@snaptrude/plugin-core 0.8.0 → 0.9.0

package/src/api/core/storeys/index.ts

@@ -0,0 +1,279 @@
+import * as z from "zod"
+import { PluginApiReturn } from "../../../types"
+import { ComponentHandle } from "../../../handles"
+import {
+  PluginStoryGetProperty,
+  PluginStoryGetResult,
+  PluginStoryGetAllResult,
+  PluginStoryCreateResult,
+  PluginStoryUpdateResult,
+  PluginStorySetActiveResult,
+  PluginStoryDeleteResult,
+  PluginStoryDuplicateResult,
+} from "../../entity/story"
+
+/**
+ * Storey (floor) management.
+ *
+ * A storey represents a building floor in the Snaptrude project. Storeys are
+ * identified by their integer **storey value** (e.g. `1` for the ground floor,
+ * `2` for the first floor, `-1` for a basement).
+ *
+ * This is the canonical home for storey operations; it shares its implementation
+ * and schemas with the deprecated `entity.story` surface. All methods are **host
+ * API calls** that return Promises and support undo/redo via Snaptrude's command
+ * system (except {@linkcode PluginCoreStoreysApi.setActive}, a view change).
+ *
+ * Accessed via `snaptrude.core.storeys`.
+ */
+export abstract class PluginCoreStoreysApi {
+  constructor() {}
+
+  /**
+   * Get properties of a storey by its storey number.
+   *
+   * Only the properties listed in `properties` are returned — unlisted
+   * properties will be `undefined` in the result.
+   *
+   * @param storyValue - Integer storey number
+   *   (e.g. `1` for ground floor, `2` for first floor, `-1` for basement)
+   * @param properties - Array of property names to retrieve. See
+   *   {@linkcode PluginStoryGetProperty} for available values.
+   * @returns A partial {@linkcode PluginStoryGetResult} containing only the requested properties
+   * @throws If the storey with the given value does not exist
+   *
+   * @examplePrompt What is the height of the ground floor?
+   * @examplePrompt How many rooms are on the second storey?
+   * @examplePrompt Get the total floor area of level 3
+   * @examplePrompt Is the first floor hidden in the viewport?
+   * @examplePrompt Show me the name and height of storey 2
+   *
+   * # Example
+   * ```ts
+   * const info = await snaptrude.core.storeys.get(1, ["height", "name", "spacesCount"])
+   * console.log(info.name, info.height, info.spacesCount)
+   * ```
+   */
+  public abstract get(
+    storyValue: number,
+    properties: PluginStoryGetProperty[],
+  ): PluginApiReturn<PluginStoryGetResult>
+
+  /**
+   * List all storeys in the current project.
+   *
+   * Returns basic identification data for every storey. Storeys are sorted
+   * from **top to bottom** (highest storey value first).
+   *
+   * @returns A {@linkcode PluginCoreStoreysListResult} with a `storeys` array,
+   *   each entry containing `value`, `id`, and `name`
+   *
+   * @examplePrompt How many floors does this building have?
+   * @examplePrompt List all the storeys in the project
+   * @examplePrompt Show me every level with its name
+   * @examplePrompt Which storeys exist in this model?
+   *
+   * # Example
+   * ```ts
+   * const { storeys } = await snaptrude.core.storeys.list()
+   * for (const s of storeys) {
+   *   console.log(`Storey ${s.value}: ${s.name} (id: ${s.id})`)
+   * }
+   * ```
+   */
+  public abstract list(): PluginApiReturn<PluginCoreStoreysListResult>
+
+  /**
+   * Create a new storey (floor) in the project.
+   *
+   * The new storey is inserted at the position specified by `storyValue`. This
+   * operation is undoable.
+   *
+   * @param storyValue - Integer storey number
+   *   to create (e.g. `3` to add a third floor)
+   * @param height - Optional height in Babylon
+   *   units. If omitted, the project's default storey height is used.
+   * @returns A {@linkcode PluginStoryCreateResult} with `storyId` and `storyValue`
+   * @throws If a storey with the given value already exists or creation fails
+   *
+   * @examplePrompt Add a third floor to the building
+   * @examplePrompt Create a new storey above the second floor
+   * @examplePrompt Add a basement level to this project
+   * @examplePrompt Insert a new level with a custom floor height
+   *
+   * # Example
+   * ```ts
+   * // Create a new third floor with custom height
+   * const { storyId } = await snaptrude.core.storeys.create(3, 4.5)
+   * ```
+   */
+  public abstract create(
+    storyValue: number,
+    height?: number,
+  ): PluginApiReturn<PluginStoryCreateResult>
+
+  /**
+   * Update a storey's floor-to-floor `height` and/or `name`.
+   *
+   * **Height** is the same operation as editing the height in the Storeys panel:
+   * the walls, columns, and masses on the storey are **stretched** to the new
+   * height, every storey **above shifts up/down** by the delta so the stack stays
+   * contiguous, and coupled elements (staircases, parametric curtain walls,
+   * furniture offsets) are re-fitted. The whole height cascade is committed as
+   * **one undo step**. Height-locked elements are left untouched.
+   *
+   * **Name** is the same as renaming the storey in the Storeys panel: it is
+   * persisted immediately but, mirroring the panel, is **not** part of the height
+   * undo step.
+   *
+   * At least one of `height` or `options.name` must be supplied. Omitting the
+   * `height` argument (e.g. for a rename-only update) leaves the height untouched.
+   *
+   * @param storyValue - Integer storey number identifying the storey to update
+   * @param height - New floor-to-floor height in
+   *   Babylon units. Omit to leave the height unchanged.
+   * @param options - `name` (new display name for the storey)
+   * @returns A {@linkcode PluginStoryUpdateResult} with the storey's
+   *   `storyValue`, `height`, and `name` after the update
+   * @throws `PRECONDITION_FAILED` if no storey has the given value;
+   *   `VALIDATION` if neither `height` nor `options.name` is supplied;
+   *   `STORY_HEIGHT_REJECTED` if the engine rejects the height;
+   *   `STORY_UPDATE_FAILED` if the storey cannot be re-read after the update
+   *
+   * @examplePrompt Change the ground floor height to 3.5 metres
+   * @examplePrompt Make the second storey taller
+   * @examplePrompt Rename the ground floor to "Lobby"
+   * @examplePrompt Set the floor-to-floor height of level 1
+   *
+   * # Example
+   * ```ts
+   * // Set ground floor height to 5 Babylon units — walls stretch and the
+   * // floors above move up to match, all in a single undo step.
+   * const result = await snaptrude.core.storeys.update(1, 5)
+   * // Rename only, leaving the height untouched.
+   * await snaptrude.core.storeys.update(1, undefined, { name: "Lobby" })
+   * ```
+   */
+  public abstract update(
+    storyValue: number,
+    height?: number,
+    options?: { name?: string },
+  ): PluginApiReturn<PluginStoryUpdateResult>
+
+  /**
+   * Make a storey the active storey — the same as clicking it in the storey/layer
+   * panel. Subsequent draws and creates target this storey, and in 2D the
+   * viewport switches to it. This is a view/navigation change: it is **not**
+   * undoable and commits nothing to the model.
+   *
+   * @param storyValue - Integer storey number to activate
+   * @returns A {@linkcode PluginStorySetActiveResult} echoing the now-active `storyValue`
+   * @throws `PRECONDITION_FAILED` if no storey has the given value
+   *
+   * @examplePrompt Switch to the second floor
+   * @examplePrompt Make the ground storey active
+   * @examplePrompt Go to the basement level
+   * @examplePrompt Set level 3 as the current storey
+   *
+   * # Example
+   * ```ts
+   * // Activate storey 2, then draw a wall — it lands on storey 2.
+   * await snaptrude.core.storeys.setActive(2)
+   * ```
+   */
+  public abstract setActive(
+    storyValue: number,
+  ): PluginApiReturn<PluginStorySetActiveResult>
+
+  /**
+   * Delete a storey and everything on it — the same as removing it from the
+   * storey panel. Every element placed on the storey (walls, floors, masses, …)
+   * is deleted with it, the remaining storeys are re-stacked, and the active
+   * storey falls back to an adjacent one. Committed as a single undo step.
+   *
+   * @param storyValue - Integer storey number to delete
+   * @returns A {@linkcode PluginStoryDeleteResult} with the deleted `storyValue`
+   *   and the `newActiveStory` the editor fell back to
+   * @throws `PRECONDITION_FAILED` if no storey has the given value; or if plugin
+   *   writes are disabled
+   *
+   * @examplePrompt Delete the top floor
+   * @examplePrompt Remove the basement level
+   * @examplePrompt Get rid of storey 3
+   * @examplePrompt Delete the second floor and everything on it
+   *
+   * # Example
+   * ```ts
+   * const { newActiveStory } = await snaptrude.core.storeys.delete(3)
+   * console.log(`Deleted storey 3; now on storey ${newActiveStory}`)
+   * ```
+   */
+  public abstract delete(
+    storyValue: number,
+  ): PluginApiReturn<PluginStoryDeleteResult>
+
+  /**
+   * Copy a storey into the adjacent level, up or down.
+   *
+   * By default the **whole storey** is copied: every eligible element on the
+   * active storey (walls, floors, roofs, masses, columns, beams, staircases,
+   * ceilings, parametric curtain walls, and furniture) is copied into the storey
+   * one level `"up"` or `"down"`. Pass `options.components` to copy only a subset
+   * instead. The target storey is **created automatically** if it does not yet
+   * exist, inheriting the source storey's height.
+   *
+   * Copies are **instanced** by default (`unique: false`) — they share geometry
+   * with the source, so later edits propagate. Set `unique: true` for independent
+   * geometry. Doors and windows are never copied on their own; they ride along
+   * with their host wall. Locked, throw-away, and unsupported elements are skipped
+   * and counted in `skipped`. The whole operation is a single undo step.
+   *
+   * @param direction - `"up"` to copy into the storey above, `"down"` for below
+   * @param options - `components` (restrict to a subset of the storey's elements;
+   *   omit for the whole storey) and `unique` (default `false` = instanced copies;
+   *   `true` = independent geometry)
+   * @returns A {@linkcode PluginStoryDuplicateResult} with the `sourceStory`, the
+   *   `targetStories` the copies landed on, the `created` component handles, the
+   *   `createdStoryValues` for any storeys generated to receive them, and the
+   *   `skipped` count of ineligible elements
+   * @throws `NO_ACTIVE_STRUCTURE` if there is no active structure to copy into;
+   *   `NO_ELIGIBLE_ELEMENTS` if nothing on the source storey (or in
+   *   `options.components`) is copyable; `HANDLE_INVALID` for a stale or foreign
+   *   supplied handle; or if plugin writes are disabled
+   *
+   * @examplePrompt Copy this floor to the storey above
+   * @examplePrompt Copy the ground floor down into a new basement
+   * @examplePrompt Repeat this level upwards with its own independent geometry
+   * @examplePrompt Copy just the selected walls onto the next floor up
+   *
+   * # Example
+   * ```ts
+   * // Copy the whole active storey one level up (instanced copies).
+   * const { targetStories, created, skipped } =
+   *   await snaptrude.core.storeys.copy("up")
+   * console.log(`Copied ${created.length} elements onto storey ${targetStories}`)
+   * if (skipped) console.log(`${skipped} elements were skipped`)
+   * ```
+   */
+  public abstract copy(
+    direction: "up" | "down",
+    options?: { components?: ComponentHandle[]; unique?: boolean },
+  ): PluginApiReturn<PluginStoryDuplicateResult>
+}
+
+/**
+ * Result of {@linkcode PluginCoreStoreysApi.list} — the {@linkcode PluginStoryGetAllResult}
+ * shape with the array field renamed `stories` → `storeys`. Each entry shares the
+ * same element type: `{ value, id, name }`, sorted top to bottom.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `storeys` | `Array<{ value, id, name }>` | All storeys, sorted top to bottom |
+ */
+export const PluginCoreStoreysListResult = z.object({
+  storeys: PluginStoryGetAllResult.shape.stories,
+})
+
+export type PluginCoreStoreysListResult = z.infer<
+  typeof PluginCoreStoreysListResult
+>

package/src/api/core/tags.ts

@@ -131,11 +131,38 @@ export abstract class PluginCoreTagsApi {
    * const { tags } = await snaptrude.core.tags.getTagsForComponent("cmp_42")
    * for (const t of tags) console.log(t.categoryName, t.tagName)
    * ```
+   *
+   * @deprecated Use `core.tags.listForComponent`
    */
   public abstract getTagsForComponent(
     componentId: ComponentHandle,
   ): PluginApiReturn<PluginCoreTagsGetTagsForComponentResult>
 
+  /**
+   * List the tags carried by a component.
+   *
+   * Returns one entry per category the component is tagged in, each carrying the
+   * category and tag names and the tag color. Canonical home of the read formerly
+   * at `getTagsForComponent` (now deprecated).
+   *
+   * @param componentId - The `Component.id` to read.
+   * @returns A {@linkcode PluginCoreTagsGetTagsForComponentResult} with a `tags`
+   *   array (empty when the component has none or does not exist).
+   *
+   * @examplePrompt What tags does this space have?
+   * @examplePrompt List the tags on component cmp_42
+   * @examplePrompt Show the labels applied to this room
+   *
+   * # Example
+   * ```ts
+   * const { tags } = await snaptrude.core.tags.listForComponent("cmp_42")
+   * for (const t of tags) console.log(t.categoryName, t.tagName)
+   * ```
+   */
+  public abstract listForComponent(
+    componentId: ComponentHandle,
+  ): PluginApiReturn<PluginCoreTagsGetTagsForComponentResult>
+
   /**
    * List the components carrying a given tag or category.
    *

package/src/api/core/zoom/index.ts

@@ -24,6 +24,8 @@ export abstract class PluginZoomApi {
    * ```ts
    * await snaptrude.core.zoom.extents()
    * ```
+   *
+   * @deprecated Use `core.camera.zoomExtents`
    */
   public abstract extents(): PluginApiReturn<boolean>
 
@@ -42,6 +44,8 @@ export abstract class PluginZoomApi {
    * ```ts
    * await snaptrude.core.zoom.selection()
    * ```
+   *
+   * @deprecated Use `core.camera.zoomSelection`
    */
   public abstract selection(): PluginApiReturn<boolean>
 }

package/src/api/design/create/index.ts

@@ -1,6 +1,7 @@
 import * as z from "zod"
 import { PluginApiReturn } from "../../../types"
 import {
+  BrepHandle,
   ComponentHandle,
   ContourHandle,
   ProfileHandle,
@@ -11,6 +12,12 @@ import {
   PluginMassType,
   PluginDepartmentId,
 } from "../../entity/space"
+import {
+  PluginBuildableEnvelopePolygonVertex,
+  PluginBuildableEnvelopeSetbackTier,
+  PluginBuildableEnvelopeVerticalCap,
+  PluginBuildableEnvelopeCreateResult,
+} from "../../entity/buildableEnvelope"
 
 /**
  * `design.create.*` — author new scene-committed BIM entities.
@@ -52,7 +59,7 @@ export abstract class PluginDesignCreateApi {
    * @param departmentId - Department assignment (default department)
    * @param storey - Target storey number to place the space on — the same integer
    *   `entity.story` uses (`1` ground, `2` first floor, `-1` basement). Default:
-   *   the active storey. Folds an `entity.story.setActive` call into the create,
+   *   the active storey. Folds a `core.storeys.setActive` call into the create,
    *   placing the space at that storey's floor elevation (any `position` offset is
    *   applied on top). Throws if no storey has that value.
    * @returns the {@linkcode ComponentHandle} of the created space
@@ -66,6 +73,10 @@ export abstract class PluginDesignCreateApi {
    * @examplePrompt Can you create a Kitchen space from the sketch I just drew?
    * @examplePrompt Create a bedroom on the second floor from this outline
    *
+   * @performance For MORE THAN ONE space, call `design.create.spaces(items[])` — the whole
+   *   batch is one host round-trip. Looping this single-space creator is N round-trips (slow,
+   *   and a large loop can trip the plugin rate limit).
+   *
    * # Example
    * ```ts
    * const v = snaptrude.core.math.vec3
@@ -126,6 +137,51 @@ export abstract class PluginDesignCreateApi {
     massType?: PluginMassType,
   ): PluginApiReturn<ComponentHandle>
 
+  /**
+   * Create a **mass** from a custom solid built with a `core.geom.create` brep
+   * constructor (`brepFromFaces`, `brepFromExtrusion`, `brepFromLoft`,
+   * `brepFromMesh`, or a brep boolean) — the free-form counterpart of
+   * {@linkcode PluginDesignCreateApi.mass}, for solids that are not simple
+   * footprint extrusions (pyramids, wedges, faceted volumes).
+   *
+   * Only accepts breps **minted by a `core.geom.create` brep constructor** —
+   * scene-derived breps from `design.query.geometry.getBrep` are read-only and
+   * throw. The mass is created as a generic mass (`massType` "Generic mass") at
+   * the exact coordinates the solid was authored in, committed as a single
+   * undo step, and synced to collaborators like any other creator.
+   *
+   * @param brep - A solid from a `core.geom.create` brep constructor
+   * @param label - Label (maps to `room_type`)
+   * @returns the {@linkcode ComponentHandle} of the created mass
+   * @throws if the brep handle is invalid, or the brep was not created by a
+   *   `core.geom.create` brep constructor
+   *
+   * @examplePrompt Create a mass from these faces
+   * @examplePrompt Turn this custom brep into a scene mass
+   * @examplePrompt Add a pyramid-shaped mass to the model
+   *
+   * # Example
+   * ```ts
+   * const apex = { x: 0, y: 4, z: 0 }
+   * const a = { x: -2, y: 0, z: -2 }
+   * const b = { x: 2, y: 0, z: -2 }
+   * const c = { x: 2, y: 0, z: 2 }
+   * const d = { x: -2, y: 0, z: 2 }
+   * const brep = await snaptrude.core.geom.create.brepFromFaces([
+   *   [a, d, c, b],
+   *   [a, b, apex],
+   *   [b, c, apex],
+   *   [c, d, apex],
+   *   [d, a, apex],
+   * ])
+   * const pyramid = await snaptrude.design.create.massFromBrep(brep, "Pavilion")
+   * ```
+   */
+  public abstract massFromBrep(
+    brep: BrepHandle,
+    label?: string,
+  ): PluginApiReturn<ComponentHandle>
+
   /**
    * Create a **slab** by extruding a footprint contour by `thickness`
    * (default direction: down).
@@ -685,6 +741,11 @@ export abstract class PluginDesignCreateApi {
    * @examplePrompt Array these walls with a 3m offset
    * @examplePrompt Clone the desk as a unique copy, not an instance
    *
+   * @performance To place N repeats of the same geometry, bulk-create the seed(s) once then
+   *   call this ONCE with `{ count: N - 1 }` — one host round-trip for all copies. Never
+   *   reproduce geometry by looping `design.create.*` N times. Copy only after the create
+   *   that mints the seed ids.
+   *
    * # Example
    * ```ts
    * const { vec3 } = snaptrude.core.math
@@ -717,6 +778,10 @@ export abstract class PluginDesignCreateApi {
    * @examplePrompt Add three rooms with different heights in a single undo step
    * @examplePrompt Create one room on the ground floor and one on the first floor
    *
+   * @performance Bulk creator — the whole batch is ONE host round-trip. Always prefer this
+   *   over calling `design.create.space` in a loop: build the full `items[]` array first
+   *   (all per-item math and geometry up front), then make one call.
+   *
    * # Example
    * ```ts
    * const rect = await snaptrude.core.geom.create.profileRect(4, 3)
@@ -730,6 +795,58 @@ export abstract class PluginDesignCreateApi {
   public abstract spaces(
     items: PluginCreateSpaceItem[],
   ): PluginApiReturn<ComponentHandle[]>
+
+  /**
+   * Create a new parametric buildable envelope — the zoning-regulated volume a
+   * building may occupy — generated from a site polygon, tiered setbacks, a
+   * height or floor-count cap, and optional FAR and lot-coverage limits. The host
+   * mints the envelope id and returns it. Canonical home of the create formerly
+   * at `entity.buildableEnvelope.create` (now deprecated).
+   *
+   * @param sitePolygon - Site polygon vertices in `lengthUnit`; minimum 3 vertices.
+   * @param lengthUnit - Unit used by all length fields (`"ft" | "m"`).
+   * @param setbacks - Setback profile, ground tier first; minimum 1 tier.
+   * @param verticalCap - Maximum height or floor count.
+   * @param floorToFloor - Required floor-to-floor height in `lengthUnit`.
+   * @param farRatio - Optional FAR value, positive when provided.
+   * @param lotCoverageMaxPct - Optional lot coverage cap, `0..100`.
+   * @returns A {@linkcode PluginBuildableEnvelopeCreateResult} with the
+   *   `buildableEnvelopeId` of the created envelope.
+   * @throws If validation fails or generation produces no renderable geometry.
+   *
+   * @examplePrompt Create a buildable envelope for my site
+   * @examplePrompt Generate the zoning envelope with 10ft front setbacks
+   * @examplePrompt Show the maximum buildable volume with a 150ft height limit
+   * @examplePrompt Create a zoning envelope capped at 12 floors with FAR 3
+   *
+   * # Example
+   * ```ts
+   * const { buildableEnvelopeId } = await snaptrude.design.create.buildableEnvelope(
+   *   [
+   *     { x: 0, z: 0 },
+   *     { x: 100, z: 0 },
+   *     { x: 100, z: 80 },
+   *     { x: 0, z: 80 },
+   *   ],
+   *   "ft",
+   *   [
+   *     { aboveHeight: 0, front: 10, side: 5, rear: 10 },
+   *     { aboveHeight: 100, front: 20, side: 10, rear: 20 },
+   *   ],
+   *   { kind: "max_height", maxHeight: 150 },
+   *   12,
+   * )
+   * ```
+   */
+  public abstract buildableEnvelope(
+    sitePolygon: PluginBuildableEnvelopePolygonVertex[],
+    lengthUnit: "ft" | "m",
+    setbacks: PluginBuildableEnvelopeSetbackTier[],
+    verticalCap: PluginBuildableEnvelopeVerticalCap,
+    floorToFloor: number,
+    farRatio?: number,
+    lotCoverageMaxPct?: number,
+  ): PluginApiReturn<PluginBuildableEnvelopeCreateResult>
 }
 
 // ---------------------------------------------------------------------------
@@ -851,6 +968,26 @@ export type PluginDesignCreateMassArgs = z.infer<
   typeof PluginDesignCreateMassArgs
 >
 
+// ---------------------------------------------------------------------------
+// massFromBrep
+// ---------------------------------------------------------------------------
+
+/**
+ * Arguments for {@linkcode PluginDesignCreateApi.massFromBrep}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `brep` | {@linkcode BrepHandle} | A solid from a `core.geom.create` brep constructor |
+ * | `label` | `string`? | Label (maps to `room_type`) |
+ */
+export const PluginDesignCreateMassFromBrepArgs = z.object({
+  brep: BrepHandle,
+  label: z.string().optional(),
+})
+export type PluginDesignCreateMassFromBrepArgs = z.infer<
+  typeof PluginDesignCreateMassFromBrepArgs
+>
+
 // ---------------------------------------------------------------------------
 // slab
 // ---------------------------------------------------------------------------

package/src/api/design/delete/index.ts

@@ -52,6 +52,9 @@ export abstract class PluginDesignDeleteApi {
    * @examplePrompt Delete all the furniture I picked
    * @examplePrompt Remove the door and window I just created
    *
+   * @performance Array delete — pass every target in one call (one host round-trip). There is
+   *   no per-item delete; collect the whole set and never loop this per entity.
+   *
    * # Example
    * ```ts
    * // Hard-delete every furniture item on storey 2 (a single undo entry)