@open-pencil/cloud 0.17.0-beta.4 → 0.17.0-beta.6

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 (280) hide show
  1. package/README.md +2 -1
  2. package/dist/bin/server.mjs +1 -1
  3. package/dist/bin/server.mjs.map +1 -1
  4. package/dist/bin/services.mjs +1 -1
  5. package/dist/bin/services.mjs.map +1 -1
  6. package/dist/client.d.ts +783 -47
  7. package/dist/client.d.ts.map +1 -1
  8. package/dist/client.js +1651 -382
  9. package/dist/client.js.map +1 -1
  10. package/dist/contract.d.ts +2 -2
  11. package/dist/contract.js +2 -2
  12. package/dist/contract2.js +701 -45
  13. package/dist/contract2.js.map +1 -1
  14. package/dist/email.d.ts +2138 -34
  15. package/dist/email.d.ts.map +1 -1
  16. package/dist/email.js +4343 -306
  17. package/dist/email.js.map +1 -1
  18. package/dist/errors.d.ts +2 -0
  19. package/dist/errors.js +61 -0
  20. package/dist/errors.js.map +1 -0
  21. package/dist/index.d.ts +1338 -44
  22. package/dist/index.d.ts.map +1 -1
  23. package/dist/index2.d.ts +45 -0
  24. package/dist/index2.d.ts.map +1 -0
  25. package/dist/listen.mjs +958 -340
  26. package/dist/listen.mjs.map +1 -1
  27. package/dist/runtime-cloudflare.d.ts +93 -0
  28. package/dist/runtime-cloudflare.d.ts.map +1 -0
  29. package/dist/runtime-cloudflare.js +18032 -0
  30. package/dist/runtime-cloudflare.js.map +1 -0
  31. package/dist/runtime-node.d.mts +12615 -5249
  32. package/dist/runtime-node.d.mts.map +1 -1
  33. package/dist/server.d.ts +17367 -8567
  34. package/dist/server.d.ts.map +1 -1
  35. package/dist/server.js +13587 -7333
  36. package/dist/server.js.map +1 -1
  37. package/dist/server.mjs +11601 -5401
  38. package/dist/server.mjs.map +1 -1
  39. package/dist/server2.mjs +84 -62
  40. package/dist/server2.mjs.map +1 -1
  41. package/package.json +31 -5
  42. package/src/admin/api/routes.ts +263 -190
  43. package/src/admin/audit/service.ts +11 -3
  44. package/src/admin/bootstrap.ts +86 -0
  45. package/src/admin/documents/service.ts +195 -10
  46. package/src/admin/email/service.ts +2 -1
  47. package/src/admin/enrollment/email.ts +17 -3
  48. package/src/admin/enrollment/service.ts +71 -10
  49. package/src/admin/errors.ts +5 -0
  50. package/src/admin/index.ts +1 -0
  51. package/src/admin/reports/service.ts +15 -3
  52. package/src/admin/schema.ts +6 -5
  53. package/src/admin/users/service.ts +173 -16
  54. package/src/client/api.ts +52 -473
  55. package/src/client/auth/client.ts +22 -3
  56. package/src/client/comments.ts +205 -0
  57. package/src/client/community.ts +40 -0
  58. package/src/client/device-authorization.ts +4 -20
  59. package/src/client/discovery.ts +39 -11
  60. package/src/client/documents.ts +160 -0
  61. package/src/client/files/archive.ts +60 -0
  62. package/src/client/files/checksum.ts +7 -0
  63. package/src/client/files/download.ts +122 -0
  64. package/src/client/files/images.ts +89 -0
  65. package/src/client/files/index.ts +15 -0
  66. package/src/client/files/objects.ts +173 -0
  67. package/src/client/files/save.ts +79 -0
  68. package/src/client/index.ts +4 -0
  69. package/src/client/portal/account.ts +73 -3
  70. package/src/client/portal/administration.ts +52 -5
  71. package/src/client/portal/request.ts +6 -2
  72. package/src/client/response.ts +21 -0
  73. package/src/client/schema.ts +8 -0
  74. package/src/client/services.ts +23 -18
  75. package/src/client/sharing.ts +262 -0
  76. package/src/client/tour.ts +44 -0
  77. package/src/client/versions.ts +110 -0
  78. package/src/contract/account.ts +111 -11
  79. package/src/contract/admin/index.ts +48 -3
  80. package/src/contract/billing.ts +235 -0
  81. package/src/contract/collaboration.ts +5 -0
  82. package/src/contract/comments.ts +223 -0
  83. package/src/contract/community.ts +60 -0
  84. package/src/contract/discovery.ts +94 -5
  85. package/src/contract/entitlements.ts +10 -0
  86. package/src/contract/index.ts +64 -5
  87. package/src/contract/links.ts +62 -4
  88. package/src/contract/locale.ts +27 -0
  89. package/src/contract/portal.ts +12 -1
  90. package/src/contract/relay.ts +3 -1
  91. package/src/contract/routes.ts +10 -0
  92. package/src/contract/services.ts +62 -20
  93. package/src/contract/workspaces.ts +5 -0
  94. package/src/email/i18n.ts +174 -0
  95. package/src/email/index.ts +13 -2
  96. package/src/email/locales/ar.json +169 -0
  97. package/src/email/locales/de.json +169 -0
  98. package/src/email/locales/es.json +169 -0
  99. package/src/email/locales/fr.json +169 -0
  100. package/src/email/locales/it.json +169 -0
  101. package/src/email/locales/ja.json +169 -0
  102. package/src/email/locales/pl.json +169 -0
  103. package/src/email/locales/pt-br.json +169 -0
  104. package/src/email/locales/ru.json +169 -0
  105. package/src/email/locales/zh-cn.json +169 -0
  106. package/src/email/messages.ts +235 -0
  107. package/src/email/render.ts +160 -276
  108. package/src/email/samples.ts +142 -0
  109. package/src/email/schema.ts +98 -8
  110. package/src/email/templates/BrandEmail.vue +56 -0
  111. package/src/email/templates/CommentNotification.vue +39 -0
  112. package/src/email/templates/DocumentBlocked.vue +45 -0
  113. package/src/email/templates/DocumentInvitation.vue +24 -0
  114. package/src/email/templates/DocumentReport.vue +32 -0
  115. package/src/email/templates/DocumentReportDecided.vue +36 -0
  116. package/src/email/templates/DocumentReportReceived.vue +18 -0
  117. package/src/email/templates/DocumentRestored.vue +24 -0
  118. package/src/email/templates/EmailChangeRequested.vue +24 -0
  119. package/src/email/templates/EmailRoot.vue +19 -0
  120. package/src/email/templates/EmailText.vue +9 -0
  121. package/src/email/templates/EmailVerification.vue +38 -0
  122. package/src/email/templates/EnrollmentInvitation.vue +53 -0
  123. package/src/email/templates/EnrollmentNotification.vue +24 -0
  124. package/src/email/templates/EnrollmentUpdate.vue +52 -0
  125. package/src/email/templates/NewSignIn.vue +37 -0
  126. package/src/email/templates/PasswordChanged.vue +22 -0
  127. package/src/email/templates/PasswordReset.vue +23 -0
  128. package/src/email/templates/StorageLimitReached.vue +28 -0
  129. package/src/email/templates/TwoStepChanged.vue +47 -0
  130. package/src/email/templates/WaitlistConfirmation.vue +29 -0
  131. package/src/email/templates/WorkspaceInvitation.vue +28 -0
  132. package/src/email/templates/brand.ts +15 -61
  133. package/src/email/templates/localization.ts +17 -0
  134. package/src/errors/index.ts +6 -0
  135. package/src/{server/errors → errors}/posthog.ts +28 -4
  136. package/src/global.d.ts +7 -0
  137. package/src/runtime/cloudflare/email.ts +2 -0
  138. package/src/runtime/cloudflare/relay/index.ts +28 -7
  139. package/src/runtime/cloudflare/tsconfig.json +2 -1
  140. package/src/runtime/cloudflare/worker.ts +14 -1
  141. package/src/runtime/cloudflare/xml.ts +12 -0
  142. package/src/runtime/node/admin.ts +51 -47
  143. package/src/runtime/node/cleanup.ts +5 -1
  144. package/src/runtime/node/email/runtime.ts +1 -0
  145. package/src/runtime/node/email/transport.ts +14 -10
  146. package/src/runtime/node/main.ts +1 -1
  147. package/src/runtime/node/server.ts +20 -4
  148. package/src/runtime/node/services/main.ts +1 -1
  149. package/src/runtime/posthog/errors.ts +5 -2
  150. package/src/runtime/s3/objects.ts +17 -0
  151. package/src/runtime/site/community.ts +101 -0
  152. package/src/runtime/site/server.ts +17 -1
  153. package/src/server/account/actions.ts +3 -1
  154. package/src/server/account/deletion.ts +40 -4
  155. package/src/server/account/routes.ts +305 -253
  156. package/src/server/account/tokens.ts +57 -0
  157. package/src/server/api/router.ts +44 -6
  158. package/src/server/app/checks.ts +89 -0
  159. package/src/server/app/cors.ts +44 -0
  160. package/src/server/app/editors.ts +20 -0
  161. package/src/server/app/index.ts +128 -0
  162. package/src/server/app/indexing.ts +40 -0
  163. package/src/server/app/limiters.ts +53 -0
  164. package/src/server/app/routes.ts +123 -0
  165. package/src/server/app/services.ts +219 -0
  166. package/src/server/auth/access-control.ts +13 -8
  167. package/src/server/auth/access-tokens.ts +62 -0
  168. package/src/server/auth/account.ts +13 -12
  169. package/src/server/auth/activity.ts +7 -2
  170. package/src/server/auth/adapter.ts +36 -3
  171. package/src/server/auth/email.ts +33 -18
  172. package/src/server/auth/endpoints.ts +4 -0
  173. package/src/server/auth/enrollment.ts +116 -0
  174. package/src/server/auth/factory.ts +165 -189
  175. package/src/server/auth/index.ts +1 -1
  176. package/src/server/auth/logger.ts +23 -0
  177. package/src/server/auth/methods.ts +162 -0
  178. package/src/server/auth/mfa-assurance.ts +190 -2
  179. package/src/server/auth/passwords.ts +43 -0
  180. package/src/server/auth/rate-limit.ts +31 -0
  181. package/src/server/auth/runtime.ts +19 -5
  182. package/src/server/auth/session.ts +2 -0
  183. package/src/server/auth/social-providers.ts +70 -24
  184. package/src/server/billing/index.ts +8 -0
  185. package/src/server/billing/notify.ts +55 -0
  186. package/src/server/billing/routes.ts +27 -0
  187. package/src/server/billing/seats.ts +17 -0
  188. package/src/server/billing/tokens.ts +37 -0
  189. package/src/server/cleanup/configured.ts +16 -3
  190. package/src/server/cleanup/documents.ts +5 -2
  191. package/src/server/cleanup/revisions.ts +6 -3
  192. package/src/server/cleanup/uploads.ts +2 -1
  193. package/src/server/cleanup/worker.ts +10 -1
  194. package/src/server/collaboration/relay/connection.ts +7 -2
  195. package/src/server/collaboration/relay/hub.ts +80 -166
  196. package/src/server/collaboration/relay/room.ts +154 -0
  197. package/src/server/collaboration/routes.ts +8 -5
  198. package/src/server/collaboration/service.ts +21 -2
  199. package/src/server/comments/index.ts +9 -0
  200. package/src/server/comments/notify.ts +277 -0
  201. package/src/server/comments/routes.ts +352 -0
  202. package/src/server/comments/rows.ts +249 -0
  203. package/src/server/comments/service.ts +570 -0
  204. package/src/server/community/index.ts +2 -0
  205. package/src/server/community/routes.ts +93 -0
  206. package/src/server/community/service.ts +134 -0
  207. package/src/server/config/deployment.ts +35 -10
  208. package/src/server/config/index.ts +2 -2
  209. package/src/server/config/public.ts +25 -6
  210. package/src/server/config/schema.ts +53 -293
  211. package/src/server/config/toml/schema.ts +330 -0
  212. package/src/server/db/index.ts +3 -1
  213. package/src/server/db/migrate.ts +33 -1
  214. package/src/server/db/migrations/009_access_tokens.ts +47 -0
  215. package/src/server/db/migrations/010_storage_limit_notices.ts +50 -0
  216. package/src/server/db/migrations/011_account_ids.ts +30 -0
  217. package/src/server/db/migrations/012_email_locales.ts +34 -0
  218. package/src/server/db/migrations/013_document_block_emails.ts +40 -0
  219. package/src/server/db/migrations/014_report_replies.ts +28 -0
  220. package/src/server/db/migrations/015_comments.ts +57 -0
  221. package/src/server/db/migrations/016_comment_notifications.ts +76 -0
  222. package/src/server/db/migrations/017_invitation_emails.ts +19 -0
  223. package/src/server/db/migrations/018_enrollment_source.ts +17 -0
  224. package/src/server/db/migrations/schema.ts +26 -1
  225. package/src/server/db/tables.ts +122 -3
  226. package/src/server/db/users.ts +22 -0
  227. package/src/server/documents/access.ts +17 -0
  228. package/src/server/documents/images.ts +6 -1
  229. package/src/server/documents/index.ts +1 -1
  230. package/src/server/documents/limits.ts +7 -1
  231. package/src/server/documents/routes.ts +12 -12
  232. package/src/server/documents/service.ts +31 -407
  233. package/src/server/documents/summary.ts +15 -0
  234. package/src/server/documents/uploads.ts +450 -0
  235. package/src/server/documents/versions/routes.ts +7 -8
  236. package/src/server/documents/versions/service.ts +86 -26
  237. package/src/server/email/invitations.ts +1 -0
  238. package/src/server/email/service.ts +39 -6
  239. package/src/server/email/types.ts +13 -0
  240. package/src/server/errors/index.ts +49 -12
  241. package/src/server/index.ts +27 -6
  242. package/src/server/internal/routes.ts +8 -2
  243. package/src/server/internal/service.ts +10 -0
  244. package/src/server/invitations/budget.ts +3 -1
  245. package/src/server/invitations/index.ts +1 -0
  246. package/src/server/invitations/links.ts +6 -0
  247. package/src/server/invitations/types.ts +5 -1
  248. package/src/server/objects/types.ts +5 -0
  249. package/src/server/pictures/service.ts +3 -1
  250. package/src/server/policy/configured.ts +9 -3
  251. package/src/server/policy/database.ts +13 -2
  252. package/src/server/policy/policy.ts +39 -12
  253. package/src/server/policy/service.ts +71 -52
  254. package/src/server/policy/storage.ts +33 -0
  255. package/src/server/policy/workspace.ts +5 -2
  256. package/src/server/quota/index.ts +6 -0
  257. package/src/server/quota/notices.ts +121 -0
  258. package/src/server/quota/storage.ts +5 -0
  259. package/src/server/rate-limit/middleware.ts +4 -0
  260. package/src/server/reports/index.ts +1 -0
  261. package/src/server/reports/replies.ts +55 -0
  262. package/src/server/reports/routes.ts +5 -3
  263. package/src/server/reports/service.ts +27 -3
  264. package/src/server/services/routes.ts +2 -2
  265. package/src/server/sharing/capabilities/service.ts +3 -4
  266. package/src/server/sharing/document-routes.ts +3 -3
  267. package/src/server/sharing/invitations/service.ts +17 -8
  268. package/src/server/sharing/routes.ts +15 -15
  269. package/src/server/validation.ts +35 -24
  270. package/src/server/workspaces/members.ts +57 -31
  271. package/src/server/workspaces/repository.ts +23 -12
  272. package/src/server/workspaces/routes.ts +8 -8
  273. package/src/services/app.ts +31 -22
  274. package/src/services/config.ts +48 -8
  275. package/src/services/metering.ts +15 -27
  276. package/src/services/usage.ts +6 -14
  277. package/src/email/templates/document-invitation.ts +0 -35
  278. package/src/email/templates/enrollment.ts +0 -27
  279. package/src/email/templates/layout.ts +0 -18
  280. package/src/server/app.ts +0 -453
@@ -0,0 +1,277 @@
1
+ import { cloudCommentURL, type CommentEmailSetting, type CommentPerson } from '#cloud/contract'
2
+ import { userIdText, type CloudDatabase } from '#cloud/server/db'
3
+ import { lockForTransaction } from '#cloud/server/db/expressions'
4
+ import { resolveDocumentCommentAccess } from '#cloud/server/documents/access'
5
+ import type { TransactionalEmailService } from '#cloud/server/email'
6
+ import { uniq } from 'es-toolkit'
7
+ import type { Kysely, Transaction } from 'kysely'
8
+ import { fromMarkdown } from 'mdast-util-from-markdown'
9
+ import { toString } from 'mdast-util-to-string'
10
+
11
+ import { DAY_MS } from '@open-pencil/std/timing'
12
+
13
+ /**
14
+ * How many comment emails one person's comments may send in a day, and how many one account may
15
+ * receive. A comment's words are the author's, so without a budget mentions are a way to send spam.
16
+ */
17
+ export const COMMENT_EMAIL_BUDGET = {
18
+ windowMs: DAY_MS,
19
+ perSender: 200,
20
+ perRecipient: 50
21
+ } as const
22
+
23
+ /** What an account hears about when it chose nothing: comments that name it. */
24
+ export const DEFAULT_COMMENT_EMAILS: CommentEmailSetting = 'mentions'
25
+
26
+ const EXCERPT_LENGTH = 280
27
+
28
+ /**
29
+ * The start of what a comment says, as plain text on one line: its Markdown read, so a mention
30
+ * reads as `@Ana`, a link as its text, and each block apart from the next.
31
+ */
32
+ export function commentExcerpt(body: string): string {
33
+ const line = fromMarkdown(body)
34
+ .children.map((block) => toString(block))
35
+ .join(' ')
36
+ .replace(/\s+/g, ' ')
37
+ .trim()
38
+ return line.length > EXCERPT_LENGTH ? `${line.slice(0, EXCERPT_LENGTH - 1).trimEnd()}…` : line
39
+ }
40
+
41
+ type Source = Kysely<CloudDatabase> | Transaction<CloudDatabase>
42
+
43
+ /**
44
+ * Everyone a document's comments may name: its workspace's members, the people it was shared with
45
+ * directly, and its maker while they are in the workspace. Names only, never addresses.
46
+ */
47
+ export async function commentPeople(source: Source, documentId: string): Promise<CommentPerson[]> {
48
+ const document = await source
49
+ .selectFrom('document')
50
+ .select(['workspaceId'])
51
+ .where('id', '=', documentId)
52
+ .executeTakeFirst()
53
+ if (!document) return []
54
+ const members = source
55
+ .selectFrom('workspaceMember')
56
+ .select('workspaceMember.userId as userId')
57
+ .where('workspaceMember.workspaceId', '=', document.workspaceId)
58
+ const grantees = source
59
+ .selectFrom('documentGrant')
60
+ .select('documentGrant.userId as userId')
61
+ .where('documentGrant.documentId', '=', documentId)
62
+ .where('documentGrant.revokedAt', 'is', null)
63
+ const ids = uniq(
64
+ [...(await members.execute()), ...(await grantees.execute())].map((row) => row.userId)
65
+ )
66
+ if (ids.length === 0) return []
67
+ const rows = await source
68
+ .selectFrom('user')
69
+ .select((expression) => [userIdText(expression).as('id'), 'user.name', 'user.image'])
70
+ .where(userIdText, 'in', ids)
71
+ .orderBy('user.name')
72
+ .execute()
73
+ return rows.map((row) => ({ id: row.id, name: row.name, image: row.image ?? null }))
74
+ }
75
+
76
+ /** The accounts of `ids` a comment by `authorId` may name: others who can read the document. */
77
+ async function readers(
78
+ transaction: Transaction<CloudDatabase>,
79
+ documentId: string,
80
+ ids: readonly string[],
81
+ authorId: string
82
+ ): Promise<string[]> {
83
+ const kept: string[] = []
84
+ for (const id of uniq(ids)) {
85
+ if (id === authorId) continue
86
+ if (await resolveDocumentCommentAccess(transaction, id, documentId)) kept.push(id)
87
+ }
88
+ return kept
89
+ }
90
+
91
+ /**
92
+ * Records whom a comment names, among those who may read it, and answers who is named now that
93
+ * was not before, so an edit tells only the people it adds.
94
+ */
95
+ export async function recordMentions(
96
+ transaction: Transaction<CloudDatabase>,
97
+ input: { documentId: string; commentId: string; authorId: string; mentions: readonly string[] }
98
+ ): Promise<string[]> {
99
+ const named = await readers(transaction, input.documentId, input.mentions, input.authorId)
100
+ if (named.length === 0) return []
101
+ const added = await transaction
102
+ .insertInto('commentMention')
103
+ .values(named.map((userId) => ({ commentId: input.commentId, userId })))
104
+ .onConflict((conflict) => conflict.columns(['commentId', 'userId']).doNothing())
105
+ .returning('userId')
106
+ .execute()
107
+ return added.map((row) => row.userId)
108
+ }
109
+
110
+ /** Counts an email against both daily budgets, or answers false once either is used. */
111
+ async function spendCommentEmail(
112
+ transaction: Transaction<CloudDatabase>,
113
+ senderId: string,
114
+ recipientId: string,
115
+ now: Date
116
+ ): Promise<boolean> {
117
+ // Always sender first, then recipient, so two transactions never wait on each other in turn.
118
+ await lockForTransaction(transaction, `comment-email-sender:${senderId}`)
119
+ await lockForTransaction(transaction, `comment-email-recipient:${recipientId}`)
120
+ const since = new Date(now.getTime() - COMMENT_EMAIL_BUDGET.windowMs)
121
+ // Both budgets in one read: what the sender's comments sent, and what the recipient received.
122
+ const spent = await transaction
123
+ .selectFrom('commentEmail')
124
+ .select((expression) => [
125
+ expression.fn.countAll<string>().filterWhere('senderId', '=', senderId).as('sent'),
126
+ expression.fn.countAll<string>().filterWhere('recipientId', '=', recipientId).as('received')
127
+ ])
128
+ .where('sentAt', '>', since)
129
+ .where((expression) =>
130
+ expression.or([
131
+ expression('senderId', '=', senderId),
132
+ expression('recipientId', '=', recipientId)
133
+ ])
134
+ )
135
+ .executeTakeFirstOrThrow()
136
+ if (
137
+ Number(spent.sent) >= COMMENT_EMAIL_BUDGET.perSender ||
138
+ Number(spent.received) >= COMMENT_EMAIL_BUDGET.perRecipient
139
+ ) {
140
+ return false
141
+ }
142
+ await transaction
143
+ .insertInto('commentEmail')
144
+ .values({ id: crypto.randomUUID(), senderId, recipientId, sentAt: now })
145
+ .execute()
146
+ return true
147
+ }
148
+
149
+ /** Who else wrote in a thread and may still read it: whom a reply tells, as they chose. */
150
+ export async function threadParticipants(
151
+ transaction: Transaction<CloudDatabase>,
152
+ documentId: string,
153
+ threadId: string,
154
+ authorId: string
155
+ ): Promise<string[]> {
156
+ const rows = await transaction
157
+ .selectFrom('comment')
158
+ .select('authorId')
159
+ .where('threadId', '=', threadId)
160
+ .where('authorId', 'is not', null)
161
+ .execute()
162
+ return readers(
163
+ transaction,
164
+ documentId,
165
+ rows.flatMap((row) => (row.authorId ? [row.authorId] : [])),
166
+ authorId
167
+ )
168
+ }
169
+
170
+ export type CommentNotifier = {
171
+ email: TransactionalEmailService
172
+ publicURL: string
173
+ }
174
+
175
+ /**
176
+ * Emails the people a new comment concerns, in the transaction that writes it: those it names,
177
+ * and, for a reply, the thread's other writers who asked to hear about every comment. Each hears
178
+ * once, as their setting allows and while the day's budgets last.
179
+ */
180
+ export async function notifyComment(
181
+ transaction: Transaction<CloudDatabase>,
182
+ notifier: CommentNotifier,
183
+ comment: {
184
+ id: string
185
+ documentId: string
186
+ threadId: string
187
+ authorId: string
188
+ body: string
189
+ mentioned: readonly string[]
190
+ participants: readonly string[]
191
+ }
192
+ ): Promise<void> {
193
+ // In account order, so two comments naming the same people take their budget locks in turn.
194
+ const recipients = [
195
+ ...comment.mentioned.map((userId) => ({ userId, reason: 'mention' as const })),
196
+ ...comment.participants
197
+ .filter((userId) => !comment.mentioned.includes(userId))
198
+ .map((userId) => ({ userId, reason: 'reply' as const }))
199
+ ].toSorted((a, b) => a.userId.localeCompare(b.userId))
200
+ if (recipients.length === 0) return
201
+ const ids = recipients.map((recipient) => recipient.userId)
202
+ const author = comment.authorId
203
+ const [users, settings, document] = await Promise.all([
204
+ transaction
205
+ .selectFrom('user')
206
+ .select((expression) => [userIdText(expression).as('id'), 'user.name', 'user.email'])
207
+ .where(userIdText, 'in', [...ids, comment.authorId])
208
+ .execute(),
209
+ transaction
210
+ .selectFrom('notificationSetting')
211
+ .select(['userId', 'commentEmails'])
212
+ .where('userId', 'in', ids)
213
+ .execute(),
214
+ transaction
215
+ .selectFrom('document')
216
+ .select('name')
217
+ .where('id', '=', comment.documentId)
218
+ .executeTakeFirstOrThrow()
219
+ ])
220
+ const byId = new Map(users.map((user) => [user.id, user]))
221
+ const chosen = new Map(settings.map((setting) => [setting.userId, setting.commentEmails]))
222
+ const now = new Date()
223
+ for (const recipient of recipients) {
224
+ const user = byId.get(recipient.userId)
225
+ const setting = chosen.get(recipient.userId) ?? DEFAULT_COMMENT_EMAILS
226
+ const wanted = setting === 'all' || (setting === 'mentions' && recipient.reason === 'mention')
227
+ if (!user || !wanted) continue
228
+ if (!(await spendCommentEmail(transaction, author, recipient.userId, now))) continue
229
+ await notifier.email.enqueue(
230
+ {
231
+ idempotencyKey: `comment-notification/${comment.id}/${recipient.userId}`,
232
+ kind: 'comment-notification',
233
+ recipientEmail: user.email,
234
+ payload: {
235
+ name: user.name || null,
236
+ authorName: byId.get(author)?.name || null,
237
+ documentName: document.name,
238
+ reason: recipient.reason,
239
+ excerpt: commentExcerpt(comment.body),
240
+ actionURL: cloudCommentURL(notifier.publicURL, comment.documentId, comment.threadId),
241
+ settingsURL: new URL('/account/notifications', notifier.publicURL).href
242
+ }
243
+ },
244
+ transaction
245
+ )
246
+ }
247
+ }
248
+
249
+ /** Which comments an account hears about by email. */
250
+ export async function readNotificationSettings(
251
+ database: Kysely<CloudDatabase>,
252
+ userId: string
253
+ ): Promise<{ commentEmails: CommentEmailSetting }> {
254
+ const row = await database
255
+ .selectFrom('notificationSetting')
256
+ .select('commentEmails')
257
+ .where('userId', '=', userId)
258
+ .executeTakeFirst()
259
+ return { commentEmails: row?.commentEmails ?? DEFAULT_COMMENT_EMAILS }
260
+ }
261
+
262
+ export async function writeNotificationSettings(
263
+ database: Kysely<CloudDatabase>,
264
+ userId: string,
265
+ settings: { commentEmails: CommentEmailSetting }
266
+ ): Promise<{ commentEmails: CommentEmailSetting }> {
267
+ await database
268
+ .insertInto('notificationSetting')
269
+ .values({ userId, commentEmails: settings.commentEmails, updatedAt: new Date() })
270
+ .onConflict((conflict) =>
271
+ conflict
272
+ .column('userId')
273
+ .doUpdateSet({ commentEmails: settings.commentEmails, updatedAt: new Date() })
274
+ )
275
+ .execute()
276
+ return settings
277
+ }
@@ -0,0 +1,352 @@
1
+ import {
2
+ createCommentSchema,
3
+ createCommentThreadSchema,
4
+ importCommentThreadsSchema,
5
+ notificationSettingsSchema,
6
+ sharedCommentsRequestSchema,
7
+ sharedCreateCommentSchema,
8
+ sharedCreateCommentThreadSchema,
9
+ sharedUpdateCommentSchema,
10
+ sharedUpdateCommentThreadSchema,
11
+ updateCommentSchema,
12
+ updateCommentThreadSchema,
13
+ type SharedCommentsRequest
14
+ } from '#cloud/contract'
15
+ import type { CloudSessionResolver } from '#cloud/server/auth'
16
+ import { documentDomainError, type DocumentRouteEnvironment } from '#cloud/server/documents'
17
+ import { shareActor } from '#cloud/server/sharing/actor'
18
+ import { sharingDomainError } from '#cloud/server/sharing/http'
19
+ import {
20
+ documentCommentParams,
21
+ documentParams,
22
+ documentThreadParams,
23
+ shareCommentParams,
24
+ shareParams,
25
+ shareThreadParams,
26
+ validatedJSON
27
+ } from '#cloud/server/validation'
28
+ import { omit } from 'es-toolkit'
29
+ import { Hono, type Context } from 'hono'
30
+ import type { BlankEnv } from 'hono/types'
31
+ import type * as v from 'valibot'
32
+
33
+ import {
34
+ CommentConflictError,
35
+ CommentLimitError,
36
+ type CommentActor,
37
+ type CommentService
38
+ } from './service'
39
+
40
+ function commentDomainError(context: Context, error: unknown): Response | null {
41
+ if (error instanceof CommentLimitError) {
42
+ return context.json({ error: { code: 'comment_limit_reached' as const } }, 409)
43
+ }
44
+ if (error instanceof CommentConflictError) {
45
+ return context.json({ error: { code: 'comment_conflict' as const } }, 409)
46
+ }
47
+ return null
48
+ }
49
+
50
+ async function answer(
51
+ context: Context,
52
+ run: () => Promise<Response>,
53
+ domainError: (context: Context, error: unknown) => Response | null
54
+ ): Promise<Response> {
55
+ try {
56
+ return await run()
57
+ } catch (error) {
58
+ const response = commentDomainError(context, error) ?? domainError(context, error)
59
+ if (response) return response
60
+ throw error
61
+ }
62
+ }
63
+
64
+ /** Answers a thread, or no content when deleting its comment deleted the thread. */
65
+ function threadOrGone(context: Context, thread: Awaited<ReturnType<CommentService['get']>> | null) {
66
+ return thread ? context.json({ thread }) : context.body(null, 204)
67
+ }
68
+
69
+ /** A route's context once its share, thread, and request body, read by `Schema`, are validated. */
70
+ type SharedThreadContext<Schema extends v.GenericSchema> = Context<
71
+ BlankEnv,
72
+ string,
73
+ {
74
+ in: { param: { shareId: string; threadId: string }; json: v.InferInput<Schema> }
75
+ out: { param: { shareId: string; threadId: string }; json: v.InferOutput<Schema> }
76
+ }
77
+ >
78
+
79
+ /** A document's comments for its members and the people it is shared with directly. */
80
+ export function createCommentRoutes(service: CommentService) {
81
+ const as = (context: Context<DocumentRouteEnvironment>, documentId: string) =>
82
+ service.forMember(context.get('actor').userId, documentId)
83
+ const run = (context: Context<DocumentRouteEnvironment>, respond: () => Promise<Response>) =>
84
+ answer(context, respond, documentDomainError)
85
+
86
+ return new Hono<DocumentRouteEnvironment>()
87
+ .get('/account/notifications', async (context) =>
88
+ context.json(await service.notificationSettings(context.get('actor').userId))
89
+ )
90
+ .put('/account/notifications', validatedJSON(notificationSettingsSchema), async (context) =>
91
+ context.json(
92
+ await service.setNotificationSettings(
93
+ context.get('actor').userId,
94
+ context.req.valid('json')
95
+ )
96
+ )
97
+ )
98
+ .get('/documents/:documentId/threads/people', documentParams, (context) =>
99
+ run(context, async () =>
100
+ context.json(await service.people(await as(context, context.req.valid('param').documentId)))
101
+ )
102
+ )
103
+ .get('/documents/:documentId/threads', documentParams, (context) =>
104
+ run(context, async () =>
105
+ context.json(await service.list(await as(context, context.req.valid('param').documentId)))
106
+ )
107
+ )
108
+ .post(
109
+ '/documents/:documentId/threads',
110
+ documentParams,
111
+ validatedJSON(createCommentThreadSchema),
112
+ (context) =>
113
+ run(context, async () => {
114
+ const actor = await as(context, context.req.valid('param').documentId)
115
+ const thread = await service.createThread(actor, context.req.valid('json'))
116
+ return context.json({ thread }, 201)
117
+ })
118
+ )
119
+ .post(
120
+ '/documents/:documentId/threads/import',
121
+ documentParams,
122
+ validatedJSON(importCommentThreadsSchema),
123
+ (context) =>
124
+ run(context, async () => {
125
+ const actor = await as(context, context.req.valid('param').documentId)
126
+ return context.json(await service.importThreads(actor, context.req.valid('json')), 201)
127
+ })
128
+ )
129
+ .get('/documents/:documentId/threads/:threadId', documentThreadParams, (context) =>
130
+ run(context, async () => {
131
+ const { documentId, threadId } = context.req.valid('param')
132
+ return context.json({ thread: await service.get(await as(context, documentId), threadId) })
133
+ })
134
+ )
135
+ .post('/documents/:documentId/threads/:threadId/read', documentThreadParams, (context) =>
136
+ run(context, async () => {
137
+ const { documentId, threadId } = context.req.valid('param')
138
+ await service.markRead(await as(context, documentId), threadId)
139
+ return context.body(null, 204)
140
+ })
141
+ )
142
+ .patch(
143
+ '/documents/:documentId/threads/:threadId',
144
+ documentThreadParams,
145
+ validatedJSON(updateCommentThreadSchema),
146
+ (context) =>
147
+ run(context, async () => {
148
+ const { documentId, threadId } = context.req.valid('param')
149
+ const actor = await as(context, documentId)
150
+ return context.json({
151
+ thread: await service.updateThread(actor, threadId, context.req.valid('json'))
152
+ })
153
+ })
154
+ )
155
+ .delete('/documents/:documentId/threads/:threadId', documentThreadParams, (context) =>
156
+ run(context, async () => {
157
+ const { documentId, threadId } = context.req.valid('param')
158
+ await service.deleteThread(await as(context, documentId), threadId)
159
+ return context.body(null, 204)
160
+ })
161
+ )
162
+ .post(
163
+ '/documents/:documentId/threads/:threadId/comments',
164
+ documentThreadParams,
165
+ validatedJSON(createCommentSchema),
166
+ (context) =>
167
+ run(context, async () => {
168
+ const { documentId, threadId } = context.req.valid('param')
169
+ const actor = await as(context, documentId)
170
+ const thread = await service.reply(actor, threadId, context.req.valid('json'))
171
+ return context.json({ thread }, 201)
172
+ })
173
+ )
174
+ .patch(
175
+ '/documents/:documentId/threads/:threadId/comments/:commentId',
176
+ documentCommentParams,
177
+ validatedJSON(updateCommentSchema),
178
+ (context) =>
179
+ run(context, async () => {
180
+ const { documentId, threadId, commentId } = context.req.valid('param')
181
+ const actor = await as(context, documentId)
182
+ return context.json({
183
+ thread: await service.updateComment(
184
+ actor,
185
+ threadId,
186
+ commentId,
187
+ context.req.valid('json')
188
+ )
189
+ })
190
+ })
191
+ )
192
+ .delete(
193
+ '/documents/:documentId/threads/:threadId/comments/:commentId',
194
+ documentCommentParams,
195
+ (context) =>
196
+ run(context, async () => {
197
+ const { documentId, threadId, commentId } = context.req.valid('param')
198
+ const actor = await as(context, documentId)
199
+ return threadOrGone(context, await service.deleteComment(actor, threadId, commentId))
200
+ })
201
+ )
202
+ }
203
+
204
+ /**
205
+ * The same comments through a share link, whose secret every request carries in its body.
206
+ * Guests read; people signed in to the server also write. Reads are POSTs for the same reason.
207
+ */
208
+ export function createSharedCommentRoutes(
209
+ service: CommentService,
210
+ resolveSession?: CloudSessionResolver
211
+ ) {
212
+ /** Answers for whoever follows the link, with the secret the request's body carries. */
213
+ async function shared(
214
+ context: Context,
215
+ shareId: string,
216
+ { share }: SharedCommentsRequest,
217
+ respond: (actor: CommentActor) => Promise<Response>
218
+ ): Promise<Response> {
219
+ return answer(
220
+ context,
221
+ async () =>
222
+ respond(
223
+ await service.forShare(
224
+ shareId,
225
+ share.secret,
226
+ await shareActor(context.req.raw, resolveSession)
227
+ )
228
+ ),
229
+ sharingDomainError
230
+ )
231
+ }
232
+
233
+ /** A route that acts on a shared thread for whoever opened the share, answering with no content. */
234
+ function sharedThreadAction(act: (actor: CommentActor, threadId: string) => Promise<void>) {
235
+ return (context: SharedThreadContext<typeof sharedCommentsRequestSchema>) => {
236
+ const { shareId, threadId } = context.req.valid('param')
237
+ return shared(context, shareId, context.req.valid('json'), async (actor) => {
238
+ await act(actor, threadId)
239
+ return context.body(null, 204)
240
+ })
241
+ }
242
+ }
243
+
244
+ /**
245
+ * A route that changes a shared thread with the edit its request carries, for whoever opened the
246
+ * share, answering with the thread.
247
+ */
248
+ function sharedThreadChange<Schema extends v.GenericSchema<unknown, SharedCommentsRequest>>(
249
+ change: (
250
+ actor: CommentActor,
251
+ threadId: string,
252
+ edit: Omit<v.InferOutput<Schema>, 'share'>
253
+ ) => Promise<unknown>,
254
+ status: 200 | 201 = 200
255
+ ) {
256
+ return (context: SharedThreadContext<Schema>) => {
257
+ const { shareId, threadId } = context.req.valid('param')
258
+ const request = context.req.valid('json')
259
+ return shared(context, shareId, request, async (actor) =>
260
+ context.json({ thread: await change(actor, threadId, omit(request, ['share'])) }, status)
261
+ )
262
+ }
263
+ }
264
+
265
+ return new Hono()
266
+ .post(
267
+ '/shares/:shareId/threads/list',
268
+ shareParams,
269
+ validatedJSON(sharedCommentsRequestSchema),
270
+ (context) =>
271
+ shared(
272
+ context,
273
+ context.req.valid('param').shareId,
274
+ context.req.valid('json'),
275
+ async (actor) => context.json(await service.list(actor))
276
+ )
277
+ )
278
+ .post(
279
+ '/shares/:shareId/threads',
280
+ shareParams,
281
+ validatedJSON(sharedCreateCommentThreadSchema),
282
+ (context) => {
283
+ const { share, ...input } = context.req.valid('json')
284
+ return shared(context, context.req.valid('param').shareId, { share }, async (actor) =>
285
+ context.json({ thread: await service.createThread(actor, input) }, 201)
286
+ )
287
+ }
288
+ )
289
+ .post(
290
+ '/shares/:shareId/threads/:threadId/get',
291
+ shareThreadParams,
292
+ validatedJSON(sharedCommentsRequestSchema),
293
+ (context) => {
294
+ const { shareId, threadId } = context.req.valid('param')
295
+ return shared(context, shareId, context.req.valid('json'), async (actor) =>
296
+ context.json({ thread: await service.get(actor, threadId) })
297
+ )
298
+ }
299
+ )
300
+ .post(
301
+ '/shares/:shareId/threads/:threadId/read',
302
+ shareThreadParams,
303
+ validatedJSON(sharedCommentsRequestSchema),
304
+ sharedThreadAction((actor, threadId) => service.markRead(actor, threadId))
305
+ )
306
+ .patch(
307
+ '/shares/:shareId/threads/:threadId',
308
+ shareThreadParams,
309
+ validatedJSON(sharedUpdateCommentThreadSchema),
310
+ sharedThreadChange<typeof sharedUpdateCommentThreadSchema>((actor, threadId, edit) =>
311
+ service.updateThread(actor, threadId, edit)
312
+ )
313
+ )
314
+ .delete(
315
+ '/shares/:shareId/threads/:threadId',
316
+ shareThreadParams,
317
+ validatedJSON(sharedCommentsRequestSchema),
318
+ sharedThreadAction((actor, threadId) => service.deleteThread(actor, threadId))
319
+ )
320
+ .post(
321
+ '/shares/:shareId/threads/:threadId/comments',
322
+ shareThreadParams,
323
+ validatedJSON(sharedCreateCommentSchema),
324
+ sharedThreadChange<typeof sharedCreateCommentSchema>(
325
+ (actor, threadId, comment) => service.reply(actor, threadId, comment),
326
+ 201
327
+ )
328
+ )
329
+ .patch(
330
+ '/shares/:shareId/threads/:threadId/comments/:commentId',
331
+ shareCommentParams,
332
+ validatedJSON(sharedUpdateCommentSchema),
333
+ (context) => {
334
+ const { shareId, threadId, commentId } = context.req.valid('param')
335
+ const { share, ...input } = context.req.valid('json')
336
+ return shared(context, shareId, { share }, async (actor) =>
337
+ context.json({ thread: await service.updateComment(actor, threadId, commentId, input) })
338
+ )
339
+ }
340
+ )
341
+ .delete(
342
+ '/shares/:shareId/threads/:threadId/comments/:commentId',
343
+ shareCommentParams,
344
+ validatedJSON(sharedCommentsRequestSchema),
345
+ (context) => {
346
+ const { shareId, threadId, commentId } = context.req.valid('param')
347
+ return shared(context, shareId, context.req.valid('json'), async (actor) =>
348
+ threadOrGone(context, await service.deleteComment(actor, threadId, commentId))
349
+ )
350
+ }
351
+ )
352
+ }