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

package/dist/index.d.ts

@@ -273,6 +273,18 @@ interface DocumentsBackend {
         };
     }): Promise<OpenDocumentResult>;
 }
+/**
+ * v70 — the backend the editor injects to back `host.viewport`'s page
+ * members. The editor owns the camera and the page layout, so it answers
+ * which page is active and moves the camera to one. No backend →
+ * `goToPage` answers false, `activePage` null, the event never fires and
+ * `supports("viewport.pages@1")` is false.
+ */
+interface PagesBackend {
+    goToPage(pageId: string, fit: "page" | "width"): boolean | Promise<boolean>;
+    activePage(): string | null;
+    onDidChangeActivePage(listener: (pageId: string | null) => void): () => void;
+}
 /** The SHARED cross-plugin data-provider registry (paged.data §7.1 / D-09). The
  *  editor creates ONE (`createDataProviderRegistry`) and injects the SAME
  *  instance into every plugin host, so a provider plugin and a consumer plugin
@@ -515,6 +527,10 @@ interface CreateBundleHostOptions {
      *  `supports("documents.exportPaged@1")` / `supports("documents.open@1")`
      *  answer true. When absent, both doors reject. */
     documents?: DocumentsBackend;
+    /** v70 — page navigation for `host.viewport` (`goToPage`,
+     *  `activePage`, `onDidChangeActivePage`). When present,
+     *  `supports("viewport.pages@1")` is true. */
+    pages?: PagesBackend;
     /** Host-provided WORKER backend (K-3 / S-07 / I-02). When present,
      *  `host.workers.spawn` resolves a declared bundle-relative module +
      *  constructs a host-owned `Worker` through it (capability-gated,
@@ -1021,4 +1037,4 @@ declare function contributeObjectType(host: BundleHost, contribution: ObjectType
  */
 declare function contributeBindingProvider(host: BundleHost, contextType: string, provider: BindingProvider): BindingProviderHandle;
 
-export { API_VERSION, ASSET_BUDGETS, BLOB_BUDGETS, type BindingProviderBackend, type BlobStore, type BundleAssetProvider, type BundleAssetSource, type BundleHostHandle, type BundleTrust, CANVAS_WASM_PKG, CLICK_DRAG_THRESHOLD_PX, type ClipboardBackend, type ConsentBackend, type CreateBundleHostOptions, type DataProviderBackend, type DiagnosticsSink, DisposableStore, type DocumentsBackend, FALLBACK_WIDGETS, HOST_FEATURES, type HarnessOptions, type HeadlessCanvasWorker, type HeadlessHost, type HeadlessHostHandle, type JournalSink, type LoadBundleWasmOptions, type LoadHeadlessEngineOptions, type LoadedBundle, type LoadedBundleWasm, type LoadedEngine, type NativeDocumentBackend, type PageDrag, PluginApiNotImplemented, PluginCapabilityError, type RecordableAssetSource, type RecordedContribution, type RecordedFontFaceRequest, type RegisteredBindingProvider, type SecretStoreBackend, type SeededFace, type ShellBackend, type SpawnedWorker, type StorageBacking, type TextCaretBackend, type ToolSettingsBackend, WASM_BUDGETS, WORKER_BUDGETS, type WillSaveBackend, type WorkerBackend, beginPageDrag, commitAndSelect, contributeBindingProvider, contributeEditContext, contributeObjectType, contributePanel, contributeSchemaPanel, contributeTool, createBindingProviderRegistry, createBundleHost, createDataProviderRegistry, createHeadlessHost, createRecordableAssetSource, defineBundle, endLocalFor, inMemoryToolSettings, inMemoryWillSave, loadBundle, loadBundleWasm, loadHeadlessEngine, makeSchemaPanelComponent, protocolFromVersion, pxToPt, readVendoredWireVersion, resolveCanvasWasm, resolveGate, satisfiesApiVersion, toDisposable };
+export { API_VERSION, ASSET_BUDGETS, BLOB_BUDGETS, type BindingProviderBackend, type BlobStore, type BundleAssetProvider, type BundleAssetSource, type BundleHostHandle, type BundleTrust, CANVAS_WASM_PKG, CLICK_DRAG_THRESHOLD_PX, type ClipboardBackend, type ConsentBackend, type CreateBundleHostOptions, type DataProviderBackend, type DiagnosticsSink, DisposableStore, type DocumentsBackend, FALLBACK_WIDGETS, HOST_FEATURES, type HarnessOptions, type HeadlessCanvasWorker, type HeadlessHost, type HeadlessHostHandle, type JournalSink, type LoadBundleWasmOptions, type LoadHeadlessEngineOptions, type LoadedBundle, type LoadedBundleWasm, type LoadedEngine, type NativeDocumentBackend, type PageDrag, type PagesBackend, PluginApiNotImplemented, PluginCapabilityError, type RecordableAssetSource, type RecordedContribution, type RecordedFontFaceRequest, type RegisteredBindingProvider, type SecretStoreBackend, type SeededFace, type ShellBackend, type SpawnedWorker, type StorageBacking, type TextCaretBackend, type ToolSettingsBackend, WASM_BUDGETS, WORKER_BUDGETS, type WillSaveBackend, type WorkerBackend, beginPageDrag, commitAndSelect, contributeBindingProvider, contributeEditContext, contributeObjectType, contributePanel, contributeSchemaPanel, contributeTool, createBindingProviderRegistry, createBundleHost, createDataProviderRegistry, createHeadlessHost, createRecordableAssetSource, defineBundle, endLocalFor, inMemoryToolSettings, inMemoryWillSave, loadBundle, loadBundleWasm, loadHeadlessEngine, makeSchemaPanelComponent, protocolFromVersion, pxToPt, readVendoredWireVersion, resolveCanvasWasm, resolveGate, satisfiesApiVersion, toDisposable };

package/dist/index.js

@@ -279,6 +279,10 @@ var HOST_FEATURES = [
   // door: the flag says this SDK forwards `snapPoint`; an engine older
   // than v67 answers the point unsnapped, never a throw.
   "document.snapPoint@1",
+  // v70 — page images from the engine's renderer (`requestSnapshot` with
+  // `hideItems`). Static like the snapper: the flag says this SDK
+  // forwards the query; an engine that refuses answers null.
+  "render.snapshot@1",
   // DOC-03 structured whole-story read (canvas-wasm v54). Static for the same
   // reason as storage.parts@1: the pinned engine is the server, and the worker
   // handshake refuses a protocol older than the pin — so a running bundle is
@@ -1520,6 +1524,7 @@ function createBundleHost(getEditor, manifest, options) {
       return store.add(toDisposable(off));
     }
   };
+  const pagesBackend = options?.pages;
   const viewport = {
     camera() {
       const cam = getEditor().camera.camera;
@@ -1528,6 +1533,53 @@ function createBundleHost(getEditor, manifest, options) {
     pxToPt(px) {
       const scale = getEditor().camera.camera.scale;
       return px / (scale > 0 ? scale : 1);
+    },
+    async goToPage(pageId, opts) {
+      if (!pagesBackend || typeof pageId !== "string" || pageId === "") {
+        return false;
+      }
+      const fit = opts?.fit === "width" ? "width" : "page";
+      return await pagesBackend.goToPage(pageId, fit) === true;
+    },
+    activePage() {
+      return pagesBackend ? pagesBackend.activePage() : null;
+    },
+    onDidChangeActivePage(listener) {
+      if (!pagesBackend) {
+        return toDisposable(() => {
+        });
+      }
+      return store.add(toDisposable(pagesBackend.onDidChangeActivePage(listener)));
+    }
+  };
+  const render = {
+    async snapshot(pageId, opts) {
+      requireDocRead("render.snapshot");
+      const widthPx = Math.round(opts?.widthPx ?? 0);
+      if (!(widthPx >= 1 && widthPx <= 8192)) {
+        throw new Error("host.render.snapshot: widthPx must be 1 to 8192");
+      }
+      const hideItems = Array.isArray(opts?.hideItems) ? opts.hideItems : [];
+      let reply;
+      try {
+        reply = await getEditor().client.send({
+          kind: "requestSnapshot",
+          payload: { pageId, targetWidthPx: widthPx, hideItems }
+        });
+      } catch {
+        return null;
+      }
+      if (reply.kind !== "snapshotReady") {
+        return null;
+      }
+      const p = reply.payload;
+      return {
+        pageId: p.pageId,
+        widthPx: p.widthPx,
+        heightPx: p.heightPx,
+        png: Uint8Array.from(p.pngBytes),
+        layoutGeneration: p.layoutGeneration
+      };
     }
   };
   const text = {
@@ -2577,6 +2629,9 @@ function createBundleHost(getEditor, manifest, options) {
     featureSet.add("document.readNative@1");
     featureSet.add("document.openNative@1");
   }
+  if (options?.pages) {
+    featureSet.add("viewport.pages@1");
+  }
   if (options?.documents) {
     featureSet.add("documents.exportPaged@1");
     featureSet.add("documents.open@1");
@@ -2597,6 +2652,7 @@ function createBundleHost(getEditor, manifest, options) {
     document,
     selection,
     viewport,
+    render,
     text,
     overlay,
     shell,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paged-media/plugin-sdk",
-  "version": "0.2.42-canary.0",
+  "version": "0.2.43-canary.0",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -11,7 +11,7 @@
     }
   },
   "dependencies": {
-    "@paged-media/plugin-api": "0.2.42-canary.0"
+    "@paged-media/plugin-api": "0.2.43-canary.0"
   },
   "peerDependencies": {
     "react": "^18.3.0"