@embedpdf/engine-core 3.0.0-next.10 → 3.0.0-next.12

package/dist/conformance.d.cts

@@ -1,5 +1,5 @@
-import { An as HighlightDraft, Ss as CharMapAnchor, al as LinePoints, cl as PdfRect, n as AnnotationListSnapshotAllPages, ol as PdfPoint, rl as InkList, t as AnnotationListPageSnapshot, xl as DocumentMetadata } from "./AnnotationListSnapshot-DDxHpJQU.cjs";
-import { t as Engine } from "./Engine-D9je6GdU.cjs";
+import { An as HighlightDraft, Bl as DocumentMetadata, Ps as CharMapAnchor, _l as LinePoints, bl as PdfRect, hl as InkList, n as AnnotationListSnapshotAllPages, t as AnnotationListPageSnapshot, vl as PdfPoint } from "./AnnotationListSnapshot-x6tKulNV.cjs";
+import { t as Engine } from "./Engine--0XF0UAK.cjs";
 //#region src/conformance/runMetadataConformance.d.ts
 interface ConformanceTestRunner {
   describe(name: string, fn: () => void): void;
@@ -16,6 +16,7 @@ interface ConformanceExpect {
     toHaveLength(expected: number): void;
     toMatch(re: RegExp): void;
     toMatchObject(shape: Record<string, unknown>): void;
+    toContain(expected: unknown): void;
     toBeInstanceOf(ctor: Function): void;
     toBeTruthy(): void;
     rejects: {
@@ -101,6 +102,11 @@ interface ActionsConformanceFixtures {
   page: ConformanceFixture;
   annotation: ConformanceFixture;
   field: ConformanceFixture;
+  /** `action_payloads.pdf` — every executable payload shape on one page of
+   *  /NM-keyed links. REQUIRED on both flavours: payload parity is a gate. */
+  payloads: ConformanceFixture;
+  /** `open_action_dest.pdf` — a destination-form catalog `/OpenAction`. */
+  openDestination: ConformanceFixture;
   /** A page whose only annotation is a Link with a `/S /JavaScript` action.
    *  Optional: the javascript-link classification test skips without it. */
   javascriptLink?: ConformanceFixture;
@@ -350,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;
@@ -644,5 +697,5 @@ 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 };
+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, runAnnotationAppearanceExportConformance, runAnnotationFlattenConformance, runAnnotationMutationConformance, runAnnotationReadConformance, runAttachmentConformance, runDocumentEventsConformance, runFormConformance, runMetadataConformance, runNamedPagesConformance, runPageDeleteConformance, runPageExtractConformance, runPageFlattenConformance, runPageGeometryOrientationConformance, runPageInsertBlankConformance, runPageInsertConformance, runPageReorderConformance, runPageRotateConformance, runPageTextConformance, runPieceInfoConformance, runRedactionApplyConformance, runSearchConformance, runTextDivergenceConformance };
 //# sourceMappingURL=conformance.d.cts.map

package/dist/conformance.d.ts

@@ -1,5 +1,5 @@
-import { An as HighlightDraft, Ss as CharMapAnchor, al as LinePoints, cl as PdfRect, n as AnnotationListSnapshotAllPages, ol as PdfPoint, rl as InkList, t as AnnotationListPageSnapshot, xl as DocumentMetadata } from "./AnnotationListSnapshot-DDxHpJQU.js";
-import { t as Engine } from "./Engine-DOoVem7_.js";
+import { An as HighlightDraft, Bl as DocumentMetadata, Ps as CharMapAnchor, _l as LinePoints, bl as PdfRect, hl as InkList, n as AnnotationListSnapshotAllPages, t as AnnotationListPageSnapshot, vl as PdfPoint } from "./AnnotationListSnapshot-x6tKulNV.js";
+import { t as Engine } from "./Engine-Ds0ytbl6.js";
 //#region src/conformance/runMetadataConformance.d.ts
 interface ConformanceTestRunner {
   describe(name: string, fn: () => void): void;
@@ -16,6 +16,7 @@ interface ConformanceExpect {
     toHaveLength(expected: number): void;
     toMatch(re: RegExp): void;
     toMatchObject(shape: Record<string, unknown>): void;
+    toContain(expected: unknown): void;
     toBeInstanceOf(ctor: Function): void;
     toBeTruthy(): void;
     rejects: {
@@ -101,6 +102,11 @@ interface ActionsConformanceFixtures {
   page: ConformanceFixture;
   annotation: ConformanceFixture;
   field: ConformanceFixture;
+  /** `action_payloads.pdf` — every executable payload shape on one page of
+   *  /NM-keyed links. REQUIRED on both flavours: payload parity is a gate. */
+  payloads: ConformanceFixture;
+  /** `open_action_dest.pdf` — a destination-form catalog `/OpenAction`. */
+  openDestination: ConformanceFixture;
   /** A page whose only annotation is a Link with a `/S /JavaScript` action.
    *  Optional: the javascript-link classification test skips without it. */
   javascriptLink?: ConformanceFixture;
@@ -350,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;
@@ -644,5 +697,5 @@ 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 };
+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, runAnnotationAppearanceExportConformance, runAnnotationFlattenConformance, runAnnotationMutationConformance, runAnnotationReadConformance, runAttachmentConformance, runDocumentEventsConformance, runFormConformance, runMetadataConformance, runNamedPagesConformance, runPageDeleteConformance, runPageExtractConformance, runPageFlattenConformance, runPageGeometryOrientationConformance, runPageInsertBlankConformance, runPageInsertConformance, runPageReorderConformance, runPageRotateConformance, runPageTextConformance, runPieceInfoConformance, runRedactionApplyConformance, runSearchConformance, runTextDivergenceConformance };
 //# sourceMappingURL=conformance.d.ts.map