@snaptrude/plugin-core 0.6.0 → 0.7.1

package/src/api/design/windows/index.ts

@@ -2,14 +2,21 @@ 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 abstract class PluginDesignWindowsApi {
   constructor() {}
@@ -148,6 +155,91 @@ export abstract class PluginDesignWindowsApi {
     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)
+   * ```
+   */
+  public 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)
+   * ```
+   */
+  public 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)
+   * ```
+   */
+  public 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")
+   * ```
+   */
+  public abstract exists(id: string): PluginApiReturn<boolean>
 }
 
 /**
@@ -205,3 +297,37 @@ export const PluginDesignWindowSetHeightArgs = z.object({
   height: z.number(),
 })
 export type PluginDesignWindowSetHeightArgs = z.infer<typeof PluginDesignWindowSetHeightArgs>
+
+// ---------------------------------------------------------------------------
+// catalog (shared DTOs defined in ../doors, re-exported here for symmetry)
+// ---------------------------------------------------------------------------
+
+// Re-export the shared catalog DTOs imported at the top of this file.
+export { PluginObjectCatalogGroup, PluginObjectCatalogItem }
+
+/**
+ * Arguments for {@linkcode PluginDesignWindowsApi.listCatalog}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `group` | `string`? | Restrict to one group's `dbType` token (optional) |
+ */
+export const PluginDesignWindowListCatalogArgs = z.object({
+  group: z.string().optional(),
+})
+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 const PluginDesignWindowGetCatalogItemArgs = z.object({
+  id: z.string(),
+})
+export type PluginDesignWindowGetCatalogItemArgs = z.infer<typeof PluginDesignWindowGetCatalogItemArgs>
+
+export const PluginDesignWindowExistsArgs = PluginDesignWindowGetCatalogItemArgs
+export type PluginDesignWindowExistsArgs = z.infer<typeof PluginDesignWindowExistsArgs>

package/src/api/entity/story.ts

@@ -1,5 +1,6 @@
 import * as z from "zod"
 import { PluginApiReturn } from "../../types"
+import { ComponentHandle } from "../../handles"
 
 /**
  * Story (floor/storey) management.
@@ -101,17 +102,25 @@ export abstract class PluginStoryApi {
   ): 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
@@ -120,7 +129,8 @@ export 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)
    * ```
    */
@@ -128,6 +138,54 @@ export abstract class PluginStoryApi {
     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`)
+   * ```
+   */
+  public abstract duplicate(
+    direction: "up" | "down",
+    options?: { components?: ComponentHandle[]; unique?: boolean },
+  ): PluginApiReturn<PluginStoryDuplicateResult>
 }
 
 /**
@@ -271,3 +329,43 @@ export const PluginStoryUpdateResult = z.object({
 })
 
 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 const PluginStoryDuplicateArgs = z.object({
+  direction: z.enum(["up", "down"]),
+  components: z.array(ComponentHandle).optional(),
+  unique: z.boolean().optional(),
+})
+
+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 const PluginStoryDuplicateResult = z.object({
+  sourceStory: z.number(),
+  targetStories: z.array(z.number()),
+  created: z.array(ComponentHandle),
+  createdStoryValues: z.array(z.number()),
+  skipped: z.number(),
+})
+
+export type PluginStoryDuplicateResult = z.infer<
+  typeof PluginStoryDuplicateResult
+>