forked from ZyntariHQ/Invoisio
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathuse-draft-autosave.ts
More file actions
424 lines (386 loc) · 13.1 KB
/
Copy pathuse-draft-autosave.ts
File metadata and controls
424 lines (386 loc) · 13.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
import { useState, useEffect, useRef, useCallback } from "react";
import { DraftService } from "@/lib/draft-service";
import type { DraftInvoice, UpdateDraftDto, CreateDraftDto } from "@/lib/types/draft.types";
/**
* Configuration for the draft autosave hook
*/
interface UseDraftAutosaveConfig {
/** Delay in milliseconds before autosave triggers (default: 3000) */
autosaveDelay?: number;
/** Minimum interval between autosaves (default: 5000) */
minAutosaveInterval?: number;
/** Whether to enable autosave (default: true) */
enabled?: boolean;
/** Callback when draft is successfully saved */
onSave?: (draft: DraftInvoice) => void;
/** Callback when draft save fails */
onError?: (error: Error) => void;
/** Callback when draft is converted to invoice */
onConvert?: (invoice: unknown) => void;
}
/**
* Return type for useDraftAutosave hook
*/
interface UseDraftAutosaveReturn {
/** Current draft data */
draft: DraftInvoice | null;
/** Whether draft is currently loading */
isLoading: boolean;
/** Whether draft is currently saving */
isSaving: boolean;
/** Whether draft is being converted */
isConverting: boolean;
/** Error message if any */
error: string | null;
/** Last save time */
lastSavedAt: Date | null;
/** Update draft fields (triggers autosave) */
updateDraft: (updates: UpdateDraftDto) => void;
/** Manually save the draft immediately */
saveDraft: () => Promise<DraftInvoice>;
/** Manually trigger autosave (bypasses debounce) */
triggerAutosave: () => Promise<DraftInvoice>;
/** Convert draft to invoice */
convertToInvoice: () => Promise<unknown>;
/** Discard the draft */
discardDraft: () => Promise<{ id: string; discarded: boolean }>;
/** Reset the draft state */
resetDraft: () => void;
/** Check if draft has all required fields */
isComplete: boolean;
/** Draft completion percentage */
completionPercentage: number;
/** Refetch the draft from server */
refreshDraft: () => Promise<void>;
}
/**
* Hook for managing draft invoice autosave functionality
* Handles debounced autosave, error recovery, and draft lifecycle
*/
export function useDraftAutosave(
draftId?: string,
config: UseDraftAutosaveConfig = {}
): UseDraftAutosaveReturn {
const {
autosaveDelay = 3000,
minAutosaveInterval = 5000,
enabled = true,
onSave,
onError,
onConvert,
} = config;
const [draft, setDraft] = useState<DraftInvoice | null>(null);
const [isLoading, setIsLoading] = useState(true);
const [isSaving, setIsSaving] = useState(false);
const [isConverting, setIsConverting] = useState(false);
const [error, setError] = useState<string | null>(null);
const [lastSavedAt, setLastSavedAt] = useState<Date | null>(null);
const [pendingUpdates, setPendingUpdates] = useState<UpdateDraftDto>({});
const autosaveTimeoutRef = useRef<ReturnType<typeof setTimeout> | null>(null);
const lastAutosaveTimeRef = useRef<number>(0);
const isMountedRef = useRef(true);
const isDraftCreatedRef = useRef(false);
// Load draft on mount or draftId change
useEffect(() => {
async function loadDraft() {
if (!draftId) {
// Create a new empty draft if no ID provided
try {
const newDraft = await DraftService.createDraft({});
if (isMountedRef.current) {
setDraft(newDraft);
isDraftCreatedRef.current = true;
setLastSavedAt(new Date());
}
} catch (err) {
if (isMountedRef.current) {
const errorMsg = err instanceof Error ? err.message : String(err);
setError(`Failed to create draft: ${errorMsg}`);
onError?.(err instanceof Error ? err : new Error(errorMsg));
}
} finally {
if (isMountedRef.current) {
setIsLoading(false);
}
}
return;
}
try {
const existingDraft = await DraftService.getDraft(draftId);
if (isMountedRef.current) {
setDraft(existingDraft);
setLastSavedAt(existingDraft.lastAutoSavedAt ? new Date(existingDraft.lastAutoSavedAt) : null);
}
} catch (err) {
if (isMountedRef.current) {
const errorMsg = err instanceof Error ? err.message : String(err);
setError(`Failed to load draft: ${errorMsg}`);
onError?.(err instanceof Error ? err : new Error(errorMsg));
}
} finally {
if (isMountedRef.current) {
setIsLoading(false);
}
}
}
loadDraft();
return () => {
isMountedRef.current = false;
if (autosaveTimeoutRef.current) {
clearTimeout(autosaveTimeoutRef.current);
autosaveTimeoutRef.current = null;
}
};
}, [draftId, onError]);
const performAutosaveRef = useRef<(updates: UpdateDraftDto) => Promise<DraftInvoice | void>>(
async () => {},
);
// Debounced autosave
const performAutosave = useCallback(async (updates: UpdateDraftDto): Promise<DraftInvoice | void> => {
if (!isMountedRef.current || !enabled) return;
if (!draft && !isDraftCreatedRef.current) {
// Draft not yet created, create it first
try {
const newDraft = await DraftService.createDraft(updates as CreateDraftDto);
if (isMountedRef.current) {
setDraft(newDraft);
isDraftCreatedRef.current = true;
setLastSavedAt(new Date());
onSave?.(newDraft);
}
return newDraft;
} catch (err) {
if (isMountedRef.current) {
const errorMsg = err instanceof Error ? err.message : String(err);
setError(`Failed to create draft: ${errorMsg}`);
onError?.(err instanceof Error ? err : new Error(errorMsg));
}
return;
}
}
// Check if enough time has passed since last autosave
const now = Date.now();
if (now - lastAutosaveTimeRef.current < minAutosaveInterval) {
// Schedule a delayed autosave if too soon
if (autosaveTimeoutRef.current) {
clearTimeout(autosaveTimeoutRef.current);
}
autosaveTimeoutRef.current = setTimeout(() => {
performAutosaveRef.current(updates);
}, minAutosaveInterval - (now - lastAutosaveTimeRef.current));
return;
}
const draftToUpdate = draft || { id: draftId };
if (!draftToUpdate.id) return;
setIsSaving(true);
try {
const updatedDraft = await DraftService.autoSaveDraft(draftToUpdate.id, updates);
if (isMountedRef.current) {
setDraft(updatedDraft);
setLastSavedAt(new Date());
setPendingUpdates({});
onSave?.(updatedDraft);
lastAutosaveTimeRef.current = now;
}
return updatedDraft;
} catch (err) {
if (isMountedRef.current) {
const errorMsg = err instanceof Error ? err.message : String(err);
setError(`Autosave failed: ${errorMsg}`);
onError?.(err instanceof Error ? err : new Error(errorMsg));
}
return;
} finally {
if (isMountedRef.current) {
setIsSaving(false);
}
}
}, [draft, draftId, enabled, minAutosaveInterval, onSave, onError]);
// Keep the ref pointed at the latest performAutosave after every render
// in which it changes.
useEffect(() => {
performAutosaveRef.current = performAutosave;
}, [performAutosave]);
// Debounce update function
const updateDraft = useCallback((updates: UpdateDraftDto) => {
if (!isMountedRef.current) return;
// Merge pending updates
setPendingUpdates((prev) => ({
...prev,
...updates,
}));
// Clear existing timeout
if (autosaveTimeoutRef.current) {
clearTimeout(autosaveTimeoutRef.current);
}
// Schedule autosave
autosaveTimeoutRef.current = setTimeout(() => {
const updatesToSave = { ...pendingUpdates, ...updates };
performAutosaveRef.current(updatesToSave);
}, autosaveDelay);
}, [pendingUpdates, autosaveDelay]);
// Manual save (bypasses debounce)
const saveDraft = useCallback(async (): Promise<DraftInvoice> => {
if (!draft && !draftId) {
throw new Error('No draft exists to save');
}
const draftToUpdate = draft || { id: draftId };
if (!draftToUpdate.id) {
throw new Error('Draft ID is required');
}
// Clear any pending autosave
if (autosaveTimeoutRef.current) {
clearTimeout(autosaveTimeoutRef.current);
autosaveTimeoutRef.current = null;
}
setIsSaving(true);
try {
const updates = pendingUpdates;
const updatedDraft = await DraftService.updateDraft(draftToUpdate.id, updates);
if (isMountedRef.current) {
setDraft(updatedDraft);
setLastSavedAt(new Date());
setPendingUpdates({});
onSave?.(updatedDraft);
lastAutosaveTimeRef.current = Date.now();
}
return updatedDraft;
} catch (err) {
const errorMsg = err instanceof Error ? err.message : String(err);
setError(`Save failed: ${errorMsg}`);
onError?.(err instanceof Error ? err : new Error(errorMsg));
throw err;
} finally {
if (isMountedRef.current) {
setIsSaving(false);
}
}
}, [draft, draftId, pendingUpdates, onSave, onError]);
// Trigger immediate autosave
const triggerAutosave = useCallback(async (): Promise<DraftInvoice> => {
if (autosaveTimeoutRef.current) {
clearTimeout(autosaveTimeoutRef.current);
autosaveTimeoutRef.current = null;
}
const result = await performAutosave(pendingUpdates);
if (result) return result;
if (draft) return draft;
throw new Error("Autosave did not complete");
}, [pendingUpdates, performAutosave, draft]);
// Convert draft to invoice
const convertToInvoice = useCallback(async () => {
if (!draft && !draftId) {
throw new Error('No draft exists to convert');
}
const draftToConvert = draft || { id: draftId };
if (!draftToConvert.id) {
throw new Error('Draft ID is required');
}
// Ensure all pending changes are saved first
if (Object.keys(pendingUpdates).length > 0) {
await saveDraft();
}
setIsConverting(true);
try {
const invoice = await DraftService.convertDraftToInvoice(draftToConvert.id);
if (isMountedRef.current) {
onConvert?.(invoice);
}
return invoice;
} catch (err) {
const errorMsg = err instanceof Error ? err.message : String(err);
setError(`Conversion failed: ${errorMsg}`);
onError?.(err instanceof Error ? err : new Error(errorMsg));
throw err;
} finally {
if (isMountedRef.current) {
setIsConverting(false);
}
}
}, [draft, draftId, pendingUpdates, saveDraft, onConvert, onError]);
// Discard draft
const discardDraft = useCallback(async () => {
if (!draft && !draftId) {
throw new Error('No draft exists to discard');
}
const draftToDiscard = draft || { id: draftId };
if (!draftToDiscard.id) {
throw new Error('Draft ID is required');
}
// Clear any pending autosave
if (autosaveTimeoutRef.current) {
clearTimeout(autosaveTimeoutRef.current);
autosaveTimeoutRef.current = null;
}
try {
const result = await DraftService.discardDraft(draftToDiscard.id);
if (isMountedRef.current) {
setDraft(null);
setPendingUpdates({});
isDraftCreatedRef.current = false;
}
return result;
} catch (err) {
const errorMsg = err instanceof Error ? err.message : String(err);
setError(`Failed to discard draft: ${errorMsg}`);
onError?.(err instanceof Error ? err : new Error(errorMsg));
throw err;
}
}, [draft, draftId, onError]);
// Reset draft state
const resetDraft = useCallback(() => {
if (autosaveTimeoutRef.current) {
clearTimeout(autosaveTimeoutRef.current);
autosaveTimeoutRef.current = null;
}
setPendingUpdates({});
setError(null);
}, []);
// Refresh draft from server
const refreshDraft = useCallback(async () => {
if (!draftId && !draft?.id) return;
const id = draftId || draft?.id;
if (!id) return;
try {
const refreshedDraft = await DraftService.getDraft(id);
if (isMountedRef.current) {
setDraft(refreshedDraft);
setLastSavedAt(refreshedDraft.lastAutoSavedAt ? new Date(refreshedDraft.lastAutoSavedAt) : null);
setError(null);
}
} catch (err) {
const errorMsg = err instanceof Error ? err.message : String(err);
setError(`Failed to refresh draft: ${errorMsg}`);
onError?.(err instanceof Error ? err : new Error(errorMsg));
}
}, [draftId, draft?.id, onError]);
// Cleanup on unmount
useEffect(() => {
return () => {
if (autosaveTimeoutRef.current) {
clearTimeout(autosaveTimeoutRef.current);
autosaveTimeoutRef.current = null;
}
};
}, []);
// Computed properties
const isComplete = draft ? DraftService.isDraftComplete(draft) : false;
const completionPercentage = draft ? DraftService.getCompletionPercentage(draft) : 0;
return {
draft,
isLoading,
isSaving,
isConverting,
error,
lastSavedAt,
updateDraft,
saveDraft,
triggerAutosave,
convertToInvoice,
discardDraft,
resetDraft,
isComplete,
completionPercentage,
refreshDraft,
};
}