@rapidmx/web-client 0.20.0 → 0.21.0

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 (118) hide show
  1. package/README.md +381 -381
  2. package/apps/admin/branding/index.tsx +39 -39
  3. package/apps/admin/data-requests/index.tsx +482 -482
  4. package/apps/admin/domains/[uid].tsx +166 -166
  5. package/apps/admin/escrow-scopes/[uid].tsx +350 -350
  6. package/apps/admin/index.tsx +129 -129
  7. package/apps/admin/mailboxes/[uid].tsx +271 -271
  8. package/apps/admin/mailboxes/new/index.tsx +30 -30
  9. package/apps/admin/plugins/index.tsx +15 -15
  10. package/apps/admin/retention-policy/index.tsx +39 -39
  11. package/apps/admin/signing-certificates/index.tsx +343 -343
  12. package/apps/escrow/audit-log/index.tsx +196 -196
  13. package/apps/escrow/matters/[uid].tsx +621 -621
  14. package/apps/shared/auth/adminAccess.ts +99 -99
  15. package/apps/shared/components/admin/layout/AdminShell.tsx +384 -384
  16. package/apps/shared/components/admin/mailboxes/EraseLeftoverDataDialog.tsx +238 -238
  17. package/apps/shared/components/admin/mailboxes/EscrowScopeCard.tsx +152 -152
  18. package/apps/shared/components/admin/mailboxes/LeftoverMailboxesSection.tsx +194 -194
  19. package/apps/shared/components/admin/settings/BrandingForm.tsx +423 -423
  20. package/apps/shared/components/admin/settings/EncryptionPolicyForm.tsx +119 -119
  21. package/apps/shared/components/admin/settings/MailboxPolicyForm.tsx +198 -198
  22. package/apps/shared/components/admin/settings/PluginsManager.tsx +2093 -2093
  23. package/apps/shared/components/admin/settings/RetentionPolicyForm.tsx +182 -182
  24. package/apps/shared/components/admin/setup/EscrowSetupStep.tsx +288 -288
  25. package/apps/shared/components/admin/setup/SetupWizard.tsx +446 -446
  26. package/apps/shared/components/admin/usePagedList.tsx +129 -129
  27. package/apps/shared/components/calendar/EventModal.tsx +206 -206
  28. package/apps/shared/components/calendar/MonthView.tsx +185 -185
  29. package/apps/shared/components/calendar/RecurrenceEditor.tsx +227 -227
  30. package/apps/shared/components/calendar/SplitDayView.tsx +144 -144
  31. package/apps/shared/components/calendar/TimeGridView.tsx +246 -246
  32. package/apps/shared/components/calendar/allDay.ts +124 -124
  33. package/apps/shared/components/contacts/ContactForm.tsx +383 -383
  34. package/apps/shared/components/contacts/ContactsToolbar.tsx +103 -103
  35. package/apps/shared/components/escrow/layout/EscrowShell.tsx +155 -155
  36. package/apps/shared/components/layout/AppShell.tsx +463 -461
  37. package/apps/shared/components/layout/KeyEnrollmentGate.tsx +398 -398
  38. package/apps/shared/components/layout/MailboxProvisioning.tsx +168 -168
  39. package/apps/shared/components/layout/ResponsiveToolbar.tsx +315 -315
  40. package/apps/shared/components/layout/ThemeSwitch.tsx +84 -84
  41. package/apps/shared/components/layout/UserMenu.tsx +439 -439
  42. package/apps/shared/components/mail/ConversationList.tsx +332 -332
  43. package/apps/shared/components/mail/ConversationThreadPane.tsx +613 -613
  44. package/apps/shared/components/mail/MailSelectionBar.tsx +240 -240
  45. package/apps/shared/components/mail/MenuButton.tsx +404 -404
  46. package/apps/shared/components/mail/MessageDetailPane.tsx +1757 -1757
  47. package/apps/shared/components/mail/compose/ComposeContext.tsx +312 -312
  48. package/apps/shared/components/mail/compose/ComposeToolbar.tsx +422 -422
  49. package/apps/shared/components/mail/compose/ComposeWindow.tsx +1705 -1681
  50. package/apps/shared/components/mail/compose/RichTextEditor.tsx +147 -147
  51. package/apps/shared/components/mail/compose/composeFlushRegistry.ts +60 -60
  52. package/apps/shared/components/mail/compose/quotedBody.ts +161 -161
  53. package/apps/shared/components/mail/reading/MessageMoreMenu.tsx +258 -258
  54. package/apps/shared/components/mail/reading/MessageSourceDialog.tsx +79 -79
  55. package/apps/shared/components/mail/reading/messageExport.ts +59 -59
  56. package/apps/shared/components/mail/reading/printMessage.ts +99 -99
  57. package/apps/shared/components/mail/reading/useMessageActions.ts +443 -443
  58. package/apps/shared/components/mail/verificationSeals.ts +125 -125
  59. package/apps/shared/components/rules/RuleBuilder.tsx +311 -311
  60. package/apps/shared/components/settings/SigningCertificateCard.tsx +344 -344
  61. package/apps/shared/keyboard/GlobalShortcuts.tsx +51 -51
  62. package/apps/shared/keyboard/ShortcutProvider.tsx +62 -62
  63. package/apps/shared/keyboard/ShortcutsDialog.tsx +84 -84
  64. package/apps/shared/keyboard/dispatch.ts +124 -124
  65. package/apps/shared/keyboard/format.ts +89 -89
  66. package/apps/shared/keyboard/keymap.ts +114 -114
  67. package/apps/shared/keyboard/registry.ts +65 -65
  68. package/apps/shared/keyboard/targets.ts +79 -79
  69. package/apps/shared/mail/folderOfType.ts +49 -49
  70. package/apps/shared/mail/folderTree.ts +143 -143
  71. package/apps/shared/mail/listAllPages.ts +39 -39
  72. package/apps/shared/mail/newMailNotifications.ts +171 -171
  73. package/apps/shared/mail/outbox/sendJob.ts +445 -445
  74. package/apps/shared/mail/outbox/sendOutcomes.ts +155 -155
  75. package/apps/shared/mail/reportNotices.ts +66 -66
  76. package/apps/shared/mail/senderBlocking.ts +141 -141
  77. package/apps/shared/mail/useMailConnection.ts +205 -205
  78. package/apps/shared/mail/useMailLiveUpdates.ts +277 -277
  79. package/apps/shared/mail/useMailboxUpdateAccess.ts +60 -60
  80. package/apps/shared/mail/useMarkMessageRead.ts +47 -47
  81. package/apps/shared/mail/useNewMailNotifications.ts +178 -178
  82. package/apps/shared/notifications/store.ts +560 -560
  83. package/apps/shared/search/LocalIndexLifecycle.tsx +114 -114
  84. package/apps/shared/search/localIndexBuilder.ts +481 -481
  85. package/apps/shared/signing/enrollmentStorage.ts +33 -33
  86. package/apps/shared/signing/enrollmentTracker.ts +385 -385
  87. package/apps/shared/signing/enrollmentView.ts +251 -251
  88. package/apps/shared/signing/useNow.ts +19 -19
  89. package/apps/shared/signing/useSigningEnrollmentWatcher.ts +90 -90
  90. package/apps/shared/styles/app.css +396 -396
  91. package/apps/www/calendar/index.tsx +581 -581
  92. package/apps/www/contacts/[uid].tsx +112 -112
  93. package/apps/www/index.tsx +3012 -3012
  94. package/apps/www/messages/[uid].tsx +139 -139
  95. package/apps/www/settings/auto-reply/index.tsx +136 -136
  96. package/apps/www/settings/blocked-senders/index.tsx +303 -303
  97. package/apps/www/settings/encryption/index.tsx +1290 -1290
  98. package/apps/www/settings/filters/[uid].tsx +179 -179
  99. package/apps/www/settings/filters/index.tsx +105 -105
  100. package/apps/www/settings/filters/new/index.tsx +165 -165
  101. package/apps/www/settings/labels/index.tsx +207 -207
  102. package/apps/www/settings/privacy/index.tsx +495 -495
  103. package/apps/www/settings/profile/index.tsx +251 -251
  104. package/apps/www/settings/read-receipts/index.tsx +150 -150
  105. package/apps/www/settings/sharing/index.tsx +259 -259
  106. package/apps/www/settings/signatures/[uid].tsx +175 -175
  107. package/apps/www/settings/signatures/index.tsx +91 -91
  108. package/apps/www/settings/signatures/new/index.tsx +138 -138
  109. package/apps/www/tasks/index.tsx +654 -654
  110. package/dist/apps/shared/components/admin/layout/AdminShell.js +2 -2
  111. package/dist/apps/shared/components/admin/settings/BrandingForm.js +3 -3
  112. package/dist/apps/shared/components/escrow/layout/EscrowShell.js +2 -2
  113. package/dist/apps/shared/components/layout/AppShell.js +4 -2
  114. package/dist/apps/shared/components/mail/compose/ComposeWindow.d.ts +7 -1
  115. package/dist/apps/shared/components/mail/compose/ComposeWindow.js +20 -1
  116. package/dist/apps/shared/components/mail/reading/printMessage.js +11 -11
  117. package/dist/apps/shared/styles/app.css +396 -396
  118. package/package.json +2 -2
@@ -1,114 +1,114 @@
1
- ///////////////////////////////////////////////////////////////////////////////
2
- // Copyright (C) 2026 Jean-Philippe Steinmetz
3
- // SPDX-License-Identifier: MPL-2.0
4
- ///////////////////////////////////////////////////////////////////////////////
5
-
6
- /**
7
- * Where a shortcut applies. `global` works in every view; a view scope (`mail`, `calendar`, `contacts`, `tasks`) exists only while that
8
- * view is mounted; `compose` applies while focus is inside a compose window; `dialog` is for what a modal dialog binds itself - a
9
- * dialog on screen silences every other scope.
10
- */
11
- export type ShortcutScope = "global" | "mail" | "compose" | "calendar" | "contacts" | "tasks" | "dialog";
12
-
13
- /** The scopes the help dialog lists, in the order it lists them. */
14
- export const HELP_SCOPES: readonly ShortcutScope[] = ["global", "mail", "compose", "calendar", "contacts", "tasks"];
15
-
16
- export const SCOPE_LABELS: Record<ShortcutScope, string> = {
17
- global: "Global",
18
- mail: "Mail",
19
- compose: "Compose",
20
- calendar: "Calendar",
21
- contacts: "Contacts",
22
- tasks: "Tasks",
23
- dialog: "Dialog",
24
- };
25
-
26
- /** One action the keyboard can trigger, and the keys that trigger it. Views register handlers for these; nothing else defines a key. */
27
- export interface ShortcutDef {
28
- /** Stable name, unique across the map - what the help dialog de-duplicates on. */
29
- id: string;
30
- /** Specs (see `parseSpec()`) that trigger it, the first being the one shown first. `mod` is Ctrl, or Cmd on macOS. */
31
- keys: readonly string[];
32
- /** Extra specs that apply only in the desktop client, where the browser's own reserved keys (Ctrl+N, Ctrl+T) are the app's. */
33
- electronKeys?: readonly string[];
34
- /** What the help dialog and a button's tooltip call it. */
35
- label: string;
36
- scope: ShortcutScope;
37
- /** Fires from a focused button or link too (Enter on a message row); by default Enter/Space are left to what has the focus. */
38
- allowOnActivatable?: boolean;
39
- /** Keeps firing while the key is held (arrows); by default a held key runs a one-shot action once. */
40
- repeat?: boolean;
41
- }
42
-
43
- function def<T extends ShortcutDef>(shortcut: T): T {
44
- return shortcut;
45
- }
46
-
47
- /**
48
- * The whole key map, in the order the help dialog lists it. The navigation set is literally Ctrl+Shift+<letter> on every platform (Cmd+Shift
49
- * on macOS collides with the browsers' own - Cmd+Shift+A/B/C/L/M/S are tab search, the bookmarks bar, Inspect, the sidebar, the profile
50
- * switcher and Save As - so it is not offered); the mail actions use `mod`, so Reply is Ctrl+R on Windows and Linux and Cmd+R on a Mac.
51
- * Ctrl+Q (mark read) stays Ctrl on a Mac because Cmd+Q is the system's Quit.
52
- */
53
- export const SHORTCUTS = {
54
- global: {
55
- account: def({ id: "go.account", keys: ["ctrl+shift+a"], label: "Go to Account", scope: "global" }),
56
- settings: def({ id: "go.settings", keys: ["ctrl+shift+s"], label: "Go to Settings", scope: "global" }),
57
- contacts: def({ id: "go.contacts", keys: ["ctrl+shift+b"], label: "Go to Contacts", scope: "global" }),
58
- mail: def({ id: "go.mail", keys: ["ctrl+shift+m"], label: "Go to Mail", scope: "global" }),
59
- calendar: def({ id: "go.calendar", keys: ["ctrl+shift+c"], label: "Go to Calendar", scope: "global" }),
60
- tasks: def({ id: "go.tasks", keys: ["ctrl+shift+l"], electronKeys: ["ctrl+shift+t"], label: "Go to Tasks", scope: "global" }),
61
- help: def({ id: "help", keys: ["?", "ctrl+/"], label: "Keyboard shortcuts", scope: "global" }),
62
- },
63
- mail: {
64
- create: def({ id: "mail.new", keys: ["alt+n"], electronKeys: ["mod+n"], label: "New message", scope: "mail" }),
65
- reply: def({ id: "mail.reply", keys: ["mod+r"], label: "Reply", scope: "mail" }),
66
- replyAll: def({ id: "mail.replyAll", keys: ["mod+shift+r"], label: "Reply all", scope: "mail" }),
67
- forward: def({ id: "mail.forward", keys: ["mod+shift+f"], label: "Forward", scope: "mail" }),
68
- delete: def({ id: "mail.delete", keys: ["mod+d", "delete"], label: "Delete", scope: "mail" }),
69
- archive: def({ id: "mail.archive", keys: ["e", "backspace"], label: "Archive", scope: "mail" }),
70
- move: def({ id: "mail.move", keys: ["mod+shift+v"], label: "Move to folder", scope: "mail" }),
71
- markRead: def({ id: "mail.markRead", keys: ["ctrl+q"], label: "Mark as read", scope: "mail" }),
72
- markUnread: def({ id: "mail.markUnread", keys: ["mod+u"], label: "Mark as unread", scope: "mail" }),
73
- flag: def({ id: "mail.flag", keys: ["insert"], label: "Flag or unflag", scope: "mail" }),
74
- next: def({ id: "mail.next", keys: ["arrowdown", "j"], label: "Next message", scope: "mail", repeat: true }),
75
- previous: def({ id: "mail.previous", keys: ["arrowup", "k"], label: "Previous message", scope: "mail", repeat: true }),
76
- nextUnread: def({ id: "mail.nextUnread", keys: ["ctrl+."], label: "Next unread message", scope: "mail" }),
77
- previousUnread: def({ id: "mail.previousUnread", keys: ["ctrl+,"], label: "Previous unread message", scope: "mail" }),
78
- open: def({ id: "mail.open", keys: ["enter"], label: "Open the message on its own page", scope: "mail", allowOnActivatable: true }),
79
- close: def({ id: "mail.close", keys: ["escape"], label: "Clear the selection", scope: "mail" }),
80
- search: def({ id: "mail.search", keys: ["/", "mod+e"], label: "Search mail", scope: "mail" }),
81
- },
82
- compose: {
83
- create: def({ id: "compose.new", keys: ["alt+n"], electronKeys: ["mod+n"], label: "New message", scope: "compose" }),
84
- send: def({ id: "compose.send", keys: ["mod+enter"], label: "Send", scope: "compose" }),
85
- saveDraft: def({ id: "compose.saveDraft", keys: ["mod+s"], label: "Save draft", scope: "compose" }),
86
- close: def({ id: "compose.close", keys: ["escape"], label: "Close (keeps the draft)", scope: "compose" }),
87
- },
88
- calendar: {
89
- create: def({ id: "calendar.new", keys: ["alt+n"], electronKeys: ["mod+n"], label: "New event", scope: "calendar" }),
90
- today: def({ id: "calendar.today", keys: ["t"], label: "Go to today", scope: "calendar" }),
91
- previous: def({ id: "calendar.previous", keys: ["arrowleft", "mod+arrowleft"], label: "Previous period", scope: "calendar", repeat: true }),
92
- next: def({ id: "calendar.next", keys: ["arrowright", "mod+arrowright"], label: "Next period", scope: "calendar", repeat: true }),
93
- day: def({ id: "calendar.day", keys: ["ctrl+alt+1"], label: "Day view", scope: "calendar" }),
94
- workWeek: def({ id: "calendar.workWeek", keys: ["ctrl+alt+2"], label: "Work week view", scope: "calendar" }),
95
- week: def({ id: "calendar.week", keys: ["ctrl+alt+3"], label: "Week view", scope: "calendar" }),
96
- month: def({ id: "calendar.month", keys: ["ctrl+alt+4"], label: "Month view", scope: "calendar" }),
97
- },
98
- contacts: {
99
- create: def({ id: "contacts.new", keys: ["alt+n"], electronKeys: ["mod+n"], label: "New contact", scope: "contacts" }),
100
- search: def({ id: "contacts.search", keys: ["/", "mod+e"], label: "Search contacts", scope: "contacts" }),
101
- },
102
- tasks: {
103
- create: def({ id: "tasks.new", keys: ["alt+n"], electronKeys: ["mod+n"], label: "New task", scope: "tasks" }),
104
- },
105
- } as const;
106
-
107
- /** Every shortcut of the map flattened, in listing order. */
108
- export const ALL_SHORTCUTS: readonly ShortcutDef[] = Object.values(SHORTCUTS).flatMap((group) => Object.values(group) as ShortcutDef[]);
109
-
110
- /** Where a shortcut sits in the listing, for ordering registrations that arrive in whatever order components mount. */
111
- export function shortcutRank(shortcut: ShortcutDef): number {
112
- const index = ALL_SHORTCUTS.findIndex((candidate) => candidate.id === shortcut.id);
113
- return index === -1 ? ALL_SHORTCUTS.length : index;
114
- }
1
+ ///////////////////////////////////////////////////////////////////////////////
2
+ // Copyright (C) 2026 Jean-Philippe Steinmetz
3
+ // SPDX-License-Identifier: MPL-2.0
4
+ ///////////////////////////////////////////////////////////////////////////////
5
+
6
+ /**
7
+ * Where a shortcut applies. `global` works in every view; a view scope (`mail`, `calendar`, `contacts`, `tasks`) exists only while that
8
+ * view is mounted; `compose` applies while focus is inside a compose window; `dialog` is for what a modal dialog binds itself - a
9
+ * dialog on screen silences every other scope.
10
+ */
11
+ export type ShortcutScope = "global" | "mail" | "compose" | "calendar" | "contacts" | "tasks" | "dialog";
12
+
13
+ /** The scopes the help dialog lists, in the order it lists them. */
14
+ export const HELP_SCOPES: readonly ShortcutScope[] = ["global", "mail", "compose", "calendar", "contacts", "tasks"];
15
+
16
+ export const SCOPE_LABELS: Record<ShortcutScope, string> = {
17
+ global: "Global",
18
+ mail: "Mail",
19
+ compose: "Compose",
20
+ calendar: "Calendar",
21
+ contacts: "Contacts",
22
+ tasks: "Tasks",
23
+ dialog: "Dialog",
24
+ };
25
+
26
+ /** One action the keyboard can trigger, and the keys that trigger it. Views register handlers for these; nothing else defines a key. */
27
+ export interface ShortcutDef {
28
+ /** Stable name, unique across the map - what the help dialog de-duplicates on. */
29
+ id: string;
30
+ /** Specs (see `parseSpec()`) that trigger it, the first being the one shown first. `mod` is Ctrl, or Cmd on macOS. */
31
+ keys: readonly string[];
32
+ /** Extra specs that apply only in the desktop client, where the browser's own reserved keys (Ctrl+N, Ctrl+T) are the app's. */
33
+ electronKeys?: readonly string[];
34
+ /** What the help dialog and a button's tooltip call it. */
35
+ label: string;
36
+ scope: ShortcutScope;
37
+ /** Fires from a focused button or link too (Enter on a message row); by default Enter/Space are left to what has the focus. */
38
+ allowOnActivatable?: boolean;
39
+ /** Keeps firing while the key is held (arrows); by default a held key runs a one-shot action once. */
40
+ repeat?: boolean;
41
+ }
42
+
43
+ function def<T extends ShortcutDef>(shortcut: T): T {
44
+ return shortcut;
45
+ }
46
+
47
+ /**
48
+ * The whole key map, in the order the help dialog lists it. The navigation set is literally Ctrl+Shift+<letter> on every platform (Cmd+Shift
49
+ * on macOS collides with the browsers' own - Cmd+Shift+A/B/C/L/M/S are tab search, the bookmarks bar, Inspect, the sidebar, the profile
50
+ * switcher and Save As - so it is not offered); the mail actions use `mod`, so Reply is Ctrl+R on Windows and Linux and Cmd+R on a Mac.
51
+ * Ctrl+Q (mark read) stays Ctrl on a Mac because Cmd+Q is the system's Quit.
52
+ */
53
+ export const SHORTCUTS = {
54
+ global: {
55
+ account: def({ id: "go.account", keys: ["ctrl+shift+a"], label: "Go to Account", scope: "global" }),
56
+ settings: def({ id: "go.settings", keys: ["ctrl+shift+s"], label: "Go to Settings", scope: "global" }),
57
+ contacts: def({ id: "go.contacts", keys: ["ctrl+shift+b"], label: "Go to Contacts", scope: "global" }),
58
+ mail: def({ id: "go.mail", keys: ["ctrl+shift+m"], label: "Go to Mail", scope: "global" }),
59
+ calendar: def({ id: "go.calendar", keys: ["ctrl+shift+c"], label: "Go to Calendar", scope: "global" }),
60
+ tasks: def({ id: "go.tasks", keys: ["ctrl+shift+l"], electronKeys: ["ctrl+shift+t"], label: "Go to Tasks", scope: "global" }),
61
+ help: def({ id: "help", keys: ["?", "ctrl+/"], label: "Keyboard shortcuts", scope: "global" }),
62
+ },
63
+ mail: {
64
+ create: def({ id: "mail.new", keys: ["alt+n"], electronKeys: ["mod+n"], label: "New message", scope: "mail" }),
65
+ reply: def({ id: "mail.reply", keys: ["mod+r"], label: "Reply", scope: "mail" }),
66
+ replyAll: def({ id: "mail.replyAll", keys: ["mod+shift+r"], label: "Reply all", scope: "mail" }),
67
+ forward: def({ id: "mail.forward", keys: ["mod+shift+f"], label: "Forward", scope: "mail" }),
68
+ delete: def({ id: "mail.delete", keys: ["mod+d", "delete"], label: "Delete", scope: "mail" }),
69
+ archive: def({ id: "mail.archive", keys: ["e", "backspace"], label: "Archive", scope: "mail" }),
70
+ move: def({ id: "mail.move", keys: ["mod+shift+v"], label: "Move to folder", scope: "mail" }),
71
+ markRead: def({ id: "mail.markRead", keys: ["ctrl+q"], label: "Mark as read", scope: "mail" }),
72
+ markUnread: def({ id: "mail.markUnread", keys: ["mod+u"], label: "Mark as unread", scope: "mail" }),
73
+ flag: def({ id: "mail.flag", keys: ["insert"], label: "Flag or unflag", scope: "mail" }),
74
+ next: def({ id: "mail.next", keys: ["arrowdown", "j"], label: "Next message", scope: "mail", repeat: true }),
75
+ previous: def({ id: "mail.previous", keys: ["arrowup", "k"], label: "Previous message", scope: "mail", repeat: true }),
76
+ nextUnread: def({ id: "mail.nextUnread", keys: ["ctrl+."], label: "Next unread message", scope: "mail" }),
77
+ previousUnread: def({ id: "mail.previousUnread", keys: ["ctrl+,"], label: "Previous unread message", scope: "mail" }),
78
+ open: def({ id: "mail.open", keys: ["enter"], label: "Open the message on its own page", scope: "mail", allowOnActivatable: true }),
79
+ close: def({ id: "mail.close", keys: ["escape"], label: "Clear the selection", scope: "mail" }),
80
+ search: def({ id: "mail.search", keys: ["/", "mod+e"], label: "Search mail", scope: "mail" }),
81
+ },
82
+ compose: {
83
+ create: def({ id: "compose.new", keys: ["alt+n"], electronKeys: ["mod+n"], label: "New message", scope: "compose" }),
84
+ send: def({ id: "compose.send", keys: ["mod+enter"], label: "Send", scope: "compose" }),
85
+ saveDraft: def({ id: "compose.saveDraft", keys: ["mod+s"], label: "Save draft", scope: "compose" }),
86
+ close: def({ id: "compose.close", keys: ["escape"], label: "Close (keeps the draft)", scope: "compose" }),
87
+ },
88
+ calendar: {
89
+ create: def({ id: "calendar.new", keys: ["alt+n"], electronKeys: ["mod+n"], label: "New event", scope: "calendar" }),
90
+ today: def({ id: "calendar.today", keys: ["t"], label: "Go to today", scope: "calendar" }),
91
+ previous: def({ id: "calendar.previous", keys: ["arrowleft", "mod+arrowleft"], label: "Previous period", scope: "calendar", repeat: true }),
92
+ next: def({ id: "calendar.next", keys: ["arrowright", "mod+arrowright"], label: "Next period", scope: "calendar", repeat: true }),
93
+ day: def({ id: "calendar.day", keys: ["ctrl+alt+1"], label: "Day view", scope: "calendar" }),
94
+ workWeek: def({ id: "calendar.workWeek", keys: ["ctrl+alt+2"], label: "Work week view", scope: "calendar" }),
95
+ week: def({ id: "calendar.week", keys: ["ctrl+alt+3"], label: "Week view", scope: "calendar" }),
96
+ month: def({ id: "calendar.month", keys: ["ctrl+alt+4"], label: "Month view", scope: "calendar" }),
97
+ },
98
+ contacts: {
99
+ create: def({ id: "contacts.new", keys: ["alt+n"], electronKeys: ["mod+n"], label: "New contact", scope: "contacts" }),
100
+ search: def({ id: "contacts.search", keys: ["/", "mod+e"], label: "Search contacts", scope: "contacts" }),
101
+ },
102
+ tasks: {
103
+ create: def({ id: "tasks.new", keys: ["alt+n"], electronKeys: ["mod+n"], label: "New task", scope: "tasks" }),
104
+ },
105
+ } as const;
106
+
107
+ /** Every shortcut of the map flattened, in listing order. */
108
+ export const ALL_SHORTCUTS: readonly ShortcutDef[] = Object.values(SHORTCUTS).flatMap((group) => Object.values(group) as ShortcutDef[]);
109
+
110
+ /** Where a shortcut sits in the listing, for ordering registrations that arrive in whatever order components mount. */
111
+ export function shortcutRank(shortcut: ShortcutDef): number {
112
+ const index = ALL_SHORTCUTS.findIndex((candidate) => candidate.id === shortcut.id);
113
+ return index === -1 ? ALL_SHORTCUTS.length : index;
114
+ }
@@ -1,65 +1,65 @@
1
- ///////////////////////////////////////////////////////////////////////////////
2
- // Copyright (C) 2026 Jean-Philippe Steinmetz
3
- // SPDX-License-Identifier: MPL-2.0
4
- ///////////////////////////////////////////////////////////////////////////////
5
- import type { RefObject } from "react";
6
- import type { ShortcutDef, ShortcutScope } from "./keymap.js";
7
- import { ParsedSpec } from "./parse.js";
8
-
9
- /**
10
- * What a handler does with its key. Returning `false` says it did not handle it (nothing selected, a button that is disabled right now)
11
- * - the key is then left alone, and a handler of a lower scope may take it. Anything else means it did, and the key is consumed.
12
- */
13
- export type ShortcutHandler = (event: KeyboardEvent) => boolean | void;
14
-
15
- /** One mounted view's claim on a shortcut. */
16
- export interface Registration {
17
- /** Unique per registration. */
18
- id: number;
19
- shortcut: ShortcutDef;
20
- scope: ShortcutScope;
21
- /** Called at event time; reads whatever the component holds now. */
22
- run: ShortcutHandler;
23
- /** Applies only to events whose target is inside this element (a compose window). */
24
- container?: RefObject<Element | null>;
25
- keys: ParsedSpec[];
26
- electronKeys: ParsedSpec[];
27
- /** Later registrations win over earlier ones in the same scope. */
28
- order: number;
29
- }
30
-
31
- /**
32
- * The shortcuts that are mounted right now. Components add and remove their claims as they mount and unmount, so a page switch changes
33
- * what a key does with nothing to re-wire; the dispatcher (`dispatchKeyEvent()`) looks handlers up here at the time of the key press,
34
- * and the help dialog lists what is here.
35
- */
36
- export class ShortcutRegistry {
37
- private registrations: readonly Registration[] = [];
38
- private counter = 0;
39
- private listeners = new Set<() => void>();
40
-
41
- /** Adds a claim; returns what removes it. */
42
- add(claim: Omit<Registration, "id" | "order">): () => void {
43
- const registration: Registration = { ...claim, id: ++this.counter, order: this.counter };
44
- this.registrations = [...this.registrations, registration];
45
- this.publish();
46
- return () => {
47
- this.registrations = this.registrations.filter((existing) => existing.id !== registration.id);
48
- this.publish();
49
- };
50
- }
51
-
52
- /** The current claims, oldest first. A new array whenever they change (so it can be a `useSyncExternalStore()` snapshot). */
53
- getSnapshot = (): readonly Registration[] => this.registrations;
54
-
55
- subscribe = (listener: () => void): (() => void) => {
56
- this.listeners.add(listener);
57
- return () => {
58
- this.listeners.delete(listener);
59
- };
60
- };
61
-
62
- private publish(): void {
63
- this.listeners.forEach((listener) => listener());
64
- }
65
- }
1
+ ///////////////////////////////////////////////////////////////////////////////
2
+ // Copyright (C) 2026 Jean-Philippe Steinmetz
3
+ // SPDX-License-Identifier: MPL-2.0
4
+ ///////////////////////////////////////////////////////////////////////////////
5
+ import type { RefObject } from "react";
6
+ import type { ShortcutDef, ShortcutScope } from "./keymap.js";
7
+ import { ParsedSpec } from "./parse.js";
8
+
9
+ /**
10
+ * What a handler does with its key. Returning `false` says it did not handle it (nothing selected, a button that is disabled right now)
11
+ * - the key is then left alone, and a handler of a lower scope may take it. Anything else means it did, and the key is consumed.
12
+ */
13
+ export type ShortcutHandler = (event: KeyboardEvent) => boolean | void;
14
+
15
+ /** One mounted view's claim on a shortcut. */
16
+ export interface Registration {
17
+ /** Unique per registration. */
18
+ id: number;
19
+ shortcut: ShortcutDef;
20
+ scope: ShortcutScope;
21
+ /** Called at event time; reads whatever the component holds now. */
22
+ run: ShortcutHandler;
23
+ /** Applies only to events whose target is inside this element (a compose window). */
24
+ container?: RefObject<Element | null>;
25
+ keys: ParsedSpec[];
26
+ electronKeys: ParsedSpec[];
27
+ /** Later registrations win over earlier ones in the same scope. */
28
+ order: number;
29
+ }
30
+
31
+ /**
32
+ * The shortcuts that are mounted right now. Components add and remove their claims as they mount and unmount, so a page switch changes
33
+ * what a key does with nothing to re-wire; the dispatcher (`dispatchKeyEvent()`) looks handlers up here at the time of the key press,
34
+ * and the help dialog lists what is here.
35
+ */
36
+ export class ShortcutRegistry {
37
+ private registrations: readonly Registration[] = [];
38
+ private counter = 0;
39
+ private listeners = new Set<() => void>();
40
+
41
+ /** Adds a claim; returns what removes it. */
42
+ add(claim: Omit<Registration, "id" | "order">): () => void {
43
+ const registration: Registration = { ...claim, id: ++this.counter, order: this.counter };
44
+ this.registrations = [...this.registrations, registration];
45
+ this.publish();
46
+ return () => {
47
+ this.registrations = this.registrations.filter((existing) => existing.id !== registration.id);
48
+ this.publish();
49
+ };
50
+ }
51
+
52
+ /** The current claims, oldest first. A new array whenever they change (so it can be a `useSyncExternalStore()` snapshot). */
53
+ getSnapshot = (): readonly Registration[] => this.registrations;
54
+
55
+ subscribe = (listener: () => void): (() => void) => {
56
+ this.listeners.add(listener);
57
+ return () => {
58
+ this.listeners.delete(listener);
59
+ };
60
+ };
61
+
62
+ private publish(): void {
63
+ this.listeners.forEach((listener) => listener());
64
+ }
65
+ }
@@ -1,79 +1,79 @@
1
- ///////////////////////////////////////////////////////////////////////////////
2
- // Copyright (C) 2026 Jean-Philippe Steinmetz
3
- // SPDX-License-Identifier: MPL-2.0
4
- ///////////////////////////////////////////////////////////////////////////////
5
-
6
- /** `<input>` types that take no typed text, so a letter pressed on one is a shortcut, not input. (Radios and ranges use the arrows.) */
7
- const NON_TEXT_INPUT_TYPES = new Set(["button", "checkbox", "submit", "reset", "image", "file", "color"]);
8
-
9
- /** Roles whose members have keys of their own (arrows, Enter, Escape, type-ahead): a bare key pressed inside one belongs to the widget. */
10
- const WIDGET_SELECTOR = [
11
- "menu",
12
- "menubar",
13
- "listbox",
14
- "tablist",
15
- "tree",
16
- "grid",
17
- "radiogroup",
18
- "slider",
19
- "spinbutton",
20
- "combobox",
21
- ]
22
- .map((role) => `[role="${role}"]`)
23
- .join(",");
24
-
25
- /** Elements Enter (and Space) already does something on. */
26
- const ACTIVATABLE_SELECTOR = 'a[href], button, summary, [role="button"], [role="link"], [role="menuitem"], [role="menuitemcheckbox"], [role="menuitemradio"], [role="tab"], [role="option"]';
27
-
28
- /** An open popup's trigger: Escape closes the popup, so it is not a shortcut then. */
29
- const OPEN_POPUP_TRIGGER = '[aria-haspopup][aria-expanded="true"], [role="combobox"][aria-expanded="true"]';
30
-
31
- function elementOf(target: EventTarget | null): Element | null {
32
- return target instanceof Element ? target : null;
33
- }
34
-
35
- /** Whether the event target takes typed text: a text field, a select, a textarea, or anything contenteditable (the rich-text editor). */
36
- export function isTextEntry(target: EventTarget | null): boolean {
37
- const element = elementOf(target);
38
- if (!element) {
39
- return false;
40
- }
41
- const tag = element.tagName;
42
- if (tag === "TEXTAREA" || tag === "SELECT") {
43
- return true;
44
- }
45
- if (tag === "INPUT") {
46
- return !NON_TEXT_INPUT_TYPES.has((element as HTMLInputElement).type);
47
- }
48
- return !!element.closest('[contenteditable]:not([contenteditable="false"]), [role="textbox"], [role="searchbox"]');
49
- }
50
-
51
- /** Whether the target is inside a widget that reads bare keys itself (an open menu, a listbox, a tab list, ...). */
52
- export function isInWidget(target: EventTarget | null): boolean {
53
- return !!elementOf(target)?.closest(WIDGET_SELECTOR);
54
- }
55
-
56
- /** Whether Enter/Space on the target already activates it (a button, a link, a menu item). */
57
- export function isActivatable(target: EventTarget | null): boolean {
58
- return !!elementOf(target)?.closest(ACTIVATABLE_SELECTOR);
59
- }
60
-
61
- /** Whether the target is the trigger of a popup that is open right now (or the combobox that owns an open list). */
62
- export function isPopupOpenAt(target: EventTarget | null): boolean {
63
- return !!elementOf(target)?.closest(OPEN_POPUP_TRIGGER);
64
- }
65
-
66
- /** Whether a modal dialog (`aria-modal="true"`: react-shared's `Modal` and `Drawer`, the unlock prompts, ...) is on screen. */
67
- export function isModalOpen(doc: Document): boolean {
68
- return doc.querySelector('[aria-modal="true"]') !== null;
69
- }
70
-
71
- /** Whether the target is inside a popover that is a dialog of its own (the emoji and GIF pickers, the send-later picker): Escape is theirs, not a view's. A region that declares a shortcut scope (a compose window) is not one. */
72
- export function isInPopoverDialog(target: EventTarget | null): boolean {
73
- return !!elementOf(target)?.closest('[role="dialog"]:not([data-shortcut-scope])');
74
- }
75
-
76
- /** The `data-shortcut-scope` of the region the target is in (a compose window), if any. */
77
- export function regionScopeOf(target: EventTarget | null): string | undefined {
78
- return elementOf(target)?.closest("[data-shortcut-scope]")?.getAttribute("data-shortcut-scope") ?? undefined;
79
- }
1
+ ///////////////////////////////////////////////////////////////////////////////
2
+ // Copyright (C) 2026 Jean-Philippe Steinmetz
3
+ // SPDX-License-Identifier: MPL-2.0
4
+ ///////////////////////////////////////////////////////////////////////////////
5
+
6
+ /** `<input>` types that take no typed text, so a letter pressed on one is a shortcut, not input. (Radios and ranges use the arrows.) */
7
+ const NON_TEXT_INPUT_TYPES = new Set(["button", "checkbox", "submit", "reset", "image", "file", "color"]);
8
+
9
+ /** Roles whose members have keys of their own (arrows, Enter, Escape, type-ahead): a bare key pressed inside one belongs to the widget. */
10
+ const WIDGET_SELECTOR = [
11
+ "menu",
12
+ "menubar",
13
+ "listbox",
14
+ "tablist",
15
+ "tree",
16
+ "grid",
17
+ "radiogroup",
18
+ "slider",
19
+ "spinbutton",
20
+ "combobox",
21
+ ]
22
+ .map((role) => `[role="${role}"]`)
23
+ .join(",");
24
+
25
+ /** Elements Enter (and Space) already does something on. */
26
+ const ACTIVATABLE_SELECTOR = 'a[href], button, summary, [role="button"], [role="link"], [role="menuitem"], [role="menuitemcheckbox"], [role="menuitemradio"], [role="tab"], [role="option"]';
27
+
28
+ /** An open popup's trigger: Escape closes the popup, so it is not a shortcut then. */
29
+ const OPEN_POPUP_TRIGGER = '[aria-haspopup][aria-expanded="true"], [role="combobox"][aria-expanded="true"]';
30
+
31
+ function elementOf(target: EventTarget | null): Element | null {
32
+ return target instanceof Element ? target : null;
33
+ }
34
+
35
+ /** Whether the event target takes typed text: a text field, a select, a textarea, or anything contenteditable (the rich-text editor). */
36
+ export function isTextEntry(target: EventTarget | null): boolean {
37
+ const element = elementOf(target);
38
+ if (!element) {
39
+ return false;
40
+ }
41
+ const tag = element.tagName;
42
+ if (tag === "TEXTAREA" || tag === "SELECT") {
43
+ return true;
44
+ }
45
+ if (tag === "INPUT") {
46
+ return !NON_TEXT_INPUT_TYPES.has((element as HTMLInputElement).type);
47
+ }
48
+ return !!element.closest('[contenteditable]:not([contenteditable="false"]), [role="textbox"], [role="searchbox"]');
49
+ }
50
+
51
+ /** Whether the target is inside a widget that reads bare keys itself (an open menu, a listbox, a tab list, ...). */
52
+ export function isInWidget(target: EventTarget | null): boolean {
53
+ return !!elementOf(target)?.closest(WIDGET_SELECTOR);
54
+ }
55
+
56
+ /** Whether Enter/Space on the target already activates it (a button, a link, a menu item). */
57
+ export function isActivatable(target: EventTarget | null): boolean {
58
+ return !!elementOf(target)?.closest(ACTIVATABLE_SELECTOR);
59
+ }
60
+
61
+ /** Whether the target is the trigger of a popup that is open right now (or the combobox that owns an open list). */
62
+ export function isPopupOpenAt(target: EventTarget | null): boolean {
63
+ return !!elementOf(target)?.closest(OPEN_POPUP_TRIGGER);
64
+ }
65
+
66
+ /** Whether a modal dialog (`aria-modal="true"`: react-shared's `Modal` and `Drawer`, the unlock prompts, ...) is on screen. */
67
+ export function isModalOpen(doc: Document): boolean {
68
+ return doc.querySelector('[aria-modal="true"]') !== null;
69
+ }
70
+
71
+ /** Whether the target is inside a popover that is a dialog of its own (the emoji and GIF pickers, the send-later picker): Escape is theirs, not a view's. A region that declares a shortcut scope (a compose window) is not one. */
72
+ export function isInPopoverDialog(target: EventTarget | null): boolean {
73
+ return !!elementOf(target)?.closest('[role="dialog"]:not([data-shortcut-scope])');
74
+ }
75
+
76
+ /** The `data-shortcut-scope` of the region the target is in (a compose window), if any. */
77
+ export function regionScopeOf(target: EventTarget | null): string | undefined {
78
+ return elementOf(target)?.closest("[data-shortcut-scope]")?.getAttribute("data-shortcut-scope") ?? undefined;
79
+ }