@snaptrude/plugin-core 1.0.1 → 1.0.2-plainpoint-20261102.2

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

@@ -8,6 +8,7 @@ import {
   CurveHandle,
   ProfileHandle,
   Vec3Handle,
+  Vec3Input,
 } from "../../../handles"
 import { PluginGridStyleOptions } from "./grids"
 import { PluginGraphicsLineStyleId } from "../../presentation/graphics"
@@ -130,7 +131,7 @@ export abstract class PluginDesignCreateApi {
     contour: ContourHandle,
     height: number,
     label?: string,
-    position?: Vec3Handle,
+    position?: Vec3Input,
     spaceType?: PluginSpaceType,
     massType?: PluginMassType,
     departmentId?: PluginDepartmentId,
@@ -165,7 +166,7 @@ export abstract class PluginDesignCreateApi {
     contour: ContourHandle,
     height: number,
     label?: string,
-    position?: Vec3Handle,
+    position?: Vec3Input,
     massType?: PluginMassType,
   ): PluginApiReturn<ComponentHandle>
 
@@ -288,7 +289,7 @@ export abstract class PluginDesignCreateApi {
    */
   public abstract floor(
     ...args:
-      | [contour: ContourHandle, thickness: number, position?: Vec3Handle]
+      | [contour: ContourHandle, thickness: number, position?: Vec3Input]
       | [contour: ContourHandle, options: PluginFamilyFloorOptions]
   ): PluginApiReturn<ComponentHandle[]>
 
@@ -422,10 +423,10 @@ export abstract class PluginDesignCreateApi {
   public abstract column(
     ...args:
       | [
-          position: Vec3Handle,
+          position: Vec3Input,
           crossSection: ContourHandle,
           height: number,
-          directionUp?: Vec3Handle,
+          directionUp?: Vec3Input,
         ]
       | [axis: LineHandle, options: PluginFamilyPlacement]
   ): PluginApiReturn<ComponentHandle>
@@ -472,7 +473,7 @@ export abstract class PluginDesignCreateApi {
    */
   public abstract beam(
     ...args:
-      | [section: ContourHandle, length: number, direction?: Vec3Handle]
+      | [section: ContourHandle, length: number, direction?: Vec3Input]
       | [axis: LineHandle, options: PluginFamilyPlacement]
   ): PluginApiReturn<ComponentHandle>
 
@@ -496,10 +497,10 @@ export abstract class PluginDesignCreateApi {
    *   single undo entry. The storey must already exist
    *   (`core.storeys.create` first). Default: geometry-derived — a profile
    *   drawn at y = 0 lands on storey 1; the ACTIVE storey is NOT consulted.
-   * @param topProfiles - Optional top edge per curve of `profile` (same order):
-   *   a {@linkcode PluginWallTopProfile} makes that wall raked / gabled; `null`
-   *   or a missing entry keeps it flat at `height`. Straight curves only. Such
-   *   walls are non-parametric (see {@linkcode PluginWallTopProfile}).
+   * @param topProfiles - Top edge per curve of `profile` (same order). Current
+   *   hosts build walls with one height: any non-null entry is refused with
+   *   `PRECONDITION_FAILED` ("sloped or stepped tops are not supported") and
+   *   nothing is created. Pass `null` entries or omit it.
    * @returns a {@linkcode ComponentHandle}`[]` (one per wall), in profile order
    * @throws if the profile is empty, `wallType` names no wall type in the
    *   project, `storey` does not exist, `topProfiles` has more entries than the
@@ -513,9 +514,6 @@ export abstract class PluginDesignCreateApi {
    * @examplePrompt Add walls with mitred corners along the path
    * @examplePrompt Draw brick walls with plaster along this outline
    * @examplePrompt Build the perimeter in exposed concrete walls
-   * @examplePrompt Create a raked wall that slopes from 3m to 5m
-   * @examplePrompt Build a gable end wall with the ridge in the middle
-   * @examplePrompt Draw a wall with a sloped top edge
    *
    * # Example
    * ```ts
@@ -531,13 +529,6 @@ export abstract class PluginDesignCreateApi {
    * const brickWalls = await snaptrude.design.create.walls(
    *   centerlines, 3, undefined, brick.label,
    * )
-   * // …a raked wall (3m at the start, 5m at the end) on a single centerline:
-   * const run = await snaptrude.core.geom.create.profileFromCurves([
-   *   await snaptrude.core.geom.create.line(await v.new(0, 0, 10), await v.new(8, 0, 10)),
-   * ])
-   * const [raked] = await snaptrude.design.create.walls(run, undefined, 0.2, undefined, undefined, [
-   *   [{ along: 0, height: 3 }, { along: 1, height: 5 }],
-   * ])
    * ```
    *
    * @performance For MORE THAN ONE run, call `design.create.wallRuns(items[])` — one
@@ -560,8 +551,9 @@ export abstract class PluginDesignCreateApi {
    * item's profile chain, mitred at shared endpoints. Junctions resolve within a
    * run, not between runs. Each item carries its own
    * dimensions, `wallType` and `storey`, so a single call can build a whole
-   * floor plate or several storeys at once. Per-curve `topProfiles` make raked
-   * or gabled walls (see {@linkcode PluginWallTopProfile}). Validate-all-or-throw;
+   * floor plate or several storeys at once. Walls have one height: a non-null
+   * `topProfiles` entry is refused with `PRECONDITION_FAILED` (`details.itemIndex`
+   * names the item) and nothing is created. Validate-all-or-throw;
    * one command.
    *
    * @param items - One {@linkcode PluginCreateWallRunItem} per run to create
@@ -582,7 +574,6 @@ export abstract class PluginDesignCreateApi {
    * @examplePrompt Bulk create wall runs from these centerlines
    * @examplePrompt Create the walls for both storeys in a single undo step
    * @examplePrompt Turn these polylines into 200mm brick walls together
-   * @examplePrompt Import these raked walls with their top profiles in one go
    *
    * @performance Bulk creator — the whole batch is ONE host round-trip and ONE undo
    *   entry. Always prefer this over calling `design.create.walls` in a loop: build the
@@ -603,9 +594,6 @@ export abstract class PluginDesignCreateApi {
    * const [groundWalls, upperWalls] = await snaptrude.design.create.wallRuns([
    *   { profile: ground, height: 3, thickness: 0.2 },
    *   { profile: upper, height: 3, storey: 2 },
-   *   // one gable wall: 3m at both ends, 5m ridge in the middle
-   *   { profile: upper, thickness: 0.2, storey: 3,
-   *     topProfiles: [[{ along: 0, height: 3 }, { along: 0.5, height: 5 }, { along: 1, height: 3 }]] },
    * ])
    * console.log(groundWalls.length, "walls on the ground floor")
    * ```
@@ -649,7 +637,7 @@ export abstract class PluginDesignCreateApi {
    */
   public abstract staircase(
     preset: PluginStaircasePreset,
-    position: Vec3Handle,
+    position: Vec3Input,
     label?: string,
     structureId?: string,
     level?: string,
@@ -740,7 +728,7 @@ export abstract class PluginDesignCreateApi {
     spacingY: number,
     options?: {
       angle?: number
-      center?: Vec3Handle
+      center?: Vec3Input
     } & PluginGridStyleOptions,
   ): PluginApiReturn<ComponentHandle>
 
@@ -895,7 +883,7 @@ export abstract class PluginDesignCreateApi {
    */
   public abstract furniture(
     catalogId: string,
-    position: Vec3Handle,
+    position: Vec3Input,
     options?: { label?: string; createNewSourceMesh?: boolean },
     angleInDegrees?: number,
   ): PluginApiReturn<ComponentHandle>
@@ -1008,14 +996,14 @@ export abstract class PluginDesignCreateApi {
   public abstract door(
     familyId: string,
     hostWall: ComponentHandle,
-    position: Vec3Handle,
+    position: Vec3Input,
     options?: {
       label?: string
-      hinge?: Vec3Handle
+      hinge?: Vec3Input
       version?: number
       values?: Record<string, number | string>
     },
-    facing?: Vec3Handle,
+    facing?: Vec3Input,
   ): PluginApiReturn<ComponentHandle>
 
   /**
@@ -1112,14 +1100,14 @@ export abstract class PluginDesignCreateApi {
   public abstract window(
     familyId: string,
     hostWall: ComponentHandle,
-    position: Vec3Handle,
+    position: Vec3Input,
     options?: {
       label?: string
-      hinge?: Vec3Handle
+      hinge?: Vec3Input
       version?: number
       values?: Record<string, number | string>
     },
-    facing?: Vec3Handle,
+    facing?: Vec3Input,
   ): PluginApiReturn<ComponentHandle>
 
   /**
@@ -1446,7 +1434,7 @@ export abstract class PluginDesignCreateApi {
    */
   public abstract copy(
     components: ComponentHandle[],
-    displacement: Vec3Handle,
+    displacement: Vec3Input,
     options?: { count?: number; mode?: PluginCopyMode },
   ): PluginApiReturn<ComponentHandle[]>
 
@@ -1669,7 +1657,7 @@ export const PluginDesignCreateSpaceArgs = z.object({
   contour: ContourHandle,
   height: z.number(),
   label: z.string().optional(),
-  position: Vec3Handle.optional(),
+  position: Vec3Input.optional(),
   spaceType: PluginSpaceType.optional(),
   massType: PluginMassType.optional(),
   departmentId: PluginDepartmentId.optional(),
@@ -1700,7 +1688,7 @@ export const PluginDesignCreateMassArgs = z.object({
   contour: ContourHandle,
   height: z.number(),
   label: z.string().optional(),
-  position: Vec3Handle.optional(),
+  position: Vec3Input.optional(),
   massType: PluginMassType.optional(),
 })
 export type PluginDesignCreateMassArgs = z.infer<
@@ -1767,7 +1755,7 @@ export type PluginDesignCreateSlabArgs = z.infer<
 export const PluginDesignCreateFloorArgs = z.object({
   contour: ContourHandle,
   thickness: z.number(),
-  position: Vec3Handle.optional(),
+  position: Vec3Input.optional(),
 })
 export type PluginDesignCreateFloorArgs = z.infer<
   typeof PluginDesignCreateFloorArgs
@@ -1830,10 +1818,10 @@ export type PluginDesignCreateCeilingArgs = z.infer<
  * | `directionUp` | {@linkcode Vec3Handle}? | Up axis (default world up) |
  */
 export const PluginDesignCreateColumnArgs = z.object({
-  position: Vec3Handle,
+  position: Vec3Input,
   crossSection: ContourHandle,
   height: z.number(),
-  directionUp: Vec3Handle.optional(),
+  directionUp: Vec3Input.optional(),
 })
 export type PluginDesignCreateColumnArgs = z.infer<
   typeof PluginDesignCreateColumnArgs
@@ -1855,7 +1843,7 @@ export type PluginDesignCreateColumnArgs = z.infer<
 export const PluginDesignCreateBeamArgs = z.object({
   section: ContourHandle,
   length: z.number(),
-  direction: Vec3Handle.optional(),
+  direction: Vec3Input.optional(),
 })
 export type PluginDesignCreateBeamArgs = z.infer<
   typeof PluginDesignCreateBeamArgs
@@ -1910,7 +1898,7 @@ export type PluginDesignCreateWallsArgs = z.infer<
  */
 export const PluginDesignCreateStaircaseArgs = z.object({
   preset: PluginStaircasePreset,
-  position: Vec3Handle,
+  position: Vec3Input,
   label: z.string().optional(),
   structureId: z.string().optional(),
   level: z.string().optional(),
@@ -1937,7 +1925,7 @@ export type PluginDesignCreateStaircaseArgs = z.infer<
  */
 export const PluginDesignCreateFurnitureArgs = z.object({
   catalogId: z.string().min(1),
-  position: Vec3Handle,
+  position: Vec3Input,
   label: z.string().optional(),
   createNewSourceMesh: z.boolean().optional(),
   angleInDegrees: z.number().optional(),
@@ -2195,7 +2183,7 @@ export type PluginCopyMode = z.infer<typeof PluginCopyMode>
  */
 export const PluginDesignCreateCopyArgs = z.object({
   components: z.array(ComponentHandle).min(1),
-  displacement: Vec3Handle,
+  displacement: Vec3Input,
   count: z.number().int().positive().optional(),
   mode: PluginCopyMode.optional(),
 })
@@ -2228,7 +2216,7 @@ export const PluginCreateSpaceItem = z.object({
   contour: ContourHandle,
   height: z.number(),
   label: z.string().optional(),
-  position: Vec3Handle.optional(),
+  position: Vec3Input.optional(),
   spaceType: PluginSpaceType.optional(),
   massType: PluginMassType.optional(),
   departmentId: PluginDepartmentId.optional(),

package/src/api/design/create/opening-fields.ts

@@ -1,5 +1,5 @@
 import * as z from "zod"
-import { ComponentHandle, Vec3Handle } from "../../../handles"
+import { ComponentHandle, Vec3Input } from "../../../handles"
 
 /**
  * The shared field bag every hosted opening (door / window) carries — used by
@@ -17,9 +17,9 @@ import { ComponentHandle, Vec3Handle } from "../../../handles"
  * | `version` | `number`? | Exact family version; newest known by default |
  * | `values` | `Record<string, number \| string>`? | Authored instance parameters; numeric lengths use Snaptrude units |
  * | `hostWall` | {@linkcode ComponentHandle} | The wall to host the opening |
- * | `position` | {@linkcode Vec3Handle} | World point projected onto the wall |
- * | `facing` | {@linkcode Vec3Handle}? | World point on the side of the wall the opening swings open to (default engine-chosen) |
- * | `hinge` | {@linkcode Vec3Handle}? | World point near the hinged jamb; requires the recipe's hand parameter |
+ * | `position` | {@linkcode Vec3Input} | World point projected onto the wall (a vec3 handle or a plain `{ x, y, z }`) |
+ * | `facing` | {@linkcode Vec3Input}? | World point on the side of the wall the opening swings open to (default engine-chosen) |
+ * | `hinge` | {@linkcode Vec3Input}? | World point near the hinged jamb; requires the recipe's hand parameter |
  * | `label` | `string`? | Instance name (optional) |
  * | `width` | `number`? | Sets the declared width parameter, not the opening's evaluated envelope |
  * | `height` | `number`? | Sets the declared height parameter |
@@ -31,9 +31,9 @@ export const PluginOpeningBaseOptions = {
     .record(z.string(), z.union([z.number().finite(), z.string()]))
     .optional(),
   hostWall: ComponentHandle,
-  position: Vec3Handle,
-  facing: Vec3Handle.optional(),
-  hinge: Vec3Handle.optional(),
+  position: Vec3Input,
+  facing: Vec3Input.optional(),
+  hinge: Vec3Input.optional(),
   label: z.string().optional(),
   width: z.number().finite().positive().optional(),
   height: z.number().finite().positive().optional(),

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

@@ -8,7 +8,7 @@ import { PluginDesignChangeResult } from "../lock"
  *
  * | Property | Type | Description |
  * |---|---|---|
- * | `components` | {@linkcode ComponentHandle}`[]` | Entities to delete. Unknown/forged handles reject the whole call (fail-fast). |
+ * | `components` | {@linkcode ComponentHandle}`[]` | Entities to delete. Handles that no longer resolve are skipped and returned as `missing`; the call rejects only when none resolve. |
  *
  * `.min(1)` is deliberately stricter than the shipped `PluginDesignLockArgs`
  * (which allows an empty array) — an empty delete is a caller error, not a no-op.
@@ -43,12 +43,19 @@ export abstract class PluginDesignDeleteApi {
    * entry, exactly as the editor's Delete key does — see `design.dimensions`. They are
    * NOT listed in `affected`, which reports component handles only.
    *
-   * @param components - Entities to delete. Unknown/forged handles reject the whole call (fail-fast).
-   * @returns The entities that were deleted, as {@linkcode ComponentHandle}`[]`
-   *   (echoed host-side from the resolved+deleted set — the engine returns no ids).
-   *   Deleted handles are **stale** afterwards: re-resolving one throws `HANDLE_INVALID`.
-   * @throws If any supplied handle is unknown/forged (`HANDLE_INVALID`) — the whole
-   *   call rejects before anything is deleted (all-or-nothing resolution).
+   * @param components - Entities to delete. A handle that no longer resolves (already
+   *   removed by an earlier edit — a door deleted with its wall, a wall replaced by an
+   *   opening's re-cut) is skipped, not fatal.
+   * @returns `{ affected, cascaded?, missing?, rejected? }`: the entities you asked to delete
+   *   (echoed host-side — the engine returns no ids); `cascaded`, the derived walls/floors/slabs
+   *   the parametric graph removed with a deleted space; `missing`, handles that no longer
+   *   resolved and were skipped; `rejected`, handles the engine accepted but left standing
+   *   (delete them again, one at a time, or report them). Deleted handles are **stale**
+   *   afterwards: re-resolving one throws `HANDLE_STALE`.
+   * @throws `HANDLE_INVALID` when NONE of the supplied handles resolve (nothing is deleted);
+   *   hosts before Oct 2026 reject the whole call when any handle is gone. `OPERATION_FAILED`
+   *   when the parametric engine rejects the deletion — the batch is rolled back.
+   *   `HANDLE_STALE` for a handle the caller held that has since been retired.
    *
    * @examplePrompt Delete the selected objects
    * @examplePrompt Remove these walls from the model

package/src/api/design/dimensions.ts

@@ -5,6 +5,7 @@ import {
   DimensionHandle,
   Vec3Components,
   Vec3Handle,
+  Vec3Input,
 } from "../../handles"
 
 /**
@@ -94,8 +95,8 @@ export abstract class PluginDesignDimensionsApi {
    * ```
    */
   public abstract create(
-    from: Vec3Handle,
-    to: Vec3Handle,
+    from: Vec3Input,
+    to: Vec3Input,
     anchor: ComponentHandle,
     options?: { anchorTo?: ComponentHandle; offset?: number },
   ): PluginApiReturn<DimensionHandle>
@@ -362,8 +363,8 @@ export type PluginDimensionsChangeResult = z.infer<
  * TRANSPORT: positional args — validated host-side as this object.
  */
 export const PluginDesignDimensionsCreateArgs = z.object({
-  from: Vec3Handle,
-  to: Vec3Handle,
+  from: Vec3Input,
+  to: Vec3Input,
   anchor: ComponentHandle,
   anchorTo: ComponentHandle.optional(),
   offset: z.number().finite().optional(),

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

@@ -1,6 +1,6 @@
 import * as z from "zod"
 import { PluginApiReturn } from "../../../types"
-import { ComponentHandle, Vec3Handle } from "../../../handles"
+import { ComponentHandle, Vec3Input } from "../../../handles"
 import { OffsetSplitOutcome } from "../shared"
 
 /**
@@ -41,7 +41,7 @@ export abstract class PluginDesignEditApi {
   public abstract offsetSplit(
     component: ComponentHandle,
     offsetDistance: number,
-    options?: { profilePickPoint?: Vec3Handle },
+    options?: { profilePickPoint?: Vec3Input },
   ): PluginApiReturn<OffsetSplitOutcome>
 }
 
@@ -49,6 +49,6 @@ export abstract class PluginDesignEditApi {
 export const PluginDesignOffsetSplitArgs = z.object({
   component: ComponentHandle,
   offsetDistance: z.number(),
-  profilePickPoint: Vec3Handle.optional(),
+  profilePickPoint: Vec3Input.optional(),
 })
 export type PluginDesignOffsetSplitArgs = z.infer<typeof PluginDesignOffsetSplitArgs>

package/src/api/design/family.ts

@@ -5,6 +5,7 @@ import {
   ComponentHandle,
   Vec3Components,
   Vec3Handle,
+  Vec3Input,
 } from "../../handles"
 import { NetworkFamilyContract } from "./networks"
 
@@ -1319,7 +1320,7 @@ export type PluginDesignFamilyDeleteArgs = z.infer<
 export const PluginDesignFamilyPlaceArgs = z.object({
   id: z.string().optional(),
   version: z.number().int().positive().optional(),
-  position: z.union([Vec3Handle, Vec3Components]).optional(),
+  position: z.union([Vec3Input, Vec3Components]).optional(),
   rotation: z.number().optional(),
   values: z.record(z.string(), z.union([z.number(), z.string()])).optional(),
   storey: z.number().int().optional(),

package/src/api/design/index.ts

@@ -15,6 +15,7 @@ import { PluginDesignEditApi } from "./edit"
 import { PluginDesignUpdateApi } from "./update"
 import { PluginDesignVisibilityApi } from "./visibility"
 import { PluginDesignDimensionsApi } from "./dimensions"
+import { PluginDesignTextApi } from "./text"
 import { PluginDesignTypesApi } from "./types"
 import { PluginDesignFamilyApi } from "./family"
 import { PluginDesignGridsApi } from "./grids"
@@ -41,6 +42,7 @@ import {
  * - {@linkcode PluginDesignApi.delete} — hard entity removal
  * - {@linkcode PluginDesignApi.visibility} — hide / isolate / reveal entities
  * - {@linkcode PluginDesignApi.dimensions} — dimension lines (Measuring Tape): create / list / delete / hide
+ * - {@linkcode PluginDesignApi.text} — authored text and annotations (Text / Annotate tools): create / list / get / update / setLeader
  * - {@linkcode PluginDesignApi.types} — read-only building type / assembly reference
  * - {@linkcode PluginDesignApi.family} — author parametric families from a JSON spec
  * - {@linkcode PluginDesignApi.lock} / {@linkcode PluginDesignApi.unlock} / {@linkcode PluginDesignApi.isLocked} / {@linkcode PluginDesignApi.listLocked} — lock state (top-level design verbs, §2A.1)
@@ -79,6 +81,8 @@ export abstract class PluginDesignApi {
   public abstract visibility: PluginDesignVisibilityApi
   /** Dimension lines (Measuring Tape). See {@linkcode PluginDesignDimensionsApi}. */
   public abstract dimensions: PluginDesignDimensionsApi
+  /** Authored text and annotations (Text / Annotate tools). See {@linkcode PluginDesignTextApi}. */
+  public abstract text: PluginDesignTextApi
   /** Read-only building type / assembly reference. See {@linkcode PluginDesignTypesApi}. */
   public abstract types: PluginDesignTypesApi
   /** Author parametric families from a JSON spec. See {@linkcode PluginDesignFamilyApi}. */
@@ -296,6 +300,7 @@ export * from "./edit"
 export * from "./update"
 export * from "./visibility"
 export * from "./dimensions"
+export * from "./text"
 export * from "./types"
 export * from "./family"
 export * from "./grids"

package/src/api/design/lock.ts

@@ -9,6 +9,12 @@ import { ComponentHandle } from "../../handles"
  */
 export const PluginDesignChangeResult = z.object({
   affected: z.array(ComponentHandle),
+  /** Derived BIM (walls/floors/slabs) the parametric engine removed with its host. Delete only. */
+  cascaded: z.array(ComponentHandle).optional(),
+  /** Handles that no longer resolved when the call ran and were skipped. Delete only. */
+  missing: z.array(ComponentHandle).optional(),
+  /** Handles the engine accepted but left standing; delete them again or report them. Delete only. */
+  rejected: z.array(ComponentHandle).optional(),
 })
 export type PluginDesignChangeResult = z.infer<typeof PluginDesignChangeResult>