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

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { $ as PdfSaveMode, $t as isPluginError, A as Identity, At as MirrorReload, B as OperationOptions, Bt as ChangeQueue, C as DocumentsToken, Ct as SerialQueue, D as EventOrigin, Dt as PageMirrorSpec, E as EngineFactory, Et as PageMirrorChange, F as OpenDocumentOptions, Ft as Cancel, G as PageInsertResult, Gt as SettledChange, H as PageDestination, Ht as HoldOptions, I as OpenDocumentResult, It as HostClock, J as PagePosition, Jt as EventHookSource, K as PageLayout, Kt as StagedChange, L as OpenInput, Lt as PluginClock, M as LockedDocumentInfo, Mt as reload, N as MetadataPatch, Nt as SliceChange, O as FailedDocumentInfo, Ot as Mirror, P as MetadataUpdateResult, Pt as SliceLease, Q as PdfRotation, Qt as PluginErrorInfo, R as OpenOptions, Rt as timerClock, S as DocumentsCapability, St as mergeSettings, T as Engine, Tt as PageMirror, U as PageInfo, Ut as PendingChange, V as PageDeleteResult, Vt as HeldChange, W as PageInsertBlankSpec, Wt as PredictedOp, X as PageRotateResult, Xt as PluginError, Y as PageReorderResult, Yt as createEventHook, Z as PdfDestination, Zt as PluginErrorCode, _ as DocumentOpenFailedEvent, _t as Settings, a as CustomMetadata, an as createLatestLane, at as PluginScope, b as DocumentStatus, bt as SettingsDeclaration, c as DocCapability, ct as ResourceStatus, d as DocumentEvent, dt as Subscribable, en as toPluginError, et as PdfSize, f as DocumentHandle, ft as UnlockOptions, g as DocumentMetadata, gt as NoSettings, h as DocumentMeta, ht as DeepPartial, i as CoreState, in as LatestRun, it as PluginDef, j as InitialDocument, jt as MirrorSpec, k as GlobalState, kt as MirrorChange, l as DocumentActiveChangedEvent, lt as StateCell, m as DocumentLockedEvent, mt as UrlSource, n as BatchResult, nn as LatestCancellation, nt as Permission, o as CustomMetadataPatch, ot as PromiseMemberOf, p as DocumentInfo, pt as Unsubscribe, q as PageObjectNumber, qt as EventHook, r as CapabilityToken, rn as LatestLane, rt as PluginContext, s as CustomMetadataUpdateResult, st as PromiseMembers, t as AnyPlugin, tn as toPluginErrorInfo, tt as PendingMeta, u as DocumentClosedEvent, ut as StateChange, v as DocumentOpenedEvent, vt as SettingsApi, w as DownloadOptions, wt as createSerialQueue, x as DocumentUnsavedChangesChangedEvent, xt as SettingsOf, y as DocumentPagesChangedEvent, yt as SettingsChangedEvent, z as OpenSource, zt as ChangeLabel } from "./types-t-DaU8VK.cjs";
-import { AbortablePromise, AnnotationAppearanceImage, AnnotationRef, CONTINUOUS_RENDER_POLICY, CallFacts, CallPriority, DocumentHandle as DocumentHandle$1, EngineRenderPolicy, Identity as Identity$1, PageHandle, PageImageHandle, PageImageObjectUrl, PageImageOptions, PageLayerRights, PageRaster, PageRef, PageRenderLayers, PageRenderOptions, PageRenderTarget, PageRenderViewport, PdfRect, PermissionDenied, WorkingSetPage, annotationKey, decodePageKey, encodePageKey, isLocalEngine, pageRefsEqual, resolvePageLayers, snapAppearanceScale, snapFullPageViewport, snapTileScale, toPageRef } from "@embedpdf/engine-core/runtime";
+import { $ as PdfRotation, $t as StagedChange, A as HostPrinter, At as SerialQueue, B as OpenSource, Bt as SliceChange, C as DocumentsToken, Ct as NoSettings, D as EventOrigin, Dt as SettingsDeclaration, E as EngineFactory, Et as SettingsChangedEvent, F as MetadataUpdateResult, Ft as Mirror, G as PageInsertBlankSpec, Gt as timerClock, H as PageDeleteResult, Ht as Cancel, I as OpenDocumentOptions, It as MirrorChange, J as PageObjectNumber, Jt as HeldChange, K as PageInsertResult, Kt as ChangeLabel, L as OpenDocumentResult, Lt as MirrorReload, M as InitialDocument, Mt as PageMirror, N as LockedDocumentInfo, Nt as PageMirrorChange, O as FailedDocumentInfo, Ot as SettingsOf, P as MetadataPatch, Pt as PageMirrorSpec, Q as PdfDestination, Qt as SettledChange, R as OpenInput, Rt as MirrorSpec, S as DocumentsCapability, St as DeepPartial, T as Engine, Tt as SettingsApi, U as PageDestination, Ut as HostClock, V as OperationOptions, Vt as SliceLease, W as PageInfo, Wt as PluginClock, X as PageReorderResult, Xt as PendingChange, Y as PagePosition, Yt as HoldOptions, Z as PageRotateResult, Zt as PredictedOp, _ as DocumentOpenFailedEvent, _t as StateChange, a as CustomMetadata, an as PluginErrorInfo, at as PluginDef, b as DocumentStatus, bt as Unsubscribe, c as DocCapability, cn as toPluginErrorInfo, ct as PrintOptions, d as DocumentEvent, dn as LatestRun, dt as PrintSheet, en as EventHook, et as PdfSaveMode, f as DocumentHandle, fn as createLatestLane, ft as PromiseMemberOf, g as DocumentMetadata, gt as StateCell, h as DocumentMeta, ht as StagedPrint, i as CoreState, in as PluginErrorCode, it as PluginContext, j as Identity, jt as createSerialQueue, k as GlobalState, kt as mergeSettings, l as DocumentActiveChangedEvent, ln as LatestCancellation, lt as PrintProgress, m as DocumentLockedEvent, mt as ResourceStatus, n as BatchResult, nn as createEventHook, nt as PendingMeta, o as CustomMetadataPatch, on as isPluginError, ot as PluginScope, p as DocumentInfo, pt as PromiseMembers, q as PageLayout, qt as ChangeQueue, r as CapabilityToken, rn as PluginError, rt as Permission, s as CustomMetadataUpdateResult, sn as toPluginError, st as PreparedPrint, t as AnyPlugin, tn as EventHookSource, tt as PdfSize, u as DocumentClosedEvent, un as LatestLane, ut as PrintQuality, v as DocumentOpenedEvent, vt as Subscribable, w as DownloadOptions, wt as Settings, x as DocumentUnsavedChangesChangedEvent, xt as UrlSource, y as DocumentPagesChangedEvent, yt as UnlockOptions, z as OpenOptions, zt as reload } from "./types-CfnZ7go6.cjs";
+import { AbortablePromise, AnnotationAppearanceImage, AnnotationRef, CONTINUOUS_RENDER_POLICY, CallFacts, CallPriority, DocumentHandle as DocumentHandle$1, EngineRenderPolicy, Identity as Identity$1, PageHandle, PageImageHandle, PageImageObjectUrl, PageImageOptions, PageLayerRights, PageRaster, PageRef, PageRenderLayers, PageRenderOptions, PageRenderTarget, PageRenderViewport, PdfRect, PermissionDenied, PrintDpi, WorkingSetPage, annotationKey, decodePageKey, encodePageKey, isLocalEngine, pageRefsEqual, resolvePageLayers, snapAppearanceScale, snapFullPageViewport, snapTileScale, toPageRef } from "@embedpdf/engine-core/runtime";
 //#region src/viewer-settings.d.ts
 /** How each page looks before its picture arrives, and around it. */
 interface ViewerPageSettings {
@@ -121,6 +121,11 @@ declare function createKernel(config: {
    * timers and no frames.
    */
   clock?: HostClock;
+  /**
+   * The host's print dialog: where `documents.print()` sends the pages. A browser passes
+   * `browserPrinter()` from `@embedpdf/web`. Without one, nothing prints (`canPrint()` is false).
+   */
+  printer?: HostPrinter;
 }): Kernel;
 //#endregion
 //#region src/compose.d.ts
@@ -297,5 +302,5 @@ declare function createHostToken<Host>(token: CapabilityToken<unknown>): Capabil
  */
 declare function definePlugin<State = void, Capability = unknown, Settings extends object = NoSettings>(definition: PluginDef<State, Capability, Settings>): PluginDef<State, Capability, Settings>;
 //#endregion
-export { AbortablePromise, type AnnotationAppearanceImage, type AnnotationRef, AnyPlugin, BatchResult, CONTINUOUS_RENDER_POLICY, type CallFacts, type CallPriority, type Cancel, CancelledError, CapabilityToken, type ChangeLabel, type ChangeQueue, CoreState, type CustomMetadata, type CustomMetadataPatch, type CustomMetadataUpdateResult, type DeepPartial, type DocCapability, DocumentActiveChangedEvent, DocumentClosedEvent, type DocumentEvent, type DocumentHandle, DocumentInfo, DocumentLockedEvent, DocumentMeta, type DocumentMetadata, DocumentOpenFailedEvent, DocumentOpenedEvent, DocumentPagesChangedEvent, DocumentStatus, DocumentUnsavedChangesChangedEvent, DocumentsCapability, type DocumentsState, DocumentsToken, DownloadOptions, type Engine, type EngineFactory, type EngineRenderPolicy, EventHook, EventHookSource, type EventOrigin, FailedDocumentInfo, GlobalState, type HeldChange, type HoldOptions, type HostClock, type Identity, InitialDocument, Kernel, KernelStatus, type LatestCancellation, type LatestLane, type LatestRun, LockedDocumentInfo, type MetadataPatch, type MetadataUpdateResult, type Mirror, type MirrorChange, type MirrorReload, type MirrorSpec, type NoSettings, OpenDocumentOptions, OpenDocumentResult, type OpenInput, type OpenOptions, OpenSource, OperationOptions, type PageDeleteResult, type PageDestination, type PageHandle, type PageImageHandle, type PageImageObjectUrl, type PageImageOptions, PageInfo, type PageInsertBlankSpec, type PageInsertResult, type PageLayerRights, type PageLayout, type PageMirror, type PageMirrorChange, type PageMirrorSpec, type PageObjectNumber, type PagePosition, type PageRaster, type PageRef, type PageRenderLayers, type PageRenderOptions, type PageRenderTarget, type PageRenderViewport, type PageReorderResult, type PageRotateResult, type PdfDestination, type PdfRect, type PdfRotation, type PdfSaveMode, type PdfSize, type PendingChange, PendingMeta, Permission, PermissionDenied, type PluginClock, PluginContext, PluginDef, PluginError, PluginErrorCode, PluginErrorInfo, PluginScope, type PredictedOp, PromiseMemberOf, PromiseMembers, ResourceStatus, SerialQueue, type Settings, type SettingsApi, type SettingsChangedEvent, type SettingsDeclaration, type SettingsOf, type SettledChange, type SliceChange, type SliceLease, type StagedChange, StateCell, StateChange, type StateDeclaration, Subscribable, UnlockOptions, Unsubscribe, UrlSource, VIEWER_DEFAULTS, VIEWER_WHOLE_SETTINGS, type ViewerPageSettings, type ViewerSettings, type ViewerSettingsInput, type WorkingSetPage, annotationKey, composeApi, createCapabilityToken, createEventHook, createHostToken, createKernel, createLatestLane, createSerialQueue, decodePageKey, definePlugin, defineState, documentState, documentsState, encodePageKey, guardHandle, isCancelled, isLocalEngine, isPluginError, isReadMember, memo, memoByKey, mergeSettings, pageRefsEqual, reload, resolvePageLayers, returnsPromise, shallowEqual, snapAppearanceScale, snapFullPageViewport, snapTileScale, standInFor, timerClock, toPageRef, toPluginError, toPluginErrorInfo, viewerSettingsOf };
+export { AbortablePromise, type AnnotationAppearanceImage, type AnnotationRef, AnyPlugin, BatchResult, CONTINUOUS_RENDER_POLICY, type CallFacts, type CallPriority, type Cancel, CancelledError, CapabilityToken, type ChangeLabel, type ChangeQueue, CoreState, type CustomMetadata, type CustomMetadataPatch, type CustomMetadataUpdateResult, type DeepPartial, type DocCapability, DocumentActiveChangedEvent, DocumentClosedEvent, type DocumentEvent, type DocumentHandle, DocumentInfo, DocumentLockedEvent, DocumentMeta, type DocumentMetadata, DocumentOpenFailedEvent, DocumentOpenedEvent, DocumentPagesChangedEvent, DocumentStatus, DocumentUnsavedChangesChangedEvent, DocumentsCapability, type DocumentsState, DocumentsToken, DownloadOptions, type Engine, type EngineFactory, type EngineRenderPolicy, EventHook, EventHookSource, type EventOrigin, FailedDocumentInfo, GlobalState, type HeldChange, type HoldOptions, type HostClock, HostPrinter, type Identity, InitialDocument, Kernel, KernelStatus, type LatestCancellation, type LatestLane, type LatestRun, LockedDocumentInfo, type MetadataPatch, type MetadataUpdateResult, type Mirror, type MirrorChange, type MirrorReload, type MirrorSpec, type NoSettings, OpenDocumentOptions, OpenDocumentResult, type OpenInput, type OpenOptions, OpenSource, OperationOptions, type PageDeleteResult, type PageDestination, type PageHandle, type PageImageHandle, type PageImageObjectUrl, type PageImageOptions, PageInfo, type PageInsertBlankSpec, type PageInsertResult, type PageLayerRights, type PageLayout, type PageMirror, type PageMirrorChange, type PageMirrorSpec, type PageObjectNumber, type PagePosition, type PageRaster, type PageRef, type PageRenderLayers, type PageRenderOptions, type PageRenderTarget, type PageRenderViewport, type PageReorderResult, type PageRotateResult, type PdfDestination, type PdfRect, type PdfRotation, type PdfSaveMode, type PdfSize, type PendingChange, PendingMeta, Permission, PermissionDenied, type PluginClock, PluginContext, PluginDef, PluginError, PluginErrorCode, PluginErrorInfo, PluginScope, type PredictedOp, PreparedPrint, type PrintDpi, PrintOptions, PrintProgress, PrintQuality, PrintSheet, PromiseMemberOf, PromiseMembers, ResourceStatus, SerialQueue, type Settings, type SettingsApi, type SettingsChangedEvent, type SettingsDeclaration, type SettingsOf, type SettledChange, type SliceChange, type SliceLease, type StagedChange, StagedPrint, StateCell, StateChange, type StateDeclaration, Subscribable, UnlockOptions, Unsubscribe, UrlSource, VIEWER_DEFAULTS, VIEWER_WHOLE_SETTINGS, type ViewerPageSettings, type ViewerSettings, type ViewerSettingsInput, type WorkingSetPage, annotationKey, composeApi, createCapabilityToken, createEventHook, createHostToken, createKernel, createLatestLane, createSerialQueue, decodePageKey, definePlugin, defineState, documentState, documentsState, encodePageKey, guardHandle, isCancelled, isLocalEngine, isPluginError, isReadMember, memo, memoByKey, mergeSettings, pageRefsEqual, reload, resolvePageLayers, returnsPromise, shallowEqual, snapAppearanceScale, snapFullPageViewport, snapTileScale, standInFor, timerClock, toPageRef, toPluginError, toPluginErrorInfo, viewerSettingsOf };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { $ as PdfSaveMode, $t as isPluginError, A as Identity, At as MirrorReload, B as OperationOptions, Bt as ChangeQueue, C as DocumentsToken, Ct as SerialQueue, D as EventOrigin, Dt as PageMirrorSpec, E as EngineFactory, Et as PageMirrorChange, F as OpenDocumentOptions, Ft as Cancel, G as PageInsertResult, Gt as SettledChange, H as PageDestination, Ht as HoldOptions, I as OpenDocumentResult, It as HostClock, J as PagePosition, Jt as EventHookSource, K as PageLayout, Kt as StagedChange, L as OpenInput, Lt as PluginClock, M as LockedDocumentInfo, Mt as reload, N as MetadataPatch, Nt as SliceChange, O as FailedDocumentInfo, Ot as Mirror, P as MetadataUpdateResult, Pt as SliceLease, Q as PdfRotation, Qt as PluginErrorInfo, R as OpenOptions, Rt as timerClock, S as DocumentsCapability, St as mergeSettings, T as Engine, Tt as PageMirror, U as PageInfo, Ut as PendingChange, V as PageDeleteResult, Vt as HeldChange, W as PageInsertBlankSpec, Wt as PredictedOp, X as PageRotateResult, Xt as PluginError, Y as PageReorderResult, Yt as createEventHook, Z as PdfDestination, Zt as PluginErrorCode, _ as DocumentOpenFailedEvent, _t as Settings, a as CustomMetadata, an as createLatestLane, at as PluginScope, b as DocumentStatus, bt as SettingsDeclaration, c as DocCapability, ct as ResourceStatus, d as DocumentEvent, dt as Subscribable, en as toPluginError, et as PdfSize, f as DocumentHandle, ft as UnlockOptions, g as DocumentMetadata, gt as NoSettings, h as DocumentMeta, ht as DeepPartial, i as CoreState, in as LatestRun, it as PluginDef, j as InitialDocument, jt as MirrorSpec, k as GlobalState, kt as MirrorChange, l as DocumentActiveChangedEvent, lt as StateCell, m as DocumentLockedEvent, mt as UrlSource, n as BatchResult, nn as LatestCancellation, nt as Permission, o as CustomMetadataPatch, ot as PromiseMemberOf, p as DocumentInfo, pt as Unsubscribe, q as PageObjectNumber, qt as EventHook, r as CapabilityToken, rn as LatestLane, rt as PluginContext, s as CustomMetadataUpdateResult, st as PromiseMembers, t as AnyPlugin, tn as toPluginErrorInfo, tt as PendingMeta, u as DocumentClosedEvent, ut as StateChange, v as DocumentOpenedEvent, vt as SettingsApi, w as DownloadOptions, wt as createSerialQueue, x as DocumentUnsavedChangesChangedEvent, xt as SettingsOf, y as DocumentPagesChangedEvent, yt as SettingsChangedEvent, z as OpenSource, zt as ChangeLabel } from "./types-t-DaU8VK.js";
-import { AbortablePromise, AnnotationAppearanceImage, AnnotationRef, CONTINUOUS_RENDER_POLICY, CallFacts, CallPriority, DocumentHandle as DocumentHandle$1, EngineRenderPolicy, Identity as Identity$1, PageHandle, PageImageHandle, PageImageObjectUrl, PageImageOptions, PageLayerRights, PageRaster, PageRef, PageRenderLayers, PageRenderOptions, PageRenderTarget, PageRenderViewport, PdfRect, PermissionDenied, WorkingSetPage, annotationKey, decodePageKey, encodePageKey, isLocalEngine, pageRefsEqual, resolvePageLayers, snapAppearanceScale, snapFullPageViewport, snapTileScale, toPageRef } from "@embedpdf/engine-core/runtime";
+import { $ as PdfRotation, $t as StagedChange, A as HostPrinter, At as SerialQueue, B as OpenSource, Bt as SliceChange, C as DocumentsToken, Ct as NoSettings, D as EventOrigin, Dt as SettingsDeclaration, E as EngineFactory, Et as SettingsChangedEvent, F as MetadataUpdateResult, Ft as Mirror, G as PageInsertBlankSpec, Gt as timerClock, H as PageDeleteResult, Ht as Cancel, I as OpenDocumentOptions, It as MirrorChange, J as PageObjectNumber, Jt as HeldChange, K as PageInsertResult, Kt as ChangeLabel, L as OpenDocumentResult, Lt as MirrorReload, M as InitialDocument, Mt as PageMirror, N as LockedDocumentInfo, Nt as PageMirrorChange, O as FailedDocumentInfo, Ot as SettingsOf, P as MetadataPatch, Pt as PageMirrorSpec, Q as PdfDestination, Qt as SettledChange, R as OpenInput, Rt as MirrorSpec, S as DocumentsCapability, St as DeepPartial, T as Engine, Tt as SettingsApi, U as PageDestination, Ut as HostClock, V as OperationOptions, Vt as SliceLease, W as PageInfo, Wt as PluginClock, X as PageReorderResult, Xt as PendingChange, Y as PagePosition, Yt as HoldOptions, Z as PageRotateResult, Zt as PredictedOp, _ as DocumentOpenFailedEvent, _t as StateChange, a as CustomMetadata, an as PluginErrorInfo, at as PluginDef, b as DocumentStatus, bt as Unsubscribe, c as DocCapability, cn as toPluginErrorInfo, ct as PrintOptions, d as DocumentEvent, dn as LatestRun, dt as PrintSheet, en as EventHook, et as PdfSaveMode, f as DocumentHandle, fn as createLatestLane, ft as PromiseMemberOf, g as DocumentMetadata, gt as StateCell, h as DocumentMeta, ht as StagedPrint, i as CoreState, in as PluginErrorCode, it as PluginContext, j as Identity, jt as createSerialQueue, k as GlobalState, kt as mergeSettings, l as DocumentActiveChangedEvent, ln as LatestCancellation, lt as PrintProgress, m as DocumentLockedEvent, mt as ResourceStatus, n as BatchResult, nn as createEventHook, nt as PendingMeta, o as CustomMetadataPatch, on as isPluginError, ot as PluginScope, p as DocumentInfo, pt as PromiseMembers, q as PageLayout, qt as ChangeQueue, r as CapabilityToken, rn as PluginError, rt as Permission, s as CustomMetadataUpdateResult, sn as toPluginError, st as PreparedPrint, t as AnyPlugin, tn as EventHookSource, tt as PdfSize, u as DocumentClosedEvent, un as LatestLane, ut as PrintQuality, v as DocumentOpenedEvent, vt as Subscribable, w as DownloadOptions, wt as Settings, x as DocumentUnsavedChangesChangedEvent, xt as UrlSource, y as DocumentPagesChangedEvent, yt as UnlockOptions, z as OpenOptions, zt as reload } from "./types-CfnZ7go6.js";
+import { AbortablePromise, AnnotationAppearanceImage, AnnotationRef, CONTINUOUS_RENDER_POLICY, CallFacts, CallPriority, DocumentHandle as DocumentHandle$1, EngineRenderPolicy, Identity as Identity$1, PageHandle, PageImageHandle, PageImageObjectUrl, PageImageOptions, PageLayerRights, PageRaster, PageRef, PageRenderLayers, PageRenderOptions, PageRenderTarget, PageRenderViewport, PdfRect, PermissionDenied, PrintDpi, WorkingSetPage, annotationKey, decodePageKey, encodePageKey, isLocalEngine, pageRefsEqual, resolvePageLayers, snapAppearanceScale, snapFullPageViewport, snapTileScale, toPageRef } from "@embedpdf/engine-core/runtime";
 //#region src/viewer-settings.d.ts
 /** How each page looks before its picture arrives, and around it. */
 interface ViewerPageSettings {
@@ -121,6 +121,11 @@ declare function createKernel(config: {
    * timers and no frames.
    */
   clock?: HostClock;
+  /**
+   * The host's print dialog: where `documents.print()` sends the pages. A browser passes
+   * `browserPrinter()` from `@embedpdf/web`. Without one, nothing prints (`canPrint()` is false).
+   */
+  printer?: HostPrinter;
 }): Kernel;
 //#endregion
 //#region src/compose.d.ts
@@ -297,5 +302,5 @@ declare function createHostToken<Host>(token: CapabilityToken<unknown>): Capabil
  */
 declare function definePlugin<State = void, Capability = unknown, Settings extends object = NoSettings>(definition: PluginDef<State, Capability, Settings>): PluginDef<State, Capability, Settings>;
 //#endregion
-export { AbortablePromise, type AnnotationAppearanceImage, type AnnotationRef, AnyPlugin, BatchResult, CONTINUOUS_RENDER_POLICY, type CallFacts, type CallPriority, type Cancel, CancelledError, CapabilityToken, type ChangeLabel, type ChangeQueue, CoreState, type CustomMetadata, type CustomMetadataPatch, type CustomMetadataUpdateResult, type DeepPartial, type DocCapability, DocumentActiveChangedEvent, DocumentClosedEvent, type DocumentEvent, type DocumentHandle, DocumentInfo, DocumentLockedEvent, DocumentMeta, type DocumentMetadata, DocumentOpenFailedEvent, DocumentOpenedEvent, DocumentPagesChangedEvent, DocumentStatus, DocumentUnsavedChangesChangedEvent, DocumentsCapability, type DocumentsState, DocumentsToken, DownloadOptions, type Engine, type EngineFactory, type EngineRenderPolicy, EventHook, EventHookSource, type EventOrigin, FailedDocumentInfo, GlobalState, type HeldChange, type HoldOptions, type HostClock, type Identity, InitialDocument, Kernel, KernelStatus, type LatestCancellation, type LatestLane, type LatestRun, LockedDocumentInfo, type MetadataPatch, type MetadataUpdateResult, type Mirror, type MirrorChange, type MirrorReload, type MirrorSpec, type NoSettings, OpenDocumentOptions, OpenDocumentResult, type OpenInput, type OpenOptions, OpenSource, OperationOptions, type PageDeleteResult, type PageDestination, type PageHandle, type PageImageHandle, type PageImageObjectUrl, type PageImageOptions, PageInfo, type PageInsertBlankSpec, type PageInsertResult, type PageLayerRights, type PageLayout, type PageMirror, type PageMirrorChange, type PageMirrorSpec, type PageObjectNumber, type PagePosition, type PageRaster, type PageRef, type PageRenderLayers, type PageRenderOptions, type PageRenderTarget, type PageRenderViewport, type PageReorderResult, type PageRotateResult, type PdfDestination, type PdfRect, type PdfRotation, type PdfSaveMode, type PdfSize, type PendingChange, PendingMeta, Permission, PermissionDenied, type PluginClock, PluginContext, PluginDef, PluginError, PluginErrorCode, PluginErrorInfo, PluginScope, type PredictedOp, PromiseMemberOf, PromiseMembers, ResourceStatus, SerialQueue, type Settings, type SettingsApi, type SettingsChangedEvent, type SettingsDeclaration, type SettingsOf, type SettledChange, type SliceChange, type SliceLease, type StagedChange, StateCell, StateChange, type StateDeclaration, Subscribable, UnlockOptions, Unsubscribe, UrlSource, VIEWER_DEFAULTS, VIEWER_WHOLE_SETTINGS, type ViewerPageSettings, type ViewerSettings, type ViewerSettingsInput, type WorkingSetPage, annotationKey, composeApi, createCapabilityToken, createEventHook, createHostToken, createKernel, createLatestLane, createSerialQueue, decodePageKey, definePlugin, defineState, documentState, documentsState, encodePageKey, guardHandle, isCancelled, isLocalEngine, isPluginError, isReadMember, memo, memoByKey, mergeSettings, pageRefsEqual, reload, resolvePageLayers, returnsPromise, shallowEqual, snapAppearanceScale, snapFullPageViewport, snapTileScale, standInFor, timerClock, toPageRef, toPluginError, toPluginErrorInfo, viewerSettingsOf };
+export { AbortablePromise, type AnnotationAppearanceImage, type AnnotationRef, AnyPlugin, BatchResult, CONTINUOUS_RENDER_POLICY, type CallFacts, type CallPriority, type Cancel, CancelledError, CapabilityToken, type ChangeLabel, type ChangeQueue, CoreState, type CustomMetadata, type CustomMetadataPatch, type CustomMetadataUpdateResult, type DeepPartial, type DocCapability, DocumentActiveChangedEvent, DocumentClosedEvent, type DocumentEvent, type DocumentHandle, DocumentInfo, DocumentLockedEvent, DocumentMeta, type DocumentMetadata, DocumentOpenFailedEvent, DocumentOpenedEvent, DocumentPagesChangedEvent, DocumentStatus, DocumentUnsavedChangesChangedEvent, DocumentsCapability, type DocumentsState, DocumentsToken, DownloadOptions, type Engine, type EngineFactory, type EngineRenderPolicy, EventHook, EventHookSource, type EventOrigin, FailedDocumentInfo, GlobalState, type HeldChange, type HoldOptions, type HostClock, HostPrinter, type Identity, InitialDocument, Kernel, KernelStatus, type LatestCancellation, type LatestLane, type LatestRun, LockedDocumentInfo, type MetadataPatch, type MetadataUpdateResult, type Mirror, type MirrorChange, type MirrorReload, type MirrorSpec, type NoSettings, OpenDocumentOptions, OpenDocumentResult, type OpenInput, type OpenOptions, OpenSource, OperationOptions, type PageDeleteResult, type PageDestination, type PageHandle, type PageImageHandle, type PageImageObjectUrl, type PageImageOptions, PageInfo, type PageInsertBlankSpec, type PageInsertResult, type PageLayerRights, type PageLayout, type PageMirror, type PageMirrorChange, type PageMirrorSpec, type PageObjectNumber, type PagePosition, type PageRaster, type PageRef, type PageRenderLayers, type PageRenderOptions, type PageRenderTarget, type PageRenderViewport, type PageReorderResult, type PageRotateResult, type PdfDestination, type PdfRect, type PdfRotation, type PdfSaveMode, type PdfSize, type PendingChange, PendingMeta, Permission, PermissionDenied, type PluginClock, PluginContext, PluginDef, PluginError, PluginErrorCode, PluginErrorInfo, PluginScope, type PredictedOp, PreparedPrint, type PrintDpi, PrintOptions, PrintProgress, PrintQuality, PrintSheet, PromiseMemberOf, PromiseMembers, ResourceStatus, SerialQueue, type Settings, type SettingsApi, type SettingsChangedEvent, type SettingsDeclaration, type SettingsOf, type SettledChange, type SliceChange, type SliceLease, type StagedChange, StagedPrint, StateCell, StateChange, type StateDeclaration, Subscribable, UnlockOptions, Unsubscribe, UrlSource, VIEWER_DEFAULTS, VIEWER_WHOLE_SETTINGS, type ViewerPageSettings, type ViewerSettings, type ViewerSettingsInput, type WorkingSetPage, annotationKey, composeApi, createCapabilityToken, createEventHook, createHostToken, createKernel, createLatestLane, createSerialQueue, decodePageKey, definePlugin, defineState, documentState, documentsState, encodePageKey, guardHandle, isCancelled, isLocalEngine, isPluginError, isReadMember, memo, memoByKey, mergeSettings, pageRefsEqual, reload, resolvePageLayers, returnsPromise, shallowEqual, snapAppearanceScale, snapFullPageViewport, snapTileScale, standInFor, timerClock, toPageRef, toPluginError, toPluginErrorInfo, viewerSettingsOf };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,4 +1,4 @@
-import { A as createScope, C as createDocumentChanges, D as toPluginError, E as isPluginError, M as createBurstGate, N as DocumentsToken, O as toPluginErrorInfo, S as timerClock, T as PluginError, _ as reload, a as markConnected, b as createStore, d as findPage, i as createPluginContext, j as isCancelled, k as CancelledError, l as permissionDenied, m as createSerialQueue, n as mergeSettings, o as readWrapped, p as cancellable, r as settle, s as sliceKey, t as createSettingsStore, u as sessionAllows, v as createLatestLane, w as createEventHook, y as guardHandle } from "./settings-CMWFRjmQ.js";
+import { A as createScope, C as createDocumentChanges, D as toPluginError, E as isPluginError, M as createBurstGate, N as DocumentsToken, O as toPluginErrorInfo, S as timerClock, T as PluginError, _ as reload, a as markConnected, b as createStore, d as findPage, i as createPluginContext, j as isCancelled, k as CancelledError, l as permissionDenied, m as createSerialQueue, n as mergeSettings, o as runWrapped, p as cancellable, r as settle, s as sliceKey, t as createSettingsStore, u as sessionAllows, v as createLatestLane, w as createEventHook, y as guardHandle } from "./settings-CHdHuZ3k.js";
 import { AbortablePromise, CONTINUOUS_RENDER_POLICY, CONTINUOUS_RENDER_POLICY as CONTINUOUS_RENDER_POLICY$1, PermissionDenied, annotationKey, decodePageKey, encodePageKey, isLocalDocument, isLocalEngine, pageRefsEqual, pageRefsEqual as pageRefsEqual$1, resolvePageLayers, snapAppearanceScale, snapFullPageViewport, snapTileScale, toPageRef } from "@embedpdf/engine-core/runtime";
 //#region src/order.ts
 /**
@@ -96,7 +96,8 @@ function layoutFromEvent(event) {
 		case "pages.reordered":
 		case "pages.rotated":
 		case "pages.deleted":
-		case "pages.inserted": return event.layout;
+		case "pages.inserted":
+		case "pages.restored": return event.layout;
 		default: return null;
 	}
 }
@@ -146,6 +147,16 @@ async function fetchUrlSource(source, signal) {
 }
 const isUrlSource = (source) => source.kind === "url";
 const noLayer = () => new PluginError("unsupported", "documents", "only the local engine gives a layer to download");
+/** How a print comes out at each tier, one object each, so readers can compare them with `Object.is`. */
+const PRINT_STANDARD = Object.freeze({
+	kind: "images",
+	dpi: 150
+});
+const PRINT_HIGH = Object.freeze({
+	kind: "images",
+	dpi: 300
+});
+const PRINT_PDF = Object.freeze({ kind: "pdf" });
 /**
 * The documents capability as seen from inside one document's scope: every call whose document
 * is optional uses that document instead of the active one. The rest is the registry itself.
@@ -156,6 +167,9 @@ const documentsInScope = (documents, documentId) => ({
 	download: (id = documentId, options) => documents.download(id, options),
 	downloadLayer: (id = documentId, options) => documents.downloadLayer(id, options),
 	canDownload: (id = documentId) => documents.canDownload(id),
+	preparePrint: (id = documentId, options) => documents.preparePrint(id, options),
+	print: (id = documentId, options) => documents.print(id, options),
+	getPrintQuality: (id = documentId) => documents.getPrintQuality(id),
 	canPrint: (id = documentId) => documents.canPrint(id),
 	listPages: (id = documentId) => documents.listPages(id),
 	getPage: (page, id = documentId) => documents.getPage(page, id),
@@ -293,12 +307,14 @@ function createKernel(config) {
 			leases: /* @__PURE__ */ new Map(),
 			settleFlushes: /* @__PURE__ */ new Set(),
 			downloadWraps: [],
+			printWraps: [],
 			changes: createDocumentChanges({
 				handle: () => session.handle,
 				notify: () => store.notify(),
 				report
 			}),
 			changeCount: 0,
+			changesSeen: 0,
 			close: () => closeSession(session)
 		};
 		session.settleFlushes.add(() => session.changes.settle());
@@ -517,13 +533,202 @@ function createKernel(config) {
 				readAt = session.changeCount;
 				return cancellable("documents", signal, read(handle));
 			};
-			const bytes = await readWrapped(session.downloadWraps, readFile);
+			const bytes = await runWrapped(session.downloadWraps, readFile);
 			if (readAt === session.changeCount) setUnsavedChanges(session, false);
 			return bytes;
 		} catch (error) {
 			throw toPluginError("documents", error);
 		}
 	}
+	const printer = config.printer ?? null;
+	const canPrintOn = (documentId) => printer !== null && allowsOn(documentId, "doc.print");
+	/**
+	* How a print comes out: the PDF copy with `doc.print.high`, a right to keep the copy (every
+	* print dialog can save it as a file) and a printer that prints a PDF; else pictures, at the
+	* resolution `doc.print.high` or `doc.print` allows.
+	*/
+	const printQualityOf = (documentId) => {
+		if (!canPrintOn(documentId)) return null;
+		if (!allowsOn(documentId, "doc.print.high")) return PRINT_STANDARD;
+		return (allowsOn(documentId, "doc.download") || allowsOn(documentId, "doc.download.flattened")) && printer?.stagePdf ? PRINT_PDF : PRINT_HIGH;
+	};
+	/** The pages a print asks for, in its order: every page when it names none. */
+	function printPagesOf(session, pages) {
+		const all = metaOf(session.id)?.pages ?? EMPTY_PAGES;
+		if (pages === void 0) return all;
+		if (pages.length === 0) throw new PluginError("invalid-input", "documents", "a print needs at least one page");
+		const found = pages.map((ref) => {
+			const page = findPage(all, ref);
+			if (!page) throw new PluginError("not-found", "documents", `page ${ref.objectNumber} is not in this document`);
+			return page;
+		});
+		if (new Set(found).size !== found.length) throw new PluginError("invalid-input", "documents", "a print names a page twice");
+		return found;
+	}
+	/**
+	* What prints beside the page content: the annotations as the options ask, by default when
+	* the user may read them; the form fields whenever the user may read the form.
+	*/
+	const printLayersOf = (documentId, options) => ({
+		includeAnnotations: options.includeAnnotations ?? allowsOn(documentId, "doc.annotate.read"),
+		includeFormFields: allowsOn(documentId, "doc.forms.read")
+	});
+	/**
+	* Make the pages as they print and hand them to the printer, once the document settled: the
+	* PDF copy, or a picture of each page. The pages are looked up again each time, so one deleted
+	* meanwhile refuses `not-found`. Returns the staged print, how it came out, and the change it
+	* saw last, so a print can tell it went stale.
+	*/
+	async function stagePrint(session, activePrinter, quality, options) {
+		const { signal } = options;
+		await settle(session.settleFlushes, [signal, session.signal], report);
+		const handle = documentHandle(session.id);
+		if (!handle) throw new PluginError("not-ready", "documents", "no open document to print");
+		const changesSeen = session.changesSeen;
+		const job = {
+			handle,
+			pages: printPagesOf(session, options.pages),
+			layers: printLayersOf(session.id, options),
+			name: session.name ?? "document",
+			options
+		};
+		options.onProgress?.({
+			pagesRendered: 0,
+			pageCount: job.pages.length
+		});
+		if (quality.kind === "images") return {
+			staged: await stagePictures(job, activePrinter, quality.dpi),
+			quality,
+			changesSeen
+		};
+		try {
+			return {
+				staged: await stagePdfCopy(job, activePrinter),
+				quality,
+				changesSeen
+			};
+		} catch (error) {
+			if (signal?.aborted) throw error;
+			return {
+				staged: await stagePictures(job, activePrinter, PRINT_HIGH.dpi),
+				quality: PRINT_HIGH,
+				changesSeen
+			};
+		}
+	}
+	/** The PDF copy of the pages as they print, staged with the printer. */
+	async function stagePdfCopy(job, activePrinter) {
+		const { handle, pages, layers, name, options } = job;
+		const { signal } = options;
+		if (!activePrinter.stagePdf) throw new PluginError("unsupported", "documents", "this printer prints no PDF");
+		const pdf = await cancellable("documents", signal, handle.pages.extract(pages.map((page) => page.ref), {
+			flatten: { usage: "print" },
+			...layers
+		}));
+		const staged = await activePrinter.stagePdf(pdf, {
+			name,
+			...signal ? { signal } : {}
+		});
+		options.onProgress?.({
+			pagesRendered: pages.length,
+			pageCount: pages.length
+		});
+		return staged;
+	}
+	/** A picture of each page, drawn by the print rules at `dpi`, staged with the printer. */
+	async function stagePictures(job, activePrinter, dpi) {
+		const { handle, pages, layers, name, options } = job;
+		const { signal } = options;
+		const sheets = [];
+		for (const page of pages) {
+			const blob = await cancellable("documents", signal, (await cancellable("documents", signal, handle.page(page.ref).render.image({
+				usage: "print",
+				viewport: {
+					kind: "dpi",
+					dpi
+				},
+				format: "png",
+				...layers
+			}))).blob());
+			sheets.push({
+				image: blob,
+				widthPt: page.size.width,
+				heightPt: page.size.height
+			});
+			options.onProgress?.({
+				pagesRendered: sheets.length,
+				pageCount: pages.length
+			});
+		}
+		return activePrinter.stage(sheets, {
+			name,
+			...signal ? { signal } : {}
+		});
+	}
+	/**
+	* Get a print ready. Refused before anything runs without `doc.print` or a printer, or for
+	* pages the document doesn't have. Its `print()` runs inside every `aroundPrint` wrap (the
+	* document's own print actions), and prepares again first when the document changed since:
+	* a will-print action that fills in a date is on the paper. When the printer turns the PDF
+	* copy down, preparing or printing, the same pages print as pictures, and `quality` says so.
+	*/
+	async function preparePrint(documentId, options = {}) {
+		const session = readySession(documentId, "preparePrint");
+		if (!allowsOn(session.id, "doc.print")) throw permissionDenied("documents", "doc.print", "documents.preparePrint");
+		const quality = printQualityOf(session.id);
+		if (!printer || !quality) throw new PluginError("unsupported", "documents", "no printer: pass one to createKernel({ printer }), such as browserPrinter() from @embedpdf/web");
+		const pageCount = printPagesOf(session, options.pages).length;
+		try {
+			let { staged, changesSeen, quality: printed } = await stagePrint(session, printer, quality, options);
+			let disposed = false;
+			const dispose = () => {
+				if (disposed) return;
+				disposed = true;
+				staged.dispose();
+			};
+			session.scope.defer(dispose);
+			/** Stage the print again, as `as`, in place of what was staged. */
+			const restage = async (as, signal) => {
+				const fresh = await stagePrint(session, printer, as, {
+					...options.pages ? { pages: options.pages } : {},
+					...options.includeAnnotations !== void 0 ? { includeAnnotations: options.includeAnnotations } : {},
+					...signal ? { signal } : {}
+				});
+				staged.dispose();
+				({staged, changesSeen, quality: printed} = fresh);
+			};
+			return {
+				get quality() {
+					return printed;
+				},
+				pageCount,
+				needsTap: printer.needsTap === true,
+				async print(printOptions) {
+					if (disposed) throw new PluginError("invalid-input", "documents", "this print was disposed");
+					const signal = printOptions?.signal;
+					const run = async () => {
+						if (session.changesSeen !== changesSeen) await restage(quality, signal);
+						if (signal?.aborted) throw new PluginError("operation-cancelled", "documents", "print cancelled", { cause: signal.reason });
+						try {
+							await staged.print();
+						} catch (error) {
+							if (printed.kind !== "pdf") throw error;
+							await restage(PRINT_HIGH, signal);
+							await staged.print();
+						}
+					};
+					try {
+						await runWrapped(session.printWraps, run);
+					} catch (error) {
+						throw toPluginError("documents", error);
+					}
+				},
+				dispose
+			};
+		} catch (error) {
+			throw toPluginError("documents", error);
+		}
+	}
 	/** Whether the plugin's `create()` is running for this document: it has no capability yet. */
 	const isBuilding = (plugin, session) => session.building.has(plugin) && !session.capabilities.has(plugin);
 	function buildDocumentCapability(plugin, session) {
@@ -665,9 +870,12 @@ function createKernel(config) {
 		session.scope.defer(bursts.close);
 		const unsubscribeEvents = session.handle.events.subscribe((event) => {
 			bursts.first(event);
-			if (tracksChanges && changesDocument(event)) {
-				session.changeCount += 1;
-				setUnsavedChanges(session, true);
+			if (changesDocument(event)) {
+				session.changesSeen += 1;
+				if (tracksChanges) {
+					session.changeCount += 1;
+					setUnsavedChanges(session, true);
+				}
 			}
 			const layout = layoutFromEvent(event);
 			if (!layout) return;
@@ -954,8 +1162,18 @@ function createKernel(config) {
 		},
 		download: (id, options) => downloadFile(id, options?.signal, "download", (handle) => handle.download(options?.mode !== void 0 ? { mode: options.mode } : void 0)),
 		downloadLayer: (id, options) => downloadFile(id, options?.signal, "downloadLayer", (handle) => isLocalDocument(handle) ? handle.downloadLayer() : Promise.reject(noLayer()), (handle) => isLocalDocument(handle) ? null : noLayer()),
+		preparePrint: (id, options) => preparePrint(id, options),
+		async print(id, options = {}) {
+			const prepared = await preparePrint(id, options);
+			try {
+				await prepared.print(options.signal ? { signal: options.signal } : void 0);
+			} finally {
+				prepared.dispose();
+			}
+		},
+		getPrintQuality: (id) => printQualityOf(id),
 		canDownload: (id) => allowsOn(id, "doc.download"),
-		canPrint: (id) => allowsOn(id, "doc.print"),
+		canPrint: (id) => canPrintOn(id),
 		listPages: (id) => metaOf(id)?.pages ?? EMPTY_PAGES,
 		getPage: (page, id) => findPage(metaOf(id)?.pages ?? EMPTY_PAGES, page),
 		getPageIndex: (ref, id) => metaOf(id)?.pages.findIndex((pageInfo) => pageRefsEqual$1(pageInfo.ref, ref)) ?? -1,