@reekon-tools/boldr-utils 1.0.13 → 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2025] [REEKON Tools]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,12 @@
+# BOLDR Utils
+
+Utilies for BOLDR Pro
+
+## Intro
+
+BOLDR Utils is a collection of types and utility functions written to be used across BOLDR web and mobile for consistency and reliability. This package must:
+
+- Be consumable in React Native (Metro bundler)
+- Be consumable in Remix (Node/ESM, often using Vite or Webpack)
+- Be written in TypeScript
+- Be published cleanly to npm

package/package.json

@@ -1,23 +1,26 @@
 {
   "name": "@reekon-tools/boldr-utils",
-  "version": "1.0.13",
-  "main": "src/index.ts",
-  "types": "src/index.ts",
-  "exports": {
-    ".": {
-      "import": "./src/index.ts",
-      "types": "./src/index.ts"
-    }
-  },
-  "files": ["src"],
+  "version": "1.1.0",
+  "description": "Shared utilities for formulas and measurement conversion used in Reekon apps",
+  "author": "REEKON Tools",
+  "license": "MIT",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc",
-    "test": "jest"
+    "test": "vitest",
+    "coverage": "vitest run --coverage",
+    "format": "prettier --write .",
+    "check-format": "prettier --check .",
+    "check-exports": "attw --pack . --ignore-rules=cjs-resolves-to-esm",
+    "ci": "yarn run check-format && vitest run && yarn run build && yarn run check-exports"
   },
   "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "repository": "https://gitlab.com/reekon-tools/software/rock-pro/boldr-types#",
+  "repository": "https://gitlab.com/reekon-tools/software/rock-pro/boldr-utils#",
   "dependencies": {
     "mathjs": "^11.11.0"
   },
@@ -25,13 +28,17 @@
     "react": "^18.0.0"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.14",
+    "@arethetypeswrong/cli": "^0.18.1",
     "@types/node": "^22.15.18",
     "@types/react": "^19.0.8",
-    "jest": "^29.7.0",
-    "ts-jest": "^29.3.3",
+    "@vitest/coverage-v8": "3.1.3",
+    "prettier": "^3.5.3",
     "ts-node": "^10.9.2",
-    "typescript": "^5.8.3"
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.3"
+  },
+  "engines": {
+    "node": ">=18"
   },
   "packageManager": "yarn@1.22.22"
 }

package/src/formulas/createFormulaScope.ts

@@ -1,47 +0,0 @@
-import { FractionalTolerance, DecimalTolerance, Units } from '..';
-import { ColumnType } from '..';
-import { convertMicrometers } from '../utils/micrometersToUnit';
-
-export function createFormulaScope({
-  group,
-  mappings,
-  columns,
-  measurementMap,
-  unit, // user preferred unit, e.g., 'in' or 'cm'
-}: {
-  group: any;
-  mappings: Record<string, string>;
-  columns: any[];
-  measurementMap: Map<string, any[]>;
-  unit: string;
-}): Record<string, number> {
-  const scope: Record<string, number> = {};
-
-  for (const [variable, columnId] of Object.entries(mappings)) {
-    const rawValue = group.columns.get(columnId);
-    const columnDef = columns.find((c) => c.id === columnId);
-
-    let parsedValue: number | undefined;
-
-    if (columnDef?.type === ColumnType.Measurement) {
-      const groupMeasurements = measurementMap.get(group.id) || [];
-      const measurement = groupMeasurements.find((m) => m.id === rawValue);
-      if (measurement?.value !== undefined) {
-        // Here, the unit 
-        parsedValue = parseFloat(convertMicrometers(
-            measurement.value,
-            unit as Units,
-            FractionalTolerance.Sixteenth,
-            DecimalTolerance.Hundredth
-          ).value);
-      }
-    } else {
-      parsedValue =
-        typeof rawValue === 'number' ? rawValue : parseFloat(rawValue || '');
-    }
-
-    scope[variable] = isNaN(parsedValue!) ? 0 : parsedValue!;
-  }
-
-  return scope;
-}

package/src/formulas/evaluateColumnValue.ts

@@ -1,70 +0,0 @@
-import { ColumnConfig, ColumnType, Group, Units } from '..';
-import { createFormulaScope } from './createFormulaScope';
-import { compile, unit as mathUnit } from 'mathjs';
-import { normalizeUnitForMathJS } from './mathUnitMap';
-
-export function evaluateColumnValue({
-  group,
-  col,
-  formulas,
-  columns,
-  measurementMap,
-  userUnit,
-}: {
-  group: Group;
-  col: ColumnConfig;
-  formulas: any[];
-  columns: any[];
-  measurementMap: Map<string, any[]>;
-  userUnit: Units;
-}): any {
-  // Normalize immediately
-  const normalizedUnit = normalizeUnitForMathJS(userUnit);
-
-  if (col.type === ColumnType.Measurement) {
-    const value = group.columns.get(col.id);
-    const groupMeasurements = measurementMap.get(group.id) || [];
-    const measurement = groupMeasurements.find((m) => m.id === value);
-    return measurement ?? value;
-  }
-
-  if (col.type === ColumnType.Formula) {
-    const formula = formulas.find((f) => f.id === col.formulaId);
-    if (!formula) {
-      console.warn(`Missing formula with id ${col.formulaId}`);
-      return null;
-    }
-
-    if (col.mappings === undefined) {
-      return null;
-    }
-
-    try {
-      const scope = createFormulaScope({
-        group,
-        mappings: col.mappings,
-        columns,
-        measurementMap,
-        unit: normalizedUnit, // ✅ normalized!
-      });
-
-      console.log('Evaluating:', formula.expression, scope);
-
-      const compiled = compile(formula.expression);
-      const result = compiled.evaluate(scope);
-
-      const asUnit = mathUnit(result, normalizedUnit);
-
-      if (!asUnit.equalBase(mathUnit('1 um'))) {
-        throw new Error(`Incompatible unit: ${asUnit.formatUnits()} is not compatible with ${normalizedUnit}`);
-      }
-
-      return Math.round(asUnit.toNumber('um'));
-    } catch (error) {
-      console.error(`Failed to evaluate formula: ${col.name}`, error);
-      return null;
-    }
-  }
-
-  return group.columns.get(col.id) ?? '';
-}

package/src/formulas/mathUnitMap.ts

@@ -1,26 +0,0 @@
-import { Units } from "..";
-
-// Must convert our custom unit types 
-export function normalizeUnitForMathJS(unit: Units | string): string {
-  switch (unit) {
-    case Units.Centimeters:
-    case 'cm':
-      return 'cm';
-    case Units.Millimeters:
-    case 'mm':
-      return 'mm';
-    case Units.Meters:
-    case 'm':
-      return 'm';
-    case Units.Inches:
-    case Units.FractionalInches:
-      return 'in';
-    case Units.Feet:
-    case Units.FeetInchesDecimal:
-    case Units.FeetInchesFractional:
-      return 'ft';
-    default:
-      console.warn(`Unknown or unsupported unit: ${unit}, falling back to 'mm'`);
-      return 'mm'; // fallback
-  }
-}

package/src/hooks/useParseMeasurement.ts

@@ -1,18 +0,0 @@
-
-import { useState } from 'react';
-import { parseMeasurement } from '../utils/parseMeasurement';
-
-export const useParseMeasurement = () => {
-  const [error, setError] = useState<string | null>(null);
-
-  const parseMeasurementInput = (input: string, defaultUnit: string = 'mm') => {
-    setError(null);
-    const result = parseMeasurement(input, defaultUnit);
-    if (result === null) {
-      setError('Invalid measurement. Please provide a valid number and unit.');
-    }
-    return result;
-  };
-
-  return { parseMeasurementInput, error };
-};

package/src/index.ts

@@ -1,2 +0,0 @@
-export * from './types/firestore';
-export { evaluateColumnValue } from './formulas/evaluateColumnValue';

package/src/types/firestore.ts

@@ -1,202 +0,0 @@
-interface FirestoreDoc {
-    id: string;
-  }
-  
-  interface Timestamps {
-    createdAt: Date;
-  }
-  
-  interface CreatedBy {
-    firstName: string;
-    lastName: string;
-    userId: string;
-  }
-  
-  export interface Organization extends FirestoreDoc, Timestamps {
-      name: string;
-      createdBy: string;
-  };
-  
-  export enum OrganizationRole {
-    Admin = 'admin',
-    Member = 'member',
-  }
-  
-  export enum InvitationStatus {
-    Pending = 'pending',
-    Accepted = 'accepted',
-  }
-  
-  export interface Invitation extends FirestoreDoc, Timestamps {
-    delivery?: unknown;
-    invitationCode: string;
-    inviteeEmail: string;
-    inviteeUid: string;
-    inviterId: string;
-    message: {
-      subject: string;
-      text: string;
-    };
-    organizationId: string;
-    role: OrganizationRole;
-    status: InvitationStatus
-  };
-    
-  export interface OrganizationMember extends FirestoreDoc {
-    email: string;
-    firstName: string;
-    lastName: string;
-    joinedAt: Date;
-    role: OrganizationRole;
-    userId: string;
-  };
-  
-  export interface Project extends FirestoreDoc, Timestamps {
-    name: string;
-    description: string;
-    imageUrl: string | null;
-    streetAddress: string;
-    city: string;
-    zipCode: string;
-    state: string;
-  }
-  
-  export enum FolderType {
-    Project = 'project',
-    Job = 'job',
-  }
-  
-  export interface Folder extends FirestoreDoc {
-    name: string;
-    index: number;
-    parentFolderId?: string | null;
-    projectId: string | null;
-    type: FolderType;
-  }
-  
-  export interface Job extends FirestoreDoc, Timestamps {
-    name: string;
-    folderId: string;  
-    progress: number;
-    projectId: string;
-    totalTasks: string;
-  }
-  
-  export interface Section {
-    id: string;
-    name: string;
-    tableConfig: ColumnConfig[];
-    measurements: string[];
-    projectId: string;
-    jobId: string;
-  }
-  
-  export interface Group extends FirestoreDoc, Timestamps {
-    projectId: string;
-    jobId: string;
-    sectionId: string;
-    name: string;
-    sortIndex: number;
-    columns: Record<string, any>;
-  }
-  
-  export enum ColumnType {
-    Text = 'text',
-    Number = 'number',
-    Measurement = 'measurement',
-    Boolean = 'boolean',
-    Formula = 'formula',
-  }
-  
-  export interface Formula extends FirestoreDoc, Timestamps {
-    expression: string;
-    name: string;
-    varaibles: string[];
-  }
-  
-  export interface ColumnConfig {
-    id: string;
-    name: string;
-    type: ColumnType;
-    formulaId?: string;
-    mappings?: Record<string, string> // Used for formula mapping
-  }
-  
-  export interface Row {
-    [key: string]: any; // Dynamic keys representing column IDs, with their respective data
-  }
-  
-  export interface Measurement extends FirestoreDoc, Timestamps, CreatedBy {
-    projectId:string;
-    jobId:string;
-    groupId:string;
-    sectionId:string;
-    value: number;
-    index: number;
-    label: string;
-    measurementIndex: number;
-    unit: Units;
-  }
-  
-  export enum Units {
-    Centimeters = 'cm',
-    Millimeters = 'mm',
-    Meters = 'm',
-    Inches = 'in',
-    FractionalInches = 'in_frac',
-    Feet = 'ft',
-    FeetInchesDecimal = 'ft_in_decimal',
-    FeetInchesFractional = 'ft_in_frac',
-  }
-  
-  export const convertUnitsToReadable = (targetUnit: Units) => {
-    switch (targetUnit) {
-      case Units.Meters:
-        return 'm';
-      case Units.Millimeters:
-        return 'mm';
-      case Units.Centimeters:
-        return 'cm';
-      case Units.Feet:
-        return 'ft';
-      case Units.FractionalInches:
-        return 'in (fractional)';
-      case Units.Inches:
-        return 'in';
-      case Units.FeetInchesDecimal:
-        return 'ft-in (decimal)';
-      case Units.FeetInchesFractional:
-        return 'ft-in (fractional)';
-      default:
-        return null;
-    }
-  };
-  
-  export enum FractionalTolerance {
-    Fourth = '4',
-    Eighth = '8',
-    Sixteenth = '16',
-    ThirtySecond = '32',
-    SixtyFourth = '64',
-    OneTwentyEighth = '128',
-  }
-  
-  export enum DecimalTolerance {
-    Half = '0.5',
-    Tenth = '0.1',
-    Hundredth = '0.01',
-    Thousandth = '0.001',
-  }
-  
-  export interface UserDocument extends FirestoreDoc, Timestamps {
-    defaultOrganization: string;
-    displayName: string;
-    email: string;
-    firstName: string;
-    lastName: string;
-    defaultUnit: Units;
-    decimalTolerance: DecimalTolerance;
-    fractionalTolerance: FractionalTolerance;
-    showWizard: boolean; // The onboarding screen displayed on web
-    printLabelSize: string;
-  };

package/src/utils/evaluateFormula.ts

@@ -1,57 +0,0 @@
-import { create, all, Unit } from 'mathjs';
-
-const math = create(all);
-
-type MeasurementMap = Map<string, { id: string; value: number }[]>;
-
-interface FormulaEvaluationOptions {
-  expression: string;
-  mappings: Record<string, string>;
-  group: { id: string; columns: Map<string, any> };
-  columns: { id: string; type: string }[];
-  measurementMap: MeasurementMap;
-  defaultUnit?: string; // 'um' by default
-}
-
-export function evaluateFormula({
-  expression,
-  mappings,
-  group,
-  columns,
-  measurementMap,
-  defaultUnit = 'um',
-}: FormulaEvaluationOptions): number | string {
-  const scope: Record<string, any> = {};
-
-  for (const [variable, columnId] of Object.entries(mappings)) {
-    const rawValue = group.columns.get(columnId);
-    const columnDef = columns.find((c) => c.id === columnId);
-
-    if (columnDef?.type === 'Measurement') {
-      const groupMeasurements = measurementMap.get(group.id) || [];
-      const measurement = groupMeasurements.find((m) => m.id === rawValue);
-      if (measurement?.value !== undefined) {
-        scope[variable] = math.unit(measurement.value, defaultUnit);
-        continue;
-      }
-    }
-
-    const parsedValue =
-      typeof rawValue === 'number' ? rawValue : parseFloat(rawValue || '');
-    scope[variable] = isNaN(parsedValue) ? 0 : parsedValue;
-  }
-
-  try {
-    const compiled = math.compile(expression);
-    const result = compiled.evaluate(scope);
-
-    if (math.typeOf(result) === 'Unit') {
-      return result.toNumber(defaultUnit);
-    }
-
-    return result;
-  } catch (err) {
-    console.error(`Formula evaluation failed:`, err);
-    return 'Error';
-  }
-}

package/src/utils/micrometersToUnit.ts

@@ -1,75 +0,0 @@
-import { convertUnitsToReadable, DecimalTolerance, FractionalTolerance, Units } from '../index';
-import { create, all } from 'mathjs';
-
-const math = create(all);
-
-export const convertMicrometers = (
-  micrometers: number,
-  unit: Units,
-  fractionalTolerance: FractionalTolerance,
-  decimalTolerance: DecimalTolerance
-): { value: string; unit: string | null } => {
-  const converted = math.unit(micrometers, 'um');
-  let value: number | string = 0;
-  let displayUnit: string | null = '';
-
-  switch (unit) {
-    case Units.Inches:
-    case Units.FractionalInches: {
-      const inches = converted.toNumber('in');
-      displayUnit = 'in';
-      if (unit === Units.FractionalInches) {
-        const denominator = parseInt(fractionalTolerance, 10);
-        const whole = Math.floor(inches);
-        const fractional = inches - whole;
-        const numerator = Math.round(fractional * denominator);
-
-        value =
-          numerator === 0
-            ? `${whole}`
-            : `${whole} ${numerator}/${denominator}`;
-      } else {
-        value = inches.toFixed(decimalTolerance.length - 2); // Match decimal places to tolerance
-      }
-      break;
-    }
-    case Units.Feet:
-    case Units.FeetInchesFractional:
-    case Units.FeetInchesDecimal: {
-      const feet = converted.toNumber('ft');
-      const wholeFeet = Math.floor(feet);
-      const fractionalFeet = feet - wholeFeet;
-      displayUnit = 'ft';
-
-      if (unit === Units.FeetInchesFractional) {
-        const inches = fractionalFeet * 12;
-        const wholeInches = Math.floor(inches);
-        const fractional = inches - wholeInches;
-        const denominator = parseInt(fractionalTolerance, 10);
-        const numerator = Math.round(fractional * denominator);
-
-        value =
-          numerator === 0
-            ? `${wholeFeet}' ${wholeInches}"`
-            : `${wholeFeet}' ${wholeInches} ${numerator}/${denominator}"`;
-      } else if (unit === Units.FeetInchesDecimal) {
-        const inches = (fractionalFeet * 12).toFixed(decimalTolerance.length - 2);
-        value = `${wholeFeet}' ${inches}"`;
-      } else {
-        value = feet.toFixed(decimalTolerance.length - 2);
-      }
-      break;
-    }
-    case Units.Meters:
-    case Units.Centimeters:
-    case Units.Millimeters: {
-      displayUnit = convertUnitsToReadable(unit);
-      value = converted.toNumber(unit).toFixed(decimalTolerance.length - 2);
-      break;
-    }
-    default:
-      throw new Error('Unsupported unit');
-  }
-
-  return { value, unit: displayUnit };
-};

package/src/utils/parseMeasurement.ts

@@ -1,54 +0,0 @@
-import { all, create } from 'mathjs';
-
-const math = create(all);
-
-export const parseMeasurement = (
-  input: string,
-  defaultUnit: string = 'mm'
-): number | null => {
-  try {
-    // Trim and normalize spaces
-    const normalizedInput = input.trim().replace(/\s+/g, ' ');
-
-    // Preprocess mixed fractions (e.g., "12 1/2" -> "12 + 1/2")
-    const processedInput = normalizedInput.replace(
-      /(\d+)\s+(\d+\/\d+)/g,
-      '$1 + $2'
-    );
-
-    // Match numeric value and optional unit
-    const match = processedInput.match(/^([\d.+\-*/\s]+)\s*(\w+)?$/);
-
-    if (!match) {
-      throw new Error('Invalid input format');
-    }
-
-    const [_, value, unit] = match;
-
-    // Evaluate the numeric value (e.g., "12 + 1/2")
-    const numericValue = math.evaluate(value.trim());
-
-    // Use the provided unit or fallback to the default unit
-    const targetUnit = unit || defaultUnit;
-
-    // Convert to micrometers
-    return math.unit(numericValue, targetUnit).toNumber('um');
-  } catch (err) {
-    if (err instanceof Error) {
-      console.error('Invalid measurement:', err.message);
-    } else {
-      console.error('An unknown error occurred:', err);
-    }
-    return null;
-  }
-};
-
-export const numberToLetterIndex = (index: number): string => {
-  let result = '';
-  while (index > 0) {
-    index--; // Adjust for 0-based index
-    result = String.fromCharCode((index % 26) + 65) + result;
-    index = Math.floor(index / 26);
-  }
-  return result;
-};