@paged-media/plugin-sdk 0.2.48-canary.0 → 0.2.50-canary.0

package/dist/index.d.ts

@@ -446,6 +446,20 @@ interface PagesBackend {
     activePage(): string | null;
     onDidChangeActivePage(listener: (pageId: string | null) => void): () => void;
 }
+/**
+ * The backend the editor injects to back `host.viewport.revealText`. The
+ * editor owns the camera, the page layout and the text selection, so it
+ * locates the range on the page, moves there and (optionally) selects it.
+ * No backend → `revealText` answers false and
+ * `supports("viewport.revealText@1")` is false.
+ */
+interface TextRevealBackend {
+    revealText(range: {
+        storyId: string;
+        start: number;
+        end: number;
+    }, select: boolean): boolean | Promise<boolean>;
+}
 /** 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
@@ -704,6 +718,9 @@ interface CreateBundleHostOptions {
      *  `activePage`, `onDidChangeActivePage`). When present,
      *  `supports("viewport.pages@1")` is true. */
     pages?: PagesBackend;
+    /** Text navigation for `host.viewport.revealText`. When present,
+     *  `supports("viewport.revealText@1")` is true. */
+    text?: TextRevealBackend;
     /** 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,
@@ -1023,6 +1040,10 @@ interface HeadlessHost {
     /** Load an IDML package into the headless document. Resolves to the
      *  loaded page ids (or throws on a parse failure). */
     load(idml: Uint8Array): Promise<string[]>;
+    /** Start a new blank document: one page of the given size in points,
+     *  laid out with `defaultFont` when one was given. Resolves to its page
+     *  ids, fanned out to subscribers like `load`. */
+    newBlank(widthPt: number, heightPt: number): Promise<string[]>;
     /** ADR 324 — the core EXPORT door the Node CLI (and a conformance test)
      *  calls: the active document as `.paged` (`exportPaged`), `.idml`
      *  (`exportIdml`, `linkBase` for relative links) or PDF (the
@@ -1576,4 +1597,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, CORE_CATALOG_ROWS, CORE_COMMAND_CREATES, CORE_COMMAND_EXCLUSIONS, CORE_COMMAND_OPS, CORE_COMMAND_PREFIX, CORE_PATHS, CORE_PATH_ALIASES, CORE_WIRE_OPS, type ClipboardBackend, type ConsentBackend, type CoreCatalogRow, type CoreCreatePlan, type CoreObjects, type CorePathRow, type CorePathScope, type CorePlan, type CoreRow71, type CoreWireOpRow, type CreateBundleHostOptions, type CreateCoreObjectsOptions, type CreateObjectRegistryOptions, type DataProviderBackend, type DiagnosticsSink, DisposableStore, type DocumentsBackend, FALLBACK_WIDGETS, FRAME_KIND_WORDS, HOST_FEATURES, type HarnessOptions, type HeadlessCanvasWorker, type HeadlessHost, type HeadlessHostHandle, type HostObjectAnswer, type HostObjectCall, type JournalSink, type LoadBundleWasmOptions, type LoadHeadlessEngineOptions, type LoadedBundle, type LoadedBundleWasm, type LoadedEngine, type NativeDocumentBackend, OBJECT_MODEL_PROTOCOL, type ObjectListRow, type ObjectModelRegistration, type ObjectRegistry, type PageDrag, type PagesBackend, type PanelSchemaIssue, type ParsedSelector, PluginApiNotImplemented, PluginCapabilityError, type PropertyRowOptions, type PublishObjectListOptions, ROW_PATH, type RecordableAssetSource, type RecordedContribution, type RecordedFontFaceRequest, type RegisteredBindingProvider, type ScriptRunResult, type ScriptSend, type SecretStoreBackend, type SeededFace, type SelectorHead, type SelectorPredicate, type SelectorStep, type ShellBackend, type SpawnedWorker, type StorageBacking, type TextCaretBackend, type ToolSettingsBackend, VALUE_TYPE_KINDS, type ValidatePanelSchemaOptions, WASM_BUDGETS, WORKER_BUDGETS, type WillSaveBackend, type WorkerBackend, addressKindOf, answerHostObjects, answerHostObjectsRound, applyDefaults, applyValueEdit, assetFromBytes, beginPageDrag, checkSchemaRows, checkValueType, codeOfEngineError, coerceValue, commitAndSelect, contributeBindingProvider, contributeEditContext, contributeObjectType, contributePanel, contributeSchemaPanel, contributeTool, coreCommandInfos, coreSchema71, createBindingProviderRegistry, createBundleHost, createCoreObjects, createDataProviderRegistry, createHeadlessHost, createObjectRegistry, createRecordableAssetSource, defaultValueOf, defineBundle, editValue, endLocalFor, escapeLabelValue, findRow, formatAddress, fromElementId, inMemoryToolSettings, inMemoryWillSave, isCoreCommand, isPropertyRow, loadBundle, loadBundleWasm, loadHeadlessEngine, makeSchemaPanelComponent, normalizeAddress, normalizeCoreType, parseAddress, parseLength, parseSelector, planValueEdit, propertyRow, propertyRows, propertyRowsOf, protocolFromVersion, publishObjectList, pxToPt, readVendoredWireVersion, resolveCanvasWasm, resolveGate, rowPathOf, runScriptWithObjects, satisfiesApiVersion, selectorKind, toDisposable, toElementId, validatePanelSchema, validateValue };
+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, CORE_CATALOG_ROWS, CORE_COMMAND_CREATES, CORE_COMMAND_EXCLUSIONS, CORE_COMMAND_OPS, CORE_COMMAND_PREFIX, CORE_PATHS, CORE_PATH_ALIASES, CORE_WIRE_OPS, type ClipboardBackend, type ConsentBackend, type CoreCatalogRow, type CoreCreatePlan, type CoreObjects, type CorePathRow, type CorePathScope, type CorePlan, type CoreRow71, type CoreWireOpRow, type CreateBundleHostOptions, type CreateCoreObjectsOptions, type CreateObjectRegistryOptions, type DataProviderBackend, type DiagnosticsSink, DisposableStore, type DocumentsBackend, FALLBACK_WIDGETS, FRAME_KIND_WORDS, HOST_FEATURES, type HarnessOptions, type HeadlessCanvasWorker, type HeadlessHost, type HeadlessHostHandle, type HostObjectAnswer, type HostObjectCall, type JournalSink, type LoadBundleWasmOptions, type LoadHeadlessEngineOptions, type LoadedBundle, type LoadedBundleWasm, type LoadedEngine, type NativeDocumentBackend, OBJECT_MODEL_PROTOCOL, type ObjectListRow, type ObjectModelRegistration, type ObjectRegistry, type PageDrag, type PagesBackend, type PanelSchemaIssue, type ParsedSelector, PluginApiNotImplemented, PluginCapabilityError, type PropertyRowOptions, type PublishObjectListOptions, ROW_PATH, type RecordableAssetSource, type RecordedContribution, type RecordedFontFaceRequest, type RegisteredBindingProvider, type ScriptRunResult, type ScriptSend, type SecretStoreBackend, type SeededFace, type SelectorHead, type SelectorPredicate, type SelectorStep, type ShellBackend, type SpawnedWorker, type StorageBacking, type TextCaretBackend, type TextRevealBackend, type ToolSettingsBackend, VALUE_TYPE_KINDS, type ValidatePanelSchemaOptions, WASM_BUDGETS, WORKER_BUDGETS, type WillSaveBackend, type WorkerBackend, addressKindOf, answerHostObjects, answerHostObjectsRound, applyDefaults, applyValueEdit, assetFromBytes, beginPageDrag, checkSchemaRows, checkValueType, codeOfEngineError, coerceValue, commitAndSelect, contributeBindingProvider, contributeEditContext, contributeObjectType, contributePanel, contributeSchemaPanel, contributeTool, coreCommandInfos, coreSchema71, createBindingProviderRegistry, createBundleHost, createCoreObjects, createDataProviderRegistry, createHeadlessHost, createObjectRegistry, createRecordableAssetSource, defaultValueOf, defineBundle, editValue, endLocalFor, escapeLabelValue, findRow, formatAddress, fromElementId, inMemoryToolSettings, inMemoryWillSave, isCoreCommand, isPropertyRow, loadBundle, loadBundleWasm, loadHeadlessEngine, makeSchemaPanelComponent, normalizeAddress, normalizeCoreType, parseAddress, parseLength, parseSelector, planValueEdit, propertyRow, propertyRows, propertyRowsOf, protocolFromVersion, publishObjectList, pxToPt, readVendoredWireVersion, resolveCanvasWasm, resolveGate, rowPathOf, runScriptWithObjects, satisfiesApiVersion, selectorKind, toDisposable, toElementId, validatePanelSchema, validateValue };

package/dist/index.js

@@ -11717,6 +11717,23 @@ function createBundleHost(getEditor, manifest, options) {
         });
       }
       return store.add(toDisposable(pagesBackend.onDidChangeActivePage(listener)));
+    },
+    async revealText(range, opts) {
+      const textBackend = options?.text;
+      if (!textBackend || !range || typeof range.storyId !== "string" || range.storyId === "") {
+        return false;
+      }
+      const start = Math.trunc(Number(range.start));
+      const end = Math.trunc(Number(range.end));
+      if (!Number.isFinite(start) || !Number.isFinite(end) || start < 0 || end < start) {
+        return false;
+      }
+      const select = opts?.select !== false;
+      try {
+        return await textBackend.revealText({ storyId: range.storyId, start, end }, select) === true;
+      } catch {
+        return false;
+      }
     }
   };
   const render = {
@@ -12803,6 +12820,9 @@ function createBundleHost(getEditor, manifest, options) {
   if (options?.pages) {
     featureSet.add("viewport.pages@1");
   }
+  if (options?.text) {
+    featureSet.add("viewport.revealText@1");
+  }
   if (options?.documents) {
     featureSet.add("documents.exportPaged@1");
     featureSet.add("documents.open@1");
@@ -13668,6 +13688,18 @@ async function createHeadlessHost(options = {}) {
       }
       throw loadFailure(reply);
     },
+    async newBlank(widthPt, heightPt) {
+      const reply = await editor.client.send({
+        kind: "newBlankDocument",
+        payload: { widthPt, heightPt, font: options.defaultFont ? Array.from(options.defaultFont) : null }
+      });
+      if (reply.kind === "documentLoaded") {
+        objects.core?.invalidate();
+        fanOut(reply);
+        return reply.payload.pageIds;
+      }
+      throw loadFailure(reply);
+    },
     async exportDocument(format, exportOptions = {}) {
       const send = (kind, payload) => editor.client.send({ kind, payload });
       if (format === "paged") {

package/package.json

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