@snaptrude/plugin-core 0.0.6 → 0.0.8

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";
+    name: "name";
+    departmentId: "departmentId";
     id: "id";
+    position: "position";
+    height: "height";
+    depth: "depth";
     type: "type";
     room_type: "room_type";
-    name: "name";
     area: "area";
-    department: "department";
+    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}.
@@ -282,19 +342,54 @@ export declare const PluginSpaceGetProperty: z.ZodEnum<{
 export declare const PluginSpaceGetArgs: z.ZodObject<{
     spaceId: z.ZodString;
     properties: z.ZodArray<z.ZodEnum<{
-        position: "position";
+        name: "name";
+        departmentId: "departmentId";
         id: "id";
+        position: "position";
+        height: "height";
+        depth: "depth";
         type: "type";
         room_type: "room_type";
-        name: "name";
         area: "area";
-        department: "department";
+        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 |
+ */
+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"}

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

@@ -121,9 +121,9 @@ export declare abstract class PluginStoryApi {
  * | `"totalArea"` | `number` | Total floor area of this story |
  */
 export declare const PluginStoryGetProperty: z.ZodEnum<{
-    height: "height";
-    id: "id";
     name: "name";
+    id: "id";
+    height: "height";
     value: "value";
     base: "base";
     hidden: "hidden";
@@ -141,9 +141,9 @@ export declare const PluginStoryGetProperty: z.ZodEnum<{
 export declare const PluginStoryGetArgs: z.ZodObject<{
     storyValue: z.ZodNumber;
     properties: z.ZodArray<z.ZodEnum<{
-        height: "height";
-        id: "id";
         name: "name";
+        id: "id";
+        height: "height";
         value: "value";
         base: "base";
         hidden: "hidden";

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

@@ -23,6 +23,8 @@ export declare abstract class PluginUnitsApi {
      *     to convert from. See {@linkcode PUnitType} for supported values.
      *   - {@linkcode PluginUnitsConvertFromArgs.value args.value} — The numeric
      *     value in the source unit
+     *   - {@linkcode PluginUnitsConvertFromArgs.degree args.degree} — (Optional)
+     *     Degree of the unit: 1 for length, 2 for area, 3 for volume. Defaults to 1
      * @returns A {@linkcode PluginUnitsConvertFromResult} containing the converted
      *   `value` in Babylon units
      *
@@ -48,6 +50,8 @@ export declare abstract class PluginUnitsApi {
      *     to convert to. See {@linkcode PUnitType} for supported values.
      *   - {@linkcode PluginUnitsConvertToArgs.value args.value} — The numeric
      *     value in Babylon units
+     *   - {@linkcode PluginUnitsConvertToArgs.degree args.degree} — (Optional)
+     *     Degree of the unit: 1 for length, 2 for area, 3 for volume. Defaults to 1
      * @returns A {@linkcode PluginUnitsConvertToResult} containing the converted
      *   `value` in the target unit
      *
@@ -61,6 +65,7 @@ export declare abstract class PluginUnitsApi {
      * const areaInMeters = await snaptrude.units.convertTo({
      *   unit: "meters",
      *   value: info.area!,
+     *   degree: 2,
      * })
      * ```
      */
@@ -94,6 +99,7 @@ export type PUnitType = z.infer<typeof PUnitType>;
  * |---|---|---|
  * | `unit` | {@linkcode PUnitType} | Source real-world unit |
  * | `value` | `number` | Numeric value in the source unit |
+ * | `degree` | `1 \| 2 \| 3` | (Optional) Degree of the unit (e.g. 1 for length, 2 for area, 3 for volume). Defaults to 1 |
  */
 export declare const PluginUnitsConvertFromArgs: z.ZodObject<{
     unit: z.ZodEnum<{
@@ -106,6 +112,7 @@ export declare const PluginUnitsConvertFromArgs: z.ZodObject<{
         miles: "miles";
     }>;
     value: z.ZodNumber;
+    degree: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 export type PluginUnitsConvertFromArgs = z.infer<typeof PluginUnitsConvertFromArgs>;
 /**
@@ -126,6 +133,7 @@ export type PluginUnitsConvertFromResult = z.infer<typeof PluginUnitsConvertFrom
  * |---|---|---|
  * | `unit` | {@linkcode PUnitType} | Target real-world unit |
  * | `value` | `number` | Numeric value in Babylon units |
+ * | `degree` | `1 \| 2 \| 3` | (Optional) Degree of the unit (e.g. 1 for length, 2 for area, 3 for volume). Defaults to 1 |
  */
 export declare const PluginUnitsConvertToArgs: z.ZodObject<{
     unit: z.ZodEnum<{
@@ -138,6 +146,7 @@ export declare const PluginUnitsConvertToArgs: z.ZodObject<{
         miles: "miles";
     }>;
     value: z.ZodNumber;
+    degree: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 export type PluginUnitsConvertToArgs = z.infer<typeof PluginUnitsConvertToArgs>;
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/units/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;GASG;AACH,8BAAsB,cAAc;;IAGlC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;aACa,WAAW,CACzB,IAAI,EAAE,0BAA0B,GAC/B,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;aACa,SAAS,CACvB,IAAI,EAAE,wBAAwB,GAC7B,eAAe,CAAC,0BAA0B,CAAC;CAC/C;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS;;;;;;;;EAQpB,CAAA;AAEF,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAA;AAEjD;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;iBAGrC,CAAA;AAEF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B;;iBAEvC,CAAA;AAEF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAEvF;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;iBAGnC,CAAA;AAEF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B;;iBAErC,CAAA;AAEF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/units/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C;;;;;;;;;GASG;AACH,8BAAsB,cAAc;;IAGlC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,WAAW,CACzB,IAAI,EAAE,0BAA0B,GAC/B,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;aACa,SAAS,CACvB,IAAI,EAAE,wBAAwB,GAC7B,eAAe,CAAC,0BAA0B,CAAC;CAC/C;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS;;;;;;;;EAQpB,CAAA;AAEF,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAA;AAEjD;;;;;;;;GAQG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;iBAIrC,CAAA;AAEF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B;;iBAEvC,CAAA;AAEF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAEvF;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;iBAInC,CAAA;AAEF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B;;iBAErC,CAAA;AAEF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA"}