@snaptrude/plugin-core 0.10.0 → 1.0.0

package/dist/api/presentation/annotate.d.ts

@@ -32,14 +32,15 @@ export declare abstract class PluginPresentationAnnotateApi {
      * falls back to regular. `fontSizePx` sets an exact pixel size, overriding
      * the `size` preset when both are given (`size` alone keeps working).
      *
-     * @param sheetId - The sheet to annotate.
+     * @param sheetId - The sheet to annotate, or `undefined` when `options.drawingId` is used.
      * @param text - The label text.
      * @param options - Optional `position` (`{ x, y }`, relative to the sheet's
      *   top-left, in canvas units — defaults to the sheet's top-left corner),
      *   `size` (`"s" | "m" | "l" | "xl"`, default `"m"`), `color` (a named
      *   palette color, default `"black"`), and typography: `fontFamily`,
      *   `fontWeight` (numeric string, `-italic` suffix allowed), `fontSizePx`
-     *   (positive px size overriding the `size` preset).
+     *   (positive px size overriding the `size` preset), and `drawingId` to parent
+     *   the annotation to a drawing. Pass exactly one parent: `sheetId` or `drawingId`.
      * @returns A {@linkcode PluginPresentationAnnotateTextResult} with the created
      *   `shapeId`.
      * @throws If Present mode is not open or the sheet id is invalid.
@@ -58,7 +59,7 @@ export declare abstract class PluginPresentationAnnotateApi {
      * )
      * ```
      */
-    abstract text(sheetId: string, text: string, options?: {
+    abstract text(sheetId: string | undefined, text: string, options?: {
         position?: {
             x: number;
             y: number;
@@ -68,6 +69,7 @@ export declare abstract class PluginPresentationAnnotateApi {
         fontFamily?: string;
         fontWeight?: string;
         fontSizePx?: number;
+        drawingId?: string;
     }): PluginApiReturn<PluginPresentationAnnotateTextResult>;
     /**
      * Draw an arrow on a sheet.
@@ -76,11 +78,12 @@ export declare abstract class PluginPresentationAnnotateApi {
      * top-left, in canvas units — the same Arrow tool as the Present toolbar) and
      * returns the id of the created canvas shape. Requires Present mode to be open.
      *
-     * @param sheetId - The sheet to annotate.
+     * @param sheetId - The sheet to annotate, or `undefined` when `options.drawingId` is used.
      * @param start - Arrow tail position (`{ x, y }`, relative to the sheet's top-left).
      * @param end - Arrow head position (`{ x, y }`, relative to the sheet's top-left).
      * @param options - Optional `color` (a named palette color, default `"black"`)
-     *   and `size` (stroke weight preset, `"s" | "m" | "l" | "xl"`, default `"m"`).
+     *   `size` (stroke weight preset, `"s" | "m" | "l" | "xl"`, default `"m"`),
+     *   and `drawingId` to parent the arrow to a drawing. Pass exactly one parent.
      * @returns A {@linkcode PluginPresentationAnnotateResult} with the created
      *   `shapeId`.
      * @throws If Present mode is not open or the sheet id is invalid.
@@ -99,7 +102,7 @@ export declare abstract class PluginPresentationAnnotateApi {
      * )
      * ```
      */
-    abstract arrow(sheetId: string, start: {
+    abstract arrow(sheetId: string | undefined, start: {
         x: number;
         y: number;
     }, end: {
@@ -108,6 +111,7 @@ export declare abstract class PluginPresentationAnnotateApi {
     }, options?: {
         color?: PluginAnnotateTextColor;
         size?: PluginAnnotateTextSize;
+        drawingId?: string;
     }): PluginApiReturn<PluginPresentationAnnotateResult>;
     /**
      * Add a sticky note to a sheet.
@@ -116,13 +120,14 @@ export declare abstract class PluginPresentationAnnotateApi {
      * fixed-size sticky square that grows with its text) and returns the id of
      * the created canvas shape. Requires Present mode to be open.
      *
-     * @param sheetId - The sheet to annotate.
+     * @param sheetId - The sheet to annotate, or `undefined` when `options.drawingId` is used.
      * @param text - The note text.
      * @param options - Optional `position` (`{ x, y }`, relative to the sheet's
      *   top-left, in canvas units — defaults to the sheet's top-left corner),
      *   `color` (a named palette color, default `"black"` — rendered as the
      *   note's sticky fill), and `size` (text size preset,
-     *   `"s" | "m" | "l" | "xl"`, default `"m"`).
+     *   `"s" | "m" | "l" | "xl"`, default `"m"`), and `drawingId` to parent
+     *   the note to a drawing. Pass exactly one parent.
      * @returns A {@linkcode PluginPresentationAnnotateResult} with the created
      *   `shapeId`.
      * @throws If Present mode is not open or the sheet id is invalid.
@@ -140,13 +145,14 @@ export declare abstract class PluginPresentationAnnotateApi {
      * )
      * ```
      */
-    abstract note(sheetId: string, text: string, options?: {
+    abstract note(sheetId: string | undefined, text: string, options?: {
         position?: {
             x: number;
             y: number;
         };
         color?: PluginAnnotateTextColor;
         size?: PluginAnnotateTextSize;
+        drawingId?: string;
     }): PluginApiReturn<PluginPresentationAnnotateResult>;
     /**
      * Draw a geo shape (rectangle, ellipse, cloud, …) on a sheet.
@@ -156,14 +162,15 @@ export declare abstract class PluginPresentationAnnotateApi {
      * top-left, in canvas units) and returns the id of the created canvas shape.
      * Requires Present mode to be open.
      *
-     * @param sheetId - The sheet to annotate.
+     * @param sheetId - The sheet to annotate, or `undefined` when `options.drawingId` is used.
      * @param kind - The shape kind ({@linkcode PluginAnnotateGeoKind}), e.g.
      *   `"rectangle"`, `"ellipse"`, `"cloud"`.
      * @param bounds - Placement box `{ x, y, w, h }` — `x`/`y` are the shape's
      *   top-left relative to the sheet's top-left; `w`/`h` must be positive.
      * @param options - Optional `color` (a named palette color, default
      *   `"black"`) and `fill` ({@linkcode PluginAnnotateFill}, default `"none"` —
-     *   outline only).
+     *   outline only), and `drawingId` to parent the shape to a drawing. Pass
+     *   exactly one parent: `sheetId` or `drawingId`.
      * @returns A {@linkcode PluginPresentationAnnotateResult} with the created
      *   `shapeId`.
      * @throws If Present mode is not open or the sheet id is invalid.
@@ -182,7 +189,7 @@ export declare abstract class PluginPresentationAnnotateApi {
      * )
      * ```
      */
-    abstract shape(sheetId: string, kind: PluginAnnotateGeoKind, bounds: {
+    abstract shape(sheetId: string | undefined, kind: PluginAnnotateGeoKind, bounds: {
         x: number;
         y: number;
         w: number;
@@ -190,6 +197,7 @@ export declare abstract class PluginPresentationAnnotateApi {
     }, options?: {
         color?: PluginAnnotateTextColor;
         fill?: PluginAnnotateFill;
+        drawingId?: string;
     }): PluginApiReturn<PluginPresentationAnnotateResult>;
 }
 /** Text size preset (the same s/m/l/xl scale as the Present-mode text tool). */
@@ -222,7 +230,8 @@ export type PluginAnnotateTextColor = z.infer<typeof PluginAnnotateTextColor>;
  *
  * | Property | Type | Description |
  * |---|---|---|
- * | `sheetId` | `string` | The sheet to annotate |
+ * | `sheetId` | `string \| undefined` | The sheet parent; omit when `drawingId` is set |
+ * | `drawingId` | `string \| undefined` | The drawing parent; mutually exclusive with `sheetId` |
  * | `text` | `string` | The label text |
  * | `position` | `{ x: number; y: number } \| undefined` | Where to place it (relative to the sheet) |
  * | `size` | {@linkcode PluginAnnotateTextSize}` \| undefined` | Text size preset |
@@ -232,7 +241,8 @@ export type PluginAnnotateTextColor = z.infer<typeof PluginAnnotateTextColor>;
  * | `fontSizePx` | `number \| undefined` | Exact px size (overrides the `size` preset) |
  */
 export declare const PluginPresentationAnnotateTextArgs: z.ZodObject<{
-    sheetId: z.ZodString;
+    sheetId: z.ZodOptional<z.ZodString>;
+    drawingId: z.ZodOptional<z.ZodString>;
     text: z.ZodString;
     position: z.ZodOptional<z.ZodObject<{
         x: z.ZodNumber;
@@ -280,11 +290,11 @@ export type PluginPresentationAnnotateTextResult = z.infer<typeof PluginPresenta
  * flyout.
  */
 export declare const PluginAnnotateGeoKind: z.ZodEnum<{
+    hexagon: "hexagon";
     rectangle: "rectangle";
     ellipse: "ellipse";
     triangle: "triangle";
     diamond: "diamond";
-    hexagon: "hexagon";
     oval: "oval";
     rhombus: "rhombus";
     star: "star";
@@ -311,14 +321,16 @@ export type PluginAnnotateFill = z.infer<typeof PluginAnnotateFill>;
  *
  * | Property | Type | Description |
  * |---|---|---|
- * | `sheetId` | `string` | The sheet to annotate |
+ * | `sheetId` | `string \| undefined` | The sheet parent; omit when `drawingId` is set |
+ * | `drawingId` | `string \| undefined` | The drawing parent; mutually exclusive with `sheetId` |
  * | `start` | `{ x: number; y: number }` | Arrow tail (relative to the sheet) |
  * | `end` | `{ x: number; y: number }` | Arrow head (relative to the sheet) |
  * | `color` | {@linkcode PluginAnnotateTextColor}` \| undefined` | Arrow color |
  * | `size` | {@linkcode PluginAnnotateTextSize}` \| undefined` | Stroke weight preset |
  */
 export declare const PluginPresentationAnnotateArrowArgs: z.ZodObject<{
-    sheetId: z.ZodString;
+    sheetId: z.ZodOptional<z.ZodString>;
+    drawingId: z.ZodOptional<z.ZodString>;
     start: z.ZodObject<{
         x: z.ZodNumber;
         y: z.ZodNumber;
@@ -355,14 +367,16 @@ export type PluginPresentationAnnotateArrowArgs = z.infer<typeof PluginPresentat
  *
  * | Property | Type | Description |
  * |---|---|---|
- * | `sheetId` | `string` | The sheet to annotate |
+ * | `sheetId` | `string \| undefined` | The sheet parent; omit when `drawingId` is set |
+ * | `drawingId` | `string \| undefined` | The drawing parent; mutually exclusive with `sheetId` |
  * | `text` | `string` | The note text |
  * | `position` | `{ x: number; y: number } \| undefined` | Where to place it (relative to the sheet) |
  * | `color` | {@linkcode PluginAnnotateTextColor}` \| undefined` | Sticky fill color |
  * | `size` | {@linkcode PluginAnnotateTextSize}` \| undefined` | Text size preset |
  */
 export declare const PluginPresentationAnnotateNoteArgs: z.ZodObject<{
-    sheetId: z.ZodString;
+    sheetId: z.ZodOptional<z.ZodString>;
+    drawingId: z.ZodOptional<z.ZodString>;
     text: z.ZodString;
     position: z.ZodOptional<z.ZodObject<{
         x: z.ZodNumber;
@@ -396,20 +410,22 @@ export type PluginPresentationAnnotateNoteArgs = z.infer<typeof PluginPresentati
  *
  * | Property | Type | Description |
  * |---|---|---|
- * | `sheetId` | `string` | The sheet to annotate |
+ * | `sheetId` | `string \| undefined` | The sheet parent; omit when `drawingId` is set |
+ * | `drawingId` | `string \| undefined` | The drawing parent; mutually exclusive with `sheetId` |
  * | `kind` | {@linkcode PluginAnnotateGeoKind} | The shape kind |
  * | `bounds` | `{ x: number; y: number; w: number; h: number }` | Placement box (relative to the sheet; `w`/`h` positive) |
  * | `color` | {@linkcode PluginAnnotateTextColor}` \| undefined` | Outline color |
  * | `fill` | {@linkcode PluginAnnotateFill}` \| undefined` | Fill style |
  */
 export declare const PluginPresentationAnnotateShapeArgs: z.ZodObject<{
-    sheetId: z.ZodString;
+    sheetId: z.ZodOptional<z.ZodString>;
+    drawingId: z.ZodOptional<z.ZodString>;
     kind: z.ZodEnum<{
+        hexagon: "hexagon";
         rectangle: "rectangle";
         ellipse: "ellipse";
         triangle: "triangle";
         diamond: "diamond";
-        hexagon: "hexagon";
         oval: "oval";
         rhombus: "rhombus";
         star: "star";

package/dist/api/presentation/annotate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"annotate.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/annotate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;;;;;;;GAeG;AACH,8BAAsB,6BAA6B;;IAGjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;aACa,IAAI,CAClB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;QACnC,IAAI,CAAC,EAAE,sBAAsB,CAAA;QAC7B,KAAK,CAAC,EAAE,uBAAuB,CAAA;QAC/B,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,UAAU,CAAC,EAAE,MAAM,CAAA;KACpB,GACA,eAAe,CAAC,oCAAoC,CAAC;IAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;aACa,KAAK,CACnB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,EAC/B,GAAG,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,EAC7B,OAAO,CAAC,EAAE;QACR,KAAK,CAAC,EAAE,uBAAuB,CAAA;QAC/B,IAAI,CAAC,EAAE,sBAAsB,CAAA;KAC9B,GACA,eAAe,CAAC,gCAAgC,CAAC;IAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;aACa,IAAI,CAClB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;QACnC,KAAK,CAAC,EAAE,uBAAuB,CAAA;QAC/B,IAAI,CAAC,EAAE,sBAAsB,CAAA;KAC9B,GACA,eAAe,CAAC,gCAAgC,CAAC;IAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;aACa,KAAK,CACnB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,qBAAqB,EAC3B,MAAM,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,EACtD,OAAO,CAAC,EAAE;QACR,KAAK,CAAC,EAAE,uBAAuB,CAAA;QAC/B,IAAI,CAAC,EAAE,kBAAkB,CAAA;KAC1B,GACA,eAAe,CAAC,gCAAgC,CAAC;CACrD;AAED,gFAAgF;AAChF,eAAO,MAAM,sBAAsB;;;;;EAAgC,CAAA;AACnE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E,+EAA+E;AAC/E,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;EAclC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAe7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;EAiBhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE,kFAAkF;AAClF,eAAO,MAAM,kBAAkB;;;;;EAA+C,CAAA;AAC9E,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAM9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAM7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAW9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,gCAAgC;;iBAE3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA"}
+{"version":3,"file":"annotate.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/annotate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;;;;;;;GAeG;AACH,8BAAsB,6BAA6B;;IAGjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;aACa,IAAI,CAClB,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;QACnC,IAAI,CAAC,EAAE,sBAAsB,CAAA;QAC7B,KAAK,CAAC,EAAE,uBAAuB,CAAA;QAC/B,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,GACA,eAAe,CAAC,oCAAoC,CAAC;IAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;aACa,KAAK,CACnB,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,KAAK,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,EAC/B,GAAG,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,EAC7B,OAAO,CAAC,EAAE;QACR,KAAK,CAAC,EAAE,uBAAuB,CAAA;QAC/B,IAAI,CAAC,EAAE,sBAAsB,CAAA;QAC7B,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,GACA,eAAe,CAAC,gCAAgC,CAAC;IAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;aACa,IAAI,CAClB,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;QACnC,KAAK,CAAC,EAAE,uBAAuB,CAAA;QAC/B,IAAI,CAAC,EAAE,sBAAsB,CAAA;QAC7B,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,GACA,eAAe,CAAC,gCAAgC,CAAC;IAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;aACa,KAAK,CACnB,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,IAAI,EAAE,qBAAqB,EAC3B,MAAM,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,EACtD,OAAO,CAAC,EAAE;QACR,KAAK,CAAC,EAAE,uBAAuB,CAAA;QAC/B,IAAI,CAAC,EAAE,kBAAkB,CAAA;QACzB,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,GACA,eAAe,CAAC,gCAAgC,CAAC;CACrD;AAED,gFAAgF;AAChF,eAAO,MAAM,sBAAsB;;;;;EAAgC,CAAA;AACnE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E,+EAA+E;AAC/E,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;EAclC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoB3C,CAAA;AACJ,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;EAiBhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE,kFAAkF;AAClF,eAAO,MAAM,kBAAkB;;;;;EAA+C,CAAA;AAC9E,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAW5C,CAAA;AACJ,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAW3C,CAAA;AACJ,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAgB5C,CAAA;AACJ,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,gCAAgC;;iBAE3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA"}

package/dist/api/presentation/camera.d.ts

@@ -0,0 +1,265 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../types";
+import { PluginPresentationImageFormat } from "./views";
+/**
+ * The Present-mode canvas camera — the Present-mode twin of
+ * {@linkcode PluginCameraApi} (`core.camera`).
+ *
+ * Present mode lays sheets out on an infinite 2D canvas; its camera is a pan
+ * (`x`, `y`) and a `zoom`. A plugin can screenshot what that canvas currently
+ * shows, read the camera, pan/zoom it, or frame all sheets or one shape.
+ *
+ * These are transient VIEW-STATE changes: not model edits, so they are not
+ * write-gated and not undoable. Every method requires **Present mode to be
+ * open** (the documentation editor) and throws `PRECONDITION_FAILED` when it is
+ * closed. `capture` is the Present-mode counterpart of
+ * {@linkcode PluginPresentationViewsApi.capture}, which shoots the Design
+ * (3D) canvas; for whole sheets at their own size use
+ * {@linkcode PluginPresentationApi.export}.
+ *
+ * Coordinates are Present canvas page units (pixels at 100% zoom), the same
+ * space `sheets`, `placedViews` and `shapes` report positions in. `zoom` is a
+ * factor: `1` = 100%, `0.5` = zoomed out to half size.
+ *
+ * Accessed via `snaptrude.presentation.camera`.
+ */
+export declare abstract class PluginPresentationCameraApi {
+    constructor();
+    /**
+     * Screenshot what the Present canvas currently shows.
+     *
+     * Captures exactly the visible area — the canvas as clipped by the window,
+     * minus the strip under the floating left sidebar — at the current pan and
+     * zoom, rendered
+     * through the same pipeline as the Present-mode Export dialog, so sheets,
+     * placed views, text, annotations and imported images look as they do on
+     * screen. Selection handles, cursors and the UI itself are not part of the
+     * image. Nothing on screen still yields an image (the export backdrop).
+     * Export-pipeline details, as in the Export dialog: sheet frames themselves
+     * are not drawn (no paper, margin guides or name label — editor chrome), the
+     * backdrop is tldraw's near-white export backdrop rather than the on-screen
+     * canvas grey, and with exactly one sheet in view it is white. Only the left
+     * sidebar is subtracted from the view; floating right-hand panels are not.
+     *
+     * @param options - All optional: `format` (`"png"` default, or `"jpeg"`),
+     *   `pixelRatio` (output pixels per screen pixel, `1`–`4`, default `1`;
+     *   `2` for a retina-sharp image).
+     * @returns A {@linkcode PluginPresentationCameraCaptureResult}: the base64
+     *   data URL and its pixel size.
+     * @throws If Present mode is not open.
+     *
+     * @examplePrompt Take a screenshot of the Present canvas
+     * @examplePrompt Capture what I am looking at in Present mode
+     * @examplePrompt Screenshot the presentation canvas as a JPEG
+     * @examplePrompt Grab a high-res image of the current sheet view
+     *
+     * # Example
+     * ```ts
+     * const { image, width, height } = await snaptrude.presentation.camera.capture({
+     *   format: "png",
+     *   pixelRatio: 2,
+     * })
+     * ```
+     */
+    abstract capture(options?: {
+        format?: PluginPresentationImageFormat;
+        pixelRatio?: number;
+    }): PluginApiReturn<PluginPresentationCameraCaptureResult>;
+    /**
+     * Read the Present camera: pan, zoom, the visible page-space rectangle and
+     * the sheet under the centre of the view.
+     *
+     * @returns The current {@linkcode PluginPresentationCameraState}.
+     * @throws If Present mode is not open.
+     *
+     * @examplePrompt Where is the Present canvas camera?
+     * @examplePrompt What zoom level is Present mode at?
+     * @examplePrompt Which sheet is on screen right now?
+     * @examplePrompt Read the visible area of the presentation canvas
+     *
+     * # Example
+     * ```ts
+     * const { zoom, sheetId } = await snaptrude.presentation.camera.get()
+     * ```
+     */
+    abstract get(): PluginApiReturn<PluginPresentationCameraState>;
+    /**
+     * Pan and/or zoom the Present canvas. Fields left out keep their current
+     * value, so `{ zoom: 2 }` changes only the zoom (the page point at the
+     * viewport's top-left corner stays put) and `{ x, y }` pans at the current
+     * zoom. `zoom` is clamped to the editor's range (1% to 1000%); the requested
+     * `x`/`y` are always honoured. Immediate (no animation). View-state only —
+     * not undoable.
+     *
+     * `x`/`y` are the camera offset in page units: the page point that lands at
+     * the viewport's top-left corner is `(-x, -y)`. Read them back from
+     * {@linkcode PluginPresentationCameraApi.get} to reproduce a framing later.
+     *
+     * @param camera - Any of `x`, `y`, `zoom` ({@linkcode PluginPresentationCameraSetArgs}); at least one.
+     * @returns The resulting {@linkcode PluginPresentationCameraState}.
+     * @throws If Present mode is not open, or another Present-mode control has
+     *   locked the camera (an open style dropdown, AI Inspiration's layout mode).
+     *
+     * @examplePrompt Zoom the Present canvas to 50%
+     * @examplePrompt Pan the presentation canvas to the right
+     * @examplePrompt Restore the Present camera I saved earlier
+     * @examplePrompt Set the Present zoom to 200% without moving
+     *
+     * # Example
+     * ```ts
+     * const saved = await snaptrude.presentation.camera.get()
+     * await snaptrude.presentation.camera.set({ zoom: 0.5 })
+     * // …later, restore the exact framing
+     * await snaptrude.presentation.camera.set({ x: saved.x, y: saved.y, zoom: saved.zoom })
+     * ```
+     */
+    abstract set(camera: {
+        x?: number;
+        y?: number;
+        zoom?: number;
+    }): PluginApiReturn<PluginPresentationCameraState>;
+    /**
+     * Frame everything on the Present canvas — every sheet and loose shape — the
+     * Present-mode "zoom to fit". View-state only — not undoable.
+     *
+     * @returns The resulting {@linkcode PluginPresentationCameraState}.
+     * @throws If Present mode is not open, or the camera is locked.
+     *
+     * @examplePrompt Zoom out to see all the sheets
+     * @examplePrompt Fit the whole presentation in the Present view
+     * @examplePrompt Zoom to fit in Present mode
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.presentation.camera.zoomToFit()
+     * ```
+     */
+    abstract zoomToFit(): PluginApiReturn<PluginPresentationCameraState>;
+    /**
+     * Frame one shape on the Present canvas: a sheet, a placed view, a keyed
+     * shape or an annotation — any id the other `presentation` namespaces hand
+     * out. Pair with {@linkcode PluginPresentationCameraApi.capture} to
+     * screenshot a single sheet or placed view as it appears on screen.
+     * Immediate, unlike `sheets.setActive`, which animates its move over half a
+     * second. View-state only — not undoable.
+     *
+     * @param shapeId - The id of the sheet or shape to frame.
+     * @returns The resulting {@linkcode PluginPresentationCameraState}.
+     * @throws If Present mode is not open, the id is unknown, or the camera is locked.
+     *
+     * @examplePrompt Zoom in on sheet 2 in Present mode
+     * @examplePrompt Frame this placed view on the Present canvas
+     * @examplePrompt Go to the cover sheet and screenshot it
+     * @examplePrompt Centre the presentation view on that table
+     *
+     * # Example
+     * ```ts
+     * const { sheets } = await snaptrude.presentation.sheets.list()
+     * await snaptrude.presentation.camera.zoomTo(sheets[1].id)
+     * const { image } = await snaptrude.presentation.camera.capture()
+     * ```
+     */
+    abstract zoomTo(shapeId: string): PluginApiReturn<PluginPresentationCameraState>;
+}
+/**
+ * The visible area of the Present canvas in page units — the canvas as
+ * clipped by the window, minus the strip under the floating left sidebar.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `x` | `number` | Left edge (page units) |
+ * | `y` | `number` | Top edge (page units) |
+ * | `width` | `number` | Width (page units) |
+ * | `height` | `number` | Height (page units) |
+ */
+export declare const PluginPresentationCameraViewport: z.ZodObject<{
+    x: z.ZodNumber;
+    y: z.ZodNumber;
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginPresentationCameraViewport = z.infer<typeof PluginPresentationCameraViewport>;
+/**
+ * The Present canvas camera as returned by every
+ * {@linkcode PluginPresentationCameraApi} method.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `x` | `number` | Camera pan offset (page units): the page point at the tldraw viewport's top-left corner (under the sidebar) is `(-x, -y)` |
+ * | `y` | `number` | Camera pan offset (page units) |
+ * | `zoom` | `number` | Zoom factor, `1` = 100% |
+ * | `viewport` | {@linkcode PluginPresentationCameraViewport} | The visible page-space rectangle |
+ * | `sheetId` | `string \| null` | The sheet under the centre of the view, or `null` when none |
+ */
+export declare const PluginPresentationCameraState: z.ZodObject<{
+    x: z.ZodNumber;
+    y: z.ZodNumber;
+    zoom: z.ZodNumber;
+    viewport: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+    }, z.core.$strip>;
+    sheetId: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type PluginPresentationCameraState = z.infer<typeof PluginPresentationCameraState>;
+/**
+ * Arguments for {@linkcode PluginPresentationCameraApi.set}. All optional, at
+ * least one required; omitted fields keep their current value.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `x` | `number \| undefined` | Camera pan offset (page units) |
+ * | `y` | `number \| undefined` | Camera pan offset (page units) |
+ * | `zoom` | `number \| undefined` | Zoom factor, `> 0` (`1` = 100%); clamped to the editor's range (`0.01`–`10`), `x`/`y` still honoured |
+ */
+export declare const PluginPresentationCameraSetArgs: z.ZodObject<{
+    x: z.ZodOptional<z.ZodNumber>;
+    y: z.ZodOptional<z.ZodNumber>;
+    zoom: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type PluginPresentationCameraSetArgs = z.infer<typeof PluginPresentationCameraSetArgs>;
+/**
+ * Arguments for {@linkcode PluginPresentationCameraApi.zoomTo}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `shapeId` | `string` | The sheet or shape to frame |
+ */
+export declare const PluginPresentationCameraZoomToArgs: z.ZodObject<{
+    shapeId: z.ZodString;
+}, z.core.$strip>;
+export type PluginPresentationCameraZoomToArgs = z.infer<typeof PluginPresentationCameraZoomToArgs>;
+/**
+ * Arguments for {@linkcode PluginPresentationCameraApi.capture}. All optional.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `format` | `"png" \| "jpeg" \| undefined` | Output image format (default `"png"`) |
+ * | `pixelRatio` | `number \| undefined` | Output pixels per screen pixel, `1`–`4` (default `1`) |
+ */
+export declare const PluginPresentationCameraCaptureArgs: z.ZodObject<{
+    format: z.ZodOptional<z.ZodEnum<{
+        png: "png";
+        jpeg: "jpeg";
+    }>>;
+    pixelRatio: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type PluginPresentationCameraCaptureArgs = z.infer<typeof PluginPresentationCameraCaptureArgs>;
+/**
+ * Result of {@linkcode PluginPresentationCameraApi.capture}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `image` | `string` | The screenshot as a base64 data URL (`data:image/png;base64,…`) |
+ * | `width` | `number` | Image width in pixels |
+ * | `height` | `number` | Image height in pixels |
+ */
+export declare const PluginPresentationCameraCaptureResult: z.ZodObject<{
+    image: z.ZodString;
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginPresentationCameraCaptureResult = z.infer<typeof PluginPresentationCameraCaptureResult>;
+//# sourceMappingURL=camera.d.ts.map

package/dist/api/presentation/camera.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"camera.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/camera.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,6BAA6B,EAAE,MAAM,SAAS,CAAA;AAEvD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,8BAAsB,2BAA2B;;IAG/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;aACa,OAAO,CAAC,OAAO,CAAC,EAAE;QAChC,MAAM,CAAC,EAAE,6BAA6B,CAAA;QACtC,UAAU,CAAC,EAAE,MAAM,CAAA;KACpB,GAAG,eAAe,CAAC,qCAAqC,CAAC;IAE1D;;;;;;;;;;;;;;;;OAgBG;aACa,GAAG,IAAI,eAAe,CAAC,6BAA6B,CAAC;IAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;aACa,GAAG,CAAC,MAAM,EAAE;QAC1B,CAAC,CAAC,EAAE,MAAM,CAAA;QACV,CAAC,CAAC,EAAE,MAAM,CAAA;QACV,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,GAAG,eAAe,CAAC,6BAA6B,CAAC;IAElD;;;;;;;;;;;;;;;OAeG;aACa,SAAS,IAAI,eAAe,CAAC,6BAA6B,CAAC;IAE3E;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,MAAM,CACpB,OAAO,EAAE,MAAM,GACd,eAAe,CAAC,6BAA6B,CAAC;CAClD;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gCAAgC;;;;;iBAK3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;;;;iBAMxC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,+BAA+B;;;;iBAWzC,CAAA;AACH,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;iBAE7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,mCAAmC;;;;;;iBAG9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,qCAAqC;;;;iBAIhD,CAAA;AACF,MAAM,MAAM,qCAAqC,GAAG,CAAC,CAAC,KAAK,CACzD,OAAO,qCAAqC,CAC7C,CAAA"}

package/dist/api/presentation/drawingContract.d.ts

@@ -0,0 +1,32 @@
+import * as z from "zod";
+/**
+ * Metric architectural scale denominators (`100` means 1:100), the metric
+ * values of the placed view's Scale dropdown.
+ */
+export declare const METRIC_DRAWING_SCALES: readonly [10, 20, 50, 100, 150, 200, 250, 500, 1000];
+/**
+ * Imperial detail scale denominators, 1" = 1' (12) to 1/128" = 1' (1536):
+ * `48` is 1/4" = 1', `96` is 1/8" = 1'.
+ */
+export declare const IMPERIAL_DETAIL_DRAWING_SCALES: readonly [12, 16, 24, 32, 48, 64, 96, 128, 192, 384, 768, 1536];
+/** Imperial site (engineering) scale denominators, 1" = 10' (120) to 1" = 400' (4800). */
+export declare const IMPERIAL_SITE_DRAWING_SCALES: readonly [120, 240, 360, 480, 600, 1200, 2400, 3600, 4800];
+/**
+ * Imperial architectural scale denominators, ascending: the imperial detail
+ * and site values of the placed view's Scale dropdown.
+ */
+export declare const IMPERIAL_DRAWING_SCALES: readonly number[];
+/**
+ * Every standard architectural scale denominator, metric and imperial,
+ * ascending. Drawing and placed-view scale arguments accept only these; the
+ * host may further restrict them to the project's unit system.
+ */
+export declare const STANDARD_DRAWING_SCALES: readonly number[];
+/** A standard architectural scale denominator; anything else is rejected with the allowed list. */
+export declare const PluginStandardDrawingScale: z.ZodNumber;
+/**
+ * An export base file name without an extension, not ending in a dot or
+ * whitespace; the host adds `.pdf`, `.svg`, `.png` or `.jpg`.
+ */
+export declare const PluginExportFileName: z.ZodString;
+//# sourceMappingURL=drawingContract.d.ts.map

package/dist/api/presentation/drawingContract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"drawingContract.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/drawingContract.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAExB;;;GAGG;AACH,eAAO,MAAM,qBAAqB,sDAExB,CAAA;AAEV;;;GAGG;AACH,eAAO,MAAM,8BAA8B,iEAEjC,CAAA;AAEV,0FAA0F;AAC1F,eAAO,MAAM,4BAA4B,4DAE/B,CAAA;AAEV;;;GAGG;AACH,eAAO,MAAM,uBAAuB,EAAE,SAAS,MAAM,EAG9B,CAAA;AAEvB;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,EAAE,SAAS,MAAM,EAG9B,CAAA;AAIvB,mGAAmG;AACnG,eAAO,MAAM,0BAA0B,aAKnC,CAAA;AAOJ;;;GAGG;AACH,eAAO,MAAM,oBAAoB,aAQ9B,CAAA"}