@snaptrude/plugin-core 0.2.4 → 0.2.5

package/dist/api/entity/space.d.ts

@@ -0,0 +1,816 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../types";
+/**
+ * Space (room/mass) management — create, query, update, and delete spaces.
+ *
+ * A **space** is a 3D volume representing a room or mass in the
+ * Snaptrude scene. Spaces live on a particular story and carry
+ * properties such as name, area, department, and room type.
+ *
+ * All methods are **host API calls** that return Promises and support
+ * undo/redo via Snaptrude's command system.
+ *
+ * Accessed via `snaptrude.entity.space`.
+ */
+export declare abstract class PluginSpaceApi {
+    constructor();
+    /**
+     * Create a rectangular (box) space.
+     *
+     * Generates an axis-aligned box with the given dimensions at the
+     * specified position. The created space is automatically assigned
+     * to the active story and a default department.
+     *
+     * @param args - An object containing:
+     *   - {@linkcode PluginSpaceCreateRectangularArgs.position args.position} — Origin
+     *     position as a {@linkcode PVec3} in Babylon units
+     *   - {@linkcode PluginSpaceCreateRectangularArgs.dimensions args.dimensions} — Box
+     *     dimensions `{ width, height, depth }` in Babylon units
+     * @returns A {@linkcode PluginSpaceCreateRectangularResult} with the `spaceId`
+     *   of the created space
+     * @throws If space creation fails
+     *
+     * # Example
+     * ```ts
+     * const { vec3 } = snaptrude.core.math
+     *
+     * const { spaceId } = await snaptrude.entity.space.createRectangular({
+     *   position: vec3.new(0, 0, 0),
+     *   dimensions: { width: 5, height: 3, depth: 4 },
+     * })
+     * ```
+     */
+    abstract createRectangular({ position, dimensions, }: PluginSpaceCreateRectangularArgs): PluginApiReturn<PluginSpaceCreateRectangularResult>;
+    /**
+     * Create a space by extruding a 2D profile.
+     *
+     * The {@linkcode PluginSpaceCreateFromProfileArgs.profile profile} is used as
+     * the outer boundary and extruded upward (along the Y axis) by
+     * {@linkcode PluginSpaceCreateFromProfileArgs.extrudeHeight extrudeHeight},
+     * then offset by {@linkcode PluginSpaceCreateFromProfileArgs.position
+     * position}. Optional {@linkcode PluginSpaceCreateFromProfileArgs.innerProfiles
+     * innerProfiles} are used as holes inside the outer boundary. The created
+     * space is automatically assigned to the active story and a default department.
+     *
+     * Use {@linkcode PluginProfileApi.fromLinePoints} to quickly build a profile
+     * from a list of points.
+     *
+     * @param args - An object containing:
+     *   - {@linkcode PluginSpaceCreateFromProfileArgs.profile args.profile} — A closed
+     *     {@linkcode PProfile} defining the outer floor shape
+     *   - {@linkcode PluginSpaceCreateFromProfileArgs.innerProfiles args.innerProfiles} —
+     *     Optional closed {@linkcode PProfile}`[]` loops to subtract as holes
+     *   - {@linkcode PluginSpaceCreateFromProfileArgs.extrudeHeight args.extrudeHeight} —
+     *     Extrusion height in Babylon units
+     *   - {@linkcode PluginSpaceCreateFromProfileArgs.position args.position} — Offset
+     *     position as a {@linkcode PVec3} in Babylon units
+     * @returns A {@linkcode PluginSpaceCreateFromProfileResult} with the `spaceId`
+     *   of the created space
+     * @throws If the profile is invalid or mesh creation fails
+     *
+     * # Example
+     * ```ts
+     * const { vec3 } = snaptrude.core.math
+     *
+     * const outerProfile = await snaptrude.core.geom.profile.fromLinePoints({
+     *   points: [
+     *     vec3.new(0, 0, 0),
+     *     vec3.new(10, 0, 0),
+     *     vec3.new(10, 0, 8),
+     *     vec3.new(0, 0, 8),
+     *   ],
+     * })
+     * const holeProfile = await snaptrude.core.geom.profile.fromLinePoints({
+     *   points: [
+     *     vec3.new(3, 0, 3),
+     *     vec3.new(7, 0, 3),
+     *     vec3.new(7, 0, 5),
+     *     vec3.new(3, 0, 5),
+     *   ],
+     * })
+     *
+     * const { spaceId } = await snaptrude.entity.space.createFromProfile({
+     *   profile: outerProfile,
+     *   innerProfiles: [holeProfile],
+     *   extrudeHeight: 3,
+     *   position: vec3.new(0, 0, 0),
+     * })
+     * ```
+     */
+    abstract createFromProfile({ profile, innerProfiles, extrudeHeight, position, }: PluginSpaceCreateFromProfileArgs): PluginApiReturn<PluginSpaceCreateFromProfileResult>;
+    /**
+     * Update a space's BRep and mesh geometry by extruding a 2D profile.
+     *
+     * The {@linkcode PluginSpaceUpdateGeometryFromProfileArgs.profile profile} is
+     * extruded upward (along the Y axis) by
+     * {@linkcode PluginSpaceUpdateGeometryFromProfileArgs.extrudeHeight extrudeHeight}
+     * and applied to the existing space. The space keeps the same `spaceId`,
+     * metadata, department, and transform; only its geometry is replaced.
+     *
+     * Profile points are interpreted in scene coordinates. Profiles returned by
+     * {@linkcode PluginSpaceApi.get} with `"profile"` can be passed back directly;
+     * `"planPoints"` can be used to construct line-only profiles in the same X/Z
+     * plan coordinate space.
+     *
+     * Use {@linkcode PluginProfileApi.fromLinePoints} to quickly build a profile
+     * from a list of points.
+     *
+     * @param args - An object containing:
+     *   - {@linkcode PluginSpaceUpdateGeometryFromProfileArgs.spaceId args.spaceId} —
+     *     The unique space ID to update
+     *   - {@linkcode PluginSpaceUpdateGeometryFromProfileArgs.profile args.profile} —
+     *     A closed {@linkcode PProfile} defining the new floor shape
+     *   - {@linkcode PluginSpaceUpdateGeometryFromProfileArgs.extrudeHeight
+     *     args.extrudeHeight} — New extrusion height in Babylon units
+     * @returns A {@linkcode PluginSpaceUpdateGeometryFromProfileResult} with the
+     *   `spaceId` of the updated space
+     * @throws If the space does not exist, the component is not a space/mass, the
+     *   height is not positive, or the profile cannot create valid geometry
+     *
+     * # Example
+     * ```ts
+     * const { vec3 } = snaptrude.core.math
+     *
+     * const profile = await snaptrude.core.geom.profile.fromLinePoints({
+     *   points: [
+     *     vec3.new(0, 0, 0),
+     *     vec3.new(12, 0, 0),
+     *     vec3.new(12, 0, 6),
+     *     vec3.new(0, 0, 6),
+     *   ],
+     * })
+     *
+     * const { spaceId } = await snaptrude.entity.space.updateGeometryFromProfile({
+     *   spaceId: "some-space-id",
+     *   profile,
+     *   extrudeHeight: 4,
+     * })
+     * ```
+     */
+    abstract updateGeometryFromProfile({ spaceId, profile, extrudeHeight, }: PluginSpaceUpdateGeometryFromProfileArgs): PluginApiReturn<PluginSpaceUpdateGeometryFromProfileResult>;
+    /**
+     * Get the IDs of all spaces in the current project.
+     *
+     * Returns every space (mass that is not a building) across all stories.
+     * Use the returned IDs with {@linkcode PluginSpaceApi.get} to query
+     * individual space properties.
+     *
+     * @returns A {@linkcode PluginSpaceGetAllResult} with a `spacesIds` array
+     *
+     * # Example
+     * ```ts
+     * const { spacesIds } = await snaptrude.entity.space.getAll()
+     * console.log(`Project has ${spacesIds.length} spaces`)
+     * ```
+     */
+    abstract getAll(): PluginApiReturn<PluginSpaceGetAllResult>;
+    /**
+     * Get properties of a space by its ID.
+     *
+     * Only the properties listed in {@linkcode PluginSpaceGetArgs.properties
+     * args.properties} are returned — unlisted properties will be `undefined`
+     * in the result.
+     *
+     * @param args - An object containing:
+     *   - {@linkcode PluginSpaceGetArgs.spaceId args.spaceId} — The unique space ID
+     *     (as returned by creation methods or {@linkcode PluginSpaceApi.getAll})
+     *   - {@linkcode PluginSpaceGetArgs.properties args.properties} — Array of property
+     *     names to retrieve. See {@linkcode PluginSpaceGetProperty} for available values.
+     * @returns A partial {@linkcode PluginSpaceGetResult} containing only the requested
+     *   properties
+     * @throws If the space does not exist or the component is not a space/mass
+     *
+     * # Example
+     * ```ts
+     * const info = await snaptrude.entity.space.get({
+     *   spaceId: "some-space-id",
+     *   properties: ["name", "area", "position"],
+     * })
+     * console.log(info.name, info.area, info.position)
+     * ```
+     */
+    abstract get({ spaceId, properties, }: PluginSpaceGetArgs): PluginApiReturn<PluginSpaceGetResult>;
+    /**
+     * Delete a space by its ID.
+     *
+     * Permanently removes the space and its associated mesh from the scene.
+     * This operation is undoable via Snaptrude's command system.
+     *
+     * @param args - An object containing:
+     *   - {@linkcode PluginSpaceDeleteArgs.spaceId args.spaceId} — The unique space ID
+     *     to delete
+     * @throws If the space does not exist or the component is not a space/mass
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.entity.space.delete({ spaceId: "some-space-id" })
+     * ```
+     */
+    abstract delete({ spaceId, }: PluginSpaceDeleteArgs): PluginApiReturn<PluginSpaceDeleteResult>;
+    /**
+     * Update properties of a space by its ID.
+     *
+     * Only the properties provided in {@linkcode PluginSpaceUpdateArgs.properties
+     * args.properties} will be updated — omitted properties remain unchanged.
+     * This operation is undoable via Snaptrude's command system.
+     *
+     * @param args - An object containing:
+     *   - {@linkcode PluginSpaceUpdateArgs.spaceId args.spaceId} — The unique space ID
+     *     to update
+     *   - {@linkcode PluginSpaceUpdateArgs.properties args.properties} — Key/value pairs
+     *     of properties to update. See {@linkcode PluginSpaceUpdateArgs} for supported fields.
+     * @returns A {@linkcode PluginSpaceUpdateResult} echoing back the `spaceId` and
+     *   the updated property values
+     * @throws If the space does not exist or the component is not a space/mass
+     *
+     * # Example
+     * ```ts
+     * const result = await snaptrude.entity.space.update({
+     *   spaceId: "some-space-id",
+     *   properties: {
+     *     room_type: "Kitchen",
+     *     massType: "Room",
+     *     departmentId: "CORE",
+     *   },
+     * })
+     * ```
+     */
+    abstract update(args: PluginSpaceUpdateArgs): PluginApiReturn<PluginSpaceUpdateResult>;
+}
+/**
+ * Arguments for {@linkcode PluginSpaceApi.createRectangular}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `position` | {@linkcode PVec3} | Origin position in Babylon units |
+ * | `dimensions` | `{ width, height, depth }` | Box dimensions in Babylon units |
+ */
+export declare const PluginSpaceCreateRectangularArgs: z.ZodObject<{
+    position: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    dimensions: z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+        depth: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type PluginSpaceCreateRectangularArgs = z.infer<typeof PluginSpaceCreateRectangularArgs>;
+/**
+ * Result of {@linkcode PluginSpaceApi.createRectangular}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceId` | `string` | Unique ID of the created space |
+ */
+export declare const PluginSpaceCreateRectangularResult: z.ZodObject<{
+    spaceId: z.ZodString;
+}, z.core.$strip>;
+export type PluginSpaceCreateRectangularResult = z.infer<typeof PluginSpaceCreateRectangularResult>;
+/**
+ * Arguments for {@linkcode PluginSpaceApi.createFromProfile}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `profile` | {@linkcode PProfile} | Closed 2D profile defining the outer floor shape |
+ * | `innerProfiles` | {@linkcode PProfile}`[]` | Optional closed profiles to subtract as holes |
+ * | `extrudeHeight` | `number` | Extrusion height in Babylon units |
+ * | `position` | {@linkcode PVec3} | Offset position in Babylon units |
+ */
+export declare const PluginSpaceCreateFromProfileArgs: z.ZodObject<{
+    profile: z.ZodObject<{
+        curves: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            curveType: z.ZodLiteral<"Line">;
+            startPoint: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+            endPoint: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            curveType: z.ZodLiteral<"Arc">;
+            startPoint: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+            endPoint: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+            centrePoint: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+            axis: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+        }, z.core.$strip>], "curveType">>;
+    }, z.core.$strip>;
+    innerProfiles: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        curves: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            curveType: z.ZodLiteral<"Line">;
+            startPoint: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+            endPoint: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            curveType: z.ZodLiteral<"Arc">;
+            startPoint: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+            endPoint: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+            centrePoint: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+            axis: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+        }, z.core.$strip>], "curveType">>;
+    }, z.core.$strip>>>;
+    extrudeHeight: z.ZodNumber;
+    position: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type PluginSpaceCreateFromProfileArgs = z.infer<typeof PluginSpaceCreateFromProfileArgs>;
+/**
+ * Result of {@linkcode PluginSpaceApi.createFromProfile}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceId` | `string` | Unique ID of the created space |
+ */
+export declare const PluginSpaceCreateFromProfileResult: z.ZodObject<{
+    spaceId: z.ZodString;
+}, z.core.$strip>;
+export type PluginSpaceCreateFromProfileResult = z.infer<typeof PluginSpaceCreateFromProfileResult>;
+/**
+ * Arguments for {@linkcode PluginSpaceApi.updateGeometryFromProfile}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceId` | `string` | Space to update |
+ * | `profile` | {@linkcode PProfile} | Closed 2D profile defining the new floor shape |
+ * | `extrudeHeight` | `number` | New extrusion height in Babylon units |
+ */
+export declare const PluginSpaceUpdateGeometryFromProfileArgs: z.ZodObject<{
+    spaceId: z.ZodString;
+    profile: z.ZodObject<{
+        curves: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            curveType: z.ZodLiteral<"Line">;
+            startPoint: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+            endPoint: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            curveType: z.ZodLiteral<"Arc">;
+            startPoint: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+            endPoint: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+            centrePoint: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+            axis: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+        }, z.core.$strip>], "curveType">>;
+    }, z.core.$strip>;
+    extrudeHeight: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginSpaceUpdateGeometryFromProfileArgs = z.infer<typeof PluginSpaceUpdateGeometryFromProfileArgs>;
+/**
+ * Result of {@linkcode PluginSpaceApi.updateGeometryFromProfile}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceId` | `string` | Unique ID of the updated space |
+ */
+export declare const PluginSpaceUpdateGeometryFromProfileResult: z.ZodObject<{
+    spaceId: z.ZodString;
+}, z.core.$strip>;
+export type PluginSpaceUpdateGeometryFromProfileResult = z.infer<typeof PluginSpaceUpdateGeometryFromProfileResult>;
+/**
+ * Available properties that can be queried on a space.
+ *
+ * **Basic:**
+ * | Value | Return Type | Description |
+ * |---|---|---|
+ * | `"id"` | `string` | Unique space identifier |
+ * | `"type"` | `string` | Component type |
+ * | `"room_type"` | `string` | Room type classification |
+ * | `"name"` | `string` | Display name of the space |
+ *
+ * **Derived from parametric data:**
+ * | Value | Return Type | Description |
+ * |---|---|---|
+ * | `"area"` | `number` | Bottom face area (from `areas_bottomFace`) |
+ * | `"breadth"` | `number` | Breadth dimension |
+ * | `"depth"` | `number` | Depth dimension |
+ * | `"height"` | `number` | Height dimension |
+ * | `"massType"` | `string \| null` | Mass type classification |
+ * | `"spaceType"` | `string \| null` | Space type classification (Room, Balcony, etc.) |
+ * | `"storey"` | `number \| null` | Story the space belongs to |
+ * | `"departmentId"` | `string \| null` | Assigned department ID |
+ * | `"departmentName"` | `string` | Assigned department name |
+ * | `"departmentColor"` | `string` | Assigned department color (hex/CSS) |
+ *
+ * **Derived from mesh:**
+ * | Value | Return Type | Description |
+ * |---|---|---|
+ * | `"position"` | {@linkcode PVec3} | Local position relative to parent |
+ * | `"absolutePosition"` | {@linkcode PVec3} | Absolute position in the scene |
+ * | `"rotation"` | {@linkcode PVec3} | Euler rotation angles (radians) |
+ * | `"rotationQuaternion"` | {@linkcode PQuat} \| `null` | Quaternion rotation, or `null` if unset |
+ *
+ * **Derived from brep:**
+ * | Value | Return Type | Description |
+ * |---|---|---|
+ * | `"planPoints"` | {@linkcode PVec3}`[]` | Bottom outer profile points in world space with `y = 0` (2D plan). No closing duplicate point. |
+ * | `"profile"` | {@linkcode PProfile} | Bottom outer profile in world space, preserving line/arc curve data. |
+ */
+export declare const PluginSpaceGetProperty: z.ZodEnum<{
+    type: "type";
+    name: "name";
+    departmentId: "departmentId";
+    id: "id";
+    profile: "profile";
+    position: "position";
+    height: "height";
+    depth: "depth";
+    room_type: "room_type";
+    area: "area";
+    breadth: "breadth";
+    massType: "massType";
+    spaceType: "spaceType";
+    storey: "storey";
+    departmentName: "departmentName";
+    departmentColor: "departmentColor";
+    absolutePosition: "absolutePosition";
+    rotation: "rotation";
+    rotationQuaternion: "rotationQuaternion";
+    planPoints: "planPoints";
+}>;
+/**
+ * Arguments for {@linkcode PluginSpaceApi.get}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceId` | `string` | The space ID to query |
+ * | `properties` | {@linkcode PluginSpaceGetProperty}`[]` | Properties to retrieve |
+ */
+export declare const PluginSpaceGetArgs: z.ZodObject<{
+    spaceId: z.ZodString;
+    properties: z.ZodArray<z.ZodEnum<{
+        type: "type";
+        name: "name";
+        departmentId: "departmentId";
+        id: "id";
+        profile: "profile";
+        position: "position";
+        height: "height";
+        depth: "depth";
+        room_type: "room_type";
+        area: "area";
+        breadth: "breadth";
+        massType: "massType";
+        spaceType: "spaceType";
+        storey: "storey";
+        departmentName: "departmentName";
+        departmentColor: "departmentColor";
+        absolutePosition: "absolutePosition";
+        rotation: "rotation";
+        rotationQuaternion: "rotationQuaternion";
+        planPoints: "planPoints";
+    }>>;
+}, z.core.$strip>;
+export type PluginSpaceGetArgs = z.infer<typeof PluginSpaceGetArgs>;
+/**
+ * Supported space type values.
+ *
+ * Mirrors the internal `SpaceType` enum from `spaceType.types.ts`.
+ *
+ * | Value | Description |
+ * |---|---|
+ * | `"Room"` | Standard room |
+ * | `"Program Block"` | Program/department block |
+ * | `"Balcony"` | Balcony space |
+ * | `"Road"` | Road |
+ * | `"Garden"` | Garden area |
+ * | `"Deck"` | Deck |
+ * | `"Pool"` | Pool |
+ * | `"Walkway"` | Walkway |
+ * | `"Envelope"` | Envelope |
+ * | `"Parking"` | Parking area |
+ */
+export declare const PluginSpaceType: z.ZodEnum<{
+    Room: "Room";
+    "Program Block": "Program Block";
+    Balcony: "Balcony";
+    Road: "Road";
+    Garden: "Garden";
+    Deck: "Deck";
+    Pool: "Pool";
+    Walkway: "Walkway";
+    Envelope: "Envelope";
+    Parking: "Parking";
+}>;
+/**
+ * Result of {@linkcode PluginSpaceApi.get}.
+ *
+ * A partial object — only the properties that were requested in
+ * {@linkcode PluginSpaceGetArgs.properties} will be present.
+ */
+export declare const PluginSpaceGetResult: z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    type: z.ZodOptional<z.ZodString>;
+    room_type: z.ZodOptional<z.ZodString>;
+    name: z.ZodOptional<z.ZodString>;
+    area: z.ZodOptional<z.ZodNumber>;
+    breadth: z.ZodOptional<z.ZodNumber>;
+    depth: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+    massType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    spaceType: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        Room: "Room";
+        "Program Block": "Program Block";
+        Balcony: "Balcony";
+        Road: "Road";
+        Garden: "Garden";
+        Deck: "Deck";
+        Pool: "Pool";
+        Walkway: "Walkway";
+        Envelope: "Envelope";
+        Parking: "Parking";
+    }>>>;
+    storey: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    departmentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    departmentName: z.ZodOptional<z.ZodString>;
+    departmentColor: z.ZodOptional<z.ZodString>;
+    position: z.ZodOptional<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>>;
+    absolutePosition: z.ZodOptional<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>>;
+    rotation: z.ZodOptional<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>>;
+    rotationQuaternion: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+        w: z.ZodNumber;
+    }, z.core.$strip>>>;
+    planPoints: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>>>;
+    profile: z.ZodOptional<z.ZodObject<{
+        curves: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            curveType: z.ZodLiteral<"Line">;
+            startPoint: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+            endPoint: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+        }, z.core.$strip>, z.ZodObject<{
+            curveType: z.ZodLiteral<"Arc">;
+            startPoint: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+            endPoint: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+            centrePoint: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+            axis: z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                z: z.ZodNumber;
+            }, z.core.$strip>;
+        }, z.core.$strip>], "curveType">>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginSpaceGetResult = z.infer<typeof PluginSpaceGetResult>;
+/**
+ * Result of {@linkcode PluginSpaceApi.getAll}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spacesIds` | `string[]` | IDs of all spaces in the project |
+ */
+export declare const PluginSpaceGetAllResult: z.ZodObject<{
+    spacesIds: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type PluginSpaceGetAllResult = z.infer<typeof PluginSpaceGetAllResult>;
+/**
+ * Arguments for {@linkcode PluginSpaceApi.delete}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceId` | `string` | The space ID to delete |
+ */
+export declare const PluginSpaceDeleteArgs: z.ZodObject<{
+    spaceId: z.ZodString;
+}, z.core.$strip>;
+export type PluginSpaceDeleteArgs = z.infer<typeof PluginSpaceDeleteArgs>;
+/** Result type for {@linkcode PluginSpaceApi.delete} — returns nothing on success. */
+export type PluginSpaceDeleteResult = void;
+/**
+ * Supported mass type values for {@linkcode PluginSpaceUpdateArgs.properties.massType}.
+ *
+ * Mirrors the internal `MASS_TYPES` enum.
+ *
+ * | Value | Description |
+ * |---|---|
+ * | `"Plinth"` | Plinth mass |
+ * | `"Void"` | Void/cut-out |
+ * | `"Pergola"` | Pergola structure |
+ * | `"Furniture"` | Furniture element |
+ * | `"Facade element"` | Facade element |
+ * | `"Generic mass"` | Generic mass |
+ * | `"Room"` | Room (default for spaces) |
+ * | `"Department"` | Department block |
+ * | `"Building"` | Building envelope |
+ * | `"Revit Import"` | Imported from Revit |
+ * | `"Mass"` | Generic mass type |
+ * | `"Site"` | Site object |
+ */
+export declare const PluginMassType: z.ZodEnum<{
+    Room: "Room";
+    Plinth: "Plinth";
+    Void: "Void";
+    Pergola: "Pergola";
+    Furniture: "Furniture";
+    "Facade element": "Facade element";
+    "Generic mass": "Generic mass";
+    Department: "Department";
+    Building: "Building";
+    "Revit Import": "Revit Import";
+    Mass: "Mass";
+    Site: "Site";
+}>;
+/**
+ * Well-known (built-in) department IDs.
+ *
+ * | Value | Department |
+ * |---|---|
+ * | `"DEFAULT"` | Default department |
+ * | `"SITE"` | Site department |
+ * | `"ENVELOPE"` | Envelope department |
+ * | `"CORE"` | Core department |
+ */
+export declare const PluginWellKnownDepartmentId: z.ZodEnum<{
+    DEFAULT: "DEFAULT";
+    SITE: "SITE";
+    ENVELOPE: "ENVELOPE";
+    CORE: "CORE";
+}>;
+/**
+ * Accepted department ID values — either a {@linkcode PluginWellKnownDepartmentId}
+ * or a UUID string for custom (user-created) departments.
+ */
+export declare const PluginDepartmentId: z.ZodUnion<readonly [z.ZodEnum<{
+    DEFAULT: "DEFAULT";
+    SITE: "SITE";
+    ENVELOPE: "ENVELOPE";
+    CORE: "CORE";
+}>, z.ZodUUID]>;
+/**
+ * Arguments for {@linkcode PluginSpaceApi.update}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceId` | `string` | The space ID to update |
+ * | `properties` | `object` | Key/value pairs of properties to update (all optional) |
+ * | `properties.room_type` | `string?` | New room type label |
+ * | `properties.massType` | {@linkcode PluginMassType}`?` | New mass type |
+ * | `properties.departmentId` | {@linkcode PluginDepartmentId}`?` | New department ID |
+ */
+export declare const PluginSpaceUpdateArgs: z.ZodObject<{
+    spaceId: z.ZodString;
+    properties: z.ZodObject<{
+        room_type: z.ZodOptional<z.ZodString>;
+        massType: z.ZodOptional<z.ZodEnum<{
+            Room: "Room";
+            Plinth: "Plinth";
+            Void: "Void";
+            Pergola: "Pergola";
+            Furniture: "Furniture";
+            "Facade element": "Facade element";
+            "Generic mass": "Generic mass";
+            Department: "Department";
+            Building: "Building";
+            "Revit Import": "Revit Import";
+            Mass: "Mass";
+            Site: "Site";
+        }>>;
+        spaceType: z.ZodOptional<z.ZodEnum<{
+            Room: "Room";
+            "Program Block": "Program Block";
+            Balcony: "Balcony";
+            Road: "Road";
+            Garden: "Garden";
+            Deck: "Deck";
+            Pool: "Pool";
+            Walkway: "Walkway";
+            Envelope: "Envelope";
+            Parking: "Parking";
+        }>>;
+        departmentId: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
+            DEFAULT: "DEFAULT";
+            SITE: "SITE";
+            ENVELOPE: "ENVELOPE";
+            CORE: "CORE";
+        }>, z.ZodUUID]>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type PluginSpaceUpdateArgs = z.infer<typeof PluginSpaceUpdateArgs>;
+/**
+ * Result of {@linkcode PluginSpaceApi.update}.
+ *
+ * Echoes back the `spaceId` and the values of properties that were updated.
+ * Properties that were not included in the update request will be `undefined`.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceId` | `string` | The space ID that was updated |
+ * | `room_type` | `string?` | Updated room type (if changed) |
+ * | `massType` | `string?` | Updated mass type (if changed) |
+ * | `spaceType` | `string?` | Updated space type (if changed) |
+ * | `departmentId` | `string \| null?` | Updated department ID (if changed) |
+ */
+export declare const PluginSpaceUpdateResult: z.ZodObject<{
+    spaceId: z.ZodString;
+    room_type: z.ZodOptional<z.ZodString>;
+    massType: z.ZodOptional<z.ZodString>;
+    spaceType: z.ZodOptional<z.ZodString>;
+    departmentId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type PluginSpaceUpdateResult = z.infer<typeof PluginSpaceUpdateResult>;
+//# sourceMappingURL=space.d.ts.map