@snaptrude/plugin-core 0.0.0-dev-20260708130115 → 0.0.0-dev-20260827194031

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

@@ -1,35 +1,143 @@
 import * as z from "zod";
 import { PluginApiReturn } from "../../../types";
+import { ComponentHandle } from "../../../handles";
+import { PluginDesignChangeResult } from "../lock";
+import { PluginObjectCatalogGroup } from "../doors";
 /**
  * `snaptrude.design.furniture` — the placeable furniture **catalog** (a library of
- * source items, NOT scene entities). Placement lives at `design.create.furniture`
- * (returns a {@linkcode ComponentHandle}); reads of placed furniture live at
- * `design.query.listFurniture`/`getProperties`.
+ * source items, NOT scene entities) plus dimension reads/edits of PLACED furniture.
+ * Placement lives at `design.create.furniture` (returns a {@linkcode ComponentHandle});
+ * generic reads of placed furniture live at `design.query.listFurniture`/`getProperties`.
  *
  * Catalog items are plain value records ({@linkcode PluginFurnitureCatalogItem}) keyed
  * by a library id (team `_id` or general `fullName`) — not handles. Reads are async
  * (network-backed) but carry no `Async` suffix (§6.6).
+ *
+ * {@linkcode PluginDesignFurnitureApi.getDimensions} / {@linkcode PluginDesignFurnitureApi.setDimensions}
+ * target a PLACED furniture {@linkcode ComponentHandle} (not a catalog id) — `length`
+ * along the object, `width` across it, `height` up. Values are engine units, matching
+ * the length/width/height fields the furniture properties panel shows.
  */
 export declare abstract class PluginDesignFurnitureApi {
     constructor();
     /**
-     * List the placeable furniture catalog (team + general libraries).
+     * Get the dimensions of a PLACED furniture item — `length` (along the object),
+     * `width` (across it) and `height` (vertical), in engine units. Mirrors the
+     * Length/Width/Height fields of the furniture properties panel.
+     *
+     * @param item The placed furniture to query
+     * @returns The dimensions, or `null` if the geometry is degenerate
+     *
+     * @examplePrompt How big is this sofa?
+     * @examplePrompt What are the dimensions of the selected furniture?
+     * @examplePrompt Measure the length, width and height of this table
+     * @examplePrompt Get the size of the chair I just placed
+     *
+     * # Example
+     * ```ts
+     * const [item] = await snaptrude.design.query.listFurniture({ isSelected: true })
+     * const dims = await snaptrude.design.furniture.getDimensions(item)
+     * if (dims) console.log(dims.length, dims.width, dims.height)
+     * ```
+     */
+    abstract getDimensions(item: ComponentHandle): PluginApiReturn<PluginFurnitureDimensions | null>;
+    /**
+     * Resize a PLACED furniture item along one or more axes — `length`, `width`
+     * and/or `height` (engine units). Omitted axes are left unchanged. Each supplied
+     * axis is an undoable command, mirroring editing the furniture properties panel.
+     *
+     * @param item The placed furniture to resize
+     * @param dimensions New `length` / `width` / `height` (each optional, engine units)
+     * @returns The affected furniture
+     *
+     * @examplePrompt Make this table 1.8m long
+     * @examplePrompt Resize the selected sofa to 2000 wide
+     * @examplePrompt Set this furniture to 800mm tall
+     * @examplePrompt Change the desk to 1500 long and 700 deep
+     *
+     * # Example
+     * ```ts
+     * const [item] = await snaptrude.design.query.listFurniture({ isSelected: true })
+     * const { affected } = await snaptrude.design.furniture.setDimensions(item, {
+     *   length: 1800,
+     *   height: 750
+     * })
+     * ```
+     */
+    abstract setDimensions(item: ComponentHandle, dimensions: PluginFurnitureDimensionUpdates): PluginApiReturn<PluginDesignChangeResult>;
+    /**
+     * List the categories (Living, Bedroom, Kitchen, …) that organize the
+     * furniture catalog — the picker taxonomy, merged from built-in categories,
+     * team types, and backend user types. Pass a value to
+     * {@linkcode PluginDesignFurnitureApi.listCatalog}'s `category` filter.
+     * @returns The category names (`[]` when empty)
+     *
+     * @examplePrompt What furniture categories are available?
+     * @examplePrompt List the furniture categories
+     * @examplePrompt Show me the furniture groups like living and bedroom
+     * @examplePrompt Which furniture categories can I filter by?
+     *
+     * # Example
+     * ```ts
+     * const categories = await snaptrude.design.furniture.listCategories()
+     * const [first] = categories
+     * const items = await snaptrude.design.furniture.listCatalog(undefined, first)
+     * console.log(first, "→", items.length, "items")
+     * ```
+     *
+     * @deprecated Use `design.furniture.listCatalogGroups` — the same name
+     * `design.doors` and `design.windows` use. Still supported.
+     */
+    abstract listCategories(): PluginApiReturn<string[]>;
+    /**
+     * List the furniture catalog's groups. Matches
+     * {@linkcode PluginDesignDoorsApi.listCatalogGroups} and
+     * {@linkcode PluginDesignWindowsApi.listCatalogGroups}, so all three catalog
+     * surfaces are named alike.
+     *
+     * `source` is `"default"` for the built-in picker groups and `"team"` for the
+     * sub-types of THIS project's team library — exactly the split
+     * {@linkcode PluginDesignFurnitureApi.listCatalog}'s `source` filter uses, so
+     * every `"team"` group is guaranteed to match at least one team item here.
+     * For furniture the group token and its label are the same string (the
+     * category), so `dbType === label`; `design.doors`/`design.windows` have a
+     * distinct engine `dbType`.
+     *
+     * @returns The catalog groups as {@linkcode PluginObjectCatalogGroup}`[]`
+     *   (`[]` when empty). Pass a group's `dbType` (=== `label`) to
+     *   {@linkcode PluginDesignFurnitureApi.listCatalog}'s `category` filter to
+     *   list its items.
+     *
+     * @examplePrompt What furniture groups are available?
+     * @examplePrompt List the furniture categories in this project
+     *
+     * # Example
+     * ```ts
+     * const groups = await snaptrude.design.furniture.listCatalogGroups()
+     * for (const g of groups) console.log(g.dbType, g.label, g.source)
+     * ```
+     */
+    abstract listCatalogGroups(): PluginApiReturn<PluginObjectCatalogGroup[]>;
+    /**
+     * List the placeable furniture catalog (team + general libraries),
+     * optionally filtered by library `source` and/or `category`.
      * @param source Restrict to one library (optional)
+     * @param category Restrict to one category (optional; see {@linkcode PluginDesignFurnitureApi.listCategories})
      * @returns The catalog as {@linkcode PluginFurnitureCatalogItem}`[]` (`[]` when empty)
      *
      * @examplePrompt What furniture can I place in this project?
      * @examplePrompt Show me all the furniture available in the library
      * @examplePrompt List the chairs and tables I can add to the model
      * @examplePrompt Which furniture items are in my team's library?
-     * @examplePrompt Browse the furniture catalog
+     * @examplePrompt Show me the bedroom furniture I can place
      *
      * # Example
      * ```ts
-     * const teamItems = await snaptrude.design.furniture.listCatalog("team")
-     * for (const item of teamItems) console.log(item.id, item.name, item.cost)
+     * const bedroom = await snaptrude.design.furniture.listCatalog("team", "bedroom")
+     * for (const item of bedroom) console.log(item.id, item.name, item.thumbnailUrl)
      * ```
      */
-    abstract listCatalog(source?: "team" | "general"): PluginApiReturn<PluginFurnitureCatalogItem[]>;
+    abstract listCatalog(source?: "team" | "general", category?: string): PluginApiReturn<PluginFurnitureCatalogItem[]>;
     /**
      * Get a single catalog item by its library id.
      * @param id The catalog library id
@@ -76,6 +184,8 @@ export declare abstract class PluginDesignFurnitureApi {
  * | `name` | `string` | Display name |
  * | `source` | `'team' \| 'general'` | Which library it came from |
  * | `subType` | `string` | Sub-type (optional) |
+ * | `category` | `string` | Category the item belongs to (optional) |
+ * | `thumbnailUrl` | `string` | Preview thumbnail URL (optional; never the mesh URL) |
  * | `cost` | `number` | Cost (optional; team items) |
  * | `familyName` | `string` | Family name (optional) |
  */
@@ -87,6 +197,8 @@ export declare const PluginFurnitureCatalogItem: z.ZodObject<{
         general: "general";
     }>;
     subType: z.ZodOptional<z.ZodString>;
+    category: z.ZodOptional<z.ZodString>;
+    thumbnailUrl: z.ZodOptional<z.ZodString>;
     cost: z.ZodOptional<z.ZodNumber>;
     familyName: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
@@ -97,12 +209,14 @@ export type PluginFurnitureCatalogItem = z.infer<typeof PluginFurnitureCatalogIt
  * | Property | Type | Description |
  * |---|---|---|
  * | `source` | `'team' \| 'general'` | Restrict to one library (optional) |
+ * | `category` | `string` | Restrict to one category (optional) |
  */
 export declare const PluginDesignFurnitureListCatalogArgs: z.ZodObject<{
     source: z.ZodOptional<z.ZodEnum<{
         team: "team";
         general: "general";
     }>>;
+    category: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export type PluginDesignFurnitureListCatalogArgs = z.infer<typeof PluginDesignFurnitureListCatalogArgs>;
 /**
@@ -120,4 +234,63 @@ export declare const PluginDesignFurnitureExistsArgs: z.ZodObject<{
     id: z.ZodString;
 }, z.core.$strip>;
 export type PluginDesignFurnitureExistsArgs = z.infer<typeof PluginDesignFurnitureExistsArgs>;
+/**
+ * A placed furniture item's dimensions (engine units).
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `length` | `number` | Along the object (panel "Length") |
+ * | `width` | `number` | Across the object (panel "Width") |
+ * | `height` | `number` | Vertical (panel "Height") |
+ */
+export declare const PluginFurnitureDimensions: z.ZodObject<{
+    length: z.ZodNumber;
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginFurnitureDimensions = z.infer<typeof PluginFurnitureDimensions>;
+/**
+ * Arguments for {@linkcode PluginDesignFurnitureApi.getDimensions}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `item` | {@linkcode ComponentHandle} | The placed furniture to query |
+ */
+export declare const PluginDesignFurnitureItemArgs: z.ZodObject<{
+    item: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+}, z.core.$strip>;
+export type PluginDesignFurnitureItemArgs = z.infer<typeof PluginDesignFurnitureItemArgs>;
+/**
+ * A partial dimension patch — each axis is optional; omitted axes are unchanged.
+ * Every supplied axis must be a positive engine-unit length.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `length` | `number`? | New length along the object (engine units, > 0) |
+ * | `width` | `number`? | New width across the object (engine units, > 0) |
+ * | `height` | `number`? | New height (engine units, > 0) |
+ */
+export declare const PluginFurnitureDimensionUpdates: z.ZodObject<{
+    length: z.ZodOptional<z.ZodNumber>;
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type PluginFurnitureDimensionUpdates = z.infer<typeof PluginFurnitureDimensionUpdates>;
+/**
+ * Arguments for {@linkcode PluginDesignFurnitureApi.setDimensions}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `item` | {@linkcode ComponentHandle} | The placed furniture to resize |
+ * | `dimensions` | {@linkcode PluginFurnitureDimensionUpdates} | The axes to change (each optional) |
+ */
+export declare const PluginDesignFurnitureSetDimensionsArgs: z.ZodObject<{
+    item: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+    dimensions: z.ZodObject<{
+        length: z.ZodOptional<z.ZodNumber>;
+        width: z.ZodOptional<z.ZodNumber>;
+        height: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type PluginDesignFurnitureSetDimensionsArgs = z.infer<typeof PluginDesignFurnitureSetDimensionsArgs>;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/design/furniture/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAEhD;;;;;;;;;GASG;AACH,8BAAsB,wBAAwB;;IAG5C;;;;;;;;;;;;;;;;OAgBG;aACa,WAAW,CACzB,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,GAC1B,eAAe,CAAC,0BAA0B,EAAE,CAAC;IAEhD;;;;;;;;;;;;;;;;OAgBG;aACa,cAAc,CAC5B,EAAE,EAAE,MAAM,GACT,eAAe,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAErD;;;;;;;;;;;;;;;;OAgBG;aACa,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC;CAC7D;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;iBAOrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF;;;;;;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,uCAAuC;;iBAElD,CAAA;AACF,MAAM,MAAM,uCAAuC,GAAG,CAAC,CAAC,KAAK,CAC3D,OAAO,uCAAuC,CAC/C,CAAA;AAED,eAAO,MAAM,+BAA+B;;iBAA0C,CAAA;AACtF,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/furniture/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,MAAM,UAAU,CAAA;AAEnD;;;;;;;;;;;;;;GAcG;AACH,8BAAsB,wBAAwB;;IAG5C;;;;;;;;;;;;;;;;;;;OAmBG;aACa,aAAa,CAC3B,IAAI,EAAE,eAAe,GACpB,eAAe,CAAC,yBAAyB,GAAG,IAAI,CAAC;IAEpD;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,aAAa,CAC3B,IAAI,EAAE,eAAe,EACrB,UAAU,EAAE,+BAA+B,GAC1C,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,cAAc,IAAI,eAAe,CAAC,MAAM,EAAE,CAAC;IAE3D;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;aACa,iBAAiB,IAAI,eAAe,CAAC,wBAAwB,EAAE,CAAC;IAEhF;;;;;;;;;;;;;;;;;;OAkBG;aACa,WAAW,CACzB,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,EAC3B,QAAQ,CAAC,EAAE,MAAM,GAChB,eAAe,CAAC,0BAA0B,EAAE,CAAC;IAEhD;;;;;;;;;;;;;;;;OAgBG;aACa,cAAc,CAC5B,EAAE,EAAE,MAAM,GACT,eAAe,CAAC,0BAA0B,GAAG,IAAI,CAAC;IAErD;;;;;;;;;;;;;;;;OAgBG;aACa,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC;CAC7D;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;iBASrC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF;;;;;;;GAOG;AACH,eAAO,MAAM,oCAAoC;;;;;;iBAG/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,uCAAuC;;iBAElD,CAAA;AACF,MAAM,MAAM,uCAAuC,GAAG,CAAC,CAAC,KAAK,CAC3D,OAAO,uCAAuC,CAC/C,CAAA;AAED,eAAO,MAAM,+BAA+B;;iBAA0C,CAAA;AACtF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AAM7F;;;;;;;;GAQG;AACH,eAAO,MAAM,yBAAyB;;;;iBAIpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAEjF;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B;;iBAExC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAA;AAEzF;;;;;;;;;GASG;AACH,eAAO,MAAM,+BAA+B;;;;iBAI1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AAE7F;;;;;;;GAOG;AACH,eAAO,MAAM,sCAAsC;;;;;;;iBAGjD,CAAA;AACF,MAAM,MAAM,sCAAsC,GAAG,CAAC,CAAC,KAAK,CAC1D,OAAO,sCAAsC,CAC9C,CAAA"}

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

@@ -13,6 +13,9 @@ import { PluginDesignBooleanApi } from "./boolean";
 import { PluginDesignTransformApi } from "./transform";
 import { PluginDesignEditApi } from "./edit";
 import { PluginDesignUpdateApi } from "./update";
+import { PluginDesignVisibilityApi } from "./visibility";
+import { PluginDesignTypesApi } from "./types";
+import { PluginDesignFamilyApi } from "./family";
 import { PluginDesignChangeResult } from "./lock";
 /**
  * `snaptrude.design.*` — author, query & edit BIM geometry.
@@ -26,7 +29,11 @@ import { PluginDesignChangeResult } from "./lock";
  * - {@linkcode PluginDesignApi.boolean} — CSG boolean ops (union / subtract / intersect)
  * - {@linkcode PluginDesignApi.erase} — plan-level adjacency-edge erase (NOT hard delete)
  * - {@linkcode PluginDesignApi.delete} — hard entity removal
+ * - {@linkcode PluginDesignApi.visibility} — hide / isolate / reveal entities
+ * - {@linkcode PluginDesignApi.types} — read-only building type / assembly reference
+ * - {@linkcode PluginDesignApi.family} — author parametric families from a JSON spec
  * - {@linkcode PluginDesignApi.lock} / {@linkcode PluginDesignApi.unlock} / {@linkcode PluginDesignApi.isLocked} / {@linkcode PluginDesignApi.listLocked} — lock state (top-level design verbs, §2A.1)
+ * - {@linkcode PluginDesignApi.lockArea} / {@linkcode PluginDesignApi.unlockArea} / {@linkcode PluginDesignApi.isAreaLocked} / {@linkcode PluginDesignApi.listAreaLocked} — footprint-area lock for Room/Department spaces
  *
  * Transform and edit operation namespaces land here in later waves.
  */
@@ -57,6 +64,12 @@ export declare abstract class PluginDesignApi {
     abstract edit: PluginDesignEditApi;
     /** Update existing entities — properties + geometry. See {@linkcode PluginDesignUpdateApi}. */
     abstract update: PluginDesignUpdateApi;
+    /** Hide / isolate / reveal entities. See {@linkcode PluginDesignVisibilityApi}. */
+    abstract visibility: PluginDesignVisibilityApi;
+    /** Read-only building type / assembly reference. See {@linkcode PluginDesignTypesApi}. */
+    abstract types: PluginDesignTypesApi;
+    /** Author parametric families from a JSON spec. See {@linkcode PluginDesignFamilyApi}. */
+    abstract family: PluginDesignFamilyApi;
     /**
      * Lock entities so they cannot be edited. Undoable. Cascades to void/door/window
      * children, stacked-wall companions, and terrain neighborhood; skips
@@ -133,6 +146,88 @@ export declare abstract class PluginDesignApi {
      * ```
      */
     abstract listLocked(): PluginApiReturn<ComponentHandle[]>;
+    /**
+     * Lock the **footprint area** of one or more Room / Department mass spaces —
+     * geometry edits that would change the bottom-face area are then refused or
+     * auto-resized to preserve it. Distinct from {@linkcode PluginDesignApi.lock}
+     * (which freezes the whole object): this locks only the area. Cascades to the
+     * space's instances and its source mass. Undoable.
+     *
+     * Only Room / Department masses are area-lockable; any other handle throws.
+     * Requires the `area_lock` feature to be enabled — when it is off this throws.
+     *
+     * @param spaces Room / Department mass spaces to area-lock
+     * @returns The affected spaces (post-cascade, echoing the input handles)
+     *
+     * @examplePrompt Lock the floor area of the selected rooms
+     * @examplePrompt Freeze the footprint area of this department so its size can't drift
+     * @examplePrompt Area-lock every room on this storey
+     * @examplePrompt Pin the area of this space while I edit its walls
+     *
+     * # Example
+     * ```ts
+     * const rooms = await snaptrude.design.selection.get()
+     * const { affected } = await snaptrude.design.lockArea(rooms)
+     * console.log("area-locked", affected.length, "spaces")
+     * ```
+     */
+    abstract lockArea(spaces: ComponentHandle[]): PluginApiReturn<PluginDesignChangeResult>;
+    /**
+     * Unlock the footprint area of previously area-locked spaces so their area can
+     * change again. Paired with {@linkcode PluginDesignApi.lockArea}; cascades to
+     * instances + source; undoable. Requires the `area_lock` feature (throws if off).
+     *
+     * @param spaces Room / Department mass spaces to area-unlock
+     * @returns The affected spaces (post-cascade)
+     *
+     * @examplePrompt Unlock the area of the selected rooms
+     * @examplePrompt Remove the footprint-area lock from this department
+     * @examplePrompt Let me resize this space again by unlocking its area
+     * @examplePrompt Area-unlock everything I locked earlier
+     *
+     * # Example
+     * ```ts
+     * const locked = await snaptrude.design.listAreaLocked()
+     * const { affected } = await snaptrude.design.unlockArea(locked)
+     * ```
+     */
+    abstract unlockArea(spaces: ComponentHandle[]): PluginApiReturn<PluginDesignChangeResult>;
+    /**
+     * Test whether a space's footprint area is locked. A read — never throws;
+     * returns `false` for non-space handles and when the `area_lock` feature is off.
+     *
+     * @param space The space to test
+     * @returns `true` if the space's area is locked, otherwise `false`
+     *
+     * @examplePrompt Is the area of this room locked?
+     * @examplePrompt Check whether this department's footprint is pinned
+     * @examplePrompt Tell me if the selected space has its area locked
+     *
+     * # Example
+     * ```ts
+     * const [room] = await snaptrude.design.selection.get()
+     * const locked = await snaptrude.design.isAreaLocked(room)
+     * console.log(locked ? "area is locked" : "area is free")
+     * ```
+     */
+    abstract isAreaLocked(space: ComponentHandle): PluginApiReturn<boolean>;
+    /**
+     * List the spaces whose footprint area is locked. A read — never throws; returns
+     * `[]` when the `area_lock` feature is off.
+     *
+     * @returns The area-locked spaces as {@linkcode ComponentHandle}`[]`
+     *
+     * @examplePrompt Which spaces have their area locked?
+     * @examplePrompt List every room with a locked footprint
+     * @examplePrompt Show me all the area-locked departments
+     *
+     * # Example
+     * ```ts
+     * const locked = await snaptrude.design.listAreaLocked()
+     * console.log(locked.length, "area-locked spaces")
+     * ```
+     */
+    abstract listAreaLocked(): PluginApiReturn<ComponentHandle[]>;
     constructor();
 }
 export * from "./create";
@@ -150,4 +245,7 @@ export * from "./boolean";
 export * from "./transform";
 export * from "./edit";
 export * from "./update";
+export * from "./visibility";
+export * from "./types";
+export * from "./family";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/design/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAC9C,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AACtD,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAC9C,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AACtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAA;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,EAAE,wBAAwB,EAAE,MAAM,QAAQ,CAAA;AAEjD;;;;;;;;;;;;;;;GAeG;AACH,8BAAsB,eAAe;IACnC,sFAAsF;IACtF,SAAgB,MAAM,EAAE,qBAAqB,CAAA;IAC7C,oFAAoF;IACpF,SAAgB,KAAK,EAAE,oBAAoB,CAAA;IAC3C,mFAAmF;IACnF,SAAgB,SAAS,EAAE,wBAAwB,CAAA;IACnD,yEAAyE;IACzE,SAAgB,KAAK,EAAE,oBAAoB,CAAA;IAC3C,qEAAqE;IACrE,SAAgB,OAAO,EAAE,sBAAsB,CAAA;IAC/C,yEAAyE;IACzE,SAAgB,SAAS,EAAE,wBAAwB,CAAA;IACnD,+EAA+E;IAC/E,SAAgB,SAAS,EAAE,wBAAwB,CAAA;IACnD,+FAA+F;IAC/F,SAAgB,KAAK,EAAE,oBAAoB,CAAA;IAC3C,kEAAkE;IAClE,SAAgB,MAAM,EAAE,qBAAqB,CAAA;IAC7C,8FAA8F;IAC9F,SAAgB,OAAO,EAAE,sBAAsB,CAAA;IAC/C,kFAAkF;IAClF,SAAgB,SAAS,EAAE,wBAAwB,CAAA;IACnD,qFAAqF;IACrF,SAAgB,IAAI,EAAE,mBAAmB,CAAA;IACzC,+FAA+F;IAC/F,SAAgB,MAAM,EAAE,qBAAqB,CAAA;IAE7C;;;;;;;;;;;;;;;;;;;OAmBG;aACa,IAAI,CAAC,UAAU,EAAE,eAAe,EAAE,GAAG,eAAe,CAAC,wBAAwB,CAAC;IAE9F;;;;;;;;;;;;;;;;;OAiBG;aACa,MAAM,CAAC,UAAU,EAAE,eAAe,EAAE,GAAG,eAAe,CAAC,wBAAwB,CAAC;IAEhG;;;;;;;;;;;;;;;;;;OAkBG;aACa,QAAQ,CACtB,SAAS,EAAE,eAAe,EAC1B,gBAAgB,CAAC,EAAE,OAAO,GACzB,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;OAcG;aACa,UAAU,IAAI,eAAe,CAAC,eAAe,EAAE,CAAC;;CAGjE;AAED,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AACvB,cAAc,aAAa,CAAA;AAC3B,cAAc,SAAS,CAAA;AACvB,cAAc,WAAW,CAAA;AACzB,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,aAAa,CAAA;AAC3B,cAAc,QAAQ,CAAA;AACtB,cAAc,UAAU,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/design/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAC9C,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AACtD,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAC9C,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AACtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAA;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAA;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAC9C,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,EAAE,wBAAwB,EAAE,MAAM,QAAQ,CAAA;AAEjD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,8BAAsB,eAAe;IACnC,sFAAsF;IACtF,SAAgB,MAAM,EAAE,qBAAqB,CAAA;IAC7C,oFAAoF;IACpF,SAAgB,KAAK,EAAE,oBAAoB,CAAA;IAC3C,mFAAmF;IACnF,SAAgB,SAAS,EAAE,wBAAwB,CAAA;IACnD,yEAAyE;IACzE,SAAgB,KAAK,EAAE,oBAAoB,CAAA;IAC3C,qEAAqE;IACrE,SAAgB,OAAO,EAAE,sBAAsB,CAAA;IAC/C,yEAAyE;IACzE,SAAgB,SAAS,EAAE,wBAAwB,CAAA;IACnD,+EAA+E;IAC/E,SAAgB,SAAS,EAAE,wBAAwB,CAAA;IACnD,+FAA+F;IAC/F,SAAgB,KAAK,EAAE,oBAAoB,CAAA;IAC3C,kEAAkE;IAClE,SAAgB,MAAM,EAAE,qBAAqB,CAAA;IAC7C,8FAA8F;IAC9F,SAAgB,OAAO,EAAE,sBAAsB,CAAA;IAC/C,kFAAkF;IAClF,SAAgB,SAAS,EAAE,wBAAwB,CAAA;IACnD,qFAAqF;IACrF,SAAgB,IAAI,EAAE,mBAAmB,CAAA;IACzC,+FAA+F;IAC/F,SAAgB,MAAM,EAAE,qBAAqB,CAAA;IAC7C,mFAAmF;IACnF,SAAgB,UAAU,EAAE,yBAAyB,CAAA;IACrD,0FAA0F;IAC1F,SAAgB,KAAK,EAAE,oBAAoB,CAAA;IAC3C,0FAA0F;IAC1F,SAAgB,MAAM,EAAE,qBAAqB,CAAA;IAE7C;;;;;;;;;;;;;;;;;;;OAmBG;aACa,IAAI,CAAC,UAAU,EAAE,eAAe,EAAE,GAAG,eAAe,CAAC,wBAAwB,CAAC;IAE9F;;;;;;;;;;;;;;;;;OAiBG;aACa,MAAM,CAAC,UAAU,EAAE,eAAe,EAAE,GAAG,eAAe,CAAC,wBAAwB,CAAC;IAEhG;;;;;;;;;;;;;;;;;;OAkBG;aACa,QAAQ,CACtB,SAAS,EAAE,eAAe,EAC1B,gBAAgB,CAAC,EAAE,OAAO,GACzB,eAAe,CAAC,OAAO,CAAC;IAE3B;;;;;;;;;;;;;;OAcG;aACa,UAAU,IAAI,eAAe,CAAC,eAAe,EAAE,CAAC;IAEhE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,QAAQ,CAAC,MAAM,EAAE,eAAe,EAAE,GAAG,eAAe,CAAC,wBAAwB,CAAC;IAE9F;;;;;;;;;;;;;;;;;;OAkBG;aACa,UAAU,CAAC,MAAM,EAAE,eAAe,EAAE,GAAG,eAAe,CAAC,wBAAwB,CAAC;IAEhG;;;;;;;;;;;;;;;;;OAiBG;aACa,YAAY,CAAC,KAAK,EAAE,eAAe,GAAG,eAAe,CAAC,OAAO,CAAC;IAE9E;;;;;;;;;;;;;;;OAeG;aACa,cAAc,IAAI,eAAe,CAAC,eAAe,EAAE,CAAC;;CAGrE;AAED,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AACvB,cAAc,aAAa,CAAA;AAC3B,cAAc,SAAS,CAAA;AACvB,cAAc,WAAW,CAAA;AACzB,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,aAAa,CAAA;AAC3B,cAAc,QAAQ,CAAA;AACtB,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA;AAC5B,cAAc,SAAS,CAAA;AACvB,cAAc,UAAU,CAAA"}

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

@@ -38,4 +38,30 @@ export declare const PluginDesignIsLockedArgs: z.ZodObject<{
     includeInherited: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
 export type PluginDesignIsLockedArgs = z.infer<typeof PluginDesignIsLockedArgs>;
+/**
+ * Arguments for {@linkcode PluginDesignApi.lockArea} / {@linkcode PluginDesignApi.unlockArea}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaces` | {@linkcode ComponentHandle}`[]` | Room / Department mass spaces to area-lock / unlock |
+ */
+export declare const PluginDesignLockAreaArgs: z.ZodObject<{
+    spaces: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+}, z.core.$strip>;
+export type PluginDesignLockAreaArgs = z.infer<typeof PluginDesignLockAreaArgs>;
+export declare const PluginDesignUnlockAreaArgs: z.ZodObject<{
+    spaces: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+}, z.core.$strip>;
+export type PluginDesignUnlockAreaArgs = z.infer<typeof PluginDesignUnlockAreaArgs>;
+/**
+ * Arguments for {@linkcode PluginDesignApi.isAreaLocked}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `space` | {@linkcode ComponentHandle} | The space to test |
+ */
+export declare const PluginDesignIsAreaLockedArgs: z.ZodObject<{
+    space: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+}, z.core.$strip>;
+export type PluginDesignIsAreaLockedArgs = z.infer<typeof PluginDesignIsAreaLockedArgs>;
 //# sourceMappingURL=lock.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"lock.d.ts","sourceRoot":"","sources":["../../../src/api/design/lock.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB;;iBAEnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;;iBAE/B,CAAA;AACF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE,eAAO,MAAM,sBAAsB;;iBAAuB,CAAA;AAC1D,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB;;;iBAGnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA"}
+{"version":3,"file":"lock.d.ts","sourceRoot":"","sources":["../../../src/api/design/lock.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB;;iBAEnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;;iBAE/B,CAAA;AACF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE,eAAO,MAAM,sBAAsB;;iBAAuB,CAAA;AAC1D,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB;;;iBAGnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB;;iBAEnC,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E,eAAO,MAAM,0BAA0B;;iBAA2B,CAAA;AAClE,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B;;iBAEvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA"}