@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.
- package/CHANGELOG.md +118 -0
- package/LICENSE +21 -21
- package/README.md +10 -4
- 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 +179 -70
- 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/plausible/plausible.d.ts +15 -0
- package/dist/adapters/plausible/plausible.js +112 -43
- package/dist/adapters/plausible/plausible.js.map +1 -1
- package/dist/adapters/posthog/posthog.js +47 -25
- package/dist/adapters/posthog/posthog.js.map +1 -1
- package/dist/adapters/umami/umami.d.ts +8 -0
- package/dist/adapters/umami/umami.js +237 -28
- package/dist/adapters/umami/umami.js.map +1 -1
- package/dist/capture/slots.js +16 -5
- package/dist/capture/slots.js.map +1 -1
- package/dist/capture/trackerConfig.d.ts +1 -0
- package/dist/capture/trackerConfig.js +28 -3
- package/dist/capture/trackerConfig.js.map +1 -1
- package/dist/charts/BarList.d.ts +15 -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 +2 -0
- package/dist/charts/bars.js +2 -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 +24 -2
- package/dist/core/cacheKey.js.map +1 -1
- package/dist/core/capabilities.js +7 -2
- package/dist/core/capabilities.js.map +1 -1
- package/dist/core/capture.d.ts +1 -1
- package/dist/core/contract.d.ts +46 -9
- package/dist/core/contract.js +29 -1
- package/dist/core/contract.js.map +1 -1
- package/dist/core/granularity.js +1 -1
- package/dist/core/options.d.ts +62 -7
- package/dist/core/options.js +63 -4
- package/dist/core/options.js.map +1 -1
- package/dist/core/scopedRead.js +33 -23
- package/dist/core/scopedRead.js.map +1 -1
- package/dist/core/serverEvent.d.ts +44 -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/client.d.ts +12 -3
- package/dist/exports/client.js +9 -1
- package/dist/exports/rsc.d.ts +7 -2
- package/dist/exports/rsc.js +6 -3
- package/dist/exports/tracker.d.ts +3 -2
- package/dist/exports/tracker.js +2 -1
- package/dist/exports/types.d.ts +13 -4
- package/dist/exports/types.js +3 -2
- package/dist/fields/AnalyticsPanelClient.js +1 -1
- 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/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 +21 -9
- 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 +250 -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 +29 -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 +55 -0
- package/dist/goals/goalsEndpoint.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 +74 -0
- package/dist/goals/trackGoalAction.js +139 -0
- package/dist/goals/trackGoalAction.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 +12 -3
- package/dist/index.js +75 -11
- package/dist/index.js.map +1 -1
- package/dist/native/collections/events.js +36 -0
- package/dist/native/collections/events.js.map +1 -1
- package/dist/native/eventScan.js +25 -0
- package/dist/native/eventScan.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/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 +2 -17
- package/dist/native/ingest/endpoint.js.map +1 -1
- package/dist/native/ingest/flushBatch.js +26 -26
- 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 +26 -0
- package/dist/native/ingest/normalizeEvent.js +35 -7
- 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/serverTrack.d.ts +20 -0
- package/dist/native/ingest/serverTrack.js +100 -0
- package/dist/native/ingest/serverTrack.js.map +1 -0
- package/dist/native/ingest/source.d.ts +7 -0
- package/dist/native/ingest/source.js +139 -14
- 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 +27 -0
- package/dist/native/ingest/validate.js.map +1 -0
- package/dist/native/nativeAdapter.d.ts +1 -1
- package/dist/native/nativeAdapter.js +53 -36
- package/dist/native/nativeAdapter.js.map +1 -1
- package/dist/native/query/eventAgg.js +14 -1
- package/dist/native/query/eventAgg.js.map +1 -1
- package/dist/native/retention/pruneTask.js +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 +30 -15
- 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 +3 -2
- package/dist/next/captureRewrites.js +3 -2
- package/dist/next/captureRewrites.js.map +1 -1
- package/dist/plugin/documentEndpoint.js +52 -15
- package/dist/plugin/documentEndpoint.js.map +1 -1
- 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 +5 -1
- package/dist/plugin/paths.js.map +1 -1
- package/dist/plugin/queryEndpoint.js +120 -0
- package/dist/plugin/queryEndpoint.js.map +1 -0
- package/dist/plugin/readContextForRequest.js +71 -0
- package/dist/plugin/readContextForRequest.js.map +1 -0
- package/dist/plugin/realtimeEndpoint.js +43 -15
- package/dist/plugin/realtimeEndpoint.js.map +1 -1
- package/dist/plugin/responses.js +17 -0
- package/dist/plugin/responses.js.map +1 -0
- package/dist/plugin/runtime.js +31 -1
- package/dist/plugin/runtime.js.map +1 -1
- package/dist/plugin/scopeFieldBoot.js +22 -0
- package/dist/plugin/scopeFieldBoot.js.map +1 -0
- package/dist/plugin/sourcesEndpoint.js +21 -52
- 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 +29 -13
- package/dist/providers/collection.js.map +1 -1
- package/dist/providers/factory.js +4 -2
- 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 +17 -0
- package/dist/query/errors.js +10 -0
- package/dist/query/errors.js.map +1 -0
- package/dist/query/fetchQuery.d.ts +59 -0
- package/dist/query/fetchQuery.js +110 -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/surfacing/engine.js +1 -1
- package/dist/surfacing/engine.js.map +1 -1
- package/dist/testing/memoryAdapter.js +0 -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/createTracker.js +13 -1
- package/dist/tracker/createTracker.js.map +1 -1
- package/dist/tracker/sinks/ga4.d.ts +21 -0
- package/dist/tracker/sinks/ga4.js +26 -0
- package/dist/tracker/sinks/ga4.js.map +1 -0
- package/dist/tracker/types.d.ts +5 -0
- package/dist/translations/ar.js +127 -1
- package/dist/translations/ar.js.map +1 -1
- package/dist/translations/de.js +127 -1
- package/dist/translations/de.js.map +1 -1
- package/dist/translations/en.js +127 -1
- package/dist/translations/en.js.map +1 -1
- package/dist/translations/es.js +127 -1
- package/dist/translations/es.js.map +1 -1
- package/dist/translations/fr.js +127 -1
- package/dist/translations/fr.js.map +1 -1
- package/dist/translations/id.js +127 -1
- package/dist/translations/id.js.map +1 -1
- package/dist/translations/keys.d.ts +126 -0
- package/dist/translations/keys.js +127 -1
- package/dist/translations/keys.js.map +1 -1
- package/dist/translations/ko.js +127 -1
- package/dist/translations/ko.js.map +1 -1
- package/dist/translations/metricKeys.js +8 -2
- package/dist/translations/metricKeys.js.map +1 -1
- package/dist/translations/pt.js +127 -1
- package/dist/translations/pt.js.map +1 -1
- package/dist/translations/ru.js +127 -1
- package/dist/translations/ru.js.map +1 -1
- package/dist/translations/server.js.map +1 -1
- package/dist/translations/uk.js +127 -1
- package/dist/translations/uk.js.map +1 -1
- package/dist/translations/zh.js +127 -1
- package/dist/translations/zh.js.map +1 -1
- 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 +200 -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 +64 -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 +197 -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 +186 -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 +74 -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 +10 -1
- 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 +28 -1
- 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 +72 -25
- 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 +24 -2
- package/dist/widgets/readForWidget.js +34 -48
- package/dist/widgets/readForWidget.js.map +1 -1
- package/dist/widgets/readForWidgetBreakdown.d.ts +32 -1
- package/dist/widgets/readForWidgetBreakdown.js +32 -42
- 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 +21 -20
- package/dist/widgets/readForWidgetRealtime.js.map +1 -1
- package/dist/widgets/readForWidgetSeries.d.ts +24 -1
- package/dist/widgets/readForWidgetSeries.js +63 -56
- 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/registerWidgets.js +53 -7
- package/dist/widgets/registerWidgets.js.map +1 -1
- package/dist/widgets/types.d.ts +15 -0
- package/dist/widgets/types.js +12 -1
- 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 +9 -4
- package/dist/native/rollups/applyDistinctDeltas.js +0 -9
- package/dist/native/rollups/applyDistinctDeltas.js.map +0 -1
- package/dist/native/rollups/bumpRollup.js +0 -73
- 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
package/dist/index.d.ts
CHANGED
|
@@ -1,11 +1,20 @@
|
|
|
1
1
|
import { Goal, GoalMatch, TrackerGoal } from "./goals/types.js";
|
|
2
|
+
import { AnalyticsTrackError, ServerEventInput, ServerTrack, ServerTrackOptions } from "./core/serverEvent.js";
|
|
2
3
|
import { PLATFORM_SCOPE } from "./core/contract.js";
|
|
4
|
+
import { GoalsResponse, WireGoal } from "./goals/fetchGoals.js";
|
|
5
|
+
import { QueryError, QueryErrorCode } from "./query/errors.js";
|
|
6
|
+
import { QueryErrorResponse, QueryResponse, QuerySourceRef, SerializedAnalyticsQuery } from "./query/response.js";
|
|
3
7
|
import { AnalyticsBinding, BindingContext, HostnameResolver, PathResolver } from "./binding/types.js";
|
|
4
|
-
import { CustomWidgetDef } from "./widgets/customWidget.js";
|
|
5
|
-
import { AnalyticsAccessOptions, AnalyticsCaptureOptions, AnalyticsGoalsOptions, AnalyticsPluginOptions, AutoCaptureOptions, CaptureConsentOption, ConsentMode, ConsentResolver, PlatformReadAccess, ProvidersCollectionOptions, ProvidersOptions, ProvidersResolve, ScopeResolver, ScopesResolver, TimezoneResolver } from "./core/options.js";
|
|
6
8
|
import { TimeframePreset } from "./timeframe/presets.js";
|
|
9
|
+
import { CustomWidgetDef } from "./widgets/customWidget.js";
|
|
10
|
+
import { AnalyticsAccessOptions, AnalyticsCaptureOptions, AnalyticsGoalsCollectionOptions, AnalyticsGoalsOptions, AnalyticsPluginOptions, AnalyticsReadAccess, AnalyticsViewAccess, AnalyticsViewOptions, AutoCaptureOptions, CaptureConsentOption, ConsentMode, ConsentResolver, PlatformReadAccess, ProvidersCollectionOptions, ProvidersOptions, ProvidersResolve, ScopeResolver, ScopesResolver, TimezoneResolver } from "./core/options.js";
|
|
7
11
|
import { AnalyticsFieldsOptions, AnalyticsMetricLabel, AnalyticsMetricLabels, AnalyticsStatOptions, AnalyticsStatRowOptions, AnalyticsTabOptions, analyticsFields, analyticsStat, analyticsStatRow, analyticsTab, analyticsTabsField } from "./fields/factories.js";
|
|
12
|
+
import { GoalFieldOptions, goalField, goalSlug } from "./goals/goalField.js";
|
|
13
|
+
import { GOAL_ACTION_TYPE, GoalActionDefinition, GoalActionRunArgs, TrackGoalActionOptions, trackGoalAction } from "./goals/trackGoalAction.js";
|
|
14
|
+
import { trackServerEvent } from "./native/ingest/serverTrack.js";
|
|
8
15
|
import { analyticsDefaultWidgets } from "./widgets/defaults.js";
|
|
16
|
+
import { WidgetFilter } from "./widgets/types.js";
|
|
17
|
+
import { widgetFilters } from "./widgets/filterField.js";
|
|
9
18
|
|
|
10
19
|
//#region src/index.d.ts
|
|
11
20
|
declare module 'payload' {
|
|
@@ -15,5 +24,5 @@ declare module 'payload' {
|
|
|
15
24
|
}
|
|
16
25
|
declare const analytics: (options: AnalyticsPluginOptions) => import("payload").Plugin;
|
|
17
26
|
//#endregion
|
|
18
|
-
export { type AnalyticsAccessOptions, type AnalyticsBinding, type AnalyticsCaptureOptions, type AnalyticsFieldsOptions, type AnalyticsGoalsOptions, type AnalyticsMetricLabel, type AnalyticsMetricLabels, type AnalyticsPluginOptions, type AnalyticsStatOptions, type AnalyticsStatRowOptions, type AnalyticsTabOptions, type AutoCaptureOptions, type BindingContext, type CaptureConsentOption, type ConsentMode, type ConsentResolver, type CustomWidgetDef, type Goal, type GoalMatch, type HostnameResolver, PLATFORM_SCOPE, type PathResolver, type PlatformReadAccess, type AnalyticsPluginOptions as PluginOptions, type ProvidersCollectionOptions, type ProvidersOptions, type ProvidersResolve, type ScopeResolver, type ScopesResolver, type TimeframePreset, type TimezoneResolver, type TrackerGoal, analytics, analyticsDefaultWidgets, analyticsFields, analyticsStat, analyticsStatRow, analyticsTab, analyticsTabsField };
|
|
27
|
+
export { type AnalyticsAccessOptions, type AnalyticsBinding, type AnalyticsCaptureOptions, type AnalyticsFieldsOptions, type AnalyticsGoalsCollectionOptions, type AnalyticsGoalsOptions, type AnalyticsMetricLabel, type AnalyticsMetricLabels, type AnalyticsPluginOptions, type AnalyticsReadAccess, type AnalyticsStatOptions, type AnalyticsStatRowOptions, type AnalyticsTabOptions, AnalyticsTrackError, type AnalyticsViewAccess, type AnalyticsViewOptions, type AutoCaptureOptions, type BindingContext, type CaptureConsentOption, type ConsentMode, type ConsentResolver, type CustomWidgetDef, GOAL_ACTION_TYPE, type Goal, type GoalActionDefinition, type GoalActionRunArgs, type GoalFieldOptions, type GoalMatch, type GoalsResponse, type HostnameResolver, PLATFORM_SCOPE, type PathResolver, type PlatformReadAccess, type AnalyticsPluginOptions as PluginOptions, type ProvidersCollectionOptions, type ProvidersOptions, type ProvidersResolve, type QueryError, type QueryErrorCode, type QueryErrorResponse, type QueryResponse, type QuerySourceRef, type ScopeResolver, type ScopesResolver, type SerializedAnalyticsQuery, type ServerEventInput, type ServerTrack, type ServerTrackOptions, type TimeframePreset, type TimezoneResolver, type TrackGoalActionOptions, type TrackerGoal, type WidgetFilter, type WireGoal, analytics, analyticsDefaultWidgets, analyticsFields, analyticsStat, analyticsStatRow, analyticsTab, analyticsTabsField, goalField, goalSlug, trackGoalAction, trackServerEvent, widgetFilters };
|
|
19
28
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.js
CHANGED
|
@@ -1,25 +1,36 @@
|
|
|
1
|
-
import { DOCUMENT_PATH, REALTIME_PATH, SOURCES_PATH } from "./plugin/paths.js";
|
|
1
|
+
import { DOCUMENT_PATH, GOALS_PATH, QUERY_PATH, REALTIME_PATH, SOURCES_PATH } from "./plugin/paths.js";
|
|
2
|
+
import { PLATFORM_SCOPE } from "./core/contract.js";
|
|
2
3
|
import { isValidTimeZone } from "./timeframe/tz.js";
|
|
3
4
|
import { setRuntime } from "./plugin/runtime.js";
|
|
4
5
|
import { proxyEndpoints } from "./capture/proxyEndpoint.js";
|
|
6
|
+
import { configGoalsResolver, createGoalsResolver } from "./goals/resolver.js";
|
|
7
|
+
import { buildGoalsCollection } from "./goals/collection.js";
|
|
5
8
|
import { buildProvidersCollection } from "./providers/collection.js";
|
|
6
9
|
import { resolveOptions } from "./core/options.js";
|
|
7
10
|
import { trackerEndpoint } from "./capture/trackerEndpoint.js";
|
|
8
11
|
import { createRegistry, staticRegistryResolver } from "./core/registry.js";
|
|
9
|
-
import {
|
|
12
|
+
import { makeGoalsHandler } from "./goals/goalsEndpoint.js";
|
|
13
|
+
import { AnalyticsTrackError } from "./core/serverEvent.js";
|
|
14
|
+
import { trackServerEvent } from "./native/ingest/serverTrack.js";
|
|
10
15
|
import { makeDocumentHandler } from "./plugin/documentEndpoint.js";
|
|
11
16
|
import { isModuleNotFoundError } from "./plugin/peerImportError.js";
|
|
17
|
+
import { makeQueryHandler } from "./plugin/queryEndpoint.js";
|
|
12
18
|
import { kvCacheStore } from "./surfacing/cacheStore.js";
|
|
13
19
|
import { makeRealtimeHandler } from "./plugin/realtimeEndpoint.js";
|
|
14
20
|
import { registerTranslations } from "./plugin/registerTranslations.js";
|
|
21
|
+
import { validateScopeField } from "./plugin/scopeFieldBoot.js";
|
|
15
22
|
import { makeSourcesHandler } from "./plugin/sourcesEndpoint.js";
|
|
16
23
|
import { warmTask } from "./plugin/warmTask.js";
|
|
17
24
|
import { collectionProvidersSource, combineRegistries, createScopedRegistryResolver } from "./providers/resolver.js";
|
|
18
25
|
import { createEngine } from "./surfacing/engine.js";
|
|
19
26
|
import { syncCollection } from "./sync/collection.js";
|
|
20
27
|
import { syncTask } from "./sync/syncTask.js";
|
|
28
|
+
import { registerView } from "./view/registerView.js";
|
|
29
|
+
import { widgetFilters } from "./widgets/filterField.js";
|
|
21
30
|
import { registerWidgets } from "./widgets/registerWidgets.js";
|
|
22
31
|
import { analyticsFields, analyticsStat, analyticsStatRow, analyticsTab, analyticsTabsField } from "./fields/factories.js";
|
|
32
|
+
import { goalField, goalSlug } from "./goals/goalField.js";
|
|
33
|
+
import { GOAL_ACTION_TYPE, trackGoalAction } from "./goals/trackGoalAction.js";
|
|
23
34
|
import { analyticsDefaultWidgets } from "./widgets/defaults.js";
|
|
24
35
|
import { definePlugin } from "payload";
|
|
25
36
|
//#region src/index.ts
|
|
@@ -78,6 +89,22 @@ const analytics = definePlugin({
|
|
|
78
89
|
});
|
|
79
90
|
config.collections = [...config.collections ?? [], withEncryptedQueryRewrite(providersCollection)];
|
|
80
91
|
}
|
|
92
|
+
const goalsResolver = resolved.goalsCollection.enabled ? createGoalsResolver({
|
|
93
|
+
slug: resolved.goalsCollection.slug,
|
|
94
|
+
scopeField: resolved.goalsCollection.scopeField,
|
|
95
|
+
scoped: resolved.scoped,
|
|
96
|
+
config: resolved.goals
|
|
97
|
+
}) : configGoalsResolver(resolved.goals);
|
|
98
|
+
if (resolved.goalsCollection.enabled) config.collections = [...config.collections ?? [], buildGoalsCollection({
|
|
99
|
+
slug: resolved.goalsCollection.slug,
|
|
100
|
+
access: resolved.goalsCollection.access,
|
|
101
|
+
overrides: resolved.goalsCollection.overrides,
|
|
102
|
+
onChange: () => goalsResolver.invalidate(),
|
|
103
|
+
scoped: resolved.scoped,
|
|
104
|
+
scopeField: resolved.goalsCollection.scopeField,
|
|
105
|
+
resolveScope,
|
|
106
|
+
platformRead: resolved.access.platformRead
|
|
107
|
+
})];
|
|
81
108
|
const resolveTimezone = async (req, scope) => {
|
|
82
109
|
const opt = resolved.reportingTimezone;
|
|
83
110
|
if (opt === void 0) return "UTC";
|
|
@@ -92,12 +119,11 @@ const analytics = definePlugin({
|
|
|
92
119
|
return "UTC";
|
|
93
120
|
}
|
|
94
121
|
};
|
|
95
|
-
const resolveGoals = async (_req, _scope) => resolved.goals;
|
|
96
122
|
for (const adapter of resolved.adapters) adapter.register?.(config, {
|
|
97
123
|
scoped: resolved.scoped,
|
|
98
124
|
resolveScope,
|
|
99
125
|
resolveTimezone,
|
|
100
|
-
resolveGoals
|
|
126
|
+
resolveGoals: goalsResolver.resolve
|
|
101
127
|
});
|
|
102
128
|
if (resolved.adapters.some((a) => a.capabilities.realtime && typeof a.realtime === "function") || providersEnabled) config.endpoints = [...config.endpoints ?? [], {
|
|
103
129
|
method: "get",
|
|
@@ -109,11 +135,24 @@ const analytics = definePlugin({
|
|
|
109
135
|
path: DOCUMENT_PATH,
|
|
110
136
|
handler: makeDocumentHandler()
|
|
111
137
|
}];
|
|
112
|
-
config.endpoints = [
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
138
|
+
config.endpoints = [
|
|
139
|
+
...config.endpoints ?? [],
|
|
140
|
+
{
|
|
141
|
+
method: "get",
|
|
142
|
+
path: SOURCES_PATH,
|
|
143
|
+
handler: makeSourcesHandler()
|
|
144
|
+
},
|
|
145
|
+
{
|
|
146
|
+
method: "get",
|
|
147
|
+
path: GOALS_PATH,
|
|
148
|
+
handler: makeGoalsHandler()
|
|
149
|
+
},
|
|
150
|
+
{
|
|
151
|
+
method: "get",
|
|
152
|
+
path: QUERY_PATH,
|
|
153
|
+
handler: makeQueryHandler()
|
|
154
|
+
}
|
|
155
|
+
];
|
|
117
156
|
if (resolved.adapters.some((a) => a.capture) || providersEnabled) config.endpoints = [
|
|
118
157
|
...config.endpoints,
|
|
119
158
|
...proxyEndpoints(),
|
|
@@ -128,9 +167,19 @@ const analytics = definePlugin({
|
|
|
128
167
|
disabled: resolved.widgets.disabled,
|
|
129
168
|
register: resolved.widgets.register,
|
|
130
169
|
localizeText: resolved.widgets.localizeText,
|
|
131
|
-
defaultId: resolved.defaultAdapter
|
|
170
|
+
defaultId: resolved.defaultAdapter,
|
|
171
|
+
comparison: resolved.widgets.comparison,
|
|
172
|
+
view: resolved.view === false ? false : {
|
|
173
|
+
path: resolved.view.path,
|
|
174
|
+
defaultRange: resolved.view.defaultRange,
|
|
175
|
+
defaultMetric: resolved.view.defaultMetric
|
|
176
|
+
}
|
|
132
177
|
});
|
|
133
178
|
}
|
|
179
|
+
registerView(config, {
|
|
180
|
+
view: resolved.view,
|
|
181
|
+
pluginOptions: options
|
|
182
|
+
});
|
|
134
183
|
if (resolved.cache.warm.enabled) config.jobs = {
|
|
135
184
|
...config.jobs,
|
|
136
185
|
tasks: [...config.jobs?.tasks ?? [], warmTask(resolved.cache.warm.cron, defaultLayout, resolved.scopes)]
|
|
@@ -155,6 +204,16 @@ const analytics = definePlugin({
|
|
|
155
204
|
}
|
|
156
205
|
const prevOnInit = config.onInit;
|
|
157
206
|
config.onInit = async (payload) => {
|
|
207
|
+
if (resolved.scoped && resolved.goalsCollection.enabled) validateScopeField(payload, {
|
|
208
|
+
option: "goals.collection.scopeField",
|
|
209
|
+
slug: resolved.goalsCollection.slug,
|
|
210
|
+
scopeField: resolved.goalsCollection.scopeField
|
|
211
|
+
});
|
|
212
|
+
if (resolved.scoped && resolved.providers.collection.enabled) validateScopeField(payload, {
|
|
213
|
+
option: "providers.collection.scopeField",
|
|
214
|
+
slug: resolved.providers.collection.slug,
|
|
215
|
+
scopeField: resolved.providers.collection.scopeField
|
|
216
|
+
});
|
|
158
217
|
if (resolved.providers.collection.enabled) {
|
|
159
218
|
const { validateEncryptedBoot } = await import("@10x-media/fields/encrypted");
|
|
160
219
|
await validateEncryptedBoot(payload, resolved.providers.collection.encryption?.keys);
|
|
@@ -180,10 +239,15 @@ const analytics = definePlugin({
|
|
|
180
239
|
consentFor: resolved.capture.consent,
|
|
181
240
|
autoCapture: resolved.capture.autoCapture,
|
|
182
241
|
goals: resolved.goals,
|
|
242
|
+
resolveGoals: goalsResolver.resolve,
|
|
243
|
+
resolveGoalsDetailed: goalsResolver.resolveDetailed,
|
|
244
|
+
...resolved.goalsCollection.enabled ? { goalsCollectionSlug: resolved.goalsCollection.slug } : {},
|
|
183
245
|
ingestPath: resolved.adapters.find((a) => a.ingest)?.ingest?.path,
|
|
246
|
+
track: (event, opts) => trackServerEvent(payload, event, opts),
|
|
184
247
|
scoped: resolved.scoped,
|
|
185
248
|
configAdapterIds: new Set(resolved.adapters.map((a) => a.id)),
|
|
186
249
|
platformRead: resolved.access.platformRead,
|
|
250
|
+
readAccess: resolved.access.read,
|
|
187
251
|
bindings: resolved.bindings,
|
|
188
252
|
engine,
|
|
189
253
|
ttl: resolved.cache.ttl,
|
|
@@ -195,6 +259,6 @@ const analytics = definePlugin({
|
|
|
195
259
|
}
|
|
196
260
|
});
|
|
197
261
|
//#endregion
|
|
198
|
-
export { PLATFORM_SCOPE, analytics, analyticsDefaultWidgets, analyticsFields, analyticsStat, analyticsStatRow, analyticsTab, analyticsTabsField };
|
|
262
|
+
export { AnalyticsTrackError, GOAL_ACTION_TYPE, PLATFORM_SCOPE, analytics, analyticsDefaultWidgets, analyticsFields, analyticsStat, analyticsStatRow, analyticsTab, analyticsTabsField, goalField, goalSlug, trackGoalAction, trackServerEvent, widgetFilters };
|
|
199
263
|
|
|
200
264
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { type Config, definePlugin, type PayloadRequest } from 'payload'\n\nimport { proxyEndpoints } from './capture/proxyEndpoint'\nimport { trackerEndpoint } from './capture/trackerEndpoint'\nimport { type AnalyticsPluginOptions, resolveOptions } from './core/options'\nimport { createRegistry, staticRegistryResolver } from './core/registry'\nimport type { Goal } from './goals/types'\nimport { DOCUMENT_PATH, makeDocumentHandler } from './plugin/documentEndpoint'\nimport { isModuleNotFoundError } from './plugin/peerImportError'\nimport { makeRealtimeHandler, REALTIME_PATH } from './plugin/realtimeEndpoint'\nimport { registerTranslations } from './plugin/registerTranslations'\nimport { setRuntime } from './plugin/runtime'\nimport { makeSourcesHandler, SOURCES_PATH } from './plugin/sourcesEndpoint'\nimport { warmTask } from './plugin/warmTask'\nimport type { BuildSecretField } from './providers/collection'\nimport { buildProvidersCollection } from './providers/collection'\nimport {\n\tcollectionProvidersSource,\n\tcombineRegistries,\n\tcreateScopedRegistryResolver,\n} from './providers/resolver'\nimport { kvCacheStore } from './surfacing/cacheStore'\nimport { createEngine } from './surfacing/engine'\nimport { syncCollection } from './sync/collection'\nimport { syncTask } from './sync/syncTask'\nimport { DEFAULT_TIMEZONE, isValidTimeZone } from './timeframe/tz'\nimport { registerWidgets } from './widgets/registerWidgets'\n\ndeclare module 'payload' {\n\tinterface RegisteredPlugins {\n\t\t'@10x-media/analytics': AnalyticsPluginOptions\n\t}\n}\n\nexport const analytics = definePlugin<AnalyticsPluginOptions>({\n\tslug: '@10x-media/analytics',\n\tplugin: async ({ config, plugins: _plugins, ...options }): Promise<Config> => {\n\t\tif (options.disabled === true) {\n\t\t\treturn config\n\t\t}\n\t\tconst resolved = resolveOptions(options)\n\t\t// A tenant's own runtime adapter (providers.collection or providers.resolve) has\n\t\t// capabilities unknown at config time, so it opens the widget/endpoint gates that\n\t\t// otherwise key off the config-adapter capability union.\n\t\tconst providersEnabled =\n\t\t\tresolved.providers.collection.enabled || Boolean(resolved.providers.resolve)\n\t\tconst defaultLayout = config.admin?.dashboard?.defaultLayout\n\t\tregisterTranslations(config, options.translations)\n\t\tconst registry = createRegistry(resolved.adapters, resolved.defaultAdapter)\n\t\tconst registryBase = { adapters: resolved.adapters, defaultId: resolved.defaultAdapter }\n\t\tlet resolveRegistry = staticRegistryResolver(registry)\n\t\tlet invalidateProviders = () => {}\n\t\tconst providersResolve = resolved.providers.resolve\n\t\tif (providersResolve) {\n\t\t\tresolveRegistry = async (args) =>\n\t\t\t\tcombineRegistries(\n\t\t\t\t\tregistryBase,\n\t\t\t\t\tawait providersResolve({ payload: args.payload, req: args.req, scope: args.scope })\n\t\t\t\t)\n\t\t} else if (resolved.providers.collection.enabled) {\n\t\t\tconst scoped = createScopedRegistryResolver({\n\t\t\t\tbase: registryBase,\n\t\t\t\tsource: collectionProvidersSource(\n\t\t\t\t\tresolved.providers.collection.slug,\n\t\t\t\t\tresolved.providers.collection.scopeField\n\t\t\t\t),\n\t\t\t})\n\t\t\tresolveRegistry = scoped.resolver\n\t\t\tinvalidateProviders = scoped.invalidate\n\t\t}\n\t\tconst resolveScope = async (req: PayloadRequest) => resolved.scopeResolver({ req })\n\t\tif (resolved.providers.collection.enabled) {\n\t\t\tconst { encryptedField, withEncryptedQueryRewrite } = await import(\n\t\t\t\t'@10x-media/fields/encrypted'\n\t\t\t).catch((err: unknown) => {\n\t\t\t\tif (isModuleNotFoundError(err)) {\n\t\t\t\t\tthrow new Error(\n\t\t\t\t\t\t'analytics: providers.collection requires @10x-media/fields (peer). Install it: pnpm add @10x-media/fields'\n\t\t\t\t\t)\n\t\t\t\t}\n\t\t\t\tthrow err\n\t\t\t})\n\t\t\tconst encryption = resolved.providers.collection.encryption\n\t\t\tconst buildSecret: BuildSecretField = (source) =>\n\t\t\t\tencryptedField(source, {\n\t\t\t\t\tprotection: 'writeOnly',\n\t\t\t\t\taadScope: '10x-analytics:providers',\n\t\t\t\t\t...(source.type === 'text' ? { hint: { suffix: 4 } } : {}),\n\t\t\t\t\t...(encryption?.keys ? { keys: encryption.keys } : {}),\n\t\t\t\t})\n\t\t\tconst providersCollection = buildProvidersCollection({\n\t\t\t\tslug: resolved.providers.collection.slug,\n\t\t\t\taccess: resolved.providers.collection.access,\n\t\t\t\toverrides: resolved.providers.collection.overrides,\n\t\t\t\tonChange: () => invalidateProviders(),\n\t\t\t\tscoped: resolved.scoped,\n\t\t\t\tscopeField: resolved.providers.collection.scopeField,\n\t\t\t\tresolveScope,\n\t\t\t\tplatformRead: resolved.access.platformRead,\n\t\t\t\tbuildSecret,\n\t\t\t})\n\t\t\t// Always wrap, even though a consumer's own @10x-media/fields plugin (if\n\t\t\t// registered) may wrap this collection again later: double application is\n\t\t\t// inert here (writeOnly forbids queryable, so there are no blind-index\n\t\t\t// markers to rewrite and the response strip is an idempotent delete),\n\t\t\t// while skipping would leak ciphertext whenever fields() runs before this\n\t\t\t// collection exists (e.g. an earlier plugin `order`).\n\t\t\tconfig.collections = [\n\t\t\t\t...(config.collections ?? []),\n\t\t\t\twithEncryptedQueryRewrite(providersCollection),\n\t\t\t]\n\t\t}\n\t\tconst resolveTimezone = async (req: PayloadRequest, scope?: string | null): Promise<string> => {\n\t\t\tconst opt = resolved.reportingTimezone\n\t\t\tif (opt === undefined) {\n\t\t\t\treturn DEFAULT_TIMEZONE\n\t\t\t}\n\t\t\ttry {\n\t\t\t\tconst tz =\n\t\t\t\t\ttypeof opt === 'string'\n\t\t\t\t\t\t? opt\n\t\t\t\t\t\t: await opt({ req, scope: scope !== undefined ? scope : await resolveScope(req) })\n\t\t\t\treturn tz && isValidTimeZone(tz) ? tz : DEFAULT_TIMEZONE\n\t\t\t} catch (err) {\n\t\t\t\treq.payload?.logger?.warn?.(\n\t\t\t\t\t`analytics: reportingTimezone resolution failed, falling back to UTC: ${String(err)}`\n\t\t\t\t)\n\t\t\t\treturn DEFAULT_TIMEZONE\n\t\t\t}\n\t\t}\n\t\t// Config goals are install-wide, so scope is accepted and ignored here; a collection\n\t\t// source resolves per scope behind the same signature.\n\t\tconst resolveGoals = async (_req: PayloadRequest, _scope?: string | null): Promise<Goal[]> =>\n\t\t\tresolved.goals\n\t\tfor (const adapter of resolved.adapters) {\n\t\t\tadapter.register?.(config, {\n\t\t\t\tscoped: resolved.scoped,\n\t\t\t\tresolveScope,\n\t\t\t\tresolveTimezone,\n\t\t\t\tresolveGoals,\n\t\t\t})\n\t\t}\n\t\tif (\n\t\t\tresolved.adapters.some((a) => a.capabilities.realtime && typeof a.realtime === 'function') ||\n\t\t\tprovidersEnabled\n\t\t) {\n\t\t\tconfig.endpoints = [\n\t\t\t\t...(config.endpoints ?? []),\n\t\t\t\t{ method: 'get', path: REALTIME_PATH, handler: makeRealtimeHandler() },\n\t\t\t]\n\t\t}\n\t\tif (Object.keys(resolved.bindings).length > 0) {\n\t\t\tconfig.endpoints = [\n\t\t\t\t...(config.endpoints ?? []),\n\t\t\t\t{ method: 'get', path: DOCUMENT_PATH, handler: makeDocumentHandler() },\n\t\t\t]\n\t\t}\n\t\tconfig.endpoints = [\n\t\t\t...(config.endpoints ?? []),\n\t\t\t{ method: 'get', path: SOURCES_PATH, handler: makeSourcesHandler() },\n\t\t]\n\t\t// A runtime provider's capture support is unknown at config time, so providers\n\t\t// alone are enough to mount the proxy; every slot is still resolved per request.\n\t\tif (resolved.adapters.some((a) => a.capture) || providersEnabled) {\n\t\t\tconfig.endpoints = [...config.endpoints, ...proxyEndpoints(), trackerEndpoint()]\n\t\t}\n\t\tif (resolved.widgets.enabled) {\n\t\t\tconst multiProvider = registry.isMultiProvider() || providersEnabled\n\t\t\tregisterWidgets(config, {\n\t\t\t\tadapters: resolved.adapters,\n\t\t\t\tmultiProvider,\n\t\t\t\tprovidersEnabled,\n\t\t\t\tdisabled: resolved.widgets.disabled,\n\t\t\t\tregister: resolved.widgets.register,\n\t\t\t\tlocalizeText: resolved.widgets.localizeText,\n\t\t\t\tdefaultId: resolved.defaultAdapter,\n\t\t\t})\n\t\t}\n\t\tif (resolved.cache.warm.enabled) {\n\t\t\tconfig.jobs = {\n\t\t\t\t...config.jobs,\n\t\t\t\ttasks: [\n\t\t\t\t\t...(config.jobs?.tasks ?? []),\n\t\t\t\t\twarmTask(resolved.cache.warm.cron, defaultLayout, resolved.scopes),\n\t\t\t\t],\n\t\t\t}\n\t\t}\n\t\tif (resolved.sync.enabled) {\n\t\t\tconfig.collections = [\n\t\t\t\t...(config.collections ?? []),\n\t\t\t\tsyncCollection(resolved.sync.collectionSlug, resolved.sync.hidden, {\n\t\t\t\t\tscoped: resolved.scoped,\n\t\t\t\t\tscopeField: 'scope',\n\t\t\t\t\tresolveScope,\n\t\t\t\t\tplatformRead: resolved.access.platformRead,\n\t\t\t\t}),\n\t\t\t]\n\t\t\tconfig.jobs = {\n\t\t\t\t...config.jobs,\n\t\t\t\ttasks: [\n\t\t\t\t\t...(config.jobs?.tasks ?? []),\n\t\t\t\t\tsyncTask({\n\t\t\t\t\t\tcron: resolved.sync.cron,\n\t\t\t\t\t\tlookbackDays: resolved.sync.lookbackDays,\n\t\t\t\t\t\tcollectionSlug: resolved.sync.collectionSlug,\n\t\t\t\t\t\tadapterIds: resolved.sync.adapters,\n\t\t\t\t\t\tscopes: resolved.scopes,\n\t\t\t\t\t}),\n\t\t\t\t],\n\t\t\t}\n\t\t}\n\t\tconst prevOnInit = config.onInit\n\t\t// The runtime is installed before the app's own onInit runs so consumer init code\n\t\t// (seeding, cache warming, sync passes) can already read through the plugin.\n\t\tconfig.onInit = async (payload) => {\n\t\t\tif (resolved.providers.collection.enabled) {\n\t\t\t\tconst { validateEncryptedBoot } = await import('@10x-media/fields/encrypted')\n\t\t\t\tawait validateEncryptedBoot(payload, resolved.providers.collection.encryption?.keys)\n\t\t\t}\n\t\t\tconst engine = createEngine({\n\t\t\t\tstore: kvCacheStore(payload.kv),\n\t\t\t\tqueue: { concurrency: 4 },\n\t\t\t\tttl: resolved.cache.ttl,\n\t\t\t\ttimeoutMs: resolved.cache.timeoutMs,\n\t\t\t\tonError: (err, adapterId) => {\n\t\t\t\t\tpayload.logger?.warn(`analytics: read failed for adapter \"${adapterId}\": ${String(err)}`)\n\t\t\t\t},\n\t\t\t})\n\t\t\tsetRuntime(payload, {\n\t\t\t\tregistry,\n\t\t\t\tresolveRegistry,\n\t\t\t\tresolveScope,\n\t\t\t\tresolveTimezone,\n\t\t\t\tplatformAdapterId: resolved.platformAdapter,\n\t\t\t\tcaptureSlots: resolved.capture.slots,\n\t\t\t\tcapturePaths: resolved.capture.paths,\n\t\t\t\tcaptureProxy: resolved.capture.proxy,\n\t\t\t\tconsentFor: resolved.capture.consent,\n\t\t\t\tautoCapture: resolved.capture.autoCapture,\n\t\t\t\tgoals: resolved.goals,\n\t\t\t\tingestPath: resolved.adapters.find((a) => a.ingest)?.ingest?.path,\n\t\t\t\tscoped: resolved.scoped,\n\t\t\t\tconfigAdapterIds: new Set(resolved.adapters.map((a) => a.id)),\n\t\t\t\tplatformRead: resolved.access.platformRead,\n\t\t\t\tbindings: resolved.bindings,\n\t\t\t\tengine,\n\t\t\t\tttl: resolved.cache.ttl,\n\t\t\t\tcomparison: resolved.widgets.comparison,\n\t\t\t})\n\t\t\tawait prevOnInit?.(payload)\n\t\t}\n\t\treturn config\n\t},\n})\n\nexport type {\n\tAnalyticsBinding,\n\tBindingContext,\n\tHostnameResolver,\n\tPathResolver,\n} from './binding/types'\nexport { PLATFORM_SCOPE } from './core/contract'\nexport type {\n\tAnalyticsAccessOptions,\n\tAnalyticsCaptureOptions,\n\tAnalyticsGoalsOptions,\n\tAnalyticsPluginOptions,\n\tAnalyticsPluginOptions as PluginOptions,\n\tAutoCaptureOptions,\n\tCaptureConsentOption,\n\tConsentMode,\n\tConsentResolver,\n\tPlatformReadAccess,\n\tProvidersCollectionOptions,\n\tProvidersOptions,\n\tProvidersResolve,\n\tScopeResolver,\n\tScopesResolver,\n\tTimezoneResolver,\n} from './core/options'\nexport type {\n\tAnalyticsFieldsOptions,\n\tAnalyticsMetricLabel,\n\tAnalyticsMetricLabels,\n\tAnalyticsStatOptions,\n\tAnalyticsStatRowOptions,\n\tAnalyticsTabOptions,\n} from './fields/factories'\nexport {\n\tanalyticsFields,\n\tanalyticsStat,\n\tanalyticsStatRow,\n\tanalyticsTab,\n\tanalyticsTabsField,\n} from './fields/factories'\nexport type { Goal, GoalMatch, TrackerGoal } from './goals/types'\nexport type { TimeframePreset } from './timeframe/presets'\nexport type { CustomWidgetDef } from './widgets/customWidget'\nexport { analyticsDefaultWidgets } from './widgets/defaults'\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAkCA,MAAa,YAAY,aAAqC;CAC7D,MAAM;CACN,QAAQ,OAAO,EAAE,QAAQ,SAAS,UAAU,GAAG,cAA+B;EAC7E,IAAI,QAAQ,aAAa,MACxB,OAAO;EAER,MAAM,WAAW,eAAe,OAAO;EAIvC,MAAM,mBACL,SAAS,UAAU,WAAW,WAAW,QAAQ,SAAS,UAAU,OAAO;EAC5E,MAAM,gBAAgB,OAAO,OAAO,WAAW;EAC/C,qBAAqB,QAAQ,QAAQ,YAAY;EACjD,MAAM,WAAW,eAAe,SAAS,UAAU,SAAS,cAAc;EAC1E,MAAM,eAAe;GAAE,UAAU,SAAS;GAAU,WAAW,SAAS;EAAe;EACvF,IAAI,kBAAkB,uBAAuB,QAAQ;EACrD,IAAI,4BAA4B,CAAC;EACjC,MAAM,mBAAmB,SAAS,UAAU;EAC5C,IAAI,kBACH,kBAAkB,OAAO,SACxB,kBACC,cACA,MAAM,iBAAiB;GAAE,SAAS,KAAK;GAAS,KAAK,KAAK;GAAK,OAAO,KAAK;EAAM,CAAC,CACnF;OACK,IAAI,SAAS,UAAU,WAAW,SAAS;GACjD,MAAM,SAAS,6BAA6B;IAC3C,MAAM;IACN,QAAQ,0BACP,SAAS,UAAU,WAAW,MAC9B,SAAS,UAAU,WAAW,UAC/B;GACD,CAAC;GACD,kBAAkB,OAAO;GACzB,sBAAsB,OAAO;EAC9B;EACA,MAAM,eAAe,OAAO,QAAwB,SAAS,cAAc,EAAE,IAAI,CAAC;EAClF,IAAI,SAAS,UAAU,WAAW,SAAS;GAC1C,MAAM,EAAE,gBAAgB,8BAA8B,MAAM,OAC3D,+BACC,OAAO,QAAiB;IACzB,IAAI,sBAAsB,GAAG,GAC5B,MAAM,IAAI,MACT,2GACD;IAED,MAAM;GACP,CAAC;GACD,MAAM,aAAa,SAAS,UAAU,WAAW;GACjD,MAAM,eAAiC,WACtC,eAAe,QAAQ;IACtB,YAAY;IACZ,UAAU;IACV,GAAI,OAAO,SAAS,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,IAAI,CAAC;IACxD,GAAI,YAAY,OAAO,EAAE,MAAM,WAAW,KAAK,IAAI,CAAC;GACrD,CAAC;GACF,MAAM,sBAAsB,yBAAyB;IACpD,MAAM,SAAS,UAAU,WAAW;IACpC,QAAQ,SAAS,UAAU,WAAW;IACtC,WAAW,SAAS,UAAU,WAAW;IACzC,gBAAgB,oBAAoB;IACpC,QAAQ,SAAS;IACjB,YAAY,SAAS,UAAU,WAAW;IAC1C;IACA,cAAc,SAAS,OAAO;IAC9B;GACD,CAAC;GAOD,OAAO,cAAc,CACpB,GAAI,OAAO,eAAe,CAAC,GAC3B,0BAA0B,mBAAmB,CAC9C;EACD;EACA,MAAM,kBAAkB,OAAO,KAAqB,UAA2C;GAC9F,MAAM,MAAM,SAAS;GACrB,IAAI,QAAQ,KAAA,GACX,OAAA;GAED,IAAI;IACH,MAAM,KACL,OAAO,QAAQ,WACZ,MACA,MAAM,IAAI;KAAE;KAAK,OAAO,UAAU,KAAA,IAAY,QAAQ,MAAM,aAAa,GAAG;IAAE,CAAC;IACnF,OAAO,MAAM,gBAAgB,EAAE,IAAI,KAAA;GACpC,SAAS,KAAK;IACb,IAAI,SAAS,QAAQ,OACpB,wEAAwE,OAAO,GAAG,GACnF;IACA,OAAA;GACD;EACD;EAGA,MAAM,eAAe,OAAO,MAAsB,WACjD,SAAS;EACV,KAAK,MAAM,WAAW,SAAS,UAC9B,QAAQ,WAAW,QAAQ;GAC1B,QAAQ,SAAS;GACjB;GACA;GACA;EACD,CAAC;EAEF,IACC,SAAS,SAAS,MAAM,MAAM,EAAE,aAAa,YAAY,OAAO,EAAE,aAAa,UAAU,KACzF,kBAEA,OAAO,YAAY,CAClB,GAAI,OAAO,aAAa,CAAC,GACzB;GAAE,QAAQ;GAAO,MAAM;GAAe,SAAS,oBAAoB;EAAE,CACtE;EAED,IAAI,OAAO,KAAK,SAAS,QAAQ,EAAE,SAAS,GAC3C,OAAO,YAAY,CAClB,GAAI,OAAO,aAAa,CAAC,GACzB;GAAE,QAAQ;GAAO,MAAM;GAAe,SAAS,oBAAoB;EAAE,CACtE;EAED,OAAO,YAAY,CAClB,GAAI,OAAO,aAAa,CAAC,GACzB;GAAE,QAAQ;GAAO,MAAM;GAAc,SAAS,mBAAmB;EAAE,CACpE;EAGA,IAAI,SAAS,SAAS,MAAM,MAAM,EAAE,OAAO,KAAK,kBAC/C,OAAO,YAAY;GAAC,GAAG,OAAO;GAAW,GAAG,eAAe;GAAG,gBAAgB;EAAC;EAEhF,IAAI,SAAS,QAAQ,SAAS;GAC7B,MAAM,gBAAgB,SAAS,gBAAgB,KAAK;GACpD,gBAAgB,QAAQ;IACvB,UAAU,SAAS;IACnB;IACA;IACA,UAAU,SAAS,QAAQ;IAC3B,UAAU,SAAS,QAAQ;IAC3B,cAAc,SAAS,QAAQ;IAC/B,WAAW,SAAS;GACrB,CAAC;EACF;EACA,IAAI,SAAS,MAAM,KAAK,SACvB,OAAO,OAAO;GACb,GAAG,OAAO;GACV,OAAO,CACN,GAAI,OAAO,MAAM,SAAS,CAAC,GAC3B,SAAS,SAAS,MAAM,KAAK,MAAM,eAAe,SAAS,MAAM,CAClE;EACD;EAED,IAAI,SAAS,KAAK,SAAS;GAC1B,OAAO,cAAc,CACpB,GAAI,OAAO,eAAe,CAAC,GAC3B,eAAe,SAAS,KAAK,gBAAgB,SAAS,KAAK,QAAQ;IAClE,QAAQ,SAAS;IACjB,YAAY;IACZ;IACA,cAAc,SAAS,OAAO;GAC/B,CAAC,CACF;GACA,OAAO,OAAO;IACb,GAAG,OAAO;IACV,OAAO,CACN,GAAI,OAAO,MAAM,SAAS,CAAC,GAC3B,SAAS;KACR,MAAM,SAAS,KAAK;KACpB,cAAc,SAAS,KAAK;KAC5B,gBAAgB,SAAS,KAAK;KAC9B,YAAY,SAAS,KAAK;KAC1B,QAAQ,SAAS;IAClB,CAAC,CACF;GACD;EACD;EACA,MAAM,aAAa,OAAO;EAG1B,OAAO,SAAS,OAAO,YAAY;GAClC,IAAI,SAAS,UAAU,WAAW,SAAS;IAC1C,MAAM,EAAE,0BAA0B,MAAM,OAAO;IAC/C,MAAM,sBAAsB,SAAS,SAAS,UAAU,WAAW,YAAY,IAAI;GACpF;GACA,MAAM,SAAS,aAAa;IAC3B,OAAO,aAAa,QAAQ,EAAE;IAC9B,OAAO,EAAE,aAAa,EAAE;IACxB,KAAK,SAAS,MAAM;IACpB,WAAW,SAAS,MAAM;IAC1B,UAAU,KAAK,cAAc;KAC5B,QAAQ,QAAQ,KAAK,uCAAuC,UAAU,KAAK,OAAO,GAAG,GAAG;IACzF;GACD,CAAC;GACD,WAAW,SAAS;IACnB;IACA;IACA;IACA;IACA,mBAAmB,SAAS;IAC5B,cAAc,SAAS,QAAQ;IAC/B,cAAc,SAAS,QAAQ;IAC/B,cAAc,SAAS,QAAQ;IAC/B,YAAY,SAAS,QAAQ;IAC7B,aAAa,SAAS,QAAQ;IAC9B,OAAO,SAAS;IAChB,YAAY,SAAS,SAAS,MAAM,MAAM,EAAE,MAAM,GAAG,QAAQ;IAC7D,QAAQ,SAAS;IACjB,kBAAkB,IAAI,IAAI,SAAS,SAAS,KAAK,MAAM,EAAE,EAAE,CAAC;IAC5D,cAAc,SAAS,OAAO;IAC9B,UAAU,SAAS;IACnB;IACA,KAAK,SAAS,MAAM;IACpB,YAAY,SAAS,QAAQ;GAC9B,CAAC;GACD,MAAM,aAAa,OAAO;EAC3B;EACA,OAAO;CACR;AACD,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { type Config, definePlugin, type PayloadRequest } from 'payload'\n\nimport { proxyEndpoints } from './capture/proxyEndpoint'\nimport { trackerEndpoint } from './capture/trackerEndpoint'\nimport { type AnalyticsPluginOptions, resolveOptions } from './core/options'\nimport { createRegistry, staticRegistryResolver } from './core/registry'\nimport { buildGoalsCollection } from './goals/collection'\nimport { GOALS_PATH, makeGoalsHandler } from './goals/goalsEndpoint'\nimport { configGoalsResolver, createGoalsResolver } from './goals/resolver'\nimport { trackServerEvent } from './native/ingest/serverTrack'\nimport { DOCUMENT_PATH, makeDocumentHandler } from './plugin/documentEndpoint'\nimport { isModuleNotFoundError } from './plugin/peerImportError'\nimport { makeQueryHandler, QUERY_PATH } from './plugin/queryEndpoint'\nimport { makeRealtimeHandler, REALTIME_PATH } from './plugin/realtimeEndpoint'\nimport { registerTranslations } from './plugin/registerTranslations'\nimport { setRuntime } from './plugin/runtime'\nimport { validateScopeField } from './plugin/scopeFieldBoot'\nimport { makeSourcesHandler, SOURCES_PATH } from './plugin/sourcesEndpoint'\nimport { warmTask } from './plugin/warmTask'\nimport type { BuildSecretField } from './providers/collection'\nimport { buildProvidersCollection } from './providers/collection'\nimport {\n\tcollectionProvidersSource,\n\tcombineRegistries,\n\tcreateScopedRegistryResolver,\n} from './providers/resolver'\nimport { kvCacheStore } from './surfacing/cacheStore'\nimport { createEngine } from './surfacing/engine'\nimport { syncCollection } from './sync/collection'\nimport { syncTask } from './sync/syncTask'\nimport { DEFAULT_TIMEZONE, isValidTimeZone } from './timeframe/tz'\nimport { registerView } from './view/registerView'\nimport { registerWidgets } from './widgets/registerWidgets'\n\ndeclare module 'payload' {\n\tinterface RegisteredPlugins {\n\t\t'@10x-media/analytics': AnalyticsPluginOptions\n\t}\n}\n\nexport const analytics = definePlugin<AnalyticsPluginOptions>({\n\tslug: '@10x-media/analytics',\n\tplugin: async ({ config, plugins: _plugins, ...options }): Promise<Config> => {\n\t\tif (options.disabled === true) {\n\t\t\treturn config\n\t\t}\n\t\tconst resolved = resolveOptions(options)\n\t\t// A tenant's own runtime adapter (providers.collection or providers.resolve) has\n\t\t// capabilities unknown at config time, so it opens the widget/endpoint gates that\n\t\t// otherwise key off the config-adapter capability union.\n\t\tconst providersEnabled =\n\t\t\tresolved.providers.collection.enabled || Boolean(resolved.providers.resolve)\n\t\tconst defaultLayout = config.admin?.dashboard?.defaultLayout\n\t\tregisterTranslations(config, options.translations)\n\t\tconst registry = createRegistry(resolved.adapters, resolved.defaultAdapter)\n\t\tconst registryBase = { adapters: resolved.adapters, defaultId: resolved.defaultAdapter }\n\t\tlet resolveRegistry = staticRegistryResolver(registry)\n\t\tlet invalidateProviders = () => {}\n\t\tconst providersResolve = resolved.providers.resolve\n\t\tif (providersResolve) {\n\t\t\tresolveRegistry = async (args) =>\n\t\t\t\tcombineRegistries(\n\t\t\t\t\tregistryBase,\n\t\t\t\t\tawait providersResolve({ payload: args.payload, req: args.req, scope: args.scope })\n\t\t\t\t)\n\t\t} else if (resolved.providers.collection.enabled) {\n\t\t\tconst scoped = createScopedRegistryResolver({\n\t\t\t\tbase: registryBase,\n\t\t\t\tsource: collectionProvidersSource(\n\t\t\t\t\tresolved.providers.collection.slug,\n\t\t\t\t\tresolved.providers.collection.scopeField\n\t\t\t\t),\n\t\t\t})\n\t\t\tresolveRegistry = scoped.resolver\n\t\t\tinvalidateProviders = scoped.invalidate\n\t\t}\n\t\tconst resolveScope = async (req: PayloadRequest) => resolved.scopeResolver({ req })\n\t\tif (resolved.providers.collection.enabled) {\n\t\t\tconst { encryptedField, withEncryptedQueryRewrite } = await import(\n\t\t\t\t'@10x-media/fields/encrypted'\n\t\t\t).catch((err: unknown) => {\n\t\t\t\tif (isModuleNotFoundError(err)) {\n\t\t\t\t\tthrow new Error(\n\t\t\t\t\t\t'analytics: providers.collection requires @10x-media/fields (peer). Install it: pnpm add @10x-media/fields'\n\t\t\t\t\t)\n\t\t\t\t}\n\t\t\t\tthrow err\n\t\t\t})\n\t\t\tconst encryption = resolved.providers.collection.encryption\n\t\t\tconst buildSecret: BuildSecretField = (source) =>\n\t\t\t\tencryptedField(source, {\n\t\t\t\t\tprotection: 'writeOnly',\n\t\t\t\t\taadScope: '10x-analytics:providers',\n\t\t\t\t\t...(source.type === 'text' ? { hint: { suffix: 4 } } : {}),\n\t\t\t\t\t...(encryption?.keys ? { keys: encryption.keys } : {}),\n\t\t\t\t})\n\t\t\tconst providersCollection = buildProvidersCollection({\n\t\t\t\tslug: resolved.providers.collection.slug,\n\t\t\t\taccess: resolved.providers.collection.access,\n\t\t\t\toverrides: resolved.providers.collection.overrides,\n\t\t\t\tonChange: () => invalidateProviders(),\n\t\t\t\tscoped: resolved.scoped,\n\t\t\t\tscopeField: resolved.providers.collection.scopeField,\n\t\t\t\tresolveScope,\n\t\t\t\tplatformRead: resolved.access.platformRead,\n\t\t\t\tbuildSecret,\n\t\t\t})\n\t\t\t// Always wrap, even though a consumer's own @10x-media/fields plugin (if\n\t\t\t// registered) may wrap this collection again later: double application is\n\t\t\t// inert here (writeOnly forbids queryable, so there are no blind-index\n\t\t\t// markers to rewrite and the response strip is an idempotent delete),\n\t\t\t// while skipping would leak ciphertext whenever fields() runs before this\n\t\t\t// collection exists (e.g. an earlier plugin `order`).\n\t\t\tconfig.collections = [\n\t\t\t\t...(config.collections ?? []),\n\t\t\t\twithEncryptedQueryRewrite(providersCollection),\n\t\t\t]\n\t\t}\n\t\t// Config goals are install-wide; the collection resolves per scope and merges over\n\t\t// them behind the same signature, so ingest and the tracker config read one source.\n\t\tconst goalsResolver = resolved.goalsCollection.enabled\n\t\t\t? createGoalsResolver({\n\t\t\t\t\tslug: resolved.goalsCollection.slug,\n\t\t\t\t\tscopeField: resolved.goalsCollection.scopeField,\n\t\t\t\t\tscoped: resolved.scoped,\n\t\t\t\t\tconfig: resolved.goals,\n\t\t\t\t})\n\t\t\t: configGoalsResolver(resolved.goals)\n\t\tif (resolved.goalsCollection.enabled) {\n\t\t\tconfig.collections = [\n\t\t\t\t...(config.collections ?? []),\n\t\t\t\tbuildGoalsCollection({\n\t\t\t\t\tslug: resolved.goalsCollection.slug,\n\t\t\t\t\taccess: resolved.goalsCollection.access,\n\t\t\t\t\toverrides: resolved.goalsCollection.overrides,\n\t\t\t\t\tonChange: () => goalsResolver.invalidate(),\n\t\t\t\t\tscoped: resolved.scoped,\n\t\t\t\t\tscopeField: resolved.goalsCollection.scopeField,\n\t\t\t\t\tresolveScope,\n\t\t\t\t\tplatformRead: resolved.access.platformRead,\n\t\t\t\t}),\n\t\t\t]\n\t\t}\n\t\tconst resolveTimezone = async (req: PayloadRequest, scope?: string | null): Promise<string> => {\n\t\t\tconst opt = resolved.reportingTimezone\n\t\t\tif (opt === undefined) {\n\t\t\t\treturn DEFAULT_TIMEZONE\n\t\t\t}\n\t\t\ttry {\n\t\t\t\tconst tz =\n\t\t\t\t\ttypeof opt === 'string'\n\t\t\t\t\t\t? opt\n\t\t\t\t\t\t: await opt({ req, scope: scope !== undefined ? scope : await resolveScope(req) })\n\t\t\t\treturn tz && isValidTimeZone(tz) ? tz : DEFAULT_TIMEZONE\n\t\t\t} catch (err) {\n\t\t\t\treq.payload?.logger?.warn?.(\n\t\t\t\t\t`analytics: reportingTimezone resolution failed, falling back to UTC: ${String(err)}`\n\t\t\t\t)\n\t\t\t\treturn DEFAULT_TIMEZONE\n\t\t\t}\n\t\t}\n\t\tfor (const adapter of resolved.adapters) {\n\t\t\tadapter.register?.(config, {\n\t\t\t\tscoped: resolved.scoped,\n\t\t\t\tresolveScope,\n\t\t\t\tresolveTimezone,\n\t\t\t\tresolveGoals: goalsResolver.resolve,\n\t\t\t})\n\t\t}\n\t\tif (\n\t\t\tresolved.adapters.some((a) => a.capabilities.realtime && typeof a.realtime === 'function') ||\n\t\t\tprovidersEnabled\n\t\t) {\n\t\t\tconfig.endpoints = [\n\t\t\t\t...(config.endpoints ?? []),\n\t\t\t\t{ method: 'get', path: REALTIME_PATH, handler: makeRealtimeHandler() },\n\t\t\t]\n\t\t}\n\t\tif (Object.keys(resolved.bindings).length > 0) {\n\t\t\tconfig.endpoints = [\n\t\t\t\t...(config.endpoints ?? []),\n\t\t\t\t{ method: 'get', path: DOCUMENT_PATH, handler: makeDocumentHandler() },\n\t\t\t]\n\t\t}\n\t\tconfig.endpoints = [\n\t\t\t...(config.endpoints ?? []),\n\t\t\t{ method: 'get', path: SOURCES_PATH, handler: makeSourcesHandler() },\n\t\t\t{ method: 'get', path: GOALS_PATH, handler: makeGoalsHandler() },\n\t\t\t{ method: 'get', path: QUERY_PATH, handler: makeQueryHandler() },\n\t\t]\n\t\t// A runtime provider's capture support is unknown at config time, so providers\n\t\t// alone are enough to mount the proxy; every slot is still resolved per request.\n\t\tif (resolved.adapters.some((a) => a.capture) || providersEnabled) {\n\t\t\tconfig.endpoints = [...config.endpoints, ...proxyEndpoints(), trackerEndpoint()]\n\t\t}\n\t\tif (resolved.widgets.enabled) {\n\t\t\tconst multiProvider = registry.isMultiProvider() || providersEnabled\n\t\t\tregisterWidgets(config, {\n\t\t\t\tadapters: resolved.adapters,\n\t\t\t\tmultiProvider,\n\t\t\t\tprovidersEnabled,\n\t\t\t\tdisabled: resolved.widgets.disabled,\n\t\t\t\tregister: resolved.widgets.register,\n\t\t\t\tlocalizeText: resolved.widgets.localizeText,\n\t\t\t\tdefaultId: resolved.defaultAdapter,\n\t\t\t\tcomparison: resolved.widgets.comparison,\n\t\t\t\tview:\n\t\t\t\t\tresolved.view === false\n\t\t\t\t\t\t? false\n\t\t\t\t\t\t: {\n\t\t\t\t\t\t\t\tpath: resolved.view.path,\n\t\t\t\t\t\t\t\tdefaultRange: resolved.view.defaultRange,\n\t\t\t\t\t\t\t\tdefaultMetric: resolved.view.defaultMetric,\n\t\t\t\t\t\t\t},\n\t\t\t})\n\t\t}\n\t\tregisterView(config, { view: resolved.view, pluginOptions: options })\n\t\tif (resolved.cache.warm.enabled) {\n\t\t\tconfig.jobs = {\n\t\t\t\t...config.jobs,\n\t\t\t\ttasks: [\n\t\t\t\t\t...(config.jobs?.tasks ?? []),\n\t\t\t\t\twarmTask(resolved.cache.warm.cron, defaultLayout, resolved.scopes),\n\t\t\t\t],\n\t\t\t}\n\t\t}\n\t\tif (resolved.sync.enabled) {\n\t\t\tconfig.collections = [\n\t\t\t\t...(config.collections ?? []),\n\t\t\t\tsyncCollection(resolved.sync.collectionSlug, resolved.sync.hidden, {\n\t\t\t\t\tscoped: resolved.scoped,\n\t\t\t\t\tscopeField: 'scope',\n\t\t\t\t\tresolveScope,\n\t\t\t\t\tplatformRead: resolved.access.platformRead,\n\t\t\t\t}),\n\t\t\t]\n\t\t\tconfig.jobs = {\n\t\t\t\t...config.jobs,\n\t\t\t\ttasks: [\n\t\t\t\t\t...(config.jobs?.tasks ?? []),\n\t\t\t\t\tsyncTask({\n\t\t\t\t\t\tcron: resolved.sync.cron,\n\t\t\t\t\t\tlookbackDays: resolved.sync.lookbackDays,\n\t\t\t\t\t\tcollectionSlug: resolved.sync.collectionSlug,\n\t\t\t\t\t\tadapterIds: resolved.sync.adapters,\n\t\t\t\t\t\tscopes: resolved.scopes,\n\t\t\t\t\t}),\n\t\t\t\t],\n\t\t\t}\n\t\t}\n\t\tconst prevOnInit = config.onInit\n\t\t// The runtime is installed before the app's own onInit runs so consumer init code\n\t\t// (seeding, cache warming, sync passes) can already read through the plugin.\n\t\tconfig.onInit = async (payload) => {\n\t\t\t// Host-owned scope fields only exist once every plugin has run, so the collections\n\t\t\t// are checked against the assembled config rather than at config time.\n\t\t\tif (resolved.scoped && resolved.goalsCollection.enabled) {\n\t\t\t\tvalidateScopeField(payload, {\n\t\t\t\t\toption: 'goals.collection.scopeField',\n\t\t\t\t\tslug: resolved.goalsCollection.slug,\n\t\t\t\t\tscopeField: resolved.goalsCollection.scopeField,\n\t\t\t\t})\n\t\t\t}\n\t\t\tif (resolved.scoped && resolved.providers.collection.enabled) {\n\t\t\t\tvalidateScopeField(payload, {\n\t\t\t\t\toption: 'providers.collection.scopeField',\n\t\t\t\t\tslug: resolved.providers.collection.slug,\n\t\t\t\t\tscopeField: resolved.providers.collection.scopeField,\n\t\t\t\t})\n\t\t\t}\n\t\t\tif (resolved.providers.collection.enabled) {\n\t\t\t\tconst { validateEncryptedBoot } = await import('@10x-media/fields/encrypted')\n\t\t\t\tawait validateEncryptedBoot(payload, resolved.providers.collection.encryption?.keys)\n\t\t\t}\n\t\t\tconst engine = createEngine({\n\t\t\t\tstore: kvCacheStore(payload.kv),\n\t\t\t\tqueue: { concurrency: 4 },\n\t\t\t\tttl: resolved.cache.ttl,\n\t\t\t\ttimeoutMs: resolved.cache.timeoutMs,\n\t\t\t\tonError: (err, adapterId) => {\n\t\t\t\t\tpayload.logger?.warn(`analytics: read failed for adapter \"${adapterId}\": ${String(err)}`)\n\t\t\t\t},\n\t\t\t})\n\t\t\tsetRuntime(payload, {\n\t\t\t\tregistry,\n\t\t\t\tresolveRegistry,\n\t\t\t\tresolveScope,\n\t\t\t\tresolveTimezone,\n\t\t\t\tplatformAdapterId: resolved.platformAdapter,\n\t\t\t\tcaptureSlots: resolved.capture.slots,\n\t\t\t\tcapturePaths: resolved.capture.paths,\n\t\t\t\tcaptureProxy: resolved.capture.proxy,\n\t\t\t\tconsentFor: resolved.capture.consent,\n\t\t\t\tautoCapture: resolved.capture.autoCapture,\n\t\t\t\tgoals: resolved.goals,\n\t\t\t\tresolveGoals: goalsResolver.resolve,\n\t\t\t\tresolveGoalsDetailed: goalsResolver.resolveDetailed,\n\t\t\t\t...(resolved.goalsCollection.enabled\n\t\t\t\t\t? { goalsCollectionSlug: resolved.goalsCollection.slug }\n\t\t\t\t\t: {}),\n\t\t\t\tingestPath: resolved.adapters.find((a) => a.ingest)?.ingest?.path,\n\t\t\t\ttrack: (event, opts) => trackServerEvent(payload, event, opts),\n\t\t\t\tscoped: resolved.scoped,\n\t\t\t\tconfigAdapterIds: new Set(resolved.adapters.map((a) => a.id)),\n\t\t\t\tplatformRead: resolved.access.platformRead,\n\t\t\t\treadAccess: resolved.access.read,\n\t\t\t\tbindings: resolved.bindings,\n\t\t\t\tengine,\n\t\t\t\tttl: resolved.cache.ttl,\n\t\t\t\tcomparison: resolved.widgets.comparison,\n\t\t\t})\n\t\t\tawait prevOnInit?.(payload)\n\t\t}\n\t\treturn config\n\t},\n})\n\nexport type {\n\tAnalyticsBinding,\n\tBindingContext,\n\tHostnameResolver,\n\tPathResolver,\n} from './binding/types'\nexport { PLATFORM_SCOPE } from './core/contract'\nexport type {\n\tAnalyticsAccessOptions,\n\tAnalyticsCaptureOptions,\n\tAnalyticsGoalsCollectionOptions,\n\tAnalyticsGoalsOptions,\n\tAnalyticsPluginOptions,\n\tAnalyticsPluginOptions as PluginOptions,\n\tAnalyticsReadAccess,\n\tAnalyticsViewAccess,\n\tAnalyticsViewOptions,\n\tAutoCaptureOptions,\n\tCaptureConsentOption,\n\tConsentMode,\n\tConsentResolver,\n\tPlatformReadAccess,\n\tProvidersCollectionOptions,\n\tProvidersOptions,\n\tProvidersResolve,\n\tScopeResolver,\n\tScopesResolver,\n\tTimezoneResolver,\n} from './core/options'\nexport type { ServerEventInput, ServerTrack, ServerTrackOptions } from './core/serverEvent'\nexport { AnalyticsTrackError } from './core/serverEvent'\nexport type {\n\tAnalyticsFieldsOptions,\n\tAnalyticsMetricLabel,\n\tAnalyticsMetricLabels,\n\tAnalyticsStatOptions,\n\tAnalyticsStatRowOptions,\n\tAnalyticsTabOptions,\n} from './fields/factories'\nexport {\n\tanalyticsFields,\n\tanalyticsStat,\n\tanalyticsStatRow,\n\tanalyticsTab,\n\tanalyticsTabsField,\n} from './fields/factories'\nexport type { GoalFieldOptions } from './goals/goalField'\nexport { goalField, goalSlug } from './goals/goalField'\nexport type { GoalsResponse, WireGoal } from './goals/goalsEndpoint'\nexport type {\n\tGoalActionDefinition,\n\tGoalActionRunArgs,\n\tTrackGoalActionOptions,\n} from './goals/trackGoalAction'\nexport { GOAL_ACTION_TYPE, trackGoalAction } from './goals/trackGoalAction'\nexport type { Goal, GoalMatch, TrackerGoal } from './goals/types'\nexport { trackServerEvent } from './native/ingest/serverTrack'\nexport type { QueryError, QueryErrorCode } from './query/errors'\nexport type {\n\tQueryErrorResponse,\n\tQueryResponse,\n\tQuerySourceRef,\n\tSerializedAnalyticsQuery,\n} from './query/response'\nexport type { TimeframePreset } from './timeframe/presets'\nexport type { CustomWidgetDef } from './widgets/customWidget'\nexport { analyticsDefaultWidgets } from './widgets/defaults'\nexport { widgetFilters } from './widgets/filterField'\nexport type { WidgetFilter } from './widgets/types'\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCA,MAAa,YAAY,aAAqC;CAC7D,MAAM;CACN,QAAQ,OAAO,EAAE,QAAQ,SAAS,UAAU,GAAG,cAA+B;EAC7E,IAAI,QAAQ,aAAa,MACxB,OAAO;EAER,MAAM,WAAW,eAAe,OAAO;EAIvC,MAAM,mBACL,SAAS,UAAU,WAAW,WAAW,QAAQ,SAAS,UAAU,OAAO;EAC5E,MAAM,gBAAgB,OAAO,OAAO,WAAW;EAC/C,qBAAqB,QAAQ,QAAQ,YAAY;EACjD,MAAM,WAAW,eAAe,SAAS,UAAU,SAAS,cAAc;EAC1E,MAAM,eAAe;GAAE,UAAU,SAAS;GAAU,WAAW,SAAS;EAAe;EACvF,IAAI,kBAAkB,uBAAuB,QAAQ;EACrD,IAAI,4BAA4B,CAAC;EACjC,MAAM,mBAAmB,SAAS,UAAU;EAC5C,IAAI,kBACH,kBAAkB,OAAO,SACxB,kBACC,cACA,MAAM,iBAAiB;GAAE,SAAS,KAAK;GAAS,KAAK,KAAK;GAAK,OAAO,KAAK;EAAM,CAAC,CACnF;OACK,IAAI,SAAS,UAAU,WAAW,SAAS;GACjD,MAAM,SAAS,6BAA6B;IAC3C,MAAM;IACN,QAAQ,0BACP,SAAS,UAAU,WAAW,MAC9B,SAAS,UAAU,WAAW,UAC/B;GACD,CAAC;GACD,kBAAkB,OAAO;GACzB,sBAAsB,OAAO;EAC9B;EACA,MAAM,eAAe,OAAO,QAAwB,SAAS,cAAc,EAAE,IAAI,CAAC;EAClF,IAAI,SAAS,UAAU,WAAW,SAAS;GAC1C,MAAM,EAAE,gBAAgB,8BAA8B,MAAM,OAC3D,+BACC,OAAO,QAAiB;IACzB,IAAI,sBAAsB,GAAG,GAC5B,MAAM,IAAI,MACT,2GACD;IAED,MAAM;GACP,CAAC;GACD,MAAM,aAAa,SAAS,UAAU,WAAW;GACjD,MAAM,eAAiC,WACtC,eAAe,QAAQ;IACtB,YAAY;IACZ,UAAU;IACV,GAAI,OAAO,SAAS,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,IAAI,CAAC;IACxD,GAAI,YAAY,OAAO,EAAE,MAAM,WAAW,KAAK,IAAI,CAAC;GACrD,CAAC;GACF,MAAM,sBAAsB,yBAAyB;IACpD,MAAM,SAAS,UAAU,WAAW;IACpC,QAAQ,SAAS,UAAU,WAAW;IACtC,WAAW,SAAS,UAAU,WAAW;IACzC,gBAAgB,oBAAoB;IACpC,QAAQ,SAAS;IACjB,YAAY,SAAS,UAAU,WAAW;IAC1C;IACA,cAAc,SAAS,OAAO;IAC9B;GACD,CAAC;GAOD,OAAO,cAAc,CACpB,GAAI,OAAO,eAAe,CAAC,GAC3B,0BAA0B,mBAAmB,CAC9C;EACD;EAGA,MAAM,gBAAgB,SAAS,gBAAgB,UAC5C,oBAAoB;GACpB,MAAM,SAAS,gBAAgB;GAC/B,YAAY,SAAS,gBAAgB;GACrC,QAAQ,SAAS;GACjB,QAAQ,SAAS;EAClB,CAAC,IACA,oBAAoB,SAAS,KAAK;EACrC,IAAI,SAAS,gBAAgB,SAC5B,OAAO,cAAc,CACpB,GAAI,OAAO,eAAe,CAAC,GAC3B,qBAAqB;GACpB,MAAM,SAAS,gBAAgB;GAC/B,QAAQ,SAAS,gBAAgB;GACjC,WAAW,SAAS,gBAAgB;GACpC,gBAAgB,cAAc,WAAW;GACzC,QAAQ,SAAS;GACjB,YAAY,SAAS,gBAAgB;GACrC;GACA,cAAc,SAAS,OAAO;EAC/B,CAAC,CACF;EAED,MAAM,kBAAkB,OAAO,KAAqB,UAA2C;GAC9F,MAAM,MAAM,SAAS;GACrB,IAAI,QAAQ,KAAA,GACX,OAAA;GAED,IAAI;IACH,MAAM,KACL,OAAO,QAAQ,WACZ,MACA,MAAM,IAAI;KAAE;KAAK,OAAO,UAAU,KAAA,IAAY,QAAQ,MAAM,aAAa,GAAG;IAAE,CAAC;IACnF,OAAO,MAAM,gBAAgB,EAAE,IAAI,KAAA;GACpC,SAAS,KAAK;IACb,IAAI,SAAS,QAAQ,OACpB,wEAAwE,OAAO,GAAG,GACnF;IACA,OAAA;GACD;EACD;EACA,KAAK,MAAM,WAAW,SAAS,UAC9B,QAAQ,WAAW,QAAQ;GAC1B,QAAQ,SAAS;GACjB;GACA;GACA,cAAc,cAAc;EAC7B,CAAC;EAEF,IACC,SAAS,SAAS,MAAM,MAAM,EAAE,aAAa,YAAY,OAAO,EAAE,aAAa,UAAU,KACzF,kBAEA,OAAO,YAAY,CAClB,GAAI,OAAO,aAAa,CAAC,GACzB;GAAE,QAAQ;GAAO,MAAM;GAAe,SAAS,oBAAoB;EAAE,CACtE;EAED,IAAI,OAAO,KAAK,SAAS,QAAQ,EAAE,SAAS,GAC3C,OAAO,YAAY,CAClB,GAAI,OAAO,aAAa,CAAC,GACzB;GAAE,QAAQ;GAAO,MAAM;GAAe,SAAS,oBAAoB;EAAE,CACtE;EAED,OAAO,YAAY;GAClB,GAAI,OAAO,aAAa,CAAC;GACzB;IAAE,QAAQ;IAAO,MAAM;IAAc,SAAS,mBAAmB;GAAE;GACnE;IAAE,QAAQ;IAAO,MAAM;IAAY,SAAS,iBAAiB;GAAE;GAC/D;IAAE,QAAQ;IAAO,MAAM;IAAY,SAAS,iBAAiB;GAAE;EAChE;EAGA,IAAI,SAAS,SAAS,MAAM,MAAM,EAAE,OAAO,KAAK,kBAC/C,OAAO,YAAY;GAAC,GAAG,OAAO;GAAW,GAAG,eAAe;GAAG,gBAAgB;EAAC;EAEhF,IAAI,SAAS,QAAQ,SAAS;GAC7B,MAAM,gBAAgB,SAAS,gBAAgB,KAAK;GACpD,gBAAgB,QAAQ;IACvB,UAAU,SAAS;IACnB;IACA;IACA,UAAU,SAAS,QAAQ;IAC3B,UAAU,SAAS,QAAQ;IAC3B,cAAc,SAAS,QAAQ;IAC/B,WAAW,SAAS;IACpB,YAAY,SAAS,QAAQ;IAC7B,MACC,SAAS,SAAS,QACf,QACA;KACA,MAAM,SAAS,KAAK;KACpB,cAAc,SAAS,KAAK;KAC5B,eAAe,SAAS,KAAK;IAC9B;GACJ,CAAC;EACF;EACA,aAAa,QAAQ;GAAE,MAAM,SAAS;GAAM,eAAe;EAAQ,CAAC;EACpE,IAAI,SAAS,MAAM,KAAK,SACvB,OAAO,OAAO;GACb,GAAG,OAAO;GACV,OAAO,CACN,GAAI,OAAO,MAAM,SAAS,CAAC,GAC3B,SAAS,SAAS,MAAM,KAAK,MAAM,eAAe,SAAS,MAAM,CAClE;EACD;EAED,IAAI,SAAS,KAAK,SAAS;GAC1B,OAAO,cAAc,CACpB,GAAI,OAAO,eAAe,CAAC,GAC3B,eAAe,SAAS,KAAK,gBAAgB,SAAS,KAAK,QAAQ;IAClE,QAAQ,SAAS;IACjB,YAAY;IACZ;IACA,cAAc,SAAS,OAAO;GAC/B,CAAC,CACF;GACA,OAAO,OAAO;IACb,GAAG,OAAO;IACV,OAAO,CACN,GAAI,OAAO,MAAM,SAAS,CAAC,GAC3B,SAAS;KACR,MAAM,SAAS,KAAK;KACpB,cAAc,SAAS,KAAK;KAC5B,gBAAgB,SAAS,KAAK;KAC9B,YAAY,SAAS,KAAK;KAC1B,QAAQ,SAAS;IAClB,CAAC,CACF;GACD;EACD;EACA,MAAM,aAAa,OAAO;EAG1B,OAAO,SAAS,OAAO,YAAY;GAGlC,IAAI,SAAS,UAAU,SAAS,gBAAgB,SAC/C,mBAAmB,SAAS;IAC3B,QAAQ;IACR,MAAM,SAAS,gBAAgB;IAC/B,YAAY,SAAS,gBAAgB;GACtC,CAAC;GAEF,IAAI,SAAS,UAAU,SAAS,UAAU,WAAW,SACpD,mBAAmB,SAAS;IAC3B,QAAQ;IACR,MAAM,SAAS,UAAU,WAAW;IACpC,YAAY,SAAS,UAAU,WAAW;GAC3C,CAAC;GAEF,IAAI,SAAS,UAAU,WAAW,SAAS;IAC1C,MAAM,EAAE,0BAA0B,MAAM,OAAO;IAC/C,MAAM,sBAAsB,SAAS,SAAS,UAAU,WAAW,YAAY,IAAI;GACpF;GACA,MAAM,SAAS,aAAa;IAC3B,OAAO,aAAa,QAAQ,EAAE;IAC9B,OAAO,EAAE,aAAa,EAAE;IACxB,KAAK,SAAS,MAAM;IACpB,WAAW,SAAS,MAAM;IAC1B,UAAU,KAAK,cAAc;KAC5B,QAAQ,QAAQ,KAAK,uCAAuC,UAAU,KAAK,OAAO,GAAG,GAAG;IACzF;GACD,CAAC;GACD,WAAW,SAAS;IACnB;IACA;IACA;IACA;IACA,mBAAmB,SAAS;IAC5B,cAAc,SAAS,QAAQ;IAC/B,cAAc,SAAS,QAAQ;IAC/B,cAAc,SAAS,QAAQ;IAC/B,YAAY,SAAS,QAAQ;IAC7B,aAAa,SAAS,QAAQ;IAC9B,OAAO,SAAS;IAChB,cAAc,cAAc;IAC5B,sBAAsB,cAAc;IACpC,GAAI,SAAS,gBAAgB,UAC1B,EAAE,qBAAqB,SAAS,gBAAgB,KAAK,IACrD,CAAC;IACJ,YAAY,SAAS,SAAS,MAAM,MAAM,EAAE,MAAM,GAAG,QAAQ;IAC7D,QAAQ,OAAO,SAAS,iBAAiB,SAAS,OAAO,IAAI;IAC7D,QAAQ,SAAS;IACjB,kBAAkB,IAAI,IAAI,SAAS,SAAS,KAAK,MAAM,EAAE,EAAE,CAAC;IAC5D,cAAc,SAAS,OAAO;IAC9B,YAAY,SAAS,OAAO;IAC5B,UAAU,SAAS;IACnB;IACA,KAAK,SAAS,MAAM;IACpB,YAAY,SAAS,QAAQ;GAC9B,CAAC;GACD,MAAM,aAAa,OAAO;EAC3B;EACA,OAAO;CACR;AACD,CAAC"}
|
|
@@ -51,14 +51,46 @@ const eventsCollection = (scoped = false) => ({
|
|
|
51
51
|
name: "referrer",
|
|
52
52
|
type: "text"
|
|
53
53
|
},
|
|
54
|
+
{
|
|
55
|
+
name: "referrerHost",
|
|
56
|
+
type: "text"
|
|
57
|
+
},
|
|
54
58
|
{
|
|
55
59
|
name: "device",
|
|
56
60
|
type: "text"
|
|
57
61
|
},
|
|
62
|
+
{
|
|
63
|
+
name: "browser",
|
|
64
|
+
type: "text"
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
name: "os",
|
|
68
|
+
type: "text"
|
|
69
|
+
},
|
|
58
70
|
{
|
|
59
71
|
name: "source",
|
|
60
72
|
type: "text"
|
|
61
73
|
},
|
|
74
|
+
{
|
|
75
|
+
name: "utmSource",
|
|
76
|
+
type: "text"
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
name: "utmMedium",
|
|
80
|
+
type: "text"
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
name: "utmCampaign",
|
|
84
|
+
type: "text"
|
|
85
|
+
},
|
|
86
|
+
{
|
|
87
|
+
name: "utmContent",
|
|
88
|
+
type: "text"
|
|
89
|
+
},
|
|
90
|
+
{
|
|
91
|
+
name: "utmTerm",
|
|
92
|
+
type: "text"
|
|
93
|
+
},
|
|
62
94
|
{
|
|
63
95
|
name: "country",
|
|
64
96
|
type: "text"
|
|
@@ -71,6 +103,10 @@ const eventsCollection = (scoped = false) => ({
|
|
|
71
103
|
name: "city",
|
|
72
104
|
type: "text"
|
|
73
105
|
},
|
|
106
|
+
{
|
|
107
|
+
name: "language",
|
|
108
|
+
type: "text"
|
|
109
|
+
},
|
|
74
110
|
{
|
|
75
111
|
name: "visitorHash",
|
|
76
112
|
type: "text",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"events.js","names":[],"sources":["../../../src/native/collections/events.ts"],"sourcesContent":["import type { CollectionConfig, Field } from 'payload'\n\nexport const EVENTS_SLUG = 'analytics-events'\n\n/**\n * The scope column exists only for scoped installs (a configured scopeResolver);\n * enabling scope on an existing native install therefore needs a migration adding\n * the column to events and rollups.\n */\nexport const eventsCollection = (scoped = false): CollectionConfig => ({\n\tslug: EVENTS_SLUG,\n\tadmin: { hidden: true },\n\taccess: { read: () => false, create: () => true, update: () => false, delete: () => false },\n\tfields: [\n\t\t{ name: 'timestamp', type: 'date', required: true, index: true },\n\t\t{\n\t\t\tname: 'type',\n\t\t\ttype: 'select',\n\t\t\trequired: true,\n\t\t\toptions: ['pageview', 'event', 'goal'],\n\t\t\tindex: true,\n\t\t},\n\t\t{ name: 'name', type: 'text' },\n\t\t{ name: 'path', type: 'text', required: true, index: true },\n\t\t{ name: 'hostname', type: 'text', required: true },\n\t\t{ name: 'referrer', type: 'text' },\n\t\t{ name: 'device', type: 'text' },\n\t\t{ name: 'source', type: 'text' },\n\t\t{ name: 'country', type: 'text' },\n\t\t{ name: 'region', type: 'text' },\n\t\t{ name: 'city', type: 'text' },\n\t\t{ name: 'visitorHash', type: 'text', required: true, index: true },\n\t\t{ name: 'sessionId', type: 'text', required: true, index: true },\n\t\t{ name: 'durationMs', type: 'number' },\n\t\t{ name: 'props', type: 'json' },\n\t\t{ name: 'value', type: 'number' },\n\t\t{ name: 'currency', type: 'text' },\n\t\t{ name: 'scrollDepth', type: 'number' },\n\t\t// The completions matched at ingest, so a raw-event read (filtered or hourly) reports\n\t\t// the same conversions the rollups hold instead of re-matching against goals that may\n\t\t// since have changed.\n\t\t{ name: 'goals', type: 'json' },\n\t\t...(scoped ? [{ name: 'scope', type: 'text', index: true } satisfies Field] : []),\n\t],\n\tindexes: [{ fields: ['path', 'timestamp'] }, { fields: ['type', 'timestamp'] }],\n})\n"],"mappings":";AAEA,MAAa,cAAc;;;;;;AAO3B,MAAa,oBAAoB,SAAS,WAA6B;CACtE,MAAM;CACN,OAAO,EAAE,QAAQ,KAAK;CACtB,QAAQ;EAAE,YAAY;EAAO,cAAc;EAAM,cAAc;EAAO,cAAc;CAAM;CAC1F,QAAQ;EACP;GAAE,MAAM;GAAa,MAAM;GAAQ,UAAU;GAAM,OAAO;EAAK;EAC/D;GACC,MAAM;GACN,MAAM;GACN,UAAU;GACV,SAAS;IAAC;IAAY;IAAS;GAAM;GACrC,OAAO;EACR;EACA;GAAE,MAAM;GAAQ,MAAM;EAAO;EAC7B;GAAE,MAAM;GAAQ,MAAM;GAAQ,UAAU;GAAM,OAAO;EAAK;EAC1D;GAAE,MAAM;GAAY,MAAM;GAAQ,UAAU;EAAK;EACjD;GAAE,MAAM;GAAY,MAAM;EAAO;
|
|
1
|
+
{"version":3,"file":"events.js","names":[],"sources":["../../../src/native/collections/events.ts"],"sourcesContent":["import type { CollectionConfig, Field } from 'payload'\n\nexport const EVENTS_SLUG = 'analytics-events'\n\n/**\n * The scope column exists only for scoped installs (a configured scopeResolver);\n * enabling scope on an existing native install therefore needs a migration adding\n * the column to events and rollups.\n */\nexport const eventsCollection = (scoped = false): CollectionConfig => ({\n\tslug: EVENTS_SLUG,\n\tadmin: { hidden: true },\n\taccess: { read: () => false, create: () => true, update: () => false, delete: () => false },\n\tfields: [\n\t\t{ name: 'timestamp', type: 'date', required: true, index: true },\n\t\t{\n\t\t\tname: 'type',\n\t\t\ttype: 'select',\n\t\t\trequired: true,\n\t\t\toptions: ['pageview', 'event', 'goal'],\n\t\t\tindex: true,\n\t\t},\n\t\t{ name: 'name', type: 'text' },\n\t\t{ name: 'path', type: 'text', required: true, index: true },\n\t\t{ name: 'hostname', type: 'text', required: true },\n\t\t{ name: 'referrer', type: 'text' },\n\t\t// Derived from the referrer at ingest: the `referrer` dimension groups and filters on the\n\t\t// bare host, which a read-time `where` could not compute.\n\t\t{ name: 'referrerHost', type: 'text' },\n\t\t{ name: 'device', type: 'text' },\n\t\t{ name: 'browser', type: 'text' },\n\t\t{ name: 'os', type: 'text' },\n\t\t{ name: 'source', type: 'text' },\n\t\t// Extracted from the pageview's query string at ingest; the raw query is never stored.\n\t\t{ name: 'utmSource', type: 'text' },\n\t\t{ name: 'utmMedium', type: 'text' },\n\t\t{ name: 'utmCampaign', type: 'text' },\n\t\t{ name: 'utmContent', type: 'text' },\n\t\t{ name: 'utmTerm', type: 'text' },\n\t\t{ name: 'country', type: 'text' },\n\t\t{ name: 'region', type: 'text' },\n\t\t{ name: 'city', type: 'text' },\n\t\t{ name: 'language', type: 'text' },\n\t\t{ name: 'visitorHash', type: 'text', required: true, index: true },\n\t\t{ name: 'sessionId', type: 'text', required: true, index: true },\n\t\t{ name: 'durationMs', type: 'number' },\n\t\t{ name: 'props', type: 'json' },\n\t\t{ name: 'value', type: 'number' },\n\t\t{ name: 'currency', type: 'text' },\n\t\t{ name: 'scrollDepth', type: 'number' },\n\t\t// The completions matched at ingest, so a raw-event read (filtered or hourly) reports\n\t\t// the same conversions the rollups hold instead of re-matching against goals that may\n\t\t// since have changed.\n\t\t{ name: 'goals', type: 'json' },\n\t\t...(scoped ? [{ name: 'scope', type: 'text', index: true } satisfies Field] : []),\n\t],\n\tindexes: [{ fields: ['path', 'timestamp'] }, { fields: ['type', 'timestamp'] }],\n})\n"],"mappings":";AAEA,MAAa,cAAc;;;;;;AAO3B,MAAa,oBAAoB,SAAS,WAA6B;CACtE,MAAM;CACN,OAAO,EAAE,QAAQ,KAAK;CACtB,QAAQ;EAAE,YAAY;EAAO,cAAc;EAAM,cAAc;EAAO,cAAc;CAAM;CAC1F,QAAQ;EACP;GAAE,MAAM;GAAa,MAAM;GAAQ,UAAU;GAAM,OAAO;EAAK;EAC/D;GACC,MAAM;GACN,MAAM;GACN,UAAU;GACV,SAAS;IAAC;IAAY;IAAS;GAAM;GACrC,OAAO;EACR;EACA;GAAE,MAAM;GAAQ,MAAM;EAAO;EAC7B;GAAE,MAAM;GAAQ,MAAM;GAAQ,UAAU;GAAM,OAAO;EAAK;EAC1D;GAAE,MAAM;GAAY,MAAM;GAAQ,UAAU;EAAK;EACjD;GAAE,MAAM;GAAY,MAAM;EAAO;EAGjC;GAAE,MAAM;GAAgB,MAAM;EAAO;EACrC;GAAE,MAAM;GAAU,MAAM;EAAO;EAC/B;GAAE,MAAM;GAAW,MAAM;EAAO;EAChC;GAAE,MAAM;GAAM,MAAM;EAAO;EAC3B;GAAE,MAAM;GAAU,MAAM;EAAO;EAE/B;GAAE,MAAM;GAAa,MAAM;EAAO;EAClC;GAAE,MAAM;GAAa,MAAM;EAAO;EAClC;GAAE,MAAM;GAAe,MAAM;EAAO;EACpC;GAAE,MAAM;GAAc,MAAM;EAAO;EACnC;GAAE,MAAM;GAAW,MAAM;EAAO;EAChC;GAAE,MAAM;GAAW,MAAM;EAAO;EAChC;GAAE,MAAM;GAAU,MAAM;EAAO;EAC/B;GAAE,MAAM;GAAQ,MAAM;EAAO;EAC7B;GAAE,MAAM;GAAY,MAAM;EAAO;EACjC;GAAE,MAAM;GAAe,MAAM;GAAQ,UAAU;GAAM,OAAO;EAAK;EACjE;GAAE,MAAM;GAAa,MAAM;GAAQ,UAAU;GAAM,OAAO;EAAK;EAC/D;GAAE,MAAM;GAAc,MAAM;EAAS;EACrC;GAAE,MAAM;GAAS,MAAM;EAAO;EAC9B;GAAE,MAAM;GAAS,MAAM;EAAS;EAChC;GAAE,MAAM;GAAY,MAAM;EAAO;EACjC;GAAE,MAAM;GAAe,MAAM;EAAS;EAItC;GAAE,MAAM;GAAS,MAAM;EAAO;EAC9B,GAAI,SAAS,CAAC;GAAE,MAAM;GAAS,MAAM;GAAQ,OAAO;EAAK,CAAiB,IAAI,CAAC;CAChF;CACA,SAAS,CAAC,EAAE,QAAQ,CAAC,QAAQ,WAAW,EAAE,GAAG,EAAE,QAAQ,CAAC,QAAQ,WAAW,EAAE,CAAC;AAC/E"}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
//#region src/native/eventScan.ts
|
|
2
|
+
/**
|
|
3
|
+
* Hard cap on how many raw events a single read scans. Reads that cannot use the day
|
|
4
|
+
* bucketed rollups (filtered, hour granularity, realtime) walk events newest-first under
|
|
5
|
+
* this cap, so a very busy site keeps its most recent activity rather than its oldest.
|
|
6
|
+
*/
|
|
7
|
+
const EVENT_SCAN_LIMIT = 5e4;
|
|
8
|
+
/**
|
|
9
|
+
* Meta for a read that aggregated raw events under the scan cap. A scan that came back
|
|
10
|
+
* full almost certainly left events behind, so its numbers are a floor rather than a
|
|
11
|
+
* count and `sampled` tells every surface to say so.
|
|
12
|
+
*/
|
|
13
|
+
const eventScanMeta = (args) => {
|
|
14
|
+
const meta = {
|
|
15
|
+
provider: "native",
|
|
16
|
+
fetchedAt: args.fetchedAt
|
|
17
|
+
};
|
|
18
|
+
if (args.clamped) meta.clamped = true;
|
|
19
|
+
if (args.eventCount >= (args.limit ?? 5e4)) meta.sampled = true;
|
|
20
|
+
return meta;
|
|
21
|
+
};
|
|
22
|
+
//#endregion
|
|
23
|
+
export { EVENT_SCAN_LIMIT, eventScanMeta };
|
|
24
|
+
|
|
25
|
+
//# sourceMappingURL=eventScan.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"eventScan.js","names":[],"sources":["../../src/native/eventScan.ts"],"sourcesContent":["import type { AnalyticsResult } from '../core/contract'\n\n/**\n * Hard cap on how many raw events a single read scans. Reads that cannot use the day\n * bucketed rollups (filtered, hour granularity, realtime) walk events newest-first under\n * this cap, so a very busy site keeps its most recent activity rather than its oldest.\n */\nexport const EVENT_SCAN_LIMIT = 50_000\n\nexport interface EventScanMetaArgs {\n\tfetchedAt: string\n\t/** How many events the capped scan came back with. */\n\teventCount: number\n\tclamped?: boolean\n\tlimit?: number\n}\n\n/**\n * Meta for a read that aggregated raw events under the scan cap. A scan that came back\n * full almost certainly left events behind, so its numbers are a floor rather than a\n * count and `sampled` tells every surface to say so.\n */\nexport const eventScanMeta = (args: EventScanMetaArgs): AnalyticsResult['meta'] => {\n\tconst meta: AnalyticsResult['meta'] = { provider: 'native', fetchedAt: args.fetchedAt }\n\tif (args.clamped) {\n\t\tmeta.clamped = true\n\t}\n\tif (args.eventCount >= (args.limit ?? EVENT_SCAN_LIMIT)) {\n\t\tmeta.sampled = true\n\t}\n\treturn meta\n}\n"],"mappings":";;;;;;AAOA,MAAa,mBAAmB;;;;;;AAehC,MAAa,iBAAiB,SAAqD;CAClF,MAAM,OAAgC;EAAE,UAAU;EAAU,WAAW,KAAK;CAAU;CACtF,IAAI,KAAK,SACR,KAAK,UAAU;CAEhB,IAAI,KAAK,eAAe,KAAK,SAAA,MAC5B,KAAK,UAAU;CAEhB,OAAO;AACR"}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import "./device.js";
|
|
2
|
+
//#region src/native/ingest/browser.ts
|
|
3
|
+
/**
|
|
4
|
+
* Order is the whole algorithm: every Chromium fork still calls itself Chrome, and every iOS
|
|
5
|
+
* browser still calls itself Safari, so the fork has to be recognized before the engine it
|
|
6
|
+
* borrowed the token from.
|
|
7
|
+
*/
|
|
8
|
+
const BROWSERS = [
|
|
9
|
+
[/edg(?:a|ios|e)?\//, "edge"],
|
|
10
|
+
[/\bopr\/|\bopt\/|\bopera\b/, "opera"],
|
|
11
|
+
[/samsungbrowser/, "samsung"],
|
|
12
|
+
[/firefox\/|fxios\//, "firefox"],
|
|
13
|
+
[/chrome\/|crios\/|chromium\//, "chrome"],
|
|
14
|
+
[/safari\//, "safari"]
|
|
15
|
+
];
|
|
16
|
+
/**
|
|
17
|
+
* `CrOS` and `Android` both sit inside an `X11`/`Linux` UA, so they are matched ahead of it.
|
|
18
|
+
* `cros` needs its word boundaries: it is also a substring of `Microsoft`.
|
|
19
|
+
*/
|
|
20
|
+
const PLATFORMS = [
|
|
21
|
+
[/iphone|ipad|ipod/, "ios"],
|
|
22
|
+
[/android/, "android"],
|
|
23
|
+
[/\bcros\b/, "chromeos"],
|
|
24
|
+
[/windows|win64|win32/, "windows"],
|
|
25
|
+
[/macintosh|mac os x/, "macos"],
|
|
26
|
+
[/linux|x11/, "linux"]
|
|
27
|
+
];
|
|
28
|
+
const lookup = (table, ua, fallback) => {
|
|
29
|
+
if (ua === "analytics-server") return;
|
|
30
|
+
const s = ua.toLowerCase();
|
|
31
|
+
return table.find(([pattern]) => pattern.test(s))?.[1] ?? fallback;
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* Coarse browser family from a user-agent string, `other` for anything unrecognized (a bot,
|
|
35
|
+
* a crawler, an HTTP client), and undefined when the agent is the synthetic server one so
|
|
36
|
+
* server events abstain from the browser breakdown rather than skewing it.
|
|
37
|
+
*/
|
|
38
|
+
const classifyBrowser = (ua) => lookup(BROWSERS, ua, "other");
|
|
39
|
+
/**
|
|
40
|
+
* Operating system from a user-agent's platform tokens, on the same terms as
|
|
41
|
+
* `classifyBrowser`: `other` when nothing matches, undefined for the server agent.
|
|
42
|
+
*/
|
|
43
|
+
const classifyOs = (ua) => lookup(PLATFORMS, ua, "other");
|
|
44
|
+
//#endregion
|
|
45
|
+
export { classifyBrowser, classifyOs };
|
|
46
|
+
|
|
47
|
+
//# sourceMappingURL=browser.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"browser.js","names":[],"sources":["../../../src/native/ingest/browser.ts"],"sourcesContent":["import { SERVER_USER_AGENT } from './device'\n\nexport type BrowserName = 'chrome' | 'safari' | 'firefox' | 'edge' | 'opera' | 'samsung' | 'other'\n\nexport type OsName = 'ios' | 'android' | 'windows' | 'macos' | 'linux' | 'chromeos' | 'other'\n\n/**\n * Order is the whole algorithm: every Chromium fork still calls itself Chrome, and every iOS\n * browser still calls itself Safari, so the fork has to be recognized before the engine it\n * borrowed the token from.\n */\nconst BROWSERS: ReadonlyArray<[RegExp, BrowserName]> = [\n\t[/edg(?:a|ios|e)?\\//, 'edge'],\n\t[/\\bopr\\/|\\bopt\\/|\\bopera\\b/, 'opera'],\n\t[/samsungbrowser/, 'samsung'],\n\t[/firefox\\/|fxios\\//, 'firefox'],\n\t[/chrome\\/|crios\\/|chromium\\//, 'chrome'],\n\t[/safari\\//, 'safari'],\n]\n\n/**\n * `CrOS` and `Android` both sit inside an `X11`/`Linux` UA, so they are matched ahead of it.\n * `cros` needs its word boundaries: it is also a substring of `Microsoft`.\n */\nconst PLATFORMS: ReadonlyArray<[RegExp, OsName]> = [\n\t[/iphone|ipad|ipod/, 'ios'],\n\t[/android/, 'android'],\n\t[/\\bcros\\b/, 'chromeos'],\n\t[/windows|win64|win32/, 'windows'],\n\t[/macintosh|mac os x/, 'macos'],\n\t[/linux|x11/, 'linux'],\n]\n\nconst lookup = <T>(table: ReadonlyArray<[RegExp, T]>, ua: string, fallback: T): T | undefined => {\n\tif (ua === SERVER_USER_AGENT) {\n\t\treturn undefined\n\t}\n\tconst s = ua.toLowerCase()\n\treturn table.find(([pattern]) => pattern.test(s))?.[1] ?? fallback\n}\n\n/**\n * Coarse browser family from a user-agent string, `other` for anything unrecognized (a bot,\n * a crawler, an HTTP client), and undefined when the agent is the synthetic server one so\n * server events abstain from the browser breakdown rather than skewing it.\n */\nexport const classifyBrowser = (ua: string): BrowserName | undefined =>\n\tlookup(BROWSERS, ua, 'other')\n\n/**\n * Operating system from a user-agent's platform tokens, on the same terms as\n * `classifyBrowser`: `other` when nothing matches, undefined for the server agent.\n */\nexport const classifyOs = (ua: string): OsName | undefined => lookup(PLATFORMS, ua, 'other')\n"],"mappings":";;;;;;;AAWA,MAAM,WAAiD;CACtD,CAAC,qBAAqB,MAAM;CAC5B,CAAC,6BAA6B,OAAO;CACrC,CAAC,kBAAkB,SAAS;CAC5B,CAAC,qBAAqB,SAAS;CAC/B,CAAC,+BAA+B,QAAQ;CACxC,CAAC,YAAY,QAAQ;AACtB;;;;;AAMA,MAAM,YAA6C;CAClD,CAAC,oBAAoB,KAAK;CAC1B,CAAC,WAAW,SAAS;CACrB,CAAC,YAAY,UAAU;CACvB,CAAC,uBAAuB,SAAS;CACjC,CAAC,sBAAsB,OAAO;CAC9B,CAAC,aAAa,OAAO;AACtB;AAEA,MAAM,UAAa,OAAmC,IAAY,aAA+B;CAChG,IAAI,OAAA,oBACH;CAED,MAAM,IAAI,GAAG,YAAY;CACzB,OAAO,MAAM,MAAM,CAAC,aAAa,QAAQ,KAAK,CAAC,CAAC,IAAI,MAAM;AAC3D;;;;;;AAOA,MAAa,mBAAmB,OAC/B,OAAO,UAAU,IAAI,OAAO;;;;;AAM7B,MAAa,cAAc,OAAmC,OAAO,WAAW,IAAI,OAAO"}
|
|
@@ -1,15 +1,23 @@
|
|
|
1
1
|
//#region src/native/ingest/device.ts
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
4
|
-
*
|
|
3
|
+
* The user agent server-side tracking stamps when the event has no browser request behind
|
|
4
|
+
* it. There is no device to report, so events carrying it abstain from the device breakdown
|
|
5
|
+
* rather than piling into `desktop` and skewing it.
|
|
6
|
+
*/
|
|
7
|
+
const SERVER_USER_AGENT = "analytics-server";
|
|
8
|
+
/**
|
|
9
|
+
* Coarse device class from a user-agent string, or undefined when the agent is not a device
|
|
10
|
+
* at all. Tablets are checked before phones because an Android tablet UA lacks the `Mobile`
|
|
11
|
+
* token an Android phone carries.
|
|
5
12
|
*/
|
|
6
13
|
const classifyDevice = (ua) => {
|
|
14
|
+
if (ua === "analytics-server") return;
|
|
7
15
|
const s = ua.toLowerCase();
|
|
8
16
|
if (/ipad|tablet|playbook|silk|kindle/.test(s) || /android/.test(s) && !/mobi/.test(s)) return "tablet";
|
|
9
17
|
if (/mobi|iphone|ipod|android|blackberry|iemobile|opera mini|windows phone/.test(s)) return "mobile";
|
|
10
18
|
return "desktop";
|
|
11
19
|
};
|
|
12
20
|
//#endregion
|
|
13
|
-
export { classifyDevice };
|
|
21
|
+
export { SERVER_USER_AGENT, classifyDevice };
|
|
14
22
|
|
|
15
23
|
//# sourceMappingURL=device.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"device.js","names":[],"sources":["../../../src/native/ingest/device.ts"],"sourcesContent":["export type DeviceType = 'desktop' | 'mobile' | 'tablet'\n\n/**\n * Coarse device class from a user-agent string. Tablets are checked before phones
|
|
1
|
+
{"version":3,"file":"device.js","names":[],"sources":["../../../src/native/ingest/device.ts"],"sourcesContent":["export type DeviceType = 'desktop' | 'mobile' | 'tablet'\n\n/**\n * The user agent server-side tracking stamps when the event has no browser request behind\n * it. There is no device to report, so events carrying it abstain from the device breakdown\n * rather than piling into `desktop` and skewing it.\n */\nexport const SERVER_USER_AGENT = 'analytics-server'\n\n/**\n * Coarse device class from a user-agent string, or undefined when the agent is not a device\n * at all. Tablets are checked before phones because an Android tablet UA lacks the `Mobile`\n * token an Android phone carries.\n */\nexport const classifyDevice = (ua: string): DeviceType | undefined => {\n\tif (ua === SERVER_USER_AGENT) {\n\t\treturn undefined\n\t}\n\tconst s = ua.toLowerCase()\n\tif (/ipad|tablet|playbook|silk|kindle/.test(s) || (/android/.test(s) && !/mobi/.test(s))) {\n\t\treturn 'tablet'\n\t}\n\tif (/mobi|iphone|ipod|android|blackberry|iemobile|opera mini|windows phone/.test(s)) {\n\t\treturn 'mobile'\n\t}\n\treturn 'desktop'\n}\n"],"mappings":";;;;;;AAOA,MAAa,oBAAoB;;;;;;AAOjC,MAAa,kBAAkB,OAAuC;CACrE,IAAI,OAAA,oBACH;CAED,MAAM,IAAI,GAAG,YAAY;CACzB,IAAI,mCAAmC,KAAK,CAAC,KAAM,UAAU,KAAK,CAAC,KAAK,CAAC,OAAO,KAAK,CAAC,GACrF,OAAO;CAER,IAAI,wEAAwE,KAAK,CAAC,GACjF,OAAO;CAER,OAAO;AACR"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import { PayloadRequest } from "payload";
|
|
@@ -2,12 +2,8 @@ import { readCappedBody } from "../../capture/requestBody.js";
|
|
|
2
2
|
import { flushBatch } from "./flushBatch.js";
|
|
3
3
|
import { normalizeEvent } from "./normalizeEvent.js";
|
|
4
4
|
import { dailySalt } from "./salt.js";
|
|
5
|
+
import { validateRawEvent } from "./validate.js";
|
|
5
6
|
//#region src/native/ingest/endpoint.ts
|
|
6
|
-
const TYPES = new Set([
|
|
7
|
-
"pageview",
|
|
8
|
-
"event",
|
|
9
|
-
"goal"
|
|
10
|
-
]);
|
|
11
7
|
/** One event, not a session replay: far above any legitimate payload, far below a DoS. */
|
|
12
8
|
const MAX_INGEST_BODY_BYTES = 64 * 1024;
|
|
13
9
|
/**
|
|
@@ -23,23 +19,12 @@ const parseBody = (bytes) => {
|
|
|
23
19
|
return;
|
|
24
20
|
}
|
|
25
21
|
};
|
|
26
|
-
/**
|
|
27
|
-
* An event is rejected only on its required fields: a known `type`, a `path`, a `hostname`,
|
|
28
|
-
* and a `name` (the event name, or the goal slug on a `goal`) for everything but a pageview.
|
|
29
|
-
* Optional fields are sanitized in `normalizeEvent` and dropped when malformed, so one bad
|
|
30
|
-
* attribute costs an attribute rather than the whole event.
|
|
31
|
-
*/
|
|
32
|
-
const nonEmptyString = (value) => typeof value === "string" && value.length > 0;
|
|
33
|
-
const isValid = (raw) => {
|
|
34
|
-
if (!raw || !TYPES.has(raw.type) || !nonEmptyString(raw.path) || !nonEmptyString(raw.hostname)) return false;
|
|
35
|
-
return raw.type === "pageview" || nonEmptyString(raw.name);
|
|
36
|
-
};
|
|
37
22
|
const makeIngestHandler = (geoResolver, getBuffer = () => null, resolvers = {}) => async (req) => {
|
|
38
23
|
const { scope: resolveScope, timezone: resolveTimezone, goals: resolveGoals } = resolvers;
|
|
39
24
|
const read = await readCappedBody(req, MAX_INGEST_BODY_BYTES);
|
|
40
25
|
if (!read.ok) return Response.json({ error: read.reason === "too-large" ? "payload too large" : "invalid payload" }, { status: read.reason === "too-large" ? 413 : 400 });
|
|
41
26
|
const raw = parseBody(read.body);
|
|
42
|
-
if (!
|
|
27
|
+
if (!validateRawEvent(raw)) return Response.json({ error: "invalid payload" }, { status: 400 });
|
|
43
28
|
const now = /* @__PURE__ */ new Date();
|
|
44
29
|
const salt = await dailySalt(req.payload, now);
|
|
45
30
|
const scope = resolveScope ? await resolveScope(req) ?? "" : void 0;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"endpoint.js","names":[],"sources":["../../../src/native/ingest/endpoint.ts"],"sourcesContent":["import type { PayloadHandler, PayloadRequest } from 'payload'\nimport { readCappedBody } from '../../capture/requestBody'\nimport type { Goal } from '../../goals/types'\nimport type { GeoResolver } from '../geo/geoResolver'\nimport { flushBatch } from './flushBatch'\nimport {
|
|
1
|
+
{"version":3,"file":"endpoint.js","names":[],"sources":["../../../src/native/ingest/endpoint.ts"],"sourcesContent":["import type { PayloadHandler, PayloadRequest } from 'payload'\nimport { readCappedBody } from '../../capture/requestBody'\nimport type { Goal } from '../../goals/types'\nimport type { GeoResolver } from '../geo/geoResolver'\nimport { flushBatch } from './flushBatch'\nimport { normalizeEvent, type RawEventInput, type StoredEvent } from './normalizeEvent'\nimport { dailySalt } from './salt'\nimport { validateRawEvent } from './validate'\nimport type { WriteBuffer } from './writeBuffer'\n\nexport interface IngestResolvers {\n\tscope?: (req: PayloadRequest) => Promise<string | null>\n\ttimezone?: (req: PayloadRequest, scope?: string | null) => Promise<string>\n\tgoals?: (req: PayloadRequest, scope?: string | null) => Promise<Goal[]>\n}\n\n/** One event, not a session replay: far above any legitimate payload, far below a DoS. */\nexport const MAX_INGEST_BODY_BYTES = 64 * 1024\n\n/**\n * Parses the buffered body, answering undefined for anything the validator could not judge:\n * a garbage POST is a 400 like any other bad payload rather than a thrown parse error that\n * escapes into Payload's routeError as a logged 500.\n */\nconst parseBody = (bytes: ArrayBuffer): RawEventInput | undefined => {\n\ttry {\n\t\tconst parsed: unknown = JSON.parse(new TextDecoder().decode(bytes))\n\t\treturn typeof parsed === 'object' && parsed !== null ? (parsed as RawEventInput) : undefined\n\t} catch {\n\t\treturn undefined\n\t}\n}\n\nexport const makeIngestHandler =\n\t(\n\t\tgeoResolver: GeoResolver,\n\t\tgetBuffer: () => WriteBuffer<StoredEvent> | null = () => null,\n\t\tresolvers: IngestResolvers = {}\n\t): PayloadHandler =>\n\tasync (req) => {\n\t\tconst { scope: resolveScope, timezone: resolveTimezone, goals: resolveGoals } = resolvers\n\t\t// Read like the capture proxy does, and for the same reasons: this is a public,\n\t\t// unauthenticated path, so the body is capped before it is buffered and a body that\n\t\t// dies in transit (a beacon from an unloading tab) answers 400 rather than throwing.\n\t\tconst read = await readCappedBody(req, MAX_INGEST_BODY_BYTES)\n\t\tif (!read.ok) {\n\t\t\treturn Response.json(\n\t\t\t\t{ error: read.reason === 'too-large' ? 'payload too large' : 'invalid payload' },\n\t\t\t\t{ status: read.reason === 'too-large' ? 413 : 400 }\n\t\t\t)\n\t\t}\n\t\tconst raw = parseBody(read.body)\n\t\tif (!validateRawEvent(raw)) {\n\t\t\treturn Response.json({ error: 'invalid payload' }, { status: 400 })\n\t\t}\n\t\tconst now = new Date()\n\t\tconst salt = await dailySalt(req.payload, now)\n\t\tconst scope = resolveScope ? ((await resolveScope(req)) ?? '') : undefined\n\t\tconst timezone = resolveTimezone ? await resolveTimezone(req, scope ?? null) : undefined\n\t\t// Goals resolve under the same scope the event is stamped with, so a tenant's event\n\t\t// can only ever complete that tenant's goals.\n\t\tconst goals = resolveGoals ? await resolveGoals(req, scope ?? null) : undefined\n\t\tconst event = await normalizeEvent({\n\t\t\traw,\n\t\t\theaders: req.headers,\n\t\t\tgeoResolver,\n\t\t\tsalt,\n\t\t\tnow,\n\t\t\tscope,\n\t\t\ttimezone,\n\t\t\tgoals,\n\t\t})\n\t\tconst buffer = getBuffer()\n\t\tif (buffer) {\n\t\t\tbuffer.add(event)\n\t\t} else {\n\t\t\tawait flushBatch(req.payload, [event])\n\t\t}\n\t\treturn Response.json({ ok: true }, { status: 202 })\n\t}\n"],"mappings":";;;;;;;AAiBA,MAAa,wBAAwB,KAAK;;;;;;AAO1C,MAAM,aAAa,UAAkD;CACpE,IAAI;EACH,MAAM,SAAkB,KAAK,MAAM,IAAI,YAAY,EAAE,OAAO,KAAK,CAAC;EAClE,OAAO,OAAO,WAAW,YAAY,WAAW,OAAQ,SAA2B,KAAA;CACpF,QAAQ;EACP;CACD;AACD;AAEA,MAAa,qBAEX,aACA,kBAAyD,MACzD,YAA6B,CAAC,MAE/B,OAAO,QAAQ;CACd,MAAM,EAAE,OAAO,cAAc,UAAU,iBAAiB,OAAO,iBAAiB;CAIhF,MAAM,OAAO,MAAM,eAAe,KAAK,qBAAqB;CAC5D,IAAI,CAAC,KAAK,IACT,OAAO,SAAS,KACf,EAAE,OAAO,KAAK,WAAW,cAAc,sBAAsB,kBAAkB,GAC/E,EAAE,QAAQ,KAAK,WAAW,cAAc,MAAM,IAAI,CACnD;CAED,MAAM,MAAM,UAAU,KAAK,IAAI;CAC/B,IAAI,CAAC,iBAAiB,GAAG,GACxB,OAAO,SAAS,KAAK,EAAE,OAAO,kBAAkB,GAAG,EAAE,QAAQ,IAAI,CAAC;CAEnE,MAAM,sBAAM,IAAI,KAAK;CACrB,MAAM,OAAO,MAAM,UAAU,IAAI,SAAS,GAAG;CAC7C,MAAM,QAAQ,eAAiB,MAAM,aAAa,GAAG,KAAM,KAAM,KAAA;CACjE,MAAM,WAAW,kBAAkB,MAAM,gBAAgB,KAAK,SAAS,IAAI,IAAI,KAAA;CAG/E,MAAM,QAAQ,eAAe,MAAM,aAAa,KAAK,SAAS,IAAI,IAAI,KAAA;CACtE,MAAM,QAAQ,MAAM,eAAe;EAClC;EACA,SAAS,IAAI;EACb;EACA;EACA;EACA;EACA;EACA;CACD,CAAC;CACD,MAAM,SAAS,UAAU;CACzB,IAAI,QACH,OAAO,IAAI,KAAK;MAEhB,MAAM,WAAW,IAAI,SAAS,CAAC,KAAK,CAAC;CAEtC,OAAO,SAAS,KAAK,EAAE,IAAI,KAAK,GAAG,EAAE,QAAQ,IAAI,CAAC;AACnD"}
|