@snaptrude/plugin-core 0.0.0-bimsvg-20260928124803

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

@@ -0,0 +1,125 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../types";
+/**
+ * Presentation slideshow — run the Present-mode slideshow programmatically.
+ *
+ * The scriptable counterpart of the Present toolbar's slideshow: the
+ * slideshow plays **all** layout sheets in sheet order (hidden sheets are
+ * excluded) — `start` options only pick the slide it opens on. Slide
+ * navigation stays with the user (arrow keys / on-screen controls); there is
+ * intentionally no `next`/`prev`/`goTo`.
+ *
+ * **Fullscreen caveat:** browsers only grant fullscreen on a user gesture. A
+ * plugin-triggered `start` usually fails that check, in which case the
+ * slideshow catches the rejection and runs non-fullscreen (same slides, same
+ * controls, windowed).
+ *
+ * `start`/`stop` are write-gated; `getState` is a never-throw read. Requires
+ * Present mode to be open (except `getState`, which reports not-running).
+ *
+ * Accessed via `snaptrude.presentation.slideshow`.
+ */
+export declare abstract class PluginPresentationSlideshowApi {
+    constructor();
+    /**
+     * Start the slideshow.
+     *
+     * Launches the Present-mode slideshow over all layout sheets in sheet
+     * order. `options.startIndex` opens on that slide (clamped into range);
+     * otherwise `options.sheetIds` naming exactly one sheet opens on that
+     * sheet; otherwise it opens on the first slide. May run non-fullscreen —
+     * see the fullscreen caveat on
+     * {@linkcode PluginPresentationSlideshowApi}. Requires Present mode to be
+     * open with at least one sheet.
+     *
+     * @param options - Optional `sheetIds` (open on this sheet when exactly one
+     *   id is given) and `startIndex` (0-based slide to open on; wins over
+     *   `sheetIds`; clamped into range).
+     * @returns The {@linkcode PluginPresentationSlideshowState} after the
+     *   launch (`running: true` and the opening `index`).
+     * @throws If Present mode is not open or there are no sheets to present.
+     *
+     * @examplePrompt Start the slideshow
+     * @examplePrompt Present the sheets from the beginning
+     * @examplePrompt Start the slideshow on sheet 3
+     * @examplePrompt Play the presentation starting at the cover sheet
+     *
+     * # Example
+     * ```ts
+     * const state = await snaptrude.presentation.slideshow.start({ startIndex: 2 })
+     * console.log(state.running, state.index) // true, 2
+     * ```
+     */
+    abstract start(options?: {
+        sheetIds?: string[];
+        startIndex?: number;
+    }): PluginApiReturn<PluginPresentationSlideshowState>;
+    /**
+     * Stop the slideshow.
+     *
+     * Closes the running slideshow (exiting fullscreen if it entered it) and
+     * returns to the Present canvas. A no-op when no slideshow is running.
+     *
+     * @returns The {@linkcode PluginPresentationSlideshowState} after the stop
+     *   (`running: false`).
+     * @throws If Present mode is not open.
+     *
+     * @examplePrompt Stop the slideshow
+     * @examplePrompt Exit the presentation
+     * @examplePrompt Close the slideshow and go back to the sheets
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.presentation.slideshow.stop()
+     * ```
+     */
+    abstract stop(): PluginApiReturn<PluginPresentationSlideshowState>;
+    /**
+     * Read the slideshow state.
+     *
+     * A never-throw read: reports whether a slideshow is running and, when it
+     * is, the current 0-based slide index (`index` is `null` when not
+     * running — including when Present mode is closed).
+     *
+     * @returns The current {@linkcode PluginPresentationSlideshowState}.
+     *
+     * @examplePrompt Is the slideshow running?
+     * @examplePrompt Which slide is the presentation on?
+     * @examplePrompt Check the slideshow state
+     *
+     * # Example
+     * ```ts
+     * const { running, index } = await snaptrude.presentation.slideshow.getState()
+     * ```
+     */
+    abstract getState(): PluginApiReturn<PluginPresentationSlideshowState>;
+}
+/**
+ * Arguments for {@linkcode PluginPresentationSlideshowApi.start}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `sheetIds` | `string[] \| undefined` | Open on this sheet when exactly one id is given |
+ * | `startIndex` | `number \| undefined` | 0-based slide to open on (wins over `sheetIds`; clamped) |
+ */
+export declare const PluginPresentationSlideshowStartArgs: z.ZodObject<{
+    sheetIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    startIndex: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type PluginPresentationSlideshowStartArgs = z.infer<typeof PluginPresentationSlideshowStartArgs>;
+/**
+ * The slideshow state — result of {@linkcode PluginPresentationSlideshowApi.start},
+ * {@linkcode PluginPresentationSlideshowApi.stop}, and
+ * {@linkcode PluginPresentationSlideshowApi.getState}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `running` | `boolean` | Whether a slideshow is currently running |
+ * | `index` | `number \| null` | Current 0-based slide index (`null` when not running) |
+ */
+export declare const PluginPresentationSlideshowState: z.ZodObject<{
+    running: z.ZodBoolean;
+    index: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+export type PluginPresentationSlideshowState = z.infer<typeof PluginPresentationSlideshowState>;
+//# sourceMappingURL=slideshow.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"slideshow.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/slideshow.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;;;;;;;;;;GAkBG;AACH,8BAAsB,8BAA8B;;IAGlD;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;aACa,KAAK,CAAC,OAAO,CAAC,EAAE;QAC9B,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;QACnB,UAAU,CAAC,EAAE,MAAM,CAAA;KACpB,GAAG,eAAe,CAAC,gCAAgC,CAAC;IAErD;;;;;;;;;;;;;;;;;;OAkBG;aACa,IAAI,IAAI,eAAe,CAAC,gCAAgC,CAAC;IAEzE;;;;;;;;;;;;;;;;;OAiBG;aACa,QAAQ,IAAI,eAAe,CAAC,gCAAgC,CAAC;CAC9E;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,oCAAoC;;;iBAG/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,gCAAgC;;;iBAG3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA"}

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

@@ -0,0 +1,81 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../types";
+import type { PluginCanvasShape } from "./placedViews";
+/**
+ * Presentation tables — place data tables on Present-mode sheets.
+ *
+ * The scriptable counterpart of the Present canvas's table paste (the flow
+ * that turns a Program-mode / Google Sheets / Excel paste into a table
+ * shape): {@linkcode PluginPresentationTablesApi.place} takes plain string
+ * rows and creates one table shape on a sheet. Requires Present mode to be
+ * open.
+ *
+ * Accessed via `snaptrude.presentation.tables`.
+ */
+export declare abstract class PluginPresentationTablesApi {
+    constructor();
+    /**
+     * Place a table on a sheet.
+     *
+     * Creates one table shape from `table.rows` — the same shape the Present
+     * canvas creates when a spreadsheet table is pasted — and returns the
+     * created shape as a canvas-shape record. Cells are plain strings; rows may
+     * be ragged (each row needs at least one cell), capped at 10000 cells
+     * total. `options.position` is sheet-local (relative to the sheet's
+     * top-left, in canvas units — the same convention as `annotate.*`); when
+     * omitted the table lands where the paste flow would auto-place it (the
+     * center of the current viewport). One undo step. Requires Present mode to
+     * be open.
+     *
+     * @param sheetId - The sheet to place the table on.
+     * @param table - The table content: `rows`, an array of string-cell rows.
+     * @param options - Optional `position` (`{ x, y }`, relative to the sheet's
+     *   top-left — defaults to the paste flow's auto-placement).
+     * @returns The created table shape as a {@linkcode PluginCanvasShape}.
+     * @throws If Present mode is not open, the sheet id is invalid, or the
+     *   table is empty / exceeds the 10000-cell cap.
+     *
+     * @examplePrompt Put the area schedule as a table on Sheet 1
+     * @examplePrompt Add a table of the room programs to the cover sheet
+     * @examplePrompt Paste this data as a table on the sheet
+     * @examplePrompt Place a two-column table of space names and areas
+     *
+     * # Example
+     * ```ts
+     * const shape = await snaptrude.presentation.tables.place("sheet_1", {
+     *   rows: [
+     *     ["Room", "Area"],
+     *     ["Kitchen", "12.4 m²"],
+     *     ["Living", "28.0 m²"],
+     *   ],
+     * }, { position: { x: 40, y: 40 } })
+     * ```
+     */
+    abstract place(sheetId: string, table: {
+        rows: string[][];
+    }, options?: {
+        position?: {
+            x: number;
+            y: number;
+        };
+    }): PluginApiReturn<PluginCanvasShape>;
+}
+/**
+ * Arguments for {@linkcode PluginPresentationTablesApi.place}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `sheetId` | `string` | The sheet to place the table on |
+ * | `rows` | `string[][]` | Table cells as string rows (non-empty; ≤ 10000 cells total) |
+ * | `position` | `{ x: number; y: number } \| undefined` | Sheet-local position (default: paste auto-placement) |
+ */
+export declare const PluginPresentationTablesPlaceArgs: z.ZodObject<{
+    sheetId: z.ZodString;
+    rows: z.ZodArray<z.ZodArray<z.ZodString>>;
+    position: z.ZodOptional<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginPresentationTablesPlaceArgs = z.infer<typeof PluginPresentationTablesPlaceArgs>;
+//# sourceMappingURL=tables.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tables.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/tables.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AAEtD;;;;;;;;;;GAUG;AACH,8BAAsB,2BAA2B;;IAG/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;aACa,KAAK,CACnB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAAA;KAAE,EAC3B,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,GAChD,eAAe,CAAC,iBAAiB,CAAC;CACtC;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,iCAAiC;;;;;;;iBAS5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA"}

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

@@ -0,0 +1,70 @@
+import * as z from "zod";
+import type { PluginApiReturn } from "../../types";
+/** Presets are document-local. Their ids are stable across reload; built-ins are immutable. */
+export declare const PluginViewPreset: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    builtIn: z.ZodBoolean;
+    revision: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginViewPreset = z.infer<typeof PluginViewPreset>;
+export declare const PluginViewPresetIdArgs: z.ZodObject<{
+    presetId: z.ZodString;
+}, z.core.$strict>;
+export type PluginViewPresetIdArgs = z.infer<typeof PluginViewPresetIdArgs>;
+export declare const PluginViewPresetCreateArgs: z.ZodObject<{
+    name: z.ZodString;
+    fromDrawingId: z.ZodString;
+}, z.core.$strict>;
+export type PluginViewPresetCreateArgs = z.infer<typeof PluginViewPresetCreateArgs>;
+export declare const PluginViewPresetRenameArgs: z.ZodObject<{
+    presetId: z.ZodString;
+    name: z.ZodString;
+}, z.core.$strict>;
+export type PluginViewPresetRenameArgs = z.infer<typeof PluginViewPresetRenameArgs>;
+export declare const PluginViewPresetUpdateArgs: z.ZodObject<{
+    presetId: z.ZodString;
+    fromDrawingId: z.ZodString;
+}, z.core.$strict>;
+export type PluginViewPresetUpdateArgs = z.infer<typeof PluginViewPresetUpdateArgs>;
+export declare const PluginViewPresetDeleteArgs: z.ZodObject<{
+    presetId: z.ZodString;
+    replacementId: z.ZodString;
+}, z.core.$strict>;
+export type PluginViewPresetDeleteArgs = z.infer<typeof PluginViewPresetDeleteArgs>;
+/**
+ * Reusable kernel-plan styles. Requires Present open. Catalog writes are native non-undoable
+ * document metadata; binding/override writes use Present history. Local title text is excluded.
+ */
+export declare abstract class PluginPresentationViewPresetsApi {
+    /**
+     * List built-ins first, then custom presets by name.
+     * @examplePrompt List the available drawing style presets
+     */
+    abstract list(): PluginApiReturn<PluginViewPreset[]>;
+    /** Read a preset, or null when missing. */
+    abstract get(presetId: string): PluginApiReturn<PluginViewPreset | null>;
+    /**
+     * Capture a drawing's effective styles and bind it to the new preset. Names must be unique.
+     * @examplePrompt Save this drawing's styles as a new preset
+     */
+    abstract create(name: string, options: {
+        fromDrawingId: string;
+    }): PluginApiReturn<PluginViewPreset>;
+    /** Copy a preset with a native unique name, without changing drawing bindings. */
+    abstract copy(presetId: string): PluginApiReturn<PluginViewPreset>;
+    /** Rename a custom preset. Built-ins reject this operation. */
+    abstract rename(presetId: string, name: string): PluginApiReturn<PluginViewPreset>;
+    /**
+     * Update a custom preset from a drawing bound to it; refresh all bound drawings.
+     * @examplePrompt Update this preset from the current drawing styles
+     */
+    abstract update(presetId: string, options: {
+        fromDrawingId: string;
+    }): PluginApiReturn<PluginViewPreset>;
+    /** Delete a custom preset, rebinding its drawings to a different existing replacement. */
+    abstract delete(presetId: string, options: {
+        replacementId: string;
+    }): PluginApiReturn<void>;
+}
+//# sourceMappingURL=viewPresets.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"viewPresets.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/viewPresets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAElD,+FAA+F;AAC/F,eAAO,MAAM,gBAAgB;;;;;iBAK3B,CAAA;AACF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAC/D,eAAO,MAAM,sBAAsB;;kBAExB,CAAA;AACX,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAC3E,eAAO,MAAM,0BAA0B;;;kBAE5B,CAAA;AACX,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AACD,eAAO,MAAM,0BAA0B;;;kBAErC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AACD,eAAO,MAAM,0BAA0B;;;kBAErC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AACD,eAAO,MAAM,0BAA0B;;;kBAErC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;GAGG;AACH,8BAAsB,gCAAgC;IACpD;;;OAGG;aACa,IAAI,IAAI,eAAe,CAAC,gBAAgB,EAAE,CAAC;IAC3D,2CAA2C;aAC3B,GAAG,CACjB,QAAQ,EAAE,MAAM,GACf,eAAe,CAAC,gBAAgB,GAAG,IAAI,CAAC;IAC3C;;;OAGG;aACa,MAAM,CACpB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE;QAAE,aAAa,EAAE,MAAM,CAAA;KAAE,GACjC,eAAe,CAAC,gBAAgB,CAAC;IACpC,kFAAkF;aAClE,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,eAAe,CAAC,gBAAgB,CAAC;IACzE,+DAA+D;aAC/C,MAAM,CACpB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,gBAAgB,CAAC;IACpC;;;OAGG;aACa,MAAM,CACpB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE;QAAE,aAAa,EAAE,MAAM,CAAA;KAAE,GACjC,eAAe,CAAC,gBAAgB,CAAC;IACpC,0FAA0F;aAC1E,MAAM,CACpB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE;QAAE,aAAa,EAAE,MAAM,CAAA;KAAE,GACjC,eAAe,CAAC,IAAI,CAAC;CACzB"}