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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (339) hide show
  1. package/README.md +3 -2
  2. package/dist/bin/server.mjs +1 -1
  3. package/dist/bin/server.mjs.map +1 -1
  4. package/dist/bin/{ai-relay.mjs → services.mjs} +9 -9
  5. package/dist/bin/services.mjs.map +1 -0
  6. package/dist/client.d.ts +525 -66
  7. package/dist/client.d.ts.map +1 -1
  8. package/dist/client.js +1257 -654
  9. package/dist/client.js.map +1 -1
  10. package/dist/contract.d.ts +2 -2
  11. package/dist/contract.js +2 -2
  12. package/dist/contract2.js +1028 -481
  13. package/dist/contract2.js.map +1 -1
  14. package/dist/email.d.ts +1780 -31
  15. package/dist/email.d.ts.map +1 -1
  16. package/dist/email.js +3556 -325
  17. package/dist/email.js.map +1 -1
  18. package/dist/errors.d.ts +2 -0
  19. package/dist/errors.js +48 -0
  20. package/dist/errors.js.map +1 -0
  21. package/dist/index.d.ts +929 -72
  22. package/dist/index.d.ts.map +1 -1
  23. package/dist/index2.d.ts +35 -0
  24. package/dist/index2.d.ts.map +1 -0
  25. package/dist/listen.mjs +802 -927
  26. package/dist/listen.mjs.map +1 -1
  27. package/dist/runtime-cloudflare.d.ts +89 -0
  28. package/dist/runtime-cloudflare.d.ts.map +1 -0
  29. package/dist/runtime-cloudflare.js +15667 -0
  30. package/dist/runtime-cloudflare.js.map +1 -0
  31. package/dist/runtime-node.d.mts +7166 -3101
  32. package/dist/runtime-node.d.mts.map +1 -1
  33. package/dist/runtime-node.mjs +6 -5
  34. package/dist/runtime-node.mjs.map +1 -1
  35. package/dist/server.d.ts +6525 -2205
  36. package/dist/server.d.ts.map +1 -1
  37. package/dist/server.js +12500 -7613
  38. package/dist/server.js.map +1 -1
  39. package/dist/server.mjs +8625 -2878
  40. package/dist/server.mjs.map +1 -1
  41. package/dist/server2.mjs +101 -79
  42. package/dist/server2.mjs.map +1 -1
  43. package/package.json +27 -9
  44. package/src/admin/api/routes.ts +59 -0
  45. package/src/admin/audit/service.ts +27 -8
  46. package/src/admin/documents/service.ts +431 -0
  47. package/src/admin/errors.ts +9 -1
  48. package/src/admin/index.ts +6 -0
  49. package/src/admin/operations/service.ts +7 -0
  50. package/src/admin/reports/service.ts +153 -0
  51. package/src/admin/schema.ts +6 -0
  52. package/src/client/api.ts +28 -461
  53. package/src/client/auth/client.ts +22 -3
  54. package/src/client/auth/navigation.ts +6 -5
  55. package/src/client/billing.ts +80 -0
  56. package/src/client/community.ts +40 -0
  57. package/src/client/discovery.ts +35 -9
  58. package/src/client/documents.ts +160 -0
  59. package/src/client/index.ts +14 -7
  60. package/src/client/portal/account.ts +79 -2
  61. package/src/client/portal/administration.ts +56 -0
  62. package/src/client/portal/request.ts +2 -0
  63. package/src/client/response.ts +21 -0
  64. package/src/client/schema.ts +8 -0
  65. package/src/client/services.ts +118 -0
  66. package/src/client/sharing.ts +262 -0
  67. package/src/client/versions.ts +104 -0
  68. package/src/contract/account.ts +108 -2
  69. package/src/contract/admin/index.ts +67 -3
  70. package/src/contract/billing.ts +166 -0
  71. package/src/contract/collaboration.ts +11 -1
  72. package/src/contract/community.ts +60 -0
  73. package/src/contract/discovery.ts +83 -4
  74. package/src/contract/documents.ts +27 -0
  75. package/src/contract/entitlements.ts +12 -2
  76. package/src/contract/index.ts +114 -39
  77. package/src/contract/links.ts +57 -4
  78. package/src/contract/locale.ts +27 -0
  79. package/src/contract/portal.ts +12 -1
  80. package/src/contract/relay.ts +6 -0
  81. package/src/contract/reports.ts +42 -0
  82. package/src/contract/routes.ts +10 -0
  83. package/src/contract/services.ts +235 -0
  84. package/src/contract/sharing.ts +3 -9
  85. package/src/email/i18n.ts +174 -0
  86. package/src/email/index.ts +13 -2
  87. package/src/email/locales/ar.json +141 -0
  88. package/src/email/locales/de.json +141 -0
  89. package/src/email/locales/es.json +141 -0
  90. package/src/email/locales/fr.json +141 -0
  91. package/src/email/locales/it.json +141 -0
  92. package/src/email/locales/ja.json +141 -0
  93. package/src/email/locales/pl.json +141 -0
  94. package/src/email/locales/pt-br.json +141 -0
  95. package/src/email/locales/ru.json +141 -0
  96. package/src/email/locales/zh-cn.json +141 -0
  97. package/src/email/messages.ts +200 -0
  98. package/src/email/render.ts +138 -246
  99. package/src/email/samples.ts +115 -0
  100. package/src/email/schema.ts +79 -5
  101. package/src/email/templates/BrandEmail.vue +54 -0
  102. package/src/email/templates/DocumentBlocked.vue +45 -0
  103. package/src/email/templates/DocumentInvitation.vue +24 -0
  104. package/src/email/templates/DocumentReport.vue +32 -0
  105. package/src/email/templates/DocumentReportDecided.vue +36 -0
  106. package/src/email/templates/DocumentReportReceived.vue +18 -0
  107. package/src/email/templates/DocumentRestored.vue +24 -0
  108. package/src/email/templates/EmailChangeRequested.vue +24 -0
  109. package/src/email/templates/EmailRoot.vue +19 -0
  110. package/src/email/templates/EmailText.vue +9 -0
  111. package/src/email/templates/EmailVerification.vue +38 -0
  112. package/src/email/templates/EnrollmentNotification.vue +24 -0
  113. package/src/email/templates/EnrollmentUpdate.vue +52 -0
  114. package/src/email/templates/NewSignIn.vue +37 -0
  115. package/src/email/templates/PasswordChanged.vue +22 -0
  116. package/src/email/templates/PasswordReset.vue +23 -0
  117. package/src/email/templates/StorageLimitReached.vue +28 -0
  118. package/src/email/templates/TwoStepChanged.vue +32 -0
  119. package/src/email/templates/WaitlistConfirmation.vue +29 -0
  120. package/src/email/templates/WorkspaceInvitation.vue +28 -0
  121. package/src/email/templates/brand.ts +9 -61
  122. package/src/email/templates/localization.ts +17 -0
  123. package/src/errors/index.ts +6 -0
  124. package/src/errors/posthog.ts +80 -0
  125. package/src/global.d.ts +7 -0
  126. package/src/runtime/cloudflare/environment.ts +22 -11
  127. package/src/runtime/cloudflare/index.ts +1 -1
  128. package/src/runtime/cloudflare/logging.ts +15 -0
  129. package/src/runtime/cloudflare/maintenance.ts +31 -0
  130. package/src/runtime/cloudflare/relay/index.ts +69 -15
  131. package/src/runtime/cloudflare/tsconfig.json +2 -1
  132. package/src/runtime/cloudflare/worker.ts +46 -13
  133. package/src/runtime/node/application.ts +5 -3
  134. package/src/runtime/node/bootstrap.ts +15 -4
  135. package/src/runtime/node/cleanup.ts +20 -3
  136. package/src/runtime/node/email/transport.ts +13 -10
  137. package/src/runtime/node/entitlements/main.ts +14 -11
  138. package/src/runtime/node/index.ts +1 -1
  139. package/src/runtime/node/main.ts +1 -1
  140. package/src/runtime/node/migrate.ts +5 -1
  141. package/src/runtime/node/relay.ts +8 -2
  142. package/src/runtime/node/request-id.ts +13 -0
  143. package/src/runtime/node/server.ts +50 -16
  144. package/src/runtime/node/{ai-relay → services}/main.ts +7 -7
  145. package/src/runtime/node/{ai-relay → services}/server.ts +18 -18
  146. package/src/runtime/postgres/database.ts +20 -1
  147. package/src/runtime/posthog/errors.ts +15 -30
  148. package/src/runtime/s3/objects.ts +41 -1
  149. package/src/runtime/site/community.ts +101 -0
  150. package/src/runtime/site/server.ts +49 -6
  151. package/src/server/account/actions.ts +5 -0
  152. package/src/server/account/deletion.ts +304 -0
  153. package/src/server/account/routes.ts +281 -206
  154. package/src/server/account/terms.ts +42 -0
  155. package/src/server/account/tokens.ts +57 -0
  156. package/src/server/api/router.ts +32 -5
  157. package/src/server/api/types.ts +2 -0
  158. package/src/server/app/checks.ts +84 -0
  159. package/src/server/app/editors.ts +20 -0
  160. package/src/server/app/index.ts +128 -0
  161. package/src/server/app/indexing.ts +40 -0
  162. package/src/server/app/limiters.ts +53 -0
  163. package/src/server/app/routes.ts +114 -0
  164. package/src/server/app/services.ts +185 -0
  165. package/src/server/auth/access-control.ts +63 -0
  166. package/src/server/auth/access-tokens.ts +62 -0
  167. package/src/server/auth/adapter.ts +32 -1
  168. package/src/server/auth/email.ts +4 -1
  169. package/src/server/auth/endpoints.ts +5 -1
  170. package/src/server/auth/enrollment.ts +116 -0
  171. package/src/server/auth/factory.ts +116 -132
  172. package/src/server/auth/index.ts +10 -1
  173. package/src/server/auth/logger.ts +23 -0
  174. package/src/server/auth/mfa-assurance.ts +51 -0
  175. package/src/server/auth/passwords.ts +43 -0
  176. package/src/server/auth/session.ts +2 -0
  177. package/src/server/billing/index.ts +6 -0
  178. package/src/server/billing/routes.ts +27 -0
  179. package/src/server/billing/tokens.ts +37 -0
  180. package/src/server/cleanup/configured.ts +27 -7
  181. package/src/server/cleanup/documents.ts +165 -71
  182. package/src/server/cleanup/revisions.ts +16 -5
  183. package/src/server/cleanup/uploads.ts +8 -2
  184. package/src/server/cleanup/worker.ts +15 -3
  185. package/src/server/collaboration/relay/connection.ts +4 -3
  186. package/src/server/collaboration/relay/documents.ts +13 -10
  187. package/src/server/collaboration/relay/hub.ts +77 -122
  188. package/src/server/collaboration/relay/log.ts +5 -2
  189. package/src/server/collaboration/relay/room.ts +154 -0
  190. package/src/server/collaboration/service.ts +48 -33
  191. package/src/server/community/index.ts +2 -0
  192. package/src/server/community/routes.ts +93 -0
  193. package/src/server/community/service.ts +134 -0
  194. package/src/server/config/deployment.ts +41 -9
  195. package/src/server/config/index.ts +1 -1
  196. package/src/server/config/public.ts +11 -4
  197. package/src/server/config/schema.ts +91 -277
  198. package/src/server/config/toml/schema.ts +307 -0
  199. package/src/server/db/expressions.ts +15 -1
  200. package/src/server/db/index.ts +1 -0
  201. package/src/server/db/migrate.ts +46 -116
  202. package/src/server/db/migrations/001_accounts.ts +79 -0
  203. package/src/server/db/migrations/002_workspaces.ts +48 -0
  204. package/src/server/db/migrations/003_storage.ts +44 -0
  205. package/src/server/db/migrations/004_documents.ts +193 -0
  206. package/src/server/db/migrations/005_sharing.ts +95 -0
  207. package/src/server/db/migrations/006_operations.ts +110 -0
  208. package/src/server/db/migrations/007_trash.ts +33 -0
  209. package/src/server/db/migrations/008_terms.ts +18 -0
  210. package/src/server/db/migrations/009_access_tokens.ts +47 -0
  211. package/src/server/db/migrations/010_storage_limit_notices.ts +50 -0
  212. package/src/server/db/migrations/011_account_ids.ts +30 -0
  213. package/src/server/db/migrations/012_email_locales.ts +34 -0
  214. package/src/server/db/migrations/013_document_block_emails.ts +40 -0
  215. package/src/server/db/migrations/014_report_replies.ts +28 -0
  216. package/src/server/db/migrations/schema.ts +96 -0
  217. package/src/server/db/tables.ts +82 -4
  218. package/src/server/db/users.ts +22 -0
  219. package/src/server/documents/access.ts +66 -55
  220. package/src/server/documents/errors.ts +7 -0
  221. package/src/server/documents/images.ts +2 -1
  222. package/src/server/documents/index.ts +1 -1
  223. package/src/server/documents/limits.ts +14 -8
  224. package/src/server/documents/purge.ts +75 -0
  225. package/src/server/documents/repository.ts +2 -0
  226. package/src/server/documents/routes.ts +26 -0
  227. package/src/server/documents/service.ts +30 -406
  228. package/src/server/documents/summary.ts +1 -0
  229. package/src/server/documents/trash.ts +203 -0
  230. package/src/server/documents/uploads.ts +450 -0
  231. package/src/server/documents/versions/checkpoint.ts +2 -1
  232. package/src/server/documents/versions/history.ts +11 -7
  233. package/src/server/documents/versions/service.ts +94 -28
  234. package/src/server/email/invitations.ts +1 -0
  235. package/src/server/email/service.ts +31 -4
  236. package/src/server/email/types.ts +12 -0
  237. package/src/server/errors/index.ts +51 -16
  238. package/src/server/index.ts +52 -16
  239. package/src/server/internal/index.ts +3 -3
  240. package/src/server/internal/routes.ts +7 -10
  241. package/src/server/internal/schema.ts +1 -1
  242. package/src/server/internal/service.ts +17 -23
  243. package/src/server/invitations/budget.ts +66 -0
  244. package/src/server/invitations/index.ts +1 -0
  245. package/src/server/invitations/types.ts +5 -1
  246. package/src/server/logging.ts +76 -0
  247. package/src/server/objects/types.ts +5 -0
  248. package/src/server/pictures/service.ts +2 -1
  249. package/src/server/policy/configured.ts +9 -3
  250. package/src/server/policy/database.ts +52 -27
  251. package/src/server/policy/index.ts +2 -1
  252. package/src/server/policy/keys.ts +5 -2
  253. package/src/server/policy/policy.ts +40 -12
  254. package/src/server/policy/schema.ts +2 -2
  255. package/src/server/policy/service.ts +78 -56
  256. package/src/server/policy/static.ts +5 -5
  257. package/src/server/policy/storage.ts +33 -0
  258. package/src/server/policy/workspace.ts +41 -0
  259. package/src/server/quota/index.ts +6 -0
  260. package/src/server/quota/notices.ts +121 -0
  261. package/src/server/quota/reconcile.ts +2 -0
  262. package/src/server/quota/storage.ts +74 -31
  263. package/src/server/rate-limit/cleanup.ts +17 -5
  264. package/src/server/rate-limit/middleware.ts +6 -2
  265. package/src/server/reports/index.ts +9 -0
  266. package/src/server/reports/replies.ts +55 -0
  267. package/src/server/reports/routes.ts +39 -0
  268. package/src/server/reports/service.ts +145 -0
  269. package/src/server/services/errors.ts +7 -0
  270. package/src/server/services/index.ts +8 -0
  271. package/src/server/{ai → services}/keys.ts +11 -11
  272. package/src/server/services/routes.ts +47 -0
  273. package/src/server/{ai/service.ts → services/tokens.ts} +23 -20
  274. package/src/server/sharing/capabilities/service.ts +68 -23
  275. package/src/server/sharing/grants/service.ts +11 -18
  276. package/src/server/sharing/http.ts +4 -0
  277. package/src/server/sharing/invitations/service.ts +35 -15
  278. package/src/server/sharing/policy.ts +9 -14
  279. package/src/server/sharing/routes.ts +0 -16
  280. package/src/server/sharing/service.ts +1 -17
  281. package/src/server/validation.ts +4 -0
  282. package/src/server/workspaces/index.ts +1 -0
  283. package/src/server/workspaces/members.ts +91 -52
  284. package/src/server/workspaces/repository.ts +2 -1
  285. package/src/server/workspaces/routes.ts +4 -0
  286. package/src/{ai-relay → services}/app.ts +46 -44
  287. package/src/{ai-relay → services}/config.ts +26 -19
  288. package/src/services/db/index.ts +10 -0
  289. package/src/services/db/migrate.ts +37 -0
  290. package/src/{ai-relay/db/migrations/001_usage.ts → services/db/migrations/001_baseline.ts} +18 -7
  291. package/src/services/db/schema.ts +22 -0
  292. package/src/services/index.ts +18 -0
  293. package/src/{ai-relay → services}/metering.ts +2 -2
  294. package/src/{ai-relay → services}/usage.ts +35 -19
  295. package/dist/bin/ai-relay.mjs.map +0 -1
  296. package/src/ai-relay/db/index.ts +0 -10
  297. package/src/ai-relay/db/migrate.ts +0 -32
  298. package/src/ai-relay/db/schema.ts +0 -20
  299. package/src/ai-relay/index.ts +0 -18
  300. package/src/client/ai.ts +0 -96
  301. package/src/contract/ai.ts +0 -150
  302. package/src/email/templates/document-invitation.ts +0 -35
  303. package/src/email/templates/enrollment.ts +0 -27
  304. package/src/email/templates/layout.ts +0 -18
  305. package/src/server/ai/errors.ts +0 -7
  306. package/src/server/ai/index.ts +0 -4
  307. package/src/server/ai/routes.ts +0 -43
  308. package/src/server/app.ts +0 -379
  309. package/src/server/auth/workspace-access.ts +0 -23
  310. package/src/server/db/migrations/001_foundation.ts +0 -164
  311. package/src/server/db/migrations/002_upload_cleanup_claims.ts +0 -34
  312. package/src/server/db/migrations/003_document_cleanup_claims.ts +0 -23
  313. package/src/server/db/migrations/004_document_sharing.ts +0 -82
  314. package/src/server/db/migrations/005_document_collaboration_epoch.ts +0 -13
  315. package/src/server/db/migrations/006_invitation_continuation.ts +0 -27
  316. package/src/server/db/migrations/007_collaboration_state.ts +0 -25
  317. package/src/server/db/migrations/008_storage_reservations.ts +0 -37
  318. package/src/server/db/migrations/009_workspace_entitlements.ts +0 -22
  319. package/src/server/db/migrations/010_upload_finalization.ts +0 -22
  320. package/src/server/db/migrations/011_upload_finalization_lease.ts +0 -12
  321. package/src/server/db/migrations/012_transactional_email.ts +0 -48
  322. package/src/server/db/migrations/013_admin_enrollment.ts +0 -54
  323. package/src/server/db/migrations/014_enrollment_email_kinds.ts +0 -30
  324. package/src/server/db/migrations/015_cloud_rate_limit.ts +0 -22
  325. package/src/server/db/migrations/016_auth_schema.ts +0 -16
  326. package/src/server/db/migrations/017_authentication_email_kinds.ts +0 -32
  327. package/src/server/db/migrations/018_authentication_mfa.ts +0 -78
  328. package/src/server/db/migrations/019_better_auth_account_issuer.ts +0 -42
  329. package/src/server/db/migrations/020_workspace_invitations.ts +0 -57
  330. package/src/server/db/migrations/021_document_versions.ts +0 -66
  331. package/src/server/db/migrations/022_entitlement_external_version.ts +0 -17
  332. package/src/server/db/migrations/023_document_images.ts +0 -61
  333. package/src/server/db/migrations/024_account_activity.ts +0 -66
  334. package/src/server/db/migrations/025_table_names.ts +0 -58
  335. package/src/server/db/migrations/026_user_picture.ts +0 -30
  336. package/src/server/db/migrations/027_document_kind.ts +0 -19
  337. package/src/server/db/migrations/028_collaboration_updates.ts +0 -84
  338. package/src/server/db/migrations/helpers.ts +0 -78
  339. /package/dist/bin/{ai-relay.d.mts → services.d.mts} +0 -0
@@ -0,0 +1,262 @@
1
+ import {
2
+ acceptedInvitationSchema,
3
+ createInvitationContinuationSchema,
4
+ documentDownloadSchema,
5
+ documentGrantSchema,
6
+ documentInvitationSchema,
7
+ documentShareSchema,
8
+ invitationContinuationSchema,
9
+ invitationPreviewSchema,
10
+ resolvedDocumentShareSchema,
11
+ type AcceptDocumentInvitationInput,
12
+ type CollaborationTicket,
13
+ type CreateInvitationContinuationInput,
14
+ type InvitationContinuation,
15
+ type CreateDocumentInvitationInput,
16
+ type CreateDocumentShareInput,
17
+ type DocumentGrant,
18
+ type DocumentInvitation,
19
+ type DocumentShare,
20
+ type InvitationPreview,
21
+ type PutDocumentGrantInput,
22
+ type ResolveDocumentShareInput,
23
+ fileDocumentReportResponseSchema,
24
+ type FileDocumentReportInput,
25
+ type UpdateDocumentShareInput,
26
+ type AcceptedInvitation
27
+ } from '#cloud/contract'
28
+ import type { CloudAPI, PublicCloudAPI } from '#cloud/server/api'
29
+ import type { hc } from 'hono/client'
30
+ import * as v from 'valibot'
31
+
32
+ import { parseResponse, responseBody, type CloudClientDiagnostic } from './response'
33
+ import { collaborationTicketResponseSchema } from './schema'
34
+
35
+ const sharesResponseSchema = v.object({ shares: v.array(documentShareSchema) })
36
+ const shareResponseSchema = v.object({ share: documentShareSchema })
37
+ const shareCapabilityResponseSchema = v.object({
38
+ share: documentShareSchema,
39
+ secret: v.string(),
40
+ path: v.string()
41
+ })
42
+ const grantsResponseSchema = v.object({ grants: v.array(documentGrantSchema) })
43
+ const grantResponseSchema = v.object({ grant: documentGrantSchema })
44
+ const acceptedResponseSchema = v.object({ accepted: acceptedInvitationSchema })
45
+ const invitationPreviewResponseSchema = v.object({ invitation: invitationPreviewSchema })
46
+ const invitationsResponseSchema = v.object({ invitations: v.array(documentInvitationSchema) })
47
+ const invitationCapabilityResponseSchema = v.object({
48
+ invitation: documentInvitationSchema,
49
+ token: v.string()
50
+ })
51
+ const resolvedShareResponseSchema = v.object({ resolution: resolvedDocumentShareSchema })
52
+ const sharedDocumentResponseSchema = v.object({
53
+ resolution: resolvedDocumentShareSchema,
54
+ document: documentDownloadSchema
55
+ })
56
+
57
+ /** Sharing a document: its links, grants, and invitations, and opening what someone shared. */
58
+ export function createSharingRequests(
59
+ client: ReturnType<typeof hc<CloudAPI>>,
60
+ publicClient: ReturnType<typeof hc<PublicCloudAPI>>,
61
+ onDiagnostic?: CloudClientDiagnostic
62
+ ) {
63
+ return {
64
+ async listDocumentShares(documentId: string): Promise<DocumentShare[]> {
65
+ const response = await parseResponse(
66
+ client.documents[':documentId'].shares.$get({ param: { documentId } }),
67
+ sharesResponseSchema,
68
+ onDiagnostic
69
+ )
70
+ return response.shares
71
+ },
72
+ async createDocumentShare(documentId: string, input: CreateDocumentShareInput) {
73
+ return parseResponse(
74
+ client.documents[':documentId'].shares.$post({
75
+ param: { documentId },
76
+ json: input
77
+ }),
78
+ shareCapabilityResponseSchema,
79
+ onDiagnostic
80
+ )
81
+ },
82
+ async updateDocumentShare(
83
+ documentId: string,
84
+ shareId: string,
85
+ input: UpdateDocumentShareInput
86
+ ): Promise<DocumentShare> {
87
+ const response = await parseResponse(
88
+ client.documents[':documentId'].shares[':shareId'].$patch({
89
+ param: { documentId, shareId },
90
+ json: input
91
+ }),
92
+ shareResponseSchema,
93
+ onDiagnostic
94
+ )
95
+ return response.share
96
+ },
97
+ async rotateDocumentShare(documentId: string, shareId: string) {
98
+ return parseResponse(
99
+ client.documents[':documentId'].shares[':shareId'].rotate.$post({
100
+ param: { documentId, shareId }
101
+ }),
102
+ shareCapabilityResponseSchema,
103
+ onDiagnostic
104
+ )
105
+ },
106
+ async revokeDocumentShare(documentId: string, shareId: string): Promise<void> {
107
+ await responseBody(
108
+ await client.documents[':documentId'].shares[':shareId'].$delete({
109
+ param: { documentId, shareId }
110
+ }),
111
+ onDiagnostic
112
+ )
113
+ },
114
+ async listDocumentGrants(documentId: string): Promise<DocumentGrant[]> {
115
+ const response = await parseResponse(
116
+ client.documents[':documentId'].grants.$get({ param: { documentId } }),
117
+ grantsResponseSchema,
118
+ onDiagnostic
119
+ )
120
+ return response.grants
121
+ },
122
+ async putDocumentGrant(
123
+ documentId: string,
124
+ userId: string,
125
+ input: PutDocumentGrantInput
126
+ ): Promise<DocumentGrant> {
127
+ const response = await parseResponse(
128
+ client.documents[':documentId'].grants[':userId'].$put({
129
+ param: { documentId, userId },
130
+ json: input
131
+ }),
132
+ grantResponseSchema,
133
+ onDiagnostic
134
+ )
135
+ return response.grant
136
+ },
137
+ async revokeDocumentGrant(documentId: string, userId: string): Promise<void> {
138
+ await responseBody(
139
+ await client.documents[':documentId'].grants[':userId'].$delete({
140
+ param: { documentId, userId }
141
+ }),
142
+ onDiagnostic
143
+ )
144
+ },
145
+ async listDocumentInvitations(documentId: string): Promise<DocumentInvitation[]> {
146
+ const response = await parseResponse(
147
+ client.documents[':documentId'].invitations.$get({ param: { documentId } }),
148
+ invitationsResponseSchema,
149
+ onDiagnostic
150
+ )
151
+ return response.invitations
152
+ },
153
+ async createDocumentInvitation(documentId: string, input: CreateDocumentInvitationInput) {
154
+ return parseResponse(
155
+ client.documents[':documentId'].invitations.$post({
156
+ param: { documentId },
157
+ json: input
158
+ }),
159
+ invitationCapabilityResponseSchema,
160
+ onDiagnostic
161
+ )
162
+ },
163
+ async createInvitationContinuation(
164
+ input: CreateInvitationContinuationInput
165
+ ): Promise<InvitationContinuation> {
166
+ return parseResponse(
167
+ publicClient.invitations.continuations.$post({ json: input }),
168
+ invitationContinuationSchema,
169
+ onDiagnostic
170
+ )
171
+ },
172
+ async consumeInvitationContinuation(id: string): Promise<CreateInvitationContinuationInput> {
173
+ return parseResponse(
174
+ publicClient.invitations.continuations[':continuationId'].consume.$post({
175
+ param: { continuationId: id }
176
+ }),
177
+ createInvitationContinuationSchema,
178
+ onDiagnostic
179
+ )
180
+ },
181
+ async previewInvitation(
182
+ invitationId: string,
183
+ input: AcceptDocumentInvitationInput
184
+ ): Promise<InvitationPreview> {
185
+ const response = await parseResponse(
186
+ publicClient.invitations[':invitationId'].preview.$post({
187
+ param: { invitationId },
188
+ json: input
189
+ }),
190
+ invitationPreviewResponseSchema,
191
+ onDiagnostic
192
+ )
193
+ return response.invitation
194
+ },
195
+ /** Accepts a document or workspace invitation, and says which it was. */
196
+ async acceptInvitation(
197
+ invitationId: string,
198
+ input: AcceptDocumentInvitationInput
199
+ ): Promise<AcceptedInvitation> {
200
+ const response = await parseResponse(
201
+ client.invitations[':invitationId'].accept.$post({
202
+ param: { invitationId },
203
+ json: input
204
+ }),
205
+ acceptedResponseSchema,
206
+ onDiagnostic
207
+ )
208
+ return response.accepted
209
+ },
210
+ async revokeDocumentInvitation(documentId: string, invitationId: string): Promise<void> {
211
+ await responseBody(
212
+ await client.documents[':documentId'].invitations[':invitationId'].$delete({
213
+ param: { documentId, invitationId }
214
+ }),
215
+ onDiagnostic
216
+ )
217
+ },
218
+ /** Reports the document a share link opens to the server's administrators. */
219
+ async fileDocumentReport(shareId: string, input: FileDocumentReportInput): Promise<void> {
220
+ await parseResponse(
221
+ publicClient.shares[':shareId'].reports.$post({ param: { shareId }, json: input }),
222
+ fileDocumentReportResponseSchema,
223
+ onDiagnostic
224
+ )
225
+ },
226
+ async resolveDocumentShare(shareId: string, input: ResolveDocumentShareInput) {
227
+ const response = await parseResponse(
228
+ publicClient.shares[':shareId'].resolve.$post({
229
+ param: { shareId },
230
+ json: input
231
+ }),
232
+ resolvedShareResponseSchema,
233
+ onDiagnostic
234
+ )
235
+ return response.resolution
236
+ },
237
+ async getSharedDocument(shareId: string, input: ResolveDocumentShareInput) {
238
+ return parseResponse(
239
+ publicClient.shares[':shareId'].document.$post({
240
+ param: { shareId },
241
+ json: input
242
+ }),
243
+ sharedDocumentResponseSchema,
244
+ onDiagnostic
245
+ )
246
+ },
247
+ async getSharedCollaborationTicket(
248
+ shareId: string,
249
+ input: ResolveDocumentShareInput
250
+ ): Promise<CollaborationTicket> {
251
+ const response = await parseResponse(
252
+ publicClient.shares[':shareId']['collaboration-ticket'].$post({
253
+ param: { shareId },
254
+ json: input
255
+ }),
256
+ collaborationTicketResponseSchema,
257
+ onDiagnostic
258
+ )
259
+ return response.ticket
260
+ }
261
+ }
262
+ }
@@ -0,0 +1,104 @@
1
+ import {
2
+ documentVersionDownloadSchema,
3
+ documentVersionResponseSchema,
4
+ documentVersionsSchema,
5
+ restoredDocumentSchema,
6
+ type DocumentSummary,
7
+ type DocumentVersion,
8
+ type DocumentVersionDownload,
9
+ type DocumentVersions,
10
+ type DuplicateDocumentVersionInput,
11
+ type SaveDocumentVersionInput,
12
+ type UpdateDocumentVersionInput
13
+ } from '#cloud/contract'
14
+ import type { CloudAPI } from '#cloud/server/api'
15
+ import { pickBy } from 'es-toolkit/object'
16
+ import type { hc } from 'hono/client'
17
+
18
+ import { parseResponse, type CloudClientDiagnostic } from './response'
19
+ import { documentResponseSchema } from './schema'
20
+
21
+ /** A document’s version history: listing, naming, opening, restoring, and duplicating. */
22
+ export function createVersionRequests(
23
+ client: ReturnType<typeof hc<CloudAPI>>,
24
+ onDiagnostic?: CloudClientDiagnostic
25
+ ) {
26
+ return {
27
+ /** A page of the document's version history, newest first. */
28
+ async listDocumentVersions(
29
+ documentId: string,
30
+ page: { before?: string; limit?: number } = {}
31
+ ): Promise<DocumentVersions> {
32
+ return parseResponse(
33
+ client.documents[':documentId'].versions.$get({
34
+ param: { documentId },
35
+ query: pickBy(page, (value) => value !== undefined)
36
+ }),
37
+ documentVersionsSchema,
38
+ onDiagnostic
39
+ )
40
+ },
41
+ async saveDocumentVersion(
42
+ documentId: string,
43
+ input: SaveDocumentVersionInput
44
+ ): Promise<DocumentVersion> {
45
+ const response = await parseResponse(
46
+ client.documents[':documentId'].versions.$post({ param: { documentId }, json: input }),
47
+ documentVersionResponseSchema,
48
+ onDiagnostic
49
+ )
50
+ return response.version
51
+ },
52
+ async updateDocumentVersion(
53
+ documentId: string,
54
+ versionId: string,
55
+ input: UpdateDocumentVersionInput
56
+ ): Promise<DocumentVersion> {
57
+ const response = await parseResponse(
58
+ client.documents[':documentId'].versions[':versionId'].$patch({
59
+ param: { documentId, versionId },
60
+ json: input
61
+ }),
62
+ documentVersionResponseSchema,
63
+ onDiagnostic
64
+ )
65
+ return response.version
66
+ },
67
+ async getDocumentVersion(
68
+ documentId: string,
69
+ versionId: string
70
+ ): Promise<DocumentVersionDownload> {
71
+ return parseResponse(
72
+ client.documents[':documentId'].versions[':versionId'].$get({
73
+ param: { documentId, versionId }
74
+ }),
75
+ documentVersionDownloadSchema,
76
+ onDiagnostic
77
+ )
78
+ },
79
+ async restoreDocumentVersion(documentId: string, versionId: string) {
80
+ return parseResponse(
81
+ client.documents[':documentId'].versions[':versionId'].restore.$post({
82
+ param: { documentId, versionId }
83
+ }),
84
+ restoredDocumentSchema,
85
+ onDiagnostic
86
+ )
87
+ },
88
+ async duplicateDocumentVersion(
89
+ documentId: string,
90
+ versionId: string,
91
+ input: DuplicateDocumentVersionInput
92
+ ): Promise<DocumentSummary> {
93
+ const response = await parseResponse(
94
+ client.documents[':documentId'].versions[':versionId'].duplicate.$post({
95
+ param: { documentId, versionId },
96
+ json: input
97
+ }),
98
+ documentResponseSchema,
99
+ onDiagnostic
100
+ )
101
+ return response.document
102
+ }
103
+ }
104
+ }
@@ -1,7 +1,17 @@
1
1
  import { isValid as isBase64 } from 'js-base64'
2
2
  import * as v from 'valibot'
3
3
 
4
- export const cloudAccountStateSchema = v.picklist(['active', 'pending', 'rejected', 'revoked'])
4
+ /**
5
+ * Where an account stands: it may use the server, waits for an administrator, was refused or had
6
+ * its access taken back, or has to accept the server's current terms first.
7
+ */
8
+ export const cloudAccountStateSchema = v.picklist([
9
+ 'active',
10
+ 'pending',
11
+ 'rejected',
12
+ 'revoked',
13
+ 'terms'
14
+ ])
5
15
  export const cloudIdentitySchema = v.object({
6
16
  userId: v.string(),
7
17
  email: v.pipe(v.string(), v.email()),
@@ -16,6 +26,9 @@ export const cloudAccountStatusResponseSchema = v.object({
16
26
  state: cloudAccountStateSchema
17
27
  })
18
28
 
29
+ /** Accepting the server's terms: the version the person read, which must be the current one. */
30
+ export const cloudTermsAcceptanceSchema = v.object({ version: v.pipe(v.string(), v.minLength(1)) })
31
+
19
32
  export const cloudAuthenticationProviderSchema = v.picklist(['credential', 'google', 'apple'])
20
33
  export const cloudAuthenticationMethodSchema = v.object({
21
34
  id: v.string(),
@@ -47,7 +60,10 @@ export const accountSecurityErrorCodeSchema = v.picklist([
47
60
  'email_unchanged',
48
61
  'email_change_unavailable',
49
62
  'current_session',
50
- 'picture_invalid'
63
+ 'picture_invalid',
64
+ 'account_sole_admin',
65
+ 'last_admin_required',
66
+ 'terms_changed'
51
67
  ])
52
68
  export const accountSecurityErrorResponseSchema = v.object({
53
69
  error: v.object({ code: accountSecurityErrorCodeSchema })
@@ -79,6 +95,57 @@ export const cloudPasskeySchema = v.object({
79
95
  export const cloudPasskeysResponseSchema = v.object({ passkeys: v.array(cloudPasskeySchema) })
80
96
  export const cloudPasskeyDeleteSchema = v.object({ id: v.string() })
81
97
 
98
+ /**
99
+ * Personal access tokens: an account's own credentials for scripts and CI, sent as
100
+ * `Authorization: Bearer <token>`. A token acts as its account on the document API only; it never
101
+ * changes how the account is reached, makes other tokens, or reaches administration.
102
+ */
103
+ export const CLOUD_ACCESS_TOKEN_PREFIX = 'opc_'
104
+ export const CLOUD_ACCESS_TOKEN_NAME_MAX_LENGTH = 64
105
+ export const CLOUD_ACCESS_TOKEN_MAX_DAYS = 365
106
+ export const cloudAccessTokenSchema = v.object({
107
+ id: v.string(),
108
+ name: v.string(),
109
+ /** The token's first characters, prefix included, to tell tokens apart; never the whole token. */
110
+ start: v.nullable(v.string()),
111
+ createdAt: v.string(),
112
+ expiresAt: v.nullable(v.string()),
113
+ lastUsedAt: v.nullable(v.string())
114
+ })
115
+ export const cloudAccessTokensResponseSchema = v.object({
116
+ tokens: v.array(cloudAccessTokenSchema)
117
+ })
118
+ export const cloudAccessTokenCreateSchema = v.object({
119
+ name: v.pipe(
120
+ v.string(),
121
+ v.trim(),
122
+ v.minLength(1),
123
+ v.maxLength(CLOUD_ACCESS_TOKEN_NAME_MAX_LENGTH)
124
+ ),
125
+ expiresInDays: v.pipe(
126
+ v.number(),
127
+ v.integer(),
128
+ v.minValue(1),
129
+ v.maxValue(CLOUD_ACCESS_TOKEN_MAX_DAYS)
130
+ )
131
+ })
132
+ /** A new token, the only time the whole of it is shown. */
133
+ export const cloudAccessTokenCreatedResponseSchema = v.object({
134
+ token: v.pipe(v.string(), v.startsWith(CLOUD_ACCESS_TOKEN_PREFIX)),
135
+ accessToken: cloudAccessTokenSchema
136
+ })
137
+ export const cloudAccessTokenRevokeSchema = v.object({ id: v.pipe(v.string(), v.minLength(1)) })
138
+
139
+ export function parseCloudAccessTokenCreate(input: unknown) {
140
+ return v.parse(cloudAccessTokenCreateSchema, input)
141
+ }
142
+ export function parseCloudAccessTokenRevoke(input: unknown) {
143
+ return v.parse(cloudAccessTokenRevokeSchema, input)
144
+ }
145
+
146
+ export function parseCloudTermsAcceptance(input: unknown) {
147
+ return v.parse(cloudTermsAcceptanceSchema, input)
148
+ }
82
149
  export function parseCloudMFAEnable(input: unknown) {
83
150
  return v.parse(cloudMFAEnableSchema, input)
84
151
  }
@@ -177,6 +244,39 @@ export const cloudSignInSchema = v.object({
177
244
  })
178
245
  export const cloudSignInsResponseSchema = v.object({ signIns: v.array(cloudSignInSchema) })
179
246
 
247
+ /** A workspace an account deletion reads: one it would delete, or one that stops it. */
248
+ export const cloudAccountDeletionWorkspaceSchema = v.object({
249
+ id: v.pipe(v.string(), v.uuid()),
250
+ name: v.string()
251
+ })
252
+ /** A document the account would lose, which Download all saves first. */
253
+ export const cloudAccountDeletionDocumentSchema = v.object({
254
+ id: v.pipe(v.string(), v.uuid()),
255
+ name: v.string(),
256
+ workspaceName: v.string()
257
+ })
258
+ /**
259
+ * What deleting the account takes: the workspaces only it belongs to, which go with their
260
+ * documents; the ones it leaves to their other members; the ones it alone administers for other
261
+ * members, which stop the deletion until it makes someone else an admin; and the documents it
262
+ * would lose, those workspaces' and the ones it created in workspaces it leaves.
263
+ */
264
+ export const cloudAccountDeletionSchema = v.object({
265
+ /** The account is the deployment's only administrator, which also stops the deletion. */
266
+ lastAdministrator: v.boolean(),
267
+ blockedBy: v.array(cloudAccountDeletionWorkspaceSchema),
268
+ deletes: v.array(cloudAccountDeletionWorkspaceSchema),
269
+ leaves: v.array(cloudAccountDeletionWorkspaceSchema),
270
+ documents: v.array(cloudAccountDeletionDocumentSchema)
271
+ })
272
+ export const cloudAccountDeletionResponseSchema = v.object({
273
+ deletion: cloudAccountDeletionSchema
274
+ })
275
+ /** The password, for a session that signed in too long ago to delete the account on its own. */
276
+ export const cloudAccountDeleteSchema = v.object({
277
+ password: v.optional(v.pipe(v.string(), v.minLength(1)))
278
+ })
279
+
180
280
  export function parseCloudProfileUpdate(input: unknown) {
181
281
  return v.parse(cloudProfileUpdateSchema, input)
182
282
  }
@@ -186,6 +286,9 @@ export function parseCloudPictureUpload(input: unknown) {
186
286
  export function parseCloudEmailChange(input: unknown) {
187
287
  return v.parse(cloudEmailChangeSchema, input)
188
288
  }
289
+ export function parseCloudAccountDelete(input: unknown) {
290
+ return v.parse(cloudAccountDeleteSchema, input)
291
+ }
189
292
  export function parseCloudSessionRevoke(input: unknown) {
190
293
  return v.parse(cloudSessionRevokeSchema, input)
191
294
  }
@@ -199,6 +302,9 @@ export type CloudAuthenticationMethods = v.InferOutput<
199
302
 
200
303
  export type CloudAccountStatus = v.InferOutput<typeof cloudAccountStatusResponseSchema>
201
304
  export type CloudProfile = v.InferOutput<typeof cloudProfileSchema>
305
+ export type CloudAccessToken = v.InferOutput<typeof cloudAccessTokenSchema>
306
+ export type CloudAccessTokenCreate = v.InferOutput<typeof cloudAccessTokenCreateSchema>
202
307
  export type CloudSignInMethod = v.InferOutput<typeof cloudSignInMethodSchema>
203
308
  export type CloudAccountSession = v.InferOutput<typeof cloudAccountSessionSchema>
204
309
  export type CloudSignIn = v.InferOutput<typeof cloudSignInSchema>
310
+ export type CloudAccountDeletion = v.InferOutput<typeof cloudAccountDeletionSchema>
@@ -7,6 +7,7 @@ import {
7
7
  cloudPersonSchema,
8
8
  cloudSignInSchema
9
9
  } from '../account'
10
+ import { documentReportReasonSchema } from '../reports'
10
11
  import { workspaceRoleSchema } from '../workspaces'
11
12
 
12
13
  const timestampSchema = v.pipe(v.string(), v.isoTimestamp())
@@ -39,7 +40,9 @@ export const adminErrorCodeSchema = v.picklist([
39
40
  'last_admin_required',
40
41
  'self_admin_action_forbidden',
41
42
  'email_regeneration_unavailable',
42
- 'mfa_required'
43
+ 'mfa_required',
44
+ 'document_not_restorable',
45
+ 'workspace_gone'
43
46
  ])
44
47
 
45
48
  export const adminErrorResponseSchema = v.object({
@@ -147,23 +150,79 @@ export const adminAuditEventSchema = v.object({
147
150
  id: v.string(),
148
151
  actor: auditPartySchema,
149
152
  action: v.string(),
150
- /** What the event is about: an account, an access request, or an email. */
153
+ /** What the event is about: an account, an access request, an email, or a document. */
151
154
  subject: v.object({ ...auditPartySchema.entries, type: v.string() }),
152
155
  metadata: v.unknown(),
153
156
  createdAt: timestampSchema
154
157
  })
155
158
  /** Which events a list of activity shows, by what they are about. */
156
- export const cloudAdminAuditFilterSchema = v.picklist(['all', 'accounts', 'requests', 'email'])
159
+ export const cloudAdminAuditFilterSchema = v.picklist([
160
+ 'all',
161
+ 'accounts',
162
+ 'requests',
163
+ 'email',
164
+ 'documents'
165
+ ])
157
166
  export const adminAuditResponseSchema = v.object({
158
167
  events: v.array(adminAuditEventSchema),
159
168
  ...listTotals(cloudAdminAuditFilterSchema.options)
160
169
  })
161
170
 
171
+ /** A document as the console shows it: where it lives, who made it, and whether it is taken down. */
172
+ export const cloudAdminDocumentSchema = v.object({
173
+ id: v.string(),
174
+ name: v.string(),
175
+ workspace: v.object({ id: v.string(), name: v.string() }),
176
+ /** Who made it, while the server knows them. */
177
+ owner: v.nullable(v.object({ id: v.string(), name: v.string(), email: v.string() })),
178
+ createdAt: timestampSchema,
179
+ updatedAt: timestampSchema,
180
+ disabledAt: nullableTimestampSchema,
181
+ disabledReason: v.nullable(v.string()),
182
+ /** Reports about it still waiting for a decision. */
183
+ openReports: countSchema,
184
+ /**
185
+ * When someone deleted it forever, and when cleanup destroys it; until then an administrator
186
+ * can still restore it. Servers from before Trash send neither.
187
+ */
188
+ purgedAt: v.optional(nullableTimestampSchema, null),
189
+ destroyedAt: v.optional(nullableTimestampSchema, null)
190
+ })
191
+ /** Which documents a list shows: live ones, or those deleted forever an administrator can restore. */
192
+ export const cloudAdminDocumentFilterSchema = v.picklist(['all', 'reported', 'disabled', 'purged'])
193
+ export const cloudAdminDocumentsResponseSchema = v.object({
194
+ documents: v.array(cloudAdminDocumentSchema),
195
+ ...listTotals(cloudAdminDocumentFilterSchema.options)
196
+ })
197
+
198
+ export const cloudAdminReportStatusSchema = v.picklist(['open', 'dismissed', 'actioned'])
199
+ export const cloudAdminReportSchema = v.object({
200
+ id: v.string(),
201
+ reason: documentReportReasonSchema,
202
+ description: v.string(),
203
+ status: cloudAdminReportStatusSchema,
204
+ /** The account that filed it, or null for a guest. */
205
+ reporter: v.nullable(v.object({ id: v.string(), name: v.nullable(v.string()) })),
206
+ replyEmail: v.nullable(v.string()),
207
+ createdAt: timestampSchema,
208
+ resolvedAt: nullableTimestampSchema,
209
+ document: cloudAdminDocumentSchema,
210
+ /** The link it was opened from, and whether that link still works. */
211
+ share: v.nullable(v.object({ id: v.string(), revoked: v.boolean() }))
212
+ })
213
+ /** Which reports a list shows, by where they stand. */
214
+ export const cloudAdminReportFilterSchema = v.picklist(['open', 'actioned', 'dismissed', 'all'])
215
+ export const cloudAdminReportsResponseSchema = v.object({
216
+ reports: v.array(cloudAdminReportSchema),
217
+ ...listTotals(cloudAdminReportFilterSchema.options)
218
+ })
219
+
162
220
  export const adminOperationsResponseSchema = v.object({
163
221
  deployment: v.picklist(['official', 'self-hosted']),
164
222
  enrollmentMode: v.picklist(['open', 'approval', 'closed']),
165
223
  emailTransport: v.picklist(['none', 'smtp', 'cloudflare']),
166
224
  pendingEnrollment: v.pipe(v.number(), v.integer(), v.minValue(0)),
225
+ openReports: countSchema,
167
226
  pendingEmail: v.pipe(v.number(), v.integer(), v.minValue(0)),
168
227
  failedEmail: v.pipe(v.number(), v.integer(), v.minValue(0)),
169
228
  accounts: countSchema,
@@ -185,3 +244,8 @@ export type CloudAdminUserDetail = v.InferOutput<typeof cloudAdminUserDetailSche
185
244
  export type TransactionalEmailAdmin = v.InferOutput<typeof transactionalEmailAdminSchema>
186
245
  export type AdminAuditEvent = v.InferOutput<typeof adminAuditEventSchema>
187
246
  export type AdminOperations = v.InferOutput<typeof adminOperationsResponseSchema>
247
+ export type CloudAdminDocument = v.InferOutput<typeof cloudAdminDocumentSchema>
248
+ export type CloudAdminDocumentFilter = v.InferOutput<typeof cloudAdminDocumentFilterSchema>
249
+ export type CloudAdminReport = v.InferOutput<typeof cloudAdminReportSchema>
250
+ export type CloudAdminReportFilter = v.InferOutput<typeof cloudAdminReportFilterSchema>
251
+ export type CloudAdminReportStatus = v.InferOutput<typeof cloudAdminReportStatusSchema>