@open-pencil/cloud 0.0.0-stage → 0.17.0-beta.1

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 (279) hide show
  1. package/LICENSE +202 -0
  2. package/LICENSE-MIT +21 -0
  3. package/NOTICE +7 -0
  4. package/README.md +37 -2
  5. package/dist/bin/ai-relay.d.mts +1 -0
  6. package/dist/bin/ai-relay.mjs +31 -0
  7. package/dist/bin/ai-relay.mjs.map +1 -0
  8. package/dist/bin/server.d.mts +1 -0
  9. package/dist/bin/server.mjs +29 -0
  10. package/dist/bin/server.mjs.map +1 -0
  11. package/dist/client.d.ts +1520 -0
  12. package/dist/client.d.ts.map +1 -0
  13. package/dist/client.js +1917 -0
  14. package/dist/client.js.map +1 -0
  15. package/dist/contract.d.ts +2 -0
  16. package/dist/contract.js +2 -0
  17. package/dist/contract2.js +1453 -0
  18. package/dist/contract2.js.map +1 -0
  19. package/dist/email.d.ts +169 -0
  20. package/dist/email.d.ts.map +1 -0
  21. package/dist/email.js +670 -0
  22. package/dist/email.js.map +1 -0
  23. package/dist/index.d.ts +1755 -0
  24. package/dist/index.d.ts.map +1 -0
  25. package/dist/listen.mjs +1881 -0
  26. package/dist/listen.mjs.map +1 -0
  27. package/dist/runtime-node.d.mts +10040 -0
  28. package/dist/runtime-node.d.mts.map +1 -0
  29. package/dist/runtime-node.mjs +32 -0
  30. package/dist/runtime-node.mjs.map +1 -0
  31. package/dist/server.d.ts +12792 -0
  32. package/dist/server.d.ts.map +1 -0
  33. package/dist/server.js +8475 -0
  34. package/dist/server.js.map +1 -0
  35. package/dist/server.mjs +8324 -0
  36. package/dist/server.mjs.map +1 -0
  37. package/dist/server2.mjs +505 -0
  38. package/dist/server2.mjs.map +1 -0
  39. package/package.json +124 -4
  40. package/src/admin/api/routes.ts +223 -0
  41. package/src/admin/api/security.ts +12 -0
  42. package/src/admin/audit/service.ts +138 -0
  43. package/src/admin/email/service.ts +140 -0
  44. package/src/admin/enrollment/email.ts +77 -0
  45. package/src/admin/enrollment/service.ts +308 -0
  46. package/src/admin/errors.ts +20 -0
  47. package/src/admin/index.ts +19 -0
  48. package/src/admin/list.ts +61 -0
  49. package/src/admin/operations/service.ts +70 -0
  50. package/src/admin/schema.ts +28 -0
  51. package/src/admin/users/service.ts +369 -0
  52. package/src/ai-relay/app.ts +251 -0
  53. package/src/ai-relay/config.ts +120 -0
  54. package/src/ai-relay/db/index.ts +10 -0
  55. package/src/ai-relay/db/migrate.ts +32 -0
  56. package/src/ai-relay/db/migrations/001_usage.ts +26 -0
  57. package/src/ai-relay/db/schema.ts +20 -0
  58. package/src/ai-relay/index.ts +18 -0
  59. package/src/ai-relay/metering.ts +68 -0
  60. package/src/ai-relay/usage.ts +115 -0
  61. package/src/client/ai.ts +96 -0
  62. package/src/client/api.ts +528 -0
  63. package/src/client/auth/client.ts +188 -0
  64. package/src/client/auth/failure.ts +54 -0
  65. package/src/client/auth/navigation.ts +45 -0
  66. package/src/client/device-authorization.ts +134 -0
  67. package/src/client/discovery.ts +105 -0
  68. package/src/client/images.ts +81 -0
  69. package/src/client/index.ts +53 -0
  70. package/src/client/portal/account.ts +183 -0
  71. package/src/client/portal/administration.ts +130 -0
  72. package/src/client/portal/client.ts +18 -0
  73. package/src/client/portal/request.ts +115 -0
  74. package/src/client/response.ts +51 -0
  75. package/src/client/workspaces.ts +142 -0
  76. package/src/contract/account.ts +204 -0
  77. package/src/contract/admin/index.ts +187 -0
  78. package/src/contract/ai.ts +150 -0
  79. package/src/contract/collaboration.ts +45 -0
  80. package/src/contract/discovery.ts +81 -0
  81. package/src/contract/documents.ts +265 -0
  82. package/src/contract/entitlements.ts +28 -0
  83. package/src/contract/index.ts +204 -0
  84. package/src/contract/links.ts +87 -0
  85. package/src/contract/portal.ts +11 -0
  86. package/src/contract/relay.ts +368 -0
  87. package/src/contract/sharing.ts +191 -0
  88. package/src/contract/versions.ts +87 -0
  89. package/src/contract/workspaces.ts +100 -0
  90. package/src/email/index.ts +14 -0
  91. package/src/email/render.ts +276 -0
  92. package/src/email/schema.ts +144 -0
  93. package/src/email/templates/brand.ts +105 -0
  94. package/src/email/templates/document-invitation.ts +35 -0
  95. package/src/email/templates/enrollment.ts +27 -0
  96. package/src/email/templates/layout.ts +18 -0
  97. package/src/runtime/cloudflare/email.ts +70 -0
  98. package/src/runtime/cloudflare/environment.ts +57 -0
  99. package/src/runtime/cloudflare/index.ts +3 -0
  100. package/src/runtime/cloudflare/relay.ts +136 -0
  101. package/src/runtime/cloudflare/site.ts +13 -0
  102. package/src/runtime/cloudflare/tsconfig.json +21 -0
  103. package/src/runtime/cloudflare/worker.ts +160 -0
  104. package/src/runtime/node/admin.ts +59 -0
  105. package/src/runtime/node/ai-relay/main.ts +35 -0
  106. package/src/runtime/node/ai-relay/server.ts +63 -0
  107. package/src/runtime/node/application.ts +50 -0
  108. package/src/runtime/node/bootstrap.ts +22 -0
  109. package/src/runtime/node/cleanup.ts +24 -0
  110. package/src/runtime/node/command.ts +17 -0
  111. package/src/runtime/node/config.ts +16 -0
  112. package/src/runtime/node/email/runtime.ts +43 -0
  113. package/src/runtime/node/email/transport.ts +112 -0
  114. package/src/runtime/node/entitlements/main.ts +41 -0
  115. package/src/runtime/node/entitlements/refusal.ts +15 -0
  116. package/src/runtime/node/index.ts +25 -0
  117. package/src/runtime/node/listen.ts +35 -0
  118. package/src/runtime/node/main.ts +29 -0
  119. package/src/runtime/node/migrate.ts +13 -0
  120. package/src/runtime/node/quota-reconcile.ts +9 -0
  121. package/src/runtime/node/relay.ts +54 -0
  122. package/src/runtime/node/server.ts +121 -0
  123. package/src/runtime/node/site.ts +64 -0
  124. package/src/runtime/postgres/database.ts +19 -0
  125. package/src/runtime/s3/objects.ts +244 -0
  126. package/src/runtime/site/server.ts +82 -0
  127. package/src/server/account/actions.ts +66 -0
  128. package/src/server/account/routes.ts +300 -0
  129. package/src/server/ai/errors.ts +7 -0
  130. package/src/server/ai/index.ts +4 -0
  131. package/src/server/ai/keys.ts +43 -0
  132. package/src/server/ai/routes.ts +43 -0
  133. package/src/server/ai/service.ts +70 -0
  134. package/src/server/api/index.ts +8 -0
  135. package/src/server/api/router.ts +117 -0
  136. package/src/server/api/types.ts +7 -0
  137. package/src/server/app.ts +375 -0
  138. package/src/server/auth/account.ts +73 -0
  139. package/src/server/auth/activity.ts +213 -0
  140. package/src/server/auth/adapter.ts +79 -0
  141. package/src/server/auth/email.ts +125 -0
  142. package/src/server/auth/endpoints.ts +57 -0
  143. package/src/server/auth/factory.ts +583 -0
  144. package/src/server/auth/index.ts +17 -0
  145. package/src/server/auth/mfa-assurance.ts +55 -0
  146. package/src/server/auth/runtime.ts +26 -0
  147. package/src/server/auth/session.ts +19 -0
  148. package/src/server/auth/social-providers.ts +55 -0
  149. package/src/server/auth/user-agent.ts +16 -0
  150. package/src/server/auth/workspace-access.ts +23 -0
  151. package/src/server/cleanup/configured.ts +38 -0
  152. package/src/server/cleanup/documents.ts +231 -0
  153. package/src/server/cleanup/index.ts +29 -0
  154. package/src/server/cleanup/objects.ts +27 -0
  155. package/src/server/cleanup/revisions.ts +232 -0
  156. package/src/server/cleanup/uploads.ts +129 -0
  157. package/src/server/cleanup/worker.ts +79 -0
  158. package/src/server/collaboration/index.ts +28 -0
  159. package/src/server/collaboration/relay/authorize.ts +53 -0
  160. package/src/server/collaboration/relay/awareness.ts +104 -0
  161. package/src/server/collaboration/relay/documents.ts +39 -0
  162. package/src/server/collaboration/relay/hub.ts +524 -0
  163. package/src/server/collaboration/relay/index.ts +15 -0
  164. package/src/server/collaboration/relay/persistence.ts +48 -0
  165. package/src/server/collaboration/routes.ts +77 -0
  166. package/src/server/collaboration/service.ts +188 -0
  167. package/src/server/config/deployment.ts +178 -0
  168. package/src/server/config/index.ts +20 -0
  169. package/src/server/config/limits.ts +8 -0
  170. package/src/server/config/public.ts +66 -0
  171. package/src/server/config/schema.ts +512 -0
  172. package/src/server/db/database.ts +15 -0
  173. package/src/server/db/expressions.ts +13 -0
  174. package/src/server/db/index.ts +21 -0
  175. package/src/server/db/migrate.ts +177 -0
  176. package/src/server/db/migrations/001_foundation.ts +164 -0
  177. package/src/server/db/migrations/002_upload_cleanup_claims.ts +34 -0
  178. package/src/server/db/migrations/003_document_cleanup_claims.ts +23 -0
  179. package/src/server/db/migrations/004_document_sharing.ts +82 -0
  180. package/src/server/db/migrations/005_document_collaboration_epoch.ts +13 -0
  181. package/src/server/db/migrations/006_invitation_continuation.ts +27 -0
  182. package/src/server/db/migrations/007_collaboration_state.ts +25 -0
  183. package/src/server/db/migrations/008_storage_reservations.ts +37 -0
  184. package/src/server/db/migrations/009_workspace_entitlements.ts +22 -0
  185. package/src/server/db/migrations/010_upload_finalization.ts +22 -0
  186. package/src/server/db/migrations/011_upload_finalization_lease.ts +12 -0
  187. package/src/server/db/migrations/012_transactional_email.ts +48 -0
  188. package/src/server/db/migrations/013_admin_enrollment.ts +54 -0
  189. package/src/server/db/migrations/014_enrollment_email_kinds.ts +30 -0
  190. package/src/server/db/migrations/015_cloud_rate_limit.ts +22 -0
  191. package/src/server/db/migrations/016_auth_schema.ts +16 -0
  192. package/src/server/db/migrations/017_authentication_email_kinds.ts +32 -0
  193. package/src/server/db/migrations/018_authentication_mfa.ts +78 -0
  194. package/src/server/db/migrations/019_better_auth_account_issuer.ts +42 -0
  195. package/src/server/db/migrations/020_workspace_invitations.ts +57 -0
  196. package/src/server/db/migrations/021_document_versions.ts +66 -0
  197. package/src/server/db/migrations/022_entitlement_external_version.ts +17 -0
  198. package/src/server/db/migrations/023_document_images.ts +61 -0
  199. package/src/server/db/migrations/024_account_activity.ts +66 -0
  200. package/src/server/db/migrations/025_table_names.ts +58 -0
  201. package/src/server/db/migrations/026_user_picture.ts +30 -0
  202. package/src/server/db/migrations/027_document_kind.ts +19 -0
  203. package/src/server/db/migrations/helpers.ts +78 -0
  204. package/src/server/db/tables.ts +394 -0
  205. package/src/server/documents/access.ts +103 -0
  206. package/src/server/documents/errors.ts +16 -0
  207. package/src/server/documents/images.ts +407 -0
  208. package/src/server/documents/index.ts +14 -0
  209. package/src/server/documents/limits.ts +57 -0
  210. package/src/server/documents/repository.ts +141 -0
  211. package/src/server/documents/routes.ts +239 -0
  212. package/src/server/documents/service.ts +597 -0
  213. package/src/server/documents/summary.ts +37 -0
  214. package/src/server/documents/types.ts +14 -0
  215. package/src/server/documents/versions/checkpoint.ts +98 -0
  216. package/src/server/documents/versions/history.ts +25 -0
  217. package/src/server/documents/versions/index.ts +4 -0
  218. package/src/server/documents/versions/routes.ts +112 -0
  219. package/src/server/documents/versions/service.ts +397 -0
  220. package/src/server/email/crypto.ts +57 -0
  221. package/src/server/email/index.ts +18 -0
  222. package/src/server/email/invitations.ts +30 -0
  223. package/src/server/email/service.ts +245 -0
  224. package/src/server/email/types.ts +56 -0
  225. package/src/server/email/worker.ts +33 -0
  226. package/src/server/index.ts +279 -0
  227. package/src/server/internal/index.ts +8 -0
  228. package/src/server/internal/routes.ts +41 -0
  229. package/src/server/internal/schema.ts +10 -0
  230. package/src/server/internal/service.ts +44 -0
  231. package/src/server/invitations/index.ts +6 -0
  232. package/src/server/invitations/types.ts +30 -0
  233. package/src/server/objects/index.ts +16 -0
  234. package/src/server/objects/types.ts +81 -0
  235. package/src/server/pictures/index.ts +9 -0
  236. package/src/server/pictures/provider.ts +61 -0
  237. package/src/server/pictures/routes.ts +21 -0
  238. package/src/server/pictures/service.ts +235 -0
  239. package/src/server/policy/configured.ts +23 -0
  240. package/src/server/policy/database.ts +108 -0
  241. package/src/server/policy/entitlements.ts +29 -0
  242. package/src/server/policy/index.ts +17 -0
  243. package/src/server/policy/keys.ts +23 -0
  244. package/src/server/policy/policy.ts +117 -0
  245. package/src/server/policy/provider.ts +67 -0
  246. package/src/server/policy/schema.ts +69 -0
  247. package/src/server/policy/service.ts +85 -0
  248. package/src/server/policy/static.ts +62 -0
  249. package/src/server/quota/index.ts +7 -0
  250. package/src/server/quota/reconcile.ts +61 -0
  251. package/src/server/quota/storage.ts +165 -0
  252. package/src/server/rate-limit/cleanup.ts +16 -0
  253. package/src/server/rate-limit/index.ts +12 -0
  254. package/src/server/rate-limit/keys.ts +38 -0
  255. package/src/server/rate-limit/middleware.ts +137 -0
  256. package/src/server/rate-limit/postgres.ts +79 -0
  257. package/src/server/sharing/access.ts +29 -0
  258. package/src/server/sharing/actor.ts +12 -0
  259. package/src/server/sharing/capabilities/service.ts +262 -0
  260. package/src/server/sharing/continuation.ts +85 -0
  261. package/src/server/sharing/contracts.ts +80 -0
  262. package/src/server/sharing/crypto.ts +48 -0
  263. package/src/server/sharing/document-routes.ts +41 -0
  264. package/src/server/sharing/errors.ts +12 -0
  265. package/src/server/sharing/grants/service.ts +79 -0
  266. package/src/server/sharing/http.ts +41 -0
  267. package/src/server/sharing/index.ts +39 -0
  268. package/src/server/sharing/invitations/service.ts +315 -0
  269. package/src/server/sharing/policy.ts +44 -0
  270. package/src/server/sharing/routes.ts +251 -0
  271. package/src/server/sharing/service.ts +117 -0
  272. package/src/server/validation.ts +24 -0
  273. package/src/server/worker/interval.ts +23 -0
  274. package/src/server/worker/periodic.ts +42 -0
  275. package/src/server/workspaces/index.ts +16 -0
  276. package/src/server/workspaces/members.ts +502 -0
  277. package/src/server/workspaces/repository.ts +91 -0
  278. package/src/server/workspaces/routes.ts +198 -0
  279. package/src/server/workspaces/service.ts +84 -0
@@ -0,0 +1,129 @@
1
+ import type { CloudDatabase } from '#cloud/server/db'
2
+ import type { ObjectStore } from '#cloud/server/objects'
3
+ import { createStorageQuotaService } from '#cloud/server/quota'
4
+ import type { Kysely } from 'kysely'
5
+
6
+ export type UploadCleanupOptions = {
7
+ batchSize: number
8
+ leaseDurationMs: number
9
+ now?: Date
10
+ }
11
+
12
+ export type UploadCleanupResult = {
13
+ claimed: number
14
+ cleaned: number
15
+ failed: number
16
+ }
17
+
18
+ export type UploadCleanupService = {
19
+ cleanupExpiredUploads(options: UploadCleanupOptions): Promise<UploadCleanupResult>
20
+ }
21
+
22
+ type ClaimedUpload = {
23
+ id: string
24
+ objectKey: string
25
+ multipartUploadId: string | null
26
+ }
27
+
28
+ export function createUploadCleanupService(
29
+ database: Kysely<CloudDatabase>,
30
+ objects: ObjectStore
31
+ ): UploadCleanupService {
32
+ const quota = createStorageQuotaService(database)
33
+ return {
34
+ async cleanupExpiredUploads(options) {
35
+ const now = options.now ?? new Date()
36
+ const staleBefore = new Date(now.getTime() - options.leaseDurationMs)
37
+ const claimId = crypto.randomUUID()
38
+ const uploads = await database.transaction().execute(async (transaction) => {
39
+ const candidates = await transaction
40
+ .selectFrom('upload')
41
+ .select(['id', 'objectKey', 'multipartUploadId'])
42
+ .where((expression) =>
43
+ expression.or([
44
+ expression.and([
45
+ expression('status', '=', 'pending'),
46
+ expression('expiresAt', '<=', now)
47
+ ]),
48
+ expression.and([
49
+ expression('status', '=', 'finalizing'),
50
+ expression('finalizationStartedAt', '<=', staleBefore)
51
+ ]),
52
+ expression.and([
53
+ expression('status', '=', 'cleaning'),
54
+ expression('cleanupClaimedAt', '<=', staleBefore)
55
+ ])
56
+ ])
57
+ )
58
+ .orderBy('expiresAt')
59
+ .limit(options.batchSize)
60
+ .forUpdate()
61
+ .skipLocked()
62
+ .execute()
63
+ if (candidates.length === 0) return []
64
+ const ids = candidates.map((upload) => upload.id)
65
+ await transaction
66
+ .updateTable('upload')
67
+ .set({
68
+ status: 'cleaning',
69
+ finalizationStartedAt: null,
70
+ cleanupClaimId: claimId,
71
+ cleanupClaimedAt: now
72
+ })
73
+ .where('id', 'in', ids)
74
+ .execute()
75
+ return candidates
76
+ })
77
+
78
+ let cleaned = 0
79
+ let failed = 0
80
+ for (const upload of uploads) {
81
+ try {
82
+ await removeUploadObject(objects, upload)
83
+ const result = await database
84
+ .updateTable('upload')
85
+ .set({
86
+ status: 'abandoned',
87
+ finalizationStartedAt: null,
88
+ cleanupClaimId: null,
89
+ cleanupClaimedAt: null
90
+ })
91
+ .where('id', '=', upload.id)
92
+ .where('status', '=', 'cleaning')
93
+ .where('cleanupClaimId', '=', claimId)
94
+ .executeTakeFirst()
95
+ if (Number(result.numUpdatedRows) > 0) {
96
+ await quota.release(upload.id)
97
+ cleaned++
98
+ }
99
+ } catch {
100
+ failed++
101
+ await database
102
+ .updateTable('upload')
103
+ .set({
104
+ status: 'pending',
105
+ finalizationStartedAt: null,
106
+ cleanupClaimId: null,
107
+ cleanupClaimedAt: null
108
+ })
109
+ .where('id', '=', upload.id)
110
+ .where('status', '=', 'cleaning')
111
+ .where('cleanupClaimId', '=', claimId)
112
+ .execute()
113
+ }
114
+ }
115
+ return { claimed: uploads.length, cleaned, failed }
116
+ }
117
+ }
118
+ }
119
+
120
+ /**
121
+ * Aborting covers a multipart upload that never finished; deleting covers one that did, such as an
122
+ * upload whose commit lost to a newer revision after its parts were assembled.
123
+ */
124
+ async function removeUploadObject(objects: ObjectStore, upload: ClaimedUpload): Promise<void> {
125
+ if (upload.multipartUploadId) {
126
+ await objects.abortUpload({ key: upload.objectKey, uploadId: upload.multipartUploadId })
127
+ }
128
+ await objects.delete(upload.objectKey)
129
+ }
@@ -0,0 +1,79 @@
1
+ import { startPeriodicWorker } from '../worker/periodic'
2
+ import type { DocumentCleanupResult, DocumentCleanupService } from './documents'
3
+ import {
4
+ REVISION_COMPACTION_GRACE_MS,
5
+ type RevisionCompactionResult,
6
+ type RevisionCompactionService
7
+ } from './revisions'
8
+ import type { UploadCleanupResult, UploadCleanupService } from './uploads'
9
+
10
+ export type CleanupWorkerOptions = {
11
+ batchSize: number
12
+ documentRetentionMs: number
13
+ intervalMs: number
14
+ leaseDurationMs: number
15
+ signal?: AbortSignal
16
+ onError?: (error: unknown) => void
17
+ }
18
+
19
+ export type CleanupResult = {
20
+ uploads: UploadCleanupResult
21
+ documents: DocumentCleanupResult
22
+ revisions: RevisionCompactionResult | null
23
+ rateLimits: number
24
+ }
25
+
26
+ export type CleanupServices = {
27
+ documents: DocumentCleanupService
28
+ uploads: UploadCleanupService
29
+ revisions?: RevisionCompactionService
30
+ rateLimits?: { cleanupExpired(before: Date): Promise<number> }
31
+ }
32
+
33
+ export type CleanupWorker = {
34
+ runOnce(): Promise<CleanupResult>
35
+ stop(): Promise<void>
36
+ }
37
+
38
+ export type CleanupPassOptions = Pick<
39
+ CleanupWorkerOptions,
40
+ 'batchSize' | 'documentRetentionMs' | 'leaseDurationMs'
41
+ >
42
+
43
+ /** One cleanup pass, for runtimes that schedule passes themselves. */
44
+ export async function runCleanup(
45
+ cleanup: CleanupServices,
46
+ options: CleanupPassOptions
47
+ ): Promise<CleanupResult> {
48
+ const uploads = await cleanup.uploads.cleanupExpiredUploads({
49
+ batchSize: options.batchSize,
50
+ leaseDurationMs: options.leaseDurationMs
51
+ })
52
+ const documents = await cleanup.documents.cleanupDeletedDocuments({
53
+ batchSize: options.batchSize,
54
+ leaseDurationMs: options.leaseDurationMs,
55
+ retentionMs: options.documentRetentionMs
56
+ })
57
+ const revisions = cleanup.revisions
58
+ ? await cleanup.revisions.compactRevisions({
59
+ batchSize: options.batchSize,
60
+ graceMs: REVISION_COMPACTION_GRACE_MS
61
+ })
62
+ : null
63
+ const rateLimits = cleanup.rateLimits
64
+ ? await cleanup.rateLimits.cleanupExpired(new Date(Date.now() - 24 * 60 * 60_000))
65
+ : 0
66
+ return { uploads, documents, revisions, rateLimits }
67
+ }
68
+
69
+ export function startCleanupWorker(
70
+ cleanup: CleanupServices,
71
+ options: CleanupWorkerOptions
72
+ ): CleanupWorker {
73
+ return startPeriodicWorker({
74
+ intervalMs: options.intervalMs,
75
+ signal: options.signal,
76
+ onError: options.onError,
77
+ run: () => runCleanup(cleanup, options)
78
+ })
79
+ }
@@ -0,0 +1,28 @@
1
+ export {
2
+ createCollaborationRoutes,
3
+ createPublicCollaborationRoutes,
4
+ type CollaborationRouteEnvironment
5
+ } from './routes'
6
+ export {
7
+ createCollaborationTicketService,
8
+ signCollaborationTicket,
9
+ type CollaborationTicketClaims,
10
+ type CollaborationTicketService,
11
+ type CollaborationTicketServiceOptions
12
+ } from './service'
13
+ export {
14
+ authorizeRelayTicket,
15
+ createCollaborationRelay,
16
+ createCollaborationStateStore,
17
+ relayDocumentLookups,
18
+ stampAwareness,
19
+ type CollaborationRelay,
20
+ type CollaborationRelayOptions,
21
+ type CollaborationRoomIdentity,
22
+ type CollaborationStateStore,
23
+ type RelayAuthorization,
24
+ type RelayConnection,
25
+ type RelaySocket,
26
+ type StampedAwareness,
27
+ type VerifiedPresence
28
+ } from './relay'
@@ -0,0 +1,53 @@
1
+ import {
2
+ collaborationPrincipalSchema,
3
+ type CollaborationPrincipal,
4
+ type DocumentPermission
5
+ } from '#cloud/contract'
6
+ import { jwtVerify } from 'jose'
7
+ import * as v from 'valibot'
8
+
9
+ const relayClaimsSchema = v.object({
10
+ documentId: v.pipe(v.string(), v.uuid()),
11
+ roomId: v.string(),
12
+ principal: collaborationPrincipalSchema,
13
+ permission: v.picklist(['view', 'edit']),
14
+ roomEpoch: v.pipe(v.number(), v.integer(), v.minValue(0)),
15
+ serverEnforcedWrites: v.literal(true),
16
+ exp: v.pipe(v.number(), v.integer())
17
+ })
18
+
19
+ export type RelayAuthorization = {
20
+ roomId: string
21
+ documentId: string
22
+ roomEpoch: number
23
+ permission: DocumentPermission
24
+ principal: CollaborationPrincipal
25
+ /** When the ticket stops being valid, in milliseconds since the epoch. */
26
+ expiresAt: number
27
+ }
28
+
29
+ /** Verifies a collaboration ticket issued for the relay; throws for anything else. */
30
+ export async function authorizeRelayTicket(
31
+ token: string,
32
+ authSecret: string
33
+ ): Promise<RelayAuthorization> {
34
+ const verified = await jwtVerify(token, new TextEncoder().encode(authSecret), {
35
+ algorithms: ['HS256']
36
+ })
37
+ const claims = v.parse(relayClaimsSchema, verified.payload)
38
+ if (claims.roomId !== `cloud:${claims.documentId}:${claims.roomEpoch}`) {
39
+ throw new Error('Collaboration ticket names a different room')
40
+ }
41
+ return {
42
+ roomId: claims.roomId,
43
+ documentId: claims.documentId,
44
+ roomEpoch: claims.roomEpoch,
45
+ permission: claims.permission,
46
+ principal: claims.principal,
47
+ expiresAt: claims.exp * 1000
48
+ }
49
+ }
50
+
51
+ export function principalKey(principal: CollaborationPrincipal): string {
52
+ return principal.kind === 'user' ? `user:${principal.userId}` : `guest:${principal.guestId}`
53
+ }
@@ -0,0 +1,104 @@
1
+ import {
2
+ presenceName,
3
+ type CloudPresence,
4
+ type CollaborationPrincipal,
5
+ type DocumentPermission
6
+ } from '#cloud/contract'
7
+ import * as decoding from 'lib0/decoding'
8
+ import * as encoding from 'lib0/encoding'
9
+ import * as v from 'valibot'
10
+
11
+ const awarenessStateSchema = v.pipe(
12
+ v.string(),
13
+ v.parseJson(),
14
+ v.looseObject({ user: v.optional(v.looseObject({})) })
15
+ )
16
+
17
+ type AwarenessEntry = { clientId: number; clock: number; state: string }
18
+
19
+ function decodeEntries(update: Uint8Array): AwarenessEntry[] | null {
20
+ try {
21
+ const decoder = decoding.createDecoder(update)
22
+ const count = decoding.readVarUint(decoder)
23
+ const entries: AwarenessEntry[] = []
24
+ for (let index = 0; index < count; index++) {
25
+ entries.push({
26
+ clientId: decoding.readVarUint(decoder),
27
+ clock: decoding.readVarUint(decoder),
28
+ state: decoding.readVarString(decoder)
29
+ })
30
+ }
31
+ return decoder.pos === update.byteLength ? entries : null
32
+ } catch {
33
+ return null
34
+ }
35
+ }
36
+
37
+ function encodeEntries(entries: AwarenessEntry[]): Uint8Array {
38
+ return encoding.encode((encoder) => {
39
+ encoding.writeVarUint(encoder, entries.length)
40
+ for (const entry of entries) {
41
+ encoding.writeVarUint(encoder, entry.clientId)
42
+ encoding.writeVarUint(encoder, entry.clock)
43
+ encoding.writeVarString(encoder, entry.state)
44
+ }
45
+ })
46
+ }
47
+
48
+ /** Who the relay verified a peer to be, as other peers see it in presence. */
49
+ export type VerifiedPresence = {
50
+ principal: CollaborationPrincipal
51
+ permission: DocumentPermission
52
+ }
53
+
54
+ function verifiedIdentity({ principal, permission }: VerifiedPresence): CloudPresence {
55
+ return {
56
+ kind: principal.kind,
57
+ id: principal.kind === 'user' ? principal.userId : principal.guestId,
58
+ name: principal.name,
59
+ permission
60
+ }
61
+ }
62
+
63
+ export type StampedAwareness = {
64
+ /** The update to forward, or null when nothing in it may be forwarded. */
65
+ update: Uint8Array | null
66
+ /** Presence clients this update introduced for the peer. */
67
+ claimed: number[]
68
+ }
69
+
70
+ /**
71
+ * Rewrites a peer's presence update so others see who the relay verified rather than what the
72
+ * peer claims: the display name comes from the ticket, and a `cloud` field carries the verified
73
+ * identity and permission. Entries for presence clients another peer owns are dropped, so one
74
+ * peer cannot speak for another; removals pass through for the peer's own clients only.
75
+ */
76
+ export function stampAwareness(
77
+ update: Uint8Array,
78
+ presence: VerifiedPresence,
79
+ ownedByOthers: (clientId: number) => boolean
80
+ ): StampedAwareness {
81
+ const entries = decodeEntries(update)
82
+ if (!entries) return { update: null, claimed: [] }
83
+ const identity = verifiedIdentity(presence)
84
+ const forwarded: AwarenessEntry[] = []
85
+ const claimed: number[] = []
86
+ for (const entry of entries) {
87
+ if (ownedByOthers(entry.clientId)) continue
88
+ if (entry.state === 'null') {
89
+ forwarded.push(entry)
90
+ continue
91
+ }
92
+ const parsed = v.safeParse(awarenessStateSchema, entry.state)
93
+ if (!parsed.success) continue
94
+ const state = {
95
+ ...parsed.output,
96
+ // The ticket's name, cut to what peers accept, so a long one cannot hide the member.
97
+ user: { ...parsed.output.user, name: presenceName(identity.name) },
98
+ cloud: identity
99
+ }
100
+ claimed.push(entry.clientId)
101
+ forwarded.push({ ...entry, state: JSON.stringify(state) })
102
+ }
103
+ return { update: forwarded.length > 0 ? encodeEntries(forwarded) : null, claimed }
104
+ }
@@ -0,0 +1,39 @@
1
+ import type { CloudDatabase } from '#cloud/server/db'
2
+ import { CLOUD_FEATURE_KEYS } from '#cloud/server/policy/keys'
3
+ import type { CloudPolicy } from '#cloud/server/policy/policy'
4
+ import type { Kysely } from 'kysely'
5
+
6
+ import type { CollaborationRelayOptions } from './hub'
7
+
8
+ /** The relay's lookups of a document: its participant limit under `policy`, and its epoch. */
9
+ export function relayDocumentLookups(
10
+ database: Kysely<CloudDatabase>,
11
+ policy: CloudPolicy,
12
+ deploymentMode: 'official' | 'self-hosted'
13
+ ): Pick<CollaborationRelayOptions, 'maximumParticipants' | 'currentRoomEpoch'> {
14
+ return {
15
+ async maximumParticipants(documentId) {
16
+ const document = await database
17
+ .selectFrom('document')
18
+ .select('workspaceId')
19
+ .where('id', '=', documentId)
20
+ .executeTakeFirst()
21
+ if (!document) return 0
22
+ const limit = await policy.number(CLOUD_FEATURE_KEYS.maximumParticipants, -1, {
23
+ targetingKey: document.workspaceId,
24
+ workspaceId: document.workspaceId,
25
+ documentId,
26
+ deploymentMode
27
+ })
28
+ return limit < 0 ? null : limit
29
+ },
30
+ async currentRoomEpoch(documentId) {
31
+ const document = await database
32
+ .selectFrom('document')
33
+ .select('collaborationEpoch')
34
+ .where('id', '=', documentId)
35
+ .executeTakeFirst()
36
+ return document?.collaborationEpoch ?? null
37
+ }
38
+ }
39
+ }