@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,341 +1,385 @@
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 type {
7
- Seed,
8
- IWidgetRepository,
9
- AggregateFormula,
10
- TimeWindow,
11
- LeaderboardEntry,
12
- LeaderboardOptions,
13
- TimeseriesPoint,
14
- WidgetListOptions,
15
- WidgetListResult,
16
- GrowthResult,
17
- } from '@beechcms/core'
18
-
19
- const SYSTEM_COLUMNS: ReadonlySet<string> = new Set([
20
- 'id',
21
- 'slug',
22
- 'status',
23
- 'created_at',
24
- 'updated_at',
25
- ])
26
-
27
- const ALLOWED_FILTER_OPERATORS: ReadonlySet<string> = new Set([
28
- 'eq',
29
- '=',
30
- 'neq',
31
- '!=',
32
- 'like',
33
- 'gt',
34
- '>',
35
- 'lt',
36
- '<',
37
- ])
38
-
39
- const UNSAFE_COLUMN_ERROR = 'UNSAFE_COLUMN'
40
-
41
- /**
42
- * D1-backed implementation of {@link IWidgetRepository}.
43
- *
44
- * All user-supplied values are bound via parameterised statements. Column
45
- * aliases originating from query strings are validated against the seed
46
- * before being composed into the SQL string, preventing column-name
47
- * injection. SQL keywords (aggregate function names, ORDER direction) are
48
- * selected via hardcoded branches.
49
- */
50
- export class D1WidgetRepository implements IWidgetRepository {
51
- constructor(private readonly database: D1Database) {}
52
-
53
- async aggregate(seed: Seed, formula: AggregateFormula, window: TimeWindow): Promise<number> {
54
- const aggregateExpression = this.buildAggregateExpression(seed, formula)
55
- const timeWindowFilter = this.buildTimeWindowFilter(window)
56
- const tableName = `content_${seed.slug}`
57
-
58
- const sql =
59
- `SELECT ${aggregateExpression} as computed_value
60
- FROM ${tableName}
61
- WHERE ${timeWindowFilter}`
62
-
63
- const row = await this.database.prepare(sql).first<{ computed_value: number | null }>()
64
- return row?.computed_value ?? 0
65
- }
66
-
67
- async growth(
68
- seed: Seed,
69
- formula: AggregateFormula,
70
- window: TimeWindow,
71
- ): Promise<GrowthResult> {
72
- const aggregateExpression = this.buildAggregateExpression(seed, formula)
73
- const { currentFilter, previousFilter } = this.buildPreviousWindowFilter(window)
74
- const tableName = `content_${seed.slug}`
75
-
76
- const [currentRow, previousRow] = await Promise.all([
77
- this.database
78
- .prepare(`SELECT ${aggregateExpression} as computed_value FROM ${tableName} WHERE ${currentFilter}`)
79
- .first<{ computed_value: number | null }>(),
80
- this.database
81
- .prepare(`SELECT ${aggregateExpression} as computed_value FROM ${tableName} WHERE ${previousFilter}`)
82
- .first<{ computed_value: number | null }>(),
83
- ])
84
-
85
- return {
86
- currentValue: currentRow?.computed_value ?? 0,
87
- previousValue: previousRow?.computed_value ?? 0,
88
- }
89
- }
90
-
91
- async leaderboard(seed: Seed, options: LeaderboardOptions): Promise<LeaderboardEntry[]> {
92
- const scoreColumn = this.resolveColumnExpression(seed, options.scoreColumn)
93
- const labelColumn = this.resolveColumnExpression(seed, seed.displayNameAlias)
94
- const tableName = `content_${seed.slug}`
95
- const orderClause = options.orderDirection === 'ASC'
96
- ? `ORDER BY CAST(${scoreColumn} AS REAL) ASC`
97
- : `ORDER BY CAST(${scoreColumn} AS REAL) DESC`
98
-
99
- const sql =
100
- `SELECT id, ${labelColumn} as label, ${scoreColumn} as score
101
- FROM ${tableName}
102
- WHERE ${scoreColumn} IS NOT NULL
103
- ${orderClause}
104
- LIMIT ?`
105
-
106
- const rows = await this.database
107
- .prepare(sql)
108
- .bind(options.limit)
109
- .all<{ id: string; label: string | null; score: number | string | null }>()
110
-
111
- return (rows.results ?? []).map(row => ({
112
- id: row.id,
113
- label: row.label ?? row.id,
114
- score: row.score ?? 0,
115
- }))
116
- }
117
-
118
- async list(seed: Seed, options: WidgetListOptions): Promise<WidgetListResult> {
119
- const tableName = `content_${seed.slug}`
120
- const conditions: string[] = []
121
- const bindings: unknown[] = []
122
-
123
- const trimmedSearch = options.search?.trim() ?? ''
124
- if (trimmedSearch.length > 0) {
125
- const displayColumn = this.resolveColumnExpression(seed, seed.displayNameAlias)
126
- conditions.push(`${displayColumn} LIKE ?`)
127
- bindings.push(`%${trimmedSearch}%`)
128
- }
129
-
130
- for (const filter of options.filters ?? []) {
131
- this.appendFilterCondition(seed, filter, conditions, bindings)
132
- }
133
-
134
- const whereSql = conditions.length > 0 ? `WHERE ${conditions.join(' AND ')}` : ''
135
- const orderClause = this.buildListOrderClause(seed, options)
136
- const branchColumns = seed.branches.map(branch => branch.alias).join(', ')
137
- const selectColumns = branchColumns.length > 0
138
- ? `id, slug, status, created_at, updated_at, ${branchColumns}`
139
- : `id, slug, status, created_at, updated_at`
140
-
141
- const dataSql =
142
- `SELECT ${selectColumns}
143
- FROM ${tableName}
144
- ${whereSql}
145
- ${orderClause}
146
- LIMIT ? OFFSET ?`
147
-
148
- const countSql = `SELECT COUNT(*) as total FROM ${tableName} ${whereSql}`
149
-
150
- const [countRow, listRows] = await Promise.all([
151
- this.database.prepare(countSql).bind(...bindings).first<{ total: number }>(),
152
- this.database
153
- .prepare(dataSql)
154
- .bind(...bindings, options.limit, options.offset)
155
- .all<Record<string, unknown>>(),
156
- ])
157
-
158
- return {
159
- entries: listRows.results ?? [],
160
- totalCount: countRow?.total ?? 0,
161
- }
162
- }
163
-
164
- async timeseries(
165
- seed: Seed,
166
- formula: AggregateFormula,
167
- window: TimeWindow,
168
- groupColumn: string,
169
- ): Promise<TimeseriesPoint[]> {
170
- const groupColumnExpression = this.resolveColumnExpression(seed, groupColumn)
171
- const aggregateExpression = this.buildAggregateExpression(seed, formula)
172
- const timeWindowFilter = this.buildTimeWindowFilter(window)
173
- const tableName = `content_${seed.slug}`
174
-
175
- const dateBucketExpression = groupColumnExpression === 'created_at'
176
- ? `strftime('%Y-%m-%d', created_at, 'unixepoch')`
177
- : `strftime('%Y-%m-%d', CAST(${groupColumnExpression} AS INTEGER), 'unixepoch')`
178
-
179
- const sql =
180
- `SELECT ${dateBucketExpression} as bucket_label,
181
- ${aggregateExpression} as bucket_value
182
- FROM ${tableName}
183
- WHERE ${timeWindowFilter}
184
- GROUP BY bucket_label
185
- ORDER BY bucket_label ASC`
186
-
187
- const rows = await this.database
188
- .prepare(sql)
189
- .all<{ bucket_label: string | null; bucket_value: number | null }>()
190
-
191
- return (rows.results ?? []).map(row => ({
192
- label: row.bucket_label ?? '',
193
- value: row.bucket_value ?? 0,
194
- }))
195
- }
196
-
197
- /**
198
- * Throws UNSAFE_COLUMN if the alias is neither a system column nor a
199
- * declared seed branch, preventing SQL injection via column names.
200
- */
201
- private resolveColumnExpression(seed: Seed, alias: string): string {
202
- if (SYSTEM_COLUMNS.has(alias)) return alias
203
- const branch = seed.branches.find(candidate => candidate.alias === alias)
204
- if (!branch) throw new Error(UNSAFE_COLUMN_ERROR)
205
- return branch.alias
206
- }
207
-
208
- private buildAggregateExpression(seed: Seed, formula: AggregateFormula): string {
209
- switch (formula.op) {
210
- case 'count':
211
- return 'COUNT(*)'
212
- case 'sum': {
213
- const column = this.resolveColumnExpression(seed, formula.column)
214
- return `SUM(CAST(${column} AS REAL))`
215
- }
216
- case 'avg': {
217
- const column = this.resolveColumnExpression(seed, formula.column)
218
- return `AVG(CAST(${column} AS REAL))`
219
- }
220
- case 'min': {
221
- const column = this.resolveColumnExpression(seed, formula.column)
222
- return `MIN(CAST(${column} AS REAL))`
223
- }
224
- case 'max': {
225
- const column = this.resolveColumnExpression(seed, formula.column)
226
- return `MAX(CAST(${column} AS REAL))`
227
- }
228
- case 'countWhere':
229
- return this.buildCountWhereExpression(seed, formula.column, formula.value)
230
- case 'percentageOf': {
231
- const numerator = this.resolveColumnExpression(seed, formula.numeratorColumn)
232
- const denominator = this.resolveColumnExpression(seed, formula.denominatorColumn)
233
- return `CASE WHEN SUM(CAST(${denominator} AS REAL)) = 0 THEN 0 ELSE (SUM(CAST(${numerator} AS REAL)) * 100.0 / SUM(CAST(${denominator} AS REAL))) END`
234
- }
235
- }
236
- }
237
-
238
- private buildCountWhereExpression(seed: Seed, alias: string, value: unknown): string {
239
- const column = this.resolveColumnExpression(seed, alias)
240
- if (value === null) return `COUNT(CASE WHEN ${column} IS NULL THEN 1 END)`
241
- if (typeof value === 'boolean') {
242
- const numericValue = value ? 1 : 0
243
- return `COUNT(CASE WHEN ${column} = ${numericValue} THEN 1 END)`
244
- }
245
- if (typeof value === 'number' && Number.isFinite(value)) {
246
- return `COUNT(CASE WHEN CAST(${column} AS REAL) = ${value} THEN 1 END)`
247
- }
248
- const escaped = String(value).replace(/'/g, "''")
249
- return `COUNT(CASE WHEN ${column} = '${escaped}' THEN 1 END)`
250
- }
251
-
252
- private buildTimeWindowFilter(window: TimeWindow): string {
253
- switch (window) {
254
- case 'week': return "created_at > unixepoch('now', '-7 days')"
255
- case 'month': return "created_at > unixepoch('now', '-1 month')"
256
- case 'year': return "created_at > unixepoch('now', '-1 year')"
257
- case 'all': return '1=1'
258
- }
259
- }
260
-
261
- private buildPreviousWindowFilter(
262
- window: TimeWindow,
263
- ): { currentFilter: string; previousFilter: string } {
264
- switch (window) {
265
- case 'week':
266
- return {
267
- currentFilter: "created_at > unixepoch('now', '-7 days')",
268
- previousFilter: "created_at > unixepoch('now', '-14 days') AND created_at <= unixepoch('now', '-7 days')",
269
- }
270
- case 'month':
271
- return {
272
- currentFilter: "created_at > unixepoch('now', '-1 month')",
273
- previousFilter: "created_at > unixepoch('now', '-2 months') AND created_at <= unixepoch('now', '-1 month')",
274
- }
275
- case 'year':
276
- return {
277
- currentFilter: "created_at > unixepoch('now', '-1 year')",
278
- previousFilter: "created_at > unixepoch('now', '-2 years') AND created_at <= unixepoch('now', '-1 year')",
279
- }
280
- case 'all':
281
- return { currentFilter: '1=1', previousFilter: '1=0' }
282
- }
283
- }
284
-
285
- private appendFilterCondition(
286
- seed: Seed,
287
- filter: { column: string; op: string; value: unknown },
288
- conditions: string[],
289
- bindings: unknown[],
290
- ): void {
291
- if (!ALLOWED_FILTER_OPERATORS.has(filter.op)) return
292
-
293
- let column: string
294
- try {
295
- column = this.resolveColumnExpression(seed, filter.column)
296
- } catch {
297
- return
298
- }
299
-
300
- switch (filter.op) {
301
- case 'eq':
302
- case '=':
303
- conditions.push(`${column} = ?`)
304
- bindings.push(filter.value)
305
- return
306
- case 'neq':
307
- case '!=':
308
- conditions.push(`${column} != ?`)
309
- bindings.push(filter.value)
310
- return
311
- case 'like':
312
- conditions.push(`${column} LIKE ?`)
313
- bindings.push(filter.value)
314
- return
315
- case 'gt':
316
- case '>':
317
- conditions.push(`CAST(${column} AS REAL) > ?`)
318
- bindings.push(filter.value)
319
- return
320
- case 'lt':
321
- case '<':
322
- conditions.push(`CAST(${column} AS REAL) < ?`)
323
- bindings.push(filter.value)
324
- return
325
- }
326
- }
327
-
328
- private buildListOrderClause(seed: Seed, options: WidgetListOptions): string {
329
- let orderColumn = 'created_at'
330
- if (options.orderByColumn) {
331
- try {
332
- orderColumn = this.resolveColumnExpression(seed, options.orderByColumn)
333
- } catch {
334
- orderColumn = 'created_at'
335
- }
336
- }
337
- return options.orderDirection === 'DESC'
338
- ? `ORDER BY ${orderColumn} DESC`
339
- : `ORDER BY ${orderColumn} ASC`
340
- }
341
- }
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 {
7
+ isDateRange,
8
+ type Seed,
9
+ type IWidgetRepository,
10
+ type AggregateFormula,
11
+ type WidgetWindow,
12
+ type LeaderboardEntry,
13
+ type LeaderboardOptions,
14
+ type TimeseriesPoint,
15
+ type WidgetListOptions,
16
+ type WidgetListResult,
17
+ type GrowthResult,
18
+ type DistributionSlice,
19
+ } from '@beechcms/core'
20
+
21
+ const SYSTEM_COLUMNS: ReadonlySet<string> = new Set([
22
+ 'id',
23
+ 'slug',
24
+ 'status',
25
+ 'created_at',
26
+ 'updated_at',
27
+ ])
28
+
29
+ const ALLOWED_FILTER_OPERATORS: ReadonlySet<string> = new Set([
30
+ 'eq',
31
+ '=',
32
+ 'neq',
33
+ '!=',
34
+ 'like',
35
+ 'gt',
36
+ '>',
37
+ 'lt',
38
+ '<',
39
+ ])
40
+
41
+ const UNSAFE_COLUMN_ERROR = 'UNSAFE_COLUMN'
42
+
43
+ /**
44
+ * D1-backed implementation of {@link IWidgetRepository}.
45
+ *
46
+ * All user-supplied values are bound via parameterised statements. Column
47
+ * aliases originating from query strings are validated against the seed
48
+ * before being composed into the SQL string, preventing column-name
49
+ * injection. SQL keywords (aggregate function names, ORDER direction) are
50
+ * selected via hardcoded branches.
51
+ */
52
+ export class D1WidgetRepository implements IWidgetRepository {
53
+ constructor(private readonly database: D1Database) {}
54
+
55
+ async aggregate(seed: Seed, formula: AggregateFormula, window: WidgetWindow): Promise<number> {
56
+ const aggregateExpression = this.buildAggregateExpression(seed, formula)
57
+ const { sql: timeWindowFilter, bindings } = this.buildTimeWindowFilter(window)
58
+ const tableName = `content_${seed.slug}`
59
+
60
+ const sql =
61
+ `SELECT ${aggregateExpression} as computed_value
62
+ FROM ${tableName}
63
+ WHERE ${timeWindowFilter}`
64
+
65
+ const row = await this.database.prepare(sql).bind(...bindings).first<{ computed_value: number | null }>()
66
+ return row?.computed_value ?? 0
67
+ }
68
+
69
+ async growth(
70
+ seed: Seed,
71
+ formula: AggregateFormula,
72
+ window: WidgetWindow,
73
+ ): Promise<GrowthResult> {
74
+ const aggregateExpression = this.buildAggregateExpression(seed, formula)
75
+ const { currentFilter, previousFilter } = this.buildPreviousWindowFilter(window)
76
+ const tableName = `content_${seed.slug}`
77
+
78
+ const [currentRow, previousRow] = await Promise.all([
79
+ this.database
80
+ .prepare(`SELECT ${aggregateExpression} as computed_value FROM ${tableName} WHERE ${currentFilter.sql}`)
81
+ .bind(...currentFilter.bindings)
82
+ .first<{ computed_value: number | null }>(),
83
+ this.database
84
+ .prepare(`SELECT ${aggregateExpression} as computed_value FROM ${tableName} WHERE ${previousFilter.sql}`)
85
+ .bind(...previousFilter.bindings)
86
+ .first<{ computed_value: number | null }>(),
87
+ ])
88
+
89
+ return {
90
+ currentValue: currentRow?.computed_value ?? 0,
91
+ previousValue: previousRow?.computed_value ?? 0,
92
+ }
93
+ }
94
+
95
+ async leaderboard(seed: Seed, options: LeaderboardOptions): Promise<LeaderboardEntry[]> {
96
+ const scoreColumn = this.resolveColumnExpression(seed, options.scoreColumn)
97
+ const labelColumn = this.resolveColumnExpression(seed, seed.displayNameAlias)
98
+ const tableName = `content_${seed.slug}`
99
+ const orderClause = options.orderDirection === 'ASC'
100
+ ? `ORDER BY CAST(${scoreColumn} AS REAL) ASC`
101
+ : `ORDER BY CAST(${scoreColumn} AS REAL) DESC`
102
+
103
+ const sql =
104
+ `SELECT id, ${labelColumn} as label, ${scoreColumn} as score
105
+ FROM ${tableName}
106
+ WHERE ${scoreColumn} IS NOT NULL
107
+ ${orderClause}
108
+ LIMIT ?`
109
+
110
+ const rows = await this.database
111
+ .prepare(sql)
112
+ .bind(options.limit)
113
+ .all<{ id: string; label: string | null; score: number | string | null }>()
114
+
115
+ return (rows.results ?? []).map(row => ({
116
+ id: row.id,
117
+ label: row.label ?? row.id,
118
+ score: row.score ?? 0,
119
+ }))
120
+ }
121
+
122
+ async list(seed: Seed, options: WidgetListOptions): Promise<WidgetListResult> {
123
+ const tableName = `content_${seed.slug}`
124
+ const conditions: string[] = []
125
+ const bindings: unknown[] = []
126
+
127
+ const trimmedSearch = options.search?.trim() ?? ''
128
+ if (trimmedSearch.length > 0) {
129
+ const displayColumn = this.resolveColumnExpression(seed, seed.displayNameAlias)
130
+ conditions.push(`${displayColumn} LIKE ?`)
131
+ bindings.push(`%${trimmedSearch}%`)
132
+ }
133
+
134
+ for (const filter of options.filters ?? []) {
135
+ this.appendFilterCondition(seed, filter, conditions, bindings)
136
+ }
137
+
138
+ const whereSql = conditions.length > 0 ? `WHERE ${conditions.join(' AND ')}` : ''
139
+ const orderClause = this.buildListOrderClause(seed, options)
140
+ const branchColumns = seed.branches.map(branch => branch.alias).join(', ')
141
+ const selectColumns = branchColumns.length > 0
142
+ ? `id, slug, status, created_at, updated_at, ${branchColumns}`
143
+ : `id, slug, status, created_at, updated_at`
144
+
145
+ const dataSql =
146
+ `SELECT ${selectColumns}
147
+ FROM ${tableName}
148
+ ${whereSql}
149
+ ${orderClause}
150
+ LIMIT ? OFFSET ?`
151
+
152
+ const countSql = `SELECT COUNT(*) as total FROM ${tableName} ${whereSql}`
153
+
154
+ const [countRow, listRows] = await Promise.all([
155
+ this.database.prepare(countSql).bind(...bindings).first<{ total: number }>(),
156
+ this.database
157
+ .prepare(dataSql)
158
+ .bind(...bindings, options.limit, options.offset)
159
+ .all<Record<string, unknown>>(),
160
+ ])
161
+
162
+ return {
163
+ entries: listRows.results ?? [],
164
+ totalCount: countRow?.total ?? 0,
165
+ }
166
+ }
167
+
168
+ async timeseries(
169
+ seed: Seed,
170
+ formula: AggregateFormula,
171
+ window: WidgetWindow,
172
+ groupColumn: string,
173
+ ): Promise<TimeseriesPoint[]> {
174
+ const groupColumnExpression = this.resolveColumnExpression(seed, groupColumn)
175
+ const aggregateExpression = this.buildAggregateExpression(seed, formula)
176
+ const { sql: timeWindowFilter, bindings } = this.buildTimeWindowFilter(window)
177
+ const tableName = `content_${seed.slug}`
178
+
179
+ const dateBucketExpression = groupColumnExpression === 'created_at'
180
+ ? `strftime('%Y-%m-%d', created_at, 'unixepoch')`
181
+ : `strftime('%Y-%m-%d', CAST(${groupColumnExpression} AS INTEGER), 'unixepoch')`
182
+
183
+ const sql =
184
+ `SELECT ${dateBucketExpression} as bucket_label,
185
+ ${aggregateExpression} as bucket_value
186
+ FROM ${tableName}
187
+ WHERE ${timeWindowFilter}
188
+ GROUP BY bucket_label
189
+ ORDER BY bucket_label ASC`
190
+
191
+ const rows = await this.database
192
+ .prepare(sql)
193
+ .bind(...bindings)
194
+ .all<{ bucket_label: string | null; bucket_value: number | null }>()
195
+
196
+ return (rows.results ?? []).map(row => ({
197
+ label: row.bucket_label ?? '',
198
+ value: row.bucket_value ?? 0,
199
+ }))
200
+ }
201
+
202
+ async distribution(
203
+ seed: Seed,
204
+ column: string,
205
+ window: WidgetWindow,
206
+ limit: number,
207
+ ): Promise<DistributionSlice[]> {
208
+ const columnExpression = this.resolveColumnExpression(seed, column)
209
+ const { sql: timeWindowFilter, bindings } = this.buildTimeWindowFilter(window)
210
+ const tableName = `content_${seed.slug}`
211
+
212
+ const sql =
213
+ `SELECT ${columnExpression} as label, COUNT(*) as value
214
+ FROM ${tableName}
215
+ WHERE ${timeWindowFilter}
216
+ GROUP BY ${columnExpression}
217
+ ORDER BY value DESC
218
+ LIMIT ?`
219
+
220
+ const rows = await this.database
221
+ .prepare(sql)
222
+ .bind(...bindings, limit)
223
+ .all<{ label: string | number | null; value: number | null }>()
224
+
225
+ return (rows.results ?? []).map(row => ({
226
+ label: row.label === null ? '∅' : String(row.label),
227
+ value: row.value ?? 0,
228
+ }))
229
+ }
230
+
231
+ /**
232
+ * Throws UNSAFE_COLUMN if the alias is neither a system column nor a
233
+ * declared seed branch, preventing SQL injection via column names.
234
+ */
235
+ private resolveColumnExpression(seed: Seed, alias: string): string {
236
+ if (SYSTEM_COLUMNS.has(alias)) return alias
237
+ const branch = seed.branches.find(candidate => candidate.alias === alias)
238
+ if (!branch) throw new Error(UNSAFE_COLUMN_ERROR)
239
+ return branch.alias
240
+ }
241
+
242
+ private buildAggregateExpression(seed: Seed, formula: AggregateFormula): string {
243
+ switch (formula.op) {
244
+ case 'count':
245
+ return 'COUNT(*)'
246
+ case 'sum': {
247
+ const column = this.resolveColumnExpression(seed, formula.column)
248
+ return `SUM(CAST(${column} AS REAL))`
249
+ }
250
+ case 'avg': {
251
+ const column = this.resolveColumnExpression(seed, formula.column)
252
+ return `AVG(CAST(${column} AS REAL))`
253
+ }
254
+ case 'min': {
255
+ const column = this.resolveColumnExpression(seed, formula.column)
256
+ return `MIN(CAST(${column} AS REAL))`
257
+ }
258
+ case 'max': {
259
+ const column = this.resolveColumnExpression(seed, formula.column)
260
+ return `MAX(CAST(${column} AS REAL))`
261
+ }
262
+ case 'countWhere':
263
+ return this.buildCountWhereExpression(seed, formula.column, formula.value)
264
+ case 'percentageOf': {
265
+ const numerator = this.resolveColumnExpression(seed, formula.numeratorColumn)
266
+ const denominator = this.resolveColumnExpression(seed, formula.denominatorColumn)
267
+ return `CASE WHEN SUM(CAST(${denominator} AS REAL)) = 0 THEN 0 ELSE (SUM(CAST(${numerator} AS REAL)) * 100.0 / SUM(CAST(${denominator} AS REAL))) END`
268
+ }
269
+ }
270
+ }
271
+
272
+ private buildCountWhereExpression(seed: Seed, alias: string, value: unknown): string {
273
+ const column = this.resolveColumnExpression(seed, alias)
274
+ if (value === null) return `COUNT(CASE WHEN ${column} IS NULL THEN 1 END)`
275
+ if (typeof value === 'boolean') {
276
+ const numericValue = value ? 1 : 0
277
+ return `COUNT(CASE WHEN ${column} = ${numericValue} THEN 1 END)`
278
+ }
279
+ if (typeof value === 'number' && Number.isFinite(value)) {
280
+ return `COUNT(CASE WHEN CAST(${column} AS REAL) = ${value} THEN 1 END)`
281
+ }
282
+ const escaped = String(value).replace(/'/g, "''")
283
+ return `COUNT(CASE WHEN ${column} = '${escaped}' THEN 1 END)`
284
+ }
285
+
286
+ private buildTimeWindowFilter(window: WidgetWindow): { sql: string; bindings: number[] } {
287
+ if (isDateRange(window)) {
288
+ return { sql: 'created_at BETWEEN ? AND ?', bindings: [window.from, window.to] }
289
+ }
290
+ switch (window) {
291
+ case 'week': return { sql: "created_at > unixepoch('now', '-7 days')", bindings: [] }
292
+ case 'month': return { sql: "created_at > unixepoch('now', '-1 month')", bindings: [] }
293
+ case 'year': return { sql: "created_at > unixepoch('now', '-1 year')", bindings: [] }
294
+ case 'all': return { sql: '1=1', bindings: [] }
295
+ }
296
+ }
297
+
298
+ private buildPreviousWindowFilter(
299
+ window: WidgetWindow,
300
+ ): { currentFilter: { sql: string; bindings: number[] }; previousFilter: { sql: string; bindings: number[] } } {
301
+ if (isDateRange(window)) {
302
+ const span = window.to - window.from
303
+ return {
304
+ currentFilter: { sql: 'created_at BETWEEN ? AND ?', bindings: [window.from, window.to] },
305
+ previousFilter: { sql: 'created_at BETWEEN ? AND ?', bindings: [window.from - span - 1, window.from - 1] },
306
+ }
307
+ }
308
+ switch (window) {
309
+ case 'week':
310
+ return {
311
+ currentFilter: { sql: "created_at > unixepoch('now', '-7 days')", bindings: [] },
312
+ previousFilter: { sql: "created_at > unixepoch('now', '-14 days') AND created_at <= unixepoch('now', '-7 days')", bindings: [] },
313
+ }
314
+ case 'month':
315
+ return {
316
+ currentFilter: { sql: "created_at > unixepoch('now', '-1 month')", bindings: [] },
317
+ previousFilter: { sql: "created_at > unixepoch('now', '-2 months') AND created_at <= unixepoch('now', '-1 month')", bindings: [] },
318
+ }
319
+ case 'year':
320
+ return {
321
+ currentFilter: { sql: "created_at > unixepoch('now', '-1 year')", bindings: [] },
322
+ previousFilter: { sql: "created_at > unixepoch('now', '-2 years') AND created_at <= unixepoch('now', '-1 year')", bindings: [] },
323
+ }
324
+ case 'all':
325
+ return { currentFilter: { sql: '1=1', bindings: [] }, previousFilter: { sql: '1=0', bindings: [] } }
326
+ }
327
+ }
328
+
329
+ private appendFilterCondition(
330
+ seed: Seed,
331
+ filter: { column: string; op: string; value: unknown },
332
+ conditions: string[],
333
+ bindings: unknown[],
334
+ ): void {
335
+ if (!ALLOWED_FILTER_OPERATORS.has(filter.op)) return
336
+
337
+ let column: string
338
+ try {
339
+ column = this.resolveColumnExpression(seed, filter.column)
340
+ } catch {
341
+ return
342
+ }
343
+
344
+ switch (filter.op) {
345
+ case 'eq':
346
+ case '=':
347
+ conditions.push(`${column} = ?`)
348
+ bindings.push(filter.value)
349
+ return
350
+ case 'neq':
351
+ case '!=':
352
+ conditions.push(`${column} != ?`)
353
+ bindings.push(filter.value)
354
+ return
355
+ case 'like':
356
+ conditions.push(`${column} LIKE ?`)
357
+ bindings.push(filter.value)
358
+ return
359
+ case 'gt':
360
+ case '>':
361
+ conditions.push(`CAST(${column} AS REAL) > ?`)
362
+ bindings.push(filter.value)
363
+ return
364
+ case 'lt':
365
+ case '<':
366
+ conditions.push(`CAST(${column} AS REAL) < ?`)
367
+ bindings.push(filter.value)
368
+ return
369
+ }
370
+ }
371
+
372
+ private buildListOrderClause(seed: Seed, options: WidgetListOptions): string {
373
+ let orderColumn = 'created_at'
374
+ if (options.orderByColumn) {
375
+ try {
376
+ orderColumn = this.resolveColumnExpression(seed, options.orderByColumn)
377
+ } catch {
378
+ orderColumn = 'created_at'
379
+ }
380
+ }
381
+ return options.orderDirection === 'DESC'
382
+ ? `ORDER BY ${orderColumn} DESC`
383
+ : `ORDER BY ${orderColumn} ASC`
384
+ }
385
+ }