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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (285) hide show
  1. package/CHANGELOG.md +127 -0
  2. package/README.md +38 -357
  3. package/dist/adapters/ga4/ga4.d.ts +20 -0
  4. package/dist/adapters/ga4/ga4.js +187 -0
  5. package/dist/adapters/ga4/ga4.js.map +1 -0
  6. package/dist/{fetchJson-DZb2_Puj.js → adapters/http/fetchJson.js} +2 -2
  7. package/dist/adapters/http/fetchJson.js.map +1 -0
  8. package/dist/adapters/plausible/plausible.d.ts +15 -0
  9. package/dist/adapters/plausible/plausible.js +148 -0
  10. package/dist/adapters/plausible/plausible.js.map +1 -0
  11. package/dist/adapters/posthog/posthog.d.ts +23 -0
  12. package/dist/adapters/posthog/posthog.js +132 -0
  13. package/dist/adapters/posthog/posthog.js.map +1 -0
  14. package/dist/{series-zytbzPoc.js → adapters/series.js} +2 -2
  15. package/dist/adapters/series.js.map +1 -0
  16. package/dist/adapters/umami/umami.d.ts +18 -0
  17. package/dist/adapters/umami/umami.js +139 -0
  18. package/dist/{exports/adapters → adapters/umami}/umami.js.map +1 -1
  19. package/dist/binding/resolvePath.js +61 -0
  20. package/dist/binding/resolvePath.js.map +1 -0
  21. package/dist/binding/types.d.ts +55 -0
  22. package/dist/charts/BarList.d.ts +20 -0
  23. package/dist/charts/BarList.js +73 -0
  24. package/dist/charts/BarList.js.map +1 -0
  25. package/dist/charts/TrendChart.d.ts +25 -0
  26. package/dist/charts/TrendChart.js +195 -0
  27. package/dist/charts/TrendChart.js.map +1 -0
  28. package/dist/charts/bars.d.ts +9 -0
  29. package/dist/charts/bars.js +19 -0
  30. package/dist/charts/bars.js.map +1 -0
  31. package/dist/charts/bucket.js +86 -0
  32. package/dist/charts/bucket.js.map +1 -0
  33. package/dist/charts/spline.js +84 -0
  34. package/dist/charts/spline.js.map +1 -0
  35. package/dist/charts/styles.js +42 -0
  36. package/dist/charts/styles.js.map +1 -0
  37. package/dist/core/cacheKey.js +28 -0
  38. package/dist/core/cacheKey.js.map +1 -0
  39. package/dist/core/capabilities.d.ts +12 -0
  40. package/dist/core/capabilities.js +12 -0
  41. package/dist/core/capabilities.js.map +1 -0
  42. package/dist/{contract-CWZPKWuR.d.ts → core/contract.d.ts} +42 -5
  43. package/dist/core/contract.js +10 -0
  44. package/dist/core/contract.js.map +1 -0
  45. package/dist/core/granularity.js +17 -0
  46. package/dist/core/granularity.js.map +1 -0
  47. package/dist/core/options.d.ts +140 -0
  48. package/dist/core/options.js +114 -0
  49. package/dist/core/options.js.map +1 -0
  50. package/dist/core/registry.js +24 -0
  51. package/dist/core/registry.js.map +1 -0
  52. package/dist/core/scopedRead.js +57 -0
  53. package/dist/core/scopedRead.js.map +1 -0
  54. package/dist/exports/adapters/ga4.d.ts +2 -20
  55. package/dist/exports/adapters/ga4.js +1 -176
  56. package/dist/exports/adapters/native.d.ts +2 -22
  57. package/dist/exports/adapters/native.js +1 -848
  58. package/dist/exports/adapters/plausible.d.ts +2 -15
  59. package/dist/exports/adapters/plausible.js +1 -142
  60. package/dist/exports/adapters/posthog.d.ts +2 -17
  61. package/dist/exports/adapters/posthog.js +1 -118
  62. package/dist/exports/adapters/umami.d.ts +2 -18
  63. package/dist/exports/adapters/umami.js +1 -138
  64. package/dist/exports/client.d.ts +5 -77
  65. package/dist/exports/client.js +4 -386
  66. package/dist/exports/geo.d.ts +4 -19
  67. package/dist/exports/geo.js +3 -1
  68. package/dist/exports/i18n.d.ts +3 -63
  69. package/dist/exports/i18n.js +2 -2
  70. package/dist/exports/next.d.ts +2 -0
  71. package/dist/exports/next.js +2 -0
  72. package/dist/exports/rsc.d.ts +16 -120
  73. package/dist/exports/rsc.js +14 -598
  74. package/dist/exports/types.d.ts +6 -4
  75. package/dist/exports/types.js +2 -1
  76. package/dist/fields/AnalyticsPanelClient.js +193 -0
  77. package/dist/fields/AnalyticsPanelClient.js.map +1 -0
  78. package/dist/fields/AnalyticsPanelField.d.ts +28 -0
  79. package/dist/fields/AnalyticsPanelField.js +54 -0
  80. package/dist/fields/AnalyticsPanelField.js.map +1 -0
  81. package/dist/fields/AnalyticsStatField.d.ts +31 -0
  82. package/dist/fields/AnalyticsStatField.js +104 -0
  83. package/dist/fields/AnalyticsStatField.js.map +1 -0
  84. package/dist/fields/dateRange/field.js +55 -0
  85. package/dist/fields/dateRange/field.js.map +1 -0
  86. package/dist/fields/dateRange/styles.js +23 -0
  87. package/dist/fields/dateRange/styles.js.map +1 -0
  88. package/dist/fields/dateRange/types.d.ts +11 -0
  89. package/dist/fields/dateRange/ui.d.ts +9 -0
  90. package/dist/fields/dateRange/ui.js +373 -0
  91. package/dist/fields/dateRange/ui.js.map +1 -0
  92. package/dist/fields/emptyState.js +46 -0
  93. package/dist/fields/emptyState.js.map +1 -0
  94. package/dist/fields/factories.d.ts +60 -0
  95. package/dist/fields/factories.js +94 -0
  96. package/dist/fields/factories.js.map +1 -0
  97. package/dist/fields/format.d.ts +7 -0
  98. package/dist/fields/format.js +22 -0
  99. package/dist/fields/format.js.map +1 -0
  100. package/dist/fields/readForDocument.d.ts +57 -0
  101. package/dist/fields/readForDocument.js +147 -0
  102. package/dist/fields/readForDocument.js.map +1 -0
  103. package/dist/index.d.ts +18 -3
  104. package/dist/index.js +83 -1028
  105. package/dist/index.js.map +1 -1
  106. package/dist/native/collections/events.js +101 -0
  107. package/dist/native/collections/events.js.map +1 -0
  108. package/dist/native/collections/rollups.js +115 -0
  109. package/dist/native/collections/rollups.js.map +1 -0
  110. package/dist/native/collections/seen.js +47 -0
  111. package/dist/native/collections/seen.js.map +1 -0
  112. package/dist/native/geo/composeGeoResolvers.d.ts +7 -0
  113. package/dist/native/geo/composeGeoResolvers.js +14 -0
  114. package/dist/native/geo/composeGeoResolvers.js.map +1 -0
  115. package/dist/{geoResolver-CasIa4T9.d.ts → native/geo/geoResolver.d.ts} +2 -2
  116. package/dist/native/geo/geoResolver.js +11 -0
  117. package/dist/native/geo/geoResolver.js.map +1 -0
  118. package/dist/native/geo/maxmindResolver.d.ts +16 -0
  119. package/dist/native/geo/maxmindResolver.js +55 -0
  120. package/dist/native/geo/maxmindResolver.js.map +1 -0
  121. package/dist/native/ingest/device.js +15 -0
  122. package/dist/native/ingest/device.js.map +1 -0
  123. package/dist/native/ingest/endpoint.js +30 -0
  124. package/dist/native/ingest/endpoint.js.map +1 -0
  125. package/dist/native/ingest/flushBatch.js +69 -0
  126. package/dist/native/ingest/flushBatch.js.map +1 -0
  127. package/dist/native/ingest/normalizeEvent.js +39 -0
  128. package/dist/native/ingest/normalizeEvent.js.map +1 -0
  129. package/dist/native/ingest/salt.js +14 -0
  130. package/dist/native/ingest/salt.js.map +1 -0
  131. package/dist/native/ingest/source.js +22 -0
  132. package/dist/native/ingest/source.js.map +1 -0
  133. package/dist/native/ingest/visitorHash.js +12 -0
  134. package/dist/native/ingest/visitorHash.js.map +1 -0
  135. package/dist/native/ingest/writeBuffer.js +55 -0
  136. package/dist/native/ingest/writeBuffer.js.map +1 -0
  137. package/dist/native/ingest/writeEvent.js +14 -0
  138. package/dist/native/ingest/writeEvent.js.map +1 -0
  139. package/dist/native/nativeAdapter.d.ts +22 -0
  140. package/dist/native/nativeAdapter.js +216 -0
  141. package/dist/native/nativeAdapter.js.map +1 -0
  142. package/dist/native/realtime/buildRealtime.js +53 -0
  143. package/dist/native/realtime/buildRealtime.js.map +1 -0
  144. package/dist/native/retention/pruneTask.js +29 -0
  145. package/dist/native/retention/pruneTask.js.map +1 -0
  146. package/dist/native/rollupAcc.js +53 -0
  147. package/dist/native/rollupAcc.js.map +1 -0
  148. package/dist/native/rollups/applyDistinctDeltas.js +9 -0
  149. package/dist/native/rollups/applyDistinctDeltas.js.map +1 -0
  150. package/dist/native/rollups/bumpRollup.js +52 -0
  151. package/dist/native/rollups/bumpRollup.js.map +1 -0
  152. package/dist/native/rollups/deltas.js +31 -0
  153. package/dist/native/rollups/deltas.js.map +1 -0
  154. package/dist/native/rollups/insertIfNew.js +19 -0
  155. package/dist/native/rollups/insertIfNew.js.map +1 -0
  156. package/dist/next/posthogProxyRewrites.d.ts +36 -0
  157. package/dist/next/posthogProxyRewrites.js +50 -0
  158. package/dist/next/posthogProxyRewrites.js.map +1 -0
  159. package/dist/plugin/documentEndpoint.js +80 -0
  160. package/dist/plugin/documentEndpoint.js.map +1 -0
  161. package/dist/plugin/paths.js +11 -0
  162. package/dist/plugin/paths.js.map +1 -0
  163. package/dist/plugin/realtimeEndpoint.js +36 -0
  164. package/dist/plugin/realtimeEndpoint.js.map +1 -0
  165. package/dist/plugin/registerTranslations.js +19 -0
  166. package/dist/plugin/registerTranslations.js.map +1 -0
  167. package/dist/plugin/runtime.js +21 -0
  168. package/dist/plugin/runtime.js.map +1 -0
  169. package/dist/plugin/warmTask.js +165 -0
  170. package/dist/plugin/warmTask.js.map +1 -0
  171. package/dist/providers/collection.js +159 -0
  172. package/dist/providers/collection.js.map +1 -0
  173. package/dist/providers/factory.js +62 -0
  174. package/dist/providers/factory.js.map +1 -0
  175. package/dist/providers/resolver.js +67 -0
  176. package/dist/providers/resolver.js.map +1 -0
  177. package/dist/providers/secrets.js +27 -0
  178. package/dist/providers/secrets.js.map +1 -0
  179. package/dist/surfacing/cacheStore.js +26 -0
  180. package/dist/surfacing/cacheStore.js.map +1 -0
  181. package/dist/surfacing/coalesce.js +15 -0
  182. package/dist/surfacing/coalesce.js.map +1 -0
  183. package/dist/surfacing/engine.js +63 -0
  184. package/dist/surfacing/engine.js.map +1 -0
  185. package/dist/surfacing/queue.js +44 -0
  186. package/dist/surfacing/queue.js.map +1 -0
  187. package/dist/sync/collection.js +70 -0
  188. package/dist/sync/collection.js.map +1 -0
  189. package/dist/sync/syncTask.js +123 -0
  190. package/dist/sync/syncTask.js.map +1 -0
  191. package/dist/testing/memoryAdapter.d.ts +1 -1
  192. package/dist/timeframe/presets.d.ts +6 -0
  193. package/dist/timeframe/presets.js +59 -0
  194. package/dist/timeframe/presets.js.map +1 -0
  195. package/dist/timeframe/tz.js +110 -0
  196. package/dist/timeframe/tz.js.map +1 -0
  197. package/dist/translations/de.js +78 -0
  198. package/dist/translations/de.js.map +1 -0
  199. package/dist/{translations-keiKtSjF.js → translations/en.js} +30 -25
  200. package/dist/translations/en.js.map +1 -0
  201. package/dist/translations/index.d.ts +15 -0
  202. package/dist/translations/index.js +30 -0
  203. package/dist/translations/index.js.map +1 -0
  204. package/dist/translations/keys.d.ts +81 -0
  205. package/dist/{keys-DEqL4LOT.js → translations/keys.js} +29 -5
  206. package/dist/translations/keys.js.map +1 -0
  207. package/dist/translations/metricKeys.js +28 -0
  208. package/dist/translations/metricKeys.js.map +1 -0
  209. package/dist/translations/server.js +13 -0
  210. package/dist/translations/server.js.map +1 -0
  211. package/dist/translations/useTranslation.js +12 -0
  212. package/dist/translations/useTranslation.js.map +1 -0
  213. package/dist/widgets/AnalyticsBreakdownWidget.d.ts +7 -0
  214. package/dist/widgets/AnalyticsBreakdownWidget.js +85 -0
  215. package/dist/widgets/AnalyticsBreakdownWidget.js.map +1 -0
  216. package/dist/widgets/AnalyticsMetricWidget.d.ts +7 -0
  217. package/dist/widgets/AnalyticsMetricWidget.js +89 -0
  218. package/dist/widgets/AnalyticsMetricWidget.js.map +1 -0
  219. package/dist/widgets/AnalyticsRealtimeWidget.d.ts +7 -0
  220. package/dist/widgets/AnalyticsRealtimeWidget.js +64 -0
  221. package/dist/widgets/AnalyticsRealtimeWidget.js.map +1 -0
  222. package/dist/widgets/AnalyticsTrendWidget.d.ts +7 -0
  223. package/dist/widgets/AnalyticsTrendWidget.js +99 -0
  224. package/dist/widgets/AnalyticsTrendWidget.js.map +1 -0
  225. package/dist/widgets/ComparisonDelta.js +83 -0
  226. package/dist/widgets/ComparisonDelta.js.map +1 -0
  227. package/dist/widgets/RealtimeCounter.d.ts +19 -0
  228. package/dist/widgets/RealtimeCounter.js +76 -0
  229. package/dist/widgets/RealtimeCounter.js.map +1 -0
  230. package/dist/widgets/breakdownTypes.js +29 -0
  231. package/dist/widgets/breakdownTypes.js.map +1 -0
  232. package/dist/widgets/cardChrome.d.ts +8 -0
  233. package/dist/widgets/cardChrome.js +22 -0
  234. package/dist/widgets/cardChrome.js.map +1 -0
  235. package/dist/widgets/comparison.js +43 -0
  236. package/dist/widgets/comparison.js.map +1 -0
  237. package/dist/widgets/customWidget.d.ts +20 -0
  238. package/dist/widgets/customWidget.js +30 -0
  239. package/dist/widgets/customWidget.js.map +1 -0
  240. package/dist/widgets/defaults.d.ts +12 -0
  241. package/dist/widgets/defaults.js +72 -0
  242. package/dist/widgets/defaults.js.map +1 -0
  243. package/dist/widgets/range.js +28 -0
  244. package/dist/widgets/range.js.map +1 -0
  245. package/dist/widgets/readForWidget.d.ts +31 -0
  246. package/dist/widgets/readForWidget.js +72 -0
  247. package/dist/widgets/readForWidget.js.map +1 -0
  248. package/dist/widgets/readForWidgetBreakdown.d.ts +38 -0
  249. package/dist/widgets/readForWidgetBreakdown.js +80 -0
  250. package/dist/widgets/readForWidgetBreakdown.js.map +1 -0
  251. package/dist/{readForWidgetRealtime-D1BD37ST.d.ts → widgets/readForWidgetRealtime.d.ts} +5 -3
  252. package/dist/widgets/readForWidgetRealtime.js +63 -0
  253. package/dist/widgets/readForWidgetRealtime.js.map +1 -0
  254. package/dist/widgets/readForWidgetSeries.d.ts +44 -0
  255. package/dist/widgets/readForWidgetSeries.js +117 -0
  256. package/dist/widgets/readForWidgetSeries.js.map +1 -0
  257. package/dist/widgets/realtimePoll.js +26 -0
  258. package/dist/widgets/realtimePoll.js.map +1 -0
  259. package/dist/widgets/registerWidgets.js +228 -0
  260. package/dist/widgets/registerWidgets.js.map +1 -0
  261. package/dist/widgets/types.js +13 -0
  262. package/dist/widgets/types.js.map +1 -0
  263. package/package.json +19 -5
  264. package/dist/RealtimeCounter-BJrjMPSa.js +0 -473
  265. package/dist/RealtimeCounter-BJrjMPSa.js.map +0 -1
  266. package/dist/dist-B6HruP5v.js +0 -4731
  267. package/dist/dist-B6HruP5v.js.map +0 -1
  268. package/dist/exports/adapters/ga4.js.map +0 -1
  269. package/dist/exports/adapters/native.js.map +0 -1
  270. package/dist/exports/adapters/plausible.js.map +0 -1
  271. package/dist/exports/adapters/posthog.js.map +0 -1
  272. package/dist/exports/client.js.map +0 -1
  273. package/dist/exports/rsc.js.map +0 -1
  274. package/dist/fetchJson-DZb2_Puj.js.map +0 -1
  275. package/dist/index-CZdCT0WJ.d.ts +0 -98
  276. package/dist/keys-DEqL4LOT.js.map +0 -1
  277. package/dist/lib-CE5x1zLQ.js +0 -1058
  278. package/dist/lib-CE5x1zLQ.js.map +0 -1
  279. package/dist/maxmindResolver-CXYXXdul.js +0 -99
  280. package/dist/maxmindResolver-CXYXXdul.js.map +0 -1
  281. package/dist/presets-CBfq_uJX.d.ts +0 -38
  282. package/dist/series-zytbzPoc.js.map +0 -1
  283. package/dist/server-Cuvhgz-S.js +0 -492
  284. package/dist/server-Cuvhgz-S.js.map +0 -1
  285. package/dist/translations-keiKtSjF.js.map +0 -1
@@ -0,0 +1,22 @@
1
+ //#region src/fields/format.ts
2
+ const formatDuration = (ms) => {
3
+ const totalSeconds = Math.round(ms / 1e3);
4
+ if (totalSeconds < 60) return `${totalSeconds}s`;
5
+ const minutes = Math.floor(totalSeconds / 60);
6
+ const seconds = totalSeconds % 60;
7
+ if (minutes < 60) return seconds === 0 ? `${minutes}m` : `${minutes}m ${seconds}s`;
8
+ const hours = Math.floor(minutes / 60);
9
+ const remMinutes = minutes % 60;
10
+ return remMinutes === 0 ? `${hours}h` : `${hours}h ${remMinutes}m`;
11
+ };
12
+ const formatCount = (value, locale) => new Intl.NumberFormat(locale).format(value);
13
+ const PERCENT_METRICS = new Set(["bounceRate", "scrollDepth"]);
14
+ const formatMetricValue = (metric, value, locale) => {
15
+ if (metric === "avgDuration") return formatDuration(value);
16
+ if (PERCENT_METRICS.has(metric)) return `${Math.round(value)}%`;
17
+ return formatCount(value, locale);
18
+ };
19
+ //#endregion
20
+ export { formatMetricValue };
21
+
22
+ //# sourceMappingURL=format.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"format.js","names":[],"sources":["../../src/fields/format.ts"],"sourcesContent":["import type { MetricKey } from '../core/contract'\n\nexport const formatDuration = (ms: number): string => {\n\tconst totalSeconds = Math.round(ms / 1000)\n\tif (totalSeconds < 60) return `${totalSeconds}s`\n\tconst minutes = Math.floor(totalSeconds / 60)\n\tconst seconds = totalSeconds % 60\n\tif (minutes < 60) return seconds === 0 ? `${minutes}m` : `${minutes}m ${seconds}s`\n\tconst hours = Math.floor(minutes / 60)\n\tconst remMinutes = minutes % 60\n\treturn remMinutes === 0 ? `${hours}h` : `${hours}h ${remMinutes}m`\n}\n\nexport const formatCount = (value: number, locale: string): string =>\n\tnew Intl.NumberFormat(locale).format(value)\n\nconst PERCENT_METRICS: ReadonlySet<MetricKey> = new Set(['bounceRate', 'scrollDepth'])\n\nexport const formatMetricValue = (metric: MetricKey, value: number, locale: string): string => {\n\tif (metric === 'avgDuration') return formatDuration(value)\n\tif (PERCENT_METRICS.has(metric)) return `${Math.round(value)}%`\n\treturn formatCount(value, locale)\n}\n"],"mappings":";AAEA,MAAa,kBAAkB,OAAuB;CACrD,MAAM,eAAe,KAAK,MAAM,KAAK,GAAI;CACzC,IAAI,eAAe,IAAI,OAAO,GAAG,aAAa;CAC9C,MAAM,UAAU,KAAK,MAAM,eAAe,EAAE;CAC5C,MAAM,UAAU,eAAe;CAC/B,IAAI,UAAU,IAAI,OAAO,YAAY,IAAI,GAAG,QAAQ,KAAK,GAAG,QAAQ,IAAI,QAAQ;CAChF,MAAM,QAAQ,KAAK,MAAM,UAAU,EAAE;CACrC,MAAM,aAAa,UAAU;CAC7B,OAAO,eAAe,IAAI,GAAG,MAAM,KAAK,GAAG,MAAM,IAAI,WAAW;AACjE;AAEA,MAAa,eAAe,OAAe,WAC1C,IAAI,KAAK,aAAa,MAAM,EAAE,OAAO,KAAK;AAE3C,MAAM,kBAA0C,IAAI,IAAI,CAAC,cAAc,aAAa,CAAC;AAErF,MAAa,qBAAqB,QAAmB,OAAe,WAA2B;CAC9F,IAAI,WAAW,eAAe,OAAO,eAAe,KAAK;CACzD,IAAI,gBAAgB,IAAI,MAAM,GAAG,OAAO,GAAG,KAAK,MAAM,KAAK,EAAE;CAC7D,OAAO,YAAY,OAAO,MAAM;AACjC"}
@@ -0,0 +1,57 @@
1
+ import { DateRange, MetricKey } from "../core/contract.js";
2
+ import { BindingDoc } from "../binding/types.js";
3
+ import { TimeframePreset } from "../timeframe/presets.js";
4
+ import { SeriesPoint } from "../widgets/readForWidgetSeries.js";
5
+ import { PayloadRequest } from "payload";
6
+
7
+ //#region src/fields/readForDocument.d.ts
8
+ type FieldReadStatus = 'ok' | 'no-path' | 'not-bound' | 'not-configured' | 'unavailable';
9
+ interface FieldReadResult {
10
+ status: FieldReadStatus;
11
+ adapterId: string;
12
+ dateRange: DateRange;
13
+ /** The reporting timezone the read resolved in; the trend axis buckets in it. */
14
+ timezone: string;
15
+ metrics: Partial<Record<MetricKey, number>>;
16
+ /** Requested metrics the adapter supports, in request order; the set actually read. */
17
+ supportedMetrics: MetricKey[];
18
+ /** Requested metrics the adapter cannot serve, dropped from the read. */
19
+ droppedMetrics: MetricKey[];
20
+ /** Previous-window totals, present only when comparison was requested and supported. */
21
+ previousMetrics?: Partial<Record<MetricKey, number>>;
22
+ /** The previous comparable window, present only when comparison ran. */
23
+ comparisonRange?: DateRange;
24
+ /** Per-day series for the first supported metric, present only when requested. */
25
+ points?: SeriesPoint[];
26
+ }
27
+ interface ReadForFieldArgs {
28
+ req: PayloadRequest;
29
+ collectionSlug: string;
30
+ data: BindingDoc;
31
+ metrics: MetricKey[];
32
+ timeframe: TimeframePreset;
33
+ /** Overrides the preset window (custom range). */
34
+ range?: DateRange;
35
+ adapterId?: string;
36
+ now: Date;
37
+ /** Explicit scope override; omitted resolves via the plugin's scopeResolver. */
38
+ scope?: string | null;
39
+ /** Also read the previous comparable window when the adapter supports comparison. */
40
+ compare?: boolean;
41
+ /** Also read a daily series for the first supported metric when the adapter can. */
42
+ series?: boolean;
43
+ }
44
+ /**
45
+ * Resolve a document's analytics for one display field: look up the runtime, resolve
46
+ * the bound path, capability-gate the requested metrics against the active adapter,
47
+ * then read through the surfacing engine. Returns a discriminated status so the
48
+ * rendering component can show the right empty state without throwing.
49
+ *
50
+ * A metric the adapter does not support is dropped (with one warning per field
51
+ * render), not fatal; `unavailable` is returned only when no requested metric
52
+ * survives or the adapter cannot query per page at all.
53
+ */
54
+ declare const readForField: (args: ReadForFieldArgs) => Promise<FieldReadResult>;
55
+ //#endregion
56
+ export { FieldReadResult, FieldReadStatus, ReadForFieldArgs, readForField };
57
+ //# sourceMappingURL=readForDocument.d.ts.map
@@ -0,0 +1,147 @@
1
+ import { resolveHostname, resolvePathCached } from "../binding/resolvePath.js";
2
+ import { satisfiesCapabilities } from "../core/capabilities.js";
3
+ import { supportsGranularity } from "../core/granularity.js";
4
+ import { getRuntime, resolveTimezoneFor } from "../plugin/runtime.js";
5
+ import { resolveReadContext } from "../core/scopedRead.js";
6
+ import { resolveTimeframe } from "../timeframe/presets.js";
7
+ import { previousWindow } from "../widgets/comparison.js";
8
+ import { fillDailySeries } from "../widgets/readForWidgetSeries.js";
9
+ //#region src/fields/readForDocument.ts
10
+ /**
11
+ * Resolve a document's analytics for one display field: look up the runtime, resolve
12
+ * the bound path, capability-gate the requested metrics against the active adapter,
13
+ * then read through the surfacing engine. Returns a discriminated status so the
14
+ * rendering component can show the right empty state without throwing.
15
+ *
16
+ * A metric the adapter does not support is dropped (with one warning per field
17
+ * render), not fatal; `unavailable` is returned only when no requested metric
18
+ * survives or the adapter cannot query per page at all.
19
+ */
20
+ const readForField = async (args) => {
21
+ const { req, collectionSlug, data, metrics, timeframe, range, adapterId, now } = args;
22
+ let dateRange = range ?? resolveTimeframe(timeframe, now);
23
+ const empty = {
24
+ metrics: {},
25
+ supportedMetrics: [],
26
+ droppedMetrics: []
27
+ };
28
+ const runtime = getRuntime(req.payload);
29
+ if (!runtime) return {
30
+ status: "not-bound",
31
+ adapterId: adapterId ?? "",
32
+ dateRange,
33
+ timezone: "UTC",
34
+ ...empty
35
+ };
36
+ const binding = runtime.bindings[collectionSlug];
37
+ if (!binding) return {
38
+ status: "not-bound",
39
+ adapterId: adapterId ?? "",
40
+ dateRange,
41
+ timezone: "UTC",
42
+ ...empty
43
+ };
44
+ const ctx = await resolveReadContext({
45
+ runtime,
46
+ req,
47
+ adapterId,
48
+ scope: args.scope
49
+ });
50
+ if (!ctx.ok) return {
51
+ status: "unavailable",
52
+ adapterId: adapterId ?? "",
53
+ dateRange,
54
+ timezone: "UTC",
55
+ ...empty
56
+ };
57
+ const tz = await resolveTimezoneFor(runtime, req, ctx.scope);
58
+ dateRange = range ?? resolveTimeframe(timeframe, now, tz);
59
+ const adapter = ctx.adapter;
60
+ const bindingCtx = {
61
+ req,
62
+ locale: req.locale ?? void 0
63
+ };
64
+ let path;
65
+ try {
66
+ path = await resolvePathCached(binding, data, bindingCtx);
67
+ } catch {
68
+ path = null;
69
+ }
70
+ if (!path) return {
71
+ status: "no-path",
72
+ adapterId: adapter.id,
73
+ dateRange,
74
+ timezone: tz,
75
+ ...empty
76
+ };
77
+ if (!adapter.isConfigured()) return {
78
+ status: "not-configured",
79
+ adapterId: adapter.id,
80
+ dateRange,
81
+ timezone: tz,
82
+ ...empty
83
+ };
84
+ const supportedMetrics = metrics.filter((m) => adapter.capabilities.metrics.has(m));
85
+ const droppedMetrics = metrics.filter((m) => !adapter.capabilities.metrics.has(m));
86
+ if (droppedMetrics.length > 0) req.payload.logger.warn(`analytics: adapter "${adapter.id}" does not support metric(s) ${droppedMetrics.join(", ")}; dropped from the "${collectionSlug}" display field`);
87
+ if (supportedMetrics.length === 0 || !satisfiesCapabilities(adapter.capabilities, {
88
+ metrics: supportedMetrics,
89
+ perPageQuery: true
90
+ })) return {
91
+ status: "unavailable",
92
+ adapterId: adapter.id,
93
+ dateRange,
94
+ timezone: tz,
95
+ metrics: {},
96
+ supportedMetrics: [],
97
+ droppedMetrics: metrics
98
+ };
99
+ const hostname = await resolveHostname(binding, data, bindingCtx);
100
+ const base = {
101
+ path,
102
+ hostname,
103
+ timezone: tz,
104
+ scope: ctx.queryScope
105
+ };
106
+ const comparisonRange = args.compare && runtime.comparison && adapter.capabilities.comparison ? previousWindow(dateRange, tz) ?? void 0 : void 0;
107
+ const wantsSeries = args.series && supportsGranularity(adapter.capabilities, "day");
108
+ const [result, previous, seriesResult] = await Promise.all([
109
+ runtime.engine.read(adapter, {
110
+ ...base,
111
+ metrics: supportedMetrics,
112
+ dateRange
113
+ }),
114
+ comparisonRange ? runtime.engine.read(adapter, {
115
+ ...base,
116
+ metrics: supportedMetrics,
117
+ dateRange: comparisonRange
118
+ }) : void 0,
119
+ wantsSeries ? runtime.engine.read(adapter, {
120
+ ...base,
121
+ metrics: [supportedMetrics[0]],
122
+ dateRange,
123
+ granularity: "day"
124
+ }) : void 0
125
+ ]);
126
+ return {
127
+ status: "ok",
128
+ adapterId: adapter.id,
129
+ dateRange,
130
+ timezone: tz,
131
+ metrics: result.totals ?? {},
132
+ supportedMetrics,
133
+ droppedMetrics,
134
+ previousMetrics: previous ? previous.totals ?? {} : void 0,
135
+ comparisonRange,
136
+ points: seriesResult ? fillDailySeries({
137
+ rows: seriesResult.rows,
138
+ dateRange,
139
+ metric: supportedMetrics[0],
140
+ tz
141
+ }) : void 0
142
+ };
143
+ };
144
+ //#endregion
145
+ export { readForField };
146
+
147
+ //# sourceMappingURL=readForDocument.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"readForDocument.js","names":[],"sources":["../../src/fields/readForDocument.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\nimport { resolveHostname, resolvePathCached } from '../binding/resolvePath'\nimport type { BindingDoc } from '../binding/types'\nimport { satisfiesCapabilities } from '../core/capabilities'\nimport type { AnalyticsAdapter, DateRange, MetricKey } from '../core/contract'\nimport { supportsGranularity } from '../core/granularity'\nimport { resolveReadContext } from '../core/scopedRead'\nimport { getRuntime, resolveTimezoneFor } from '../plugin/runtime'\nimport { resolveTimeframe, type TimeframePreset } from '../timeframe/presets'\nimport { DEFAULT_TIMEZONE } from '../timeframe/tz'\nimport { previousWindow } from '../widgets/comparison'\nimport { fillDailySeries, type SeriesPoint } from '../widgets/readForWidgetSeries'\n\nexport type FieldReadStatus = 'ok' | 'no-path' | 'not-bound' | 'not-configured' | 'unavailable'\n\nexport interface FieldReadResult {\n\tstatus: FieldReadStatus\n\tadapterId: string\n\tdateRange: DateRange\n\t/** The reporting timezone the read resolved in; the trend axis buckets in it. */\n\ttimezone: string\n\tmetrics: Partial<Record<MetricKey, number>>\n\t/** Requested metrics the adapter supports, in request order; the set actually read. */\n\tsupportedMetrics: MetricKey[]\n\t/** Requested metrics the adapter cannot serve, dropped from the read. */\n\tdroppedMetrics: MetricKey[]\n\t/** Previous-window totals, present only when comparison was requested and supported. */\n\tpreviousMetrics?: Partial<Record<MetricKey, number>>\n\t/** The previous comparable window, present only when comparison ran. */\n\tcomparisonRange?: DateRange\n\t/** Per-day series for the first supported metric, present only when requested. */\n\tpoints?: SeriesPoint[]\n}\n\nexport interface ReadForFieldArgs {\n\treq: PayloadRequest\n\tcollectionSlug: string\n\tdata: BindingDoc\n\tmetrics: MetricKey[]\n\ttimeframe: TimeframePreset\n\t/** Overrides the preset window (custom range). */\n\trange?: DateRange\n\tadapterId?: string\n\tnow: Date\n\t/** Explicit scope override; omitted resolves via the plugin's scopeResolver. */\n\tscope?: string | null\n\t/** Also read the previous comparable window when the adapter supports comparison. */\n\tcompare?: boolean\n\t/** Also read a daily series for the first supported metric when the adapter can. */\n\tseries?: boolean\n}\n\n/**\n * Resolve a document's analytics for one display field: look up the runtime, resolve\n * the bound path, capability-gate the requested metrics against the active adapter,\n * then read through the surfacing engine. Returns a discriminated status so the\n * rendering component can show the right empty state without throwing.\n *\n * A metric the adapter does not support is dropped (with one warning per field\n * render), not fatal; `unavailable` is returned only when no requested metric\n * survives or the adapter cannot query per page at all.\n */\nexport const readForField = async (args: ReadForFieldArgs): Promise<FieldReadResult> => {\n\tconst { req, collectionSlug, data, metrics, timeframe, range, adapterId, now } = args\n\tlet dateRange = range ?? resolveTimeframe(timeframe, now)\n\tconst empty = { metrics: {}, supportedMetrics: [], droppedMetrics: [] }\n\tconst runtime = getRuntime(req.payload)\n\tif (!runtime) {\n\t\treturn {\n\t\t\tstatus: 'not-bound',\n\t\t\tadapterId: adapterId ?? '',\n\t\t\tdateRange,\n\t\t\ttimezone: DEFAULT_TIMEZONE,\n\t\t\t...empty,\n\t\t}\n\t}\n\tconst binding = runtime.bindings[collectionSlug]\n\tif (!binding) {\n\t\treturn {\n\t\t\tstatus: 'not-bound',\n\t\t\tadapterId: adapterId ?? '',\n\t\t\tdateRange,\n\t\t\ttimezone: DEFAULT_TIMEZONE,\n\t\t\t...empty,\n\t\t}\n\t}\n\tconst ctx = await resolveReadContext({ runtime, req, adapterId, scope: args.scope })\n\tif (!ctx.ok) {\n\t\treturn {\n\t\t\tstatus: 'unavailable',\n\t\t\tadapterId: adapterId ?? '',\n\t\t\tdateRange,\n\t\t\ttimezone: DEFAULT_TIMEZONE,\n\t\t\t...empty,\n\t\t}\n\t}\n\tconst tz = await resolveTimezoneFor(runtime, req, ctx.scope)\n\tdateRange = range ?? resolveTimeframe(timeframe, now, tz)\n\tconst adapter: AnalyticsAdapter = ctx.adapter\n\tconst bindingCtx = { req, locale: req.locale ?? undefined }\n\tlet path: string | null\n\ttry {\n\t\tpath = await resolvePathCached(binding, data, bindingCtx)\n\t} catch {\n\t\tpath = null\n\t}\n\tif (!path) {\n\t\treturn { status: 'no-path', adapterId: adapter.id, dateRange, timezone: tz, ...empty }\n\t}\n\tif (!adapter.isConfigured()) {\n\t\treturn { status: 'not-configured', adapterId: adapter.id, dateRange, timezone: tz, ...empty }\n\t}\n\tconst supportedMetrics = metrics.filter((m) => adapter.capabilities.metrics.has(m))\n\tconst droppedMetrics = metrics.filter((m) => !adapter.capabilities.metrics.has(m))\n\tif (droppedMetrics.length > 0) {\n\t\treq.payload.logger.warn(\n\t\t\t`analytics: adapter \"${adapter.id}\" does not support metric(s) ${droppedMetrics.join(', ')}; dropped from the \"${collectionSlug}\" display field`\n\t\t)\n\t}\n\tif (\n\t\tsupportedMetrics.length === 0 ||\n\t\t!satisfiesCapabilities(adapter.capabilities, { metrics: supportedMetrics, perPageQuery: true })\n\t) {\n\t\treturn {\n\t\t\tstatus: 'unavailable',\n\t\t\tadapterId: adapter.id,\n\t\t\tdateRange,\n\t\t\ttimezone: tz,\n\t\t\tmetrics: {},\n\t\t\tsupportedMetrics: [],\n\t\t\tdroppedMetrics: metrics,\n\t\t}\n\t}\n\tconst hostname = await resolveHostname(binding, data, bindingCtx)\n\tconst base = { path, hostname, timezone: tz, scope: ctx.queryScope }\n\tconst comparisonRange =\n\t\targs.compare && runtime.comparison && adapter.capabilities.comparison\n\t\t\t? (previousWindow(dateRange, tz) ?? undefined)\n\t\t\t: undefined\n\tconst wantsSeries = args.series && supportsGranularity(adapter.capabilities, 'day')\n\tconst [result, previous, seriesResult] = await Promise.all([\n\t\truntime.engine.read(adapter, { ...base, metrics: supportedMetrics, dateRange }),\n\t\tcomparisonRange\n\t\t\t? runtime.engine.read(adapter, {\n\t\t\t\t\t...base,\n\t\t\t\t\tmetrics: supportedMetrics,\n\t\t\t\t\tdateRange: comparisonRange,\n\t\t\t\t})\n\t\t\t: undefined,\n\t\twantsSeries\n\t\t\t? runtime.engine.read(adapter, {\n\t\t\t\t\t...base,\n\t\t\t\t\tmetrics: [supportedMetrics[0] as MetricKey],\n\t\t\t\t\tdateRange,\n\t\t\t\t\tgranularity: 'day',\n\t\t\t\t})\n\t\t\t: undefined,\n\t])\n\treturn {\n\t\tstatus: 'ok',\n\t\tadapterId: adapter.id,\n\t\tdateRange,\n\t\ttimezone: tz,\n\t\tmetrics: result.totals ?? {},\n\t\tsupportedMetrics,\n\t\tdroppedMetrics,\n\t\tpreviousMetrics: previous ? (previous.totals ?? {}) : undefined,\n\t\tcomparisonRange,\n\t\tpoints: seriesResult\n\t\t\t? fillDailySeries({\n\t\t\t\t\trows: seriesResult.rows,\n\t\t\t\t\tdateRange,\n\t\t\t\t\tmetric: supportedMetrics[0] as MetricKey,\n\t\t\t\t\ttz,\n\t\t\t\t})\n\t\t\t: undefined,\n\t}\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AA8DA,MAAa,eAAe,OAAO,SAAqD;CACvF,MAAM,EAAE,KAAK,gBAAgB,MAAM,SAAS,WAAW,OAAO,WAAW,QAAQ;CACjF,IAAI,YAAY,SAAS,iBAAiB,WAAW,GAAG;CACxD,MAAM,QAAQ;EAAE,SAAS,CAAC;EAAG,kBAAkB,CAAC;EAAG,gBAAgB,CAAC;CAAE;CACtE,MAAM,UAAU,WAAW,IAAI,OAAO;CACtC,IAAI,CAAC,SACJ,OAAO;EACN,QAAQ;EACR,WAAW,aAAa;EACxB;EACA,UAAA;EACA,GAAG;CACJ;CAED,MAAM,UAAU,QAAQ,SAAS;CACjC,IAAI,CAAC,SACJ,OAAO;EACN,QAAQ;EACR,WAAW,aAAa;EACxB;EACA,UAAA;EACA,GAAG;CACJ;CAED,MAAM,MAAM,MAAM,mBAAmB;EAAE;EAAS;EAAK;EAAW,OAAO,KAAK;CAAM,CAAC;CACnF,IAAI,CAAC,IAAI,IACR,OAAO;EACN,QAAQ;EACR,WAAW,aAAa;EACxB;EACA,UAAA;EACA,GAAG;CACJ;CAED,MAAM,KAAK,MAAM,mBAAmB,SAAS,KAAK,IAAI,KAAK;CAC3D,YAAY,SAAS,iBAAiB,WAAW,KAAK,EAAE;CACxD,MAAM,UAA4B,IAAI;CACtC,MAAM,aAAa;EAAE;EAAK,QAAQ,IAAI,UAAU,KAAA;CAAU;CAC1D,IAAI;CACJ,IAAI;EACH,OAAO,MAAM,kBAAkB,SAAS,MAAM,UAAU;CACzD,QAAQ;EACP,OAAO;CACR;CACA,IAAI,CAAC,MACJ,OAAO;EAAE,QAAQ;EAAW,WAAW,QAAQ;EAAI;EAAW,UAAU;EAAI,GAAG;CAAM;CAEtF,IAAI,CAAC,QAAQ,aAAa,GACzB,OAAO;EAAE,QAAQ;EAAkB,WAAW,QAAQ;EAAI;EAAW,UAAU;EAAI,GAAG;CAAM;CAE7F,MAAM,mBAAmB,QAAQ,QAAQ,MAAM,QAAQ,aAAa,QAAQ,IAAI,CAAC,CAAC;CAClF,MAAM,iBAAiB,QAAQ,QAAQ,MAAM,CAAC,QAAQ,aAAa,QAAQ,IAAI,CAAC,CAAC;CACjF,IAAI,eAAe,SAAS,GAC3B,IAAI,QAAQ,OAAO,KAClB,uBAAuB,QAAQ,GAAG,+BAA+B,eAAe,KAAK,IAAI,EAAE,sBAAsB,eAAe,gBACjI;CAED,IACC,iBAAiB,WAAW,KAC5B,CAAC,sBAAsB,QAAQ,cAAc;EAAE,SAAS;EAAkB,cAAc;CAAK,CAAC,GAE9F,OAAO;EACN,QAAQ;EACR,WAAW,QAAQ;EACnB;EACA,UAAU;EACV,SAAS,CAAC;EACV,kBAAkB,CAAC;EACnB,gBAAgB;CACjB;CAED,MAAM,WAAW,MAAM,gBAAgB,SAAS,MAAM,UAAU;CAChE,MAAM,OAAO;EAAE;EAAM;EAAU,UAAU;EAAI,OAAO,IAAI;CAAW;CACnE,MAAM,kBACL,KAAK,WAAW,QAAQ,cAAc,QAAQ,aAAa,aACvD,eAAe,WAAW,EAAE,KAAK,KAAA,IAClC,KAAA;CACJ,MAAM,cAAc,KAAK,UAAU,oBAAoB,QAAQ,cAAc,KAAK;CAClF,MAAM,CAAC,QAAQ,UAAU,gBAAgB,MAAM,QAAQ,IAAI;EAC1D,QAAQ,OAAO,KAAK,SAAS;GAAE,GAAG;GAAM,SAAS;GAAkB;EAAU,CAAC;EAC9E,kBACG,QAAQ,OAAO,KAAK,SAAS;GAC7B,GAAG;GACH,SAAS;GACT,WAAW;EACZ,CAAC,IACA,KAAA;EACH,cACG,QAAQ,OAAO,KAAK,SAAS;GAC7B,GAAG;GACH,SAAS,CAAC,iBAAiB,EAAe;GAC1C;GACA,aAAa;EACd,CAAC,IACA,KAAA;CACJ,CAAC;CACD,OAAO;EACN,QAAQ;EACR,WAAW,QAAQ;EACnB;EACA,UAAU;EACV,SAAS,OAAO,UAAU,CAAC;EAC3B;EACA;EACA,iBAAiB,WAAY,SAAS,UAAU,CAAC,IAAK,KAAA;EACtD;EACA,QAAQ,eACL,gBAAgB;GAChB,MAAM,aAAa;GACnB;GACA,QAAQ,iBAAiB;GACzB;EACD,CAAC,IACA,KAAA;CACJ;AACD"}
package/dist/index.d.ts CHANGED
@@ -1,3 +1,18 @@
1
- import { a as HostnameResolver, n as AnalyticsBinding, o as PathResolver, r as BindingContext, t as TimeframePreset } from "./presets-CBfq_uJX.js";
2
- import { a as AnalyticsFieldsOptions, c as AnalyticsTabOptions, d as analyticsStatRow, f as analyticsTab, i as CustomWidgetDef, l as analyticsFields, n as analyticsDefaultWidgets, o as AnalyticsStatOptions, r as AnalyticsPluginOptions, s as AnalyticsStatRowOptions, t as analytics, u as analyticsStat } from "./index-CZdCT0WJ.js";
3
- export { type AnalyticsBinding, type AnalyticsFieldsOptions, type AnalyticsPluginOptions, type AnalyticsPluginOptions as PluginOptions, type AnalyticsStatOptions, type AnalyticsStatRowOptions, type AnalyticsTabOptions, type BindingContext, type CustomWidgetDef, type HostnameResolver, type PathResolver, type TimeframePreset, analytics, analyticsDefaultWidgets, analyticsFields, analyticsStat, analyticsStatRow, analyticsTab };
1
+ import { PLATFORM_SCOPE } from "./core/contract.js";
2
+ import { AnalyticsBinding, BindingContext, HostnameResolver, PathResolver } from "./binding/types.js";
3
+ import { TimeframePreset } from "./timeframe/presets.js";
4
+ import { AnalyticsFieldsOptions, AnalyticsMetricLabel, AnalyticsMetricLabels, AnalyticsStatOptions, AnalyticsStatRowOptions, AnalyticsTabOptions, analyticsFields, analyticsStat, analyticsStatRow, analyticsTab, analyticsTabsField } from "./fields/factories.js";
5
+ import { CustomWidgetDef } from "./widgets/customWidget.js";
6
+ import { AnalyticsAccessOptions, AnalyticsPluginOptions, PlatformReadAccess, ProvidersCollectionOptions, ProvidersOptions, ProvidersResolve, ScopeResolver, TimezoneResolver } from "./core/options.js";
7
+ import { analyticsDefaultWidgets } from "./widgets/defaults.js";
8
+
9
+ //#region src/index.d.ts
10
+ declare module 'payload' {
11
+ interface RegisteredPlugins {
12
+ '@10x-media/analytics': AnalyticsPluginOptions;
13
+ }
14
+ }
15
+ declare const analytics: (options: AnalyticsPluginOptions) => import("payload").Plugin;
16
+ //#endregion
17
+ export { type AnalyticsAccessOptions, type AnalyticsBinding, type AnalyticsFieldsOptions, type AnalyticsMetricLabel, type AnalyticsMetricLabels, type AnalyticsPluginOptions, type AnalyticsStatOptions, type AnalyticsStatRowOptions, type AnalyticsTabOptions, type BindingContext, type CustomWidgetDef, type HostnameResolver, PLATFORM_SCOPE, type PathResolver, type PlatformReadAccess, type AnalyticsPluginOptions as PluginOptions, type ProvidersCollectionOptions, type ProvidersOptions, type ProvidersResolve, type ScopeResolver, type TimeframePreset, type TimezoneResolver, analytics, analyticsDefaultWidgets, analyticsFields, analyticsStat, analyticsStatRow, analyticsTab, analyticsTabsField };
18
+ //# sourceMappingURL=index.d.ts.map