This repository has been archived by the owner on Jun 15, 2022. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 110
/
snjs_helper_hooks.ts
496 lines (435 loc) · 13.6 KB
/
snjs_helper_hooks.ts
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
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
import { ApplicationContext } from '@Root/ApplicationContext';
import { SCREEN_NOTES } from '@Screens/screens';
import {
ApplicationEvent,
ButtonType,
isSameDay,
NoteMutator,
NoteViewController,
SNNote,
StorageEncryptionPolicies,
} from '@standardnotes/snjs';
import React, { useCallback, useEffect } from 'react';
import { LockStateType } from './application_state';
export const useSignedIn = (
signedInCallback?: () => void,
signedOutCallback?: () => void
) => {
// Context
const application = React.useContext(ApplicationContext);
const [isLocked] = useIsLocked();
// State
const [signedIn, setSignedIn] = React.useState(false);
React.useEffect(() => {
let mounted = true;
const getSignedIn = async () => {
if (mounted && !isLocked) {
setSignedIn(!application?.noAccount());
}
};
getSignedIn();
const removeSignedInObserver = application?.addEventObserver(
async event => {
if (event === ApplicationEvent.Launched) {
getSignedIn();
}
if (event === ApplicationEvent.SignedIn) {
setSignedIn(true);
signedInCallback && signedInCallback();
} else if (event === ApplicationEvent.SignedOut) {
setSignedIn(false);
signedOutCallback && signedOutCallback();
}
}
);
return () => {
mounted = false;
removeSignedInObserver && removeSignedInObserver();
};
}, [application, signedInCallback, signedOutCallback, isLocked]);
return [signedIn];
};
export const useOutOfSync = () => {
// Context
const application = React.useContext(ApplicationContext);
// State
const [outOfSync, setOutOfSync] = React.useState<boolean>(false);
React.useEffect(() => {
let isMounted = true;
const getOutOfSync = async () => {
const outOfSyncInitial = await application?.sync.isOutOfSync();
if (isMounted) {
setOutOfSync(Boolean(outOfSyncInitial));
}
};
getOutOfSync();
return () => {
isMounted = false;
};
}, [application]);
React.useEffect(() => {
const removeSignedInObserver = application?.addEventObserver(
async event => {
if (event === ApplicationEvent.EnteredOutOfSync) {
setOutOfSync(true);
} else if (event === ApplicationEvent.ExitedOutOfSync) {
setOutOfSync(false);
}
}
);
return removeSignedInObserver;
}, [application]);
return [outOfSync];
};
export const useIsLocked = () => {
// Context
const application = React.useContext(ApplicationContext);
// State
const [isLocked, setIsLocked] = React.useState<boolean>(() =>
Boolean(application?.getAppState().locked)
);
useEffect(() => {
let isMounted = true;
const removeSignedInObserver = application
?.getAppState()
.addLockStateChangeObserver(event => {
if (isMounted) {
if (event === LockStateType.Locked) {
setIsLocked(true);
}
if (event === LockStateType.Unlocked) {
setIsLocked(false);
}
}
});
return () => {
isMounted = false;
removeSignedInObserver && removeSignedInObserver();
};
}, [application]);
return [isLocked];
};
export const useHasEditor = () => {
// Context
const application = React.useContext(ApplicationContext);
// State
const [hasEditor, setHasEditor] = React.useState<boolean>(false);
useEffect(() => {
const removeEditorObserver =
application?.editorGroup.addActiveControllerChangeObserver(newEditor => {
setHasEditor(Boolean(newEditor));
});
return removeEditorObserver;
}, [application]);
return [hasEditor];
};
export const useSyncStatus = () => {
// Context
const application = React.useContext(ApplicationContext);
// State
const [completedInitialSync, setCompletedInitialSync] = React.useState(false);
const [loading, setLoading] = React.useState(false);
const [decrypting, setDecrypting] = React.useState(false);
const [refreshing, setRefreshing] = React.useState(false);
const setStatus = useCallback(
(status = '') => {
application?.getStatusManager().setMessage(SCREEN_NOTES, status);
},
[application]
);
const updateLocalDataStatus = useCallback(() => {
const syncStatus = application!.sync.getSyncStatus();
const stats = syncStatus.getStats();
const encryption =
application!.isEncryptionAvailable() &&
application!.getStorageEncryptionPolicy() ===
StorageEncryptionPolicies.Default;
if (
stats.localDataCurrent === 0 ||
stats.localDataTotal === 0 ||
stats.localDataDone
) {
setStatus();
return;
}
const notesString = `${stats.localDataCurrent}/${stats.localDataTotal} items…`;
const loadingStatus = encryption
? `Decrypting ${notesString}`
: `Loading ${notesString}`;
setStatus(loadingStatus);
}, [application, setStatus]);
useEffect(() => {
let mounted = true;
const isEncryptionAvailable =
application!.isEncryptionAvailable() &&
application!.getStorageEncryptionPolicy() ===
StorageEncryptionPolicies.Default;
if (mounted) {
setDecrypting(!completedInitialSync && isEncryptionAvailable);
updateLocalDataStatus();
setLoading(!completedInitialSync && !isEncryptionAvailable);
}
return () => {
mounted = false;
};
}, [application, completedInitialSync, updateLocalDataStatus]);
const updateSyncStatus = useCallback(() => {
const syncStatus = application!.sync.getSyncStatus();
const stats = syncStatus.getStats();
if (syncStatus.hasError()) {
setRefreshing(false);
setStatus('Unable to Sync');
} else if (stats.downloadCount > 20) {
const text = `Downloading ${stats.downloadCount} items. Keep app open.`;
setStatus(text);
} else if (stats.uploadTotalCount > 20) {
setStatus(
`Syncing ${stats.uploadCompletionCount}/${stats.uploadTotalCount} items...`
);
} else if (syncStatus.syncInProgress && !completedInitialSync) {
setStatus('Syncing…');
} else {
setStatus();
}
}, [application, completedInitialSync, setStatus]);
useEffect(() => {
const unsubscribeAppEvents = application?.addEventObserver(
async eventName => {
if (eventName === ApplicationEvent.LocalDataIncrementalLoad) {
updateLocalDataStatus();
} else if (
eventName === ApplicationEvent.SyncStatusChanged ||
eventName === ApplicationEvent.FailedSync
) {
updateSyncStatus();
} else if (eventName === ApplicationEvent.LocalDataLoaded) {
setDecrypting(false);
setLoading(false);
updateLocalDataStatus();
} else if (eventName === ApplicationEvent.CompletedFullSync) {
if (completedInitialSync) {
setRefreshing(false);
} else {
setCompletedInitialSync(true);
}
setLoading(false);
updateSyncStatus();
} else if (eventName === ApplicationEvent.LocalDatabaseReadError) {
application!.alertService!.alert(
'Unable to load local storage. Please restart the app and try again.'
);
} else if (eventName === ApplicationEvent.LocalDatabaseWriteError) {
application!.alertService!.alert(
'Unable to write to local storage. Please restart the app and try again.'
);
} else if (eventName === ApplicationEvent.SignedIn) {
setLoading(true);
}
}
);
return unsubscribeAppEvents;
}, [
application,
completedInitialSync,
setStatus,
updateLocalDataStatus,
updateSyncStatus,
]);
const startRefreshing = () => {
setRefreshing(true);
};
return [loading, decrypting, refreshing, startRefreshing] as [
boolean,
boolean,
boolean,
() => void
];
};
export const useDeleteNoteWithPrivileges = (
note: SNNote,
onDeleteCallback: () => void,
onTrashCallback: () => void,
editor?: NoteViewController
) => {
// Context
const application = React.useContext(ApplicationContext);
const trashNote = useCallback(async () => {
const title = 'Move to Trash';
const message = 'Are you sure you want to move this note to the trash?';
const confirmed = await application?.alertService?.confirm(
message,
title,
'Confirm',
ButtonType.Danger
);
if (confirmed) {
onTrashCallback();
}
}, [application?.alertService, onTrashCallback]);
const deleteNotePermanently = useCallback(async () => {
const title = `Delete ${note!.title}`;
const message = 'Are you sure you want to permanently delete this note?';
if (editor?.isTemplateNote) {
application?.alertService!.alert(
'This note is a placeholder and cannot be deleted. To remove from your list, simply navigate to a different note.'
);
return;
}
const confirmed = await application?.alertService?.confirm(
message,
title,
'Delete',
ButtonType.Danger,
'Cancel'
);
if (confirmed) {
onDeleteCallback();
}
}, [
application?.alertService,
editor?.isTemplateNote,
note,
onDeleteCallback,
]);
const deleteNote = useCallback(
async (permanently: boolean) => {
if (note?.locked) {
application?.alertService.alert(
"This note has editing disabled. If you'd like to delete it, enable editing on it, and try again."
);
return;
}
if (permanently) {
deleteNotePermanently();
} else {
trashNote();
}
},
[application, deleteNotePermanently, note?.locked, trashNote]
);
return [deleteNote];
};
export const useProtectionSessionExpiry = () => {
// Context
const application = React.useContext(ApplicationContext);
const getProtectionsDisabledUntil = React.useCallback(() => {
const protectionExpiry = application?.getProtectionSessionExpiryDate();
const now = new Date();
if (protectionExpiry && protectionExpiry > now) {
if (typeof Intl !== 'undefined' && Intl.DateTimeFormat) {
let f: Intl.DateTimeFormat;
if (isSameDay(protectionExpiry, now)) {
f = new Intl.DateTimeFormat(undefined, {
hour: 'numeric',
minute: 'numeric',
});
} else {
f = new Intl.DateTimeFormat(undefined, {
weekday: 'long',
day: 'numeric',
month: 'short',
hour: 'numeric',
minute: 'numeric',
});
}
return f.format(protectionExpiry);
} else {
if (isSameDay(protectionExpiry, now)) {
return protectionExpiry.toLocaleTimeString();
} else {
return `${protectionExpiry.toDateString()} ${protectionExpiry.toLocaleTimeString()}`;
}
}
}
return null;
}, [application]);
// State
const [protectionsDisabledUntil, setProtectionsDisabledUntil] =
React.useState(getProtectionsDisabledUntil());
useEffect(() => {
const removeProtectionLengthSubscriber = application?.addEventObserver(
async event => {
if (event === ApplicationEvent.UnprotectedSessionBegan) {
setProtectionsDisabledUntil(getProtectionsDisabledUntil());
}
}
);
return () => {
removeProtectionLengthSubscriber && removeProtectionLengthSubscriber();
};
}, [application, getProtectionsDisabledUntil]);
return [protectionsDisabledUntil];
};
export const useChangeNoteChecks = (
note: SNNote | undefined,
editor: NoteViewController | undefined = undefined
) => {
// Context
const application = React.useContext(ApplicationContext);
const canChangeNote = useCallback(async () => {
if (!note) {
return false;
}
if (note.deleted) {
application?.alertService?.alert(
'The note you are attempting to edit has been deleted, and is awaiting sync. Changes you make will be disregarded.'
);
return false;
}
if (editor && editor.isTemplateNote) {
await editor.insertTemplatedNote();
}
if (!application?.items.findItem(note.uuid)) {
application?.alertService!.alert(
"The note you are attempting to save can not be found or has been deleted. Changes you make will not be synced. Please copy this note's text and start a new note."
);
return false;
}
return true;
}, [application, editor, note]);
return [canChangeNote];
};
export const useChangeNote = (
note: SNNote | undefined,
editor: NoteViewController | undefined = undefined
) => {
const application = React.useContext(ApplicationContext);
const [canChangeNote] = useChangeNoteChecks(note, editor);
const changeNote = useCallback(
async (
mutate: (mutator: NoteMutator) => void,
updateTimestamps: boolean
) => {
if (await canChangeNote()) {
await application?.mutator.changeAndSaveItem(
note!.uuid,
mutator => {
const noteMutator = mutator as NoteMutator;
mutate(noteMutator);
},
updateTimestamps
);
}
},
[application, note, canChangeNote]
);
return [changeNote];
};
export const useProtectOrUnprotectNote = (
note: SNNote | undefined,
editor: NoteViewController | undefined = undefined
) => {
// Context
const application = React.useContext(ApplicationContext);
const [canChangeNote] = useChangeNoteChecks(note, editor);
const protectOrUnprotectNote = useCallback(async () => {
if (await canChangeNote()) {
if (note!.protected) {
await application?.mutator.unprotectNote(note!);
} else {
application?.mutator.protectNote(note!);
}
}
}, [application, note, canChangeNote]);
return [protectOrUnprotectNote];
};