@things-factory/figure-ui 10.1.198 → 10.1.201

package/dist-client/modeller/links.d.ts

@@ -1,5 +1,6 @@
+import { figureJointAsFixed } from '@hatiolab/figure-model';
 import type { FigureFollow, FigureSizeRange } from '@hatiolab/figure-model';
-import type { FigureAsset, FigureAuthoringAction, FigureBindingPlace, FigureFace, FigureJoint } from '@hatiolab/figure-model';
+import type { FigureAsset, FigureAuthoringAction, FigureBindingPlace, FigureFace, FigureFacing, FigureJoint } from '@hatiolab/figure-model';
 import { type FigureRevision } from './revision.js';
 import { type JointAxisVector } from './joint-axis.js';
 export type Axis = 'x' | 'y' | 'z';
@@ -27,7 +28,7 @@ export declare function heldBy(asset: FigureAsset, part: string): {
 } | {
     plane: true;
 } | null;
-/** The word for where a joint end sits: its face's, or the part's origin for an end placed by it (ADR-0107 decision 4). */
+/** The word for where a joint's body0 end sits: its face's, or the part's origin for an end placed by it (ADR-0107 decision 4). */
 export declare const endPlaceKeyOf: (end: object) => string;
 /** Whether a dimension of this part can follow something — box-shaped, whose three sizes are X, Y and Z. */
 export declare function canFollow(asset: FigureAsset, part: string): boolean;
@@ -126,35 +127,30 @@ export type Alignment = 'centre' | 'min' | 'max' | 'mm' | 'share' | 'input';
  */
 /**
  * The mounting plane of this figure, by its placement (ADR-0093): the floor or the ceiling is Y = 0 and a part stands
- * on it by its bottom or hangs from it by its top; a wall is Z = 0 and a part is fastened to it by its back.
+ * on it or hangs below it; a wall is Z = 0 and a part stands out of it (ADR-0140 3.11).
  */
 export declare function mountingPlaneOf(asset: FigureAsset): {
     normal: Axis;
-    faces: FigureFace[];
+    facings: FigureFacing[];
 };
-export declare function alignAxesOf(asset: FigureAsset, part: string, target: {
+export declare function alignAxesOf(asset: FigureAsset, target: {
     part: string;
     face: string;
-} | 'plane', twisted?: boolean): {
+} | 'plane'): {
     axis: Axis;
     edges: boolean;
 }[];
-/**
- * The faces of its own a part may be fastened by: its outer faces -- on the mounting plane only the ones the plane takes
- * (a bottom or a top on the floor, a back on a wall) -- and, to another part, its centre, which a roller spins about.
- */
-export declare function ownFacesOf(asset: FigureAsset, part: string, toPlane: boolean): Array<FigureFace | 'centre'>;
 /**
  * The axes across the face the fastening form asks about in rows: only where the face drawing (`view`, its axes) cannot
  * set the place -- no drawing at all, an axis it does not draw, a place that follows a position field, or one the
  * figure's size may scale.
  */
-export declare function alignRowsOf(asset: FigureAsset, part: string, aim: {
+export declare function alignRowsOf(asset: FigureAsset, aim: {
     part: string;
     face: string;
 } | 'plane', view: {
     axes: readonly Axis[];
-} | undefined, twisted: boolean, alignInput?: Partial<Record<Axis, string>>): {
+} | undefined, alignInput?: Partial<Record<Axis, string>>): {
     axis: Axis;
     edges: boolean;
 }[];
@@ -174,21 +170,19 @@ export declare function shownWhenOf(asset: FigureAsset, part: string): {
 /** Whether `part` hangs from `from`, through any number of fastenings. */
 export declare function hangsFrom(asset: FigureAsset, part: string, from: string): boolean;
 /**
- * The fastening a part has, as the fastening form holds it -- so the form opens on what is there (the face, including
- * \`centre\`, the target and its face, the gap, the twist and where across the face) and a change is a change to that.
+ * The fastening a part has, as the fastening form holds it -- so the form opens on what is there (the target and its
+ * face, how it meets it, the gap and where across the face) and a change is a change to that.
  * Opening it on the defaults showed a roller fastened by its centre as fastened by its bottom, and fastening again
  * from there broke its turning in place (walk 1, 2026-09-26). Null for a part fastened to nothing.
  */
 export declare function fasteningOf(revision: FigureRevision, part: string): {
-    face: string;
     toPlane: boolean;
     target: string;
     targetFace: string;
-    facing: 'meet' | 'flush';
+    facing: FigureFacing;
     gap: number;
     /** The record's gap when it is worked out (a length that follows something): kept as it is until a number is typed. */
     gapKept?: unknown;
-    twist: number;
     align: Partial<Record<Axis, Alignment>>;
     alignMm: Partial<Record<Axis, number>>;
     /** Placed by a part's origin (ADR-0107 decision 4): no face to fasten by, and the form does not write it. */
@@ -206,23 +200,22 @@ export declare function fastenGapOf(form: {
     gap?: unknown;
 };
 /**
- * The alignment that keeps the part where it stands when it is fastened: on each axis across the face, its distance
- * from the target's centre (the plane's is the origin). Fastening used to centre it -- a door set 100 mm in front of
- * its frame slid into it (2026-09-26). Left centred where it already is, and where the target stands turned.
+ * The alignment that keeps the part where it stands when it is fastened, as the form holds it: the kernel's place
+ * (`figureFastenKeptPlaceOf`, ADR-0140 3.7), a distance on each axis it is off the target's centre.
  */
 export declare function placeKeptOf(revision: FigureRevision, part: string, target: {
     part: string;
     face: string;
-} | 'plane', twisted?: boolean): {
+} | 'plane'): {
     align: Partial<Record<Axis, Alignment>>;
     alignMm: Partial<Record<Axis, number>>;
     alignInput: Partial<Record<Axis, string>>;
 };
 /** The `align` of an attach command from the form's choices: only the axes across that face, and centred ones left out. */
-export declare function alignOf(asset: FigureAsset, part: string, target: {
+export declare function alignOf(asset: FigureAsset, target: {
     part: string;
     face: string;
-} | 'plane', how: Partial<Record<Axis, Alignment>>, mm: Partial<Record<Axis, number>>, twisted?: boolean, inputs?: Partial<Record<Axis, string>>): Partial<Record<Axis, "min" | "max" | {
+} | 'plane', how: Partial<Record<Axis, Alignment>>, mm: Partial<Record<Axis, number>>, inputs?: Partial<Record<Axis, string>>): Partial<Record<Axis, "min" | "max" | {
     mm: number | {
         from: {
             of: "instance";
@@ -395,5 +388,5 @@ export declare function rangeDiffers(a: FigureSizeRange, b: FigureSizeRange): bo
  * architect's ruling 2026-09-24); the modeller proposes it, the author declares it.
  */
 export declare function turnsAboutAJoint(asset: FigureAsset): boolean;
-/** The joint made still: its fastening, its place and its row kept, its motion gone. */
-export declare function fixedJointOf(joint: FigureJoint): FigureJoint;
+/** The joint made still: its fastening, its place and its row kept, its motion gone (the kernel's `figureJointAsFixed`, ADR-0140 D6). */
+export declare const fixedJointOf: typeof figureJointAsFixed;

package/dist-client/modeller/links.js

@@ -1,4 +1,4 @@
-import { FIGURE_FACES, figureShapeFaces, figurePartsExtentOf, figureFollowOf, proposeFigureProportion, defaultInstanceSizeRange, foldInstanceSizeRange, figureAttachmentsOf, figureBindingsOf, figureInstanceSizeLimitsOf, figureFollowableAxesOf, figureShapeProviderOf, figureMimicTermsOf } from '@hatiolab/figure-model';
+import { figureShapeFaces, figurePartsExtentOf, figureFollowOf, proposeFigureProportion, defaultInstanceSizeRange, foldInstanceSizeRange, figureAttachmentsOf, figureBindingsOf, figureInstanceSizeLimitsOf, figureFollowableAxesOf, figureShapeProviderOf, figureMimicTermsOf, figureFastenKeptPlaceOf, figureFastenAxesOf, figureJointAsFixed, figureJointWithMotion } from '@hatiolab/figure-model';
 import { startingShapeKindOf } from './starting-shape.js';
 import { boxOf } from './align.js';
 import { graphValuesOf } from './revision.js';
@@ -32,7 +32,7 @@ export function heldBy(asset, part) {
     const to = fastenedTo(asset, part);
     return to ? { part: to } : null;
 }
-/** The word for where a joint end sits: its face's, or the part's origin for an end placed by it (ADR-0107 decision 4). */
+/** The word for where a joint's body0 end sits: its face's, or the part's origin for an end placed by it (ADR-0107 decision 4). */
 export const endPlaceKeyOf = (end) => ('face' in end ? `figure.label.face-${end.face}` : 'figure.label.joint-origin');
 /** Whether a dimension of this part can follow something — box-shaped, whose three sizes are X, Y and Z. */
 export function canFollow(asset, part) {
@@ -234,10 +234,9 @@ export function rowAxesOf(asset, part) {
     if (joints.some(o => 'part' in o.body0 && o.body0.part === part))
         return [];
     /* Placed by an origin: no face to lay the row across, and the kernel refuses it. */
-    const by = j.body1;
-    if (!('face' in j.body0) || !('face' in by))
+    if (!('face' in j.body0) || 'at' in j.body1)
         return [];
-    return AXES.filter(axis => axis !== FIGURE_FACES[by.face]);
+    return figureFastenAxesOf(asset, { part: j.body0.part, face: j.body0.face });
 }
 /**
  * Why a part cannot be made into a row here, in the terms `rowAxesOf` refuses it: said, not hidden (ADR-0097 §5.5).
@@ -254,7 +253,7 @@ export function rowBlockOf(asset, part) {
         return 'on-plane';
     if (joints.some(o => 'part' in o.body0 && o.body0.part === part))
         return 'holds-parts';
-    if (!('face' in j.body0) || !('face' in j.body1))
+    if (!('face' in j.body0) || 'at' in j.body1)
         return 'at-origin';
     return undefined;
 }
@@ -267,43 +266,26 @@ export const rowOf = (asset, part) => asset.joints?.find(o => o.body1.part === p
  */
 /**
  * The mounting plane of this figure, by its placement (ADR-0093): the floor or the ceiling is Y = 0 and a part stands
- * on it by its bottom or hangs from it by its top; a wall is Z = 0 and a part is fastened to it by its back.
+ * on it or hangs below it; a wall is Z = 0 and a part stands out of it (ADR-0140 3.11).
  */
 export function mountingPlaneOf(asset) {
-    return asset.placement === 'wall' ? { normal: 'z', faces: ['back'] } : { normal: 'y', faces: ['bottom', 'top'] };
+    return asset.placement === 'wall' ? { normal: 'z', facings: ['meet'] } : { normal: 'y', facings: ['meet', 'flush'] };
 }
-export function alignAxesOf(asset, part, target, twisted = false) {
+export function alignAxesOf(asset, target) {
     /* The plane has no edges, but a figure that declares its size has sides on it (figure-model 0.1.64). */
-    if (target === 'plane') {
-        const { normal } = mountingPlaneOf(asset);
-        return AXES.filter(axis => axis !== normal).map(axis => ({ axis, edges: !twisted && hasInstanceSize(asset, axis) }));
-    }
-    const along = faceAxisOf(asset, target.part, target.face);
-    if (!along)
-        return [];
-    const theirs = new Set(facesOf(asset, target.part)), mine = new Set(facesOf(asset, part));
-    /* A part twisted about the face's normal has no side level with the target's edges. */
-    return AXES.filter(axis => axis !== along).map(axis => ({ axis, edges: !twisted && OUTER[axis].every(f => theirs.has(f) && mine.has(f)) }));
-}
-/**
- * The faces of its own a part may be fastened by: its outer faces -- on the mounting plane only the ones the plane takes
- * (a bottom or a top on the floor, a back on a wall) -- and, to another part, its centre, which a roller spins about.
- */
-export function ownFacesOf(asset, part, toPlane) {
-    const outer = Object.keys(FIGURE_FACES);
-    const plane = mountingPlaneOf(asset);
-    return [
-        ...facesOf(asset, part).filter(face => outer.includes(face) && (!toPlane || plane.faces.includes(face))),
-        ...(toPlane ? [] : ['centre'])
-    ];
+    if (target === 'plane')
+        return figureFastenAxesOf(asset, 'plane').map(axis => ({ axis, edges: hasInstanceSize(asset, axis) }));
+    /* The part is lined up by its real extent in the pose it has (ADR-0140 3.4): the target's two sides are what it needs. */
+    const theirs = new Set(facesOf(asset, target.part));
+    return figureFastenAxesOf(asset, target).map(axis => ({ axis, edges: OUTER[axis].every(f => theirs.has(f)) }));
 }
 /**
  * The axes across the face the fastening form asks about in rows: only where the face drawing (`view`, its axes) cannot
  * set the place -- no drawing at all, an axis it does not draw, a place that follows a position field, or one the
  * figure's size may scale.
  */
-export function alignRowsOf(asset, part, aim, view, twisted, alignInput = {}) {
-    return alignAxesOf(asset, part, aim, twisted).filter(({ axis }) => !view || !view.axes.includes(axis) || !!alignInput[axis] || hasInstanceSize(asset, axis));
+export function alignRowsOf(asset, aim, view, alignInput = {}) {
+    return alignAxesOf(asset, aim).filter(({ axis }) => !view || !view.axes.includes(axis) || !!alignInput[axis] || hasInstanceSize(asset, axis));
 }
 /** The controls a part's showing can follow: the figure's state inputs, with their range and label. */
 export function visibilityControlsOf(asset) {
@@ -335,8 +317,8 @@ export function hangsFrom(asset, part, from) {
     return false;
 }
 /**
- * The fastening a part has, as the fastening form holds it -- so the form opens on what is there (the face, including
- * \`centre\`, the target and its face, the gap, the twist and where across the face) and a change is a change to that.
+ * The fastening a part has, as the fastening form holds it -- so the form opens on what is there (the target and its
+ * face, how it meets it, the gap and where across the face) and a change is a change to that.
  * Opening it on the defaults showed a roller fastened by its centre as fastened by its bottom, and fastening again
  * from there broke its turning in place (walk 1, 2026-09-26). Null for a part fastened to nothing.
  */
@@ -347,10 +329,9 @@ export function fasteningOf(revision, part) {
     const toPlane = 'plane' in record.body0;
     const target = 'part' in record.body0 ? record.body0.part : '';
     const targetFace = 'face' in record.body0 ? record.body0.face : 'top';
-    const atOrigin = !('plane' in record.body0) && (!('face' in record.body0) || !('face' in record.body1));
-    const twist = record.origin?.twist ?? 0;
+    const atOrigin = !('plane' in record.body0) && (!('face' in record.body0) || 'at' in record.body1);
     /* Where across the face: as the record says it, and where it says nothing, where the part stands now. */
-    const kept = placeKeptOf(revision, part, toPlane ? 'plane' : { part: target, face: targetFace }, !!twist);
+    const kept = placeKeptOf(revision, part, toPlane ? 'plane' : { part: target, face: targetFace });
     for (const [axis, how] of Object.entries(record.origin?.align ?? {})) {
         if (how === 'min' || how === 'max' || how === 'centre') {
             kept.align[axis] = how;
@@ -369,14 +350,12 @@ export function fasteningOf(revision, part) {
     }
     const gap = record.origin?.gap;
     return {
-        face: 'face' in record.body1 ? record.body1.face : 'centre',
         toPlane,
         target,
         targetFace,
         facing: record.origin?.facing ?? 'meet',
         gap: typeof gap === 'number' ? gap : 0,
         ...(gap !== undefined && typeof gap !== 'number' ? { gapKept: gap } : {}),
-        twist,
         ...kept,
         ...(atOrigin ? { atOrigin: true } : {})
     };
@@ -392,41 +371,17 @@ export function fastenGapOf(form) {
     return form.gap ? { gap: form.gap } : {};
 }
 /**
- * The alignment that keeps the part where it stands when it is fastened: on each axis across the face, its distance
- * from the target's centre (the plane's is the origin). Fastening used to centre it -- a door set 100 mm in front of
- * its frame slid into it (2026-09-26). Left centred where it already is, and where the target stands turned.
- */
-export function placeKeptOf(revision, part, target, twisted = false) {
-    const kept = { align: {}, alignMm: {}, alignInput: {} };
-    const asset = revision.asset;
-    /* Where it stands as drawn: the pose the command that fastens it sees. */
-    const geometry = revision.geometry;
-    const poseOf = (id) => geometry.find(g => g.id === id)?.pose;
-    const mine = poseOf(part);
-    if (!mine)
-        return kept;
-    let centre = [0, 0, 0];
-    if (target !== 'plane') {
-        const theirs = poseOf(target.part);
-        const upright = theirs?.r.every((row, i) => row.every((v, j) => Math.abs(v - (i === j ? 1 : 0)) < 1e-9));
-        if (!theirs || !upright)
-            return kept;
-        centre = theirs.t;
-    }
-    for (const { axis } of alignAxesOf(asset, part, target, twisted)) {
-        const k = AXES.indexOf(axis);
-        const off = Math.round((mine.t[k] - centre[k]) * 10) / 10;
-        if (Math.abs(off) < 0.5)
-            continue;
-        kept.align[axis] = 'mm';
-        kept.alignMm[axis] = off;
-    }
-    return kept;
+ * The alignment that keeps the part where it stands when it is fastened, as the form holds it: the kernel's place
+ * (`figureFastenKeptPlaceOf`, ADR-0140 3.7), a distance on each axis it is off the target's centre.
+ */
+export function placeKeptOf(revision, part, target) {
+    const alignMm = figureFastenKeptPlaceOf(revision.asset, part, target, { ...revision.inputs });
+    return { align: Object.fromEntries(Object.keys(alignMm).map(axis => [axis, 'mm'])), alignMm, alignInput: {} };
 }
 /** The `align` of an attach command from the form's choices: only the axes across that face, and centred ones left out. */
-export function alignOf(asset, part, target, how, mm, twisted = false, inputs = {}) {
+export function alignOf(asset, target, how, mm, inputs = {}) {
     const align = {};
-    for (const { axis, edges } of alignAxesOf(asset, part, target, twisted)) {
+    for (const { axis, edges } of alignAxesOf(asset, target)) {
         const one = how[axis] ?? 'centre';
         const size = asset.designInputs[`size.${axis}`];
         if (one === 'share' && mm[axis] && hasInstanceSize(asset, axis) && size)
@@ -539,27 +494,23 @@ export function leadersFor(asset, part, kind) {
  * control or limits of its own — its range is the leader's times the multiplier.
  */
 export function motionJoint(joint, m, part) {
+    /* Where it is fastened -- its row and its frame's own words too -- is the kernel's to keep (`figureJointWithMotion`, ADR-0140 D6). */
     const moving = {
-        id: joint.id,
-        body0: joint.body0,
-        body1: joint.body1,
-        ...(joint.origin ? { origin: joint.origin } : {}),
-        /* A row keeps being a row when it is given a motion: dropped here, the row went with it (designer 2026-09-27). */
-        ...(joint.repeat ? { repeat: joint.repeat } : {}),
         type: m.kind === 'slide' ? 'prismatic' : 'revolute',
         axis: (m.axisVector ?? m.axis.toUpperCase())
     };
+    const given = (motion) => figureJointWithMotion(joint, { ...moving, ...motion });
     if (m.follow)
-        return { ...moving, mimic: { joint: m.follow, multiplier: m.multiplier, ...(m.offset ? { offset: m.offset } : {}) } };
+        return given({ mimic: { joint: m.follow, multiplier: m.multiplier, ...(m.offset ? { offset: m.offset } : {}) } });
     if (m.followSum)
-        return { ...moving, mimic: { sum: m.followSum, ...(m.offset ? { offset: m.offset } : {}) } };
+        return given({ mimic: { sum: m.followSum, ...(m.offset ? { offset: m.offset } : {}) } });
     if (m.kind === 'slide' && m.travelSum && !m.travel)
-        return { ...moving, travel: m.travelSum, state: { id: m.id || `${part}-${m.kind}` } };
+        return given({ travel: m.travelSum, state: { id: m.id || `${part}-${m.kind}` } });
     if (m.kind === 'slide' && m.travel) {
         const [of, axis] = m.travel.split(':');
-        return { ...moving, travel: { source: { of: 'part', part: of, axis: axis }, ...(m.travelPlus ? { plus: m.travelPlus } : {}) }, state: { id: m.id || `${part}-${m.kind}` } };
+        return given({ travel: { source: { of: 'part', part: of, axis: axis }, ...(m.travelPlus ? { plus: m.travelPlus } : {}) }, state: { id: m.id || `${part}-${m.kind}` } });
     }
-    return { ...moving, ...(m.kind === 'continuous' ? {} : { lowerLimit: m.min, upperLimit: m.max }), state: { id: m.id || `${part}-${m.kind}` } };
+    return given({ ...(m.kind === 'continuous' ? {} : { lowerLimit: m.min, upperLimit: m.max }), state: { id: m.id || `${part}-${m.kind}` } });
 }
 /**
  * Why the motion form cannot be saved as it stands, as the kernel would refuse it: a follower's multiplier that is not
@@ -727,15 +678,6 @@ export function rangeDiffers(a, b) {
 export function turnsAboutAJoint(asset) {
     return modelOf(asset).nodes.some(n => n.op === 'axis-turn@1');
 }
-/** The joint made still: its fastening, its place and its row kept, its motion gone. */
-export function fixedJointOf(joint) {
-    return {
-        id: joint.id,
-        type: 'fixed',
-        body0: joint.body0,
-        body1: joint.body1,
-        ...(joint.origin ? { origin: joint.origin } : {}),
-        ...(joint.repeat ? { repeat: joint.repeat } : {})
-    };
-}
+/** The joint made still: its fastening, its place and its row kept, its motion gone (the kernel's `figureJointAsFixed`, ADR-0140 D6). */
+export const fixedJointOf = figureJointAsFixed;
 //# sourceMappingURL=links.js.map