@snaptrude/plugin-core 0.0.0-bimsvg-20260928124803

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

@@ -0,0 +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;AAC3B,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAClD,OAAO,EACL,oCAAoC,EACpC,kCAAkC,EAClC,kCAAkC,EAClC,mCAAmC,EACpC,MAAM,gCAAgC,CAAA;AAGvC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAMrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED,+DAA+D;AAC/D,eAAO,MAAM,yBAAyB;;;iBAGpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,yBAAyB,CACjC,CAAA;AAED,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,CAC/C,OAAO,2BAA2B,CACnC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;iBAG1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,iBAAiB;;;;iBAQ1B,CAAA;AACJ,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAEjE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,iBAAiB;;;iBAO1B,CAAA;AACJ,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAEjE,4DAA4D;AAC5D,eAAO,MAAM,0BAA0B;;;;;;;iBAGrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,0BAA0B;;;;;;iBAGrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED,oEAAoE;AACpE,eAAO,MAAM,4BAA4B;;;iBAGvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED,qEAAqE;AACrE,eAAO,MAAM,6BAA6B;;;iBAGxC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,yBAAyB;;;iBAGpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,yBAAyB,CACjC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;iBAM1B,CAAA;AACF,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAE7D,4DAA4D;AAC5D,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;iBAGrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF;;;;;GAKG;AACH,8BAAsB,qBAAqB;;IAGzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;aACa,QAAQ,CACtB,SAAS,EAAE,eAAe,EAC1B,KAAK,EAAE,MAAM,GACZ,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,IAAI,CAClB,IAAI,EAAE,eAAe,EACrB,KAAK,EAAE,eAAe,GACrB,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;aACa,MAAM,CACpB,KAAK,EAAE,qBAAqB,EAAE,GAC7B,eAAe,CAAC,uBAAuB,EAAE,CAAC;IAE7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;aACa,SAAS,CACvB,UAAU,EAAE,eAAe,EAAE,EAC7B,MAAM,EAAE,2BAA2B,GAClC,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;aACa,IAAI,CAClB,SAAS,EAAE,eAAe,EAC1B,OAAO,EAAE,iBAAiB,GACzB,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;aACa,IAAI,CAClB,SAAS,EAAE,eAAe,EAC1B,OAAO,EAAE,iBAAiB,GACzB,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,KAAK,CACnB,SAAS,EAAE,eAAe,EAC1B,OAAO,EAAE,iBAAiB,GACzB,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;aACa,IAAI,CAClB,SAAS,EAAE,eAAe,EAC1B,OAAO,EAAE,iBAAiB,GACzB,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,OAAO,CACrB,SAAS,EAAE,eAAe,EAC1B,OAAO,EAAE,iBAAiB,GACzB,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;aACa,YAAY,CAC1B,SAAS,EAAE,eAAe,EAC1B,SAAS,EAAE,MAAM,GAChB,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;aACa,aAAa,CAC3B,SAAS,EAAE,eAAe,EAC1B,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;aACa,SAAS,CACvB,UAAU,EAAE,eAAe,EAAE,EAC7B,MAAM,EAAE,MAAM,GACb,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;aACa,iBAAiB,CAC/B,mBAAmB,EAAE,MAAM,EAC3B,WAAW,EAAE,oCAAoC,EAAE,EACnD,UAAU,EAAE,IAAI,GAAG,GAAG,EACtB,QAAQ,EAAE,kCAAkC,EAAE,EAC9C,WAAW,EAAE,kCAAkC,EAC/C,YAAY,EAAE,MAAM,EACpB,QAAQ,CAAC,EAAE,MAAM,EACjB,iBAAiB,CAAC,EAAE,MAAM,GACzB,eAAe,CAAC,mCAAmC,CAAC;CACxD"}

package/dist/api/design/visibility.d.ts

@@ -0,0 +1,126 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../types";
+import { ComponentHandle } from "../../handles";
+import { PluginDesignChangeResult } from "./lock";
+/**
+ * `snaptrude.design.visibility.*` — hide, isolate, and reveal scene entities.
+ *
+ * Visibility is a per-component user flag (the same one the "Hide" / "Isolate" /
+ * "Show All" toolbar and right-click actions toggle). Every method here commits
+ * an undoable command and echoes the affected entities as
+ * {@linkcode PluginDesignChangeResult}.
+ *
+ * Accessed via `snaptrude.design.visibility`.
+ */
+export declare abstract class PluginDesignVisibilityApi {
+    constructor();
+    /**
+     * Hide entities from the viewport — the same as the "Hide" action. Undoable.
+     * Hosted door/window/void children ride along with their wall. Already-hidden
+     * entities stay hidden.
+     *
+     * @param components Entities to hide
+     * @returns The affected entities (echoing the input handles)
+     *
+     * @examplePrompt Hide the selected walls
+     * @examplePrompt Conceal these masses so I can see behind them
+     * @examplePrompt Hide every column on this floor
+     * @examplePrompt Make this furniture disappear from view
+     *
+     * # Example
+     * ```ts
+     * const walls = await snaptrude.design.query.listWalls({ storeys: [1] })
+     * const { affected } = await snaptrude.design.visibility.hide(walls)
+     * ```
+     */
+    abstract hide(components: ComponentHandle[]): PluginApiReturn<PluginDesignChangeResult>;
+    /**
+     * Reveal specific hidden components — the inverse of
+     * {@linkcode PluginDesignVisibilityApi.hide}. Use
+     * {@linkcode PluginDesignVisibilityApi.showAll} to reveal everything.
+     *
+     * @param components - The components to reveal.
+     * @returns A {@linkcode PluginDesignChangeResult} echoing the components shown.
+     *
+     * @examplePrompt Show these walls again
+     * @examplePrompt Unhide the selected furniture
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.design.visibility.show([wall])
+     * ```
+     */
+    abstract show(components: ComponentHandle[]): PluginApiReturn<PluginDesignChangeResult>;
+    /**
+     * Isolate entities — hide everything else so only the given entities remain
+     * visible (the "Isolate" / solo action). Undoable. Reverse it with
+     * {@linkcode PluginDesignVisibilityApi.showAll}.
+     *
+     * @param components Entities to keep visible; everything else is hidden
+     * @returns The isolated entities (echoing the input handles)
+     *
+     * @examplePrompt Isolate the selected room so I can focus on it
+     * @examplePrompt Show only these walls and hide the rest
+     * @examplePrompt Solo this mass
+     * @examplePrompt Hide everything except the staircase
+     *
+     * # Example
+     * ```ts
+     * const [room] = await snaptrude.design.selection.get()
+     * await snaptrude.design.visibility.isolate([room])
+     * ```
+     */
+    abstract isolate(components: ComponentHandle[]): PluginApiReturn<PluginDesignChangeResult>;
+    /**
+     * Reveal everything hidden on the active story — the "Show All" action, which
+     * also exits an isolate. Undoable.
+     *
+     * @returns The entities that were made visible
+     *
+     * @examplePrompt Show everything again
+     * @examplePrompt Unhide all the hidden objects
+     * @examplePrompt Exit isolate mode
+     * @examplePrompt Reveal everything I hid earlier
+     *
+     * # Example
+     * ```ts
+     * const { affected } = await snaptrude.design.visibility.showAll()
+     * console.log(`Revealed ${affected.length} entities`)
+     * ```
+     */
+    abstract showAll(): PluginApiReturn<PluginDesignChangeResult>;
+}
+/**
+ * Arguments for {@linkcode PluginDesignVisibilityApi.hide}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `components` | {@linkcode ComponentHandle}`[]` | Entities to hide |
+ */
+export declare const PluginDesignVisibilityHideArgs: z.ZodObject<{
+    components: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+}, z.core.$strip>;
+export type PluginDesignVisibilityHideArgs = z.infer<typeof PluginDesignVisibilityHideArgs>;
+/**
+ * Arguments for {@linkcode PluginDesignVisibilityApi.show}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `components` | {@linkcode ComponentHandle}`[]` | Entities to reveal |
+ */
+export declare const PluginDesignVisibilityShowArgs: z.ZodObject<{
+    components: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+}, z.core.$strip>;
+export type PluginDesignVisibilityShowArgs = z.infer<typeof PluginDesignVisibilityShowArgs>;
+/**
+ * Arguments for {@linkcode PluginDesignVisibilityApi.isolate}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `components` | {@linkcode ComponentHandle}`[]` | Entities to keep visible |
+ */
+export declare const PluginDesignVisibilityIsolateArgs: z.ZodObject<{
+    components: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+}, z.core.$strip>;
+export type PluginDesignVisibilityIsolateArgs = z.infer<typeof PluginDesignVisibilityIsolateArgs>;
+//# sourceMappingURL=visibility.d.ts.map

package/dist/api/design/visibility.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"visibility.d.ts","sourceRoot":"","sources":["../../../src/api/design/visibility.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;AAC/C,OAAO,EAAE,wBAAwB,EAAE,MAAM,QAAQ,CAAA;AAEjD;;;;;;;;;GASG;AACH,8BAAsB,yBAAyB;;IAG7C;;;;;;;;;;;;;;;;;;OAkBG;aACa,IAAI,CAClB,UAAU,EAAE,eAAe,EAAE,GAC5B,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;OAeG;aACa,IAAI,CAClB,UAAU,EAAE,eAAe,EAAE,GAC5B,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;OAkBG;aACa,OAAO,CACrB,UAAU,EAAE,eAAe,EAAE,GAC5B,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;OAgBG;aACa,OAAO,IAAI,eAAe,CAAC,wBAAwB,CAAC;CACrE;AAED;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B;;iBAEzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAA;AAE3F;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B;;iBAEzC,CAAA;AACF,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iCAAiC;;iBAE5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA"}

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

@@ -0,0 +1,300 @@
+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.
+ *
+ * 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();
+    /**
+     * Get the type name of a window — the label that identifies which kind of
+     * window the instance is, as shown in its properties.
+     *
+     * @param window The window to query
+     * @returns The type as a `string`, or `null`
+     *
+     * @examplePrompt What type of window is this?
+     * @examplePrompt Is the selected window a casement or a slider?
+     * @examplePrompt Tell me the window type used on this wall
+     * @examplePrompt Check what kind of window the living room has
+     *
+     * # Example
+     * ```ts
+     * const [win] = await snaptrude.design.query.listWindows({ isSelected: true })
+     * const type = await snaptrude.design.windows.getType(win)
+     * if (type) console.log("window type:", type)
+     * ```
+     */
+    abstract getType(window: ComponentHandle): PluginApiReturn<string | null>;
+    /**
+     * Get the width of a window — how wide its opening is along the host wall.
+     *
+     * @param window The window to query
+     * @returns The width as a `number`, or `null`
+     *
+     * @examplePrompt How wide is this window?
+     * @examplePrompt What's the width of the selected window?
+     * @examplePrompt Measure the width of the kitchen window
+     * @examplePrompt Check whether this window is 1200mm wide
+     *
+     * # Example
+     * ```ts
+     * const [win] = await snaptrude.design.query.listWindows()
+     * const width = await snaptrude.design.windows.getWidth(win)
+     * if (width !== null) console.log("window width:", width)
+     * ```
+     */
+    abstract getWidth(window: ComponentHandle): PluginApiReturn<number | null>;
+    /**
+     * Get the height of a window — how tall its opening is on the host wall.
+     *
+     * @param window The window to query
+     * @returns The height as a `number`, or `null`
+     *
+     * @examplePrompt How tall is this window?
+     * @examplePrompt What's the height of the selected window?
+     * @examplePrompt Check the window height on this wall
+     * @examplePrompt Is the bedroom window 1.5m high?
+     *
+     * # Example
+     * ```ts
+     * const [win] = await snaptrude.design.query.listWindows()
+     * const height = await snaptrude.design.windows.getHeight(win)
+     * if (height !== null) console.log("window height:", height)
+     * ```
+     */
+    abstract getHeight(window: ComponentHandle): PluginApiReturn<number | null>;
+    /**
+     * Get a window's full dimensions in one call — width along the wall, vertical
+     * height, and thickness through the wall — measured in the window's local
+     * oriented space.
+     *
+     * @param window The window to query
+     * @returns The dimensions, or `null`
+     *
+     * @examplePrompt What are the dimensions of this window?
+     * @examplePrompt How big is the selected window?
+     * @examplePrompt Give me the width, height and depth of this window
+     * @examplePrompt Measure the living room window
+     * @examplePrompt Get the window size including its thickness through the wall
+     *
+     * # Example
+     * ```ts
+     * const [win] = await snaptrude.design.query.listWindows({ isSelected: true })
+     * const dims = await snaptrude.design.windows.getDimensions(win)
+     * if (dims) console.log(dims.width, dims.height, dims.thickness)
+     * ```
+     */
+    abstract getDimensions(window: ComponentHandle): PluginApiReturn<PluginWindowDimensions | null>;
+    /**
+     * Set the width of a window, resizing its opening and re-cutting the host
+     * wall. Width is in engine units; the change is undoable.
+     *
+     * @param window The window to resize
+     * @param width New width (engine units)
+     * @returns The affected window
+     *
+     * @examplePrompt Make this window 1200mm wide
+     * @examplePrompt Widen the selected window to 4 feet
+     * @examplePrompt Change the window width to 1.5m
+     * @examplePrompt Resize the kitchen window to 900 wide
+     *
+     * # Example
+     * ```ts
+     * // Takes a single window (unlike design.doors.setWidth, which takes an array)
+     * const [win] = await snaptrude.design.query.listWindows({ isSelected: true })
+     * const { affected } = await snaptrude.design.windows.setWidth(win, 1200)
+     * ```
+     */
+    abstract setWidth(window: ComponentHandle, width: number): PluginApiReturn<PluginDesignChangeResult>;
+    /**
+     * Set the height of a window, resizing its opening and re-cutting the host
+     * wall. Height is in engine units; the change is undoable.
+     *
+     * @param window The window to resize
+     * @param height New height (engine units)
+     * @returns The affected window
+     *
+     * @examplePrompt Make this window 1.5m tall
+     * @examplePrompt Change the window height to 4 feet
+     * @examplePrompt Shorten the selected window to 900mm high
+     * @examplePrompt Set the bedroom window height to 1200
+     *
+     * # Example
+     * ```ts
+     * const [win] = await snaptrude.design.query.listWindows({ isSelected: true })
+     * await snaptrude.design.windows.setHeight(win, 1500)
+     * ```
+     */
+    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.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `window` | {@linkcode ComponentHandle} | The window to query |
+ */
+export declare const PluginDesignWindowArgs: z.ZodObject<{
+    window: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+}, z.core.$strip>;
+export type PluginDesignWindowArgs = z.infer<typeof PluginDesignWindowArgs>;
+/**
+ * A window's dimensions.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `width` | `number` | Along the wall |
+ * | `height` | `number` | Vertical |
+ * | `thickness` | `number` | Through the wall (engine `length` axis) |
+ */
+export declare const PluginWindowDimensions: z.ZodObject<{
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+    thickness: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginWindowDimensions = z.infer<typeof PluginWindowDimensions>;
+/**
+ * Arguments for {@linkcode PluginDesignWindowsApi.setWidth}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `window` | {@linkcode ComponentHandle} | The window to resize |
+ * | `width` | `number` | New width (engine units) |
+ */
+export declare const PluginDesignWindowSetWidthArgs: z.ZodObject<{
+    window: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+    width: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginDesignWindowSetWidthArgs = z.infer<typeof PluginDesignWindowSetWidthArgs>;
+/**
+ * Arguments for {@linkcode PluginDesignWindowsApi.setHeight}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `window` | {@linkcode ComponentHandle} | The window to resize |
+ * | `height` | `number` | New height (engine units) |
+ */
+export declare const PluginDesignWindowSetHeightArgs: z.ZodObject<{
+    window: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+    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

@@ -0,0 +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;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"}