@embedpdf/engine-services 3.0.0-next.11 → 3.0.0-next.12

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import { PdfFunctions, PdfRuntimeMemory, PdfRuntimeModule, Ptr } from "@embedpdf/engine-runtime";
-import { ActionReadBudget, AnnotationActor, AnnotationAppearanceRenderOptions, AnnotationAppearancesResult, AnnotationCreateResult, AnnotationDeleteResult, AnnotationListMutationMeta, AnnotationListPageSnapshot, AnnotationListSnapshotAllPages, AnnotationMoveResult, AnnotationMutationKind, AnnotationRef, AnnotationStableId, AnnotationUpdateResult, AttachmentCreateResult, AttachmentDeleteResult, AttachmentFileInfo, AttachmentFileWorkerPayload, DocumentActionsSnapshot, DocumentEvent, DocumentEventInit, DocumentEventStream, DocumentMetadata, DocumentSecurityProbeInfo, EmbeddedFileItem, EmbeddedFileRef, FormDataFormat, FormEffect, FormEffectsResult, FormFieldDTO, FormFieldDraft, FormFieldPatch, FormFieldRef, FormFieldValue, FormImportResult, FormRepairResult, FormSetValueResult, FormSnapshot, FormWidgetRef, MetadataPatch, MetadataUpdateResult, PageDeleteResult, PageFlattenResult, PageFlattenUsage, PageGeometryRun, PageGeometrySnapshot, PageInsertBlankSpec, PageInsertResult, PageListSnapshot, PageMoveResult, PageNetworkRenderFormat, PageObjectNumber, PageRaster, PageRenderOptions, PageRotateResult, PageRotation, PageState, PageTextSnapshot, PdfActionTree, PdfQuad, PdfRect, PdfSaveMode, RedactionApplyResult, RedactionApplyScope, RevisionToken, SearchRequest, SearchSlice, WeakAnnotationState, WireAnnotationDraft, WireAnnotationPatch, WireAttachmentFile, WirePack, WireResource, WireResourceMap, WorkerRequest, WorkerResponse } from "@embedpdf/engine-core/runtime";
+import { ActionReadBudget, AnnotationActor, AnnotationAppearanceRenderOptions, AnnotationAppearancesResult, AnnotationCreateResult, AnnotationDeleteResult, AnnotationFlattenResult, AnnotationListMutationMeta, AnnotationListPageSnapshot, AnnotationListSnapshotAllPages, AnnotationMoveResult, AnnotationMutationKind, AnnotationRef, AnnotationStableId, AnnotationUpdateResult, AttachmentCreateResult, AttachmentDeleteResult, AttachmentFileInfo, AttachmentFileWorkerPayload, DocumentActionsSnapshot, DocumentEvent, DocumentEventInit, DocumentEventStream, DocumentMetadata, DocumentSecurityProbeInfo, EmbeddedFileItem, EmbeddedFileRef, FormDataFormat, FormEffect, FormEffectsResult, FormFieldDTO, FormFieldDraft, FormFieldPatch, FormFieldRef, FormFieldValue, FormImportResult, FormRepairResult, FormSetValueResult, FormSnapshot, FormWidgetRef, MetadataPatch, MetadataUpdateResult, PageDeleteResult, PageFlattenResult, PageFlattenUsage, PageGeometryRun, PageGeometrySnapshot, PageInsertBlankSpec, PageInsertResult, PageListSnapshot, PageMoveResult, PageNameInput, PageNameResult, PageNetworkRenderFormat, PageObjectNumber, PageRaster, PageRemoveNameInput, PageRenderOptions, PageRotateResult, PageRotation, PageState, PageTextSnapshot, PdfActionTree, PdfQuad, PdfRect, PdfSaveMode, RedactionApplyResult, RedactionApplyScope, RevisionToken, SearchRequest, SearchSlice, WeakAnnotationState, WireAnnotationDraft, WireAnnotationPatch, WireAttachmentFile, WirePack, WireResource, WireResourceMap, WorkerRequest, WorkerResponse } from "@embedpdf/engine-core/runtime";
 //#region src/runtime/lifecycle/bootstrap.d.ts
 /**
  * Initialize the thread-confined PDFium runtime for the calling thread. Each
@@ -538,6 +538,16 @@ declare class PagesMutator {
    * Abort is honored BEFORE the apply loop, never inside it.
    */
   delete(pageObjectNumbers: PageObjectNumber[], signal: AbortSignal): PageDeleteResult;
+  /**
+   * Register `name` → page in `/Names /Pages` (create, or replace what the
+   * key points at); with `replace`, drop that other key first — a rename as
+   * one job. Named pages are LAYOUT: page identity and order are untouched
+   * (no registry refresh, no revision bumps) and the fresh snapshot is
+   * returned like `move()`.
+   */
+  setName(input: PageNameInput, signal: AbortSignal): PageNameResult;
+  /** Remove one `/Names /Pages` registration; the page stays. */
+  removeName(input: PageRemoveNameInput, signal: AbortSignal): PageNameResult;
   /** Shared input check: non-empty, no duplicate PONs. */
   private requireUniquePons;
 }
@@ -1029,6 +1039,31 @@ declare class AnnotationMutator {
   private computeHasWeakAnnotations;
 }
 //#endregion
+//#region src/features/annotations/AnnotationFlattener.d.ts
+/**
+ * The annotation-plane flatten verbs — `pages.flatten` for a chosen set:
+ * in place (`flatten`) or into a new single-page document
+ * (`exportAppearance`). Both resolve refs to native handles on the page,
+ * hand the SET to the fork (one candidate plan, one placement writer — the
+ * same code whole-page flatten runs), and release every handle afterwards.
+ */
+declare class AnnotationFlattener {
+  private readonly runtime;
+  private readonly session;
+  constructor(runtime: PdfRuntimeModule, session: DocumentSession);
+  flatten(pageObjectNumber: PageObjectNumber, refs: AnnotationRef[], usage: PageFlattenUsage, signal: AbortSignal): AnnotationFlattenResult;
+  exportAppearance(pageObjectNumber: PageObjectNumber, refs: AnnotationRef[], signal: AbortSignal): {
+    bytes: ArrayBuffer;
+    size: number;
+  };
+  /** Resolve every ref on `pagePtr` (NotFound / InvalidReference from the
+   *  resolver on caller error); on any failure, close what was opened. */
+  private resolveAll;
+  /** Marshal an `FPDF_ANNOTATION*` array for the call's duration. */
+  private withHandleArray;
+  private requireRefs;
+}
+//#endregion
 //#region src/features/annotations/internal/mutations/computeMutationImpact.d.ts
 /**
  * The kind of mutation that just happened on a page.
@@ -1529,11 +1564,15 @@ declare class WorkerHost {
   private handleAnnotationsCreate;
   private handleAnnotationsUpdate;
   private handleAnnotationsDelete;
+  private handleAnnotationsFlatten;
+  private handleAnnotationsExportAppearance;
   private handleAnnotationsMove;
   private handlePagesList;
   private handlePagesMove;
   private handlePagesRotate;
   private handlePagesDelete;
+  private handlePagesSetName;
+  private handlePagesRemoveName;
   private handlePagesFlatten;
   private handleRedactionApply;
   private handlePagesExtract;
@@ -1611,5 +1650,5 @@ declare class WorkerHost {
   private saveLayerArtifact;
 }
 //#endregion
-export { ALL_STANDARD_SECURITY_PERMISSIONS, type AcquiredBaseDocument, ActionReadBudgetTracker, AnnotationAppearanceReader, AnnotationMutator, AnnotationReader, AttachmentMutator, AttachmentReader, BaseDocumentRegistry, CloseStack, DocumentActionsReader, PagesMutator as DocumentPagesMutator, PagesMutator, DocumentSaver, DocumentSession, EPDF_CHAR_GEOMETRY_LAYOUT, EventHub, FontRegistrar, FormMutator, FormReader, FormsEffectsApplier, type ImpactInputs, type LayerSource, LocalRevisionAuthority, MetadataMutator, MetadataReader, type MutationKind, type OpenedPdfDocument, type OpenedPdfDocumentKind, PageGeometryReader, PagesReader as PageLayoutReader, PagesReader, PagePtrPool, PageRenderReader as PageRasterReader, PageRenderReader, type PageRecord, PageTextReader, PagesExtractor, PagesFlattener, PagesInserter, RawAnnotationReader, type RawGeometryGlyphRecord, RedactionApplier, type RevisionAuthority, SearchReader, SecurityReader, SessionEventPublisher, type StartupFontSpec, type WorkerEncodedImage, WorkerHost, type WorkerHostOptions, type WorkerImageEncoder, buildRunsFromRawGlyphs, computeMutationImpact, destroyLibrary, disposeFormModel, ensureInitialized, formatPdfDate, generateUuid, hasAllStandardSecurityPermissions, normalizeU32, openFatMemoryDocument, openLayerDocument, pdfDateToIso, readActionModel, readAttachmentFileInfo, throwIfAborted, writeAttachmentFilePayload };
+export { ALL_STANDARD_SECURITY_PERMISSIONS, type AcquiredBaseDocument, ActionReadBudgetTracker, AnnotationAppearanceReader, AnnotationFlattener, AnnotationMutator, AnnotationReader, AttachmentMutator, AttachmentReader, BaseDocumentRegistry, CloseStack, DocumentActionsReader, PagesMutator as DocumentPagesMutator, PagesMutator, DocumentSaver, DocumentSession, EPDF_CHAR_GEOMETRY_LAYOUT, EventHub, FontRegistrar, FormMutator, FormReader, FormsEffectsApplier, type ImpactInputs, type LayerSource, LocalRevisionAuthority, MetadataMutator, MetadataReader, type MutationKind, type OpenedPdfDocument, type OpenedPdfDocumentKind, PageGeometryReader, PagesReader as PageLayoutReader, PagesReader, PagePtrPool, PageRenderReader as PageRasterReader, PageRenderReader, type PageRecord, PageTextReader, PagesExtractor, PagesFlattener, PagesInserter, RawAnnotationReader, type RawGeometryGlyphRecord, RedactionApplier, type RevisionAuthority, SearchReader, SecurityReader, SessionEventPublisher, type StartupFontSpec, type WorkerEncodedImage, WorkerHost, type WorkerHostOptions, type WorkerImageEncoder, buildRunsFromRawGlyphs, computeMutationImpact, destroyLibrary, disposeFormModel, ensureInitialized, formatPdfDate, generateUuid, hasAllStandardSecurityPermissions, normalizeU32, openFatMemoryDocument, openLayerDocument, pdfDateToIso, readActionModel, readAttachmentFileInfo, throwIfAborted, writeAttachmentFilePayload };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ActionReadBudget, AnnotationActor, AnnotationAppearanceRenderOptions, AnnotationAppearancesResult, AnnotationCreateResult, AnnotationDeleteResult, AnnotationListMutationMeta, AnnotationListPageSnapshot, AnnotationListSnapshotAllPages, AnnotationMoveResult, AnnotationMutationKind, AnnotationRef, AnnotationStableId, AnnotationUpdateResult, AttachmentCreateResult, AttachmentDeleteResult, AttachmentFileInfo, AttachmentFileWorkerPayload, DocumentActionsSnapshot, DocumentEvent, DocumentEventInit, DocumentEventStream, DocumentMetadata, DocumentSecurityProbeInfo, EmbeddedFileItem, EmbeddedFileRef, FormDataFormat, FormEffect, FormEffectsResult, FormFieldDTO, FormFieldDraft, FormFieldPatch, FormFieldRef, FormFieldValue, FormImportResult, FormRepairResult, FormSetValueResult, FormSnapshot, FormWidgetRef, MetadataPatch, MetadataUpdateResult, PageDeleteResult, PageFlattenResult, PageFlattenUsage, PageGeometryRun, PageGeometrySnapshot, PageInsertBlankSpec, PageInsertResult, PageListSnapshot, PageMoveResult, PageNetworkRenderFormat, PageObjectNumber, PageRaster, PageRenderOptions, PageRotateResult, PageRotation, PageState, PageTextSnapshot, PdfActionTree, PdfQuad, PdfRect, PdfSaveMode, RedactionApplyResult, RedactionApplyScope, RevisionToken, SearchRequest, SearchSlice, WeakAnnotationState, WireAnnotationDraft, WireAnnotationPatch, WireAttachmentFile, WirePack, WireResource, WireResourceMap, WorkerRequest, WorkerResponse } from "@embedpdf/engine-core/runtime";
+import { ActionReadBudget, AnnotationActor, AnnotationAppearanceRenderOptions, AnnotationAppearancesResult, AnnotationCreateResult, AnnotationDeleteResult, AnnotationFlattenResult, AnnotationListMutationMeta, AnnotationListPageSnapshot, AnnotationListSnapshotAllPages, AnnotationMoveResult, AnnotationMutationKind, AnnotationRef, AnnotationStableId, AnnotationUpdateResult, AttachmentCreateResult, AttachmentDeleteResult, AttachmentFileInfo, AttachmentFileWorkerPayload, DocumentActionsSnapshot, DocumentEvent, DocumentEventInit, DocumentEventStream, DocumentMetadata, DocumentSecurityProbeInfo, EmbeddedFileItem, EmbeddedFileRef, FormDataFormat, FormEffect, FormEffectsResult, FormFieldDTO, FormFieldDraft, FormFieldPatch, FormFieldRef, FormFieldValue, FormImportResult, FormRepairResult, FormSetValueResult, FormSnapshot, FormWidgetRef, MetadataPatch, MetadataUpdateResult, PageDeleteResult, PageFlattenResult, PageFlattenUsage, PageGeometryRun, PageGeometrySnapshot, PageInsertBlankSpec, PageInsertResult, PageListSnapshot, PageMoveResult, PageNameInput, PageNameResult, PageNetworkRenderFormat, PageObjectNumber, PageRaster, PageRemoveNameInput, PageRenderOptions, PageRotateResult, PageRotation, PageState, PageTextSnapshot, PdfActionTree, PdfQuad, PdfRect, PdfSaveMode, RedactionApplyResult, RedactionApplyScope, RevisionToken, SearchRequest, SearchSlice, WeakAnnotationState, WireAnnotationDraft, WireAnnotationPatch, WireAttachmentFile, WirePack, WireResource, WireResourceMap, WorkerRequest, WorkerResponse } from "@embedpdf/engine-core/runtime";
 import { PdfFunctions, PdfRuntimeMemory, PdfRuntimeModule, Ptr } from "@embedpdf/engine-runtime";
 //#region src/runtime/lifecycle/bootstrap.d.ts
 /**
@@ -538,6 +538,16 @@ declare class PagesMutator {
    * Abort is honored BEFORE the apply loop, never inside it.
    */
   delete(pageObjectNumbers: PageObjectNumber[], signal: AbortSignal): PageDeleteResult;
+  /**
+   * Register `name` → page in `/Names /Pages` (create, or replace what the
+   * key points at); with `replace`, drop that other key first — a rename as
+   * one job. Named pages are LAYOUT: page identity and order are untouched
+   * (no registry refresh, no revision bumps) and the fresh snapshot is
+   * returned like `move()`.
+   */
+  setName(input: PageNameInput, signal: AbortSignal): PageNameResult;
+  /** Remove one `/Names /Pages` registration; the page stays. */
+  removeName(input: PageRemoveNameInput, signal: AbortSignal): PageNameResult;
   /** Shared input check: non-empty, no duplicate PONs. */
   private requireUniquePons;
 }
@@ -1029,6 +1039,31 @@ declare class AnnotationMutator {
   private computeHasWeakAnnotations;
 }
 //#endregion
+//#region src/features/annotations/AnnotationFlattener.d.ts
+/**
+ * The annotation-plane flatten verbs — `pages.flatten` for a chosen set:
+ * in place (`flatten`) or into a new single-page document
+ * (`exportAppearance`). Both resolve refs to native handles on the page,
+ * hand the SET to the fork (one candidate plan, one placement writer — the
+ * same code whole-page flatten runs), and release every handle afterwards.
+ */
+declare class AnnotationFlattener {
+  private readonly runtime;
+  private readonly session;
+  constructor(runtime: PdfRuntimeModule, session: DocumentSession);
+  flatten(pageObjectNumber: PageObjectNumber, refs: AnnotationRef[], usage: PageFlattenUsage, signal: AbortSignal): AnnotationFlattenResult;
+  exportAppearance(pageObjectNumber: PageObjectNumber, refs: AnnotationRef[], signal: AbortSignal): {
+    bytes: ArrayBuffer;
+    size: number;
+  };
+  /** Resolve every ref on `pagePtr` (NotFound / InvalidReference from the
+   *  resolver on caller error); on any failure, close what was opened. */
+  private resolveAll;
+  /** Marshal an `FPDF_ANNOTATION*` array for the call's duration. */
+  private withHandleArray;
+  private requireRefs;
+}
+//#endregion
 //#region src/features/annotations/internal/mutations/computeMutationImpact.d.ts
 /**
  * The kind of mutation that just happened on a page.
@@ -1529,11 +1564,15 @@ declare class WorkerHost {
   private handleAnnotationsCreate;
   private handleAnnotationsUpdate;
   private handleAnnotationsDelete;
+  private handleAnnotationsFlatten;
+  private handleAnnotationsExportAppearance;
   private handleAnnotationsMove;
   private handlePagesList;
   private handlePagesMove;
   private handlePagesRotate;
   private handlePagesDelete;
+  private handlePagesSetName;
+  private handlePagesRemoveName;
   private handlePagesFlatten;
   private handleRedactionApply;
   private handlePagesExtract;
@@ -1611,5 +1650,5 @@ declare class WorkerHost {
   private saveLayerArtifact;
 }
 //#endregion
-export { ALL_STANDARD_SECURITY_PERMISSIONS, type AcquiredBaseDocument, ActionReadBudgetTracker, AnnotationAppearanceReader, AnnotationMutator, AnnotationReader, AttachmentMutator, AttachmentReader, BaseDocumentRegistry, CloseStack, DocumentActionsReader, PagesMutator as DocumentPagesMutator, PagesMutator, DocumentSaver, DocumentSession, EPDF_CHAR_GEOMETRY_LAYOUT, EventHub, FontRegistrar, FormMutator, FormReader, FormsEffectsApplier, type ImpactInputs, type LayerSource, LocalRevisionAuthority, MetadataMutator, MetadataReader, type MutationKind, type OpenedPdfDocument, type OpenedPdfDocumentKind, PageGeometryReader, PagesReader as PageLayoutReader, PagesReader, PagePtrPool, PageRenderReader as PageRasterReader, PageRenderReader, type PageRecord, PageTextReader, PagesExtractor, PagesFlattener, PagesInserter, RawAnnotationReader, type RawGeometryGlyphRecord, RedactionApplier, type RevisionAuthority, SearchReader, SecurityReader, SessionEventPublisher, type StartupFontSpec, type WorkerEncodedImage, WorkerHost, type WorkerHostOptions, type WorkerImageEncoder, buildRunsFromRawGlyphs, computeMutationImpact, destroyLibrary, disposeFormModel, ensureInitialized, formatPdfDate, generateUuid, hasAllStandardSecurityPermissions, normalizeU32, openFatMemoryDocument, openLayerDocument, pdfDateToIso, readActionModel, readAttachmentFileInfo, throwIfAborted, writeAttachmentFilePayload };
+export { ALL_STANDARD_SECURITY_PERMISSIONS, type AcquiredBaseDocument, ActionReadBudgetTracker, AnnotationAppearanceReader, AnnotationFlattener, AnnotationMutator, AnnotationReader, AttachmentMutator, AttachmentReader, BaseDocumentRegistry, CloseStack, DocumentActionsReader, PagesMutator as DocumentPagesMutator, PagesMutator, DocumentSaver, DocumentSession, EPDF_CHAR_GEOMETRY_LAYOUT, EventHub, FontRegistrar, FormMutator, FormReader, FormsEffectsApplier, type ImpactInputs, type LayerSource, LocalRevisionAuthority, MetadataMutator, MetadataReader, type MutationKind, type OpenedPdfDocument, type OpenedPdfDocumentKind, PageGeometryReader, PagesReader as PageLayoutReader, PagesReader, PagePtrPool, PageRenderReader as PageRasterReader, PageRenderReader, type PageRecord, PageTextReader, PagesExtractor, PagesFlattener, PagesInserter, RawAnnotationReader, type RawGeometryGlyphRecord, RedactionApplier, type RevisionAuthority, SearchReader, SecurityReader, SessionEventPublisher, type StartupFontSpec, type WorkerEncodedImage, WorkerHost, type WorkerHostOptions, type WorkerImageEncoder, buildRunsFromRawGlyphs, computeMutationImpact, destroyLibrary, disposeFormModel, ensureInitialized, formatPdfDate, generateUuid, hasAllStandardSecurityPermissions, normalizeU32, openFatMemoryDocument, openLayerDocument, pdfDateToIso, readActionModel, readAttachmentFileInfo, throwIfAborted, writeAttachmentFilePayload };
 //# sourceMappingURL=index.d.ts.map