@open-pencil/cloud 0.17.0-beta.1 → 0.17.0-beta.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (235) hide show
  1. package/README.md +1 -1
  2. package/dist/bin/{ai-relay.mjs → services.mjs} +8 -8
  3. package/dist/bin/services.mjs.map +1 -0
  4. package/dist/client.d.ts +236 -46
  5. package/dist/client.d.ts.map +1 -1
  6. package/dist/client.js +649 -400
  7. package/dist/client.js.map +1 -1
  8. package/dist/contract.d.ts +2 -2
  9. package/dist/contract.js +2 -2
  10. package/dist/contract2.js +680 -443
  11. package/dist/contract2.js.map +1 -1
  12. package/dist/email.d.ts +9 -1
  13. package/dist/email.d.ts.map +1 -1
  14. package/dist/email.js +99 -58
  15. package/dist/email.js.map +1 -1
  16. package/dist/index.d.ts +468 -64
  17. package/dist/index.d.ts.map +1 -1
  18. package/dist/listen.mjs +575 -738
  19. package/dist/listen.mjs.map +1 -1
  20. package/dist/runtime-node.d.mts +6564 -2934
  21. package/dist/runtime-node.d.mts.map +1 -1
  22. package/dist/runtime-node.mjs +6 -5
  23. package/dist/runtime-node.mjs.map +1 -1
  24. package/dist/server.d.ts +8931 -4198
  25. package/dist/server.d.ts.map +1 -1
  26. package/dist/server.js +5260 -3859
  27. package/dist/server.js.map +1 -1
  28. package/dist/server.mjs +5686 -3736
  29. package/dist/server.mjs.map +1 -1
  30. package/dist/server2.mjs +101 -79
  31. package/dist/server2.mjs.map +1 -1
  32. package/package.json +9 -6
  33. package/src/admin/api/routes.ts +103 -33
  34. package/src/admin/audit/service.ts +25 -6
  35. package/src/admin/documents/service.ts +361 -0
  36. package/src/admin/errors.ts +9 -1
  37. package/src/admin/index.ts +6 -0
  38. package/src/admin/operations/service.ts +7 -0
  39. package/src/admin/reports/service.ts +147 -0
  40. package/src/admin/schema.ts +6 -0
  41. package/src/client/api.ts +36 -21
  42. package/src/client/auth/navigation.ts +6 -5
  43. package/src/client/index.ts +7 -7
  44. package/src/client/portal/account.ts +25 -0
  45. package/src/client/portal/administration.ts +56 -0
  46. package/src/client/{ai.ts → services.ts} +44 -27
  47. package/src/contract/account.ts +58 -2
  48. package/src/contract/admin/index.ts +67 -3
  49. package/src/contract/collaboration.ts +6 -1
  50. package/src/contract/discovery.ts +22 -4
  51. package/src/contract/documents.ts +27 -0
  52. package/src/contract/entitlements.ts +2 -2
  53. package/src/contract/index.ts +63 -37
  54. package/src/contract/relay.ts +6 -0
  55. package/src/contract/reports.ts +42 -0
  56. package/src/contract/services.ts +233 -0
  57. package/src/contract/sharing.ts +3 -9
  58. package/src/email/render.ts +26 -0
  59. package/src/email/schema.ts +11 -1
  60. package/src/email/templates/brand.ts +1 -1
  61. package/src/runtime/cloudflare/environment.ts +31 -6
  62. package/src/runtime/cloudflare/index.ts +1 -1
  63. package/src/runtime/cloudflare/logging.ts +15 -0
  64. package/src/runtime/cloudflare/maintenance.ts +31 -0
  65. package/src/runtime/cloudflare/relay/index.ts +176 -0
  66. package/src/runtime/cloudflare/relay/sockets.ts +112 -0
  67. package/src/runtime/cloudflare/worker.ts +89 -26
  68. package/src/runtime/node/application.ts +5 -3
  69. package/src/runtime/node/bootstrap.ts +20 -4
  70. package/src/runtime/node/cleanup.ts +16 -3
  71. package/src/runtime/node/entitlements/main.ts +14 -11
  72. package/src/runtime/node/index.ts +1 -1
  73. package/src/runtime/node/migrate.ts +5 -1
  74. package/src/runtime/node/relay.ts +8 -2
  75. package/src/runtime/node/request-id.ts +13 -0
  76. package/src/runtime/node/server.ts +71 -15
  77. package/src/runtime/node/{ai-relay → services}/main.ts +6 -6
  78. package/src/runtime/node/{ai-relay → services}/server.ts +18 -18
  79. package/src/runtime/postgres/database.ts +20 -1
  80. package/src/runtime/posthog/errors.ts +32 -0
  81. package/src/runtime/s3/objects.ts +50 -1
  82. package/src/runtime/site/server.ts +33 -4
  83. package/src/server/account/actions.ts +5 -0
  84. package/src/server/account/deletion.ts +302 -0
  85. package/src/server/account/routes.ts +47 -3
  86. package/src/server/account/terms.ts +42 -0
  87. package/src/server/api/router.ts +12 -7
  88. package/src/server/api/types.ts +9 -0
  89. package/src/server/app.ts +93 -15
  90. package/src/server/auth/access-control.ts +63 -0
  91. package/src/server/auth/adapter.ts +11 -0
  92. package/src/server/auth/endpoints.ts +5 -1
  93. package/src/server/auth/factory.ts +30 -3
  94. package/src/server/auth/index.ts +10 -1
  95. package/src/server/cleanup/configured.ts +12 -5
  96. package/src/server/cleanup/documents.ts +165 -71
  97. package/src/server/cleanup/objects.ts +10 -2
  98. package/src/server/cleanup/revisions.ts +24 -7
  99. package/src/server/cleanup/uploads.ts +8 -2
  100. package/src/server/cleanup/worker.ts +5 -2
  101. package/src/server/collaboration/index.ts +3 -0
  102. package/src/server/collaboration/relay/connection.ts +196 -0
  103. package/src/server/collaboration/relay/documents.ts +13 -10
  104. package/src/server/collaboration/relay/hub.ts +279 -195
  105. package/src/server/collaboration/relay/index.ts +3 -1
  106. package/src/server/collaboration/relay/log.ts +79 -0
  107. package/src/server/collaboration/relay/persistence.ts +147 -22
  108. package/src/server/collaboration/relay/resume.ts +28 -0
  109. package/src/server/collaboration/routes.ts +27 -16
  110. package/src/server/collaboration/service.ts +27 -31
  111. package/src/server/config/deployment.ts +35 -4
  112. package/src/server/config/public.ts +5 -4
  113. package/src/server/config/schema.ts +104 -16
  114. package/src/server/db/expressions.ts +15 -1
  115. package/src/server/db/migrate.ts +34 -114
  116. package/src/server/db/migrations/001_accounts.ts +79 -0
  117. package/src/server/db/migrations/002_workspaces.ts +48 -0
  118. package/src/server/db/migrations/003_storage.ts +44 -0
  119. package/src/server/db/migrations/004_documents.ts +193 -0
  120. package/src/server/db/migrations/005_sharing.ts +95 -0
  121. package/src/server/db/migrations/006_operations.ts +110 -0
  122. package/src/server/db/migrations/007_trash.ts +33 -0
  123. package/src/server/db/migrations/008_terms.ts +18 -0
  124. package/src/server/db/migrations/schema.ts +71 -0
  125. package/src/server/db/tables.ts +70 -7
  126. package/src/server/documents/access.ts +66 -55
  127. package/src/server/documents/errors.ts +7 -0
  128. package/src/server/documents/images.ts +2 -1
  129. package/src/server/documents/limits.ts +9 -9
  130. package/src/server/documents/purge.ts +75 -0
  131. package/src/server/documents/repository.ts +2 -0
  132. package/src/server/documents/routes.ts +132 -80
  133. package/src/server/documents/service.ts +18 -4
  134. package/src/server/documents/summary.ts +1 -0
  135. package/src/server/documents/trash.ts +203 -0
  136. package/src/server/documents/versions/checkpoint.ts +2 -1
  137. package/src/server/documents/versions/history.ts +11 -7
  138. package/src/server/documents/versions/routes.ts +36 -25
  139. package/src/server/documents/versions/service.ts +22 -4
  140. package/src/server/errors/index.ts +99 -0
  141. package/src/server/errors/posthog.ts +80 -0
  142. package/src/server/index.ts +56 -16
  143. package/src/server/internal/index.ts +3 -3
  144. package/src/server/internal/routes.ts +7 -15
  145. package/src/server/internal/schema.ts +1 -1
  146. package/src/server/internal/service.ts +17 -23
  147. package/src/server/invitations/budget.ts +66 -0
  148. package/src/server/invitations/index.ts +1 -0
  149. package/src/server/logging.ts +76 -0
  150. package/src/server/objects/types.ts +12 -0
  151. package/src/server/pictures/routes.ts +4 -2
  152. package/src/server/pictures/service.ts +2 -1
  153. package/src/server/policy/database.ts +39 -25
  154. package/src/server/policy/index.ts +2 -1
  155. package/src/server/policy/keys.ts +5 -2
  156. package/src/server/policy/policy.ts +1 -0
  157. package/src/server/policy/schema.ts +2 -2
  158. package/src/server/policy/service.ts +12 -9
  159. package/src/server/policy/static.ts +5 -5
  160. package/src/server/policy/workspace.ts +41 -0
  161. package/src/server/quota/reconcile.ts +2 -0
  162. package/src/server/quota/storage.ts +69 -31
  163. package/src/server/rate-limit/cleanup.ts +17 -5
  164. package/src/server/rate-limit/index.ts +4 -1
  165. package/src/server/rate-limit/middleware.ts +100 -12
  166. package/src/server/reports/index.ts +8 -0
  167. package/src/server/reports/routes.ts +37 -0
  168. package/src/server/reports/service.ts +123 -0
  169. package/src/server/services/errors.ts +7 -0
  170. package/src/server/services/index.ts +8 -0
  171. package/src/server/{ai → services}/keys.ts +11 -11
  172. package/src/server/services/routes.ts +47 -0
  173. package/src/server/{ai/service.ts → services/tokens.ts} +23 -20
  174. package/src/server/sharing/capabilities/service.ts +68 -22
  175. package/src/server/sharing/document-routes.ts +30 -22
  176. package/src/server/sharing/grants/service.ts +11 -18
  177. package/src/server/sharing/http.ts +4 -0
  178. package/src/server/sharing/invitations/service.ts +21 -11
  179. package/src/server/sharing/policy.ts +9 -14
  180. package/src/server/sharing/routes.ts +108 -85
  181. package/src/server/sharing/service.ts +1 -17
  182. package/src/server/validation.ts +59 -2
  183. package/src/server/workspaces/index.ts +1 -0
  184. package/src/server/workspaces/members.ts +89 -38
  185. package/src/server/workspaces/repository.ts +2 -1
  186. package/src/server/workspaces/routes.ts +67 -45
  187. package/src/{ai-relay → services}/app.ts +48 -44
  188. package/src/{ai-relay → services}/config.ts +25 -19
  189. package/src/services/db/index.ts +10 -0
  190. package/src/services/db/migrate.ts +37 -0
  191. package/src/{ai-relay/db/migrations/001_usage.ts → services/db/migrations/001_baseline.ts} +18 -7
  192. package/src/services/db/schema.ts +22 -0
  193. package/src/services/index.ts +18 -0
  194. package/src/{ai-relay → services}/metering.ts +2 -2
  195. package/src/{ai-relay → services}/usage.ts +43 -19
  196. package/dist/bin/ai-relay.mjs.map +0 -1
  197. package/src/ai-relay/db/index.ts +0 -10
  198. package/src/ai-relay/db/migrate.ts +0 -32
  199. package/src/ai-relay/db/schema.ts +0 -20
  200. package/src/ai-relay/index.ts +0 -18
  201. package/src/contract/ai.ts +0 -150
  202. package/src/runtime/cloudflare/relay.ts +0 -136
  203. package/src/server/ai/errors.ts +0 -7
  204. package/src/server/ai/index.ts +0 -4
  205. package/src/server/ai/routes.ts +0 -43
  206. package/src/server/auth/workspace-access.ts +0 -23
  207. package/src/server/db/migrations/001_foundation.ts +0 -164
  208. package/src/server/db/migrations/002_upload_cleanup_claims.ts +0 -34
  209. package/src/server/db/migrations/003_document_cleanup_claims.ts +0 -23
  210. package/src/server/db/migrations/004_document_sharing.ts +0 -82
  211. package/src/server/db/migrations/005_document_collaboration_epoch.ts +0 -13
  212. package/src/server/db/migrations/006_invitation_continuation.ts +0 -27
  213. package/src/server/db/migrations/007_collaboration_state.ts +0 -25
  214. package/src/server/db/migrations/008_storage_reservations.ts +0 -37
  215. package/src/server/db/migrations/009_workspace_entitlements.ts +0 -22
  216. package/src/server/db/migrations/010_upload_finalization.ts +0 -22
  217. package/src/server/db/migrations/011_upload_finalization_lease.ts +0 -12
  218. package/src/server/db/migrations/012_transactional_email.ts +0 -48
  219. package/src/server/db/migrations/013_admin_enrollment.ts +0 -54
  220. package/src/server/db/migrations/014_enrollment_email_kinds.ts +0 -30
  221. package/src/server/db/migrations/015_cloud_rate_limit.ts +0 -22
  222. package/src/server/db/migrations/016_auth_schema.ts +0 -16
  223. package/src/server/db/migrations/017_authentication_email_kinds.ts +0 -32
  224. package/src/server/db/migrations/018_authentication_mfa.ts +0 -78
  225. package/src/server/db/migrations/019_better_auth_account_issuer.ts +0 -42
  226. package/src/server/db/migrations/020_workspace_invitations.ts +0 -57
  227. package/src/server/db/migrations/021_document_versions.ts +0 -66
  228. package/src/server/db/migrations/022_entitlement_external_version.ts +0 -17
  229. package/src/server/db/migrations/023_document_images.ts +0 -61
  230. package/src/server/db/migrations/024_account_activity.ts +0 -66
  231. package/src/server/db/migrations/025_table_names.ts +0 -58
  232. package/src/server/db/migrations/026_user_picture.ts +0 -30
  233. package/src/server/db/migrations/027_document_kind.ts +0 -19
  234. package/src/server/db/migrations/helpers.ts +0 -78
  235. /package/dist/bin/{ai-relay.d.mts → services.d.mts} +0 -0
@@ -0,0 +1,80 @@
1
+ import { PostHog, type PostHogOptions } from 'posthog-node'
2
+
3
+ /** Where a server caught an error, and for a request, its method, matched route, and ID. */
4
+ export type ErrorReportContext<Source extends string = string> = {
5
+ source: Source
6
+ method?: string
7
+ route?: string
8
+ /** The request's ID, as `cloudRequestId` named it; logs carry it too. */
9
+ requestId?: string
10
+ /** What failed, as the server's log says it; not sent to PostHog, whose report has the error. */
11
+ message?: string
12
+ }
13
+
14
+ /** Sends a caught error where it is seen; it never rejects. */
15
+ export type ErrorReporter<Source extends string = string> = (
16
+ error: unknown,
17
+ context: ErrorReportContext<Source>
18
+ ) => Promise<void>
19
+
20
+ export type PostHogErrorReporterOptions = {
21
+ /** The project API key, or how to read it; a key that cannot be read yet is read again later. */
22
+ key: string | (() => Promise<string>)
23
+ host: string
24
+ /** Sent with every report: which service and deployment report, never who made the request. */
25
+ properties: Record<string, string>
26
+ /** The property that names the context's `source`, such as `cloud_source`. */
27
+ sourceProperty: string
28
+ /** Names the service in its own log, such as `Cloud`. */
29
+ logName: string
30
+ fetch?: PostHogOptions['fetch']
31
+ }
32
+
33
+ /**
34
+ * Reports errors to PostHog error tracking, each as it is caught, as a `$exception` with no person
35
+ * profile and no GeoIP. A report carries `properties`, the source, and a request's method and
36
+ * matched route and ID; never who made the request or what it carried.
37
+ */
38
+ export function createPostHogErrorReporter<Source extends string>(
39
+ options: PostHogErrorReporterOptions
40
+ ): ErrorReporter<Source> {
41
+ const { key, logName } = options
42
+ const connect = async () => {
43
+ const client = new PostHog(typeof key === 'string' ? key : await key(), {
44
+ host: options.host,
45
+ disableGeoip: true,
46
+ // The SDK's own fetch unless a caller passes one.
47
+ ...(options.fetch && { fetch: options.fetch })
48
+ })
49
+ // The SDK resolves a capture that PostHog refused and emits the refusal instead.
50
+ client.on('error', (failure: unknown) => {
51
+ console.error(`[${logName}] PostHog refused an error report:`, failure)
52
+ })
53
+ return client
54
+ }
55
+ let connecting: Promise<PostHog> | undefined
56
+ const posthog = async () => {
57
+ connecting ??= connect()
58
+ try {
59
+ return await connecting
60
+ } catch (failure) {
61
+ connecting = undefined
62
+ throw failure
63
+ }
64
+ }
65
+ return async (error, context) => {
66
+ try {
67
+ const client = await posthog()
68
+ // Undefined request fields are left out of the event's JSON.
69
+ await client.captureExceptionImmediate(error, undefined, {
70
+ ...options.properties,
71
+ [options.sourceProperty]: context.source,
72
+ http_method: context.method,
73
+ http_route: context.route,
74
+ request_id: context.requestId
75
+ })
76
+ } catch (failure) {
77
+ console.error(`[${logName}] Reporting an error failed:`, failure)
78
+ }
79
+ }
80
+ }
@@ -20,16 +20,16 @@ export {
20
20
  type EnrollmentStatus
21
21
  } from '#cloud/admin'
22
22
  export {
23
- AINotEntitledError,
24
- createAIRoutes,
25
- createAITokenService,
26
- importAISigningKey,
27
- loadAISigningKey,
28
- type AIRouteEnvironment,
29
- type AISigningKey,
30
- type AITokenService,
31
- type AITokenServiceOptions
32
- } from './ai'
23
+ ServicesNotEntitledError,
24
+ createServicesRoutes,
25
+ createServicesTokenService,
26
+ importServicesSigningKey,
27
+ loadServicesSigningKey,
28
+ type ServicesRouteEnvironment,
29
+ type ServicesSigningKey,
30
+ type ServicesTokenService,
31
+ type ServicesTokenServiceOptions
32
+ } from './services'
33
33
  export {
34
34
  createAuthenticationEmailService,
35
35
  createAccountAuthenticationService,
@@ -45,9 +45,14 @@ export {
45
45
  type CloudSessionResolver,
46
46
  type AccountAuthenticationService,
47
47
  type AuthenticationEmailService,
48
- workspaceAccessControl,
48
+ accessControl,
49
+ accessStatements,
50
+ documentRoleCan,
51
+ documentRoles,
52
+ workspaceRoleCan,
49
53
  workspaceRoles,
50
- workspaceStatements
54
+ type AccessRequest,
55
+ type DocumentRole
51
56
  } from './auth'
52
57
  export {
53
58
  createCloudAPIRouter,
@@ -95,6 +100,9 @@ export {
95
100
  type CollaborationRelayOptions,
96
101
  type CollaborationRoomIdentity,
97
102
  type CollaborationStateStore,
103
+ type SavedRoom,
104
+ readRelayPeerState,
105
+ type RelayPeerState,
98
106
  type RelayAuthorization,
99
107
  type RelayConnection,
100
108
  type RelaySocket,
@@ -182,15 +190,39 @@ export {
182
190
  type TransactionalEmailWorker,
183
191
  type TransactionalEmailWorkerOptions
184
192
  } from './email'
193
+ export {
194
+ CLOUD_ERROR_SOURCES,
195
+ cloudErrorHandler,
196
+ createLoggingErrorReporter,
197
+ reportCloudError,
198
+ type CloudErrorContext,
199
+ type CloudErrorReporter,
200
+ type CloudErrorSource,
201
+ createPostHogErrorReporter,
202
+ type ErrorReportContext,
203
+ type ErrorReporter,
204
+ type PostHogErrorReporterOptions
205
+ } from './errors'
206
+ export {
207
+ cloudRequestId,
208
+ logCloud,
209
+ loggedError,
210
+ writeJSONLine,
211
+ type CloudLogLine,
212
+ type CloudLogWriter,
213
+ type ForwardedRequestId
214
+ } from './logging'
185
215
  export {
186
216
  createInternalRoutes,
187
217
  createInternalService,
188
- parseSetWorkspaceEntitlements,
189
- setWorkspaceEntitlementsSchema,
218
+ parseSetAccountEntitlements,
219
+ setAccountEntitlementsSchema,
190
220
  type InternalService,
191
- type SetWorkspaceEntitlementsInput
221
+ type SetAccountEntitlementsInput
192
222
  } from './internal'
193
223
  export {
224
+ INVITATION_BUDGET,
225
+ InvitationLimitError,
194
226
  noOpInvitationDelivery,
195
227
  type DocumentInvitationMessage,
196
228
  type InvitationDelivery,
@@ -233,7 +265,7 @@ export {
233
265
  CLOUD_FEATURE_KEYS,
234
266
  CloudPolicy,
235
267
  createConfiguredCloudPolicy,
236
- createWorkspaceEntitlementRepository,
268
+ createAccountEntitlementRepository,
237
269
  DatabaseEntitlementSource,
238
270
  EntitlementOpenFeatureProvider,
239
271
  createDefaultCloudPolicy,
@@ -277,3 +309,11 @@ export {
277
309
  type WorkspaceRouteEnvironment,
278
310
  type WorkspaceService
279
311
  } from './workspaces'
312
+ export {
313
+ createDocumentReportService,
314
+ createPublicReportRoutes,
315
+ DOCUMENT_REPORT_BUDGET,
316
+ DocumentReportLimitError,
317
+ type DocumentReportService,
318
+ type DocumentReportServiceOptions
319
+ } from './reports'
@@ -1,8 +1,8 @@
1
1
  export { createInternalRoutes } from './routes'
2
2
  export {
3
3
  createInternalService,
4
- parseSetWorkspaceEntitlements,
4
+ parseSetAccountEntitlements,
5
5
  type InternalService,
6
- type SetWorkspaceEntitlementsInput
6
+ type SetAccountEntitlementsInput
7
7
  } from './service'
8
- export { setWorkspaceEntitlementsSchema } from './schema'
8
+ export { setAccountEntitlementsSchema } from './schema'
@@ -1,12 +1,9 @@
1
1
  import { capabilityHashMatches, hashCapability } from '#cloud/server/sharing/crypto'
2
- import { validatedJSON } from '#cloud/server/validation'
2
+ import { accountParams, validatedJSON } from '#cloud/server/validation'
3
3
  import { Hono } from 'hono'
4
4
  import { bearerAuth } from 'hono/bearer-auth'
5
- import * as v from 'valibot'
6
5
 
7
- import { parseSetWorkspaceEntitlements, type InternalService } from './service'
8
-
9
- const uuidSchema = v.pipe(v.string(), v.uuid())
6
+ import { parseSetAccountEntitlements, type InternalService } from './service'
10
7
 
11
8
  /** The internal API on HTTP, for runtimes without a private transport to their services. */
12
9
  export function createInternalRoutes(service: InternalService, serviceToken: string) {
@@ -23,17 +20,12 @@ export function createInternalRoutes(service: InternalService, serviceToken: str
23
20
  })
24
21
  )
25
22
  .put(
26
- '/workspaces/:workspaceId/entitlements',
27
- validatedJSON(parseSetWorkspaceEntitlements),
23
+ '/accounts/:userId/entitlements',
24
+ accountParams,
25
+ validatedJSON(parseSetAccountEntitlements),
28
26
  async (context) => {
29
- const workspaceId = context.req.param('workspaceId')
30
- if (!v.is(uuidSchema, workspaceId)) {
31
- return context.json({ error: { code: 'not_found' as const } }, 404)
32
- }
33
- const result = await service.setWorkspaceEntitlements(
34
- workspaceId,
35
- context.req.valid('json')
36
- )
27
+ const { userId } = context.req.valid('param')
28
+ const result = await service.setAccountEntitlements(userId, context.req.valid('json'))
37
29
  if (!result.found) return context.json({ error: { code: 'not_found' as const } }, 404)
38
30
  return context.json({ applied: result.applied })
39
31
  }
@@ -1,7 +1,7 @@
1
1
  import { staticEntitlementsSchema } from '#cloud/server/policy/schema'
2
2
  import * as v from 'valibot'
3
3
 
4
- export const setWorkspaceEntitlementsSchema = v.object({
4
+ export const setAccountEntitlementsSchema = v.object({
5
5
  values: staticEntitlementsSchema,
6
6
  /** Who decided these values, such as `billing`; stored as the row's source. */
7
7
  source: v.pipe(v.string(), v.trim(), v.minLength(1), v.maxLength(64)),
@@ -1,14 +1,14 @@
1
1
  import type { CloudDatabase } from '#cloud/server/db'
2
- import { createWorkspaceEntitlementRepository } from '#cloud/server/policy'
2
+ import { createAccountEntitlementRepository } from '#cloud/server/policy'
3
3
  import type { Kysely } from 'kysely'
4
4
  import * as v from 'valibot'
5
5
 
6
- import { setWorkspaceEntitlementsSchema } from './schema'
6
+ import { setAccountEntitlementsSchema } from './schema'
7
7
 
8
- export type SetWorkspaceEntitlementsInput = v.InferInput<typeof setWorkspaceEntitlementsSchema>
8
+ export type SetAccountEntitlementsInput = v.InferInput<typeof setAccountEntitlementsSchema>
9
9
 
10
- export function parseSetWorkspaceEntitlements(input: unknown) {
11
- return v.parse(setWorkspaceEntitlementsSchema, input)
10
+ export function parseSetAccountEntitlements(input: unknown) {
11
+ return v.parse(setAccountEntitlementsSchema, input)
12
12
  }
13
13
 
14
14
  /**
@@ -16,26 +16,20 @@ export function parseSetWorkspaceEntitlements(input: unknown) {
16
16
  * their own transport: an authenticated HTTP route on Node, a service binding on Workers.
17
17
  */
18
18
  export function createInternalService(database: Kysely<CloudDatabase>) {
19
- const entitlements = createWorkspaceEntitlementRepository(database)
19
+ const entitlements = createAccountEntitlementRepository(database)
20
20
  return {
21
- /** `found` is false for an unknown workspace; `applied` is false for an outdated version. */
22
- async setWorkspaceEntitlements(
23
- workspaceId: string,
24
- input: SetWorkspaceEntitlementsInput
21
+ /**
22
+ * Sets an account's plan, which every workspace it owns takes. `found` is false for an
23
+ * unknown account; `applied` is false for an outdated version.
24
+ */
25
+ async setAccountEntitlements(
26
+ userId: string,
27
+ input: SetAccountEntitlementsInput
25
28
  ): Promise<{ found: boolean; applied: boolean }> {
26
- const { values, source, externalVersion } = parseSetWorkspaceEntitlements(input)
27
- const workspace = await database
28
- .selectFrom('workspace')
29
- .select('id')
30
- .where('id', '=', workspaceId)
31
- .executeTakeFirst()
32
- if (!workspace) return { found: false, applied: false }
33
- const { applied } = await entitlements.setVersioned(
34
- workspaceId,
35
- values,
36
- source,
37
- externalVersion
38
- )
29
+ const { values, source, externalVersion } = parseSetAccountEntitlements(input)
30
+ const account = await entitlements.account(userId)
31
+ if (!account) return { found: false, applied: false }
32
+ const { applied } = await entitlements.setVersioned(account, values, source, externalVersion)
39
33
  return { found: true, applied }
40
34
  }
41
35
  }
@@ -0,0 +1,66 @@
1
+ import type { CloudDatabase } from '#cloud/server/db'
2
+ import { lockForTransaction } from '#cloud/server/db/expressions'
3
+ import type { Transaction } from 'kysely'
4
+
5
+ /**
6
+ * How many invitations, to documents and workspaces alike, one person may send in a day, and how
7
+ * many one address may receive from everyone. Each sends an email naming the inviter and the file,
8
+ * both of which the sender chooses, so without a daily budget invitations are a way to send spam.
9
+ */
10
+ export const INVITATION_BUDGET = {
11
+ windowMs: 24 * 60 * 60 * 1000,
12
+ perSender: 100,
13
+ perRecipient: 5
14
+ } as const
15
+
16
+ /** An invitation past the sender's or the recipient's daily budget. */
17
+ export class InvitationLimitError extends Error {
18
+ override readonly name = 'InvitationLimitError'
19
+ }
20
+
21
+ async function sentSince(
22
+ transaction: Transaction<CloudDatabase>,
23
+ column: 'senderId' | 'emailNormalized',
24
+ value: string,
25
+ since: Date
26
+ ): Promise<number> {
27
+ const row = await transaction
28
+ .selectFrom('invitationSend')
29
+ .select((expression) => expression.fn.countAll<string>().as('count'))
30
+ .where(column, '=', value)
31
+ .where('sentAt', '>', since)
32
+ .executeTakeFirstOrThrow()
33
+ return Number(row.count)
34
+ }
35
+
36
+ /**
37
+ * Counts an invitation from `senderId` to `email` against both daily budgets, in the transaction
38
+ * that creates it, or refuses it once either budget is used. Sends are logged apart from the
39
+ * invitations, so deleting a workspace or document gives nothing back, and the check holds locks
40
+ * on the sender and the recipient, so two invitations at once cannot both take the last one.
41
+ */
42
+ export async function spendInvitationBudget(
43
+ transaction: Transaction<CloudDatabase>,
44
+ invitation: { senderId: string; email: string },
45
+ now = new Date()
46
+ ): Promise<void> {
47
+ const email = invitation.email.trim().toLowerCase()
48
+ // Always sender first, then recipient, so two transactions never wait on each other in turn.
49
+ await lockForTransaction(transaction, `invitation-sender:${invitation.senderId}`)
50
+ await lockForTransaction(transaction, `invitation-recipient:${email}`)
51
+ const since = new Date(now.getTime() - INVITATION_BUDGET.windowMs)
52
+ const bySender = await sentSince(transaction, 'senderId', invitation.senderId, since)
53
+ const byRecipient = await sentSince(transaction, 'emailNormalized', email, since)
54
+ if (bySender >= INVITATION_BUDGET.perSender || byRecipient >= INVITATION_BUDGET.perRecipient) {
55
+ throw new InvitationLimitError()
56
+ }
57
+ await transaction
58
+ .insertInto('invitationSend')
59
+ .values({
60
+ id: crypto.randomUUID(),
61
+ senderId: invitation.senderId,
62
+ emailNormalized: email,
63
+ sentAt: now
64
+ })
65
+ .execute()
66
+ }
@@ -1,3 +1,4 @@
1
+ export { INVITATION_BUDGET, InvitationLimitError, spendInvitationBudget } from './budget'
1
2
  export {
2
3
  noOpInvitationDelivery,
3
4
  type DocumentInvitationMessage,
@@ -0,0 +1,76 @@
1
+ import type { MiddlewareHandler } from 'hono'
2
+
3
+ export type CloudLogLevel = 'error' | 'warn' | 'info'
4
+
5
+ export type CloudLoggedError = {
6
+ name: string
7
+ message: string
8
+ stack?: string
9
+ cause?: CloudLoggedError
10
+ }
11
+
12
+ /** What a log line carries besides its message; never who made a request or what it carried. */
13
+ export type CloudLogFields = Record<
14
+ string,
15
+ string | number | boolean | undefined | CloudLoggedError
16
+ >
17
+
18
+ /** One structured log line. */
19
+ export type CloudLogLine = CloudLogFields & { level: CloudLogLevel; message: string }
20
+
21
+ /**
22
+ * Writes a log line where the runtime's logs go, in the form they index best. Runtimes pass their
23
+ * own to `createLoggingErrorReporter`; `writeJSONLine` is the default.
24
+ */
25
+ export type CloudLogWriter = (line: CloudLogLine) => void
26
+
27
+ /** Writes the line as one line of JSON, at the console method of its level. */
28
+ export const writeJSONLine: CloudLogWriter = (line) => {
29
+ console[line.level](JSON.stringify(line))
30
+ }
31
+
32
+ /** How deep a chain of causes is written out. */
33
+ const MAXIMUM_CAUSES = 4
34
+
35
+ /** An error as a log line keeps it: its name, message, stack, and causes. */
36
+ export function loggedError(error: unknown, depth = 0): CloudLoggedError {
37
+ if (!(error instanceof Error)) return { name: 'NonError', message: String(error) }
38
+ const cause =
39
+ error.cause !== undefined && depth < MAXIMUM_CAUSES
40
+ ? loggedError(error.cause, depth + 1)
41
+ : undefined
42
+ return { name: error.name, message: error.message, stack: error.stack, ...(cause && { cause }) }
43
+ }
44
+
45
+ /**
46
+ * Writes a warning or note through the default writer, from code no runtime hands a writer to.
47
+ * Errors go through `reportCloudError`, which logs with the runtime's.
48
+ */
49
+ export function logCloud(level: CloudLogLevel, message: string, fields: CloudLogFields = {}): void {
50
+ writeJSONLine({ ...fields, level, message })
51
+ }
52
+
53
+ /** Reads the ID that what stands in front of the server gave a request, if the runtime trusts it. */
54
+ export type ForwardedRequestId = (headers: Headers) => string | undefined
55
+
56
+ /**
57
+ * Names each request as the `requestId` variable, from what the runtime trusts in front of it
58
+ * (such as Cloudflare's ray ID) or else a new UUID, and answers with it as `X-Request-Id` so a
59
+ * person reporting a failure can quote it. Nested servers each name the request; the innermost
60
+ * one that answered keeps its ID on the response.
61
+ */
62
+ export function cloudRequestId(
63
+ forwarded?: ForwardedRequestId
64
+ ): MiddlewareHandler<{ Variables: { requestId: string } }> {
65
+ return async (context, next) => {
66
+ const id = forwarded?.(context.req.raw.headers) ?? crypto.randomUUID()
67
+ context.set('requestId', id)
68
+ context.header('X-Request-Id', id)
69
+ await next()
70
+ // A response the handler built itself, such as a page an inner server answered, misses the
71
+ // prepared header; one an inner layer named keeps its ID. A socket upgrade is left alone.
72
+ if (context.res.status !== 101 && !context.res.headers.has('X-Request-Id')) {
73
+ context.header('X-Request-Id', id)
74
+ }
75
+ }
76
+ }
@@ -54,6 +54,14 @@ export type CreateObjectUploadInput = CreateObjectDownloadInput & {
54
54
  contentType: string
55
55
  }
56
56
 
57
+ /** Bytes the server stores itself, under the checksum the caller computed and recorded. */
58
+ export type WriteObjectInput = {
59
+ key: string
60
+ bytes: Uint8Array
61
+ contentType: string
62
+ checksum: string
63
+ }
64
+
57
65
  export type CompleteObjectUploadInput = {
58
66
  key: string
59
67
  uploadId: string
@@ -78,4 +86,8 @@ export interface ObjectStore {
78
86
  abortUpload(input: AbortObjectUploadInput): Promise<void>
79
87
  head(key: string): Promise<StoredObject | null>
80
88
  delete(key: string): Promise<void>
89
+ /** Stores bytes the server holds itself, such as a collaboration room's snapshot. */
90
+ write(input: WriteObjectInput): Promise<void>
91
+ /** The bytes stored under `key`, or null when there are none. */
92
+ read(key: string): Promise<Uint8Array | null>
81
93
  }
@@ -1,3 +1,4 @@
1
+ import { pictureParams } from '#cloud/server/validation'
1
2
  import { Hono } from 'hono'
2
3
 
3
4
  import { PICTURE_PATH, type UserPictureService } from './service'
@@ -7,8 +8,9 @@ import { PICTURE_PATH, type UserPictureService } from './service'
7
8
  * documents and workspaces with, and the desktop app shows them from another origin.
8
9
  */
9
10
  export function createPictureRoutes(pictures: UserPictureService) {
10
- return new Hono().get(`${PICTURE_PATH}/:userId/:version`, async (context) => {
11
- const picture = await pictures.read(context.req.param('userId'), context.req.param('version'))
11
+ return new Hono().get(`${PICTURE_PATH}/:userId/:version`, pictureParams, async (context) => {
12
+ const { userId, version } = context.req.valid('param')
13
+ const picture = await pictures.read(userId, version)
12
14
  if (!picture) return context.json({ error: { code: 'not_found' as const } }, 404)
13
15
  // The address changes with the picture, but a removed one must stop showing within a day.
14
16
  context.header('Cache-Control', 'public, max-age=86400')
@@ -1,5 +1,6 @@
1
1
  import { CLOUD_PICTURE_MAX_BYTES } from '#cloud/contract'
2
2
  import type { CloudDatabase, UserPictureFormat } from '#cloud/server/db'
3
+ import { logCloud, loggedError } from '#cloud/server/logging'
3
4
  import { sha256 } from '@noble/hashes/sha2.js'
4
5
  import { bytesToHex } from '@noble/hashes/utils.js'
5
6
  import { imageSize } from 'image-size'
@@ -220,7 +221,7 @@ export function createUserPictures(database: Kysely<CloudDatabase>, options: Use
220
221
  if (!bytes) throw new PictureInvalidError()
221
222
  await save(userId, bytes, { from: 'provider', seen: current })
222
223
  } catch (error) {
223
- console.warn('Keeping a linked account picture failed', error)
224
+ logCloud('warn', 'Keeping a linked account picture failed', { error: loggedError(error) })
224
225
  await database
225
226
  .updateTable('user')
226
227
  .set({ image: null, updatedAt: new Date() })
@@ -10,11 +10,11 @@ export class DatabaseEntitlementSource implements EntitlementSource {
10
10
  constructor(private readonly database: Kysely<CloudDatabase>) {}
11
11
 
12
12
  private async values(subject: EntitlementSubject): Promise<Record<string, boolean | number>> {
13
- if (subject.type !== 'workspace') return {}
13
+ if (subject.type !== 'user') return {}
14
14
  const row = await this.database
15
- .selectFrom('workspaceEntitlement')
15
+ .selectFrom('accountEntitlement')
16
16
  .select('values')
17
- .where('workspaceId', '=', subject.id)
17
+ .where('userId', '=', subject.id)
18
18
  .executeTakeFirst()
19
19
  return row ? staticEntitlementValues(v.parse(staticEntitlementsSchema, row.values)) : {}
20
20
  }
@@ -34,26 +34,43 @@ export class DatabaseEntitlementSource implements EntitlementSource {
34
34
  }
35
35
  }
36
36
 
37
- export function createWorkspaceEntitlementRepository(database: Kysely<CloudDatabase>) {
37
+ /** Each account's stored entitlements, which every workspace it owns takes. */
38
+ const accountIdSchema = v.pipe(v.string(), v.uuid())
39
+
40
+ export function createAccountEntitlementRepository(database: Kysely<CloudDatabase>) {
38
41
  return {
39
- async get(workspaceId: string) {
42
+ /**
43
+ * The account `userId` names, as the user table spells it, or null when there is none, so a
44
+ * plan is stored under the key policy reads, whatever case the caller wrote the ID in.
45
+ */
46
+ async account(userId: string): Promise<string | null> {
47
+ if (!v.is(accountIdSchema, userId)) return null
48
+ const user = await database
49
+ .selectFrom('user')
50
+ .select('id')
51
+ .where('id', '=', userId)
52
+ .executeTakeFirst()
53
+ return user?.id ?? null
54
+ },
55
+
56
+ async get(userId: string) {
40
57
  return database
41
- .selectFrom('workspaceEntitlement')
58
+ .selectFrom('accountEntitlement')
42
59
  .selectAll()
43
- .where('workspaceId', '=', workspaceId)
60
+ .where('userId', '=', userId)
44
61
  .executeTakeFirst()
45
62
  },
46
63
 
47
- async set(workspaceId: string, values: StaticEntitlementsInput, source: string) {
64
+ async set(userId: string, values: StaticEntitlementsInput, source: string) {
48
65
  const validated = v.parse(staticEntitlementsSchema, values)
49
66
  return database
50
- .insertInto('workspaceEntitlement')
51
- .values({ workspaceId, values: validated, source })
67
+ .insertInto('accountEntitlement')
68
+ .values({ userId, values: validated, source })
52
69
  .onConflict((conflict) =>
53
- conflict.column('workspaceId').doUpdateSet({
70
+ conflict.column('userId').doUpdateSet({
54
71
  values: validated,
55
72
  source,
56
- revision: (expression) => expression('workspaceEntitlement.revision', '+', 1),
73
+ revision: (expression) => expression('accountEntitlement.revision', '+', 1),
57
74
  updatedAt: new Date()
58
75
  })
59
76
  )
@@ -67,42 +84,39 @@ export function createWorkspaceEntitlementRepository(database: Kysely<CloudDatab
67
84
  * An unversioned row, such as one an operator set, is replaced.
68
85
  */
69
86
  async setVersioned(
70
- workspaceId: string,
87
+ userId: string,
71
88
  values: StaticEntitlementsInput,
72
89
  source: string,
73
90
  externalVersion: number
74
91
  ): Promise<{ applied: boolean }> {
75
92
  const validated = v.parse(staticEntitlementsSchema, values)
76
93
  const row = await database
77
- .insertInto('workspaceEntitlement')
78
- .values({ workspaceId, values: validated, source, externalVersion })
94
+ .insertInto('accountEntitlement')
95
+ .values({ userId, values: validated, source, externalVersion })
79
96
  .onConflict((conflict) =>
80
97
  conflict
81
- .column('workspaceId')
98
+ .column('userId')
82
99
  .doUpdateSet({
83
100
  values: validated,
84
101
  source,
85
102
  externalVersion,
86
- revision: (expression) => expression('workspaceEntitlement.revision', '+', 1),
103
+ revision: (expression) => expression('accountEntitlement.revision', '+', 1),
87
104
  updatedAt: new Date()
88
105
  })
89
106
  .where((expression) =>
90
107
  expression.or([
91
- expression('workspaceEntitlement.externalVersion', 'is', null),
92
- expression('workspaceEntitlement.externalVersion', '<', externalVersion)
108
+ expression('accountEntitlement.externalVersion', 'is', null),
109
+ expression('accountEntitlement.externalVersion', '<', externalVersion)
93
110
  ])
94
111
  )
95
112
  )
96
- .returning('workspaceId')
113
+ .returning('userId')
97
114
  .executeTakeFirst()
98
115
  return { applied: row !== undefined }
99
116
  },
100
117
 
101
- async clear(workspaceId: string): Promise<void> {
102
- await database
103
- .deleteFrom('workspaceEntitlement')
104
- .where('workspaceId', '=', workspaceId)
105
- .execute()
118
+ async clear(userId: string): Promise<void> {
119
+ await database.deleteFrom('accountEntitlement').where('userId', '=', userId).execute()
106
120
  }
107
121
  }
108
122
  }
@@ -1,4 +1,5 @@
1
- export { createWorkspaceEntitlementRepository, DatabaseEntitlementSource } from './database'
1
+ export { createAccountEntitlementRepository, DatabaseEntitlementSource } from './database'
2
+ export { workspacePolicyContext } from './workspace'
2
3
  export {
3
4
  StaticEntitlementSource,
4
5
  type EntitlementSource,