@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,62 +1,62 @@
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 { describe, it, expect, vi } from 'vitest'
6
- import { BackgroundNotificationService } from './background-notification-service'
7
- import type { INotificationRepository, NotificationRecord } from '@beechcms/core'
8
-
9
- function makeRepository(opts: { createShouldThrow?: boolean } = {}): INotificationRepository {
10
- return {
11
- list: vi.fn().mockResolvedValue([]),
12
- stats: vi.fn().mockResolvedValue({ totalCount: 0, latestCreatedAt: 0, readCount: 0 }),
13
- create: opts.createShouldThrow
14
- ? vi.fn().mockRejectedValue(new Error('db down'))
15
- : vi.fn().mockResolvedValue('generated-id'),
16
- markRead: vi.fn(),
17
- markUnread: vi.fn(),
18
- markAllRead: vi.fn(),
19
- delete: vi.fn(),
20
- } as unknown as INotificationRepository & {
21
- create: ReturnType<typeof vi.fn>
22
- }
23
- }
24
-
25
- describe('BackgroundNotificationService', () => {
26
- it('delegates persistence to the repository with the provided fields', async () => {
27
- const repo = makeRepository()
28
- await new BackgroundNotificationService(repo).notify({
29
- title: 'Hello',
30
- message: 'World',
31
- type: 'success',
32
- })
33
- expect(repo.create).toHaveBeenCalledWith({
34
- title: 'Hello',
35
- message: 'World',
36
- type: 'success',
37
- })
38
- })
39
-
40
- it('defaults to type "info" when none is provided', async () => {
41
- const repo = makeRepository()
42
- await new BackgroundNotificationService(repo).notify({ title: 'T', message: 'M' })
43
- expect(repo.create).toHaveBeenCalledWith({ title: 'T', message: 'M', type: 'info' })
44
- })
45
-
46
- it('delegates to the background scheduler when provided', () => {
47
- const repo = makeRepository()
48
- const schedule = vi.fn()
49
- new BackgroundNotificationService(repo, schedule).notify({ title: 'T', message: 'M' })
50
- expect(schedule).toHaveBeenCalledTimes(1)
51
- expect(schedule.mock.calls[0][0]).toBeInstanceOf(Promise)
52
- })
53
-
54
- it('never throws to the caller when the repository write fails', async () => {
55
- const repo = makeRepository({ createShouldThrow: true })
56
- const consoleSpy = vi.spyOn(console, 'error').mockImplementation(() => {})
57
- const service = new BackgroundNotificationService(repo)
58
- await expect(service.notify({ title: 'T', message: 'M' })).resolves.toBeUndefined()
59
- expect(consoleSpy).toHaveBeenCalled()
60
- consoleSpy.mockRestore()
61
- })
62
- })
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 { describe, it, expect, vi } from 'vitest'
6
+ import { BackgroundNotificationService } from './background-notification-service'
7
+ import type { INotificationRepository, NotificationRecord } from '@beechcms/core'
8
+
9
+ function makeRepository(opts: { createShouldThrow?: boolean } = {}): INotificationRepository {
10
+ return {
11
+ list: vi.fn().mockResolvedValue([]),
12
+ stats: vi.fn().mockResolvedValue({ totalCount: 0, latestCreatedAt: 0, readCount: 0 }),
13
+ create: opts.createShouldThrow
14
+ ? vi.fn().mockRejectedValue(new Error('db down'))
15
+ : vi.fn().mockResolvedValue('generated-id'),
16
+ markRead: vi.fn(),
17
+ markUnread: vi.fn(),
18
+ markAllRead: vi.fn(),
19
+ delete: vi.fn(),
20
+ } as unknown as INotificationRepository & {
21
+ create: ReturnType<typeof vi.fn>
22
+ }
23
+ }
24
+
25
+ describe('BackgroundNotificationService', () => {
26
+ it('delegates persistence to the repository with the provided fields', async () => {
27
+ const repo = makeRepository()
28
+ await new BackgroundNotificationService(repo).notify({
29
+ title: 'Hello',
30
+ message: 'World',
31
+ type: 'success',
32
+ })
33
+ expect(repo.create).toHaveBeenCalledWith({
34
+ title: 'Hello',
35
+ message: 'World',
36
+ type: 'success',
37
+ })
38
+ })
39
+
40
+ it('defaults to type "info" when none is provided', async () => {
41
+ const repo = makeRepository()
42
+ await new BackgroundNotificationService(repo).notify({ title: 'T', message: 'M' })
43
+ expect(repo.create).toHaveBeenCalledWith({ title: 'T', message: 'M', type: 'info' })
44
+ })
45
+
46
+ it('delegates to the background scheduler when provided', () => {
47
+ const repo = makeRepository()
48
+ const schedule = vi.fn()
49
+ new BackgroundNotificationService(repo, schedule).notify({ title: 'T', message: 'M' })
50
+ expect(schedule).toHaveBeenCalledTimes(1)
51
+ expect(schedule.mock.calls[0][0]).toBeInstanceOf(Promise)
52
+ })
53
+
54
+ it('never throws to the caller when the repository write fails', async () => {
55
+ const repo = makeRepository({ createShouldThrow: true })
56
+ const consoleSpy = vi.spyOn(console, 'error').mockImplementation(() => {})
57
+ const service = new BackgroundNotificationService(repo)
58
+ await expect(service.notify({ title: 'T', message: 'M' })).resolves.toBeUndefined()
59
+ expect(consoleSpy).toHaveBeenCalled()
60
+ consoleSpy.mockRestore()
61
+ })
62
+ })
@@ -1,52 +1,52 @@
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 type {
6
- INotificationService,
7
- CreateNotificationInput,
8
- INotificationRepository,
9
- NotificationType,
10
- } from '@beechcms/core'
11
-
12
- const DEFAULT_NOTIFICATION_TYPE: NotificationType = 'info'
13
-
14
- type ScheduleBackgroundTask = (task: Promise<unknown>) => void
15
-
16
- /**
17
- * Production implementation of {@link INotificationService}.
18
- *
19
- * Delegates persistence to the injected {@link INotificationRepository}.
20
- * When `scheduleBackgroundTask` is provided (wired to
21
- * `c.executionCtx.waitUntil`), the repository write runs after the response
22
- * is flushed so the public-API request that triggered it is never delayed.
23
- */
24
- export class BackgroundNotificationService implements INotificationService {
25
- constructor(
26
- private readonly notificationRepository: INotificationRepository,
27
- private readonly scheduleBackgroundTask?: ScheduleBackgroundTask
28
- ) {}
29
-
30
- notify(input: CreateNotificationInput): Promise<void> | void {
31
- const persistPromise = this.runPersist(input)
32
-
33
- if (this.scheduleBackgroundTask) {
34
- this.scheduleBackgroundTask(persistPromise)
35
- return
36
- }
37
-
38
- return persistPromise
39
- }
40
-
41
- private async runPersist(input: CreateNotificationInput): Promise<void> {
42
- try {
43
- await this.notificationRepository.create({
44
- title: input.title,
45
- message: input.message,
46
- type: input.type ?? DEFAULT_NOTIFICATION_TYPE,
47
- })
48
- } catch (error) {
49
- console.error('BackgroundNotificationService: failed to create notification', error)
50
- }
51
- }
52
- }
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 type {
6
+ INotificationService,
7
+ CreateNotificationInput,
8
+ INotificationRepository,
9
+ NotificationType,
10
+ } from '@beechcms/core'
11
+
12
+ const DEFAULT_NOTIFICATION_TYPE: NotificationType = 'info'
13
+
14
+ type ScheduleBackgroundTask = (task: Promise<unknown>) => void
15
+
16
+ /**
17
+ * Production implementation of {@link INotificationService}.
18
+ *
19
+ * Delegates persistence to the injected {@link INotificationRepository}.
20
+ * When `scheduleBackgroundTask` is provided (wired to
21
+ * `c.executionCtx.waitUntil`), the repository write runs after the response
22
+ * is flushed so the public-API request that triggered it is never delayed.
23
+ */
24
+ export class BackgroundNotificationService implements INotificationService {
25
+ constructor(
26
+ private readonly notificationRepository: INotificationRepository,
27
+ private readonly scheduleBackgroundTask?: ScheduleBackgroundTask
28
+ ) {}
29
+
30
+ notify(input: CreateNotificationInput): Promise<void> | void {
31
+ const persistPromise = this.runPersist(input)
32
+
33
+ if (this.scheduleBackgroundTask) {
34
+ this.scheduleBackgroundTask(persistPromise)
35
+ return
36
+ }
37
+
38
+ return persistPromise
39
+ }
40
+
41
+ private async runPersist(input: CreateNotificationInput): Promise<void> {
42
+ try {
43
+ await this.notificationRepository.create({
44
+ title: input.title,
45
+ message: input.message,
46
+ type: input.type ?? DEFAULT_NOTIFICATION_TYPE,
47
+ })
48
+ } catch (error) {
49
+ console.error('BackgroundNotificationService: failed to create notification', error)
50
+ }
51
+ }
52
+ }
@@ -1,32 +1,32 @@
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
- /// <reference types="@cloudflare/workers-types" />
6
- import { RepositoryError } from '@beechcms/core'
7
-
8
- /**
9
- * Base class for D1-backed repositories.
10
- * Handles the D1 instance and provides common database utilities and error mapping.
11
- */
12
- export abstract class BaseD1Repository {
13
- constructor(protected readonly database: D1Database) {}
14
-
15
- /**
16
- * Utility method to extract a table name for a given seed.
17
- */
18
- protected getTableName(slug: string, isDraft = false): string {
19
- return isDraft ? `content_${slug}_drafts` : `content_${slug}`
20
- }
21
-
22
- /**
23
- * Helper to map generic D1 errors to Beech RepositoryErrors.
24
- * This centralizes error handling for all D1 repositories.
25
- */
26
- protected mapError(error: any, context: string): RepositoryError {
27
- const message = error?.message || 'Unknown database error'
28
- // In the future, we can add more specific SQLite error code checks here
29
- // (e.g., checking for UNIQUE constraint via string matching or codes if available)
30
- return new RepositoryError(`${context}: ${message}`, error)
31
- }
32
- }
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
+ /// <reference types="@cloudflare/workers-types" />
6
+ import { RepositoryError } from '@beechcms/core'
7
+
8
+ /**
9
+ * Base class for D1-backed repositories.
10
+ * Handles the D1 instance and provides common database utilities and error mapping.
11
+ */
12
+ export abstract class BaseD1Repository {
13
+ constructor(protected readonly database: D1Database) {}
14
+
15
+ /**
16
+ * Utility method to extract a table name for a given seed.
17
+ */
18
+ protected getTableName(slug: string, isDraft = false): string {
19
+ return isDraft ? `content_${slug}_drafts` : `content_${slug}`
20
+ }
21
+
22
+ /**
23
+ * Helper to map generic D1 errors to Beech RepositoryErrors.
24
+ * This centralizes error handling for all D1 repositories.
25
+ */
26
+ protected mapError(error: any, context: string): RepositoryError {
27
+ const message = error?.message || 'Unknown database error'
28
+ // In the future, we can add more specific SQLite error code checks here
29
+ // (e.g., checking for UNIQUE constraint via string matching or codes if available)
30
+ return new RepositoryError(`${context}: ${message}`, error)
31
+ }
32
+ }
@@ -1,165 +1,165 @@
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 { describe, it, expect, vi } from 'vitest'
6
- import { rowToApiData, rowToEntry, buildInsertBindings, buildUpdateBindings, hasDraft } from './content-utils'
7
- import type { Seed } from '@beechcms/core'
8
-
9
- const SEED = {
10
- slug: 'articoli',
11
- displayNameAlias: 'title',
12
- allowDrafts: true,
13
- branches: [
14
- { id: 'br_01', alias: 'title', type: 'text' },
15
- { id: 'br_02', alias: 'body', type: 'text' },
16
- ],
17
- } as unknown as Seed
18
-
19
- const NO_DRAFT_SEED = {
20
- slug: 'prodotti',
21
- displayNameAlias: 'nome',
22
- allowDrafts: false,
23
- branches: [
24
- { id: 'br_01', alias: 'nome', type: 'text' },
25
- ],
26
- } as unknown as Seed
27
-
28
- // ─── rowToApiData ─────────────────────────────────────────────────────────────
29
-
30
- describe('rowToApiData', () => {
31
- it('returns an object keyed by branch aliases with deserialized values', () => {
32
- const result = rowToApiData(SEED, { title: 'Hello', body: 'World' })
33
- expect(result).toHaveProperty('title', 'Hello')
34
- expect(result).toHaveProperty('body', 'World')
35
- })
36
-
37
- it('uses null for missing branch values', () => {
38
- const result = rowToApiData(SEED, {})
39
- expect(result.title).toBeNull()
40
- expect(result.body).toBeNull()
41
- })
42
-
43
- it('only includes keys for branches defined in the seed', () => {
44
- const result = rowToApiData(SEED, { title: 'Hi', unknownCol: 'ignored' })
45
- expect(Object.keys(result)).toEqual(['title', 'body'])
46
- expect(result).not.toHaveProperty('unknownCol')
47
- })
48
- })
49
-
50
- // ─── rowToEntry ───────────────────────────────────────────────────────────────
51
-
52
- describe('rowToEntry', () => {
53
- it('maps a DB row to a ContentEntry with correct system fields', () => {
54
- const row = {
55
- id: 'entry-1', slug: 'my-post', status: 'published',
56
- title: 'Hello', body: 'World', created_at: 1000, updated_at: 2000,
57
- }
58
- const entry = rowToEntry(SEED, row)
59
- expect(entry.id).toBe('entry-1')
60
- expect(entry.schema_slug).toBe('articoli')
61
- expect(entry.slug).toBe('my-post')
62
- expect(entry.status).toBe('published')
63
- expect(entry.created_at).toBe(1000)
64
- expect(entry.updated_at).toBe(2000)
65
- expect(entry.hasPendingDraft).toBe(false)
66
- })
67
-
68
- it('defaults hasPendingDraft to false when not provided', () => {
69
- const entry = rowToEntry(SEED, { id: 'e1', slug: null, status: 'draft', title: null, body: null, created_at: null, updated_at: null })
70
- expect(entry.hasPendingDraft).toBe(false)
71
- })
72
-
73
- it('passes through hasPendingDraft when explicitly set to true', () => {
74
- const entry = rowToEntry(SEED, { id: 'e1', slug: null, status: 'draft', title: null, body: null }, true)
75
- expect(entry.hasPendingDraft).toBe(true)
76
- })
77
-
78
- it('defaults slug to null and status to draft for missing values', () => {
79
- const entry = rowToEntry(SEED, { id: 'e1' })
80
- expect(entry.slug).toBeNull()
81
- expect(entry.status).toBe('draft')
82
- })
83
- })
84
-
85
- // ─── buildInsertBindings ──────────────────────────────────────────────────────
86
-
87
- describe('buildInsertBindings', () => {
88
- it('returns cols, placeholders, and bindings for each matching branch alias', () => {
89
- const { cols, placeholders, bindings } = buildInsertBindings(SEED, { title: 'Hi', body: 'There' })
90
- expect(cols).toContain('title')
91
- expect(cols).toContain('body')
92
- expect(placeholders).toHaveLength(2)
93
- expect(placeholders.every(p => p === '?')).toBe(true)
94
- expect(bindings).toHaveLength(2)
95
- })
96
-
97
- it('omits branches not present in the payload', () => {
98
- const { cols, bindings } = buildInsertBindings(SEED, { title: 'Only title' })
99
- expect(cols).toEqual(['title'])
100
- expect(bindings).toHaveLength(1)
101
- })
102
-
103
- it('returns empty arrays when payload has no matching aliases', () => {
104
- const { cols, placeholders, bindings } = buildInsertBindings(SEED, { unknownField: 'x' })
105
- expect(cols).toHaveLength(0)
106
- expect(placeholders).toHaveLength(0)
107
- expect(bindings).toHaveLength(0)
108
- })
109
- })
110
-
111
- // ─── buildUpdateBindings ──────────────────────────────────────────────────────
112
-
113
- describe('buildUpdateBindings', () => {
114
- it('returns a SET clause and bindings for each matching branch alias', () => {
115
- const { setClause, bindings } = buildUpdateBindings(SEED, { title: 'New', body: 'Content' })
116
- expect(setClause).toContain('title = ?')
117
- expect(setClause).toContain('body = ?')
118
- expect(bindings).toHaveLength(2)
119
- })
120
-
121
- it('builds a single-field SET clause', () => {
122
- const { setClause, bindings } = buildUpdateBindings(SEED, { title: 'Updated' })
123
- expect(setClause).toBe('title = ?')
124
- expect(bindings).toHaveLength(1)
125
- })
126
-
127
- it('returns empty setClause and bindings for non-matching payload', () => {
128
- const { setClause, bindings } = buildUpdateBindings(SEED, { ghost: 'field' })
129
- expect(setClause).toBe('')
130
- expect(bindings).toHaveLength(0)
131
- })
132
- })
133
-
134
- // ─── hasDraft ─────────────────────────────────────────────────────────────────
135
-
136
- describe('hasDraft', () => {
137
- function makeMockDb(firstResult: unknown) {
138
- const firstMock = vi.fn().mockResolvedValue(firstResult)
139
- const bindMock = vi.fn(() => ({ first: firstMock }))
140
- const prepareMock = vi.fn(() => ({ bind: bindMock }))
141
- return { db: { prepare: prepareMock } as any, prepareMock, bindMock }
142
- }
143
-
144
- it('returns false immediately when seed does not allow drafts', async () => {
145
- const { db, prepareMock } = makeMockDb(null)
146
- expect(await hasDraft(db, NO_DRAFT_SEED, 'e1')).toBe(false)
147
- expect(prepareMock).not.toHaveBeenCalled()
148
- })
149
-
150
- it('returns true when a draft row exists', async () => {
151
- const { db } = makeMockDb({ 1: 1 })
152
- expect(await hasDraft(db, SEED, 'entry-1')).toBe(true)
153
- })
154
-
155
- it('returns false when no draft row is found', async () => {
156
- const { db } = makeMockDb(null)
157
- expect(await hasDraft(db, SEED, 'entry-1')).toBe(false)
158
- })
159
-
160
- it('queries the correct drafts table for the seed slug', async () => {
161
- const { db, prepareMock } = makeMockDb(null)
162
- await hasDraft(db, SEED, 'entry-1')
163
- expect(prepareMock).toHaveBeenCalledWith(expect.stringContaining('content_articoli_drafts'))
164
- })
165
- })
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 { describe, it, expect, vi } from 'vitest'
6
+ import { rowToApiData, rowToEntry, buildInsertBindings, buildUpdateBindings, hasDraft } from './content-utils'
7
+ import type { Seed } from '@beechcms/core'
8
+
9
+ const SEED = {
10
+ slug: 'articoli',
11
+ displayNameAlias: 'title',
12
+ allowDrafts: true,
13
+ branches: [
14
+ { id: 'br_01', alias: 'title', type: 'text' },
15
+ { id: 'br_02', alias: 'body', type: 'text' },
16
+ ],
17
+ } as unknown as Seed
18
+
19
+ const NO_DRAFT_SEED = {
20
+ slug: 'prodotti',
21
+ displayNameAlias: 'nome',
22
+ allowDrafts: false,
23
+ branches: [
24
+ { id: 'br_01', alias: 'nome', type: 'text' },
25
+ ],
26
+ } as unknown as Seed
27
+
28
+ // ─── rowToApiData ─────────────────────────────────────────────────────────────
29
+
30
+ describe('rowToApiData', () => {
31
+ it('returns an object keyed by branch aliases with deserialized values', () => {
32
+ const result = rowToApiData(SEED, { title: 'Hello', body: 'World' })
33
+ expect(result).toHaveProperty('title', 'Hello')
34
+ expect(result).toHaveProperty('body', 'World')
35
+ })
36
+
37
+ it('uses null for missing branch values', () => {
38
+ const result = rowToApiData(SEED, {})
39
+ expect(result.title).toBeNull()
40
+ expect(result.body).toBeNull()
41
+ })
42
+
43
+ it('only includes keys for branches defined in the seed', () => {
44
+ const result = rowToApiData(SEED, { title: 'Hi', unknownCol: 'ignored' })
45
+ expect(Object.keys(result)).toEqual(['title', 'body'])
46
+ expect(result).not.toHaveProperty('unknownCol')
47
+ })
48
+ })
49
+
50
+ // ─── rowToEntry ───────────────────────────────────────────────────────────────
51
+
52
+ describe('rowToEntry', () => {
53
+ it('maps a DB row to a ContentEntry with correct system fields', () => {
54
+ const row = {
55
+ id: 'entry-1', slug: 'my-post', status: 'published',
56
+ title: 'Hello', body: 'World', created_at: 1000, updated_at: 2000,
57
+ }
58
+ const entry = rowToEntry(SEED, row)
59
+ expect(entry.id).toBe('entry-1')
60
+ expect(entry.schema_slug).toBe('articoli')
61
+ expect(entry.slug).toBe('my-post')
62
+ expect(entry.status).toBe('published')
63
+ expect(entry.created_at).toBe(1000)
64
+ expect(entry.updated_at).toBe(2000)
65
+ expect(entry.hasPendingDraft).toBe(false)
66
+ })
67
+
68
+ it('defaults hasPendingDraft to false when not provided', () => {
69
+ const entry = rowToEntry(SEED, { id: 'e1', slug: null, status: 'draft', title: null, body: null, created_at: null, updated_at: null })
70
+ expect(entry.hasPendingDraft).toBe(false)
71
+ })
72
+
73
+ it('passes through hasPendingDraft when explicitly set to true', () => {
74
+ const entry = rowToEntry(SEED, { id: 'e1', slug: null, status: 'draft', title: null, body: null }, true)
75
+ expect(entry.hasPendingDraft).toBe(true)
76
+ })
77
+
78
+ it('defaults slug to null and status to draft for missing values', () => {
79
+ const entry = rowToEntry(SEED, { id: 'e1' })
80
+ expect(entry.slug).toBeNull()
81
+ expect(entry.status).toBe('draft')
82
+ })
83
+ })
84
+
85
+ // ─── buildInsertBindings ──────────────────────────────────────────────────────
86
+
87
+ describe('buildInsertBindings', () => {
88
+ it('returns cols, placeholders, and bindings for each matching branch alias', () => {
89
+ const { cols, placeholders, bindings } = buildInsertBindings(SEED, { title: 'Hi', body: 'There' })
90
+ expect(cols).toContain('title')
91
+ expect(cols).toContain('body')
92
+ expect(placeholders).toHaveLength(2)
93
+ expect(placeholders.every(p => p === '?')).toBe(true)
94
+ expect(bindings).toHaveLength(2)
95
+ })
96
+
97
+ it('omits branches not present in the payload', () => {
98
+ const { cols, bindings } = buildInsertBindings(SEED, { title: 'Only title' })
99
+ expect(cols).toEqual(['title'])
100
+ expect(bindings).toHaveLength(1)
101
+ })
102
+
103
+ it('returns empty arrays when payload has no matching aliases', () => {
104
+ const { cols, placeholders, bindings } = buildInsertBindings(SEED, { unknownField: 'x' })
105
+ expect(cols).toHaveLength(0)
106
+ expect(placeholders).toHaveLength(0)
107
+ expect(bindings).toHaveLength(0)
108
+ })
109
+ })
110
+
111
+ // ─── buildUpdateBindings ──────────────────────────────────────────────────────
112
+
113
+ describe('buildUpdateBindings', () => {
114
+ it('returns a SET clause and bindings for each matching branch alias', () => {
115
+ const { setClause, bindings } = buildUpdateBindings(SEED, { title: 'New', body: 'Content' })
116
+ expect(setClause).toContain('title = ?')
117
+ expect(setClause).toContain('body = ?')
118
+ expect(bindings).toHaveLength(2)
119
+ })
120
+
121
+ it('builds a single-field SET clause', () => {
122
+ const { setClause, bindings } = buildUpdateBindings(SEED, { title: 'Updated' })
123
+ expect(setClause).toBe('title = ?')
124
+ expect(bindings).toHaveLength(1)
125
+ })
126
+
127
+ it('returns empty setClause and bindings for non-matching payload', () => {
128
+ const { setClause, bindings } = buildUpdateBindings(SEED, { ghost: 'field' })
129
+ expect(setClause).toBe('')
130
+ expect(bindings).toHaveLength(0)
131
+ })
132
+ })
133
+
134
+ // ─── hasDraft ─────────────────────────────────────────────────────────────────
135
+
136
+ describe('hasDraft', () => {
137
+ function makeMockDb(firstResult: unknown) {
138
+ const firstMock = vi.fn().mockResolvedValue(firstResult)
139
+ const bindMock = vi.fn(() => ({ first: firstMock }))
140
+ const prepareMock = vi.fn(() => ({ bind: bindMock }))
141
+ return { db: { prepare: prepareMock } as any, prepareMock, bindMock }
142
+ }
143
+
144
+ it('returns false immediately when seed does not allow drafts', async () => {
145
+ const { db, prepareMock } = makeMockDb(null)
146
+ expect(await hasDraft(db, NO_DRAFT_SEED, 'e1')).toBe(false)
147
+ expect(prepareMock).not.toHaveBeenCalled()
148
+ })
149
+
150
+ it('returns true when a draft row exists', async () => {
151
+ const { db } = makeMockDb({ 1: 1 })
152
+ expect(await hasDraft(db, SEED, 'entry-1')).toBe(true)
153
+ })
154
+
155
+ it('returns false when no draft row is found', async () => {
156
+ const { db } = makeMockDb(null)
157
+ expect(await hasDraft(db, SEED, 'entry-1')).toBe(false)
158
+ })
159
+
160
+ it('queries the correct drafts table for the seed slug', async () => {
161
+ const { db, prepareMock } = makeMockDb(null)
162
+ await hasDraft(db, SEED, 'entry-1')
163
+ expect(prepareMock).toHaveBeenCalledWith(expect.stringContaining('content_articoli_drafts'))
164
+ })
165
+ })