@paged-media/plugin-api 0.2.52-canary.0 → 0.2.53-canary.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/wire.d.ts +42 -9
  2. package/package.json +1 -1
package/dist/wire.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  // GENERATED — do not edit. Vendored verbatim from the published
2
2
  // @paged-media/canvas-wasm .d.ts (tsify output from paged-media/core,
3
3
  // MPL-2.0 OR PMEL). Sync: node scripts/sync-wire.mjs · Check: --check.
4
- // Synced from @paged-media/canvas-wasm@0.71.7
4
+ // Synced from @paged-media/canvas-wasm@0.71.8
5
5
  /* tslint:disable */
6
6
  /* eslint-disable */
7
7
 
@@ -763,7 +763,9 @@ export interface HitResult {
763
763
  bounds?: [number, number, number, number] | null;
764
764
  /**
765
765
  * Phase A — composed affine `[a, b, c, d, tx, ty]` on the hit
766
- * element. `None` for items with no `ItemTransform`.
766
+ * element, into the hit page\'s space like `frame_bounds` (the
767
+ * page\'s origin inside its spread folded in). `None` for an item
768
+ * with no `ItemTransform` on a page at its spread\'s origin.
767
769
  */
768
770
  itemTransform?: [number, number, number, number, number, number] | null;
769
771
  /**
@@ -1139,8 +1141,9 @@ export type GestureHandle = number;
1139
1141
  /**
1140
1142
  * Oriented geometry for one selected element. `bounds` is the raw
1141
1143
  * `GeometricBounds` (content-box space); `item_transform` is the
1142
- * composed affine. The overlay layer multiplies bounds corners by
1143
- * the transform to draw the oriented selection chrome.
1144
+ * composed affine into the PAGE the element sits on (see
1145
+ * [`Self::item_transform`]). The overlay layer multiplies bounds
1146
+ * corners by the transform to draw the oriented selection chrome.
1144
1147
  */
1145
1148
  export interface ElementGeometryItem {
1146
1149
  id: ElementId;
@@ -1155,7 +1158,8 @@ export interface ElementGeometryItem {
1155
1158
  * grouped something it then could not read back.
1156
1159
  *
1157
1160
  * **The convention `None` carries:** `bounds` + `item_transform`
1158
- * compose against the SPREAD origin rather than a page origin.
1161
+ * compose against the SPREAD origin rather than a page origin (a
1162
+ * page-owned item composes against its page\'s).
1159
1163
  * `spread_id` names which spread, because without it the answer is
1160
1164
  * unusable the moment a document has two.
1161
1165
  *
@@ -1174,9 +1178,23 @@ export interface ElementGeometryItem {
1174
1178
  */
1175
1179
  bounds: [number, number, number, number];
1176
1180
  /**
1177
- * `[a, b, c, d, tx, ty]`.
1181
+ * `[a, b, c, d, tx, ty]`: `bounds` through it lands in the
1182
+ * coordinates of `page_id`\'s page, `(0, 0)` at its top-left — the
1183
+ * space of the hit test\'s `frameBounds`, carets, selection rects and
1184
+ * the inserts. It is the stored `ItemTransform` with the page\'s
1185
+ * origin inside its spread folded in ([`Self::page_origin`]); the two
1186
+ * differ wherever a page does not start at its spread\'s origin (a
1187
+ * verso, every page of an InDesign document). `moveFrame` takes it
1188
+ * back in the same space. A pageless item answers in spread space.
1178
1189
  */
1179
1190
  itemTransform?: [number, number, number, number, number, number] | null;
1191
+ /**
1192
+ * The page\'s origin inside its spread, `[x, y]` in spread
1193
+ * coordinates; `None` for a pageless item and a table cell. The
1194
+ * stored `ItemTransform` (what the `frameTransform` property reads
1195
+ * and writes) is `translate(page_origin) ∘ item_transform`. Additive.
1196
+ */
1197
+ pageOrigin?: [number, number];
1180
1198
  /**
1181
1199
  * Phase F — `true` when this element hosts a placed image
1182
1200
  * (`Rectangle` with `<Image>` / `<EPSImage>` / `<PDF>` /
@@ -1795,6 +1813,13 @@ export interface PageSummary {
1795
1813
  * 1-based index — what the user types in \"Go to page #\".
1796
1814
  */
1797
1815
  index: number;
1816
+ /**
1817
+ * The page\'s name as InDesign gives it: its folio, the label a
1818
+ * page-number marker on it prints (`\"3\"`, `\"iv\"`, `\"A-2\"`) — the
1819
+ * baked `Name` of a page InDesign wrote, else the number the section
1820
+ * rules give it where it stands. Never the page\'s id. Additive.
1821
+ */
1822
+ name?: string;
1798
1823
  /**
1799
1824
  * `[width, height]` in points.
1800
1825
  */
@@ -1898,8 +1923,10 @@ export interface LinkSummary {
1898
1923
  /**
1899
1924
  * SDK Phase 5 (v1 sweep) — one spread summary. Backs
1900
1925
  * `documentCollection:spreads`. `pageCount` is the number of
1901
- * `<Page>` children in the spread; `label` is the spread\'s
1902
- * `Self` id (or filename when missing).
1926
+ * `<Page>` children in the spread; `label` is what InDesign\'s Pages
1927
+ * panel shows for it, its pages\' folios (`\"3\"`, `\"2–3\"`, see
1928
+ * [`PageSummary::name`]) — the spread\'s `Self` id (or filename) only
1929
+ * when it has no built page.
1903
1930
  */
1904
1931
  export interface SpreadSummary {
1905
1932
  selfId: string;
@@ -2019,9 +2046,15 @@ export interface PathAnchorsResult {
2019
2046
  */
2020
2047
  subpathOpen?: boolean[];
2021
2048
  /**
2022
- * `[a, b, c, d, tx, ty]`. None ⇒ identity.
2049
+ * `[a, b, c, d, tx, ty]`. None ⇒ identity. Into the PAGE the path
2050
+ * sits on, the page\'s origin folded in, exactly as
2051
+ * [`ElementGeometryItem::item_transform`].
2023
2052
  */
2024
2053
  itemTransform?: [number, number, number, number, number, number] | null;
2054
+ /**
2055
+ * See [`ElementGeometryItem::page_origin`]. Additive.
2056
+ */
2057
+ pageOrigin?: [number, number];
2025
2058
  }
2026
2059
 
2027
2060
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@paged-media/plugin-api",
3
- "version": "0.2.52-canary.0",
3
+ "version": "0.2.53-canary.0",
4
4
  "description": "The Paged plugin contract: manifest, bundle lifecycle, the BundleHost surface, and the contribution + engine wire types. Type-only.",
5
5
  "license": "MPL-2.0 OR LicenseRef-PMEL",
6
6
  "type": "module",