@f-o-t/e-signature 1.6.0 → 1.6.1

package/dist/appearance.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Visual Signature Appearance
+ *
+ * Draws certificate information and QR code on the PDF page
+ * following the ICP-Brasil standard visual signature layout.
+ */
+import type { CertificateInfo } from "@f-o-t/digital-certificate";
+import type { PdfDocument, PdfImage, PdfPage } from "@f-o-t/pdf/plugins/editing";
+import type { QrCodeConfig, SignatureAppearance } from "./types.ts";
+/**
+ * Draw the visual signature appearance on a PDF page.
+ *
+ * Includes optional QR code and certificate information text
+ * inside a bordered rectangle following ICP-Brasil layout.
+ */
+export declare function drawSignatureAppearance(doc: PdfDocument, page: PdfPage, appearance: SignatureAppearance, certInfo: CertificateInfo | null, options: {
+    reason?: string;
+    location?: string;
+    qrCode?: QrCodeConfig;
+    pdfData: Uint8Array;
+    preEmbeddedQr?: PdfImage;
+}): void;
+/**
+ * Pre-compute the QR code image and embed it once into the PDF document.
+ * Call this before an appearances loop so all appearances share a single XObject.
+ */
+export declare function precomputeSharedQrImage(doc: PdfDocument, certInfo: CertificateInfo | null, pdfData: Uint8Array, qrConfig?: QrCodeConfig): PdfImage;
+//# sourceMappingURL=appearance.d.ts.map

package/dist/appearance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"appearance.d.ts","sourceRoot":"","sources":["../src/appearance.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,KAAK,EACT,WAAW,EACX,QAAQ,EACR,OAAO,EACT,MAAM,4BAA4B,CAAC;AAEpC,OAAO,KAAK,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAIpE;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACpC,GAAG,EAAE,WAAW,EAChB,IAAI,EAAE,OAAO,EACb,UAAU,EAAE,mBAAmB,EAC/B,QAAQ,EAAE,eAAe,GAAG,IAAI,EAChC,OAAO,EAAE;IACN,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,OAAO,EAAE,UAAU,CAAC;IACpB,aAAa,CAAC,EAAE,QAAQ,CAAC;CAC3B,GACD,IAAI,CA8DN;AAgGD;;;GAGG;AACH,wBAAgB,uBAAuB,CACpC,GAAG,EAAE,WAAW,EAChB,QAAQ,EAAE,eAAe,GAAG,IAAI,EAChC,OAAO,EAAE,UAAU,EACnB,QAAQ,CAAC,EAAE,YAAY,GACvB,QAAQ,CAIV"}

package/dist/batch.d.ts

@@ -0,0 +1,61 @@
+import type { PdfSignOptions } from "./types.ts";
+/**
+ * Input for a single PDF in a batch signing operation.
+ */
+export type BatchSignInput = {
+    /** Filename for identification in events */
+    filename: string;
+    /** PDF content as Uint8Array or ReadableStream */
+    pdf: Uint8Array | ReadableStream<Uint8Array>;
+    /** Per-file option overrides merged with base options */
+    options?: Partial<PdfSignOptions>;
+};
+/**
+ * Events emitted during batch signing.
+ */
+export type BatchSignEvent = {
+    type: "file_start";
+    fileIndex: number;
+    filename: string;
+} | {
+    type: "file_complete";
+    fileIndex: number;
+    filename: string;
+    signed: Uint8Array;
+} | {
+    type: "file_error";
+    fileIndex: number;
+    filename: string;
+    error: string;
+} | {
+    type: "batch_complete";
+    totalFiles: number;
+    errorCount: number;
+};
+/**
+ * Sign multiple PDFs sequentially, yielding progress events.
+ *
+ * Yields control between each signing operation to prevent blocking
+ * the event loop under bulk load.
+ *
+ * @param files - Array of PDFs with filename and optional per-file options
+ * @param options - Base signing options (per-file options override these)
+ * @yields BatchSignEvent for each file start, completion, error, and batch complete
+ */
+export declare function signPdfBatch(files: BatchSignInput[], options: PdfSignOptions): AsyncGenerator<BatchSignEvent>;
+/**
+ * Sign multiple PDFs sequentially, collecting all results.
+ *
+ * Convenience wrapper around {@link signPdfBatch} that collects all events
+ * into an array of results.
+ *
+ * @param files - Array of PDFs with filename and optional per-file options
+ * @param options - Base signing options
+ * @returns Array of results with signed PDF bytes or error per file
+ */
+export declare function signPdfBatchToArray(files: BatchSignInput[], options: PdfSignOptions): Promise<{
+    filename: string;
+    signed?: Uint8Array;
+    error?: string;
+}[]>;
+//# sourceMappingURL=batch.d.ts.map

package/dist/batch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch.d.ts","sourceRoot":"","sources":["../src/batch.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC1B,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAC;IACjB,kDAAkD;IAClD,GAAG,EAAE,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC;IAC7C,yDAAyD;IACzD,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GACrB;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GAC3D;IACG,IAAI,EAAE,eAAe,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,UAAU,CAAC;CACrB,GACD;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAC1E;IAAE,IAAI,EAAE,gBAAgB,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,CAAC;AAExE;;;;;;;;;GASG;AACH,wBAAuB,YAAY,CAChC,KAAK,EAAE,cAAc,EAAE,EACvB,OAAO,EAAE,cAAc,GACvB,cAAc,CAAC,cAAc,CAAC,CAsChC;AAED;;;;;;;;;GASG;AACH,wBAAsB,mBAAmB,CACtC,KAAK,EAAE,cAAc,EAAE,EACvB,OAAO,EAAE,cAAc,GACvB,OAAO,CAAC;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,UAAU,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,EAAE,CAAC,CAoBtE"}

package/dist/detect-position.d.ts

@@ -0,0 +1,13 @@
+import type { DetectedPosition, DetectPositionOptions } from "./types.ts";
+/**
+ * Detect the best position to place a digital signature on a PDF.
+ *
+ * Uses weighted scoring across three signal types:
+ * - Signer name match (weight 3)
+ * - Horizontal line patterns (weight 2)
+ * - Signature keywords (weight 1)
+ *
+ * Returns null if the PDF cannot be parsed.
+ */
+export declare function detectSigningPosition(pdfData: Uint8Array, options?: DetectPositionOptions): DetectedPosition | null;
+//# sourceMappingURL=detect-position.d.ts.map

package/dist/detect-position.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"detect-position.d.ts","sourceRoot":"","sources":["../src/detect-position.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAoB1E;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAClC,OAAO,EAAE,UAAU,EACnB,OAAO,GAAE,qBAA0B,GACnC,gBAAgB,GAAG,IAAI,CAqIzB"}

package/dist/icp-brasil.d.ts

@@ -0,0 +1,60 @@
+/**
+ * ICP-Brasil Attributes for PAdES Signatures
+ *
+ * Implements the id-aa-signingCertificateV2 (RFC 5035) and
+ * id-aa-ets-sigPolicyId attributes required by ICP-Brasil.
+ *
+ * Uses @f-o-t/asn1 for ASN.1 construction and @f-o-t/crypto for hashing.
+ */
+/**
+ * Clear the cached signature policy data.
+ * Useful for testing or forcing a re-download.
+ */
+export declare function clearPolicyCache(): void;
+/**
+ * Build the id-aa-signingCertificateV2 attribute value (DER-encoded).
+ *
+ * This attribute links the signature to the specific certificate used to
+ * create it, preventing substitution attacks.
+ *
+ * ASN.1 structure (RFC 5035):
+ *
+ * SigningCertificateV2 ::= SEQUENCE {
+ *   certs SEQUENCE OF ESSCertIDv2
+ * }
+ *
+ * ESSCertIDv2 ::= SEQUENCE {
+ *   hashAlgorithm AlgorithmIdentifier DEFAULT {algorithm id-sha256},
+ *   certHash Hash,
+ *   issuerSerial IssuerSerial OPTIONAL
+ * }
+ *
+ * IssuerSerial ::= SEQUENCE {
+ *   issuer GeneralNames,
+ *   serialNumber CertificateSerialNumber
+ * }
+ *
+ * @param certDer - DER-encoded X.509 certificate
+ * @returns DER-encoded SigningCertificateV2 value
+ */
+export declare function buildSigningCertificateV2(certDer: Uint8Array): Uint8Array;
+/**
+ * Build the id-aa-ets-sigPolicyId attribute value (DER-encoded).
+ *
+ * Downloads the ICP-Brasil PAdES signature policy and extracts the
+ * embedded signPolicyHash to build the attribute.
+ *
+ * @returns DER-encoded SignaturePolicyIdentifier value
+ */
+export declare function buildSignaturePolicy(): Promise<Uint8Array>;
+/**
+ * Attribute OID constants for external use
+ */
+export declare const ICP_BRASIL_OIDS: {
+    readonly signingCertificateV2: "1.2.840.113549.1.9.16.2.47";
+    readonly signaturePolicy: "1.2.840.113549.1.9.16.2.15";
+};
+export declare class SignaturePolicyError extends Error {
+    constructor(message: string);
+}
+//# sourceMappingURL=icp-brasil.d.ts.map

package/dist/icp-brasil.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"icp-brasil.d.ts","sourceRoot":"","sources":["../src/icp-brasil.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AA8CH;;;GAGG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAEvC;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,UAAU,GAAG,UAAU,CAuCzE;AA2ED;;;;;;;GAOG;AACH,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,UAAU,CAAC,CA8BhE;AAED;;GAEG;AACH,eAAO,MAAM,eAAe;;;CAGlB,CAAC;AAMX,qBAAa,oBAAqB,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM;CAI7B"}