🏷️

vbuch · Oct 5, 2023 · 31d6907 · 31d6907
1 parent 025f99b
commit 31d6907
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 2 deletions.
diff --git a/packages/signpdf/dist/signpdf.d.ts b/packages/signpdf/dist/signpdf.d.ts
@@ -1,8 +1,23 @@
+/**
+ * @typedef {object} SignerOptions
+ * @prop {string} [passphrase]
+ * @prop {boolean} [asn1StrictParsing]
+ */
 export class SignPdf {
     byteRangePlaceholder: "**********";
     lastSignature: string;
-    sign(pdfBuffer: any, p12Buffer: any, additionalOptions?: {}): Buffer;
+    /**
+     * @param {Buffer} pdfBuffer
+     * @param {Buffer} p12Buffer
+     * @param {SignerOptions} additionalOptions
+     * @returns {Buffer}
+     */
+    sign(pdfBuffer: Buffer, p12Buffer: Buffer, additionalOptions?: SignerOptions): Buffer;
 }
 declare const _default: SignPdf;
 export default _default;
+export type SignerOptions = {
+    passphrase?: string;
+    asn1StrictParsing?: boolean;
+};
 //# sourceMappingURL=signpdf.d.ts.map
diff --git a/packages/signpdf/dist/signpdf.d.ts.map b/packages/signpdf/dist/signpdf.d.ts.map
diff --git a/packages/signpdf/dist/signpdf.js b/packages/signpdf/dist/signpdf.js
@@ -7,11 +7,24 @@ exports.default = exports.SignPdf = void 0;
 var _nodeForge = _interopRequireDefault(require("node-forge"));
 var _utils = require("@signpdf/utils");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * @typedef {object} SignerOptions
+ * @prop {string} [passphrase]
+ * @prop {boolean} [asn1StrictParsing]
+ */
+
 class SignPdf {
   constructor() {
     this.byteRangePlaceholder = _utils.DEFAULT_BYTE_RANGE_PLACEHOLDER;
     this.lastSignature = null;
   }
+
+  /**
+   * @param {Buffer} pdfBuffer
+   * @param {Buffer} p12Buffer
+   * @param {SignerOptions} additionalOptions
+   * @returns {Buffer}
+   */
   sign(pdfBuffer, p12Buffer, additionalOptions = {}) {
     const options = {
       asn1StrictParsing: false,

diff --git a/packages/signpdf/src/signpdf.js b/packages/signpdf/src/signpdf.js
@@ -6,12 +6,24 @@ import {
     SignPdfError,
 } from '@signpdf/utils';
 
+/**
+ * @typedef {object} SignerOptions
+ * @prop {string} [passphrase]
+ * @prop {boolean} [asn1StrictParsing]
+ */
+
 export class SignPdf {
     constructor() {
         this.byteRangePlaceholder = DEFAULT_BYTE_RANGE_PLACEHOLDER;
         this.lastSignature = null;
     }
 
+    /**
+     * @param {Buffer} pdfBuffer
+     * @param {Buffer} p12Buffer
+     * @param {SignerOptions} additionalOptions
+     * @returns {Buffer}
+     */
     sign(
         pdfBuffer,
         p12Buffer,