@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,187 @@
1
+ import { dayIso } from "../series.js";
2
+ //#region src/adapters/ga4/ga4.ts
3
+ const METRIC_MAP = {
4
+ pageviews: "screenPageViews",
5
+ visitors: "totalUsers",
6
+ visits: "sessions",
7
+ sessions: "sessions",
8
+ bounceRate: "bounceRate",
9
+ avgDuration: "averageSessionDuration",
10
+ events: "eventCount",
11
+ conversions: "keyEvents",
12
+ revenue: "totalRevenue"
13
+ };
14
+ const DIMENSION_MAP = {
15
+ page: "pagePath",
16
+ referrer: "pageReferrer",
17
+ source: "sessionSource",
18
+ medium: "sessionMedium",
19
+ campaign: "sessionCampaignName",
20
+ utmSource: "sessionSource",
21
+ utmMedium: "sessionMedium",
22
+ utmCampaign: "sessionCampaignName",
23
+ device: "deviceCategory",
24
+ browser: "browser",
25
+ os: "operatingSystem",
26
+ country: "countryId",
27
+ region: "region",
28
+ city: "city",
29
+ language: "language",
30
+ event: "eventName"
31
+ };
32
+ const ga4Metrics = new Set(Object.keys(METRIC_MAP));
33
+ const ga4Dimensions = new Set(Object.keys(DIMENSION_MAP));
34
+ const toContractValue = (metric, raw) => {
35
+ if (metric === "avgDuration") return Math.round(raw * 1e3);
36
+ if (metric === "bounceRate") return Math.round(raw * 100);
37
+ return raw;
38
+ };
39
+ function ga4(config) {
40
+ const capabilities = {
41
+ perPageQuery: true,
42
+ realtime: false,
43
+ comparison: false,
44
+ minGranularity: "day",
45
+ maxLookbackDays: config.maxLookbackDays !== void 0 ? config.maxLookbackDays : 425,
46
+ metrics: ga4Metrics,
47
+ dimensions: ga4Dimensions,
48
+ batchPageReport: true,
49
+ rateLimit: {
50
+ maxConcurrent: 10,
51
+ quotaModel: "tokens",
52
+ readsCountAsUsage: true
53
+ },
54
+ recommendedTtl: {
55
+ realtime: 300,
56
+ aggregate: 21600
57
+ }
58
+ };
59
+ let clientPromise;
60
+ const getClient = () => {
61
+ if (!clientPromise) clientPromise = (async () => {
62
+ let mod;
63
+ try {
64
+ mod = await import("@google-analytics/data");
65
+ } catch {
66
+ throw new Error("@10x-media/analytics: the GA4 adapter requires the optional peer dependency \"@google-analytics/data\". Install it with: pnpm add @google-analytics/data");
67
+ }
68
+ return new mod.BetaAnalyticsDataClient({
69
+ credentials: config.credentials,
70
+ projectId: config.projectId
71
+ });
72
+ })();
73
+ return clientPromise;
74
+ };
75
+ return {
76
+ id: "ga4",
77
+ label: "Google Analytics 4",
78
+ capabilities,
79
+ isConfigured: () => Boolean(config.propertyId && config.credentials?.client_email && config.credentials?.private_key),
80
+ async query(q, _ctx) {
81
+ const fetchedAt = q.dateRange.end.toISOString();
82
+ const wanted = q.metrics.filter((m) => METRIC_MAP[m]);
83
+ const providerMetrics = [...new Set(wanted.map((m) => METRIC_MAP[m]))];
84
+ const dims = (q.dimensions ?? []).filter((d) => DIMENSION_MAP[d]);
85
+ const providerDims = [...new Set(dims.map((d) => DIMENSION_MAP[d]))];
86
+ const readRow = (row) => {
87
+ const out = {};
88
+ for (const m of wanted) {
89
+ const idx = providerMetrics.indexOf(METRIC_MAP[m]);
90
+ out[m] = toContractValue(m, Number(row.metricValues?.[idx]?.value ?? 0));
91
+ }
92
+ return out;
93
+ };
94
+ const filterExprs = [];
95
+ if (q.path) filterExprs.push({ filter: {
96
+ fieldName: "pagePath",
97
+ stringFilter: {
98
+ matchType: "EXACT",
99
+ value: q.path
100
+ }
101
+ } });
102
+ if (q.hostname) filterExprs.push({ filter: {
103
+ fieldName: "hostName",
104
+ stringFilter: {
105
+ matchType: "EXACT",
106
+ value: q.hostname
107
+ }
108
+ } });
109
+ const dimensionFilter = filterExprs.length === 0 ? void 0 : filterExprs.length === 1 ? filterExprs[0] : { andGroup: { expressions: filterExprs } };
110
+ const baseRequest = {
111
+ property: `properties/${config.propertyId}`,
112
+ dateRanges: [{
113
+ startDate: q.dateRange.start.toISOString().slice(0, 10),
114
+ endDate: q.dateRange.end.toISOString().slice(0, 10)
115
+ }],
116
+ metrics: providerMetrics.map((name) => ({ name })),
117
+ ...dimensionFilter ? { dimensionFilter } : {}
118
+ };
119
+ const client = await getClient();
120
+ if (q.granularity === "day" && !dims.length) {
121
+ const [response] = await client.runReport({
122
+ ...baseRequest,
123
+ dimensions: [{ name: "date" }],
124
+ metricAggregations: ["TOTAL"],
125
+ orderBys: [{ dimension: { dimensionName: "date" } }]
126
+ });
127
+ const rows = [];
128
+ for (const row of response.rows ?? []) {
129
+ const ymd = row.dimensionValues?.[0]?.value ?? "";
130
+ const ts = dayIso(`${ymd.slice(0, 4)}-${ymd.slice(4, 6)}-${ymd.slice(6, 8)}`);
131
+ if (ts) rows.push({
132
+ timestamp: ts,
133
+ metrics: readRow(row)
134
+ });
135
+ }
136
+ const totalsRow = response.totals?.[0];
137
+ return {
138
+ rows,
139
+ totals: totalsRow ? readRow(totalsRow) : {},
140
+ meta: {
141
+ provider: "ga4",
142
+ fetchedAt
143
+ }
144
+ };
145
+ }
146
+ const [response] = await client.runReport({
147
+ ...baseRequest,
148
+ ...providerDims.length ? { dimensions: providerDims.map((name) => ({ name })) } : {},
149
+ ...q.limit ? { limit: q.limit } : {}
150
+ });
151
+ if (!dims.length) {
152
+ const row = response.rows?.[0];
153
+ const totals = row ? readRow(row) : {};
154
+ return {
155
+ rows: [{ metrics: totals }],
156
+ totals,
157
+ meta: {
158
+ provider: "ga4",
159
+ fetchedAt
160
+ }
161
+ };
162
+ }
163
+ return {
164
+ rows: (response.rows ?? []).map((row) => {
165
+ const dimValues = {};
166
+ for (const d of dims) {
167
+ const idx = providerDims.indexOf(DIMENSION_MAP[d]);
168
+ dimValues[d] = row.dimensionValues?.[idx]?.value ?? "";
169
+ }
170
+ return {
171
+ dimensions: dimValues,
172
+ metrics: readRow(row)
173
+ };
174
+ }),
175
+ totals: void 0,
176
+ meta: {
177
+ provider: "ga4",
178
+ fetchedAt
179
+ }
180
+ };
181
+ }
182
+ };
183
+ }
184
+ //#endregion
185
+ export { ga4 };
186
+
187
+ //# sourceMappingURL=ga4.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ga4.js","names":[],"sources":["../../../src/adapters/ga4/ga4.ts"],"sourcesContent":["import type { BetaAnalyticsDataClient, protos } from '@google-analytics/data'\nimport type {\n\tAdapterContext,\n\tAnalyticsAdapter,\n\tAnalyticsCapabilities,\n\tAnalyticsQuery,\n\tAnalyticsResult,\n\tAnalyticsRow,\n\tDimensionKey,\n\tMetricKey,\n} from '../../core/contract'\nimport { dayIso } from '../series'\n\nexport interface Ga4Config {\n\t/** GA4 property id (numeric), e.g. '123456789'. */\n\tpropertyId: string\n\t/** Service-account credentials. */\n\tcredentials: { client_email: string; private_key: string }\n\t/** GCP project id; inferred from the credentials when omitted. */\n\tprojectId?: string\n\t/** Maximum days of historical data. Defaults to 425 (GA4's rolling-window limit). Pass null to disable clamping. */\n\tmaxLookbackDays?: number | null\n}\n\nconst METRIC_MAP: Partial<Record<MetricKey, string>> = {\n\tpageviews: 'screenPageViews',\n\tvisitors: 'totalUsers',\n\tvisits: 'sessions',\n\tsessions: 'sessions',\n\tbounceRate: 'bounceRate',\n\tavgDuration: 'averageSessionDuration',\n\tevents: 'eventCount',\n\tconversions: 'keyEvents',\n\trevenue: 'totalRevenue',\n}\n\nconst DIMENSION_MAP: Partial<Record<DimensionKey, string>> = {\n\tpage: 'pagePath',\n\treferrer: 'pageReferrer',\n\tsource: 'sessionSource',\n\tmedium: 'sessionMedium',\n\tcampaign: 'sessionCampaignName',\n\tutmSource: 'sessionSource',\n\tutmMedium: 'sessionMedium',\n\tutmCampaign: 'sessionCampaignName',\n\tdevice: 'deviceCategory',\n\tbrowser: 'browser',\n\tos: 'operatingSystem',\n\tcountry: 'countryId',\n\tregion: 'region',\n\tcity: 'city',\n\tlanguage: 'language',\n\tevent: 'eventName',\n}\n\nconst ga4Metrics: ReadonlySet<MetricKey> = new Set(Object.keys(METRIC_MAP) as MetricKey[])\nconst ga4Dimensions: ReadonlySet<DimensionKey> = new Set(\n\tObject.keys(DIMENSION_MAP) as DimensionKey[]\n)\n\n// GA4 returns bounceRate as a 0..1 ratio and averageSessionDuration in seconds; the\n// contract uses a 0..100 percentage and milliseconds.\nconst toContractValue = (metric: MetricKey, raw: number): number => {\n\tif (metric === 'avgDuration') {\n\t\treturn Math.round(raw * 1000)\n\t}\n\tif (metric === 'bounceRate') {\n\t\treturn Math.round(raw * 100)\n\t}\n\treturn raw\n}\n\nexport function ga4(config: Ga4Config): AnalyticsAdapter {\n\tconst maxLookbackDays = config.maxLookbackDays !== undefined ? config.maxLookbackDays : 425\n\n\tconst capabilities: AnalyticsCapabilities = {\n\t\tperPageQuery: true,\n\t\trealtime: false,\n\t\tcomparison: false,\n\t\tminGranularity: 'day',\n\t\tmaxLookbackDays,\n\t\tmetrics: ga4Metrics,\n\t\tdimensions: ga4Dimensions,\n\t\tbatchPageReport: true,\n\t\trateLimit: { maxConcurrent: 10, quotaModel: 'tokens', readsCountAsUsage: true },\n\t\trecommendedTtl: { realtime: 300, aggregate: 21600 },\n\t}\n\n\tlet clientPromise: Promise<BetaAnalyticsDataClient> | undefined\n\n\tconst getClient = (): Promise<BetaAnalyticsDataClient> => {\n\t\tif (!clientPromise) {\n\t\t\tclientPromise = (async () => {\n\t\t\t\tlet mod: typeof import('@google-analytics/data')\n\t\t\t\ttry {\n\t\t\t\t\tmod = await import('@google-analytics/data')\n\t\t\t\t} catch {\n\t\t\t\t\tthrow new Error(\n\t\t\t\t\t\t'@10x-media/analytics: the GA4 adapter requires the optional peer dependency \"@google-analytics/data\". Install it with: pnpm add @google-analytics/data'\n\t\t\t\t\t)\n\t\t\t\t}\n\t\t\t\treturn new mod.BetaAnalyticsDataClient({\n\t\t\t\t\tcredentials: config.credentials,\n\t\t\t\t\tprojectId: config.projectId,\n\t\t\t\t})\n\t\t\t})()\n\t\t}\n\t\treturn clientPromise\n\t}\n\n\treturn {\n\t\tid: 'ga4',\n\t\tlabel: 'Google Analytics 4',\n\t\tcapabilities,\n\t\tisConfigured: () =>\n\t\t\tBoolean(\n\t\t\t\tconfig.propertyId && config.credentials?.client_email && config.credentials?.private_key\n\t\t\t),\n\t\t// The gRPC SDK's gax CallOptions has no AbortSignal field, so ctx.signal cannot be\n\t\t// forwarded; gax cancellation uses the call's own handle, not our signal.\n\t\tasync query(q: AnalyticsQuery, _ctx: AdapterContext): Promise<AnalyticsResult> {\n\t\t\tconst fetchedAt = q.dateRange.end.toISOString()\n\t\t\tconst wanted = q.metrics.filter((m) => METRIC_MAP[m])\n\t\t\tconst providerMetrics = [...new Set(wanted.map((m) => METRIC_MAP[m] as string))]\n\t\t\tconst dims = (q.dimensions ?? []).filter((d) => DIMENSION_MAP[d])\n\t\t\tconst providerDims = [...new Set(dims.map((d) => DIMENSION_MAP[d] as string))]\n\n\t\t\tconst readRow = (\n\t\t\t\trow: protos.google.analytics.data.v1beta.IRow\n\t\t\t): Partial<Record<MetricKey, number>> => {\n\t\t\t\tconst out: Partial<Record<MetricKey, number>> = {}\n\t\t\t\tfor (const m of wanted) {\n\t\t\t\t\tconst idx = providerMetrics.indexOf(METRIC_MAP[m] as string)\n\t\t\t\t\tout[m] = toContractValue(m, Number(row.metricValues?.[idx]?.value ?? 0))\n\t\t\t\t}\n\t\t\t\treturn out\n\t\t\t}\n\n\t\t\tconst filterExprs: protos.google.analytics.data.v1beta.IFilterExpression[] = []\n\t\t\tif (q.path) {\n\t\t\t\tfilterExprs.push({\n\t\t\t\t\tfilter: { fieldName: 'pagePath', stringFilter: { matchType: 'EXACT', value: q.path } },\n\t\t\t\t})\n\t\t\t}\n\t\t\tif (q.hostname) {\n\t\t\t\tfilterExprs.push({\n\t\t\t\t\tfilter: {\n\t\t\t\t\t\tfieldName: 'hostName',\n\t\t\t\t\t\tstringFilter: { matchType: 'EXACT', value: q.hostname },\n\t\t\t\t\t},\n\t\t\t\t})\n\t\t\t}\n\t\t\tconst dimensionFilter =\n\t\t\t\tfilterExprs.length === 0\n\t\t\t\t\t? undefined\n\t\t\t\t\t: filterExprs.length === 1\n\t\t\t\t\t\t? filterExprs[0]\n\t\t\t\t\t\t: { andGroup: { expressions: filterExprs } }\n\n\t\t\tconst baseRequest: protos.google.analytics.data.v1beta.IRunReportRequest = {\n\t\t\t\tproperty: `properties/${config.propertyId}`,\n\t\t\t\tdateRanges: [\n\t\t\t\t\t{\n\t\t\t\t\t\tstartDate: q.dateRange.start.toISOString().slice(0, 10),\n\t\t\t\t\t\tendDate: q.dateRange.end.toISOString().slice(0, 10),\n\t\t\t\t\t},\n\t\t\t\t],\n\t\t\t\tmetrics: providerMetrics.map((name) => ({ name })),\n\t\t\t\t...(dimensionFilter ? { dimensionFilter } : {}),\n\t\t\t}\n\n\t\t\tconst client = await getClient()\n\n\t\t\tif (q.granularity === 'day' && !dims.length) {\n\t\t\t\tconst [response] = await client.runReport({\n\t\t\t\t\t...baseRequest,\n\t\t\t\t\tdimensions: [{ name: 'date' }],\n\t\t\t\t\tmetricAggregations: [\n\t\t\t\t\t\t'TOTAL',\n\t\t\t\t\t] as unknown as protos.google.analytics.data.v1beta.MetricAggregation[],\n\t\t\t\t\torderBys: [{ dimension: { dimensionName: 'date' } }],\n\t\t\t\t})\n\t\t\t\tconst rows: AnalyticsRow[] = []\n\t\t\t\tfor (const row of response.rows ?? []) {\n\t\t\t\t\tconst ymd = row.dimensionValues?.[0]?.value ?? ''\n\t\t\t\t\tconst ts = dayIso(`${ymd.slice(0, 4)}-${ymd.slice(4, 6)}-${ymd.slice(6, 8)}`)\n\t\t\t\t\tif (ts) {\n\t\t\t\t\t\trows.push({ timestamp: ts, metrics: readRow(row) })\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tconst totalsRow = response.totals?.[0]\n\t\t\t\tconst totals = totalsRow ? readRow(totalsRow) : {}\n\t\t\t\treturn { rows, totals, meta: { provider: 'ga4', fetchedAt } }\n\t\t\t}\n\n\t\t\tconst [response] = await client.runReport({\n\t\t\t\t...baseRequest,\n\t\t\t\t...(providerDims.length ? { dimensions: providerDims.map((name) => ({ name })) } : {}),\n\t\t\t\t...(q.limit ? { limit: q.limit } : {}),\n\t\t\t})\n\n\t\t\tif (!dims.length) {\n\t\t\t\tconst row = response.rows?.[0]\n\t\t\t\tconst totals = row ? readRow(row) : {}\n\t\t\t\treturn { rows: [{ metrics: totals }], totals, meta: { provider: 'ga4', fetchedAt } }\n\t\t\t}\n\n\t\t\tconst rows: AnalyticsRow[] = (response.rows ?? []).map((row) => {\n\t\t\t\tconst dimValues: Partial<Record<DimensionKey, string>> = {}\n\t\t\t\tfor (const d of dims) {\n\t\t\t\t\tconst idx = providerDims.indexOf(DIMENSION_MAP[d] as string)\n\t\t\t\t\tdimValues[d] = row.dimensionValues?.[idx]?.value ?? ''\n\t\t\t\t}\n\t\t\t\treturn { dimensions: dimValues, metrics: readRow(row) }\n\t\t\t})\n\t\t\treturn { rows, totals: undefined, meta: { provider: 'ga4', fetchedAt } }\n\t\t},\n\t}\n}\n"],"mappings":";;AAwBA,MAAM,aAAiD;CACtD,WAAW;CACX,UAAU;CACV,QAAQ;CACR,UAAU;CACV,YAAY;CACZ,aAAa;CACb,QAAQ;CACR,aAAa;CACb,SAAS;AACV;AAEA,MAAM,gBAAuD;CAC5D,MAAM;CACN,UAAU;CACV,QAAQ;CACR,QAAQ;CACR,UAAU;CACV,WAAW;CACX,WAAW;CACX,aAAa;CACb,QAAQ;CACR,SAAS;CACT,IAAI;CACJ,SAAS;CACT,QAAQ;CACR,MAAM;CACN,UAAU;CACV,OAAO;AACR;AAEA,MAAM,aAAqC,IAAI,IAAI,OAAO,KAAK,UAAU,CAAgB;AACzF,MAAM,gBAA2C,IAAI,IACpD,OAAO,KAAK,aAAa,CAC1B;AAIA,MAAM,mBAAmB,QAAmB,QAAwB;CACnE,IAAI,WAAW,eACd,OAAO,KAAK,MAAM,MAAM,GAAI;CAE7B,IAAI,WAAW,cACd,OAAO,KAAK,MAAM,MAAM,GAAG;CAE5B,OAAO;AACR;AAEA,SAAgB,IAAI,QAAqC;CAGxD,MAAM,eAAsC;EAC3C,cAAc;EACd,UAAU;EACV,YAAY;EACZ,gBAAgB;EAChB,iBAPuB,OAAO,oBAAoB,KAAA,IAAY,OAAO,kBAAkB;EAQvF,SAAS;EACT,YAAY;EACZ,iBAAiB;EACjB,WAAW;GAAE,eAAe;GAAI,YAAY;GAAU,mBAAmB;EAAK;EAC9E,gBAAgB;GAAE,UAAU;GAAK,WAAW;EAAM;CACnD;CAEA,IAAI;CAEJ,MAAM,kBAAoD;EACzD,IAAI,CAAC,eACJ,iBAAiB,YAAY;GAC5B,IAAI;GACJ,IAAI;IACH,MAAM,MAAM,OAAO;GACpB,QAAQ;IACP,MAAM,IAAI,MACT,0JACD;GACD;GACA,OAAO,IAAI,IAAI,wBAAwB;IACtC,aAAa,OAAO;IACpB,WAAW,OAAO;GACnB,CAAC;EACF,GAAG;EAEJ,OAAO;CACR;CAEA,OAAO;EACN,IAAI;EACJ,OAAO;EACP;EACA,oBACC,QACC,OAAO,cAAc,OAAO,aAAa,gBAAgB,OAAO,aAAa,WAC9E;EAGD,MAAM,MAAM,GAAmB,MAAgD;GAC9E,MAAM,YAAY,EAAE,UAAU,IAAI,YAAY;GAC9C,MAAM,SAAS,EAAE,QAAQ,QAAQ,MAAM,WAAW,EAAE;GACpD,MAAM,kBAAkB,CAAC,GAAG,IAAI,IAAI,OAAO,KAAK,MAAM,WAAW,EAAY,CAAC,CAAC;GAC/E,MAAM,QAAQ,EAAE,cAAc,CAAC,GAAG,QAAQ,MAAM,cAAc,EAAE;GAChE,MAAM,eAAe,CAAC,GAAG,IAAI,IAAI,KAAK,KAAK,MAAM,cAAc,EAAY,CAAC,CAAC;GAE7E,MAAM,WACL,QACwC;IACxC,MAAM,MAA0C,CAAC;IACjD,KAAK,MAAM,KAAK,QAAQ;KACvB,MAAM,MAAM,gBAAgB,QAAQ,WAAW,EAAY;KAC3D,IAAI,KAAK,gBAAgB,GAAG,OAAO,IAAI,eAAe,MAAM,SAAS,CAAC,CAAC;IACxE;IACA,OAAO;GACR;GAEA,MAAM,cAAuE,CAAC;GAC9E,IAAI,EAAE,MACL,YAAY,KAAK,EAChB,QAAQ;IAAE,WAAW;IAAY,cAAc;KAAE,WAAW;KAAS,OAAO,EAAE;IAAK;GAAE,EACtF,CAAC;GAEF,IAAI,EAAE,UACL,YAAY,KAAK,EAChB,QAAQ;IACP,WAAW;IACX,cAAc;KAAE,WAAW;KAAS,OAAO,EAAE;IAAS;GACvD,EACD,CAAC;GAEF,MAAM,kBACL,YAAY,WAAW,IACpB,KAAA,IACA,YAAY,WAAW,IACtB,YAAY,KACZ,EAAE,UAAU,EAAE,aAAa,YAAY,EAAE;GAE9C,MAAM,cAAqE;IAC1E,UAAU,cAAc,OAAO;IAC/B,YAAY,CACX;KACC,WAAW,EAAE,UAAU,MAAM,YAAY,EAAE,MAAM,GAAG,EAAE;KACtD,SAAS,EAAE,UAAU,IAAI,YAAY,EAAE,MAAM,GAAG,EAAE;IACnD,CACD;IACA,SAAS,gBAAgB,KAAK,UAAU,EAAE,KAAK,EAAE;IACjD,GAAI,kBAAkB,EAAE,gBAAgB,IAAI,CAAC;GAC9C;GAEA,MAAM,SAAS,MAAM,UAAU;GAE/B,IAAI,EAAE,gBAAgB,SAAS,CAAC,KAAK,QAAQ;IAC5C,MAAM,CAAC,YAAY,MAAM,OAAO,UAAU;KACzC,GAAG;KACH,YAAY,CAAC,EAAE,MAAM,OAAO,CAAC;KAC7B,oBAAoB,CACnB,OACD;KACA,UAAU,CAAC,EAAE,WAAW,EAAE,eAAe,OAAO,EAAE,CAAC;IACpD,CAAC;IACD,MAAM,OAAuB,CAAC;IAC9B,KAAK,MAAM,OAAO,SAAS,QAAQ,CAAC,GAAG;KACtC,MAAM,MAAM,IAAI,kBAAkB,IAAI,SAAS;KAC/C,MAAM,KAAK,OAAO,GAAG,IAAI,MAAM,GAAG,CAAC,EAAE,GAAG,IAAI,MAAM,GAAG,CAAC,EAAE,GAAG,IAAI,MAAM,GAAG,CAAC,GAAG;KAC5E,IAAI,IACH,KAAK,KAAK;MAAE,WAAW;MAAI,SAAS,QAAQ,GAAG;KAAE,CAAC;IAEpD;IACA,MAAM,YAAY,SAAS,SAAS;IAEpC,OAAO;KAAE;KAAM,QADA,YAAY,QAAQ,SAAS,IAAI,CAAC;KAC1B,MAAM;MAAE,UAAU;MAAO;KAAU;IAAE;GAC7D;GAEA,MAAM,CAAC,YAAY,MAAM,OAAO,UAAU;IACzC,GAAG;IACH,GAAI,aAAa,SAAS,EAAE,YAAY,aAAa,KAAK,UAAU,EAAE,KAAK,EAAE,EAAE,IAAI,CAAC;IACpF,GAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;GACrC,CAAC;GAED,IAAI,CAAC,KAAK,QAAQ;IACjB,MAAM,MAAM,SAAS,OAAO;IAC5B,MAAM,SAAS,MAAM,QAAQ,GAAG,IAAI,CAAC;IACrC,OAAO;KAAE,MAAM,CAAC,EAAE,SAAS,OAAO,CAAC;KAAG;KAAQ,MAAM;MAAE,UAAU;MAAO;KAAU;IAAE;GACpF;GAUA,OAAO;IAAE,OARqB,SAAS,QAAQ,CAAC,GAAG,KAAK,QAAQ;KAC/D,MAAM,YAAmD,CAAC;KAC1D,KAAK,MAAM,KAAK,MAAM;MACrB,MAAM,MAAM,aAAa,QAAQ,cAAc,EAAY;MAC3D,UAAU,KAAK,IAAI,kBAAkB,MAAM,SAAS;KACrD;KACA,OAAO;MAAE,YAAY;MAAW,SAAS,QAAQ,GAAG;KAAE;IACvD,CACY;IAAG,QAAQ,KAAA;IAAW,MAAM;KAAE,UAAU;KAAO;IAAU;GAAE;EACxE;CACD;AACD"}
@@ -31,6 +31,6 @@ const fetchJson = async (url, opts) => {
31
31
  return await res.json();
32
32
  };
33
33
  //#endregion
34
- export { fetchJson as t };
34
+ export { fetchJson };
35
35
 
36
- //# sourceMappingURL=fetchJson-DZb2_Puj.js.map
36
+ //# sourceMappingURL=fetchJson.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fetchJson.js","names":[],"sources":["../../../src/adapters/http/fetchJson.ts"],"sourcesContent":["export class ProviderHttpError extends Error {\n\treadonly status: number\n\treadonly provider: string\n\tconstructor(status: number, provider: string, message: string) {\n\t\tsuper(message)\n\t\tthis.name = 'ProviderHttpError'\n\t\tthis.status = status\n\t\tthis.provider = provider\n\t}\n}\n\nexport interface FetchJsonOptions {\n\tmethod?: 'GET' | 'POST'\n\theaders?: Record<string, string>\n\tbody?: unknown\n\tsignal?: AbortSignal\n\tprovider: string\n}\n\n/**\n * Thin JSON fetch used by provider adapters. Throws ProviderHttpError (carrying the\n * status) on a non-2xx response so the surfacing engine's queue can treat it as a\n * failed fetch; the engine owns retry/backoff and caching.\n */\nexport const fetchJson = async <T>(url: string, opts: FetchJsonOptions): Promise<T> => {\n\tconst res = await fetch(url, {\n\t\tmethod: opts.method ?? 'GET',\n\t\theaders: {\n\t\t\t...(opts.body === undefined ? {} : { 'content-type': 'application/json' }),\n\t\t\t...opts.headers,\n\t\t},\n\t\tbody: opts.body === undefined ? undefined : JSON.stringify(opts.body),\n\t\tsignal: opts.signal,\n\t})\n\tif (!res.ok) {\n\t\tconst detail = await res.text().catch(() => '')\n\t\tthrow new ProviderHttpError(\n\t\t\tres.status,\n\t\t\topts.provider,\n\t\t\t`${opts.provider}: HTTP ${res.status} ${detail.slice(0, 200)}`\n\t\t)\n\t}\n\treturn (await res.json()) as T\n}\n"],"mappings":";AAAA,IAAa,oBAAb,cAAuC,MAAM;CAC5C;CACA;CACA,YAAY,QAAgB,UAAkB,SAAiB;EAC9D,MAAM,OAAO;EACb,KAAK,OAAO;EACZ,KAAK,SAAS;EACd,KAAK,WAAW;CACjB;AACD;;;;;;AAeA,MAAa,YAAY,OAAU,KAAa,SAAuC;CACtF,MAAM,MAAM,MAAM,MAAM,KAAK;EAC5B,QAAQ,KAAK,UAAU;EACvB,SAAS;GACR,GAAI,KAAK,SAAS,KAAA,IAAY,CAAC,IAAI,EAAE,gBAAgB,mBAAmB;GACxE,GAAG,KAAK;EACT;EACA,MAAM,KAAK,SAAS,KAAA,IAAY,KAAA,IAAY,KAAK,UAAU,KAAK,IAAI;EACpE,QAAQ,KAAK;CACd,CAAC;CACD,IAAI,CAAC,IAAI,IAAI;EACZ,MAAM,SAAS,MAAM,IAAI,KAAK,EAAE,YAAY,EAAE;EAC9C,MAAM,IAAI,kBACT,IAAI,QACJ,KAAK,UACL,GAAG,KAAK,SAAS,SAAS,IAAI,OAAO,GAAG,OAAO,MAAM,GAAG,GAAG,GAC5D;CACD;CACA,OAAQ,MAAM,IAAI,KAAK;AACxB"}
@@ -0,0 +1,15 @@
1
+ import { AnalyticsAdapter } from "../../core/contract.js";
2
+
3
+ //#region src/adapters/plausible/plausible.d.ts
4
+ interface PlausibleConfig {
5
+ siteId: string;
6
+ apiKey: string;
7
+ /** Base URL for self-hosted CE. Defaults to Plausible Cloud. */
8
+ host?: string;
9
+ /** Maximum days of historical data. Defaults to 730. Pass null to disable clamping. */
10
+ maxLookbackDays?: number | null;
11
+ }
12
+ declare function plausible(config: PlausibleConfig): AnalyticsAdapter;
13
+ //#endregion
14
+ export { PlausibleConfig, plausible };
15
+ //# sourceMappingURL=plausible.d.ts.map
@@ -0,0 +1,148 @@
1
+ import { dayIso } from "../series.js";
2
+ import { fetchJson } from "../http/fetchJson.js";
3
+ //#region src/adapters/plausible/plausible.ts
4
+ const METRIC_MAP = {
5
+ pageviews: "pageviews",
6
+ visitors: "visitors",
7
+ visits: "visits",
8
+ sessions: "visits",
9
+ bounceRate: "bounce_rate",
10
+ avgDuration: "visit_duration",
11
+ events: "events",
12
+ scrollDepth: "scroll_depth",
13
+ revenue: "total_revenue"
14
+ };
15
+ const DIMENSION_MAP = {
16
+ page: "event:page",
17
+ source: "visit:source",
18
+ referrer: "visit:referrer",
19
+ device: "visit:device",
20
+ browser: "visit:browser",
21
+ os: "visit:os",
22
+ country: "visit:country",
23
+ region: "visit:region",
24
+ city: "visit:city",
25
+ utmSource: "visit:utm_source",
26
+ utmMedium: "visit:utm_medium",
27
+ utmCampaign: "visit:utm_campaign"
28
+ };
29
+ const plausibleMetrics = new Set(Object.keys(METRIC_MAP));
30
+ const plausibleDimensions = new Set(Object.keys(DIMENSION_MAP));
31
+ const toContractValue = (metric, raw) => metric === "avgDuration" ? Math.round(raw * 1e3) : raw;
32
+ function plausible(config) {
33
+ const host = config.host ?? "https://plausible.io";
34
+ return {
35
+ id: "plausible",
36
+ label: "Plausible",
37
+ capabilities: {
38
+ perPageQuery: true,
39
+ realtime: false,
40
+ comparison: false,
41
+ minGranularity: "day",
42
+ maxLookbackDays: config.maxLookbackDays !== void 0 ? config.maxLookbackDays : 730,
43
+ metrics: plausibleMetrics,
44
+ dimensions: plausibleDimensions,
45
+ batchPageReport: true,
46
+ rateLimit: { requestsPerHour: 600 },
47
+ recommendedTtl: {
48
+ realtime: 300,
49
+ aggregate: 3600
50
+ }
51
+ },
52
+ isConfigured: () => Boolean(config.siteId && config.apiKey),
53
+ async query(q, ctx) {
54
+ const fetchedAt = q.dateRange.end.toISOString();
55
+ const wanted = q.metrics.filter((m) => METRIC_MAP[m]);
56
+ const providerMetrics = [...new Set(wanted.map((m) => METRIC_MAP[m]))];
57
+ const dims = (q.dimensions ?? []).filter((d) => DIMENSION_MAP[d]);
58
+ const filters = [];
59
+ if (q.path) filters.push([
60
+ "is",
61
+ "event:page",
62
+ [q.path]
63
+ ]);
64
+ if (q.hostname) filters.push([
65
+ "is",
66
+ "event:hostname",
67
+ [q.hostname]
68
+ ]);
69
+ const readRow = (row) => {
70
+ const out = {};
71
+ for (const m of wanted) {
72
+ const idx = providerMetrics.indexOf(METRIC_MAP[m]);
73
+ out[m] = toContractValue(m, row.metrics[idx] ?? 0);
74
+ }
75
+ return out;
76
+ };
77
+ const postQuery = (extra) => fetchJson(`${host}/api/v2/query`, {
78
+ method: "POST",
79
+ headers: { authorization: `Bearer ${config.apiKey}` },
80
+ body: {
81
+ site_id: config.siteId,
82
+ metrics: providerMetrics,
83
+ date_range: [q.dateRange.start.toISOString().slice(0, 10), q.dateRange.end.toISOString().slice(0, 10)],
84
+ ...filters.length ? { filters } : {},
85
+ ...extra
86
+ },
87
+ signal: ctx.signal,
88
+ provider: "plausible"
89
+ });
90
+ const fetchTotals = async () => {
91
+ const data = await postQuery({});
92
+ return data.results[0] ? readRow(data.results[0]) : {};
93
+ };
94
+ if (q.granularity === "day" && !dims.length) {
95
+ const [seriesData, totals] = await Promise.all([postQuery({ dimensions: ["time:day"] }), fetchTotals()]);
96
+ const rows = [];
97
+ for (const row of seriesData.results) {
98
+ const ts = dayIso(row.dimensions[0] ?? "");
99
+ if (ts) rows.push({
100
+ timestamp: ts,
101
+ metrics: readRow(row)
102
+ });
103
+ }
104
+ return {
105
+ rows,
106
+ totals,
107
+ meta: {
108
+ provider: "plausible",
109
+ fetchedAt
110
+ }
111
+ };
112
+ }
113
+ if (!dims.length) {
114
+ const totals = await fetchTotals();
115
+ return {
116
+ rows: [{ metrics: totals }],
117
+ totals,
118
+ meta: {
119
+ provider: "plausible",
120
+ fetchedAt
121
+ }
122
+ };
123
+ }
124
+ return {
125
+ rows: (await postQuery({ dimensions: dims.map((d) => DIMENSION_MAP[d]) })).results.map((row) => {
126
+ const dimValues = {};
127
+ for (let i = 0; i < dims.length; i++) {
128
+ const d = dims[i];
129
+ if (d !== void 0) dimValues[d] = row.dimensions[i] ?? "";
130
+ }
131
+ return {
132
+ dimensions: dimValues,
133
+ metrics: readRow(row)
134
+ };
135
+ }),
136
+ totals: void 0,
137
+ meta: {
138
+ provider: "plausible",
139
+ fetchedAt
140
+ }
141
+ };
142
+ }
143
+ };
144
+ }
145
+ //#endregion
146
+ export { plausible };
147
+
148
+ //# sourceMappingURL=plausible.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"plausible.js","names":[],"sources":["../../../src/adapters/plausible/plausible.ts"],"sourcesContent":["import type {\n\tAdapterContext,\n\tAnalyticsAdapter,\n\tAnalyticsCapabilities,\n\tAnalyticsQuery,\n\tAnalyticsResult,\n\tAnalyticsRow,\n\tDimensionKey,\n\tMetricKey,\n} from '../../core/contract'\nimport { fetchJson } from '../http/fetchJson'\nimport { dayIso } from '../series'\n\nexport interface PlausibleConfig {\n\tsiteId: string\n\tapiKey: string\n\t/** Base URL for self-hosted CE. Defaults to Plausible Cloud. */\n\thost?: string\n\t/** Maximum days of historical data. Defaults to 730. Pass null to disable clamping. */\n\tmaxLookbackDays?: number | null\n}\n\nconst METRIC_MAP: Partial<Record<MetricKey, string>> = {\n\tpageviews: 'pageviews',\n\tvisitors: 'visitors',\n\tvisits: 'visits',\n\tsessions: 'visits',\n\tbounceRate: 'bounce_rate',\n\tavgDuration: 'visit_duration',\n\tevents: 'events',\n\tscrollDepth: 'scroll_depth',\n\trevenue: 'total_revenue',\n}\n\nconst DIMENSION_MAP: Partial<Record<DimensionKey, string>> = {\n\tpage: 'event:page',\n\tsource: 'visit:source',\n\treferrer: 'visit:referrer',\n\tdevice: 'visit:device',\n\tbrowser: 'visit:browser',\n\tos: 'visit:os',\n\tcountry: 'visit:country',\n\tregion: 'visit:region',\n\tcity: 'visit:city',\n\tutmSource: 'visit:utm_source',\n\tutmMedium: 'visit:utm_medium',\n\tutmCampaign: 'visit:utm_campaign',\n}\n\nconst plausibleMetrics: ReadonlySet<MetricKey> = new Set(Object.keys(METRIC_MAP) as MetricKey[])\nconst plausibleDimensions: ReadonlySet<DimensionKey> = new Set(\n\tObject.keys(DIMENSION_MAP) as DimensionKey[]\n)\n\ninterface PlausibleResponse {\n\tresults: Array<{ metrics: number[]; dimensions: string[] }>\n}\n\n// visit_duration is reported in seconds; the contract avgDuration is milliseconds.\nconst toContractValue = (metric: MetricKey, raw: number): number =>\n\tmetric === 'avgDuration' ? Math.round(raw * 1000) : raw\n\nexport function plausible(config: PlausibleConfig): AnalyticsAdapter {\n\tconst host = config.host ?? 'https://plausible.io'\n\tconst maxLookbackDays = config.maxLookbackDays !== undefined ? config.maxLookbackDays : 730\n\n\tconst capabilities: AnalyticsCapabilities = {\n\t\tperPageQuery: true,\n\t\trealtime: false,\n\t\tcomparison: false,\n\t\tminGranularity: 'day',\n\t\tmaxLookbackDays,\n\t\tmetrics: plausibleMetrics,\n\t\tdimensions: plausibleDimensions,\n\t\tbatchPageReport: true,\n\t\trateLimit: { requestsPerHour: 600 },\n\t\trecommendedTtl: { realtime: 300, aggregate: 3600 },\n\t}\n\n\treturn {\n\t\tid: 'plausible',\n\t\tlabel: 'Plausible',\n\t\tcapabilities,\n\t\tisConfigured: () => Boolean(config.siteId && config.apiKey),\n\t\tasync query(q: AnalyticsQuery, ctx: AdapterContext): Promise<AnalyticsResult> {\n\t\t\tconst fetchedAt = q.dateRange.end.toISOString()\n\t\t\tconst wanted = q.metrics.filter((m) => METRIC_MAP[m])\n\t\t\t// Several contract metrics alias one Plausible metric (sessions and visits both\n\t\t\t// map to \"visits\"), so dedupe before sending and read each contract metric back\n\t\t\t// from its provider key's position rather than the request index.\n\t\t\tconst providerMetrics = [...new Set(wanted.map((m) => METRIC_MAP[m] as string))]\n\t\t\tconst dims = (q.dimensions ?? []).filter((d) => DIMENSION_MAP[d])\n\t\t\tconst filters: Array<[string, string, string[]]> = []\n\t\t\tif (q.path) {\n\t\t\t\tfilters.push(['is', 'event:page', [q.path]])\n\t\t\t}\n\t\t\tif (q.hostname) {\n\t\t\t\tfilters.push(['is', 'event:hostname', [q.hostname]])\n\t\t\t}\n\n\t\t\tconst readRow = (row: { metrics: number[] }): Partial<Record<MetricKey, number>> => {\n\t\t\t\tconst out: Partial<Record<MetricKey, number>> = {}\n\t\t\t\tfor (const m of wanted) {\n\t\t\t\t\tconst idx = providerMetrics.indexOf(METRIC_MAP[m] as string)\n\t\t\t\t\tout[m] = toContractValue(m, row.metrics[idx] ?? 0)\n\t\t\t\t}\n\t\t\t\treturn out\n\t\t\t}\n\n\t\t\tconst postQuery = (extra: Record<string, unknown>): Promise<PlausibleResponse> =>\n\t\t\t\tfetchJson<PlausibleResponse>(`${host}/api/v2/query`, {\n\t\t\t\t\tmethod: 'POST',\n\t\t\t\t\theaders: { authorization: `Bearer ${config.apiKey}` },\n\t\t\t\t\tbody: {\n\t\t\t\t\t\tsite_id: config.siteId,\n\t\t\t\t\t\tmetrics: providerMetrics,\n\t\t\t\t\t\tdate_range: [\n\t\t\t\t\t\t\tq.dateRange.start.toISOString().slice(0, 10),\n\t\t\t\t\t\t\tq.dateRange.end.toISOString().slice(0, 10),\n\t\t\t\t\t\t],\n\t\t\t\t\t\t...(filters.length ? { filters } : {}),\n\t\t\t\t\t\t...extra,\n\t\t\t\t\t},\n\t\t\t\t\tsignal: ctx.signal,\n\t\t\t\t\tprovider: 'plausible',\n\t\t\t\t})\n\n\t\t\tconst fetchTotals = async (): Promise<Partial<Record<MetricKey, number>>> => {\n\t\t\t\tconst data = await postQuery({})\n\t\t\t\treturn data.results[0] ? readRow(data.results[0]) : {}\n\t\t\t}\n\n\t\t\tif (q.granularity === 'day' && !dims.length) {\n\t\t\t\tconst [seriesData, totals] = await Promise.all([\n\t\t\t\t\tpostQuery({ dimensions: ['time:day'] }),\n\t\t\t\t\tfetchTotals(),\n\t\t\t\t])\n\t\t\t\tconst rows: AnalyticsRow[] = []\n\t\t\t\tfor (const row of seriesData.results) {\n\t\t\t\t\tconst ts = dayIso(row.dimensions[0] ?? '')\n\t\t\t\t\tif (ts) {\n\t\t\t\t\t\trows.push({ timestamp: ts, metrics: readRow(row) })\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn { rows, totals, meta: { provider: 'plausible', fetchedAt } }\n\t\t\t}\n\n\t\t\tif (!dims.length) {\n\t\t\t\tconst totals = await fetchTotals()\n\t\t\t\treturn { rows: [{ metrics: totals }], totals, meta: { provider: 'plausible', fetchedAt } }\n\t\t\t}\n\n\t\t\tconst data = await postQuery({ dimensions: dims.map((d) => DIMENSION_MAP[d] as string) })\n\t\t\tconst rows: AnalyticsRow[] = data.results.map((row) => {\n\t\t\t\tconst dimValues: Partial<Record<DimensionKey, string>> = {}\n\t\t\t\tfor (let i = 0; i < dims.length; i++) {\n\t\t\t\t\tconst d = dims[i]\n\t\t\t\t\tif (d !== undefined) {\n\t\t\t\t\t\tdimValues[d] = row.dimensions[i] ?? ''\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn { dimensions: dimValues, metrics: readRow(row) }\n\t\t\t})\n\t\t\treturn { rows, totals: undefined, meta: { provider: 'plausible', fetchedAt } }\n\t\t},\n\t}\n}\n"],"mappings":";;;AAsBA,MAAM,aAAiD;CACtD,WAAW;CACX,UAAU;CACV,QAAQ;CACR,UAAU;CACV,YAAY;CACZ,aAAa;CACb,QAAQ;CACR,aAAa;CACb,SAAS;AACV;AAEA,MAAM,gBAAuD;CAC5D,MAAM;CACN,QAAQ;CACR,UAAU;CACV,QAAQ;CACR,SAAS;CACT,IAAI;CACJ,SAAS;CACT,QAAQ;CACR,MAAM;CACN,WAAW;CACX,WAAW;CACX,aAAa;AACd;AAEA,MAAM,mBAA2C,IAAI,IAAI,OAAO,KAAK,UAAU,CAAgB;AAC/F,MAAM,sBAAiD,IAAI,IAC1D,OAAO,KAAK,aAAa,CAC1B;AAOA,MAAM,mBAAmB,QAAmB,QAC3C,WAAW,gBAAgB,KAAK,MAAM,MAAM,GAAI,IAAI;AAErD,SAAgB,UAAU,QAA2C;CACpE,MAAM,OAAO,OAAO,QAAQ;CAgB5B,OAAO;EACN,IAAI;EACJ,OAAO;EACP,cAAA;GAfA,cAAc;GACd,UAAU;GACV,YAAY;GACZ,gBAAgB;GAChB,iBAPuB,OAAO,oBAAoB,KAAA,IAAY,OAAO,kBAAkB;GAQvF,SAAS;GACT,YAAY;GACZ,iBAAiB;GACjB,WAAW,EAAE,iBAAiB,IAAI;GAClC,gBAAgB;IAAE,UAAU;IAAK,WAAW;GAAK;EAMtC;EACX,oBAAoB,QAAQ,OAAO,UAAU,OAAO,MAAM;EAC1D,MAAM,MAAM,GAAmB,KAA+C;GAC7E,MAAM,YAAY,EAAE,UAAU,IAAI,YAAY;GAC9C,MAAM,SAAS,EAAE,QAAQ,QAAQ,MAAM,WAAW,EAAE;GAIpD,MAAM,kBAAkB,CAAC,GAAG,IAAI,IAAI,OAAO,KAAK,MAAM,WAAW,EAAY,CAAC,CAAC;GAC/E,MAAM,QAAQ,EAAE,cAAc,CAAC,GAAG,QAAQ,MAAM,cAAc,EAAE;GAChE,MAAM,UAA6C,CAAC;GACpD,IAAI,EAAE,MACL,QAAQ,KAAK;IAAC;IAAM;IAAc,CAAC,EAAE,IAAI;GAAC,CAAC;GAE5C,IAAI,EAAE,UACL,QAAQ,KAAK;IAAC;IAAM;IAAkB,CAAC,EAAE,QAAQ;GAAC,CAAC;GAGpD,MAAM,WAAW,QAAmE;IACnF,MAAM,MAA0C,CAAC;IACjD,KAAK,MAAM,KAAK,QAAQ;KACvB,MAAM,MAAM,gBAAgB,QAAQ,WAAW,EAAY;KAC3D,IAAI,KAAK,gBAAgB,GAAG,IAAI,QAAQ,QAAQ,CAAC;IAClD;IACA,OAAO;GACR;GAEA,MAAM,aAAa,UAClB,UAA6B,GAAG,KAAK,gBAAgB;IACpD,QAAQ;IACR,SAAS,EAAE,eAAe,UAAU,OAAO,SAAS;IACpD,MAAM;KACL,SAAS,OAAO;KAChB,SAAS;KACT,YAAY,CACX,EAAE,UAAU,MAAM,YAAY,EAAE,MAAM,GAAG,EAAE,GAC3C,EAAE,UAAU,IAAI,YAAY,EAAE,MAAM,GAAG,EAAE,CAC1C;KACA,GAAI,QAAQ,SAAS,EAAE,QAAQ,IAAI,CAAC;KACpC,GAAG;IACJ;IACA,QAAQ,IAAI;IACZ,UAAU;GACX,CAAC;GAEF,MAAM,cAAc,YAAyD;IAC5E,MAAM,OAAO,MAAM,UAAU,CAAC,CAAC;IAC/B,OAAO,KAAK,QAAQ,KAAK,QAAQ,KAAK,QAAQ,EAAE,IAAI,CAAC;GACtD;GAEA,IAAI,EAAE,gBAAgB,SAAS,CAAC,KAAK,QAAQ;IAC5C,MAAM,CAAC,YAAY,UAAU,MAAM,QAAQ,IAAI,CAC9C,UAAU,EAAE,YAAY,CAAC,UAAU,EAAE,CAAC,GACtC,YAAY,CACb,CAAC;IACD,MAAM,OAAuB,CAAC;IAC9B,KAAK,MAAM,OAAO,WAAW,SAAS;KACrC,MAAM,KAAK,OAAO,IAAI,WAAW,MAAM,EAAE;KACzC,IAAI,IACH,KAAK,KAAK;MAAE,WAAW;MAAI,SAAS,QAAQ,GAAG;KAAE,CAAC;IAEpD;IACA,OAAO;KAAE;KAAM;KAAQ,MAAM;MAAE,UAAU;MAAa;KAAU;IAAE;GACnE;GAEA,IAAI,CAAC,KAAK,QAAQ;IACjB,MAAM,SAAS,MAAM,YAAY;IACjC,OAAO;KAAE,MAAM,CAAC,EAAE,SAAS,OAAO,CAAC;KAAG;KAAQ,MAAM;MAAE,UAAU;MAAa;KAAU;IAAE;GAC1F;GAaA,OAAO;IAAE,OAVoB,MADV,UAAU,EAAE,YAAY,KAAK,KAAK,MAAM,cAAc,EAAY,EAAE,CAAC,GACtD,QAAQ,KAAK,QAAQ;KACtD,MAAM,YAAmD,CAAC;KAC1D,KAAK,IAAI,IAAI,GAAG,IAAI,KAAK,QAAQ,KAAK;MACrC,MAAM,IAAI,KAAK;MACf,IAAI,MAAM,KAAA,GACT,UAAU,KAAK,IAAI,WAAW,MAAM;KAEtC;KACA,OAAO;MAAE,YAAY;MAAW,SAAS,QAAQ,GAAG;KAAE;IACvD,CACY;IAAG,QAAQ,KAAA;IAAW,MAAM;KAAE,UAAU;KAAa;IAAU;GAAE;EAC9E;CACD;AACD"}
@@ -0,0 +1,23 @@
1
+ import { AnalyticsAdapter } from "../../core/contract.js";
2
+
3
+ //#region src/adapters/posthog/posthog.d.ts
4
+ interface PosthogConfig {
5
+ /** PostHog project id (numeric). */
6
+ projectId: string;
7
+ /** Personal API key with the "Query Read" scope (phx_...). */
8
+ apiKey: string;
9
+ /** API host. Defaults to US Cloud; EU is https://eu.posthog.com, self-host is your instance URL. */
10
+ host?: string;
11
+ /** Maximum days of historical data. Defaults to 730. Pass null to disable clamping. */
12
+ maxLookbackDays?: number | null;
13
+ /**
14
+ * Event property holding a query's scope (e.g. 'tenant'). Enables scoped queries:
15
+ * one platform project captures every scope with this property set, and a scoped
16
+ * read filters on it. Both the property name and value are escaped literals.
17
+ */
18
+ scopeProperty?: string;
19
+ }
20
+ declare function posthog(config: PosthogConfig): AnalyticsAdapter;
21
+ //#endregion
22
+ export { PosthogConfig, posthog };
23
+ //# sourceMappingURL=posthog.d.ts.map
@@ -0,0 +1,132 @@
1
+ import { dayIso } from "../series.js";
2
+ import { fetchJson } from "../http/fetchJson.js";
3
+ //#region src/adapters/posthog/posthog.ts
4
+ const US_CLOUD = "https://us.posthog.com";
5
+ const METRIC_SQL_PAGEVIEW = {
6
+ pageviews: "count()",
7
+ visitors: "count(DISTINCT person_id)",
8
+ visits: "count(DISTINCT properties.$session_id)",
9
+ sessions: "count(DISTINCT properties.$session_id)"
10
+ };
11
+ const METRIC_SQL_ALL = {
12
+ pageviews: "countIf(event = '$pageview')",
13
+ visitors: "count(DISTINCT if(event = '$pageview', person_id, NULL))",
14
+ visits: "count(DISTINCT if(event = '$pageview', properties.$session_id, NULL))",
15
+ sessions: "count(DISTINCT if(event = '$pageview', properties.$session_id, NULL))",
16
+ events: "count()"
17
+ };
18
+ const DIMENSION_SQL = {
19
+ page: "properties.$pathname",
20
+ event: "event"
21
+ };
22
+ const posthogMetrics = new Set(Object.keys(METRIC_SQL_ALL));
23
+ const posthogDimensions = new Set(Object.keys(DIMENSION_SQL));
24
+ const sqlString = (value) => `'${value.replace(/\\/g, "\\\\").replace(/'/g, "\\'")}'`;
25
+ const sqlDateTimeLiteral = (d) => sqlString(d.toISOString().slice(0, 19).replace("T", " "));
26
+ function posthog(config) {
27
+ const host = config.host ?? US_CLOUD;
28
+ return {
29
+ id: "posthog",
30
+ label: "PostHog",
31
+ capabilities: {
32
+ perPageQuery: true,
33
+ realtime: false,
34
+ comparison: false,
35
+ minGranularity: "day",
36
+ maxLookbackDays: config.maxLookbackDays !== void 0 ? config.maxLookbackDays : 730,
37
+ metrics: posthogMetrics,
38
+ dimensions: posthogDimensions,
39
+ batchPageReport: true,
40
+ rateLimit: {
41
+ requestsPerMinute: 240,
42
+ requestsPerHour: 2400
43
+ },
44
+ recommendedTtl: {
45
+ realtime: 300,
46
+ aggregate: 3600
47
+ },
48
+ ...config.scopeProperty ? { scopedQueries: true } : {}
49
+ },
50
+ isConfigured: () => Boolean(config.projectId && config.apiKey),
51
+ async query(q, ctx) {
52
+ const fetchedAt = q.dateRange.end.toISOString();
53
+ const breakdownDim = (q.dimensions ?? []).find((d) => DIMENSION_SQL[d]);
54
+ const scanAllEvents = q.metrics.includes("events") || breakdownDim === "event";
55
+ const metricSql = scanAllEvents ? METRIC_SQL_ALL : METRIC_SQL_PAGEVIEW;
56
+ const wanted = q.metrics.filter((m) => metricSql[m]);
57
+ const exprs = [...new Set(wanted.map((m) => metricSql[m]))];
58
+ const where = [`timestamp >= toDateTime(${sqlDateTimeLiteral(q.dateRange.start)})`, `timestamp <= toDateTime(${sqlDateTimeLiteral(q.dateRange.end)})`];
59
+ if (!scanAllEvents) where.unshift("event = '$pageview'");
60
+ if (q.path) where.push(`properties.$pathname = ${sqlString(q.path)}`);
61
+ if (q.hostname) where.push(`properties.$host = ${sqlString(q.hostname)}`);
62
+ if (config.scopeProperty && q.scope !== void 0) where.push(`properties[${sqlString(config.scopeProperty)}] = ${sqlString(q.scope)}`);
63
+ const selectMetrics = exprs.map((expr, i) => `${expr} AS m${i}`);
64
+ const runSql = (sql) => fetchJson(`${host}/api/projects/${config.projectId}/query/`, {
65
+ method: "POST",
66
+ headers: { authorization: `Bearer ${config.apiKey}` },
67
+ body: { query: {
68
+ kind: "HogQLQuery",
69
+ query: sql
70
+ } },
71
+ signal: ctx.signal,
72
+ provider: "posthog"
73
+ });
74
+ const readRow = (row, offset) => {
75
+ const out = {};
76
+ for (const m of wanted) {
77
+ const idx = exprs.indexOf(metricSql[m]);
78
+ out[m] = Number(row[offset + idx] ?? 0);
79
+ }
80
+ return out;
81
+ };
82
+ const fetchTotals = async () => {
83
+ const row = (await runSql(`SELECT ${selectMetrics.join(", ")} FROM events WHERE ${where.join(" AND ")}`)).results[0];
84
+ return row ? readRow(row, 0) : {};
85
+ };
86
+ if (q.granularity === "day" && !breakdownDim) {
87
+ const seriesSql = `SELECT ${`toStartOfDay(timestamp, ${sqlString(q.timezone ?? "UTC")})`} AS day, ${selectMetrics.join(", ")} FROM events WHERE ${where.join(" AND ")} GROUP BY day ORDER BY day`;
88
+ const [seriesData, totals] = await Promise.all([runSql(seriesSql), fetchTotals()]);
89
+ const rows = [];
90
+ for (const row of seriesData.results) {
91
+ const ts = dayIso(String(row[0] ?? ""));
92
+ if (ts) rows.push({
93
+ timestamp: ts,
94
+ metrics: readRow(row, 1)
95
+ });
96
+ }
97
+ return {
98
+ rows,
99
+ totals,
100
+ meta: {
101
+ provider: "posthog",
102
+ fetchedAt
103
+ }
104
+ };
105
+ }
106
+ if (breakdownDim) return {
107
+ rows: (await runSql(`SELECT ${DIMENSION_SQL[breakdownDim]} AS dim, ${selectMetrics.join(", ")} FROM events WHERE ${where.join(" AND ")} GROUP BY dim ORDER BY m0 DESC LIMIT ${q.limit ?? 100}`)).results.map((row) => ({
108
+ dimensions: { [breakdownDim]: String(row[0] ?? "") },
109
+ metrics: readRow(row, 1)
110
+ })),
111
+ totals: void 0,
112
+ meta: {
113
+ provider: "posthog",
114
+ fetchedAt
115
+ }
116
+ };
117
+ const totals = await fetchTotals();
118
+ return {
119
+ rows: [{ metrics: totals }],
120
+ totals,
121
+ meta: {
122
+ provider: "posthog",
123
+ fetchedAt
124
+ }
125
+ };
126
+ }
127
+ };
128
+ }
129
+ //#endregion
130
+ export { posthog };
131
+
132
+ //# sourceMappingURL=posthog.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"posthog.js","names":[],"sources":["../../../src/adapters/posthog/posthog.ts"],"sourcesContent":["import type {\n\tAdapterContext,\n\tAnalyticsAdapter,\n\tAnalyticsCapabilities,\n\tAnalyticsQuery,\n\tAnalyticsResult,\n\tAnalyticsRow,\n\tDimensionKey,\n\tMetricKey,\n} from '../../core/contract'\nimport { fetchJson } from '../http/fetchJson'\nimport { dayIso } from '../series'\n\nexport interface PosthogConfig {\n\t/** PostHog project id (numeric). */\n\tprojectId: string\n\t/** Personal API key with the \"Query Read\" scope (phx_...). */\n\tapiKey: string\n\t/** API host. Defaults to US Cloud; EU is https://eu.posthog.com, self-host is your instance URL. */\n\thost?: string\n\t/** Maximum days of historical data. Defaults to 730. Pass null to disable clamping. */\n\tmaxLookbackDays?: number | null\n\t/**\n\t * Event property holding a query's scope (e.g. 'tenant'). Enables scoped queries:\n\t * one platform project captures every scope with this property set, and a scoped\n\t * read filters on it. Both the property name and value are escaped literals.\n\t */\n\tscopeProperty?: string\n}\n\nconst US_CLOUD = 'https://us.posthog.com'\n\n// Pageview-scoped expressions, used when the read filters the WHERE to `$pageview`.\n// visits and sessions share the distinct-session expression and are deduped before the\n// SELECT, then read back by the expression's position.\nconst METRIC_SQL_PAGEVIEW: Partial<Record<MetricKey, string>> = {\n\tpageviews: 'count()',\n\tvisitors: 'count(DISTINCT person_id)',\n\tvisits: 'count(DISTINCT properties.$session_id)',\n\tsessions: 'count(DISTINCT properties.$session_id)',\n}\n\n// All-event expressions, used when `events` (total captured events, matching PostHog's own\n// Events definition) or an `event`-name breakdown is requested. The WHERE is not filtered to\n// `$pageview`, so the pageview-family metrics scope themselves with conditional aggregates.\nconst METRIC_SQL_ALL: Partial<Record<MetricKey, string>> = {\n\tpageviews: \"countIf(event = '$pageview')\",\n\tvisitors: \"count(DISTINCT if(event = '$pageview', person_id, NULL))\",\n\tvisits: \"count(DISTINCT if(event = '$pageview', properties.$session_id, NULL))\",\n\tsessions: \"count(DISTINCT if(event = '$pageview', properties.$session_id, NULL))\",\n\tevents: 'count()',\n}\n\nconst DIMENSION_SQL: Partial<Record<DimensionKey, string>> = {\n\tpage: 'properties.$pathname',\n\tevent: 'event',\n}\n\nconst posthogMetrics: ReadonlySet<MetricKey> = new Set(Object.keys(METRIC_SQL_ALL) as MetricKey[])\nconst posthogDimensions: ReadonlySet<DimensionKey> = new Set(\n\tObject.keys(DIMENSION_SQL) as DimensionKey[]\n)\n\n// The Query API has no parameter binding, so values are inlined as quoted literals.\n// Escape backslashes first, then single quotes, so a crafted path cannot break out.\nconst sqlString = (value: string): string =>\n\t`'${value.replace(/\\\\/g, '\\\\\\\\').replace(/'/g, \"\\\\'\")}'`\n\nconst sqlDateTimeLiteral = (d: Date): string =>\n\tsqlString(d.toISOString().slice(0, 19).replace('T', ' '))\n\ninterface PosthogQueryResponse {\n\tcolumns: string[]\n\ttypes: string[]\n\tresults: unknown[][]\n}\n\nexport function posthog(config: PosthogConfig): AnalyticsAdapter {\n\tconst host = config.host ?? US_CLOUD\n\tconst maxLookbackDays = config.maxLookbackDays !== undefined ? config.maxLookbackDays : 730\n\n\tconst capabilities: AnalyticsCapabilities = {\n\t\tperPageQuery: true,\n\t\trealtime: false,\n\t\tcomparison: false,\n\t\tminGranularity: 'day',\n\t\tmaxLookbackDays,\n\t\tmetrics: posthogMetrics,\n\t\tdimensions: posthogDimensions,\n\t\tbatchPageReport: true,\n\t\trateLimit: { requestsPerMinute: 240, requestsPerHour: 2400 },\n\t\trecommendedTtl: { realtime: 300, aggregate: 3600 },\n\t\t...(config.scopeProperty ? { scopedQueries: true } : {}),\n\t}\n\n\treturn {\n\t\tid: 'posthog',\n\t\tlabel: 'PostHog',\n\t\tcapabilities,\n\t\tisConfigured: () => Boolean(config.projectId && config.apiKey),\n\t\tasync query(q: AnalyticsQuery, ctx: AdapterContext): Promise<AnalyticsResult> {\n\t\t\tconst fetchedAt = q.dateRange.end.toISOString()\n\t\t\tconst breakdownDim = (q.dimensions ?? []).find((d) => DIMENSION_SQL[d])\n\t\t\t// A total-events metric or an event-name breakdown must scan every event, not\n\t\t\t// just pageviews; those reads switch to conditional aggregation.\n\t\t\tconst scanAllEvents = q.metrics.includes('events') || breakdownDim === 'event'\n\t\t\tconst metricSql = scanAllEvents ? METRIC_SQL_ALL : METRIC_SQL_PAGEVIEW\n\t\t\tconst wanted = q.metrics.filter((m) => metricSql[m])\n\t\t\tconst exprs = [...new Set(wanted.map((m) => metricSql[m] as string))]\n\n\t\t\tconst where = [\n\t\t\t\t`timestamp >= toDateTime(${sqlDateTimeLiteral(q.dateRange.start)})`,\n\t\t\t\t`timestamp <= toDateTime(${sqlDateTimeLiteral(q.dateRange.end)})`,\n\t\t\t]\n\t\t\tif (!scanAllEvents) {\n\t\t\t\twhere.unshift(\"event = '$pageview'\")\n\t\t\t}\n\t\t\tif (q.path) {\n\t\t\t\twhere.push(`properties.$pathname = ${sqlString(q.path)}`)\n\t\t\t}\n\t\t\tif (q.hostname) {\n\t\t\t\twhere.push(`properties.$host = ${sqlString(q.hostname)}`)\n\t\t\t}\n\t\t\tif (config.scopeProperty && q.scope !== undefined) {\n\t\t\t\t// Bracket property access with escaped literals: neither the configured\n\t\t\t\t// property name nor the scope value can break out of the HogQL string.\n\t\t\t\twhere.push(`properties[${sqlString(config.scopeProperty)}] = ${sqlString(q.scope)}`)\n\t\t\t}\n\t\t\tconst selectMetrics = exprs.map((expr, i) => `${expr} AS m${i}`)\n\n\t\t\tconst runSql = (sql: string): Promise<PosthogQueryResponse> =>\n\t\t\t\tfetchJson<PosthogQueryResponse>(`${host}/api/projects/${config.projectId}/query/`, {\n\t\t\t\t\tmethod: 'POST',\n\t\t\t\t\theaders: { authorization: `Bearer ${config.apiKey}` },\n\t\t\t\t\tbody: { query: { kind: 'HogQLQuery', query: sql } },\n\t\t\t\t\tsignal: ctx.signal,\n\t\t\t\t\tprovider: 'posthog',\n\t\t\t\t})\n\n\t\t\tconst readRow = (row: unknown[], offset: number): Partial<Record<MetricKey, number>> => {\n\t\t\t\tconst out: Partial<Record<MetricKey, number>> = {}\n\t\t\t\tfor (const m of wanted) {\n\t\t\t\t\tconst idx = exprs.indexOf(metricSql[m] as string)\n\t\t\t\t\tout[m] = Number(row[offset + idx] ?? 0)\n\t\t\t\t}\n\t\t\t\treturn out\n\t\t\t}\n\n\t\t\tconst fetchTotals = async (): Promise<Partial<Record<MetricKey, number>>> => {\n\t\t\t\tconst data = await runSql(\n\t\t\t\t\t`SELECT ${selectMetrics.join(', ')} FROM events WHERE ${where.join(' AND ')}`\n\t\t\t\t)\n\t\t\t\tconst row = data.results[0]\n\t\t\t\treturn row ? readRow(row, 0) : {}\n\t\t\t}\n\n\t\t\tif (q.granularity === 'day' && !breakdownDim) {\n\t\t\t\t// HogQL buckets in the timezone argument when given; without it PostHog falls back\n\t\t\t\t// to the project's own timezone, so the resolved reporting timezone (UTC included)\n\t\t\t\t// is always passed to keep day buckets deterministic across projects. The window\n\t\t\t\t// literals stay UTC instants (already aligned to the reporting-timezone day\n\t\t\t\t// boundary by the caller).\n\t\t\t\tconst dayExpr = `toStartOfDay(timestamp, ${sqlString(q.timezone ?? 'UTC')})`\n\t\t\t\tconst seriesSql = `SELECT ${dayExpr} AS day, ${selectMetrics.join(', ')} FROM events WHERE ${where.join(' AND ')} GROUP BY day ORDER BY day`\n\t\t\t\tconst [seriesData, totals] = await Promise.all([runSql(seriesSql), fetchTotals()])\n\t\t\t\tconst rows: AnalyticsRow[] = []\n\t\t\t\tfor (const row of seriesData.results) {\n\t\t\t\t\tconst ts = dayIso(String(row[0] ?? ''))\n\t\t\t\t\tif (ts) {\n\t\t\t\t\t\trows.push({ timestamp: ts, metrics: readRow(row, 1) })\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn { rows, totals, meta: { provider: 'posthog', fetchedAt } }\n\t\t\t}\n\n\t\t\tif (breakdownDim) {\n\t\t\t\tconst dimSql = DIMENSION_SQL[breakdownDim] as string\n\t\t\t\tconst sql = `SELECT ${dimSql} AS dim, ${selectMetrics.join(', ')} FROM events WHERE ${where.join(' AND ')} GROUP BY dim ORDER BY m0 DESC LIMIT ${q.limit ?? 100}`\n\t\t\t\tconst data = await runSql(sql)\n\t\t\t\tconst rows: AnalyticsRow[] = data.results.map((row) => ({\n\t\t\t\t\tdimensions: { [breakdownDim]: String(row[0] ?? '') },\n\t\t\t\t\tmetrics: readRow(row, 1),\n\t\t\t\t}))\n\t\t\t\treturn { rows, totals: undefined, meta: { provider: 'posthog', fetchedAt } }\n\t\t\t}\n\n\t\t\tconst totals = await fetchTotals()\n\t\t\treturn { rows: [{ metrics: totals }], totals, meta: { provider: 'posthog', fetchedAt } }\n\t\t},\n\t}\n}\n"],"mappings":";;;AA8BA,MAAM,WAAW;AAKjB,MAAM,sBAA0D;CAC/D,WAAW;CACX,UAAU;CACV,QAAQ;CACR,UAAU;AACX;AAKA,MAAM,iBAAqD;CAC1D,WAAW;CACX,UAAU;CACV,QAAQ;CACR,UAAU;CACV,QAAQ;AACT;AAEA,MAAM,gBAAuD;CAC5D,MAAM;CACN,OAAO;AACR;AAEA,MAAM,iBAAyC,IAAI,IAAI,OAAO,KAAK,cAAc,CAAgB;AACjG,MAAM,oBAA+C,IAAI,IACxD,OAAO,KAAK,aAAa,CAC1B;AAIA,MAAM,aAAa,UAClB,IAAI,MAAM,QAAQ,OAAO,MAAM,EAAE,QAAQ,MAAM,KAAK,EAAE;AAEvD,MAAM,sBAAsB,MAC3B,UAAU,EAAE,YAAY,EAAE,MAAM,GAAG,EAAE,EAAE,QAAQ,KAAK,GAAG,CAAC;AAQzD,SAAgB,QAAQ,QAAyC;CAChE,MAAM,OAAO,OAAO,QAAQ;CAiB5B,OAAO;EACN,IAAI;EACJ,OAAO;EACP,cAAA;GAhBA,cAAc;GACd,UAAU;GACV,YAAY;GACZ,gBAAgB;GAChB,iBAPuB,OAAO,oBAAoB,KAAA,IAAY,OAAO,kBAAkB;GAQvF,SAAS;GACT,YAAY;GACZ,iBAAiB;GACjB,WAAW;IAAE,mBAAmB;IAAK,iBAAiB;GAAK;GAC3D,gBAAgB;IAAE,UAAU;IAAK,WAAW;GAAK;GACjD,GAAI,OAAO,gBAAgB,EAAE,eAAe,KAAK,IAAI,CAAC;EAM3C;EACX,oBAAoB,QAAQ,OAAO,aAAa,OAAO,MAAM;EAC7D,MAAM,MAAM,GAAmB,KAA+C;GAC7E,MAAM,YAAY,EAAE,UAAU,IAAI,YAAY;GAC9C,MAAM,gBAAgB,EAAE,cAAc,CAAC,GAAG,MAAM,MAAM,cAAc,EAAE;GAGtE,MAAM,gBAAgB,EAAE,QAAQ,SAAS,QAAQ,KAAK,iBAAiB;GACvE,MAAM,YAAY,gBAAgB,iBAAiB;GACnD,MAAM,SAAS,EAAE,QAAQ,QAAQ,MAAM,UAAU,EAAE;GACnD,MAAM,QAAQ,CAAC,GAAG,IAAI,IAAI,OAAO,KAAK,MAAM,UAAU,EAAY,CAAC,CAAC;GAEpE,MAAM,QAAQ,CACb,2BAA2B,mBAAmB,EAAE,UAAU,KAAK,EAAE,IACjE,2BAA2B,mBAAmB,EAAE,UAAU,GAAG,EAAE,EAChE;GACA,IAAI,CAAC,eACJ,MAAM,QAAQ,qBAAqB;GAEpC,IAAI,EAAE,MACL,MAAM,KAAK,0BAA0B,UAAU,EAAE,IAAI,GAAG;GAEzD,IAAI,EAAE,UACL,MAAM,KAAK,sBAAsB,UAAU,EAAE,QAAQ,GAAG;GAEzD,IAAI,OAAO,iBAAiB,EAAE,UAAU,KAAA,GAGvC,MAAM,KAAK,cAAc,UAAU,OAAO,aAAa,EAAE,MAAM,UAAU,EAAE,KAAK,GAAG;GAEpF,MAAM,gBAAgB,MAAM,KAAK,MAAM,MAAM,GAAG,KAAK,OAAO,GAAG;GAE/D,MAAM,UAAU,QACf,UAAgC,GAAG,KAAK,gBAAgB,OAAO,UAAU,UAAU;IAClF,QAAQ;IACR,SAAS,EAAE,eAAe,UAAU,OAAO,SAAS;IACpD,MAAM,EAAE,OAAO;KAAE,MAAM;KAAc,OAAO;IAAI,EAAE;IAClD,QAAQ,IAAI;IACZ,UAAU;GACX,CAAC;GAEF,MAAM,WAAW,KAAgB,WAAuD;IACvF,MAAM,MAA0C,CAAC;IACjD,KAAK,MAAM,KAAK,QAAQ;KACvB,MAAM,MAAM,MAAM,QAAQ,UAAU,EAAY;KAChD,IAAI,KAAK,OAAO,IAAI,SAAS,QAAQ,CAAC;IACvC;IACA,OAAO;GACR;GAEA,MAAM,cAAc,YAAyD;IAI5E,MAAM,OAAM,MAHO,OAClB,UAAU,cAAc,KAAK,IAAI,EAAE,qBAAqB,MAAM,KAAK,OAAO,GAC3E,GACiB,QAAQ;IACzB,OAAO,MAAM,QAAQ,KAAK,CAAC,IAAI,CAAC;GACjC;GAEA,IAAI,EAAE,gBAAgB,SAAS,CAAC,cAAc;IAO7C,MAAM,YAAY,UAAU,2BADe,UAAU,EAAE,YAAY,KAAK,EAAE,GACtC,WAAW,cAAc,KAAK,IAAI,EAAE,qBAAqB,MAAM,KAAK,OAAO,EAAE;IACjH,MAAM,CAAC,YAAY,UAAU,MAAM,QAAQ,IAAI,CAAC,OAAO,SAAS,GAAG,YAAY,CAAC,CAAC;IACjF,MAAM,OAAuB,CAAC;IAC9B,KAAK,MAAM,OAAO,WAAW,SAAS;KACrC,MAAM,KAAK,OAAO,OAAO,IAAI,MAAM,EAAE,CAAC;KACtC,IAAI,IACH,KAAK,KAAK;MAAE,WAAW;MAAI,SAAS,QAAQ,KAAK,CAAC;KAAE,CAAC;IAEvD;IACA,OAAO;KAAE;KAAM;KAAQ,MAAM;MAAE,UAAU;MAAW;KAAU;IAAE;GACjE;GAEA,IAAI,cAQH,OAAO;IAAE,OAJoB,MADV,OAAO,UAFX,cAAc,cACA,WAAW,cAAc,KAAK,IAAI,EAAE,qBAAqB,MAAM,KAAK,OAAO,EAAE,uCAAuC,EAAE,SAAS,KAC/H,GACK,QAAQ,KAAK,SAAS;KACvD,YAAY,GAAG,eAAe,OAAO,IAAI,MAAM,EAAE,EAAE;KACnD,SAAS,QAAQ,KAAK,CAAC;IACxB,EACY;IAAG,QAAQ,KAAA;IAAW,MAAM;KAAE,UAAU;KAAW;IAAU;GAAE;GAG5E,MAAM,SAAS,MAAM,YAAY;GACjC,OAAO;IAAE,MAAM,CAAC,EAAE,SAAS,OAAO,CAAC;IAAG;IAAQ,MAAM;KAAE,UAAU;KAAW;IAAU;GAAE;EACxF;CACD;AACD"}
@@ -12,6 +12,6 @@ const dayIso = (value) => {
12
12
  return Number.isNaN(t) ? null : new Date(t).toISOString();
13
13
  };
14
14
  //#endregion
15
- export { dayIso as t };
15
+ export { dayIso };
16
16
 
17
- //# sourceMappingURL=series-zytbzPoc.js.map
17
+ //# sourceMappingURL=series.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"series.js","names":[],"sources":["../../src/adapters/series.ts"],"sourcesContent":["/**\n * Normalize a provider's day label to a UTC-day ISO string. Takes any value whose first\n * 10 chars are `YYYY-MM-DD` (a bare date, or a datetime like `2026-06-23 14:00:00`).\n * Returns null for an unparseable value so the caller can skip that one row rather than\n * emit a broken timestamp.\n */\nexport const dayIso = (value: string): string | null => {\n\tconst date = value.slice(0, 10)\n\t// V8's Date.parse leniently accepts year-only and year-month strings, so require a\n\t// full YYYY-MM-DD before parsing or a short value would resolve to Jan 1, not null.\n\tif (date.length !== 10) {\n\t\treturn null\n\t}\n\tconst t = Date.parse(`${date}T00:00:00.000Z`)\n\treturn Number.isNaN(t) ? null : new Date(t).toISOString()\n}\n"],"mappings":";;;;;;;AAMA,MAAa,UAAU,UAAiC;CACvD,MAAM,OAAO,MAAM,MAAM,GAAG,EAAE;CAG9B,IAAI,KAAK,WAAW,IACnB,OAAO;CAER,MAAM,IAAI,KAAK,MAAM,GAAG,KAAK,eAAe;CAC5C,OAAO,OAAO,MAAM,CAAC,IAAI,OAAO,IAAI,KAAK,CAAC,EAAE,YAAY;AACzD"}
@@ -0,0 +1,18 @@
1
+ import { AnalyticsAdapter } from "../../core/contract.js";
2
+
3
+ //#region src/adapters/umami/umami.d.ts
4
+ interface UmamiConfig {
5
+ websiteId: string;
6
+ /** Umami Cloud API key (sent as x-umami-api-key). */
7
+ apiKey?: string;
8
+ /** Self-hosted bearer token (from POST /api/auth/login). */
9
+ token?: string;
10
+ /** API base URL. Defaults to Umami Cloud (https://api.umami.is/v1). Self-hosted is e.g. https://site/api. */
11
+ host?: string;
12
+ /** Maximum days of historical data. Defaults to 730. Pass null to disable clamping. */
13
+ maxLookbackDays?: number | null;
14
+ }
15
+ declare function umami(config: UmamiConfig): AnalyticsAdapter;
16
+ //#endregion
17
+ export { UmamiConfig, umami };
18
+ //# sourceMappingURL=umami.d.ts.map