@snaptrude/plugin-core 0.0.0-bimsvg-20260928124803

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

@@ -0,0 +1,282 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../../types";
+import { ComponentHandle } from "../../../handles";
+import { PluginDesignChangeResult } from "../lock";
+/**
+ * The entity kinds {@linkcode PluginDesignSelectionApi.setByFilter} can select —
+ * the union of the editor's "Filter selection" menus (Design tab + BIM tab).
+ * Tokens mirror {@linkcode PluginEntityType} where a kind exists on the query
+ * surface; the rest are selection-only kinds the query surface cannot reach
+ * (layer-backed and annotation objects).
+ *
+ * | Value | Entity (menu label) |
+ * |---|---|
+ * | `"wall"` | Wall |
+ * | `"slab"` | Floor slab |
+ * | `"floor"` | Flooring |
+ * | `"door"` | Door |
+ * | `"window"` | Window |
+ * | `"beam"` | Beam |
+ * | `"column"` | Column |
+ * | `"ceiling"` | Ceiling |
+ * | `"roof"` | Roof |
+ * | `"staircase"` | Staircase |
+ * | `"furniture"` | Furniture |
+ * | `"pergola"` | Pergola |
+ * | `"sunshade"` | Sunshade |
+ * | `"referenceLine"` | Reference line |
+ * | `"space"` | Space (room mass) |
+ * | `"site"` | Site |
+ * | `"terrain"` | Terrain |
+ * | `"cad"` | CAD import |
+ * | `"pdf"` | PDF import |
+ * | `"image"` | Image import |
+ * | `"dimensionLine"` | Dimension line |
+ * | `"model3d"` | Imported 3D model |
+ * | `"neighborhoodBuilding"` | Neighborhood building |
+ * | `"programBlock"` | Program block (department mass) |
+ */
+export declare const PluginSelectionEntityType: z.ZodEnum<{
+    terrain: "terrain";
+    floor: "floor";
+    wall: "wall";
+    ceiling: "ceiling";
+    image: "image";
+    cad: "cad";
+    pdf: "pdf";
+    door: "door";
+    window: "window";
+    furniture: "furniture";
+    space: "space";
+    slab: "slab";
+    roof: "roof";
+    column: "column";
+    beam: "beam";
+    staircase: "staircase";
+    referenceLine: "referenceLine";
+    pergola: "pergola";
+    sunshade: "sunshade";
+    site: "site";
+    dimensionLine: "dimensionLine";
+    model3d: "model3d";
+    neighborhoodBuilding: "neighborhoodBuilding";
+    programBlock: "programBlock";
+}>;
+export type PluginSelectionEntityType = z.infer<typeof PluginSelectionEntityType>;
+/**
+ * The filter for {@linkcode PluginDesignSelectionApi.setByFilter}. At least one
+ * field must be non-empty (to empty the selection use
+ * {@linkcode PluginDesignSelectionApi.clear}). Fields **AND**-combine; values
+ * within a field **OR**-combine — `{ storeys: [2], types: ["furniture"] }`
+ * selects only the furniture on storey 2.
+ *
+ * | Field | Type | Selects entities where |
+ * |---|---|---|
+ * | `storeys` | `number[]` | storey/floor level ∈ `storeys` (negative = basement) |
+ * | `types` | {@linkcode PluginSelectionEntityType}`[]` | entity kind ∈ `types` |
+ */
+export declare const PluginSelectionFilter: z.ZodObject<{
+    storeys: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    types: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        terrain: "terrain";
+        floor: "floor";
+        wall: "wall";
+        ceiling: "ceiling";
+        image: "image";
+        cad: "cad";
+        pdf: "pdf";
+        door: "door";
+        window: "window";
+        furniture: "furniture";
+        space: "space";
+        slab: "slab";
+        roof: "roof";
+        column: "column";
+        beam: "beam";
+        staircase: "staircase";
+        referenceLine: "referenceLine";
+        pergola: "pergola";
+        sunshade: "sunshade";
+        site: "site";
+        dimensionLine: "dimensionLine";
+        model3d: "model3d";
+        neighborhoodBuilding: "neighborhoodBuilding";
+        programBlock: "programBlock";
+    }>>>;
+}, z.core.$strip>;
+export type PluginSelectionFilter = z.infer<typeof PluginSelectionFilter>;
+/**
+ * `snaptrude.design.selection` — read and mutate the current scene selection.
+ *
+ * Selection targets are {@linkcode ComponentHandle}s. `get` is the one sanctioned
+ * `get`-returns-array accessor (§4.1(3)). The mutators (`set`/`add`/`remove`/`clear`)
+ * change the live selection and return the resulting selection snapshot — they are
+ * **not undoable** (the engine fires a selection listener, no command), so the
+ * returned {@linkcode PluginDesignChangeResult} is a committed-state snapshot.
+ */
+export declare abstract class PluginDesignSelectionApi {
+    constructor();
+    /**
+     * Read the current scene selection — the entities the user (or a previous
+     * call) has selected, returned as handles you can pass straight into other
+     * API calls.
+     *
+     * @returns The selection as {@linkcode ComponentHandle}`[]` (`[]` when nothing is selected)
+     *
+     * @examplePrompt What do I have selected right now?
+     * @examplePrompt List the currently selected objects
+     * @examplePrompt Which rooms are selected in the scene?
+     * @examplePrompt Get the ids of everything I've selected
+     * @examplePrompt Is anything selected?
+     *
+     * # Example
+     * ```ts
+     * // Selection handles feed straight into other API calls
+     * const selection = await snaptrude.design.selection.get()
+     * if (selection.length > 0) {
+     *   const props = await snaptrude.design.query.getProperties(selection[0])
+     * }
+     * ```
+     */
+    abstract get(): PluginApiReturn<ComponentHandle[]>;
+    /**
+     * Replace the selection with exactly the given entities — anything
+     * previously selected is deselected first, so afterwards only these
+     * entities are selected.
+     *
+     * @param components The entities to select
+     * @returns The resulting selection snapshot
+     *
+     * @examplePrompt Select these three walls
+     * @examplePrompt Select only the kitchen and deselect everything else
+     * @examplePrompt Change the selection to just these rooms
+     * @examplePrompt Highlight the spaces on the second storey
+     *
+     * # Example
+     * ```ts
+     * // Select only the ground-storey walls (replaces the previous selection)
+     * const walls = await snaptrude.design.query.listWalls({ storeys: [1] })
+     * const { affected } = await snaptrude.design.selection.set(walls)
+     * ```
+     */
+    abstract set(components: ComponentHandle[]): PluginApiReturn<PluginDesignChangeResult>;
+    /**
+     * Add entities to the current selection without deselecting anything — the
+     * selection grows to include the given entities alongside whatever was
+     * already selected.
+     *
+     * @param components The entities to add to the selection
+     * @returns The resulting selection snapshot
+     *
+     * @examplePrompt Add the corridor to my current selection
+     * @examplePrompt Select these columns too, keeping what's already selected
+     * @examplePrompt Also select the roof
+     * @examplePrompt Extend the selection to include all the doors on this floor
+     *
+     * # Example
+     * ```ts
+     * // Grow the selection to include every roof, keeping what's already selected
+     * const roofs = await snaptrude.design.query.listRoofs()
+     * await snaptrude.design.selection.add(roofs)
+     * ```
+     */
+    abstract add(components: ComponentHandle[]): PluginApiReturn<PluginDesignChangeResult>;
+    /**
+     * Remove entities from the current selection — the given entities are
+     * deselected while everything else stays selected.
+     *
+     * @param components The entities to remove from the selection
+     * @returns The resulting selection snapshot
+     *
+     * @examplePrompt Deselect the stair core but keep the rest selected
+     * @examplePrompt Remove these walls from my selection
+     * @examplePrompt Take the furniture out of the current selection
+     * @examplePrompt Unselect the two smaller rooms
+     *
+     * # Example
+     * ```ts
+     * // Deselect the furniture while keeping everything else selected
+     * const furniture = await snaptrude.design.query.listFurniture({ isSelected: true })
+     * await snaptrude.design.selection.remove(furniture)
+     * ```
+     */
+    abstract remove(components: ComponentHandle[]): PluginApiReturn<PluginDesignChangeResult>;
+    /**
+     * Clear the selection so nothing is selected (equivalent to `set([])`).
+     *
+     * @returns The resulting (empty) selection snapshot
+     *
+     * @examplePrompt Deselect everything
+     * @examplePrompt Clear my current selection
+     * @examplePrompt Unselect all objects in the scene
+     * @examplePrompt Make sure nothing is selected before we start
+     *
+     * # Example
+     * ```ts
+     * const { affected } = await snaptrude.design.selection.clear()
+     * // affected is the resulting selection — always [] here
+     * ```
+     */
+    abstract clear(): PluginApiReturn<PluginDesignChangeResult>;
+    /**
+     * Replace the selection with every visible entity of the active building that
+     * matches the filter — the programmatic equivalent of the editor's
+     * **Story selection** (`storeys`) and **Filter selection** (`types`) menus
+     * under the select tool, including their combination (fields AND, values
+     * within a field OR). Reaches selection-only kinds the query surface cannot
+     * (sites, terrain, CAD/PDF/image imports, dimension lines, 3D models,
+     * neighborhood buildings) and selects whole groups the way the editor does.
+     *
+     * This is a one-shot bulk select, not a persistent mode: the user's next
+     * canvas click resets the underlying filter state (the selection it made
+     * stays until changed). Results honor the ambient view — active building,
+     * hidden objects/buckets, and in 2D the active storey.
+     *
+     * @param filter Which entities to select — {@linkcode PluginSelectionFilter};
+     *   at least one field must be non-empty
+     * @returns The resulting selection snapshot
+     *
+     * @examplePrompt Select everything on storey 2
+     * @examplePrompt Select all the walls and doors
+     * @examplePrompt Story selection: select the ground floor and first floor
+     * @examplePrompt Filter selection: select all furniture in the model
+     * @examplePrompt Select only the furniture on the second storey
+     * @examplePrompt Select all the spaces so I can recolor them
+     *
+     * # Example
+     * ```ts
+     * // "Story selection": everything on storeys 1 and 2
+     * await snaptrude.design.selection.setByFilter({ storeys: [1, 2] })
+     *
+     * // "Filter selection": all walls and doors
+     * await snaptrude.design.selection.setByFilter({ types: ["wall", "door"] })
+     *
+     * // Combined: only the furniture on storey 2
+     * const { affected } = await snaptrude.design.selection.setByFilter({
+     *   storeys: [2],
+     *   types: ["furniture"],
+     * })
+     * ```
+     */
+    abstract setByFilter(filter: PluginSelectionFilter): PluginApiReturn<PluginDesignChangeResult>;
+}
+/**
+ * Arguments for {@linkcode PluginDesignSelectionApi.set}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `components` | {@linkcode ComponentHandle}`[]` | The entities to select |
+ */
+export declare const PluginDesignSelectionSetArgs: z.ZodObject<{
+    components: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+}, z.core.$strip>;
+export type PluginDesignSelectionSetArgs = z.infer<typeof PluginDesignSelectionSetArgs>;
+export declare const PluginDesignSelectionAddArgs: z.ZodObject<{
+    components: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+}, z.core.$strip>;
+export type PluginDesignSelectionAddArgs = z.infer<typeof PluginDesignSelectionAddArgs>;
+export declare const PluginDesignSelectionRemoveArgs: z.ZodObject<{
+    components: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+}, z.core.$strip>;
+export type PluginDesignSelectionRemoveArgs = z.infer<typeof PluginDesignSelectionRemoveArgs>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/design/selection/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;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;EAyBpC,CAAA;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAEjF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAQ9B,CAAA;AACJ,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;;GAQG;AACH,8BAAsB,wBAAwB;;IAG5C;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,GAAG,IAAI,eAAe,CAAC,eAAe,EAAE,CAAC;IAEzD;;;;;;;;;;;;;;;;;;;OAmBG;aACa,GAAG,CAAC,UAAU,EAAE,eAAe,EAAE,GAAG,eAAe,CAAC,wBAAwB,CAAC;IAE7F;;;;;;;;;;;;;;;;;;;OAmBG;aACa,GAAG,CAAC,UAAU,EAAE,eAAe,EAAE,GAAG,eAAe,CAAC,wBAAwB,CAAC;IAE7F;;;;;;;;;;;;;;;;;;OAkBG;aACa,MAAM,CACpB,UAAU,EAAE,eAAe,EAAE,GAC5B,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;OAeG;aACa,KAAK,IAAI,eAAe,CAAC,wBAAwB,CAAC;IAElE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;aACa,WAAW,CACzB,MAAM,EAAE,qBAAqB,GAC5B,eAAe,CAAC,wBAAwB,CAAC;CAC7C;AAED;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B;;iBAEvC,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAEvF,eAAO,MAAM,4BAA4B;;iBAA+B,CAAA;AACxE,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAEvF,eAAO,MAAM,+BAA+B;;iBAA+B,CAAA;AAC3E,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA"}

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

@@ -0,0 +1,38 @@
+import * as z from "zod";
+import { ComponentHandle } from "../../handles";
+/**
+ * Shared `design.*` operation return records (LLD Part A.3).
+ *
+ * `PluginDesignChangeResult` (`{ affected }`) is NOT here — it already lives in
+ * `./lock` and is reused verbatim by the transform/delete mutators.
+ *
+ * NOTE: `PluginMirrorAxis` currently lives in `./doors`; its relocation into this
+ * shared module is deferred to the transform wave (avoids a doors edit + a
+ * double-export while `design.transform` is unwired).
+ */
+/**
+ * Result of a CSG boolean op (`design.boolean.union/subtract/intersect`). Grounded
+ * in the engine `Boolean3dOperation.resultComponents { toCreate; toDelete }`:
+ * `created` are the result masses, `deleted` is every consumed input (for
+ * `subtract` this includes BOTH the target AND the tools). Errors throw (RPC
+ * rejects); no `Result<>` crosses the boundary.
+ */
+export declare const BooleanOutcome: z.ZodObject<{
+    created: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+    deleted: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+}, z.core.$strip>;
+export type BooleanOutcome = z.infer<typeof BooleanOutcome>;
+/**
+ * Result of `design.edit.offsetSplit` (migrated from `tools.offset`). `createdIds`
+ * are the components the offset produced; `deletedIds` are those a split-style
+ * offset removed. `offsetValue` is the engine's POST-clamp / post-sign applied
+ * distance — the only way a caller learns the actually-applied clamped distance
+ * (the shipped `tools.offset` result dropped it).
+ */
+export declare const OffsetSplitOutcome: z.ZodObject<{
+    createdIds: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+    deletedIds: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+    offsetValue: z.ZodNumber;
+}, z.core.$strip>;
+export type OffsetSplitOutcome = z.infer<typeof OffsetSplitOutcome>;
+//# sourceMappingURL=shared.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../../src/api/design/shared.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAE/C;;;;;;;;;GASG;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,cAAc;;;iBAGzB,CAAA;AACF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAE3D;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB;;;;iBAI7B,CAAA;AACF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA"}

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

@@ -0,0 +1,249 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../../types";
+import { ComponentHandle, Vec3Handle } from "../../../handles";
+import { PluginDesignChangeResult } from "../lock";
+/**
+ * `snaptrude.design.transform` — rigid transforms on scene entities.
+ *
+ * `move` / `rotate` migrated from the removed `tools.transform.*`; `align` snaps a
+ * set of components' bounding-box edges to each other (or to a reference); `mirror`
+ * flips components in place about a horizontal axis. All ops are undoable and return
+ * {@linkcode PluginDesignChangeResult} `{ affected }`; failures throw (RPC rejects).
+ *
+ * `getPosition` / `setPosition` (and `scale`, an engine gap) are NOT in this surface
+ * yet — they are a later pass.
+ */
+export declare abstract class PluginDesignTransformApi {
+    constructor();
+    /**
+     * Translate entities by a **relative** displacement vector (added to the first
+     * component's absolute position as the anchor). Undoable.
+     *
+     * @param components - Entities to move
+     * @param displacement - Relative translation as a {@linkcode Vec3Handle}
+     * @param options - `is2D`, `trackParentChange`
+     * @returns {@linkcode PluginDesignChangeResult}
+     *
+     * @examplePrompt Move the selected room 5 metres to the right
+     * @examplePrompt Shift these walls 3m along the x axis
+     * @examplePrompt Nudge this space 500mm north
+     * @examplePrompt Translate the furniture block by (10, 0, 5)
+     * @examplePrompt Move these masses up one storey
+     *
+     * @performance Array API — one host round-trip for the whole set. Pass every target in a
+     *   single call; never loop `design.transform.move` per entity.
+     *
+     * # Example
+     * ```ts
+     * const { vec3 } = snaptrude.core.math
+     * await snaptrude.design.transform.move(["space-id"], vec3.new(10, 0, 0))
+     * ```
+     */
+    abstract move(components: ComponentHandle[], displacement: Vec3Handle, options?: {
+        is2D?: boolean;
+        trackParentChange?: boolean;
+    }): PluginApiReturn<PluginDesignChangeResult>;
+    /**
+     * Rotate entities by a **signed angle in DEGREES** (positive = CCW about +Y).
+     * The pivot defaults to the combined bounding-box centre; pass `options.pivot`
+     * to rotate about an explicit world-space point instead. NOTE: unlike the
+     * removed `tools.transform.rotate` (radians), this canonical form takes
+     * DEGREES. Undoable.
+     *
+     * @param components - Entities to rotate
+     * @param angleInDegrees - Signed rotation angle in degrees
+     * @param options - `axis` (defaults to world +Y), `pivot` (world-space rotation
+     *   centre as a {@linkcode Vec3Handle}; defaults to the combined bbox centre),
+     *   `is2D`
+     * @returns {@linkcode PluginDesignChangeResult}
+     *
+     * @examplePrompt Rotate the selected building 90 degrees
+     * @examplePrompt Turn this room 45 degrees clockwise
+     * @examplePrompt Spin the furniture block 180 degrees about its centre
+     * @examplePrompt Rotate these masses 30 degrees around the vertical axis
+     * @examplePrompt Rotate these walls 90 degrees about the origin
+     *
+     * @performance Array API — one host round-trip for the whole set. Pass every target in a
+     *   single call; never loop `design.transform.rotate` per entity.
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.design.transform.rotate(["space-id"], 90)
+     * // …or rotate about an explicit pivot point
+     * const { vec3 } = snaptrude.core.math
+     * await snaptrude.design.transform.rotate(["space-id"], 90, { pivot: vec3.new(0, 0, 0) })
+     * ```
+     */
+    abstract rotate(components: ComponentHandle[], angleInDegrees: number, options?: {
+        axis?: Vec3Handle;
+        pivot?: Vec3Handle;
+        is2D?: boolean;
+    }): PluginApiReturn<PluginDesignChangeResult>;
+    /**
+     * Align a set of components by snapping one bounding-box edge to a common value
+     * — the classic Left/Center/Right/Top/Middle/Bottom align. Purely **world-axis**
+     * (deterministic and headless — the UI's camera-relative remap is bypassed):
+     *
+     * - `left` / `right` / `center` → world **X** min / max / mid
+     * - `top` / `bottom` / `middle` → world **Z** max / min / mid
+     *
+     * There is **no vertical (Y) alignment** in v1 (the UI only reaches it via a
+     * side-elevation camera remap, which this API does not replicate). Doors and
+     * windows are **rejected** in v1 — if any component in `components` (or the
+     * `reference`) is a door or window, the whole call **throws**; nothing is
+     * silently dropped. A group aligns as **one rigid body** (its whole-group
+     * bounding box moves together). Undoable.
+     *
+     * Requires **at least 2 components** unless a `reference` is supplied; with a
+     * reference, every component aligns to that reference's edge (the reference does
+     * not move) and a single component is allowed. Y (height) is preserved.
+     *
+     * @param components - Entities to align (≥2 without a `reference`)
+     * @param edge - Which bounding-box edge to snap ({@linkcode PluginAlignEdge})
+     * @param options - `reference`: a component whose edge is the fixed target
+     * @returns {@linkcode PluginDesignChangeResult}
+     *
+     * @examplePrompt Align the selected rooms to the left
+     * @examplePrompt Line up these masses along their top edges
+     * @examplePrompt Center these columns horizontally
+     * @examplePrompt Align all the walls to the left edge of this reference wall
+     * @examplePrompt Snap the bottom edges of these spaces together
+     *
+     * @performance Array API — one host round-trip for the whole set. Pass every target in a
+     *   single call; never loop `design.transform.align` per entity.
+     *
+     * # Example
+     * ```ts
+     * const rooms = await snaptrude.design.selection.get()
+     * // align every room's left (world -X) edge to a common minimum
+     * await snaptrude.design.transform.align(rooms, "left")
+     * // …or align them to a fixed reference component's left edge
+     * const [anchor] = await snaptrude.design.query.listWalls({ storeys: [1] })
+     * await snaptrude.design.transform.align(rooms, "left", { reference: anchor })
+     * ```
+     */
+    abstract align(components: ComponentHandle[], edge: PluginAlignEdge, options?: {
+        reference?: ComponentHandle;
+    }): PluginApiReturn<PluginDesignChangeResult>;
+    /**
+     * Mirror components **in place** about a horizontal axis, flipping their geometry
+     * across that axis through the combined bounding-box centre (the mesh's
+     * world-matrix flip + brep inversion + CAD/dimension-line/parametric handling
+     * commit atomically). Nothing moves off-centre — this is the toolbar "flip", not
+     * a translate-and-reflect. Undoable.
+     *
+     * `axis` names the axis the geometry mirrors **across** (world axes, Y is up):
+     * - `'x'` — mirror across world X (a front↔back flip in plan; reflects the Z coord)
+     * - `'z'` — mirror across world Z (a left↔right flip in plan; reflects the X coord)
+     *
+     * Vertical (`'y'`) mirroring is intentionally not exposed. Locked, bucket-locked
+     * and ineligible entries (terrain, plinths, reference/dimension lines,
+     * neighbourhood buildings) are **silently dropped**; the call only throws if
+     * nothing mirrorable remains. `affected` echoes the supplied handles.
+     *
+     * @param components - Entities to mirror (≥1)
+     * @param axis - Axis to mirror across ({@linkcode PluginTransformMirrorAxis})
+     * @returns {@linkcode PluginDesignChangeResult}
+     *
+     * @examplePrompt Mirror the selected building across the x axis
+     * @examplePrompt Flip these rooms left to right
+     * @examplePrompt Mirror this furniture block horizontally
+     * @examplePrompt Flip the selected walls front to back
+     * @examplePrompt Create a mirror image of these masses about the z axis
+     *
+     * @performance Array API — one host round-trip for the whole set. Pass every target in a
+     *   single call; never loop `design.transform.mirror` per entity.
+     *
+     * # Example
+     * ```ts
+     * const rooms = await snaptrude.design.selection.get()
+     * await snaptrude.design.transform.mirror(rooms, "x")
+     * ```
+     */
+    abstract mirror(components: ComponentHandle[], axis: PluginTransformMirrorAxis): PluginApiReturn<PluginDesignChangeResult>;
+}
+/**
+ * The horizontal axis a {@linkcode PluginDesignTransformApi.mirror} flips **across**
+ * (world axes, Y up): `'x'` mirrors across world X (front↔back in plan; reflects Z),
+ * `'z'` mirrors across world Z (left↔right in plan; reflects X). Vertical (`'y'`)
+ * mirroring is not exposed.
+ */
+export declare const PluginTransformMirrorAxis: z.ZodEnum<{
+    x: "x";
+    z: "z";
+}>;
+export type PluginTransformMirrorAxis = z.infer<typeof PluginTransformMirrorAxis>;
+/**
+ * The bounding-box edge an {@linkcode PluginDesignTransformApi.align} snaps to.
+ * Mirrors the engine's align `DirectionType`. World-axis mapping: `left`/`right`/`center`
+ * → world X min/max/mid; `top`/`bottom`/`middle` → world Z max/min/mid.
+ */
+export declare const PluginAlignEdge: z.ZodEnum<{
+    center: "center";
+    top: "top";
+    left: "left";
+    right: "right";
+    bottom: "bottom";
+    middle: "middle";
+}>;
+export type PluginAlignEdge = z.infer<typeof PluginAlignEdge>;
+/**
+ * Arguments for {@linkcode PluginDesignTransformApi.move} (options flattened).
+ */
+export declare const PluginDesignMoveArgs: z.ZodObject<{
+    components: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+    displacement: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>;
+    is2D: z.ZodOptional<z.ZodBoolean>;
+    trackParentChange: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type PluginDesignMoveArgs = z.infer<typeof PluginDesignMoveArgs>;
+/**
+ * Arguments for {@linkcode PluginDesignTransformApi.rotate} (options flattened).
+ */
+export declare const PluginDesignRotateArgs: z.ZodObject<{
+    components: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+    angleInDegrees: z.ZodNumber;
+    axis: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
+    is2D: z.ZodOptional<z.ZodBoolean>;
+    pivot: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodString>, z.ZodTransform<import("../../..").Handle<"vec3">, string>>>;
+}, z.core.$strip>;
+export type PluginDesignRotateArgs = z.infer<typeof PluginDesignRotateArgs>;
+/**
+ * Arguments for {@linkcode PluginDesignTransformApi.align} (options flattened).
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `components` | {@linkcode ComponentHandle}`[]` | Entities to align (≥2 unless `reference` is set — host-enforced) |
+ * | `edge` | {@linkcode PluginAlignEdge} | Which bounding-box edge to snap |
+ * | `reference` | {@linkcode ComponentHandle} | A fixed component whose edge is the target (optional) |
+ */
+export declare const PluginDesignAlignArgs: z.ZodObject<{
+    components: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+    edge: z.ZodEnum<{
+        center: "center";
+        top: "top";
+        left: "left";
+        right: "right";
+        bottom: "bottom";
+        middle: "middle";
+    }>;
+    reference: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+}, z.core.$strip>;
+export type PluginDesignAlignArgs = z.infer<typeof PluginDesignAlignArgs>;
+/**
+ * Arguments for {@linkcode PluginDesignTransformApi.mirror}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `components` | {@linkcode ComponentHandle}`[]` | Entities to mirror (≥1) |
+ * | `axis` | {@linkcode PluginTransformMirrorAxis} | Horizontal axis to mirror across (`'x'` \| `'z'`) |
+ */
+export declare const PluginDesignMirrorArgs: z.ZodObject<{
+    components: z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>>;
+    axis: z.ZodEnum<{
+        x: "x";
+        z: "z";
+    }>;
+}, z.core.$strip>;
+export type PluginDesignMirrorArgs = z.infer<typeof PluginDesignMirrorArgs>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/design/transform/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAC9D,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAElD;;;;;;;;;;GAUG;AACH,8BAAsB,wBAAwB;;IAG5C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,IAAI,CAClB,UAAU,EAAE,eAAe,EAAE,EAC7B,YAAY,EAAE,UAAU,EACxB,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,iBAAiB,CAAC,EAAE,OAAO,CAAA;KAAE,GACxD,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;aACa,MAAM,CACpB,UAAU,EAAE,eAAe,EAAE,EAC7B,cAAc,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,UAAU,CAAC;QAAC,KAAK,CAAC,EAAE,UAAU,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAA;KAAE,GAClE,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;aACa,KAAK,CACnB,UAAU,EAAE,eAAe,EAAE,EAC7B,IAAI,EAAE,eAAe,EACrB,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,eAAe,CAAA;KAAE,GACxC,eAAe,CAAC,wBAAwB,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;aACa,MAAM,CACpB,UAAU,EAAE,eAAe,EAAE,EAC7B,IAAI,EAAE,yBAAyB,GAC9B,eAAe,CAAC,wBAAwB,CAAC;CAC7C;AAED;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB;;;EAAqB,CAAA;AAC3D,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,yBAAyB,CACjC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,eAAe;;;;;;;EAO1B,CAAA;AACF,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAE7D;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;iBAK/B,CAAA;AACF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;;;;iBAMjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAE3E;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;iBAIhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB;;;;;;iBAGjC,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA"}