@open-pencil/cloud 0.0.0-stage → 0.17.0-beta.1

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 (279) hide show
  1. package/LICENSE +202 -0
  2. package/LICENSE-MIT +21 -0
  3. package/NOTICE +7 -0
  4. package/README.md +37 -2
  5. package/dist/bin/ai-relay.d.mts +1 -0
  6. package/dist/bin/ai-relay.mjs +31 -0
  7. package/dist/bin/ai-relay.mjs.map +1 -0
  8. package/dist/bin/server.d.mts +1 -0
  9. package/dist/bin/server.mjs +29 -0
  10. package/dist/bin/server.mjs.map +1 -0
  11. package/dist/client.d.ts +1520 -0
  12. package/dist/client.d.ts.map +1 -0
  13. package/dist/client.js +1917 -0
  14. package/dist/client.js.map +1 -0
  15. package/dist/contract.d.ts +2 -0
  16. package/dist/contract.js +2 -0
  17. package/dist/contract2.js +1453 -0
  18. package/dist/contract2.js.map +1 -0
  19. package/dist/email.d.ts +169 -0
  20. package/dist/email.d.ts.map +1 -0
  21. package/dist/email.js +670 -0
  22. package/dist/email.js.map +1 -0
  23. package/dist/index.d.ts +1755 -0
  24. package/dist/index.d.ts.map +1 -0
  25. package/dist/listen.mjs +1881 -0
  26. package/dist/listen.mjs.map +1 -0
  27. package/dist/runtime-node.d.mts +10040 -0
  28. package/dist/runtime-node.d.mts.map +1 -0
  29. package/dist/runtime-node.mjs +32 -0
  30. package/dist/runtime-node.mjs.map +1 -0
  31. package/dist/server.d.ts +12792 -0
  32. package/dist/server.d.ts.map +1 -0
  33. package/dist/server.js +8475 -0
  34. package/dist/server.js.map +1 -0
  35. package/dist/server.mjs +8324 -0
  36. package/dist/server.mjs.map +1 -0
  37. package/dist/server2.mjs +505 -0
  38. package/dist/server2.mjs.map +1 -0
  39. package/package.json +124 -4
  40. package/src/admin/api/routes.ts +223 -0
  41. package/src/admin/api/security.ts +12 -0
  42. package/src/admin/audit/service.ts +138 -0
  43. package/src/admin/email/service.ts +140 -0
  44. package/src/admin/enrollment/email.ts +77 -0
  45. package/src/admin/enrollment/service.ts +308 -0
  46. package/src/admin/errors.ts +20 -0
  47. package/src/admin/index.ts +19 -0
  48. package/src/admin/list.ts +61 -0
  49. package/src/admin/operations/service.ts +70 -0
  50. package/src/admin/schema.ts +28 -0
  51. package/src/admin/users/service.ts +369 -0
  52. package/src/ai-relay/app.ts +251 -0
  53. package/src/ai-relay/config.ts +120 -0
  54. package/src/ai-relay/db/index.ts +10 -0
  55. package/src/ai-relay/db/migrate.ts +32 -0
  56. package/src/ai-relay/db/migrations/001_usage.ts +26 -0
  57. package/src/ai-relay/db/schema.ts +20 -0
  58. package/src/ai-relay/index.ts +18 -0
  59. package/src/ai-relay/metering.ts +68 -0
  60. package/src/ai-relay/usage.ts +115 -0
  61. package/src/client/ai.ts +96 -0
  62. package/src/client/api.ts +528 -0
  63. package/src/client/auth/client.ts +188 -0
  64. package/src/client/auth/failure.ts +54 -0
  65. package/src/client/auth/navigation.ts +45 -0
  66. package/src/client/device-authorization.ts +134 -0
  67. package/src/client/discovery.ts +105 -0
  68. package/src/client/images.ts +81 -0
  69. package/src/client/index.ts +53 -0
  70. package/src/client/portal/account.ts +183 -0
  71. package/src/client/portal/administration.ts +130 -0
  72. package/src/client/portal/client.ts +18 -0
  73. package/src/client/portal/request.ts +115 -0
  74. package/src/client/response.ts +51 -0
  75. package/src/client/workspaces.ts +142 -0
  76. package/src/contract/account.ts +204 -0
  77. package/src/contract/admin/index.ts +187 -0
  78. package/src/contract/ai.ts +150 -0
  79. package/src/contract/collaboration.ts +45 -0
  80. package/src/contract/discovery.ts +81 -0
  81. package/src/contract/documents.ts +265 -0
  82. package/src/contract/entitlements.ts +28 -0
  83. package/src/contract/index.ts +204 -0
  84. package/src/contract/links.ts +87 -0
  85. package/src/contract/portal.ts +11 -0
  86. package/src/contract/relay.ts +368 -0
  87. package/src/contract/sharing.ts +191 -0
  88. package/src/contract/versions.ts +87 -0
  89. package/src/contract/workspaces.ts +100 -0
  90. package/src/email/index.ts +14 -0
  91. package/src/email/render.ts +276 -0
  92. package/src/email/schema.ts +144 -0
  93. package/src/email/templates/brand.ts +105 -0
  94. package/src/email/templates/document-invitation.ts +35 -0
  95. package/src/email/templates/enrollment.ts +27 -0
  96. package/src/email/templates/layout.ts +18 -0
  97. package/src/runtime/cloudflare/email.ts +70 -0
  98. package/src/runtime/cloudflare/environment.ts +57 -0
  99. package/src/runtime/cloudflare/index.ts +3 -0
  100. package/src/runtime/cloudflare/relay.ts +136 -0
  101. package/src/runtime/cloudflare/site.ts +13 -0
  102. package/src/runtime/cloudflare/tsconfig.json +21 -0
  103. package/src/runtime/cloudflare/worker.ts +160 -0
  104. package/src/runtime/node/admin.ts +59 -0
  105. package/src/runtime/node/ai-relay/main.ts +35 -0
  106. package/src/runtime/node/ai-relay/server.ts +63 -0
  107. package/src/runtime/node/application.ts +50 -0
  108. package/src/runtime/node/bootstrap.ts +22 -0
  109. package/src/runtime/node/cleanup.ts +24 -0
  110. package/src/runtime/node/command.ts +17 -0
  111. package/src/runtime/node/config.ts +16 -0
  112. package/src/runtime/node/email/runtime.ts +43 -0
  113. package/src/runtime/node/email/transport.ts +112 -0
  114. package/src/runtime/node/entitlements/main.ts +41 -0
  115. package/src/runtime/node/entitlements/refusal.ts +15 -0
  116. package/src/runtime/node/index.ts +25 -0
  117. package/src/runtime/node/listen.ts +35 -0
  118. package/src/runtime/node/main.ts +29 -0
  119. package/src/runtime/node/migrate.ts +13 -0
  120. package/src/runtime/node/quota-reconcile.ts +9 -0
  121. package/src/runtime/node/relay.ts +54 -0
  122. package/src/runtime/node/server.ts +121 -0
  123. package/src/runtime/node/site.ts +64 -0
  124. package/src/runtime/postgres/database.ts +19 -0
  125. package/src/runtime/s3/objects.ts +244 -0
  126. package/src/runtime/site/server.ts +82 -0
  127. package/src/server/account/actions.ts +66 -0
  128. package/src/server/account/routes.ts +300 -0
  129. package/src/server/ai/errors.ts +7 -0
  130. package/src/server/ai/index.ts +4 -0
  131. package/src/server/ai/keys.ts +43 -0
  132. package/src/server/ai/routes.ts +43 -0
  133. package/src/server/ai/service.ts +70 -0
  134. package/src/server/api/index.ts +8 -0
  135. package/src/server/api/router.ts +117 -0
  136. package/src/server/api/types.ts +7 -0
  137. package/src/server/app.ts +375 -0
  138. package/src/server/auth/account.ts +73 -0
  139. package/src/server/auth/activity.ts +213 -0
  140. package/src/server/auth/adapter.ts +79 -0
  141. package/src/server/auth/email.ts +125 -0
  142. package/src/server/auth/endpoints.ts +57 -0
  143. package/src/server/auth/factory.ts +583 -0
  144. package/src/server/auth/index.ts +17 -0
  145. package/src/server/auth/mfa-assurance.ts +55 -0
  146. package/src/server/auth/runtime.ts +26 -0
  147. package/src/server/auth/session.ts +19 -0
  148. package/src/server/auth/social-providers.ts +55 -0
  149. package/src/server/auth/user-agent.ts +16 -0
  150. package/src/server/auth/workspace-access.ts +23 -0
  151. package/src/server/cleanup/configured.ts +38 -0
  152. package/src/server/cleanup/documents.ts +231 -0
  153. package/src/server/cleanup/index.ts +29 -0
  154. package/src/server/cleanup/objects.ts +27 -0
  155. package/src/server/cleanup/revisions.ts +232 -0
  156. package/src/server/cleanup/uploads.ts +129 -0
  157. package/src/server/cleanup/worker.ts +79 -0
  158. package/src/server/collaboration/index.ts +28 -0
  159. package/src/server/collaboration/relay/authorize.ts +53 -0
  160. package/src/server/collaboration/relay/awareness.ts +104 -0
  161. package/src/server/collaboration/relay/documents.ts +39 -0
  162. package/src/server/collaboration/relay/hub.ts +524 -0
  163. package/src/server/collaboration/relay/index.ts +15 -0
  164. package/src/server/collaboration/relay/persistence.ts +48 -0
  165. package/src/server/collaboration/routes.ts +77 -0
  166. package/src/server/collaboration/service.ts +188 -0
  167. package/src/server/config/deployment.ts +178 -0
  168. package/src/server/config/index.ts +20 -0
  169. package/src/server/config/limits.ts +8 -0
  170. package/src/server/config/public.ts +66 -0
  171. package/src/server/config/schema.ts +512 -0
  172. package/src/server/db/database.ts +15 -0
  173. package/src/server/db/expressions.ts +13 -0
  174. package/src/server/db/index.ts +21 -0
  175. package/src/server/db/migrate.ts +177 -0
  176. package/src/server/db/migrations/001_foundation.ts +164 -0
  177. package/src/server/db/migrations/002_upload_cleanup_claims.ts +34 -0
  178. package/src/server/db/migrations/003_document_cleanup_claims.ts +23 -0
  179. package/src/server/db/migrations/004_document_sharing.ts +82 -0
  180. package/src/server/db/migrations/005_document_collaboration_epoch.ts +13 -0
  181. package/src/server/db/migrations/006_invitation_continuation.ts +27 -0
  182. package/src/server/db/migrations/007_collaboration_state.ts +25 -0
  183. package/src/server/db/migrations/008_storage_reservations.ts +37 -0
  184. package/src/server/db/migrations/009_workspace_entitlements.ts +22 -0
  185. package/src/server/db/migrations/010_upload_finalization.ts +22 -0
  186. package/src/server/db/migrations/011_upload_finalization_lease.ts +12 -0
  187. package/src/server/db/migrations/012_transactional_email.ts +48 -0
  188. package/src/server/db/migrations/013_admin_enrollment.ts +54 -0
  189. package/src/server/db/migrations/014_enrollment_email_kinds.ts +30 -0
  190. package/src/server/db/migrations/015_cloud_rate_limit.ts +22 -0
  191. package/src/server/db/migrations/016_auth_schema.ts +16 -0
  192. package/src/server/db/migrations/017_authentication_email_kinds.ts +32 -0
  193. package/src/server/db/migrations/018_authentication_mfa.ts +78 -0
  194. package/src/server/db/migrations/019_better_auth_account_issuer.ts +42 -0
  195. package/src/server/db/migrations/020_workspace_invitations.ts +57 -0
  196. package/src/server/db/migrations/021_document_versions.ts +66 -0
  197. package/src/server/db/migrations/022_entitlement_external_version.ts +17 -0
  198. package/src/server/db/migrations/023_document_images.ts +61 -0
  199. package/src/server/db/migrations/024_account_activity.ts +66 -0
  200. package/src/server/db/migrations/025_table_names.ts +58 -0
  201. package/src/server/db/migrations/026_user_picture.ts +30 -0
  202. package/src/server/db/migrations/027_document_kind.ts +19 -0
  203. package/src/server/db/migrations/helpers.ts +78 -0
  204. package/src/server/db/tables.ts +394 -0
  205. package/src/server/documents/access.ts +103 -0
  206. package/src/server/documents/errors.ts +16 -0
  207. package/src/server/documents/images.ts +407 -0
  208. package/src/server/documents/index.ts +14 -0
  209. package/src/server/documents/limits.ts +57 -0
  210. package/src/server/documents/repository.ts +141 -0
  211. package/src/server/documents/routes.ts +239 -0
  212. package/src/server/documents/service.ts +597 -0
  213. package/src/server/documents/summary.ts +37 -0
  214. package/src/server/documents/types.ts +14 -0
  215. package/src/server/documents/versions/checkpoint.ts +98 -0
  216. package/src/server/documents/versions/history.ts +25 -0
  217. package/src/server/documents/versions/index.ts +4 -0
  218. package/src/server/documents/versions/routes.ts +112 -0
  219. package/src/server/documents/versions/service.ts +397 -0
  220. package/src/server/email/crypto.ts +57 -0
  221. package/src/server/email/index.ts +18 -0
  222. package/src/server/email/invitations.ts +30 -0
  223. package/src/server/email/service.ts +245 -0
  224. package/src/server/email/types.ts +56 -0
  225. package/src/server/email/worker.ts +33 -0
  226. package/src/server/index.ts +279 -0
  227. package/src/server/internal/index.ts +8 -0
  228. package/src/server/internal/routes.ts +41 -0
  229. package/src/server/internal/schema.ts +10 -0
  230. package/src/server/internal/service.ts +44 -0
  231. package/src/server/invitations/index.ts +6 -0
  232. package/src/server/invitations/types.ts +30 -0
  233. package/src/server/objects/index.ts +16 -0
  234. package/src/server/objects/types.ts +81 -0
  235. package/src/server/pictures/index.ts +9 -0
  236. package/src/server/pictures/provider.ts +61 -0
  237. package/src/server/pictures/routes.ts +21 -0
  238. package/src/server/pictures/service.ts +235 -0
  239. package/src/server/policy/configured.ts +23 -0
  240. package/src/server/policy/database.ts +108 -0
  241. package/src/server/policy/entitlements.ts +29 -0
  242. package/src/server/policy/index.ts +17 -0
  243. package/src/server/policy/keys.ts +23 -0
  244. package/src/server/policy/policy.ts +117 -0
  245. package/src/server/policy/provider.ts +67 -0
  246. package/src/server/policy/schema.ts +69 -0
  247. package/src/server/policy/service.ts +85 -0
  248. package/src/server/policy/static.ts +62 -0
  249. package/src/server/quota/index.ts +7 -0
  250. package/src/server/quota/reconcile.ts +61 -0
  251. package/src/server/quota/storage.ts +165 -0
  252. package/src/server/rate-limit/cleanup.ts +16 -0
  253. package/src/server/rate-limit/index.ts +12 -0
  254. package/src/server/rate-limit/keys.ts +38 -0
  255. package/src/server/rate-limit/middleware.ts +137 -0
  256. package/src/server/rate-limit/postgres.ts +79 -0
  257. package/src/server/sharing/access.ts +29 -0
  258. package/src/server/sharing/actor.ts +12 -0
  259. package/src/server/sharing/capabilities/service.ts +262 -0
  260. package/src/server/sharing/continuation.ts +85 -0
  261. package/src/server/sharing/contracts.ts +80 -0
  262. package/src/server/sharing/crypto.ts +48 -0
  263. package/src/server/sharing/document-routes.ts +41 -0
  264. package/src/server/sharing/errors.ts +12 -0
  265. package/src/server/sharing/grants/service.ts +79 -0
  266. package/src/server/sharing/http.ts +41 -0
  267. package/src/server/sharing/index.ts +39 -0
  268. package/src/server/sharing/invitations/service.ts +315 -0
  269. package/src/server/sharing/policy.ts +44 -0
  270. package/src/server/sharing/routes.ts +251 -0
  271. package/src/server/sharing/service.ts +117 -0
  272. package/src/server/validation.ts +24 -0
  273. package/src/server/worker/interval.ts +23 -0
  274. package/src/server/worker/periodic.ts +42 -0
  275. package/src/server/workspaces/index.ts +16 -0
  276. package/src/server/workspaces/members.ts +502 -0
  277. package/src/server/workspaces/repository.ts +91 -0
  278. package/src/server/workspaces/routes.ts +198 -0
  279. package/src/server/workspaces/service.ts +84 -0
@@ -0,0 +1,50 @@
1
+ import { createPostgresCloudDatabase } from '#cloud/runtime/postgres/database'
2
+ import { createS3ObjectStore } from '#cloud/runtime/s3/objects'
3
+ import {
4
+ createCloudAuthenticationRuntime,
5
+ createCloudApp,
6
+ loadAISigningKey,
7
+ type CloudApp,
8
+ type CloudEnvironment,
9
+ type CloudServerConfig,
10
+ type ObjectStore
11
+ } from '#cloud/server'
12
+
13
+ import { loadNodeCloudServerConfig } from './config'
14
+ import { createNodeTransactionalEmailRuntime } from './email/runtime'
15
+
16
+ export type NodeCloudApplicationOptions = {
17
+ environment?: CloudEnvironment
18
+ databaseURL?: string
19
+ }
20
+
21
+ export async function createNodeCloudApplication(
22
+ options: NodeCloudApplicationOptions = {}
23
+ ): Promise<{
24
+ app: CloudApp
25
+ config: CloudServerConfig
26
+ database: ReturnType<typeof createPostgresCloudDatabase>
27
+ objects: ObjectStore
28
+ email: ReturnType<typeof createNodeTransactionalEmailRuntime>['email']
29
+ }> {
30
+ const environment = options.environment ?? process.env
31
+ const config = await loadNodeCloudServerConfig(environment)
32
+ const aiSigningKey = await loadAISigningKey(config)
33
+ const database = createPostgresCloudDatabase({
34
+ connectionString: options.databaseURL ?? config.databaseURL
35
+ })
36
+ const objects = createS3ObjectStore(config)
37
+ const { email, invitationOutbox } = createNodeTransactionalEmailRuntime(config, database)
38
+ const { auth, enrollment } = createCloudAuthenticationRuntime(config, database, email)
39
+ const app = createCloudApp({
40
+ config,
41
+ database,
42
+ auth,
43
+ objects,
44
+ invitationOutbox,
45
+ transactionalEmail: email,
46
+ enrollment,
47
+ aiSigningKey
48
+ })
49
+ return { app, config, database, objects, email }
50
+ }
@@ -0,0 +1,22 @@
1
+ import { createPostgresCloudDatabase } from '#cloud/runtime/postgres/database'
2
+ import {
3
+ createBetterAuthAdapter,
4
+ migrateCloudDatabase,
5
+ type CloudServerConfig
6
+ } from '#cloud/server'
7
+
8
+ import { loadNodeCloudServerConfig } from './config'
9
+
10
+ export async function createMigratedNodeCloudDatabase(
11
+ environment: Readonly<Record<string, string | undefined>>
12
+ ): Promise<{
13
+ config: CloudServerConfig
14
+ database: ReturnType<typeof createPostgresCloudDatabase>
15
+ auth: ReturnType<typeof createBetterAuthAdapter>
16
+ }> {
17
+ const config = await loadNodeCloudServerConfig(environment)
18
+ const database = createPostgresCloudDatabase({ connectionString: config.databaseURL })
19
+ const auth = createBetterAuthAdapter(config, database)
20
+ await migrateCloudDatabase(database, { run: auth.migrate, schemaVersion: auth.schemaVersion })
21
+ return { config, database, auth }
22
+ }
@@ -0,0 +1,24 @@
1
+ import { createPostgresCloudDatabase } from '#cloud/runtime/postgres/database'
2
+ import { createS3ObjectStore } from '#cloud/runtime/s3/objects'
3
+ import {
4
+ cleanupPassOptions,
5
+ createCleanupServices,
6
+ createConfiguredCloudPolicy,
7
+ runCleanup
8
+ } from '#cloud/server'
9
+
10
+ import { loadNodeCloudServerConfig } from './config'
11
+
12
+ const config = await loadNodeCloudServerConfig(process.env)
13
+ const database = createPostgresCloudDatabase({ connectionString: config.databaseURL })
14
+ const objects = createS3ObjectStore(config)
15
+ try {
16
+ const policy = createConfiguredCloudPolicy(config, database)
17
+ const result = await runCleanup(
18
+ createCleanupServices(config, database, objects, policy),
19
+ cleanupPassOptions(config)
20
+ )
21
+ console.log(JSON.stringify(result))
22
+ } finally {
23
+ await database.destroy()
24
+ }
@@ -0,0 +1,17 @@
1
+ import { createMigratedNodeCloudDatabase } from './bootstrap'
2
+
3
+ type MigratedNodeCloudDatabase = Awaited<ReturnType<typeof createMigratedNodeCloudDatabase>>
4
+
5
+ export async function withNodeCloudDatabase<T>(
6
+ operation: (
7
+ database: MigratedNodeCloudDatabase['database'],
8
+ config: MigratedNodeCloudDatabase['config']
9
+ ) => Promise<T>
10
+ ): Promise<T> {
11
+ const { config, database } = await createMigratedNodeCloudDatabase(process.env)
12
+ try {
13
+ return await operation(database, config)
14
+ } finally {
15
+ await database.destroy()
16
+ }
17
+ }
@@ -0,0 +1,16 @@
1
+ import { readFile } from 'node:fs/promises'
2
+
3
+ import {
4
+ CloudConfigError,
5
+ parseCloudDeploymentTOML,
6
+ type CloudEnvironment,
7
+ type CloudServerConfig
8
+ } from '#cloud/server'
9
+
10
+ export async function loadNodeCloudServerConfig(
11
+ environment: CloudEnvironment
12
+ ): Promise<CloudServerConfig> {
13
+ const path = environment.OPENPENCIL_CLOUD_CONFIG
14
+ if (!path) throw new CloudConfigError('OPENPENCIL_CLOUD_CONFIG must name a deployment TOML file')
15
+ return parseCloudDeploymentTOML(await readFile(path, 'utf8'), environment)
16
+ }
@@ -0,0 +1,43 @@
1
+ import {
2
+ createInvitationOutbox,
3
+ createTransactionalEmailService,
4
+ type CloudServerConfig,
5
+ type TransactionalEmailService,
6
+ type TransactionalEmailTransport
7
+ } from '#cloud/server'
8
+ import type { CloudDatabase } from '#cloud/server/db'
9
+ import type { Kysely } from 'kysely'
10
+
11
+ import { createSMTPTransactionalEmailTransport } from './transport'
12
+
13
+ export type NodeTransactionalEmailRuntime = {
14
+ email: TransactionalEmailService
15
+ transport?: TransactionalEmailTransport
16
+ invitationOutbox?: ReturnType<typeof createInvitationOutbox>
17
+ }
18
+
19
+ export function createNodeTransactionalEmailRuntime(
20
+ config: CloudServerConfig,
21
+ database: Kysely<CloudDatabase>
22
+ ): NodeTransactionalEmailRuntime {
23
+ const transport =
24
+ config.emailTransport === 'smtp' && config.smtpHost && config.smtpPort
25
+ ? createSMTPTransactionalEmailTransport({
26
+ host: config.smtpHost,
27
+ port: config.smtpPort,
28
+ secure: config.smtpSecure ?? config.smtpPort === 465,
29
+ user: config.smtpUser,
30
+ password: config.smtpPassword
31
+ })
32
+ : undefined
33
+ const email = createTransactionalEmailService(database, {
34
+ encryptionSecret: config.authSecret,
35
+ from: config.emailFrom ?? '',
36
+ transport
37
+ })
38
+ return {
39
+ email,
40
+ transport,
41
+ invitationOutbox: transport ? createInvitationOutbox(email) : undefined
42
+ }
43
+ }
@@ -0,0 +1,112 @@
1
+ import { renderTransactionalEmail } from '#cloud/email'
2
+ import type { TransactionalEmailTransport } from '#cloud/server/email'
3
+ import type { DocumentInvitationMessage, InvitationDelivery } from '#cloud/server/invitations'
4
+ import nodemailer, { type Transporter } from 'nodemailer'
5
+ import type Mail from 'nodemailer/lib/mailer/index.js'
6
+
7
+ export type NodemailerTransporter = {
8
+ sendMail(mail: Mail.Options): Promise<unknown>
9
+ }
10
+
11
+ export type NodemailerTransactionalEmailTransportOptions = {
12
+ transporter: NodemailerTransporter
13
+ }
14
+
15
+ export function createNodemailerTransactionalEmailTransport(
16
+ options: NodemailerTransactionalEmailTransportOptions
17
+ ): TransactionalEmailTransport {
18
+ return {
19
+ id: 'smtp',
20
+ async send(message) {
21
+ const result = (await options.transporter.sendMail({
22
+ from: message.from,
23
+ to: message.to,
24
+ subject: message.subject,
25
+ html: message.html,
26
+ text: message.text,
27
+ headers: message.headers,
28
+ messageId: `<${message.deliveryId}@openpencil.cloud>`
29
+ })) as { messageId?: unknown }
30
+ if (typeof result.messageId !== 'string') {
31
+ throw new TypeError('SMTP transport returned no message ID')
32
+ }
33
+ return {
34
+ transportMessageId: result.messageId,
35
+ acceptedAt: new Date().toISOString()
36
+ }
37
+ }
38
+ }
39
+ }
40
+
41
+ export type SMTPTransactionalEmailTransportOptions = {
42
+ host: string
43
+ port: number
44
+ secure: boolean
45
+ user?: string
46
+ password?: string
47
+ }
48
+
49
+ function createSMTPTransporter(options: SMTPTransactionalEmailTransportOptions): Transporter {
50
+ return nodemailer.createTransport({
51
+ host: options.host,
52
+ port: options.port,
53
+ secure: options.secure,
54
+ connectionTimeout: 10_000,
55
+ greetingTimeout: 10_000,
56
+ socketTimeout: 30_000,
57
+ auth:
58
+ options.user && options.password ? { user: options.user, pass: options.password } : undefined
59
+ })
60
+ }
61
+
62
+ export function createSMTPTransactionalEmailTransport(
63
+ options: SMTPTransactionalEmailTransportOptions
64
+ ): TransactionalEmailTransport {
65
+ return createNodemailerTransactionalEmailTransport({
66
+ transporter: createSMTPTransporter(options)
67
+ })
68
+ }
69
+
70
+ export type NodemailerInvitationDeliveryOptions = NodemailerTransactionalEmailTransportOptions & {
71
+ from: string
72
+ }
73
+
74
+ export function createNodemailerInvitationDelivery(
75
+ options: NodemailerInvitationDeliveryOptions
76
+ ): InvitationDelivery {
77
+ const transport = createNodemailerTransactionalEmailTransport(options)
78
+ return {
79
+ async sendDocumentInvitation(message: DocumentInvitationMessage): Promise<void> {
80
+ const rendered = await renderTransactionalEmail({
81
+ kind: 'document-invitation',
82
+ payload: {
83
+ inviterName: message.inviterName,
84
+ documentName: message.documentName,
85
+ permission: message.permission,
86
+ expiresAt: message.expiresAt,
87
+ acceptanceURL: message.acceptanceURL
88
+ }
89
+ })
90
+ await transport.send({
91
+ deliveryId: message.deliveryId,
92
+ from: options.from,
93
+ to: message.recipientEmail,
94
+ ...rendered,
95
+ headers: { 'X-OpenPencil-Delivery-ID': message.deliveryId }
96
+ })
97
+ }
98
+ }
99
+ }
100
+
101
+ export type SMTPInvitationDeliveryOptions = SMTPTransactionalEmailTransportOptions & {
102
+ from: string
103
+ }
104
+
105
+ export function createSMTPInvitationDelivery(
106
+ options: SMTPInvitationDeliveryOptions
107
+ ): InvitationDelivery {
108
+ return createNodemailerInvitationDelivery({
109
+ transporter: createSMTPTransporter(options),
110
+ from: options.from
111
+ })
112
+ }
@@ -0,0 +1,41 @@
1
+ import { readFile } from 'node:fs/promises'
2
+
3
+ import { createWorkspaceEntitlementRepository, parseStaticEntitlementsTOML } from '#cloud/server'
4
+ import { parse as parseTOML } from 'smol-toml'
5
+
6
+ import { withNodeCloudDatabase } from '../command'
7
+ import { entitlementWriteRefusal } from './refusal'
8
+
9
+ const operation = process.argv[2]
10
+ const workspaceIndex = process.argv.indexOf('--workspace')
11
+ const fileIndex = process.argv.indexOf('--file')
12
+ const dryRun = process.argv.includes('--dry-run')
13
+ const workspaceId = workspaceIndex !== -1 ? process.argv[workspaceIndex + 1] : undefined
14
+ if (!workspaceId) throw new Error('Expected --workspace <uuid>')
15
+
16
+ await withNodeCloudDatabase(async (database, config) => {
17
+ const repository = createWorkspaceEntitlementRepository(database)
18
+ const refusal = entitlementWriteRefusal(config, operation, dryRun)
19
+ if (refusal) throw new Error(refusal)
20
+ if (operation === 'get') {
21
+ console.log(JSON.stringify({ entitlement: await repository.get(workspaceId) }))
22
+ } else if (operation === 'clear') {
23
+ if (dryRun) {
24
+ console.log(JSON.stringify({ dryRun, cleared: false, workspaceId }))
25
+ return
26
+ }
27
+ await repository.clear(workspaceId)
28
+ console.log(JSON.stringify({ cleared: true, workspaceId }))
29
+ } else if (operation === 'set') {
30
+ const file = fileIndex !== -1 ? process.argv[fileIndex + 1] : undefined
31
+ if (!file) throw new Error('Expected --file <path>')
32
+ const values = parseStaticEntitlementsTOML(parseTOML(await readFile(file, 'utf8')))
33
+ if (dryRun) {
34
+ console.log(JSON.stringify({ dryRun, workspaceId, values }))
35
+ return
36
+ }
37
+ console.log(JSON.stringify({ entitlement: await repository.set(workspaceId, values, 'cli') }))
38
+ } else {
39
+ throw new Error('Expected operation: get, set, or clear')
40
+ }
41
+ })
@@ -0,0 +1,15 @@
1
+ import type { CloudServerConfig } from '#cloud/server'
2
+
3
+ /**
4
+ * Why the `entitlements` command must not write, if it must not: with
5
+ * `[entitlements] source = "static"` the server never reads the database rows it would change.
6
+ */
7
+ export function entitlementWriteRefusal(
8
+ config: Pick<CloudServerConfig, 'staticEntitlements'>,
9
+ operation: string | undefined,
10
+ dryRun: boolean
11
+ ): string | null {
12
+ if (!config.staticEntitlements || dryRun) return null
13
+ if (operation !== 'set' && operation !== 'clear') return null
14
+ return 'Entitlements come from the static [entitlements] table in the deployment TOML; change them there'
15
+ }
@@ -0,0 +1,25 @@
1
+ export { startNodeAIRelay, type NodeAIRelayOptions } from './ai-relay/server'
2
+ export { createMigratedNodeCloudDatabase } from './bootstrap'
3
+ export { createNodeCloudApplication, type NodeCloudApplicationOptions } from './application'
4
+ export { loadNodeCloudServerConfig } from './config'
5
+ export {
6
+ createNodeTransactionalEmailRuntime,
7
+ type NodeTransactionalEmailRuntime
8
+ } from './email/runtime'
9
+ export {
10
+ createPostgresCloudDatabase,
11
+ type PostgresCloudDatabaseOptions
12
+ } from '#cloud/runtime/postgres/database'
13
+ export {
14
+ createNodemailerInvitationDelivery,
15
+ createSMTPInvitationDelivery,
16
+ createNodemailerTransactionalEmailTransport,
17
+ createSMTPTransactionalEmailTransport,
18
+ type NodemailerInvitationDeliveryOptions,
19
+ type SMTPInvitationDeliveryOptions,
20
+ type NodemailerTransactionalEmailTransportOptions,
21
+ type SMTPTransactionalEmailTransportOptions
22
+ } from './email/transport'
23
+ export { createS3ObjectStore } from '#cloud/runtime/s3/objects'
24
+ export { attachCollaborationRelay } from './relay'
25
+ export { startNodeCloudServer, type NodeCloudServerOptions } from './server'
@@ -0,0 +1,35 @@
1
+ import { createServer } from 'node:http'
2
+
3
+ import { getRequestListener } from '@hono/node-server'
4
+
5
+ /** Serves a fetch handler over Node HTTP and resolves once the port is bound. */
6
+ export async function listen(
7
+ fetch: (request: Request) => Promise<Response>,
8
+ port: number,
9
+ hostname: string
10
+ ) {
11
+ const listener = getRequestListener(fetch)
12
+ const server = createServer((request, response) => {
13
+ void listener(request, response)
14
+ })
15
+ await new Promise<void>((resolve, reject) => {
16
+ server.once('error', reject)
17
+ server.listen(port, hostname, () => {
18
+ server.off('error', reject)
19
+ resolve()
20
+ })
21
+ })
22
+ const address = server.address()
23
+ const boundPort = typeof address === 'object' && address ? address.port : port
24
+ return {
25
+ url: new URL(`http://localhost:${boundPort}`),
26
+ http: server,
27
+ close: () =>
28
+ new Promise<void>((done, fail) => {
29
+ server.close((error) => {
30
+ if (error) fail(error)
31
+ else done()
32
+ })
33
+ })
34
+ }
35
+ }
@@ -0,0 +1,29 @@
1
+ #!/usr/bin/env node
2
+ import dedent from 'dedent'
3
+
4
+ import { startNodeCloudServer } from './server'
5
+
6
+ if (process.argv.includes('--help') || process.argv.includes('-h')) {
7
+ console.log(dedent`
8
+ Usage: openpencil-cloud
9
+
10
+ Runs OpenPencil Cloud. Settings come from the environment:
11
+ OPENPENCIL_CLOUD_CONFIG the deployment TOML file (required)
12
+ OPENPENCIL_CLOUD_SITE_DIR the editor and portal build to serve
13
+ OPENPENCIL_CLOUD_DEV_SITE_URL
14
+ a Vite dev server to serve them from instead (cloud:dev)
15
+ PORT, HOST where to listen (default 8787 on 0.0.0.0)
16
+ plus the secrets the TOML names. See https://openpencil.dev/reference/self-hosting-cloud
17
+ `)
18
+ process.exit(0)
19
+ }
20
+
21
+ const cloud = await startNodeCloudServer()
22
+ console.log(`OpenPencil Cloud listening on ${cloud.url}`)
23
+
24
+ function shutdown() {
25
+ void cloud.stop().then(() => process.exit(0))
26
+ }
27
+
28
+ process.on('SIGINT', shutdown)
29
+ process.on('SIGTERM', shutdown)
@@ -0,0 +1,13 @@
1
+ import { createPostgresCloudDatabase } from '#cloud/runtime/postgres/database'
2
+ import { createBetterAuthAdapter, migrateCloudDatabase } from '#cloud/server'
3
+
4
+ import { loadNodeCloudServerConfig } from './config'
5
+
6
+ const config = await loadNodeCloudServerConfig(process.env)
7
+ const database = createPostgresCloudDatabase({ connectionString: config.databaseURL })
8
+ try {
9
+ const auth = createBetterAuthAdapter(config, database)
10
+ await migrateCloudDatabase(database, { run: auth.migrate, schemaVersion: auth.schemaVersion })
11
+ } finally {
12
+ await database.destroy()
13
+ }
@@ -0,0 +1,9 @@
1
+ import { createStorageReconciliationService } from '#cloud/server'
2
+
3
+ import { withNodeCloudDatabase } from './command'
4
+
5
+ const dryRun = process.argv.includes('--dry-run')
6
+ const results = await withNodeCloudDatabase((database) =>
7
+ createStorageReconciliationService(database).reconcile({ dryRun })
8
+ )
9
+ console.log(JSON.stringify({ dryRun, results }))
@@ -0,0 +1,54 @@
1
+ import type { IncomingMessage, Server } from 'node:http'
2
+ import type { Duplex } from 'node:stream'
3
+
4
+ import { RELAY_PATH } from '#cloud/contract'
5
+ import type { CollaborationRelay } from '#cloud/server'
6
+ import { WebSocketServer, type RawData } from 'ws'
7
+
8
+ function bytes(data: RawData): Uint8Array {
9
+ if (Array.isArray(data)) return new Uint8Array(Buffer.concat(data))
10
+ return data instanceof ArrayBuffer ? new Uint8Array(data) : new Uint8Array(data)
11
+ }
12
+
13
+ /**
14
+ * Accepts WebSocket upgrades on the relay path of an HTTP server and hands each socket to the
15
+ * relay. Other upgrade requests are refused.
16
+ */
17
+ export function attachCollaborationRelay(
18
+ server: Pick<Server, 'on' | 'off'>,
19
+ relay: CollaborationRelay,
20
+ maximumMessageBytes: number
21
+ ) {
22
+ // ws enforces the limit before buffering; the relay checks again for other runtimes.
23
+ const sockets = new WebSocketServer({ noServer: true, maxPayload: maximumMessageBytes })
24
+
25
+ function upgrade(request: IncomingMessage, socket: Duplex, head: Buffer) {
26
+ const path = new URL(request.url ?? '/', 'http://relay').pathname
27
+ if (path !== RELAY_PATH) {
28
+ socket.destroy()
29
+ return
30
+ }
31
+ sockets.handleUpgrade(request, socket, head, (webSocket) => {
32
+ webSocket.binaryType = 'nodebuffer'
33
+ const connection = relay.connect({
34
+ send: (data) => webSocket.send(data),
35
+ close: (code, reason) => webSocket.close(code, reason)
36
+ })
37
+ webSocket.on('message', (data) => connection.receive(bytes(data)))
38
+ webSocket.on('close', () => connection.closed())
39
+ webSocket.on('error', () => webSocket.terminate())
40
+ })
41
+ }
42
+
43
+ server.on('upgrade', upgrade)
44
+ return {
45
+ async close() {
46
+ server.off('upgrade', upgrade)
47
+ await relay.close()
48
+ for (const client of sockets.clients) client.terminate()
49
+ await new Promise<void>((resolve) => {
50
+ sockets.close(() => resolve())
51
+ })
52
+ }
53
+ }
54
+ }
@@ -0,0 +1,121 @@
1
+ import { defaultRelayURL } from '#cloud/contract'
2
+ import { createS3ObjectStore } from '#cloud/runtime/s3/objects'
3
+ import { createCloudServer, type SiteFiles } from '#cloud/runtime/site/server'
4
+ import {
5
+ createCloudApp,
6
+ loadAISigningKey,
7
+ createCloudAuthenticationRuntime,
8
+ createCollaborationRelay,
9
+ createCollaborationStateStore,
10
+ cleanupPassOptions,
11
+ createCleanupServices,
12
+ createConfiguredCloudPolicy,
13
+ relayDocumentLookups,
14
+ startCleanupWorker,
15
+ startTransactionalEmailWorker
16
+ } from '#cloud/server'
17
+
18
+ import { createMigratedNodeCloudDatabase } from './bootstrap'
19
+ import { createNodeTransactionalEmailRuntime } from './email/runtime'
20
+ import { listen } from './listen'
21
+ import { attachCollaborationRelay } from './relay'
22
+ import { developmentSiteFiles, nodeSiteFiles } from './site'
23
+
24
+ export type NodeCloudServerOptions = {
25
+ environment?: Readonly<Record<string, string | undefined>>
26
+ port?: number
27
+ }
28
+
29
+ /** The site the server serves: a build, or in `cloud:dev` a development server's source. */
30
+ function siteFiles(
31
+ environment: Readonly<Record<string, string | undefined>>
32
+ ): SiteFiles | undefined {
33
+ const developmentSite = environment.OPENPENCIL_CLOUD_DEV_SITE_URL
34
+ if (developmentSite) return developmentSiteFiles(developmentSite)
35
+ const siteDirectory = environment.OPENPENCIL_CLOUD_SITE_DIR
36
+ if (siteDirectory) return nodeSiteFiles(siteDirectory)
37
+ console.warn(
38
+ '[Cloud] OPENPENCIL_CLOUD_SITE_DIR is not set; the editor and sign-in pages are off.'
39
+ )
40
+ return undefined
41
+ }
42
+
43
+ export async function startNodeCloudServer(options: NodeCloudServerOptions = {}) {
44
+ const environment = options.environment ?? process.env
45
+ const { config, database } = await createMigratedNodeCloudDatabase(environment)
46
+ // Before any worker starts, so a key that cannot sign leaves nothing running.
47
+ const aiSigningKey = await loadAISigningKey(config).catch(async (error: unknown) => {
48
+ await database.destroy()
49
+ throw error
50
+ })
51
+ const objects = createS3ObjectStore(config)
52
+ const {
53
+ email,
54
+ invitationOutbox,
55
+ transport: emailTransport
56
+ } = createNodeTransactionalEmailRuntime(config, database)
57
+ const { auth, enrollment } = createCloudAuthenticationRuntime(config, database, email)
58
+ const policy = createConfiguredCloudPolicy(config, database)
59
+ const cleanup = config.cleanupEnabled
60
+ ? startCleanupWorker(createCleanupServices(config, database, objects, policy), {
61
+ ...cleanupPassOptions(config),
62
+ intervalMs: config.cleanupIntervalMs,
63
+ onError: (error) => console.error('[Cloud] Cleanup worker failed:', error)
64
+ })
65
+ : undefined
66
+ const relay = createCollaborationRelay({
67
+ authSecret: config.authSecret,
68
+ store: createCollaborationStateStore(database),
69
+ maximumMessageBytes: config.technicalLimits.maximumCollaborationMessageBytes,
70
+ maximumConnectionsPerRoom: config.technicalLimits.maximumConnectionsPerRoom,
71
+ ...relayDocumentLookups(database, policy, config.deployment)
72
+ })
73
+ const app = createCloudApp({
74
+ config,
75
+ database,
76
+ auth,
77
+ objects,
78
+ invitationOutbox,
79
+ transactionalEmail: email,
80
+ enrollment,
81
+ aiSigningKey,
82
+ relayURL: config.relayURL ?? defaultRelayURL(config.publicURL),
83
+ onDocumentRestored: (documentId) => relay.startOver(documentId),
84
+ onDocumentVersionsChanged: (documentId) => relay.announceVersions(documentId)
85
+ })
86
+ const emailWorker = emailTransport
87
+ ? startTransactionalEmailWorker(email, {
88
+ batchSize: config.emailBatchSize,
89
+ intervalMs: config.emailIntervalMs,
90
+ leaseDurationMs: config.emailLeaseDurationMs,
91
+ maximumAttempts: config.emailMaximumAttempts,
92
+ onError: (error) => console.error('[Cloud] Email worker failed:', error)
93
+ })
94
+ : undefined
95
+ const cloudServer = createCloudServer(app, {
96
+ site: siteFiles(environment),
97
+ indexingPolicy: config.indexingPolicy
98
+ })
99
+ const server = await listen(
100
+ async (request) => cloudServer.fetch(request),
101
+ options.port ?? Number(environment.PORT ?? 8787),
102
+ environment.HOST ?? '0.0.0.0'
103
+ )
104
+ const relayListener = attachCollaborationRelay(
105
+ server.http,
106
+ relay,
107
+ config.technicalLimits.maximumCollaborationMessageBytes
108
+ )
109
+ return {
110
+ app,
111
+ database,
112
+ url: server.url,
113
+ async stop() {
114
+ await relayListener.close()
115
+ await server.close()
116
+ await cleanup?.stop()
117
+ await emailWorker?.stop()
118
+ await database.destroy()
119
+ }
120
+ }
121
+ }