@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,10 +1,18 @@
1
- import "../collections/seen.js";
2
- import { bumpRollup } from "../rollups/bumpRollup.js";
3
- import { insertIfNew } from "../rollups/insertIfNew.js";
4
- import { bucketKey } from "../rollups/applyDistinctDeltas.js";
1
+ import { SEEN_SLUG } from "../collections/seen.js";
2
+ import { bucketKey } from "../rollups/bucketKey.js";
3
+ import { bumpRollups } from "../rollups/bumpRollups.js";
5
4
  import { computeRollupDeltas } from "../rollups/deltas.js";
5
+ import { insertManyIfNew } from "../rollups/insertManyIfNew.js";
6
6
  import { writeEvent } from "./writeEvent.js";
7
7
  //#region src/native/ingest/flushBatch.ts
8
+ /**
9
+ * Coalesces a batch of events into the fewest writes: events insert concurrently, base rollup
10
+ * increments are summed per bucket, and distinct visitor / session candidates are de-duplicated
11
+ * within the batch before one insert-if-new decides which of them the ledger had not seen.
12
+ * Whatever the batch size, that is three round trips for the rollups and the ledger rather
13
+ * than one per bucket. Correctness matches the per-event path because the seen ledger still
14
+ * de-dupes across batches, and its unique index still arbitrates between concurrent writers.
15
+ */
8
16
  async function flushBatch(payload, events) {
9
17
  if (events.length === 0) return;
10
18
  await Promise.all(events.map((event) => writeEvent(payload, event)));
@@ -29,30 +37,22 @@ async function flushBatch(payload, events) {
29
37
  value: event.sessionId
30
38
  });
31
39
  }
32
- for (const agg of base.values()) await bumpRollup(payload, agg.key, agg.inc);
33
- const distinct = /* @__PURE__ */ new Map();
34
- for (const candidate of candidates.values()) {
35
- if (!await insertIfNew(payload, "analytics-seen", {
36
- bucket: bucketKey(candidate.key),
37
- kind: candidate.kind,
38
- value: candidate.value,
39
- period: candidate.key.period
40
- })) continue;
41
- const metric = candidate.kind === "visitor" ? "visitors" : "sessions";
42
- const dk = `${bucketKey(candidate.key)}|${metric}`;
43
- const entry = distinct.get(dk);
44
- if (entry) entry.count += 1;
45
- else distinct.set(dk, {
40
+ await bumpRollups(payload, [...base.values()]);
41
+ const pending = [...candidates.values()];
42
+ const isNew = await insertManyIfNew(payload, SEEN_SLUG, pending.map((candidate) => ({
43
+ bucket: bucketKey(candidate.key),
44
+ kind: candidate.kind,
45
+ value: candidate.value,
46
+ period: candidate.key.period
47
+ })));
48
+ const distinct = [];
49
+ pending.forEach((candidate, index) => {
50
+ if (isNew[index]) distinct.push({
46
51
  key: candidate.key,
47
- metric,
48
- count: 1
52
+ inc: candidate.kind === "visitor" ? { visitors: 1 } : { sessions: 1 }
49
53
  });
50
- }
51
- for (const entry of distinct.values()) {
52
- const inc = {};
53
- inc[entry.metric] = entry.count;
54
- await bumpRollup(payload, entry.key, inc);
55
- }
54
+ });
55
+ await bumpRollups(payload, distinct);
56
56
  }
57
57
  //#endregion
58
58
  export { flushBatch };
@@ -1 +1 @@
1
- {"version":3,"file":"flushBatch.js","names":[],"sources":["../../../src/native/ingest/flushBatch.ts"],"sourcesContent":["import type { Payload } from 'payload'\nimport { SEEN_SLUG } from '../collections/seen'\nimport { bucketKey } from '../rollups/applyDistinctDeltas'\nimport { bumpRollup } from '../rollups/bumpRollup'\nimport {\n\tcomputeRollupDeltas,\n\ttype RollupInc,\n\ttype RollupKey,\n\ttype RollupMetric,\n} from '../rollups/deltas'\nimport { insertIfNew } from '../rollups/insertIfNew'\nimport type { StoredEvent } from './normalizeEvent'\nimport { writeEvent } from './writeEvent'\n\ninterface BaseAgg {\n\tkey: RollupKey\n\tinc: RollupInc\n}\n\ninterface DistinctCandidate {\n\tkey: RollupKey\n\tkind: 'visitor' | 'session'\n\tvalue: string\n}\n\n// Coalesces a batch of events into the fewest writes: events insert concurrently, base\n// rollup increments are summed per bucket into one upsert each, and distinct visitor /\n// session candidates are de-duplicated within the batch before insert-if-new. Correctness\n// matches the per-event path because the seen ledger still de-dupes across batches.\nexport async function flushBatch(payload: Payload, events: StoredEvent[]): Promise<void> {\n\tif (events.length === 0) {\n\t\treturn\n\t}\n\tawait Promise.all(events.map((event) => writeEvent(payload, event)))\n\n\tconst base = new Map<string, BaseAgg>()\n\tconst candidates = new Map<string, DistinctCandidate>()\n\tfor (const event of events) {\n\t\tfor (const delta of computeRollupDeltas(event)) {\n\t\t\tconst bk = bucketKey(delta.key)\n\t\t\tconst agg = base.get(bk)\n\t\t\tif (agg) {\n\t\t\t\tfor (const metric of Object.keys(agg.inc) as Array<keyof RollupInc>) {\n\t\t\t\t\tagg.inc[metric] += delta.inc[metric]\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tbase.set(bk, { key: delta.key, inc: { ...delta.inc } })\n\t\t\t}\n\t\t\tcandidates.set(`${bk}|visitor|${event.visitorHash}`, {\n\t\t\t\tkey: delta.key,\n\t\t\t\tkind: 'visitor',\n\t\t\t\tvalue: event.visitorHash,\n\t\t\t})\n\t\t\tcandidates.set(`${bk}|session|${event.sessionId}`, {\n\t\t\t\tkey: delta.key,\n\t\t\t\tkind: 'session',\n\t\t\t\tvalue: event.sessionId,\n\t\t\t})\n\t\t}\n\t}\n\n\tfor (const agg of base.values()) {\n\t\tawait bumpRollup(payload, agg.key, agg.inc)\n\t}\n\n\tconst distinct = new Map<string, { key: RollupKey; metric: RollupMetric; count: number }>()\n\tfor (const candidate of candidates.values()) {\n\t\tconst isNew = await insertIfNew(payload, SEEN_SLUG, {\n\t\t\tbucket: bucketKey(candidate.key),\n\t\t\tkind: candidate.kind,\n\t\t\tvalue: candidate.value,\n\t\t\tperiod: candidate.key.period,\n\t\t})\n\t\tif (!isNew) {\n\t\t\tcontinue\n\t\t}\n\t\tconst metric: RollupMetric = candidate.kind === 'visitor' ? 'visitors' : 'sessions'\n\t\tconst dk = `${bucketKey(candidate.key)}|${metric}`\n\t\tconst entry = distinct.get(dk)\n\t\tif (entry) {\n\t\t\tentry.count += 1\n\t\t} else {\n\t\t\tdistinct.set(dk, { key: candidate.key, metric, count: 1 })\n\t\t}\n\t}\n\n\tfor (const entry of distinct.values()) {\n\t\tconst inc: Partial<Record<RollupMetric, number>> = {}\n\t\tinc[entry.metric] = entry.count\n\t\tawait bumpRollup(payload, entry.key, inc)\n\t}\n}\n"],"mappings":";;;;;;;AA6BA,eAAsB,WAAW,SAAkB,QAAsC;CACxF,IAAI,OAAO,WAAW,GACrB;CAED,MAAM,QAAQ,IAAI,OAAO,KAAK,UAAU,WAAW,SAAS,KAAK,CAAC,CAAC;CAEnE,MAAM,uBAAO,IAAI,IAAqB;CACtC,MAAM,6BAAa,IAAI,IAA+B;CACtD,KAAK,MAAM,SAAS,QACnB,KAAK,MAAM,SAAS,oBAAoB,KAAK,GAAG;EAC/C,MAAM,KAAK,UAAU,MAAM,GAAG;EAC9B,MAAM,MAAM,KAAK,IAAI,EAAE;EACvB,IAAI,KACH,KAAK,MAAM,UAAU,OAAO,KAAK,IAAI,GAAG,GACvC,IAAI,IAAI,WAAW,MAAM,IAAI;OAG9B,KAAK,IAAI,IAAI;GAAE,KAAK,MAAM;GAAK,KAAK,EAAE,GAAG,MAAM,IAAI;EAAE,CAAC;EAEvD,WAAW,IAAI,GAAG,GAAG,WAAW,MAAM,eAAe;GACpD,KAAK,MAAM;GACX,MAAM;GACN,OAAO,MAAM;EACd,CAAC;EACD,WAAW,IAAI,GAAG,GAAG,WAAW,MAAM,aAAa;GAClD,KAAK,MAAM;GACX,MAAM;GACN,OAAO,MAAM;EACd,CAAC;CACF;CAGD,KAAK,MAAM,OAAO,KAAK,OAAO,GAC7B,MAAM,WAAW,SAAS,IAAI,KAAK,IAAI,GAAG;CAG3C,MAAM,2BAAW,IAAI,IAAqE;CAC1F,KAAK,MAAM,aAAa,WAAW,OAAO,GAAG;EAO5C,IAAI,CAAC,MANe,YAAY,SAAA,kBAAoB;GACnD,QAAQ,UAAU,UAAU,GAAG;GAC/B,MAAM,UAAU;GAChB,OAAO,UAAU;GACjB,QAAQ,UAAU,IAAI;EACvB,CAAC,GAEA;EAED,MAAM,SAAuB,UAAU,SAAS,YAAY,aAAa;EACzE,MAAM,KAAK,GAAG,UAAU,UAAU,GAAG,EAAE,GAAG;EAC1C,MAAM,QAAQ,SAAS,IAAI,EAAE;EAC7B,IAAI,OACH,MAAM,SAAS;OAEf,SAAS,IAAI,IAAI;GAAE,KAAK,UAAU;GAAK;GAAQ,OAAO;EAAE,CAAC;CAE3D;CAEA,KAAK,MAAM,SAAS,SAAS,OAAO,GAAG;EACtC,MAAM,MAA6C,CAAC;EACpD,IAAI,MAAM,UAAU,MAAM;EAC1B,MAAM,WAAW,SAAS,MAAM,KAAK,GAAG;CACzC;AACD"}
1
+ {"version":3,"file":"flushBatch.js","names":[],"sources":["../../../src/native/ingest/flushBatch.ts"],"sourcesContent":["import type { Payload } from 'payload'\nimport { SEEN_SLUG } from '../collections/seen'\nimport { bucketKey } from '../rollups/bucketKey'\nimport { bumpRollups, type RollupBump } from '../rollups/bumpRollups'\nimport { computeRollupDeltas, type RollupInc, type RollupKey } from '../rollups/deltas'\nimport { insertManyIfNew } from '../rollups/insertManyIfNew'\nimport type { StoredEvent } from './normalizeEvent'\nimport { writeEvent } from './writeEvent'\n\ninterface BaseAgg {\n\tkey: RollupKey\n\tinc: RollupInc\n}\n\ninterface DistinctCandidate {\n\tkey: RollupKey\n\tkind: 'visitor' | 'session'\n\tvalue: string\n}\n\n/**\n * Coalesces a batch of events into the fewest writes: events insert concurrently, base rollup\n * increments are summed per bucket, and distinct visitor / session candidates are de-duplicated\n * within the batch before one insert-if-new decides which of them the ledger had not seen.\n * Whatever the batch size, that is three round trips for the rollups and the ledger rather\n * than one per bucket. Correctness matches the per-event path because the seen ledger still\n * de-dupes across batches, and its unique index still arbitrates between concurrent writers.\n */\nexport async function flushBatch(payload: Payload, events: StoredEvent[]): Promise<void> {\n\tif (events.length === 0) {\n\t\treturn\n\t}\n\tawait Promise.all(events.map((event) => writeEvent(payload, event)))\n\n\tconst base = new Map<string, BaseAgg>()\n\tconst candidates = new Map<string, DistinctCandidate>()\n\tfor (const event of events) {\n\t\tfor (const delta of computeRollupDeltas(event)) {\n\t\t\tconst bk = bucketKey(delta.key)\n\t\t\tconst agg = base.get(bk)\n\t\t\tif (agg) {\n\t\t\t\tfor (const metric of Object.keys(agg.inc) as Array<keyof RollupInc>) {\n\t\t\t\t\tagg.inc[metric] += delta.inc[metric]\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\tbase.set(bk, { key: delta.key, inc: { ...delta.inc } })\n\t\t\t}\n\t\t\tcandidates.set(`${bk}|visitor|${event.visitorHash}`, {\n\t\t\t\tkey: delta.key,\n\t\t\t\tkind: 'visitor',\n\t\t\t\tvalue: event.visitorHash,\n\t\t\t})\n\t\t\tcandidates.set(`${bk}|session|${event.sessionId}`, {\n\t\t\t\tkey: delta.key,\n\t\t\t\tkind: 'session',\n\t\t\t\tvalue: event.sessionId,\n\t\t\t})\n\t\t}\n\t}\n\n\tawait bumpRollups(payload, [...base.values()])\n\n\tconst pending = [...candidates.values()]\n\tconst isNew = await insertManyIfNew(\n\t\tpayload,\n\t\tSEEN_SLUG,\n\t\tpending.map((candidate) => ({\n\t\t\tbucket: bucketKey(candidate.key),\n\t\t\tkind: candidate.kind,\n\t\t\tvalue: candidate.value,\n\t\t\tperiod: candidate.key.period,\n\t\t}))\n\t)\n\t// One increment per ledger row this flush actually created; bumpRollups sums the ones that\n\t// land on the same bucket.\n\tconst distinct: RollupBump[] = []\n\tpending.forEach((candidate, index) => {\n\t\tif (isNew[index]) {\n\t\t\tdistinct.push({\n\t\t\t\tkey: candidate.key,\n\t\t\t\tinc: candidate.kind === 'visitor' ? { visitors: 1 } : { sessions: 1 },\n\t\t\t})\n\t\t}\n\t})\n\tawait bumpRollups(payload, distinct)\n}\n"],"mappings":";;;;;;;;;;;;;;;AA4BA,eAAsB,WAAW,SAAkB,QAAsC;CACxF,IAAI,OAAO,WAAW,GACrB;CAED,MAAM,QAAQ,IAAI,OAAO,KAAK,UAAU,WAAW,SAAS,KAAK,CAAC,CAAC;CAEnE,MAAM,uBAAO,IAAI,IAAqB;CACtC,MAAM,6BAAa,IAAI,IAA+B;CACtD,KAAK,MAAM,SAAS,QACnB,KAAK,MAAM,SAAS,oBAAoB,KAAK,GAAG;EAC/C,MAAM,KAAK,UAAU,MAAM,GAAG;EAC9B,MAAM,MAAM,KAAK,IAAI,EAAE;EACvB,IAAI,KACH,KAAK,MAAM,UAAU,OAAO,KAAK,IAAI,GAAG,GACvC,IAAI,IAAI,WAAW,MAAM,IAAI;OAG9B,KAAK,IAAI,IAAI;GAAE,KAAK,MAAM;GAAK,KAAK,EAAE,GAAG,MAAM,IAAI;EAAE,CAAC;EAEvD,WAAW,IAAI,GAAG,GAAG,WAAW,MAAM,eAAe;GACpD,KAAK,MAAM;GACX,MAAM;GACN,OAAO,MAAM;EACd,CAAC;EACD,WAAW,IAAI,GAAG,GAAG,WAAW,MAAM,aAAa;GAClD,KAAK,MAAM;GACX,MAAM;GACN,OAAO,MAAM;EACd,CAAC;CACF;CAGD,MAAM,YAAY,SAAS,CAAC,GAAG,KAAK,OAAO,CAAC,CAAC;CAE7C,MAAM,UAAU,CAAC,GAAG,WAAW,OAAO,CAAC;CACvC,MAAM,QAAQ,MAAM,gBACnB,SACA,WACA,QAAQ,KAAK,eAAe;EAC3B,QAAQ,UAAU,UAAU,GAAG;EAC/B,MAAM,UAAU;EAChB,OAAO,UAAU;EACjB,QAAQ,UAAU,IAAI;CACvB,EAAE,CACH;CAGA,MAAM,WAAyB,CAAC;CAChC,QAAQ,SAAS,WAAW,UAAU;EACrC,IAAI,MAAM,QACT,SAAS,KAAK;GACb,KAAK,UAAU;GACf,KAAK,UAAU,SAAS,YAAY,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE;EACrE,CAAC;CAEH,CAAC;CACD,MAAM,YAAY,SAAS,QAAQ;AACpC"}
@@ -0,0 +1,14 @@
1
+ /**
2
+ * The visitor's preferred language from an `Accept-Language` header: the first tag, without
3
+ * its quality factor, lowercased (`de-DE,de;q=0.9` becomes `de-de`). A wildcard or an absent
4
+ * header states no preference, so nothing is reported.
5
+ */
6
+ const primaryLanguage = (acceptLanguage) => {
7
+ const tag = acceptLanguage?.split(",")[0]?.split(";")[0]?.trim().toLowerCase();
8
+ if (!tag || tag === "*") return;
9
+ return tag.slice(0, 16);
10
+ };
11
+ //#endregion
12
+ export { primaryLanguage };
13
+
14
+ //# sourceMappingURL=language.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"language.js","names":[],"sources":["../../../src/native/ingest/language.ts"],"sourcesContent":["/** Long enough for any real BCP 47 tag; a longer one is junk, not a language. */\nexport const MAX_LANGUAGE_LENGTH = 16\n\n/**\n * The visitor's preferred language from an `Accept-Language` header: the first tag, without\n * its quality factor, lowercased (`de-DE,de;q=0.9` becomes `de-de`). A wildcard or an absent\n * header states no preference, so nothing is reported.\n */\nexport const primaryLanguage = (acceptLanguage: string | null): string | undefined => {\n\tconst tag = acceptLanguage?.split(',')[0]?.split(';')[0]?.trim().toLowerCase()\n\tif (!tag || tag === '*') {\n\t\treturn undefined\n\t}\n\treturn tag.slice(0, MAX_LANGUAGE_LENGTH)\n}\n"],"mappings":";;;;;AAQA,MAAa,mBAAmB,mBAAsD;CACrF,MAAM,MAAM,gBAAgB,MAAM,GAAG,EAAE,IAAI,MAAM,GAAG,EAAE,IAAI,KAAK,EAAE,YAAY;CAC7E,IAAI,CAAC,OAAO,QAAQ,KACnB;CAED,OAAO,IAAI,MAAM,GAAA,EAAsB;AACxC"}
@@ -0,0 +1,26 @@
1
+ //#region src/native/ingest/normalizeEvent.d.ts
2
+ type EventType = 'pageview' | 'event' | 'goal';
3
+ interface RawEventInput {
4
+ type: EventType;
5
+ /** Event name, or the goal slug on a `goal`. Absent on pageviews. */
6
+ name?: string;
7
+ path: string;
8
+ hostname: string;
9
+ referrer?: string;
10
+ /**
11
+ * The page's query string, without its leading `?`. Read for its utm keys and then
12
+ * discarded: it is never stored, so a session token or an email address that happens to
13
+ * be in the URL never lands in the events collection.
14
+ */
15
+ query?: string;
16
+ durationMs?: number;
17
+ props?: Record<string, unknown>;
18
+ /** Revenue for a goal completion, in `currency`. */
19
+ value?: number;
20
+ currency?: string;
21
+ /** Max scroll depth reached on a pageview, 0-100. */
22
+ scrollDepth?: number;
23
+ }
24
+ //#endregion
25
+ export { RawEventInput };
26
+ //# sourceMappingURL=normalizeEvent.d.ts.map
@@ -1,7 +1,11 @@
1
1
  import { clientIpFromHeaders } from "./clientIp.js";
2
- import { matchGoals } from "../../goals/match.js";
3
2
  import { classifyDevice } from "./device.js";
3
+ import { matchGoals } from "../../goals/match.js";
4
+ import { classifyBrowser, classifyOs } from "./browser.js";
5
+ import { primaryLanguage } from "./language.js";
6
+ import { referrerHost, storedReferrer } from "./referrer.js";
4
7
  import { deriveSource } from "./source.js";
8
+ import { extractUtm } from "./utm.js";
5
9
  import { dailyVisitorHash, deriveSessionId } from "./visitorHash.js";
6
10
  //#region src/native/ingest/normalizeEvent.ts
7
11
  const MAX_PROPS = 20;
@@ -33,6 +37,14 @@ const duration = (value) => {
33
37
  };
34
38
  /** The event name is a rollup bucket key (the `event` dimension), so it is length-capped. */
35
39
  const eventName = (value) => typeof value === "string" ? value.slice(0, MAX_NAME_LENGTH) : void 0;
40
+ /**
41
+ * A geo value as stored. The resolver reads request headers a client can set, and each value
42
+ * becomes a rollup dimvalue and part of a seen-ledger key, so it is capped here rather than
43
+ * trusted. An empty value stays absent: '' would be a bucket of its own.
44
+ */
45
+ const geoValue = (value) => value ? value.slice(0, 128) : void 0;
46
+ /** Capped before it is parsed, so a hostile query cannot make ingest do unbounded work. */
47
+ const queryString = (value) => typeof value === "string" ? value.slice(0, 512) : void 0;
36
48
  const depth = (value) => {
37
49
  const n = nonNegative(value);
38
50
  return n === void 0 ? void 0 : Math.round(Math.min(n, 100));
@@ -69,6 +81,13 @@ async function normalizeEvent({ raw, headers, geoResolver, salt, now, scope, tim
69
81
  const scrollDepth = depth(raw.scrollDepth);
70
82
  const durationMs = duration(raw.durationMs);
71
83
  const name = eventName(raw.name);
84
+ const device = classifyDevice(ua);
85
+ const browser = classifyBrowser(ua);
86
+ const os = classifyOs(ua);
87
+ const language = primaryLanguage(headers.get("accept-language"));
88
+ const refHost = referrerHost(raw.referrer, hostname);
89
+ const query = queryString(raw.query);
90
+ const utm = extractUtm(query);
72
91
  const completions = goals?.length ? matchGoals({
73
92
  type: raw.type,
74
93
  name,
@@ -82,12 +101,21 @@ async function normalizeEvent({ raw, headers, geoResolver, salt, now, scope, tim
82
101
  name,
83
102
  path,
84
103
  hostname,
85
- referrer: raw.referrer,
86
- device: classifyDevice(ua),
87
- source: deriveSource(raw.referrer, hostname),
88
- country: geo.country,
89
- region: geo.region,
90
- city: geo.city,
104
+ referrer: storedReferrer(raw.referrer),
105
+ ...refHost ? { referrerHost: refHost } : {},
106
+ ...device ? { device } : {},
107
+ ...browser ? { browser } : {},
108
+ ...os ? { os } : {},
109
+ source: deriveSource({
110
+ referrerHost: refHost,
111
+ utmMedium: utm.utmMedium,
112
+ query
113
+ }),
114
+ ...utm,
115
+ country: geoValue(geo.country),
116
+ region: geoValue(geo.region),
117
+ city: geoValue(geo.city),
118
+ ...language ? { language } : {},
91
119
  visitorHash,
92
120
  sessionId: deriveSessionId(visitorHash, hourBucket),
93
121
  props,
@@ -1 +1 @@
1
- {"version":3,"file":"normalizeEvent.js","names":[],"sources":["../../../src/native/ingest/normalizeEvent.ts"],"sourcesContent":["import { type GoalCompletion, matchGoals } from '../../goals/match'\nimport type { Goal } from '../../goals/types'\nimport type { GeoResolver } from '../geo/geoResolver'\nimport { clientIpFromHeaders } from './clientIp'\nimport { classifyDevice, type DeviceType } from './device'\nimport { deriveSource } from './source'\nimport { dailyVisitorHash, deriveSessionId } from './visitorHash'\n\nexport type EventType = 'pageview' | 'event' | 'goal'\n\nexport interface RawEventInput {\n\ttype: EventType\n\t/** Event name, or the goal slug on a `goal`. Absent on pageviews. */\n\tname?: string\n\tpath: string\n\thostname: string\n\treferrer?: string\n\tdurationMs?: number\n\tprops?: Record<string, unknown>\n\t/** Revenue for a goal completion, in `currency`. */\n\tvalue?: number\n\tcurrency?: string\n\t/** Max scroll depth reached on a pageview, 0-100. */\n\tscrollDepth?: number\n}\n\nexport interface StoredEvent {\n\ttimestamp: Date\n\ttype: EventType\n\tname?: string\n\tpath: string\n\thostname: string\n\treferrer?: string\n\tdevice?: DeviceType\n\tsource?: string\n\tcountry?: string\n\tregion?: string\n\tcity?: string\n\tvisitorHash: string\n\tsessionId: string\n\tdurationMs?: number\n\tprops?: Record<string, unknown>\n\tvalue?: number\n\t/** ISO 4217 code `value` is denominated in. Stored as sent; revenue is never converted. */\n\tcurrency?: string\n\tscrollDepth?: number\n\t/**\n\t * Goals this event completed, resolved against the install's goals at ingest so a later\n\t * goal edit never rewrites history and a raw-event read can re-derive the same numbers\n\t * the rollups hold.\n\t */\n\tgoals?: GoalCompletion[]\n\t/** Set only in scoped installs; '' is the null scope. */\n\tscope?: string\n\t/**\n\t * Reporting timezone the rollup day bucket is computed in. In-memory only: stripped\n\t * before the event row is persisted (day bucketing happens at rollup time). Absent\n\t * means UTC.\n\t */\n\ttimezone?: string\n}\n\nexport interface NormalizeArgs {\n\traw: RawEventInput\n\theaders: Headers\n\tgeoResolver: GeoResolver\n\tsalt: string\n\tnow: Date\n\tscope?: string\n\ttimezone?: string\n\t/** Goals to match this event against; omitted means no goal matching. */\n\tgoals?: Goal[]\n}\n\nconst MAX_PROPS = 20\nconst MAX_KEY_LENGTH = 64\nconst MAX_VALUE_LENGTH = 256\nconst MAX_NAME_LENGTH = 128\nconst MAX_PATH_LENGTH = 512\n/** Longest legal DNS name. */\nconst MAX_HOSTNAME_LENGTH = 253\n/** 24 hours. A longer duration is a broken clock, not a session. */\nconst MAX_DURATION_MS = 86_400_000\nconst CURRENCY = /^[A-Z]{3}$/\n\n/**\n * Optional wire fields are sanitized rather than rejected: a bad `value`, `currency`,\n * `scrollDepth`, `durationMs`, or prop is dropped and the event is still ingested, so one malformed\n * attribute never costs a pageview. Only the required fields (checked in the endpoint)\n * can fail an event.\n */\nconst nonNegative = (value: unknown): number | undefined =>\n\ttypeof value === 'number' && Number.isFinite(value) && value >= 0 ? value : undefined\n\nconst currencyCode = (value: unknown): string | undefined =>\n\ttypeof value === 'string' && CURRENCY.test(value) ? value : undefined\n\n/**\n * Infinity would poison a rollup bucket's average for good, and a string would throw out of\n * the write and take the whole buffered batch with it, so a duration outside the ceiling is\n * dropped like any other malformed attribute.\n */\nconst duration = (value: unknown): number | undefined => {\n\tconst n = nonNegative(value)\n\treturn n === undefined || n > MAX_DURATION_MS ? undefined : n\n}\n\n/** The event name is a rollup bucket key (the `event` dimension), so it is length-capped. */\nconst eventName = (value: unknown): string | undefined =>\n\ttypeof value === 'string' ? value.slice(0, MAX_NAME_LENGTH) : undefined\n\nconst depth = (value: unknown): number | undefined => {\n\tconst n = nonNegative(value)\n\treturn n === undefined ? undefined : Math.round(Math.min(n, 100))\n}\n\n/** Flat JSON scalars only: the first 20 short-keyed string/number/boolean entries. */\nconst sanitizeProps = (raw: unknown): Record<string, unknown> | undefined => {\n\tif (typeof raw !== 'object' || raw === null || Array.isArray(raw)) {\n\t\treturn undefined\n\t}\n\tconst out: Record<string, unknown> = {}\n\tlet kept = 0\n\tfor (const [key, value] of Object.entries(raw)) {\n\t\tif (kept >= MAX_PROPS || key.length > MAX_KEY_LENGTH) {\n\t\t\tcontinue\n\t\t}\n\t\tif (typeof value === 'string') {\n\t\t\tout[key] = value.slice(0, MAX_VALUE_LENGTH)\n\t\t} else if (\n\t\t\ttypeof value === 'boolean' ||\n\t\t\t(typeof value === 'number' && Number.isFinite(value))\n\t\t) {\n\t\t\tout[key] = value\n\t\t} else {\n\t\t\tcontinue\n\t\t}\n\t\tkept++\n\t}\n\treturn kept > 0 ? out : undefined\n}\n\nexport async function normalizeEvent({\n\traw,\n\theaders,\n\tgeoResolver,\n\tsalt,\n\tnow,\n\tscope,\n\ttimezone,\n\tgoals,\n}: NormalizeArgs): Promise<StoredEvent> {\n\tconst geo = await geoResolver(headers)\n\tconst ip = clientIpFromHeaders(headers) ?? ''\n\tconst ua = headers.get('user-agent') ?? ''\n\t// Both are unique-index bucket keys on the rollup and seen rows, so they are capped\n\t// before anything derives from them: an uncapped path exceeds Mongo's index key limit.\n\tconst path = raw.path.slice(0, MAX_PATH_LENGTH)\n\tconst hostname = raw.hostname.slice(0, MAX_HOSTNAME_LENGTH)\n\tconst visitorHash = dailyVisitorHash({ ip, ua, site: hostname, salt })\n\tconst hourBucket = now.toISOString().slice(0, 13)\n\tconst props = sanitizeProps(raw.props)\n\tconst value = nonNegative(raw.value)\n\tconst scrollDepth = depth(raw.scrollDepth)\n\tconst durationMs = duration(raw.durationMs)\n\tconst name = eventName(raw.name)\n\t// Match on the sanitized fields so a rejected value never reaches a goal's revenue.\n\tconst completions = goals?.length\n\t\t? matchGoals({ type: raw.type, name, path, props, value }, goals)\n\t\t: []\n\treturn {\n\t\ttimestamp: now,\n\t\ttype: raw.type,\n\t\tname,\n\t\tpath,\n\t\thostname,\n\t\treferrer: raw.referrer,\n\t\tdevice: classifyDevice(ua),\n\t\tsource: deriveSource(raw.referrer, hostname),\n\t\tcountry: geo.country,\n\t\tregion: geo.region,\n\t\tcity: geo.city,\n\t\tvisitorHash,\n\t\tsessionId: deriveSessionId(visitorHash, hourBucket),\n\t\tprops,\n\t\t...(durationMs !== undefined ? { durationMs } : {}),\n\t\t...(value !== undefined ? { value } : {}),\n\t\t...(currencyCode(raw.currency) !== undefined ? { currency: raw.currency } : {}),\n\t\t...(scrollDepth !== undefined ? { scrollDepth } : {}),\n\t\t...(completions.length > 0 ? { goals: completions } : {}),\n\t\t...(scope !== undefined ? { scope } : {}),\n\t\t...(timezone !== undefined ? { timezone } : {}),\n\t}\n}\n"],"mappings":";;;;;;AA0EA,MAAM,YAAY;AAClB,MAAM,iBAAiB;AACvB,MAAM,mBAAmB;AACzB,MAAM,kBAAkB;AACxB,MAAM,kBAAkB;;AAExB,MAAM,sBAAsB;;AAE5B,MAAM,kBAAkB;AACxB,MAAM,WAAW;;;;;;;AAQjB,MAAM,eAAe,UACpB,OAAO,UAAU,YAAY,OAAO,SAAS,KAAK,KAAK,SAAS,IAAI,QAAQ,KAAA;AAE7E,MAAM,gBAAgB,UACrB,OAAO,UAAU,YAAY,SAAS,KAAK,KAAK,IAAI,QAAQ,KAAA;;;;;;AAO7D,MAAM,YAAY,UAAuC;CACxD,MAAM,IAAI,YAAY,KAAK;CAC3B,OAAO,MAAM,KAAA,KAAa,IAAI,kBAAkB,KAAA,IAAY;AAC7D;;AAGA,MAAM,aAAa,UAClB,OAAO,UAAU,WAAW,MAAM,MAAM,GAAG,eAAe,IAAI,KAAA;AAE/D,MAAM,SAAS,UAAuC;CACrD,MAAM,IAAI,YAAY,KAAK;CAC3B,OAAO,MAAM,KAAA,IAAY,KAAA,IAAY,KAAK,MAAM,KAAK,IAAI,GAAG,GAAG,CAAC;AACjE;;AAGA,MAAM,iBAAiB,QAAsD;CAC5E,IAAI,OAAO,QAAQ,YAAY,QAAQ,QAAQ,MAAM,QAAQ,GAAG,GAC/D;CAED,MAAM,MAA+B,CAAC;CACtC,IAAI,OAAO;CACX,KAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,GAAG,GAAG;EAC/C,IAAI,QAAQ,aAAa,IAAI,SAAS,gBACrC;EAED,IAAI,OAAO,UAAU,UACpB,IAAI,OAAO,MAAM,MAAM,GAAG,gBAAgB;OACpC,IACN,OAAO,UAAU,aAChB,OAAO,UAAU,YAAY,OAAO,SAAS,KAAK,GAEnD,IAAI,OAAO;OAEX;EAED;CACD;CACA,OAAO,OAAO,IAAI,MAAM,KAAA;AACzB;AAEA,eAAsB,eAAe,EACpC,KACA,SACA,aACA,MACA,KACA,OACA,UACA,SACuC;CACvC,MAAM,MAAM,MAAM,YAAY,OAAO;CACrC,MAAM,KAAK,oBAAoB,OAAO,KAAK;CAC3C,MAAM,KAAK,QAAQ,IAAI,YAAY,KAAK;CAGxC,MAAM,OAAO,IAAI,KAAK,MAAM,GAAG,eAAe;CAC9C,MAAM,WAAW,IAAI,SAAS,MAAM,GAAG,mBAAmB;CAC1D,MAAM,cAAc,iBAAiB;EAAE;EAAI;EAAI,MAAM;EAAU;CAAK,CAAC;CACrE,MAAM,aAAa,IAAI,YAAY,EAAE,MAAM,GAAG,EAAE;CAChD,MAAM,QAAQ,cAAc,IAAI,KAAK;CACrC,MAAM,QAAQ,YAAY,IAAI,KAAK;CACnC,MAAM,cAAc,MAAM,IAAI,WAAW;CACzC,MAAM,aAAa,SAAS,IAAI,UAAU;CAC1C,MAAM,OAAO,UAAU,IAAI,IAAI;CAE/B,MAAM,cAAc,OAAO,SACxB,WAAW;EAAE,MAAM,IAAI;EAAM;EAAM;EAAM;EAAO;CAAM,GAAG,KAAK,IAC9D,CAAC;CACJ,OAAO;EACN,WAAW;EACX,MAAM,IAAI;EACV;EACA;EACA;EACA,UAAU,IAAI;EACd,QAAQ,eAAe,EAAE;EACzB,QAAQ,aAAa,IAAI,UAAU,QAAQ;EAC3C,SAAS,IAAI;EACb,QAAQ,IAAI;EACZ,MAAM,IAAI;EACV;EACA,WAAW,gBAAgB,aAAa,UAAU;EAClD;EACA,GAAI,eAAe,KAAA,IAAY,EAAE,WAAW,IAAI,CAAC;EACjD,GAAI,UAAU,KAAA,IAAY,EAAE,MAAM,IAAI,CAAC;EACvC,GAAI,aAAa,IAAI,QAAQ,MAAM,KAAA,IAAY,EAAE,UAAU,IAAI,SAAS,IAAI,CAAC;EAC7E,GAAI,gBAAgB,KAAA,IAAY,EAAE,YAAY,IAAI,CAAC;EACnD,GAAI,YAAY,SAAS,IAAI,EAAE,OAAO,YAAY,IAAI,CAAC;EACvD,GAAI,UAAU,KAAA,IAAY,EAAE,MAAM,IAAI,CAAC;EACvC,GAAI,aAAa,KAAA,IAAY,EAAE,SAAS,IAAI,CAAC;CAC9C;AACD"}
1
+ {"version":3,"file":"normalizeEvent.js","names":[],"sources":["../../../src/native/ingest/normalizeEvent.ts"],"sourcesContent":["import { type GoalCompletion, matchGoals } from '../../goals/match'\nimport type { Goal } from '../../goals/types'\nimport { MAX_GEO_LENGTH, MAX_QUERY_LENGTH, MAX_REFERRER_LENGTH } from '../../query/limits'\nimport type { GeoResolver } from '../geo/geoResolver'\nimport { type BrowserName, classifyBrowser, classifyOs, type OsName } from './browser'\nimport { clientIpFromHeaders } from './clientIp'\nimport { classifyDevice, type DeviceType } from './device'\nimport { primaryLanguage } from './language'\nimport { referrerHost, storedReferrer } from './referrer'\nimport { deriveSource } from './source'\nimport { extractUtm } from './utm'\nimport { dailyVisitorHash, deriveSessionId } from './visitorHash'\n\n/** The wire caps, re-exported beside the sanitizers that apply them. */\nexport { MAX_GEO_LENGTH, MAX_QUERY_LENGTH, MAX_REFERRER_LENGTH }\n\nexport type EventType = 'pageview' | 'event' | 'goal'\n\nexport interface RawEventInput {\n\ttype: EventType\n\t/** Event name, or the goal slug on a `goal`. Absent on pageviews. */\n\tname?: string\n\tpath: string\n\thostname: string\n\treferrer?: string\n\t/**\n\t * The page's query string, without its leading `?`. Read for its utm keys and then\n\t * discarded: it is never stored, so a session token or an email address that happens to\n\t * be in the URL never lands in the events collection.\n\t */\n\tquery?: string\n\tdurationMs?: number\n\tprops?: Record<string, unknown>\n\t/** Revenue for a goal completion, in `currency`. */\n\tvalue?: number\n\tcurrency?: string\n\t/** Max scroll depth reached on a pageview, 0-100. */\n\tscrollDepth?: number\n}\n\nexport interface StoredEvent {\n\ttimestamp: Date\n\ttype: EventType\n\tname?: string\n\tpath: string\n\thostname: string\n\t/** Origin and path only: the query string and fragment are stripped before storage. */\n\treferrer?: string\n\t/**\n\t * The referrer's bare host, derived at ingest because a `where` cannot derive it at read\n\t * time: it is what the `referrer` dimension buckets and filters on.\n\t */\n\treferrerHost?: string\n\tdevice?: DeviceType\n\tbrowser?: BrowserName\n\tos?: OsName\n\t/**\n\t * The hit's traffic channel (`TrafficChannel`). Typed as a string because rows written\n\t * before the channel classifier hold a referrer host here instead, and they are never\n\t * rewritten.\n\t */\n\tsource?: string\n\t/** The five campaign keys extracted from the wire `query`; absent when it carried none. */\n\tutmSource?: string\n\tutmMedium?: string\n\tutmCampaign?: string\n\tutmContent?: string\n\tutmTerm?: string\n\tcountry?: string\n\tregion?: string\n\tcity?: string\n\t/** Primary `Accept-Language` tag, lowercased (`de-de`). */\n\tlanguage?: string\n\tvisitorHash: string\n\tsessionId: string\n\tdurationMs?: number\n\tprops?: Record<string, unknown>\n\tvalue?: number\n\t/** ISO 4217 code `value` is denominated in. Stored as sent; revenue is never converted. */\n\tcurrency?: string\n\tscrollDepth?: number\n\t/**\n\t * Goals this event completed, resolved against the install's goals at ingest so a later\n\t * goal edit never rewrites history and a raw-event read can re-derive the same numbers\n\t * the rollups hold.\n\t */\n\tgoals?: GoalCompletion[]\n\t/** Set only in scoped installs; '' is the null scope. */\n\tscope?: string\n\t/**\n\t * Reporting timezone the rollup day bucket is computed in. In-memory only: stripped\n\t * before the event row is persisted (day bucketing happens at rollup time). Absent\n\t * means UTC.\n\t */\n\ttimezone?: string\n}\n\nexport interface NormalizeArgs {\n\traw: RawEventInput\n\theaders: Headers\n\tgeoResolver: GeoResolver\n\tsalt: string\n\tnow: Date\n\tscope?: string\n\ttimezone?: string\n\t/** Goals to match this event against; omitted means no goal matching. */\n\tgoals?: Goal[]\n}\n\nconst MAX_PROPS = 20\nconst MAX_KEY_LENGTH = 64\nconst MAX_VALUE_LENGTH = 256\nconst MAX_NAME_LENGTH = 128\nconst MAX_PATH_LENGTH = 512\n/** Longest legal DNS name. */\nconst MAX_HOSTNAME_LENGTH = 253\n/** 24 hours. A longer duration is a broken clock, not a session. */\nconst MAX_DURATION_MS = 86_400_000\nconst CURRENCY = /^[A-Z]{3}$/\n\n/**\n * Optional wire fields are sanitized rather than rejected: a bad `value`, `currency`,\n * `scrollDepth`, `durationMs`, or prop is dropped and the event is still ingested, so one malformed\n * attribute never costs a pageview. Only the required fields (checked in the endpoint)\n * can fail an event.\n */\nconst nonNegative = (value: unknown): number | undefined =>\n\ttypeof value === 'number' && Number.isFinite(value) && value >= 0 ? value : undefined\n\nconst currencyCode = (value: unknown): string | undefined =>\n\ttypeof value === 'string' && CURRENCY.test(value) ? value : undefined\n\n/**\n * Infinity would poison a rollup bucket's average for good, and a string would throw out of\n * the write and take the whole buffered batch with it, so a duration outside the ceiling is\n * dropped like any other malformed attribute.\n */\nconst duration = (value: unknown): number | undefined => {\n\tconst n = nonNegative(value)\n\treturn n === undefined || n > MAX_DURATION_MS ? undefined : n\n}\n\n/** The event name is a rollup bucket key (the `event` dimension), so it is length-capped. */\nconst eventName = (value: unknown): string | undefined =>\n\ttypeof value === 'string' ? value.slice(0, MAX_NAME_LENGTH) : undefined\n\n/**\n * A geo value as stored. The resolver reads request headers a client can set, and each value\n * becomes a rollup dimvalue and part of a seen-ledger key, so it is capped here rather than\n * trusted. An empty value stays absent: '' would be a bucket of its own.\n */\nconst geoValue = (value: string | undefined): string | undefined =>\n\tvalue ? value.slice(0, MAX_GEO_LENGTH) : undefined\n\n/** Capped before it is parsed, so a hostile query cannot make ingest do unbounded work. */\nconst queryString = (value: unknown): string | undefined =>\n\ttypeof value === 'string' ? value.slice(0, MAX_QUERY_LENGTH) : undefined\n\nconst depth = (value: unknown): number | undefined => {\n\tconst n = nonNegative(value)\n\treturn n === undefined ? undefined : Math.round(Math.min(n, 100))\n}\n\n/** Flat JSON scalars only: the first 20 short-keyed string/number/boolean entries. */\nconst sanitizeProps = (raw: unknown): Record<string, unknown> | undefined => {\n\tif (typeof raw !== 'object' || raw === null || Array.isArray(raw)) {\n\t\treturn undefined\n\t}\n\tconst out: Record<string, unknown> = {}\n\tlet kept = 0\n\tfor (const [key, value] of Object.entries(raw)) {\n\t\tif (kept >= MAX_PROPS || key.length > MAX_KEY_LENGTH) {\n\t\t\tcontinue\n\t\t}\n\t\tif (typeof value === 'string') {\n\t\t\tout[key] = value.slice(0, MAX_VALUE_LENGTH)\n\t\t} else if (\n\t\t\ttypeof value === 'boolean' ||\n\t\t\t(typeof value === 'number' && Number.isFinite(value))\n\t\t) {\n\t\t\tout[key] = value\n\t\t} else {\n\t\t\tcontinue\n\t\t}\n\t\tkept++\n\t}\n\treturn kept > 0 ? out : undefined\n}\n\nexport async function normalizeEvent({\n\traw,\n\theaders,\n\tgeoResolver,\n\tsalt,\n\tnow,\n\tscope,\n\ttimezone,\n\tgoals,\n}: NormalizeArgs): Promise<StoredEvent> {\n\tconst geo = await geoResolver(headers)\n\tconst ip = clientIpFromHeaders(headers) ?? ''\n\tconst ua = headers.get('user-agent') ?? ''\n\t// Everything that becomes a rollup dimvalue or a seen-ledger key is capped before anything\n\t// derives from it: an uncapped value exceeds Mongo's index key limit, and on Postgres a\n\t// btree key over 2704 bytes fails the write outright. That covers path and hostname here,\n\t// the geo values below (a client can set the headers a resolver reads), and the event name,\n\t// query and referrer in their own sanitizers.\n\tconst path = raw.path.slice(0, MAX_PATH_LENGTH)\n\tconst hostname = raw.hostname.slice(0, MAX_HOSTNAME_LENGTH)\n\tconst visitorHash = dailyVisitorHash({ ip, ua, site: hostname, salt })\n\tconst hourBucket = now.toISOString().slice(0, 13)\n\tconst props = sanitizeProps(raw.props)\n\tconst value = nonNegative(raw.value)\n\tconst scrollDepth = depth(raw.scrollDepth)\n\tconst durationMs = duration(raw.durationMs)\n\tconst name = eventName(raw.name)\n\tconst device = classifyDevice(ua)\n\tconst browser = classifyBrowser(ua)\n\tconst os = classifyOs(ua)\n\tconst language = primaryLanguage(headers.get('accept-language'))\n\tconst refHost = referrerHost(raw.referrer, hostname)\n\tconst query = queryString(raw.query)\n\tconst utm = extractUtm(query)\n\t// Match on the sanitized fields so a rejected value never reaches a goal's revenue.\n\tconst completions = goals?.length\n\t\t? matchGoals({ type: raw.type, name, path, props, value }, goals)\n\t\t: []\n\treturn {\n\t\ttimestamp: now,\n\t\ttype: raw.type,\n\t\tname,\n\t\tpath,\n\t\thostname,\n\t\treferrer: storedReferrer(raw.referrer),\n\t\t...(refHost ? { referrerHost: refHost } : {}),\n\t\t...(device ? { device } : {}),\n\t\t...(browser ? { browser } : {}),\n\t\t...(os ? { os } : {}),\n\t\tsource: deriveSource({ referrerHost: refHost, utmMedium: utm.utmMedium, query }),\n\t\t...utm,\n\t\tcountry: geoValue(geo.country),\n\t\tregion: geoValue(geo.region),\n\t\tcity: geoValue(geo.city),\n\t\t...(language ? { language } : {}),\n\t\tvisitorHash,\n\t\tsessionId: deriveSessionId(visitorHash, hourBucket),\n\t\tprops,\n\t\t...(durationMs !== undefined ? { durationMs } : {}),\n\t\t...(value !== undefined ? { value } : {}),\n\t\t...(currencyCode(raw.currency) !== undefined ? { currency: raw.currency } : {}),\n\t\t...(scrollDepth !== undefined ? { scrollDepth } : {}),\n\t\t...(completions.length > 0 ? { goals: completions } : {}),\n\t\t...(scope !== undefined ? { scope } : {}),\n\t\t...(timezone !== undefined ? { timezone } : {}),\n\t}\n}\n"],"mappings":";;;;;;;;;;AA6GA,MAAM,YAAY;AAClB,MAAM,iBAAiB;AACvB,MAAM,mBAAmB;AACzB,MAAM,kBAAkB;AACxB,MAAM,kBAAkB;;AAExB,MAAM,sBAAsB;;AAE5B,MAAM,kBAAkB;AACxB,MAAM,WAAW;;;;;;;AAQjB,MAAM,eAAe,UACpB,OAAO,UAAU,YAAY,OAAO,SAAS,KAAK,KAAK,SAAS,IAAI,QAAQ,KAAA;AAE7E,MAAM,gBAAgB,UACrB,OAAO,UAAU,YAAY,SAAS,KAAK,KAAK,IAAI,QAAQ,KAAA;;;;;;AAO7D,MAAM,YAAY,UAAuC;CACxD,MAAM,IAAI,YAAY,KAAK;CAC3B,OAAO,MAAM,KAAA,KAAa,IAAI,kBAAkB,KAAA,IAAY;AAC7D;;AAGA,MAAM,aAAa,UAClB,OAAO,UAAU,WAAW,MAAM,MAAM,GAAG,eAAe,IAAI,KAAA;;;;;;AAO/D,MAAM,YAAY,UACjB,QAAQ,MAAM,MAAM,GAAA,GAAiB,IAAI,KAAA;;AAG1C,MAAM,eAAe,UACpB,OAAO,UAAU,WAAW,MAAM,MAAM,GAAA,GAAmB,IAAI,KAAA;AAEhE,MAAM,SAAS,UAAuC;CACrD,MAAM,IAAI,YAAY,KAAK;CAC3B,OAAO,MAAM,KAAA,IAAY,KAAA,IAAY,KAAK,MAAM,KAAK,IAAI,GAAG,GAAG,CAAC;AACjE;;AAGA,MAAM,iBAAiB,QAAsD;CAC5E,IAAI,OAAO,QAAQ,YAAY,QAAQ,QAAQ,MAAM,QAAQ,GAAG,GAC/D;CAED,MAAM,MAA+B,CAAC;CACtC,IAAI,OAAO;CACX,KAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,GAAG,GAAG;EAC/C,IAAI,QAAQ,aAAa,IAAI,SAAS,gBACrC;EAED,IAAI,OAAO,UAAU,UACpB,IAAI,OAAO,MAAM,MAAM,GAAG,gBAAgB;OACpC,IACN,OAAO,UAAU,aAChB,OAAO,UAAU,YAAY,OAAO,SAAS,KAAK,GAEnD,IAAI,OAAO;OAEX;EAED;CACD;CACA,OAAO,OAAO,IAAI,MAAM,KAAA;AACzB;AAEA,eAAsB,eAAe,EACpC,KACA,SACA,aACA,MACA,KACA,OACA,UACA,SACuC;CACvC,MAAM,MAAM,MAAM,YAAY,OAAO;CACrC,MAAM,KAAK,oBAAoB,OAAO,KAAK;CAC3C,MAAM,KAAK,QAAQ,IAAI,YAAY,KAAK;CAMxC,MAAM,OAAO,IAAI,KAAK,MAAM,GAAG,eAAe;CAC9C,MAAM,WAAW,IAAI,SAAS,MAAM,GAAG,mBAAmB;CAC1D,MAAM,cAAc,iBAAiB;EAAE;EAAI;EAAI,MAAM;EAAU;CAAK,CAAC;CACrE,MAAM,aAAa,IAAI,YAAY,EAAE,MAAM,GAAG,EAAE;CAChD,MAAM,QAAQ,cAAc,IAAI,KAAK;CACrC,MAAM,QAAQ,YAAY,IAAI,KAAK;CACnC,MAAM,cAAc,MAAM,IAAI,WAAW;CACzC,MAAM,aAAa,SAAS,IAAI,UAAU;CAC1C,MAAM,OAAO,UAAU,IAAI,IAAI;CAC/B,MAAM,SAAS,eAAe,EAAE;CAChC,MAAM,UAAU,gBAAgB,EAAE;CAClC,MAAM,KAAK,WAAW,EAAE;CACxB,MAAM,WAAW,gBAAgB,QAAQ,IAAI,iBAAiB,CAAC;CAC/D,MAAM,UAAU,aAAa,IAAI,UAAU,QAAQ;CACnD,MAAM,QAAQ,YAAY,IAAI,KAAK;CACnC,MAAM,MAAM,WAAW,KAAK;CAE5B,MAAM,cAAc,OAAO,SACxB,WAAW;EAAE,MAAM,IAAI;EAAM;EAAM;EAAM;EAAO;CAAM,GAAG,KAAK,IAC9D,CAAC;CACJ,OAAO;EACN,WAAW;EACX,MAAM,IAAI;EACV;EACA;EACA;EACA,UAAU,eAAe,IAAI,QAAQ;EACrC,GAAI,UAAU,EAAE,cAAc,QAAQ,IAAI,CAAC;EAC3C,GAAI,SAAS,EAAE,OAAO,IAAI,CAAC;EAC3B,GAAI,UAAU,EAAE,QAAQ,IAAI,CAAC;EAC7B,GAAI,KAAK,EAAE,GAAG,IAAI,CAAC;EACnB,QAAQ,aAAa;GAAE,cAAc;GAAS,WAAW,IAAI;GAAW;EAAM,CAAC;EAC/E,GAAG;EACH,SAAS,SAAS,IAAI,OAAO;EAC7B,QAAQ,SAAS,IAAI,MAAM;EAC3B,MAAM,SAAS,IAAI,IAAI;EACvB,GAAI,WAAW,EAAE,SAAS,IAAI,CAAC;EAC/B;EACA,WAAW,gBAAgB,aAAa,UAAU;EAClD;EACA,GAAI,eAAe,KAAA,IAAY,EAAE,WAAW,IAAI,CAAC;EACjD,GAAI,UAAU,KAAA,IAAY,EAAE,MAAM,IAAI,CAAC;EACvC,GAAI,aAAa,IAAI,QAAQ,MAAM,KAAA,IAAY,EAAE,UAAU,IAAI,SAAS,IAAI,CAAC;EAC7E,GAAI,gBAAgB,KAAA,IAAY,EAAE,YAAY,IAAI,CAAC;EACnD,GAAI,YAAY,SAAS,IAAI,EAAE,OAAO,YAAY,IAAI,CAAC;EACvD,GAAI,UAAU,KAAA,IAAY,EAAE,MAAM,IAAI,CAAC;EACvC,GAAI,aAAa,KAAA,IAAY,EAAE,SAAS,IAAI,CAAC;CAC9C;AACD"}
@@ -0,0 +1,48 @@
1
+ //#region src/native/ingest/referrer.ts
2
+ /** A hostname as it is compared: lowercased, without a leading `www.`. */
3
+ const bareHost = (host) => host.toLowerCase().replace(/^www\./, "");
4
+ /**
5
+ * The referrer as it is stored: everything from the first `#` or `?` onwards removed, then
6
+ * capped. A same-origin navigation puts the previous page's whole URL in `document.referrer`,
7
+ * so the query string routinely carries a reset token, a session id or an email address that
8
+ * has no business in an analytics row. Origin and path are kept verbatim, case included,
9
+ * because they are what makes a referrer readable. The fragment goes first: a `?` after a
10
+ * `#` belongs to the fragment, not to a query.
11
+ *
12
+ * An unparseable referrer is stripped on the same terms rather than trusted, and a value that
13
+ * is not a string at all is dropped: the wire field is public and unvalidated, so a body
14
+ * carrying `"referrer": {}` must cost the event its referrer, not the request its response.
15
+ */
16
+ const storedReferrer = (raw) => {
17
+ if (typeof raw !== "string") return;
18
+ const stripped = raw.split("#")[0]?.split("?")[0];
19
+ return stripped ? stripped.slice(0, 512) : void 0;
20
+ };
21
+ /**
22
+ * The referrer's bare host, which is what the `referrer` dimension buckets and reads by:
23
+ * lowercased, without scheme, port, path, query or a leading `www.`. Nothing is reported for
24
+ * a missing, non-string, hostless or unparseable referrer, so the event contributes no
25
+ * referrer bucket.
26
+ *
27
+ * A self-referral reports nothing either: internal navigation is the bulk of any site's
28
+ * traffic, and counting it would put the site's own domain at the top of its referrers
29
+ * breakdown forever. `selfHostname` is the event's own hostname, compared on the same terms
30
+ * (case-insensitively, `www.` stripped). The `source` dimension reads the same absence as its
31
+ * `direct` channel.
32
+ */
33
+ const referrerHost = (raw, selfHostname) => {
34
+ if (typeof raw !== "string" || !raw) return;
35
+ let host;
36
+ try {
37
+ host = new URL(raw).hostname;
38
+ } catch {
39
+ return;
40
+ }
41
+ const bare = bareHost(host);
42
+ if (!bare || bare === bareHost(selfHostname)) return;
43
+ return bare.slice(0, 253);
44
+ };
45
+ //#endregion
46
+ export { referrerHost, storedReferrer };
47
+
48
+ //# sourceMappingURL=referrer.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"referrer.js","names":[],"sources":["../../../src/native/ingest/referrer.ts"],"sourcesContent":["import { MAX_QUERY_HOSTNAME_LENGTH, MAX_REFERRER_LENGTH } from '../../query/limits'\n\n/** A hostname as it is compared: lowercased, without a leading `www.`. */\nconst bareHost = (host: string): string => host.toLowerCase().replace(/^www\\./, '')\n\n/**\n * The referrer as it is stored: everything from the first `#` or `?` onwards removed, then\n * capped. A same-origin navigation puts the previous page's whole URL in `document.referrer`,\n * so the query string routinely carries a reset token, a session id or an email address that\n * has no business in an analytics row. Origin and path are kept verbatim, case included,\n * because they are what makes a referrer readable. The fragment goes first: a `?` after a\n * `#` belongs to the fragment, not to a query.\n *\n * An unparseable referrer is stripped on the same terms rather than trusted, and a value that\n * is not a string at all is dropped: the wire field is public and unvalidated, so a body\n * carrying `\"referrer\": {}` must cost the event its referrer, not the request its response.\n */\nexport const storedReferrer = (raw: unknown): string | undefined => {\n\tif (typeof raw !== 'string') {\n\t\treturn undefined\n\t}\n\tconst stripped = raw.split('#')[0]?.split('?')[0]\n\treturn stripped ? stripped.slice(0, MAX_REFERRER_LENGTH) : undefined\n}\n\n/**\n * The referrer's bare host, which is what the `referrer` dimension buckets and reads by:\n * lowercased, without scheme, port, path, query or a leading `www.`. Nothing is reported for\n * a missing, non-string, hostless or unparseable referrer, so the event contributes no\n * referrer bucket.\n *\n * A self-referral reports nothing either: internal navigation is the bulk of any site's\n * traffic, and counting it would put the site's own domain at the top of its referrers\n * breakdown forever. `selfHostname` is the event's own hostname, compared on the same terms\n * (case-insensitively, `www.` stripped). The `source` dimension reads the same absence as its\n * `direct` channel.\n */\nexport const referrerHost = (raw: unknown, selfHostname: string): string | undefined => {\n\tif (typeof raw !== 'string' || !raw) {\n\t\treturn undefined\n\t}\n\tlet host: string\n\ttry {\n\t\thost = new URL(raw).hostname\n\t} catch {\n\t\treturn undefined\n\t}\n\tconst bare = bareHost(host)\n\tif (!bare || bare === bareHost(selfHostname)) {\n\t\treturn undefined\n\t}\n\treturn bare.slice(0, MAX_QUERY_HOSTNAME_LENGTH)\n}\n"],"mappings":";;AAGA,MAAM,YAAY,SAAyB,KAAK,YAAY,EAAE,QAAQ,UAAU,EAAE;;;;;;;;;;;;;AAclF,MAAa,kBAAkB,QAAqC;CACnE,IAAI,OAAO,QAAQ,UAClB;CAED,MAAM,WAAW,IAAI,MAAM,GAAG,EAAE,IAAI,MAAM,GAAG,EAAE;CAC/C,OAAO,WAAW,SAAS,MAAM,GAAA,GAAsB,IAAI,KAAA;AAC5D;;;;;;;;;;;;;AAcA,MAAa,gBAAgB,KAAc,iBAA6C;CACvF,IAAI,OAAO,QAAQ,YAAY,CAAC,KAC/B;CAED,IAAI;CACJ,IAAI;EACH,OAAO,IAAI,IAAI,GAAG,EAAE;CACrB,QAAQ;EACP;CACD;CACA,MAAM,OAAO,SAAS,IAAI;CAC1B,IAAI,CAAC,QAAQ,SAAS,SAAS,YAAY,GAC1C;CAED,OAAO,KAAK,MAAM,GAAA,GAA4B;AAC/C"}
@@ -0,0 +1,20 @@
1
+ import { ServerEventInput, ServerTrackOptions } from "../../core/serverEvent.js";
2
+ import { Payload } from "payload";
3
+
4
+ //#region src/native/ingest/serverTrack.d.ts
5
+ /**
6
+ * Records an analytics event from server code: a webhook, a job, a server action. The event
7
+ * goes through the same normalization, sanitization and goal matching a browser event does.
8
+ * Pass `opts.req` whenever there is a request behind the event, so it inherits that request's
9
+ * attribution, scope and reporting timezone.
10
+ *
11
+ * `event.scope` overrides the request's scope; it is ignored on an unscoped install and is
12
+ * never checked against the scopes that exist, so the caller owns what it stamps.
13
+ *
14
+ * Needs the native adapter: a provider slot (Plausible, GA4) has no server ingestion seam
15
+ * here yet, so an install without the native adapter throws rather than dropping the event.
16
+ */
17
+ declare const trackServerEvent: (payload: Payload, event: ServerEventInput, opts?: ServerTrackOptions) => Promise<void>;
18
+ //#endregion
19
+ export { trackServerEvent };
20
+ //# sourceMappingURL=serverTrack.d.ts.map
@@ -0,0 +1,100 @@
1
+ import { getRuntime } from "../../plugin/runtime.js";
2
+ import { AnalyticsTrackError } from "../../core/serverEvent.js";
3
+ import { SERVER_USER_AGENT } from "./device.js";
4
+ import { flushBatch } from "./flushBatch.js";
5
+ import { normalizeEvent } from "./normalizeEvent.js";
6
+ import { dailySalt } from "./salt.js";
7
+ import { rawEventError } from "./validate.js";
8
+ import { createLocalReq } from "payload";
9
+ //#region src/native/ingest/serverTrack.ts
10
+ /**
11
+ * The originating request's own headers, so a server event attributes exactly like the
12
+ * browser event it stands in for: the platform's geo headers reach the geo resolver and the
13
+ * visitor hashes to the same person. Explicit `ip` / `userAgent` overlay them.
14
+ *
15
+ * With no request and no user agent the synthetic server agent stands in, which hashes every
16
+ * such event in a day to one visitor per site and reports no device at all.
17
+ */
18
+ const attributionHeaders = (event, req) => {
19
+ const headers = new Headers(req?.headers);
20
+ if (event.ip) headers.set("x-forwarded-for", event.ip);
21
+ if (event.userAgent) headers.set("user-agent", event.userAgent);
22
+ if (!headers.get("user-agent")) headers.set("user-agent", SERVER_USER_AGENT);
23
+ return headers;
24
+ };
25
+ const resolveScope = async (event, opts, resolvers) => {
26
+ if (!resolvers.scope) return;
27
+ if (event.scope !== void 0) return event.scope ?? "";
28
+ if (!opts?.req) return "";
29
+ return await resolvers.scope(opts.req) ?? "";
30
+ };
31
+ /**
32
+ * The native adapter's server-side ingestion, exposed as `adapter.ingest.track`. Same
33
+ * normalization, goal matching and write path the HTTP endpoint uses; only attribution and
34
+ * scope resolution differ, since there may be no request behind the event at all.
35
+ */
36
+ const makeServerTrack = (deps) => async (event, opts) => {
37
+ const payload = deps.getPayload();
38
+ if (!payload) throw new AnalyticsTrackError("analytics: trackServerEvent called before init");
39
+ const invalid = rawEventError(event);
40
+ if (invalid) throw new AnalyticsTrackError(`analytics: trackServerEvent needs a valid "${invalid}"`);
41
+ const resolvers = deps.getResolvers();
42
+ const scope = await resolveScope(event, opts, resolvers);
43
+ let local;
44
+ const requestFor = async () => {
45
+ if (opts?.req) return opts.req;
46
+ local ??= await createLocalReq({}, payload);
47
+ return local;
48
+ };
49
+ const timezone = event.timezone ?? (resolvers.timezone ? await resolvers.timezone(await requestFor(), scope ?? null) : void 0);
50
+ const goals = resolvers.goals ? await resolvers.goals(await requestFor(), scope ?? null) : void 0;
51
+ const now = event.now ?? /* @__PURE__ */ new Date();
52
+ const stored = await normalizeEvent({
53
+ raw: {
54
+ type: event.type,
55
+ name: event.name,
56
+ path: event.path,
57
+ hostname: event.hostname,
58
+ referrer: event.referrer,
59
+ query: event.query,
60
+ props: event.props,
61
+ value: event.value,
62
+ currency: event.currency
63
+ },
64
+ headers: attributionHeaders(event, opts?.req),
65
+ geoResolver: deps.geoResolver,
66
+ salt: await dailySalt(payload, now),
67
+ now,
68
+ scope,
69
+ timezone,
70
+ goals
71
+ });
72
+ const buffer = deps.getBuffer();
73
+ if (!buffer) {
74
+ await flushBatch(payload, [stored]);
75
+ return;
76
+ }
77
+ buffer.add(stored);
78
+ if (opts?.flush) await buffer.flush();
79
+ };
80
+ /**
81
+ * Records an analytics event from server code: a webhook, a job, a server action. The event
82
+ * goes through the same normalization, sanitization and goal matching a browser event does.
83
+ * Pass `opts.req` whenever there is a request behind the event, so it inherits that request's
84
+ * attribution, scope and reporting timezone.
85
+ *
86
+ * `event.scope` overrides the request's scope; it is ignored on an unscoped install and is
87
+ * never checked against the scopes that exist, so the caller owns what it stamps.
88
+ *
89
+ * Needs the native adapter: a provider slot (Plausible, GA4) has no server ingestion seam
90
+ * here yet, so an install without the native adapter throws rather than dropping the event.
91
+ */
92
+ const trackServerEvent = async (payload, event, opts) => {
93
+ const track = getRuntime(payload)?.registry.all().find((adapter) => adapter.ingest?.track)?.ingest?.track;
94
+ if (!track) throw new AnalyticsTrackError("analytics: trackServerEvent needs the native adapter; provider-slot server tracking is not supported yet");
95
+ await track(event, opts);
96
+ };
97
+ //#endregion
98
+ export { makeServerTrack, trackServerEvent };
99
+
100
+ //# sourceMappingURL=serverTrack.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"serverTrack.js","names":[],"sources":["../../../src/native/ingest/serverTrack.ts"],"sourcesContent":["import { createLocalReq, type Payload, type PayloadRequest } from 'payload'\nimport {\n\tAnalyticsTrackError,\n\ttype ServerEventInput,\n\ttype ServerTrack,\n\ttype ServerTrackOptions,\n} from '../../core/serverEvent'\nimport { getRuntime } from '../../plugin/runtime'\nimport type { GeoResolver } from '../geo/geoResolver'\nimport { SERVER_USER_AGENT } from './device'\nimport type { IngestResolvers } from './endpoint'\nimport { flushBatch } from './flushBatch'\nimport { normalizeEvent, type StoredEvent } from './normalizeEvent'\nimport { dailySalt } from './salt'\nimport { rawEventError } from './validate'\nimport type { WriteBuffer } from './writeBuffer'\n\nexport interface ServerTrackDeps {\n\t/** Null until the adapter's onInit has run. */\n\tgetPayload: () => Payload | null\n\tgeoResolver: GeoResolver\n\tgetBuffer: () => WriteBuffer<StoredEvent> | null\n\t/** Read late: the register context that carries them arrives after the adapter is built. */\n\tgetResolvers: () => IngestResolvers\n}\n\n/**\n * The originating request's own headers, so a server event attributes exactly like the\n * browser event it stands in for: the platform's geo headers reach the geo resolver and the\n * visitor hashes to the same person. Explicit `ip` / `userAgent` overlay them.\n *\n * With no request and no user agent the synthetic server agent stands in, which hashes every\n * such event in a day to one visitor per site and reports no device at all.\n */\nconst attributionHeaders = (event: ServerEventInput, req?: PayloadRequest): Headers => {\n\tconst headers = new Headers(req?.headers)\n\tif (event.ip) {\n\t\theaders.set('x-forwarded-for', event.ip)\n\t}\n\tif (event.userAgent) {\n\t\theaders.set('user-agent', event.userAgent)\n\t}\n\tif (!headers.get('user-agent')) {\n\t\theaders.set('user-agent', SERVER_USER_AGENT)\n\t}\n\treturn headers\n}\n\nconst resolveScope = async (\n\tevent: ServerEventInput,\n\topts: ServerTrackOptions | undefined,\n\tresolvers: IngestResolvers\n): Promise<string | undefined> => {\n\t// An unscoped install has no scope resolver and no scope field on its rows, so a scope\n\t// declared by the caller is ignored exactly as the endpoint ignores one on the wire.\n\tif (!resolvers.scope) {\n\t\treturn undefined\n\t}\n\tif (event.scope !== undefined) {\n\t\treturn event.scope ?? ''\n\t}\n\tif (!opts?.req) {\n\t\treturn ''\n\t}\n\treturn (await resolvers.scope(opts.req)) ?? ''\n}\n\n/**\n * The native adapter's server-side ingestion, exposed as `adapter.ingest.track`. Same\n * normalization, goal matching and write path the HTTP endpoint uses; only attribution and\n * scope resolution differ, since there may be no request behind the event at all.\n */\nexport const makeServerTrack =\n\t(deps: ServerTrackDeps): ServerTrack =>\n\tasync (event, opts) => {\n\t\tconst payload = deps.getPayload()\n\t\tif (!payload) {\n\t\t\tthrow new AnalyticsTrackError('analytics: trackServerEvent called before init')\n\t\t}\n\t\tconst invalid = rawEventError(event)\n\t\tif (invalid) {\n\t\t\tthrow new AnalyticsTrackError(`analytics: trackServerEvent needs a valid \"${invalid}\"`)\n\t\t}\n\t\tconst resolvers = deps.getResolvers()\n\t\tconst scope = await resolveScope(event, opts, resolvers)\n\t\t// createLocalReq mutates the request it is given, so a caller's own req is passed\n\t\t// through untouched and a fresh one is built only when a resolver needs it.\n\t\tlet local: PayloadRequest | undefined\n\t\tconst requestFor = async (): Promise<PayloadRequest> => {\n\t\t\tif (opts?.req) {\n\t\t\t\treturn opts.req\n\t\t\t}\n\t\t\tlocal ??= await createLocalReq({}, payload)\n\t\t\treturn local\n\t\t}\n\t\tconst timezone =\n\t\t\tevent.timezone ??\n\t\t\t(resolvers.timezone ? await resolvers.timezone(await requestFor(), scope ?? null) : undefined)\n\t\t// Goals resolve under the scope the event is stamped with, so a tenant's server event\n\t\t// can only ever complete that tenant's goals.\n\t\tconst goals = resolvers.goals\n\t\t\t? await resolvers.goals(await requestFor(), scope ?? null)\n\t\t\t: undefined\n\t\tconst now = event.now ?? new Date()\n\t\tconst stored = await normalizeEvent({\n\t\t\traw: {\n\t\t\t\ttype: event.type,\n\t\t\t\tname: event.name,\n\t\t\t\tpath: event.path,\n\t\t\t\thostname: event.hostname,\n\t\t\t\treferrer: event.referrer,\n\t\t\t\tquery: event.query,\n\t\t\t\tprops: event.props,\n\t\t\t\tvalue: event.value,\n\t\t\t\tcurrency: event.currency,\n\t\t\t},\n\t\t\theaders: attributionHeaders(event, opts?.req),\n\t\t\tgeoResolver: deps.geoResolver,\n\t\t\tsalt: await dailySalt(payload, now),\n\t\t\tnow,\n\t\t\tscope,\n\t\t\ttimezone,\n\t\t\tgoals,\n\t\t})\n\t\tconst buffer = deps.getBuffer()\n\t\tif (!buffer) {\n\t\t\tawait flushBatch(payload, [stored])\n\t\t\treturn\n\t\t}\n\t\tbuffer.add(stored)\n\t\tif (opts?.flush) {\n\t\t\tawait buffer.flush()\n\t\t}\n\t}\n\n/**\n * Records an analytics event from server code: a webhook, a job, a server action. The event\n * goes through the same normalization, sanitization and goal matching a browser event does.\n * Pass `opts.req` whenever there is a request behind the event, so it inherits that request's\n * attribution, scope and reporting timezone.\n *\n * `event.scope` overrides the request's scope; it is ignored on an unscoped install and is\n * never checked against the scopes that exist, so the caller owns what it stamps.\n *\n * Needs the native adapter: a provider slot (Plausible, GA4) has no server ingestion seam\n * here yet, so an install without the native adapter throws rather than dropping the event.\n */\nexport const trackServerEvent = async (\n\tpayload: Payload,\n\tevent: ServerEventInput,\n\topts?: ServerTrackOptions\n): Promise<void> => {\n\tconst track = getRuntime(payload)\n\t\t?.registry.all()\n\t\t.find((adapter) => adapter.ingest?.track)?.ingest?.track\n\tif (!track) {\n\t\tthrow new AnalyticsTrackError(\n\t\t\t'analytics: trackServerEvent needs the native adapter; provider-slot server tracking is not supported yet'\n\t\t)\n\t}\n\tawait track(event, opts)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAkCA,MAAM,sBAAsB,OAAyB,QAAkC;CACtF,MAAM,UAAU,IAAI,QAAQ,KAAK,OAAO;CACxC,IAAI,MAAM,IACT,QAAQ,IAAI,mBAAmB,MAAM,EAAE;CAExC,IAAI,MAAM,WACT,QAAQ,IAAI,cAAc,MAAM,SAAS;CAE1C,IAAI,CAAC,QAAQ,IAAI,YAAY,GAC5B,QAAQ,IAAI,cAAc,iBAAiB;CAE5C,OAAO;AACR;AAEA,MAAM,eAAe,OACpB,OACA,MACA,cACiC;CAGjC,IAAI,CAAC,UAAU,OACd;CAED,IAAI,MAAM,UAAU,KAAA,GACnB,OAAO,MAAM,SAAS;CAEvB,IAAI,CAAC,MAAM,KACV,OAAO;CAER,OAAQ,MAAM,UAAU,MAAM,KAAK,GAAG,KAAM;AAC7C;;;;;;AAOA,MAAa,mBACX,SACD,OAAO,OAAO,SAAS;CACtB,MAAM,UAAU,KAAK,WAAW;CAChC,IAAI,CAAC,SACJ,MAAM,IAAI,oBAAoB,gDAAgD;CAE/E,MAAM,UAAU,cAAc,KAAK;CACnC,IAAI,SACH,MAAM,IAAI,oBAAoB,8CAA8C,QAAQ,EAAE;CAEvF,MAAM,YAAY,KAAK,aAAa;CACpC,MAAM,QAAQ,MAAM,aAAa,OAAO,MAAM,SAAS;CAGvD,IAAI;CACJ,MAAM,aAAa,YAAqC;EACvD,IAAI,MAAM,KACT,OAAO,KAAK;EAEb,UAAU,MAAM,eAAe,CAAC,GAAG,OAAO;EAC1C,OAAO;CACR;CACA,MAAM,WACL,MAAM,aACL,UAAU,WAAW,MAAM,UAAU,SAAS,MAAM,WAAW,GAAG,SAAS,IAAI,IAAI,KAAA;CAGrF,MAAM,QAAQ,UAAU,QACrB,MAAM,UAAU,MAAM,MAAM,WAAW,GAAG,SAAS,IAAI,IACvD,KAAA;CACH,MAAM,MAAM,MAAM,uBAAO,IAAI,KAAK;CAClC,MAAM,SAAS,MAAM,eAAe;EACnC,KAAK;GACJ,MAAM,MAAM;GACZ,MAAM,MAAM;GACZ,MAAM,MAAM;GACZ,UAAU,MAAM;GAChB,UAAU,MAAM;GAChB,OAAO,MAAM;GACb,OAAO,MAAM;GACb,OAAO,MAAM;GACb,UAAU,MAAM;EACjB;EACA,SAAS,mBAAmB,OAAO,MAAM,GAAG;EAC5C,aAAa,KAAK;EAClB,MAAM,MAAM,UAAU,SAAS,GAAG;EAClC;EACA;EACA;EACA;CACD,CAAC;CACD,MAAM,SAAS,KAAK,UAAU;CAC9B,IAAI,CAAC,QAAQ;EACZ,MAAM,WAAW,SAAS,CAAC,MAAM,CAAC;EAClC;CACD;CACA,OAAO,IAAI,MAAM;CACjB,IAAI,MAAM,OACT,MAAM,OAAO,MAAM;AAErB;;;;;;;;;;;;;AAcD,MAAa,mBAAmB,OAC/B,SACA,OACA,SACmB;CACnB,MAAM,QAAQ,WAAW,OAAO,GAC7B,SAAS,IAAI,EACd,MAAM,YAAY,QAAQ,QAAQ,KAAK,GAAG,QAAQ;CACpD,IAAI,CAAC,OACJ,MAAM,IAAI,oBACT,0GACD;CAED,MAAM,MAAM,OAAO,IAAI;AACxB"}
@@ -0,0 +1,7 @@
1
+ //#region src/native/ingest/source.d.ts
2
+ /** Every bucket the `source` dimension can hold, lowercase as they are stored. */
3
+ declare const TRAFFIC_CHANNELS: readonly ["direct", "search", "social", "email", "paid", "referral"];
4
+ type TrafficChannel = (typeof TRAFFIC_CHANNELS)[number];
5
+ //#endregion
6
+ export { TRAFFIC_CHANNELS, TrafficChannel };
7
+ //# sourceMappingURL=source.d.ts.map
@@ -1,22 +1,147 @@
1
1
  //#region src/native/ingest/source.ts
2
- const stripWww = (host) => host.replace(/^www\./, "");
2
+ /** Every bucket the `source` dimension can hold, lowercase as they are stored. */
3
+ const TRAFFIC_CHANNELS = [
4
+ "direct",
5
+ "search",
6
+ "social",
7
+ "email",
8
+ "paid",
9
+ "referral"
10
+ ];
3
11
  /**
4
- * Reduce a raw referrer URL to a coarse traffic source: the bare referrer host
5
- * (without `www.`), or `Direct` when there is no referrer, it is unparseable, or it
6
- * points back at the site itself (internal navigation is not a traffic source).
12
+ * A `Map` rather than an object literal: a lookup keyed by whatever `utm_medium` carries must
13
+ * answer nothing for `constructor` or `__proto__`, where an object literal answers an
14
+ * inherited member and puts a function in the `source` column.
15
+ *
16
+ * `referral` is deliberately absent. It names the channel the host branch already decides, and
17
+ * pinning it here would turn a hit with no referrer at all into `referral` rather than `direct`.
7
18
  */
8
- const deriveSource = (referrer, selfHostname) => {
9
- if (!referrer) return "Direct";
10
- let host;
11
- try {
12
- host = new URL(referrer).hostname;
13
- } catch {
14
- return "Direct";
19
+ const MEDIUM_CHANNELS = new Map([
20
+ ["cpc", "paid"],
21
+ ["ppc", "paid"],
22
+ ["display", "paid"],
23
+ ["retargeting", "paid"],
24
+ ["email", "email"],
25
+ ["newsletter", "email"],
26
+ ["social", "social"],
27
+ ["social-media", "social"],
28
+ ["sm", "social"],
29
+ ["organic", "search"],
30
+ ["search", "search"]
31
+ ]);
32
+ /** A click id only an ad click carries, whatever the referrer says. */
33
+ const CLICK_IDS = new Set([
34
+ "gclid",
35
+ "fbclid",
36
+ "msclkid",
37
+ "ttclid"
38
+ ]);
39
+ /**
40
+ * Hosts whose channel the lists below would get wrong, checked first. Webmail is `referral`
41
+ * rather than `email`: a referrer only proves a link was opened in a mail client, never that
42
+ * the mail was the newsletter an `email` bucket claims credit for.
43
+ */
44
+ const HOST_OVERRIDES = new Map([
45
+ ["mail.google.com", "referral"],
46
+ ["mail.yahoo.com", "referral"],
47
+ ["outlook.live.com", "referral"],
48
+ ["outlook.office.com", "referral"],
49
+ ["mail.proton.me", "referral"]
50
+ ]);
51
+ const SEARCH_HOSTS = [
52
+ "bing.com",
53
+ "duckduckgo.com",
54
+ "baidu.com",
55
+ "ecosia.org",
56
+ "search.brave.com",
57
+ "qwant.com",
58
+ "startpage.com",
59
+ "naver.com",
60
+ "seznam.cz",
61
+ "sogou.com"
62
+ ];
63
+ const SOCIAL_HOSTS = [
64
+ "facebook.com",
65
+ "fb.com",
66
+ "instagram.com",
67
+ "twitter.com",
68
+ "x.com",
69
+ "t.co",
70
+ "linkedin.com",
71
+ "lnkd.in",
72
+ "reddit.com",
73
+ "tiktok.com",
74
+ "youtube.com",
75
+ "youtu.be",
76
+ "threads.net",
77
+ "mastodon.social",
78
+ "bsky.app",
79
+ "web.telegram.org",
80
+ "t.me",
81
+ "wa.me",
82
+ "whatsapp.com"
83
+ ];
84
+ /** Brands running one site per country, matched on the label rather than a fixed tld. */
85
+ const SEARCH_BRANDS = [
86
+ "google",
87
+ "yahoo",
88
+ "yandex"
89
+ ];
90
+ const SOCIAL_BRANDS = ["pinterest"];
91
+ /**
92
+ * Second-level suffixes a brand's country site sits under (`google.co.uk`, `yahoo.com.au`).
93
+ * Without this list a two-label tail would also match `google.evil.com`, handing any host that
94
+ * cares to name itself after a search engine the search channel.
95
+ */
96
+ const SECOND_LEVEL = new Set([
97
+ "co",
98
+ "com",
99
+ "net",
100
+ "org",
101
+ "ac",
102
+ "gov",
103
+ "edu"
104
+ ]);
105
+ const matchesHost = (host, domain) => host === domain || host.endsWith(`.${domain}`);
106
+ const matchesBrand = (host, brand) => {
107
+ const labels = host.split(".");
108
+ for (let i = 0; i < labels.length; i++) {
109
+ if (labels[i] !== brand) continue;
110
+ const tail = labels.length - i - 1;
111
+ if (tail === 1 || tail === 2 && SECOND_LEVEL.has(labels[i + 1] ?? "")) return true;
112
+ }
113
+ return false;
114
+ };
115
+ const hostChannel = (host) => {
116
+ for (const [domain, channel] of HOST_OVERRIDES) if (matchesHost(host, domain)) return channel;
117
+ if (SEARCH_HOSTS.some((domain) => matchesHost(host, domain)) || SEARCH_BRANDS.some((brand) => matchesBrand(host, brand))) return "search";
118
+ if (SOCIAL_HOSTS.some((domain) => matchesHost(host, domain)) || SOCIAL_BRANDS.some((brand) => matchesBrand(host, brand))) return "social";
119
+ return "referral";
120
+ };
121
+ const hasClickId = (query) => {
122
+ for (const [key, value] of new URLSearchParams(query)) if (value && CLICK_IDS.has(key.toLowerCase())) return true;
123
+ return false;
124
+ };
125
+ /**
126
+ * The `source` dimension's bucket: the traffic channel a hit arrived through, which is what a
127
+ * report is asked for ("how much of last month was paid?"), where the host it came from is the
128
+ * `referrer` dimension's job.
129
+ *
130
+ * `utm_medium` wins outright, because a campaign states its own channel and the referrer host
131
+ * is then only the last hop; a paid click id is next, since an ad click carries one whatever
132
+ * host it bounced through; the built-in search and social lists decide the rest. Anything else
133
+ * with a host is `referral`, and a hit with no usable host at all is `direct`.
134
+ */
135
+ const deriveSource = ({ referrerHost, utmMedium, query }) => {
136
+ const medium = utmMedium?.trim().toLowerCase();
137
+ if (medium) {
138
+ const channel = medium.startsWith("paid") ? "paid" : MEDIUM_CHANNELS.get(medium);
139
+ if (channel) return channel;
15
140
  }
16
- if (!host || stripWww(host) === stripWww(selfHostname)) return "Direct";
17
- return stripWww(host);
141
+ if (query && hasClickId(query)) return "paid";
142
+ return referrerHost ? hostChannel(referrerHost) : "direct";
18
143
  };
19
144
  //#endregion
20
- export { deriveSource };
145
+ export { TRAFFIC_CHANNELS, deriveSource };
21
146
 
22
147
  //# sourceMappingURL=source.js.map