@snaptrude/plugin-core 0.0.6 → 0.0.7

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

@@ -1,3 +1,4 @@
+import { PluginReferenceLineApi } from "./referenceLine";
 import { PluginSpaceApi } from "./space";
 import { PluginStoryApi } from "./story";
 /**
@@ -5,14 +6,18 @@ import { PluginStoryApi } from "./story";
  *
  * - {@linkcode PluginEntityApi.space} — Create, query, and delete spaces (rooms/masses)
  * - {@linkcode PluginEntityApi.story} — Create, query, and update stories (floors)
+ * - {@linkcode PluginEntityApi.referenceLine} — Create, query, and delete reference lines
  */
 export declare abstract class PluginEntityApi {
     /** Space (room/mass) operations. See {@linkcode PluginSpaceApi}. */
     abstract space: PluginSpaceApi;
     /** Story (floor/storey) operations. See {@linkcode PluginStoryApi}. */
     abstract story: PluginStoryApi;
+    /** Reference line operations. See {@linkcode PluginReferenceLineApi}. */
+    abstract referenceLine: PluginReferenceLineApi;
     constructor();
 }
+export * from "./referenceLine";
 export * from "./space";
 export * from "./story";
 //# sourceMappingURL=index.d.ts.map

package/dist/api/entity/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/entity/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAExC;;;;;GAKG;AACH,8BAAsB,eAAe;IACnC,oEAAoE;IACpE,SAAgB,KAAK,EAAE,cAAc,CAAA;IACrC,uEAAuE;IACvE,SAAgB,KAAK,EAAE,cAAc,CAAA;;CAGtC;AAED,cAAc,SAAS,CAAA;AACvB,cAAc,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/entity/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAExC;;;;;;GAMG;AACH,8BAAsB,eAAe;IACnC,oEAAoE;IACpE,SAAgB,KAAK,EAAE,cAAc,CAAA;IACrC,uEAAuE;IACvE,SAAgB,KAAK,EAAE,cAAc,CAAA;IACrC,yEAAyE;IACzE,SAAgB,aAAa,EAAE,sBAAsB,CAAA;;CAGtD;AAED,cAAc,iBAAiB,CAAA;AAC/B,cAAc,SAAS,CAAA;AACvB,cAAc,SAAS,CAAA"}

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

@@ -0,0 +1,259 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../types";
+/**
+ * Reference line management — create, query, and delete reference lines.
+ *
+ * A **reference line** is a 2D guide line (or arc) in the Snaptrude scene,
+ * typically used for grid lines and alignment guides. Reference lines
+ * carry properties such as grid tags, labels, and line styles.
+ *
+ * All methods are **host API calls** that return Promises and support
+ * undo/redo via Snaptrude's command system.
+ *
+ * Accessed via `snaptrude.entity.referenceLine`.
+ */
+export declare abstract class PluginReferenceLineApi {
+    constructor();
+    /**
+     * Create multiple reference lines from a profile.
+     *
+     * Each {@linkcode PCurve} in the given {@linkcode PProfile} becomes
+     * a separate reference line. Uses `ReferenceLineConstructor.createFromProfile`
+     * internally.
+     *
+     * @param args - An object containing:
+     *   - {@linkcode PluginReferenceLineCreateMultiArgs.profile args.profile} — A
+     *     {@linkcode PProfile} whose curves define the reference lines to create
+     * @returns A {@linkcode PluginReferenceLineCreateMultiResult} with the
+     *   `referenceLineIds` of the created reference lines
+     * @throws If reference line creation fails
+     *
+     * # Example
+     * ```ts
+     * const { vec3 } = snaptrude.core.math
+     *
+     * const l1 = snaptrude.core.geom.line.new(vec3.new(0, 0, 0), vec3.new(10, 0, 0))
+     * const l2 = snaptrude.core.geom.line.new(vec3.new(10, 0, 0), vec3.new(10, 0, 10))
+     * const profile = snaptrude.core.geom.profile.new([l1, l2])
+     *
+     * const { referenceLineIds } = await snaptrude.entity.referenceLine.createMulti({
+     *   profile,
+     * })
+     * ```
+     */
+    abstract createMulti(args: PluginReferenceLineCreateMultiArgs): PluginApiReturn<PluginReferenceLineCreateMultiResult>;
+    /**
+     * Get properties of a reference line by its ID.
+     *
+     * Only the properties listed in {@linkcode PluginReferenceLineGetArgs.properties
+     * args.properties} are returned — unlisted properties will be `undefined`
+     * in the result.
+     *
+     * @param args - An object containing:
+     *   - {@linkcode PluginReferenceLineGetArgs.referenceLineId args.referenceLineId} —
+     *     The unique reference line ID
+     *   - {@linkcode PluginReferenceLineGetArgs.properties args.properties} — Array of
+     *     property names to retrieve. See {@linkcode PluginReferenceLineGetProperty}.
+     * @returns A partial {@linkcode PluginReferenceLineGetResult} containing only the
+     *   requested properties
+     * @throws If the reference line does not exist
+     *
+     * # Example
+     * ```ts
+     * const result = await snaptrude.entity.referenceLine.get({
+     *   referenceLineId: "some-ref-line-id",
+     *   properties: ["curve"],
+     * })
+     * console.log(result.curve) // PCurve
+     * ```
+     */
+    abstract get(args: PluginReferenceLineGetArgs): PluginApiReturn<PluginReferenceLineGetResult>;
+    /**
+     * Get the IDs of all reference lines in the current project.
+     *
+     * Returns every reference line across all stories.
+     * Use the returned IDs with {@linkcode PluginReferenceLineApi.get} to query
+     * individual reference line properties.
+     *
+     * @returns A {@linkcode PluginReferenceLineGetAllResult} with a
+     *   `referenceLineIds` array
+     *
+     * # Example
+     * ```ts
+     * const { referenceLineIds } = await snaptrude.entity.referenceLine.getAll()
+     * console.log(`Project has ${referenceLineIds.length} reference lines`)
+     * ```
+     */
+    abstract getAll(): PluginApiReturn<PluginReferenceLineGetAllResult>;
+    /**
+     * Delete a reference line by its ID.
+     *
+     * Permanently removes the reference line and its associated mesh from
+     * the scene. This operation is undoable via Snaptrude's command system.
+     *
+     * @param args - An object containing:
+     *   - {@linkcode PluginReferenceLineDeleteArgs.referenceLineId args.referenceLineId} —
+     *     The unique reference line ID to delete
+     * @throws If the reference line does not exist
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.entity.referenceLine.delete({
+     *   referenceLineId: "some-ref-line-id",
+     * })
+     * ```
+     */
+    abstract delete(args: PluginReferenceLineDeleteArgs): PluginApiReturn<PluginReferenceLineDeleteResult>;
+}
+/**
+ * Arguments for {@linkcode PluginReferenceLineApi.createMulti}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `profile` | {@linkcode PProfile} | Profile whose curves define reference lines |
+ */
+export declare const PluginReferenceLineCreateMultiArgs: 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>;
+}, z.core.$strip>;
+export type PluginReferenceLineCreateMultiArgs = z.infer<typeof PluginReferenceLineCreateMultiArgs>;
+/**
+ * Result of {@linkcode PluginReferenceLineApi.createMulti}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `referenceLineIds` | `string[]` | IDs of the created reference lines |
+ */
+export declare const PluginReferenceLineCreateMultiResult: z.ZodObject<{
+    referenceLineIds: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type PluginReferenceLineCreateMultiResult = z.infer<typeof PluginReferenceLineCreateMultiResult>;
+/**
+ * Available properties that can be queried on a reference line.
+ *
+ * | Value | Return Type | Description |
+ * |---|---|---|
+ * | `"curve"` | {@linkcode PCurve} | The curve geometry of the reference line |
+ */
+export declare const PluginReferenceLineGetProperty: z.ZodEnum<{
+    curve: "curve";
+}>;
+/**
+ * Arguments for {@linkcode PluginReferenceLineApi.get}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `referenceLineId` | `string` | The reference line ID to query |
+ * | `properties` | {@linkcode PluginReferenceLineGetProperty}`[]` | Properties to retrieve |
+ */
+export declare const PluginReferenceLineGetArgs: z.ZodObject<{
+    referenceLineId: z.ZodString;
+    properties: z.ZodArray<z.ZodEnum<{
+        curve: "curve";
+    }>>;
+}, z.core.$strip>;
+export type PluginReferenceLineGetArgs = z.infer<typeof PluginReferenceLineGetArgs>;
+/**
+ * Result of {@linkcode PluginReferenceLineApi.get}.
+ *
+ * A partial object — only the properties that were requested in
+ * {@linkcode PluginReferenceLineGetArgs.properties} will be present.
+ */
+export declare const PluginReferenceLineGetResult: z.ZodObject<{
+    curve: z.ZodOptional<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>;
+export type PluginReferenceLineGetResult = z.infer<typeof PluginReferenceLineGetResult>;
+/**
+ * Result of {@linkcode PluginReferenceLineApi.getAll}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `referenceLineIds` | `string[]` | IDs of all reference lines in the project |
+ */
+export declare const PluginReferenceLineGetAllResult: z.ZodObject<{
+    referenceLineIds: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type PluginReferenceLineGetAllResult = z.infer<typeof PluginReferenceLineGetAllResult>;
+/**
+ * Arguments for {@linkcode PluginReferenceLineApi.delete}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `referenceLineId` | `string` | The reference line ID to delete |
+ */
+export declare const PluginReferenceLineDeleteArgs: z.ZodObject<{
+    referenceLineId: z.ZodString;
+}, z.core.$strip>;
+export type PluginReferenceLineDeleteArgs = z.infer<typeof PluginReferenceLineDeleteArgs>;
+/** Result type for {@linkcode PluginReferenceLineApi.delete} — returns nothing on success. */
+export type PluginReferenceLineDeleteResult = void;
+//# sourceMappingURL=referenceLine.d.ts.map

package/dist/api/entity/referenceLine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"referenceLine.d.ts","sourceRoot":"","sources":["../../../src/api/entity/referenceLine.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAI7C;;;;;;;;;;;GAWG;AACH,8BAAsB,sBAAsB;;IAG1C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;aACa,WAAW,CACzB,IAAI,EAAE,kCAAkC,GACvC,eAAe,CAAC,oCAAoC,CAAC;IAExD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,GAAG,CACjB,IAAI,EAAE,0BAA0B,GAC/B,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;OAeG;aACa,MAAM,IAAI,eAAe,CAAC,+BAA+B,CAAC;IAE1E;;;;;;;;;;;;;;;;;OAiBG;aACa,MAAM,CACpB,IAAI,EAAE,6BAA6B,GAClC,eAAe,CAAC,+BAA+B,CAAC;CACpD;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAE7C,CAAA;AAEF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAEnG;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC;;iBAE/C,CAAA;AAEF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oCAAoC,CAAC,CAAA;AAEvG;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B;;EAEzC,CAAA;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;;;;iBAGrC,CAAA;AAEF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAI7B,CAAA;AAEZ,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAEvF;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B;;iBAE1C,CAAA;AAEF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AAE7F;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B;;iBAExC,CAAA;AAEF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAA;AAEzF,8FAA8F;AAC9F,MAAM,MAAM,+BAA+B,GAAG,IAAI,CAAA"}

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

@@ -144,6 +144,35 @@ export declare abstract class PluginSpaceApi {
      * ```
      */
     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}.
@@ -246,30 +275,61 @@ export type PluginSpaceCreateFromProfileResult = z.infer<typeof PluginSpaceCreat
 /**
  * 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 |
- * | `"area"` | `number` | Bottom (floor) area |
- * | `"department"` | `string` | Assigned department name |
+ *
+ * **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. |
  */
 export declare const PluginSpaceGetProperty: z.ZodEnum<{
     position: "position";
+    height: "height";
+    depth: "depth";
     id: "id";
     type: "type";
     room_type: "room_type";
     name: "name";
     area: "area";
-    department: "department";
+    breadth: "breadth";
+    massType: "massType";
+    spaceType: "spaceType";
+    storey: "storey";
+    departmentId: "departmentId";
+    departmentName: "departmentName";
+    departmentColor: "departmentColor";
     absolutePosition: "absolutePosition";
     rotation: "rotation";
     rotationQuaternion: "rotationQuaternion";
+    planPoints: "planPoints";
 }>;
 /**
  * Arguments for {@linkcode PluginSpaceApi.get}.
@@ -283,18 +343,53 @@ export declare const PluginSpaceGetArgs: z.ZodObject<{
     spaceId: z.ZodString;
     properties: z.ZodArray<z.ZodEnum<{
         position: "position";
+        height: "height";
+        depth: "depth";
         id: "id";
         type: "type";
         room_type: "room_type";
         name: "name";
         area: "area";
-        department: "department";
+        breadth: "breadth";
+        massType: "massType";
+        spaceType: "spaceType";
+        storey: "storey";
+        departmentId: "departmentId";
+        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 |
+ */
+export declare const PluginSpaceType: z.ZodEnum<{
+    Room: "Room";
+    "Program Block": "Program Block";
+    Balcony: "Balcony";
+    Road: "Road";
+    Garden: "Garden";
+    Deck: "Deck";
+    Pool: "Pool";
+    Walkway: "Walkway";
+}>;
 /**
  * Result of {@linkcode PluginSpaceApi.get}.
  *
@@ -307,7 +402,24 @@ export declare const PluginSpaceGetResult: z.ZodObject<{
     room_type: z.ZodOptional<z.ZodString>;
     name: z.ZodOptional<z.ZodString>;
     area: z.ZodOptional<z.ZodNumber>;
-    department: z.ZodOptional<z.ZodString>;
+    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";
+    }>>>;
+    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;
@@ -329,6 +441,11 @@ export declare const PluginSpaceGetResult: z.ZodObject<{
         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>>>;
 }, z.core.$strip>;
 export type PluginSpaceGetResult = z.infer<typeof PluginSpaceGetResult>;
 /**
@@ -355,4 +472,134 @@ export declare const PluginSpaceDeleteArgs: z.ZodObject<{
 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";
+        }>>;
+        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

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

@@ -1 +1 @@
-{"version":3,"file":"space.d.ts","sourceRoot":"","sources":["../../../src/api/entity/space.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAK7C;;;;;;;;;;;GAWG;AACH,8BAAsB,cAAc;;IAGlC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,iBAAiB,CAAC,EAChC,QAAQ,EACR,UAAU,GACX,EAAE,gCAAgC,GAAG,eAAe,CAAC,kCAAkC,CAAC;IAEzF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;aACa,iBAAiB,CAAC,EAChC,OAAO,EACP,aAAa,EACb,QAAQ,GACT,EAAE,gCAAgC,GAAG,eAAe,CAAC,kCAAkC,CAAC;IAEzF;;;;;;;;;;;;;;OAcG;aACa,MAAM,IAAI,eAAe,CAAC,uBAAuB,CAAC;IAElE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,GAAG,CAAC,EAClB,OAAO,EACP,UAAU,GACX,EAAE,kBAAkB,GAAG,eAAe,CAAC,oBAAoB,CAAC;IAE7D;;;;;;;;;;;;;;;OAeG;aACa,MAAM,CAAC,EACrB,OAAO,GACR,EAAE,qBAAqB,GAAG,eAAe,CAAC,uBAAuB,CAAC;CACpE;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;iBAO3C,CAAA;AAEF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAA;AAE/F;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;iBAE7C,CAAA;AAEF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAEnG;;;;;;;;GAQG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAI3C,CAAA;AAEF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAA;AAE/F;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;iBAE7C,CAAA;AAEF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAEnG;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;EAWjC,CAAA;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;iBAG7B,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAarB,CAAA;AAEZ,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;;iBAElC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB;;iBAEhC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE,sFAAsF;AACtF,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAA"}
+{"version":3,"file":"space.d.ts","sourceRoot":"","sources":["../../../src/api/entity/space.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAK7C;;;;;;;;;;;GAWG;AACH,8BAAsB,cAAc;;IAGlC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,iBAAiB,CAAC,EAChC,QAAQ,EACR,UAAU,GACX,EAAE,gCAAgC,GAAG,eAAe,CAAC,kCAAkC,CAAC;IAEzF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;aACa,iBAAiB,CAAC,EAChC,OAAO,EACP,aAAa,EACb,QAAQ,GACT,EAAE,gCAAgC,GAAG,eAAe,CAAC,kCAAkC,CAAC;IAEzF;;;;;;;;;;;;;;OAcG;aACa,MAAM,IAAI,eAAe,CAAC,uBAAuB,CAAC;IAElE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;aACa,GAAG,CAAC,EAClB,OAAO,EACP,UAAU,GACX,EAAE,kBAAkB,GAAG,eAAe,CAAC,oBAAoB,CAAC;IAE7D;;;;;;;;;;;;;;;OAeG;aACa,MAAM,CAAC,EACrB,OAAO,GACR,EAAE,qBAAqB,GAAG,eAAe,CAAC,uBAAuB,CAAC;IAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;aACa,MAAM,CACpB,IAAI,EAAE,qBAAqB,GAC1B,eAAe,CAAC,uBAAuB,CAAC;CAC5C;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;iBAO3C,CAAA;AAEF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;iBAE7C,CAAA;AAEF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAI3C,CAAA;AAEF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kCAAkC;;iBAE7C,CAAA;AAEF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;EAwBjC,CAAA;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;iBAG7B,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,eAAe;;;;;;;;;EAS1B,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA0BrB,CAAA;AAEZ,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;;iBAElC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB;;iBAEhC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE,sFAAsF;AACtF,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAA;AAE1C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;EAazB,CAAA;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,2BAA2B;;;;;EAKtC,CAAA;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;;;;eAG7B,CAAA;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAQhC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,uBAAuB;;;;;;iBAMlC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA"}