@10x-media/analytics 1.0.0-beta.7 → 1.0.0-beta.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (368) hide show
  1. package/CHANGELOG.md +118 -0
  2. package/LICENSE +21 -21
  3. package/README.md +10 -4
  4. package/dist/adapters/ga4/eventName.d.ts +15 -0
  5. package/dist/adapters/ga4/eventName.js +19 -0
  6. package/dist/adapters/ga4/eventName.js.map +1 -0
  7. package/dist/adapters/ga4/ga4.d.ts +5 -0
  8. package/dist/adapters/ga4/ga4.js +179 -70
  9. package/dist/adapters/ga4/ga4.js.map +1 -1
  10. package/dist/adapters/ga4/measurementId.js +15 -0
  11. package/dist/adapters/ga4/measurementId.js.map +1 -0
  12. package/dist/adapters/goalRead.js +126 -0
  13. package/dist/adapters/goalRead.js.map +1 -0
  14. package/dist/adapters/plausible/plausible.d.ts +15 -0
  15. package/dist/adapters/plausible/plausible.js +112 -43
  16. package/dist/adapters/plausible/plausible.js.map +1 -1
  17. package/dist/adapters/posthog/posthog.js +47 -25
  18. package/dist/adapters/posthog/posthog.js.map +1 -1
  19. package/dist/adapters/umami/umami.d.ts +8 -0
  20. package/dist/adapters/umami/umami.js +237 -28
  21. package/dist/adapters/umami/umami.js.map +1 -1
  22. package/dist/capture/slots.js +16 -5
  23. package/dist/capture/slots.js.map +1 -1
  24. package/dist/capture/trackerConfig.d.ts +1 -0
  25. package/dist/capture/trackerConfig.js +28 -3
  26. package/dist/capture/trackerConfig.js.map +1 -1
  27. package/dist/charts/BarList.d.ts +15 -1
  28. package/dist/charts/BarList.js +41 -19
  29. package/dist/charts/BarList.js.map +1 -1
  30. package/dist/charts/TrendChart.d.ts +16 -3
  31. package/dist/charts/TrendChart.js +172 -106
  32. package/dist/charts/TrendChart.js.map +1 -1
  33. package/dist/charts/bars.d.ts +2 -0
  34. package/dist/charts/bars.js +2 -1
  35. package/dist/charts/bars.js.map +1 -1
  36. package/dist/charts/bucket.js +10 -1
  37. package/dist/charts/bucket.js.map +1 -1
  38. package/dist/charts/spline.js +2 -2
  39. package/dist/charts/spline.js.map +1 -1
  40. package/dist/charts/styles.js +18 -1
  41. package/dist/charts/styles.js.map +1 -1
  42. package/dist/core/cacheKey.js +24 -2
  43. package/dist/core/cacheKey.js.map +1 -1
  44. package/dist/core/capabilities.js +7 -2
  45. package/dist/core/capabilities.js.map +1 -1
  46. package/dist/core/capture.d.ts +1 -1
  47. package/dist/core/contract.d.ts +46 -9
  48. package/dist/core/contract.js +29 -1
  49. package/dist/core/contract.js.map +1 -1
  50. package/dist/core/granularity.js +1 -1
  51. package/dist/core/options.d.ts +62 -7
  52. package/dist/core/options.js +63 -4
  53. package/dist/core/options.js.map +1 -1
  54. package/dist/core/scopedRead.js +33 -23
  55. package/dist/core/scopedRead.js.map +1 -1
  56. package/dist/core/serverEvent.d.ts +44 -0
  57. package/dist/core/serverEvent.js +12 -0
  58. package/dist/core/serverEvent.js.map +1 -0
  59. package/dist/exports/adapters/ga4.d.ts +2 -1
  60. package/dist/exports/adapters/ga4.js +2 -1
  61. package/dist/exports/client.d.ts +12 -3
  62. package/dist/exports/client.js +9 -1
  63. package/dist/exports/rsc.d.ts +7 -2
  64. package/dist/exports/rsc.js +6 -3
  65. package/dist/exports/tracker.d.ts +3 -2
  66. package/dist/exports/tracker.js +2 -1
  67. package/dist/exports/types.d.ts +13 -4
  68. package/dist/exports/types.js +3 -2
  69. package/dist/fields/AnalyticsPanelClient.js +1 -1
  70. package/dist/fields/AnalyticsPanelField.js +1 -1
  71. package/dist/fields/AnalyticsStatField.js +2 -2
  72. package/dist/fields/config/FilterDimensionSelectField.d.ts +14 -0
  73. package/dist/fields/config/FilterDimensionSelectField.js +77 -0
  74. package/dist/fields/config/FilterDimensionSelectField.js.map +1 -0
  75. package/dist/fields/config/FilterOperatorSelectField.d.ts +14 -0
  76. package/dist/fields/config/FilterOperatorSelectField.js +75 -0
  77. package/dist/fields/config/FilterOperatorSelectField.js.map +1 -0
  78. package/dist/fields/config/MetricSelectField.js +3 -3
  79. package/dist/fields/config/MetricSelectField.js.map +1 -1
  80. package/dist/fields/config/SourceSelectField.js +3 -3
  81. package/dist/fields/config/SourceSelectField.js.map +1 -1
  82. package/dist/fields/config/fetchSources.d.ts +5 -1
  83. package/dist/fields/config/sourcesState.js +19 -3
  84. package/dist/fields/config/sourcesState.js.map +1 -1
  85. package/dist/fields/config/useAnalyticsSources.d.ts +8 -3
  86. package/dist/fields/config/useAnalyticsSources.js +9 -6
  87. package/dist/fields/config/useAnalyticsSources.js.map +1 -1
  88. package/dist/fields/config/useFilterCapabilities.d.ts +28 -0
  89. package/dist/fields/config/useFilterCapabilities.js +52 -0
  90. package/dist/fields/config/useFilterCapabilities.js.map +1 -0
  91. package/dist/fields/readForDocument.d.ts +5 -0
  92. package/dist/fields/readForDocument.js +21 -9
  93. package/dist/fields/readForDocument.js.map +1 -1
  94. package/dist/goals/GoalSelectField.d.ts +7 -0
  95. package/dist/goals/GoalSelectField.js +77 -0
  96. package/dist/goals/GoalSelectField.js.map +1 -0
  97. package/dist/goals/collection.js +250 -0
  98. package/dist/goals/collection.js.map +1 -0
  99. package/dist/goals/currency.js +14 -0
  100. package/dist/goals/currency.js.map +1 -0
  101. package/dist/goals/fetchGoals.d.ts +18 -0
  102. package/dist/goals/fetchGoals.js +29 -0
  103. package/dist/goals/fetchGoals.js.map +1 -0
  104. package/dist/goals/goalField.d.ts +31 -0
  105. package/dist/goals/goalField.js +56 -0
  106. package/dist/goals/goalField.js.map +1 -0
  107. package/dist/goals/goalsEndpoint.d.ts +1 -0
  108. package/dist/goals/goalsEndpoint.js +55 -0
  109. package/dist/goals/goalsEndpoint.js.map +1 -0
  110. package/dist/goals/resolver.d.ts +8 -0
  111. package/dist/goals/resolver.js +147 -0
  112. package/dist/goals/resolver.js.map +1 -0
  113. package/dist/goals/trackGoalAction.d.ts +74 -0
  114. package/dist/goals/trackGoalAction.js +139 -0
  115. package/dist/goals/trackGoalAction.js.map +1 -0
  116. package/dist/goals/useAnalyticsGoals.d.ts +20 -0
  117. package/dist/goals/useAnalyticsGoals.js +67 -0
  118. package/dist/goals/useAnalyticsGoals.js.map +1 -0
  119. package/dist/index.d.ts +12 -3
  120. package/dist/index.js +75 -11
  121. package/dist/index.js.map +1 -1
  122. package/dist/native/collections/events.js +36 -0
  123. package/dist/native/collections/events.js.map +1 -1
  124. package/dist/native/eventScan.js +25 -0
  125. package/dist/native/eventScan.js.map +1 -0
  126. package/dist/native/ingest/browser.js +47 -0
  127. package/dist/native/ingest/browser.js.map +1 -0
  128. package/dist/native/ingest/device.js +11 -3
  129. package/dist/native/ingest/device.js.map +1 -1
  130. package/dist/native/ingest/endpoint.d.ts +1 -0
  131. package/dist/native/ingest/endpoint.js +2 -17
  132. package/dist/native/ingest/endpoint.js.map +1 -1
  133. package/dist/native/ingest/flushBatch.js +26 -26
  134. package/dist/native/ingest/flushBatch.js.map +1 -1
  135. package/dist/native/ingest/language.js +14 -0
  136. package/dist/native/ingest/language.js.map +1 -0
  137. package/dist/native/ingest/normalizeEvent.d.ts +26 -0
  138. package/dist/native/ingest/normalizeEvent.js +35 -7
  139. package/dist/native/ingest/normalizeEvent.js.map +1 -1
  140. package/dist/native/ingest/referrer.js +48 -0
  141. package/dist/native/ingest/referrer.js.map +1 -0
  142. package/dist/native/ingest/serverTrack.d.ts +20 -0
  143. package/dist/native/ingest/serverTrack.js +100 -0
  144. package/dist/native/ingest/serverTrack.js.map +1 -0
  145. package/dist/native/ingest/source.d.ts +7 -0
  146. package/dist/native/ingest/source.js +139 -14
  147. package/dist/native/ingest/source.js.map +1 -1
  148. package/dist/native/ingest/utm.js +33 -0
  149. package/dist/native/ingest/utm.js.map +1 -0
  150. package/dist/native/ingest/validate.js +27 -0
  151. package/dist/native/ingest/validate.js.map +1 -0
  152. package/dist/native/nativeAdapter.d.ts +1 -1
  153. package/dist/native/nativeAdapter.js +53 -36
  154. package/dist/native/nativeAdapter.js.map +1 -1
  155. package/dist/native/query/eventAgg.js +14 -1
  156. package/dist/native/query/eventAgg.js.map +1 -1
  157. package/dist/native/retention/pruneTask.js +1 -1
  158. package/dist/native/rollups/bucketKey.js +15 -0
  159. package/dist/native/rollups/bucketKey.js.map +1 -0
  160. package/dist/native/rollups/bumpRollups.js +116 -0
  161. package/dist/native/rollups/bumpRollups.js.map +1 -0
  162. package/dist/native/rollups/deltas.js +30 -15
  163. package/dist/native/rollups/deltas.js.map +1 -1
  164. package/dist/native/rollups/insertManyIfNew.js +93 -0
  165. package/dist/native/rollups/insertManyIfNew.js.map +1 -0
  166. package/dist/next/captureRewrites.d.ts +3 -2
  167. package/dist/next/captureRewrites.js +3 -2
  168. package/dist/next/captureRewrites.js.map +1 -1
  169. package/dist/plugin/documentEndpoint.js +52 -15
  170. package/dist/plugin/documentEndpoint.js.map +1 -1
  171. package/dist/plugin/goalHint.d.ts +1 -0
  172. package/dist/plugin/goalHint.js +24 -0
  173. package/dist/plugin/goalHint.js.map +1 -0
  174. package/dist/plugin/paths.js +5 -1
  175. package/dist/plugin/paths.js.map +1 -1
  176. package/dist/plugin/queryEndpoint.js +120 -0
  177. package/dist/plugin/queryEndpoint.js.map +1 -0
  178. package/dist/plugin/readContextForRequest.js +71 -0
  179. package/dist/plugin/readContextForRequest.js.map +1 -0
  180. package/dist/plugin/realtimeEndpoint.js +43 -15
  181. package/dist/plugin/realtimeEndpoint.js.map +1 -1
  182. package/dist/plugin/responses.js +17 -0
  183. package/dist/plugin/responses.js.map +1 -0
  184. package/dist/plugin/runtime.js +31 -1
  185. package/dist/plugin/runtime.js.map +1 -1
  186. package/dist/plugin/scopeFieldBoot.js +22 -0
  187. package/dist/plugin/scopeFieldBoot.js.map +1 -0
  188. package/dist/plugin/sourcesEndpoint.js +21 -52
  189. package/dist/plugin/sourcesEndpoint.js.map +1 -1
  190. package/dist/plugin/warmTask.js +0 -0
  191. package/dist/plugin/warmTask.js.map +1 -1
  192. package/dist/providers/collection.js +29 -13
  193. package/dist/providers/collection.js.map +1 -1
  194. package/dist/providers/factory.js +4 -2
  195. package/dist/providers/factory.js.map +1 -1
  196. package/dist/providers/resolver.js.map +1 -1
  197. package/dist/query/dates.js +64 -0
  198. package/dist/query/dates.js.map +1 -0
  199. package/dist/query/errors.d.ts +17 -0
  200. package/dist/query/errors.js +10 -0
  201. package/dist/query/errors.js.map +1 -0
  202. package/dist/query/fetchQuery.d.ts +59 -0
  203. package/dist/query/fetchQuery.js +110 -0
  204. package/dist/query/fetchQuery.js.map +1 -0
  205. package/dist/query/parse.d.ts +22 -0
  206. package/dist/query/parse.js +168 -0
  207. package/dist/query/parse.js.map +1 -0
  208. package/dist/query/response.d.ts +39 -0
  209. package/dist/query/response.js +11 -0
  210. package/dist/query/response.js.map +1 -0
  211. package/dist/surfacing/engine.js +1 -1
  212. package/dist/surfacing/engine.js.map +1 -1
  213. package/dist/testing/memoryAdapter.js +0 -1
  214. package/dist/testing/memoryAdapter.js.map +1 -1
  215. package/dist/timeframe/tz.js +17 -6
  216. package/dist/timeframe/tz.js.map +1 -1
  217. package/dist/tracker/createTracker.js +13 -1
  218. package/dist/tracker/createTracker.js.map +1 -1
  219. package/dist/tracker/sinks/ga4.d.ts +21 -0
  220. package/dist/tracker/sinks/ga4.js +26 -0
  221. package/dist/tracker/sinks/ga4.js.map +1 -0
  222. package/dist/tracker/types.d.ts +5 -0
  223. package/dist/translations/ar.js +127 -1
  224. package/dist/translations/ar.js.map +1 -1
  225. package/dist/translations/de.js +127 -1
  226. package/dist/translations/de.js.map +1 -1
  227. package/dist/translations/en.js +127 -1
  228. package/dist/translations/en.js.map +1 -1
  229. package/dist/translations/es.js +127 -1
  230. package/dist/translations/es.js.map +1 -1
  231. package/dist/translations/fr.js +127 -1
  232. package/dist/translations/fr.js.map +1 -1
  233. package/dist/translations/id.js +127 -1
  234. package/dist/translations/id.js.map +1 -1
  235. package/dist/translations/keys.d.ts +126 -0
  236. package/dist/translations/keys.js +127 -1
  237. package/dist/translations/keys.js.map +1 -1
  238. package/dist/translations/ko.js +127 -1
  239. package/dist/translations/ko.js.map +1 -1
  240. package/dist/translations/metricKeys.js +8 -2
  241. package/dist/translations/metricKeys.js.map +1 -1
  242. package/dist/translations/pt.js +127 -1
  243. package/dist/translations/pt.js.map +1 -1
  244. package/dist/translations/ru.js +127 -1
  245. package/dist/translations/ru.js.map +1 -1
  246. package/dist/translations/server.js.map +1 -1
  247. package/dist/translations/uk.js +127 -1
  248. package/dist/translations/uk.js.map +1 -1
  249. package/dist/translations/zh.js +127 -1
  250. package/dist/translations/zh.js.map +1 -1
  251. package/dist/view/AnalyticsNavLink.d.ts +19 -0
  252. package/dist/view/AnalyticsNavLink.js +40 -0
  253. package/dist/view/AnalyticsNavLink.js.map +1 -0
  254. package/dist/view/AnalyticsView.d.ts +23 -0
  255. package/dist/view/AnalyticsView.js +45 -0
  256. package/dist/view/AnalyticsView.js.map +1 -0
  257. package/dist/view/AnalyticsViewClient.d.ts +15 -0
  258. package/dist/view/AnalyticsViewClient.js +200 -0
  259. package/dist/view/AnalyticsViewClient.js.map +1 -0
  260. package/dist/view/authRedirect.js +32 -0
  261. package/dist/view/authRedirect.js.map +1 -0
  262. package/dist/view/conversionRate.js +18 -0
  263. package/dist/view/conversionRate.js.map +1 -0
  264. package/dist/view/dayRange.js +68 -0
  265. package/dist/view/dayRange.js.map +1 -0
  266. package/dist/view/gating.d.ts +1 -0
  267. package/dist/view/gating.js +142 -0
  268. package/dist/view/gating.js.map +1 -0
  269. package/dist/view/labels.js +64 -0
  270. package/dist/view/labels.js.map +1 -0
  271. package/dist/view/registerView.js +48 -0
  272. package/dist/view/registerView.js.map +1 -0
  273. package/dist/view/sections/Breakdowns.js +197 -0
  274. package/dist/view/sections/Breakdowns.js.map +1 -0
  275. package/dist/view/sections/EmptyStates.js +92 -0
  276. package/dist/view/sections/EmptyStates.js.map +1 -0
  277. package/dist/view/sections/FilterChips.js +46 -0
  278. package/dist/view/sections/FilterChips.js.map +1 -0
  279. package/dist/view/sections/GoalsPanel.js +82 -0
  280. package/dist/view/sections/GoalsPanel.js.map +1 -0
  281. package/dist/view/sections/OverviewCards.js +65 -0
  282. package/dist/view/sections/OverviewCards.js.map +1 -0
  283. package/dist/view/sections/RealtimeStrip.js +80 -0
  284. package/dist/view/sections/RealtimeStrip.js.map +1 -0
  285. package/dist/view/sections/Toolbar.js +186 -0
  286. package/dist/view/sections/Toolbar.js.map +1 -0
  287. package/dist/view/sections/Trend.js +125 -0
  288. package/dist/view/sections/Trend.js.map +1 -0
  289. package/dist/view/sections/styles.js +74 -0
  290. package/dist/view/sections/styles.js.map +1 -0
  291. package/dist/view/state.js +211 -0
  292. package/dist/view/state.js.map +1 -0
  293. package/dist/view/useViewQueries.js +153 -0
  294. package/dist/view/useViewQueries.js.map +1 -0
  295. package/dist/view/viewProps.d.ts +40 -0
  296. package/dist/view/viewProps.js +90 -0
  297. package/dist/view/viewProps.js.map +1 -0
  298. package/dist/widgets/AnalyticsBreakdownWidget.d.ts +2 -1
  299. package/dist/widgets/AnalyticsBreakdownWidget.js +78 -11
  300. package/dist/widgets/AnalyticsBreakdownWidget.js.map +1 -1
  301. package/dist/widgets/AnalyticsGoalsWidget.d.ts +14 -0
  302. package/dist/widgets/AnalyticsGoalsWidget.js +196 -0
  303. package/dist/widgets/AnalyticsGoalsWidget.js.map +1 -0
  304. package/dist/widgets/AnalyticsMetricWidget.d.ts +2 -1
  305. package/dist/widgets/AnalyticsMetricWidget.js +63 -13
  306. package/dist/widgets/AnalyticsMetricWidget.js.map +1 -1
  307. package/dist/widgets/AnalyticsRealtimeWidget.d.ts +2 -1
  308. package/dist/widgets/AnalyticsRealtimeWidget.js +44 -22
  309. package/dist/widgets/AnalyticsRealtimeWidget.js.map +1 -1
  310. package/dist/widgets/AnalyticsTrendWidget.d.ts +2 -1
  311. package/dist/widgets/AnalyticsTrendWidget.js +79 -16
  312. package/dist/widgets/AnalyticsTrendWidget.js.map +1 -1
  313. package/dist/widgets/RealtimeCounter.d.ts +4 -0
  314. package/dist/widgets/RealtimeCounter.js +10 -1
  315. package/dist/widgets/RealtimeCounter.js.map +1 -1
  316. package/dist/widgets/WidgetViewLink.js +17 -0
  317. package/dist/widgets/WidgetViewLink.js.map +1 -0
  318. package/dist/widgets/breakdownTypes.js +28 -1
  319. package/dist/widgets/breakdownTypes.js.map +1 -1
  320. package/dist/widgets/cardChrome.js +31 -7
  321. package/dist/widgets/cardChrome.js.map +1 -1
  322. package/dist/widgets/comparison.js +15 -1
  323. package/dist/widgets/comparison.js.map +1 -1
  324. package/dist/widgets/defaults.d.ts +6 -2
  325. package/dist/widgets/defaults.js +72 -25
  326. package/dist/widgets/defaults.js.map +1 -1
  327. package/dist/widgets/filterCaption.js +27 -0
  328. package/dist/widgets/filterCaption.js.map +1 -0
  329. package/dist/widgets/filterField.d.ts +19 -0
  330. package/dist/widgets/filterField.js +75 -0
  331. package/dist/widgets/filterField.js.map +1 -0
  332. package/dist/widgets/prepareWidgetRead.d.ts +7 -0
  333. package/dist/widgets/prepareWidgetRead.js +74 -0
  334. package/dist/widgets/prepareWidgetRead.js.map +1 -0
  335. package/dist/widgets/range.js +43 -12
  336. package/dist/widgets/range.js.map +1 -1
  337. package/dist/widgets/readForWidget.d.ts +24 -2
  338. package/dist/widgets/readForWidget.js +34 -48
  339. package/dist/widgets/readForWidget.js.map +1 -1
  340. package/dist/widgets/readForWidgetBreakdown.d.ts +32 -1
  341. package/dist/widgets/readForWidgetBreakdown.js +32 -42
  342. package/dist/widgets/readForWidgetBreakdown.js.map +1 -1
  343. package/dist/widgets/readForWidgetGoals.d.ts +67 -0
  344. package/dist/widgets/readForWidgetGoals.js +140 -0
  345. package/dist/widgets/readForWidgetGoals.js.map +1 -0
  346. package/dist/widgets/readForWidgetRealtime.d.ts +8 -0
  347. package/dist/widgets/readForWidgetRealtime.js +21 -20
  348. package/dist/widgets/readForWidgetRealtime.js.map +1 -1
  349. package/dist/widgets/readForWidgetSeries.d.ts +24 -1
  350. package/dist/widgets/readForWidgetSeries.js +63 -56
  351. package/dist/widgets/readForWidgetSeries.js.map +1 -1
  352. package/dist/widgets/readMeta.js +18 -0
  353. package/dist/widgets/readMeta.js.map +1 -0
  354. package/dist/widgets/registerWidgets.js +53 -7
  355. package/dist/widgets/registerWidgets.js.map +1 -1
  356. package/dist/widgets/types.d.ts +15 -0
  357. package/dist/widgets/types.js +12 -1
  358. package/dist/widgets/types.js.map +1 -1
  359. package/dist/widgets/viewLink.d.ts +22 -0
  360. package/dist/widgets/viewLink.js +86 -0
  361. package/dist/widgets/viewLink.js.map +1 -0
  362. package/package.json +9 -4
  363. package/dist/native/rollups/applyDistinctDeltas.js +0 -9
  364. package/dist/native/rollups/applyDistinctDeltas.js.map +0 -1
  365. package/dist/native/rollups/bumpRollup.js +0 -73
  366. package/dist/native/rollups/bumpRollup.js.map +0 -1
  367. package/dist/native/rollups/insertIfNew.js +0 -19
  368. package/dist/native/rollups/insertIfNew.js.map +0 -1
@@ -1,5 +1,32 @@
1
+ import { zonedCalendarDay } from "../../timeframe/tz.js";
2
+ import { MEASUREMENT_ID_PATTERN } from "./measurementId.js";
3
+ import { emptyGoalBreakdown, goalHint, hintSlugs, mergeGoalRows, mergeGoalTotals, providerMetricKeys, readGoalPair, splitGoalMetrics } from "../goalRead.js";
1
4
  import { dayIso } from "../series.js";
5
+ import { ga4EventName } from "./eventName.js";
2
6
  //#region src/adapters/ga4/ga4.ts
7
+ /**
8
+ * Google's documented install snippet (https://developers.google.com/tag-platform/gtagjs/install):
9
+ * the inline publishes `dataLayer` and `gtag` and configures the measurement id, then the tag
10
+ * loads from googletagmanager.com. Inline first is Google's own ordering for consent mode, and
11
+ * it leaves the queue defined even when the tag itself is blocked. The tag is served from
12
+ * Google's CDN with the id in the query string, so there is nothing to proxy and `routes`
13
+ * stays empty; the snippet is rendered from an absolute `src` and the slot's proxy mount
14
+ * answers 404.
15
+ */
16
+ function buildCapture(measurementId) {
17
+ const id = JSON.stringify(measurementId);
18
+ return {
19
+ proxy: { routes: [] },
20
+ snippet: () => ({ scripts: [{ inline: `window.dataLayer=window.dataLayer||[];function gtag(){dataLayer.push(arguments)}gtag("js",new Date());gtag("config",${id})` }, {
21
+ src: `https://www.googletagmanager.com/gtag/js?id=${encodeURIComponent(measurementId)}`,
22
+ async: true
23
+ }] }),
24
+ client: {
25
+ kind: "ga4",
26
+ measurementId
27
+ }
28
+ };
29
+ }
3
30
  const METRIC_MAP = {
4
31
  pageviews: "screenPageViews",
5
32
  visitors: "totalUsers",
@@ -27,10 +54,54 @@ const DIMENSION_MAP = {
27
54
  region: "region",
28
55
  city: "city",
29
56
  language: "language",
30
- event: "eventName"
57
+ event: "eventName",
58
+ goal: "eventName"
59
+ };
60
+ /**
61
+ * Metrics GA4 answers only for a goal-restricted read. A goal matches the GA4 event named by
62
+ * its normalized slug, since GA4 refuses the kebab-case slug itself. `keyEvents` counts
63
+ * events the property itself marks as key events, so an event that is a goal here but not
64
+ * marked there reports 0.
65
+ */
66
+ const GOAL_METRICS = new Set(["conversions"]);
67
+ /**
68
+ * The hint's slugs keyed by the GA4 event name each one normalizes to, which is both the
69
+ * `eventName` list the goal request sends and the way its rows map back. Two slugs can
70
+ * normalize to one GA4 event, which GA4 counts once: the first hint slug owns those rows.
71
+ */
72
+ const goalSlugsByEventName = (slugs) => {
73
+ const byName = /* @__PURE__ */ new Map();
74
+ for (const slug of slugs) {
75
+ const name = ga4EventName(slug);
76
+ if (!byName.has(name)) byName.set(name, slug);
77
+ }
78
+ return byName;
79
+ };
80
+ /**
81
+ * FULL_REGEXP is a full match, so a pattern has to cover the whole value (`/docs/.*`, not
82
+ * `^/docs`). PARTIAL_REGEXP exists but is not the contract's `matches`.
83
+ */
84
+ const MATCH_TYPE_MAP = {
85
+ eq: "EXACT",
86
+ contains: "CONTAINS",
87
+ matches: "FULL_REGEXP"
31
88
  };
89
+ const CASE_SENSITIVE = {
90
+ EXACT: true,
91
+ CONTAINS: false,
92
+ FULL_REGEXP: true
93
+ };
94
+ const stringFilter = (fieldName, matchType, value) => ({ filter: {
95
+ fieldName,
96
+ stringFilter: {
97
+ matchType,
98
+ value,
99
+ caseSensitive: CASE_SENSITIVE[matchType]
100
+ }
101
+ } });
32
102
  const ga4Metrics = new Set(Object.keys(METRIC_MAP));
33
103
  const ga4Dimensions = new Set(Object.keys(DIMENSION_MAP));
104
+ const ga4Filters = new Set([...ga4Dimensions].filter((dimension) => dimension !== "goal"));
34
105
  const toContractValue = (metric, raw) => {
35
106
  if (metric === "avgDuration") return Math.round(raw * 1e3);
36
107
  if (metric === "bounceRate") return Math.round(raw * 100);
@@ -40,13 +111,16 @@ function ga4(config) {
40
111
  const capabilities = {
41
112
  perPageQuery: true,
42
113
  realtime: false,
43
- comparison: false,
44
114
  minGranularity: "day",
45
115
  maxLookbackDays: config.maxLookbackDays !== void 0 ? config.maxLookbackDays : 425,
46
116
  metrics: ga4Metrics,
47
117
  dimensions: ga4Dimensions,
48
- filters: ga4Dimensions,
49
- filterOperators: new Set(["eq"]),
118
+ filters: ga4Filters,
119
+ filterOperators: new Set([
120
+ "eq",
121
+ "contains",
122
+ "matches"
123
+ ]),
50
124
  batchPageReport: true,
51
125
  rateLimit: {
52
126
  maxConcurrent: 10,
@@ -74,122 +148,157 @@ function ga4(config) {
74
148
  })();
75
149
  return clientPromise;
76
150
  };
151
+ const measurementId = config.measurementId;
77
152
  return {
78
153
  id: "ga4",
79
154
  label: "Google Analytics 4",
80
155
  capabilities,
156
+ ...measurementId && MEASUREMENT_ID_PATTERN.test(measurementId) ? { capture: buildCapture(measurementId) } : {},
81
157
  isConfigured: () => Boolean(config.propertyId && config.credentials?.client_email && config.credentials?.private_key),
82
158
  async query(q, _ctx) {
83
159
  const fetchedAt = q.dateRange.end.toISOString();
84
- const wanted = q.metrics.filter((m) => METRIC_MAP[m]);
85
- const providerMetrics = [...new Set(wanted.map((m) => METRIC_MAP[m]))];
86
160
  const dims = (q.dimensions ?? []).filter((d) => DIMENSION_MAP[d]);
161
+ const goalBreakdown = dims.includes("goal");
162
+ const hint = goalHint(q);
163
+ const slugs = hintSlugs(hint);
164
+ const empty = goalBreakdown ? emptyGoalBreakdown({
165
+ provider: "ga4",
166
+ q,
167
+ hint
168
+ }) : null;
169
+ if (empty) return empty;
170
+ const { siteMetrics, goalMetrics, unresolved } = splitGoalMetrics({
171
+ wanted: q.metrics.filter((m) => METRIC_MAP[m]),
172
+ goalOnly: GOAL_METRICS,
173
+ goalBreakdown,
174
+ hint
175
+ });
176
+ const siteKeys = providerMetricKeys(siteMetrics, METRIC_MAP);
177
+ const goalKeys = providerMetricKeys(goalMetrics, METRIC_MAP);
87
178
  const providerDims = [...new Set(dims.map((d) => DIMENSION_MAP[d]))];
88
- const readRow = (row) => {
179
+ let goalsFailed = false;
180
+ const meta = () => ({
181
+ provider: "ga4",
182
+ fetchedAt,
183
+ ...unresolved || goalsFailed ? { goalsUnresolved: true } : {}
184
+ });
185
+ const readMetrics = (ms, keys, row) => {
89
186
  const out = {};
90
- for (const m of wanted) {
91
- const idx = providerMetrics.indexOf(METRIC_MAP[m]);
187
+ for (const m of ms) {
188
+ const idx = keys.indexOf(METRIC_MAP[m]);
92
189
  out[m] = toContractValue(m, Number(row.metricValues?.[idx]?.value ?? 0));
93
190
  }
94
191
  return out;
95
192
  };
96
193
  const filterExprs = [];
97
- if (q.path) filterExprs.push({ filter: {
98
- fieldName: "pagePath",
99
- stringFilter: {
100
- matchType: "EXACT",
101
- value: q.path
102
- }
103
- } });
104
- if (q.hostname) filterExprs.push({ filter: {
105
- fieldName: "hostName",
106
- stringFilter: {
107
- matchType: "EXACT",
108
- value: q.hostname
109
- }
110
- } });
194
+ if (q.path) filterExprs.push(stringFilter("pagePath", "EXACT", q.path));
195
+ if (q.hostname) filterExprs.push(stringFilter("hostName", "EXACT", q.hostname));
111
196
  for (const filter of q.filters ?? []) {
112
- const fieldName = DIMENSION_MAP[filter.dimension];
113
- if (!fieldName || filter.operator !== "eq") continue;
114
- filterExprs.push({ filter: {
115
- fieldName,
116
- stringFilter: {
117
- matchType: "EXACT",
118
- value: filter.value
119
- }
120
- } });
197
+ const fieldName = ga4Filters.has(filter.dimension) ? DIMENSION_MAP[filter.dimension] : void 0;
198
+ if (!fieldName) continue;
199
+ filterExprs.push(stringFilter(fieldName, MATCH_TYPE_MAP[filter.operator], filter.value));
121
200
  }
122
- const dimensionFilter = filterExprs.length === 0 ? void 0 : filterExprs.length === 1 ? filterExprs[0] : { andGroup: { expressions: filterExprs } };
123
- const baseRequest = {
124
- property: `properties/${config.propertyId}`,
125
- dateRanges: [{
126
- startDate: q.dateRange.start.toISOString().slice(0, 10),
127
- endDate: q.dateRange.end.toISOString().slice(0, 10)
128
- }],
129
- metrics: providerMetrics.map((name) => ({ name })),
130
- ...dimensionFilter ? { dimensionFilter } : {}
201
+ const goalSlugs = slugs ? goalSlugsByEventName(slugs) : null;
202
+ const goalExprs = goalSlugs ? [...filterExprs, { filter: {
203
+ fieldName: "eventName",
204
+ inListFilter: {
205
+ values: [...goalSlugs.keys()],
206
+ caseSensitive: true
207
+ }
208
+ } }] : filterExprs;
209
+ const asFilter = (exprs) => exprs.length === 0 ? void 0 : exprs.length === 1 ? exprs[0] : { andGroup: { expressions: exprs } };
210
+ const request = (metrics, exprs, extra) => {
211
+ const dimensionFilter = asFilter(exprs);
212
+ return {
213
+ property: `properties/${config.propertyId}`,
214
+ dateRanges: [{
215
+ startDate: zonedCalendarDay(q.dateRange.start, q.timezone ?? "UTC"),
216
+ endDate: zonedCalendarDay(q.dateRange.end, q.timezone ?? "UTC")
217
+ }],
218
+ metrics: metrics.map((name) => ({ name })),
219
+ ...dimensionFilter ? { dimensionFilter } : {},
220
+ ...extra
221
+ };
131
222
  };
132
223
  const client = await getClient();
224
+ const rowKeys = (row) => (row.dimensionValues ?? []).map((value) => value.value ?? "");
225
+ /**
226
+ * One report shape run twice, plainly and goal-filtered, unioned per row. A row the
227
+ * goal report has no counterpart for carries no conversions: no key event fired there.
228
+ * `limit` is the site report's alone, since a goal ranked outside its top N would
229
+ * otherwise be lost from the union.
230
+ */
231
+ const runPair = async (extra, limit) => {
232
+ const runReport = async (metrics, exprs, reportExtra) => {
233
+ const [response] = await client.runReport(request(metrics, exprs, reportExtra));
234
+ return response;
235
+ };
236
+ const siteExprs = goalBreakdown ? goalExprs : filterExprs;
237
+ const siteExtra = limit ? {
238
+ ...extra,
239
+ limit
240
+ } : extra;
241
+ const pair = await readGoalPair({
242
+ site: siteKeys.length ? () => runReport(siteKeys, siteExprs, siteExtra) : void 0,
243
+ goals: goalKeys.length ? () => runReport(goalKeys, goalExprs, extra) : void 0
244
+ });
245
+ if (pair.failed) goalsFailed = true;
246
+ const keyed = (response, ms, keys) => response?.rows?.map((row) => ({
247
+ keys: rowKeys(row),
248
+ metrics: readMetrics(ms, keys, row)
249
+ })) ?? (response ? [] : void 0);
250
+ const siteTotals = pair.site?.totals?.[0];
251
+ const goalTotals = pair.goals?.totals?.[0];
252
+ return {
253
+ rows: mergeGoalRows(keyed(pair.site, siteMetrics, siteKeys), keyed(pair.goals, goalMetrics, goalKeys)),
254
+ totals: mergeGoalTotals(siteTotals ? readMetrics(siteMetrics, siteKeys, siteTotals) : void 0, goalTotals ? readMetrics(goalMetrics, goalKeys, goalTotals) : void 0)
255
+ };
256
+ };
133
257
  if (q.granularity === "day" && !dims.length) {
134
- const [response] = await client.runReport({
135
- ...baseRequest,
258
+ const report = await runPair({
136
259
  dimensions: [{ name: "date" }],
137
260
  metricAggregations: ["TOTAL"],
138
261
  orderBys: [{ dimension: { dimensionName: "date" } }]
139
262
  });
140
263
  const rows = [];
141
- for (const row of response.rows ?? []) {
142
- const ymd = row.dimensionValues?.[0]?.value ?? "";
264
+ for (const row of report.rows) {
265
+ const ymd = row.keys[0] ?? "";
143
266
  const ts = dayIso(`${ymd.slice(0, 4)}-${ymd.slice(4, 6)}-${ymd.slice(6, 8)}`);
144
267
  if (ts) rows.push({
145
268
  timestamp: ts,
146
- metrics: readRow(row)
269
+ metrics: row.metrics
147
270
  });
148
271
  }
149
- const totalsRow = response.totals?.[0];
150
272
  return {
151
273
  rows,
152
- totals: totalsRow ? readRow(totalsRow) : {},
153
- meta: {
154
- provider: "ga4",
155
- fetchedAt
156
- }
274
+ totals: report.totals ?? {},
275
+ meta: meta()
157
276
  };
158
277
  }
159
- const [response] = await client.runReport({
160
- ...baseRequest,
161
- ...providerDims.length ? { dimensions: providerDims.map((name) => ({ name })) } : {},
162
- ...q.limit ? { limit: q.limit } : {}
163
- });
278
+ const report = await runPair(providerDims.length ? { dimensions: providerDims.map((name) => ({ name })) } : {}, q.limit);
164
279
  if (!dims.length) {
165
- const row = response.rows?.[0];
166
- const totals = row ? readRow(row) : {};
280
+ const totals = report.rows[0]?.metrics ?? {};
167
281
  return {
168
282
  rows: [{ metrics: totals }],
169
283
  totals,
170
- meta: {
171
- provider: "ga4",
172
- fetchedAt
173
- }
284
+ meta: meta()
174
285
  };
175
286
  }
176
287
  return {
177
- rows: (response.rows ?? []).map((row) => {
288
+ rows: report.rows.map((row) => {
178
289
  const dimValues = {};
179
290
  for (const d of dims) {
180
291
  const idx = providerDims.indexOf(DIMENSION_MAP[d]);
181
- dimValues[d] = row.dimensionValues?.[idx]?.value ?? "";
292
+ const value = row.keys[idx] ?? "";
293
+ dimValues[d] = d === "goal" ? goalSlugs?.get(value) ?? value : value;
182
294
  }
183
295
  return {
184
296
  dimensions: dimValues,
185
- metrics: readRow(row)
297
+ metrics: row.metrics
186
298
  };
187
299
  }),
188
300
  totals: void 0,
189
- meta: {
190
- provider: "ga4",
191
- fetchedAt
192
- }
301
+ meta: meta()
193
302
  };
194
303
  }
195
304
  };
@@ -1 +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\tfilters: ga4Dimensions,\n\t\tfilterOperators: new Set(['eq']),\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\t// Capability gating (filters/filterOperators) is the real contract upstream; an\n\t\t\t// unsupported dimension or operator is dropped here as the safety net.\n\t\t\tfor (const filter of q.filters ?? []) {\n\t\t\t\tconst fieldName = DIMENSION_MAP[filter.dimension]\n\t\t\t\tif (!fieldName || filter.operator !== 'eq') {\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\tfilterExprs.push({\n\t\t\t\t\tfilter: { fieldName, stringFilter: { matchType: 'EXACT', value: filter.value } },\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,SAAS;EACT,iBAAiB,IAAI,IAAI,CAAC,IAAI,CAAC;EAC/B,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;GAIF,KAAK,MAAM,UAAU,EAAE,WAAW,CAAC,GAAG;IACrC,MAAM,YAAY,cAAc,OAAO;IACvC,IAAI,CAAC,aAAa,OAAO,aAAa,MACrC;IAED,YAAY,KAAK,EAChB,QAAQ;KAAE;KAAW,cAAc;MAAE,WAAW;MAAS,OAAO,OAAO;KAAM;IAAE,EAChF,CAAC;GACF;GACA,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"}
1
+ {"version":3,"file":"ga4.js","names":[],"sources":["../../../src/adapters/ga4/ga4.ts"],"sourcesContent":["import type { BetaAnalyticsDataClient, protos } from '@google-analytics/data'\nimport type { CaptureSupport } from '../../core/capture'\nimport type {\n\tAdapterContext,\n\tAnalyticsAdapter,\n\tAnalyticsCapabilities,\n\tAnalyticsQuery,\n\tAnalyticsResult,\n\tAnalyticsRow,\n\tDimensionKey,\n\tFilterOperator,\n\tMetricKey,\n} from '../../core/contract'\nimport { DEFAULT_TIMEZONE, zonedCalendarDay } from '../../timeframe/tz'\nimport {\n\temptyGoalBreakdown,\n\ttype GoalKeyedRow,\n\tgoalHint,\n\thintSlugs,\n\tmergeGoalRows,\n\tmergeGoalTotals,\n\tproviderMetricKeys,\n\treadGoalPair,\n\tsplitGoalMetrics,\n} from '../goalRead'\nimport { dayIso } from '../series'\nimport { ga4EventName } from './eventName'\nimport { MEASUREMENT_ID_PATTERN } from './measurementId'\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\t/**\n\t * Public measurement id (`G-XXXXXXX`). Setting it turns on capture: the tag is loaded\n\t * from googletagmanager.com and booted with gtag.\n\t */\n\tmeasurementId?: string\n}\n\n/**\n * Google's documented install snippet (https://developers.google.com/tag-platform/gtagjs/install):\n * the inline publishes `dataLayer` and `gtag` and configures the measurement id, then the tag\n * loads from googletagmanager.com. Inline first is Google's own ordering for consent mode, and\n * it leaves the queue defined even when the tag itself is blocked. The tag is served from\n * Google's CDN with the id in the query string, so there is nothing to proxy and `routes`\n * stays empty; the snippet is rendered from an absolute `src` and the slot's proxy mount\n * answers 404.\n */\nfunction buildCapture(measurementId: string): CaptureSupport {\n\tconst id = JSON.stringify(measurementId)\n\treturn {\n\t\tproxy: { routes: [] },\n\t\tsnippet: () => ({\n\t\t\tscripts: [\n\t\t\t\t{\n\t\t\t\t\tinline: `window.dataLayer=window.dataLayer||[];function gtag(){dataLayer.push(arguments)}gtag(\"js\",new Date());gtag(\"config\",${id})`,\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\tsrc: `https://www.googletagmanager.com/gtag/js?id=${encodeURIComponent(measurementId)}`,\n\t\t\t\t\tasync: true,\n\t\t\t\t},\n\t\t\t],\n\t\t}),\n\t\tclient: { kind: 'ga4', measurementId },\n\t}\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\tgoal: 'eventName',\n}\n\n/**\n * Metrics GA4 answers only for a goal-restricted read. A goal matches the GA4 event named by\n * its normalized slug, since GA4 refuses the kebab-case slug itself. `keyEvents` counts\n * events the property itself marks as key events, so an event that is a goal here but not\n * marked there reports 0.\n */\nconst GOAL_METRICS: ReadonlySet<MetricKey> = new Set(['conversions'])\n\n/**\n * The hint's slugs keyed by the GA4 event name each one normalizes to, which is both the\n * `eventName` list the goal request sends and the way its rows map back. Two slugs can\n * normalize to one GA4 event, which GA4 counts once: the first hint slug owns those rows.\n */\nconst goalSlugsByEventName = (slugs: string[]): Map<string, string> => {\n\tconst byName = new Map<string, string>()\n\tfor (const slug of slugs) {\n\t\tconst name = ga4EventName(slug)\n\t\tif (!byName.has(name)) {\n\t\t\tbyName.set(name, slug)\n\t\t}\n\t}\n\treturn byName\n}\n\ntype StringMatchType = 'EXACT' | 'CONTAINS' | 'FULL_REGEXP'\n\n/**\n * FULL_REGEXP is a full match, so a pattern has to cover the whole value (`/docs/.*`, not\n * `^/docs`). PARTIAL_REGEXP exists but is not the contract's `matches`.\n */\nconst MATCH_TYPE_MAP: Record<FilterOperator, StringMatchType> = {\n\teq: 'EXACT',\n\tcontains: 'CONTAINS',\n\tmatches: 'FULL_REGEXP',\n}\n\n// caseSensitive is explicit on every string filter because the Data API defaults it to\n// false: `contains` stays insensitive, matching the native source and Umami's ilike, while\n// `eq` and `matches` compare literally.\nconst CASE_SENSITIVE: Record<StringMatchType, boolean> = {\n\tEXACT: true,\n\tCONTAINS: false,\n\tFULL_REGEXP: true,\n}\n\nconst stringFilter = (\n\tfieldName: string,\n\tmatchType: StringMatchType,\n\tvalue: string\n): protos.google.analytics.data.v1beta.IFilterExpression => ({\n\tfilter: {\n\t\tfieldName,\n\t\tstringFilter: { matchType, value, caseSensitive: CASE_SENSITIVE[matchType] },\n\t},\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// `goal` is a breakdown, not a filter: the read's own goal slugs own the eventName clause.\nconst ga4Filters: ReadonlySet<DimensionKey> = new Set(\n\t[...ga4Dimensions].filter((dimension) => dimension !== 'goal')\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\tminGranularity: 'day',\n\t\tmaxLookbackDays,\n\t\tmetrics: ga4Metrics,\n\t\tdimensions: ga4Dimensions,\n\t\tfilters: ga4Filters,\n\t\tfilterOperators: new Set(['eq', 'contains', 'matches']),\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\tconst measurementId = config.measurementId\n\treturn {\n\t\tid: 'ga4',\n\t\tlabel: 'Google Analytics 4',\n\t\tcapabilities,\n\t\t// An id that is not a bare token is dropped rather than escaped: it lands in an inline\n\t\t// script and in the tag URL, and no legitimate measurement id needs anything else.\n\t\t...(measurementId && MEASUREMENT_ID_PATTERN.test(measurementId)\n\t\t\t? { capture: buildCapture(measurementId) }\n\t\t\t: {}),\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 dims = (q.dimensions ?? []).filter((d) => DIMENSION_MAP[d])\n\t\t\tconst goalBreakdown = dims.includes('goal')\n\t\t\tconst hint = goalHint(q)\n\t\t\tconst slugs = hintSlugs(hint)\n\t\t\tconst empty = goalBreakdown ? emptyGoalBreakdown({ provider: 'ga4', q, hint }) : null\n\t\t\tif (empty) {\n\t\t\t\treturn empty\n\t\t\t}\n\t\t\tconst wanted = q.metrics.filter((m) => METRIC_MAP[m])\n\t\t\tconst { siteMetrics, goalMetrics, unresolved } = splitGoalMetrics({\n\t\t\t\twanted,\n\t\t\t\tgoalOnly: GOAL_METRICS,\n\t\t\t\tgoalBreakdown,\n\t\t\t\thint,\n\t\t\t})\n\t\t\tconst siteKeys = providerMetricKeys(siteMetrics, METRIC_MAP)\n\t\t\tconst goalKeys = providerMetricKeys(goalMetrics, METRIC_MAP)\n\t\t\tconst providerDims = [...new Set(dims.map((d) => DIMENSION_MAP[d] as string))]\n\t\t\t// Set when GA4 rejects a goal report the site report survived, so the rows keep their\n\t\t\t// site metrics and lose only their conversions.\n\t\t\tlet goalsFailed = false\n\t\t\tconst meta = (): AnalyticsResult['meta'] => ({\n\t\t\t\tprovider: 'ga4',\n\t\t\t\tfetchedAt,\n\t\t\t\t...(unresolved || goalsFailed ? { goalsUnresolved: true as const } : {}),\n\t\t\t})\n\n\t\t\tconst readMetrics = (\n\t\t\t\tms: MetricKey[],\n\t\t\t\tkeys: string[],\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 ms) {\n\t\t\t\t\tconst idx = keys.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(stringFilter('pagePath', 'EXACT', q.path))\n\t\t\t}\n\t\t\tif (q.hostname) {\n\t\t\t\tfilterExprs.push(stringFilter('hostName', 'EXACT', q.hostname))\n\t\t\t}\n\t\t\t// Capability gating (filters/filterOperators) is the real contract upstream; an\n\t\t\t// unsupported dimension is dropped here as the safety net.\n\t\t\tfor (const filter of q.filters ?? []) {\n\t\t\t\tconst fieldName = ga4Filters.has(filter.dimension)\n\t\t\t\t\t? DIMENSION_MAP[filter.dimension]\n\t\t\t\t\t: undefined\n\t\t\t\tif (!fieldName) {\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\tfilterExprs.push(stringFilter(fieldName, MATCH_TYPE_MAP[filter.operator], filter.value))\n\t\t\t}\n\t\t\tconst goalSlugs = slugs ? goalSlugsByEventName(slugs) : null\n\t\t\tconst goalExprs = goalSlugs\n\t\t\t\t? [\n\t\t\t\t\t\t...filterExprs,\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tfilter: {\n\t\t\t\t\t\t\t\tfieldName: 'eventName',\n\t\t\t\t\t\t\t\tinListFilter: { values: [...goalSlugs.keys()], caseSensitive: true },\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t]\n\t\t\t\t: filterExprs\n\t\t\tconst asFilter = (\n\t\t\t\texprs: protos.google.analytics.data.v1beta.IFilterExpression[]\n\t\t\t): protos.google.analytics.data.v1beta.IFilterExpression | undefined =>\n\t\t\t\texprs.length === 0\n\t\t\t\t\t? undefined\n\t\t\t\t\t: exprs.length === 1\n\t\t\t\t\t\t? exprs[0]\n\t\t\t\t\t\t: { andGroup: { expressions: exprs } }\n\n\t\t\tconst request = (\n\t\t\t\tmetrics: string[],\n\t\t\t\texprs: protos.google.analytics.data.v1beta.IFilterExpression[],\n\t\t\t\textra: protos.google.analytics.data.v1beta.IRunReportRequest\n\t\t\t): protos.google.analytics.data.v1beta.IRunReportRequest => {\n\t\t\t\tconst dimensionFilter = asFilter(exprs)\n\t\t\t\treturn {\n\t\t\t\t\tproperty: `properties/${config.propertyId}`,\n\t\t\t\t\tdateRanges: [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tstartDate: zonedCalendarDay(q.dateRange.start, q.timezone ?? DEFAULT_TIMEZONE),\n\t\t\t\t\t\t\tendDate: zonedCalendarDay(q.dateRange.end, q.timezone ?? DEFAULT_TIMEZONE),\n\t\t\t\t\t\t},\n\t\t\t\t\t],\n\t\t\t\t\tmetrics: metrics.map((name) => ({ name })),\n\t\t\t\t\t...(dimensionFilter ? { dimensionFilter } : {}),\n\t\t\t\t\t...extra,\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tconst client = await getClient()\n\n\t\t\tinterface PairedReport {\n\t\t\t\trows: GoalKeyedRow[]\n\t\t\t\ttotals: Partial<Record<MetricKey, number>> | undefined\n\t\t\t}\n\n\t\t\tconst rowKeys = (row: protos.google.analytics.data.v1beta.IRow): string[] =>\n\t\t\t\t(row.dimensionValues ?? []).map((value) => value.value ?? '')\n\n\t\t\t/**\n\t\t\t * One report shape run twice, plainly and goal-filtered, unioned per row. A row the\n\t\t\t * goal report has no counterpart for carries no conversions: no key event fired there.\n\t\t\t * `limit` is the site report's alone, since a goal ranked outside its top N would\n\t\t\t * otherwise be lost from the union.\n\t\t\t */\n\t\t\tconst runPair = async (\n\t\t\t\textra: protos.google.analytics.data.v1beta.IRunReportRequest,\n\t\t\t\tlimit?: number\n\t\t\t): Promise<PairedReport> => {\n\t\t\t\tconst runReport = async (\n\t\t\t\t\tmetrics: string[],\n\t\t\t\t\texprs: protos.google.analytics.data.v1beta.IFilterExpression[],\n\t\t\t\t\treportExtra: protos.google.analytics.data.v1beta.IRunReportRequest\n\t\t\t\t) => {\n\t\t\t\t\tconst [response] = await client.runReport(request(metrics, exprs, reportExtra))\n\t\t\t\t\treturn response\n\t\t\t\t}\n\t\t\t\t// A goal breakdown restricts its own rows, so its one report carries the hint too.\n\t\t\t\tconst siteExprs = goalBreakdown ? goalExprs : filterExprs\n\t\t\t\tconst siteExtra = limit ? { ...extra, limit } : extra\n\t\t\t\tconst pair = await readGoalPair({\n\t\t\t\t\tsite: siteKeys.length ? () => runReport(siteKeys, siteExprs, siteExtra) : undefined,\n\t\t\t\t\tgoals: goalKeys.length ? () => runReport(goalKeys, goalExprs, extra) : undefined,\n\t\t\t\t})\n\t\t\t\tif (pair.failed) {\n\t\t\t\t\tgoalsFailed = true\n\t\t\t\t}\n\t\t\t\tconst keyed = (\n\t\t\t\t\tresponse: protos.google.analytics.data.v1beta.IRunReportResponse | undefined,\n\t\t\t\t\tms: MetricKey[],\n\t\t\t\t\tkeys: string[]\n\t\t\t\t): GoalKeyedRow[] | undefined =>\n\t\t\t\t\tresponse?.rows?.map((row) => ({\n\t\t\t\t\t\tkeys: rowKeys(row),\n\t\t\t\t\t\tmetrics: readMetrics(ms, keys, row),\n\t\t\t\t\t})) ?? (response ? [] : undefined)\n\t\t\t\tconst siteTotals = pair.site?.totals?.[0]\n\t\t\t\tconst goalTotals = pair.goals?.totals?.[0]\n\t\t\t\treturn {\n\t\t\t\t\trows: mergeGoalRows(\n\t\t\t\t\t\tkeyed(pair.site, siteMetrics, siteKeys),\n\t\t\t\t\t\tkeyed(pair.goals, goalMetrics, goalKeys)\n\t\t\t\t\t),\n\t\t\t\t\ttotals: mergeGoalTotals(\n\t\t\t\t\t\tsiteTotals ? readMetrics(siteMetrics, siteKeys, siteTotals) : undefined,\n\t\t\t\t\t\tgoalTotals ? readMetrics(goalMetrics, goalKeys, goalTotals) : undefined\n\t\t\t\t\t),\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (q.granularity === 'day' && !dims.length) {\n\t\t\t\tconst report = await runPair({\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 report.rows) {\n\t\t\t\t\tconst ymd = row.keys[0] ?? ''\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: row.metrics })\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn { rows, totals: report.totals ?? {}, meta: meta() }\n\t\t\t}\n\n\t\t\tconst report = await runPair(\n\t\t\t\tproviderDims.length ? { dimensions: providerDims.map((name) => ({ name })) } : {},\n\t\t\t\tq.limit\n\t\t\t)\n\n\t\t\tif (!dims.length) {\n\t\t\t\tconst totals = report.rows[0]?.metrics ?? {}\n\t\t\t\treturn { rows: [{ metrics: totals }], totals, meta: meta() }\n\t\t\t}\n\n\t\t\tconst rows: AnalyticsRow[] = report.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\tconst value = row.keys[idx] ?? ''\n\t\t\t\t\t// A `goal` row reports the slug it was asked for; an `event` row reports GA4's own\n\t\t\t\t\t// event name, even though both read the same dimension.\n\t\t\t\t\tdimValues[d] = d === 'goal' ? (goalSlugs?.get(value) ?? value) : value\n\t\t\t\t}\n\t\t\t\treturn { dimensions: dimValues, metrics: row.metrics }\n\t\t\t})\n\t\t\treturn { rows, totals: undefined, meta: meta() }\n\t\t},\n\t}\n}\n"],"mappings":";;;;;;;;;;;;;;;AAsDA,SAAS,aAAa,eAAuC;CAC5D,MAAM,KAAK,KAAK,UAAU,aAAa;CACvC,OAAO;EACN,OAAO,EAAE,QAAQ,CAAC,EAAE;EACpB,gBAAgB,EACf,SAAS,CACR,EACC,QAAQ,uHAAuH,GAAG,GACnI,GACA;GACC,KAAK,+CAA+C,mBAAmB,aAAa;GACpF,OAAO;EACR,CACD,EACD;EACA,QAAQ;GAAE,MAAM;GAAO;EAAc;CACtC;AACD;AAEA,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;CACP,MAAM;AACP;;;;;;;AAQA,MAAM,eAAuC,IAAI,IAAI,CAAC,aAAa,CAAC;;;;;;AAOpE,MAAM,wBAAwB,UAAyC;CACtE,MAAM,yBAAS,IAAI,IAAoB;CACvC,KAAK,MAAM,QAAQ,OAAO;EACzB,MAAM,OAAO,aAAa,IAAI;EAC9B,IAAI,CAAC,OAAO,IAAI,IAAI,GACnB,OAAO,IAAI,MAAM,IAAI;CAEvB;CACA,OAAO;AACR;;;;;AAQA,MAAM,iBAA0D;CAC/D,IAAI;CACJ,UAAU;CACV,SAAS;AACV;AAKA,MAAM,iBAAmD;CACxD,OAAO;CACP,UAAU;CACV,aAAa;AACd;AAEA,MAAM,gBACL,WACA,WACA,WAC4D,EAC5D,QAAQ;CACP;CACA,cAAc;EAAE;EAAW;EAAO,eAAe,eAAe;CAAW;AAC5E,EACD;AAEA,MAAM,aAAqC,IAAI,IAAI,OAAO,KAAK,UAAU,CAAgB;AACzF,MAAM,gBAA2C,IAAI,IACpD,OAAO,KAAK,aAAa,CAC1B;AAEA,MAAM,aAAwC,IAAI,IACjD,CAAC,GAAG,aAAa,EAAE,QAAQ,cAAc,cAAc,MAAM,CAC9D;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,gBAAgB;EAChB,iBANuB,OAAO,oBAAoB,KAAA,IAAY,OAAO,kBAAkB;EAOvF,SAAS;EACT,YAAY;EACZ,SAAS;EACT,iBAAiB,IAAI,IAAI;GAAC;GAAM;GAAY;EAAS,CAAC;EACtD,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,MAAM,gBAAgB,OAAO;CAC7B,OAAO;EACN,IAAI;EACJ,OAAO;EACP;EAGA,GAAI,iBAAiB,uBAAuB,KAAK,aAAa,IAC3D,EAAE,SAAS,aAAa,aAAa,EAAE,IACvC,CAAC;EACJ,oBACC,QACC,OAAO,cAAc,OAAO,aAAa,gBAAgB,OAAO,aAAa,WAC9E;EAGD,MAAM,MAAM,GAAmB,MAAgD;GAC9E,MAAM,YAAY,EAAE,UAAU,IAAI,YAAY;GAC9C,MAAM,QAAQ,EAAE,cAAc,CAAC,GAAG,QAAQ,MAAM,cAAc,EAAE;GAChE,MAAM,gBAAgB,KAAK,SAAS,MAAM;GAC1C,MAAM,OAAO,SAAS,CAAC;GACvB,MAAM,QAAQ,UAAU,IAAI;GAC5B,MAAM,QAAQ,gBAAgB,mBAAmB;IAAE,UAAU;IAAO;IAAG;GAAK,CAAC,IAAI;GACjF,IAAI,OACH,OAAO;GAGR,MAAM,EAAE,aAAa,aAAa,eAAe,iBAAiB;IACjE,QAFc,EAAE,QAAQ,QAAQ,MAAM,WAAW,EAE5C;IACL,UAAU;IACV;IACA;GACD,CAAC;GACD,MAAM,WAAW,mBAAmB,aAAa,UAAU;GAC3D,MAAM,WAAW,mBAAmB,aAAa,UAAU;GAC3D,MAAM,eAAe,CAAC,GAAG,IAAI,IAAI,KAAK,KAAK,MAAM,cAAc,EAAY,CAAC,CAAC;GAG7E,IAAI,cAAc;GAClB,MAAM,cAAuC;IAC5C,UAAU;IACV;IACA,GAAI,cAAc,cAAc,EAAE,iBAAiB,KAAc,IAAI,CAAC;GACvE;GAEA,MAAM,eACL,IACA,MACA,QACwC;IACxC,MAAM,MAA0C,CAAC;IACjD,KAAK,MAAM,KAAK,IAAI;KACnB,MAAM,MAAM,KAAK,QAAQ,WAAW,EAAY;KAChD,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,aAAa,YAAY,SAAS,EAAE,IAAI,CAAC;GAE3D,IAAI,EAAE,UACL,YAAY,KAAK,aAAa,YAAY,SAAS,EAAE,QAAQ,CAAC;GAI/D,KAAK,MAAM,UAAU,EAAE,WAAW,CAAC,GAAG;IACrC,MAAM,YAAY,WAAW,IAAI,OAAO,SAAS,IAC9C,cAAc,OAAO,aACrB,KAAA;IACH,IAAI,CAAC,WACJ;IAED,YAAY,KAAK,aAAa,WAAW,eAAe,OAAO,WAAW,OAAO,KAAK,CAAC;GACxF;GACA,MAAM,YAAY,QAAQ,qBAAqB,KAAK,IAAI;GACxD,MAAM,YAAY,YACf,CACA,GAAG,aACH,EACC,QAAQ;IACP,WAAW;IACX,cAAc;KAAE,QAAQ,CAAC,GAAG,UAAU,KAAK,CAAC;KAAG,eAAe;IAAK;GACpE,EACD,CACD,IACC;GACH,MAAM,YACL,UAEA,MAAM,WAAW,IACd,KAAA,IACA,MAAM,WAAW,IAChB,MAAM,KACN,EAAE,UAAU,EAAE,aAAa,MAAM,EAAE;GAExC,MAAM,WACL,SACA,OACA,UAC2D;IAC3D,MAAM,kBAAkB,SAAS,KAAK;IACtC,OAAO;KACN,UAAU,cAAc,OAAO;KAC/B,YAAY,CACX;MACC,WAAW,iBAAiB,EAAE,UAAU,OAAO,EAAE,YAAA,KAA4B;MAC7E,SAAS,iBAAiB,EAAE,UAAU,KAAK,EAAE,YAAA,KAA4B;KAC1E,CACD;KACA,SAAS,QAAQ,KAAK,UAAU,EAAE,KAAK,EAAE;KACzC,GAAI,kBAAkB,EAAE,gBAAgB,IAAI,CAAC;KAC7C,GAAG;IACJ;GACD;GAEA,MAAM,SAAS,MAAM,UAAU;GAO/B,MAAM,WAAW,SACf,IAAI,mBAAmB,CAAC,GAAG,KAAK,UAAU,MAAM,SAAS,EAAE;;;;;;;GAQ7D,MAAM,UAAU,OACf,OACA,UAC2B;IAC3B,MAAM,YAAY,OACjB,SACA,OACA,gBACI;KACJ,MAAM,CAAC,YAAY,MAAM,OAAO,UAAU,QAAQ,SAAS,OAAO,WAAW,CAAC;KAC9E,OAAO;IACR;IAEA,MAAM,YAAY,gBAAgB,YAAY;IAC9C,MAAM,YAAY,QAAQ;KAAE,GAAG;KAAO;IAAM,IAAI;IAChD,MAAM,OAAO,MAAM,aAAa;KAC/B,MAAM,SAAS,eAAe,UAAU,UAAU,WAAW,SAAS,IAAI,KAAA;KAC1E,OAAO,SAAS,eAAe,UAAU,UAAU,WAAW,KAAK,IAAI,KAAA;IACxE,CAAC;IACD,IAAI,KAAK,QACR,cAAc;IAEf,MAAM,SACL,UACA,IACA,SAEA,UAAU,MAAM,KAAK,SAAS;KAC7B,MAAM,QAAQ,GAAG;KACjB,SAAS,YAAY,IAAI,MAAM,GAAG;IACnC,EAAE,MAAM,WAAW,CAAC,IAAI,KAAA;IACzB,MAAM,aAAa,KAAK,MAAM,SAAS;IACvC,MAAM,aAAa,KAAK,OAAO,SAAS;IACxC,OAAO;KACN,MAAM,cACL,MAAM,KAAK,MAAM,aAAa,QAAQ,GACtC,MAAM,KAAK,OAAO,aAAa,QAAQ,CACxC;KACA,QAAQ,gBACP,aAAa,YAAY,aAAa,UAAU,UAAU,IAAI,KAAA,GAC9D,aAAa,YAAY,aAAa,UAAU,UAAU,IAAI,KAAA,CAC/D;IACD;GACD;GAEA,IAAI,EAAE,gBAAgB,SAAS,CAAC,KAAK,QAAQ;IAC5C,MAAM,SAAS,MAAM,QAAQ;KAC5B,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,OAAO,MAAM;KAC9B,MAAM,MAAM,IAAI,KAAK,MAAM;KAC3B,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,IAAI;KAAQ,CAAC;IAEnD;IACA,OAAO;KAAE;KAAM,QAAQ,OAAO,UAAU,CAAC;KAAG,MAAM,KAAK;IAAE;GAC1D;GAEA,MAAM,SAAS,MAAM,QACpB,aAAa,SAAS,EAAE,YAAY,aAAa,KAAK,UAAU,EAAE,KAAK,EAAE,EAAE,IAAI,CAAC,GAChF,EAAE,KACH;GAEA,IAAI,CAAC,KAAK,QAAQ;IACjB,MAAM,SAAS,OAAO,KAAK,IAAI,WAAW,CAAC;IAC3C,OAAO;KAAE,MAAM,CAAC,EAAE,SAAS,OAAO,CAAC;KAAG;KAAQ,MAAM,KAAK;IAAE;GAC5D;GAaA,OAAO;IAAE,MAXoB,OAAO,KAAK,KAAK,QAAQ;KACrD,MAAM,YAAmD,CAAC;KAC1D,KAAK,MAAM,KAAK,MAAM;MACrB,MAAM,MAAM,aAAa,QAAQ,cAAc,EAAY;MAC3D,MAAM,QAAQ,IAAI,KAAK,QAAQ;MAG/B,UAAU,KAAK,MAAM,SAAU,WAAW,IAAI,KAAK,KAAK,QAAS;KAClE;KACA,OAAO;MAAE,YAAY;MAAW,SAAS,IAAI;KAAQ;IACtD,CACY;IAAG,QAAQ,KAAA;IAAW,MAAM,KAAK;GAAE;EAChD;CACD;AACD"}
@@ -0,0 +1,15 @@
1
+ import { keys } from "../../translations/keys.js";
2
+ import { asTranslate } from "../../translations/server.js";
3
+ //#region src/adapters/ga4/measurementId.ts
4
+ /** What Google's own ids look like, and all the inline snippet and the tag URL may carry. */
5
+ const MEASUREMENT_ID_PATTERN = /^[A-Za-z0-9-]+$/;
6
+ /**
7
+ * Its own module so the providers collection can validate the id on the same terms the
8
+ * adapter admits it, without importing the adapter and its `@google-analytics/data` peer.
9
+ * Empty is allowed: the id is optional and only turns capture on.
10
+ */
11
+ const validateMeasurementId = (value, { req }) => !value || MEASUREMENT_ID_PATTERN.test(value) ? true : asTranslate(req.t)(keys.providerErrorMeasurementId);
12
+ //#endregion
13
+ export { MEASUREMENT_ID_PATTERN, validateMeasurementId };
14
+
15
+ //# sourceMappingURL=measurementId.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"measurementId.js","names":[],"sources":["../../../src/adapters/ga4/measurementId.ts"],"sourcesContent":["import type { TextFieldSingleValidation } from 'payload'\nimport { keys } from '../../translations/keys'\nimport { asTranslate } from '../../translations/server'\n\n/** What Google's own ids look like, and all the inline snippet and the tag URL may carry. */\nexport const MEASUREMENT_ID_PATTERN = /^[A-Za-z0-9-]+$/\n\n/**\n * Its own module so the providers collection can validate the id on the same terms the\n * adapter admits it, without importing the adapter and its `@google-analytics/data` peer.\n * Empty is allowed: the id is optional and only turns capture on.\n */\nexport const validateMeasurementId: TextFieldSingleValidation = (value, { req }) =>\n\t!value || MEASUREMENT_ID_PATTERN.test(value)\n\t\t? true\n\t\t: asTranslate(req.t)(keys.providerErrorMeasurementId)\n"],"mappings":";;;;AAKA,MAAa,yBAAyB;;;;;;AAOtC,MAAa,yBAAoD,OAAO,EAAE,UACzE,CAAC,SAAS,uBAAuB,KAAK,KAAK,IACxC,OACA,YAAY,IAAI,CAAC,EAAE,KAAK,0BAA0B"}
@@ -0,0 +1,126 @@
1
+ //#region src/adapters/goalRead.ts
2
+ const goalHint = (q) => {
3
+ if (q.goalSlugs === void 0) return null;
4
+ if (q.goalSlugs === "unresolved") return "unresolved";
5
+ return { slugs: [...new Set(q.goalSlugs.filter((slug) => slug.length > 0))] };
6
+ };
7
+ /** The slugs a provider request filters by, or null when the hint names none to filter by. */
8
+ const hintSlugs = (hint) => hint === null || hint === "unresolved" || hint.slugs.length === 0 ? null : hint.slugs;
9
+ /**
10
+ * Whether goal numbers are missing because the hint failed or was never set, rather than
11
+ * because the install configured no goals, which is an empty result and not a failure.
12
+ */
13
+ const hintFailed = (hint) => hint === null || hint === "unresolved";
14
+ /** A `goal` breakdown a provider was asked for without the hint that defines its rows. */
15
+ const goalsUnresolvedResult = (provider, q, meta) => ({
16
+ rows: [],
17
+ meta: {
18
+ provider,
19
+ fetchedAt: q.dateRange.end.toISOString(),
20
+ ...meta,
21
+ goalsUnresolved: true
22
+ }
23
+ });
24
+ /**
25
+ * The answer a `goal` breakdown owes before it reads, or null when its hint names rows to
26
+ * read. A failed or absent hint is reported with `goalsUnresolved`; an install that
27
+ * configured no goals gets the same empty rows without the flag.
28
+ */
29
+ const emptyGoalBreakdown = ({ provider, q, hint, meta }) => {
30
+ if (hintSlugs(hint) !== null) return null;
31
+ return hintFailed(hint) ? goalsUnresolvedResult(provider, q, meta) : {
32
+ rows: [],
33
+ meta: {
34
+ provider,
35
+ fetchedAt: q.dateRange.end.toISOString(),
36
+ ...meta
37
+ }
38
+ };
39
+ };
40
+ /**
41
+ * How a provider that serves goal metrics only under a goal filter splits one read in two.
42
+ * A goal breakdown restricts every row it returns, so its single request carries everything;
43
+ * anywhere else the goal metrics need a request of their own, because filtering the whole
44
+ * read would scope the site metrics to goal hits as well.
45
+ */
46
+ const splitGoalMetrics = ({ wanted, goalOnly, goalBreakdown, hint }) => {
47
+ if (goalBreakdown) return {
48
+ siteMetrics: wanted,
49
+ goalMetrics: [],
50
+ unresolved: false
51
+ };
52
+ const goalMetrics = wanted.filter((m) => goalOnly.has(m));
53
+ return {
54
+ siteMetrics: wanted.filter((m) => !goalOnly.has(m)),
55
+ goalMetrics: hintSlugs(hint) === null ? [] : goalMetrics,
56
+ unresolved: goalMetrics.length > 0 && hintFailed(hint)
57
+ };
58
+ };
59
+ /**
60
+ * Provider metric names for a contract metric list, deduped: several contract metrics can
61
+ * alias one provider metric (sessions and visits both map to Plausible's `visits`), so each
62
+ * is read back from its provider key's position rather than from the request index.
63
+ */
64
+ const providerMetricKeys = (metrics, map) => [...new Set(metrics.map((m) => map[m]))];
65
+ /**
66
+ * The two halves of a pair read unioned by dimension key. A row only the site request
67
+ * returned keeps its conversions absent (no goal fired there); a row only the goal request
68
+ * returned is appended carrying its goal metrics alone, since the site request answers a
69
+ * different ranking and its own limit may have cut the row off.
70
+ */
71
+ const mergeGoalRows = (site, goals) => {
72
+ if (!site) return goals ?? [];
73
+ if (!goals) return site;
74
+ const byKey = new Map(goals.map((row) => [JSON.stringify(row.keys), row]));
75
+ return [...site.map((row) => {
76
+ const key = JSON.stringify(row.keys);
77
+ const goalRow = byKey.get(key);
78
+ if (!goalRow) return row;
79
+ byKey.delete(key);
80
+ return {
81
+ keys: row.keys,
82
+ metrics: {
83
+ ...row.metrics,
84
+ ...goalRow.metrics
85
+ }
86
+ };
87
+ }), ...byKey.values()];
88
+ };
89
+ /** The same union over a pair's totals rows, which carry no dimensions to key on. */
90
+ const mergeGoalTotals = (site, goals) => site || goals ? {
91
+ ...site,
92
+ ...goals
93
+ } : void 0;
94
+ /**
95
+ * One request shape issued twice, plainly and goal-filtered. Sequential rather than
96
+ * concurrent: the engine takes a single limiter permit per `adapter.query`, so a parallel
97
+ * pair would exceed the provider's declared concurrency. A goal request the provider rejects
98
+ * (a property with no key events, a site with no revenue goals) costs the read its
99
+ * conversions rather than all of it, unless there is no site half left to serve.
100
+ */
101
+ const readGoalPair = async ({ site, goals }) => {
102
+ const siteResponse = site ? await site() : void 0;
103
+ if (!goals) return {
104
+ site: siteResponse,
105
+ goals: void 0,
106
+ failed: false
107
+ };
108
+ try {
109
+ return {
110
+ site: siteResponse,
111
+ goals: await goals(),
112
+ failed: false
113
+ };
114
+ } catch (error) {
115
+ if (!site) throw error;
116
+ return {
117
+ site: siteResponse,
118
+ goals: void 0,
119
+ failed: true
120
+ };
121
+ }
122
+ };
123
+ //#endregion
124
+ export { emptyGoalBreakdown, goalHint, hintFailed, hintSlugs, mergeGoalRows, mergeGoalTotals, providerMetricKeys, readGoalPair, splitGoalMetrics };
125
+
126
+ //# sourceMappingURL=goalRead.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"goalRead.js","names":[],"sources":["../../src/adapters/goalRead.ts"],"sourcesContent":["import type { AnalyticsQuery, AnalyticsResult, MetricKey } from '../core/contract'\n\n/**\n * What a read tells a provider about this install's goals: the slugs its goal rows are\n * restricted to (possibly none, for an install that configured none), `'unresolved'` when\n * the resolver failed, or null when the caller set no hint at all. Nothing in a provider\n * marks which of its events are this install's goals, so a provider adapter counts\n * conversions for the hinted names and for no others.\n */\nexport type GoalHint = { slugs: string[] } | 'unresolved' | null\n\nexport const goalHint = (q: AnalyticsQuery): GoalHint => {\n\tif (q.goalSlugs === undefined) {\n\t\treturn null\n\t}\n\tif (q.goalSlugs === 'unresolved') {\n\t\treturn 'unresolved'\n\t}\n\treturn { slugs: [...new Set(q.goalSlugs.filter((slug) => slug.length > 0))] }\n}\n\n/** The slugs a provider request filters by, or null when the hint names none to filter by. */\nexport const hintSlugs = (hint: GoalHint): string[] | null =>\n\thint === null || hint === 'unresolved' || hint.slugs.length === 0 ? null : hint.slugs\n\n/**\n * Whether goal numbers are missing because the hint failed or was never set, rather than\n * because the install configured no goals, which is an empty result and not a failure.\n */\nexport const hintFailed = (hint: GoalHint): boolean => hint === null || hint === 'unresolved'\n\n/** Meta a goal read still has to report beside its empty rows (unapplied filters, sampling). */\ntype GoalsUnresolvedMeta = Omit<\n\tAnalyticsResult['meta'],\n\t'provider' | 'fetchedAt' | 'goalsUnresolved'\n>\n\n/** A `goal` breakdown a provider was asked for without the hint that defines its rows. */\nexport const goalsUnresolvedResult = (\n\tprovider: string,\n\tq: AnalyticsQuery,\n\tmeta?: GoalsUnresolvedMeta\n): AnalyticsResult => ({\n\trows: [],\n\tmeta: {\n\t\tprovider,\n\t\tfetchedAt: q.dateRange.end.toISOString(),\n\t\t...meta,\n\t\tgoalsUnresolved: true,\n\t},\n})\n\n/**\n * The answer a `goal` breakdown owes before it reads, or null when its hint names rows to\n * read. A failed or absent hint is reported with `goalsUnresolved`; an install that\n * configured no goals gets the same empty rows without the flag.\n */\nexport const emptyGoalBreakdown = ({\n\tprovider,\n\tq,\n\thint,\n\tmeta,\n}: {\n\tprovider: string\n\tq: AnalyticsQuery\n\thint: GoalHint\n\tmeta?: GoalsUnresolvedMeta\n}): AnalyticsResult | null => {\n\tif (hintSlugs(hint) !== null) {\n\t\treturn null\n\t}\n\treturn hintFailed(hint)\n\t\t? goalsUnresolvedResult(provider, q, meta)\n\t\t: { rows: [], meta: { provider, fetchedAt: q.dateRange.end.toISOString(), ...meta } }\n}\n\nexport interface GoalMetricSplit {\n\t/** Metrics the plain request asks for. */\n\tsiteMetrics: MetricKey[]\n\t/** Metrics only the goal-filtered request can answer; empty when the hint names no goal. */\n\tgoalMetrics: MetricKey[]\n\t/** The read wanted goal numbers it had no hint to ask for. */\n\tunresolved: boolean\n}\n\n/**\n * How a provider that serves goal metrics only under a goal filter splits one read in two.\n * A goal breakdown restricts every row it returns, so its single request carries everything;\n * anywhere else the goal metrics need a request of their own, because filtering the whole\n * read would scope the site metrics to goal hits as well.\n */\nexport const splitGoalMetrics = ({\n\twanted,\n\tgoalOnly,\n\tgoalBreakdown,\n\thint,\n}: {\n\twanted: MetricKey[]\n\tgoalOnly: ReadonlySet<MetricKey>\n\tgoalBreakdown: boolean\n\thint: GoalHint\n}): GoalMetricSplit => {\n\tif (goalBreakdown) {\n\t\treturn { siteMetrics: wanted, goalMetrics: [], unresolved: false }\n\t}\n\tconst goalMetrics = wanted.filter((m) => goalOnly.has(m))\n\treturn {\n\t\tsiteMetrics: wanted.filter((m) => !goalOnly.has(m)),\n\t\tgoalMetrics: hintSlugs(hint) === null ? [] : goalMetrics,\n\t\tunresolved: goalMetrics.length > 0 && hintFailed(hint),\n\t}\n}\n\n/**\n * Provider metric names for a contract metric list, deduped: several contract metrics can\n * alias one provider metric (sessions and visits both map to Plausible's `visits`), so each\n * is read back from its provider key's position rather than from the request index.\n */\nexport const providerMetricKeys = (\n\tmetrics: MetricKey[],\n\tmap: Partial<Record<MetricKey, string>>\n): string[] => [...new Set(metrics.map((m) => map[m] as string))]\n\nexport interface GoalKeyedRow {\n\t/** The row's dimension values in the request's dimension order; empty for a totals row. */\n\tkeys: string[]\n\tmetrics: Partial<Record<MetricKey, number>>\n}\n\n/**\n * The two halves of a pair read unioned by dimension key. A row only the site request\n * returned keeps its conversions absent (no goal fired there); a row only the goal request\n * returned is appended carrying its goal metrics alone, since the site request answers a\n * different ranking and its own limit may have cut the row off.\n */\nexport const mergeGoalRows = (\n\tsite: GoalKeyedRow[] | undefined,\n\tgoals: GoalKeyedRow[] | undefined\n): GoalKeyedRow[] => {\n\tif (!site) {\n\t\treturn goals ?? []\n\t}\n\tif (!goals) {\n\t\treturn site\n\t}\n\tconst byKey = new Map(goals.map((row) => [JSON.stringify(row.keys), row]))\n\tconst merged = site.map((row) => {\n\t\tconst key = JSON.stringify(row.keys)\n\t\tconst goalRow = byKey.get(key)\n\t\tif (!goalRow) {\n\t\t\treturn row\n\t\t}\n\t\tbyKey.delete(key)\n\t\treturn { keys: row.keys, metrics: { ...row.metrics, ...goalRow.metrics } }\n\t})\n\treturn [...merged, ...byKey.values()]\n}\n\n/** The same union over a pair's totals rows, which carry no dimensions to key on. */\nexport const mergeGoalTotals = (\n\tsite: Partial<Record<MetricKey, number>> | undefined,\n\tgoals: Partial<Record<MetricKey, number>> | undefined\n): Partial<Record<MetricKey, number>> | undefined =>\n\tsite || goals ? { ...site, ...goals } : undefined\n\nexport interface GoalPair<Response> {\n\tsite: Response | undefined\n\tgoals: Response | undefined\n\t/** The goal request failed, so the read is served without its goal numbers. */\n\tfailed: boolean\n}\n\n/**\n * One request shape issued twice, plainly and goal-filtered. Sequential rather than\n * concurrent: the engine takes a single limiter permit per `adapter.query`, so a parallel\n * pair would exceed the provider's declared concurrency. A goal request the provider rejects\n * (a property with no key events, a site with no revenue goals) costs the read its\n * conversions rather than all of it, unless there is no site half left to serve.\n */\nexport const readGoalPair = async <Response>({\n\tsite,\n\tgoals,\n}: {\n\tsite: (() => Promise<Response>) | undefined\n\tgoals: (() => Promise<Response>) | undefined\n}): Promise<GoalPair<Response>> => {\n\tconst siteResponse = site ? await site() : undefined\n\tif (!goals) {\n\t\treturn { site: siteResponse, goals: undefined, failed: false }\n\t}\n\ttry {\n\t\treturn { site: siteResponse, goals: await goals(), failed: false }\n\t} catch (error) {\n\t\tif (!site) {\n\t\t\tthrow error\n\t\t}\n\t\treturn { site: siteResponse, goals: undefined, failed: true }\n\t}\n}\n"],"mappings":";AAWA,MAAa,YAAY,MAAgC;CACxD,IAAI,EAAE,cAAc,KAAA,GACnB,OAAO;CAER,IAAI,EAAE,cAAc,cACnB,OAAO;CAER,OAAO,EAAE,OAAO,CAAC,GAAG,IAAI,IAAI,EAAE,UAAU,QAAQ,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE;AAC7E;;AAGA,MAAa,aAAa,SACzB,SAAS,QAAQ,SAAS,gBAAgB,KAAK,MAAM,WAAW,IAAI,OAAO,KAAK;;;;;AAMjF,MAAa,cAAc,SAA4B,SAAS,QAAQ,SAAS;;AASjF,MAAa,yBACZ,UACA,GACA,UACsB;CACtB,MAAM,CAAC;CACP,MAAM;EACL;EACA,WAAW,EAAE,UAAU,IAAI,YAAY;EACvC,GAAG;EACH,iBAAiB;CAClB;AACD;;;;;;AAOA,MAAa,sBAAsB,EAClC,UACA,GACA,MACA,WAM6B;CAC7B,IAAI,UAAU,IAAI,MAAM,MACvB,OAAO;CAER,OAAO,WAAW,IAAI,IACnB,sBAAsB,UAAU,GAAG,IAAI,IACvC;EAAE,MAAM,CAAC;EAAG,MAAM;GAAE;GAAU,WAAW,EAAE,UAAU,IAAI,YAAY;GAAG,GAAG;EAAK;CAAE;AACtF;;;;;;;AAiBA,MAAa,oBAAoB,EAChC,QACA,UACA,eACA,WAMsB;CACtB,IAAI,eACH,OAAO;EAAE,aAAa;EAAQ,aAAa,CAAC;EAAG,YAAY;CAAM;CAElE,MAAM,cAAc,OAAO,QAAQ,MAAM,SAAS,IAAI,CAAC,CAAC;CACxD,OAAO;EACN,aAAa,OAAO,QAAQ,MAAM,CAAC,SAAS,IAAI,CAAC,CAAC;EAClD,aAAa,UAAU,IAAI,MAAM,OAAO,CAAC,IAAI;EAC7C,YAAY,YAAY,SAAS,KAAK,WAAW,IAAI;CACtD;AACD;;;;;;AAOA,MAAa,sBACZ,SACA,QACc,CAAC,GAAG,IAAI,IAAI,QAAQ,KAAK,MAAM,IAAI,EAAY,CAAC,CAAC;;;;;;;AAchE,MAAa,iBACZ,MACA,UACoB;CACpB,IAAI,CAAC,MACJ,OAAO,SAAS,CAAC;CAElB,IAAI,CAAC,OACJ,OAAO;CAER,MAAM,QAAQ,IAAI,IAAI,MAAM,KAAK,QAAQ,CAAC,KAAK,UAAU,IAAI,IAAI,GAAG,GAAG,CAAC,CAAC;CAUzE,OAAO,CAAC,GATO,KAAK,KAAK,QAAQ;EAChC,MAAM,MAAM,KAAK,UAAU,IAAI,IAAI;EACnC,MAAM,UAAU,MAAM,IAAI,GAAG;EAC7B,IAAI,CAAC,SACJ,OAAO;EAER,MAAM,OAAO,GAAG;EAChB,OAAO;GAAE,MAAM,IAAI;GAAM,SAAS;IAAE,GAAG,IAAI;IAAS,GAAG,QAAQ;GAAQ;EAAE;CAC1E,CACgB,GAAG,GAAG,MAAM,OAAO,CAAC;AACrC;;AAGA,MAAa,mBACZ,MACA,UAEA,QAAQ,QAAQ;CAAE,GAAG;CAAM,GAAG;AAAM,IAAI,KAAA;;;;;;;;AAgBzC,MAAa,eAAe,OAAiB,EAC5C,MACA,YAIkC;CAClC,MAAM,eAAe,OAAO,MAAM,KAAK,IAAI,KAAA;CAC3C,IAAI,CAAC,OACJ,OAAO;EAAE,MAAM;EAAc,OAAO,KAAA;EAAW,QAAQ;CAAM;CAE9D,IAAI;EACH,OAAO;GAAE,MAAM;GAAc,OAAO,MAAM,MAAM;GAAG,QAAQ;EAAM;CAClE,SAAS,OAAO;EACf,IAAI,CAAC,MACJ,MAAM;EAEP,OAAO;GAAE,MAAM;GAAc,OAAO,KAAA;GAAW,QAAQ;EAAK;CAC7D;AACD"}
@@ -18,7 +18,22 @@ interface PlausibleConfig {
18
18
  * declares `capture` only when one of it and `domain` is set.
19
19
  */
20
20
  scriptId?: string;
21
+ /**
22
+ * The ISO currency of the site's revenue goals. Declaring it turns on the `revenue`
23
+ * metric: Plausible serves `total_revenue` only where a revenue goal exists, and errors
24
+ * the whole request on a site that has none.
25
+ */
26
+ revenueCurrency?: string;
21
27
  }
28
+ /**
29
+ * Plausible identifies a goal by its display name in the site's own goal list ("Signup",
30
+ * "Visit /thank-you"), so a plugin goal's slug must equal that name for its conversions to
31
+ * read. Conversions are the `events` metric on goal rows, which is the dashboard's Total
32
+ * Conversions; revenue is `total_revenue`, which Plausible serves only for a revenue goal
33
+ * and reports as an object whose `value` is null when the rows mix currencies. Revenue is
34
+ * offered only when `revenueCurrency` says the site has such a goal: asking for it on a site
35
+ * without one errors the request.
36
+ */
22
37
  declare function plausible(config: PlausibleConfig): AnalyticsAdapter;
23
38
  //#endregion
24
39
  export { PlausibleConfig, plausible };