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

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 (235) hide show
  1. package/README.md +1 -1
  2. package/dist/bin/{ai-relay.mjs → services.mjs} +8 -8
  3. package/dist/bin/services.mjs.map +1 -0
  4. package/dist/client.d.ts +236 -46
  5. package/dist/client.d.ts.map +1 -1
  6. package/dist/client.js +649 -400
  7. package/dist/client.js.map +1 -1
  8. package/dist/contract.d.ts +2 -2
  9. package/dist/contract.js +2 -2
  10. package/dist/contract2.js +680 -443
  11. package/dist/contract2.js.map +1 -1
  12. package/dist/email.d.ts +9 -1
  13. package/dist/email.d.ts.map +1 -1
  14. package/dist/email.js +99 -58
  15. package/dist/email.js.map +1 -1
  16. package/dist/index.d.ts +468 -64
  17. package/dist/index.d.ts.map +1 -1
  18. package/dist/listen.mjs +575 -738
  19. package/dist/listen.mjs.map +1 -1
  20. package/dist/runtime-node.d.mts +6564 -2934
  21. package/dist/runtime-node.d.mts.map +1 -1
  22. package/dist/runtime-node.mjs +6 -5
  23. package/dist/runtime-node.mjs.map +1 -1
  24. package/dist/server.d.ts +8931 -4198
  25. package/dist/server.d.ts.map +1 -1
  26. package/dist/server.js +5260 -3859
  27. package/dist/server.js.map +1 -1
  28. package/dist/server.mjs +5686 -3736
  29. package/dist/server.mjs.map +1 -1
  30. package/dist/server2.mjs +101 -79
  31. package/dist/server2.mjs.map +1 -1
  32. package/package.json +9 -6
  33. package/src/admin/api/routes.ts +103 -33
  34. package/src/admin/audit/service.ts +25 -6
  35. package/src/admin/documents/service.ts +361 -0
  36. package/src/admin/errors.ts +9 -1
  37. package/src/admin/index.ts +6 -0
  38. package/src/admin/operations/service.ts +7 -0
  39. package/src/admin/reports/service.ts +147 -0
  40. package/src/admin/schema.ts +6 -0
  41. package/src/client/api.ts +36 -21
  42. package/src/client/auth/navigation.ts +6 -5
  43. package/src/client/index.ts +7 -7
  44. package/src/client/portal/account.ts +25 -0
  45. package/src/client/portal/administration.ts +56 -0
  46. package/src/client/{ai.ts → services.ts} +44 -27
  47. package/src/contract/account.ts +58 -2
  48. package/src/contract/admin/index.ts +67 -3
  49. package/src/contract/collaboration.ts +6 -1
  50. package/src/contract/discovery.ts +22 -4
  51. package/src/contract/documents.ts +27 -0
  52. package/src/contract/entitlements.ts +2 -2
  53. package/src/contract/index.ts +63 -37
  54. package/src/contract/relay.ts +6 -0
  55. package/src/contract/reports.ts +42 -0
  56. package/src/contract/services.ts +233 -0
  57. package/src/contract/sharing.ts +3 -9
  58. package/src/email/render.ts +26 -0
  59. package/src/email/schema.ts +11 -1
  60. package/src/email/templates/brand.ts +1 -1
  61. package/src/runtime/cloudflare/environment.ts +31 -6
  62. package/src/runtime/cloudflare/index.ts +1 -1
  63. package/src/runtime/cloudflare/logging.ts +15 -0
  64. package/src/runtime/cloudflare/maintenance.ts +31 -0
  65. package/src/runtime/cloudflare/relay/index.ts +176 -0
  66. package/src/runtime/cloudflare/relay/sockets.ts +112 -0
  67. package/src/runtime/cloudflare/worker.ts +89 -26
  68. package/src/runtime/node/application.ts +5 -3
  69. package/src/runtime/node/bootstrap.ts +20 -4
  70. package/src/runtime/node/cleanup.ts +16 -3
  71. package/src/runtime/node/entitlements/main.ts +14 -11
  72. package/src/runtime/node/index.ts +1 -1
  73. package/src/runtime/node/migrate.ts +5 -1
  74. package/src/runtime/node/relay.ts +8 -2
  75. package/src/runtime/node/request-id.ts +13 -0
  76. package/src/runtime/node/server.ts +71 -15
  77. package/src/runtime/node/{ai-relay → services}/main.ts +6 -6
  78. package/src/runtime/node/{ai-relay → services}/server.ts +18 -18
  79. package/src/runtime/postgres/database.ts +20 -1
  80. package/src/runtime/posthog/errors.ts +32 -0
  81. package/src/runtime/s3/objects.ts +50 -1
  82. package/src/runtime/site/server.ts +33 -4
  83. package/src/server/account/actions.ts +5 -0
  84. package/src/server/account/deletion.ts +302 -0
  85. package/src/server/account/routes.ts +47 -3
  86. package/src/server/account/terms.ts +42 -0
  87. package/src/server/api/router.ts +12 -7
  88. package/src/server/api/types.ts +9 -0
  89. package/src/server/app.ts +93 -15
  90. package/src/server/auth/access-control.ts +63 -0
  91. package/src/server/auth/adapter.ts +11 -0
  92. package/src/server/auth/endpoints.ts +5 -1
  93. package/src/server/auth/factory.ts +30 -3
  94. package/src/server/auth/index.ts +10 -1
  95. package/src/server/cleanup/configured.ts +12 -5
  96. package/src/server/cleanup/documents.ts +165 -71
  97. package/src/server/cleanup/objects.ts +10 -2
  98. package/src/server/cleanup/revisions.ts +24 -7
  99. package/src/server/cleanup/uploads.ts +8 -2
  100. package/src/server/cleanup/worker.ts +5 -2
  101. package/src/server/collaboration/index.ts +3 -0
  102. package/src/server/collaboration/relay/connection.ts +196 -0
  103. package/src/server/collaboration/relay/documents.ts +13 -10
  104. package/src/server/collaboration/relay/hub.ts +279 -195
  105. package/src/server/collaboration/relay/index.ts +3 -1
  106. package/src/server/collaboration/relay/log.ts +79 -0
  107. package/src/server/collaboration/relay/persistence.ts +147 -22
  108. package/src/server/collaboration/relay/resume.ts +28 -0
  109. package/src/server/collaboration/routes.ts +27 -16
  110. package/src/server/collaboration/service.ts +27 -31
  111. package/src/server/config/deployment.ts +35 -4
  112. package/src/server/config/public.ts +5 -4
  113. package/src/server/config/schema.ts +104 -16
  114. package/src/server/db/expressions.ts +15 -1
  115. package/src/server/db/migrate.ts +34 -114
  116. package/src/server/db/migrations/001_accounts.ts +79 -0
  117. package/src/server/db/migrations/002_workspaces.ts +48 -0
  118. package/src/server/db/migrations/003_storage.ts +44 -0
  119. package/src/server/db/migrations/004_documents.ts +193 -0
  120. package/src/server/db/migrations/005_sharing.ts +95 -0
  121. package/src/server/db/migrations/006_operations.ts +110 -0
  122. package/src/server/db/migrations/007_trash.ts +33 -0
  123. package/src/server/db/migrations/008_terms.ts +18 -0
  124. package/src/server/db/migrations/schema.ts +71 -0
  125. package/src/server/db/tables.ts +70 -7
  126. package/src/server/documents/access.ts +66 -55
  127. package/src/server/documents/errors.ts +7 -0
  128. package/src/server/documents/images.ts +2 -1
  129. package/src/server/documents/limits.ts +9 -9
  130. package/src/server/documents/purge.ts +75 -0
  131. package/src/server/documents/repository.ts +2 -0
  132. package/src/server/documents/routes.ts +132 -80
  133. package/src/server/documents/service.ts +18 -4
  134. package/src/server/documents/summary.ts +1 -0
  135. package/src/server/documents/trash.ts +203 -0
  136. package/src/server/documents/versions/checkpoint.ts +2 -1
  137. package/src/server/documents/versions/history.ts +11 -7
  138. package/src/server/documents/versions/routes.ts +36 -25
  139. package/src/server/documents/versions/service.ts +22 -4
  140. package/src/server/errors/index.ts +99 -0
  141. package/src/server/errors/posthog.ts +80 -0
  142. package/src/server/index.ts +56 -16
  143. package/src/server/internal/index.ts +3 -3
  144. package/src/server/internal/routes.ts +7 -15
  145. package/src/server/internal/schema.ts +1 -1
  146. package/src/server/internal/service.ts +17 -23
  147. package/src/server/invitations/budget.ts +66 -0
  148. package/src/server/invitations/index.ts +1 -0
  149. package/src/server/logging.ts +76 -0
  150. package/src/server/objects/types.ts +12 -0
  151. package/src/server/pictures/routes.ts +4 -2
  152. package/src/server/pictures/service.ts +2 -1
  153. package/src/server/policy/database.ts +39 -25
  154. package/src/server/policy/index.ts +2 -1
  155. package/src/server/policy/keys.ts +5 -2
  156. package/src/server/policy/policy.ts +1 -0
  157. package/src/server/policy/schema.ts +2 -2
  158. package/src/server/policy/service.ts +12 -9
  159. package/src/server/policy/static.ts +5 -5
  160. package/src/server/policy/workspace.ts +41 -0
  161. package/src/server/quota/reconcile.ts +2 -0
  162. package/src/server/quota/storage.ts +69 -31
  163. package/src/server/rate-limit/cleanup.ts +17 -5
  164. package/src/server/rate-limit/index.ts +4 -1
  165. package/src/server/rate-limit/middleware.ts +100 -12
  166. package/src/server/reports/index.ts +8 -0
  167. package/src/server/reports/routes.ts +37 -0
  168. package/src/server/reports/service.ts +123 -0
  169. package/src/server/services/errors.ts +7 -0
  170. package/src/server/services/index.ts +8 -0
  171. package/src/server/{ai → services}/keys.ts +11 -11
  172. package/src/server/services/routes.ts +47 -0
  173. package/src/server/{ai/service.ts → services/tokens.ts} +23 -20
  174. package/src/server/sharing/capabilities/service.ts +68 -22
  175. package/src/server/sharing/document-routes.ts +30 -22
  176. package/src/server/sharing/grants/service.ts +11 -18
  177. package/src/server/sharing/http.ts +4 -0
  178. package/src/server/sharing/invitations/service.ts +21 -11
  179. package/src/server/sharing/policy.ts +9 -14
  180. package/src/server/sharing/routes.ts +108 -85
  181. package/src/server/sharing/service.ts +1 -17
  182. package/src/server/validation.ts +59 -2
  183. package/src/server/workspaces/index.ts +1 -0
  184. package/src/server/workspaces/members.ts +89 -38
  185. package/src/server/workspaces/repository.ts +2 -1
  186. package/src/server/workspaces/routes.ts +67 -45
  187. package/src/{ai-relay → services}/app.ts +48 -44
  188. package/src/{ai-relay → services}/config.ts +25 -19
  189. package/src/services/db/index.ts +10 -0
  190. package/src/services/db/migrate.ts +37 -0
  191. package/src/{ai-relay/db/migrations/001_usage.ts → services/db/migrations/001_baseline.ts} +18 -7
  192. package/src/services/db/schema.ts +22 -0
  193. package/src/services/index.ts +18 -0
  194. package/src/{ai-relay → services}/metering.ts +2 -2
  195. package/src/{ai-relay → services}/usage.ts +43 -19
  196. package/dist/bin/ai-relay.mjs.map +0 -1
  197. package/src/ai-relay/db/index.ts +0 -10
  198. package/src/ai-relay/db/migrate.ts +0 -32
  199. package/src/ai-relay/db/schema.ts +0 -20
  200. package/src/ai-relay/index.ts +0 -18
  201. package/src/contract/ai.ts +0 -150
  202. package/src/runtime/cloudflare/relay.ts +0 -136
  203. package/src/server/ai/errors.ts +0 -7
  204. package/src/server/ai/index.ts +0 -4
  205. package/src/server/ai/routes.ts +0 -43
  206. package/src/server/auth/workspace-access.ts +0 -23
  207. package/src/server/db/migrations/001_foundation.ts +0 -164
  208. package/src/server/db/migrations/002_upload_cleanup_claims.ts +0 -34
  209. package/src/server/db/migrations/003_document_cleanup_claims.ts +0 -23
  210. package/src/server/db/migrations/004_document_sharing.ts +0 -82
  211. package/src/server/db/migrations/005_document_collaboration_epoch.ts +0 -13
  212. package/src/server/db/migrations/006_invitation_continuation.ts +0 -27
  213. package/src/server/db/migrations/007_collaboration_state.ts +0 -25
  214. package/src/server/db/migrations/008_storage_reservations.ts +0 -37
  215. package/src/server/db/migrations/009_workspace_entitlements.ts +0 -22
  216. package/src/server/db/migrations/010_upload_finalization.ts +0 -22
  217. package/src/server/db/migrations/011_upload_finalization_lease.ts +0 -12
  218. package/src/server/db/migrations/012_transactional_email.ts +0 -48
  219. package/src/server/db/migrations/013_admin_enrollment.ts +0 -54
  220. package/src/server/db/migrations/014_enrollment_email_kinds.ts +0 -30
  221. package/src/server/db/migrations/015_cloud_rate_limit.ts +0 -22
  222. package/src/server/db/migrations/016_auth_schema.ts +0 -16
  223. package/src/server/db/migrations/017_authentication_email_kinds.ts +0 -32
  224. package/src/server/db/migrations/018_authentication_mfa.ts +0 -78
  225. package/src/server/db/migrations/019_better_auth_account_issuer.ts +0 -42
  226. package/src/server/db/migrations/020_workspace_invitations.ts +0 -57
  227. package/src/server/db/migrations/021_document_versions.ts +0 -66
  228. package/src/server/db/migrations/022_entitlement_external_version.ts +0 -17
  229. package/src/server/db/migrations/023_document_images.ts +0 -61
  230. package/src/server/db/migrations/024_account_activity.ts +0 -66
  231. package/src/server/db/migrations/025_table_names.ts +0 -58
  232. package/src/server/db/migrations/026_user_picture.ts +0 -30
  233. package/src/server/db/migrations/027_document_kind.ts +0 -19
  234. package/src/server/db/migrations/helpers.ts +0 -78
  235. /package/dist/bin/{ai-relay.d.mts → services.d.mts} +0 -0
@@ -0,0 +1,196 @@
1
+ import {
2
+ createRelayClientAssembler,
3
+ decodeRelayClientFrame,
4
+ RELAY_CLOSE,
5
+ type RelayClientFrame
6
+ } from '#cloud/contract'
7
+
8
+ import { authorizeRelayTicket, principalKey, type RelayAuthorization } from './authorize'
9
+ import type { RelayPeerState } from './resume'
10
+
11
+ /** One client's socket, as a runtime adapter hands it to the relay. */
12
+ export type RelaySocket = {
13
+ send(data: Uint8Array): void
14
+ close(code: number, reason: string): void
15
+ /**
16
+ * Keeps the peer's state with the socket, for a runtime that sets the relay aside while sockets
17
+ * stay open and resumes their peers with `resume` when it wakes.
18
+ */
19
+ remember?(state: RelayPeerState): void
20
+ }
21
+
22
+ /** What the adapter reports back about that socket. */
23
+ export type RelayConnection = {
24
+ receive(data: Uint8Array): void
25
+ closed(): void
26
+ }
27
+
28
+ /** A socket admitted to a room, as the person and permission its ticket names. */
29
+ export type RelayPeer = {
30
+ id: string
31
+ socket: RelaySocket
32
+ authorization: RelayAuthorization
33
+ presenceClients: Set<number>
34
+ }
35
+
36
+ /** A room message from an admitted peer. */
37
+ export type RelayRoomFrame = Extract<RelayClientFrame, { type: 'message' }>
38
+
39
+ /** What a connection asks of the relay it belongs to. */
40
+ export type ConnectionRelay = {
41
+ authSecret: string
42
+ /** The one document the relay serves, when it serves one. */
43
+ documentId?: string
44
+ maximumMessageBytes: number
45
+ /** The most an editor's update may carry once its fragments are joined. */
46
+ maximumUpdateBytes: number
47
+ authTimeoutMs: number
48
+ /** Admits a newcomer whose ticket verified, or turns it away and answers null. */
49
+ admit(socket: RelaySocket, authorization: RelayAuthorization): Promise<RelayPeer | null>
50
+ /** Takes a refreshed ticket for a peer already in its room. */
51
+ refreshed(peer: RelayPeer): void
52
+ /** Handles a peer's room message; a promise while it waits for the room's document. */
53
+ deliver(peer: RelayPeer, frame: RelayRoomFrame): Promise<void> | undefined
54
+ depart(peer: RelayPeer): void
55
+ report(message: string, error: unknown): void
56
+ }
57
+
58
+ /**
59
+ * A socket's connection: a new one, which presents a ticket before it joins, or one resumed with
60
+ * the peer it already is. It joins fragmented frames, holds what arrives while a ticket is checked
61
+ * or the room's document loads, and refreshes tickets.
62
+ */
63
+ export function openRelayConnection(
64
+ socket: RelaySocket,
65
+ resumed: RelayPeer | null,
66
+ relay: ConnectionRelay
67
+ ): RelayConnection {
68
+ let peer: RelayPeer | null = resumed
69
+ /** Read through an object, since it changes across awaits and between messages. */
70
+ const state = { closed: false, busy: false }
71
+ const isClosed = () => state.closed
72
+ const queued: Uint8Array[] = []
73
+ let queuedBytes = 0
74
+ // Only an editor's writes can be large: a viewer's frames, and a peer's before it is
75
+ // admitted, fit in one message, so nobody else can make the relay hold more.
76
+ const assembler = createRelayClientAssembler(() =>
77
+ peer?.authorization.permission === 'edit' ? relay.maximumUpdateBytes : relay.maximumMessageBytes
78
+ )
79
+ const authTimer = resumed
80
+ ? undefined
81
+ : setTimeout(
82
+ () => socket.close(RELAY_CLOSE.unauthorized, 'Expected a collaboration ticket'),
83
+ relay.authTimeoutMs
84
+ )
85
+
86
+ async function authenticate(token: string) {
87
+ let authorization: RelayAuthorization
88
+ try {
89
+ authorization = await authorizeRelayTicket(token, relay.authSecret)
90
+ } catch {
91
+ socket.close(RELAY_CLOSE.unauthorized, 'Invalid collaboration ticket')
92
+ return
93
+ }
94
+ if (relay.documentId !== undefined && authorization.documentId !== relay.documentId) {
95
+ socket.close(RELAY_CLOSE.unauthorized, 'Ticket is for a different document')
96
+ return
97
+ }
98
+ if (state.closed) return
99
+ if (peer) {
100
+ // A refreshed ticket keeps the peer in its room as the same person; a lowered
101
+ // permission applies from now on.
102
+ const current = peer.authorization
103
+ if (
104
+ authorization.roomId !== current.roomId ||
105
+ principalKey(authorization.principal) !== principalKey(current.principal)
106
+ ) {
107
+ socket.close(RELAY_CLOSE.unauthorized, 'Ticket is for a different room or person')
108
+ return
109
+ }
110
+ peer.authorization = authorization
111
+ relay.refreshed(peer)
112
+ return
113
+ }
114
+ clearTimeout(authTimer)
115
+ const admitted = await relay.admit(socket, authorization)
116
+ // The socket may have closed while the room loaded.
117
+ if (admitted && isClosed()) relay.depart(admitted)
118
+ else peer = admitted
119
+ }
120
+
121
+ function process(data: Uint8Array) {
122
+ if (data.byteLength > relay.maximumMessageBytes) {
123
+ socket.close(RELAY_CLOSE.messageTooLarge, 'Collaboration message is too large')
124
+ return
125
+ }
126
+ const assembled = assembler.push(data)
127
+ if (assembled.type === 'partial') return
128
+ if (assembled.type === 'too-large') {
129
+ socket.close(RELAY_CLOSE.messageTooLarge, 'Collaboration message is too large')
130
+ return
131
+ }
132
+ const frame = assembled.type === 'frame' ? decodeRelayClientFrame(assembled.data) : null
133
+ if (!frame) {
134
+ socket.close(RELAY_CLOSE.protocol, 'Malformed collaboration frame')
135
+ return
136
+ }
137
+ if (frame.type === 'auth') {
138
+ state.busy = true
139
+ void authenticate(frame.token)
140
+ .catch((error: unknown) => {
141
+ relay.report('Admitting a collaboration peer failed', error)
142
+ socket.close(RELAY_CLOSE.protocol, 'Could not open the collaboration room')
143
+ })
144
+ .finally(() => {
145
+ state.busy = false
146
+ flush()
147
+ })
148
+ return
149
+ }
150
+ if (!peer) {
151
+ socket.close(RELAY_CLOSE.unauthorized, 'Expected a collaboration ticket')
152
+ return
153
+ }
154
+ const delivered = relay.deliver(peer, frame)
155
+ if (!delivered) return
156
+ // The room's document is loading; this peer's later messages wait for it.
157
+ state.busy = true
158
+ void delivered.finally(() => {
159
+ state.busy = false
160
+ flush()
161
+ })
162
+ }
163
+
164
+ function flush() {
165
+ while (!state.busy && !state.closed && queued.length > 0) {
166
+ const next = queued.shift()
167
+ if (!next) continue
168
+ queuedBytes -= next.byteLength
169
+ process(next)
170
+ }
171
+ }
172
+
173
+ return {
174
+ receive(data) {
175
+ if (state.closed) return
176
+ queuedBytes += data.byteLength
177
+ // Before admission a peer has sent its ticket and has nothing else to say, so what
178
+ // waits for the room to open is held to one message's worth.
179
+ if (!peer && queuedBytes > relay.maximumMessageBytes) {
180
+ queued.length = 0
181
+ queuedBytes = 0
182
+ socket.close(RELAY_CLOSE.messageTooLarge, 'Too much sent before joining the room')
183
+ return
184
+ }
185
+ queued.push(data)
186
+ flush()
187
+ },
188
+ closed() {
189
+ state.closed = true
190
+ queued.length = 0
191
+ queuedBytes = 0
192
+ clearTimeout(authTimer)
193
+ if (peer) relay.depart(peer)
194
+ }
195
+ }
196
+ }
@@ -1,11 +1,15 @@
1
1
  import type { CloudDatabase } from '#cloud/server/db'
2
2
  import { CLOUD_FEATURE_KEYS } from '#cloud/server/policy/keys'
3
3
  import type { CloudPolicy } from '#cloud/server/policy/policy'
4
+ import { workspacePolicyContext } from '#cloud/server/policy/workspace'
4
5
  import type { Kysely } from 'kysely'
5
6
 
6
7
  import type { CollaborationRelayOptions } from './hub'
7
8
 
8
- /** The relay's lookups of a document: its participant limit under `policy`, and its epoch. */
9
+ /**
10
+ * The relay's lookups of a document: its participant limit under `policy`, none while it is taken
11
+ * down, and its epoch.
12
+ */
9
13
  export function relayDocumentLookups(
10
14
  database: Kysely<CloudDatabase>,
11
15
  policy: CloudPolicy,
@@ -13,18 +17,17 @@ export function relayDocumentLookups(
13
17
  ): Pick<CollaborationRelayOptions, 'maximumParticipants' | 'currentRoomEpoch'> {
14
18
  return {
15
19
  async maximumParticipants(documentId) {
16
- const document = await database
20
+ // A taken-down document's room takes nobody, even with a ticket issued before.
21
+ const open = await database
17
22
  .selectFrom('document')
18
- .select('workspaceId')
23
+ .select('id')
19
24
  .where('id', '=', documentId)
25
+ .where('disabledAt', 'is', null)
20
26
  .executeTakeFirst()
21
- if (!document) return 0
22
- const limit = await policy.number(CLOUD_FEATURE_KEYS.maximumParticipants, -1, {
23
- targetingKey: document.workspaceId,
24
- workspaceId: document.workspaceId,
25
- documentId,
26
- deploymentMode
27
- })
27
+ if (!open) return 0
28
+ const context = await workspacePolicyContext(database, { documentId }, { deploymentMode })
29
+ if (!context) return 0
30
+ const limit = await policy.number(CLOUD_FEATURE_KEYS.maximumParticipants, -1, context)
28
31
  return limit < 0 ? null : limit
29
32
  },
30
33
  async currentRoomEpoch(documentId) {