@snaptrude/plugin-core 0.8.0 → 0.9.1

package/src/api/presentation/shapes.ts

@@ -0,0 +1,274 @@
+import * as z from "zod"
+import { PluginApiReturn } from "../../types"
+import {
+  PluginAnnotateFill,
+  PluginAnnotateGeoKind,
+  PluginAnnotateTextColor,
+  PluginAnnotateTextSize,
+} from "./annotate"
+
+/**
+ * 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 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",
+   * })
+   * ```
+   */
+  public 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")
+   * ```
+   */
+  public 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()
+   * ```
+   */
+  public 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")
+   * ```
+   */
+  public 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 const PluginPresentationShapeSpec = z.discriminatedUnion("type", [
+  z.object({
+    type: z.literal("text"),
+    text: z.string(),
+    position: z.object({ x: z.number(), y: z.number() }).optional(),
+    size: PluginAnnotateTextSize.optional(),
+    color: PluginAnnotateTextColor.optional(),
+  }),
+  z.object({
+    type: z.literal("note"),
+    text: z.string(),
+    position: z.object({ x: z.number(), y: z.number() }).optional(),
+    color: PluginAnnotateTextColor.optional(),
+    size: PluginAnnotateTextSize.optional(),
+  }),
+  z.object({
+    type: z.literal("arrow"),
+    start: z.object({ x: z.number(), y: z.number() }),
+    end: z.object({ x: z.number(), y: z.number() }),
+    color: PluginAnnotateTextColor.optional(),
+    size: PluginAnnotateTextSize.optional(),
+  }),
+  z.object({
+    type: z.literal("geo"),
+    kind: PluginAnnotateGeoKind,
+    bounds: z.object({
+      x: z.number(),
+      y: z.number(),
+      w: z.number().positive(),
+      h: z.number().positive(),
+    }),
+    color: PluginAnnotateTextColor.optional(),
+    fill: PluginAnnotateFill.optional(),
+  }),
+])
+export type PluginPresentationShapeSpec = z.infer<
+  typeof PluginPresentationShapeSpec
+>
+
+/** The shape kind of a plugin-owned shape (the `type` discriminant of {@linkcode PluginPresentationShapeSpec}). */
+export const PluginPresentationShapeType = z.enum([
+  "text",
+  "note",
+  "arrow",
+  "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 const PluginPresentationShapesUpsertArgs = z.object({
+  key: z.string().min(1),
+  shape: PluginPresentationShapeSpec,
+  sheetId: z.string().optional(),
+})
+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 const PluginPresentationShapesUpsertResult = z.object({
+  shapeId: z.string(),
+  created: z.boolean(),
+})
+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 const PluginPresentationShapesRemoveArgs = z.object({
+  key: z.string().min(1),
+})
+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 const PluginPresentationShapesListResult = z.object({
+  shapes: z.array(
+    z.object({
+      key: z.string(),
+      shapeId: z.string(),
+      type: PluginPresentationShapeType,
+    }),
+  ),
+})
+export type PluginPresentationShapesListResult = z.infer<
+  typeof PluginPresentationShapesListResult
+>

package/src/api/presentation/sheets.ts

@@ -126,6 +126,34 @@ export abstract class PluginPresentationSheetsApi {
     orientation?: PluginSheetOrientation,
   ): PluginApiReturn<PluginPresentationSheet>
 
+  /**
+   * Set a sheet's print margin.
+   *
+   * Applies one of the canonical margin presets — exactly what the sheet
+   * header's margin dropdown does. `margin` is unit-agnostic: `0 | 0.25 |
+   * 0.5 | 0.75 | 1`, displayed as None / 1/4″ / 1/2″ / 3/4″ / 1″ on imperial
+   * projects and None / 5mm / 10mm / 15mm / 20mm on metric ones. One undo
+   * step. Requires Present mode to be open.
+   *
+   * @param sheetId - The id of the sheet.
+   * @param margin - The margin preset ({@linkcode PluginSheetMargin}).
+   * @returns The updated {@linkcode PluginPresentationSheet}.
+   * @throws If Present mode is not open, or the sheet id is invalid.
+   *
+   * @examplePrompt Set the sheet margin to half an inch
+   * @examplePrompt Remove the margins on sheet_1
+   * @examplePrompt Give the cover sheet a 10mm margin
+   *
+   * # Example
+   * ```ts
+   * const sheet = await snaptrude.presentation.sheets.setMargin("sheet_1", 0.5)
+   * ```
+   */
+  public abstract setMargin(
+    sheetId: string,
+    margin: PluginSheetMargin,
+  ): PluginApiReturn<PluginPresentationSheet>
+
   /**
    * Place a saved view onto a sheet.
    *
@@ -331,6 +359,21 @@ export type PluginSheetSize = z.infer<typeof PluginSheetSize>
 export const PluginSheetOrientation = z.enum(["landscape", "portrait"])
 export type PluginSheetOrientation = z.infer<typeof PluginSheetOrientation>
 
+/**
+ * Canonical sheet margin presets — unit-agnostic values matching the sheet
+ * header's margin dropdown: `0` (None), `0.25`, `0.5`, `0.75`, `1`.
+ * Displayed as None / 1/4″ / 1/2″ / 3/4″ / 1″ on imperial projects and
+ * None / 5mm / 10mm / 15mm / 20mm on metric ones.
+ */
+export const PluginSheetMargin = z.union([
+  z.literal(0),
+  z.literal(0.25),
+  z.literal(0.5),
+  z.literal(0.75),
+  z.literal(1),
+])
+export type PluginSheetMargin = z.infer<typeof PluginSheetMargin>
+
 /**
  * A layout sheet in the presentation.
  *
@@ -340,12 +383,14 @@ export type PluginSheetOrientation = z.infer<typeof PluginSheetOrientation>
  * | `name` | `string` | Display name |
  * | `size` | {@linkcode PluginSheetSize}` \| null` | Paper preset (`null` for a legacy sheet without one) |
  * | `orientation` | {@linkcode PluginSheetOrientation}` \| null` | Orientation (`null` for a legacy sheet) |
+ * | `margin` | {@linkcode PluginSheetMargin}` \| null` | Margin preset (`null` when absent/unrecognized) |
  */
 export const PluginPresentationSheet = z.object({
   id: z.string(),
   name: z.string(),
   size: PluginSheetSize.nullable(),
   orientation: PluginSheetOrientation.nullable(),
+  margin: PluginSheetMargin.nullable(),
 })
 export type PluginPresentationSheet = z.infer<typeof PluginPresentationSheet>
 
@@ -406,6 +451,15 @@ export type PluginPresentationSheetsSetSizeArgs = z.infer<
   typeof PluginPresentationSheetsSetSizeArgs
 >
 
+/** Arguments for {@linkcode PluginPresentationSheetsApi.setMargin}. */
+export const PluginPresentationSheetsSetMarginArgs = z.object({
+  sheetId: z.string(),
+  margin: PluginSheetMargin,
+})
+export type PluginPresentationSheetsSetMarginArgs = z.infer<
+  typeof PluginPresentationSheetsSetMarginArgs
+>
+
 /**
  * Arguments for {@linkcode PluginPresentationSheetsApi.place}.
  *

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
+>