@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
@@ -0,0 +1,193 @@
1
+ import type { Kysely } from 'kysely'
2
+
3
+ import { addChecks, addIndexes, dropTables, now, required } from './schema'
4
+
5
+ /** Documents and what they hold: revisions, versions, images, collaboration rooms, and uploads. */
6
+ const TABLES = [
7
+ 'document',
8
+ 'document_revision',
9
+ 'document_version',
10
+ 'revision_image',
11
+ 'document_room_snapshot',
12
+ 'document_room_update',
13
+ 'upload',
14
+ 'upload_storage_reservation'
15
+ ]
16
+
17
+ async function createRevisions(database: Kysely<unknown>): Promise<void> {
18
+ await database.schema
19
+ .createTable('document')
20
+ .addColumn('id', 'uuid', (column) => column.primaryKey())
21
+ .addColumn('workspace_id', 'uuid', (column) =>
22
+ column.notNull().references('workspace.id').onDelete('cascade')
23
+ )
24
+ .addColumn('name', 'text', required)
25
+ .addColumn('kind', 'text', (column) => column.notNull().defaultTo('design'))
26
+ .addColumn('current_revision_id', 'uuid')
27
+ .addColumn('version', 'integer', (column) => column.notNull().defaultTo(0))
28
+ .addColumn('collaboration_epoch', 'integer', (column) => column.notNull().defaultTo(0))
29
+ .addColumn('created_by', 'text', required)
30
+ .addColumn('created_at', 'timestamptz', now)
31
+ .addColumn('updated_at', 'timestamptz', now)
32
+ .addColumn('deleted_at', 'timestamptz')
33
+ .addColumn('cleanup_claim_id', 'uuid')
34
+ .addColumn('cleanup_claimed_at', 'timestamptz')
35
+ .addColumn('disabled_at', 'timestamptz')
36
+ .addColumn('disabled_reason', 'text')
37
+ .execute()
38
+ await database.schema
39
+ .createTable('document_revision')
40
+ .addColumn('id', 'uuid', (column) => column.primaryKey())
41
+ .addColumn('document_id', 'uuid', (column) =>
42
+ column.notNull().references('document.id').onDelete('cascade')
43
+ )
44
+ .addColumn('parent_revision_id', 'uuid', (column) =>
45
+ column.references('document_revision.id').onDelete('set null')
46
+ )
47
+ .addColumn('storage_object_id', 'uuid', (column) =>
48
+ column.notNull().references('storage_object.id').onDelete('restrict')
49
+ )
50
+ .addColumn('created_by', 'text', required)
51
+ .addColumn('created_at', 'timestamptz', now)
52
+ .execute()
53
+ // A document and its revisions refer to each other, so this key comes once both exist.
54
+ await database.schema
55
+ .alterTable('document')
56
+ .addForeignKeyConstraint(
57
+ 'document_current_revision_id_fkey',
58
+ ['current_revision_id'],
59
+ 'document_revision',
60
+ ['id'],
61
+ (constraint) => constraint.onDelete('set null')
62
+ )
63
+ .execute()
64
+ await database.schema
65
+ .createTable('document_version')
66
+ .addColumn('id', 'uuid', (column) => column.primaryKey())
67
+ .addColumn('document_id', 'uuid', (column) =>
68
+ column.notNull().references('document.id').onDelete('cascade')
69
+ )
70
+ .addColumn('revision_id', 'uuid', (column) =>
71
+ column.notNull().unique().references('document_revision.id').onDelete('cascade')
72
+ )
73
+ .addColumn('kind', 'text', required)
74
+ .addColumn('name', 'text')
75
+ .addColumn('description', 'text')
76
+ .addColumn('restored_from_version_id', 'uuid', (column) =>
77
+ column.references('document_version.id').onDelete('set null')
78
+ )
79
+ .addColumn('created_by', 'text', required)
80
+ .addColumn('created_at', 'timestamptz', now)
81
+ .execute()
82
+ await database.schema
83
+ .createTable('revision_image')
84
+ .addColumn('revision_id', 'uuid', (column) =>
85
+ column.notNull().references('document_revision.id').onDelete('cascade')
86
+ )
87
+ .addColumn('name', 'text', required)
88
+ .addColumn('workspace_id', 'uuid', required)
89
+ .addColumn('checksum', 'text', required)
90
+ .addPrimaryKeyConstraint('revision_image_pkey', ['revision_id', 'name'])
91
+ .addForeignKeyConstraint(
92
+ 'revision_image_workspace_id_checksum_fkey',
93
+ ['workspace_id', 'checksum'],
94
+ 'workspace_image',
95
+ ['workspace_id', 'checksum']
96
+ )
97
+ .execute()
98
+ }
99
+
100
+ async function createRooms(database: Kysely<unknown>): Promise<void> {
101
+ // A collaboration room's document: a snapshot in the object store and the updates after it.
102
+ await database.schema
103
+ .createTable('document_room_snapshot')
104
+ .addColumn('document_id', 'uuid', (column) =>
105
+ column.notNull().references('document.id').onDelete('cascade')
106
+ )
107
+ .addColumn('room_epoch', 'integer', required)
108
+ .addColumn('snapshot_object_id', 'uuid', (column) =>
109
+ column.notNull().references('storage_object.id')
110
+ )
111
+ .addColumn('through_sequence', 'integer', required)
112
+ .addColumn('created_at', 'timestamptz', now)
113
+ .addColumn('updated_at', 'timestamptz', now)
114
+ .addPrimaryKeyConstraint('document_room_snapshot_pkey', ['document_id', 'room_epoch'])
115
+ .execute()
116
+ await database.schema
117
+ .createTable('document_room_update')
118
+ .addColumn('document_id', 'uuid', (column) =>
119
+ column.notNull().references('document.id').onDelete('cascade')
120
+ )
121
+ .addColumn('room_epoch', 'integer', required)
122
+ .addColumn('sequence', 'integer', required)
123
+ .addColumn('data', 'bytea', required)
124
+ .addColumn('created_at', 'timestamptz', now)
125
+ .addPrimaryKeyConstraint('document_room_update_pkey', ['document_id', 'room_epoch', 'sequence'])
126
+ .execute()
127
+ }
128
+
129
+ async function createUploads(database: Kysely<unknown>): Promise<void> {
130
+ // A revision or image on its way into the object store, and the space it holds meanwhile.
131
+ await database.schema
132
+ .createTable('upload')
133
+ .addColumn('id', 'uuid', (column) => column.primaryKey())
134
+ .addColumn('document_id', 'uuid', (column) =>
135
+ column.notNull().references('document.id').onDelete('cascade')
136
+ )
137
+ .addColumn('kind', 'text', (column) => column.notNull().defaultTo('revision'))
138
+ .addColumn('base_revision_id', 'uuid', (column) =>
139
+ column.references('document_revision.id').onDelete('set null')
140
+ )
141
+ .addColumn('object_key', 'text', (column) => column.notNull().unique())
142
+ .addColumn('status', 'text', required)
143
+ .addColumn('checksum', 'text', required)
144
+ .addColumn('byte_size', 'bigint', required)
145
+ .addColumn('content_type', 'text', required)
146
+ .addColumn('multipart_upload_id', 'text')
147
+ .addColumn('created_by', 'text', required)
148
+ .addColumn('created_at', 'timestamptz', now)
149
+ .addColumn('expires_at', 'timestamptz', required)
150
+ .addColumn('finalization_started_at', 'timestamptz')
151
+ .addColumn('cleanup_claim_id', 'uuid')
152
+ .addColumn('cleanup_claimed_at', 'timestamptz')
153
+ .execute()
154
+ await database.schema
155
+ .createTable('upload_storage_reservation')
156
+ .addColumn('id', 'uuid', (column) => column.primaryKey())
157
+ .addColumn('workspace_id', 'uuid', (column) =>
158
+ column.notNull().references('workspace.id').onDelete('cascade')
159
+ )
160
+ .addColumn('upload_id', 'uuid', (column) =>
161
+ column.notNull().unique().references('upload.id').onDelete('cascade')
162
+ )
163
+ .addColumn('bytes', 'bigint', required)
164
+ .addColumn('created_at', 'timestamptz', now)
165
+ .addColumn('expires_at', 'timestamptz', required)
166
+ .addColumn('committed_at', 'timestamptz')
167
+ .addColumn('released_at', 'timestamptz')
168
+ .execute()
169
+ }
170
+
171
+ export async function up(database: Kysely<unknown>): Promise<void> {
172
+ await createRevisions(database)
173
+ await createRooms(database)
174
+ await createUploads(database)
175
+ await addChecks(database, [
176
+ ['document', 'kind', ['design', 'board']],
177
+ ['document_version', 'kind', ['checkpoint', 'named']],
178
+ ['upload', 'kind', ['revision', 'image']],
179
+ ['upload', 'status', ['pending', 'finalizing', 'cleaning', 'committed', 'abandoned']]
180
+ ])
181
+ await addIndexes(database, [
182
+ ['document', ['workspace_id', 'updated_at']],
183
+ ['document', ['deleted_at', 'cleanup_claimed_at']],
184
+ ['document_revision', ['document_id', 'created_at']],
185
+ ['document_version', ['document_id', 'created_at desc', 'id desc']],
186
+ ['revision_image', ['workspace_id', 'checksum']],
187
+ ['upload', ['status', 'expires_at']]
188
+ ])
189
+ }
190
+
191
+ export async function down(database: Kysely<unknown>): Promise<void> {
192
+ await dropTables(database, TABLES)
193
+ }
@@ -0,0 +1,95 @@
1
+ import type { Kysely } from 'kysely'
2
+
3
+ import {
4
+ addChecks,
5
+ addIndexes,
6
+ dropTables,
7
+ now,
8
+ PERMISSIONS,
9
+ required,
10
+ withInvitation
11
+ } from './schema'
12
+
13
+ /** Who a document is shared with: people, invitations, links, and the invitations budget. */
14
+ const TABLES = [
15
+ 'document_grant',
16
+ 'document_invitation',
17
+ 'invitation_continuation',
18
+ 'document_share',
19
+ 'invitation_send'
20
+ ]
21
+
22
+ export async function up(database: Kysely<unknown>): Promise<void> {
23
+ await database.schema
24
+ .createTable('document_grant')
25
+ .addColumn('id', 'uuid', (column) => column.primaryKey())
26
+ .addColumn('document_id', 'uuid', (column) =>
27
+ column.notNull().references('document.id').onDelete('cascade')
28
+ )
29
+ .addColumn('user_id', 'text', required)
30
+ .addColumn('permission', 'text', required)
31
+ .addColumn('created_by', 'text', required)
32
+ .addColumn('created_at', 'timestamptz', now)
33
+ .addColumn('updated_at', 'timestamptz', now)
34
+ .addColumn('revoked_at', 'timestamptz')
35
+ .addUniqueConstraint('document_grant_document_id_user_id_key', ['document_id', 'user_id'])
36
+ .execute()
37
+ await withInvitation(database.schema.createTable('document_invitation'), 'permission')
38
+ .addColumn('document_id', 'uuid', (column) =>
39
+ column.notNull().references('document.id').onDelete('cascade')
40
+ )
41
+ .execute()
42
+ // An invitation's token carried through a sign-in that leaves the editor, encrypted.
43
+ await database.schema
44
+ .createTable('invitation_continuation')
45
+ .addColumn('id', 'text', (column) => column.primaryKey())
46
+ .addColumn('invitation_id', 'uuid', (column) =>
47
+ column.notNull().references('document_invitation.id').onDelete('cascade')
48
+ )
49
+ .addColumn('token_encrypted', 'text', required)
50
+ .addColumn('created_at', 'timestamptz', now)
51
+ .addColumn('expires_at', 'timestamptz', required)
52
+ .addColumn('consumed_at', 'timestamptz')
53
+ .execute()
54
+ await database.schema
55
+ .createTable('document_share')
56
+ .addColumn('id', 'uuid', (column) => column.primaryKey())
57
+ .addColumn('document_id', 'uuid', (column) =>
58
+ column.notNull().references('document.id').onDelete('cascade')
59
+ )
60
+ .addColumn('permission', 'text', required)
61
+ .addColumn('secret_hash', 'text', required)
62
+ .addColumn('room_epoch', 'integer', (column) => column.notNull().defaultTo(0))
63
+ .addColumn('created_by', 'text', required)
64
+ .addColumn('created_at', 'timestamptz', now)
65
+ .addColumn('updated_at', 'timestamptz', now)
66
+ .addColumn('expires_at', 'timestamptz')
67
+ .addColumn('revoked_at', 'timestamptz')
68
+ .addColumn('last_used_at', 'timestamptz')
69
+ .execute()
70
+ // Each invitation sent, for the daily invitation budget; kept apart from the invitations.
71
+ await database.schema
72
+ .createTable('invitation_send')
73
+ .addColumn('id', 'uuid', (column) => column.primaryKey())
74
+ .addColumn('sender_id', 'text', required)
75
+ .addColumn('email_normalized', 'text', required)
76
+ .addColumn('sent_at', 'timestamptz', now)
77
+ .execute()
78
+ await addChecks(database, [
79
+ ['document_grant', 'permission', PERMISSIONS],
80
+ ['document_invitation', 'permission', PERMISSIONS],
81
+ ['document_share', 'permission', PERMISSIONS]
82
+ ])
83
+ await addIndexes(database, [
84
+ ['document_grant', ['user_id', 'document_id']],
85
+ ['document_invitation', ['document_id', 'revoked_at']],
86
+ ['document_share', ['document_id', 'revoked_at']],
87
+ ['invitation_continuation', ['expires_at']],
88
+ ['invitation_send', ['sender_id', 'sent_at']],
89
+ ['invitation_send', ['email_normalized', 'sent_at']]
90
+ ])
91
+ }
92
+
93
+ export async function down(database: Kysely<unknown>): Promise<void> {
94
+ await dropTables(database, TABLES)
95
+ }
@@ -0,0 +1,110 @@
1
+ import { EMPTY_JSON_OBJECT } from '#cloud/server/db/expressions'
2
+ import type { Kysely } from 'kysely'
3
+
4
+ import { addChecks, addIndexes, dropTables, now, required } from './schema'
5
+
6
+ /** Running the deployment: the email outbox, enrollment, reports, and the administrators' log. */
7
+ const TABLES = ['transactional_email', 'enrollment', 'document_report', 'admin_audit_event']
8
+
9
+ export async function up(database: Kysely<unknown>): Promise<void> {
10
+ // The email outbox; a payload is encrypted until it is sent.
11
+ await database.schema
12
+ .createTable('transactional_email')
13
+ .addColumn('id', 'uuid', (column) => column.primaryKey())
14
+ .addColumn('idempotency_key', 'text', (column) => column.notNull().unique())
15
+ .addColumn('kind', 'text', required)
16
+ .addColumn('recipient_email_normalized', 'text', required)
17
+ .addColumn('payload_encrypted', 'text')
18
+ .addColumn('status', 'text', (column) => column.notNull().defaultTo('pending'))
19
+ .addColumn('attempt_count', 'integer', (column) => column.notNull().defaultTo(0))
20
+ .addColumn('next_attempt_at', 'timestamptz', now)
21
+ .addColumn('claim_id', 'uuid')
22
+ .addColumn('claimed_at', 'timestamptz')
23
+ .addColumn('transport', 'text')
24
+ .addColumn('transport_message_id', 'text')
25
+ .addColumn('last_error_code', 'text')
26
+ .addColumn('created_at', 'timestamptz', now)
27
+ .addColumn('updated_at', 'timestamptz', now)
28
+ .addColumn('accepted_at', 'timestamptz')
29
+ .execute()
30
+ await database.schema
31
+ .createTable('enrollment')
32
+ .addColumn('id', 'uuid', (column) => column.primaryKey())
33
+ .addColumn('email_normalized', 'text', (column) => column.notNull().unique())
34
+ .addColumn('name', 'text')
35
+ .addColumn('reason', 'text')
36
+ .addColumn('status', 'text', (column) => column.notNull().defaultTo('pending'))
37
+ .addColumn('request_revision', 'integer', (column) => column.notNull().defaultTo(1))
38
+ .addColumn('requested_at', 'timestamptz', now)
39
+ .addColumn('reviewed_at', 'timestamptz')
40
+ .addColumn('reviewed_by', 'text')
41
+ .addColumn('review_note', 'text')
42
+ .addColumn('approved_user_id', 'text')
43
+ .execute()
44
+ // What someone reported about a shared document, and what an administrator did about it.
45
+ await database.schema
46
+ .createTable('document_report')
47
+ .addColumn('id', 'uuid', (column) => column.primaryKey())
48
+ .addColumn('document_id', 'uuid', (column) =>
49
+ column.notNull().references('document.id').onDelete('cascade')
50
+ )
51
+ .addColumn('share_id', 'uuid')
52
+ .addColumn('reporter_user_id', 'text')
53
+ .addColumn('reporter_guest_id', 'text')
54
+ .addColumn('reply_email', 'text')
55
+ .addColumn('reason', 'text', required)
56
+ .addColumn('description', 'text', required)
57
+ .addColumn('status', 'text', (column) => column.notNull().defaultTo('open'))
58
+ .addColumn('created_at', 'timestamptz', now)
59
+ .addColumn('resolved_at', 'timestamptz')
60
+ .addColumn('resolved_by', 'text')
61
+ .execute()
62
+ await database.schema
63
+ .createTable('admin_audit_event')
64
+ .addColumn('id', 'uuid', (column) => column.primaryKey())
65
+ .addColumn('actor_user_id', 'text', required)
66
+ .addColumn('action', 'text', required)
67
+ .addColumn('subject_type', 'text', required)
68
+ .addColumn('subject_id', 'text', required)
69
+ .addColumn('metadata', 'jsonb', (column) => column.notNull().defaultTo(EMPTY_JSON_OBJECT))
70
+ .addColumn('created_at', 'timestamptz', now)
71
+ .execute()
72
+ await addChecks(database, [
73
+ [
74
+ 'transactional_email',
75
+ 'kind',
76
+ [
77
+ 'document-invitation',
78
+ 'workspace-invitation',
79
+ 'enrollment-requested',
80
+ 'admin-enrollment-notification',
81
+ 'enrollment-approved',
82
+ 'enrollment-rejected',
83
+ 'enrollment-revoked',
84
+ 'email-verification',
85
+ 'password-reset',
86
+ 'password-changed',
87
+ 'email-change-requested',
88
+ 'new-sign-in',
89
+ 'two-step-changed',
90
+ 'document-report'
91
+ ]
92
+ ],
93
+ ['transactional_email', 'status', ['pending', 'sending', 'accepted', 'failed', 'suppressed']],
94
+ ['enrollment', 'status', ['pending', 'approved', 'rejected', 'revoked']],
95
+ ['document_report', 'reason', ['spam-phishing', 'illegal', 'copyright', 'harassment', 'other']],
96
+ ['document_report', 'status', ['open', 'dismissed', 'actioned']]
97
+ ])
98
+ await addIndexes(database, [
99
+ ['transactional_email', ['status', 'next_attempt_at']],
100
+ ['enrollment', ['status', 'requested_at']],
101
+ ['document_report', ['document_id']],
102
+ ['document_report', ['share_id', 'created_at']],
103
+ ['document_report', ['status', 'created_at']],
104
+ ['admin_audit_event', ['created_at']]
105
+ ])
106
+ }
107
+
108
+ export async function down(database: Kysely<unknown>): Promise<void> {
109
+ await dropTables(database, TABLES)
110
+ }
@@ -0,0 +1,33 @@
1
+ import type { Kysely } from 'kysely'
2
+
3
+ import { addIndexes } from './schema'
4
+
5
+ /**
6
+ * Trash: who deleted a document, and who deleted it forever, when, and the storage that took off
7
+ * its workspace's usage while its files wait out the grace before cleanup destroys them.
8
+ */
9
+ export async function up(database: Kysely<unknown>): Promise<void> {
10
+ await database.schema
11
+ .alterTable('document')
12
+ .addColumn('deleted_by', 'text')
13
+ .addColumn('purged_at', 'timestamptz')
14
+ .addColumn('purged_by', 'text')
15
+ .addColumn('purged_bytes', 'bigint', (column) => column.notNull().defaultTo(0))
16
+ .execute()
17
+ await addIndexes(database, [
18
+ ['document', ['workspace_id', 'deleted_at desc']],
19
+ ['document', ['purged_at']]
20
+ ])
21
+ }
22
+
23
+ export async function down(database: Kysely<unknown>): Promise<void> {
24
+ await database.schema.dropIndex('document_purged_at_idx').execute()
25
+ await database.schema.dropIndex('document_workspace_id_deleted_at_idx').execute()
26
+ await database.schema
27
+ .alterTable('document')
28
+ .dropColumn('purged_bytes')
29
+ .dropColumn('purged_by')
30
+ .dropColumn('purged_at')
31
+ .dropColumn('deleted_by')
32
+ .execute()
33
+ }
@@ -0,0 +1,18 @@
1
+ import type { Kysely } from 'kysely'
2
+
3
+ import { now, required } from './schema'
4
+
5
+ /** Which version of the deployment's terms each account accepted, and when. */
6
+ export async function up(database: Kysely<unknown>): Promise<void> {
7
+ await database.schema
8
+ .createTable('terms_acceptance')
9
+ .addColumn('user_id', 'text', required)
10
+ .addColumn('version', 'text', required)
11
+ .addColumn('accepted_at', 'timestamptz', now)
12
+ .addPrimaryKeyConstraint('terms_acceptance_pkey', ['user_id', 'version'])
13
+ .execute()
14
+ }
15
+
16
+ export async function down(database: Kysely<unknown>): Promise<void> {
17
+ await database.schema.dropTable('terms_acceptance').execute()
18
+ }
@@ -0,0 +1,71 @@
1
+ import { checkColumnIn, CURRENT_TIMESTAMP } from '#cloud/server/db/expressions'
2
+ import type { ColumnDefinitionBuilder, CreateTableBuilder, Kysely } from 'kysely'
3
+
4
+ /**
5
+ * What Cloud's migrations build tables with. Names follow PostgreSQL's own: `<table>_pkey`,
6
+ * `<table>_<columns>_key` for unique, `<table>_<columns>_fkey`, and `<table>_<column>_check`;
7
+ * indexes are `<table>_<columns>_idx`. Account IDs are text, since Better Auth's tables come after
8
+ * Cloud's (see `migrateCloudDatabase`), and never foreign keys.
9
+ */
10
+
11
+ export const now = (column: ColumnDefinitionBuilder) =>
12
+ column.notNull().defaultTo(CURRENT_TIMESTAMP)
13
+ export const required = (column: ColumnDefinitionBuilder) => column.notNull()
14
+
15
+ export const PERMISSIONS = ['view', 'edit']
16
+ export const ROLES = ['admin', 'editor', 'viewer']
17
+
18
+ /** What every emailed invitation keeps: whom it went to, its access, its secret, and its life. */
19
+ export function withInvitation<Table extends string>(
20
+ table: CreateTableBuilder<Table>,
21
+ access: 'permission' | 'role'
22
+ ) {
23
+ return table
24
+ .addColumn('id', 'uuid', (column) => column.primaryKey())
25
+ .addColumn('email_normalized', 'text', required)
26
+ .addColumn(access, 'text', required)
27
+ .addColumn('token_hash', 'text', required)
28
+ .addColumn('invited_by', 'text', required)
29
+ .addColumn('invited_at', 'timestamptz', now)
30
+ .addColumn('expires_at', 'timestamptz', required)
31
+ .addColumn('accepted_at', 'timestamptz')
32
+ .addColumn('revoked_at', 'timestamptz')
33
+ }
34
+
35
+ /** Text columns that take one of a few values, as `[table, column, values]`. */
36
+ export async function addChecks(
37
+ database: Kysely<unknown>,
38
+ checks: readonly (readonly [table: string, column: string, values: readonly string[]])[]
39
+ ): Promise<void> {
40
+ for (const [table, column, values] of checks) {
41
+ await database.schema
42
+ .alterTable(table)
43
+ .addCheckConstraint(`${table}_${column}_check`, checkColumnIn(column, values))
44
+ .execute()
45
+ }
46
+ }
47
+
48
+ /** Lookups beyond primary keys and unique columns, as `[table, columns]`; `desc` sorts newest first. */
49
+ export async function addIndexes(
50
+ database: Kysely<unknown>,
51
+ indexes: readonly (readonly [table: string, columns: readonly string[]])[]
52
+ ): Promise<void> {
53
+ for (const [table, columns] of indexes) {
54
+ const name = columns.map((column) => column.split(' ')[0]).join('_')
55
+ await database.schema
56
+ .createIndex(`${table}_${name}_idx`)
57
+ .on(table)
58
+ .columns([...columns])
59
+ .execute()
60
+ }
61
+ }
62
+
63
+ /** Drops a migration's tables, last created first. */
64
+ export async function dropTables(
65
+ database: Kysely<unknown>,
66
+ tables: readonly string[]
67
+ ): Promise<void> {
68
+ for (const table of tables.toReversed()) {
69
+ await database.schema.dropTable(table).ifExists().cascade().execute()
70
+ }
71
+ }
@@ -51,6 +51,8 @@ export interface WorkspaceTable {
51
51
  name: string
52
52
  slug: string
53
53
  createdBy: string
54
+ /** Whose plan the workspace's limits come from; ownership passes to another admin when they go. */
55
+ ownerId: string
54
56
  createdAt: TimestampColumn
55
57
  updatedAt: TimestampColumn
56
58
  }
@@ -88,8 +90,37 @@ export interface DocumentTable {
88
90
  createdAt: TimestampColumn
89
91
  updatedAt: TimestampColumn
90
92
  deletedAt: TimestampColumn | null
93
+ /** Who moved the document to Trash; empty when its account's deletion did. */
94
+ deletedBy: string | null
95
+ /**
96
+ * When it was deleted forever, and by whom (empty for an account's deletion): out of everyone's
97
+ * sight, its files wait out the deployment's grace before cleanup destroys them.
98
+ */
99
+ purgedAt: TimestampColumn | null
100
+ purgedBy: string | null
101
+ /** Storage taken off its workspace's usage when it was deleted forever; see migration 007. */
102
+ purgedBytes: Generated<number>
91
103
  cleanupClaimId: Generated<string | null>
92
104
  cleanupClaimedAt: TimestampColumn | null
105
+ /** Set while a deployment administrator has taken the document down; see migration 032. */
106
+ disabledAt: TimestampColumn | null
107
+ disabledReason: Generated<string | null>
108
+ }
109
+
110
+ /** A report someone filed about a document shared with them by link; see migration 032. */
111
+ export interface DocumentReportTable {
112
+ id: string
113
+ documentId: string
114
+ shareId: string | null
115
+ reporterUserId: string | null
116
+ reporterGuestId: string | null
117
+ replyEmail: string | null
118
+ reason: 'spam-phishing' | 'illegal' | 'copyright' | 'harassment' | 'other'
119
+ description: string
120
+ status: Generated<'open' | 'dismissed' | 'actioned'>
121
+ createdAt: TimestampColumn
122
+ resolvedAt: TimestampColumn | null
123
+ resolvedBy: string | null
93
124
  }
94
125
 
95
126
  export interface StorageObjectTable {
@@ -233,15 +264,28 @@ export interface UserPictureTable {
233
264
  createdAt: TimestampColumn
234
265
  }
235
266
 
236
- export interface DocumentCollaborationStateTable {
267
+ /** A collaboration room's latest snapshot, a stored file, by document and epoch. */
268
+ export interface DocumentRoomSnapshotTable {
237
269
  documentId: string
238
270
  roomEpoch: number
239
- state: Uint8Array
240
- version: Generated<number>
271
+ /** The stored file holding the room's snapshot. */
272
+ snapshotObjectId: string
273
+ /** The last logged update the snapshot holds; later ones are in `documentRoomUpdate`. */
274
+ throughSequence: number
241
275
  createdAt: TimestampColumn
242
276
  updatedAt: TimestampColumn
243
277
  }
244
278
 
279
+ /** An update a room logged after its snapshot, one per save. */
280
+ export interface DocumentRoomUpdateTable {
281
+ documentId: string
282
+ roomEpoch: number
283
+ sequence: number
284
+ /** One Yjs update, as the relay merged the changes of one save. */
285
+ data: Uint8Array
286
+ createdAt: TimestampColumn
287
+ }
288
+
245
289
  export interface InvitationContinuationTable {
246
290
  id: string
247
291
  invitationId: string
@@ -251,8 +295,15 @@ export interface InvitationContinuationTable {
251
295
  createdAt: TimestampColumn
252
296
  }
253
297
 
254
- export interface WorkspaceEntitlementTable {
255
- workspaceId: string
298
+ /** Which version of the server's terms an account accepted, and when; one row per version. */
299
+ export interface TermsAcceptanceTable {
300
+ userId: string
301
+ version: string
302
+ acceptedAt: TimestampColumn
303
+ }
304
+
305
+ export interface AccountEntitlementTable {
306
+ userId: string
256
307
  values: unknown
257
308
  source: string
258
309
  revision: Generated<number>
@@ -338,6 +389,14 @@ export interface AuthSchemaVersionTable {
338
389
  updatedAt: TimestampColumn
339
390
  }
340
391
 
392
+ /** One invitation sent, for the daily invitation budget; see `src/server/invitations/budget.ts`. */
393
+ export interface InvitationSendTable {
394
+ id: string
395
+ senderId: string
396
+ emailNormalized: string
397
+ sentAt: TimestampColumn
398
+ }
399
+
341
400
  export interface CloudDatabase {
342
401
  account: Account
343
402
  session: Session
@@ -363,13 +422,17 @@ export interface CloudDatabase {
363
422
  documentShare: DocumentShareTable
364
423
  documentGrant: DocumentGrantTable
365
424
  documentInvitation: DocumentInvitationTable
366
- documentCollaborationState: DocumentCollaborationStateTable
425
+ documentRoomSnapshot: DocumentRoomSnapshotTable
426
+ documentRoomUpdate: DocumentRoomUpdateTable
367
427
  invitationContinuation: InvitationContinuationTable
368
- workspaceEntitlement: WorkspaceEntitlementTable
428
+ accountEntitlement: AccountEntitlementTable
429
+ termsAcceptance: TermsAcceptanceTable
369
430
  workspaceStorageUsage: WorkspaceStorageUsageTable
370
431
  transactionalEmail: TransactionalEmailTable
371
432
  uploadStorageReservation: UploadStorageReservationTable
372
433
  upload: UploadTable
434
+ invitationSend: InvitationSendTable
435
+ documentReport: DocumentReportTable
373
436
  }
374
437
 
375
438
  export type NewTransactionalEmail = Insertable<TransactionalEmailTable>