@paged-media/sdk 0.70.1 → 0.71.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paged-media/sdk",
-  "version": "0.70.1",
+  "version": "0.71.0",
   "type": "module",
   "main": "paged_sdk.js",
   "types": "paged_sdk.d.ts",

package/paged_sdk.d.ts

@@ -26,6 +26,18 @@ export type ByteBuf = number[];
  */
 export type SceneBlendMode = "multiply" | "screen" | "overlay" | "darken" | "lighten" | "colorDodge" | "colorBurn" | "hardLight" | "softLight" | "difference" | "exclusion" | "hue" | "saturation" | "color" | "luminosity";
 
+/**
+ * A malformed address or selector, with the byte offset the problem
+ * starts at — user input, so an answer, never a panic.
+ */
+export interface GrammarError {
+    /**
+     * Byte offset into the input.
+     */
+    position: number;
+    message: string;
+}
+
 /**
  * A plugin gradient paint for [`SceneItem::FillPathGradient`] (C-1.3).
  * Coordinates are frame-content points (mapped by the frame transform
@@ -114,6 +126,32 @@ export interface ScenePaint {
     a: number;
 }
 
+/**
+ * A style family — which of the document\'s five style tables a
+ * `style:` address names.
+ */
+export type StyleFamily = "paragraph" | "character" | "object" | "cell" | "table";
+
+/**
+ * ADR 132 — the RESOLVED target of a `Mutation::Set` / a property
+ * read: every object kind a property can live on, named by the ids the
+ * dedicated operations take.
+ *
+ * The wire names a target by [`Address`] (ADR 131); the engine resolves
+ * that against the document into this enum ([`query::Index::to_virtual_target`],
+ * total over every core address kind) — `frame:` finds its kind,
+ * `page:#n` its page id, a style\'s display name its `Self`, and a
+ * `table:`/`cell:` the story that owns the table. `Element` carries the
+ * six page-item kinds plus `storyRange:` through the existing `ElementId`.
+ *
+ * This enum\'s JSON (`{ \"kind\": \"layer\", \"layerId\": \"ua\" }`) was the
+ * `Set` target at protocol 70 before addresses landed; it is still
+ * accepted in that position as a DEPRECATED alias (see
+ * [`From<VirtualTarget> for Address`](Address)). The id fields are spelled
+ * `…Id` so batch handle substitution (`$h:`) reaches them.
+ */
+export type VirtualTarget = { kind: "doc" } | { kind: "page"; pageId: string } | { kind: "layer"; layerId: string } | { kind: "master"; masterId: string } | { kind: "story"; storyId: string } | { kind: "field"; storyId: string; offset: number } | { kind: "swatch"; swatchId: string } | { kind: "gradient"; gradientId: string } | { kind: "colorGroup"; groupId: string } | { kind: "numberingList"; listId: string } | { kind: "style"; family: StyleFamily; styleId: string } | { kind: "section"; sectionId: string } | { kind: "guide"; guideId: string } | { kind: "condition"; conditionId: string } | { kind: "textVariable"; variableId: string } | { kind: "spread"; spreadId: string } | { kind: "conditionSet"; setId: string } | { kind: "hyperlink"; hyperlinkId: string } | { kind: "table"; storyId: string; tableId: string } | { kind: "cell"; storyId: string; tableId: string; row: number; col: number } | { kind: "element"; elementId: ElementId };
+
 /**
  * Continuous-layout geometry for every page, so the TS wrapper
  * computes fit / goToPage / currentPage / scroll extents without
@@ -139,6 +177,13 @@ export interface PagesLayout {
  */
 export type ElementId = { kind: "textFrame"; id: string } | { kind: "rectangle"; id: string } | { kind: "oval"; id: string } | { kind: "polygon"; id: string } | { kind: "graphicLine"; id: string } | { kind: "group"; id: string } | { kind: "storyRange"; id: { story_id: string; start: number; end: number } } | { kind: "table"; id: { story_id: string; table_id: string } } | { kind: "tableCell"; id: { story_id: string; table_id: string; row: number; col: number } };
 
+/**
+ * Every object in a document, by one name. See the module docs for the
+ * string grammar, which is the canonical form; this enum is its typed
+ * mirror on the wire.
+ */
+export type Address = { kind: "doc" } | { kind: "textFrame"; id: string } | { kind: "rectangle"; id: string } | { kind: "oval"; id: string } | { kind: "polygon"; id: string } | { kind: "graphicLine"; id: string } | { kind: "group"; id: string } | { kind: "frame"; id: string } | { kind: "page"; id: string } | { kind: "pageNumber"; n: number } | { kind: "spread"; id: string } | { kind: "layer"; id: string } | { kind: "master"; id: string } | { kind: "story"; id: string } | { kind: "storyRange"; storyId: string; start: number; end: number } | { kind: "field"; storyId: string; offset: number } | { kind: "table"; id: string } | { kind: "cell"; tableId: string; row: number; col: number } | { kind: "style"; family: StyleFamily; id: string } | { kind: "swatch"; id: string } | { kind: "gradient"; id: string } | { kind: "colorGroup"; id: string } | { kind: "numberingList"; id: string } | { kind: "guide"; id: string } | { kind: "condition"; id: string } | { kind: "conditionSet"; id: string } | { kind: "section"; id: string } | { kind: "hyperlink"; id: string } | { kind: "textVariable"; id: string } | { kind: "onMaster"; master: string; item: Address } | { kind: "plugin"; pluginId: string; objectKind: string; id: string } | { kind: "handle"; name: string };
+
 /**
  * How a `SetElementSelection` request combines with the current set.
  * Mirrors the canonical macOS / industry convention:
@@ -194,6 +239,13 @@ export interface Diagnostics {
     messages: Diagnostic[];
 }
 
+/**
+ * The kind of an [`Address`], without its payload — what a selector\'s
+ * kind step names, and the key the published id grammar is generated
+ * from.
+ */
+export type AddressKind = "doc" | "textFrame" | "rectangle" | "oval" | "polygon" | "graphicLine" | "group" | "frame" | "page" | "spread" | "layer" | "master" | "story" | "storyRange" | "field" | "table" | "cell" | "style" | "swatch" | "gradient" | "colorGroup" | "numberingList" | "guide" | "condition" | "conditionSet" | "section" | "hyperlink" | "textVariable" | "plugin" | "handle";
+
 /**
  * W1.13 — cell qualifier for a content address that points INTO a
  * table cell rather than the story\'s main paragraph flow.

package/paged_sdk.js

@@ -1351,7 +1351,7 @@ function __wbg_get_imports() {
             arg0.writeTexture(arg1, getArrayU8FromWasm0(arg2, arg3), arg4, arg5);
         }, arguments); },
         __wbindgen_generic_0000000000000001: function(arg0, arg1) {
-            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 1827, ret: Result(Unit), inner_ret: Some(Result(Unit)) }, mutable: true }) -> Externref`.
+            // Cast intrinsic for `Closure(Closure { owned: true, function: Function { arguments: [Externref], shim_idx: 1825, ret: Result(Unit), inner_ret: Some(Result(Unit)) }, mutable: true }) -> Externref`.
             const ret = makeMutClosure(arg0, arg1, wasm_bindgen__convert__closures_____invoke__h78ff2cea7266d1aa);
             return ret;
         },