notes

5.7 KB

1. // project.hl — notes.worldapi.org: THE MAP. Config, routes and WHO HEARS WHAT. Hybriel on hl:web.
2. // Notes with an ident login (ticket notes#1): a sidebar of the user's notes (subject = first line, last edited
3. // first) and the selected note on the right, edited with <md-editor> (shared/md-editor.js, vendored from
4. // worldapi-components). Saved on the server in storage/mpackdb/; kept offline in the browser (ticket notes#2).
5. //
6. // WHERE WHAT IS (README "Files"):
7. // notes, their sync rules, every write to notes.db lib/notes.hl (+ lib/notes-helpers.hl)
8. // users, the ident exchange, both logins' user step lib/users.hl
9. // /login/callback, /api/me, /api/notes lib/api.hl (+ lib/api-helpers.hl, lib/jsoncheck.hl)
10. // env, table folder, lists, id checks lib/util.hl
11. // the page shell, login/logout faces components/main.hl
12. // the notes page, /login/failed, all CSS components/notes.hl, loginfailed.hl, styles.hl
13. // the notes area in the browser, offline copy notes-offline.js, sw.js (login.js = ident selector bridge)
14. import WebFramework from 'hl:web'
15. import { env } from 'hl:proc'
17. import Styles from './components/styles.hl'
18. import { tagOf } from './lib/users.hl'
19. import { loginCallback, apiMe, apiNotes } from './lib/api.hl'
20. import { dark, darker } from './shared/tokens.hl'
22. import Notes from './components/notes.hl'
23. import LoginFailed from './components/loginfailed.hl'
25. static siteName = "notes"
27. appTitle = siteName
29. // ---- THE INSTALLABLE APP (mission 046), as calendar.worldapi.org / tracker do it: hl:web's own web app manifest
30. // (/__hl/manifest.webmanifest, linked from every head with the apple-touch-icon and theme-color) from these settings.
31. // Icons in icons/ (icon.svg is the source, the PNGs are rendered from it with rsvg-convert, README "PWA"). The theme
32. // colour is the header's background (darker), the splash background the page's (dark) — both off the tokens.
33. // NO `offline = [...]` here ON PURPOSE: that would make hl:web register its own service worker (/__hl/sw.js, scope /)
34. // over notes' own /sw.js (notes-offline.js registers it, same scope) — one would replace the other. Notes keeps its
35. // own offline copy (sw.js + IndexedDB, ticket notes#2) until notes#4 moves it to Hybriel.
36. appThemeColor = darker.value
37. appBackgroundColor = dark.value
38. appIcons = [
39. { src = '/icons/icon-192.png' sizes = '192x192' purpose = 'any' }
40. { src = '/icons/icon-512.png' sizes = '512x512' purpose = 'any' }
41. { src = '/icons/icon-192.png' sizes = '192x192' purpose = 'maskable' }
42. { src = '/icons/icon-512.png' sizes = '512x512' purpose = 'maskable' }
43. ]
44. appTouchIcon = '/icons/apple-touch-icon.png'
45. appFavicon = '/icons/favicon.svg'
46. styles = Styles
48. routes = [
49. { pattern = "/favicon.ico" file = "./icons/favicon.ico" headers = { 'Cache-Control' = 'no-cache' } }
50. // the installable app (mission 046): the icons (the manifest is hl:web's own, from appIcons)
51. { pattern = "/icons/icon-192.png" file = "./icons/icon-192.png" headers = { 'Cache-Control' = 'no-cache' } }
52. { pattern = "/icons/icon-512.png" file = "./icons/icon-512.png" headers = { 'Cache-Control' = 'no-cache' } }
53. { pattern = "/icons/apple-touch-icon.png" file = "./icons/apple-touch-icon.png" headers = { 'Cache-Control' = 'no-cache' } }
54. { pattern = "/icons/favicon.svg" file = "./icons/favicon.svg" headers = { 'Cache-Control' = 'no-cache' } }
55. // the login button's return writes the session: the request and the store go BY REFERENCE (lib/api.hl)
56. { pattern = "/login/callback" function = (route, req) => { return loginCallback(route, &req, &server.sessions) } }
57. { pattern = "/login/failed" component = LoginFailed }
58. { pattern = "/login.js" file = "./login.js" headers = { 'Cache-Control' = 'no-cache' } }
59. // the Markdown editor <md-editor>, vendored from worldapi-components (one <script> in the shell would do too:
60. // it is loaded by the page component's parent, see components/main.hl)
61. { pattern = "/md-editor.js" file = "./shared/md-editor.js" headers = { 'Cache-Control' = 'no-cache' } }
62. // the sync API (ticket notes#2, lib/api.hl)
63. { pattern = "/api/me" function = apiMe }
64. { pattern = "/api/notes" function = apiNotes }
65. // the offline copy: the service worker (network first, the cached page when there is none) and the client that
66. // keeps the notes in IndexedDB and syncs them
67. { pattern = "/sw.js" file = "./sw.js" headers = { 'Cache-Control' = 'no-cache' } }
68. { pattern = "/notes-offline.js" file = "./notes-offline.js" headers = { 'Cache-Control' = 'no-cache' } }
69. { pattern = "/" component = Notes }
70. { pattern = "/note/:id" component = Notes }
71. ]
73. // WHO GETS THE PUSH: the login state reaches the tabs of one session. (Notes are not pushed: the browser's own copy
74. // pulls through /api/notes.)
75. // `notesSignedIn` / `notesSignedOut` go to the tabs of ONE session: the one whose login carries that random tag.
76. audience = {
77. notesSignedIn = (tag, session) => { return tag != null && tagOf(session) == tag }
78. notesSignedOut = (tag, session) => { return tag != null && tagOf(session) == tag }
79. }
81. sessionDir = env('NOTES_SESSIONS') != null ? env('NOTES_SESSIONS') : null
82. port = env('NOTES_PORT') != null ? toNumber(env('NOTES_PORT')) : 8710
83. // HL_HOST = the interface hl:web binds: 127.0.0.1 on Byrodin behind nginx; unset = 0.0.0.0 (dev on Loreana).
84. // NOTES_WATCH=0 = no dev watcher. The session cookie is `notessid` (hybriel #10). A note taker is not logged
85. // out after 15 minutes of thinking: the session idles out after the 14 days of sessionMaxAge.
86. watching = env('NOTES_WATCH') != '0'
87. sessionCookie = 'notessid'
88. sessionIdle = 1209600
89. server = new WebFramework(routes = routes, styles = styles, minify = true, port = port, watchMode = watching, sessionCookie = sessionCookie)
91. on Error(e) { console.log('error absorbed: ' + e.message) }