@pascal-app/nodes 1.0.1 → 1.0.4

package/dist/index.js

@@ -16,6 +16,8 @@ import { ductTerminalDefinition } from './duct-terminal';
 import { elevatorDefinition } from './elevator';
 import { eyebrowVentDefinition } from './eyebrow-vent';
 import { fenceDefinition } from './fence';
+import { fenceGateDefinition, fenceOpeningDefinition } from './fence-feature/definition';
+import { floorOpeningDefinition } from './floor-opening/definition';
 import { guideDefinition } from './guide';
 import { gutterDefinition } from './gutter';
 import { hvacEquipmentDefinition } from './hvac-equipment';
@@ -34,6 +36,7 @@ import { ridgeVentDefinition } from './ridge-vent';
 import { roofDefinition } from './roof';
 import { roofSegmentDefinition } from './roof-segment';
 import { scanDefinition } from './scan';
+import { separatorDefinition } from './separator/definition';
 import { shelfDefinition } from './shelf';
 import { siteDefinition } from './site';
 import { skylightDefinition } from './skylight';
@@ -73,8 +76,12 @@ export const builtinPlugin = {
         blockDefinition,
         spawnDefinition,
         wallDefinition,
+        separatorDefinition,
+        floorOpeningDefinition,
         leanToExtensionDefinition,
         fenceDefinition,
+        fenceGateDefinition,
+        fenceOpeningDefinition,
         slabDefinition,
         ceilingDefinition,
         doorDefinition,
@@ -145,12 +152,14 @@ export { ductSegmentDefinition } from './duct-segment';
 export { ductTerminalDefinition } from './duct-terminal';
 export { elevatorDefinition } from './elevator';
 export { eyebrowVentDefinition } from './eyebrow-vent';
-export { fenceDefinition } from './fence';
+export { beginFenceFeaturePlacement, fenceDefinition } from './fence';
+export { fenceGateDefinition, fenceOpeningDefinition } from './fence-feature/definition';
+export { floorOpeningDefinition } from './floor-opening/definition';
 export { guideDefinition } from './guide';
 export { gutterDefinition } from './gutter';
 export { hvacEquipmentDefinition } from './hvac-equipment';
 export { importedMeshDefinition } from './imported-mesh';
-export { itemDefinition } from './item';
+export { getPendingItemModelLoadCount, itemDefinition } from './item';
 export { leanToExtensionDefinition } from './lean-to-extension';
 export { levelDefinition } from './level';
 export { linesetDefinition } from './lineset';
@@ -163,6 +172,7 @@ export { ridgeVentDefinition } from './ridge-vent';
 export { roofDefinition, useRoofFootprintSource } from './roof';
 export { roofSegmentDefinition } from './roof-segment';
 export { scanDefinition } from './scan';
+export { separatorDefinition } from './separator/definition';
 export { shelfDefinition } from './shelf';
 export { siteDefinition } from './site';
 export { skylightDefinition } from './skylight';
@@ -170,6 +180,14 @@ export { slabDefinition } from './slab';
 export { solarPanelDefinition } from './solar-panel';
 export { spawnDefinition } from './spawn';
 export { stairDefinition } from './stair';
+export { guardBoxGeometry } from './stair/baluster-geometry';
+export { buildBalusterGuard } from './stair/baluster-guard';
+export { buildBoardsGuard } from './stair/boards-guard';
+export { buildCableGuard } from './stair/cable-guard';
+export { buildGlassGuard } from './stair/glass-guard';
+export { buildMetalGuard } from './stair/metal-guard';
+export { buildFloorplanStairEntry } from './stair/plan-entry';
+export { buildPostAndRailGuard } from './stair/post-and-rail-guard';
 export { stairSegmentDefinition } from './stair-segment';
 export { structuralGridDefinition } from './structural-grid';
 export { turbineVentDefinition } from './turbine-vent';

package/dist/item/authored-face-host.d.ts

@@ -0,0 +1,10 @@
+import { type FaceHostCapability, type ItemNode } from '@pascal-app/core';
+/**
+ * Authored objects host ceiling items (pendants, fans, recessed cans) on
+ * their real undersides — a vault plane, a soffit, a beam — found from the
+ * pointer's hit, so placement follows the geometry the script built. A
+ * pendant hangs plumb, a recessed fixture tilts with the slope; either
+ * becomes the object's child.
+ */
+export declare const authoredItemFaceHost: FaceHostCapability<ItemNode>;
+//# sourceMappingURL=authored-face-host.d.ts.map

package/dist/item/authored-face-host.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authored-face-host.d.ts","sourceRoot":"","sources":["../../src/item/authored-face-host.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,kBAAkB,EAGvB,KAAK,QAAQ,EAGd,MAAM,kBAAkB,CAAA;AA4CzB;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,EAAE,kBAAkB,CAAC,QAAQ,CAsC7D,CAAA"}

package/dist/item/authored-face-host.js

@@ -0,0 +1,87 @@
+import { flushMountRotation, mountsFlush, sceneRegistry, } from '@pascal-app/core';
+import { Quaternion, Triangle, Vector3 } from 'three';
+/** Faces pointing at least this far down take ceiling items (a vault plane at up to ~70°). */
+const UNDERSIDE_MAX_NORMAL_Y = -0.35;
+const UNDERSIDE_FACE = 'underside';
+function hitNormal(object, faceIndex) {
+    const geometry = object.geometry;
+    const position = geometry?.getAttribute('position');
+    if (!(geometry && position) || faceIndex === undefined)
+        return null;
+    const index = geometry.getIndex();
+    const vertex = (k) => (index ? index.getX(faceIndex * 3 + k) : faceIndex * 3 + k);
+    const triangle = new Triangle(new Vector3().fromBufferAttribute(position, vertex(0)), new Vector3().fromBufferAttribute(position, vertex(1)), new Vector3().fromBufferAttribute(position, vertex(2)));
+    return triangle.getNormal(new Vector3());
+}
+/**
+ * Where a ceiling item hangs under an authored object: the hit point and the
+ * face normal, both in the host item's frame, when the face points down.
+ */
+function resolveUnderside(args) {
+    if (!args.host.source || args.asset.attachTo !== 'ceiling')
+        return null;
+    const hostObject = sceneRegistry.nodes.get(args.host.id);
+    const object = args.object;
+    const localNormal = hitNormal(object, args.faceIndex);
+    if (!(hostObject && localNormal))
+        return null;
+    object.updateWorldMatrix(true, false);
+    hostObject.updateWorldMatrix(true, false);
+    const world = object.localToWorld(new Vector3(...args.localPosition));
+    const point = hostObject.worldToLocal(world.clone());
+    const toHost = hostObject.getWorldQuaternion(new Quaternion()).invert();
+    const normal = localNormal
+        .applyQuaternion(object.getWorldQuaternion(new Quaternion()))
+        .applyQuaternion(toHost)
+        .normalize();
+    if (normal.y > UNDERSIDE_MAX_NORMAL_Y)
+        return null;
+    return { world, point, normal };
+}
+/**
+ * Authored objects host ceiling items (pendants, fans, recessed cans) on
+ * their real undersides — a vault plane, a soffit, a beam — found from the
+ * pointer's hit, so placement follows the geometry the script built. A
+ * pendant hangs plumb, a recessed fixture tilts with the slope; either
+ * becomes the object's child.
+ */
+export const authoredItemFaceHost = {
+    currentFaceId: (item) => (item?.asset.attachTo === 'ceiling' ? UNDERSIDE_FACE : null),
+    clearItemFields: [],
+    resolvePlacement: (args) => {
+        const hit = resolveUnderside(args);
+        if (!hit)
+            return null;
+        const yaw = args.draftItem?.rotation[1] ?? 0;
+        // A recessed fixture seats flush along the face, tilted with a slope; a
+        // pendant or fan hangs plumb from the point.
+        const flush = mountsFlush({ ...args.asset, dimensions: args.rawDimensions });
+        const offset = flush
+            ? hit.normal.clone().multiplyScalar(0.02)
+            : new Vector3(0, -args.rawDimensions[1], 0);
+        const at = hit.point.clone().add(offset);
+        const position = [at.x, at.y, at.z];
+        const rotation = flush
+            ? flushMountRotation([hit.normal.x, hit.normal.y, hit.normal.z], yaw)
+            : [0, yaw, 0];
+        const cursor = hit.world.clone().add(offset);
+        return {
+            faceId: UNDERSIDE_FACE,
+            nodeUpdate: {
+                position,
+                rotation,
+                parentId: args.host.id,
+                wallId: undefined,
+                blockFaceId: undefined,
+                roofSegmentId: undefined,
+                roofFace: undefined,
+            },
+            position,
+            rotation,
+            cursorPosition: cursor.toArray(),
+            cursorRotation: rotation,
+        };
+    },
+    storedPlacementPatch: () => null,
+    isStoredPlacementValid: ({ host, asset }) => Boolean(host.source) && asset.attachTo === 'ceiling',
+};

package/dist/item/authored-params.d.ts

@@ -0,0 +1,15 @@
+import type { ScriptedNode } from '@pascal-app/core';
+/**
+ * The params an authored object's script declares, as controls. Sliders
+ * preview their value while dragging and rebuild on release (a rebuild runs
+ * the script again: tens to hundreds of milliseconds in three.js, seconds in
+ * Blender). A param changed from
+ * the script's default can be put back, alone or with all the others.
+ */
+export declare function AuthoredParams({ node, }: {
+    node: {
+        id: string;
+        source?: ScriptedNode['source'];
+    };
+}): import("react").JSX.Element | null;
+//# sourceMappingURL=authored-params.d.ts.map

package/dist/item/authored-params.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authored-params.d.ts","sourceRoot":"","sources":["../../src/item/authored-params.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAGV,YAAY,EACb,MAAM,kBAAkB,CAAA;AAezB;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,EAC7B,IAAI,GACL,EAAE;IACD,IAAI,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAA;KAAE,CAAA;CACtD,sCAsHA"}

package/dist/item/authored-params.js

@@ -0,0 +1,72 @@
+'use client';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { PanelSection, rebuildAuthoredObject, SegmentedControl, SliderControl, ToggleControl, Tooltip, TooltipContent, TooltipTrigger, } from '@pascal-app/editor';
+import { RotateCcw } from 'lucide-react';
+import { useRef, useState } from 'react';
+import { isScriptDefault, scriptDefault, scriptDefaultsPatch } from './script-param-defaults';
+/**
+ * The params an authored object's script declares, as controls. Sliders
+ * preview their value while dragging and rebuild on release (a rebuild runs
+ * the script again: tens to hundreds of milliseconds in three.js, seconds in
+ * Blender). A param changed from
+ * the script's default can be put back, alone or with all the others.
+ */
+export function AuthoredParams({ node, }) {
+    const source = node.source;
+    const [drafts, setDrafts] = useState({});
+    const [busy, setBusy] = useState(false);
+    const rebuilding = useRef(false);
+    const [error, setError] = useState(null);
+    if (!source || source.manifest.params.length === 0)
+        return null;
+    const rebuild = (patch) => {
+        if (rebuilding.current)
+            return;
+        rebuilding.current = true;
+        setBusy(true);
+        setError(null);
+        rebuildAuthoredObject(node.id, patch)
+            .catch((reason) => {
+            console.error('[authored object] rebuild failed', reason);
+            setError("Couldn't rebuild with these values.");
+        })
+            .finally(() => {
+            rebuilding.current = false;
+            setBusy(false);
+            setDrafts((current) => {
+                const rest = { ...current };
+                for (const id of Object.keys(patch))
+                    delete rest[id];
+                return rest;
+            });
+        });
+    };
+    const control = (spec) => {
+        const value = source.params[spec.id] ?? scriptDefault(spec);
+        const label = spec.label ?? spec.id;
+        if (spec.kind === 'boolean') {
+            return (_jsx(ToggleControl, { checked: Boolean(value), label: label, onChange: (checked) => rebuild({ [spec.id]: checked }) }));
+        }
+        if (spec.kind === 'string') {
+            if (!spec.options?.length) {
+                return (_jsxs("div", { className: "flex h-7 items-center justify-between gap-2 px-2 text-xs", children: [_jsx("span", { className: "text-muted-foreground", children: label }), _jsx("span", { className: "truncate", children: String(value) })] }));
+            }
+            return (_jsx(SegmentedControl, { onChange: (next) => rebuild({ [spec.id]: next }), options: spec.options.map((option) => ({ label: option, value: option })), value: String(value) }));
+        }
+        const current = drafts[spec.id] ?? Number(value);
+        const span = Math.max(Math.abs(Number(spec.default)), 1);
+        return (_jsx(SliderControl, { label: label, max: spec.max ?? Number(spec.default) + span, min: spec.min ?? Number(spec.default) - span, onChange: (next) => {
+                if (!rebuilding.current)
+                    setDrafts((d) => ({ ...d, [spec.id]: next }));
+            }, onCommit: (next) => rebuild({ [spec.id]: next }), precision: spec.step !== undefined && spec.step < 1 ? 2 : 0, restoreOnCommit: false, step: spec.step ?? 0.01, unit: spec.unit, value: current }));
+    };
+    const row = (spec) => {
+        const input = control(spec);
+        return (_jsxs("div", { className: "flex items-center gap-1", inert: busy, children: [_jsx("div", { className: "min-w-0 flex-1", children: input }), isScriptDefault(spec, source.params[spec.id]) ? null : (_jsx(ResetButton, { label: `Reset ${spec.label ?? spec.id}`, onClick: () => rebuild({ [spec.id]: scriptDefault(spec) }) }))] }, spec.id));
+    };
+    const resetAll = scriptDefaultsPatch(source.manifest.params, source.params);
+    return (_jsxs(PanelSection, { title: "Parameters", children: [source.manifest.params.map(row), Object.keys(resetAll).length > 0 ? (_jsxs("button", { className: "mt-1 flex h-8 items-center justify-center gap-1.5 rounded-full border border-border/50 px-3 font-medium text-foreground text-xs transition-colors hover:bg-accent/50", "data-authored-params-reset": true, disabled: busy, onClick: () => rebuild(resetAll), type: "button", children: [_jsx(RotateCcw, { className: "h-3.5 w-3.5" }), "Reset parameters"] })) : null, busy ? (_jsx("div", { className: "px-2 py-1 text-muted-foreground text-xs", children: source.language === 'bpy' ? 'Rebuilding in Blender…' : 'Rebuilding…' })) : null, error ? _jsx("div", { className: "px-2 py-1 text-red-400 text-xs", children: error }) : null] }));
+}
+function ResetButton({ label, onClick }) {
+    return (_jsxs(Tooltip, { children: [_jsx(TooltipTrigger, { asChild: true, children: _jsx("button", { "aria-label": label, className: "flex h-7 w-7 shrink-0 items-center justify-center rounded-full text-muted-foreground transition-colors hover:bg-accent hover:text-foreground", "data-authored-param-reset": true, onClick: onClick, type: "button", children: _jsx(RotateCcw, { className: "h-3.5 w-3.5" }) }) }), _jsx(TooltipContent, { side: "top", children: "Reset to default" })] }));
+}

package/dist/item/definition.d.ts

@@ -3,8 +3,8 @@ import { ItemNode } from './schema';
 /**
  * Item — Phase 5 batch kind. Catalog-backed, GLB-rendered, multi-host.
  *
- * Demonstrates the **custom `def.renderer` escape hatch** (see
- * plans/editor-node-registry.md): items use `useGLTF` from drei to
+ * Demonstrates the **custom `def.renderer` escape hatch** ("Opting out of a
+ * generic path" in wiki/architecture/node-definitions.md): items use `useGLTF` from drei to
  * load CDN assets, plus a non-trivial interactive-widget layer inside
  * the rendered scene. Not expressible as a pure `def.geometry`. The
  * registry mounts the custom React renderer as-is.

package/dist/item/definition.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"definition.d.ts","sourceRoot":"","sources":["../../src/item/definition.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,cAAc,EACpB,MAAM,kBAAkB,CAAA;AAMzB,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AA+HnC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,cAAc,EAAE,cAAc,CAAC,OAAO,QAAQ,CAwL1D,CAAA"}
+{"version":3,"file":"definition.d.ts","sourceRoot":"","sources":["../../src/item/definition.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,KAAK,cAAc,EAGpB,MAAM,kBAAkB,CAAA;AAWzB,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AA+HnC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,cAAc,EAAE,cAAc,CAAC,OAAO,QAAQ,CAqN1D,CAAA"}

package/dist/item/definition.js

@@ -1,8 +1,13 @@
-import { getScaledDimensions, } from '@pascal-app/core';
+import { getEffectiveCutterNode, getScaledDimensions, resolveCutterHost, toggleMechanism, } from '@pascal-app/core';
+import { itemHasLights, itemMechanism, toggleItemLights } from '../shared/item-interactions';
+import { itemBatchable } from '../shared/node-batch/batchable';
+import { restingFloorplanAffectedIds } from '../shared/resting-surface-plan';
+import { authoredItemFaceHost } from './authored-face-host';
 import { buildItemContextualDimensions, buildItemFloorplan } from './floorplan';
 import { itemFloorplanMoveTarget } from './floorplan-move';
 import { itemPaint } from './paint';
 import { itemParametrics } from './parametrics';
+import { itemPlacementNotice } from './placement-notice';
 import { ItemNode } from './schema';
 // The two floor gizmos flank the item at mid-height so they never overlap,
 // even on small items: move sits past the left edge, rotate past the right
@@ -125,8 +130,8 @@ function itemWallMoveHandle() {
 /**
  * Item — Phase 5 batch kind. Catalog-backed, GLB-rendered, multi-host.
  *
- * Demonstrates the **custom `def.renderer` escape hatch** (see
- * plans/editor-node-registry.md): items use `useGLTF` from drei to
+ * Demonstrates the **custom `def.renderer` escape hatch** ("Opting out of a
+ * generic path" in wiki/architecture/node-definitions.md): items use `useGLTF` from drei to
  * load CDN assets, plus a non-trivial interactive-widget layer inside
  * the rendered scene. Not expressible as a pure `def.geometry`. The
  * registry mounts the custom React renderer as-is.
@@ -161,6 +166,7 @@ export const itemDefinition = {
     extensions: {
         'pascal:editor/floorplan': {
             contextualDimensions: buildItemContextualDimensions,
+            actionMenu: { actions: () => import('../shared/item-interaction-actions') },
         },
     },
     // Defaults shape is cast: the schema requires a fully-typed `asset`
@@ -187,7 +193,10 @@ export const itemDefinition = {
         },
     }),
     capabilities: {
+        batchable: itemBatchable,
         selectable: { hitVolume: 'bbox' },
+        // Authored objects host ceiling items on their undersides; catalog items do not.
+        faceHost: authoredItemFaceHost,
         surfaces: {
             top: {
                 height: (node) => {
@@ -196,9 +205,10 @@ export const itemDefinition = {
                 },
             },
         },
-        duplicable: true,
+        duplicable: { subtree: 'with-children' },
         deletable: true,
         paint: itemPaint,
+        mechanism: itemMechanism,
         // Items participate in compositions — e.g. "table-with-plants",
         // "shelf-with-books-on-top" — so they're presettable in their own
         // right (and as descendants of presettable parents). The GLB-kind
@@ -297,12 +307,33 @@ export const itemDefinition = {
     // Stage C: floor-plan polygon. ctx.resolve walks the parent chain
     // (wall / nested item / level) to compute the world-space transform.
     floorplan: buildItemFloorplan,
+    floorplanAffectedIds: (args) => {
+        const ids = [...restingFloorplanAffectedIds(args)];
+        for (const node of [args.node, getEffectiveCutterNode(args.node)]) {
+            if (node.type !== 'item')
+                continue;
+            for (const cutter of node.source?.manifest.cutters ?? []) {
+                const host = resolveCutterHost(node, cutter.host === 'mounted' ? 'cutout' : `cut:${cutter.host}`, args.nodes);
+                if (host)
+                    ids.push(host.id);
+            }
+        }
+        return ids;
+    },
     // 2D move-on-floorplan handler. Branches on `asset.attachTo`:
     // wall items snap to walls (like door / window), ceiling items
     // snap to ceiling polygons, floor items snap to slabs. attachTo
     // *transitions* (drop a wall item on a ceiling) remain canonical
     // in the 3D path; 2D only re-anchors within the same family.
     floorplanMoveTarget: itemFloorplanMoveTarget,
+    placementNotice: itemPlacementNotice,
+    keyboardActions: {
+        e: {
+            appliesTo: (node) => itemMechanism.has(node) || itemHasLights(node),
+            // Same as the action bar: mechanisms when the item has them, otherwise its light.
+            run: (node) => itemMechanism.has(node) ? toggleMechanism(itemMechanism, node) : toggleItemLights(node),
+        },
+    },
     toolHints: [
         { key: 'Left click', label: 'Place item' },
         { key: 'R / T', label: 'Rotate' },

package/dist/item/floorplan-move.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"floorplan-move.d.ts","sourceRoot":"","sources":["../../src/item/floorplan-move.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,SAAS,EACd,KAAK,WAAW,EAGhB,KAAK,mBAAmB,EAKxB,KAAK,QAAQ,EAQd,MAAM,kBAAkB,CAAA;AAkLzB,eAAO,MAAM,uBAAuB,EAAE,mBAAmB,CAAC,QAAQ,CA+BjE,CAAA;AAoOD;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,EAChC,KAAK,EAAE,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,EACjC,aAAa,EAAE,SAAS,GAAG,IAAI,EAC/B,UAAU,EAAE,SAAS,GACpB,WAAW,GAAG,IAAI,CAwBpB"}
+{"version":3,"file":"floorplan-move.d.ts","sourceRoot":"","sources":["../../src/item/floorplan-move.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,SAAS,EACd,KAAK,WAAW,EAMhB,KAAK,mBAAmB,EAKxB,KAAK,QAAQ,EAQd,MAAM,kBAAkB,CAAA;AA+EzB,eAAO,MAAM,uBAAuB,EAAE,mBAAmB,CAAC,QAAQ,CA+BjE,CAAA;AAgaD;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,EAChC,KAAK,EAAE,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,EACjC,aAAa,EAAE,SAAS,GAAG,IAAI,EAC/B,UAAU,EAAE,SAAS,GACpB,WAAW,GAAG,IAAI,CAwBpB"}