@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
@@ -1,11 +1,12 @@
1
- import { createAIRoutes, type AITokenService } from '#cloud/server/ai'
2
1
  import type { CloudAPIEnvironment } from '#cloud/server/api/types'
3
2
  import type { CloudSessionResolver } from '#cloud/server/auth'
3
+ import { createBillingRoutes, type BillingTokenService } from '#cloud/server/billing'
4
4
  import type { CollaborationTicketService } from '#cloud/server/collaboration'
5
5
  import {
6
6
  createCollaborationRoutes,
7
7
  createPublicCollaborationRoutes
8
8
  } from '#cloud/server/collaboration'
9
+ import { createCommunityRoutes, type CommunityService } from '#cloud/server/community'
9
10
  import type { CloudDatabase } from '#cloud/server/db'
10
11
  import type { DocumentService } from '#cloud/server/documents'
11
12
  import { createDocumentRoutes } from '#cloud/server/documents'
@@ -14,6 +15,8 @@ import {
14
15
  type DocumentVersionService
15
16
  } from '#cloud/server/documents/versions'
16
17
  import type { EntitlementService } from '#cloud/server/policy'
18
+ import { createPublicReportRoutes, type DocumentReportService } from '#cloud/server/reports'
19
+ import { createServicesRoutes, type ServicesTokenService } from '#cloud/server/services'
17
20
  import type { DocumentSharingService } from '#cloud/server/sharing'
18
21
  import {
19
22
  createDocumentSharingRoutes,
@@ -32,28 +35,43 @@ export type CloudAPIServices = {
32
35
  collaboration: CollaborationTicketService
33
36
  documents: DocumentService
34
37
  versions: DocumentVersionService
38
+ /** The community gallery, which anyone may read. */
39
+ community: CommunityService
35
40
  sharing: DocumentSharingService
41
+ /** Reports about documents shared by link. */
42
+ reports: DocumentReportService
36
43
  resolveSession?: CloudSessionResolver
37
44
  entitlements?: EntitlementService
38
- /** Signs AI service tokens; without it the deployment has no AI service. */
39
- aiTokens?: AITokenService
45
+ /** Signs service tokens; without it the deployment offers no services. */
46
+ servicesTokens?: ServicesTokenService
47
+ /** Signs billing tokens; without it the deployment sells nothing. */
48
+ billingTokens?: BillingTokenService
40
49
  workspaces: WorkspaceService
41
50
  workspaceMembers: WorkspaceMemberService
42
51
  }
43
52
 
44
53
  export function createPublicCloudAPIRouter(services: CloudAPIServices) {
45
54
  return new Hono<CloudAPIEnvironment>()
55
+ .route('/', createPublicReportRoutes(services.reports, services.resolveSession))
46
56
  .route('/', createPublicSharingRoutes(services.sharing, services.resolveSession))
47
57
  .route(
48
58
  '/',
49
59
  createPublicDocumentRoutes(services.sharing, services.documents, services.resolveSession)
50
60
  )
51
61
  .route('/', createPublicCollaborationRoutes(services.collaboration, services.resolveSession))
62
+ .route('/', createCommunityRoutes(services.community))
52
63
  }
53
64
 
54
65
  export function createCloudAPIRouter(services: CloudAPIServices) {
55
66
  return new Hono<CloudAPIEnvironment>()
56
67
  .route('/public', createPublicCloudAPIRouter(services))
68
+ .get('/account/entitlements', async (context) => {
69
+ if (!services.entitlements)
70
+ return context.json({ error: { code: 'not_found' as const } }, 404)
71
+ return context.json({
72
+ entitlements: await services.entitlements.account(context.get('actor').userId)
73
+ })
74
+ })
57
75
  .get('/workspaces/:workspaceId/entitlements', workspaceParams, async (context) => {
58
76
  if (!services.entitlements)
59
77
  return context.json({ error: { code: 'not_found' as const } }, 404)
@@ -67,8 +85,17 @@ export function createCloudAPIRouter(services: CloudAPIServices) {
67
85
  .get('/session', (context) => context.json({ user: context.get('actor') }))
68
86
  .route(
69
87
  '/',
70
- createAIRoutes(
71
- services.aiTokens,
88
+ createServicesRoutes(
89
+ services.servicesTokens,
90
+ services.database && services.rateLimitSecret
91
+ ? { database: services.database, secret: services.rateLimitSecret }
92
+ : undefined
93
+ )
94
+ )
95
+ .route(
96
+ '/',
97
+ createBillingRoutes(
98
+ services.billingTokens,
72
99
  services.database && services.rateLimitSecret
73
100
  ? { database: services.database, secret: services.rateLimitSecret }
74
101
  : undefined
@@ -6,6 +6,8 @@ export type RateLimitUse = { limit: number; remaining: number; resetTime?: Date
6
6
  export type CloudAPIEnvironment = {
7
7
  Variables: {
8
8
  actor: CloudActor
9
+ /** Set by `cloudRequestId`: what logs and error reports name the request by. */
10
+ requestId: string
9
11
  /** Set by `hono-rate-limiter` for the last budget it counted. */
10
12
  rateLimit?: RateLimitUse
11
13
  /** A resource budget's use, kept before the actor-wide budget records its own. */
@@ -0,0 +1,84 @@
1
+ import { createCloudIdentityResolver, createCloudSessionResolver } from '#cloud/server/auth'
2
+ import type { Context } from 'hono'
3
+
4
+ import type { CloudServices } from './services'
5
+
6
+ /**
7
+ * The routes a personal access token reaches: workspaces and their documents, uploads, versions,
8
+ * sharing, and Trash, and who it signs in as. Anything else, such as services tokens that spend
9
+ * credits or administration, takes a session, including routes added later.
10
+ */
11
+ const ACCESS_TOKEN_API_PATHS = [
12
+ '/api/session',
13
+ '/api/workspaces',
14
+ '/api/documents',
15
+ '/api/uploads',
16
+ '/api/shared-documents',
17
+ '/api/trash'
18
+ ]
19
+ const acceptsAccessToken = (path: string) =>
20
+ ACCESS_TOKEN_API_PATHS.some((prefix) => path === prefix || path.startsWith(`${prefix}/`))
21
+
22
+ /** Who a request comes from: anyone signed in, an account that may use the server, or may leave. */
23
+ export function createRequestResolvers(services: CloudServices) {
24
+ return {
25
+ resolveIdentity: services.resolveIdentity ?? createCloudIdentityResolver(services.auth),
26
+ resolveSession: services.resolveSession ?? createCloudSessionResolver(services.auth),
27
+ resolveAccountSession:
28
+ services.resolveAccountSession ??
29
+ (services.resolveSession
30
+ ? services.resolveSession
31
+ : (request: Request) => services.auth.resolveAccountSession(request.headers))
32
+ }
33
+ }
34
+
35
+ /** The checks routes put in front of themselves to name the request's actor. */
36
+ export function createRequestChecks(
37
+ services: CloudServices,
38
+ resolvers: ReturnType<typeof createRequestResolvers>
39
+ ) {
40
+ const { resolveSession, resolveAccountSession } = resolvers
41
+ return {
42
+ requireActiveSession: async (context: Context, next: () => Promise<void>) => {
43
+ // A route that lets an account leave before accepting the terms named it already.
44
+ if (context.get('actor')) return next()
45
+ const actor = await resolveSession(context.req.raw)
46
+ if (!actor) return context.json({ error: { code: 'unauthorized' as const } }, 401)
47
+ context.set('actor', actor)
48
+ return next()
49
+ },
50
+ /**
51
+ * The API's caller: a session, or else a personal access token on the routes that take one
52
+ * (`ACCESS_TOKEN_API_PATHS`); account routes never get here.
53
+ */
54
+ requireActiveActor: async (context: Context, next: () => Promise<void>) => {
55
+ if (context.get('actor')) return next()
56
+ const actor =
57
+ (await resolveSession(context.req.raw)) ??
58
+ (acceptsAccessToken(context.req.path)
59
+ ? await services.auth.resolveAccessToken(context.req.raw.headers)
60
+ : null)
61
+ if (!actor) return context.json({ error: { code: 'unauthorized' as const } }, 401)
62
+ context.set('actor', actor)
63
+ return next()
64
+ },
65
+ /**
66
+ * An account that may leave: one that has terms to accept can still download its documents
67
+ * and delete itself, which nothing else lets it do until it accepts.
68
+ */
69
+ requireAccountSession: async (context: Context, next: () => Promise<void>) => {
70
+ const actor = await resolveAccountSession(context.req.raw)
71
+ if (!actor) return context.json({ error: { code: 'unauthorized' as const } }, 401)
72
+ context.set('actor', actor)
73
+ return next()
74
+ },
75
+ /** Reading one document, which downloading everything before leaving needs, without terms. */
76
+ allowLeavingRead: async (context: Context, next: () => Promise<void>) => {
77
+ if (context.req.method === 'GET') {
78
+ const actor = await resolveAccountSession(context.req.raw)
79
+ if (actor) context.set('actor', actor)
80
+ }
81
+ return next()
82
+ }
83
+ }
84
+ }
@@ -0,0 +1,20 @@
1
+ import { CLOUD_EDITOR_VERSION_HEADER, isEditorVersionAtLeast } from '#cloud/contract'
2
+ import type { MiddlewareHandler } from 'hono'
3
+
4
+ /**
5
+ * Refuses requests from a desktop editor older than the server's minimum, which would otherwise
6
+ * keep writing with a model the server no longer accepts. Requests that name no version, from
7
+ * browser editors, the CLI or MCP, pass.
8
+ */
9
+ export function requireMinimumEditor(minimum: string | undefined): MiddlewareHandler {
10
+ return async (context, next) => {
11
+ const version = context.req.header(CLOUD_EDITOR_VERSION_HEADER)
12
+ if (minimum && version && !isEditorVersionAtLeast(version, minimum)) {
13
+ return context.json(
14
+ { error: { code: 'editor_outdated' as const }, minimumEditorVersion: minimum },
15
+ 426
16
+ )
17
+ }
18
+ return next()
19
+ }
20
+ }
@@ -0,0 +1,128 @@
1
+ import {
2
+ CLOUD_API_MAX_BODY_BYTES,
3
+ CLOUD_DISCOVERY_PATH,
4
+ CLOUD_PROTOCOL_VERSION,
5
+ CLOUD_SERVICES_JWKS_PATH
6
+ } from '#cloud/contract'
7
+ import type { CloudAPIEnvironment } from '#cloud/server/api'
8
+ import { AUTH_BASE_PATH } from '#cloud/server/auth'
9
+ import { createCommunityThumbnailRoutes } from '#cloud/server/community'
10
+ import { cloudDiscoveryFromConfig } from '#cloud/server/config'
11
+ import { cloudErrorHandler } from '#cloud/server/errors'
12
+ import { cloudRequestId } from '#cloud/server/logging'
13
+ import { createPictureRoutes } from '#cloud/server/pictures'
14
+ import { Hono } from 'hono'
15
+ import { bodyLimit } from 'hono/body-limit'
16
+ import { cors } from 'hono/cors'
17
+
18
+ import { createRequestChecks, createRequestResolvers } from './checks'
19
+ import { requireMinimumEditor } from './editors'
20
+ import { robotsText, shouldPreventIndexing } from './indexing'
21
+ import { createAppRateLimiters } from './limiters'
22
+ import { createAppRouters } from './routes'
23
+ import { createAppServices, type CloudServices } from './services'
24
+
25
+ export { shouldPreventIndexing, withIndexingPolicy } from './indexing'
26
+ export type { CloudServices } from './services'
27
+
28
+ /** Where administration is mounted. */
29
+ const ADMIN_API_PATH = '/api/admin'
30
+
31
+ /**
32
+ * The Cloud server over a runtime's services. The order the routes and checks are registered in
33
+ * is what guards them: rate limiters come before the routes they count, the public API before
34
+ * the checks that require an account, and administration before the general write limiter.
35
+ */
36
+ export function createCloudApp(services: CloudServices) {
37
+ const { config } = services
38
+ const discovery = cloudDiscoveryFromConfig(config)
39
+ const allowedOrigins = new Set(
40
+ [config.publicURL, ...config.trustedOrigins].map((origin) => new URL(origin).origin)
41
+ )
42
+ const cloudCORS = cors({
43
+ origin: (origin) => (allowedOrigins.has(origin) ? origin : null),
44
+ allowMethods: ['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS'],
45
+ allowHeaders: ['Content-Type', 'Authorization'],
46
+ credentials: true,
47
+ maxAge: 600
48
+ })
49
+ const app = createAppServices(services)
50
+ const resolvers = createRequestResolvers(services)
51
+ const checks = createRequestChecks(services, resolvers)
52
+ const limiters = createAppRateLimiters(services.database, config)
53
+ const routers = createAppRouters(services, app, resolvers, checks, limiters, allowedOrigins)
54
+
55
+ return new Hono<CloudAPIEnvironment>()
56
+ .onError(cloudErrorHandler(services.reportError))
57
+ .use('*', cloudRequestId(services.forwardedRequestId))
58
+ .use(CLOUD_DISCOVERY_PATH, cloudCORS)
59
+ .use('/api/*', cloudCORS)
60
+ .use('/api/*', requireMinimumEditor(config.minimumEditorVersion))
61
+ .use(
62
+ '/api/*',
63
+ bodyLimit({
64
+ maxSize: CLOUD_API_MAX_BODY_BYTES,
65
+ onError: (context) => context.json({ error: { code: 'invalid_request' as const } }, 413)
66
+ })
67
+ )
68
+ .use('*', async (context, next) => {
69
+ await next()
70
+ if (shouldPreventIndexing(context.req.path, config.indexingPolicy)) {
71
+ context.header('X-Robots-Tag', 'noindex, nofollow, noarchive')
72
+ }
73
+ })
74
+ .get('/robots.txt', (context) => {
75
+ context.header('Content-Type', 'text/plain; charset=utf-8')
76
+ return context.body(robotsText(config.indexingPolicy))
77
+ })
78
+ .get('/health', (context) =>
79
+ context.json({
80
+ status: 'ok' as const,
81
+ protocolVersion: CLOUD_PROTOCOL_VERSION
82
+ })
83
+ )
84
+ .get('/ready', async (context) => {
85
+ try {
86
+ await services.database.selectFrom('workspace').select('id').limit(1).execute()
87
+ const objects = await services.objects.checkReadiness()
88
+ if (!objects.ok) {
89
+ return context.json(
90
+ { status: 'unavailable' as const, dependency: 'object_storage' as const },
91
+ 503
92
+ )
93
+ }
94
+ return context.json({
95
+ status: 'ready' as const,
96
+ objectStorage: {
97
+ checksumVerification: objects.checksumVerification,
98
+ multipartUpload: services.objects.capabilities.multipartUpload
99
+ }
100
+ })
101
+ } catch {
102
+ return context.json({ status: 'unavailable' as const }, 503)
103
+ }
104
+ })
105
+ .get(CLOUD_DISCOVERY_PATH, (context) => context.json(discovery))
106
+ .get(CLOUD_SERVICES_JWKS_PATH, async (context) =>
107
+ app.servicesTokens ? context.json(app.servicesTokens.jwks()) : context.notFound()
108
+ )
109
+ .on(['GET', 'POST'], `${AUTH_BASE_PATH}/*`, (context) => services.auth.handler(context.req.raw))
110
+ .route('/', routers.account)
111
+ .route('/', routers.accessTokens)
112
+ .route('/', createPictureRoutes(app.pictures))
113
+ .use('/api/shares/:shareId/collaboration-ticket', limiters.publicCollaborationLimiter)
114
+ .use('/api/public/*', limiters.publicRateLimiter)
115
+ .use('/api/shares/*', limiters.publicRateLimiter)
116
+ .use('/api/invitations/*', limiters.publicRateLimiter)
117
+ .use('/api/community/*', limiters.communityLimiter, limiters.publicRateLimiter)
118
+ .route('/', createCommunityThumbnailRoutes(app.community))
119
+ .route('/api', routers.publicCloudAPI)
120
+ .route('/api/internal', routers.internalAPI)
121
+ .use('/api/documents/:documentId', checks.allowLeavingRead)
122
+ .use('/api/*', checks.requireActiveActor)
123
+ .route(ADMIN_API_PATH, routers.admin)
124
+ .use('/api/*', limiters.authenticatedMutationLimiter)
125
+ .route('/api', routers.cloudAPI)
126
+ }
127
+
128
+ export type CloudApp = ReturnType<typeof createCloudApp>
@@ -0,0 +1,40 @@
1
+ import { CLOUD_DISCOVERY_PATH } from '#cloud/contract'
2
+
3
+ export function shouldPreventIndexing(path: string, policy: 'allow' | 'deny'): boolean {
4
+ return (
5
+ policy === 'deny' ||
6
+ path.startsWith('/api/') ||
7
+ path.startsWith('/admin') ||
8
+ path.startsWith('/auth') ||
9
+ path.startsWith('/account') ||
10
+ path === '/app' ||
11
+ path === '/sign-in' ||
12
+ path === '/sign-up' ||
13
+ path === '/join' ||
14
+ path === CLOUD_DISCOVERY_PATH ||
15
+ // A community document in the editor; its page at `/community/:id` is the one to index.
16
+ /^\/community\/[^/]+\/open\/?$/.test(path)
17
+ )
18
+ }
19
+
20
+ export function withIndexingPolicy(
21
+ response: Response,
22
+ path: string,
23
+ policy: 'allow' | 'deny'
24
+ ): Response {
25
+ if (!shouldPreventIndexing(path, policy)) return response
26
+ const headers = new Headers(response.headers)
27
+ headers.set('X-Robots-Tag', 'noindex, nofollow, noarchive')
28
+ return new Response(response.body, {
29
+ status: response.status,
30
+ statusText: response.statusText,
31
+ headers
32
+ })
33
+ }
34
+
35
+ /** What `/robots.txt` answers: everything closed, or only the server's own pages and API. */
36
+ export function robotsText(policy: 'allow' | 'deny'): string {
37
+ return policy === 'deny'
38
+ ? 'User-agent: *\nDisallow: /\n'
39
+ : 'User-agent: *\nDisallow: /admin\nDisallow: /account\nDisallow: /app\nDisallow: /api\nDisallow: /auth\nDisallow: /sign-in\nDisallow: /sign-up\nDisallow: /join\nDisallow: /.well-known\n'
40
+ }
@@ -0,0 +1,53 @@
1
+ import type { CloudServerConfig } from '#cloud/server/config'
2
+ import type { CloudDatabase } from '#cloud/server/db'
3
+ import {
4
+ CLOUD_RATE_LIMITS,
5
+ createActorRateLimiter,
6
+ createTrustedIPRateLimiter,
7
+ routeHasOwnBudget,
8
+ type RateLimitPolicy
9
+ } from '#cloud/server/rate-limit'
10
+ import type { Kysely } from 'kysely'
11
+
12
+ /**
13
+ * The app's rate limiters. The public ones count by trusted client IP and answer an exhausted
14
+ * budget as not found, so a capability's existence never leaks; the authenticated one counts by
15
+ * actor and leaves reads and routes with a budget of their own alone.
16
+ */
17
+ export function createAppRateLimiters(database: Kysely<CloudDatabase>, config: CloudServerConfig) {
18
+ /** A limiter for requests without an account, by trusted client IP. */
19
+ const publicLimiter = (
20
+ policy: RateLimitPolicy,
21
+ options: Parameters<typeof createTrustedIPRateLimiter>[5]
22
+ ) =>
23
+ createTrustedIPRateLimiter(
24
+ database,
25
+ config.authSecret,
26
+ policy,
27
+ { trustedHeaders: config.authTrustedIPHeaders },
28
+ (context) => context.json({ error: { code: 'not_found' as const } }, 404),
29
+ options
30
+ )
31
+
32
+ return {
33
+ publicRateLimiter: publicLimiter(CLOUD_RATE_LIMITS.publicCapability, {
34
+ resource: (context) => context.req.path,
35
+ // Guests refresh collaboration tickets on their own budget, `publicCollaborationLimiter`.
36
+ skip: routeHasOwnBudget
37
+ }),
38
+ publicCollaborationLimiter: publicLimiter(CLOUD_RATE_LIMITS.collaborationTicket, {
39
+ resource: (context) => context.req.path,
40
+ route: true
41
+ }),
42
+ // The gallery's own budget, across its paths, in place of the per-path public one.
43
+ communityLimiter: publicLimiter(CLOUD_RATE_LIMITS.communityRead, { route: true }),
44
+ authenticatedMutationLimiter: createActorRateLimiter(
45
+ database,
46
+ config.authSecret,
47
+ CLOUD_RATE_LIMITS.authenticatedMutation,
48
+ // Reads are free, and a route with a budget of its own, such as creating documents, counts
49
+ // against that instead.
50
+ (context) => context.req.method === 'GET' || routeHasOwnBudget(context)
51
+ )
52
+ }
53
+ }
@@ -0,0 +1,114 @@
1
+ import {
2
+ createAdminAuditService,
3
+ createAdminDocumentService,
4
+ createAdminEmailService,
5
+ createAdminOperationsService,
6
+ createAdminReportService,
7
+ createAdminUserService,
8
+ createCloudAdminRoutes
9
+ } from '#cloud/admin'
10
+ import { createAccountDeletionService } from '#cloud/server/account/deletion'
11
+ import { createAccountRoutes } from '#cloud/server/account/routes'
12
+ import { createTermsService } from '#cloud/server/account/terms'
13
+ import { createAccessTokenRoutes } from '#cloud/server/account/tokens'
14
+ import { createCloudAPIRouter, createPublicCloudAPIRouter } from '#cloud/server/api'
15
+ import { createAuthenticationEmailService } from '#cloud/server/auth'
16
+ import { createInternalRoutes, createInternalService } from '#cloud/server/internal'
17
+ import { Hono } from 'hono'
18
+
19
+ import type { createRequestChecks, createRequestResolvers } from './checks'
20
+ import type { createAppRateLimiters } from './limiters'
21
+ import type { CloudAppServices, CloudServices } from './services'
22
+
23
+ /** The routers the app mounts, each over the services, checks, and limiters it needs. */
24
+ export function createAppRouters(
25
+ services: CloudServices,
26
+ app: CloudAppServices,
27
+ resolvers: ReturnType<typeof createRequestResolvers>,
28
+ checks: ReturnType<typeof createRequestChecks>,
29
+ limiters: ReturnType<typeof createAppRateLimiters>,
30
+ allowedOrigins: ReadonlySet<string>
31
+ ) {
32
+ const { config, database } = services
33
+ const { resolveIdentity, resolveSession } = resolvers
34
+ const admin = createCloudAdminRoutes(
35
+ {
36
+ email: createAdminEmailService(database, services.transactionalEmail, {
37
+ publicURL: config.publicURL
38
+ }),
39
+ enrollment: app.enrollment,
40
+ users: createAdminUserService(database, services.auth, {
41
+ requireMFA: config.deploymentAdminMFARequired,
42
+ pictures: app.pictures,
43
+ notify: services.transactionalEmail
44
+ ? createAuthenticationEmailService(services.transactionalEmail, config.publicURL)
45
+ : undefined
46
+ }),
47
+ audit: createAdminAuditService(database),
48
+ operations: createAdminOperationsService(database, config),
49
+ documents: createAdminDocumentService(database, {
50
+ closeRooms: services.onDocumentTakenDown,
51
+ purgeGraceMs: config.documentPurgeGraceMs,
52
+ email: services.transactionalEmail,
53
+ publicURL: config.publicURL,
54
+ contactEmail: config.legal?.abuseEmail
55
+ }),
56
+ reports: createAdminReportService(database, {
57
+ email: services.transactionalEmail,
58
+ contactEmail: config.legal?.abuseEmail
59
+ })
60
+ },
61
+ allowedOrigins,
62
+ {
63
+ database,
64
+ secret: config.authSecret,
65
+ auth: services.auth,
66
+ requireMFA: config.deploymentAdminMFARequired
67
+ }
68
+ )
69
+ const account = createAccountRoutes({
70
+ auth: services.auth,
71
+ terms: createTermsService(database, config),
72
+ pictures: app.pictures,
73
+ config,
74
+ enrollment: app.enrollment,
75
+ workspaces: app.workspaces,
76
+ deletion: createAccountDeletionService(database),
77
+ resolveIdentity,
78
+ resolveSession,
79
+ requireActiveSession: checks.requireActiveSession,
80
+ requireAccountSession: checks.requireAccountSession,
81
+ authenticatedMutationLimiter: limiters.authenticatedMutationLimiter
82
+ })
83
+ const accessTokens = createAccessTokenRoutes({
84
+ auth: services.auth,
85
+ resolveSession,
86
+ requireActiveSession: checks.requireActiveSession,
87
+ authenticatedMutationLimiter: limiters.authenticatedMutationLimiter
88
+ })
89
+ const shared = {
90
+ collaboration: app.collaboration,
91
+ documents: app.documents,
92
+ versions: app.versions,
93
+ community: app.community,
94
+ entitlements: app.entitlements,
95
+ sharing: app.sharing,
96
+ reports: app.reports,
97
+ workspaces: app.workspaces,
98
+ workspaceMembers: app.workspaceMembers,
99
+ resolveSession
100
+ }
101
+ const cloudAPI = createCloudAPIRouter({
102
+ ...shared,
103
+ database,
104
+ rateLimitSecret: config.authSecret,
105
+ servicesTokens: app.servicesTokens,
106
+ billingTokens: app.billingTokens
107
+ })
108
+ const publicCloudAPI = createPublicCloudAPIRouter(shared)
109
+ // Services such as billing authenticate with their own token, not a session.
110
+ const internalAPI = config.internalServiceToken
111
+ ? createInternalRoutes(createInternalService(database), config.internalServiceToken)
112
+ : new Hono()
113
+ return { admin, account, accessTokens, cloudAPI, publicCloudAPI, internalAPI }
114
+ }