@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,359 +1,359 @@
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, beforeEach } from 'vitest'
6
- import { Hono } from 'hono'
7
- import type { BackrefMap } from '@beechcms/core'
8
- import { backrefsApp } from '../backrefs.handler'
9
-
10
- // ---------------------------------------------------------------------------
11
- // Seed fixtures
12
- // ---------------------------------------------------------------------------
13
-
14
- const teamSeed = {
15
- slug: 'team',
16
- label: 'Team Member',
17
- labelPlural: 'Team Members',
18
- displayNameAlias: 'name',
19
- branches: [
20
- { id: 'br_01', alias: 'name', label: 'Name', type: 'text' as const },
21
- ],
22
- allowPublicRead: false,
23
- }
24
-
25
- const articlesSeed = {
26
- slug: 'articles',
27
- label: 'Article',
28
- labelPlural: 'Articles',
29
- displayNameAlias: 'title',
30
- branches: [
31
- { id: 'br_01', alias: 'title', label: 'Title', type: 'text' as const },
32
- { id: 'br_02', alias: 'author_id', label: 'Author', type: 'relation' as const, targetSeed: 'team' },
33
- ],
34
- allowPublicRead: false,
35
- }
36
-
37
- const tagsSeed = {
38
- slug: 'tags',
39
- label: 'Tag',
40
- labelPlural: 'Tags',
41
- displayNameAlias: 'name',
42
- branches: [
43
- { id: 'br_01', alias: 'name', label: 'Name', type: 'text' as const },
44
- ],
45
- allowPublicRead: false,
46
- }
47
-
48
- const articleTagsSeed = {
49
- slug: 'articles',
50
- label: 'Article',
51
- labelPlural: 'Articles',
52
- displayNameAlias: 'title',
53
- branches: [
54
- { id: 'br_01', alias: 'title', label: 'Title', type: 'text' as const },
55
- { id: 'br_02', alias: 'tags', label: 'Tags', type: 'relation' as const, targetSeed: 'tags', multiple: true },
56
- ],
57
- allowPublicRead: false,
58
- }
59
-
60
- // ---------------------------------------------------------------------------
61
- // D1 mock helpers
62
- // ---------------------------------------------------------------------------
63
-
64
- function makeD1First<T>(result: T | null) {
65
- return vi.fn().mockResolvedValue(result)
66
- }
67
-
68
- function makeD1All<T>(results: T[]) {
69
- return vi.fn().mockResolvedValue({ results })
70
- }
71
-
72
- interface D1PrepareStub {
73
- firstResult?: unknown
74
- allResults?: unknown[]
75
- }
76
-
77
- function makeD1(stubs: D1PrepareStub[] = []) {
78
- let callCount = 0
79
- return {
80
- prepare: vi.fn().mockImplementation(() => {
81
- const stub = stubs[callCount++] ?? { firstResult: null, allResults: [] }
82
- return {
83
- bind: vi.fn().mockReturnThis(),
84
- first: makeD1First(stub.firstResult ?? null),
85
- all: makeD1All((stub.allResults ?? []) as unknown[]),
86
- }
87
- }),
88
- }
89
- }
90
-
91
- // ---------------------------------------------------------------------------
92
- // App builder
93
- // ---------------------------------------------------------------------------
94
-
95
- function buildApp({
96
- db,
97
- backrefMap,
98
- getSeed,
99
- }: {
100
- db: ReturnType<typeof makeD1>
101
- backrefMap: BackrefMap
102
- getSeed: (slug: string) => unknown
103
- }) {
104
- const app = new Hono()
105
- app.use('*', async (c, next) => {
106
- ;(c as any).env = { DB: db }
107
- ;(c as any).set('backrefMap', backrefMap)
108
- ;(c as any).set('getSeed', getSeed)
109
- await next()
110
- })
111
- app.route('/', backrefsApp)
112
- return app
113
- }
114
-
115
- // ---------------------------------------------------------------------------
116
- // Tests
117
- // ---------------------------------------------------------------------------
118
-
119
- describe('GET /:targetSlug/:targetId/backrefs', () => {
120
- describe('404 cases', () => {
121
- it('returns 404 when target slug is unknown', async () => {
122
- const db = makeD1()
123
- const app = buildApp({
124
- db,
125
- backrefMap: new Map(),
126
- getSeed: () => null,
127
- })
128
-
129
- const res = await app.request('/unknown-slug/id-1/backrefs')
130
- expect(res.status).toBe(404)
131
- const body = await res.json() as { type: string }
132
- expect(body.type).toContain('not-found')
133
- })
134
-
135
- it('returns 404 when target id does not exist in DB', async () => {
136
- const db = makeD1([{ firstResult: null }])
137
- const app = buildApp({
138
- db,
139
- backrefMap: new Map(),
140
- getSeed: (s) => s === 'team' ? teamSeed : null,
141
- })
142
-
143
- const res = await app.request('/team/nonexistent-id/backrefs')
144
- expect(res.status).toBe(404)
145
- })
146
- })
147
-
148
- describe('no inbound relations', () => {
149
- it('returns empty groups when backrefMap has no entry for target', async () => {
150
- const db = makeD1([{ firstResult: { id: 'ada-1' } }])
151
- const app = buildApp({
152
- db,
153
- backrefMap: new Map(),
154
- getSeed: (s) => s === 'team' ? teamSeed : null,
155
- })
156
-
157
- const res = await app.request('/team/ada-1/backrefs')
158
- expect(res.status).toBe(200)
159
- const body = await res.json() as { groups: unknown[] }
160
- expect(body.groups).toHaveLength(0)
161
- })
162
- })
163
-
164
- describe('single-value source with 5 referencing rows', () => {
165
- it('preview: returns 3 items, total=5, restricts=false', async () => {
166
- const backrefMap: BackrefMap = new Map([
167
- ['team', [{
168
- sourceSlug: 'articles',
169
- branchAlias: 'author_id',
170
- branchLabel: 'Author',
171
- relationship: 'single',
172
- restricts: false,
173
- }]],
174
- ])
175
-
176
- const previewItems = Array.from({ length: 3 }, (_, i) => ({
177
- id: `art-${i + 1}`,
178
- displayName: `Article ${i + 1}`,
179
- status: 'published',
180
- updated_at: 1000 + i,
181
- }))
182
-
183
- // prepare calls: 1) exists check, 2) rows query, 3) count query
184
- const db = makeD1([
185
- { firstResult: { id: 'ada-1' } }, // exists
186
- { allResults: previewItems }, // rows
187
- { firstResult: { total: 5 } }, // count
188
- ])
189
-
190
- const app = buildApp({
191
- db,
192
- backrefMap,
193
- getSeed: (s) => {
194
- if (s === 'team') return teamSeed
195
- if (s === 'articles') return articlesSeed
196
- return null
197
- },
198
- })
199
-
200
- const res = await app.request('/team/ada-1/backrefs')
201
- expect(res.status).toBe(200)
202
- const body = await res.json() as { groups: any[] }
203
- expect(body.groups).toHaveLength(1)
204
- const g = body.groups[0]
205
- expect(g.total).toBe(5)
206
- expect(g.items).toHaveLength(3)
207
- expect(g.restricts).toBe(false)
208
- expect(g.relationship).toBe('single')
209
- })
210
- })
211
-
212
- describe('multi-relation source with 12 referencing rows', () => {
213
- it('preview: returns 3 items, total=12', async () => {
214
- const backrefMap: BackrefMap = new Map([
215
- ['tags', [{
216
- sourceSlug: 'articles',
217
- branchAlias: 'tags',
218
- branchLabel: 'Tags',
219
- relationship: 'multi',
220
- restricts: false,
221
- }]],
222
- ])
223
-
224
- const previewItems = Array.from({ length: 3 }, (_, i) => ({
225
- id: `art-${i}`,
226
- displayName: `Article ${i}`,
227
- status: 'published',
228
- updated_at: 1000,
229
- }))
230
-
231
- const db = makeD1([
232
- { firstResult: { id: 'tag-1' } }, // exists
233
- { allResults: previewItems }, // rows
234
- { firstResult: { total: 12 } }, // count
235
- ])
236
-
237
- const app = buildApp({
238
- db,
239
- backrefMap,
240
- getSeed: (s) => {
241
- if (s === 'tags') return tagsSeed
242
- if (s === 'articles') return articleTagsSeed
243
- return null
244
- },
245
- })
246
-
247
- const res = await app.request('/tags/tag-1/backrefs')
248
- expect(res.status).toBe(200)
249
- const body = await res.json() as { groups: any[] }
250
- const g = body.groups[0]
251
- expect(g.total).toBe(12)
252
- expect(g.items).toHaveLength(3)
253
- expect(g.relationship).toBe('multi')
254
- })
255
- })
256
-
257
- describe('paginated ?group= request', () => {
258
- it('page=2&limit=4 returns correct offset (rows 5–8)', async () => {
259
- const backrefMap: BackrefMap = new Map([
260
- ['team', [{
261
- sourceSlug: 'articles',
262
- branchAlias: 'author_id',
263
- branchLabel: 'Author',
264
- relationship: 'single',
265
- restricts: false,
266
- }]],
267
- ])
268
-
269
- const page2Items = Array.from({ length: 4 }, (_, i) => ({
270
- id: `art-${i + 5}`,
271
- displayName: `Article ${i + 5}`,
272
- status: 'published',
273
- updated_at: 1000,
274
- }))
275
-
276
- const db = makeD1([
277
- { firstResult: { id: 'ada-1' } }, // exists
278
- { allResults: page2Items }, // rows (page 2, limit 4 → offset 4)
279
- { firstResult: { total: 12 } }, // count
280
- ])
281
-
282
- const app = buildApp({
283
- db,
284
- backrefMap,
285
- getSeed: (s) => {
286
- if (s === 'team') return teamSeed
287
- if (s === 'articles') return articlesSeed
288
- return null
289
- },
290
- })
291
-
292
- const res = await app.request('/team/ada-1/backrefs?group=articles:author_id&page=2&limit=4')
293
- expect(res.status).toBe(200)
294
- const body = await res.json() as { groups: any[] }
295
- expect(body.groups).toHaveLength(1)
296
- const g = body.groups[0]
297
- expect(g.items).toHaveLength(4)
298
- expect(g.items[0].id).toBe('art-5')
299
- })
300
-
301
- it('returns 404 for unknown group key', async () => {
302
- const backrefMap: BackrefMap = new Map([
303
- ['team', [{
304
- sourceSlug: 'articles',
305
- branchAlias: 'author_id',
306
- branchLabel: 'Author',
307
- relationship: 'single',
308
- restricts: false,
309
- }]],
310
- ])
311
-
312
- const db = makeD1([{ firstResult: { id: 'ada-1' } }])
313
-
314
- const app = buildApp({
315
- db,
316
- backrefMap,
317
- getSeed: (s) => s === 'team' ? teamSeed : null,
318
- })
319
-
320
- const res = await app.request('/team/ada-1/backrefs?group=articles:unknown_field')
321
- expect(res.status).toBe(404)
322
- })
323
- })
324
-
325
- describe('restricts flag', () => {
326
- it('exposes restricts=true when branch has onDelete RESTRICT', async () => {
327
- const backrefMap: BackrefMap = new Map([
328
- ['team', [{
329
- sourceSlug: 'articles',
330
- branchAlias: 'author_id',
331
- branchLabel: 'Author',
332
- relationship: 'single',
333
- restricts: true,
334
- }]],
335
- ])
336
-
337
- const db = makeD1([
338
- { firstResult: { id: 'ada-1' } },
339
- { allResults: [{ id: 'art-1', displayName: 'Art', status: 'published', updated_at: 1000 }] },
340
- { firstResult: { total: 1 } },
341
- ])
342
-
343
- const app = buildApp({
344
- db,
345
- backrefMap,
346
- getSeed: (s) => {
347
- if (s === 'team') return teamSeed
348
- if (s === 'articles') return articlesSeed
349
- return null
350
- },
351
- })
352
-
353
- const res = await app.request('/team/ada-1/backrefs')
354
- expect(res.status).toBe(200)
355
- const body = await res.json() as { groups: any[] }
356
- expect(body.groups[0].restricts).toBe(true)
357
- })
358
- })
359
- })
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, beforeEach } from 'vitest'
6
+ import { Hono } from 'hono'
7
+ import type { BackrefMap } from '@beechcms/core'
8
+ import { backrefsApp } from '../backrefs.handler'
9
+
10
+ // ---------------------------------------------------------------------------
11
+ // Seed fixtures
12
+ // ---------------------------------------------------------------------------
13
+
14
+ const teamSeed = {
15
+ slug: 'team',
16
+ label: 'Team Member',
17
+ labelPlural: 'Team Members',
18
+ displayNameAlias: 'name',
19
+ branches: [
20
+ { id: 'br_01', alias: 'name', label: 'Name', type: 'text' as const },
21
+ ],
22
+ allowPublicRead: false,
23
+ }
24
+
25
+ const articlesSeed = {
26
+ slug: 'articles',
27
+ label: 'Article',
28
+ labelPlural: 'Articles',
29
+ displayNameAlias: 'title',
30
+ branches: [
31
+ { id: 'br_01', alias: 'title', label: 'Title', type: 'text' as const },
32
+ { id: 'br_02', alias: 'author_id', label: 'Author', type: 'relation' as const, targetSeed: 'team' },
33
+ ],
34
+ allowPublicRead: false,
35
+ }
36
+
37
+ const tagsSeed = {
38
+ slug: 'tags',
39
+ label: 'Tag',
40
+ labelPlural: 'Tags',
41
+ displayNameAlias: 'name',
42
+ branches: [
43
+ { id: 'br_01', alias: 'name', label: 'Name', type: 'text' as const },
44
+ ],
45
+ allowPublicRead: false,
46
+ }
47
+
48
+ const articleTagsSeed = {
49
+ slug: 'articles',
50
+ label: 'Article',
51
+ labelPlural: 'Articles',
52
+ displayNameAlias: 'title',
53
+ branches: [
54
+ { id: 'br_01', alias: 'title', label: 'Title', type: 'text' as const },
55
+ { id: 'br_02', alias: 'tags', label: 'Tags', type: 'relation' as const, targetSeed: 'tags', multiple: true },
56
+ ],
57
+ allowPublicRead: false,
58
+ }
59
+
60
+ // ---------------------------------------------------------------------------
61
+ // D1 mock helpers
62
+ // ---------------------------------------------------------------------------
63
+
64
+ function makeD1First<T>(result: T | null) {
65
+ return vi.fn().mockResolvedValue(result)
66
+ }
67
+
68
+ function makeD1All<T>(results: T[]) {
69
+ return vi.fn().mockResolvedValue({ results })
70
+ }
71
+
72
+ interface D1PrepareStub {
73
+ firstResult?: unknown
74
+ allResults?: unknown[]
75
+ }
76
+
77
+ function makeD1(stubs: D1PrepareStub[] = []) {
78
+ let callCount = 0
79
+ return {
80
+ prepare: vi.fn().mockImplementation(() => {
81
+ const stub = stubs[callCount++] ?? { firstResult: null, allResults: [] }
82
+ return {
83
+ bind: vi.fn().mockReturnThis(),
84
+ first: makeD1First(stub.firstResult ?? null),
85
+ all: makeD1All((stub.allResults ?? []) as unknown[]),
86
+ }
87
+ }),
88
+ }
89
+ }
90
+
91
+ // ---------------------------------------------------------------------------
92
+ // App builder
93
+ // ---------------------------------------------------------------------------
94
+
95
+ function buildApp({
96
+ db,
97
+ backrefMap,
98
+ getSeed,
99
+ }: {
100
+ db: ReturnType<typeof makeD1>
101
+ backrefMap: BackrefMap
102
+ getSeed: (slug: string) => unknown
103
+ }) {
104
+ const app = new Hono()
105
+ app.use('*', async (c, next) => {
106
+ ;(c as any).env = { DB: db }
107
+ ;(c as any).set('backrefMap', backrefMap)
108
+ ;(c as any).set('getSeed', getSeed)
109
+ await next()
110
+ })
111
+ app.route('/', backrefsApp)
112
+ return app
113
+ }
114
+
115
+ // ---------------------------------------------------------------------------
116
+ // Tests
117
+ // ---------------------------------------------------------------------------
118
+
119
+ describe('GET /:targetSlug/:targetId/backrefs', () => {
120
+ describe('404 cases', () => {
121
+ it('returns 404 when target slug is unknown', async () => {
122
+ const db = makeD1()
123
+ const app = buildApp({
124
+ db,
125
+ backrefMap: new Map(),
126
+ getSeed: () => null,
127
+ })
128
+
129
+ const res = await app.request('/unknown-slug/id-1/backrefs')
130
+ expect(res.status).toBe(404)
131
+ const body = await res.json() as { type: string }
132
+ expect(body.type).toContain('not-found')
133
+ })
134
+
135
+ it('returns 404 when target id does not exist in DB', async () => {
136
+ const db = makeD1([{ firstResult: null }])
137
+ const app = buildApp({
138
+ db,
139
+ backrefMap: new Map(),
140
+ getSeed: (s) => s === 'team' ? teamSeed : null,
141
+ })
142
+
143
+ const res = await app.request('/team/nonexistent-id/backrefs')
144
+ expect(res.status).toBe(404)
145
+ })
146
+ })
147
+
148
+ describe('no inbound relations', () => {
149
+ it('returns empty groups when backrefMap has no entry for target', async () => {
150
+ const db = makeD1([{ firstResult: { id: 'ada-1' } }])
151
+ const app = buildApp({
152
+ db,
153
+ backrefMap: new Map(),
154
+ getSeed: (s) => s === 'team' ? teamSeed : null,
155
+ })
156
+
157
+ const res = await app.request('/team/ada-1/backrefs')
158
+ expect(res.status).toBe(200)
159
+ const body = await res.json() as { groups: unknown[] }
160
+ expect(body.groups).toHaveLength(0)
161
+ })
162
+ })
163
+
164
+ describe('single-value source with 5 referencing rows', () => {
165
+ it('preview: returns 3 items, total=5, restricts=false', async () => {
166
+ const backrefMap: BackrefMap = new Map([
167
+ ['team', [{
168
+ sourceSlug: 'articles',
169
+ branchAlias: 'author_id',
170
+ branchLabel: 'Author',
171
+ relationship: 'single',
172
+ restricts: false,
173
+ }]],
174
+ ])
175
+
176
+ const previewItems = Array.from({ length: 3 }, (_, i) => ({
177
+ id: `art-${i + 1}`,
178
+ displayName: `Article ${i + 1}`,
179
+ status: 'published',
180
+ updated_at: 1000 + i,
181
+ }))
182
+
183
+ // prepare calls: 1) exists check, 2) rows query, 3) count query
184
+ const db = makeD1([
185
+ { firstResult: { id: 'ada-1' } }, // exists
186
+ { allResults: previewItems }, // rows
187
+ { firstResult: { total: 5 } }, // count
188
+ ])
189
+
190
+ const app = buildApp({
191
+ db,
192
+ backrefMap,
193
+ getSeed: (s) => {
194
+ if (s === 'team') return teamSeed
195
+ if (s === 'articles') return articlesSeed
196
+ return null
197
+ },
198
+ })
199
+
200
+ const res = await app.request('/team/ada-1/backrefs')
201
+ expect(res.status).toBe(200)
202
+ const body = await res.json() as { groups: any[] }
203
+ expect(body.groups).toHaveLength(1)
204
+ const g = body.groups[0]
205
+ expect(g.total).toBe(5)
206
+ expect(g.items).toHaveLength(3)
207
+ expect(g.restricts).toBe(false)
208
+ expect(g.relationship).toBe('single')
209
+ })
210
+ })
211
+
212
+ describe('multi-relation source with 12 referencing rows', () => {
213
+ it('preview: returns 3 items, total=12', async () => {
214
+ const backrefMap: BackrefMap = new Map([
215
+ ['tags', [{
216
+ sourceSlug: 'articles',
217
+ branchAlias: 'tags',
218
+ branchLabel: 'Tags',
219
+ relationship: 'multi',
220
+ restricts: false,
221
+ }]],
222
+ ])
223
+
224
+ const previewItems = Array.from({ length: 3 }, (_, i) => ({
225
+ id: `art-${i}`,
226
+ displayName: `Article ${i}`,
227
+ status: 'published',
228
+ updated_at: 1000,
229
+ }))
230
+
231
+ const db = makeD1([
232
+ { firstResult: { id: 'tag-1' } }, // exists
233
+ { allResults: previewItems }, // rows
234
+ { firstResult: { total: 12 } }, // count
235
+ ])
236
+
237
+ const app = buildApp({
238
+ db,
239
+ backrefMap,
240
+ getSeed: (s) => {
241
+ if (s === 'tags') return tagsSeed
242
+ if (s === 'articles') return articleTagsSeed
243
+ return null
244
+ },
245
+ })
246
+
247
+ const res = await app.request('/tags/tag-1/backrefs')
248
+ expect(res.status).toBe(200)
249
+ const body = await res.json() as { groups: any[] }
250
+ const g = body.groups[0]
251
+ expect(g.total).toBe(12)
252
+ expect(g.items).toHaveLength(3)
253
+ expect(g.relationship).toBe('multi')
254
+ })
255
+ })
256
+
257
+ describe('paginated ?group= request', () => {
258
+ it('page=2&limit=4 returns correct offset (rows 5–8)', async () => {
259
+ const backrefMap: BackrefMap = new Map([
260
+ ['team', [{
261
+ sourceSlug: 'articles',
262
+ branchAlias: 'author_id',
263
+ branchLabel: 'Author',
264
+ relationship: 'single',
265
+ restricts: false,
266
+ }]],
267
+ ])
268
+
269
+ const page2Items = Array.from({ length: 4 }, (_, i) => ({
270
+ id: `art-${i + 5}`,
271
+ displayName: `Article ${i + 5}`,
272
+ status: 'published',
273
+ updated_at: 1000,
274
+ }))
275
+
276
+ const db = makeD1([
277
+ { firstResult: { id: 'ada-1' } }, // exists
278
+ { allResults: page2Items }, // rows (page 2, limit 4 → offset 4)
279
+ { firstResult: { total: 12 } }, // count
280
+ ])
281
+
282
+ const app = buildApp({
283
+ db,
284
+ backrefMap,
285
+ getSeed: (s) => {
286
+ if (s === 'team') return teamSeed
287
+ if (s === 'articles') return articlesSeed
288
+ return null
289
+ },
290
+ })
291
+
292
+ const res = await app.request('/team/ada-1/backrefs?group=articles:author_id&page=2&limit=4')
293
+ expect(res.status).toBe(200)
294
+ const body = await res.json() as { groups: any[] }
295
+ expect(body.groups).toHaveLength(1)
296
+ const g = body.groups[0]
297
+ expect(g.items).toHaveLength(4)
298
+ expect(g.items[0].id).toBe('art-5')
299
+ })
300
+
301
+ it('returns 404 for unknown group key', async () => {
302
+ const backrefMap: BackrefMap = new Map([
303
+ ['team', [{
304
+ sourceSlug: 'articles',
305
+ branchAlias: 'author_id',
306
+ branchLabel: 'Author',
307
+ relationship: 'single',
308
+ restricts: false,
309
+ }]],
310
+ ])
311
+
312
+ const db = makeD1([{ firstResult: { id: 'ada-1' } }])
313
+
314
+ const app = buildApp({
315
+ db,
316
+ backrefMap,
317
+ getSeed: (s) => s === 'team' ? teamSeed : null,
318
+ })
319
+
320
+ const res = await app.request('/team/ada-1/backrefs?group=articles:unknown_field')
321
+ expect(res.status).toBe(404)
322
+ })
323
+ })
324
+
325
+ describe('restricts flag', () => {
326
+ it('exposes restricts=true when branch has onDelete RESTRICT', async () => {
327
+ const backrefMap: BackrefMap = new Map([
328
+ ['team', [{
329
+ sourceSlug: 'articles',
330
+ branchAlias: 'author_id',
331
+ branchLabel: 'Author',
332
+ relationship: 'single',
333
+ restricts: true,
334
+ }]],
335
+ ])
336
+
337
+ const db = makeD1([
338
+ { firstResult: { id: 'ada-1' } },
339
+ { allResults: [{ id: 'art-1', displayName: 'Art', status: 'published', updated_at: 1000 }] },
340
+ { firstResult: { total: 1 } },
341
+ ])
342
+
343
+ const app = buildApp({
344
+ db,
345
+ backrefMap,
346
+ getSeed: (s) => {
347
+ if (s === 'team') return teamSeed
348
+ if (s === 'articles') return articlesSeed
349
+ return null
350
+ },
351
+ })
352
+
353
+ const res = await app.request('/team/ada-1/backrefs')
354
+ expect(res.status).toBe(200)
355
+ const body = await res.json() as { groups: any[] }
356
+ expect(body.groups[0].restricts).toBe(true)
357
+ })
358
+ })
359
+ })