@snaptrude/plugin-core 0.11.0-rc.1 → 1.0.0

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

@@ -3,7 +3,51 @@ import { PluginApiReturn } from "../../../types";
 import { ComponentHandle } from "../../../handles";
 import { PluginSpaceUpdateResult } from "../../entity/space";
 import { PluginDesignChangeResult } from "../lock";
-import { PluginBuildableEnvelopePolygonVertex, PluginBuildableEnvelopeSetbackTier, PluginBuildableEnvelopeVerticalCap, PluginBuildableEnvelopeUpdateResult } from "../../entity/buildableEnvelope";
+import { MassParametersPatch, type MassParametersRecord } from "../../../massParameters";
+import { PluginBuildableEnvelopePolygonVertex, PluginBuildableEnvelopeSetbackTier, PluginBuildableEnvelopeVerticalCap, PluginBuildableEnvelopeUpdateResult, PluginSiteEdgePatch, PluginDesignUpdateSiteEdgeResult } from "../../entity/buildableEnvelope";
+import { type PluginFamilyUpdates } from "../catalog";
+/** A project style; its pen/pattern and native legacy mirror change together. */
+export declare const PluginReferenceLineStylePatch: z.ZodObject<{
+    styleId: z.ZodEnum<{
+        hidden: "hidden";
+        thin: "thin";
+        medium: "medium";
+        wide: "wide";
+        overhead: "overhead";
+        demolished: "demolished";
+        centerline: "centerline";
+    }>;
+}, z.core.$strict>;
+export type PluginReferenceLineStylePatch = z.infer<typeof PluginReferenceLineStylePatch>;
+/** Arguments for design.update.referenceLine. */
+export declare const PluginDesignUpdateReferenceLineArgs: z.ZodObject<{
+    referenceLineId: z.ZodString;
+    patch: z.ZodObject<{
+        styleId: z.ZodEnum<{
+            hidden: "hidden";
+            thin: "thin";
+            medium: "medium";
+            wide: "wide";
+            overhead: "overhead";
+            demolished: "demolished";
+            centerline: "centerline";
+        }>;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+/** Styled line id and the applied project style. */
+export declare const PluginDesignUpdateReferenceLineResult: z.ZodObject<{
+    referenceLineId: z.ZodString;
+    styleId: z.ZodEnum<{
+        hidden: "hidden";
+        thin: "thin";
+        medium: "medium";
+        wide: "wide";
+        overhead: "overhead";
+        demolished: "demolished";
+        centerline: "centerline";
+    }>;
+}, z.core.$strip>;
+export type PluginDesignUpdateReferenceLineResult = z.infer<typeof PluginDesignUpdateReferenceLineResult>;
 /**
  * Sparse property updates for a space. Only provided fields change.
  *
@@ -18,11 +62,11 @@ import { PluginBuildableEnvelopePolygonVertex, PluginBuildableEnvelopeSetbackTie
 export declare const PluginSpacePropertyUpdates: z.ZodObject<{
     room_type: z.ZodOptional<z.ZodString>;
     massType: z.ZodOptional<z.ZodEnum<{
+        Furniture: "Furniture";
         Room: "Room";
         Plinth: "Plinth";
         Void: "Void";
         Pergola: "Pergola";
-        Furniture: "Furniture";
         "Facade element": "Facade element";
         "Generic mass": "Generic mass";
         Department: "Department";
@@ -68,11 +112,11 @@ export declare const PluginUpdateSpaceItem: z.ZodObject<{
     properties: z.ZodOptional<z.ZodObject<{
         room_type: z.ZodOptional<z.ZodString>;
         massType: z.ZodOptional<z.ZodEnum<{
+            Furniture: "Furniture";
             Room: "Room";
             Plinth: "Plinth";
             Void: "Void";
             Pergola: "Pergola";
-            Furniture: "Furniture";
             "Facade element": "Facade element";
             "Generic mass": "Generic mass";
             Department: "Department";
@@ -194,6 +238,19 @@ export declare const PluginDesignUpdateStaircaseArgs: z.ZodObject<{
     }, z.core.$strip>;
 }, z.core.$strip>;
 export type PluginDesignUpdateStaircaseArgs = z.infer<typeof PluginDesignUpdateStaircaseArgs>;
+/**
+ * Arguments for {@linkcode PluginDesignUpdateApi.parameters}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `component` | {@linkcode ComponentHandle} | The parametric mass to edit |
+ * | `patch` | {@linkcode MassParametersPatch} | Partial `values` (+ optional `operations`), or the full edited record |
+ */
+export declare const PluginDesignUpdateParametersArgs: z.ZodObject<{
+    component: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+    patch: z.ZodType<MassParametersPatch, MassParametersPatch, z.core.$ZodTypeInternals<MassParametersPatch, MassParametersPatch>>;
+}, z.core.$strip>;
+export type PluginDesignUpdateParametersArgs = z.infer<typeof PluginDesignUpdateParametersArgs>;
 /**
  * Sparse edits for a wall (all optional; at least one required). Only the
  * fields you provide change. Dimensions are in **engine units** (the same
@@ -204,12 +261,16 @@ export type PluginDesignUpdateStaircaseArgs = z.infer<typeof PluginDesignUpdateS
  * |---|---|---|
  * | `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 declare const PluginWallUpdates: z.ZodObject<{
     thickness: z.ZodOptional<z.ZodNumber>;
     height: z.ZodOptional<z.ZodNumber>;
-    type: z.ZodOptional<z.ZodString>;
+    type: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodNumber;
+    }, z.core.$strip>]>>;
+    values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean]>>>;
 }, z.core.$strip>;
 export type PluginWallUpdates = z.infer<typeof PluginWallUpdates>;
 /**
@@ -229,6 +290,11 @@ export type PluginWallUpdates = z.infer<typeof PluginWallUpdates>;
 export declare const PluginSlabUpdates: z.ZodObject<{
     thickness: z.ZodOptional<z.ZodNumber>;
     overhang: z.ZodOptional<z.ZodNumber>;
+    type: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodNumber;
+    }, z.core.$strict>, z.ZodString]>>;
+    values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean]>>>;
 }, z.core.$strip>;
 export type PluginSlabUpdates = z.infer<typeof PluginSlabUpdates>;
 /** Arguments for {@linkcode PluginDesignUpdateApi.wall}. */
@@ -237,7 +303,11 @@ export declare const PluginDesignUpdateWallArgs: z.ZodObject<{
     updates: z.ZodObject<{
         thickness: z.ZodOptional<z.ZodNumber>;
         height: z.ZodOptional<z.ZodNumber>;
-        type: z.ZodOptional<z.ZodString>;
+        type: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+            id: z.ZodString;
+            version: z.ZodNumber;
+        }, z.core.$strip>]>>;
+        values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean]>>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
 export type PluginDesignUpdateWallArgs = z.infer<typeof PluginDesignUpdateWallArgs>;
@@ -250,6 +320,11 @@ export declare const PluginDesignUpdateSlabArgs: z.ZodObject<{
     updates: z.ZodObject<{
         thickness: z.ZodOptional<z.ZodNumber>;
         overhang: z.ZodOptional<z.ZodNumber>;
+        type: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+            id: z.ZodString;
+            version: z.ZodNumber;
+        }, z.core.$strict>, z.ZodString]>>;
+        values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodBoolean]>>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
 export type PluginDesignUpdateSlabArgs = z.infer<typeof PluginDesignUpdateSlabArgs>;
@@ -278,14 +353,106 @@ export declare const PluginDesignSetStoreyArgs: z.ZodObject<{
     storey: z.ZodNumber;
 }, z.core.$strip>;
 export type PluginDesignSetStoreyArgs = z.infer<typeof PluginDesignSetStoreyArgs>;
+/**
+ * Object types {@linkcode PluginDesignUpdateApi.setObjectType} can turn a mass
+ * into — the `design.query` `type` vocabulary.
+ */
+export declare const PluginObjectType: z.ZodEnum<{
+    floor: "floor";
+    wall: "wall";
+    slab: "slab";
+    roof: "roof";
+}>;
+export type PluginObjectType = z.infer<typeof PluginObjectType>;
+/**
+ * Arguments for {@linkcode PluginDesignUpdateApi.setObjectType}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `components` | {@linkcode ComponentHandle}`[]` | The masses to convert (>= 1) |
+ * | `objectType` | {@linkcode PluginObjectType} | Target object type (`"wall"`, `"roof"`, `"slab"`, `"floor"`) |
+ */
+export declare const PluginDesignSetObjectTypeArgs: z.ZodObject<{
+    components: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+    objectType: z.ZodEnum<{
+        floor: "floor";
+        wall: "wall";
+        slab: "slab";
+        roof: "roof";
+    }>;
+}, z.core.$strip>;
+export type PluginDesignSetObjectTypeArgs = z.infer<typeof PluginDesignSetObjectTypeArgs>;
+/**
+ * The sparse GROUP-LEVEL patch accepted by {@linkcode PluginDesignUpdateApi.grid}.
+ * Only provided fields change. Wing- and line-level updates live on the grids
+ * entity family: `design.grids.updateWings` / `design.grids.updateLines`.
+ */
+export declare const PluginGridPatch: z.ZodObject<{
+    angle: z.ZodOptional<z.ZodNumber>;
+    props: z.ZodOptional<z.ZodObject<{
+        style: z.ZodOptional<z.ZodEnum<{
+            SOLID: "SOLID";
+            DASHED: "DASHED";
+            DOT_DASH: "DOT_DASH";
+        }>>;
+        weight: z.ZodOptional<z.ZodNumber>;
+        color: z.ZodOptional<z.ZodString>;
+        showStart: z.ZodOptional<z.ZodBoolean>;
+        showEnd: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    storeyVisibility: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        storey: z.ZodNumber;
+        visible: z.ZodBoolean;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type PluginGridPatch = z.infer<typeof PluginGridPatch>;
+/** Arguments for {@linkcode PluginDesignUpdateApi.grid}. */
+export declare const PluginDesignUpdateGridArgs: z.ZodObject<{
+    grid: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+    patch: z.ZodObject<{
+        angle: z.ZodOptional<z.ZodNumber>;
+        props: z.ZodOptional<z.ZodObject<{
+            style: z.ZodOptional<z.ZodEnum<{
+                SOLID: "SOLID";
+                DASHED: "DASHED";
+                DOT_DASH: "DOT_DASH";
+            }>>;
+            weight: z.ZodOptional<z.ZodNumber>;
+            color: z.ZodOptional<z.ZodString>;
+            showStart: z.ZodOptional<z.ZodBoolean>;
+            showEnd: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>;
+        storeyVisibility: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            storey: z.ZodNumber;
+            visible: z.ZodBoolean;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type PluginDesignUpdateGridArgs = z.infer<typeof PluginDesignUpdateGridArgs>;
 /**
  * `snaptrude.design.update` — edit existing scene entities (properties + geometry).
  *
  * 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 declare abstract class PluginDesignUpdateApi {
     constructor();
+    /**
+     * Apply a project style through the native reference-line property command.
+     * One saved undo step; no selection or tool preference changes. Saves the
+     * legacy thickness/mode mirror too. Requires Paper Pens and an editable line
+     * in the current proposal. A no-op creates no history entry.
+     * @param referenceLineId - Existing reference line id.
+     * @param patch - styleId from the project line-style catalog.
+     * @returns The line id and applied style id.
+     * @example await snaptrude.design.update.referenceLine(id, { styleId: "wide" })
+     */
+    abstract referenceLine(referenceLineId: string, patch: PluginReferenceLineStylePatch): PluginApiReturn<PluginDesignUpdateReferenceLineResult>;
     /**
      * Set a component's **Label** — the same editable Label field the properties
      * panel shows (doors, windows, furniture, spaces, and every other labelled
@@ -325,6 +492,33 @@ export declare abstract class PluginDesignUpdateApi {
      * ```
      */
     abstract setLabel(component: ComponentHandle, label: string): PluginApiReturn<boolean>;
+    /**
+     * Update a structural grid's **group-level** fields with a sparse patch —
+     * default line styling, absolute angle, and per-storey 2D visibility. Only
+     * provided fields change. Wing- and line-level updates live on the grids
+     * entity family: {@linkcode PluginDesignGridsApi.updateWings} /
+     * {@linkcode PluginDesignGridsApi.updateLines}.
+     *
+     * Every change routes through the exact setters the native panel uses —
+     * each changed field commits its own undoable command, identical to editing
+     * that field in the panel. `angle` is an absolute target in degrees (CCW
+     * about +Y).
+     *
+     * @param grid - The grid group to update
+     * @param patch - The sparse {@linkcode PluginGridPatch}
+     * @returns `true` once applied
+     *
+     * @examplePrompt Rotate the grid to 45 degrees
+     * @examplePrompt Make this grid's lines dashed and grey
+     * @examplePrompt Hide this grid on storey 3's plan
+     *
+     * # Example
+     * ```ts
+     * const [grid] = await snaptrude.design.query.listGrids()
+     * await snaptrude.design.update.grid(grid, { angle: 45, props: { style: "DASHED" } })
+     * ```
+     */
+    abstract grid(grid: ComponentHandle, patch: PluginGridPatch): PluginApiReturn<boolean>;
     /**
      * Update a single space (room) — change its properties (room label, space
      * type, mass type, area class, department) and/or replace its geometry by
@@ -334,6 +528,8 @@ export declare 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
@@ -363,6 +559,7 @@ export declare 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
@@ -433,6 +630,94 @@ export declare abstract class PluginDesignUpdateApi {
      * ```
      */
     abstract staircase(staircases: ComponentHandle[], params: PluginStaircaseParamUpdates): PluginApiReturn<PluginDesignChangeResult>;
+    /**
+     * Edit a parametric mass by patching its creation recipe and rebuilding the
+     * solid in place — the mass keeps its id, storey, materials, position and
+     * linked copies; only the geometry changes. Read the current record with
+     * `design.query.getParameters` first.
+     *
+     * `patch` is a partial of `record.values` — or the whole record you read
+     * back, edited. A key you leave out is unchanged (that includes
+     * `operations`). Each key you send replaces that value whole — a scalar, a
+     * point, a list or a record (`contour`, `profile`, `sections`, `path`,
+     * `options`, `operations`) alike — so send the complete value you read,
+     * edited (a partial `options` drops the switches it leaves out);
+     * `{ operations: [] }` drops every operation. An optional key
+     * the record does not carry yet may be patched in when the kind allows it:
+     * a straight extrusion acquires `twistInDegrees` or `topScale`, an
+     * options-less loft or sweep acquires `options` (`levels` is not one — send
+     * the angle, not the section count). A patch that changes nothing
+     * returns the current record and records no edit (no undo step). `kind` and
+     * `version` are immutable: to change the kind, build a new mass. Keys are the
+     * record's `values` keys for its `kind` (sphere: `centre`, `radius`;
+     * cylinder: `base`, `axis`, `radius`, `height`; torus: `centre`, `axis`,
+     * `majorRadius`, `minorRadius`; …) plus `operations`. To change a fillet
+     * radius, edit `operations[i].radius` in the record you read and send
+     * `{ operations }` back. Points and axes are WORLD coordinates in internal
+     * units, exactly as `getParameters` reports them.
+     *
+     * Rebuilds in memory first, then swaps onto the SAME component; every linked
+     * copy regenerates together. One undo step; saves and syncs to collaborators
+     * like any geometry edit. Kernel kinds (revolution, sweep, loft, primitives,
+     * any `operations`) run on OpenCascade — expect a short pause.
+     *
+     * @param component - a mass whose `getParameters` is non-null
+     * @param patch - partial `values` (+ optional `operations`), or the full edited record
+     * @returns the complete post-edit record, world coordinates (what
+     *   `getParameters` now returns)
+     * @throws PRECONDITION_FAILED when the component is not a mass (a family
+     *   instance: use `design.family.setParameters`).
+     *   Also PRECONDITION_FAILED when the mass carries no live recipe — built
+     *   from a boolean, split, `brepFromFaces`/`brepFromMesh` or drawn; edited
+     *   free-form since (push/pull, move face, boolean); or scaled with the
+     *   transform tool. `getParameters` returns `null` for exactly these.
+     *   Do not retry — rebuild it with a recipe constructor and say so.
+     *   A scaled mass is the exception: undo the scale and call again.
+     *   Also PRECONDITION_FAILED when the mass (or a linked copy) is **locked**
+     *   (the message says so). Locking is invisible to `getParameters` — a
+     *   locked parametric mass still reads back a full record. Unlock it (and
+     *   every linked copy) and call again; never rebuild it, the recipe is intact.
+     *   Also PRECONDITION_FAILED when an `operations` entry's edge/face selectors
+     *   no longer resolve on the rebuilt base (the message names the operation
+     *   and edge): re-select the edges on the new shape and re-apply that
+     *   operation.
+     *   Also PRECONDITION_FAILED when the edit is the first twist or taper — or
+     *   the straightening — of an extrusion that carries a shell, fillet or
+     *   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 ∉
+     *   (0, 360], a profile crossing its axis, a spline with fewer than
+     *   degree + 1 poles).
+     * @throws OPERATION_FAILED when the kernel cannot build the edited recipe;
+     *   the model is left unchanged.
+     *
+     * @examplePrompt Make the dome's radius 8 metres
+     * @examplePrompt Raise the podium to 5 m
+     * @examplePrompt Widen the vase — move its profile points 20 cm outward
+     * @examplePrompt Change the fillet on the rounded column to 300 mm
+     *
+     * # Example
+     * ```ts
+     * // { kind: "sphere", values: { centre, radius: 19.685 }, … }
+     * const before = await snaptrude.design.query.getParameters(dome)
+     * const after = await snaptrude.design.update.parameters(dome, { radius: 31.496 }) // 8 m in internal units
+     *
+     * // Fillet radius on a recorded result: read → edit → send the array back
+     * const rec = await snaptrude.design.query.getParameters(column)
+     * const operations = rec?.operations ?? []
+     * if (operations[0]?.op === "fillet") {
+     *   operations[0].radius = 1.181
+     *   await snaptrude.design.update.parameters(column, { operations })
+     * }
+     * ```
+     */
+    abstract parameters(component: ComponentHandle, patch: MassParametersPatch): PluginApiReturn<MassParametersRecord>;
     /**
      * Edit a **wall** — its thickness and/or height (the same command the
      * properties panel's Thickness/Height fields drive) and/or its **wall type**
@@ -587,6 +872,16 @@ export declare abstract class PluginDesignUpdateApi {
      * ```
      */
     abstract ceiling(component: ComponentHandle, 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.
+     */
+    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.
+     */
+    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
@@ -682,12 +977,61 @@ export declare abstract class PluginDesignUpdateApi {
      * ```
      */
     abstract setStorey(components: ComponentHandle[], storey: number): PluginApiReturn<PluginDesignChangeResult>;
+    /**
+     * Change the **object type** of one or more masses — turn a mass into a real
+     * wall, roof, slab or floor: the properties panel's Object Type dropdown,
+     * headless. The geometry is kept exactly as it is (a wedge stays a wedge;
+     * nothing is flattened to a default thickness), so a sloped mass built with
+     * `design.create.massFromBrep` becomes a sloped roof or a raked wall. The
+     * component keeps its handle, label and storey; it gains the target type's
+     * construction layers and properties, and the type's default material when
+     * the mass still wore the default. One undoable operation for the whole
+     * list; undo turns them back into masses.
+     *
+     * Instances convert as a family: passing one instance (or the source) of an
+     * instanced mass converts its source and every sibling; `affected` echoes
+     * every visible member (the hidden instancing template converts too but is
+     * not listed). A converted component cannot be converted again (same rule
+     * as the panel). A converted wall has no parametric centerline: it hosts
+     * doors and windows and exports, but neighbours do not re-mitre against it.
+     *
+     * Throws before anything changes (all-or-nothing) when a component is not a
+     * mass, is a plinth, is locked or in a locked bucket, already had its type
+     * changed, or when a handle is gone/forged.
+     *
+     * @param components - The masses to convert
+     * @param objectType - Target type: `"wall"`, `"roof"`, `"slab"` or `"floor"`
+     *   (the `design.query.getEntityType` vocabulary)
+     * @returns the visible components converted — the same handles, plus any
+     *   instance siblings pulled in by family expansion
+     *
+     * @examplePrompt Convert this mass into a wall
+     * @examplePrompt Turn the sloped mass into a roof
+     * @examplePrompt Make these masses real slabs
+     * @examplePrompt Change the object type of the selection to wall
+     * @examplePrompt Convert the wedge I built into a raked wall
+     * @examplePrompt Turn this mass into a floor
+     *
+     * # Example
+     * ```ts
+     * const brep = await snaptrude.core.geom.create.brepFromFaces(wedgeFaces)
+     * const wedge = await snaptrude.design.create.massFromBrep(brep, "Gable end")
+     * const { affected } = await snaptrude.design.update.setObjectType([wedge], "wall")
+     * console.log(await snaptrude.design.query.getEntityType(affected[0])) // "wall"
+     * ```
+     */
+    abstract setObjectType(components: ComponentHandle[], objectType: PluginObjectType): PluginApiReturn<PluginDesignChangeResult>;
     /**
      * Update an existing parametric buildable envelope — regenerate the zoning
      * volume from a revised site polygon, setbacks, vertical cap, or FAR and
      * lot-coverage limits, keeping the same envelope id. Canonical home of the
      * update formerly at `entity.buildableEnvelope.update` (now deprecated).
      *
+     * Edge state is preserved, like the right panel: every edge's type
+     * (front/side/rear) is kept. For each type whose value changed (by more than
+     * 2 mm), the per-edge custom distances on edges of that type are cleared;
+     * custom distances on types whose value did not change are kept.
+     *
      * @param buildableEnvelopeId - Existing envelope ID to update; non-empty and
      *   must match an existing envelope on the canvas.
      * @param sitePolygon - Site polygon vertices in `lengthUnit`; minimum 3 vertices.
@@ -698,9 +1042,15 @@ export declare abstract class PluginDesignUpdateApi {
      * @param farRatio - Optional FAR value, positive when provided.
      * @param lotCoverageMaxPct - Optional lot coverage cap, `0..100`.
      * @returns A {@linkcode PluginBuildableEnvelopeUpdateResult} with the
-     *   `buildableEnvelopeId` of the updated envelope.
+     *   `buildableEnvelopeId` of the updated envelope and `clearedEdgeSetbacks`,
+     *   the `edgeIndex` of each edge that lost its custom distance (empty when
+     *   none). Tell the user about any cleared edges.
      * @throws If validation fails, the envelope does not exist, or generation
-     *   produces no renderable geometry.
+     *   produces no renderable geometry. Also throws `PRECONDITION_FAILED`
+     *   (`details.reason: "STALE_EDGE_SETTINGS"`, nothing changes) when the site
+     *   outline changed since the edge settings were made. Tell the user;
+     *   editing any edge on the canvas setback pills resets the edge settings
+     *   to the new outline (dropping the old ones), after which you can retry.
      *
      * @examplePrompt Change the envelope's height limit to 175 feet
      * @examplePrompt Update the setbacks on the buildable envelope
@@ -725,5 +1075,59 @@ export declare abstract class PluginDesignUpdateApi {
      * ```
      */
     abstract buildableEnvelope(buildableEnvelopeId: string, sitePolygon: PluginBuildableEnvelopePolygonVertex[], lengthUnit: "ft" | "m", setbacks: PluginBuildableEnvelopeSetbackTier[], verticalCap: PluginBuildableEnvelopeVerticalCap, floorToFloor: number, farRatio?: number, lotCoverageMaxPct?: number): PluginApiReturn<PluginBuildableEnvelopeUpdateResult>;
+    /**
+     * Change one site edge's type (front / side / rear) and/or give that edge
+     * its own setback distance, the same as editing a setback pill on the
+     * canvas. One undo step; the pills and Site Analysis sheet refresh.
+     *
+     * Address the edge with `siteId` and `edgeIndex` from
+     * `program.site.listEdges()`. Setting `role` clears that edge's own
+     * distance. `setback: null` clears the edge's own distance and puts it back
+     * on its type's distance. When `role` and a numeric `setback` are both
+     * given, the role is applied first and then the setback, so the new distance
+     * wins. On the only edge of its type, a numeric setback becomes that type's
+     * value (like the canvas pills), so `null` afterwards has nothing to
+     * clear; set the type's value instead. Only call this when the user asks to
+     * change an edge.
+     *
+     * @param siteId - Site component id, from `program.site.listEdges()`.
+     * @param edgeIndex - Edge index from `program.site.listEdges()`; nonnegative
+     *   integer, upper bound checked by the host.
+     * @param patch - A {@linkcode PluginSiteEdgePatch}: `role`, `setback` (a
+     *   number in `lengthUnit`, or `null` to clear), and `lengthUnit` (required
+     *   with a numeric `setback`). Provide `role` and/or `setback`.
+     * @returns The refreshed {@linkcode PluginDesignUpdateSiteEdgeResult} for the
+     *   site, as `program.site.listEdges()` returns it.
+     * @throws
+     *   - `HANDLE_INVALID`: unknown `siteId` (invalid site handle).
+     *   - `VALIDATION`: `edgeIndex` is out of range or not a nonnegative
+     *     integer; when the index is out of range, `details` include `edgeCount`.
+     *   - `PRECONDITION_FAILED`, with `details.reason` one of:
+     *     - `NO_BUILDABLE_ENVELOPE`: the site has no envelope to store edge
+     *       settings on. Ask the user whether to create a default envelope with
+     *       `design.create.buildableEnvelopeFromSite(siteId)` or to create one
+     *       themselves; do not create one unasked.
+     *     - `MASSING_ENVELOPE`: the site's envelope is a massing envelope. Tell
+     *       the user; change nothing.
+     *     - `ENVELOPE_TRANSFORMED`: the envelope has been rotated or scaled, so
+     *       edge editing is unavailable. Tell the user.
+     *     - `STALE_EDGE_SETTINGS`: the site outline changed since the edge
+     *       settings were made. Tell the user; editing any edge on the canvas
+     *       setback pills resets the edge settings to the new outline (dropping
+     *       the old ones), after which you can retry.
+     *
+     * @examplePrompt Make edge 2 the front
+     * @examplePrompt Set just the north edge setback to 8 m
+     * @examplePrompt Remove the custom setback on edge 3
+     *
+     * # Example
+     * ```ts
+     * const [{ siteId }] = (await snaptrude.program.site.listEdges()).sites
+     * await snaptrude.design.update.siteEdge(siteId, 2, { role: "front" })
+     * await snaptrude.design.update.siteEdge(siteId, 3, { setback: 8, lengthUnit: "m" })
+     * await snaptrude.design.update.siteEdge(siteId, 3, { setback: null })
+     * ```
+     */
+    abstract siteEdge(siteId: string, edgeIndex: number, patch: PluginSiteEdgePatch): PluginApiReturn<PluginDesignUpdateSiteEdgeResult>;
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +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;AAEvC;;;;;;;;;;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;;;;;GAKG;AACH,8BAAsB,qBAAqB;;IAGzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;aACa,QAAQ,CACtB,SAAS,EAAE,eAAe,EAC1B,KAAK,EAAE,MAAM,GACZ,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"}
+{"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,mBAAmB,EACnB,KAAK,oBAAoB,EAC1B,MAAM,yBAAyB,CAAA;AAChC,OAAO,EACL,oCAAoC,EACpC,kCAAkC,EAClC,kCAAkC,EAClC,mCAAmC,EACnC,mBAAmB,EACnB,gCAAgC,EACjC,MAAM,gCAAgC,CAAA;AAKvC,OAAO,EAGL,KAAK,mBAAmB,EACzB,MAAM,YAAY,CAAA;AAEnB,iFAAiF;AACjF,eAAO,MAAM,6BAA6B;;;;;;;;;;kBAI/B,CAAA;AACX,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED,iDAAiD;AACjD,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;kBAKrC,CAAA;AAEX,oDAAoD;AACpD,eAAO,MAAM,qCAAqC;;;;;;;;;;;iBAGhD,CAAA;AACF,MAAM,MAAM,qCAAqC,GAAG,CAAC,CAAC,KAAK,CACzD,OAAO,qCAAqC,CAC7C,CAAA;AAED;;;;;;;;;;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;;;;;;;GAOG;AACH,eAAO,MAAM,gCAAgC;;;iBAG3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;iBAS1B,CAAA;AACJ,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAEjE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;iBAS1B,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;;;GAGG;AACH,eAAO,MAAM,gBAAgB;;;;;EAK3B,CAAA;AACF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAE/D;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;iBAGxC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,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,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;;;;;;;;GAUG;AACH,8BAAsB,qBAAqB;;IAGzC;;;;;;;;;OASG;aACa,aAAa,CAC3B,eAAe,EAAE,MAAM,EACvB,KAAK,EAAE,6BAA6B,GACnC,eAAe,CAAC,qCAAqC,CAAC;IAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsFG;aACa,UAAU,CACxB,SAAS,EAAE,eAAe,EAC1B,KAAK,EAAE,mBAAmB,GACzB,eAAe,CAAC,oBAAoB,CAAC;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;;;OAGG;aACa,IAAI,CAClB,SAAS,EAAE,eAAe,EAC1B,OAAO,EAAE,mBAAmB,GAC3B,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;OAGG;aACa,MAAM,CACpB,SAAS,EAAE,eAAe,EAC1B,OAAO,EAAE,mBAAmB,GAC3B,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;aACa,aAAa,CAC3B,UAAU,EAAE,eAAe,EAAE,EAC7B,UAAU,EAAE,gBAAgB,GAC3B,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;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;IAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;aACa,QAAQ,CACtB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,mBAAmB,GACzB,eAAe,CAAC,gCAAgC,CAAC;CACrD"}

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

@@ -9,13 +9,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 declare abstract class PluginDesignWindowsApi {
     constructor();
@@ -78,9 +79,8 @@ export declare abstract class PluginDesignWindowsApi {
      */
     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`

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

@@ -1 +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"}
+{"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;;;;;;;;;;;;;;GAcG;AACH,8BAAsB,sBAAsB;;IAG1C;;;;;;;;;;;;;;;;;;OAkBG;aACa,OAAO,CACrB,MAAM,EAAE,eAAe,GACtB,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC;IAEjC;;;;;;;;;;;;;;;;;OAiBG;aACa,QAAQ,CACtB,MAAM,EAAE,eAAe,GACtB,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC;IAEjC;;;;;;;;;;;;;;;;;OAiBG;aACa,SAAS,CACvB,MAAM,EAAE,eAAe,GACtB,eAAe,CAAC,MAAM,GAAG,IAAI,CAAC;IAEjC;;;;;;;;;;;;;;;;;;;OAmBG;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,CAClD,wBAAwB,EAAE,CAC3B;IAED;;;;;;;;;;;;;;;;;;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,CAClD,OAAO,8BAA8B,CACtC,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;AAOD,OAAO,EAAE,wBAAwB,EAAE,uBAAuB,EAAE,CAAA;AAE5D;;;;;;GAMG;AACH,eAAO,MAAM,iCAAiC;;iBAE5C,CAAA;AACF,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,iCAAiC,CACzC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACxD,OAAO,oCAAoC,CAC5C,CAAA;AAED,eAAO,MAAM,4BAA4B;;iBAAuC,CAAA;AAChF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA"}