@snaptrude/plugin-core 0.9.16-networks-20261012.1 → 0.9.17

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

@@ -4,7 +4,6 @@ import {
   BrepHandle,
   ComponentHandle,
   ContourHandle,
-  LineHandle,
   CurveHandle,
   ProfileHandle,
   Vec3Handle,
@@ -30,14 +29,6 @@ import type {
   PluginCreateWindowItem,
 } from "./bulk-items"
 import { PluginWallTopProfile } from "./bulk-items"
-import { PluginWallType } from "../types"
-import {
-  PluginFamilyPlacement,
-  PluginFamilyFloorOptions,
-  PluginFamilySlabOptions,
-  PluginFamilyCeilingOptions,
-  PluginFamilyValues,
-} from "../catalog"
 
 /**
  * `design.create.*` — author new scene-committed BIM entities.
@@ -52,13 +43,7 @@ import {
  * Footprint objects take a {@linkcode ContourHandle} (outer profile + holes);
  * build one with `snaptrude.core.geom.create.contourFromProfile(s)`.
  *
- * Family overloads take `{ type, values? }` from `design.catalog`. The family supplies
- * construction; the contour or axis supplies instance geometry. Geometry uses SU,
- * while family length overrides use mm and angles use degrees. Omitted parameters
- * retain family defaults; shared/type, formula and geometry-bound overrides are refused.
- * Placement never publishes a definition. Unsupported references or geometry fail before mutation.
- *
- * `door`/`window` place a parametric family into a host wall (the world point is
+ * `door`/`window` place a catalog item into a host wall (the world point is
  * projected onto the wall face to locate the opening; the wall is re-cut in one
  * undo entry) and throw if the point projects outside the wall. `smartLayout` is
  * the one creator returning a grouped {@linkcode PluginSmartLayoutResult} rather
@@ -234,29 +219,20 @@ export abstract class PluginDesignCreateApi {
    * ```
    */
   public abstract slab(
-    ...args:
-      | [
-          contour: ContourHandle,
-          thickness: number,
-          direction?: "up" | "down",
-          slabType?: PluginSlabType,
-        ]
-      | [contour: ContourHandle, options: PluginFamilySlabOptions]
+    contour: ContourHandle,
+    thickness: number,
+    direction?: "up" | "down",
+    slabType?: PluginSlabType,
   ): PluginApiReturn<ComponentHandle>
 
   /**
    * Create a **floor** by extruding a footprint contour by `thickness`
    * (extruded upward).
    *
-   * The native family overload takes `{ type, values?, position? }`. Contour
-   * geometry uses SU; family values use mm. The family supplies layer thickness.
-   * PG2 can split or merge the footprint, so both overloads return an array.
-   * A merge into an existing floor can return no newly created handles.
-   *
    * @param contour - Footprint (outer + holes)
    * @param thickness - Floor thickness (> 0)
    * @param position - Offset from origin
-   * @returns Newly created {@linkcode ComponentHandle}s; an empty array after a merge
+   * @returns the {@linkcode ComponentHandle} of the created floor
    * @throws if the contour is invalid or the thickness is not positive
    *
    * @examplePrompt Create a floor from this room outline
@@ -271,15 +247,15 @@ export abstract class PluginDesignCreateApi {
    * const floor = await snaptrude.design.create.floor(contour, 0.1)
    * ```
    *
-   * @performance For dimensional floors, `design.create.floors(items[])` uses one
-   *   host round-trip and one undo entry. That bulk method does not accept native
-   *   family options; use this method for a family-backed floor.
+   * @performance For MORE THAN ONE floor, call `design.create.floors(items[])` — one
+   *   host round-trip and ONE undo entry for the whole batch. Looping this single-floor
+   *   creator is N round-trips and N undo entries.
    */
   public abstract floor(
-    ...args:
-      | [contour: ContourHandle, thickness: number, position?: Vec3Handle]
-      | [contour: ContourHandle, options: PluginFamilyFloorOptions]
-  ): PluginApiReturn<ComponentHandle[]>
+    contour: ContourHandle,
+    thickness: number,
+    position?: Vec3Handle,
+  ): PluginApiReturn<ComponentHandle>
 
   /**
    * Create **many floors** in one undoable operation (bulk plural of
@@ -344,7 +320,7 @@ export abstract class PluginDesignCreateApi {
    */
   public abstract roof(
     contour: ContourHandle,
-    thickness: number | PluginFamilyPlacement,
+    thickness: number,
   ): PluginApiReturn<ComponentHandle>
 
   /**
@@ -370,9 +346,9 @@ export abstract class PluginDesignCreateApi {
    * ```
    */
   public abstract ceiling(
-    ...args:
-      | [contour: ContourHandle, thickness: number, heightFromFloor?: number]
-      | [contour: ContourHandle, options: PluginFamilyCeilingOptions]
+    contour: ContourHandle,
+    thickness: number,
+    heightFromFloor?: number,
   ): PluginApiReturn<ComponentHandle>
 
   /**
@@ -403,14 +379,10 @@ export abstract class PluginDesignCreateApi {
    * ```
    */
   public abstract column(
-    ...args:
-      | [
-          position: Vec3Handle,
-          crossSection: ContourHandle,
-          height: number,
-          directionUp?: Vec3Handle,
-        ]
-      | [axis: LineHandle, options: PluginFamilyPlacement]
+    position: Vec3Handle,
+    crossSection: ContourHandle,
+    height: number,
+    directionUp?: Vec3Handle,
   ): PluginApiReturn<ComponentHandle>
 
   /**
@@ -454,9 +426,9 @@ export abstract class PluginDesignCreateApi {
    * ```
    */
   public abstract beam(
-    ...args:
-      | [section: ContourHandle, length: number, direction?: Vec3Handle]
-      | [axis: LineHandle, options: PluginFamilyPlacement]
+    section: ContourHandle,
+    length: number,
+    direction?: Vec3Handle,
   ): PluginApiReturn<ComponentHandle>
 
   /**
@@ -467,12 +439,12 @@ export abstract class PluginDesignCreateApi {
    * @param height - Wall height (default engine default)
    * @param thickness - Wall thickness (default: the `wallType`'s total layer
    *   thickness when `wallType` is given, else the engine default)
-   * @param wallType - Legacy label/`wall:` id, or the exact `nativeFamily`
-   *   `{ id, version }` pin from `design.types.list("wall")`. Native pins are
-   *   authorized on every use; selecting a family in Draw is not registration.
-   *   Native pins support straight horizontal centerlines and flat tops only.
-   *   Omit thickness for native pins; a conflicting explicit thickness rejects.
-   *   Default: the engine's generic wall.
+   * @param wallType - Wall type to build with — the same searchable list the
+   *   Draw tab's Wall Type dropdown offers. Pass a name from
+   *   `design.types.list("wall")` (the summary's `label`, or its `"wall:…"` id).
+   *   Drives the wall's construction layers and default material, and — when
+   *   `thickness` is omitted — its total layer thickness. Default: the engine's
+   *   generic wall.
    * @param storey - Target storey (integer: `1` ground, `2` first floor, `-1`
    *   basement — same convention as `design.create.space`). The walls are
    *   assigned to it and lifted to its base elevation, all inside the same
@@ -531,10 +503,9 @@ export abstract class PluginDesignCreateApi {
     profile: ProfileHandle,
     height?: number,
     thickness?: number,
-    wallType?: PluginWallType,
+    wallType?: string,
     storey?: number,
     topProfiles?: (PluginWallTopProfile | null)[],
-    values?: PluginFamilyValues,
   ): PluginApiReturn<ComponentHandle[]>
 
   /**
@@ -924,23 +895,30 @@ export abstract class PluginDesignCreateApi {
   ): PluginApiReturn<ComponentHandle[]>
 
   /**
-   * Place a parametric **door** family into a host wall.
+   * Place a **door** from the catalog into a host wall.
    *
-   * Identified by a saved **family definition id**. Discover ids with
+   * Identified by a **catalog (library) id** — the team object's stable `_id`
+   * or the general library's `fullName`. Discover ids with
    * {@linkcode PluginDesignDoorsApi.listCatalog}. The world `position` is
    * projected onto the host wall's face to locate the opening; the wall is
    * re-cut and the door hosted in a single undo entry. Placement is
-   * asynchronous. Values and host bindings are evaluated before the first cut.
+   * asynchronous (the source mesh is fetched if not cached).
    *
-   * @param familyId - Hosted door definition ID; legacy mesh catalog IDs are not accepted
+   * @param catalogId - Library id: team `_id` or general `fullName`
    * @param hostWall - The wall to host the door
    * @param position - World point projected onto the wall to locate the opening
-   * @param options - `version` pins the definition. `values` sets authored parameters
-   *   (numeric lengths in SU, or unit strings). `label` names the instance.
-   *   `hinge` selects the declared `hand` enum: local -X is left, +X is right.
-   * @param facing - World point selecting local +Z; omitted uses the picked face
+   * @param options - Optional placement options: `label` — instance name;
+   *   `hinge` — world point near the jamb the door is hinged on (the door is
+   *   reflected along the wall so its hinged jamb is the one nearer this
+   *   point; default the catalog item's authored hinge side)
+   * @param facing - World point on the side of the wall the door swings open
+   *   to (the room it opens into — where the plan symbol draws the swing arc).
+   *   Any point clearly on that side works (e.g. the room's center). Default:
+   *   the engine picks a side (nondeterministic when `position` sits on the
+   *   wall centerline).
    * @returns the {@linkcode ComponentHandle} of the placed door
-   * @throws if the family/category/parameters are invalid, or placement or cutting fails
+   * @throws if the catalog id is unknown, the host is not a wall, the source
+   *   mesh fails to load, or the projected point falls **outside** the host wall
    *
    * @examplePrompt Add a door to this wall here
    * @examplePrompt Place a sliding door on the selected wall
@@ -983,28 +961,26 @@ export abstract class PluginDesignCreateApi {
    *   that single call. Looping this single-door creator is N round-trips.
    */
   public abstract door(
-    familyId: string,
+    catalogId: string,
     hostWall: ComponentHandle,
     position: Vec3Handle,
-    options?: {
-      label?: string
-      hinge?: Vec3Handle
-      version?: number
-      values?: Record<string, number | string>
-    },
+    options?: { label?: string; hinge?: Vec3Handle },
     facing?: Vec3Handle,
   ): PluginApiReturn<ComponentHandle>
 
   /**
    * Place **many doors** into host walls in one undoable operation (bulk plural
-   * of {@linkcode door}). Each item carries its own family id, host wall,
+   * of {@linkcode door}). Each item carries its own catalog id, host wall,
    * world position, and optional `facing`, `label`, `width` and `height` — the
    * same fields as a `"door"` {@linkcode PluginDesignCreateOpeningOptions}.
    * Validate-all-or-throw; one command.
    *
-   * The wall keeps its identity. Several items may use the same host.
-   * Width and height set named recipe parameters, not mesh scale. The recipe's
-   * evaluated hole can include frame allowances. A failed item rolls back the batch.
+   * As with the singular creator, placing an opening **re-cuts its host wall**:
+   * the wall you passed as `hostWall` stops resolving once the call returns.
+   * Several items MAY name the same original wall handle in one call — the host
+   * chains the re-cuts internally — but after the call recover the surviving
+   * wall with `design.query.getHost(opening)`, never by reusing the handle you
+   * passed in.
    *
    * @param items - One {@linkcode PluginCreateDoorItem} per door to place
    *   (≥1, ≤1000)
@@ -1012,9 +988,10 @@ export abstract class PluginDesignCreateApi {
    * @throws `VALIDATION` if the items fail the schema (empty array, more than
    *   1000 items, unknown fields, a non-positive `width`/`height`);
    *   `HANDLE_INVALID` if a `position`, `facing` or `hinge` handle is unknown
-   *   or released; `PRECONDITION_FAILED` if the family cannot be resolved or saved,
-   *   or a host is locked / is not in the active proposal;
-   *   `OPERATION_FAILED` if placement, containment, overlap checks or cutting fail
+   *   or released; `PRECONDITION_FAILED` if a catalog id is unknown, a `hostWall`
+   *   is not a wall / is locked / is not in the active proposal, the projected
+   *   point falls outside its host wall, or a door tool is active;
+   *   `OPERATION_FAILED` if a source mesh fails to load or placement fails
    *   (nothing is created — `details.itemIndex` is the failing item);
    *   `METHOD_NOT_PERMITTED` if the plugin may not write.
    *
@@ -1025,7 +1002,7 @@ export abstract class PluginDesignCreateApi {
    * @examplePrompt Add all the doors for this floor plan together
    *
    * @performance Bulk creator — the whole batch is ONE host round-trip and ONE undo
-   *   entry. Always prefer this over
+   *   entry, and each distinct catalog source loads once. Always prefer this over
    *   calling `design.create.door` in a loop: build the full `items[]` array first
    *   (all host walls and points up front), then make one call.
    *
@@ -1035,10 +1012,10 @@ export abstract class PluginDesignCreateApi {
    * const [wall] = await snaptrude.design.query.listWalls({ isSelected: true })
    * const [entry] = await snaptrude.design.doors.listCatalog()
    * const [front, side] = await snaptrude.design.create.doors([
-   *   { familyId: entry.id, hostWall: wall, position: await v.new(2, 0, 5), label: "D-01" },
-   *   { familyId: entry.id, hostWall: wall, position: await v.new(6, 0, 5), values: { width: "1200mm" } },
+   *   { catalogId: entry.id, hostWall: wall, position: await v.new(2, 0, 5), label: "D-01" },
+   *   { catalogId: entry.id, hostWall: wall, position: await v.new(6, 0, 5), width: 1.2 },
    * ])
-   * // The host still resolves after both cuts:
+   * // `wall` was re-cut twice and no longer resolves — ask the opening for its host:
    * const currentWall = await snaptrude.design.query.getHost(front)
    * ```
    */
@@ -1047,21 +1024,29 @@ export abstract class PluginDesignCreateApi {
   ): PluginApiReturn<ComponentHandle[]>
 
   /**
-   * Place a parametric **window** family into a host wall.
+   * Place a **window** from the catalog into a host wall.
    *
-   * Identified by a saved **family definition id**. Discover ids with
+   * Identified by a **catalog (library) id** — the team object's stable `_id`
+   * or the general library's `fullName`. Discover ids with
    * {@linkcode PluginDesignWindowsApi.listCatalog}. The world `position` is
    * projected onto the host wall's face to locate the opening; the wall is
    * re-cut and the window hosted in a single undo entry. Placement is
-   * asynchronous. The sill parameter determines elevation; position Y is ignored.
+   * asynchronous (the source mesh is fetched if not cached).
    *
-   * @param familyId - Hosted window definition ID; legacy mesh catalog IDs are not accepted
+   * @param catalogId - Library id: team `_id` or general `fullName`
    * @param hostWall - The wall to host the window
    * @param position - World point projected onto the wall to locate the opening
-   * @param options - `version`, `values`, `label`, and parameter-driven `hinge`, as for door
-   * @param facing - World point selecting local +Z; omitted uses the picked face
+   * @param options - Optional placement options: `label` — instance name;
+   *   `hinge` — world point near the jamb the window is hinged on (same rule
+   *   as {@linkcode PluginDesignCreateApi.door}; default the catalog item's
+   *   authored side)
+   * @param facing - World point on the side of the wall the window opens to
+   *   (matters for asymmetric windows, e.g. casement swing) — same convention
+   *   as {@linkcode PluginDesignCreateApi.door}. Default: the engine picks a
+   *   side (nondeterministic when `position` sits on the centerline).
    * @returns the {@linkcode ComponentHandle} of the placed window
-   * @throws if the family/category/parameters are invalid, or placement or cutting fails
+   * @throws if the catalog id is unknown, the host is not a wall, the source
+   *   mesh fails to load, or the projected point falls **outside** the host wall
    *
    * @examplePrompt Add a window to this wall here
    * @examplePrompt Place a casement window on the selected wall
@@ -1087,29 +1072,28 @@ export abstract class PluginDesignCreateApi {
    *   inside that single call. Looping this single-window creator is N round-trips.
    */
   public abstract window(
-    familyId: string,
+    catalogId: string,
     hostWall: ComponentHandle,
     position: Vec3Handle,
-    options?: {
-      label?: string
-      hinge?: Vec3Handle
-      version?: number
-      values?: Record<string, number | string>
-    },
+    options?: { label?: string; hinge?: Vec3Handle },
     facing?: Vec3Handle,
   ): PluginApiReturn<ComponentHandle>
 
   /**
    * Place **many windows** into host walls in one undoable operation (bulk
-   * plural of {@linkcode window}). Each item carries its own family id, host
+   * plural of {@linkcode window}). Each item carries its own catalog id, host
    * wall, world position, and optional `facing`, `label`, `width`, `height` and
    * `sillHeight` — the same fields as a `"window"`
    * {@linkcode PluginDesignCreateOpeningOptions}. `sillHeight` is measured from
    * the host wall base to the BOTTOM of the window. Validate-all-or-throw; one
    * command.
    *
-   * Hosts keep their identity. Width, height and sillHeight set the declared
-   * width, height and sill parameters before the first cut. No mesh scaling occurs.
+   * As with the singular creator, placing an opening **re-cuts its host wall**:
+   * the wall you passed as `hostWall` stops resolving once the call returns.
+   * Several items MAY name the same original wall handle in one call — the host
+   * chains the re-cuts internally — but after the call recover the surviving
+   * wall with `design.query.getHost(opening)`, never by reusing the handle you
+   * passed in.
    *
    * @param items - One {@linkcode PluginCreateWindowItem} per window to place
    *   (≥1, ≤1000)
@@ -1117,9 +1101,10 @@ export abstract class PluginDesignCreateApi {
    * @throws `VALIDATION` if the items fail the schema (empty array, more than
    *   1000 items, unknown fields, a non-positive `width`/`height`, a negative
    *   `sillHeight`); `HANDLE_INVALID` if a `position`, `facing` or `hinge`
-   *   handle is unknown or released; `PRECONDITION_FAILED` if the family cannot be
-   *   resolved or saved, or a host is locked / is not in the active proposal;
-   *   `OPERATION_FAILED` if placement, containment, overlap checks or cutting fail
+   *   handle is unknown or released; `PRECONDITION_FAILED` if a catalog id is unknown, a
+   *   `hostWall` is not a wall / is locked / is not in the active proposal, the
+   *   projected point falls outside its host wall, or a window tool is active;
+   *   `OPERATION_FAILED` if a source mesh fails to load or placement fails
    *   (nothing is created — `details.itemIndex` is the failing item);
    *   `METHOD_NOT_PERMITTED` if the plugin may not write.
    *
@@ -1130,7 +1115,7 @@ export abstract class PluginDesignCreateApi {
    * @examplePrompt Add all the windows with a 0.9m sill height together
    *
    * @performance Bulk creator — the whole batch is ONE host round-trip and ONE undo
-   *   entry. Always prefer this over
+   *   entry, and each distinct catalog source loads once. Always prefer this over
    *   calling `design.create.window` in a loop: build the full `items[]` array first
    *   (all host walls and points up front), then make one call.
    *
@@ -1140,8 +1125,8 @@ export abstract class PluginDesignCreateApi {
    * const [wall] = await snaptrude.design.query.listWalls({ isSelected: true })
    * const [casement] = await snaptrude.design.windows.listCatalog()
    * const placed = await snaptrude.design.create.windows([
-   *   { familyId: casement.id, hostWall: wall, position: await v.new(2, 0, 5), values: { sill: "900mm" } },
-   *   { familyId: casement.id, hostWall: wall, position: await v.new(5, 0, 5), values: { sill: "900mm" } },
+   *   { catalogId: casement.id, hostWall: wall, position: await v.new(2, 0, 5), sillHeight: 0.9 },
+   *   { catalogId: casement.id, hostWall: wall, position: await v.new(5, 0, 5), sillHeight: 0.9 },
    * ])
    * const currentWall = await snaptrude.design.query.getHost(placed[0])
    * ```
@@ -1151,17 +1136,17 @@ export abstract class PluginDesignCreateApi {
   ): PluginApiReturn<ComponentHandle[]>
 
   /**
-   * Place a parametric **door or window** into a host wall with parameter overrides.
+   * Place a catalog **door or window** into a host wall with optional size overrides.
    *
    * The world `position` is projected onto the host wall to locate the opening.
    * All supplied dimensions use Snaptrude engine units. Window `sillHeight` is
    * measured from the host wall base to the bottom of the window, not to
    * its center. Placement is asynchronous and committed as one undoable creation.
    *
-   * @param options - Opening kind, family and host references, placement, and
+   * @param options - Opening kind, catalog and host references, placement, and
    *   optional facing (swing side), hinge (hinged jamb), label, and dimensions
    * @returns the {@linkcode ComponentHandle} of the placed door or window
-   * @throws if the options are invalid, the family id is unknown, the host is
+   * @throws if the options are invalid, the catalog id is unknown, the host is
    *   not a wall, loading fails, or the opening cannot be placed on the host
    *
    * @examplePrompt Add a 1m wide door to this wall here
@@ -1175,7 +1160,7 @@ export abstract class PluginDesignCreateApi {
    * ```ts
    * const opening = await snaptrude.design.create.opening({
    *   kind: "window",
-   *   familyId: windowType.id,
+   *   catalogId: windowType.id,
    *   hostWall: wall,
    *   position: await snaptrude.core.math.vec3.new(3, 0, 5),
    *   width: 1.2,
@@ -1675,7 +1660,7 @@ export type PluginDesignCreateBeamArgs = z.infer<
  * | `profile` | {@linkcode ProfileHandle} | Ordered curve chain (wall centerlines) |
  * | `height` | `number`? | Wall height (default engine default) |
  * | `thickness` | `number`? | Wall thickness (default: `wallType`'s total layer thickness when given, else engine default) |
- * | `wallType` | {@linkcode PluginWallType}? | Legacy name/id or exact native `{ id, version }` pin from `design.types.list("wall")` (default generic) |
+ * | `wallType` | `string`? | Wall type name from `design.types.list("wall")` — layers/material/thickness defaults (default generic) |
  * | `storey` | `number`? | Target storey (integer, must exist) — walls assigned + lifted to its base in the same undo entry (default: geometry-derived) |
  * | `topProfiles` | ({@linkcode PluginWallTopProfile} \| `null`)[]? | Top edge per curve (same order); `null`/missing = flat at `height`. Straight curves only |
  */
@@ -1683,10 +1668,9 @@ export const PluginDesignCreateWallsArgs = z.object({
   profile: ProfileHandle,
   height: z.number().optional(),
   thickness: z.number().optional(),
-  wallType: PluginWallType.optional(),
+  wallType: z.string().min(1).optional(),
   storey: z.number().int().optional(),
   topProfiles: z.array(PluginWallTopProfile.nullable()).optional(),
-  values: PluginFamilyValues.optional(),
 })
 export type PluginDesignCreateWallsArgs = z.infer<
   typeof PluginDesignCreateWallsArgs
@@ -1759,23 +1743,26 @@ export type PluginDesignCreateFurnitureArgs = z.infer<
  *
  * | Property | Type | Description |
  * |---|---|---|
- * | `familyId` | `string` | Hosted door family definition ID |
- * | `version` | `number`? | Exact version; newest known by default |
- * | `values` | `Record<string, number \| string>`? | Parameters; numeric lengths use SU |
+ * | `catalogId` | `string` | Library id: team `_id` or general `fullName` |
  * | `hostWall` | {@linkcode ComponentHandle} | The wall to host the door |
  * | `position` | {@linkcode Vec3Handle} | World point projected onto the wall |
  * | `label` | `string`? | Instance name (optional) |
  * | `facing` | {@linkcode Vec3Handle}? | World point on the side of the wall the door swings open to (default engine-chosen) |
- * | `hinge` | {@linkcode Vec3Handle}? | World point near the hinged jamb; requires hand control |
+ * | `hinge` | {@linkcode Vec3Handle}? | World point near the jamb the door is hinged on (default the catalog item's authored side) |
  */
 export const PluginDesignCreateDoorArgs = z.object({
-  ...PluginOpeningBaseOptions,
+  catalogId: z.string().min(1),
+  hostWall: ComponentHandle,
+  position: Vec3Handle,
+  label: z.string().optional(),
+  facing: Vec3Handle.optional(),
+  hinge: Vec3Handle.optional(),
 })
 export type PluginDesignCreateDoorArgs = z.infer<
   typeof PluginDesignCreateDoorArgs
 >
 // TRANSPORT: positional signature shipped — facing is the trailing 5th arg, hinge rides in options:
-//   door(familyId, hostWall, position, options?: { label?, hinge?, version?, values? }, facing?)
+//   door(catalogId: string, hostWall: ComponentHandle, position: Vec3Handle, options?: { label?, hinge? }, facing?: Vec3Handle)
 
 // ---------------------------------------------------------------------------
 // window
@@ -1786,23 +1773,26 @@ export type PluginDesignCreateDoorArgs = z.infer<
  *
  * | Property | Type | Description |
  * |---|---|---|
- * | `familyId` | `string` | Hosted window family definition ID |
- * | `version` | `number`? | Exact version; newest known by default |
- * | `values` | `Record<string, number \| string>`? | Parameters; numeric lengths use SU |
+ * | `catalogId` | `string` | Library id: team `_id` or general `fullName` |
  * | `hostWall` | {@linkcode ComponentHandle} | The wall to host the window |
  * | `position` | {@linkcode Vec3Handle} | World point projected onto the wall |
  * | `label` | `string`? | Instance name (optional) |
  * | `facing` | {@linkcode Vec3Handle}? | World point on the side of the wall the window opens to (default engine-chosen) |
- * | `hinge` | {@linkcode Vec3Handle}? | World point near the hinged jamb; requires hand control |
+ * | `hinge` | {@linkcode Vec3Handle}? | World point near the jamb the window is hinged on (default the catalog item's authored side) |
  */
 export const PluginDesignCreateWindowArgs = z.object({
-  ...PluginOpeningBaseOptions,
+  catalogId: z.string().min(1),
+  hostWall: ComponentHandle,
+  position: Vec3Handle,
+  label: z.string().optional(),
+  facing: Vec3Handle.optional(),
+  hinge: Vec3Handle.optional(),
 })
 export type PluginDesignCreateWindowArgs = z.infer<
   typeof PluginDesignCreateWindowArgs
 >
 // TRANSPORT: positional signature shipped — facing is the trailing 5th arg, hinge rides in options:
-//   window(familyId, hostWall, position, options?: { label?, hinge?, version?, values? }, facing?)
+//   window(catalogId: string, hostWall: ComponentHandle, position: Vec3Handle, options?: { label?, hinge? }, facing?: Vec3Handle)
 
 // ---------------------------------------------------------------------------
 // opening

package/src/api/design/create/opening-fields.ts

@@ -6,30 +6,27 @@ import { ComponentHandle, Vec3Handle } from "../../../handles"
  * {@linkcode PluginDesignCreateOpeningOptions} and by the bulk item schemas in
  * `bulk-items.ts`, so singular and plural openings validate identically.
  *
- * PC-only placement. The family recipe owns dimensions and geometry. Overrides
- * are applied before fit checks and cutting, never by scaling generated meshes.
- * `facing` selects the host frame's +Z side. `hinge` selects the declared
- * `hand` parameter (left/right); families without that control reject it.
+ * `facing` and `hinge` are WORLD POINTS, not directions: `facing` sits on the
+ * side of the wall the leaf swings open to (where the plan symbol draws the
+ * swing arc); `hinge` sits near the jamb the leaf is hinged on — the item is
+ * reflected along the wall so its hinged jamb is the one nearer that point.
+ * Either may be omitted (engine-chosen side / the catalog item's authored
+ * hinge side). Neither has a visible effect on symmetric items such as
+ * sliders or fixed windows.
  *
  * | Property | Type | Description |
  * |---|---|---|
- * | `familyId` | `string` | Hosted parametric definition ID, not a mesh catalog ID |
- * | `version` | `number`? | Exact family version; newest known by default |
- * | `values` | `Record<string, number \| string>`? | Authored instance parameters; numeric lengths use Snaptrude units |
+ * | `catalogId` | `string` | Library id: team `_id` or general `fullName` |
  * | `hostWall` | {@linkcode ComponentHandle} | The wall to host the opening |
  * | `position` | {@linkcode Vec3Handle} | World point projected onto the wall |
  * | `facing` | {@linkcode Vec3Handle}? | World point on the side of the wall the opening swings open to (default engine-chosen) |
- * | `hinge` | {@linkcode Vec3Handle}? | World point near the hinged jamb; requires the recipe's hand parameter |
+ * | `hinge` | {@linkcode Vec3Handle}? | World point near the jamb the opening is hinged on (default the catalog item's authored side) |
  * | `label` | `string`? | Instance name (optional) |
- * | `width` | `number`? | Sets the declared width parameter, not the opening's evaluated envelope |
- * | `height` | `number`? | Sets the declared height parameter |
+ * | `width` | `number`? | Width override (Snaptrude units, > 0; default the catalog item's) |
+ * | `height` | `number`? | Height override (Snaptrude units, > 0; default the catalog item's) |
  */
 export const PluginOpeningBaseOptions = {
-  familyId: z.string().min(1),
-  version: z.number().int().positive().optional(),
-  values: z
-    .record(z.string(), z.union([z.number().finite(), z.string()]))
-    .optional(),
+  catalogId: z.string().min(1),
   hostWall: ComponentHandle,
   position: Vec3Handle,
   facing: Vec3Handle.optional(),