@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
@@ -1,4 +1,6 @@
1
- import { sql, type Expression } from 'kysely'
1
+ import { sql, type Expression, type Transaction } from 'kysely'
2
+
3
+ import type { CloudDatabase } from './tables'
2
4
 
3
5
  export const CURRENT_TIMESTAMP = sql<Date>`current_timestamp`
4
6
  export const EMPTY_JSON_OBJECT = sql`'{}'::jsonb`
@@ -11,3 +13,15 @@ export function checkColumnIn(column: string, values: readonly string[]): Expres
11
13
  }
12
14
  return sql<boolean>`${sql.ref(column)} in (${sql.join(values.map((value) => sql.lit(value)))})`
13
15
  }
16
+
17
+ /**
18
+ * Holds a lock named `key` until the transaction ends, for a check and a write that must not
19
+ * interleave with another transaction's, such as reserving storage from an account's allowance,
20
+ * which spans rows no single one of which could be locked for it.
21
+ */
22
+ export async function lockForTransaction(
23
+ transaction: Transaction<CloudDatabase>,
24
+ key: string
25
+ ): Promise<void> {
26
+ await sql`select pg_advisory_xact_lock(hashtextextended(${key}, 0))`.execute(transaction)
27
+ }
@@ -1,69 +1,38 @@
1
1
  import type { Kysely } from 'kysely'
2
2
  import { Migrator, type Migration, type MigrationProvider } from 'kysely/migration'
3
3
 
4
- import * as foundation from './migrations/001_foundation'
5
- import * as cleanupClaims from './migrations/002_upload_cleanup_claims'
6
- import * as documentCleanupClaims from './migrations/003_document_cleanup_claims'
7
- import * as documentSharing from './migrations/004_document_sharing'
8
- import * as documentCollaborationEpoch from './migrations/005_document_collaboration_epoch'
9
- import * as invitationContinuation from './migrations/006_invitation_continuation'
10
- import * as collaborationState from './migrations/007_collaboration_state'
11
- import * as storageReservations from './migrations/008_storage_reservations'
12
- import * as workspaceEntitlements from './migrations/009_workspace_entitlements'
13
- import * as uploadFinalization from './migrations/010_upload_finalization'
14
- import * as uploadFinalizationLease from './migrations/011_upload_finalization_lease'
15
- import * as transactionalEmail from './migrations/012_transactional_email'
16
- import * as adminEnrollment from './migrations/013_admin_enrollment'
17
- import * as enrollmentEmailKinds from './migrations/014_enrollment_email_kinds'
18
- import * as cloudRateLimit from './migrations/015_cloud_rate_limit'
19
- import * as authSchema from './migrations/016_auth_schema'
20
- import * as authenticationEmailKinds from './migrations/017_authentication_email_kinds'
21
- import * as authenticationMFA from './migrations/018_authentication_mfa'
22
- import * as betterAuthAccountIssuer from './migrations/019_better_auth_account_issuer'
23
- import * as workspaceInvitations from './migrations/020_workspace_invitations'
24
- import * as documentVersions from './migrations/021_document_versions'
25
- import * as entitlementExternalVersion from './migrations/022_entitlement_external_version'
26
- import * as documentImages from './migrations/023_document_images'
27
- import * as accountActivity from './migrations/024_account_activity'
28
- import * as tableNames from './migrations/025_table_names'
29
- import * as userPicture from './migrations/026_user_picture'
30
- import * as documentKind from './migrations/027_document_kind'
31
- import * as collaborationUpdates from './migrations/028_collaboration_updates'
4
+ import * as accounts from './migrations/001_accounts'
5
+ import * as workspaces from './migrations/002_workspaces'
6
+ import * as storage from './migrations/003_storage'
7
+ import * as documents from './migrations/004_documents'
8
+ import * as sharing from './migrations/005_sharing'
9
+ import * as operations from './migrations/006_operations'
10
+ import * as trash from './migrations/007_trash'
11
+ import * as terms from './migrations/008_terms'
32
12
  import type { CloudDatabase } from './tables'
33
13
 
34
- const migrations: Record<string, Migration> = {
35
- '001_foundation': foundation,
36
- '002_upload_cleanup_claims': cleanupClaims,
37
- '003_document_cleanup_claims': documentCleanupClaims,
38
- '004_document_sharing': documentSharing,
39
- '005_document_collaboration_epoch': documentCollaborationEpoch,
40
- '006_invitation_continuation': invitationContinuation,
41
- '007_collaboration_state': collaborationState,
42
- '008_storage_reservations': storageReservations,
43
- '009_workspace_entitlements': workspaceEntitlements,
44
- '010_upload_finalization': uploadFinalization,
45
- '011_upload_finalization_lease': uploadFinalizationLease,
46
- '012_transactional_email': transactionalEmail,
47
- '013_admin_enrollment': adminEnrollment,
48
- '014_enrollment_email_kinds': enrollmentEmailKinds,
49
- '015_cloud_rate_limit': cloudRateLimit,
50
- '016_auth_schema': authSchema,
51
- '017_authentication_email_kinds': authenticationEmailKinds,
52
- '018_authentication_mfa': authenticationMFA,
53
- '019_better_auth_account_issuer': betterAuthAccountIssuer,
54
- '020_workspace_invitations': workspaceInvitations,
55
- '021_document_versions': documentVersions,
56
- '022_entitlement_external_version': entitlementExternalVersion,
57
- '023_document_images': documentImages,
58
- '024_account_activity': accountActivity,
59
- '025_table_names': tableNames,
60
- '026_user_picture': userPicture,
61
- '027_document_kind': documentKind,
62
- '028_collaboration_updates': collaborationUpdates
14
+ /**
15
+ * A migration runs before the code it ships with, while the previous release still serves, so it
16
+ * only adds (expand): no table or column dropped, renamed, retyped, or newly required. One that
17
+ * must (contract) names each table or `table.column` it changes in `contracts`, and ships a
18
+ * release after the last code that used them (`tests/integration/server/db/expand.test.ts`).
19
+ */
20
+ export type CloudMigration = Migration & { contracts?: readonly string[] }
21
+
22
+ const migrations: Record<string, CloudMigration> = {
23
+ '001_accounts': accounts,
24
+ '002_workspaces': workspaces,
25
+ '003_storage': storage,
26
+ '004_documents': documents,
27
+ '005_sharing': sharing,
28
+ '006_operations': operations,
29
+ '007_trash': trash,
30
+ '008_terms': terms
63
31
  }
64
32
 
65
- class CloudMigrationProvider implements MigrationProvider {
66
- async getMigrations(): Promise<Record<string, Migration>> {
33
+ /** Cloud's migrations, in order. */
34
+ export class CloudMigrationProvider implements MigrationProvider {
35
+ async getMigrations(): Promise<Record<string, CloudMigration>> {
67
36
  return migrations
68
37
  }
69
38
  }
@@ -73,46 +42,11 @@ export type CloudAuthMigration = {
73
42
  schemaVersion: string
74
43
  }
75
44
 
76
- const REQUIRED_AUTH_SCHEMA: Record<string, string[]> = {
77
- user: [
78
- 'id',
79
- 'name',
80
- 'email',
81
- 'email_verified',
82
- 'created_at',
83
- 'updated_at',
84
- 'role',
85
- 'banned',
86
- 'two_factor_enabled'
87
- ],
88
- session: ['id', 'expires_at', 'token', 'user_id', 'impersonated_by'],
89
- account: ['id', 'account_id', 'provider_id', 'user_id'],
90
- verification: ['id', 'identifier', 'value', 'expires_at'],
91
- device_code: ['id', 'device_code', 'user_code', 'status', 'client_id'],
92
- rate_limit: ['id', 'key', 'count', 'last_request'],
93
- two_factor: [
94
- 'id',
95
- 'secret',
96
- 'backup_codes',
97
- 'user_id',
98
- 'verified',
99
- 'failed_verification_count',
100
- 'locked_until'
101
- ],
102
- passkey: ['id', 'public_key', 'user_id', 'credential_id', 'counter', 'device_type', 'backed_up']
103
- }
104
-
105
- async function existingAuthSchema(
106
- database: Kysely<CloudDatabase>
107
- ): Promise<Map<string, Set<string>>> {
108
- const tables = await database.introspection.getTables()
109
- return new Map(
110
- tables
111
- .filter((table) => Object.hasOwn(REQUIRED_AUTH_SCHEMA, table.name))
112
- .map((table) => [table.name, new Set(table.columns.map((column) => column.name))])
113
- )
114
- }
115
-
45
+ /**
46
+ * Better Auth's tables come from its own migration API, once, after Cloud's: the version they
47
+ * were built for is recorded, and a different one stops startup until someone migrates it
48
+ * deliberately, since Better Auth cannot say what an upgrade between its versions changes.
49
+ */
116
50
  async function migrateAuthSchema(
117
51
  database: Kysely<CloudDatabase>,
118
52
  migration: CloudAuthMigration
@@ -130,23 +64,7 @@ async function migrateAuthSchema(
130
64
  }
131
65
  return
132
66
  }
133
-
134
- const existing = await existingAuthSchema(database)
135
- if (existing.size === 0) {
136
- await migration.run()
137
- } else {
138
- const missing = Object.entries(REQUIRED_AUTH_SCHEMA).flatMap(([table, requiredColumns]) => {
139
- const columns = existing.get(table)
140
- if (!columns) return [table]
141
- return requiredColumns
142
- .filter((column) => !columns.has(column))
143
- .map((column) => `${table}.${column}`)
144
- })
145
- if (missing.length > 0) {
146
- throw new Error(`Existing Better Auth schema is incomplete: ${missing.join(', ')}`)
147
- }
148
- }
149
-
67
+ await migration.run()
150
68
  await database
151
69
  .insertInto('authSchemaVersion')
152
70
  .values({ id: 'better-auth', version: migration.schemaVersion, updatedAt: new Date() })
@@ -0,0 +1,79 @@
1
+ import type { Kysely } from 'kysely'
2
+
3
+ import { addChecks, addIndexes, dropTables, now, required } from './schema'
4
+
5
+ /** What Cloud keeps about an account beside Better Auth's tables: its plan, sign-ins, and picture. */
6
+ const TABLES = [
7
+ 'auth_schema_version',
8
+ 'account_entitlement',
9
+ 'mfa_assurance',
10
+ 'sign_in',
11
+ 'user_picture',
12
+ 'api_rate_limit'
13
+ ]
14
+
15
+ export async function up(database: Kysely<unknown>): Promise<void> {
16
+ // The Better Auth schema version this database was built for.
17
+ await database.schema
18
+ .createTable('auth_schema_version')
19
+ .addColumn('id', 'text', (column) => column.primaryKey())
20
+ .addColumn('version', 'text', required)
21
+ .addColumn('updated_at', 'timestamptz', now)
22
+ .execute()
23
+ // An account's plan, as billing or an operator set it; its workspaces share it.
24
+ await database.schema
25
+ .createTable('account_entitlement')
26
+ .addColumn('user_id', 'text', (column) => column.primaryKey())
27
+ .addColumn('values', 'jsonb', required)
28
+ .addColumn('source', 'text', required)
29
+ .addColumn('revision', 'integer', (column) => column.notNull().defaultTo(1))
30
+ .addColumn('external_version', 'bigint')
31
+ .addColumn('updated_at', 'timestamptz', now)
32
+ .execute()
33
+ await database.schema
34
+ .createTable('mfa_assurance')
35
+ .addColumn('session_id', 'uuid', (column) => column.primaryKey())
36
+ .addColumn('user_id', 'uuid', required)
37
+ .addColumn('method', 'text', required)
38
+ .addColumn('verified_at', 'timestamptz', required)
39
+ .execute()
40
+ await database.schema
41
+ .createTable('sign_in')
42
+ .addColumn('id', 'uuid', (column) => column.primaryKey())
43
+ .addColumn('user_id', 'uuid', required)
44
+ .addColumn('session_id', 'uuid')
45
+ .addColumn('method', 'text', required)
46
+ .addColumn('ip_address', 'text')
47
+ .addColumn('user_agent', 'text')
48
+ .addColumn('created_at', 'timestamptz', now)
49
+ .execute()
50
+ await database.schema
51
+ .createTable('user_picture')
52
+ .addColumn('user_id', 'uuid', (column) => column.primaryKey())
53
+ .addColumn('bytes', 'bytea', required)
54
+ .addColumn('format', 'text', required)
55
+ .addColumn('checksum', 'text', required)
56
+ .addColumn('source', 'text', required)
57
+ .addColumn('created_at', 'timestamptz', now)
58
+ .execute()
59
+ // OpenPencil's own rate limits; Better Auth keeps its own in `rate_limit`.
60
+ await database.schema
61
+ .createTable('api_rate_limit')
62
+ .addColumn('key_hash', 'text', (column) => column.primaryKey())
63
+ .addColumn('window_started_at', 'timestamptz', required)
64
+ .addColumn('request_count', 'integer', (column) => column.notNull().defaultTo(1))
65
+ .addColumn('updated_at', 'timestamptz', now)
66
+ .execute()
67
+ await addChecks(database, [
68
+ ['user_picture', 'format', ['png', 'jpeg']],
69
+ ['user_picture', 'source', ['upload', 'provider']]
70
+ ])
71
+ await addIndexes(database, [
72
+ ['sign_in', ['user_id', 'created_at']],
73
+ ['sign_in', ['session_id']]
74
+ ])
75
+ }
76
+
77
+ export async function down(database: Kysely<unknown>): Promise<void> {
78
+ await dropTables(database, TABLES)
79
+ }
@@ -0,0 +1,48 @@
1
+ import type { Kysely } from 'kysely'
2
+
3
+ import { addChecks, addIndexes, dropTables, now, required, ROLES, withInvitation } from './schema'
4
+
5
+ /** Workspaces, their members, and the people invited to join. */
6
+ const TABLES = ['workspace', 'workspace_member', 'workspace_invitation']
7
+
8
+ export async function up(database: Kysely<unknown>): Promise<void> {
9
+ // A workspace takes its limits from its owner's plan.
10
+ await database.schema
11
+ .createTable('workspace')
12
+ .addColumn('id', 'uuid', (column) => column.primaryKey())
13
+ .addColumn('name', 'text', required)
14
+ .addColumn('slug', 'text', (column) => column.notNull().unique())
15
+ .addColumn('created_by', 'text', required)
16
+ .addColumn('owner_id', 'text', required)
17
+ .addColumn('created_at', 'timestamptz', now)
18
+ .addColumn('updated_at', 'timestamptz', now)
19
+ .execute()
20
+ await database.schema
21
+ .createTable('workspace_member')
22
+ .addColumn('workspace_id', 'uuid', (column) =>
23
+ column.notNull().references('workspace.id').onDelete('cascade')
24
+ )
25
+ .addColumn('user_id', 'text', required)
26
+ .addColumn('role', 'text', required)
27
+ .addColumn('created_at', 'timestamptz', now)
28
+ .addPrimaryKeyConstraint('workspace_member_pkey', ['workspace_id', 'user_id'])
29
+ .execute()
30
+ await withInvitation(database.schema.createTable('workspace_invitation'), 'role')
31
+ .addColumn('workspace_id', 'uuid', (column) =>
32
+ column.notNull().references('workspace.id').onDelete('cascade')
33
+ )
34
+ .execute()
35
+ await addChecks(database, [
36
+ ['workspace_member', 'role', ROLES],
37
+ ['workspace_invitation', 'role', ROLES]
38
+ ])
39
+ await addIndexes(database, [
40
+ ['workspace', ['owner_id']],
41
+ ['workspace_member', ['user_id']],
42
+ ['workspace_invitation', ['workspace_id', 'revoked_at']]
43
+ ])
44
+ }
45
+
46
+ export async function down(database: Kysely<unknown>): Promise<void> {
47
+ await dropTables(database, TABLES)
48
+ }
@@ -0,0 +1,44 @@
1
+ import type { Kysely } from 'kysely'
2
+
3
+ import { dropTables, now, required } from './schema'
4
+
5
+ /** Files in the object store, a workspace's images among them, and how much each workspace uses. */
6
+ const TABLES = ['storage_object', 'workspace_storage_usage', 'workspace_image']
7
+
8
+ export async function up(database: Kysely<unknown>): Promise<void> {
9
+ // A stored file, by content; revisions, snapshots, and images refer to one.
10
+ await database.schema
11
+ .createTable('storage_object')
12
+ .addColumn('id', 'uuid', (column) => column.primaryKey())
13
+ .addColumn('object_key', 'text', (column) => column.notNull().unique())
14
+ .addColumn('checksum', 'text', required)
15
+ .addColumn('byte_size', 'bigint', required)
16
+ .addColumn('content_type', 'text', required)
17
+ .addColumn('created_at', 'timestamptz', now)
18
+ .execute()
19
+ await database.schema
20
+ .createTable('workspace_storage_usage')
21
+ .addColumn('workspace_id', 'uuid', (column) =>
22
+ column.primaryKey().references('workspace.id').onDelete('cascade')
23
+ )
24
+ .addColumn('committed_bytes', 'bigint', (column) => column.notNull().defaultTo(0))
25
+ .addColumn('updated_at', 'timestamptz', now)
26
+ .execute()
27
+ // A workspace's images, each stored once; revisions name the ones they use.
28
+ await database.schema
29
+ .createTable('workspace_image')
30
+ .addColumn('workspace_id', 'uuid', (column) =>
31
+ column.notNull().references('workspace.id').onDelete('cascade')
32
+ )
33
+ .addColumn('checksum', 'text', required)
34
+ .addColumn('storage_object_id', 'uuid', (column) =>
35
+ column.notNull().unique().references('storage_object.id')
36
+ )
37
+ .addColumn('touched_at', 'timestamptz', now)
38
+ .addPrimaryKeyConstraint('workspace_image_pkey', ['workspace_id', 'checksum'])
39
+ .execute()
40
+ }
41
+
42
+ export async function down(database: Kysely<unknown>): Promise<void> {
43
+ await dropTables(database, TABLES)
44
+ }
@@ -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
+ }