@embedpdf/plugin-signature 2.15.1 → 3.0.0-next.13

package/dist/contract-Dg50puf7.d.ts

@@ -0,0 +1,176 @@
+import { EventHook } from "@embedpdf/core";
+import { StampAsset } from "@embedpdf/plugin-stamp/contract";
+import { StampPlacement } from "@embedpdf/plugin-annotation/contract";
+import { SignatureVerdict, SignatureVerdict as SignatureVerdict$1, SignerPort, SignerPort as SignerPort$1, TrustPort, TrustPort as TrustPort$1, ValidationTime, ValidationTime as ValidationTime$1 } from "@embedpdf/core-signature";
+import { AnalyzeInput, AnalyzeInput as AnalyzeInput$1, BinarySource, ChangeAnalysis, ChangeAnalysis as ChangeAnalysis$1, DocMdpPermission, DocMdpPermission as DocMdpPermission$1, DocumentProtection, DocumentProtection as DocumentProtection$1, FieldLockSpec, FieldLockSpec as FieldLockSpec$1, FormFieldRef, FormFieldRef as FormFieldRef$1, SignatureCompleteResult, SignatureCompleteResult as SignatureCompleteResult$1, SignatureDTO, SignatureDTO as SignatureDTO$1, SignatureSnapshot, SignatureSnapshot as SignatureSnapshot$1 } from "@embedpdf/engine-core/runtime";
+//#region src/types.d.ts
+/**
+ * What placing a mark on a signature field does:
+ *   - `sign`    seal the field with the configured signer (the mark is the appearance);
+ *   - `visual`  draw the mark into the field without sealing (Preview's "signature");
+ *   - `ask`     neither — emit `ask` so the chrome can open its dialog and decide.
+ * Default `sign` when a signer is configured, else `visual`.
+ */
+type SignatureMode = 'sign' | 'visual' | 'ask';
+interface SignatureConfig {
+  mode?: SignatureMode;
+  /** The key holder: a raw signer (the CMS is built here) or a CMS signer (a service builds it). A thunk resolves per signing. */
+  signer?: SignerPort | (() => Promise<SignerPort>);
+  /** Trust anchors for validation. None → every verdict tops out at `valid-untrusted`. */
+  trust?: TrustPort;
+  /** Let the UI offer a certification (still needs `doc.sign.certify`). Default false. */
+  allowCertify?: boolean;
+}
+/** The mark: a stamp-plugin asset, or bytes the embedder brings (PNG, JPEG, or a one-page PDF). */
+type Mark = {
+  assetId: string;
+} | {
+  source: BinarySource;
+};
+interface SignFieldInput {
+  field: FormFieldRef;
+  mark: Mark;
+  /** What the signature dictionary says (`/Name` `/Reason` `/Location` `/ContactInfo`); the name defaults to the certificate's subject. */
+  attribution?: {
+    name?: string;
+    reason?: string;
+    location?: string;
+    contactInfo?: string;
+  };
+  /** Instead of the mark: a ready one-page appearance PDF the embedder composed itself. */
+  appearance?: BinarySource;
+  certify?: {
+    permission: DocMdpPermission;
+  };
+  lock?: FieldLockSpec;
+}
+/** The stamp-library kind that holds people's marks: one library per person. */
+declare const SIGNATURES_LIBRARY_KIND = "signatures";
+/** The asset identifiers inside a signatures library: the full signature and the initials. */
+declare const SIGNATURE_MARK_NAME = "signature";
+declare const INITIALS_MARK_NAME = "initials";
+type MarkRole = 'signature' | 'initials';
+/** Which mark an asset of a signatures library is (anything not named `initials` is a signature). */
+declare const markRoleOf: (asset: Pick<StampAsset, "name">) => MarkRole;
+interface SignaturePending {
+  signingId: string;
+  field: FormFieldRef;
+}
+interface SignatureState {
+  snapshot: SignatureSnapshot | null;
+  verdicts: SignatureVerdict[] | null;
+  /** The field the user chose to sign next ("select the field, then pick a mark"). */
+  target: FormFieldRef | null;
+  /** A signing candidate is parked (here or, on the cloud, elsewhere): the document is read-only. */
+  pending: SignaturePending | null;
+  /** A sign/fill call is in flight. */
+  busy: boolean;
+}
+type SignatureAction = {
+  type: 'SNAPSHOT';
+  snapshot: SignatureSnapshot | null;
+} | {
+  type: 'VERDICTS';
+  verdicts: SignatureVerdict[] | null;
+} | {
+  type: 'TARGET';
+  field: FormFieldRef | null;
+} | {
+  type: 'PENDING';
+  pending: SignaturePending | null;
+} | {
+  type: 'BUSY';
+  busy: boolean;
+};
+type SignatureChange = {
+  type: 'signed';
+  field: FormFieldRef;
+  result: SignatureCompleteResult;
+} | {
+  type: 'filled';
+  field: FormFieldRef;
+} | {
+  type: 'cleared';
+  field: FormFieldRef;
+} |
+/** Mode `ask`: a mark met a field and the chrome decides (open its dialog, then `signField`/`fillField`). */
+{
+  type: 'ask';
+  field: FormFieldRef;
+  mark: Mark;
+} |
+/** A signed field was activated: show what its signature says. */
+{
+  type: 'inspect';
+  field: FormFieldRef;
+} | {
+  type: 'target';
+  field: FormFieldRef | null;
+} | {
+  type: 'validated';
+  verdicts: SignatureVerdict[];
+} |
+/** An unsaved edit just turned a signature that held into one a save would invalidate. Once per edge. */
+{
+  type: 'invalidating';
+  field: FormFieldRef;
+  detail: string;
+} | {
+  type: 'protectionChanged';
+  protection: DocumentProtection;
+};
+interface SignatureCapability {
+  snapshot(): SignatureSnapshot | null;
+  verdicts(): SignatureVerdict[] | null;
+  protection(): DocumentProtection | null;
+  pending(): SignaturePending | null;
+  target(): FormFieldRef | null;
+  busy(): boolean;
+  mode(): SignatureMode;
+  /** The signature facts of one field, by ref or by widget, from the last snapshot. */
+  signatureOf(field: FormFieldRef | {
+    annotObjectNumber: number;
+  }): SignatureDTO | null;
+  /** The verdict of one signed field from the last validation. */
+  verdictOf(field: FormFieldRef | {
+    annotObjectNumber: number;
+  }): SignatureVerdict | null;
+  /** `doc.sign` is granted and a signer is configured (or resolvable). */
+  canSign(): boolean;
+  /** Visual fills ride `doc.forms.fill`. */
+  canFill(): boolean;
+  /** `allowCertify` and `doc.sign.certify`. */
+  canCertify(): boolean;
+  /** Seal the field: the mark's page becomes the widget's appearance, the configured signer signs. */
+  signField(input: SignFieldInput): Promise<SignatureCompleteResult>;
+  /** Visual only: the mark becomes the widget's appearance; nothing is sealed. Refused on a signed field. */
+  fillField(field: FormFieldRef, mark: Mark): Promise<void>;
+  /** Undo a visual fill (a blank appearance). Refused on a signed field. */
+  clearField(field: FormFieldRef): Promise<void>;
+  /** The destination rule in one call: a field (sign, fill, or ask by mode) or a free placement (a stamp). */
+  placeMark(mark: Mark, target: {
+    field: FormFieldRef;
+  } | StampPlacement): Promise<void>;
+  /** Name the field the next picked mark goes to (the chrome's "Sign here"); null clears. */
+  setTarget(field: FormFieldRef | null): void;
+  /** Ask the chrome to show a signed field's facts (`inspect`). */
+  inspect(field: FormFieldRef): void;
+  refresh(): Promise<SignatureSnapshot | null>;
+  /**
+   * Judge every signature. The viewer's default is the WORKING COPY: unsaved
+   * edits count, so the verdict is the one the file a save produces will get.
+   * `until: 'persisted'` judges the loaded bytes only.
+   */
+  validate(opts?: {
+    at?: ValidationTime;
+    until?: 'persisted' | 'working-copy';
+  }): Promise<SignatureVerdict[]>;
+  analyze(input: AnalyzeInput): Promise<ChangeAnalysis>;
+  /** The exact bytes a signature's revision covers (`doc.signatures.revisionBytes`) — rides `doc.download`. */
+  revisionBytes(revisionIndex: number): Promise<Uint8Array>;
+  onChanged: EventHook<SignatureChange>;
+}
+declare const SignatureToken: import("@embedpdf/core").CapabilityToken<SignatureCapability>;
+//#endregion
+export { SignatureConfig as C, SignatureToken as D, SignatureState as E, markRoleOf as O, SignatureChange as S, SignaturePending as T, SIGNATURES_LIBRARY_KIND as _, FieldLockSpec$1 as a, SignatureAction as b, SignatureDTO$1 as c, SignerPort$1 as d, TrustPort$1 as f, MarkRole as g, Mark as h, DocumentProtection$1 as i, SignatureSnapshot$1 as l, INITIALS_MARK_NAME as m, ChangeAnalysis$1 as n, FormFieldRef$1 as o, ValidationTime$1 as p, DocMdpPermission$1 as r, SignatureCompleteResult$1 as s, AnalyzeInput$1 as t, SignatureVerdict$1 as u, SIGNATURE_MARK_NAME as v, SignatureMode as w, SignatureCapability as x, SignFieldInput as y };
+//# sourceMappingURL=contract-Dg50puf7.d.ts.map

package/dist/contract.cjs

@@ -0,0 +1,7 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_contract = require("./contract-CojqGdMH.cjs");
+exports.INITIALS_MARK_NAME = require_contract.INITIALS_MARK_NAME;
+exports.SIGNATURES_LIBRARY_KIND = require_contract.SIGNATURES_LIBRARY_KIND;
+exports.SIGNATURE_MARK_NAME = require_contract.SIGNATURE_MARK_NAME;
+exports.SignatureToken = require_contract.SignatureToken;
+exports.markRoleOf = require_contract.markRoleOf;

package/dist/contract.d.cts

@@ -0,0 +1,2 @@
+import { C as SignatureConfig, D as SignatureToken, E as SignatureState, O as markRoleOf, S as SignatureChange, T as SignaturePending, _ as SIGNATURES_LIBRARY_KIND, a as FieldLockSpec, b as SignatureAction, c as SignatureDTO, d as SignerPort, f as TrustPort, g as MarkRole, h as Mark, i as DocumentProtection, l as SignatureSnapshot, m as INITIALS_MARK_NAME, n as ChangeAnalysis, o as FormFieldRef, p as ValidationTime, r as DocMdpPermission, s as SignatureCompleteResult, t as AnalyzeInput, u as SignatureVerdict, v as SIGNATURE_MARK_NAME, w as SignatureMode, x as SignatureCapability, y as SignFieldInput } from "./contract-BvHa9Zl_.cjs";
+export { type AnalyzeInput, type ChangeAnalysis, type DocMdpPermission, type DocumentProtection, type FieldLockSpec, type FormFieldRef, INITIALS_MARK_NAME, type Mark, type MarkRole, SIGNATURES_LIBRARY_KIND, SIGNATURE_MARK_NAME, type SignFieldInput, type SignatureAction, type SignatureCapability, type SignatureChange, type SignatureCompleteResult, type SignatureConfig, type SignatureDTO, type SignatureMode, type SignaturePending, type SignatureSnapshot, type SignatureState, SignatureToken, type SignatureVerdict, type SignerPort, type TrustPort, type ValidationTime, markRoleOf };

package/dist/contract.d.ts

@@ -0,0 +1,2 @@
+import { C as SignatureConfig, D as SignatureToken, E as SignatureState, O as markRoleOf, S as SignatureChange, T as SignaturePending, _ as SIGNATURES_LIBRARY_KIND, a as FieldLockSpec, b as SignatureAction, c as SignatureDTO, d as SignerPort, f as TrustPort, g as MarkRole, h as Mark, i as DocumentProtection, l as SignatureSnapshot, m as INITIALS_MARK_NAME, n as ChangeAnalysis, o as FormFieldRef, p as ValidationTime, r as DocMdpPermission, s as SignatureCompleteResult, t as AnalyzeInput, u as SignatureVerdict, v as SIGNATURE_MARK_NAME, w as SignatureMode, x as SignatureCapability, y as SignFieldInput } from "./contract-Dg50puf7.js";
+export { type AnalyzeInput, type ChangeAnalysis, type DocMdpPermission, type DocumentProtection, type FieldLockSpec, type FormFieldRef, INITIALS_MARK_NAME, type Mark, type MarkRole, SIGNATURES_LIBRARY_KIND, SIGNATURE_MARK_NAME, type SignFieldInput, type SignatureAction, type SignatureCapability, type SignatureChange, type SignatureCompleteResult, type SignatureConfig, type SignatureDTO, type SignatureMode, type SignaturePending, type SignatureSnapshot, type SignatureState, SignatureToken, type SignatureVerdict, type SignerPort, type TrustPort, type ValidationTime, markRoleOf };

package/dist/contract.js

@@ -0,0 +1,2 @@
+import { a as markRoleOf, i as SignatureToken, n as SIGNATURES_LIBRARY_KIND, r as SIGNATURE_MARK_NAME, t as INITIALS_MARK_NAME } from "./contract-C3nQtwGf.js";
+export { INITIALS_MARK_NAME, SIGNATURES_LIBRARY_KIND, SIGNATURE_MARK_NAME, SignatureToken, markRoleOf };