@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
@@ -0,0 +1 @@
1
+ {"version":3,"file":"queryEndpoint.js","names":[],"sources":["../../src/plugin/queryEndpoint.ts"],"sourcesContent":["import type { PayloadHandler } from 'payload'\nimport { serializeCapabilities } from '../core/capabilities'\nimport {\n\ttype AnalyticsQuery,\n\ttype AnalyticsResult,\n\ttype DateRange,\n\tPLATFORM_SCOPE,\n} from '../core/contract'\nimport { resolveQueryScope } from '../core/scopedRead'\nimport { queryError } from '../query/errors'\nimport { parseQueryParams, readParam } from '../query/parse'\nimport type { QueryResponse, SerializedAnalyticsQuery } from '../query/response'\nimport { previousWindow, withinLookback } from '../widgets/comparison'\nimport { goalSlugsFor } from './goalHint'\nimport { QUERY_PATH } from './paths'\nimport { resolveSourcesForRequest } from './readContextForRequest'\nimport { errorResponse, NO_STORE, RETRY_AFTER } from './responses'\nimport { getRuntime, platformReadGate, readAccessFor, resolveTimezoneFor } from './runtime'\n\nexport { QUERY_PATH }\n\n/**\n * The query as the response echoes it: the date range's instants as ISO strings, every\n * other field as the read carried it. `goalSlugs` rides along unchanged, so a client sees\n * the scope's slugs, an empty list for a scope with no goals, or the string `'unresolved'`\n * when the resolver failed.\n */\nexport const serializeQuery = (query: AnalyticsQuery): SerializedAnalyticsQuery => ({\n\t...query,\n\tdateRange: {\n\t\tstart: query.dateRange.start.toISOString(),\n\t\tend: query.dateRange.end.toISOString(),\n\t},\n})\n\n/**\n * Authenticated GET over the surfacing engine: the public read primitive the admin view\n * and consumers' own dashboards are built on. Gating runs in a fixed order so a caller\n * learns nothing from the answer it is not already entitled to: authentication, then\n * `access.read`, then scope and source resolution (shared with the sources endpoint, so a\n * tenant can select no source that endpoint does not list), then capability validation of\n * every parameter against the selected source. Being listed is not sufficient: a shared\n * source that cannot narrow to the caller's scope answers 403 with `param: 'source'`.\n * Errors carry a code and the parameter at fault; adapter configuration and upstream error\n * text never reach the response.\n */\nexport const makeQueryHandler = (): PayloadHandler => async (req) => {\n\tif (!req.user) {\n\t\treturn errorResponse(401, queryError('unauthorized', 'analytics: authentication required'))\n\t}\n\tconst runtime = getRuntime(req.payload)\n\tif (!runtime) {\n\t\t// Both `unavailable` answers are retryable, so both carry the same delay: a client\n\t\t// backs off identically whether the plugin is still booting or a provider is down.\n\t\treturn errorResponse(503, queryError('unavailable', 'analytics: not available'), RETRY_AFTER)\n\t}\n\tlet adapterId = 'unresolved'\n\ttry {\n\t\tif (!(await readAccessFor(runtime, req))) {\n\t\t\treturn errorResponse(403, queryError('forbidden', 'analytics: read access denied'))\n\t\t}\n\t\tconst params = new URL(req.url ?? '', 'http://localhost').searchParams\n\t\tconst platformRead = platformReadGate(runtime, req)\n\t\tconst requestedScope = readParam(params, 'scope')\n\t\tif (requestedScope !== null && !(await platformRead())) {\n\t\t\treturn errorResponse(\n\t\t\t\t400,\n\t\t\t\tqueryError('untrusted_scope', 'analytics: scope is not permitted for this request', 'scope')\n\t\t\t)\n\t\t}\n\t\tconst context = await resolveSourcesForRequest(req, {\n\t\t\tplatformRead,\n\t\t\t...(requestedScope === null ? {} : { scope: requestedScope }),\n\t\t})\n\t\tif (context.adapters.size === 0) {\n\t\t\treturn errorResponse(\n\t\t\t\t404,\n\t\t\t\tqueryError('unknown_source', 'analytics: no source is available for this request')\n\t\t\t)\n\t\t}\n\t\tconst requestedSource = readParam(params, 'source')\n\t\tconst adapter = context.adapters.get(requestedSource ?? context.defaultId ?? '')\n\t\tif (!adapter) {\n\t\t\treturn errorResponse(404, queryError('unknown_source', 'analytics: unknown source', 'source'))\n\t\t}\n\t\tadapterId = adapter.id\n\t\tconst queryScope = await resolveQueryScope({\n\t\t\truntime,\n\t\t\treq,\n\t\t\tscope: context.scope,\n\t\t\tadapter,\n\t\t\tplatformRead,\n\t\t})\n\t\tif (!queryScope.ok) {\n\t\t\treturn errorResponse(\n\t\t\t\t403,\n\t\t\t\tqueryError('forbidden', 'analytics: this source cannot be read for your scope', 'source')\n\t\t\t)\n\t\t}\n\t\tconst capabilities = serializeCapabilities(adapter.capabilities)\n\t\tconst timezone = await resolveTimezoneFor(\n\t\t\truntime,\n\t\t\treq,\n\t\t\tcontext.scope === PLATFORM_SCOPE ? null : context.scope\n\t\t)\n\t\tconst parsed = parseQueryParams(params, { capabilities, timezone })\n\t\tif (!parsed.ok) {\n\t\t\treturn errorResponse(400, parsed.error)\n\t\t}\n\t\tconst goalSlugs = await goalSlugsFor({\n\t\t\truntime,\n\t\t\treq,\n\t\t\tscope: context.scope === PLATFORM_SCOPE ? null : context.scope,\n\t\t\tmetrics: parsed.value.query.metrics,\n\t\t\tdimensions: parsed.value.query.dimensions,\n\t\t})\n\t\tconst query: AnalyticsQuery = {\n\t\t\t...parsed.value.query,\n\t\t\t...(queryScope.queryScope === undefined ? {} : { scope: queryScope.queryScope }),\n\t\t\t...(goalSlugs === undefined ? {} : { goalSlugs }),\n\t\t}\n\t\tlet comparisonRange: DateRange | null = null\n\t\tif (parsed.value.compare === 'previous') {\n\t\t\tcomparisonRange = previousWindow(query.dateRange, query.timezone)\n\t\t\tif (!comparisonRange) {\n\t\t\t\treturn errorResponse(\n\t\t\t\t\t400,\n\t\t\t\t\tqueryError(\n\t\t\t\t\t\t'invalid_param',\n\t\t\t\t\t\t'analytics: the range is too long to compare against a previous period',\n\t\t\t\t\t\t'compare'\n\t\t\t\t\t)\n\t\t\t\t)\n\t\t\t}\n\t\t\t// The view decides this same predicate on the browser clock, so a client near the\n\t\t\t// floor or with a skewed clock must lose only its delta, never the whole read.\n\t\t\tif (\n\t\t\t\t!withinLookback(comparisonRange, adapter.capabilities.maxLookbackDays, {\n\t\t\t\t\ttz: query.timezone,\n\t\t\t\t})\n\t\t\t) {\n\t\t\t\tcomparisonRange = null\n\t\t\t}\n\t\t}\n\t\tlet result: AnalyticsResult\n\t\tlet comparison: AnalyticsResult | undefined\n\t\ttry {\n\t\t\t;[result, comparison] = await Promise.all([\n\t\t\t\truntime.engine.read(adapter, query),\n\t\t\t\tcomparisonRange\n\t\t\t\t\t? runtime.engine.read(adapter, { ...query, dateRange: comparisonRange })\n\t\t\t\t\t: undefined,\n\t\t\t])\n\t\t} catch (err) {\n\t\t\t// Neither a fresh nor a stale entry survived the read: the source is down, not the\n\t\t\t// request wrong, so the client is told to retry rather than to change anything.\n\t\t\treq.payload.logger?.warn(\n\t\t\t\t`analytics: query read failed for adapter \"${adapter.id}\": ${String(err)}`\n\t\t\t)\n\t\t\treturn errorResponse(\n\t\t\t\t503,\n\t\t\t\tqueryError('unavailable', 'analytics: source is temporarily unavailable'),\n\t\t\t\tRETRY_AFTER\n\t\t\t)\n\t\t}\n\t\tconst body: QueryResponse = {\n\t\t\tresult,\n\t\t\t...(comparison ? { comparison } : {}),\n\t\t\tsource: {\n\t\t\t\tid: adapter.id,\n\t\t\t\tlabel: adapter.label,\n\t\t\t\tkind: runtime.configAdapterIds.has(adapter.id) ? 'config' : 'runtime',\n\t\t\t},\n\t\t\tcapabilities,\n\t\t\tquery: serializeQuery(query),\n\t\t}\n\t\treturn Response.json(body, { headers: NO_STORE })\n\t} catch (err) {\n\t\treq.payload.logger?.warn(`analytics: query failed for adapter \"${adapterId}\": ${String(err)}`)\n\t\treturn errorResponse(500, queryError('internal', 'analytics: query failed'))\n\t}\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AA2BA,MAAa,kBAAkB,WAAqD;CACnF,GAAG;CACH,WAAW;EACV,OAAO,MAAM,UAAU,MAAM,YAAY;EACzC,KAAK,MAAM,UAAU,IAAI,YAAY;CACtC;AACD;;;;;;;;;;;;AAaA,MAAa,yBAAyC,OAAO,QAAQ;CACpE,IAAI,CAAC,IAAI,MACR,OAAO,cAAc,KAAK,WAAW,gBAAgB,oCAAoC,CAAC;CAE3F,MAAM,UAAU,WAAW,IAAI,OAAO;CACtC,IAAI,CAAC,SAGJ,OAAO,cAAc,KAAK,WAAW,eAAe,0BAA0B,GAAG,WAAW;CAE7F,IAAI,YAAY;CAChB,IAAI;EACH,IAAI,CAAE,MAAM,cAAc,SAAS,GAAG,GACrC,OAAO,cAAc,KAAK,WAAW,aAAa,+BAA+B,CAAC;EAEnF,MAAM,SAAS,IAAI,IAAI,IAAI,OAAO,IAAI,kBAAkB,EAAE;EAC1D,MAAM,eAAe,iBAAiB,SAAS,GAAG;EAClD,MAAM,iBAAiB,UAAU,QAAQ,OAAO;EAChD,IAAI,mBAAmB,QAAQ,CAAE,MAAM,aAAa,GACnD,OAAO,cACN,KACA,WAAW,mBAAmB,sDAAsD,OAAO,CAC5F;EAED,MAAM,UAAU,MAAM,yBAAyB,KAAK;GACnD;GACA,GAAI,mBAAmB,OAAO,CAAC,IAAI,EAAE,OAAO,eAAe;EAC5D,CAAC;EACD,IAAI,QAAQ,SAAS,SAAS,GAC7B,OAAO,cACN,KACA,WAAW,kBAAkB,oDAAoD,CAClF;EAED,MAAM,kBAAkB,UAAU,QAAQ,QAAQ;EAClD,MAAM,UAAU,QAAQ,SAAS,IAAI,mBAAmB,QAAQ,aAAa,EAAE;EAC/E,IAAI,CAAC,SACJ,OAAO,cAAc,KAAK,WAAW,kBAAkB,6BAA6B,QAAQ,CAAC;EAE9F,YAAY,QAAQ;EACpB,MAAM,aAAa,MAAM,kBAAkB;GAC1C;GACA;GACA,OAAO,QAAQ;GACf;GACA;EACD,CAAC;EACD,IAAI,CAAC,WAAW,IACf,OAAO,cACN,KACA,WAAW,aAAa,wDAAwD,QAAQ,CACzF;EAED,MAAM,eAAe,sBAAsB,QAAQ,YAAY;EAM/D,MAAM,SAAS,iBAAiB,QAAQ;GAAE;GAAc,UAAA,MALjC,mBACtB,SACA,KACA,QAAQ,UAAA,MAA2B,OAAO,QAAQ,KACnD;EACiE,CAAC;EAClE,IAAI,CAAC,OAAO,IACX,OAAO,cAAc,KAAK,OAAO,KAAK;EAEvC,MAAM,YAAY,MAAM,aAAa;GACpC;GACA;GACA,OAAO,QAAQ,UAAA,MAA2B,OAAO,QAAQ;GACzD,SAAS,OAAO,MAAM,MAAM;GAC5B,YAAY,OAAO,MAAM,MAAM;EAChC,CAAC;EACD,MAAM,QAAwB;GAC7B,GAAG,OAAO,MAAM;GAChB,GAAI,WAAW,eAAe,KAAA,IAAY,CAAC,IAAI,EAAE,OAAO,WAAW,WAAW;GAC9E,GAAI,cAAc,KAAA,IAAY,CAAC,IAAI,EAAE,UAAU;EAChD;EACA,IAAI,kBAAoC;EACxC,IAAI,OAAO,MAAM,YAAY,YAAY;GACxC,kBAAkB,eAAe,MAAM,WAAW,MAAM,QAAQ;GAChE,IAAI,CAAC,iBACJ,OAAO,cACN,KACA,WACC,iBACA,yEACA,SACD,CACD;GAID,IACC,CAAC,eAAe,iBAAiB,QAAQ,aAAa,iBAAiB,EACtE,IAAI,MAAM,SACX,CAAC,GAED,kBAAkB;EAEpB;EACA,IAAI;EACJ,IAAI;EACJ,IAAI;GACF,CAAC,QAAQ,cAAc,MAAM,QAAQ,IAAI,CACzC,QAAQ,OAAO,KAAK,SAAS,KAAK,GAClC,kBACG,QAAQ,OAAO,KAAK,SAAS;IAAE,GAAG;IAAO,WAAW;GAAgB,CAAC,IACrE,KAAA,CACJ,CAAC;EACF,SAAS,KAAK;GAGb,IAAI,QAAQ,QAAQ,KACnB,6CAA6C,QAAQ,GAAG,KAAK,OAAO,GAAG,GACxE;GACA,OAAO,cACN,KACA,WAAW,eAAe,8CAA8C,GACxE,WACD;EACD;EACA,MAAM,OAAsB;GAC3B;GACA,GAAI,aAAa,EAAE,WAAW,IAAI,CAAC;GACnC,QAAQ;IACP,IAAI,QAAQ;IACZ,OAAO,QAAQ;IACf,MAAM,QAAQ,iBAAiB,IAAI,QAAQ,EAAE,IAAI,WAAW;GAC7D;GACA;GACA,OAAO,eAAe,KAAK;EAC5B;EACA,OAAO,SAAS,KAAK,MAAM,EAAE,SAAS,SAAS,CAAC;CACjD,SAAS,KAAK;EACb,IAAI,QAAQ,QAAQ,KAAK,wCAAwC,UAAU,KAAK,OAAO,GAAG,GAAG;EAC7F,OAAO,cAAc,KAAK,WAAW,YAAY,yBAAyB,CAAC;CAC5E;AACD"}
@@ -0,0 +1,71 @@
1
+ import "../core/contract.js";
2
+ import { getRuntime, platformReadGate, resolveRegistryFor, resolveScopeFor } from "./runtime.js";
3
+ import { serializeCapabilities } from "../core/capabilities.js";
4
+ //#region src/plugin/readContextForRequest.ts
5
+ const empty = () => ({
6
+ sources: [],
7
+ defaultId: null,
8
+ adapters: /* @__PURE__ */ new Map(),
9
+ scope: null
10
+ });
11
+ const fromRegistry = (args) => {
12
+ const { runtime, registry, scope } = args;
13
+ const adapters = registry.all();
14
+ return {
15
+ sources: adapters.map((adapter) => ({
16
+ id: adapter.id,
17
+ label: adapter.label,
18
+ kind: runtime.configAdapterIds.has(adapter.id) ? "config" : "runtime",
19
+ capabilities: serializeCapabilities(adapter.capabilities)
20
+ })),
21
+ defaultId: registry.default().id,
22
+ adapters: new Map(adapters.map((adapter) => [adapter.id, adapter])),
23
+ scope
24
+ };
25
+ };
26
+ /**
27
+ * The sources a request may read, resolved once for both read endpoints: the request's
28
+ * own scope (or a trusted explicit one), the per-scope registry, and each adapter's
29
+ * serialized capabilities. Two resolutions are cross-scope and fail closed behind
30
+ * `platformRead`: a scopeResolver answering the `'*'` marker, and, on a scoped install, one
31
+ * answering no scope at all, which is ambiguous rather than install-wide (returning null
32
+ * usually means "no tenant selected"). A failed resolution resolves nothing too, since it is
33
+ * indistinguishable from a forged one. An unscoped install falls back to the static config
34
+ * registry on failure.
35
+ */
36
+ const resolveSourcesForRequest = async (req, args = {}) => {
37
+ const runtime = getRuntime(req.payload);
38
+ if (!runtime) return empty();
39
+ const allowed = args.platformRead ?? platformReadGate(runtime, req);
40
+ try {
41
+ let scope;
42
+ if (args.scope !== void 0) {
43
+ if (!await allowed()) return empty();
44
+ scope = args.scope;
45
+ } else {
46
+ scope = await resolveScopeFor(runtime, req);
47
+ if ((scope === "*" || runtime.scoped && scope === null) && !await allowed()) return empty();
48
+ }
49
+ return fromRegistry({
50
+ runtime,
51
+ registry: await resolveRegistryFor(runtime, {
52
+ payload: req.payload,
53
+ req,
54
+ scope: scope === "*" ? null : scope
55
+ }),
56
+ scope
57
+ });
58
+ } catch (err) {
59
+ req.payload.logger?.warn(`analytics: source resolution failed: ${String(err)}`);
60
+ if (runtime.scoped) return empty();
61
+ return fromRegistry({
62
+ runtime,
63
+ registry: runtime.registry,
64
+ scope: null
65
+ });
66
+ }
67
+ };
68
+ //#endregion
69
+ export { resolveSourcesForRequest };
70
+
71
+ //# sourceMappingURL=readContextForRequest.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"readContextForRequest.js","names":[],"sources":["../../src/plugin/readContextForRequest.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\nimport { type SerializedCapabilities, serializeCapabilities } from '../core/capabilities'\nimport { type AnalyticsAdapter, PLATFORM_SCOPE } from '../core/contract'\nimport type { AdapterRegistry } from '../core/registry'\nimport type { QuerySourceRef } from '../query/response'\nimport {\n\ttype AnalyticsRuntime,\n\tgetRuntime,\n\ttype PlatformReadGate,\n\tplatformReadGate,\n\tresolveRegistryFor,\n\tresolveScopeFor,\n} from './runtime'\n\n/** One readable source on the wire: its identity plus the capabilities a client gates on. */\nexport interface RequestSource extends QuerySourceRef {\n\tcapabilities: SerializedCapabilities\n}\n\nexport interface RequestSources {\n\t/** Wire rows for the resolved scope, in registry order; empty when none resolve. */\n\tsources: RequestSource[]\n\tdefaultId: string | null\n\t/** The adapters behind `sources`, for callers that read through them. */\n\tadapters: ReadonlyMap<string, AnalyticsAdapter>\n\t/** Scope the sources were resolved for; null is install-wide, `*` is cross-scope. */\n\tscope: string | null\n}\n\nexport interface ResolveSourcesArgs {\n\t/**\n\t * Read another scope's sources instead of the request's own. Evaluated behind\n\t * `access.platformRead`; a denied override resolves nothing at all.\n\t */\n\tscope?: string | null\n\t/** Shared `platformRead` decision; one is created per call when omitted. */\n\tplatformRead?: PlatformReadGate\n}\n\nconst empty = (): RequestSources => ({\n\tsources: [],\n\tdefaultId: null,\n\tadapters: new Map(),\n\tscope: null,\n})\n\nconst fromRegistry = (args: {\n\truntime: AnalyticsRuntime\n\tregistry: AdapterRegistry\n\tscope: string | null\n}): RequestSources => {\n\tconst { runtime, registry, scope } = args\n\tconst adapters = registry.all()\n\treturn {\n\t\tsources: adapters.map((adapter) => ({\n\t\t\tid: adapter.id,\n\t\t\tlabel: adapter.label,\n\t\t\tkind: runtime.configAdapterIds.has(adapter.id) ? ('config' as const) : ('runtime' as const),\n\t\t\tcapabilities: serializeCapabilities(adapter.capabilities),\n\t\t})),\n\t\tdefaultId: registry.default().id,\n\t\tadapters: new Map(adapters.map((adapter) => [adapter.id, adapter])),\n\t\tscope,\n\t}\n}\n\n/**\n * The sources a request may read, resolved once for both read endpoints: the request's\n * own scope (or a trusted explicit one), the per-scope registry, and each adapter's\n * serialized capabilities. Two resolutions are cross-scope and fail closed behind\n * `platformRead`: a scopeResolver answering the `'*'` marker, and, on a scoped install, one\n * answering no scope at all, which is ambiguous rather than install-wide (returning null\n * usually means \"no tenant selected\"). A failed resolution resolves nothing too, since it is\n * indistinguishable from a forged one. An unscoped install falls back to the static config\n * registry on failure.\n */\nexport const resolveSourcesForRequest = async (\n\treq: PayloadRequest,\n\targs: ResolveSourcesArgs = {}\n): Promise<RequestSources> => {\n\tconst runtime = getRuntime(req.payload)\n\tif (!runtime) {\n\t\treturn empty()\n\t}\n\tconst allowed = args.platformRead ?? platformReadGate(runtime, req)\n\ttry {\n\t\tlet scope: string | null\n\t\tif (args.scope !== undefined) {\n\t\t\tif (!(await allowed())) {\n\t\t\t\treturn empty()\n\t\t\t}\n\t\t\tscope = args.scope\n\t\t} else {\n\t\t\tscope = await resolveScopeFor(runtime, req)\n\t\t\tconst crossScope = scope === PLATFORM_SCOPE || (runtime.scoped && scope === null)\n\t\t\tif (crossScope && !(await allowed())) {\n\t\t\t\treturn empty()\n\t\t\t}\n\t\t}\n\t\tconst registry = await resolveRegistryFor(runtime, {\n\t\t\tpayload: req.payload,\n\t\t\treq,\n\t\t\tscope: scope === PLATFORM_SCOPE ? null : scope,\n\t\t})\n\t\treturn fromRegistry({ runtime, registry, scope })\n\t} catch (err) {\n\t\treq.payload.logger?.warn(`analytics: source resolution failed: ${String(err)}`)\n\t\tif (runtime.scoped) {\n\t\t\treturn empty()\n\t\t}\n\t\treturn fromRegistry({ runtime, registry: runtime.registry, scope: null })\n\t}\n}\n"],"mappings":";;;;AAuCA,MAAM,eAA+B;CACpC,SAAS,CAAC;CACV,WAAW;CACX,0BAAU,IAAI,IAAI;CAClB,OAAO;AACR;AAEA,MAAM,gBAAgB,SAIA;CACrB,MAAM,EAAE,SAAS,UAAU,UAAU;CACrC,MAAM,WAAW,SAAS,IAAI;CAC9B,OAAO;EACN,SAAS,SAAS,KAAK,aAAa;GACnC,IAAI,QAAQ;GACZ,OAAO,QAAQ;GACf,MAAM,QAAQ,iBAAiB,IAAI,QAAQ,EAAE,IAAK,WAAsB;GACxE,cAAc,sBAAsB,QAAQ,YAAY;EACzD,EAAE;EACF,WAAW,SAAS,QAAQ,EAAE;EAC9B,UAAU,IAAI,IAAI,SAAS,KAAK,YAAY,CAAC,QAAQ,IAAI,OAAO,CAAC,CAAC;EAClE;CACD;AACD;;;;;;;;;;;AAYA,MAAa,2BAA2B,OACvC,KACA,OAA2B,CAAC,MACC;CAC7B,MAAM,UAAU,WAAW,IAAI,OAAO;CACtC,IAAI,CAAC,SACJ,OAAO,MAAM;CAEd,MAAM,UAAU,KAAK,gBAAgB,iBAAiB,SAAS,GAAG;CAClE,IAAI;EACH,IAAI;EACJ,IAAI,KAAK,UAAU,KAAA,GAAW;GAC7B,IAAI,CAAE,MAAM,QAAQ,GACnB,OAAO,MAAM;GAEd,QAAQ,KAAK;EACd,OAAO;GACN,QAAQ,MAAM,gBAAgB,SAAS,GAAG;GAE1C,KADmB,UAAA,OAA6B,QAAQ,UAAU,UAAU,SAC1D,CAAE,MAAM,QAAQ,GACjC,OAAO,MAAM;EAEf;EAMA,OAAO,aAAa;GAAE;GAAS,UAAA,MALR,mBAAmB,SAAS;IAClD,SAAS,IAAI;IACb;IACA,OAAO,UAAA,MAA2B,OAAO;GAC1C,CAAC;GACwC;EAAM,CAAC;CACjD,SAAS,KAAK;EACb,IAAI,QAAQ,QAAQ,KAAK,wCAAwC,OAAO,GAAG,GAAG;EAC9E,IAAI,QAAQ,QACX,OAAO,MAAM;EAEd,OAAO,aAAa;GAAE;GAAS,UAAU,QAAQ;GAAU,OAAO;EAAK,CAAC;CACzE;AACD"}
@@ -1,4 +1,7 @@
1
1
  import "./paths.js";
2
+ import { getRuntime, readAccessFor } from "./runtime.js";
3
+ import { NO_STORE, RETRY_AFTER, errorResponse } from "./responses.js";
4
+ import { queryError } from "../query/errors.js";
2
5
  import { readForWidgetRealtime } from "../widgets/readForWidgetRealtime.js";
3
6
  //#region src/plugin/realtimeEndpoint.ts
4
7
  const ALLOWED_METRICS = ["visitors", "pageviews"];
@@ -11,24 +14,49 @@ const ALLOWED_WINDOWS = [
11
14
  const DEFAULT_WINDOW = 30;
12
15
  /**
13
16
  * Authenticated GET handler for the realtime widget poller. Reads + clamps the query
14
- * params, then delegates to readForWidgetRealtime. Returns 401 for an anonymous request.
15
- * The gate is any authenticated user (not admin-panel access specifically); the response
16
- * is integer counts only. Tightening to admin-only is a post-v1 option.
17
+ * params, then delegates to readForWidgetRealtime. Returns 401 for an anonymous request
18
+ * and 403 when `access.read` denies, which defaults to any authenticated user (not
19
+ * admin-panel access specifically); the response is integer counts only. A source that
20
+ * throws answers a retryable 503 rather than an unhandled 500: the widget polls this every
21
+ * few seconds, and a provider outage is not a reason to burn a stack trace per poll. Only
22
+ * the read is retryable, though, so an `access.read` resolver that throws answers 500: that
23
+ * is a configuration bug, and telling the poller to come back would only repeat it. Every
24
+ * answer is `no-store`, since what it counts depends on the caller's own scope.
17
25
  */
18
26
  const makeRealtimeHandler = () => async (req) => {
19
- if (!req.user) return Response.json({ error: "unauthorized" }, { status: 401 });
20
- const params = new URL(req.url ?? "", "http://localhost").searchParams;
21
- const rawMetric = params.get("metric");
22
- const metric = ALLOWED_METRICS.includes(rawMetric) ? rawMetric : "visitors";
23
- const rawWindow = Number(params.get("windowMinutes"));
24
- const result = await readForWidgetRealtime({
25
- req,
26
- metric,
27
- windowMinutes: ALLOWED_WINDOWS.includes(rawWindow) ? rawWindow : DEFAULT_WINDOW,
28
- adapterId: params.get("dataSource") ?? void 0,
29
- now: /* @__PURE__ */ new Date()
27
+ if (!req.user) return Response.json({ error: "unauthorized" }, {
28
+ status: 401,
29
+ headers: NO_STORE
30
30
  });
31
- return Response.json(result);
31
+ try {
32
+ const runtime = getRuntime(req.payload);
33
+ if (runtime && !await readAccessFor(runtime, req)) return Response.json({ error: "forbidden" }, {
34
+ status: 403,
35
+ headers: NO_STORE
36
+ });
37
+ const params = new URL(req.url ?? "", "http://localhost").searchParams;
38
+ const rawMetric = params.get("metric");
39
+ const metric = ALLOWED_METRICS.includes(rawMetric) ? rawMetric : "visitors";
40
+ const rawWindow = Number(params.get("windowMinutes"));
41
+ const windowMinutes = ALLOWED_WINDOWS.includes(rawWindow) ? rawWindow : DEFAULT_WINDOW;
42
+ const dataSource = params.get("dataSource") ?? void 0;
43
+ try {
44
+ const result = await readForWidgetRealtime({
45
+ req,
46
+ metric,
47
+ windowMinutes,
48
+ adapterId: dataSource,
49
+ now: /* @__PURE__ */ new Date()
50
+ });
51
+ return Response.json(result, { headers: NO_STORE });
52
+ } catch (err) {
53
+ req.payload.logger?.warn(`analytics: realtime read failed: ${String(err)}`);
54
+ return errorResponse(503, queryError("unavailable", "analytics: source is temporarily unavailable"), RETRY_AFTER);
55
+ }
56
+ } catch (err) {
57
+ req.payload.logger?.warn(`analytics: realtime request failed: ${String(err)}`);
58
+ return errorResponse(500, queryError("internal", "analytics: realtime read failed"));
59
+ }
32
60
  };
33
61
  //#endregion
34
62
  export { makeRealtimeHandler };
@@ -1 +1 @@
1
- {"version":3,"file":"realtimeEndpoint.js","names":[],"sources":["../../src/plugin/realtimeEndpoint.ts"],"sourcesContent":["import type { PayloadHandler } from 'payload'\nimport type { MetricKey } from '../core/contract'\nimport { readForWidgetRealtime } from '../widgets/readForWidgetRealtime'\nimport { REALTIME_PATH } from './paths'\n\nexport { REALTIME_PATH }\n\nconst ALLOWED_METRICS: MetricKey[] = ['visitors', 'pageviews']\nconst ALLOWED_WINDOWS = [5, 15, 30, 60]\nconst DEFAULT_WINDOW = 30\n\n/**\n * Authenticated GET handler for the realtime widget poller. Reads + clamps the query\n * params, then delegates to readForWidgetRealtime. Returns 401 for an anonymous request.\n * The gate is any authenticated user (not admin-panel access specifically); the response\n * is integer counts only. Tightening to admin-only is a post-v1 option.\n */\nexport const makeRealtimeHandler = (): PayloadHandler => async (req) => {\n\tif (!req.user) {\n\t\treturn Response.json({ error: 'unauthorized' }, { status: 401 })\n\t}\n\tconst params = new URL(req.url ?? '', 'http://localhost').searchParams\n\tconst rawMetric = params.get('metric')\n\tconst metric: MetricKey = ALLOWED_METRICS.includes(rawMetric as MetricKey)\n\t\t? (rawMetric as MetricKey)\n\t\t: 'visitors'\n\tconst rawWindow = Number(params.get('windowMinutes'))\n\tconst windowMinutes = ALLOWED_WINDOWS.includes(rawWindow) ? rawWindow : DEFAULT_WINDOW\n\tconst dataSource = params.get('dataSource') ?? undefined\n\tconst result = await readForWidgetRealtime({\n\t\treq,\n\t\tmetric,\n\t\twindowMinutes,\n\t\tadapterId: dataSource,\n\t\tnow: new Date(),\n\t})\n\treturn Response.json(result)\n}\n"],"mappings":";;;AAOA,MAAM,kBAA+B,CAAC,YAAY,WAAW;AAC7D,MAAM,kBAAkB;CAAC;CAAG;CAAI;CAAI;AAAE;AACtC,MAAM,iBAAiB;;;;;;;AAQvB,MAAa,4BAA4C,OAAO,QAAQ;CACvE,IAAI,CAAC,IAAI,MACR,OAAO,SAAS,KAAK,EAAE,OAAO,eAAe,GAAG,EAAE,QAAQ,IAAI,CAAC;CAEhE,MAAM,SAAS,IAAI,IAAI,IAAI,OAAO,IAAI,kBAAkB,EAAE;CAC1D,MAAM,YAAY,OAAO,IAAI,QAAQ;CACrC,MAAM,SAAoB,gBAAgB,SAAS,SAAsB,IACrE,YACD;CACH,MAAM,YAAY,OAAO,OAAO,IAAI,eAAe,CAAC;CAGpD,MAAM,SAAS,MAAM,sBAAsB;EAC1C;EACA;EACA,eALqB,gBAAgB,SAAS,SAAS,IAAI,YAAY;EAMvE,WALkB,OAAO,IAAI,YAAY,KAAK,KAAA;EAM9C,qBAAK,IAAI,KAAK;CACf,CAAC;CACD,OAAO,SAAS,KAAK,MAAM;AAC5B"}
1
+ {"version":3,"file":"realtimeEndpoint.js","names":[],"sources":["../../src/plugin/realtimeEndpoint.ts"],"sourcesContent":["import type { PayloadHandler } from 'payload'\nimport type { MetricKey } from '../core/contract'\nimport { queryError } from '../query/errors'\nimport { readForWidgetRealtime } from '../widgets/readForWidgetRealtime'\nimport { REALTIME_PATH } from './paths'\nimport { errorResponse, NO_STORE, RETRY_AFTER } from './responses'\nimport { getRuntime, readAccessFor } from './runtime'\n\nexport { REALTIME_PATH }\n\nconst ALLOWED_METRICS: MetricKey[] = ['visitors', 'pageviews']\nconst ALLOWED_WINDOWS = [5, 15, 30, 60]\nconst DEFAULT_WINDOW = 30\n\n/**\n * Authenticated GET handler for the realtime widget poller. Reads + clamps the query\n * params, then delegates to readForWidgetRealtime. Returns 401 for an anonymous request\n * and 403 when `access.read` denies, which defaults to any authenticated user (not\n * admin-panel access specifically); the response is integer counts only. A source that\n * throws answers a retryable 503 rather than an unhandled 500: the widget polls this every\n * few seconds, and a provider outage is not a reason to burn a stack trace per poll. Only\n * the read is retryable, though, so an `access.read` resolver that throws answers 500: that\n * is a configuration bug, and telling the poller to come back would only repeat it. Every\n * answer is `no-store`, since what it counts depends on the caller's own scope.\n */\nexport const makeRealtimeHandler = (): PayloadHandler => async (req) => {\n\tif (!req.user) {\n\t\treturn Response.json({ error: 'unauthorized' }, { status: 401, headers: NO_STORE })\n\t}\n\ttry {\n\t\tconst runtime = getRuntime(req.payload)\n\t\t// No runtime means no adapter to read, so the skipped gate protects no data.\n\t\tif (runtime && !(await readAccessFor(runtime, req))) {\n\t\t\treturn Response.json({ error: 'forbidden' }, { status: 403, headers: NO_STORE })\n\t\t}\n\t\tconst params = new URL(req.url ?? '', 'http://localhost').searchParams\n\t\tconst rawMetric = params.get('metric')\n\t\tconst metric: MetricKey = ALLOWED_METRICS.includes(rawMetric as MetricKey)\n\t\t\t? (rawMetric as MetricKey)\n\t\t\t: 'visitors'\n\t\tconst rawWindow = Number(params.get('windowMinutes'))\n\t\tconst windowMinutes = ALLOWED_WINDOWS.includes(rawWindow) ? rawWindow : DEFAULT_WINDOW\n\t\tconst dataSource = params.get('dataSource') ?? undefined\n\t\ttry {\n\t\t\tconst result = await readForWidgetRealtime({\n\t\t\t\treq,\n\t\t\t\tmetric,\n\t\t\t\twindowMinutes,\n\t\t\t\tadapterId: dataSource,\n\t\t\t\tnow: new Date(),\n\t\t\t})\n\t\t\treturn Response.json(result, { headers: NO_STORE })\n\t\t} catch (err) {\n\t\t\treq.payload.logger?.warn(`analytics: realtime read failed: ${String(err)}`)\n\t\t\treturn errorResponse(\n\t\t\t\t503,\n\t\t\t\tqueryError('unavailable', 'analytics: source is temporarily unavailable'),\n\t\t\t\tRETRY_AFTER\n\t\t\t)\n\t\t}\n\t} catch (err) {\n\t\treq.payload.logger?.warn(`analytics: realtime request failed: ${String(err)}`)\n\t\treturn errorResponse(500, queryError('internal', 'analytics: realtime read failed'))\n\t}\n}\n"],"mappings":";;;;;;AAUA,MAAM,kBAA+B,CAAC,YAAY,WAAW;AAC7D,MAAM,kBAAkB;CAAC;CAAG;CAAI;CAAI;AAAE;AACtC,MAAM,iBAAiB;;;;;;;;;;;;AAavB,MAAa,4BAA4C,OAAO,QAAQ;CACvE,IAAI,CAAC,IAAI,MACR,OAAO,SAAS,KAAK,EAAE,OAAO,eAAe,GAAG;EAAE,QAAQ;EAAK,SAAS;CAAS,CAAC;CAEnF,IAAI;EACH,MAAM,UAAU,WAAW,IAAI,OAAO;EAEtC,IAAI,WAAW,CAAE,MAAM,cAAc,SAAS,GAAG,GAChD,OAAO,SAAS,KAAK,EAAE,OAAO,YAAY,GAAG;GAAE,QAAQ;GAAK,SAAS;EAAS,CAAC;EAEhF,MAAM,SAAS,IAAI,IAAI,IAAI,OAAO,IAAI,kBAAkB,EAAE;EAC1D,MAAM,YAAY,OAAO,IAAI,QAAQ;EACrC,MAAM,SAAoB,gBAAgB,SAAS,SAAsB,IACrE,YACD;EACH,MAAM,YAAY,OAAO,OAAO,IAAI,eAAe,CAAC;EACpD,MAAM,gBAAgB,gBAAgB,SAAS,SAAS,IAAI,YAAY;EACxE,MAAM,aAAa,OAAO,IAAI,YAAY,KAAK,KAAA;EAC/C,IAAI;GACH,MAAM,SAAS,MAAM,sBAAsB;IAC1C;IACA;IACA;IACA,WAAW;IACX,qBAAK,IAAI,KAAK;GACf,CAAC;GACD,OAAO,SAAS,KAAK,QAAQ,EAAE,SAAS,SAAS,CAAC;EACnD,SAAS,KAAK;GACb,IAAI,QAAQ,QAAQ,KAAK,oCAAoC,OAAO,GAAG,GAAG;GAC1E,OAAO,cACN,KACA,WAAW,eAAe,8CAA8C,GACxE,WACD;EACD;CACD,SAAS,KAAK;EACb,IAAI,QAAQ,QAAQ,KAAK,uCAAuC,OAAO,GAAG,GAAG;EAC7E,OAAO,cAAc,KAAK,WAAW,YAAY,iCAAiC,CAAC;CACpF;AACD"}
@@ -0,0 +1,17 @@
1
+ //#region src/plugin/responses.ts
2
+ /** Scope depends on the caller's cookies, so no shared cache may ever hold an answer. */
3
+ const NO_STORE = { "Cache-Control": "private, no-store" };
4
+ /** How long a client should wait out a provider outage before retrying the same read. */
5
+ const RETRY_AFTER = { "Retry-After": "30" };
6
+ /** A read endpoint's error answer: coded body, never cached, headers merged over `NO_STORE`. */
7
+ const errorResponse = (status, error, headers = {}) => Response.json({ error }, {
8
+ status,
9
+ headers: {
10
+ ...NO_STORE,
11
+ ...headers
12
+ }
13
+ });
14
+ //#endregion
15
+ export { NO_STORE, RETRY_AFTER, errorResponse };
16
+
17
+ //# sourceMappingURL=responses.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"responses.js","names":[],"sources":["../../src/plugin/responses.ts"],"sourcesContent":["import type { QueryError } from '../query/errors'\n\n/** Scope depends on the caller's cookies, so no shared cache may ever hold an answer. */\nexport const NO_STORE = { 'Cache-Control': 'private, no-store' }\n\n/** How long a client should wait out a provider outage before retrying the same read. */\nexport const RETRY_AFTER = { 'Retry-After': '30' }\n\n/** A read endpoint's error answer: coded body, never cached, headers merged over `NO_STORE`. */\nexport const errorResponse = (\n\tstatus: number,\n\terror: QueryError,\n\theaders: Record<string, string> = {}\n): Response => Response.json({ error }, { status, headers: { ...NO_STORE, ...headers } })\n"],"mappings":";;AAGA,MAAa,WAAW,EAAE,iBAAiB,oBAAoB;;AAG/D,MAAa,cAAc,EAAE,eAAe,KAAK;;AAGjD,MAAa,iBACZ,QACA,OACA,UAAkC,CAAC,MACrB,SAAS,KAAK,EAAE,MAAM,GAAG;CAAE;CAAQ,SAAS;EAAE,GAAG;EAAU,GAAG;CAAQ;AAAE,CAAC"}
@@ -1,3 +1,4 @@
1
+ import "../core/contract.js";
1
2
  //#region src/plugin/runtime.ts
2
3
  /**
3
4
  * Stored on the Payload instance (not a module global) so the runtime survives the
@@ -13,9 +14,38 @@ const setRuntime = (payload, runtime) => {
13
14
  const getRuntime = (payload) => payload[RUNTIME_KEY];
14
15
  const resolveScopeFor = (runtime, req) => runtime.resolveScope?.(req) ?? Promise.resolve(null);
15
16
  const resolveTimezoneFor = (runtime, req, scope) => runtime.resolveTimezone?.(req, scope) ?? Promise.resolve("UTC");
17
+ /**
18
+ * The reporting timezone of a request, resolving its scope first and falling back to UTC
19
+ * when the plugin is not booted or resolution throws. Callers that must interpret a
20
+ * client-supplied or stored calendar day before the read begins use this; a read path
21
+ * already holding a resolved scope calls {@link resolveTimezoneFor} directly.
22
+ */
23
+ const requestTimezone = async (req) => {
24
+ const runtime = getRuntime(req.payload);
25
+ if (!runtime) return "UTC";
26
+ try {
27
+ const scope = await resolveScopeFor(runtime, req);
28
+ return await resolveTimezoneFor(runtime, req, scope === "*" ? null : scope);
29
+ } catch {
30
+ return "UTC";
31
+ }
32
+ };
16
33
  const resolveRegistryFor = (runtime, args) => runtime.resolveRegistry?.(args) ?? Promise.resolve(runtime.registry);
34
+ const resolveGoalsFor = (runtime, req, scope) => runtime.resolveGoals?.(req, scope) ?? Promise.resolve(runtime.goals ?? []);
35
+ const resolveGoalsDetailedFor = (runtime, req, scope) => runtime.resolveGoalsDetailed?.(req, scope) ?? Promise.resolve((runtime.goals ?? []).map((goal) => ({
36
+ goal,
37
+ source: "config"
38
+ })));
39
+ const readAccessFor = async (runtime, req) => runtime.readAccess ? await runtime.readAccess({ req }) : Boolean(req.user);
17
40
  const platformReadFor = async (runtime, req) => runtime.platformRead ? await runtime.platformRead({ req }) : Boolean(req.user);
41
+ const platformReadGate = (runtime, req) => {
42
+ let pending;
43
+ return () => {
44
+ pending ??= platformReadFor(runtime, req);
45
+ return pending;
46
+ };
47
+ };
18
48
  //#endregion
19
- export { getRuntime, platformReadFor, resolveRegistryFor, resolveScopeFor, resolveTimezoneFor, setRuntime };
49
+ export { getRuntime, platformReadFor, platformReadGate, readAccessFor, requestTimezone, resolveGoalsDetailedFor, resolveGoalsFor, resolveRegistryFor, resolveScopeFor, resolveTimezoneFor, setRuntime };
20
50
 
21
51
  //# sourceMappingURL=runtime.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"runtime.js","names":[],"sources":["../../src/plugin/runtime.ts"],"sourcesContent":["import type { Payload, PayloadRequest } from 'payload'\nimport type { ResolvedBinding } from '../binding/types'\nimport type { CaptureSlotOption, ConsentPolicy, ResolvedAutoCapture } from '../core/options'\nimport type { AdapterRegistry, RegistryResolver, ResolveRegistryArgs } from '../core/registry'\nimport type { Goal } from '../goals/types'\nimport type { Engine } from '../surfacing/engine'\nimport { DEFAULT_TIMEZONE } from '../timeframe/tz'\n\nexport interface AnalyticsRuntime {\n\tregistry: AdapterRegistry\n\t/** Per-scope adapter resolution; absent runtimes fall back to the static registry. */\n\tresolveRegistry?: RegistryResolver\n\t/** The plugin's scopeResolver bound at init; absent runtimes resolve null. */\n\tresolveScope?: (req: PayloadRequest) => Promise<string | null>\n\t/** The plugin's reportingTimezone bound at init; absent runtimes resolve 'UTC'. */\n\tresolveTimezone?: (req: PayloadRequest, scope?: string | null) => Promise<string>\n\t/** Id of the config adapter shared by every scope, when one is designated. */\n\tplatformAdapterId?: string\n\t/** `capture.slots` overrides naming the adapter that fills each capture slot. */\n\tcaptureSlots?: { global?: CaptureSlotOption; tenant?: CaptureSlotOption }\n\t/**\n\t * `capture.paths` overrides for a slot's mount. Unset, the tracker config derives the\n\t * runtime proxy mount; set when the slot is served through Next rewrites instead.\n\t */\n\tcapturePaths?: { global?: string; tenant?: string }\n\t/**\n\t * Whether a slot's tracker waits for consent, evaluated per request-resolved adapter.\n\t * Absent runtimes fall back to the default: no gate for native, one for a vendor.\n\t */\n\tconsentFor?: ConsentPolicy\n\t/** Browser auto-capture toggles handed to the tracker; absent runtimes default all on. */\n\tautoCapture?: ResolvedAutoCapture\n\t/** Config goals; the tracker receives their slug and match only. */\n\tgoals?: Goal[]\n\t/**\n\t * Where the ingest endpoint listens, relative to `routes.api`, lifted at init from the\n\t * adapter that registered one. Absent runtimes fall back to the default mount.\n\t */\n\tingestPath?: string\n\t/**\n\t * `capture.proxy` limits for the runtime capture proxy. Deliberately separate from\n\t * `cache.timeoutMs`: that is a per-read provider deadline for authenticated dashboard\n\t * queries, this is a public request path with entirely different traffic.\n\t */\n\tcaptureProxy?: { timeoutMs: number; maxBodyBytes: number }\n\t/** True when the app configured a scopeResolver (scoped install); mirrors `resolved.scoped`. */\n\tscoped?: boolean\n\t/**\n\t * Ids of the config-time adapters shared by every scope (the ones passed to\n\t * `adapters` in plugin options). Runtime provider adapters (resolved per scope\n\t * from the providers collection or `providers.resolve`) are never in it.\n\t */\n\tconfigAdapterIds: ReadonlySet<string>\n\t/** Gate for cross-scope reads; absent runtimes require an authenticated user. */\n\tplatformRead?: (args: { req: PayloadRequest }) => boolean | Promise<boolean>\n\tbindings: Record<string, ResolvedBinding>\n\tengine: Engine\n\t/** Explicit TTL overrides; when a value is unset the adapter's recommendedTtl applies. */\n\tttl: { aggregate?: number; realtime?: number }\n\t/** Widget period-over-period comparison; false skips the previous-window read. */\n\tcomparison: boolean\n}\n\n/**\n * Stored on the Payload instance (not a module global) so the runtime survives the\n * separate `.` and `/rsc` bundles a consumer loads: a server-component bundle that\n * imported its own copy of a module-level map would never see what the plugin wrote.\n * `Symbol.for` keys into the cross-realm global symbol registry, so both bundles\n * resolve the same key on the same `payload` object.\n */\nconst RUNTIME_KEY = Symbol.for('@10x-media/analytics/runtime')\n\ntype RuntimeHost = { [RUNTIME_KEY]?: AnalyticsRuntime }\n\nexport const setRuntime = (payload: Payload, runtime: AnalyticsRuntime): void => {\n\t;(payload as unknown as RuntimeHost)[RUNTIME_KEY] = runtime\n}\n\nexport const getRuntime = (payload: Payload): AnalyticsRuntime | undefined =>\n\t(payload as unknown as RuntimeHost)[RUNTIME_KEY]\n\nexport const resolveScopeFor = (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest\n): Promise<string | null> => runtime.resolveScope?.(req) ?? Promise.resolve(null)\n\nexport const resolveTimezoneFor = (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest,\n\tscope?: string | null\n): Promise<string> => runtime.resolveTimezone?.(req, scope) ?? Promise.resolve(DEFAULT_TIMEZONE)\n\nexport const resolveRegistryFor = (\n\truntime: AnalyticsRuntime,\n\targs: ResolveRegistryArgs\n): Promise<AdapterRegistry> => runtime.resolveRegistry?.(args) ?? Promise.resolve(runtime.registry)\n\nexport const platformReadFor = async (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest\n): Promise<boolean> =>\n\truntime.platformRead ? await runtime.platformRead({ req }) : Boolean(req.user)\n"],"mappings":";;;;;;;;AAsEA,MAAM,cAAc,OAAO,IAAI,8BAA8B;AAI7D,MAAa,cAAc,SAAkB,YAAoC;CAC/E,QAAoC,eAAe;AACrD;AAEA,MAAa,cAAc,YACzB,QAAmC;AAErC,MAAa,mBACZ,SACA,QAC4B,QAAQ,eAAe,GAAG,KAAK,QAAQ,QAAQ,IAAI;AAEhF,MAAa,sBACZ,SACA,KACA,UACqB,QAAQ,kBAAkB,KAAK,KAAK,KAAK,QAAQ,QAAA,KAAwB;AAE/F,MAAa,sBACZ,SACA,SAC8B,QAAQ,kBAAkB,IAAI,KAAK,QAAQ,QAAQ,QAAQ,QAAQ;AAElG,MAAa,kBAAkB,OAC9B,SACA,QAEA,QAAQ,eAAe,MAAM,QAAQ,aAAa,EAAE,IAAI,CAAC,IAAI,QAAQ,IAAI,IAAI"}
1
+ {"version":3,"file":"runtime.js","names":[],"sources":["../../src/plugin/runtime.ts"],"sourcesContent":["import type { Payload, PayloadRequest } from 'payload'\nimport type { ResolvedBinding } from '../binding/types'\nimport { PLATFORM_SCOPE } from '../core/contract'\nimport type { CaptureSlotOption, ConsentPolicy, ResolvedAutoCapture } from '../core/options'\nimport type { AdapterRegistry, RegistryResolver, ResolveRegistryArgs } from '../core/registry'\nimport type { ServerTrack } from '../core/serverEvent'\nimport type { GoalsResolver, ResolvedGoal } from '../goals/resolver'\nimport type { Goal } from '../goals/types'\nimport type { Engine } from '../surfacing/engine'\nimport { DEFAULT_TIMEZONE } from '../timeframe/tz'\n\nexport interface AnalyticsRuntime {\n\tregistry: AdapterRegistry\n\t/** Per-scope adapter resolution; absent runtimes fall back to the static registry. */\n\tresolveRegistry?: RegistryResolver\n\t/** The plugin's scopeResolver bound at init; absent runtimes resolve null. */\n\tresolveScope?: (req: PayloadRequest) => Promise<string | null>\n\t/** The plugin's reportingTimezone bound at init; absent runtimes resolve 'UTC'. */\n\tresolveTimezone?: (req: PayloadRequest, scope?: string | null) => Promise<string>\n\t/** Id of the config adapter shared by every scope, when one is designated. */\n\tplatformAdapterId?: string\n\t/** `capture.slots` overrides naming the adapter that fills each capture slot. */\n\tcaptureSlots?: { global?: CaptureSlotOption; tenant?: CaptureSlotOption }\n\t/**\n\t * `capture.paths` overrides for a slot's mount. Unset, the tracker config derives the\n\t * runtime proxy mount; set when the slot is served through Next rewrites instead.\n\t */\n\tcapturePaths?: { global?: string; tenant?: string }\n\t/**\n\t * Whether a slot's tracker waits for consent, evaluated per request-resolved adapter.\n\t * Absent runtimes fall back to the default: no gate for native, one for a vendor.\n\t */\n\tconsentFor?: ConsentPolicy\n\t/** Browser auto-capture toggles handed to the tracker; absent runtimes default all on. */\n\tautoCapture?: ResolvedAutoCapture\n\t/** Config goals, and the fallback wherever the merged resolution is unavailable. */\n\tgoals?: Goal[]\n\t/**\n\t * Config goals merged with the goals collection for a request's scope. Absent runtimes\n\t * fall back to `goals`.\n\t */\n\tresolveGoals?: GoalsResolver['resolve']\n\t/** The same merge, each goal tagged with where it came from. */\n\tresolveGoalsDetailed?: GoalsResolver['resolveDetailed']\n\t/** Slug of the goals collection when the install enabled it; the picker links to it. */\n\tgoalsCollectionSlug?: string\n\t/**\n\t * Records an event from server code, through whichever registered adapter accepts\n\t * server events. Rejects with an `AnalyticsTrackError` when none does.\n\t */\n\ttrack?: ServerTrack\n\t/**\n\t * Where the ingest endpoint listens, relative to `routes.api`, lifted at init from the\n\t * adapter that registered one. Absent runtimes fall back to the default mount.\n\t */\n\tingestPath?: string\n\t/**\n\t * `capture.proxy` limits for the runtime capture proxy. Deliberately separate from\n\t * `cache.timeoutMs`: that is a per-read provider deadline for authenticated dashboard\n\t * queries, this is a public request path with entirely different traffic.\n\t */\n\tcaptureProxy?: { timeoutMs: number; maxBodyBytes: number }\n\t/** True when the app configured a scopeResolver (scoped install); mirrors `resolved.scoped`. */\n\tscoped?: boolean\n\t/**\n\t * Ids of the config-time adapters shared by every scope (the ones passed to\n\t * `adapters` in plugin options). Runtime provider adapters (resolved per scope\n\t * from the providers collection or `providers.resolve`) are never in it.\n\t */\n\tconfigAdapterIds: ReadonlySet<string>\n\t/** Gate for cross-scope reads; absent runtimes require an authenticated user. */\n\tplatformRead?: (args: { req: PayloadRequest }) => boolean | Promise<boolean>\n\t/** Gate for the query endpoint; absent runtimes require an authenticated user. */\n\treadAccess?: (args: { req: PayloadRequest }) => boolean | Promise<boolean>\n\tbindings: Record<string, ResolvedBinding>\n\tengine: Engine\n\t/** Explicit TTL overrides; when a value is unset the adapter's recommendedTtl applies. */\n\tttl: { aggregate?: number; realtime?: number }\n\t/** Widget period-over-period comparison; false skips the previous-window read. */\n\tcomparison: boolean\n}\n\n/**\n * Stored on the Payload instance (not a module global) so the runtime survives the\n * separate `.` and `/rsc` bundles a consumer loads: a server-component bundle that\n * imported its own copy of a module-level map would never see what the plugin wrote.\n * `Symbol.for` keys into the cross-realm global symbol registry, so both bundles\n * resolve the same key on the same `payload` object.\n */\nconst RUNTIME_KEY = Symbol.for('@10x-media/analytics/runtime')\n\ntype RuntimeHost = { [RUNTIME_KEY]?: AnalyticsRuntime }\n\nexport const setRuntime = (payload: Payload, runtime: AnalyticsRuntime): void => {\n\t;(payload as unknown as RuntimeHost)[RUNTIME_KEY] = runtime\n}\n\nexport const getRuntime = (payload: Payload): AnalyticsRuntime | undefined =>\n\t(payload as unknown as RuntimeHost)[RUNTIME_KEY]\n\nexport const resolveScopeFor = (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest\n): Promise<string | null> => runtime.resolveScope?.(req) ?? Promise.resolve(null)\n\nexport const resolveTimezoneFor = (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest,\n\tscope?: string | null\n): Promise<string> => runtime.resolveTimezone?.(req, scope) ?? Promise.resolve(DEFAULT_TIMEZONE)\n\n/**\n * The reporting timezone of a request, resolving its scope first and falling back to UTC\n * when the plugin is not booted or resolution throws. Callers that must interpret a\n * client-supplied or stored calendar day before the read begins use this; a read path\n * already holding a resolved scope calls {@link resolveTimezoneFor} directly.\n */\nexport const requestTimezone = async (req: PayloadRequest): Promise<string> => {\n\tconst runtime = getRuntime(req.payload)\n\tif (!runtime) {\n\t\treturn DEFAULT_TIMEZONE\n\t}\n\ttry {\n\t\t// The cross-scope marker is not a scope a reporting timezone can be resolved for;\n\t\t// `resolveReadContext` narrows it to null the same way.\n\t\tconst scope = await resolveScopeFor(runtime, req)\n\t\treturn await resolveTimezoneFor(runtime, req, scope === PLATFORM_SCOPE ? null : scope)\n\t} catch {\n\t\treturn DEFAULT_TIMEZONE\n\t}\n}\n\nexport const resolveRegistryFor = (\n\truntime: AnalyticsRuntime,\n\targs: ResolveRegistryArgs\n): Promise<AdapterRegistry> => runtime.resolveRegistry?.(args) ?? Promise.resolve(runtime.registry)\n\nexport const resolveGoalsFor = (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest,\n\tscope?: string | null\n): Promise<Goal[]> => runtime.resolveGoals?.(req, scope) ?? Promise.resolve(runtime.goals ?? [])\n\nexport const resolveGoalsDetailedFor = (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest,\n\tscope?: string | null\n): Promise<ResolvedGoal[]> =>\n\truntime.resolveGoalsDetailed?.(req, scope) ??\n\tPromise.resolve((runtime.goals ?? []).map((goal) => ({ goal, source: 'config' as const })))\n\nexport const readAccessFor = async (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest\n): Promise<boolean> => (runtime.readAccess ? await runtime.readAccess({ req }) : Boolean(req.user))\n\nexport const platformReadFor = async (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest\n): Promise<boolean> =>\n\truntime.platformRead ? await runtime.platformRead({ req }) : Boolean(req.user)\n\n/** A `platformRead` decision evaluated at most once, however many gates consult it. */\nexport type PlatformReadGate = () => Promise<boolean>\n\nexport const platformReadGate = (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest\n): PlatformReadGate => {\n\tlet pending: Promise<boolean> | undefined\n\treturn () => {\n\t\tpending ??= platformReadFor(runtime, req)\n\t\treturn pending\n\t}\n}\n"],"mappings":";;;;;;;;;AAyFA,MAAM,cAAc,OAAO,IAAI,8BAA8B;AAI7D,MAAa,cAAc,SAAkB,YAAoC;CAC/E,QAAoC,eAAe;AACrD;AAEA,MAAa,cAAc,YACzB,QAAmC;AAErC,MAAa,mBACZ,SACA,QAC4B,QAAQ,eAAe,GAAG,KAAK,QAAQ,QAAQ,IAAI;AAEhF,MAAa,sBACZ,SACA,KACA,UACqB,QAAQ,kBAAkB,KAAK,KAAK,KAAK,QAAQ,QAAA,KAAwB;;;;;;;AAQ/F,MAAa,kBAAkB,OAAO,QAAyC;CAC9E,MAAM,UAAU,WAAW,IAAI,OAAO;CACtC,IAAI,CAAC,SACJ,OAAA;CAED,IAAI;EAGH,MAAM,QAAQ,MAAM,gBAAgB,SAAS,GAAG;EAChD,OAAO,MAAM,mBAAmB,SAAS,KAAK,UAAA,MAA2B,OAAO,KAAK;CACtF,QAAQ;EACP,OAAA;CACD;AACD;AAEA,MAAa,sBACZ,SACA,SAC8B,QAAQ,kBAAkB,IAAI,KAAK,QAAQ,QAAQ,QAAQ,QAAQ;AAElG,MAAa,mBACZ,SACA,KACA,UACqB,QAAQ,eAAe,KAAK,KAAK,KAAK,QAAQ,QAAQ,QAAQ,SAAS,CAAC,CAAC;AAE/F,MAAa,2BACZ,SACA,KACA,UAEA,QAAQ,uBAAuB,KAAK,KAAK,KACzC,QAAQ,SAAS,QAAQ,SAAS,CAAC,GAAG,KAAK,UAAU;CAAE;CAAM,QAAQ;AAAkB,EAAE,CAAC;AAE3F,MAAa,gBAAgB,OAC5B,SACA,QACuB,QAAQ,aAAa,MAAM,QAAQ,WAAW,EAAE,IAAI,CAAC,IAAI,QAAQ,IAAI,IAAI;AAEjG,MAAa,kBAAkB,OAC9B,SACA,QAEA,QAAQ,eAAe,MAAM,QAAQ,aAAa,EAAE,IAAI,CAAC,IAAI,QAAQ,IAAI,IAAI;AAK9E,MAAa,oBACZ,SACA,QACsB;CACtB,IAAI;CACJ,aAAa;EACZ,YAAY,gBAAgB,SAAS,GAAG;EACxC,OAAO;CACR;AACD"}
@@ -0,0 +1,22 @@
1
+ //#region src/plugin/scopeFieldBoot.ts
2
+ /** Whether a top-level field of that name exists, looking through presentational wrappers. */
3
+ const hasField = (fields, name) => fields.some((field) => {
4
+ if ("name" in field && field.name) return field.name === name;
5
+ if ("fields" in field) return hasField(field.fields, name);
6
+ if ("tabs" in field) return field.tabs.some((tab) => !("name" in tab && tab.name) && hasField(tab.fields, name));
7
+ return false;
8
+ });
9
+ /**
10
+ * Fails the boot when a `scopeField` the plugin does not own never materialized on the
11
+ * collection. A tenant plugin registers its field after this plugin runs, so the check
12
+ * waits for the assembled config at init rather than guessing at config time.
13
+ */
14
+ const validateScopeField = (payload, args) => {
15
+ const collection = payload.config.collections.find((c) => c.slug === args.slug);
16
+ if (!collection || hasField(collection.fields, args.scopeField)) return;
17
+ throw new Error(`analytics: ${args.option} "${args.scopeField}" does not exist on ${args.slug}; register the collection with your tenant plugin or use the default scope field`);
18
+ };
19
+ //#endregion
20
+ export { validateScopeField };
21
+
22
+ //# sourceMappingURL=scopeFieldBoot.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"scopeFieldBoot.js","names":[],"sources":["../../src/plugin/scopeFieldBoot.ts"],"sourcesContent":["import type { Field, Payload } from 'payload'\n\n/** Whether a top-level field of that name exists, looking through presentational wrappers. */\nconst hasField = (fields: Field[], name: string): boolean =>\n\tfields.some((field) => {\n\t\tif ('name' in field && field.name) {\n\t\t\treturn field.name === name\n\t\t}\n\t\tif ('fields' in field) {\n\t\t\treturn hasField(field.fields, name)\n\t\t}\n\t\tif ('tabs' in field) {\n\t\t\treturn field.tabs.some(\n\t\t\t\t(tab) => !('name' in tab && tab.name) && hasField(tab.fields as Field[], name)\n\t\t\t)\n\t\t}\n\t\treturn false\n\t})\n\nexport interface ValidateScopeFieldArgs {\n\t/** Option path quoted in the error, e.g. `goals.collection.scopeField`. */\n\toption: string\n\tslug: string\n\tscopeField: string\n}\n\n/**\n * Fails the boot when a `scopeField` the plugin does not own never materialized on the\n * collection. A tenant plugin registers its field after this plugin runs, so the check\n * waits for the assembled config at init rather than guessing at config time.\n */\nexport const validateScopeField = (payload: Payload, args: ValidateScopeFieldArgs): void => {\n\tconst collection = payload.config.collections.find((c) => c.slug === args.slug)\n\tif (!collection || hasField(collection.fields, args.scopeField)) {\n\t\treturn\n\t}\n\tthrow new Error(\n\t\t`analytics: ${args.option} \"${args.scopeField}\" does not exist on ${args.slug}; register the collection with your tenant plugin or use the default scope field`\n\t)\n}\n"],"mappings":";;AAGA,MAAM,YAAY,QAAiB,SAClC,OAAO,MAAM,UAAU;CACtB,IAAI,UAAU,SAAS,MAAM,MAC5B,OAAO,MAAM,SAAS;CAEvB,IAAI,YAAY,OACf,OAAO,SAAS,MAAM,QAAQ,IAAI;CAEnC,IAAI,UAAU,OACb,OAAO,MAAM,KAAK,MAChB,QAAQ,EAAE,UAAU,OAAO,IAAI,SAAS,SAAS,IAAI,QAAmB,IAAI,CAC9E;CAED,OAAO;AACR,CAAC;;;;;;AAcF,MAAa,sBAAsB,SAAkB,SAAuC;CAC3F,MAAM,aAAa,QAAQ,OAAO,YAAY,MAAM,MAAM,EAAE,SAAS,KAAK,IAAI;CAC9E,IAAI,CAAC,cAAc,SAAS,WAAW,QAAQ,KAAK,UAAU,GAC7D;CAED,MAAM,IAAI,MACT,cAAc,KAAK,OAAO,IAAI,KAAK,WAAW,sBAAsB,KAAK,KAAK,iFAC/E;AACD"}
@@ -1,63 +1,32 @@
1
1
  import "./paths.js";
2
- import { getRuntime, platformReadFor, resolveRegistryFor, resolveScopeFor } from "./runtime.js";
3
- import { serializeCapabilities } from "../core/capabilities.js";
2
+ import { getRuntime, readAccessFor } from "./runtime.js";
3
+ import { NO_STORE } from "./responses.js";
4
+ import { resolveSourcesForRequest } from "./readContextForRequest.js";
4
5
  //#region src/plugin/sourcesEndpoint.ts
5
6
  /**
6
7
  * Authenticated GET listing the adapters visible to the requesting scope, with
7
- * serialized capabilities for client-side pickers. Always answers for the
8
- * caller's own resolved scope; there is deliberately no scope parameter, so a
9
- * tenant can never enumerate another tenant's sources. On a scoped install, a
10
- * request that resolves no scope at all is ambiguous, not install-wide, so it
11
- * answers empty rather than leaking the static config registry, unless
12
- * `platformRead` grants it. On resolution failure, an unscoped install falls
13
- * back to the static config registry; a scoped install answers empty, since a
14
- * failed resolution is indistinguishable from a forged one.
8
+ * serialized capabilities for client-side pickers. Gated by `access.read` like
9
+ * every other read endpoint. Always answers for the caller's own resolved scope;
10
+ * there is deliberately no scope parameter, so a tenant can never enumerate
11
+ * another tenant's sources. Everything else about the resolution, including how a
12
+ * null scope and a failed resolution fail closed, lives in
13
+ * {@link resolveSourcesForRequest}, which the query endpoint shares.
15
14
  */
16
15
  const makeSourcesHandler = () => async (req) => {
17
- if (!req.user) return Response.json({ error: "unauthorized" }, { status: 401 });
16
+ if (!req.user) return Response.json({ error: "unauthorized" }, {
17
+ status: 401,
18
+ headers: NO_STORE
19
+ });
18
20
  const runtime = getRuntime(req.payload);
19
- if (!runtime) return Response.json({
20
- defaultId: null,
21
- sources: []
21
+ if (runtime && !await readAccessFor(runtime, req)) return Response.json({ error: "forbidden" }, {
22
+ status: 403,
23
+ headers: NO_STORE
22
24
  });
23
- try {
24
- const scope = await resolveScopeFor(runtime, req);
25
- if (runtime.scoped && scope === null && !await platformReadFor(runtime, req)) return Response.json({
26
- defaultId: null,
27
- sources: []
28
- });
29
- const registry = await resolveRegistryFor(runtime, {
30
- payload: req.payload,
31
- req,
32
- scope
33
- });
34
- const sources = registry.all().map((a) => ({
35
- id: a.id,
36
- label: a.label,
37
- kind: runtime.configAdapterIds.has(a.id) ? "config" : "runtime",
38
- capabilities: serializeCapabilities(a.capabilities)
39
- }));
40
- return Response.json({
41
- defaultId: registry.default().id,
42
- sources
43
- });
44
- } catch (err) {
45
- req.payload.logger?.warn(`analytics: sources listing failed: ${String(err)}`);
46
- if (runtime.scoped) return Response.json({
47
- defaultId: null,
48
- sources: []
49
- });
50
- const sources = runtime.registry.all().map((a) => ({
51
- id: a.id,
52
- label: a.label,
53
- kind: "config",
54
- capabilities: serializeCapabilities(a.capabilities)
55
- }));
56
- return Response.json({
57
- defaultId: runtime.registry.default().id,
58
- sources
59
- });
60
- }
25
+ const { sources, defaultId } = await resolveSourcesForRequest(req);
26
+ return Response.json({
27
+ defaultId,
28
+ sources
29
+ }, { headers: NO_STORE });
61
30
  };
62
31
  //#endregion
63
32
  export { makeSourcesHandler };
@@ -1 +1 @@
1
- {"version":3,"file":"sourcesEndpoint.js","names":[],"sources":["../../src/plugin/sourcesEndpoint.ts"],"sourcesContent":["import type { PayloadHandler } from 'payload'\nimport { serializeCapabilities } from '../core/capabilities'\nimport { SOURCES_PATH } from './paths'\nimport { getRuntime, platformReadFor, resolveRegistryFor, resolveScopeFor } from './runtime'\n\nexport { SOURCES_PATH }\n\n/**\n * Authenticated GET listing the adapters visible to the requesting scope, with\n * serialized capabilities for client-side pickers. Always answers for the\n * caller's own resolved scope; there is deliberately no scope parameter, so a\n * tenant can never enumerate another tenant's sources. On a scoped install, a\n * request that resolves no scope at all is ambiguous, not install-wide, so it\n * answers empty rather than leaking the static config registry, unless\n * `platformRead` grants it. On resolution failure, an unscoped install falls\n * back to the static config registry; a scoped install answers empty, since a\n * failed resolution is indistinguishable from a forged one.\n */\nexport const makeSourcesHandler = (): PayloadHandler => async (req) => {\n\tif (!req.user) {\n\t\treturn Response.json({ error: 'unauthorized' }, { status: 401 })\n\t}\n\tconst runtime = getRuntime(req.payload)\n\tif (!runtime) {\n\t\treturn Response.json({ defaultId: null, sources: [] })\n\t}\n\ttry {\n\t\tconst scope = await resolveScopeFor(runtime, req)\n\t\tif (runtime.scoped && scope === null && !(await platformReadFor(runtime, req))) {\n\t\t\treturn Response.json({ defaultId: null, sources: [] })\n\t\t}\n\t\tconst registry = await resolveRegistryFor(runtime, { payload: req.payload, req, scope })\n\t\tconst sources = registry.all().map((a) => ({\n\t\t\tid: a.id,\n\t\t\tlabel: a.label,\n\t\t\tkind: runtime.configAdapterIds.has(a.id) ? ('config' as const) : ('runtime' as const),\n\t\t\tcapabilities: serializeCapabilities(a.capabilities),\n\t\t}))\n\t\treturn Response.json({ defaultId: registry.default().id, sources })\n\t} catch (err) {\n\t\treq.payload.logger?.warn(`analytics: sources listing failed: ${String(err)}`)\n\t\tif (runtime.scoped) {\n\t\t\treturn Response.json({ defaultId: null, sources: [] })\n\t\t}\n\t\tconst sources = runtime.registry.all().map((a) => ({\n\t\t\tid: a.id,\n\t\t\tlabel: a.label,\n\t\t\tkind: 'config' as const,\n\t\t\tcapabilities: serializeCapabilities(a.capabilities),\n\t\t}))\n\t\treturn Response.json({ defaultId: runtime.registry.default().id, sources })\n\t}\n}\n"],"mappings":";;;;;;;;;;;;;;;AAkBA,MAAa,2BAA2C,OAAO,QAAQ;CACtE,IAAI,CAAC,IAAI,MACR,OAAO,SAAS,KAAK,EAAE,OAAO,eAAe,GAAG,EAAE,QAAQ,IAAI,CAAC;CAEhE,MAAM,UAAU,WAAW,IAAI,OAAO;CACtC,IAAI,CAAC,SACJ,OAAO,SAAS,KAAK;EAAE,WAAW;EAAM,SAAS,CAAC;CAAE,CAAC;CAEtD,IAAI;EACH,MAAM,QAAQ,MAAM,gBAAgB,SAAS,GAAG;EAChD,IAAI,QAAQ,UAAU,UAAU,QAAQ,CAAE,MAAM,gBAAgB,SAAS,GAAG,GAC3E,OAAO,SAAS,KAAK;GAAE,WAAW;GAAM,SAAS,CAAC;EAAE,CAAC;EAEtD,MAAM,WAAW,MAAM,mBAAmB,SAAS;GAAE,SAAS,IAAI;GAAS;GAAK;EAAM,CAAC;EACvF,MAAM,UAAU,SAAS,IAAI,EAAE,KAAK,OAAO;GAC1C,IAAI,EAAE;GACN,OAAO,EAAE;GACT,MAAM,QAAQ,iBAAiB,IAAI,EAAE,EAAE,IAAK,WAAsB;GAClE,cAAc,sBAAsB,EAAE,YAAY;EACnD,EAAE;EACF,OAAO,SAAS,KAAK;GAAE,WAAW,SAAS,QAAQ,EAAE;GAAI;EAAQ,CAAC;CACnE,SAAS,KAAK;EACb,IAAI,QAAQ,QAAQ,KAAK,sCAAsC,OAAO,GAAG,GAAG;EAC5E,IAAI,QAAQ,QACX,OAAO,SAAS,KAAK;GAAE,WAAW;GAAM,SAAS,CAAC;EAAE,CAAC;EAEtD,MAAM,UAAU,QAAQ,SAAS,IAAI,EAAE,KAAK,OAAO;GAClD,IAAI,EAAE;GACN,OAAO,EAAE;GACT,MAAM;GACN,cAAc,sBAAsB,EAAE,YAAY;EACnD,EAAE;EACF,OAAO,SAAS,KAAK;GAAE,WAAW,QAAQ,SAAS,QAAQ,EAAE;GAAI;EAAQ,CAAC;CAC3E;AACD"}
1
+ {"version":3,"file":"sourcesEndpoint.js","names":[],"sources":["../../src/plugin/sourcesEndpoint.ts"],"sourcesContent":["import type { PayloadHandler } from 'payload'\nimport { SOURCES_PATH } from './paths'\nimport { resolveSourcesForRequest } from './readContextForRequest'\nimport { NO_STORE } from './responses'\nimport { getRuntime, readAccessFor } from './runtime'\n\nexport { SOURCES_PATH }\n\n/**\n * Authenticated GET listing the adapters visible to the requesting scope, with\n * serialized capabilities for client-side pickers. Gated by `access.read` like\n * every other read endpoint. Always answers for the caller's own resolved scope;\n * there is deliberately no scope parameter, so a tenant can never enumerate\n * another tenant's sources. Everything else about the resolution, including how a\n * null scope and a failed resolution fail closed, lives in\n * {@link resolveSourcesForRequest}, which the query endpoint shares.\n */\nexport const makeSourcesHandler = (): PayloadHandler => async (req) => {\n\tif (!req.user) {\n\t\treturn Response.json({ error: 'unauthorized' }, { status: 401, headers: NO_STORE })\n\t}\n\tconst runtime = getRuntime(req.payload)\n\t// No runtime means the plugin served nothing to gate: the listing below is empty anyway.\n\tif (runtime && !(await readAccessFor(runtime, req))) {\n\t\treturn Response.json({ error: 'forbidden' }, { status: 403, headers: NO_STORE })\n\t}\n\tconst { sources, defaultId } = await resolveSourcesForRequest(req)\n\treturn Response.json({ defaultId, sources }, { headers: NO_STORE })\n}\n"],"mappings":";;;;;;;;;;;;;;AAiBA,MAAa,2BAA2C,OAAO,QAAQ;CACtE,IAAI,CAAC,IAAI,MACR,OAAO,SAAS,KAAK,EAAE,OAAO,eAAe,GAAG;EAAE,QAAQ;EAAK,SAAS;CAAS,CAAC;CAEnF,MAAM,UAAU,WAAW,IAAI,OAAO;CAEtC,IAAI,WAAW,CAAE,MAAM,cAAc,SAAS,GAAG,GAChD,OAAO,SAAS,KAAK,EAAE,OAAO,YAAY,GAAG;EAAE,QAAQ;EAAK,SAAS;CAAS,CAAC;CAEhF,MAAM,EAAE,SAAS,cAAc,MAAM,yBAAyB,GAAG;CACjE,OAAO,SAAS,KAAK;EAAE;EAAW;CAAQ,GAAG,EAAE,SAAS,SAAS,CAAC;AACnE"}
Binary file
@@ -1 +1 @@
1
- {"version":3,"file":"warmTask.js","names":[],"sources":["../../src/plugin/warmTask.ts"],"sourcesContent":["import type { PayloadRequest, TaskConfig, WidgetInstance } from 'payload'\nimport type { DateRange, DimensionKey, MetricKey } from '../core/contract'\nimport type { ScopesResolver } from '../core/options'\nimport { resolveScopeList } from '../core/scopeList'\nimport { TIMEFRAME_PRESETS, type TimeframePreset } from '../timeframe/presets'\nimport { breakdownSpecBySlug } from '../widgets/breakdownTypes'\nimport { resolveCustomRange } from '../widgets/range'\nimport { readForWidget, type WidgetReadStatus } from '../widgets/readForWidget'\nimport { readForWidgetBreakdown } from '../widgets/readForWidgetBreakdown'\nimport { readForWidgetSeries } from '../widgets/readForWidgetSeries'\nimport { WIDGET_METRICS, type WidgetRange } from '../widgets/types'\n\n/** Minimal shape of a dashboard widget instance the warm job reads. */\nexport interface WarmWidgetInstance {\n\twidgetSlug?: string\n\tdata?: Record<string, unknown>\n}\n\nexport type WarmTarget =\n\t| {\n\t\t\tkind: 'metric'\n\t\t\tmetric: MetricKey\n\t\t\ttimeframe: TimeframePreset\n\t\t\trange?: DateRange\n\t\t\tadapterId?: string\n\t }\n\t| {\n\t\t\tkind: 'series'\n\t\t\tmetric: MetricKey\n\t\t\ttimeframe: TimeframePreset\n\t\t\trange?: DateRange\n\t\t\tadapterId?: string\n\t }\n\t| {\n\t\t\tkind: 'breakdown'\n\t\t\tmetric: MetricKey\n\t\t\tdimension: DimensionKey\n\t\t\ttimeframe: TimeframePreset\n\t\t\tlimit: number\n\t\t\trange?: DateRange\n\t\t\tadapterId?: string\n\t }\n\nconst asString = (v: unknown): string | undefined => (typeof v === 'string' ? v : undefined)\n\nconst asMetric = (v: unknown): MetricKey =>\n\ttypeof v === 'string' && (WIDGET_METRICS as readonly string[]).includes(v)\n\t\t? (v as MetricKey)\n\t\t: 'pageviews'\n\nconst asTimeframe = (v: unknown): TimeframePreset | 'custom' => {\n\tif (v === 'custom') {\n\t\treturn 'custom'\n\t}\n\tif (typeof v === 'string' && (TIMEFRAME_PRESETS as readonly string[]).includes(v)) {\n\t\treturn v as TimeframePreset\n\t}\n\treturn 'last30days'\n}\n\nconst asLimit = (v: unknown): number => (typeof v === 'number' && v > 0 ? v : 5)\n\nconst asRange = (v: unknown): WidgetRange | undefined => {\n\tif (!v || typeof v !== 'object') {\n\t\treturn undefined\n\t}\n\tconst r = v as { from?: unknown; to?: unknown }\n\treturn { from: asString(r.from), to: asString(r.to) }\n}\n\nconst targetKey = (t: WarmTarget): string => {\n\tconst range = t.range ? `${t.range.start.toISOString()}:${t.range.end.toISOString()}` : ''\n\tconst dimension = t.kind === 'breakdown' ? t.dimension : ''\n\tconst limit = t.kind === 'breakdown' ? String(t.limit) : ''\n\treturn `${t.kind}:${t.metric}:${dimension}:${t.timeframe}:${limit}:${t.adapterId ?? ''}:${range}`\n}\n\n/**\n * Map a dashboard's widget layout to the set of reads that warm its cache. Built-in\n * metric, trend, and breakdown widgets become targets; the realtime widget is skipped\n * (its short-TTL key is kept warm by the live poller) and any other slug is a custom app\n * widget whose read shape the plugin does not know. A `custom` timeframe is kept only when\n * its range resolves (the read takes an explicit range; `timeframe` is then unused).\n * Identical targets are de-duplicated so a repeated widget warms its tuple once.\n */\nexport const deriveWarmTargets = (widgets: readonly WarmWidgetInstance[]): WarmTarget[] => {\n\tconst out: WarmTarget[] = []\n\tconst seen = new Set<string>()\n\tfor (const widget of widgets) {\n\t\tconst slug = widget.widgetSlug\n\t\tif (!slug || slug === 'analytics-realtime') {\n\t\t\tcontinue\n\t\t}\n\t\tconst data = widget.data ?? {}\n\t\tconst metric = asMetric(data.metric)\n\t\tconst adapterId = asString(data.dataSource)\n\t\tconst timeframeRaw = asTimeframe(data.timeframe)\n\t\tlet timeframe: TimeframePreset = 'last30days'\n\t\tlet range: DateRange | undefined\n\t\tif (timeframeRaw === 'custom') {\n\t\t\tconst resolved = resolveCustomRange('custom', asRange(data.range))\n\t\t\tif (!resolved) {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\trange = resolved\n\t\t} else {\n\t\t\ttimeframe = timeframeRaw\n\t\t}\n\n\t\tlet target: WarmTarget | undefined\n\t\tif (slug === 'analytics-metric') {\n\t\t\ttarget = { kind: 'metric', metric, timeframe, range, adapterId }\n\t\t} else if (slug === 'analytics-trend') {\n\t\t\ttarget = { kind: 'series', metric, timeframe, range, adapterId }\n\t\t} else {\n\t\t\tconst spec = breakdownSpecBySlug(slug)\n\t\t\tif (spec) {\n\t\t\t\ttarget = {\n\t\t\t\t\tkind: 'breakdown',\n\t\t\t\t\tmetric,\n\t\t\t\t\tdimension: spec.dimension,\n\t\t\t\t\ttimeframe,\n\t\t\t\t\tlimit: asLimit(data.limit),\n\t\t\t\t\trange,\n\t\t\t\t\tadapterId,\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tif (!target) {\n\t\t\tcontinue\n\t\t}\n\t\tconst key = targetKey(target)\n\t\tif (seen.has(key)) {\n\t\t\tcontinue\n\t\t}\n\t\tseen.add(key)\n\t\tout.push(target)\n\t}\n\treturn out\n}\n\nexport const WARM_TASK_SLUG = 'analytics-warm-cache'\n\n/** A dashboard `defaultLayout`: an array, or a function resolving one per request. */\nexport type WarmLayout =\n\t| ((args: { req: PayloadRequest }) => WidgetInstance[] | Promise<WidgetInstance[]>)\n\t| WidgetInstance[]\n\t| undefined\n\nconst resolveLayout = async (\n\tlayout: WarmLayout,\n\treq: PayloadRequest\n): Promise<WarmWidgetInstance[]> => {\n\ttry {\n\t\tconst list = typeof layout === 'function' ? await layout({ req }) : (layout ?? [])\n\t\treturn list.map((w) => ({ widgetSlug: w.widgetSlug, data: w.data }))\n\t} catch (err) {\n\t\treq.payload.logger.warn(\n\t\t\t`analytics warm-cache: could not resolve the dashboard layout: ${String(err)}`\n\t\t)\n\t\treturn []\n\t}\n}\n\ninterface TargetRunResult {\n\tstatus: WidgetReadStatus\n\tadapterId: string\n}\n\n/** Run one target's read for one scope; the caller decides how to count/log the status. */\nconst runTarget = async (args: {\n\ttarget: WarmTarget\n\treq: PayloadRequest\n\tnow: Date\n\tscope: string | null\n}): Promise<TargetRunResult> => {\n\tconst { target, req, now, scope } = args\n\tif (target.kind === 'metric') {\n\t\tconst result = await readForWidget({\n\t\t\treq,\n\t\t\tmetrics: [target.metric],\n\t\t\ttimeframe: target.timeframe,\n\t\t\tadapterId: target.adapterId,\n\t\t\tnow,\n\t\t\trange: target.range,\n\t\t\tscope,\n\t\t})\n\t\treturn { status: result.status, adapterId: result.adapterId }\n\t}\n\tif (target.kind === 'series') {\n\t\tconst result = await readForWidgetSeries({\n\t\t\treq,\n\t\t\tmetric: target.metric,\n\t\t\ttimeframe: target.timeframe,\n\t\t\tadapterId: target.adapterId,\n\t\t\tnow,\n\t\t\trange: target.range,\n\t\t\tscope,\n\t\t})\n\t\treturn { status: result.status, adapterId: result.adapterId }\n\t}\n\tconst result = await readForWidgetBreakdown({\n\t\treq,\n\t\tmetric: target.metric,\n\t\tdimension: target.dimension,\n\t\ttimeframe: target.timeframe,\n\t\tlimit: target.limit,\n\t\tadapterId: target.adapterId,\n\t\tnow,\n\t\trange: target.range,\n\t\tscope,\n\t})\n\treturn { status: result.status, adapterId: result.adapterId }\n}\n\n/**\n * Opt-in Payload task that pre-runs the dashboard's widget reads through the surfacing\n * engine so `payload.kv` is warm before a user opens the dashboard. Targets are derived\n * from `layout` (the app's `defaultLayout`, captured at registration and resolved here);\n * each read is isolated so one failing provider does not abort the rest. Most valuable\n * for slow or rate-limited provider adapters; native reads are cheap and harmless to warm.\n * With `scopes` configured, every target runs once per tenant scope (plus the install-wide\n * scope) so a multi-tenant install warms every tenant's dashboard, not just the null one.\n */\nexport const warmTask = (\n\tcron: string,\n\tlayout: WarmLayout,\n\tscopes?: ScopesResolver\n): TaskConfig<{ input: Record<string, never>; output: { warmed: number; failed: number } }> => ({\n\tslug: WARM_TASK_SLUG,\n\thandler: async ({ req }) => {\n\t\tconst targets = deriveWarmTargets(await resolveLayout(layout, req))\n\t\tif (targets.length === 0) {\n\t\t\treturn { output: { warmed: 0, failed: 0 } }\n\t\t}\n\t\tconst scopeList = await resolveScopeList(scopes, req.payload)\n\t\tconst now = new Date()\n\t\tlet warmed = 0\n\t\tlet failed = 0\n\t\t// A tenant-pass target that degrades (e.g. a shared config adapter gated for\n\t\t// that scope) is not a failure, but a silent one leaves `warmed` unexplainably\n\t\t// short of `scopes x targets`; warn once per (scope, adapter) so it is visible.\n\t\tconst warnedGated = new Set<string>()\n\t\tfor (const scope of scopeList) {\n\t\t\tfor (const target of targets) {\n\t\t\t\ttry {\n\t\t\t\t\tconst result = await runTarget({ target, req, now, scope })\n\t\t\t\t\tif (result.status === 'ok') {\n\t\t\t\t\t\twarmed++\n\t\t\t\t\t} else if (scope !== null) {\n\t\t\t\t\t\tconst key = `${scope}\u0000${result.adapterId}`\n\t\t\t\t\t\tif (!warnedGated.has(key)) {\n\t\t\t\t\t\t\twarnedGated.add(key)\n\t\t\t\t\t\t\treq.payload.logger.warn(\n\t\t\t\t\t\t\t\t`analytics warm-cache: scope \"${scope}\" adapter \"${result.adapterId}\" returned \"${result.status}\", skipping`\n\t\t\t\t\t\t\t)\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t} catch (err) {\n\t\t\t\t\tfailed++\n\t\t\t\t\treq.payload.logger.warn(\n\t\t\t\t\t\t`analytics warm-cache: ${target.kind} read for \"${target.metric}\" (scope \"${scope ?? ''}\") failed: ${String(err)}`\n\t\t\t\t\t)\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn { output: { warmed, failed } }\n\t},\n\tschedule: [{ cron, queue: 'default' }],\n})\n"],"mappings":";;;;;;;;;AA2CA,MAAM,YAAY,MAAoC,OAAO,MAAM,WAAW,IAAI,KAAA;AAElF,MAAM,YAAY,MACjB,OAAO,MAAM,YAAa,eAAqC,SAAS,CAAC,IACrE,IACD;AAEJ,MAAM,eAAe,MAA2C;CAC/D,IAAI,MAAM,UACT,OAAO;CAER,IAAI,OAAO,MAAM,YAAa,kBAAwC,SAAS,CAAC,GAC/E,OAAO;CAER,OAAO;AACR;AAEA,MAAM,WAAW,MAAwB,OAAO,MAAM,YAAY,IAAI,IAAI,IAAI;AAE9E,MAAM,WAAW,MAAwC;CACxD,IAAI,CAAC,KAAK,OAAO,MAAM,UACtB;CAED,MAAM,IAAI;CACV,OAAO;EAAE,MAAM,SAAS,EAAE,IAAI;EAAG,IAAI,SAAS,EAAE,EAAE;CAAE;AACrD;AAEA,MAAM,aAAa,MAA0B;CAC5C,MAAM,QAAQ,EAAE,QAAQ,GAAG,EAAE,MAAM,MAAM,YAAY,EAAE,GAAG,EAAE,MAAM,IAAI,YAAY,MAAM;CACxF,MAAM,YAAY,EAAE,SAAS,cAAc,EAAE,YAAY;CACzD,MAAM,QAAQ,EAAE,SAAS,cAAc,OAAO,EAAE,KAAK,IAAI;CACzD,OAAO,GAAG,EAAE,KAAK,GAAG,EAAE,OAAO,GAAG,UAAU,GAAG,EAAE,UAAU,GAAG,MAAM,GAAG,EAAE,aAAa,GAAG,GAAG;AAC3F;;;;;;;;;AAUA,MAAa,qBAAqB,YAAyD;CAC1F,MAAM,MAAoB,CAAC;CAC3B,MAAM,uBAAO,IAAI,IAAY;CAC7B,KAAK,MAAM,UAAU,SAAS;EAC7B,MAAM,OAAO,OAAO;EACpB,IAAI,CAAC,QAAQ,SAAS,sBACrB;EAED,MAAM,OAAO,OAAO,QAAQ,CAAC;EAC7B,MAAM,SAAS,SAAS,KAAK,MAAM;EACnC,MAAM,YAAY,SAAS,KAAK,UAAU;EAC1C,MAAM,eAAe,YAAY,KAAK,SAAS;EAC/C,IAAI,YAA6B;EACjC,IAAI;EACJ,IAAI,iBAAiB,UAAU;GAC9B,MAAM,WAAW,mBAAmB,UAAU,QAAQ,KAAK,KAAK,CAAC;GACjE,IAAI,CAAC,UACJ;GAED,QAAQ;EACT,OACC,YAAY;EAGb,IAAI;EACJ,IAAI,SAAS,oBACZ,SAAS;GAAE,MAAM;GAAU;GAAQ;GAAW;GAAO;EAAU;OACzD,IAAI,SAAS,mBACnB,SAAS;GAAE,MAAM;GAAU;GAAQ;GAAW;GAAO;EAAU;OACzD;GACN,MAAM,OAAO,oBAAoB,IAAI;GACrC,IAAI,MACH,SAAS;IACR,MAAM;IACN;IACA,WAAW,KAAK;IAChB;IACA,OAAO,QAAQ,KAAK,KAAK;IACzB;IACA;GACD;EAEF;EACA,IAAI,CAAC,QACJ;EAED,MAAM,MAAM,UAAU,MAAM;EAC5B,IAAI,KAAK,IAAI,GAAG,GACf;EAED,KAAK,IAAI,GAAG;EACZ,IAAI,KAAK,MAAM;CAChB;CACA,OAAO;AACR;AAEA,MAAa,iBAAiB;AAQ9B,MAAM,gBAAgB,OACrB,QACA,QACmC;CACnC,IAAI;EAEH,QADa,OAAO,WAAW,aAAa,MAAM,OAAO,EAAE,IAAI,CAAC,IAAK,UAAU,CAAC,GACpE,KAAK,OAAO;GAAE,YAAY,EAAE;GAAY,MAAM,EAAE;EAAK,EAAE;CACpE,SAAS,KAAK;EACb,IAAI,QAAQ,OAAO,KAClB,iEAAiE,OAAO,GAAG,GAC5E;EACA,OAAO,CAAC;CACT;AACD;;AAQA,MAAM,YAAY,OAAO,SAKO;CAC/B,MAAM,EAAE,QAAQ,KAAK,KAAK,UAAU;CACpC,IAAI,OAAO,SAAS,UAAU;EAC7B,MAAM,SAAS,MAAM,cAAc;GAClC;GACA,SAAS,CAAC,OAAO,MAAM;GACvB,WAAW,OAAO;GAClB,WAAW,OAAO;GAClB;GACA,OAAO,OAAO;GACd;EACD,CAAC;EACD,OAAO;GAAE,QAAQ,OAAO;GAAQ,WAAW,OAAO;EAAU;CAC7D;CACA,IAAI,OAAO,SAAS,UAAU;EAC7B,MAAM,SAAS,MAAM,oBAAoB;GACxC;GACA,QAAQ,OAAO;GACf,WAAW,OAAO;GAClB,WAAW,OAAO;GAClB;GACA,OAAO,OAAO;GACd;EACD,CAAC;EACD,OAAO;GAAE,QAAQ,OAAO;GAAQ,WAAW,OAAO;EAAU;CAC7D;CACA,MAAM,SAAS,MAAM,uBAAuB;EAC3C;EACA,QAAQ,OAAO;EACf,WAAW,OAAO;EAClB,WAAW,OAAO;EAClB,OAAO,OAAO;EACd,WAAW,OAAO;EAClB;EACA,OAAO,OAAO;EACd;CACD,CAAC;CACD,OAAO;EAAE,QAAQ,OAAO;EAAQ,WAAW,OAAO;CAAU;AAC7D;;;;;;;;;;AAWA,MAAa,YACZ,MACA,QACA,YAC+F;CAC/F,MAAM;CACN,SAAS,OAAO,EAAE,UAAU;EAC3B,MAAM,UAAU,kBAAkB,MAAM,cAAc,QAAQ,GAAG,CAAC;EAClE,IAAI,QAAQ,WAAW,GACtB,OAAO,EAAE,QAAQ;GAAE,QAAQ;GAAG,QAAQ;EAAE,EAAE;EAE3C,MAAM,YAAY,MAAM,iBAAiB,QAAQ,IAAI,OAAO;EAC5D,MAAM,sBAAM,IAAI,KAAK;EACrB,IAAI,SAAS;EACb,IAAI,SAAS;EAIb,MAAM,8BAAc,IAAI,IAAY;EACpC,KAAK,MAAM,SAAS,WACnB,KAAK,MAAM,UAAU,SACpB,IAAI;GACH,MAAM,SAAS,MAAM,UAAU;IAAE;IAAQ;IAAK;IAAK;GAAM,CAAC;GAC1D,IAAI,OAAO,WAAW,MACrB;QACM,IAAI,UAAU,MAAM;IAC1B,MAAM,MAAM,GAAG,MAAM,GAAG,OAAO;IAC/B,IAAI,CAAC,YAAY,IAAI,GAAG,GAAG;KAC1B,YAAY,IAAI,GAAG;KACnB,IAAI,QAAQ,OAAO,KAClB,gCAAgC,MAAM,aAAa,OAAO,UAAU,cAAc,OAAO,OAAO,YACjG;IACD;GACD;EACD,SAAS,KAAK;GACb;GACA,IAAI,QAAQ,OAAO,KAClB,yBAAyB,OAAO,KAAK,aAAa,OAAO,OAAO,YAAY,SAAS,GAAG,aAAa,OAAO,GAAG,GAChH;EACD;EAGF,OAAO,EAAE,QAAQ;GAAE;GAAQ;EAAO,EAAE;CACrC;CACA,UAAU,CAAC;EAAE;EAAM,OAAO;CAAU,CAAC;AACtC"}
1
+ {"version":3,"file":"warmTask.js","names":[],"sources":["../../src/plugin/warmTask.ts"],"sourcesContent":["import type { PayloadRequest, TaskConfig, WidgetInstance } from 'payload'\nimport type { DimensionKey, MetricKey } from '../core/contract'\nimport type { ScopesResolver } from '../core/options'\nimport { resolveScopeList } from '../core/scopeList'\nimport { TIMEFRAME_PRESETS, type TimeframePreset } from '../timeframe/presets'\nimport { DEFAULT_TIMEZONE } from '../timeframe/tz'\nimport { breakdownSpecBySlug } from '../widgets/breakdownTypes'\nimport { resolveCustomRange } from '../widgets/range'\nimport { readForWidget, type WidgetReadStatus } from '../widgets/readForWidget'\nimport { readForWidgetBreakdown } from '../widgets/readForWidgetBreakdown'\nimport { readForWidgetSeries } from '../widgets/readForWidgetSeries'\nimport { WIDGET_METRICS, type WidgetRange } from '../widgets/types'\nimport { getRuntime, resolveTimezoneFor } from './runtime'\n\n/** Minimal shape of a dashboard widget instance the warm job reads. */\nexport interface WarmWidgetInstance {\n\twidgetSlug?: string\n\tdata?: Record<string, unknown>\n}\n\nexport type WarmTarget =\n\t| {\n\t\t\tkind: 'metric'\n\t\t\tmetric: MetricKey\n\t\t\ttimeframe: TimeframePreset\n\t\t\trange?: WidgetRange\n\t\t\tadapterId?: string\n\t }\n\t| {\n\t\t\tkind: 'series'\n\t\t\tmetric: MetricKey\n\t\t\ttimeframe: TimeframePreset\n\t\t\trange?: WidgetRange\n\t\t\tadapterId?: string\n\t }\n\t| {\n\t\t\tkind: 'breakdown'\n\t\t\tmetric: MetricKey\n\t\t\tdimension: DimensionKey\n\t\t\ttimeframe: TimeframePreset\n\t\t\tlimit: number\n\t\t\trange?: WidgetRange\n\t\t\tadapterId?: string\n\t }\n\nconst asString = (v: unknown): string | undefined => (typeof v === 'string' ? v : undefined)\n\nconst asMetric = (v: unknown): MetricKey =>\n\ttypeof v === 'string' && (WIDGET_METRICS as readonly string[]).includes(v)\n\t\t? (v as MetricKey)\n\t\t: 'pageviews'\n\nconst asTimeframe = (v: unknown): TimeframePreset | 'custom' => {\n\tif (v === 'custom') {\n\t\treturn 'custom'\n\t}\n\tif (typeof v === 'string' && (TIMEFRAME_PRESETS as readonly string[]).includes(v)) {\n\t\treturn v as TimeframePreset\n\t}\n\treturn 'last30days'\n}\n\nconst asLimit = (v: unknown): number => (typeof v === 'number' && v > 0 ? v : 5)\n\nconst asRange = (v: unknown): WidgetRange | undefined => {\n\tif (!v || typeof v !== 'object') {\n\t\treturn undefined\n\t}\n\tconst r = v as { from?: unknown; to?: unknown }\n\treturn { from: asString(r.from), to: asString(r.to) }\n}\n\nconst targetKey = (t: WarmTarget): string => {\n\tconst range = t.range ? `${t.range.from ?? ''}:${t.range.to ?? ''}` : ''\n\tconst dimension = t.kind === 'breakdown' ? t.dimension : ''\n\tconst limit = t.kind === 'breakdown' ? String(t.limit) : ''\n\treturn `${t.kind}:${t.metric}:${dimension}:${t.timeframe}:${limit}:${t.adapterId ?? ''}:${range}`\n}\n\n/**\n * Map a dashboard's widget layout to the set of reads that warm its cache. Built-in\n * metric, trend, and breakdown widgets become targets; the realtime widget is skipped\n * (its short-TTL key is kept warm by the live poller) and any other slug is a custom app\n * widget whose read shape the plugin does not know. A `custom` timeframe is kept only when\n * its range resolves (the read takes an explicit range; `timeframe` is then unused), and\n * the stored bounds travel with the target rather than concrete instants: which instants\n * two picked days span depends on the reporting timezone, which is per scope and so only\n * known inside the warm loop. Identical targets are de-duplicated so a repeated widget\n * warms its tuple once.\n */\nexport const deriveWarmTargets = (widgets: readonly WarmWidgetInstance[]): WarmTarget[] => {\n\tconst out: WarmTarget[] = []\n\tconst seen = new Set<string>()\n\tfor (const widget of widgets) {\n\t\tconst slug = widget.widgetSlug\n\t\tif (!slug || slug === 'analytics-realtime') {\n\t\t\tcontinue\n\t\t}\n\t\tconst data = widget.data ?? {}\n\t\tconst metric = asMetric(data.metric)\n\t\tconst adapterId = asString(data.dataSource)\n\t\tconst timeframeRaw = asTimeframe(data.timeframe)\n\t\tlet timeframe: TimeframePreset = 'last30days'\n\t\tlet range: WidgetRange | undefined\n\t\tif (timeframeRaw === 'custom') {\n\t\t\tconst stored = asRange(data.range)\n\t\t\t// Whether the bounds name real days is timezone-independent, so the skip decision\n\t\t\t// can be taken here even though the window itself cannot.\n\t\t\tif (!resolveCustomRange('custom', stored, DEFAULT_TIMEZONE)) {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\trange = stored\n\t\t} else {\n\t\t\ttimeframe = timeframeRaw\n\t\t}\n\n\t\tlet target: WarmTarget | undefined\n\t\tif (slug === 'analytics-metric') {\n\t\t\ttarget = { kind: 'metric', metric, timeframe, range, adapterId }\n\t\t} else if (slug === 'analytics-trend') {\n\t\t\ttarget = { kind: 'series', metric, timeframe, range, adapterId }\n\t\t} else {\n\t\t\tconst spec = breakdownSpecBySlug(slug)\n\t\t\tif (spec) {\n\t\t\t\ttarget = {\n\t\t\t\t\tkind: 'breakdown',\n\t\t\t\t\tmetric,\n\t\t\t\t\tdimension: spec.dimension,\n\t\t\t\t\ttimeframe,\n\t\t\t\t\tlimit: asLimit(data.limit),\n\t\t\t\t\trange,\n\t\t\t\t\tadapterId,\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tif (!target) {\n\t\t\tcontinue\n\t\t}\n\t\tconst key = targetKey(target)\n\t\tif (seen.has(key)) {\n\t\t\tcontinue\n\t\t}\n\t\tseen.add(key)\n\t\tout.push(target)\n\t}\n\treturn out\n}\n\nexport const WARM_TASK_SLUG = 'analytics-warm-cache'\n\n/** A dashboard `defaultLayout`: an array, or a function resolving one per request. */\nexport type WarmLayout =\n\t| ((args: { req: PayloadRequest }) => WidgetInstance[] | Promise<WidgetInstance[]>)\n\t| WidgetInstance[]\n\t| undefined\n\nconst resolveLayout = async (\n\tlayout: WarmLayout,\n\treq: PayloadRequest\n): Promise<WarmWidgetInstance[]> => {\n\ttry {\n\t\tconst list = typeof layout === 'function' ? await layout({ req }) : (layout ?? [])\n\t\treturn list.map((w) => ({ widgetSlug: w.widgetSlug, data: w.data }))\n\t} catch (err) {\n\t\treq.payload.logger.warn(\n\t\t\t`analytics warm-cache: could not resolve the dashboard layout: ${String(err)}`\n\t\t)\n\t\treturn []\n\t}\n}\n\ninterface TargetRunResult {\n\tstatus: WidgetReadStatus\n\tadapterId: string\n}\n\n/**\n * Run one target's read for one scope; the caller decides how to count/log the status. The\n * stored custom bounds resolve here, in that scope's reporting timezone, so the warmed key\n * is the one the rendered widget will ask for.\n */\nconst runTarget = async (args: {\n\ttarget: WarmTarget\n\treq: PayloadRequest\n\tnow: Date\n\tscope: string | null\n\ttimezone: string\n}): Promise<TargetRunResult> => {\n\tconst { target, req, now, scope, timezone } = args\n\tconst range = resolveCustomRange('custom', target.range, timezone)\n\tif (target.kind === 'metric') {\n\t\tconst result = await readForWidget({\n\t\t\treq,\n\t\t\tmetrics: [target.metric],\n\t\t\ttimeframe: target.timeframe,\n\t\t\tadapterId: target.adapterId,\n\t\t\tnow,\n\t\t\trange,\n\t\t\tscope,\n\t\t\ttimezone,\n\t\t})\n\t\treturn { status: result.status, adapterId: result.adapterId }\n\t}\n\tif (target.kind === 'series') {\n\t\tconst result = await readForWidgetSeries({\n\t\t\treq,\n\t\t\tmetric: target.metric,\n\t\t\ttimeframe: target.timeframe,\n\t\t\tadapterId: target.adapterId,\n\t\t\tnow,\n\t\t\trange,\n\t\t\tscope,\n\t\t\ttimezone,\n\t\t})\n\t\treturn { status: result.status, adapterId: result.adapterId }\n\t}\n\tconst result = await readForWidgetBreakdown({\n\t\treq,\n\t\tmetric: target.metric,\n\t\tdimension: target.dimension,\n\t\ttimeframe: target.timeframe,\n\t\tlimit: target.limit,\n\t\tadapterId: target.adapterId,\n\t\tnow,\n\t\trange,\n\t\tscope,\n\t\ttimezone,\n\t})\n\treturn { status: result.status, adapterId: result.adapterId }\n}\n\n/**\n * Opt-in Payload task that pre-runs the dashboard's widget reads through the surfacing\n * engine so `payload.kv` is warm before a user opens the dashboard. Targets are derived\n * from `layout` (the app's `defaultLayout`, captured at registration and resolved here);\n * each read is isolated so one failing provider does not abort the rest. Most valuable\n * for slow or rate-limited provider adapters; native reads are cheap and harmless to warm.\n * With `scopes` configured, every target runs once per tenant scope (plus the install-wide\n * scope) so a multi-tenant install warms every tenant's dashboard, not just the null one.\n */\nexport const warmTask = (\n\tcron: string,\n\tlayout: WarmLayout,\n\tscopes?: ScopesResolver\n): TaskConfig<{ input: Record<string, never>; output: { warmed: number; failed: number } }> => ({\n\tslug: WARM_TASK_SLUG,\n\thandler: async ({ req }) => {\n\t\tconst targets = deriveWarmTargets(await resolveLayout(layout, req))\n\t\tif (targets.length === 0) {\n\t\t\treturn { output: { warmed: 0, failed: 0 } }\n\t\t}\n\t\tconst scopeList = await resolveScopeList(scopes, req.payload)\n\t\tconst now = new Date()\n\t\tlet warmed = 0\n\t\tlet failed = 0\n\t\t// A tenant-pass target that degrades (e.g. a shared config adapter gated for\n\t\t// that scope) is not a failure, but a silent one leaves `warmed` unexplainably\n\t\t// short of `scopes x targets`; warn once per (scope, adapter) so it is visible.\n\t\tconst warnedGated = new Set<string>()\n\t\tconst runtime = getRuntime(req.payload)\n\t\tfor (const scope of scopeList) {\n\t\t\tconst timezone = runtime ? await resolveTimezoneFor(runtime, req, scope) : DEFAULT_TIMEZONE\n\t\t\tfor (const target of targets) {\n\t\t\t\ttry {\n\t\t\t\t\tconst result = await runTarget({ target, req, now, scope, timezone })\n\t\t\t\t\tif (result.status === 'ok') {\n\t\t\t\t\t\twarmed++\n\t\t\t\t\t} else if (scope !== null) {\n\t\t\t\t\t\tconst key = `${scope}\u0000${result.adapterId}`\n\t\t\t\t\t\tif (!warnedGated.has(key)) {\n\t\t\t\t\t\t\twarnedGated.add(key)\n\t\t\t\t\t\t\treq.payload.logger.warn(\n\t\t\t\t\t\t\t\t`analytics warm-cache: scope \"${scope}\" adapter \"${result.adapterId}\" returned \"${result.status}\", skipping`\n\t\t\t\t\t\t\t)\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t} catch (err) {\n\t\t\t\t\tfailed++\n\t\t\t\t\treq.payload.logger.warn(\n\t\t\t\t\t\t`analytics warm-cache: ${target.kind} read for \"${target.metric}\" (scope \"${scope ?? ''}\") failed: ${String(err)}`\n\t\t\t\t\t)\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn { output: { warmed, failed } }\n\t},\n\tschedule: [{ cron, queue: 'default' }],\n})\n"],"mappings":";;;;;;;;;;AA6CA,MAAM,YAAY,MAAoC,OAAO,MAAM,WAAW,IAAI,KAAA;AAElF,MAAM,YAAY,MACjB,OAAO,MAAM,YAAa,eAAqC,SAAS,CAAC,IACrE,IACD;AAEJ,MAAM,eAAe,MAA2C;CAC/D,IAAI,MAAM,UACT,OAAO;CAER,IAAI,OAAO,MAAM,YAAa,kBAAwC,SAAS,CAAC,GAC/E,OAAO;CAER,OAAO;AACR;AAEA,MAAM,WAAW,MAAwB,OAAO,MAAM,YAAY,IAAI,IAAI,IAAI;AAE9E,MAAM,WAAW,MAAwC;CACxD,IAAI,CAAC,KAAK,OAAO,MAAM,UACtB;CAED,MAAM,IAAI;CACV,OAAO;EAAE,MAAM,SAAS,EAAE,IAAI;EAAG,IAAI,SAAS,EAAE,EAAE;CAAE;AACrD;AAEA,MAAM,aAAa,MAA0B;CAC5C,MAAM,QAAQ,EAAE,QAAQ,GAAG,EAAE,MAAM,QAAQ,GAAG,GAAG,EAAE,MAAM,MAAM,OAAO;CACtE,MAAM,YAAY,EAAE,SAAS,cAAc,EAAE,YAAY;CACzD,MAAM,QAAQ,EAAE,SAAS,cAAc,OAAO,EAAE,KAAK,IAAI;CACzD,OAAO,GAAG,EAAE,KAAK,GAAG,EAAE,OAAO,GAAG,UAAU,GAAG,EAAE,UAAU,GAAG,MAAM,GAAG,EAAE,aAAa,GAAG,GAAG;AAC3F;;;;;;;;;;;;AAaA,MAAa,qBAAqB,YAAyD;CAC1F,MAAM,MAAoB,CAAC;CAC3B,MAAM,uBAAO,IAAI,IAAY;CAC7B,KAAK,MAAM,UAAU,SAAS;EAC7B,MAAM,OAAO,OAAO;EACpB,IAAI,CAAC,QAAQ,SAAS,sBACrB;EAED,MAAM,OAAO,OAAO,QAAQ,CAAC;EAC7B,MAAM,SAAS,SAAS,KAAK,MAAM;EACnC,MAAM,YAAY,SAAS,KAAK,UAAU;EAC1C,MAAM,eAAe,YAAY,KAAK,SAAS;EAC/C,IAAI,YAA6B;EACjC,IAAI;EACJ,IAAI,iBAAiB,UAAU;GAC9B,MAAM,SAAS,QAAQ,KAAK,KAAK;GAGjC,IAAI,CAAC,mBAAmB,UAAU,QAAA,KAAwB,GACzD;GAED,QAAQ;EACT,OACC,YAAY;EAGb,IAAI;EACJ,IAAI,SAAS,oBACZ,SAAS;GAAE,MAAM;GAAU;GAAQ;GAAW;GAAO;EAAU;OACzD,IAAI,SAAS,mBACnB,SAAS;GAAE,MAAM;GAAU;GAAQ;GAAW;GAAO;EAAU;OACzD;GACN,MAAM,OAAO,oBAAoB,IAAI;GACrC,IAAI,MACH,SAAS;IACR,MAAM;IACN;IACA,WAAW,KAAK;IAChB;IACA,OAAO,QAAQ,KAAK,KAAK;IACzB;IACA;GACD;EAEF;EACA,IAAI,CAAC,QACJ;EAED,MAAM,MAAM,UAAU,MAAM;EAC5B,IAAI,KAAK,IAAI,GAAG,GACf;EAED,KAAK,IAAI,GAAG;EACZ,IAAI,KAAK,MAAM;CAChB;CACA,OAAO;AACR;AAEA,MAAa,iBAAiB;AAQ9B,MAAM,gBAAgB,OACrB,QACA,QACmC;CACnC,IAAI;EAEH,QADa,OAAO,WAAW,aAAa,MAAM,OAAO,EAAE,IAAI,CAAC,IAAK,UAAU,CAAC,GACpE,KAAK,OAAO;GAAE,YAAY,EAAE;GAAY,MAAM,EAAE;EAAK,EAAE;CACpE,SAAS,KAAK;EACb,IAAI,QAAQ,OAAO,KAClB,iEAAiE,OAAO,GAAG,GAC5E;EACA,OAAO,CAAC;CACT;AACD;;;;;;AAYA,MAAM,YAAY,OAAO,SAMO;CAC/B,MAAM,EAAE,QAAQ,KAAK,KAAK,OAAO,aAAa;CAC9C,MAAM,QAAQ,mBAAmB,UAAU,OAAO,OAAO,QAAQ;CACjE,IAAI,OAAO,SAAS,UAAU;EAC7B,MAAM,SAAS,MAAM,cAAc;GAClC;GACA,SAAS,CAAC,OAAO,MAAM;GACvB,WAAW,OAAO;GAClB,WAAW,OAAO;GAClB;GACA;GACA;GACA;EACD,CAAC;EACD,OAAO;GAAE,QAAQ,OAAO;GAAQ,WAAW,OAAO;EAAU;CAC7D;CACA,IAAI,OAAO,SAAS,UAAU;EAC7B,MAAM,SAAS,MAAM,oBAAoB;GACxC;GACA,QAAQ,OAAO;GACf,WAAW,OAAO;GAClB,WAAW,OAAO;GAClB;GACA;GACA;GACA;EACD,CAAC;EACD,OAAO;GAAE,QAAQ,OAAO;GAAQ,WAAW,OAAO;EAAU;CAC7D;CACA,MAAM,SAAS,MAAM,uBAAuB;EAC3C;EACA,QAAQ,OAAO;EACf,WAAW,OAAO;EAClB,WAAW,OAAO;EAClB,OAAO,OAAO;EACd,WAAW,OAAO;EAClB;EACA;EACA;EACA;CACD,CAAC;CACD,OAAO;EAAE,QAAQ,OAAO;EAAQ,WAAW,OAAO;CAAU;AAC7D;;;;;;;;;;AAWA,MAAa,YACZ,MACA,QACA,YAC+F;CAC/F,MAAM;CACN,SAAS,OAAO,EAAE,UAAU;EAC3B,MAAM,UAAU,kBAAkB,MAAM,cAAc,QAAQ,GAAG,CAAC;EAClE,IAAI,QAAQ,WAAW,GACtB,OAAO,EAAE,QAAQ;GAAE,QAAQ;GAAG,QAAQ;EAAE,EAAE;EAE3C,MAAM,YAAY,MAAM,iBAAiB,QAAQ,IAAI,OAAO;EAC5D,MAAM,sBAAM,IAAI,KAAK;EACrB,IAAI,SAAS;EACb,IAAI,SAAS;EAIb,MAAM,8BAAc,IAAI,IAAY;EACpC,MAAM,UAAU,WAAW,IAAI,OAAO;EACtC,KAAK,MAAM,SAAS,WAAW;GAC9B,MAAM,WAAW,UAAU,MAAM,mBAAmB,SAAS,KAAK,KAAK,IAAA;GACvE,KAAK,MAAM,UAAU,SACpB,IAAI;IACH,MAAM,SAAS,MAAM,UAAU;KAAE;KAAQ;KAAK;KAAK;KAAO;IAAS,CAAC;IACpE,IAAI,OAAO,WAAW,MACrB;SACM,IAAI,UAAU,MAAM;KAC1B,MAAM,MAAM,GAAG,MAAM,GAAG,OAAO;KAC/B,IAAI,CAAC,YAAY,IAAI,GAAG,GAAG;MAC1B,YAAY,IAAI,GAAG;MACnB,IAAI,QAAQ,OAAO,KAClB,gCAAgC,MAAM,aAAa,OAAO,UAAU,cAAc,OAAO,OAAO,YACjG;KACD;IACD;GACD,SAAS,KAAK;IACb;IACA,IAAI,QAAQ,OAAO,KAClB,yBAAyB,OAAO,KAAK,aAAa,OAAO,OAAO,YAAY,SAAS,GAAG,aAAa,OAAO,GAAG,GAChH;GACD;EAEF;EACA,OAAO,EAAE,QAAQ;GAAE;GAAQ;EAAO,EAAE;CACrC;CACA,UAAU,CAAC;EAAE;EAAM,OAAO;CAAU,CAAC;AACtC"}
@@ -1,7 +1,9 @@
1
- import { keys } from "../translations/keys.js";
2
- import { labelForKey } from "../translations/server.js";
3
1
  import { providerCreateAccess, providerRowAccess } from "./access.js";
4
2
  import { stampScope } from "./stampScope.js";
3
+ import { keys } from "../translations/keys.js";
4
+ import { labelForKey } from "../translations/server.js";
5
+ import { validateCurrency } from "../goals/currency.js";
6
+ import { validateMeasurementId } from "../adapters/ga4/measurementId.js";
5
7
  //#region src/providers/collection.ts
6
8
  const PROVIDERS_SLUG = "analytics-providers";
7
9
  const textField = (name, label, width) => ({
@@ -21,15 +23,28 @@ const secretField = (args, opts) => args.buildSecret({
21
23
  * serves it to the browser. An adapter declares `capture` only when its public field is
22
24
  * filled, so these are what let a provider document fill a capture slot.
23
25
  */
24
- const captureField = (name, label, width) => ({
26
+ const captureField = (name, label, opts = {}) => ({
25
27
  name,
26
28
  type: "text",
27
29
  label: labelForKey(label),
30
+ ...opts.validate ? { validate: opts.validate } : {},
28
31
  admin: {
29
32
  description: labelForKey(keys.providerFieldCaptureHelp),
30
- ...width ? { width } : {}
33
+ ...opts.width ? { width: opts.width } : {}
31
34
  }
32
35
  });
36
+ /**
37
+ * The plugin's own scope field, and only when `scopeField` still names it: a host-owned
38
+ * field (a tenant plugin's relationship) is the host's to register, and shadowing it with a
39
+ * hidden text field of another name would store the scope twice.
40
+ */
41
+ const scopeField = (args) => args.scopeField === "scope" ? [{
42
+ name: "scope",
43
+ type: "text",
44
+ index: true,
45
+ label: labelForKey(keys.providerFieldScope),
46
+ admin: { hidden: true }
47
+ }] : [];
33
48
  const hostField = () => ({
34
49
  name: "host",
35
50
  type: "text",
@@ -128,13 +143,7 @@ const buildProvidersCollection = (args) => {
128
143
  }
129
144
  }]
130
145
  },
131
- {
132
- name: "scope",
133
- type: "text",
134
- index: true,
135
- label: labelForKey(keys.providerFieldScope),
136
- admin: { hidden: true }
137
- },
146
+ ...scopeField(args),
138
147
  providerGroup("plausible", keys.providerNamePlausible, [
139
148
  {
140
149
  type: "row",
@@ -146,7 +155,13 @@ const buildProvidersCollection = (args) => {
146
155
  },
147
156
  {
148
157
  type: "row",
149
- fields: [captureField("domain", keys.providerFieldDomain, "50%"), captureField("scriptId", keys.providerFieldScriptId, "50%")]
158
+ fields: [captureField("domain", keys.providerFieldDomain, { width: "50%" }), captureField("scriptId", keys.providerFieldScriptId, { width: "50%" })]
159
+ },
160
+ {
161
+ name: "revenueCurrency",
162
+ type: "text",
163
+ label: labelForKey(keys.providerFieldRevenueCurrency),
164
+ validate: validateCurrency
150
165
  },
151
166
  hostField()
152
167
  ]),
@@ -171,6 +186,7 @@ const buildProvidersCollection = (args) => {
171
186
  fields: [textField("propertyId", keys.providerFieldPropertyId, "50%"), textField("projectId", keys.providerFieldProjectId, "50%")]
172
187
  },
173
188
  textField("clientEmail", keys.providerFieldClientEmail),
189
+ captureField("measurementId", keys.providerFieldMeasurementId, { validate: validateMeasurementId }),
174
190
  ...args.buildSecret({
175
191
  name: "privateKey",
176
192
  type: "textarea",
@@ -188,7 +204,7 @@ const buildProvidersCollection = (args) => {
188
204
  },
189
205
  {
190
206
  type: "row",
191
- fields: [captureField("projectToken", keys.providerFieldProjectToken, "50%"), {
207
+ fields: [captureField("projectToken", keys.providerFieldProjectToken, { width: "50%" }), {
192
208
  name: "region",
193
209
  type: "select",
194
210
  label: labelForKey(keys.providerFieldRegion),