@reekon-tools/boldr-utils 1.6.39 → 1.7.1

package/dist/calculator/evaluate.js

@@ -0,0 +1,207 @@
+import { create, all } from 'mathjs';
+import { ColumnType } from '../types/firestore.js';
+import { equationForField, findField } from './schema.js';
+// Trig in calculator equations works in DEGREES: angle fields are stored in
+// degrees canonically, and construction authors write `H = W * tan(A)`
+// expecting A in degrees. mathjs has no `angle` config option (evaluateFormula
+// passes `{ angle: 'deg' }`, but mathjs ignores it and runs radians), so we
+// override the trig functions with degree-aware wrappers — the documented
+// mathjs recipe for degree mode.
+const math = create(all);
+const DEG = Math.PI / 180;
+math.import({
+    sin: (x) => Math.sin(x * DEG),
+    cos: (x) => Math.cos(x * DEG),
+    tan: (x) => Math.tan(x * DEG),
+    sec: (x) => 1 / Math.cos(x * DEG),
+    csc: (x) => 1 / Math.sin(x * DEG),
+    cot: (x) => 1 / Math.tan(x * DEG),
+    asin: (x) => Math.asin(x) / DEG,
+    acos: (x) => Math.acos(x) / DEG,
+    atan: (x) => Math.atan(x) / DEG,
+    atan2: (y, x) => Math.atan2(y, x) / DEG,
+}, { override: true });
+const compile = math.compile.bind(math);
+// Small compile cache — the editor preview re-evaluates on every keystroke.
+const compileCache = new Map();
+const COMPILE_CACHE_MAX = 200;
+const compiled = (expression) => {
+    const hit = compileCache.get(expression);
+    if (hit)
+        return hit;
+    const node = compile(expression);
+    if (compileCache.size >= COMPILE_CACHE_MAX)
+        compileCache.clear();
+    compileCache.set(expression, node);
+    return node;
+};
+/**
+ * The unit-agnostic expression core: compile + evaluate + finiteness checks,
+ * no unit coercion. Scope values and the result share whatever unit system
+ * the caller established (canonical, for calculator equations).
+ */
+export const evaluateExpression = (expression, scope) => {
+    let node;
+    try {
+        node = compiled(expression);
+    }
+    catch (err) {
+        return {
+            ok: false,
+            error: `Invalid expression: ${err instanceof Error ? err.message : String(err)}`,
+        };
+    }
+    let result;
+    try {
+        // Spread so mathjs can't mutate the caller's scope.
+        result = node.evaluate({ ...scope });
+    }
+    catch (err) {
+        return {
+            ok: false,
+            error: `Evaluation failed: ${err instanceof Error ? err.message : String(err)}`,
+        };
+    }
+    if (typeof result !== 'number') {
+        return { ok: false, error: 'Expression did not produce a number' };
+    }
+    if (Number.isNaN(result))
+        return { ok: false, error: 'Result is NaN' };
+    if (!Number.isFinite(result)) {
+        return { ok: false, error: 'Result is not finite (division by zero?)' };
+    }
+    return { ok: true, value: result };
+};
+/**
+ * The canonical numeric value a field contributes to an equation scope, or
+ * null when the field has no usable value. Select and instructions fields are
+ * non-computational (validation rejects mapping them into equations).
+ */
+export const numericFieldValue = (field, value) => {
+    switch (field.kind) {
+        case ColumnType.Number:
+        case ColumnType.Measurement:
+        case ColumnType.Angle: {
+            const v = value ?? field.defaultValue;
+            return typeof v === 'number' && Number.isFinite(v) ? v : null;
+        }
+        case ColumnType.ConversionTable: {
+            // Value is the selected conversion's label; the numeric factor comes
+            // from the matched entry (Conversion.value is a string app-wide).
+            const label = value ?? field.defaultValue;
+            if (typeof label !== 'string')
+                return null;
+            const entry = field.columnData.conversions.find((c) => c.label === label);
+            if (!entry)
+                return null;
+            const parsed = parseFloat(entry.value);
+            return Number.isFinite(parsed) ? parsed : null;
+        }
+        default:
+            return null;
+    }
+};
+const evaluateEquationInContext = (equation, ctx) => {
+    const cached = ctx.cache.get(equation.id);
+    if (cached)
+        return cached;
+    if (ctx.stack.has(equation.id)) {
+        return {
+            ok: false,
+            reason: 'error',
+            error: `Circular equation reference involving ${equation.id}`,
+        };
+    }
+    ctx.stack.add(equation.id);
+    try {
+        const scope = {};
+        const missing = [];
+        for (const [variable, fieldId] of Object.entries(equation.variableToFieldId)) {
+            const resolved = resolveFieldNumeric(fieldId, ctx);
+            if (!resolved.ok) {
+                if (resolved.reason === 'missing-inputs') {
+                    missing.push(...resolved.missingFieldIds);
+                    continue;
+                }
+                return resolved;
+            }
+            scope[variable] = resolved.value;
+        }
+        if (missing.length > 0) {
+            const result = {
+                ok: false,
+                reason: 'missing-inputs',
+                missingFieldIds: [...new Set(missing)],
+            };
+            ctx.cache.set(equation.id, result);
+            return result;
+        }
+        const evaluated = evaluateExpression(equation.expression, scope);
+        const result = evaluated.ok
+            ? { ok: true, value: evaluated.value }
+            : { ok: false, reason: 'error', error: evaluated.error };
+        ctx.cache.set(equation.id, result);
+        return result;
+    }
+    finally {
+        ctx.stack.delete(equation.id);
+    }
+};
+// An output field with an equation resolves to its COMPUTED value; if the
+// computation is blocked on missing inputs but the user supplied a value for
+// the output directly (the two-way-solving posture), the supplied value is
+// used instead. Everything else resolves from `values`/defaults.
+const resolveFieldNumeric = (fieldId, ctx) => {
+    const field = findField(ctx.definition, fieldId);
+    if (!field) {
+        return {
+            ok: false,
+            reason: 'error',
+            error: `Equation references unknown field ${fieldId}`,
+        };
+    }
+    const equation = equationForField(ctx.definition, fieldId);
+    if (equation) {
+        const computed = evaluateEquationInContext(equation, ctx);
+        if (computed.ok)
+            return computed;
+        if (computed.reason === 'missing-inputs') {
+            const supplied = numericFieldValue(field, ctx.values[fieldId]);
+            if (supplied != null)
+                return { ok: true, value: supplied };
+        }
+        return computed;
+    }
+    const value = numericFieldValue(field, ctx.values[fieldId]);
+    if (value == null) {
+        return { ok: false, reason: 'missing-inputs', missingFieldIds: [fieldId] };
+    }
+    return { ok: true, value };
+};
+/**
+ * Evaluate one equation against canonical field values. Variables referencing
+ * other output fields recurse into their equations (cycle-guarded).
+ */
+export const evaluateEquation = ({ definition, equation, values, }) => evaluateEquationInContext(equation, {
+    definition,
+    values,
+    stack: new Set(),
+    cache: new Map(),
+});
+/**
+ * Evaluate every equation in the definition. Returns a result per target
+ * field id — the live-preview / runtime "recompute all outputs" entry point.
+ */
+export const evaluateOutputs = ({ definition, values, }) => {
+    const ctx = {
+        definition,
+        values,
+        stack: new Set(),
+        cache: new Map(),
+    };
+    const results = {};
+    for (const equation of definition.equations) {
+        results[equation.targetFieldId] = evaluateEquationInContext(equation, ctx);
+    }
+    return results;
+};

package/dist/calculator/index.d.ts

@@ -0,0 +1,6 @@
+export * from './schema.js';
+export * from './units.js';
+export * from './evaluate.js';
+export * from './solve.js';
+export * from './instance.js';
+export { calculatorDefinitionSchema, expressionSymbols, validateCalculatorDefinition, type IssueSeverity, type ValidationIssue, type ValidationResult, } from './validate.js';

package/dist/calculator/index.js

@@ -0,0 +1,10 @@
+// Construction Calculator shared module: the calculator-definition schema,
+// per-field unit system, forward evaluator, two-way numeric solver, and
+// definition validation. Pure logic (mathjs + zod only — no Skia/React), safe
+// on web, native, and Node.
+export * from './schema.js';
+export * from './units.js';
+export * from './evaluate.js';
+export * from './solve.js';
+export * from './instance.js';
+export { calculatorDefinitionSchema, expressionSymbols, validateCalculatorDefinition, } from './validate.js';

package/dist/calculator/instance.d.ts

@@ -0,0 +1,36 @@
+import type { AnnotationCanvasState } from '../types/annotation.js';
+import type { CalculatorDefinition } from './schema.js';
+import type { CalculatorUnit } from './units.js';
+export type CalculatorEntrySource = 'user' | 'tool';
+export interface CalculatorEntryAttribution {
+    deviceId: string;
+    deviceName: string | null;
+    userName: string | null;
+    /** Epoch ms. */
+    at: number;
+}
+export interface CalculatorFieldEntry {
+    value: number | string | string[];
+    source: CalculatorEntrySource;
+    attribution: CalculatorEntryAttribution | null;
+    /** Pinned: edits, clears, and tape readings are refused until unlocked. */
+    locked: boolean;
+    /** Epoch ms. */
+    enteredAt: number;
+}
+export interface CalculatorInstanceFileData {
+    /** Source doc id in the top-level `calculators` collection. */
+    calculatorId: string;
+    /** definition.version at save time. */
+    sourceVersion: number;
+    definition: CalculatorDefinition;
+    entries: Record<string, CalculatorFieldEntry>;
+    /** Session display-unit choices, keyed by field id. */
+    displayUnitOverrides?: Record<string, CalculatorUnit>;
+    /**
+     * Embedded copy of the source diagram canvas. Its background image is
+     * re-uploaded under the instance file's own Storage path (and
+     * viewport.backgroundImage.storagePath repointed) at save time.
+     */
+    canvas?: AnnotationCanvasState;
+}

package/dist/calculator/schema.d.ts

@@ -0,0 +1,163 @@
+import { ColumnType, type ColumnConfig, type ConversionTableColumnData, type InstructionsColumnData, type SelectColumnData, type DecimalTolerance, type FractionalTolerance } from '../types/firestore.js';
+import type { AngleUnit, CalculatorUnit, FieldDimension, MeasurementDimension } from './units.js';
+/**
+ * Version of the definition format itself. Bumped only on breaking schema
+ * changes; independent of the npm package version and of each calculator's
+ * own content `version`.
+ */
+export declare const CALCULATOR_SCHEMA_VERSION = 1;
+/**
+ * Which table a field appears in (the Figma mockup's Input Fields / Output
+ * Fields split). Mostly cosmetic: an input with solve hints can be computed
+ * from outputs at runtime, and outputs are just fields targeted by equations.
+ */
+export type FieldRole = 'input' | 'output';
+/** Field kinds reuse the app-wide ColumnType enum (calculator subset). */
+export type CalculatorFieldKind = ColumnType.Number | ColumnType.Measurement | ColumnType.Angle | ColumnType.SingleSelect | ColumnType.MultiSelect | ColumnType.ConversionTable | ColumnType.Instructions;
+export declare const CALCULATOR_FIELD_KINDS: CalculatorFieldKind[];
+/**
+ * Per-field unit configuration (templates have only a global user unit).
+ * `dimension` covers the volume-calculator case: inputs in inches, output in
+ * cubic feet — each field picks its own dimension and display units.
+ */
+export interface FieldUnitConfig {
+    dimension: MeasurementDimension;
+    /** Default display unit; must belong to `dimension`. */
+    defaultUnit: CalculatorUnit;
+    /** Units the runtime lets the user toggle between; must match `dimension`. */
+    allowedUnits: CalculatorUnit[];
+    fractionalTolerance?: FractionalTolerance;
+    decimalTolerance?: DecimalTolerance;
+}
+/**
+ * The schema half of two-way solving. A solvable field can be computed by
+ * numerically inverting its governing equation when the user supplies that
+ * equation's output value instead (see solve.ts). `min`/`max` bracket the
+ * root search in CANONICAL units; when absent the solver falls back to
+ * generous per-dimension defaults, so brackets are only needed to isolate a
+ * specific root (e.g. the positive branch of a quadratic) or to speed search.
+ */
+export interface SolveHints {
+    solvable: boolean;
+    /** The ONE equation numerically inverted for this field. */
+    governingEquationId?: string;
+    min?: number;
+    max?: number;
+    /** Optional Newton seed (canonical units). */
+    guess?: number;
+}
+/**
+ * Binds a field to a diagram hotspot. `hotspotId` is the id of the placed
+ * canvas tile — the tile itself carries the reverse link by storing the field
+ * id in `PlacedMeasurementRef.columnId` (the existing template-canvas
+ * column-anchor channel, reused with field-id semantics).
+ */
+export interface DiagramBinding {
+    hotspotId: string;
+}
+interface CalculatorFieldBase {
+    id: string;
+    name: string;
+    role: FieldRole;
+    description?: string;
+    binding?: DiagramBinding;
+}
+export type CalculatorField = CalculatorFieldBase & ({
+    kind: ColumnType.Number;
+    defaultValue?: number;
+    solve?: SolveHints;
+} | {
+    kind: ColumnType.Measurement;
+    unit: FieldUnitConfig;
+    /** Canonical (µm / µm² / µm³ per unit.dimension). */
+    defaultValue?: number;
+    solve?: SolveHints;
+} | {
+    kind: ColumnType.Angle;
+    /** Display unit; canonical storage is always degrees. */
+    angleUnit?: AngleUnit;
+    defaultValue?: number;
+    solve?: SolveHints;
+} | {
+    kind: ColumnType.SingleSelect;
+    columnData: SelectColumnData;
+    defaultValue?: string;
+} | {
+    kind: ColumnType.MultiSelect;
+    columnData: SelectColumnData;
+    defaultValue?: string[];
+} | {
+    kind: ColumnType.ConversionTable;
+    columnData: ConversionTableColumnData;
+    /** The selected conversion's label. */
+    defaultValue?: string;
+} | {
+    kind: ColumnType.Instructions;
+    columnData: InstructionsColumnData;
+});
+/**
+ * A forward equation computing one output field. Mirrors the existing
+ * `Formula` shape (`expression` + variable map), but variables bind to field
+ * ids and the equation lives inside the definition rather than in the org
+ * `formulas` collection. Variables may reference other OUTPUT fields — their
+ * equations are evaluated recursively (cycles are rejected by validation).
+ */
+export interface CalculatorEquation {
+    id: string;
+    /** The output field this equation computes. */
+    targetFieldId: string;
+    /** math.js forward expression, e.g. 'A * B * C'. */
+    expression: string;
+    /** Variable letter -> field id. */
+    variableToFieldId: Record<string, string>;
+}
+/** A runtime/preview value for one field, in canonical units. */
+export type CalculatorFieldValue = number | string | string[] | null;
+export type CalculatorValues = Record<string, CalculatorFieldValue>;
+export interface CalculatorDefinition {
+    id: string;
+    /** CALCULATOR_SCHEMA_VERSION captured at author time. */
+    schemaVersion: number;
+    /** Monotonic content revision; bumped on publish. Offline-cache key with updatedAt. */
+    version: number;
+    name: string;
+    description: string;
+    folderId: string | null;
+    /** Inputs + outputs in one list, discriminated by `role`. */
+    fields: CalculatorField[];
+    equations: CalculatorEquation[];
+    /** Diagram file (files subcollection doc carrying the Skia canvas). */
+    diagramFileId?: string | null;
+    /** Public calculators are readable by everyone; rules/query key. */
+    isPublic: boolean;
+    sharedUserIds?: string[];
+    sharedOrgIds?: string[];
+    createdBy?: {
+        userId: string;
+        firstName?: string;
+        lastName?: string;
+    };
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+export declare const fieldsByRole: (definition: Pick<CalculatorDefinition, "fields">, role: FieldRole) => CalculatorField[];
+export declare const findField: (definition: Pick<CalculatorDefinition, "fields">, fieldId: string) => CalculatorField | undefined;
+export declare const findEquation: (definition: Pick<CalculatorDefinition, "equations">, equationId: string) => CalculatorEquation | undefined;
+/** The equation targeting an output field, if any. */
+export declare const equationForField: (definition: Pick<CalculatorDefinition, "equations">, fieldId: string) => CalculatorEquation | undefined;
+/** The dimension a field's numeric value carries. */
+export declare const fieldDimension: (field: CalculatorField) => FieldDimension;
+/** Fields whose value participates in equations as a number. */
+export declare const isNumericFieldKind: (kind: CalculatorFieldKind) => kind is ColumnType.Number | ColumnType.Measurement | ColumnType.Angle | ColumnType.ConversionTable;
+/** Field kinds an equation may target (compute into). */
+export declare const isEquationTargetKind: (kind: CalculatorFieldKind) => kind is ColumnType.Number | ColumnType.Measurement | ColumnType.Angle;
+/**
+ * Synthesize a ColumnConfig for a field so the existing table/tile components
+ * (built around ColumnConfig) can render calculator fields unchanged.
+ */
+export declare const fieldToColumnConfig: (field: CalculatorField) => ColumnConfig;
+/** Default per-field unit config for a fresh measurement field. */
+export declare const defaultFieldUnitConfig: (dimension?: MeasurementDimension) => FieldUnitConfig;
+/** Seed for the create-new-calculator stub doc (mirrors the template flow). */
+export declare const createEmptyCalculatorDefinition: (id: string) => Omit<CalculatorDefinition, "createdAt" | "updatedAt" | "createdBy">;
+export {};

package/dist/calculator/schema.js

@@ -0,0 +1,129 @@
+import { ColumnType, Units, } from '../types/firestore.js';
+import { unitsForDimension } from './units.js';
+// ---------------------------------------------------------------------------
+// The Construction Calculator definition — the shared artifact the web
+// authoring tool produces, the mobile runtime interprets, and sync ships.
+//
+// Distinct from the loosely-typed Template/ColumnConfig model, but reuses its
+// vocabulary where it fits: field kinds ARE ColumnType values (subset) and the
+// per-kind payloads reuse the existing column-data shapes, so the table UI
+// and the runtime tiles can share components with templates.
+//
+// CANONICAL VALUES: every numeric value in a definition (defaultValue, solve
+// brackets) and every runtime field value is canonical — µm for length, µm²
+// area, µm³ volume, degrees for angle, raw for dimensionless (see units.ts).
+//
+// EXPRESSION SEMANTICS: equations are math.js expressions evaluated over a
+// canonical scope. Numeric literals inside an expression are therefore
+// canonical too (a bare `2` multiplying a length is a plain scalar; a bare
+// additive length constant would be micrometers). Authors should express
+// length constants as input fields with a defaultValue instead of literals.
+// ---------------------------------------------------------------------------
+/**
+ * Version of the definition format itself. Bumped only on breaking schema
+ * changes; independent of the npm package version and of each calculator's
+ * own content `version`.
+ */
+export const CALCULATOR_SCHEMA_VERSION = 1;
+export const CALCULATOR_FIELD_KINDS = [
+    ColumnType.Number,
+    ColumnType.Measurement,
+    ColumnType.Angle,
+    ColumnType.SingleSelect,
+    ColumnType.MultiSelect,
+    ColumnType.ConversionTable,
+    ColumnType.Instructions,
+];
+// ---------------------------------------------------------------------------
+// Helpers
+// ---------------------------------------------------------------------------
+export const fieldsByRole = (definition, role) => definition.fields.filter((f) => f.role === role);
+export const findField = (definition, fieldId) => definition.fields.find((f) => f.id === fieldId);
+export const findEquation = (definition, equationId) => definition.equations.find((e) => e.id === equationId);
+/** The equation targeting an output field, if any. */
+export const equationForField = (definition, fieldId) => definition.equations.find((e) => e.targetFieldId === fieldId);
+/** The dimension a field's numeric value carries. */
+export const fieldDimension = (field) => {
+    switch (field.kind) {
+        case ColumnType.Measurement:
+            return field.unit.dimension;
+        case ColumnType.Angle:
+            return 'angle';
+        default:
+            return 'none';
+    }
+};
+/** Fields whose value participates in equations as a number. */
+export const isNumericFieldKind = (kind) => kind === ColumnType.Number ||
+    kind === ColumnType.Measurement ||
+    kind === ColumnType.Angle ||
+    kind === ColumnType.ConversionTable;
+/** Field kinds an equation may target (compute into). */
+export const isEquationTargetKind = (kind) => kind === ColumnType.Number ||
+    kind === ColumnType.Measurement ||
+    kind === ColumnType.Angle;
+/**
+ * Synthesize a ColumnConfig for a field so the existing table/tile components
+ * (built around ColumnConfig) can render calculator fields unchanged.
+ */
+export const fieldToColumnConfig = (field) => {
+    switch (field.kind) {
+        case ColumnType.SingleSelect:
+            return {
+                id: field.id,
+                name: field.name,
+                type: ColumnType.SingleSelect,
+                columnData: field.columnData,
+            };
+        case ColumnType.MultiSelect:
+            return {
+                id: field.id,
+                name: field.name,
+                type: ColumnType.MultiSelect,
+                columnData: field.columnData,
+            };
+        case ColumnType.ConversionTable:
+            return {
+                id: field.id,
+                name: field.name,
+                type: ColumnType.ConversionTable,
+                columnData: field.columnData,
+            };
+        case ColumnType.Instructions:
+            return {
+                id: field.id,
+                name: field.name,
+                type: ColumnType.Instructions,
+                columnData: field.columnData,
+            };
+        case ColumnType.Number:
+            return { id: field.id, name: field.name, type: ColumnType.Number };
+        case ColumnType.Angle:
+            return { id: field.id, name: field.name, type: ColumnType.Angle };
+        case ColumnType.Measurement:
+            return { id: field.id, name: field.name, type: ColumnType.Measurement };
+    }
+};
+/** Default per-field unit config for a fresh measurement field. */
+export const defaultFieldUnitConfig = (dimension = 'length') => ({
+    dimension,
+    defaultUnit: dimension === 'length'
+        ? Units.FractionalInches
+        : dimension === 'area'
+            ? 'sq_ft'
+            : 'cu_ft',
+    allowedUnits: unitsForDimension(dimension),
+});
+/** Seed for the create-new-calculator stub doc (mirrors the template flow). */
+export const createEmptyCalculatorDefinition = (id) => ({
+    id,
+    schemaVersion: CALCULATOR_SCHEMA_VERSION,
+    version: 0,
+    name: '',
+    description: '',
+    folderId: null,
+    fields: [],
+    equations: [],
+    diagramFileId: null,
+    isPublic: false,
+});

package/dist/calculator/solve.d.ts

@@ -0,0 +1,46 @@
+import type { CalculatorDefinition, CalculatorValues } from './schema.js';
+export type SolveFailure = {
+    kind: 'unknown-field';
+} | {
+    kind: 'not-solvable';
+} | {
+    kind: 'no-governing-equation';
+} | {
+    kind: 'missing-target';
+    targetFieldId: string;
+} | {
+    kind: 'missing-inputs';
+    missingFieldIds: string[];
+} | {
+    kind: 'invalid-bracket';
+} | {
+    kind: 'no-sign-change';
+} | {
+    kind: 'eval-error';
+    error: string;
+} | {
+    kind: 'non-convergent';
+};
+export type SolveResult = {
+    ok: true;
+    value: number;
+} | {
+    ok: false;
+    failure: SolveFailure;
+};
+export interface SolveOptions {
+    maxIter?: number;
+    /** Points probed when the bracket endpoints don't straddle a root. */
+    scanSamples?: number;
+}
+/**
+ * Numerically solve a solvable field from its governing equation, given the
+ * equation's output value (and every other referenced value) in `values`.
+ */
+export declare const solveForField: ({ definition, fieldId, values, options, }: {
+    definition: Pick<CalculatorDefinition, "fields" | "equations">;
+    fieldId: string;
+    /** Canonical values; must include the governing equation's target value. */
+    values: CalculatorValues;
+    options?: SolveOptions;
+}) => SolveResult;