@beechcms/api 0.6.0-preview.1 → 0.6.0-preview.2

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 (222) hide show
  1. package/assets/dashboard/BeechLogo.svg +18 -18
  2. package/assets/dashboard/BeechLogoLIght.svg +48 -48
  3. package/assets/dashboard/assets/chart-BrJFdsGZ.js +39 -0
  4. package/assets/dashboard/assets/index-CIaoMxuB.css +1 -0
  5. package/assets/dashboard/assets/index-wTKgygsg.js +636 -0
  6. package/assets/dashboard/assets/pie-chart-recharts-BEaE1FOE.js +1 -0
  7. package/assets/dashboard/assets/timeseries-chart-recharts-DmWM6imF.js +1 -0
  8. package/assets/dashboard/beechLogoDark.svg +48 -48
  9. package/assets/dashboard/index.html +18 -18
  10. package/assets/dashboard/noResult.svg +42 -42
  11. package/assets/dashboard/sol.svg +3 -3
  12. package/assets/dashboard/undraw_enter_nwx3.svg +36 -36
  13. package/migrations/0000_v040_base.sql +265 -265
  14. package/migrations/0029_automations.sql +14 -14
  15. package/migrations/0030_test_seeds.sql +125 -125
  16. package/package.json +2 -2
  17. package/src/auth/__fixtures__/in-memory-hash-provider.ts +17 -17
  18. package/src/auth/__fixtures__/static-token-service.ts +22 -22
  19. package/src/auth/bcrypt-hash-provider.ts +24 -24
  20. package/src/auth/constants.ts +14 -14
  21. package/src/auth/generate-refresh-token.test.ts +23 -23
  22. package/src/auth/hash-provider.test.ts +55 -55
  23. package/src/auth/jose-token-service.ts +62 -62
  24. package/src/auth/jwt-claims-passthrough.test.ts +87 -87
  25. package/src/auth/login.test.ts +100 -100
  26. package/src/auth/login.ts +78 -78
  27. package/src/auth/refresh.ts +11 -11
  28. package/src/auth/token-service.test.ts +90 -90
  29. package/src/factory.ts +370 -368
  30. package/src/features/automations/__tests__/action-executors.test.ts +255 -255
  31. package/src/features/automations/__tests__/automation-runner.test.ts +196 -196
  32. package/src/features/automations/__tests__/automation-runner.utils.test.ts +60 -60
  33. package/src/features/automations/__tests__/automations.handler.test.ts +264 -264
  34. package/src/features/automations/__tests__/automations.repository.test.ts +163 -163
  35. package/src/features/automations/__tests__/automations.schema.test.ts +224 -224
  36. package/src/features/automations/__tests__/context-resolver.test.ts +126 -126
  37. package/src/features/automations/__tests__/cron-runner.test.ts +267 -267
  38. package/src/features/automations/__tests__/cron-runner.utils.test.ts +144 -144
  39. package/src/features/automations/__tests__/set-variable.executor.test.ts +383 -383
  40. package/src/features/automations/__tests__/template-grammar.test.ts +308 -308
  41. package/src/features/automations/__tests__/webhook.executor.test.ts +142 -142
  42. package/src/features/automations/__tests__/when-evaluator.test.ts +274 -274
  43. package/src/features/automations/__tests__/when-pushdown.test.ts +281 -281
  44. package/src/features/automations/action-executors/create-entry.executor.ts +27 -27
  45. package/src/features/automations/action-executors/edit-field.executor.ts +26 -26
  46. package/src/features/automations/action-executors/index.ts +37 -37
  47. package/src/features/automations/action-executors/send-mail.executor.ts +53 -53
  48. package/src/features/automations/action-executors/set-variable.executor.ts +159 -159
  49. package/src/features/automations/action-executors/webhook.executor.ts +67 -67
  50. package/src/features/automations/automation-runner.ts +85 -85
  51. package/src/features/automations/automation-runner.utils.ts +47 -47
  52. package/src/features/automations/automations.handler.ts +197 -197
  53. package/src/features/automations/automations.schema.ts +177 -177
  54. package/src/features/automations/context-resolver.ts +152 -152
  55. package/src/features/automations/cron-runner.ts +140 -140
  56. package/src/features/automations/cron-runner.utils.ts +44 -44
  57. package/src/features/automations/filter-translation.ts +46 -46
  58. package/src/features/automations/index.ts +16 -16
  59. package/src/features/automations/template-grammar.ts +245 -245
  60. package/src/features/automations/var-access-resolver.ts +140 -140
  61. package/src/features/automations/when-evaluator.ts +87 -87
  62. package/src/features/automations/when-pushdown.ts +57 -57
  63. package/src/features/backrefs/__tests__/backrefs.handler.test.ts +359 -359
  64. package/src/features/backrefs/backrefs.handler.ts +168 -168
  65. package/src/features/backrefs/d1-backref.repository.ts +84 -84
  66. package/src/features/backrefs/index.ts +5 -5
  67. package/src/features/content/constants.ts +16 -16
  68. package/src/features/content/handlers/bulk.handler.ts +185 -185
  69. package/src/features/content/handlers/create.ts +129 -129
  70. package/src/features/content/handlers/delete.ts +62 -62
  71. package/src/features/content/handlers/facets.ts +49 -49
  72. package/src/features/content/handlers/get.ts +120 -120
  73. package/src/features/content/handlers/helpers.test.ts +180 -180
  74. package/src/features/content/handlers/helpers.ts +93 -93
  75. package/src/features/content/handlers/list.ts +174 -174
  76. package/src/features/content/handlers/update.ts +174 -174
  77. package/src/features/content/index.ts +26 -26
  78. package/src/features/dashboard-layout/__tests__/dashboard-layout.handler.test.ts +388 -0
  79. package/src/features/dashboard-layout/dashboard-layout.handler.ts +206 -0
  80. package/src/features/dashboard-layout/index.ts +5 -0
  81. package/src/features/draft/draft.handler.ts +195 -195
  82. package/src/features/draft/draft.middleware.ts +66 -66
  83. package/src/features/draft/index.ts +5 -5
  84. package/src/features/email/email.provider.ts +42 -42
  85. package/src/features/email/email.service.ts +98 -98
  86. package/src/features/email/email.types.ts +119 -119
  87. package/src/features/email/index.ts +33 -33
  88. package/src/features/email/providers/resend.ts +67 -67
  89. package/src/features/email/providers/smtp.ts +55 -55
  90. package/src/features/email/templates/automation-mail.ts +19 -19
  91. package/src/features/email/templates/password-changed.ts +63 -63
  92. package/src/features/email/templates/password-reset.ts +68 -68
  93. package/src/features/email/templates/shell.ts +96 -96
  94. package/src/features/notifications/index.ts +5 -5
  95. package/src/features/notifications/notifications.handler.ts +105 -105
  96. package/src/features/password-reset/index.ts +19 -19
  97. package/src/features/password-reset/request.ts +92 -92
  98. package/src/features/password-reset/reset.ts +102 -102
  99. package/src/features/rotate-field/index.ts +5 -5
  100. package/src/features/rotate-field/rotate-field.handler.ts +132 -132
  101. package/src/features/rotate-field/rotate-field.schema.ts +17 -17
  102. package/src/features/schema/schema.handler.ts +131 -131
  103. package/src/features/seeds/index.ts +5 -5
  104. package/src/features/seeds/seeds.handler.test.ts +1199 -632
  105. package/src/features/seeds/seeds.handler.ts +558 -693
  106. package/src/features/settings/__tests__/settings.handler.test.ts +555 -555
  107. package/src/features/settings/settings.handler.ts +392 -392
  108. package/src/features/setup/index.ts +288 -204
  109. package/src/features/stats/index.ts +5 -5
  110. package/src/features/stats/stats.handler.ts +420 -420
  111. package/src/features/webhooks/index.ts +63 -63
  112. package/src/index.ts +65 -65
  113. package/src/media-utils.ts +82 -82
  114. package/src/middleware/auth-providers.middleware.test.ts +85 -0
  115. package/src/middleware/auth-providers.middleware.ts +45 -45
  116. package/src/middleware/observability.middleware.test.ts +93 -0
  117. package/src/middleware/observability.middleware.ts +70 -70
  118. package/src/middleware/rate-limit.middleware.ts +45 -45
  119. package/src/middleware/repository.middleware.ts +117 -114
  120. package/src/middleware/seed-registry.middleware.test.ts +97 -97
  121. package/src/middleware/seed-registry.middleware.ts +21 -21
  122. package/src/middleware/storage.middleware.ts +25 -25
  123. package/src/middleware.ts +45 -45
  124. package/src/public/access-policy.ts +27 -27
  125. package/src/public/api-key-middleware.ts +57 -57
  126. package/src/public/cache-utils.ts +38 -38
  127. package/src/public/entry-projection.ts +46 -46
  128. package/src/public/idempotency.ts +23 -23
  129. package/src/public/index.ts +16 -16
  130. package/src/public/problem-details.ts +124 -124
  131. package/src/public/public-add.ts +114 -114
  132. package/src/public/public-edit.ts +163 -163
  133. package/src/public/public-errors.ts +19 -19
  134. package/src/public/public-read.ts +63 -63
  135. package/src/public/public-routes.ts +88 -88
  136. package/src/public/query-builder.test.ts +224 -224
  137. package/src/public/query-builder.ts +156 -156
  138. package/src/public/rate-limit-middleware.ts +34 -34
  139. package/src/public/read-list.ts +54 -54
  140. package/src/public/read-single.ts +48 -48
  141. package/src/public/response-builder.ts +30 -30
  142. package/src/public/sanitize.ts +69 -69
  143. package/src/public/slug-utils.ts +18 -18
  144. package/src/rate-limit/cloudflare-rate-limiter.test.ts +30 -30
  145. package/src/rate-limit/cloudflare-rate-limiter.ts +15 -15
  146. package/src/rate-limit/in-memory-rate-limiter.test.ts +37 -37
  147. package/src/rate-limit/in-memory-rate-limiter.ts +17 -17
  148. package/src/rate-limit/no-op-rate-limiter.test.ts +22 -22
  149. package/src/rate-limit/no-op-rate-limiter.ts +11 -11
  150. package/src/search-utils.test.ts +211 -211
  151. package/src/search-utils.ts +213 -213
  152. package/src/search.ts +65 -65
  153. package/src/shared/apply-policies.test.ts +81 -81
  154. package/src/shared/apply-policies.ts +67 -67
  155. package/src/shared/automations.repository.d1.ts +150 -150
  156. package/src/shared/background-notification-service.test.ts +62 -62
  157. package/src/shared/background-notification-service.ts +52 -52
  158. package/src/shared/base.repository.d1.ts +32 -32
  159. package/src/shared/content-utils.test.ts +165 -165
  160. package/src/shared/content-utils.ts +86 -86
  161. package/src/shared/content.repository.d1.test.ts +507 -458
  162. package/src/shared/content.repository.d1.ts +851 -851
  163. package/src/shared/d1-activity-log.repository.test.ts +140 -140
  164. package/src/shared/d1-activity-log.repository.ts +105 -105
  165. package/src/shared/d1-activity-logger.test.ts +86 -86
  166. package/src/shared/d1-activity-logger.ts +67 -67
  167. package/src/shared/d1-analytics.repository.test.ts +78 -78
  168. package/src/shared/d1-analytics.repository.ts +85 -85
  169. package/src/shared/d1-content-scan.repository.test.ts +80 -80
  170. package/src/shared/d1-content-scan.repository.ts +37 -37
  171. package/src/shared/d1-notification.repository.test.ts +128 -128
  172. package/src/shared/d1-notification.repository.ts +118 -118
  173. package/src/shared/d1-password-reset-token.repository.test.ts +81 -81
  174. package/src/shared/d1-password-reset-token.repository.ts +56 -56
  175. package/src/shared/d1-search.repository.test.ts +87 -87
  176. package/src/shared/d1-search.repository.ts +88 -88
  177. package/src/shared/d1-session.repository.test.ts +125 -125
  178. package/src/shared/d1-session.repository.ts +102 -102
  179. package/src/shared/d1-setup-checklist.repository.ts +36 -36
  180. package/src/shared/d1-user.repository.test.ts +151 -151
  181. package/src/shared/d1-user.repository.ts +119 -119
  182. package/src/shared/d1-widget.repository.test.ts +267 -221
  183. package/src/shared/d1-widget.repository.ts +385 -341
  184. package/src/shared/dashboard-layout.repository.d1.test.ts +135 -0
  185. package/src/shared/dashboard-layout.repository.d1.ts +58 -0
  186. package/src/shared/demo-data-sql.ts +216 -54
  187. package/src/shared/demo-data.repository.d1.ts +20 -20
  188. package/src/shared/execution-context-scheduler.ts +13 -13
  189. package/src/shared/fixed-clock.ts +25 -25
  190. package/src/shared/fts-sync.ts +8 -8
  191. package/src/shared/idempotency.repository.d1.test.ts +83 -83
  192. package/src/shared/idempotency.repository.d1.ts +60 -60
  193. package/src/shared/in-memory-activity-logger.ts +19 -19
  194. package/src/shared/in-memory-notification-service.ts +19 -19
  195. package/src/shared/in-memory-seed.repository.ts +58 -51
  196. package/src/shared/media.repository.d1.test.ts +107 -107
  197. package/src/shared/media.repository.d1.ts +68 -68
  198. package/src/shared/qstash-notification-service.test.ts +67 -67
  199. package/src/shared/qstash-notification-service.ts +55 -55
  200. package/src/shared/query-utils.ts +141 -141
  201. package/src/shared/request-utils.ts +26 -26
  202. package/src/shared/schema-mutator.d1.test.ts +142 -0
  203. package/src/shared/schema-mutator.d1.ts +64 -64
  204. package/src/shared/seed-layout.repository.d1.test.ts +114 -114
  205. package/src/shared/seed-layout.repository.d1.ts +62 -62
  206. package/src/shared/seed-registry-cache.test.ts +68 -68
  207. package/src/shared/seed-registry-cache.ts +49 -49
  208. package/src/shared/seed.repository.d1.test.ts +143 -143
  209. package/src/shared/seed.repository.d1.ts +98 -98
  210. package/src/shared/sequential-id-generator.ts +33 -33
  211. package/src/shared/site-settings.repository.d1.ts +53 -53
  212. package/src/shared/storage/factory.ts +41 -41
  213. package/src/shared/storage/s3-bucket.ts +195 -195
  214. package/src/shared/storage-utils.ts +40 -40
  215. package/src/shared/system-stats.repository.d1.test.ts +58 -58
  216. package/src/shared/system-stats.repository.d1.ts +48 -48
  217. package/src/types.ts +90 -87
  218. package/src/upload.ts +198 -198
  219. package/src/widget.test.ts +85 -0
  220. package/src/widget.ts +251 -212
  221. package/assets/dashboard/assets/index-BSjk0Sx9.js +0 -634
  222. package/assets/dashboard/assets/index-kRCYVN2B.css +0 -1
@@ -1,41 +1,41 @@
1
- // SPDX-License-Identifier: BUSL-1.1
2
- // Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
3
- // See LICENSE in the repository root for license terms.
4
-
5
- import { BeechBucket, PutBucketOptions, GetBucketResult } from '@beechcms/core'
6
- import { Env } from '../../types'
7
- import { S3Bucket } from './s3-bucket'
8
-
9
- class NullBucket implements BeechBucket {
10
- private fail(): never {
11
- throw new Error('Storage not configured. Set R2_ENDPOINT, R2_ACCESS_KEY_ID, R2_SECRET_ACCESS_KEY, R2_BUCKET_NAME.')
12
- }
13
- put(): Promise<void> { return this.fail() }
14
- get(): Promise<GetBucketResult | null> { return this.fail() }
15
- delete(): Promise<void> { return this.fail() }
16
- head(): Promise<{ size: number } | null> { return this.fail() }
17
- getUrl(): string { return this.fail() }
18
- getTotalSize(): Promise<number> { return this.fail() }
19
- list(): Promise<{ objects: Array<{ key: string; size: number }>; cursor?: string }> { return this.fail() }
20
- presignPut(): Promise<string> { return this.fail() }
21
- presignGet(): Promise<string> { return this.fail() }
22
- }
23
-
24
- /**
25
- * Single storage path: S3-compatible HTTP API.
26
- * Prod → Cloudflare R2 with S3 API token.
27
- * Dev → MinIO container (or R2 staging bucket).
28
- */
29
- export function createBucketProvider(env: Env, baseUrl: string): BeechBucket {
30
- if (env.R2_ACCESS_KEY_ID && env.R2_SECRET_ACCESS_KEY && env.R2_ENDPOINT && env.R2_BUCKET_NAME) {
31
- return new S3Bucket({
32
- endpoint: env.R2_ENDPOINT,
33
- accessKeyId: env.R2_ACCESS_KEY_ID,
34
- secretAccessKey: env.R2_SECRET_ACCESS_KEY,
35
- bucketName: env.R2_BUCKET_NAME,
36
- baseUrl,
37
- cdnUrl: env.MEDIA_CDN_URL?.trim().replace(/\/$/, '') || undefined,
38
- })
39
- }
40
- return new NullBucket()
41
- }
1
+ // SPDX-License-Identifier: BUSL-1.1
2
+ // Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
3
+ // See LICENSE in the repository root for license terms.
4
+
5
+ import { BeechBucket, PutBucketOptions, GetBucketResult } from '@beechcms/core'
6
+ import { Env } from '../../types'
7
+ import { S3Bucket } from './s3-bucket'
8
+
9
+ class NullBucket implements BeechBucket {
10
+ private fail(): never {
11
+ throw new Error('Storage not configured. Set R2_ENDPOINT, R2_ACCESS_KEY_ID, R2_SECRET_ACCESS_KEY, R2_BUCKET_NAME.')
12
+ }
13
+ put(): Promise<void> { return this.fail() }
14
+ get(): Promise<GetBucketResult | null> { return this.fail() }
15
+ delete(): Promise<void> { return this.fail() }
16
+ head(): Promise<{ size: number } | null> { return this.fail() }
17
+ getUrl(): string { return this.fail() }
18
+ getTotalSize(): Promise<number> { return this.fail() }
19
+ list(): Promise<{ objects: Array<{ key: string; size: number }>; cursor?: string }> { return this.fail() }
20
+ presignPut(): Promise<string> { return this.fail() }
21
+ presignGet(): Promise<string> { return this.fail() }
22
+ }
23
+
24
+ /**
25
+ * Single storage path: S3-compatible HTTP API.
26
+ * Prod → Cloudflare R2 with S3 API token.
27
+ * Dev → MinIO container (or R2 staging bucket).
28
+ */
29
+ export function createBucketProvider(env: Env, baseUrl: string): BeechBucket {
30
+ if (env.R2_ACCESS_KEY_ID && env.R2_SECRET_ACCESS_KEY && env.R2_ENDPOINT && env.R2_BUCKET_NAME) {
31
+ return new S3Bucket({
32
+ endpoint: env.R2_ENDPOINT,
33
+ accessKeyId: env.R2_ACCESS_KEY_ID,
34
+ secretAccessKey: env.R2_SECRET_ACCESS_KEY,
35
+ bucketName: env.R2_BUCKET_NAME,
36
+ baseUrl,
37
+ cdnUrl: env.MEDIA_CDN_URL?.trim().replace(/\/$/, '') || undefined,
38
+ })
39
+ }
40
+ return new NullBucket()
41
+ }
@@ -1,195 +1,195 @@
1
- // SPDX-License-Identifier: BUSL-1.1
2
- // Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
3
- // See LICENSE in the repository root for license terms.
4
-
5
- import { S3Client, PutObjectCommand, GetObjectCommand, DeleteObjectCommand, HeadObjectCommand, ListObjectsV2Command } from '@aws-sdk/client-s3'
6
- import { getSignedUrl } from '@aws-sdk/s3-request-presigner'
7
- import { BeechBucket, PutBucketOptions, GetBucketResult, PresignOptions } from '@beechcms/core'
8
-
9
- /**
10
- * Implementation of BeechBucket using S3-compatible API (AWS SDK).
11
- * Used for production when connecting to R2 or any other S3 provider via HTTP.
12
- */
13
- export class S3Bucket implements BeechBucket {
14
- private client: S3Client
15
- private bucketName: string
16
- private baseUrl: string
17
-
18
- private cdnUrl: string | null
19
-
20
- constructor(config: {
21
- endpoint: string,
22
- accessKeyId: string,
23
- secretAccessKey: string,
24
- bucketName: string,
25
- baseUrl: string,
26
- cdnUrl?: string,
27
- }) {
28
- // requestChecksumCalculation/responseChecksumValidation exist at runtime in AWS SDK v3
29
- // but are not yet in the TypeScript types for this version. Casting via unknown to pass them
30
- // through: without them the SDK adds x-amz-checksum-crc32 to presigned URLs, which causes
31
- // R2 to reject PUT requests when the CRC32 of the uploaded file doesn't match.
32
- this.client = new S3Client({
33
- region: 'auto',
34
- endpoint: config.endpoint,
35
- credentials: {
36
- accessKeyId: config.accessKeyId,
37
- secretAccessKey: config.secretAccessKey,
38
- },
39
- forcePathStyle: true,
40
- requestChecksumCalculation: 'when_required',
41
- responseChecksumValidation: 'when_required',
42
- } as unknown as import('@aws-sdk/client-s3').S3ClientConfig)
43
- this.bucketName = config.bucketName
44
- this.baseUrl = config.baseUrl
45
- this.cdnUrl = config.cdnUrl ?? null
46
- }
47
-
48
- async put(key: string, body: ArrayBuffer | Uint8Array | ReadableStream, options?: PutBucketOptions): Promise<void> {
49
- const command = new PutObjectCommand({
50
- Bucket: this.bucketName,
51
- Key: key,
52
- Body: body instanceof ReadableStream ? await this.streamToUint8Array(body) : new Uint8Array(body as ArrayBuffer),
53
- ContentType: options?.contentType,
54
- Metadata: options?.metadata
55
- })
56
- await this.client.send(command)
57
- }
58
-
59
- private async streamToUint8Array(stream: ReadableStream): Promise<Uint8Array> {
60
- const reader = stream.getReader()
61
- const chunks: Uint8Array[] = []
62
- let totalLength = 0
63
- while (true) {
64
- const { done, value } = await reader.read()
65
- if (done) break
66
- chunks.push(value)
67
- totalLength += value.length
68
- }
69
- const result = new Uint8Array(totalLength)
70
- let offset = 0
71
- for (const chunk of chunks) {
72
- result.set(chunk, offset)
73
- offset += chunk.length
74
- }
75
- return result
76
- }
77
-
78
- async get(key: string): Promise<GetBucketResult | null> {
79
- try {
80
- const command = new GetObjectCommand({
81
- Bucket: this.bucketName,
82
- Key: key
83
- })
84
- const response = await this.client.send(command)
85
-
86
- if (!response.Body) return null
87
-
88
- const rawBody = response.Body as any
89
- const body: ReadableStream = typeof rawBody.transformToWebStream === 'function'
90
- ? rawBody.transformToWebStream()
91
- : rawBody as ReadableStream
92
-
93
- return {
94
- body,
95
- contentType: response.ContentType,
96
- size: response.ContentLength ?? 0,
97
- metadata: response.Metadata
98
- }
99
- } catch (err: any) {
100
- if (err.name === 'NoSuchKey' || err.name === 'NotFound' || err.message === 'NoSuchKey') {
101
- return null
102
- }
103
- // Rethrow other errors (AccessDenied, Timeout, etc.)
104
- throw err
105
- }
106
- }
107
-
108
- async delete(key: string): Promise<void> {
109
- const command = new DeleteObjectCommand({
110
- Bucket: this.bucketName,
111
- Key: key
112
- })
113
- await this.client.send(command)
114
- }
115
-
116
- async head(key: string): Promise<{ size: number; contentType?: string; metadata?: Record<string, string> } | null> {
117
- try {
118
- const command = new HeadObjectCommand({
119
- Bucket: this.bucketName,
120
- Key: key
121
- })
122
- const response = await this.client.send(command)
123
- return {
124
- size: response.ContentLength ?? 0,
125
- contentType: response.ContentType,
126
- metadata: response.Metadata
127
- }
128
- } catch (err: any) {
129
- if (err.name === 'NoSuchKey' || err.name === 'NotFound') return null
130
- throw err
131
- }
132
- }
133
-
134
- getUrl(key: string): string {
135
- if (this.cdnUrl) {
136
- return `${this.cdnUrl}/${encodeURIComponent(key)}`
137
- }
138
- return `${this.baseUrl}/api/media/${encodeURIComponent(key)}`
139
- }
140
-
141
- async getTotalSize(): Promise<number> {
142
- let total = 0
143
- let token: string | undefined
144
- do {
145
- const command = new ListObjectsV2Command({
146
- Bucket: this.bucketName,
147
- ContinuationToken: token
148
- })
149
- const response = await this.client.send(command)
150
- for (const obj of response.Contents ?? []) {
151
- total += obj.Size ?? 0
152
- }
153
- token = response.NextContinuationToken
154
- } while (token)
155
- return total
156
- }
157
-
158
- async presignPut(key: string, options: PresignOptions): Promise<string> {
159
- // ContentLength intentionally excluded: including it adds content-length to
160
- // X-Amz-SignedHeaders, requiring the uploading client to send an exact
161
- // Content-Length header. Some fetch implementations omit it, causing MinIO/R2
162
- // to reject the PUT with 400. Size validation already happened server-side.
163
- const command = new PutObjectCommand({
164
- Bucket: this.bucketName,
165
- Key: key,
166
- ContentType: options.contentType,
167
- })
168
- return getSignedUrl(this.client, command, { expiresIn: options.expiresIn })
169
- }
170
-
171
- async presignGet(key: string, options: PresignOptions): Promise<string> {
172
- const command = new GetObjectCommand({
173
- Bucket: this.bucketName,
174
- Key: key,
175
- })
176
- return getSignedUrl(this.client, command, { expiresIn: options.expiresIn })
177
- }
178
-
179
- async list(options?: { prefix?: string; limit?: number; cursor?: string }): Promise<{ objects: Array<{ key: string; size: number }>; cursor?: string }> {
180
- const command = new ListObjectsV2Command({
181
- Bucket: this.bucketName,
182
- Prefix: options?.prefix,
183
- MaxKeys: options?.limit,
184
- ContinuationToken: options?.cursor
185
- })
186
- const response = await this.client.send(command)
187
- return {
188
- objects: (response.Contents ?? []).map(obj => ({
189
- key: obj.Key ?? '',
190
- size: obj.Size ?? 0
191
- })),
192
- cursor: response.NextContinuationToken
193
- }
194
- }
195
- }
1
+ // SPDX-License-Identifier: BUSL-1.1
2
+ // Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
3
+ // See LICENSE in the repository root for license terms.
4
+
5
+ import { S3Client, PutObjectCommand, GetObjectCommand, DeleteObjectCommand, HeadObjectCommand, ListObjectsV2Command } from '@aws-sdk/client-s3'
6
+ import { getSignedUrl } from '@aws-sdk/s3-request-presigner'
7
+ import { BeechBucket, PutBucketOptions, GetBucketResult, PresignOptions } from '@beechcms/core'
8
+
9
+ /**
10
+ * Implementation of BeechBucket using S3-compatible API (AWS SDK).
11
+ * Used for production when connecting to R2 or any other S3 provider via HTTP.
12
+ */
13
+ export class S3Bucket implements BeechBucket {
14
+ private client: S3Client
15
+ private bucketName: string
16
+ private baseUrl: string
17
+
18
+ private cdnUrl: string | null
19
+
20
+ constructor(config: {
21
+ endpoint: string,
22
+ accessKeyId: string,
23
+ secretAccessKey: string,
24
+ bucketName: string,
25
+ baseUrl: string,
26
+ cdnUrl?: string,
27
+ }) {
28
+ // requestChecksumCalculation/responseChecksumValidation exist at runtime in AWS SDK v3
29
+ // but are not yet in the TypeScript types for this version. Casting via unknown to pass them
30
+ // through: without them the SDK adds x-amz-checksum-crc32 to presigned URLs, which causes
31
+ // R2 to reject PUT requests when the CRC32 of the uploaded file doesn't match.
32
+ this.client = new S3Client({
33
+ region: 'auto',
34
+ endpoint: config.endpoint,
35
+ credentials: {
36
+ accessKeyId: config.accessKeyId,
37
+ secretAccessKey: config.secretAccessKey,
38
+ },
39
+ forcePathStyle: true,
40
+ requestChecksumCalculation: 'when_required',
41
+ responseChecksumValidation: 'when_required',
42
+ } as unknown as import('@aws-sdk/client-s3').S3ClientConfig)
43
+ this.bucketName = config.bucketName
44
+ this.baseUrl = config.baseUrl
45
+ this.cdnUrl = config.cdnUrl ?? null
46
+ }
47
+
48
+ async put(key: string, body: ArrayBuffer | Uint8Array | ReadableStream, options?: PutBucketOptions): Promise<void> {
49
+ const command = new PutObjectCommand({
50
+ Bucket: this.bucketName,
51
+ Key: key,
52
+ Body: body instanceof ReadableStream ? await this.streamToUint8Array(body) : new Uint8Array(body as ArrayBuffer),
53
+ ContentType: options?.contentType,
54
+ Metadata: options?.metadata
55
+ })
56
+ await this.client.send(command)
57
+ }
58
+
59
+ private async streamToUint8Array(stream: ReadableStream): Promise<Uint8Array> {
60
+ const reader = stream.getReader()
61
+ const chunks: Uint8Array[] = []
62
+ let totalLength = 0
63
+ while (true) {
64
+ const { done, value } = await reader.read()
65
+ if (done) break
66
+ chunks.push(value)
67
+ totalLength += value.length
68
+ }
69
+ const result = new Uint8Array(totalLength)
70
+ let offset = 0
71
+ for (const chunk of chunks) {
72
+ result.set(chunk, offset)
73
+ offset += chunk.length
74
+ }
75
+ return result
76
+ }
77
+
78
+ async get(key: string): Promise<GetBucketResult | null> {
79
+ try {
80
+ const command = new GetObjectCommand({
81
+ Bucket: this.bucketName,
82
+ Key: key
83
+ })
84
+ const response = await this.client.send(command)
85
+
86
+ if (!response.Body) return null
87
+
88
+ const rawBody = response.Body as any
89
+ const body: ReadableStream = typeof rawBody.transformToWebStream === 'function'
90
+ ? rawBody.transformToWebStream()
91
+ : rawBody as ReadableStream
92
+
93
+ return {
94
+ body,
95
+ contentType: response.ContentType,
96
+ size: response.ContentLength ?? 0,
97
+ metadata: response.Metadata
98
+ }
99
+ } catch (err: any) {
100
+ if (err.name === 'NoSuchKey' || err.name === 'NotFound' || err.message === 'NoSuchKey') {
101
+ return null
102
+ }
103
+ // Rethrow other errors (AccessDenied, Timeout, etc.)
104
+ throw err
105
+ }
106
+ }
107
+
108
+ async delete(key: string): Promise<void> {
109
+ const command = new DeleteObjectCommand({
110
+ Bucket: this.bucketName,
111
+ Key: key
112
+ })
113
+ await this.client.send(command)
114
+ }
115
+
116
+ async head(key: string): Promise<{ size: number; contentType?: string; metadata?: Record<string, string> } | null> {
117
+ try {
118
+ const command = new HeadObjectCommand({
119
+ Bucket: this.bucketName,
120
+ Key: key
121
+ })
122
+ const response = await this.client.send(command)
123
+ return {
124
+ size: response.ContentLength ?? 0,
125
+ contentType: response.ContentType,
126
+ metadata: response.Metadata
127
+ }
128
+ } catch (err: any) {
129
+ if (err.name === 'NoSuchKey' || err.name === 'NotFound') return null
130
+ throw err
131
+ }
132
+ }
133
+
134
+ getUrl(key: string): string {
135
+ if (this.cdnUrl) {
136
+ return `${this.cdnUrl}/${encodeURIComponent(key)}`
137
+ }
138
+ return `${this.baseUrl}/api/media/${encodeURIComponent(key)}`
139
+ }
140
+
141
+ async getTotalSize(): Promise<number> {
142
+ let total = 0
143
+ let token: string | undefined
144
+ do {
145
+ const command = new ListObjectsV2Command({
146
+ Bucket: this.bucketName,
147
+ ContinuationToken: token
148
+ })
149
+ const response = await this.client.send(command)
150
+ for (const obj of response.Contents ?? []) {
151
+ total += obj.Size ?? 0
152
+ }
153
+ token = response.NextContinuationToken
154
+ } while (token)
155
+ return total
156
+ }
157
+
158
+ async presignPut(key: string, options: PresignOptions): Promise<string> {
159
+ // ContentLength intentionally excluded: including it adds content-length to
160
+ // X-Amz-SignedHeaders, requiring the uploading client to send an exact
161
+ // Content-Length header. Some fetch implementations omit it, causing MinIO/R2
162
+ // to reject the PUT with 400. Size validation already happened server-side.
163
+ const command = new PutObjectCommand({
164
+ Bucket: this.bucketName,
165
+ Key: key,
166
+ ContentType: options.contentType,
167
+ })
168
+ return getSignedUrl(this.client, command, { expiresIn: options.expiresIn })
169
+ }
170
+
171
+ async presignGet(key: string, options: PresignOptions): Promise<string> {
172
+ const command = new GetObjectCommand({
173
+ Bucket: this.bucketName,
174
+ Key: key,
175
+ })
176
+ return getSignedUrl(this.client, command, { expiresIn: options.expiresIn })
177
+ }
178
+
179
+ async list(options?: { prefix?: string; limit?: number; cursor?: string }): Promise<{ objects: Array<{ key: string; size: number }>; cursor?: string }> {
180
+ const command = new ListObjectsV2Command({
181
+ Bucket: this.bucketName,
182
+ Prefix: options?.prefix,
183
+ MaxKeys: options?.limit,
184
+ ContinuationToken: options?.cursor
185
+ })
186
+ const response = await this.client.send(command)
187
+ return {
188
+ objects: (response.Contents ?? []).map(obj => ({
189
+ key: obj.Key ?? '',
190
+ size: obj.Size ?? 0
191
+ })),
192
+ cursor: response.NextContinuationToken
193
+ }
194
+ }
195
+ }
@@ -1,40 +1,40 @@
1
- // SPDX-License-Identifier: BUSL-1.1
2
- // Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
3
- // See LICENSE in the repository root for license terms.
4
-
5
- import { S3Client, ListObjectsV2Command, ListObjectsV2CommandOutput } from '@aws-sdk/client-s3'
6
-
7
- /**
8
- * Calcola la dimensione totale occupata in un bucket R2 (in byte).
9
- * Nota: esegue una scansione completa del bucket. Per bucket molto grandi
10
- * andrebbe implementata una cache o usato Cloudflare Logpush/Analytics.
11
- */
12
- export async function getBucketSize(client: S3Client, bucketName: string): Promise<number> {
13
- let totalSize = 0
14
- let isTruncatedFlag = true
15
- let continuationToken: string | undefined = undefined
16
-
17
- try {
18
- while (isTruncatedFlag) {
19
- const command: ListObjectsV2Command = new ListObjectsV2Command({
20
- Bucket: bucketName,
21
- ContinuationToken: continuationToken,
22
- })
23
-
24
- const response: ListObjectsV2CommandOutput = await client.send(command)
25
-
26
- if (response.Contents) {
27
- for (const obj of response.Contents) {
28
- totalSize += obj.Size ?? 0
29
- }
30
- }
31
-
32
- isTruncatedFlag = response.IsTruncated ?? false
33
- continuationToken = response.NextContinuationToken
34
- }
35
- return totalSize
36
- } catch (err) {
37
- console.error('Error calculating bucket size:', err)
38
- throw new Error('Failed to calculate bucket size. Check your R2/S3 credentials and endpoint.')
39
- }
40
- }
1
+ // SPDX-License-Identifier: BUSL-1.1
2
+ // Copyright (c) 2024–2026 Flavio De Musso. All rights reserved.
3
+ // See LICENSE in the repository root for license terms.
4
+
5
+ import { S3Client, ListObjectsV2Command, ListObjectsV2CommandOutput } from '@aws-sdk/client-s3'
6
+
7
+ /**
8
+ * Calcola la dimensione totale occupata in un bucket R2 (in byte).
9
+ * Nota: esegue una scansione completa del bucket. Per bucket molto grandi
10
+ * andrebbe implementata una cache o usato Cloudflare Logpush/Analytics.
11
+ */
12
+ export async function getBucketSize(client: S3Client, bucketName: string): Promise<number> {
13
+ let totalSize = 0
14
+ let isTruncatedFlag = true
15
+ let continuationToken: string | undefined = undefined
16
+
17
+ try {
18
+ while (isTruncatedFlag) {
19
+ const command: ListObjectsV2Command = new ListObjectsV2Command({
20
+ Bucket: bucketName,
21
+ ContinuationToken: continuationToken,
22
+ })
23
+
24
+ const response: ListObjectsV2CommandOutput = await client.send(command)
25
+
26
+ if (response.Contents) {
27
+ for (const obj of response.Contents) {
28
+ totalSize += obj.Size ?? 0
29
+ }
30
+ }
31
+
32
+ isTruncatedFlag = response.IsTruncated ?? false
33
+ continuationToken = response.NextContinuationToken
34
+ }
35
+ return totalSize
36
+ } catch (err) {
37
+ console.error('Error calculating bucket size:', err)
38
+ throw new Error('Failed to calculate bucket size. Check your R2/S3 credentials and endpoint.')
39
+ }
40
+ }