@snaptrude/plugin-core 0.6.0 → 0.7.1

package/dist/api/design/update/index.d.ts

@@ -2,6 +2,7 @@ import * as z from "zod";
 import { PluginApiReturn } from "../../../types";
 import { ComponentHandle } from "../../../handles";
 import { PluginSpaceUpdateResult } from "../../entity/space";
+import { PluginDesignChangeResult } from "../lock";
 /**
  * Sparse property updates for a space. Only provided fields change.
  *
@@ -109,6 +110,89 @@ export declare const PluginUpdateSpaceItem: z.ZodObject<{
     }, z.core.$strip>>;
 }, z.core.$strip>;
 export type PluginUpdateSpaceItem = z.infer<typeof PluginUpdateSpaceItem>;
+/**
+ * Wire schema for {@linkcode PluginDesignUpdateApi.setLabel}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `component` | `ComponentHandle` | The component to relabel |
+ * | `label` | `string` | New label (non-empty after trimming) |
+ */
+export declare const PluginDesignSetLabelArgs: z.ZodObject<{
+    component: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+    label: z.ZodString;
+}, z.core.$strip>;
+export type PluginDesignSetLabelArgs = z.infer<typeof PluginDesignSetLabelArgs>;
+/**
+ * Sparse parametric updates for a staircase (all fields optional; at least one
+ * required). Only the fields you provide change. Consumed by
+ * {@linkcode PluginDesignUpdateApi.staircase}; the paired read is
+ * `design.query.getStaircaseParams`.
+ *
+ * All dimensions are in **engine units** (the same convention as
+ * `design.doors.setWidth`); `steps` is a unitless integer count. Height, riser,
+ * and step count are **coupled** (`staircaseHeight = steps × riser`); the two
+ * lock booleans govern which value recomputes — see the method JSDoc.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `isStoreyHeightUnlocked` | `boolean`? | Unlock the staircase height from the storey height |
+ * | `isStaircaseHeightUnlocked` | `boolean`? | Unlock the height from `steps × riser` |
+ * | `storeyHeight` | `number`? | Storey height the stair sits within (engine units) |
+ * | `staircaseHeight` | `number`? | Total rise (engine units) |
+ * | `steps` | `number`? | Step count (unitless integer) |
+ * | `riser` | `number`? | Riser height (engine units) |
+ * | `tread` | `number`? | Tread depth (engine units) |
+ * | `width` | `number`? | Flight width (engine units) |
+ * | `depth` | `number`? | Slab/waist thickness (engine units) |
+ * | `wellSize` | `number`? | Stairwell gap (dogLegged / openWell / square) |
+ * | `flightStartDistAfterTurn` | `number`? | Flight offset after a turn (dogLegged / lShaped / square) |
+ * | `landingWidth` | `number`? | Landing depth (straight / dogLegged) |
+ * | `baseOffset` | `number`? | Vertical offset from the storey base (engine units) |
+ */
+export declare const PluginStaircaseParamUpdates: z.ZodObject<{
+    isStoreyHeightUnlocked: z.ZodOptional<z.ZodBoolean>;
+    isStaircaseHeightUnlocked: z.ZodOptional<z.ZodBoolean>;
+    storeyHeight: z.ZodOptional<z.ZodNumber>;
+    staircaseHeight: z.ZodOptional<z.ZodNumber>;
+    steps: z.ZodOptional<z.ZodNumber>;
+    riser: z.ZodOptional<z.ZodNumber>;
+    tread: z.ZodOptional<z.ZodNumber>;
+    width: z.ZodOptional<z.ZodNumber>;
+    depth: z.ZodOptional<z.ZodNumber>;
+    wellSize: z.ZodOptional<z.ZodNumber>;
+    flightStartDistAfterTurn: z.ZodOptional<z.ZodNumber>;
+    landingWidth: z.ZodOptional<z.ZodNumber>;
+    baseOffset: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type PluginStaircaseParamUpdates = z.infer<typeof PluginStaircaseParamUpdates>;
+/**
+ * Arguments for {@linkcode PluginDesignUpdateApi.staircase}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `staircases` | {@linkcode ComponentHandle}`[]` | The staircases to update |
+ * | `params` | {@linkcode PluginStaircaseParamUpdates} | Sparse parametric changes (≥ 1 field) |
+ */
+export declare const PluginDesignUpdateStaircaseArgs: z.ZodObject<{
+    staircases: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+    params: z.ZodObject<{
+        isStoreyHeightUnlocked: z.ZodOptional<z.ZodBoolean>;
+        isStaircaseHeightUnlocked: z.ZodOptional<z.ZodBoolean>;
+        storeyHeight: z.ZodOptional<z.ZodNumber>;
+        staircaseHeight: z.ZodOptional<z.ZodNumber>;
+        steps: z.ZodOptional<z.ZodNumber>;
+        riser: z.ZodOptional<z.ZodNumber>;
+        tread: z.ZodOptional<z.ZodNumber>;
+        width: z.ZodOptional<z.ZodNumber>;
+        depth: z.ZodOptional<z.ZodNumber>;
+        wellSize: z.ZodOptional<z.ZodNumber>;
+        flightStartDistAfterTurn: z.ZodOptional<z.ZodNumber>;
+        landingWidth: z.ZodOptional<z.ZodNumber>;
+        baseOffset: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type PluginDesignUpdateStaircaseArgs = z.infer<typeof PluginDesignUpdateStaircaseArgs>;
 /**
  * `snaptrude.design.update` — edit existing scene entities (properties + geometry).
  *
@@ -117,6 +201,45 @@ export type PluginUpdateSpaceItem = z.infer<typeof PluginUpdateSpaceItem>;
  */
 export declare abstract class PluginDesignUpdateApi {
     constructor();
+    /**
+     * Set a component's **Label** — the same editable Label field the properties
+     * panel shows (doors, windows, furniture, spaces, and every other labelled
+     * component). The paired read is `design.query.getLabel`. Undoable; the
+     * canvas label text updates immediately.
+     *
+     * Strictly **per component**: labelling one door of a placed family never
+     * touches its sibling doors (the panel's Label edit, by contrast, applies to
+     * the whole family). On **legacy masses** without a space type, panel parity
+     * applies — a label matching a room-type preset with a height can also
+     * adjust the mass's height and material, exactly like typing it in the panel.
+     *
+     * Throws when the component is locked, the handle is gone/forged, the label
+     * is empty, or the component has no mesh to label. Re-applying the current
+     * label is a no-op that returns `true` without touching the undo stack.
+     *
+     * @param component - The component to relabel
+     * @param label - New label text (non-empty; leading/trailing whitespace trimmed)
+     * @returns `true` once the label is applied
+     *
+     * @examplePrompt Rename this door to D-101
+     * @examplePrompt Number all doors on storey 2 with a D-2-XX tag
+     * @examplePrompt Set the selected window's label to W-04
+     * @examplePrompt Tag every door with its fire rating
+     *
+     * # Example
+     * ```ts
+     * // Door tag numbering: label every door as D-<storey>-<n>, numbered per storey
+     * await snaptrude.design.selection.setByFilter({ types: ["door"] })
+     * const doors = await snaptrude.design.selection.get()
+     * const counts = {}
+     * for (const door of doors) {
+     *   const { storey = 0 } = await snaptrude.design.query.getProperties(door)
+     *   counts[storey] = (counts[storey] ?? 0) + 1
+     *   await snaptrude.design.update.setLabel(door, `D-${storey}-${String(counts[storey]).padStart(2, "0")}`)
+     * }
+     * ```
+     */
+    abstract setLabel(component: ComponentHandle, label: string): PluginApiReturn<boolean>;
     /**
      * Update a single space (room) — change its properties (room label, space
      * type, mass type, area class, department) and/or replace its geometry by
@@ -174,5 +297,50 @@ export declare abstract class PluginDesignUpdateApi {
      * ```
      */
     abstract spaces(items: PluginUpdateSpaceItem[]): PluginApiReturn<PluginSpaceUpdateResult[]>;
+    /**
+     * Update the parameters of one or more staircases — riser, tread, width,
+     * depth, step count, total height, well size, landing depth, base offset,
+     * and the two height locks — in one undoable operation. Sparse: only the
+     * fields you provide change. The paired read is
+     * `design.query.getStaircaseParams`.
+     *
+     * All dimensions are in **engine units** (the same convention as
+     * `design.doors.setWidth`); `steps` is a unitless integer count. The height,
+     * riser, and step count are **coupled** — `staircaseHeight = steps × riser` —
+     * and the two lock booleans govern which value recomputes when another
+     * changes. With `isStoreyHeightUnlocked` false the staircase height follows
+     * the storey height; unlocking it also unlocks the staircase height. Setting
+     * `steps` recomputes `riser` (or the height, once the height is unlocked),
+     * and setting `riser` recomputes `steps`/height in turn.
+     *
+     * Presets-only: this edits the parametric fields of a preset staircase; it
+     * does not change the staircase's type/preset (there is no in-place re-type).
+     * Every edit rebuilds the staircase geometry, so the call is async.
+     *
+     * Throws when a handle is not a staircase, when a staircase is locked, or
+     * when a value falls outside the engine's accepted range (RPC rejects).
+     *
+     * @param staircases - the staircases to update
+     * @param params - sparse {@linkcode PluginStaircaseParamUpdates} (at least one field)
+     * @returns the affected staircases
+     *
+     * @examplePrompt Set the riser of this staircase to 165mm
+     * @examplePrompt Change all the stairs to 14 steps
+     * @examplePrompt Make the selected staircase 1200 wide with a 280 tread
+     * @examplePrompt Widen every staircase on level 1 to 1 metre
+     * @examplePrompt Unlock the height and set this stair to 3200 tall
+     *
+     * # Example
+     * ```ts
+     * // Give every ground-floor staircase a common riser + tread (engine units)
+     * const stairs = await snaptrude.design.query.listStaircases({ storeys: [1] })
+     * const { affected } = await snaptrude.design.update.staircase(stairs, {
+     *   riser: 165,
+     *   tread: 280,
+     * })
+     * console.log("updated", affected.length, "staircases")
+     * ```
+     */
+    abstract staircase(staircases: ComponentHandle[], params: PluginStaircaseParamUpdates): PluginApiReturn<PluginDesignChangeResult>;
 }
 //# sourceMappingURL=index.d.ts.map

package/dist/api/design/update/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/design/update/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAiB,MAAM,kBAAkB,CAAA;AACjE,OAAO,EAKL,uBAAuB,EACxB,MAAM,oBAAoB,CAAA;AAE3B;;;;;;;;;;GAUG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAMrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF,+DAA+D;AAC/D,eAAO,MAAM,yBAAyB;;;iBAGpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAEjF,wEAAwE;AACxE,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAIhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;GAKG;AACH,8BAAsB,qBAAqB;;IAGzC;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,KAAK,CACnB,KAAK,EAAE,eAAe,EACtB,OAAO,EAAE;QACP,UAAU,CAAC,EAAE,0BAA0B,CAAA;QACvC,QAAQ,CAAC,EAAE,yBAAyB,CAAA;KACrC,GACA,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;aACa,MAAM,CAAC,KAAK,EAAE,qBAAqB,EAAE,GAAG,eAAe,CAAC,uBAAuB,EAAE,CAAC;CACnG"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/design/update/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAiB,MAAM,kBAAkB,CAAA;AACjE,OAAO,EAKL,uBAAuB,EACxB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAElD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAMrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF,+DAA+D;AAC/D,eAAO,MAAM,yBAAyB;;;iBAGpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAEjF,wEAAwE;AACxE,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAIhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB;;;iBAGnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;iBAmBpC,CAAA;AACJ,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAA;AAErF;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;iBAG1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AAE7F;;;;;GAKG;AACH,8BAAsB,qBAAqB;;IAGzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;aACa,QAAQ,CAAC,SAAS,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC;IAE7F;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,KAAK,CACnB,KAAK,EAAE,eAAe,EACtB,OAAO,EAAE;QACP,UAAU,CAAC,EAAE,0BAA0B,CAAA;QACvC,QAAQ,CAAC,EAAE,yBAAyB,CAAA;KACrC,GACA,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;aACa,MAAM,CAAC,KAAK,EAAE,qBAAqB,EAAE,GAAG,eAAe,CAAC,uBAAuB,EAAE,CAAC;IAElG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;aACa,SAAS,CACvB,UAAU,EAAE,eAAe,EAAE,EAC7B,MAAM,EAAE,2BAA2B,GAClC,eAAe,CAAC,wBAAwB,CAAC;CAC7C"}

package/dist/api/design/windows/index.d.ts

@@ -2,13 +2,20 @@ import * as z from "zod";
 import { PluginApiReturn } from "../../../types";
 import { ComponentHandle } from "../../../handles";
 import { PluginDesignChangeResult } from "../lock";
+import { PluginObjectCatalogGroup, PluginObjectCatalogItem } from "../doors";
 /**
  * `snaptrude.design.windows` — window-specific reads. Creation lives at
  * `design.create.window`; generic reads (`listWindows`/`getHost`/`getProperties`) live
  * at `design.query.*`. Window targets are {@linkcode ComponentHandle}s.
  *
- * `listTypes` (UI-const catalog), `getSillHeight` (bounds-derived), and the
- * command-wired `mirror` land in a later pass.
+ * The **catalog** reads (`listCatalogGroups`/`listCatalog`/`getCatalogItem`/`exists`)
+ * browse the placeable window library — plain value records keyed by a library id
+ * (team `_id` or general `fullName`), NOT handles — and feed `design.create.window`.
+ * They are network-backed but carry no `Async` suffix (§6.6) and never throw
+ * (`[]`/`null`). The {@linkcode PluginObjectCatalogGroup} / {@linkcode PluginObjectCatalogItem}
+ * DTOs are shared with `design.doors` (defined there, re-exported here).
+ *
+ * `getSillHeight` (bounds-derived) and the command-wired `mirror` land in a later pass.
  */
 export declare abstract class PluginDesignWindowsApi {
     constructor();
@@ -133,6 +140,83 @@ export declare abstract class PluginDesignWindowsApi {
      * ```
      */
     abstract setHeight(window: ComponentHandle, height: number): PluginApiReturn<PluginDesignChangeResult>;
+    /**
+     * List the window catalog **groups** — the placement families (Fixed,
+     * Casement, Sliding, Folding, …), built-in groups merged with any
+     * team-custom types.
+     *
+     * @returns The groups as {@linkcode PluginObjectCatalogGroup}`[]` (`[]` when empty)
+     *
+     * @examplePrompt What kinds of windows can I place?
+     * @examplePrompt List the window groups in the catalog
+     * @examplePrompt Show me the window families available in this project
+     * @examplePrompt Which window types does this project support?
+     *
+     * # Example
+     * ```ts
+     * const groups = await snaptrude.design.windows.listCatalogGroups()
+     * for (const g of groups) console.log(g.dbType, g.label, g.source)
+     * ```
+     */
+    abstract listCatalogGroups(): PluginApiReturn<PluginObjectCatalogGroup[]>;
+    /**
+     * List the placeable window catalog (team + general libraries), optionally
+     * restricted to one group by its `dbType` token.
+     *
+     * @param group Restrict to one group's `dbType` (optional; e.g. `"casementDouble"`)
+     * @returns The catalog as {@linkcode PluginObjectCatalogItem}`[]` (`[]` when empty)
+     *
+     * @examplePrompt What windows can I place in this project?
+     * @examplePrompt List every window in the library
+     * @examplePrompt Show me the casement windows I can add
+     * @examplePrompt Browse the window catalog
+     *
+     * # Example
+     * ```ts
+     * const [group] = await snaptrude.design.windows.listCatalogGroups()
+     * const items = await snaptrude.design.windows.listCatalog(group?.dbType)
+     * for (const item of items) console.log(item.id, item.name, item.thumbnailUrl)
+     * ```
+     */
+    abstract listCatalog(group?: string): PluginApiReturn<PluginObjectCatalogItem[]>;
+    /**
+     * Get a single window catalog item by its library id.
+     *
+     * @param id The catalog library id
+     * @returns The item, or `null` if no catalog item matches
+     *
+     * @examplePrompt Get the details of this window from the library
+     * @examplePrompt Look up the catalog entry for this window id
+     * @examplePrompt What is the cost of this window item?
+     * @examplePrompt Show me the family name of this window in the catalog
+     *
+     * # Example
+     * ```ts
+     * const [entry] = await snaptrude.design.windows.listCatalog()
+     * const item = await snaptrude.design.windows.getCatalogItem(entry.id)
+     * if (item) console.log(item.name, item.source, item.dbType)
+     * ```
+     */
+    abstract getCatalogItem(id: string): PluginApiReturn<PluginObjectCatalogItem | null>;
+    /**
+     * Test whether a window catalog item exists for the given library id.
+     *
+     * @param id The catalog library id
+     * @returns `true` if it exists, otherwise `false`
+     *
+     * @examplePrompt Is this window still in the library?
+     * @examplePrompt Check whether a window catalog item with this id exists
+     * @examplePrompt Does my team library have this window?
+     * @examplePrompt Verify the window is available before placing it
+     *
+     * # Example
+     * ```ts
+     * const [entry] = await snaptrude.design.windows.listCatalog()
+     * const stillAvailable = await snaptrude.design.windows.exists(entry.id)
+     * console.log(stillAvailable ? "safe to place" : "removed from library")
+     * ```
+     */
+    abstract exists(id: string): PluginApiReturn<boolean>;
 }
 /**
  * Arguments for the single-window read methods.
@@ -186,4 +270,31 @@ export declare const PluginDesignWindowSetHeightArgs: z.ZodObject<{
     height: z.ZodNumber;
 }, z.core.$strip>;
 export type PluginDesignWindowSetHeightArgs = z.infer<typeof PluginDesignWindowSetHeightArgs>;
+export { PluginObjectCatalogGroup, PluginObjectCatalogItem };
+/**
+ * Arguments for {@linkcode PluginDesignWindowsApi.listCatalog}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `group` | `string`? | Restrict to one group's `dbType` token (optional) |
+ */
+export declare const PluginDesignWindowListCatalogArgs: z.ZodObject<{
+    group: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type PluginDesignWindowListCatalogArgs = z.infer<typeof PluginDesignWindowListCatalogArgs>;
+/**
+ * Arguments for {@linkcode PluginDesignWindowsApi.getCatalogItem} / {@linkcode PluginDesignWindowsApi.exists}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `id` | `string` | The catalog library id |
+ */
+export declare const PluginDesignWindowGetCatalogItemArgs: z.ZodObject<{
+    id: z.ZodString;
+}, z.core.$strip>;
+export type PluginDesignWindowGetCatalogItemArgs = z.infer<typeof PluginDesignWindowGetCatalogItemArgs>;
+export declare const PluginDesignWindowExistsArgs: z.ZodObject<{
+    id: z.ZodString;
+}, z.core.$strip>;
+export type PluginDesignWindowExistsArgs = z.infer<typeof PluginDesignWindowExistsArgs>;
 //# sourceMappingURL=index.d.ts.map

package/dist/api/design/windows/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/design/windows/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAElD;;;;;;;GAOG;AACH,8BAAsB,sBAAsB;;IAG1C;;;;;;;;;;;;;;;;;;OAkBG;aACa,OAAO,CAAC,MAAM,EAAE,eAAe,GAAG,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC;IAEhF;;;;;;;;;;;;;;;;;OAiBG;aACa,QAAQ,CAAC,MAAM,EAAE,eAAe,GAAG,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC;IAEjF;;;;;;;;;;;;;;;;;OAiBG;aACa,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC;IAElF;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,aAAa,CAC3B,MAAM,EAAE,eAAe,GACtB,eAAe,CAAC,sBAAsB,GAAG,IAAI,CAAC;IAEjD;;;;;;;;;;;;;;;;;;;OAmBG;aACa,QAAQ,CACtB,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,MAAM,GACZ,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;OAkBG;aACa,SAAS,CACvB,MAAM,EAAE,eAAe,EACvB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,wBAAwB,CAAC;CAC7C;AAED;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;iBAEjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;;GAQG;AACH,eAAO,MAAM,sBAAsB;;;;iBAIjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,8BAA8B;;;iBAGzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAA;AAE3F;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B;;;iBAG1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/design/windows/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAClD,OAAO,EAAE,wBAAwB,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAA;AAE5E;;;;;;;;;;;;;GAaG;AACH,8BAAsB,sBAAsB;;IAG1C;;;;;;;;;;;;;;;;;;OAkBG;aACa,OAAO,CAAC,MAAM,EAAE,eAAe,GAAG,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC;IAEhF;;;;;;;;;;;;;;;;;OAiBG;aACa,QAAQ,CAAC,MAAM,EAAE,eAAe,GAAG,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC;IAEjF;;;;;;;;;;;;;;;;;OAiBG;aACa,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC;IAElF;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,aAAa,CAC3B,MAAM,EAAE,eAAe,GACtB,eAAe,CAAC,sBAAsB,GAAG,IAAI,CAAC;IAEjD;;;;;;;;;;;;;;;;;;;OAmBG;aACa,QAAQ,CACtB,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,MAAM,GACZ,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;OAkBG;aACa,SAAS,CACvB,MAAM,EAAE,eAAe,EACvB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;OAiBG;aACa,iBAAiB,IAAI,eAAe,CAAC,wBAAwB,EAAE,CAAC;IAEhF;;;;;;;;;;;;;;;;;;OAkBG;aACa,WAAW,CACzB,KAAK,CAAC,EAAE,MAAM,GACb,eAAe,CAAC,uBAAuB,EAAE,CAAC;IAE7C;;;;;;;;;;;;;;;;;OAiBG;aACa,cAAc,CAC5B,EAAE,EAAE,MAAM,GACT,eAAe,CAAC,uBAAuB,GAAG,IAAI,CAAC;IAElD;;;;;;;;;;;;;;;;;OAiBG;aACa,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC;CAC7D;AAED;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB;;iBAEjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;;GAQG;AACH,eAAO,MAAM,sBAAsB;;;;iBAIjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,8BAA8B;;;iBAGzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAA;AAE3F;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B;;;iBAG1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AAO7F,OAAO,EAAE,wBAAwB,EAAE,uBAAuB,EAAE,CAAA;AAE5D;;;;;;GAMG;AACH,eAAO,MAAM,iCAAiC;;iBAE5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAA;AAEjG;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oCAAoC,CAAC,CAAA;AAEvG,eAAO,MAAM,4BAA4B;;iBAAuC,CAAA;AAChF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA"}

package/dist/api/entity/story.d.ts

@@ -1,5 +1,6 @@
 import * as z from "zod";
 import { PluginApiReturn } from "../../types";
+import { ComponentHandle } from "../../handles";
 /**
  * Story (floor/storey) management.
  *
@@ -90,17 +91,25 @@ export declare abstract class PluginStoryApi {
      */
     abstract create(storyValue: number, height?: number): PluginApiReturn<PluginStoryCreateResult>;
     /**
-     * Update a story's height.
+     * Update a story's floor-to-floor height, cascading the full geometry change.
      *
-     * Changes the floor-to-floor height of the specified story. This
-     * operation is undoable.
+     * This is the same operation as editing the height in the Stories panel: the
+     * walls, columns, and masses on the story are **stretched** to the new height,
+     * every story **above shifts up/down** by the delta so the stack stays
+     * contiguous, and coupled elements (staircases, parametric curtain walls,
+     * furniture offsets) are re-fitted. The whole cascade is committed as **one
+     * undo step**. Height-locked elements are left untouched.
      *
      * @param storyValue - Integer storey number
      *   identifying the story to update
-     * @param height - New height value in Babylon
-     *   units
+     * @param height - New floor-to-floor height in
+     *   Babylon units
      * @returns A {@linkcode PluginStoryUpdateResult} with the updated `storyValue` and `height`
-     * @throws If the story does not exist or the update fails
+     * @throws `PRECONDITION_FAILED` if no story has the given value;
+     *   `STORY_HEIGHT_REJECTED` if the engine rejects the height (e.g. out of
+     *   range — the change silently reverts host-side and is surfaced as this
+     *   error); `STORY_UPDATE_FAILED` if the story cannot be re-read after the
+     *   update
      *
      * @examplePrompt Change the ground floor height to 3.5 metres
      * @examplePrompt Make the second storey taller
@@ -109,11 +118,59 @@ export declare abstract class PluginStoryApi {
      *
      * # Example
      * ```ts
-     * // Set ground floor height to 5 Babylon units
+     * // Set ground floor height to 5 Babylon units — walls stretch and the
+     * // floors above move up to match, all in a single undo step.
      * const result = await snaptrude.entity.story.update(1, 5)
      * ```
      */
     abstract update(storyValue: number, height: number): PluginApiReturn<PluginStoryUpdateResult>;
+    /**
+     * Duplicate a story into the adjacent level, up or down.
+     *
+     * By default the **whole story** is duplicated: every eligible element on the
+     * active story (walls, floors, roofs, masses, columns, beams, staircases,
+     * ceilings, parametric curtain walls, and furniture) is copied into the story
+     * one level `"up"` or `"down"`. Pass `options.components` to duplicate only a
+     * subset instead. The target story is **created automatically** if it does not
+     * yet exist, inheriting the source story's height.
+     *
+     * Copies are **instanced** by default (`unique: false`) — they share geometry
+     * with the source, so later edits propagate. Set `unique: true` for independent
+     * geometry. Doors and windows are never duplicated on their own; they ride along
+     * with their host wall. Locked, throw-away, and unsupported elements are skipped
+     * and counted in `skipped`. The whole operation is a single undo step.
+     *
+     * @param direction - `"up"` to duplicate into the story above, `"down"` for below
+     * @param options - `components` (restrict to a subset of the story's elements;
+     *   omit for the whole story) and `unique` (default `false` = instanced copies;
+     *   `true` = independent geometry)
+     * @returns A {@linkcode PluginStoryDuplicateResult} with the `sourceStory`, the
+     *   `targetStories` the copies landed on, the `created` component handles, the
+     *   `createdStoryValues` for any stories generated to receive them, and the
+     *   `skipped` count of ineligible elements
+     * @throws `NO_ACTIVE_STRUCTURE` if there is no active structure to duplicate
+     *   into; `NO_ELIGIBLE_ELEMENTS` if nothing on the source story (or in
+     *   `options.components`) is duplicable; `HANDLE_INVALID` for a stale or
+     *   foreign supplied handle; or if plugin writes are disabled
+     *
+     * @examplePrompt Duplicate this floor to the storey above
+     * @examplePrompt Copy the ground floor down into a new basement
+     * @examplePrompt Repeat this level upwards with its own independent geometry
+     * @examplePrompt Duplicate just the selected walls onto the next floor up
+     *
+     * # Example
+     * ```ts
+     * // Duplicate the whole active story one level up (instanced copies).
+     * const { targetStories, created, skipped } =
+     *   await snaptrude.entity.story.duplicate("up")
+     * console.log(`Copied ${created.length} elements onto story ${targetStories}`)
+     * if (skipped) console.log(`${skipped} elements were skipped`)
+     * ```
+     */
+    abstract duplicate(direction: "up" | "down", options?: {
+        components?: ComponentHandle[];
+        unique?: boolean;
+    }): PluginApiReturn<PluginStoryDuplicateResult>;
 }
 /**
  * Available properties that can be queried on a story.
@@ -246,4 +303,41 @@ export declare const PluginStoryUpdateResult: z.ZodObject<{
     height: z.ZodNumber;
 }, z.core.$strip>;
 export type PluginStoryUpdateResult = z.infer<typeof PluginStoryUpdateResult>;
+/**
+ * Arguments for {@linkcode PluginStoryApi.duplicate} (options flattened).
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `direction` | `'up' \| 'down'` | Which adjacent story to duplicate into |
+ * | `components` | {@linkcode ComponentHandle}`[]?` | Restrict to a subset; omit for the whole story |
+ * | `unique` | `boolean?` | `false` (default) = instanced copies; `true` = independent geometry |
+ */
+export declare const PluginStoryDuplicateArgs: z.ZodObject<{
+    direction: z.ZodEnum<{
+        up: "up";
+        down: "down";
+    }>;
+    components: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>>;
+    unique: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type PluginStoryDuplicateArgs = z.infer<typeof PluginStoryDuplicateArgs>;
+/**
+ * Result of {@linkcode PluginStoryApi.duplicate}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `sourceStory` | `number` | Storey value the copies were duplicated from |
+ * | `targetStories` | `number[]` | Storey values the copies landed on |
+ * | `created` | {@linkcode ComponentHandle}`[]` | Handles of the newly created components |
+ * | `createdStoryValues` | `number[]` | Storey values that were generated to receive the copies |
+ * | `skipped` | `number` | Count of ineligible elements that were skipped |
+ */
+export declare const PluginStoryDuplicateResult: z.ZodObject<{
+    sourceStory: z.ZodNumber;
+    targetStories: z.ZodArray<z.ZodNumber>;
+    created: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+    createdStoryValues: z.ZodArray<z.ZodNumber>;
+    skipped: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginStoryDuplicateResult = z.infer<typeof PluginStoryDuplicateResult>;
 //# sourceMappingURL=story.d.ts.map

package/dist/api/entity/story.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"story.d.ts","sourceRoot":"","sources":["../../../src/api/entity/story.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;;;GAWG;AACH,8BAAsB,cAAc;;IAGlC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,GAAG,CACjB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,sBAAsB,EAAE,GACnC,eAAe,CAAC,oBAAoB,CAAC;IAExC;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,MAAM,IAAI,eAAe,CAAC,uBAAuB,CAAC;IAElE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,MAAM,GACd,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,uBAAuB,CAAC;CAC5C;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;EASjC,CAAA;AAEF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;iBAG7B,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;iBAWrB,CAAA;AAEZ,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;;;;;;iBAQlC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB;;;iBAGhC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB;;;iBAGlC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB;;;iBAGhC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB;;;iBAGlC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA"}
+{"version":3,"file":"story.d.ts","sourceRoot":"","sources":["../../../src/api/entity/story.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE/C;;;;;;;;;;;GAWG;AACH,8BAAsB,cAAc;;IAGlC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,GAAG,CACjB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,sBAAsB,EAAE,GACnC,eAAe,CAAC,oBAAoB,CAAC;IAExC;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,MAAM,IAAI,eAAe,CAAC,uBAAuB,CAAC;IAElE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,MAAM,GACd,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,uBAAuB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;aACa,SAAS,CACvB,SAAS,EAAE,IAAI,GAAG,MAAM,EACxB,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAC7D,eAAe,CAAC,0BAA0B,CAAC;CAC/C;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;EASjC,CAAA;AAEF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;iBAG7B,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;iBAWrB,CAAA;AAEZ,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;;;;;;iBAQlC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB;;;iBAGhC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB;;;iBAGlC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB;;;iBAGhC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB;;;iBAGlC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB;;;;;;;iBAInC,CAAA;AAEF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;;;;;GAUG;AACH,eAAO,MAAM,0BAA0B;;;;;;iBAMrC,CAAA;AAEF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA"}