@hatiolab/figure-model 0.1.76 → 0.1.78

package/dist/v3-from-v2.d.ts

@@ -1,203 +0,0 @@
-import { type V3WorldBox } from './v3-gate.ts';
-import { type InstanceScale } from './sizing.ts';
-import type { AnimationChannel, Axis, FigureSource, Vec3 } from './types.ts';
-import type { V3Asset } from './v3-asset-types.ts';
-/** A rule the converter cannot write in V3. The asset is not converted. */
-export interface V3ConversionRefusal {
-    code: string;
-    part?: string;
-    detail: string;
-}
-/** Something the V3 asset does not carry over from the V2 source. Listed, never dropped quietly. */
-export interface V3ConversionLoss {
-    code: string;
-    part?: string;
-    detail: string;
-}
-/**
- * Something the converter normalised on purpose, with the value before and after. Not a loss: the V3 asset draws
- * what V2 drew. The report keeps it so nobody has to rediscover why a number differs from the source.
- */
-export interface V3ConversionNote {
-    code: string;
-    part?: string;
-    detail: string;
-}
-/**
- * How the V3 asset was produced: written by the converter from the V2 rules, or re-authored by a person
- * (ADR-0087 ruling 1). This says nothing about whether it matches or what was lost; those are `compareV2WithV3`
- * and `lost` / `rangeChanges` (designer's ruling, 2026-09-22: method, verification and preservation are three
- * separate facts).
- */
-export type V3ConversionMethod = 'mechanical' | 're-authored';
-/**
- * A change to the range of inputs the asset accepts, compared with V2. This is a behaviour-contract change, not a
- * remark: an instance V2 drew (however badly) is one V3 refuses.
- */
-export interface V3RangeChange {
-    input: string;
-    /** What V2 accepted, in words. */
-    v2: string;
-    /** The V3 input range. */
-    v3: {
-        min: number;
-        max: number;
-    };
-    part?: string;
-    reason: string;
-}
-export type V3ConversionResult = {
-    status: 'converted';
-    method: V3ConversionMethod;
-    asset: V3Asset;
-    lost: V3ConversionLoss[];
-    rangeChanges: V3RangeChange[];
-    notes: V3ConversionNote[];
-} | {
-    status: 'refused';
-    refusals: V3ConversionRefusal[];
-    lost: V3ConversionLoss[];
-    rangeChanges: V3RangeChange[];
-    notes: V3ConversionNote[];
-};
-export interface V3ConversionOptions {
-    /** Colour of every palette token the source uses. The converter invents no colours. */
-    palette: Record<string, string>;
-    /** What that palette is called, for the report (ADR-0087 ruling 5). Without it the report carries a hash. */
-    paletteId?: string;
-    /** Asset name. Defaults to the V2 `type`. */
-    name?: string;
-    /**
-     * Re-authoring the converter may do for a person (ADR-0087 ruling 1, V3 designer's approval 2026-09-22 for
-     * candidates). `rotatedFollows: 'nearest-axis'`: a part rotated off the axes whose size follows the instance is
-     * given rigid dimensions that follow the world axis each local axis lies nearest to, instead of V2's shear. The
-     * result is marked `re-authored`, matches V2 where the in-plane factors agree, and differs elsewhere by design.
-     */
-    reauthor?: {
-        rotatedFollows?: 'nearest-axis';
-        /**
-         * Re-authoring a tilted part as rigid and fastened to what it is mounted on (designer's ruling
-         * 2026-09-22: keep the shape and the tilt, connect it to its mounting).
-         *
-         * V2 makes such a part follow the instance, and a rotation that mixes two axes scaling differently shears
-         * it. V2 has no rule for "the position follows but the size does not", so this cannot be said in a V2
-         * source; it is said here. The part keeps its authored dimensions and tilt, and its centre rides the named
-         * part's face, so the gap between them is the gap the author drew at every instance size.
-         */
-        attach?: Array<{
-            part: string;
-            to: string;
-        }>;
-    };
-    /**
-     * What the figure declares it occupies (V3 designer's ruling 2026-09-22).
-     *
-     * `'authored'` (the default) keeps V2's box: the declared volume is the authored size, so a part that
-     * reaches past it is still reported by the gate. Conversion stays faithful and the existing debt stays
-     * visible.
-     *
-     * `'measured'` declares the volume the parts actually need, as an expression in the size. This changes what
-     * the figure tells a scene it fills, so it is a deliberate act per asset, not something conversion does on
-     * its own.
-     */
-    occupancy?: 'authored' | 'measured';
-}
-/** A short stable fingerprint of the palette, so a report can say which colours it snapshotted. */
-export declare function paletteHash(palette: Record<string, string>): string;
-/** The V3 design inputs that stand for the instance size, in mm. */
-export declare const V3_SIZE_INPUTS: Readonly<Record<Axis, string>>;
-/** Rx·Ry·Rz for degrees, the order V2 (`three` 'XYZ') and V3 `rigid@1` share. */
-export declare function eulerXYZ(rotation: Partial<Vec3> | undefined): number[][];
-/**
- * Convert one validated V2 source to a V3 asset that places every part where V2 places it, at every
- * instance size in the input range. See the file comment for what is refused and what is listed as lost.
- */
-export declare function convertV2ToV3(source: unknown, options: V3ConversionOptions): V3ConversionResult;
-/** One placed body in the world, from either side, in the bottom-origin asset frame. */
-export type WorldBox = V3WorldBox;
-/** Values that move a V2 figure: parameter values by name and, per animation clip, an elapsed time in seconds. */
-export interface V2MotionState {
-    parameters?: Record<string, number>;
-    clipTime?: Record<string, number>;
-}
-type Mat = number[][];
-/** Rotation about a unit axis by degrees (Rodrigues), the matrix three's setFromAxisAngle builds. */
-export declare function axisAngle(axis: Vec3, deg: number): Mat;
-/** V2's clip length: the last key time across its channels, in seconds. */
-export declare function v2ClipDuration(clip: {
-    channels: AnimationChannel[];
-}): number;
-/**
- * Where V2 draws every part (and copy) at an instance scale and a motion state, as oriented world boxes.
- * Motion follows things-scene: a translation channel shifts the part in the figure frame by the part's world
- * factor; a rotation channel turns it about its own centre in its own frame (R_part·R_ch·R_part⁻¹); a joint turns
- * everything in its frame about its sized origin, parents first (ADR-0066).
- */
-export declare function v2WorldBoxes(source: FigureSource, scale: InstanceScale, state?: V2MotionState, options?: {
-    points?: boolean;
-}): WorldBox[];
-/** Where a converted V3 asset draws every part at an instance size, as world boxes. */
-export declare function v3WorldBoxes(asset: V3Asset, size: Vec3, stateOverrides?: Record<string, number>, options?: {
-    points?: boolean;
-}): WorldBox[];
-/**
- * Instance scales at which a repeated part's copy count changes, one just below and one just above each
- * boundary near the base count (completion criterion: repeat-count boundaries).
- */
-export declare function repeatBoundaryScales(source: FigureSource): InstanceScale[];
-export interface V3SameDifference {
-    part: string;
-    scale: InstanceScale;
-    /** Which motion state was being compared; `rest` when none. */
-    state: string;
-    what: string;
-    v2: string;
-    v3: string;
-}
-export interface V3SameReport {
-    /** True when no difference was found over the checked scales and states. Not a guarantee over all inputs. */
-    same: boolean;
-    /** Instance scales checked. */
-    scales: InstanceScale[];
-    /** Motion states checked; `rest` is always first. */
-    states: string[];
-    boxesCompared: number;
-    /**
-     * How the surfaces were sampled, so the report says what a Hausdorff gap under tolerance does and does not
-     * prove: a bound at these sample points, not the maximum error over the whole surface.
-     */
-    sampling: {
-        toleranceMm: number;
-        toleranceDeg: number;
-        mesh: boolean;
-        cornerDivisions: number;
-        sphereGrid: string;
-        cylinderSegments: string;
-    };
-    differences: V3SameDifference[];
-}
-export declare const SAME_TOLERANCE_MM = 1;
-export declare const SAME_TOLERANCE_DEG = 0.1;
-export interface V3CompareOptions {
-    factor?: number;
-    /** Also check at half size on every axis combination (completion criterion: shrunken sizes). */
-    shrink?: boolean;
-    /** Extra instance scales, e.g. `repeatBoundaryScales(source)`. */
-    extraScales?: InstanceScale[];
-    /** Compare sampled surfaces too, not only oriented boxes. Default true. */
-    mesh?: boolean;
-    /** Motion states to compare beyond rest, each with a label for the report. */
-    states?: Array<{
-        label: string;
-    } & V2MotionState>;
-}
-/** The V3 state overrides that stand for a V2 motion state: parameters by name, drivers at their clip's time. */
-export declare function v3StateOverrides(asset: V3Asset, state: V2MotionState): Record<string, number>;
-/**
- * "The same" (ADR-0087 decision 2): the V2 source and the V3 asset draw the same parts, each with the same
- * centre and local dimensions within 1 mm and the same rotation within 0.1° (as a relative angle), with the same
- * material, at the base size and at every combination of doubled axes, at rest and at every motion state given.
- */
-export declare function compareV2WithV3(source: FigureSource, asset: V3Asset, options?: V3CompareOptions | number): V3SameReport;
-export {};
-//# sourceMappingURL=v3-from-v2.d.ts.map

package/dist/v3-from-v2.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"v3-from-v2.d.ts","sourceRoot":"","sources":["../src/v3-from-v2.ts"],"names":[],"mappings":"AA+BA,OAAO,EAA+B,KAAK,UAAU,EAAE,MAAM,cAAc,CAAA;AAK3E,OAAO,EAQL,KAAK,aAAa,EACnB,MAAM,aAAa,CAAA;AAEpB,OAAO,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAqD,YAAY,EAAgB,IAAI,EAAE,MAAM,YAAY,CAAA;AAC7I,OAAO,KAAK,EAAE,OAAO,EAAmD,MAAM,qBAAqB,CAAA;AAMnG,2EAA2E;AAC3E,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACf;AAED,oGAAoG;AACpG,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAAG,aAAa,CAAA;AAE7D;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAA;IACb,kCAAkC;IAClC,EAAE,EAAE,MAAM,CAAA;IACV,0BAA0B;IAC1B,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAA;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,kBAAkB,GAC1B;IAAE,MAAM,EAAE,WAAW,CAAC;IAAC,MAAM,EAAE,kBAAkB,CAAC;IAAC,KAAK,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAAC,YAAY,EAAE,aAAa,EAAE,CAAC;IAAC,KAAK,EAAE,gBAAgB,EAAE,CAAA;CAAE,GACvJ;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,QAAQ,EAAE,mBAAmB,EAAE,CAAC;IAAC,IAAI,EAAE,gBAAgB,EAAE,CAAC;IAAC,YAAY,EAAE,aAAa,EAAE,CAAC;IAAC,KAAK,EAAE,gBAAgB,EAAE,CAAA;CAAE,CAAA;AAE9I,MAAM,WAAW,mBAAmB;IAClC,uFAAuF;IACvF,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,6GAA6G;IAC7G,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,6CAA6C;IAC7C,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;;;OAKG;IACH,QAAQ,CAAC,EAAE;QACT,cAAc,CAAC,EAAE,cAAc,CAAA;QAC/B;;;;;;;;WAQG;QACH,MAAM,CAAC,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,EAAE,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;KAC7C,CAAA;IACD;;;;;;;;;;OAUG;IACH,SAAS,CAAC,EAAE,UAAU,GAAG,UAAU,CAAA;CACpC;AAED,mGAAmG;AACnG,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAKnE;AAED,oEAAoE;AACpE,eAAO,MAAM,cAAc,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAA4D,CAAA;AA4EtH,iFAAiF;AACjF,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,GAAG,MAAM,EAAE,EAAE,CAaxE;AAyFD;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,mBAAmB,GAAG,kBAAkB,CAuqB/F;AAkUD,wFAAwF;AACxF,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAA;AAEjC,kHAAkH;AAClH,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAClC;AAED,KAAK,GAAG,GAAG,MAAM,EAAE,EAAE,CAAA;AAKrB,qGAAqG;AACrG,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,GAAG,CAYtD;AAqBD,2EAA2E;AAC3E,wBAAgB,cAAc,CAAC,IAAI,EAAE;IAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAA;CAAE,GAAG,MAAM,CAO7E;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,GAAE,aAAkB,EAAE,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAO,GAAG,QAAQ,EAAE,CAsKlJ;AAOD,uFAAuF;AACvF,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,EAAE,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAO,GAAG,QAAQ,EAAE,CAIpJ;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,YAAY,GAAG,aAAa,EAAE,CAiB1E;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,aAAa,CAAA;IACpB,+DAA+D;IAC/D,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,EAAE,EAAE,MAAM,CAAA;CACX;AAED,MAAM,WAAW,YAAY;IAC3B,6GAA6G;IAC7G,IAAI,EAAE,OAAO,CAAA;IACb,+BAA+B;IAC/B,MAAM,EAAE,aAAa,EAAE,CAAA;IACvB,qDAAqD;IACrD,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,QAAQ,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,OAAO,CAAC;QAAC,eAAe,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,gBAAgB,EAAE,MAAM,CAAA;KAAE,CAAA;IAC7I,WAAW,EAAE,gBAAgB,EAAE,CAAA;CAChC;AAKD,eAAO,MAAM,iBAAiB,IAAI,CAAA;AAClC,eAAO,MAAM,kBAAkB,MAAM,CAAA;AAErC,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,gGAAgG;IAChG,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,kEAAkE;IAClE,WAAW,CAAC,EAAE,aAAa,EAAE,CAAA;IAC7B,2EAA2E;IAC3E,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,8EAA8E;IAC9E,MAAM,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,aAAa,CAAC,CAAA;CAClD;AAED,iHAAiH;AACjH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAU7F;AAUD;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,GAAE,gBAAgB,GAAG,MAAW,GAAG,YAAY,CAsF3H"}