@paged-media/sdk 0.62.0 → 0.64.0

package/package.json

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

package/paged_sdk.d.ts

@@ -5,6 +5,17 @@
  */
 export type ScenePathSeg = { op: "moveTo"; x: number; y: number } | { op: "lineTo"; x: number; y: number } | { op: "cubicTo"; cx1: number; cy1: number; cx2: number; cy2: number; x: number; y: number } | { op: "close" };
 
+/**
+ * A byte buffer that crosses the message channel. Wraps `Vec<u8>`
+ * so transferable-via-`postMessage` semantics are explicit at call
+ * sites; the wasm crate decides whether to clone or transfer based
+ * on whether the value is the JS-side `Uint8Array` or a Rust-side
+ * `Vec`. The wire form is whatever serde produces for `Vec<u8>` —
+ * JSON renders an array of numbers; future binary protocols (CBOR
+ * / messagepack) render a real bytes blob without code change.
+ */
+export type ByteBuf = number[];
+
 /**
  * A compositing blend mode for [`SceneItem::FillPathBlend`] (C-1.4).
  * Mirrors the CSS-relevant subset of the display list\'s
@@ -95,6 +106,29 @@ export interface PagesLayout {
     pages: PageRect[];
 }
 
+/**
+ * Element address the user can select OR a `SetElementProperty`
+ * mutation can target. The first six variants are page items
+ * (selection state holds these); `StoryRange` is the half-open
+ * character range that character / paragraph property writes
+ * address. Selection state today never holds `StoryRange` (the
+ * text-side caret + range live in `ContentSelection`); the
+ * variant exists so the apply layer can be reached via the
+ * existing `Mutation::SetElementProperty` wire shape — see
+ * `docs/paged/sdk-implementation-plan.md` §3c.1 ADR.
+ */
+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 } };
+
+/**
+ * How a `SetElementSelection` request combines with the current set.
+ * Mirrors the canonical macOS / industry convention:
+ * - `Replace` — plain click; selection becomes the request.
+ * - `Add` — Shift-click; union (already-selected ids stay).
+ * - `Toggle` — Cmd/Ctrl-click; ids already in the set are removed,
+ *   ids not in the set are added.
+ */
+export type SelectionMode = "replace" | "add" | "toggle";
+
 /**
  * One RGBA8 tile of a [`PixelLayer`]. `rgba` is tightly packed
  * (`width*height*4`, row-major); the tile is placed at the `(x, y)`
@@ -129,18 +163,6 @@ export interface SceneGradientStop {
  */
 export type SceneItem = { kind: "fillPath"; path: ScenePathSeg[]; paint: ScenePaint } | { kind: "strokePath"; path: ScenePathSeg[]; paint: ScenePaint; width: number } | ({ kind: "text" } & SceneTextItem) | { kind: "image"; rgba: number[]; width: number; height: number; x: number; y: number; w: number; h: number } | { kind: "fillPathGradient"; path: ScenePathSeg[]; gradient: SceneGradient } | { kind: "fillPathBlend"; path: ScenePathSeg[]; paint: ScenePaint; blend: SceneBlendMode } | { kind: "dropShadow"; path: ScenePathSeg[]; offset_x: number; offset_y: number; blur_radius: number; r: number; g: number; b: number; a: number } | { kind: "innerShadow"; path: ScenePathSeg[]; offset_x: number; offset_y: number; blur_radius: number; choke: number; r: number; g: number; b: number; a: number } | { kind: "strokePathGradient"; path: ScenePathSeg[]; gradient: SceneGradient; width: number } | { kind: "fillPathGradientBlend"; path: ScenePathSeg[]; gradient: SceneGradient; blend: SceneBlendMode };
 
-/**
- * Stable page identity, independent of position in the page vector.
- *
- * Derived from the IDML `<Page Self=\"...\">` attribute where present;
- * synthesised as `\"page-<spread_idx>-<local_idx>\"` when missing
- * (older / synthetic fixtures without `Self`). The canvas keys
- * display-list caches and LOD tiles by `PageId`, so the value must
- * stay stable across re-layouts — only document-structural edits
- * (insert/delete page) should ever change the set of `PageId`s.
- */
-export type PageId = string;
-
 /**
  * Structured, JSON-serialisable result of `load` / `render_*`. Unlike
  * the legacy free functions, recoverable parse/layout problems are
@@ -152,6 +174,60 @@ export interface Diagnostics {
     messages: Diagnostic[];
 }
 
+/**
+ * W1.13 — cell qualifier for a content address that points INTO a
+ * table cell rather than the story\'s main paragraph flow.
+ *
+ * ## The two-stream addressing model
+ *
+ * Table-cell text is stored out of band on `Table.cells[].paragraphs`
+ * (see `idml_import`), disjoint from `Story.paragraphs`. So a content
+ * address needs to say *which* paragraph stream its byte offsets index:
+ *
+ * - `ContentSelection.cell == None` — offsets are story-local bytes
+ *   over `story.paragraphs` (the body flow). Unchanged from before.
+ * - `ContentSelection.cell == Some(addr)` — offsets are CELL-LOCAL
+ *   bytes over `cell.paragraphs`, under the same story-offset contract
+ *   (run bytes + one synthetic `\\n` per inter-paragraph boundary,
+ *   counted within the cell). The owning story is still `story_id`;
+ *   `addr` picks the cell within that story\'s table.
+ *
+ * `table_id` / `row` / `col` are the SAME identifiers the hit-test
+ * surface emits (`HitResult.table_context` / `TableHitContext`) and
+ * that the renderer stamps onto cell `LineLayout`s
+ * (`paged_renderer::CellAddr`), so a hit that lands in a cell hands
+ * back exactly the qualifier the caret/edit address needs — no second
+ * query.
+ *
+ * ## Why a qualifier and not a re-numbered flat offset
+ *
+ * The alternative — fold cells into one flat story-offset space via a
+ * reserved high-bit/region scheme — was rejected: it makes
+ * `shift_for_insert`/`shift_for_delete`, undo inverse offsets, and the
+ * existing body-only consumers (BreakRecord, the A/B harness, every
+ * `RequestWordBounds`/`RequestLineBounds` caller) all have to learn the
+ * encoding, and a single arithmetic slip silently routes an edit into
+ * the wrong cell. The qualifier keeps body addressing byte-identical
+ * (the field defaults to `None` and is `#[serde(default)]`, so it
+ * rides v35 additively — old senders omit it) and makes \"which stream\
+ * an explicit, type-checked decision. Undo is trivially correct
+ * because the inverse op carries the same `cell` qualifier.
+ */
+export interface TextCellAddr {
+    /**
+     * `<Table Self=\"...\">` id within `story_id`.
+     */
+    tableId: string;
+    /**
+     * Template row (0-based); span-origin row for spanned cells.
+     */
+    row: number;
+    /**
+     * Column (0-based); span-origin column for spanned cells.
+     */
+    col: number;
+}
+
 export interface Diagnostic {
     /**
      * `\"error\" | \"warning\" | \"info\"`.
@@ -176,6 +252,8 @@ export interface PageRect {
     heightPt: number;
 }
 
+export type PageId = string;
+
 
 /**
  * Headless readback result. `rgba` is tightly-packed RGBA8
@@ -290,6 +368,7 @@ export interface InitOutput {
     readonly __wbg_set_renderedraster_rgba: (a: number, b: number, c: number) => void;
     readonly __wbg_set_renderedraster_width: (a: number, b: number) => void;
     readonly __wbg_viewersession_free: (a: number, b: number) => void;
+    readonly on_start: () => void;
     readonly viewersession_load: (a: number, b: number, c: number, d: number, e: number) => any;
     readonly viewersession_new: () => any;
     readonly viewersession_page_count: (a: number) => number;
@@ -302,7 +381,6 @@ export interface InitOutput {
     readonly viewersession_render_to_canvas_main: (a: number, b: any) => any;
     readonly viewersession_resize: (a: number, b: number, c: number, d: number) => void;
     readonly viewersession_set_page: (a: number, b: number) => void;
-    readonly on_start: () => void;
     readonly qcms_enable_iccv4: () => void;
     readonly qcms_profile_precache_output_transform: (a: number) => void;
     readonly qcms_transform_data_bgra_out_lut: (a: number, b: number, c: number, d: number) => void;
@@ -316,9 +394,9 @@ export interface InitOutput {
     readonly qcms_white_point_sRGB: (a: number) => void;
     readonly lut_inverse_interp16: (a: number, b: number, c: number) => number;
     readonly lut_interp_linear16: (a: number, b: number, c: number) => number;
-    readonly wasm_bindgen__convert__closures_____invoke__h0cde11723d429dba: (a: number, b: number, c: any) => [number, number];
-    readonly wasm_bindgen__convert__closures_____invoke__h59cb846e76c2acc2: (a: number, b: number, c: any, d: any) => void;
-    readonly wasm_bindgen__convert__closures_____invoke__h9534aa66f81a191a: (a: number, b: number, c: any) => void;
+    readonly wasm_bindgen__convert__closures_____invoke__h1697a25be679c0e2: (a: number, b: number, c: any, d: any) => void;
+    readonly wasm_bindgen__convert__closures_____invoke__h78ff2cea7266d1aa: (a: number, b: number, c: any) => [number, number];
+    readonly wasm_bindgen__convert__closures_____invoke__h6089e3893d556868: (a: number, b: number, c: any) => void;
     readonly __wbindgen_malloc: (a: number, b: number) => number;
     readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
     readonly __wbindgen_exn_store: (a: number) => void;