@reekon-tools/boldr-utils 1.6.39 → 1.7.0

package/dist/calculator/units.js

@@ -0,0 +1,137 @@
+import { create, all } from 'mathjs';
+import { DecimalTolerance, FractionalTolerance, Units, convertUnitsToReadableShort, } from '../types/firestore.js';
+import { convertMicrometers } from '../utils/micrometersToUnit.js';
+import { parseMeasurement } from '../utils/parseMeasurement.js';
+const math = create(all);
+const LENGTH_UNIT_INFO = {
+    [Units.Millimeters]: { dimension: 'length', mathUnit: 'mm', label: 'mm' },
+    [Units.Centimeters]: { dimension: 'length', mathUnit: 'cm', label: 'cm' },
+    [Units.Meters]: { dimension: 'length', mathUnit: 'm', label: 'm' },
+    [Units.Inches]: { dimension: 'length', mathUnit: 'in', label: 'in' },
+    [Units.FractionalInches]: {
+        dimension: 'length',
+        mathUnit: 'in',
+        label: 'in',
+    },
+    [Units.Feet]: { dimension: 'length', mathUnit: 'ft', label: 'ft' },
+    [Units.FeetInchesDecimal]: {
+        dimension: 'length',
+        mathUnit: 'ft',
+        label: 'ft-in',
+    },
+    [Units.FeetInchesFractional]: {
+        dimension: 'length',
+        mathUnit: 'ft',
+        label: 'ft-in',
+    },
+};
+export const CALCULATOR_UNIT_INFO = {
+    ...LENGTH_UNIT_INFO,
+    sq_mm: { dimension: 'area', mathUnit: 'mm^2', label: 'mm²' },
+    sq_cm: { dimension: 'area', mathUnit: 'cm^2', label: 'cm²' },
+    sq_m: { dimension: 'area', mathUnit: 'm^2', label: 'm²' },
+    sq_in: { dimension: 'area', mathUnit: 'in^2', label: 'in²' },
+    sq_ft: { dimension: 'area', mathUnit: 'ft^2', label: 'ft²' },
+    sq_yd: { dimension: 'area', mathUnit: 'yd^2', label: 'yd²' },
+    cu_mm: { dimension: 'volume', mathUnit: 'mm^3', label: 'mm³' },
+    cu_cm: { dimension: 'volume', mathUnit: 'cm^3', label: 'cm³' },
+    cu_m: { dimension: 'volume', mathUnit: 'm^3', label: 'm³' },
+    cu_in: { dimension: 'volume', mathUnit: 'in^3', label: 'in³' },
+    cu_ft: { dimension: 'volume', mathUnit: 'ft^3', label: 'ft³' },
+    cu_yd: { dimension: 'volume', mathUnit: 'yd^3', label: 'yd³' },
+    liter: { dimension: 'volume', mathUnit: 'L', label: 'L' },
+    gallon: { dimension: 'volume', mathUnit: 'gal', label: 'gal' },
+    deg: { dimension: 'angle', mathUnit: 'deg', label: '°' },
+    rad: { dimension: 'angle', mathUnit: 'rad', label: 'rad' },
+};
+/** The math.js token for a dimension's canonical unit. '' for dimensionless. */
+export const canonicalMathUnit = (dimension) => {
+    switch (dimension) {
+        case 'length':
+            return 'um';
+        case 'area':
+            return 'um^2';
+        case 'volume':
+            return 'um^3';
+        case 'angle':
+            return 'deg';
+        case 'none':
+            return '';
+    }
+};
+export const unitDimension = (unit) => CALCULATOR_UNIT_INFO[unit]?.dimension ?? 'none';
+export const unitsForDimension = (dimension) => Object.keys(CALCULATOR_UNIT_INFO).filter((u) => CALCULATOR_UNIT_INFO[u].dimension === dimension);
+/** Short label for a unit ('ft³', 'in', '°'). */
+export const calculatorUnitLabel = (unit) => {
+    const lengthLabel = convertUnitsToReadableShort(unit);
+    return CALCULATOR_UNIT_INFO[unit]?.label ?? lengthLabel ?? String(unit);
+};
+// All units here are pure scale factors relative to their canonical unit
+// (no affine offsets like °F), so conversion is a cached multiply.
+const factorCache = new Map();
+const canonicalFactor = (unit) => {
+    const cached = factorCache.get(unit);
+    if (cached != null)
+        return cached;
+    const info = CALCULATOR_UNIT_INFO[unit];
+    if (!info)
+        throw new Error(`Unknown calculator unit: ${unit}`);
+    const canonical = canonicalMathUnit(info.dimension);
+    const factor = canonical === '' ? 1 : math.unit(1, info.mathUnit).toNumber(canonical);
+    factorCache.set(unit, factor);
+    return factor;
+};
+/** Convert a display-unit numeric value to the dimension's canonical unit. */
+export const toCanonical = (value, unit) => value * canonicalFactor(unit);
+/** Convert a canonical value to a display-unit numeric value. */
+export const fromCanonical = (value, unit) => value / canonicalFactor(unit);
+const decimalPlaces = (tolerance) => 
+// '0.5' -> 1, '0.01' -> 2, ... (the string-length trick used app-wide).
+tolerance.length - 2;
+// "12 1/2" -> "12 + 1/2" (same normalization parseMeasurement applies).
+const normalizeMixedFraction = (input) => input.trim().replace(/(\d+)\s+(\d+)\/(\d+)/g, '$1 + $2/$3');
+/**
+ * Parse user input in a display unit into a canonical value. Accepts plain
+ * numbers, fractions and mixed numbers ("12 1/2"). Length units additionally
+ * accept a trailing unit token (delegated to parseMeasurement). Returns null
+ * on unparseable input.
+ */
+export const parseToCanonical = (input, unit) => {
+    const info = CALCULATOR_UNIT_INFO[unit];
+    if (!info || input.trim() === '')
+        return null;
+    if (info.dimension === 'length') {
+        // parseMeasurement already returns micrometers (canonical).
+        return parseMeasurement(input, info.mathUnit);
+    }
+    try {
+        const result = math.evaluate(normalizeMixedFraction(input));
+        if (typeof result !== 'number' || !Number.isFinite(result))
+            return null;
+        return toCanonical(result, unit);
+    }
+    catch {
+        return null;
+    }
+};
+/**
+ * Format a canonical value for display in the given unit. Lengths delegate to
+ * convertMicrometers (the one place that renders fractional-inch / feet-inch
+ * strings); other dimensions format decimally per the decimal tolerance.
+ */
+export const formatCanonical = (value, unit, tolerances) => {
+    const fractional = tolerances?.fractionalTolerance ?? FractionalTolerance.Sixteenth;
+    const decimal = tolerances?.decimalTolerance ?? DecimalTolerance.Hundredth;
+    const info = CALCULATOR_UNIT_INFO[unit];
+    if (value == null || Number.isNaN(value) || !info) {
+        return { value: 'NaN', unit: info?.label ?? '' };
+    }
+    if (info.dimension === 'length') {
+        return convertMicrometers(value, unit, fractional, decimal);
+    }
+    const display = fromCanonical(value, unit);
+    return {
+        value: display.toFixed(decimalPlaces(decimal)),
+        unit: info.label,
+    };
+};

package/dist/calculator/validate.d.ts

@@ -0,0 +1,192 @@
+import { z } from 'zod';
+import { ColumnType, DecimalTolerance, FractionalTolerance } from '../types/firestore.js';
+export declare const calculatorDefinitionSchema: z.ZodObject<{
+    id: z.ZodString;
+    schemaVersion: z.ZodNumber;
+    version: z.ZodNumber;
+    name: z.ZodString;
+    description: z.ZodString;
+    folderId: z.ZodNullable<z.ZodString>;
+    fields: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        kind: z.ZodLiteral<ColumnType.Number>;
+        defaultValue: z.ZodOptional<z.ZodNumber>;
+        solve: z.ZodOptional<z.ZodObject<{
+            solvable: z.ZodBoolean;
+            governingEquationId: z.ZodOptional<z.ZodString>;
+            min: z.ZodOptional<z.ZodNumber>;
+            max: z.ZodOptional<z.ZodNumber>;
+            guess: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+        id: z.ZodString;
+        name: z.ZodString;
+        role: z.ZodEnum<{
+            input: "input";
+            output: "output";
+        }>;
+        description: z.ZodOptional<z.ZodString>;
+        binding: z.ZodOptional<z.ZodObject<{
+            hotspotId: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<ColumnType.Measurement>;
+        unit: z.ZodObject<{
+            dimension: z.ZodEnum<{
+                length: "length";
+                area: "area";
+                volume: "volume";
+            }>;
+            defaultUnit: z.ZodString;
+            allowedUnits: z.ZodArray<z.ZodString>;
+            fractionalTolerance: z.ZodOptional<z.ZodEnum<typeof FractionalTolerance>>;
+            decimalTolerance: z.ZodOptional<z.ZodEnum<typeof DecimalTolerance>>;
+        }, z.core.$strip>;
+        defaultValue: z.ZodOptional<z.ZodNumber>;
+        solve: z.ZodOptional<z.ZodObject<{
+            solvable: z.ZodBoolean;
+            governingEquationId: z.ZodOptional<z.ZodString>;
+            min: z.ZodOptional<z.ZodNumber>;
+            max: z.ZodOptional<z.ZodNumber>;
+            guess: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+        id: z.ZodString;
+        name: z.ZodString;
+        role: z.ZodEnum<{
+            input: "input";
+            output: "output";
+        }>;
+        description: z.ZodOptional<z.ZodString>;
+        binding: z.ZodOptional<z.ZodObject<{
+            hotspotId: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<ColumnType.Angle>;
+        angleUnit: z.ZodOptional<z.ZodEnum<{
+            deg: "deg";
+            rad: "rad";
+        }>>;
+        defaultValue: z.ZodOptional<z.ZodNumber>;
+        solve: z.ZodOptional<z.ZodObject<{
+            solvable: z.ZodBoolean;
+            governingEquationId: z.ZodOptional<z.ZodString>;
+            min: z.ZodOptional<z.ZodNumber>;
+            max: z.ZodOptional<z.ZodNumber>;
+            guess: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+        id: z.ZodString;
+        name: z.ZodString;
+        role: z.ZodEnum<{
+            input: "input";
+            output: "output";
+        }>;
+        description: z.ZodOptional<z.ZodString>;
+        binding: z.ZodOptional<z.ZodObject<{
+            hotspotId: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<ColumnType.SingleSelect>;
+        columnData: z.ZodObject<{
+            options: z.ZodArray<z.ZodString>;
+        }, z.core.$strip>;
+        defaultValue: z.ZodOptional<z.ZodString>;
+        id: z.ZodString;
+        name: z.ZodString;
+        role: z.ZodEnum<{
+            input: "input";
+            output: "output";
+        }>;
+        description: z.ZodOptional<z.ZodString>;
+        binding: z.ZodOptional<z.ZodObject<{
+            hotspotId: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<ColumnType.MultiSelect>;
+        columnData: z.ZodObject<{
+            options: z.ZodArray<z.ZodString>;
+        }, z.core.$strip>;
+        defaultValue: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        id: z.ZodString;
+        name: z.ZodString;
+        role: z.ZodEnum<{
+            input: "input";
+            output: "output";
+        }>;
+        description: z.ZodOptional<z.ZodString>;
+        binding: z.ZodOptional<z.ZodObject<{
+            hotspotId: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<ColumnType.ConversionTable>;
+        columnData: z.ZodObject<{
+            conversions: z.ZodArray<z.ZodObject<{
+                label: z.ZodString;
+                value: z.ZodString;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+        defaultValue: z.ZodOptional<z.ZodString>;
+        id: z.ZodString;
+        name: z.ZodString;
+        role: z.ZodEnum<{
+            input: "input";
+            output: "output";
+        }>;
+        description: z.ZodOptional<z.ZodString>;
+        binding: z.ZodOptional<z.ZodObject<{
+            hotspotId: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>, z.ZodObject<{
+        kind: z.ZodLiteral<ColumnType.Instructions>;
+        columnData: z.ZodObject<{
+            text: z.ZodString;
+            textColor: z.ZodString;
+            backgroundColor: z.ZodString;
+        }, z.core.$strip>;
+        id: z.ZodString;
+        name: z.ZodString;
+        role: z.ZodEnum<{
+            input: "input";
+            output: "output";
+        }>;
+        description: z.ZodOptional<z.ZodString>;
+        binding: z.ZodOptional<z.ZodObject<{
+            hotspotId: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>], "kind">>;
+    equations: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        targetFieldId: z.ZodString;
+        expression: z.ZodString;
+        variableToFieldId: z.ZodRecord<z.ZodString, z.ZodString>;
+    }, z.core.$strip>>;
+    diagramFileId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    isPublic: z.ZodBoolean;
+    sharedUserIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    sharedOrgIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    createdBy: z.ZodOptional<z.ZodObject<{
+        userId: z.ZodString;
+        firstName: z.ZodOptional<z.ZodString>;
+        lastName: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    createdAt: z.ZodOptional<z.ZodUnknown>;
+    updatedAt: z.ZodOptional<z.ZodUnknown>;
+}, z.core.$strip>;
+export type IssueSeverity = 'error' | 'warning';
+export interface ValidationIssue {
+    code: string;
+    path: string;
+    message: string;
+    severity: IssueSeverity;
+}
+export interface ValidationResult {
+    /** True when there are no error-severity issues (warnings allowed). */
+    ok: boolean;
+    issues: ValidationIssue[];
+}
+/** Free variables of an expression (function names and constants excluded). */
+export declare const expressionSymbols: (expression: string) => {
+    ok: true;
+    symbols: string[];
+} | {
+    ok: false;
+    error: string;
+};
+export declare const validateCalculatorDefinition: (input: unknown) => ValidationResult;