npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mbenfriha/pdffiller-stream-with-utf8

v0.1.1

Published

Take an existing PDF Form and data and PDF Filler will create a new PDF with all given fields populated.

Downloads

41

Readme

PDF Filler Stream

npm version Build Status

This is a fork of the pdf-filler package, modified to return promises and readable streams, by piping data in/out of a spawned pdftk process instead of temporarily writing files to disk.

The goal is cleaner integration, in eg. a microservices context, where it is preferable not to write multiple temporary files to disk and where you may wish to stream the generated pdf directly to a service like AWS.

A node.js PDF form field data filler and FDF generator toolkit. This essentially is a wrapper around the PDF Toolkit library PDF ToolKit.

Quick start

You must first have pdftk (from pdftk-server, found here) installed correctly on your platform.

Then, install this library:

npm i @mbenfriha/pdffiller-stream-with-utf8 --save

Note for MacOS / OSX Developers - the main pdftk package for OSX is currently broken as of OS 10.11, but PDFLabs released an alternative build that should work normally on the platform: https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/pdftk_server-2.02-mac_osx-10.11-setup.pkg

Examples

1.Fill PDF with existing FDF Data

import pdfFiller from 'pdffiller-stream';

const sourcePDF = "test/test.pdf";

const data = {
    "last_name" : "John",
    "first_name" : "Doe",
    "date" : "Jan 1, 2013",
    "football" : "Off",
    "baseball" : "Yes",
    "basketball" : "Off",
    "hockey" : "Yes",
    "nascar" : "Off"
};

pdfFiller.fillForm( sourcePDF, data)
    .then((outputStream) => {
        // use the outputStream here;
        // will be instance of stream.Readable
    }).catch((err) => {
        console.log(err);
    });

This will take the test.pdf, fill the fields with the data values and stream a filled in, read-only PDF.

A chainable convenience method toFile is attached to the response, if you simply wish to write the stream to a file with no fuss:

pdfFiller.fillForm( sourcePDF, data)
    .toFile('outputFile.PDF')
    .then(() => {
        // your file has been written 
    }).catch((err) => {
        console.log(err);
    });

You could also stream the resulting data directly to AWS, doing something like this with an instantiated s3 client:

pdfFiller.fillForm( sourcePDF, data)
    .then((outputStream) => {
        const Body = outputStream;
        const Bucket = 'some-bucket';
        const Key = 'myFancyNewFilledPDF';
        const ContentType = 'application/pdf';
        
        const uploader = new AWS.S3.ManagedUpload({
            params: {Bucket, Key, Body, ContentType},
            service: s3,
        });
        
        uploader.promise().then((data) => {/* do something with AWS response */})
        
    }).catch((err) => {
        console.log(err);
    });

Calling fillFormWithFlatten() with shouldFlatten = false will leave any unmapped fields still editable, as per the pdftk command specification.


const shouldFlatten = false;

pdfFiller.fillFormWithFlatten(sourcePDF, data, shouldFlatten)
    .then((outputStream) {
        // etc, same as above
    })

2. Generate FDF Template from PDF

import pdfFiller from 'pdffiller-stream';

const sourcePDF = "test/test.pdf";

// Override the default field name regex. Default: /FieldName: ([^\n]*)/
const nameRegex = null;  

const FDF_data = pdfFiller.generateFDFTemplate(sourcePDF, nameRegex).then((fdfData) => {
    console.log(fdfData);
}).catch((err) => {
    console.log(err);
});

This will print out this

{
    "last_name" : "",
    "first_name" : "",
    "date" : "",
    "football" : "",
    "baseball" : "",
    "basketball" : "",
    "hockey" : "",
    "nascar" : ""
}

3. Map form fields to PDF fields

import pdfFiller from 'pdffiller-stream';

const conversionMap = {

    "lastName": "last_name",
    "firstName": "first_name",
    "Date": "date",
    "footballField": "football",
    "baseballField": "baseball",
    "bballField": "basketball",
    "hockeyField": "hockey",
    "nascarField": "nascar"
};

const FormFields = {
    "lastName" : "John",
    "firstName" : "Doe",
    "Date" : "Jan 1, 2013",
    "footballField" : "Off",
    "baseballField" : "Yes",
    "bballField" : "Off",
    "hockeyField" : "Yes",
    "nascarField" : "Off"
};

pdfFiller.mapForm2PDF(data, convMap).then((mappedFields) => {
    console.log(mappedFields);
});

This will print out the object below.


{
    "last_name" : "John",
    "first_name" : "Doe",
    "date" : "Jan 1, 2013",
    "football" : "Off",
    "baseball" : "Yes",
    "basketball" : "Off",
    "hockey" : "Yes",
    "nascar" : "Off"

}

4. Convert fieldJson to FDF data

import pdfFiller from 'pdffiller-stream';

const fieldJson = [
    {
        "title" : "last_name",
        "fieldfieldType": "Text",
        "fieldValue": "Doe"
    },
    {
        "title" : "first_name",
        "fieldfieldType": "Text",
        "fieldValue": "John"
    },
    {
        "title" : "date",
        "fieldType": "Text",
        "fieldValue": "Jan 1, 2013"
    },
    {
        "title" : "football",
        "fieldType": "Button",
        "fieldValue": false
    },
    {
        "title" : "baseball",
        "fieldType": "Button",
        "fieldValue": true
    },
    {
        "title" : "basketball",
        "fieldType": "Button"
        "fieldValue": false
    },
    {
        "title" : "hockey",
        "fieldType": "Button"
        "fieldValue": true
    },
    {
        "title" : "nascar",
        "fieldType": "Button"
        "fieldValue": false
    }
];


const FDFData = pdfFiller.convFieldJson2FDF(data);

console.log(FDFData)

This will print out:

{
    "last_name" : "John",
    "first_name" : "Doe",
    "date" : "Jan 1, 2013",
    "football" : "Off",
    "baseball" : "Yes",
    "basketball" : "Off",
    "hockey" : "Yes",
    "nascar" : "Off"
};