@snaptrude/plugin-core 0.0.0-bimsvg-20260928124803

package/src/api/presentation/slideshow.ts

@@ -0,0 +1,134 @@
+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 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
+   * ```
+   */
+  public 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()
+   * ```
+   */
+  public 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()
+   * ```
+   */
+  public 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 const PluginPresentationSlideshowStartArgs = z.object({
+  sheetIds: z.array(z.string().min(1)).optional(),
+  startIndex: z.number().int().min(0).optional(),
+})
+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 const PluginPresentationSlideshowState = z.object({
+  running: z.boolean(),
+  index: z.number().int().nullable(),
+})
+export type PluginPresentationSlideshowState = z.infer<
+  typeof PluginPresentationSlideshowState
+>

package/src/api/presentation/tables.ts

@@ -0,0 +1,84 @@
+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 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 } })
+   * ```
+   */
+  public 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 const PluginPresentationTablesPlaceArgs = z.object({
+  sheetId: z.string().min(1),
+  rows: z
+    .array(z.array(z.string()).min(1))
+    .min(1)
+    .refine((rows) => rows.reduce((n, r) => n + r.length, 0) <= 10000, {
+      message: "table exceeds the 10000-cell cap",
+    }),
+  position: z.object({ x: z.number(), y: z.number() }).optional(),
+})
+export type PluginPresentationTablesPlaceArgs = z.infer<
+  typeof PluginPresentationTablesPlaceArgs
+>

package/src/api/presentation/viewPresets.ts

@@ -0,0 +1,83 @@
+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 const PluginViewPreset = z.object({
+  id: z.string(),
+  name: z.string(),
+  builtIn: z.boolean(),
+  revision: z.number().int().nonnegative(),
+})
+export type PluginViewPreset = z.infer<typeof PluginViewPreset>
+export const PluginViewPresetIdArgs = z
+  .object({ presetId: z.string().min(1) })
+  .strict()
+export type PluginViewPresetIdArgs = z.infer<typeof PluginViewPresetIdArgs>
+export const PluginViewPresetCreateArgs = z
+  .object({ name: z.string().trim().min(1), fromDrawingId: z.string().min(1) })
+  .strict()
+export type PluginViewPresetCreateArgs = z.infer<
+  typeof PluginViewPresetCreateArgs
+>
+export const PluginViewPresetRenameArgs = PluginViewPresetIdArgs.extend({
+  name: z.string().trim().min(1),
+})
+export type PluginViewPresetRenameArgs = z.infer<
+  typeof PluginViewPresetRenameArgs
+>
+export const PluginViewPresetUpdateArgs = PluginViewPresetIdArgs.extend({
+  fromDrawingId: z.string().min(1),
+})
+export type PluginViewPresetUpdateArgs = z.infer<
+  typeof PluginViewPresetUpdateArgs
+>
+export const PluginViewPresetDeleteArgs = PluginViewPresetIdArgs.extend({
+  replacementId: z.string().min(1),
+})
+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 abstract class PluginPresentationViewPresetsApi {
+  /**
+   * List built-ins first, then custom presets by name.
+   * @examplePrompt List the available drawing style presets
+   */
+  public abstract list(): PluginApiReturn<PluginViewPreset[]>
+  /** Read a preset, or null when missing. */
+  public 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
+   */
+  public abstract create(
+    name: string,
+    options: { fromDrawingId: string },
+  ): PluginApiReturn<PluginViewPreset>
+  /** Copy a preset with a native unique name, without changing drawing bindings. */
+  public abstract copy(presetId: string): PluginApiReturn<PluginViewPreset>
+  /** Rename a custom preset. Built-ins reject this operation. */
+  public 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
+   */
+  public abstract update(
+    presetId: string,
+    options: { fromDrawingId: string },
+  ): PluginApiReturn<PluginViewPreset>
+  /** Delete a custom preset, rebinding its drawings to a different existing replacement. */
+  public abstract delete(
+    presetId: string,
+    options: { replacementId: string },
+  ): PluginApiReturn<void>
+}