@open-pencil/cloud 0.17.0-beta.2 → 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 (223) 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 +469 -65
  17. package/dist/index.d.ts.map +1 -1
  18. package/dist/listen.mjs +505 -787
  19. package/dist/listen.mjs.map +1 -1
  20. package/dist/runtime-node.d.mts +3920 -2524
  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 +3586 -1897
  25. package/dist/server.d.ts.map +1 -1
  26. package/dist/server.js +5216 -4272
  27. package/dist/server.js.map +1 -1
  28. package/dist/server.mjs +5179 -3623
  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 +7 -6
  33. package/src/admin/api/routes.ts +59 -0
  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 +22 -11
  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 +62 -14
  66. package/src/runtime/cloudflare/worker.ts +39 -13
  67. package/src/runtime/node/application.ts +5 -3
  68. package/src/runtime/node/bootstrap.ts +15 -4
  69. package/src/runtime/node/cleanup.ts +16 -3
  70. package/src/runtime/node/entitlements/main.ts +14 -11
  71. package/src/runtime/node/index.ts +1 -1
  72. package/src/runtime/node/migrate.ts +5 -1
  73. package/src/runtime/node/relay.ts +8 -2
  74. package/src/runtime/node/request-id.ts +13 -0
  75. package/src/runtime/node/server.ts +39 -15
  76. package/src/runtime/node/{ai-relay → services}/main.ts +6 -6
  77. package/src/runtime/node/{ai-relay → services}/server.ts +18 -18
  78. package/src/runtime/postgres/database.ts +20 -1
  79. package/src/runtime/posthog/errors.ts +15 -31
  80. package/src/runtime/s3/objects.ts +24 -1
  81. package/src/runtime/site/server.ts +32 -5
  82. package/src/server/account/actions.ts +5 -0
  83. package/src/server/account/deletion.ts +302 -0
  84. package/src/server/account/routes.ts +47 -3
  85. package/src/server/account/terms.ts +42 -0
  86. package/src/server/api/router.ts +9 -5
  87. package/src/server/api/types.ts +2 -0
  88. package/src/server/app.ts +90 -16
  89. package/src/server/auth/access-control.ts +63 -0
  90. package/src/server/auth/adapter.ts +11 -0
  91. package/src/server/auth/endpoints.ts +5 -1
  92. package/src/server/auth/factory.ts +30 -3
  93. package/src/server/auth/index.ts +10 -1
  94. package/src/server/cleanup/configured.ts +12 -5
  95. package/src/server/cleanup/documents.ts +165 -71
  96. package/src/server/cleanup/revisions.ts +16 -5
  97. package/src/server/cleanup/uploads.ts +8 -2
  98. package/src/server/cleanup/worker.ts +5 -2
  99. package/src/server/collaboration/relay/connection.ts +4 -3
  100. package/src/server/collaboration/relay/documents.ts +13 -10
  101. package/src/server/collaboration/relay/hub.ts +97 -25
  102. package/src/server/collaboration/relay/log.ts +5 -2
  103. package/src/server/collaboration/service.ts +27 -31
  104. package/src/server/config/deployment.ts +24 -4
  105. package/src/server/config/public.ts +5 -4
  106. package/src/server/config/schema.ts +82 -16
  107. package/src/server/db/expressions.ts +15 -1
  108. package/src/server/db/migrate.ts +34 -116
  109. package/src/server/db/migrations/001_accounts.ts +79 -0
  110. package/src/server/db/migrations/002_workspaces.ts +48 -0
  111. package/src/server/db/migrations/003_storage.ts +44 -0
  112. package/src/server/db/migrations/004_documents.ts +193 -0
  113. package/src/server/db/migrations/005_sharing.ts +95 -0
  114. package/src/server/db/migrations/006_operations.ts +110 -0
  115. package/src/server/db/migrations/007_trash.ts +33 -0
  116. package/src/server/db/migrations/008_terms.ts +18 -0
  117. package/src/server/db/migrations/schema.ts +71 -0
  118. package/src/server/db/tables.ts +52 -3
  119. package/src/server/documents/access.ts +66 -55
  120. package/src/server/documents/errors.ts +7 -0
  121. package/src/server/documents/images.ts +2 -1
  122. package/src/server/documents/limits.ts +9 -9
  123. package/src/server/documents/purge.ts +75 -0
  124. package/src/server/documents/repository.ts +2 -0
  125. package/src/server/documents/routes.ts +26 -0
  126. package/src/server/documents/service.ts +18 -4
  127. package/src/server/documents/summary.ts +1 -0
  128. package/src/server/documents/trash.ts +203 -0
  129. package/src/server/documents/versions/checkpoint.ts +2 -1
  130. package/src/server/documents/versions/history.ts +11 -7
  131. package/src/server/documents/versions/service.ts +13 -4
  132. package/src/server/errors/index.ts +59 -16
  133. package/src/server/errors/posthog.ts +80 -0
  134. package/src/server/index.ts +46 -17
  135. package/src/server/internal/index.ts +3 -3
  136. package/src/server/internal/routes.ts +7 -10
  137. package/src/server/internal/schema.ts +1 -1
  138. package/src/server/internal/service.ts +17 -23
  139. package/src/server/invitations/budget.ts +66 -0
  140. package/src/server/invitations/index.ts +1 -0
  141. package/src/server/logging.ts +76 -0
  142. package/src/server/pictures/service.ts +2 -1
  143. package/src/server/policy/database.ts +39 -25
  144. package/src/server/policy/index.ts +2 -1
  145. package/src/server/policy/keys.ts +5 -2
  146. package/src/server/policy/policy.ts +1 -0
  147. package/src/server/policy/schema.ts +2 -2
  148. package/src/server/policy/service.ts +12 -9
  149. package/src/server/policy/static.ts +5 -5
  150. package/src/server/policy/workspace.ts +41 -0
  151. package/src/server/quota/reconcile.ts +2 -0
  152. package/src/server/quota/storage.ts +69 -31
  153. package/src/server/rate-limit/cleanup.ts +17 -5
  154. package/src/server/rate-limit/middleware.ts +2 -2
  155. package/src/server/reports/index.ts +8 -0
  156. package/src/server/reports/routes.ts +37 -0
  157. package/src/server/reports/service.ts +123 -0
  158. package/src/server/services/errors.ts +7 -0
  159. package/src/server/services/index.ts +8 -0
  160. package/src/server/{ai → services}/keys.ts +11 -11
  161. package/src/server/services/routes.ts +47 -0
  162. package/src/server/{ai/service.ts → services/tokens.ts} +23 -20
  163. package/src/server/sharing/capabilities/service.ts +68 -22
  164. package/src/server/sharing/grants/service.ts +11 -18
  165. package/src/server/sharing/http.ts +4 -0
  166. package/src/server/sharing/invitations/service.ts +21 -11
  167. package/src/server/sharing/policy.ts +9 -14
  168. package/src/server/sharing/routes.ts +0 -16
  169. package/src/server/sharing/service.ts +1 -17
  170. package/src/server/validation.ts +1 -0
  171. package/src/server/workspaces/index.ts +1 -0
  172. package/src/server/workspaces/members.ts +89 -38
  173. package/src/server/workspaces/repository.ts +2 -1
  174. package/src/server/workspaces/routes.ts +4 -0
  175. package/src/{ai-relay → services}/app.ts +48 -44
  176. package/src/{ai-relay → services}/config.ts +25 -19
  177. package/src/services/db/index.ts +10 -0
  178. package/src/services/db/migrate.ts +37 -0
  179. package/src/{ai-relay/db/migrations/001_usage.ts → services/db/migrations/001_baseline.ts} +18 -7
  180. package/src/services/db/schema.ts +22 -0
  181. package/src/services/index.ts +18 -0
  182. package/src/{ai-relay → services}/metering.ts +2 -2
  183. package/src/{ai-relay → services}/usage.ts +43 -19
  184. package/dist/bin/ai-relay.mjs.map +0 -1
  185. package/src/ai-relay/db/index.ts +0 -10
  186. package/src/ai-relay/db/migrate.ts +0 -32
  187. package/src/ai-relay/db/schema.ts +0 -20
  188. package/src/ai-relay/index.ts +0 -18
  189. package/src/contract/ai.ts +0 -150
  190. package/src/server/ai/errors.ts +0 -7
  191. package/src/server/ai/index.ts +0 -4
  192. package/src/server/ai/routes.ts +0 -43
  193. package/src/server/auth/workspace-access.ts +0 -23
  194. package/src/server/db/migrations/001_foundation.ts +0 -164
  195. package/src/server/db/migrations/002_upload_cleanup_claims.ts +0 -34
  196. package/src/server/db/migrations/003_document_cleanup_claims.ts +0 -23
  197. package/src/server/db/migrations/004_document_sharing.ts +0 -82
  198. package/src/server/db/migrations/005_document_collaboration_epoch.ts +0 -13
  199. package/src/server/db/migrations/006_invitation_continuation.ts +0 -27
  200. package/src/server/db/migrations/007_collaboration_state.ts +0 -25
  201. package/src/server/db/migrations/008_storage_reservations.ts +0 -37
  202. package/src/server/db/migrations/009_workspace_entitlements.ts +0 -22
  203. package/src/server/db/migrations/010_upload_finalization.ts +0 -22
  204. package/src/server/db/migrations/011_upload_finalization_lease.ts +0 -12
  205. package/src/server/db/migrations/012_transactional_email.ts +0 -48
  206. package/src/server/db/migrations/013_admin_enrollment.ts +0 -54
  207. package/src/server/db/migrations/014_enrollment_email_kinds.ts +0 -30
  208. package/src/server/db/migrations/015_cloud_rate_limit.ts +0 -22
  209. package/src/server/db/migrations/016_auth_schema.ts +0 -16
  210. package/src/server/db/migrations/017_authentication_email_kinds.ts +0 -32
  211. package/src/server/db/migrations/018_authentication_mfa.ts +0 -78
  212. package/src/server/db/migrations/019_better_auth_account_issuer.ts +0 -42
  213. package/src/server/db/migrations/020_workspace_invitations.ts +0 -57
  214. package/src/server/db/migrations/021_document_versions.ts +0 -66
  215. package/src/server/db/migrations/022_entitlement_external_version.ts +0 -17
  216. package/src/server/db/migrations/023_document_images.ts +0 -61
  217. package/src/server/db/migrations/024_account_activity.ts +0 -66
  218. package/src/server/db/migrations/025_table_names.ts +0 -58
  219. package/src/server/db/migrations/026_user_picture.ts +0 -30
  220. package/src/server/db/migrations/027_document_kind.ts +0 -19
  221. package/src/server/db/migrations/028_collaboration_updates.ts +0 -84
  222. package/src/server/db/migrations/helpers.ts +0 -78
  223. /package/dist/bin/{ai-relay.d.mts → services.d.mts} +0 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@open-pencil/cloud",
3
- "version": "0.17.0-beta.2",
3
+ "version": "0.17.0-beta.4",
4
4
  "license": "Apache-2.0 AND MIT",
5
5
  "files": [
6
6
  "dist",
@@ -10,7 +10,7 @@
10
10
  "LICENSE-MIT"
11
11
  ],
12
12
  "bin": {
13
- "openpencil-ai-relay": "./dist/bin/ai-relay.mjs",
13
+ "openpencil-services": "./dist/bin/services.mjs",
14
14
  "openpencil-cloud": "./dist/bin/server.mjs"
15
15
  },
16
16
  "dependencies": {
@@ -22,7 +22,7 @@
22
22
  "@hono/node-server": "^1.19.17",
23
23
  "@internationalized/date": "^3.12.3",
24
24
  "@noble/hashes": "^2.4.0",
25
- "@open-pencil/scene-graph": "^0.17.0-beta.2",
25
+ "@open-pencil/scene-graph": "^0.17.0-beta.4",
26
26
  "@openfeature/server-sdk": "^1.23.0",
27
27
  "@vue-email/components": "^0.0.21",
28
28
  "@vue-email/render": "^0.0.9",
@@ -84,14 +84,13 @@
84
84
  },
85
85
  "imports": {
86
86
  "#cloud/admin": "./src/admin/index.ts",
87
- "#cloud/ai-relay": "./src/ai-relay/index.ts",
87
+ "#cloud/services": "./src/services/index.ts",
88
88
  "#cloud/client": "./src/client/index.ts",
89
89
  "#cloud/contract": "./src/contract/index.ts",
90
90
  "#cloud/email": "./src/email/index.ts",
91
91
  "#cloud/runtime/cloudflare": "./src/runtime/cloudflare/index.ts",
92
92
  "#cloud/runtime/node": "./src/runtime/node/index.ts",
93
93
  "#cloud/server": "./src/server/index.ts",
94
- "#cloud/server/ai": "./src/server/ai/index.ts",
95
94
  "#cloud/server/api": "./src/server/api/index.ts",
96
95
  "#cloud/server/auth": "./src/server/auth/index.ts",
97
96
  "#cloud/server/cleanup": "./src/server/cleanup/index.ts",
@@ -109,12 +108,14 @@
109
108
  "#cloud/server/policy": "./src/server/policy/index.ts",
110
109
  "#cloud/server/quota": "./src/server/quota/index.ts",
111
110
  "#cloud/server/rate-limit": "./src/server/rate-limit/index.ts",
111
+ "#cloud/server/reports": "./src/server/reports/index.ts",
112
+ "#cloud/server/services": "./src/server/services/index.ts",
112
113
  "#cloud/server/sharing": "./src/server/sharing/index.ts",
113
114
  "#cloud/server/workspaces": "./src/server/workspaces/index.ts",
114
115
  "#cloud/*": "./src/*.ts",
115
116
  "#cloud-tests/*": "./tests/*.ts"
116
117
  },
117
- "description": "Self-hostable OpenPencil Cloud: accounts, workspaces, document revisions, sharing, collaboration, and the AI relay, for Node and Cloudflare Workers.",
118
+ "description": "Self-hostable OpenPencil Cloud: accounts, workspaces, document revisions, sharing, collaboration, and the services server, for Node and Cloudflare Workers.",
118
119
  "repository": {
119
120
  "type": "git",
120
121
  "url": "git+https://github.com/open-pencil/open-pencil.git",
@@ -1,11 +1,14 @@
1
1
  import { requireTrustedMutationOrigin } from '#cloud/admin/api/security'
2
2
  import type { AdminAuditService } from '#cloud/admin/audit/service'
3
+ import type { AdminDocumentService } from '#cloud/admin/documents/service'
3
4
  import type { AdminEmailService } from '#cloud/admin/email/service'
4
5
  import type { EnrollmentService } from '#cloud/admin/enrollment/service'
5
6
  import { adminErrorStatus, AdminDomainError } from '#cloud/admin/errors'
6
7
  import type { AdminOperationsService } from '#cloud/admin/operations/service'
8
+ import type { AdminReportService } from '#cloud/admin/reports/service'
7
9
  import {
8
10
  enrollmentStatusSchema,
11
+ parseDocumentTakedown,
9
12
  parseEnrollmentReview,
10
13
  parseUserMutation,
11
14
  parseUserRoleMutation
@@ -13,7 +16,9 @@ import {
13
16
  import type { AdminUserService } from '#cloud/admin/users/service'
14
17
  import {
15
18
  cloudAdminAuditFilterSchema,
19
+ cloudAdminDocumentFilterSchema,
16
20
  cloudAdminEmailFilterSchema,
21
+ cloudAdminReportFilterSchema,
17
22
  cloudAdminUserFilterSchema
18
23
  } from '#cloud/contract'
19
24
  import type { CloudAPIEnvironment } from '#cloud/server/api'
@@ -44,6 +49,8 @@ const parseEnrollmentQuery = listQuery(enrollmentStatusSchema)
44
49
  const parseUserQuery = listQuery(cloudAdminUserFilterSchema)
45
50
  const parseEmailQuery = listQuery(cloudAdminEmailFilterSchema)
46
51
  const parseAuditQuery = listQuery(cloudAdminAuditFilterSchema)
52
+ const parseDocumentQuery = listQuery(cloudAdminDocumentFilterSchema)
53
+ const parseReportQuery = listQuery(cloudAdminReportFilterSchema)
47
54
  /** Accounts are named by UUID; anything else names no one, rather than failing the query. */
48
55
  const accountIdSchema = v.pipe(v.string(), v.uuid())
49
56
 
@@ -66,6 +73,8 @@ export type CloudAdminServices = {
66
73
  users: AdminUserService
67
74
  audit: AdminAuditService
68
75
  operations: AdminOperationsService
76
+ documents: AdminDocumentService
77
+ reports: AdminReportService
69
78
  }
70
79
 
71
80
  export function createCloudAdminRoutes(
@@ -228,6 +237,56 @@ export function createCloudAdminRoutes(
228
237
  context.json(await services.audit.list(context.req.valid('query')))
229
238
  )
230
239
  .get('/operations', async (context) => context.json(await services.operations.summary()))
240
+ .get('/reports', validatedQuery(parseReportQuery), async (context) =>
241
+ context.json(await services.reports.list(context.req.valid('query')))
242
+ )
243
+ .post('/reports/:id/dismiss', idParams, async (context) => {
244
+ await services.reports.resolve(
245
+ context.get('actor').userId,
246
+ context.req.valid('param').id,
247
+ 'dismissed'
248
+ )
249
+ return context.json({ ok: true as const })
250
+ })
251
+ .post('/reports/:id/action', idParams, async (context) => {
252
+ await services.reports.resolve(
253
+ context.get('actor').userId,
254
+ context.req.valid('param').id,
255
+ 'actioned'
256
+ )
257
+ return context.json({ ok: true as const })
258
+ })
259
+ .get('/documents', validatedQuery(parseDocumentQuery), async (context) =>
260
+ context.json(await services.documents.list(context.req.valid('query')))
261
+ )
262
+ .post(
263
+ '/documents/:id/disable',
264
+ idParams,
265
+ validatedJSON(parseDocumentTakedown),
266
+ async (context) => {
267
+ await services.documents.disable(
268
+ context.get('actor').userId,
269
+ context.req.valid('param').id,
270
+ context.req.valid('json').reason
271
+ )
272
+ return context.json({ ok: true as const })
273
+ }
274
+ )
275
+ .post('/documents/:id/enable', idParams, async (context) => {
276
+ await services.documents.enable(context.get('actor').userId, context.req.valid('param').id)
277
+ return context.json({ ok: true as const })
278
+ })
279
+ .post('/documents/:id/undelete', idParams, async (context) => {
280
+ await services.documents.undelete(context.get('actor').userId, context.req.valid('param').id)
281
+ return context.json({ ok: true as const })
282
+ })
283
+ .post('/shares/:id/revoke', idParams, async (context) => {
284
+ await services.documents.revokeShare(
285
+ context.get('actor').userId,
286
+ context.req.valid('param').id
287
+ )
288
+ return context.json({ ok: true as const })
289
+ })
231
290
  }
232
291
 
233
292
  /** The administration routes' types, for the portal's typed client. */
@@ -17,7 +17,13 @@ const FILTERS: ListFilters<CloudAdminAuditFilter, 'adminAuditEvent'> = {
17
17
  all: (expression) => expression.lit(true),
18
18
  accounts: (expression) => expression('adminAuditEvent.subjectType', '=', 'user'),
19
19
  requests: (expression) => expression('adminAuditEvent.subjectType', '=', 'enrollment'),
20
- email: (expression) => expression('adminAuditEvent.subjectType', '=', 'transactional-email')
20
+ email: (expression) => expression('adminAuditEvent.subjectType', '=', 'transactional-email'),
21
+ documents: (expression) =>
22
+ expression('adminAuditEvent.subjectType', 'in', [
23
+ 'document',
24
+ 'document-share',
25
+ 'document-report'
26
+ ])
21
27
  }
22
28
 
23
29
  type AuditExpression = ExpressionBuilder<CloudDatabase, 'adminAuditEvent'>
@@ -96,7 +102,10 @@ export function createAdminAuditService(database: Kysely<CloudDatabase>) {
96
102
  const enrollmentIds = uniq(
97
103
  events.flatMap((event) => (event.subjectType === 'enrollment' ? [event.subjectId] : []))
98
104
  ).filter(isUUID)
99
- const [users, enrollments] = await Promise.all([
105
+ const documentIds = uniq(
106
+ events.flatMap((event) => (event.subjectType === 'document' ? [event.subjectId] : []))
107
+ ).filter(isUUID)
108
+ const [users, enrollments, documents] = await Promise.all([
100
109
  userIds.length
101
110
  ? database.selectFrom('user').select(['id', 'name']).where('id', 'in', userIds).execute()
102
111
  : [],
@@ -106,8 +115,16 @@ export function createAdminAuditService(database: Kysely<CloudDatabase>) {
106
115
  .select(['id', 'name', 'emailNormalized'])
107
116
  .where('id', 'in', enrollmentIds)
108
117
  .execute()
118
+ : [],
119
+ documentIds.length
120
+ ? database
121
+ .selectFrom('document')
122
+ .select(['id', 'name'])
123
+ .where('id', 'in', documentIds)
124
+ .execute()
109
125
  : []
110
126
  ])
127
+ const documentNames = new Map(documents.map((document) => [document.id, document.name]))
111
128
  const names = new Map(users.map((user) => [user.id, user.name]))
112
129
  const requesters = new Map(
113
130
  enrollments.map((enrollment) => [
@@ -115,6 +132,11 @@ export function createAdminAuditService(database: Kysely<CloudDatabase>) {
115
132
  enrollment.name ?? enrollment.emailNormalized
116
133
  ])
117
134
  )
135
+ const subjectName = (type: string, id: string) => {
136
+ if (type === 'enrollment') return requesters.get(id)
137
+ if (type === 'document') return documentNames.get(id)
138
+ return names.get(id)
139
+ }
118
140
  const rows = events.map((event) => ({
119
141
  id: event.id,
120
142
  actor: { id: event.actorUserId, name: names.get(event.actorUserId) ?? null },
@@ -122,10 +144,7 @@ export function createAdminAuditService(database: Kysely<CloudDatabase>) {
122
144
  subject: {
123
145
  type: event.subjectType,
124
146
  id: event.subjectId,
125
- name:
126
- (event.subjectType === 'enrollment'
127
- ? requesters.get(event.subjectId)
128
- : names.get(event.subjectId)) ?? null
147
+ name: subjectName(event.subjectType, event.subjectId) ?? null
129
148
  },
130
149
  metadata: event.metadata,
131
150
  createdAt: event.createdAt
@@ -0,0 +1,361 @@
1
+ import { AdminDomainError } from '#cloud/admin/errors'
2
+ import {
3
+ containsPattern,
4
+ countEachFilter,
5
+ listSearch,
6
+ listWindow,
7
+ type AdminListQuery,
8
+ type ListFilters
9
+ } from '#cloud/admin/list'
10
+ import { isUUID } from '#cloud/admin/schema'
11
+ import {
12
+ cloudAdminDocumentFilterSchema,
13
+ type CloudAdminDocument,
14
+ type CloudAdminDocumentFilter
15
+ } from '#cloud/contract'
16
+ import type { CloudDatabase } from '#cloud/server/db'
17
+ import { unmarkPurged } from '#cloud/server/documents/purge'
18
+ import { dateString } from '#cloud/server/sharing/contracts'
19
+ import { uniq } from 'es-toolkit'
20
+ import type { ExpressionBuilder, Kysely, Transaction } from 'kysely'
21
+
22
+ type DocumentExpression = ExpressionBuilder<CloudDatabase, 'document'>
23
+
24
+ /** Whether reports about the document are still waiting for a decision. */
25
+ const reported = (expression: DocumentExpression) =>
26
+ expression.exists(
27
+ expression
28
+ .selectFrom('documentReport')
29
+ .select('documentReport.id')
30
+ .whereRef('documentReport.documentId', '=', 'document.id')
31
+ .where('documentReport.status', '=', 'open')
32
+ )
33
+
34
+ const live = (expression: DocumentExpression) => expression('document.deletedAt', 'is', null)
35
+
36
+ const FILTERS: ListFilters<CloudAdminDocumentFilter, 'document'> = {
37
+ all: live,
38
+ reported: (expression) => expression.and([live(expression), reported(expression)]),
39
+ disabled: (expression) =>
40
+ expression.and([live(expression), expression('document.disabledAt', 'is not', null)]),
41
+ purged: (expression) => expression('document.purgedAt', 'is not', null)
42
+ }
43
+
44
+ /**
45
+ * What the console lists: live documents, and those deleted forever an administrator can still
46
+ * restore, inside the grace and not yet being destroyed.
47
+ */
48
+ function listable(graceSince: Date) {
49
+ return (expression: DocumentExpression) =>
50
+ expression.or([
51
+ live(expression),
52
+ expression.and([
53
+ expression('document.purgedAt', '>', graceSince),
54
+ expression('document.cleanupClaimId', 'is', null)
55
+ ])
56
+ ])
57
+ }
58
+
59
+ /** Documents whose name, ID, or maker's name or email has the search in it. */
60
+ function searchCondition(search: string) {
61
+ const pattern = containsPattern(search)
62
+ return (expression: DocumentExpression) =>
63
+ expression.or([
64
+ expression('document.name', 'ilike', pattern),
65
+ expression(expression.cast('document.id', 'text'), '=', search.toLowerCase()),
66
+ expression.exists(
67
+ expression
68
+ .selectFrom('user')
69
+ .select('user.id')
70
+ .where((inner) =>
71
+ inner(inner.cast('user.id', 'text'), '=', inner.ref('document.createdBy'))
72
+ )
73
+ .where((inner) =>
74
+ inner.or([inner('user.email', 'ilike', pattern), inner('user.name', 'ilike', pattern)])
75
+ )
76
+ )
77
+ ])
78
+ }
79
+
80
+ /**
81
+ * The documents with these IDs as the console shows them, in no particular order; with
82
+ * `purgeGraceMs`, when cleanup destroys one deleted forever.
83
+ */
84
+ export async function adminDocuments(
85
+ database: Kysely<CloudDatabase>,
86
+ documentIds: readonly string[],
87
+ purgeGraceMs?: number
88
+ ): Promise<Map<string, CloudAdminDocument>> {
89
+ const ids = uniq(documentIds).filter(isUUID)
90
+ if (ids.length === 0) return new Map()
91
+ const rows = await database
92
+ .selectFrom('document')
93
+ .innerJoin('workspace', 'workspace.id', 'document.workspaceId')
94
+ .select((expression) => [
95
+ 'document.id',
96
+ 'document.name',
97
+ 'document.createdBy',
98
+ 'document.createdAt',
99
+ 'document.updatedAt',
100
+ 'document.disabledAt',
101
+ 'document.disabledReason',
102
+ 'document.purgedAt',
103
+ 'workspace.id as workspaceId',
104
+ 'workspace.name as workspaceName',
105
+ expression
106
+ .selectFrom('documentReport')
107
+ .select((inner) => inner.fn.countAll<string>().as('count'))
108
+ .whereRef('documentReport.documentId', '=', 'document.id')
109
+ .where('documentReport.status', '=', 'open')
110
+ .as('openReports')
111
+ ])
112
+ .where('document.id', 'in', ids)
113
+ .execute()
114
+ const ownerIds = uniq(rows.map((row) => row.createdBy)).filter(isUUID)
115
+ const owners = ownerIds.length
116
+ ? await database
117
+ .selectFrom('user')
118
+ .select(['id', 'name', 'email'])
119
+ .where('id', 'in', ownerIds)
120
+ .execute()
121
+ : []
122
+ const ownerById = new Map(owners.map((owner) => [owner.id, owner]))
123
+ return new Map(
124
+ rows.map((row) => [
125
+ row.id,
126
+ {
127
+ id: row.id,
128
+ name: row.name,
129
+ workspace: { id: row.workspaceId, name: row.workspaceName },
130
+ owner: ownerById.get(row.createdBy) ?? null,
131
+ createdAt: dateString(row.createdAt) ?? '',
132
+ updatedAt: dateString(row.updatedAt) ?? '',
133
+ disabledAt: dateString(row.disabledAt),
134
+ disabledReason: row.disabledReason,
135
+ openReports: Number(row.openReports ?? 0),
136
+ purgedAt: dateString(row.purgedAt),
137
+ destroyedAt:
138
+ row.purgedAt === null || purgeGraceMs === undefined
139
+ ? null
140
+ : new Date(new Date(row.purgedAt).getTime() + purgeGraceMs).toISOString()
141
+ }
142
+ ])
143
+ )
144
+ }
145
+
146
+ type AuditDatabase = Kysely<CloudDatabase> | Transaction<CloudDatabase>
147
+
148
+ /** Records an administrator's action on a document, a link, or a report. */
149
+ export async function auditContentAction(
150
+ database: AuditDatabase,
151
+ actorId: string,
152
+ action: string,
153
+ subject: { type: 'document' | 'document-share' | 'document-report'; id: string },
154
+ metadata: Record<string, unknown> = {}
155
+ ): Promise<void> {
156
+ await database
157
+ .insertInto('adminAuditEvent')
158
+ .values({
159
+ id: crypto.randomUUID(),
160
+ actorUserId: actorId,
161
+ action,
162
+ subjectType: subject.type,
163
+ subjectId: subject.id,
164
+ metadata
165
+ })
166
+ .execute()
167
+ }
168
+
169
+ /** A document that is not deleted, held until the transaction ends; none is not found. */
170
+ function lockedDocument(transaction: Transaction<CloudDatabase>, documentId: string) {
171
+ return transaction
172
+ .selectFrom('document')
173
+ .select(['id', 'disabledAt'])
174
+ .where('id', '=', documentId)
175
+ .where('deletedAt', 'is', null)
176
+ .forUpdate()
177
+ .executeTakeFirstOrThrow()
178
+ }
179
+
180
+ export type AdminDocumentServiceOptions = {
181
+ /**
182
+ * Ends a taken-down document's live rooms, saving them, so a takedown reaches open tabs at once
183
+ * and a restore loses no edit.
184
+ */
185
+ closeRooms?: (documentId: string) => void
186
+ /** How long a document deleted forever waits before cleanup destroys it; 0 when not given. */
187
+ purgeGraceMs?: number
188
+ }
189
+
190
+ export function createAdminDocumentService(
191
+ database: Kysely<CloudDatabase>,
192
+ options: AdminDocumentServiceOptions = {}
193
+ ) {
194
+ const purgeGraceMs = options.purgeGraceMs ?? 0
195
+ const graceSince = (now: Date) => new Date(now.getTime() - purgeGraceMs)
196
+ return {
197
+ /** A page of documents, newest change first, and how many match the search under each filter. */
198
+ async list(query: AdminListQuery<CloudAdminDocumentFilter> = {}) {
199
+ const search = listSearch(query)
200
+ const filter = query.filter ?? 'all'
201
+ const { limit, offset } = listWindow(query)
202
+ let searched = database.selectFrom('document').where(listable(graceSince(new Date())))
203
+ if (search) searched = searched.where(searchCondition(search))
204
+ const counts = await countEachFilter(
205
+ searched,
206
+ cloudAdminDocumentFilterSchema.options,
207
+ FILTERS
208
+ )
209
+ const page = await searched
210
+ .where(FILTERS[filter])
211
+ .select('document.id')
212
+ .orderBy('document.updatedAt', 'desc')
213
+ .orderBy('document.id')
214
+ .limit(limit)
215
+ .offset(offset)
216
+ .execute()
217
+ const documents = await adminDocuments(
218
+ database,
219
+ page.map((row) => row.id),
220
+ purgeGraceMs
221
+ )
222
+ return {
223
+ documents: page.flatMap((row) => documents.get(row.id) ?? []),
224
+ total: counts[filter],
225
+ counts
226
+ }
227
+ },
228
+
229
+ /**
230
+ * Takes a document down: it opens for nobody, its owner included, its links stop working,
231
+ * and its live rooms close, saved. Its open reports count as acted on. Nothing is deleted and
232
+ * its collaboration epoch stays, so enabling it gives everything back, live edits included.
233
+ */
234
+ async disable(actorId: string, documentId: string, reason: string | undefined): Promise<void> {
235
+ await database.transaction().execute(async (transaction) => {
236
+ const document = await lockedDocument(transaction, documentId)
237
+ if (document.disabledAt) return
238
+ await transaction
239
+ .updateTable('document')
240
+ .set({ disabledAt: new Date(), disabledReason: reason ?? null })
241
+ .where('id', '=', documentId)
242
+ .execute()
243
+ await transaction
244
+ .updateTable('documentReport')
245
+ .set({ status: 'actioned', resolvedAt: new Date(), resolvedBy: actorId })
246
+ .where('documentId', '=', documentId)
247
+ .where('status', '=', 'open')
248
+ .execute()
249
+ await auditContentAction(
250
+ transaction,
251
+ actorId,
252
+ 'document.disabled',
253
+ { type: 'document', id: documentId },
254
+ reason ? { reason } : {}
255
+ )
256
+ })
257
+ options.closeRooms?.(documentId)
258
+ },
259
+
260
+ /** Puts a document taken down back where it was. */
261
+ async enable(actorId: string, documentId: string): Promise<void> {
262
+ await database.transaction().execute(async (transaction) => {
263
+ const document = await lockedDocument(transaction, documentId)
264
+ if (!document.disabledAt) return
265
+ await transaction
266
+ .updateTable('document')
267
+ .set({ disabledAt: null, disabledReason: null })
268
+ .where('id', '=', documentId)
269
+ .execute()
270
+ await auditContentAction(transaction, actorId, 'document.enabled', {
271
+ type: 'document',
272
+ id: documentId
273
+ })
274
+ })
275
+ },
276
+
277
+ /**
278
+ * Brings back a document someone deleted forever, while its grace lasts: it is live again in
279
+ * its workspace, not in Trash, and counts toward the workspace's storage again, over its plan
280
+ * or not. A document cleanup is destroying, or whose workspace has nobody left in it, can't be.
281
+ */
282
+ async undelete(actorId: string, documentId: string, now = new Date()): Promise<void> {
283
+ await database.transaction().execute(async (transaction) => {
284
+ const document = await transaction
285
+ .selectFrom('document')
286
+ .select(['id', 'workspaceId', 'purgedAt', 'purgedBytes', 'cleanupClaimId'])
287
+ .where('id', '=', documentId)
288
+ .forUpdate()
289
+ .executeTakeFirst()
290
+ // Cleanup may have destroyed it since the list was loaded.
291
+ if (
292
+ !document ||
293
+ document.purgedAt === null ||
294
+ document.cleanupClaimId !== null ||
295
+ new Date(document.purgedAt) <= graceSince(now)
296
+ ) {
297
+ throw new AdminDomainError(
298
+ 'document_not_restorable',
299
+ 'Only a document deleted forever, inside its grace, can be restored'
300
+ )
301
+ }
302
+ const member = await transaction
303
+ .selectFrom('workspaceMember')
304
+ .select('userId')
305
+ .where('workspaceId', '=', document.workspaceId)
306
+ .limit(1)
307
+ .executeTakeFirst()
308
+ if (!member) {
309
+ throw new AdminDomainError('workspace_gone', 'The document’s workspace has nobody in it')
310
+ }
311
+ await unmarkPurged(transaction, {
312
+ id: document.id,
313
+ workspaceId: document.workspaceId,
314
+ purgedBytes: Number(document.purgedBytes)
315
+ })
316
+ await auditContentAction(
317
+ transaction,
318
+ actorId,
319
+ 'document.undeleted',
320
+ { type: 'document', id: documentId },
321
+ { workspaceId: document.workspaceId }
322
+ )
323
+ })
324
+ },
325
+
326
+ /**
327
+ * Revokes a share link for good, as its owner can: the collaboration epoch moves on, so the
328
+ * link's guests lose their tickets, while members keep editing.
329
+ */
330
+ async revokeShare(actorId: string, shareId: string): Promise<void> {
331
+ await database.transaction().execute(async (transaction) => {
332
+ const share = await transaction
333
+ .selectFrom('documentShare')
334
+ .select(['id', 'documentId', 'revokedAt'])
335
+ .where('id', '=', shareId)
336
+ .forUpdate()
337
+ .executeTakeFirstOrThrow()
338
+ if (share.revokedAt) return
339
+ await transaction
340
+ .updateTable('documentShare')
341
+ .set({ revokedAt: new Date(), updatedAt: new Date() })
342
+ .where('id', '=', shareId)
343
+ .execute()
344
+ await transaction
345
+ .updateTable('document')
346
+ .set((expression) => ({ collaborationEpoch: expression('collaborationEpoch', '+', 1) }))
347
+ .where('id', '=', share.documentId)
348
+ .execute()
349
+ await auditContentAction(
350
+ transaction,
351
+ actorId,
352
+ 'document-share.revoked',
353
+ { type: 'document-share', id: shareId },
354
+ { documentId: share.documentId }
355
+ )
356
+ })
357
+ }
358
+ }
359
+ }
360
+
361
+ export type AdminDocumentService = ReturnType<typeof createAdminDocumentService>
@@ -4,6 +4,8 @@ export type AdminErrorCode =
4
4
  | 'self_admin_action_forbidden'
5
5
  | 'email_regeneration_unavailable'
6
6
  | 'mfa_required'
7
+ | 'document_not_restorable'
8
+ | 'workspace_gone'
7
9
 
8
10
  export class AdminDomainError extends Error {
9
11
  override readonly name = 'AdminDomainError'
@@ -15,6 +17,12 @@ export class AdminDomainError extends Error {
15
17
  }
16
18
  }
17
19
 
20
+ const CONFLICTS = new Set<AdminErrorCode>([
21
+ 'invalid_enrollment_transition',
22
+ 'document_not_restorable',
23
+ 'workspace_gone'
24
+ ])
25
+
18
26
  export function adminErrorStatus(error: AdminDomainError): 400 | 409 {
19
- return error.code === 'invalid_enrollment_transition' ? 409 : 400
27
+ return CONFLICTS.has(error.code) ? 409 : 400
20
28
  }
@@ -17,3 +17,9 @@ export {
17
17
  } from './enrollment/service'
18
18
  export { createAdminOperationsService, type AdminOperationsService } from './operations/service'
19
19
  export { createAdminUserService, type AdminUserService } from './users/service'
20
+ export {
21
+ createAdminDocumentService,
22
+ type AdminDocumentService,
23
+ type AdminDocumentServiceOptions
24
+ } from './documents/service'
25
+ export { createAdminReportService, type AdminReportService } from './reports/service'
@@ -19,6 +19,7 @@ export function createAdminOperationsService(
19
19
  async summary() {
20
20
  const [
21
21
  pendingEnrollment,
22
+ openReports,
22
23
  pendingEmail,
23
24
  failedEmail,
24
25
  accounts,
@@ -31,6 +32,11 @@ export function createAdminOperationsService(
31
32
  .select(({ fn }) => fn.countAll<number>().as('count'))
32
33
  .where('status', '=', 'pending')
33
34
  .executeTakeFirstOrThrow(),
35
+ database
36
+ .selectFrom('documentReport')
37
+ .select(({ fn }) => fn.countAll<number>().as('count'))
38
+ .where('status', '=', 'open')
39
+ .executeTakeFirstOrThrow(),
34
40
  emailCount('pending'),
35
41
  emailCount('failed'),
36
42
  database
@@ -56,6 +62,7 @@ export function createAdminOperationsService(
56
62
  enrollmentMode: config.enrollmentMode,
57
63
  emailTransport: config.emailTransport,
58
64
  pendingEnrollment: Number(pendingEnrollment.count),
65
+ openReports: Number(openReports.count),
59
66
  pendingEmail,
60
67
  failedEmail,
61
68
  accounts: Number(accounts.count),