@snaptrude/plugin-core 0.0.0-dev-20260708130115

package/src/api/entity/space.ts

@@ -0,0 +1,612 @@
+// 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 {
+  ProfileHandle,
+  Vec3Handle,
+  Vec3Components,
+  QuatComponents,
+  CurveHandle,
+} from "../../handles"
+
+
+/**
+ * Arguments for `createRectangular`.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `position` | {@linkcode Vec3Handle} | Origin position in Babylon units |
+ * | `dimensions` | `{ width, height, depth }` | Box dimensions in Babylon units |
+ */
+export const PluginSpaceCreateRectangularArgs = z.object({
+  position: Vec3Handle,
+  dimensions: z.object({
+    width: z.number(),
+    height: z.number(),
+    depth: z.number(),
+  }),
+})
+
+export type PluginSpaceCreateRectangularArgs = z.infer<
+  typeof PluginSpaceCreateRectangularArgs
+>
+
+/**
+ * Result of `createRectangular`.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceId` | `string` | Unique ID of the created space |
+ */
+export const PluginSpaceCreateRectangularResult = z.object({
+  spaceId: z.string(),
+})
+
+export type PluginSpaceCreateRectangularResult = z.infer<
+  typeof PluginSpaceCreateRectangularResult
+>
+
+/**
+ * Arguments for `createFromProfile`.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `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 Vec3Handle} | Offset position in Babylon units |
+ */
+export const PluginSpaceCreateFromProfileArgs = z.object({
+  profile: ProfileHandle,
+  innerProfiles: z.array(ProfileHandle).optional(),
+  extrudeHeight: z.number(),
+  position: Vec3Handle,
+})
+
+export type PluginSpaceCreateFromProfileArgs = z.infer<
+  typeof PluginSpaceCreateFromProfileArgs
+>
+
+/**
+ * Result of `createFromProfile`.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceId` | `string` | Unique ID of the created space |
+ */
+export const PluginSpaceCreateFromProfileResult = z.object({
+  spaceId: z.string(),
+})
+
+export type PluginSpaceCreateFromProfileResult = z.infer<
+  typeof PluginSpaceCreateFromProfileResult
+>
+
+/**
+ * Arguments for `updateGeometryFromProfile`.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceId` | `string` | Space to update |
+ * | `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: ProfileHandle,
+  extrudeHeight: z.number(),
+})
+
+export type PluginSpaceUpdateGeometryFromProfileArgs = z.infer<
+  typeof PluginSpaceUpdateGeometryFromProfileArgs
+>
+
+/**
+ * Result of `updateGeometryFromProfile`.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceId` | `string` | Unique ID of the updated space |
+ */
+export const PluginSpaceUpdateGeometryFromProfileResult = z.object({
+  spaceId: z.string(),
+})
+
+export type PluginSpaceUpdateGeometryFromProfileResult = z.infer<
+  typeof PluginSpaceUpdateGeometryFromProfileResult
+>
+
+/**
+ * Available properties that can be queried on a space.
+ *
+ * **Basic:**
+ * | Value | Return Type | Description |
+ * |---|---|---|
+ * | `"id"` | `string` | Unique space identifier |
+ * | `"type"` | `string` | Component type |
+ * | `"room_type"` | `string` | Room type classification |
+ * | `"name"` | `string` | Display name of the space |
+ *
+ * **Derived from parametric data:**
+ * | Value | Return Type | Description |
+ * |---|---|---|
+ * | `"area"` | `number` | Bottom face area (from `areas_bottomFace`) |
+ * | `"breadth"` | `number` | Breadth dimension |
+ * | `"depth"` | `number` | Depth dimension |
+ * | `"height"` | `number` | Height dimension |
+ * | `"massType"` | `string \| null` | Mass type classification |
+ * | `"spaceType"` | `string \| null` | Space type classification (Room, Balcony, etc.) |
+ * | `"storey"` | `number \| null` | Story the space belongs to |
+ * | `"departmentId"` | `string \| null` | Assigned department ID |
+ * | `"departmentName"` | `string` | Assigned department name |
+ * | `"departmentColor"` | `string` | Assigned department color (hex/CSS) |
+ *
+ * **Derived from mesh:**
+ * | Value | Return Type | Description |
+ * |---|---|---|
+ * | `"position"` | {@linkcode 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 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
+  "id",
+  "type",
+  "room_type",
+  "name",
+  // Derived from parametric data
+  "area",
+  "breadth",
+  "depth",
+  "height",
+  "massType",
+  "spaceType",
+  "areaClass",
+  "storey",
+  "departmentId",
+  "departmentName",
+  "departmentColor",
+  // Derived from mesh
+  "position",
+  "absolutePosition",
+  "rotation",
+  "rotationQuaternion",
+  // Derived from brep
+  "planPoints",
+  "profile",
+  "innerProfiles",
+  "innerPlanPoints",
+  // Derived from adjacency manager
+  "adjacency",
+])
+
+/**
+ * Arguments for `get`.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceId` | `string` | The space ID to query |
+ * | `properties` | {@linkcode PluginSpaceGetProperty}`[]` | Properties to retrieve |
+ */
+export const PluginSpaceGetArgs = z.object({
+  spaceId: z.string(),
+  properties: z.array(PluginSpaceGetProperty),
+})
+
+export type PluginSpaceGetArgs = z.infer<typeof PluginSpaceGetArgs>
+
+/**
+ * Supported space type values.
+ *
+ * Mirrors the internal `SpaceType` enum from `spaceType.types.ts`.
+ *
+ * | Value | Description |
+ * |---|---|
+ * | `"Room"` | Standard room |
+ * | `"Program Block"` | Program/department block |
+ * | `"Balcony"` | Balcony space |
+ * | `"Road"` | Road |
+ * | `"Garden"` | Garden area |
+ * | `"Deck"` | Deck |
+ * | `"Pool"` | Pool |
+ * | `"Walkway"` | Walkway |
+ * | `"Envelope"` | Envelope |
+ * | `"Parking"` | Parking area |
+ */
+export const PluginSpaceType = z.enum([
+  "Room",
+  "Program Block",
+  "Balcony",
+  "Road",
+  "Garden",
+  "Deck",
+  "Pool",
+  "Walkway",
+  "Envelope",
+  "Parking",
+])
+/** The space-type value union (same-name type alias for positional signatures). */
+export type PluginSpaceType = z.infer<typeof PluginSpaceType>
+
+/**
+ * Area-class classification of a space (mirrors the internal `AreaClass` enum).
+ *
+ * | Value | Description |
+ * |---|---|
+ * | `"NET"` | Net (usable) area |
+ * | `"GROSS"` | Gross area |
+ * | `"EXCLUDED"` | Excluded from area totals |
+ */
+export const PluginAreaClass = z.enum(["NET", "GROSS", "EXCLUDED"])
+
+/**
+ * Result of `get`.
+ *
+ * A partial object — only the properties that were requested in
+ * {@linkcode PluginSpaceGetArgs.properties} will be present.
+ */
+export const PluginSpaceGetResult = z
+  .object({
+    // Basic
+    id: z.string(),
+    type: z.string(),
+    room_type: z.string(),
+    name: z.string(),
+    // Derived from parametric data
+    area: z.number(),
+    breadth: z.number(),
+    depth: z.number(),
+    height: z.number(),
+    massType: z.string().nullable(),
+    spaceType: PluginSpaceType.nullable(),
+    areaClass: PluginAreaClass,
+    storey: z.number().nullable(),
+    departmentId: z.string().nullable(),
+    departmentName: z.string(),
+    departmentColor: z.string(),
+    // Derived from mesh
+    position: Vec3Components,
+    absolutePosition: Vec3Components,
+    rotation: Vec3Components,
+    rotationQuaternion: QuatComponents.nullable(),
+    // Derived from brep
+    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(),
+    })),
+  })
+  .partial()
+
+export type PluginSpaceGetResult = z.infer<typeof PluginSpaceGetResult>
+
+/**
+ * Result of `getAll`.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spacesIds` | `string[]` | IDs of all spaces in the project |
+ */
+export const PluginSpaceGetAllResult = z.object({
+  spacesIds: z.array(z.string()),
+})
+
+export type PluginSpaceGetAllResult = z.infer<typeof PluginSpaceGetAllResult>
+
+/**
+ * Arguments for `delete`.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceId` | `string` | The space ID to delete |
+ */
+export const PluginSpaceDeleteArgs = z.object({
+  spaceId: z.string(),
+})
+
+export type PluginSpaceDeleteArgs = z.infer<typeof PluginSpaceDeleteArgs>
+
+/** Result type for `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 const PluginMassType = z.enum([
+  "Plinth",
+  "Void",
+  "Pergola",
+  "Furniture",
+  "Facade element",
+  "Generic mass",
+  "Room",
+  "Department",
+  "Building",
+  "Revit Import",
+  "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.
+ *
+ * | Value | Department |
+ * |---|---|
+ * | `"DEFAULT"` | Default department |
+ * | `"SITE"` | Site department |
+ * | `"ENVELOPE"` | Envelope department |
+ * | `"CORE"` | Core department |
+ */
+export const PluginWellKnownDepartmentId = z.enum([
+  "DEFAULT",
+  "SITE",
+  "ENVELOPE",
+  "CORE",
+])
+
+/**
+ * Accepted department ID values — either a {@linkcode PluginWellKnownDepartmentId}
+ * or a UUID string for custom (user-created) departments.
+ */
+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 `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 const PluginSpaceUpdateArgs = z.object({
+  spaceId: z.string(),
+  properties: z.object({
+    room_type: z.string().optional(),
+    massType: PluginMassType.optional(),
+    spaceType: PluginSpaceType.optional(),
+    areaClass: PluginAreaClass.optional(),
+    departmentId: PluginDepartmentId.optional(),
+  }),
+})
+
+export type PluginSpaceUpdateArgs = z.infer<typeof PluginSpaceUpdateArgs>
+
+/**
+ * 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`.
+ *
+ * | 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 const PluginSpaceUpdateResult = z.object({
+  spaceId: z.string(),
+  room_type: z.string().optional(),
+  massType: z.string().optional(),
+  spaceType: z.string().optional(),
+  areaClass: PluginAreaClass.optional(),
+  departmentId: z.string().nullable().optional(),
+})
+
+export type PluginSpaceUpdateResult = z.infer<typeof PluginSpaceUpdateResult>
+
+// ---------------------------------------------------------------------------
+// Bulk operations
+// ---------------------------------------------------------------------------
+
+/**
+ * A single item for `bulkCreate`.
+ *
+ * Discriminated on `kind`:
+ * - `"rectangular"` — a box defined by `position` + `dimensions` (mirrors
+ *   {@linkcode PluginSpaceCreateRectangularArgs})
+ * - `"profile"` — an extruded `profile` (with optional `innerProfiles`) by
+ *   `extrudeHeight` at `position` (mirrors {@linkcode PluginSpaceCreateFromProfileArgs})
+ *
+ * Every item may optionally set `room_type`, `spaceType`, `massType`, and
+ * `departmentId`; these are applied within the same single undo step as the
+ * creation.
+ */
+export const PluginSpaceBulkCreateItem = z.discriminatedUnion("kind", [
+  z.object({
+    kind: z.literal("rectangular"),
+    position: Vec3Handle,
+    dimensions: z.object({
+      width: z.number(),
+      height: z.number(),
+      depth: z.number(),
+    }),
+    room_type: z.string().optional(),
+    spaceType: PluginSpaceType.optional(),
+    massType: PluginMassType.optional(),
+    departmentId: PluginDepartmentId.optional(),
+  }),
+  z.object({
+    kind: z.literal("profile"),
+    profile: ProfileHandle,
+    innerProfiles: z.array(ProfileHandle).optional(),
+    extrudeHeight: z.number(),
+    position: Vec3Handle,
+    room_type: z.string().optional(),
+    spaceType: PluginSpaceType.optional(),
+    massType: PluginMassType.optional(),
+    departmentId: PluginDepartmentId.optional(),
+  }),
+])
+
+export type PluginSpaceBulkCreateItem = z.infer<typeof PluginSpaceBulkCreateItem>
+
+/**
+ * Arguments for `bulkCreate`.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `items` | {@linkcode PluginSpaceBulkCreateItem}`[]` | Spaces to create |
+ */
+export const PluginSpaceBulkCreateArgs = z.object({
+  items: z.array(PluginSpaceBulkCreateItem),
+})
+
+export type PluginSpaceBulkCreateArgs = z.infer<typeof PluginSpaceBulkCreateArgs>
+
+/**
+ * Result of `bulkCreate`.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceIds` | `string[]` | IDs of the created spaces, in input order |
+ */
+export const PluginSpaceBulkCreateResult = z.object({
+  spaceIds: z.array(z.string()),
+})
+
+export type PluginSpaceBulkCreateResult = z.infer<
+  typeof PluginSpaceBulkCreateResult
+>
+
+/**
+ * A single item for `bulkUpdate`.
+ *
+ * Targets an existing space by `spaceId`. Geometry fields `profile` and
+ * `extrudeHeight` must be supplied **together** (mirrors
+ * {@linkcode PluginSpaceUpdateGeometryFromProfileArgs}). Property changes are
+ * nested under `properties`, mirroring {@linkcode PluginSpaceUpdateArgs}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceId` | `string` | The space to update |
+ * | `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: ProfileHandle.optional(),
+  extrudeHeight: z.number().optional(),
+  properties: z
+    .object({
+      room_type: z.string().optional(),
+      massType: PluginMassType.optional(),
+      spaceType: PluginSpaceType.optional(),
+      areaClass: PluginAreaClass.optional(),
+      departmentId: PluginDepartmentId.optional(),
+    })
+    .optional(),
+})
+
+export type PluginSpaceBulkUpdateItem = z.infer<typeof PluginSpaceBulkUpdateItem>
+
+/**
+ * Arguments for `bulkUpdate`.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `items` | {@linkcode PluginSpaceBulkUpdateItem}`[]` | Spaces to update |
+ */
+export const PluginSpaceBulkUpdateArgs = z.object({
+  items: z.array(PluginSpaceBulkUpdateItem),
+})
+
+export type PluginSpaceBulkUpdateArgs = z.infer<typeof PluginSpaceBulkUpdateArgs>
+
+/**
+ * Result of `bulkUpdate`.
+ *
+ * Echoes one {@linkcode PluginSpaceUpdateResult} per item, in input order —
+ * the same per-space shape returned by `update`.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaces` | {@linkcode PluginSpaceUpdateResult}`[]` | Per-item updated values, in input order |
+ */
+export const PluginSpaceBulkUpdateResult = z.object({
+  spaces: z.array(PluginSpaceUpdateResult),
+})
+
+export type PluginSpaceBulkUpdateResult = z.infer<
+  typeof PluginSpaceBulkUpdateResult
+>
+
+/**
+ * Arguments for `bulkDelete`.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `spaceIds` | `string[]` | The space IDs to delete |
+ */
+export const PluginSpaceBulkDeleteArgs = z.object({
+  spaceIds: z.array(z.string()),
+})
+
+export type PluginSpaceBulkDeleteArgs = z.infer<typeof PluginSpaceBulkDeleteArgs>
+
+/**
+ * Result of `bulkDelete`.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `deletedSpaceIds` | `string[]` | The space IDs that were removed |
+ */
+export const PluginSpaceBulkDeleteResult = z.object({
+  deletedSpaceIds: z.array(z.string()),
+})
+
+export type PluginSpaceBulkDeleteResult = z.infer<
+  typeof PluginSpaceBulkDeleteResult
+>