@snaptrude/plugin-core 0.7.1 → 0.8.0

package/dist/api/entity/story.d.ts

@@ -91,21 +91,32 @@ export declare abstract class PluginStoryApi {
      */
     abstract create(storyValue: number, height?: number): PluginApiReturn<PluginStoryCreateResult>;
     /**
-     * Update a story's floor-to-floor height, cascading the full geometry change.
+     * Update a story's floor-to-floor `height` and/or `name`.
      *
-     * This is the same operation as editing the height in the Stories panel: the
-     * walls, columns, and masses on the story are **stretched** to the new height,
-     * every story **above shifts up/down** by the delta so the stack stays
+     * **Height** is the same operation as editing the height in the Stories panel:
+     * the walls, columns, and masses on the story are **stretched** to the new
+     * height, every story **above shifts up/down** by the delta so the stack stays
      * contiguous, and coupled elements (staircases, parametric curtain walls,
-     * furniture offsets) are re-fitted. The whole cascade is committed as **one
-     * undo step**. Height-locked elements are left untouched.
+     * furniture offsets) are re-fitted. The whole height cascade is committed as
+     * **one undo step**. Height-locked elements are left untouched.
+     *
+     * **Name** is the same as renaming the story in the Stories panel: it is
+     * persisted immediately (saved to the project) but, mirroring the panel, is
+     * **not** part of the height undo step.
+     *
+     * At least one of `height` or `options.name` must be supplied. Omitting the
+     * `height` argument (e.g. for a rename-only update) leaves the height
+     * untouched.
      *
      * @param storyValue - Integer storey number
      *   identifying the story to update
      * @param height - New floor-to-floor height in
-     *   Babylon units
-     * @returns A {@linkcode PluginStoryUpdateResult} with the updated `storyValue` and `height`
+     *   Babylon units. Omit to leave the height unchanged.
+     * @param options - `name` (new display name for the story)
+     * @returns A {@linkcode PluginStoryUpdateResult} with the story's
+     *   `storyValue`, `height`, and `name` after the update
      * @throws `PRECONDITION_FAILED` if no story has the given value;
+     *   `VALIDATION` if neither `height` nor `options.name` is supplied;
      *   `STORY_HEIGHT_REJECTED` if the engine rejects the height (e.g. out of
      *   range — the change silently reverts host-side and is surfaced as this
      *   error); `STORY_UPDATE_FAILED` if the story cannot be re-read after the
@@ -113,17 +124,68 @@ export declare abstract class PluginStoryApi {
      *
      * @examplePrompt Change the ground floor height to 3.5 metres
      * @examplePrompt Make the second storey taller
+     * @examplePrompt Rename the ground floor to "Lobby"
      * @examplePrompt Set the floor-to-floor height of level 1
-     * @examplePrompt Increase the height of the third floor
+     * @examplePrompt Rename storey 2 and make it taller in one go
      *
      * # Example
      * ```ts
      * // Set ground floor height to 5 Babylon units — walls stretch and the
      * // floors above move up to match, all in a single undo step.
      * const result = await snaptrude.entity.story.update(1, 5)
+     * // Rename only, leaving the height untouched.
+     * await snaptrude.entity.story.update(1, undefined, { name: "Lobby" })
      * ```
      */
-    abstract update(storyValue: number, height: number): PluginApiReturn<PluginStoryUpdateResult>;
+    abstract update(storyValue: number, height?: number, options?: {
+        name?: string;
+    }): PluginApiReturn<PluginStoryUpdateResult>;
+    /**
+     * Make a story the active story — the same as clicking it in the storey/layer
+     * panel. Subsequent draws and creates target this story, and in 2D the
+     * viewport switches to it. This is a view/navigation change: it is **not**
+     * undoable and commits nothing to the model.
+     *
+     * @param storyValue - Integer storey number to activate
+     * @returns A {@linkcode PluginStorySetActiveResult} echoing the now-active `storyValue`
+     * @throws `PRECONDITION_FAILED` if no story has the given value
+     *
+     * @examplePrompt Switch to the second floor
+     * @examplePrompt Make the ground storey active
+     * @examplePrompt Go to the basement level
+     * @examplePrompt Set level 3 as the current storey
+     *
+     * # Example
+     * ```ts
+     * // Activate story 2, then draw a wall — it lands on story 2.
+     * await snaptrude.entity.story.setActive(2)
+     * ```
+     */
+    abstract setActive(storyValue: number): PluginApiReturn<PluginStorySetActiveResult>;
+    /**
+     * Delete a story and everything on it — the same as removing it from the
+     * storey panel. Every element placed on the story (walls, floors, masses, …)
+     * is deleted with it, the remaining stories are re-stacked, and the active
+     * story falls back to an adjacent one. Committed as a single undo step.
+     *
+     * @param storyValue - Integer storey number to delete
+     * @returns A {@linkcode PluginStoryDeleteResult} with the deleted `storyValue`
+     *   and the `newActiveStory` the editor fell back to
+     * @throws `PRECONDITION_FAILED` if no story has the given value; or if plugin
+     *   writes are disabled
+     *
+     * @examplePrompt Delete the top floor
+     * @examplePrompt Remove the basement level
+     * @examplePrompt Get rid of storey 3
+     * @examplePrompt Delete the second floor and everything on it
+     *
+     * # Example
+     * ```ts
+     * const { newActiveStory } = await snaptrude.entity.story.delete(3)
+     * console.log(`Deleted story 3; now on story ${newActiveStory}`)
+     * ```
+     */
+    abstract delete(storyValue: number): PluginApiReturn<PluginStoryDeleteResult>;
     /**
      * Duplicate a story into the adjacent level, up or down.
      *
@@ -278,31 +340,82 @@ export declare const PluginStoryCreateResult: z.ZodObject<{
 }, z.core.$strip>;
 export type PluginStoryCreateResult = z.infer<typeof PluginStoryCreateResult>;
 /**
- * Arguments for {@linkcode PluginStoryApi.update}.
+ * Arguments for {@linkcode PluginStoryApi.update}. At least one of `height` or
+ * `name` must be supplied.
  *
  * | Property | Type | Description |
  * |---|---|---|
  * | `storyValue` | `number` (int) | Storey number of the story to update |
- * | `height` | `number` | New height in Babylon units |
+ * | `height` | `number?` | New height in Babylon units (omit to leave unchanged) |
+ * | `name` | `string?` | New display name for the story (omit to leave unchanged) |
  */
 export declare const PluginStoryUpdateArgs: z.ZodObject<{
     storyValue: z.ZodNumber;
-    height: z.ZodNumber;
+    height: z.ZodOptional<z.ZodNumber>;
+    name: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export type PluginStoryUpdateArgs = z.infer<typeof PluginStoryUpdateArgs>;
 /**
- * Result of {@linkcode PluginStoryApi.update}.
+ * Result of {@linkcode PluginStoryApi.update} — the story's state after the update.
  *
  * | Property | Type | Description |
  * |---|---|---|
  * | `storyValue` | `number` | The storey number of the updated story |
- * | `height` | `number` | The new height after the update |
+ * | `height` | `number` | The height after the update |
+ * | `name` | `string` | The name after the update |
  */
 export declare const PluginStoryUpdateResult: z.ZodObject<{
     storyValue: z.ZodNumber;
     height: z.ZodNumber;
+    name: z.ZodString;
 }, z.core.$strip>;
 export type PluginStoryUpdateResult = z.infer<typeof PluginStoryUpdateResult>;
+/**
+ * Arguments for {@linkcode PluginStoryApi.setActive}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `storyValue` | `number` (int) | Storey number to activate |
+ */
+export declare const PluginStorySetActiveArgs: z.ZodObject<{
+    storyValue: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginStorySetActiveArgs = z.infer<typeof PluginStorySetActiveArgs>;
+/**
+ * Result of {@linkcode PluginStoryApi.setActive}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `storyValue` | `number` | The storey number that is now active |
+ */
+export declare const PluginStorySetActiveResult: z.ZodObject<{
+    storyValue: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginStorySetActiveResult = z.infer<typeof PluginStorySetActiveResult>;
+/**
+ * Arguments for {@linkcode PluginStoryApi.delete}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `storyValue` | `number` (int) | Storey number to delete |
+ */
+export declare const PluginStoryDeleteArgs: z.ZodObject<{
+    storyValue: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginStoryDeleteArgs = z.infer<typeof PluginStoryDeleteArgs>;
+/**
+ * Result of {@linkcode PluginStoryApi.delete}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `storyValue` | `number` | The storey number that was deleted |
+ * | `newActiveStory` | `number` | The storey the editor fell back to as active |
+ */
+export declare const PluginStoryDeleteResult: z.ZodObject<{
+    storyValue: z.ZodNumber;
+    newActiveStory: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginStoryDeleteResult = z.infer<typeof PluginStoryDeleteResult>;
 /**
  * Arguments for {@linkcode PluginStoryApi.duplicate} (options flattened).
  *

package/dist/api/entity/story.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"story.d.ts","sourceRoot":"","sources":["../../../src/api/entity/story.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE/C;;;;;;;;;;;GAWG;AACH,8BAAsB,cAAc;;IAGlC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,GAAG,CACjB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,sBAAsB,EAAE,GACnC,eAAe,CAAC,oBAAoB,CAAC;IAExC;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,MAAM,IAAI,eAAe,CAAC,uBAAuB,CAAC;IAElE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,MAAM,GACd,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;aACa,SAAS,CACvB,SAAS,EAAE,IAAI,GAAG,MAAM,EACxB,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAC7D,eAAe,CAAC,0BAA0B,CAAC;CAC/C;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;EASjC,CAAA;AAEF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;iBAG7B,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;iBAWrB,CAAA;AAEZ,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;;;;;;iBAQlC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB;;;iBAGhC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB;;;iBAGlC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB;;;iBAGhC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB;;;iBAGlC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB;;;;;;;iBAInC,CAAA;AAEF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;;;;GAUG;AACH,eAAO,MAAM,0BAA0B;;;;;;iBAMrC,CAAA;AAEF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA"}
+{"version":3,"file":"story.d.ts","sourceRoot":"","sources":["../../../src/api/entity/story.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE/C;;;;;;;;;;;GAWG;AACH,8BAAsB,cAAc;;IAGlC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,GAAG,CACjB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,sBAAsB,EAAE,GACnC,eAAe,CAAC,oBAAoB,CAAC;IAExC;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,MAAM,IAAI,eAAe,CAAC,uBAAuB,CAAC;IAElE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,MAAM,GACd,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAC1B,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,SAAS,CACvB,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,0BAA0B,CAAC;IAE9C;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;aACa,SAAS,CACvB,SAAS,EAAE,IAAI,GAAG,MAAM,EACxB,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAC7D,eAAe,CAAC,0BAA0B,CAAC;CAC/C;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;EASjC,CAAA;AAEF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;iBAG7B,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;iBAWrB,CAAA;AAEZ,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;;;;;;iBAQlC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB;;;iBAGhC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB;;;iBAGlC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;;;GASG;AACH,eAAO,MAAM,qBAAqB;;;;iBAIhC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;;GAQG;AACH,eAAO,MAAM,uBAAuB;;;;iBAIlC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB;;iBAEnC,CAAA;AAEF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B;;iBAErC,CAAA;AAEF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB;;iBAEhC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB;;;iBAGlC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB;;;;;;;iBAInC,CAAA;AAEF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;;;;GAUG;AACH,eAAO,MAAM,0BAA0B;;;;;;iBAMrC,CAAA;AAEF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA"}

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

@@ -0,0 +1,448 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../types";
+/**
+ * Presentation annotate — add annotations to Present-mode sheets.
+ *
+ * The scriptable counterparts to the Present toolbar's annotation tools (all
+ * require Present mode to be open; each returns the created canvas shape id):
+ *
+ * - {@linkcode PluginPresentationAnnotateApi.text} — text labels (titles, captions)
+ * - {@linkcode PluginPresentationAnnotateApi.arrow} — arrows pointing between two points
+ * - {@linkcode PluginPresentationAnnotateApi.note} — sticky notes
+ * - {@linkcode PluginPresentationAnnotateApi.shape} — geo shapes (rectangle, ellipse, cloud, …)
+ *
+ * The freehand Draw tool is not scriptable (a stroke is an interactive gesture,
+ * not a single call) and is intentionally not exposed here.
+ *
+ * Accessed via `snaptrude.presentation.annotate`.
+ */
+export declare abstract class PluginPresentationAnnotateApi {
+    constructor();
+    /**
+     * Add a text label to a sheet.
+     *
+     * Creates a text shape on the given sheet and returns the id of the created
+     * canvas shape. Requires Present mode to be open.
+     *
+     * @param sheetId - The sheet to annotate.
+     * @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"`), and `color` (a named
+     *   palette color, default `"black"`).
+     * @returns A {@linkcode PluginPresentationAnnotateTextResult} with the created
+     *   `shapeId`.
+     * @throws If Present mode is not open or the sheet id is invalid.
+     *
+     * @examplePrompt Add a title "Ground Floor" to Sheet 1
+     * @examplePrompt Label the cover sheet with the project name
+     * @examplePrompt Caption this view with "Proposed layout"
+     * @examplePrompt Put a red note on the sheet
+     *
+     * # Example
+     * ```ts
+     * const { shapeId } = await snaptrude.presentation.annotate.text(
+     *   "sheet_1",
+     *   "Ground Floor",
+     *   { position: { x: 40, y: 40 }, size: "xl", color: "blue" },
+     * )
+     * ```
+     */
+    abstract text(sheetId: string, text: string, options?: {
+        position?: {
+            x: number;
+            y: number;
+        };
+        size?: PluginAnnotateTextSize;
+        color?: PluginAnnotateTextColor;
+    }): PluginApiReturn<PluginPresentationAnnotateTextResult>;
+    /**
+     * Draw an arrow on a sheet.
+     *
+     * Creates an arrow shape from `start` to `end` (both relative to the sheet's
+     * 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 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"`).
+     * @returns A {@linkcode PluginPresentationAnnotateResult} with the created
+     *   `shapeId`.
+     * @throws If Present mode is not open or the sheet id is invalid.
+     *
+     * @examplePrompt Draw an arrow pointing at the entrance on Sheet 1
+     * @examplePrompt Add a red arrow from the title to the plan view
+     * @examplePrompt Point an arrow at the top-left view on the cover sheet
+     *
+     * # Example
+     * ```ts
+     * const { shapeId } = await snaptrude.presentation.annotate.arrow(
+     *   "sheet_1",
+     *   { x: 100, y: 200 },
+     *   { x: 300, y: 250 },
+     *   { color: "red" },
+     * )
+     * ```
+     */
+    abstract arrow(sheetId: string, start: {
+        x: number;
+        y: number;
+    }, end: {
+        x: number;
+        y: number;
+    }, options?: {
+        color?: PluginAnnotateTextColor;
+        size?: PluginAnnotateTextSize;
+    }): PluginApiReturn<PluginPresentationAnnotateResult>;
+    /**
+     * Add a sticky note to a sheet.
+     *
+     * Creates a note shape (the same Note tool as the Present toolbar — a
+     * 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 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"`).
+     * @returns A {@linkcode PluginPresentationAnnotateResult} with the created
+     *   `shapeId`.
+     * @throws If Present mode is not open or the sheet id is invalid.
+     *
+     * @examplePrompt Add a sticky note "Review this wall" to Sheet 1
+     * @examplePrompt Put a yellow note on the cover sheet
+     * @examplePrompt Leave a note next to the ground floor plan
+     *
+     * # Example
+     * ```ts
+     * const { shapeId } = await snaptrude.presentation.annotate.note(
+     *   "sheet_1",
+     *   "Review this wall",
+     *   { position: { x: 60, y: 120 }, color: "yellow" },
+     * )
+     * ```
+     */
+    abstract note(sheetId: string, text: string, options?: {
+        position?: {
+            x: number;
+            y: number;
+        };
+        color?: PluginAnnotateTextColor;
+        size?: PluginAnnotateTextSize;
+    }): PluginApiReturn<PluginPresentationAnnotateResult>;
+    /**
+     * Draw a geo shape (rectangle, ellipse, cloud, …) on a sheet.
+     *
+     * Creates a geo shape of the given `kind` — the same shapes as the Present
+     * toolbar's shape flyout — sized to `bounds` (relative to the sheet's
+     * 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 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).
+     * @returns A {@linkcode PluginPresentationAnnotateResult} with the created
+     *   `shapeId`.
+     * @throws If Present mode is not open or the sheet id is invalid.
+     *
+     * @examplePrompt Draw a revision cloud around the kitchen on Sheet 2
+     * @examplePrompt Add a red rectangle highlight to the sheet
+     * @examplePrompt Draw an ellipse around the entrance on the cover sheet
+     *
+     * # Example
+     * ```ts
+     * const { shapeId } = await snaptrude.presentation.annotate.shape(
+     *   "sheet_1",
+     *   "cloud",
+     *   { x: 80, y: 80, w: 240, h: 160 },
+     *   { color: "red" },
+     * )
+     * ```
+     */
+    abstract shape(sheetId: string, kind: PluginAnnotateGeoKind, bounds: {
+        x: number;
+        y: number;
+        w: number;
+        h: number;
+    }, options?: {
+        color?: PluginAnnotateTextColor;
+        fill?: PluginAnnotateFill;
+    }): PluginApiReturn<PluginPresentationAnnotateResult>;
+}
+/** Text size preset (the same s/m/l/xl scale as the Present-mode text tool). */
+export declare const PluginAnnotateTextSize: z.ZodEnum<{
+    m: "m";
+    s: "s";
+    l: "l";
+    xl: "xl";
+}>;
+export type PluginAnnotateTextSize = z.infer<typeof PluginAnnotateTextSize>;
+/** Named palette color (the same swatches as the Present-mode style panel). */
+export declare const PluginAnnotateTextColor: z.ZodEnum<{
+    black: "black";
+    grey: "grey";
+    "light-violet": "light-violet";
+    violet: "violet";
+    blue: "blue";
+    "light-blue": "light-blue";
+    yellow: "yellow";
+    orange: "orange";
+    green: "green";
+    "light-green": "light-green";
+    "light-red": "light-red";
+    red: "red";
+    white: "white";
+}>;
+export type PluginAnnotateTextColor = z.infer<typeof PluginAnnotateTextColor>;
+/**
+ * Arguments for {@linkcode PluginPresentationAnnotateApi.text}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `sheetId` | `string` | The sheet to annotate |
+ * | `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 |
+ * | `color` | {@linkcode PluginAnnotateTextColor}` \| undefined` | Text color |
+ */
+export declare const PluginPresentationAnnotateTextArgs: z.ZodObject<{
+    sheetId: z.ZodString;
+    text: z.ZodString;
+    position: z.ZodOptional<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, z.core.$strip>>;
+    size: z.ZodOptional<z.ZodEnum<{
+        m: "m";
+        s: "s";
+        l: "l";
+        xl: "xl";
+    }>>;
+    color: z.ZodOptional<z.ZodEnum<{
+        black: "black";
+        grey: "grey";
+        "light-violet": "light-violet";
+        violet: "violet";
+        blue: "blue";
+        "light-blue": "light-blue";
+        yellow: "yellow";
+        orange: "orange";
+        green: "green";
+        "light-green": "light-green";
+        "light-red": "light-red";
+        red: "red";
+        white: "white";
+    }>>;
+}, z.core.$strip>;
+export type PluginPresentationAnnotateTextArgs = z.infer<typeof PluginPresentationAnnotateTextArgs>;
+/**
+ * Result of {@linkcode PluginPresentationAnnotateApi.text}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `shapeId` | `string` | Id of the created text shape |
+ */
+export declare const PluginPresentationAnnotateTextResult: z.ZodObject<{
+    shapeId: z.ZodString;
+}, z.core.$strip>;
+export type PluginPresentationAnnotateTextResult = z.infer<typeof PluginPresentationAnnotateTextResult>;
+/**
+ * Geo shape kind — the shapes offered by the Present-mode toolbar's shape
+ * flyout.
+ */
+export declare const PluginAnnotateGeoKind: z.ZodEnum<{
+    rectangle: "rectangle";
+    ellipse: "ellipse";
+    triangle: "triangle";
+    diamond: "diamond";
+    hexagon: "hexagon";
+    oval: "oval";
+    rhombus: "rhombus";
+    star: "star";
+    cloud: "cloud";
+    heart: "heart";
+    "x-box": "x-box";
+    "check-box": "check-box";
+    "arrow-left": "arrow-left";
+    "arrow-up": "arrow-up";
+    "arrow-right": "arrow-right";
+    "arrow-down": "arrow-down";
+}>;
+export type PluginAnnotateGeoKind = z.infer<typeof PluginAnnotateGeoKind>;
+/** Fill style for geo shapes (the same fills as the Present-mode style panel). */
+export declare const PluginAnnotateFill: z.ZodEnum<{
+    pattern: "pattern";
+    none: "none";
+    semi: "semi";
+    solid: "solid";
+}>;
+export type PluginAnnotateFill = z.infer<typeof PluginAnnotateFill>;
+/**
+ * Arguments for {@linkcode PluginPresentationAnnotateApi.arrow}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `sheetId` | `string` | The sheet to annotate |
+ * | `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;
+    start: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, z.core.$strip>;
+    end: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, z.core.$strip>;
+    color: z.ZodOptional<z.ZodEnum<{
+        black: "black";
+        grey: "grey";
+        "light-violet": "light-violet";
+        violet: "violet";
+        blue: "blue";
+        "light-blue": "light-blue";
+        yellow: "yellow";
+        orange: "orange";
+        green: "green";
+        "light-green": "light-green";
+        "light-red": "light-red";
+        red: "red";
+        white: "white";
+    }>>;
+    size: z.ZodOptional<z.ZodEnum<{
+        m: "m";
+        s: "s";
+        l: "l";
+        xl: "xl";
+    }>>;
+}, z.core.$strip>;
+export type PluginPresentationAnnotateArrowArgs = z.infer<typeof PluginPresentationAnnotateArrowArgs>;
+/**
+ * Arguments for {@linkcode PluginPresentationAnnotateApi.note}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `sheetId` | `string` | The sheet to annotate |
+ * | `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;
+    text: z.ZodString;
+    position: z.ZodOptional<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, z.core.$strip>>;
+    color: z.ZodOptional<z.ZodEnum<{
+        black: "black";
+        grey: "grey";
+        "light-violet": "light-violet";
+        violet: "violet";
+        blue: "blue";
+        "light-blue": "light-blue";
+        yellow: "yellow";
+        orange: "orange";
+        green: "green";
+        "light-green": "light-green";
+        "light-red": "light-red";
+        red: "red";
+        white: "white";
+    }>>;
+    size: z.ZodOptional<z.ZodEnum<{
+        m: "m";
+        s: "s";
+        l: "l";
+        xl: "xl";
+    }>>;
+}, z.core.$strip>;
+export type PluginPresentationAnnotateNoteArgs = z.infer<typeof PluginPresentationAnnotateNoteArgs>;
+/**
+ * Arguments for {@linkcode PluginPresentationAnnotateApi.shape}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `sheetId` | `string` | The sheet to annotate |
+ * | `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;
+    kind: z.ZodEnum<{
+        rectangle: "rectangle";
+        ellipse: "ellipse";
+        triangle: "triangle";
+        diamond: "diamond";
+        hexagon: "hexagon";
+        oval: "oval";
+        rhombus: "rhombus";
+        star: "star";
+        cloud: "cloud";
+        heart: "heart";
+        "x-box": "x-box";
+        "check-box": "check-box";
+        "arrow-left": "arrow-left";
+        "arrow-up": "arrow-up";
+        "arrow-right": "arrow-right";
+        "arrow-down": "arrow-down";
+    }>;
+    bounds: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        w: z.ZodNumber;
+        h: z.ZodNumber;
+    }, z.core.$strip>;
+    color: z.ZodOptional<z.ZodEnum<{
+        black: "black";
+        grey: "grey";
+        "light-violet": "light-violet";
+        violet: "violet";
+        blue: "blue";
+        "light-blue": "light-blue";
+        yellow: "yellow";
+        orange: "orange";
+        green: "green";
+        "light-green": "light-green";
+        "light-red": "light-red";
+        red: "red";
+        white: "white";
+    }>>;
+    fill: z.ZodOptional<z.ZodEnum<{
+        pattern: "pattern";
+        none: "none";
+        semi: "semi";
+        solid: "solid";
+    }>>;
+}, z.core.$strip>;
+export type PluginPresentationAnnotateShapeArgs = z.infer<typeof PluginPresentationAnnotateShapeArgs>;
+/**
+ * Result of {@linkcode PluginPresentationAnnotateApi.arrow},
+ * {@linkcode PluginPresentationAnnotateApi.note}, and
+ * {@linkcode PluginPresentationAnnotateApi.shape}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `shapeId` | `string` | Id of the created canvas shape |
+ */
+export declare const PluginPresentationAnnotateResult: z.ZodObject<{
+    shapeId: z.ZodString;
+}, z.core.$strip>;
+export type PluginPresentationAnnotateResult = z.infer<typeof PluginPresentationAnnotateResult>;
+//# sourceMappingURL=annotate.d.ts.map

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

@@ -0,0 +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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;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;KAChC,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;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAM7C,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"}