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

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 (235) hide show
  1. package/README.md +1 -1
  2. package/dist/bin/{ai-relay.mjs → services.mjs} +8 -8
  3. package/dist/bin/services.mjs.map +1 -0
  4. package/dist/client.d.ts +236 -46
  5. package/dist/client.d.ts.map +1 -1
  6. package/dist/client.js +649 -400
  7. package/dist/client.js.map +1 -1
  8. package/dist/contract.d.ts +2 -2
  9. package/dist/contract.js +2 -2
  10. package/dist/contract2.js +680 -443
  11. package/dist/contract2.js.map +1 -1
  12. package/dist/email.d.ts +9 -1
  13. package/dist/email.d.ts.map +1 -1
  14. package/dist/email.js +99 -58
  15. package/dist/email.js.map +1 -1
  16. package/dist/index.d.ts +468 -64
  17. package/dist/index.d.ts.map +1 -1
  18. package/dist/listen.mjs +575 -738
  19. package/dist/listen.mjs.map +1 -1
  20. package/dist/runtime-node.d.mts +6564 -2934
  21. package/dist/runtime-node.d.mts.map +1 -1
  22. package/dist/runtime-node.mjs +6 -5
  23. package/dist/runtime-node.mjs.map +1 -1
  24. package/dist/server.d.ts +8931 -4198
  25. package/dist/server.d.ts.map +1 -1
  26. package/dist/server.js +5260 -3859
  27. package/dist/server.js.map +1 -1
  28. package/dist/server.mjs +5686 -3736
  29. package/dist/server.mjs.map +1 -1
  30. package/dist/server2.mjs +101 -79
  31. package/dist/server2.mjs.map +1 -1
  32. package/package.json +9 -6
  33. package/src/admin/api/routes.ts +103 -33
  34. package/src/admin/audit/service.ts +25 -6
  35. package/src/admin/documents/service.ts +361 -0
  36. package/src/admin/errors.ts +9 -1
  37. package/src/admin/index.ts +6 -0
  38. package/src/admin/operations/service.ts +7 -0
  39. package/src/admin/reports/service.ts +147 -0
  40. package/src/admin/schema.ts +6 -0
  41. package/src/client/api.ts +36 -21
  42. package/src/client/auth/navigation.ts +6 -5
  43. package/src/client/index.ts +7 -7
  44. package/src/client/portal/account.ts +25 -0
  45. package/src/client/portal/administration.ts +56 -0
  46. package/src/client/{ai.ts → services.ts} +44 -27
  47. package/src/contract/account.ts +58 -2
  48. package/src/contract/admin/index.ts +67 -3
  49. package/src/contract/collaboration.ts +6 -1
  50. package/src/contract/discovery.ts +22 -4
  51. package/src/contract/documents.ts +27 -0
  52. package/src/contract/entitlements.ts +2 -2
  53. package/src/contract/index.ts +63 -37
  54. package/src/contract/relay.ts +6 -0
  55. package/src/contract/reports.ts +42 -0
  56. package/src/contract/services.ts +233 -0
  57. package/src/contract/sharing.ts +3 -9
  58. package/src/email/render.ts +26 -0
  59. package/src/email/schema.ts +11 -1
  60. package/src/email/templates/brand.ts +1 -1
  61. package/src/runtime/cloudflare/environment.ts +31 -6
  62. package/src/runtime/cloudflare/index.ts +1 -1
  63. package/src/runtime/cloudflare/logging.ts +15 -0
  64. package/src/runtime/cloudflare/maintenance.ts +31 -0
  65. package/src/runtime/cloudflare/relay/index.ts +176 -0
  66. package/src/runtime/cloudflare/relay/sockets.ts +112 -0
  67. package/src/runtime/cloudflare/worker.ts +89 -26
  68. package/src/runtime/node/application.ts +5 -3
  69. package/src/runtime/node/bootstrap.ts +20 -4
  70. package/src/runtime/node/cleanup.ts +16 -3
  71. package/src/runtime/node/entitlements/main.ts +14 -11
  72. package/src/runtime/node/index.ts +1 -1
  73. package/src/runtime/node/migrate.ts +5 -1
  74. package/src/runtime/node/relay.ts +8 -2
  75. package/src/runtime/node/request-id.ts +13 -0
  76. package/src/runtime/node/server.ts +71 -15
  77. package/src/runtime/node/{ai-relay → services}/main.ts +6 -6
  78. package/src/runtime/node/{ai-relay → services}/server.ts +18 -18
  79. package/src/runtime/postgres/database.ts +20 -1
  80. package/src/runtime/posthog/errors.ts +32 -0
  81. package/src/runtime/s3/objects.ts +50 -1
  82. package/src/runtime/site/server.ts +33 -4
  83. package/src/server/account/actions.ts +5 -0
  84. package/src/server/account/deletion.ts +302 -0
  85. package/src/server/account/routes.ts +47 -3
  86. package/src/server/account/terms.ts +42 -0
  87. package/src/server/api/router.ts +12 -7
  88. package/src/server/api/types.ts +9 -0
  89. package/src/server/app.ts +93 -15
  90. package/src/server/auth/access-control.ts +63 -0
  91. package/src/server/auth/adapter.ts +11 -0
  92. package/src/server/auth/endpoints.ts +5 -1
  93. package/src/server/auth/factory.ts +30 -3
  94. package/src/server/auth/index.ts +10 -1
  95. package/src/server/cleanup/configured.ts +12 -5
  96. package/src/server/cleanup/documents.ts +165 -71
  97. package/src/server/cleanup/objects.ts +10 -2
  98. package/src/server/cleanup/revisions.ts +24 -7
  99. package/src/server/cleanup/uploads.ts +8 -2
  100. package/src/server/cleanup/worker.ts +5 -2
  101. package/src/server/collaboration/index.ts +3 -0
  102. package/src/server/collaboration/relay/connection.ts +196 -0
  103. package/src/server/collaboration/relay/documents.ts +13 -10
  104. package/src/server/collaboration/relay/hub.ts +279 -195
  105. package/src/server/collaboration/relay/index.ts +3 -1
  106. package/src/server/collaboration/relay/log.ts +79 -0
  107. package/src/server/collaboration/relay/persistence.ts +147 -22
  108. package/src/server/collaboration/relay/resume.ts +28 -0
  109. package/src/server/collaboration/routes.ts +27 -16
  110. package/src/server/collaboration/service.ts +27 -31
  111. package/src/server/config/deployment.ts +35 -4
  112. package/src/server/config/public.ts +5 -4
  113. package/src/server/config/schema.ts +104 -16
  114. package/src/server/db/expressions.ts +15 -1
  115. package/src/server/db/migrate.ts +34 -114
  116. package/src/server/db/migrations/001_accounts.ts +79 -0
  117. package/src/server/db/migrations/002_workspaces.ts +48 -0
  118. package/src/server/db/migrations/003_storage.ts +44 -0
  119. package/src/server/db/migrations/004_documents.ts +193 -0
  120. package/src/server/db/migrations/005_sharing.ts +95 -0
  121. package/src/server/db/migrations/006_operations.ts +110 -0
  122. package/src/server/db/migrations/007_trash.ts +33 -0
  123. package/src/server/db/migrations/008_terms.ts +18 -0
  124. package/src/server/db/migrations/schema.ts +71 -0
  125. package/src/server/db/tables.ts +70 -7
  126. package/src/server/documents/access.ts +66 -55
  127. package/src/server/documents/errors.ts +7 -0
  128. package/src/server/documents/images.ts +2 -1
  129. package/src/server/documents/limits.ts +9 -9
  130. package/src/server/documents/purge.ts +75 -0
  131. package/src/server/documents/repository.ts +2 -0
  132. package/src/server/documents/routes.ts +132 -80
  133. package/src/server/documents/service.ts +18 -4
  134. package/src/server/documents/summary.ts +1 -0
  135. package/src/server/documents/trash.ts +203 -0
  136. package/src/server/documents/versions/checkpoint.ts +2 -1
  137. package/src/server/documents/versions/history.ts +11 -7
  138. package/src/server/documents/versions/routes.ts +36 -25
  139. package/src/server/documents/versions/service.ts +22 -4
  140. package/src/server/errors/index.ts +99 -0
  141. package/src/server/errors/posthog.ts +80 -0
  142. package/src/server/index.ts +56 -16
  143. package/src/server/internal/index.ts +3 -3
  144. package/src/server/internal/routes.ts +7 -15
  145. package/src/server/internal/schema.ts +1 -1
  146. package/src/server/internal/service.ts +17 -23
  147. package/src/server/invitations/budget.ts +66 -0
  148. package/src/server/invitations/index.ts +1 -0
  149. package/src/server/logging.ts +76 -0
  150. package/src/server/objects/types.ts +12 -0
  151. package/src/server/pictures/routes.ts +4 -2
  152. package/src/server/pictures/service.ts +2 -1
  153. package/src/server/policy/database.ts +39 -25
  154. package/src/server/policy/index.ts +2 -1
  155. package/src/server/policy/keys.ts +5 -2
  156. package/src/server/policy/policy.ts +1 -0
  157. package/src/server/policy/schema.ts +2 -2
  158. package/src/server/policy/service.ts +12 -9
  159. package/src/server/policy/static.ts +5 -5
  160. package/src/server/policy/workspace.ts +41 -0
  161. package/src/server/quota/reconcile.ts +2 -0
  162. package/src/server/quota/storage.ts +69 -31
  163. package/src/server/rate-limit/cleanup.ts +17 -5
  164. package/src/server/rate-limit/index.ts +4 -1
  165. package/src/server/rate-limit/middleware.ts +100 -12
  166. package/src/server/reports/index.ts +8 -0
  167. package/src/server/reports/routes.ts +37 -0
  168. package/src/server/reports/service.ts +123 -0
  169. package/src/server/services/errors.ts +7 -0
  170. package/src/server/services/index.ts +8 -0
  171. package/src/server/{ai → services}/keys.ts +11 -11
  172. package/src/server/services/routes.ts +47 -0
  173. package/src/server/{ai/service.ts → services/tokens.ts} +23 -20
  174. package/src/server/sharing/capabilities/service.ts +68 -22
  175. package/src/server/sharing/document-routes.ts +30 -22
  176. package/src/server/sharing/grants/service.ts +11 -18
  177. package/src/server/sharing/http.ts +4 -0
  178. package/src/server/sharing/invitations/service.ts +21 -11
  179. package/src/server/sharing/policy.ts +9 -14
  180. package/src/server/sharing/routes.ts +108 -85
  181. package/src/server/sharing/service.ts +1 -17
  182. package/src/server/validation.ts +59 -2
  183. package/src/server/workspaces/index.ts +1 -0
  184. package/src/server/workspaces/members.ts +89 -38
  185. package/src/server/workspaces/repository.ts +2 -1
  186. package/src/server/workspaces/routes.ts +67 -45
  187. package/src/{ai-relay → services}/app.ts +48 -44
  188. package/src/{ai-relay → services}/config.ts +25 -19
  189. package/src/services/db/index.ts +10 -0
  190. package/src/services/db/migrate.ts +37 -0
  191. package/src/{ai-relay/db/migrations/001_usage.ts → services/db/migrations/001_baseline.ts} +18 -7
  192. package/src/services/db/schema.ts +22 -0
  193. package/src/services/index.ts +18 -0
  194. package/src/{ai-relay → services}/metering.ts +2 -2
  195. package/src/{ai-relay → services}/usage.ts +43 -19
  196. package/dist/bin/ai-relay.mjs.map +0 -1
  197. package/src/ai-relay/db/index.ts +0 -10
  198. package/src/ai-relay/db/migrate.ts +0 -32
  199. package/src/ai-relay/db/schema.ts +0 -20
  200. package/src/ai-relay/index.ts +0 -18
  201. package/src/contract/ai.ts +0 -150
  202. package/src/runtime/cloudflare/relay.ts +0 -136
  203. package/src/server/ai/errors.ts +0 -7
  204. package/src/server/ai/index.ts +0 -4
  205. package/src/server/ai/routes.ts +0 -43
  206. package/src/server/auth/workspace-access.ts +0 -23
  207. package/src/server/db/migrations/001_foundation.ts +0 -164
  208. package/src/server/db/migrations/002_upload_cleanup_claims.ts +0 -34
  209. package/src/server/db/migrations/003_document_cleanup_claims.ts +0 -23
  210. package/src/server/db/migrations/004_document_sharing.ts +0 -82
  211. package/src/server/db/migrations/005_document_collaboration_epoch.ts +0 -13
  212. package/src/server/db/migrations/006_invitation_continuation.ts +0 -27
  213. package/src/server/db/migrations/007_collaboration_state.ts +0 -25
  214. package/src/server/db/migrations/008_storage_reservations.ts +0 -37
  215. package/src/server/db/migrations/009_workspace_entitlements.ts +0 -22
  216. package/src/server/db/migrations/010_upload_finalization.ts +0 -22
  217. package/src/server/db/migrations/011_upload_finalization_lease.ts +0 -12
  218. package/src/server/db/migrations/012_transactional_email.ts +0 -48
  219. package/src/server/db/migrations/013_admin_enrollment.ts +0 -54
  220. package/src/server/db/migrations/014_enrollment_email_kinds.ts +0 -30
  221. package/src/server/db/migrations/015_cloud_rate_limit.ts +0 -22
  222. package/src/server/db/migrations/016_auth_schema.ts +0 -16
  223. package/src/server/db/migrations/017_authentication_email_kinds.ts +0 -32
  224. package/src/server/db/migrations/018_authentication_mfa.ts +0 -78
  225. package/src/server/db/migrations/019_better_auth_account_issuer.ts +0 -42
  226. package/src/server/db/migrations/020_workspace_invitations.ts +0 -57
  227. package/src/server/db/migrations/021_document_versions.ts +0 -66
  228. package/src/server/db/migrations/022_entitlement_external_version.ts +0 -17
  229. package/src/server/db/migrations/023_document_images.ts +0 -61
  230. package/src/server/db/migrations/024_account_activity.ts +0 -66
  231. package/src/server/db/migrations/025_table_names.ts +0 -58
  232. package/src/server/db/migrations/026_user_picture.ts +0 -30
  233. package/src/server/db/migrations/027_document_kind.ts +0 -19
  234. package/src/server/db/migrations/helpers.ts +0 -78
  235. /package/dist/bin/{ai-relay.d.mts → services.d.mts} +0 -0
package/src/server/app.ts CHANGED
@@ -1,20 +1,24 @@
1
1
  import {
2
2
  createAdminAuditService,
3
+ createAdminDocumentService,
3
4
  createAdminEmailService,
4
5
  createAdminOperationsService,
6
+ createAdminReportService,
5
7
  createAdminUserService,
6
8
  createCloudAdminRoutes,
7
9
  createEnrollmentService,
8
10
  type EnrollmentService
9
11
  } from '#cloud/admin'
10
12
  import {
11
- CLOUD_AI_JWKS_PATH,
13
+ CLOUD_API_MAX_BODY_BYTES,
14
+ CLOUD_SERVICES_JWKS_PATH,
12
15
  CLOUD_DISCOVERY_PATH,
13
16
  CLOUD_PROTOCOL_VERSION,
14
17
  type CloudDiscovery
15
18
  } from '#cloud/contract'
19
+ import { createAccountDeletionService } from '#cloud/server/account/deletion'
16
20
  import { createAccountRoutes } from '#cloud/server/account/routes'
17
- import { createAITokenService, type AISigningKey } from '#cloud/server/ai'
21
+ import { createTermsService } from '#cloud/server/account/terms'
18
22
  import {
19
23
  createCloudAPIRouter,
20
24
  createPublicCloudAPIRouter,
@@ -39,8 +43,10 @@ import type { CloudDatabase } from '#cloud/server/db'
39
43
  import { createDocumentService } from '#cloud/server/documents'
40
44
  import { createDocumentVersionService } from '#cloud/server/documents/versions'
41
45
  import type { TransactionalEmailService } from '#cloud/server/email'
46
+ import { cloudErrorHandler, type CloudErrorReporter } from '#cloud/server/errors'
42
47
  import { createInternalRoutes, createInternalService } from '#cloud/server/internal'
43
48
  import type { InvitationDelivery, InvitationOutbox } from '#cloud/server/invitations'
49
+ import { cloudRequestId, type ForwardedRequestId } from '#cloud/server/logging'
44
50
  import type { ObjectStore } from '#cloud/server/objects'
45
51
  import { createPictureRoutes, createUserPictures } from '#cloud/server/pictures'
46
52
  import {
@@ -57,9 +63,12 @@ import {
57
63
  createTrustedIPRateLimiter,
58
64
  routeHasOwnBudget
59
65
  } from '#cloud/server/rate-limit'
66
+ import { createDocumentReportService } from '#cloud/server/reports'
67
+ import { createServicesTokenService, type ServicesSigningKey } from '#cloud/server/services'
60
68
  import { createDocumentSharingService } from '#cloud/server/sharing'
61
69
  import { createWorkspaceMemberService, createWorkspaceService } from '#cloud/server/workspaces'
62
70
  import { Hono, type Context } from 'hono'
71
+ import { bodyLimit } from 'hono/body-limit'
63
72
  import { cors } from 'hono/cors'
64
73
  import type { Kysely } from 'kysely'
65
74
 
@@ -70,14 +79,19 @@ export type CloudServices = {
70
79
  objects: ObjectStore
71
80
  resolveIdentity?: CloudIdentityResolver
72
81
  resolveSession?: CloudSessionResolver
82
+ /**
83
+ * An approved account even before it accepted the current terms, for leaving: reading its
84
+ * documents and deleting the account. Defaults to `resolveSession` when that is given.
85
+ */
86
+ resolveAccountSession?: CloudSessionResolver
73
87
  invitationDelivery?: InvitationDelivery
74
88
  invitationOutbox?: InvitationOutbox
75
89
  transactionalEmail?: TransactionalEmailService
76
90
  enrollment?: EnrollmentService
77
91
  entitlementSource?: EntitlementSource
78
92
  policy?: CloudPolicy
79
- /** The imported `aiSigningKey`, required when the config names one. See `loadAISigningKey`. */
80
- aiSigningKey?: AISigningKey
93
+ /** The imported `servicesSigningKey`, required when the config names one. See `loadServicesSigningKey`. */
94
+ servicesSigningKey?: ServicesSigningKey
81
95
  /**
82
96
  * Where clients reach this runtime's collaboration relay. Without one, Cloud rooms fall back to
83
97
  * peer-to-peer and writes are not enforced by the server.
@@ -85,8 +99,14 @@ export type CloudServices = {
85
99
  relayURL?: string
86
100
  /** Ends a restored document's live rooms, on the relay this runtime runs, if any. */
87
101
  onDocumentRestored?: (documentId: string) => void
102
+ /** Ends a taken-down document's live rooms, saving them for when it is restored. */
103
+ onDocumentTakenDown?: (documentId: string) => void
88
104
  /** Tells a document's live rooms its version history changed, on the relay this runtime runs. */
89
105
  onDocumentVersionsChanged?: (documentId: string) => void
106
+ /** Logs errors no route handled, and reports them when the deployment configures error tracking. */
107
+ reportError?: CloudErrorReporter
108
+ /** The request ID this runtime trusts from what stands in front of it, such as `cf-ray`. */
109
+ forwardedRequestId?: ForwardedRequestId
90
110
  }
91
111
 
92
112
  type CloudEnvironment = CloudAPIEnvironment
@@ -129,6 +149,11 @@ export function createCloudApp(services: CloudServices) {
129
149
  const discovery = discoveryFromServices(services)
130
150
  const resolveIdentity = services.resolveIdentity ?? createCloudIdentityResolver(services.auth)
131
151
  const resolveSession = services.resolveSession ?? createCloudSessionResolver(services.auth)
152
+ const resolveAccountSession =
153
+ services.resolveAccountSession ??
154
+ (services.resolveSession
155
+ ? services.resolveSession
156
+ : (request: Request) => services.auth.resolveAccountSession(request.headers))
132
157
  const allowedOrigins = new Set(
133
158
  [services.config.publicURL, ...services.config.trustedOrigins].map(
134
159
  (origin) => new URL(origin).origin
@@ -168,7 +193,12 @@ export function createCloudApp(services: CloudServices) {
168
193
  : undefined
169
194
  }),
170
195
  audit: createAdminAuditService(services.database),
171
- operations: createAdminOperationsService(services.database, services.config)
196
+ operations: createAdminOperationsService(services.database, services.config),
197
+ documents: createAdminDocumentService(services.database, {
198
+ closeRooms: services.onDocumentTakenDown,
199
+ purgeGraceMs: services.config.documentPurgeGraceMs
200
+ }),
201
+ reports: createAdminReportService(services.database)
172
202
  },
173
203
  allowedOrigins,
174
204
  {
@@ -186,7 +216,14 @@ export function createCloudApp(services: CloudServices) {
186
216
  const documents = createDocumentService(services.database, services.objects, {
187
217
  policy,
188
218
  technicalMaximumUploadBytes: services.config.technicalLimits.maximumUploadBytes,
189
- onVersionsChanged: services.onDocumentVersionsChanged
219
+ onVersionsChanged: services.onDocumentVersionsChanged,
220
+ trash: {
221
+ retentionMs: services.config.documentRetentionMs,
222
+ purgeGraceMs: services.config.documentPurgeGraceMs,
223
+ leaseDurationMs: services.config.cleanupLeaseDurationMs,
224
+ reportError: services.reportError
225
+ },
226
+ reportError: services.reportError
190
227
  })
191
228
  const versions = createDocumentVersionService(services.database, services.objects, {
192
229
  policy,
@@ -217,26 +254,46 @@ export function createCloudApp(services: CloudServices) {
217
254
  policy,
218
255
  deploymentMode: services.config.deployment
219
256
  })
220
- if (services.config.aiSigningKey && !services.aiSigningKey) {
221
- throw new CloudConfigError('The AI service needs the signing key imported by loadAISigningKey')
257
+ if (services.config.servicesSigningKey && !services.servicesSigningKey) {
258
+ throw new CloudConfigError('Services need the signing key imported by loadServicesSigningKey')
222
259
  }
223
- const aiTokens = services.aiSigningKey
224
- ? createAITokenService({
260
+ const servicesTokens = services.servicesSigningKey
261
+ ? createServicesTokenService({
225
262
  database: services.database,
226
263
  policy,
227
264
  deploymentMode: services.config.deployment,
228
265
  issuer: new URL(services.config.publicURL).origin,
229
- signingKey: services.aiSigningKey,
230
- lifetimeSeconds: services.config.aiTokenLifetimeSeconds
266
+ signingKey: services.servicesSigningKey,
267
+ lifetimeSeconds: services.config.servicesTokenLifetimeSeconds
231
268
  })
232
269
  : undefined
233
270
 
234
271
  const requireActiveSession = async (context: Context, next: () => Promise<void>) => {
272
+ // A route that lets an account leave before accepting the terms named it already.
273
+ if (context.get('actor')) return next()
235
274
  const actor = await resolveSession(context.req.raw)
236
275
  if (!actor) return context.json({ error: { code: 'unauthorized' as const } }, 401)
237
276
  context.set('actor', actor)
238
277
  return next()
239
278
  }
279
+ /**
280
+ * An account that may leave: one that has terms to accept can still download its documents and
281
+ * delete itself, which nothing else lets it do until it accepts.
282
+ */
283
+ const requireAccountSession = async (context: Context, next: () => Promise<void>) => {
284
+ const actor = await resolveAccountSession(context.req.raw)
285
+ if (!actor) return context.json({ error: { code: 'unauthorized' as const } }, 401)
286
+ context.set('actor', actor)
287
+ return next()
288
+ }
289
+ /** Reading one document, which downloading everything before leaving needs, without the terms. */
290
+ const allowLeavingRead = async (context: Context, next: () => Promise<void>) => {
291
+ if (context.req.method === 'GET') {
292
+ const actor = await resolveAccountSession(context.req.raw)
293
+ if (actor) context.set('actor', actor)
294
+ }
295
+ return next()
296
+ }
240
297
  const publicRateLimiter = createTrustedIPRateLimiter(
241
298
  services.database,
242
299
  services.config.authSecret,
@@ -268,15 +325,24 @@ export function createCloudApp(services: CloudServices) {
268
325
 
269
326
  const accountRoutes = createAccountRoutes({
270
327
  auth: services.auth,
328
+ terms: createTermsService(services.database, services.config),
271
329
  pictures,
272
330
  config: services.config,
273
331
  enrollment,
274
332
  workspaces,
333
+ deletion: createAccountDeletionService(services.database),
275
334
  resolveIdentity,
276
335
  resolveSession,
277
336
  requireActiveSession,
337
+ requireAccountSession,
278
338
  authenticatedMutationLimiter
279
339
  })
340
+ const reports = createDocumentReportService(services.database, {
341
+ sharing,
342
+ email: services.transactionalEmail,
343
+ adminRecipients: services.config.enrollmentAdminNotificationEmails,
344
+ publicURL: services.config.publicURL
345
+ })
280
346
  const cloudAPI = createCloudAPIRouter({
281
347
  collaboration,
282
348
  database: services.database,
@@ -284,8 +350,9 @@ export function createCloudApp(services: CloudServices) {
284
350
  documents,
285
351
  versions,
286
352
  entitlements,
287
- aiTokens,
353
+ servicesTokens,
288
354
  sharing,
355
+ reports,
289
356
  workspaces,
290
357
  workspaceMembers,
291
358
  resolveSession
@@ -296,6 +363,7 @@ export function createCloudApp(services: CloudServices) {
296
363
  versions,
297
364
  entitlements,
298
365
  sharing,
366
+ reports,
299
367
  workspaces,
300
368
  workspaceMembers,
301
369
  resolveSession
@@ -310,8 +378,17 @@ export function createCloudApp(services: CloudServices) {
310
378
  : new Hono()
311
379
 
312
380
  return new Hono<CloudEnvironment>()
381
+ .onError(cloudErrorHandler(services.reportError))
382
+ .use('*', cloudRequestId(services.forwardedRequestId))
313
383
  .use(CLOUD_DISCOVERY_PATH, cloudCORS)
314
384
  .use('/api/*', cloudCORS)
385
+ .use(
386
+ '/api/*',
387
+ bodyLimit({
388
+ maxSize: CLOUD_API_MAX_BODY_BYTES,
389
+ onError: (context) => context.json({ error: { code: 'invalid_request' as const } }, 413)
390
+ })
391
+ )
315
392
  .use('*', async (context, next) => {
316
393
  await next()
317
394
  if (shouldPreventIndexing(context.req.path, services.config.indexingPolicy)) {
@@ -354,8 +431,8 @@ export function createCloudApp(services: CloudServices) {
354
431
  }
355
432
  })
356
433
  .get(CLOUD_DISCOVERY_PATH, (context) => context.json(discovery))
357
- .get(CLOUD_AI_JWKS_PATH, async (context) =>
358
- aiTokens ? context.json(aiTokens.jwks()) : context.notFound()
434
+ .get(CLOUD_SERVICES_JWKS_PATH, async (context) =>
435
+ servicesTokens ? context.json(servicesTokens.jwks()) : context.notFound()
359
436
  )
360
437
  .on(['GET', 'POST'], `${AUTH_BASE_PATH}/*`, (context) => services.auth.handler(context.req.raw))
361
438
  .route('/', accountRoutes)
@@ -366,6 +443,7 @@ export function createCloudApp(services: CloudServices) {
366
443
  .use('/api/invitations/*', publicRateLimiter)
367
444
  .route('/api', publicCloudAPI)
368
445
  .route('/api/internal', internalAPI)
446
+ .use('/api/documents/:documentId', allowLeavingRead)
369
447
  .use('/api/*', requireActiveSession)
370
448
  .route('/api/admin', admin)
371
449
  .use('/api/*', authenticatedMutationLimiter)
@@ -0,0 +1,63 @@
1
+ import type { DocumentPermission, WorkspaceRole } from '#cloud/contract'
2
+ import { createAccessControl } from 'better-auth/plugins/access'
3
+
4
+ export const accessStatements = {
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']
8
+ } as const
9
+
10
+ type AccessStatements = typeof accessStatements
11
+
12
+ /** Actions a check asks for, by resource; every listed action must be allowed. */
13
+ export type AccessRequest = {
14
+ [Resource in keyof AccessStatements]?: AccessStatements[Resource][number][]
15
+ }
16
+
17
+ export const accessControl = createAccessControl(accessStatements)
18
+
19
+ /**
20
+ * What a workspace member may do there, by role. Together with `documentRoles` this is the whole
21
+ * permission policy: every check goes through `workspaceRoleCan` or `documentRoleCan`.
22
+ */
23
+ export const workspaceRoles = {
24
+ admin: accessControl.newRole({
25
+ workspace: ['read', 'update', 'delete', 'invite', 'manage-members'],
26
+ document: ['create', 'read', 'edit', 'share', 'delete', 'purge']
27
+ }),
28
+ editor: accessControl.newRole({
29
+ workspace: ['read'],
30
+ document: ['create', 'read', 'edit', 'share', 'delete']
31
+ }),
32
+ viewer: accessControl.newRole({
33
+ workspace: ['read'],
34
+ document: ['read']
35
+ })
36
+ } satisfies Record<WorkspaceRole, unknown>
37
+
38
+ /**
39
+ * What someone may do with one document through something other than workspace membership: being
40
+ * its owner, or a grant made to them. A grant lets its holder edit and share, never delete the
41
+ * owner's document. Deleting from Trash for good is for the owner and workspace administrators.
42
+ */
43
+ 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
+ }
48
+
49
+ export type DocumentRole = keyof typeof documentRoles
50
+
51
+ /** The document role a direct grant of this permission gives. */
52
+ export const GRANT_DOCUMENT_ROLE: Record<DocumentPermission, DocumentRole> = {
53
+ view: 'viewer',
54
+ edit: 'editor'
55
+ }
56
+
57
+ export function workspaceRoleCan(role: WorkspaceRole, request: AccessRequest): boolean {
58
+ return workspaceRoles[role].authorize(request).success
59
+ }
60
+
61
+ export function documentRoleCan(role: DocumentRole, request: AccessRequest): boolean {
62
+ return documentRoles[role].authorize(request).success
63
+ }
@@ -38,6 +38,11 @@ export interface CloudAuthAdapter {
38
38
  handler(request: Request): Promise<Response>
39
39
  resolveIdentity(headers: Headers): Promise<CloudIdentity | null>
40
40
  resolveSession(headers: Headers): Promise<CloudActor | null>
41
+ /**
42
+ * The signed-in person while their account is approved, whether or not it accepted the current
43
+ * terms: enough to leave, by downloading its documents and deleting the account.
44
+ */
45
+ resolveAccountSession(headers: Headers): Promise<CloudActor | null>
41
46
  listAuthenticationMethods(headers: Headers): Promise<CloudAuthenticationMethodRecord[]>
42
47
  changePassword(
43
48
  headers: Headers,
@@ -74,6 +79,12 @@ export interface CloudAuthAdapter {
74
79
  revokeSession(headers: Headers, sessionId: string): Promise<void>
75
80
  revokeOtherSessions(headers: Headers): Promise<void>
76
81
  signIns(headers: Headers): Promise<CloudSignIn[] | null>
82
+ /**
83
+ * Deletes the signed-in account through Better Auth, after Cloud removes what it keeps about
84
+ * it; a session that signed in a while ago gives its password. Answers the headers that clear the
85
+ * session cookie.
86
+ */
87
+ deleteAccount(headers: Headers, password?: string): Promise<Headers>
77
88
  migrate: () => Promise<void>
78
89
  schemaVersion: string
79
90
  }
@@ -15,12 +15,14 @@ type CorePaths<Names extends keyof typeof BetterAuthEndpoints> = {
15
15
 
16
16
  /**
17
17
  * The core endpoints whose paths Better Auth's own options need before it is built: rate limits,
18
- * captcha, and the hooks that record sign-ins. Plugin endpoints come from the plugin objects and
18
+ * captcha, disabled paths, and the hooks that record sign-ins. Plugin endpoints come from the plugin objects and
19
19
  * the rest from `auth.api`; these few are written out, and the type check holds each to the path
20
20
  * the library declares, so a renamed endpoint fails to compile.
21
21
  */
22
22
  export const CORE_AUTH_PATHS: CorePaths<
23
23
  | 'callbackOAuth'
24
+ | 'deleteUser'
25
+ | 'deleteUserCallback'
24
26
  | 'requestPasswordReset'
25
27
  | 'sendVerificationEmail'
26
28
  | 'signInEmail'
@@ -28,6 +30,8 @@ export const CORE_AUTH_PATHS: CorePaths<
28
30
  | 'verifyEmail'
29
31
  > = {
30
32
  callbackOAuth: '/callback/:id',
33
+ deleteUser: '/delete-user',
34
+ deleteUserCallback: '/delete-user/callback',
31
35
  requestPasswordReset: '/request-password-reset',
32
36
  sendVerificationEmail: '/send-verification-email',
33
37
  signInEmail: '/sign-in/email',
@@ -1,4 +1,6 @@
1
1
  import { createEnrollmentService, type EnrollmentService } from '#cloud/admin/enrollment/service'
2
+ import { accountDeletionOptions } from '#cloud/server/account/deletion'
3
+ import { createTermsService } from '#cloud/server/account/terms'
2
4
  import type { CloudServerConfig } from '#cloud/server/config'
3
5
  import type { CloudDatabase } from '#cloud/server/db'
4
6
  import { createUserPictures, providerPictures } from '#cloud/server/pictures'
@@ -86,6 +88,7 @@ export function createBetterAuthAdapter(
86
88
  ): CloudAuthAdapter {
87
89
  const authenticationEmail = runtime.email
88
90
  const assurance = createMFAAssuranceService(database, config)
91
+ const terms = createTermsService(database, config)
89
92
  const activity = createSignInActivity(database, authenticationEmail)
90
93
  // A new address is confirmed through a link sent to it, so changing one needs email delivery.
91
94
  const emailChangeAvailable = Boolean(config.emailPasswordEnabled && authenticationEmail)
@@ -115,12 +118,16 @@ export function createBetterAuthAdapter(
115
118
  baseURL: config.publicURL,
116
119
  basePath: AUTH_BASE_PATH,
117
120
  // Clients never reach Better Auth's own administration, which `/api/admin` replaces with MFA,
118
- // origin, last-administrator, and audit checks, nor the two endpoints Cloud's policy manages
121
+ // origin, last-administrator, and audit checks, nor the endpoints Cloud's policy manages
119
122
  // through its account routes; the server still calls them itself.
120
123
  disabledPaths: [
121
124
  ...Object.values(administration.endpoints).map((endpoint) => endpoint.path),
122
125
  passkeys.endpoints.deletePasskey.path,
123
- twoStep.endpoints.disableTwoFactor.path
126
+ twoStep.endpoints.disableTwoFactor.path,
127
+ // Accounts are deleted through `/api/account/delete`, which an account awaiting approval
128
+ // cannot reach either.
129
+ CORE_AUTH_PATHS.deleteUser,
130
+ CORE_AUTH_PATHS.deleteUserCallback
124
131
  ],
125
132
  secret: config.authSecret,
126
133
  database: {
@@ -224,6 +231,7 @@ export function createBetterAuthAdapter(
224
231
  : undefined,
225
232
  user: {
226
233
  changeEmail: { enabled: emailChangeAvailable },
234
+ deleteUser: accountDeletionOptions(database),
227
235
  validateUserInfo: ({ source }) => {
228
236
  if (source.action === 'create-user' && config.enrollmentMode === 'closed') {
229
237
  return { error: 'enrollment_closed', errorDescription: 'Cloud enrollment is closed' }
@@ -331,8 +339,18 @@ export function createBetterAuthAdapter(
331
339
  })
332
340
  }
333
341
 
334
- /** The signed-in person while their account may use the server, which awaiting approval it may not. */
342
+ /**
343
+ * The signed-in person while their account may use the server: not while it awaits approval, nor
344
+ * before it accepted the deployment's current terms when those are required.
345
+ */
335
346
  async function resolveSession(headers: Headers) {
347
+ const identity = await resolveAccountSession(headers)
348
+ if (!identity || !(await terms.hasAccepted(identity.userId))) return null
349
+ return identity
350
+ }
351
+
352
+ /** The signed-in person while their account is approved, before or after accepting the terms. */
353
+ async function resolveAccountSession(headers: Headers) {
336
354
  const identity = await resolveIdentity(headers)
337
355
  if (!identity) return null
338
356
  if (config.enrollmentMode === 'approval' && !(await enrollment.isApproved(identity.email))) {
@@ -391,6 +409,7 @@ export function createBetterAuthAdapter(
391
409
  },
392
410
  resolveIdentity,
393
411
  resolveSession,
412
+ resolveAccountSession,
394
413
  async listAuthenticationMethods(headers) {
395
414
  const accounts = await auth.api.listUserAccounts({ headers })
396
415
  return accounts.map((account) => ({
@@ -428,6 +447,14 @@ export function createBetterAuthAdapter(
428
447
  })
429
448
  return response.url
430
449
  },
450
+ async deleteAccount(headers, password) {
451
+ const { headers: answer } = await auth.api.deleteUser({
452
+ headers,
453
+ body: password ? { password } : {},
454
+ returnHeaders: true
455
+ })
456
+ return answer
457
+ },
431
458
  async unlinkAuthenticationMethod(headers, methodId) {
432
459
  await auth.api.unlinkAccount({ headers, body: { accountId: methodId } })
433
460
  },
@@ -14,4 +14,13 @@ export {
14
14
  type CloudSessionResolver
15
15
  } from './session'
16
16
  export type { CloudIdentity } from './adapter'
17
- export { workspaceAccessControl, workspaceRoles, workspaceStatements } from './workspace-access'
17
+ export {
18
+ accessControl,
19
+ accessStatements,
20
+ documentRoleCan,
21
+ documentRoles,
22
+ workspaceRoleCan,
23
+ workspaceRoles,
24
+ type AccessRequest,
25
+ type DocumentRole
26
+ } from './access-control'
@@ -1,5 +1,6 @@
1
1
  import type { CloudServerConfig } from '#cloud/server/config'
2
2
  import type { CloudDatabase } from '#cloud/server/db'
3
+ import type { CloudErrorReporter } from '#cloud/server/errors'
3
4
  import type { ObjectStore } from '#cloud/server/objects'
4
5
  import type { CloudPolicy } from '#cloud/server/policy/policy'
5
6
  import { createRateLimitCleanupService } from '#cloud/server/rate-limit/cleanup'
@@ -10,19 +11,24 @@ import { createRevisionCompactionService } from './revisions'
10
11
  import { createUploadCleanupService } from './uploads'
11
12
  import type { CleanupPassOptions, CleanupServices } from './worker'
12
13
 
13
- /** Every cleanup service, over a deployment's database and bucket. */
14
+ /**
15
+ * Every cleanup service, over a deployment's database and bucket. Each reports what it couldn't
16
+ * clean through `reportError`, where a deployment tracks errors, and carries on with the rest.
17
+ */
14
18
  export function createCleanupServices(
15
19
  config: Pick<CloudServerConfig, 'deployment'>,
16
20
  database: Kysely<CloudDatabase>,
17
21
  objects: ObjectStore,
18
- policy: CloudPolicy
22
+ policy: CloudPolicy,
23
+ reportError?: CloudErrorReporter
19
24
  ): CleanupServices {
20
25
  return {
21
- uploads: createUploadCleanupService(database, objects),
22
- documents: createDocumentCleanupService(database, objects),
26
+ uploads: createUploadCleanupService(database, objects, reportError),
27
+ documents: createDocumentCleanupService(database, objects, { reportError }),
23
28
  revisions: createRevisionCompactionService(database, objects, {
24
29
  policy,
25
- deploymentMode: config.deployment
30
+ deploymentMode: config.deployment,
31
+ reportError
26
32
  }),
27
33
  rateLimits: createRateLimitCleanupService(database)
28
34
  }
@@ -33,6 +39,7 @@ export function cleanupPassOptions(config: CloudServerConfig): CleanupPassOption
33
39
  return {
34
40
  batchSize: config.cleanupBatchSize,
35
41
  documentRetentionMs: config.documentRetentionMs,
42
+ documentPurgeGraceMs: config.documentPurgeGraceMs,
36
43
  leaseDurationMs: config.cleanupLeaseDurationMs
37
44
  }
38
45
  }