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

package/LICENSE

@@ -1,21 +1,192 @@
-MIT License
-
-Copyright (c) 2025 CloudPDF
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+Copyright 2026 CloudPDF LTD
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use files in this distribution except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-----------------------------------------------------------------------
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,38 @@
+# @embedpdf/plugin-signature
+
+Document-scoped digital signing for EmbedPDF v3: sign a signature field with a
+**mark** (a stamp-library asset — drawn, typed, uploaded — or bytes you bring)
+through a **signer port** you configure; fill a field visually without
+sealing; validate what is signed; and drop an armed mark onto a field.
+
+The plugin owns the act and nothing else:
+
+- marks are the stamp plugin's (`@embedpdf/plugin-stamp`) — one library of kind
+  `signatures` per person, holding a `signature` asset and optional `initials`;
+- the key is a `SignerPort` from `@embedpdf/core-signature` (`webCryptoSigner`,
+  `remoteSigner`, `personalSigner`), resolved per signing;
+- the engine draws the mark's page into the field and seals the bytes
+  (`doc.signatures.prepare` → CMS → `complete`); on the cloud the server
+  publishes the new version.
+
+```ts
+import { signaturePlugin, personalSigner, indexedDbKeyStore } from '@embedpdf/plugin-signature';
+
+signaturePlugin({
+  signer: () => personalSigner({ subject: 'Ada Lovelace', store: indexedDbKeyStore('keys') }),
+  trust: { anchors: async () => [rootCertificateDer] },
+  mode: 'sign', // 'sign' (default with a signer) | 'visual' (default without) | 'ask'
+});
+
+const signature = ctx.get(SignatureToken);
+await signature.placeMark({ assetId }, { field: { kind: 'fqn', name: 'sig' } }); // sign / fill / ask, by mode
+await signature.placeMark({ assetId }, { pageObjectNumber, at: { x: 120, y: 90 } }); // elsewhere: a stamp
+```
+
+With the interaction hub and the stamp plugin present, a mark armed from a
+`signatures` library and clicked over an unsigned signature field goes into
+the field; anywhere else it is placed as a stamp.
+
+Requires `@embedpdf/plugin-form`; optional `@embedpdf/plugin-stamp`,
+`@embedpdf/plugin-annotation`, `@embedpdf/plugin-interaction`. See the docs
+page `headless/plugins/signature` for the full contract.

package/dist/contract-BvHa9Zl_.d.cts

@@ -0,0 +1,176 @@
+import { EventHook } from "@embedpdf/core";
+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";
+import { StampPlacement } from "@embedpdf/plugin-annotation/contract";
+import { StampAsset } from "@embedpdf/plugin-stamp/contract";
+//#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-BvHa9Zl_.d.cts.map

package/dist/contract-C3nQtwGf.js

@@ -0,0 +1,14 @@
+import { createCapabilityToken } from "@embedpdf/core";
+//#region src/types.ts
+/** The stamp-library kind that holds people's marks: one library per person. */
+const SIGNATURES_LIBRARY_KIND = "signatures";
+/** The asset identifiers inside a signatures library: the full signature and the initials. */
+const SIGNATURE_MARK_NAME = "signature";
+const INITIALS_MARK_NAME = "initials";
+/** Which mark an asset of a signatures library is (anything not named `initials` is a signature). */
+const markRoleOf = (asset) => asset.name === "initials" ? "initials" : "signature";
+const SignatureToken = createCapabilityToken("signature");
+//#endregion
+export { markRoleOf as a, SignatureToken as i, SIGNATURES_LIBRARY_KIND as n, SIGNATURE_MARK_NAME as r, INITIALS_MARK_NAME as t };
+
+//# sourceMappingURL=contract-C3nQtwGf.js.map

package/dist/contract-C3nQtwGf.js.map

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

package/dist/contract-CojqGdMH.cjs

@@ -0,0 +1,43 @@
+let _embedpdf_core = require("@embedpdf/core");
+//#region src/types.ts
+/** The stamp-library kind that holds people's marks: one library per person. */
+const SIGNATURES_LIBRARY_KIND = "signatures";
+/** The asset identifiers inside a signatures library: the full signature and the initials. */
+const SIGNATURE_MARK_NAME = "signature";
+const INITIALS_MARK_NAME = "initials";
+/** Which mark an asset of a signatures library is (anything not named `initials` is a signature). */
+const markRoleOf = (asset) => asset.name === "initials" ? "initials" : "signature";
+const SignatureToken = (0, _embedpdf_core.createCapabilityToken)("signature");
+//#endregion
+Object.defineProperty(exports, "INITIALS_MARK_NAME", {
+	enumerable: true,
+	get: function() {
+		return INITIALS_MARK_NAME;
+	}
+});
+Object.defineProperty(exports, "SIGNATURES_LIBRARY_KIND", {
+	enumerable: true,
+	get: function() {
+		return SIGNATURES_LIBRARY_KIND;
+	}
+});
+Object.defineProperty(exports, "SIGNATURE_MARK_NAME", {
+	enumerable: true,
+	get: function() {
+		return SIGNATURE_MARK_NAME;
+	}
+});
+Object.defineProperty(exports, "SignatureToken", {
+	enumerable: true,
+	get: function() {
+		return SignatureToken;
+	}
+});
+Object.defineProperty(exports, "markRoleOf", {
+	enumerable: true,
+	get: function() {
+		return markRoleOf;
+	}
+});
+
+//# sourceMappingURL=contract-CojqGdMH.cjs.map

package/dist/contract-CojqGdMH.cjs.map

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