@reekon-tools/boldr-utils 1.7.3 → 1.7.5

package/dist/export/config.js

@@ -0,0 +1,72 @@
+// Shared model for the configurable job CSV export (rock-pro-app +
+// rock-desktop). The config is persisted on the user doc (`exportConfig`) so
+// it follows the user across devices and platforms; both apps must therefore
+// read/write the same shape and tolerate values written by the other.
+export const ALL_EXPORT_CATEGORIES = [
+    'defaultGroup',
+    'groups',
+    'forms',
+];
+export const ALL_EXPORT_OBJECT_TYPES = [
+    'calculators',
+    'files',
+    'photos',
+    'cad',
+    'labels',
+    'notes',
+];
+export const ALL_EXPORT_MEASUREMENT_DATA_FIELDS = ['measurement', 'label', 'notes'];
+// Objects are opt-in: nothing ticked and images excluded until the user
+// configures otherwise, so a default export is measurements-only.
+export const DEFAULT_EXPORT_CONFIG = {
+    categories: [...ALL_EXPORT_CATEGORIES],
+    objects: [],
+    measurements: 'all',
+    imageFormat: 'none',
+    measurementData: [...ALL_EXPORT_MEASUREMENT_DATA_FIELDS],
+};
+// "Export All" (everything, ignoring the saved config): every category, every
+// object kind as a hyperlink, all measurements, all list columns.
+export const EXPORT_EVERYTHING_CONFIG = {
+    categories: [...ALL_EXPORT_CATEGORIES],
+    objects: [...ALL_EXPORT_OBJECT_TYPES],
+    measurements: 'all',
+    imageFormat: 'hyperlink',
+    measurementData: [...ALL_EXPORT_MEASUREMENT_DATA_FIELDS],
+};
+const isCategory = (v) => typeof v === 'string' && ALL_EXPORT_CATEGORIES.includes(v);
+const isObjectType = (v) => typeof v === 'string' && ALL_EXPORT_OBJECT_TYPES.includes(v);
+const isMeasurementFilter = (v) => v === 'all' || v === 'complete' || v === 'incomplete';
+const isImageFormat = (v) => v === 'hyperlink' || v === 'none';
+const isMeasurementDataField = (v) => typeof v === 'string' &&
+    ALL_EXPORT_MEASUREMENT_DATA_FIELDS.includes(v);
+// Tolerant reader for the raw user-doc field. Missing/invalid fields fall
+// back to defaults and unknown array members are dropped. Empty `categories`
+// or `measurementData` fall back to all — the UIs can't save those, so treat
+// them as corrupt. `objects` defaults to none (objects are opt-in), so
+// missing and empty read the same.
+export function normalizeExportConfig(raw) {
+    const r = raw && typeof raw === 'object' ? raw : {};
+    const categories = Array.isArray(r.categories)
+        ? r.categories.filter(isCategory)
+        : [];
+    const objects = Array.isArray(r.objects)
+        ? r.objects.filter(isObjectType)
+        : [];
+    const measurementData = Array.isArray(r.measurementData)
+        ? r.measurementData.filter(isMeasurementDataField)
+        : [];
+    return {
+        categories: categories.length > 0 ? categories : [...ALL_EXPORT_CATEGORIES],
+        objects,
+        measurements: isMeasurementFilter(r.measurements)
+            ? r.measurements
+            : DEFAULT_EXPORT_CONFIG.measurements,
+        imageFormat: isImageFormat(r.imageFormat)
+            ? r.imageFormat
+            : DEFAULT_EXPORT_CONFIG.imageFormat,
+        measurementData: measurementData.length > 0
+            ? measurementData
+            : [...ALL_EXPORT_MEASUREMENT_DATA_FIELDS],
+    };
+}

package/dist/export/desktopLinks.d.ts

@@ -0,0 +1,11 @@
+import { type FileUpload } from '../types/firestore.js';
+export type DesktopLinkContext = {
+    baseUrl: string;
+    orgId: string;
+    projectId: string;
+    jobId: string;
+    groupId: string;
+    isDefaultGroup: boolean;
+};
+export declare function desktopBaseUrlForFirebaseProject(firebaseProjectId: string | undefined): string;
+export declare function desktopFileEditorUrl(file: FileUpload, ctx: DesktopLinkContext): string | null;

package/dist/export/desktopLinks.js

@@ -0,0 +1,45 @@
+import { FileUploadType } from '../types/firestore.js';
+// Maps the running mobile app's Firebase project onto the desktop
+// deployment. Dev builds target a local rock-desktop dev server (`yarn dev`,
+// Vite's default port) for testing.
+export function desktopBaseUrlForFirebaseProject(firebaseProjectId) {
+    switch (firebaseProjectId) {
+        case 'rock-production-pro':
+            return 'https://app.boldrpro.com';
+        case 'rock-staging-pro':
+            return 'https://staging.app.boldrpro.com';
+        default:
+            return 'http://localhost:5173';
+    }
+}
+// Returns the desktop editor URL for an exported group file, or null when
+// desktop has no editor for it (labels render inert there) — the CSV cell
+// then degrades to the plain object name.
+export function desktopFileEditorUrl(file, ctx) {
+    const { baseUrl, orgId, projectId, jobId, groupId, isDefaultGroup } = ctx;
+    const jobPath = `${baseUrl}/app/organizations/${orgId}/projects/${projectId}/jobs/${jobId}`;
+    const groupQuery = `groupId=${encodeURIComponent(groupId)}`;
+    switch (file.type) {
+        case FileUploadType.LayoutGroup:
+            return `${jobPath}/layout-group/${file.id}?${groupQuery}`;
+        case FileUploadType.Note:
+            return `${jobPath}/notes/${file.id}?${groupQuery}`;
+        case FileUploadType.Canvas:
+            return `${jobPath}/canvas/${file.id}?${groupQuery}`;
+        case FileUploadType.Annotation: {
+            // Pass a top-level fileType through when the doc carries one (desktop
+            // uses it to pick the 3D viewer); omit otherwise — the viewer defaults
+            // to the PDF path.
+            const rawFileType = file.fileType;
+            const fileTypeQuery = rawFileType
+                ? `&fileType=${encodeURIComponent(rawFileType)}`
+                : '';
+            const defaultQuery = isDefaultGroup ? '&isDefault=true' : '';
+            return `${jobPath}/viewer?fileId=${encodeURIComponent(file.id)}&${groupQuery}${fileTypeQuery}${defaultQuery}`;
+        }
+        default:
+            // Labels (no desktop editor) and anything classifyFileForExport should
+            // already have excluded.
+            return null;
+    }
+}

package/dist/export/objectKinds.d.ts

@@ -0,0 +1,3 @@
+import { type FileUpload } from '../types/firestore.js';
+import type { ExportObjectType } from './config.js';
+export declare function classifyFileForExport(file: FileUpload): ExportObjectType | null;

package/dist/export/objectKinds.js

@@ -0,0 +1,28 @@
+import { FileUploadType } from '../types/firestore.js';
+// Maps a group file onto the export config's object kinds. `null` means the
+// file is never exported: Calculator is a config placeholder for now (the
+// checkbox persists but nothing exports until calculator export ships),
+// Conversion/Template/Background are internal utility docs, and Annotation
+// files flagged `isLabel` are label-print artifacts hidden from group grids.
+export function classifyFileForExport(file) {
+    switch (file.type) {
+        case FileUploadType.LayoutGroup:
+            return 'cad';
+        case FileUploadType.Note:
+            return 'notes';
+        case FileUploadType.Label:
+            return 'labels';
+        case FileUploadType.Canvas:
+            return 'photos';
+        case FileUploadType.Annotation: {
+            const fileData = file.fileData;
+            if (fileData?.isLabel)
+                return null;
+            // Legacy Nutrient sketches count as photos for filtering, but still
+            // open in the document viewer (they have no Skia canvas state).
+            return fileData?.fileType === 'sketch' ? 'photos' : 'files';
+        }
+        default:
+            return null;
+    }
+}

package/dist/exports.d.ts

@@ -7,7 +7,11 @@ export * from './types/firestore.js';
 export * from './types/layout.js';
 export * from './types/annotation.js';
 export { getToleranceColor, calculateDeviationPercentage, isWithinTolerance, generateToleranceGradient, createDefaultToleranceThresholds, DEFAULT_TOLERANCE_COLORS, type ToleranceThreshold, type ToleranceConfig, } from './utils/tolerance.js';
-export { DEFAULT_GROUP_INDEX, isDefaultGroup, findDefaultGroup, } from './utils/groups.js';
+export { DEFAULT_GROUP_INDEX, isDefaultGroup, findDefaultGroup, isFormGroupCompleted, } from './utils/groups.js';
+export { ALL_EXPORT_CATEGORIES, ALL_EXPORT_MEASUREMENT_DATA_FIELDS, ALL_EXPORT_OBJECT_TYPES, DEFAULT_EXPORT_CONFIG, EXPORT_EVERYTHING_CONFIG, normalizeExportConfig, type ExportCategory, type ExportConfig, type ExportImageFormat, type ExportMeasurementDataField, type ExportMeasurementFilter, type ExportObjectType, } from './export/config.js';
+export { classifyFileForExport } from './export/objectKinds.js';
+export { buildJobCsv, escapeCSVField, hyperlinkCell, type BuildJobCsvInput, type ExportObjectRow, type ExportScope, } from './export/buildJobCsv.js';
+export { desktopBaseUrlForFirebaseProject, desktopFileEditorUrl, type DesktopLinkContext, } from './export/desktopLinks.js';
 export { numberToLetterIndex, formGroupInputLabel, listGroupMeasurementLabel, } from './utils/indexLabels.js';
 export { toSelectedValues, formatSelectedValues, toStoredValue, } from './utils/selectValues.js';
 export * from './calculator/index.js';

package/dist/exports.js

@@ -11,7 +11,13 @@ export * from './types/firestore.js';
 export * from './types/layout.js';
 export * from './types/annotation.js';
 export { getToleranceColor, calculateDeviationPercentage, isWithinTolerance, generateToleranceGradient, createDefaultToleranceThresholds, DEFAULT_TOLERANCE_COLORS, } from './utils/tolerance.js';
-export { DEFAULT_GROUP_INDEX, isDefaultGroup, findDefaultGroup, } from './utils/groups.js';
+export { DEFAULT_GROUP_INDEX, isDefaultGroup, findDefaultGroup, isFormGroupCompleted, } from './utils/groups.js';
+// Configurable job CSV export, shared by rock-pro-app and rock-desktop so
+// both platforms emit identical files.
+export { ALL_EXPORT_CATEGORIES, ALL_EXPORT_MEASUREMENT_DATA_FIELDS, ALL_EXPORT_OBJECT_TYPES, DEFAULT_EXPORT_CONFIG, EXPORT_EVERYTHING_CONFIG, normalizeExportConfig, } from './export/config.js';
+export { classifyFileForExport } from './export/objectKinds.js';
+export { buildJobCsv, escapeCSVField, hyperlinkCell, } from './export/buildJobCsv.js';
+export { desktopBaseUrlForFirebaseProject, desktopFileEditorUrl, } from './export/desktopLinks.js';
 export { numberToLetterIndex, formGroupInputLabel, listGroupMeasurementLabel, } from './utils/indexLabels.js';
 export { toSelectedValues, formatSelectedValues, toStoredValue, } from './utils/selectValues.js';
 // Construction Calculator shared module (schema, units, evaluator, solver,

package/dist/hooks/useParseMeasurement.d.ts

@@ -0,0 +1,4 @@
+export declare const useParseMeasurement: () => {
+    parseMeasurementInput: (input: string, defaultUnit?: string) => number | null;
+    error: string | null;
+};

package/dist/hooks/useParseMeasurement.js

@@ -0,0 +1,14 @@
+import { useState } from 'react';
+import { parseMeasurement } from '../utils/parseMeasurement.js';
+export const useParseMeasurement = () => {
+    const [error, setError] = useState(null);
+    const parseMeasurementInput = (input, defaultUnit = '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/dist/utils/evaluateFormula.d.ts

@@ -0,0 +1,20 @@
+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;
+}
+export declare function evaluateFormula({ expression, mappings, group, columns, measurementMap, defaultUnit, }: FormulaEvaluationOptions): number | string;
+export {};

package/dist/utils/evaluateFormula.js

@@ -0,0 +1,31 @@
+import { create, all } from 'mathjs';
+const math = create(all);
+export function evaluateFormula({ expression, mappings, group, columns, measurementMap, defaultUnit = 'um', }) {
+    const scope = {};
+    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/dist/utils/groups.d.ts

@@ -1,4 +1,5 @@
-import type { Group } from '../types/firestore.js';
+import { type Group, type Section } from '../types/firestore.js';
 export declare const DEFAULT_GROUP_INDEX = 0;
 export declare const isDefaultGroup: (group: Pick<Group, "groupIndex"> | null | undefined) => boolean;
 export declare const findDefaultGroup: <T extends Pick<Group, "groupIndex">>(groups: T[] | null | undefined) => T | null;
+export declare const isFormGroupCompleted: (group: Group, section: Section) => boolean;

package/dist/utils/groups.js

@@ -1,3 +1,17 @@
+import { ColumnType } from '../types/firestore.js';
 export const DEFAULT_GROUP_INDEX = 0;
 export const isDefaultGroup = (group) => group?.groupIndex === DEFAULT_GROUP_INDEX;
 export const findDefaultGroup = (groups) => groups?.find((g) => g.groupIndex === DEFAULT_GROUP_INDEX) ?? null;
+// A FORM group (one row of its section's table) counts as complete when every
+// Measurement column holds a value. Angle columns are intentionally excluded
+// (mirrors the apps' header-completion computations), and a section with no
+// Measurement columns is never "complete".
+export const isFormGroupCompleted = (group, section) => {
+    const measurementColumns = section.tableConfig.filter((column) => column.type === ColumnType.Measurement);
+    if (measurementColumns.length === 0)
+        return false;
+    return measurementColumns.every((column) => {
+        const value = group.columns?.[column.id];
+        return value !== undefined && value !== '';
+    });
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reekon-tools/boldr-utils",
-  "version": "1.7.3",
+  "version": "1.7.5",
   "description": "Shared utilities for formulas and measurement conversion used in Reekon apps",
   "author": "REEKON Tools",
   "license": "MIT",

package/dist/annotation/canvas/tools/measurementLineTool.d.ts

@@ -1,12 +0,0 @@
-import type { PlacedMeasurementRef } from '../../../types/annotation.js';
-import type { Tool } from '../Tool.js';
-export interface MeasurementLineToolOptions {
-    id?: string;
-    label?: string;
-    minDragPx?: number;
-    autoSwitchToSelect?: boolean;
-    selectToolId?: string;
-    onAutoSwitch?: (toToolId: string) => void;
-    onPlaced?: (measurement: PlacedMeasurementRef) => void;
-}
-export declare const createMeasurementLineTool: (options?: MeasurementLineToolOptions) => Tool;

package/dist/annotation/canvas/tools/measurementLineTool.js

@@ -1,95 +0,0 @@
-import { DEFAULT_LAYER_ID } from '../../../types/annotation.js';
-import { DEFAULT_LINE_POS, recomputeAnchor } from '../measurementGeometry.js';
-let counter = 0;
-const makeId = () => `annotation-${Date.now().toString(36)}-${(counter++).toString(36)}`;
-const firstLayerId = (doc) => doc.layers[0]?.id ?? DEFAULT_LAYER_ID;
-// Build the blank line-measurement annotation for a drag from `a` to `b`: a
-// 2-point line with a value tile magnetized to its center (linePos 0.5). The
-// payload mirrors useAnnotationCanvasState's placeAnnotationAtCenter so a drawn
-// line and a (legacy) center-placed one are byte-identical once committed.
-const buildLineMeasurement = (opts) => {
-    const line = { a: opts.a, b: opts.b };
-    return {
-        id: opts.id,
-        layerId: opts.layerId,
-        placement: 'line',
-        line,
-        linePos: DEFAULT_LINE_POS,
-        // Center of the line; recomputeAnchor keeps this in sync on edits.
-        anchor: recomputeAnchor(line, 'line', DEFAULT_LINE_POS, {
-            x: (opts.a.x + opts.b.x) / 2,
-            y: (opts.a.y + opts.b.y) / 2,
-        }),
-        showLabel: true,
-        showValue: true,
-        createdAt: Date.now(),
-    };
-};
-// Drag-to-draw measurement-line tool. Press-drag rubber-bands a measurement
-// annotation (a line with a blank value tile at its center); release commits
-// it. Mirrors createShapeTool's interaction so "input lines" are placed the
-// same way as shapes — draw to add, not tap-the-icon-to-add — replacing the
-// old center-place affordance. The annotation stays blank (no measurement
-// associated) until the user fills it via the tile / picker. Skia-free, like
-// every tool factory; it renders its live preview through ctx.preview, so it
-// works on web and (via the generic tool-pan dispatch) on native.
-export const createMeasurementLineTool = (options = {}) => {
-    const minDragPx = options.minDragPx ?? 4;
-    const autoSwitchToSelect = options.autoSwitchToSelect ?? true;
-    const selectToolId = options.selectToolId ?? 'select';
-    return {
-        id: options.id ?? 'measure-line',
-        label: options.label ?? 'Measurement line',
-        cursor: 'crosshair',
-        onPointerDown(event) {
-            return {
-                kind: 'measurement-line-drawing',
-                id: makeId(),
-                startWorld: event.world,
-                startScreen: event.screen,
-                moved: false,
-            };
-        },
-        onPointerMove(event, ctx, state) {
-            const s = state;
-            if (s?.kind !== 'measurement-line-drawing')
-                return s;
-            const measurement = buildLineMeasurement({
-                id: s.id,
-                layerId: firstLayerId(ctx.document),
-                a: s.startWorld,
-                b: event.world,
-            });
-            ctx.preview({ ops: [{ op: 'addMeasurement', measurement }] });
-            return { ...s, moved: true };
-        },
-        onPointerUp(event, ctx, state) {
-            const s = state;
-            if (s?.kind !== 'measurement-line-drawing')
-                return;
-            const dx = event.screen.x - s.startScreen.x;
-            const dy = event.screen.y - s.startScreen.y;
-            if (!s.moved || dx * dx + dy * dy < minDragPx * minDragPx) {
-                // Accidental tap — discard the rubber-band, commit nothing.
-                ctx.preview({ ops: [] });
-                return;
-            }
-            const measurement = buildLineMeasurement({
-                id: s.id,
-                layerId: firstLayerId(ctx.document),
-                a: s.startWorld,
-                b: event.world,
-            });
-            ctx.commit({ ops: [{ op: 'addMeasurement', measurement }] });
-            // Leave it selected (and hand back to select) so the blank line can be
-            // filled / moved straight away — the same flow as the text tool.
-            ctx.setSelection({ ids: [measurement.id] });
-            options.onPlaced?.(measurement);
-            if (autoSwitchToSelect)
-                options.onAutoSwitch?.(selectToolId);
-        },
-        onCancel(_state, ctx) {
-            ctx.preview({ ops: [] });
-        },
-    };
-};