chore: Fixed build

Author: wickedest

.vscode/launch.json

@@ -26,6 +26,22 @@
 			"args": [
 			],
 			"program": "${file}"
-		}
+		},
+		{
+			"type": "node",
+			"request": "launch",
+			"name": "Mocha Tests",
+			"program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+			"env": {
+					"TZ": "UTC",
+					"LOG_LEVEL": "fatal"
+			},
+			"args": [
+					"--no-timeouts",
+					"--colors",
+			],
+			"cwd": "${fileDirname}/..",
+			"internalConsoleOptions": "openOnSessionStart"
+		},
 	]
 }

docs/API.md

@@ -12,6 +12,24 @@
 <dt><a href="#map">map(pdfFile, [options])</a> ⇒ <code>object</code></dt>
 <dd><p>Generates a map from a PDF file and saves as YAML.</p>
 </dd>
+<dt><a href="#open">open(fileName)</a> ⇒ <code>PDF</code></dt>
+<dd><p>Opens a PDF form.</p>
+</dd>
+<dt><a href="#getTemplate">getTemplate()</a> ⇒ <code>object</code></dt>
+<dd><p>Gets the form template.</p>
+</dd>
+<dt><a href="#fillForm">fillForm(filledTemplate)</a></dt>
+<dd><p>Fills out a form using <code>filledTemplate</code>.</p>
+</dd>
+<dt><a href="#slice">slice(begin, end)</a> ⇒ <code>PDF</code></dt>
+<dd><p>Slice pages from <code>begin</code> (0-based, inclusive) to <code>end</code> (exclusive).</p>
+</dd>
+<dt><a href="#append">append(pdf)</a></dt>
+<dd><p>Appends PDF to the current PDF.</p>
+</dd>
+<dt><a href="#save">save(dest, [flatten])</a> ⇒ <code>Promise</code></dt>
+<dd><p>Saves the PDF to file.</p>
+</dd>
 </dl>
 
 ## Typedefs
@@ -38,7 +56,7 @@ Creates a fillable form from a PDF.
     * [.fill(filler, [options])](#Form+fill)
     * [.save(source, dest)](#Form+save)
     * [.slice(begin, end, dest)](#Form+slice)
-    * [.join(parts, dest)](#Form+join)
+    * [.join(dest, parts)](#Form+join)
 
 <a name="Form+init"></a>
 
@@ -94,7 +112,7 @@ form.setFormName('banana');
 ### form.setSourcePDF(source)
 Change the source PDF name.  By default, this is the the `source` PDF
 path provided in [load](load) function.  It allows the source PDF to be
-changed prior to calling [slice](slice) or [save](save).
+changed prior to calling [slice](#slice) or [save](#save).
 
 **Kind**: instance method of [<code>Form</code>](#Form)  
 **Access**: public  
@@ -186,16 +204,16 @@ for slicing pages.
 
 <a name="Form+join"></a>
 
-### form.join(parts, dest)
+### form.join(dest, parts)
 Join multiple PDF `parts` into a new PDF `dest`.
 
 **Kind**: instance method of [<code>Form</code>](#Form)  
 **Access**: public  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| parts | <code>Array.&lt;string&gt;</code> | PDF file name parts to join. |
-| dest | <code>string</code> | The destination PDF file to write. |
+| dest | <code>PDF</code> | - |
+| parts | <code>Array.&lt;string&gt;</code> | - |
 
 <a name="map"></a>
 
@@ -211,6 +229,72 @@ Generates a map from a PDF file and saves as YAML.
 | pdfFile | <code>string</code> |  | The PDF file containing a form. |
 | [options] | <code>object</code> | <code>{}</code> | Options. |
 
+<a name="open"></a>
+
+## open(fileName) ⇒ <code>PDF</code>
+Opens a PDF form.
+
+**Kind**: global function  
+**Returns**: <code>PDF</code> - A PDF for filling.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| fileName | <code>string</code> | The path to the PDF file to open. |
+
+<a name="getTemplate"></a>
+
+## getTemplate() ⇒ <code>object</code>
+Gets the form template.
+
+**Kind**: global function  
+**Returns**: <code>object</code> - A PDF form template.  
+<a name="fillForm"></a>
+
+## fillForm(filledTemplate)
+Fills out a form using `filledTemplate`.
+
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| filledTemplate | <code>object</code> | 
+
+<a name="slice"></a>
+
+## slice(begin, end) ⇒ <code>PDF</code>
+Slice pages from `begin` (0-based, inclusive) to `end` (exclusive).
+
+**Kind**: global function  
+**Returns**: <code>PDF</code> - The new PDF.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| begin | <code>int</code> | The index of the page to slice from. |
+| end | <code>int</code> | The index of the page to slice to. |
+
+<a name="append"></a>
+
+## append(pdf)
+Appends PDF to the current PDF.
+
+**Kind**: global function  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| pdf | <code>PDF</code> | The PDF to append. |
+
+<a name="save"></a>
+
+## save(dest, [flatten]) ⇒ <code>Promise</code>
+Saves the PDF to file.
+
+**Kind**: global function  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| dest | <code>str</code> |  | The destination file name. |
+| [flatten] | <code>bool</code> | <code>true</code> | Flattens the PDF form before saving. |
+
 <a name="HelperFunction"></a>
 
 ## HelperFunction ⇒ <code>number</code> \| <code>string</code>

package-lock.json

@@ -43,7 +43,7 @@
     "@semantic-release/git": "^10.0.1",
     "c8": "^7.13.0",
     "chai": "^4.3.7",
-    "command-exists": "^1.2.9",
+    "chai-as-promised": "^8.0.1",
     "conventional-changelog-conventionalcommits": "^5.0.0",
     "eslint": "^8.40.0",
     "husky": "^8.0.3",

package.json

@@ -42,7 +42,7 @@ async function map(pdfFile, options = {}) {
 	// extract the template from PDF
 	log('opening PDF file:', pdfFile);
 
-	const pdfDoc = await PDF.open(pdfFile)
+	const pdfDoc = await PDF.open(pdfFile);
 	const template = pdfDoc.getTemplate();
 
 	// fill a form, mapping each input ID `key` to a unique index `i`
@@ -73,8 +73,6 @@ async function map(pdfFile, options = {}) {
 
 		// update the form with each input ID `key` filled as unique index `i`
 		log('calling fillFormWithFlattenAsync', pdfFile);
-		// await pdfFiller.fillFormWithFlattenAsync(
-		// 	pdfFile, filledFile, template, false);
 		await pdfDoc.fillForm(template, filledFile);
 
 		return {
@@ -94,7 +92,7 @@ function ensureDirectory(dir) {
 	return fs.access(dir, fs.constants.R_OK | fs.constants.W_OK)
 		.catch(() => {
 			log('mkdir:', dir);
-			fs.mkdir(dir);
+			return fs.mkdir(dir);
 		});
 }
 

src/map.js

@@ -22,7 +22,7 @@ export default class PDF {
 	 * Opens a PDF form.
 	 *
 	 * @param {string} fileName - The path to the PDF file to open.
-	 * @returns
+	 * @returns {PDF} A PDF for filling.
 	 */
 	static async open(fileName) {
 		log('open', fileName);
@@ -63,7 +63,7 @@ export default class PDF {
 				try {
 					field.setText(filledTemplate[key]);
 				} catch (ex) {
-					if (`${ex}`.indexOf(" must be of type `string`") >= 0) {
+					if (`${ex}`.indexOf(' must be of type `string`') >= 0) {
 						// automatically convert numbers to strings
 						field.setText(`${filledTemplate[key]}`);
 					} else {
@@ -142,8 +142,8 @@ export default class PDF {
 	 * Saves the PDF to file.
 	 *
 	 * @param {str} dest - The destination file name.
-	 * @param {bool=true} flatten - Flattens the PDF form before saving.
-	 * @returns
+	 * @param {bool} [flatten=true] - Flattens the PDF form before saving.
+	 * @returns {Promise}
 	 */
 	async save(dest, flatten = true) {
 		if (flatten) {

src/pdf.js

@@ -1,9 +1,8 @@
-// const fs = require('fs');
-import fs from 'fs';
+import fs from 'fs/promises';
 import path from 'path';
 import { expect } from 'chai';
 import simple from 'simple-mock';
-import pdfFiller from 'pdffiller';
+import { PDFDocument } from '@cantoo/pdf-lib';
 import { map, Form } from '../src/index.js';
 
 const examplePdf = path.join('example', 'f1040.pdf');
@@ -12,40 +11,50 @@ const fillerFile = path.join('example', 'f1040-script.yaml');
 const configFile = path.join('example', 'config.yaml');
 const outputPdf = path.join('example', 'example.pdf');
 
+async function mockForm(fieldName) {
+	const doc = await PDFDocument.create();
+	doc.addPage([550, 750]);
+	const form = doc.getForm();
+	const textField = form.createTextField(fieldName);
+	simple.mock(PDFDocument, 'load').resolveWith(doc);
+	simple.mock(fs, 'readFile').resolveWith('bytes');
+	simple.mock(fs, 'writeFile').resolveWith();
+	return textField;
+}
+
 describe('example', () => {
 	beforeEach(() => {
-		simple.mock(pdfFiller, 'fillFormWithFlattenAsync')
-			.resolveWith();
+		simple.mock(fs, 'writeFile').resolveWith();
 	});
 
 	afterEach(() => {
 		simple.restore();
 	});
 
 	it('should generate a map YAML file for the example PDF file', async () => {
-		// simple.mock(child_process, 'execFile').throwWith(new Error('omg'));
-		simple.mock(pdfFiller, 'generatePDFTemplateAsync').resolveWith({
-			key1: 'banana'
-		});
-		simple.mock(fs.promises, 'writeFile').resolveWith();
+		await mockForm('key1');
+		simple.mock(fs, 'writeFile').resolveWith();
 
 		await map(examplePdf, { dir: 'example' });
-		expect(fs.existsSync(mapFile)).to.be.true;
 
-		expect(fs.promises.writeFile.calls).to.have.length(1);
-		expect(fs.promises.writeFile.calls[0].args[0])
+		// expect(fs.existsSync(mapFile)).to.be.true;
+		expect(fs.writeFile.calls).to.have.length(1);
+		expect(fs.writeFile.calls[0].args[0])
 			.to.equal('example/f1040-map.yaml');
-		expect(fs.promises.writeFile.calls[0].args[1])
+		expect(fs.writeFile.calls[0].args[1])
 			.to.equal('key1: \'0\'\n');
-		expect(pdfFiller.generatePDFTemplateAsync.calls).to.have.length(1);
-		expect(pdfFiller.generatePDFTemplateAsync.calls[0].args[0])
-			.to.equal('example/f1040.pdf');
 	});
 
 	it('should fill the example PDF form', async () => {
-		simple.mock(pdfFiller, 'fillFormWithFlattenAsync').resolveWith();
+		const form = new Form();
+		await form.init(configFile);
+		await form.load(examplePdf, mapFile);
+		await form.fill(fillerFile);
+		await form.save(outputPdf);
 
-		const expected = {
+		expect(fs.writeFile.calls).to.have.length(1);
+		expect(fs.writeFile.calls[0].arg).to.equal('example/example.pdf');
+		expect(form.ctx.forms.f1040).to.deep.equal({
 			'filing.status': '1',
 			'your.first.name.and.middle.initial': 'Joe A',
 			'topmostSubform[0].Page1[0].f1_02[0]': 'Joe A',
@@ -54,17 +63,6 @@ describe('example', () => {
 			'topmostSubform[0].Page1[0].f1_03[0]': 'Bloggs',
 			'social.security.number': '012345678',
 			'topmostSubform[0].Page1[0].YourSocial_ReadOrderControl[0].f1_04[0]': '012345678'
-		};
-
-		const form = new Form();
-		await form.init(configFile);
-		await form.load(examplePdf, mapFile);
-		await form.fill(fillerFile);
-		await form.save(outputPdf);
-
-		expect(pdfFiller.fillFormWithFlattenAsync.calls)
-			.to.have.length(1);
-		expect(pdfFiller.fillFormWithFlattenAsync.lastCall.args)
-			.to.deep.equal([ examplePdf, outputPdf, expected, false ]);
+		});
 	});
 });