@snaptrude/plugin-core 0.0.5 → 0.0.6

package/dist/api/core/math/vec3.d.ts

@@ -1,35 +1,152 @@
 import * as z from "zod";
+/**
+ * 3D vector operations for positions, directions, and displacements.
+ *
+ * All methods are **pure** — they return new {@linkcode PVec3} values
+ * without mutating the inputs.
+ *
+ * Accessed via `snaptrude.core.math.vec3`.
+ */
 export declare abstract class PluginVec3Api {
     constructor();
-    /** Create a new PVec3. */
+    /**
+     * Create a new 3D vector.
+     *
+     * @param x - The X component
+     * @param y - The Y component
+     * @param z - The Z component
+     * @returns A new {@linkcode PVec3}
+     *
+     * # Example
+     * ```ts
+     * const position = snaptrude.core.math.vec3.new(1, 2, 3)
+     * // { x: 1, y: 2, z: 3 }
+     * ```
+     */
     new(x: number, y: number, z: number): PVec3;
-    /** Add two vectors. */
+    /**
+     * Add two vectors component-wise.
+     *
+     * @param a - First vector
+     * @param b - Second vector
+     * @returns A new {@linkcode PVec3} where each component is `a[i] + b[i]`
+     */
     add(a: PVec3, b: PVec3): PVec3;
-    /** Subtract b from a. */
+    /**
+     * Subtract vector {@linkcode b} from vector {@linkcode a} component-wise.
+     *
+     * @param a - Vector to subtract from
+     * @param b - Vector to subtract
+     * @returns A new {@linkcode PVec3} where each component is `a[i] - b[i]`
+     */
     subtract(a: PVec3, b: PVec3): PVec3;
-    /** Scale a vector by a scalar. */
+    /**
+     * Scale a vector by a scalar value.
+     *
+     * @param v - The vector to scale
+     * @param scalar - The scalar multiplier
+     * @returns A new {@linkcode PVec3} where each component is `v[i] * scalar`
+     */
     scale(v: PVec3, scalar: number): PVec3;
-    /** Dot product of two vectors. */
+    /**
+     * Compute the dot product of two vectors.
+     *
+     * The dot product equals `|a| * |b| * cos(θ)` where `θ` is the angle
+     * between the vectors. Useful for checking orthogonality (result = 0)
+     * or projection.
+     *
+     * @param a - First vector
+     * @param b - Second vector
+     * @returns The scalar dot product
+     */
     dot(a: PVec3, b: PVec3): number;
-    /** Cross product of two vectors. */
+    /**
+     * Compute the cross product of two vectors.
+     *
+     * The result is a vector perpendicular to both inputs, with magnitude
+     * equal to the area of the parallelogram they span. Useful for computing
+     * surface normals.
+     *
+     * @param a - First vector
+     * @param b - Second vector
+     * @returns A new {@linkcode PVec3} perpendicular to both {@linkcode a} and {@linkcode b}
+     */
     cross(a: PVec3, b: PVec3): PVec3;
-    /** Length (magnitude) of a vector. */
+    /**
+     * Compute the length (magnitude) of a vector.
+     *
+     * @param v - The vector
+     * @returns The Euclidean length `√(x² + y² + z²)`
+     */
     length(v: PVec3): number;
-    /** Squared length of a vector (avoids sqrt). */
+    /**
+     * Compute the squared length of a vector.
+     *
+     * Avoids the `sqrt` call — prefer this over {@linkcode PluginVec3Api.length}
+     * when comparing relative magnitudes.
+     *
+     * @param v - The vector
+     * @returns The squared length `x² + y² + z²`
+     */
     lengthSquared(v: PVec3): number;
-    /** Normalize a vector to unit length. Returns zero vector if length is 0. */
+    /**
+     * Normalize a vector to unit length.
+     *
+     * @param v - The vector to normalize
+     * @returns A new unit-length {@linkcode PVec3} in the same direction,
+     *   or a zero vector `(0, 0, 0)` if the input has zero length
+     */
     normalize(v: PVec3): PVec3;
-    /** Distance between two points. */
+    /**
+     * Compute the Euclidean distance between two points.
+     *
+     * @param a - First point
+     * @param b - Second point
+     * @returns The distance `|a - b|`
+     */
     distance(a: PVec3, b: PVec3): number;
-    /** Linearly interpolate between two vectors. */
+    /**
+     * Linearly interpolate between two vectors.
+     *
+     * @param a - Start vector (returned when `t = 0`)
+     * @param b - End vector (returned when `t = 1`)
+     * @param t - Interpolation factor, typically in `[0, 1]`
+     * @returns A new {@linkcode PVec3} at `a + (b - a) * t`
+     */
     lerp(a: PVec3, b: PVec3, t: number): PVec3;
-    /** Negate a vector. */
+    /**
+     * Negate a vector (reverse its direction).
+     *
+     * @param v - The vector to negate
+     * @returns A new {@linkcode PVec3} with all components negated
+     */
     negate(v: PVec3): PVec3;
-    /** Check if two vectors are equal (exact). */
+    /**
+     * Check if two vectors are exactly equal (strict equality per component).
+     *
+     * For floating-point comparisons, prefer {@linkcode PluginVec3Api.equalsApprox}.
+     *
+     * @param a - First vector
+     * @param b - Second vector
+     * @returns `true` if all components match exactly
+     */
     equals(a: PVec3, b: PVec3): boolean;
-    /** Check if two vectors are approximately equal within an epsilon. */
+    /**
+     * Check if two vectors are approximately equal within a tolerance.
+     *
+     * @param a - First vector
+     * @param b - Second vector
+     * @param epsilon - Maximum allowed difference per component (default `1e-6`)
+     * @returns `true` if `|a[i] - b[i]| < epsilon` for all components
+     */
     equalsApprox(a: PVec3, b: PVec3, epsilon?: number): boolean;
 }
+/**
+ * A 3D vector with `x`, `y`, and `z` components.
+ *
+ * Used throughout the plugin API for positions, directions, displacements,
+ * and Euler rotation angles. Equivalent to `BABYLON.Vector3`.
+ */
 export declare const PVec3: z.ZodObject<{
     x: z.ZodNumber;
     y: z.ZodNumber;

package/dist/api/core/math/vec3.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vec3.d.ts","sourceRoot":"","sources":["../../../../src/api/core/math/vec3.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAExB,8BAAsB,aAAa;;IAGjC,0BAA0B;IAC1B,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,KAAK;IAI3C,uBAAuB;IACvB,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,GAAG,KAAK;IAI9B,yBAAyB;IACzB,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,GAAG,KAAK;IAInC,kCAAkC;IAClC,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,GAAG,KAAK;IAItC,kCAAkC;IAClC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,GAAG,MAAM;IAI/B,oCAAoC;IACpC,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,GAAG,KAAK;IAQhC,sCAAsC;IACtC,MAAM,CAAC,CAAC,EAAE,KAAK,GAAG,MAAM;IAIxB,gDAAgD;IAChD,aAAa,CAAC,CAAC,EAAE,KAAK,GAAG,MAAM;IAI/B,6EAA6E;IAC7E,SAAS,CAAC,CAAC,EAAE,KAAK,GAAG,KAAK;IAM1B,mCAAmC;IACnC,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,GAAG,MAAM;IAIpC,gDAAgD;IAChD,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,GAAG,KAAK;IAQ1C,uBAAuB;IACvB,MAAM,CAAC,CAAC,EAAE,KAAK,GAAG,KAAK;IAIvB,8CAA8C;IAC9C,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,GAAG,OAAO;IAInC,sEAAsE;IACtE,YAAY,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,GAAE,MAAa,GAAG,OAAO;CAOlE;AAED,eAAO,MAAM,KAAK;;;;iBAIhB,CAAA;AAEF,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,KAAK,CAAC,CAAA"}
+{"version":3,"file":"vec3.d.ts","sourceRoot":"","sources":["../../../../src/api/core/math/vec3.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAExB;;;;;;;GAOG;AACH,8BAAsB,aAAa;;IAGjC;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,KAAK;IAI3C;;;;;;OAMG;IACH,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,GAAG,KAAK;IAI9B;;;;;;OAMG;IACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,GAAG,KAAK;IAInC;;;;;;OAMG;IACH,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,GAAG,KAAK;IAItC;;;;;;;;;;OAUG;IACH,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,GAAG,MAAM;IAI/B;;;;;;;;;;OAUG;IACH,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,GAAG,KAAK;IAQhC;;;;;OAKG;IACH,MAAM,CAAC,CAAC,EAAE,KAAK,GAAG,MAAM;IAIxB;;;;;;;;OAQG;IACH,aAAa,CAAC,CAAC,EAAE,KAAK,GAAG,MAAM;IAI/B;;;;;;OAMG;IACH,SAAS,CAAC,CAAC,EAAE,KAAK,GAAG,KAAK;IAM1B;;;;;;OAMG;IACH,QAAQ,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,GAAG,MAAM;IAIpC;;;;;;;OAOG;IACH,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,GAAG,KAAK;IAQ1C;;;;;OAKG;IACH,MAAM,CAAC,CAAC,EAAE,KAAK,GAAG,KAAK;IAIvB;;;;;;;;OAQG;IACH,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,GAAG,OAAO;IAInC;;;;;;;OAOG;IACH,YAAY,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,GAAE,MAAa,GAAG,OAAO;CAOlE;AAED;;;;;GAKG;AACH,eAAO,MAAM,KAAK;;;;iBAIhB,CAAA;AAEF,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,KAAK,CAAC,CAAA"}

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

@@ -1,7 +1,15 @@
 import { PluginSpaceApi } from "./space";
 import { PluginStoryApi } from "./story";
+/**
+ * CRUD operations on Snaptrude building entities.
+ *
+ * - {@linkcode PluginEntityApi.space} — Create, query, and delete spaces (rooms/masses)
+ * - {@linkcode PluginEntityApi.story} — Create, query, and update stories (floors)
+ */
 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;
     constructor();
 }

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,8BAAsB,eAAe;IACnC,SAAgB,KAAK,EAAE,cAAc,CAAA;IACrC,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,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"}

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

@@ -1,13 +1,158 @@
 import * as z from "zod";
 import { PluginApiReturn } from "../../types";
+/**
+ * Space (room/mass) management — create, query, 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 extruded
+     * upward (along the Y axis) by {@linkcode PluginSpaceCreateFromProfileArgs.extrudeHeight
+     * extrudeHeight}, then offset by {@linkcode PluginSpaceCreateFromProfileArgs.position
+     * position}. 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 floor shape
+     *   - {@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 profile = 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 { spaceId } = await snaptrude.entity.space.createFromProfile({
+     *   profile,
+     *   extrudeHeight: 3,
+     *   position: vec3.new(0, 0, 0),
+     * })
+     * ```
+     */
     abstract createFromProfile({ profile, extrudeHeight, position, }: PluginSpaceCreateFromProfileArgs): PluginApiReturn<PluginSpaceCreateFromProfileResult>;
+    /**
+     * 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>;
-    abstract deleteById({ spaceId, }: PluginSpaceDeleteByIdArgs): PluginApiReturn<PluginSpaceDeleteByIdResult>;
+    /**
+     * 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>;
 }
+/**
+ * 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;
@@ -21,10 +166,26 @@ export declare const PluginSpaceCreateRectangularArgs: z.ZodObject<{
     }, 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 floor shape |
+ * | `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<{
@@ -71,10 +232,33 @@ export declare const PluginSpaceCreateFromProfileArgs: z.ZodObject<{
     }, 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>;
+/**
+ * Available properties that can be queried on a space.
+ *
+ * | 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 |
+ * | `"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 |
+ */
 export declare const PluginSpaceGetProperty: z.ZodEnum<{
     position: "position";
     id: "id";
@@ -87,6 +271,14 @@ export declare const PluginSpaceGetProperty: z.ZodEnum<{
     rotation: "rotation";
     rotationQuaternion: "rotationQuaternion";
 }>;
+/**
+ * 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<{
@@ -103,6 +295,12 @@ export declare const PluginSpaceGetArgs: z.ZodObject<{
     }>>;
 }, z.core.$strip>;
 export type PluginSpaceGetArgs = z.infer<typeof PluginSpaceGetArgs>;
+/**
+ * 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>;
@@ -133,13 +331,28 @@ export declare const PluginSpaceGetResult: z.ZodObject<{
     }, 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>;
-export declare const PluginSpaceDeleteByIdArgs: z.ZodObject<{
+/**
+ * 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 PluginSpaceDeleteByIdArgs = z.infer<typeof PluginSpaceDeleteByIdArgs>;
-export type PluginSpaceDeleteByIdResult = void;
+export type PluginSpaceDeleteArgs = z.infer<typeof PluginSpaceDeleteArgs>;
+/** Result type for {@linkcode PluginSpaceApi.delete} — returns nothing on success. */
+export type PluginSpaceDeleteResult = void;
 //# 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,8BAAsB,cAAc;;aAGlB,iBAAiB,CAAC,EAChC,QAAQ,EACR,UAAU,GACX,EAAE,gCAAgC,GAAG,eAAe,CAAC,kCAAkC,CAAC;aAEzE,iBAAiB,CAAC,EAChC,OAAO,EACP,aAAa,EACb,QAAQ,GACT,EAAE,gCAAgC,GAAG,eAAe,CAAC,kCAAkC,CAAC;aAEzE,MAAM,IAAI,eAAe,CAAC,uBAAuB,CAAC;aAElD,GAAG,CAAC,EAClB,OAAO,EACP,UAAU,GACX,EAAE,kBAAkB,GAAG,eAAe,CAAC,oBAAoB,CAAC;aAE7C,UAAU,CAAC,EACzB,OAAO,GACR,EAAE,yBAAyB,GAAG,eAAe,CAAC,2BAA2B,CAAC;CAC5E;AAED,eAAO,MAAM,gCAAgC;;;;;;;;;;;iBAO3C,CAAA;AAEF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAA;AAE/F,eAAO,MAAM,kCAAkC;;iBAE7C,CAAA;AAEF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAEnG,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAI3C,CAAA;AAEF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAA;AAE/F,eAAO,MAAM,kCAAkC;;iBAE7C,CAAA;AAEF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kCAAkC,CAAC,CAAA;AAEnG,eAAO,MAAM,sBAAsB;;;;;;;;;;;EAWjC,CAAA;AAEF,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;iBAG7B,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAarB,CAAA;AAEZ,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE,eAAO,MAAM,uBAAuB;;iBAElC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E,eAAO,MAAM,yBAAyB;;iBAEpC,CAAA;AAEF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAEjF,MAAM,MAAM,2BAA2B,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;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"}