@paged-media/plugin-api 0.2.42-canary.0 → 0.2.43-canary.0

package/dist/host.d.ts

@@ -1138,6 +1138,55 @@ export interface ViewportSurface {
     /** Screen px → document pt at the current zoom (the constant-
      *  screen-tolerance idiom every tool needs). */
     pxToPt(px: number): number;
+    /** v70 — bring a page into view, fitted to the viewport (a slide
+     *  sorter's click, a link to a page). `false` when the page is unknown
+     *  or the host can't navigate: probe `supports("viewport.pages@1")`. */
+    goToPage(pageId: PageId, options?: {
+        fit?: "page" | "width";
+    }): Promise<boolean>;
+    /** v70 — the page the user is on: the one the viewport's centre is
+     *  over, else the nearest (the same page `host.document.meta()`
+     *  reports as `activePage`). `null` with no document or no host
+     *  backend. */
+    activePage(): PageId | null;
+    /** v70 — fires when the active page changes (scrolling, zooming,
+     *  `goToPage`, a page deleted under it). Never fires without a host
+     *  backend. */
+    onDidChangeActivePage(listener: (pageId: PageId | null) => void): Disposable;
+}
+/** v70 — what `host.render.snapshot` renders. */
+export interface RenderSnapshotOptions {
+    /** Width of the image in device pixels, 1 to 8192; the height follows
+     *  the page's aspect. The engine renders at a resolution derived from
+     *  it, so the image can be a pixel off: `RenderedPage.widthPx` is exact. */
+    widthPx: number;
+    /** Items to leave out of this image only (a build step whose shapes
+     *  have not appeared yet). The document is not changed and no undo
+     *  step is recorded. */
+    hideItems?: ElementId[];
+}
+/** v70 — one rendered page. */
+export interface RenderedPage {
+    pageId: PageId;
+    /** The image's own size, within a pixel of the requested width. */
+    widthPx: number;
+    heightPx: number;
+    /** PNG bytes; `createImageBitmap(new Blob([png]))` draws them. */
+    png: Uint8Array;
+    /** The engine's layout generation the image shows: an image with an
+     *  older generation than a page's current one is stale. */
+    layoutGeneration: number;
+}
+/**
+ * v70 — render a page to an image with the engine's own renderer (CPU),
+ * the same pixels the canvas shows: slide thumbnails, a slideshow's
+ * frames, a build step's frames. A READ: gated on
+ * `capabilities.document.read`. `supports("render.snapshot@1")`.
+ */
+export interface RenderSurface {
+    /** The page as a PNG, or `null` when the page is unknown or the
+     *  engine refused (an invalid width). */
+    snapshot(pageId: PageId, options: RenderSnapshotOptions): Promise<RenderedPage | null>;
 }
 /** Font advance + vertical metrics, in document points (pt). */
 export interface TextMetrics {
@@ -1660,6 +1709,9 @@ export interface BundleHost {
     readonly document: DocumentSurface;
     readonly selection: SelectionSurface;
     readonly viewport: ViewportSurface;
+    /** v70 — page images from the engine's renderer (thumbnails, slideshow
+     *  frames). `supports("render.snapshot@1")`; gated on document read. */
+    readonly render: RenderSurface;
     /** Font measurement against the document's fonts (S-13). A read door,
      *  no capability gate; `supports("text.measure@1")` reports whether the
      *  host wired the engine shaper (it is false under a host that injects

package/dist/index.d.ts

@@ -1,11 +1,11 @@
 export type { PluginId, PluginManifest, PluginCapabilities, PluginContributions, NetworkCapability, DataProvidersCapability, StorageCapability, WasmArtifact, WasmPurpose, WorkersCapability, SecretsCapability, DocumentsCapability, GpuCapability, } from "./manifest";
 export type { BundleHandle, PagedBundle } from "./bundle";
-export type { BundleHost, ContributionSurface, SceneLayerSurface, SceneLayerSubmitResult, SceneImage, SceneImageTile, SceneImageSubmitOptions, WillSaveEvent, ToolsSurface, ToolSettingValue, ImagesSurface, ImageResourceClaimOptions, TileBytes, WorkersSurface, BundleWorker, SpawnWorkerOptions, SecretsSurface, SecretMaterial, DocumentSurface, MutateWithBytesOptions, SelectionSurface, ViewportSurface, TextSurface, TextMetrics, TextCaret, FrameChainLink, PlanarFace, PlanarRegionsResult, StoryContent, ParagraphContent, RunContent, OverlaySurface, OverlayLayer, ShellSurface, FilePickerOptions, PickedFile, SaveFileOptions, StorageSurface, BlobSurface, BlobUsage, PartsSurface, NativeDocumentSurface, DocumentsSurface, OpenDocumentOptions, OpenDocumentResult, NetworkSurface, ConsentResult, DataProvidersSurface, DataProviderRegistration, DataProviderHandle, DataProviderInfo, DataProviderSnapshot, ProviderSchema, ProviderField, ProviderRecordSet, DiagnosticsSurface, JournalSurface, JournalRecord, BindingsSurface, Diagnostic, DocumentChangeEvent, DocumentOpenedEvent, MutationOutcome, Disposable, PluginLogger, EditContextContribution, ObjectTypeContribution, EditContextCandidate, EnteredEditContext, ContentPointerEvent, ContentWheelEvent, EditContextDescriptor, ObjectTypeDescriptor, PluginMetadataEnvelope, ObjectTypeBaker, BakeContext, MenuContribution, } from "./host";
+export type { BundleHost, ContributionSurface, SceneLayerSurface, SceneLayerSubmitResult, SceneImage, SceneImageTile, SceneImageSubmitOptions, WillSaveEvent, ToolsSurface, ToolSettingValue, ImagesSurface, ImageResourceClaimOptions, TileBytes, WorkersSurface, BundleWorker, SpawnWorkerOptions, SecretsSurface, SecretMaterial, DocumentSurface, MutateWithBytesOptions, SelectionSurface, ViewportSurface, RenderSurface, RenderSnapshotOptions, RenderedPage, TextSurface, TextMetrics, TextCaret, FrameChainLink, PlanarFace, PlanarRegionsResult, StoryContent, ParagraphContent, RunContent, OverlaySurface, OverlayLayer, ShellSurface, FilePickerOptions, PickedFile, SaveFileOptions, StorageSurface, BlobSurface, BlobUsage, PartsSurface, NativeDocumentSurface, DocumentsSurface, OpenDocumentOptions, OpenDocumentResult, NetworkSurface, ConsentResult, DataProvidersSurface, DataProviderRegistration, DataProviderHandle, DataProviderInfo, DataProviderSnapshot, ProviderSchema, ProviderField, ProviderRecordSet, DiagnosticsSurface, JournalSurface, JournalRecord, BindingsSurface, Diagnostic, DocumentChangeEvent, DocumentOpenedEvent, MutationOutcome, Disposable, PluginLogger, EditContextContribution, ObjectTypeContribution, EditContextCandidate, EnteredEditContext, ContentPointerEvent, ContentWheelEvent, EditContextDescriptor, ObjectTypeDescriptor, PluginMetadataEnvelope, ObjectTypeBaker, BakeContext, MenuContribution, } from "./host";
 export type { PanelSchema, PanelSchemaSection, PanelSchemaRow, SchemaPanelContribution, SchemaPanelRenderer, SchemaPanelRendererProps, WidgetValueBinding, BindingRef, SchemaGate, WidgetCollectionBinding, SchemaRowAction, SchemaListAction, SchemaListSpec, } from "./panel-schema";
 export type { WidgetSurface, ColorPickerProps, CodeEditorProps, CodeEditorDiagnostic, CodeEditorLanguage, } from "./widgets";
 export type { BindingTarget, BindingPropertyRequest, BindingPropertyWrite, BindingCollectionRequest, BindingRead, BindingResolved, BindingDecline, BindingWrite, BindingCollection, BindingOp, BindingProvider, BindingProviderScope, BindingProviderHandle, BindingReadResult, BindingWriteResult, BindingCollectionResult, ActiveBindingProvider, } from "./binding-provider";
 export type { AssetSurface, AssetKind, FontFaceAsset, FontFaceFormat, } from "./assets";
-export type { ProviderTileWire } from "./wire";
+export type { ProviderTileWire, SnapshotPng } from "./wire";
 export type { SnapPointQuery, SnapPointResult, SnapPointHit, SnapAxisHit, SnapSegmentHit, SnapExclude, SnapSource, SnapSettings, } from "./wire";
 export type { MintedElement } from "./wire";
 export type { ClipboardSurface, ClipboardPayload, TabularClipboard, } from "./clipboard";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paged-media/plugin-api",
-  "version": "0.2.42-canary.0",
+  "version": "0.2.43-canary.0",
   "description": "The Paged plugin contract: manifest, bundle lifecycle, the BundleHost surface, and the contribution + engine wire types. Type-only.",
   "license": "MPL-2.0 OR LicenseRef-PMEL",
   "type": "module",