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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (279) hide show
  1. package/LICENSE +202 -0
  2. package/LICENSE-MIT +21 -0
  3. package/NOTICE +7 -0
  4. package/README.md +37 -2
  5. package/dist/bin/ai-relay.d.mts +1 -0
  6. package/dist/bin/ai-relay.mjs +31 -0
  7. package/dist/bin/ai-relay.mjs.map +1 -0
  8. package/dist/bin/server.d.mts +1 -0
  9. package/dist/bin/server.mjs +29 -0
  10. package/dist/bin/server.mjs.map +1 -0
  11. package/dist/client.d.ts +1520 -0
  12. package/dist/client.d.ts.map +1 -0
  13. package/dist/client.js +1917 -0
  14. package/dist/client.js.map +1 -0
  15. package/dist/contract.d.ts +2 -0
  16. package/dist/contract.js +2 -0
  17. package/dist/contract2.js +1453 -0
  18. package/dist/contract2.js.map +1 -0
  19. package/dist/email.d.ts +169 -0
  20. package/dist/email.d.ts.map +1 -0
  21. package/dist/email.js +670 -0
  22. package/dist/email.js.map +1 -0
  23. package/dist/index.d.ts +1755 -0
  24. package/dist/index.d.ts.map +1 -0
  25. package/dist/listen.mjs +1881 -0
  26. package/dist/listen.mjs.map +1 -0
  27. package/dist/runtime-node.d.mts +10040 -0
  28. package/dist/runtime-node.d.mts.map +1 -0
  29. package/dist/runtime-node.mjs +32 -0
  30. package/dist/runtime-node.mjs.map +1 -0
  31. package/dist/server.d.ts +12792 -0
  32. package/dist/server.d.ts.map +1 -0
  33. package/dist/server.js +8475 -0
  34. package/dist/server.js.map +1 -0
  35. package/dist/server.mjs +8324 -0
  36. package/dist/server.mjs.map +1 -0
  37. package/dist/server2.mjs +505 -0
  38. package/dist/server2.mjs.map +1 -0
  39. package/package.json +124 -4
  40. package/src/admin/api/routes.ts +223 -0
  41. package/src/admin/api/security.ts +12 -0
  42. package/src/admin/audit/service.ts +138 -0
  43. package/src/admin/email/service.ts +140 -0
  44. package/src/admin/enrollment/email.ts +77 -0
  45. package/src/admin/enrollment/service.ts +308 -0
  46. package/src/admin/errors.ts +20 -0
  47. package/src/admin/index.ts +19 -0
  48. package/src/admin/list.ts +61 -0
  49. package/src/admin/operations/service.ts +70 -0
  50. package/src/admin/schema.ts +28 -0
  51. package/src/admin/users/service.ts +369 -0
  52. package/src/ai-relay/app.ts +251 -0
  53. package/src/ai-relay/config.ts +120 -0
  54. package/src/ai-relay/db/index.ts +10 -0
  55. package/src/ai-relay/db/migrate.ts +32 -0
  56. package/src/ai-relay/db/migrations/001_usage.ts +26 -0
  57. package/src/ai-relay/db/schema.ts +20 -0
  58. package/src/ai-relay/index.ts +18 -0
  59. package/src/ai-relay/metering.ts +68 -0
  60. package/src/ai-relay/usage.ts +115 -0
  61. package/src/client/ai.ts +96 -0
  62. package/src/client/api.ts +528 -0
  63. package/src/client/auth/client.ts +188 -0
  64. package/src/client/auth/failure.ts +54 -0
  65. package/src/client/auth/navigation.ts +45 -0
  66. package/src/client/device-authorization.ts +134 -0
  67. package/src/client/discovery.ts +105 -0
  68. package/src/client/images.ts +81 -0
  69. package/src/client/index.ts +53 -0
  70. package/src/client/portal/account.ts +183 -0
  71. package/src/client/portal/administration.ts +130 -0
  72. package/src/client/portal/client.ts +18 -0
  73. package/src/client/portal/request.ts +115 -0
  74. package/src/client/response.ts +51 -0
  75. package/src/client/workspaces.ts +142 -0
  76. package/src/contract/account.ts +204 -0
  77. package/src/contract/admin/index.ts +187 -0
  78. package/src/contract/ai.ts +150 -0
  79. package/src/contract/collaboration.ts +45 -0
  80. package/src/contract/discovery.ts +81 -0
  81. package/src/contract/documents.ts +265 -0
  82. package/src/contract/entitlements.ts +28 -0
  83. package/src/contract/index.ts +204 -0
  84. package/src/contract/links.ts +87 -0
  85. package/src/contract/portal.ts +11 -0
  86. package/src/contract/relay.ts +368 -0
  87. package/src/contract/sharing.ts +191 -0
  88. package/src/contract/versions.ts +87 -0
  89. package/src/contract/workspaces.ts +100 -0
  90. package/src/email/index.ts +14 -0
  91. package/src/email/render.ts +276 -0
  92. package/src/email/schema.ts +144 -0
  93. package/src/email/templates/brand.ts +105 -0
  94. package/src/email/templates/document-invitation.ts +35 -0
  95. package/src/email/templates/enrollment.ts +27 -0
  96. package/src/email/templates/layout.ts +18 -0
  97. package/src/runtime/cloudflare/email.ts +70 -0
  98. package/src/runtime/cloudflare/environment.ts +57 -0
  99. package/src/runtime/cloudflare/index.ts +3 -0
  100. package/src/runtime/cloudflare/relay.ts +136 -0
  101. package/src/runtime/cloudflare/site.ts +13 -0
  102. package/src/runtime/cloudflare/tsconfig.json +21 -0
  103. package/src/runtime/cloudflare/worker.ts +160 -0
  104. package/src/runtime/node/admin.ts +59 -0
  105. package/src/runtime/node/ai-relay/main.ts +35 -0
  106. package/src/runtime/node/ai-relay/server.ts +63 -0
  107. package/src/runtime/node/application.ts +50 -0
  108. package/src/runtime/node/bootstrap.ts +22 -0
  109. package/src/runtime/node/cleanup.ts +24 -0
  110. package/src/runtime/node/command.ts +17 -0
  111. package/src/runtime/node/config.ts +16 -0
  112. package/src/runtime/node/email/runtime.ts +43 -0
  113. package/src/runtime/node/email/transport.ts +112 -0
  114. package/src/runtime/node/entitlements/main.ts +41 -0
  115. package/src/runtime/node/entitlements/refusal.ts +15 -0
  116. package/src/runtime/node/index.ts +25 -0
  117. package/src/runtime/node/listen.ts +35 -0
  118. package/src/runtime/node/main.ts +29 -0
  119. package/src/runtime/node/migrate.ts +13 -0
  120. package/src/runtime/node/quota-reconcile.ts +9 -0
  121. package/src/runtime/node/relay.ts +54 -0
  122. package/src/runtime/node/server.ts +121 -0
  123. package/src/runtime/node/site.ts +64 -0
  124. package/src/runtime/postgres/database.ts +19 -0
  125. package/src/runtime/s3/objects.ts +244 -0
  126. package/src/runtime/site/server.ts +82 -0
  127. package/src/server/account/actions.ts +66 -0
  128. package/src/server/account/routes.ts +300 -0
  129. package/src/server/ai/errors.ts +7 -0
  130. package/src/server/ai/index.ts +4 -0
  131. package/src/server/ai/keys.ts +43 -0
  132. package/src/server/ai/routes.ts +43 -0
  133. package/src/server/ai/service.ts +70 -0
  134. package/src/server/api/index.ts +8 -0
  135. package/src/server/api/router.ts +117 -0
  136. package/src/server/api/types.ts +7 -0
  137. package/src/server/app.ts +375 -0
  138. package/src/server/auth/account.ts +73 -0
  139. package/src/server/auth/activity.ts +213 -0
  140. package/src/server/auth/adapter.ts +79 -0
  141. package/src/server/auth/email.ts +125 -0
  142. package/src/server/auth/endpoints.ts +57 -0
  143. package/src/server/auth/factory.ts +583 -0
  144. package/src/server/auth/index.ts +17 -0
  145. package/src/server/auth/mfa-assurance.ts +55 -0
  146. package/src/server/auth/runtime.ts +26 -0
  147. package/src/server/auth/session.ts +19 -0
  148. package/src/server/auth/social-providers.ts +55 -0
  149. package/src/server/auth/user-agent.ts +16 -0
  150. package/src/server/auth/workspace-access.ts +23 -0
  151. package/src/server/cleanup/configured.ts +38 -0
  152. package/src/server/cleanup/documents.ts +231 -0
  153. package/src/server/cleanup/index.ts +29 -0
  154. package/src/server/cleanup/objects.ts +27 -0
  155. package/src/server/cleanup/revisions.ts +232 -0
  156. package/src/server/cleanup/uploads.ts +129 -0
  157. package/src/server/cleanup/worker.ts +79 -0
  158. package/src/server/collaboration/index.ts +28 -0
  159. package/src/server/collaboration/relay/authorize.ts +53 -0
  160. package/src/server/collaboration/relay/awareness.ts +104 -0
  161. package/src/server/collaboration/relay/documents.ts +39 -0
  162. package/src/server/collaboration/relay/hub.ts +524 -0
  163. package/src/server/collaboration/relay/index.ts +15 -0
  164. package/src/server/collaboration/relay/persistence.ts +48 -0
  165. package/src/server/collaboration/routes.ts +77 -0
  166. package/src/server/collaboration/service.ts +188 -0
  167. package/src/server/config/deployment.ts +178 -0
  168. package/src/server/config/index.ts +20 -0
  169. package/src/server/config/limits.ts +8 -0
  170. package/src/server/config/public.ts +66 -0
  171. package/src/server/config/schema.ts +512 -0
  172. package/src/server/db/database.ts +15 -0
  173. package/src/server/db/expressions.ts +13 -0
  174. package/src/server/db/index.ts +21 -0
  175. package/src/server/db/migrate.ts +177 -0
  176. package/src/server/db/migrations/001_foundation.ts +164 -0
  177. package/src/server/db/migrations/002_upload_cleanup_claims.ts +34 -0
  178. package/src/server/db/migrations/003_document_cleanup_claims.ts +23 -0
  179. package/src/server/db/migrations/004_document_sharing.ts +82 -0
  180. package/src/server/db/migrations/005_document_collaboration_epoch.ts +13 -0
  181. package/src/server/db/migrations/006_invitation_continuation.ts +27 -0
  182. package/src/server/db/migrations/007_collaboration_state.ts +25 -0
  183. package/src/server/db/migrations/008_storage_reservations.ts +37 -0
  184. package/src/server/db/migrations/009_workspace_entitlements.ts +22 -0
  185. package/src/server/db/migrations/010_upload_finalization.ts +22 -0
  186. package/src/server/db/migrations/011_upload_finalization_lease.ts +12 -0
  187. package/src/server/db/migrations/012_transactional_email.ts +48 -0
  188. package/src/server/db/migrations/013_admin_enrollment.ts +54 -0
  189. package/src/server/db/migrations/014_enrollment_email_kinds.ts +30 -0
  190. package/src/server/db/migrations/015_cloud_rate_limit.ts +22 -0
  191. package/src/server/db/migrations/016_auth_schema.ts +16 -0
  192. package/src/server/db/migrations/017_authentication_email_kinds.ts +32 -0
  193. package/src/server/db/migrations/018_authentication_mfa.ts +78 -0
  194. package/src/server/db/migrations/019_better_auth_account_issuer.ts +42 -0
  195. package/src/server/db/migrations/020_workspace_invitations.ts +57 -0
  196. package/src/server/db/migrations/021_document_versions.ts +66 -0
  197. package/src/server/db/migrations/022_entitlement_external_version.ts +17 -0
  198. package/src/server/db/migrations/023_document_images.ts +61 -0
  199. package/src/server/db/migrations/024_account_activity.ts +66 -0
  200. package/src/server/db/migrations/025_table_names.ts +58 -0
  201. package/src/server/db/migrations/026_user_picture.ts +30 -0
  202. package/src/server/db/migrations/027_document_kind.ts +19 -0
  203. package/src/server/db/migrations/helpers.ts +78 -0
  204. package/src/server/db/tables.ts +394 -0
  205. package/src/server/documents/access.ts +103 -0
  206. package/src/server/documents/errors.ts +16 -0
  207. package/src/server/documents/images.ts +407 -0
  208. package/src/server/documents/index.ts +14 -0
  209. package/src/server/documents/limits.ts +57 -0
  210. package/src/server/documents/repository.ts +141 -0
  211. package/src/server/documents/routes.ts +239 -0
  212. package/src/server/documents/service.ts +597 -0
  213. package/src/server/documents/summary.ts +37 -0
  214. package/src/server/documents/types.ts +14 -0
  215. package/src/server/documents/versions/checkpoint.ts +98 -0
  216. package/src/server/documents/versions/history.ts +25 -0
  217. package/src/server/documents/versions/index.ts +4 -0
  218. package/src/server/documents/versions/routes.ts +112 -0
  219. package/src/server/documents/versions/service.ts +397 -0
  220. package/src/server/email/crypto.ts +57 -0
  221. package/src/server/email/index.ts +18 -0
  222. package/src/server/email/invitations.ts +30 -0
  223. package/src/server/email/service.ts +245 -0
  224. package/src/server/email/types.ts +56 -0
  225. package/src/server/email/worker.ts +33 -0
  226. package/src/server/index.ts +279 -0
  227. package/src/server/internal/index.ts +8 -0
  228. package/src/server/internal/routes.ts +41 -0
  229. package/src/server/internal/schema.ts +10 -0
  230. package/src/server/internal/service.ts +44 -0
  231. package/src/server/invitations/index.ts +6 -0
  232. package/src/server/invitations/types.ts +30 -0
  233. package/src/server/objects/index.ts +16 -0
  234. package/src/server/objects/types.ts +81 -0
  235. package/src/server/pictures/index.ts +9 -0
  236. package/src/server/pictures/provider.ts +61 -0
  237. package/src/server/pictures/routes.ts +21 -0
  238. package/src/server/pictures/service.ts +235 -0
  239. package/src/server/policy/configured.ts +23 -0
  240. package/src/server/policy/database.ts +108 -0
  241. package/src/server/policy/entitlements.ts +29 -0
  242. package/src/server/policy/index.ts +17 -0
  243. package/src/server/policy/keys.ts +23 -0
  244. package/src/server/policy/policy.ts +117 -0
  245. package/src/server/policy/provider.ts +67 -0
  246. package/src/server/policy/schema.ts +69 -0
  247. package/src/server/policy/service.ts +85 -0
  248. package/src/server/policy/static.ts +62 -0
  249. package/src/server/quota/index.ts +7 -0
  250. package/src/server/quota/reconcile.ts +61 -0
  251. package/src/server/quota/storage.ts +165 -0
  252. package/src/server/rate-limit/cleanup.ts +16 -0
  253. package/src/server/rate-limit/index.ts +12 -0
  254. package/src/server/rate-limit/keys.ts +38 -0
  255. package/src/server/rate-limit/middleware.ts +137 -0
  256. package/src/server/rate-limit/postgres.ts +79 -0
  257. package/src/server/sharing/access.ts +29 -0
  258. package/src/server/sharing/actor.ts +12 -0
  259. package/src/server/sharing/capabilities/service.ts +262 -0
  260. package/src/server/sharing/continuation.ts +85 -0
  261. package/src/server/sharing/contracts.ts +80 -0
  262. package/src/server/sharing/crypto.ts +48 -0
  263. package/src/server/sharing/document-routes.ts +41 -0
  264. package/src/server/sharing/errors.ts +12 -0
  265. package/src/server/sharing/grants/service.ts +79 -0
  266. package/src/server/sharing/http.ts +41 -0
  267. package/src/server/sharing/index.ts +39 -0
  268. package/src/server/sharing/invitations/service.ts +315 -0
  269. package/src/server/sharing/policy.ts +44 -0
  270. package/src/server/sharing/routes.ts +251 -0
  271. package/src/server/sharing/service.ts +117 -0
  272. package/src/server/validation.ts +24 -0
  273. package/src/server/worker/interval.ts +23 -0
  274. package/src/server/worker/periodic.ts +42 -0
  275. package/src/server/workspaces/index.ts +16 -0
  276. package/src/server/workspaces/members.ts +502 -0
  277. package/src/server/workspaces/repository.ts +91 -0
  278. package/src/server/workspaces/routes.ts +198 -0
  279. package/src/server/workspaces/service.ts +84 -0
@@ -0,0 +1,528 @@
1
+ import type { CloudFetch } from '#cloud/client/discovery'
2
+ import {
3
+ acceptedInvitationSchema,
4
+ aiTokenSchema,
5
+ cloudSessionSchema,
6
+ cloudUserProfileSchema,
7
+ collaborationTicketSchema,
8
+ createInvitationContinuationSchema,
9
+ documentAccessSchema,
10
+ documentDownloadSchema,
11
+ objectUploadSchema,
12
+ documentGrantSchema,
13
+ documentInvitationSchema,
14
+ documentShareSchema,
15
+ documentSummarySchema,
16
+ documentVersionDownloadSchema,
17
+ documentVersionResponseSchema,
18
+ documentVersionsSchema,
19
+ restoredDocumentSchema,
20
+ sharedDocumentSchema,
21
+ invitationContinuationSchema,
22
+ invitationPreviewSchema,
23
+ resolvedDocumentShareSchema,
24
+ type AcceptDocumentInvitationInput,
25
+ type AIToken,
26
+ type CloudSession,
27
+ type CloudUserProfile,
28
+ type CollaborationTicket,
29
+ type CreateInvitationContinuationInput,
30
+ type InvitationContinuation,
31
+ type CommitUploadRequest,
32
+ type CreateDocumentRequest,
33
+ type CreateDocumentInvitationInput,
34
+ type CreateDocumentShareInput,
35
+ type CreateUploadInput,
36
+ type DocumentAccess,
37
+ type DocumentDownload,
38
+ type DocumentGrant,
39
+ type DocumentInvitation,
40
+ type DocumentShare,
41
+ type DocumentSummary,
42
+ type DocumentVersion,
43
+ type DocumentVersionDownload,
44
+ type DocumentVersions,
45
+ type DuplicateDocumentVersionInput,
46
+ type SaveDocumentVersionInput,
47
+ type UpdateDocumentVersionInput,
48
+ type SharedDocument,
49
+ type InvitationPreview,
50
+ type LookupCloudUserInput,
51
+ type PutDocumentGrantInput,
52
+ type ResolveDocumentShareInput,
53
+ type UpdateDocumentShareInput,
54
+ type AcceptedInvitation
55
+ } from '#cloud/contract'
56
+ import type { CloudAPI, PublicCloudAPI } from '#cloud/server/api'
57
+ import { pickBy } from 'es-toolkit/object'
58
+ import { hc } from 'hono/client'
59
+ import * as v from 'valibot'
60
+
61
+ import { createImageRequests } from './images'
62
+ import { CloudAPIError, parseResponse, responseBody, type CloudClientDiagnostic } from './response'
63
+ import { createWorkspaceRequests } from './workspaces'
64
+
65
+ export { CloudAPIError, type CloudClientDiagnostic } from './response'
66
+
67
+ const documentsResponseSchema = v.object({ documents: v.array(documentSummarySchema) })
68
+ const sharedDocumentsResponseSchema = v.object({ documents: v.array(sharedDocumentSchema) })
69
+ const documentResponseSchema = v.object({ document: documentSummarySchema })
70
+ const downloadResponseSchema = v.object({ document: documentDownloadSchema })
71
+ const accessResponseSchema = v.object({ access: documentAccessSchema })
72
+ const sharesResponseSchema = v.object({ shares: v.array(documentShareSchema) })
73
+ const shareResponseSchema = v.object({ share: documentShareSchema })
74
+ const shareCapabilityResponseSchema = v.object({
75
+ share: documentShareSchema,
76
+ secret: v.string(),
77
+ path: v.string()
78
+ })
79
+ const grantsResponseSchema = v.object({ grants: v.array(documentGrantSchema) })
80
+ const grantResponseSchema = v.object({ grant: documentGrantSchema })
81
+ const acceptedResponseSchema = v.object({ accepted: acceptedInvitationSchema })
82
+ const invitationPreviewResponseSchema = v.object({ invitation: invitationPreviewSchema })
83
+ const invitationsResponseSchema = v.object({ invitations: v.array(documentInvitationSchema) })
84
+ const invitationCapabilityResponseSchema = v.object({
85
+ invitation: documentInvitationSchema,
86
+ token: v.string()
87
+ })
88
+ const collaborationTicketResponseSchema = v.object({ ticket: collaborationTicketSchema })
89
+ const resolvedShareResponseSchema = v.object({ resolution: resolvedDocumentShareSchema })
90
+ const sharedDocumentResponseSchema = v.object({
91
+ resolution: resolvedDocumentShareSchema,
92
+ document: documentDownloadSchema
93
+ })
94
+ const userLookupResponseSchema = v.object({ user: v.nullable(cloudUserProfileSchema) })
95
+ const uploadResponseSchema = v.object({
96
+ id: v.pipe(v.string(), v.uuid()),
97
+ upload: objectUploadSchema
98
+ })
99
+
100
+ export type CloudRequestOptions = {
101
+ fetch?: CloudFetch
102
+ signal?: AbortSignal
103
+ accessToken?: string
104
+ onDiagnostic?: CloudClientDiagnostic
105
+ }
106
+
107
+ export type CloudUpload = v.InferOutput<typeof uploadResponseSchema>
108
+
109
+ function apiURL(baseURL: string): string {
110
+ const url = new URL(baseURL)
111
+ if (url.protocol !== 'https:' && url.protocol !== 'http:') {
112
+ throw new CloudAPIError('OpenPencil Cloud API URL must use HTTP or HTTPS', 0)
113
+ }
114
+ url.pathname = url.pathname.replace(/\/$/, '')
115
+ url.search = ''
116
+ url.hash = ''
117
+ return url.href
118
+ }
119
+
120
+ export function createCloudAPIClient(baseURL: string, options: CloudRequestOptions = {}) {
121
+ const headers = {
122
+ 'Content-Type': 'application/json',
123
+ ...(options.accessToken ? { Authorization: `Bearer ${options.accessToken}` } : {})
124
+ }
125
+ const client = hc<CloudAPI>(apiURL(baseURL), {
126
+ fetch: options.fetch,
127
+ init: { credentials: 'include', signal: options.signal, headers }
128
+ })
129
+ const publicClient = hc<PublicCloudAPI>(apiURL(baseURL), {
130
+ fetch: options.fetch,
131
+ init: { credentials: 'include', signal: options.signal, headers }
132
+ })
133
+
134
+ return {
135
+ async getSession(): Promise<CloudSession | null> {
136
+ const response = await client.session.$get()
137
+ if (response.status === 401) return null
138
+ return v.parse(cloudSessionSchema, await responseBody(response, options.onDiagnostic))
139
+ },
140
+ /** A short-lived token for the deployment's AI service, on the workspace's behalf. */
141
+ async requestAIToken(workspaceId: string): Promise<AIToken> {
142
+ return parseResponse(
143
+ client.ai.token.$post({ json: { workspaceId } }),
144
+ aiTokenSchema,
145
+ options.onDiagnostic
146
+ )
147
+ },
148
+ async lookupUser(
149
+ documentId: string,
150
+ input: LookupCloudUserInput
151
+ ): Promise<CloudUserProfile | null> {
152
+ const response = await parseResponse(
153
+ client.documents[':documentId'].users.lookup.$post({
154
+ param: { documentId },
155
+ json: input
156
+ }),
157
+ userLookupResponseSchema,
158
+ options.onDiagnostic
159
+ )
160
+ return response.user
161
+ },
162
+ async getUserProfile(documentId: string, userId: string): Promise<CloudUserProfile | null> {
163
+ const response = await parseResponse(
164
+ client.documents[':documentId'].users[':userId'].$get({
165
+ param: { documentId, userId }
166
+ }),
167
+ userLookupResponseSchema,
168
+ options.onDiagnostic
169
+ )
170
+ return response.user
171
+ },
172
+ ...createWorkspaceRequests(client, options.onDiagnostic),
173
+ ...createImageRequests(client, publicClient, options.onDiagnostic),
174
+ /** Documents shared with the person directly, outside their workspaces. */
175
+ async listSharedDocuments(): Promise<SharedDocument[]> {
176
+ const response = await parseResponse(
177
+ client['shared-documents'].$get(),
178
+ sharedDocumentsResponseSchema,
179
+ options.onDiagnostic
180
+ )
181
+ return response.documents
182
+ },
183
+ async listDocuments(workspaceId: string): Promise<DocumentSummary[]> {
184
+ const response = await parseResponse(
185
+ client.workspaces[':workspaceId'].documents.$get({
186
+ param: { workspaceId }
187
+ }),
188
+ documentsResponseSchema,
189
+ options.onDiagnostic
190
+ )
191
+ return response.documents
192
+ },
193
+ async createDocument(
194
+ workspaceId: string,
195
+ input: CreateDocumentRequest
196
+ ): Promise<DocumentSummary> {
197
+ const response = await parseResponse(
198
+ client.workspaces[':workspaceId'].documents.$post({
199
+ param: { workspaceId },
200
+ json: { ...input, kind: input.kind ?? 'design' }
201
+ }),
202
+ documentResponseSchema,
203
+ options.onDiagnostic
204
+ )
205
+ return response.document
206
+ },
207
+ async deleteDocument(documentId: string): Promise<void> {
208
+ await responseBody(
209
+ await client.documents[':documentId'].$delete({ param: { documentId } }),
210
+ options.onDiagnostic
211
+ )
212
+ },
213
+ async getDocument(documentId: string): Promise<DocumentDownload> {
214
+ const response = await parseResponse(
215
+ client.documents[':documentId'].$get({ param: { documentId } }),
216
+ downloadResponseSchema,
217
+ options.onDiagnostic
218
+ )
219
+ return response.document
220
+ },
221
+ async getDocumentAccess(documentId: string): Promise<DocumentAccess> {
222
+ const response = await parseResponse(
223
+ client.documents[':documentId'].access.$get({ param: { documentId } }),
224
+ accessResponseSchema,
225
+ options.onDiagnostic
226
+ )
227
+ return response.access
228
+ },
229
+ async listDocumentShares(documentId: string): Promise<DocumentShare[]> {
230
+ const response = await parseResponse(
231
+ client.documents[':documentId'].shares.$get({ param: { documentId } }),
232
+ sharesResponseSchema,
233
+ options.onDiagnostic
234
+ )
235
+ return response.shares
236
+ },
237
+ async createDocumentShare(documentId: string, input: CreateDocumentShareInput) {
238
+ return parseResponse(
239
+ client.documents[':documentId'].shares.$post({
240
+ param: { documentId },
241
+ json: input
242
+ }),
243
+ shareCapabilityResponseSchema,
244
+ options.onDiagnostic
245
+ )
246
+ },
247
+ async updateDocumentShare(
248
+ documentId: string,
249
+ shareId: string,
250
+ input: UpdateDocumentShareInput
251
+ ): Promise<DocumentShare> {
252
+ const response = await parseResponse(
253
+ client.documents[':documentId'].shares[':shareId'].$patch({
254
+ param: { documentId, shareId },
255
+ json: input
256
+ }),
257
+ shareResponseSchema,
258
+ options.onDiagnostic
259
+ )
260
+ return response.share
261
+ },
262
+ async rotateDocumentShare(documentId: string, shareId: string) {
263
+ return parseResponse(
264
+ client.documents[':documentId'].shares[':shareId'].rotate.$post({
265
+ param: { documentId, shareId }
266
+ }),
267
+ shareCapabilityResponseSchema,
268
+ options.onDiagnostic
269
+ )
270
+ },
271
+ async revokeDocumentShare(documentId: string, shareId: string): Promise<void> {
272
+ await responseBody(
273
+ await client.documents[':documentId'].shares[':shareId'].$delete({
274
+ param: { documentId, shareId }
275
+ }),
276
+ options.onDiagnostic
277
+ )
278
+ },
279
+ async listDocumentGrants(documentId: string): Promise<DocumentGrant[]> {
280
+ const response = await parseResponse(
281
+ client.documents[':documentId'].grants.$get({ param: { documentId } }),
282
+ grantsResponseSchema,
283
+ options.onDiagnostic
284
+ )
285
+ return response.grants
286
+ },
287
+ async putDocumentGrant(
288
+ documentId: string,
289
+ userId: string,
290
+ input: PutDocumentGrantInput
291
+ ): Promise<DocumentGrant> {
292
+ const response = await parseResponse(
293
+ client.documents[':documentId'].grants[':userId'].$put({
294
+ param: { documentId, userId },
295
+ json: input
296
+ }),
297
+ grantResponseSchema,
298
+ options.onDiagnostic
299
+ )
300
+ return response.grant
301
+ },
302
+ async revokeDocumentGrant(documentId: string, userId: string): Promise<void> {
303
+ await responseBody(
304
+ await client.documents[':documentId'].grants[':userId'].$delete({
305
+ param: { documentId, userId }
306
+ }),
307
+ options.onDiagnostic
308
+ )
309
+ },
310
+ async listDocumentInvitations(documentId: string): Promise<DocumentInvitation[]> {
311
+ const response = await parseResponse(
312
+ client.documents[':documentId'].invitations.$get({ param: { documentId } }),
313
+ invitationsResponseSchema,
314
+ options.onDiagnostic
315
+ )
316
+ return response.invitations
317
+ },
318
+ async createDocumentInvitation(documentId: string, input: CreateDocumentInvitationInput) {
319
+ return parseResponse(
320
+ client.documents[':documentId'].invitations.$post({
321
+ param: { documentId },
322
+ json: input
323
+ }),
324
+ invitationCapabilityResponseSchema,
325
+ options.onDiagnostic
326
+ )
327
+ },
328
+ async createInvitationContinuation(
329
+ input: CreateInvitationContinuationInput
330
+ ): Promise<InvitationContinuation> {
331
+ return parseResponse(
332
+ publicClient.invitations.continuations.$post({ json: input }),
333
+ invitationContinuationSchema,
334
+ options.onDiagnostic
335
+ )
336
+ },
337
+ async consumeInvitationContinuation(id: string): Promise<CreateInvitationContinuationInput> {
338
+ return parseResponse(
339
+ publicClient.invitations.continuations[':continuationId'].consume.$post({
340
+ param: { continuationId: id }
341
+ }),
342
+ createInvitationContinuationSchema,
343
+ options.onDiagnostic
344
+ )
345
+ },
346
+ async previewInvitation(
347
+ invitationId: string,
348
+ input: AcceptDocumentInvitationInput
349
+ ): Promise<InvitationPreview> {
350
+ const response = await parseResponse(
351
+ publicClient.invitations[':invitationId'].preview.$post({
352
+ param: { invitationId },
353
+ json: input
354
+ }),
355
+ invitationPreviewResponseSchema,
356
+ options.onDiagnostic
357
+ )
358
+ return response.invitation
359
+ },
360
+ /** Accepts a document or workspace invitation, and says which it was. */
361
+ async acceptInvitation(
362
+ invitationId: string,
363
+ input: AcceptDocumentInvitationInput
364
+ ): Promise<AcceptedInvitation> {
365
+ const response = await parseResponse(
366
+ client.invitations[':invitationId'].accept.$post({
367
+ param: { invitationId },
368
+ json: input
369
+ }),
370
+ acceptedResponseSchema,
371
+ options.onDiagnostic
372
+ )
373
+ return response.accepted
374
+ },
375
+ async revokeDocumentInvitation(documentId: string, invitationId: string): Promise<void> {
376
+ await responseBody(
377
+ await client.documents[':documentId'].invitations[':invitationId'].$delete({
378
+ param: { documentId, invitationId }
379
+ }),
380
+ options.onDiagnostic
381
+ )
382
+ },
383
+ async resolveDocumentShare(shareId: string, input: ResolveDocumentShareInput) {
384
+ const response = await parseResponse(
385
+ publicClient.shares[':shareId'].resolve.$post({
386
+ param: { shareId },
387
+ json: input
388
+ }),
389
+ resolvedShareResponseSchema,
390
+ options.onDiagnostic
391
+ )
392
+ return response.resolution
393
+ },
394
+ async getSharedDocument(shareId: string, input: ResolveDocumentShareInput) {
395
+ return parseResponse(
396
+ publicClient.shares[':shareId'].document.$post({
397
+ param: { shareId },
398
+ json: input
399
+ }),
400
+ sharedDocumentResponseSchema,
401
+ options.onDiagnostic
402
+ )
403
+ },
404
+ async getSharedCollaborationTicket(
405
+ shareId: string,
406
+ input: ResolveDocumentShareInput
407
+ ): Promise<CollaborationTicket> {
408
+ const response = await parseResponse(
409
+ publicClient.shares[':shareId']['collaboration-ticket'].$post({
410
+ param: { shareId },
411
+ json: input
412
+ }),
413
+ collaborationTicketResponseSchema,
414
+ options.onDiagnostic
415
+ )
416
+ return response.ticket
417
+ },
418
+ async getCollaborationTicket(documentId: string): Promise<CollaborationTicket> {
419
+ const response = await parseResponse(
420
+ client.documents[':documentId']['collaboration-ticket'].$post({
421
+ param: { documentId }
422
+ }),
423
+ collaborationTicketResponseSchema,
424
+ options.onDiagnostic
425
+ )
426
+ return response.ticket
427
+ },
428
+ async createUpload(documentId: string, input: CreateUploadInput): Promise<CloudUpload> {
429
+ return parseResponse(
430
+ client.documents[':documentId'].uploads.$post({
431
+ param: { documentId },
432
+ json: input
433
+ }),
434
+ uploadResponseSchema,
435
+ options.onDiagnostic
436
+ )
437
+ },
438
+ async commitUpload(uploadId: string, input: CommitUploadRequest): Promise<DocumentSummary> {
439
+ const response = await parseResponse(
440
+ client.uploads[':uploadId'].commit.$post({
441
+ param: { uploadId },
442
+ json: { ...input, images: input.images ?? [] }
443
+ }),
444
+ documentResponseSchema,
445
+ options.onDiagnostic
446
+ )
447
+ return response.document
448
+ },
449
+ /** A page of the document's version history, newest first. */
450
+ async listDocumentVersions(
451
+ documentId: string,
452
+ page: { before?: string; limit?: number } = {}
453
+ ): Promise<DocumentVersions> {
454
+ return parseResponse(
455
+ client.documents[':documentId'].versions.$get({
456
+ param: { documentId },
457
+ query: pickBy(page, (value) => value !== undefined)
458
+ }),
459
+ documentVersionsSchema,
460
+ options.onDiagnostic
461
+ )
462
+ },
463
+ async saveDocumentVersion(
464
+ documentId: string,
465
+ input: SaveDocumentVersionInput
466
+ ): Promise<DocumentVersion> {
467
+ const response = await parseResponse(
468
+ client.documents[':documentId'].versions.$post({ param: { documentId }, json: input }),
469
+ documentVersionResponseSchema,
470
+ options.onDiagnostic
471
+ )
472
+ return response.version
473
+ },
474
+ async updateDocumentVersion(
475
+ documentId: string,
476
+ versionId: string,
477
+ input: UpdateDocumentVersionInput
478
+ ): Promise<DocumentVersion> {
479
+ const response = await parseResponse(
480
+ client.documents[':documentId'].versions[':versionId'].$patch({
481
+ param: { documentId, versionId },
482
+ json: input
483
+ }),
484
+ documentVersionResponseSchema,
485
+ options.onDiagnostic
486
+ )
487
+ return response.version
488
+ },
489
+ async getDocumentVersion(
490
+ documentId: string,
491
+ versionId: string
492
+ ): Promise<DocumentVersionDownload> {
493
+ return parseResponse(
494
+ client.documents[':documentId'].versions[':versionId'].$get({
495
+ param: { documentId, versionId }
496
+ }),
497
+ documentVersionDownloadSchema,
498
+ options.onDiagnostic
499
+ )
500
+ },
501
+ async restoreDocumentVersion(documentId: string, versionId: string) {
502
+ return parseResponse(
503
+ client.documents[':documentId'].versions[':versionId'].restore.$post({
504
+ param: { documentId, versionId }
505
+ }),
506
+ restoredDocumentSchema,
507
+ options.onDiagnostic
508
+ )
509
+ },
510
+ async duplicateDocumentVersion(
511
+ documentId: string,
512
+ versionId: string,
513
+ input: DuplicateDocumentVersionInput
514
+ ): Promise<DocumentSummary> {
515
+ const response = await parseResponse(
516
+ client.documents[':documentId'].versions[':versionId'].duplicate.$post({
517
+ param: { documentId, versionId },
518
+ json: input
519
+ }),
520
+ documentResponseSchema,
521
+ options.onDiagnostic
522
+ )
523
+ return response.document
524
+ }
525
+ }
526
+ }
527
+
528
+ export type CloudAPIClient = ReturnType<typeof createCloudAPIClient>