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

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 (280) hide show
  1. package/README.md +2 -1
  2. package/dist/bin/server.mjs +1 -1
  3. package/dist/bin/server.mjs.map +1 -1
  4. package/dist/bin/services.mjs +1 -1
  5. package/dist/bin/services.mjs.map +1 -1
  6. package/dist/client.d.ts +783 -47
  7. package/dist/client.d.ts.map +1 -1
  8. package/dist/client.js +1651 -382
  9. package/dist/client.js.map +1 -1
  10. package/dist/contract.d.ts +2 -2
  11. package/dist/contract.js +2 -2
  12. package/dist/contract2.js +701 -45
  13. package/dist/contract2.js.map +1 -1
  14. package/dist/email.d.ts +2138 -34
  15. package/dist/email.d.ts.map +1 -1
  16. package/dist/email.js +4343 -306
  17. package/dist/email.js.map +1 -1
  18. package/dist/errors.d.ts +2 -0
  19. package/dist/errors.js +61 -0
  20. package/dist/errors.js.map +1 -0
  21. package/dist/index.d.ts +1338 -44
  22. package/dist/index.d.ts.map +1 -1
  23. package/dist/index2.d.ts +45 -0
  24. package/dist/index2.d.ts.map +1 -0
  25. package/dist/listen.mjs +958 -340
  26. package/dist/listen.mjs.map +1 -1
  27. package/dist/runtime-cloudflare.d.ts +93 -0
  28. package/dist/runtime-cloudflare.d.ts.map +1 -0
  29. package/dist/runtime-cloudflare.js +18032 -0
  30. package/dist/runtime-cloudflare.js.map +1 -0
  31. package/dist/runtime-node.d.mts +12615 -5249
  32. package/dist/runtime-node.d.mts.map +1 -1
  33. package/dist/server.d.ts +17367 -8567
  34. package/dist/server.d.ts.map +1 -1
  35. package/dist/server.js +13587 -7333
  36. package/dist/server.js.map +1 -1
  37. package/dist/server.mjs +11601 -5401
  38. package/dist/server.mjs.map +1 -1
  39. package/dist/server2.mjs +84 -62
  40. package/dist/server2.mjs.map +1 -1
  41. package/package.json +31 -5
  42. package/src/admin/api/routes.ts +263 -190
  43. package/src/admin/audit/service.ts +11 -3
  44. package/src/admin/bootstrap.ts +86 -0
  45. package/src/admin/documents/service.ts +195 -10
  46. package/src/admin/email/service.ts +2 -1
  47. package/src/admin/enrollment/email.ts +17 -3
  48. package/src/admin/enrollment/service.ts +71 -10
  49. package/src/admin/errors.ts +5 -0
  50. package/src/admin/index.ts +1 -0
  51. package/src/admin/reports/service.ts +15 -3
  52. package/src/admin/schema.ts +6 -5
  53. package/src/admin/users/service.ts +173 -16
  54. package/src/client/api.ts +52 -473
  55. package/src/client/auth/client.ts +22 -3
  56. package/src/client/comments.ts +205 -0
  57. package/src/client/community.ts +40 -0
  58. package/src/client/device-authorization.ts +4 -20
  59. package/src/client/discovery.ts +39 -11
  60. package/src/client/documents.ts +160 -0
  61. package/src/client/files/archive.ts +60 -0
  62. package/src/client/files/checksum.ts +7 -0
  63. package/src/client/files/download.ts +122 -0
  64. package/src/client/files/images.ts +89 -0
  65. package/src/client/files/index.ts +15 -0
  66. package/src/client/files/objects.ts +173 -0
  67. package/src/client/files/save.ts +79 -0
  68. package/src/client/index.ts +4 -0
  69. package/src/client/portal/account.ts +73 -3
  70. package/src/client/portal/administration.ts +52 -5
  71. package/src/client/portal/request.ts +6 -2
  72. package/src/client/response.ts +21 -0
  73. package/src/client/schema.ts +8 -0
  74. package/src/client/services.ts +23 -18
  75. package/src/client/sharing.ts +262 -0
  76. package/src/client/tour.ts +44 -0
  77. package/src/client/versions.ts +110 -0
  78. package/src/contract/account.ts +111 -11
  79. package/src/contract/admin/index.ts +48 -3
  80. package/src/contract/billing.ts +235 -0
  81. package/src/contract/collaboration.ts +5 -0
  82. package/src/contract/comments.ts +223 -0
  83. package/src/contract/community.ts +60 -0
  84. package/src/contract/discovery.ts +94 -5
  85. package/src/contract/entitlements.ts +10 -0
  86. package/src/contract/index.ts +64 -5
  87. package/src/contract/links.ts +62 -4
  88. package/src/contract/locale.ts +27 -0
  89. package/src/contract/portal.ts +12 -1
  90. package/src/contract/relay.ts +3 -1
  91. package/src/contract/routes.ts +10 -0
  92. package/src/contract/services.ts +62 -20
  93. package/src/contract/workspaces.ts +5 -0
  94. package/src/email/i18n.ts +174 -0
  95. package/src/email/index.ts +13 -2
  96. package/src/email/locales/ar.json +169 -0
  97. package/src/email/locales/de.json +169 -0
  98. package/src/email/locales/es.json +169 -0
  99. package/src/email/locales/fr.json +169 -0
  100. package/src/email/locales/it.json +169 -0
  101. package/src/email/locales/ja.json +169 -0
  102. package/src/email/locales/pl.json +169 -0
  103. package/src/email/locales/pt-br.json +169 -0
  104. package/src/email/locales/ru.json +169 -0
  105. package/src/email/locales/zh-cn.json +169 -0
  106. package/src/email/messages.ts +235 -0
  107. package/src/email/render.ts +160 -276
  108. package/src/email/samples.ts +142 -0
  109. package/src/email/schema.ts +98 -8
  110. package/src/email/templates/BrandEmail.vue +56 -0
  111. package/src/email/templates/CommentNotification.vue +39 -0
  112. package/src/email/templates/DocumentBlocked.vue +45 -0
  113. package/src/email/templates/DocumentInvitation.vue +24 -0
  114. package/src/email/templates/DocumentReport.vue +32 -0
  115. package/src/email/templates/DocumentReportDecided.vue +36 -0
  116. package/src/email/templates/DocumentReportReceived.vue +18 -0
  117. package/src/email/templates/DocumentRestored.vue +24 -0
  118. package/src/email/templates/EmailChangeRequested.vue +24 -0
  119. package/src/email/templates/EmailRoot.vue +19 -0
  120. package/src/email/templates/EmailText.vue +9 -0
  121. package/src/email/templates/EmailVerification.vue +38 -0
  122. package/src/email/templates/EnrollmentInvitation.vue +53 -0
  123. package/src/email/templates/EnrollmentNotification.vue +24 -0
  124. package/src/email/templates/EnrollmentUpdate.vue +52 -0
  125. package/src/email/templates/NewSignIn.vue +37 -0
  126. package/src/email/templates/PasswordChanged.vue +22 -0
  127. package/src/email/templates/PasswordReset.vue +23 -0
  128. package/src/email/templates/StorageLimitReached.vue +28 -0
  129. package/src/email/templates/TwoStepChanged.vue +47 -0
  130. package/src/email/templates/WaitlistConfirmation.vue +29 -0
  131. package/src/email/templates/WorkspaceInvitation.vue +28 -0
  132. package/src/email/templates/brand.ts +15 -61
  133. package/src/email/templates/localization.ts +17 -0
  134. package/src/errors/index.ts +6 -0
  135. package/src/{server/errors → errors}/posthog.ts +28 -4
  136. package/src/global.d.ts +7 -0
  137. package/src/runtime/cloudflare/email.ts +2 -0
  138. package/src/runtime/cloudflare/relay/index.ts +28 -7
  139. package/src/runtime/cloudflare/tsconfig.json +2 -1
  140. package/src/runtime/cloudflare/worker.ts +14 -1
  141. package/src/runtime/cloudflare/xml.ts +12 -0
  142. package/src/runtime/node/admin.ts +51 -47
  143. package/src/runtime/node/cleanup.ts +5 -1
  144. package/src/runtime/node/email/runtime.ts +1 -0
  145. package/src/runtime/node/email/transport.ts +14 -10
  146. package/src/runtime/node/main.ts +1 -1
  147. package/src/runtime/node/server.ts +20 -4
  148. package/src/runtime/node/services/main.ts +1 -1
  149. package/src/runtime/posthog/errors.ts +5 -2
  150. package/src/runtime/s3/objects.ts +17 -0
  151. package/src/runtime/site/community.ts +101 -0
  152. package/src/runtime/site/server.ts +17 -1
  153. package/src/server/account/actions.ts +3 -1
  154. package/src/server/account/deletion.ts +40 -4
  155. package/src/server/account/routes.ts +305 -253
  156. package/src/server/account/tokens.ts +57 -0
  157. package/src/server/api/router.ts +44 -6
  158. package/src/server/app/checks.ts +89 -0
  159. package/src/server/app/cors.ts +44 -0
  160. package/src/server/app/editors.ts +20 -0
  161. package/src/server/app/index.ts +128 -0
  162. package/src/server/app/indexing.ts +40 -0
  163. package/src/server/app/limiters.ts +53 -0
  164. package/src/server/app/routes.ts +123 -0
  165. package/src/server/app/services.ts +219 -0
  166. package/src/server/auth/access-control.ts +13 -8
  167. package/src/server/auth/access-tokens.ts +62 -0
  168. package/src/server/auth/account.ts +13 -12
  169. package/src/server/auth/activity.ts +7 -2
  170. package/src/server/auth/adapter.ts +36 -3
  171. package/src/server/auth/email.ts +33 -18
  172. package/src/server/auth/endpoints.ts +4 -0
  173. package/src/server/auth/enrollment.ts +116 -0
  174. package/src/server/auth/factory.ts +165 -189
  175. package/src/server/auth/index.ts +1 -1
  176. package/src/server/auth/logger.ts +23 -0
  177. package/src/server/auth/methods.ts +162 -0
  178. package/src/server/auth/mfa-assurance.ts +190 -2
  179. package/src/server/auth/passwords.ts +43 -0
  180. package/src/server/auth/rate-limit.ts +31 -0
  181. package/src/server/auth/runtime.ts +19 -5
  182. package/src/server/auth/session.ts +2 -0
  183. package/src/server/auth/social-providers.ts +70 -24
  184. package/src/server/billing/index.ts +8 -0
  185. package/src/server/billing/notify.ts +55 -0
  186. package/src/server/billing/routes.ts +27 -0
  187. package/src/server/billing/seats.ts +17 -0
  188. package/src/server/billing/tokens.ts +37 -0
  189. package/src/server/cleanup/configured.ts +16 -3
  190. package/src/server/cleanup/documents.ts +5 -2
  191. package/src/server/cleanup/revisions.ts +6 -3
  192. package/src/server/cleanup/uploads.ts +2 -1
  193. package/src/server/cleanup/worker.ts +10 -1
  194. package/src/server/collaboration/relay/connection.ts +7 -2
  195. package/src/server/collaboration/relay/hub.ts +80 -166
  196. package/src/server/collaboration/relay/room.ts +154 -0
  197. package/src/server/collaboration/routes.ts +8 -5
  198. package/src/server/collaboration/service.ts +21 -2
  199. package/src/server/comments/index.ts +9 -0
  200. package/src/server/comments/notify.ts +277 -0
  201. package/src/server/comments/routes.ts +352 -0
  202. package/src/server/comments/rows.ts +249 -0
  203. package/src/server/comments/service.ts +570 -0
  204. package/src/server/community/index.ts +2 -0
  205. package/src/server/community/routes.ts +93 -0
  206. package/src/server/community/service.ts +134 -0
  207. package/src/server/config/deployment.ts +35 -10
  208. package/src/server/config/index.ts +2 -2
  209. package/src/server/config/public.ts +25 -6
  210. package/src/server/config/schema.ts +53 -293
  211. package/src/server/config/toml/schema.ts +330 -0
  212. package/src/server/db/index.ts +3 -1
  213. package/src/server/db/migrate.ts +33 -1
  214. package/src/server/db/migrations/009_access_tokens.ts +47 -0
  215. package/src/server/db/migrations/010_storage_limit_notices.ts +50 -0
  216. package/src/server/db/migrations/011_account_ids.ts +30 -0
  217. package/src/server/db/migrations/012_email_locales.ts +34 -0
  218. package/src/server/db/migrations/013_document_block_emails.ts +40 -0
  219. package/src/server/db/migrations/014_report_replies.ts +28 -0
  220. package/src/server/db/migrations/015_comments.ts +57 -0
  221. package/src/server/db/migrations/016_comment_notifications.ts +76 -0
  222. package/src/server/db/migrations/017_invitation_emails.ts +19 -0
  223. package/src/server/db/migrations/018_enrollment_source.ts +17 -0
  224. package/src/server/db/migrations/schema.ts +26 -1
  225. package/src/server/db/tables.ts +122 -3
  226. package/src/server/db/users.ts +22 -0
  227. package/src/server/documents/access.ts +17 -0
  228. package/src/server/documents/images.ts +6 -1
  229. package/src/server/documents/index.ts +1 -1
  230. package/src/server/documents/limits.ts +7 -1
  231. package/src/server/documents/routes.ts +12 -12
  232. package/src/server/documents/service.ts +31 -407
  233. package/src/server/documents/summary.ts +15 -0
  234. package/src/server/documents/uploads.ts +450 -0
  235. package/src/server/documents/versions/routes.ts +7 -8
  236. package/src/server/documents/versions/service.ts +86 -26
  237. package/src/server/email/invitations.ts +1 -0
  238. package/src/server/email/service.ts +39 -6
  239. package/src/server/email/types.ts +13 -0
  240. package/src/server/errors/index.ts +49 -12
  241. package/src/server/index.ts +27 -6
  242. package/src/server/internal/routes.ts +8 -2
  243. package/src/server/internal/service.ts +10 -0
  244. package/src/server/invitations/budget.ts +3 -1
  245. package/src/server/invitations/index.ts +1 -0
  246. package/src/server/invitations/links.ts +6 -0
  247. package/src/server/invitations/types.ts +5 -1
  248. package/src/server/objects/types.ts +5 -0
  249. package/src/server/pictures/service.ts +3 -1
  250. package/src/server/policy/configured.ts +9 -3
  251. package/src/server/policy/database.ts +13 -2
  252. package/src/server/policy/policy.ts +39 -12
  253. package/src/server/policy/service.ts +71 -52
  254. package/src/server/policy/storage.ts +33 -0
  255. package/src/server/policy/workspace.ts +5 -2
  256. package/src/server/quota/index.ts +6 -0
  257. package/src/server/quota/notices.ts +121 -0
  258. package/src/server/quota/storage.ts +5 -0
  259. package/src/server/rate-limit/middleware.ts +4 -0
  260. package/src/server/reports/index.ts +1 -0
  261. package/src/server/reports/replies.ts +55 -0
  262. package/src/server/reports/routes.ts +5 -3
  263. package/src/server/reports/service.ts +27 -3
  264. package/src/server/services/routes.ts +2 -2
  265. package/src/server/sharing/capabilities/service.ts +3 -4
  266. package/src/server/sharing/document-routes.ts +3 -3
  267. package/src/server/sharing/invitations/service.ts +17 -8
  268. package/src/server/sharing/routes.ts +15 -15
  269. package/src/server/validation.ts +35 -24
  270. package/src/server/workspaces/members.ts +57 -31
  271. package/src/server/workspaces/repository.ts +23 -12
  272. package/src/server/workspaces/routes.ts +8 -8
  273. package/src/services/app.ts +31 -22
  274. package/src/services/config.ts +48 -8
  275. package/src/services/metering.ts +15 -27
  276. package/src/services/usage.ts +6 -14
  277. package/src/email/templates/document-invitation.ts +0 -35
  278. package/src/email/templates/enrollment.ts +0 -27
  279. package/src/email/templates/layout.ts +0 -18
  280. package/src/server/app.ts +0 -453
@@ -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, staticEntitlementsTOMLSchema } from '#cloud/server/policy/schema'
7
+ import { staticEntitlementsSchema } from '#cloud/server/policy/schema'
7
8
  import * as v from 'valibot'
8
9
 
9
10
  import {
@@ -35,7 +36,7 @@ const optionalTextSchema = v.optional(v.pipe(v.string(), v.trim(), v.minLength(1
35
36
  * A prefix deleted files move under: one lowercase path segment and a slash, which no object key
36
37
  * the server makes starts with (they start with `documents/`).
37
38
  */
38
- const deletedPrefixSchema = v.pipe(
39
+ export const deletedPrefixSchema = v.pipe(
39
40
  v.string(),
40
41
  v.regex(/^[a-z0-9][a-z0-9-]*\/$/),
41
42
  v.check((prefix) => prefix !== 'documents/', 'deleted_prefix cannot be documents/')
@@ -45,6 +46,7 @@ const rawCloudServerConfigSchema = v.object({
45
46
  deployment: v.picklist(['official', 'self-hosted']),
46
47
  publicURL: httpURLSchema,
47
48
  listingMinimumEditorVersion: v.optional(cloudEditorVersionSchema),
49
+ minimumEditorVersion: v.optional(cloudEditorVersionSchema),
48
50
  relayURL: v.optional(websocketURLSchema),
49
51
  technicalLimits: v.optional(
50
52
  v.object({
@@ -68,6 +70,8 @@ const rawCloudServerConfigSchema = v.object({
68
70
  }
69
71
  ),
70
72
  staticEntitlements: v.optional(staticEntitlementsSchema),
73
+ /** With database entitlements, what an account without stored ones takes, value by value. */
74
+ defaultEntitlements: v.optional(staticEntitlementsSchema),
71
75
  databaseURL: v.pipe(v.string(), v.url()),
72
76
  authSecret: v.pipe(v.string(), v.minLength(32)),
73
77
  trustedOrigins: v.optional(v.array(httpURLSchema), []),
@@ -110,6 +114,8 @@ const rawCloudServerConfigSchema = v.object({
110
114
  appleTeamId: optionalTextSchema,
111
115
  appleKeyId: optionalTextSchema,
112
116
  applePrivateKey: optionalTextSchema,
117
+ githubClientId: optionalTextSchema,
118
+ githubClientSecret: optionalTextSchema,
113
119
  appleAppBundleIdentifier: optionalTextSchema,
114
120
  s3Endpoint: httpURLSchema,
115
121
  s3Region: v.pipe(v.string(), v.trim(), v.minLength(1)),
@@ -129,6 +135,7 @@ const rawCloudServerConfigSchema = v.object({
129
135
  smtpUser: optionalTextSchema,
130
136
  smtpPassword: optionalTextSchema,
131
137
  emailFrom: optionalTextSchema,
138
+ emailReplyTo: v.optional(v.pipe(v.string(), v.email())),
132
139
  emailTransport: v.optional(v.picklist(['none', 'smtp', 'cloudflare']), 'none'),
133
140
  emailBatchSize: v.optional(v.pipe(v.number(), v.integer(), v.minValue(1), v.maxValue(1000)), 50),
134
141
  emailIntervalMs: v.optional(v.pipe(v.number(), v.integer(), v.minValue(1000)), 30_000),
@@ -164,7 +171,8 @@ const rawCloudServerConfigSchema = v.object({
164
171
  v.pipe(v.number(), v.integer(), v.minValue(60), v.maxValue(60 * 60)),
165
172
  10 * 60
166
173
  ),
167
- billingPortalURL: v.optional(httpURLSchema),
174
+ /** The billing service accounts buy plans and credits from, which discovery advertises. */
175
+ billingEndpoint: v.optional(httpURLSchema),
168
176
  /** The bearer token services such as billing present to the internal API. */
169
177
  internalServiceToken: v.optional(v.pipe(v.string(), v.minLength(32))),
170
178
  /**
@@ -182,12 +190,33 @@ const rawCloudServerConfigSchema = v.object({
182
190
  minimumAge: v.optional(v.pipe(v.number(), v.integer(), v.minValue(13), v.maxValue(21)))
183
191
  })
184
192
  ),
193
+ /**
194
+ * The workspace whose documents anyone may open read-only, without signing in or a link: the
195
+ * deployment's community gallery. Without it the server has none.
196
+ */
197
+ community: v.optional(
198
+ v.object({
199
+ workspaceId: v.pipe(v.string(), v.uuid()),
200
+ /** The gallery document editors open as their tour. */
201
+ tourDocumentId: v.optional(v.pipe(v.string(), v.uuid()))
202
+ })
203
+ ),
204
+ /** How a self-hosted server names itself on its public pages. */
205
+ branding: v.optional(
206
+ v.object({
207
+ name: v.optional(v.pipe(v.string(), v.trim(), v.minLength(1), v.maxLength(80))),
208
+ logoURL: v.optional(httpURLSchema),
209
+ helpURL: v.optional(httpURLSchema)
210
+ })
211
+ ),
185
212
  /** Where server errors are reported; without it the server reports nothing. */
186
213
  errorTracking: v.optional(
187
214
  v.object({
188
215
  provider: v.literal('posthog'),
189
216
  host: httpURLSchema,
190
- projectAPIKey: v.pipe(v.string(), v.trim(), v.minLength(1))
217
+ projectAPIKey: v.pipe(v.string(), v.trim(), v.minLength(1)),
218
+ /** Error reports name the account and records involved; off unless a deployment sets it. */
219
+ includeIds: v.optional(v.boolean(), false)
191
220
  })
192
221
  )
193
222
  })
@@ -248,6 +277,7 @@ function validateAuthenticationConfig(config: CloudServerConfig): void {
248
277
  'appleKeyId',
249
278
  'applePrivateKey'
250
279
  ])
280
+ requireTogether(config, 'GitHub', ['githubClientId', 'githubClientSecret'])
251
281
  }
252
282
 
253
283
  function validateEmailConfig(config: CloudServerConfig): void {
@@ -269,17 +299,29 @@ function validateEmailConfig(config: CloudServerConfig): void {
269
299
 
270
300
  function validateServiceConfig(config: CloudServerConfig): void {
271
301
  requireTogether(config, 'Services', ['servicesEndpoint', 'servicesSigningKey'])
302
+ // Billing tokens are signed with the services' key, and billing sets plans through the
303
+ // internal API, which static entitlements would hide.
304
+ if (config.billingEndpoint && !config.servicesSigningKey) {
305
+ throw new CloudConfigError('Billing needs the services signing key to sign its tokens')
306
+ }
307
+ if (config.billingEndpoint && !config.internalServiceToken) {
308
+ throw new CloudConfigError('Billing needs the internal API to set the plans it sells')
309
+ }
272
310
  if (config.internalServiceToken && config.staticEntitlements) {
273
311
  throw new CloudConfigError(
274
312
  'The internal API writes database entitlements, which static entitlements would hide'
275
313
  )
276
314
  }
277
- if (
278
- config.deployment === 'official' &&
279
- config.servicesEndpoint &&
280
- new URL(config.servicesEndpoint).protocol !== 'https:'
281
- ) {
282
- throw new CloudConfigError('Official services endpoint must use HTTPS')
315
+ // Editors send these endpoints a bearer token, which must not cross the network in the clear.
316
+ for (const [name, endpoint] of [
317
+ ['services', config.servicesEndpoint],
318
+ ['billing', config.billingEndpoint]
319
+ ] as const) {
320
+ if (endpoint && !sendsTokenSafely(endpoint)) {
321
+ throw new CloudConfigError(
322
+ `The ${name} endpoint must use HTTPS, or HTTP only to 127.0.0.1 or [::1] for development`
323
+ )
324
+ }
283
325
  }
284
326
  }
285
327
 
@@ -316,285 +358,3 @@ export function parseCloudServerConfig(input: unknown): CloudServerConfig {
316
358
  validateLegalConfig(config)
317
359
  return config
318
360
  }
319
-
320
- /** PostHog's EU Cloud ingestion host, where OpenPencil's own project is. */
321
- const POSTHOG_DEFAULT_HOST = 'https://eu.i.posthog.com'
322
-
323
- const DEFAULT_SECRET_NAMES = {
324
- databaseURL: 'DATABASE_URL',
325
- authSecret: 'BETTER_AUTH_SECRET',
326
- googleClientId: 'GOOGLE_CLIENT_ID',
327
- googleClientSecret: 'GOOGLE_CLIENT_SECRET',
328
- applePrivateKey: 'APPLE_PRIVATE_KEY',
329
- s3AccessKeyId: 'S3_ACCESS_KEY_ID',
330
- s3SecretAccessKey: 'S3_SECRET_ACCESS_KEY',
331
- s3SessionToken: 'S3_SESSION_TOKEN',
332
- smtpUser: 'OPENPENCIL_CLOUD_SMTP_USER',
333
- smtpPassword: 'OPENPENCIL_CLOUD_SMTP_PASSWORD',
334
- turnstileSecretKey: 'TURNSTILE_SECRET_KEY',
335
- servicesSigningKey: 'OPENPENCIL_CLOUD_SERVICES_SIGNING_KEY',
336
- internalServiceToken: 'OPENPENCIL_CLOUD_SERVICE_TOKEN',
337
- posthogProjectAPIKey: 'POSTHOG_PROJECT_API_KEY'
338
- } as const
339
-
340
- const urlSchema = v.pipe(v.string(), v.url())
341
- const textSchema = v.pipe(v.string(), v.trim(), v.minLength(1))
342
- const positiveIntegerSchema = v.pipe(v.number(), v.integer(), v.minValue(1))
343
- const secretReferenceSchema = v.strictObject({ from_env: textSchema })
344
- const configurableTextSchema = v.union([textSchema, secretReferenceSchema])
345
- const defaultReference = (name: string) => v.optional(secretReferenceSchema, { from_env: name })
346
-
347
- const providerSchema = v.strictObject({
348
- google: v.optional(
349
- v.strictObject({
350
- client_id: v.optional(configurableTextSchema, {
351
- from_env: DEFAULT_SECRET_NAMES.googleClientId
352
- }),
353
- client_secret: defaultReference(DEFAULT_SECRET_NAMES.googleClientSecret)
354
- })
355
- ),
356
- apple: v.optional(
357
- v.strictObject({
358
- client_id: textSchema,
359
- team_id: textSchema,
360
- key_id: textSchema,
361
- private_key: defaultReference(DEFAULT_SECRET_NAMES.applePrivateKey),
362
- app_bundle_identifier: v.optional(textSchema)
363
- })
364
- )
365
- })
366
-
367
- const emailSchema = v.optional(
368
- v.variant('transport', [
369
- v.strictObject({ transport: v.literal('none') }),
370
- v.strictObject({
371
- transport: v.literal('smtp'),
372
- from: textSchema,
373
- smtp: v.strictObject({
374
- host: textSchema,
375
- port: positiveIntegerSchema,
376
- secure: v.optional(v.boolean()),
377
- user: v.optional(secretReferenceSchema, {
378
- from_env: DEFAULT_SECRET_NAMES.smtpUser
379
- }),
380
- password: v.optional(secretReferenceSchema, {
381
- from_env: DEFAULT_SECRET_NAMES.smtpPassword
382
- })
383
- })
384
- }),
385
- v.strictObject({ transport: v.literal('cloudflare'), from: textSchema })
386
- ]),
387
- { transport: 'none' }
388
- )
389
-
390
- /**
391
- * Every table is strict: a key the schema doesn't know, such as one renamed since, stops startup
392
- * instead of leaving its setting at a default the operator never chose.
393
- */
394
- export const cloudDeploymentConfigSchema = v.strictObject({
395
- schema_version: v.literal(2),
396
- deployment: v.strictObject({
397
- mode: v.picklist(['official', 'self-hosted']),
398
- public_url: urlSchema,
399
- indexing: v.optional(v.picklist(['allow', 'deny']), 'deny'),
400
- trusted_origins: v.optional(v.array(urlSchema), []),
401
- // The server's editor works with files on this device without signing in to the server.
402
- local_editor: v.optional(v.boolean(), true),
403
- listing: v.optional(v.strictObject({ minimum_editor_version: cloudEditorVersionSchema }))
404
- }),
405
- database: v.optional(
406
- v.strictObject({ url: defaultReference(DEFAULT_SECRET_NAMES.databaseURL) }),
407
- {
408
- url: { from_env: DEFAULT_SECRET_NAMES.databaseURL }
409
- }
410
- ),
411
- authentication: v.strictObject({
412
- secret: defaultReference(DEFAULT_SECRET_NAMES.authSecret),
413
- enrollment: v.optional(
414
- v.strictObject({
415
- mode: v.optional(v.picklist(['open', 'approval', 'closed']), 'open'),
416
- notification_emails: v.optional(v.array(v.pipe(v.string(), v.email())), [])
417
- }),
418
- { mode: 'open', notification_emails: [] }
419
- ),
420
- email_password: v.optional(
421
- v.strictObject({
422
- enabled: v.optional(v.boolean(), false),
423
- sign_up: v.optional(v.boolean(), true),
424
- minimum_password_length: v.optional(
425
- v.pipe(v.number(), v.integer(), v.minValue(8), v.maxValue(128)),
426
- 8
427
- ),
428
- maximum_password_length: v.optional(
429
- v.pipe(v.number(), v.integer(), v.minValue(15), v.maxValue(128)),
430
- 128
431
- ),
432
- verification_link_lifetime_minutes: v.optional(positiveIntegerSchema, 60),
433
- password_reset_link_lifetime_minutes: v.optional(positiveIntegerSchema, 60),
434
- compromised_password_check: v.optional(v.boolean(), false)
435
- }),
436
- {
437
- enabled: false,
438
- sign_up: true,
439
- minimum_password_length: 8,
440
- maximum_password_length: 128,
441
- verification_link_lifetime_minutes: 60,
442
- password_reset_link_lifetime_minutes: 60,
443
- compromised_password_check: false
444
- }
445
- ),
446
- mfa: v.optional(
447
- v.strictObject({
448
- required_for_admins: v.optional(v.boolean(), false),
449
- totp: v.optional(v.boolean(), false),
450
- recovery_codes: v.optional(v.boolean(), false),
451
- trusted_device_lifetime_days: v.optional(v.pipe(v.number(), v.integer(), v.minValue(0)), 14)
452
- }),
453
- {
454
- required_for_admins: false,
455
- totp: false,
456
- recovery_codes: false,
457
- trusted_device_lifetime_days: 14
458
- }
459
- ),
460
- // Passkeys belong to public_url's host and origin.
461
- passkeys: v.optional(
462
- v.strictObject({
463
- enabled: v.optional(v.boolean(), false),
464
- rp_name: v.optional(textSchema, 'OpenPencil Cloud')
465
- }),
466
- { enabled: false, rp_name: 'OpenPencil Cloud' }
467
- ),
468
- captcha: v.optional(
469
- v.strictObject({
470
- provider: v.literal('cloudflare-turnstile'),
471
- site_key: textSchema,
472
- secret_key: defaultReference(DEFAULT_SECRET_NAMES.turnstileSecretKey),
473
- allowed_hostnames: v.optional(v.array(textSchema), [])
474
- })
475
- ),
476
- trusted_proxies: v.optional(
477
- v.strictObject({
478
- headers: v.optional(v.array(textSchema), []),
479
- addresses: v.optional(v.array(textSchema), [])
480
- }),
481
- { headers: [], addresses: [] }
482
- ),
483
- providers: v.optional(providerSchema, {})
484
- }),
485
- object_storage: v.strictObject({
486
- endpoint: urlSchema,
487
- region: textSchema,
488
- bucket: textSchema,
489
- credentials: v.optional(
490
- v.strictObject({
491
- access_key_id: defaultReference(DEFAULT_SECRET_NAMES.s3AccessKeyId),
492
- secret_access_key: defaultReference(DEFAULT_SECRET_NAMES.s3SecretAccessKey),
493
- session_token: v.optional(secretReferenceSchema, {
494
- from_env: DEFAULT_SECRET_NAMES.s3SessionToken
495
- })
496
- }),
497
- {
498
- access_key_id: { from_env: DEFAULT_SECRET_NAMES.s3AccessKeyId },
499
- secret_access_key: { from_env: DEFAULT_SECRET_NAMES.s3SecretAccessKey }
500
- }
501
- ),
502
- force_path_style: v.optional(v.boolean(), true),
503
- checksum_verification: v.optional(v.picklist(['native', 'metadata']), 'native'),
504
- server_side_encryption: v.optional(v.picklist(['AES256', 'aws:kms'])),
505
- kms_key_id: v.optional(textSchema),
506
- /**
507
- * Keeps each file cleanup deletes under this prefix, such as `deleted/`, so a database restored
508
- * to an earlier time still finds it; a lifecycle rule on the prefix expires them.
509
- */
510
- deleted_prefix: v.optional(deletedPrefixSchema),
511
- maximum_upload_bytes: v.optional(positiveIntegerSchema)
512
- }),
513
- collaboration: v.optional(
514
- v.strictObject({
515
- relay_url: v.optional(urlSchema),
516
- maximum_message_bytes: v.optional(positiveIntegerSchema),
517
- maximum_connections_per_room: v.optional(positiveIntegerSchema)
518
- }),
519
- {}
520
- ),
521
- documents: v.optional(
522
- v.strictObject({
523
- retention_days: v.optional(v.pipe(v.number(), v.integer(), v.minValue(0)), 30),
524
- purge_grace_days: v.optional(v.pipe(v.number(), v.integer(), v.minValue(0)), 7)
525
- }),
526
- { retention_days: 30, purge_grace_days: 7 }
527
- ),
528
- email: emailSchema,
529
- workers: v.optional(
530
- v.strictObject({
531
- email: v.optional(
532
- v.strictObject({
533
- batch_size: v.optional(positiveIntegerSchema, 50),
534
- interval_ms: v.optional(positiveIntegerSchema, 30_000),
535
- lease_ms: v.optional(positiveIntegerSchema, 300_000),
536
- maximum_attempts: v.optional(positiveIntegerSchema, 5)
537
- }),
538
- { batch_size: 50, interval_ms: 30_000, lease_ms: 300_000, maximum_attempts: 5 }
539
- ),
540
- cleanup: v.optional(
541
- v.strictObject({
542
- enabled: v.optional(v.boolean(), true),
543
- batch_size: v.optional(positiveIntegerSchema, 100),
544
- interval_ms: v.optional(positiveIntegerSchema, 60_000),
545
- lease_ms: v.optional(positiveIntegerSchema, 300_000)
546
- }),
547
- { enabled: true, batch_size: 100, interval_ms: 60_000, lease_ms: 300_000 }
548
- )
549
- })
550
- ),
551
- entitlements: v.optional(
552
- v.variant('source', [
553
- v.strictObject({ source: v.literal('static'), ...staticEntitlementsTOMLSchema.entries }),
554
- v.strictObject({ source: v.literal('database') })
555
- ])
556
- ),
557
- services: v.optional(
558
- v.strictObject({
559
- endpoint: urlSchema,
560
- signing_key: defaultReference(DEFAULT_SECRET_NAMES.servicesSigningKey),
561
- token_lifetime_minutes: v.optional(
562
- v.pipe(v.number(), v.integer(), v.minValue(1), v.maxValue(60)),
563
- 10
564
- )
565
- })
566
- ),
567
- billing: v.optional(v.strictObject({ portal_url: urlSchema })),
568
- internal_api: v.optional(
569
- v.strictObject({ service_token: defaultReference(DEFAULT_SECRET_NAMES.internalServiceToken) })
570
- ),
571
- /**
572
- * Optional: the operator's terms and privacy policy, linked at sign-up and in the portal, and
573
- * with `require_acceptance`, accepted once per `terms_version` before an account uses the server.
574
- */
575
- legal: v.optional(
576
- v.strictObject({
577
- terms_url: v.optional(urlSchema),
578
- privacy_url: v.optional(urlSchema),
579
- terms_version: v.optional(textSchema),
580
- require_acceptance: v.optional(v.boolean(), false),
581
- abuse_email: v.optional(v.pipe(v.string(), v.email())),
582
- minimum_age: v.optional(v.pipe(v.number(), v.integer(), v.minValue(13), v.maxValue(21)))
583
- })
584
- ),
585
- /** Optional: reports server errors to PostHog error tracking. Leave it out to send nothing. */
586
- error_tracking: v.optional(
587
- v.strictObject({
588
- provider: v.literal('posthog'),
589
- host: v.optional(urlSchema, POSTHOG_DEFAULT_HOST),
590
- project_api_key: v.optional(configurableTextSchema, {
591
- from_env: DEFAULT_SECRET_NAMES.posthogProjectAPIKey
592
- })
593
- })
594
- )
595
- })
596
-
597
- export type CloudDeploymentConfig = v.InferOutput<typeof cloudDeploymentConfigSchema>
598
- /** Deployment configuration as an operator writes it, before defaults are applied. */
599
- export type CloudDeploymentInput = v.InferInput<typeof cloudDeploymentConfigSchema>
600
- export type CloudSecretReference = v.InferOutput<typeof secretReferenceSchema>