@open-pencil/cloud 0.17.0-beta.5 → 0.17.0-beta.7

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 (188) hide show
  1. package/dist/client.d.ts +560 -93
  2. package/dist/client.d.ts.map +1 -1
  3. package/dist/client.js +1101 -186
  4. package/dist/client.js.map +1 -1
  5. package/dist/contract.d.ts +2 -2
  6. package/dist/contract.js +2 -2
  7. package/dist/contract2.js +390 -44
  8. package/dist/contract2.js.map +1 -1
  9. package/dist/email.d.ts +366 -3
  10. package/dist/email.d.ts.map +1 -1
  11. package/dist/email.js +1403 -556
  12. package/dist/email.js.map +1 -1
  13. package/dist/errors.js +16 -3
  14. package/dist/errors.js.map +1 -1
  15. package/dist/index.d.ts +878 -37
  16. package/dist/index.d.ts.map +1 -1
  17. package/dist/index2.d.ts +12 -2
  18. package/dist/index2.d.ts.map +1 -1
  19. package/dist/listen.mjs +589 -128
  20. package/dist/listen.mjs.map +1 -1
  21. package/dist/runtime-cloudflare.d.ts +4 -0
  22. package/dist/runtime-cloudflare.d.ts.map +1 -1
  23. package/dist/runtime-cloudflare.js +8690 -6325
  24. package/dist/runtime-cloudflare.js.map +1 -1
  25. package/dist/runtime-node.d.mts +10098 -5401
  26. package/dist/runtime-node.d.mts.map +1 -1
  27. package/dist/server.d.ts +13807 -7638
  28. package/dist/server.d.ts.map +1 -1
  29. package/dist/server.js +11723 -9412
  30. package/dist/server.js.map +1 -1
  31. package/dist/server.mjs +10659 -8650
  32. package/dist/server.mjs.map +1 -1
  33. package/dist/server2.mjs +79 -57
  34. package/dist/server2.mjs.map +1 -1
  35. package/package.json +13 -4
  36. package/src/admin/api/routes.ts +263 -190
  37. package/src/admin/audit/service.ts +9 -1
  38. package/src/admin/bootstrap.ts +86 -0
  39. package/src/admin/documents/service.ts +119 -4
  40. package/src/admin/email/service.ts +2 -1
  41. package/src/admin/enrollment/email.ts +17 -3
  42. package/src/admin/enrollment/service.ts +71 -10
  43. package/src/admin/errors.ts +5 -0
  44. package/src/admin/index.ts +1 -0
  45. package/src/admin/reports/service.ts +9 -3
  46. package/src/admin/schema.ts +6 -5
  47. package/src/admin/users/service.ts +173 -16
  48. package/src/client/api.ts +29 -2
  49. package/src/client/comments.ts +205 -0
  50. package/src/client/device-authorization.ts +4 -20
  51. package/src/client/discovery.ts +4 -2
  52. package/src/client/files/archive.ts +60 -0
  53. package/src/client/files/checksum.ts +7 -0
  54. package/src/client/files/download.ts +122 -0
  55. package/src/client/files/images.ts +89 -0
  56. package/src/client/files/index.ts +15 -0
  57. package/src/client/files/objects.ts +173 -0
  58. package/src/client/files/save.ts +79 -0
  59. package/src/client/index.ts +3 -6
  60. package/src/client/portal/account.ts +20 -2
  61. package/src/client/portal/administration.ts +52 -5
  62. package/src/client/portal/request.ts +4 -2
  63. package/src/client/tour.ts +44 -0
  64. package/src/client/versions.ts +7 -1
  65. package/src/contract/account.ts +61 -11
  66. package/src/contract/admin/index.ts +48 -3
  67. package/src/contract/billing.ts +73 -4
  68. package/src/contract/comments.ts +223 -0
  69. package/src/contract/discovery.ts +47 -19
  70. package/src/contract/index.ts +10 -0
  71. package/src/contract/links.ts +5 -0
  72. package/src/contract/relay.ts +3 -1
  73. package/src/contract/services.ts +44 -4
  74. package/src/contract/workspaces.ts +5 -0
  75. package/src/email/locales/ar.json +28 -0
  76. package/src/email/locales/de.json +28 -0
  77. package/src/email/locales/es.json +28 -0
  78. package/src/email/locales/fr.json +28 -0
  79. package/src/email/locales/it.json +28 -0
  80. package/src/email/locales/ja.json +28 -0
  81. package/src/email/locales/pl.json +28 -0
  82. package/src/email/locales/pt-br.json +28 -0
  83. package/src/email/locales/ru.json +28 -0
  84. package/src/email/locales/zh-cn.json +28 -0
  85. package/src/email/messages.ts +35 -0
  86. package/src/email/render.ts +18 -0
  87. package/src/email/samples.ts +28 -1
  88. package/src/email/schema.ts +29 -3
  89. package/src/email/templates/BrandEmail.vue +3 -1
  90. package/src/email/templates/CommentNotification.vue +39 -0
  91. package/src/email/templates/EnrollmentInvitation.vue +53 -0
  92. package/src/email/templates/TwoStepChanged.vue +17 -2
  93. package/src/email/templates/brand.ts +6 -0
  94. package/src/errors/posthog.ts +28 -4
  95. package/src/runtime/cloudflare/email.ts +2 -0
  96. package/src/runtime/cloudflare/relay/index.ts +21 -6
  97. package/src/runtime/cloudflare/worker.ts +6 -0
  98. package/src/runtime/cloudflare/xml.ts +12 -0
  99. package/src/runtime/node/admin.ts +51 -47
  100. package/src/runtime/node/email/runtime.ts +1 -0
  101. package/src/runtime/node/email/transport.ts +1 -0
  102. package/src/runtime/node/server.ts +8 -2
  103. package/src/runtime/posthog/errors.ts +3 -1
  104. package/src/runtime/site/server.ts +4 -1
  105. package/src/server/account/actions.ts +3 -1
  106. package/src/server/account/deletion.ts +38 -4
  107. package/src/server/account/routes.ts +67 -46
  108. package/src/server/account/tokens.ts +3 -3
  109. package/src/server/api/router.ts +22 -7
  110. package/src/server/app/checks.ts +6 -1
  111. package/src/server/app/cors.ts +44 -0
  112. package/src/server/app/index.ts +76 -76
  113. package/src/server/app/routes.ts +14 -5
  114. package/src/server/app/services.ts +49 -15
  115. package/src/server/auth/access-control.ts +13 -8
  116. package/src/server/auth/account.ts +13 -12
  117. package/src/server/auth/activity.ts +7 -2
  118. package/src/server/auth/adapter.ts +16 -3
  119. package/src/server/auth/email.ts +29 -17
  120. package/src/server/auth/endpoints.ts +4 -0
  121. package/src/server/auth/factory.ts +83 -64
  122. package/src/server/auth/index.ts +1 -1
  123. package/src/server/auth/methods.ts +162 -0
  124. package/src/server/auth/mfa-assurance.ts +147 -10
  125. package/src/server/auth/rate-limit.ts +31 -0
  126. package/src/server/auth/runtime.ts +19 -5
  127. package/src/server/auth/social-providers.ts +70 -24
  128. package/src/server/billing/index.ts +2 -0
  129. package/src/server/billing/notify.ts +55 -0
  130. package/src/server/billing/seats.ts +17 -0
  131. package/src/server/billing/tokens.ts +1 -1
  132. package/src/server/cleanup/documents.ts +5 -2
  133. package/src/server/cleanup/revisions.ts +6 -3
  134. package/src/server/cleanup/uploads.ts +2 -1
  135. package/src/server/collaboration/relay/connection.ts +7 -2
  136. package/src/server/collaboration/relay/hub.ts +55 -24
  137. package/src/server/collaboration/routes.ts +8 -5
  138. package/src/server/comments/index.ts +9 -0
  139. package/src/server/comments/notify.ts +277 -0
  140. package/src/server/comments/routes.ts +352 -0
  141. package/src/server/comments/rows.ts +249 -0
  142. package/src/server/comments/service.ts +570 -0
  143. package/src/server/community/routes.ts +6 -6
  144. package/src/server/config/deployment.ts +19 -6
  145. package/src/server/config/index.ts +1 -1
  146. package/src/server/config/public.ts +19 -6
  147. package/src/server/config/schema.ts +14 -2
  148. package/src/server/config/toml/schema.ts +27 -4
  149. package/src/server/db/index.ts +2 -1
  150. package/src/server/db/migrate.ts +21 -1
  151. package/src/server/db/migrations/015_comments.ts +57 -0
  152. package/src/server/db/migrations/016_comment_notifications.ts +76 -0
  153. package/src/server/db/migrations/017_invitation_emails.ts +19 -0
  154. package/src/server/db/migrations/018_enrollment_source.ts +17 -0
  155. package/src/server/db/tables.ts +92 -2
  156. package/src/server/documents/access.ts +17 -0
  157. package/src/server/documents/images.ts +6 -1
  158. package/src/server/documents/routes.ts +12 -12
  159. package/src/server/documents/service.ts +19 -5
  160. package/src/server/documents/summary.ts +15 -0
  161. package/src/server/documents/versions/routes.ts +7 -8
  162. package/src/server/documents/versions/service.ts +5 -2
  163. package/src/server/email/service.ts +8 -2
  164. package/src/server/email/types.ts +1 -0
  165. package/src/server/errors/index.ts +48 -3
  166. package/src/server/index.ts +15 -1
  167. package/src/server/internal/routes.ts +8 -2
  168. package/src/server/internal/service.ts +10 -0
  169. package/src/server/invitations/budget.ts +3 -1
  170. package/src/server/invitations/index.ts +1 -0
  171. package/src/server/invitations/links.ts +6 -0
  172. package/src/server/pictures/service.ts +3 -1
  173. package/src/server/policy/workspace.ts +5 -2
  174. package/src/server/reports/routes.ts +2 -2
  175. package/src/server/reports/service.ts +3 -1
  176. package/src/server/services/routes.ts +2 -2
  177. package/src/server/sharing/capabilities/service.ts +1 -1
  178. package/src/server/sharing/document-routes.ts +3 -3
  179. package/src/server/sharing/invitations/service.ts +3 -4
  180. package/src/server/sharing/routes.ts +15 -15
  181. package/src/server/validation.ts +33 -25
  182. package/src/server/workspaces/members.ts +50 -12
  183. package/src/server/workspaces/repository.ts +23 -12
  184. package/src/server/workspaces/routes.ts +8 -8
  185. package/src/services/app.ts +30 -19
  186. package/src/services/config.ts +47 -8
  187. package/src/services/metering.ts +15 -27
  188. package/src/client/billing.ts +0 -80
@@ -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
+ }
@@ -0,0 +1,249 @@
1
+ import type { CloudComment, CloudCommentThread, CommentAnchor } from '#cloud/contract'
2
+ import { userIdText, type CloudDatabase } from '#cloud/server/db'
3
+ import { DocumentNotFoundError } from '#cloud/server/documents/errors'
4
+ import { groupBy } from 'es-toolkit'
5
+ import type { Kysely, Transaction } from 'kysely'
6
+
7
+ export type Source = Kysely<CloudDatabase> | Transaction<CloudDatabase>
8
+
9
+ export type ThreadRow = {
10
+ id: string
11
+ pageId: string
12
+ pageName: string | null
13
+ nodeId: string | null
14
+ nodeName: string | null
15
+ offsetX: number | null
16
+ offsetY: number | null
17
+ x: number
18
+ y: number
19
+ createdBy: string
20
+ createdAt: Date
21
+ updatedAt: Date
22
+ resolvedAt: Date | null
23
+ resolvedBy: string | null
24
+ }
25
+
26
+ type CommentRow = {
27
+ id: string
28
+ threadId: string
29
+ mentions: string[]
30
+ authorId: string | null
31
+ authorName: string | null
32
+ importedAuthorName: string | null
33
+ agent: string | null
34
+ body: string
35
+ createdAt: Date
36
+ editedAt: Date | null
37
+ }
38
+
39
+ function commentOf(row: CommentRow): CloudComment {
40
+ return {
41
+ id: row.id,
42
+ author:
43
+ row.authorId === null
44
+ ? { kind: 'imported', name: row.importedAuthorName ?? '' }
45
+ : { kind: 'user', id: row.authorId, name: row.authorName },
46
+ agent: row.agent,
47
+ body: row.body,
48
+ mentions: row.mentions,
49
+ createdAt: row.createdAt.toISOString(),
50
+ editedAt: row.editedAt?.toISOString() ?? null
51
+ }
52
+ }
53
+
54
+ /**
55
+ * Whether someone other than `viewer` wrote in the thread since `readAt`, or at all when the viewer
56
+ * never read it; never for a guest, who has no account to keep it for.
57
+ */
58
+ function unreadBy(
59
+ comments: readonly CommentRow[],
60
+ viewer: string | null,
61
+ readAt: Date | undefined
62
+ ): boolean {
63
+ if (viewer === null) return false
64
+ return comments.some(
65
+ (comment) => comment.authorId !== viewer && (!readAt || comment.createdAt > readAt)
66
+ )
67
+ }
68
+
69
+ export function threadOf(
70
+ row: ThreadRow,
71
+ comments: readonly CommentRow[],
72
+ viewer: string | null,
73
+ readAt: Date | undefined
74
+ ): CloudCommentThread {
75
+ return {
76
+ id: row.id,
77
+ pageId: row.pageId,
78
+ pageName: row.pageName,
79
+ nodeId: row.nodeId,
80
+ nodeName: row.nodeName,
81
+ offsetX: row.offsetX,
82
+ offsetY: row.offsetY,
83
+ x: row.x,
84
+ y: row.y,
85
+ createdAt: row.createdAt.toISOString(),
86
+ updatedAt: row.updatedAt.toISOString(),
87
+ resolvedAt: row.resolvedAt?.toISOString() ?? null,
88
+ resolvedBy: row.resolvedBy,
89
+ createdBy: row.createdBy,
90
+ unread: unreadBy(comments, viewer, readAt),
91
+ comments: comments.map(commentOf)
92
+ }
93
+ }
94
+
95
+ export function anchorValues(anchor: CommentAnchor) {
96
+ return {
97
+ pageId: anchor.pageId,
98
+ pageName: anchor.pageName,
99
+ nodeId: anchor.nodeId,
100
+ nodeName: anchor.nodeName,
101
+ offsetX: anchor.offsetX,
102
+ offsetY: anchor.offsetY,
103
+ x: anchor.x,
104
+ y: anchor.y
105
+ }
106
+ }
107
+
108
+ /** How many threads the document holds, resolved ones included. */
109
+ export async function documentThreadCount(
110
+ transaction: Transaction<CloudDatabase>,
111
+ documentId: string
112
+ ): Promise<number> {
113
+ const { count } = await transaction
114
+ .selectFrom('commentThread')
115
+ .select((expression) => expression.fn.countAll<string>().as('count'))
116
+ .where('documentId', '=', documentId)
117
+ .executeTakeFirstOrThrow()
118
+ return Number(count)
119
+ }
120
+
121
+ /** Holds the document's row, so one writer at a time counts and adds its threads. */
122
+ export async function lockDocument(transaction: Transaction<CloudDatabase>, documentId: string) {
123
+ await transaction
124
+ .selectFrom('document')
125
+ .select('id')
126
+ .where('id', '=', documentId)
127
+ .forUpdate()
128
+ .executeTakeFirstOrThrow()
129
+ }
130
+
131
+ /** What resolving or reopening sets, or nothing when the thread already is as asked. */
132
+ export function resolutionChange(
133
+ resolved: boolean | undefined,
134
+ isResolved: boolean,
135
+ userId: string
136
+ ) {
137
+ if (resolved === undefined || resolved === isResolved) return {}
138
+ return resolved
139
+ ? { resolvedAt: new Date(), resolvedBy: userId }
140
+ : { resolvedAt: null, resolvedBy: null }
141
+ }
142
+
143
+ /** Threads with what a reply shows of them, to narrow by document or ID. */
144
+ export function threads(source: Source) {
145
+ return source
146
+ .selectFrom('commentThread')
147
+ .select([
148
+ 'commentThread.id',
149
+ 'commentThread.pageId',
150
+ 'commentThread.pageName',
151
+ 'commentThread.nodeId',
152
+ 'commentThread.nodeName',
153
+ 'commentThread.offsetX',
154
+ 'commentThread.offsetY',
155
+ 'commentThread.x',
156
+ 'commentThread.y',
157
+ 'commentThread.createdBy',
158
+ 'commentThread.createdAt',
159
+ 'commentThread.updatedAt',
160
+ 'commentThread.resolvedAt',
161
+ 'commentThread.resolvedBy'
162
+ ])
163
+ }
164
+
165
+ /** The threads' comments, oldest first, each with whom it names. */
166
+ export async function comments(
167
+ source: Source,
168
+ threadIds: readonly string[]
169
+ ): Promise<CommentRow[]> {
170
+ const rows = await source
171
+ .selectFrom('comment')
172
+ .leftJoin('user', (join) => join.onRef(userIdText, '=', 'comment.authorId'))
173
+ .select([
174
+ 'comment.id',
175
+ 'comment.threadId',
176
+ 'comment.authorId',
177
+ 'user.name as authorName',
178
+ 'comment.importedAuthorName',
179
+ 'comment.agent',
180
+ 'comment.body',
181
+ 'comment.createdAt',
182
+ 'comment.editedAt'
183
+ ])
184
+ .where('comment.threadId', 'in', [...threadIds])
185
+ .orderBy('comment.createdAt')
186
+ .orderBy('comment.id')
187
+ .execute()
188
+ if (rows.length === 0) return []
189
+ const mentions = groupBy(
190
+ await source
191
+ .selectFrom('commentMention')
192
+ .select(['commentId', 'userId'])
193
+ .where(
194
+ 'commentId',
195
+ 'in',
196
+ rows.map((row) => row.id)
197
+ )
198
+ .orderBy('createdAt')
199
+ .execute(),
200
+ (mention) => mention.commentId
201
+ )
202
+ return rows.map((row) => ({
203
+ ...row,
204
+ mentions: (mentions[row.id] ?? []).map((mention) => mention.userId)
205
+ }))
206
+ }
207
+
208
+ /** When `viewer` last read each of the threads. */
209
+ export async function readsOf(source: Source, viewer: string | null, threadIds: readonly string[]) {
210
+ if (viewer === null || threadIds.length === 0) return new Map<string, Date>()
211
+ const rows = await source
212
+ .selectFrom('commentRead')
213
+ .select(['threadId', 'readAt'])
214
+ .where('userId', '=', viewer)
215
+ .where('threadId', 'in', [...threadIds])
216
+ .execute()
217
+ return new Map(rows.map((row) => [row.threadId, row.readAt]))
218
+ }
219
+
220
+ /** Records that `userId` has read the thread as it is now. */
221
+ export async function markRead(source: Source, userId: string, threadId: string) {
222
+ const readAt = new Date()
223
+ await source
224
+ .insertInto('commentRead')
225
+ .values({ userId, threadId, readAt })
226
+ // A request that read the thread earlier but lands later never moves the marker back.
227
+ .onConflict((conflict) =>
228
+ conflict
229
+ .columns(['userId', 'threadId'])
230
+ .doUpdateSet({ readAt })
231
+ .where('commentRead.readAt', '<', readAt)
232
+ )
233
+ .execute()
234
+ }
235
+
236
+ export async function findThread(
237
+ source: Source,
238
+ documentId: string,
239
+ threadId: string,
240
+ lock = false
241
+ ) {
242
+ let query = threads(source)
243
+ .where('commentThread.documentId', '=', documentId)
244
+ .where('commentThread.id', '=', threadId)
245
+ if (lock) query = query.forUpdate()
246
+ const row = await query.executeTakeFirst()
247
+ if (!row) throw new DocumentNotFoundError()
248
+ return row
249
+ }