@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,188 @@
1
+ import type { CloudDiscovery } from '#cloud/contract'
2
+ import { passkeyClient } from '@better-auth/passkey/client'
3
+ import { createAuthClient } from 'better-auth/client'
4
+ import { deviceAuthorizationClient, twoFactorClient } from 'better-auth/client/plugins'
5
+ import { withoutFragment } from 'ufo'
6
+
7
+ import type { CloudFetch } from '../discovery'
8
+ import { cloudAuthFailure, type CloudAuthResult } from './failure'
9
+
10
+ export type CloudSocialProvider = CloudDiscovery['authentication']['socialProviders'][number]
11
+
12
+ function returnURL(): string {
13
+ return withoutFragment(globalThis.location.href)
14
+ }
15
+
16
+ type DeviceActionResult = Promise<{
17
+ data?: { success: boolean }
18
+ error?: { error_description: string }
19
+ }>
20
+
21
+ export type CloudAuthClient = Pick<
22
+ ReturnType<typeof createAuthClient>,
23
+ | 'getSession'
24
+ | 'signIn'
25
+ | 'signOut'
26
+ | 'signUp'
27
+ | 'sendVerificationEmail'
28
+ | 'requestPasswordReset'
29
+ | 'resetPassword'
30
+ > & {
31
+ signIn: ReturnType<typeof createAuthClient>['signIn'] & {
32
+ passkey(): Promise<{
33
+ data: unknown
34
+ error: { message?: string; code?: string; status: number } | null
35
+ }>
36
+ }
37
+ twoFactor: {
38
+ verifyTotp(input: { code: string; trustDevice?: boolean }): Promise<{
39
+ data: unknown
40
+ error: { message?: string; code?: string; status: number } | null
41
+ }>
42
+ verifyBackupCode(input: { code: string; trustDevice?: boolean }): Promise<{
43
+ data: unknown
44
+ error: { message?: string; code?: string; status: number } | null
45
+ }>
46
+ }
47
+ passkey: {
48
+ addPasskey(input?: { name?: string }): Promise<{
49
+ data: unknown
50
+ error: { message?: string; code?: string; status: number } | null
51
+ }>
52
+ }
53
+ device: {
54
+ (input: { query: { user_code: string } }): Promise<{
55
+ data?: { user_code: string; status: string }
56
+ error?: { error_description: string }
57
+ }>
58
+ approve(input: { userCode: string }): DeviceActionResult
59
+ deny(input: { userCode: string }): DeviceActionResult
60
+ }
61
+ }
62
+
63
+ export type CloudAuthClientOptions = {
64
+ accessToken?: string
65
+ captchaResponse?: string
66
+ fetch?: CloudFetch
67
+ }
68
+
69
+ function authHeaders(options: CloudAuthClientOptions): HeadersInit | undefined {
70
+ const headers: Record<string, string> = {}
71
+ if (options.accessToken) headers.Authorization = `Bearer ${options.accessToken}`
72
+ if (options.captchaResponse) headers['x-captcha-response'] = options.captchaResponse
73
+ return Object.keys(headers).length > 0 ? headers : undefined
74
+ }
75
+
76
+ export function createCloudAuthClient(
77
+ discovery: CloudDiscovery,
78
+ options: CloudAuthClientOptions = {}
79
+ ): CloudAuthClient {
80
+ return createAuthClient({
81
+ baseURL: discovery.authURL,
82
+ plugins: [
83
+ deviceAuthorizationClient(),
84
+ twoFactorClient({ twoFactorPage: '/auth/two-factor' }),
85
+ passkeyClient()
86
+ ],
87
+ fetchOptions: {
88
+ credentials: 'include',
89
+ customFetchImpl: options.fetch,
90
+ headers: authHeaders(options)
91
+ }
92
+ }) as CloudAuthClient
93
+ }
94
+
95
+ export type CloudSignInOptions = {
96
+ callbackURL?: string
97
+ fetch?: CloudFetch
98
+ navigate?: (url: string) => void
99
+ }
100
+
101
+ export async function signInToCloud(
102
+ discovery: CloudDiscovery,
103
+ provider: CloudSocialProvider,
104
+ options: CloudSignInOptions = {}
105
+ ): Promise<void> {
106
+ const callbackURL = options.callbackURL ?? returnURL()
107
+ if (!discovery.authentication.socialProviders.includes(provider)) {
108
+ throw new Error(`Cloud sign-in provider is unavailable: ${provider}`)
109
+ }
110
+ const result = await createCloudAuthClient(discovery, { fetch: options.fetch }).signIn.social({
111
+ provider,
112
+ callbackURL,
113
+ errorCallbackURL: callbackURL,
114
+ disableRedirect: true
115
+ })
116
+ if (result.error) throw new Error(result.error.message ?? 'Cloud sign-in failed')
117
+ if (typeof result.data.url !== 'string') {
118
+ throw new TypeError('Cloud sign-in response did not include a URL')
119
+ }
120
+ const navigate = options.navigate ?? ((url: string) => globalThis.location.assign(url))
121
+ navigate(result.data.url)
122
+ }
123
+
124
+ export async function signOutFromCloud(
125
+ discovery: CloudDiscovery,
126
+ options: Pick<CloudAuthClientOptions, 'fetch' | 'accessToken'> = {}
127
+ ): Promise<void> {
128
+ const result = await createCloudAuthClient(discovery, options).signOut()
129
+ if (result.error) throw new Error(result.error.message ?? 'Cloud sign-out failed')
130
+ }
131
+
132
+ /** An email sign-in that went through: the session's bearer token, or a second step to take. */
133
+ export type CloudEmailSignIn = { status: 'signed-in'; token: string } | { status: 'two-step' }
134
+
135
+ type CloudEmailAuthOptions = Pick<CloudAuthClientOptions, 'fetch' | 'captchaResponse'>
136
+
137
+ /**
138
+ * Signs in with an email and password without leaving the app. The token goes on every later
139
+ * request, so no cookie has to cross from the server to the editor.
140
+ */
141
+ export async function signInToCloudWithEmail(
142
+ discovery: CloudDiscovery,
143
+ input: { email: string; password: string },
144
+ options: CloudEmailAuthOptions = {}
145
+ ): Promise<CloudAuthResult<CloudEmailSignIn>> {
146
+ const result = await createCloudAuthClient(discovery, options)
147
+ .signIn.email({ ...input, rememberMe: true })
148
+ .catch(() => null)
149
+ if (!result) return cloudAuthFailure(null)
150
+ if (result.error) return cloudAuthFailure(result.error)
151
+ if ('twoFactorRedirect' in result.data && result.data.twoFactorRedirect === true) {
152
+ return { ok: true, value: { status: 'two-step' } }
153
+ }
154
+ if (!('token' in result.data) || typeof result.data.token !== 'string') {
155
+ return cloudAuthFailure(null)
156
+ }
157
+ return { ok: true, value: { status: 'signed-in', token: result.data.token } }
158
+ }
159
+
160
+ /** Creates an account; the server emails a link that opens `verifiedURL` once it is confirmed. */
161
+ export async function signUpToCloudWithEmail(
162
+ discovery: CloudDiscovery,
163
+ input: { name: string; email: string; password: string; verifiedURL: string },
164
+ options: CloudEmailAuthOptions = {}
165
+ ): Promise<CloudAuthResult> {
166
+ const result = await createCloudAuthClient(discovery, options)
167
+ .signUp.email({
168
+ name: input.name,
169
+ email: input.email,
170
+ password: input.password,
171
+ callbackURL: input.verifiedURL
172
+ })
173
+ .catch(() => null)
174
+ if (!result) return cloudAuthFailure(null)
175
+ return result.error ? cloudAuthFailure(result.error) : { ok: true, value: undefined }
176
+ }
177
+
178
+ export async function resendCloudVerification(
179
+ discovery: CloudDiscovery,
180
+ input: { email: string; verifiedURL: string },
181
+ options: CloudEmailAuthOptions = {}
182
+ ): Promise<CloudAuthResult> {
183
+ const result = await createCloudAuthClient(discovery, options)
184
+ .sendVerificationEmail({ email: input.email, callbackURL: input.verifiedURL })
185
+ .catch(() => null)
186
+ if (!result) return cloudAuthFailure(null)
187
+ return result.error ? cloudAuthFailure(result.error) : { ok: true, value: undefined }
188
+ }
@@ -0,0 +1,54 @@
1
+ /** Why a sign-in step did not go through, in terms a page or dialog can explain. */
2
+ export type CloudAuthFailure =
3
+ | 'invalid-credentials'
4
+ | 'email-not-verified'
5
+ | 'password-too-short'
6
+ | 'password-too-long'
7
+ | 'invalid-link'
8
+ | 'invalid-code'
9
+ | 'passkey-cancelled'
10
+ | 'passkey-exists'
11
+ | 'passkey-unavailable'
12
+ | 'session-not-fresh'
13
+ | 'rate-limited'
14
+ | 'unavailable'
15
+
16
+ export type CloudAuthResult<T = undefined> =
17
+ | { ok: true; value: T }
18
+ | { ok: false; failure: CloudAuthFailure }
19
+
20
+ type BetterAuthError = { code?: string; status?: number } | null | undefined
21
+
22
+ /** The failure a Better Auth error stands for; anything unknown can only be retried later. */
23
+ export function cloudAuthFailure(error: BetterAuthError): { ok: false; failure: CloudAuthFailure } {
24
+ if (error?.status === 429) return { ok: false, failure: 'rate-limited' }
25
+ switch (error?.code ?? '') {
26
+ case 'INVALID_EMAIL_OR_PASSWORD':
27
+ return { ok: false, failure: 'invalid-credentials' }
28
+ case 'EMAIL_NOT_VERIFIED':
29
+ return { ok: false, failure: 'email-not-verified' }
30
+ case 'PASSWORD_TOO_SHORT':
31
+ return { ok: false, failure: 'password-too-short' }
32
+ case 'PASSWORD_TOO_LONG':
33
+ return { ok: false, failure: 'password-too-long' }
34
+ case 'INVALID_TOKEN':
35
+ return { ok: false, failure: 'invalid-link' }
36
+ case 'SESSION_NOT_FRESH':
37
+ return { ok: false, failure: 'session-not-fresh' }
38
+ case 'AUTH_CANCELLED':
39
+ case 'ERROR_CEREMONY_ABORTED':
40
+ return { ok: false, failure: 'passkey-cancelled' }
41
+ case 'ERROR_AUTHENTICATOR_PREVIOUSLY_REGISTERED':
42
+ return { ok: false, failure: 'passkey-exists' }
43
+ case 'INVALID_CODE':
44
+ case 'INVALID_TWO_FACTOR_CODE':
45
+ case 'INVALID_BACKUP_CODE':
46
+ return { ok: false, failure: 'invalid-code' }
47
+ default:
48
+ // The browser's own WebAuthn refusals, such as an address it won't make passkeys for.
49
+ return {
50
+ ok: false,
51
+ failure: error?.code?.startsWith('ERROR_') ? 'passkey-unavailable' : 'unavailable'
52
+ }
53
+ }
54
+ }
@@ -0,0 +1,45 @@
1
+ import { cloudServerOrigin, type CloudDiscovery } from '#cloud/contract'
2
+ import { withoutFragment, withQuery } from 'ufo'
3
+
4
+ import type { CloudSocialProvider } from './client'
5
+
6
+ /** The instance owns authentication; only its own editor may receive the return. */
7
+ export function cloudEditorReturnURL(discovery: CloudDiscovery, value: string): string {
8
+ const destination = new URL(value)
9
+ if (
10
+ !['https:', 'http:'].includes(destination.protocol) ||
11
+ destination.origin !== cloudServerOrigin(discovery) ||
12
+ destination.username ||
13
+ destination.password
14
+ ) {
15
+ throw new Error('Authentication return URL must belong to this instance editor')
16
+ }
17
+ return withoutFragment(destination.href)
18
+ }
19
+
20
+ /**
21
+ * The server's sign-in page, coming back to `returnURL` on its editor afterwards. A `provider`
22
+ * starts that provider's sign-in at once, while the server's pages still handle two-step sign-in
23
+ * and approval before the return.
24
+ */
25
+ export function cloudSignInURL(
26
+ discovery: CloudDiscovery,
27
+ returnURL: string,
28
+ provider?: CloudSocialProvider
29
+ ): string {
30
+ const offered = provider && discovery.authentication.socialProviders.includes(provider)
31
+ // The pages are at the server's root, whatever path the auth API has.
32
+ return withQuery(new URL('/auth/sign-in', discovery.authURL).href, {
33
+ redirect: withQuery('/auth/return', { editor: cloudEditorReturnURL(discovery, returnURL) }),
34
+ provider: offered ? provider : undefined
35
+ })
36
+ }
37
+
38
+ /** Accept only same-origin application paths for post-authentication navigation. */
39
+ export function cloudRedirectPath(value: unknown, fallback = '/app'): string {
40
+ if (typeof value !== 'string' || !value.startsWith('/') || value.startsWith('//')) return fallback
41
+ const origin = 'https://redirect.invalid'
42
+ const url = new URL(value, origin)
43
+ if (url.origin !== origin) return fallback
44
+ return `${url.pathname}${url.search}${url.hash}`
45
+ }
@@ -0,0 +1,134 @@
1
+ import type { CloudDiscovery } from '#cloud/contract'
2
+ import { joinURL } from 'ufo'
3
+ import * as v from 'valibot'
4
+
5
+ import type { CloudFetch } from './discovery'
6
+
7
+ const deviceCodeSchema = v.object({
8
+ device_code: v.string(),
9
+ user_code: v.string(),
10
+ verification_uri: v.pipe(v.string(), v.url()),
11
+ verification_uri_complete: v.pipe(v.string(), v.url()),
12
+ expires_in: v.pipe(v.number(), v.integer(), v.minValue(1)),
13
+ interval: v.pipe(v.number(), v.integer(), v.minValue(1))
14
+ })
15
+ const deviceTokenSchema = v.object({
16
+ access_token: v.string(),
17
+ token_type: v.literal('Bearer'),
18
+ expires_in: v.pipe(v.number(), v.integer(), v.minValue(1)),
19
+ scope: v.string()
20
+ })
21
+ const deviceErrorSchema = v.object({ error: v.string(), error_description: v.optional(v.string()) })
22
+ /** RFC 8628: each `slow_down` adds five seconds to the polling interval. */
23
+ const SLOW_DOWN_MS = 5000
24
+
25
+ export type CloudDeviceErrorCode = 'denied' | 'expired' | 'unavailable'
26
+
27
+ export class CloudDeviceAuthorizationError extends Error {
28
+ override readonly name = 'CloudDeviceAuthorizationError'
29
+ constructor(readonly code: CloudDeviceErrorCode) {
30
+ super(`Cloud device authorization ${code}`)
31
+ }
32
+ }
33
+
34
+ export type CloudDeviceAuthorization = v.InferOutput<typeof deviceCodeSchema>
35
+ export type CloudDeviceToken = v.InferOutput<typeof deviceTokenSchema>
36
+
37
+ export type CloudDevicePollingOptions = {
38
+ signal?: AbortSignal
39
+ fetch?: CloudFetch
40
+ now?: () => number
41
+ sleep?: (milliseconds: number, signal?: AbortSignal) => Promise<void>
42
+ }
43
+
44
+ function abortableSleep(milliseconds: number, signal?: AbortSignal): Promise<void> {
45
+ return new Promise<void>((resolve, reject) => {
46
+ const timeout = setTimeout(resolve, milliseconds)
47
+ signal?.addEventListener(
48
+ 'abort',
49
+ () => {
50
+ clearTimeout(timeout)
51
+ reject(
52
+ signal.reason instanceof Error
53
+ ? signal.reason
54
+ : new DOMException('Authorization cancelled', 'AbortError')
55
+ )
56
+ },
57
+ { once: true }
58
+ )
59
+ })
60
+ }
61
+
62
+ function authEndpoint(discovery: CloudDiscovery, path: string): string {
63
+ return joinURL(discovery.authURL, path)
64
+ }
65
+
66
+ export type CloudDeviceAuthorizationOptions = {
67
+ fetch?: CloudFetch
68
+ }
69
+
70
+ export async function requestCloudDeviceAuthorization(
71
+ discovery: CloudDiscovery,
72
+ connectionId: string,
73
+ options: CloudDeviceAuthorizationOptions = {}
74
+ ): Promise<CloudDeviceAuthorization> {
75
+ const request = options.fetch ?? globalThis.fetch
76
+ const response = await request(authEndpoint(discovery, 'device/code'), {
77
+ method: 'POST',
78
+ headers: { 'Content-Type': 'application/json' },
79
+ body: JSON.stringify({
80
+ client_id: `openpencil-desktop:${connectionId}`,
81
+ scope: 'openid profile'
82
+ })
83
+ })
84
+ if (!response.ok) throw new CloudDeviceAuthorizationError('unavailable')
85
+ return v.parse(deviceCodeSchema, await response.json())
86
+ }
87
+
88
+ export async function pollCloudDeviceToken(
89
+ discovery: CloudDiscovery,
90
+ connectionId: string,
91
+ authorization: CloudDeviceAuthorization,
92
+ options: CloudDevicePollingOptions = {}
93
+ ): Promise<CloudDeviceToken> {
94
+ const request = options.fetch ?? globalThis.fetch
95
+ const now = options.now ?? Date.now
96
+ const sleep = options.sleep ?? abortableSleep
97
+ const expiresAt = now() + authorization.expires_in * 1000
98
+ let interval = authorization.interval * 1000
99
+ while (now() < expiresAt) {
100
+ options.signal?.throwIfAborted()
101
+ await sleep(interval, options.signal)
102
+ if (now() >= expiresAt) break
103
+ const response = await request(authEndpoint(discovery, 'device/token'), {
104
+ method: 'POST',
105
+ headers: { 'Content-Type': 'application/json' },
106
+ body: JSON.stringify({
107
+ grant_type: 'urn:ietf:params:oauth:grant-type:device_code',
108
+ device_code: authorization.device_code,
109
+ client_id: `openpencil-desktop:${connectionId}`
110
+ }),
111
+ signal: options.signal
112
+ })
113
+ const body = await response.text()
114
+ if (response.ok) return v.parse(v.pipe(v.string(), v.parseJson(), deviceTokenSchema), body)
115
+ // A rate limit asks for the same as `slow_down`, whatever its body says.
116
+ if (response.status === 429) {
117
+ interval += SLOW_DOWN_MS
118
+ continue
119
+ }
120
+ const parsed = v.safeParse(v.pipe(v.string(), v.parseJson(), deviceErrorSchema), body)
121
+ if (!parsed.success) throw new CloudDeviceAuthorizationError('unavailable')
122
+ const error = parsed.output
123
+ if (error.error === 'authorization_pending') continue
124
+ if (error.error === 'slow_down') {
125
+ interval += SLOW_DOWN_MS
126
+ continue
127
+ }
128
+ let code: CloudDeviceErrorCode = 'unavailable'
129
+ if (error.error === 'access_denied') code = 'denied'
130
+ else if (error.error === 'expired_token') code = 'expired'
131
+ throw new CloudDeviceAuthorizationError(code)
132
+ }
133
+ throw new CloudDeviceAuthorizationError('expired')
134
+ }
@@ -0,0 +1,105 @@
1
+ import {
2
+ CLOUD_DISCOVERY_PATH,
3
+ CLOUD_PROTOCOL_VERSION,
4
+ cloudDiscoverySchema,
5
+ type CloudDiscovery
6
+ } from '#cloud/contract'
7
+ import * as v from 'valibot'
8
+
9
+ const DISCOVERY_TIMEOUT_MS = 10_000
10
+
11
+ export type CloudFetch = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>
12
+
13
+ export type DiscoverCloudOptions = {
14
+ fetch?: CloudFetch
15
+ signal?: AbortSignal
16
+ }
17
+
18
+ /**
19
+ * Why a server could not be used: the address is not a web address, nothing answered, something
20
+ * answered but not as OpenPencil Cloud, or it speaks another protocol version.
21
+ */
22
+ export type CloudDiscoveryFailure = 'invalid-address' | 'unreachable' | 'not-cloud' | 'outdated'
23
+
24
+ export class CloudClientError extends Error {
25
+ constructor(
26
+ message: string,
27
+ override readonly cause?: unknown,
28
+ readonly reason: CloudDiscoveryFailure = 'unreachable'
29
+ ) {
30
+ super(message)
31
+ this.name = 'CloudClientError'
32
+ }
33
+ }
34
+
35
+ const discoveryBodySchema = v.pipe(v.string(), v.parseJson(), v.looseObject({}))
36
+ const protocolSchema = v.looseObject({ protocolVersion: v.string() })
37
+
38
+ function discoveryURL(serverURL: string): URL {
39
+ let url: URL
40
+ try {
41
+ url = new URL(serverURL)
42
+ } catch (error) {
43
+ throw new CloudClientError('OpenPencil server URL is invalid', error, 'invalid-address')
44
+ }
45
+ if (url.protocol !== 'https:' && url.protocol !== 'http:') {
46
+ throw new CloudClientError(
47
+ 'OpenPencil server URL must use HTTP or HTTPS',
48
+ undefined,
49
+ 'invalid-address'
50
+ )
51
+ }
52
+ url.pathname = CLOUD_DISCOVERY_PATH
53
+ url.search = ''
54
+ url.hash = ''
55
+ return url
56
+ }
57
+
58
+ function parseDiscoveryBody(text: string): CloudDiscovery {
59
+ const body = v.safeParse(discoveryBodySchema, text)
60
+ if (!body.success) {
61
+ throw new CloudClientError('OpenPencil server discovery is not JSON', body.issues, 'not-cloud')
62
+ }
63
+ const discovery = v.safeParse(cloudDiscoverySchema, body.output)
64
+ if (discovery.success) return discovery.output
65
+ const protocol = v.safeParse(protocolSchema, body.output)
66
+ const outdated = protocol.success && protocol.output.protocolVersion !== CLOUD_PROTOCOL_VERSION
67
+ throw new CloudClientError(
68
+ outdated
69
+ ? `OpenPencil server speaks protocol ${protocol.output.protocolVersion}`
70
+ : 'OpenPencil server discovery is invalid',
71
+ discovery.issues,
72
+ outdated ? 'outdated' : 'not-cloud'
73
+ )
74
+ }
75
+
76
+ export async function discoverCloud(
77
+ serverURL: string,
78
+ options: DiscoverCloudOptions = {}
79
+ ): Promise<CloudDiscovery> {
80
+ const fetchImplementation = options.fetch ?? globalThis.fetch
81
+ const timeoutSignal = AbortSignal.timeout(DISCOVERY_TIMEOUT_MS)
82
+ const signal = options.signal ? AbortSignal.any([options.signal, timeoutSignal]) : timeoutSignal
83
+
84
+ try {
85
+ const response = await fetchImplementation(discoveryURL(serverURL), {
86
+ headers: { Accept: 'application/json' },
87
+ redirect: 'follow',
88
+ signal
89
+ })
90
+ if (!response.ok) {
91
+ throw new CloudClientError(
92
+ `OpenPencil server discovery failed with HTTP ${response.status}`,
93
+ undefined,
94
+ response.status >= 500 ? 'unreachable' : 'not-cloud'
95
+ )
96
+ }
97
+ return parseDiscoveryBody(await response.text())
98
+ } catch (error) {
99
+ if (error instanceof CloudClientError) throw error
100
+ if (signal.aborted) {
101
+ throw new CloudClientError('OpenPencil server discovery was cancelled or timed out', error)
102
+ }
103
+ throw new CloudClientError('OpenPencil server discovery failed', error)
104
+ }
105
+ }
@@ -0,0 +1,81 @@
1
+ import {
2
+ documentImageLinkSchema,
3
+ imageUploadOfferSchema,
4
+ type CommitImageUploadsInput,
5
+ type DocumentImageLink,
6
+ type ImageUploadOffer,
7
+ type RequestImageUploadsInput,
8
+ type ResolveDocumentShareInput
9
+ } from '#cloud/contract'
10
+ import type { CloudAPI, PublicCloudAPI } from '#cloud/server/api'
11
+ import type { hc } from 'hono/client'
12
+ import * as v from 'valibot'
13
+
14
+ import { parseResponse, responseBody, type CloudClientDiagnostic } from './response'
15
+
16
+ const imageLinksResponseSchema = v.object({ images: v.array(documentImageLinkSchema) })
17
+ const imageUploadsResponseSchema = v.object({ uploads: v.array(imageUploadOfferSchema) })
18
+
19
+ /** The images a save uploads apart from the document, and the links a live room loads them by. */
20
+ export function createImageRequests(
21
+ client: ReturnType<typeof hc<CloudAPI>>,
22
+ publicClient: ReturnType<typeof hc<PublicCloudAPI>>,
23
+ onDiagnostic?: CloudClientDiagnostic
24
+ ) {
25
+ return {
26
+ /** Uploads for the images a save will name that the document's workspace lacks. */
27
+ async requestImageUploads(
28
+ documentId: string,
29
+ input: RequestImageUploadsInput
30
+ ): Promise<ImageUploadOffer[]> {
31
+ const response = await parseResponse(
32
+ client.documents[':documentId'].images.$post({
33
+ param: { documentId },
34
+ json: input
35
+ }),
36
+ imageUploadsResponseSchema,
37
+ onDiagnostic
38
+ )
39
+ return response.uploads
40
+ },
41
+ /** Commits the image uploads a save asked for, once their bytes are in place. */
42
+ async commitImageUploads(
43
+ documentId: string,
44
+ uploads: CommitImageUploadsInput['uploads']
45
+ ): Promise<void> {
46
+ const response = await client.documents[':documentId'].images.commit.$post({
47
+ param: { documentId },
48
+ json: { uploads }
49
+ })
50
+ await responseBody(response, onDiagnostic)
51
+ },
52
+ /** Links for images a document's live room names. */
53
+ async getImageLinks(documentId: string, checksums: string[]): Promise<DocumentImageLink[]> {
54
+ const response = await parseResponse(
55
+ client.documents[':documentId'].images.links.$post({
56
+ param: { documentId },
57
+ json: { checksums }
58
+ }),
59
+ imageLinksResponseSchema,
60
+ onDiagnostic
61
+ )
62
+ return response.images
63
+ },
64
+ /** Links for images a shared document's live room names, as the share's guest. */
65
+ async getSharedImageLinks(
66
+ shareId: string,
67
+ input: ResolveDocumentShareInput,
68
+ checksums: string[]
69
+ ): Promise<DocumentImageLink[]> {
70
+ const response = await parseResponse(
71
+ publicClient.shares[':shareId'].images.$post({
72
+ param: { shareId },
73
+ json: { ...input, checksums }
74
+ }),
75
+ imageLinksResponseSchema,
76
+ onDiagnostic
77
+ )
78
+ return response.images
79
+ }
80
+ }
81
+ }
@@ -0,0 +1,53 @@
1
+ export {
2
+ CloudAIError,
3
+ cloudAIFetch,
4
+ createCloudAIClient,
5
+ type CloudAIClient,
6
+ type CloudAIClientOptions,
7
+ type CloudAITokenSource
8
+ } from './ai'
9
+ export { cloudEditorReturnURL, cloudRedirectPath, cloudSignInURL } from './auth/navigation'
10
+ export {
11
+ CloudAPIError,
12
+ createCloudAPIClient,
13
+ type CloudAPIClient,
14
+ type CloudRequestOptions,
15
+ type CloudUpload
16
+ } from './api'
17
+ export { cloudAuthFailure, type CloudAuthFailure, type CloudAuthResult } from './auth/failure'
18
+ export {
19
+ createCloudAuthClient,
20
+ resendCloudVerification,
21
+ signInToCloudWithEmail,
22
+ signUpToCloudWithEmail,
23
+ type CloudEmailSignIn,
24
+ signInToCloud,
25
+ signOutFromCloud,
26
+ type CloudAuthClient,
27
+ type CloudAuthClientOptions,
28
+ type CloudSignInOptions,
29
+ type CloudSocialProvider
30
+ } from './auth/client'
31
+ export {
32
+ CloudDeviceAuthorizationError,
33
+ type CloudDeviceErrorCode,
34
+ pollCloudDeviceToken,
35
+ requestCloudDeviceAuthorization,
36
+ type CloudDeviceAuthorization,
37
+ type CloudDeviceAuthorizationOptions,
38
+ type CloudDeviceToken
39
+ } from './device-authorization'
40
+ export {
41
+ CloudClientError,
42
+ type CloudDiscoveryFailure,
43
+ discoverCloud,
44
+ type CloudFetch,
45
+ type DiscoverCloudOptions
46
+ } from './discovery'
47
+ export {
48
+ CloudPortalAPIError,
49
+ createCloudPortalClient,
50
+ type CloudPortalAPIErrorKind,
51
+ type CloudPortalClient,
52
+ type CloudPortalClientOptions
53
+ } from './portal/client'