@10x-media/analytics 0.1.0-beta.5 → 1.0.0-beta.11
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 +277 -0
- package/README.md +15 -4
- package/dist/adapters/ga4/disableKey.d.ts +9 -0
- package/dist/adapters/ga4/disableKey.js +21 -0
- package/dist/adapters/ga4/disableKey.js.map +1 -0
- package/dist/adapters/ga4/eventName.d.ts +15 -0
- package/dist/adapters/ga4/eventName.js +19 -0
- package/dist/adapters/ga4/eventName.js.map +1 -0
- package/dist/adapters/ga4/ga4.d.ts +5 -0
- package/dist/adapters/ga4/ga4.js +186 -58
- package/dist/adapters/ga4/ga4.js.map +1 -1
- package/dist/adapters/ga4/measurementId.js +15 -0
- package/dist/adapters/ga4/measurementId.js.map +1 -0
- package/dist/adapters/goalRead.js +126 -0
- package/dist/adapters/goalRead.js.map +1 -0
- package/dist/adapters/http/fetchJson.js +1 -1
- package/dist/adapters/plausible/plausible.d.ts +25 -0
- package/dist/adapters/plausible/plausible.js +159 -38
- package/dist/adapters/plausible/plausible.js.map +1 -1
- package/dist/adapters/posthog/posthog.d.ts +10 -1
- package/dist/adapters/posthog/posthog.js +130 -21
- package/dist/adapters/posthog/posthog.js.map +1 -1
- package/dist/adapters/series.js +11 -1
- package/dist/adapters/series.js.map +1 -1
- package/dist/adapters/umami/umami.d.ts +13 -1
- package/dist/adapters/umami/umami.js +278 -26
- package/dist/adapters/umami/umami.js.map +1 -1
- package/dist/binding/resolvePath.js +18 -2
- package/dist/binding/resolvePath.js.map +1 -1
- package/dist/capture/getTrackerConfig.d.ts +20 -0
- package/dist/capture/getTrackerConfig.js +31 -0
- package/dist/capture/getTrackerConfig.js.map +1 -0
- package/dist/capture/mountPath.js +14 -0
- package/dist/capture/mountPath.js.map +1 -0
- package/dist/capture/proxyEndpoint.js +127 -0
- package/dist/capture/proxyEndpoint.js.map +1 -0
- package/dist/capture/proxyRoutes.js +108 -0
- package/dist/capture/proxyRoutes.js.map +1 -0
- package/dist/capture/requestBody.js +68 -0
- package/dist/capture/requestBody.js.map +1 -0
- package/dist/capture/slots.d.ts +8 -0
- package/dist/capture/slots.js +54 -0
- package/dist/capture/slots.js.map +1 -0
- package/dist/capture/trackerConfig.d.ts +33 -0
- package/dist/capture/trackerConfig.js +95 -0
- package/dist/capture/trackerConfig.js.map +1 -0
- package/dist/capture/trackerEndpoint.js +35 -0
- package/dist/capture/trackerEndpoint.js.map +1 -0
- package/dist/charts/BarList.d.ts +16 -1
- package/dist/charts/BarList.js +41 -19
- package/dist/charts/BarList.js.map +1 -1
- package/dist/charts/TrendChart.d.ts +16 -3
- package/dist/charts/TrendChart.js +172 -106
- package/dist/charts/TrendChart.js.map +1 -1
- package/dist/charts/bars.d.ts +4 -0
- package/dist/charts/bars.js +3 -1
- package/dist/charts/bars.js.map +1 -1
- package/dist/charts/bucket.js +10 -1
- package/dist/charts/bucket.js.map +1 -1
- package/dist/charts/spline.js +2 -2
- package/dist/charts/spline.js.map +1 -1
- package/dist/charts/styles.js +18 -1
- package/dist/charts/styles.js.map +1 -1
- package/dist/core/cacheKey.js +26 -3
- package/dist/core/cacheKey.js.map +1 -1
- package/dist/core/capabilities.d.ts +5 -1
- package/dist/core/capabilities.js +11 -2
- package/dist/core/capabilities.js.map +1 -1
- package/dist/core/capture.d.ts +49 -0
- package/dist/core/contract.d.ts +74 -5
- package/dist/core/contract.js +30 -1
- package/dist/core/contract.js.map +1 -1
- package/dist/core/granularity.js +1 -1
- package/dist/core/options.d.ts +164 -6
- package/dist/core/options.js +126 -3
- package/dist/core/options.js.map +1 -1
- package/dist/core/registry.d.ts +1 -0
- package/dist/core/scopeList.js +32 -0
- package/dist/core/scopeList.js.map +1 -0
- package/dist/core/scopedRead.js +101 -30
- package/dist/core/scopedRead.js.map +1 -1
- package/dist/core/serverEvent.d.ts +60 -0
- package/dist/core/serverEvent.js +12 -0
- package/dist/core/serverEvent.js.map +1 -0
- package/dist/exports/adapters/ga4.d.ts +2 -1
- package/dist/exports/adapters/ga4.js +2 -1
- package/dist/exports/adapters/native.d.ts +3 -1
- package/dist/exports/adapters/native.js +2 -1
- package/dist/exports/client.d.ts +13 -3
- package/dist/exports/client.js +10 -1
- package/dist/exports/geo.d.ts +2 -2
- package/dist/exports/next.d.ts +2 -1
- package/dist/exports/next.js +2 -1
- package/dist/exports/react.d.ts +4 -0
- package/dist/exports/react.js +5 -0
- package/dist/exports/rsc.d.ts +11 -3
- package/dist/exports/rsc.js +7 -2
- package/dist/exports/tracker.d.ts +21 -0
- package/dist/exports/tracker.js +15 -0
- package/dist/exports/types.d.ts +16 -3
- package/dist/exports/types.js +4 -2
- package/dist/fields/AnalyticsPanelClient.js +2 -2
- package/dist/fields/AnalyticsPanelField.js +1 -1
- package/dist/fields/AnalyticsStatField.js +2 -2
- package/dist/fields/config/FilterDimensionSelectField.d.ts +14 -0
- package/dist/fields/config/FilterDimensionSelectField.js +77 -0
- package/dist/fields/config/FilterDimensionSelectField.js.map +1 -0
- package/dist/fields/config/FilterOperatorSelectField.d.ts +14 -0
- package/dist/fields/config/FilterOperatorSelectField.js +75 -0
- package/dist/fields/config/FilterOperatorSelectField.js.map +1 -0
- package/dist/fields/config/MetricSelectField.js +3 -3
- package/dist/fields/config/MetricSelectField.js.map +1 -1
- package/dist/fields/config/SourceSelectField.js +3 -3
- package/dist/fields/config/SourceSelectField.js.map +1 -1
- package/dist/fields/config/fetchSources.d.ts +5 -1
- package/dist/fields/config/fetchSources.js +7 -3
- package/dist/fields/config/fetchSources.js.map +1 -1
- package/dist/fields/config/narrow.js +2 -0
- package/dist/fields/config/narrow.js.map +1 -1
- package/dist/fields/config/sourcesState.js +19 -3
- package/dist/fields/config/sourcesState.js.map +1 -1
- package/dist/fields/config/useAnalyticsSources.d.ts +8 -3
- package/dist/fields/config/useAnalyticsSources.js +9 -6
- package/dist/fields/config/useAnalyticsSources.js.map +1 -1
- package/dist/fields/config/useFilterCapabilities.d.ts +28 -0
- package/dist/fields/config/useFilterCapabilities.js +52 -0
- package/dist/fields/config/useFilterCapabilities.js.map +1 -0
- package/dist/fields/readForDocument.d.ts +5 -0
- package/dist/fields/readForDocument.js +22 -10
- package/dist/fields/readForDocument.js.map +1 -1
- package/dist/goals/GoalSelectField.d.ts +7 -0
- package/dist/goals/GoalSelectField.js +77 -0
- package/dist/goals/GoalSelectField.js.map +1 -0
- package/dist/goals/collection.js +254 -0
- package/dist/goals/collection.js.map +1 -0
- package/dist/goals/currency.js +14 -0
- package/dist/goals/currency.js.map +1 -0
- package/dist/goals/fetchGoals.d.ts +18 -0
- package/dist/goals/fetchGoals.js +33 -0
- package/dist/goals/fetchGoals.js.map +1 -0
- package/dist/goals/goalField.d.ts +31 -0
- package/dist/goals/goalField.js +56 -0
- package/dist/goals/goalField.js.map +1 -0
- package/dist/goals/goalsEndpoint.d.ts +1 -0
- package/dist/goals/goalsEndpoint.js +58 -0
- package/dist/goals/goalsEndpoint.js.map +1 -0
- package/dist/goals/match.js +64 -0
- package/dist/goals/match.js.map +1 -0
- package/dist/goals/resolver.d.ts +8 -0
- package/dist/goals/resolver.js +147 -0
- package/dist/goals/resolver.js.map +1 -0
- package/dist/goals/trackGoalAction.d.ts +76 -0
- package/dist/goals/trackGoalAction.js +158 -0
- package/dist/goals/trackGoalAction.js.map +1 -0
- package/dist/goals/types.d.ts +33 -0
- package/dist/goals/types.js +7 -0
- package/dist/goals/types.js.map +1 -0
- package/dist/goals/useAnalyticsGoals.d.ts +20 -0
- package/dist/goals/useAnalyticsGoals.js +67 -0
- package/dist/goals/useAnalyticsGoals.js.map +1 -0
- package/dist/index.d.ts +14 -3
- package/dist/index.js +174 -19
- package/dist/index.js.map +1 -1
- package/dist/native/collections/events.js +65 -1
- package/dist/native/collections/events.js.map +1 -1
- package/dist/native/collections/rollups.js +39 -3
- package/dist/native/collections/rollups.js.map +1 -1
- package/dist/native/eventScan.js +25 -0
- package/dist/native/eventScan.js.map +1 -0
- package/dist/native/geo/composeGeoResolvers.js +2 -2
- package/dist/native/geo/composeGeoResolvers.js.map +1 -1
- package/dist/native/geo/geoResolver.d.ts +9 -2
- package/dist/native/geo/geoResolver.js.map +1 -1
- package/dist/native/geo/maxmindResolver.js +3 -5
- package/dist/native/geo/maxmindResolver.js.map +1 -1
- package/dist/native/ingest/bots.d.ts +11 -0
- package/dist/native/ingest/bots.js +71 -0
- package/dist/native/ingest/bots.js.map +1 -0
- package/dist/native/ingest/browser.js +47 -0
- package/dist/native/ingest/browser.js.map +1 -0
- package/dist/native/ingest/clientIp.js +20 -0
- package/dist/native/ingest/clientIp.js.map +1 -0
- package/dist/native/ingest/device.js +11 -3
- package/dist/native/ingest/device.js.map +1 -1
- package/dist/native/ingest/endpoint.d.ts +1 -0
- package/dist/native/ingest/endpoint.js +107 -21
- package/dist/native/ingest/endpoint.js.map +1 -1
- package/dist/native/ingest/flushBatch.js +29 -38
- package/dist/native/ingest/flushBatch.js.map +1 -1
- package/dist/native/ingest/language.js +14 -0
- package/dist/native/ingest/language.js.map +1 -0
- package/dist/native/ingest/normalizeEvent.d.ts +30 -0
- package/dist/native/ingest/normalizeEvent.js +115 -16
- package/dist/native/ingest/normalizeEvent.js.map +1 -1
- package/dist/native/ingest/referrer.js +48 -0
- package/dist/native/ingest/referrer.js.map +1 -0
- package/dist/native/ingest/requestHost.js +57 -0
- package/dist/native/ingest/requestHost.js.map +1 -0
- package/dist/native/ingest/resolveHostname.d.ts +29 -0
- package/dist/native/ingest/resolveHostname.js +52 -0
- package/dist/native/ingest/resolveHostname.js.map +1 -0
- package/dist/native/ingest/salt.js +27 -2
- package/dist/native/ingest/salt.js.map +1 -1
- package/dist/native/ingest/serverTrack.d.ts +20 -0
- package/dist/native/ingest/serverTrack.js +109 -0
- package/dist/native/ingest/serverTrack.js.map +1 -0
- package/dist/native/ingest/source.d.ts +11 -0
- package/dist/native/ingest/source.js +264 -16
- package/dist/native/ingest/source.js.map +1 -1
- package/dist/native/ingest/utm.js +33 -0
- package/dist/native/ingest/utm.js.map +1 -0
- package/dist/native/ingest/validate.js +26 -0
- package/dist/native/ingest/validate.js.map +1 -0
- package/dist/native/nativeAdapter.d.ts +37 -1
- package/dist/native/nativeAdapter.js +175 -22
- package/dist/native/nativeAdapter.js.map +1 -1
- package/dist/native/query/eventAgg.js +175 -0
- package/dist/native/query/eventAgg.js.map +1 -0
- package/dist/native/retention/pruneTask.js +53 -13
- package/dist/native/retention/pruneTask.js.map +1 -1
- package/dist/native/rollupAcc.js +12 -1
- package/dist/native/rollupAcc.js.map +1 -1
- package/dist/native/rollups/bucketKey.js +15 -0
- package/dist/native/rollups/bucketKey.js.map +1 -0
- package/dist/native/rollups/bumpRollups.js +116 -0
- package/dist/native/rollups/bumpRollups.js.map +1 -0
- package/dist/native/rollups/deltas.js +86 -11
- package/dist/native/rollups/deltas.js.map +1 -1
- package/dist/native/rollups/insertManyIfNew.js +93 -0
- package/dist/native/rollups/insertManyIfNew.js.map +1 -0
- package/dist/next/captureRewrites.d.ts +42 -0
- package/dist/next/captureRewrites.js +57 -0
- package/dist/next/captureRewrites.js.map +1 -0
- package/dist/next/posthogProxyRewrites.d.ts +5 -0
- package/dist/next/posthogProxyRewrites.js +16 -21
- package/dist/next/posthogProxyRewrites.js.map +1 -1
- package/dist/plugin/documentEndpoint.js +71 -24
- package/dist/plugin/documentEndpoint.js.map +1 -1
- package/dist/plugin/errors.d.ts +31 -0
- package/dist/plugin/errors.js +79 -0
- package/dist/plugin/errors.js.map +1 -0
- package/dist/plugin/goalHint.d.ts +1 -0
- package/dist/plugin/goalHint.js +24 -0
- package/dist/plugin/goalHint.js.map +1 -0
- package/dist/plugin/paths.js +17 -1
- package/dist/plugin/paths.js.map +1 -1
- package/dist/plugin/queryEndpoint.js +124 -0
- package/dist/plugin/queryEndpoint.js.map +1 -0
- package/dist/plugin/readContextForRequest.js +73 -0
- package/dist/plugin/readContextForRequest.js.map +1 -0
- package/dist/plugin/realtimeEndpoint.js +37 -16
- package/dist/plugin/realtimeEndpoint.js.map +1 -1
- package/dist/plugin/refreshEndpoint.js +113 -0
- package/dist/plugin/refreshEndpoint.js.map +1 -0
- package/dist/plugin/runtime.d.ts +1 -0
- package/dist/plugin/runtime.js +33 -1
- package/dist/plugin/runtime.js.map +1 -1
- package/dist/plugin/scopeChange.js +22 -0
- package/dist/plugin/scopeChange.js.map +1 -0
- package/dist/plugin/scopeFieldBoot.js +22 -0
- package/dist/plugin/scopeFieldBoot.js.map +1 -0
- package/dist/plugin/sourcesEndpoint.js +16 -41
- package/dist/plugin/sourcesEndpoint.js.map +1 -1
- package/dist/plugin/warmTask.js +0 -0
- package/dist/plugin/warmTask.js.map +1 -1
- package/dist/providers/collection.js +89 -29
- package/dist/providers/collection.js.map +1 -1
- package/dist/providers/factory.js +11 -3
- package/dist/providers/factory.js.map +1 -1
- package/dist/providers/resolver.js.map +1 -1
- package/dist/query/dates.js +64 -0
- package/dist/query/dates.js.map +1 -0
- package/dist/query/errors.d.ts +14 -0
- package/dist/query/fetchQuery.d.ts +79 -0
- package/dist/query/fetchQuery.js +117 -0
- package/dist/query/fetchQuery.js.map +1 -0
- package/dist/query/parse.d.ts +22 -0
- package/dist/query/parse.js +168 -0
- package/dist/query/parse.js.map +1 -0
- package/dist/query/response.d.ts +39 -0
- package/dist/query/response.js +11 -0
- package/dist/query/response.js.map +1 -0
- package/dist/react/AnalyticsProvider.d.ts +50 -0
- package/dist/react/AnalyticsProvider.js +67 -0
- package/dist/react/AnalyticsProvider.js.map +1 -0
- package/dist/react/TrackerBoot.d.ts +22 -0
- package/dist/react/TrackerBoot.js +30 -0
- package/dist/react/TrackerBoot.js.map +1 -0
- package/dist/react/useAnalytics.d.ts +20 -0
- package/dist/react/useAnalytics.js +52 -0
- package/dist/react/useAnalytics.js.map +1 -0
- package/dist/rsc/AnalyticsScripts.d.ts +30 -0
- package/dist/rsc/AnalyticsScripts.js +41 -0
- package/dist/rsc/AnalyticsScripts.js.map +1 -0
- package/dist/surfacing/cacheStore.d.ts +1 -0
- package/dist/surfacing/cacheStore.js +18 -2
- package/dist/surfacing/cacheStore.js.map +1 -1
- package/dist/surfacing/engine.d.ts +1 -0
- package/dist/surfacing/engine.js +47 -6
- package/dist/surfacing/engine.js.map +1 -1
- package/dist/surfacing/epoch.d.ts +1 -0
- package/dist/surfacing/epoch.js +72 -0
- package/dist/surfacing/epoch.js.map +1 -0
- package/dist/surfacing/queue.js +22 -6
- package/dist/surfacing/queue.js.map +1 -1
- package/dist/surfacing/rateLimiter.js +130 -0
- package/dist/surfacing/rateLimiter.js.map +1 -0
- package/dist/surfacing/retryPolicy.js +15 -0
- package/dist/surfacing/retryPolicy.js.map +1 -0
- package/dist/sync/collection.js +23 -7
- package/dist/sync/collection.js.map +1 -1
- package/dist/sync/syncTask.js +68 -33
- package/dist/sync/syncTask.js.map +1 -1
- package/dist/testing/memoryAdapter.d.ts +2 -0
- package/dist/testing/memoryAdapter.js +17 -1
- package/dist/testing/memoryAdapter.js.map +1 -1
- package/dist/timeframe/tz.js +17 -6
- package/dist/timeframe/tz.js.map +1 -1
- package/dist/tracker/autoCapture.d.ts +48 -0
- package/dist/tracker/autoCapture.js +129 -0
- package/dist/tracker/autoCapture.js.map +1 -0
- package/dist/tracker/consent.d.ts +24 -0
- package/dist/tracker/consent.js +48 -0
- package/dist/tracker/consent.js.map +1 -0
- package/dist/tracker/createTracker.d.ts +18 -0
- package/dist/tracker/createTracker.js +215 -0
- package/dist/tracker/createTracker.js.map +1 -0
- package/dist/tracker/exclusion.d.ts +28 -0
- package/dist/tracker/exclusion.js +50 -0
- package/dist/tracker/exclusion.js.map +1 -0
- package/dist/tracker/initTracker.d.ts +22 -0
- package/dist/tracker/initTracker.js +33 -0
- package/dist/tracker/initTracker.js.map +1 -0
- package/dist/tracker/loadScript.d.ts +14 -0
- package/dist/tracker/loadScript.js +41 -0
- package/dist/tracker/loadScript.js.map +1 -0
- package/dist/tracker/pageTracking.d.ts +17 -0
- package/dist/tracker/pageTracking.js +38 -0
- package/dist/tracker/pageTracking.js.map +1 -0
- package/dist/tracker/registry.d.ts +27 -0
- package/dist/tracker/registry.js +73 -0
- package/dist/tracker/registry.js.map +1 -0
- package/dist/tracker/sinks/ga4.d.ts +29 -0
- package/dist/tracker/sinks/ga4.js +30 -0
- package/dist/tracker/sinks/ga4.js.map +1 -0
- package/dist/tracker/sinks/native.d.ts +22 -0
- package/dist/tracker/sinks/native.js +56 -0
- package/dist/tracker/sinks/native.js.map +1 -0
- package/dist/tracker/sinks/plausible.d.ts +20 -0
- package/dist/tracker/sinks/plausible.js +32 -0
- package/dist/tracker/sinks/plausible.js.map +1 -0
- package/dist/tracker/sinks/posthog.d.ts +18 -0
- package/dist/tracker/sinks/posthog.js +30 -0
- package/dist/tracker/sinks/posthog.js.map +1 -0
- package/dist/tracker/sinks/umami.d.ts +18 -0
- package/dist/tracker/sinks/umami.js +23 -0
- package/dist/tracker/sinks/umami.js.map +1 -0
- package/dist/tracker/sinks/vendor.d.ts +14 -0
- package/dist/tracker/sinks/vendor.js +81 -0
- package/dist/tracker/sinks/vendor.js.map +1 -0
- package/dist/tracker/transport.js +28 -0
- package/dist/tracker/transport.js.map +1 -0
- package/dist/tracker/types.d.ts +91 -0
- package/dist/translations/ar.js +221 -0
- package/dist/translations/ar.js.map +1 -0
- package/dist/translations/de.js +145 -1
- package/dist/translations/de.js.map +1 -1
- package/dist/translations/en.js +145 -1
- package/dist/translations/en.js.map +1 -1
- package/dist/translations/es.js +221 -0
- package/dist/translations/es.js.map +1 -0
- package/dist/translations/fr.js +221 -0
- package/dist/translations/fr.js.map +1 -0
- package/dist/translations/id.js +221 -0
- package/dist/translations/id.js.map +1 -0
- package/dist/translations/index.d.ts +10 -1
- package/dist/translations/index.js +19 -1
- package/dist/translations/index.js.map +1 -1
- package/dist/translations/keys.d.ts +144 -0
- package/dist/translations/keys.js +145 -1
- package/dist/translations/keys.js.map +1 -1
- package/dist/translations/ko.js +221 -0
- package/dist/translations/ko.js.map +1 -0
- package/dist/translations/metricKeys.js +8 -2
- package/dist/translations/metricKeys.js.map +1 -1
- package/dist/translations/pt.js +221 -0
- package/dist/translations/pt.js.map +1 -0
- package/dist/translations/ru.js +221 -0
- package/dist/translations/ru.js.map +1 -0
- package/dist/translations/server.js.map +1 -1
- package/dist/translations/uk.js +221 -0
- package/dist/translations/uk.js.map +1 -0
- package/dist/translations/zh.js +221 -0
- package/dist/translations/zh.js.map +1 -0
- package/dist/view/AnalyticsNavLink.d.ts +19 -0
- package/dist/view/AnalyticsNavLink.js +40 -0
- package/dist/view/AnalyticsNavLink.js.map +1 -0
- package/dist/view/AnalyticsView.d.ts +23 -0
- package/dist/view/AnalyticsView.js +45 -0
- package/dist/view/AnalyticsView.js.map +1 -0
- package/dist/view/AnalyticsViewClient.d.ts +15 -0
- package/dist/view/AnalyticsViewClient.js +244 -0
- package/dist/view/AnalyticsViewClient.js.map +1 -0
- package/dist/view/authRedirect.js +32 -0
- package/dist/view/authRedirect.js.map +1 -0
- package/dist/view/conversionRate.js +18 -0
- package/dist/view/conversionRate.js.map +1 -0
- package/dist/view/dayRange.js +68 -0
- package/dist/view/dayRange.js.map +1 -0
- package/dist/view/gating.d.ts +1 -0
- package/dist/view/gating.js +142 -0
- package/dist/view/gating.js.map +1 -0
- package/dist/view/labels.js +76 -0
- package/dist/view/labels.js.map +1 -0
- package/dist/view/registerView.js +48 -0
- package/dist/view/registerView.js.map +1 -0
- package/dist/view/sections/Breakdowns.js +198 -0
- package/dist/view/sections/Breakdowns.js.map +1 -0
- package/dist/view/sections/EmptyStates.js +92 -0
- package/dist/view/sections/EmptyStates.js.map +1 -0
- package/dist/view/sections/FilterChips.js +46 -0
- package/dist/view/sections/FilterChips.js.map +1 -0
- package/dist/view/sections/GoalsPanel.js +82 -0
- package/dist/view/sections/GoalsPanel.js.map +1 -0
- package/dist/view/sections/OverviewCards.js +65 -0
- package/dist/view/sections/OverviewCards.js.map +1 -0
- package/dist/view/sections/RealtimeStrip.js +80 -0
- package/dist/view/sections/RealtimeStrip.js.map +1 -0
- package/dist/view/sections/Toolbar.js +207 -0
- package/dist/view/sections/Toolbar.js.map +1 -0
- package/dist/view/sections/Trend.js +125 -0
- package/dist/view/sections/Trend.js.map +1 -0
- package/dist/view/sections/styles.js +76 -0
- package/dist/view/sections/styles.js.map +1 -0
- package/dist/view/state.js +211 -0
- package/dist/view/state.js.map +1 -0
- package/dist/view/useViewQueries.js +153 -0
- package/dist/view/useViewQueries.js.map +1 -0
- package/dist/view/viewProps.d.ts +40 -0
- package/dist/view/viewProps.js +90 -0
- package/dist/view/viewProps.js.map +1 -0
- package/dist/widgets/AnalyticsBreakdownWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsBreakdownWidget.js +78 -11
- package/dist/widgets/AnalyticsBreakdownWidget.js.map +1 -1
- package/dist/widgets/AnalyticsGoalsWidget.d.ts +14 -0
- package/dist/widgets/AnalyticsGoalsWidget.js +196 -0
- package/dist/widgets/AnalyticsGoalsWidget.js.map +1 -0
- package/dist/widgets/AnalyticsMetricWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsMetricWidget.js +63 -13
- package/dist/widgets/AnalyticsMetricWidget.js.map +1 -1
- package/dist/widgets/AnalyticsRealtimeWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsRealtimeWidget.js +44 -22
- package/dist/widgets/AnalyticsRealtimeWidget.js.map +1 -1
- package/dist/widgets/AnalyticsTrendWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsTrendWidget.js +79 -16
- package/dist/widgets/AnalyticsTrendWidget.js.map +1 -1
- package/dist/widgets/RealtimeCounter.d.ts +4 -0
- package/dist/widgets/RealtimeCounter.js +18 -4
- package/dist/widgets/RealtimeCounter.js.map +1 -1
- package/dist/widgets/WidgetViewLink.js +17 -0
- package/dist/widgets/WidgetViewLink.js.map +1 -0
- package/dist/widgets/breakdownTypes.js +38 -0
- package/dist/widgets/breakdownTypes.js.map +1 -1
- package/dist/widgets/cardChrome.js +31 -7
- package/dist/widgets/cardChrome.js.map +1 -1
- package/dist/widgets/comparison.js +15 -1
- package/dist/widgets/comparison.js.map +1 -1
- package/dist/widgets/defaults.d.ts +6 -2
- package/dist/widgets/defaults.js +78 -23
- package/dist/widgets/defaults.js.map +1 -1
- package/dist/widgets/filterCaption.js +27 -0
- package/dist/widgets/filterCaption.js.map +1 -0
- package/dist/widgets/filterField.d.ts +19 -0
- package/dist/widgets/filterField.js +75 -0
- package/dist/widgets/filterField.js.map +1 -0
- package/dist/widgets/prepareWidgetRead.d.ts +7 -0
- package/dist/widgets/prepareWidgetRead.js +74 -0
- package/dist/widgets/prepareWidgetRead.js.map +1 -0
- package/dist/widgets/range.js +43 -12
- package/dist/widgets/range.js.map +1 -1
- package/dist/widgets/readForWidget.d.ts +26 -3
- package/dist/widgets/readForWidget.js +48 -44
- package/dist/widgets/readForWidget.js.map +1 -1
- package/dist/widgets/readForWidgetBreakdown.d.ts +34 -2
- package/dist/widgets/readForWidgetBreakdown.js +53 -49
- package/dist/widgets/readForWidgetBreakdown.js.map +1 -1
- package/dist/widgets/readForWidgetGoals.d.ts +67 -0
- package/dist/widgets/readForWidgetGoals.js +140 -0
- package/dist/widgets/readForWidgetGoals.js.map +1 -0
- package/dist/widgets/readForWidgetRealtime.d.ts +8 -0
- package/dist/widgets/readForWidgetRealtime.js +23 -21
- package/dist/widgets/readForWidgetRealtime.js.map +1 -1
- package/dist/widgets/readForWidgetSeries.d.ts +26 -2
- package/dist/widgets/readForWidgetSeries.js +78 -53
- package/dist/widgets/readForWidgetSeries.js.map +1 -1
- package/dist/widgets/readMeta.js +18 -0
- package/dist/widgets/readMeta.js.map +1 -0
- package/dist/widgets/realtimePoll.js +13 -1
- package/dist/widgets/realtimePoll.js.map +1 -1
- package/dist/widgets/registerWidgets.js +62 -10
- package/dist/widgets/registerWidgets.js.map +1 -1
- package/dist/widgets/types.d.ts +15 -0
- package/dist/widgets/types.js +16 -2
- package/dist/widgets/types.js.map +1 -1
- package/dist/widgets/viewLink.d.ts +22 -0
- package/dist/widgets/viewLink.js +86 -0
- package/dist/widgets/viewLink.js.map +1 -0
- package/package.json +27 -7
- package/dist/native/rollups/applyDistinctDeltas.js +0 -9
- package/dist/native/rollups/applyDistinctDeltas.js.map +0 -1
- package/dist/native/rollups/bumpRollup.js +0 -68
- package/dist/native/rollups/bumpRollup.js.map +0 -1
- package/dist/native/rollups/insertIfNew.js +0 -19
- package/dist/native/rollups/insertIfNew.js.map +0 -1
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
import { AnalyticsFilter, DimensionKey, Granularity, MetricKey } from "../core/contract.js";
|
|
2
|
+
import { QueryError } from "./errors.js";
|
|
3
|
+
import { QueryResponse } from "./response.js";
|
|
4
|
+
|
|
5
|
+
//#region src/query/fetchQuery.d.ts
|
|
6
|
+
/** A client-side mirror of the parameters `parseQueryParams` reads off the request. */
|
|
7
|
+
interface QueryRequest {
|
|
8
|
+
metrics: MetricKey[];
|
|
9
|
+
dimensions?: DimensionKey[];
|
|
10
|
+
from: string;
|
|
11
|
+
to: string;
|
|
12
|
+
granularity?: Granularity;
|
|
13
|
+
filters?: AnalyticsFilter[];
|
|
14
|
+
limit?: number;
|
|
15
|
+
order?: {
|
|
16
|
+
metric: MetricKey;
|
|
17
|
+
direction: 'asc' | 'desc';
|
|
18
|
+
};
|
|
19
|
+
compare?: 'previous';
|
|
20
|
+
source?: string;
|
|
21
|
+
/**
|
|
22
|
+
* Read another scope's data. Platform readers only: the endpoint answers
|
|
23
|
+
* `400 untrusted_scope` for any caller that may not read across scopes.
|
|
24
|
+
*/
|
|
25
|
+
scope?: string;
|
|
26
|
+
path?: string;
|
|
27
|
+
hostname?: string;
|
|
28
|
+
timezone?: string;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Builds the query endpoint URL from a fixed field order (not object insertion order),
|
|
32
|
+
* so two `QueryRequest`s with the same values always produce the same URL string. That
|
|
33
|
+
* determinism is what `fetchQuery`'s in-flight dedupe keys on.
|
|
34
|
+
*/
|
|
35
|
+
declare const buildQueryUrl: (apiRoute: string, request: QueryRequest) => string;
|
|
36
|
+
/** Thrown by `fetchQuery` for any non-2xx response; `error` is set only when the body parsed as the endpoint's error shape. */
|
|
37
|
+
declare class QueryFetchError extends Error {
|
|
38
|
+
readonly status: number;
|
|
39
|
+
readonly error?: QueryError;
|
|
40
|
+
readonly retryAfter?: number;
|
|
41
|
+
constructor(status: number, error?: QueryError, retryAfter?: number);
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Fetches `GET /analytics/query`, deduping concurrent identical requests (same URL) into
|
|
45
|
+
* one underlying fetch; the entry clears on settle (success or failure), so a later call
|
|
46
|
+
* always sees fresh data and a failed one retries instead of pinning the error.
|
|
47
|
+
*
|
|
48
|
+
* Dedupe means the shared fetch itself never carries a caller's `AbortSignal`, since
|
|
49
|
+
* aborting it would also cancel every other caller sharing that in-flight request.
|
|
50
|
+
* `init.signal` instead races the caller's own promise against the abort: aborting
|
|
51
|
+
* rejects that caller without touching the shared fetch. Use distinct requests (varying
|
|
52
|
+
* a param) when one caller's cancellation must actually stop the network call.
|
|
53
|
+
*/
|
|
54
|
+
declare const fetchQuery: (apiRoute: string, request: QueryRequest, init?: {
|
|
55
|
+
signal?: AbortSignal;
|
|
56
|
+
}) => Promise<QueryResponse>;
|
|
57
|
+
/** What `POST /analytics/refresh` answers: the scope's epoch token after the bump. */
|
|
58
|
+
interface RefreshResponse {
|
|
59
|
+
epoch: string;
|
|
60
|
+
}
|
|
61
|
+
interface RefreshRequest {
|
|
62
|
+
/**
|
|
63
|
+
* Refresh another scope. Platform readers only: the endpoint answers
|
|
64
|
+
* `400 untrusted_scope` for any caller that may not read across scopes. Omitted, the
|
|
65
|
+
* request's own resolved scope is refreshed.
|
|
66
|
+
*/
|
|
67
|
+
scope?: string;
|
|
68
|
+
signal?: AbortSignal;
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Raises the scope's cache epoch, so every later read of it misses the cache and reaches
|
|
72
|
+
* the provider again. Not deduped, unlike `fetchQuery`: a reader pressing Refresh twice
|
|
73
|
+
* means it twice, and the signal can go straight to the fetch because no other caller
|
|
74
|
+
* shares it. Rejects with a `QueryFetchError` for any non-2xx answer, the same as a read.
|
|
75
|
+
*/
|
|
76
|
+
declare const refreshCache: (apiRoute: string, request?: RefreshRequest) => Promise<RefreshResponse>;
|
|
77
|
+
//#endregion
|
|
78
|
+
export { QueryFetchError, QueryRequest, RefreshRequest, RefreshResponse, buildQueryUrl, fetchQuery, refreshCache };
|
|
79
|
+
//# sourceMappingURL=fetchQuery.d.ts.map
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
import { QUERY_PATH, REFRESH_PATH } from "../plugin/paths.js";
|
|
2
|
+
import { readResponseError } from "../plugin/errors.js";
|
|
3
|
+
//#region src/query/fetchQuery.ts
|
|
4
|
+
const apiBase = (apiRoute) => apiRoute.endsWith("/") ? apiRoute.slice(0, -1) : apiRoute;
|
|
5
|
+
/**
|
|
6
|
+
* Builds the query endpoint URL from a fixed field order (not object insertion order),
|
|
7
|
+
* so two `QueryRequest`s with the same values always produce the same URL string. That
|
|
8
|
+
* determinism is what `fetchQuery`'s in-flight dedupe keys on.
|
|
9
|
+
*/
|
|
10
|
+
const buildQueryUrl = (apiRoute, request) => {
|
|
11
|
+
const params = new URLSearchParams();
|
|
12
|
+
params.set("metrics", request.metrics.join(","));
|
|
13
|
+
if (request.dimensions && request.dimensions.length > 0) params.set("dimensions", request.dimensions.join(","));
|
|
14
|
+
params.set("from", request.from);
|
|
15
|
+
params.set("to", request.to);
|
|
16
|
+
if (request.granularity !== void 0) params.set("granularity", request.granularity);
|
|
17
|
+
if (request.filters && request.filters.length > 0) params.set("filters", JSON.stringify(request.filters));
|
|
18
|
+
if (request.limit !== void 0) params.set("limit", String(request.limit));
|
|
19
|
+
if (request.order !== void 0) params.set("order", `${request.order.metric}:${request.order.direction}`);
|
|
20
|
+
if (request.compare !== void 0) params.set("compare", request.compare);
|
|
21
|
+
if (request.source !== void 0) params.set("source", request.source);
|
|
22
|
+
if (request.scope !== void 0) params.set("scope", request.scope);
|
|
23
|
+
if (request.path !== void 0) params.set("path", request.path);
|
|
24
|
+
if (request.hostname !== void 0) params.set("hostname", request.hostname);
|
|
25
|
+
if (request.timezone !== void 0) params.set("timezone", request.timezone);
|
|
26
|
+
return `${apiBase(apiRoute)}${QUERY_PATH}?${params.toString()}`;
|
|
27
|
+
};
|
|
28
|
+
const isRecord = (value) => typeof value === "object" && value !== null;
|
|
29
|
+
/** Thrown by `fetchQuery` for any non-2xx response; `error` is set only when the body parsed as the endpoint's error shape. */
|
|
30
|
+
var QueryFetchError = class extends Error {
|
|
31
|
+
status;
|
|
32
|
+
error;
|
|
33
|
+
retryAfter;
|
|
34
|
+
constructor(status, error, retryAfter) {
|
|
35
|
+
super(error?.message ?? `analytics query request failed with status ${status}`);
|
|
36
|
+
this.name = "QueryFetchError";
|
|
37
|
+
this.status = status;
|
|
38
|
+
if (error !== void 0) this.error = error;
|
|
39
|
+
if (retryAfter !== void 0) this.retryAfter = retryAfter;
|
|
40
|
+
}
|
|
41
|
+
};
|
|
42
|
+
const readRetryAfter = (res) => {
|
|
43
|
+
const header = res.headers.get("Retry-After");
|
|
44
|
+
if (header === null) return void 0;
|
|
45
|
+
const seconds = Number(header);
|
|
46
|
+
return Number.isFinite(seconds) ? Math.floor(seconds) : void 0;
|
|
47
|
+
};
|
|
48
|
+
const failure = async (res) => new QueryFetchError(res.status, await readResponseError(res), readRetryAfter(res));
|
|
49
|
+
const runFetch = async (url) => {
|
|
50
|
+
const res = await fetch(url, {
|
|
51
|
+
credentials: "include",
|
|
52
|
+
headers: { Accept: "application/json" }
|
|
53
|
+
});
|
|
54
|
+
if (!res.ok) throw await failure(res);
|
|
55
|
+
return await res.json();
|
|
56
|
+
};
|
|
57
|
+
const inFlight = /* @__PURE__ */ new Map();
|
|
58
|
+
/**
|
|
59
|
+
* Fetches `GET /analytics/query`, deduping concurrent identical requests (same URL) into
|
|
60
|
+
* one underlying fetch; the entry clears on settle (success or failure), so a later call
|
|
61
|
+
* always sees fresh data and a failed one retries instead of pinning the error.
|
|
62
|
+
*
|
|
63
|
+
* Dedupe means the shared fetch itself never carries a caller's `AbortSignal`, since
|
|
64
|
+
* aborting it would also cancel every other caller sharing that in-flight request.
|
|
65
|
+
* `init.signal` instead races the caller's own promise against the abort: aborting
|
|
66
|
+
* rejects that caller without touching the shared fetch. Use distinct requests (varying
|
|
67
|
+
* a param) when one caller's cancellation must actually stop the network call.
|
|
68
|
+
*/
|
|
69
|
+
const fetchQuery = (apiRoute, request, init) => {
|
|
70
|
+
const url = buildQueryUrl(apiRoute, request);
|
|
71
|
+
let pending = inFlight.get(url);
|
|
72
|
+
if (!pending) {
|
|
73
|
+
pending = runFetch(url).finally(() => {
|
|
74
|
+
inFlight.delete(url);
|
|
75
|
+
});
|
|
76
|
+
inFlight.set(url, pending);
|
|
77
|
+
}
|
|
78
|
+
const signal = init?.signal;
|
|
79
|
+
if (!signal) return pending;
|
|
80
|
+
if (signal.aborted) return Promise.reject(signal.reason);
|
|
81
|
+
return new Promise((resolve, reject) => {
|
|
82
|
+
const onAbort = () => reject(signal.reason);
|
|
83
|
+
signal.addEventListener("abort", onAbort, { once: true });
|
|
84
|
+
pending.then((value) => {
|
|
85
|
+
signal.removeEventListener("abort", onAbort);
|
|
86
|
+
resolve(value);
|
|
87
|
+
}, (err) => {
|
|
88
|
+
signal.removeEventListener("abort", onAbort);
|
|
89
|
+
reject(err);
|
|
90
|
+
});
|
|
91
|
+
});
|
|
92
|
+
};
|
|
93
|
+
/**
|
|
94
|
+
* Raises the scope's cache epoch, so every later read of it misses the cache and reaches
|
|
95
|
+
* the provider again. Not deduped, unlike `fetchQuery`: a reader pressing Refresh twice
|
|
96
|
+
* means it twice, and the signal can go straight to the fetch because no other caller
|
|
97
|
+
* shares it. Rejects with a `QueryFetchError` for any non-2xx answer, the same as a read.
|
|
98
|
+
*/
|
|
99
|
+
const refreshCache = async (apiRoute, request = {}) => {
|
|
100
|
+
const res = await fetch(`${apiBase(apiRoute)}${REFRESH_PATH}`, {
|
|
101
|
+
method: "POST",
|
|
102
|
+
credentials: "include",
|
|
103
|
+
headers: {
|
|
104
|
+
Accept: "application/json",
|
|
105
|
+
"Content-Type": "application/json"
|
|
106
|
+
},
|
|
107
|
+
body: JSON.stringify(request.scope === void 0 ? {} : { scope: request.scope }),
|
|
108
|
+
...request.signal === void 0 ? {} : { signal: request.signal }
|
|
109
|
+
});
|
|
110
|
+
if (!res.ok) throw await failure(res);
|
|
111
|
+
const body = await res.json();
|
|
112
|
+
return { epoch: isRecord(body) && typeof body.epoch === "string" ? body.epoch : "0" };
|
|
113
|
+
};
|
|
114
|
+
//#endregion
|
|
115
|
+
export { QueryFetchError, buildQueryUrl, fetchQuery, refreshCache };
|
|
116
|
+
|
|
117
|
+
//# sourceMappingURL=fetchQuery.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fetchQuery.js","names":[],"sources":["../../src/query/fetchQuery.ts"],"sourcesContent":["import type { AnalyticsFilter, DimensionKey, Granularity, MetricKey } from '../core/contract'\nimport { readResponseError } from '../plugin/errors'\nimport { QUERY_PATH, REFRESH_PATH } from '../plugin/paths'\nimport type { QueryError } from './errors'\nimport type { QueryResponse } from './response'\n\n/** A client-side mirror of the parameters `parseQueryParams` reads off the request. */\nexport interface QueryRequest {\n\tmetrics: MetricKey[]\n\tdimensions?: DimensionKey[]\n\tfrom: string\n\tto: string\n\tgranularity?: Granularity\n\tfilters?: AnalyticsFilter[]\n\tlimit?: number\n\torder?: { metric: MetricKey; direction: 'asc' | 'desc' }\n\tcompare?: 'previous'\n\tsource?: string\n\t/**\n\t * Read another scope's data. Platform readers only: the endpoint answers\n\t * `400 untrusted_scope` for any caller that may not read across scopes.\n\t */\n\tscope?: string\n\tpath?: string\n\thostname?: string\n\ttimezone?: string\n}\n\nconst apiBase = (apiRoute: string): string =>\n\tapiRoute.endsWith('/') ? apiRoute.slice(0, -1) : apiRoute\n\n/**\n * Builds the query endpoint URL from a fixed field order (not object insertion order),\n * so two `QueryRequest`s with the same values always produce the same URL string. That\n * determinism is what `fetchQuery`'s in-flight dedupe keys on.\n */\nexport const buildQueryUrl = (apiRoute: string, request: QueryRequest): string => {\n\tconst params = new URLSearchParams()\n\tparams.set('metrics', request.metrics.join(','))\n\tif (request.dimensions && request.dimensions.length > 0) {\n\t\tparams.set('dimensions', request.dimensions.join(','))\n\t}\n\tparams.set('from', request.from)\n\tparams.set('to', request.to)\n\tif (request.granularity !== undefined) {\n\t\tparams.set('granularity', request.granularity)\n\t}\n\tif (request.filters && request.filters.length > 0) {\n\t\tparams.set('filters', JSON.stringify(request.filters))\n\t}\n\tif (request.limit !== undefined) {\n\t\tparams.set('limit', String(request.limit))\n\t}\n\tif (request.order !== undefined) {\n\t\tparams.set('order', `${request.order.metric}:${request.order.direction}`)\n\t}\n\tif (request.compare !== undefined) {\n\t\tparams.set('compare', request.compare)\n\t}\n\tif (request.source !== undefined) {\n\t\tparams.set('source', request.source)\n\t}\n\tif (request.scope !== undefined) {\n\t\tparams.set('scope', request.scope)\n\t}\n\tif (request.path !== undefined) {\n\t\tparams.set('path', request.path)\n\t}\n\tif (request.hostname !== undefined) {\n\t\tparams.set('hostname', request.hostname)\n\t}\n\tif (request.timezone !== undefined) {\n\t\tparams.set('timezone', request.timezone)\n\t}\n\treturn `${apiBase(apiRoute)}${QUERY_PATH}?${params.toString()}`\n}\n\nconst isRecord = (value: unknown): value is Record<string, unknown> =>\n\ttypeof value === 'object' && value !== null\n\n/** Thrown by `fetchQuery` for any non-2xx response; `error` is set only when the body parsed as the endpoint's error shape. */\nexport class QueryFetchError extends Error {\n\treadonly status: number\n\treadonly error?: QueryError\n\treadonly retryAfter?: number\n\n\tconstructor(status: number, error?: QueryError, retryAfter?: number) {\n\t\tsuper(error?.message ?? `analytics query request failed with status ${status}`)\n\t\tthis.name = 'QueryFetchError'\n\t\tthis.status = status\n\t\tif (error !== undefined) this.error = error\n\t\tif (retryAfter !== undefined) this.retryAfter = retryAfter\n\t}\n}\n\nconst readRetryAfter = (res: Response): number | undefined => {\n\tconst header = res.headers.get('Retry-After')\n\tif (header === null) return undefined\n\t// The HTTP-date form is not a number, so it yields no delay rather than a bogus one;\n\t// a fractional delay floors, since callers schedule in whole seconds.\n\tconst seconds = Number(header)\n\treturn Number.isFinite(seconds) ? Math.floor(seconds) : undefined\n}\n\nconst failure = async (res: Response): Promise<QueryFetchError> =>\n\tnew QueryFetchError(res.status, await readResponseError(res), readRetryAfter(res))\n\nconst runFetch = async (url: string): Promise<QueryResponse> => {\n\tconst res = await fetch(url, {\n\t\tcredentials: 'include',\n\t\theaders: { Accept: 'application/json' },\n\t})\n\tif (!res.ok) {\n\t\tthrow await failure(res)\n\t}\n\treturn (await res.json()) as QueryResponse\n}\n\nconst inFlight = new Map<string, Promise<QueryResponse>>()\n\n/**\n * Fetches `GET /analytics/query`, deduping concurrent identical requests (same URL) into\n * one underlying fetch; the entry clears on settle (success or failure), so a later call\n * always sees fresh data and a failed one retries instead of pinning the error.\n *\n * Dedupe means the shared fetch itself never carries a caller's `AbortSignal`, since\n * aborting it would also cancel every other caller sharing that in-flight request.\n * `init.signal` instead races the caller's own promise against the abort: aborting\n * rejects that caller without touching the shared fetch. Use distinct requests (varying\n * a param) when one caller's cancellation must actually stop the network call.\n */\nexport const fetchQuery = (\n\tapiRoute: string,\n\trequest: QueryRequest,\n\tinit?: { signal?: AbortSignal }\n): Promise<QueryResponse> => {\n\tconst url = buildQueryUrl(apiRoute, request)\n\tlet pending = inFlight.get(url)\n\tif (!pending) {\n\t\tpending = runFetch(url).finally(() => {\n\t\t\tinFlight.delete(url)\n\t\t})\n\t\tinFlight.set(url, pending)\n\t}\n\n\tconst signal = init?.signal\n\tif (!signal) return pending\n\tif (signal.aborted) return Promise.reject(signal.reason)\n\n\treturn new Promise<QueryResponse>((resolve, reject) => {\n\t\tconst onAbort = () => reject(signal.reason)\n\t\tsignal.addEventListener('abort', onAbort, { once: true })\n\t\tpending.then(\n\t\t\t(value) => {\n\t\t\t\tsignal.removeEventListener('abort', onAbort)\n\t\t\t\tresolve(value)\n\t\t\t},\n\t\t\t(err: unknown) => {\n\t\t\t\tsignal.removeEventListener('abort', onAbort)\n\t\t\t\treject(err)\n\t\t\t}\n\t\t)\n\t})\n}\n\n/** What `POST /analytics/refresh` answers: the scope's epoch token after the bump. */\nexport interface RefreshResponse {\n\tepoch: string\n}\n\nexport interface RefreshRequest {\n\t/**\n\t * Refresh another scope. Platform readers only: the endpoint answers\n\t * `400 untrusted_scope` for any caller that may not read across scopes. Omitted, the\n\t * request's own resolved scope is refreshed.\n\t */\n\tscope?: string\n\tsignal?: AbortSignal\n}\n\n/**\n * Raises the scope's cache epoch, so every later read of it misses the cache and reaches\n * the provider again. Not deduped, unlike `fetchQuery`: a reader pressing Refresh twice\n * means it twice, and the signal can go straight to the fetch because no other caller\n * shares it. Rejects with a `QueryFetchError` for any non-2xx answer, the same as a read.\n */\nexport const refreshCache = async (\n\tapiRoute: string,\n\trequest: RefreshRequest = {}\n): Promise<RefreshResponse> => {\n\tconst res = await fetch(`${apiBase(apiRoute)}${REFRESH_PATH}`, {\n\t\tmethod: 'POST',\n\t\tcredentials: 'include',\n\t\theaders: { Accept: 'application/json', 'Content-Type': 'application/json' },\n\t\tbody: JSON.stringify(request.scope === undefined ? {} : { scope: request.scope }),\n\t\t...(request.signal === undefined ? {} : { signal: request.signal }),\n\t})\n\tif (!res.ok) {\n\t\tthrow await failure(res)\n\t}\n\tconst body: unknown = await res.json()\n\t// The caller acts on the refresh having happened, not on the token, so an answer this\n\t// client cannot read is reported as the initial token rather than typed into a lie.\n\treturn { epoch: isRecord(body) && typeof body.epoch === 'string' ? body.epoch : '0' }\n}\n"],"mappings":";;;AA4BA,MAAM,WAAW,aAChB,SAAS,SAAS,GAAG,IAAI,SAAS,MAAM,GAAG,EAAE,IAAI;;;;;;AAOlD,MAAa,iBAAiB,UAAkB,YAAkC;CACjF,MAAM,SAAS,IAAI,gBAAgB;CACnC,OAAO,IAAI,WAAW,QAAQ,QAAQ,KAAK,GAAG,CAAC;CAC/C,IAAI,QAAQ,cAAc,QAAQ,WAAW,SAAS,GACrD,OAAO,IAAI,cAAc,QAAQ,WAAW,KAAK,GAAG,CAAC;CAEtD,OAAO,IAAI,QAAQ,QAAQ,IAAI;CAC/B,OAAO,IAAI,MAAM,QAAQ,EAAE;CAC3B,IAAI,QAAQ,gBAAgB,KAAA,GAC3B,OAAO,IAAI,eAAe,QAAQ,WAAW;CAE9C,IAAI,QAAQ,WAAW,QAAQ,QAAQ,SAAS,GAC/C,OAAO,IAAI,WAAW,KAAK,UAAU,QAAQ,OAAO,CAAC;CAEtD,IAAI,QAAQ,UAAU,KAAA,GACrB,OAAO,IAAI,SAAS,OAAO,QAAQ,KAAK,CAAC;CAE1C,IAAI,QAAQ,UAAU,KAAA,GACrB,OAAO,IAAI,SAAS,GAAG,QAAQ,MAAM,OAAO,GAAG,QAAQ,MAAM,WAAW;CAEzE,IAAI,QAAQ,YAAY,KAAA,GACvB,OAAO,IAAI,WAAW,QAAQ,OAAO;CAEtC,IAAI,QAAQ,WAAW,KAAA,GACtB,OAAO,IAAI,UAAU,QAAQ,MAAM;CAEpC,IAAI,QAAQ,UAAU,KAAA,GACrB,OAAO,IAAI,SAAS,QAAQ,KAAK;CAElC,IAAI,QAAQ,SAAS,KAAA,GACpB,OAAO,IAAI,QAAQ,QAAQ,IAAI;CAEhC,IAAI,QAAQ,aAAa,KAAA,GACxB,OAAO,IAAI,YAAY,QAAQ,QAAQ;CAExC,IAAI,QAAQ,aAAa,KAAA,GACxB,OAAO,IAAI,YAAY,QAAQ,QAAQ;CAExC,OAAO,GAAG,QAAQ,QAAQ,IAAI,WAAW,GAAG,OAAO,SAAS;AAC7D;AAEA,MAAM,YAAY,UACjB,OAAO,UAAU,YAAY,UAAU;;AAGxC,IAAa,kBAAb,cAAqC,MAAM;CAC1C;CACA;CACA;CAEA,YAAY,QAAgB,OAAoB,YAAqB;EACpE,MAAM,OAAO,WAAW,8CAA8C,QAAQ;EAC9E,KAAK,OAAO;EACZ,KAAK,SAAS;EACd,IAAI,UAAU,KAAA,GAAW,KAAK,QAAQ;EACtC,IAAI,eAAe,KAAA,GAAW,KAAK,aAAa;CACjD;AACD;AAEA,MAAM,kBAAkB,QAAsC;CAC7D,MAAM,SAAS,IAAI,QAAQ,IAAI,aAAa;CAC5C,IAAI,WAAW,MAAM,OAAO,KAAA;CAG5B,MAAM,UAAU,OAAO,MAAM;CAC7B,OAAO,OAAO,SAAS,OAAO,IAAI,KAAK,MAAM,OAAO,IAAI,KAAA;AACzD;AAEA,MAAM,UAAU,OAAO,QACtB,IAAI,gBAAgB,IAAI,QAAQ,MAAM,kBAAkB,GAAG,GAAG,eAAe,GAAG,CAAC;AAElF,MAAM,WAAW,OAAO,QAAwC;CAC/D,MAAM,MAAM,MAAM,MAAM,KAAK;EAC5B,aAAa;EACb,SAAS,EAAE,QAAQ,mBAAmB;CACvC,CAAC;CACD,IAAI,CAAC,IAAI,IACR,MAAM,MAAM,QAAQ,GAAG;CAExB,OAAQ,MAAM,IAAI,KAAK;AACxB;AAEA,MAAM,2BAAW,IAAI,IAAoC;;;;;;;;;;;;AAazD,MAAa,cACZ,UACA,SACA,SAC4B;CAC5B,MAAM,MAAM,cAAc,UAAU,OAAO;CAC3C,IAAI,UAAU,SAAS,IAAI,GAAG;CAC9B,IAAI,CAAC,SAAS;EACb,UAAU,SAAS,GAAG,EAAE,cAAc;GACrC,SAAS,OAAO,GAAG;EACpB,CAAC;EACD,SAAS,IAAI,KAAK,OAAO;CAC1B;CAEA,MAAM,SAAS,MAAM;CACrB,IAAI,CAAC,QAAQ,OAAO;CACpB,IAAI,OAAO,SAAS,OAAO,QAAQ,OAAO,OAAO,MAAM;CAEvD,OAAO,IAAI,SAAwB,SAAS,WAAW;EACtD,MAAM,gBAAgB,OAAO,OAAO,MAAM;EAC1C,OAAO,iBAAiB,SAAS,SAAS,EAAE,MAAM,KAAK,CAAC;EACxD,QAAQ,MACN,UAAU;GACV,OAAO,oBAAoB,SAAS,OAAO;GAC3C,QAAQ,KAAK;EACd,IACC,QAAiB;GACjB,OAAO,oBAAoB,SAAS,OAAO;GAC3C,OAAO,GAAG;EACX,CACD;CACD,CAAC;AACF;;;;;;;AAuBA,MAAa,eAAe,OAC3B,UACA,UAA0B,CAAC,MACG;CAC9B,MAAM,MAAM,MAAM,MAAM,GAAG,QAAQ,QAAQ,IAAI,gBAAgB;EAC9D,QAAQ;EACR,aAAa;EACb,SAAS;GAAE,QAAQ;GAAoB,gBAAgB;EAAmB;EAC1E,MAAM,KAAK,UAAU,QAAQ,UAAU,KAAA,IAAY,CAAC,IAAI,EAAE,OAAO,QAAQ,MAAM,CAAC;EAChF,GAAI,QAAQ,WAAW,KAAA,IAAY,CAAC,IAAI,EAAE,QAAQ,QAAQ,OAAO;CAClE,CAAC;CACD,IAAI,CAAC,IAAI,IACR,MAAM,MAAM,QAAQ,GAAG;CAExB,MAAM,OAAgB,MAAM,IAAI,KAAK;CAGrC,OAAO,EAAE,OAAO,SAAS,IAAI,KAAK,OAAO,KAAK,UAAU,WAAW,KAAK,QAAQ,IAAI;AACrF"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { AnalyticsQuery } from "../core/contract.js";
|
|
2
|
+
import { AnalyticsError } from "../plugin/errors.js";
|
|
3
|
+
|
|
4
|
+
//#region src/query/parse.d.ts
|
|
5
|
+
/**
|
|
6
|
+
* A validated read request. `source` and `scope` are absent by design: the handler must
|
|
7
|
+
* resolve both before the parser can run, and reads them itself through {@link readParam}.
|
|
8
|
+
*/
|
|
9
|
+
interface ParsedQuery {
|
|
10
|
+
query: AnalyticsQuery;
|
|
11
|
+
compare: 'previous' | null;
|
|
12
|
+
}
|
|
13
|
+
type ParseResult = {
|
|
14
|
+
ok: true;
|
|
15
|
+
value: ParsedQuery;
|
|
16
|
+
} | {
|
|
17
|
+
ok: false;
|
|
18
|
+
error: AnalyticsError;
|
|
19
|
+
};
|
|
20
|
+
//#endregion
|
|
21
|
+
export { ParseResult, ParsedQuery };
|
|
22
|
+
//# sourceMappingURL=parse.d.ts.map
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
import { DIMENSION_KEYS, FILTER_OPERATORS } from "../core/contract.js";
|
|
2
|
+
import { isValidTimeZone } from "../timeframe/tz.js";
|
|
3
|
+
import { METRIC_KEYS } from "../translations/metricKeys.js";
|
|
4
|
+
import { analyticsError } from "../plugin/errors.js";
|
|
5
|
+
import { GRANULARITY_ORDER } from "../core/granularity.js";
|
|
6
|
+
import { parseDayOrInstant } from "./dates.js";
|
|
7
|
+
//#region src/query/parse.ts
|
|
8
|
+
const KNOWN_METRICS = new Set(Object.keys(METRIC_KEYS));
|
|
9
|
+
const KNOWN_DIMENSIONS = new Set(DIMENSION_KEYS);
|
|
10
|
+
const KNOWN_OPERATORS = new Set(FILTER_OPERATORS);
|
|
11
|
+
const KNOWN_GRANULARITIES = new Set(GRANULARITY_ORDER);
|
|
12
|
+
const DAY_MS = 864e5;
|
|
13
|
+
const fail = (code, message, param) => ({
|
|
14
|
+
ok: false,
|
|
15
|
+
error: analyticsError(code, message, param)
|
|
16
|
+
});
|
|
17
|
+
/** Echo a rejected value back in a message without letting a caller inflate the response. */
|
|
18
|
+
const echo = (value) => value.length > 40 ? `${value.slice(0, 40)}...` : value;
|
|
19
|
+
/**
|
|
20
|
+
* A trimmed non-empty parameter, or null when absent or blank. Exported so the handler
|
|
21
|
+
* reads `source` and `scope` (which it must resolve before the parser can run) exactly
|
|
22
|
+
* the way the parser reads everything else.
|
|
23
|
+
*/
|
|
24
|
+
const readParam = (params, name) => {
|
|
25
|
+
const raw = params.get(name)?.trim();
|
|
26
|
+
return raw ? raw : null;
|
|
27
|
+
};
|
|
28
|
+
const commaList = (raw) => raw.split(",").map((part) => part.trim()).filter((part) => part.length > 0);
|
|
29
|
+
const dedupe = (values) => [...new Set(values)];
|
|
30
|
+
const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
|
|
31
|
+
const parseFilters = (raw, capabilities) => {
|
|
32
|
+
let decoded;
|
|
33
|
+
try {
|
|
34
|
+
decoded = JSON.parse(raw);
|
|
35
|
+
} catch {
|
|
36
|
+
return fail("invalid_param", "filters must be a JSON array", "filters");
|
|
37
|
+
}
|
|
38
|
+
if (!Array.isArray(decoded)) return fail("invalid_param", "filters must be a JSON array", "filters");
|
|
39
|
+
if (decoded.length > 10) return fail("invalid_param", `at most 10 filters are allowed`, "filters");
|
|
40
|
+
const filterable = new Set(capabilities.filters);
|
|
41
|
+
const operators = new Set(capabilities.filterOperators);
|
|
42
|
+
const parsed = [];
|
|
43
|
+
for (const item of decoded) {
|
|
44
|
+
if (!isRecord(item)) return fail("invalid_param", "each filter must be an object", "filters");
|
|
45
|
+
const { dimension, operator, value } = item;
|
|
46
|
+
if (typeof dimension !== "string" || !KNOWN_DIMENSIONS.has(dimension)) return fail("invalid_param", `unknown filter dimension: ${echo(String(dimension))}`, "filters");
|
|
47
|
+
if (typeof operator !== "string" || !KNOWN_OPERATORS.has(operator)) return fail("invalid_param", `unknown filter operator: ${echo(String(operator))}`, "filters");
|
|
48
|
+
if (typeof value !== "string") return fail("invalid_param", "each filter value must be a string", "filters");
|
|
49
|
+
const trimmed = value.trim();
|
|
50
|
+
if (trimmed.length < 1 || trimmed.length > 256) return fail("invalid_param", `each filter value must be 1 to 256 characters`, "filters");
|
|
51
|
+
if (!filterable.has(dimension)) return fail("unsupported_filter", `source cannot filter on ${dimension}`, "filters");
|
|
52
|
+
if (!operators.has(operator)) return fail("unsupported_operator", `source does not support ${operator}`, "filters");
|
|
53
|
+
parsed.push({
|
|
54
|
+
dimension,
|
|
55
|
+
operator,
|
|
56
|
+
value: trimmed
|
|
57
|
+
});
|
|
58
|
+
}
|
|
59
|
+
return parsed;
|
|
60
|
+
};
|
|
61
|
+
/**
|
|
62
|
+
* Validate a query string against a source's serialized capabilities. Rules are evaluated
|
|
63
|
+
* in a fixed order and the first failure wins: timezone, metrics, dimensions, from/to,
|
|
64
|
+
* granularity, filters, limit, order, compare, path, hostname. Within each, a value
|
|
65
|
+
* outside the contract's own union is `invalid_param` and a contract value the source
|
|
66
|
+
* lacks is its `unsupported_*` code. Unknown parameters are ignored; `source` and `scope`
|
|
67
|
+
* pass through unvalidated, since only the handler knows whether they are trusted.
|
|
68
|
+
*/
|
|
69
|
+
const parseQueryParams = (params, args) => {
|
|
70
|
+
const rawTimezone = readParam(params, "timezone");
|
|
71
|
+
if (rawTimezone !== null && !isValidTimeZone(rawTimezone)) return fail("invalid_param", `unknown timezone: ${echo(rawTimezone)}`, "timezone");
|
|
72
|
+
const timezone = rawTimezone ?? args.timezone;
|
|
73
|
+
const rawMetrics = readParam(params, "metrics");
|
|
74
|
+
const metricList = rawMetrics ? commaList(rawMetrics) : [];
|
|
75
|
+
if (metricList.length === 0) return fail("invalid_param", "metrics is required", "metrics");
|
|
76
|
+
const unknownMetric = metricList.find((m) => !KNOWN_METRICS.has(m));
|
|
77
|
+
if (unknownMetric !== void 0) return fail("invalid_param", `unknown metric: ${echo(unknownMetric)}`, "metrics");
|
|
78
|
+
const metrics = dedupe(metricList);
|
|
79
|
+
if (metrics.length > 10) return fail("invalid_param", `at most 10 metrics are allowed`, "metrics");
|
|
80
|
+
const servedMetrics = new Set(args.capabilities.metrics);
|
|
81
|
+
const unsupportedMetric = metrics.find((m) => !servedMetrics.has(m));
|
|
82
|
+
if (unsupportedMetric !== void 0) return fail("unsupported_metric", `source does not serve ${unsupportedMetric}`, "metrics");
|
|
83
|
+
const rawDimensions = readParam(params, "dimensions");
|
|
84
|
+
const dimensionList = rawDimensions ? commaList(rawDimensions) : [];
|
|
85
|
+
const unknownDimension = dimensionList.find((d) => !KNOWN_DIMENSIONS.has(d));
|
|
86
|
+
if (unknownDimension !== void 0) return fail("invalid_param", `unknown dimension: ${echo(unknownDimension)}`, "dimensions");
|
|
87
|
+
const dimensions = dedupe(dimensionList);
|
|
88
|
+
if (dimensions.length > 2) return fail("invalid_param", `at most 2 dimensions are allowed`, "dimensions");
|
|
89
|
+
const servedDimensions = new Set(args.capabilities.dimensions);
|
|
90
|
+
const unsupportedDimension = dimensions.find((d) => !servedDimensions.has(d));
|
|
91
|
+
if (unsupportedDimension !== void 0) return fail("unsupported_dimension", `source does not break down by ${unsupportedDimension}`, "dimensions");
|
|
92
|
+
const rawFrom = readParam(params, "from");
|
|
93
|
+
const rawTo = readParam(params, "to");
|
|
94
|
+
if (!rawFrom) return fail("invalid_param", "from is required", "from");
|
|
95
|
+
const start = parseDayOrInstant(rawFrom, {
|
|
96
|
+
timezone,
|
|
97
|
+
edge: "start"
|
|
98
|
+
});
|
|
99
|
+
if (!start) return fail("invalid_param", `from is not a date: ${echo(rawFrom)}`, "from");
|
|
100
|
+
if (!rawTo) return fail("invalid_param", "to is required", "to");
|
|
101
|
+
const end = parseDayOrInstant(rawTo, {
|
|
102
|
+
timezone,
|
|
103
|
+
edge: "end"
|
|
104
|
+
});
|
|
105
|
+
if (!end) return fail("invalid_param", `to is not a date: ${echo(rawTo)}`, "to");
|
|
106
|
+
if (end.getTime() < start.getTime()) return fail("invalid_param", "to must not be before from", "to");
|
|
107
|
+
if (end.getTime() - start.getTime() > 366 * DAY_MS) return fail("range_too_long", `the range must not exceed 366 days`, "to");
|
|
108
|
+
const rawGranularity = readParam(params, "granularity");
|
|
109
|
+
if (rawGranularity !== null && !KNOWN_GRANULARITIES.has(rawGranularity)) return fail("invalid_param", `unknown granularity: ${echo(rawGranularity)}`, "granularity");
|
|
110
|
+
const granularity = rawGranularity;
|
|
111
|
+
if (granularity !== null && GRANULARITY_ORDER.indexOf(granularity) < GRANULARITY_ORDER.indexOf(args.capabilities.minGranularity)) return fail("unsupported_granularity", `source buckets no finer than ${args.capabilities.minGranularity}`, "granularity");
|
|
112
|
+
const rawFilters = readParam(params, "filters");
|
|
113
|
+
const filters = rawFilters === null ? [] : parseFilters(rawFilters, args.capabilities);
|
|
114
|
+
if (!Array.isArray(filters)) return filters;
|
|
115
|
+
const rawLimit = readParam(params, "limit");
|
|
116
|
+
let limit = 50;
|
|
117
|
+
if (rawLimit !== null) {
|
|
118
|
+
if (!/^\d+$/.test(rawLimit)) return fail("invalid_param", `limit must be an integer: ${echo(rawLimit)}`, "limit");
|
|
119
|
+
limit = Number(rawLimit);
|
|
120
|
+
if (limit < 1 || limit > 500) return fail("invalid_param", `limit must be between 1 and 500`, "limit");
|
|
121
|
+
}
|
|
122
|
+
const rawOrder = readParam(params, "order");
|
|
123
|
+
let order;
|
|
124
|
+
if (rawOrder !== null) {
|
|
125
|
+
const parts = rawOrder.split(":");
|
|
126
|
+
const metric = parts[0] ?? "";
|
|
127
|
+
const direction = parts[1] ?? "";
|
|
128
|
+
if (parts.length !== 2 || direction !== "asc" && direction !== "desc") return fail("invalid_param", "order must be <metric>:<asc|desc>", "order");
|
|
129
|
+
const ordered = metrics.find((m) => m === metric);
|
|
130
|
+
if (ordered === void 0) return fail("invalid_param", `order metric is not in metrics: ${echo(metric)}`, "order");
|
|
131
|
+
order = {
|
|
132
|
+
metric: ordered,
|
|
133
|
+
direction
|
|
134
|
+
};
|
|
135
|
+
}
|
|
136
|
+
const rawCompare = readParam(params, "compare");
|
|
137
|
+
if (rawCompare !== null && rawCompare !== "previous") return fail("invalid_param", `compare must be "previous": ${echo(rawCompare)}`, "compare");
|
|
138
|
+
if (rawCompare === "previous" && !args.capabilities.comparison) return fail("invalid_param", "source does not support comparison", "compare");
|
|
139
|
+
const path = readParam(params, "path");
|
|
140
|
+
if (path !== null && path.length > 512) return fail("invalid_param", `path must be at most 512 characters`, "path");
|
|
141
|
+
const hostname = readParam(params, "hostname");
|
|
142
|
+
if (hostname !== null && hostname.length > 253) return fail("invalid_param", `hostname must be at most 253 characters`, "hostname");
|
|
143
|
+
return {
|
|
144
|
+
ok: true,
|
|
145
|
+
value: {
|
|
146
|
+
query: {
|
|
147
|
+
metrics,
|
|
148
|
+
dateRange: {
|
|
149
|
+
start,
|
|
150
|
+
end
|
|
151
|
+
},
|
|
152
|
+
limit,
|
|
153
|
+
timezone,
|
|
154
|
+
...dimensions.length > 0 ? { dimensions } : {},
|
|
155
|
+
...granularity !== null ? { granularity } : {},
|
|
156
|
+
...filters.length > 0 ? { filters } : {},
|
|
157
|
+
...order ? { order } : {},
|
|
158
|
+
...path !== null ? { path } : {},
|
|
159
|
+
...hostname !== null ? { hostname } : {}
|
|
160
|
+
},
|
|
161
|
+
compare: rawCompare === "previous" ? "previous" : null
|
|
162
|
+
}
|
|
163
|
+
};
|
|
164
|
+
};
|
|
165
|
+
//#endregion
|
|
166
|
+
export { parseQueryParams, readParam };
|
|
167
|
+
|
|
168
|
+
//# sourceMappingURL=parse.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"parse.js","names":[],"sources":["../../src/query/parse.ts"],"sourcesContent":["import type { SerializedCapabilities } from '../core/capabilities'\nimport {\n\ttype AnalyticsFilter,\n\ttype AnalyticsQuery,\n\tDIMENSION_KEYS,\n\ttype DimensionKey,\n\tFILTER_OPERATORS,\n\ttype FilterOperator,\n\ttype Granularity,\n\ttype MetricKey,\n} from '../core/contract'\nimport { GRANULARITY_ORDER } from '../core/granularity'\nimport { type AnalyticsError, analyticsError } from '../plugin/errors'\nimport { isValidTimeZone } from '../timeframe/tz'\nimport { METRIC_KEYS } from '../translations/metricKeys'\nimport { parseDayOrInstant } from './dates'\nimport {\n\tDEFAULT_QUERY_LIMIT,\n\tMAX_QUERY_DIMENSIONS,\n\tMAX_QUERY_FILTER_VALUE_LENGTH,\n\tMAX_QUERY_FILTERS,\n\tMAX_QUERY_HOSTNAME_LENGTH,\n\tMAX_QUERY_LIMIT,\n\tMAX_QUERY_METRICS,\n\tMAX_QUERY_PATH_LENGTH,\n\tMAX_QUERY_RANGE_DAYS,\n\tMIN_QUERY_LIMIT,\n} from './limits'\n\n/**\n * A validated read request. `source` and `scope` are absent by design: the handler must\n * resolve both before the parser can run, and reads them itself through {@link readParam}.\n */\nexport interface ParsedQuery {\n\tquery: AnalyticsQuery\n\tcompare: 'previous' | null\n}\n\nexport type ParseResult = { ok: true; value: ParsedQuery } | { ok: false; error: AnalyticsError }\n\nexport interface ParseQueryArgs {\n\tcapabilities: SerializedCapabilities\n\t/** Reporting timezone the plugin resolved for this request; the `timezone` param overrides it. */\n\ttimezone: string\n}\n\nconst KNOWN_METRICS = new Set<string>(Object.keys(METRIC_KEYS))\nconst KNOWN_DIMENSIONS = new Set<string>(DIMENSION_KEYS)\nconst KNOWN_OPERATORS = new Set<string>(FILTER_OPERATORS)\nconst KNOWN_GRANULARITIES = new Set<string>(GRANULARITY_ORDER)\nconst DAY_MS = 86_400_000\n\nconst fail = (code: AnalyticsError['code'], message: string, param: string): ParseResult => ({\n\tok: false,\n\terror: analyticsError(code, message, param),\n})\n\n/** Echo a rejected value back in a message without letting a caller inflate the response. */\nconst echo = (value: string): string => (value.length > 40 ? `${value.slice(0, 40)}...` : value)\n\n/**\n * A trimmed non-empty parameter, or null when absent or blank. Exported so the handler\n * reads `source` and `scope` (which it must resolve before the parser can run) exactly\n * the way the parser reads everything else.\n */\nexport const readParam = (params: URLSearchParams, name: string): string | null => {\n\tconst raw = params.get(name)?.trim()\n\treturn raw ? raw : null\n}\n\nconst commaList = (raw: string): string[] =>\n\traw\n\t\t.split(',')\n\t\t.map((part) => part.trim())\n\t\t.filter((part) => part.length > 0)\n\nconst dedupe = <T extends string>(values: T[]): T[] => [...new Set(values)]\n\nconst isRecord = (value: unknown): value is Record<string, unknown> =>\n\ttypeof value === 'object' && value !== null && !Array.isArray(value)\n\nconst parseFilters = (\n\traw: string,\n\tcapabilities: SerializedCapabilities\n): AnalyticsFilter[] | ParseResult => {\n\tlet decoded: unknown\n\ttry {\n\t\tdecoded = JSON.parse(raw)\n\t} catch {\n\t\treturn fail('invalid_param', 'filters must be a JSON array', 'filters')\n\t}\n\tif (!Array.isArray(decoded)) {\n\t\treturn fail('invalid_param', 'filters must be a JSON array', 'filters')\n\t}\n\tif (decoded.length > MAX_QUERY_FILTERS) {\n\t\treturn fail('invalid_param', `at most ${MAX_QUERY_FILTERS} filters are allowed`, 'filters')\n\t}\n\tconst filterable = new Set<string>(capabilities.filters)\n\tconst operators = new Set<string>(capabilities.filterOperators)\n\tconst parsed: AnalyticsFilter[] = []\n\tfor (const item of decoded) {\n\t\tif (!isRecord(item)) {\n\t\t\treturn fail('invalid_param', 'each filter must be an object', 'filters')\n\t\t}\n\t\tconst { dimension, operator, value } = item\n\t\tif (typeof dimension !== 'string' || !KNOWN_DIMENSIONS.has(dimension)) {\n\t\t\treturn fail(\n\t\t\t\t'invalid_param',\n\t\t\t\t`unknown filter dimension: ${echo(String(dimension))}`,\n\t\t\t\t'filters'\n\t\t\t)\n\t\t}\n\t\tif (typeof operator !== 'string' || !KNOWN_OPERATORS.has(operator)) {\n\t\t\treturn fail('invalid_param', `unknown filter operator: ${echo(String(operator))}`, 'filters')\n\t\t}\n\t\tif (typeof value !== 'string') {\n\t\t\treturn fail('invalid_param', 'each filter value must be a string', 'filters')\n\t\t}\n\t\tconst trimmed = value.trim()\n\t\tif (trimmed.length < 1 || trimmed.length > MAX_QUERY_FILTER_VALUE_LENGTH) {\n\t\t\treturn fail(\n\t\t\t\t'invalid_param',\n\t\t\t\t`each filter value must be 1 to ${MAX_QUERY_FILTER_VALUE_LENGTH} characters`,\n\t\t\t\t'filters'\n\t\t\t)\n\t\t}\n\t\tif (!filterable.has(dimension)) {\n\t\t\treturn fail('unsupported_filter', `source cannot filter on ${dimension}`, 'filters')\n\t\t}\n\t\tif (!operators.has(operator)) {\n\t\t\treturn fail('unsupported_operator', `source does not support ${operator}`, 'filters')\n\t\t}\n\t\tparsed.push({\n\t\t\tdimension: dimension as DimensionKey,\n\t\t\toperator: operator as FilterOperator,\n\t\t\tvalue: trimmed,\n\t\t})\n\t}\n\treturn parsed\n}\n\n/**\n * Validate a query string against a source's serialized capabilities. Rules are evaluated\n * in a fixed order and the first failure wins: timezone, metrics, dimensions, from/to,\n * granularity, filters, limit, order, compare, path, hostname. Within each, a value\n * outside the contract's own union is `invalid_param` and a contract value the source\n * lacks is its `unsupported_*` code. Unknown parameters are ignored; `source` and `scope`\n * pass through unvalidated, since only the handler knows whether they are trusted.\n */\nexport const parseQueryParams = (params: URLSearchParams, args: ParseQueryArgs): ParseResult => {\n\tconst rawTimezone = readParam(params, 'timezone')\n\tif (rawTimezone !== null && !isValidTimeZone(rawTimezone)) {\n\t\treturn fail('invalid_param', `unknown timezone: ${echo(rawTimezone)}`, 'timezone')\n\t}\n\tconst timezone = rawTimezone ?? args.timezone\n\n\tconst rawMetrics = readParam(params, 'metrics')\n\tconst metricList = rawMetrics ? commaList(rawMetrics) : []\n\tif (metricList.length === 0) {\n\t\treturn fail('invalid_param', 'metrics is required', 'metrics')\n\t}\n\tconst unknownMetric = metricList.find((m) => !KNOWN_METRICS.has(m))\n\tif (unknownMetric !== undefined) {\n\t\treturn fail('invalid_param', `unknown metric: ${echo(unknownMetric)}`, 'metrics')\n\t}\n\tconst metrics = dedupe(metricList) as MetricKey[]\n\tif (metrics.length > MAX_QUERY_METRICS) {\n\t\treturn fail('invalid_param', `at most ${MAX_QUERY_METRICS} metrics are allowed`, 'metrics')\n\t}\n\tconst servedMetrics = new Set<string>(args.capabilities.metrics)\n\tconst unsupportedMetric = metrics.find((m) => !servedMetrics.has(m))\n\tif (unsupportedMetric !== undefined) {\n\t\treturn fail('unsupported_metric', `source does not serve ${unsupportedMetric}`, 'metrics')\n\t}\n\n\tconst rawDimensions = readParam(params, 'dimensions')\n\tconst dimensionList = rawDimensions ? commaList(rawDimensions) : []\n\tconst unknownDimension = dimensionList.find((d) => !KNOWN_DIMENSIONS.has(d))\n\tif (unknownDimension !== undefined) {\n\t\treturn fail('invalid_param', `unknown dimension: ${echo(unknownDimension)}`, 'dimensions')\n\t}\n\tconst dimensions = dedupe(dimensionList) as DimensionKey[]\n\tif (dimensions.length > MAX_QUERY_DIMENSIONS) {\n\t\treturn fail(\n\t\t\t'invalid_param',\n\t\t\t`at most ${MAX_QUERY_DIMENSIONS} dimensions are allowed`,\n\t\t\t'dimensions'\n\t\t)\n\t}\n\tconst servedDimensions = new Set<string>(args.capabilities.dimensions)\n\tconst unsupportedDimension = dimensions.find((d) => !servedDimensions.has(d))\n\tif (unsupportedDimension !== undefined) {\n\t\treturn fail(\n\t\t\t'unsupported_dimension',\n\t\t\t`source does not break down by ${unsupportedDimension}`,\n\t\t\t'dimensions'\n\t\t)\n\t}\n\n\tconst rawFrom = readParam(params, 'from')\n\tconst rawTo = readParam(params, 'to')\n\tif (!rawFrom) {\n\t\treturn fail('invalid_param', 'from is required', 'from')\n\t}\n\tconst start = parseDayOrInstant(rawFrom, { timezone, edge: 'start' })\n\tif (!start) {\n\t\treturn fail('invalid_param', `from is not a date: ${echo(rawFrom)}`, 'from')\n\t}\n\tif (!rawTo) {\n\t\treturn fail('invalid_param', 'to is required', 'to')\n\t}\n\tconst end = parseDayOrInstant(rawTo, { timezone, edge: 'end' })\n\tif (!end) {\n\t\treturn fail('invalid_param', `to is not a date: ${echo(rawTo)}`, 'to')\n\t}\n\tif (end.getTime() < start.getTime()) {\n\t\treturn fail('invalid_param', 'to must not be before from', 'to')\n\t}\n\tif (end.getTime() - start.getTime() > MAX_QUERY_RANGE_DAYS * DAY_MS) {\n\t\treturn fail('range_too_long', `the range must not exceed ${MAX_QUERY_RANGE_DAYS} days`, 'to')\n\t}\n\n\tconst rawGranularity = readParam(params, 'granularity')\n\tif (rawGranularity !== null && !KNOWN_GRANULARITIES.has(rawGranularity)) {\n\t\treturn fail('invalid_param', `unknown granularity: ${echo(rawGranularity)}`, 'granularity')\n\t}\n\tconst granularity = rawGranularity as Granularity | null\n\tif (\n\t\tgranularity !== null &&\n\t\tGRANULARITY_ORDER.indexOf(granularity) <\n\t\t\tGRANULARITY_ORDER.indexOf(args.capabilities.minGranularity)\n\t) {\n\t\treturn fail(\n\t\t\t'unsupported_granularity',\n\t\t\t`source buckets no finer than ${args.capabilities.minGranularity}`,\n\t\t\t'granularity'\n\t\t)\n\t}\n\n\tconst rawFilters = readParam(params, 'filters')\n\tconst filters = rawFilters === null ? [] : parseFilters(rawFilters, args.capabilities)\n\tif (!Array.isArray(filters)) {\n\t\treturn filters\n\t}\n\n\tconst rawLimit = readParam(params, 'limit')\n\tlet limit = DEFAULT_QUERY_LIMIT\n\tif (rawLimit !== null) {\n\t\tif (!/^\\d+$/.test(rawLimit)) {\n\t\t\treturn fail('invalid_param', `limit must be an integer: ${echo(rawLimit)}`, 'limit')\n\t\t}\n\t\tlimit = Number(rawLimit)\n\t\tif (limit < MIN_QUERY_LIMIT || limit > MAX_QUERY_LIMIT) {\n\t\t\treturn fail(\n\t\t\t\t'invalid_param',\n\t\t\t\t`limit must be between ${MIN_QUERY_LIMIT} and ${MAX_QUERY_LIMIT}`,\n\t\t\t\t'limit'\n\t\t\t)\n\t\t}\n\t}\n\n\tconst rawOrder = readParam(params, 'order')\n\tlet order: AnalyticsQuery['order']\n\tif (rawOrder !== null) {\n\t\tconst parts = rawOrder.split(':')\n\t\tconst metric = parts[0] ?? ''\n\t\tconst direction = parts[1] ?? ''\n\t\tif (parts.length !== 2 || (direction !== 'asc' && direction !== 'desc')) {\n\t\t\treturn fail('invalid_param', 'order must be <metric>:<asc|desc>', 'order')\n\t\t}\n\t\tconst ordered = metrics.find((m) => m === metric)\n\t\tif (ordered === undefined) {\n\t\t\treturn fail('invalid_param', `order metric is not in metrics: ${echo(metric)}`, 'order')\n\t\t}\n\t\torder = { metric: ordered, direction }\n\t}\n\n\tconst rawCompare = readParam(params, 'compare')\n\tif (rawCompare !== null && rawCompare !== 'previous') {\n\t\treturn fail('invalid_param', `compare must be \"previous\": ${echo(rawCompare)}`, 'compare')\n\t}\n\tif (rawCompare === 'previous' && !args.capabilities.comparison) {\n\t\treturn fail('invalid_param', 'source does not support comparison', 'compare')\n\t}\n\n\tconst path = readParam(params, 'path')\n\tif (path !== null && path.length > MAX_QUERY_PATH_LENGTH) {\n\t\treturn fail('invalid_param', `path must be at most ${MAX_QUERY_PATH_LENGTH} characters`, 'path')\n\t}\n\tconst hostname = readParam(params, 'hostname')\n\tif (hostname !== null && hostname.length > MAX_QUERY_HOSTNAME_LENGTH) {\n\t\treturn fail(\n\t\t\t'invalid_param',\n\t\t\t`hostname must be at most ${MAX_QUERY_HOSTNAME_LENGTH} characters`,\n\t\t\t'hostname'\n\t\t)\n\t}\n\n\tconst query: AnalyticsQuery = {\n\t\tmetrics,\n\t\tdateRange: { start, end },\n\t\tlimit,\n\t\ttimezone,\n\t\t...(dimensions.length > 0 ? { dimensions } : {}),\n\t\t...(granularity !== null ? { granularity } : {}),\n\t\t...(filters.length > 0 ? { filters } : {}),\n\t\t...(order ? { order } : {}),\n\t\t...(path !== null ? { path } : {}),\n\t\t...(hostname !== null ? { hostname } : {}),\n\t}\n\treturn {\n\t\tok: true,\n\t\tvalue: { query, compare: rawCompare === 'previous' ? 'previous' : null },\n\t}\n}\n"],"mappings":";;;;;;;AA8CA,MAAM,gBAAgB,IAAI,IAAY,OAAO,KAAK,WAAW,CAAC;AAC9D,MAAM,mBAAmB,IAAI,IAAY,cAAc;AACvD,MAAM,kBAAkB,IAAI,IAAY,gBAAgB;AACxD,MAAM,sBAAsB,IAAI,IAAY,iBAAiB;AAC7D,MAAM,SAAS;AAEf,MAAM,QAAQ,MAA8B,SAAiB,WAAgC;CAC5F,IAAI;CACJ,OAAO,eAAe,MAAM,SAAS,KAAK;AAC3C;;AAGA,MAAM,QAAQ,UAA2B,MAAM,SAAS,KAAK,GAAG,MAAM,MAAM,GAAG,EAAE,EAAE,OAAO;;;;;;AAO1F,MAAa,aAAa,QAAyB,SAAgC;CAClF,MAAM,MAAM,OAAO,IAAI,IAAI,GAAG,KAAK;CACnC,OAAO,MAAM,MAAM;AACpB;AAEA,MAAM,aAAa,QAClB,IACE,MAAM,GAAG,EACT,KAAK,SAAS,KAAK,KAAK,CAAC,EACzB,QAAQ,SAAS,KAAK,SAAS,CAAC;AAEnC,MAAM,UAA4B,WAAqB,CAAC,GAAG,IAAI,IAAI,MAAM,CAAC;AAE1E,MAAM,YAAY,UACjB,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAEpE,MAAM,gBACL,KACA,iBACqC;CACrC,IAAI;CACJ,IAAI;EACH,UAAU,KAAK,MAAM,GAAG;CACzB,QAAQ;EACP,OAAO,KAAK,iBAAiB,gCAAgC,SAAS;CACvE;CACA,IAAI,CAAC,MAAM,QAAQ,OAAO,GACzB,OAAO,KAAK,iBAAiB,gCAAgC,SAAS;CAEvE,IAAI,QAAQ,SAAA,IACX,OAAO,KAAK,iBAAiB,kCAAoD,SAAS;CAE3F,MAAM,aAAa,IAAI,IAAY,aAAa,OAAO;CACvD,MAAM,YAAY,IAAI,IAAY,aAAa,eAAe;CAC9D,MAAM,SAA4B,CAAC;CACnC,KAAK,MAAM,QAAQ,SAAS;EAC3B,IAAI,CAAC,SAAS,IAAI,GACjB,OAAO,KAAK,iBAAiB,iCAAiC,SAAS;EAExE,MAAM,EAAE,WAAW,UAAU,UAAU;EACvC,IAAI,OAAO,cAAc,YAAY,CAAC,iBAAiB,IAAI,SAAS,GACnE,OAAO,KACN,iBACA,6BAA6B,KAAK,OAAO,SAAS,CAAC,KACnD,SACD;EAED,IAAI,OAAO,aAAa,YAAY,CAAC,gBAAgB,IAAI,QAAQ,GAChE,OAAO,KAAK,iBAAiB,4BAA4B,KAAK,OAAO,QAAQ,CAAC,KAAK,SAAS;EAE7F,IAAI,OAAO,UAAU,UACpB,OAAO,KAAK,iBAAiB,sCAAsC,SAAS;EAE7E,MAAM,UAAU,MAAM,KAAK;EAC3B,IAAI,QAAQ,SAAS,KAAK,QAAQ,SAAA,KACjC,OAAO,KACN,iBACA,iDACA,SACD;EAED,IAAI,CAAC,WAAW,IAAI,SAAS,GAC5B,OAAO,KAAK,sBAAsB,2BAA2B,aAAa,SAAS;EAEpF,IAAI,CAAC,UAAU,IAAI,QAAQ,GAC1B,OAAO,KAAK,wBAAwB,2BAA2B,YAAY,SAAS;EAErF,OAAO,KAAK;GACA;GACD;GACV,OAAO;EACR,CAAC;CACF;CACA,OAAO;AACR;;;;;;;;;AAUA,MAAa,oBAAoB,QAAyB,SAAsC;CAC/F,MAAM,cAAc,UAAU,QAAQ,UAAU;CAChD,IAAI,gBAAgB,QAAQ,CAAC,gBAAgB,WAAW,GACvD,OAAO,KAAK,iBAAiB,qBAAqB,KAAK,WAAW,KAAK,UAAU;CAElF,MAAM,WAAW,eAAe,KAAK;CAErC,MAAM,aAAa,UAAU,QAAQ,SAAS;CAC9C,MAAM,aAAa,aAAa,UAAU,UAAU,IAAI,CAAC;CACzD,IAAI,WAAW,WAAW,GACzB,OAAO,KAAK,iBAAiB,uBAAuB,SAAS;CAE9D,MAAM,gBAAgB,WAAW,MAAM,MAAM,CAAC,cAAc,IAAI,CAAC,CAAC;CAClE,IAAI,kBAAkB,KAAA,GACrB,OAAO,KAAK,iBAAiB,mBAAmB,KAAK,aAAa,KAAK,SAAS;CAEjF,MAAM,UAAU,OAAO,UAAU;CACjC,IAAI,QAAQ,SAAA,IACX,OAAO,KAAK,iBAAiB,kCAAoD,SAAS;CAE3F,MAAM,gBAAgB,IAAI,IAAY,KAAK,aAAa,OAAO;CAC/D,MAAM,oBAAoB,QAAQ,MAAM,MAAM,CAAC,cAAc,IAAI,CAAC,CAAC;CACnE,IAAI,sBAAsB,KAAA,GACzB,OAAO,KAAK,sBAAsB,yBAAyB,qBAAqB,SAAS;CAG1F,MAAM,gBAAgB,UAAU,QAAQ,YAAY;CACpD,MAAM,gBAAgB,gBAAgB,UAAU,aAAa,IAAI,CAAC;CAClE,MAAM,mBAAmB,cAAc,MAAM,MAAM,CAAC,iBAAiB,IAAI,CAAC,CAAC;CAC3E,IAAI,qBAAqB,KAAA,GACxB,OAAO,KAAK,iBAAiB,sBAAsB,KAAK,gBAAgB,KAAK,YAAY;CAE1F,MAAM,aAAa,OAAO,aAAa;CACvC,IAAI,WAAW,SAAA,GACd,OAAO,KACN,iBACA,oCACA,YACD;CAED,MAAM,mBAAmB,IAAI,IAAY,KAAK,aAAa,UAAU;CACrE,MAAM,uBAAuB,WAAW,MAAM,MAAM,CAAC,iBAAiB,IAAI,CAAC,CAAC;CAC5E,IAAI,yBAAyB,KAAA,GAC5B,OAAO,KACN,yBACA,iCAAiC,wBACjC,YACD;CAGD,MAAM,UAAU,UAAU,QAAQ,MAAM;CACxC,MAAM,QAAQ,UAAU,QAAQ,IAAI;CACpC,IAAI,CAAC,SACJ,OAAO,KAAK,iBAAiB,oBAAoB,MAAM;CAExD,MAAM,QAAQ,kBAAkB,SAAS;EAAE;EAAU,MAAM;CAAQ,CAAC;CACpE,IAAI,CAAC,OACJ,OAAO,KAAK,iBAAiB,uBAAuB,KAAK,OAAO,KAAK,MAAM;CAE5E,IAAI,CAAC,OACJ,OAAO,KAAK,iBAAiB,kBAAkB,IAAI;CAEpD,MAAM,MAAM,kBAAkB,OAAO;EAAE;EAAU,MAAM;CAAM,CAAC;CAC9D,IAAI,CAAC,KACJ,OAAO,KAAK,iBAAiB,qBAAqB,KAAK,KAAK,KAAK,IAAI;CAEtE,IAAI,IAAI,QAAQ,IAAI,MAAM,QAAQ,GACjC,OAAO,KAAK,iBAAiB,8BAA8B,IAAI;CAEhE,IAAI,IAAI,QAAQ,IAAI,MAAM,QAAQ,IAAA,MAA2B,QAC5D,OAAO,KAAK,kBAAkB,sCAA0D,IAAI;CAG7F,MAAM,iBAAiB,UAAU,QAAQ,aAAa;CACtD,IAAI,mBAAmB,QAAQ,CAAC,oBAAoB,IAAI,cAAc,GACrE,OAAO,KAAK,iBAAiB,wBAAwB,KAAK,cAAc,KAAK,aAAa;CAE3F,MAAM,cAAc;CACpB,IACC,gBAAgB,QAChB,kBAAkB,QAAQ,WAAW,IACpC,kBAAkB,QAAQ,KAAK,aAAa,cAAc,GAE3D,OAAO,KACN,2BACA,gCAAgC,KAAK,aAAa,kBAClD,aACD;CAGD,MAAM,aAAa,UAAU,QAAQ,SAAS;CAC9C,MAAM,UAAU,eAAe,OAAO,CAAC,IAAI,aAAa,YAAY,KAAK,YAAY;CACrF,IAAI,CAAC,MAAM,QAAQ,OAAO,GACzB,OAAO;CAGR,MAAM,WAAW,UAAU,QAAQ,OAAO;CAC1C,IAAI,QAAA;CACJ,IAAI,aAAa,MAAM;EACtB,IAAI,CAAC,QAAQ,KAAK,QAAQ,GACzB,OAAO,KAAK,iBAAiB,6BAA6B,KAAK,QAAQ,KAAK,OAAO;EAEpF,QAAQ,OAAO,QAAQ;EACvB,IAAI,QAAA,KAA2B,QAAA,KAC9B,OAAO,KACN,iBACA,mCACA,OACD;CAEF;CAEA,MAAM,WAAW,UAAU,QAAQ,OAAO;CAC1C,IAAI;CACJ,IAAI,aAAa,MAAM;EACtB,MAAM,QAAQ,SAAS,MAAM,GAAG;EAChC,MAAM,SAAS,MAAM,MAAM;EAC3B,MAAM,YAAY,MAAM,MAAM;EAC9B,IAAI,MAAM,WAAW,KAAM,cAAc,SAAS,cAAc,QAC/D,OAAO,KAAK,iBAAiB,qCAAqC,OAAO;EAE1E,MAAM,UAAU,QAAQ,MAAM,MAAM,MAAM,MAAM;EAChD,IAAI,YAAY,KAAA,GACf,OAAO,KAAK,iBAAiB,mCAAmC,KAAK,MAAM,KAAK,OAAO;EAExF,QAAQ;GAAE,QAAQ;GAAS;EAAU;CACtC;CAEA,MAAM,aAAa,UAAU,QAAQ,SAAS;CAC9C,IAAI,eAAe,QAAQ,eAAe,YACzC,OAAO,KAAK,iBAAiB,+BAA+B,KAAK,UAAU,KAAK,SAAS;CAE1F,IAAI,eAAe,cAAc,CAAC,KAAK,aAAa,YACnD,OAAO,KAAK,iBAAiB,sCAAsC,SAAS;CAG7E,MAAM,OAAO,UAAU,QAAQ,MAAM;CACrC,IAAI,SAAS,QAAQ,KAAK,SAAA,KACzB,OAAO,KAAK,iBAAiB,uCAA4D,MAAM;CAEhG,MAAM,WAAW,UAAU,QAAQ,UAAU;CAC7C,IAAI,aAAa,QAAQ,SAAS,SAAA,KACjC,OAAO,KACN,iBACA,2CACA,UACD;CAeD,OAAO;EACN,IAAI;EACJ,OAAO;GAAE,OAAA;IAbT;IACA,WAAW;KAAE;KAAO;IAAI;IACxB;IACA;IACA,GAAI,WAAW,SAAS,IAAI,EAAE,WAAW,IAAI,CAAC;IAC9C,GAAI,gBAAgB,OAAO,EAAE,YAAY,IAAI,CAAC;IAC9C,GAAI,QAAQ,SAAS,IAAI,EAAE,QAAQ,IAAI,CAAC;IACxC,GAAI,QAAQ,EAAE,MAAM,IAAI,CAAC;IACzB,GAAI,SAAS,OAAO,EAAE,KAAK,IAAI,CAAC;IAChC,GAAI,aAAa,OAAO,EAAE,SAAS,IAAI,CAAC;GAI3B;GAAG,SAAS,eAAe,aAAa,aAAa;EAAK;CACxE;AACD"}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { AnalyticsQuery, AnalyticsResult } from "../core/contract.js";
|
|
2
|
+
import { SerializedCapabilities } from "../core/capabilities.js";
|
|
3
|
+
import { QueryError } from "./errors.js";
|
|
4
|
+
|
|
5
|
+
//#region src/query/response.d.ts
|
|
6
|
+
/** Identity of the source a read was served by; its capabilities travel beside it. */
|
|
7
|
+
interface QuerySourceRef {
|
|
8
|
+
id: string;
|
|
9
|
+
label: string;
|
|
10
|
+
/** `config` for an adapter every scope shares, `runtime` for one resolved per scope. */
|
|
11
|
+
kind: 'config' | 'runtime';
|
|
12
|
+
}
|
|
13
|
+
/** An `AnalyticsQuery` as it survives JSON: the date range's instants are ISO strings. */
|
|
14
|
+
type SerializedAnalyticsQuery = Omit<AnalyticsQuery, 'dateRange'> & {
|
|
15
|
+
dateRange: {
|
|
16
|
+
start: string;
|
|
17
|
+
end: string;
|
|
18
|
+
};
|
|
19
|
+
};
|
|
20
|
+
/** Successful answer of `GET /analytics/query`. */
|
|
21
|
+
interface QueryResponse {
|
|
22
|
+
result: AnalyticsResult;
|
|
23
|
+
/**
|
|
24
|
+
* The equal-length window before `query.dateRange`, asked for with `compare=previous`.
|
|
25
|
+
* Omitted when the source does not compare or that window is beyond its lookback.
|
|
26
|
+
*/
|
|
27
|
+
comparison?: AnalyticsResult;
|
|
28
|
+
source: QuerySourceRef;
|
|
29
|
+
capabilities: SerializedCapabilities;
|
|
30
|
+
/** The query after validation and defaulting, so a client renders what it actually got. */
|
|
31
|
+
query: SerializedAnalyticsQuery;
|
|
32
|
+
}
|
|
33
|
+
/** Every non-2xx answer of `GET /analytics/query`. */
|
|
34
|
+
interface QueryErrorResponse {
|
|
35
|
+
error: QueryError;
|
|
36
|
+
}
|
|
37
|
+
//#endregion
|
|
38
|
+
export { QueryErrorResponse, QueryResponse, QuerySourceRef, SerializedAnalyticsQuery };
|
|
39
|
+
//# sourceMappingURL=response.d.ts.map
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
//#region src/query/response.ts
|
|
2
|
+
/**
|
|
3
|
+
* Whether the echoed query asked about goals and the scope configured none. The hint is
|
|
4
|
+
* set only for a goal read, so an empty list is a scope with nothing to convert on: an
|
|
5
|
+
* empty table rather than a source that could not answer, which is `meta.goalsUnresolved`.
|
|
6
|
+
*/
|
|
7
|
+
const askedAboutNoGoals = (query) => Array.isArray(query?.goalSlugs) && query.goalSlugs.length === 0;
|
|
8
|
+
//#endregion
|
|
9
|
+
export { askedAboutNoGoals };
|
|
10
|
+
|
|
11
|
+
//# sourceMappingURL=response.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"response.js","names":[],"sources":["../../src/query/response.ts"],"sourcesContent":["import type { SerializedCapabilities } from '../core/capabilities'\nimport type { AnalyticsQuery, AnalyticsResult } from '../core/contract'\nimport type { QueryError } from './errors'\n\n/** Identity of the source a read was served by; its capabilities travel beside it. */\nexport interface QuerySourceRef {\n\tid: string\n\tlabel: string\n\t/** `config` for an adapter every scope shares, `runtime` for one resolved per scope. */\n\tkind: 'config' | 'runtime'\n}\n\n/** An `AnalyticsQuery` as it survives JSON: the date range's instants are ISO strings. */\nexport type SerializedAnalyticsQuery = Omit<AnalyticsQuery, 'dateRange'> & {\n\tdateRange: { start: string; end: string }\n}\n\n/** Successful answer of `GET /analytics/query`. */\nexport interface QueryResponse {\n\tresult: AnalyticsResult\n\t/**\n\t * The equal-length window before `query.dateRange`, asked for with `compare=previous`.\n\t * Omitted when the source does not compare or that window is beyond its lookback.\n\t */\n\tcomparison?: AnalyticsResult\n\tsource: QuerySourceRef\n\tcapabilities: SerializedCapabilities\n\t/** The query after validation and defaulting, so a client renders what it actually got. */\n\tquery: SerializedAnalyticsQuery\n}\n\n/**\n * Whether the echoed query asked about goals and the scope configured none. The hint is\n * set only for a goal read, so an empty list is a scope with nothing to convert on: an\n * empty table rather than a source that could not answer, which is `meta.goalsUnresolved`.\n */\nexport const askedAboutNoGoals = (query?: SerializedAnalyticsQuery): boolean =>\n\tArray.isArray(query?.goalSlugs) && query.goalSlugs.length === 0\n\n/** Every non-2xx answer of `GET /analytics/query`. */\nexport interface QueryErrorResponse {\n\terror: QueryError\n}\n"],"mappings":";;;;;;AAoCA,MAAa,qBAAqB,UACjC,MAAM,QAAQ,OAAO,SAAS,KAAK,MAAM,UAAU,WAAW"}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import { TrackerConfig } from "../capture/trackerConfig.js";
|
|
2
|
+
import { LoadScript, Tracker } from "../tracker/types.js";
|
|
3
|
+
import { ReactElement, ReactNode } from "react";
|
|
4
|
+
|
|
5
|
+
//#region src/react/AnalyticsProvider.d.ts
|
|
6
|
+
/** What a component can ask the tracker to do. Stable for the life of the provider. */
|
|
7
|
+
interface AnalyticsCommands {
|
|
8
|
+
track: Tracker['track'];
|
|
9
|
+
trackGoal: Tracker['trackGoal'];
|
|
10
|
+
consent: Tracker['consent'];
|
|
11
|
+
/** Takes this browser out of capture, or puts it back. */
|
|
12
|
+
setExcluded: Tracker['exclude'];
|
|
13
|
+
}
|
|
14
|
+
/** The tracker surface a component gets from `useAnalytics`. */
|
|
15
|
+
interface AnalyticsApi extends AnalyticsCommands {
|
|
16
|
+
/** True while this browser is excluded from capture. Flipping it re-renders the caller. */
|
|
17
|
+
excluded: boolean;
|
|
18
|
+
}
|
|
19
|
+
interface AnalyticsProviderProps {
|
|
20
|
+
/** Resolved server-side by `getTrackerConfig`, or fetched from the tracker endpoint. */
|
|
21
|
+
config: TrackerConfig;
|
|
22
|
+
children?: ReactNode;
|
|
23
|
+
/** CSP nonce applied to the vendor scripts the tracker injects. */
|
|
24
|
+
nonce?: string;
|
|
25
|
+
/** Replaces script injection, for a consent manager or a framework script loader. */
|
|
26
|
+
loadScript?: LoadScript;
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Shares the window's tracker with the tree through `useAnalytics`. Use it when components
|
|
30
|
+
* need to call `track`, `trackGoal`, or `consent` themselves; a page that only needs
|
|
31
|
+
* pageviews and auto-capture can render `<AnalyticsScripts />` (which boots
|
|
32
|
+
* `<TrackerBoot />`) and skip the provider. Rendering both is fine: the tracker is leased
|
|
33
|
+
* from a per-window registry, so there is still only one.
|
|
34
|
+
*
|
|
35
|
+
* The lease is taken lazily in the browser rather than during render, so server rendering
|
|
36
|
+
* stays inert and React's double-invoked render cannot leak a second tracker.
|
|
37
|
+
*
|
|
38
|
+
* Whichever component boots the tracker first owns its options, so a `nonce` or
|
|
39
|
+
* `loadScript` passed to a provider that mounts after `<TrackerBoot />` is ignored: give
|
|
40
|
+
* them to whatever boots first, or render only one of the two.
|
|
41
|
+
*/
|
|
42
|
+
declare const AnalyticsProvider: ({
|
|
43
|
+
config,
|
|
44
|
+
children,
|
|
45
|
+
nonce,
|
|
46
|
+
loadScript
|
|
47
|
+
}: AnalyticsProviderProps) => ReactElement;
|
|
48
|
+
//#endregion
|
|
49
|
+
export { AnalyticsApi, AnalyticsCommands, AnalyticsProvider, AnalyticsProviderProps };
|
|
50
|
+
//# sourceMappingURL=AnalyticsProvider.d.ts.map
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
import { acquireTracker } from "../tracker/registry.js";
|
|
3
|
+
import { createContext, useCallback, useEffect, useMemo, useRef } from "react";
|
|
4
|
+
import { jsx } from "react/jsx-runtime";
|
|
5
|
+
//#region src/react/AnalyticsProvider.tsx
|
|
6
|
+
const AnalyticsContext = createContext(null);
|
|
7
|
+
/**
|
|
8
|
+
* Shares the window's tracker with the tree through `useAnalytics`. Use it when components
|
|
9
|
+
* need to call `track`, `trackGoal`, or `consent` themselves; a page that only needs
|
|
10
|
+
* pageviews and auto-capture can render `<AnalyticsScripts />` (which boots
|
|
11
|
+
* `<TrackerBoot />`) and skip the provider. Rendering both is fine: the tracker is leased
|
|
12
|
+
* from a per-window registry, so there is still only one.
|
|
13
|
+
*
|
|
14
|
+
* The lease is taken lazily in the browser rather than during render, so server rendering
|
|
15
|
+
* stays inert and React's double-invoked render cannot leak a second tracker.
|
|
16
|
+
*
|
|
17
|
+
* Whichever component boots the tracker first owns its options, so a `nonce` or
|
|
18
|
+
* `loadScript` passed to a provider that mounts after `<TrackerBoot />` is ignored: give
|
|
19
|
+
* them to whatever boots first, or render only one of the two.
|
|
20
|
+
*/
|
|
21
|
+
const AnalyticsProvider = ({ config, children, nonce, loadScript }) => {
|
|
22
|
+
const boot = useRef({
|
|
23
|
+
config,
|
|
24
|
+
nonce,
|
|
25
|
+
loadScript
|
|
26
|
+
});
|
|
27
|
+
boot.current = {
|
|
28
|
+
config,
|
|
29
|
+
nonce,
|
|
30
|
+
loadScript
|
|
31
|
+
};
|
|
32
|
+
const lease = useRef(null);
|
|
33
|
+
const unmounted = useRef(false);
|
|
34
|
+
const ensure = useCallback(() => {
|
|
35
|
+
if (!lease.current && !unmounted.current && typeof window !== "undefined") {
|
|
36
|
+
const { config: current, nonce: currentNonce, loadScript: currentLoad } = boot.current;
|
|
37
|
+
lease.current = acquireTracker(current, {
|
|
38
|
+
nonce: currentNonce,
|
|
39
|
+
loadScript: currentLoad
|
|
40
|
+
});
|
|
41
|
+
}
|
|
42
|
+
return lease.current?.tracker ?? null;
|
|
43
|
+
}, []);
|
|
44
|
+
useEffect(() => {
|
|
45
|
+
unmounted.current = false;
|
|
46
|
+
ensure();
|
|
47
|
+
return () => {
|
|
48
|
+
unmounted.current = true;
|
|
49
|
+
lease.current?.release();
|
|
50
|
+
lease.current = null;
|
|
51
|
+
};
|
|
52
|
+
}, [ensure]);
|
|
53
|
+
const api = useMemo(() => ({
|
|
54
|
+
track: (name, props) => ensure()?.track(name, props),
|
|
55
|
+
trackGoal: (slug, opts) => ensure()?.trackGoal(slug, opts),
|
|
56
|
+
consent: (state) => ensure()?.consent(state),
|
|
57
|
+
setExcluded: (next) => ensure()?.exclude(next)
|
|
58
|
+
}), [ensure]);
|
|
59
|
+
return /* @__PURE__ */ jsx(AnalyticsContext.Provider, {
|
|
60
|
+
value: api,
|
|
61
|
+
children
|
|
62
|
+
});
|
|
63
|
+
};
|
|
64
|
+
//#endregion
|
|
65
|
+
export { AnalyticsContext, AnalyticsProvider };
|
|
66
|
+
|
|
67
|
+
//# sourceMappingURL=AnalyticsProvider.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"AnalyticsProvider.js","names":[],"sources":["../../src/react/AnalyticsProvider.tsx"],"sourcesContent":["'use client'\n\nimport {\n\tcreateContext,\n\ttype ReactElement,\n\ttype ReactNode,\n\tuseCallback,\n\tuseEffect,\n\tuseMemo,\n\tuseRef,\n} from 'react'\nimport type { TrackerConfig } from '../capture/trackerConfig'\nimport { acquireTracker, type TrackerLease } from '../tracker/registry'\nimport type { LoadScript, Tracker } from '../tracker/types'\n\n/** What a component can ask the tracker to do. Stable for the life of the provider. */\nexport interface AnalyticsCommands {\n\ttrack: Tracker['track']\n\ttrackGoal: Tracker['trackGoal']\n\tconsent: Tracker['consent']\n\t/** Takes this browser out of capture, or puts it back. */\n\tsetExcluded: Tracker['exclude']\n}\n\n/** The tracker surface a component gets from `useAnalytics`. */\nexport interface AnalyticsApi extends AnalyticsCommands {\n\t/** True while this browser is excluded from capture. Flipping it re-renders the caller. */\n\texcluded: boolean\n}\n\nexport const AnalyticsContext = createContext<AnalyticsCommands | null>(null)\n\nexport interface AnalyticsProviderProps {\n\t/** Resolved server-side by `getTrackerConfig`, or fetched from the tracker endpoint. */\n\tconfig: TrackerConfig\n\tchildren?: ReactNode\n\t/** CSP nonce applied to the vendor scripts the tracker injects. */\n\tnonce?: string\n\t/** Replaces script injection, for a consent manager or a framework script loader. */\n\tloadScript?: LoadScript\n}\n\n/**\n * Shares the window's tracker with the tree through `useAnalytics`. Use it when components\n * need to call `track`, `trackGoal`, or `consent` themselves; a page that only needs\n * pageviews and auto-capture can render `<AnalyticsScripts />` (which boots\n * `<TrackerBoot />`) and skip the provider. Rendering both is fine: the tracker is leased\n * from a per-window registry, so there is still only one.\n *\n * The lease is taken lazily in the browser rather than during render, so server rendering\n * stays inert and React's double-invoked render cannot leak a second tracker.\n *\n * Whichever component boots the tracker first owns its options, so a `nonce` or\n * `loadScript` passed to a provider that mounts after `<TrackerBoot />` is ignored: give\n * them to whatever boots first, or render only one of the two.\n */\nexport const AnalyticsProvider = ({\n\tconfig,\n\tchildren,\n\tnonce,\n\tloadScript,\n}: AnalyticsProviderProps): ReactElement => {\n\tconst boot = useRef({ config, nonce, loadScript })\n\tboot.current = { config, nonce, loadScript }\n\tconst lease = useRef<TrackerLease | null>(null)\n\tconst unmounted = useRef(false)\n\n\tconst ensure = useCallback((): Tracker | null => {\n\t\tif (!lease.current && !unmounted.current && typeof window !== 'undefined') {\n\t\t\tconst { config: current, nonce: currentNonce, loadScript: currentLoad } = boot.current\n\t\t\tlease.current = acquireTracker(current, { nonce: currentNonce, loadScript: currentLoad })\n\t\t}\n\t\treturn lease.current?.tracker ?? null\n\t}, [])\n\n\tuseEffect(() => {\n\t\tunmounted.current = false\n\t\tensure()\n\t\treturn () => {\n\t\t\t// A stale `track` call held past unmount must not resurrect the tracker.\n\t\t\tunmounted.current = true\n\t\t\tlease.current?.release()\n\t\t\tlease.current = null\n\t\t}\n\t}, [ensure])\n\n\tconst api = useMemo<AnalyticsCommands>(\n\t\t() => ({\n\t\t\ttrack: (name, props) => ensure()?.track(name, props),\n\t\t\ttrackGoal: (slug, opts) => ensure()?.trackGoal(slug, opts),\n\t\t\tconsent: (state) => ensure()?.consent(state),\n\t\t\tsetExcluded: (next) => ensure()?.exclude(next),\n\t\t}),\n\t\t[ensure]\n\t)\n\n\treturn <AnalyticsContext.Provider value={api}>{children}</AnalyticsContext.Provider>\n}\n"],"mappings":";;;;;AA8BA,MAAa,mBAAmB,cAAwC,IAAI;;;;;;;;;;;;;;;AA0B5E,MAAa,qBAAqB,EACjC,QACA,UACA,OACA,iBAC2C;CAC3C,MAAM,OAAO,OAAO;EAAE;EAAQ;EAAO;CAAW,CAAC;CACjD,KAAK,UAAU;EAAE;EAAQ;EAAO;CAAW;CAC3C,MAAM,QAAQ,OAA4B,IAAI;CAC9C,MAAM,YAAY,OAAO,KAAK;CAE9B,MAAM,SAAS,kBAAkC;EAChD,IAAI,CAAC,MAAM,WAAW,CAAC,UAAU,WAAW,OAAO,WAAW,aAAa;GAC1E,MAAM,EAAE,QAAQ,SAAS,OAAO,cAAc,YAAY,gBAAgB,KAAK;GAC/E,MAAM,UAAU,eAAe,SAAS;IAAE,OAAO;IAAc,YAAY;GAAY,CAAC;EACzF;EACA,OAAO,MAAM,SAAS,WAAW;CAClC,GAAG,CAAC,CAAC;CAEL,gBAAgB;EACf,UAAU,UAAU;EACpB,OAAO;EACP,aAAa;GAEZ,UAAU,UAAU;GACpB,MAAM,SAAS,QAAQ;GACvB,MAAM,UAAU;EACjB;CACD,GAAG,CAAC,MAAM,CAAC;CAEX,MAAM,MAAM,eACJ;EACN,QAAQ,MAAM,UAAU,OAAO,GAAG,MAAM,MAAM,KAAK;EACnD,YAAY,MAAM,SAAS,OAAO,GAAG,UAAU,MAAM,IAAI;EACzD,UAAU,UAAU,OAAO,GAAG,QAAQ,KAAK;EAC3C,cAAc,SAAS,OAAO,GAAG,QAAQ,IAAI;CAC9C,IACA,CAAC,MAAM,CACR;CAEA,OAAO,oBAAC,iBAAiB,UAAlB;EAA2B,OAAO;EAAM;CAAoC,CAAA;AACpF"}
|