@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,315 @@
1
+ import type {
2
+ AcceptDocumentInvitationInput,
3
+ AcceptedInvitation,
4
+ CreateDocumentInvitationInput,
5
+ CreateInvitationContinuationInput,
6
+ DocumentInvitation,
7
+ InvitationPreview,
8
+ WorkspaceRole
9
+ } from '#cloud/contract'
10
+ import { cloudInvitationURL } from '#cloud/contract'
11
+ import type { CloudActor } from '#cloud/server/auth'
12
+ import type { CloudDatabase } from '#cloud/server/db'
13
+ import { DocumentNotFoundError } from '#cloud/server/documents/errors'
14
+ import type { InvitationDelivery, InvitationOutbox } from '#cloud/server/invitations'
15
+ import type { Kysely } from 'kysely'
16
+
17
+ import { randomHex } from '@open-pencil/scene-graph/random'
18
+
19
+ import { requireSharingAccess } from '../access'
20
+ import {
21
+ createInvitationContinuationService,
22
+ invitationMatchesActor,
23
+ invitationTokenIsActive,
24
+ recipientHint
25
+ } from '../continuation'
26
+ import { dateString, grantContract, invitationContract } from '../contracts'
27
+ import { hashCapability } from '../crypto'
28
+ import { DocumentShareInvalidError, InvitationDeliveryError } from '../errors'
29
+
30
+ const INVITATION_SECRET_BYTES = 24
31
+ const INVITATION_LIFETIME_MS = 7 * 24 * 60 * 60_000
32
+
33
+ /** Workspace invitations share the invitation link; their ids are not document invitations. */
34
+ export type WorkspaceInvitationResolver = {
35
+ preview(invitationId: string, token: string): Promise<InvitationPreview | null>
36
+ accept(
37
+ actor: CloudActor,
38
+ invitationId: string,
39
+ token: string
40
+ ): Promise<{ workspaceId: string; role: WorkspaceRole } | null>
41
+ }
42
+
43
+ export type InvitationServiceOptions = {
44
+ workspaceInvitations?: WorkspaceInvitationResolver
45
+ continuationSecret?: string
46
+ delivery?: InvitationDelivery
47
+ outbox?: InvitationOutbox
48
+ publicURL?: string
49
+ }
50
+
51
+ export function createInvitationService(
52
+ database: Kysely<CloudDatabase>,
53
+ options: InvitationServiceOptions
54
+ ) {
55
+ async function previewDocumentInvitation(
56
+ invitationId: string,
57
+ input: AcceptDocumentInvitationInput
58
+ ): Promise<InvitationPreview> {
59
+ const invitation = await database
60
+ .selectFrom('documentInvitation')
61
+ .innerJoin('document', 'document.id', 'documentInvitation.documentId')
62
+ .select([
63
+ 'documentInvitation.emailNormalized',
64
+ 'documentInvitation.permission',
65
+ 'documentInvitation.tokenHash',
66
+ 'documentInvitation.expiresAt',
67
+ 'documentInvitation.acceptedAt',
68
+ 'documentInvitation.revokedAt',
69
+ 'documentInvitation.invitedBy',
70
+ 'document.name as documentName'
71
+ ])
72
+ .where('documentInvitation.id', '=', invitationId)
73
+ .executeTakeFirst()
74
+ if (!invitation || !invitationTokenIsActive(invitation, input.token)) {
75
+ throw new DocumentShareInvalidError()
76
+ }
77
+ const inviter = await database
78
+ .selectFrom('user')
79
+ .select('name')
80
+ .where('id', '=', invitation.invitedBy)
81
+ .executeTakeFirst()
82
+ return {
83
+ kind: 'document',
84
+ documentName: invitation.documentName,
85
+ inviterName: inviter?.name ?? 'An OpenPencil user',
86
+ permission: invitation.permission,
87
+ expiresAt: dateString(invitation.expiresAt) ?? '',
88
+ recipientHint: recipientHint(invitation.emailNormalized)
89
+ }
90
+ }
91
+
92
+ const continuation = options.continuationSecret
93
+ ? createInvitationContinuationService(
94
+ database,
95
+ options.continuationSecret,
96
+ // Continuations are kept for document invitations only.
97
+ async (invitationId, token) => previewDocumentInvitation(invitationId, { token })
98
+ )
99
+ : null
100
+
101
+ return {
102
+ async listInvitations(userId: string, documentId: string): Promise<DocumentInvitation[]> {
103
+ await requireSharingAccess(database, userId, documentId)
104
+ const rows = await database
105
+ .selectFrom('documentInvitation')
106
+ .select([
107
+ 'id',
108
+ 'documentId',
109
+ 'emailNormalized',
110
+ 'permission',
111
+ 'invitedBy',
112
+ 'invitedAt',
113
+ 'expiresAt',
114
+ 'acceptedAt'
115
+ ])
116
+ .where('documentId', '=', documentId)
117
+ .where('revokedAt', 'is', null)
118
+ .orderBy('invitedAt')
119
+ .execute()
120
+ return rows.map(invitationContract)
121
+ },
122
+
123
+ async createInvitation(
124
+ userId: string,
125
+ documentId: string,
126
+ input: CreateDocumentInvitationInput
127
+ ): Promise<{ invitation: DocumentInvitation; token: string }> {
128
+ await requireSharingAccess(database, userId, documentId)
129
+ const id = crypto.randomUUID()
130
+ const token = randomHex(INVITATION_SECRET_BYTES)
131
+ const expiresAt = new Date(Date.now() + INVITATION_LIFETIME_MS)
132
+ const deliveryContext =
133
+ (options.delivery || options.outbox) && options.publicURL
134
+ ? await Promise.all([
135
+ database
136
+ .selectFrom('user')
137
+ .select('name')
138
+ .where('id', '=', userId)
139
+ .executeTakeFirst(),
140
+ database
141
+ .selectFrom('document')
142
+ .select('name')
143
+ .where('id', '=', documentId)
144
+ .executeTakeFirstOrThrow()
145
+ ])
146
+ : null
147
+ const acceptanceURL =
148
+ deliveryContext && options.publicURL
149
+ ? cloudInvitationURL(options.publicURL, id, token)
150
+ : null
151
+ const message =
152
+ deliveryContext && acceptanceURL
153
+ ? {
154
+ deliveryId: id,
155
+ recipientEmail: input.email,
156
+ inviterName: deliveryContext[0]?.name ?? 'An OpenPencil user',
157
+ documentName: deliveryContext[1].name,
158
+ permission: input.permission,
159
+ expiresAt: expiresAt.toISOString(),
160
+ acceptanceURL
161
+ }
162
+ : null
163
+ const row = await database.transaction().execute(async (transaction) => {
164
+ const inserted = await transaction
165
+ .insertInto('documentInvitation')
166
+ .values({
167
+ id,
168
+ documentId,
169
+ emailNormalized: input.email,
170
+ permission: input.permission,
171
+ tokenHash: hashCapability(token),
172
+ invitedBy: userId,
173
+ expiresAt,
174
+ acceptedAt: null,
175
+ revokedAt: null
176
+ })
177
+ .returning([
178
+ 'id',
179
+ 'documentId',
180
+ 'emailNormalized',
181
+ 'permission',
182
+ 'invitedBy',
183
+ 'invitedAt',
184
+ 'expiresAt',
185
+ 'acceptedAt'
186
+ ])
187
+ .executeTakeFirstOrThrow()
188
+ if (options.outbox && message) {
189
+ await options.outbox.enqueueDocumentInvitation(message, transaction)
190
+ }
191
+ return inserted
192
+ })
193
+ const invitation = invitationContract(row)
194
+ if (options.delivery && message && !options.outbox) {
195
+ try {
196
+ await options.delivery.sendDocumentInvitation(message)
197
+ } catch (error) {
198
+ await database
199
+ .updateTable('documentInvitation')
200
+ .set({ revokedAt: new Date() })
201
+ .where('id', '=', id)
202
+ .execute()
203
+ throw new InvitationDeliveryError('Invitation delivery failed', { cause: error })
204
+ }
205
+ }
206
+ return { invitation, token }
207
+ },
208
+
209
+ async createInvitationContinuation(input: CreateInvitationContinuationInput) {
210
+ if (!continuation) throw new DocumentShareInvalidError()
211
+ return continuation.create(input)
212
+ },
213
+
214
+ async consumeInvitationContinuation(id: string) {
215
+ if (!continuation) throw new DocumentShareInvalidError()
216
+ return continuation.consume(id)
217
+ },
218
+
219
+ /** What an invitation link offers: a document, or a workspace when the id is one of those. */
220
+ async previewInvitation(
221
+ invitationId: string,
222
+ input: AcceptDocumentInvitationInput
223
+ ): Promise<InvitationPreview> {
224
+ const workspace = await options.workspaceInvitations?.preview(invitationId, input.token)
225
+ return workspace ?? previewDocumentInvitation(invitationId, input)
226
+ },
227
+
228
+ async acceptInvitation(
229
+ actor: CloudActor,
230
+ invitationId: string,
231
+ input: AcceptDocumentInvitationInput
232
+ ): Promise<AcceptedInvitation> {
233
+ const workspace = await options.workspaceInvitations?.accept(actor, invitationId, input.token)
234
+ if (workspace) return { kind: 'workspace', ...workspace }
235
+ const invitation = await database
236
+ .selectFrom('documentInvitation')
237
+ .select([
238
+ 'id',
239
+ 'documentId',
240
+ 'emailNormalized',
241
+ 'permission',
242
+ 'invitedBy',
243
+ 'tokenHash',
244
+ 'expiresAt',
245
+ 'acceptedAt',
246
+ 'revokedAt'
247
+ ])
248
+ .where('id', '=', invitationId)
249
+ .executeTakeFirst()
250
+ if (
251
+ !invitation ||
252
+ !invitationMatchesActor(actor, invitation.emailNormalized) ||
253
+ !invitationTokenIsActive(invitation, input.token)
254
+ ) {
255
+ throw new DocumentShareInvalidError()
256
+ }
257
+ return database.transaction().execute(async (transaction) => {
258
+ const row = await transaction
259
+ .insertInto('documentGrant')
260
+ .values({
261
+ id: crypto.randomUUID(),
262
+ documentId: invitation.documentId,
263
+ userId: actor.userId,
264
+ permission: invitation.permission,
265
+ // The grant is the inviter's, so "shared by" names them, not the recipient.
266
+ createdBy: invitation.invitedBy,
267
+ revokedAt: null
268
+ })
269
+ .onConflict((conflict) =>
270
+ conflict.columns(['documentId', 'userId']).doUpdateSet({
271
+ permission: invitation.permission,
272
+ createdBy: invitation.invitedBy,
273
+ revokedAt: null,
274
+ updatedAt: new Date()
275
+ })
276
+ )
277
+ .returning([
278
+ 'id',
279
+ 'documentId',
280
+ 'userId',
281
+ 'permission',
282
+ 'createdBy',
283
+ 'createdAt',
284
+ 'updatedAt'
285
+ ])
286
+ .executeTakeFirstOrThrow()
287
+ await transaction
288
+ .updateTable('documentInvitation')
289
+ .set({ acceptedAt: new Date() })
290
+ .where('id', '=', invitationId)
291
+ .where('acceptedAt', 'is', null)
292
+ .execute()
293
+ return { kind: 'document' as const, grant: grantContract(row) }
294
+ })
295
+ },
296
+
297
+ async revokeInvitation(
298
+ userId: string,
299
+ documentId: string,
300
+ invitationId: string
301
+ ): Promise<void> {
302
+ await requireSharingAccess(database, userId, documentId)
303
+ const result = await database
304
+ .updateTable('documentInvitation')
305
+ .set({ revokedAt: new Date() })
306
+ .where('id', '=', invitationId)
307
+ .where('documentId', '=', documentId)
308
+ .where('revokedAt', 'is', null)
309
+ .executeTakeFirst()
310
+ if (Number(result.numUpdatedRows) === 0) throw new DocumentNotFoundError()
311
+ }
312
+ }
313
+ }
314
+
315
+ export type InvitationService = ReturnType<typeof createInvitationService>
@@ -0,0 +1,44 @@
1
+ import type { CloudDatabase } from '#cloud/server/db'
2
+ import { DocumentForbiddenError } from '#cloud/server/documents/errors'
3
+ import { CLOUD_FEATURE_KEYS, type CloudPolicy, type CloudPolicyContext } from '#cloud/server/policy'
4
+ import type { Kysely } from 'kysely'
5
+
6
+ export type SharingPolicyOptions = {
7
+ policy?: CloudPolicy
8
+ deploymentMode?: 'official' | 'self-hosted'
9
+ }
10
+
11
+ export type CapabilityLinkPolicyInput = {
12
+ actorId: string
13
+ documentId: string
14
+ }
15
+
16
+ export function createSharingPolicy(
17
+ database: Kysely<CloudDatabase>,
18
+ options: SharingPolicyOptions
19
+ ) {
20
+ async function requireCapabilityLink(input: CapabilityLinkPolicyInput): Promise<void> {
21
+ if (!options.policy) return
22
+ const document = await database
23
+ .selectFrom('document')
24
+ .select('workspaceId')
25
+ .where('id', '=', input.documentId)
26
+ .executeTakeFirstOrThrow()
27
+ const context: CloudPolicyContext = {
28
+ targetingKey: document.workspaceId,
29
+ actorId: input.actorId,
30
+ workspaceId: document.workspaceId,
31
+ documentId: input.documentId,
32
+ deploymentMode: options.deploymentMode ?? 'self-hosted'
33
+ }
34
+ // Whether guests may follow the link is checked when they do, so edit links still work for
35
+ // people signed in to the server.
36
+ if (!(await options.policy.boolean(CLOUD_FEATURE_KEYS.links, false, context))) {
37
+ throw new DocumentForbiddenError()
38
+ }
39
+ }
40
+
41
+ return { requireCapabilityLink }
42
+ }
43
+
44
+ export type SharingPolicy = ReturnType<typeof createSharingPolicy>
@@ -0,0 +1,251 @@
1
+ import {
2
+ parseAcceptDocumentInvitation,
3
+ parseCreateInvitationContinuation,
4
+ parseCreateDocumentInvitation,
5
+ parseLookupCloudUser,
6
+ parseCreateDocumentShare,
7
+ parsePutDocumentGrant,
8
+ parseResolveDocumentShare,
9
+ parseUpdateDocumentShare
10
+ } from '#cloud/contract'
11
+ import type { CloudActor, CloudSessionResolver } from '#cloud/server/auth'
12
+ import type { CloudDatabase } from '#cloud/server/db'
13
+ import { CLOUD_RATE_LIMITS, createRouteRateLimiter } from '#cloud/server/rate-limit'
14
+ import { sharingRoute } from '#cloud/server/sharing/http'
15
+ import type { DocumentSharingService } from '#cloud/server/sharing/service'
16
+ import { validatedJSON } from '#cloud/server/validation'
17
+ import { Hono } from 'hono'
18
+ import type { Kysely } from 'kysely'
19
+
20
+ import { shareActor } from './actor'
21
+
22
+ export type SharingRouteEnvironment = {
23
+ Variables: { actor: CloudActor }
24
+ }
25
+
26
+ export function createDocumentSharingRoutes(
27
+ service: DocumentSharingService,
28
+ rateLimit?: { database: Kysely<CloudDatabase>; secret: string }
29
+ ) {
30
+ const router = new Hono<SharingRouteEnvironment>()
31
+ if (rateLimit) {
32
+ router.use(
33
+ '/documents/:documentId/invitations',
34
+ createRouteRateLimiter(
35
+ rateLimit.database,
36
+ rateLimit.secret,
37
+ CLOUD_RATE_LIMITS.invitationMutation,
38
+ (context) => context.req.method !== 'POST',
39
+ (context) => context.req.param('documentId') ?? 'unknown'
40
+ )
41
+ )
42
+ }
43
+ return router
44
+ .post('/documents/:documentId/users/lookup', validatedJSON(parseLookupCloudUser), (context) =>
45
+ sharingRoute(context, async () =>
46
+ context.json({
47
+ user: await service.lookupUser(
48
+ context.get('actor').userId,
49
+ context.req.param('documentId'),
50
+ context.req.valid('json')
51
+ )
52
+ })
53
+ )
54
+ )
55
+ .get('/documents/:documentId/users/:userId', (context) =>
56
+ sharingRoute(context, async () =>
57
+ context.json({
58
+ user: await service.userProfile(
59
+ context.get('actor').userId,
60
+ context.req.param('documentId'),
61
+ context.req.param('userId')
62
+ )
63
+ })
64
+ )
65
+ )
66
+ .get('/documents/:documentId/shares', (context) =>
67
+ sharingRoute(context, async () =>
68
+ context.json({
69
+ shares: await service.listShares(
70
+ context.get('actor').userId,
71
+ context.req.param('documentId')
72
+ )
73
+ })
74
+ )
75
+ )
76
+ .post('/documents/:documentId/shares', validatedJSON(parseCreateDocumentShare), (context) =>
77
+ sharingRoute(context, async () =>
78
+ context.json(
79
+ await service.createShare(
80
+ context.get('actor').userId,
81
+ context.req.param('documentId'),
82
+ context.req.valid('json')
83
+ ),
84
+ 201
85
+ )
86
+ )
87
+ )
88
+ .patch(
89
+ '/documents/:documentId/shares/:shareId',
90
+ validatedJSON(parseUpdateDocumentShare),
91
+ (context) =>
92
+ sharingRoute(context, async () =>
93
+ context.json({
94
+ share: await service.updateShare(
95
+ context.get('actor').userId,
96
+ context.req.param('documentId'),
97
+ context.req.param('shareId'),
98
+ context.req.valid('json')
99
+ )
100
+ })
101
+ )
102
+ )
103
+ .post('/documents/:documentId/shares/:shareId/rotate', (context) =>
104
+ sharingRoute(context, async () =>
105
+ context.json(
106
+ await service.rotateShare(
107
+ context.get('actor').userId,
108
+ context.req.param('documentId'),
109
+ context.req.param('shareId')
110
+ )
111
+ )
112
+ )
113
+ )
114
+ .delete('/documents/:documentId/shares/:shareId', (context) =>
115
+ sharingRoute(context, async () => {
116
+ await service.revokeShare(
117
+ context.get('actor').userId,
118
+ context.req.param('documentId'),
119
+ context.req.param('shareId')
120
+ )
121
+ return context.body(null, 204)
122
+ })
123
+ )
124
+ .get('/documents/:documentId/grants', (context) =>
125
+ sharingRoute(context, async () =>
126
+ context.json({
127
+ grants: await service.listGrants(
128
+ context.get('actor').userId,
129
+ context.req.param('documentId')
130
+ )
131
+ })
132
+ )
133
+ )
134
+ .put('/documents/:documentId/grants/:userId', validatedJSON(parsePutDocumentGrant), (context) =>
135
+ sharingRoute(context, async () =>
136
+ context.json({
137
+ grant: await service.putGrant(
138
+ context.get('actor').userId,
139
+ context.req.param('documentId'),
140
+ context.req.param('userId'),
141
+ context.req.valid('json')
142
+ )
143
+ })
144
+ )
145
+ )
146
+ .delete('/documents/:documentId/grants/:userId', (context) =>
147
+ sharingRoute(context, async () => {
148
+ await service.revokeGrant(
149
+ context.get('actor').userId,
150
+ context.req.param('documentId'),
151
+ context.req.param('userId')
152
+ )
153
+ return context.body(null, 204)
154
+ })
155
+ )
156
+ .get('/documents/:documentId/invitations', (context) =>
157
+ sharingRoute(context, async () =>
158
+ context.json({
159
+ invitations: await service.listInvitations(
160
+ context.get('actor').userId,
161
+ context.req.param('documentId')
162
+ )
163
+ })
164
+ )
165
+ )
166
+ .post(
167
+ '/documents/:documentId/invitations',
168
+ validatedJSON(parseCreateDocumentInvitation),
169
+ (context) =>
170
+ sharingRoute(context, async () =>
171
+ context.json(
172
+ await service.createInvitation(
173
+ context.get('actor').userId,
174
+ context.req.param('documentId'),
175
+ context.req.valid('json')
176
+ ),
177
+ 201
178
+ )
179
+ )
180
+ )
181
+ .post(
182
+ '/invitations/:invitationId/accept',
183
+ validatedJSON(parseAcceptDocumentInvitation),
184
+ (context) =>
185
+ sharingRoute(context, async () =>
186
+ context.json({
187
+ accepted: await service.acceptInvitation(
188
+ context.get('actor'),
189
+ context.req.param('invitationId'),
190
+ context.req.valid('json')
191
+ )
192
+ })
193
+ )
194
+ )
195
+ .delete('/documents/:documentId/invitations/:invitationId', (context) =>
196
+ sharingRoute(context, async () => {
197
+ await service.revokeInvitation(
198
+ context.get('actor').userId,
199
+ context.req.param('documentId'),
200
+ context.req.param('invitationId')
201
+ )
202
+ return context.body(null, 204)
203
+ })
204
+ )
205
+ }
206
+
207
+ export function createPublicSharingRoutes(
208
+ service: DocumentSharingService,
209
+ resolveSession?: CloudSessionResolver
210
+ ) {
211
+ return new Hono()
212
+ .post(
213
+ '/invitations/continuations',
214
+ validatedJSON(parseCreateInvitationContinuation),
215
+ (context) =>
216
+ sharingRoute(context, async () =>
217
+ context.json(await service.createInvitationContinuation(context.req.valid('json')), 201)
218
+ )
219
+ )
220
+ .post('/invitations/continuations/:continuationId/consume', (context) =>
221
+ sharingRoute(context, async () =>
222
+ context.json(
223
+ await service.consumeInvitationContinuation(context.req.param('continuationId'))
224
+ )
225
+ )
226
+ )
227
+ .post(
228
+ '/invitations/:invitationId/preview',
229
+ validatedJSON(parseAcceptDocumentInvitation),
230
+ (context) =>
231
+ sharingRoute(context, async () =>
232
+ context.json({
233
+ invitation: await service.previewInvitation(
234
+ context.req.param('invitationId'),
235
+ context.req.valid('json')
236
+ )
237
+ })
238
+ )
239
+ )
240
+ .post('/shares/:shareId/resolve', validatedJSON(parseResolveDocumentShare), (context) =>
241
+ sharingRoute(context, async () =>
242
+ context.json({
243
+ resolution: await service.resolveShare(
244
+ context.req.param('shareId'),
245
+ context.req.valid('json'),
246
+ await shareActor(context.req.raw, resolveSession)
247
+ )
248
+ })
249
+ )
250
+ )
251
+ }