@embedpdf/engine-core 3.0.0-next.11 → 3.0.0-next.13

package/dist/conformance.d.cts

@@ -1,5 +1,5 @@
-import { An as HighlightDraft, Ds as CharMapAnchor, cl as LinePoints, dl as PdfRect, jl as DocumentMetadata, ll as PdfPoint, n as AnnotationListSnapshotAllPages, ol as InkList, t as AnnotationListPageSnapshot } from "./AnnotationListSnapshot-C1U3XUxP.cjs";
-import { t as Engine } from "./Engine-D3868xIU.cjs";
+import { $u as PdfRect, An as HighlightDraft, Ju as InkList, Mc as CharMapAnchor, Xu as LinePoints, Zu as PdfPoint, n as AnnotationListSnapshotAllPages, t as AnnotationListPageSnapshot, yd as DocumentMetadata } from "./AnnotationListSnapshot-D3mFut1e.cjs";
+import { t as Engine } from "./Engine-Bx0NOfmd.cjs";
 //#region src/conformance/runMetadataConformance.d.ts
 interface ConformanceTestRunner {
   describe(name: string, fn: () => void): void;
@@ -356,6 +356,53 @@ declare function runPageRotateConformance(runner: ConformanceTestRunner, opts: C
  */
 declare function runPageDeleteConformance(runner: ConformanceTestRunner, opts: ConformanceOptions): void;
 //#endregion
+//#region src/conformance/runNamedPagesConformance.d.ts
+/**
+ * Named-pages conformance: the catalog's `/Names /Pages` registry as LAYOUT
+ * data. Locks the invariants both engines must share — do not loosen
+ * without re-reading `NamedPageEntry` and `PageNameResult`:
+ *
+ *   1. `pages.list().namedPages` is present (possibly empty) and every
+ *      registration resolves to a page in `pages`, a template, or is
+ *      reported dangling — never silently dropped.
+ *   2. `pages.setName()` creates or replaces by decoded key (idempotent),
+ *      `replace` renames in one job, and the result IS the new layout.
+ *   3. `pages.removeName()` drops the registration and nothing else.
+ *   4. Deleting a page removes every registration pointing at it — inside
+ *      the delete, with no plugin in the loop.
+ *   5. Non-ASCII keys round-trip unchanged (Acrobat writes UTF-16 + BOM).
+ *
+ * Skips cleanly when the engine does not implement the optional members.
+ */
+declare function runNamedPagesConformance(runner: ConformanceTestRunner, opts: ConformanceOptions): void;
+//#endregion
+//#region src/conformance/runAnnotationFlattenConformance.d.ts
+/**
+ * Selective annotation flatten: `page(pon).annotations.flatten(refs)` is
+ * `pages.flatten` for a chosen set. Locks, on every engine:
+ *   1. only the given refs are painted and removed; the rest of the page's
+ *      annotations are untouched;
+ *   2. per-ref status (`applied` / `skipped`), one `annotations.flattened`
+ *      event, a `meta` with that page's new pins, layout unchanged;
+ *   3. a hidden ref is `skipped`; a ref on another page rejects `InvalidArg`
+ *      with nothing mutated.
+ * Skips cleanly when the engine does not implement the optional member.
+ */
+declare function runAnnotationFlattenConformance(runner: ConformanceTestRunner, opts: ConformanceOptions): void;
+//#endregion
+//#region src/conformance/runAnnotationAppearanceExportConformance.d.ts
+/**
+ * `page(pon).annotations.exportAppearance(refs)`: the chosen annotations'
+ * appearances as ONE single-page PDF sized to their union /Rect. Locks:
+ *   1. bytes are a PDF; the source page is untouched (no mutation, no
+ *      revision bump);
+ *   2. re-opened (local engines), the page is exactly the union size and the
+ *      requested count of annotations is gone — they are content now;
+ *   3. a ref on another page rejects `InvalidArg`; an empty list rejects.
+ * Skips cleanly when the engine does not implement the optional member.
+ */
+declare function runAnnotationAppearanceExportConformance(runner: ConformanceTestRunner, opts: ConformanceOptions): void;
+//#endregion
 //#region src/conformance/runPageFlattenConformance.d.ts
 /** Transport-neutral coverage for the content + annotation flatten rail. */
 declare function runPageFlattenConformance(runner: ConformanceTestRunner, opts: ConformanceOptions): void;
@@ -650,5 +697,72 @@ declare function runSearchConformance(runner: ConformanceTestRunner, opts: Searc
 declare function diffAnnotationListSnapshot(a: AnnotationListPageSnapshot, b: AnnotationListPageSnapshot): string[];
 declare function diffAnnotationListSnapshotAll(a: AnnotationListSnapshotAllPages, b: AnnotationListSnapshotAllPages): string[];
 //#endregion
-export { type ActionsConformanceFixtures, type ActionsConformanceOptions, type AnnotationAppearanceConformanceFixture, type AnnotationAppearanceConformanceOptions, type AnnotationConformanceOptions, type AnnotationMutationConformanceFixture, type AnnotationMutationConformanceOptions, type AnnotationReadConformanceFixture, type ConformanceExpect, type ConformanceFixture, type ConformanceOptions, type ConformanceTestRunner, type FormConformanceFixtures, type FormConformanceOptions, type PageGeometryOrientationFixture, type PageGeometryOrientationOptions, type PageReorderConformanceFixture, type PageReorderConformanceOptions, type PageTextConformanceFixture, type PageTextConformanceOptions, type SearchConformanceFixture, type SearchConformanceOptions, TEXT_DIVERGENCE_CASES, type TextDivergenceCase, type TextDivergenceConformanceFixture, type TextDivergenceConformanceOptions, diffAnnotationListSnapshot, diffAnnotationListSnapshotAll, runActionsConformance, runAnnotationAppearanceConformance, runAnnotationMutationConformance, runAnnotationReadConformance, runAttachmentConformance, runDocumentEventsConformance, runFormConformance, runMetadataConformance, runPageDeleteConformance, runPageExtractConformance, runPageFlattenConformance, runPageGeometryOrientationConformance, runPageInsertBlankConformance, runPageInsertConformance, runPageReorderConformance, runPageRotateConformance, runPageTextConformance, runPieceInfoConformance, runRedactionApplyConformance, runSearchConformance, runTextDivergenceConformance };
+//#region src/conformance/runSignatureConformance.d.ts
+interface SignatureConformanceFixtures {
+  /** A form with no signature fields at all. */
+  unsignedForm: ConformanceFixture;
+  /**
+   * Three revisions: the original, an approval signature sealing revision
+   * 1, and a form fill plus a second approval signature sealing revision
+   * 2. Both signatures have whole-revision coverage; `textField` is the
+   * filled text field.
+   */
+  twoApprovals: ConformanceFixture & {
+    fieldNames: [string, string];
+    textField: string;
+  };
+  /** Two revisions: a certification signature with permission 2 sealing revision 1. */
+  certified: ConformanceFixture & {
+    fieldName: string;
+  };
+  /** Two revisions: one approval signature whose FieldMDP includes `lockedField`. */
+  fieldMdp: ConformanceFixture & {
+    fieldName: string;
+    lockedField: string;
+  };
+  /** Three chained revisions, two signatures whose ranges are well-formed but seal no revision. */
+  partialChain: ConformanceFixture;
+  /** One unsigned signature field (with a widget) and one text field, nothing signed. */
+  unsignedSigField: ConformanceFixture & {
+    fieldName: string;
+    textField: string;
+  };
+  /** Any single-page PDF, used as signature artwork. */
+  artwork: ConformanceFixture;
+}
+interface SignatureConformanceOptions {
+  label: string;
+  makeEngine: () => Promise<Engine> | Engine;
+  /**
+   * An engine constructed with `signedDocumentPolicy: 'permit'`; the
+   * suite proves the protection it lifts. Omit where the engine has no
+   * such option.
+   */
+  makePermitEngine?: () => Promise<Engine> | Engine;
+  /** `layerBytes` opens each fixture as an immutable base with a fresh layer on top. */
+  openKind: 'bytes' | 'layerBytes' | 'id';
+  fixtures: SignatureConformanceFixtures;
+}
+/**
+ * Digital signatures, read side. The service is OPTIONAL on the contract
+ * (`downloadLayer?` pattern) — the suite runs only where the engine
+ * provides it.
+ *
+ * Invariants:
+ *   1. Byte facts describe the LOADED bytes: a revision is a byte prefix,
+ *      a whole-revision signature seals exactly one, the digest over its
+ *      `/ByteRange` is what the file's bytes hash to, and an unsaved edit
+ *      changes none of it.
+ *   2. Protection is derived from the signatures in the file and applied
+ *      as document-derived capabilities: a certification with permission 2
+ *      takes page assembly and annotation writes away, a FieldMDP freezes
+ *      the fields it names, a rewrite save is refused. Under
+ *      `signedDocumentPolicy: 'permit'` none of that applies and the
+ *      analysis is unchanged.
+ *   3. The same answers come from a plain session and from a layer
+ *      session over the same bytes.
+ */
+declare function runSignatureConformance(runner: ConformanceTestRunner, opts: SignatureConformanceOptions): void;
+//#endregion
+export { type ActionsConformanceFixtures, type ActionsConformanceOptions, type AnnotationAppearanceConformanceFixture, type AnnotationAppearanceConformanceOptions, type AnnotationConformanceOptions, type AnnotationMutationConformanceFixture, type AnnotationMutationConformanceOptions, type AnnotationReadConformanceFixture, type ConformanceExpect, type ConformanceFixture, type ConformanceOptions, type ConformanceTestRunner, type FormConformanceFixtures, type FormConformanceOptions, type PageGeometryOrientationFixture, type PageGeometryOrientationOptions, type PageReorderConformanceFixture, type PageReorderConformanceOptions, type PageTextConformanceFixture, type PageTextConformanceOptions, type SearchConformanceFixture, type SearchConformanceOptions, type SignatureConformanceFixtures, type SignatureConformanceOptions, TEXT_DIVERGENCE_CASES, type TextDivergenceCase, type TextDivergenceConformanceFixture, type TextDivergenceConformanceOptions, diffAnnotationListSnapshot, diffAnnotationListSnapshotAll, runActionsConformance, runAnnotationAppearanceConformance, runAnnotationAppearanceExportConformance, runAnnotationFlattenConformance, runAnnotationMutationConformance, runAnnotationReadConformance, runAttachmentConformance, runDocumentEventsConformance, runFormConformance, runMetadataConformance, runNamedPagesConformance, runPageDeleteConformance, runPageExtractConformance, runPageFlattenConformance, runPageGeometryOrientationConformance, runPageInsertBlankConformance, runPageInsertConformance, runPageReorderConformance, runPageRotateConformance, runPageTextConformance, runPieceInfoConformance, runRedactionApplyConformance, runSearchConformance, runSignatureConformance, runTextDivergenceConformance };
 //# sourceMappingURL=conformance.d.cts.map

package/dist/conformance.d.ts

@@ -1,5 +1,5 @@
-import { An as HighlightDraft, Ds as CharMapAnchor, cl as LinePoints, dl as PdfRect, jl as DocumentMetadata, ll as PdfPoint, n as AnnotationListSnapshotAllPages, ol as InkList, t as AnnotationListPageSnapshot } from "./AnnotationListSnapshot-C1U3XUxP.js";
-import { t as Engine } from "./Engine-CWnAKccD.js";
+import { $u as PdfRect, An as HighlightDraft, Ju as InkList, Mc as CharMapAnchor, Xu as LinePoints, Zu as PdfPoint, n as AnnotationListSnapshotAllPages, t as AnnotationListPageSnapshot, yd as DocumentMetadata } from "./AnnotationListSnapshot-D3mFut1e.js";
+import { t as Engine } from "./Engine-DxtpCYcP.js";
 //#region src/conformance/runMetadataConformance.d.ts
 interface ConformanceTestRunner {
   describe(name: string, fn: () => void): void;
@@ -356,6 +356,53 @@ declare function runPageRotateConformance(runner: ConformanceTestRunner, opts: C
  */
 declare function runPageDeleteConformance(runner: ConformanceTestRunner, opts: ConformanceOptions): void;
 //#endregion
+//#region src/conformance/runNamedPagesConformance.d.ts
+/**
+ * Named-pages conformance: the catalog's `/Names /Pages` registry as LAYOUT
+ * data. Locks the invariants both engines must share — do not loosen
+ * without re-reading `NamedPageEntry` and `PageNameResult`:
+ *
+ *   1. `pages.list().namedPages` is present (possibly empty) and every
+ *      registration resolves to a page in `pages`, a template, or is
+ *      reported dangling — never silently dropped.
+ *   2. `pages.setName()` creates or replaces by decoded key (idempotent),
+ *      `replace` renames in one job, and the result IS the new layout.
+ *   3. `pages.removeName()` drops the registration and nothing else.
+ *   4. Deleting a page removes every registration pointing at it — inside
+ *      the delete, with no plugin in the loop.
+ *   5. Non-ASCII keys round-trip unchanged (Acrobat writes UTF-16 + BOM).
+ *
+ * Skips cleanly when the engine does not implement the optional members.
+ */
+declare function runNamedPagesConformance(runner: ConformanceTestRunner, opts: ConformanceOptions): void;
+//#endregion
+//#region src/conformance/runAnnotationFlattenConformance.d.ts
+/**
+ * Selective annotation flatten: `page(pon).annotations.flatten(refs)` is
+ * `pages.flatten` for a chosen set. Locks, on every engine:
+ *   1. only the given refs are painted and removed; the rest of the page's
+ *      annotations are untouched;
+ *   2. per-ref status (`applied` / `skipped`), one `annotations.flattened`
+ *      event, a `meta` with that page's new pins, layout unchanged;
+ *   3. a hidden ref is `skipped`; a ref on another page rejects `InvalidArg`
+ *      with nothing mutated.
+ * Skips cleanly when the engine does not implement the optional member.
+ */
+declare function runAnnotationFlattenConformance(runner: ConformanceTestRunner, opts: ConformanceOptions): void;
+//#endregion
+//#region src/conformance/runAnnotationAppearanceExportConformance.d.ts
+/**
+ * `page(pon).annotations.exportAppearance(refs)`: the chosen annotations'
+ * appearances as ONE single-page PDF sized to their union /Rect. Locks:
+ *   1. bytes are a PDF; the source page is untouched (no mutation, no
+ *      revision bump);
+ *   2. re-opened (local engines), the page is exactly the union size and the
+ *      requested count of annotations is gone — they are content now;
+ *   3. a ref on another page rejects `InvalidArg`; an empty list rejects.
+ * Skips cleanly when the engine does not implement the optional member.
+ */
+declare function runAnnotationAppearanceExportConformance(runner: ConformanceTestRunner, opts: ConformanceOptions): void;
+//#endregion
 //#region src/conformance/runPageFlattenConformance.d.ts
 /** Transport-neutral coverage for the content + annotation flatten rail. */
 declare function runPageFlattenConformance(runner: ConformanceTestRunner, opts: ConformanceOptions): void;
@@ -650,5 +697,72 @@ declare function runSearchConformance(runner: ConformanceTestRunner, opts: Searc
 declare function diffAnnotationListSnapshot(a: AnnotationListPageSnapshot, b: AnnotationListPageSnapshot): string[];
 declare function diffAnnotationListSnapshotAll(a: AnnotationListSnapshotAllPages, b: AnnotationListSnapshotAllPages): string[];
 //#endregion
-export { type ActionsConformanceFixtures, type ActionsConformanceOptions, type AnnotationAppearanceConformanceFixture, type AnnotationAppearanceConformanceOptions, type AnnotationConformanceOptions, type AnnotationMutationConformanceFixture, type AnnotationMutationConformanceOptions, type AnnotationReadConformanceFixture, type ConformanceExpect, type ConformanceFixture, type ConformanceOptions, type ConformanceTestRunner, type FormConformanceFixtures, type FormConformanceOptions, type PageGeometryOrientationFixture, type PageGeometryOrientationOptions, type PageReorderConformanceFixture, type PageReorderConformanceOptions, type PageTextConformanceFixture, type PageTextConformanceOptions, type SearchConformanceFixture, type SearchConformanceOptions, TEXT_DIVERGENCE_CASES, type TextDivergenceCase, type TextDivergenceConformanceFixture, type TextDivergenceConformanceOptions, diffAnnotationListSnapshot, diffAnnotationListSnapshotAll, runActionsConformance, runAnnotationAppearanceConformance, runAnnotationMutationConformance, runAnnotationReadConformance, runAttachmentConformance, runDocumentEventsConformance, runFormConformance, runMetadataConformance, runPageDeleteConformance, runPageExtractConformance, runPageFlattenConformance, runPageGeometryOrientationConformance, runPageInsertBlankConformance, runPageInsertConformance, runPageReorderConformance, runPageRotateConformance, runPageTextConformance, runPieceInfoConformance, runRedactionApplyConformance, runSearchConformance, runTextDivergenceConformance };
+//#region src/conformance/runSignatureConformance.d.ts
+interface SignatureConformanceFixtures {
+  /** A form with no signature fields at all. */
+  unsignedForm: ConformanceFixture;
+  /**
+   * Three revisions: the original, an approval signature sealing revision
+   * 1, and a form fill plus a second approval signature sealing revision
+   * 2. Both signatures have whole-revision coverage; `textField` is the
+   * filled text field.
+   */
+  twoApprovals: ConformanceFixture & {
+    fieldNames: [string, string];
+    textField: string;
+  };
+  /** Two revisions: a certification signature with permission 2 sealing revision 1. */
+  certified: ConformanceFixture & {
+    fieldName: string;
+  };
+  /** Two revisions: one approval signature whose FieldMDP includes `lockedField`. */
+  fieldMdp: ConformanceFixture & {
+    fieldName: string;
+    lockedField: string;
+  };
+  /** Three chained revisions, two signatures whose ranges are well-formed but seal no revision. */
+  partialChain: ConformanceFixture;
+  /** One unsigned signature field (with a widget) and one text field, nothing signed. */
+  unsignedSigField: ConformanceFixture & {
+    fieldName: string;
+    textField: string;
+  };
+  /** Any single-page PDF, used as signature artwork. */
+  artwork: ConformanceFixture;
+}
+interface SignatureConformanceOptions {
+  label: string;
+  makeEngine: () => Promise<Engine> | Engine;
+  /**
+   * An engine constructed with `signedDocumentPolicy: 'permit'`; the
+   * suite proves the protection it lifts. Omit where the engine has no
+   * such option.
+   */
+  makePermitEngine?: () => Promise<Engine> | Engine;
+  /** `layerBytes` opens each fixture as an immutable base with a fresh layer on top. */
+  openKind: 'bytes' | 'layerBytes' | 'id';
+  fixtures: SignatureConformanceFixtures;
+}
+/**
+ * Digital signatures, read side. The service is OPTIONAL on the contract
+ * (`downloadLayer?` pattern) — the suite runs only where the engine
+ * provides it.
+ *
+ * Invariants:
+ *   1. Byte facts describe the LOADED bytes: a revision is a byte prefix,
+ *      a whole-revision signature seals exactly one, the digest over its
+ *      `/ByteRange` is what the file's bytes hash to, and an unsaved edit
+ *      changes none of it.
+ *   2. Protection is derived from the signatures in the file and applied
+ *      as document-derived capabilities: a certification with permission 2
+ *      takes page assembly and annotation writes away, a FieldMDP freezes
+ *      the fields it names, a rewrite save is refused. Under
+ *      `signedDocumentPolicy: 'permit'` none of that applies and the
+ *      analysis is unchanged.
+ *   3. The same answers come from a plain session and from a layer
+ *      session over the same bytes.
+ */
+declare function runSignatureConformance(runner: ConformanceTestRunner, opts: SignatureConformanceOptions): void;
+//#endregion
+export { type ActionsConformanceFixtures, type ActionsConformanceOptions, type AnnotationAppearanceConformanceFixture, type AnnotationAppearanceConformanceOptions, type AnnotationConformanceOptions, type AnnotationMutationConformanceFixture, type AnnotationMutationConformanceOptions, type AnnotationReadConformanceFixture, type ConformanceExpect, type ConformanceFixture, type ConformanceOptions, type ConformanceTestRunner, type FormConformanceFixtures, type FormConformanceOptions, type PageGeometryOrientationFixture, type PageGeometryOrientationOptions, type PageReorderConformanceFixture, type PageReorderConformanceOptions, type PageTextConformanceFixture, type PageTextConformanceOptions, type SearchConformanceFixture, type SearchConformanceOptions, type SignatureConformanceFixtures, type SignatureConformanceOptions, TEXT_DIVERGENCE_CASES, type TextDivergenceCase, type TextDivergenceConformanceFixture, type TextDivergenceConformanceOptions, diffAnnotationListSnapshot, diffAnnotationListSnapshotAll, runActionsConformance, runAnnotationAppearanceConformance, runAnnotationAppearanceExportConformance, runAnnotationFlattenConformance, runAnnotationMutationConformance, runAnnotationReadConformance, runAttachmentConformance, runDocumentEventsConformance, runFormConformance, runMetadataConformance, runNamedPagesConformance, runPageDeleteConformance, runPageExtractConformance, runPageFlattenConformance, runPageGeometryOrientationConformance, runPageInsertBlankConformance, runPageInsertConformance, runPageReorderConformance, runPageRotateConformance, runPageTextConformance, runPieceInfoConformance, runRedactionApplyConformance, runSearchConformance, runSignatureConformance, runTextDivergenceConformance };
 //# sourceMappingURL=conformance.d.ts.map