@embedpdf/core 3.0.0-next.15 → 3.0.0-next.16

package/dist/{types-t-DaU8VK.d.ts → types-CfnZ7go6.d.cts}

@@ -1,4 +1,4 @@
-import { Annotation, ChangeOp, ChangeResult, CustomMetadata, CustomMetadataPatch, CustomMetadataUpdateResult, DocCapability, DocumentEvent, DocumentEvent as DocumentEvent$1, DocumentHandle, DocumentHandle as DocumentHandle$1, DocumentMetadata, Engine as Engine$1, EngineFactory, EngineRenderPolicy, EventOrigin, FormFieldDTO, Identity as Identity$1, MetadataPatch, MetadataUpdateResult, OpenInput, OpenOptions, PageDeleteResult, PageDestination, PageInsertBlankSpec, PageInsertResult, PageLayout as PageLayout$1, PageObjectNumber, PagePosition, PageRef, PageReorderResult, PageRotateResult, PdfDestination, PdfRotation, PdfSaveMode, PdfSize, WidgetAnnotation } from "@embedpdf/engine-core/runtime";
+import { Annotation, Attachment, ChangeOp, ChangeResult, CustomMetadata, CustomMetadataPatch, CustomMetadataUpdateResult, DocCapability, DocumentEvent, DocumentEvent as DocumentEvent$1, DocumentHandle, DocumentHandle as DocumentHandle$1, DocumentMetadata, Engine as Engine$1, EngineFactory, EngineRenderPolicy, EventOrigin, FormFieldDTO, Identity as Identity$1, MetadataPatch, MetadataUpdateResult, OpenInput, OpenOptions, OutlineItem, PageDeleteResult, PageDestination, PageInsertBlankSpec, PageInsertResult, PageLayout as PageLayout$1, PageObjectNumber, PagePosition, PageRef, PageReorderResult, PageRotateResult, PdfDestination, PdfRotation, PdfSaveMode, PdfSize, PrintDpi, WidgetAnnotation } from "@embedpdf/engine-core/runtime";
 //#region src/lanes.d.ts
 /** One execution inside a `latest` lane. */
 /** `details` of the `operation-cancelled` error a superseded or cancelled run rejects with. */
@@ -136,6 +136,16 @@ type PredictedOp = ChangeOp | {
   readonly widget: WidgetAnnotation;
   /** Its field as the restore leaves it, with the widget back; `null` when it had none. */
   readonly field: FormFieldDTO | null;
+} | {
+  readonly type: 'outline.restore';
+  /** The items as they were: the item first, then the items under it, depth first. */
+  readonly items: readonly OutlineItem[];
+  /** The item's place among its parent's children. */
+  readonly index: number;
+} | {
+  readonly type: 'attachments.restore';
+  /** The embedded file as it was, under the key it had. */
+  readonly attachment: Attachment;
 };
 /** One user action, as a plugin stages it. */
 type StagedChange = {
@@ -848,6 +858,14 @@ interface PluginContext<S = unknown, T extends object = NoSettings> {
    * others. Document-scoped plugins only; unregistered when the instance closes.
    */
   aroundDownload(wrap: (read: () => Promise<Uint8Array>) => Promise<Uint8Array>): void;
+  /**
+   * Run something of the document's own around every print of it (`documents.print()`, a
+   * prepared print's `print()`): `wrap` gets the print and resolves when it did, doing what
+   * comes before and after it. The actions plugin runs the document's print actions this way.
+   * The first registered wraps the others. Document-scoped plugins only; unregistered when the
+   * instance closes.
+   */
+  aroundPrint(wrap: (print: () => Promise<void>) => Promise<void>): void;
   /** Acquire a resource whose disposal the instance owns; a late arrival after close is disposed, not returned. */
   acquire<R>(get: (lifetime: AbortSignal) => Promise<R>, dispose: (resource: R) => void | Promise<void>): Promise<R>;
   /**
@@ -1004,6 +1022,111 @@ interface DownloadOptions extends OperationOptions {
    */
   readonly mode?: PdfSaveMode;
 }
+/**
+ * How a print comes out.
+ *
+ * - `'pdf'`: the printer prints a copy of the pages as they print (`pages.extract()` with
+ *   `flatten: { usage: 'print' }`): sharp text and lines. It takes `doc.print.high`, a right to
+ *   keep the copy (`doc.download` or `doc.download.flattened`: every print dialog can save it as
+ *   a file), and a printer that prints a PDF (`HostPrinter.stagePdf`).
+ * - `'images'` otherwise: pictures of the pages, drawn by the print rules, at 150 DPI with
+ *   `doc.print` or 300 DPI with `doc.print.high` (Acrobat's low and high resolution printing).
+ */
+type PrintQuality = {
+  readonly kind: 'pdf';
+} | {
+  readonly kind: 'images';
+  readonly dpi: PrintDpi;
+};
+/** How far preparing a print got. */
+interface PrintProgress {
+  /** Pages that are ready: one at a time as pictures, all at once as a PDF. */
+  readonly pagesRendered: number;
+  /** Pages the print has. */
+  readonly pageCount: number;
+}
+interface PrintOptions extends OperationOptions {
+  /** The pages to print, in this order. Default: every page. */
+  readonly pages?: readonly PageRef[];
+  /**
+   * Print the annotations that print. Default: when the user may read them. Form fields print
+   * when the user may read the form, whatever this says.
+   */
+  readonly includeAnnotations?: boolean;
+  /** Called each time pages are ready, and once before the first. */
+  readonly onProgress?: (progress: PrintProgress) => void;
+}
+/**
+ * A print got ready by `documents.preparePrint()`. Everything slow already happened, so
+ * `print()` opens the print dialog at once.
+ */
+interface PreparedPrint {
+  readonly quality: PrintQuality;
+  /** How many pages it prints. */
+  readonly pageCount: number;
+  /**
+   * Whether `print()` must run inside the user's tap or click: the printer's `needsTap`. Safari
+   * doesn't print what waited for its pages (iOS refuses the dialog, the Mac prints blank pages),
+   * so a dialog that prepared on a tap asks for another once the print is ready. When `false`,
+   * print as soon as it is ready.
+   */
+  readonly needsTap: boolean;
+  /**
+   * Open the print dialog. The document's own print actions run around it, when the actions
+   * plugin is installed; when they, or anyone, change the document after it was prepared, it is
+   * prepared again first. Resolves when the printer has the job. When the printer refuses a
+   * PDF, the same pages print as pictures. Rejects `invalid-input` once disposed,
+   * `operation-cancelled` when `signal` fires before the dialog opens.
+   */
+  print(options?: OperationOptions): Promise<void>;
+  /** Free what preparing took. Closing the document does too. */
+  dispose(): void;
+}
+/** One printed sheet: a picture of a page, and the page's size on paper. */
+interface PrintSheet {
+  /** A PNG of the page, drawn by the print rules. */
+  readonly image: Blob;
+  /** The page's width in points (1/72 inch), as it prints. */
+  readonly widthPt: number;
+  /** The page's height in points. */
+  readonly heightPt: number;
+}
+/** What a printer got ready: `print()` opens the print dialog with it. */
+interface StagedPrint {
+  /** Open the print dialog. Resolves once the printer has the job. */
+  print(): Promise<void>;
+  /** Free what staging took. */
+  dispose(): void;
+}
+/**
+ * Where prints go: the host's print dialog. A browser passes `browserPrinter()` from
+ * `@embedpdf/web`; an app with its own print path (a desktop shell, a native app) passes its
+ * own.
+ */
+interface HostPrinter {
+  /**
+   * `true` when this printer prints only while the user's tap or click is being handled (Safari),
+   * so a print that waited for its pages needs another tap. Default `false`.
+   */
+  readonly needsTap?: boolean;
+  /**
+   * Get the sheets ready to print, so `print()` on what it returns opens the dialog at once.
+   * `name` names the print job. Rejects when `signal` fires.
+   */
+  stage(sheets: readonly PrintSheet[], options: {
+    readonly name: string;
+    readonly signal?: AbortSignal;
+  }): Promise<StagedPrint>;
+  /**
+   * Present when this printer prints a PDF file on this device: a browser whose own PDF viewer
+   * prints it, a desktop shell, a native print API. Gets `pdf`, a copy of the pages as they
+   * print, ready as `stage()` gets sheets ready. A printer without it prints pictures.
+   */
+  stagePdf?(pdf: Uint8Array, options: {
+    readonly name: string;
+    readonly signal?: AbortSignal;
+  }): Promise<StagedPrint>;
+}
 /**
  * One boot document for `documents.openAll()` — the shared shape every
  * framework adapter's `initialDocuments` input uses (adapters re-export it,
@@ -1127,7 +1250,26 @@ interface DocumentsCapability {
   downloadLayer(id?: string, options?: OperationOptions): Promise<Uint8Array>;
   /** Whether the document (the one in scope without an id) may be downloaded: `doc.download`. */
   canDownload(id?: string): boolean;
-  /** Whether the document (the one in scope without an id) may be printed: `doc.print`. */
+  /**
+   * Get a print of the document ready (the one in scope without an id): wait for changes still
+   * on their way, make the pages as they print (a PDF copy or pictures, as `getPrintQuality()`
+   * says), and hand them to the host's printer. `onProgress` follows the pages. Rejects
+   * `permission-denied` without `doc.print`, `unsupported` when the host gave no printer,
+   * `not-found` for a page the document doesn't have, `invalid-input` for an empty `pages` or a
+   * page named twice, `not-ready` with no open document, `operation-cancelled` when `signal`
+   * fires.
+   */
+  preparePrint(id?: string, options?: PrintOptions): Promise<PreparedPrint>;
+  /**
+   * Prepare a print and print it: `preparePrint()`, then its `print()`. The document's own
+   * print actions run around the dialog when the actions plugin is installed. Rejects as
+   * `preparePrint()` does. A printer that `needsTap` may refuse the dialog once preparing took a
+   * while: there, prepare first and print from a tap.
+   */
+  print(id?: string, options?: PrintOptions): Promise<void>;
+  /** How a print of the document comes out for this user, or null when they can't print it. */
+  getPrintQuality(id?: string): PrintQuality | null;
+  /** Whether the document (the one in scope without an id) may be printed: `doc.print`, and the host gave a printer. */
   canPrint(id?: string): boolean;
   /**
    * The document's pages, in order (the one in scope without an id). The same array until a
@@ -1158,5 +1300,5 @@ interface DocumentsCapability {
 /** Built-in token for the document registry capability (provided by the kernel). */
 declare const DocumentsToken: CapabilityToken<DocumentsCapability>;
 //#endregion
-export { PdfSaveMode as $, isPluginError as $t, Identity$1 as A, MirrorReload as At, OperationOptions as B, ChangeQueue as Bt, DocumentsToken as C, SerialQueue as Ct, EventOrigin as D, PageMirrorSpec as Dt, EngineFactory as E, PageMirrorChange as Et, OpenDocumentOptions as F, Cancel as Ft, PageInsertResult as G, SettledChange as Gt, PageDestination as H, HoldOptions as Ht, OpenDocumentResult as I, HostClock as It, PagePosition as J, EventHookSource as Jt, PageLayout$1 as K, StagedChange as Kt, OpenInput as L, PluginClock as Lt, LockedDocumentInfo as M, reload as Mt, MetadataPatch as N, SliceChange as Nt, FailedDocumentInfo as O, Mirror as Ot, MetadataUpdateResult as P, SliceLease as Pt, PdfRotation as Q, PluginErrorInfo as Qt, OpenOptions as R, timerClock as Rt, DocumentsCapability as S, mergeSettings as St, Engine$1 as T, PageMirror as Tt, PageInfo as U, PendingChange as Ut, PageDeleteResult as V, HeldChange as Vt, PageInsertBlankSpec as W, PredictedOp as Wt, PageRotateResult as X, PluginError as Xt, PageReorderResult as Y, createEventHook as Yt, PdfDestination as Z, PluginErrorCode as Zt, DocumentOpenFailedEvent as _, Settings as _t, CustomMetadata as a, createLatestLane as an, PluginScope as at, DocumentStatus as b, SettingsDeclaration as bt, DocCapability as c, ResourceStatus as ct, DocumentEvent$1 as d, Subscribable as dt, toPluginError as en, PdfSize as et, DocumentHandle$1 as f, UnlockOptions as ft, DocumentMetadata as g, NoSettings as gt, DocumentMeta as h, DeepPartial as ht, CoreState as i, LatestRun as in, PluginDef as it, InitialDocument as j, MirrorSpec as jt, GlobalState as k, MirrorChange as kt, DocumentActiveChangedEvent as l, StateCell as lt, DocumentLockedEvent as m, UrlSource as mt, BatchResult as n, LatestCancellation as nn, Permission as nt, CustomMetadataPatch as o, PromiseMemberOf as ot, DocumentInfo as p, Unsubscribe as pt, PageObjectNumber as q, EventHook as qt, CapabilityToken as r, LatestLane as rn, PluginContext as rt, CustomMetadataUpdateResult as s, PromiseMembers as st, AnyPlugin as t, toPluginErrorInfo as tn, PendingMeta as tt, DocumentClosedEvent as u, StateChange as ut, DocumentOpenedEvent as v, SettingsApi as vt, DownloadOptions as w, createSerialQueue as wt, DocumentUnsavedChangesChangedEvent as x, SettingsOf as xt, DocumentPagesChangedEvent as y, SettingsChangedEvent as yt, OpenSource as z, ChangeLabel as zt };
-//# sourceMappingURL=types-t-DaU8VK.d.ts.map
+export { PdfRotation as $, StagedChange as $t, HostPrinter as A, SerialQueue as At, OpenSource as B, SliceChange as Bt, DocumentsToken as C, NoSettings as Ct, EventOrigin as D, SettingsDeclaration as Dt, EngineFactory as E, SettingsChangedEvent as Et, MetadataUpdateResult as F, Mirror as Ft, PageInsertBlankSpec as G, timerClock as Gt, PageDeleteResult as H, Cancel as Ht, OpenDocumentOptions as I, MirrorChange as It, PageObjectNumber as J, HeldChange as Jt, PageInsertResult as K, ChangeLabel as Kt, OpenDocumentResult as L, MirrorReload as Lt, InitialDocument as M, PageMirror as Mt, LockedDocumentInfo as N, PageMirrorChange as Nt, FailedDocumentInfo as O, SettingsOf as Ot, MetadataPatch as P, PageMirrorSpec as Pt, PdfDestination as Q, SettledChange as Qt, OpenInput as R, MirrorSpec as Rt, DocumentsCapability as S, DeepPartial as St, Engine$1 as T, SettingsApi as Tt, PageDestination as U, HostClock as Ut, OperationOptions as V, SliceLease as Vt, PageInfo as W, PluginClock as Wt, PageReorderResult as X, PendingChange as Xt, PagePosition as Y, HoldOptions as Yt, PageRotateResult as Z, PredictedOp as Zt, DocumentOpenFailedEvent as _, StateChange as _t, CustomMetadata as a, PluginErrorInfo as an, PluginDef as at, DocumentStatus as b, Unsubscribe as bt, DocCapability as c, toPluginErrorInfo as cn, PrintOptions as ct, DocumentEvent$1 as d, LatestRun as dn, PrintSheet as dt, EventHook as en, PdfSaveMode as et, DocumentHandle$1 as f, createLatestLane as fn, PromiseMemberOf as ft, DocumentMetadata as g, StateCell as gt, DocumentMeta as h, StagedPrint as ht, CoreState as i, PluginErrorCode as in, PluginContext as it, Identity$1 as j, createSerialQueue as jt, GlobalState as k, mergeSettings as kt, DocumentActiveChangedEvent as l, LatestCancellation as ln, PrintProgress as lt, DocumentLockedEvent as m, ResourceStatus as mt, BatchResult as n, createEventHook as nn, PendingMeta as nt, CustomMetadataPatch as o, isPluginError as on, PluginScope as ot, DocumentInfo as p, PromiseMembers as pt, PageLayout$1 as q, ChangeQueue as qt, CapabilityToken as r, PluginError as rn, Permission as rt, CustomMetadataUpdateResult as s, toPluginError as sn, PreparedPrint as st, AnyPlugin as t, EventHookSource as tn, PdfSize as tt, DocumentClosedEvent as u, LatestLane as un, PrintQuality as ut, DocumentOpenedEvent as v, Subscribable as vt, DownloadOptions as w, Settings as wt, DocumentUnsavedChangesChangedEvent as x, UrlSource as xt, DocumentPagesChangedEvent as y, UnlockOptions as yt, OpenOptions as z, reload as zt };
+//# sourceMappingURL=types-CfnZ7go6.d.cts.map

package/dist/{types-t-DaU8VK.d.cts → types-CfnZ7go6.d.ts}

@@ -1,4 +1,4 @@
-import { Annotation, ChangeOp, ChangeResult, CustomMetadata, CustomMetadataPatch, CustomMetadataUpdateResult, DocCapability, DocumentEvent, DocumentEvent as DocumentEvent$1, DocumentHandle, DocumentHandle as DocumentHandle$1, DocumentMetadata, Engine as Engine$1, EngineFactory, EngineRenderPolicy, EventOrigin, FormFieldDTO, Identity as Identity$1, MetadataPatch, MetadataUpdateResult, OpenInput, OpenOptions, PageDeleteResult, PageDestination, PageInsertBlankSpec, PageInsertResult, PageLayout as PageLayout$1, PageObjectNumber, PagePosition, PageRef, PageReorderResult, PageRotateResult, PdfDestination, PdfRotation, PdfSaveMode, PdfSize, WidgetAnnotation } from "@embedpdf/engine-core/runtime";
+import { Annotation, Attachment, ChangeOp, ChangeResult, CustomMetadata, CustomMetadataPatch, CustomMetadataUpdateResult, DocCapability, DocumentEvent, DocumentEvent as DocumentEvent$1, DocumentHandle, DocumentHandle as DocumentHandle$1, DocumentMetadata, Engine as Engine$1, EngineFactory, EngineRenderPolicy, EventOrigin, FormFieldDTO, Identity as Identity$1, MetadataPatch, MetadataUpdateResult, OpenInput, OpenOptions, OutlineItem, PageDeleteResult, PageDestination, PageInsertBlankSpec, PageInsertResult, PageLayout as PageLayout$1, PageObjectNumber, PagePosition, PageRef, PageReorderResult, PageRotateResult, PdfDestination, PdfRotation, PdfSaveMode, PdfSize, PrintDpi, WidgetAnnotation } from "@embedpdf/engine-core/runtime";
 //#region src/lanes.d.ts
 /** One execution inside a `latest` lane. */
 /** `details` of the `operation-cancelled` error a superseded or cancelled run rejects with. */
@@ -136,6 +136,16 @@ type PredictedOp = ChangeOp | {
   readonly widget: WidgetAnnotation;
   /** Its field as the restore leaves it, with the widget back; `null` when it had none. */
   readonly field: FormFieldDTO | null;
+} | {
+  readonly type: 'outline.restore';
+  /** The items as they were: the item first, then the items under it, depth first. */
+  readonly items: readonly OutlineItem[];
+  /** The item's place among its parent's children. */
+  readonly index: number;
+} | {
+  readonly type: 'attachments.restore';
+  /** The embedded file as it was, under the key it had. */
+  readonly attachment: Attachment;
 };
 /** One user action, as a plugin stages it. */
 type StagedChange = {
@@ -848,6 +858,14 @@ interface PluginContext<S = unknown, T extends object = NoSettings> {
    * others. Document-scoped plugins only; unregistered when the instance closes.
    */
   aroundDownload(wrap: (read: () => Promise<Uint8Array>) => Promise<Uint8Array>): void;
+  /**
+   * Run something of the document's own around every print of it (`documents.print()`, a
+   * prepared print's `print()`): `wrap` gets the print and resolves when it did, doing what
+   * comes before and after it. The actions plugin runs the document's print actions this way.
+   * The first registered wraps the others. Document-scoped plugins only; unregistered when the
+   * instance closes.
+   */
+  aroundPrint(wrap: (print: () => Promise<void>) => Promise<void>): void;
   /** Acquire a resource whose disposal the instance owns; a late arrival after close is disposed, not returned. */
   acquire<R>(get: (lifetime: AbortSignal) => Promise<R>, dispose: (resource: R) => void | Promise<void>): Promise<R>;
   /**
@@ -1004,6 +1022,111 @@ interface DownloadOptions extends OperationOptions {
    */
   readonly mode?: PdfSaveMode;
 }
+/**
+ * How a print comes out.
+ *
+ * - `'pdf'`: the printer prints a copy of the pages as they print (`pages.extract()` with
+ *   `flatten: { usage: 'print' }`): sharp text and lines. It takes `doc.print.high`, a right to
+ *   keep the copy (`doc.download` or `doc.download.flattened`: every print dialog can save it as
+ *   a file), and a printer that prints a PDF (`HostPrinter.stagePdf`).
+ * - `'images'` otherwise: pictures of the pages, drawn by the print rules, at 150 DPI with
+ *   `doc.print` or 300 DPI with `doc.print.high` (Acrobat's low and high resolution printing).
+ */
+type PrintQuality = {
+  readonly kind: 'pdf';
+} | {
+  readonly kind: 'images';
+  readonly dpi: PrintDpi;
+};
+/** How far preparing a print got. */
+interface PrintProgress {
+  /** Pages that are ready: one at a time as pictures, all at once as a PDF. */
+  readonly pagesRendered: number;
+  /** Pages the print has. */
+  readonly pageCount: number;
+}
+interface PrintOptions extends OperationOptions {
+  /** The pages to print, in this order. Default: every page. */
+  readonly pages?: readonly PageRef[];
+  /**
+   * Print the annotations that print. Default: when the user may read them. Form fields print
+   * when the user may read the form, whatever this says.
+   */
+  readonly includeAnnotations?: boolean;
+  /** Called each time pages are ready, and once before the first. */
+  readonly onProgress?: (progress: PrintProgress) => void;
+}
+/**
+ * A print got ready by `documents.preparePrint()`. Everything slow already happened, so
+ * `print()` opens the print dialog at once.
+ */
+interface PreparedPrint {
+  readonly quality: PrintQuality;
+  /** How many pages it prints. */
+  readonly pageCount: number;
+  /**
+   * Whether `print()` must run inside the user's tap or click: the printer's `needsTap`. Safari
+   * doesn't print what waited for its pages (iOS refuses the dialog, the Mac prints blank pages),
+   * so a dialog that prepared on a tap asks for another once the print is ready. When `false`,
+   * print as soon as it is ready.
+   */
+  readonly needsTap: boolean;
+  /**
+   * Open the print dialog. The document's own print actions run around it, when the actions
+   * plugin is installed; when they, or anyone, change the document after it was prepared, it is
+   * prepared again first. Resolves when the printer has the job. When the printer refuses a
+   * PDF, the same pages print as pictures. Rejects `invalid-input` once disposed,
+   * `operation-cancelled` when `signal` fires before the dialog opens.
+   */
+  print(options?: OperationOptions): Promise<void>;
+  /** Free what preparing took. Closing the document does too. */
+  dispose(): void;
+}
+/** One printed sheet: a picture of a page, and the page's size on paper. */
+interface PrintSheet {
+  /** A PNG of the page, drawn by the print rules. */
+  readonly image: Blob;
+  /** The page's width in points (1/72 inch), as it prints. */
+  readonly widthPt: number;
+  /** The page's height in points. */
+  readonly heightPt: number;
+}
+/** What a printer got ready: `print()` opens the print dialog with it. */
+interface StagedPrint {
+  /** Open the print dialog. Resolves once the printer has the job. */
+  print(): Promise<void>;
+  /** Free what staging took. */
+  dispose(): void;
+}
+/**
+ * Where prints go: the host's print dialog. A browser passes `browserPrinter()` from
+ * `@embedpdf/web`; an app with its own print path (a desktop shell, a native app) passes its
+ * own.
+ */
+interface HostPrinter {
+  /**
+   * `true` when this printer prints only while the user's tap or click is being handled (Safari),
+   * so a print that waited for its pages needs another tap. Default `false`.
+   */
+  readonly needsTap?: boolean;
+  /**
+   * Get the sheets ready to print, so `print()` on what it returns opens the dialog at once.
+   * `name` names the print job. Rejects when `signal` fires.
+   */
+  stage(sheets: readonly PrintSheet[], options: {
+    readonly name: string;
+    readonly signal?: AbortSignal;
+  }): Promise<StagedPrint>;
+  /**
+   * Present when this printer prints a PDF file on this device: a browser whose own PDF viewer
+   * prints it, a desktop shell, a native print API. Gets `pdf`, a copy of the pages as they
+   * print, ready as `stage()` gets sheets ready. A printer without it prints pictures.
+   */
+  stagePdf?(pdf: Uint8Array, options: {
+    readonly name: string;
+    readonly signal?: AbortSignal;
+  }): Promise<StagedPrint>;
+}
 /**
  * One boot document for `documents.openAll()` — the shared shape every
  * framework adapter's `initialDocuments` input uses (adapters re-export it,
@@ -1127,7 +1250,26 @@ interface DocumentsCapability {
   downloadLayer(id?: string, options?: OperationOptions): Promise<Uint8Array>;
   /** Whether the document (the one in scope without an id) may be downloaded: `doc.download`. */
   canDownload(id?: string): boolean;
-  /** Whether the document (the one in scope without an id) may be printed: `doc.print`. */
+  /**
+   * Get a print of the document ready (the one in scope without an id): wait for changes still
+   * on their way, make the pages as they print (a PDF copy or pictures, as `getPrintQuality()`
+   * says), and hand them to the host's printer. `onProgress` follows the pages. Rejects
+   * `permission-denied` without `doc.print`, `unsupported` when the host gave no printer,
+   * `not-found` for a page the document doesn't have, `invalid-input` for an empty `pages` or a
+   * page named twice, `not-ready` with no open document, `operation-cancelled` when `signal`
+   * fires.
+   */
+  preparePrint(id?: string, options?: PrintOptions): Promise<PreparedPrint>;
+  /**
+   * Prepare a print and print it: `preparePrint()`, then its `print()`. The document's own
+   * print actions run around the dialog when the actions plugin is installed. Rejects as
+   * `preparePrint()` does. A printer that `needsTap` may refuse the dialog once preparing took a
+   * while: there, prepare first and print from a tap.
+   */
+  print(id?: string, options?: PrintOptions): Promise<void>;
+  /** How a print of the document comes out for this user, or null when they can't print it. */
+  getPrintQuality(id?: string): PrintQuality | null;
+  /** Whether the document (the one in scope without an id) may be printed: `doc.print`, and the host gave a printer. */
   canPrint(id?: string): boolean;
   /**
    * The document's pages, in order (the one in scope without an id). The same array until a
@@ -1158,5 +1300,5 @@ interface DocumentsCapability {
 /** Built-in token for the document registry capability (provided by the kernel). */
 declare const DocumentsToken: CapabilityToken<DocumentsCapability>;
 //#endregion
-export { PdfSaveMode as $, isPluginError as $t, Identity$1 as A, MirrorReload as At, OperationOptions as B, ChangeQueue as Bt, DocumentsToken as C, SerialQueue as Ct, EventOrigin as D, PageMirrorSpec as Dt, EngineFactory as E, PageMirrorChange as Et, OpenDocumentOptions as F, Cancel as Ft, PageInsertResult as G, SettledChange as Gt, PageDestination as H, HoldOptions as Ht, OpenDocumentResult as I, HostClock as It, PagePosition as J, EventHookSource as Jt, PageLayout$1 as K, StagedChange as Kt, OpenInput as L, PluginClock as Lt, LockedDocumentInfo as M, reload as Mt, MetadataPatch as N, SliceChange as Nt, FailedDocumentInfo as O, Mirror as Ot, MetadataUpdateResult as P, SliceLease as Pt, PdfRotation as Q, PluginErrorInfo as Qt, OpenOptions as R, timerClock as Rt, DocumentsCapability as S, mergeSettings as St, Engine$1 as T, PageMirror as Tt, PageInfo as U, PendingChange as Ut, PageDeleteResult as V, HeldChange as Vt, PageInsertBlankSpec as W, PredictedOp as Wt, PageRotateResult as X, PluginError as Xt, PageReorderResult as Y, createEventHook as Yt, PdfDestination as Z, PluginErrorCode as Zt, DocumentOpenFailedEvent as _, Settings as _t, CustomMetadata as a, createLatestLane as an, PluginScope as at, DocumentStatus as b, SettingsDeclaration as bt, DocCapability as c, ResourceStatus as ct, DocumentEvent$1 as d, Subscribable as dt, toPluginError as en, PdfSize as et, DocumentHandle$1 as f, UnlockOptions as ft, DocumentMetadata as g, NoSettings as gt, DocumentMeta as h, DeepPartial as ht, CoreState as i, LatestRun as in, PluginDef as it, InitialDocument as j, MirrorSpec as jt, GlobalState as k, MirrorChange as kt, DocumentActiveChangedEvent as l, StateCell as lt, DocumentLockedEvent as m, UrlSource as mt, BatchResult as n, LatestCancellation as nn, Permission as nt, CustomMetadataPatch as o, PromiseMemberOf as ot, DocumentInfo as p, Unsubscribe as pt, PageObjectNumber as q, EventHook as qt, CapabilityToken as r, LatestLane as rn, PluginContext as rt, CustomMetadataUpdateResult as s, PromiseMembers as st, AnyPlugin as t, toPluginErrorInfo as tn, PendingMeta as tt, DocumentClosedEvent as u, StateChange as ut, DocumentOpenedEvent as v, SettingsApi as vt, DownloadOptions as w, createSerialQueue as wt, DocumentUnsavedChangesChangedEvent as x, SettingsOf as xt, DocumentPagesChangedEvent as y, SettingsChangedEvent as yt, OpenSource as z, ChangeLabel as zt };
-//# sourceMappingURL=types-t-DaU8VK.d.cts.map
+export { PdfRotation as $, StagedChange as $t, HostPrinter as A, SerialQueue as At, OpenSource as B, SliceChange as Bt, DocumentsToken as C, NoSettings as Ct, EventOrigin as D, SettingsDeclaration as Dt, EngineFactory as E, SettingsChangedEvent as Et, MetadataUpdateResult as F, Mirror as Ft, PageInsertBlankSpec as G, timerClock as Gt, PageDeleteResult as H, Cancel as Ht, OpenDocumentOptions as I, MirrorChange as It, PageObjectNumber as J, HeldChange as Jt, PageInsertResult as K, ChangeLabel as Kt, OpenDocumentResult as L, MirrorReload as Lt, InitialDocument as M, PageMirror as Mt, LockedDocumentInfo as N, PageMirrorChange as Nt, FailedDocumentInfo as O, SettingsOf as Ot, MetadataPatch as P, PageMirrorSpec as Pt, PdfDestination as Q, SettledChange as Qt, OpenInput as R, MirrorSpec as Rt, DocumentsCapability as S, DeepPartial as St, Engine$1 as T, SettingsApi as Tt, PageDestination as U, HostClock as Ut, OperationOptions as V, SliceLease as Vt, PageInfo as W, PluginClock as Wt, PageReorderResult as X, PendingChange as Xt, PagePosition as Y, HoldOptions as Yt, PageRotateResult as Z, PredictedOp as Zt, DocumentOpenFailedEvent as _, StateChange as _t, CustomMetadata as a, PluginErrorInfo as an, PluginDef as at, DocumentStatus as b, Unsubscribe as bt, DocCapability as c, toPluginErrorInfo as cn, PrintOptions as ct, DocumentEvent$1 as d, LatestRun as dn, PrintSheet as dt, EventHook as en, PdfSaveMode as et, DocumentHandle$1 as f, createLatestLane as fn, PromiseMemberOf as ft, DocumentMetadata as g, StateCell as gt, DocumentMeta as h, StagedPrint as ht, CoreState as i, PluginErrorCode as in, PluginContext as it, Identity$1 as j, createSerialQueue as jt, GlobalState as k, mergeSettings as kt, DocumentActiveChangedEvent as l, LatestCancellation as ln, PrintProgress as lt, DocumentLockedEvent as m, ResourceStatus as mt, BatchResult as n, createEventHook as nn, PendingMeta as nt, CustomMetadataPatch as o, isPluginError as on, PluginScope as ot, DocumentInfo as p, PromiseMembers as pt, PageLayout$1 as q, ChangeQueue as qt, CapabilityToken as r, PluginError as rn, Permission as rt, CustomMetadataUpdateResult as s, toPluginError as sn, PreparedPrint as st, AnyPlugin as t, EventHookSource as tn, PdfSize as tt, DocumentClosedEvent as u, LatestLane as un, PrintQuality as ut, DocumentOpenedEvent as v, Subscribable as vt, DownloadOptions as w, Settings as wt, DocumentUnsavedChangesChangedEvent as x, UrlSource as xt, DocumentPagesChangedEvent as y, UnlockOptions as yt, OpenOptions as z, reload as zt };
+//# sourceMappingURL=types-CfnZ7go6.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@embedpdf/core",
-  "version": "3.0.0-next.15",
+  "version": "3.0.0-next.16",
   "private": false,
   "description": "Pure, framework-free runtime for the EmbedPDF v3 viewer: store, typed capabilities, and plugin lifecycle. DOM-free and serializable.",
   "type": "module",
@@ -22,7 +22,7 @@
     "dist"
   ],
   "dependencies": {
-    "@embedpdf/engine-core": "3.0.0-next.15"
+    "@embedpdf/engine-core": "3.0.0-next.16"
   },
   "devDependencies": {
     "typescript": "^5.0.0",