@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
package/dist/index.js CHANGED
@@ -1,1025 +1,20 @@
1
- import { a as readForWidgetSeries, b as setRuntime, c as readForWidget, d as BREAKDOWN_SPECS, f as breakdownSpecBySlug, g as makeRealtimeHandler, h as REALTIME_PATH, i as TIMEFRAME_KEYS, n as labelForKey, o as supportsGranularity, p as TIMEFRAME_PRESETS, r as METRIC_KEYS, s as readForWidgetBreakdown, u as resolveCustomRange, v as kvCacheStore, x as satisfiesCapabilities, y as getRuntime } from "./server-Cuvhgz-S.js";
2
- import { t as keys } from "./keys-DEqL4LOT.js";
3
- import { n as en, t as translations } from "./translations-keiKtSjF.js";
1
+ import { buildProvidersCollection } from "./providers/collection.js";
2
+ import { resolveOptions } from "./core/options.js";
3
+ import { createRegistry, staticRegistryResolver } from "./core/registry.js";
4
+ import { setRuntime } from "./plugin/runtime.js";
5
+ import { PLATFORM_SCOPE } from "./core/contract.js";
6
+ import { kvCacheStore } from "./surfacing/cacheStore.js";
7
+ import { REALTIME_PATH, makeRealtimeHandler } from "./plugin/realtimeEndpoint.js";
8
+ import { registerTranslations } from "./plugin/registerTranslations.js";
9
+ import { warmTask } from "./plugin/warmTask.js";
10
+ import { collectionProvidersSource, combineRegistries, createScopedRegistryResolver } from "./providers/resolver.js";
11
+ import { createEngine } from "./surfacing/engine.js";
12
+ import { syncCollection } from "./sync/collection.js";
13
+ import { syncTask } from "./sync/syncTask.js";
14
+ import { registerWidgets } from "./widgets/registerWidgets.js";
15
+ import { analyticsFields, analyticsStat, analyticsStatRow, analyticsTab, analyticsTabsField } from "./fields/factories.js";
16
+ import { analyticsDefaultWidgets } from "./widgets/defaults.js";
4
17
  import { definePlugin } from "payload";
5
- import { deepMergeSimple } from "payload/shared";
6
- //#region src/core/options.ts
7
- const DEFAULT_WARM_CRON = "*/30 * * * *";
8
- const DEFAULT_SYNC_CRON = "0 */6 * * *";
9
- const DEFAULT_SYNC_COLLECTION = "analytics-daily";
10
- const DEFAULT_SYNC_LOOKBACK = 3;
11
- const resolveBindings = (collections) => {
12
- const out = {};
13
- for (const [slug, binding] of Object.entries(collections ?? {})) {
14
- if (!binding.path && !binding.pathField) throw new Error(`analytics: binding for "${slug}" needs a path resolver or a pathField`);
15
- out[slug] = binding;
16
- }
17
- return out;
18
- };
19
- function resolveOptions(options) {
20
- if (!options.adapters || options.adapters.length === 0) throw new Error("analytics: at least one adapter is required");
21
- const widgets = options.widgets === false ? {
22
- enabled: false,
23
- disabled: [],
24
- register: []
25
- } : options.widgets === void 0 || options.widgets === true ? {
26
- enabled: true,
27
- disabled: [],
28
- register: []
29
- } : {
30
- enabled: true,
31
- disabled: options.widgets.disabled ?? [],
32
- register: options.widgets.register ?? []
33
- };
34
- const warmOpt = options.cache?.warm;
35
- const warm = warmOpt === true ? {
36
- enabled: true,
37
- cron: DEFAULT_WARM_CRON
38
- } : warmOpt && typeof warmOpt === "object" ? {
39
- enabled: true,
40
- cron: warmOpt.cron ?? DEFAULT_WARM_CRON
41
- } : {
42
- enabled: false,
43
- cron: DEFAULT_WARM_CRON
44
- };
45
- const syncOpt = options.sync;
46
- const sync = syncOpt === true ? {
47
- enabled: true,
48
- collectionSlug: DEFAULT_SYNC_COLLECTION,
49
- cron: DEFAULT_SYNC_CRON,
50
- lookbackDays: DEFAULT_SYNC_LOOKBACK
51
- } : syncOpt && typeof syncOpt === "object" ? {
52
- enabled: true,
53
- collectionSlug: syncOpt.collectionSlug ?? DEFAULT_SYNC_COLLECTION,
54
- cron: syncOpt.cron ?? DEFAULT_SYNC_CRON,
55
- lookbackDays: syncOpt.lookbackDays ?? DEFAULT_SYNC_LOOKBACK,
56
- adapters: syncOpt.adapters
57
- } : {
58
- enabled: false,
59
- collectionSlug: DEFAULT_SYNC_COLLECTION,
60
- cron: DEFAULT_SYNC_CRON,
61
- lookbackDays: DEFAULT_SYNC_LOOKBACK
62
- };
63
- return {
64
- adapters: options.adapters,
65
- defaultAdapter: options.defaultAdapter,
66
- bindings: resolveBindings(options.collections),
67
- cache: {
68
- ttl: {
69
- aggregate: options.cache?.ttl?.aggregate ?? 3600,
70
- realtime: options.cache?.ttl?.realtime ?? 300
71
- },
72
- warm
73
- },
74
- widgets,
75
- sync
76
- };
77
- }
78
- //#endregion
79
- //#region src/core/registry.ts
80
- function createRegistry(adapters, defaultId) {
81
- if (adapters.length === 0) throw new Error("analytics: at least one adapter is required");
82
- const first = adapters[0];
83
- const byId = new Map(adapters.map((a) => [a.id, a]));
84
- if (defaultId !== void 0 && !byId.has(defaultId)) throw new Error(`analytics: unknown default adapter "${defaultId}"`);
85
- const fallback = defaultId ?? first.id;
86
- return {
87
- get(id) {
88
- const a = byId.get(id);
89
- if (!a) throw new Error(`analytics: unknown adapter "${id}"`);
90
- return a;
91
- },
92
- default: () => byId.get(fallback) ?? first,
93
- all: () => adapters,
94
- isMultiProvider: () => adapters.length > 1
95
- };
96
- }
97
- //#endregion
98
- //#region src/plugin/registerTranslations.ts
99
- /**
100
- * Merge this plugin's translations into the host config. A host value wins on
101
- * conflict (`deepMergeSimple` lets the second argument override), so projects can
102
- * override any string.
103
- */
104
- const registerTranslations = (config) => {
105
- config.i18n ??= {};
106
- config.i18n.translations = deepMergeSimple(translations, config.i18n.translations ?? {});
107
- };
108
- //#endregion
109
- //#region src/widgets/types.ts
110
- const WIDGET_METRICS = [
111
- "pageviews",
112
- "visitors",
113
- "sessions",
114
- "avgDuration",
115
- "bounceRate",
116
- "events"
117
- ];
118
- //#endregion
119
- //#region src/plugin/warmTask.ts
120
- const asString = (v) => typeof v === "string" ? v : void 0;
121
- const asMetric = (v) => typeof v === "string" && WIDGET_METRICS.includes(v) ? v : "pageviews";
122
- const asTimeframe = (v) => {
123
- if (v === "custom") return "custom";
124
- if (typeof v === "string" && TIMEFRAME_PRESETS.includes(v)) return v;
125
- return "last30days";
126
- };
127
- const asLimit = (v) => typeof v === "number" && v > 0 ? v : 5;
128
- const asRange = (v) => {
129
- if (!v || typeof v !== "object") return;
130
- const r = v;
131
- return {
132
- from: asString(r.from),
133
- to: asString(r.to)
134
- };
135
- };
136
- const targetKey = (t) => {
137
- const range = t.range ? `${t.range.start.toISOString()}:${t.range.end.toISOString()}` : "";
138
- const dimension = t.kind === "breakdown" ? t.dimension : "";
139
- const limit = t.kind === "breakdown" ? String(t.limit) : "";
140
- return `${t.kind}:${t.metric}:${dimension}:${t.timeframe}:${limit}:${t.adapterId ?? ""}:${range}`;
141
- };
142
- /**
143
- * Map a dashboard's widget layout to the set of reads that warm its cache. Built-in
144
- * metric, trend, and breakdown widgets become targets; the realtime widget is skipped
145
- * (its short-TTL key is kept warm by the live poller) and any other slug is a custom app
146
- * widget whose read shape the plugin does not know. A `custom` timeframe is kept only when
147
- * its range resolves (the read takes an explicit range; `timeframe` is then unused).
148
- * Identical targets are de-duplicated so a repeated widget warms its tuple once.
149
- */
150
- const deriveWarmTargets = (widgets) => {
151
- const out = [];
152
- const seen = /* @__PURE__ */ new Set();
153
- for (const widget of widgets) {
154
- const slug = widget.widgetSlug;
155
- if (!slug || slug === "analytics-realtime") continue;
156
- const data = widget.data ?? {};
157
- const metric = asMetric(data.metric);
158
- const adapterId = asString(data.dataSource);
159
- const timeframeRaw = asTimeframe(data.timeframe);
160
- let timeframe = "last30days";
161
- let range;
162
- if (timeframeRaw === "custom") {
163
- const resolved = resolveCustomRange("custom", asRange(data.range));
164
- if (!resolved) continue;
165
- range = resolved;
166
- } else timeframe = timeframeRaw;
167
- let target;
168
- if (slug === "analytics-metric") target = {
169
- kind: "metric",
170
- metric,
171
- timeframe,
172
- range,
173
- adapterId
174
- };
175
- else if (slug === "analytics-trend") target = {
176
- kind: "series",
177
- metric,
178
- timeframe,
179
- range,
180
- adapterId
181
- };
182
- else {
183
- const spec = breakdownSpecBySlug(slug);
184
- if (spec) target = {
185
- kind: "breakdown",
186
- metric,
187
- dimension: spec.dimension,
188
- timeframe,
189
- limit: asLimit(data.limit),
190
- range,
191
- adapterId
192
- };
193
- }
194
- if (!target) continue;
195
- const key = targetKey(target);
196
- if (seen.has(key)) continue;
197
- seen.add(key);
198
- out.push(target);
199
- }
200
- return out;
201
- };
202
- const WARM_TASK_SLUG = "analytics-warm-cache";
203
- const resolveLayout = async (layout, req) => {
204
- try {
205
- return (typeof layout === "function" ? await layout({ req }) : layout ?? []).map((w) => ({
206
- widgetSlug: w.widgetSlug,
207
- data: w.data
208
- }));
209
- } catch (err) {
210
- req.payload.logger.warn(`analytics warm-cache: could not resolve the dashboard layout: ${String(err)}`);
211
- return [];
212
- }
213
- };
214
- /** Run one target's read; returns true when the read served data (status `ok`). */
215
- const runTarget = async (target, req, now) => {
216
- if (target.kind === "metric") return (await readForWidget({
217
- req,
218
- metrics: [target.metric],
219
- timeframe: target.timeframe,
220
- adapterId: target.adapterId,
221
- now,
222
- range: target.range
223
- })).status === "ok";
224
- if (target.kind === "series") return (await readForWidgetSeries({
225
- req,
226
- metric: target.metric,
227
- timeframe: target.timeframe,
228
- adapterId: target.adapterId,
229
- now,
230
- range: target.range
231
- })).status === "ok";
232
- return (await readForWidgetBreakdown({
233
- req,
234
- metric: target.metric,
235
- dimension: target.dimension,
236
- timeframe: target.timeframe,
237
- limit: target.limit,
238
- adapterId: target.adapterId,
239
- now,
240
- range: target.range
241
- })).status === "ok";
242
- };
243
- /**
244
- * Opt-in Payload task that pre-runs the dashboard's widget reads through the surfacing
245
- * engine so `payload.kv` is warm before a user opens the dashboard. Targets are derived
246
- * from `layout` (the app's `defaultLayout`, captured at registration and resolved here);
247
- * each read is isolated so one failing provider does not abort the rest. Most valuable
248
- * for slow or rate-limited provider adapters; native reads are cheap and harmless to warm.
249
- */
250
- const warmTask = (cron, layout) => ({
251
- slug: WARM_TASK_SLUG,
252
- handler: async ({ req }) => {
253
- const targets = deriveWarmTargets(await resolveLayout(layout, req));
254
- const now = /* @__PURE__ */ new Date();
255
- let warmed = 0;
256
- let failed = 0;
257
- for (const target of targets) try {
258
- if (await runTarget(target, req, now)) warmed++;
259
- } catch (err) {
260
- failed++;
261
- req.payload.logger.warn(`analytics warm-cache: ${target.kind} read for "${target.metric}" failed: ${String(err)}`);
262
- }
263
- return { output: {
264
- warmed,
265
- failed
266
- } };
267
- },
268
- schedule: [{
269
- cron,
270
- queue: "default"
271
- }]
272
- });
273
- //#endregion
274
- //#region src/core/cacheKey.ts
275
- const stable = (xs) => xs ? [...xs].sort().join(",") : "";
276
- const startOfUtcDay$2 = (d) => new Date(Date.UTC(d.getUTCFullYear(), d.getUTCMonth(), d.getUTCDate()));
277
- const startOfNextUtcDay = (d) => {
278
- const day = startOfUtcDay$2(d);
279
- day.setUTCDate(day.getUTCDate() + 1);
280
- return day;
281
- };
282
- function buildCacheKey(provider, q) {
283
- const scope = q.path ?? "site";
284
- const range = `${startOfUtcDay$2(q.dateRange.start).toISOString()}_${startOfNextUtcDay(q.dateRange.end).toISOString()}`;
285
- const filters = (q.filters ?? []).map((f) => `${f.dimension}${f.operator}${f.value}`).sort().join(";");
286
- return [
287
- "analytics",
288
- provider,
289
- q.hostname ?? "_",
290
- scope,
291
- stable(q.metrics),
292
- stable(q.dimensions),
293
- range,
294
- q.granularity ?? "_",
295
- filters,
296
- String(q.limit ?? "_"),
297
- q.order ? `${q.order.metric}:${q.order.direction}` : "_"
298
- ].join("|");
299
- }
300
- //#endregion
301
- //#region src/surfacing/coalesce.ts
302
- function createCoalescer() {
303
- const inFlight = /* @__PURE__ */ new Map();
304
- return (key, worker) => {
305
- const existing = inFlight.get(key);
306
- if (existing) return existing;
307
- const promise = worker().finally(() => inFlight.delete(key));
308
- inFlight.set(key, promise);
309
- return promise;
310
- };
311
- }
312
- //#endregion
313
- //#region src/surfacing/queue.ts
314
- const wait = (ms) => new Promise((r) => setTimeout(r, ms));
315
- function createQueue(opts) {
316
- const maxRetries = opts.maxRetries ?? 0;
317
- const baseDelayMs = opts.baseDelayMs ?? 200;
318
- let active = 0;
319
- const pending = [];
320
- const acquire = () => {
321
- if (active < opts.concurrency) {
322
- active++;
323
- return Promise.resolve();
324
- }
325
- return new Promise((resolve) => pending.push(resolve)).then(() => {
326
- active++;
327
- });
328
- };
329
- const release = () => {
330
- active--;
331
- pending.shift()?.();
332
- };
333
- const withRetry = async (task) => {
334
- let attempt = 0;
335
- for (;;) try {
336
- return await task();
337
- } catch (err) {
338
- if (attempt >= maxRetries) throw err;
339
- const jitter = baseDelayMs * .5;
340
- await wait(baseDelayMs * 2 ** attempt + jitter * attempt);
341
- attempt++;
342
- }
343
- };
344
- return { async run(task) {
345
- await acquire();
346
- try {
347
- return await withRetry(task);
348
- } finally {
349
- release();
350
- }
351
- } };
352
- }
353
- //#endregion
354
- //#region src/surfacing/engine.ts
355
- const DAY_MS$1 = 864e5;
356
- const startOfUtcDay$1 = (d) => new Date(Date.UTC(d.getUTCFullYear(), d.getUTCMonth(), d.getUTCDate()));
357
- const clampRange = (range, maxLookbackDays) => {
358
- if (maxLookbackDays == null) return {
359
- range,
360
- clamped: false
361
- };
362
- const floor = /* @__PURE__ */ new Date(startOfUtcDay$1(range.end).getTime() - maxLookbackDays * DAY_MS$1);
363
- if (range.start.getTime() >= floor.getTime()) return {
364
- range,
365
- clamped: false
366
- };
367
- return {
368
- range: {
369
- start: floor,
370
- end: range.end
371
- },
372
- clamped: true
373
- };
374
- };
375
- const emptyResult = (provider, q) => ({
376
- rows: [],
377
- meta: {
378
- provider,
379
- fetchedAt: q.dateRange.end.toISOString()
380
- }
381
- });
382
- function createEngine(opts) {
383
- const coalesce = createCoalescer();
384
- const queue = createQueue(opts.queue);
385
- return { async read(adapter, query) {
386
- if (!adapter.isConfigured()) return emptyResult(adapter.id, query);
387
- const { range, clamped } = clampRange(query.dateRange, adapter.capabilities.maxLookbackDays);
388
- const q = clamped ? {
389
- ...query,
390
- dateRange: range
391
- } : query;
392
- const key = buildCacheKey(adapter.id, q);
393
- return coalesce(key, async () => {
394
- const cached = await opts.store.get(key);
395
- if (cached) return cached;
396
- const fresh = await queue.run(() => adapter.query(q, {}));
397
- const result = clamped ? {
398
- ...fresh,
399
- meta: {
400
- ...fresh.meta,
401
- clamped: true
402
- }
403
- } : fresh;
404
- const ttl = adapter.capabilities.recommendedTtl.aggregate || opts.ttl.aggregate;
405
- await opts.store.set(key, result, ttl);
406
- return result;
407
- });
408
- } };
409
- }
410
- //#endregion
411
- //#region src/sync/collection.ts
412
- const METRIC_FIELDS = [
413
- "pageviews",
414
- "visitors",
415
- "sessions",
416
- "avgDuration",
417
- "bounceRate",
418
- "events"
419
- ];
420
- /**
421
- * The sync tier's queryable collection: one row per (source, date) of a provider's daily
422
- * metrics. Unlike the native collections it is visible and readable; writes are locked to
423
- * the sync job (which uses overrideAccess). The unique (source, date) index makes re-syncs
424
- * idempotent and is cross-DB clean (both key columns are required, so NOT NULL on Postgres,
425
- * which would otherwise treat repeated rows as distinct). Metric fields are nullable so a
426
- * provider that omits a metric is distinguishable from a real zero.
427
- */
428
- const syncCollection = (slug) => ({
429
- slug,
430
- admin: {
431
- useAsTitle: "source",
432
- defaultColumns: [
433
- "source",
434
- "date",
435
- "pageviews",
436
- "visitors"
437
- ]
438
- },
439
- access: {
440
- read: ({ req }) => Boolean(req.user),
441
- create: () => false,
442
- update: () => false,
443
- delete: () => false
444
- },
445
- fields: [
446
- {
447
- name: "source",
448
- type: "text",
449
- required: true,
450
- index: true
451
- },
452
- {
453
- name: "date",
454
- type: "date",
455
- required: true,
456
- index: true
457
- },
458
- ...METRIC_FIELDS.map((name) => ({
459
- name,
460
- type: "number"
461
- })),
462
- {
463
- name: "syncedAt",
464
- type: "date"
465
- }
466
- ],
467
- indexes: [{
468
- fields: ["source", "date"],
469
- unique: true
470
- }]
471
- });
472
- //#endregion
473
- //#region src/sync/syncTask.ts
474
- const SYNC_TASK_SLUG = "analytics-sync";
475
- const DAY_MS = 864e5;
476
- /**
477
- * Map one daily `AnalyticsRow` to a sync-collection doc: the row's UTC-day timestamp becomes
478
- * `date`, each present numeric metric is copied, absent metrics are omitted (stored null).
479
- * Returns null when the row has no usable timestamp, so a malformed row is skipped not written.
480
- */
481
- const toSyncRow = (source, row, syncedAt) => {
482
- if (!row.timestamp) return null;
483
- const date = new Date(row.timestamp);
484
- if (Number.isNaN(date.getTime())) return null;
485
- const doc = {
486
- source,
487
- date,
488
- syncedAt
489
- };
490
- for (const metric of METRIC_FIELDS) {
491
- const value = row.metrics[metric];
492
- if (typeof value === "number") doc[metric] = value;
493
- }
494
- return doc;
495
- };
496
- const startOfUtcDay = (d) => new Date(Date.UTC(d.getUTCFullYear(), d.getUTCMonth(), d.getUTCDate()));
497
- const upsertDailyRow = async (req, collectionSlug, row) => {
498
- const found = (await req.payload.find({
499
- collection: collectionSlug,
500
- where: { and: [{ source: { equals: row.source } }, { date: { equals: row.date.toISOString() } }] },
501
- limit: 1,
502
- depth: 0,
503
- overrideAccess: true
504
- })).docs[0];
505
- if (found) {
506
- await req.payload.update({
507
- collection: collectionSlug,
508
- id: found.id,
509
- data: row,
510
- overrideAccess: true
511
- });
512
- return;
513
- }
514
- await req.payload.create({
515
- collection: collectionSlug,
516
- data: row,
517
- overrideAccess: true
518
- });
519
- };
520
- /**
521
- * Opt-in Payload task that ETLs each configured provider adapter's last `lookbackDays` of
522
- * daily metrics into the sync collection (one upserted row per source + day), reading
523
- * through the surfacing engine so the pull rides its queue / backoff / cache. Native is
524
- * excluded (its data already lives in the rollups collection); each provider runs in its
525
- * own try/catch so one failure does not abort the rest.
526
- */
527
- const syncTask = (opts) => ({
528
- slug: SYNC_TASK_SLUG,
529
- handler: async ({ req }) => {
530
- const runtime = getRuntime(req.payload);
531
- if (!runtime) return { output: {
532
- synced: 0,
533
- failed: 0
534
- } };
535
- const now = /* @__PURE__ */ new Date();
536
- const dateRange = {
537
- start: /* @__PURE__ */ new Date(startOfUtcDay(now).getTime() - (opts.lookbackDays - 1) * DAY_MS),
538
- end: now
539
- };
540
- let synced = 0;
541
- let failed = 0;
542
- for (const adapter of runtime.registry.all()) {
543
- if (adapter.id === "native") continue;
544
- if (opts.adapterIds && !opts.adapterIds.includes(adapter.id)) continue;
545
- if (!adapter.isConfigured() || !supportsGranularity(adapter.capabilities, "day")) continue;
546
- const metrics = METRIC_FIELDS.filter((m) => adapter.capabilities.metrics.has(m));
547
- if (metrics.length === 0) continue;
548
- let result;
549
- try {
550
- result = await runtime.engine.read(adapter, {
551
- metrics,
552
- dateRange,
553
- granularity: "day"
554
- });
555
- } catch (err) {
556
- failed++;
557
- req.payload.logger.warn(`analytics sync: adapter "${adapter.id}" read failed: ${String(err)}`);
558
- continue;
559
- }
560
- for (const row of result.rows) {
561
- const doc = toSyncRow(adapter.id, row, now);
562
- if (!doc) continue;
563
- try {
564
- await upsertDailyRow(req, opts.collectionSlug, doc);
565
- synced++;
566
- } catch (err) {
567
- failed++;
568
- req.payload.logger.warn(`analytics sync: upsert for "${adapter.id}" on ${doc.date.toISOString()} failed: ${String(err)}`);
569
- }
570
- }
571
- }
572
- return { output: {
573
- synced,
574
- failed
575
- } };
576
- },
577
- schedule: [{
578
- cron: opts.cron,
579
- queue: "default"
580
- }]
581
- });
582
- //#endregion
583
- //#region src/fields/dateRange/field.ts
584
- /**
585
- * Utility to create a Date Range field: a group with `from` / `to` date subfields
586
- * rendered as a single range picker in the admin UI.
587
- *
588
- * @example
589
- * ```ts
590
- * dateRangeField({
591
- * name: 'eventDates',
592
- * label: 'Event Dates',
593
- * pickerAppearance: 'dayOnly',
594
- * timezone: true,
595
- * })
596
- * ```
597
- */
598
- const dateRangeField = (args) => {
599
- const { name, label, description, required, pickerAppearance = "default", timezone = false, overrides } = args;
600
- const childFields = [{
601
- name: "from",
602
- type: "date",
603
- admin: { hidden: true }
604
- }, {
605
- name: "to",
606
- type: "date",
607
- admin: { hidden: true }
608
- }];
609
- if (timezone) childFields.push({
610
- name: "_tz",
611
- type: "text",
612
- admin: { hidden: true }
613
- });
614
- const baseField = {
615
- name,
616
- type: "group",
617
- label: label ?? false,
618
- required,
619
- admin: {
620
- description,
621
- components: { Field: {
622
- path: "@10x-media/analytics/client#DateRangeField",
623
- clientProps: {
624
- pickerAppearance,
625
- timezone
626
- }
627
- } }
628
- },
629
- fields: childFields
630
- };
631
- if (typeof overrides === "function") return overrides(baseField);
632
- return baseField;
633
- };
634
- //#endregion
635
- //#region src/widgets/customWidget.ts
636
- const isSupported = (requires, adapters) => !requires || adapters.some((a) => satisfiesCapabilities(a.capabilities, requires));
637
- /**
638
- * Turn app-provided custom widget defs into Payload widgets: validate the slug (the
639
- * `analytics-` prefix is reserved for built-ins), skip a disabled slug, and drop a def
640
- * whose `requires` no configured adapter satisfies. Throws on a reserved or empty slug
641
- * so a misconfiguration fails at boot rather than silently dropping the widget.
642
- */
643
- const buildCustomWidgets = (defs, adapters, disabled) => {
644
- const built = [];
645
- for (const def of defs) {
646
- if (!def.slug || def.slug.startsWith("analytics-")) throw new Error(`analytics: custom widget slug "${def.slug}" is invalid; it must be non-empty and must not use the reserved "analytics-" prefix`);
647
- if (disabled.includes(def.slug)) continue;
648
- if (!isSupported(def.requires, adapters)) continue;
649
- built.push({
650
- slug: def.slug,
651
- Component: def.component,
652
- label: def.label,
653
- fields: def.fields ?? [],
654
- minWidth: def.minWidth,
655
- maxWidth: def.maxWidth
656
- });
657
- }
658
- return built;
659
- };
660
- //#endregion
661
- //#region src/widgets/registerWidgets.ts
662
- const widgetIsSupported = (requires, adapters) => !requires || adapters.some((a) => satisfiesCapabilities(a.capabilities, requires));
663
- const metricWidgetFields = (args) => {
664
- const fields = [
665
- {
666
- name: "title",
667
- type: "text",
668
- label: labelForKey(keys.widgetFieldTitle),
669
- admin: { placeholder: en[keys.widgetFieldTitlePlaceholder] }
670
- },
671
- {
672
- name: "metric",
673
- type: "select",
674
- required: true,
675
- defaultValue: "pageviews",
676
- label: labelForKey(keys.widgetFieldMetric),
677
- options: WIDGET_METRICS.map((m) => ({
678
- value: m,
679
- label: labelForKey(METRIC_KEYS[m])
680
- }))
681
- },
682
- {
683
- name: "timeframe",
684
- type: "select",
685
- required: true,
686
- defaultValue: "last30days",
687
- label: labelForKey(keys.widgetFieldTimeframe),
688
- options: [...TIMEFRAME_PRESETS.map((p) => ({
689
- value: p,
690
- label: labelForKey(TIMEFRAME_KEYS[p])
691
- })), {
692
- value: "custom",
693
- label: labelForKey(keys.widgetTimeframeCustom)
694
- }]
695
- },
696
- dateRangeField({
697
- name: "range",
698
- label: labelForKey(keys.widgetFieldRange),
699
- pickerAppearance: "dayOnly",
700
- overrides: (f) => ({
701
- ...f,
702
- admin: {
703
- ...f.admin,
704
- condition: (_data, siblingData) => siblingData?.timeframe === "custom"
705
- }
706
- })
707
- })
708
- ];
709
- if (args.multiProvider) fields.push({
710
- name: "dataSource",
711
- type: "select",
712
- label: labelForKey(keys.widgetFieldDataSource),
713
- defaultValue: args.adapters[0]?.id,
714
- options: args.adapters.map((a) => ({
715
- value: a.id,
716
- label: a.label
717
- }))
718
- });
719
- return fields;
720
- };
721
- const breakdownWidgetFields = (args, spec) => {
722
- const fields = [
723
- {
724
- name: "title",
725
- type: "text",
726
- label: labelForKey(keys.widgetFieldTitle),
727
- admin: { placeholder: en[spec.label] }
728
- },
729
- {
730
- name: "metric",
731
- type: "select",
732
- required: true,
733
- defaultValue: "pageviews",
734
- label: labelForKey(keys.widgetFieldMetric),
735
- options: WIDGET_METRICS.map((m) => ({
736
- value: m,
737
- label: labelForKey(METRIC_KEYS[m])
738
- }))
739
- },
740
- {
741
- name: "timeframe",
742
- type: "select",
743
- required: true,
744
- defaultValue: "last30days",
745
- label: labelForKey(keys.widgetFieldTimeframe),
746
- options: [...TIMEFRAME_PRESETS.map((p) => ({
747
- value: p,
748
- label: labelForKey(TIMEFRAME_KEYS[p])
749
- })), {
750
- value: "custom",
751
- label: labelForKey(keys.widgetTimeframeCustom)
752
- }]
753
- },
754
- dateRangeField({
755
- name: "range",
756
- label: labelForKey(keys.widgetFieldRange),
757
- pickerAppearance: "dayOnly",
758
- overrides: (f) => ({
759
- ...f,
760
- admin: {
761
- ...f.admin,
762
- condition: (_data, siblingData) => siblingData?.timeframe === "custom"
763
- }
764
- })
765
- }),
766
- {
767
- name: "limit",
768
- type: "number",
769
- defaultValue: 5,
770
- min: 1,
771
- max: 20,
772
- label: labelForKey(keys.widgetFieldLimit)
773
- }
774
- ];
775
- if (args.multiProvider) fields.push({
776
- name: "dataSource",
777
- type: "select",
778
- label: labelForKey(keys.widgetFieldDataSource),
779
- defaultValue: args.adapters[0]?.id,
780
- options: args.adapters.map((a) => ({
781
- value: a.id,
782
- label: a.label
783
- }))
784
- });
785
- return fields;
786
- };
787
- const realtimeWidgetFields = (args) => {
788
- const fields = [
789
- {
790
- name: "title",
791
- type: "text",
792
- label: labelForKey(keys.widgetFieldTitle),
793
- admin: { placeholder: en[keys.widgetFieldTitlePlaceholder] }
794
- },
795
- {
796
- name: "metric",
797
- type: "select",
798
- required: true,
799
- defaultValue: "visitors",
800
- label: labelForKey(keys.widgetFieldMetric),
801
- options: [{
802
- value: "visitors",
803
- label: labelForKey(METRIC_KEYS.visitors)
804
- }, {
805
- value: "pageviews",
806
- label: labelForKey(METRIC_KEYS.pageviews)
807
- }]
808
- },
809
- {
810
- name: "windowMinutes",
811
- type: "select",
812
- defaultValue: "30",
813
- label: labelForKey(keys.widgetFieldWindow),
814
- options: [
815
- {
816
- value: "5",
817
- label: "5 min"
818
- },
819
- {
820
- value: "15",
821
- label: "15 min"
822
- },
823
- {
824
- value: "30",
825
- label: "30 min"
826
- },
827
- {
828
- value: "60",
829
- label: "60 min"
830
- }
831
- ]
832
- }
833
- ];
834
- if (args.multiProvider) fields.push({
835
- name: "dataSource",
836
- type: "select",
837
- label: labelForKey(keys.widgetFieldDataSource),
838
- defaultValue: args.adapters[0]?.id,
839
- options: args.adapters.map((a) => ({
840
- value: a.id,
841
- label: a.label
842
- }))
843
- });
844
- return fields;
845
- };
846
- const WIDGET_DEFS = [
847
- {
848
- slug: "analytics-metric",
849
- component: "@10x-media/analytics/rsc#AnalyticsMetricWidget",
850
- label: keys.widgetMetricLabel,
851
- minWidth: "x-small",
852
- maxWidth: "medium",
853
- fields: metricWidgetFields
854
- },
855
- {
856
- slug: "analytics-trend",
857
- component: "@10x-media/analytics/rsc#AnalyticsTrendWidget",
858
- label: keys.widgetTrendLabel,
859
- requires: { metrics: ["pageviews"] },
860
- minWidth: "small",
861
- maxWidth: "full",
862
- fields: metricWidgetFields
863
- },
864
- {
865
- slug: "analytics-realtime",
866
- component: "@10x-media/analytics/rsc#AnalyticsRealtimeWidget",
867
- label: keys.widgetRealtimeLabel,
868
- requires: { realtime: true },
869
- minWidth: "small",
870
- maxWidth: "medium",
871
- fields: realtimeWidgetFields
872
- },
873
- ...BREAKDOWN_SPECS.map((spec) => ({
874
- slug: spec.slug,
875
- component: "@10x-media/analytics/rsc#AnalyticsBreakdownWidget",
876
- label: spec.label,
877
- requires: { dimensions: [spec.dimension] },
878
- minWidth: "small",
879
- maxWidth: "large",
880
- fields: (args) => breakdownWidgetFields(args, spec)
881
- }))
882
- ];
883
- const registerWidgets = (config, args) => {
884
- const built = [];
885
- for (const def of WIDGET_DEFS) {
886
- if (args.disabled.includes(def.slug)) continue;
887
- if (!widgetIsSupported(def.requires, args.adapters)) continue;
888
- built.push({
889
- slug: def.slug,
890
- Component: def.component,
891
- label: labelForKey(def.label),
892
- fields: def.fields(args),
893
- minWidth: def.minWidth,
894
- maxWidth: def.maxWidth
895
- });
896
- }
897
- built.push(...buildCustomWidgets(args.register, args.adapters, args.disabled));
898
- if (!built.length) return;
899
- config.admin ??= {};
900
- config.admin.dashboard ??= { widgets: [] };
901
- config.admin.dashboard.widgets ??= [];
902
- config.admin.dashboard.widgets.push(...built);
903
- };
904
- //#endregion
905
- //#region src/fields/factories.ts
906
- const RSC_PATH = "@10x-media/analytics/rsc#AnalyticsStatField";
907
- const DEFAULT_ROW_METRICS = [
908
- "pageviews",
909
- "visitors",
910
- "sessions",
911
- "avgDuration"
912
- ];
913
- const statField = (name, serverProps, position) => ({
914
- name,
915
- type: "ui",
916
- admin: {
917
- ...position ? { position } : {},
918
- components: { Field: {
919
- path: RSC_PATH,
920
- serverProps
921
- } }
922
- }
923
- });
924
- const analyticsStat = (options) => statField(options.name ?? `analytics_${options.metric}`, {
925
- metrics: [options.metric],
926
- timeframe: options.timeframe ?? "last30days",
927
- variant: "stat",
928
- adapterId: options.adapter
929
- }, options.position);
930
- const analyticsStatRow = (options = {}) => statField(options.name ?? "analytics_stats", {
931
- metrics: options.metrics ?? DEFAULT_ROW_METRICS,
932
- timeframe: options.timeframe ?? "last30days",
933
- variant: "row",
934
- adapterId: options.adapter
935
- }, options.position);
936
- const analyticsFields = (options = {}) => (options.metrics ?? DEFAULT_ROW_METRICS).map((metric) => analyticsStat({
937
- metric,
938
- timeframe: options.timeframe,
939
- adapter: options.adapter,
940
- name: `analytics_${metric}`
941
- }));
942
- const analyticsTab = (options = {}) => ({
943
- type: "tabs",
944
- tabs: [{
945
- label: labelForKey(keys.tabAnalytics),
946
- fields: [analyticsStatRow({
947
- metrics: options.metrics,
948
- timeframe: options.timeframe,
949
- adapter: options.adapter
950
- })]
951
- }]
952
- });
953
- //#endregion
954
- //#region src/widgets/defaults.ts
955
- /**
956
- * Default analytics widget instances to spread into an app's own
957
- * `admin.dashboard.defaultLayout`. A plugin must never set `defaultLayout` itself
958
- * (Payload applies it with `??=`, so any setter would clobber the app's layout).
959
- */
960
- const analyticsDefaultWidgets = () => [
961
- {
962
- widgetSlug: "analytics-trend",
963
- width: "large",
964
- data: {
965
- metric: "pageviews",
966
- timeframe: "last30days"
967
- }
968
- },
969
- {
970
- widgetSlug: "analytics-metric",
971
- width: "small",
972
- data: {
973
- metric: "pageviews",
974
- timeframe: "last30days"
975
- }
976
- },
977
- {
978
- widgetSlug: "analytics-metric",
979
- width: "small",
980
- data: {
981
- metric: "visitors",
982
- timeframe: "last30days"
983
- }
984
- },
985
- {
986
- widgetSlug: "analytics-breakdown-pages",
987
- width: "medium",
988
- data: {
989
- metric: "pageviews",
990
- timeframe: "last30days",
991
- limit: 5
992
- }
993
- },
994
- {
995
- widgetSlug: "analytics-breakdown-sources",
996
- width: "medium",
997
- data: {
998
- metric: "pageviews",
999
- timeframe: "last30days",
1000
- limit: 5
1001
- }
1002
- },
1003
- {
1004
- widgetSlug: "analytics-breakdown-devices",
1005
- width: "medium",
1006
- data: {
1007
- metric: "pageviews",
1008
- timeframe: "last30days",
1009
- limit: 5
1010
- }
1011
- },
1012
- {
1013
- widgetSlug: "analytics-breakdown-countries",
1014
- width: "medium",
1015
- data: {
1016
- metric: "pageviews",
1017
- timeframe: "last30days",
1018
- limit: 5
1019
- }
1020
- }
1021
- ];
1022
- //#endregion
1023
18
  //#region src/index.ts
1024
19
  const analytics = definePlugin({
1025
20
  slug: "@10x-media/analytics",
@@ -1027,9 +22,39 @@ const analytics = definePlugin({
1027
22
  if (options.disabled === true) return config;
1028
23
  const resolved = resolveOptions(options);
1029
24
  const defaultLayout = config.admin?.dashboard?.defaultLayout;
1030
- registerTranslations(config);
25
+ registerTranslations(config, options.translations);
1031
26
  const registry = createRegistry(resolved.adapters, resolved.defaultAdapter);
1032
- for (const adapter of resolved.adapters) adapter.register?.(config);
27
+ const registryBase = {
28
+ adapters: resolved.adapters,
29
+ defaultId: resolved.defaultAdapter
30
+ };
31
+ let resolveRegistry = staticRegistryResolver(registry);
32
+ let invalidateProviders = () => {};
33
+ const providersResolve = resolved.providers.resolve;
34
+ if (providersResolve) resolveRegistry = async (args) => combineRegistries(registryBase, await providersResolve({
35
+ payload: args.payload,
36
+ req: args.req,
37
+ scope: args.scope
38
+ }));
39
+ else if (resolved.providers.collection.enabled) {
40
+ const scoped = createScopedRegistryResolver({
41
+ base: registryBase,
42
+ source: collectionProvidersSource(resolved.providers.collection.slug, resolved.providers.collection.scopeField)
43
+ });
44
+ resolveRegistry = scoped.resolver;
45
+ invalidateProviders = scoped.invalidate;
46
+ }
47
+ if (resolved.providers.collection.enabled) config.collections = [...config.collections ?? [], buildProvidersCollection({
48
+ slug: resolved.providers.collection.slug,
49
+ access: resolved.providers.collection.access,
50
+ overrides: resolved.providers.collection.overrides,
51
+ onChange: () => invalidateProviders()
52
+ })];
53
+ const resolveScope = async (req) => resolved.scopeResolver({ req });
54
+ for (const adapter of resolved.adapters) adapter.register?.(config, {
55
+ scoped: resolved.scoped,
56
+ resolveScope
57
+ });
1033
58
  if (resolved.adapters.some((a) => a.capabilities.realtime && typeof a.realtime === "function")) config.endpoints = [...config.endpoints ?? [], {
1034
59
  method: "get",
1035
60
  path: REALTIME_PATH,
@@ -1039,7 +64,8 @@ const analytics = definePlugin({
1039
64
  adapters: resolved.adapters,
1040
65
  multiProvider: registry.isMultiProvider(),
1041
66
  disabled: resolved.widgets.disabled,
1042
- register: resolved.widgets.register
67
+ register: resolved.widgets.register,
68
+ localizeText: resolved.widgets.localizeText
1043
69
  });
1044
70
  if (resolved.cache.warm.enabled) config.jobs = {
1045
71
  ...config.jobs,
@@ -1067,6 +93,10 @@ const analytics = definePlugin({
1067
93
  });
1068
94
  setRuntime(payload, {
1069
95
  registry,
96
+ resolveRegistry,
97
+ resolveScope,
98
+ platformAdapterId: resolved.platformAdapter,
99
+ platformRead: resolved.access.platformRead,
1070
100
  bindings: resolved.bindings,
1071
101
  engine,
1072
102
  ttl: resolved.cache.ttl
@@ -1076,6 +106,6 @@ const analytics = definePlugin({
1076
106
  }
1077
107
  });
1078
108
  //#endregion
1079
- export { analytics, analyticsDefaultWidgets, analyticsFields, analyticsStat, analyticsStatRow, analyticsTab };
109
+ export { PLATFORM_SCOPE, analytics, analyticsDefaultWidgets, analyticsFields, analyticsStat, analyticsStatRow, analyticsTab, analyticsTabsField };
1080
110
 
1081
111
  //# sourceMappingURL=index.js.map