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

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/erase/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"
 
 /**
  * The erase strategies exposed to plugins. `SplitAndUnion` is *enumerable* but
@@ -38,7 +38,7 @@ export const ErasableEdgeRef = z.object({
   /** The components this edge is incident to — one for external (DirectDelete); two or more for internal (DirectUnion; 3+ at T-junctions where several masses share the edge). */
   components: z.array(ComponentHandle),
   /** A representative point on the edge (its head endpoint). Diagnostic only. */
-  snapPoint: Vec3Handle,
+  snapPoint: Vec3Input,
 })
 export type ErasableEdgeRef = z.infer<typeof ErasableEdgeRef>
 

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/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>
 

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

@@ -1,6 +1,6 @@
 import * as z from "zod"
 import { PluginApiReturn } from "../../../types"
-import { ComponentHandle, Vec3Handle } from "../../../handles"
+import { ComponentHandle, Vec3Handle, Vec3Input } from "../../../handles"
 import { PluginDesignChangeResult } from "../lock"
 
 /**
@@ -22,9 +22,17 @@ export abstract class PluginDesignTransformApi {
    * component's absolute position as the anchor). Undoable.
    *
    * @param components - Entities to move
-   * @param displacement - Relative translation as a {@linkcode Vec3Handle}
+   * @param displacement - Relative translation as a {@linkcode Vec3Handle}. A displacement
+   *   shorter than 1e-6 is a no-op that succeeds (hosts before Oct 2026 throw
+   *   `OPERATION_FAILED` "No movement occurred" instead, so skip the call when nothing moves).
    * @param options - `is2D`, `trackParentChange`
    * @returns {@linkcode PluginDesignChangeResult}
+   * @throws `OPERATION_FAILED` when the engine drops the whole move. A single connected
+   *   parametric wall moves only across its own line: the vertical part and the part along
+   *   the line are dropped. Move the whole connected run in one call to lift walls; to slide
+   *   or lengthen one wall, delete it and create it again on the new line. Graph-bound walls
+   *   made by Sketch-to-BIM refuse `move` outright (`TOPOLOGY_ERROR` / `ZERO_MOVEMENT`):
+   *   adjust the room boundary that owns the wall instead.
    *
    * @examplePrompt Move the selected room 5 metres to the right
    * @examplePrompt Shift these walls 3m along the x axis
@@ -43,7 +51,7 @@ export abstract class PluginDesignTransformApi {
    */
   public abstract move(
     components: ComponentHandle[],
-    displacement: Vec3Handle,
+    displacement: Vec3Input,
     options?: { is2D?: boolean; trackParentChange?: boolean },
   ): PluginApiReturn<PluginDesignChangeResult>
 
@@ -81,7 +89,7 @@ export abstract class PluginDesignTransformApi {
   public abstract rotate(
     components: ComponentHandle[],
     angleInDegrees: number,
-    options?: { axis?: Vec3Handle; pivot?: Vec3Handle; is2D?: boolean },
+    options?: { axis?: Vec3Input; pivot?: Vec3Input; is2D?: boolean },
   ): PluginApiReturn<PluginDesignChangeResult>
 
   /**
@@ -205,7 +213,7 @@ export type PluginAlignEdge = z.infer<typeof PluginAlignEdge>
  */
 export const PluginDesignMoveArgs = z.object({
   components: z.array(ComponentHandle).min(1),
-  displacement: Vec3Handle,
+  displacement: Vec3Input,
   is2D: z.boolean().optional(),
   trackParentChange: z.boolean().optional(),
 })
@@ -217,9 +225,9 @@ export type PluginDesignMoveArgs = z.infer<typeof PluginDesignMoveArgs>
 export const PluginDesignRotateArgs = z.object({
   components: z.array(ComponentHandle).min(1),
   angleInDegrees: z.number(),
-  axis: Vec3Handle.optional(),
+  axis: Vec3Input.optional(),
   is2D: z.boolean().optional(),
-  pivot: Vec3Handle.optional(),
+  pivot: Vec3Input.optional(),
 })
 export type PluginDesignRotateArgs = z.infer<typeof PluginDesignRotateArgs>
 

package/src/api/entity/space.ts

@@ -6,6 +6,7 @@ import * as z from "zod"
 import {
   ProfileHandle,
   Vec3Handle,
+  Vec3Input,
   Vec3Components,
   QuatComponents,
   CurveHandle,
@@ -21,7 +22,7 @@ import {
  * | `dimensions` | `{ width, height, depth }` | Box dimensions in Babylon units |
  */
 export const PluginSpaceCreateRectangularArgs = z.object({
-  position: Vec3Handle,
+  position: Vec3Input,
   dimensions: z.object({
     width: z.number(),
     height: z.number(),
@@ -62,7 +63,7 @@ export const PluginSpaceCreateFromProfileArgs = z.object({
   profile: ProfileHandle,
   innerProfiles: z.array(ProfileHandle).optional(),
   extrudeHeight: z.number(),
-  position: Vec3Handle,
+  position: Vec3Input,
 })
 
 export type PluginSpaceCreateFromProfileArgs = z.infer<
@@ -466,7 +467,7 @@ export type PluginSpaceUpdateResult = z.infer<typeof PluginSpaceUpdateResult>
 export const PluginSpaceBulkCreateItem = z.discriminatedUnion("kind", [
   z.object({
     kind: z.literal("rectangular"),
-    position: Vec3Handle,
+    position: Vec3Input,
     dimensions: z.object({
       width: z.number(),
       height: z.number(),
@@ -482,7 +483,7 @@ export const PluginSpaceBulkCreateItem = z.discriminatedUnion("kind", [
     profile: ProfileHandle,
     innerProfiles: z.array(ProfileHandle).optional(),
     extrudeHeight: z.number(),
-    position: Vec3Handle,
+    position: Vec3Input,
     room_type: z.string().optional(),
     spaceType: PluginSpaceType.optional(),
     massType: PluginMassType.optional(),

package/src/handles.ts

@@ -288,6 +288,17 @@ export const EdgeHandle = handleSchema("edge")
 export const HalfEdgeHandle = handleSchema("halfedge")
 export const VertexHandle = handleSchema("vertex")
 export const Vec3Components = z.object({ x: z.number(), y: z.number(), z: z.number() })
+/**
+ * A vec3 ARGUMENT: a {@linkcode Vec3Handle} in any inbound form, or a plain finite
+ * `{ x, y, z }` point. Geometry reads return plain points, and callers pass them straight
+ * back where a vec3 is expected; the host resolves the point as a vector. Returns stay
+ * {@linkcode Vec3Handle}. Explicitly typed to keep handles.d.ts inside its size budget.
+ */
+export type Vec3Input = Handle<"vec3"> | Vec3Components
+export const Vec3Input: z.ZodUnion<readonly [typeof Vec3Handle, typeof Vec3Components]> = z.union(
+  [Vec3Handle, Vec3Components],
+  { error: 'expected a "vec3" handle or a plain { x, y, z } point' }
+)
 export const QuatComponents = z.object({
   x: z.number(),
   y: z.number(),

package/test/handles.test.mjs

@@ -0,0 +1,36 @@
+// Node built-in test runner suite for the handle schemas.
+// Imports the BUILT package (dist) — run `pnpm build` first.
+import test from "node:test"
+import assert from "node:assert/strict"
+import { Vec3Handle, Vec3Input, Handle, PluginDesignMoveArgs } from "../dist/index.js"
+
+test("a vec3 handle parses in every inbound form, and only as a handle", () => {
+  for (const v of ["vec3_abc", new Handle("vec3_abc"), { __h: "vec3_abc" }, { id: "vec3_abc" }]) {
+    const out = Vec3Handle.parse(v)
+    assert.ok(out instanceof Handle)
+    assert.equal(out.id, "vec3_abc")
+  }
+  assert.equal(Vec3Handle.safeParse({ x: 1, y: 2, z: 3 }).success, false)
+  const bad = Vec3Handle.safeParse("profile_1")
+  assert.equal(bad.success, false)
+  assert.match(bad.error.issues[0].message, /expected a "vec3" handle/)
+})
+
+test("Vec3Input takes a handle or a plain { x, y, z } point", () => {
+  // Geometry reads return plain points; agents pass them back where a vec3 belongs.
+  const point = { x: 1, y: 2.5, z: -3 }
+  assert.deepEqual(Vec3Input.parse(point), point)
+  assert.ok(Vec3Input.parse("vec3_abc") instanceof Handle)
+  const args = PluginDesignMoveArgs.parse({ components: ["wl_1"], displacement: { x: 0, y: 0, z: 10 } })
+  assert.deepEqual(args.displacement, { x: 0, y: 0, z: 10 })
+  const handled = PluginDesignMoveArgs.parse({ components: ["wl_1"], displacement: "vec3_d" })
+  assert.equal(handled.displacement.id, "vec3_d")
+})
+
+test("Vec3Input still rejects non-points and wrong handles, with one message", () => {
+  for (const v of [{ x: 1, y: 2 }, { x: 1, y: Number.NaN, z: 3 }, { x: "1", y: 2, z: 3 }, "profile_1", null, 42]) {
+    const r = Vec3Input.safeParse(v)
+    assert.equal(r.success, false, JSON.stringify(v))
+    assert.equal(r.error.issues[0].message, 'expected a "vec3" handle or a plain { x, y, z } point')
+  }
+})