@open-pencil/cloud 0.17.0-beta.2 → 0.17.0-beta.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/bin/{ai-relay.mjs → services.mjs} +8 -8
- package/dist/bin/services.mjs.map +1 -0
- package/dist/client.d.ts +236 -46
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +649 -400
- package/dist/client.js.map +1 -1
- package/dist/contract.d.ts +2 -2
- package/dist/contract.js +2 -2
- package/dist/contract2.js +680 -443
- package/dist/contract2.js.map +1 -1
- package/dist/email.d.ts +9 -1
- package/dist/email.d.ts.map +1 -1
- package/dist/email.js +99 -58
- package/dist/email.js.map +1 -1
- package/dist/index.d.ts +469 -65
- package/dist/index.d.ts.map +1 -1
- package/dist/listen.mjs +505 -787
- package/dist/listen.mjs.map +1 -1
- package/dist/runtime-node.d.mts +3920 -2524
- package/dist/runtime-node.d.mts.map +1 -1
- package/dist/runtime-node.mjs +6 -5
- package/dist/runtime-node.mjs.map +1 -1
- package/dist/server.d.ts +3586 -1897
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +5216 -4272
- package/dist/server.js.map +1 -1
- package/dist/server.mjs +5179 -3623
- package/dist/server.mjs.map +1 -1
- package/dist/server2.mjs +101 -79
- package/dist/server2.mjs.map +1 -1
- package/package.json +7 -6
- package/src/admin/api/routes.ts +59 -0
- package/src/admin/audit/service.ts +25 -6
- package/src/admin/documents/service.ts +361 -0
- package/src/admin/errors.ts +9 -1
- package/src/admin/index.ts +6 -0
- package/src/admin/operations/service.ts +7 -0
- package/src/admin/reports/service.ts +147 -0
- package/src/admin/schema.ts +6 -0
- package/src/client/api.ts +36 -21
- package/src/client/auth/navigation.ts +6 -5
- package/src/client/index.ts +7 -7
- package/src/client/portal/account.ts +25 -0
- package/src/client/portal/administration.ts +56 -0
- package/src/client/{ai.ts → services.ts} +44 -27
- package/src/contract/account.ts +58 -2
- package/src/contract/admin/index.ts +67 -3
- package/src/contract/collaboration.ts +6 -1
- package/src/contract/discovery.ts +22 -4
- package/src/contract/documents.ts +27 -0
- package/src/contract/entitlements.ts +2 -2
- package/src/contract/index.ts +63 -37
- package/src/contract/relay.ts +6 -0
- package/src/contract/reports.ts +42 -0
- package/src/contract/services.ts +233 -0
- package/src/contract/sharing.ts +3 -9
- package/src/email/render.ts +26 -0
- package/src/email/schema.ts +11 -1
- package/src/email/templates/brand.ts +1 -1
- package/src/runtime/cloudflare/environment.ts +22 -11
- package/src/runtime/cloudflare/index.ts +1 -1
- package/src/runtime/cloudflare/logging.ts +15 -0
- package/src/runtime/cloudflare/maintenance.ts +31 -0
- package/src/runtime/cloudflare/relay/index.ts +62 -14
- package/src/runtime/cloudflare/worker.ts +39 -13
- package/src/runtime/node/application.ts +5 -3
- package/src/runtime/node/bootstrap.ts +15 -4
- package/src/runtime/node/cleanup.ts +16 -3
- package/src/runtime/node/entitlements/main.ts +14 -11
- package/src/runtime/node/index.ts +1 -1
- package/src/runtime/node/migrate.ts +5 -1
- package/src/runtime/node/relay.ts +8 -2
- package/src/runtime/node/request-id.ts +13 -0
- package/src/runtime/node/server.ts +39 -15
- package/src/runtime/node/{ai-relay → services}/main.ts +6 -6
- package/src/runtime/node/{ai-relay → services}/server.ts +18 -18
- package/src/runtime/postgres/database.ts +20 -1
- package/src/runtime/posthog/errors.ts +15 -31
- package/src/runtime/s3/objects.ts +24 -1
- package/src/runtime/site/server.ts +32 -5
- package/src/server/account/actions.ts +5 -0
- package/src/server/account/deletion.ts +302 -0
- package/src/server/account/routes.ts +47 -3
- package/src/server/account/terms.ts +42 -0
- package/src/server/api/router.ts +9 -5
- package/src/server/api/types.ts +2 -0
- package/src/server/app.ts +90 -16
- package/src/server/auth/access-control.ts +63 -0
- package/src/server/auth/adapter.ts +11 -0
- package/src/server/auth/endpoints.ts +5 -1
- package/src/server/auth/factory.ts +30 -3
- package/src/server/auth/index.ts +10 -1
- package/src/server/cleanup/configured.ts +12 -5
- package/src/server/cleanup/documents.ts +165 -71
- package/src/server/cleanup/revisions.ts +16 -5
- package/src/server/cleanup/uploads.ts +8 -2
- package/src/server/cleanup/worker.ts +5 -2
- package/src/server/collaboration/relay/connection.ts +4 -3
- package/src/server/collaboration/relay/documents.ts +13 -10
- package/src/server/collaboration/relay/hub.ts +97 -25
- package/src/server/collaboration/relay/log.ts +5 -2
- package/src/server/collaboration/service.ts +27 -31
- package/src/server/config/deployment.ts +24 -4
- package/src/server/config/public.ts +5 -4
- package/src/server/config/schema.ts +82 -16
- package/src/server/db/expressions.ts +15 -1
- package/src/server/db/migrate.ts +34 -116
- package/src/server/db/migrations/001_accounts.ts +79 -0
- package/src/server/db/migrations/002_workspaces.ts +48 -0
- package/src/server/db/migrations/003_storage.ts +44 -0
- package/src/server/db/migrations/004_documents.ts +193 -0
- package/src/server/db/migrations/005_sharing.ts +95 -0
- package/src/server/db/migrations/006_operations.ts +110 -0
- package/src/server/db/migrations/007_trash.ts +33 -0
- package/src/server/db/migrations/008_terms.ts +18 -0
- package/src/server/db/migrations/schema.ts +71 -0
- package/src/server/db/tables.ts +52 -3
- package/src/server/documents/access.ts +66 -55
- package/src/server/documents/errors.ts +7 -0
- package/src/server/documents/images.ts +2 -1
- package/src/server/documents/limits.ts +9 -9
- package/src/server/documents/purge.ts +75 -0
- package/src/server/documents/repository.ts +2 -0
- package/src/server/documents/routes.ts +26 -0
- package/src/server/documents/service.ts +18 -4
- package/src/server/documents/summary.ts +1 -0
- package/src/server/documents/trash.ts +203 -0
- package/src/server/documents/versions/checkpoint.ts +2 -1
- package/src/server/documents/versions/history.ts +11 -7
- package/src/server/documents/versions/service.ts +13 -4
- package/src/server/errors/index.ts +59 -16
- package/src/server/errors/posthog.ts +80 -0
- package/src/server/index.ts +46 -17
- package/src/server/internal/index.ts +3 -3
- package/src/server/internal/routes.ts +7 -10
- package/src/server/internal/schema.ts +1 -1
- package/src/server/internal/service.ts +17 -23
- package/src/server/invitations/budget.ts +66 -0
- package/src/server/invitations/index.ts +1 -0
- package/src/server/logging.ts +76 -0
- package/src/server/pictures/service.ts +2 -1
- package/src/server/policy/database.ts +39 -25
- package/src/server/policy/index.ts +2 -1
- package/src/server/policy/keys.ts +5 -2
- package/src/server/policy/policy.ts +1 -0
- package/src/server/policy/schema.ts +2 -2
- package/src/server/policy/service.ts +12 -9
- package/src/server/policy/static.ts +5 -5
- package/src/server/policy/workspace.ts +41 -0
- package/src/server/quota/reconcile.ts +2 -0
- package/src/server/quota/storage.ts +69 -31
- package/src/server/rate-limit/cleanup.ts +17 -5
- package/src/server/rate-limit/middleware.ts +2 -2
- package/src/server/reports/index.ts +8 -0
- package/src/server/reports/routes.ts +37 -0
- package/src/server/reports/service.ts +123 -0
- package/src/server/services/errors.ts +7 -0
- package/src/server/services/index.ts +8 -0
- package/src/server/{ai → services}/keys.ts +11 -11
- package/src/server/services/routes.ts +47 -0
- package/src/server/{ai/service.ts → services/tokens.ts} +23 -20
- package/src/server/sharing/capabilities/service.ts +68 -22
- package/src/server/sharing/grants/service.ts +11 -18
- package/src/server/sharing/http.ts +4 -0
- package/src/server/sharing/invitations/service.ts +21 -11
- package/src/server/sharing/policy.ts +9 -14
- package/src/server/sharing/routes.ts +0 -16
- package/src/server/sharing/service.ts +1 -17
- package/src/server/validation.ts +1 -0
- package/src/server/workspaces/index.ts +1 -0
- package/src/server/workspaces/members.ts +89 -38
- package/src/server/workspaces/repository.ts +2 -1
- package/src/server/workspaces/routes.ts +4 -0
- package/src/{ai-relay → services}/app.ts +48 -44
- package/src/{ai-relay → services}/config.ts +25 -19
- package/src/services/db/index.ts +10 -0
- package/src/services/db/migrate.ts +37 -0
- package/src/{ai-relay/db/migrations/001_usage.ts → services/db/migrations/001_baseline.ts} +18 -7
- package/src/services/db/schema.ts +22 -0
- package/src/services/index.ts +18 -0
- package/src/{ai-relay → services}/metering.ts +2 -2
- package/src/{ai-relay → services}/usage.ts +43 -19
- package/dist/bin/ai-relay.mjs.map +0 -1
- package/src/ai-relay/db/index.ts +0 -10
- package/src/ai-relay/db/migrate.ts +0 -32
- package/src/ai-relay/db/schema.ts +0 -20
- package/src/ai-relay/index.ts +0 -18
- package/src/contract/ai.ts +0 -150
- package/src/server/ai/errors.ts +0 -7
- package/src/server/ai/index.ts +0 -4
- package/src/server/ai/routes.ts +0 -43
- package/src/server/auth/workspace-access.ts +0 -23
- package/src/server/db/migrations/001_foundation.ts +0 -164
- package/src/server/db/migrations/002_upload_cleanup_claims.ts +0 -34
- package/src/server/db/migrations/003_document_cleanup_claims.ts +0 -23
- package/src/server/db/migrations/004_document_sharing.ts +0 -82
- package/src/server/db/migrations/005_document_collaboration_epoch.ts +0 -13
- package/src/server/db/migrations/006_invitation_continuation.ts +0 -27
- package/src/server/db/migrations/007_collaboration_state.ts +0 -25
- package/src/server/db/migrations/008_storage_reservations.ts +0 -37
- package/src/server/db/migrations/009_workspace_entitlements.ts +0 -22
- package/src/server/db/migrations/010_upload_finalization.ts +0 -22
- package/src/server/db/migrations/011_upload_finalization_lease.ts +0 -12
- package/src/server/db/migrations/012_transactional_email.ts +0 -48
- package/src/server/db/migrations/013_admin_enrollment.ts +0 -54
- package/src/server/db/migrations/014_enrollment_email_kinds.ts +0 -30
- package/src/server/db/migrations/015_cloud_rate_limit.ts +0 -22
- package/src/server/db/migrations/016_auth_schema.ts +0 -16
- package/src/server/db/migrations/017_authentication_email_kinds.ts +0 -32
- package/src/server/db/migrations/018_authentication_mfa.ts +0 -78
- package/src/server/db/migrations/019_better_auth_account_issuer.ts +0 -42
- package/src/server/db/migrations/020_workspace_invitations.ts +0 -57
- package/src/server/db/migrations/021_document_versions.ts +0 -66
- package/src/server/db/migrations/022_entitlement_external_version.ts +0 -17
- package/src/server/db/migrations/023_document_images.ts +0 -61
- package/src/server/db/migrations/024_account_activity.ts +0 -66
- package/src/server/db/migrations/025_table_names.ts +0 -58
- package/src/server/db/migrations/026_user_picture.ts +0 -30
- package/src/server/db/migrations/027_document_kind.ts +0 -19
- package/src/server/db/migrations/028_collaboration_updates.ts +0 -84
- package/src/server/db/migrations/helpers.ts +0 -78
- /package/dist/bin/{ai-relay.d.mts → services.d.mts} +0 -0
package/src/server/app.ts
CHANGED
|
@@ -1,20 +1,24 @@
|
|
|
1
1
|
import {
|
|
2
2
|
createAdminAuditService,
|
|
3
|
+
createAdminDocumentService,
|
|
3
4
|
createAdminEmailService,
|
|
4
5
|
createAdminOperationsService,
|
|
6
|
+
createAdminReportService,
|
|
5
7
|
createAdminUserService,
|
|
6
8
|
createCloudAdminRoutes,
|
|
7
9
|
createEnrollmentService,
|
|
8
10
|
type EnrollmentService
|
|
9
11
|
} from '#cloud/admin'
|
|
10
12
|
import {
|
|
11
|
-
|
|
13
|
+
CLOUD_API_MAX_BODY_BYTES,
|
|
14
|
+
CLOUD_SERVICES_JWKS_PATH,
|
|
12
15
|
CLOUD_DISCOVERY_PATH,
|
|
13
16
|
CLOUD_PROTOCOL_VERSION,
|
|
14
17
|
type CloudDiscovery
|
|
15
18
|
} from '#cloud/contract'
|
|
19
|
+
import { createAccountDeletionService } from '#cloud/server/account/deletion'
|
|
16
20
|
import { createAccountRoutes } from '#cloud/server/account/routes'
|
|
17
|
-
import {
|
|
21
|
+
import { createTermsService } from '#cloud/server/account/terms'
|
|
18
22
|
import {
|
|
19
23
|
createCloudAPIRouter,
|
|
20
24
|
createPublicCloudAPIRouter,
|
|
@@ -42,6 +46,7 @@ import type { TransactionalEmailService } from '#cloud/server/email'
|
|
|
42
46
|
import { cloudErrorHandler, type CloudErrorReporter } from '#cloud/server/errors'
|
|
43
47
|
import { createInternalRoutes, createInternalService } from '#cloud/server/internal'
|
|
44
48
|
import type { InvitationDelivery, InvitationOutbox } from '#cloud/server/invitations'
|
|
49
|
+
import { cloudRequestId, type ForwardedRequestId } from '#cloud/server/logging'
|
|
45
50
|
import type { ObjectStore } from '#cloud/server/objects'
|
|
46
51
|
import { createPictureRoutes, createUserPictures } from '#cloud/server/pictures'
|
|
47
52
|
import {
|
|
@@ -58,9 +63,12 @@ import {
|
|
|
58
63
|
createTrustedIPRateLimiter,
|
|
59
64
|
routeHasOwnBudget
|
|
60
65
|
} from '#cloud/server/rate-limit'
|
|
66
|
+
import { createDocumentReportService } from '#cloud/server/reports'
|
|
67
|
+
import { createServicesTokenService, type ServicesSigningKey } from '#cloud/server/services'
|
|
61
68
|
import { createDocumentSharingService } from '#cloud/server/sharing'
|
|
62
69
|
import { createWorkspaceMemberService, createWorkspaceService } from '#cloud/server/workspaces'
|
|
63
70
|
import { Hono, type Context } from 'hono'
|
|
71
|
+
import { bodyLimit } from 'hono/body-limit'
|
|
64
72
|
import { cors } from 'hono/cors'
|
|
65
73
|
import type { Kysely } from 'kysely'
|
|
66
74
|
|
|
@@ -71,14 +79,19 @@ export type CloudServices = {
|
|
|
71
79
|
objects: ObjectStore
|
|
72
80
|
resolveIdentity?: CloudIdentityResolver
|
|
73
81
|
resolveSession?: CloudSessionResolver
|
|
82
|
+
/**
|
|
83
|
+
* An approved account even before it accepted the current terms, for leaving: reading its
|
|
84
|
+
* documents and deleting the account. Defaults to `resolveSession` when that is given.
|
|
85
|
+
*/
|
|
86
|
+
resolveAccountSession?: CloudSessionResolver
|
|
74
87
|
invitationDelivery?: InvitationDelivery
|
|
75
88
|
invitationOutbox?: InvitationOutbox
|
|
76
89
|
transactionalEmail?: TransactionalEmailService
|
|
77
90
|
enrollment?: EnrollmentService
|
|
78
91
|
entitlementSource?: EntitlementSource
|
|
79
92
|
policy?: CloudPolicy
|
|
80
|
-
/** The imported `
|
|
81
|
-
|
|
93
|
+
/** The imported `servicesSigningKey`, required when the config names one. See `loadServicesSigningKey`. */
|
|
94
|
+
servicesSigningKey?: ServicesSigningKey
|
|
82
95
|
/**
|
|
83
96
|
* Where clients reach this runtime's collaboration relay. Without one, Cloud rooms fall back to
|
|
84
97
|
* peer-to-peer and writes are not enforced by the server.
|
|
@@ -86,10 +99,14 @@ export type CloudServices = {
|
|
|
86
99
|
relayURL?: string
|
|
87
100
|
/** Ends a restored document's live rooms, on the relay this runtime runs, if any. */
|
|
88
101
|
onDocumentRestored?: (documentId: string) => void
|
|
102
|
+
/** Ends a taken-down document's live rooms, saving them for when it is restored. */
|
|
103
|
+
onDocumentTakenDown?: (documentId: string) => void
|
|
89
104
|
/** Tells a document's live rooms its version history changed, on the relay this runtime runs. */
|
|
90
105
|
onDocumentVersionsChanged?: (documentId: string) => void
|
|
91
|
-
/**
|
|
106
|
+
/** Logs errors no route handled, and reports them when the deployment configures error tracking. */
|
|
92
107
|
reportError?: CloudErrorReporter
|
|
108
|
+
/** The request ID this runtime trusts from what stands in front of it, such as `cf-ray`. */
|
|
109
|
+
forwardedRequestId?: ForwardedRequestId
|
|
93
110
|
}
|
|
94
111
|
|
|
95
112
|
type CloudEnvironment = CloudAPIEnvironment
|
|
@@ -132,6 +149,11 @@ export function createCloudApp(services: CloudServices) {
|
|
|
132
149
|
const discovery = discoveryFromServices(services)
|
|
133
150
|
const resolveIdentity = services.resolveIdentity ?? createCloudIdentityResolver(services.auth)
|
|
134
151
|
const resolveSession = services.resolveSession ?? createCloudSessionResolver(services.auth)
|
|
152
|
+
const resolveAccountSession =
|
|
153
|
+
services.resolveAccountSession ??
|
|
154
|
+
(services.resolveSession
|
|
155
|
+
? services.resolveSession
|
|
156
|
+
: (request: Request) => services.auth.resolveAccountSession(request.headers))
|
|
135
157
|
const allowedOrigins = new Set(
|
|
136
158
|
[services.config.publicURL, ...services.config.trustedOrigins].map(
|
|
137
159
|
(origin) => new URL(origin).origin
|
|
@@ -171,7 +193,12 @@ export function createCloudApp(services: CloudServices) {
|
|
|
171
193
|
: undefined
|
|
172
194
|
}),
|
|
173
195
|
audit: createAdminAuditService(services.database),
|
|
174
|
-
operations: createAdminOperationsService(services.database, services.config)
|
|
196
|
+
operations: createAdminOperationsService(services.database, services.config),
|
|
197
|
+
documents: createAdminDocumentService(services.database, {
|
|
198
|
+
closeRooms: services.onDocumentTakenDown,
|
|
199
|
+
purgeGraceMs: services.config.documentPurgeGraceMs
|
|
200
|
+
}),
|
|
201
|
+
reports: createAdminReportService(services.database)
|
|
175
202
|
},
|
|
176
203
|
allowedOrigins,
|
|
177
204
|
{
|
|
@@ -189,7 +216,14 @@ export function createCloudApp(services: CloudServices) {
|
|
|
189
216
|
const documents = createDocumentService(services.database, services.objects, {
|
|
190
217
|
policy,
|
|
191
218
|
technicalMaximumUploadBytes: services.config.technicalLimits.maximumUploadBytes,
|
|
192
|
-
onVersionsChanged: services.onDocumentVersionsChanged
|
|
219
|
+
onVersionsChanged: services.onDocumentVersionsChanged,
|
|
220
|
+
trash: {
|
|
221
|
+
retentionMs: services.config.documentRetentionMs,
|
|
222
|
+
purgeGraceMs: services.config.documentPurgeGraceMs,
|
|
223
|
+
leaseDurationMs: services.config.cleanupLeaseDurationMs,
|
|
224
|
+
reportError: services.reportError
|
|
225
|
+
},
|
|
226
|
+
reportError: services.reportError
|
|
193
227
|
})
|
|
194
228
|
const versions = createDocumentVersionService(services.database, services.objects, {
|
|
195
229
|
policy,
|
|
@@ -220,26 +254,46 @@ export function createCloudApp(services: CloudServices) {
|
|
|
220
254
|
policy,
|
|
221
255
|
deploymentMode: services.config.deployment
|
|
222
256
|
})
|
|
223
|
-
if (services.config.
|
|
224
|
-
throw new CloudConfigError('
|
|
257
|
+
if (services.config.servicesSigningKey && !services.servicesSigningKey) {
|
|
258
|
+
throw new CloudConfigError('Services need the signing key imported by loadServicesSigningKey')
|
|
225
259
|
}
|
|
226
|
-
const
|
|
227
|
-
?
|
|
260
|
+
const servicesTokens = services.servicesSigningKey
|
|
261
|
+
? createServicesTokenService({
|
|
228
262
|
database: services.database,
|
|
229
263
|
policy,
|
|
230
264
|
deploymentMode: services.config.deployment,
|
|
231
265
|
issuer: new URL(services.config.publicURL).origin,
|
|
232
|
-
signingKey: services.
|
|
233
|
-
lifetimeSeconds: services.config.
|
|
266
|
+
signingKey: services.servicesSigningKey,
|
|
267
|
+
lifetimeSeconds: services.config.servicesTokenLifetimeSeconds
|
|
234
268
|
})
|
|
235
269
|
: undefined
|
|
236
270
|
|
|
237
271
|
const requireActiveSession = async (context: Context, next: () => Promise<void>) => {
|
|
272
|
+
// A route that lets an account leave before accepting the terms named it already.
|
|
273
|
+
if (context.get('actor')) return next()
|
|
238
274
|
const actor = await resolveSession(context.req.raw)
|
|
239
275
|
if (!actor) return context.json({ error: { code: 'unauthorized' as const } }, 401)
|
|
240
276
|
context.set('actor', actor)
|
|
241
277
|
return next()
|
|
242
278
|
}
|
|
279
|
+
/**
|
|
280
|
+
* An account that may leave: one that has terms to accept can still download its documents and
|
|
281
|
+
* delete itself, which nothing else lets it do until it accepts.
|
|
282
|
+
*/
|
|
283
|
+
const requireAccountSession = async (context: Context, next: () => Promise<void>) => {
|
|
284
|
+
const actor = await resolveAccountSession(context.req.raw)
|
|
285
|
+
if (!actor) return context.json({ error: { code: 'unauthorized' as const } }, 401)
|
|
286
|
+
context.set('actor', actor)
|
|
287
|
+
return next()
|
|
288
|
+
}
|
|
289
|
+
/** Reading one document, which downloading everything before leaving needs, without the terms. */
|
|
290
|
+
const allowLeavingRead = async (context: Context, next: () => Promise<void>) => {
|
|
291
|
+
if (context.req.method === 'GET') {
|
|
292
|
+
const actor = await resolveAccountSession(context.req.raw)
|
|
293
|
+
if (actor) context.set('actor', actor)
|
|
294
|
+
}
|
|
295
|
+
return next()
|
|
296
|
+
}
|
|
243
297
|
const publicRateLimiter = createTrustedIPRateLimiter(
|
|
244
298
|
services.database,
|
|
245
299
|
services.config.authSecret,
|
|
@@ -271,15 +325,24 @@ export function createCloudApp(services: CloudServices) {
|
|
|
271
325
|
|
|
272
326
|
const accountRoutes = createAccountRoutes({
|
|
273
327
|
auth: services.auth,
|
|
328
|
+
terms: createTermsService(services.database, services.config),
|
|
274
329
|
pictures,
|
|
275
330
|
config: services.config,
|
|
276
331
|
enrollment,
|
|
277
332
|
workspaces,
|
|
333
|
+
deletion: createAccountDeletionService(services.database),
|
|
278
334
|
resolveIdentity,
|
|
279
335
|
resolveSession,
|
|
280
336
|
requireActiveSession,
|
|
337
|
+
requireAccountSession,
|
|
281
338
|
authenticatedMutationLimiter
|
|
282
339
|
})
|
|
340
|
+
const reports = createDocumentReportService(services.database, {
|
|
341
|
+
sharing,
|
|
342
|
+
email: services.transactionalEmail,
|
|
343
|
+
adminRecipients: services.config.enrollmentAdminNotificationEmails,
|
|
344
|
+
publicURL: services.config.publicURL
|
|
345
|
+
})
|
|
283
346
|
const cloudAPI = createCloudAPIRouter({
|
|
284
347
|
collaboration,
|
|
285
348
|
database: services.database,
|
|
@@ -287,8 +350,9 @@ export function createCloudApp(services: CloudServices) {
|
|
|
287
350
|
documents,
|
|
288
351
|
versions,
|
|
289
352
|
entitlements,
|
|
290
|
-
|
|
353
|
+
servicesTokens,
|
|
291
354
|
sharing,
|
|
355
|
+
reports,
|
|
292
356
|
workspaces,
|
|
293
357
|
workspaceMembers,
|
|
294
358
|
resolveSession
|
|
@@ -299,6 +363,7 @@ export function createCloudApp(services: CloudServices) {
|
|
|
299
363
|
versions,
|
|
300
364
|
entitlements,
|
|
301
365
|
sharing,
|
|
366
|
+
reports,
|
|
302
367
|
workspaces,
|
|
303
368
|
workspaceMembers,
|
|
304
369
|
resolveSession
|
|
@@ -314,8 +379,16 @@ export function createCloudApp(services: CloudServices) {
|
|
|
314
379
|
|
|
315
380
|
return new Hono<CloudEnvironment>()
|
|
316
381
|
.onError(cloudErrorHandler(services.reportError))
|
|
382
|
+
.use('*', cloudRequestId(services.forwardedRequestId))
|
|
317
383
|
.use(CLOUD_DISCOVERY_PATH, cloudCORS)
|
|
318
384
|
.use('/api/*', cloudCORS)
|
|
385
|
+
.use(
|
|
386
|
+
'/api/*',
|
|
387
|
+
bodyLimit({
|
|
388
|
+
maxSize: CLOUD_API_MAX_BODY_BYTES,
|
|
389
|
+
onError: (context) => context.json({ error: { code: 'invalid_request' as const } }, 413)
|
|
390
|
+
})
|
|
391
|
+
)
|
|
319
392
|
.use('*', async (context, next) => {
|
|
320
393
|
await next()
|
|
321
394
|
if (shouldPreventIndexing(context.req.path, services.config.indexingPolicy)) {
|
|
@@ -358,8 +431,8 @@ export function createCloudApp(services: CloudServices) {
|
|
|
358
431
|
}
|
|
359
432
|
})
|
|
360
433
|
.get(CLOUD_DISCOVERY_PATH, (context) => context.json(discovery))
|
|
361
|
-
.get(
|
|
362
|
-
|
|
434
|
+
.get(CLOUD_SERVICES_JWKS_PATH, async (context) =>
|
|
435
|
+
servicesTokens ? context.json(servicesTokens.jwks()) : context.notFound()
|
|
363
436
|
)
|
|
364
437
|
.on(['GET', 'POST'], `${AUTH_BASE_PATH}/*`, (context) => services.auth.handler(context.req.raw))
|
|
365
438
|
.route('/', accountRoutes)
|
|
@@ -370,6 +443,7 @@ export function createCloudApp(services: CloudServices) {
|
|
|
370
443
|
.use('/api/invitations/*', publicRateLimiter)
|
|
371
444
|
.route('/api', publicCloudAPI)
|
|
372
445
|
.route('/api/internal', internalAPI)
|
|
446
|
+
.use('/api/documents/:documentId', allowLeavingRead)
|
|
373
447
|
.use('/api/*', requireActiveSession)
|
|
374
448
|
.route('/api/admin', admin)
|
|
375
449
|
.use('/api/*', authenticatedMutationLimiter)
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
import type { DocumentPermission, WorkspaceRole } from '#cloud/contract'
|
|
2
|
+
import { createAccessControl } from 'better-auth/plugins/access'
|
|
3
|
+
|
|
4
|
+
export const accessStatements = {
|
|
5
|
+
workspace: ['read', 'update', 'delete', 'invite', 'manage-members'],
|
|
6
|
+
/** `delete` moves a document to Trash and back; `purge` deletes it from Trash for good. */
|
|
7
|
+
document: ['create', 'read', 'edit', 'share', 'delete', 'purge']
|
|
8
|
+
} as const
|
|
9
|
+
|
|
10
|
+
type AccessStatements = typeof accessStatements
|
|
11
|
+
|
|
12
|
+
/** Actions a check asks for, by resource; every listed action must be allowed. */
|
|
13
|
+
export type AccessRequest = {
|
|
14
|
+
[Resource in keyof AccessStatements]?: AccessStatements[Resource][number][]
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
export const accessControl = createAccessControl(accessStatements)
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* What a workspace member may do there, by role. Together with `documentRoles` this is the whole
|
|
21
|
+
* permission policy: every check goes through `workspaceRoleCan` or `documentRoleCan`.
|
|
22
|
+
*/
|
|
23
|
+
export const workspaceRoles = {
|
|
24
|
+
admin: accessControl.newRole({
|
|
25
|
+
workspace: ['read', 'update', 'delete', 'invite', 'manage-members'],
|
|
26
|
+
document: ['create', 'read', 'edit', 'share', 'delete', 'purge']
|
|
27
|
+
}),
|
|
28
|
+
editor: accessControl.newRole({
|
|
29
|
+
workspace: ['read'],
|
|
30
|
+
document: ['create', 'read', 'edit', 'share', 'delete']
|
|
31
|
+
}),
|
|
32
|
+
viewer: accessControl.newRole({
|
|
33
|
+
workspace: ['read'],
|
|
34
|
+
document: ['read']
|
|
35
|
+
})
|
|
36
|
+
} satisfies Record<WorkspaceRole, unknown>
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* What someone may do with one document through something other than workspace membership: being
|
|
40
|
+
* its owner, or a grant made to them. A grant lets its holder edit and share, never delete the
|
|
41
|
+
* owner's document. Deleting from Trash for good is for the owner and workspace administrators.
|
|
42
|
+
*/
|
|
43
|
+
export const documentRoles = {
|
|
44
|
+
owner: accessControl.newRole({ document: ['read', 'edit', 'share', 'delete', 'purge'] }),
|
|
45
|
+
editor: accessControl.newRole({ document: ['read', 'edit', 'share'] }),
|
|
46
|
+
viewer: accessControl.newRole({ document: ['read'] })
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export type DocumentRole = keyof typeof documentRoles
|
|
50
|
+
|
|
51
|
+
/** The document role a direct grant of this permission gives. */
|
|
52
|
+
export const GRANT_DOCUMENT_ROLE: Record<DocumentPermission, DocumentRole> = {
|
|
53
|
+
view: 'viewer',
|
|
54
|
+
edit: 'editor'
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
export function workspaceRoleCan(role: WorkspaceRole, request: AccessRequest): boolean {
|
|
58
|
+
return workspaceRoles[role].authorize(request).success
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
export function documentRoleCan(role: DocumentRole, request: AccessRequest): boolean {
|
|
62
|
+
return documentRoles[role].authorize(request).success
|
|
63
|
+
}
|
|
@@ -38,6 +38,11 @@ export interface CloudAuthAdapter {
|
|
|
38
38
|
handler(request: Request): Promise<Response>
|
|
39
39
|
resolveIdentity(headers: Headers): Promise<CloudIdentity | null>
|
|
40
40
|
resolveSession(headers: Headers): Promise<CloudActor | null>
|
|
41
|
+
/**
|
|
42
|
+
* The signed-in person while their account is approved, whether or not it accepted the current
|
|
43
|
+
* terms: enough to leave, by downloading its documents and deleting the account.
|
|
44
|
+
*/
|
|
45
|
+
resolveAccountSession(headers: Headers): Promise<CloudActor | null>
|
|
41
46
|
listAuthenticationMethods(headers: Headers): Promise<CloudAuthenticationMethodRecord[]>
|
|
42
47
|
changePassword(
|
|
43
48
|
headers: Headers,
|
|
@@ -74,6 +79,12 @@ export interface CloudAuthAdapter {
|
|
|
74
79
|
revokeSession(headers: Headers, sessionId: string): Promise<void>
|
|
75
80
|
revokeOtherSessions(headers: Headers): Promise<void>
|
|
76
81
|
signIns(headers: Headers): Promise<CloudSignIn[] | null>
|
|
82
|
+
/**
|
|
83
|
+
* Deletes the signed-in account through Better Auth, after Cloud removes what it keeps about
|
|
84
|
+
* it; a session that signed in a while ago gives its password. Answers the headers that clear the
|
|
85
|
+
* session cookie.
|
|
86
|
+
*/
|
|
87
|
+
deleteAccount(headers: Headers, password?: string): Promise<Headers>
|
|
77
88
|
migrate: () => Promise<void>
|
|
78
89
|
schemaVersion: string
|
|
79
90
|
}
|
|
@@ -15,12 +15,14 @@ type CorePaths<Names extends keyof typeof BetterAuthEndpoints> = {
|
|
|
15
15
|
|
|
16
16
|
/**
|
|
17
17
|
* The core endpoints whose paths Better Auth's own options need before it is built: rate limits,
|
|
18
|
-
* captcha, and the hooks that record sign-ins. Plugin endpoints come from the plugin objects and
|
|
18
|
+
* captcha, disabled paths, and the hooks that record sign-ins. Plugin endpoints come from the plugin objects and
|
|
19
19
|
* the rest from `auth.api`; these few are written out, and the type check holds each to the path
|
|
20
20
|
* the library declares, so a renamed endpoint fails to compile.
|
|
21
21
|
*/
|
|
22
22
|
export const CORE_AUTH_PATHS: CorePaths<
|
|
23
23
|
| 'callbackOAuth'
|
|
24
|
+
| 'deleteUser'
|
|
25
|
+
| 'deleteUserCallback'
|
|
24
26
|
| 'requestPasswordReset'
|
|
25
27
|
| 'sendVerificationEmail'
|
|
26
28
|
| 'signInEmail'
|
|
@@ -28,6 +30,8 @@ export const CORE_AUTH_PATHS: CorePaths<
|
|
|
28
30
|
| 'verifyEmail'
|
|
29
31
|
> = {
|
|
30
32
|
callbackOAuth: '/callback/:id',
|
|
33
|
+
deleteUser: '/delete-user',
|
|
34
|
+
deleteUserCallback: '/delete-user/callback',
|
|
31
35
|
requestPasswordReset: '/request-password-reset',
|
|
32
36
|
sendVerificationEmail: '/send-verification-email',
|
|
33
37
|
signInEmail: '/sign-in/email',
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import { createEnrollmentService, type EnrollmentService } from '#cloud/admin/enrollment/service'
|
|
2
|
+
import { accountDeletionOptions } from '#cloud/server/account/deletion'
|
|
3
|
+
import { createTermsService } from '#cloud/server/account/terms'
|
|
2
4
|
import type { CloudServerConfig } from '#cloud/server/config'
|
|
3
5
|
import type { CloudDatabase } from '#cloud/server/db'
|
|
4
6
|
import { createUserPictures, providerPictures } from '#cloud/server/pictures'
|
|
@@ -86,6 +88,7 @@ export function createBetterAuthAdapter(
|
|
|
86
88
|
): CloudAuthAdapter {
|
|
87
89
|
const authenticationEmail = runtime.email
|
|
88
90
|
const assurance = createMFAAssuranceService(database, config)
|
|
91
|
+
const terms = createTermsService(database, config)
|
|
89
92
|
const activity = createSignInActivity(database, authenticationEmail)
|
|
90
93
|
// A new address is confirmed through a link sent to it, so changing one needs email delivery.
|
|
91
94
|
const emailChangeAvailable = Boolean(config.emailPasswordEnabled && authenticationEmail)
|
|
@@ -115,12 +118,16 @@ export function createBetterAuthAdapter(
|
|
|
115
118
|
baseURL: config.publicURL,
|
|
116
119
|
basePath: AUTH_BASE_PATH,
|
|
117
120
|
// Clients never reach Better Auth's own administration, which `/api/admin` replaces with MFA,
|
|
118
|
-
// origin, last-administrator, and audit checks, nor the
|
|
121
|
+
// origin, last-administrator, and audit checks, nor the endpoints Cloud's policy manages
|
|
119
122
|
// through its account routes; the server still calls them itself.
|
|
120
123
|
disabledPaths: [
|
|
121
124
|
...Object.values(administration.endpoints).map((endpoint) => endpoint.path),
|
|
122
125
|
passkeys.endpoints.deletePasskey.path,
|
|
123
|
-
twoStep.endpoints.disableTwoFactor.path
|
|
126
|
+
twoStep.endpoints.disableTwoFactor.path,
|
|
127
|
+
// Accounts are deleted through `/api/account/delete`, which an account awaiting approval
|
|
128
|
+
// cannot reach either.
|
|
129
|
+
CORE_AUTH_PATHS.deleteUser,
|
|
130
|
+
CORE_AUTH_PATHS.deleteUserCallback
|
|
124
131
|
],
|
|
125
132
|
secret: config.authSecret,
|
|
126
133
|
database: {
|
|
@@ -224,6 +231,7 @@ export function createBetterAuthAdapter(
|
|
|
224
231
|
: undefined,
|
|
225
232
|
user: {
|
|
226
233
|
changeEmail: { enabled: emailChangeAvailable },
|
|
234
|
+
deleteUser: accountDeletionOptions(database),
|
|
227
235
|
validateUserInfo: ({ source }) => {
|
|
228
236
|
if (source.action === 'create-user' && config.enrollmentMode === 'closed') {
|
|
229
237
|
return { error: 'enrollment_closed', errorDescription: 'Cloud enrollment is closed' }
|
|
@@ -331,8 +339,18 @@ export function createBetterAuthAdapter(
|
|
|
331
339
|
})
|
|
332
340
|
}
|
|
333
341
|
|
|
334
|
-
/**
|
|
342
|
+
/**
|
|
343
|
+
* The signed-in person while their account may use the server: not while it awaits approval, nor
|
|
344
|
+
* before it accepted the deployment's current terms when those are required.
|
|
345
|
+
*/
|
|
335
346
|
async function resolveSession(headers: Headers) {
|
|
347
|
+
const identity = await resolveAccountSession(headers)
|
|
348
|
+
if (!identity || !(await terms.hasAccepted(identity.userId))) return null
|
|
349
|
+
return identity
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
/** The signed-in person while their account is approved, before or after accepting the terms. */
|
|
353
|
+
async function resolveAccountSession(headers: Headers) {
|
|
336
354
|
const identity = await resolveIdentity(headers)
|
|
337
355
|
if (!identity) return null
|
|
338
356
|
if (config.enrollmentMode === 'approval' && !(await enrollment.isApproved(identity.email))) {
|
|
@@ -391,6 +409,7 @@ export function createBetterAuthAdapter(
|
|
|
391
409
|
},
|
|
392
410
|
resolveIdentity,
|
|
393
411
|
resolveSession,
|
|
412
|
+
resolveAccountSession,
|
|
394
413
|
async listAuthenticationMethods(headers) {
|
|
395
414
|
const accounts = await auth.api.listUserAccounts({ headers })
|
|
396
415
|
return accounts.map((account) => ({
|
|
@@ -428,6 +447,14 @@ export function createBetterAuthAdapter(
|
|
|
428
447
|
})
|
|
429
448
|
return response.url
|
|
430
449
|
},
|
|
450
|
+
async deleteAccount(headers, password) {
|
|
451
|
+
const { headers: answer } = await auth.api.deleteUser({
|
|
452
|
+
headers,
|
|
453
|
+
body: password ? { password } : {},
|
|
454
|
+
returnHeaders: true
|
|
455
|
+
})
|
|
456
|
+
return answer
|
|
457
|
+
},
|
|
431
458
|
async unlinkAuthenticationMethod(headers, methodId) {
|
|
432
459
|
await auth.api.unlinkAccount({ headers, body: { accountId: methodId } })
|
|
433
460
|
},
|
package/src/server/auth/index.ts
CHANGED
|
@@ -14,4 +14,13 @@ export {
|
|
|
14
14
|
type CloudSessionResolver
|
|
15
15
|
} from './session'
|
|
16
16
|
export type { CloudIdentity } from './adapter'
|
|
17
|
-
export {
|
|
17
|
+
export {
|
|
18
|
+
accessControl,
|
|
19
|
+
accessStatements,
|
|
20
|
+
documentRoleCan,
|
|
21
|
+
documentRoles,
|
|
22
|
+
workspaceRoleCan,
|
|
23
|
+
workspaceRoles,
|
|
24
|
+
type AccessRequest,
|
|
25
|
+
type DocumentRole
|
|
26
|
+
} from './access-control'
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { CloudServerConfig } from '#cloud/server/config'
|
|
2
2
|
import type { CloudDatabase } from '#cloud/server/db'
|
|
3
|
+
import type { CloudErrorReporter } from '#cloud/server/errors'
|
|
3
4
|
import type { ObjectStore } from '#cloud/server/objects'
|
|
4
5
|
import type { CloudPolicy } from '#cloud/server/policy/policy'
|
|
5
6
|
import { createRateLimitCleanupService } from '#cloud/server/rate-limit/cleanup'
|
|
@@ -10,19 +11,24 @@ import { createRevisionCompactionService } from './revisions'
|
|
|
10
11
|
import { createUploadCleanupService } from './uploads'
|
|
11
12
|
import type { CleanupPassOptions, CleanupServices } from './worker'
|
|
12
13
|
|
|
13
|
-
/**
|
|
14
|
+
/**
|
|
15
|
+
* Every cleanup service, over a deployment's database and bucket. Each reports what it couldn't
|
|
16
|
+
* clean through `reportError`, where a deployment tracks errors, and carries on with the rest.
|
|
17
|
+
*/
|
|
14
18
|
export function createCleanupServices(
|
|
15
19
|
config: Pick<CloudServerConfig, 'deployment'>,
|
|
16
20
|
database: Kysely<CloudDatabase>,
|
|
17
21
|
objects: ObjectStore,
|
|
18
|
-
policy: CloudPolicy
|
|
22
|
+
policy: CloudPolicy,
|
|
23
|
+
reportError?: CloudErrorReporter
|
|
19
24
|
): CleanupServices {
|
|
20
25
|
return {
|
|
21
|
-
uploads: createUploadCleanupService(database, objects),
|
|
22
|
-
documents: createDocumentCleanupService(database, objects),
|
|
26
|
+
uploads: createUploadCleanupService(database, objects, reportError),
|
|
27
|
+
documents: createDocumentCleanupService(database, objects, { reportError }),
|
|
23
28
|
revisions: createRevisionCompactionService(database, objects, {
|
|
24
29
|
policy,
|
|
25
|
-
deploymentMode: config.deployment
|
|
30
|
+
deploymentMode: config.deployment,
|
|
31
|
+
reportError
|
|
26
32
|
}),
|
|
27
33
|
rateLimits: createRateLimitCleanupService(database)
|
|
28
34
|
}
|
|
@@ -33,6 +39,7 @@ export function cleanupPassOptions(config: CloudServerConfig): CleanupPassOption
|
|
|
33
39
|
return {
|
|
34
40
|
batchSize: config.cleanupBatchSize,
|
|
35
41
|
documentRetentionMs: config.documentRetentionMs,
|
|
42
|
+
documentPurgeGraceMs: config.documentPurgeGraceMs,
|
|
36
43
|
leaseDurationMs: config.cleanupLeaseDurationMs
|
|
37
44
|
}
|
|
38
45
|
}
|