@snaptrude/plugin-core 0.7.1 → 0.9.0

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

@@ -0,0 +1,481 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../types";
+/**
+ * Presentation shapes — a stable, plugin-owned shape lifecycle on Present-mode
+ * sheets.
+ *
+ * Where {@linkcode PluginPresentationAnnotateApi} is fire-and-forget (every call
+ * creates a new shape), this namespace keys each shape by a caller-chosen
+ * string, so rerunning an analysis **updates** its sheet output in place instead
+ * of duplicating it:
+ *
+ * - {@linkcode PluginPresentationShapesApi.upsert} — create or update the shape for a key
+ * - {@linkcode PluginPresentationShapesApi.remove} — delete the shape for a key
+ * - {@linkcode PluginPresentationShapesApi.removeAll} — delete every shape owned by the calling plugin
+ * - {@linkcode PluginPresentationShapesApi.list} — the calling plugin's shapes (key, shapeId, type)
+ *
+ * Shape ids are derived deterministically from the plugin id + key, so upserts
+ * converge across collaborators. Mutations require **Present mode to be open**
+ * (`list` is a never-throw read); each plugin sees and mutates only its own
+ * shapes.
+ *
+ * Accessed via `snaptrude.presentation.shapes`.
+ */
+export declare abstract class PluginPresentationShapesApi {
+    constructor();
+    /**
+     * Create or update the shape for a key.
+     *
+     * The `shape` spec is a discriminated union over the same four annotation
+     * kinds as `presentation.annotate` (`text`, `note`, `arrow`, `geo`), with the
+     * same option shapes. On first call for a key the shape is created on the
+     * target sheet (`options.sheetId`, default: the first sheet) and nested under
+     * the sheet frame; on later calls the existing shape is updated in place —
+     * same shape id, same sheet, one undo step. Positions/bounds are relative to
+     * the sheet's top-left, in canvas units. Requires Present mode to be open.
+     *
+     * @param key - Caller-chosen stable identifier for the shape (per plugin).
+     * @param shape - The desired shape ({@linkcode PluginPresentationShapeSpec}):
+     *   `{ type: "text" | "note" | "arrow" | "geo", ... }` with the matching
+     *   annotate options. Changing `type` for an existing key replaces the shape
+     *   (same shape id).
+     * @param options - Optional `sheetId` — the sheet to create the shape on
+     *   (defaults to the first sheet; ignored on update, the shape stays on its
+     *   sheet).
+     * @returns A {@linkcode PluginPresentationShapesUpsertResult} — the stable
+     *   `shapeId` and `created` (`true` on first upsert, `false` on update).
+     * @throws If Present mode is not open, the args are invalid, or the sheet id
+     *   is unknown.
+     *
+     * @examplePrompt Update the analysis label on the sheet instead of adding another one
+     * @examplePrompt Rerun the daylight report and refresh its annotations
+     * @examplePrompt Keep one "FAR: 2.4" text on Sheet 1 that updates on each run
+     * @examplePrompt Draw a highlight rectangle the plugin can move on the next run
+     *
+     * # Example
+     * ```ts
+     * const { shapeId, created } = await snaptrude.presentation.shapes.upsert("far-label", {
+     *   type: "text",
+     *   text: "FAR: 2.4",
+     *   position: { x: 40, y: 40 },
+     *   color: "blue",
+     * })
+     * ```
+     */
+    abstract upsert(key: string, shape: PluginPresentationShapeSpec, options?: {
+        sheetId?: string;
+    }): PluginApiReturn<PluginPresentationShapesUpsertResult>;
+    /**
+     * Delete the shape for a key.
+     *
+     * Removes the calling plugin's shape registered under `key`, if it exists.
+     * Requires Present mode to be open.
+     *
+     * @param key - The key passed to {@linkcode PluginPresentationShapesApi.upsert}.
+     * @returns `true` if a shape was deleted, `false` if no shape exists for the
+     *   key.
+     * @throws If Present mode is not open or the key is invalid.
+     *
+     * @examplePrompt Remove the FAR label from the sheet
+     * @examplePrompt Delete the highlight the plugin added earlier
+     * @examplePrompt Clear the "far-label" annotation
+     *
+     * # Example
+     * ```ts
+     * const removed = await snaptrude.presentation.shapes.remove("far-label")
+     * ```
+     */
+    abstract remove(key: string): PluginApiReturn<boolean>;
+    /**
+     * Delete every shape owned by the calling plugin.
+     *
+     * Removes all shapes the calling plugin has upserted (across all sheets) in
+     * one undo step. Requires Present mode to be open.
+     *
+     * @returns The number of shapes deleted.
+     * @throws If Present mode is not open.
+     *
+     * @examplePrompt Clear all annotations my plugin added
+     * @examplePrompt Reset the sheet output before rerunning the analysis
+     * @examplePrompt Remove every plugin-drawn shape
+     *
+     * # Example
+     * ```ts
+     * const deleted = await snaptrude.presentation.shapes.removeAll()
+     * ```
+     */
+    abstract removeAll(): PluginApiReturn<number>;
+    /**
+     * List the calling plugin's shapes.
+     *
+     * Returns one entry per live shape the calling plugin has upserted — its
+     * `key`, the underlying canvas `shapeId`, and the shape `type`. A never-throw
+     * read: returns an empty list when Present mode is closed.
+     *
+     * @returns A {@linkcode PluginPresentationShapesListResult} with the `shapes`
+     *   array (empty when Present mode is closed).
+     *
+     * @examplePrompt Which annotations has my plugin placed on the sheets?
+     * @examplePrompt List the plugin's shapes before refreshing them
+     * @examplePrompt Check whether the FAR label already exists
+     *
+     * # Example
+     * ```ts
+     * const { shapes } = await snaptrude.presentation.shapes.list()
+     * const hasLabel = shapes.some((s) => s.key === "far-label")
+     * ```
+     */
+    abstract list(): PluginApiReturn<PluginPresentationShapesListResult>;
+}
+/**
+ * Desired shape for {@linkcode PluginPresentationShapesApi.upsert} — a
+ * discriminated union over the four annotate kinds, with the same option shapes
+ * as the matching `presentation.annotate` call:
+ *
+ * | `type` | Payload | Mirrors |
+ * |---|---|---|
+ * | `"text"` | `text`, `position?`, `size?`, `color?` | `annotate.text` |
+ * | `"note"` | `text`, `position?`, `color?`, `size?` | `annotate.note` |
+ * | `"arrow"` | `start`, `end`, `color?`, `size?` | `annotate.arrow` |
+ * | `"geo"` | `kind`, `bounds`, `color?`, `fill?` | `annotate.shape` |
+ *
+ * Positions/bounds are relative to the sheet's top-left, in canvas units.
+ */
+export declare const PluginPresentationShapeSpec: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"text">;
+    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>, z.ZodObject<{
+    type: z.ZodLiteral<"note">;
+    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>, z.ZodObject<{
+    type: z.ZodLiteral<"arrow">;
+    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>, z.ZodObject<{
+    type: z.ZodLiteral<"geo">;
+    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>], "type">;
+export type PluginPresentationShapeSpec = z.infer<typeof PluginPresentationShapeSpec>;
+/** The shape kind of a plugin-owned shape (the `type` discriminant of {@linkcode PluginPresentationShapeSpec}). */
+export declare const PluginPresentationShapeType: z.ZodEnum<{
+    text: "text";
+    note: "note";
+    arrow: "arrow";
+    geo: "geo";
+}>;
+export type PluginPresentationShapeType = z.infer<typeof PluginPresentationShapeType>;
+/**
+ * Arguments for {@linkcode PluginPresentationShapesApi.upsert}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `key` | `string` | Caller-chosen stable identifier (non-empty) |
+ * | `shape` | {@linkcode PluginPresentationShapeSpec} | The desired shape |
+ * | `sheetId` | `string \| undefined` | Sheet to create on (default: first sheet; ignored on update) |
+ */
+export declare const PluginPresentationShapesUpsertArgs: z.ZodObject<{
+    key: z.ZodString;
+    shape: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"text">;
+        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>, z.ZodObject<{
+        type: z.ZodLiteral<"note">;
+        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>, z.ZodObject<{
+        type: z.ZodLiteral<"arrow">;
+        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>, z.ZodObject<{
+        type: z.ZodLiteral<"geo">;
+        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>], "type">;
+    sheetId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type PluginPresentationShapesUpsertArgs = z.infer<typeof PluginPresentationShapesUpsertArgs>;
+/**
+ * Result of {@linkcode PluginPresentationShapesApi.upsert}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `shapeId` | `string` | Stable id of the canvas shape for the key |
+ * | `created` | `boolean` | `true` if the shape was created, `false` if updated |
+ */
+export declare const PluginPresentationShapesUpsertResult: z.ZodObject<{
+    shapeId: z.ZodString;
+    created: z.ZodBoolean;
+}, z.core.$strip>;
+export type PluginPresentationShapesUpsertResult = z.infer<typeof PluginPresentationShapesUpsertResult>;
+/**
+ * Arguments for {@linkcode PluginPresentationShapesApi.remove}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `key` | `string` | The key the shape was upserted under (non-empty) |
+ */
+export declare const PluginPresentationShapesRemoveArgs: z.ZodObject<{
+    key: z.ZodString;
+}, z.core.$strip>;
+export type PluginPresentationShapesRemoveArgs = z.infer<typeof PluginPresentationShapesRemoveArgs>;
+/**
+ * Result of {@linkcode PluginPresentationShapesApi.list}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `shapes` | `{ key: string; shapeId: string; type: `{@linkcode PluginPresentationShapeType}` }[]` | One entry per live plugin-owned shape |
+ */
+export declare const PluginPresentationShapesListResult: z.ZodObject<{
+    shapes: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        shapeId: z.ZodString;
+        type: z.ZodEnum<{
+            text: "text";
+            note: "note";
+            arrow: "arrow";
+            geo: "geo";
+        }>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginPresentationShapesListResult = z.infer<typeof PluginPresentationShapesListResult>;
+//# sourceMappingURL=shapes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"shapes.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/shapes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAQ7C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,8BAAsB,2BAA2B;;IAG/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;aACa,MAAM,CACpB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,2BAA2B,EAClC,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAC7B,eAAe,CAAC,oCAAoC,CAAC;IAExD;;;;;;;;;;;;;;;;;;;OAmBG;aACa,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC;IAE7D;;;;;;;;;;;;;;;;;OAiBG;aACa,SAAS,IAAI,eAAe,CAAC,MAAM,CAAC;IAEpD;;;;;;;;;;;;;;;;;;;OAmBG;aACa,IAAI,IAAI,eAAe,CAAC,kCAAkC,CAAC;CAC5E;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAkCtC,CAAA;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED,mHAAmH;AACnH,eAAO,MAAM,2BAA2B;;;;;EAKtC,CAAA;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAI7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,oCAAoC;;;iBAG/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;iBAE7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;;;;iBAQ7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA"}