@10x-media/analytics 0.1.0-beta.0 → 0.1.0-beta.1

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 (262) hide show
  1. package/CHANGELOG.md +71 -0
  2. package/README.md +37 -357
  3. package/dist/adapters/ga4/ga4.d.ts +20 -0
  4. package/dist/adapters/ga4/ga4.js +177 -0
  5. package/dist/{fetchJson-DZb2_Puj.js → adapters/http/fetchJson.js} +2 -2
  6. package/dist/adapters/http/fetchJson.js.map +1 -0
  7. package/dist/adapters/plausible/plausible.d.ts +15 -0
  8. package/dist/adapters/plausible/plausible.js +143 -0
  9. package/dist/adapters/posthog/posthog.d.ts +23 -0
  10. package/dist/adapters/posthog/posthog.js +121 -0
  11. package/dist/adapters/posthog/posthog.js.map +1 -0
  12. package/dist/{series-zytbzPoc.js → adapters/series.js} +2 -2
  13. package/dist/adapters/series.js.map +1 -0
  14. package/dist/adapters/umami/umami.d.ts +18 -0
  15. package/dist/adapters/umami/umami.js +139 -0
  16. package/dist/binding/resolvePath.js +61 -0
  17. package/dist/binding/resolvePath.js.map +1 -0
  18. package/dist/binding/types.d.ts +53 -0
  19. package/dist/charts/BarList.d.ts +20 -0
  20. package/dist/charts/BarList.js +73 -0
  21. package/dist/charts/BarList.js.map +1 -0
  22. package/dist/charts/TrendChart.d.ts +25 -0
  23. package/dist/charts/TrendChart.js +186 -0
  24. package/dist/charts/TrendChart.js.map +1 -0
  25. package/dist/charts/bars.d.ts +9 -0
  26. package/dist/charts/bars.js +19 -0
  27. package/dist/charts/bars.js.map +1 -0
  28. package/dist/charts/bucket.js +79 -0
  29. package/dist/charts/bucket.js.map +1 -0
  30. package/dist/charts/spline.js +84 -0
  31. package/dist/charts/spline.js.map +1 -0
  32. package/dist/charts/styles.js +42 -0
  33. package/dist/charts/styles.js.map +1 -0
  34. package/dist/core/cacheKey.js +31 -0
  35. package/dist/core/cacheKey.js.map +1 -0
  36. package/dist/core/capabilities.d.ts +12 -0
  37. package/dist/core/capabilities.js +12 -0
  38. package/dist/core/capabilities.js.map +1 -0
  39. package/dist/{contract-CWZPKWuR.d.ts → core/contract.d.ts} +30 -4
  40. package/dist/core/contract.js +10 -0
  41. package/dist/core/contract.js.map +1 -0
  42. package/dist/core/granularity.js +17 -0
  43. package/dist/core/granularity.js.map +1 -0
  44. package/dist/core/options.d.ts +115 -0
  45. package/dist/core/options.js +107 -0
  46. package/dist/core/options.js.map +1 -0
  47. package/dist/core/registry.js +24 -0
  48. package/dist/core/registry.js.map +1 -0
  49. package/dist/core/scopedRead.js +57 -0
  50. package/dist/core/scopedRead.js.map +1 -0
  51. package/dist/exports/adapters/ga4.d.ts +2 -20
  52. package/dist/exports/adapters/ga4.js +1 -176
  53. package/dist/exports/adapters/native.d.ts +2 -22
  54. package/dist/exports/adapters/native.js +1 -848
  55. package/dist/exports/adapters/plausible.d.ts +2 -15
  56. package/dist/exports/adapters/plausible.js +1 -142
  57. package/dist/exports/adapters/posthog.d.ts +2 -17
  58. package/dist/exports/adapters/posthog.js +1 -118
  59. package/dist/exports/adapters/umami.d.ts +2 -18
  60. package/dist/exports/adapters/umami.js +1 -138
  61. package/dist/exports/client.d.ts +5 -77
  62. package/dist/exports/client.js +4 -386
  63. package/dist/exports/geo.d.ts +4 -19
  64. package/dist/exports/geo.js +3 -1
  65. package/dist/exports/i18n.d.ts +3 -63
  66. package/dist/exports/i18n.js +2 -2
  67. package/dist/exports/next.d.ts +2 -0
  68. package/dist/exports/next.js +2 -0
  69. package/dist/exports/rsc.d.ts +13 -120
  70. package/dist/exports/rsc.js +10 -597
  71. package/dist/exports/types.d.ts +6 -4
  72. package/dist/exports/types.js +2 -1
  73. package/dist/fields/AnalyticsStatField.d.ts +31 -0
  74. package/dist/fields/AnalyticsStatField.js +93 -0
  75. package/dist/fields/AnalyticsStatField.js.map +1 -0
  76. package/dist/fields/dateRange/field.js +55 -0
  77. package/dist/fields/dateRange/field.js.map +1 -0
  78. package/dist/fields/dateRange/styles.js +23 -0
  79. package/dist/fields/dateRange/styles.js.map +1 -0
  80. package/dist/fields/dateRange/types.d.ts +11 -0
  81. package/dist/fields/dateRange/ui.d.ts +9 -0
  82. package/dist/fields/dateRange/ui.js +373 -0
  83. package/dist/fields/dateRange/ui.js.map +1 -0
  84. package/dist/fields/factories.d.ts +52 -0
  85. package/dist/fields/factories.js +65 -0
  86. package/dist/fields/factories.js.map +1 -0
  87. package/dist/fields/format.d.ts +7 -0
  88. package/dist/fields/format.js +22 -0
  89. package/dist/fields/format.js.map +1 -0
  90. package/dist/fields/readForDocument.js +107 -0
  91. package/dist/fields/readForDocument.js.map +1 -0
  92. package/dist/index.d.ts +18 -3
  93. package/dist/index.js +55 -1025
  94. package/dist/index.js.map +1 -1
  95. package/dist/native/collections/events.js +101 -0
  96. package/dist/native/collections/events.js.map +1 -0
  97. package/dist/native/collections/rollups.js +115 -0
  98. package/dist/native/collections/rollups.js.map +1 -0
  99. package/dist/native/collections/seen.js +47 -0
  100. package/dist/native/collections/seen.js.map +1 -0
  101. package/dist/native/geo/composeGeoResolvers.d.ts +7 -0
  102. package/dist/native/geo/composeGeoResolvers.js +14 -0
  103. package/dist/native/geo/composeGeoResolvers.js.map +1 -0
  104. package/dist/{geoResolver-CasIa4T9.d.ts → native/geo/geoResolver.d.ts} +2 -2
  105. package/dist/native/geo/geoResolver.js +11 -0
  106. package/dist/native/geo/geoResolver.js.map +1 -0
  107. package/dist/native/geo/maxmindResolver.d.ts +16 -0
  108. package/dist/native/geo/maxmindResolver.js +55 -0
  109. package/dist/native/geo/maxmindResolver.js.map +1 -0
  110. package/dist/native/ingest/device.js +15 -0
  111. package/dist/native/ingest/device.js.map +1 -0
  112. package/dist/native/ingest/endpoint.js +27 -0
  113. package/dist/native/ingest/endpoint.js.map +1 -0
  114. package/dist/native/ingest/flushBatch.js +69 -0
  115. package/dist/native/ingest/flushBatch.js.map +1 -0
  116. package/dist/native/ingest/normalizeEvent.js +38 -0
  117. package/dist/native/ingest/normalizeEvent.js.map +1 -0
  118. package/dist/native/ingest/salt.js +14 -0
  119. package/dist/native/ingest/salt.js.map +1 -0
  120. package/dist/native/ingest/source.js +22 -0
  121. package/dist/native/ingest/source.js.map +1 -0
  122. package/dist/native/ingest/visitorHash.js +12 -0
  123. package/dist/native/ingest/visitorHash.js.map +1 -0
  124. package/dist/native/ingest/writeBuffer.js +55 -0
  125. package/dist/native/ingest/writeBuffer.js.map +1 -0
  126. package/dist/native/ingest/writeEvent.js +13 -0
  127. package/dist/native/ingest/writeEvent.js.map +1 -0
  128. package/dist/native/nativeAdapter.d.ts +22 -0
  129. package/dist/native/nativeAdapter.js +213 -0
  130. package/dist/native/nativeAdapter.js.map +1 -0
  131. package/dist/native/realtime/buildRealtime.js +53 -0
  132. package/dist/native/realtime/buildRealtime.js.map +1 -0
  133. package/dist/native/retention/pruneTask.js +29 -0
  134. package/dist/native/retention/pruneTask.js.map +1 -0
  135. package/dist/native/rollupAcc.js +50 -0
  136. package/dist/native/rollupAcc.js.map +1 -0
  137. package/dist/native/rollups/applyDistinctDeltas.js +9 -0
  138. package/dist/native/rollups/applyDistinctDeltas.js.map +1 -0
  139. package/dist/native/rollups/bumpRollup.js +52 -0
  140. package/dist/native/rollups/bumpRollup.js.map +1 -0
  141. package/dist/native/rollups/deltas.js +31 -0
  142. package/dist/native/rollups/deltas.js.map +1 -0
  143. package/dist/native/rollups/insertIfNew.js +19 -0
  144. package/dist/native/rollups/insertIfNew.js.map +1 -0
  145. package/dist/next/posthogProxyRewrites.d.ts +36 -0
  146. package/dist/next/posthogProxyRewrites.js +50 -0
  147. package/dist/next/posthogProxyRewrites.js.map +1 -0
  148. package/dist/plugin/realtimeEndpoint.js +36 -0
  149. package/dist/plugin/realtimeEndpoint.js.map +1 -0
  150. package/dist/plugin/registerTranslations.js +19 -0
  151. package/dist/plugin/registerTranslations.js.map +1 -0
  152. package/dist/plugin/runtime.js +20 -0
  153. package/dist/plugin/runtime.js.map +1 -0
  154. package/dist/plugin/warmTask.js +165 -0
  155. package/dist/plugin/warmTask.js.map +1 -0
  156. package/dist/providers/collection.js +159 -0
  157. package/dist/providers/collection.js.map +1 -0
  158. package/dist/providers/factory.js +62 -0
  159. package/dist/providers/factory.js.map +1 -0
  160. package/dist/providers/resolver.js +67 -0
  161. package/dist/providers/resolver.js.map +1 -0
  162. package/dist/providers/secrets.js +27 -0
  163. package/dist/providers/secrets.js.map +1 -0
  164. package/dist/surfacing/cacheStore.js +26 -0
  165. package/dist/surfacing/cacheStore.js.map +1 -0
  166. package/dist/surfacing/coalesce.js +15 -0
  167. package/dist/surfacing/coalesce.js.map +1 -0
  168. package/dist/surfacing/engine.js +63 -0
  169. package/dist/surfacing/engine.js.map +1 -0
  170. package/dist/surfacing/queue.js +44 -0
  171. package/dist/surfacing/queue.js.map +1 -0
  172. package/dist/sync/collection.js +65 -0
  173. package/dist/sync/collection.js.map +1 -0
  174. package/dist/sync/syncTask.js +123 -0
  175. package/dist/sync/syncTask.js.map +1 -0
  176. package/dist/testing/memoryAdapter.d.ts +1 -1
  177. package/dist/timeframe/presets.d.ts +6 -0
  178. package/dist/timeframe/presets.js +63 -0
  179. package/dist/timeframe/presets.js.map +1 -0
  180. package/dist/{translations-keiKtSjF.js → translations/en.js} +25 -23
  181. package/dist/translations/en.js.map +1 -0
  182. package/dist/translations/index.d.ts +14 -0
  183. package/dist/translations/index.js +26 -0
  184. package/dist/translations/index.js.map +1 -0
  185. package/dist/translations/keys.d.ts +78 -0
  186. package/dist/{keys-DEqL4LOT.js → translations/keys.js} +24 -3
  187. package/dist/translations/keys.js.map +1 -0
  188. package/dist/translations/metricKeys.js +30 -0
  189. package/dist/translations/metricKeys.js.map +1 -0
  190. package/dist/translations/server.js +13 -0
  191. package/dist/translations/server.js.map +1 -0
  192. package/dist/translations/useTranslation.js +12 -0
  193. package/dist/translations/useTranslation.js.map +1 -0
  194. package/dist/widgets/AnalyticsBreakdownWidget.d.ts +7 -0
  195. package/dist/widgets/AnalyticsBreakdownWidget.js +85 -0
  196. package/dist/widgets/AnalyticsBreakdownWidget.js.map +1 -0
  197. package/dist/widgets/AnalyticsMetricWidget.d.ts +7 -0
  198. package/dist/widgets/AnalyticsMetricWidget.js +81 -0
  199. package/dist/widgets/AnalyticsMetricWidget.js.map +1 -0
  200. package/dist/widgets/AnalyticsRealtimeWidget.d.ts +7 -0
  201. package/dist/widgets/AnalyticsRealtimeWidget.js +64 -0
  202. package/dist/widgets/AnalyticsRealtimeWidget.js.map +1 -0
  203. package/dist/widgets/AnalyticsTrendWidget.d.ts +7 -0
  204. package/dist/widgets/AnalyticsTrendWidget.js +91 -0
  205. package/dist/widgets/AnalyticsTrendWidget.js.map +1 -0
  206. package/dist/widgets/RealtimeCounter.d.ts +19 -0
  207. package/dist/widgets/RealtimeCounter.js +76 -0
  208. package/dist/widgets/RealtimeCounter.js.map +1 -0
  209. package/dist/widgets/breakdownTypes.js +29 -0
  210. package/dist/widgets/breakdownTypes.js.map +1 -0
  211. package/dist/widgets/cardChrome.js +22 -0
  212. package/dist/widgets/cardChrome.js.map +1 -0
  213. package/dist/widgets/customWidget.d.ts +20 -0
  214. package/dist/widgets/customWidget.js +30 -0
  215. package/dist/widgets/customWidget.js.map +1 -0
  216. package/dist/widgets/defaults.d.ts +12 -0
  217. package/dist/widgets/defaults.js +72 -0
  218. package/dist/widgets/defaults.js.map +1 -0
  219. package/dist/widgets/range.js +28 -0
  220. package/dist/widgets/range.js.map +1 -0
  221. package/dist/widgets/readForWidget.d.ts +27 -0
  222. package/dist/widgets/readForWidget.js +57 -0
  223. package/dist/widgets/readForWidget.js.map +1 -0
  224. package/dist/widgets/readForWidgetBreakdown.d.ts +38 -0
  225. package/dist/widgets/readForWidgetBreakdown.js +75 -0
  226. package/dist/widgets/readForWidgetBreakdown.js.map +1 -0
  227. package/dist/{readForWidgetRealtime-D1BD37ST.d.ts → widgets/readForWidgetRealtime.d.ts} +5 -3
  228. package/dist/widgets/readForWidgetRealtime.js +63 -0
  229. package/dist/widgets/readForWidgetRealtime.js.map +1 -0
  230. package/dist/widgets/readForWidgetSeries.d.ts +38 -0
  231. package/dist/widgets/readForWidgetSeries.js +97 -0
  232. package/dist/widgets/readForWidgetSeries.js.map +1 -0
  233. package/dist/widgets/realtimePoll.js +26 -0
  234. package/dist/widgets/realtimePoll.js.map +1 -0
  235. package/dist/widgets/registerWidgets.js +249 -0
  236. package/dist/widgets/registerWidgets.js.map +1 -0
  237. package/dist/widgets/types.js +13 -0
  238. package/dist/widgets/types.js.map +1 -0
  239. package/package.json +16 -2
  240. package/dist/RealtimeCounter-BJrjMPSa.js +0 -473
  241. package/dist/RealtimeCounter-BJrjMPSa.js.map +0 -1
  242. package/dist/dist-B6HruP5v.js +0 -4731
  243. package/dist/dist-B6HruP5v.js.map +0 -1
  244. package/dist/exports/adapters/native.js.map +0 -1
  245. package/dist/exports/adapters/posthog.js.map +0 -1
  246. package/dist/exports/client.js.map +0 -1
  247. package/dist/exports/rsc.js.map +0 -1
  248. package/dist/fetchJson-DZb2_Puj.js.map +0 -1
  249. package/dist/index-CZdCT0WJ.d.ts +0 -98
  250. package/dist/keys-DEqL4LOT.js.map +0 -1
  251. package/dist/lib-CE5x1zLQ.js +0 -1058
  252. package/dist/lib-CE5x1zLQ.js.map +0 -1
  253. package/dist/maxmindResolver-CXYXXdul.js +0 -99
  254. package/dist/maxmindResolver-CXYXXdul.js.map +0 -1
  255. package/dist/presets-CBfq_uJX.d.ts +0 -38
  256. package/dist/series-zytbzPoc.js.map +0 -1
  257. package/dist/server-Cuvhgz-S.js +0 -492
  258. package/dist/server-Cuvhgz-S.js.map +0 -1
  259. package/dist/translations-keiKtSjF.js.map +0 -1
  260. /package/dist/{exports/adapters → adapters/ga4}/ga4.js.map +0 -0
  261. /package/dist/{exports/adapters → adapters/plausible}/plausible.js.map +0 -0
  262. /package/dist/{exports/adapters → adapters/umami}/umami.js.map +0 -0
@@ -0,0 +1,29 @@
1
+ import { EVENTS_SLUG } from "../collections/events.js";
2
+ import { SEEN_SLUG } from "../collections/seen.js";
3
+ //#region src/native/retention/pruneTask.ts
4
+ const PRUNE_TASK_SLUG = "analytics-prune-events";
5
+ const pruneEventsTask = (retentionDays) => ({
6
+ slug: PRUNE_TASK_SLUG,
7
+ handler: async ({ req }) => {
8
+ const cutoff = (/* @__PURE__ */ new Date(Date.now() - retentionDays * 864e5)).toISOString();
9
+ const events = await req.payload.delete({
10
+ collection: EVENTS_SLUG,
11
+ where: { timestamp: { less_than: cutoff } },
12
+ overrideAccess: true
13
+ });
14
+ const seen = await req.payload.delete({
15
+ collection: SEEN_SLUG,
16
+ where: { period: { less_than: cutoff } },
17
+ overrideAccess: true
18
+ });
19
+ return { output: { deleted: events.docs.length + seen.docs.length } };
20
+ },
21
+ schedule: [{
22
+ cron: "0 3 * * *",
23
+ queue: "default"
24
+ }]
25
+ });
26
+ //#endregion
27
+ export { pruneEventsTask };
28
+
29
+ //# sourceMappingURL=pruneTask.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"pruneTask.js","names":[],"sources":["../../../src/native/retention/pruneTask.ts"],"sourcesContent":["import type { TaskConfig } from 'payload'\nimport { EVENTS_SLUG } from '../collections/events'\nimport { SEEN_SLUG } from '../collections/seen'\n\nexport const PRUNE_TASK_SLUG = 'analytics-prune-events'\n\nexport const pruneEventsTask = (\n\tretentionDays: number\n): TaskConfig<{ input: Record<string, never>; output: { deleted: number } }> => ({\n\tslug: PRUNE_TASK_SLUG,\n\thandler: async ({ req }) => {\n\t\tconst cutoff = new Date(Date.now() - retentionDays * 86_400_000).toISOString()\n\t\tconst events = await req.payload.delete({\n\t\t\tcollection: EVENTS_SLUG as never,\n\t\t\twhere: { timestamp: { less_than: cutoff } },\n\t\t\toverrideAccess: true,\n\t\t})\n\t\tconst seen = await req.payload.delete({\n\t\t\tcollection: SEEN_SLUG as never,\n\t\t\twhere: { period: { less_than: cutoff } },\n\t\t\toverrideAccess: true,\n\t\t})\n\t\treturn { output: { deleted: events.docs.length + seen.docs.length } }\n\t},\n\tschedule: [{ cron: '0 3 * * *', queue: 'default' }],\n})\n"],"mappings":";;;AAIA,MAAa,kBAAkB;AAE/B,MAAa,mBACZ,mBACgF;CAChF,MAAM;CACN,SAAS,OAAO,EAAE,UAAU;EAC3B,MAAM,0BAAS,IAAI,KAAK,KAAK,IAAI,IAAI,gBAAgB,KAAU,GAAE,YAAY;EAC7E,MAAM,SAAS,MAAM,IAAI,QAAQ,OAAO;GACvC,YAAY;GACZ,OAAO,EAAE,WAAW,EAAE,WAAW,OAAO,EAAE;GAC1C,gBAAgB;EACjB,CAAC;EACD,MAAM,OAAO,MAAM,IAAI,QAAQ,OAAO;GACrC,YAAY;GACZ,OAAO,EAAE,QAAQ,EAAE,WAAW,OAAO,EAAE;GACvC,gBAAgB;EACjB,CAAC;EACD,OAAO,EAAE,QAAQ,EAAE,SAAS,OAAO,KAAK,SAAS,KAAK,KAAK,OAAO,EAAE;CACrE;CACA,UAAU,CAAC;EAAE,MAAM;EAAa,OAAO;CAAU,CAAC;AACnD"}
@@ -0,0 +1,50 @@
1
+ //#region src/native/rollupAcc.ts
2
+ const emptyAcc = () => ({
3
+ pageviews: 0,
4
+ events: 0,
5
+ durationMs: 0,
6
+ visitors: 0,
7
+ sessions: 0
8
+ });
9
+ const add = (acc, d) => {
10
+ acc.pageviews += d.pageviews;
11
+ acc.events += d.events;
12
+ acc.durationMs += d.durationMs;
13
+ acc.visitors += d.visitors;
14
+ acc.sessions += d.sessions;
15
+ };
16
+ const selectMetrics = (acc, wanted) => {
17
+ const out = {};
18
+ if (wanted.includes("pageviews")) out.pageviews = acc.pageviews;
19
+ if (wanted.includes("events")) out.events = acc.events;
20
+ if (wanted.includes("visitors")) out.visitors = acc.visitors;
21
+ if (wanted.includes("sessions")) out.sessions = acc.sessions;
22
+ if (wanted.includes("avgDuration")) out.avgDuration = acc.pageviews > 0 ? Math.round(acc.durationMs / acc.pageviews) : 0;
23
+ return out;
24
+ };
25
+ const startOfUtcDay = (d) => new Date(Date.UTC(d.getUTCFullYear(), d.getUTCMonth(), d.getUTCDate()));
26
+ /**
27
+ * Collapse per-day rollup docs into one time-series row per UTC day, ascending by
28
+ * day. Distinct metrics (visitors/sessions) come from each day's own rollup and are
29
+ * never summed across days, so a daily trend shows that day's uniques.
30
+ */
31
+ const seriesFromRollups = (docs, metrics) => {
32
+ const byDay = /* @__PURE__ */ new Map();
33
+ for (const d of docs) {
34
+ const day = startOfUtcDay(new Date(d.period)).toISOString();
35
+ let acc = byDay.get(day);
36
+ if (!acc) {
37
+ acc = emptyAcc();
38
+ byDay.set(day, acc);
39
+ }
40
+ add(acc, d);
41
+ }
42
+ return [...byDay.entries()].sort(([a], [b]) => a < b ? -1 : a > b ? 1 : 0).map(([day, acc]) => ({
43
+ timestamp: day,
44
+ metrics: selectMetrics(acc, metrics)
45
+ }));
46
+ };
47
+ //#endregion
48
+ export { add, emptyAcc, selectMetrics, seriesFromRollups };
49
+
50
+ //# sourceMappingURL=rollupAcc.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rollupAcc.js","names":[],"sources":["../../src/native/rollupAcc.ts"],"sourcesContent":["import type { AnalyticsRow, MetricKey } from '../core/contract'\n\nexport interface RollupDoc {\n\tpath: string\n\tdimvalue: string\n\tperiod: string | Date\n\tpageviews: number\n\tevents: number\n\tdurationMs: number\n\tvisitors: number\n\tsessions: number\n}\n\nexport interface Acc {\n\tpageviews: number\n\tevents: number\n\tdurationMs: number\n\tvisitors: number\n\tsessions: number\n}\n\nexport const emptyAcc = (): Acc => ({\n\tpageviews: 0,\n\tevents: 0,\n\tdurationMs: 0,\n\tvisitors: 0,\n\tsessions: 0,\n})\n\nexport const add = (acc: Acc, d: Acc): void => {\n\tacc.pageviews += d.pageviews\n\tacc.events += d.events\n\tacc.durationMs += d.durationMs\n\tacc.visitors += d.visitors\n\tacc.sessions += d.sessions\n}\n\nexport const selectMetrics = (\n\tacc: Acc,\n\twanted: MetricKey[]\n): Partial<Record<MetricKey, number>> => {\n\tconst out: Partial<Record<MetricKey, number>> = {}\n\tif (wanted.includes('pageviews')) out.pageviews = acc.pageviews\n\tif (wanted.includes('events')) out.events = acc.events\n\tif (wanted.includes('visitors')) out.visitors = acc.visitors\n\tif (wanted.includes('sessions')) out.sessions = acc.sessions\n\tif (wanted.includes('avgDuration')) {\n\t\tout.avgDuration = acc.pageviews > 0 ? Math.round(acc.durationMs / acc.pageviews) : 0\n\t}\n\treturn out\n}\n\nconst startOfUtcDay = (d: Date): Date =>\n\tnew Date(Date.UTC(d.getUTCFullYear(), d.getUTCMonth(), d.getUTCDate()))\n\n/**\n * Collapse per-day rollup docs into one time-series row per UTC day, ascending by\n * day. Distinct metrics (visitors/sessions) come from each day's own rollup and are\n * never summed across days, so a daily trend shows that day's uniques.\n */\nexport const seriesFromRollups = (docs: RollupDoc[], metrics: MetricKey[]): AnalyticsRow[] => {\n\tconst byDay = new Map<string, Acc>()\n\tfor (const d of docs) {\n\t\tconst day = startOfUtcDay(new Date(d.period)).toISOString()\n\t\tlet acc = byDay.get(day)\n\t\tif (!acc) {\n\t\t\tacc = emptyAcc()\n\t\t\tbyDay.set(day, acc)\n\t\t}\n\t\tadd(acc, d)\n\t}\n\treturn [...byDay.entries()]\n\t\t.sort(([a], [b]) => (a < b ? -1 : a > b ? 1 : 0))\n\t\t.map(([day, acc]) => ({ timestamp: day, metrics: selectMetrics(acc, metrics) }))\n}\n"],"mappings":";AAqBA,MAAa,kBAAuB;CACnC,WAAW;CACX,QAAQ;CACR,YAAY;CACZ,UAAU;CACV,UAAU;AACX;AAEA,MAAa,OAAO,KAAU,MAAiB;CAC9C,IAAI,aAAa,EAAE;CACnB,IAAI,UAAU,EAAE;CAChB,IAAI,cAAc,EAAE;CACpB,IAAI,YAAY,EAAE;CAClB,IAAI,YAAY,EAAE;AACnB;AAEA,MAAa,iBACZ,KACA,WACwC;CACxC,MAAM,MAA0C,CAAC;CACjD,IAAI,OAAO,SAAS,WAAW,GAAG,IAAI,YAAY,IAAI;CACtD,IAAI,OAAO,SAAS,QAAQ,GAAG,IAAI,SAAS,IAAI;CAChD,IAAI,OAAO,SAAS,UAAU,GAAG,IAAI,WAAW,IAAI;CACpD,IAAI,OAAO,SAAS,UAAU,GAAG,IAAI,WAAW,IAAI;CACpD,IAAI,OAAO,SAAS,aAAa,GAChC,IAAI,cAAc,IAAI,YAAY,IAAI,KAAK,MAAM,IAAI,aAAa,IAAI,SAAS,IAAI;CAEpF,OAAO;AACR;AAEA,MAAM,iBAAiB,MACtB,IAAI,KAAK,KAAK,IAAI,EAAE,eAAe,GAAG,EAAE,YAAY,GAAG,EAAE,WAAW,CAAC,CAAC;;;;;;AAOvE,MAAa,qBAAqB,MAAmB,YAAyC;CAC7F,MAAM,wBAAQ,IAAI,IAAiB;CACnC,KAAK,MAAM,KAAK,MAAM;EACrB,MAAM,MAAM,cAAc,IAAI,KAAK,EAAE,MAAM,CAAC,EAAE,YAAY;EAC1D,IAAI,MAAM,MAAM,IAAI,GAAG;EACvB,IAAI,CAAC,KAAK;GACT,MAAM,SAAS;GACf,MAAM,IAAI,KAAK,GAAG;EACnB;EACA,IAAI,KAAK,CAAC;CACX;CACA,OAAO,CAAC,GAAG,MAAM,QAAQ,CAAC,EACxB,MAAM,CAAC,IAAI,CAAC,OAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,CAAE,EAC/C,KAAK,CAAC,KAAK,UAAU;EAAE,WAAW;EAAK,SAAS,cAAc,KAAK,OAAO;CAAE,EAAE;AACjF"}
@@ -0,0 +1,9 @@
1
+ //#region src/native/rollups/applyDistinctDeltas.ts
2
+ function bucketKey(key) {
3
+ const base = `${key.granularity}|${key.period.toISOString()}|${key.path}|${key.dimension}|${key.dimvalue}`;
4
+ return key.scope !== void 0 ? `${base}|${key.scope}` : base;
5
+ }
6
+ //#endregion
7
+ export { bucketKey };
8
+
9
+ //# sourceMappingURL=applyDistinctDeltas.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"applyDistinctDeltas.js","names":[],"sources":["../../../src/native/rollups/applyDistinctDeltas.ts"],"sourcesContent":["import type { Payload } from 'payload'\nimport { SEEN_SLUG } from '../collections/seen'\nimport type { StoredEvent } from '../ingest/normalizeEvent'\nimport { bumpRollup } from './bumpRollup'\nimport type { RollupDelta, RollupKey } from './deltas'\nimport { insertIfNew } from './insertIfNew'\n\nexport function bucketKey(key: RollupKey): string {\n\tconst base = `${key.granularity}|${key.period.toISOString()}|${key.path}|${key.dimension}|${key.dimvalue}`\n\treturn key.scope !== undefined ? `${base}|${key.scope}` : base\n}\n\n// For each rollup bucket the event touches, count this visitor and session at most once.\n// insertIfNew is the dedup gate; only a genuinely new ledger row bumps the distinct counter.\nexport async function applyDistinctDeltas(\n\tpayload: Payload,\n\tevent: StoredEvent,\n\tdeltas: RollupDelta[]\n): Promise<void> {\n\tfor (const d of deltas) {\n\t\tconst bucket = bucketKey(d.key)\n\t\tconst period = d.key.period\n\t\tif (\n\t\t\tawait insertIfNew(payload, SEEN_SLUG, {\n\t\t\t\tbucket,\n\t\t\t\tkind: 'visitor',\n\t\t\t\tvalue: event.visitorHash,\n\t\t\t\tperiod,\n\t\t\t})\n\t\t) {\n\t\t\tawait bumpRollup(payload, d.key, { visitors: 1 })\n\t\t}\n\t\tif (\n\t\t\tawait insertIfNew(payload, SEEN_SLUG, {\n\t\t\t\tbucket,\n\t\t\t\tkind: 'session',\n\t\t\t\tvalue: event.sessionId,\n\t\t\t\tperiod,\n\t\t\t})\n\t\t) {\n\t\t\tawait bumpRollup(payload, d.key, { sessions: 1 })\n\t\t}\n\t}\n}\n"],"mappings":";AAOA,SAAgB,UAAU,KAAwB;CACjD,MAAM,OAAO,GAAG,IAAI,YAAY,GAAG,IAAI,OAAO,YAAY,EAAE,GAAG,IAAI,KAAK,GAAG,IAAI,UAAU,GAAG,IAAI;CAChG,OAAO,IAAI,UAAU,KAAA,IAAY,GAAG,KAAK,GAAG,IAAI,UAAU;AAC3D"}
@@ -0,0 +1,52 @@
1
+ import { ROLLUPS_SLUG } from "../collections/rollups.js";
2
+ //#region src/native/rollups/bumpRollup.ts
3
+ const PG_TABLE_KEY = "analytics_rollups";
4
+ const ZERO = {
5
+ pageviews: 0,
6
+ events: 0,
7
+ durationMs: 0,
8
+ samples: 0,
9
+ visitors: 0,
10
+ sessions: 0
11
+ };
12
+ async function bumpRollup(payload, key, inc) {
13
+ if (payload.db.name === "mongoose") {
14
+ const model = payload.db.collections[ROLLUPS_SLUG];
15
+ if (!model) throw new Error(`analytics: mongoose collection "${ROLLUPS_SLUG}" not found`);
16
+ const setOnInsert = { ...key };
17
+ for (const [metric, zero] of Object.entries(ZERO)) if (!(metric in inc)) setOnInsert[metric] = zero;
18
+ await model.collection.updateOne(key, {
19
+ $inc: inc,
20
+ $setOnInsert: setOnInsert
21
+ }, { upsert: true });
22
+ return;
23
+ }
24
+ const { sql } = await import("@payloadcms/db-postgres");
25
+ const db = payload.db;
26
+ const tableName = db.tableNameMap.get(PG_TABLE_KEY);
27
+ if (!tableName) throw new Error(`analytics: drizzle table "${PG_TABLE_KEY}" not found`);
28
+ const table = db.tables[tableName];
29
+ if (!table) throw new Error(`analytics: drizzle table object for "${tableName}" not found`);
30
+ const set = {};
31
+ for (const [metric, amount] of Object.entries(inc)) set[metric] = sql`${table[metric]} + ${amount}`;
32
+ const target = [
33
+ table.granularity,
34
+ table.period,
35
+ table.path,
36
+ table.dimension,
37
+ table.dimvalue
38
+ ];
39
+ if (key.scope !== void 0) target.push(table.scope);
40
+ await db.drizzle.insert(table).values({
41
+ ...key,
42
+ ...ZERO,
43
+ ...inc
44
+ }).onConflictDoUpdate({
45
+ target,
46
+ set
47
+ });
48
+ }
49
+ //#endregion
50
+ export { bumpRollup };
51
+
52
+ //# sourceMappingURL=bumpRollup.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"bumpRollup.js","names":[],"sources":["../../../src/native/rollups/bumpRollup.ts"],"sourcesContent":["import type { Payload } from 'payload'\nimport { ROLLUPS_SLUG } from '../collections/rollups'\nimport type { RollupKey, RollupMetric } from './deltas'\n\nconst PG_TABLE_KEY = 'analytics_rollups'\n\n// payload.db raw-access shapes are intentionally loose; these narrow casts reach the\n// Mongoose driver collection / Drizzle instance for atomic upserts (no public typed API).\ntype MongoDb = {\n\tname: 'mongoose'\n\tcollections: Record<\n\t\tstring,\n\t\t{ collection: { updateOne: (f: object, u: object, o: object) => Promise<unknown> } }\n\t>\n}\ntype PgDb = {\n\tname: 'postgres'\n\tdrizzle: {\n\t\tinsert: (t: unknown) => {\n\t\t\tvalues: (v: unknown) => { onConflictDoUpdate: (c: unknown) => Promise<unknown> }\n\t\t}\n\t}\n\ttables: Record<string, Record<string, unknown>>\n\ttableNameMap: Map<string, string>\n}\n\nconst ZERO: Record<RollupMetric, number> = {\n\tpageviews: 0,\n\tevents: 0,\n\tdurationMs: 0,\n\tsamples: 0,\n\tvisitors: 0,\n\tsessions: 0,\n}\n\n// Always seed every metric on insert: Payload's defaultValue is applied app-side, not as\n// a SQL default, so a raw insert that omits a NOT NULL metric column would fail on Postgres.\nexport async function bumpRollup(\n\tpayload: Payload,\n\tkey: RollupKey,\n\tinc: Partial<Record<RollupMetric, number>>\n): Promise<void> {\n\tif (payload.db.name === 'mongoose') {\n\t\tconst db = payload.db as unknown as MongoDb\n\t\tconst model = db.collections[ROLLUPS_SLUG]\n\t\tif (!model) throw new Error(`analytics: mongoose collection \"${ROLLUPS_SLUG}\" not found`)\n\t\tconst setOnInsert: Record<string, unknown> = { ...key }\n\t\tfor (const [metric, zero] of Object.entries(ZERO)) {\n\t\t\tif (!(metric in inc)) setOnInsert[metric] = zero\n\t\t}\n\t\tawait model.collection.updateOne(\n\t\t\tkey,\n\t\t\t{ $inc: inc, $setOnInsert: setOnInsert },\n\t\t\t{ upsert: true }\n\t\t)\n\t\treturn\n\t}\n\tconst { sql } = await import('@payloadcms/db-postgres')\n\tconst db = payload.db as unknown as PgDb\n\tconst tableName = db.tableNameMap.get(PG_TABLE_KEY)\n\tif (!tableName) throw new Error(`analytics: drizzle table \"${PG_TABLE_KEY}\" not found`)\n\tconst table = db.tables[tableName]\n\tif (!table) throw new Error(`analytics: drizzle table object for \"${tableName}\" not found`)\n\tconst set: Record<string, unknown> = {}\n\tfor (const [metric, amount] of Object.entries(inc)) {\n\t\tset[metric] = sql`${table[metric]} + ${amount}`\n\t}\n\t// The conflict target must match the unique index exactly, which includes the\n\t// scope column only in scoped installs (mirrored by a scope key on RollupKey).\n\tconst target = [table.granularity, table.period, table.path, table.dimension, table.dimvalue]\n\tif (key.scope !== undefined) {\n\t\ttarget.push(table.scope)\n\t}\n\tawait db.drizzle\n\t\t.insert(table)\n\t\t.values({ ...key, ...ZERO, ...inc })\n\t\t.onConflictDoUpdate({ target, set })\n}\n"],"mappings":";;AAIA,MAAM,eAAe;AAsBrB,MAAM,OAAqC;CAC1C,WAAW;CACX,QAAQ;CACR,YAAY;CACZ,SAAS;CACT,UAAU;CACV,UAAU;AACX;AAIA,eAAsB,WACrB,SACA,KACA,KACgB;CAChB,IAAI,QAAQ,GAAG,SAAS,YAAY;EAEnC,MAAM,QADK,QAAQ,GACF,YAAY;EAC7B,IAAI,CAAC,OAAO,MAAM,IAAI,MAAM,mCAAmC,aAAa,YAAY;EACxF,MAAM,cAAuC,EAAE,GAAG,IAAI;EACtD,KAAK,MAAM,CAAC,QAAQ,SAAS,OAAO,QAAQ,IAAI,GAC/C,IAAI,EAAE,UAAU,MAAM,YAAY,UAAU;EAE7C,MAAM,MAAM,WAAW,UACtB,KACA;GAAE,MAAM;GAAK,cAAc;EAAY,GACvC,EAAE,QAAQ,KAAK,CAChB;EACA;CACD;CACA,MAAM,EAAE,QAAQ,MAAM,OAAO;CAC7B,MAAM,KAAK,QAAQ;CACnB,MAAM,YAAY,GAAG,aAAa,IAAI,YAAY;CAClD,IAAI,CAAC,WAAW,MAAM,IAAI,MAAM,6BAA6B,aAAa,YAAY;CACtF,MAAM,QAAQ,GAAG,OAAO;CACxB,IAAI,CAAC,OAAO,MAAM,IAAI,MAAM,wCAAwC,UAAU,YAAY;CAC1F,MAAM,MAA+B,CAAC;CACtC,KAAK,MAAM,CAAC,QAAQ,WAAW,OAAO,QAAQ,GAAG,GAChD,IAAI,UAAU,GAAG,GAAG,MAAM,QAAQ,KAAK;CAIxC,MAAM,SAAS;EAAC,MAAM;EAAa,MAAM;EAAQ,MAAM;EAAM,MAAM;EAAW,MAAM;CAAQ;CAC5F,IAAI,IAAI,UAAU,KAAA,GACjB,OAAO,KAAK,MAAM,KAAK;CAExB,MAAM,GAAG,QACP,OAAO,KAAK,EACZ,OAAO;EAAE,GAAG;EAAK,GAAG;EAAM,GAAG;CAAI,CAAC,EAClC,mBAAmB;EAAE;EAAQ;CAAI,CAAC;AACrC"}
@@ -0,0 +1,31 @@
1
+ //#region src/native/rollups/deltas.ts
2
+ const startOfUtcDay = (d) => new Date(Date.UTC(d.getUTCFullYear(), d.getUTCMonth(), d.getUTCDate()));
3
+ function computeRollupDeltas(event) {
4
+ const period = startOfUtcDay(event.timestamp);
5
+ const inc = {
6
+ pageviews: event.type === "pageview" ? 1 : 0,
7
+ events: event.type === "event" ? 1 : 0,
8
+ durationMs: event.durationMs ?? 0,
9
+ samples: 1
10
+ };
11
+ const make = (path, dimension, dimvalue) => ({
12
+ key: {
13
+ granularity: "day",
14
+ period,
15
+ path,
16
+ dimension,
17
+ dimvalue,
18
+ ...event.scope !== void 0 ? { scope: event.scope } : {}
19
+ },
20
+ inc: { ...inc }
21
+ });
22
+ const deltas = [make(event.path, "", ""), make("", "", "")];
23
+ if (event.country) deltas.push(make("", "country", event.country));
24
+ if (event.device) deltas.push(make("", "device", event.device));
25
+ if (event.source) deltas.push(make("", "source", event.source));
26
+ return deltas;
27
+ }
28
+ //#endregion
29
+ export { computeRollupDeltas };
30
+
31
+ //# sourceMappingURL=deltas.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"deltas.js","names":[],"sources":["../../../src/native/rollups/deltas.ts"],"sourcesContent":["import type { StoredEvent } from '../ingest/normalizeEvent'\n\nexport interface RollupKey {\n\tgranularity: 'day'\n\tperiod: Date\n\tpath: string\n\tdimension: string\n\tdimvalue: string\n\t/** Present only in scoped installs, where it is part of the unique bucket. */\n\tscope?: string\n}\n\nexport type RollupMetric =\n\t| 'pageviews'\n\t| 'events'\n\t| 'durationMs'\n\t| 'samples'\n\t| 'visitors'\n\t| 'sessions'\n\nexport interface RollupDelta {\n\tkey: RollupKey\n\tinc: { pageviews: number; events: number; durationMs: number; samples: number }\n}\n\nconst startOfUtcDay = (d: Date): Date =>\n\tnew Date(Date.UTC(d.getUTCFullYear(), d.getUTCMonth(), d.getUTCDate()))\n\nexport function computeRollupDeltas(event: StoredEvent): RollupDelta[] {\n\tconst period = startOfUtcDay(event.timestamp)\n\tconst inc = {\n\t\tpageviews: event.type === 'pageview' ? 1 : 0,\n\t\tevents: event.type === 'event' ? 1 : 0,\n\t\tdurationMs: event.durationMs ?? 0,\n\t\tsamples: 1,\n\t}\n\tconst make = (path: string, dimension: string, dimvalue: string): RollupDelta => ({\n\t\tkey: {\n\t\t\tgranularity: 'day',\n\t\t\tperiod,\n\t\t\tpath,\n\t\t\tdimension,\n\t\t\tdimvalue,\n\t\t\t...(event.scope !== undefined ? { scope: event.scope } : {}),\n\t\t},\n\t\tinc: { ...inc },\n\t})\n\tconst deltas: RollupDelta[] = [make(event.path, '', ''), make('', '', '')]\n\tif (event.country) {\n\t\tdeltas.push(make('', 'country', event.country))\n\t}\n\tif (event.device) {\n\t\tdeltas.push(make('', 'device', event.device))\n\t}\n\tif (event.source) {\n\t\tdeltas.push(make('', 'source', event.source))\n\t}\n\treturn deltas\n}\n"],"mappings":";AAyBA,MAAM,iBAAiB,MACtB,IAAI,KAAK,KAAK,IAAI,EAAE,eAAe,GAAG,EAAE,YAAY,GAAG,EAAE,WAAW,CAAC,CAAC;AAEvE,SAAgB,oBAAoB,OAAmC;CACtE,MAAM,SAAS,cAAc,MAAM,SAAS;CAC5C,MAAM,MAAM;EACX,WAAW,MAAM,SAAS,aAAa,IAAI;EAC3C,QAAQ,MAAM,SAAS,UAAU,IAAI;EACrC,YAAY,MAAM,cAAc;EAChC,SAAS;CACV;CACA,MAAM,QAAQ,MAAc,WAAmB,cAAmC;EACjF,KAAK;GACJ,aAAa;GACb;GACA;GACA;GACA;GACA,GAAI,MAAM,UAAU,KAAA,IAAY,EAAE,OAAO,MAAM,MAAM,IAAI,CAAC;EAC3D;EACA,KAAK,EAAE,GAAG,IAAI;CACf;CACA,MAAM,SAAwB,CAAC,KAAK,MAAM,MAAM,IAAI,EAAE,GAAG,KAAK,IAAI,IAAI,EAAE,CAAC;CACzE,IAAI,MAAM,SACT,OAAO,KAAK,KAAK,IAAI,WAAW,MAAM,OAAO,CAAC;CAE/C,IAAI,MAAM,QACT,OAAO,KAAK,KAAK,IAAI,UAAU,MAAM,MAAM,CAAC;CAE7C,IAAI,MAAM,QACT,OAAO,KAAK,KAAK,IAAI,UAAU,MAAM,MAAM,CAAC;CAE7C,OAAO;AACR"}
@@ -0,0 +1,19 @@
1
+ //#region src/native/rollups/insertIfNew.ts
2
+ async function insertIfNew(payload, slug, key) {
3
+ if (payload.db.name === "mongoose") {
4
+ const model = payload.db.collections[slug];
5
+ if (!model) throw new Error(`analytics: mongoose collection "${slug}" not found`);
6
+ return (await model.collection.updateOne(key, { $setOnInsert: key }, { upsert: true })).upsertedCount === 1;
7
+ }
8
+ const db = payload.db;
9
+ const tableKey = slug.replace(/-/g, "_");
10
+ const tableName = db.tableNameMap.get(tableKey);
11
+ if (!tableName) throw new Error(`analytics: drizzle table "${tableKey}" not found`);
12
+ const table = db.tables[tableName];
13
+ if (!table) throw new Error(`analytics: drizzle table object for "${tableName}" not found`);
14
+ return (await db.drizzle.insert(table).values(key).onConflictDoNothing().returning()).length === 1;
15
+ }
16
+ //#endregion
17
+ export { insertIfNew };
18
+
19
+ //# sourceMappingURL=insertIfNew.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"insertIfNew.js","names":[],"sources":["../../../src/native/rollups/insertIfNew.ts"],"sourcesContent":["import type { Payload } from 'payload'\n\n// payload.db raw-access shapes are intentionally loose; these narrow casts reach the\n// Mongoose driver collection / Drizzle instance directly (no public typed API).\ntype MongoDb = {\n\tname: 'mongoose'\n\tcollections: Record<\n\t\tstring,\n\t\t{\n\t\t\tcollection: {\n\t\t\t\tupdateOne: (f: object, u: object, o: object) => Promise<{ upsertedCount: number }>\n\t\t\t}\n\t\t}\n\t>\n}\ntype PgDb = {\n\tname: 'postgres'\n\tdrizzle: {\n\t\tinsert: (t: unknown) => {\n\t\t\tvalues: (v: unknown) => { onConflictDoNothing: () => { returning: () => Promise<unknown[]> } }\n\t\t}\n\t}\n\ttables: Record<string, Record<string, unknown>>\n\ttableNameMap: Map<string, string>\n}\n\n// Returns true iff the row was newly inserted (the key had not been seen). Single-statement\n// atomic on both adapters; the unique index on `slug` is what makes it concurrency-safe.\nexport async function insertIfNew(\n\tpayload: Payload,\n\tslug: string,\n\tkey: Record<string, unknown>\n): Promise<boolean> {\n\tif (payload.db.name === 'mongoose') {\n\t\tconst db = payload.db as unknown as MongoDb\n\t\tconst model = db.collections[slug]\n\t\tif (!model) throw new Error(`analytics: mongoose collection \"${slug}\" not found`)\n\t\tconst res = await model.collection.updateOne(key, { $setOnInsert: key }, { upsert: true })\n\t\treturn res.upsertedCount === 1\n\t}\n\tconst db = payload.db as unknown as PgDb\n\tconst tableKey = slug.replace(/-/g, '_')\n\tconst tableName = db.tableNameMap.get(tableKey)\n\tif (!tableName) throw new Error(`analytics: drizzle table \"${tableKey}\" not found`)\n\tconst table = db.tables[tableName]\n\tif (!table) throw new Error(`analytics: drizzle table object for \"${tableName}\" not found`)\n\tconst inserted = await db.drizzle.insert(table).values(key).onConflictDoNothing().returning()\n\treturn inserted.length === 1\n}\n"],"mappings":";AA4BA,eAAsB,YACrB,SACA,MACA,KACmB;CACnB,IAAI,QAAQ,GAAG,SAAS,YAAY;EAEnC,MAAM,QADK,QAAQ,GACF,YAAY;EAC7B,IAAI,CAAC,OAAO,MAAM,IAAI,MAAM,mCAAmC,KAAK,YAAY;EAEhF,QAAO,MADW,MAAM,WAAW,UAAU,KAAK,EAAE,cAAc,IAAI,GAAG,EAAE,QAAQ,KAAK,CAAC,GAC9E,kBAAkB;CAC9B;CACA,MAAM,KAAK,QAAQ;CACnB,MAAM,WAAW,KAAK,QAAQ,MAAM,GAAG;CACvC,MAAM,YAAY,GAAG,aAAa,IAAI,QAAQ;CAC9C,IAAI,CAAC,WAAW,MAAM,IAAI,MAAM,6BAA6B,SAAS,YAAY;CAClF,MAAM,QAAQ,GAAG,OAAO;CACxB,IAAI,CAAC,OAAO,MAAM,IAAI,MAAM,wCAAwC,UAAU,YAAY;CAE1F,QAAO,MADgB,GAAG,QAAQ,OAAO,KAAK,EAAE,OAAO,GAAG,EAAE,oBAAoB,EAAE,UAAU,GAC5E,WAAW;AAC5B"}
@@ -0,0 +1,36 @@
1
+ //#region src/next/posthogProxyRewrites.d.ts
2
+ type PosthogProxyRegion = 'eu' | 'us';
3
+ /** One Next.js rewrite entry (the shape `next.config` `rewrites()` returns). */
4
+ type PosthogProxyRewrite = {
5
+ source: string;
6
+ destination: string;
7
+ };
8
+ type PosthogProxyRewritesOptions = {
9
+ /** First-party base path the snippet's `api_host` points at. Default '/ph'. */path?: string; /** PostHog Cloud region. Default 'eu'. */
10
+ region?: PosthogProxyRegion;
11
+ };
12
+ /**
13
+ * Next.js rewrites for a first-party PostHog reverse proxy, per PostHog's own
14
+ * guidance: static assets and the array loader route to the region's assets host,
15
+ * everything else to the ingest host. Order matters (Next evaluates rewrites in
16
+ * order), and the app should also set `skipTrailingSlashRedirect: true` because
17
+ * PostHog's capture endpoints use trailing slashes.
18
+ *
19
+ * ```ts
20
+ * // next.config.ts
21
+ * import { posthogProxyRewrites } from '@10x-media/analytics/next'
22
+ *
23
+ * const nextConfig = {
24
+ * skipTrailingSlashRedirect: true,
25
+ * async rewrites() {
26
+ * return posthogProxyRewrites({ path: '/ph', region: 'eu' })
27
+ * },
28
+ * }
29
+ * ```
30
+ *
31
+ * Point the snippet at it with `api_host: '/ph'` (plus `ui_host` for the region).
32
+ */
33
+ declare const posthogProxyRewrites: (options?: PosthogProxyRewritesOptions) => PosthogProxyRewrite[];
34
+ //#endregion
35
+ export { PosthogProxyRegion, PosthogProxyRewrite, PosthogProxyRewritesOptions, posthogProxyRewrites };
36
+ //# sourceMappingURL=posthogProxyRewrites.d.ts.map
@@ -0,0 +1,50 @@
1
+ //#region src/next/posthogProxyRewrites.ts
2
+ const normalizePath = (path) => {
3
+ const trimmed = (path.startsWith("/") ? path : `/${path}`).replace(/\/+$/, "");
4
+ return trimmed === "" ? "/" : trimmed;
5
+ };
6
+ /**
7
+ * Next.js rewrites for a first-party PostHog reverse proxy, per PostHog's own
8
+ * guidance: static assets and the array loader route to the region's assets host,
9
+ * everything else to the ingest host. Order matters (Next evaluates rewrites in
10
+ * order), and the app should also set `skipTrailingSlashRedirect: true` because
11
+ * PostHog's capture endpoints use trailing slashes.
12
+ *
13
+ * ```ts
14
+ * // next.config.ts
15
+ * import { posthogProxyRewrites } from '@10x-media/analytics/next'
16
+ *
17
+ * const nextConfig = {
18
+ * skipTrailingSlashRedirect: true,
19
+ * async rewrites() {
20
+ * return posthogProxyRewrites({ path: '/ph', region: 'eu' })
21
+ * },
22
+ * }
23
+ * ```
24
+ *
25
+ * Point the snippet at it with `api_host: '/ph'` (plus `ui_host` for the region).
26
+ */
27
+ const posthogProxyRewrites = (options = {}) => {
28
+ const region = options.region ?? "eu";
29
+ const path = normalizePath(options.path ?? "/ph");
30
+ const assets = `https://${region}-assets.i.posthog.com`;
31
+ const ingest = `https://${region}.i.posthog.com`;
32
+ return [
33
+ {
34
+ source: `${path}/static/:path*`,
35
+ destination: `${assets}/static/:path*`
36
+ },
37
+ {
38
+ source: `${path}/array/:path*`,
39
+ destination: `${assets}/array/:path*`
40
+ },
41
+ {
42
+ source: `${path}/:path*`,
43
+ destination: `${ingest}/:path*`
44
+ }
45
+ ];
46
+ };
47
+ //#endregion
48
+ export { posthogProxyRewrites };
49
+
50
+ //# sourceMappingURL=posthogProxyRewrites.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"posthogProxyRewrites.js","names":[],"sources":["../../src/next/posthogProxyRewrites.ts"],"sourcesContent":["export type PosthogProxyRegion = 'eu' | 'us'\n\n/** One Next.js rewrite entry (the shape `next.config` `rewrites()` returns). */\nexport type PosthogProxyRewrite = { source: string; destination: string }\n\nexport type PosthogProxyRewritesOptions = {\n\t/** First-party base path the snippet's `api_host` points at. Default '/ph'. */\n\tpath?: string\n\t/** PostHog Cloud region. Default 'eu'. */\n\tregion?: PosthogProxyRegion\n}\n\nconst normalizePath = (path: string): string => {\n\tconst withLeading = path.startsWith('/') ? path : `/${path}`\n\tconst trimmed = withLeading.replace(/\\/+$/, '')\n\treturn trimmed === '' ? '/' : trimmed\n}\n\n/**\n * Next.js rewrites for a first-party PostHog reverse proxy, per PostHog's own\n * guidance: static assets and the array loader route to the region's assets host,\n * everything else to the ingest host. Order matters (Next evaluates rewrites in\n * order), and the app should also set `skipTrailingSlashRedirect: true` because\n * PostHog's capture endpoints use trailing slashes.\n *\n * ```ts\n * // next.config.ts\n * import { posthogProxyRewrites } from '@10x-media/analytics/next'\n *\n * const nextConfig = {\n * skipTrailingSlashRedirect: true,\n * async rewrites() {\n * return posthogProxyRewrites({ path: '/ph', region: 'eu' })\n * },\n * }\n * ```\n *\n * Point the snippet at it with `api_host: '/ph'` (plus `ui_host` for the region).\n */\nexport const posthogProxyRewrites = (\n\toptions: PosthogProxyRewritesOptions = {}\n): PosthogProxyRewrite[] => {\n\tconst region = options.region ?? 'eu'\n\tconst path = normalizePath(options.path ?? '/ph')\n\tconst assets = `https://${region}-assets.i.posthog.com`\n\tconst ingest = `https://${region}.i.posthog.com`\n\treturn [\n\t\t{ source: `${path}/static/:path*`, destination: `${assets}/static/:path*` },\n\t\t{ source: `${path}/array/:path*`, destination: `${assets}/array/:path*` },\n\t\t{ source: `${path}/:path*`, destination: `${ingest}/:path*` },\n\t]\n}\n"],"mappings":";AAYA,MAAM,iBAAiB,SAAyB;CAE/C,MAAM,WADc,KAAK,WAAW,GAAG,IAAI,OAAO,IAAI,QAC1B,QAAQ,QAAQ,EAAE;CAC9C,OAAO,YAAY,KAAK,MAAM;AAC/B;;;;;;;;;;;;;;;;;;;;;;AAuBA,MAAa,wBACZ,UAAuC,CAAC,MACb;CAC3B,MAAM,SAAS,QAAQ,UAAU;CACjC,MAAM,OAAO,cAAc,QAAQ,QAAQ,KAAK;CAChD,MAAM,SAAS,WAAW,OAAO;CACjC,MAAM,SAAS,WAAW,OAAO;CACjC,OAAO;EACN;GAAE,QAAQ,GAAG,KAAK;GAAiB,aAAa,GAAG,OAAO;EAAgB;EAC1E;GAAE,QAAQ,GAAG,KAAK;GAAgB,aAAa,GAAG,OAAO;EAAe;EACxE;GAAE,QAAQ,GAAG,KAAK;GAAU,aAAa,GAAG,OAAO;EAAS;CAC7D;AACD"}
@@ -0,0 +1,36 @@
1
+ import { readForWidgetRealtime } from "../widgets/readForWidgetRealtime.js";
2
+ //#region src/plugin/realtimeEndpoint.ts
3
+ const ALLOWED_METRICS = ["visitors", "pageviews"];
4
+ const ALLOWED_WINDOWS = [
5
+ 5,
6
+ 15,
7
+ 30,
8
+ 60
9
+ ];
10
+ const DEFAULT_WINDOW = 30;
11
+ const REALTIME_PATH = "/analytics/realtime";
12
+ /**
13
+ * 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
+ */
18
+ 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()
30
+ });
31
+ return Response.json(result);
32
+ };
33
+ //#endregion
34
+ export { REALTIME_PATH, makeRealtimeHandler };
35
+
36
+ //# sourceMappingURL=realtimeEndpoint.js.map
@@ -0,0 +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'\n\nconst ALLOWED_METRICS: MetricKey[] = ['visitors', 'pageviews']\nconst ALLOWED_WINDOWS = [5, 15, 30, 60]\nconst DEFAULT_WINDOW = 30\n\nexport const REALTIME_PATH = '/analytics/realtime'\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":";;AAIA,MAAM,kBAA+B,CAAC,YAAY,WAAW;AAC7D,MAAM,kBAAkB;CAAC;CAAG;CAAI;CAAI;AAAE;AACtC,MAAM,iBAAiB;AAEvB,MAAa,gBAAgB;;;;;;;AAQ7B,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"}
@@ -0,0 +1,19 @@
1
+ import { toNested, translations } from "../translations/index.js";
2
+ import { deepMergeSimple } from "payload/shared";
3
+ //#region src/plugin/registerTranslations.ts
4
+ /**
5
+ * Merge this plugin's translations into the host config. Plugin-level
6
+ * `overrides` win over the built-ins key-by-key and may add locales the plugin
7
+ * does not ship. A host value wins over both (`deepMergeSimple` lets the second
8
+ * argument override), so projects can override any string.
9
+ */
10
+ const registerTranslations = (config, overrides) => {
11
+ const nested = {};
12
+ for (const [locale, flat] of Object.entries(overrides ?? {})) nested[locale] = toNested(flat);
13
+ config.i18n ??= {};
14
+ config.i18n.translations = deepMergeSimple(deepMergeSimple(translations, nested), config.i18n.translations ?? {});
15
+ };
16
+ //#endregion
17
+ export { registerTranslations };
18
+
19
+ //# sourceMappingURL=registerTranslations.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"registerTranslations.js","names":[],"sources":["../../src/plugin/registerTranslations.ts"],"sourcesContent":["import type { Config } from 'payload'\nimport { deepMergeSimple } from 'payload/shared'\n\nimport { type TranslationsOption, toNested, translations } from '../translations'\n\ntype Translations = NonNullable<NonNullable<Config['i18n']>['translations']>\n\n/**\n * Merge this plugin's translations into the host config. Plugin-level\n * `overrides` win over the built-ins key-by-key and may add locales the plugin\n * does not ship. A host value wins over both (`deepMergeSimple` lets the second\n * argument override), so projects can override any string.\n */\nexport const registerTranslations = (config: Config, overrides?: TranslationsOption): void => {\n\tconst nested: Record<string, Record<string, Record<string, string>>> = {}\n\tfor (const [locale, flat] of Object.entries(overrides ?? {})) {\n\t\tnested[locale] = toNested(flat)\n\t}\n\tconfig.i18n ??= {}\n\tconfig.i18n.translations = deepMergeSimple<Translations>(\n\t\tdeepMergeSimple(translations, nested),\n\t\tconfig.i18n.translations ?? {}\n\t)\n}\n"],"mappings":";;;;;;;;;AAaA,MAAa,wBAAwB,QAAgB,cAAyC;CAC7F,MAAM,SAAiE,CAAC;CACxE,KAAK,MAAM,CAAC,QAAQ,SAAS,OAAO,QAAQ,aAAa,CAAC,CAAC,GAC1D,OAAO,UAAU,SAAS,IAAI;CAE/B,OAAO,SAAS,CAAC;CACjB,OAAO,KAAK,eAAe,gBAC1B,gBAAgB,cAAc,MAAM,GACpC,OAAO,KAAK,gBAAgB,CAAC,CAC9B;AACD"}
@@ -0,0 +1,20 @@
1
+ //#region src/plugin/runtime.ts
2
+ /**
3
+ * Stored on the Payload instance (not a module global) so the runtime survives the
4
+ * separate `.` and `/rsc` bundles a consumer loads: a server-component bundle that
5
+ * imported its own copy of a module-level map would never see what the plugin wrote.
6
+ * `Symbol.for` keys into the cross-realm global symbol registry, so both bundles
7
+ * resolve the same key on the same `payload` object.
8
+ */
9
+ const RUNTIME_KEY = Symbol.for("@10x-media/analytics/runtime");
10
+ const setRuntime = (payload, runtime) => {
11
+ payload[RUNTIME_KEY] = runtime;
12
+ };
13
+ const getRuntime = (payload) => payload[RUNTIME_KEY];
14
+ const resolveScopeFor = (runtime, req) => runtime.resolveScope?.(req) ?? Promise.resolve(null);
15
+ const resolveRegistryFor = (runtime, args) => runtime.resolveRegistry?.(args) ?? Promise.resolve(runtime.registry);
16
+ const platformReadFor = async (runtime, req) => runtime.platformRead ? await runtime.platformRead({ req }) : Boolean(req.user);
17
+ //#endregion
18
+ export { getRuntime, platformReadFor, resolveRegistryFor, resolveScopeFor, setRuntime };
19
+
20
+ //# sourceMappingURL=runtime.js.map
@@ -0,0 +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 { AdapterRegistry, RegistryResolver, ResolveRegistryArgs } from '../core/registry'\nimport type { Engine } from '../surfacing/engine'\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/** Id of the config adapter shared by every scope, when one is designated. */\n\tplatformAdapterId?: 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\tttl: { aggregate: number; realtime: number }\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 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":";;;;;;;;AA2BA,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,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"}
@@ -0,0 +1,165 @@
1
+ import { TIMEFRAME_PRESETS } from "../timeframe/presets.js";
2
+ import { breakdownSpecBySlug } from "../widgets/breakdownTypes.js";
3
+ import { resolveCustomRange } from "../widgets/range.js";
4
+ import { readForWidget } from "../widgets/readForWidget.js";
5
+ import { readForWidgetBreakdown } from "../widgets/readForWidgetBreakdown.js";
6
+ import { readForWidgetSeries } from "../widgets/readForWidgetSeries.js";
7
+ import { WIDGET_METRICS } from "../widgets/types.js";
8
+ //#region src/plugin/warmTask.ts
9
+ const asString = (v) => typeof v === "string" ? v : void 0;
10
+ const asMetric = (v) => typeof v === "string" && WIDGET_METRICS.includes(v) ? v : "pageviews";
11
+ const asTimeframe = (v) => {
12
+ if (v === "custom") return "custom";
13
+ if (typeof v === "string" && TIMEFRAME_PRESETS.includes(v)) return v;
14
+ return "last30days";
15
+ };
16
+ const asLimit = (v) => typeof v === "number" && v > 0 ? v : 5;
17
+ const asRange = (v) => {
18
+ if (!v || typeof v !== "object") return;
19
+ const r = v;
20
+ return {
21
+ from: asString(r.from),
22
+ to: asString(r.to)
23
+ };
24
+ };
25
+ const targetKey = (t) => {
26
+ const range = t.range ? `${t.range.start.toISOString()}:${t.range.end.toISOString()}` : "";
27
+ const dimension = t.kind === "breakdown" ? t.dimension : "";
28
+ const limit = t.kind === "breakdown" ? String(t.limit) : "";
29
+ return `${t.kind}:${t.metric}:${dimension}:${t.timeframe}:${limit}:${t.adapterId ?? ""}:${range}`;
30
+ };
31
+ /**
32
+ * Map a dashboard's widget layout to the set of reads that warm its cache. Built-in
33
+ * metric, trend, and breakdown widgets become targets; the realtime widget is skipped
34
+ * (its short-TTL key is kept warm by the live poller) and any other slug is a custom app
35
+ * widget whose read shape the plugin does not know. A `custom` timeframe is kept only when
36
+ * its range resolves (the read takes an explicit range; `timeframe` is then unused).
37
+ * Identical targets are de-duplicated so a repeated widget warms its tuple once.
38
+ */
39
+ const deriveWarmTargets = (widgets) => {
40
+ const out = [];
41
+ const seen = /* @__PURE__ */ new Set();
42
+ for (const widget of widgets) {
43
+ const slug = widget.widgetSlug;
44
+ if (!slug || slug === "analytics-realtime") continue;
45
+ const data = widget.data ?? {};
46
+ const metric = asMetric(data.metric);
47
+ const adapterId = asString(data.dataSource);
48
+ const timeframeRaw = asTimeframe(data.timeframe);
49
+ let timeframe = "last30days";
50
+ let range;
51
+ if (timeframeRaw === "custom") {
52
+ const resolved = resolveCustomRange("custom", asRange(data.range));
53
+ if (!resolved) continue;
54
+ range = resolved;
55
+ } else timeframe = timeframeRaw;
56
+ let target;
57
+ if (slug === "analytics-metric") target = {
58
+ kind: "metric",
59
+ metric,
60
+ timeframe,
61
+ range,
62
+ adapterId
63
+ };
64
+ else if (slug === "analytics-trend") target = {
65
+ kind: "series",
66
+ metric,
67
+ timeframe,
68
+ range,
69
+ adapterId
70
+ };
71
+ else {
72
+ const spec = breakdownSpecBySlug(slug);
73
+ if (spec) target = {
74
+ kind: "breakdown",
75
+ metric,
76
+ dimension: spec.dimension,
77
+ timeframe,
78
+ limit: asLimit(data.limit),
79
+ range,
80
+ adapterId
81
+ };
82
+ }
83
+ if (!target) continue;
84
+ const key = targetKey(target);
85
+ if (seen.has(key)) continue;
86
+ seen.add(key);
87
+ out.push(target);
88
+ }
89
+ return out;
90
+ };
91
+ const WARM_TASK_SLUG = "analytics-warm-cache";
92
+ const resolveLayout = async (layout, req) => {
93
+ try {
94
+ return (typeof layout === "function" ? await layout({ req }) : layout ?? []).map((w) => ({
95
+ widgetSlug: w.widgetSlug,
96
+ data: w.data
97
+ }));
98
+ } catch (err) {
99
+ req.payload.logger.warn(`analytics warm-cache: could not resolve the dashboard layout: ${String(err)}`);
100
+ return [];
101
+ }
102
+ };
103
+ /** Run one target's read; returns true when the read served data (status `ok`). */
104
+ const runTarget = async (target, req, now) => {
105
+ if (target.kind === "metric") return (await readForWidget({
106
+ req,
107
+ metrics: [target.metric],
108
+ timeframe: target.timeframe,
109
+ adapterId: target.adapterId,
110
+ now,
111
+ range: target.range
112
+ })).status === "ok";
113
+ if (target.kind === "series") return (await readForWidgetSeries({
114
+ req,
115
+ metric: target.metric,
116
+ timeframe: target.timeframe,
117
+ adapterId: target.adapterId,
118
+ now,
119
+ range: target.range
120
+ })).status === "ok";
121
+ return (await readForWidgetBreakdown({
122
+ req,
123
+ metric: target.metric,
124
+ dimension: target.dimension,
125
+ timeframe: target.timeframe,
126
+ limit: target.limit,
127
+ adapterId: target.adapterId,
128
+ now,
129
+ range: target.range
130
+ })).status === "ok";
131
+ };
132
+ /**
133
+ * Opt-in Payload task that pre-runs the dashboard's widget reads through the surfacing
134
+ * engine so `payload.kv` is warm before a user opens the dashboard. Targets are derived
135
+ * from `layout` (the app's `defaultLayout`, captured at registration and resolved here);
136
+ * each read is isolated so one failing provider does not abort the rest. Most valuable
137
+ * for slow or rate-limited provider adapters; native reads are cheap and harmless to warm.
138
+ */
139
+ const warmTask = (cron, layout) => ({
140
+ slug: WARM_TASK_SLUG,
141
+ handler: async ({ req }) => {
142
+ const targets = deriveWarmTargets(await resolveLayout(layout, req));
143
+ const now = /* @__PURE__ */ new Date();
144
+ let warmed = 0;
145
+ let failed = 0;
146
+ for (const target of targets) try {
147
+ if (await runTarget(target, req, now)) warmed++;
148
+ } catch (err) {
149
+ failed++;
150
+ req.payload.logger.warn(`analytics warm-cache: ${target.kind} read for "${target.metric}" failed: ${String(err)}`);
151
+ }
152
+ return { output: {
153
+ warmed,
154
+ failed
155
+ } };
156
+ },
157
+ schedule: [{
158
+ cron,
159
+ queue: "default"
160
+ }]
161
+ });
162
+ //#endregion
163
+ export { warmTask };
164
+
165
+ //# sourceMappingURL=warmTask.js.map
@@ -0,0 +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 { TIMEFRAME_PRESETS, type TimeframePreset } from '../timeframe/presets'\nimport { breakdownSpecBySlug } from '../widgets/breakdownTypes'\nimport { resolveCustomRange } from '../widgets/range'\nimport { readForWidget } 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\n/** Run one target's read; returns true when the read served data (status `ok`). */\nconst runTarget = async (target: WarmTarget, req: PayloadRequest, now: Date): Promise<boolean> => {\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})\n\t\treturn result.status === 'ok'\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})\n\t\treturn result.status === 'ok'\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})\n\treturn result.status === 'ok'\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 */\nexport const warmTask = (\n\tcron: string,\n\tlayout: WarmLayout\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\tconst now = new Date()\n\t\tlet warmed = 0\n\t\tlet failed = 0\n\t\tfor (const target of targets) {\n\t\t\ttry {\n\t\t\t\tif (await runTarget(target, req, now)) {\n\t\t\t\t\twarmed++\n\t\t\t\t}\n\t\t\t} catch (err) {\n\t\t\t\tfailed++\n\t\t\t\treq.payload.logger.warn(\n\t\t\t\t\t`analytics warm-cache: ${target.kind} read for \"${target.metric}\" failed: ${String(err)}`\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":";;;;;;;;AAyCA,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;;AAGA,MAAM,YAAY,OAAO,QAAoB,KAAqB,QAAgC;CACjG,IAAI,OAAO,SAAS,UASnB,QAAO,MARc,cAAc;EAClC;EACA,SAAS,CAAC,OAAO,MAAM;EACvB,WAAW,OAAO;EAClB,WAAW,OAAO;EAClB;EACA,OAAO,OAAO;CACf,CAAC,GACa,WAAW;CAE1B,IAAI,OAAO,SAAS,UASnB,QAAO,MARc,oBAAoB;EACxC;EACA,QAAQ,OAAO;EACf,WAAW,OAAO;EAClB,WAAW,OAAO;EAClB;EACA,OAAO,OAAO;CACf,CAAC,GACa,WAAW;CAY1B,QAAO,MAVc,uBAAuB;EAC3C;EACA,QAAQ,OAAO;EACf,WAAW,OAAO;EAClB,WAAW,OAAO;EAClB,OAAO,OAAO;EACd,WAAW,OAAO;EAClB;EACA,OAAO,OAAO;CACf,CAAC,GACa,WAAW;AAC1B;;;;;;;;AASA,MAAa,YACZ,MACA,YAC+F;CAC/F,MAAM;CACN,SAAS,OAAO,EAAE,UAAU;EAC3B,MAAM,UAAU,kBAAkB,MAAM,cAAc,QAAQ,GAAG,CAAC;EAClE,MAAM,sBAAM,IAAI,KAAK;EACrB,IAAI,SAAS;EACb,IAAI,SAAS;EACb,KAAK,MAAM,UAAU,SACpB,IAAI;GACH,IAAI,MAAM,UAAU,QAAQ,KAAK,GAAG,GACnC;EAEF,SAAS,KAAK;GACb;GACA,IAAI,QAAQ,OAAO,KAClB,yBAAyB,OAAO,KAAK,aAAa,OAAO,OAAO,YAAY,OAAO,GAAG,GACvF;EACD;EAED,OAAO,EAAE,QAAQ;GAAE;GAAQ;EAAO,EAAE;CACrC;CACA,UAAU,CAAC;EAAE;EAAM,OAAO;CAAU,CAAC;AACtC"}