@10x-media/analytics 0.1.0-beta.5 → 1.0.0-beta.10
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.
- package/CHANGELOG.md +270 -0
- package/LICENSE +21 -21
- package/README.md +15 -4
- package/dist/adapters/ga4/disableKey.d.ts +9 -0
- package/dist/adapters/ga4/disableKey.js +21 -0
- package/dist/adapters/ga4/disableKey.js.map +1 -0
- package/dist/adapters/ga4/eventName.d.ts +15 -0
- package/dist/adapters/ga4/eventName.js +19 -0
- package/dist/adapters/ga4/eventName.js.map +1 -0
- package/dist/adapters/ga4/ga4.d.ts +5 -0
- package/dist/adapters/ga4/ga4.js +186 -58
- package/dist/adapters/ga4/ga4.js.map +1 -1
- package/dist/adapters/ga4/measurementId.js +15 -0
- package/dist/adapters/ga4/measurementId.js.map +1 -0
- package/dist/adapters/goalRead.js +126 -0
- package/dist/adapters/goalRead.js.map +1 -0
- package/dist/adapters/http/fetchJson.js +1 -1
- package/dist/adapters/plausible/plausible.d.ts +25 -0
- package/dist/adapters/plausible/plausible.js +159 -38
- package/dist/adapters/plausible/plausible.js.map +1 -1
- package/dist/adapters/posthog/posthog.d.ts +10 -1
- package/dist/adapters/posthog/posthog.js +130 -21
- package/dist/adapters/posthog/posthog.js.map +1 -1
- package/dist/adapters/series.js +11 -1
- package/dist/adapters/series.js.map +1 -1
- package/dist/adapters/umami/umami.d.ts +13 -1
- package/dist/adapters/umami/umami.js +278 -26
- package/dist/adapters/umami/umami.js.map +1 -1
- package/dist/binding/resolvePath.js +18 -2
- package/dist/binding/resolvePath.js.map +1 -1
- package/dist/capture/getTrackerConfig.d.ts +20 -0
- package/dist/capture/getTrackerConfig.js +31 -0
- package/dist/capture/getTrackerConfig.js.map +1 -0
- package/dist/capture/mountPath.js +14 -0
- package/dist/capture/mountPath.js.map +1 -0
- package/dist/capture/proxyEndpoint.js +127 -0
- package/dist/capture/proxyEndpoint.js.map +1 -0
- package/dist/capture/proxyRoutes.js +108 -0
- package/dist/capture/proxyRoutes.js.map +1 -0
- package/dist/capture/requestBody.js +68 -0
- package/dist/capture/requestBody.js.map +1 -0
- package/dist/capture/slots.d.ts +8 -0
- package/dist/capture/slots.js +54 -0
- package/dist/capture/slots.js.map +1 -0
- package/dist/capture/trackerConfig.d.ts +33 -0
- package/dist/capture/trackerConfig.js +95 -0
- package/dist/capture/trackerConfig.js.map +1 -0
- package/dist/capture/trackerEndpoint.js +35 -0
- package/dist/capture/trackerEndpoint.js.map +1 -0
- package/dist/charts/BarList.d.ts +16 -1
- package/dist/charts/BarList.js +41 -19
- package/dist/charts/BarList.js.map +1 -1
- package/dist/charts/TrendChart.d.ts +16 -3
- package/dist/charts/TrendChart.js +172 -106
- package/dist/charts/TrendChart.js.map +1 -1
- package/dist/charts/bars.d.ts +4 -0
- package/dist/charts/bars.js +3 -1
- package/dist/charts/bars.js.map +1 -1
- package/dist/charts/bucket.js +10 -1
- package/dist/charts/bucket.js.map +1 -1
- package/dist/charts/spline.js +2 -2
- package/dist/charts/spline.js.map +1 -1
- package/dist/charts/styles.js +18 -1
- package/dist/charts/styles.js.map +1 -1
- package/dist/core/cacheKey.js +26 -3
- package/dist/core/cacheKey.js.map +1 -1
- package/dist/core/capabilities.d.ts +5 -1
- package/dist/core/capabilities.js +11 -2
- package/dist/core/capabilities.js.map +1 -1
- package/dist/core/capture.d.ts +49 -0
- package/dist/core/contract.d.ts +74 -5
- package/dist/core/contract.js +30 -1
- package/dist/core/contract.js.map +1 -1
- package/dist/core/granularity.js +1 -1
- package/dist/core/options.d.ts +164 -6
- package/dist/core/options.js +126 -3
- package/dist/core/options.js.map +1 -1
- package/dist/core/registry.d.ts +1 -0
- package/dist/core/scopeList.js +32 -0
- package/dist/core/scopeList.js.map +1 -0
- package/dist/core/scopedRead.js +101 -30
- package/dist/core/scopedRead.js.map +1 -1
- package/dist/core/serverEvent.d.ts +60 -0
- package/dist/core/serverEvent.js +12 -0
- package/dist/core/serverEvent.js.map +1 -0
- package/dist/exports/adapters/ga4.d.ts +2 -1
- package/dist/exports/adapters/ga4.js +2 -1
- package/dist/exports/adapters/native.d.ts +3 -1
- package/dist/exports/adapters/native.js +2 -1
- package/dist/exports/client.d.ts +13 -3
- package/dist/exports/client.js +10 -1
- package/dist/exports/geo.d.ts +2 -2
- package/dist/exports/next.d.ts +2 -1
- package/dist/exports/next.js +2 -1
- package/dist/exports/react.d.ts +4 -0
- package/dist/exports/react.js +5 -0
- package/dist/exports/rsc.d.ts +11 -3
- package/dist/exports/rsc.js +7 -2
- package/dist/exports/tracker.d.ts +21 -0
- package/dist/exports/tracker.js +15 -0
- package/dist/exports/types.d.ts +16 -3
- package/dist/exports/types.js +4 -2
- package/dist/fields/AnalyticsPanelClient.js +2 -2
- package/dist/fields/AnalyticsPanelField.js +1 -1
- package/dist/fields/AnalyticsStatField.js +2 -2
- package/dist/fields/config/FilterDimensionSelectField.d.ts +14 -0
- package/dist/fields/config/FilterDimensionSelectField.js +77 -0
- package/dist/fields/config/FilterDimensionSelectField.js.map +1 -0
- package/dist/fields/config/FilterOperatorSelectField.d.ts +14 -0
- package/dist/fields/config/FilterOperatorSelectField.js +75 -0
- package/dist/fields/config/FilterOperatorSelectField.js.map +1 -0
- package/dist/fields/config/MetricSelectField.js +3 -3
- package/dist/fields/config/MetricSelectField.js.map +1 -1
- package/dist/fields/config/SourceSelectField.js +3 -3
- package/dist/fields/config/SourceSelectField.js.map +1 -1
- package/dist/fields/config/fetchSources.d.ts +5 -1
- package/dist/fields/config/fetchSources.js +7 -3
- package/dist/fields/config/fetchSources.js.map +1 -1
- package/dist/fields/config/narrow.js +2 -0
- package/dist/fields/config/narrow.js.map +1 -1
- package/dist/fields/config/sourcesState.js +19 -3
- package/dist/fields/config/sourcesState.js.map +1 -1
- package/dist/fields/config/useAnalyticsSources.d.ts +8 -3
- package/dist/fields/config/useAnalyticsSources.js +9 -6
- package/dist/fields/config/useAnalyticsSources.js.map +1 -1
- package/dist/fields/config/useFilterCapabilities.d.ts +28 -0
- package/dist/fields/config/useFilterCapabilities.js +52 -0
- package/dist/fields/config/useFilterCapabilities.js.map +1 -0
- package/dist/fields/readForDocument.d.ts +5 -0
- package/dist/fields/readForDocument.js +22 -10
- package/dist/fields/readForDocument.js.map +1 -1
- package/dist/goals/GoalSelectField.d.ts +7 -0
- package/dist/goals/GoalSelectField.js +77 -0
- package/dist/goals/GoalSelectField.js.map +1 -0
- package/dist/goals/collection.js +254 -0
- package/dist/goals/collection.js.map +1 -0
- package/dist/goals/currency.js +14 -0
- package/dist/goals/currency.js.map +1 -0
- package/dist/goals/fetchGoals.d.ts +18 -0
- package/dist/goals/fetchGoals.js +33 -0
- package/dist/goals/fetchGoals.js.map +1 -0
- package/dist/goals/goalField.d.ts +31 -0
- package/dist/goals/goalField.js +56 -0
- package/dist/goals/goalField.js.map +1 -0
- package/dist/goals/goalsEndpoint.d.ts +1 -0
- package/dist/goals/goalsEndpoint.js +58 -0
- package/dist/goals/goalsEndpoint.js.map +1 -0
- package/dist/goals/match.js +64 -0
- package/dist/goals/match.js.map +1 -0
- package/dist/goals/resolver.d.ts +8 -0
- package/dist/goals/resolver.js +147 -0
- package/dist/goals/resolver.js.map +1 -0
- package/dist/goals/trackGoalAction.d.ts +76 -0
- package/dist/goals/trackGoalAction.js +158 -0
- package/dist/goals/trackGoalAction.js.map +1 -0
- package/dist/goals/types.d.ts +33 -0
- package/dist/goals/types.js +7 -0
- package/dist/goals/types.js.map +1 -0
- package/dist/goals/useAnalyticsGoals.d.ts +20 -0
- package/dist/goals/useAnalyticsGoals.js +67 -0
- package/dist/goals/useAnalyticsGoals.js.map +1 -0
- package/dist/index.d.ts +14 -3
- package/dist/index.js +174 -19
- package/dist/index.js.map +1 -1
- package/dist/native/collections/events.js +65 -1
- package/dist/native/collections/events.js.map +1 -1
- package/dist/native/collections/rollups.js +39 -3
- package/dist/native/collections/rollups.js.map +1 -1
- package/dist/native/eventScan.js +25 -0
- package/dist/native/eventScan.js.map +1 -0
- package/dist/native/geo/composeGeoResolvers.js +2 -2
- package/dist/native/geo/composeGeoResolvers.js.map +1 -1
- package/dist/native/geo/geoResolver.d.ts +9 -2
- package/dist/native/geo/geoResolver.js.map +1 -1
- package/dist/native/geo/maxmindResolver.js +3 -5
- package/dist/native/geo/maxmindResolver.js.map +1 -1
- package/dist/native/ingest/bots.d.ts +11 -0
- package/dist/native/ingest/bots.js +71 -0
- package/dist/native/ingest/bots.js.map +1 -0
- package/dist/native/ingest/browser.js +47 -0
- package/dist/native/ingest/browser.js.map +1 -0
- package/dist/native/ingest/clientIp.js +20 -0
- package/dist/native/ingest/clientIp.js.map +1 -0
- package/dist/native/ingest/device.js +11 -3
- package/dist/native/ingest/device.js.map +1 -1
- package/dist/native/ingest/endpoint.d.ts +1 -0
- package/dist/native/ingest/endpoint.js +107 -21
- package/dist/native/ingest/endpoint.js.map +1 -1
- package/dist/native/ingest/flushBatch.js +29 -38
- package/dist/native/ingest/flushBatch.js.map +1 -1
- package/dist/native/ingest/language.js +14 -0
- package/dist/native/ingest/language.js.map +1 -0
- package/dist/native/ingest/normalizeEvent.d.ts +30 -0
- package/dist/native/ingest/normalizeEvent.js +115 -16
- package/dist/native/ingest/normalizeEvent.js.map +1 -1
- package/dist/native/ingest/referrer.js +48 -0
- package/dist/native/ingest/referrer.js.map +1 -0
- package/dist/native/ingest/requestHost.js +57 -0
- package/dist/native/ingest/requestHost.js.map +1 -0
- package/dist/native/ingest/resolveHostname.d.ts +29 -0
- package/dist/native/ingest/resolveHostname.js +52 -0
- package/dist/native/ingest/resolveHostname.js.map +1 -0
- package/dist/native/ingest/salt.js +27 -2
- package/dist/native/ingest/salt.js.map +1 -1
- package/dist/native/ingest/serverTrack.d.ts +20 -0
- package/dist/native/ingest/serverTrack.js +109 -0
- package/dist/native/ingest/serverTrack.js.map +1 -0
- package/dist/native/ingest/source.d.ts +11 -0
- package/dist/native/ingest/source.js +264 -16
- package/dist/native/ingest/source.js.map +1 -1
- package/dist/native/ingest/utm.js +33 -0
- package/dist/native/ingest/utm.js.map +1 -0
- package/dist/native/ingest/validate.js +26 -0
- package/dist/native/ingest/validate.js.map +1 -0
- package/dist/native/nativeAdapter.d.ts +37 -1
- package/dist/native/nativeAdapter.js +175 -22
- package/dist/native/nativeAdapter.js.map +1 -1
- package/dist/native/query/eventAgg.js +175 -0
- package/dist/native/query/eventAgg.js.map +1 -0
- package/dist/native/retention/pruneTask.js +53 -13
- package/dist/native/retention/pruneTask.js.map +1 -1
- package/dist/native/rollupAcc.js +12 -1
- package/dist/native/rollupAcc.js.map +1 -1
- package/dist/native/rollups/bucketKey.js +15 -0
- package/dist/native/rollups/bucketKey.js.map +1 -0
- package/dist/native/rollups/bumpRollups.js +116 -0
- package/dist/native/rollups/bumpRollups.js.map +1 -0
- package/dist/native/rollups/deltas.js +86 -11
- package/dist/native/rollups/deltas.js.map +1 -1
- package/dist/native/rollups/insertManyIfNew.js +93 -0
- package/dist/native/rollups/insertManyIfNew.js.map +1 -0
- package/dist/next/captureRewrites.d.ts +42 -0
- package/dist/next/captureRewrites.js +57 -0
- package/dist/next/captureRewrites.js.map +1 -0
- package/dist/next/posthogProxyRewrites.d.ts +5 -0
- package/dist/next/posthogProxyRewrites.js +16 -21
- package/dist/next/posthogProxyRewrites.js.map +1 -1
- package/dist/plugin/documentEndpoint.js +71 -24
- package/dist/plugin/documentEndpoint.js.map +1 -1
- package/dist/plugin/errors.d.ts +31 -0
- package/dist/plugin/errors.js +79 -0
- package/dist/plugin/errors.js.map +1 -0
- package/dist/plugin/goalHint.d.ts +1 -0
- package/dist/plugin/goalHint.js +24 -0
- package/dist/plugin/goalHint.js.map +1 -0
- package/dist/plugin/paths.js +17 -1
- package/dist/plugin/paths.js.map +1 -1
- package/dist/plugin/queryEndpoint.js +124 -0
- package/dist/plugin/queryEndpoint.js.map +1 -0
- package/dist/plugin/readContextForRequest.js +73 -0
- package/dist/plugin/readContextForRequest.js.map +1 -0
- package/dist/plugin/realtimeEndpoint.js +37 -16
- package/dist/plugin/realtimeEndpoint.js.map +1 -1
- package/dist/plugin/refreshEndpoint.js +113 -0
- package/dist/plugin/refreshEndpoint.js.map +1 -0
- package/dist/plugin/runtime.d.ts +1 -0
- package/dist/plugin/runtime.js +33 -1
- package/dist/plugin/runtime.js.map +1 -1
- package/dist/plugin/scopeChange.js +22 -0
- package/dist/plugin/scopeChange.js.map +1 -0
- package/dist/plugin/scopeFieldBoot.js +22 -0
- package/dist/plugin/scopeFieldBoot.js.map +1 -0
- package/dist/plugin/sourcesEndpoint.js +16 -41
- package/dist/plugin/sourcesEndpoint.js.map +1 -1
- package/dist/plugin/warmTask.js +0 -0
- package/dist/plugin/warmTask.js.map +1 -1
- package/dist/providers/collection.js +89 -29
- package/dist/providers/collection.js.map +1 -1
- package/dist/providers/factory.js +11 -3
- package/dist/providers/factory.js.map +1 -1
- package/dist/providers/resolver.js.map +1 -1
- package/dist/query/dates.js +64 -0
- package/dist/query/dates.js.map +1 -0
- package/dist/query/errors.d.ts +14 -0
- package/dist/query/fetchQuery.d.ts +79 -0
- package/dist/query/fetchQuery.js +117 -0
- package/dist/query/fetchQuery.js.map +1 -0
- package/dist/query/parse.d.ts +22 -0
- package/dist/query/parse.js +168 -0
- package/dist/query/parse.js.map +1 -0
- package/dist/query/response.d.ts +39 -0
- package/dist/query/response.js +11 -0
- package/dist/query/response.js.map +1 -0
- package/dist/react/AnalyticsProvider.d.ts +50 -0
- package/dist/react/AnalyticsProvider.js +67 -0
- package/dist/react/AnalyticsProvider.js.map +1 -0
- package/dist/react/TrackerBoot.d.ts +22 -0
- package/dist/react/TrackerBoot.js +30 -0
- package/dist/react/TrackerBoot.js.map +1 -0
- package/dist/react/useAnalytics.d.ts +20 -0
- package/dist/react/useAnalytics.js +52 -0
- package/dist/react/useAnalytics.js.map +1 -0
- package/dist/rsc/AnalyticsScripts.d.ts +30 -0
- package/dist/rsc/AnalyticsScripts.js +41 -0
- package/dist/rsc/AnalyticsScripts.js.map +1 -0
- package/dist/surfacing/cacheStore.d.ts +1 -0
- package/dist/surfacing/cacheStore.js +18 -2
- package/dist/surfacing/cacheStore.js.map +1 -1
- package/dist/surfacing/engine.d.ts +1 -0
- package/dist/surfacing/engine.js +47 -6
- package/dist/surfacing/engine.js.map +1 -1
- package/dist/surfacing/epoch.d.ts +1 -0
- package/dist/surfacing/epoch.js +72 -0
- package/dist/surfacing/epoch.js.map +1 -0
- package/dist/surfacing/queue.js +22 -6
- package/dist/surfacing/queue.js.map +1 -1
- package/dist/surfacing/rateLimiter.js +130 -0
- package/dist/surfacing/rateLimiter.js.map +1 -0
- package/dist/surfacing/retryPolicy.js +15 -0
- package/dist/surfacing/retryPolicy.js.map +1 -0
- package/dist/sync/collection.js +23 -7
- package/dist/sync/collection.js.map +1 -1
- package/dist/sync/syncTask.js +68 -33
- package/dist/sync/syncTask.js.map +1 -1
- package/dist/testing/memoryAdapter.d.ts +2 -0
- package/dist/testing/memoryAdapter.js +17 -1
- package/dist/testing/memoryAdapter.js.map +1 -1
- package/dist/timeframe/tz.js +17 -6
- package/dist/timeframe/tz.js.map +1 -1
- package/dist/tracker/autoCapture.d.ts +48 -0
- package/dist/tracker/autoCapture.js +129 -0
- package/dist/tracker/autoCapture.js.map +1 -0
- package/dist/tracker/consent.d.ts +24 -0
- package/dist/tracker/consent.js +48 -0
- package/dist/tracker/consent.js.map +1 -0
- package/dist/tracker/createTracker.d.ts +18 -0
- package/dist/tracker/createTracker.js +215 -0
- package/dist/tracker/createTracker.js.map +1 -0
- package/dist/tracker/exclusion.d.ts +28 -0
- package/dist/tracker/exclusion.js +50 -0
- package/dist/tracker/exclusion.js.map +1 -0
- package/dist/tracker/initTracker.d.ts +22 -0
- package/dist/tracker/initTracker.js +33 -0
- package/dist/tracker/initTracker.js.map +1 -0
- package/dist/tracker/loadScript.d.ts +14 -0
- package/dist/tracker/loadScript.js +41 -0
- package/dist/tracker/loadScript.js.map +1 -0
- package/dist/tracker/pageTracking.d.ts +17 -0
- package/dist/tracker/pageTracking.js +38 -0
- package/dist/tracker/pageTracking.js.map +1 -0
- package/dist/tracker/registry.d.ts +27 -0
- package/dist/tracker/registry.js +73 -0
- package/dist/tracker/registry.js.map +1 -0
- package/dist/tracker/sinks/ga4.d.ts +29 -0
- package/dist/tracker/sinks/ga4.js +30 -0
- package/dist/tracker/sinks/ga4.js.map +1 -0
- package/dist/tracker/sinks/native.d.ts +22 -0
- package/dist/tracker/sinks/native.js +56 -0
- package/dist/tracker/sinks/native.js.map +1 -0
- package/dist/tracker/sinks/plausible.d.ts +20 -0
- package/dist/tracker/sinks/plausible.js +32 -0
- package/dist/tracker/sinks/plausible.js.map +1 -0
- package/dist/tracker/sinks/posthog.d.ts +18 -0
- package/dist/tracker/sinks/posthog.js +30 -0
- package/dist/tracker/sinks/posthog.js.map +1 -0
- package/dist/tracker/sinks/umami.d.ts +18 -0
- package/dist/tracker/sinks/umami.js +23 -0
- package/dist/tracker/sinks/umami.js.map +1 -0
- package/dist/tracker/sinks/vendor.d.ts +14 -0
- package/dist/tracker/sinks/vendor.js +81 -0
- package/dist/tracker/sinks/vendor.js.map +1 -0
- package/dist/tracker/transport.js +28 -0
- package/dist/tracker/transport.js.map +1 -0
- package/dist/tracker/types.d.ts +91 -0
- package/dist/translations/ar.js +221 -0
- package/dist/translations/ar.js.map +1 -0
- package/dist/translations/de.js +145 -1
- package/dist/translations/de.js.map +1 -1
- package/dist/translations/en.js +145 -1
- package/dist/translations/en.js.map +1 -1
- package/dist/translations/es.js +221 -0
- package/dist/translations/es.js.map +1 -0
- package/dist/translations/fr.js +221 -0
- package/dist/translations/fr.js.map +1 -0
- package/dist/translations/id.js +221 -0
- package/dist/translations/id.js.map +1 -0
- package/dist/translations/index.d.ts +10 -1
- package/dist/translations/index.js +19 -1
- package/dist/translations/index.js.map +1 -1
- package/dist/translations/keys.d.ts +144 -0
- package/dist/translations/keys.js +145 -1
- package/dist/translations/keys.js.map +1 -1
- package/dist/translations/ko.js +221 -0
- package/dist/translations/ko.js.map +1 -0
- package/dist/translations/metricKeys.js +8 -2
- package/dist/translations/metricKeys.js.map +1 -1
- package/dist/translations/pt.js +221 -0
- package/dist/translations/pt.js.map +1 -0
- package/dist/translations/ru.js +221 -0
- package/dist/translations/ru.js.map +1 -0
- package/dist/translations/server.js.map +1 -1
- package/dist/translations/uk.js +221 -0
- package/dist/translations/uk.js.map +1 -0
- package/dist/translations/zh.js +221 -0
- package/dist/translations/zh.js.map +1 -0
- package/dist/view/AnalyticsNavLink.d.ts +19 -0
- package/dist/view/AnalyticsNavLink.js +40 -0
- package/dist/view/AnalyticsNavLink.js.map +1 -0
- package/dist/view/AnalyticsView.d.ts +23 -0
- package/dist/view/AnalyticsView.js +45 -0
- package/dist/view/AnalyticsView.js.map +1 -0
- package/dist/view/AnalyticsViewClient.d.ts +15 -0
- package/dist/view/AnalyticsViewClient.js +244 -0
- package/dist/view/AnalyticsViewClient.js.map +1 -0
- package/dist/view/authRedirect.js +32 -0
- package/dist/view/authRedirect.js.map +1 -0
- package/dist/view/conversionRate.js +18 -0
- package/dist/view/conversionRate.js.map +1 -0
- package/dist/view/dayRange.js +68 -0
- package/dist/view/dayRange.js.map +1 -0
- package/dist/view/gating.d.ts +1 -0
- package/dist/view/gating.js +142 -0
- package/dist/view/gating.js.map +1 -0
- package/dist/view/labels.js +76 -0
- package/dist/view/labels.js.map +1 -0
- package/dist/view/registerView.js +48 -0
- package/dist/view/registerView.js.map +1 -0
- package/dist/view/sections/Breakdowns.js +198 -0
- package/dist/view/sections/Breakdowns.js.map +1 -0
- package/dist/view/sections/EmptyStates.js +92 -0
- package/dist/view/sections/EmptyStates.js.map +1 -0
- package/dist/view/sections/FilterChips.js +46 -0
- package/dist/view/sections/FilterChips.js.map +1 -0
- package/dist/view/sections/GoalsPanel.js +82 -0
- package/dist/view/sections/GoalsPanel.js.map +1 -0
- package/dist/view/sections/OverviewCards.js +65 -0
- package/dist/view/sections/OverviewCards.js.map +1 -0
- package/dist/view/sections/RealtimeStrip.js +80 -0
- package/dist/view/sections/RealtimeStrip.js.map +1 -0
- package/dist/view/sections/Toolbar.js +207 -0
- package/dist/view/sections/Toolbar.js.map +1 -0
- package/dist/view/sections/Trend.js +125 -0
- package/dist/view/sections/Trend.js.map +1 -0
- package/dist/view/sections/styles.js +76 -0
- package/dist/view/sections/styles.js.map +1 -0
- package/dist/view/state.js +211 -0
- package/dist/view/state.js.map +1 -0
- package/dist/view/useViewQueries.js +153 -0
- package/dist/view/useViewQueries.js.map +1 -0
- package/dist/view/viewProps.d.ts +40 -0
- package/dist/view/viewProps.js +90 -0
- package/dist/view/viewProps.js.map +1 -0
- package/dist/widgets/AnalyticsBreakdownWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsBreakdownWidget.js +78 -11
- package/dist/widgets/AnalyticsBreakdownWidget.js.map +1 -1
- package/dist/widgets/AnalyticsGoalsWidget.d.ts +14 -0
- package/dist/widgets/AnalyticsGoalsWidget.js +196 -0
- package/dist/widgets/AnalyticsGoalsWidget.js.map +1 -0
- package/dist/widgets/AnalyticsMetricWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsMetricWidget.js +63 -13
- package/dist/widgets/AnalyticsMetricWidget.js.map +1 -1
- package/dist/widgets/AnalyticsRealtimeWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsRealtimeWidget.js +44 -22
- package/dist/widgets/AnalyticsRealtimeWidget.js.map +1 -1
- package/dist/widgets/AnalyticsTrendWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsTrendWidget.js +79 -16
- package/dist/widgets/AnalyticsTrendWidget.js.map +1 -1
- package/dist/widgets/RealtimeCounter.d.ts +4 -0
- package/dist/widgets/RealtimeCounter.js +18 -4
- package/dist/widgets/RealtimeCounter.js.map +1 -1
- package/dist/widgets/WidgetViewLink.js +17 -0
- package/dist/widgets/WidgetViewLink.js.map +1 -0
- package/dist/widgets/breakdownTypes.js +38 -0
- package/dist/widgets/breakdownTypes.js.map +1 -1
- package/dist/widgets/cardChrome.js +31 -7
- package/dist/widgets/cardChrome.js.map +1 -1
- package/dist/widgets/comparison.js +15 -1
- package/dist/widgets/comparison.js.map +1 -1
- package/dist/widgets/defaults.d.ts +6 -2
- package/dist/widgets/defaults.js +78 -23
- package/dist/widgets/defaults.js.map +1 -1
- package/dist/widgets/filterCaption.js +27 -0
- package/dist/widgets/filterCaption.js.map +1 -0
- package/dist/widgets/filterField.d.ts +19 -0
- package/dist/widgets/filterField.js +75 -0
- package/dist/widgets/filterField.js.map +1 -0
- package/dist/widgets/prepareWidgetRead.d.ts +7 -0
- package/dist/widgets/prepareWidgetRead.js +74 -0
- package/dist/widgets/prepareWidgetRead.js.map +1 -0
- package/dist/widgets/range.js +43 -12
- package/dist/widgets/range.js.map +1 -1
- package/dist/widgets/readForWidget.d.ts +26 -3
- package/dist/widgets/readForWidget.js +48 -44
- package/dist/widgets/readForWidget.js.map +1 -1
- package/dist/widgets/readForWidgetBreakdown.d.ts +34 -2
- package/dist/widgets/readForWidgetBreakdown.js +53 -49
- package/dist/widgets/readForWidgetBreakdown.js.map +1 -1
- package/dist/widgets/readForWidgetGoals.d.ts +67 -0
- package/dist/widgets/readForWidgetGoals.js +140 -0
- package/dist/widgets/readForWidgetGoals.js.map +1 -0
- package/dist/widgets/readForWidgetRealtime.d.ts +8 -0
- package/dist/widgets/readForWidgetRealtime.js +23 -21
- package/dist/widgets/readForWidgetRealtime.js.map +1 -1
- package/dist/widgets/readForWidgetSeries.d.ts +26 -2
- package/dist/widgets/readForWidgetSeries.js +78 -53
- package/dist/widgets/readForWidgetSeries.js.map +1 -1
- package/dist/widgets/readMeta.js +18 -0
- package/dist/widgets/readMeta.js.map +1 -0
- package/dist/widgets/realtimePoll.js +13 -1
- package/dist/widgets/realtimePoll.js.map +1 -1
- package/dist/widgets/registerWidgets.js +62 -10
- package/dist/widgets/registerWidgets.js.map +1 -1
- package/dist/widgets/types.d.ts +15 -0
- package/dist/widgets/types.js +16 -2
- package/dist/widgets/types.js.map +1 -1
- package/dist/widgets/viewLink.d.ts +22 -0
- package/dist/widgets/viewLink.js +86 -0
- package/dist/widgets/viewLink.js.map +1 -0
- package/package.json +28 -8
- package/dist/native/rollups/applyDistinctDeltas.js +0 -9
- package/dist/native/rollups/applyDistinctDeltas.js.map +0 -1
- package/dist/native/rollups/bumpRollup.js +0 -68
- package/dist/native/rollups/bumpRollup.js.map +0 -1
- package/dist/native/rollups/insertIfNew.js +0 -19
- package/dist/native/rollups/insertIfNew.js.map +0 -1
|
@@ -1,22 +1,270 @@
|
|
|
1
1
|
//#region src/native/ingest/source.ts
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
2
|
+
/**
|
|
3
|
+
* Every acquisition channel the `channel` dimension can hold, lowercase as they are stored.
|
|
4
|
+
* Paid is split per platform rather than pooled, because that is the split every vendor
|
|
5
|
+
* reports and the one a budget question is actually asked in.
|
|
6
|
+
*/
|
|
7
|
+
const TRAFFIC_CHANNELS = [
|
|
8
|
+
"direct",
|
|
9
|
+
"organic-search",
|
|
10
|
+
"paid-search",
|
|
11
|
+
"organic-social",
|
|
12
|
+
"paid-social",
|
|
13
|
+
"organic-video",
|
|
14
|
+
"paid-video",
|
|
15
|
+
"email",
|
|
16
|
+
"affiliate",
|
|
17
|
+
"display",
|
|
18
|
+
"referral",
|
|
19
|
+
"paid-other"
|
|
20
|
+
];
|
|
21
|
+
const PAID_CHANNELS = {
|
|
22
|
+
search: "paid-search",
|
|
23
|
+
social: "paid-social",
|
|
24
|
+
video: "paid-video"
|
|
25
|
+
};
|
|
26
|
+
const ORGANIC_CHANNELS = {
|
|
27
|
+
search: "organic-search",
|
|
28
|
+
social: "organic-social",
|
|
29
|
+
video: "organic-video"
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* Every lookup below is a `Map` or a `Set` rather than an object literal: each is keyed by
|
|
33
|
+
* whatever `utm_medium`, `utm_source` or a query key carries, and an object literal answers
|
|
34
|
+
* an inherited member, which would put a function where a channel belongs.
|
|
35
|
+
*
|
|
36
|
+
* `referral` is deliberately absent. It names the channel the host branch already decides,
|
|
37
|
+
* and pinning it here would turn a hit with no referrer at all into `referral` rather than
|
|
38
|
+
* `direct`.
|
|
39
|
+
*/
|
|
40
|
+
const MEDIUM_CHANNELS = new Map([
|
|
41
|
+
["email", "email"],
|
|
42
|
+
["newsletter", "email"],
|
|
43
|
+
["affiliate", "affiliate"],
|
|
44
|
+
["affiliates", "affiliate"],
|
|
45
|
+
["display", "display"],
|
|
46
|
+
["banner", "display"],
|
|
47
|
+
["cpm", "display"],
|
|
48
|
+
["retargeting", "display"],
|
|
49
|
+
["remarketing", "display"],
|
|
50
|
+
["social", "organic-social"],
|
|
51
|
+
["social-media", "organic-social"],
|
|
52
|
+
["sm", "organic-social"],
|
|
53
|
+
["organic", "organic-search"],
|
|
54
|
+
["search", "organic-search"]
|
|
55
|
+
]);
|
|
56
|
+
/**
|
|
57
|
+
* Mediums that declare a paid visit, mapped to the platform the medium itself names. `null`
|
|
58
|
+
* is a medium that says "paid" and nothing more: `cpc` is as common on a social buy as on a
|
|
59
|
+
* search one, so it names no platform and leaves the referrer to. Any other medium starting
|
|
60
|
+
* `paid` is treated the same way.
|
|
61
|
+
*/
|
|
62
|
+
const PAID_MEDIUMS = new Map([
|
|
63
|
+
["cpc", null],
|
|
64
|
+
["ppc", null],
|
|
65
|
+
["paidsearch", "search"],
|
|
66
|
+
["paid-search", "search"],
|
|
67
|
+
["paid_search", "search"],
|
|
68
|
+
["paidsocial", "social"],
|
|
69
|
+
["paid-social", "social"],
|
|
70
|
+
["paid_social", "social"],
|
|
71
|
+
["paidvideo", "video"],
|
|
72
|
+
["paid-video", "video"],
|
|
73
|
+
["paid_video", "video"]
|
|
74
|
+
]);
|
|
75
|
+
/** Click ids only a paid click carries, and the platform of the network that issues each. */
|
|
76
|
+
const PAID_CLICK_IDS = new Map([
|
|
77
|
+
["gclid", "search"],
|
|
78
|
+
["gbraid", "search"],
|
|
79
|
+
["wbraid", "search"],
|
|
80
|
+
["msclkid", "search"],
|
|
81
|
+
["ttclid", "social"]
|
|
82
|
+
]);
|
|
83
|
+
/**
|
|
84
|
+
* Facebook appends `fbclid` to every outbound link, organic posts included, so it proves the
|
|
85
|
+
* platform and never the spend. It stands in for a referrer only when there is none, which is
|
|
86
|
+
* the in-app browser case it exists to cover.
|
|
87
|
+
*/
|
|
88
|
+
const FACEBOOK_CLICK_ID = "fbclid";
|
|
89
|
+
/**
|
|
90
|
+
* Hosts the lists below would get wrong, checked first and sorted into no platform at all.
|
|
91
|
+
* Webmail is a `referral` rather than `email`: a referrer only proves a link was opened in a
|
|
92
|
+
* mail client, never that the mail was the newsletter an `email` bucket claims credit for.
|
|
93
|
+
*/
|
|
94
|
+
const NON_PLATFORM_HOSTS = new Set([
|
|
95
|
+
"mail.google.com",
|
|
96
|
+
"mail.yahoo.com",
|
|
97
|
+
"outlook.live.com",
|
|
98
|
+
"outlook.office.com",
|
|
99
|
+
"mail.proton.me"
|
|
100
|
+
]);
|
|
101
|
+
const SEARCH_HOSTS = [
|
|
102
|
+
"bing.com",
|
|
103
|
+
"duckduckgo.com",
|
|
104
|
+
"baidu.com",
|
|
105
|
+
"ecosia.org",
|
|
106
|
+
"search.brave.com",
|
|
107
|
+
"qwant.com",
|
|
108
|
+
"startpage.com",
|
|
109
|
+
"naver.com",
|
|
110
|
+
"seznam.cz",
|
|
111
|
+
"sogou.com"
|
|
112
|
+
];
|
|
113
|
+
const SOCIAL_HOSTS = [
|
|
114
|
+
"facebook.com",
|
|
115
|
+
"fb.com",
|
|
116
|
+
"instagram.com",
|
|
117
|
+
"twitter.com",
|
|
118
|
+
"x.com",
|
|
119
|
+
"t.co",
|
|
120
|
+
"linkedin.com",
|
|
121
|
+
"lnkd.in",
|
|
122
|
+
"reddit.com",
|
|
123
|
+
"tiktok.com",
|
|
124
|
+
"threads.net",
|
|
125
|
+
"mastodon.social",
|
|
126
|
+
"bsky.app",
|
|
127
|
+
"web.telegram.org",
|
|
128
|
+
"t.me",
|
|
129
|
+
"wa.me",
|
|
130
|
+
"whatsapp.com"
|
|
131
|
+
];
|
|
132
|
+
const VIDEO_HOSTS = [
|
|
133
|
+
"youtube.com",
|
|
134
|
+
"youtu.be",
|
|
135
|
+
"vimeo.com"
|
|
136
|
+
];
|
|
137
|
+
/** Brands running one site per country, matched on the label rather than a fixed tld. */
|
|
138
|
+
const SEARCH_BRANDS = [
|
|
139
|
+
"google",
|
|
140
|
+
"yahoo",
|
|
141
|
+
"yandex"
|
|
142
|
+
];
|
|
143
|
+
const SOCIAL_BRANDS = ["pinterest"];
|
|
144
|
+
/** The same platforms by name, for the `utm_source` a hit carries instead of a referrer. */
|
|
145
|
+
const NAME_PLATFORMS = new Map([
|
|
146
|
+
["google", "search"],
|
|
147
|
+
["bing", "search"],
|
|
148
|
+
["yahoo", "search"],
|
|
149
|
+
["yandex", "search"],
|
|
150
|
+
["duckduckgo", "search"],
|
|
151
|
+
["baidu", "search"],
|
|
152
|
+
["ecosia", "search"],
|
|
153
|
+
["brave", "search"],
|
|
154
|
+
["qwant", "search"],
|
|
155
|
+
["startpage", "search"],
|
|
156
|
+
["naver", "search"],
|
|
157
|
+
["seznam", "search"],
|
|
158
|
+
["sogou", "search"],
|
|
159
|
+
["facebook", "social"],
|
|
160
|
+
["fb", "social"],
|
|
161
|
+
["instagram", "social"],
|
|
162
|
+
["twitter", "social"],
|
|
163
|
+
["x", "social"],
|
|
164
|
+
["linkedin", "social"],
|
|
165
|
+
["reddit", "social"],
|
|
166
|
+
["tiktok", "social"],
|
|
167
|
+
["threads", "social"],
|
|
168
|
+
["mastodon", "social"],
|
|
169
|
+
["bluesky", "social"],
|
|
170
|
+
["bsky", "social"],
|
|
171
|
+
["telegram", "social"],
|
|
172
|
+
["whatsapp", "social"],
|
|
173
|
+
["pinterest", "social"],
|
|
174
|
+
["youtube", "video"],
|
|
175
|
+
["vimeo", "video"]
|
|
176
|
+
]);
|
|
177
|
+
/**
|
|
178
|
+
* Second-level suffixes a brand's country site sits under (`google.co.uk`, `yahoo.com.au`).
|
|
179
|
+
* Without this list a two-label tail would also match `google.evil.com`, handing any host that
|
|
180
|
+
* cares to name itself after a search engine the search channel.
|
|
181
|
+
*/
|
|
182
|
+
const SECOND_LEVEL = new Set([
|
|
183
|
+
"co",
|
|
184
|
+
"com",
|
|
185
|
+
"net",
|
|
186
|
+
"org",
|
|
187
|
+
"ac",
|
|
188
|
+
"gov",
|
|
189
|
+
"edu"
|
|
190
|
+
]);
|
|
191
|
+
const matchesHost = (host, domain) => host === domain || host.endsWith(`.${domain}`);
|
|
192
|
+
const matchesBrand = (host, brand) => {
|
|
193
|
+
const labels = host.split(".");
|
|
194
|
+
for (let i = 0; i < labels.length; i++) {
|
|
195
|
+
if (labels[i] !== brand) continue;
|
|
196
|
+
const tail = labels.length - i - 1;
|
|
197
|
+
if (tail === 1 || tail === 2 && SECOND_LEVEL.has(labels[i + 1] ?? "")) return true;
|
|
198
|
+
}
|
|
199
|
+
return false;
|
|
200
|
+
};
|
|
201
|
+
const hostPlatform = (host) => {
|
|
202
|
+
for (const domain of NON_PLATFORM_HOSTS) if (matchesHost(host, domain)) return;
|
|
203
|
+
if (SEARCH_HOSTS.some((domain) => matchesHost(host, domain)) || SEARCH_BRANDS.some((brand) => matchesBrand(host, brand))) return "search";
|
|
204
|
+
if (SOCIAL_HOSTS.some((domain) => matchesHost(host, domain)) || SOCIAL_BRANDS.some((brand) => matchesBrand(host, brand))) return "social";
|
|
205
|
+
if (VIDEO_HOSTS.some((domain) => matchesHost(host, domain))) return "video";
|
|
206
|
+
};
|
|
207
|
+
/** A `utm_source` spelled as a domain is matched as one, so `google.com` is not an unknown. */
|
|
208
|
+
const namePlatform = (name) => NAME_PLATFORMS.get(name) ?? (name.includes(".") ? hostPlatform(name) : void 0);
|
|
209
|
+
const clickIds = (query) => {
|
|
210
|
+
if (!query) return { facebook: false };
|
|
211
|
+
let paid;
|
|
212
|
+
let facebook = false;
|
|
213
|
+
for (const [key, value] of new URLSearchParams(query)) {
|
|
214
|
+
if (!value) continue;
|
|
215
|
+
const name = key.toLowerCase();
|
|
216
|
+
if (name === FACEBOOK_CLICK_ID) {
|
|
217
|
+
facebook = true;
|
|
218
|
+
continue;
|
|
219
|
+
}
|
|
220
|
+
paid ??= PAID_CLICK_IDS.get(name);
|
|
221
|
+
}
|
|
222
|
+
return {
|
|
223
|
+
paid,
|
|
224
|
+
facebook
|
|
225
|
+
};
|
|
226
|
+
};
|
|
227
|
+
const paidChannel = (platform) => platform ? PAID_CHANNELS[platform] : "paid-other";
|
|
228
|
+
/**
|
|
229
|
+
* The acquisition channel a hit arrived through, which is what a report is asked for ("how
|
|
230
|
+
* much of last month was paid search?"), where the origin it came from is the `source`
|
|
231
|
+
* dimension's job.
|
|
232
|
+
*
|
|
233
|
+
* `utm_medium` wins outright, because a campaign states its own channel and the referrer host
|
|
234
|
+
* is then only the last hop. A paid click id is next, since an ad click carries one whatever
|
|
235
|
+
* host it bounced through, and it names its own network's platform. The platform itself comes
|
|
236
|
+
* from the referrer host, else from `utm_source` matched by name; on the paid path `utm_source`
|
|
237
|
+
* answers too when the host names no platform, because an ad click routinely arrives through the
|
|
238
|
+
* network's own redirect host. Anything left with a host is `referral`, and a hit with no usable
|
|
239
|
+
* host at all is `direct`.
|
|
240
|
+
*/
|
|
241
|
+
const classifyChannel = ({ referrerHost, utmSource, utmMedium, query }) => {
|
|
242
|
+
const host = referrerHost?.trim().toLowerCase();
|
|
243
|
+
const name = utmSource?.trim().toLowerCase();
|
|
244
|
+
const medium = utmMedium?.trim().toLowerCase();
|
|
245
|
+
const clicks = clickIds(query);
|
|
246
|
+
const platform = (host ? hostPlatform(host) : name ? namePlatform(name) : void 0) ?? (!host && clicks.facebook ? "social" : void 0);
|
|
247
|
+
if (medium) {
|
|
248
|
+
if (PAID_MEDIUMS.has(medium) || medium.startsWith("paid")) return paidChannel(PAID_MEDIUMS.get(medium) ?? clicks.paid ?? platform ?? (host && name ? namePlatform(name) : void 0));
|
|
249
|
+
const channel = MEDIUM_CHANNELS.get(medium);
|
|
250
|
+
if (channel) return channel;
|
|
15
251
|
}
|
|
16
|
-
if (
|
|
17
|
-
|
|
252
|
+
if (clicks.paid) return paidChannel(clicks.paid);
|
|
253
|
+
if (platform) return ORGANIC_CHANNELS[platform];
|
|
254
|
+
return host ? "referral" : "direct";
|
|
255
|
+
};
|
|
256
|
+
/**
|
|
257
|
+
* The visit's named origin: the `utm_source` it was tagged with, else the host it came from,
|
|
258
|
+
* else `direct`. That is what `source` means on Plausible (`visit:source`) and GA4
|
|
259
|
+
* (`sessionSource`), so a report reads the same column whichever source answered it. The tag is
|
|
260
|
+
* lowercased and capped like every other campaign key, so one tag spelled two ways is one row; the
|
|
261
|
+
* host already arrives lowercased, and the `utmSource` dimension keeps the tag as it was written. A
|
|
262
|
+
* campaign tagged `utm_source=direct` therefore shares the `direct` bucket with untagged traffic.
|
|
263
|
+
*/
|
|
264
|
+
const deriveSource = ({ referrerHost, utmSource }) => {
|
|
265
|
+
return utmSource?.trim().toLowerCase().slice(0, 128) || referrerHost || "direct";
|
|
18
266
|
};
|
|
19
267
|
//#endregion
|
|
20
|
-
export { deriveSource };
|
|
268
|
+
export { TRAFFIC_CHANNELS, classifyChannel, deriveSource };
|
|
21
269
|
|
|
22
270
|
//# sourceMappingURL=source.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"source.js","names":[],"sources":["../../../src/native/ingest/source.ts"],"sourcesContent":["const stripWww = (host: string): string => host.replace(/^www\\./, '')\n\n/**\n * Reduce a raw referrer URL to a coarse traffic source: the bare referrer host\n * (without `www.`), or `Direct` when there is no referrer, it is unparseable, or it\n * points back at the site itself (internal navigation is not a traffic source).\n */\nexport const deriveSource = (referrer: string | undefined, selfHostname: string): string => {\n\tif (!referrer) {\n\t\treturn 'Direct'\n\t}\n\tlet host: string\n\ttry {\n\t\thost = new URL(referrer).hostname\n\t} catch {\n\t\treturn 'Direct'\n\t}\n\tif (!host || stripWww(host) === stripWww(selfHostname)) {\n\t\treturn 'Direct'\n\t}\n\treturn stripWww(host)\n}\n"],"mappings":";AAAA,MAAM,YAAY,SAAyB,KAAK,QAAQ,UAAU,EAAE;;;;;;AAOpE,MAAa,gBAAgB,UAA8B,iBAAiC;CAC3F,IAAI,CAAC,UACJ,OAAO;CAER,IAAI;CACJ,IAAI;EACH,OAAO,IAAI,IAAI,QAAQ,EAAE;CAC1B,QAAQ;EACP,OAAO;CACR;CACA,IAAI,CAAC,QAAQ,SAAS,IAAI,MAAM,SAAS,YAAY,GACpD,OAAO;CAER,OAAO,SAAS,IAAI;AACrB"}
|
|
1
|
+
{"version":3,"file":"source.js","names":[],"sources":["../../../src/native/ingest/source.ts"],"sourcesContent":["import { MAX_UTM_LENGTH } from './utm'\n\n/**\n * Every acquisition channel the `channel` dimension can hold, lowercase as they are stored.\n * Paid is split per platform rather than pooled, because that is the split every vendor\n * reports and the one a budget question is actually asked in.\n */\nexport const TRAFFIC_CHANNELS = [\n\t'direct',\n\t'organic-search',\n\t'paid-search',\n\t'organic-social',\n\t'paid-social',\n\t'organic-video',\n\t'paid-video',\n\t'email',\n\t'affiliate',\n\t'display',\n\t'referral',\n\t'paid-other',\n] as const\n\nexport type TrafficChannel = (typeof TRAFFIC_CHANNELS)[number]\n\n/**\n * Stamped beside the channel on every event, so a later reclassify can find the rows an\n * older rule set decided. Bump it whenever these rules change what they answer.\n */\nexport const CHANNEL_TAXONOMY_VERSION = 1\n\nexport interface ChannelInput {\n\t/** The referrer's bare host from `referrerHost`, already absent for a same-site hit. */\n\treferrerHost?: string\n\tutmSource?: string\n\tutmMedium?: string\n\t/** The page's query string, read here only for the ad networks' click ids. */\n\tquery?: string\n}\n\nexport interface SourceInput {\n\treferrerHost?: string\n\tutmSource?: string\n}\n\n/** The platform families a referrer host or a `utm_source` is sorted into. */\ntype Platform = 'search' | 'social' | 'video'\n\nconst PAID_CHANNELS: Record<Platform, TrafficChannel> = {\n\tsearch: 'paid-search',\n\tsocial: 'paid-social',\n\tvideo: 'paid-video',\n}\n\nconst ORGANIC_CHANNELS: Record<Platform, TrafficChannel> = {\n\tsearch: 'organic-search',\n\tsocial: 'organic-social',\n\tvideo: 'organic-video',\n}\n\n/**\n * Every lookup below is a `Map` or a `Set` rather than an object literal: each is keyed by\n * whatever `utm_medium`, `utm_source` or a query key carries, and an object literal answers\n * an inherited member, which would put a function where a channel belongs.\n *\n * `referral` is deliberately absent. It names the channel the host branch already decides,\n * and pinning it here would turn a hit with no referrer at all into `referral` rather than\n * `direct`.\n */\nconst MEDIUM_CHANNELS: ReadonlyMap<string, TrafficChannel> = new Map<string, TrafficChannel>([\n\t['email', 'email'],\n\t['newsletter', 'email'],\n\t['affiliate', 'affiliate'],\n\t['affiliates', 'affiliate'],\n\t['display', 'display'],\n\t['banner', 'display'],\n\t['cpm', 'display'],\n\t['retargeting', 'display'],\n\t['remarketing', 'display'],\n\t['social', 'organic-social'],\n\t['social-media', 'organic-social'],\n\t['sm', 'organic-social'],\n\t['organic', 'organic-search'],\n\t['search', 'organic-search'],\n])\n\n/**\n * Mediums that declare a paid visit, mapped to the platform the medium itself names. `null`\n * is a medium that says \"paid\" and nothing more: `cpc` is as common on a social buy as on a\n * search one, so it names no platform and leaves the referrer to. Any other medium starting\n * `paid` is treated the same way.\n */\nconst PAID_MEDIUMS: ReadonlyMap<string, Platform | null> = new Map<string, Platform | null>([\n\t['cpc', null],\n\t['ppc', null],\n\t['paidsearch', 'search'],\n\t['paid-search', 'search'],\n\t['paid_search', 'search'],\n\t['paidsocial', 'social'],\n\t['paid-social', 'social'],\n\t['paid_social', 'social'],\n\t['paidvideo', 'video'],\n\t['paid-video', 'video'],\n\t['paid_video', 'video'],\n])\n\n/** Click ids only a paid click carries, and the platform of the network that issues each. */\nconst PAID_CLICK_IDS: ReadonlyMap<string, Platform> = new Map<string, Platform>([\n\t['gclid', 'search'],\n\t['gbraid', 'search'],\n\t['wbraid', 'search'],\n\t['msclkid', 'search'],\n\t['ttclid', 'social'],\n])\n\n/**\n * Facebook appends `fbclid` to every outbound link, organic posts included, so it proves the\n * platform and never the spend. It stands in for a referrer only when there is none, which is\n * the in-app browser case it exists to cover.\n */\nconst FACEBOOK_CLICK_ID = 'fbclid'\n\n/**\n * Hosts the lists below would get wrong, checked first and sorted into no platform at all.\n * Webmail is a `referral` rather than `email`: a referrer only proves a link was opened in a\n * mail client, never that the mail was the newsletter an `email` bucket claims credit for.\n */\nconst NON_PLATFORM_HOSTS: ReadonlySet<string> = new Set([\n\t'mail.google.com',\n\t'mail.yahoo.com',\n\t'outlook.live.com',\n\t'outlook.office.com',\n\t'mail.proton.me',\n])\n\nconst SEARCH_HOSTS = [\n\t'bing.com',\n\t'duckduckgo.com',\n\t'baidu.com',\n\t'ecosia.org',\n\t'search.brave.com',\n\t'qwant.com',\n\t'startpage.com',\n\t'naver.com',\n\t'seznam.cz',\n\t'sogou.com',\n]\nconst SOCIAL_HOSTS = [\n\t'facebook.com',\n\t'fb.com',\n\t'instagram.com',\n\t'twitter.com',\n\t'x.com',\n\t't.co',\n\t'linkedin.com',\n\t'lnkd.in',\n\t'reddit.com',\n\t'tiktok.com',\n\t'threads.net',\n\t'mastodon.social',\n\t'bsky.app',\n\t'web.telegram.org',\n\t't.me',\n\t'wa.me',\n\t'whatsapp.com',\n]\nconst VIDEO_HOSTS = ['youtube.com', 'youtu.be', 'vimeo.com']\n\n/** Brands running one site per country, matched on the label rather than a fixed tld. */\nconst SEARCH_BRANDS = ['google', 'yahoo', 'yandex']\nconst SOCIAL_BRANDS = ['pinterest']\n\n/** The same platforms by name, for the `utm_source` a hit carries instead of a referrer. */\nconst NAME_PLATFORMS: ReadonlyMap<string, Platform> = new Map<string, Platform>([\n\t['google', 'search'],\n\t['bing', 'search'],\n\t['yahoo', 'search'],\n\t['yandex', 'search'],\n\t['duckduckgo', 'search'],\n\t['baidu', 'search'],\n\t['ecosia', 'search'],\n\t['brave', 'search'],\n\t['qwant', 'search'],\n\t['startpage', 'search'],\n\t['naver', 'search'],\n\t['seznam', 'search'],\n\t['sogou', 'search'],\n\t['facebook', 'social'],\n\t['fb', 'social'],\n\t['instagram', 'social'],\n\t['twitter', 'social'],\n\t['x', 'social'],\n\t['linkedin', 'social'],\n\t['reddit', 'social'],\n\t['tiktok', 'social'],\n\t['threads', 'social'],\n\t['mastodon', 'social'],\n\t['bluesky', 'social'],\n\t['bsky', 'social'],\n\t['telegram', 'social'],\n\t['whatsapp', 'social'],\n\t['pinterest', 'social'],\n\t['youtube', 'video'],\n\t['vimeo', 'video'],\n])\n\n/**\n * Second-level suffixes a brand's country site sits under (`google.co.uk`, `yahoo.com.au`).\n * Without this list a two-label tail would also match `google.evil.com`, handing any host that\n * cares to name itself after a search engine the search channel.\n */\nconst SECOND_LEVEL: ReadonlySet<string> = new Set(['co', 'com', 'net', 'org', 'ac', 'gov', 'edu'])\n\nconst matchesHost = (host: string, domain: string): boolean =>\n\thost === domain || host.endsWith(`.${domain}`)\n\nconst matchesBrand = (host: string, brand: string): boolean => {\n\tconst labels = host.split('.')\n\tfor (let i = 0; i < labels.length; i++) {\n\t\tif (labels[i] !== brand) {\n\t\t\tcontinue\n\t\t}\n\t\tconst tail = labels.length - i - 1\n\t\tif (tail === 1 || (tail === 2 && SECOND_LEVEL.has(labels[i + 1] ?? ''))) {\n\t\t\treturn true\n\t\t}\n\t}\n\treturn false\n}\n\nconst hostPlatform = (host: string): Platform | undefined => {\n\tfor (const domain of NON_PLATFORM_HOSTS) {\n\t\tif (matchesHost(host, domain)) {\n\t\t\treturn undefined\n\t\t}\n\t}\n\tif (\n\t\tSEARCH_HOSTS.some((domain) => matchesHost(host, domain)) ||\n\t\tSEARCH_BRANDS.some((brand) => matchesBrand(host, brand))\n\t) {\n\t\treturn 'search'\n\t}\n\tif (\n\t\tSOCIAL_HOSTS.some((domain) => matchesHost(host, domain)) ||\n\t\tSOCIAL_BRANDS.some((brand) => matchesBrand(host, brand))\n\t) {\n\t\treturn 'social'\n\t}\n\tif (VIDEO_HOSTS.some((domain) => matchesHost(host, domain))) {\n\t\treturn 'video'\n\t}\n\treturn undefined\n}\n\n/** A `utm_source` spelled as a domain is matched as one, so `google.com` is not an unknown. */\nconst namePlatform = (name: string): Platform | undefined =>\n\tNAME_PLATFORMS.get(name) ?? (name.includes('.') ? hostPlatform(name) : undefined)\n\ninterface ClickIds {\n\t/** The platform of the paid click id the query carried, if it carried one. */\n\tpaid?: Platform\n\tfacebook: boolean\n}\n\nconst clickIds = (query: string | undefined): ClickIds => {\n\tif (!query) {\n\t\treturn { facebook: false }\n\t}\n\tlet paid: Platform | undefined\n\tlet facebook = false\n\tfor (const [key, value] of new URLSearchParams(query)) {\n\t\tif (!value) {\n\t\t\tcontinue\n\t\t}\n\t\tconst name = key.toLowerCase()\n\t\tif (name === FACEBOOK_CLICK_ID) {\n\t\t\tfacebook = true\n\t\t\tcontinue\n\t\t}\n\t\tpaid ??= PAID_CLICK_IDS.get(name)\n\t}\n\treturn { paid, facebook }\n}\n\nconst paidChannel = (platform: Platform | null | undefined): TrafficChannel =>\n\tplatform ? PAID_CHANNELS[platform] : 'paid-other'\n\n/**\n * The acquisition channel a hit arrived through, which is what a report is asked for (\"how\n * much of last month was paid search?\"), where the origin it came from is the `source`\n * dimension's job.\n *\n * `utm_medium` wins outright, because a campaign states its own channel and the referrer host\n * is then only the last hop. A paid click id is next, since an ad click carries one whatever\n * host it bounced through, and it names its own network's platform. The platform itself comes\n * from the referrer host, else from `utm_source` matched by name; on the paid path `utm_source`\n * answers too when the host names no platform, because an ad click routinely arrives through the\n * network's own redirect host. Anything left with a host is `referral`, and a hit with no usable\n * host at all is `direct`.\n */\nexport const classifyChannel = ({\n\treferrerHost,\n\tutmSource,\n\tutmMedium,\n\tquery,\n}: ChannelInput): TrafficChannel => {\n\tconst host = referrerHost?.trim().toLowerCase()\n\tconst name = utmSource?.trim().toLowerCase()\n\tconst medium = utmMedium?.trim().toLowerCase()\n\tconst clicks = clickIds(query)\n\tconst named = host ? hostPlatform(host) : name ? namePlatform(name) : undefined\n\tconst platform = named ?? (!host && clicks.facebook ? 'social' : undefined)\n\tif (medium) {\n\t\tif (PAID_MEDIUMS.has(medium) || medium.startsWith('paid')) {\n\t\t\treturn paidChannel(\n\t\t\t\tPAID_MEDIUMS.get(medium) ??\n\t\t\t\t\tclicks.paid ??\n\t\t\t\t\tplatform ??\n\t\t\t\t\t(host && name ? namePlatform(name) : undefined)\n\t\t\t)\n\t\t}\n\t\tconst channel = MEDIUM_CHANNELS.get(medium)\n\t\tif (channel) {\n\t\t\treturn channel\n\t\t}\n\t}\n\tif (clicks.paid) {\n\t\treturn paidChannel(clicks.paid)\n\t}\n\tif (platform) {\n\t\treturn ORGANIC_CHANNELS[platform]\n\t}\n\treturn host ? 'referral' : 'direct'\n}\n\n/**\n * The visit's named origin: the `utm_source` it was tagged with, else the host it came from,\n * else `direct`. That is what `source` means on Plausible (`visit:source`) and GA4\n * (`sessionSource`), so a report reads the same column whichever source answered it. The tag is\n * lowercased and capped like every other campaign key, so one tag spelled two ways is one row; the\n * host already arrives lowercased, and the `utmSource` dimension keeps the tag as it was written. A\n * campaign tagged `utm_source=direct` therefore shares the `direct` bucket with untagged traffic.\n */\nexport const deriveSource = ({ referrerHost, utmSource }: SourceInput): string => {\n\tconst tagged = utmSource?.trim().toLowerCase().slice(0, MAX_UTM_LENGTH)\n\treturn tagged || referrerHost || 'direct'\n}\n"],"mappings":";;;;;;AAOA,MAAa,mBAAmB;CAC/B;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;AA2BA,MAAM,gBAAkD;CACvD,QAAQ;CACR,QAAQ;CACR,OAAO;AACR;AAEA,MAAM,mBAAqD;CAC1D,QAAQ;CACR,QAAQ;CACR,OAAO;AACR;;;;;;;;;;AAWA,MAAM,kBAAuD,IAAI,IAA4B;CAC5F,CAAC,SAAS,OAAO;CACjB,CAAC,cAAc,OAAO;CACtB,CAAC,aAAa,WAAW;CACzB,CAAC,cAAc,WAAW;CAC1B,CAAC,WAAW,SAAS;CACrB,CAAC,UAAU,SAAS;CACpB,CAAC,OAAO,SAAS;CACjB,CAAC,eAAe,SAAS;CACzB,CAAC,eAAe,SAAS;CACzB,CAAC,UAAU,gBAAgB;CAC3B,CAAC,gBAAgB,gBAAgB;CACjC,CAAC,MAAM,gBAAgB;CACvB,CAAC,WAAW,gBAAgB;CAC5B,CAAC,UAAU,gBAAgB;AAC5B,CAAC;;;;;;;AAQD,MAAM,eAAqD,IAAI,IAA6B;CAC3F,CAAC,OAAO,IAAI;CACZ,CAAC,OAAO,IAAI;CACZ,CAAC,cAAc,QAAQ;CACvB,CAAC,eAAe,QAAQ;CACxB,CAAC,eAAe,QAAQ;CACxB,CAAC,cAAc,QAAQ;CACvB,CAAC,eAAe,QAAQ;CACxB,CAAC,eAAe,QAAQ;CACxB,CAAC,aAAa,OAAO;CACrB,CAAC,cAAc,OAAO;CACtB,CAAC,cAAc,OAAO;AACvB,CAAC;;AAGD,MAAM,iBAAgD,IAAI,IAAsB;CAC/E,CAAC,SAAS,QAAQ;CAClB,CAAC,UAAU,QAAQ;CACnB,CAAC,UAAU,QAAQ;CACnB,CAAC,WAAW,QAAQ;CACpB,CAAC,UAAU,QAAQ;AACpB,CAAC;;;;;;AAOD,MAAM,oBAAoB;;;;;;AAO1B,MAAM,qBAA0C,IAAI,IAAI;CACvD;CACA;CACA;CACA;CACA;AACD,CAAC;AAED,MAAM,eAAe;CACpB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;AACA,MAAM,eAAe;CACpB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;AACA,MAAM,cAAc;CAAC;CAAe;CAAY;AAAW;;AAG3D,MAAM,gBAAgB;CAAC;CAAU;CAAS;AAAQ;AAClD,MAAM,gBAAgB,CAAC,WAAW;;AAGlC,MAAM,iBAAgD,IAAI,IAAsB;CAC/E,CAAC,UAAU,QAAQ;CACnB,CAAC,QAAQ,QAAQ;CACjB,CAAC,SAAS,QAAQ;CAClB,CAAC,UAAU,QAAQ;CACnB,CAAC,cAAc,QAAQ;CACvB,CAAC,SAAS,QAAQ;CAClB,CAAC,UAAU,QAAQ;CACnB,CAAC,SAAS,QAAQ;CAClB,CAAC,SAAS,QAAQ;CAClB,CAAC,aAAa,QAAQ;CACtB,CAAC,SAAS,QAAQ;CAClB,CAAC,UAAU,QAAQ;CACnB,CAAC,SAAS,QAAQ;CAClB,CAAC,YAAY,QAAQ;CACrB,CAAC,MAAM,QAAQ;CACf,CAAC,aAAa,QAAQ;CACtB,CAAC,WAAW,QAAQ;CACpB,CAAC,KAAK,QAAQ;CACd,CAAC,YAAY,QAAQ;CACrB,CAAC,UAAU,QAAQ;CACnB,CAAC,UAAU,QAAQ;CACnB,CAAC,WAAW,QAAQ;CACpB,CAAC,YAAY,QAAQ;CACrB,CAAC,WAAW,QAAQ;CACpB,CAAC,QAAQ,QAAQ;CACjB,CAAC,YAAY,QAAQ;CACrB,CAAC,YAAY,QAAQ;CACrB,CAAC,aAAa,QAAQ;CACtB,CAAC,WAAW,OAAO;CACnB,CAAC,SAAS,OAAO;AAClB,CAAC;;;;;;AAOD,MAAM,eAAoC,IAAI,IAAI;CAAC;CAAM;CAAO;CAAO;CAAO;CAAM;CAAO;AAAK,CAAC;AAEjG,MAAM,eAAe,MAAc,WAClC,SAAS,UAAU,KAAK,SAAS,IAAI,QAAQ;AAE9C,MAAM,gBAAgB,MAAc,UAA2B;CAC9D,MAAM,SAAS,KAAK,MAAM,GAAG;CAC7B,KAAK,IAAI,IAAI,GAAG,IAAI,OAAO,QAAQ,KAAK;EACvC,IAAI,OAAO,OAAO,OACjB;EAED,MAAM,OAAO,OAAO,SAAS,IAAI;EACjC,IAAI,SAAS,KAAM,SAAS,KAAK,aAAa,IAAI,OAAO,IAAI,MAAM,EAAE,GACpE,OAAO;CAET;CACA,OAAO;AACR;AAEA,MAAM,gBAAgB,SAAuC;CAC5D,KAAK,MAAM,UAAU,oBACpB,IAAI,YAAY,MAAM,MAAM,GAC3B;CAGF,IACC,aAAa,MAAM,WAAW,YAAY,MAAM,MAAM,CAAC,KACvD,cAAc,MAAM,UAAU,aAAa,MAAM,KAAK,CAAC,GAEvD,OAAO;CAER,IACC,aAAa,MAAM,WAAW,YAAY,MAAM,MAAM,CAAC,KACvD,cAAc,MAAM,UAAU,aAAa,MAAM,KAAK,CAAC,GAEvD,OAAO;CAER,IAAI,YAAY,MAAM,WAAW,YAAY,MAAM,MAAM,CAAC,GACzD,OAAO;AAGT;;AAGA,MAAM,gBAAgB,SACrB,eAAe,IAAI,IAAI,MAAM,KAAK,SAAS,GAAG,IAAI,aAAa,IAAI,IAAI,KAAA;AAQxE,MAAM,YAAY,UAAwC;CACzD,IAAI,CAAC,OACJ,OAAO,EAAE,UAAU,MAAM;CAE1B,IAAI;CACJ,IAAI,WAAW;CACf,KAAK,MAAM,CAAC,KAAK,UAAU,IAAI,gBAAgB,KAAK,GAAG;EACtD,IAAI,CAAC,OACJ;EAED,MAAM,OAAO,IAAI,YAAY;EAC7B,IAAI,SAAS,mBAAmB;GAC/B,WAAW;GACX;EACD;EACA,SAAS,eAAe,IAAI,IAAI;CACjC;CACA,OAAO;EAAE;EAAM;CAAS;AACzB;AAEA,MAAM,eAAe,aACpB,WAAW,cAAc,YAAY;;;;;;;;;;;;;;AAetC,MAAa,mBAAmB,EAC/B,cACA,WACA,WACA,YACmC;CACnC,MAAM,OAAO,cAAc,KAAK,EAAE,YAAY;CAC9C,MAAM,OAAO,WAAW,KAAK,EAAE,YAAY;CAC3C,MAAM,SAAS,WAAW,KAAK,EAAE,YAAY;CAC7C,MAAM,SAAS,SAAS,KAAK;CAE7B,MAAM,YADQ,OAAO,aAAa,IAAI,IAAI,OAAO,aAAa,IAAI,IAAI,KAAA,OAC3C,CAAC,QAAQ,OAAO,WAAW,WAAW,KAAA;CACjE,IAAI,QAAQ;EACX,IAAI,aAAa,IAAI,MAAM,KAAK,OAAO,WAAW,MAAM,GACvD,OAAO,YACN,aAAa,IAAI,MAAM,KACtB,OAAO,QACP,aACC,QAAQ,OAAO,aAAa,IAAI,IAAI,KAAA,EACvC;EAED,MAAM,UAAU,gBAAgB,IAAI,MAAM;EAC1C,IAAI,SACH,OAAO;CAET;CACA,IAAI,OAAO,MACV,OAAO,YAAY,OAAO,IAAI;CAE/B,IAAI,UACH,OAAO,iBAAiB;CAEzB,OAAO,OAAO,aAAa;AAC5B;;;;;;;;;AAUA,MAAa,gBAAgB,EAAE,cAAc,gBAAqC;CAEjF,OADe,WAAW,KAAK,EAAE,YAAY,EAAE,MAAM,GAAA,GAAiB,KACrD,gBAAgB;AAClC"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A `Map` rather than an object literal: the lookup is keyed by a query key an attacker
|
|
3
|
+
* writes, and an object literal answers its inherited members, so `?constructor=x` would
|
|
4
|
+
* otherwise reach storage under a key `UtmParams` does not declare.
|
|
5
|
+
*/
|
|
6
|
+
const UTM_KEYS = new Map([
|
|
7
|
+
["utm_source", "utmSource"],
|
|
8
|
+
["utm_medium", "utmMedium"],
|
|
9
|
+
["utm_campaign", "utmCampaign"],
|
|
10
|
+
["utm_content", "utmContent"],
|
|
11
|
+
["utm_term", "utmTerm"]
|
|
12
|
+
]);
|
|
13
|
+
/**
|
|
14
|
+
* The five utm keys carried by a page's query string, decoded and capped. Keys are matched
|
|
15
|
+
* case-insensitively and a repeated key keeps its first value, matching what
|
|
16
|
+
* `URLSearchParams.get` would have answered. Everything else in the query is discarded here
|
|
17
|
+
* and never reaches storage.
|
|
18
|
+
*/
|
|
19
|
+
const extractUtm = (query) => {
|
|
20
|
+
if (!query) return {};
|
|
21
|
+
const out = {};
|
|
22
|
+
for (const [rawKey, rawValue] of new URLSearchParams(query)) {
|
|
23
|
+
const key = UTM_KEYS.get(rawKey.toLowerCase());
|
|
24
|
+
if (!key || out[key] !== void 0) continue;
|
|
25
|
+
const value = rawValue.trim().slice(0, 128);
|
|
26
|
+
if (value) out[key] = value;
|
|
27
|
+
}
|
|
28
|
+
return out;
|
|
29
|
+
};
|
|
30
|
+
//#endregion
|
|
31
|
+
export { extractUtm };
|
|
32
|
+
|
|
33
|
+
//# sourceMappingURL=utm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utm.js","names":[],"sources":["../../../src/native/ingest/utm.ts"],"sourcesContent":["export interface UtmParams {\n\tutmSource?: string\n\tutmMedium?: string\n\tutmCampaign?: string\n\tutmContent?: string\n\tutmTerm?: string\n}\n\n/** Each extracted value is a rollup bucket key, so it is capped like every other one. */\nexport const MAX_UTM_LENGTH = 128\n\n/**\n * A `Map` rather than an object literal: the lookup is keyed by a query key an attacker\n * writes, and an object literal answers its inherited members, so `?constructor=x` would\n * otherwise reach storage under a key `UtmParams` does not declare.\n */\nconst UTM_KEYS: ReadonlyMap<string, keyof UtmParams> = new Map<string, keyof UtmParams>([\n\t['utm_source', 'utmSource'],\n\t['utm_medium', 'utmMedium'],\n\t['utm_campaign', 'utmCampaign'],\n\t['utm_content', 'utmContent'],\n\t['utm_term', 'utmTerm'],\n])\n\n/**\n * The five utm keys carried by a page's query string, decoded and capped. Keys are matched\n * case-insensitively and a repeated key keeps its first value, matching what\n * `URLSearchParams.get` would have answered. Everything else in the query is discarded here\n * and never reaches storage.\n */\nexport const extractUtm = (query: string | undefined): UtmParams => {\n\tif (!query) {\n\t\treturn {}\n\t}\n\tconst out: UtmParams = {}\n\tfor (const [rawKey, rawValue] of new URLSearchParams(query)) {\n\t\tconst key = UTM_KEYS.get(rawKey.toLowerCase())\n\t\tif (!key || out[key] !== undefined) {\n\t\t\tcontinue\n\t\t}\n\t\tconst value = rawValue.trim().slice(0, MAX_UTM_LENGTH)\n\t\tif (value) {\n\t\t\tout[key] = value\n\t\t}\n\t}\n\treturn out\n}\n"],"mappings":";;;;;AAgBA,MAAM,WAAiD,IAAI,IAA6B;CACvF,CAAC,cAAc,WAAW;CAC1B,CAAC,cAAc,WAAW;CAC1B,CAAC,gBAAgB,aAAa;CAC9B,CAAC,eAAe,YAAY;CAC5B,CAAC,YAAY,SAAS;AACvB,CAAC;;;;;;;AAQD,MAAa,cAAc,UAAyC;CACnE,IAAI,CAAC,OACJ,OAAO,CAAC;CAET,MAAM,MAAiB,CAAC;CACxB,KAAK,MAAM,CAAC,QAAQ,aAAa,IAAI,gBAAgB,KAAK,GAAG;EAC5D,MAAM,MAAM,SAAS,IAAI,OAAO,YAAY,CAAC;EAC7C,IAAI,CAAC,OAAO,IAAI,SAAS,KAAA,GACxB;EAED,MAAM,QAAQ,SAAS,KAAK,EAAE,MAAM,GAAA,GAAiB;EACrD,IAAI,OACH,IAAI,OAAO;CAEb;CACA,OAAO;AACR"}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
//#region src/native/ingest/validate.ts
|
|
2
|
+
const TYPES = new Set([
|
|
3
|
+
"pageview",
|
|
4
|
+
"event",
|
|
5
|
+
"goal"
|
|
6
|
+
]);
|
|
7
|
+
const nonEmptyString = (value) => typeof value === "string" && value.length > 0;
|
|
8
|
+
/**
|
|
9
|
+
* The first required field an event fails on, or undefined when it is valid: a known `type`,
|
|
10
|
+
* a `path`, and a `name` (the event name, or the goal slug on a `goal`) for everything but a
|
|
11
|
+
* pageview. Optional fields are sanitized in `normalizeEvent` and dropped when malformed, so
|
|
12
|
+
* one bad attribute costs an attribute rather than the whole event.
|
|
13
|
+
*
|
|
14
|
+
* Types are checked rather than truthiness: a non-string path would otherwise reach goal
|
|
15
|
+
* matching and throw there rather than being refused here.
|
|
16
|
+
*/
|
|
17
|
+
const rawEventError = (raw, check = {}) => {
|
|
18
|
+
if (!raw || !TYPES.has(raw.type)) return "type";
|
|
19
|
+
if (!nonEmptyString(raw.path)) return "path";
|
|
20
|
+
if (!(check.requireHostname ? nonEmptyString(raw.hostname) : raw.hostname === void 0 || typeof raw.hostname === "string")) return "hostname";
|
|
21
|
+
if (raw.type !== "pageview" && !nonEmptyString(raw.name)) return "name";
|
|
22
|
+
};
|
|
23
|
+
//#endregion
|
|
24
|
+
export { rawEventError };
|
|
25
|
+
|
|
26
|
+
//# sourceMappingURL=validate.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"validate.js","names":[],"sources":["../../../src/native/ingest/validate.ts"],"sourcesContent":["import type { EventType, RawEventInput } from './normalizeEvent'\n\nconst TYPES: ReadonlySet<string> = new Set<EventType>(['pageview', 'event', 'goal'])\n\nconst nonEmptyString = (value: unknown): boolean => typeof value === 'string' && value.length > 0\n\nexport type RawEventField = 'type' | 'path' | 'hostname' | 'name'\n\nexport interface RawEventCheck {\n\t/**\n\t * Demand a hostname. The wire body's is optional, because ingest attributes an event to the\n\t * request that carried it; server code supplies its own and there is no request to fall back\n\t * on, so that path still requires one.\n\t */\n\trequireHostname?: boolean\n}\n\n/**\n * The first required field an event fails on, or undefined when it is valid: a known `type`,\n * a `path`, and a `name` (the event name, or the goal slug on a `goal`) for everything but a\n * pageview. Optional fields are sanitized in `normalizeEvent` and dropped when malformed, so\n * one bad attribute costs an attribute rather than the whole event.\n *\n * Types are checked rather than truthiness: a non-string path would otherwise reach goal\n * matching and throw there rather than being refused here.\n */\nexport const rawEventError = (\n\traw: RawEventInput | undefined,\n\tcheck: RawEventCheck = {}\n): RawEventField | undefined => {\n\tif (!raw || !TYPES.has(raw.type)) {\n\t\treturn 'type'\n\t}\n\tif (!nonEmptyString(raw.path)) {\n\t\treturn 'path'\n\t}\n\tconst hostname = check.requireHostname\n\t\t? nonEmptyString(raw.hostname)\n\t\t: raw.hostname === undefined || typeof raw.hostname === 'string'\n\tif (!hostname) {\n\t\treturn 'hostname'\n\t}\n\tif (raw.type !== 'pageview' && !nonEmptyString(raw.name)) {\n\t\treturn 'name'\n\t}\n\treturn undefined\n}\n\nexport const validateRawEvent = (raw: RawEventInput | undefined): raw is RawEventInput =>\n\trawEventError(raw) === undefined\n"],"mappings":";AAEA,MAAM,QAA6B,IAAI,IAAe;CAAC;CAAY;CAAS;AAAM,CAAC;AAEnF,MAAM,kBAAkB,UAA4B,OAAO,UAAU,YAAY,MAAM,SAAS;;;;;;;;;;AAsBhG,MAAa,iBACZ,KACA,QAAuB,CAAC,MACO;CAC/B,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,IAAI,IAAI,GAC9B,OAAO;CAER,IAAI,CAAC,eAAe,IAAI,IAAI,GAC3B,OAAO;CAKR,IAAI,EAHa,MAAM,kBACpB,eAAe,IAAI,QAAQ,IAC3B,IAAI,aAAa,KAAA,KAAa,OAAO,IAAI,aAAa,WAExD,OAAO;CAER,IAAI,IAAI,SAAS,cAAc,CAAC,eAAe,IAAI,IAAI,GACtD,OAAO;AAGT"}
|
|
@@ -1,17 +1,53 @@
|
|
|
1
|
-
import { AnalyticsAdapter } from "../core/contract.js";
|
|
2
1
|
import { GeoResolver } from "./geo/geoResolver.js";
|
|
2
|
+
import { AnalyticsAdapter } from "../core/contract.js";
|
|
3
|
+
import { BotFilter } from "./ingest/bots.js";
|
|
4
|
+
import { EventHostnameResolver, HostnameOption } from "./ingest/resolveHostname.js";
|
|
3
5
|
|
|
4
6
|
//#region src/native/nativeAdapter.d.ts
|
|
5
7
|
interface NativeOptions {
|
|
6
8
|
geoResolver?: GeoResolver;
|
|
7
9
|
geoDbPath?: string;
|
|
8
10
|
ingestPath?: string;
|
|
11
|
+
/**
|
|
12
|
+
* Events and seen-ledger rows older than this many days are deleted by the nightly task.
|
|
13
|
+
* Zero or less means keep everything; anything else must be a whole number of days, so a
|
|
14
|
+
* window the sweep could not turn into a cutoff fails the boot.
|
|
15
|
+
*/
|
|
9
16
|
retentionDays?: number;
|
|
17
|
+
/**
|
|
18
|
+
* Rollup rows older than this many days are deleted by the nightly task. Off by default,
|
|
19
|
+
* since rollups are the long-term store. It requires `retentionDays` and cannot be shorter
|
|
20
|
+
* than it: a window reaching past raw-event retention is answered from rollups, so a shorter
|
|
21
|
+
* rollup window would make a long window report less than a short one.
|
|
22
|
+
*/
|
|
23
|
+
rollupRetentionDays?: number;
|
|
10
24
|
/** Opt-in in-process write batching. `true` uses defaults (maxSize 50, maxAgeMs 2000). */
|
|
11
25
|
buffer?: boolean | {
|
|
12
26
|
maxSize?: number;
|
|
13
27
|
maxAgeMs?: number;
|
|
14
28
|
};
|
|
29
|
+
/**
|
|
30
|
+
* Where an event's hostname comes from. `'request'` (the default) stores the host the
|
|
31
|
+
* request carried and ignores the body's claim, so a scripted client cannot mint hostname
|
|
32
|
+
* buckets. A list stores the request host only when it is one of those, for an install
|
|
33
|
+
* behind no host validation at all. A resolver decides per event, and returning null drops
|
|
34
|
+
* it. A dropped event is answered exactly like an accepted one.
|
|
35
|
+
*/
|
|
36
|
+
hostname?: HostnameOption;
|
|
37
|
+
/**
|
|
38
|
+
* Hostnames that keep ingesting on a scoped install even when the request resolves no
|
|
39
|
+
* scope: the platform's own domains, which are infrastructure rather than tenants. Their
|
|
40
|
+
* events are stored under the null scope. Tenant domains need no entry here, since the
|
|
41
|
+
* install's own `scopeResolver` already answers for them.
|
|
42
|
+
*/
|
|
43
|
+
platformHostnames?: string[];
|
|
44
|
+
/**
|
|
45
|
+
* Whether crawlers, monitors and headless clients are dropped at ingest, by their user
|
|
46
|
+
* agent. On by default. A function decides for itself and receives the raw agent; `false`
|
|
47
|
+
* counts every beacon. A dropped bot is answered exactly like an accepted event, and
|
|
48
|
+
* `trackServerEvent` is trusted host code that is never filtered.
|
|
49
|
+
*/
|
|
50
|
+
filterBots?: boolean | BotFilter;
|
|
15
51
|
}
|
|
16
52
|
type NativeAdapter = AnalyticsAdapter & {
|
|
17
53
|
flush: () => Promise<void>;
|