@snaptrude/plugin-core 0.8.0 → 0.9.1

package/src/api/presentation/annotate.ts

@@ -26,12 +26,22 @@ export abstract class PluginPresentationAnnotateApi {
    * Creates a text shape on the given sheet and returns the id of the created
    * canvas shape. Requires Present mode to be open.
    *
+   * Typography is optional: `fontFamily` takes a system family or any Google
+   * Font (loaded automatically, the same loader as the Present text panel);
+   * `fontWeight` is a numeric weight string like `"400"` or `"700"`,
+   * optionally with the `-italic` suffix (e.g. `"700-italic"`) — the Present
+   * text panel's value domain; a weight the chosen font does not provide
+   * falls back to regular. `fontSizePx` sets an exact pixel size, overriding
+   * the `size` preset when both are given (`size` alone keeps working).
+   *
    * @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"`).
+   *   `size` (`"s" | "m" | "l" | "xl"`, default `"m"`), `color` (a named
+   *   palette color, default `"black"`), and typography: `fontFamily`,
+   *   `fontWeight` (numeric string, `-italic` suffix allowed), `fontSizePx`
+   *   (positive px size overriding the `size` preset).
    * @returns A {@linkcode PluginPresentationAnnotateTextResult} with the created
    *   `shapeId`.
    * @throws If Present mode is not open or the sheet id is invalid.
@@ -57,6 +67,9 @@ export abstract class PluginPresentationAnnotateApi {
       position?: { x: number; y: number }
       size?: PluginAnnotateTextSize
       color?: PluginAnnotateTextColor
+      fontFamily?: string
+      fontWeight?: string
+      fontSizePx?: number
     },
   ): PluginApiReturn<PluginPresentationAnnotateTextResult>
 
@@ -218,6 +231,9 @@ export type PluginAnnotateTextColor = z.infer<typeof PluginAnnotateTextColor>
  * | `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 |
+ * | `fontFamily` | `string \| undefined` | System family or any Google Font (loaded automatically) |
+ * | `fontWeight` | `string \| undefined` | Numeric weight like `"400"`/`"700"`, `-italic` suffix allowed |
+ * | `fontSizePx` | `number \| undefined` | Exact px size (overrides the `size` preset) |
  */
 export const PluginPresentationAnnotateTextArgs = z.object({
   sheetId: z.string(),
@@ -225,6 +241,15 @@ export const PluginPresentationAnnotateTextArgs = z.object({
   position: z.object({ x: z.number(), y: z.number() }).optional(),
   size: PluginAnnotateTextSize.optional(),
   color: PluginAnnotateTextColor.optional(),
+  fontFamily: z.string().min(1).optional(),
+  fontWeight: z
+    .string()
+    .regex(
+      /^\d{3}(-italic)?$/,
+      'fontWeight must be a numeric string like "400" or "700", optionally with the "-italic" suffix',
+    )
+    .optional(),
+  fontSizePx: z.number().finite().positive().optional(),
 })
 export type PluginPresentationAnnotateTextArgs = z.infer<
   typeof PluginPresentationAnnotateTextArgs

package/src/api/presentation/diagrams.ts

@@ -8,8 +8,10 @@ import { PluginApiReturn } from "../../types"
  * {@linkcode PluginPresentationDiagramsApi.generateProgram} runs the Present-mode
  * **Program** action: it reads the project's spaces and departments and creates
  * new layout sheets holding the generated diagram graphics.
+ * {@linkcode PluginPresentationDiagramsApi.generateSite} runs the site-diagram
+ * flow (location / streetview / climate sheets from the map terrain).
  * {@linkcode PluginPresentationDiagramsApi.place} drops ready diagram images (by
- * URL) onto an existing sheet and returns the created canvas shape ids. Both
+ * URL) onto an existing sheet and returns the created canvas shape ids. All
  * require Present mode to be open. Adjacency data itself is read and computed via
  * `program.adjacency` (see {@linkcode PluginProgramAdjacencyApi}).
  *
@@ -50,6 +52,44 @@ export abstract class PluginPresentationDiagramsApi {
    */
   public abstract generateProgram(): PluginApiReturn<PluginPresentationDiagramsGenerateResult>
 
+  /**
+   * Generate the site diagrams (location, streetview, climate) for the
+   * current model, creating new layout sheets.
+   *
+   * Runs the same auto-generation as the Present-mode site-diagram flow:
+   * each requested type renders its diagram from the project's map terrain
+   * and creates a new sheet holding it. `options.types` selects which
+   * diagrams to generate (default: all three). Generation is tracked
+   * per-proposal — a type whose diagram already exists for the active
+   * proposal is **skipped, not duplicated** (the same semantics as the
+   * mount-time flow; existing site-diagram sheets are never replaced), so
+   * `sheetIds` contains only the sheets created by this call and can be
+   * empty when everything already exists. Requires Present mode to be open
+   * and the project to have a map terrain to generate from.
+   *
+   * @param options - Optional `types` — which site diagrams to generate
+   *   (default: `["location", "streetview", "climate"]`).
+   * @returns A {@linkcode PluginPresentationDiagramsGenerateResult} with the
+   *   `sheetIds` of the sheets created by this call (empty when all requested
+   *   types were already generated).
+   * @throws If Present mode is not open or the project has no map terrain to
+   *   generate from.
+   *
+   * @examplePrompt Generate the site diagrams for this project
+   * @examplePrompt Create the location, streetview and climate sheets
+   * @examplePrompt Add a climate diagram sheet to the presentation
+   *
+   * # Example
+   * ```ts
+   * const { sheetIds } = await snaptrude.presentation.diagrams.generateSite({
+   *   types: ["location", "climate"],
+   * })
+   * ```
+   */
+  public abstract generateSite(options?: {
+    types?: PluginPresentationSiteDiagramType[]
+  }): PluginApiReturn<PluginPresentationDiagramsGenerateResult>
+
   /**
    * Place diagram images onto a sheet.
    *
@@ -114,8 +154,33 @@ export type PluginPresentationDiagramsPlaceResult = z.infer<
   typeof PluginPresentationDiagramsPlaceResult
 >
 
+/** A site diagram type — the three diagrams of the Present-mode site flow. */
+export const PluginPresentationSiteDiagramType = z.enum([
+  "location",
+  "streetview",
+  "climate",
+])
+export type PluginPresentationSiteDiagramType = z.infer<
+  typeof PluginPresentationSiteDiagramType
+>
+
+/**
+ * Arguments for {@linkcode PluginPresentationDiagramsApi.generateSite}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `types` | {@linkcode PluginPresentationSiteDiagramType}`[] \| undefined` | Which site diagrams to generate (default: all three) |
+ */
+export const PluginPresentationDiagramsGenerateSiteArgs = z.object({
+  types: z.array(PluginPresentationSiteDiagramType).min(1).optional(),
+})
+export type PluginPresentationDiagramsGenerateSiteArgs = z.infer<
+  typeof PluginPresentationDiagramsGenerateSiteArgs
+>
+
 /**
- * Result of {@linkcode PluginPresentationDiagramsApi.generateProgram}.
+ * Result of {@linkcode PluginPresentationDiagramsApi.generateProgram} and
+ * {@linkcode PluginPresentationDiagramsApi.generateSite}.
  *
  * | Property | Type | Description |
  * |---|---|---|

package/src/api/presentation/export.ts

@@ -20,6 +20,10 @@ import * as z from "zod"
  *
  * Accessed via `snaptrude.presentation.export`.
  *
+ * For a different export intent, see `core.io.export.model` (the 3D model as a
+ * GLB/OBJ/FBX/3DS file) and `program.spreadsheet.export` (the area-program /
+ * takeoff workbook as XLSX/PDF/CSV).
+ *
  * The schemas and result types live here; the callable method is declared on
  * {@linkcode PluginPresentationApi.export}.
  */

package/src/api/presentation/import.ts

@@ -20,6 +20,9 @@ export abstract class PluginPresentationImportApi {
   /**
    * Import a reference image onto the current Present sheet.
    *
+   * To place the image as a **scene** underlay to trace over — on a storey,
+   * not the Present canvas — use `core.io.import.image` instead.
+   *
    * @param source - The asset to import: exactly one of `url` or `dataUrl`.
    * @param options - Optional `position` — where to place the image on the
    *   sheet.
@@ -50,6 +53,9 @@ export abstract class PluginPresentationImportApi {
    *
    * Each page is converted to vector SVG and placed as a canvas shape.
    *
+   * To bring the PDF into the **scene** as a traceable underlay — on a storey,
+   * not the Present canvas — use `core.io.import.pdf` instead.
+   *
    * @param source - The asset to import: exactly one of `url` or `dataUrl`.
    * @param options - Optional `position` — where to place the pages on the
    *   sheet.

package/src/api/presentation/index.ts

@@ -2,8 +2,12 @@ import { PluginApiReturn } from "../../types"
 import { PluginPresentationViewsApi } from "./views"
 import { PluginPresentationAIInspirationApi } from "./aiInspiration"
 import { PluginPresentationSheetsApi } from "./sheets"
+import { PluginPresentationPlacedViewsApi } from "./placedViews"
 import { PluginPresentationDiagramsApi } from "./diagrams"
 import { PluginPresentationAnnotateApi } from "./annotate"
+import { PluginPresentationShapesApi } from "./shapes"
+import { PluginPresentationTablesApi } from "./tables"
+import { PluginPresentationSlideshowApi } from "./slideshow"
 import { PluginPresentationImportApi } from "./import"
 import {
   PluginPresentationExportResult,
@@ -23,7 +27,10 @@ import {
  *
  * - {@linkcode PluginPresentationApi.views} — Saved 2D/3D views (list, get, capture, activate, create)
  * - {@linkcode PluginPresentationApi.sheets} — Layout sheets (list, get, create, place views)
- * - {@linkcode PluginPresentationApi.diagrams} — Place program/adjacency/site diagram images on sheets
+ * - {@linkcode PluginPresentationApi.placedViews} — Views already placed on the canvas (move, scale, crop)
+ * - {@linkcode PluginPresentationApi.diagrams} — Generate program/site diagram sheets, place diagram images
+ * - {@linkcode PluginPresentationApi.tables} — Place data tables on sheets
+ * - {@linkcode PluginPresentationApi.slideshow} — Run the Present-mode slideshow
  * - {@linkcode PluginPresentationApi.import} — Import reference images/PDFs onto the canvas
  * - {@linkcode PluginPresentationApi.aiInspiration} — Present-mode AI image/video generation
  *
@@ -34,10 +41,18 @@ export abstract class PluginPresentationApi {
   public abstract views: PluginPresentationViewsApi
   /** Layout sheets — list/get/create and place views (Present mode). See {@linkcode PluginPresentationSheetsApi}. */
   public abstract sheets: PluginPresentationSheetsApi
+  /** Placed views — layout of the view shapes on the canvas: move/scale/setScale/setCrop (Present mode). See {@linkcode PluginPresentationPlacedViewsApi}. */
+  public abstract placedViews: PluginPresentationPlacedViewsApi
   /** Program/adjacency/site diagrams — place images on sheets. See {@linkcode PluginPresentationDiagramsApi}. */
   public abstract diagrams: PluginPresentationDiagramsApi
   /** Annotations on Present-mode sheets — text/arrows/notes/geo shapes. See {@linkcode PluginPresentationAnnotateApi}. */
   public abstract annotate: PluginPresentationAnnotateApi
+  /** Plugin-owned keyed shapes — upsert/remove/list so reruns update instead of duplicating. See {@linkcode PluginPresentationShapesApi}. */
+  public abstract shapes: PluginPresentationShapesApi
+  /** Data tables on Present sheets — place string rows as a table shape. See {@linkcode PluginPresentationTablesApi}. */
+  public abstract tables: PluginPresentationTablesApi
+  /** The Present-mode slideshow — start/stop/getState. See {@linkcode PluginPresentationSlideshowApi}. */
+  public abstract slideshow: PluginPresentationSlideshowApi
   /** Import reference images/PDFs onto the Present canvas. See {@linkcode PluginPresentationImportApi}. */
   public abstract import: PluginPresentationImportApi
   /**
@@ -86,8 +101,12 @@ export abstract class PluginPresentationApi {
 
 export * from "./views"
 export * from "./sheets"
+export * from "./placedViews"
 export * from "./diagrams"
 export * from "./annotate"
+export * from "./shapes"
+export * from "./tables"
+export * from "./slideshow"
 export * from "./import"
 export * from "./aiInspiration"
 export * from "./export"