sendproof-core 0.1.0.alpha.1

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 (229) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +21 -0
  3. data/README.md +55 -0
  4. data/lib/sendproof/assets.rb +70 -0
  5. data/lib/sendproof/attribution.rb +98 -0
  6. data/lib/sendproof/capture.rb +66 -0
  7. data/lib/sendproof/clock.rb +54 -0
  8. data/lib/sendproof/configuration.rb +241 -0
  9. data/lib/sendproof/data_store.rb +34 -0
  10. data/lib/sendproof/dynamodb/store.rb +183 -0
  11. data/lib/sendproof/dynamodb.rb +17 -0
  12. data/lib/sendproof/elasticsearch/store.rb +24 -0
  13. data/lib/sendproof/elasticsearch.rb +17 -0
  14. data/lib/sendproof/firestore/interceptor.rb +38 -0
  15. data/lib/sendproof/firestore/store.rb +150 -0
  16. data/lib/sendproof/firestore.rb +99 -0
  17. data/lib/sendproof/handler.rb +23 -0
  18. data/lib/sendproof/identity.rb +37 -0
  19. data/lib/sendproof/limits.rb +113 -0
  20. data/lib/sendproof/middleware.rb +68 -0
  21. data/lib/sendproof/mongo/engine.rb +692 -0
  22. data/lib/sendproof/mongo/guarded.rb +100 -0
  23. data/lib/sendproof/mongo/plain.rb +45 -0
  24. data/lib/sendproof/mongo/store.rb +54 -0
  25. data/lib/sendproof/mongo/subscriber.rb +21 -0
  26. data/lib/sendproof/mongo.rb +41 -0
  27. data/lib/sendproof/mongoid/store.rb +58 -0
  28. data/lib/sendproof/mongoid.rb +65 -0
  29. data/lib/sendproof/observed_request.rb +108 -0
  30. data/lib/sendproof/opensearch/store.rb +21 -0
  31. data/lib/sendproof/opensearch.rb +17 -0
  32. data/lib/sendproof/operation_matcher.rb +28 -0
  33. data/lib/sendproof/pool_hooks.rb +80 -0
  34. data/lib/sendproof/preview_request.rb +44 -0
  35. data/lib/sendproof/preview_transport.rb +331 -0
  36. data/lib/sendproof/protocol.rb +81 -0
  37. data/lib/sendproof/provider.rb +83 -0
  38. data/lib/sendproof/recorder.rb +298 -0
  39. data/lib/sendproof/redaction.rb +98 -0
  40. data/lib/sendproof/redis/commands.rb +76 -0
  41. data/lib/sendproof/redis/store.rb +205 -0
  42. data/lib/sendproof/redis.rb +18 -0
  43. data/lib/sendproof/search/middleware.rb +39 -0
  44. data/lib/sendproof/search/store.rb +213 -0
  45. data/lib/sendproof/search.rb +82 -0
  46. data/lib/sendproof/stores/classify.rb +346 -0
  47. data/lib/sendproof/stores/guard.rb +127 -0
  48. data/lib/sendproof/stores/tables.rb +1328 -0
  49. data/lib/sendproof/stores.rb +12 -0
  50. data/lib/sendproof/trace_store.rb +110 -0
  51. data/lib/sendproof/transaction_control.rb +187 -0
  52. data/lib/sendproof/ui/action-bar.js +91 -0
  53. data/lib/sendproof/ui/api.js +239 -0
  54. data/lib/sendproof/ui/app.css +848 -0
  55. data/lib/sendproof/ui/app.js +742 -0
  56. data/lib/sendproof/ui/autofill.js +137 -0
  57. data/lib/sendproof/ui/code-copy.js +71 -0
  58. data/lib/sendproof/ui/code-picker.js +149 -0
  59. data/lib/sendproof/ui/commands.js +197 -0
  60. data/lib/sendproof/ui/components.js +77 -0
  61. data/lib/sendproof/ui/context-bar.js +82 -0
  62. data/lib/sendproof/ui/copy.js +92 -0
  63. data/lib/sendproof/ui/coverage-popover.js +35 -0
  64. data/lib/sendproof/ui/crumb-fit.js +80 -0
  65. data/lib/sendproof/ui/deprecation.js +164 -0
  66. data/lib/sendproof/ui/display-settings.js +175 -0
  67. data/lib/sendproof/ui/doc-diff.js +209 -0
  68. data/lib/sendproof/ui/docs-view.js +347 -0
  69. data/lib/sendproof/ui/favicon.png +0 -0
  70. data/lib/sendproof/ui/favicon.svg +1 -0
  71. data/lib/sendproof/ui/field-help.js +52 -0
  72. data/lib/sendproof/ui/field-modules.js +23 -0
  73. data/lib/sendproof/ui/fields/controls.js +179 -0
  74. data/lib/sendproof/ui/fields/dom.js +36 -0
  75. data/lib/sendproof/ui/fields/infer.js +71 -0
  76. data/lib/sendproof/ui/fields/lookup-source.js +63 -0
  77. data/lib/sendproof/ui/fields/lookup.js +285 -0
  78. data/lib/sendproof/ui/fields/render.js +496 -0
  79. data/lib/sendproof/ui/fields/select.js +175 -0
  80. data/lib/sendproof/ui/fields/validate.js +363 -0
  81. data/lib/sendproof/ui/fields/validation-formats.js +164 -0
  82. data/lib/sendproof/ui/fields/validation-references.js +68 -0
  83. data/lib/sendproof/ui/fields/validation-values.js +137 -0
  84. data/lib/sendproof/ui/generate-menu.js +44 -0
  85. data/lib/sendproof/ui/generate.js +184 -0
  86. data/lib/sendproof/ui/header-editor.js +777 -0
  87. data/lib/sendproof/ui/headers.js +188 -0
  88. data/lib/sendproof/ui/highlight.js +257 -0
  89. data/lib/sendproof/ui/history-popover.js +24 -0
  90. data/lib/sendproof/ui/i18n.js +253 -0
  91. data/lib/sendproof/ui/icons.js +87 -0
  92. data/lib/sendproof/ui/index.html +70 -0
  93. data/lib/sendproof/ui/issues.js +187 -0
  94. data/lib/sendproof/ui/json-view.js +166 -0
  95. data/lib/sendproof/ui/lang-icons.js +62 -0
  96. data/lib/sendproof/ui/layout.js +262 -0
  97. data/lib/sendproof/ui/listbox.js +334 -0
  98. data/lib/sendproof/ui/locales/ar-capture.js +366 -0
  99. data/lib/sendproof/ui/locales/ar-stores.js +116 -0
  100. data/lib/sendproof/ui/locales/ar.js +561 -0
  101. data/lib/sendproof/ui/locales/cs-capture.js +442 -0
  102. data/lib/sendproof/ui/locales/cs-stores.js +116 -0
  103. data/lib/sendproof/ui/locales/cs.js +689 -0
  104. data/lib/sendproof/ui/locales/da-capture.js +347 -0
  105. data/lib/sendproof/ui/locales/da-stores.js +116 -0
  106. data/lib/sendproof/ui/locales/da.js +522 -0
  107. data/lib/sendproof/ui/locales/de-capture.js +347 -0
  108. data/lib/sendproof/ui/locales/de-stores.js +116 -0
  109. data/lib/sendproof/ui/locales/de.js +519 -0
  110. data/lib/sendproof/ui/locales/el-capture.js +347 -0
  111. data/lib/sendproof/ui/locales/el-stores.js +116 -0
  112. data/lib/sendproof/ui/locales/el.js +520 -0
  113. data/lib/sendproof/ui/locales/en-capture.js +349 -0
  114. data/lib/sendproof/ui/locales/en-stores.js +95 -0
  115. data/lib/sendproof/ui/locales/en.js +522 -0
  116. data/lib/sendproof/ui/locales/es-capture.js +353 -0
  117. data/lib/sendproof/ui/locales/es-stores.js +116 -0
  118. data/lib/sendproof/ui/locales/es.js +525 -0
  119. data/lib/sendproof/ui/locales/fa-capture.js +348 -0
  120. data/lib/sendproof/ui/locales/fa-stores.js +116 -0
  121. data/lib/sendproof/ui/locales/fa.js +521 -0
  122. data/lib/sendproof/ui/locales/fi-capture.js +347 -0
  123. data/lib/sendproof/ui/locales/fi-stores.js +116 -0
  124. data/lib/sendproof/ui/locales/fi.js +523 -0
  125. data/lib/sendproof/ui/locales/fr-capture.js +353 -0
  126. data/lib/sendproof/ui/locales/fr-stores.js +116 -0
  127. data/lib/sendproof/ui/locales/fr.js +525 -0
  128. data/lib/sendproof/ui/locales/he-capture.js +358 -0
  129. data/lib/sendproof/ui/locales/he-stores.js +116 -0
  130. data/lib/sendproof/ui/locales/he.js +529 -0
  131. data/lib/sendproof/ui/locales/hi-capture.js +348 -0
  132. data/lib/sendproof/ui/locales/hi-stores.js +116 -0
  133. data/lib/sendproof/ui/locales/hi.js +523 -0
  134. data/lib/sendproof/ui/locales/id-capture.js +347 -0
  135. data/lib/sendproof/ui/locales/id-stores.js +116 -0
  136. data/lib/sendproof/ui/locales/id.js +521 -0
  137. data/lib/sendproof/ui/locales/it-capture.js +361 -0
  138. data/lib/sendproof/ui/locales/it-stores.js +116 -0
  139. data/lib/sendproof/ui/locales/it.js +523 -0
  140. data/lib/sendproof/ui/locales/ja-capture.js +346 -0
  141. data/lib/sendproof/ui/locales/ja-stores.js +116 -0
  142. data/lib/sendproof/ui/locales/ja.js +521 -0
  143. data/lib/sendproof/ui/locales/ko-capture.js +346 -0
  144. data/lib/sendproof/ui/locales/ko-stores.js +116 -0
  145. data/lib/sendproof/ui/locales/ko.js +522 -0
  146. data/lib/sendproof/ui/locales/nb-capture.js +349 -0
  147. data/lib/sendproof/ui/locales/nb-stores.js +116 -0
  148. data/lib/sendproof/ui/locales/nb.js +521 -0
  149. data/lib/sendproof/ui/locales/nl-capture.js +355 -0
  150. data/lib/sendproof/ui/locales/nl-stores.js +116 -0
  151. data/lib/sendproof/ui/locales/nl.js +520 -0
  152. data/lib/sendproof/ui/locales/pl-capture.js +432 -0
  153. data/lib/sendproof/ui/locales/pl-stores.js +116 -0
  154. data/lib/sendproof/ui/locales/pl.js +528 -0
  155. data/lib/sendproof/ui/locales/pt-BR-capture.js +350 -0
  156. data/lib/sendproof/ui/locales/pt-BR-stores.js +116 -0
  157. data/lib/sendproof/ui/locales/pt-BR.js +523 -0
  158. data/lib/sendproof/ui/locales/pt-PT-capture.js +350 -0
  159. data/lib/sendproof/ui/locales/pt-PT-stores.js +116 -0
  160. data/lib/sendproof/ui/locales/pt-PT.js +523 -0
  161. data/lib/sendproof/ui/locales/ru-capture.js +437 -0
  162. data/lib/sendproof/ui/locales/ru-stores.js +116 -0
  163. data/lib/sendproof/ui/locales/ru.js +624 -0
  164. data/lib/sendproof/ui/locales/sv-capture.js +349 -0
  165. data/lib/sendproof/ui/locales/sv-stores.js +116 -0
  166. data/lib/sendproof/ui/locales/sv.js +518 -0
  167. data/lib/sendproof/ui/locales/th-capture.js +347 -0
  168. data/lib/sendproof/ui/locales/th-stores.js +116 -0
  169. data/lib/sendproof/ui/locales/th.js +521 -0
  170. data/lib/sendproof/ui/locales/tr-capture.js +348 -0
  171. data/lib/sendproof/ui/locales/tr-stores.js +116 -0
  172. data/lib/sendproof/ui/locales/tr.js +521 -0
  173. data/lib/sendproof/ui/locales/uk-capture.js +442 -0
  174. data/lib/sendproof/ui/locales/uk-stores.js +116 -0
  175. data/lib/sendproof/ui/locales/uk.js +630 -0
  176. data/lib/sendproof/ui/locales/vi-capture.js +346 -0
  177. data/lib/sendproof/ui/locales/vi-stores.js +116 -0
  178. data/lib/sendproof/ui/locales/vi.js +523 -0
  179. data/lib/sendproof/ui/locales/zh-Hans-capture.js +347 -0
  180. data/lib/sendproof/ui/locales/zh-Hans-stores.js +116 -0
  181. data/lib/sendproof/ui/locales/zh-Hans.js +523 -0
  182. data/lib/sendproof/ui/locales/zh-Hant-capture.js +346 -0
  183. data/lib/sendproof/ui/locales/zh-Hant-stores.js +116 -0
  184. data/lib/sendproof/ui/locales/zh-Hant.js +522 -0
  185. data/lib/sendproof/ui/manifest.json +866 -0
  186. data/lib/sendproof/ui/markdown.js +39 -0
  187. data/lib/sendproof/ui/model-view.js +182 -0
  188. data/lib/sendproof/ui/navigation.js +233 -0
  189. data/lib/sendproof/ui/operation-header.js +76 -0
  190. data/lib/sendproof/ui/operations.js +7 -0
  191. data/lib/sendproof/ui/overview-view.js +63 -0
  192. data/lib/sendproof/ui/personas.js +59 -0
  193. data/lib/sendproof/ui/popover.js +71 -0
  194. data/lib/sendproof/ui/preview-false.js +108 -0
  195. data/lib/sendproof/ui/request-editor.js +496 -0
  196. data/lib/sendproof/ui/response-metadata.js +354 -0
  197. data/lib/sendproof/ui/response-viewer.js +618 -0
  198. data/lib/sendproof/ui/result-blocked.js +155 -0
  199. data/lib/sendproof/ui/result-capture.js +25 -0
  200. data/lib/sendproof/ui/result-database.js +185 -0
  201. data/lib/sendproof/ui/result-effects.js +176 -0
  202. data/lib/sendproof/ui/result-headers.js +106 -0
  203. data/lib/sendproof/ui/result-logs.js +408 -0
  204. data/lib/sendproof/ui/result-states.js +213 -0
  205. data/lib/sendproof/ui/results.js +371 -0
  206. data/lib/sendproof/ui/router.js +118 -0
  207. data/lib/sendproof/ui/schema-model.js +336 -0
  208. data/lib/sendproof/ui/schema-tree.js +344 -0
  209. data/lib/sendproof/ui/schema.js +397 -0
  210. data/lib/sendproof/ui/security.js +31 -0
  211. data/lib/sendproof/ui/seeded-menu.js +69 -0
  212. data/lib/sendproof/ui/settings.js +93 -0
  213. data/lib/sendproof/ui/shortcuts-sheet.js +73 -0
  214. data/lib/sendproof/ui/shortcuts.js +190 -0
  215. data/lib/sendproof/ui/sidebar.js +289 -0
  216. data/lib/sendproof/ui/signin.js +259 -0
  217. data/lib/sendproof/ui/snippets.js +530 -0
  218. data/lib/sendproof/ui/store-marks.js +47 -0
  219. data/lib/sendproof/ui/stores.js +131 -0
  220. data/lib/sendproof/ui/styles.css +971 -0
  221. data/lib/sendproof/ui/toggletip.js +53 -0
  222. data/lib/sendproof/ui/uuid.js +10 -0
  223. data/lib/sendproof/ui/view.js +122 -0
  224. data/lib/sendproof/ui/views.css +653 -0
  225. data/lib/sendproof/version.rb +9 -0
  226. data/lib/sendproof/workbench.rb +102 -0
  227. data/lib/sendproof-core.rb +3 -0
  228. data/lib/sendproof.rb +121 -0
  229. metadata +292 -0
@@ -0,0 +1,190 @@
1
+ // The one shortcut registry. Keyboard handling, aria-keyshortcuts, keycaps on buttons, the
2
+ // command palette and the shortcut sheet all read these definitions, so they can't disagree.
3
+ //
4
+ // A chord is shown as one keycap: "⇧⌘↵" on a Mac, "Ctrl ⇧↵" elsewhere. Tooltips, menus and the
5
+ // sheet's note use the long form, such as "Ctrl+Shift+Enter".
6
+ import { current, t } from './i18n.js';
7
+
8
+ const keys = (...values) => values.join('+');
9
+
10
+ /** Shared shortcut definitions. `group` places an entry in the sheet and palette. */
11
+ export const SHORTCUTS = {
12
+ palette: { group: 'General', chord: keys('Mod', 'K'), icon: 'search' },
13
+ shortcuts: { group: 'General', chord: '?', icon: 'keyboard' },
14
+ display: { group: 'General', chord: keys('Mod', ','), icon: 'sliders' },
15
+ sidebar: { group: 'General', chord: keys('Mod', '\\'), icon: 'sidebar' },
16
+ theme: { group: 'General', chord: keys('Mod', 'Shift', 'L'), icon: 'moon' },
17
+ history: { group: 'General', chord: keys('Mod', 'Y'), icon: 'history' },
18
+ signin: { group: 'General', chord: keys('Mod', 'Shift', 'U'), icon: 'user' },
19
+ filter: { group: 'Navigate', chord: '/', icon: 'filter' },
20
+ next: { group: 'Navigate', chord: 'J' },
21
+ previous: { group: 'Navigate', chord: 'K' },
22
+ 'sidebar-operations': { group: 'Navigate', sequence: ['G', 'O'], icon: 'list' },
23
+ 'sidebar-models': { group: 'Navigate', sequence: ['G', 'M'], icon: 'box' },
24
+ 'goto-operation': { group: 'Navigate', icon: 'search' },
25
+ docs: { group: 'Navigate', chord: 'D', icon: 'book' },
26
+ 'model-back': { group: 'Navigate', chord: keys('Alt', 'ArrowLeft'), icon: 'arrow-left' },
27
+ 'focus-pane': { group: 'Navigate', chord: keys('Mod', '[') },
28
+ 'editor-mode': { group: 'Request', chord: keys('Mod', 'E'), icon: 'code' },
29
+ 'issue-next': { group: 'Request', chord: keys('Alt', 'ArrowDown'), icon: 'alert' },
30
+ 'issue-previous': { group: 'Request', chord: keys('Alt', 'ArrowUp'), icon: 'alert' },
31
+ 'copy-url': { group: 'Request', chord: keys('Mod', 'Alt', 'U'), icon: 'copy' },
32
+ 'open-replacement': { group: 'Request', chord: keys('Alt', 'R'), icon: 'arrow-right' },
33
+ 'traced-send': { group: 'Request', icon: 'eye' },
34
+ 'add-header': { group: 'Headers & lists', chord: keys('Mod', 'Shift', 'H'), icon: 'plus' },
35
+ 'add-row': { group: 'Headers & lists', chord: keys('Mod', 'Enter') },
36
+ 'remove-row': { group: 'Headers & lists', chord: 'Backspace' },
37
+ 'toggle-header': { group: 'Headers & lists', chord: keys('Mod', '/') },
38
+ 'bulk-edit': { group: 'Headers & lists', chord: keys('Mod', 'Shift', 'B'), icon: 'edit' },
39
+ 'header-presets': { group: 'Headers & lists', icon: 'list' },
40
+ generate: { group: 'Fields', chord: keys('Alt', 'G') },
41
+ 'generate-menu': { group: 'Fields', chord: keys('Alt', 'Shift', 'G') },
42
+ 'field-info': { group: 'Fields', chord: keys('Alt', 'I') },
43
+ 'lookup-open': { group: 'Fields', chord: keys('Alt', 'ArrowDown') },
44
+ 'lookup-preview': { group: 'Fields', chord: keys('Mod', 'Enter') },
45
+ 'lookup-paste': { group: 'Fields', chord: keys('Mod', 'V') },
46
+ 'autofill-undo': { group: 'Fields', chord: keys('Mod', 'Z'), mode: 'undo' },
47
+ 'date-today': { group: 'Fields', chord: 'T' },
48
+ 'date-tomorrow': { group: 'Fields', chord: 'Plus' },
49
+ 'date-yesterday': { group: 'Fields', chord: '-' },
50
+ 'copy-curl': { group: 'Result', chord: keys('Mod', 'Shift', 'C'), icon: 'copy' },
51
+ 'copy-response': { group: 'Result', chord: keys('Mod', 'Alt', 'C'), icon: 'copy' },
52
+ 'find-response': { group: 'Result', chord: keys('Mod', 'F'), icon: 'search' },
53
+ 'fold-all': { group: 'Result', chord: keys('Alt', 'Shift', 'ArrowUp'), icon: 'chevrons-ud' },
54
+ 'wrap-lines': { group: 'Result', chord: keys('Alt', 'Z'), icon: 'wrap' },
55
+ 'follow-response': { group: 'Result', chord: keys('Mod', 'G'), icon: 'link' },
56
+ 'change-next': { group: 'Result', chord: 'N' },
57
+ 'change-prev': { group: 'Result', chord: 'P' },
58
+ escape: { group: 'Result', chord: 'Escape' },
59
+ 'autofill-required': { group: 'Request', chord: keys('Mod', 'Shift', 'F'), mode: 'required', icon: 'wand' },
60
+ 'autofill-all': { group: 'Request', chord: keys('Mod', 'Alt', 'Shift', 'F'), mode: 'all', icon: 'list' },
61
+ 'autofill-reuse': { group: 'Request', chord: keys('Mod', 'R'), mode: 'reuse' },
62
+ 'autofill-ids': { group: 'Fields', chord: keys('Mod', 'I'), mode: 'ids' },
63
+ 'autofill-clear': { group: 'Request', chord: keys('Mod', 'Shift', 'Backspace'), mode: 'clear' },
64
+ preview: { group: 'Request', chord: keys('Mod', 'Enter'), icon: 'flask' },
65
+ send: { group: 'Request', chord: keys('Mod', 'Shift', 'Enter'), icon: 'send' },
66
+ 'send-read-only': { chord: keys('Mod', 'Enter') },
67
+ 'reload-spec': { chord: keys('Mod', 'R') },
68
+ enter: { chord: 'Enter' },
69
+ tab: { chord: 'Tab' },
70
+ up: { chord: 'ArrowUp' },
71
+ down: { chord: 'ArrowDown' },
72
+ updown: { chord: 'ArrowUp', display: '↑↓' },
73
+ left: { chord: 'ArrowLeft' },
74
+ right: { chord: 'ArrowRight' },
75
+ home: { chord: 'Home' },
76
+ end: { chord: 'End' },
77
+ pageup: { chord: 'PageUp' },
78
+ pagedown: { chord: 'PageDown' },
79
+ copy: { chord: keys('Mod', 'C') },
80
+ 'zoom-in': { chord: keys('Mod', 'Plus') },
81
+ 'zoom-out': { chord: keys('Mod', '-') },
82
+ };
83
+ for (let index = 0; index < 5; index++) {
84
+ SHORTCUTS['request-tab-' + index] = { chord: keys('Alt', index + 1) };
85
+ SHORTCUTS['result-tab-' + index] = { chord: keys('Shift', 'Alt', index + 1) };
86
+ }
87
+ SHORTCUTS['request-tab-range'] = { range: ['request-tab-0', 'request-tab-4'] };
88
+ SHORTCUTS['result-tab-range'] = { range: ['result-tab-0', 'result-tab-4'] };
89
+
90
+ /** The label of a shortcut in the current language. */
91
+ export const shortcutLabel = id => t('shortcut.' + id);
92
+
93
+ const keyGlyphs = {
94
+ Enter: '↵', Escape: 'Esc', ArrowUp: '↑', ArrowDown: '↓', ArrowLeft: '←', ArrowRight: '→',
95
+ Backspace: '⌫', Plus: '+', Tab: 'Tab', Home: 'Home', End: 'End', PageUp: 'PgUp', PageDown: 'PgDn',
96
+ };
97
+ const modifiers = ['Mod', 'Shift', 'Alt', 'Meta', 'Control'];
98
+ const platformStyle = () => current().platform === 'mac'
99
+ ? { order: ['Alt', 'Shift', 'Mod'], compact: { Mod: '⌘', Shift: '⇧', Alt: '⌥' }, long: { Mod: '⌘', Shift: '⇧', Alt: '⌥', Enter: 'Return' }, joiner: '' }
100
+ : { order: ['Mod', 'Shift', 'Alt'], compact: { Mod: 'Ctrl ', Shift: '⇧', Alt: 'Alt ' }, long: { Mod: 'Ctrl', Shift: 'Shift', Alt: 'Alt', Enter: 'Enter' }, joiner: '+' };
101
+
102
+ function sortedParts(chord) {
103
+ const parts = chord.split('+');
104
+ const style = platformStyle();
105
+ return [...style.order.filter(key => parts.includes(key)), ...parts.filter(key => !modifiers.includes(key))];
106
+ }
107
+
108
+ /** One keycap's text for a chord: "⇧⌘↵" on a Mac, "Ctrl ⇧↵" elsewhere. */
109
+ export function chordText(chord) {
110
+ const style = platformStyle();
111
+ return sortedParts(chord).map(key => style.compact[key] ?? keyGlyphs[key] ?? key).join('');
112
+ }
113
+
114
+ /** The long form for tooltips and menus: "⇧⌘Return" on a Mac, "Ctrl+Shift+Enter" elsewhere. */
115
+ export function chordLong(chord) {
116
+ const style = platformStyle();
117
+ return sortedParts(chord).map(key => style.long[key] ?? keyGlyphs[key] ?? key).join(style.joiner);
118
+ }
119
+
120
+ /** The keycaps shown for a shortcut, in order. A sequence such as G then O gives ['G', 'then', 'O']. */
121
+ export function shortcutParts(id) {
122
+ const definition = SHORTCUTS[id];
123
+ if (!definition) return [];
124
+ if (definition.range) {
125
+ const first = shortcutParts(definition.range[0])[0];
126
+ const last = shortcutParts(definition.range[1])[0];
127
+ return [first.slice(0, -1) + first.at(-1) + '–' + last.at(-1)];
128
+ }
129
+ if (definition.sequence) return definition.sequence.flatMap((key, index) => index ? ['then', key] : [key]);
130
+ if (definition.display) return [definition.display];
131
+ return definition.chord ? [chordText(definition.chord)] : [];
132
+ }
133
+
134
+ /** The long, readable form of a shortcut, for tooltips: "Ctrl+Shift+Enter". */
135
+ export function shortcutLong(id) {
136
+ const definition = SHORTCUTS[id];
137
+ if (definition?.sequence) return definition.sequence.join(' ' + t('kbd.then') + ' ');
138
+ return definition?.chord ? chordLong(definition.chord) : '';
139
+ }
140
+
141
+ const partMarkup = key => key === 'then'
142
+ ? `<span class="then">${t('kbd.then')}</span>`
143
+ : `<kbd class="kbd">${key.replace(/&/g, '&amp;').replace(/</g, '&lt;')}</kbd>`;
144
+
145
+ /** Keycaps for one or more shortcuts. Decorative: the control's aria-keyshortcuts announces them. */
146
+ export function shortcutHint(...ids) {
147
+ return `<span class="keys" data-shortcut-hint="${ids.join(' ')}" aria-hidden="true">${ids.flatMap(shortcutParts).map(partMarkup).join('')}</span>`;
148
+ }
149
+
150
+ /** The same keycaps as a DOM node. */
151
+ export function shortcutHintNode(...ids) {
152
+ const group = document.createElement('span');
153
+ group.className = 'keys';
154
+ group.dataset.shortcutHint = ids.join(' ');
155
+ group.setAttribute('aria-hidden', 'true');
156
+ for (const key of ids.flatMap(shortcutParts)) {
157
+ const cap = document.createElement(key === 'then' ? 'span' : 'kbd');
158
+ cap.className = key === 'then' ? 'then' : 'kbd';
159
+ cap.textContent = key === 'then' ? t('kbd.then') : key;
160
+ group.append(cap);
161
+ }
162
+ return group;
163
+ }
164
+
165
+ export function shortcutAria(...ids) {
166
+ return ids.flatMap(id => {
167
+ const chord = SHORTCUTS[id]?.chord;
168
+ return !chord ? [] : chord.includes('Mod') ? [chord.replace('Mod', 'Meta'), chord.replace('Mod', 'Control')] : [chord];
169
+ }).join(' ');
170
+ }
171
+
172
+ export function shortcutAttrs(...ids) {
173
+ const aria = shortcutAria(...ids);
174
+ return aria ? `aria-keyshortcuts="${aria}" data-shortcut="${ids.join(' ')}"` : '';
175
+ }
176
+
177
+ export function matchesShortcut(id, event) {
178
+ const parts = SHORTCUTS[id]?.chord?.split('+');
179
+ if (!parts || event.defaultPrevented || event.isComposing) return false;
180
+ const key = parts.at(-1) === 'Plus' ? '+' : parts.at(-1);
181
+ const symbol = key === '?' || key === '+' || key === ',';
182
+ const keyMatches = event.key.toLowerCase() === key.toLowerCase() ||
183
+ (parts.length > 1 && (/^[a-z]$/i.test(key) && event.code === 'Key' + key.toUpperCase() ||
184
+ /^\d$/.test(key) && event.code === 'Digit' + key));
185
+ return keyMatches &&
186
+ (symbol || !!event.shiftKey === parts.includes('Shift')) &&
187
+ !!event.altKey === parts.includes('Alt') &&
188
+ (parts.includes('Mod') ? !!(event.metaKey || event.ctrlKey) :
189
+ !!event.metaKey === parts.includes('Meta') && !!event.ctrlKey === parts.includes('Control'));
190
+ }
@@ -0,0 +1,289 @@
1
+ // The sidebar (mocks/sidebar.js): Operations and Models tabs, the signed-out notice, the filter,
2
+ // tag and model groups, and the foot bar.
3
+ //
4
+ // - Every group starts open (List pages in Models start closed). Each heading collapses its
5
+ // group, the choice is remembered per API in localStorage, and "Collapse all" lives in the foot.
6
+ // - Signed out, a notice at the top says how many operations need sign-in; locked rows carry a
7
+ // lock. Deprecated and locked markers stack. Signed in, role-restricted rows carry a shield.
8
+ // - The tab changes only when the user picks it. An operation a model was opened from stays
9
+ // marked as the current context (`.is-context`, aria-current="location").
10
+ import { esc, icon, method, stateBlock } from './components.js';
11
+ import { formatNumber, t, th } from './i18n.js';
12
+ import { isPublic, requiredScopes, scopeText } from './security.js';
13
+ import { shortcutAttrs, shortcutHint } from './shortcuts.js';
14
+ import { modelGroups, modelKind, modelSize } from './schema-model.js';
15
+ import { opKey } from './operations.js';
16
+ import { previewUnavailable } from './stores.js';
17
+ import { bindDeprecationTips, deprecationTipParts } from './deprecation.js';
18
+
19
+ /** Edit distance, used to suggest a likely intended filter. */
20
+ function distance(a, b) {
21
+ const row = Array.from({ length: b.length + 1 }, (_, i) => i);
22
+ for (let i = 1; i <= a.length; i++) {
23
+ let previous = row[0];
24
+ row[0] = i;
25
+ for (let j = 1; j <= b.length; j++) {
26
+ const saved = row[j];
27
+ row[j] = Math.min(row[j] + 1, row[j - 1] + 1, previous + (a[i - 1] === b[j - 1] ? 0 : 1));
28
+ previous = saved;
29
+ }
30
+ }
31
+ return row[b.length];
32
+ }
33
+
34
+ /** The closest word to a query among names, for "Try “payment”". */
35
+ export function suggestion(query, words) {
36
+ let best;
37
+ for (const word of new Set(words.map(item => item.toLowerCase()).filter(item => item.length > 2))) {
38
+ const score = distance(query, word);
39
+ if (score <= Math.max(1, Math.floor(query.length / 3)) && (!best || score < best.score)) best = { word, score };
40
+ }
41
+ return best?.word;
42
+ }
43
+
44
+ const searchText = op => `${op.title} ${op.path} ${op.method} ${op.group} ${op.operation.operationId || ''} ${(op.operation.tags || []).join(' ')}`.toLowerCase();
45
+
46
+ /** Models groups that start collapsed, until the user opens them. */
47
+ const COLLAPSED_BY_DEFAULT = new Set(['lists']);
48
+
49
+ /** The storage key of the remembered group state for one API document. */
50
+ export const navStorageKey = documentUrl => `sendproof-nav:${documentUrl || ''}`;
51
+
52
+ /**
53
+ * Reads the remembered group state: `{ ops: { [tag]: boolean }, models: { [group]: boolean } }`
54
+ * where true means collapsed. Anything unreadable means "nothing remembered".
55
+ */
56
+ export function loadNavState(storage, documentUrl) {
57
+ try {
58
+ const value = JSON.parse(storage?.getItem(navStorageKey(documentUrl)) || 'null');
59
+ const clean = source => Object.fromEntries(Object.entries(source && typeof source === 'object' ? source : {}).filter(([, flag]) => typeof flag === 'boolean'));
60
+ return { ops: clean(value?.ops), models: clean(value?.models) };
61
+ } catch { return { ops: {}, models: {} }; }
62
+ }
63
+
64
+ /** Writes the remembered group state; storage that is full or blocked is ignored. */
65
+ export function saveNavState(storage, documentUrl, nav) {
66
+ try { storage?.setItem(navStorageKey(documentUrl), JSON.stringify(nav)); } catch { /* A blocked store only forgets the choice. */ }
67
+ }
68
+
69
+ /** Tag groups in the document's tag order, then any tags only operations mention. */
70
+ export function operationGroups(ops, document) {
71
+ const map = new Map((document?.tags || []).map(tag => [tag.name, []]));
72
+ for (const op of ops) {
73
+ if (!map.has(op.group)) map.set(op.group, []);
74
+ map.get(op.group).push(op);
75
+ }
76
+ return [...map].filter(([, items]) => items.length);
77
+ }
78
+
79
+ /** Sidebar rendering and its small amount of state. */
80
+ export function createSidebar({ state, $, storage = globalThis.localStorage }) {
81
+ let tab = 'operations';
82
+ let nav = { ops: {}, models: {} };
83
+ let loadedFor;
84
+
85
+ bindDeprecationTips();
86
+ const signedIn = () => !!state.cap?.identity?.name;
87
+ const models = () => Object.entries(state.doc?.components?.schemas || {});
88
+ const groups = () => operationGroups(state.ops, state.doc);
89
+ const loaded = () => {
90
+ if (loadedFor !== state.documentUrl) { loadedFor = state.documentUrl; nav = loadNavState(storage, state.documentUrl); }
91
+ return nav;
92
+ };
93
+ const isCollapsed = (kind, key) => loaded()[kind][key] ?? (kind === 'models' && COLLAPSED_BY_DEFAULT.has(key));
94
+ const remember = (kind, key, collapsed) => { loaded()[kind][key] = collapsed; saveNavState(storage, state.documentUrl, nav); };
95
+
96
+ /** Whether the signed-in user's role is outside the roles an operation names (admins pass anything they're listed for). */
97
+ function restricted(op) {
98
+ const scopes = requiredScopes(op, state.doc);
99
+ const identity = state.cap?.identity;
100
+ const roles = [identity?.role, ...(identity?.roles || [])].filter(Boolean);
101
+ return scopes.length > 0 && !scopes.some(scope => roles.includes(scope));
102
+ }
103
+
104
+ /** Deprecated and locked (or role) markers stack; each has a tooltip and screen-reader text. */
105
+ function trail(op) {
106
+ const out = [];
107
+ const mark = (glyph, label, cls = '') => out.push(`<span${cls ? ` class="${cls}"` : ''} title="${esc(label)}">${icon(glyph, true)}<span class="sr-only">${esc(label)}</span></span>`);
108
+ if (op.operation.deprecated) mark('warn', t('side.deprecated'));
109
+ // Marked preview: false by the API author (mock 122): the reason is in the tooltip.
110
+ const noPreview = !['GET', 'HEAD', 'OPTIONS'].includes(op.method) && previewUnavailable(op, state.cap);
111
+ if (noPreview) mark('flask-off', noPreview.reason ? `${t('side.noPreview')} · ${noPreview.reason}` : t('side.noPreview'), 'no-preview');
112
+ if (!isPublic(op, state.doc)) {
113
+ if (!signedIn()) mark('lock', t('side.needsSignIn'), 'lock');
114
+ else if (restricted(op)) mark('shield', t('side.needsScope', { scope: scopeText(op, state.doc) }));
115
+ }
116
+ return out.length ? `<span class="trail">${out.join('')}</span>` : '';
117
+ }
118
+
119
+ function noMatch(query, names, forModels = false) {
120
+ const guess = suggestion(query, names.flatMap(name => name.split(/[^\p{L}\p{N}]+/u)));
121
+ return `<div class="nav-state">${stateBlock({
122
+ glyph: 'search', compact: true, title: esc(t(forModels ? 'side.noMatchModelsTitle' : 'side.noMatchTitle', { query })),
123
+ body: esc(t(forModels ? 'side.noMatchModelsBody' : 'side.noMatchBody')),
124
+ actions: [`<button type="button" class="btn btn-sm" data-action="clear-filter">${esc(t('side.clearFilter'))} ${shortcutHint('escape')}</button>`,
125
+ guess ? `<button type="button" class="btn btn-ghost btn-sm" data-filter-suggestion="${esc(guess)}">${esc(t('side.try', { query: guess }))}</button>` : ''].filter(Boolean),
126
+ })}</div>`;
127
+ }
128
+
129
+ /** A group with a disclosure heading and its list. `open` is forced while filtering. */
130
+ function group(id, kind, key, label, count, open, items, lang = true) {
131
+ return `<div class="nav-group">
132
+ <button type="button" class="nav-heading" data-group="${esc(key)}" data-group-kind="${kind}" aria-controls="${id}" aria-expanded="${open}">${icon(open ? 'chevron-down' : 'chevron-right', true)}<span${lang ? ' lang="en"' : ''}>${esc(label)}</span><span class="count">${formatNumber(count)}</span></button>
133
+ <ul id="${id}" ${open ? '' : 'hidden'}>${items}</ul>
134
+ </div>`;
135
+ }
136
+
137
+ function operationList(query) {
138
+ if (!state.ops.length) return stateBlock({
139
+ glyph: 'list', compact: true, title: esc(t('side.emptyTitle')),
140
+ body: th('side.emptyBody', { url: `<code class="ltr">${esc(new URL(state.documentUrl, location.href).pathname)}</code>` }),
141
+ actions: [`<button type="button" class="btn btn-sm" data-action="restart" ${shortcutAttrs('reload-spec')}>${icon('refresh', true)}${esc(t('side.reload'))} ${shortcutHint('reload-spec')}</button>`],
142
+ });
143
+ const matching = groups().map(([name, items]) => [name, items.filter(op => searchText(op).includes(query))]).filter(([, items]) => items.length);
144
+ if (!matching.length) return noMatch(query, state.ops.flatMap(op => [op.title, op.group, ...(op.operation.tags || [])]));
145
+ const context = state.view === 'model' ? state.modelFrom?.op : undefined;
146
+ const docs = state.view === 'docs';
147
+ return matching.map(([name, items], index) => group(`nav-group-${index}`, 'ops', name, name, items.length, !!query || !isCollapsed('ops', name),
148
+ items.map(op => {
149
+ const current = op === state.op && (state.view === 'try' || state.view === 'docs');
150
+ const here = current ? ' aria-current="page"' : op === context ? ' aria-current="location"' : '';
151
+ // A deprecated row's tooltip says when it stops working and what to use (mock 90).
152
+ const parts = op.operation.deprecated && deprecationTipParts(op, state.ops, state.doc);
153
+ const tip = parts ? ` data-dep-tip="${esc(parts.head)}" data-dep-use="${esc(parts.use)}"` : ` title="${esc(op.title)}"`;
154
+ return `<li><a class="nav-item${op.operation.deprecated ? ' is-deprecated' : ''}${op === context ? ' is-context' : ''}" href="#${docs ? 'docs' : 'op'}/${encodeURIComponent(opKey(op))}" data-op="${state.ops.indexOf(op)}"${tip}${here}>${method(op.method)}<span class="label-text" lang="en">${esc(op.title)}</span>${trail(op)}</a></li>`;
155
+ }).join(''))).join('');
156
+ }
157
+
158
+ function modelList(query) {
159
+ const all = models();
160
+ if (!all.length) return stateBlock({
161
+ glyph: 'box', compact: true, title: esc(t('side.noModelsTitle')),
162
+ body: th('side.noModelsBody', { source: '<code class="ltr">components.schemas</code>' }),
163
+ });
164
+ const shown = new Set(all.filter(([name, schema]) => `${name} ${schema?.description || ''}`.toLowerCase().includes(query)).map(([name]) => name));
165
+ if (!shown.size) return noMatch(query, all.map(([name]) => name), true);
166
+ return modelGroups(state.doc).map(([key, names], index) => [key, names.filter(name => shown.has(name)), index]).filter(([, names]) => names.length).map(([key, names, index]) =>
167
+ group(`model-group-${index}`, 'models', key, t('models.group.' + key), names.length, !!query || !isCollapsed('models', key), names.map(name => {
168
+ const schema = state.doc.components.schemas[name];
169
+ const kind = modelKind(schema, state.doc);
170
+ const current = state.view === 'model' && state.model === name;
171
+ return `<li><a class="nav-item" href="#model/${encodeURIComponent(name)}" data-pick-model="${esc(name)}" title="${esc(name)}"${current ? ' aria-current="page"' : ''}><span class="model-ico" title="${esc(t('side.kind.' + kind.id))}">${esc(kind.glyph)}<span class="sr-only">${esc(t('side.kind.' + kind.id))}</span></span><span class="label-text" lang="en">${esc(name)}</span><span class="trail num">${formatNumber(modelSize(schema, state.doc))}</span></a></li>`;
172
+ }).join(''), false)).join('');
173
+ }
174
+
175
+ /** The signed-out notice: how many operations need sign-in and the ways to do it. */
176
+ function notice() {
177
+ const locked = state.ops.filter(op => !isPublic(op, state.doc)).length;
178
+ if (signedIn() || !locked) return '';
179
+ const providers = state.cap?.authProviders || [];
180
+ const seeded = providers.some(provider => provider.kind?.toLowerCase() === 'personas' && provider.url);
181
+ const actions = providers.length ? `<div class="an-actions">
182
+ <button type="button" class="btn btn-primary btn-sm" data-action="signin" ${shortcutAttrs('signin')}>${icon('log-in', true)}${esc(t('shell.signIn'))}${shortcutHint('signin')}</button>
183
+ ${seeded ? `<button type="button" class="btn btn-sm" data-action="seeded-menu" aria-haspopup="menu" aria-expanded="false">${esc(t('auth.out.seeded'))}${icon('chevron-down', true)}</button>` : ''}
184
+ </div>` : '';
185
+ return `<section class="auth-notice" aria-labelledby="auth-notice-title">
186
+ <div class="an-title">${icon('lock', true)}<h2 id="auth-notice-title">${esc(t('auth.out.title'))}</h2></div>
187
+ <p>${esc(t('auth.out.body', { n: formatNumber(locked), total: formatNumber(state.ops.length) }))}</p>${actions}
188
+ </section>`;
189
+ }
190
+
191
+ /** The foot bar: counts, and Collapse all / Expand all for the operation groups. */
192
+ function foot() {
193
+ if (tab === 'models') return models().length
194
+ ? `<span class="bar-text">${icon('box', true)}<span>${esc(t('side.footSchemas', { n: models().length }))}</span></span>` : '';
195
+ if (!state.ops.length) return '';
196
+ const everyGroupClosed = groups().every(([name]) => isCollapsed('ops', name));
197
+ return `<span class="bar-text">${icon('list', true)}<span>${esc(t('side.footOps', { n: state.ops.length }))}</span></span>
198
+ <button type="button" class="btn btn-ghost btn-xs" data-action="toggle-groups" title="${esc(t(everyGroupClosed ? 'side.expandAll' : 'side.collapseAll'))}">${icon('chevrons-ud', true)}<span class="lbl">${esc(t(everyGroupClosed ? 'side.expandAll' : 'side.collapseAll'))}</span></button>`;
199
+ }
200
+
201
+ /** Re-renders the tabs' counts, the notice, the filter's end slot, the list and the foot bar. */
202
+ function render() {
203
+ const input = $('#filter');
204
+ const query = (input?.value || '').trim().toLowerCase();
205
+ for (const button of document.querySelectorAll('[data-side-tab]')) {
206
+ const selected = button.dataset.sideTab === tab;
207
+ button.setAttribute('aria-selected', String(selected));
208
+ button.tabIndex = selected ? 0 : -1;
209
+ const badge = button.querySelector('.n');
210
+ const count = button.dataset.sideTab === 'models' ? models().length : state.ops.length;
211
+ if (badge) { badge.textContent = formatNumber(count); badge.classList.remove('unknown'); badge.removeAttribute('aria-hidden'); }
212
+ button.querySelector('.sr-only')?.remove();
213
+ }
214
+ const placeholder = t(tab === 'models' ? 'side.filterModels' : 'side.filterOperations');
215
+ if (input) input.placeholder = placeholder;
216
+ const label = $('[data-filter-label]');
217
+ if (label) label.textContent = placeholder;
218
+ const end = $('[data-filter-end]');
219
+ if (end) end.innerHTML = query
220
+ ? `<button type="button" class="btn btn-ghost btn-icon btn-xs" data-action="clear-filter" aria-label="${esc(t('side.clearFilter'))}">${icon('x', true)}</button>`
221
+ : shortcutHint('filter');
222
+ const noticeSlot = $('[data-auth-notice]');
223
+ if (noticeSlot) { noticeSlot.innerHTML = notice(); noticeSlot.hidden = !noticeSlot.innerHTML; }
224
+ const list = $('.nav');
225
+ list.setAttribute('aria-labelledby', `side-tab-${tab}`);
226
+ const scroll = list.scrollTop;
227
+ list.innerHTML = tab === 'models' ? modelList(query) : operationList(query);
228
+ list.scrollTop = scroll;
229
+ const bar = $('.side-bar');
230
+ bar.innerHTML = query && !list.querySelector('.nav-item') ? '' : foot();
231
+ // A long translation ("40 Operationen" beside "Alle einklappen") keeps the count whole: the
232
+ // toggle gives way to its icon, its name stays in aria-label and the tooltip.
233
+ const count = bar.querySelector('.bar-text > span');
234
+ const toggle = bar.querySelector('[data-action="toggle-groups"]');
235
+ if (count && toggle && count.scrollWidth > count.clientWidth + 1) {
236
+ toggle.classList.add('btn-icon');
237
+ toggle.setAttribute('aria-label', toggle.title);
238
+ toggle.querySelector('.lbl').hidden = true;
239
+ }
240
+ }
241
+
242
+ /** Opens or closes one group from its heading and remembers the choice. */
243
+ function toggleGroup(heading) {
244
+ const list = heading.nextElementSibling;
245
+ const expand = list.hidden;
246
+ remember(heading.dataset.groupKind, heading.dataset.group, !expand);
247
+ list.hidden = !expand;
248
+ heading.setAttribute('aria-expanded', String(expand));
249
+ heading.querySelector('use').setAttribute('href', expand ? '#i-chevron-down' : '#i-chevron-right');
250
+ if (heading.dataset.groupKind === 'ops') render();
251
+ }
252
+
253
+ /** Collapses every operation group, or opens them all when they are all collapsed. */
254
+ function toggleAll() {
255
+ const collapse = !groups().every(([name]) => isCollapsed('ops', name));
256
+ for (const [name] of groups()) remember('ops', name, collapse);
257
+ render();
258
+ $('[data-action="toggle-groups"]')?.focus();
259
+ }
260
+
261
+ /** Switches to the tab that holds a group, opens the group and moves focus to its heading. */
262
+ function reveal(kind, key) {
263
+ const wanted = kind === 'models' ? 'models' : 'operations';
264
+ if (tab !== wanted) tab = wanted;
265
+ const input = $('#filter');
266
+ if (input) input.value = '';
267
+ remember(kind, key, false);
268
+ render();
269
+ const heading = document.querySelector(`[data-group-kind="${kind}"][data-group="${CSS.escape(key)}"]`);
270
+ heading?.focus();
271
+ heading?.scrollIntoView?.({ block: 'nearest' });
272
+ }
273
+
274
+ return {
275
+ render, toggleGroup, toggleAll, reveal,
276
+ get tab() { return tab; },
277
+ /** Picks the tab without drawing (before the shell exists). */
278
+ setTab(next) { tab = next; },
279
+ selectTab(next, { focusFilter = false } = {}) {
280
+ if (next !== tab) {
281
+ tab = next;
282
+ const input = $('#filter');
283
+ if (input) input.value = '';
284
+ }
285
+ render();
286
+ if (focusFilter) $('#filter')?.focus();
287
+ },
288
+ };
289
+ }