value can be null or undefined

.travis.yml

@@ -0,0 +1,6 @@
+language: node_js
+node_js:
+  - "node"
+before_install:
+  - sudo apt-get -qq update
+  - sudo apt-get install -y pdftk

LICENSE.md

@@ -1,6 +1,7 @@
 MIT License (MIT)
 
-Copyright (c) 2014-2016 John Taylor
+This Fork: Copyright (c) 2017 Jason Phillips
+Original Library: Copyright (c) 2014-2016 John Taylor
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,33 +1,40 @@
-PDF Filler (Node.js)
+PDF Filler Stream
 ======
-[![NPM](https://nodei.co/npm/pdffiller.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/pdffiller/)
+
+[![npm version](https://badge.fury.io/js/pdffiller-stream.svg)](https://badge.fury.io/js/pdffiller-stream) [![Build Status](https://travis-ci.org/jasonphillips/pdffiller-stream.svg?branch=master)](https://travis-ci.org/jasonphillips/pdffiller-stream)
+
+> This is a fork of the [pdf-filler](https://github.com/pdffillerjs/pdffiller) 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 <a target="_blank" href="http://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/">PDF ToolKit</a>.
 
 
 Quick start
 -----------
 
-First, run `npm install pdffiller --save` for your app.
+**You must first have `pdftk` (from pdftk-server, found [here](https://www.pdflabs.com/tools/pdftk-server/)) installed correctly on your platform.**
 
-Import the module using:
+Then, install this library:
 
-```js
-var pdfFiller = require('pdffiller');
-
-// ...
+```bash
+npm install pdffiller-stream --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
+
 ````javascript
-var pdfFiller   = require('pdffiller');
+import pdfFiller from 'pdffiller-stream';
 
-var sourcePDF = "test/test.pdf";
-var destinationPDF =  "test/test_complete.pdf";
-var data = {
+const sourcePDF = "test/test.pdf";
+
+const data = {
     "last_name" : "John",
     "first_name" : "Doe",
     "date" : "Jan 1, 2013",
@@ -38,52 +45,86 @@ var data = {
     "nascar" : "Off"
 };
 
-pdfFiller.fillForm( sourcePDF, destinationPDF, data, function(err) {
-    if (err) throw err;
-    console.log("In callback (we're done).");
-});
+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 create a complete filled in PDF (test_filled_in.pdf). Note that the
-resulting PDF will be read-only.
+This will take the test.pdf, fill the fields with the data values and stream a filled in, read-only PDF.
 
-Alternatively,
+A chainable convenience method `toFile` is attached to the response, if you simply wish to write the stream to a file with no fuss:
 
-````javascript
+```javascript
+pdfFiller.fillForm( sourcePDF, data)
+    .toFile('outputFile.PDF')
+    .then(() => {
+        // your file has been written 
+    }).catch((err) => {
+        console.log(err);
+    });
+```
 
-var shouldFlatten = false;
+You could also stream the resulting data directly to AWS, doing something like this with an instantiated `s3` client:
+
+```javascript
+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);
+    });
 
-pdfFiller.fillFormWithFlatten( sourcePDF, destinationPDF, data, shouldFlatten, function(err) {
-    if (err) throw err;
-    console.log("In callback (we're done).");
-})
-````
+```
 
-Calling
-`fillFormWithFlatten()` with `shouldFlatten = false` will leave any unmapped fields
-still editable, as per the `pdftk` command specification.
+Calling `fillFormWithFlatten()` with `shouldFlatten = false` will leave any unmapped fields still editable, as per the `pdftk` command specification.
+
+```javascript
+
+const shouldFlatten = false;
+
+pdfFiller.fillFormWithFlatten(sourcePDF, data, shouldFlatten)
+    .then((outputStream) {
+        // etc, same as above
+    })
+```
 
 
 #### 2. Generate FDF Template from PDF
+
 ````javascript
-var pdfFiller   = require('pdffiller');
+import pdfFiller from 'pdffiller-stream';
 
-var sourcePDF = "test/test.pdf";
+const sourcePDF = "test/test.pdf";
 
 // Override the default field name regex. Default: /FieldName: ([^\n]*)/
-var nameRegex = null;  
+const nameRegex = null;  
 
-var FDF_data = pdfFiller.generateFDFTemplate( sourcePDF, nameRegex, function(err, fdfData) {
-    if (err) throw err;
+const FDF_data = pdfFiller.generateFDFTemplate(sourcePDF, nameRegex).then((fdfData) => {
     console.log(fdfData);
+}).catch((err) => {
+    console.log(err);
 });
 
 ````
 
 This will print out this
-```
+```json
 {
     "last_name" : "",
     "first_name" : "",
@@ -93,14 +134,15 @@ This will print out this
     "basketball" : "",
     "hockey" : "",
     "nascar" : ""
-};
+}
 ```
 
 #### 3. Map form fields to PDF fields
 ````javascript
-var pdfFiller = require('pdffiller');
+import pdfFiller from 'pdffiller-stream';
+
+const conversionMap = {
 
-var convMap = {
     "lastName": "last_name",
     "firstName": "first_name",
     "Date": "date",
@@ -111,55 +153,25 @@ var convMap = {
     "nascarField": "nascar"
 };
 
-var fieldJson = [
-    {
-        "title" : "lastName",
-        "fieldfieldType": "Text",
-        "fieldValue": "John"
-    },
-    {
-        "title" : "firstName",
-        "fieldfieldType": "Text",
-        "fieldValue": "Doe"
-    },
-    {
-        "title" : "Date",
-        "fieldType": "Text",
-        "fieldValue": "Jan 1, 2013"
-    },
-    {
-        "title" : "footballField",
-        "fieldType": "Button",
-        "fieldValue": false
-    },
-    {
-        "title" : "baseballField",
-        "fieldType": "Button",
-        "fieldValue": true
-    },
-    {
-        "title" : "bballField",
-        "fieldType": "Button",
-        "fieldValue": false
-    },
-    {
-        "title" : "hockeyField",
-        "fieldType": "Button",
-        "fieldValue": true
-    },
-    {
-        "title" : "nascarField",
-        "fieldType": "Button",
-        "fieldValue": false
-    }
-];
+const FormFields = {
+    "lastName" : "John",
+    "firstName" : "Doe",
+    "Date" : "Jan 1, 2013",
+    "footballField" : "Off",
+    "baseballField" : "Yes",
+    "bballField" : "Off",
+    "hockeyField" : "Yes",
+    "nascarField" : "Off"
+};
 
-var mappedFields = pdfFiller.mapForm2PDF( fieldJson, convMap );
-console.log(mappedFields);
+pdfFiller.mapForm2PDF(data, convMap).then((mappedFields) => {
+    console.log(mappedFields);
+});
 ````
 
 This will print out the object below.
-```
+```json
+
 {
     "last_name" : "John",
     "first_name" : "Doe",
@@ -169,14 +181,15 @@ This will print out the object below.
     "basketball" : "Off",
     "hockey" : "Yes",
     "nascar" : "Off"
-};
+
+}
 ```
 
 #### 4. Convert fieldJson to FDF data
 ````javascript
-var pdfFiller   = require('pdffiller');
+import pdfFiller from 'pdffiller-stream';
 
-var fieldJson = [
+const fieldJson = [
     {
         "title" : "last_name",
         "fieldfieldType": "Text",
@@ -219,12 +232,15 @@ var fieldJson = [
     }
 ];
 
-var FDFData = pdfFiller.convFieldJson2FDF( fieldJson );
+
+const FDFData = pdfFiller.convFieldJson2FDF(data);
+
 console.log(FDFData)
 ````
 
-This will print out this
-````
+This will print out:
+
+````json
 {
     "last_name" : "John",
     "first_name" : "Doe",

fdf.js

@@ -0,0 +1,72 @@
+var fs = require('fs');
+var _ = require('lodash');
+
+// only this sequence in FDF header requires char codes
+var headerChars = new Buffer(
+    (String.fromCharCode(226)) +
+    (String.fromCharCode(227)) +
+    (String.fromCharCode(207)) +
+    (String.fromCharCode(211)) +
+    "\n"
+);
+
+var header = Buffer.concat([
+    new Buffer("%FDF-1.2\n"),
+    headerChars,
+    new Buffer(
+        "1 0 obj \n" +
+        "<<\n" +
+        "/FDF \n" +
+        "<<\n" +
+        "/Fields [\n"
+    )
+]);
+
+var footer = new Buffer(
+    "]\n" +
+    ">>\n" +
+    ">>\n" +
+    "endobj \n" +
+    "trailer\n" +
+    "\n" +
+    "<<\n" +
+    "/Root 1 0 R\n" +
+    ">>\n" +
+    "%%EOF\n"
+)
+
+var escapeString = function escapeString(value) {
+    var out = value.toString();
+    out = out.replace(/\\/g, "\\\\");
+    out = out.replace(/\(/g, "\\(");
+    out = out.replace(/\)/g, "\\)");
+    out = out.toString("utf8");
+    return out;
+}
+
+exports.createFdf = function (data) {    
+    var body = new Buffer([]);
+
+    _.mapKeys(data, function (value, name) {
+        try {
+            body = Buffer.concat([
+                body,
+                new Buffer(
+                    "<<\n" +
+                    "/T (" +
+                    escapeString(name) +
+                    ")\n" +
+                    "/V (" +
+                    escapeString(value) +
+                    ")\n" +
+                    ">>\n"
+                )
+            ]);
+        } catch (err) {
+            let errMsg = "Cannot escape string: '" + name + ": " + value + "'.";
+            throw Error(errMsg);
+        }
+    });
+
+    return Buffer.concat([header, body, footer]);
+}