@snaptrude/plugin-core 0.7.1 → 0.9.0

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

@@ -5,12 +5,14 @@ import { PluginApiReturn } from "../../types";
  *
  * A **view** is a saved camera/plan: a sheet-ready 2D plan or a saved 3D view.
  * A plugin can list and read views, capture them to images, activate one (move
- * the camera to it), save the current camera as a new view, and read/update a
- * view's display settings (background, color mode, axis, edges, labels).
+ * the camera to it), save the current camera as a new view, rename or delete a
+ * saved view, and read/update a view's display settings (background, color
+ * mode, view mode, axis, edges, labels). Each view carries the `storey` it was
+ * saved on.
  *
  * `list`/`get`/`getActive`/`capture`/`getSettings` are reads;
- * `setActive`/`create`/`updateSettings` are writes (a view is a camera bookmark
- * — not geometry).
+ * `setActive`/`create`/`rename`/`delete`/`updateSettings` are writes (a view is
+ * a camera bookmark — not geometry).
  *
  * Accessed via `snaptrude.presentation.views`.
  */
@@ -124,26 +126,34 @@ export declare abstract class PluginPresentationViewsApi {
      * Creates a camera bookmark (not geometry) from where the camera is now.
      *
      * @param name - Name for the new view (a default is used when omitted).
-     * @param options - Optional `kind`: what kind of view to save (default `"view"`).
+     * @param options - Optional `kind` (what kind of view to save, default
+     *   `"view"`) and `storey` (save the view on a specific storey — the storey is
+     *   activated first, matching the storey the view is captured on; when omitted
+     *   the current active storey is used).
      * @returns The newly created {@linkcode PluginPresentationView}.
-     * @throws If the view could not be saved.
+     * @throws If `storey` is given but no such storey exists, or the view could
+     *   not be saved.
      *
      * @examplePrompt Save the current view as Lobby Perspective
      * @examplePrompt Create a new saved view from where I'm looking
      * @examplePrompt Bookmark this camera angle
      * @examplePrompt Save the current 2D plan as a view
+     * @examplePrompt Save a view on the second storey
      *
      * # Example
      * ```ts
      * const view = await snaptrude.presentation.views.create("Lobby")
+     * // …or capture the view on a specific storey
+     * const level2 = await snaptrude.presentation.views.create("Level 2", { storey: 2 })
      * ```
      */
     abstract create(name?: string, options?: {
         kind?: "view" | "sitePlan";
+        storey?: number;
     }): PluginApiReturn<PluginPresentationViewsCreateResult>;
     /**
-     * Read a saved view's display settings (background, color mode, axis, edges,
-     * labels).
+     * Read a saved view's display settings (background, color mode, view mode,
+     * axis, edges, labels).
      *
      * @param viewId - The id of the view to read settings for.
      * @returns The view's {@linkcode PluginPresentationViewSettings}, or `null` if
@@ -190,19 +200,30 @@ export declare abstract class PluginPresentationViewsApi {
      * {@linkcode PluginPresentationViewsApi.getSettings}, so read-then-write
      * round-trips a tag-based color scheme unchanged.
      *
+     * `viewMode` (`"perspective"` | `"isometric"`) applies to **3D views only** —
+     * a 2D plan is always orthographic, so a `viewMode: "perspective"` patch on a
+     * 2D view is rejected. `"isometric"` on a 2D plan is accepted as a no-op (the
+     * plan is already orthographic), so writing back exactly what
+     * {@linkcode PluginPresentationViewsApi.getSettings} returned is always a
+     * no-op. On the active view the camera switches projection live (the same
+     * toggle the view-settings modal runs); on other views the mode is applied
+     * the next time the view is activated.
+     *
      * @param viewId - The id of the view to update.
      * @param settings - A partial {@linkcode PluginPresentationViewSettings}; any
      *   omitted field is left unchanged.
      * @returns The updated view's `id`.
-     * @throws If writes are disabled, no view has the given id, or the patch is
+     * @throws If writes are disabled, no view has the given id, the patch is
      *   contradictory (`showLabels: false` with a non-empty `labels`, or
-     *   `showLabels: true` with an explicitly empty `labels` list).
+     *   `showLabels: true` with an explicitly empty `labels` list), or
+     *   `viewMode: "perspective"` is patched on a 2D plan view.
      *
      * @examplePrompt Switch this view to monochrome color mode
      * @examplePrompt Turn off the axis in the Ground Floor view
      * @examplePrompt Set the background of the active view to white
      * @examplePrompt Show area labels on this view
      * @examplePrompt Enable hidden-line mode for the section view
+     * @examplePrompt Make the 3D view orthographic instead of perspective
      *
      * # Example
      * ```ts
@@ -210,9 +231,60 @@ export declare abstract class PluginPresentationViewsApi {
      *   colorMode: "monochrome",
      *   showAxis: false,
      * })
+     * // switch a 3D view to an isometric (orthographic) projection
+     * await snaptrude.presentation.views.updateSettings("view_123", {
+     *   viewMode: "isometric",
+     * })
      * ```
      */
     abstract updateSettings(viewId: string, settings: Partial<PluginPresentationViewSettings>): PluginApiReturn<PluginPresentationViewsUpdateSettingsResult>;
+    /**
+     * Rename a saved view.
+     *
+     * Sets the view's display name — the same label the views panel shows and
+     * that `list`/`get` read back. Names must be unique within the proposal and
+     * cannot contain the characters `\ : { } [ ] | ; < > ? ~`.
+     *
+     * @param viewId - The id of the view to rename.
+     * @param name - The new display name (non-empty after trimming).
+     * @returns The updated {@linkcode PluginPresentationView}.
+     * @throws If writes are disabled, no view has the given id, the name is
+     *   empty/invalid, or another view in the proposal already has that name.
+     *
+     * @examplePrompt Rename the view Lobby to Entrance Lobby
+     * @examplePrompt Call this view Ground Floor Plan
+     * @examplePrompt Change the active view's name to Final
+     *
+     * # Example
+     * ```ts
+     * const view = await snaptrude.presentation.views.rename("view_123", "Entrance")
+     * ```
+     */
+    abstract rename(viewId: string, name: string): PluginApiReturn<PluginPresentationViewsRenameResult>;
+    /**
+     * Delete a saved view.
+     *
+     * Removes the view from the project and the views panel (the panel's own
+     * delete action). If the deleted view was active, the product falls back to
+     * the default plan/3D view. Default views (the built-in plan/3D/site-plan
+     * entries) cannot be deleted.
+     *
+     * @param viewId - The id of the view to delete.
+     * @returns The id of the deleted view
+     *   (a {@linkcode PluginPresentationViewsDeleteResult}).
+     * @throws If writes are disabled, no view has the given id, or the view is a
+     *   default view.
+     *
+     * @examplePrompt Delete the view named Old Draft
+     * @examplePrompt Remove this saved view
+     * @examplePrompt Get rid of the Lobby camera bookmark
+     *
+     * # Example
+     * ```ts
+     * const { id } = await snaptrude.presentation.views.delete("view_123")
+     * ```
+     */
+    abstract delete(viewId: string): PluginApiReturn<PluginPresentationViewsDeleteResult>;
 }
 /**
  * The kind of a saved view: a 2D plan view or a 3D view.
@@ -231,6 +303,7 @@ export type PluginPresentationViewType = z.infer<typeof PluginPresentationViewTy
  * | `name` | `string` | Display name |
  * | `type` | `"2d" \| "3d"` | Whether this is a 2D plan view or a 3D view |
  * | `isActive` | `boolean` | Whether this view is the currently active view |
+ * | `storey` | `number \| null` | The storey this view was saved on (`null` on older views saved without one) |
  */
 export declare const PluginPresentationView: z.ZodObject<{
     id: z.ZodString;
@@ -240,6 +313,7 @@ export declare const PluginPresentationView: z.ZodObject<{
         "3d": "3d";
     }>;
     isActive: z.ZodBoolean;
+    storey: z.ZodNullable<z.ZodNumber>;
 }, z.core.$strip>;
 export type PluginPresentationView = z.infer<typeof PluginPresentationView>;
 /**
@@ -258,6 +332,7 @@ export declare const PluginPresentationViewsListResult: z.ZodObject<{
             "3d": "3d";
         }>;
         isActive: z.ZodBoolean;
+        storey: z.ZodNullable<z.ZodNumber>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
 export type PluginPresentationViewsListResult = z.infer<typeof PluginPresentationViewsListResult>;
@@ -285,6 +360,7 @@ export declare const PluginPresentationViewsGetResult: z.ZodNullable<z.ZodObject
         "3d": "3d";
     }>;
     isActive: z.ZodBoolean;
+    storey: z.ZodNullable<z.ZodNumber>;
 }, z.core.$strip>>;
 export type PluginPresentationViewsGetResult = z.infer<typeof PluginPresentationViewsGetResult>;
 /** Image format for {@linkcode PluginPresentationViewsApi.capture}. */
@@ -345,6 +421,7 @@ export type PluginPresentationViewsSetActiveResult = z.infer<typeof PluginPresen
  * |---|---|---|
  * | `name` | `string \| undefined` | Name for the new view (a default is used when omitted) |
  * | `kind` | `"view" \| "sitePlan" \| undefined` | What kind of view to save (default `"view"`). `"plan"` is not offered — the host cannot create a plan view without a `planId` this API does not carry. |
+ * | `storey` | `number \| undefined` | Save the view on this storey (activated before capture); defaults to the current active storey |
  */
 export declare const PluginPresentationViewsCreateArgs: z.ZodObject<{
     name: z.ZodOptional<z.ZodString>;
@@ -352,6 +429,7 @@ export declare const PluginPresentationViewsCreateArgs: z.ZodObject<{
         view: "view";
         sitePlan: "sitePlan";
     }>>;
+    storey: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 export type PluginPresentationViewsCreateArgs = z.infer<typeof PluginPresentationViewsCreateArgs>;
 /** Result of {@linkcode PluginPresentationViewsApi.create} — the saved view. */
@@ -363,6 +441,7 @@ export declare const PluginPresentationViewsCreateResult: z.ZodObject<{
         "3d": "3d";
     }>;
     isActive: z.ZodBoolean;
+    storey: z.ZodNullable<z.ZodNumber>;
 }, z.core.$strip>;
 export type PluginPresentationViewsCreateResult = z.infer<typeof PluginPresentationViewsCreateResult>;
 /**
@@ -400,6 +479,22 @@ export declare const PluginPresentationViewLabel: z.ZodEnum<{
     areas: "areas";
 }>;
 export type PluginPresentationViewLabel = z.infer<typeof PluginPresentationViewLabel>;
+/**
+ * A view's camera projection: perspective, or isometric (orthographic).
+ *
+ * | Value | Meaning |
+ * |---|---|
+ * | `perspective` | Perspective projection (vanishing points) |
+ * | `isometric` | Orthographic projection (no perspective distortion) |
+ *
+ * Applies to 3D views; a 2D plan view is always orthographic and reads
+ * `"isometric"`.
+ */
+export declare const PluginPresentationViewMode: z.ZodEnum<{
+    perspective: "perspective";
+    isometric: "isometric";
+}>;
+export type PluginPresentationViewMode = z.infer<typeof PluginPresentationViewMode>;
 /**
  * A view's display settings.
  *
@@ -407,6 +502,7 @@ export type PluginPresentationViewLabel = z.infer<typeof PluginPresentationViewL
  * |---|---|---|
  * | `backgroundColor` | `string` | Canvas background as a hex color (e.g. `#ffffff`) |
  * | `colorMode` | {@linkcode PluginPresentationViewColorMode} | How the scene is colored (including `tag:<categoryId>` schemes) |
+ * | `viewMode` | {@linkcode PluginPresentationViewMode} | Camera projection — `"perspective"` or `"isometric"` (orthographic). Writable on 3D views only; a 2D plan always reads `"isometric"` and accepts only `"isometric"` (a no-op) |
  * | `showAxis` | `boolean` | Whether the X/Y/Z axes are shown |
  * | `showEdges` | `boolean` | Whether edges are shown; `false` = hidden-line rendering |
  * | `showLabels` | `boolean` | Master label switch — whether on-canvas labels are shown at all. `true` always pairs with a non-empty `labels` selection (labels render only while the selection is non-empty; there is no labels-on-with-empty-selection state) |
@@ -419,6 +515,10 @@ export declare const PluginPresentationViewSettings: z.ZodObject<{
         monochrome: "monochrome";
         texture: "texture";
     }>, z.ZodTemplateLiteral<`tag:${string}`>]>;
+    viewMode: z.ZodEnum<{
+        perspective: "perspective";
+        isometric: "isometric";
+    }>;
     showAxis: z.ZodBoolean;
     showEdges: z.ZodBoolean;
     showLabels: z.ZodBoolean;
@@ -451,6 +551,10 @@ export declare const PluginPresentationViewsGetSettingsResult: z.ZodNullable<z.Z
         monochrome: "monochrome";
         texture: "texture";
     }>, z.ZodTemplateLiteral<`tag:${string}`>]>;
+    viewMode: z.ZodEnum<{
+        perspective: "perspective";
+        isometric: "isometric";
+    }>;
     showAxis: z.ZodBoolean;
     showEdges: z.ZodBoolean;
     showLabels: z.ZodBoolean;
@@ -482,6 +586,10 @@ export declare const PluginPresentationViewsUpdateSettingsArgs: z.ZodObject<{
             monochrome: "monochrome";
             texture: "texture";
         }>, z.ZodTemplateLiteral<`tag:${string}`>]>>;
+        viewMode: z.ZodOptional<z.ZodEnum<{
+            perspective: "perspective";
+            isometric: "isometric";
+        }>>;
         showAxis: z.ZodOptional<z.ZodBoolean>;
         showEdges: z.ZodOptional<z.ZodBoolean>;
         showLabels: z.ZodOptional<z.ZodBoolean>;
@@ -498,4 +606,51 @@ export declare const PluginPresentationViewsUpdateSettingsResult: z.ZodObject<{
     id: z.ZodString;
 }, z.core.$strip>;
 export type PluginPresentationViewsUpdateSettingsResult = z.infer<typeof PluginPresentationViewsUpdateSettingsResult>;
+/**
+ * Arguments for {@linkcode PluginPresentationViewsApi.rename}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `id` | `string` | The id of the view to rename |
+ * | `name` | `string` | New display name (non-empty after trimming) |
+ */
+export declare const PluginPresentationViewsRenameArgs: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+}, z.core.$strip>;
+export type PluginPresentationViewsRenameArgs = z.infer<typeof PluginPresentationViewsRenameArgs>;
+/** Result of {@linkcode PluginPresentationViewsApi.rename} — the renamed view. */
+export declare const PluginPresentationViewsRenameResult: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    type: z.ZodEnum<{
+        "2d": "2d";
+        "3d": "3d";
+    }>;
+    isActive: z.ZodBoolean;
+    storey: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+export type PluginPresentationViewsRenameResult = z.infer<typeof PluginPresentationViewsRenameResult>;
+/**
+ * Arguments for {@linkcode PluginPresentationViewsApi.delete}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `id` | `string` | The id of the view to delete |
+ */
+export declare const PluginPresentationViewsDeleteArgs: z.ZodObject<{
+    id: z.ZodString;
+}, z.core.$strip>;
+export type PluginPresentationViewsDeleteArgs = z.infer<typeof PluginPresentationViewsDeleteArgs>;
+/**
+ * Result of {@linkcode PluginPresentationViewsApi.delete}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `id` | `string` | Id of the deleted view |
+ */
+export declare const PluginPresentationViewsDeleteResult: z.ZodObject<{
+    id: z.ZodString;
+}, z.core.$strip>;
+export type PluginPresentationViewsDeleteResult = z.infer<typeof PluginPresentationViewsDeleteResult>;
 //# sourceMappingURL=views.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"views.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/views.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;;;;;GAaG;AACH,8BAAsB,0BAA0B;;IAG9C;;;;;;;;;;;;;;;;;;OAkBG;aACa,IAAI,IAAI,eAAe,CAAC,iCAAiC,CAAC;IAE1E;;;;;;;;;;;;;;;OAeG;aACa,GAAG,CACjB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,gCAAgC,CAAC;IAEpD;;;;;;;;;;;;;;OAcG;aACa,SAAS,IAAI,eAAe,CAAC,gCAAgC,CAAC;IAE9E;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,OAAO,CAAC,OAAO,CAAC,EAAE;QAChC,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;QACvB,UAAU,CAAC,EAAE,MAAM,CAAA;KACpB,GAAG,eAAe,CAAC,oCAAoC,CAAC;IAEzD;;;;;;;;;;;;;;;;;;;OAmBG;aACa,SAAS,CACvB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,sCAAsC,CAAC;IAE1D;;;;;;;;;;;;;;;;;;;OAmBG;aACa,MAAM,CACpB,IAAI,CAAC,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;KAAE,GACvC,eAAe,CAAC,mCAAmC,CAAC;IAEvD;;;;;;;;;;;;;;;;;;OAkBG;aACa,WAAW,CACzB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,wCAAwC,CAAC;IAE5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;aACa,cAAc,CAC5B,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,OAAO,CAAC,8BAA8B,CAAC,GAChD,eAAe,CAAC,2CAA2C,CAAC;CAChE;AAED;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;EAAuB,CAAA;AAC9D,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;iBAKjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;GAMG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;;;iBAE5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B;;iBAEzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;kBACV,CAAA;AACnC,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED,uEAAuE;AACvE,eAAO,MAAM,6BAA6B;;;EAA0B,CAAA;AACpE,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,kCAAkC;;;;;;;iBAI7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED,yFAAyF;AACzF,eAAO,MAAM,sCAAsC;;iBAEjD,CAAA;AACF,MAAM,MAAM,sCAAsC,GAAG,CAAC,CAAC,KAAK,CAC1D,OAAO,sCAAsC,CAC9C,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,iCAAiC;;;;;;iBAG5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED,gFAAgF;AAChF,eAAO,MAAM,mCAAmC;;;;;;;;iBAAyB,CAAA;AACzE,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,+BAA+B;;;;2CAG1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,2BAA2B;;;;EAItC,CAAA;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;iBAOzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,sCAAsC;;iBAEjD,CAAA;AACF,MAAM,MAAM,sCAAsC,GAAG,CAAC,CAAC,KAAK,CAC1D,OAAO,sCAAsC,CAC9C,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,wCAAwC;;;;;;;;;;;;;;;kBACV,CAAA;AAC3C,MAAM,MAAM,wCAAwC,GAAG,CAAC,CAAC,KAAK,CAC5D,OAAO,wCAAwC,CAChD,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,yCAAyC;;;;;;;;;;;;;;;;;;iBAwBnD,CAAA;AACH,MAAM,MAAM,yCAAyC,GAAG,CAAC,CAAC,KAAK,CAC7D,OAAO,yCAAyC,CACjD,CAAA;AAED,+FAA+F;AAC/F,eAAO,MAAM,2CAA2C;;iBAEtD,CAAA;AACF,MAAM,MAAM,2CAA2C,GAAG,CAAC,CAAC,KAAK,CAC/D,OAAO,2CAA2C,CACnD,CAAA"}
+{"version":3,"file":"views.d.ts","sourceRoot":"","sources":["../../../src/api/presentation/views.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;;;;;;;GAeG;AACH,8BAAsB,0BAA0B;;IAG9C;;;;;;;;;;;;;;;;;;OAkBG;aACa,IAAI,IAAI,eAAe,CAAC,iCAAiC,CAAC;IAE1E;;;;;;;;;;;;;;;OAeG;aACa,GAAG,CACjB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,gCAAgC,CAAC;IAEpD;;;;;;;;;;;;;;OAcG;aACa,SAAS,IAAI,eAAe,CAAC,gCAAgC,CAAC;IAE9E;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,OAAO,CAAC,OAAO,CAAC,EAAE;QAChC,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;QACvB,UAAU,CAAC,EAAE,MAAM,CAAA;KACpB,GAAG,eAAe,CAAC,oCAAoC,CAAC;IAEzD;;;;;;;;;;;;;;;;;;;OAmBG;aACa,SAAS,CACvB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,sCAAsC,CAAC;IAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;aACa,MAAM,CACpB,IAAI,CAAC,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GACxD,eAAe,CAAC,mCAAmC,CAAC;IAEvD;;;;;;;;;;;;;;;;;;OAkBG;aACa,WAAW,CACzB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,wCAAwC,CAAC;IAE5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiEG;aACa,cAAc,CAC5B,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,OAAO,CAAC,8BAA8B,CAAC,GAChD,eAAe,CAAC,2CAA2C,CAAC;IAE/D;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,MAAM,CACpB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,mCAAmC,CAAC;IAEvD;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,MAAM,CACpB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,mCAAmC,CAAC;CACxD;AAED;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;EAAuB,CAAA;AAC9D,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;iBAMjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;GAMG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;;;;iBAE5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B;;iBAEzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;kBACV,CAAA;AACnC,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED,uEAAuE;AACvE,eAAO,MAAM,6BAA6B;;;EAA0B,CAAA;AACpE,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,kCAAkC;;;;;;;iBAI7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED,yFAAyF;AACzF,eAAO,MAAM,sCAAsC;;iBAEjD,CAAA;AACF,MAAM,MAAM,sCAAsC,GAAG,CAAC,CAAC,KAAK,CAC1D,OAAO,sCAAsC,CAC9C,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,iCAAiC;;;;;;;iBAI5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED,gFAAgF;AAChF,eAAO,MAAM,mCAAmC;;;;;;;;;iBAAyB,CAAA;AACzE,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,+BAA+B;;;;2CAG1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,2BAA2B;;;;EAItC,CAAA;AACF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,0BAA0B;;;EAAuC,CAAA;AAC9E,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;iBAQzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,sCAAsC;;iBAEjD,CAAA;AACF,MAAM,MAAM,sCAAsC,GAAG,CAAC,CAAC,KAAK,CAC1D,OAAO,sCAAsC,CAC9C,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,wCAAwC;;;;;;;;;;;;;;;;;;;kBACV,CAAA;AAC3C,MAAM,MAAM,wCAAwC,GAAG,CAAC,CAAC,KAAK,CAC5D,OAAO,wCAAwC,CAChD,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,yCAAyC;;;;;;;;;;;;;;;;;;;;;;iBA0BnD,CAAA;AACH,MAAM,MAAM,yCAAyC,GAAG,CAAC,CAAC,KAAK,CAC7D,OAAO,yCAAyC,CACjD,CAAA;AAED,+FAA+F;AAC/F,eAAO,MAAM,2CAA2C;;iBAEtD,CAAA;AACF,MAAM,MAAM,2CAA2C,GAAG,CAAC,CAAC,KAAK,CAC/D,OAAO,2CAA2C,CACnD,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,iCAAiC;;;iBAG5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED,kFAAkF;AAClF,eAAO,MAAM,mCAAmC;;;;;;;;;iBAAyB,CAAA;AACzE,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iCAAiC;;iBAE5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mCAAmC;;iBAE9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA"}

package/dist/api/program/areas.d.ts

@@ -26,9 +26,14 @@ import { ComponentHandle } from "../../handles";
  * PluginProgramAreasApi.update}); the two are the same ratio, one measured and
  * one intended. The surface speaks **FAR only** — there is no FSI alias.
  *
- * Reads return plain records and never throw. The only write —
- * {@linkcode PluginProgramAreasApi.update} — is a non-undoable settings write
- * for the FAR inputs.
+ * Reads return plain records and never throw. Because the engine only recomputes
+ * the breakdown live while the Area sidebar is open, a headless plugin should call
+ * {@linkcode PluginProgramAreasApi.refresh} first to guarantee the reads are fresh.
+ * The only write — {@linkcode PluginProgramAreasApi.update} — is a non-undoable
+ * settings write for the FAR inputs. With an active design option (proposal),
+ * those inputs are per-option: `update` writes and the reads report the active
+ * option's own target FAR / site area / deviation, matching the product's Area
+ * settings dialog.
  *
  * Accessed via `snaptrude.program.areas`.
  */
@@ -115,6 +120,13 @@ export declare abstract class PluginProgramAreasApi {
      * area, and the allowed deviation. This is a **non-undoable settings write**
      * (persisted with the project). `achievedFar` recomputes from these.
      *
+     * **Design options:** when a design option (proposal) is active, the FAR
+     * inputs are **scoped to that design option** — exactly like the product's
+     * Area settings dialog. `update` writes the active option's settings (each
+     * option keeps its own target FAR / site area / deviation) and the reads
+     * ({@linkcode PluginProgramAreasApi.get} etc.) report that same scope.
+     * Without design options there is a single project-wide set of FAR inputs.
+     *
      * @param options - Any of `targetFar`, `siteArea`, `deviation`; omitted fields
      *   are left unchanged.
      * @returns The recomputed {@linkcode PluginProgramAreaSummary}.
@@ -135,6 +147,33 @@ export declare abstract class PluginProgramAreasApi {
         siteArea?: number;
         deviation?: number;
     }): PluginApiReturn<PluginProgramAreasUpdateResult>;
+    /**
+     * Force the area breakdown to recompute, then return the fresh summary.
+     *
+     * The engine recomputes the carpet / built-up / FAR totals live **only while the
+     * Area sidebar is open**. A plugin running with the sidebar closed can therefore
+     * read a stale — or never-computed — snapshot from {@linkcode
+     * PluginProgramAreasApi.get} / {@linkcode PluginProgramAreasApi.list}. Call
+     * `refresh` first to guarantee those reads reflect the current model. It is a
+     * read (no write gate) — it recomputes derived totals, it does not change the model.
+     *
+     * **Cost:** a full pass over every space, floor and mass in the active structure.
+     * Not free on large models — call it once before a batch of reads, not per read.
+     *
+     * @returns The freshly-recomputed {@linkcode PluginProgramAreaSummary}.
+     *
+     * @examplePrompt Recompute the area totals before I read them
+     * @examplePrompt Refresh the FAR numbers
+     * @examplePrompt Make sure the area breakdown is up to date
+     *
+     * # Example
+     * ```ts
+     * const s = await snaptrude.program.areas.refresh()
+     * const { groups } = await snaptrude.program.areas.list("storeys") // now fresh
+     * console.log(s.builtUp, groups.length)
+     * ```
+     */
+    abstract refresh(): PluginApiReturn<PluginProgramAreasRefreshResult>;
 }
 /**
  * The whole-program area / FAR summary. All area figures are in `areaUnit`;
@@ -387,4 +426,25 @@ export declare const PluginProgramAreasUpdateResult: z.ZodObject<{
     }>;
 }, z.core.$strip>;
 export type PluginProgramAreasUpdateResult = z.infer<typeof PluginProgramAreasUpdateResult>;
+/**
+ * Result of {@linkcode PluginProgramAreasApi.refresh} — the freshly-recomputed
+ * program area summary.
+ */
+export declare const PluginProgramAreasRefreshResult: z.ZodObject<{
+    count: z.ZodNumber;
+    hiddenCount: z.ZodNumber;
+    carpet: z.ZodNumber;
+    builtUp: z.ZodNumber;
+    excluded: z.ZodNumber;
+    farBuiltUp: z.ZodNumber;
+    siteArea: z.ZodNumber;
+    achievedFar: z.ZodNullable<z.ZodNumber>;
+    targetFar: z.ZodNumber;
+    deviation: z.ZodNumber;
+    areaUnit: z.ZodEnum<{
+        ft2: "ft2";
+        m2: "m2";
+    }>;
+}, z.core.$strip>;
+export type PluginProgramAreasRefreshResult = z.infer<typeof PluginProgramAreasRefreshResult>;
 //# sourceMappingURL=areas.d.ts.map

package/dist/api/program/areas.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"areas.d.ts","sourceRoot":"","sources":["../../../src/api/program/areas.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAG7C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,8BAAsB,qBAAqB;;IAGzC;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,GAAG,IAAI,eAAe,CAAC,2BAA2B,CAAC;IAEnE;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,IAAI,CAClB,OAAO,EAAE,wBAAwB,EACjC,UAAU,CAAC,EAAE,MAAM,GAClB,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,WAAW,CACzB,OAAO,EAAE,wBAAwB,EACjC,OAAO,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,GAClB,eAAe,CAAC,mCAAmC,CAAC;IAEvD;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,MAAM,CACpB,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GACtE,eAAe,CAAC,8BAA8B,CAAC;CACnD;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;iBAYnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;iBAUjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;iBAQlC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E,6CAA6C;AAC7C,eAAO,MAAM,wBAAwB;;;;;;EAMnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E,kFAAkF;AAClF,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;iBAA2B,CAAA;AACnE,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;iBAOnC,CAAA;AACJ,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;iBAEvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;;;iBAQ1C,CAAA;AACJ,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;iBAE9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,4BAA4B;;;;iBAIvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;iBAA2B,CAAA;AACtE,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA"}
+{"version":3,"file":"areas.d.ts","sourceRoot":"","sources":["../../../src/api/program/areas.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAG7C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,8BAAsB,qBAAqB;;IAGzC;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,GAAG,IAAI,eAAe,CAAC,2BAA2B,CAAC;IAEnE;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,IAAI,CAClB,OAAO,EAAE,wBAAwB,EACjC,UAAU,CAAC,EAAE,MAAM,GAClB,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,WAAW,CACzB,OAAO,EAAE,wBAAwB,EACjC,OAAO,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,GAClB,eAAe,CAAC,mCAAmC,CAAC;IAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;aACa,MAAM,CAAC,OAAO,CAAC,EAAE;QAC/B,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,GAAG,eAAe,CAAC,8BAA8B,CAAC;IAEnD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,OAAO,IAAI,eAAe,CAAC,+BAA+B,CAAC;CAC5E;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;iBAYnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;iBAUjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;iBAQlC,CAAA;AACF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E,6CAA6C;AAC7C,eAAO,MAAM,wBAAwB;;;;;;EAMnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E,kFAAkF;AAClF,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;iBAA2B,CAAA;AACnE,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;iBAOnC,CAAA;AACJ,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;iBAEvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;;;iBAQ1C,CAAA;AACJ,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;iBAE9C,CAAA;AACF,MAAM,MAAM,mCAAmC,GAAG,CAAC,CAAC,KAAK,CACvD,OAAO,mCAAmC,CAC3C,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,4BAA4B;;;;iBAIvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;iBAA2B,CAAA;AACtE,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;iBAA2B,CAAA;AACvE,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA"}

package/dist/api/program/cores.d.ts

@@ -4,13 +4,9 @@ import { PluginApiReturn } from "../../types";
  * Program cores — the building's vertical-circulation cores (lift / stair / shaft
  * shells).
  *
- * Read the cores in the scene, test whether a space is a core, and trigger core
- * generation from a layout. `create` is a **thin trigger**: the program hands a
- * core layout to the core-generation engine, which authors the geometry — the
- * core geometry itself is owned by the geometry layer, not here (the exact
- * layout ↔ engine payload is coordinated with the geometry owner).
- *
- * `list`/`isCore` are reads; `create` triggers generation.
+ * Read the cores in the scene and test whether a space is a core. Both are reads;
+ * there is no core-generation trigger on this surface (core geometry is owned by
+ * the geometry layer, not here).
  *
  * Accessed via `snaptrude.program.cores`.
  */
@@ -49,33 +45,6 @@ export declare abstract class PluginProgramCoresApi {
      * ```
      */
     abstract isCore(id: string): PluginApiReturn<boolean>;
-    /**
-     * Generate core geometry from a layout (thin trigger).
-     *
-     * Hands the core layout to the core-generation engine and returns how many core
-     * elements were created. The geometry is authored by the engine, not here.
-     * _(Authored ahead — optional until the host's geometry adapter lands; the
-     * reads {@linkcode PluginProgramCoresApi.list}/{@linkcode PluginProgramCoresApi.isCore}
-     * are live.)_
-     *
-     * @param cores - The {@linkcode PluginProgramCoreSpec} layout of cores to
-     *   generate.
-     * @param lengthUnit - Unit of the spec dimensions (default project unit).
-     * @returns A {@linkcode PluginProgramCoresCreateResult} with the created count.
-     * @throws If the layout could not be realized.
-     *
-     * @examplePrompt Generate the building cores from this layout
-     * @examplePrompt Place the elevator and stair cores
-     * @examplePrompt Create the service core shells
-     *
-     * # Example
-     * ```ts
-     * await snaptrude.program.cores.create([
-     *   { type: "lift", position: { x: 0, y: 0, z: 0 }, width: 3, depth: 4 },
-     * ])
-     * ```
-     */
-    create?: (cores: PluginProgramCoreSpec[], lengthUnit?: "mm" | "m" | "ft") => PluginApiReturn<PluginProgramCoresCreateResult>;
 }
 /**
  * A circulation core element in the building.
@@ -106,69 +75,4 @@ export declare const PluginProgramCoresIsCoreArgs: z.ZodObject<{
     id: z.ZodString;
 }, z.core.$strip>;
 export type PluginProgramCoresIsCoreArgs = z.infer<typeof PluginProgramCoresIsCoreArgs>;
-/**
- * One core to generate. The geometry layer interprets this layout (the exact
- * fields are coordinated with the geometry owner).
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `type` | `string \| undefined` | Core kind (e.g. `"lift"`, `"stair"`, `"shaft"`) |
- * | `position` | `{ x; y; z }` | Base position of the core |
- * | `width` | `number` | Core width, in `lengthUnit` |
- * | `depth` | `number` | Core depth, in `lengthUnit` |
- * | `fromStorey` | `number \| undefined` | First storey the core spans |
- * | `toStorey` | `number \| undefined` | Last storey the core spans |
- */
-export declare const PluginProgramCoreSpec: z.ZodObject<{
-    type: z.ZodOptional<z.ZodString>;
-    position: z.ZodObject<{
-        x: z.ZodNumber;
-        y: z.ZodNumber;
-        z: z.ZodNumber;
-    }, z.core.$strip>;
-    width: z.ZodNumber;
-    depth: z.ZodNumber;
-    fromStorey: z.ZodOptional<z.ZodNumber>;
-    toStorey: z.ZodOptional<z.ZodNumber>;
-}, z.core.$strip>;
-export type PluginProgramCoreSpec = z.infer<typeof PluginProgramCoreSpec>;
-/**
- * Arguments for {@linkcode PluginProgramCoresApi.create}.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `cores` | {@linkcode PluginProgramCoreSpec}`[]` | The cores to generate |
- * | `lengthUnit` | `"mm" \| "m" \| "ft" \| undefined` | Unit of the spec dimensions (default project unit) |
- */
-export declare const PluginProgramCoresCreateArgs: z.ZodObject<{
-    cores: z.ZodArray<z.ZodObject<{
-        type: z.ZodOptional<z.ZodString>;
-        position: z.ZodObject<{
-            x: z.ZodNumber;
-            y: z.ZodNumber;
-            z: z.ZodNumber;
-        }, z.core.$strip>;
-        width: z.ZodNumber;
-        depth: z.ZodNumber;
-        fromStorey: z.ZodOptional<z.ZodNumber>;
-        toStorey: z.ZodOptional<z.ZodNumber>;
-    }, z.core.$strip>>;
-    lengthUnit: z.ZodOptional<z.ZodEnum<{
-        ft: "ft";
-        m: "m";
-        mm: "mm";
-    }>>;
-}, z.core.$strip>;
-export type PluginProgramCoresCreateArgs = z.infer<typeof PluginProgramCoresCreateArgs>;
-/**
- * Result of {@linkcode PluginProgramCoresApi.create}.
- *
- * | Property | Type | Description |
- * |---|---|---|
- * | `createdCount` | `number` | Number of core elements created |
- */
-export declare const PluginProgramCoresCreateResult: z.ZodObject<{
-    createdCount: z.ZodNumber;
-}, z.core.$strip>;
-export type PluginProgramCoresCreateResult = z.infer<typeof PluginProgramCoresCreateResult>;
 //# sourceMappingURL=cores.d.ts.map

package/dist/api/program/cores.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cores.d.ts","sourceRoot":"","sources":["../../../src/api/program/cores.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;;;;;GAaG;AACH,8BAAsB,qBAAqB;;IAGzC;;;;;;;;;;;;;;;OAeG;aACa,IAAI,IAAI,eAAe,CAAC,4BAA4B,CAAC;IAErE;;;;;;;;;;;;;;OAcG;aACa,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC;IAE5D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,MAAM,CAAC,EAAE,CACd,KAAK,EAAE,qBAAqB,EAAE,EAC9B,UAAU,CAAC,EAAE,IAAI,GAAG,GAAG,GAAG,IAAI,KAC3B,eAAe,CAAC,8BAA8B,CAAC,CAAA;CACrD;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB;;;;iBAI5B,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAEjE,wDAAwD;AACxD,eAAO,MAAM,4BAA4B;;;;;;iBAEvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED,8DAA8D;AAC9D,eAAO,MAAM,4BAA4B;;iBAEvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;iBAOhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;GAOG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;iBAGvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B;;iBAEzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA"}
+{"version":3,"file":"cores.d.ts","sourceRoot":"","sources":["../../../src/api/program/cores.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;GASG;AACH,8BAAsB,qBAAqB;;IAGzC;;;;;;;;;;;;;;;OAeG;aACa,IAAI,IAAI,eAAe,CAAC,4BAA4B,CAAC;IAErE;;;;;;;;;;;;;;OAcG;aACa,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC;CAC7D;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB;;;;iBAI5B,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAEjE,wDAAwD;AACxD,eAAO,MAAM,4BAA4B;;;;;;iBAEvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED,8DAA8D;AAC9D,eAAO,MAAM,4BAA4B;;iBAEvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA"}

package/dist/api/program/index.d.ts

@@ -23,7 +23,7 @@ import { PluginProgramAreasApi } from "./areas";
  * - {@linkcode PluginProgramApi.areas} — FAR / built-up-area rollup and groupings
  * - {@linkcode PluginProgramApi.spreadsheet} — Render program data to sheets and read it back
  * - {@linkcode PluginProgramApi.site} — Read the site/plot planning context
- * - {@linkcode PluginProgramApi.cores} — Read & trigger vertical-circulation cores
+ * - {@linkcode PluginProgramApi.cores} — Read & predicate vertical-circulation cores (reads only)
  * - {@linkcode PluginProgramApi.classification} — Classification catalog + display tags
  *
  * Accessed via `snaptrude.program`.
@@ -43,7 +43,7 @@ export declare abstract class PluginProgramApi {
     abstract spreadsheet: PluginProgramSpreadsheetApi;
     /** Site/plot planning context — total area, parcel footprints, geo rings. See {@linkcode PluginProgramSiteApi}. */
     abstract site: PluginProgramSiteApi;
-    /** Vertical-circulation cores — read & predicate (live); generation trigger is optional. See {@linkcode PluginProgramCoresApi}. */
+    /** Vertical-circulation cores — read & predicate (reads only). See {@linkcode PluginProgramCoresApi}. */
     abstract cores: PluginProgramCoresApi;
     /** Classification catalog (space/area/mass types) + display tags. See {@linkcode PluginProgramClassificationApi}. */
     abstract classification: PluginProgramClassificationApi;

package/dist/api/program/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/program/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAA;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAA;AACvD,OAAO,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AACjD,OAAO,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAA;AACnD,OAAO,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAA;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAC/C,OAAO,EAAE,8BAA8B,EAAE,MAAM,kBAAkB,CAAA;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,8BAAsB,gBAAgB;IACpC,wHAAwH;IACxH,SAAgB,WAAW,EAAE,2BAA2B,CAAA;IACxD,4GAA4G;IAC5G,SAAgB,SAAS,EAAE,yBAAyB,CAAA;IACpD,sGAAsG;IACtG,SAAgB,MAAM,EAAE,sBAAsB,CAAA;IAC9C,iGAAiG;IACjG,SAAgB,OAAO,EAAE,uBAAuB,CAAA;IAChD,uFAAuF;IACvF,SAAgB,KAAK,EAAE,qBAAqB,CAAA;IAC5C,2HAA2H;IAC3H,SAAgB,WAAW,EAAE,2BAA2B,CAAA;IACxD,mHAAmH;IACnH,SAAgB,IAAI,EAAE,oBAAoB,CAAA;IAC1C,mIAAmI;IACnI,SAAgB,KAAK,EAAE,qBAAqB,CAAA;IAC5C,qHAAqH;IACrH,SAAgB,cAAc,EAAE,8BAA8B,CAAA;;CAG/D;AAED,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,eAAe,CAAA;AAC7B,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,kBAAkB,CAAA;AAChC,cAAc,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/program/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAA;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAA;AACvD,OAAO,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AACjD,OAAO,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAA;AACnD,OAAO,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAA;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAC/C,OAAO,EAAE,8BAA8B,EAAE,MAAM,kBAAkB,CAAA;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,8BAAsB,gBAAgB;IACpC,wHAAwH;IACxH,SAAgB,WAAW,EAAE,2BAA2B,CAAA;IACxD,4GAA4G;IAC5G,SAAgB,SAAS,EAAE,yBAAyB,CAAA;IACpD,sGAAsG;IACtG,SAAgB,MAAM,EAAE,sBAAsB,CAAA;IAC9C,iGAAiG;IACjG,SAAgB,OAAO,EAAE,uBAAuB,CAAA;IAChD,uFAAuF;IACvF,SAAgB,KAAK,EAAE,qBAAqB,CAAA;IAC5C,2HAA2H;IAC3H,SAAgB,WAAW,EAAE,2BAA2B,CAAA;IACxD,mHAAmH;IACnH,SAAgB,IAAI,EAAE,oBAAoB,CAAA;IAC1C,yGAAyG;IACzG,SAAgB,KAAK,EAAE,qBAAqB,CAAA;IAC5C,qHAAqH;IACrH,SAAgB,cAAc,EAAE,8BAA8B,CAAA;;CAG/D;AAED,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,eAAe,CAAA;AAC7B,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,kBAAkB,CAAA;AAChC,cAAc,SAAS,CAAA"}