@snaptrude/plugin-core 0.9.17 → 0.9.18-voids-20261016.1

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

@@ -354,6 +354,9 @@ export abstract class PluginDesignQueryApi {
    * List all entities of one BIM object type — wall, door, slab, panel, and so
    * on — optionally narrowed by the shared filter.
    *
+   * `"mass"` includes voids; a mass whose `design.query.getHost` is a slab,
+   * floor, roof or ceiling is a void (made by `design.create.void`).
+   *
    * @param type - the {@linkcode PluginEntityType} to list
    * @param filter - an optional {@linkcode PluginEntityFilter}
    * @returns matching entities as {@linkcode ComponentHandle}`[]`
@@ -445,6 +448,9 @@ export abstract class PluginDesignQueryApi {
    * List all the generic masses (non-room massing volumes) in the project,
    * optionally filtered by storey, building, label, mass type, or region.
    *
+   * Includes voids; a mass whose `design.query.getHost` is a slab, floor, roof
+   * or ceiling is a void (made by `design.create.void`).
+   *
    * @param filter - an optional {@linkcode PluginEntityFilter}
    * @returns mass {@linkcode ComponentHandle}`[]`
    *
@@ -881,7 +887,8 @@ export abstract class PluginDesignQueryApi {
 
   /**
    * List an entity's direct child entities — for example the doors and windows
-   * hosted in a wall.
+   * hosted in a wall, or the voids (holes, shafts, openings) cut in a slab,
+   * floor, roof or ceiling by `design.create.void`.
    * @param component - the entity's {@linkcode ComponentHandle}
    * @returns child {@linkcode ComponentHandle}`[]` (`[]` if none)
    *
@@ -889,6 +896,7 @@ export abstract class PluginDesignQueryApi {
    * @examplePrompt Show the child elements of the selected object
    * @examplePrompt Which openings belong to this wall?
    * @examplePrompt List everything nested under this mass
+   * @examplePrompt List all holes in this slab
    *
    * # Example
    * ```ts
@@ -908,7 +916,8 @@ export abstract class PluginDesignQueryApi {
   ): PluginApiReturn<ComponentHandle[]>
 
   /**
-   * Get an entity's host/parent entity (e.g. the wall a door is cut into).
+   * Get an entity's host/parent entity (e.g. the wall a door is cut into, or
+   * the slab, floor, roof or ceiling a void is cut through).
    * @param component - the entity's {@linkcode ComponentHandle}
    * @returns the host {@linkcode ComponentHandle}, or `null` if top-level
    *
@@ -916,6 +925,7 @@ export abstract class PluginDesignQueryApi {
    * @examplePrompt Find the parent of the selected window
    * @examplePrompt What is this element attached to?
    * @examplePrompt Which wall hosts this window?
+   * @examplePrompt Which slab is this shaft in?
    *
    * # Example
    * ```ts

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

@@ -1,23 +1,25 @@
 import * as z from "zod"
 import { PluginApiReturn } from "../../../types"
 
+/** An exact saved native wall family. Access is checked on every use; Draw selection is not registration. */
+export const PluginNativeWallType = z.object({
+  id: z.string().min(1),
+  version: z.number().int().positive(),
+})
+export type PluginNativeWallType = z.infer<typeof PluginNativeWallType>
+
+/** Legacy project type name/id, or an exact authorized native wall family pin. */
+export const PluginWallType = z.union([z.string().trim().min(1), PluginNativeWallType])
+export type PluginWallType = z.infer<typeof PluginWallType>
+
 /**
- * `snaptrude.design.types` — READ-ONLY reference over the project's building
- * **type / assembly** system (the Project Properties layer stacks: External /
- * Internal walls, slabs, floors, ceilings, roofs). A type bundles a labelled
- * layer stack — each layer's role, thickness (engine units) and material — plus a
- * summed total thickness. Both the built-in defaults and any team/user-added types
- * are surfaced.
- *
- * Types are plain value records ({@linkcode PluginBuildingType}) — NOT scene
- * entities/handles. A type's `id` is a stable `"<kind>:<name>"` token
- * (e.g. `"wall:brickWithPlasterAndPaint"`) returned by
- * {@linkcode PluginDesignTypesApi.list} and consumed by
- * {@linkcode PluginDesignTypesApi.get}. Reads never throw — an unknown id yields
- * `null`; a kind with no types yields `[]`.
- *
- * These are reads only: there is no engine seam to author a type from a plugin
- * (types are created through the construction/project-properties UI).
+ * Read-only project assemblies and authorized saved native wall families.
+ * Legacy ids use `"<kind>:<name>"`. Native wall records carry `nativeFamily`:
+ * pass that exact `{ id, version }` pin to get, create.walls, create.wallRuns,
+ * or update.wall. Labels and bare definition ids do not select native families.
+ * Native lengths use Snaptrude units (1 SU = 254 mm).
+ * Missing ids return null; catalog/network failures reject rather than return
+ * an incomplete catalog. Author native families with design.family.
  */
 export abstract class PluginDesignTypesApi {
   constructor() {}
@@ -46,10 +48,10 @@ export abstract class PluginDesignTypesApi {
   ): PluginApiReturn<PluginBuildingTypeSummary[]>
 
   /**
-   * Get one building type by its `"<kind>:<name>"` id — its labelled layer stack
+   * Get one building type by its legacy id or exact native wall pin — its labelled layer stack
    * (each layer's role, thickness and material) plus the summed total thickness.
    *
-   * @param typeId The type id from {@linkcode PluginDesignTypesApi.list} (e.g. `"wall:exposedConcrete"`)
+   * @param typeId The legacy id or nativeFamily pin from {@linkcode PluginDesignTypesApi.list}
    * @returns The full type, or `null` if no type matches
    *
    * @examplePrompt What layers make up this wall type?
@@ -60,11 +62,11 @@ export abstract class PluginDesignTypesApi {
    * # Example
    * ```ts
    * const [first] = await snaptrude.design.types.list("wall")
-   * const type = await snaptrude.design.types.get(first.id)
+   * const type = await snaptrude.design.types.get(first.nativeFamily ?? first.id)
    * if (type) for (const layer of type.layers) console.log(layer.name, layer.thickness)
    * ```
    */
-  public abstract get(typeId: string): PluginApiReturn<PluginBuildingType | null>
+  public abstract get(typeId: PluginWallType): PluginApiReturn<PluginBuildingType | null>
 }
 
 /** The building-type families exposed by {@linkcode PluginDesignTypesApi}. */
@@ -85,6 +87,8 @@ export const PluginTypeLayer = z.object({
   name: z.string(),
   role: z.string(),
   thickness: z.number(),
+  /** Native authored core membership. Never inferred from material or layer name. */
+  isCore: z.boolean().optional(),
   material: z
     .object({
       name: z.string(),
@@ -99,7 +103,7 @@ export type PluginTypeLayer = z.infer<typeof PluginTypeLayer>
  *
  * | Property | Type | Description |
  * |---|---|---|
- * | `id` | `string` | Stable `"<kind>:<name>"` token — pass to `design.types.get` |
+ * | `id` | `string` | Legacy `"<kind>:<name>"` token or native definition id; native lookups use `nativeFamily` |
  * | `kind` | {@linkcode PluginBuildingTypeKind} | Which family it belongs to |
  * | `label` | `string` | Human-readable label |
  * | `isDefault` | `boolean` | `true` for a built-in type, `false` for a team/user type |
@@ -111,6 +115,8 @@ export const PluginBuildingTypeSummary = z.object({
   label: z.string(),
   isDefault: z.boolean(),
   thickness: z.number(),
+  /** Present for native walls. Pass the whole pin to get/create/update, not its label or bare id. */
+  nativeFamily: PluginNativeWallType.optional(),
 })
 export type PluginBuildingTypeSummary = z.infer<typeof PluginBuildingTypeSummary>
 
@@ -119,7 +125,7 @@ export type PluginBuildingTypeSummary = z.infer<typeof PluginBuildingTypeSummary
  *
  * | Property | Type | Description |
  * |---|---|---|
- * | `id` | `string` | Stable `"<kind>:<name>"` token |
+ * | `id` | `string` | Legacy type token or native definition id |
  * | `kind` | {@linkcode PluginBuildingTypeKind} | Which family it belongs to |
  * | `label` | `string` | Human-readable label |
  * | `isDefault` | `boolean` | `true` for a built-in type |
@@ -148,9 +154,10 @@ export type PluginDesignTypesListArgs = z.infer<typeof PluginDesignTypesListArgs
  *
  * | Property | Type | Description |
  * |---|---|---|
- * | `typeId` | `string` | The `"<kind>:<name>"` id from `design.types.list` |
+ * | `typeId` | {@linkcode PluginWallType} | A legacy `"<kind>:<name>"` id or exact `nativeFamily` pin from `design.types.list` |
  */
 export const PluginDesignTypesGetArgs = z.object({
-  typeId: z.string(),
+  // Preserve legacy lookup behavior: malformed string ids return null in the host.
+  typeId: z.union([z.string(), PluginNativeWallType]),
 })
 export type PluginDesignTypesGetArgs = z.infer<typeof PluginDesignTypesGetArgs>

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

@@ -9,7 +9,10 @@ import {
   PluginSpaceUpdateResult,
 } from "../../entity/space"
 import { PluginDesignChangeResult } from "../lock"
-import { MassParametersPatch, type MassParametersRecord } from "../../../massParameters"
+import {
+  MassParametersPatch,
+  type MassParametersRecord,
+} from "../../../massParameters"
 import {
   PluginBuildableEnvelopePolygonVertex,
   PluginBuildableEnvelopeSetbackTier,
@@ -18,6 +21,12 @@ import {
 } from "../../entity/buildableEnvelope"
 import { PluginGridStyleOptions } from "../create/grids"
 import { PluginEntityType } from "../query"
+import { PluginWallType } from "../types"
+import {
+  PluginConstructionType,
+  PluginFamilyValues,
+  type PluginFamilyUpdates,
+} from "../catalog"
 
 /**
  * Sparse property updates for a space. Only provided fields change.
@@ -165,13 +174,14 @@ export type PluginDesignUpdateParametersArgs = z.infer<
  * |---|---|---|
  * | `thickness` | `number`? | Wall thickness, engine units (> 0) |
  * | `height` | `number`? | Wall height, engine units (> 0) |
- * | `type` | `string`? | Convert the wall to another wall type — a name (or `wall:`-prefixed id) from `design.types.list("wall")` |
+ * | `type` | {@linkcode PluginWallType}? | Legacy name/id or exact authorized native `{ id, version }` pin from `design.types.list("wall")` |
  */
 export const PluginWallUpdates = z
   .object({
     thickness: z.number().positive().optional(),
     height: z.number().positive().optional(),
-    type: z.string().trim().min(1).optional(),
+    type: PluginWallType.optional(),
+    values: PluginFamilyValues.optional(),
   })
   .refine((p) => Object.keys(p).length > 0, {
     message: "PluginWallUpdates requires at least one field to change",
@@ -196,6 +206,8 @@ export const PluginSlabUpdates = z
   .object({
     thickness: z.number().positive().optional(),
     overhang: z.number().optional(),
+    type: PluginConstructionType.optional(),
+    values: PluginFamilyValues.optional(),
   })
   .refine((p) => Object.keys(p).length > 0, {
     message: "PluginSlabUpdates requires at least one field to change",
@@ -313,6 +325,11 @@ export type PluginDesignUpdateGridArgs = z.infer<
  *
  * Migrated from the removed `entity.space.{update, updateGeometryFromProfile, bulkUpdate}`.
  * Only provided fields change; each call is undoable. Failures throw (RPC rejects).
+ *
+ * Native family edits accept `type` and/or sparse `values` from `design.catalog`.
+ * Length overrides use mm; dimensional arguments use SU. Contours and axes stay unchanged.
+ * Shared/type overrides are refused. A thickness argument must agree with the layer values.
+ * Family roof overhang is unsupported; use the native slab path for family overhang edits.
  */
 export abstract class PluginDesignUpdateApi {
   constructor() {}
@@ -400,6 +417,8 @@ export abstract class PluginDesignUpdateApi {
    * @param space - The space to update
    * @param options - `properties` (sparse) and/or `geometry` ({ profile, extrudeHeight })
    * @returns the updated space's echoed {@linkcode PluginSpaceUpdateResult}
+   * @throws PRECONDITION_FAILED for a void (a hole cut with `design.create.void`): delete it and
+   *   cut a new one
    *
    * @examplePrompt Rename this room to Office
    * @examplePrompt Change this space's room type to Meeting Room
@@ -433,6 +452,7 @@ export abstract class PluginDesignUpdateApi {
    *
    * @param items - One {@linkcode PluginUpdateSpaceItem} per space
    * @returns one {@linkcode PluginSpaceUpdateResult} per item, in input order
+   * @throws PRECONDITION_FAILED for a void, like {@linkcode space}
    *
    * @examplePrompt Label all the selected rooms as Bedrooms
    * @examplePrompt Change the room type of these five spaces at once
@@ -566,6 +586,9 @@ export abstract class PluginDesignUpdateApi {
    *   chamfer (the kernel numbers its faces differently): send the twist/taper
    *   keys with `operations: []` first (the message names them), re-select on
    *   the new shape, then send `{ operations }` back.
+   *   Graph-bound spaces accept amount-only extrusion edits. Footprint, twist,
+   *   taper and operation edits require the owning boundary tools, so generated
+   *   walls, junctions and hosted openings remain synchronized.
    * @throws VALIDATION for a key the kind does not have (the message lists the
    *   kind's keys), `kind` or `version` in a partial patch, or a value outside
    *   the constructor's own rules (torus tube ≥ ring, revolution angle ∉
@@ -773,6 +796,24 @@ export abstract class PluginDesignUpdateApi {
     updates: PluginSlabUpdates,
   ): PluginApiReturn<PluginDesignChangeResult>
 
+  /** Replace a native beam family while preserving its authored axis. Values use mm/degrees.
+   * @param component Native beam. @param updates Saved family reference and optional instance values.
+   * @returns Affected component IDs. One undoable operation; unsupported geometry fails before mutation.
+   */
+  public abstract beam(
+    component: ComponentHandle,
+    updates: PluginFamilyUpdates,
+  ): PluginApiReturn<PluginDesignChangeResult>
+
+  /** Replace a native column family while preserving its authored axis. Values use mm/degrees.
+   * @param component Native column. @param updates Saved family reference and optional instance values.
+   * @returns Affected component IDs. One undoable operation; unsupported geometry fails before mutation.
+   */
+  public abstract column(
+    component: ComponentHandle,
+    updates: PluginFamilyUpdates,
+  ): PluginApiReturn<PluginDesignChangeResult>
+
   /**
    * Set a component's **absolute world elevation** — moves it vertically so its
    * base (the bounding-box bottom, world Y) lands at `elevation`. Composed over

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

@@ -10,13 +10,14 @@ import { PluginObjectCatalogGroup, PluginObjectCatalogItem } from "../doors"
  * 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}
+ * browse saved hosted window families, keyed by definition ID, and feed design.create.window.
+ * They reject if saved definitions cannot be loaded completely. A missing item returns 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.
+ * PC-only: dimensions read the evaluated opening and host thickness in SU. Setters
+ * write declared width/height parameters, never mesh scale. Missing or derived
+ * controls reject. Use design.family.setParameters for sill and other controls.
  */
 export abstract class PluginDesignWindowsApi {
   constructor() {}
@@ -40,7 +41,9 @@ export abstract class PluginDesignWindowsApi {
    * if (type) console.log("window type:", type)
    * ```
    */
-  public abstract getType(window: ComponentHandle): PluginApiReturn<string | null>
+  public abstract getType(
+    window: ComponentHandle,
+  ): PluginApiReturn<string | null>
 
   /**
    * Get the width of a window — how wide its opening is along the host wall.
@@ -60,7 +63,9 @@ export abstract class PluginDesignWindowsApi {
    * if (width !== null) console.log("window width:", width)
    * ```
    */
-  public abstract getWidth(window: ComponentHandle): PluginApiReturn<number | null>
+  public abstract getWidth(
+    window: ComponentHandle,
+  ): PluginApiReturn<number | null>
 
   /**
    * Get the height of a window — how tall its opening is on the host wall.
@@ -80,12 +85,13 @@ export abstract class PluginDesignWindowsApi {
    * if (height !== null) console.log("window height:", height)
    * ```
    */
-  public abstract getHeight(window: ComponentHandle): PluginApiReturn<number | null>
+  public 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.
+   * Get evaluated opening width/height and host thickness in Snaptrude units.
+   * The opening can differ from the width/height input parameters.
    *
    * @param window The window to query
    * @returns The dimensions, or `null`
@@ -104,7 +110,7 @@ export abstract class PluginDesignWindowsApi {
    * ```
    */
   public abstract getDimensions(
-    window: ComponentHandle
+    window: ComponentHandle,
   ): PluginApiReturn<PluginWindowDimensions | null>
 
   /**
@@ -129,7 +135,7 @@ export abstract class PluginDesignWindowsApi {
    */
   public abstract setWidth(
     window: ComponentHandle,
-    width: number
+    width: number,
   ): PluginApiReturn<PluginDesignChangeResult>
 
   /**
@@ -153,7 +159,7 @@ export abstract class PluginDesignWindowsApi {
    */
   public abstract setHeight(
     window: ComponentHandle,
-    height: number
+    height: number,
   ): PluginApiReturn<PluginDesignChangeResult>
 
   /**
@@ -174,7 +180,9 @@ export abstract class PluginDesignWindowsApi {
    * for (const g of groups) console.log(g.dbType, g.label, g.source)
    * ```
    */
-  public abstract listCatalogGroups(): PluginApiReturn<PluginObjectCatalogGroup[]>
+  public abstract listCatalogGroups(): PluginApiReturn<
+    PluginObjectCatalogGroup[]
+  >
 
   /**
    * List the placeable window catalog (team + general libraries), optionally
@@ -196,7 +204,7 @@ export abstract class PluginDesignWindowsApi {
    * ```
    */
   public abstract listCatalog(
-    group?: string
+    group?: string,
   ): PluginApiReturn<PluginObjectCatalogItem[]>
 
   /**
@@ -218,7 +226,7 @@ export abstract class PluginDesignWindowsApi {
    * ```
    */
   public abstract getCatalogItem(
-    id: string
+    id: string,
   ): PluginApiReturn<PluginObjectCatalogItem | null>
 
   /**
@@ -282,7 +290,9 @@ export const PluginDesignWindowSetWidthArgs = z.object({
   window: ComponentHandle,
   width: z.number(),
 })
-export type PluginDesignWindowSetWidthArgs = z.infer<typeof PluginDesignWindowSetWidthArgs>
+export type PluginDesignWindowSetWidthArgs = z.infer<
+  typeof PluginDesignWindowSetWidthArgs
+>
 
 /**
  * Arguments for {@linkcode PluginDesignWindowsApi.setHeight}.
@@ -296,7 +306,9 @@ export const PluginDesignWindowSetHeightArgs = z.object({
   window: ComponentHandle,
   height: z.number(),
 })
-export type PluginDesignWindowSetHeightArgs = z.infer<typeof PluginDesignWindowSetHeightArgs>
+export type PluginDesignWindowSetHeightArgs = z.infer<
+  typeof PluginDesignWindowSetHeightArgs
+>
 
 // ---------------------------------------------------------------------------
 // catalog (shared DTOs defined in ../doors, re-exported here for symmetry)
@@ -315,7 +327,9 @@ export { PluginObjectCatalogGroup, PluginObjectCatalogItem }
 export const PluginDesignWindowListCatalogArgs = z.object({
   group: z.string().optional(),
 })
-export type PluginDesignWindowListCatalogArgs = z.infer<typeof PluginDesignWindowListCatalogArgs>
+export type PluginDesignWindowListCatalogArgs = z.infer<
+  typeof PluginDesignWindowListCatalogArgs
+>
 
 /**
  * Arguments for {@linkcode PluginDesignWindowsApi.getCatalogItem} / {@linkcode PluginDesignWindowsApi.exists}.
@@ -327,7 +341,11 @@ export type PluginDesignWindowListCatalogArgs = z.infer<typeof PluginDesignWindo
 export const PluginDesignWindowGetCatalogItemArgs = z.object({
   id: z.string(),
 })
-export type PluginDesignWindowGetCatalogItemArgs = z.infer<typeof PluginDesignWindowGetCatalogItemArgs>
+export type PluginDesignWindowGetCatalogItemArgs = z.infer<
+  typeof PluginDesignWindowGetCatalogItemArgs
+>
 
 export const PluginDesignWindowExistsArgs = PluginDesignWindowGetCatalogItemArgs
-export type PluginDesignWindowExistsArgs = z.infer<typeof PluginDesignWindowExistsArgs>
+export type PluginDesignWindowExistsArgs = z.infer<
+  typeof PluginDesignWindowExistsArgs
+>