@snaptrude/plugin-core 0.2.9 → 0.5.0

package/src/api/entity/space.ts

@@ -1,390 +1,27 @@
+// Space value types + schemas. The `entity.space.*` API was removed and its
+// operations migrated to `design.create.spaces` / `design.update.*` /
+// `design.query.*` / `design.delete.entities`. These shared space types survive
+// here because `design.create` / `design.query` / `design.update` import them.
 import * as z from "zod"
-import { PluginApiReturn } from "../../types"
-import { PVec3 } from "../core/math/vec3"
-import { PQuat } from "../core/math/quat"
-import { PProfile } from "../core/geom/profile"
+import {
+  ProfileHandle,
+  Vec3Handle,
+  Vec3Components,
+  QuatComponents,
+  CurveHandle,
+} from "../../handles"
 
-/**
- * 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 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 },
-   * })
-   * ```
-   */
-  public 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),
-   * })
-   * ```
-   */
-  public 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,
-   * })
-   * ```
-   */
-  public 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`)
-   * ```
-   */
-  public 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)
-   * ```
-   */
-  public 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" })
-   * ```
-   */
-  public 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",
-   *   },
-   * })
-   * ```
-   */
-  public abstract update(
-    args: PluginSpaceUpdateArgs,
-  ): PluginApiReturn<PluginSpaceUpdateResult>
-
-  /**
-   * Create many spaces in a single undoable operation.
-   *
-   * Each item is either a rectangular box (`kind: "rectangular"`) or an
-   * extruded profile (`kind: "profile"`), and may optionally set `room_type`,
-   * `spaceType`, `massType`, and `departmentId`. All creations — and the
-   * optional property assignments — are batched into **one** command, so the
-   * entire batch is undone/redone in a single step.
-   *
-   * All items are validated first; if any item is invalid the call **throws**
-   * and no spaces are created (nothing is applied) — consistent with the
-   * single-item create methods.
-   *
-   * @param args - {@linkcode PluginSpaceBulkCreateArgs} with an `items` array
-   * @returns A {@linkcode PluginSpaceBulkCreateResult} with the `spaceIds` of
-   *   the created spaces, in input order
-   * @throws If any item has invalid dimensions, height, or profile
-   *
-   * # Example
-   * ```ts
-   * const { vec3 } = snaptrude.core.math
-   *
-   * const { spaceIds } = await snaptrude.entity.space.bulkCreate({
-   *   items: [
-   *     {
-   *       kind: "rectangular",
-   *       position: vec3.new(0, 0, 0),
-   *       dimensions: { width: 5, height: 3, depth: 4 },
-   *       spaceType: "Room",
-   *       departmentId: "CORE",
-   *     },
-   *     {
-   *       kind: "profile",
-   *       profile: await snaptrude.core.geom.profile.fromLinePoints({
-   *         points: [vec3.new(0, 0, 0), vec3.new(8, 0, 0), vec3.new(8, 0, 6), vec3.new(0, 0, 6)],
-   *       }),
-   *       extrudeHeight: 3,
-   *       position: vec3.new(10, 0, 0),
-   *       massType: "Room",
-   *     },
-   *   ],
-   * })
-   * ```
-   */
-  public abstract bulkCreate(
-    args: PluginSpaceBulkCreateArgs,
-  ): PluginApiReturn<PluginSpaceBulkCreateResult>
-
-  /**
-   * Update many existing spaces in a single undoable operation.
-   *
-   * Each item targets an existing space by `spaceId` and may change its
-   * geometry (`profile` + `extrudeHeight`, which must be supplied together) and/or
-   * its `properties` (`room_type`, `massType`, `spaceType`, `areaClass`,
-   * `departmentId` —
-   * nested under `properties`, mirroring {@linkcode PluginSpaceApi.update}). All
-   * changes are batched into **one** command, so the entire batch is
-   * undone/redone in a single step.
-   *
-   * All items are validated first; if any item is invalid — an unknown
-   * `spaceId`, a non-positive height, or supplying only one of
-   * `profile`/`extrudeHeight` — the call **throws** and no changes are applied.
-   *
-   * @param args - {@linkcode PluginSpaceBulkUpdateArgs} with an `items` array
-   * @returns A {@linkcode PluginSpaceBulkUpdateResult} echoing one
-   *   {@linkcode PluginSpaceUpdateResult} per item in `spaces`, in input order
-   * @throws If any item targets an unknown space, has a non-positive height, or
-   *   supplies only one of `profile`/`extrudeHeight`
-   *
-   * # Example
-   * ```ts
-   * const { spaces } = await snaptrude.entity.space.bulkUpdate({
-   *   items: [
-   *     { spaceId: "space-a", properties: { room_type: "Kitchen", spaceType: "Room" } },
-   *     { spaceId: "space-b", profile, extrudeHeight: 4 },
-   *   ],
-   * })
-   * ```
-   */
-  public abstract bulkUpdate(
-    args: PluginSpaceBulkUpdateArgs,
-  ): PluginApiReturn<PluginSpaceBulkUpdateResult>
-
-  /**
-   * Delete many spaces in a single undoable operation.
-   *
-   * All deletions are batched into **one** command, so the entire batch is
-   * undone/redone in a single step.
-   *
-   * All IDs are validated first; if any ID is unknown or is not a space the
-   * call **throws** and no spaces are deleted — consistent with the single-item
-   * {@linkcode PluginSpaceApi.delete}.
-   *
-   * @param args - {@linkcode PluginSpaceBulkDeleteArgs} with a `spaceIds` array
-   * @returns A {@linkcode PluginSpaceBulkDeleteResult} with `deletedSpaceIds`
-   *   (the removed IDs, in input order)
-   * @throws If any ID does not resolve to an existing space
-   *
-   * # Example
-   * ```ts
-   * await snaptrude.entity.space.bulkDelete({ spaceIds: ["space-a", "space-b"] })
-   * ```
-   */
-  public abstract bulkDelete(
-    args: PluginSpaceBulkDeleteArgs,
-  ): PluginApiReturn<PluginSpaceBulkDeleteResult>
-}
 
 /**
- * Arguments for {@linkcode PluginSpaceApi.createRectangular}.
+ * Arguments for `createRectangular`.
  *
  * | Property | Type | Description |
  * |---|---|---|
- * | `position` | {@linkcode PVec3} | Origin position in Babylon units |
+ * | `position` | {@linkcode Vec3Handle} | Origin position in Babylon units |
  * | `dimensions` | `{ width, height, depth }` | Box dimensions in Babylon units |
  */
 export const PluginSpaceCreateRectangularArgs = z.object({
-  position: PVec3,
+  position: Vec3Handle,
   dimensions: z.object({
     width: z.number(),
     height: z.number(),
@@ -397,7 +34,7 @@ export type PluginSpaceCreateRectangularArgs = z.infer<
 >
 
 /**
- * Result of {@linkcode PluginSpaceApi.createRectangular}.
+ * Result of `createRectangular`.
  *
  * | Property | Type | Description |
  * |---|---|---|
@@ -412,20 +49,20 @@ export type PluginSpaceCreateRectangularResult = z.infer<
 >
 
 /**
- * Arguments for {@linkcode PluginSpaceApi.createFromProfile}.
+ * Arguments for `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 |
+ * | `profile` | {@linkcode ProfileHandle} | Handle to a closed 2D profile (the outer floor shape) |
+ * | `innerProfiles` | {@linkcode ProfileHandle}`[]` | Optional profile handles to subtract as holes |
  * | `extrudeHeight` | `number` | Extrusion height in Babylon units |
- * | `position` | {@linkcode PVec3} | Offset position in Babylon units |
+ * | `position` | {@linkcode Vec3Handle} | Offset position in Babylon units |
  */
 export const PluginSpaceCreateFromProfileArgs = z.object({
-  profile: PProfile,
-  innerProfiles: z.array(PProfile).optional(),
+  profile: ProfileHandle,
+  innerProfiles: z.array(ProfileHandle).optional(),
   extrudeHeight: z.number(),
-  position: PVec3,
+  position: Vec3Handle,
 })
 
 export type PluginSpaceCreateFromProfileArgs = z.infer<
@@ -433,7 +70,7 @@ export type PluginSpaceCreateFromProfileArgs = z.infer<
 >
 
 /**
- * Result of {@linkcode PluginSpaceApi.createFromProfile}.
+ * Result of `createFromProfile`.
  *
  * | Property | Type | Description |
  * |---|---|---|
@@ -448,17 +85,17 @@ export type PluginSpaceCreateFromProfileResult = z.infer<
 >
 
 /**
- * Arguments for {@linkcode PluginSpaceApi.updateGeometryFromProfile}.
+ * Arguments for `updateGeometryFromProfile`.
  *
  * | Property | Type | Description |
  * |---|---|---|
  * | `spaceId` | `string` | Space to update |
- * | `profile` | {@linkcode PProfile} | Closed 2D profile defining the new floor shape |
+ * | `profile` | {@linkcode ProfileHandle} | Handle to the closed 2D profile defining the new floor shape |
  * | `extrudeHeight` | `number` | New extrusion height in Babylon units |
  */
 export const PluginSpaceUpdateGeometryFromProfileArgs = z.object({
   spaceId: z.string(),
-  profile: PProfile,
+  profile: ProfileHandle,
   extrudeHeight: z.number(),
 })
 
@@ -467,7 +104,7 @@ export type PluginSpaceUpdateGeometryFromProfileArgs = z.infer<
 >
 
 /**
- * Result of {@linkcode PluginSpaceApi.updateGeometryFromProfile}.
+ * Result of `updateGeometryFromProfile`.
  *
  * | Property | Type | Description |
  * |---|---|---|
@@ -501,7 +138,6 @@ export type PluginSpaceUpdateGeometryFromProfileResult = z.infer<
  * | `"height"` | `number` | Height dimension |
  * | `"massType"` | `string \| null` | Mass type classification |
  * | `"spaceType"` | `string \| null` | Space type classification (Room, Balcony, etc.) |
- * | `"areaClass"` | {@linkcode PluginAreaClass} | Effective area classification (`"NET"`, `"GROSS"`, or `"EXCLUDED"`), resolving any per-space override then the space-type default. Never null. |
  * | `"storey"` | `number \| null` | Story the space belongs to |
  * | `"departmentId"` | `string \| null` | Assigned department ID |
  * | `"departmentName"` | `string` | Assigned department name |
@@ -510,18 +146,23 @@ export type PluginSpaceUpdateGeometryFromProfileResult = z.infer<
  * **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 |
+ * | `"position"` | {@linkcode Vec3Components} | Local position relative to parent |
+ * | `"absolutePosition"` | {@linkcode Vec3Components} | Absolute position in the scene |
+ * | `"rotation"` | {@linkcode Vec3Components} | Euler rotation angles (radians) |
+ * | `"rotationQuaternion"` | {@linkcode QuatComponents} \| `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. |
- * | `"innerProfiles"` | {@linkcode PProfile}`[]` | Bottom inner profiles (holes) in world space, preserving line/arc curve data. Empty array when the space has no holes. |
- * | `"innerPlanPoints"` | {@linkcode PVec3}`[][]` | One point loop per inner profile (hole) in world space with `y = 0` (2D plan). No closing duplicate point. Empty array when the space has no holes. |
+ * | `"planPoints"` | {@linkcode Vec3Components}`[]` | Bottom outer profile points in world space with `y = 0` (2D plan). No closing duplicate point. |
+ * | `"profile"` | {@linkcode CurveHandle}`[]` | Bottom outer profile curves in world space, as opaque curve handles. Read coordinates via the `core.geom.curve` read API. |
+ * | `"innerProfiles"` | {@linkcode CurveHandle}`[][]` | Inner (hole) profile curve loops in world space — one loop per hole, `[]` when the space has none. Each curve is an opaque handle. |
+ * | `"innerPlanPoints"` | {@linkcode Vec3Components}`[][]` | Inner (hole) profile points in world space with `y = 0` — one loop per hole, no closing duplicate, `[]` when none. |
+ *
+ * **Derived from adjacency manager:**
+ * | Value | Return Type | Description |
+ * |---|---|---|
+ * | `"adjacency"` | `{ spaceId: string; value: number }[]` | Adjacency relationships to other spaces. `value`: `2` = Direct (required), `1` = Indirect or physical contact, `-1` = Restricted; `0` (no relationship) entries are filtered out. Empty when adjacency has never been computed — see `program.adjacency.compute`. |
  */
 export const PluginSpaceGetProperty = z.enum([
   // Basic
@@ -556,7 +197,7 @@ export const PluginSpaceGetProperty = z.enum([
 ])
 
 /**
- * Arguments for {@linkcode PluginSpaceApi.get}.
+ * Arguments for `get`.
  *
  * | Property | Type | Description |
  * |---|---|---|
@@ -600,24 +241,22 @@ export const PluginSpaceType = z.enum([
   "Envelope",
   "Parking",
 ])
+/** The space-type value union (same-name type alias for positional signatures). */
+export type PluginSpaceType = z.infer<typeof PluginSpaceType>
 
 /**
- * Area classification for a space — controls which area total the space's
- * footprint contributes to.
+ * Area-class classification of a space (mirrors the internal `AreaClass` enum).
  *
  * | Value | Description |
  * |---|---|
- * | `"NET"` | Counted toward the net (carpet) area total |
- * | `"GROSS"` | Counted toward the gross (built-up) area total |
- * | `"EXCLUDED"` | Counted toward neither total |
- *
- * The classification does **not** change a space's own footprint area — it
- * only decides which project-level total that footprint is summed into.
+ * | `"NET"` | Net (usable) area |
+ * | `"GROSS"` | Gross area |
+ * | `"EXCLUDED"` | Excluded from area totals |
  */
 export const PluginAreaClass = z.enum(["NET", "GROSS", "EXCLUDED"])
 
 /**
- * Result of {@linkcode PluginSpaceApi.get}.
+ * Result of `get`.
  *
  * A partial object — only the properties that were requested in
  * {@linkcode PluginSpaceGetArgs.properties} will be present.
@@ -642,16 +281,19 @@ export const PluginSpaceGetResult = z
     departmentName: z.string(),
     departmentColor: z.string(),
     // Derived from mesh
-    position: PVec3,
-    absolutePosition: PVec3,
-    rotation: PVec3,
-    rotationQuaternion: PQuat.nullable(),
+    position: Vec3Components,
+    absolutePosition: Vec3Components,
+    rotation: Vec3Components,
+    rotationQuaternion: QuatComponents.nullable(),
     // Derived from brep
-    planPoints: z.array(PVec3),
-    profile: PProfile,
-    innerProfiles: z.array(PProfile),
-    innerPlanPoints: z.array(z.array(PVec3)),
-    // Derived from adjacency manager
+    planPoints: z.array(Vec3Components),
+    profile: z.array(CurveHandle),
+    innerProfiles: z.array(z.array(CurveHandle)),
+    innerPlanPoints: z.array(z.array(Vec3Components)),
+    // Derived from adjacency manager.
+    // value: 2 = Direct (required), 1 = Indirect or physical contact, -1 = Restricted;
+    // 0 (no relationship) entries are filtered out. Empty array when adjacency has
+    // never been computed — run program.adjacency.compute() first for fresh data.
     adjacency: z.array(z.object({
       spaceId: z.string(),
       value: z.number(),
@@ -662,7 +304,7 @@ export const PluginSpaceGetResult = z
 export type PluginSpaceGetResult = z.infer<typeof PluginSpaceGetResult>
 
 /**
- * Result of {@linkcode PluginSpaceApi.getAll}.
+ * Result of `getAll`.
  *
  * | Property | Type | Description |
  * |---|---|---|
@@ -675,7 +317,7 @@ export const PluginSpaceGetAllResult = z.object({
 export type PluginSpaceGetAllResult = z.infer<typeof PluginSpaceGetAllResult>
 
 /**
- * Arguments for {@linkcode PluginSpaceApi.delete}.
+ * Arguments for `delete`.
  *
  * | Property | Type | Description |
  * |---|---|---|
@@ -687,7 +329,7 @@ export const PluginSpaceDeleteArgs = z.object({
 
 export type PluginSpaceDeleteArgs = z.infer<typeof PluginSpaceDeleteArgs>
 
-/** Result type for {@linkcode PluginSpaceApi.delete} — returns nothing on success. */
+/** Result type for `delete` — returns nothing on success. */
 export type PluginSpaceDeleteResult = void
 
 /**
@@ -724,6 +366,8 @@ export const PluginMassType = z.enum([
   "Mass",
   "Site",
 ])
+/** The mass-type value union (same-name type alias for positional signatures). */
+export type PluginMassType = z.infer<typeof PluginMassType>
 
 /**
  * Well-known (built-in) department IDs.
@@ -750,9 +394,11 @@ export const PluginDepartmentId = z.union([
   PluginWellKnownDepartmentId,
   z.uuid(),
 ])
+/** The department-id value union (same-name type alias for positional signatures). */
+export type PluginDepartmentId = z.infer<typeof PluginDepartmentId>
 
 /**
- * Arguments for {@linkcode PluginSpaceApi.update}.
+ * Arguments for `update`.
  *
  * | Property | Type | Description |
  * |---|---|---|
@@ -760,7 +406,6 @@ export const PluginDepartmentId = z.union([
  * | `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.areaClass` | {@linkcode PluginAreaClass}`?` | New area classification. Sets an explicit per-space override (`"NET"`, `"GROSS"`, or `"EXCLUDED"`) that wins over the space-type default. |
  * | `properties.departmentId` | {@linkcode PluginDepartmentId}`?` | New department ID |
  */
 export const PluginSpaceUpdateArgs = z.object({
@@ -777,7 +422,7 @@ export const PluginSpaceUpdateArgs = z.object({
 export type PluginSpaceUpdateArgs = z.infer<typeof PluginSpaceUpdateArgs>
 
 /**
- * Result of {@linkcode PluginSpaceApi.update}.
+ * Result of `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`.
@@ -788,7 +433,6 @@ export type PluginSpaceUpdateArgs = z.infer<typeof PluginSpaceUpdateArgs>
  * | `room_type` | `string?` | Updated room type (if changed) |
  * | `massType` | `string?` | Updated mass type (if changed) |
  * | `spaceType` | `string?` | Updated space type (if changed) |
- * | `areaClass` | {@linkcode PluginAreaClass}`?` | Updated area classification (if changed) |
  * | `departmentId` | `string \| null?` | Updated department ID (if changed) |
  */
 export const PluginSpaceUpdateResult = z.object({
@@ -807,7 +451,7 @@ export type PluginSpaceUpdateResult = z.infer<typeof PluginSpaceUpdateResult>
 // ---------------------------------------------------------------------------
 
 /**
- * A single item for {@linkcode PluginSpaceApi.bulkCreate}.
+ * A single item for `bulkCreate`.
  *
  * Discriminated on `kind`:
  * - `"rectangular"` — a box defined by `position` + `dimensions` (mirrors
@@ -822,7 +466,7 @@ export type PluginSpaceUpdateResult = z.infer<typeof PluginSpaceUpdateResult>
 export const PluginSpaceBulkCreateItem = z.discriminatedUnion("kind", [
   z.object({
     kind: z.literal("rectangular"),
-    position: PVec3,
+    position: Vec3Handle,
     dimensions: z.object({
       width: z.number(),
       height: z.number(),
@@ -835,10 +479,10 @@ export const PluginSpaceBulkCreateItem = z.discriminatedUnion("kind", [
   }),
   z.object({
     kind: z.literal("profile"),
-    profile: PProfile,
-    innerProfiles: z.array(PProfile).optional(),
+    profile: ProfileHandle,
+    innerProfiles: z.array(ProfileHandle).optional(),
     extrudeHeight: z.number(),
-    position: PVec3,
+    position: Vec3Handle,
     room_type: z.string().optional(),
     spaceType: PluginSpaceType.optional(),
     massType: PluginMassType.optional(),
@@ -849,7 +493,7 @@ export const PluginSpaceBulkCreateItem = z.discriminatedUnion("kind", [
 export type PluginSpaceBulkCreateItem = z.infer<typeof PluginSpaceBulkCreateItem>
 
 /**
- * Arguments for {@linkcode PluginSpaceApi.bulkCreate}.
+ * Arguments for `bulkCreate`.
  *
  * | Property | Type | Description |
  * |---|---|---|
@@ -862,7 +506,7 @@ export const PluginSpaceBulkCreateArgs = z.object({
 export type PluginSpaceBulkCreateArgs = z.infer<typeof PluginSpaceBulkCreateArgs>
 
 /**
- * Result of {@linkcode PluginSpaceApi.bulkCreate}.
+ * Result of `bulkCreate`.
  *
  * | Property | Type | Description |
  * |---|---|---|
@@ -877,7 +521,7 @@ export type PluginSpaceBulkCreateResult = z.infer<
 >
 
 /**
- * A single item for {@linkcode PluginSpaceApi.bulkUpdate}.
+ * A single item for `bulkUpdate`.
  *
  * Targets an existing space by `spaceId`. Geometry fields `profile` and
  * `extrudeHeight` must be supplied **together** (mirrors
@@ -887,13 +531,13 @@ export type PluginSpaceBulkCreateResult = z.infer<
  * | Property | Type | Description |
  * |---|---|---|
  * | `spaceId` | `string` | The space to update |
- * | `profile` | {@linkcode PProfile}`?` | New floor shape (requires `extrudeHeight`) |
+ * | `profile` | {@linkcode ProfileHandle}`?` | New floor shape handle (requires `extrudeHeight`) |
  * | `extrudeHeight` | `number?` | New extrusion height (requires `profile`) |
  * | `properties` | `object?` | Property changes (same shape as {@linkcode PluginSpaceUpdateArgs.properties}) |
  */
 export const PluginSpaceBulkUpdateItem = z.object({
   spaceId: z.string(),
-  profile: PProfile.optional(),
+  profile: ProfileHandle.optional(),
   extrudeHeight: z.number().optional(),
   properties: z
     .object({
@@ -909,7 +553,7 @@ export const PluginSpaceBulkUpdateItem = z.object({
 export type PluginSpaceBulkUpdateItem = z.infer<typeof PluginSpaceBulkUpdateItem>
 
 /**
- * Arguments for {@linkcode PluginSpaceApi.bulkUpdate}.
+ * Arguments for `bulkUpdate`.
  *
  * | Property | Type | Description |
  * |---|---|---|
@@ -922,10 +566,10 @@ export const PluginSpaceBulkUpdateArgs = z.object({
 export type PluginSpaceBulkUpdateArgs = z.infer<typeof PluginSpaceBulkUpdateArgs>
 
 /**
- * Result of {@linkcode PluginSpaceApi.bulkUpdate}.
+ * Result of `bulkUpdate`.
  *
  * Echoes one {@linkcode PluginSpaceUpdateResult} per item, in input order —
- * the same per-space shape returned by {@linkcode PluginSpaceApi.update}.
+ * the same per-space shape returned by `update`.
  *
  * | Property | Type | Description |
  * |---|---|---|
@@ -940,7 +584,7 @@ export type PluginSpaceBulkUpdateResult = z.infer<
 >
 
 /**
- * Arguments for {@linkcode PluginSpaceApi.bulkDelete}.
+ * Arguments for `bulkDelete`.
  *
  * | Property | Type | Description |
  * |---|---|---|
@@ -953,7 +597,7 @@ export const PluginSpaceBulkDeleteArgs = z.object({
 export type PluginSpaceBulkDeleteArgs = z.infer<typeof PluginSpaceBulkDeleteArgs>
 
 /**
- * Result of {@linkcode PluginSpaceApi.bulkDelete}.
+ * Result of `bulkDelete`.
  *
  * | Property | Type | Description |
  * |---|---|---|