@snaptrude/plugin-core 0.0.0-bimsvg-20260928124803

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

@@ -0,0 +1,184 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../types";
+/**
+ * Presentation diagrams — generate program diagrams from the model, and place
+ * diagram images onto sheets.
+ *
+ * {@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. All
+ * require Present mode to be open. Adjacency data itself is read and computed via
+ * `program.adjacency` (see {@linkcode PluginProgramAdjacencyApi}).
+ *
+ * There is intentionally no `generateAdjacency`: the host's adjacency generator
+ * runs its sheet-creation task fire-and-forget internally, so a single call
+ * cannot return the sheets it creates. Use the Present-mode Adjacency menu for
+ * those, then `place` a pre-rendered adjacency image if you need it via the API.
+ *
+ * Accessed via `snaptrude.presentation.diagrams`.
+ */
+export declare abstract class PluginPresentationDiagramsApi {
+    constructor();
+    /**
+     * Generate the program (space + department) diagrams for the current model,
+     * creating new layout sheets.
+     *
+     * Runs the same auto-generation as the Present-mode **Program** action: reads
+     * the project's spaces and departments, lays them out to scale, and creates one
+     * or more new sheets holding the generated diagram graphics. Unlike
+     * {@linkcode PluginPresentationDiagramsApi.place} (which pastes ready image URLs
+     * onto an existing sheet), this generates the graphics from the model and
+     * creates its own sheets. Requires Present mode to be open.
+     *
+     * @returns A {@linkcode PluginPresentationDiagramsGenerateResult} with the
+     *   `sheetIds` of the sheets created.
+     * @throws If Present mode is not open, or the model has no spaces/departments to
+     *   generate from.
+     *
+     * @examplePrompt Generate the program diagrams for this project
+     * @examplePrompt Auto-generate the space and department diagram sheets
+     * @examplePrompt Create the program layout sheets from the model
+     *
+     * # Example
+     * ```ts
+     * const { sheetIds } = await snaptrude.presentation.diagrams.generateProgram()
+     * ```
+     */
+    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"],
+     * })
+     * ```
+     */
+    abstract generateSite(options?: {
+        types?: PluginPresentationSiteDiagramType[];
+    }): PluginApiReturn<PluginPresentationDiagramsGenerateResult>;
+    /**
+     * Place diagram images onto a sheet.
+     *
+     * Drops the given diagram image URLs onto a sheet and returns the ids of the
+     * created canvas shapes. Requires Present mode to be open.
+     *
+     * @param sheetId - The sheet to place onto.
+     * @param urls - Diagram image URLs to place.
+     * @param options - Optional `position` (`{ x, y }`, relative to the sheet)
+     *   for the placed images.
+     * @returns A {@linkcode PluginPresentationDiagramsPlaceResult} with the created
+     *   `shapeIds`.
+     * @throws If Present mode is not open or the sheet id is invalid.
+     *
+     * @examplePrompt Place the adjacency diagram on Sheet 1
+     * @examplePrompt Add the program diagram to the cover sheet
+     * @examplePrompt Drop these diagram images onto the layout
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.presentation.diagrams.place("sheet_1", [
+     *   "https://example.com/program-diagram.png",
+     * ])
+     * ```
+     */
+    abstract place(sheetId: string, urls: string[], options?: {
+        position?: {
+            x: number;
+            y: number;
+        };
+    }): PluginApiReturn<PluginPresentationDiagramsPlaceResult>;
+}
+/**
+ * Arguments for {@linkcode PluginPresentationDiagramsApi.place}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `sheetId` | `string` | The sheet to place onto |
+ * | `urls` | `string[]` | Diagram image URLs |
+ * | `position` | `{ x: number; y: number } \| undefined` | Where to place them |
+ */
+export declare const PluginPresentationDiagramsPlaceArgs: z.ZodObject<{
+    sheetId: z.ZodString;
+    urls: z.ZodArray<z.ZodString>;
+    position: z.ZodOptional<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginPresentationDiagramsPlaceArgs = z.infer<typeof PluginPresentationDiagramsPlaceArgs>;
+/**
+ * Result of {@linkcode PluginPresentationDiagramsApi.place}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `shapeIds` | `string[]` | Ids of the created canvas shapes |
+ */
+export declare const PluginPresentationDiagramsPlaceResult: z.ZodObject<{
+    shapeIds: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type PluginPresentationDiagramsPlaceResult = z.infer<typeof PluginPresentationDiagramsPlaceResult>;
+/** A site diagram type — the three diagrams of the Present-mode site flow. */
+export declare const PluginPresentationSiteDiagramType: z.ZodEnum<{
+    location: "location";
+    streetview: "streetview";
+    climate: "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 declare const PluginPresentationDiagramsGenerateSiteArgs: z.ZodObject<{
+    types: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        location: "location";
+        streetview: "streetview";
+        climate: "climate";
+    }>>>;
+}, z.core.$strip>;
+export type PluginPresentationDiagramsGenerateSiteArgs = z.infer<typeof PluginPresentationDiagramsGenerateSiteArgs>;
+/**
+ * Result of {@linkcode PluginPresentationDiagramsApi.generateProgram} and
+ * {@linkcode PluginPresentationDiagramsApi.generateSite}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `sheetIds` | `string[]` | Ids of the sheets created by the generator |
+ */
+export declare const PluginPresentationDiagramsGenerateResult: z.ZodObject<{
+    sheetIds: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type PluginPresentationDiagramsGenerateResult = z.infer<typeof PluginPresentationDiagramsGenerateResult>;
+//# sourceMappingURL=diagrams.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"diagrams.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/diagrams.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,8BAAsB,6BAA6B;;IAGjD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,eAAe,IAAI,eAAe,CAAC,wCAAwC,CAAC;IAE5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;aACa,YAAY,CAAC,OAAO,CAAC,EAAE;QACrC,KAAK,CAAC,EAAE,iCAAiC,EAAE,CAAA;KAC5C,GAAG,eAAe,CAAC,wCAAwC,CAAC;IAE7D;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,KAAK,CACnB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EAAE,EACd,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,GAChD,eAAe,CAAC,qCAAqC,CAAC;CAC1D;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,mCAAmC;;;;;;;iBAI9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,qCAAqC;;iBAEhD,CAAA;AACF,MAAM,MAAM,qCAAqC,GAAG,CAAC,CAAC,KAAK,CACzD,OAAO,qCAAqC,CAC7C,CAAA;AAED,8EAA8E;AAC9E,eAAO,MAAM,iCAAiC;;;;EAI5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,0CAA0C;;;;;;iBAErD,CAAA;AACF,MAAM,MAAM,0CAA0C,GAAG,CAAC,CAAC,KAAK,CAC9D,OAAO,0CAA0C,CAClD,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,wCAAwC;;iBAEnD,CAAA;AACF,MAAM,MAAM,wCAAwC,GAAG,CAAC,CAAC,KAAK,CAC5D,OAAO,wCAAwC,CAChD,CAAA"}