@10x-media/analytics 1.0.0-beta.7 → 1.0.0-beta.9

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 (368) hide show
  1. package/CHANGELOG.md +118 -0
  2. package/LICENSE +21 -21
  3. package/README.md +10 -4
  4. package/dist/adapters/ga4/eventName.d.ts +15 -0
  5. package/dist/adapters/ga4/eventName.js +19 -0
  6. package/dist/adapters/ga4/eventName.js.map +1 -0
  7. package/dist/adapters/ga4/ga4.d.ts +5 -0
  8. package/dist/adapters/ga4/ga4.js +179 -70
  9. package/dist/adapters/ga4/ga4.js.map +1 -1
  10. package/dist/adapters/ga4/measurementId.js +15 -0
  11. package/dist/adapters/ga4/measurementId.js.map +1 -0
  12. package/dist/adapters/goalRead.js +126 -0
  13. package/dist/adapters/goalRead.js.map +1 -0
  14. package/dist/adapters/plausible/plausible.d.ts +15 -0
  15. package/dist/adapters/plausible/plausible.js +112 -43
  16. package/dist/adapters/plausible/plausible.js.map +1 -1
  17. package/dist/adapters/posthog/posthog.js +47 -25
  18. package/dist/adapters/posthog/posthog.js.map +1 -1
  19. package/dist/adapters/umami/umami.d.ts +8 -0
  20. package/dist/adapters/umami/umami.js +237 -28
  21. package/dist/adapters/umami/umami.js.map +1 -1
  22. package/dist/capture/slots.js +16 -5
  23. package/dist/capture/slots.js.map +1 -1
  24. package/dist/capture/trackerConfig.d.ts +1 -0
  25. package/dist/capture/trackerConfig.js +28 -3
  26. package/dist/capture/trackerConfig.js.map +1 -1
  27. package/dist/charts/BarList.d.ts +15 -1
  28. package/dist/charts/BarList.js +41 -19
  29. package/dist/charts/BarList.js.map +1 -1
  30. package/dist/charts/TrendChart.d.ts +16 -3
  31. package/dist/charts/TrendChart.js +172 -106
  32. package/dist/charts/TrendChart.js.map +1 -1
  33. package/dist/charts/bars.d.ts +2 -0
  34. package/dist/charts/bars.js +2 -1
  35. package/dist/charts/bars.js.map +1 -1
  36. package/dist/charts/bucket.js +10 -1
  37. package/dist/charts/bucket.js.map +1 -1
  38. package/dist/charts/spline.js +2 -2
  39. package/dist/charts/spline.js.map +1 -1
  40. package/dist/charts/styles.js +18 -1
  41. package/dist/charts/styles.js.map +1 -1
  42. package/dist/core/cacheKey.js +24 -2
  43. package/dist/core/cacheKey.js.map +1 -1
  44. package/dist/core/capabilities.js +7 -2
  45. package/dist/core/capabilities.js.map +1 -1
  46. package/dist/core/capture.d.ts +1 -1
  47. package/dist/core/contract.d.ts +46 -9
  48. package/dist/core/contract.js +29 -1
  49. package/dist/core/contract.js.map +1 -1
  50. package/dist/core/granularity.js +1 -1
  51. package/dist/core/options.d.ts +62 -7
  52. package/dist/core/options.js +63 -4
  53. package/dist/core/options.js.map +1 -1
  54. package/dist/core/scopedRead.js +33 -23
  55. package/dist/core/scopedRead.js.map +1 -1
  56. package/dist/core/serverEvent.d.ts +44 -0
  57. package/dist/core/serverEvent.js +12 -0
  58. package/dist/core/serverEvent.js.map +1 -0
  59. package/dist/exports/adapters/ga4.d.ts +2 -1
  60. package/dist/exports/adapters/ga4.js +2 -1
  61. package/dist/exports/client.d.ts +12 -3
  62. package/dist/exports/client.js +9 -1
  63. package/dist/exports/rsc.d.ts +7 -2
  64. package/dist/exports/rsc.js +6 -3
  65. package/dist/exports/tracker.d.ts +3 -2
  66. package/dist/exports/tracker.js +2 -1
  67. package/dist/exports/types.d.ts +13 -4
  68. package/dist/exports/types.js +3 -2
  69. package/dist/fields/AnalyticsPanelClient.js +1 -1
  70. package/dist/fields/AnalyticsPanelField.js +1 -1
  71. package/dist/fields/AnalyticsStatField.js +2 -2
  72. package/dist/fields/config/FilterDimensionSelectField.d.ts +14 -0
  73. package/dist/fields/config/FilterDimensionSelectField.js +77 -0
  74. package/dist/fields/config/FilterDimensionSelectField.js.map +1 -0
  75. package/dist/fields/config/FilterOperatorSelectField.d.ts +14 -0
  76. package/dist/fields/config/FilterOperatorSelectField.js +75 -0
  77. package/dist/fields/config/FilterOperatorSelectField.js.map +1 -0
  78. package/dist/fields/config/MetricSelectField.js +3 -3
  79. package/dist/fields/config/MetricSelectField.js.map +1 -1
  80. package/dist/fields/config/SourceSelectField.js +3 -3
  81. package/dist/fields/config/SourceSelectField.js.map +1 -1
  82. package/dist/fields/config/fetchSources.d.ts +5 -1
  83. package/dist/fields/config/sourcesState.js +19 -3
  84. package/dist/fields/config/sourcesState.js.map +1 -1
  85. package/dist/fields/config/useAnalyticsSources.d.ts +8 -3
  86. package/dist/fields/config/useAnalyticsSources.js +9 -6
  87. package/dist/fields/config/useAnalyticsSources.js.map +1 -1
  88. package/dist/fields/config/useFilterCapabilities.d.ts +28 -0
  89. package/dist/fields/config/useFilterCapabilities.js +52 -0
  90. package/dist/fields/config/useFilterCapabilities.js.map +1 -0
  91. package/dist/fields/readForDocument.d.ts +5 -0
  92. package/dist/fields/readForDocument.js +21 -9
  93. package/dist/fields/readForDocument.js.map +1 -1
  94. package/dist/goals/GoalSelectField.d.ts +7 -0
  95. package/dist/goals/GoalSelectField.js +77 -0
  96. package/dist/goals/GoalSelectField.js.map +1 -0
  97. package/dist/goals/collection.js +250 -0
  98. package/dist/goals/collection.js.map +1 -0
  99. package/dist/goals/currency.js +14 -0
  100. package/dist/goals/currency.js.map +1 -0
  101. package/dist/goals/fetchGoals.d.ts +18 -0
  102. package/dist/goals/fetchGoals.js +29 -0
  103. package/dist/goals/fetchGoals.js.map +1 -0
  104. package/dist/goals/goalField.d.ts +31 -0
  105. package/dist/goals/goalField.js +56 -0
  106. package/dist/goals/goalField.js.map +1 -0
  107. package/dist/goals/goalsEndpoint.d.ts +1 -0
  108. package/dist/goals/goalsEndpoint.js +55 -0
  109. package/dist/goals/goalsEndpoint.js.map +1 -0
  110. package/dist/goals/resolver.d.ts +8 -0
  111. package/dist/goals/resolver.js +147 -0
  112. package/dist/goals/resolver.js.map +1 -0
  113. package/dist/goals/trackGoalAction.d.ts +74 -0
  114. package/dist/goals/trackGoalAction.js +139 -0
  115. package/dist/goals/trackGoalAction.js.map +1 -0
  116. package/dist/goals/useAnalyticsGoals.d.ts +20 -0
  117. package/dist/goals/useAnalyticsGoals.js +67 -0
  118. package/dist/goals/useAnalyticsGoals.js.map +1 -0
  119. package/dist/index.d.ts +12 -3
  120. package/dist/index.js +75 -11
  121. package/dist/index.js.map +1 -1
  122. package/dist/native/collections/events.js +36 -0
  123. package/dist/native/collections/events.js.map +1 -1
  124. package/dist/native/eventScan.js +25 -0
  125. package/dist/native/eventScan.js.map +1 -0
  126. package/dist/native/ingest/browser.js +47 -0
  127. package/dist/native/ingest/browser.js.map +1 -0
  128. package/dist/native/ingest/device.js +11 -3
  129. package/dist/native/ingest/device.js.map +1 -1
  130. package/dist/native/ingest/endpoint.d.ts +1 -0
  131. package/dist/native/ingest/endpoint.js +2 -17
  132. package/dist/native/ingest/endpoint.js.map +1 -1
  133. package/dist/native/ingest/flushBatch.js +26 -26
  134. package/dist/native/ingest/flushBatch.js.map +1 -1
  135. package/dist/native/ingest/language.js +14 -0
  136. package/dist/native/ingest/language.js.map +1 -0
  137. package/dist/native/ingest/normalizeEvent.d.ts +26 -0
  138. package/dist/native/ingest/normalizeEvent.js +35 -7
  139. package/dist/native/ingest/normalizeEvent.js.map +1 -1
  140. package/dist/native/ingest/referrer.js +48 -0
  141. package/dist/native/ingest/referrer.js.map +1 -0
  142. package/dist/native/ingest/serverTrack.d.ts +20 -0
  143. package/dist/native/ingest/serverTrack.js +100 -0
  144. package/dist/native/ingest/serverTrack.js.map +1 -0
  145. package/dist/native/ingest/source.d.ts +7 -0
  146. package/dist/native/ingest/source.js +139 -14
  147. package/dist/native/ingest/source.js.map +1 -1
  148. package/dist/native/ingest/utm.js +33 -0
  149. package/dist/native/ingest/utm.js.map +1 -0
  150. package/dist/native/ingest/validate.js +27 -0
  151. package/dist/native/ingest/validate.js.map +1 -0
  152. package/dist/native/nativeAdapter.d.ts +1 -1
  153. package/dist/native/nativeAdapter.js +53 -36
  154. package/dist/native/nativeAdapter.js.map +1 -1
  155. package/dist/native/query/eventAgg.js +14 -1
  156. package/dist/native/query/eventAgg.js.map +1 -1
  157. package/dist/native/retention/pruneTask.js +1 -1
  158. package/dist/native/rollups/bucketKey.js +15 -0
  159. package/dist/native/rollups/bucketKey.js.map +1 -0
  160. package/dist/native/rollups/bumpRollups.js +116 -0
  161. package/dist/native/rollups/bumpRollups.js.map +1 -0
  162. package/dist/native/rollups/deltas.js +30 -15
  163. package/dist/native/rollups/deltas.js.map +1 -1
  164. package/dist/native/rollups/insertManyIfNew.js +93 -0
  165. package/dist/native/rollups/insertManyIfNew.js.map +1 -0
  166. package/dist/next/captureRewrites.d.ts +3 -2
  167. package/dist/next/captureRewrites.js +3 -2
  168. package/dist/next/captureRewrites.js.map +1 -1
  169. package/dist/plugin/documentEndpoint.js +52 -15
  170. package/dist/plugin/documentEndpoint.js.map +1 -1
  171. package/dist/plugin/goalHint.d.ts +1 -0
  172. package/dist/plugin/goalHint.js +24 -0
  173. package/dist/plugin/goalHint.js.map +1 -0
  174. package/dist/plugin/paths.js +5 -1
  175. package/dist/plugin/paths.js.map +1 -1
  176. package/dist/plugin/queryEndpoint.js +120 -0
  177. package/dist/plugin/queryEndpoint.js.map +1 -0
  178. package/dist/plugin/readContextForRequest.js +71 -0
  179. package/dist/plugin/readContextForRequest.js.map +1 -0
  180. package/dist/plugin/realtimeEndpoint.js +43 -15
  181. package/dist/plugin/realtimeEndpoint.js.map +1 -1
  182. package/dist/plugin/responses.js +17 -0
  183. package/dist/plugin/responses.js.map +1 -0
  184. package/dist/plugin/runtime.js +31 -1
  185. package/dist/plugin/runtime.js.map +1 -1
  186. package/dist/plugin/scopeFieldBoot.js +22 -0
  187. package/dist/plugin/scopeFieldBoot.js.map +1 -0
  188. package/dist/plugin/sourcesEndpoint.js +21 -52
  189. package/dist/plugin/sourcesEndpoint.js.map +1 -1
  190. package/dist/plugin/warmTask.js +0 -0
  191. package/dist/plugin/warmTask.js.map +1 -1
  192. package/dist/providers/collection.js +29 -13
  193. package/dist/providers/collection.js.map +1 -1
  194. package/dist/providers/factory.js +4 -2
  195. package/dist/providers/factory.js.map +1 -1
  196. package/dist/providers/resolver.js.map +1 -1
  197. package/dist/query/dates.js +64 -0
  198. package/dist/query/dates.js.map +1 -0
  199. package/dist/query/errors.d.ts +17 -0
  200. package/dist/query/errors.js +10 -0
  201. package/dist/query/errors.js.map +1 -0
  202. package/dist/query/fetchQuery.d.ts +59 -0
  203. package/dist/query/fetchQuery.js +110 -0
  204. package/dist/query/fetchQuery.js.map +1 -0
  205. package/dist/query/parse.d.ts +22 -0
  206. package/dist/query/parse.js +168 -0
  207. package/dist/query/parse.js.map +1 -0
  208. package/dist/query/response.d.ts +39 -0
  209. package/dist/query/response.js +11 -0
  210. package/dist/query/response.js.map +1 -0
  211. package/dist/surfacing/engine.js +1 -1
  212. package/dist/surfacing/engine.js.map +1 -1
  213. package/dist/testing/memoryAdapter.js +0 -1
  214. package/dist/testing/memoryAdapter.js.map +1 -1
  215. package/dist/timeframe/tz.js +17 -6
  216. package/dist/timeframe/tz.js.map +1 -1
  217. package/dist/tracker/createTracker.js +13 -1
  218. package/dist/tracker/createTracker.js.map +1 -1
  219. package/dist/tracker/sinks/ga4.d.ts +21 -0
  220. package/dist/tracker/sinks/ga4.js +26 -0
  221. package/dist/tracker/sinks/ga4.js.map +1 -0
  222. package/dist/tracker/types.d.ts +5 -0
  223. package/dist/translations/ar.js +127 -1
  224. package/dist/translations/ar.js.map +1 -1
  225. package/dist/translations/de.js +127 -1
  226. package/dist/translations/de.js.map +1 -1
  227. package/dist/translations/en.js +127 -1
  228. package/dist/translations/en.js.map +1 -1
  229. package/dist/translations/es.js +127 -1
  230. package/dist/translations/es.js.map +1 -1
  231. package/dist/translations/fr.js +127 -1
  232. package/dist/translations/fr.js.map +1 -1
  233. package/dist/translations/id.js +127 -1
  234. package/dist/translations/id.js.map +1 -1
  235. package/dist/translations/keys.d.ts +126 -0
  236. package/dist/translations/keys.js +127 -1
  237. package/dist/translations/keys.js.map +1 -1
  238. package/dist/translations/ko.js +127 -1
  239. package/dist/translations/ko.js.map +1 -1
  240. package/dist/translations/metricKeys.js +8 -2
  241. package/dist/translations/metricKeys.js.map +1 -1
  242. package/dist/translations/pt.js +127 -1
  243. package/dist/translations/pt.js.map +1 -1
  244. package/dist/translations/ru.js +127 -1
  245. package/dist/translations/ru.js.map +1 -1
  246. package/dist/translations/server.js.map +1 -1
  247. package/dist/translations/uk.js +127 -1
  248. package/dist/translations/uk.js.map +1 -1
  249. package/dist/translations/zh.js +127 -1
  250. package/dist/translations/zh.js.map +1 -1
  251. package/dist/view/AnalyticsNavLink.d.ts +19 -0
  252. package/dist/view/AnalyticsNavLink.js +40 -0
  253. package/dist/view/AnalyticsNavLink.js.map +1 -0
  254. package/dist/view/AnalyticsView.d.ts +23 -0
  255. package/dist/view/AnalyticsView.js +45 -0
  256. package/dist/view/AnalyticsView.js.map +1 -0
  257. package/dist/view/AnalyticsViewClient.d.ts +15 -0
  258. package/dist/view/AnalyticsViewClient.js +200 -0
  259. package/dist/view/AnalyticsViewClient.js.map +1 -0
  260. package/dist/view/authRedirect.js +32 -0
  261. package/dist/view/authRedirect.js.map +1 -0
  262. package/dist/view/conversionRate.js +18 -0
  263. package/dist/view/conversionRate.js.map +1 -0
  264. package/dist/view/dayRange.js +68 -0
  265. package/dist/view/dayRange.js.map +1 -0
  266. package/dist/view/gating.d.ts +1 -0
  267. package/dist/view/gating.js +142 -0
  268. package/dist/view/gating.js.map +1 -0
  269. package/dist/view/labels.js +64 -0
  270. package/dist/view/labels.js.map +1 -0
  271. package/dist/view/registerView.js +48 -0
  272. package/dist/view/registerView.js.map +1 -0
  273. package/dist/view/sections/Breakdowns.js +197 -0
  274. package/dist/view/sections/Breakdowns.js.map +1 -0
  275. package/dist/view/sections/EmptyStates.js +92 -0
  276. package/dist/view/sections/EmptyStates.js.map +1 -0
  277. package/dist/view/sections/FilterChips.js +46 -0
  278. package/dist/view/sections/FilterChips.js.map +1 -0
  279. package/dist/view/sections/GoalsPanel.js +82 -0
  280. package/dist/view/sections/GoalsPanel.js.map +1 -0
  281. package/dist/view/sections/OverviewCards.js +65 -0
  282. package/dist/view/sections/OverviewCards.js.map +1 -0
  283. package/dist/view/sections/RealtimeStrip.js +80 -0
  284. package/dist/view/sections/RealtimeStrip.js.map +1 -0
  285. package/dist/view/sections/Toolbar.js +186 -0
  286. package/dist/view/sections/Toolbar.js.map +1 -0
  287. package/dist/view/sections/Trend.js +125 -0
  288. package/dist/view/sections/Trend.js.map +1 -0
  289. package/dist/view/sections/styles.js +74 -0
  290. package/dist/view/sections/styles.js.map +1 -0
  291. package/dist/view/state.js +211 -0
  292. package/dist/view/state.js.map +1 -0
  293. package/dist/view/useViewQueries.js +153 -0
  294. package/dist/view/useViewQueries.js.map +1 -0
  295. package/dist/view/viewProps.d.ts +40 -0
  296. package/dist/view/viewProps.js +90 -0
  297. package/dist/view/viewProps.js.map +1 -0
  298. package/dist/widgets/AnalyticsBreakdownWidget.d.ts +2 -1
  299. package/dist/widgets/AnalyticsBreakdownWidget.js +78 -11
  300. package/dist/widgets/AnalyticsBreakdownWidget.js.map +1 -1
  301. package/dist/widgets/AnalyticsGoalsWidget.d.ts +14 -0
  302. package/dist/widgets/AnalyticsGoalsWidget.js +196 -0
  303. package/dist/widgets/AnalyticsGoalsWidget.js.map +1 -0
  304. package/dist/widgets/AnalyticsMetricWidget.d.ts +2 -1
  305. package/dist/widgets/AnalyticsMetricWidget.js +63 -13
  306. package/dist/widgets/AnalyticsMetricWidget.js.map +1 -1
  307. package/dist/widgets/AnalyticsRealtimeWidget.d.ts +2 -1
  308. package/dist/widgets/AnalyticsRealtimeWidget.js +44 -22
  309. package/dist/widgets/AnalyticsRealtimeWidget.js.map +1 -1
  310. package/dist/widgets/AnalyticsTrendWidget.d.ts +2 -1
  311. package/dist/widgets/AnalyticsTrendWidget.js +79 -16
  312. package/dist/widgets/AnalyticsTrendWidget.js.map +1 -1
  313. package/dist/widgets/RealtimeCounter.d.ts +4 -0
  314. package/dist/widgets/RealtimeCounter.js +10 -1
  315. package/dist/widgets/RealtimeCounter.js.map +1 -1
  316. package/dist/widgets/WidgetViewLink.js +17 -0
  317. package/dist/widgets/WidgetViewLink.js.map +1 -0
  318. package/dist/widgets/breakdownTypes.js +28 -1
  319. package/dist/widgets/breakdownTypes.js.map +1 -1
  320. package/dist/widgets/cardChrome.js +31 -7
  321. package/dist/widgets/cardChrome.js.map +1 -1
  322. package/dist/widgets/comparison.js +15 -1
  323. package/dist/widgets/comparison.js.map +1 -1
  324. package/dist/widgets/defaults.d.ts +6 -2
  325. package/dist/widgets/defaults.js +72 -25
  326. package/dist/widgets/defaults.js.map +1 -1
  327. package/dist/widgets/filterCaption.js +27 -0
  328. package/dist/widgets/filterCaption.js.map +1 -0
  329. package/dist/widgets/filterField.d.ts +19 -0
  330. package/dist/widgets/filterField.js +75 -0
  331. package/dist/widgets/filterField.js.map +1 -0
  332. package/dist/widgets/prepareWidgetRead.d.ts +7 -0
  333. package/dist/widgets/prepareWidgetRead.js +74 -0
  334. package/dist/widgets/prepareWidgetRead.js.map +1 -0
  335. package/dist/widgets/range.js +43 -12
  336. package/dist/widgets/range.js.map +1 -1
  337. package/dist/widgets/readForWidget.d.ts +24 -2
  338. package/dist/widgets/readForWidget.js +34 -48
  339. package/dist/widgets/readForWidget.js.map +1 -1
  340. package/dist/widgets/readForWidgetBreakdown.d.ts +32 -1
  341. package/dist/widgets/readForWidgetBreakdown.js +32 -42
  342. package/dist/widgets/readForWidgetBreakdown.js.map +1 -1
  343. package/dist/widgets/readForWidgetGoals.d.ts +67 -0
  344. package/dist/widgets/readForWidgetGoals.js +140 -0
  345. package/dist/widgets/readForWidgetGoals.js.map +1 -0
  346. package/dist/widgets/readForWidgetRealtime.d.ts +8 -0
  347. package/dist/widgets/readForWidgetRealtime.js +21 -20
  348. package/dist/widgets/readForWidgetRealtime.js.map +1 -1
  349. package/dist/widgets/readForWidgetSeries.d.ts +24 -1
  350. package/dist/widgets/readForWidgetSeries.js +63 -56
  351. package/dist/widgets/readForWidgetSeries.js.map +1 -1
  352. package/dist/widgets/readMeta.js +18 -0
  353. package/dist/widgets/readMeta.js.map +1 -0
  354. package/dist/widgets/registerWidgets.js +53 -7
  355. package/dist/widgets/registerWidgets.js.map +1 -1
  356. package/dist/widgets/types.d.ts +15 -0
  357. package/dist/widgets/types.js +12 -1
  358. package/dist/widgets/types.js.map +1 -1
  359. package/dist/widgets/viewLink.d.ts +22 -0
  360. package/dist/widgets/viewLink.js +86 -0
  361. package/dist/widgets/viewLink.js.map +1 -0
  362. package/package.json +9 -4
  363. package/dist/native/rollups/applyDistinctDeltas.js +0 -9
  364. package/dist/native/rollups/applyDistinctDeltas.js.map +0 -1
  365. package/dist/native/rollups/bumpRollup.js +0 -73
  366. package/dist/native/rollups/bumpRollup.js.map +0 -1
  367. package/dist/native/rollups/insertIfNew.js +0 -19
  368. package/dist/native/rollups/insertIfNew.js.map +0 -1
@@ -12,6 +12,14 @@ interface WidgetRealtimeResult {
12
12
  adapterId: string;
13
13
  activeNow: number;
14
14
  series: RealtimePoint[];
15
+ /** The source that answered, absent on a read that never reached one. */
16
+ provider?: string;
17
+ clamped?: boolean;
18
+ stale?: boolean;
19
+ filtersUnapplied?: boolean;
20
+ goalsUnresolved?: boolean;
21
+ /** True when the read hit the source's event scan cap, so the counts are a floor. */
22
+ sampled?: boolean;
15
23
  }
16
24
  interface ReadForWidgetRealtimeArgs {
17
25
  req: PayloadRequest;
@@ -1,6 +1,5 @@
1
- import { getRuntime } from "../plugin/runtime.js";
2
- import { satisfiesCapabilities } from "../core/capabilities.js";
3
- import { resolveReadContext } from "../core/scopedRead.js";
1
+ import { prepareWidgetRead } from "./prepareWidgetRead.js";
2
+ import { readMeta } from "./readMeta.js";
4
3
  import { kvCacheStore } from "../surfacing/cacheStore.js";
5
4
  //#region src/widgets/readForWidgetRealtime.ts
6
5
  const empty = (status, adapterId) => ({
@@ -17,33 +16,34 @@ const empty = (status, adapterId) => ({
17
16
  */
18
17
  const readForWidgetRealtime = async (args) => {
19
18
  const { req, metric, windowMinutes, adapterId, now } = args;
20
- const runtime = getRuntime(req.payload);
21
- if (!runtime) return empty("unavailable", adapterId ?? "");
22
- const ctx = await resolveReadContext({
23
- runtime,
19
+ const dateRange = {
20
+ start: /* @__PURE__ */ new Date(now.getTime() - windowMinutes * 6e4),
21
+ end: now
22
+ };
23
+ const prepared = await prepareWidgetRead({
24
24
  req,
25
+ now,
26
+ range: dateRange,
27
+ timezone: "UTC",
25
28
  adapterId,
26
- scope: args.scope
29
+ scope: args.scope,
30
+ requires: { realtime: true }
27
31
  });
28
- if (!ctx.ok) return empty("unavailable", adapterId ?? "");
29
- const adapter = ctx.adapter;
30
- if (!adapter.isConfigured()) return empty("not-configured", adapter.id);
31
- if (!adapter.realtime || !satisfiesCapabilities(adapter.capabilities, { realtime: true })) return empty("unavailable", adapter.id);
32
+ if (!prepared.ok) return empty(prepared.status === "not-configured" ? "not-configured" : "unavailable", prepared.adapterId);
33
+ const { runtime, adapter, queryScope } = prepared;
34
+ const realtime = adapter.realtime;
35
+ if (!realtime) return empty("unavailable", adapter.id);
32
36
  const ttlSeconds = runtime.ttl.realtime ?? adapter.capabilities.recommendedTtl.realtime;
33
37
  const bucket = Math.floor(now.getTime() / 1e3 / Math.max(1, ttlSeconds));
34
- const scopeKey = ctx.queryScope === void 0 ? "" : `:${encodeURIComponent(ctx.queryScope)}`;
38
+ const scopeKey = queryScope === void 0 ? "" : `:${encodeURIComponent(queryScope)}`;
35
39
  const key = `rt:${adapter.id}:${metric}:${windowMinutes}:${bucket}${scopeKey}`;
36
40
  const store = kvCacheStore(req.payload.kv);
37
41
  const cached = await store.get(key);
38
42
  if (cached) return cached;
39
- const dateRange = {
40
- start: /* @__PURE__ */ new Date(now.getTime() - windowMinutes * 6e4),
41
- end: now
42
- };
43
- const result = await adapter.realtime({
43
+ const result = await realtime({
44
44
  metrics: [metric],
45
45
  dateRange,
46
- scope: ctx.queryScope
46
+ scope: queryScope
47
47
  }, {});
48
48
  const out = {
49
49
  status: "ok",
@@ -52,7 +52,8 @@ const readForWidgetRealtime = async (args) => {
52
52
  series: result.rows.map((r) => ({
53
53
  date: r.timestamp ?? "",
54
54
  value: r.metrics[metric] ?? 0
55
- }))
55
+ })),
56
+ ...readMeta(result)
56
57
  };
57
58
  await store.set(key, out, ttlSeconds);
58
59
  return out;
@@ -1 +1 @@
1
- {"version":3,"file":"readForWidgetRealtime.js","names":[],"sources":["../../src/widgets/readForWidgetRealtime.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\nimport { satisfiesCapabilities } from '../core/capabilities'\nimport type { AnalyticsAdapter, MetricKey } from '../core/contract'\nimport { resolveReadContext } from '../core/scopedRead'\nimport { getRuntime } from '../plugin/runtime'\nimport { kvCacheStore } from '../surfacing/cacheStore'\n\nexport type WidgetRealtimeStatus = 'ok' | 'not-configured' | 'unavailable'\n\nexport interface RealtimePoint {\n\tdate: string\n\tvalue: number\n}\n\nexport interface WidgetRealtimeResult {\n\tstatus: WidgetRealtimeStatus\n\tadapterId: string\n\tactiveNow: number\n\tseries: RealtimePoint[]\n}\n\nexport interface ReadForWidgetRealtimeArgs {\n\treq: PayloadRequest\n\tmetric: MetricKey\n\twindowMinutes: number\n\tadapterId?: string\n\tnow: Date\n\t/** Explicit scope override; omitted resolves via the plugin's scopeResolver. */\n\tscope?: string | null\n}\n\nconst empty = (status: WidgetRealtimeStatus, adapterId: string): WidgetRealtimeResult => ({\n\tstatus,\n\tadapterId,\n\tactiveNow: 0,\n\tseries: [],\n})\n\n/**\n * Site-wide realtime read for the \"active now\" widget. The window arrives as a\n * dateRange (now - windowMinutes -> now). Cached under a realtime-specific key bucketed\n * to the realtime TTL: it is deliberately NOT routed through the engine, whose key\n * day-snaps the range (so a \"last 30 min\" read would collide with a \"today\" aggregate).\n */\nexport const readForWidgetRealtime = async (\n\targs: ReadForWidgetRealtimeArgs\n): Promise<WidgetRealtimeResult> => {\n\tconst { req, metric, windowMinutes, adapterId, now } = args\n\tconst runtime = getRuntime(req.payload)\n\tif (!runtime) {\n\t\treturn empty('unavailable', adapterId ?? '')\n\t}\n\tconst ctx = await resolveReadContext({ runtime, req, adapterId, scope: args.scope })\n\tif (!ctx.ok) {\n\t\treturn empty('unavailable', adapterId ?? '')\n\t}\n\tconst adapter: AnalyticsAdapter = ctx.adapter\n\tif (!adapter.isConfigured()) {\n\t\treturn empty('not-configured', adapter.id)\n\t}\n\tif (!adapter.realtime || !satisfiesCapabilities(adapter.capabilities, { realtime: true })) {\n\t\treturn empty('unavailable', adapter.id)\n\t}\n\n\tconst ttlSeconds = runtime.ttl.realtime ?? adapter.capabilities.recommendedTtl.realtime\n\tconst bucket = Math.floor(now.getTime() / 1000 / Math.max(1, ttlSeconds))\n\tconst scopeKey = ctx.queryScope === undefined ? '' : `:${encodeURIComponent(ctx.queryScope)}`\n\tconst key = `rt:${adapter.id}:${metric}:${windowMinutes}:${bucket}${scopeKey}`\n\tconst store = kvCacheStore(req.payload.kv)\n\tconst cached = await store.get<WidgetRealtimeResult>(key)\n\tif (cached) {\n\t\treturn cached\n\t}\n\n\tconst dateRange = { start: new Date(now.getTime() - windowMinutes * 60_000), end: now }\n\tconst result = await adapter.realtime({ metrics: [metric], dateRange, scope: ctx.queryScope }, {})\n\tconst out: WidgetRealtimeResult = {\n\t\tstatus: 'ok',\n\t\tadapterId: adapter.id,\n\t\tactiveNow: result.totals?.[metric] ?? 0,\n\t\tseries: result.rows.map((r) => ({ date: r.timestamp ?? '', value: r.metrics[metric] ?? 0 })),\n\t}\n\tawait store.set(key, out, ttlSeconds)\n\treturn out\n}\n"],"mappings":";;;;;AA+BA,MAAM,SAAS,QAA8B,eAA6C;CACzF;CACA;CACA,WAAW;CACX,QAAQ,CAAC;AACV;;;;;;;AAQA,MAAa,wBAAwB,OACpC,SACmC;CACnC,MAAM,EAAE,KAAK,QAAQ,eAAe,WAAW,QAAQ;CACvD,MAAM,UAAU,WAAW,IAAI,OAAO;CACtC,IAAI,CAAC,SACJ,OAAO,MAAM,eAAe,aAAa,EAAE;CAE5C,MAAM,MAAM,MAAM,mBAAmB;EAAE;EAAS;EAAK;EAAW,OAAO,KAAK;CAAM,CAAC;CACnF,IAAI,CAAC,IAAI,IACR,OAAO,MAAM,eAAe,aAAa,EAAE;CAE5C,MAAM,UAA4B,IAAI;CACtC,IAAI,CAAC,QAAQ,aAAa,GACzB,OAAO,MAAM,kBAAkB,QAAQ,EAAE;CAE1C,IAAI,CAAC,QAAQ,YAAY,CAAC,sBAAsB,QAAQ,cAAc,EAAE,UAAU,KAAK,CAAC,GACvF,OAAO,MAAM,eAAe,QAAQ,EAAE;CAGvC,MAAM,aAAa,QAAQ,IAAI,YAAY,QAAQ,aAAa,eAAe;CAC/E,MAAM,SAAS,KAAK,MAAM,IAAI,QAAQ,IAAI,MAAO,KAAK,IAAI,GAAG,UAAU,CAAC;CACxE,MAAM,WAAW,IAAI,eAAe,KAAA,IAAY,KAAK,IAAI,mBAAmB,IAAI,UAAU;CAC1F,MAAM,MAAM,MAAM,QAAQ,GAAG,GAAG,OAAO,GAAG,cAAc,GAAG,SAAS;CACpE,MAAM,QAAQ,aAAa,IAAI,QAAQ,EAAE;CACzC,MAAM,SAAS,MAAM,MAAM,IAA0B,GAAG;CACxD,IAAI,QACH,OAAO;CAGR,MAAM,YAAY;EAAE,uBAAO,IAAI,KAAK,IAAI,QAAQ,IAAI,gBAAgB,GAAM;EAAG,KAAK;CAAI;CACtF,MAAM,SAAS,MAAM,QAAQ,SAAS;EAAE,SAAS,CAAC,MAAM;EAAG;EAAW,OAAO,IAAI;CAAW,GAAG,CAAC,CAAC;CACjG,MAAM,MAA4B;EACjC,QAAQ;EACR,WAAW,QAAQ;EACnB,WAAW,OAAO,SAAS,WAAW;EACtC,QAAQ,OAAO,KAAK,KAAK,OAAO;GAAE,MAAM,EAAE,aAAa;GAAI,OAAO,EAAE,QAAQ,WAAW;EAAE,EAAE;CAC5F;CACA,MAAM,MAAM,IAAI,KAAK,KAAK,UAAU;CACpC,OAAO;AACR"}
1
+ {"version":3,"file":"readForWidgetRealtime.js","names":[],"sources":["../../src/widgets/readForWidgetRealtime.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\nimport type { MetricKey } from '../core/contract'\nimport { kvCacheStore } from '../surfacing/cacheStore'\nimport { DEFAULT_TIMEZONE } from '../timeframe/tz'\nimport { prepareWidgetRead } from './prepareWidgetRead'\nimport { readMeta } from './readMeta'\n\nexport type WidgetRealtimeStatus = 'ok' | 'not-configured' | 'unavailable'\n\nexport interface RealtimePoint {\n\tdate: string\n\tvalue: number\n}\n\nexport interface WidgetRealtimeResult {\n\tstatus: WidgetRealtimeStatus\n\tadapterId: string\n\tactiveNow: number\n\tseries: RealtimePoint[]\n\t/** The source that answered, absent on a read that never reached one. */\n\tprovider?: string\n\tclamped?: boolean\n\tstale?: boolean\n\tfiltersUnapplied?: boolean\n\tgoalsUnresolved?: boolean\n\t/** True when the read hit the source's event scan cap, so the counts are a floor. */\n\tsampled?: boolean\n}\n\nexport interface ReadForWidgetRealtimeArgs {\n\treq: PayloadRequest\n\tmetric: MetricKey\n\twindowMinutes: number\n\tadapterId?: string\n\tnow: Date\n\t/** Explicit scope override; omitted resolves via the plugin's scopeResolver. */\n\tscope?: string | null\n}\n\nconst empty = (status: WidgetRealtimeStatus, adapterId: string): WidgetRealtimeResult => ({\n\tstatus,\n\tadapterId,\n\tactiveNow: 0,\n\tseries: [],\n})\n\n/**\n * Site-wide realtime read for the \"active now\" widget. The window arrives as a\n * dateRange (now - windowMinutes -> now). Cached under a realtime-specific key bucketed\n * to the realtime TTL: it is deliberately NOT routed through the engine, whose key\n * day-snaps the range (so a \"last 30 min\" read would collide with a \"today\" aggregate).\n */\nexport const readForWidgetRealtime = async (\n\targs: ReadForWidgetRealtimeArgs\n): Promise<WidgetRealtimeResult> => {\n\tconst { req, metric, windowMinutes, adapterId, now } = args\n\tconst dateRange = { start: new Date(now.getTime() - windowMinutes * 60_000), end: now }\n\t// The window is anchored on `now` and never rendered in a zone, so the poll skips the\n\t// install's timezone resolver rather than paying for it ahead of the cache check.\n\tconst prepared = await prepareWidgetRead({\n\t\treq,\n\t\tnow,\n\t\trange: dateRange,\n\t\ttimezone: DEFAULT_TIMEZONE,\n\t\tadapterId,\n\t\tscope: args.scope,\n\t\trequires: { realtime: true },\n\t})\n\tif (!prepared.ok) {\n\t\t// The window carries no filters, so `filter-unsupported` cannot arise here.\n\t\tconst status = prepared.status === 'not-configured' ? 'not-configured' : 'unavailable'\n\t\treturn empty(status, prepared.adapterId)\n\t}\n\tconst { runtime, adapter, queryScope } = prepared\n\t// The capability says the source counts live visitors; the hook is what reads them.\n\tconst realtime = adapter.realtime\n\tif (!realtime) {\n\t\treturn empty('unavailable', adapter.id)\n\t}\n\n\tconst ttlSeconds = runtime.ttl.realtime ?? adapter.capabilities.recommendedTtl.realtime\n\tconst bucket = Math.floor(now.getTime() / 1000 / Math.max(1, ttlSeconds))\n\tconst scopeKey = queryScope === undefined ? '' : `:${encodeURIComponent(queryScope)}`\n\tconst key = `rt:${adapter.id}:${metric}:${windowMinutes}:${bucket}${scopeKey}`\n\tconst store = kvCacheStore(req.payload.kv)\n\tconst cached = await store.get<WidgetRealtimeResult>(key)\n\tif (cached) {\n\t\treturn cached\n\t}\n\n\tconst result = await realtime({ metrics: [metric], dateRange, scope: queryScope }, {})\n\tconst out: WidgetRealtimeResult = {\n\t\tstatus: 'ok',\n\t\tadapterId: adapter.id,\n\t\tactiveNow: result.totals?.[metric] ?? 0,\n\t\tseries: result.rows.map((r) => ({ date: r.timestamp ?? '', value: r.metrics[metric] ?? 0 })),\n\t\t...readMeta(result),\n\t}\n\tawait store.set(key, out, ttlSeconds)\n\treturn out\n}\n"],"mappings":";;;;AAuCA,MAAM,SAAS,QAA8B,eAA6C;CACzF;CACA;CACA,WAAW;CACX,QAAQ,CAAC;AACV;;;;;;;AAQA,MAAa,wBAAwB,OACpC,SACmC;CACnC,MAAM,EAAE,KAAK,QAAQ,eAAe,WAAW,QAAQ;CACvD,MAAM,YAAY;EAAE,uBAAO,IAAI,KAAK,IAAI,QAAQ,IAAI,gBAAgB,GAAM;EAAG,KAAK;CAAI;CAGtF,MAAM,WAAW,MAAM,kBAAkB;EACxC;EACA;EACA,OAAO;EACP,UAAA;EACA;EACA,OAAO,KAAK;EACZ,UAAU,EAAE,UAAU,KAAK;CAC5B,CAAC;CACD,IAAI,CAAC,SAAS,IAGb,OAAO,MADQ,SAAS,WAAW,mBAAmB,mBAAmB,eACpD,SAAS,SAAS;CAExC,MAAM,EAAE,SAAS,SAAS,eAAe;CAEzC,MAAM,WAAW,QAAQ;CACzB,IAAI,CAAC,UACJ,OAAO,MAAM,eAAe,QAAQ,EAAE;CAGvC,MAAM,aAAa,QAAQ,IAAI,YAAY,QAAQ,aAAa,eAAe;CAC/E,MAAM,SAAS,KAAK,MAAM,IAAI,QAAQ,IAAI,MAAO,KAAK,IAAI,GAAG,UAAU,CAAC;CACxE,MAAM,WAAW,eAAe,KAAA,IAAY,KAAK,IAAI,mBAAmB,UAAU;CAClF,MAAM,MAAM,MAAM,QAAQ,GAAG,GAAG,OAAO,GAAG,cAAc,GAAG,SAAS;CACpE,MAAM,QAAQ,aAAa,IAAI,QAAQ,EAAE;CACzC,MAAM,SAAS,MAAM,MAAM,IAA0B,GAAG;CACxD,IAAI,QACH,OAAO;CAGR,MAAM,SAAS,MAAM,SAAS;EAAE,SAAS,CAAC,MAAM;EAAG;EAAW,OAAO;CAAW,GAAG,CAAC,CAAC;CACrF,MAAM,MAA4B;EACjC,QAAQ;EACR,WAAW,QAAQ;EACnB,WAAW,OAAO,SAAS,WAAW;EACtC,QAAQ,OAAO,KAAK,KAAK,OAAO;GAAE,MAAM,EAAE,aAAa;GAAI,OAAO,EAAE,QAAQ,WAAW;EAAE,EAAE;EAC3F,GAAG,SAAS,MAAM;CACnB;CACA,MAAM,MAAM,IAAI,KAAK,KAAK,UAAU;CACpC,OAAO;AACR"}
@@ -1,6 +1,6 @@
1
1
  import { AnalyticsFilter, DateRange, MetricKey } from "../core/contract.js";
2
2
  import { TimeframePreset } from "../timeframe/presets.js";
3
- import { WidgetReadStatus } from "./readForWidget.js";
3
+ import { WidgetReadStatus } from "./prepareWidgetRead.js";
4
4
  import { PayloadRequest } from "payload";
5
5
 
6
6
  //#region src/widgets/readForWidgetSeries.d.ts
@@ -16,11 +16,27 @@ interface WidgetSeriesResult {
16
16
  timezone: string;
17
17
  points: SeriesPoint[];
18
18
  total: number;
19
+ /** The source that answered, absent on a read that never reached one. */
20
+ provider?: string;
19
21
  clamped?: boolean;
22
+ /** True when the engine served a stale cache entry after a failed provider read. */
23
+ stale?: boolean;
24
+ /** True when the source answered without one of the filters the read carried. */
25
+ filtersUnapplied?: boolean;
26
+ /** True when the read hit the source's event scan cap, so the numbers are a floor. */
27
+ sampled?: boolean;
28
+ /** True when the source could not read the scope's goals, so a conversions series means nothing. */
29
+ goalsUnresolved?: boolean;
20
30
  /** Previous-window headline total, present only when the adapter supports comparison. */
21
31
  previousTotal?: number;
22
32
  /** The previous comparable window, present only when comparison ran. */
23
33
  comparisonRange?: DateRange;
34
+ /**
35
+ * The previous window's daily series, present only when `compare` was asked for and the
36
+ * adapter supports comparison. Zero-filled to the same length as `points`, so the
37
+ * previous window's day i overlays `points[i]`.
38
+ */
39
+ comparisonPoints?: SeriesPoint[];
24
40
  }
25
41
  interface ReadForWidgetSeriesArgs {
26
42
  req: PayloadRequest;
@@ -31,7 +47,14 @@ interface ReadForWidgetSeriesArgs {
31
47
  range?: DateRange;
32
48
  /** Explicit scope override; omitted resolves via the plugin's scopeResolver. */
33
49
  scope?: string | null;
50
+ /**
51
+ * Reporting timezone the caller already resolved, reused rather than resolved again so
52
+ * a caller-supplied `range` is read in the very timezone it was interpreted in.
53
+ */
54
+ timezone?: string;
34
55
  filters?: AnalyticsFilter[];
56
+ /** Also return the previous window's series, for the chart's comparison overlay. */
57
+ compare?: boolean;
35
58
  }
36
59
  /**
37
60
  * Site-wide time-series read for a trend widget: resolve the timeframe, pick the
@@ -1,10 +1,8 @@
1
1
  import { addDaysInTz, startOfDayInTz, zonedDayIso } from "../timeframe/tz.js";
2
- import { getRuntime, resolveTimezoneFor } from "../plugin/runtime.js";
3
- import { satisfiesCapabilities } from "../core/capabilities.js";
4
- import { supportsGranularity } from "../core/granularity.js";
5
- import { resolveReadContext } from "../core/scopedRead.js";
6
- import { resolveTimeframe } from "../timeframe/presets.js";
7
- import { previousWindow } from "./comparison.js";
2
+ import { comparisonOf } from "../core/capabilities.js";
3
+ import { previousWindow, withinLookback } from "./comparison.js";
4
+ import { prepareWidgetRead } from "./prepareWidgetRead.js";
5
+ import { readMeta } from "./readMeta.js";
8
6
  //#region src/widgets/readForWidgetSeries.ts
9
7
  const MAX_SERIES_DAYS = 366;
10
8
  /**
@@ -37,72 +35,74 @@ const fillDailySeries = (args) => {
37
35
  }));
38
36
  };
39
37
  /**
38
+ * Project a comparison series onto the primary axis: day i of the previous window overlays
39
+ * day i of the current one. Both windows span the same day count by construction, so this
40
+ * only guards a DST-shifted or clamped edge, silently truncating or zero-filling; a filled
41
+ * bucket borrows the axis day so every point still carries a real date.
42
+ */
43
+ const alignSeries = (points, axis) => points.length === axis.length ? points : axis.map((day, i) => points[i] ?? {
44
+ date: day.date,
45
+ value: 0
46
+ });
47
+ /**
40
48
  * Site-wide time-series read for a trend widget: resolve the timeframe, pick the
41
49
  * adapter, gate on the metric and day-granularity support, read through the engine,
42
50
  * then return a zero-filled daily series plus the headline total. Mirrors
43
51
  * `readForWidget` but yields points instead of a single value.
44
52
  */
45
53
  const readForWidgetSeries = async (args) => {
46
- const { req, metric, timeframe, adapterId, now, range, filters } = args;
47
- const fallback = (status, id) => ({
48
- status,
49
- adapterId: id,
50
- dateRange: range ?? resolveTimeframe(timeframe, now),
51
- timezone: "UTC",
52
- points: [],
53
- total: 0
54
- });
55
- const runtime = getRuntime(req.payload);
56
- if (!runtime) return fallback("unavailable", adapterId ?? "");
57
- const ctx = await resolveReadContext({
58
- runtime,
54
+ const { req, metric, timeframe, adapterId, now, range, filters, compare } = args;
55
+ const prepared = await prepareWidgetRead({
59
56
  req,
57
+ now,
58
+ timeframe,
60
59
  adapterId,
61
- scope: args.scope
60
+ scope: args.scope,
61
+ timezone: args.timezone,
62
+ range,
63
+ filters,
64
+ requires: { metrics: [metric] },
65
+ granularity: "day",
66
+ goalRead: () => ({ metrics: [metric] })
62
67
  });
63
- if (!ctx.ok) return fallback("unavailable", adapterId ?? "");
64
- const tz = await resolveTimezoneFor(runtime, req, ctx.scope);
65
- const dateRange = range ?? resolveTimeframe(timeframe, now, tz);
68
+ if (!prepared.ok) return {
69
+ status: prepared.status,
70
+ adapterId: prepared.adapterId,
71
+ dateRange: prepared.dateRange,
72
+ timezone: prepared.tz,
73
+ points: [],
74
+ total: 0
75
+ };
76
+ const { runtime, adapter, tz, dateRange, goalSlugs } = prepared;
66
77
  const base = {
67
78
  dateRange,
68
79
  timezone: tz,
69
80
  points: [],
70
81
  total: 0
71
82
  };
72
- const adapter = ctx.adapter;
73
- if (!adapter.isConfigured()) return {
74
- status: "not-configured",
75
- adapterId: adapter.id,
76
- ...base
77
- };
78
- if (!satisfiesCapabilities(adapter.capabilities, {
83
+ const previousRange = runtime.comparison && comparisonOf(adapter.capabilities) ? previousWindow(dateRange, tz) : null;
84
+ const comparisonRange = previousRange && withinLookback(previousRange, adapter.capabilities.maxLookbackDays, {
85
+ tz,
86
+ now
87
+ }) ? previousRange : void 0;
88
+ const readBase = {
79
89
  metrics: [metric],
80
- ...filters && filters.length > 0 ? {
81
- filters: filters.map((f) => f.dimension),
82
- filterOperators: filters.map((f) => f.operator)
83
- } : {}
84
- }) || !supportsGranularity(adapter.capabilities, "day")) return {
85
- status: "unavailable",
86
- adapterId: adapter.id,
87
- ...base
90
+ filters,
91
+ timezone: tz,
92
+ scope: prepared.queryScope,
93
+ ...goalSlugs === void 0 ? {} : { goalSlugs }
88
94
  };
89
- const comparisonRange = runtime.comparison && adapter.capabilities.comparison ? previousWindow(dateRange, tz) ?? void 0 : void 0;
90
95
  let result;
91
96
  let previous;
92
97
  try {
93
98
  [result, previous] = await Promise.all([runtime.engine.read(adapter, {
94
- metrics: [metric],
99
+ ...readBase,
95
100
  dateRange,
96
- granularity: "day",
97
- filters,
98
- timezone: tz,
99
- scope: ctx.queryScope
101
+ granularity: "day"
100
102
  }), comparisonRange ? runtime.engine.read(adapter, {
101
- metrics: [metric],
103
+ ...readBase,
102
104
  dateRange: comparisonRange,
103
- filters,
104
- timezone: tz,
105
- scope: ctx.queryScope
105
+ ...compare ? { granularity: "day" } : {}
106
106
  }) : void 0]);
107
107
  } catch {
108
108
  return {
@@ -112,21 +112,28 @@ const readForWidgetSeries = async (args) => {
112
112
  };
113
113
  }
114
114
  const previousTotal = previous ? previous.totals?.[metric] : void 0;
115
+ const points = fillDailySeries({
116
+ rows: result.rows,
117
+ dateRange,
118
+ metric,
119
+ tz
120
+ });
115
121
  return {
116
122
  status: "ok",
117
123
  adapterId: adapter.id,
118
124
  dateRange,
119
125
  timezone: tz,
120
- points: fillDailySeries({
121
- rows: result.rows,
122
- dateRange,
123
- metric,
124
- tz
125
- }),
126
+ points,
126
127
  total: result.totals?.[metric] ?? 0,
127
- clamped: result.meta.clamped ?? false,
128
+ ...readMeta(result),
128
129
  previousTotal,
129
- comparisonRange
130
+ comparisonRange,
131
+ ...compare && previous && comparisonRange ? { comparisonPoints: alignSeries(fillDailySeries({
132
+ rows: previous.rows,
133
+ dateRange: comparisonRange,
134
+ metric,
135
+ tz
136
+ }), points) } : {}
130
137
  };
131
138
  };
132
139
  //#endregion
@@ -1 +1 @@
1
- {"version":3,"file":"readForWidgetSeries.js","names":[],"sources":["../../src/widgets/readForWidgetSeries.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\nimport { satisfiesCapabilities } from '../core/capabilities'\nimport type {\n\tAnalyticsAdapter,\n\tAnalyticsFilter,\n\tAnalyticsResult,\n\tAnalyticsRow,\n\tDateRange,\n\tMetricKey,\n} from '../core/contract'\nimport { supportsGranularity } from '../core/granularity'\nimport { resolveReadContext } from '../core/scopedRead'\nimport { getRuntime, resolveTimezoneFor } from '../plugin/runtime'\nimport { resolveTimeframe, type TimeframePreset } from '../timeframe/presets'\nimport { addDaysInTz, DEFAULT_TIMEZONE, startOfDayInTz, zonedDayIso } from '../timeframe/tz'\nimport { previousWindow } from './comparison'\nimport type { WidgetReadStatus } from './readForWidget'\n\nexport interface SeriesPoint {\n\tdate: string\n\tvalue: number\n}\n\nexport interface WidgetSeriesResult {\n\tstatus: WidgetReadStatus\n\tadapterId: string\n\tdateRange: DateRange\n\t/** Reporting timezone the read resolved in; the trend axis buckets in it. */\n\ttimezone: string\n\tpoints: SeriesPoint[]\n\ttotal: number\n\tclamped?: boolean\n\t/** Previous-window headline total, present only when the adapter supports comparison. */\n\tpreviousTotal?: number\n\t/** The previous comparable window, present only when comparison ran. */\n\tcomparisonRange?: DateRange\n}\n\nexport interface ReadForWidgetSeriesArgs {\n\treq: PayloadRequest\n\tmetric: MetricKey\n\ttimeframe: TimeframePreset\n\tadapterId?: string\n\tnow: Date\n\trange?: DateRange\n\t/** Explicit scope override; omitted resolves via the plugin's scopeResolver. */\n\tscope?: string | null\n\tfilters?: AnalyticsFilter[]\n}\n\nconst MAX_SERIES_DAYS = 366\n\n/**\n * Project time-series rows onto a contiguous daily axis, zero-filling gaps. Days are\n * counted in `tz` (defaulting to UTC), so a reporting-timezone read aligns each bucket\n * to that zone's midnight. The axis is capped at the most recent `MAX_SERIES_DAYS` so\n * an unbounded range (all time) stays a bounded, drawable sparkline; the headline total\n * still reflects the full range.\n */\nexport const fillDailySeries = (args: {\n\trows: AnalyticsRow[]\n\tdateRange: DateRange\n\tmetric: MetricKey\n\ttz?: string\n}): SeriesPoint[] => {\n\tconst { rows, dateRange, metric } = args\n\tconst tz = args.tz ?? DEFAULT_TIMEZONE\n\tconst lastDay = startOfDayInTz(dateRange.end, tz)\n\tconst requestedStart = startOfDayInTz(dateRange.start, tz)\n\tconst byDay = new Map<string, number>()\n\tfor (const row of rows) {\n\t\tif (!row.timestamp) {\n\t\t\tcontinue\n\t\t}\n\t\tconst day = zonedDayIso(new Date(row.timestamp), tz)\n\t\tbyDay.set(day, (byDay.get(day) ?? 0) + (row.metrics[metric] ?? 0))\n\t}\n\t// Walk calendar days back from the last day so DST-length days never mis-step, capping\n\t// the axis at MAX_SERIES_DAYS or the requested start, whichever is more recent.\n\tconst isoDays: string[] = []\n\tlet cursor = lastDay\n\tfor (let i = 0; i < MAX_SERIES_DAYS && cursor.getTime() >= requestedStart.getTime(); i += 1) {\n\t\tisoDays.push(cursor.toISOString())\n\t\tcursor = addDaysInTz(cursor, -1, tz)\n\t}\n\treturn isoDays.reverse().map((date) => ({ date, value: byDay.get(date) ?? 0 }))\n}\n\n/**\n * Site-wide time-series read for a trend widget: resolve the timeframe, pick the\n * adapter, gate on the metric and day-granularity support, read through the engine,\n * then return a zero-filled daily series plus the headline total. Mirrors\n * `readForWidget` but yields points instead of a single value.\n */\nexport const readForWidgetSeries = async (\n\targs: ReadForWidgetSeriesArgs\n): Promise<WidgetSeriesResult> => {\n\tconst { req, metric, timeframe, adapterId, now, range, filters } = args\n\tconst fallback = (status: WidgetReadStatus, id: string): WidgetSeriesResult => ({\n\t\tstatus,\n\t\tadapterId: id,\n\t\tdateRange: range ?? resolveTimeframe(timeframe, now),\n\t\ttimezone: DEFAULT_TIMEZONE,\n\t\tpoints: [],\n\t\ttotal: 0,\n\t})\n\n\tconst runtime = getRuntime(req.payload)\n\tif (!runtime) {\n\t\treturn fallback('unavailable', adapterId ?? '')\n\t}\n\tconst ctx = await resolveReadContext({ runtime, req, adapterId, scope: args.scope })\n\tif (!ctx.ok) {\n\t\treturn fallback('unavailable', adapterId ?? '')\n\t}\n\tconst tz = await resolveTimezoneFor(runtime, req, ctx.scope)\n\tconst dateRange = range ?? resolveTimeframe(timeframe, now, tz)\n\tconst base = { dateRange, timezone: tz, points: [] as SeriesPoint[], total: 0 }\n\tconst adapter: AnalyticsAdapter = ctx.adapter\n\tif (!adapter.isConfigured()) {\n\t\treturn { status: 'not-configured', adapterId: adapter.id, ...base }\n\t}\n\tif (\n\t\t!satisfiesCapabilities(adapter.capabilities, {\n\t\t\tmetrics: [metric],\n\t\t\t...(filters && filters.length > 0\n\t\t\t\t? {\n\t\t\t\t\t\tfilters: filters.map((f) => f.dimension),\n\t\t\t\t\t\tfilterOperators: filters.map((f) => f.operator),\n\t\t\t\t\t}\n\t\t\t\t: {}),\n\t\t}) ||\n\t\t!supportsGranularity(adapter.capabilities, 'day')\n\t) {\n\t\treturn { status: 'unavailable', adapterId: adapter.id, ...base }\n\t}\n\tconst comparisonRange =\n\t\truntime.comparison && adapter.capabilities.comparison\n\t\t\t? (previousWindow(dateRange, tz) ?? undefined)\n\t\t\t: undefined\n\tlet result: AnalyticsResult\n\tlet previous: AnalyticsResult | undefined\n\ttry {\n\t\t;[result, previous] = await Promise.all([\n\t\t\truntime.engine.read(adapter, {\n\t\t\t\tmetrics: [metric],\n\t\t\t\tdateRange,\n\t\t\t\tgranularity: 'day',\n\t\t\t\tfilters,\n\t\t\t\ttimezone: tz,\n\t\t\t\tscope: ctx.queryScope,\n\t\t\t}),\n\t\t\tcomparisonRange\n\t\t\t\t? runtime.engine.read(adapter, {\n\t\t\t\t\t\tmetrics: [metric],\n\t\t\t\t\t\tdateRange: comparisonRange,\n\t\t\t\t\t\tfilters,\n\t\t\t\t\t\ttimezone: tz,\n\t\t\t\t\t\tscope: ctx.queryScope,\n\t\t\t\t\t})\n\t\t\t\t: undefined,\n\t\t])\n\t} catch {\n\t\t// No cache entry (fresh or stale) survived the failed read; degrade like an\n\t\t// unsupported capability instead of throwing through the widget render tree.\n\t\treturn { status: 'unavailable', adapterId: adapter.id, ...base }\n\t}\n\tconst previousTotal = previous ? previous.totals?.[metric] : undefined\n\treturn {\n\t\tstatus: 'ok',\n\t\tadapterId: adapter.id,\n\t\tdateRange,\n\t\ttimezone: tz,\n\t\tpoints: fillDailySeries({ rows: result.rows, dateRange, metric, tz }),\n\t\ttotal: result.totals?.[metric] ?? 0,\n\t\tclamped: result.meta.clamped ?? false,\n\t\tpreviousTotal,\n\t\tcomparisonRange,\n\t}\n}\n"],"mappings":";;;;;;;;AAkDA,MAAM,kBAAkB;;;;;;;;AASxB,MAAa,mBAAmB,SAKX;CACpB,MAAM,EAAE,MAAM,WAAW,WAAW;CACpC,MAAM,KAAK,KAAK,MAAA;CAChB,MAAM,UAAU,eAAe,UAAU,KAAK,EAAE;CAChD,MAAM,iBAAiB,eAAe,UAAU,OAAO,EAAE;CACzD,MAAM,wBAAQ,IAAI,IAAoB;CACtC,KAAK,MAAM,OAAO,MAAM;EACvB,IAAI,CAAC,IAAI,WACR;EAED,MAAM,MAAM,YAAY,IAAI,KAAK,IAAI,SAAS,GAAG,EAAE;EACnD,MAAM,IAAI,MAAM,MAAM,IAAI,GAAG,KAAK,MAAM,IAAI,QAAQ,WAAW,EAAE;CAClE;CAGA,MAAM,UAAoB,CAAC;CAC3B,IAAI,SAAS;CACb,KAAK,IAAI,IAAI,GAAG,IAAI,mBAAmB,OAAO,QAAQ,KAAK,eAAe,QAAQ,GAAG,KAAK,GAAG;EAC5F,QAAQ,KAAK,OAAO,YAAY,CAAC;EACjC,SAAS,YAAY,QAAQ,IAAI,EAAE;CACpC;CACA,OAAO,QAAQ,QAAQ,EAAE,KAAK,UAAU;EAAE;EAAM,OAAO,MAAM,IAAI,IAAI,KAAK;CAAE,EAAE;AAC/E;;;;;;;AAQA,MAAa,sBAAsB,OAClC,SACiC;CACjC,MAAM,EAAE,KAAK,QAAQ,WAAW,WAAW,KAAK,OAAO,YAAY;CACnE,MAAM,YAAY,QAA0B,QAAoC;EAC/E;EACA,WAAW;EACX,WAAW,SAAS,iBAAiB,WAAW,GAAG;EACnD,UAAA;EACA,QAAQ,CAAC;EACT,OAAO;CACR;CAEA,MAAM,UAAU,WAAW,IAAI,OAAO;CACtC,IAAI,CAAC,SACJ,OAAO,SAAS,eAAe,aAAa,EAAE;CAE/C,MAAM,MAAM,MAAM,mBAAmB;EAAE;EAAS;EAAK;EAAW,OAAO,KAAK;CAAM,CAAC;CACnF,IAAI,CAAC,IAAI,IACR,OAAO,SAAS,eAAe,aAAa,EAAE;CAE/C,MAAM,KAAK,MAAM,mBAAmB,SAAS,KAAK,IAAI,KAAK;CAC3D,MAAM,YAAY,SAAS,iBAAiB,WAAW,KAAK,EAAE;CAC9D,MAAM,OAAO;EAAE;EAAW,UAAU;EAAI,QAAQ,CAAC;EAAoB,OAAO;CAAE;CAC9E,MAAM,UAA4B,IAAI;CACtC,IAAI,CAAC,QAAQ,aAAa,GACzB,OAAO;EAAE,QAAQ;EAAkB,WAAW,QAAQ;EAAI,GAAG;CAAK;CAEnE,IACC,CAAC,sBAAsB,QAAQ,cAAc;EAC5C,SAAS,CAAC,MAAM;EAChB,GAAI,WAAW,QAAQ,SAAS,IAC7B;GACA,SAAS,QAAQ,KAAK,MAAM,EAAE,SAAS;GACvC,iBAAiB,QAAQ,KAAK,MAAM,EAAE,QAAQ;EAC/C,IACC,CAAC;CACL,CAAC,KACD,CAAC,oBAAoB,QAAQ,cAAc,KAAK,GAEhD,OAAO;EAAE,QAAQ;EAAe,WAAW,QAAQ;EAAI,GAAG;CAAK;CAEhE,MAAM,kBACL,QAAQ,cAAc,QAAQ,aAAa,aACvC,eAAe,WAAW,EAAE,KAAK,KAAA,IAClC,KAAA;CACJ,IAAI;CACJ,IAAI;CACJ,IAAI;EACF,CAAC,QAAQ,YAAY,MAAM,QAAQ,IAAI,CACvC,QAAQ,OAAO,KAAK,SAAS;GAC5B,SAAS,CAAC,MAAM;GAChB;GACA,aAAa;GACb;GACA,UAAU;GACV,OAAO,IAAI;EACZ,CAAC,GACD,kBACG,QAAQ,OAAO,KAAK,SAAS;GAC7B,SAAS,CAAC,MAAM;GAChB,WAAW;GACX;GACA,UAAU;GACV,OAAO,IAAI;EACZ,CAAC,IACA,KAAA,CACJ,CAAC;CACF,QAAQ;EAGP,OAAO;GAAE,QAAQ;GAAe,WAAW,QAAQ;GAAI,GAAG;EAAK;CAChE;CACA,MAAM,gBAAgB,WAAW,SAAS,SAAS,UAAU,KAAA;CAC7D,OAAO;EACN,QAAQ;EACR,WAAW,QAAQ;EACnB;EACA,UAAU;EACV,QAAQ,gBAAgB;GAAE,MAAM,OAAO;GAAM;GAAW;GAAQ;EAAG,CAAC;EACpE,OAAO,OAAO,SAAS,WAAW;EAClC,SAAS,OAAO,KAAK,WAAW;EAChC;EACA;CACD;AACD"}
1
+ {"version":3,"file":"readForWidgetSeries.js","names":[],"sources":["../../src/widgets/readForWidgetSeries.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\nimport { comparisonOf } from '../core/capabilities'\nimport type {\n\tAnalyticsFilter,\n\tAnalyticsResult,\n\tAnalyticsRow,\n\tDateRange,\n\tMetricKey,\n} from '../core/contract'\nimport type { TimeframePreset } from '../timeframe/presets'\nimport { addDaysInTz, DEFAULT_TIMEZONE, startOfDayInTz, zonedDayIso } from '../timeframe/tz'\nimport { previousWindow, withinLookback } from './comparison'\nimport { prepareWidgetRead, type WidgetReadStatus } from './prepareWidgetRead'\nimport { readMeta } from './readMeta'\n\nexport interface SeriesPoint {\n\tdate: string\n\tvalue: number\n}\n\nexport interface WidgetSeriesResult {\n\tstatus: WidgetReadStatus\n\tadapterId: string\n\tdateRange: DateRange\n\t/** Reporting timezone the read resolved in; the trend axis buckets in it. */\n\ttimezone: string\n\tpoints: SeriesPoint[]\n\ttotal: number\n\t/** The source that answered, absent on a read that never reached one. */\n\tprovider?: string\n\tclamped?: boolean\n\t/** True when the engine served a stale cache entry after a failed provider read. */\n\tstale?: boolean\n\t/** True when the source answered without one of the filters the read carried. */\n\tfiltersUnapplied?: boolean\n\t/** True when the read hit the source's event scan cap, so the numbers are a floor. */\n\tsampled?: boolean\n\t/** True when the source could not read the scope's goals, so a conversions series means nothing. */\n\tgoalsUnresolved?: boolean\n\t/** Previous-window headline total, present only when the adapter supports comparison. */\n\tpreviousTotal?: number\n\t/** The previous comparable window, present only when comparison ran. */\n\tcomparisonRange?: DateRange\n\t/**\n\t * The previous window's daily series, present only when `compare` was asked for and the\n\t * adapter supports comparison. Zero-filled to the same length as `points`, so the\n\t * previous window's day i overlays `points[i]`.\n\t */\n\tcomparisonPoints?: SeriesPoint[]\n}\n\nexport interface ReadForWidgetSeriesArgs {\n\treq: PayloadRequest\n\tmetric: MetricKey\n\ttimeframe: TimeframePreset\n\tadapterId?: string\n\tnow: Date\n\trange?: DateRange\n\t/** Explicit scope override; omitted resolves via the plugin's scopeResolver. */\n\tscope?: string | null\n\t/**\n\t * Reporting timezone the caller already resolved, reused rather than resolved again so\n\t * a caller-supplied `range` is read in the very timezone it was interpreted in.\n\t */\n\ttimezone?: string\n\tfilters?: AnalyticsFilter[]\n\t/** Also return the previous window's series, for the chart's comparison overlay. */\n\tcompare?: boolean\n}\n\nconst MAX_SERIES_DAYS = 366\n\n/**\n * Project time-series rows onto a contiguous daily axis, zero-filling gaps. Days are\n * counted in `tz` (defaulting to UTC), so a reporting-timezone read aligns each bucket\n * to that zone's midnight. The axis is capped at the most recent `MAX_SERIES_DAYS` so\n * an unbounded range (all time) stays a bounded, drawable sparkline; the headline total\n * still reflects the full range.\n */\nexport const fillDailySeries = (args: {\n\trows: AnalyticsRow[]\n\tdateRange: DateRange\n\tmetric: MetricKey\n\ttz?: string\n}): SeriesPoint[] => {\n\tconst { rows, dateRange, metric } = args\n\tconst tz = args.tz ?? DEFAULT_TIMEZONE\n\tconst lastDay = startOfDayInTz(dateRange.end, tz)\n\tconst requestedStart = startOfDayInTz(dateRange.start, tz)\n\tconst byDay = new Map<string, number>()\n\tfor (const row of rows) {\n\t\tif (!row.timestamp) {\n\t\t\tcontinue\n\t\t}\n\t\tconst day = zonedDayIso(new Date(row.timestamp), tz)\n\t\tbyDay.set(day, (byDay.get(day) ?? 0) + (row.metrics[metric] ?? 0))\n\t}\n\t// Walk calendar days back from the last day so DST-length days never mis-step, capping\n\t// the axis at MAX_SERIES_DAYS or the requested start, whichever is more recent.\n\tconst isoDays: string[] = []\n\tlet cursor = lastDay\n\tfor (let i = 0; i < MAX_SERIES_DAYS && cursor.getTime() >= requestedStart.getTime(); i += 1) {\n\t\tisoDays.push(cursor.toISOString())\n\t\tcursor = addDaysInTz(cursor, -1, tz)\n\t}\n\treturn isoDays.reverse().map((date) => ({ date, value: byDay.get(date) ?? 0 }))\n}\n\n/**\n * Project a comparison series onto the primary axis: day i of the previous window overlays\n * day i of the current one. Both windows span the same day count by construction, so this\n * only guards a DST-shifted or clamped edge, silently truncating or zero-filling; a filled\n * bucket borrows the axis day so every point still carries a real date.\n */\nconst alignSeries = (points: SeriesPoint[], axis: SeriesPoint[]): SeriesPoint[] =>\n\tpoints.length === axis.length\n\t\t? points\n\t\t: axis.map((day, i) => points[i] ?? { date: day.date, value: 0 })\n\n/**\n * Site-wide time-series read for a trend widget: resolve the timeframe, pick the\n * adapter, gate on the metric and day-granularity support, read through the engine,\n * then return a zero-filled daily series plus the headline total. Mirrors\n * `readForWidget` but yields points instead of a single value.\n */\nexport const readForWidgetSeries = async (\n\targs: ReadForWidgetSeriesArgs\n): Promise<WidgetSeriesResult> => {\n\tconst { req, metric, timeframe, adapterId, now, range, filters, compare } = args\n\n\tconst prepared = await prepareWidgetRead({\n\t\treq,\n\t\tnow,\n\t\ttimeframe,\n\t\tadapterId,\n\t\tscope: args.scope,\n\t\ttimezone: args.timezone,\n\t\trange,\n\t\tfilters,\n\t\trequires: { metrics: [metric] },\n\t\tgranularity: 'day',\n\t\tgoalRead: () => ({ metrics: [metric] }),\n\t})\n\tif (!prepared.ok) {\n\t\treturn {\n\t\t\tstatus: prepared.status,\n\t\t\tadapterId: prepared.adapterId,\n\t\t\tdateRange: prepared.dateRange,\n\t\t\ttimezone: prepared.tz,\n\t\t\tpoints: [],\n\t\t\ttotal: 0,\n\t\t}\n\t}\n\tconst { runtime, adapter, tz, dateRange, goalSlugs } = prepared\n\tconst base = { dateRange, timezone: tz, points: [] as SeriesPoint[], total: 0 }\n\tconst previousRange =\n\t\truntime.comparison && comparisonOf(adapter.capabilities) ? previousWindow(dateRange, tz) : null\n\tconst comparisonRange =\n\t\tpreviousRange &&\n\t\twithinLookback(previousRange, adapter.capabilities.maxLookbackDays, { tz, now })\n\t\t\t? previousRange\n\t\t\t: undefined\n\tconst readBase = {\n\t\tmetrics: [metric],\n\t\tfilters,\n\t\ttimezone: tz,\n\t\tscope: prepared.queryScope,\n\t\t...(goalSlugs === undefined ? {} : { goalSlugs }),\n\t}\n\tlet result: AnalyticsResult\n\tlet previous: AnalyticsResult | undefined\n\ttry {\n\t\t;[result, previous] = await Promise.all([\n\t\t\truntime.engine.read(adapter, { ...readBase, dateRange, granularity: 'day' }),\n\t\t\tcomparisonRange\n\t\t\t\t? runtime.engine.read(adapter, {\n\t\t\t\t\t\t...readBase,\n\t\t\t\t\t\tdateRange: comparisonRange,\n\t\t\t\t\t\t// The overlay needs the previous window bucketed like the primary; the delta\n\t\t\t\t\t\t// alone only needs its total, so the read stays as it was without `compare`.\n\t\t\t\t\t\t...(compare ? { granularity: 'day' as const } : {}),\n\t\t\t\t\t})\n\t\t\t\t: undefined,\n\t\t])\n\t} catch {\n\t\t// No cache entry (fresh or stale) survived the failed read; degrade like an\n\t\t// unsupported capability instead of throwing through the widget render tree.\n\t\treturn { status: 'unavailable', adapterId: adapter.id, ...base }\n\t}\n\tconst previousTotal = previous ? previous.totals?.[metric] : undefined\n\tconst points = fillDailySeries({ rows: result.rows, dateRange, metric, tz })\n\treturn {\n\t\tstatus: 'ok',\n\t\tadapterId: adapter.id,\n\t\tdateRange,\n\t\ttimezone: tz,\n\t\tpoints,\n\t\ttotal: result.totals?.[metric] ?? 0,\n\t\t...readMeta(result),\n\t\tpreviousTotal,\n\t\tcomparisonRange,\n\t\t...(compare && previous && comparisonRange\n\t\t\t? {\n\t\t\t\t\tcomparisonPoints: alignSeries(\n\t\t\t\t\t\tfillDailySeries({ rows: previous.rows, dateRange: comparisonRange, metric, tz }),\n\t\t\t\t\t\tpoints\n\t\t\t\t\t),\n\t\t\t\t}\n\t\t\t: {}),\n\t}\n}\n"],"mappings":";;;;;;AAsEA,MAAM,kBAAkB;;;;;;;;AASxB,MAAa,mBAAmB,SAKX;CACpB,MAAM,EAAE,MAAM,WAAW,WAAW;CACpC,MAAM,KAAK,KAAK,MAAA;CAChB,MAAM,UAAU,eAAe,UAAU,KAAK,EAAE;CAChD,MAAM,iBAAiB,eAAe,UAAU,OAAO,EAAE;CACzD,MAAM,wBAAQ,IAAI,IAAoB;CACtC,KAAK,MAAM,OAAO,MAAM;EACvB,IAAI,CAAC,IAAI,WACR;EAED,MAAM,MAAM,YAAY,IAAI,KAAK,IAAI,SAAS,GAAG,EAAE;EACnD,MAAM,IAAI,MAAM,MAAM,IAAI,GAAG,KAAK,MAAM,IAAI,QAAQ,WAAW,EAAE;CAClE;CAGA,MAAM,UAAoB,CAAC;CAC3B,IAAI,SAAS;CACb,KAAK,IAAI,IAAI,GAAG,IAAI,mBAAmB,OAAO,QAAQ,KAAK,eAAe,QAAQ,GAAG,KAAK,GAAG;EAC5F,QAAQ,KAAK,OAAO,YAAY,CAAC;EACjC,SAAS,YAAY,QAAQ,IAAI,EAAE;CACpC;CACA,OAAO,QAAQ,QAAQ,EAAE,KAAK,UAAU;EAAE;EAAM,OAAO,MAAM,IAAI,IAAI,KAAK;CAAE,EAAE;AAC/E;;;;;;;AAQA,MAAM,eAAe,QAAuB,SAC3C,OAAO,WAAW,KAAK,SACpB,SACA,KAAK,KAAK,KAAK,MAAM,OAAO,MAAM;CAAE,MAAM,IAAI;CAAM,OAAO;AAAE,CAAC;;;;;;;AAQlE,MAAa,sBAAsB,OAClC,SACiC;CACjC,MAAM,EAAE,KAAK,QAAQ,WAAW,WAAW,KAAK,OAAO,SAAS,YAAY;CAE5E,MAAM,WAAW,MAAM,kBAAkB;EACxC;EACA;EACA;EACA;EACA,OAAO,KAAK;EACZ,UAAU,KAAK;EACf;EACA;EACA,UAAU,EAAE,SAAS,CAAC,MAAM,EAAE;EAC9B,aAAa;EACb,iBAAiB,EAAE,SAAS,CAAC,MAAM,EAAE;CACtC,CAAC;CACD,IAAI,CAAC,SAAS,IACb,OAAO;EACN,QAAQ,SAAS;EACjB,WAAW,SAAS;EACpB,WAAW,SAAS;EACpB,UAAU,SAAS;EACnB,QAAQ,CAAC;EACT,OAAO;CACR;CAED,MAAM,EAAE,SAAS,SAAS,IAAI,WAAW,cAAc;CACvD,MAAM,OAAO;EAAE;EAAW,UAAU;EAAI,QAAQ,CAAC;EAAoB,OAAO;CAAE;CAC9E,MAAM,gBACL,QAAQ,cAAc,aAAa,QAAQ,YAAY,IAAI,eAAe,WAAW,EAAE,IAAI;CAC5F,MAAM,kBACL,iBACA,eAAe,eAAe,QAAQ,aAAa,iBAAiB;EAAE;EAAI;CAAI,CAAC,IAC5E,gBACA,KAAA;CACJ,MAAM,WAAW;EAChB,SAAS,CAAC,MAAM;EAChB;EACA,UAAU;EACV,OAAO,SAAS;EAChB,GAAI,cAAc,KAAA,IAAY,CAAC,IAAI,EAAE,UAAU;CAChD;CACA,IAAI;CACJ,IAAI;CACJ,IAAI;EACF,CAAC,QAAQ,YAAY,MAAM,QAAQ,IAAI,CACvC,QAAQ,OAAO,KAAK,SAAS;GAAE,GAAG;GAAU;GAAW,aAAa;EAAM,CAAC,GAC3E,kBACG,QAAQ,OAAO,KAAK,SAAS;GAC7B,GAAG;GACH,WAAW;GAGX,GAAI,UAAU,EAAE,aAAa,MAAe,IAAI,CAAC;EAClD,CAAC,IACA,KAAA,CACJ,CAAC;CACF,QAAQ;EAGP,OAAO;GAAE,QAAQ;GAAe,WAAW,QAAQ;GAAI,GAAG;EAAK;CAChE;CACA,MAAM,gBAAgB,WAAW,SAAS,SAAS,UAAU,KAAA;CAC7D,MAAM,SAAS,gBAAgB;EAAE,MAAM,OAAO;EAAM;EAAW;EAAQ;CAAG,CAAC;CAC3E,OAAO;EACN,QAAQ;EACR,WAAW,QAAQ;EACnB;EACA,UAAU;EACV;EACA,OAAO,OAAO,SAAS,WAAW;EAClC,GAAG,SAAS,MAAM;EAClB;EACA;EACA,GAAI,WAAW,YAAY,kBACxB,EACA,kBAAkB,YACjB,gBAAgB;GAAE,MAAM,SAAS;GAAM,WAAW;GAAiB;GAAQ;EAAG,CAAC,GAC/E,MACD,EACD,IACC,CAAC;CACL;AACD"}
@@ -0,0 +1,18 @@
1
+ //#region src/widgets/readMeta.ts
2
+ /**
3
+ * One mapping from an adapter result's meta to the flags a widget renders. Every helper
4
+ * maps all of them, so a widget that starts rendering a notice needs nothing from the read
5
+ * path, and a flag cannot go missing on one widget while its neighbour shows it.
6
+ */
7
+ const readMeta = (result) => ({
8
+ clamped: result.meta.clamped ?? false,
9
+ stale: result.meta.stale ?? false,
10
+ filtersUnapplied: (result.meta.unappliedFilters?.length ?? 0) > 0,
11
+ goalsUnresolved: result.meta.goalsUnresolved === true,
12
+ sampled: result.meta.sampled ?? false,
13
+ provider: result.meta.provider
14
+ });
15
+ //#endregion
16
+ export { readMeta };
17
+
18
+ //# sourceMappingURL=readMeta.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"readMeta.js","names":[],"sources":["../../src/widgets/readMeta.ts"],"sourcesContent":["import type { AnalyticsResult } from '../core/contract'\n\n/** The state flags every widget result carries, whatever shape its numbers take. */\nexport interface WidgetReadMeta {\n\t/** The source read a shorter window than the one that was asked for. */\n\tclamped: boolean\n\t/** The engine served an expired cache entry after a failed provider read. */\n\tstale: boolean\n\t/** The source answered without one of the filters the read carried. */\n\tfiltersUnapplied: boolean\n\t/** The source could not read the scope's goals, so the goal numbers mean nothing. */\n\tgoalsUnresolved: boolean\n\t/** The read hit the source's event scan cap, so the numbers are a floor. */\n\tsampled: boolean\n\t/** The source that answered. */\n\tprovider: string\n}\n\n/**\n * One mapping from an adapter result's meta to the flags a widget renders. Every helper\n * maps all of them, so a widget that starts rendering a notice needs nothing from the read\n * path, and a flag cannot go missing on one widget while its neighbour shows it.\n */\nexport const readMeta = (result: AnalyticsResult): WidgetReadMeta => ({\n\tclamped: result.meta.clamped ?? false,\n\tstale: result.meta.stale ?? false,\n\tfiltersUnapplied: (result.meta.unappliedFilters?.length ?? 0) > 0,\n\tgoalsUnresolved: result.meta.goalsUnresolved === true,\n\tsampled: result.meta.sampled ?? false,\n\tprovider: result.meta.provider,\n})\n"],"mappings":";;;;;;AAuBA,MAAa,YAAY,YAA6C;CACrE,SAAS,OAAO,KAAK,WAAW;CAChC,OAAO,OAAO,KAAK,SAAS;CAC5B,mBAAmB,OAAO,KAAK,kBAAkB,UAAU,KAAK;CAChE,iBAAiB,OAAO,KAAK,oBAAoB;CACjD,SAAS,OAAO,KAAK,WAAW;CAChC,UAAU,OAAO,KAAK;AACvB"}
@@ -1,14 +1,15 @@
1
1
  import { keys } from "../translations/keys.js";
2
2
  import { labelForKey } from "../translations/server.js";
3
- import { satisfiesCapabilities } from "../core/capabilities.js";
4
3
  import { TIMEFRAME_PRESETS } from "../timeframe/presets.js";
5
4
  import { METRIC_KEYS, TIMEFRAME_KEYS } from "../translations/metricKeys.js";
5
+ import { satisfiesCapabilities } from "../core/capabilities.js";
6
6
  import { de } from "../translations/de.js";
7
7
  import { en } from "../translations/en.js";
8
8
  import { BREAKDOWN_SPECS } from "./breakdownTypes.js";
9
- import { WIDGET_METRICS } from "./types.js";
9
+ import { GOAL_ROW_LIMITS, WIDGET_METRICS } from "./types.js";
10
10
  import { dateRangeField } from "../fields/dateRange/field.js";
11
11
  import { buildCustomWidgets } from "./customWidget.js";
12
+ import { filterField } from "./filterField.js";
12
13
  //#region src/widgets/registerWidgets.ts
13
14
  /**
14
15
  * Select options must carry static labels: `filterOptions` results are serialized
@@ -90,6 +91,13 @@ const timeframeSelectField = () => ({
90
91
  label: labelForKey(keys.widgetTimeframeCustom)
91
92
  }]
92
93
  });
94
+ /** Reads the previous period too: the trend overlays it, the goals table deltas against it. */
95
+ const compareField = () => ({
96
+ name: "compare",
97
+ type: "checkbox",
98
+ defaultValue: false,
99
+ label: labelForKey(keys.widgetFieldCompare)
100
+ });
93
101
  const dataSourceField = (args) => ({
94
102
  name: "dataSource",
95
103
  type: "select",
@@ -119,18 +127,20 @@ const customRangeField = () => dateRangeField({
119
127
  });
120
128
  /** The metric select in a widget's field list. */
121
129
  const findMetricField = (fields) => fields.find((field) => "name" in field && field.name === "metric");
122
- const metricWidgetFields = (args) => [
130
+ const metricWidgetFields = (args, extra = []) => [
123
131
  titleField(args, en[keys.widgetFieldTitlePlaceholder]),
124
132
  metricSelectField(WIDGET_METRICS, args),
125
133
  timeframeSelectField(),
126
134
  customRangeField(),
127
- ...args.multiProvider ? [dataSourceField(args)] : []
135
+ ...extra,
136
+ ...args.multiProvider ? [dataSourceField(args)] : [],
137
+ filterField()
128
138
  ];
129
139
  const breakdownWidgetFields = (args, spec) => [
130
140
  titleField(args, en[spec.label]),
131
141
  metricSelectField(WIDGET_METRICS, args, {
132
142
  extra: { dimensions: [spec.dimension] },
133
- ...spec.dimension === "goal" ? { preferredDefault: "conversions" } : {}
143
+ ...spec.preferredDefault ? { preferredDefault: spec.preferredDefault } : {}
134
144
  }),
135
145
  timeframeSelectField(),
136
146
  customRangeField(),
@@ -142,6 +152,27 @@ const breakdownWidgetFields = (args, spec) => [
142
152
  max: 20,
143
153
  label: labelForKey(keys.widgetFieldLimit)
144
154
  },
155
+ ...args.multiProvider ? [dataSourceField(args)] : [],
156
+ filterField()
157
+ ];
158
+ /** A select, not the breakdown's free number: the goals table is a summary, not a report. */
159
+ const goalLimitField = () => ({
160
+ name: "limit",
161
+ type: "select",
162
+ defaultValue: String(GOAL_ROW_LIMITS[0]),
163
+ label: labelForKey(keys.widgetFieldLimit),
164
+ admin: { isClearable: false },
165
+ options: GOAL_ROW_LIMITS.map((limit) => ({
166
+ value: String(limit),
167
+ label: String(limit)
168
+ }))
169
+ });
170
+ const goalsWidgetFields = (args) => [
171
+ titleField(args, en[keys.widgetGoals]),
172
+ timeframeSelectField(),
173
+ customRangeField(),
174
+ goalLimitField(),
175
+ ...args.comparison === false ? [] : [compareField()],
145
176
  ...args.multiProvider ? [dataSourceField(args)] : []
146
177
  ];
147
178
  const realtimeWidgetFields = (args) => [
@@ -193,7 +224,7 @@ const WIDGET_DEFS = [
193
224
  requires: { metrics: ["pageviews"] },
194
225
  minWidth: "small",
195
226
  maxWidth: "full",
196
- fields: metricWidgetFields
227
+ fields: (args) => metricWidgetFields(args, args.comparison === false ? [] : [compareField()])
197
228
  },
198
229
  {
199
230
  slug: "analytics-realtime",
@@ -204,6 +235,18 @@ const WIDGET_DEFS = [
204
235
  maxWidth: "medium",
205
236
  fields: realtimeWidgetFields
206
237
  },
238
+ {
239
+ slug: "analytics-goals",
240
+ component: "@10x-media/analytics/rsc#AnalyticsGoalsWidget",
241
+ label: keys.widgetGoals,
242
+ requires: {
243
+ metrics: ["conversions"],
244
+ dimensions: ["goal"]
245
+ },
246
+ minWidth: "small",
247
+ maxWidth: "large",
248
+ fields: goalsWidgetFields
249
+ },
207
250
  ...BREAKDOWN_SPECS.map((spec) => ({
208
251
  slug: spec.slug,
209
252
  component: "@10x-media/analytics/rsc#AnalyticsBreakdownWidget",
@@ -224,7 +267,10 @@ const registerWidgets = (config, args) => {
224
267
  if (metricField && "options" in metricField && metricField.options.length === 0) continue;
225
268
  built.push({
226
269
  slug: def.slug,
227
- Component: def.component,
270
+ Component: {
271
+ path: def.component,
272
+ serverProps: { view: args.view ?? false }
273
+ },
228
274
  label: labelForKey(def.label),
229
275
  fields,
230
276
  minWidth: def.minWidth,
@@ -1 +1 @@
1
- {"version":3,"file":"registerWidgets.js","names":[],"sources":["../../src/widgets/registerWidgets.ts"],"sourcesContent":["import type {\n\tConfig,\n\tField,\n\tSelectField,\n\tSelectFieldSingleValidation,\n\tWidget,\n\tWidgetWidth,\n} from 'payload'\nimport { type CapabilityRequirement, satisfiesCapabilities } from '../core/capabilities'\nimport type { AnalyticsAdapter, MetricKey } from '../core/contract'\nimport { dateRangeField } from '../fields/dateRange/field'\nimport { TIMEFRAME_PRESETS } from '../timeframe/presets'\nimport { de } from '../translations/de'\nimport { en } from '../translations/en'\nimport type { TranslationKey } from '../translations/keys'\nimport { keys } from '../translations/keys'\nimport { METRIC_KEYS, TIMEFRAME_KEYS } from '../translations/metricKeys'\nimport { labelForKey } from '../translations/server'\nimport { BREAKDOWN_SPECS, type BreakdownSpec } from './breakdownTypes'\nimport { buildCustomWidgets, type CustomWidgetDef } from './customWidget'\nimport { WIDGET_METRICS } from './types'\n\n/**\n * Select options must carry static labels: `filterOptions` results are serialized\n * into client form state at request time, where a label function cannot cross the\n * server/client boundary.\n */\nconst staticLabel = (key: TranslationKey): Record<string, string> => ({\n\tde: de[key],\n\ten: en[key],\n})\n\nexport interface RegisterWidgetsArgs {\n\tadapters: AnalyticsAdapter[]\n\tmultiProvider: boolean\n\t/**\n\t * True when a tenant's own runtime adapter can exist (`providers.collection` or\n\t * `providers.resolve`). Such an adapter's capabilities are unknown at config time, so\n\t * gating on the config-adapter union would impose a false ceiling: widgets and metric\n\t * options open up, and the per-request sources endpoint plus client pickers narrow per\n\t * request instead.\n\t */\n\tprovidersEnabled: boolean\n\tdisabled: string[]\n\tregister: CustomWidgetDef[]\n\tlocalizeText?: boolean\n\t/** The plugin's configured defaultAdapter, when set; falls back to the first adapter. */\n\tdefaultId?: string\n}\n\ninterface WidgetDef {\n\tslug: string\n\tcomponent: string\n\tlabel: TranslationKey\n\trequires?: CapabilityRequirement\n\tminWidth?: WidgetWidth\n\tmaxWidth?: WidgetWidth\n\tfields: (args: RegisterWidgetsArgs) => Field[]\n}\n\nexport const widgetIsSupported = (\n\trequires: CapabilityRequirement | undefined,\n\tadapters: AnalyticsAdapter[]\n): boolean => !requires || adapters.some((a) => satisfiesCapabilities(a.capabilities, requires))\n\n/**\n * The widget metric select. Options are limited to metrics at least one configured\n * adapter can serve, mirroring the OR-across-adapters gating used to hide whole widgets;\n * `extra` layers on further requirements (a breakdown widget's dimension, realtime) so\n * the picker never offers a metric the read path would report as unavailable. In\n * multi-provider installs `filterOptions` additionally narrows the picker to the selected\n * `dataSource`'s capabilities; an id not known at config time (a runtime/DB provider)\n * keeps the union. The default clamps to the first option when the preferred metric is\n * not servable, and options can come out empty for exotic adapter sets, which\n * {@link registerWidgets} treats as \"skip this widget\". When `providersEnabled`, the\n * config-adapter filter is skipped entirely: a tenant's own runtime adapter may serve\n * metrics no config adapter does, so every candidate is offered and `filterOptions` alone\n * narrows once a `dataSource` is picked.\n */\nconst metricSelectField = (\n\tcandidates: MetricKey[],\n\targs: RegisterWidgetsArgs,\n\topts: {\n\t\textra?: Omit<CapabilityRequirement, 'metrics'>\n\t\tpreferredDefault?: MetricKey\n\t} = {}\n): Field => {\n\tconst { extra, preferredDefault = 'pageviews' } = opts\n\tconst supports = (adapter: AnalyticsAdapter, metric: MetricKey): boolean =>\n\t\tsatisfiesCapabilities(adapter.capabilities, { ...extra, metrics: [metric] })\n\tconst options = (\n\t\targs.providersEnabled\n\t\t\t? candidates\n\t\t\t: candidates.filter((m) => args.adapters.some((a) => supports(a, m)))\n\t).map((m) => ({ value: m, label: staticLabel(METRIC_KEYS[m]) }))\n\tconst defaultValue = options.some((o) => o.value === preferredDefault)\n\t\t? preferredDefault\n\t\t: options[0]?.value\n\tconst filterOptions: SelectField['filterOptions'] = ({ options: opts, siblingData }) => {\n\t\tconst sourceId = (siblingData as { dataSource?: unknown } | undefined)?.dataSource\n\t\tconst adapter =\n\t\t\ttypeof sourceId === 'string' ? args.adapters.find((a) => a.id === sourceId) : undefined\n\t\tif (!adapter) {\n\t\t\treturn opts\n\t\t}\n\t\treturn opts.filter((o) => typeof o === 'object' && supports(adapter, o.value as MetricKey))\n\t}\n\treturn {\n\t\tname: 'metric',\n\t\ttype: 'select',\n\t\trequired: true,\n\t\t...(defaultValue !== undefined ? { defaultValue } : {}),\n\t\tlabel: labelForKey(keys.widgetFieldMetric),\n\t\toptions,\n\t\tadmin: {\n\t\t\t// A required metric has no meaningful cleared state.\n\t\t\tisClearable: false,\n\t\t\tcomponents: {\n\t\t\t\tField: {\n\t\t\t\t\tpath: '@10x-media/analytics/client#MetricSelectField',\n\t\t\t\t\t...(extra ? { clientProps: { requires: extra } } : {}),\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t...(args.multiProvider ? { filterOptions } : {}),\n\t}\n}\n\nconst titleField = (args: RegisterWidgetsArgs, placeholder: string): Field => ({\n\tname: 'title',\n\ttype: 'text',\n\tlabel: labelForKey(keys.widgetFieldTitle),\n\t...(args.localizeText ? { localized: true } : {}),\n\tadmin: { placeholder },\n})\n\nconst timeframeSelectField = (): Field => ({\n\tname: 'timeframe',\n\ttype: 'select',\n\trequired: true,\n\tdefaultValue: 'last30days',\n\tlabel: labelForKey(keys.widgetFieldTimeframe),\n\tadmin: { isClearable: false },\n\toptions: [\n\t\t...TIMEFRAME_PRESETS.map((p) => ({ value: p, label: labelForKey(TIMEFRAME_KEYS[p]) })),\n\t\t{ value: 'custom', label: labelForKey(keys.widgetTimeframeCustom) },\n\t],\n})\n\nconst dataSourceField = (args: RegisterWidgetsArgs): Field => ({\n\tname: 'dataSource',\n\ttype: 'select',\n\tlabel: labelForKey(keys.widgetFieldDataSource),\n\tdefaultValue: args.defaultId ?? args.adapters[0]?.id,\n\tadmin: {\n\t\t// Clearing would leave no source; the widget always reads through one.\n\t\tisClearable: false,\n\t\tcomponents: { Field: { path: '@10x-media/analytics/client#SourceSelectField' } },\n\t},\n\toptions: args.adapters.map((a) => ({ value: a.id, label: a.label })),\n\t// Payload's select validator rejects any value absent from `options`, but runtime\n\t// (DB-registered) provider ids are only known per request, not at config time.\n\tvalidate: ((value) =>\n\t\tvalue === undefined || value === null || (typeof value === 'string' && value.length > 0)\n\t\t\t? true\n\t\t\t: 'invalid data source') as SelectFieldSingleValidation,\n})\n\nconst customRangeField = (): Field =>\n\tdateRangeField({\n\t\tname: 'range',\n\t\tlabel: labelForKey(keys.widgetFieldRange),\n\t\tpickerAppearance: 'dayOnly',\n\t\toverrides: (f) => ({\n\t\t\t...f,\n\t\t\tadmin: {\n\t\t\t\t...f.admin,\n\t\t\t\tcondition: (_data, siblingData) => siblingData?.timeframe === 'custom',\n\t\t\t},\n\t\t}),\n\t})\n\n/** The metric select in a widget's field list. */\nexport const findMetricField = (fields: Field[]): Field | undefined =>\n\tfields.find((field) => 'name' in field && field.name === 'metric')\n\nconst metricWidgetFields = (args: RegisterWidgetsArgs): Field[] => [\n\ttitleField(args, en[keys.widgetFieldTitlePlaceholder]),\n\tmetricSelectField(WIDGET_METRICS, args),\n\ttimeframeSelectField(),\n\tcustomRangeField(),\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\nconst breakdownWidgetFields = (args: RegisterWidgetsArgs, spec: BreakdownSpec): Field[] => [\n\ttitleField(args, en[spec.label]),\n\t// A goals breakdown is a conversion table: pageviews per goal is a stranger default.\n\tmetricSelectField(WIDGET_METRICS, args, {\n\t\textra: { dimensions: [spec.dimension] },\n\t\t...(spec.dimension === 'goal' ? { preferredDefault: 'conversions' as MetricKey } : {}),\n\t}),\n\ttimeframeSelectField(),\n\tcustomRangeField(),\n\t{\n\t\tname: 'limit',\n\t\ttype: 'number',\n\t\tdefaultValue: 5,\n\t\tmin: 1,\n\t\tmax: 20,\n\t\tlabel: labelForKey(keys.widgetFieldLimit),\n\t},\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\nconst realtimeWidgetFields = (args: RegisterWidgetsArgs): Field[] => [\n\ttitleField(args, en[keys.widgetFieldTitlePlaceholder]),\n\tmetricSelectField(['visitors', 'pageviews'], args, {\n\t\textra: { realtime: true },\n\t\tpreferredDefault: 'visitors',\n\t}),\n\t{\n\t\tname: 'windowMinutes',\n\t\ttype: 'select',\n\t\tdefaultValue: '30',\n\t\tlabel: labelForKey(keys.widgetFieldWindow),\n\t\tadmin: { isClearable: false },\n\t\toptions: [\n\t\t\t{ value: '5', label: '5 min' },\n\t\t\t{ value: '15', label: '15 min' },\n\t\t\t{ value: '30', label: '30 min' },\n\t\t\t{ value: '60', label: '60 min' },\n\t\t],\n\t},\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\nconst WIDGET_DEFS: WidgetDef[] = [\n\t{\n\t\tslug: 'analytics-metric',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsMetricWidget',\n\t\tlabel: keys.widgetMetricLabel,\n\t\tminWidth: 'x-small',\n\t\tmaxWidth: 'medium',\n\t\tfields: metricWidgetFields,\n\t},\n\t{\n\t\tslug: 'analytics-trend',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsTrendWidget',\n\t\tlabel: keys.widgetTrendLabel,\n\t\trequires: { metrics: ['pageviews'] },\n\t\tminWidth: 'small',\n\t\tmaxWidth: 'full',\n\t\tfields: metricWidgetFields,\n\t},\n\t{\n\t\tslug: 'analytics-realtime',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsRealtimeWidget',\n\t\tlabel: keys.widgetRealtimeLabel,\n\t\trequires: { realtime: true },\n\t\tminWidth: 'small' as WidgetWidth,\n\t\tmaxWidth: 'medium' as WidgetWidth,\n\t\tfields: realtimeWidgetFields,\n\t},\n\t...BREAKDOWN_SPECS.map(\n\t\t(spec): WidgetDef => ({\n\t\t\tslug: spec.slug,\n\t\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsBreakdownWidget',\n\t\t\tlabel: spec.label,\n\t\t\trequires: { dimensions: [spec.dimension] },\n\t\t\tminWidth: 'small' as WidgetWidth,\n\t\t\tmaxWidth: 'large' as WidgetWidth,\n\t\t\tfields: (args) => breakdownWidgetFields(args, spec),\n\t\t})\n\t),\n]\n\nexport const registerWidgets = (config: Config, args: RegisterWidgetsArgs): void => {\n\tconst built: Widget[] = []\n\tfor (const def of WIDGET_DEFS) {\n\t\tif (args.disabled.includes(def.slug)) {\n\t\t\tcontinue\n\t\t}\n\t\tif (!args.providersEnabled && !widgetIsSupported(def.requires, args.adapters)) {\n\t\t\tcontinue\n\t\t}\n\t\tconst fields = def.fields(args)\n\t\t// A required metric select with no servable option would make the widget\n\t\t// impossible to configure; skip it like an unsupported widget.\n\t\tconst metricField = findMetricField(fields)\n\t\tif (metricField && 'options' in metricField && metricField.options.length === 0) {\n\t\t\tcontinue\n\t\t}\n\t\tbuilt.push({\n\t\t\tslug: def.slug,\n\t\t\tComponent: def.component,\n\t\t\tlabel: labelForKey(def.label),\n\t\t\tfields,\n\t\t\tminWidth: def.minWidth,\n\t\t\tmaxWidth: def.maxWidth,\n\t\t})\n\t}\n\tbuilt.push(...buildCustomWidgets(args.register, args.adapters, args.disabled))\n\tif (!built.length) {\n\t\treturn\n\t}\n\tconfig.admin ??= {}\n\tconfig.admin.dashboard ??= { widgets: [] }\n\tconfig.admin.dashboard.widgets ??= []\n\tconfig.admin.dashboard.widgets.push(...built)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AA2BA,MAAM,eAAe,SAAiD;CACrE,IAAI,GAAG;CACP,IAAI,GAAG;AACR;AA8BA,MAAa,qBACZ,UACA,aACa,CAAC,YAAY,SAAS,MAAM,MAAM,sBAAsB,EAAE,cAAc,QAAQ,CAAC;;;;;;;;;;;;;;;AAgB/F,MAAM,qBACL,YACA,MACA,OAGI,CAAC,MACM;CACX,MAAM,EAAE,OAAO,mBAAmB,gBAAgB;CAClD,MAAM,YAAY,SAA2B,WAC5C,sBAAsB,QAAQ,cAAc;EAAE,GAAG;EAAO,SAAS,CAAC,MAAM;CAAE,CAAC;CAC5E,MAAM,WACL,KAAK,mBACF,aACA,WAAW,QAAQ,MAAM,KAAK,SAAS,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,CAAC,GACpE,KAAK,OAAO;EAAE,OAAO;EAAG,OAAO,YAAY,YAAY,EAAE;CAAE,EAAE;CAC/D,MAAM,eAAe,QAAQ,MAAM,MAAM,EAAE,UAAU,gBAAgB,IAClE,mBACA,QAAQ,IAAI;CACf,MAAM,iBAA+C,EAAE,SAAS,MAAM,kBAAkB;EACvF,MAAM,WAAY,aAAsD;EACxE,MAAM,UACL,OAAO,aAAa,WAAW,KAAK,SAAS,MAAM,MAAM,EAAE,OAAO,QAAQ,IAAI,KAAA;EAC/E,IAAI,CAAC,SACJ,OAAO;EAER,OAAO,KAAK,QAAQ,MAAM,OAAO,MAAM,YAAY,SAAS,SAAS,EAAE,KAAkB,CAAC;CAC3F;CACA,OAAO;EACN,MAAM;EACN,MAAM;EACN,UAAU;EACV,GAAI,iBAAiB,KAAA,IAAY,EAAE,aAAa,IAAI,CAAC;EACrD,OAAO,YAAY,KAAK,iBAAiB;EACzC;EACA,OAAO;GAEN,aAAa;GACb,YAAY,EACX,OAAO;IACN,MAAM;IACN,GAAI,QAAQ,EAAE,aAAa,EAAE,UAAU,MAAM,EAAE,IAAI,CAAC;GACrD,EACD;EACD;EACA,GAAI,KAAK,gBAAgB,EAAE,cAAc,IAAI,CAAC;CAC/C;AACD;AAEA,MAAM,cAAc,MAA2B,iBAAgC;CAC9E,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,gBAAgB;CACxC,GAAI,KAAK,eAAe,EAAE,WAAW,KAAK,IAAI,CAAC;CAC/C,OAAO,EAAE,YAAY;AACtB;AAEA,MAAM,8BAAqC;CAC1C,MAAM;CACN,MAAM;CACN,UAAU;CACV,cAAc;CACd,OAAO,YAAY,KAAK,oBAAoB;CAC5C,OAAO,EAAE,aAAa,MAAM;CAC5B,SAAS,CACR,GAAG,kBAAkB,KAAK,OAAO;EAAE,OAAO;EAAG,OAAO,YAAY,eAAe,EAAE;CAAE,EAAE,GACrF;EAAE,OAAO;EAAU,OAAO,YAAY,KAAK,qBAAqB;CAAE,CACnE;AACD;AAEA,MAAM,mBAAmB,UAAsC;CAC9D,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,qBAAqB;CAC7C,cAAc,KAAK,aAAa,KAAK,SAAS,IAAI;CAClD,OAAO;EAEN,aAAa;EACb,YAAY,EAAE,OAAO,EAAE,MAAM,gDAAgD,EAAE;CAChF;CACA,SAAS,KAAK,SAAS,KAAK,OAAO;EAAE,OAAO,EAAE;EAAI,OAAO,EAAE;CAAM,EAAE;CAGnE,YAAY,UACX,UAAU,KAAA,KAAa,UAAU,QAAS,OAAO,UAAU,YAAY,MAAM,SAAS,IACnF,OACA;AACL;AAEA,MAAM,yBACL,eAAe;CACd,MAAM;CACN,OAAO,YAAY,KAAK,gBAAgB;CACxC,kBAAkB;CAClB,YAAY,OAAO;EAClB,GAAG;EACH,OAAO;GACN,GAAG,EAAE;GACL,YAAY,OAAO,gBAAgB,aAAa,cAAc;EAC/D;CACD;AACD,CAAC;;AAGF,MAAa,mBAAmB,WAC/B,OAAO,MAAM,UAAU,UAAU,SAAS,MAAM,SAAS,QAAQ;AAElE,MAAM,sBAAsB,SAAuC;CAClE,WAAW,MAAM,GAAG,KAAK,4BAA4B;CACrD,kBAAkB,gBAAgB,IAAI;CACtC,qBAAqB;CACrB,iBAAiB;CACjB,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;AAEA,MAAM,yBAAyB,MAA2B,SAAiC;CAC1F,WAAW,MAAM,GAAG,KAAK,MAAM;CAE/B,kBAAkB,gBAAgB,MAAM;EACvC,OAAO,EAAE,YAAY,CAAC,KAAK,SAAS,EAAE;EACtC,GAAI,KAAK,cAAc,SAAS,EAAE,kBAAkB,cAA2B,IAAI,CAAC;CACrF,CAAC;CACD,qBAAqB;CACrB,iBAAiB;CACjB;EACC,MAAM;EACN,MAAM;EACN,cAAc;EACd,KAAK;EACL,KAAK;EACL,OAAO,YAAY,KAAK,gBAAgB;CACzC;CACA,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;AAEA,MAAM,wBAAwB,SAAuC;CACpE,WAAW,MAAM,GAAG,KAAK,4BAA4B;CACrD,kBAAkB,CAAC,YAAY,WAAW,GAAG,MAAM;EAClD,OAAO,EAAE,UAAU,KAAK;EACxB,kBAAkB;CACnB,CAAC;CACD;EACC,MAAM;EACN,MAAM;EACN,cAAc;EACd,OAAO,YAAY,KAAK,iBAAiB;EACzC,OAAO,EAAE,aAAa,MAAM;EAC5B,SAAS;GACR;IAAE,OAAO;IAAK,OAAO;GAAQ;GAC7B;IAAE,OAAO;IAAM,OAAO;GAAS;GAC/B;IAAE,OAAO;IAAM,OAAO;GAAS;GAC/B;IAAE,OAAO;IAAM,OAAO;GAAS;EAChC;CACD;CACA,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;AAEA,MAAM,cAA2B;CAChC;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,SAAS,CAAC,WAAW,EAAE;EACnC,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,UAAU,KAAK;EAC3B,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA,GAAG,gBAAgB,KACjB,UAAqB;EACrB,MAAM,KAAK;EACX,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,YAAY,CAAC,KAAK,SAAS,EAAE;EACzC,UAAU;EACV,UAAU;EACV,SAAS,SAAS,sBAAsB,MAAM,IAAI;CACnD,EACD;AACD;AAEA,MAAa,mBAAmB,QAAgB,SAAoC;CACnF,MAAM,QAAkB,CAAC;CACzB,KAAK,MAAM,OAAO,aAAa;EAC9B,IAAI,KAAK,SAAS,SAAS,IAAI,IAAI,GAClC;EAED,IAAI,CAAC,KAAK,oBAAoB,CAAC,kBAAkB,IAAI,UAAU,KAAK,QAAQ,GAC3E;EAED,MAAM,SAAS,IAAI,OAAO,IAAI;EAG9B,MAAM,cAAc,gBAAgB,MAAM;EAC1C,IAAI,eAAe,aAAa,eAAe,YAAY,QAAQ,WAAW,GAC7E;EAED,MAAM,KAAK;GACV,MAAM,IAAI;GACV,WAAW,IAAI;GACf,OAAO,YAAY,IAAI,KAAK;GAC5B;GACA,UAAU,IAAI;GACd,UAAU,IAAI;EACf,CAAC;CACF;CACA,MAAM,KAAK,GAAG,mBAAmB,KAAK,UAAU,KAAK,UAAU,KAAK,QAAQ,CAAC;CAC7E,IAAI,CAAC,MAAM,QACV;CAED,OAAO,UAAU,CAAC;CAClB,OAAO,MAAM,cAAc,EAAE,SAAS,CAAC,EAAE;CACzC,OAAO,MAAM,UAAU,YAAY,CAAC;CACpC,OAAO,MAAM,UAAU,QAAQ,KAAK,GAAG,KAAK;AAC7C"}
1
+ {"version":3,"file":"registerWidgets.js","names":[],"sources":["../../src/widgets/registerWidgets.ts"],"sourcesContent":["import type {\n\tConfig,\n\tField,\n\tSelectField,\n\tSelectFieldSingleValidation,\n\tWidget,\n\tWidgetWidth,\n} from 'payload'\nimport { type CapabilityRequirement, satisfiesCapabilities } from '../core/capabilities'\nimport type { AnalyticsAdapter, MetricKey } from '../core/contract'\nimport { dateRangeField } from '../fields/dateRange/field'\nimport { TIMEFRAME_PRESETS } from '../timeframe/presets'\nimport { de } from '../translations/de'\nimport { en } from '../translations/en'\nimport type { TranslationKey } from '../translations/keys'\nimport { keys } from '../translations/keys'\nimport { METRIC_KEYS, TIMEFRAME_KEYS } from '../translations/metricKeys'\nimport { labelForKey } from '../translations/server'\nimport { BREAKDOWN_SPECS, type BreakdownSpec } from './breakdownTypes'\nimport { buildCustomWidgets, type CustomWidgetDef } from './customWidget'\nimport { filterField } from './filterField'\nimport { GOAL_ROW_LIMITS, WIDGET_METRICS } from './types'\nimport type { WidgetView } from './viewLink'\n\n/**\n * Select options must carry static labels: `filterOptions` results are serialized\n * into client form state at request time, where a label function cannot cross the\n * server/client boundary.\n */\nconst staticLabel = (key: TranslationKey): Record<string, string> => ({\n\tde: de[key],\n\ten: en[key],\n})\n\nexport interface RegisterWidgetsArgs {\n\tadapters: AnalyticsAdapter[]\n\tmultiProvider: boolean\n\t/**\n\t * True when a tenant's own runtime adapter can exist (`providers.collection` or\n\t * `providers.resolve`). Such an adapter's capabilities are unknown at config time, so\n\t * gating on the config-adapter union would impose a false ceiling: widgets and metric\n\t * options open up, and the per-request sources endpoint plus client pickers narrow per\n\t * request instead.\n\t */\n\tprovidersEnabled: boolean\n\tdisabled: string[]\n\tregister: CustomWidgetDef[]\n\tlocalizeText?: boolean\n\t/** The plugin's configured defaultAdapter, when set; falls back to the first adapter. */\n\tdefaultId?: string\n\t/** `widgets.comparison`; false hides every compare checkbox. Defaults to on. */\n\tcomparison?: boolean\n\t/**\n\t * Where the analytics view mounts, so every built-in widget can link into it. False or\n\t * absent means no view to link to, and the widgets render without the footer link.\n\t */\n\tview?: WidgetView\n}\n\ninterface WidgetDef {\n\tslug: string\n\tcomponent: string\n\tlabel: TranslationKey\n\trequires?: CapabilityRequirement\n\tminWidth?: WidgetWidth\n\tmaxWidth?: WidgetWidth\n\tfields: (args: RegisterWidgetsArgs) => Field[]\n}\n\nexport const widgetIsSupported = (\n\trequires: CapabilityRequirement | undefined,\n\tadapters: AnalyticsAdapter[]\n): boolean => !requires || adapters.some((a) => satisfiesCapabilities(a.capabilities, requires))\n\n/**\n * The widget metric select. Options are limited to metrics at least one configured\n * adapter can serve, mirroring the OR-across-adapters gating used to hide whole widgets;\n * `extra` layers on further requirements (a breakdown widget's dimension, realtime) so\n * the picker never offers a metric the read path would report as unavailable. In\n * multi-provider installs `filterOptions` additionally narrows the picker to the selected\n * `dataSource`'s capabilities; an id not known at config time (a runtime/DB provider)\n * keeps the union. The default clamps to the first option when the preferred metric is\n * not servable, and options can come out empty for exotic adapter sets, which\n * {@link registerWidgets} treats as \"skip this widget\". When `providersEnabled`, the\n * config-adapter filter is skipped entirely: a tenant's own runtime adapter may serve\n * metrics no config adapter does, so every candidate is offered and `filterOptions` alone\n * narrows once a `dataSource` is picked.\n */\nconst metricSelectField = (\n\tcandidates: MetricKey[],\n\targs: RegisterWidgetsArgs,\n\topts: {\n\t\textra?: Omit<CapabilityRequirement, 'metrics'>\n\t\tpreferredDefault?: MetricKey\n\t} = {}\n): Field => {\n\tconst { extra, preferredDefault = 'pageviews' } = opts\n\tconst supports = (adapter: AnalyticsAdapter, metric: MetricKey): boolean =>\n\t\tsatisfiesCapabilities(adapter.capabilities, { ...extra, metrics: [metric] })\n\tconst options = (\n\t\targs.providersEnabled\n\t\t\t? candidates\n\t\t\t: candidates.filter((m) => args.adapters.some((a) => supports(a, m)))\n\t).map((m) => ({ value: m, label: staticLabel(METRIC_KEYS[m]) }))\n\tconst defaultValue = options.some((o) => o.value === preferredDefault)\n\t\t? preferredDefault\n\t\t: options[0]?.value\n\tconst filterOptions: SelectField['filterOptions'] = ({ options: opts, siblingData }) => {\n\t\tconst sourceId = (siblingData as { dataSource?: unknown } | undefined)?.dataSource\n\t\tconst adapter =\n\t\t\ttypeof sourceId === 'string' ? args.adapters.find((a) => a.id === sourceId) : undefined\n\t\tif (!adapter) {\n\t\t\treturn opts\n\t\t}\n\t\treturn opts.filter((o) => typeof o === 'object' && supports(adapter, o.value as MetricKey))\n\t}\n\treturn {\n\t\tname: 'metric',\n\t\ttype: 'select',\n\t\trequired: true,\n\t\t...(defaultValue !== undefined ? { defaultValue } : {}),\n\t\tlabel: labelForKey(keys.widgetFieldMetric),\n\t\toptions,\n\t\tadmin: {\n\t\t\t// A required metric has no meaningful cleared state.\n\t\t\tisClearable: false,\n\t\t\tcomponents: {\n\t\t\t\tField: {\n\t\t\t\t\tpath: '@10x-media/analytics/client#MetricSelectField',\n\t\t\t\t\t...(extra ? { clientProps: { requires: extra } } : {}),\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t...(args.multiProvider ? { filterOptions } : {}),\n\t}\n}\n\nconst titleField = (args: RegisterWidgetsArgs, placeholder: string): Field => ({\n\tname: 'title',\n\ttype: 'text',\n\tlabel: labelForKey(keys.widgetFieldTitle),\n\t...(args.localizeText ? { localized: true } : {}),\n\tadmin: { placeholder },\n})\n\nconst timeframeSelectField = (): Field => ({\n\tname: 'timeframe',\n\ttype: 'select',\n\trequired: true,\n\tdefaultValue: 'last30days',\n\tlabel: labelForKey(keys.widgetFieldTimeframe),\n\tadmin: { isClearable: false },\n\toptions: [\n\t\t...TIMEFRAME_PRESETS.map((p) => ({ value: p, label: labelForKey(TIMEFRAME_KEYS[p]) })),\n\t\t{ value: 'custom', label: labelForKey(keys.widgetTimeframeCustom) },\n\t],\n})\n\n/** Reads the previous period too: the trend overlays it, the goals table deltas against it. */\nconst compareField = (): Field => ({\n\tname: 'compare',\n\ttype: 'checkbox',\n\tdefaultValue: false,\n\tlabel: labelForKey(keys.widgetFieldCompare),\n})\n\nconst dataSourceField = (args: RegisterWidgetsArgs): Field => ({\n\tname: 'dataSource',\n\ttype: 'select',\n\tlabel: labelForKey(keys.widgetFieldDataSource),\n\tdefaultValue: args.defaultId ?? args.adapters[0]?.id,\n\tadmin: {\n\t\t// Clearing would leave no source; the widget always reads through one.\n\t\tisClearable: false,\n\t\tcomponents: { Field: { path: '@10x-media/analytics/client#SourceSelectField' } },\n\t},\n\toptions: args.adapters.map((a) => ({ value: a.id, label: a.label })),\n\t// Payload's select validator rejects any value absent from `options`, but runtime\n\t// (DB-registered) provider ids are only known per request, not at config time.\n\tvalidate: ((value) =>\n\t\tvalue === undefined || value === null || (typeof value === 'string' && value.length > 0)\n\t\t\t? true\n\t\t\t: 'invalid data source') as SelectFieldSingleValidation,\n})\n\nconst customRangeField = (): Field =>\n\tdateRangeField({\n\t\tname: 'range',\n\t\tlabel: labelForKey(keys.widgetFieldRange),\n\t\tpickerAppearance: 'dayOnly',\n\t\toverrides: (f) => ({\n\t\t\t...f,\n\t\t\tadmin: {\n\t\t\t\t...f.admin,\n\t\t\t\tcondition: (_data, siblingData) => siblingData?.timeframe === 'custom',\n\t\t\t},\n\t\t}),\n\t})\n\n/** The metric select in a widget's field list. */\nexport const findMetricField = (fields: Field[]): Field | undefined =>\n\tfields.find((field) => 'name' in field && field.name === 'metric')\n\nconst metricWidgetFields = (args: RegisterWidgetsArgs, extra: Field[] = []): Field[] => [\n\ttitleField(args, en[keys.widgetFieldTitlePlaceholder]),\n\tmetricSelectField(WIDGET_METRICS, args),\n\ttimeframeSelectField(),\n\tcustomRangeField(),\n\t...extra,\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n\tfilterField(),\n]\n\nconst breakdownWidgetFields = (args: RegisterWidgetsArgs, spec: BreakdownSpec): Field[] => [\n\ttitleField(args, en[spec.label]),\n\tmetricSelectField(WIDGET_METRICS, args, {\n\t\textra: { dimensions: [spec.dimension] },\n\t\t...(spec.preferredDefault ? { preferredDefault: spec.preferredDefault } : {}),\n\t}),\n\ttimeframeSelectField(),\n\tcustomRangeField(),\n\t{\n\t\tname: 'limit',\n\t\ttype: 'number',\n\t\tdefaultValue: 5,\n\t\tmin: 1,\n\t\tmax: 20,\n\t\tlabel: labelForKey(keys.widgetFieldLimit),\n\t},\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n\tfilterField(),\n]\n\n/** A select, not the breakdown's free number: the goals table is a summary, not a report. */\nconst goalLimitField = (): Field => ({\n\tname: 'limit',\n\ttype: 'select',\n\tdefaultValue: String(GOAL_ROW_LIMITS[0]),\n\tlabel: labelForKey(keys.widgetFieldLimit),\n\tadmin: { isClearable: false },\n\toptions: GOAL_ROW_LIMITS.map((limit) => ({ value: String(limit), label: String(limit) })),\n})\n\nconst goalsWidgetFields = (args: RegisterWidgetsArgs): Field[] => [\n\ttitleField(args, en[keys.widgetGoals]),\n\ttimeframeSelectField(),\n\tcustomRangeField(),\n\tgoalLimitField(),\n\t...(args.comparison === false ? [] : [compareField()]),\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\nconst realtimeWidgetFields = (args: RegisterWidgetsArgs): Field[] => [\n\ttitleField(args, en[keys.widgetFieldTitlePlaceholder]),\n\tmetricSelectField(['visitors', 'pageviews'], args, {\n\t\textra: { realtime: true },\n\t\tpreferredDefault: 'visitors',\n\t}),\n\t{\n\t\tname: 'windowMinutes',\n\t\ttype: 'select',\n\t\tdefaultValue: '30',\n\t\tlabel: labelForKey(keys.widgetFieldWindow),\n\t\tadmin: { isClearable: false },\n\t\toptions: [\n\t\t\t{ value: '5', label: '5 min' },\n\t\t\t{ value: '15', label: '15 min' },\n\t\t\t{ value: '30', label: '30 min' },\n\t\t\t{ value: '60', label: '60 min' },\n\t\t],\n\t},\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\nconst WIDGET_DEFS: WidgetDef[] = [\n\t{\n\t\tslug: 'analytics-metric',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsMetricWidget',\n\t\tlabel: keys.widgetMetricLabel,\n\t\tminWidth: 'x-small',\n\t\tmaxWidth: 'medium',\n\t\tfields: metricWidgetFields,\n\t},\n\t{\n\t\tslug: 'analytics-trend',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsTrendWidget',\n\t\tlabel: keys.widgetTrendLabel,\n\t\trequires: { metrics: ['pageviews'] },\n\t\tminWidth: 'small',\n\t\tmaxWidth: 'full',\n\t\tfields: (args) => metricWidgetFields(args, args.comparison === false ? [] : [compareField()]),\n\t},\n\t{\n\t\tslug: 'analytics-realtime',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsRealtimeWidget',\n\t\tlabel: keys.widgetRealtimeLabel,\n\t\trequires: { realtime: true },\n\t\tminWidth: 'small' as WidgetWidth,\n\t\tmaxWidth: 'medium' as WidgetWidth,\n\t\tfields: realtimeWidgetFields,\n\t},\n\t{\n\t\tslug: 'analytics-goals',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsGoalsWidget',\n\t\tlabel: keys.widgetGoals,\n\t\trequires: { metrics: ['conversions'], dimensions: ['goal'] },\n\t\tminWidth: 'small' as WidgetWidth,\n\t\tmaxWidth: 'large' as WidgetWidth,\n\t\tfields: goalsWidgetFields,\n\t},\n\t...BREAKDOWN_SPECS.map(\n\t\t(spec): WidgetDef => ({\n\t\t\tslug: spec.slug,\n\t\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsBreakdownWidget',\n\t\t\tlabel: spec.label,\n\t\t\trequires: { dimensions: [spec.dimension] },\n\t\t\tminWidth: 'small' as WidgetWidth,\n\t\t\tmaxWidth: 'large' as WidgetWidth,\n\t\t\tfields: (args) => breakdownWidgetFields(args, spec),\n\t\t})\n\t),\n]\n\nexport const registerWidgets = (config: Config, args: RegisterWidgetsArgs): void => {\n\tconst built: Widget[] = []\n\tfor (const def of WIDGET_DEFS) {\n\t\tif (args.disabled.includes(def.slug)) {\n\t\t\tcontinue\n\t\t}\n\t\tif (!args.providersEnabled && !widgetIsSupported(def.requires, args.adapters)) {\n\t\t\tcontinue\n\t\t}\n\t\tconst fields = def.fields(args)\n\t\t// A required metric select with no servable option would make the widget\n\t\t// impossible to configure; skip it like an unsupported widget.\n\t\tconst metricField = findMetricField(fields)\n\t\tif (metricField && 'options' in metricField && metricField.options.length === 0) {\n\t\t\tcontinue\n\t\t}\n\t\tbuilt.push({\n\t\t\tslug: def.slug,\n\t\t\tComponent: { path: def.component, serverProps: { view: args.view ?? false } },\n\t\t\tlabel: labelForKey(def.label),\n\t\t\tfields,\n\t\t\tminWidth: def.minWidth,\n\t\t\tmaxWidth: def.maxWidth,\n\t\t})\n\t}\n\tbuilt.push(...buildCustomWidgets(args.register, args.adapters, args.disabled))\n\tif (!built.length) {\n\t\treturn\n\t}\n\tconfig.admin ??= {}\n\tconfig.admin.dashboard ??= { widgets: [] }\n\tconfig.admin.dashboard.widgets ??= []\n\tconfig.admin.dashboard.widgets.push(...built)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AA6BA,MAAM,eAAe,SAAiD;CACrE,IAAI,GAAG;CACP,IAAI,GAAG;AACR;AAqCA,MAAa,qBACZ,UACA,aACa,CAAC,YAAY,SAAS,MAAM,MAAM,sBAAsB,EAAE,cAAc,QAAQ,CAAC;;;;;;;;;;;;;;;AAgB/F,MAAM,qBACL,YACA,MACA,OAGI,CAAC,MACM;CACX,MAAM,EAAE,OAAO,mBAAmB,gBAAgB;CAClD,MAAM,YAAY,SAA2B,WAC5C,sBAAsB,QAAQ,cAAc;EAAE,GAAG;EAAO,SAAS,CAAC,MAAM;CAAE,CAAC;CAC5E,MAAM,WACL,KAAK,mBACF,aACA,WAAW,QAAQ,MAAM,KAAK,SAAS,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,CAAC,GACpE,KAAK,OAAO;EAAE,OAAO;EAAG,OAAO,YAAY,YAAY,EAAE;CAAE,EAAE;CAC/D,MAAM,eAAe,QAAQ,MAAM,MAAM,EAAE,UAAU,gBAAgB,IAClE,mBACA,QAAQ,IAAI;CACf,MAAM,iBAA+C,EAAE,SAAS,MAAM,kBAAkB;EACvF,MAAM,WAAY,aAAsD;EACxE,MAAM,UACL,OAAO,aAAa,WAAW,KAAK,SAAS,MAAM,MAAM,EAAE,OAAO,QAAQ,IAAI,KAAA;EAC/E,IAAI,CAAC,SACJ,OAAO;EAER,OAAO,KAAK,QAAQ,MAAM,OAAO,MAAM,YAAY,SAAS,SAAS,EAAE,KAAkB,CAAC;CAC3F;CACA,OAAO;EACN,MAAM;EACN,MAAM;EACN,UAAU;EACV,GAAI,iBAAiB,KAAA,IAAY,EAAE,aAAa,IAAI,CAAC;EACrD,OAAO,YAAY,KAAK,iBAAiB;EACzC;EACA,OAAO;GAEN,aAAa;GACb,YAAY,EACX,OAAO;IACN,MAAM;IACN,GAAI,QAAQ,EAAE,aAAa,EAAE,UAAU,MAAM,EAAE,IAAI,CAAC;GACrD,EACD;EACD;EACA,GAAI,KAAK,gBAAgB,EAAE,cAAc,IAAI,CAAC;CAC/C;AACD;AAEA,MAAM,cAAc,MAA2B,iBAAgC;CAC9E,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,gBAAgB;CACxC,GAAI,KAAK,eAAe,EAAE,WAAW,KAAK,IAAI,CAAC;CAC/C,OAAO,EAAE,YAAY;AACtB;AAEA,MAAM,8BAAqC;CAC1C,MAAM;CACN,MAAM;CACN,UAAU;CACV,cAAc;CACd,OAAO,YAAY,KAAK,oBAAoB;CAC5C,OAAO,EAAE,aAAa,MAAM;CAC5B,SAAS,CACR,GAAG,kBAAkB,KAAK,OAAO;EAAE,OAAO;EAAG,OAAO,YAAY,eAAe,EAAE;CAAE,EAAE,GACrF;EAAE,OAAO;EAAU,OAAO,YAAY,KAAK,qBAAqB;CAAE,CACnE;AACD;;AAGA,MAAM,sBAA6B;CAClC,MAAM;CACN,MAAM;CACN,cAAc;CACd,OAAO,YAAY,KAAK,kBAAkB;AAC3C;AAEA,MAAM,mBAAmB,UAAsC;CAC9D,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,qBAAqB;CAC7C,cAAc,KAAK,aAAa,KAAK,SAAS,IAAI;CAClD,OAAO;EAEN,aAAa;EACb,YAAY,EAAE,OAAO,EAAE,MAAM,gDAAgD,EAAE;CAChF;CACA,SAAS,KAAK,SAAS,KAAK,OAAO;EAAE,OAAO,EAAE;EAAI,OAAO,EAAE;CAAM,EAAE;CAGnE,YAAY,UACX,UAAU,KAAA,KAAa,UAAU,QAAS,OAAO,UAAU,YAAY,MAAM,SAAS,IACnF,OACA;AACL;AAEA,MAAM,yBACL,eAAe;CACd,MAAM;CACN,OAAO,YAAY,KAAK,gBAAgB;CACxC,kBAAkB;CAClB,YAAY,OAAO;EAClB,GAAG;EACH,OAAO;GACN,GAAG,EAAE;GACL,YAAY,OAAO,gBAAgB,aAAa,cAAc;EAC/D;CACD;AACD,CAAC;;AAGF,MAAa,mBAAmB,WAC/B,OAAO,MAAM,UAAU,UAAU,SAAS,MAAM,SAAS,QAAQ;AAElE,MAAM,sBAAsB,MAA2B,QAAiB,CAAC,MAAe;CACvF,WAAW,MAAM,GAAG,KAAK,4BAA4B;CACrD,kBAAkB,gBAAgB,IAAI;CACtC,qBAAqB;CACrB,iBAAiB;CACjB,GAAG;CACH,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;CACpD,YAAY;AACb;AAEA,MAAM,yBAAyB,MAA2B,SAAiC;CAC1F,WAAW,MAAM,GAAG,KAAK,MAAM;CAC/B,kBAAkB,gBAAgB,MAAM;EACvC,OAAO,EAAE,YAAY,CAAC,KAAK,SAAS,EAAE;EACtC,GAAI,KAAK,mBAAmB,EAAE,kBAAkB,KAAK,iBAAiB,IAAI,CAAC;CAC5E,CAAC;CACD,qBAAqB;CACrB,iBAAiB;CACjB;EACC,MAAM;EACN,MAAM;EACN,cAAc;EACd,KAAK;EACL,KAAK;EACL,OAAO,YAAY,KAAK,gBAAgB;CACzC;CACA,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;CACpD,YAAY;AACb;;AAGA,MAAM,wBAA+B;CACpC,MAAM;CACN,MAAM;CACN,cAAc,OAAO,gBAAgB,EAAE;CACvC,OAAO,YAAY,KAAK,gBAAgB;CACxC,OAAO,EAAE,aAAa,MAAM;CAC5B,SAAS,gBAAgB,KAAK,WAAW;EAAE,OAAO,OAAO,KAAK;EAAG,OAAO,OAAO,KAAK;CAAE,EAAE;AACzF;AAEA,MAAM,qBAAqB,SAAuC;CACjE,WAAW,MAAM,GAAG,KAAK,YAAY;CACrC,qBAAqB;CACrB,iBAAiB;CACjB,eAAe;CACf,GAAI,KAAK,eAAe,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC;CACpD,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;AAEA,MAAM,wBAAwB,SAAuC;CACpE,WAAW,MAAM,GAAG,KAAK,4BAA4B;CACrD,kBAAkB,CAAC,YAAY,WAAW,GAAG,MAAM;EAClD,OAAO,EAAE,UAAU,KAAK;EACxB,kBAAkB;CACnB,CAAC;CACD;EACC,MAAM;EACN,MAAM;EACN,cAAc;EACd,OAAO,YAAY,KAAK,iBAAiB;EACzC,OAAO,EAAE,aAAa,MAAM;EAC5B,SAAS;GACR;IAAE,OAAO;IAAK,OAAO;GAAQ;GAC7B;IAAE,OAAO;IAAM,OAAO;GAAS;GAC/B;IAAE,OAAO;IAAM,OAAO;GAAS;GAC/B;IAAE,OAAO;IAAM,OAAO;GAAS;EAChC;CACD;CACA,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;AAEA,MAAM,cAA2B;CAChC;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,SAAS,CAAC,WAAW,EAAE;EACnC,UAAU;EACV,UAAU;EACV,SAAS,SAAS,mBAAmB,MAAM,KAAK,eAAe,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;CAC7F;CACA;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,UAAU,KAAK;EAC3B,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU;GAAE,SAAS,CAAC,aAAa;GAAG,YAAY,CAAC,MAAM;EAAE;EAC3D,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA,GAAG,gBAAgB,KACjB,UAAqB;EACrB,MAAM,KAAK;EACX,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,YAAY,CAAC,KAAK,SAAS,EAAE;EACzC,UAAU;EACV,UAAU;EACV,SAAS,SAAS,sBAAsB,MAAM,IAAI;CACnD,EACD;AACD;AAEA,MAAa,mBAAmB,QAAgB,SAAoC;CACnF,MAAM,QAAkB,CAAC;CACzB,KAAK,MAAM,OAAO,aAAa;EAC9B,IAAI,KAAK,SAAS,SAAS,IAAI,IAAI,GAClC;EAED,IAAI,CAAC,KAAK,oBAAoB,CAAC,kBAAkB,IAAI,UAAU,KAAK,QAAQ,GAC3E;EAED,MAAM,SAAS,IAAI,OAAO,IAAI;EAG9B,MAAM,cAAc,gBAAgB,MAAM;EAC1C,IAAI,eAAe,aAAa,eAAe,YAAY,QAAQ,WAAW,GAC7E;EAED,MAAM,KAAK;GACV,MAAM,IAAI;GACV,WAAW;IAAE,MAAM,IAAI;IAAW,aAAa,EAAE,MAAM,KAAK,QAAQ,MAAM;GAAE;GAC5E,OAAO,YAAY,IAAI,KAAK;GAC5B;GACA,UAAU,IAAI;GACd,UAAU,IAAI;EACf,CAAC;CACF;CACA,MAAM,KAAK,GAAG,mBAAmB,KAAK,UAAU,KAAK,UAAU,KAAK,QAAQ,CAAC;CAC7E,IAAI,CAAC,MAAM,QACV;CAED,OAAO,UAAU,CAAC;CAClB,OAAO,MAAM,cAAc,EAAE,SAAS,CAAC,EAAE;CACzC,OAAO,MAAM,UAAU,YAAY,CAAC;CACpC,OAAO,MAAM,UAAU,QAAQ,KAAK,GAAG,KAAK;AAC7C"}
@@ -0,0 +1,15 @@
1
+ import { DimensionKey, FilterOperator } from "../core/contract.js";
2
+ //#region src/widgets/types.d.ts
3
+ /**
4
+ * The optional one-filter group a widget stores. Every part is optional because the group
5
+ * is only ever partly filled while it is being configured; a filter counts as set once it
6
+ * has a dimension and a value.
7
+ */
8
+ interface WidgetFilter {
9
+ dimension?: DimensionKey;
10
+ operator?: FilterOperator;
11
+ value?: string;
12
+ }
13
+ //#endregion
14
+ export { WidgetFilter };
15
+ //# sourceMappingURL=types.d.ts.map