@hatiolab/figure-model 0.5.0 → 0.5.2

package/dist/authoring-size.js

@@ -0,0 +1,140 @@
+/*
+ * Copyright © HatioLab Inc. All rights reserved.
+ */
+/*
+ * The size range a figure declares for its instances, and the check that a command keeps within it.
+ */
+import { figurePartsExtentOf } from "./gate.js";
+import { AXES } from "./words.js";
+import { FIGURE_INSTANCE_SIZE_INPUTS, figureInstanceSizeLimitsOf, foldInstanceSizeRange } from "./instance-size.js";
+import { fail, round6, sizeInputOf } from "./authoring-nodes.js";
+export function declareInstanceSize(asset, a) {
+    const m = asset.document.model;
+    const declared = AXES.filter(axis => sizeInputOf(m, axis));
+    if (declared.length && !a.replace)
+        fail('INSTANCE_SIZE_DECLARED', 'size', `the instance size is already declared (${declared.map(x => FIGURE_INSTANCE_SIZE_INPUTS[x]).join(', ')}); pass replace to change its range`);
+    if (!a.range || typeof a.range !== 'object')
+        fail('SCHEMA', 'size', 'a range per axis is required');
+    let measured;
+    const authoredOf = (axis) => {
+        const given = a.at?.[axis];
+        if (given !== undefined)
+            return given;
+        const existing = asset.designInputs[FIGURE_INSTANCE_SIZE_INPUTS[axis]];
+        if (typeof existing === 'number')
+            return existing;
+        /* The parts as they rest, not the room their joints carry them through (a door's swing). */
+        if (!measured)
+            measured = figurePartsExtentOf(asset);
+        return measured[axis];
+    };
+    for (const axis of AXES) {
+        const r = a.range[axis];
+        const at = authoredOf(axis);
+        const path = FIGURE_INSTANCE_SIZE_INPUTS[axis];
+        if (!r || ![r.min, r.max, at].every(Number.isFinite))
+            fail('SCHEMA', path, 'finite min, max and size required');
+        if (!(r.min > 0))
+            fail('INSTANCE_SIZE_RANGE', path, `the smallest size must be above zero; got ${r.min}`, {
+                reason: 'size-min-not-positive',
+                axis,
+                min: r.min
+            });
+        if (!(r.min <= at && at <= r.max))
+            fail('INSTANCE_SIZE_RANGE', path, `the authored size ${at} mm must lie within ${r.min}…${r.max} mm`, {
+                reason: 'size-outside-range',
+                axis,
+                at,
+                min: r.min,
+                max: r.max
+            });
+        const input = sizeInputOf(m, axis);
+        if (input)
+            Object.assign(input, { min: r.min, max: r.max });
+        else
+            m.inputs.push({ id: path, unit: 'mm', min: r.min, max: r.max, role: 'design' });
+        asset.designInputs[path] = at;
+    }
+    return asset;
+}
+/**
+ * Every command leaves a figure that can take each size it declares: the kernel is asked at the ends of the declared
+ * range, and a size the figure cannot take is refused by name with the size it can go to. This is where a link that
+ * makes a part 200 mm shorter than the instance is caught when the instance may be 1 mm wide — the kernel alone
+ * accepts it, and the board then fails to draw the figure at small sizes.
+ */
+/** Where the declared size range reaches past what the figure holds: per axis, the bound it would need, and who sets it. */
+function sizeRangeGaps(asset) {
+    const m = asset.document.model;
+    if (!AXES.every(axis => sizeInputOf(m, axis)))
+        return [];
+    const range = Object.fromEntries(AXES.map(axis => [axis, { min: sizeInputOf(m, axis).min, max: sizeInputOf(m, axis).max }]));
+    const limits = figureInstanceSizeLimitsOf(asset, range);
+    const { range: holds } = foldInstanceSizeRange(range, limits);
+    const gaps = [];
+    for (const axis of AXES) {
+        const who = limits.find(l => l.axis === axis)?.part;
+        if (holds[axis].min > range[axis].min)
+            gaps.push({ axis, bound: 'min', need: holds[axis].min, declared: range[axis].min, who });
+        if (holds[axis].max < range[axis].max)
+            gaps.push({ axis, bound: 'max', need: holds[axis].max, declared: range[axis].max, who });
+    }
+    return gaps;
+}
+/** The declared size range folded to what the figure allows, as asked; the authored size must stay inside. */
+export function narrowDeclaredSize(asset) {
+    const m = asset.document.model;
+    /* A figure that declares no size has no range to reach past: there is nothing to narrow, and the link stands as it is. */
+    if (!AXES.every(axis => sizeInputOf(m, axis)))
+        return;
+    for (const gap of sizeRangeGaps(asset)) {
+        const input = sizeInputOf(m, gap.axis);
+        const at = asset.designInputs[FIGURE_INSTANCE_SIZE_INPUTS[gap.axis]];
+        if (gap.bound === 'min' ? at < gap.need : at > gap.need)
+            fail('INSTANCE_SIZE_RANGE', FIGURE_INSTANCE_SIZE_INPUTS[gap.axis], `the figure is authored at ${at} mm, where a length is already gone; change the link or the size`, {
+                reason: 'size-already-gone',
+                axis: gap.axis,
+                at,
+                bound: gap.bound,
+                need: gap.need
+            });
+        if (gap.bound === 'min')
+            input.min = gap.need;
+        else
+            input.max = gap.need;
+    }
+}
+/**
+ * After a command, the declared size range must still hold at its ends. A gap the figure already had before the
+ * command -- a range the conversion declared too wide (FORMATION_TRAY: X from 1 mm, its cells gone below 8.8 mm) -- is
+ * not the command's doing: it is refused only if it made a gap or widened one. Refusing every command for it had
+ * blocked even choosing a detail level (user, 2026-09-24).
+ */
+export function holdsOverDeclaredSize(asset, before) {
+    const now = sizeRangeGaps(asset);
+    if (!now.length)
+        return;
+    const was = before ? sizeRangeGaps(before) : [];
+    for (const gap of now) {
+        const prior = was.find(g => g.axis === gap.axis && g.bound === gap.bound);
+        const worse = !prior ||
+            (gap.bound === 'min'
+                ? gap.need > prior.need + 1e-9 || gap.declared < prior.declared
+                : gap.need < prior.need - 1e-9 || gap.declared > prior.declared);
+        if (!worse)
+            continue;
+        const path = FIGURE_INSTANCE_SIZE_INPUTS[gap.axis];
+        const by = gap.who ? ` (${gap.who})` : '';
+        const details = {
+            reason: 'size-cannot-reach',
+            axis: gap.axis,
+            bound: gap.bound,
+            need: round6(gap.need),
+            ...(gap.who ? { part: gap.who } : {})
+        };
+        if (gap.bound === 'min')
+            fail('INSTANCE_SIZE_RANGE', path, `below ${round6(gap.need)} mm a length goes to zero${by}; declare the smallest size at ${round6(gap.need)} mm or more`, details);
+        fail('INSTANCE_SIZE_RANGE', path, `above ${round6(gap.need)} mm the figure cannot be drawn${by}; declare the largest size at ${round6(gap.need)} mm or less`, details);
+    }
+}
+//# sourceMappingURL=authoring-size.js.map

package/dist/authoring-size.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authoring-size.js","sourceRoot":"","sources":["../src/authoring-size.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AAE/C,OAAO,EAAE,IAAI,EAAa,MAAM,YAAY,CAAA;AAC5C,OAAO,EACL,2BAA2B,EAE3B,0BAA0B,EAC1B,qBAAqB,EACtB,MAAM,oBAAoB,CAAA;AAG3B,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAIhE,MAAM,UAAU,mBAAmB,CACjC,KAAc,EACd,CAAoE;IAEpE,MAAM,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAA;IAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;IAC1D,IAAI,QAAQ,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,OAAO;QAC/B,IAAI,CACF,wBAAwB,EACxB,MAAM,EACN,0CAA0C,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,2BAA2B,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,qCAAqC,CAC5I,CAAA;IACH,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ;QAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,8BAA8B,CAAC,CAAA;IACnG,IAAI,QAA0C,CAAA;IAC9C,MAAM,UAAU,GAAG,CAAC,IAAU,EAAU,EAAE;QACxC,MAAM,KAAK,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAA;QAC1B,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,KAAK,CAAA;QACrC,MAAM,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC,CAAA;QACtE,IAAI,OAAO,QAAQ,KAAK,QAAQ;YAAE,OAAO,QAAQ,CAAA;QACjD,4FAA4F;QAC5F,IAAI,CAAC,QAAQ;YAAE,QAAQ,GAAG,mBAAmB,CAAC,KAAoB,CAAC,CAAA;QACnE,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAA;IACvB,CAAC,CAAA;IACD,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;QACxB,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACvB,MAAM,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC,CAAA;QAC3B,MAAM,IAAI,GAAG,2BAA2B,CAAC,IAAI,CAAC,CAAA;QAC9C,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC;YAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,mCAAmC,CAAC,CAAA;QAC/G,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;YACd,IAAI,CAAC,qBAAqB,EAAE,IAAI,EAAE,6CAA6C,CAAC,CAAC,GAAG,EAAE,EAAE;gBACtF,MAAM,EAAE,uBAAuB;gBAC/B,IAAI;gBACJ,GAAG,EAAE,CAAC,CAAC,GAAG;aACX,CAAC,CAAA;QACJ,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC;YAC/B,IAAI,CAAC,qBAAqB,EAAE,IAAI,EAAE,qBAAqB,EAAE,uBAAuB,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,KAAK,EAAE;gBACnG,MAAM,EAAE,oBAAoB;gBAC5B,IAAI;gBACJ,EAAE;gBACF,GAAG,EAAE,CAAC,CAAC,GAAG;gBACV,GAAG,EAAE,CAAC,CAAC,GAAG;aACX,CAAC,CAAA;QACJ,MAAM,KAAK,GAAG,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,CAAA;QAClC,IAAI,KAAK;YAAE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAA;;YACtD,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAA;QACpF,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,CAAA;IAC/B,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;;;GAKG;AACH,4HAA4H;AAC5H,SAAS,aAAa,CACpB,KAAkB;IAElB,MAAM,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAgB,CAAA;IACzC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QAAE,OAAO,EAAE,CAAA;IACxD,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAC9B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CACxE,CAAA;IACpB,MAAM,MAAM,GAAG,0BAA0B,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;IACvD,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,qBAAqB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;IAC7D,MAAM,IAAI,GAA8F,EAAE,CAAA;IAC1G,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;QACxB,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,IAAI,CAAA;QACnD,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG;YACnC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAA;QAC1F,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG;YACnC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAA;IAC5F,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,8GAA8G;AAC9G,MAAM,UAAU,kBAAkB,CAAC,KAAc;IAC/C,MAAM,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAA;IAC9B,0HAA0H;IAC1H,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QAAE,OAAM;IACrD,KAAK,MAAM,GAAG,IAAI,aAAa,CAAC,KAAoB,CAAC,EAAE,CAAC;QACtD,MAAM,KAAK,GAAG,WAAW,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,CAAA;QACtC,MAAM,EAAE,GAAG,KAAK,CAAC,YAAY,CAAC,2BAA2B,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA;QACpE,IAAI,GAAG,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI;YACrD,IAAI,CACF,qBAAqB,EACrB,2BAA2B,CAAC,GAAG,CAAC,IAAI,CAAC,EACrC,6BAA6B,EAAE,kEAAkE,EACjG;gBACE,MAAM,EAAE,mBAAmB;gBAC3B,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,EAAE;gBACF,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,IAAI,EAAE,GAAG,CAAC,IAAI;aACf,CACF,CAAA;QACH,IAAI,GAAG,CAAC,KAAK,KAAK,KAAK;YAAE,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC,IAAI,CAAA;;YACxC,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC,IAAI,CAAA;IAC3B,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAC,KAAkB,EAAE,MAAoB;IAC5E,MAAM,GAAG,GAAG,aAAa,CAAC,KAAK,CAAC,CAAA;IAChC,IAAI,CAAC,GAAG,CAAC,MAAM;QAAE,OAAM;IACvB,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAC/C,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;QACtB,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,KAAK,KAAK,GAAG,CAAC,KAAK,CAAC,CAAA;QACzE,MAAM,KAAK,GACT,CAAC,KAAK;YACN,CAAC,GAAG,CAAC,KAAK,KAAK,KAAK;gBAClB,CAAC,CAAC,GAAG,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,GAAG,IAAI,IAAI,GAAG,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ;gBAC/D,CAAC,CAAC,GAAG,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,GAAG,IAAI,IAAI,GAAG,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAA;QACpE,IAAI,CAAC,KAAK;YAAE,SAAQ;QACpB,MAAM,IAAI,GAAG,2BAA2B,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QAClD,MAAM,EAAE,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;QACzC,MAAM,OAAO,GAAyB;YACpC,MAAM,EAAE,mBAAmB;YAC3B,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC;YACtB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACtC,CAAA;QACD,IAAI,GAAG,CAAC,KAAK,KAAK,KAAK;YACrB,IAAI,CACF,qBAAqB,EACrB,IAAI,EACJ,SAAS,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,4BAA4B,EAAE,kCAAkC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,EACtH,OAAO,CACR,CAAA;QACH,IAAI,CACF,qBAAqB,EACrB,IAAI,EACJ,SAAS,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,iCAAiC,EAAE,iCAAiC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,EAC1H,OAAO,CACR,CAAA;IACH,CAAC;AACH,CAAC"}