@open-pencil/cloud 0.0.0-stage → 0.16.0

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,98 @@
1
+ import type { CloudDatabase } from '#cloud/server/db'
2
+ import type { Transaction } from 'kysely'
3
+
4
+ /** How long the newest version may be old before a save keeps the state it replaces. */
5
+ export const CHECKPOINT_INTERVAL_MS = 30 * 60_000
6
+
7
+ /** Keeps a revision in the history, unless a version already keeps it. */
8
+ export async function keepRevision(
9
+ transaction: Transaction<CloudDatabase>,
10
+ input: {
11
+ documentId: string
12
+ revisionId: string
13
+ createdBy: string
14
+ createdAt: Date
15
+ restoredFromVersionId?: string
16
+ }
17
+ ): Promise<void> {
18
+ await transaction
19
+ .insertInto('documentVersion')
20
+ .values({
21
+ id: crypto.randomUUID(),
22
+ documentId: input.documentId,
23
+ revisionId: input.revisionId,
24
+ kind: 'checkpoint',
25
+ name: null,
26
+ description: null,
27
+ createdBy: input.createdBy,
28
+ restoredFromVersionId: input.restoredFromVersionId ?? null,
29
+ createdAt: input.createdAt
30
+ })
31
+ .onConflict((conflict) => conflict.column('revisionId').doNothing())
32
+ .execute()
33
+ }
34
+
35
+ /**
36
+ * Records the history's checkpoints as a save lands: the document's first save, and the state a
37
+ * save replaces once the newest version is half an hour old. Each stretch of editing, and how the
38
+ * document was left at the end of every session, stays in the history; the saves between them are
39
+ * compacted later. Whether the history gained a checkpoint.
40
+ */
41
+ export async function recordCheckpoint(
42
+ transaction: Transaction<CloudDatabase>,
43
+ input: {
44
+ documentId: string
45
+ previousRevisionId: string | null
46
+ revisionId: string
47
+ userId: string
48
+ now: Date
49
+ }
50
+ ): Promise<boolean> {
51
+ if (!input.previousRevisionId) {
52
+ await keepRevision(transaction, {
53
+ documentId: input.documentId,
54
+ revisionId: input.revisionId,
55
+ createdBy: input.userId,
56
+ createdAt: input.now
57
+ })
58
+ return true
59
+ }
60
+ const newest = await transaction
61
+ .selectFrom('documentVersion')
62
+ .select('createdAt')
63
+ .where('documentId', '=', input.documentId)
64
+ .orderBy('createdAt', 'desc')
65
+ .limit(1)
66
+ .executeTakeFirst()
67
+ if (newest && newest.createdAt.getTime() > input.now.getTime() - CHECKPOINT_INTERVAL_MS) {
68
+ return false
69
+ }
70
+ const previous = await transaction
71
+ .selectFrom('documentRevision')
72
+ .select(['createdBy', 'createdAt'])
73
+ .where('id', '=', input.previousRevisionId)
74
+ .executeTakeFirst()
75
+ if (!previous) return false
76
+ await keepRevision(transaction, {
77
+ documentId: input.documentId,
78
+ revisionId: input.previousRevisionId,
79
+ createdBy: previous.createdBy,
80
+ createdAt: previous.createdAt
81
+ })
82
+ return true
83
+ }
84
+
85
+ /**
86
+ * Tells the document's live rooms that its history changed. The change stands whatever the hook
87
+ * does; an open list that misses it loads the history again when it is next opened.
88
+ */
89
+ export function announceVersions(
90
+ onVersionsChanged: ((documentId: string) => void) | undefined,
91
+ documentId: string
92
+ ): void {
93
+ try {
94
+ onVersionsChanged?.(documentId)
95
+ } catch (error) {
96
+ console.error('[Cloud] Announcing a version history change failed:', error)
97
+ }
98
+ }
@@ -0,0 +1,25 @@
1
+ import { CLOUD_FEATURE_KEYS, type CloudPolicyContext } from '#cloud/server/policy/keys'
2
+ import type { CloudPolicy } from '#cloud/server/policy/policy'
3
+
4
+ /** How far back a workspace without full revision history keeps its versions. */
5
+ export const LIMITED_HISTORY_DAYS = 30
6
+
7
+ /**
8
+ * The oldest moment a workspace's history reaches, or null when it keeps everything: with the
9
+ * `revisionHistory` entitlement off, only the last 30 days, as on a free plan.
10
+ */
11
+ export async function historyStart(
12
+ policy: CloudPolicy | undefined,
13
+ deploymentMode: CloudPolicyContext['deploymentMode'],
14
+ workspaceId: string,
15
+ now: Date
16
+ ): Promise<Date | null> {
17
+ const full = policy
18
+ ? await policy.boolean(CLOUD_FEATURE_KEYS.revisionHistory, true, {
19
+ targetingKey: workspaceId,
20
+ workspaceId,
21
+ deploymentMode
22
+ })
23
+ : true
24
+ return full ? null : new Date(now.getTime() - LIMITED_HISTORY_DAYS * 24 * 60 * 60_000)
25
+ }
@@ -0,0 +1,4 @@
1
+ export { CHECKPOINT_INTERVAL_MS } from './checkpoint'
2
+ export { LIMITED_HISTORY_DAYS, historyStart } from './history'
3
+ export { createDocumentVersionRoutes } from './routes'
4
+ export { createDocumentVersionService, type DocumentVersionService } from './service'
@@ -0,0 +1,112 @@
1
+ import {
2
+ parseDuplicateDocumentVersion,
3
+ parseSaveDocumentVersion,
4
+ parseUpdateDocumentVersion
5
+ } from '#cloud/contract'
6
+ import { documentDomainError, type DocumentRouteEnvironment } from '#cloud/server/documents/routes'
7
+ import { validatedJSON, validatedQuery } from '#cloud/server/validation'
8
+ import { Hono, type Context } from 'hono'
9
+ import * as v from 'valibot'
10
+
11
+ import type { DocumentVersionService } from './service'
12
+
13
+ const pageSchema = v.object({
14
+ before: v.optional(v.pipe(v.string(), v.uuid())),
15
+ limit: v.optional(v.pipe(v.string(), v.toNumber(), v.integer(), v.minValue(1)))
16
+ })
17
+ const parsePage = (input: unknown) => v.parse(pageSchema, input)
18
+
19
+ async function answer(context: Context, run: () => Promise<Response>): Promise<Response> {
20
+ try {
21
+ return await run()
22
+ } catch (error) {
23
+ const response = documentDomainError(context, error)
24
+ if (response) return response
25
+ throw error
26
+ }
27
+ }
28
+
29
+ /** A document's version history: listing, naming, opening, restoring, and duplicating versions. */
30
+ export function createDocumentVersionRoutes(service: DocumentVersionService) {
31
+ return new Hono<DocumentRouteEnvironment>()
32
+ .get('/documents/:documentId/versions', validatedQuery(parsePage), (context) =>
33
+ answer(context, async () =>
34
+ context.json(
35
+ await service.list(
36
+ context.get('actor').userId,
37
+ context.req.param('documentId'),
38
+ context.req.valid('query')
39
+ )
40
+ )
41
+ )
42
+ )
43
+ .post('/documents/:documentId/versions', validatedJSON(parseSaveDocumentVersion), (context) =>
44
+ answer(context, async () =>
45
+ context.json(
46
+ {
47
+ version: await service.save(
48
+ context.get('actor').userId,
49
+ context.req.param('documentId'),
50
+ context.req.valid('json')
51
+ )
52
+ },
53
+ 201
54
+ )
55
+ )
56
+ )
57
+ .patch(
58
+ '/documents/:documentId/versions/:versionId',
59
+ validatedJSON(parseUpdateDocumentVersion),
60
+ (context) =>
61
+ answer(context, async () =>
62
+ context.json({
63
+ version: await service.update(
64
+ context.get('actor').userId,
65
+ context.req.param('documentId'),
66
+ context.req.param('versionId'),
67
+ context.req.valid('json')
68
+ )
69
+ })
70
+ )
71
+ )
72
+ .get('/documents/:documentId/versions/:versionId', (context) =>
73
+ answer(context, async () =>
74
+ context.json(
75
+ await service.download(
76
+ context.get('actor').userId,
77
+ context.req.param('documentId'),
78
+ context.req.param('versionId')
79
+ )
80
+ )
81
+ )
82
+ )
83
+ .post('/documents/:documentId/versions/:versionId/restore', (context) =>
84
+ answer(context, async () =>
85
+ context.json(
86
+ await service.restore(
87
+ context.get('actor').userId,
88
+ context.req.param('documentId'),
89
+ context.req.param('versionId')
90
+ )
91
+ )
92
+ )
93
+ )
94
+ .post(
95
+ '/documents/:documentId/versions/:versionId/duplicate',
96
+ validatedJSON(parseDuplicateDocumentVersion),
97
+ (context) =>
98
+ answer(context, async () =>
99
+ context.json(
100
+ {
101
+ document: await service.duplicate(
102
+ context.get('actor').userId,
103
+ context.req.param('documentId'),
104
+ context.req.param('versionId'),
105
+ context.req.valid('json')
106
+ )
107
+ },
108
+ 201
109
+ )
110
+ )
111
+ )
112
+ }
@@ -0,0 +1,397 @@
1
+ import type {
2
+ DocumentVersionDownload,
3
+ DocumentSummary,
4
+ DocumentVersion,
5
+ DocumentVersions,
6
+ DuplicateDocumentVersionInput,
7
+ SaveDocumentVersionInput,
8
+ UpdateDocumentVersionInput
9
+ } from '#cloud/contract'
10
+ import type { CloudDatabase } from '#cloud/server/db'
11
+ import { canEditDocument, resolveDocumentAccess } from '#cloud/server/documents/access'
12
+ import { DocumentForbiddenError, DocumentNotFoundError } from '#cloud/server/documents/errors'
13
+ import { copyRevisionImages, revisionImageDownloads } from '#cloud/server/documents/images'
14
+ import { findDocument, insertDocument, workspaceRole } from '#cloud/server/documents/repository'
15
+ import { documentSummary, getDocumentSummaryRow } from '#cloud/server/documents/summary'
16
+ import type { ObjectStore } from '#cloud/server/objects'
17
+ import type { CloudPolicyContext } from '#cloud/server/policy/keys'
18
+ import type { CloudPolicy } from '#cloud/server/policy/policy'
19
+ import type { Kysely, Transaction } from 'kysely'
20
+
21
+ import { announceVersions, keepRevision } from './checkpoint'
22
+ import { historyStart } from './history'
23
+
24
+ const DOWNLOAD_LIFETIME_MS = 5 * 60 * 1000
25
+ const DEFAULT_PAGE_SIZE = 50
26
+ const MAXIMUM_PAGE_SIZE = 100
27
+ const WRITABLE_ROLES = new Set(['admin', 'editor'])
28
+
29
+ type VersionRow = {
30
+ id: string
31
+ revisionId: string
32
+ kind: 'checkpoint' | 'named'
33
+ name: string | null
34
+ description: string | null
35
+ createdAt: Date
36
+ createdBy: string
37
+ createdByName: string | null
38
+ restoredFromVersionId: string | null
39
+ }
40
+
41
+ function versionOf(row: VersionRow, currentRevisionId: string | null): DocumentVersion {
42
+ return {
43
+ id: row.id,
44
+ revisionId: row.revisionId,
45
+ kind: row.kind,
46
+ name: row.name,
47
+ description: row.description,
48
+ createdAt: row.createdAt.toISOString(),
49
+ createdBy: { id: row.createdBy, name: row.createdByName },
50
+ restoredFromVersionId: row.restoredFromVersionId,
51
+ current: row.revisionId === currentRevisionId
52
+ }
53
+ }
54
+
55
+ /**
56
+ * A document's version history: its checkpoints and named versions, newest first, and what can be
57
+ * done with one. Anyone who can open the document sees its history; editors name and restore.
58
+ */
59
+ export function createDocumentVersionService(
60
+ database: Kysely<CloudDatabase>,
61
+ objects: ObjectStore,
62
+ options: {
63
+ policy?: CloudPolicy
64
+ deploymentMode?: CloudPolicyContext['deploymentMode']
65
+ /** Called once a restore lands, so the document's live room starts over. */
66
+ onRestored?: (documentId: string) => void
67
+ /** Called once the history changes: a version named, renamed, or turned back into an autosave. */
68
+ onVersionsChanged?: (documentId: string) => void
69
+ } = {}
70
+ ) {
71
+ const deploymentMode = options.deploymentMode ?? 'self-hosted'
72
+ function versions() {
73
+ return database
74
+ .selectFrom('documentVersion')
75
+ .leftJoin('user', (join) =>
76
+ join.on((expression) =>
77
+ expression(
78
+ expression.cast(expression.ref('user.id'), 'text'),
79
+ '=',
80
+ expression.ref('documentVersion.createdBy')
81
+ )
82
+ )
83
+ )
84
+ .select([
85
+ 'documentVersion.id',
86
+ 'documentVersion.revisionId',
87
+ 'documentVersion.kind',
88
+ 'documentVersion.name',
89
+ 'documentVersion.description',
90
+ 'documentVersion.createdAt',
91
+ 'documentVersion.createdBy',
92
+ 'user.name as createdByName',
93
+ 'documentVersion.restoredFromVersionId'
94
+ ])
95
+ }
96
+
97
+ /** The document the person may see the history of, and where that history starts. */
98
+ async function openHistory(userId: string, documentId: string, edit: boolean) {
99
+ const access = await resolveDocumentAccess(database, userId, documentId)
100
+ if (!access) throw new DocumentNotFoundError()
101
+ if (edit && !canEditDocument(access)) throw new DocumentForbiddenError()
102
+ const document = await getDocumentSummaryRow(database, documentId)
103
+ if (!document) throw new DocumentNotFoundError()
104
+ return {
105
+ document,
106
+ start: await historyStart(options.policy, deploymentMode, document.workspaceId, new Date())
107
+ }
108
+ }
109
+
110
+ async function findVersion(documentId: string, versionId: string, start: Date | null) {
111
+ let query = versions()
112
+ .where('documentVersion.documentId', '=', documentId)
113
+ .where('documentVersion.id', '=', versionId)
114
+ if (start) query = query.where('documentVersion.createdAt', '>=', start)
115
+ const row = await query.executeTakeFirst()
116
+ if (!row) throw new DocumentNotFoundError()
117
+ return row
118
+ }
119
+
120
+ /** The stored file of a revision; read under the document's lock before reusing it. */
121
+ async function storedRevision(
122
+ source: Kysely<CloudDatabase> | Transaction<CloudDatabase>,
123
+ revisionId: string
124
+ ) {
125
+ const stored = await source
126
+ .selectFrom('documentRevision')
127
+ .innerJoin('storageObject', 'storageObject.id', 'documentRevision.storageObjectId')
128
+ .select([
129
+ 'documentRevision.storageObjectId',
130
+ 'storageObject.objectKey',
131
+ 'storageObject.byteSize',
132
+ 'storageObject.checksum',
133
+ 'storageObject.contentType'
134
+ ])
135
+ .where('documentRevision.id', '=', revisionId)
136
+ .executeTakeFirst()
137
+ if (!stored) throw new DocumentNotFoundError()
138
+ return stored
139
+ }
140
+
141
+ return {
142
+ async list(
143
+ userId: string,
144
+ documentId: string,
145
+ page: { before?: string; limit?: number } = {}
146
+ ): Promise<DocumentVersions> {
147
+ const { document, start } = await openHistory(userId, documentId, false)
148
+ const limit = Math.min(Math.max(page.limit ?? DEFAULT_PAGE_SIZE, 1), MAXIMUM_PAGE_SIZE)
149
+ let query = versions().where('documentVersion.documentId', '=', documentId)
150
+ if (start) query = query.where('documentVersion.createdAt', '>=', start)
151
+ if (page.before) {
152
+ const cursor = await findVersion(documentId, page.before, start)
153
+ query = query.where((expression) =>
154
+ expression.or([
155
+ expression('documentVersion.createdAt', '<', cursor.createdAt),
156
+ expression.and([
157
+ expression('documentVersion.createdAt', '=', cursor.createdAt),
158
+ expression('documentVersion.id', '<', cursor.id)
159
+ ])
160
+ ])
161
+ )
162
+ }
163
+ const rows = await query
164
+ .orderBy('documentVersion.createdAt', 'desc')
165
+ .orderBy('documentVersion.id', 'desc')
166
+ .limit(limit + 1)
167
+ .execute()
168
+ const shown = rows.slice(0, limit)
169
+ return {
170
+ versions: shown.map((row) => versionOf(row, document.currentRevisionId)),
171
+ nextCursor: rows.length > limit ? (shown.at(-1)?.id ?? null) : null
172
+ }
173
+ },
174
+
175
+ /** Names the document as it is now, as Save to version history does. */
176
+ async save(
177
+ userId: string,
178
+ documentId: string,
179
+ input: SaveDocumentVersionInput
180
+ ): Promise<DocumentVersion> {
181
+ const { document } = await openHistory(userId, documentId, true)
182
+ const revisionId = document.currentRevisionId
183
+ if (!revisionId) throw new DocumentNotFoundError()
184
+ const description = input.description || null
185
+ await database
186
+ .insertInto('documentVersion')
187
+ .values({
188
+ id: crypto.randomUUID(),
189
+ documentId,
190
+ revisionId,
191
+ kind: 'named',
192
+ name: input.name,
193
+ description,
194
+ createdBy: userId,
195
+ restoredFromVersionId: null
196
+ })
197
+ .onConflict((conflict) =>
198
+ conflict
199
+ .column('revisionId')
200
+ .doUpdateSet({ kind: 'named', name: input.name, description })
201
+ )
202
+ .execute()
203
+ announceVersions(options.onVersionsChanged, documentId)
204
+ const row = await versions()
205
+ .where('documentVersion.revisionId', '=', revisionId)
206
+ .executeTakeFirstOrThrow()
207
+ return versionOf(row, revisionId)
208
+ },
209
+
210
+ /** Names a version, renames it, or with a null name deletes its info so it is a checkpoint. */
211
+ async update(
212
+ userId: string,
213
+ documentId: string,
214
+ versionId: string,
215
+ input: UpdateDocumentVersionInput
216
+ ): Promise<DocumentVersion> {
217
+ const { document, start } = await openHistory(userId, documentId, true)
218
+ await findVersion(documentId, versionId, start)
219
+ await database
220
+ .updateTable('documentVersion')
221
+ .set(
222
+ input.name
223
+ ? { kind: 'named', name: input.name, description: input.description || null }
224
+ : { kind: 'checkpoint', name: null, description: null }
225
+ )
226
+ .where('id', '=', versionId)
227
+ .execute()
228
+ announceVersions(options.onVersionsChanged, documentId)
229
+ return versionOf(await findVersion(documentId, versionId, start), document.currentRevisionId)
230
+ },
231
+
232
+ async download(
233
+ userId: string,
234
+ documentId: string,
235
+ versionId: string
236
+ ): Promise<DocumentVersionDownload> {
237
+ const { document, start } = await openHistory(userId, documentId, false)
238
+ const version = await findVersion(documentId, versionId, start)
239
+ const stored = await storedRevision(database, version.revisionId)
240
+ const expiresAt = new Date(Date.now() + DOWNLOAD_LIFETIME_MS)
241
+ return {
242
+ document: {
243
+ document: documentSummary(document),
244
+ revisionId: version.revisionId,
245
+ byteSize: Number(stored.byteSize),
246
+ checksum: stored.checksum,
247
+ contentType: stored.contentType,
248
+ download: await objects.createDownload({ key: stored.objectKey, expiresAt }),
249
+ images: await revisionImageDownloads(database, objects, version.revisionId, expiresAt)
250
+ },
251
+ version: versionOf(version, document.currentRevisionId)
252
+ }
253
+ },
254
+
255
+ /**
256
+ * Makes a version the document's current state without losing anything: the state it replaces
257
+ * is kept as a checkpoint, the restored state becomes a new revision of the same stored file,
258
+ * and the document's live room starts over so everyone has the restored version.
259
+ */
260
+ async restore(
261
+ userId: string,
262
+ documentId: string,
263
+ versionId: string
264
+ ): Promise<{ document: DocumentSummary; version: DocumentVersion }> {
265
+ const { start } = await openHistory(userId, documentId, true)
266
+ const version = await findVersion(documentId, versionId, start)
267
+ const revisionId = crypto.randomUUID()
268
+ const now = new Date()
269
+ await database.transaction().execute(async (transaction) => {
270
+ const locked = await transaction
271
+ .selectFrom('document')
272
+ .select(['currentRevisionId', 'deletedAt'])
273
+ .where('id', '=', documentId)
274
+ .forUpdate()
275
+ .executeTakeFirst()
276
+ if (!locked || locked.deletedAt) throw new DocumentNotFoundError()
277
+ // Compaction locks the document too, so the version's file cannot go while it is reused.
278
+ const stored = await storedRevision(transaction, version.revisionId)
279
+ if (locked.currentRevisionId) {
280
+ const current = await transaction
281
+ .selectFrom('documentRevision')
282
+ .select('createdBy')
283
+ .where('id', '=', locked.currentRevisionId)
284
+ .executeTakeFirstOrThrow()
285
+ await keepRevision(transaction, {
286
+ documentId,
287
+ revisionId: locked.currentRevisionId,
288
+ createdBy: current.createdBy,
289
+ createdAt: now
290
+ })
291
+ }
292
+ await transaction
293
+ .insertInto('documentRevision')
294
+ .values({
295
+ id: revisionId,
296
+ documentId,
297
+ parentRevisionId: locked.currentRevisionId,
298
+ storageObjectId: stored.storageObjectId,
299
+ createdBy: userId
300
+ })
301
+ .execute()
302
+ await copyRevisionImages(transaction, version.revisionId, revisionId)
303
+ await transaction
304
+ .updateTable('document')
305
+ .set({
306
+ currentRevisionId: revisionId,
307
+ version: (expression) => expression('version', '+', 1),
308
+ collaborationEpoch: (expression) => expression('collaborationEpoch', '+', 1)
309
+ })
310
+ .where('id', '=', documentId)
311
+ .execute()
312
+ // A moment after the state it replaces, so the history lists it first.
313
+ await keepRevision(transaction, {
314
+ documentId,
315
+ revisionId,
316
+ createdBy: userId,
317
+ createdAt: new Date(now.getTime() + 1),
318
+ restoredFromVersionId: versionId
319
+ })
320
+ })
321
+ // The restore stands whatever the hook does; a stale ticket is still turned away by its epoch.
322
+ try {
323
+ options.onRestored?.(documentId)
324
+ } catch (error) {
325
+ console.error('[Cloud] Ending the rooms of a restored document failed:', error)
326
+ }
327
+ const document = await findDocument(database, userId, documentId)
328
+ if (!document) throw new DocumentNotFoundError()
329
+ const restored = await versions()
330
+ .where('documentVersion.revisionId', '=', revisionId)
331
+ .executeTakeFirstOrThrow()
332
+ return { document, version: versionOf(restored, revisionId) }
333
+ },
334
+
335
+ /** Makes a new document in the same workspace from a version, sharing its stored file. */
336
+ async duplicate(
337
+ userId: string,
338
+ documentId: string,
339
+ versionId: string,
340
+ input: DuplicateDocumentVersionInput
341
+ ): Promise<DocumentSummary> {
342
+ const { document, start } = await openHistory(userId, documentId, false)
343
+ const role = await workspaceRole(database, userId, document.workspaceId)
344
+ if (!role) throw new DocumentNotFoundError()
345
+ if (!WRITABLE_ROLES.has(role)) throw new DocumentForbiddenError()
346
+ const version = await findVersion(documentId, versionId, start)
347
+ const copyId = crypto.randomUUID()
348
+ const revisionId = crypto.randomUUID()
349
+ await database.transaction().execute(async (transaction) => {
350
+ // Deleted-document cleanup removes files its document alone uses; holding the source
351
+ // until the copy refers to the file means cleanup either finishes first or sees the copy.
352
+ const source = await transaction
353
+ .selectFrom('document')
354
+ .select(['deletedAt', 'cleanupClaimId'])
355
+ .where('id', '=', documentId)
356
+ .forUpdate()
357
+ .executeTakeFirst()
358
+ if (!source || source.deletedAt || source.cleanupClaimId) throw new DocumentNotFoundError()
359
+ const stored = await storedRevision(transaction, version.revisionId)
360
+ await insertDocument(transaction, {
361
+ id: copyId,
362
+ workspaceId: document.workspaceId,
363
+ name: input.name,
364
+ kind: document.kind,
365
+ createdBy: userId
366
+ })
367
+ await transaction
368
+ .insertInto('documentRevision')
369
+ .values({
370
+ id: revisionId,
371
+ documentId: copyId,
372
+ parentRevisionId: null,
373
+ storageObjectId: stored.storageObjectId,
374
+ createdBy: userId
375
+ })
376
+ .execute()
377
+ await copyRevisionImages(transaction, version.revisionId, revisionId)
378
+ await transaction
379
+ .updateTable('document')
380
+ .set({ currentRevisionId: revisionId, version: 1 })
381
+ .where('id', '=', copyId)
382
+ .execute()
383
+ await keepRevision(transaction, {
384
+ documentId: copyId,
385
+ revisionId,
386
+ createdBy: userId,
387
+ createdAt: new Date()
388
+ })
389
+ })
390
+ const copy = await findDocument(database, userId, copyId)
391
+ if (!copy) throw new DocumentNotFoundError()
392
+ return copy
393
+ }
394
+ }
395
+ }
396
+
397
+ export type DocumentVersionService = ReturnType<typeof createDocumentVersionService>
@@ -0,0 +1,57 @@
1
+ import {
2
+ transactionalEmailContentSchema,
3
+ type TransactionalEmailContent,
4
+ type TransactionalEmailKind,
5
+ type TransactionalEmailPayloadByKind
6
+ } from '#cloud/email'
7
+ import { hkdf } from '@noble/hashes/hkdf.js'
8
+ import { sha256 } from '@noble/hashes/sha2.js'
9
+ import { utf8ToBytes } from '@noble/hashes/utils.js'
10
+ import { compactDecrypt, CompactEncrypt } from 'jose'
11
+ import * as v from 'valibot'
12
+
13
+ const EMAIL_PAYLOAD_SALT = utf8ToBytes('openpencil-cloud-transactional-email')
14
+ const EMAIL_PAYLOAD_HEADER = { alg: 'dir', enc: 'A256GCM' } as const
15
+ const encoder = new TextEncoder()
16
+ const decoder = new TextDecoder()
17
+
18
+ function emailPayloadKey(secret: string, id: string, kind: TransactionalEmailKind): Uint8Array {
19
+ return hkdf(
20
+ sha256,
21
+ utf8ToBytes(secret),
22
+ EMAIL_PAYLOAD_SALT,
23
+ encoder.encode(`openpencil-cloud-email:${kind}:${id}`),
24
+ 32
25
+ )
26
+ }
27
+
28
+ export async function encryptTransactionalEmailPayload<Kind extends TransactionalEmailKind>(
29
+ secret: string,
30
+ id: string,
31
+ kind: Kind,
32
+ payload: TransactionalEmailPayloadByKind[Kind]
33
+ ): Promise<string> {
34
+ return new CompactEncrypt(encoder.encode(JSON.stringify(payload)))
35
+ .setProtectedHeader(EMAIL_PAYLOAD_HEADER)
36
+ .encrypt(emailPayloadKey(secret, id, kind))
37
+ }
38
+
39
+ export async function decryptTransactionalEmailPayload(
40
+ secret: string,
41
+ id: string,
42
+ kind: TransactionalEmailKind,
43
+ value: string
44
+ ): Promise<TransactionalEmailContent> {
45
+ const { plaintext, protectedHeader } = await compactDecrypt(
46
+ value,
47
+ emailPayloadKey(secret, id, kind)
48
+ )
49
+ if (
50
+ protectedHeader.alg !== EMAIL_PAYLOAD_HEADER.alg ||
51
+ protectedHeader.enc !== EMAIL_PAYLOAD_HEADER.enc
52
+ ) {
53
+ throw new Error('Unsupported transactional email payload encryption')
54
+ }
55
+ const payload = v.parse(v.pipe(v.string(), v.parseJson()), decoder.decode(plaintext))
56
+ return v.parse(transactionalEmailContentSchema, { kind, payload })
57
+ }