@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,88 +1,88 @@
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 { Hono } from 'hono'
6
- import type { AppEnv } from '../types'
7
- import { publicReadHandler } from './public-read'
8
- import { publicAddHandler } from './public-add'
9
- import { publicEditHandler } from './public-edit'
10
-
11
- const publicApp = new Hono<AppEnv>()
12
-
13
- publicApp.get('/health', (c) => {
14
- return c.json({ ok: true, service: 'public-api' }, 200)
15
- })
16
-
17
- /** Returns the public-facing schema: only seeds with public read or post enabled. */
18
- publicApp.get('/schema', (c) => {
19
- const registry = c.get('seedRegistry')
20
- const publicSeeds = registry.all()
21
- .filter(seed => seed.allowPublicRead === true || seed.allowPublicPost === true || seed.allowPublicEdit === true)
22
- .map(seed => ({
23
- slug: seed.slug,
24
- label: seed.label,
25
- labelPlural: seed.labelPlural,
26
- allowPublicRead: seed.allowPublicRead ?? false,
27
- allowPublicPost: seed.allowPublicPost ?? false,
28
- allowPublicEdit: seed.allowPublicEdit ?? false,
29
- branches: (seed.branches ?? []).map(branch => ({
30
- alias: branch.alias,
31
- type: branch.type,
32
- label: branch.label,
33
- requiredOnCreate: branch.requiredOnCreate ?? false,
34
- policies: {
35
- public: branch.policies?.public ?? true,
36
- visibility: branch.policies?.visibility ?? 'full',
37
- },
38
- })),
39
- }))
40
- return c.json({ seeds: publicSeeds })
41
- })
42
-
43
- /** HTML render of the public schema for quick browser inspection. */
44
- publicApp.get('/schema.html', (c) => {
45
- const registry = c.get('seedRegistry')
46
- const publicSeeds = registry.all()
47
- .filter(seed => seed.allowPublicRead === true || seed.allowPublicPost === true || seed.allowPublicEdit === true)
48
-
49
- const seedHtml = publicSeeds.map(seed => {
50
- const ops = [
51
- seed.allowPublicRead && 'GET /:seed',
52
- seed.allowPublicPost && 'POST /:seed/add',
53
- seed.allowPublicEdit && 'PUT /:seed/edit/:id',
54
- ].filter(Boolean).join(', ')
55
-
56
- const branchRows = (seed.branches ?? []).map(b =>
57
- `<tr><td>${b.alias}</td><td>${b.type}</td><td>${b.label}</td><td>${b.requiredOnCreate ? 'yes' : ''}</td><td>${(b.policies?.public ?? true) ? 'readable' : 'hidden'}</td></tr>`
58
- ).join('')
59
-
60
- return `<section>
61
- <h2>${seed.label} <code>${seed.slug}</code></h2>
62
- <p><strong>Allowed operations:</strong> ${ops || 'none'}</p>
63
- <table><thead><tr><th>alias</th><th>type</th><th>label</th><th>required</th><th>public access</th></tr></thead>
64
- <tbody>${branchRows}</tbody></table>
65
- </section>`
66
- }).join('\n')
67
-
68
- const html = `<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8">
69
- <title>BeechCMS Public Schema</title>
70
- <style>body{font-family:system-ui,sans-serif;max-width:900px;margin:2rem auto;padding:0 1rem;color:#222}
71
- code{background:#f3f4f6;padding:2px 6px;border-radius:4px}
72
- table{border-collapse:collapse;width:100%}th,td{text-align:left;padding:6px 10px;border:1px solid #e5e7eb}
73
- th{background:#f9fafb}h2{margin-top:2rem}section{margin-bottom:2rem}</style>
74
- </head><body>
75
- <h1>BeechCMS — Public API Schema</h1>
76
- <p>Only content types with public access enabled are listed here.</p>
77
- ${seedHtml || '<p><em>No content types with public access configured.</em></p>'}
78
- </body></html>`
79
-
80
- return c.html(html)
81
- })
82
-
83
- publicApp.get('/:seed', publicReadHandler)
84
- publicApp.post('/:seed/add', publicAddHandler)
85
- publicApp.put('/:seed/edit/:id', publicEditHandler)
86
-
87
- export const publicRoutes = publicApp
88
-
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 { Hono } from 'hono'
6
+ import type { AppEnv } from '../types'
7
+ import { publicReadHandler } from './public-read'
8
+ import { publicAddHandler } from './public-add'
9
+ import { publicEditHandler } from './public-edit'
10
+
11
+ const publicApp = new Hono<AppEnv>()
12
+
13
+ publicApp.get('/health', (c) => {
14
+ return c.json({ ok: true, service: 'public-api' }, 200)
15
+ })
16
+
17
+ /** Returns the public-facing schema: only seeds with public read or post enabled. */
18
+ publicApp.get('/schema', (c) => {
19
+ const registry = c.get('seedRegistry')
20
+ const publicSeeds = registry.all()
21
+ .filter(seed => seed.allowPublicRead === true || seed.allowPublicPost === true || seed.allowPublicEdit === true)
22
+ .map(seed => ({
23
+ slug: seed.slug,
24
+ label: seed.label,
25
+ labelPlural: seed.labelPlural,
26
+ allowPublicRead: seed.allowPublicRead ?? false,
27
+ allowPublicPost: seed.allowPublicPost ?? false,
28
+ allowPublicEdit: seed.allowPublicEdit ?? false,
29
+ branches: (seed.branches ?? []).map(branch => ({
30
+ alias: branch.alias,
31
+ type: branch.type,
32
+ label: branch.label,
33
+ requiredOnCreate: branch.requiredOnCreate ?? false,
34
+ policies: {
35
+ public: branch.policies?.public ?? true,
36
+ visibility: branch.policies?.visibility ?? 'full',
37
+ },
38
+ })),
39
+ }))
40
+ return c.json({ seeds: publicSeeds })
41
+ })
42
+
43
+ /** HTML render of the public schema for quick browser inspection. */
44
+ publicApp.get('/schema.html', (c) => {
45
+ const registry = c.get('seedRegistry')
46
+ const publicSeeds = registry.all()
47
+ .filter(seed => seed.allowPublicRead === true || seed.allowPublicPost === true || seed.allowPublicEdit === true)
48
+
49
+ const seedHtml = publicSeeds.map(seed => {
50
+ const ops = [
51
+ seed.allowPublicRead && 'GET /:seed',
52
+ seed.allowPublicPost && 'POST /:seed/add',
53
+ seed.allowPublicEdit && 'PUT /:seed/edit/:id',
54
+ ].filter(Boolean).join(', ')
55
+
56
+ const branchRows = (seed.branches ?? []).map(b =>
57
+ `<tr><td>${b.alias}</td><td>${b.type}</td><td>${b.label}</td><td>${b.requiredOnCreate ? 'yes' : ''}</td><td>${(b.policies?.public ?? true) ? 'readable' : 'hidden'}</td></tr>`
58
+ ).join('')
59
+
60
+ return `<section>
61
+ <h2>${seed.label} <code>${seed.slug}</code></h2>
62
+ <p><strong>Allowed operations:</strong> ${ops || 'none'}</p>
63
+ <table><thead><tr><th>alias</th><th>type</th><th>label</th><th>required</th><th>public access</th></tr></thead>
64
+ <tbody>${branchRows}</tbody></table>
65
+ </section>`
66
+ }).join('\n')
67
+
68
+ const html = `<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8">
69
+ <title>BeechCMS Public Schema</title>
70
+ <style>body{font-family:system-ui,sans-serif;max-width:900px;margin:2rem auto;padding:0 1rem;color:#222}
71
+ code{background:#f3f4f6;padding:2px 6px;border-radius:4px}
72
+ table{border-collapse:collapse;width:100%}th,td{text-align:left;padding:6px 10px;border:1px solid #e5e7eb}
73
+ th{background:#f9fafb}h2{margin-top:2rem}section{margin-bottom:2rem}</style>
74
+ </head><body>
75
+ <h1>BeechCMS — Public API Schema</h1>
76
+ <p>Only content types with public access enabled are listed here.</p>
77
+ ${seedHtml || '<p><em>No content types with public access configured.</em></p>'}
78
+ </body></html>`
79
+
80
+ return c.html(html)
81
+ })
82
+
83
+ publicApp.get('/:seed', publicReadHandler)
84
+ publicApp.post('/:seed/add', publicAddHandler)
85
+ publicApp.put('/:seed/edit/:id', publicEditHandler)
86
+
87
+ export const publicRoutes = publicApp
88
+
@@ -1,224 +1,224 @@
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 } from 'vitest'
6
- import {
7
- parsePublicFilter,
8
- toEngineFilters,
9
- parsePublicPagination,
10
- parseLatestCount,
11
- } from './query-builder'
12
- import type { Seed } from '@beechcms/core'
13
-
14
- const SEED = {
15
- slug: 'posts',
16
- displayNameAlias: 'title',
17
- branches: [
18
- { id: 'br_01', alias: 'title', type: 'text' },
19
- { id: 'br_02', alias: 'count', type: 'number' },
20
- { id: 'br_03', alias: 'active', type: 'boolean' },
21
- { id: 'br_04', alias: 'published_at', type: 'date' },
22
- { id: 'br_05', alias: 'tags', type: 'tags' },
23
- { id: 'br_06', alias: 'body', type: 'richtext' },
24
- { id: 'br_07', alias: 'attachment', type: 'file' },
25
- { id: 'br_08', alias: 'meta', type: 'json' },
26
- ],
27
- } as unknown as Seed
28
-
29
- // ─── parsePublicFilter ────────────────────────────────────────────────────────
30
-
31
- describe('parsePublicFilter', () => {
32
- it('returns null for undefined input', () => {
33
- expect(parsePublicFilter(undefined)).toBeNull()
34
- })
35
-
36
- it('returns null for empty string', () => {
37
- expect(parsePublicFilter('')).toBeNull()
38
- })
39
-
40
- it('parses a valid filter with explicit AND logic', () => {
41
- const raw = JSON.stringify({ logic: 'AND', where: [{ field: 'title', op: 'eq', value: 'Hello' }] })
42
- const result = parsePublicFilter(raw)!
43
- expect(result.logic).toBe('AND')
44
- expect(result.where).toHaveLength(1)
45
- expect(result.where[0]).toEqual({ field: 'title', op: 'eq', value: 'Hello' })
46
- })
47
-
48
- it('defaults logic to AND when omitted', () => {
49
- const raw = JSON.stringify({ where: [{ field: 'title', op: 'contains', value: 'x' }] })
50
- expect(parsePublicFilter(raw)!.logic).toBe('AND')
51
- })
52
-
53
- it('accepts case-insensitive logic value', () => {
54
- const raw = JSON.stringify({ logic: 'or', where: [] })
55
- expect(parsePublicFilter(raw)!.logic).toBe('OR')
56
- })
57
-
58
- it('throws for malformed JSON', () => {
59
- expect(() => parsePublicFilter('{not-json')).toThrow('malformed JSON')
60
- })
61
-
62
- it('throws when parsed value is not an object', () => {
63
- expect(() => parsePublicFilter('"a string"')).toThrow('object expected')
64
- })
65
-
66
- it('throws for an invalid logic value', () => {
67
- const raw = JSON.stringify({ logic: 'BOTH', where: [] })
68
- expect(() => parsePublicFilter(raw)).toThrow("'AND' or 'OR'")
69
- })
70
-
71
- it('throws for an unknown operator in a where condition', () => {
72
- const raw = JSON.stringify({ where: [{ field: 'title', op: 'like', value: 'x' }] })
73
- expect(() => parsePublicFilter(raw)).toThrow("unknown operator 'like'")
74
- })
75
-
76
- it('throws when where is not an array', () => {
77
- const raw = JSON.stringify({ where: { field: 'title', op: 'eq' } })
78
- expect(() => parsePublicFilter(raw)).toThrow("'where' must be an array")
79
- })
80
-
81
- it('filters out null conditions from where (missing field/op)', () => {
82
- const raw = JSON.stringify({ where: [null, { field: 'title', op: 'eq', value: 'x' }] })
83
- const result = parsePublicFilter(raw)!
84
- expect(result.where).toHaveLength(1)
85
- })
86
-
87
- it('accepts all valid operators without throwing', () => {
88
- const operators = ['eq', 'neq', 'gt', 'gte', 'lt', 'lte', 'contains', 'not_contains',
89
- 'starts_with', 'ends_with', 'is_empty', 'is_not_empty', 'in', 'not_in',
90
- 'has_tag', 'has_any_tag', 'has_all_tags']
91
- for (const op of operators) {
92
- const raw = JSON.stringify({ where: [{ field: 'title', op, value: 'x' }] })
93
- expect(() => parsePublicFilter(raw)).not.toThrow()
94
- }
95
- })
96
- })
97
-
98
- // ─── toEngineFilters ──────────────────────────────────────────────────────────
99
-
100
- describe('toEngineFilters', () => {
101
- it('returns [] for null filter', () => {
102
- expect(toEngineFilters(SEED, null)).toEqual([])
103
- })
104
-
105
- it('returns [] when where array is empty', () => {
106
- expect(toEngineFilters(SEED, { where: [], logic: 'AND' })).toEqual([])
107
- })
108
-
109
- it('maps text branch to FilterType "text"', () => {
110
- const result = toEngineFilters(SEED, { where: [{ field: 'title', op: 'eq', value: 'Hi' }], logic: 'AND' })
111
- expect(result[0].type).toBe('text')
112
- })
113
-
114
- it('maps number branch to FilterType "number"', () => {
115
- const result = toEngineFilters(SEED, { where: [{ field: 'count', op: 'gt', value: 5 }], logic: 'AND' })
116
- expect(result[0].type).toBe('number')
117
- })
118
-
119
- it('maps boolean branch to FilterType "boolean"', () => {
120
- const result = toEngineFilters(SEED, { where: [{ field: 'active', op: 'eq', value: true }], logic: 'AND' })
121
- expect(result[0].type).toBe('boolean')
122
- })
123
-
124
- it('maps date branch to FilterType "date"', () => {
125
- const result = toEngineFilters(SEED, { where: [{ field: 'published_at', op: 'gt', value: '2024-01-01' }], logic: 'AND' })
126
- expect(result[0].type).toBe('date')
127
- })
128
-
129
- it('maps tags branch to FilterType "tags"', () => {
130
- const result = toEngineFilters(SEED, { where: [{ field: 'tags', op: 'has_tag', value: 'news' }], logic: 'AND' })
131
- expect(result[0].type).toBe('tags')
132
- })
133
-
134
- it('maps richtext branch to FilterType "text"', () => {
135
- const result = toEngineFilters(SEED, { where: [{ field: 'body', op: 'contains', value: 'x' }], logic: 'AND' })
136
- expect(result[0].type).toBe('text')
137
- })
138
-
139
- it('maps file branch to FilterType "text"', () => {
140
- const result = toEngineFilters(SEED, { where: [{ field: 'attachment', op: 'contains', value: 'url' }], logic: 'AND' })
141
- expect(result[0].type).toBe('text')
142
- })
143
-
144
- it('maps json branch to FilterType "json"', () => {
145
- const result = toEngineFilters(SEED, { where: [{ field: 'meta', op: 'eq', value: '{}' }], logic: 'AND' })
146
- expect(result[0].type).toBe('json')
147
- })
148
-
149
- it('maps system columns (id, slug, status) to FilterType "system"', () => {
150
- for (const field of ['id', 'slug', 'status', 'created_at', 'updated_at']) {
151
- const result = toEngineFilters(SEED, { where: [{ field, op: 'eq', value: 'x' }], logic: 'AND' })
152
- expect(result[0].type).toBe('system')
153
- }
154
- })
155
-
156
- it('maps unknown fields to FilterType "text"', () => {
157
- const result = toEngineFilters(SEED, { where: [{ field: 'ghost_field', op: 'eq', value: 'x' }], logic: 'AND' })
158
- expect(result[0].type).toBe('text')
159
- })
160
-
161
- it('produces one FilterGroup per condition', () => {
162
- const filter = {
163
- where: [
164
- { field: 'title', op: 'eq' as const, value: 'A' },
165
- { field: 'count', op: 'gt' as const, value: 5 },
166
- ],
167
- logic: 'AND' as const,
168
- }
169
- expect(toEngineFilters(SEED, filter)).toHaveLength(2)
170
- })
171
-
172
- it('includes column and conditions in each FilterGroup', () => {
173
- const filter = { where: [{ field: 'title', op: 'contains' as const, value: 'hi' }], logic: 'AND' as const }
174
- const [group] = toEngineFilters(SEED, filter)
175
- expect(group.column).toBe('title')
176
- expect(group.conditions[0].op).toBe('contains')
177
- expect(group.conditions[0].value).toBe('hi')
178
- })
179
- })
180
-
181
- // ─── parsePublicPagination ────────────────────────────────────────────────────
182
-
183
- describe('parsePublicPagination', () => {
184
- it('defaults to page=1 and limit=25 when input is empty', () => {
185
- expect(parsePublicPagination({})).toEqual({ page: 1, limit: 25 })
186
- })
187
-
188
- it('parses valid page and limit values', () => {
189
- expect(parsePublicPagination({ page: '3', limit: '10' })).toEqual({ page: 3, limit: 10 })
190
- })
191
-
192
- it('clamps limit to a maximum of 100', () => {
193
- expect(parsePublicPagination({ limit: '500' }).limit).toBe(100)
194
- })
195
-
196
- it('uses default for invalid (non-numeric) input', () => {
197
- expect(parsePublicPagination({ page: 'abc', limit: 'xyz' })).toEqual({ page: 1, limit: 25 })
198
- })
199
- })
200
-
201
- // ─── parseLatestCount ─────────────────────────────────────────────────────────
202
-
203
- describe('parseLatestCount', () => {
204
- it('returns 10 for undefined', () => {
205
- expect(parseLatestCount(undefined)).toBe(10)
206
- })
207
-
208
- it('parses a valid integer string', () => {
209
- expect(parseLatestCount('5')).toBe(5)
210
- })
211
-
212
- it('clamps to 1 for values below minimum', () => {
213
- expect(parseLatestCount('0')).toBe(1)
214
- expect(parseLatestCount('-5')).toBe(1)
215
- })
216
-
217
- it('clamps to 100 for values above maximum', () => {
218
- expect(parseLatestCount('200')).toBe(100)
219
- })
220
-
221
- it('returns 10 for non-numeric input', () => {
222
- expect(parseLatestCount('abc')).toBe(10)
223
- })
224
- })
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 } from 'vitest'
6
+ import {
7
+ parsePublicFilter,
8
+ toEngineFilters,
9
+ parsePublicPagination,
10
+ parseLatestCount,
11
+ } from './query-builder'
12
+ import type { Seed } from '@beechcms/core'
13
+
14
+ const SEED = {
15
+ slug: 'posts',
16
+ displayNameAlias: 'title',
17
+ branches: [
18
+ { id: 'br_01', alias: 'title', type: 'text' },
19
+ { id: 'br_02', alias: 'count', type: 'number' },
20
+ { id: 'br_03', alias: 'active', type: 'boolean' },
21
+ { id: 'br_04', alias: 'published_at', type: 'date' },
22
+ { id: 'br_05', alias: 'tags', type: 'tags' },
23
+ { id: 'br_06', alias: 'body', type: 'richtext' },
24
+ { id: 'br_07', alias: 'attachment', type: 'file' },
25
+ { id: 'br_08', alias: 'meta', type: 'json' },
26
+ ],
27
+ } as unknown as Seed
28
+
29
+ // ─── parsePublicFilter ────────────────────────────────────────────────────────
30
+
31
+ describe('parsePublicFilter', () => {
32
+ it('returns null for undefined input', () => {
33
+ expect(parsePublicFilter(undefined)).toBeNull()
34
+ })
35
+
36
+ it('returns null for empty string', () => {
37
+ expect(parsePublicFilter('')).toBeNull()
38
+ })
39
+
40
+ it('parses a valid filter with explicit AND logic', () => {
41
+ const raw = JSON.stringify({ logic: 'AND', where: [{ field: 'title', op: 'eq', value: 'Hello' }] })
42
+ const result = parsePublicFilter(raw)!
43
+ expect(result.logic).toBe('AND')
44
+ expect(result.where).toHaveLength(1)
45
+ expect(result.where[0]).toEqual({ field: 'title', op: 'eq', value: 'Hello' })
46
+ })
47
+
48
+ it('defaults logic to AND when omitted', () => {
49
+ const raw = JSON.stringify({ where: [{ field: 'title', op: 'contains', value: 'x' }] })
50
+ expect(parsePublicFilter(raw)!.logic).toBe('AND')
51
+ })
52
+
53
+ it('accepts case-insensitive logic value', () => {
54
+ const raw = JSON.stringify({ logic: 'or', where: [] })
55
+ expect(parsePublicFilter(raw)!.logic).toBe('OR')
56
+ })
57
+
58
+ it('throws for malformed JSON', () => {
59
+ expect(() => parsePublicFilter('{not-json')).toThrow('malformed JSON')
60
+ })
61
+
62
+ it('throws when parsed value is not an object', () => {
63
+ expect(() => parsePublicFilter('"a string"')).toThrow('object expected')
64
+ })
65
+
66
+ it('throws for an invalid logic value', () => {
67
+ const raw = JSON.stringify({ logic: 'BOTH', where: [] })
68
+ expect(() => parsePublicFilter(raw)).toThrow("'AND' or 'OR'")
69
+ })
70
+
71
+ it('throws for an unknown operator in a where condition', () => {
72
+ const raw = JSON.stringify({ where: [{ field: 'title', op: 'like', value: 'x' }] })
73
+ expect(() => parsePublicFilter(raw)).toThrow("unknown operator 'like'")
74
+ })
75
+
76
+ it('throws when where is not an array', () => {
77
+ const raw = JSON.stringify({ where: { field: 'title', op: 'eq' } })
78
+ expect(() => parsePublicFilter(raw)).toThrow("'where' must be an array")
79
+ })
80
+
81
+ it('filters out null conditions from where (missing field/op)', () => {
82
+ const raw = JSON.stringify({ where: [null, { field: 'title', op: 'eq', value: 'x' }] })
83
+ const result = parsePublicFilter(raw)!
84
+ expect(result.where).toHaveLength(1)
85
+ })
86
+
87
+ it('accepts all valid operators without throwing', () => {
88
+ const operators = ['eq', 'neq', 'gt', 'gte', 'lt', 'lte', 'contains', 'not_contains',
89
+ 'starts_with', 'ends_with', 'is_empty', 'is_not_empty', 'in', 'not_in',
90
+ 'has_tag', 'has_any_tag', 'has_all_tags']
91
+ for (const op of operators) {
92
+ const raw = JSON.stringify({ where: [{ field: 'title', op, value: 'x' }] })
93
+ expect(() => parsePublicFilter(raw)).not.toThrow()
94
+ }
95
+ })
96
+ })
97
+
98
+ // ─── toEngineFilters ──────────────────────────────────────────────────────────
99
+
100
+ describe('toEngineFilters', () => {
101
+ it('returns [] for null filter', () => {
102
+ expect(toEngineFilters(SEED, null)).toEqual([])
103
+ })
104
+
105
+ it('returns [] when where array is empty', () => {
106
+ expect(toEngineFilters(SEED, { where: [], logic: 'AND' })).toEqual([])
107
+ })
108
+
109
+ it('maps text branch to FilterType "text"', () => {
110
+ const result = toEngineFilters(SEED, { where: [{ field: 'title', op: 'eq', value: 'Hi' }], logic: 'AND' })
111
+ expect(result[0].type).toBe('text')
112
+ })
113
+
114
+ it('maps number branch to FilterType "number"', () => {
115
+ const result = toEngineFilters(SEED, { where: [{ field: 'count', op: 'gt', value: 5 }], logic: 'AND' })
116
+ expect(result[0].type).toBe('number')
117
+ })
118
+
119
+ it('maps boolean branch to FilterType "boolean"', () => {
120
+ const result = toEngineFilters(SEED, { where: [{ field: 'active', op: 'eq', value: true }], logic: 'AND' })
121
+ expect(result[0].type).toBe('boolean')
122
+ })
123
+
124
+ it('maps date branch to FilterType "date"', () => {
125
+ const result = toEngineFilters(SEED, { where: [{ field: 'published_at', op: 'gt', value: '2024-01-01' }], logic: 'AND' })
126
+ expect(result[0].type).toBe('date')
127
+ })
128
+
129
+ it('maps tags branch to FilterType "tags"', () => {
130
+ const result = toEngineFilters(SEED, { where: [{ field: 'tags', op: 'has_tag', value: 'news' }], logic: 'AND' })
131
+ expect(result[0].type).toBe('tags')
132
+ })
133
+
134
+ it('maps richtext branch to FilterType "text"', () => {
135
+ const result = toEngineFilters(SEED, { where: [{ field: 'body', op: 'contains', value: 'x' }], logic: 'AND' })
136
+ expect(result[0].type).toBe('text')
137
+ })
138
+
139
+ it('maps file branch to FilterType "text"', () => {
140
+ const result = toEngineFilters(SEED, { where: [{ field: 'attachment', op: 'contains', value: 'url' }], logic: 'AND' })
141
+ expect(result[0].type).toBe('text')
142
+ })
143
+
144
+ it('maps json branch to FilterType "json"', () => {
145
+ const result = toEngineFilters(SEED, { where: [{ field: 'meta', op: 'eq', value: '{}' }], logic: 'AND' })
146
+ expect(result[0].type).toBe('json')
147
+ })
148
+
149
+ it('maps system columns (id, slug, status) to FilterType "system"', () => {
150
+ for (const field of ['id', 'slug', 'status', 'created_at', 'updated_at']) {
151
+ const result = toEngineFilters(SEED, { where: [{ field, op: 'eq', value: 'x' }], logic: 'AND' })
152
+ expect(result[0].type).toBe('system')
153
+ }
154
+ })
155
+
156
+ it('maps unknown fields to FilterType "text"', () => {
157
+ const result = toEngineFilters(SEED, { where: [{ field: 'ghost_field', op: 'eq', value: 'x' }], logic: 'AND' })
158
+ expect(result[0].type).toBe('text')
159
+ })
160
+
161
+ it('produces one FilterGroup per condition', () => {
162
+ const filter = {
163
+ where: [
164
+ { field: 'title', op: 'eq' as const, value: 'A' },
165
+ { field: 'count', op: 'gt' as const, value: 5 },
166
+ ],
167
+ logic: 'AND' as const,
168
+ }
169
+ expect(toEngineFilters(SEED, filter)).toHaveLength(2)
170
+ })
171
+
172
+ it('includes column and conditions in each FilterGroup', () => {
173
+ const filter = { where: [{ field: 'title', op: 'contains' as const, value: 'hi' }], logic: 'AND' as const }
174
+ const [group] = toEngineFilters(SEED, filter)
175
+ expect(group.column).toBe('title')
176
+ expect(group.conditions[0].op).toBe('contains')
177
+ expect(group.conditions[0].value).toBe('hi')
178
+ })
179
+ })
180
+
181
+ // ─── parsePublicPagination ────────────────────────────────────────────────────
182
+
183
+ describe('parsePublicPagination', () => {
184
+ it('defaults to page=1 and limit=25 when input is empty', () => {
185
+ expect(parsePublicPagination({})).toEqual({ page: 1, limit: 25 })
186
+ })
187
+
188
+ it('parses valid page and limit values', () => {
189
+ expect(parsePublicPagination({ page: '3', limit: '10' })).toEqual({ page: 3, limit: 10 })
190
+ })
191
+
192
+ it('clamps limit to a maximum of 100', () => {
193
+ expect(parsePublicPagination({ limit: '500' }).limit).toBe(100)
194
+ })
195
+
196
+ it('uses default for invalid (non-numeric) input', () => {
197
+ expect(parsePublicPagination({ page: 'abc', limit: 'xyz' })).toEqual({ page: 1, limit: 25 })
198
+ })
199
+ })
200
+
201
+ // ─── parseLatestCount ─────────────────────────────────────────────────────────
202
+
203
+ describe('parseLatestCount', () => {
204
+ it('returns 10 for undefined', () => {
205
+ expect(parseLatestCount(undefined)).toBe(10)
206
+ })
207
+
208
+ it('parses a valid integer string', () => {
209
+ expect(parseLatestCount('5')).toBe(5)
210
+ })
211
+
212
+ it('clamps to 1 for values below minimum', () => {
213
+ expect(parseLatestCount('0')).toBe(1)
214
+ expect(parseLatestCount('-5')).toBe(1)
215
+ })
216
+
217
+ it('clamps to 100 for values above maximum', () => {
218
+ expect(parseLatestCount('200')).toBe(100)
219
+ })
220
+
221
+ it('returns 10 for non-numeric input', () => {
222
+ expect(parseLatestCount('abc')).toBe(10)
223
+ })
224
+ })