@open-pencil/cloud 0.17.0-beta.2 → 0.17.0-beta.5

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 (339) hide show
  1. package/README.md +3 -2
  2. package/dist/bin/server.mjs +1 -1
  3. package/dist/bin/server.mjs.map +1 -1
  4. package/dist/bin/{ai-relay.mjs → services.mjs} +9 -9
  5. package/dist/bin/services.mjs.map +1 -0
  6. package/dist/client.d.ts +525 -66
  7. package/dist/client.d.ts.map +1 -1
  8. package/dist/client.js +1257 -654
  9. package/dist/client.js.map +1 -1
  10. package/dist/contract.d.ts +2 -2
  11. package/dist/contract.js +2 -2
  12. package/dist/contract2.js +1028 -481
  13. package/dist/contract2.js.map +1 -1
  14. package/dist/email.d.ts +1780 -31
  15. package/dist/email.d.ts.map +1 -1
  16. package/dist/email.js +3556 -325
  17. package/dist/email.js.map +1 -1
  18. package/dist/errors.d.ts +2 -0
  19. package/dist/errors.js +48 -0
  20. package/dist/errors.js.map +1 -0
  21. package/dist/index.d.ts +929 -72
  22. package/dist/index.d.ts.map +1 -1
  23. package/dist/index2.d.ts +35 -0
  24. package/dist/index2.d.ts.map +1 -0
  25. package/dist/listen.mjs +802 -927
  26. package/dist/listen.mjs.map +1 -1
  27. package/dist/runtime-cloudflare.d.ts +89 -0
  28. package/dist/runtime-cloudflare.d.ts.map +1 -0
  29. package/dist/runtime-cloudflare.js +15667 -0
  30. package/dist/runtime-cloudflare.js.map +1 -0
  31. package/dist/runtime-node.d.mts +7166 -3101
  32. package/dist/runtime-node.d.mts.map +1 -1
  33. package/dist/runtime-node.mjs +6 -5
  34. package/dist/runtime-node.mjs.map +1 -1
  35. package/dist/server.d.ts +6525 -2205
  36. package/dist/server.d.ts.map +1 -1
  37. package/dist/server.js +12500 -7613
  38. package/dist/server.js.map +1 -1
  39. package/dist/server.mjs +8625 -2878
  40. package/dist/server.mjs.map +1 -1
  41. package/dist/server2.mjs +101 -79
  42. package/dist/server2.mjs.map +1 -1
  43. package/package.json +27 -9
  44. package/src/admin/api/routes.ts +59 -0
  45. package/src/admin/audit/service.ts +27 -8
  46. package/src/admin/documents/service.ts +431 -0
  47. package/src/admin/errors.ts +9 -1
  48. package/src/admin/index.ts +6 -0
  49. package/src/admin/operations/service.ts +7 -0
  50. package/src/admin/reports/service.ts +153 -0
  51. package/src/admin/schema.ts +6 -0
  52. package/src/client/api.ts +28 -461
  53. package/src/client/auth/client.ts +22 -3
  54. package/src/client/auth/navigation.ts +6 -5
  55. package/src/client/billing.ts +80 -0
  56. package/src/client/community.ts +40 -0
  57. package/src/client/discovery.ts +35 -9
  58. package/src/client/documents.ts +160 -0
  59. package/src/client/index.ts +14 -7
  60. package/src/client/portal/account.ts +79 -2
  61. package/src/client/portal/administration.ts +56 -0
  62. package/src/client/portal/request.ts +2 -0
  63. package/src/client/response.ts +21 -0
  64. package/src/client/schema.ts +8 -0
  65. package/src/client/services.ts +118 -0
  66. package/src/client/sharing.ts +262 -0
  67. package/src/client/versions.ts +104 -0
  68. package/src/contract/account.ts +108 -2
  69. package/src/contract/admin/index.ts +67 -3
  70. package/src/contract/billing.ts +166 -0
  71. package/src/contract/collaboration.ts +11 -1
  72. package/src/contract/community.ts +60 -0
  73. package/src/contract/discovery.ts +83 -4
  74. package/src/contract/documents.ts +27 -0
  75. package/src/contract/entitlements.ts +12 -2
  76. package/src/contract/index.ts +114 -39
  77. package/src/contract/links.ts +57 -4
  78. package/src/contract/locale.ts +27 -0
  79. package/src/contract/portal.ts +12 -1
  80. package/src/contract/relay.ts +6 -0
  81. package/src/contract/reports.ts +42 -0
  82. package/src/contract/routes.ts +10 -0
  83. package/src/contract/services.ts +235 -0
  84. package/src/contract/sharing.ts +3 -9
  85. package/src/email/i18n.ts +174 -0
  86. package/src/email/index.ts +13 -2
  87. package/src/email/locales/ar.json +141 -0
  88. package/src/email/locales/de.json +141 -0
  89. package/src/email/locales/es.json +141 -0
  90. package/src/email/locales/fr.json +141 -0
  91. package/src/email/locales/it.json +141 -0
  92. package/src/email/locales/ja.json +141 -0
  93. package/src/email/locales/pl.json +141 -0
  94. package/src/email/locales/pt-br.json +141 -0
  95. package/src/email/locales/ru.json +141 -0
  96. package/src/email/locales/zh-cn.json +141 -0
  97. package/src/email/messages.ts +200 -0
  98. package/src/email/render.ts +138 -246
  99. package/src/email/samples.ts +115 -0
  100. package/src/email/schema.ts +79 -5
  101. package/src/email/templates/BrandEmail.vue +54 -0
  102. package/src/email/templates/DocumentBlocked.vue +45 -0
  103. package/src/email/templates/DocumentInvitation.vue +24 -0
  104. package/src/email/templates/DocumentReport.vue +32 -0
  105. package/src/email/templates/DocumentReportDecided.vue +36 -0
  106. package/src/email/templates/DocumentReportReceived.vue +18 -0
  107. package/src/email/templates/DocumentRestored.vue +24 -0
  108. package/src/email/templates/EmailChangeRequested.vue +24 -0
  109. package/src/email/templates/EmailRoot.vue +19 -0
  110. package/src/email/templates/EmailText.vue +9 -0
  111. package/src/email/templates/EmailVerification.vue +38 -0
  112. package/src/email/templates/EnrollmentNotification.vue +24 -0
  113. package/src/email/templates/EnrollmentUpdate.vue +52 -0
  114. package/src/email/templates/NewSignIn.vue +37 -0
  115. package/src/email/templates/PasswordChanged.vue +22 -0
  116. package/src/email/templates/PasswordReset.vue +23 -0
  117. package/src/email/templates/StorageLimitReached.vue +28 -0
  118. package/src/email/templates/TwoStepChanged.vue +32 -0
  119. package/src/email/templates/WaitlistConfirmation.vue +29 -0
  120. package/src/email/templates/WorkspaceInvitation.vue +28 -0
  121. package/src/email/templates/brand.ts +9 -61
  122. package/src/email/templates/localization.ts +17 -0
  123. package/src/errors/index.ts +6 -0
  124. package/src/errors/posthog.ts +80 -0
  125. package/src/global.d.ts +7 -0
  126. package/src/runtime/cloudflare/environment.ts +22 -11
  127. package/src/runtime/cloudflare/index.ts +1 -1
  128. package/src/runtime/cloudflare/logging.ts +15 -0
  129. package/src/runtime/cloudflare/maintenance.ts +31 -0
  130. package/src/runtime/cloudflare/relay/index.ts +69 -15
  131. package/src/runtime/cloudflare/tsconfig.json +2 -1
  132. package/src/runtime/cloudflare/worker.ts +46 -13
  133. package/src/runtime/node/application.ts +5 -3
  134. package/src/runtime/node/bootstrap.ts +15 -4
  135. package/src/runtime/node/cleanup.ts +20 -3
  136. package/src/runtime/node/email/transport.ts +13 -10
  137. package/src/runtime/node/entitlements/main.ts +14 -11
  138. package/src/runtime/node/index.ts +1 -1
  139. package/src/runtime/node/main.ts +1 -1
  140. package/src/runtime/node/migrate.ts +5 -1
  141. package/src/runtime/node/relay.ts +8 -2
  142. package/src/runtime/node/request-id.ts +13 -0
  143. package/src/runtime/node/server.ts +50 -16
  144. package/src/runtime/node/{ai-relay → services}/main.ts +7 -7
  145. package/src/runtime/node/{ai-relay → services}/server.ts +18 -18
  146. package/src/runtime/postgres/database.ts +20 -1
  147. package/src/runtime/posthog/errors.ts +15 -30
  148. package/src/runtime/s3/objects.ts +41 -1
  149. package/src/runtime/site/community.ts +101 -0
  150. package/src/runtime/site/server.ts +49 -6
  151. package/src/server/account/actions.ts +5 -0
  152. package/src/server/account/deletion.ts +304 -0
  153. package/src/server/account/routes.ts +281 -206
  154. package/src/server/account/terms.ts +42 -0
  155. package/src/server/account/tokens.ts +57 -0
  156. package/src/server/api/router.ts +32 -5
  157. package/src/server/api/types.ts +2 -0
  158. package/src/server/app/checks.ts +84 -0
  159. package/src/server/app/editors.ts +20 -0
  160. package/src/server/app/index.ts +128 -0
  161. package/src/server/app/indexing.ts +40 -0
  162. package/src/server/app/limiters.ts +53 -0
  163. package/src/server/app/routes.ts +114 -0
  164. package/src/server/app/services.ts +185 -0
  165. package/src/server/auth/access-control.ts +63 -0
  166. package/src/server/auth/access-tokens.ts +62 -0
  167. package/src/server/auth/adapter.ts +32 -1
  168. package/src/server/auth/email.ts +4 -1
  169. package/src/server/auth/endpoints.ts +5 -1
  170. package/src/server/auth/enrollment.ts +116 -0
  171. package/src/server/auth/factory.ts +116 -132
  172. package/src/server/auth/index.ts +10 -1
  173. package/src/server/auth/logger.ts +23 -0
  174. package/src/server/auth/mfa-assurance.ts +51 -0
  175. package/src/server/auth/passwords.ts +43 -0
  176. package/src/server/auth/session.ts +2 -0
  177. package/src/server/billing/index.ts +6 -0
  178. package/src/server/billing/routes.ts +27 -0
  179. package/src/server/billing/tokens.ts +37 -0
  180. package/src/server/cleanup/configured.ts +27 -7
  181. package/src/server/cleanup/documents.ts +165 -71
  182. package/src/server/cleanup/revisions.ts +16 -5
  183. package/src/server/cleanup/uploads.ts +8 -2
  184. package/src/server/cleanup/worker.ts +15 -3
  185. package/src/server/collaboration/relay/connection.ts +4 -3
  186. package/src/server/collaboration/relay/documents.ts +13 -10
  187. package/src/server/collaboration/relay/hub.ts +77 -122
  188. package/src/server/collaboration/relay/log.ts +5 -2
  189. package/src/server/collaboration/relay/room.ts +154 -0
  190. package/src/server/collaboration/service.ts +48 -33
  191. package/src/server/community/index.ts +2 -0
  192. package/src/server/community/routes.ts +93 -0
  193. package/src/server/community/service.ts +134 -0
  194. package/src/server/config/deployment.ts +41 -9
  195. package/src/server/config/index.ts +1 -1
  196. package/src/server/config/public.ts +11 -4
  197. package/src/server/config/schema.ts +91 -277
  198. package/src/server/config/toml/schema.ts +307 -0
  199. package/src/server/db/expressions.ts +15 -1
  200. package/src/server/db/index.ts +1 -0
  201. package/src/server/db/migrate.ts +46 -116
  202. package/src/server/db/migrations/001_accounts.ts +79 -0
  203. package/src/server/db/migrations/002_workspaces.ts +48 -0
  204. package/src/server/db/migrations/003_storage.ts +44 -0
  205. package/src/server/db/migrations/004_documents.ts +193 -0
  206. package/src/server/db/migrations/005_sharing.ts +95 -0
  207. package/src/server/db/migrations/006_operations.ts +110 -0
  208. package/src/server/db/migrations/007_trash.ts +33 -0
  209. package/src/server/db/migrations/008_terms.ts +18 -0
  210. package/src/server/db/migrations/009_access_tokens.ts +47 -0
  211. package/src/server/db/migrations/010_storage_limit_notices.ts +50 -0
  212. package/src/server/db/migrations/011_account_ids.ts +30 -0
  213. package/src/server/db/migrations/012_email_locales.ts +34 -0
  214. package/src/server/db/migrations/013_document_block_emails.ts +40 -0
  215. package/src/server/db/migrations/014_report_replies.ts +28 -0
  216. package/src/server/db/migrations/schema.ts +96 -0
  217. package/src/server/db/tables.ts +82 -4
  218. package/src/server/db/users.ts +22 -0
  219. package/src/server/documents/access.ts +66 -55
  220. package/src/server/documents/errors.ts +7 -0
  221. package/src/server/documents/images.ts +2 -1
  222. package/src/server/documents/index.ts +1 -1
  223. package/src/server/documents/limits.ts +14 -8
  224. package/src/server/documents/purge.ts +75 -0
  225. package/src/server/documents/repository.ts +2 -0
  226. package/src/server/documents/routes.ts +26 -0
  227. package/src/server/documents/service.ts +30 -406
  228. package/src/server/documents/summary.ts +1 -0
  229. package/src/server/documents/trash.ts +203 -0
  230. package/src/server/documents/uploads.ts +450 -0
  231. package/src/server/documents/versions/checkpoint.ts +2 -1
  232. package/src/server/documents/versions/history.ts +11 -7
  233. package/src/server/documents/versions/service.ts +94 -28
  234. package/src/server/email/invitations.ts +1 -0
  235. package/src/server/email/service.ts +31 -4
  236. package/src/server/email/types.ts +12 -0
  237. package/src/server/errors/index.ts +51 -16
  238. package/src/server/index.ts +52 -16
  239. package/src/server/internal/index.ts +3 -3
  240. package/src/server/internal/routes.ts +7 -10
  241. package/src/server/internal/schema.ts +1 -1
  242. package/src/server/internal/service.ts +17 -23
  243. package/src/server/invitations/budget.ts +66 -0
  244. package/src/server/invitations/index.ts +1 -0
  245. package/src/server/invitations/types.ts +5 -1
  246. package/src/server/logging.ts +76 -0
  247. package/src/server/objects/types.ts +5 -0
  248. package/src/server/pictures/service.ts +2 -1
  249. package/src/server/policy/configured.ts +9 -3
  250. package/src/server/policy/database.ts +52 -27
  251. package/src/server/policy/index.ts +2 -1
  252. package/src/server/policy/keys.ts +5 -2
  253. package/src/server/policy/policy.ts +40 -12
  254. package/src/server/policy/schema.ts +2 -2
  255. package/src/server/policy/service.ts +78 -56
  256. package/src/server/policy/static.ts +5 -5
  257. package/src/server/policy/storage.ts +33 -0
  258. package/src/server/policy/workspace.ts +41 -0
  259. package/src/server/quota/index.ts +6 -0
  260. package/src/server/quota/notices.ts +121 -0
  261. package/src/server/quota/reconcile.ts +2 -0
  262. package/src/server/quota/storage.ts +74 -31
  263. package/src/server/rate-limit/cleanup.ts +17 -5
  264. package/src/server/rate-limit/middleware.ts +6 -2
  265. package/src/server/reports/index.ts +9 -0
  266. package/src/server/reports/replies.ts +55 -0
  267. package/src/server/reports/routes.ts +39 -0
  268. package/src/server/reports/service.ts +145 -0
  269. package/src/server/services/errors.ts +7 -0
  270. package/src/server/services/index.ts +8 -0
  271. package/src/server/{ai → services}/keys.ts +11 -11
  272. package/src/server/services/routes.ts +47 -0
  273. package/src/server/{ai/service.ts → services/tokens.ts} +23 -20
  274. package/src/server/sharing/capabilities/service.ts +68 -23
  275. package/src/server/sharing/grants/service.ts +11 -18
  276. package/src/server/sharing/http.ts +4 -0
  277. package/src/server/sharing/invitations/service.ts +35 -15
  278. package/src/server/sharing/policy.ts +9 -14
  279. package/src/server/sharing/routes.ts +0 -16
  280. package/src/server/sharing/service.ts +1 -17
  281. package/src/server/validation.ts +4 -0
  282. package/src/server/workspaces/index.ts +1 -0
  283. package/src/server/workspaces/members.ts +91 -52
  284. package/src/server/workspaces/repository.ts +2 -1
  285. package/src/server/workspaces/routes.ts +4 -0
  286. package/src/{ai-relay → services}/app.ts +46 -44
  287. package/src/{ai-relay → services}/config.ts +26 -19
  288. package/src/services/db/index.ts +10 -0
  289. package/src/services/db/migrate.ts +37 -0
  290. package/src/{ai-relay/db/migrations/001_usage.ts → services/db/migrations/001_baseline.ts} +18 -7
  291. package/src/services/db/schema.ts +22 -0
  292. package/src/services/index.ts +18 -0
  293. package/src/{ai-relay → services}/metering.ts +2 -2
  294. package/src/{ai-relay → services}/usage.ts +35 -19
  295. package/dist/bin/ai-relay.mjs.map +0 -1
  296. package/src/ai-relay/db/index.ts +0 -10
  297. package/src/ai-relay/db/migrate.ts +0 -32
  298. package/src/ai-relay/db/schema.ts +0 -20
  299. package/src/ai-relay/index.ts +0 -18
  300. package/src/client/ai.ts +0 -96
  301. package/src/contract/ai.ts +0 -150
  302. package/src/email/templates/document-invitation.ts +0 -35
  303. package/src/email/templates/enrollment.ts +0 -27
  304. package/src/email/templates/layout.ts +0 -18
  305. package/src/server/ai/errors.ts +0 -7
  306. package/src/server/ai/index.ts +0 -4
  307. package/src/server/ai/routes.ts +0 -43
  308. package/src/server/app.ts +0 -379
  309. package/src/server/auth/workspace-access.ts +0 -23
  310. package/src/server/db/migrations/001_foundation.ts +0 -164
  311. package/src/server/db/migrations/002_upload_cleanup_claims.ts +0 -34
  312. package/src/server/db/migrations/003_document_cleanup_claims.ts +0 -23
  313. package/src/server/db/migrations/004_document_sharing.ts +0 -82
  314. package/src/server/db/migrations/005_document_collaboration_epoch.ts +0 -13
  315. package/src/server/db/migrations/006_invitation_continuation.ts +0 -27
  316. package/src/server/db/migrations/007_collaboration_state.ts +0 -25
  317. package/src/server/db/migrations/008_storage_reservations.ts +0 -37
  318. package/src/server/db/migrations/009_workspace_entitlements.ts +0 -22
  319. package/src/server/db/migrations/010_upload_finalization.ts +0 -22
  320. package/src/server/db/migrations/011_upload_finalization_lease.ts +0 -12
  321. package/src/server/db/migrations/012_transactional_email.ts +0 -48
  322. package/src/server/db/migrations/013_admin_enrollment.ts +0 -54
  323. package/src/server/db/migrations/014_enrollment_email_kinds.ts +0 -30
  324. package/src/server/db/migrations/015_cloud_rate_limit.ts +0 -22
  325. package/src/server/db/migrations/016_auth_schema.ts +0 -16
  326. package/src/server/db/migrations/017_authentication_email_kinds.ts +0 -32
  327. package/src/server/db/migrations/018_authentication_mfa.ts +0 -78
  328. package/src/server/db/migrations/019_better_auth_account_issuer.ts +0 -42
  329. package/src/server/db/migrations/020_workspace_invitations.ts +0 -57
  330. package/src/server/db/migrations/021_document_versions.ts +0 -66
  331. package/src/server/db/migrations/022_entitlement_external_version.ts +0 -17
  332. package/src/server/db/migrations/023_document_images.ts +0 -61
  333. package/src/server/db/migrations/024_account_activity.ts +0 -66
  334. package/src/server/db/migrations/025_table_names.ts +0 -58
  335. package/src/server/db/migrations/026_user_picture.ts +0 -30
  336. package/src/server/db/migrations/027_document_kind.ts +0 -19
  337. package/src/server/db/migrations/028_collaboration_updates.ts +0 -84
  338. package/src/server/db/migrations/helpers.ts +0 -78
  339. /package/dist/bin/{ai-relay.d.mts → services.d.mts} +0 -0
@@ -11,6 +11,8 @@ import { DocumentNotFoundError } from '#cloud/server/documents'
11
11
  import { resolveDocumentAccess } from '#cloud/server/documents/access'
12
12
  import { CLOUD_FEATURE_KEYS } from '#cloud/server/policy/keys'
13
13
  import type { CloudPolicy } from '#cloud/server/policy/policy'
14
+ import { storageLimitReached } from '#cloud/server/policy/storage'
15
+ import { workspacePolicyContext } from '#cloud/server/policy/workspace'
14
16
  import type { DocumentSharingService } from '#cloud/server/sharing'
15
17
  import { base64url, SignJWT } from 'jose'
16
18
  import type { Kysely } from 'kysely'
@@ -39,6 +41,8 @@ export type CollaborationTicketClaims = {
39
41
  documentId: string
40
42
  principal: CollaborationPrincipal
41
43
  permission: DocumentPermission
44
+ /** Why a peer who could edit only views, which the editor explains; never part of the token. */
45
+ readOnly?: 'storage-limit'
42
46
  roomEpoch: number
43
47
  /**
44
48
  * The relay that enforces writes; without one the ticket is for peer-to-peer rooms. The ticket's
@@ -53,6 +57,7 @@ export async function signCollaborationTicket({
53
57
  documentId,
54
58
  principal,
55
59
  permission,
60
+ readOnly,
56
61
  roomEpoch,
57
62
  relayURL
58
63
  }: CollaborationTicketClaims): Promise<CollaborationTicket> {
@@ -74,13 +79,22 @@ export async function signCollaborationTicket({
74
79
  .setExpirationTime(expiresAtSeconds)
75
80
  .setSubject(principal.kind === 'user' ? principal.userId : principal.guestId)
76
81
  .sign(new TextEncoder().encode(authSecret))
77
- return {
82
+ const ticket = {
78
83
  token,
79
- provider: relayURL ? ('relay' as const) : ('trystero' as const),
80
- ...(relayURL ? { serverURL: withQuery(relayURL, { [RELAY_DOCUMENT_PARAM]: documentId }) } : {}),
84
+ provider: 'trystero' as const,
85
+ ...(readOnly && { readOnly }),
81
86
  ...claims,
82
87
  roomKey,
83
- expiresAt: new Date(expiresAtSeconds * 1000).toISOString()
88
+ expiresAt: new Date(expiresAtSeconds * 1000).toISOString(),
89
+ relayHeartbeat: false
90
+ }
91
+ if (!relayURL) return ticket
92
+ // This deployment's relay answers the heartbeat, which editors then use to notice a lost socket.
93
+ return {
94
+ ...ticket,
95
+ provider: 'relay' as const,
96
+ serverURL: withQuery(relayURL, { [RELAY_DOCUMENT_PARAM]: documentId }),
97
+ relayHeartbeat: true
84
98
  }
85
99
  }
86
100
 
@@ -101,25 +115,31 @@ export function createCollaborationTicketService({
101
115
  policy,
102
116
  deploymentMode = 'self-hosted'
103
117
  }: CollaborationTicketServiceOptions) {
118
+ /**
119
+ * The permission a ticket carries: an owner at their storage limit leaves their documents
120
+ * read-only, so whoever could edit them views them instead, and the ticket says why.
121
+ */
122
+ async function ticketPermission(documentId: string, permission: DocumentPermission) {
123
+ if (
124
+ permission === 'edit' &&
125
+ (await storageLimitReached(database, policy, { documentId }, deploymentMode))
126
+ ) {
127
+ return { permission: 'view' as const, readOnly: 'storage-limit' as const }
128
+ }
129
+ return { permission }
130
+ }
131
+
104
132
  return {
105
133
  async issueUserTicket(actor: CloudActor, documentId: string): Promise<CollaborationTicket> {
106
134
  const access = await resolveDocumentAccess(database, actor.userId, documentId)
107
135
  if (!access) throw new DocumentNotFoundError()
108
136
  if (policy) {
109
- const workspace = await database
110
- .selectFrom('document')
111
- .select('workspaceId')
112
- .where('id', '=', documentId)
113
- .executeTakeFirstOrThrow()
114
- if (
115
- !(await policy.boolean(CLOUD_FEATURE_KEYS.collaboration, false, {
116
- targetingKey: workspace.workspaceId,
117
- actorId: actor.userId,
118
- workspaceId: workspace.workspaceId,
119
- documentId,
120
- deploymentMode
121
- }))
122
- ) {
137
+ const context = await workspacePolicyContext(
138
+ database,
139
+ { documentId },
140
+ { actorId: actor.userId, deploymentMode }
141
+ )
142
+ if (!context || !(await policy.boolean(CLOUD_FEATURE_KEYS.collaboration, false, context))) {
123
143
  throw new DocumentNotFoundError()
124
144
  }
125
145
  }
@@ -128,13 +148,14 @@ export function createCollaborationTicketService({
128
148
  .select('collaborationEpoch')
129
149
  .where('id', '=', documentId)
130
150
  .where('deletedAt', 'is', null)
151
+ .where('disabledAt', 'is', null)
131
152
  .executeTakeFirst()
132
153
  if (!document) throw new DocumentNotFoundError()
133
154
  return signCollaborationTicket({
134
155
  authSecret,
135
156
  documentId,
136
157
  principal: { kind: 'user', userId: actor.userId, name: actor.name, email: actor.email },
137
- permission: access.permission,
158
+ ...(await ticketPermission(documentId, access.permission)),
138
159
  roomEpoch: document.collaborationEpoch,
139
160
  relayURL
140
161
  })
@@ -147,19 +168,12 @@ export function createCollaborationTicketService({
147
168
  ): Promise<CollaborationTicket> {
148
169
  const resolved = await sharing.resolveShare(shareId, input, actor)
149
170
  if (policy) {
150
- const workspace = await database
151
- .selectFrom('document')
152
- .select('workspaceId')
153
- .where('id', '=', resolved.documentId)
154
- .executeTakeFirstOrThrow()
155
- const context = {
156
- targetingKey: workspace.workspaceId,
157
- ...(actor ? { actorId: actor.userId } : {}),
158
- workspaceId: workspace.workspaceId,
159
- documentId: resolved.documentId,
160
- deploymentMode
161
- }
162
- if (!(await policy.boolean(CLOUD_FEATURE_KEYS.collaboration, false, context))) {
171
+ const context = await workspacePolicyContext(
172
+ database,
173
+ { documentId: resolved.documentId },
174
+ { actorId: actor?.userId, deploymentMode }
175
+ )
176
+ if (!context || !(await policy.boolean(CLOUD_FEATURE_KEYS.collaboration, false, context))) {
163
177
  throw new DocumentNotFoundError()
164
178
  }
165
179
  if (!actor && !(await policy.boolean(CLOUD_FEATURE_KEYS.guestPresence, false, context))) {
@@ -171,13 +185,14 @@ export function createCollaborationTicketService({
171
185
  .select('collaborationEpoch')
172
186
  .where('id', '=', resolved.documentId)
173
187
  .where('deletedAt', 'is', null)
188
+ .where('disabledAt', 'is', null)
174
189
  .executeTakeFirst()
175
190
  if (!document) throw new DocumentNotFoundError()
176
191
  return signCollaborationTicket({
177
192
  authSecret,
178
193
  documentId: resolved.documentId,
179
194
  principal: resolved.principal,
180
- permission: resolved.permission,
195
+ ...(await ticketPermission(resolved.documentId, resolved.permission)),
181
196
  roomEpoch: document.collaborationEpoch,
182
197
  relayURL
183
198
  })
@@ -0,0 +1,2 @@
1
+ export { createCommunityRoutes, createCommunityThumbnailRoutes } from './routes'
2
+ export { createCommunityService, type CommunityService } from './service'
@@ -0,0 +1,93 @@
1
+ import {
2
+ COMMUNITY_THUMBNAIL_PATH,
3
+ parseCommunityDownloadQuery,
4
+ parseRequestImageLinks
5
+ } from '#cloud/contract'
6
+ import { documentDomainError } from '#cloud/server/documents'
7
+ import {
8
+ communityThumbnailParams,
9
+ documentParams,
10
+ validatedJSON,
11
+ validatedQuery
12
+ } from '#cloud/server/validation'
13
+ import { Hono, type Context } from 'hono'
14
+
15
+ import type { CommunityService } from './service'
16
+
17
+ const notFound = (context: Context) => context.json({ error: { code: 'not_found' as const } }, 404)
18
+
19
+ /** Answers a missing or hidden gallery document as not found, like any document outside it. */
20
+ async function communityRoute(context: Context, action: () => Promise<Response>) {
21
+ try {
22
+ return await action()
23
+ } catch (error) {
24
+ const response = documentDomainError(context, error)
25
+ if (response) return response
26
+ throw error
27
+ }
28
+ }
29
+
30
+ /**
31
+ * The community gallery's data for anyone, signed in or not: the list, a document or one of its
32
+ * named versions to open read-only, and the links of its images. A deployment without a gallery
33
+ * answers not found.
34
+ */
35
+ export function createCommunityRoutes(community: CommunityService) {
36
+ return new Hono()
37
+ .get('/community', async (context) => {
38
+ if (!community.enabled) return notFound(context)
39
+ // The gallery changes on a publish; a few minutes' copy spares the database repeat visits.
40
+ context.header('Cache-Control', 'public, max-age=300')
41
+ return context.json({ documents: await community.list() })
42
+ })
43
+ .get(
44
+ '/community/:documentId/document',
45
+ documentParams,
46
+ validatedQuery(parseCommunityDownloadQuery),
47
+ (context) =>
48
+ communityRoute(context, async () => {
49
+ const { documentId } = context.req.valid('param')
50
+ return context.json(
51
+ await community.download(documentId, context.req.valid('query').version)
52
+ )
53
+ })
54
+ )
55
+ .post(
56
+ '/community/:documentId/images',
57
+ documentParams,
58
+ validatedJSON(parseRequestImageLinks),
59
+ (context) =>
60
+ communityRoute(context, async () =>
61
+ context.json(
62
+ await community.imageLinks(
63
+ context.req.valid('param').documentId,
64
+ context.req.valid('json').checksums
65
+ )
66
+ )
67
+ )
68
+ )
69
+ }
70
+
71
+ /**
72
+ * Gallery thumbnails, for pages and apps on any origin. Each address names the revision it shows,
73
+ * so a copy never goes stale, but it is cached only as long as the listing is: a document taken
74
+ * down or out of the gallery stops showing everywhere within minutes.
75
+ */
76
+ export function createCommunityThumbnailRoutes(community: CommunityService) {
77
+ return new Hono().get(
78
+ `${COMMUNITY_THUMBNAIL_PATH}/:documentId/:revisionId`,
79
+ communityThumbnailParams,
80
+ (context) =>
81
+ communityRoute(context, async () => {
82
+ const { documentId, revisionId } = context.req.valid('param')
83
+ const thumbnail = await community.thumbnail(documentId, revisionId)
84
+ if (!thumbnail) return notFound(context)
85
+ context.header('Cache-Control', 'public, max-age=300')
86
+ context.header('Content-Type', 'image/png')
87
+ context.header('X-Content-Type-Options', 'nosniff')
88
+ context.header('Content-Security-Policy', "default-src 'none'; sandbox")
89
+ context.header('Cross-Origin-Resource-Policy', 'cross-origin')
90
+ return context.body(new Uint8Array(thumbnail))
91
+ })
92
+ )
93
+ }
@@ -0,0 +1,134 @@
1
+ import {
2
+ communityThumbnailPath,
3
+ type CommunityDocument,
4
+ type CommunityDownload,
5
+ type CommunityVersion,
6
+ type DocumentVersion
7
+ } from '#cloud/contract'
8
+ import { isBannedNow, userIdText, type CloudDatabase } from '#cloud/server/db'
9
+ import { DocumentNotFoundError, type DocumentService } from '#cloud/server/documents'
10
+ import type { DocumentVersionService } from '#cloud/server/documents/versions'
11
+ import type { ObjectStore } from '#cloud/server/objects'
12
+ import type { Kysely } from 'kysely'
13
+
14
+ import { extractFigThumbnailFromReader } from '@open-pencil/fig'
15
+
16
+ const communityVersion = (version: DocumentVersion): CommunityVersion => ({
17
+ id: version.id,
18
+ name: version.name ?? '',
19
+ description: version.description || null,
20
+ createdAt: version.createdAt,
21
+ current: version.current
22
+ })
23
+
24
+ /**
25
+ * The deployment's community gallery: the documents of the workspace its config names, which
26
+ * anyone may open read-only without signing in or a link. Nothing marks a document as published;
27
+ * saving it to the workspace publishes it and moving it out takes it down. A document the
28
+ * workspace's members could not open either — deleted, taken down by an administrator, never
29
+ * saved, or made by a banned account — is not in the gallery.
30
+ */
31
+ export function createCommunityService(
32
+ database: Kysely<CloudDatabase>,
33
+ objects: ObjectStore,
34
+ documents: Pick<DocumentService, 'downloadShared' | 'imageLinksShared'>,
35
+ versions: Pick<DocumentVersionService, 'namedSharedIn' | 'downloadNamedShared'>,
36
+ workspaceId: string | null
37
+ ) {
38
+ function published() {
39
+ return database
40
+ .selectFrom('document')
41
+ .innerJoin('documentRevision', 'documentRevision.id', 'document.currentRevisionId')
42
+ .innerJoin('storageObject', 'storageObject.id', 'documentRevision.storageObjectId')
43
+ .select([
44
+ 'document.id',
45
+ 'document.name',
46
+ 'document.kind',
47
+ 'document.updatedAt',
48
+ 'document.currentRevisionId as revisionId',
49
+ 'storageObject.objectKey',
50
+ 'storageObject.byteSize'
51
+ ])
52
+ .where('document.workspaceId', '=', workspaceId ?? '')
53
+ .where('document.deletedAt', 'is', null)
54
+ .where('document.disabledAt', 'is', null)
55
+ .where((expression) =>
56
+ expression.not(
57
+ expression.exists(
58
+ expression
59
+ .selectFrom('user')
60
+ .select('user.id')
61
+ .whereRef(userIdText, '=', 'document.createdBy')
62
+ .where(isBannedNow)
63
+ )
64
+ )
65
+ )
66
+ }
67
+
68
+ /** A document of the gallery, or not found for any other, so nothing outside it shows. */
69
+ async function find(documentId: string) {
70
+ if (!workspaceId) throw new DocumentNotFoundError()
71
+ const row = await published().where('document.id', '=', documentId).executeTakeFirst()
72
+ if (!row?.revisionId) throw new DocumentNotFoundError()
73
+ return { ...row, revisionId: row.revisionId }
74
+ }
75
+
76
+ return {
77
+ /** Whether the deployment has a gallery at all. */
78
+ enabled: workspaceId !== null,
79
+
80
+ /** The gallery's documents, most recently changed first, each with its named versions. */
81
+ async list(): Promise<CommunityDocument[]> {
82
+ if (!workspaceId) return []
83
+ const rows = (await published().orderBy('document.updatedAt', 'desc').execute()).flatMap(
84
+ ({ revisionId, ...row }) => (revisionId ? [{ ...row, revisionId }] : [])
85
+ )
86
+ const named = await versions.namedSharedIn(
87
+ workspaceId,
88
+ rows.map((row) => ({ id: row.id, currentRevisionId: row.revisionId }))
89
+ )
90
+ return rows.map((row) => ({
91
+ id: row.id,
92
+ name: row.name,
93
+ kind: row.kind,
94
+ updatedAt: new Date(row.updatedAt).toISOString(),
95
+ revisionId: row.revisionId,
96
+ thumbnailPath: communityThumbnailPath(row.id, row.revisionId),
97
+ versions: (named.get(row.id) ?? []).map(communityVersion)
98
+ }))
99
+ },
100
+
101
+ /** A gallery document as it is now, or one of its named versions, with where to download it. */
102
+ async download(documentId: string, versionId?: string): Promise<CommunityDownload> {
103
+ await find(documentId)
104
+ if (!versionId) return { document: await documents.downloadShared(documentId), version: null }
105
+ const named = await versions.downloadNamedShared(documentId, versionId)
106
+ return { document: named.document, version: communityVersion(named.version) }
107
+ },
108
+
109
+ /** Links for the images a gallery document's live room names. */
110
+ async imageLinks(documentId: string, checksums: string[]) {
111
+ await find(documentId)
112
+ return documents.imageLinksShared(documentId, checksums)
113
+ },
114
+
115
+ /**
116
+ * The thumbnail a gallery document's stored file carries, read from storage in ranges, for
117
+ * the revision it is now; null when that revision is not current any more or has none.
118
+ */
119
+ async thumbnail(documentId: string, revisionId: string): Promise<Uint8Array | null> {
120
+ const row = await find(documentId)
121
+ if (row.revisionId !== revisionId) return null
122
+ return extractFigThumbnailFromReader({
123
+ size: Number(row.byteSize),
124
+ read: async (start, endExclusive) => {
125
+ const bytes = await objects.readRange(row.objectKey, start, endExclusive)
126
+ if (!bytes) throw new DocumentNotFoundError()
127
+ return bytes
128
+ }
129
+ })
130
+ }
131
+ }
132
+ }
133
+
134
+ export type CommunityService = ReturnType<typeof createCommunityService>
@@ -2,13 +2,12 @@ import { staticEntitlementsFromTOML } from '#cloud/server/policy/static'
2
2
  import { parse as parseTOML } from 'smol-toml'
3
3
  import * as v from 'valibot'
4
4
 
5
+ import { parseCloudServerConfig, type CloudServerConfig } from './schema'
5
6
  import {
6
7
  cloudDeploymentConfigSchema,
7
- parseCloudServerConfig,
8
8
  type CloudDeploymentConfig,
9
- type CloudSecretReference,
10
- type CloudServerConfig
11
- } from './schema'
9
+ type CloudSecretReference
10
+ } from './toml/schema'
12
11
 
13
12
  export type CloudEnvironment = Readonly<Record<string, string | undefined>>
14
13
 
@@ -41,6 +40,11 @@ function staticEntitlements(config: CloudDeploymentConfig) {
41
40
  return staticEntitlementsFromTOML(config.entitlements)
42
41
  }
43
42
 
43
+ function defaultEntitlements(config: CloudDeploymentConfig) {
44
+ if (config.entitlements?.source !== 'database') return undefined
45
+ return staticEntitlementsFromTOML(config.entitlements)
46
+ }
47
+
44
48
  function emailConfig(config: CloudDeploymentConfig, environment: CloudEnvironment) {
45
49
  if (config.email.transport === 'none') return { emailTransport: 'none' as const }
46
50
  if (config.email.transport === 'cloudflare') {
@@ -83,22 +87,40 @@ function workerConfig(config: CloudDeploymentConfig) {
83
87
  cleanupBatchSize: cleanup?.batch_size,
84
88
  cleanupIntervalMs: cleanup?.interval_ms,
85
89
  cleanupLeaseDurationMs: cleanup?.lease_ms,
86
- documentRetentionMs: config.documents.retention_days * 86_400_000
90
+ documentRetentionMs: config.documents.retention_days * 86_400_000,
91
+ documentPurgeGraceMs: config.documents.purge_grace_days * 86_400_000
87
92
  }
88
93
  }
89
94
 
90
95
  function serviceConfig(config: CloudDeploymentConfig, environment: CloudEnvironment) {
91
96
  return {
92
- aiEndpoint: config.ai?.endpoint,
93
- aiSigningKey: config.ai ? requiredSecret(environment, config.ai.signing_key) : undefined,
94
- aiTokenLifetimeSeconds: config.ai ? config.ai.token_lifetime_minutes * 60 : undefined,
95
- billingPortalURL: config.billing?.portal_url,
97
+ servicesEndpoint: config.services?.endpoint,
98
+ servicesSigningKey: config.services
99
+ ? requiredSecret(environment, config.services.signing_key)
100
+ : undefined,
101
+ servicesTokenLifetimeSeconds: config.services
102
+ ? config.services.token_lifetime_minutes * 60
103
+ : undefined,
104
+ billingEndpoint: config.billing?.endpoint,
96
105
  internalServiceToken: config.internal_api
97
106
  ? requiredSecret(environment, config.internal_api.service_token)
98
107
  : undefined
99
108
  }
100
109
  }
101
110
 
111
+ function legalConfig(config: CloudDeploymentConfig) {
112
+ const legal = config.legal
113
+ if (!legal) return undefined
114
+ return {
115
+ termsURL: legal.terms_url,
116
+ privacyURL: legal.privacy_url,
117
+ termsVersion: legal.terms_version,
118
+ requireAcceptance: legal.require_acceptance,
119
+ abuseEmail: legal.abuse_email,
120
+ minimumAge: legal.minimum_age
121
+ }
122
+ }
123
+
102
124
  function errorTrackingConfig(config: CloudDeploymentConfig, environment: CloudEnvironment) {
103
125
  const tracking = config.error_tracking
104
126
  if (!tracking) return undefined
@@ -130,6 +152,7 @@ export function parseCloudDeploymentConfig(
130
152
  trustedOrigins: config.deployment.trusted_origins,
131
153
  localEditor: config.deployment.local_editor,
132
154
  listingMinimumEditorVersion: config.deployment.listing?.minimum_editor_version,
155
+ minimumEditorVersion: config.deployment.minimum_editor_version,
133
156
  databaseURL: requiredSecret(environment, config.database.url),
134
157
  authSecret: requiredSecret(environment, config.authentication.secret),
135
158
  enrollmentMode: config.authentication.enrollment.mode,
@@ -171,11 +194,20 @@ export function parseCloudDeploymentConfig(
171
194
  s3ChecksumVerification: config.object_storage.checksum_verification,
172
195
  s3ServerSideEncryption: config.object_storage.server_side_encryption,
173
196
  s3KmsKeyId: config.object_storage.kms_key_id,
197
+ s3DeletedPrefix: config.object_storage.deleted_prefix,
174
198
  relayURL: config.collaboration.relay_url,
175
199
  staticEntitlements: staticEntitlements(config),
200
+ defaultEntitlements: defaultEntitlements(config),
176
201
  ...emailConfig(config, environment),
177
202
  ...workerConfig(config),
178
203
  ...serviceConfig(config, environment),
204
+ legal: legalConfig(config),
205
+ community: config.community ? { workspaceId: config.community.workspace } : undefined,
206
+ branding: config.deployment.branding && {
207
+ name: config.deployment.branding.name,
208
+ logoURL: config.deployment.branding.logo_url,
209
+ helpURL: config.deployment.branding.help_url
210
+ },
179
211
  errorTracking: errorTrackingConfig(config, environment),
180
212
  technicalLimits: technicalLimits(config)
181
213
  })
@@ -9,7 +9,7 @@ export {
9
9
  type CloudDeploymentConfig,
10
10
  type CloudDeploymentInput,
11
11
  type CloudSecretReference
12
- } from './schema'
12
+ } from './toml/schema'
13
13
  export { CLOUD_PROTOCOL_MAX_UPLOAD_BYTES } from '#cloud/contract'
14
14
  export {
15
15
  CLOUD_DEFAULT_MAX_COLLABORATION_MESSAGE_BYTES,
@@ -1,5 +1,6 @@
1
1
  import {
2
- CLOUD_AI_CONTRACT_VERSION,
2
+ CLOUD_BILLING_CONTRACT_VERSION,
3
+ CLOUD_SERVICES_CONTRACT_VERSION,
3
4
  CLOUD_PROTOCOL_VERSION,
4
5
  parseCloudDiscovery,
5
6
  type CloudDiscovery
@@ -58,9 +59,15 @@ export function cloudDiscoveryFromConfig(config: CloudServerConfig): CloudDiscov
58
59
  listing: config.listingMinimumEditorVersion
59
60
  ? { minimumEditorVersion: config.listingMinimumEditorVersion }
60
61
  : undefined,
61
- ai: config.aiEndpoint
62
- ? { endpoint: config.aiEndpoint, contractVersion: CLOUD_AI_CONTRACT_VERSION }
62
+ minimumEditorVersion: config.minimumEditorVersion,
63
+ services: config.servicesEndpoint
64
+ ? { endpoint: config.servicesEndpoint, contractVersion: CLOUD_SERVICES_CONTRACT_VERSION }
63
65
  : undefined,
64
- billing: config.billingPortalURL ? { portalURL: config.billingPortalURL } : undefined
66
+ billing: config.billingEndpoint
67
+ ? { endpoint: config.billingEndpoint, contractVersion: CLOUD_BILLING_CONTRACT_VERSION }
68
+ : undefined,
69
+ community: config.community,
70
+ branding: config.branding,
71
+ legal: config.legal
65
72
  })
66
73
  }