@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.
- package/README.md +3 -2
- package/dist/bin/server.mjs +1 -1
- package/dist/bin/server.mjs.map +1 -1
- package/dist/bin/{ai-relay.mjs → services.mjs} +9 -9
- package/dist/bin/services.mjs.map +1 -0
- package/dist/client.d.ts +525 -66
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +1257 -654
- package/dist/client.js.map +1 -1
- package/dist/contract.d.ts +2 -2
- package/dist/contract.js +2 -2
- package/dist/contract2.js +1028 -481
- package/dist/contract2.js.map +1 -1
- package/dist/email.d.ts +1780 -31
- package/dist/email.d.ts.map +1 -1
- package/dist/email.js +3556 -325
- package/dist/email.js.map +1 -1
- package/dist/errors.d.ts +2 -0
- package/dist/errors.js +48 -0
- package/dist/errors.js.map +1 -0
- package/dist/index.d.ts +929 -72
- package/dist/index.d.ts.map +1 -1
- package/dist/index2.d.ts +35 -0
- package/dist/index2.d.ts.map +1 -0
- package/dist/listen.mjs +802 -927
- package/dist/listen.mjs.map +1 -1
- package/dist/runtime-cloudflare.d.ts +89 -0
- package/dist/runtime-cloudflare.d.ts.map +1 -0
- package/dist/runtime-cloudflare.js +15667 -0
- package/dist/runtime-cloudflare.js.map +1 -0
- package/dist/runtime-node.d.mts +7166 -3101
- 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 +6525 -2205
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +12500 -7613
- package/dist/server.js.map +1 -1
- package/dist/server.mjs +8625 -2878
- package/dist/server.mjs.map +1 -1
- package/dist/server2.mjs +101 -79
- package/dist/server2.mjs.map +1 -1
- package/package.json +27 -9
- package/src/admin/api/routes.ts +59 -0
- package/src/admin/audit/service.ts +27 -8
- package/src/admin/documents/service.ts +431 -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 +153 -0
- package/src/admin/schema.ts +6 -0
- package/src/client/api.ts +28 -461
- package/src/client/auth/client.ts +22 -3
- package/src/client/auth/navigation.ts +6 -5
- package/src/client/billing.ts +80 -0
- package/src/client/community.ts +40 -0
- package/src/client/discovery.ts +35 -9
- package/src/client/documents.ts +160 -0
- package/src/client/index.ts +14 -7
- package/src/client/portal/account.ts +79 -2
- package/src/client/portal/administration.ts +56 -0
- package/src/client/portal/request.ts +2 -0
- package/src/client/response.ts +21 -0
- package/src/client/schema.ts +8 -0
- package/src/client/services.ts +118 -0
- package/src/client/sharing.ts +262 -0
- package/src/client/versions.ts +104 -0
- package/src/contract/account.ts +108 -2
- package/src/contract/admin/index.ts +67 -3
- package/src/contract/billing.ts +166 -0
- package/src/contract/collaboration.ts +11 -1
- package/src/contract/community.ts +60 -0
- package/src/contract/discovery.ts +83 -4
- package/src/contract/documents.ts +27 -0
- package/src/contract/entitlements.ts +12 -2
- package/src/contract/index.ts +114 -39
- package/src/contract/links.ts +57 -4
- package/src/contract/locale.ts +27 -0
- package/src/contract/portal.ts +12 -1
- package/src/contract/relay.ts +6 -0
- package/src/contract/reports.ts +42 -0
- package/src/contract/routes.ts +10 -0
- package/src/contract/services.ts +235 -0
- package/src/contract/sharing.ts +3 -9
- package/src/email/i18n.ts +174 -0
- package/src/email/index.ts +13 -2
- package/src/email/locales/ar.json +141 -0
- package/src/email/locales/de.json +141 -0
- package/src/email/locales/es.json +141 -0
- package/src/email/locales/fr.json +141 -0
- package/src/email/locales/it.json +141 -0
- package/src/email/locales/ja.json +141 -0
- package/src/email/locales/pl.json +141 -0
- package/src/email/locales/pt-br.json +141 -0
- package/src/email/locales/ru.json +141 -0
- package/src/email/locales/zh-cn.json +141 -0
- package/src/email/messages.ts +200 -0
- package/src/email/render.ts +138 -246
- package/src/email/samples.ts +115 -0
- package/src/email/schema.ts +79 -5
- package/src/email/templates/BrandEmail.vue +54 -0
- package/src/email/templates/DocumentBlocked.vue +45 -0
- package/src/email/templates/DocumentInvitation.vue +24 -0
- package/src/email/templates/DocumentReport.vue +32 -0
- package/src/email/templates/DocumentReportDecided.vue +36 -0
- package/src/email/templates/DocumentReportReceived.vue +18 -0
- package/src/email/templates/DocumentRestored.vue +24 -0
- package/src/email/templates/EmailChangeRequested.vue +24 -0
- package/src/email/templates/EmailRoot.vue +19 -0
- package/src/email/templates/EmailText.vue +9 -0
- package/src/email/templates/EmailVerification.vue +38 -0
- package/src/email/templates/EnrollmentNotification.vue +24 -0
- package/src/email/templates/EnrollmentUpdate.vue +52 -0
- package/src/email/templates/NewSignIn.vue +37 -0
- package/src/email/templates/PasswordChanged.vue +22 -0
- package/src/email/templates/PasswordReset.vue +23 -0
- package/src/email/templates/StorageLimitReached.vue +28 -0
- package/src/email/templates/TwoStepChanged.vue +32 -0
- package/src/email/templates/WaitlistConfirmation.vue +29 -0
- package/src/email/templates/WorkspaceInvitation.vue +28 -0
- package/src/email/templates/brand.ts +9 -61
- package/src/email/templates/localization.ts +17 -0
- package/src/errors/index.ts +6 -0
- package/src/errors/posthog.ts +80 -0
- package/src/global.d.ts +7 -0
- 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 +69 -15
- package/src/runtime/cloudflare/tsconfig.json +2 -1
- package/src/runtime/cloudflare/worker.ts +46 -13
- package/src/runtime/node/application.ts +5 -3
- package/src/runtime/node/bootstrap.ts +15 -4
- package/src/runtime/node/cleanup.ts +20 -3
- package/src/runtime/node/email/transport.ts +13 -10
- package/src/runtime/node/entitlements/main.ts +14 -11
- package/src/runtime/node/index.ts +1 -1
- package/src/runtime/node/main.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 +50 -16
- package/src/runtime/node/{ai-relay → services}/main.ts +7 -7
- 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 -30
- package/src/runtime/s3/objects.ts +41 -1
- package/src/runtime/site/community.ts +101 -0
- package/src/runtime/site/server.ts +49 -6
- package/src/server/account/actions.ts +5 -0
- package/src/server/account/deletion.ts +304 -0
- package/src/server/account/routes.ts +281 -206
- package/src/server/account/terms.ts +42 -0
- package/src/server/account/tokens.ts +57 -0
- package/src/server/api/router.ts +32 -5
- package/src/server/api/types.ts +2 -0
- package/src/server/app/checks.ts +84 -0
- package/src/server/app/editors.ts +20 -0
- package/src/server/app/index.ts +128 -0
- package/src/server/app/indexing.ts +40 -0
- package/src/server/app/limiters.ts +53 -0
- package/src/server/app/routes.ts +114 -0
- package/src/server/app/services.ts +185 -0
- package/src/server/auth/access-control.ts +63 -0
- package/src/server/auth/access-tokens.ts +62 -0
- package/src/server/auth/adapter.ts +32 -1
- package/src/server/auth/email.ts +4 -1
- package/src/server/auth/endpoints.ts +5 -1
- package/src/server/auth/enrollment.ts +116 -0
- package/src/server/auth/factory.ts +116 -132
- package/src/server/auth/index.ts +10 -1
- package/src/server/auth/logger.ts +23 -0
- package/src/server/auth/mfa-assurance.ts +51 -0
- package/src/server/auth/passwords.ts +43 -0
- package/src/server/auth/session.ts +2 -0
- package/src/server/billing/index.ts +6 -0
- package/src/server/billing/routes.ts +27 -0
- package/src/server/billing/tokens.ts +37 -0
- package/src/server/cleanup/configured.ts +27 -7
- 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 +15 -3
- 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 +77 -122
- package/src/server/collaboration/relay/log.ts +5 -2
- package/src/server/collaboration/relay/room.ts +154 -0
- package/src/server/collaboration/service.ts +48 -33
- package/src/server/community/index.ts +2 -0
- package/src/server/community/routes.ts +93 -0
- package/src/server/community/service.ts +134 -0
- package/src/server/config/deployment.ts +41 -9
- package/src/server/config/index.ts +1 -1
- package/src/server/config/public.ts +11 -4
- package/src/server/config/schema.ts +91 -277
- package/src/server/config/toml/schema.ts +307 -0
- package/src/server/db/expressions.ts +15 -1
- package/src/server/db/index.ts +1 -0
- package/src/server/db/migrate.ts +46 -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/009_access_tokens.ts +47 -0
- package/src/server/db/migrations/010_storage_limit_notices.ts +50 -0
- package/src/server/db/migrations/011_account_ids.ts +30 -0
- package/src/server/db/migrations/012_email_locales.ts +34 -0
- package/src/server/db/migrations/013_document_block_emails.ts +40 -0
- package/src/server/db/migrations/014_report_replies.ts +28 -0
- package/src/server/db/migrations/schema.ts +96 -0
- package/src/server/db/tables.ts +82 -4
- package/src/server/db/users.ts +22 -0
- 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/index.ts +1 -1
- package/src/server/documents/limits.ts +14 -8
- 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 +30 -406
- package/src/server/documents/summary.ts +1 -0
- package/src/server/documents/trash.ts +203 -0
- package/src/server/documents/uploads.ts +450 -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 +94 -28
- package/src/server/email/invitations.ts +1 -0
- package/src/server/email/service.ts +31 -4
- package/src/server/email/types.ts +12 -0
- package/src/server/errors/index.ts +51 -16
- package/src/server/index.ts +52 -16
- 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/invitations/types.ts +5 -1
- package/src/server/logging.ts +76 -0
- package/src/server/objects/types.ts +5 -0
- package/src/server/pictures/service.ts +2 -1
- package/src/server/policy/configured.ts +9 -3
- package/src/server/policy/database.ts +52 -27
- package/src/server/policy/index.ts +2 -1
- package/src/server/policy/keys.ts +5 -2
- package/src/server/policy/policy.ts +40 -12
- package/src/server/policy/schema.ts +2 -2
- package/src/server/policy/service.ts +78 -56
- package/src/server/policy/static.ts +5 -5
- package/src/server/policy/storage.ts +33 -0
- package/src/server/policy/workspace.ts +41 -0
- package/src/server/quota/index.ts +6 -0
- package/src/server/quota/notices.ts +121 -0
- package/src/server/quota/reconcile.ts +2 -0
- package/src/server/quota/storage.ts +74 -31
- package/src/server/rate-limit/cleanup.ts +17 -5
- package/src/server/rate-limit/middleware.ts +6 -2
- package/src/server/reports/index.ts +9 -0
- package/src/server/reports/replies.ts +55 -0
- package/src/server/reports/routes.ts +39 -0
- package/src/server/reports/service.ts +145 -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 -23
- package/src/server/sharing/grants/service.ts +11 -18
- package/src/server/sharing/http.ts +4 -0
- package/src/server/sharing/invitations/service.ts +35 -15
- 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 +4 -0
- package/src/server/workspaces/index.ts +1 -0
- package/src/server/workspaces/members.ts +91 -52
- package/src/server/workspaces/repository.ts +2 -1
- package/src/server/workspaces/routes.ts +4 -0
- package/src/{ai-relay → services}/app.ts +46 -44
- package/src/{ai-relay → services}/config.ts +26 -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 +35 -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/client/ai.ts +0 -96
- package/src/contract/ai.ts +0 -150
- package/src/email/templates/document-invitation.ts +0 -35
- package/src/email/templates/enrollment.ts +0 -27
- package/src/email/templates/layout.ts +0 -18
- 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/app.ts +0 -379
- 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
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
import {
|
|
2
2
|
CLOUD_PROTOCOL_MAX_UPLOAD_BYTES,
|
|
3
3
|
cloudEditorVersionSchema,
|
|
4
|
-
RELAY_MINIMUM_MESSAGE_BYTES
|
|
4
|
+
RELAY_MINIMUM_MESSAGE_BYTES,
|
|
5
|
+
sendsTokenSafely
|
|
5
6
|
} from '#cloud/contract'
|
|
6
|
-
import { staticEntitlementsSchema
|
|
7
|
+
import { staticEntitlementsSchema } from '#cloud/server/policy/schema'
|
|
7
8
|
import * as v from 'valibot'
|
|
8
9
|
|
|
9
10
|
import {
|
|
@@ -31,10 +32,21 @@ const websocketURLSchema = v.pipe(
|
|
|
31
32
|
|
|
32
33
|
const optionalTextSchema = v.optional(v.pipe(v.string(), v.trim(), v.minLength(1)))
|
|
33
34
|
|
|
35
|
+
/**
|
|
36
|
+
* A prefix deleted files move under: one lowercase path segment and a slash, which no object key
|
|
37
|
+
* the server makes starts with (they start with `documents/`).
|
|
38
|
+
*/
|
|
39
|
+
export const deletedPrefixSchema = v.pipe(
|
|
40
|
+
v.string(),
|
|
41
|
+
v.regex(/^[a-z0-9][a-z0-9-]*\/$/),
|
|
42
|
+
v.check((prefix) => prefix !== 'documents/', 'deleted_prefix cannot be documents/')
|
|
43
|
+
)
|
|
44
|
+
|
|
34
45
|
const rawCloudServerConfigSchema = v.object({
|
|
35
46
|
deployment: v.picklist(['official', 'self-hosted']),
|
|
36
47
|
publicURL: httpURLSchema,
|
|
37
48
|
listingMinimumEditorVersion: v.optional(cloudEditorVersionSchema),
|
|
49
|
+
minimumEditorVersion: v.optional(cloudEditorVersionSchema),
|
|
38
50
|
relayURL: v.optional(websocketURLSchema),
|
|
39
51
|
technicalLimits: v.optional(
|
|
40
52
|
v.object({
|
|
@@ -58,6 +70,8 @@ const rawCloudServerConfigSchema = v.object({
|
|
|
58
70
|
}
|
|
59
71
|
),
|
|
60
72
|
staticEntitlements: v.optional(staticEntitlementsSchema),
|
|
73
|
+
/** With database entitlements, what an account without stored ones takes, value by value. */
|
|
74
|
+
defaultEntitlements: v.optional(staticEntitlementsSchema),
|
|
61
75
|
databaseURL: v.pipe(v.string(), v.url()),
|
|
62
76
|
authSecret: v.pipe(v.string(), v.minLength(32)),
|
|
63
77
|
trustedOrigins: v.optional(v.array(httpURLSchema), []),
|
|
@@ -111,6 +125,8 @@ const rawCloudServerConfigSchema = v.object({
|
|
|
111
125
|
s3ChecksumVerification: v.optional(v.picklist(['native', 'metadata']), 'native'),
|
|
112
126
|
s3ServerSideEncryption: v.optional(v.picklist(['AES256', 'aws:kms'])),
|
|
113
127
|
s3KmsKeyId: optionalTextSchema,
|
|
128
|
+
/** Where a deleted file is kept until the bucket's lifecycle rule expires it; see `deleted_prefix`. */
|
|
129
|
+
s3DeletedPrefix: v.optional(deletedPrefixSchema),
|
|
114
130
|
smtpHost: optionalTextSchema,
|
|
115
131
|
smtpPort: v.optional(v.pipe(v.number(), v.integer(), v.minValue(1), v.maxValue(65_535))),
|
|
116
132
|
smtpSecure: v.optional(v.boolean()),
|
|
@@ -136,17 +152,54 @@ const rawCloudServerConfigSchema = v.object({
|
|
|
136
152
|
v.pipe(v.number(), v.integer(), v.minValue(0)),
|
|
137
153
|
30 * 24 * 60 * 60_000
|
|
138
154
|
),
|
|
139
|
-
/**
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
155
|
+
/**
|
|
156
|
+
* How long a document deleted forever keeps its files and rows, out of everyone's sight, so a
|
|
157
|
+
* server administrator can still bring it back; 0 destroys it at once.
|
|
158
|
+
*/
|
|
159
|
+
documentPurgeGraceMs: v.optional(
|
|
160
|
+
v.pipe(v.number(), v.integer(), v.minValue(0)),
|
|
161
|
+
7 * 24 * 60 * 60_000
|
|
162
|
+
),
|
|
163
|
+
/** The OpenPencil services editors reach with tokens this server signs; see `src/contract/services.ts`. */
|
|
164
|
+
servicesEndpoint: v.optional(httpURLSchema),
|
|
165
|
+
/** The PKCS #8 PEM of the P-256 key that signs service tokens. */
|
|
166
|
+
servicesSigningKey: optionalTextSchema,
|
|
167
|
+
servicesTokenLifetimeSeconds: v.optional(
|
|
144
168
|
v.pipe(v.number(), v.integer(), v.minValue(60), v.maxValue(60 * 60)),
|
|
145
169
|
10 * 60
|
|
146
170
|
),
|
|
147
|
-
|
|
171
|
+
/** The billing service accounts buy plans and credits from, which discovery advertises. */
|
|
172
|
+
billingEndpoint: v.optional(httpURLSchema),
|
|
148
173
|
/** The bearer token services such as billing present to the internal API. */
|
|
149
174
|
internalServiceToken: v.optional(v.pipe(v.string(), v.minLength(32))),
|
|
175
|
+
/**
|
|
176
|
+
* The operator's own terms, privacy policy, abuse contact, and minimum age; without it the
|
|
177
|
+
* server shows none. With `requireAcceptance`, an account uses the server only once it accepted
|
|
178
|
+
* `termsVersion`.
|
|
179
|
+
*/
|
|
180
|
+
legal: v.optional(
|
|
181
|
+
v.object({
|
|
182
|
+
termsURL: v.optional(httpURLSchema),
|
|
183
|
+
privacyURL: v.optional(httpURLSchema),
|
|
184
|
+
termsVersion: optionalTextSchema,
|
|
185
|
+
requireAcceptance: v.boolean(),
|
|
186
|
+
abuseEmail: v.optional(v.pipe(v.string(), v.email())),
|
|
187
|
+
minimumAge: v.optional(v.pipe(v.number(), v.integer(), v.minValue(13), v.maxValue(21)))
|
|
188
|
+
})
|
|
189
|
+
),
|
|
190
|
+
/**
|
|
191
|
+
* The workspace whose documents anyone may open read-only, without signing in or a link: the
|
|
192
|
+
* deployment's community gallery. Without it the server has none.
|
|
193
|
+
*/
|
|
194
|
+
community: v.optional(v.object({ workspaceId: v.pipe(v.string(), v.uuid()) })),
|
|
195
|
+
/** How a self-hosted server names itself on its public pages. */
|
|
196
|
+
branding: v.optional(
|
|
197
|
+
v.object({
|
|
198
|
+
name: v.optional(v.pipe(v.string(), v.trim(), v.minLength(1), v.maxLength(80))),
|
|
199
|
+
logoURL: v.optional(httpURLSchema),
|
|
200
|
+
helpURL: v.optional(httpURLSchema)
|
|
201
|
+
})
|
|
202
|
+
),
|
|
150
203
|
/** Where server errors are reported; without it the server reports nothing. */
|
|
151
204
|
errorTracking: v.optional(
|
|
152
205
|
v.object({
|
|
@@ -189,6 +242,9 @@ function validateAuthenticationConfig(config: CloudServerConfig): void {
|
|
|
189
242
|
if (config.deploymentAdminMFARequired && !config.totpEnabled && !config.passkeysEnabled) {
|
|
190
243
|
throw new CloudConfigError('Deployment administrator MFA requires TOTP or passkeys')
|
|
191
244
|
}
|
|
245
|
+
if (config.deployment === 'official' && !config.deploymentAdminMFARequired) {
|
|
246
|
+
throw new CloudConfigError('An official deployment requires MFA for deployment administrators')
|
|
247
|
+
}
|
|
192
248
|
if (config.recoveryCodesEnabled && !config.totpEnabled) {
|
|
193
249
|
throw new CloudConfigError('MFA recovery codes require TOTP')
|
|
194
250
|
}
|
|
@@ -230,18 +286,37 @@ function validateEmailConfig(config: CloudServerConfig): void {
|
|
|
230
286
|
}
|
|
231
287
|
|
|
232
288
|
function validateServiceConfig(config: CloudServerConfig): void {
|
|
233
|
-
requireTogether(config, '
|
|
289
|
+
requireTogether(config, 'Services', ['servicesEndpoint', 'servicesSigningKey'])
|
|
290
|
+
// Billing tokens are signed with the services' key, and billing sets plans through the
|
|
291
|
+
// internal API, which static entitlements would hide.
|
|
292
|
+
if (config.billingEndpoint && !config.servicesSigningKey) {
|
|
293
|
+
throw new CloudConfigError('Billing needs the services signing key to sign its tokens')
|
|
294
|
+
}
|
|
295
|
+
if (config.billingEndpoint && !config.internalServiceToken) {
|
|
296
|
+
throw new CloudConfigError('Billing needs the internal API to set the plans it sells')
|
|
297
|
+
}
|
|
234
298
|
if (config.internalServiceToken && config.staticEntitlements) {
|
|
235
299
|
throw new CloudConfigError(
|
|
236
300
|
'The internal API writes database entitlements, which static entitlements would hide'
|
|
237
301
|
)
|
|
238
302
|
}
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
config.
|
|
242
|
-
|
|
243
|
-
) {
|
|
244
|
-
|
|
303
|
+
// Editors send these endpoints a bearer token, which must not cross the network in the clear.
|
|
304
|
+
for (const [name, endpoint] of [
|
|
305
|
+
['services', config.servicesEndpoint],
|
|
306
|
+
['billing', config.billingEndpoint]
|
|
307
|
+
] as const) {
|
|
308
|
+
if (endpoint && !sendsTokenSafely(endpoint)) {
|
|
309
|
+
throw new CloudConfigError(
|
|
310
|
+
`The ${name} endpoint must use HTTPS, or HTTP only to 127.0.0.1 or [::1] for development`
|
|
311
|
+
)
|
|
312
|
+
}
|
|
313
|
+
}
|
|
314
|
+
}
|
|
315
|
+
|
|
316
|
+
function validateLegalConfig(config: CloudServerConfig): void {
|
|
317
|
+
const legal = config.legal
|
|
318
|
+
if (legal?.requireAcceptance && !(legal.termsURL && legal.termsVersion)) {
|
|
319
|
+
throw new CloudConfigError('[legal] require_acceptance needs terms_url and terms_version')
|
|
245
320
|
}
|
|
246
321
|
}
|
|
247
322
|
|
|
@@ -268,267 +343,6 @@ export function parseCloudServerConfig(input: unknown): CloudServerConfig {
|
|
|
268
343
|
validateEmailConfig(config)
|
|
269
344
|
validateServiceConfig(config)
|
|
270
345
|
validateObjectStorageConfig(config)
|
|
346
|
+
validateLegalConfig(config)
|
|
271
347
|
return config
|
|
272
348
|
}
|
|
273
|
-
|
|
274
|
-
/** PostHog's US Cloud ingestion host. */
|
|
275
|
-
const POSTHOG_DEFAULT_HOST = 'https://us.i.posthog.com'
|
|
276
|
-
|
|
277
|
-
const DEFAULT_SECRET_NAMES = {
|
|
278
|
-
databaseURL: 'DATABASE_URL',
|
|
279
|
-
authSecret: 'BETTER_AUTH_SECRET',
|
|
280
|
-
googleClientId: 'GOOGLE_CLIENT_ID',
|
|
281
|
-
googleClientSecret: 'GOOGLE_CLIENT_SECRET',
|
|
282
|
-
applePrivateKey: 'APPLE_PRIVATE_KEY',
|
|
283
|
-
s3AccessKeyId: 'S3_ACCESS_KEY_ID',
|
|
284
|
-
s3SecretAccessKey: 'S3_SECRET_ACCESS_KEY',
|
|
285
|
-
s3SessionToken: 'S3_SESSION_TOKEN',
|
|
286
|
-
smtpUser: 'OPENPENCIL_CLOUD_SMTP_USER',
|
|
287
|
-
smtpPassword: 'OPENPENCIL_CLOUD_SMTP_PASSWORD',
|
|
288
|
-
turnstileSecretKey: 'TURNSTILE_SECRET_KEY',
|
|
289
|
-
aiSigningKey: 'OPENPENCIL_CLOUD_AI_SIGNING_KEY',
|
|
290
|
-
internalServiceToken: 'OPENPENCIL_CLOUD_SERVICE_TOKEN',
|
|
291
|
-
posthogProjectAPIKey: 'POSTHOG_PROJECT_API_KEY'
|
|
292
|
-
} as const
|
|
293
|
-
|
|
294
|
-
const urlSchema = v.pipe(v.string(), v.url())
|
|
295
|
-
const textSchema = v.pipe(v.string(), v.trim(), v.minLength(1))
|
|
296
|
-
const positiveIntegerSchema = v.pipe(v.number(), v.integer(), v.minValue(1))
|
|
297
|
-
const secretReferenceSchema = v.strictObject({ from_env: textSchema })
|
|
298
|
-
const configurableTextSchema = v.union([textSchema, secretReferenceSchema])
|
|
299
|
-
const defaultReference = (name: string) => v.optional(secretReferenceSchema, { from_env: name })
|
|
300
|
-
|
|
301
|
-
const providerSchema = v.strictObject({
|
|
302
|
-
google: v.optional(
|
|
303
|
-
v.strictObject({
|
|
304
|
-
client_id: v.optional(configurableTextSchema, {
|
|
305
|
-
from_env: DEFAULT_SECRET_NAMES.googleClientId
|
|
306
|
-
}),
|
|
307
|
-
client_secret: defaultReference(DEFAULT_SECRET_NAMES.googleClientSecret)
|
|
308
|
-
})
|
|
309
|
-
),
|
|
310
|
-
apple: v.optional(
|
|
311
|
-
v.strictObject({
|
|
312
|
-
client_id: textSchema,
|
|
313
|
-
team_id: textSchema,
|
|
314
|
-
key_id: textSchema,
|
|
315
|
-
private_key: defaultReference(DEFAULT_SECRET_NAMES.applePrivateKey),
|
|
316
|
-
app_bundle_identifier: v.optional(textSchema)
|
|
317
|
-
})
|
|
318
|
-
)
|
|
319
|
-
})
|
|
320
|
-
|
|
321
|
-
const emailSchema = v.optional(
|
|
322
|
-
v.variant('transport', [
|
|
323
|
-
v.strictObject({ transport: v.literal('none') }),
|
|
324
|
-
v.strictObject({
|
|
325
|
-
transport: v.literal('smtp'),
|
|
326
|
-
from: textSchema,
|
|
327
|
-
smtp: v.strictObject({
|
|
328
|
-
host: textSchema,
|
|
329
|
-
port: positiveIntegerSchema,
|
|
330
|
-
secure: v.optional(v.boolean()),
|
|
331
|
-
user: v.optional(secretReferenceSchema, {
|
|
332
|
-
from_env: DEFAULT_SECRET_NAMES.smtpUser
|
|
333
|
-
}),
|
|
334
|
-
password: v.optional(secretReferenceSchema, {
|
|
335
|
-
from_env: DEFAULT_SECRET_NAMES.smtpPassword
|
|
336
|
-
})
|
|
337
|
-
})
|
|
338
|
-
}),
|
|
339
|
-
v.strictObject({ transport: v.literal('cloudflare'), from: textSchema })
|
|
340
|
-
]),
|
|
341
|
-
{ transport: 'none' }
|
|
342
|
-
)
|
|
343
|
-
|
|
344
|
-
/**
|
|
345
|
-
* Every table is strict: a key the schema doesn't know, such as one renamed since, stops startup
|
|
346
|
-
* instead of leaving its setting at a default the operator never chose.
|
|
347
|
-
*/
|
|
348
|
-
export const cloudDeploymentConfigSchema = v.strictObject({
|
|
349
|
-
schema_version: v.literal(2),
|
|
350
|
-
deployment: v.strictObject({
|
|
351
|
-
mode: v.picklist(['official', 'self-hosted']),
|
|
352
|
-
public_url: urlSchema,
|
|
353
|
-
indexing: v.optional(v.picklist(['allow', 'deny']), 'deny'),
|
|
354
|
-
trusted_origins: v.optional(v.array(urlSchema), []),
|
|
355
|
-
// The server's editor works with files on this device without signing in to the server.
|
|
356
|
-
local_editor: v.optional(v.boolean(), true),
|
|
357
|
-
listing: v.optional(v.strictObject({ minimum_editor_version: cloudEditorVersionSchema }))
|
|
358
|
-
}),
|
|
359
|
-
database: v.optional(
|
|
360
|
-
v.strictObject({ url: defaultReference(DEFAULT_SECRET_NAMES.databaseURL) }),
|
|
361
|
-
{
|
|
362
|
-
url: { from_env: DEFAULT_SECRET_NAMES.databaseURL }
|
|
363
|
-
}
|
|
364
|
-
),
|
|
365
|
-
authentication: v.strictObject({
|
|
366
|
-
secret: defaultReference(DEFAULT_SECRET_NAMES.authSecret),
|
|
367
|
-
enrollment: v.optional(
|
|
368
|
-
v.strictObject({
|
|
369
|
-
mode: v.optional(v.picklist(['open', 'approval', 'closed']), 'open'),
|
|
370
|
-
notification_emails: v.optional(v.array(v.pipe(v.string(), v.email())), [])
|
|
371
|
-
}),
|
|
372
|
-
{ mode: 'open', notification_emails: [] }
|
|
373
|
-
),
|
|
374
|
-
email_password: v.optional(
|
|
375
|
-
v.strictObject({
|
|
376
|
-
enabled: v.optional(v.boolean(), false),
|
|
377
|
-
sign_up: v.optional(v.boolean(), true),
|
|
378
|
-
minimum_password_length: v.optional(
|
|
379
|
-
v.pipe(v.number(), v.integer(), v.minValue(8), v.maxValue(128)),
|
|
380
|
-
8
|
|
381
|
-
),
|
|
382
|
-
maximum_password_length: v.optional(
|
|
383
|
-
v.pipe(v.number(), v.integer(), v.minValue(15), v.maxValue(128)),
|
|
384
|
-
128
|
|
385
|
-
),
|
|
386
|
-
verification_link_lifetime_minutes: v.optional(positiveIntegerSchema, 60),
|
|
387
|
-
password_reset_link_lifetime_minutes: v.optional(positiveIntegerSchema, 60),
|
|
388
|
-
compromised_password_check: v.optional(v.boolean(), false)
|
|
389
|
-
}),
|
|
390
|
-
{
|
|
391
|
-
enabled: false,
|
|
392
|
-
sign_up: true,
|
|
393
|
-
minimum_password_length: 8,
|
|
394
|
-
maximum_password_length: 128,
|
|
395
|
-
verification_link_lifetime_minutes: 60,
|
|
396
|
-
password_reset_link_lifetime_minutes: 60,
|
|
397
|
-
compromised_password_check: false
|
|
398
|
-
}
|
|
399
|
-
),
|
|
400
|
-
mfa: v.optional(
|
|
401
|
-
v.strictObject({
|
|
402
|
-
required_for_admins: v.optional(v.boolean(), false),
|
|
403
|
-
totp: v.optional(v.boolean(), false),
|
|
404
|
-
recovery_codes: v.optional(v.boolean(), false),
|
|
405
|
-
trusted_device_lifetime_days: v.optional(v.pipe(v.number(), v.integer(), v.minValue(0)), 14)
|
|
406
|
-
}),
|
|
407
|
-
{
|
|
408
|
-
required_for_admins: false,
|
|
409
|
-
totp: false,
|
|
410
|
-
recovery_codes: false,
|
|
411
|
-
trusted_device_lifetime_days: 14
|
|
412
|
-
}
|
|
413
|
-
),
|
|
414
|
-
// Passkeys belong to public_url's host and origin.
|
|
415
|
-
passkeys: v.optional(
|
|
416
|
-
v.strictObject({
|
|
417
|
-
enabled: v.optional(v.boolean(), false),
|
|
418
|
-
rp_name: v.optional(textSchema, 'OpenPencil Cloud')
|
|
419
|
-
}),
|
|
420
|
-
{ enabled: false, rp_name: 'OpenPencil Cloud' }
|
|
421
|
-
),
|
|
422
|
-
captcha: v.optional(
|
|
423
|
-
v.strictObject({
|
|
424
|
-
provider: v.literal('cloudflare-turnstile'),
|
|
425
|
-
site_key: textSchema,
|
|
426
|
-
secret_key: defaultReference(DEFAULT_SECRET_NAMES.turnstileSecretKey),
|
|
427
|
-
allowed_hostnames: v.optional(v.array(textSchema), [])
|
|
428
|
-
})
|
|
429
|
-
),
|
|
430
|
-
trusted_proxies: v.optional(
|
|
431
|
-
v.strictObject({
|
|
432
|
-
headers: v.optional(v.array(textSchema), []),
|
|
433
|
-
addresses: v.optional(v.array(textSchema), [])
|
|
434
|
-
}),
|
|
435
|
-
{ headers: [], addresses: [] }
|
|
436
|
-
),
|
|
437
|
-
providers: v.optional(providerSchema, {})
|
|
438
|
-
}),
|
|
439
|
-
object_storage: v.strictObject({
|
|
440
|
-
endpoint: urlSchema,
|
|
441
|
-
region: textSchema,
|
|
442
|
-
bucket: textSchema,
|
|
443
|
-
credentials: v.optional(
|
|
444
|
-
v.strictObject({
|
|
445
|
-
access_key_id: defaultReference(DEFAULT_SECRET_NAMES.s3AccessKeyId),
|
|
446
|
-
secret_access_key: defaultReference(DEFAULT_SECRET_NAMES.s3SecretAccessKey),
|
|
447
|
-
session_token: v.optional(secretReferenceSchema, {
|
|
448
|
-
from_env: DEFAULT_SECRET_NAMES.s3SessionToken
|
|
449
|
-
})
|
|
450
|
-
}),
|
|
451
|
-
{
|
|
452
|
-
access_key_id: { from_env: DEFAULT_SECRET_NAMES.s3AccessKeyId },
|
|
453
|
-
secret_access_key: { from_env: DEFAULT_SECRET_NAMES.s3SecretAccessKey }
|
|
454
|
-
}
|
|
455
|
-
),
|
|
456
|
-
force_path_style: v.optional(v.boolean(), true),
|
|
457
|
-
checksum_verification: v.optional(v.picklist(['native', 'metadata']), 'native'),
|
|
458
|
-
server_side_encryption: v.optional(v.picklist(['AES256', 'aws:kms'])),
|
|
459
|
-
kms_key_id: v.optional(textSchema),
|
|
460
|
-
maximum_upload_bytes: v.optional(positiveIntegerSchema)
|
|
461
|
-
}),
|
|
462
|
-
collaboration: v.optional(
|
|
463
|
-
v.strictObject({
|
|
464
|
-
relay_url: v.optional(urlSchema),
|
|
465
|
-
maximum_message_bytes: v.optional(positiveIntegerSchema),
|
|
466
|
-
maximum_connections_per_room: v.optional(positiveIntegerSchema)
|
|
467
|
-
}),
|
|
468
|
-
{}
|
|
469
|
-
),
|
|
470
|
-
documents: v.optional(
|
|
471
|
-
v.strictObject({
|
|
472
|
-
retention_days: v.optional(v.pipe(v.number(), v.integer(), v.minValue(0)), 30)
|
|
473
|
-
}),
|
|
474
|
-
{ retention_days: 30 }
|
|
475
|
-
),
|
|
476
|
-
email: emailSchema,
|
|
477
|
-
workers: v.optional(
|
|
478
|
-
v.strictObject({
|
|
479
|
-
email: v.optional(
|
|
480
|
-
v.strictObject({
|
|
481
|
-
batch_size: v.optional(positiveIntegerSchema, 50),
|
|
482
|
-
interval_ms: v.optional(positiveIntegerSchema, 30_000),
|
|
483
|
-
lease_ms: v.optional(positiveIntegerSchema, 300_000),
|
|
484
|
-
maximum_attempts: v.optional(positiveIntegerSchema, 5)
|
|
485
|
-
}),
|
|
486
|
-
{ batch_size: 50, interval_ms: 30_000, lease_ms: 300_000, maximum_attempts: 5 }
|
|
487
|
-
),
|
|
488
|
-
cleanup: v.optional(
|
|
489
|
-
v.strictObject({
|
|
490
|
-
enabled: v.optional(v.boolean(), true),
|
|
491
|
-
batch_size: v.optional(positiveIntegerSchema, 100),
|
|
492
|
-
interval_ms: v.optional(positiveIntegerSchema, 60_000),
|
|
493
|
-
lease_ms: v.optional(positiveIntegerSchema, 300_000)
|
|
494
|
-
}),
|
|
495
|
-
{ enabled: true, batch_size: 100, interval_ms: 60_000, lease_ms: 300_000 }
|
|
496
|
-
)
|
|
497
|
-
})
|
|
498
|
-
),
|
|
499
|
-
entitlements: v.optional(
|
|
500
|
-
v.variant('source', [
|
|
501
|
-
v.strictObject({ source: v.literal('static'), ...staticEntitlementsTOMLSchema.entries }),
|
|
502
|
-
v.strictObject({ source: v.literal('database') })
|
|
503
|
-
])
|
|
504
|
-
),
|
|
505
|
-
ai: v.optional(
|
|
506
|
-
v.strictObject({
|
|
507
|
-
endpoint: urlSchema,
|
|
508
|
-
signing_key: defaultReference(DEFAULT_SECRET_NAMES.aiSigningKey),
|
|
509
|
-
token_lifetime_minutes: v.optional(
|
|
510
|
-
v.pipe(v.number(), v.integer(), v.minValue(1), v.maxValue(60)),
|
|
511
|
-
10
|
|
512
|
-
)
|
|
513
|
-
})
|
|
514
|
-
),
|
|
515
|
-
billing: v.optional(v.strictObject({ portal_url: urlSchema })),
|
|
516
|
-
internal_api: v.optional(
|
|
517
|
-
v.strictObject({ service_token: defaultReference(DEFAULT_SECRET_NAMES.internalServiceToken) })
|
|
518
|
-
),
|
|
519
|
-
/** Optional: reports server errors to PostHog error tracking. Leave it out to send nothing. */
|
|
520
|
-
error_tracking: v.optional(
|
|
521
|
-
v.strictObject({
|
|
522
|
-
provider: v.literal('posthog'),
|
|
523
|
-
host: v.optional(urlSchema, POSTHOG_DEFAULT_HOST),
|
|
524
|
-
project_api_key: v.optional(configurableTextSchema, {
|
|
525
|
-
from_env: DEFAULT_SECRET_NAMES.posthogProjectAPIKey
|
|
526
|
-
})
|
|
527
|
-
})
|
|
528
|
-
)
|
|
529
|
-
})
|
|
530
|
-
|
|
531
|
-
export type CloudDeploymentConfig = v.InferOutput<typeof cloudDeploymentConfigSchema>
|
|
532
|
-
/** Deployment configuration as an operator writes it, before defaults are applied. */
|
|
533
|
-
export type CloudDeploymentInput = v.InferInput<typeof cloudDeploymentConfigSchema>
|
|
534
|
-
export type CloudSecretReference = v.InferOutput<typeof secretReferenceSchema>
|