Pre 3.2.0

CHANGELOG.md

@@ -4,14 +4,27 @@
 
 * [utils] Introduced `convertBuffer()` to allow inputs as `Buffer`, `Uint8Array` or `string`;
 * [utils] The `Signer` abstract class accepts an optional `signingTime`.
+
 * [signpdf] Accepts `Buffer`, `Uint8Array` or `string` as input;
+
 * [signer-p12] Accepts `Buffer`, `Uint8Array` or `string` as input;
 * [signer-p12] Respects `signingTime` as abstracted in `Signer`;
+
 * [placeholder-pdf-lib] Accepts either a `PDFDoc` or a `PDFPage` to allow adding the placeholder to a specific page rather than always the first one;
 * [placeholder-pdf-lib] Accepts `signingTime`;
 * [placeholder-pdf-lib] Includes an `AP` appearance stream for PDF/A compliance;
-* [placeholder-pdf-lib] Adds `Prop_Build` to describe the signing application;
+* [placeholder-pdf-lib] Accepts `appName` and includes it in `Prop_Build` to allow describing the signing application;
 * [placeholder-pdf-lib] Does not require `{useObjectStreams: false}`;
+
+* [placeholder-pdfkit] Accepts `signingTime`;
+* [placeholder-pdfkit] Accepts `appName` and includes it in `Prop_Build` to allow describing the signing application;
+
+* [placeholder-pdfkit010] Accepts `signingTime`;
+* [placeholder-pdfkit010] Accepts `appName` and includes it in `Prop_Build` to allow describing the signing application;
+
+* [placeholder-plain] Accepts `signingTime`;
+* [placeholder-plain] Accepts `appName` and includes it in `Prop_Build` to allow describing the signing application;
+
 * Bumped version of follow-redirects;
 
 ## [3.1.0]

packages/placeholder-pdfkit/dist/pdfkitAddPlaceholder.d.ts

@@ -1,4 +1,4 @@
-export function pdfkitAddPlaceholder({ pdf, reason, contactInfo, name, location, signatureLength, byteRangePlaceholder, subFilter, widgetRect, }: InputType): ReturnType;
+export function pdfkitAddPlaceholder({ pdf, reason, contactInfo, name, location, signingTime, signatureLength, byteRangePlaceholder, subFilter, widgetRect, appName, }: InputType): ReturnType;
 export type InputType = {
     /**
      * PDFDocument
@@ -9,6 +9,7 @@ export type InputType = {
     contactInfo: string;
     name: string;
     location: string;
+    signingTime?: Date;
     signatureLength?: number;
     byteRangePlaceholder?: string;
     /**
@@ -19,6 +20,10 @@ export type InputType = {
      * [x1, y1, x2, y2] widget rectangle
      */
     widgetRect?: number[];
+    /**
+     * Name of the application generating the signature
+     */
+    appName?: string;
 };
 export type ReturnType = {
     signature: any;

packages/placeholder-pdfkit/dist/pdfkitAddPlaceholder.js

@@ -13,10 +13,12 @@ var _utils = require("@signpdf/utils");
 * @property {string} contactInfo
 * @property {string} name
 * @property {string} location
+* @property {Date} [signingTime]
 * @property {number} [signatureLength]
 * @property {string} [byteRangePlaceholder]
 * @property {string} [subFilter] One of SUBFILTER_* from \@signpdf/utils
 * @property {number[]} [widgetRect] [x1, y1, x2, y2] widget rectangle
+* @property {string} [appName] Name of the application generating the signature
 */
 
 /**
@@ -39,10 +41,12 @@ const pdfkitAddPlaceholder = ({
   contactInfo,
   name,
   location,
+  signingTime = undefined,
   signatureLength = _utils.DEFAULT_SIGNATURE_LENGTH,
   byteRangePlaceholder = _utils.DEFAULT_BYTE_RANGE_PLACEHOLDER,
   subFilter = _utils.SUBFILTER_ADOBE_PKCS7_DETACHED,
-  widgetRect = [0, 0, 0, 0]
+  widgetRect = [0, 0, 0, 0],
+  appName = undefined
 }) => {
   /* eslint-disable no-underscore-dangle,no-param-reassign */
   // Generate the signature placeholder
@@ -54,14 +58,24 @@ const pdfkitAddPlaceholder = ({
     Contents: Buffer.from(String.fromCharCode(0).repeat(signatureLength)),
     Reason: new String(reason),
     // eslint-disable-line no-new-wrappers
-    M: new Date(),
+    M: signingTime !== null && signingTime !== void 0 ? signingTime : new Date(),
     ContactInfo: new String(contactInfo),
     // eslint-disable-line no-new-wrappers
     Name: new String(name),
     // eslint-disable-line no-new-wrappers
-    Location: new String(location) // eslint-disable-line no-new-wrappers
+    Location: new String(location),
+    // eslint-disable-line no-new-wrappers
+    Prop_Build: {
+      Filter: {
+        Name: 'Adobe.PPKLite'
+      },
+      ...(appName ? {
+        App: {
+          Name: appName
+        }
+      } : {})
+    }
   });
-
   if (!pdf._acroform) {
     pdf.initForm();
   }

packages/placeholder-pdfkit/src/pdfkitAddPlaceholder.js

@@ -13,10 +13,12 @@ import {
 * @property {string} contactInfo
 * @property {string} name
 * @property {string} location
+* @property {Date} [signingTime]
 * @property {number} [signatureLength]
 * @property {string} [byteRangePlaceholder]
 * @property {string} [subFilter] One of SUBFILTER_* from \@signpdf/utils
 * @property {number[]} [widgetRect] [x1, y1, x2, y2] widget rectangle
+* @property {string} [appName] Name of the application generating the signature
 */
 
 /**
@@ -39,10 +41,12 @@ export const pdfkitAddPlaceholder = ({
     contactInfo,
     name,
     location,
+    signingTime = undefined,
     signatureLength = DEFAULT_SIGNATURE_LENGTH,
     byteRangePlaceholder = DEFAULT_BYTE_RANGE_PLACEHOLDER,
     subFilter = SUBFILTER_ADOBE_PKCS7_DETACHED,
     widgetRect = [0, 0, 0, 0],
+    appName = undefined,
 }) => {
     /* eslint-disable no-underscore-dangle,no-param-reassign */
     // Generate the signature placeholder
@@ -58,10 +62,16 @@ export const pdfkitAddPlaceholder = ({
         ],
         Contents: Buffer.from(String.fromCharCode(0).repeat(signatureLength)),
         Reason: new String(reason), // eslint-disable-line no-new-wrappers
-        M: new Date(),
+        M: signingTime ?? new Date(),
         ContactInfo: new String(contactInfo), // eslint-disable-line no-new-wrappers
         Name: new String(name), // eslint-disable-line no-new-wrappers
         Location: new String(location), // eslint-disable-line no-new-wrappers
+        Prop_Build: {
+            Filter: {Name: 'Adobe.PPKLite'},
+            ...(
+                appName ? {App: {Name: appName}} : {}
+            ),
+        },
     });
 
     if (!pdf._acroform) {

packages/placeholder-pdfkit/src/pdfkitAddPlaceholder.test.js

@@ -146,4 +146,28 @@ describe(pdfkitAddPlaceholder, () => {
             '**********',
         ]);
     });
+
+    it('sets the Prop_Build dictionary for the signature', async () => {
+        const {pdf} = createPdfkitDocument(PDFDocument, {});
+        const widgetRect = [100, 100, 200, 200];
+        const refs = pdfkitAddPlaceholder({
+            ...defaults,
+            pdf,
+            pdfBuffer: Buffer.from([pdf]),
+            reason: 'test reason',
+            widgetRect,
+            appName: 'signpdf',
+        });
+        expect(Object.keys(refs)).toEqual(expect.arrayContaining([
+            'signature',
+            'form',
+            'widget',
+        ]));
+        expect(pdf.page.dictionary.data.Annots).toHaveLength(1);
+        const widget = pdf.page.dictionary.data.Annots[0];
+        const propBuild = widget.data.V.data.Prop_Build;
+
+        expect(propBuild.Filter.Name).toEqual('Adobe.PPKLite');
+        expect(propBuild.App.Name).toEqual('signpdf');
+    });
 });

packages/placeholder-pdfkit010/dist/pdfkitAddPlaceholder.d.ts

@@ -1,4 +1,4 @@
-export function pdfkitAddPlaceholder({ pdf, pdfBuffer, reason, contactInfo, name, location, signatureLength, byteRangePlaceholder, subFilter, widgetRect, }: InputType): ReturnType;
+export function pdfkitAddPlaceholder({ pdf, pdfBuffer, reason, contactInfo, name, location, signingTime, signatureLength, byteRangePlaceholder, subFilter, widgetRect, appName, }: InputType): ReturnType;
 export type InputType = {
     /**
      * PDFDocument
@@ -9,6 +9,7 @@ export type InputType = {
     contactInfo: string;
     name: string;
     location: string;
+    signingTime?: Date;
     signatureLength?: number;
     byteRangePlaceholder?: string;
     /**
@@ -19,6 +20,10 @@ export type InputType = {
      * [x1, y1, x2, y2] widget rectangle
      */
     widgetRect?: number[];
+    /**
+     * Name of the application generating the signature
+     */
+    appName?: string;
 };
 export type ReturnType = {
     signature: any;

packages/placeholder-pdfkit010/dist/pdfkitAddPlaceholder.js

@@ -16,10 +16,12 @@ var _pdfkitReferenceMock = require("./pdfkitReferenceMock");
 * @property {string} contactInfo
 * @property {string} name
 * @property {string} location
+* @property {Date} [signingTime]
 * @property {number} [signatureLength]
 * @property {string} [byteRangePlaceholder]
 * @property {string} [subFilter] One of SUBFILTER_* from \@signpdf/utils
 * @property {number[]} [widgetRect] [x1, y1, x2, y2] widget rectangle
+* @property {string} [appName] Name of the application generating the signature
 */
 
 /**
@@ -43,10 +45,12 @@ const pdfkitAddPlaceholder = ({
   contactInfo,
   name,
   location,
+  signingTime = undefined,
   signatureLength = _utils.DEFAULT_SIGNATURE_LENGTH,
   byteRangePlaceholder = _utils.DEFAULT_BYTE_RANGE_PLACEHOLDER,
   subFilter = _utils.SUBFILTER_ADOBE_PKCS7_DETACHED,
-  widgetRect = [0, 0, 0, 0]
+  widgetRect = [0, 0, 0, 0],
+  appName = undefined
 }) => {
   /* eslint-disable no-underscore-dangle,no-param-reassign */
   // Generate the signature placeholder
@@ -58,12 +62,23 @@ const pdfkitAddPlaceholder = ({
     Contents: Buffer.from(String.fromCharCode(0).repeat(signatureLength)),
     Reason: new String(reason),
     // eslint-disable-line no-new-wrappers
-    M: new Date(),
+    M: signingTime !== null && signingTime !== void 0 ? signingTime : new Date(),
     ContactInfo: new String(contactInfo),
     // eslint-disable-line no-new-wrappers
     Name: new String(name),
     // eslint-disable-line no-new-wrappers
-    Location: new String(location) // eslint-disable-line no-new-wrappers
+    Location: new String(location),
+    // eslint-disable-line no-new-wrappers
+    Prop_Build: {
+      Filter: {
+        Name: 'Adobe.PPKLite'
+      },
+      ...(appName ? {
+        App: {
+          Name: appName
+        }
+      } : {})
+    }
   });
 
   // Check if pdf already contains acroform field

packages/placeholder-pdfkit010/src/pdfkitAddPlaceholder.js

@@ -16,10 +16,12 @@ import {PDFKitReferenceMock} from './pdfkitReferenceMock';
 * @property {string} contactInfo
 * @property {string} name
 * @property {string} location
+* @property {Date} [signingTime]
 * @property {number} [signatureLength]
 * @property {string} [byteRangePlaceholder]
 * @property {string} [subFilter] One of SUBFILTER_* from \@signpdf/utils
 * @property {number[]} [widgetRect] [x1, y1, x2, y2] widget rectangle
+* @property {string} [appName] Name of the application generating the signature
 */
 
 /**
@@ -43,10 +45,12 @@ export const pdfkitAddPlaceholder = ({
     contactInfo,
     name,
     location,
+    signingTime = undefined,
     signatureLength = DEFAULT_SIGNATURE_LENGTH,
     byteRangePlaceholder = DEFAULT_BYTE_RANGE_PLACEHOLDER,
     subFilter = SUBFILTER_ADOBE_PKCS7_DETACHED,
     widgetRect = [0, 0, 0, 0],
+    appName = undefined,
 }) => {
     /* eslint-disable no-underscore-dangle,no-param-reassign */
     // Generate the signature placeholder
@@ -62,10 +66,16 @@ export const pdfkitAddPlaceholder = ({
         ],
         Contents: Buffer.from(String.fromCharCode(0).repeat(signatureLength)),
         Reason: new String(reason), // eslint-disable-line no-new-wrappers
-        M: new Date(),
+        M: signingTime ?? new Date(),
         ContactInfo: new String(contactInfo), // eslint-disable-line no-new-wrappers
         Name: new String(name), // eslint-disable-line no-new-wrappers
         Location: new String(location), // eslint-disable-line no-new-wrappers
+        Prop_Build: {
+            Filter: {Name: 'Adobe.PPKLite'},
+            ...(
+                appName ? {App: {Name: appName}} : {}
+            ),
+        },
     });
 
     // Check if pdf already contains acroform field

packages/placeholder-pdfkit010/src/pdfkitAddPlaceholder.test.js

@@ -143,6 +143,7 @@ describe(pdfkitAddPlaceholder, () => {
             'form',
             'widget',
         ]));
+
         expect(pdf.page.dictionary.data.Annots).toHaveLength(1);
         expect(pdf.page.dictionary.data.Annots[0].data.Subtype).toEqual('Widget');
         expect(pdf.page.dictionary.data.Annots[0].data.V.data.ByteRange).toEqual([
@@ -152,4 +153,28 @@ describe(pdfkitAddPlaceholder, () => {
             '**********',
         ]);
     });
+
+    it('sets the Prop_Build dictionary for the signature', async () => {
+        const {pdf} = createPdfkitDocument(PDFDocument, {});
+        const widgetRect = [100, 100, 200, 200];
+        const refs = pdfkitAddPlaceholder({
+            ...defaults,
+            pdf,
+            pdfBuffer: Buffer.from([pdf]),
+            reason: 'test reason',
+            widgetRect,
+            appName: 'signpdf',
+        });
+        expect(Object.keys(refs)).toEqual(expect.arrayContaining([
+            'signature',
+            'form',
+            'widget',
+        ]));
+        expect(pdf.page.dictionary.data.Annots).toHaveLength(1);
+        const widget = pdf.page.dictionary.data.Annots[0];
+        const propBuild = widget.data.V.data.Prop_Build;
+
+        expect(propBuild.Filter.Name).toEqual('Adobe.PPKLite');
+        expect(propBuild.App.Name).toEqual('signpdf');
+    });
 });

packages/placeholder-plain/dist/plainAddPlaceholder.d.ts

@@ -1,10 +1,11 @@
-export function plainAddPlaceholder({ pdfBuffer, reason, contactInfo, name, location, signatureLength, subFilter, widgetRect, }: InputType): Buffer;
+export function plainAddPlaceholder({ pdfBuffer, reason, contactInfo, name, location, signingTime, signatureLength, subFilter, widgetRect, appName, }: InputType): Buffer;
 export type InputType = {
     pdfBuffer: Buffer;
     reason: string;
     contactInfo: string;
     name: string;
     location: string;
+    signingTime?: Date;
     signatureLength?: number;
     /**
      * One of SUBFILTER_* from \@signpdf/utils
@@ -14,5 +15,9 @@ export type InputType = {
      * [x1, y1, x2, y2] widget rectangle
      */
     widgetRect?: number[];
+    /**
+     * Name of the application generating the signature
+     */
+    appName?: string;
 };
 //# sourceMappingURL=plainAddPlaceholder.d.ts.map