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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (206) 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 +296 -27
  7. package/dist/client.d.ts.map +1 -1
  8. package/dist/client.js +649 -295
  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 +331 -21
  13. package/dist/contract2.js.map +1 -1
  14. package/dist/email.d.ts +1773 -32
  15. package/dist/email.d.ts.map +1 -1
  16. package/dist/email.js +3478 -288
  17. package/dist/email.js.map +1 -1
  18. package/dist/errors.d.ts +2 -0
  19. package/dist/errors.js +48 -0
  20. package/dist/errors.js.map +1 -0
  21. package/dist/index.d.ts +466 -13
  22. package/dist/index.d.ts.map +1 -1
  23. package/dist/index2.d.ts +35 -0
  24. package/dist/index2.d.ts.map +1 -0
  25. package/dist/listen.mjs +447 -290
  26. package/dist/listen.mjs.map +1 -1
  27. package/dist/runtime-cloudflare.d.ts +89 -0
  28. package/dist/runtime-cloudflare.d.ts.map +1 -0
  29. package/dist/runtime-cloudflare.js +15667 -0
  30. package/dist/runtime-cloudflare.js.map +1 -0
  31. package/dist/runtime-node.d.mts +2963 -294
  32. package/dist/runtime-node.d.mts.map +1 -1
  33. package/dist/server.d.ts +3473 -842
  34. package/dist/server.d.ts.map +1 -1
  35. package/dist/server.js +12187 -8244
  36. package/dist/server.js.map +1 -1
  37. package/dist/server.mjs +7739 -3548
  38. package/dist/server.mjs.map +1 -1
  39. package/dist/server2.mjs +5 -5
  40. package/dist/server2.mjs.map +1 -1
  41. package/package.json +22 -5
  42. package/src/admin/audit/service.ts +2 -2
  43. package/src/admin/documents/service.ts +76 -6
  44. package/src/admin/reports/service.ts +7 -1
  45. package/src/client/api.ts +23 -471
  46. package/src/client/auth/client.ts +22 -3
  47. package/src/client/billing.ts +80 -0
  48. package/src/client/community.ts +40 -0
  49. package/src/client/discovery.ts +35 -9
  50. package/src/client/documents.ts +160 -0
  51. package/src/client/index.ts +7 -0
  52. package/src/client/portal/account.ts +54 -2
  53. package/src/client/portal/request.ts +2 -0
  54. package/src/client/response.ts +21 -0
  55. package/src/client/schema.ts +8 -0
  56. package/src/client/services.ts +23 -18
  57. package/src/client/sharing.ts +262 -0
  58. package/src/client/versions.ts +104 -0
  59. package/src/contract/account.ts +50 -0
  60. package/src/contract/billing.ts +166 -0
  61. package/src/contract/collaboration.ts +5 -0
  62. package/src/contract/community.ts +60 -0
  63. package/src/contract/discovery.ts +63 -2
  64. package/src/contract/entitlements.ts +10 -0
  65. package/src/contract/index.ts +54 -5
  66. package/src/contract/links.ts +57 -4
  67. package/src/contract/locale.ts +27 -0
  68. package/src/contract/portal.ts +12 -1
  69. package/src/contract/routes.ts +10 -0
  70. package/src/contract/services.ts +18 -16
  71. package/src/email/i18n.ts +174 -0
  72. package/src/email/index.ts +13 -2
  73. package/src/email/locales/ar.json +141 -0
  74. package/src/email/locales/de.json +141 -0
  75. package/src/email/locales/es.json +141 -0
  76. package/src/email/locales/fr.json +141 -0
  77. package/src/email/locales/it.json +141 -0
  78. package/src/email/locales/ja.json +141 -0
  79. package/src/email/locales/pl.json +141 -0
  80. package/src/email/locales/pt-br.json +141 -0
  81. package/src/email/locales/ru.json +141 -0
  82. package/src/email/locales/zh-cn.json +141 -0
  83. package/src/email/messages.ts +200 -0
  84. package/src/email/render.ts +142 -276
  85. package/src/email/samples.ts +115 -0
  86. package/src/email/schema.ts +70 -6
  87. package/src/email/templates/BrandEmail.vue +54 -0
  88. package/src/email/templates/DocumentBlocked.vue +45 -0
  89. package/src/email/templates/DocumentInvitation.vue +24 -0
  90. package/src/email/templates/DocumentReport.vue +32 -0
  91. package/src/email/templates/DocumentReportDecided.vue +36 -0
  92. package/src/email/templates/DocumentReportReceived.vue +18 -0
  93. package/src/email/templates/DocumentRestored.vue +24 -0
  94. package/src/email/templates/EmailChangeRequested.vue +24 -0
  95. package/src/email/templates/EmailRoot.vue +19 -0
  96. package/src/email/templates/EmailText.vue +9 -0
  97. package/src/email/templates/EmailVerification.vue +38 -0
  98. package/src/email/templates/EnrollmentNotification.vue +24 -0
  99. package/src/email/templates/EnrollmentUpdate.vue +52 -0
  100. package/src/email/templates/NewSignIn.vue +37 -0
  101. package/src/email/templates/PasswordChanged.vue +22 -0
  102. package/src/email/templates/PasswordReset.vue +23 -0
  103. package/src/email/templates/StorageLimitReached.vue +28 -0
  104. package/src/email/templates/TwoStepChanged.vue +32 -0
  105. package/src/email/templates/WaitlistConfirmation.vue +29 -0
  106. package/src/email/templates/WorkspaceInvitation.vue +28 -0
  107. package/src/email/templates/brand.ts +9 -61
  108. package/src/email/templates/localization.ts +17 -0
  109. package/src/errors/index.ts +6 -0
  110. package/src/global.d.ts +7 -0
  111. package/src/runtime/cloudflare/relay/index.ts +7 -1
  112. package/src/runtime/cloudflare/tsconfig.json +2 -1
  113. package/src/runtime/cloudflare/worker.ts +8 -1
  114. package/src/runtime/node/cleanup.ts +5 -1
  115. package/src/runtime/node/email/transport.ts +13 -10
  116. package/src/runtime/node/main.ts +1 -1
  117. package/src/runtime/node/server.ts +12 -2
  118. package/src/runtime/node/services/main.ts +1 -1
  119. package/src/runtime/posthog/errors.ts +2 -1
  120. package/src/runtime/s3/objects.ts +17 -0
  121. package/src/runtime/site/community.ts +101 -0
  122. package/src/runtime/site/server.ts +17 -1
  123. package/src/server/account/deletion.ts +2 -0
  124. package/src/server/account/routes.ts +271 -240
  125. package/src/server/account/tokens.ts +57 -0
  126. package/src/server/api/router.ts +23 -0
  127. package/src/server/app/checks.ts +84 -0
  128. package/src/server/app/editors.ts +20 -0
  129. package/src/server/app/index.ts +128 -0
  130. package/src/server/app/indexing.ts +40 -0
  131. package/src/server/app/limiters.ts +53 -0
  132. package/src/server/app/routes.ts +114 -0
  133. package/src/server/app/services.ts +185 -0
  134. package/src/server/auth/access-tokens.ts +62 -0
  135. package/src/server/auth/adapter.ts +21 -1
  136. package/src/server/auth/email.ts +4 -1
  137. package/src/server/auth/enrollment.ts +116 -0
  138. package/src/server/auth/factory.ts +88 -131
  139. package/src/server/auth/logger.ts +23 -0
  140. package/src/server/auth/mfa-assurance.ts +51 -0
  141. package/src/server/auth/passwords.ts +43 -0
  142. package/src/server/auth/session.ts +2 -0
  143. package/src/server/billing/index.ts +6 -0
  144. package/src/server/billing/routes.ts +27 -0
  145. package/src/server/billing/tokens.ts +37 -0
  146. package/src/server/cleanup/configured.ts +16 -3
  147. package/src/server/cleanup/worker.ts +10 -1
  148. package/src/server/collaboration/relay/hub.ts +25 -142
  149. package/src/server/collaboration/relay/room.ts +154 -0
  150. package/src/server/collaboration/service.ts +21 -2
  151. package/src/server/community/index.ts +2 -0
  152. package/src/server/community/routes.ts +93 -0
  153. package/src/server/community/service.ts +134 -0
  154. package/src/server/config/deployment.ts +17 -5
  155. package/src/server/config/index.ts +1 -1
  156. package/src/server/config/public.ts +7 -1
  157. package/src/server/config/schema.ts +40 -292
  158. package/src/server/config/toml/schema.ts +307 -0
  159. package/src/server/db/index.ts +1 -0
  160. package/src/server/db/migrate.ts +13 -1
  161. package/src/server/db/migrations/009_access_tokens.ts +47 -0
  162. package/src/server/db/migrations/010_storage_limit_notices.ts +50 -0
  163. package/src/server/db/migrations/011_account_ids.ts +30 -0
  164. package/src/server/db/migrations/012_email_locales.ts +34 -0
  165. package/src/server/db/migrations/013_document_block_emails.ts +40 -0
  166. package/src/server/db/migrations/014_report_replies.ts +28 -0
  167. package/src/server/db/migrations/schema.ts +26 -1
  168. package/src/server/db/tables.ts +30 -1
  169. package/src/server/db/users.ts +22 -0
  170. package/src/server/documents/index.ts +1 -1
  171. package/src/server/documents/limits.ts +7 -1
  172. package/src/server/documents/service.ts +12 -402
  173. package/src/server/documents/uploads.ts +450 -0
  174. package/src/server/documents/versions/service.ts +81 -24
  175. package/src/server/email/invitations.ts +1 -0
  176. package/src/server/email/service.ts +31 -4
  177. package/src/server/email/types.ts +12 -0
  178. package/src/server/errors/index.ts +1 -9
  179. package/src/server/index.ts +12 -5
  180. package/src/server/invitations/types.ts +5 -1
  181. package/src/server/objects/types.ts +5 -0
  182. package/src/server/policy/configured.ts +9 -3
  183. package/src/server/policy/database.ts +13 -2
  184. package/src/server/policy/policy.ts +39 -12
  185. package/src/server/policy/service.ts +71 -52
  186. package/src/server/policy/storage.ts +33 -0
  187. package/src/server/quota/index.ts +6 -0
  188. package/src/server/quota/notices.ts +121 -0
  189. package/src/server/quota/storage.ts +5 -0
  190. package/src/server/rate-limit/middleware.ts +4 -0
  191. package/src/server/reports/index.ts +1 -0
  192. package/src/server/reports/replies.ts +55 -0
  193. package/src/server/reports/routes.ts +3 -1
  194. package/src/server/reports/service.ts +24 -2
  195. package/src/server/sharing/capabilities/service.ts +2 -3
  196. package/src/server/sharing/invitations/service.ts +14 -4
  197. package/src/server/validation.ts +3 -0
  198. package/src/server/workspaces/members.ts +7 -19
  199. package/src/services/app.ts +1 -3
  200. package/src/services/config.ts +1 -0
  201. package/src/services/usage.ts +6 -14
  202. package/src/email/templates/document-invitation.ts +0 -35
  203. package/src/email/templates/enrollment.ts +0 -27
  204. package/src/email/templates/layout.ts +0 -18
  205. package/src/server/app.ts +0 -453
  206. /package/src/{server/errors → errors}/posthog.ts +0 -0
@@ -0,0 +1,185 @@
1
+ import { createEnrollmentService, type EnrollmentService } from '#cloud/admin'
2
+ import type {
3
+ CloudAuthAdapter,
4
+ CloudIdentityResolver,
5
+ CloudSessionResolver
6
+ } from '#cloud/server/auth'
7
+ import { createBillingTokenService } from '#cloud/server/billing'
8
+ import { createCollaborationTicketService } from '#cloud/server/collaboration'
9
+ import { createCommunityService } from '#cloud/server/community'
10
+ import { CloudConfigError, type CloudServerConfig } from '#cloud/server/config'
11
+ import type { CloudDatabase } from '#cloud/server/db'
12
+ import { createDocumentService } from '#cloud/server/documents'
13
+ import { createDocumentVersionService } from '#cloud/server/documents/versions'
14
+ import type { TransactionalEmailService } from '#cloud/server/email'
15
+ import type { CloudErrorReporter } from '#cloud/server/errors'
16
+ import type { InvitationDelivery, InvitationOutbox } from '#cloud/server/invitations'
17
+ import type { ForwardedRequestId } from '#cloud/server/logging'
18
+ import type { ObjectStore } from '#cloud/server/objects'
19
+ import { createUserPictures } from '#cloud/server/pictures'
20
+ import {
21
+ createConfiguredCloudPolicy,
22
+ createDefaultCloudPolicy,
23
+ createEntitlementService,
24
+ EntitlementOpenFeatureProvider,
25
+ type CloudPolicy,
26
+ type EntitlementSource
27
+ } from '#cloud/server/policy'
28
+ import { createDocumentReportService } from '#cloud/server/reports'
29
+ import { createServicesTokenService, type ServicesSigningKey } from '#cloud/server/services'
30
+ import { createDocumentSharingService } from '#cloud/server/sharing'
31
+ import { createWorkspaceMemberService, createWorkspaceService } from '#cloud/server/workspaces'
32
+ import type { Kysely } from 'kysely'
33
+
34
+ export type CloudServices = {
35
+ config: CloudServerConfig
36
+ database: Kysely<CloudDatabase>
37
+ auth: CloudAuthAdapter
38
+ objects: ObjectStore
39
+ resolveIdentity?: CloudIdentityResolver
40
+ resolveSession?: CloudSessionResolver
41
+ /**
42
+ * An approved account even before it accepted the current terms, for leaving: reading its
43
+ * documents and deleting the account. Defaults to `resolveSession` when that is given.
44
+ */
45
+ resolveAccountSession?: CloudSessionResolver
46
+ invitationDelivery?: InvitationDelivery
47
+ invitationOutbox?: InvitationOutbox
48
+ transactionalEmail?: TransactionalEmailService
49
+ enrollment?: EnrollmentService
50
+ entitlementSource?: EntitlementSource
51
+ policy?: CloudPolicy
52
+ /** The imported `servicesSigningKey`, required when the config names one. See `loadServicesSigningKey`. */
53
+ servicesSigningKey?: ServicesSigningKey
54
+ /**
55
+ * Where clients reach this runtime's collaboration relay. Without one, Cloud rooms fall back to
56
+ * peer-to-peer and writes are not enforced by the server.
57
+ */
58
+ relayURL?: string
59
+ /** Ends a restored document's live rooms, on the relay this runtime runs, if any. */
60
+ onDocumentRestored?: (documentId: string) => void
61
+ /** Ends a taken-down document's live rooms, saving them for when it is restored. */
62
+ onDocumentTakenDown?: (documentId: string) => void
63
+ /** Tells a document's live rooms its version history changed, on the relay this runtime runs. */
64
+ onDocumentVersionsChanged?: (documentId: string) => void
65
+ /** Logs errors no route handled, and reports them when the deployment configures error tracking. */
66
+ reportError?: CloudErrorReporter
67
+ /** The request ID this runtime trusts from what stands in front of it, such as `cf-ray`. */
68
+ forwardedRequestId?: ForwardedRequestId
69
+ }
70
+
71
+ /** The domain services the app's routes are built from, over the runtime's injected services. */
72
+ export function createAppServices(services: CloudServices) {
73
+ const { config, database, objects } = services
74
+ const workspaces = createWorkspaceService(database)
75
+ const pictures = createUserPictures(database, { publicURL: config.publicURL })
76
+ const workspaceMembers = createWorkspaceMemberService(database, {
77
+ email: services.transactionalEmail,
78
+ publicURL: config.publicURL
79
+ })
80
+ const enrollment =
81
+ services.enrollment ??
82
+ createEnrollmentService(database, {
83
+ publicURL: config.publicURL,
84
+ adminRecipients: config.enrollmentAdminNotificationEmails,
85
+ email: services.transactionalEmail
86
+ })
87
+ const policy =
88
+ services.policy ??
89
+ (services.entitlementSource
90
+ ? createDefaultCloudPolicy(new EntitlementOpenFeatureProvider(services.entitlementSource))
91
+ : createConfiguredCloudPolicy(config, database))
92
+ const documents = createDocumentService(database, objects, {
93
+ policy,
94
+ technicalMaximumUploadBytes: config.technicalLimits.maximumUploadBytes,
95
+ onVersionsChanged: services.onDocumentVersionsChanged,
96
+ trash: {
97
+ retentionMs: config.documentRetentionMs,
98
+ purgeGraceMs: config.documentPurgeGraceMs,
99
+ leaseDurationMs: config.cleanupLeaseDurationMs,
100
+ reportError: services.reportError
101
+ },
102
+ reportError: services.reportError
103
+ })
104
+ const versions = createDocumentVersionService(database, objects, {
105
+ policy,
106
+ deploymentMode: config.deployment,
107
+ onRestored: services.onDocumentRestored,
108
+ onVersionsChanged: services.onDocumentVersionsChanged
109
+ })
110
+ const community = createCommunityService(
111
+ database,
112
+ objects,
113
+ documents,
114
+ versions,
115
+ config.community?.workspaceId ?? null
116
+ )
117
+ const entitlements = createEntitlementService(
118
+ database,
119
+ policy,
120
+ config.technicalLimits.maximumUploadBytes,
121
+ config.technicalLimits.maximumConnectionsPerRoom
122
+ )
123
+ const sharing = createDocumentSharingService(database, {
124
+ delivery: services.invitationDelivery,
125
+ outbox: services.invitationOutbox,
126
+ continuationSecret: config.authSecret,
127
+ publicURL: config.publicURL,
128
+ policy,
129
+ deploymentMode: config.deployment,
130
+ workspaceInvitations: workspaceMembers
131
+ })
132
+ const collaboration = createCollaborationTicketService({
133
+ database,
134
+ sharing,
135
+ authSecret: config.authSecret,
136
+ relayURL: services.relayURL,
137
+ policy,
138
+ deploymentMode: config.deployment
139
+ })
140
+ if (config.servicesSigningKey && !services.servicesSigningKey) {
141
+ throw new CloudConfigError('Services need the signing key imported by loadServicesSigningKey')
142
+ }
143
+ const servicesTokens = services.servicesSigningKey
144
+ ? createServicesTokenService({
145
+ database,
146
+ policy,
147
+ deploymentMode: config.deployment,
148
+ issuer: new URL(config.publicURL).origin,
149
+ signingKey: services.servicesSigningKey,
150
+ lifetimeSeconds: config.servicesTokenLifetimeSeconds
151
+ })
152
+ : undefined
153
+ const billingTokens =
154
+ services.servicesSigningKey && config.billingEndpoint
155
+ ? createBillingTokenService({
156
+ issuer: new URL(config.publicURL).origin,
157
+ signingKey: services.servicesSigningKey,
158
+ lifetimeSeconds: config.servicesTokenLifetimeSeconds
159
+ })
160
+ : undefined
161
+ const reports = createDocumentReportService(database, {
162
+ sharing,
163
+ email: services.transactionalEmail,
164
+ adminRecipients: config.enrollmentAdminNotificationEmails,
165
+ publicURL: config.publicURL
166
+ })
167
+ return {
168
+ workspaces,
169
+ pictures,
170
+ workspaceMembers,
171
+ enrollment,
172
+ policy,
173
+ documents,
174
+ versions,
175
+ community,
176
+ entitlements,
177
+ sharing,
178
+ collaboration,
179
+ servicesTokens,
180
+ billingTokens,
181
+ reports
182
+ }
183
+ }
184
+
185
+ export type CloudAppServices = ReturnType<typeof createAppServices>
@@ -0,0 +1,62 @@
1
+ import type { EnrollmentService } from '#cloud/admin/enrollment/service'
2
+ import { CLOUD_ACCESS_TOKEN_PREFIX, type CloudAccessToken } from '#cloud/contract'
3
+ import type { TermsService } from '#cloud/server/account/terms'
4
+ import type { CloudServerConfig } from '#cloud/server/config'
5
+ import type { CloudDatabase } from '#cloud/server/db'
6
+ import type { Kysely } from 'kysely'
7
+
8
+ /** The personal access token in `Authorization: Bearer`, when the header carries one of Cloud's. */
9
+ export function bearerAccessToken(headers: Headers): string | null {
10
+ const key = headers.get('authorization')?.match(/^Bearer\s+(\S+)$/i)?.[1]
11
+ return key?.startsWith(CLOUD_ACCESS_TOKEN_PREFIX) ? key : null
12
+ }
13
+
14
+ /**
15
+ * The account a verified token belongs to, held to what a session would be: not banned, approved,
16
+ * and with the current terms accepted.
17
+ */
18
+ export async function accessTokenAccount(
19
+ {
20
+ database,
21
+ config,
22
+ enrollment,
23
+ terms
24
+ }: {
25
+ database: Kysely<CloudDatabase>
26
+ config: CloudServerConfig
27
+ enrollment: EnrollmentService
28
+ terms: TermsService
29
+ },
30
+ userId: string
31
+ ) {
32
+ const user = await database
33
+ .selectFrom('user')
34
+ .select(['id', 'email', 'name', 'image', 'role', 'banned', 'banExpires'])
35
+ .where('id', '=', userId)
36
+ .executeTakeFirst()
37
+ if (!user) return null
38
+ const banExpires = user.banExpires ? new Date(user.banExpires).getTime() : null
39
+ if (user.banned && (banExpires === null || banExpires > Date.now())) return null
40
+ if (config.enrollmentMode === 'approval' && !(await enrollment.isApproved(user.email))) {
41
+ return null
42
+ }
43
+ if (!(await terms.hasAccepted(user.id))) return null
44
+ return user
45
+ }
46
+
47
+ /** A stored token as the account's token list shows it, without the secret. */
48
+ export const toAccessToken = (key: {
49
+ id: string
50
+ name: string | null
51
+ start: string | null
52
+ createdAt: Date
53
+ expiresAt: Date | null
54
+ lastRequest: Date | null
55
+ }): CloudAccessToken => ({
56
+ id: key.id,
57
+ name: key.name ?? '',
58
+ start: key.start,
59
+ createdAt: new Date(key.createdAt).toISOString(),
60
+ expiresAt: key.expiresAt ? new Date(key.expiresAt).toISOString() : null,
61
+ lastUsedAt: key.lastRequest ? new Date(key.lastRequest).toISOString() : null
62
+ })
@@ -1,4 +1,9 @@
1
- import type { CloudAccountSession, CloudSignIn } from '#cloud/contract'
1
+ import type {
2
+ CloudAccessToken,
3
+ CloudAccessTokenCreate,
4
+ CloudAccountSession,
5
+ CloudSignIn
6
+ } from '#cloud/contract'
2
7
  import type { CloudActor } from '#cloud/server/auth/session'
3
8
 
4
9
  export type CloudMFAStatus = {
@@ -43,6 +48,18 @@ export interface CloudAuthAdapter {
43
48
  * terms: enough to leave, by downloading its documents and deleting the account.
44
49
  */
45
50
  resolveAccountSession(headers: Headers): Promise<CloudActor | null>
51
+ /**
52
+ * The account a personal access token stands for, from `Authorization: Bearer`, once it is held
53
+ * to what a session would be. Only the document API reads tokens.
54
+ */
55
+ resolveAccessToken(headers: Headers): Promise<CloudActor | null>
56
+ listAccessTokens(headers: Headers): Promise<CloudAccessToken[] | null>
57
+ /** Makes a token for the signed-in account; answers the whole token, shown this once. */
58
+ createAccessToken(
59
+ headers: Headers,
60
+ input: CloudAccessTokenCreate
61
+ ): Promise<{ token: string; accessToken: CloudAccessToken }>
62
+ revokeAccessToken(headers: Headers, id: string): Promise<void>
46
63
  listAuthenticationMethods(headers: Headers): Promise<CloudAuthenticationMethodRecord[]>
47
64
  changePassword(
48
65
  headers: Headers,
@@ -72,6 +89,9 @@ export interface CloudAuthAdapter {
72
89
  emailChangeAvailable: boolean
73
90
  profile(headers: Headers): Promise<CloudAccountProfile | null>
74
91
  updateProfile(headers: Headers, input: { name: string }): Promise<void>
92
+ /** The language Cloud writes to the account in, as the app says it uses. */
93
+ /** Takes the app's language tag; the server keeps the nearest language it writes in. */
94
+ setLocale(headers: Headers, locale: string): Promise<void>
75
95
  /** Sends the confirmation to the new address and tells the old one which address it is. */
76
96
  changeEmail(headers: Headers, input: { newEmail: string; callbackURL: string }): Promise<void>
77
97
  sessions(headers: Headers): Promise<CloudAccountSession[] | null>
@@ -1,4 +1,4 @@
1
- import type { TwoStepChange } from '#cloud/email'
1
+ import type { EmailLocale, TwoStepChange } from '#cloud/email'
2
2
  import type { TransactionalEmailService } from '#cloud/server/email'
3
3
  import { sha256 } from '@noble/hashes/sha2.js'
4
4
  import { bytesToHex, utf8ToBytes } from '@noble/hashes/utils.js'
@@ -10,6 +10,8 @@ export type AuthenticationEmailService = {
10
10
  url: string
11
11
  token: string
12
12
  purpose?: 'account' | 'change'
13
+ /** The account's own language, or null for none; nothing is looked up, as sign-up needs. */
14
+ locale?: EmailLocale | null
13
15
  }): Promise<void>
14
16
  sendPasswordReset(input: {
15
17
  email: string
@@ -62,6 +64,7 @@ export function createAuthenticationEmailService(
62
64
  idempotencyKey: `email-verification/${input.email.toLowerCase()}/${tokenHash(input.token)}`,
63
65
  kind: 'email-verification',
64
66
  recipientEmail: input.email,
67
+ recipientLocale: input.locale ?? null,
65
68
  payload: { name: input.name, actionURL: input.url, purpose: input.purpose }
66
69
  })
67
70
  },
@@ -0,0 +1,116 @@
1
+ import type { EnrollmentService } from '#cloud/admin/enrollment/service'
2
+ import { cloudLanguageTagSchema } from '#cloud/contract'
3
+ import { acceptedLocale, emailLocale, isEmailLocale, type EmailLocale } from '#cloud/email'
4
+ import { accountDeletionOptions } from '#cloud/server/account/deletion'
5
+ import type { CloudServerConfig } from '#cloud/server/config'
6
+ import type { CloudDatabase } from '#cloud/server/db'
7
+ import type { BetterAuthOptions } from 'better-auth'
8
+ import type { Kysely } from 'kysely'
9
+ import * as v from 'valibot'
10
+
11
+ import type { AuthenticationEmailService } from './email'
12
+
13
+ /** The language an account writes in, which Better Auth's types don't know it has. */
14
+ function accountLocale(user: object): EmailLocale | null {
15
+ return 'locale' in user && isEmailLocale(user.locale) ? user.locale : null
16
+ }
17
+
18
+ /** The language tag the app sent, if any, before it's matched to one Cloud writes in. */
19
+ function languageTag(user: object): string | null {
20
+ return 'locale' in user && typeof user.locale === 'string' ? user.locale : null
21
+ }
22
+
23
+ /**
24
+ * Who may join and when an account counts as enrolled: addresses are verified before an account
25
+ * asks for approval or binds an approved invitation, and a closed deployment creates no accounts.
26
+ */
27
+ export function enrollmentOptions(
28
+ config: CloudServerConfig,
29
+ database: Kysely<CloudDatabase>,
30
+ enrollment: EnrollmentService,
31
+ authenticationEmail: AuthenticationEmailService | undefined,
32
+ emailChangeAvailable: boolean
33
+ ) {
34
+ async function enroll(user: { id: string; email: string; name: string }) {
35
+ if (config.enrollmentMode === 'approval') {
36
+ await enrollment.request({ email: user.email, name: user.name })
37
+ }
38
+ await enrollment.bindApprovedUser(user.email, user.id)
39
+ }
40
+
41
+ return {
42
+ emailVerification:
43
+ config.emailPasswordEnabled && authenticationEmail
44
+ ? {
45
+ expiresIn: config.emailVerificationExpiresIn,
46
+ sendOnSignUp: true,
47
+ // Signing in unverified only says so; people ask for another link with Send again.
48
+ sendOnSignIn: false,
49
+ autoSignInAfterVerification: true,
50
+ // A change of address sends the link to the new address as `user.email`, on the
51
+ // account it already confirmed; a new account has not confirmed one yet. This runs
52
+ // inside sign-up's transaction, so it must not query the database itself.
53
+ sendVerificationEmail: ({ user, url, token }) =>
54
+ authenticationEmail.sendVerification({
55
+ email: user.email,
56
+ name: user.name,
57
+ url,
58
+ token,
59
+ purpose: user.emailVerified ? 'change' : 'account',
60
+ // The account carries its language, so nothing is looked up in the transaction.
61
+ locale: accountLocale(user)
62
+ }),
63
+ afterEmailVerification: async (user) => {
64
+ await enrollment.followEmailChange(user.id, user.email)
65
+ await enroll(user)
66
+ }
67
+ }
68
+ : undefined,
69
+ user: {
70
+ additionalFields: {
71
+ // The language Cloud writes to the account in: the app's, sent when signing up and
72
+ // whenever the person changes it, as the nearest language Cloud has (the hooks below).
73
+ locale: {
74
+ type: 'string' as const,
75
+ required: false,
76
+ input: true,
77
+ validator: { input: v.nullish(cloudLanguageTagSchema) }
78
+ }
79
+ },
80
+ changeEmail: { enabled: emailChangeAvailable },
81
+ deleteUser: accountDeletionOptions(database),
82
+ validateUserInfo: ({ source }) => {
83
+ if (source.action === 'create-user' && config.enrollmentMode === 'closed') {
84
+ return { error: 'enrollment_closed', errorDescription: 'Cloud enrollment is closed' }
85
+ }
86
+ return undefined
87
+ }
88
+ },
89
+ databaseHooks: {
90
+ user: {
91
+ create: {
92
+ // The app's language, or for an account it didn't name one for, as one made through
93
+ // Google or Apple, the browser's. A language Cloud doesn't write in reads English.
94
+ before: async (user, context) => {
95
+ const tag = languageTag(user)
96
+ const locale = tag
97
+ ? emailLocale([tag])
98
+ : acceptedLocale(context?.headers?.get('accept-language'))
99
+ return { data: { ...user, locale } }
100
+ },
101
+ after: async (user) => {
102
+ if (user.emailVerified) await enroll(user)
103
+ }
104
+ },
105
+ update: {
106
+ // Whoever changes it, Cloud keeps the nearest language it writes in, or English.
107
+ before: async (user) => {
108
+ if (!('locale' in user)) return undefined
109
+ const tag = languageTag(user)
110
+ return { data: { ...user, locale: emailLocale(tag ? [tag] : []) } }
111
+ }
112
+ }
113
+ }
114
+ }
115
+ } satisfies Pick<BetterAuthOptions, 'emailVerification' | 'user' | 'databaseHooks'>
116
+ }