@reekon-tools/boldr-utils 1.7.3 → 1.7.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (75) hide show
  1. package/dist/canvas/AnnotationCanvas.d.ts +11 -0
  2. package/dist/canvas/AnnotationCanvas.js +10 -0
  3. package/dist/canvas/AnnotationCanvas.native.d.ts +8 -0
  4. package/dist/canvas/AnnotationCanvas.native.js +6 -0
  5. package/dist/canvas/AnnotationCanvasInner.d.ts +39 -0
  6. package/dist/canvas/AnnotationCanvasInner.js +219 -0
  7. package/dist/canvas/AnnotationCanvasInner.native.d.ts +35 -0
  8. package/dist/canvas/AnnotationCanvasInner.native.js +138 -0
  9. package/dist/canvas/AnnotationCanvasSkia.d.ts +27 -0
  10. package/dist/canvas/AnnotationCanvasSkia.js +20 -0
  11. package/dist/canvas/Tool.d.ts +38 -0
  12. package/dist/canvas/Tool.js +1 -0
  13. package/dist/canvas/elements/BackgroundImageElement.d.ts +9 -0
  14. package/dist/canvas/elements/BackgroundImageElement.js +37 -0
  15. package/dist/canvas/elements/MeasurementStampElement.d.ts +13 -0
  16. package/dist/canvas/elements/MeasurementStampElement.js +30 -0
  17. package/dist/canvas/elements/ShapeElement.d.ts +7 -0
  18. package/dist/canvas/elements/ShapeElement.js +62 -0
  19. package/dist/canvas/elements/StrokeElement.d.ts +7 -0
  20. package/dist/canvas/elements/StrokeElement.js +18 -0
  21. package/dist/canvas/measurementPicker.d.ts +10 -0
  22. package/dist/canvas/measurementPicker.js +1 -0
  23. package/dist/canvas/measurementStampOverlay.d.ts +11 -0
  24. package/dist/canvas/measurementStampOverlay.js +1 -0
  25. package/dist/canvas/pointerAdapter.d.ts +3 -0
  26. package/dist/canvas/pointerAdapter.js +19 -0
  27. package/dist/canvas/stampLayout.d.ts +5 -0
  28. package/dist/canvas/stampLayout.js +14 -0
  29. package/dist/canvas/tools/measurementStampTool.d.ts +9 -0
  30. package/dist/canvas/tools/measurementStampTool.js +37 -0
  31. package/dist/canvas/tools/panTool.d.ts +5 -0
  32. package/dist/canvas/tools/panTool.js +25 -0
  33. package/dist/canvas/tools/penTool.d.ts +13 -0
  34. package/dist/canvas/tools/penTool.js +68 -0
  35. package/dist/canvas/tools/selectTool.d.ts +2 -0
  36. package/dist/canvas/tools/selectTool.js +182 -0
  37. package/dist/canvas/useAnnotationCanvasState.d.ts +54 -0
  38. package/dist/canvas/useAnnotationCanvasState.js +210 -0
  39. package/dist/canvas/viewport.d.ts +16 -0
  40. package/dist/canvas/viewport.js +54 -0
  41. package/dist/data/AnnotationDataContext.d.ts +8 -0
  42. package/dist/data/AnnotationDataContext.js +11 -0
  43. package/dist/data/AnnotationDataProvider.d.ts +65 -0
  44. package/dist/data/AnnotationDataProvider.js +4 -0
  45. package/dist/data/InMemoryAnnotationProvider.d.ts +30 -0
  46. package/dist/data/InMemoryAnnotationProvider.js +197 -0
  47. package/dist/data/canvasPersistence.d.ts +3 -0
  48. package/dist/data/canvasPersistence.js +26 -0
  49. package/dist/data/hooks/useAnnotationCanvasDoc.d.ts +33 -0
  50. package/dist/data/hooks/useAnnotationCanvasDoc.js +314 -0
  51. package/dist/data/hooks/useAnnotationDoc.d.ts +7 -0
  52. package/dist/data/hooks/useAnnotationDoc.js +33 -0
  53. package/dist/data/hooks/useAnnotationList.d.ts +7 -0
  54. package/dist/data/hooks/useAnnotationList.js +26 -0
  55. package/dist/data/hooks/useAnnotationMutations.d.ts +9 -0
  56. package/dist/data/hooks/useAnnotationMutations.js +11 -0
  57. package/dist/export/buildJobCsv.d.ts +26 -0
  58. package/dist/export/buildJobCsv.js +189 -0
  59. package/dist/export/config.d.ts +18 -0
  60. package/dist/export/config.js +72 -0
  61. package/dist/export/desktopLinks.d.ts +11 -0
  62. package/dist/export/desktopLinks.js +45 -0
  63. package/dist/export/objectKinds.d.ts +3 -0
  64. package/dist/export/objectKinds.js +28 -0
  65. package/dist/exports.d.ts +5 -1
  66. package/dist/exports.js +7 -1
  67. package/dist/hooks/useParseMeasurement.d.ts +4 -0
  68. package/dist/hooks/useParseMeasurement.js +14 -0
  69. package/dist/utils/evaluateFormula.d.ts +20 -0
  70. package/dist/utils/evaluateFormula.js +31 -0
  71. package/dist/utils/groups.d.ts +2 -1
  72. package/dist/utils/groups.js +14 -0
  73. package/package.json +1 -1
  74. package/dist/annotation/canvas/tools/measurementLineTool.d.ts +0 -12
  75. package/dist/annotation/canvas/tools/measurementLineTool.js +0 -95
@@ -0,0 +1,314 @@
1
+ import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
2
+ import { applyPatch, createEmptyCanvasState, } from '../../types/annotation.js';
3
+ import { FileUploadType } from '../../types/firestore.js';
4
+ import { useAnnotationDoc } from './useAnnotationDoc.js';
5
+ import { useAnnotationMutations } from './useAnnotationMutations.js';
6
+ import { hydrateCanvasState } from '../canvasPersistence.js';
7
+ // Stable placeholder so useAnnotationMutations (which requires a non-null
8
+ // scope) can be called unconditionally. Never used to write — flushes are
9
+ // guarded on a real scope.
10
+ const EMPTY_SCOPE = {
11
+ orgId: '',
12
+ projectId: '',
13
+ jobId: '',
14
+ groupId: '',
15
+ };
16
+ // Build the persisted fileData, omitting `isLabel` when undefined so the write
17
+ // contains no undefined values (Firestore rejects them on RN).
18
+ const buildFileData = (fileType, isLabel, canvas) => ({
19
+ fileType,
20
+ ...(isLabel !== undefined ? { isLabel } : {}),
21
+ canvas,
22
+ });
23
+ // Orchestrates load + auto-save for the annotation canvas. Hydrates the working
24
+ // state from the persisted doc, applies commits optimistically, and persists
25
+ // (debounced) through the data provider — creating the file on first save when
26
+ // no `fileId` was supplied. Composes the existing low-level hooks so it stays
27
+ // decoupled from any specific Firebase SDK.
28
+ export const useAnnotationCanvasDoc = (options) => {
29
+ const { scope, fileId, fallbackViewport, debounceMs = 800, createSeed, onFileCreated, onSaveError, captureThumbnail, debugLogging = false, } = options;
30
+ const { data, loading, error } = useAnnotationDoc(scope, fileId);
31
+ const { create, update, uploadImage, deleteImage } = useAnnotationMutations(scope ?? EMPTY_SCOPE);
32
+ const [working, setWorking] = useState(null);
33
+ const [saveStatus, setSaveStatus] = useState('idle');
34
+ // Refs let the debounced/unmount flush read the latest values without
35
+ // re-creating timers on every keystroke.
36
+ const workingRef = useRef(null);
37
+ const dataRef = useRef(data);
38
+ const statusRef = useRef('idle');
39
+ const timerRef = useRef(null);
40
+ const createRef = useRef(create);
41
+ const updateRef = useRef(update);
42
+ const fileIdRef = useRef(fileId);
43
+ // Id of a file this hook created on first save (when opened with no fileId).
44
+ // Used for subsequent updates and to recognize the caller echoing it back
45
+ // into `fileId`.
46
+ const createdIdRef = useRef(null);
47
+ const createSeedRef = useRef(createSeed);
48
+ const onFileCreatedRef = useRef(onFileCreated);
49
+ const onSaveErrorRef = useRef(onSaveError);
50
+ const captureThumbnailRef = useRef(captureThumbnail);
51
+ const uploadImageRef = useRef(uploadImage);
52
+ // Guards against overlapping thumbnail captures (each save fires one).
53
+ const thumbnailSavingRef = useRef(false);
54
+ const debugRef = useRef(debugLogging);
55
+ // JSON of the canvas we last wrote, to recognize (and ignore) the snapshot
56
+ // echo of our own write when reconciling incoming remote changes.
57
+ const lastSavedJsonRef = useRef(null);
58
+ // Guards against two creates racing if flushes overlap.
59
+ const creatingRef = useRef(false);
60
+ workingRef.current = working;
61
+ dataRef.current = data;
62
+ statusRef.current = saveStatus;
63
+ createRef.current = create;
64
+ updateRef.current = update;
65
+ createSeedRef.current = createSeed;
66
+ onFileCreatedRef.current = onFileCreated;
67
+ onSaveErrorRef.current = onSaveError;
68
+ captureThumbnailRef.current = captureThumbnail;
69
+ uploadImageRef.current = uploadImage;
70
+ debugRef.current = debugLogging;
71
+ const setStatus = useCallback((next) => {
72
+ statusRef.current = next;
73
+ setSaveStatus(next);
74
+ }, []);
75
+ // Fire-and-forget thumbnail capture + upload, run after each successful save.
76
+ // Stable identity (reads refs) so it doesn't churn `flush`'s deps. Skips when
77
+ // no capturer is supplied or a capture is already in flight.
78
+ const saveThumbnail = useCallback(async (fileId) => {
79
+ const capture = captureThumbnailRef.current;
80
+ if (!capture || thumbnailSavingRef.current)
81
+ return;
82
+ thumbnailSavingRef.current = true;
83
+ try {
84
+ const blob = await capture();
85
+ if (blob)
86
+ await uploadImageRef.current(fileId, 'thumbnail', blob);
87
+ }
88
+ catch (e) {
89
+ console.warn('[useAnnotationCanvasDoc] thumbnail save failed', e);
90
+ }
91
+ finally {
92
+ thumbnailSavingRef.current = false;
93
+ }
94
+ }, []);
95
+ // Reset working state when the target document changes so the next snapshot
96
+ // hydrates the new file rather than leaking the previous one. Skip the reset
97
+ // when the new fileId is one we just created (the caller echoing it back) —
98
+ // our working state is already correct and must not be wiped.
99
+ useEffect(() => {
100
+ if (fileIdRef.current === fileId)
101
+ return;
102
+ fileIdRef.current = fileId;
103
+ if (fileId !== null && fileId === createdIdRef.current)
104
+ return;
105
+ if (timerRef.current) {
106
+ clearTimeout(timerRef.current);
107
+ timerRef.current = null;
108
+ }
109
+ createdIdRef.current = null;
110
+ lastSavedJsonRef.current = null;
111
+ setWorking(null);
112
+ setStatus('idle');
113
+ }, [fileId, setStatus]);
114
+ // Hydrate / reconcile from the persisted doc.
115
+ useEffect(() => {
116
+ // First load — always hydrate.
117
+ if (workingRef.current === null) {
118
+ setWorking(hydrateCanvasState(data, fallbackViewport));
119
+ lastSavedJsonRef.current = data?.fileData.canvas
120
+ ? JSON.stringify(data.fileData.canvas)
121
+ : null;
122
+ return;
123
+ }
124
+ // A write of ours is queued or in flight — ignore the snapshot; it is
125
+ // either the echo of our write or about to be superseded by it.
126
+ if (statusRef.current === 'saving' || timerRef.current !== null)
127
+ return;
128
+ // Clean locally: accept a genuine remote change, but ignore the echo of
129
+ // our own last write (same content).
130
+ const incoming = data?.fileData.canvas;
131
+ if (!incoming)
132
+ return;
133
+ const incomingJson = JSON.stringify(incoming);
134
+ if (incomingJson === lastSavedJsonRef.current)
135
+ return;
136
+ lastSavedJsonRef.current = incomingJson;
137
+ setWorking(hydrateCanvasState(data, fallbackViewport));
138
+ // eslint-disable-next-line react-hooks/exhaustive-deps
139
+ }, [data]);
140
+ const flush = useCallback(async () => {
141
+ if (timerRef.current) {
142
+ clearTimeout(timerRef.current);
143
+ timerRef.current = null;
144
+ }
145
+ const canvas = workingRef.current;
146
+ // Nothing to persist, or no real target scope yet.
147
+ if (!canvas || !scope)
148
+ return;
149
+ if (creatingRef.current)
150
+ return;
151
+ const json = JSON.stringify(canvas);
152
+ const id = fileIdRef.current ?? createdIdRef.current;
153
+ const mode = id ? 'update' : 'create';
154
+ const debug = debugRef.current;
155
+ if (debug) {
156
+ console.log('[useAnnotationCanvasDoc] save attempt', {
157
+ mode,
158
+ fileId: id,
159
+ scope,
160
+ bytes: json.length,
161
+ strokes: canvas.strokes.length,
162
+ shapes: canvas.shapes.length,
163
+ measurements: canvas.placedMeasurements.length,
164
+ });
165
+ }
166
+ // Round-trip through JSON to drop `undefined` keys (e.g. an empty canvas's
167
+ // viewport.backgroundImage/backgroundFit). Firestore — RN in particular —
168
+ // rejects undefined field values unless ignoreUndefinedProperties is set.
169
+ const canvasPayload = JSON.parse(json);
170
+ setStatus('saving');
171
+ try {
172
+ if (!id) {
173
+ // First save with no file — create the doc seeded with the canvas.
174
+ creatingRef.current = true;
175
+ const seed = createSeedRef.current;
176
+ const newId = await createRef.current({
177
+ type: FileUploadType.Canvas,
178
+ ...(seed?.name !== undefined ? { name: seed.name } : {}),
179
+ fileData: buildFileData(seed?.fileType ?? 'sketch', seed?.isLabel, canvasPayload),
180
+ });
181
+ creatingRef.current = false;
182
+ createdIdRef.current = newId;
183
+ if (debug) {
184
+ console.log('[useAnnotationCanvasDoc] created file', newId);
185
+ }
186
+ onFileCreatedRef.current?.(newId);
187
+ }
188
+ else {
189
+ const doc = dataRef.current;
190
+ await updateRef.current(id, {
191
+ fileData: buildFileData(doc?.fileData.fileType ??
192
+ createSeedRef.current?.fileType ??
193
+ 'sketch', doc?.fileData.isLabel ?? createSeedRef.current?.isLabel, canvasPayload),
194
+ });
195
+ if (debug) {
196
+ console.log('[useAnnotationCanvasDoc] updated file', id);
197
+ }
198
+ }
199
+ lastSavedJsonRef.current = json;
200
+ // Refresh the file's thumbnail to match what was just saved (fire and
201
+ // forget — never blocks or fails the save).
202
+ const savedId = fileIdRef.current ?? createdIdRef.current;
203
+ if (savedId)
204
+ void saveThumbnail(savedId);
205
+ // If new edits landed mid-flight, stay dirty and let the next debounce
206
+ // (or unmount) flush them.
207
+ const latest = workingRef.current;
208
+ if (latest && JSON.stringify(latest) !== json) {
209
+ setStatus('dirty');
210
+ }
211
+ else {
212
+ setStatus('saved');
213
+ }
214
+ }
215
+ catch (e) {
216
+ creatingRef.current = false;
217
+ // Always log save failures with context — these are otherwise invisible
218
+ // (the canvas keeps working from local state).
219
+ console.error(`[useAnnotationCanvasDoc] ${mode} failed`, { fileId: id, scope, bytes: json.length }, e);
220
+ onSaveErrorRef.current?.(e);
221
+ setStatus('error');
222
+ }
223
+ }, [scope, setStatus, saveThumbnail]);
224
+ const onCommit = useCallback((patch) => {
225
+ setWorking((prev) => (prev ? applyPatch(prev, patch) : prev));
226
+ setStatus('dirty');
227
+ if (timerRef.current)
228
+ clearTimeout(timerRef.current);
229
+ timerRef.current = setTimeout(() => {
230
+ timerRef.current = null;
231
+ void flush();
232
+ }, debounceMs);
233
+ }, [debounceMs, flush, setStatus]);
234
+ const ensureFileId = useCallback(async () => {
235
+ const existing = fileIdRef.current ?? createdIdRef.current;
236
+ if (existing)
237
+ return existing;
238
+ // No file yet — seed an empty canvas if nothing has hydrated, then flush
239
+ // so the existing create branch mints the doc.
240
+ if (!workingRef.current) {
241
+ const seeded = createEmptyCanvasState(fallbackViewport);
242
+ workingRef.current = seeded;
243
+ setWorking(seeded);
244
+ }
245
+ await flush();
246
+ const id = fileIdRef.current ?? createdIdRef.current;
247
+ if (!id) {
248
+ throw new Error('Unable to create annotation file before background upload');
249
+ }
250
+ return id;
251
+ }, [flush, fallbackViewport]);
252
+ const setBackgroundImage = useCallback(async (blob, dims, fit = 'contain') => {
253
+ const id = await ensureFileId();
254
+ const ref = await uploadImage(id, 'background', blob);
255
+ onCommit({
256
+ ops: [
257
+ {
258
+ op: 'setViewport',
259
+ patch: {
260
+ backgroundImage: {
261
+ storagePath: ref.storagePath,
262
+ downloadUrl: ref.downloadUrl,
263
+ widthPx: dims.width,
264
+ heightPx: dims.height,
265
+ },
266
+ backgroundFit: fit,
267
+ },
268
+ },
269
+ ],
270
+ });
271
+ }, [ensureFileId, uploadImage, onCommit]);
272
+ const clearBackgroundImage = useCallback(async () => {
273
+ const bg = workingRef.current?.viewport.backgroundImage;
274
+ const id = fileIdRef.current ?? createdIdRef.current;
275
+ if (bg && id) {
276
+ try {
277
+ await deleteImage(id, bg.storagePath);
278
+ }
279
+ catch (e) {
280
+ // Non-fatal: still clear the viewport reference even if the storage
281
+ // object is already gone.
282
+ console.warn('[useAnnotationCanvasDoc] failed to delete background image', e);
283
+ }
284
+ }
285
+ onCommit({
286
+ ops: [
287
+ {
288
+ op: 'setViewport',
289
+ patch: { backgroundImage: undefined, backgroundFit: undefined },
290
+ },
291
+ ],
292
+ });
293
+ }, [deleteImage, onCommit]);
294
+ // Flush any pending edits on unmount.
295
+ useEffect(() => () => {
296
+ if (timerRef.current) {
297
+ clearTimeout(timerRef.current);
298
+ timerRef.current = null;
299
+ void flush();
300
+ }
301
+ }, [flush]);
302
+ const canvas = useMemo(() => working ?? createEmptyCanvasState(fallbackViewport), [working, fallbackViewport]);
303
+ return {
304
+ canvas,
305
+ onCommit,
306
+ loading,
307
+ error,
308
+ saveStatus,
309
+ save: flush,
310
+ ensureFileId,
311
+ setBackgroundImage,
312
+ clearBackgroundImage,
313
+ };
314
+ };
@@ -0,0 +1,7 @@
1
+ import type { AnnotationFile, JobGroupScope } from '../AnnotationDataProvider.js';
2
+ export interface UseAnnotationDocResult {
3
+ data: AnnotationFile | null;
4
+ loading: boolean;
5
+ error: Error | null;
6
+ }
7
+ export declare const useAnnotationDoc: (scope: JobGroupScope | null, fileId: string | null) => UseAnnotationDocResult;
@@ -0,0 +1,33 @@
1
+ import { useEffect, useState } from 'react';
2
+ import { useAnnotationData } from '../AnnotationDataContext.js';
3
+ export const useAnnotationDoc = (scope, fileId) => {
4
+ const provider = useAnnotationData();
5
+ const [data, setData] = useState(null);
6
+ const [loading, setLoading] = useState(true);
7
+ const [error, setError] = useState(null);
8
+ useEffect(() => {
9
+ if (!scope || !fileId) {
10
+ setData(null);
11
+ setLoading(false);
12
+ return;
13
+ }
14
+ setLoading(true);
15
+ setError(null);
16
+ const unsubscribe = provider.subscribe(scope, fileId, (doc) => {
17
+ setData(doc);
18
+ setLoading(false);
19
+ }, (err) => {
20
+ setError(err);
21
+ setLoading(false);
22
+ });
23
+ return unsubscribe;
24
+ }, [
25
+ provider,
26
+ scope?.orgId,
27
+ scope?.projectId,
28
+ scope?.jobId,
29
+ scope?.groupId,
30
+ fileId,
31
+ ]);
32
+ return { data, loading, error };
33
+ };
@@ -0,0 +1,7 @@
1
+ import type { AnnotationFileSummary, JobGroupScope } from '../AnnotationDataProvider.js';
2
+ export interface UseAnnotationListResult {
3
+ files: AnnotationFileSummary[];
4
+ loading: boolean;
5
+ error: Error | null;
6
+ }
7
+ export declare const useAnnotationList: (scope: JobGroupScope | null) => UseAnnotationListResult;
@@ -0,0 +1,26 @@
1
+ import { useEffect, useState } from 'react';
2
+ import { useAnnotationData } from '../AnnotationDataContext.js';
3
+ export const useAnnotationList = (scope) => {
4
+ const provider = useAnnotationData();
5
+ const [files, setFiles] = useState([]);
6
+ const [loading, setLoading] = useState(true);
7
+ const [error, setError] = useState(null);
8
+ useEffect(() => {
9
+ if (!scope) {
10
+ setFiles([]);
11
+ setLoading(false);
12
+ return;
13
+ }
14
+ setLoading(true);
15
+ setError(null);
16
+ const unsubscribe = provider.list(scope, (next) => {
17
+ setFiles(next);
18
+ setLoading(false);
19
+ }, (err) => {
20
+ setError(err);
21
+ setLoading(false);
22
+ });
23
+ return unsubscribe;
24
+ }, [provider, scope?.orgId, scope?.projectId, scope?.jobId, scope?.groupId]);
25
+ return { files, loading, error };
26
+ };
@@ -0,0 +1,9 @@
1
+ import type { AnnotationFile, ImageBlob, JobGroupScope, Patch, UploadedImageRef } from '../AnnotationDataProvider.js';
2
+ export interface AnnotationMutations {
3
+ create(seed: Partial<AnnotationFile>): Promise<string>;
4
+ update(fileId: string, patch: Patch<AnnotationFile>): Promise<void>;
5
+ remove(fileId: string): Promise<void>;
6
+ uploadImage(fileId: string, role: 'background' | 'thumbnail', blob: ImageBlob): Promise<UploadedImageRef>;
7
+ deleteImage(fileId: string, storagePath: string): Promise<void>;
8
+ }
9
+ export declare const useAnnotationMutations: (scope: JobGroupScope) => AnnotationMutations;
@@ -0,0 +1,11 @@
1
+ import { useCallback, useMemo } from 'react';
2
+ import { useAnnotationData } from '../AnnotationDataContext.js';
3
+ export const useAnnotationMutations = (scope) => {
4
+ const provider = useAnnotationData();
5
+ const create = useCallback((seed) => provider.create(scope, seed), [provider, scope.orgId, scope.projectId, scope.jobId, scope.groupId]);
6
+ const update = useCallback((fileId, patch) => provider.update(scope, fileId, patch), [provider, scope.orgId, scope.projectId, scope.jobId, scope.groupId]);
7
+ const remove = useCallback((fileId) => provider.delete(scope, fileId), [provider, scope.orgId, scope.projectId, scope.jobId, scope.groupId]);
8
+ const uploadImage = useCallback((fileId, role, blob) => provider.uploadImage(scope, fileId, role, blob), [provider, scope.orgId, scope.projectId, scope.jobId, scope.groupId]);
9
+ const deleteImage = useCallback((fileId, storagePath) => provider.deleteImage(scope, fileId, storagePath), [provider, scope.orgId, scope.projectId, scope.jobId, scope.groupId]);
10
+ return useMemo(() => ({ create, update, remove, uploadImage, deleteImage }), [create, update, remove, uploadImage, deleteImage]);
11
+ };
@@ -0,0 +1,26 @@
1
+ import { type DecimalTolerance, type Formula, type FractionalTolerance, type Group, type Measurement, type Section, type Units } from '../types/firestore.js';
2
+ import type { ExportConfig } from './config.js';
3
+ export type ExportScope = 'all' | 'activeGroup';
4
+ export type ExportObjectRow = {
5
+ name: string;
6
+ url: string | null;
7
+ };
8
+ export type BuildJobCsvInput = {
9
+ scope: ExportScope;
10
+ activeGroupId?: string | null;
11
+ config: ExportConfig;
12
+ groups: Group[];
13
+ sections: Section[];
14
+ formulas: Formula[];
15
+ measurementsByGroup: Map<string, Measurement[]>;
16
+ objectsByGroup: Map<string, ExportObjectRow[]>;
17
+ formatMeasurementValue: (value: number, device?: string) => string;
18
+ unitPrefs: {
19
+ defaultUnit?: Units;
20
+ fractionalTolerance?: FractionalTolerance;
21
+ decimalTolerance?: DecimalTolerance;
22
+ };
23
+ };
24
+ export declare const escapeCSVField: (field: string) => string;
25
+ export declare const hyperlinkCell: (url: string, label: string) => string;
26
+ export declare function buildJobCsv(input: BuildJobCsvInput): string;
@@ -0,0 +1,189 @@
1
+ import { ColumnType, GroupType, } from '../types/firestore.js';
2
+ import { calculateFormula } from '../formulas/calculateFormula.js';
3
+ import { formatSelectedValues } from '../utils/selectValues.js';
4
+ import { isDefaultGroup, isFormGroupCompleted } from '../utils/groups.js';
5
+ export const escapeCSVField = (field) => `"${field.replace(/"/g, '""')}"`;
6
+ // Spreadsheet-formula hyperlink cell. Two escaping layers: quotes inside the
7
+ // formula's string literals are doubled (Excel/Sheets escaping), then the
8
+ // whole formula is CSV-escaped.
9
+ export const hyperlinkCell = (url, label) => escapeCSVField(`=HYPERLINK("${url.replace(/"/g, '""')}","${label.replace(/"/g, '""')}")`);
10
+ const objectCell = (obj) => obj.url ? hyperlinkCell(obj.url, obj.name) : escapeCSVField(obj.name);
11
+ // Pure CSV assembly for the job export, shared by rock-pro-app and
12
+ // rock-desktop so the two platforms emit identical files. With no objects
13
+ // selected and all measurement-data columns on, the measurement sections are
14
+ // identical to the legacy exportCSV output; objects add a trailing "Objects"
15
+ // column (list groups) or extend the form row (form groups), one skipped
16
+ // column after the existing cells.
17
+ export function buildJobCsv(input) {
18
+ const { scope, activeGroupId, config, groups, sections, formulas, measurementsByGroup, objectsByGroup, formatMeasurementValue, unitPrefs, } = input;
19
+ const csvRows = [];
20
+ let listGroups;
21
+ let formGroups;
22
+ if (scope === 'activeGroup') {
23
+ const active = groups.find((g) => g.id === activeGroupId);
24
+ listGroups = active?.type === GroupType.LIST ? [active] : [];
25
+ formGroups = active?.type === GroupType.FORM ? [active] : [];
26
+ }
27
+ else {
28
+ listGroups = groups.filter((g) => g.type === GroupType.LIST &&
29
+ config.categories.includes(isDefaultGroup(g) ? 'defaultGroup' : 'groups'));
30
+ formGroups = config.categories.includes('forms')
31
+ ? groups.filter((g) => g.type === GroupType.FORM)
32
+ : [];
33
+ }
34
+ const measurementPassesFilter = (m) => config.measurements === 'all' ||
35
+ (config.measurements === 'complete'
36
+ ? m.isCompleted === true
37
+ : m.isCompleted !== true);
38
+ const includeField = (field) => config.measurementData.includes(field);
39
+ // --- List Groups ---
40
+ if (listGroups.length > 0) {
41
+ csvRows.push('List Groups');
42
+ csvRows.push('');
43
+ listGroups.forEach((group) => {
44
+ csvRows.push(`Group: ${group.name}`);
45
+ const objects = objectsByGroup.get(group.id) ?? [];
46
+ const headerCells = [
47
+ '',
48
+ ...(includeField('measurement') ? ['Measurement'] : []),
49
+ ...(includeField('label') ? ['Label'] : []),
50
+ ...(includeField('notes') ? ['Notes'] : []),
51
+ ].map(escapeCSVField);
52
+ if (objects.length > 0) {
53
+ headerCells.push(escapeCSVField(''), escapeCSVField('Objects'));
54
+ }
55
+ csvRows.push(headerCells.join(','));
56
+ const measurements = (measurementsByGroup.get(group.id) ?? []).filter(measurementPassesFilter);
57
+ // Objects fill a parallel column, one per row from the top; extra rows
58
+ // are emitted when a group has more objects than measurements.
59
+ const rowCount = Math.max(measurements.length, objects.length);
60
+ for (let i = 0; i < rowCount; i++) {
61
+ const measurement = measurements[i];
62
+ const row = [escapeCSVField('')];
63
+ if (includeField('measurement')) {
64
+ row.push(escapeCSVField(measurement
65
+ ? formatMeasurementValue(measurement.value, measurement.device)
66
+ : ''));
67
+ }
68
+ if (includeField('label')) {
69
+ row.push(escapeCSVField(measurement?.label || ''));
70
+ }
71
+ if (includeField('notes')) {
72
+ row.push(escapeCSVField(measurement?.note || ''));
73
+ }
74
+ const obj = objects[i];
75
+ if (obj) {
76
+ row.push(escapeCSVField(''), objectCell(obj));
77
+ }
78
+ csvRows.push(row.join(','));
79
+ }
80
+ csvRows.push('');
81
+ });
82
+ }
83
+ // --- Form Groups ---
84
+ if (formGroups.length > 0) {
85
+ csvRows.push('Form Groups');
86
+ csvRows.push('');
87
+ const sectionIds = [...new Set(formGroups.map((g) => g.sectionId))];
88
+ sectionIds.forEach((sectionId) => {
89
+ const section = sections.find((s) => s.id === sectionId);
90
+ if (!section)
91
+ return;
92
+ const sectionGroups = formGroups.filter((g) => g.sectionId === sectionId);
93
+ if (sectionGroups.length === 0)
94
+ return;
95
+ csvRows.push(`Section: ${section.name}`);
96
+ csvRows.push('');
97
+ const columnHeaders = [];
98
+ section.tableConfig.forEach((column) => {
99
+ columnHeaders.push(column.name);
100
+ if (column.type === ColumnType.Measurement ||
101
+ column.type === ColumnType.Angle) {
102
+ columnHeaders.push(`${column.name} Notes`);
103
+ }
104
+ });
105
+ csvRows.push(['Form Name', ...columnHeaders].map(escapeCSVField).join(','));
106
+ sectionGroups.forEach((group) => {
107
+ // The completeness filter drops whole rows (their objects with
108
+ // them); cell references below still resolve against the group's
109
+ // full measurement list.
110
+ if (config.measurements !== 'all') {
111
+ const completed = isFormGroupCompleted(group, section);
112
+ if (config.measurements === 'complete' ? !completed : completed) {
113
+ return;
114
+ }
115
+ }
116
+ const row = [];
117
+ section.tableConfig.forEach((column) => {
118
+ if (column.type === ColumnType.Formula) {
119
+ const formula = formulas.find((f) => f.id === column.columnData?.formulaId);
120
+ if (formula) {
121
+ try {
122
+ const result = calculateFormula(formula, formulas, group.columns, section.tableConfig, measurementsByGroup.get(group.id) ?? [], unitPrefs.defaultUnit, unitPrefs.fractionalTolerance, unitPrefs.decimalTolerance);
123
+ if (result !== null &&
124
+ result !== undefined &&
125
+ typeof result === 'number') {
126
+ row.push(escapeCSVField(formatMeasurementValue(result)));
127
+ }
128
+ else {
129
+ row.push(escapeCSVField(result !== null && result !== undefined
130
+ ? String(result)
131
+ : ''));
132
+ }
133
+ }
134
+ catch {
135
+ row.push('');
136
+ }
137
+ }
138
+ else {
139
+ row.push('');
140
+ }
141
+ }
142
+ else if (column.type === ColumnType.Angle) {
143
+ const measurementId = group.columns[column.id];
144
+ const measurements = measurementsByGroup.get(group.id);
145
+ const measurement = measurements?.find((m) => m.id === measurementId);
146
+ if (measurement) {
147
+ row.push(escapeCSVField(`${measurement.value}°`));
148
+ }
149
+ else {
150
+ row.push(escapeCSVField(formatSelectedValues(group.columns[column.id])));
151
+ }
152
+ }
153
+ else if (column.id in group.columns) {
154
+ const measurementId = group.columns[column.id];
155
+ const measurements = measurementsByGroup.get(group.id);
156
+ const measurement = measurements?.find((m) => m.id === measurementId);
157
+ if (measurement) {
158
+ row.push(escapeCSVField(formatMeasurementValue(measurement.value, measurement.device)));
159
+ }
160
+ else {
161
+ row.push(escapeCSVField(formatSelectedValues(group.columns[column.id])));
162
+ }
163
+ }
164
+ else {
165
+ row.push('');
166
+ }
167
+ if (column.type === ColumnType.Measurement ||
168
+ column.type === ColumnType.Angle) {
169
+ if (group.descriptions && group.descriptions[column.id]) {
170
+ row.push(escapeCSVField(group.descriptions[column.id]));
171
+ }
172
+ else {
173
+ row.push('');
174
+ }
175
+ }
176
+ });
177
+ // Objects extend the row past the table, one skipped column after
178
+ // the last cell.
179
+ const objects = objectsByGroup.get(group.id) ?? [];
180
+ if (objects.length > 0) {
181
+ row.push(escapeCSVField(''), ...objects.map(objectCell));
182
+ }
183
+ csvRows.push([escapeCSVField(group.name), ...row].join(','));
184
+ });
185
+ csvRows.push('');
186
+ });
187
+ }
188
+ return csvRows.join('\n');
189
+ }
@@ -0,0 +1,18 @@
1
+ export type ExportCategory = 'defaultGroup' | 'groups' | 'forms';
2
+ export type ExportObjectType = 'calculators' | 'files' | 'photos' | 'cad' | 'labels' | 'notes';
3
+ export type ExportMeasurementFilter = 'all' | 'complete' | 'incomplete';
4
+ export type ExportImageFormat = 'hyperlink' | 'none';
5
+ export type ExportMeasurementDataField = 'measurement' | 'label' | 'notes';
6
+ export type ExportConfig = {
7
+ categories: ExportCategory[];
8
+ objects: ExportObjectType[];
9
+ measurements: ExportMeasurementFilter;
10
+ imageFormat: ExportImageFormat;
11
+ measurementData: ExportMeasurementDataField[];
12
+ };
13
+ export declare const ALL_EXPORT_CATEGORIES: ExportCategory[];
14
+ export declare const ALL_EXPORT_OBJECT_TYPES: ExportObjectType[];
15
+ export declare const ALL_EXPORT_MEASUREMENT_DATA_FIELDS: ExportMeasurementDataField[];
16
+ export declare const DEFAULT_EXPORT_CONFIG: ExportConfig;
17
+ export declare const EXPORT_EVERYTHING_CONFIG: ExportConfig;
18
+ export declare function normalizeExportConfig(raw: unknown): ExportConfig;