@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,219 @@
1
+ import { createEnrollmentService, type EnrollmentService } from '#cloud/admin'
2
+ import type {
3
+ CloudAuthAdapter,
4
+ CloudIdentityResolver,
5
+ CloudSessionResolver
6
+ } from '#cloud/server/auth'
7
+ import { enrollmentEmailOptions } from '#cloud/server/auth'
8
+ import { createBillingTokenService, createSeatNotifier } from '#cloud/server/billing'
9
+ import { createCollaborationTicketService } from '#cloud/server/collaboration'
10
+ import { createCommentService } from '#cloud/server/comments'
11
+ import { createCommunityService } from '#cloud/server/community'
12
+ import { CloudConfigError, type CloudServerConfig } from '#cloud/server/config'
13
+ import type { CloudDatabase } from '#cloud/server/db'
14
+ import { createDocumentService } from '#cloud/server/documents'
15
+ import { createDocumentVersionService } from '#cloud/server/documents/versions'
16
+ import type { TransactionalEmailService } from '#cloud/server/email'
17
+ import { reportCloudError, type CloudErrorReporter } from '#cloud/server/errors'
18
+ import type { InvitationDelivery, InvitationOutbox } from '#cloud/server/invitations'
19
+ import type { ForwardedRequestId } from '#cloud/server/logging'
20
+ import type { ObjectStore } from '#cloud/server/objects'
21
+ import { createUserPictures } from '#cloud/server/pictures'
22
+ import {
23
+ createConfiguredCloudPolicy,
24
+ createDefaultCloudPolicy,
25
+ createEntitlementService,
26
+ EntitlementOpenFeatureProvider,
27
+ type CloudPolicy,
28
+ type EntitlementSource
29
+ } from '#cloud/server/policy'
30
+ import { createDocumentReportService } from '#cloud/server/reports'
31
+ import { createServicesTokenService, type ServicesSigningKey } from '#cloud/server/services'
32
+ import { createDocumentSharingService } from '#cloud/server/sharing'
33
+ import { createWorkspaceMemberService, createWorkspaceService } from '#cloud/server/workspaces'
34
+ import type { Kysely } from 'kysely'
35
+
36
+ export type CloudServices = {
37
+ config: CloudServerConfig
38
+ database: Kysely<CloudDatabase>
39
+ auth: CloudAuthAdapter
40
+ objects: ObjectStore
41
+ resolveIdentity?: CloudIdentityResolver
42
+ resolveSession?: CloudSessionResolver
43
+ /**
44
+ * An approved account even before it accepted the current terms, for leaving: reading its
45
+ * documents and deleting the account. Defaults to `resolveSession` when that is given.
46
+ */
47
+ resolveAccountSession?: CloudSessionResolver
48
+ /**
49
+ * Whether the request's session proved its account's second step, or the account has none.
50
+ * Defaults to the auth adapter's, or to yes when `resolveIdentity` stands in for signing in.
51
+ */
52
+ twoStepConfirmed?: (request: Request) => Promise<boolean>
53
+ invitationDelivery?: InvitationDelivery
54
+ invitationOutbox?: InvitationOutbox
55
+ transactionalEmail?: TransactionalEmailService
56
+ enrollment?: EnrollmentService
57
+ entitlementSource?: EntitlementSource
58
+ policy?: CloudPolicy
59
+ /** The imported `servicesSigningKey`, required when the config names one. See `loadServicesSigningKey`. */
60
+ servicesSigningKey?: ServicesSigningKey
61
+ /**
62
+ * Where clients reach this runtime's collaboration relay. Without one, Cloud rooms fall back to
63
+ * peer-to-peer and writes are not enforced by the server.
64
+ */
65
+ relayURL?: string
66
+ /** Ends a restored document's live rooms, on the relay this runtime runs, if any. */
67
+ onDocumentRestored?: (documentId: string) => void
68
+ /** Ends a taken-down document's live rooms, saving them for when it is restored. */
69
+ onDocumentTakenDown?: (documentId: string) => void
70
+ /** Tells a document's live rooms its version history changed, on the relay this runtime runs. */
71
+ onDocumentVersionsChanged?: (documentId: string) => void
72
+ /** Tells a document's live rooms one of its comment threads changed, on this runtime's relay. */
73
+ onDocumentCommentsChanged?: (documentId: string, threadId: string) => void
74
+ /**
75
+ * Keeps work a request started running after its answer, as Workers' `waitUntil` does; without
76
+ * it the work runs on its own, as Node lets it.
77
+ */
78
+ runInBackground?: (task: Promise<unknown>) => void
79
+ /** Logs errors no route handled, and reports them when the deployment configures error tracking. */
80
+ reportError?: CloudErrorReporter
81
+ /** The request ID this runtime trusts from what stands in front of it, such as `cf-ray`. */
82
+ forwardedRequestId?: ForwardedRequestId
83
+ }
84
+
85
+ /** The domain services the app's routes are built from, over the runtime's injected services. */
86
+ export function createAppServices(services: CloudServices) {
87
+ const { config, database, objects } = services
88
+ const workspaces = createWorkspaceService(database)
89
+ const pictures = createUserPictures(database, { publicURL: config.publicURL })
90
+ const billingTokens =
91
+ services.servicesSigningKey && config.billingEndpoint
92
+ ? createBillingTokenService({
93
+ issuer: new URL(config.publicURL).origin,
94
+ signingKey: services.servicesSigningKey,
95
+ lifetimeSeconds: config.servicesTokenLifetimeSeconds
96
+ })
97
+ : undefined
98
+ // Billing charges for the people who can edit, so it hears when they change.
99
+ const seatNotifier =
100
+ billingTokens && config.billingEndpoint
101
+ ? createSeatNotifier({ database, endpoint: config.billingEndpoint, tokens: billingTokens })
102
+ : undefined
103
+ const onSeatsChanged = seatNotifier
104
+ ? (accountIds: readonly string[]) => {
105
+ const task = seatNotifier.notify(accountIds).catch((error: unknown) => {
106
+ void reportCloudError(services.reportError, 'Telling billing about seats failed', error, {
107
+ source: 'background'
108
+ })
109
+ })
110
+ if (services.runInBackground) services.runInBackground(task)
111
+ }
112
+ : undefined
113
+ const workspaceMembers = createWorkspaceMemberService(database, {
114
+ email: services.transactionalEmail,
115
+ publicURL: config.publicURL,
116
+ onSeatsChanged
117
+ })
118
+ const enrollment =
119
+ services.enrollment ??
120
+ createEnrollmentService(database, enrollmentEmailOptions(config, services.transactionalEmail))
121
+ const policy =
122
+ services.policy ??
123
+ (services.entitlementSource
124
+ ? createDefaultCloudPolicy(new EntitlementOpenFeatureProvider(services.entitlementSource))
125
+ : createConfiguredCloudPolicy(config, database))
126
+ const documents = createDocumentService(database, objects, {
127
+ policy,
128
+ technicalMaximumUploadBytes: config.technicalLimits.maximumUploadBytes,
129
+ onVersionsChanged: services.onDocumentVersionsChanged,
130
+ trash: {
131
+ retentionMs: config.documentRetentionMs,
132
+ purgeGraceMs: config.documentPurgeGraceMs,
133
+ leaseDurationMs: config.cleanupLeaseDurationMs,
134
+ reportError: services.reportError
135
+ },
136
+ reportError: services.reportError
137
+ })
138
+ const versions = createDocumentVersionService(database, objects, {
139
+ policy,
140
+ deploymentMode: config.deployment,
141
+ onRestored: services.onDocumentRestored,
142
+ onVersionsChanged: services.onDocumentVersionsChanged
143
+ })
144
+ const community = createCommunityService(
145
+ database,
146
+ objects,
147
+ documents,
148
+ versions,
149
+ config.community?.workspaceId ?? null
150
+ )
151
+ const entitlements = createEntitlementService(
152
+ database,
153
+ policy,
154
+ config.technicalLimits.maximumUploadBytes,
155
+ config.technicalLimits.maximumConnectionsPerRoom
156
+ )
157
+ const sharing = createDocumentSharingService(database, {
158
+ delivery: services.invitationDelivery,
159
+ outbox: services.invitationOutbox,
160
+ continuationSecret: config.authSecret,
161
+ publicURL: config.publicURL,
162
+ policy,
163
+ deploymentMode: config.deployment,
164
+ workspaceInvitations: workspaceMembers
165
+ })
166
+ const collaboration = createCollaborationTicketService({
167
+ database,
168
+ sharing,
169
+ authSecret: config.authSecret,
170
+ relayURL: services.relayURL,
171
+ policy,
172
+ deploymentMode: config.deployment
173
+ })
174
+ if (config.servicesSigningKey && !services.servicesSigningKey) {
175
+ throw new CloudConfigError('Services need the signing key imported by loadServicesSigningKey')
176
+ }
177
+ const servicesTokens = services.servicesSigningKey
178
+ ? createServicesTokenService({
179
+ database,
180
+ policy,
181
+ deploymentMode: config.deployment,
182
+ issuer: new URL(config.publicURL).origin,
183
+ signingKey: services.servicesSigningKey,
184
+ lifetimeSeconds: config.servicesTokenLifetimeSeconds
185
+ })
186
+ : undefined
187
+ const comments = createCommentService(database, {
188
+ sharing,
189
+ onCommentsChanged: services.onDocumentCommentsChanged,
190
+ notifier: services.transactionalEmail
191
+ ? { email: services.transactionalEmail, publicURL: config.publicURL }
192
+ : undefined
193
+ })
194
+ const reports = createDocumentReportService(database, {
195
+ sharing,
196
+ email: services.transactionalEmail,
197
+ adminRecipients: config.enrollmentAdminNotificationEmails,
198
+ publicURL: config.publicURL
199
+ })
200
+ return {
201
+ workspaces,
202
+ pictures,
203
+ workspaceMembers,
204
+ enrollment,
205
+ policy,
206
+ documents,
207
+ versions,
208
+ community,
209
+ entitlements,
210
+ sharing,
211
+ collaboration,
212
+ servicesTokens,
213
+ billingTokens,
214
+ comments,
215
+ reports
216
+ }
217
+ }
218
+
219
+ export type CloudAppServices = ReturnType<typeof createAppServices>
@@ -3,8 +3,11 @@ import { createAccessControl } from 'better-auth/plugins/access'
3
3
 
4
4
  export const accessStatements = {
5
5
  workspace: ['read', 'update', 'delete', 'invite', 'manage-members'],
6
- /** `delete` moves a document to Trash and back; `purge` deletes it from Trash for good. */
7
- document: ['create', 'read', 'edit', 'share', 'delete', 'purge']
6
+ /**
7
+ * `delete` moves a document to Trash and back; `purge` deletes it from Trash for good.
8
+ * `comment` writes comments, which everyone who can read may; `moderate` deletes anyone's.
9
+ */
10
+ document: ['create', 'read', 'comment', 'edit', 'moderate', 'share', 'delete', 'purge']
8
11
  } as const
9
12
 
10
13
  type AccessStatements = typeof accessStatements
@@ -23,15 +26,15 @@ export const accessControl = createAccessControl(accessStatements)
23
26
  export const workspaceRoles = {
24
27
  admin: accessControl.newRole({
25
28
  workspace: ['read', 'update', 'delete', 'invite', 'manage-members'],
26
- document: ['create', 'read', 'edit', 'share', 'delete', 'purge']
29
+ document: ['create', 'read', 'comment', 'edit', 'moderate', 'share', 'delete', 'purge']
27
30
  }),
28
31
  editor: accessControl.newRole({
29
32
  workspace: ['read'],
30
- document: ['create', 'read', 'edit', 'share', 'delete']
33
+ document: ['create', 'read', 'comment', 'edit', 'moderate', 'share', 'delete']
31
34
  }),
32
35
  viewer: accessControl.newRole({
33
36
  workspace: ['read'],
34
- document: ['read']
37
+ document: ['read', 'comment']
35
38
  })
36
39
  } satisfies Record<WorkspaceRole, unknown>
37
40
 
@@ -41,9 +44,11 @@ export const workspaceRoles = {
41
44
  * owner's document. Deleting from Trash for good is for the owner and workspace administrators.
42
45
  */
43
46
  export const documentRoles = {
44
- owner: accessControl.newRole({ document: ['read', 'edit', 'share', 'delete', 'purge'] }),
45
- editor: accessControl.newRole({ document: ['read', 'edit', 'share'] }),
46
- viewer: accessControl.newRole({ document: ['read'] })
47
+ owner: accessControl.newRole({
48
+ document: ['read', 'comment', 'edit', 'moderate', 'share', 'delete', 'purge']
49
+ }),
50
+ editor: accessControl.newRole({ document: ['read', 'comment', 'edit', 'moderate', 'share'] }),
51
+ viewer: accessControl.newRole({ document: ['read', 'comment'] })
47
52
  }
48
53
 
49
54
  export type DocumentRole = keyof typeof documentRoles
@@ -0,0 +1,62 @@
1
+ import type { EnrollmentService } from '#cloud/admin/enrollment/service'
2
+ import { CLOUD_ACCESS_TOKEN_PREFIX, type CloudAccessToken } from '#cloud/contract'
3
+ import type { TermsService } from '#cloud/server/account/terms'
4
+ import type { CloudServerConfig } from '#cloud/server/config'
5
+ import type { CloudDatabase } from '#cloud/server/db'
6
+ import type { Kysely } from 'kysely'
7
+
8
+ /** The personal access token in `Authorization: Bearer`, when the header carries one of Cloud's. */
9
+ export function bearerAccessToken(headers: Headers): string | null {
10
+ const key = headers.get('authorization')?.match(/^Bearer\s+(\S+)$/i)?.[1]
11
+ return key?.startsWith(CLOUD_ACCESS_TOKEN_PREFIX) ? key : null
12
+ }
13
+
14
+ /**
15
+ * The account a verified token belongs to, held to what a session would be: not banned, approved,
16
+ * and with the current terms accepted.
17
+ */
18
+ export async function accessTokenAccount(
19
+ {
20
+ database,
21
+ config,
22
+ enrollment,
23
+ terms
24
+ }: {
25
+ database: Kysely<CloudDatabase>
26
+ config: CloudServerConfig
27
+ enrollment: EnrollmentService
28
+ terms: TermsService
29
+ },
30
+ userId: string
31
+ ) {
32
+ const user = await database
33
+ .selectFrom('user')
34
+ .select(['id', 'email', 'name', 'image', 'role', 'banned', 'banExpires'])
35
+ .where('id', '=', userId)
36
+ .executeTakeFirst()
37
+ if (!user) return null
38
+ const banExpires = user.banExpires ? new Date(user.banExpires).getTime() : null
39
+ if (user.banned && (banExpires === null || banExpires > Date.now())) return null
40
+ if (config.enrollmentMode === 'approval' && !(await enrollment.isApproved(user.email))) {
41
+ return null
42
+ }
43
+ if (!(await terms.hasAccepted(user.id))) return null
44
+ return user
45
+ }
46
+
47
+ /** A stored token as the account's token list shows it, without the secret. */
48
+ export const toAccessToken = (key: {
49
+ id: string
50
+ name: string | null
51
+ start: string | null
52
+ createdAt: Date
53
+ expiresAt: Date | null
54
+ lastRequest: Date | null
55
+ }): CloudAccessToken => ({
56
+ id: key.id,
57
+ name: key.name ?? '',
58
+ start: key.start,
59
+ createdAt: new Date(key.createdAt).toISOString(),
60
+ expiresAt: key.expiresAt ? new Date(key.expiresAt).toISOString() : null,
61
+ lastUsedAt: key.lastRequest ? new Date(key.lastRequest).toISOString() : null
62
+ })
@@ -1,29 +1,30 @@
1
- import type {
2
- CloudAuthenticationMethod,
3
- CloudAuthenticationProvider
1
+ import {
2
+ isKnownAuthenticationProvider,
3
+ type CloudAuthenticationMethod,
4
+ type CloudSocialProvider
4
5
  } from '#cloud/contract/account'
5
- import { configuredSocialProviders, type CloudServerConfig } from '#cloud/server/config'
6
+ import type { CloudServerConfig } from '#cloud/server/config'
6
7
 
7
- import type { CloudAuthAdapter } from './adapter'
8
-
9
- const supportedProvider = (provider: string): provider is CloudAuthenticationProvider =>
10
- provider === 'credential' || provider === 'google' || provider === 'apple'
8
+ import type { CloudAuthAdapter, SocialLinkStart } from './adapter'
9
+ import { canRemoveSignInMethod, signInProviders } from './methods'
10
+ import { configuredSocialProviders } from './social-providers'
11
11
 
12
12
  export function createAccountAuthenticationService(
13
13
  auth: CloudAuthAdapter,
14
14
  config: CloudServerConfig
15
15
  ) {
16
+ const providers = signInProviders(config)
16
17
  return {
17
18
  async methods(headers: Headers) {
18
19
  const accounts = await auth.listAuthenticationMethods(headers)
19
20
  const methods = accounts.flatMap((account): CloudAuthenticationMethod[] => {
20
- if (!supportedProvider(account.providerId)) return []
21
+ if (!isKnownAuthenticationProvider(account.providerId)) return []
21
22
  return [
22
23
  {
23
24
  id: account.id,
24
25
  provider: account.providerId,
25
26
  createdAt: account.createdAt.toISOString(),
26
- canUnlink: accounts.length > 1
27
+ canUnlink: canRemoveSignInMethod(account, accounts, providers)
27
28
  }
28
29
  ]
29
30
  })
@@ -42,8 +43,8 @@ export function createAccountAuthenticationService(
42
43
  },
43
44
  async startSocialLink(
44
45
  headers: Headers,
45
- input: { provider: 'google' | 'apple'; callbackURL: string }
46
- ): Promise<string> {
46
+ input: { provider: CloudSocialProvider; callbackURL: string }
47
+ ): Promise<SocialLinkStart> {
47
48
  if (!configuredSocialProviders(config).includes(input.provider)) {
48
49
  throw new Error('Authentication provider is unavailable')
49
50
  }
@@ -1,4 +1,9 @@
1
- import type { CloudAccountSession, CloudSignIn, CloudSignInMethod } from '#cloud/contract'
1
+ import {
2
+ isKnownSocialProvider,
3
+ type CloudAccountSession,
4
+ type CloudSignIn,
5
+ type CloudSignInMethod
6
+ } from '#cloud/contract'
2
7
  import type { CloudDatabase } from '#cloud/server/db'
3
8
  import { dateString } from '#cloud/server/sharing/contracts'
4
9
  import type { BetterAuthPlugin } from 'better-auth'
@@ -47,7 +52,7 @@ export function signInMethod(
47
52
  ): CloudSignInMethod | null {
48
53
  if (isAuthEndpoint(endpoint.path, CORE_AUTH_PATHS.callbackOAuth)) {
49
54
  const provider = endpoint.params?.id
50
- return provider === 'google' || provider === 'apple' ? provider : 'other'
55
+ return provider && isKnownSocialProvider(provider) ? provider : 'other'
51
56
  }
52
57
  return methods.find(([path]) => isAuthEndpoint(endpoint.path, path))?.[1] ?? null
53
58
  }
@@ -1,4 +1,10 @@
1
- import type { CloudAccountSession, CloudSignIn } from '#cloud/contract'
1
+ import type {
2
+ CloudAccessToken,
3
+ CloudAccessTokenCreate,
4
+ CloudAccountSession,
5
+ CloudSignIn,
6
+ CloudSocialProvider
7
+ } from '#cloud/contract'
2
8
  import type { CloudActor } from '#cloud/server/auth/session'
3
9
 
4
10
  export type CloudMFAStatus = {
@@ -34,6 +40,12 @@ export type CloudAuthenticationMethodRecord = {
34
40
  createdAt: Date
35
41
  }
36
42
 
43
+ /**
44
+ * Where a link sends the browser, and the cookies that let the provider's callback match it to this
45
+ * request: the browser has to keep them, or the callback refuses the link.
46
+ */
47
+ export type SocialLinkStart = { url: string; headers: Headers }
48
+
37
49
  export interface CloudAuthAdapter {
38
50
  handler(request: Request): Promise<Response>
39
51
  resolveIdentity(headers: Headers): Promise<CloudIdentity | null>
@@ -43,6 +55,24 @@ export interface CloudAuthAdapter {
43
55
  * terms: enough to leave, by downloading its documents and deleting the account.
44
56
  */
45
57
  resolveAccountSession(headers: Headers): Promise<CloudActor | null>
58
+ /**
59
+ * Whether the signed-in session proved its account's second step, or the account has none.
60
+ * Neither resolver above accepts a session that has not: signing in through a linked account
61
+ * such as Google never asks for it.
62
+ */
63
+ twoStepConfirmed(headers: Headers): Promise<boolean>
64
+ /**
65
+ * The account a personal access token stands for, from `Authorization: Bearer`, once it is held
66
+ * to what a session would be. Only the document API reads tokens.
67
+ */
68
+ resolveAccessToken(headers: Headers): Promise<CloudActor | null>
69
+ listAccessTokens(headers: Headers): Promise<CloudAccessToken[] | null>
70
+ /** Makes a token for the signed-in account; answers the whole token, shown this once. */
71
+ createAccessToken(
72
+ headers: Headers,
73
+ input: CloudAccessTokenCreate
74
+ ): Promise<{ token: string; accessToken: CloudAccessToken }>
75
+ revokeAccessToken(headers: Headers, id: string): Promise<void>
46
76
  listAuthenticationMethods(headers: Headers): Promise<CloudAuthenticationMethodRecord[]>
47
77
  changePassword(
48
78
  headers: Headers,
@@ -50,8 +80,8 @@ export interface CloudAuthAdapter {
50
80
  ): Promise<void>
51
81
  startSocialLink(
52
82
  headers: Headers,
53
- input: { provider: 'google' | 'apple'; callbackURL: string }
54
- ): Promise<string>
83
+ input: { provider: CloudSocialProvider; callbackURL: string }
84
+ ): Promise<SocialLinkStart>
55
85
  unlinkAuthenticationMethod(headers: Headers, methodId: string): Promise<void>
56
86
  banUser(headers: Headers, userId: string, reason?: string): Promise<void>
57
87
  unbanUser(headers: Headers, userId: string): Promise<void>
@@ -72,6 +102,9 @@ export interface CloudAuthAdapter {
72
102
  emailChangeAvailable: boolean
73
103
  profile(headers: Headers): Promise<CloudAccountProfile | null>
74
104
  updateProfile(headers: Headers, input: { name: string }): Promise<void>
105
+ /** The language Cloud writes to the account in, as the app says it uses. */
106
+ /** Takes the app's language tag; the server keeps the nearest language it writes in. */
107
+ setLocale(headers: Headers, locale: string): Promise<void>
75
108
  /** Sends the confirmation to the new address and tells the old one which address it is. */
76
109
  changeEmail(headers: Headers, input: { newEmail: string; callbackURL: string }): Promise<void>
77
110
  sessions(headers: Headers): Promise<CloudAccountSession[] | null>
@@ -1,7 +1,9 @@
1
- import type { TwoStepChange } from '#cloud/email'
1
+ import type { EmailLocale, TwoStepChange } from '#cloud/email'
2
+ import type { CloudDatabase } from '#cloud/server/db'
2
3
  import type { TransactionalEmailService } from '#cloud/server/email'
3
4
  import { sha256 } from '@noble/hashes/sha2.js'
4
5
  import { bytesToHex, utf8ToBytes } from '@noble/hashes/utils.js'
6
+ import type { Transaction } from 'kysely'
5
7
 
6
8
  export type AuthenticationEmailService = {
7
9
  sendVerification(input: {
@@ -10,6 +12,8 @@ export type AuthenticationEmailService = {
10
12
  url: string
11
13
  token: string
12
14
  purpose?: 'account' | 'change'
15
+ /** The account's own language, or null for none; nothing is looked up, as sign-up needs. */
16
+ locale?: EmailLocale | null
13
17
  }): Promise<void>
14
18
  sendPasswordReset(input: {
15
19
  email: string
@@ -40,12 +44,17 @@ export type AuthenticationEmailService = {
40
44
  system: string | null
41
45
  desktop: boolean
42
46
  }): Promise<void>
43
- sendTwoStepChanged(input: {
44
- email: string
45
- name: string
46
- userId: string
47
- change: TwoStepChange
48
- }): Promise<void>
47
+ sendTwoStepChanged(
48
+ input: {
49
+ email: string
50
+ name: string
51
+ userId: string
52
+ change: TwoStepChange
53
+ /** For a removed sign-in method, which one. */
54
+ method?: string
55
+ },
56
+ transaction?: Transaction<CloudDatabase>
57
+ ): Promise<void>
49
58
  }
50
59
 
51
60
  function tokenHash(value: string): string {
@@ -62,6 +71,7 @@ export function createAuthenticationEmailService(
62
71
  idempotencyKey: `email-verification/${input.email.toLowerCase()}/${tokenHash(input.token)}`,
63
72
  kind: 'email-verification',
64
73
  recipientEmail: input.email,
74
+ recipientLocale: input.locale ?? null,
65
75
  payload: { name: input.name, actionURL: input.url, purpose: input.purpose }
66
76
  })
67
77
  },
@@ -109,17 +119,22 @@ export function createAuthenticationEmailService(
109
119
  }
110
120
  })
111
121
  },
112
- async sendTwoStepChanged(input) {
113
- await email.enqueue({
114
- idempotencyKey: `two-step-changed/${input.userId}/${crypto.randomUUID()}`,
115
- kind: 'two-step-changed',
116
- recipientEmail: input.email,
117
- payload: {
118
- name: input.name,
119
- change: input.change,
120
- actionURL: new URL('/account/security', publicURL).href
121
- }
122
- })
122
+ // Queued in the transaction that made the change, so the change and its notice commit together.
123
+ async sendTwoStepChanged(input, transaction) {
124
+ await email.enqueue(
125
+ {
126
+ idempotencyKey: `two-step-changed/${input.userId}/${crypto.randomUUID()}`,
127
+ kind: 'two-step-changed',
128
+ recipientEmail: input.email,
129
+ payload: {
130
+ name: input.name,
131
+ change: input.change,
132
+ ...(input.method && { method: input.method }),
133
+ actionURL: new URL('/account/security', publicURL).href
134
+ }
135
+ },
136
+ transaction
137
+ )
123
138
  }
124
139
  }
125
140
  }
@@ -23,15 +23,19 @@ export const CORE_AUTH_PATHS: CorePaths<
23
23
  | 'callbackOAuth'
24
24
  | 'deleteUser'
25
25
  | 'deleteUserCallback'
26
+ | 'linkSocialAccount'
26
27
  | 'requestPasswordReset'
27
28
  | 'sendVerificationEmail'
28
29
  | 'signInEmail'
29
30
  | 'signUpEmail'
31
+ | 'unlinkAccount'
30
32
  | 'verifyEmail'
31
33
  > = {
32
34
  callbackOAuth: '/callback/:id',
33
35
  deleteUser: '/delete-user',
34
36
  deleteUserCallback: '/delete-user/callback',
37
+ linkSocialAccount: '/link-social',
38
+ unlinkAccount: '/unlink-account',
35
39
  requestPasswordReset: '/request-password-reset',
36
40
  sendVerificationEmail: '/send-verification-email',
37
41
  signInEmail: '/sign-in/email',