@10x-media/analytics 0.1.0-beta.5 → 1.0.0-beta.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +270 -0
- package/LICENSE +21 -21
- package/README.md +15 -4
- package/dist/adapters/ga4/disableKey.d.ts +9 -0
- package/dist/adapters/ga4/disableKey.js +21 -0
- package/dist/adapters/ga4/disableKey.js.map +1 -0
- package/dist/adapters/ga4/eventName.d.ts +15 -0
- package/dist/adapters/ga4/eventName.js +19 -0
- package/dist/adapters/ga4/eventName.js.map +1 -0
- package/dist/adapters/ga4/ga4.d.ts +5 -0
- package/dist/adapters/ga4/ga4.js +186 -58
- package/dist/adapters/ga4/ga4.js.map +1 -1
- package/dist/adapters/ga4/measurementId.js +15 -0
- package/dist/adapters/ga4/measurementId.js.map +1 -0
- package/dist/adapters/goalRead.js +126 -0
- package/dist/adapters/goalRead.js.map +1 -0
- package/dist/adapters/http/fetchJson.js +1 -1
- package/dist/adapters/plausible/plausible.d.ts +25 -0
- package/dist/adapters/plausible/plausible.js +159 -38
- package/dist/adapters/plausible/plausible.js.map +1 -1
- package/dist/adapters/posthog/posthog.d.ts +10 -1
- package/dist/adapters/posthog/posthog.js +130 -21
- package/dist/adapters/posthog/posthog.js.map +1 -1
- package/dist/adapters/series.js +11 -1
- package/dist/adapters/series.js.map +1 -1
- package/dist/adapters/umami/umami.d.ts +13 -1
- package/dist/adapters/umami/umami.js +278 -26
- package/dist/adapters/umami/umami.js.map +1 -1
- package/dist/binding/resolvePath.js +18 -2
- package/dist/binding/resolvePath.js.map +1 -1
- package/dist/capture/getTrackerConfig.d.ts +20 -0
- package/dist/capture/getTrackerConfig.js +31 -0
- package/dist/capture/getTrackerConfig.js.map +1 -0
- package/dist/capture/mountPath.js +14 -0
- package/dist/capture/mountPath.js.map +1 -0
- package/dist/capture/proxyEndpoint.js +127 -0
- package/dist/capture/proxyEndpoint.js.map +1 -0
- package/dist/capture/proxyRoutes.js +108 -0
- package/dist/capture/proxyRoutes.js.map +1 -0
- package/dist/capture/requestBody.js +68 -0
- package/dist/capture/requestBody.js.map +1 -0
- package/dist/capture/slots.d.ts +8 -0
- package/dist/capture/slots.js +54 -0
- package/dist/capture/slots.js.map +1 -0
- package/dist/capture/trackerConfig.d.ts +33 -0
- package/dist/capture/trackerConfig.js +95 -0
- package/dist/capture/trackerConfig.js.map +1 -0
- package/dist/capture/trackerEndpoint.js +35 -0
- package/dist/capture/trackerEndpoint.js.map +1 -0
- package/dist/charts/BarList.d.ts +16 -1
- package/dist/charts/BarList.js +41 -19
- package/dist/charts/BarList.js.map +1 -1
- package/dist/charts/TrendChart.d.ts +16 -3
- package/dist/charts/TrendChart.js +172 -106
- package/dist/charts/TrendChart.js.map +1 -1
- package/dist/charts/bars.d.ts +4 -0
- package/dist/charts/bars.js +3 -1
- package/dist/charts/bars.js.map +1 -1
- package/dist/charts/bucket.js +10 -1
- package/dist/charts/bucket.js.map +1 -1
- package/dist/charts/spline.js +2 -2
- package/dist/charts/spline.js.map +1 -1
- package/dist/charts/styles.js +18 -1
- package/dist/charts/styles.js.map +1 -1
- package/dist/core/cacheKey.js +26 -3
- package/dist/core/cacheKey.js.map +1 -1
- package/dist/core/capabilities.d.ts +5 -1
- package/dist/core/capabilities.js +11 -2
- package/dist/core/capabilities.js.map +1 -1
- package/dist/core/capture.d.ts +49 -0
- package/dist/core/contract.d.ts +74 -5
- package/dist/core/contract.js +30 -1
- package/dist/core/contract.js.map +1 -1
- package/dist/core/granularity.js +1 -1
- package/dist/core/options.d.ts +164 -6
- package/dist/core/options.js +126 -3
- package/dist/core/options.js.map +1 -1
- package/dist/core/registry.d.ts +1 -0
- package/dist/core/scopeList.js +32 -0
- package/dist/core/scopeList.js.map +1 -0
- package/dist/core/scopedRead.js +101 -30
- package/dist/core/scopedRead.js.map +1 -1
- package/dist/core/serverEvent.d.ts +60 -0
- package/dist/core/serverEvent.js +12 -0
- package/dist/core/serverEvent.js.map +1 -0
- package/dist/exports/adapters/ga4.d.ts +2 -1
- package/dist/exports/adapters/ga4.js +2 -1
- package/dist/exports/adapters/native.d.ts +3 -1
- package/dist/exports/adapters/native.js +2 -1
- package/dist/exports/client.d.ts +13 -3
- package/dist/exports/client.js +10 -1
- package/dist/exports/geo.d.ts +2 -2
- package/dist/exports/next.d.ts +2 -1
- package/dist/exports/next.js +2 -1
- package/dist/exports/react.d.ts +4 -0
- package/dist/exports/react.js +5 -0
- package/dist/exports/rsc.d.ts +11 -3
- package/dist/exports/rsc.js +7 -2
- package/dist/exports/tracker.d.ts +21 -0
- package/dist/exports/tracker.js +15 -0
- package/dist/exports/types.d.ts +16 -3
- package/dist/exports/types.js +4 -2
- package/dist/fields/AnalyticsPanelClient.js +2 -2
- package/dist/fields/AnalyticsPanelField.js +1 -1
- package/dist/fields/AnalyticsStatField.js +2 -2
- package/dist/fields/config/FilterDimensionSelectField.d.ts +14 -0
- package/dist/fields/config/FilterDimensionSelectField.js +77 -0
- package/dist/fields/config/FilterDimensionSelectField.js.map +1 -0
- package/dist/fields/config/FilterOperatorSelectField.d.ts +14 -0
- package/dist/fields/config/FilterOperatorSelectField.js +75 -0
- package/dist/fields/config/FilterOperatorSelectField.js.map +1 -0
- package/dist/fields/config/MetricSelectField.js +3 -3
- package/dist/fields/config/MetricSelectField.js.map +1 -1
- package/dist/fields/config/SourceSelectField.js +3 -3
- package/dist/fields/config/SourceSelectField.js.map +1 -1
- package/dist/fields/config/fetchSources.d.ts +5 -1
- package/dist/fields/config/fetchSources.js +7 -3
- package/dist/fields/config/fetchSources.js.map +1 -1
- package/dist/fields/config/narrow.js +2 -0
- package/dist/fields/config/narrow.js.map +1 -1
- package/dist/fields/config/sourcesState.js +19 -3
- package/dist/fields/config/sourcesState.js.map +1 -1
- package/dist/fields/config/useAnalyticsSources.d.ts +8 -3
- package/dist/fields/config/useAnalyticsSources.js +9 -6
- package/dist/fields/config/useAnalyticsSources.js.map +1 -1
- package/dist/fields/config/useFilterCapabilities.d.ts +28 -0
- package/dist/fields/config/useFilterCapabilities.js +52 -0
- package/dist/fields/config/useFilterCapabilities.js.map +1 -0
- package/dist/fields/readForDocument.d.ts +5 -0
- package/dist/fields/readForDocument.js +22 -10
- package/dist/fields/readForDocument.js.map +1 -1
- package/dist/goals/GoalSelectField.d.ts +7 -0
- package/dist/goals/GoalSelectField.js +77 -0
- package/dist/goals/GoalSelectField.js.map +1 -0
- package/dist/goals/collection.js +254 -0
- package/dist/goals/collection.js.map +1 -0
- package/dist/goals/currency.js +14 -0
- package/dist/goals/currency.js.map +1 -0
- package/dist/goals/fetchGoals.d.ts +18 -0
- package/dist/goals/fetchGoals.js +33 -0
- package/dist/goals/fetchGoals.js.map +1 -0
- package/dist/goals/goalField.d.ts +31 -0
- package/dist/goals/goalField.js +56 -0
- package/dist/goals/goalField.js.map +1 -0
- package/dist/goals/goalsEndpoint.d.ts +1 -0
- package/dist/goals/goalsEndpoint.js +58 -0
- package/dist/goals/goalsEndpoint.js.map +1 -0
- package/dist/goals/match.js +64 -0
- package/dist/goals/match.js.map +1 -0
- package/dist/goals/resolver.d.ts +8 -0
- package/dist/goals/resolver.js +147 -0
- package/dist/goals/resolver.js.map +1 -0
- package/dist/goals/trackGoalAction.d.ts +76 -0
- package/dist/goals/trackGoalAction.js +158 -0
- package/dist/goals/trackGoalAction.js.map +1 -0
- package/dist/goals/types.d.ts +33 -0
- package/dist/goals/types.js +7 -0
- package/dist/goals/types.js.map +1 -0
- package/dist/goals/useAnalyticsGoals.d.ts +20 -0
- package/dist/goals/useAnalyticsGoals.js +67 -0
- package/dist/goals/useAnalyticsGoals.js.map +1 -0
- package/dist/index.d.ts +14 -3
- package/dist/index.js +174 -19
- package/dist/index.js.map +1 -1
- package/dist/native/collections/events.js +65 -1
- package/dist/native/collections/events.js.map +1 -1
- package/dist/native/collections/rollups.js +39 -3
- package/dist/native/collections/rollups.js.map +1 -1
- package/dist/native/eventScan.js +25 -0
- package/dist/native/eventScan.js.map +1 -0
- package/dist/native/geo/composeGeoResolvers.js +2 -2
- package/dist/native/geo/composeGeoResolvers.js.map +1 -1
- package/dist/native/geo/geoResolver.d.ts +9 -2
- package/dist/native/geo/geoResolver.js.map +1 -1
- package/dist/native/geo/maxmindResolver.js +3 -5
- package/dist/native/geo/maxmindResolver.js.map +1 -1
- package/dist/native/ingest/bots.d.ts +11 -0
- package/dist/native/ingest/bots.js +71 -0
- package/dist/native/ingest/bots.js.map +1 -0
- package/dist/native/ingest/browser.js +47 -0
- package/dist/native/ingest/browser.js.map +1 -0
- package/dist/native/ingest/clientIp.js +20 -0
- package/dist/native/ingest/clientIp.js.map +1 -0
- package/dist/native/ingest/device.js +11 -3
- package/dist/native/ingest/device.js.map +1 -1
- package/dist/native/ingest/endpoint.d.ts +1 -0
- package/dist/native/ingest/endpoint.js +107 -21
- package/dist/native/ingest/endpoint.js.map +1 -1
- package/dist/native/ingest/flushBatch.js +29 -38
- package/dist/native/ingest/flushBatch.js.map +1 -1
- package/dist/native/ingest/language.js +14 -0
- package/dist/native/ingest/language.js.map +1 -0
- package/dist/native/ingest/normalizeEvent.d.ts +30 -0
- package/dist/native/ingest/normalizeEvent.js +115 -16
- package/dist/native/ingest/normalizeEvent.js.map +1 -1
- package/dist/native/ingest/referrer.js +48 -0
- package/dist/native/ingest/referrer.js.map +1 -0
- package/dist/native/ingest/requestHost.js +57 -0
- package/dist/native/ingest/requestHost.js.map +1 -0
- package/dist/native/ingest/resolveHostname.d.ts +29 -0
- package/dist/native/ingest/resolveHostname.js +52 -0
- package/dist/native/ingest/resolveHostname.js.map +1 -0
- package/dist/native/ingest/salt.js +27 -2
- package/dist/native/ingest/salt.js.map +1 -1
- package/dist/native/ingest/serverTrack.d.ts +20 -0
- package/dist/native/ingest/serverTrack.js +109 -0
- package/dist/native/ingest/serverTrack.js.map +1 -0
- package/dist/native/ingest/source.d.ts +11 -0
- package/dist/native/ingest/source.js +264 -16
- package/dist/native/ingest/source.js.map +1 -1
- package/dist/native/ingest/utm.js +33 -0
- package/dist/native/ingest/utm.js.map +1 -0
- package/dist/native/ingest/validate.js +26 -0
- package/dist/native/ingest/validate.js.map +1 -0
- package/dist/native/nativeAdapter.d.ts +37 -1
- package/dist/native/nativeAdapter.js +175 -22
- package/dist/native/nativeAdapter.js.map +1 -1
- package/dist/native/query/eventAgg.js +175 -0
- package/dist/native/query/eventAgg.js.map +1 -0
- package/dist/native/retention/pruneTask.js +53 -13
- package/dist/native/retention/pruneTask.js.map +1 -1
- package/dist/native/rollupAcc.js +12 -1
- package/dist/native/rollupAcc.js.map +1 -1
- package/dist/native/rollups/bucketKey.js +15 -0
- package/dist/native/rollups/bucketKey.js.map +1 -0
- package/dist/native/rollups/bumpRollups.js +116 -0
- package/dist/native/rollups/bumpRollups.js.map +1 -0
- package/dist/native/rollups/deltas.js +86 -11
- package/dist/native/rollups/deltas.js.map +1 -1
- package/dist/native/rollups/insertManyIfNew.js +93 -0
- package/dist/native/rollups/insertManyIfNew.js.map +1 -0
- package/dist/next/captureRewrites.d.ts +42 -0
- package/dist/next/captureRewrites.js +57 -0
- package/dist/next/captureRewrites.js.map +1 -0
- package/dist/next/posthogProxyRewrites.d.ts +5 -0
- package/dist/next/posthogProxyRewrites.js +16 -21
- package/dist/next/posthogProxyRewrites.js.map +1 -1
- package/dist/plugin/documentEndpoint.js +71 -24
- package/dist/plugin/documentEndpoint.js.map +1 -1
- package/dist/plugin/errors.d.ts +31 -0
- package/dist/plugin/errors.js +79 -0
- package/dist/plugin/errors.js.map +1 -0
- package/dist/plugin/goalHint.d.ts +1 -0
- package/dist/plugin/goalHint.js +24 -0
- package/dist/plugin/goalHint.js.map +1 -0
- package/dist/plugin/paths.js +17 -1
- package/dist/plugin/paths.js.map +1 -1
- package/dist/plugin/queryEndpoint.js +124 -0
- package/dist/plugin/queryEndpoint.js.map +1 -0
- package/dist/plugin/readContextForRequest.js +73 -0
- package/dist/plugin/readContextForRequest.js.map +1 -0
- package/dist/plugin/realtimeEndpoint.js +37 -16
- package/dist/plugin/realtimeEndpoint.js.map +1 -1
- package/dist/plugin/refreshEndpoint.js +113 -0
- package/dist/plugin/refreshEndpoint.js.map +1 -0
- package/dist/plugin/runtime.d.ts +1 -0
- package/dist/plugin/runtime.js +33 -1
- package/dist/plugin/runtime.js.map +1 -1
- package/dist/plugin/scopeChange.js +22 -0
- package/dist/plugin/scopeChange.js.map +1 -0
- package/dist/plugin/scopeFieldBoot.js +22 -0
- package/dist/plugin/scopeFieldBoot.js.map +1 -0
- package/dist/plugin/sourcesEndpoint.js +16 -41
- package/dist/plugin/sourcesEndpoint.js.map +1 -1
- package/dist/plugin/warmTask.js +0 -0
- package/dist/plugin/warmTask.js.map +1 -1
- package/dist/providers/collection.js +89 -29
- package/dist/providers/collection.js.map +1 -1
- package/dist/providers/factory.js +11 -3
- package/dist/providers/factory.js.map +1 -1
- package/dist/providers/resolver.js.map +1 -1
- package/dist/query/dates.js +64 -0
- package/dist/query/dates.js.map +1 -0
- package/dist/query/errors.d.ts +14 -0
- package/dist/query/fetchQuery.d.ts +79 -0
- package/dist/query/fetchQuery.js +117 -0
- package/dist/query/fetchQuery.js.map +1 -0
- package/dist/query/parse.d.ts +22 -0
- package/dist/query/parse.js +168 -0
- package/dist/query/parse.js.map +1 -0
- package/dist/query/response.d.ts +39 -0
- package/dist/query/response.js +11 -0
- package/dist/query/response.js.map +1 -0
- package/dist/react/AnalyticsProvider.d.ts +50 -0
- package/dist/react/AnalyticsProvider.js +67 -0
- package/dist/react/AnalyticsProvider.js.map +1 -0
- package/dist/react/TrackerBoot.d.ts +22 -0
- package/dist/react/TrackerBoot.js +30 -0
- package/dist/react/TrackerBoot.js.map +1 -0
- package/dist/react/useAnalytics.d.ts +20 -0
- package/dist/react/useAnalytics.js +52 -0
- package/dist/react/useAnalytics.js.map +1 -0
- package/dist/rsc/AnalyticsScripts.d.ts +30 -0
- package/dist/rsc/AnalyticsScripts.js +41 -0
- package/dist/rsc/AnalyticsScripts.js.map +1 -0
- package/dist/surfacing/cacheStore.d.ts +1 -0
- package/dist/surfacing/cacheStore.js +18 -2
- package/dist/surfacing/cacheStore.js.map +1 -1
- package/dist/surfacing/engine.d.ts +1 -0
- package/dist/surfacing/engine.js +47 -6
- package/dist/surfacing/engine.js.map +1 -1
- package/dist/surfacing/epoch.d.ts +1 -0
- package/dist/surfacing/epoch.js +72 -0
- package/dist/surfacing/epoch.js.map +1 -0
- package/dist/surfacing/queue.js +22 -6
- package/dist/surfacing/queue.js.map +1 -1
- package/dist/surfacing/rateLimiter.js +130 -0
- package/dist/surfacing/rateLimiter.js.map +1 -0
- package/dist/surfacing/retryPolicy.js +15 -0
- package/dist/surfacing/retryPolicy.js.map +1 -0
- package/dist/sync/collection.js +23 -7
- package/dist/sync/collection.js.map +1 -1
- package/dist/sync/syncTask.js +68 -33
- package/dist/sync/syncTask.js.map +1 -1
- package/dist/testing/memoryAdapter.d.ts +2 -0
- package/dist/testing/memoryAdapter.js +17 -1
- package/dist/testing/memoryAdapter.js.map +1 -1
- package/dist/timeframe/tz.js +17 -6
- package/dist/timeframe/tz.js.map +1 -1
- package/dist/tracker/autoCapture.d.ts +48 -0
- package/dist/tracker/autoCapture.js +129 -0
- package/dist/tracker/autoCapture.js.map +1 -0
- package/dist/tracker/consent.d.ts +24 -0
- package/dist/tracker/consent.js +48 -0
- package/dist/tracker/consent.js.map +1 -0
- package/dist/tracker/createTracker.d.ts +18 -0
- package/dist/tracker/createTracker.js +215 -0
- package/dist/tracker/createTracker.js.map +1 -0
- package/dist/tracker/exclusion.d.ts +28 -0
- package/dist/tracker/exclusion.js +50 -0
- package/dist/tracker/exclusion.js.map +1 -0
- package/dist/tracker/initTracker.d.ts +22 -0
- package/dist/tracker/initTracker.js +33 -0
- package/dist/tracker/initTracker.js.map +1 -0
- package/dist/tracker/loadScript.d.ts +14 -0
- package/dist/tracker/loadScript.js +41 -0
- package/dist/tracker/loadScript.js.map +1 -0
- package/dist/tracker/pageTracking.d.ts +17 -0
- package/dist/tracker/pageTracking.js +38 -0
- package/dist/tracker/pageTracking.js.map +1 -0
- package/dist/tracker/registry.d.ts +27 -0
- package/dist/tracker/registry.js +73 -0
- package/dist/tracker/registry.js.map +1 -0
- package/dist/tracker/sinks/ga4.d.ts +29 -0
- package/dist/tracker/sinks/ga4.js +30 -0
- package/dist/tracker/sinks/ga4.js.map +1 -0
- package/dist/tracker/sinks/native.d.ts +22 -0
- package/dist/tracker/sinks/native.js +56 -0
- package/dist/tracker/sinks/native.js.map +1 -0
- package/dist/tracker/sinks/plausible.d.ts +20 -0
- package/dist/tracker/sinks/plausible.js +32 -0
- package/dist/tracker/sinks/plausible.js.map +1 -0
- package/dist/tracker/sinks/posthog.d.ts +18 -0
- package/dist/tracker/sinks/posthog.js +30 -0
- package/dist/tracker/sinks/posthog.js.map +1 -0
- package/dist/tracker/sinks/umami.d.ts +18 -0
- package/dist/tracker/sinks/umami.js +23 -0
- package/dist/tracker/sinks/umami.js.map +1 -0
- package/dist/tracker/sinks/vendor.d.ts +14 -0
- package/dist/tracker/sinks/vendor.js +81 -0
- package/dist/tracker/sinks/vendor.js.map +1 -0
- package/dist/tracker/transport.js +28 -0
- package/dist/tracker/transport.js.map +1 -0
- package/dist/tracker/types.d.ts +91 -0
- package/dist/translations/ar.js +221 -0
- package/dist/translations/ar.js.map +1 -0
- package/dist/translations/de.js +145 -1
- package/dist/translations/de.js.map +1 -1
- package/dist/translations/en.js +145 -1
- package/dist/translations/en.js.map +1 -1
- package/dist/translations/es.js +221 -0
- package/dist/translations/es.js.map +1 -0
- package/dist/translations/fr.js +221 -0
- package/dist/translations/fr.js.map +1 -0
- package/dist/translations/id.js +221 -0
- package/dist/translations/id.js.map +1 -0
- package/dist/translations/index.d.ts +10 -1
- package/dist/translations/index.js +19 -1
- package/dist/translations/index.js.map +1 -1
- package/dist/translations/keys.d.ts +144 -0
- package/dist/translations/keys.js +145 -1
- package/dist/translations/keys.js.map +1 -1
- package/dist/translations/ko.js +221 -0
- package/dist/translations/ko.js.map +1 -0
- package/dist/translations/metricKeys.js +8 -2
- package/dist/translations/metricKeys.js.map +1 -1
- package/dist/translations/pt.js +221 -0
- package/dist/translations/pt.js.map +1 -0
- package/dist/translations/ru.js +221 -0
- package/dist/translations/ru.js.map +1 -0
- package/dist/translations/server.js.map +1 -1
- package/dist/translations/uk.js +221 -0
- package/dist/translations/uk.js.map +1 -0
- package/dist/translations/zh.js +221 -0
- package/dist/translations/zh.js.map +1 -0
- package/dist/view/AnalyticsNavLink.d.ts +19 -0
- package/dist/view/AnalyticsNavLink.js +40 -0
- package/dist/view/AnalyticsNavLink.js.map +1 -0
- package/dist/view/AnalyticsView.d.ts +23 -0
- package/dist/view/AnalyticsView.js +45 -0
- package/dist/view/AnalyticsView.js.map +1 -0
- package/dist/view/AnalyticsViewClient.d.ts +15 -0
- package/dist/view/AnalyticsViewClient.js +244 -0
- package/dist/view/AnalyticsViewClient.js.map +1 -0
- package/dist/view/authRedirect.js +32 -0
- package/dist/view/authRedirect.js.map +1 -0
- package/dist/view/conversionRate.js +18 -0
- package/dist/view/conversionRate.js.map +1 -0
- package/dist/view/dayRange.js +68 -0
- package/dist/view/dayRange.js.map +1 -0
- package/dist/view/gating.d.ts +1 -0
- package/dist/view/gating.js +142 -0
- package/dist/view/gating.js.map +1 -0
- package/dist/view/labels.js +76 -0
- package/dist/view/labels.js.map +1 -0
- package/dist/view/registerView.js +48 -0
- package/dist/view/registerView.js.map +1 -0
- package/dist/view/sections/Breakdowns.js +198 -0
- package/dist/view/sections/Breakdowns.js.map +1 -0
- package/dist/view/sections/EmptyStates.js +92 -0
- package/dist/view/sections/EmptyStates.js.map +1 -0
- package/dist/view/sections/FilterChips.js +46 -0
- package/dist/view/sections/FilterChips.js.map +1 -0
- package/dist/view/sections/GoalsPanel.js +82 -0
- package/dist/view/sections/GoalsPanel.js.map +1 -0
- package/dist/view/sections/OverviewCards.js +65 -0
- package/dist/view/sections/OverviewCards.js.map +1 -0
- package/dist/view/sections/RealtimeStrip.js +80 -0
- package/dist/view/sections/RealtimeStrip.js.map +1 -0
- package/dist/view/sections/Toolbar.js +207 -0
- package/dist/view/sections/Toolbar.js.map +1 -0
- package/dist/view/sections/Trend.js +125 -0
- package/dist/view/sections/Trend.js.map +1 -0
- package/dist/view/sections/styles.js +76 -0
- package/dist/view/sections/styles.js.map +1 -0
- package/dist/view/state.js +211 -0
- package/dist/view/state.js.map +1 -0
- package/dist/view/useViewQueries.js +153 -0
- package/dist/view/useViewQueries.js.map +1 -0
- package/dist/view/viewProps.d.ts +40 -0
- package/dist/view/viewProps.js +90 -0
- package/dist/view/viewProps.js.map +1 -0
- package/dist/widgets/AnalyticsBreakdownWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsBreakdownWidget.js +78 -11
- package/dist/widgets/AnalyticsBreakdownWidget.js.map +1 -1
- package/dist/widgets/AnalyticsGoalsWidget.d.ts +14 -0
- package/dist/widgets/AnalyticsGoalsWidget.js +196 -0
- package/dist/widgets/AnalyticsGoalsWidget.js.map +1 -0
- package/dist/widgets/AnalyticsMetricWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsMetricWidget.js +63 -13
- package/dist/widgets/AnalyticsMetricWidget.js.map +1 -1
- package/dist/widgets/AnalyticsRealtimeWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsRealtimeWidget.js +44 -22
- package/dist/widgets/AnalyticsRealtimeWidget.js.map +1 -1
- package/dist/widgets/AnalyticsTrendWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsTrendWidget.js +79 -16
- package/dist/widgets/AnalyticsTrendWidget.js.map +1 -1
- package/dist/widgets/RealtimeCounter.d.ts +4 -0
- package/dist/widgets/RealtimeCounter.js +18 -4
- package/dist/widgets/RealtimeCounter.js.map +1 -1
- package/dist/widgets/WidgetViewLink.js +17 -0
- package/dist/widgets/WidgetViewLink.js.map +1 -0
- package/dist/widgets/breakdownTypes.js +38 -0
- package/dist/widgets/breakdownTypes.js.map +1 -1
- package/dist/widgets/cardChrome.js +31 -7
- package/dist/widgets/cardChrome.js.map +1 -1
- package/dist/widgets/comparison.js +15 -1
- package/dist/widgets/comparison.js.map +1 -1
- package/dist/widgets/defaults.d.ts +6 -2
- package/dist/widgets/defaults.js +78 -23
- package/dist/widgets/defaults.js.map +1 -1
- package/dist/widgets/filterCaption.js +27 -0
- package/dist/widgets/filterCaption.js.map +1 -0
- package/dist/widgets/filterField.d.ts +19 -0
- package/dist/widgets/filterField.js +75 -0
- package/dist/widgets/filterField.js.map +1 -0
- package/dist/widgets/prepareWidgetRead.d.ts +7 -0
- package/dist/widgets/prepareWidgetRead.js +74 -0
- package/dist/widgets/prepareWidgetRead.js.map +1 -0
- package/dist/widgets/range.js +43 -12
- package/dist/widgets/range.js.map +1 -1
- package/dist/widgets/readForWidget.d.ts +26 -3
- package/dist/widgets/readForWidget.js +48 -44
- package/dist/widgets/readForWidget.js.map +1 -1
- package/dist/widgets/readForWidgetBreakdown.d.ts +34 -2
- package/dist/widgets/readForWidgetBreakdown.js +53 -49
- package/dist/widgets/readForWidgetBreakdown.js.map +1 -1
- package/dist/widgets/readForWidgetGoals.d.ts +67 -0
- package/dist/widgets/readForWidgetGoals.js +140 -0
- package/dist/widgets/readForWidgetGoals.js.map +1 -0
- package/dist/widgets/readForWidgetRealtime.d.ts +8 -0
- package/dist/widgets/readForWidgetRealtime.js +23 -21
- package/dist/widgets/readForWidgetRealtime.js.map +1 -1
- package/dist/widgets/readForWidgetSeries.d.ts +26 -2
- package/dist/widgets/readForWidgetSeries.js +78 -53
- package/dist/widgets/readForWidgetSeries.js.map +1 -1
- package/dist/widgets/readMeta.js +18 -0
- package/dist/widgets/readMeta.js.map +1 -0
- package/dist/widgets/realtimePoll.js +13 -1
- package/dist/widgets/realtimePoll.js.map +1 -1
- package/dist/widgets/registerWidgets.js +62 -10
- package/dist/widgets/registerWidgets.js.map +1 -1
- package/dist/widgets/types.d.ts +15 -0
- package/dist/widgets/types.js +16 -2
- package/dist/widgets/types.js.map +1 -1
- package/dist/widgets/viewLink.d.ts +22 -0
- package/dist/widgets/viewLink.js +86 -0
- package/dist/widgets/viewLink.js.map +1 -0
- package/package.json +28 -8
- package/dist/native/rollups/applyDistinctDeltas.js +0 -9
- package/dist/native/rollups/applyDistinctDeltas.js.map +0 -1
- package/dist/native/rollups/bumpRollup.js +0 -68
- package/dist/native/rollups/bumpRollup.js.map +0 -1
- package/dist/native/rollups/insertIfNew.js +0 -19
- package/dist/native/rollups/insertIfNew.js.map +0 -1
|
@@ -1,6 +1,47 @@
|
|
|
1
|
+
import { zonedCalendarDay } from "../../timeframe/tz.js";
|
|
2
|
+
import { emptyGoalBreakdown, goalHint, hintSlugs, mergeGoalRows, providerMetricKeys, readGoalPair, splitGoalMetrics } from "../goalRead.js";
|
|
1
3
|
import { dayIso } from "../series.js";
|
|
2
4
|
import { fetchJson } from "../http/fetchJson.js";
|
|
3
5
|
//#region src/adapters/plausible/plausible.ts
|
|
6
|
+
/**
|
|
7
|
+
* Plausible's official per-site stub, as served on plausible.io's own pages: `plausible.q`
|
|
8
|
+
* queues calls the tracker replays on load, and `plausible.init` parks the options on
|
|
9
|
+
* `plausible.o` for it to read. It makes the inline safe next to the async loader in either
|
|
10
|
+
* order, which the bare `plausible.init(...)` call was not. `init` is guarded with `||`
|
|
11
|
+
* (the official one assigns unconditionally) because here the tracker is a separate async
|
|
12
|
+
* tag and may win the race, and overwriting the real `init` with the stub would lose the
|
|
13
|
+
* endpoint.
|
|
14
|
+
*/
|
|
15
|
+
const PLAUSIBLE_STUB = "window.plausible=window.plausible||function(){(window.plausible.q=window.plausible.q||[]).push(arguments)},window.plausible.init=window.plausible.init||function(e){window.plausible.o=e||{}};";
|
|
16
|
+
function buildCapture(config) {
|
|
17
|
+
const base = config.host ?? "https://plausible.io";
|
|
18
|
+
const scripts = (path) => {
|
|
19
|
+
if (config.domain) return [{
|
|
20
|
+
src: `${path}/js/script.js`,
|
|
21
|
+
defer: true,
|
|
22
|
+
attrs: {
|
|
23
|
+
"data-domain": config.domain,
|
|
24
|
+
"data-api": `${path}/api/event`
|
|
25
|
+
}
|
|
26
|
+
}];
|
|
27
|
+
if (config.scriptId) return [{
|
|
28
|
+
src: `${path}/js/pa-${config.scriptId}.js`,
|
|
29
|
+
async: true
|
|
30
|
+
}, { inline: `${PLAUSIBLE_STUB}plausible.init({endpoint:${JSON.stringify(`${path}/api/event`)}})` }];
|
|
31
|
+
return [];
|
|
32
|
+
};
|
|
33
|
+
return {
|
|
34
|
+
proxy: { routes: [{
|
|
35
|
+
source: "/js/:script*",
|
|
36
|
+
upstream: `${base}/js/:script*`
|
|
37
|
+
}, {
|
|
38
|
+
source: "/api/event",
|
|
39
|
+
upstream: `${base}/api/event`
|
|
40
|
+
}] },
|
|
41
|
+
snippet: ({ path }) => ({ scripts: scripts(path) }),
|
|
42
|
+
client: { kind: "plausible" }
|
|
43
|
+
};
|
|
44
|
+
}
|
|
4
45
|
const METRIC_MAP = {
|
|
5
46
|
pageviews: "pageviews",
|
|
6
47
|
visitors: "visitors",
|
|
@@ -10,11 +51,15 @@ const METRIC_MAP = {
|
|
|
10
51
|
avgDuration: "visit_duration",
|
|
11
52
|
events: "events",
|
|
12
53
|
scrollDepth: "scroll_depth",
|
|
54
|
+
conversions: "events",
|
|
13
55
|
revenue: "total_revenue"
|
|
14
56
|
};
|
|
57
|
+
/** Metrics Plausible answers only for a goal-restricted read. */
|
|
58
|
+
const GOAL_METRICS = new Set(["conversions", "revenue"]);
|
|
15
59
|
const DIMENSION_MAP = {
|
|
16
60
|
page: "event:page",
|
|
17
61
|
source: "visit:source",
|
|
62
|
+
channel: "visit:channel",
|
|
18
63
|
referrer: "visit:referrer",
|
|
19
64
|
device: "visit:device",
|
|
20
65
|
browser: "visit:browser",
|
|
@@ -24,24 +69,55 @@ const DIMENSION_MAP = {
|
|
|
24
69
|
city: "visit:city",
|
|
25
70
|
utmSource: "visit:utm_source",
|
|
26
71
|
utmMedium: "visit:utm_medium",
|
|
27
|
-
utmCampaign: "visit:utm_campaign"
|
|
72
|
+
utmCampaign: "visit:utm_campaign",
|
|
73
|
+
goal: "event:goal"
|
|
74
|
+
};
|
|
75
|
+
/**
|
|
76
|
+
* Stats API v2 filter operators, available on every dimension this adapter offers as a
|
|
77
|
+
* filter (event:goal is the grammar's one exception, taking `is` and `contains` only, and
|
|
78
|
+
* is a breakdown here rather than a filter). `matches` is an re2 full match, so a pattern
|
|
79
|
+
* has to cover the whole value (`/docs/.*`, not `^/docs`).
|
|
80
|
+
*/
|
|
81
|
+
const OPERATOR_MAP = {
|
|
82
|
+
eq: "is",
|
|
83
|
+
contains: "contains",
|
|
84
|
+
matches: "matches"
|
|
28
85
|
};
|
|
29
86
|
const plausibleMetrics = new Set(Object.keys(METRIC_MAP));
|
|
87
|
+
const plausibleMetricsNoRevenue = new Set([...plausibleMetrics].filter((m) => m !== "revenue"));
|
|
30
88
|
const plausibleDimensions = new Set(Object.keys(DIMENSION_MAP));
|
|
89
|
+
const plausibleFilters = new Set([...plausibleDimensions].filter((dimension) => dimension !== "goal"));
|
|
90
|
+
const revenueAmount = (raw) => typeof raw === "object" && raw !== null && typeof raw.value === "number" ? raw.value : void 0;
|
|
31
91
|
const toContractValue = (metric, raw) => metric === "avgDuration" ? Math.round(raw * 1e3) : raw;
|
|
92
|
+
/**
|
|
93
|
+
* Plausible identifies a goal by its display name in the site's own goal list ("Signup",
|
|
94
|
+
* "Visit /thank-you"), so a plugin goal's slug must equal that name for its conversions to
|
|
95
|
+
* read. Conversions are the `events` metric on goal rows, which is the dashboard's Total
|
|
96
|
+
* Conversions; revenue is `total_revenue`, which Plausible serves only for a revenue goal
|
|
97
|
+
* and reports as an object whose `value` is null when the rows mix currencies. Revenue is
|
|
98
|
+
* offered only when `revenueCurrency` says the site has such a goal: asking for it on a site
|
|
99
|
+
* without one errors the request.
|
|
100
|
+
*/
|
|
32
101
|
function plausible(config) {
|
|
33
102
|
const host = config.host ?? "https://plausible.io";
|
|
103
|
+
const maxLookbackDays = config.maxLookbackDays !== void 0 ? config.maxLookbackDays : 730;
|
|
104
|
+
const revenueGoals = Boolean(config.revenueCurrency);
|
|
34
105
|
return {
|
|
35
106
|
id: "plausible",
|
|
36
107
|
label: "Plausible",
|
|
37
108
|
capabilities: {
|
|
38
109
|
perPageQuery: true,
|
|
39
110
|
realtime: false,
|
|
40
|
-
comparison: false,
|
|
41
111
|
minGranularity: "day",
|
|
42
|
-
maxLookbackDays
|
|
43
|
-
metrics: plausibleMetrics,
|
|
112
|
+
maxLookbackDays,
|
|
113
|
+
metrics: revenueGoals ? plausibleMetrics : plausibleMetricsNoRevenue,
|
|
44
114
|
dimensions: plausibleDimensions,
|
|
115
|
+
filters: plausibleFilters,
|
|
116
|
+
filterOperators: new Set([
|
|
117
|
+
"eq",
|
|
118
|
+
"contains",
|
|
119
|
+
"matches"
|
|
120
|
+
]),
|
|
45
121
|
batchPageReport: true,
|
|
46
122
|
rateLimit: { requestsPerHour: 600 },
|
|
47
123
|
recommendedTtl: {
|
|
@@ -49,12 +125,28 @@ function plausible(config) {
|
|
|
49
125
|
aggregate: 3600
|
|
50
126
|
}
|
|
51
127
|
},
|
|
128
|
+
...config.domain || config.scriptId ? { capture: buildCapture(config) } : {},
|
|
52
129
|
isConfigured: () => Boolean(config.siteId && config.apiKey),
|
|
53
130
|
async query(q, ctx) {
|
|
54
131
|
const fetchedAt = q.dateRange.end.toISOString();
|
|
55
|
-
const wanted = q.metrics.filter((m) => METRIC_MAP[m]);
|
|
56
|
-
const providerMetrics = [...new Set(wanted.map((m) => METRIC_MAP[m]))];
|
|
57
132
|
const dims = (q.dimensions ?? []).filter((d) => DIMENSION_MAP[d]);
|
|
133
|
+
const goalBreakdown = dims.includes("goal");
|
|
134
|
+
const hint = goalHint(q);
|
|
135
|
+
const slugs = hintSlugs(hint);
|
|
136
|
+
const empty = goalBreakdown ? emptyGoalBreakdown({
|
|
137
|
+
provider: "plausible",
|
|
138
|
+
q,
|
|
139
|
+
hint
|
|
140
|
+
}) : null;
|
|
141
|
+
if (empty) return empty;
|
|
142
|
+
const { siteMetrics, goalMetrics, unresolved } = splitGoalMetrics({
|
|
143
|
+
wanted: q.metrics.filter((m) => METRIC_MAP[m] && (revenueGoals || m !== "revenue")),
|
|
144
|
+
goalOnly: GOAL_METRICS,
|
|
145
|
+
goalBreakdown,
|
|
146
|
+
hint
|
|
147
|
+
});
|
|
148
|
+
const siteKeys = providerMetricKeys(siteMetrics, METRIC_MAP);
|
|
149
|
+
const goalKeys = providerMetricKeys(goalMetrics, METRIC_MAP);
|
|
58
150
|
const filters = [];
|
|
59
151
|
if (q.path) filters.push([
|
|
60
152
|
"is",
|
|
@@ -66,78 +158,107 @@ function plausible(config) {
|
|
|
66
158
|
"event:hostname",
|
|
67
159
|
[q.hostname]
|
|
68
160
|
]);
|
|
69
|
-
const
|
|
161
|
+
for (const filter of q.filters ?? []) {
|
|
162
|
+
const mapped = plausibleFilters.has(filter.dimension) ? DIMENSION_MAP[filter.dimension] : void 0;
|
|
163
|
+
if (!mapped) continue;
|
|
164
|
+
filters.push([
|
|
165
|
+
OPERATOR_MAP[filter.operator],
|
|
166
|
+
mapped,
|
|
167
|
+
[filter.value]
|
|
168
|
+
]);
|
|
169
|
+
}
|
|
170
|
+
const goalFilters = slugs ? [...filters, [
|
|
171
|
+
"is",
|
|
172
|
+
"event:goal",
|
|
173
|
+
slugs
|
|
174
|
+
]] : filters;
|
|
175
|
+
const siteFilters = goalBreakdown ? goalFilters : filters;
|
|
176
|
+
let goalsFailed = false;
|
|
177
|
+
const meta = () => ({
|
|
178
|
+
provider: "plausible",
|
|
179
|
+
fetchedAt,
|
|
180
|
+
...unresolved || goalsFailed ? { goalsUnresolved: true } : {}
|
|
181
|
+
});
|
|
182
|
+
const readMetrics = (ms, keys, row) => {
|
|
70
183
|
const out = {};
|
|
71
|
-
for (const m of
|
|
72
|
-
const
|
|
73
|
-
|
|
184
|
+
for (const m of ms) {
|
|
185
|
+
const raw = row.metrics[keys.indexOf(METRIC_MAP[m])];
|
|
186
|
+
if (m === "revenue") {
|
|
187
|
+
const amount = revenueAmount(raw);
|
|
188
|
+
if (amount !== void 0) out.revenue = amount;
|
|
189
|
+
continue;
|
|
190
|
+
}
|
|
191
|
+
out[m] = toContractValue(m, typeof raw === "number" ? raw : 0);
|
|
74
192
|
}
|
|
75
193
|
return out;
|
|
76
194
|
};
|
|
77
|
-
const postQuery = (extra) => fetchJson(`${host}/api/v2/query`, {
|
|
195
|
+
const postQuery = (metrics, clauses, extra) => fetchJson(`${host}/api/v2/query`, {
|
|
78
196
|
method: "POST",
|
|
79
197
|
headers: { authorization: `Bearer ${config.apiKey}` },
|
|
80
198
|
body: {
|
|
81
199
|
site_id: config.siteId,
|
|
82
|
-
metrics
|
|
83
|
-
date_range: [q.dateRange.start
|
|
84
|
-
...
|
|
200
|
+
metrics,
|
|
201
|
+
date_range: [zonedCalendarDay(q.dateRange.start, q.timezone ?? "UTC"), zonedCalendarDay(q.dateRange.end, q.timezone ?? "UTC")],
|
|
202
|
+
...clauses.length ? { filters: clauses } : {},
|
|
85
203
|
...extra
|
|
86
204
|
},
|
|
87
205
|
signal: ctx.signal,
|
|
88
206
|
provider: "plausible"
|
|
89
207
|
});
|
|
90
|
-
const
|
|
91
|
-
|
|
92
|
-
|
|
208
|
+
const keyedRows = (response, ms, keys) => response?.results.map((row) => ({
|
|
209
|
+
keys: row.dimensions,
|
|
210
|
+
metrics: readMetrics(ms, keys, row)
|
|
211
|
+
}));
|
|
212
|
+
/**
|
|
213
|
+
* One request shape read twice, plainly and goal-filtered, unioned per row. A row the
|
|
214
|
+
* goal read has no counterpart for carries no conversions: no goal was completed there.
|
|
215
|
+
*/
|
|
216
|
+
const readPair = async (extra) => {
|
|
217
|
+
const pair = await readGoalPair({
|
|
218
|
+
site: siteKeys.length ? () => postQuery(siteKeys, siteFilters, extra) : void 0,
|
|
219
|
+
goals: goalKeys.length ? () => postQuery(goalKeys, goalFilters, extra) : void 0
|
|
220
|
+
});
|
|
221
|
+
if (pair.failed) goalsFailed = true;
|
|
222
|
+
return mergeGoalRows(keyedRows(pair.site, siteMetrics, siteKeys), keyedRows(pair.goals, goalMetrics, goalKeys));
|
|
93
223
|
};
|
|
94
224
|
if (q.granularity === "day" && !dims.length) {
|
|
95
|
-
const [
|
|
225
|
+
const [series, totalRows] = await Promise.all([readPair({ dimensions: ["time:day"] }), readPair({})]);
|
|
96
226
|
const rows = [];
|
|
97
|
-
for (const row of
|
|
98
|
-
const ts = dayIso(row.
|
|
227
|
+
for (const row of series) {
|
|
228
|
+
const ts = dayIso(row.keys[0] ?? "");
|
|
99
229
|
if (ts) rows.push({
|
|
100
230
|
timestamp: ts,
|
|
101
|
-
metrics:
|
|
231
|
+
metrics: row.metrics
|
|
102
232
|
});
|
|
103
233
|
}
|
|
104
234
|
return {
|
|
105
235
|
rows,
|
|
106
|
-
totals,
|
|
107
|
-
meta:
|
|
108
|
-
provider: "plausible",
|
|
109
|
-
fetchedAt
|
|
110
|
-
}
|
|
236
|
+
totals: totalRows[0]?.metrics ?? {},
|
|
237
|
+
meta: meta()
|
|
111
238
|
};
|
|
112
239
|
}
|
|
113
240
|
if (!dims.length) {
|
|
114
|
-
const totals = await
|
|
241
|
+
const totals = (await readPair({}))[0]?.metrics ?? {};
|
|
115
242
|
return {
|
|
116
243
|
rows: [{ metrics: totals }],
|
|
117
244
|
totals,
|
|
118
|
-
meta:
|
|
119
|
-
provider: "plausible",
|
|
120
|
-
fetchedAt
|
|
121
|
-
}
|
|
245
|
+
meta: meta()
|
|
122
246
|
};
|
|
123
247
|
}
|
|
124
248
|
return {
|
|
125
|
-
rows: (await
|
|
249
|
+
rows: (await readPair({ dimensions: dims.map((d) => DIMENSION_MAP[d]) })).map((row) => {
|
|
126
250
|
const dimValues = {};
|
|
127
251
|
for (let i = 0; i < dims.length; i++) {
|
|
128
252
|
const d = dims[i];
|
|
129
|
-
if (d !== void 0) dimValues[d] = row.
|
|
253
|
+
if (d !== void 0) dimValues[d] = row.keys[i] ?? "";
|
|
130
254
|
}
|
|
131
255
|
return {
|
|
132
256
|
dimensions: dimValues,
|
|
133
|
-
metrics:
|
|
257
|
+
metrics: row.metrics
|
|
134
258
|
};
|
|
135
259
|
}),
|
|
136
260
|
totals: void 0,
|
|
137
|
-
meta:
|
|
138
|
-
provider: "plausible",
|
|
139
|
-
fetchedAt
|
|
140
|
-
}
|
|
261
|
+
meta: meta()
|
|
141
262
|
};
|
|
142
263
|
}
|
|
143
264
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"plausible.js","names":[],"sources":["../../../src/adapters/plausible/plausible.ts"],"sourcesContent":["import type {\n\tAdapterContext,\n\tAnalyticsAdapter,\n\tAnalyticsCapabilities,\n\tAnalyticsQuery,\n\tAnalyticsResult,\n\tAnalyticsRow,\n\tDimensionKey,\n\tMetricKey,\n} from '../../core/contract'\nimport { fetchJson } from '../http/fetchJson'\nimport { dayIso } from '../series'\n\nexport interface PlausibleConfig {\n\tsiteId: string\n\tapiKey: string\n\t/** Base URL for self-hosted CE. Defaults to Plausible Cloud. */\n\thost?: string\n\t/** Maximum days of historical data. Defaults to 730. Pass null to disable clamping. */\n\tmaxLookbackDays?: number | null\n}\n\nconst METRIC_MAP: Partial<Record<MetricKey, string>> = {\n\tpageviews: 'pageviews',\n\tvisitors: 'visitors',\n\tvisits: 'visits',\n\tsessions: 'visits',\n\tbounceRate: 'bounce_rate',\n\tavgDuration: 'visit_duration',\n\tevents: 'events',\n\tscrollDepth: 'scroll_depth',\n\trevenue: 'total_revenue',\n}\n\nconst DIMENSION_MAP: Partial<Record<DimensionKey, string>> = {\n\tpage: 'event:page',\n\tsource: 'visit:source',\n\treferrer: 'visit:referrer',\n\tdevice: 'visit:device',\n\tbrowser: 'visit:browser',\n\tos: 'visit:os',\n\tcountry: 'visit:country',\n\tregion: 'visit:region',\n\tcity: 'visit:city',\n\tutmSource: 'visit:utm_source',\n\tutmMedium: 'visit:utm_medium',\n\tutmCampaign: 'visit:utm_campaign',\n}\n\nconst plausibleMetrics: ReadonlySet<MetricKey> = new Set(Object.keys(METRIC_MAP) as MetricKey[])\nconst plausibleDimensions: ReadonlySet<DimensionKey> = new Set(\n\tObject.keys(DIMENSION_MAP) as DimensionKey[]\n)\n\ninterface PlausibleResponse {\n\tresults: Array<{ metrics: number[]; dimensions: string[] }>\n}\n\n// visit_duration is reported in seconds; the contract avgDuration is milliseconds.\nconst toContractValue = (metric: MetricKey, raw: number): number =>\n\tmetric === 'avgDuration' ? Math.round(raw * 1000) : raw\n\nexport function plausible(config: PlausibleConfig): AnalyticsAdapter {\n\tconst host = config.host ?? 'https://plausible.io'\n\tconst maxLookbackDays = config.maxLookbackDays !== undefined ? config.maxLookbackDays : 730\n\n\tconst capabilities: AnalyticsCapabilities = {\n\t\tperPageQuery: true,\n\t\trealtime: false,\n\t\tcomparison: false,\n\t\tminGranularity: 'day',\n\t\tmaxLookbackDays,\n\t\tmetrics: plausibleMetrics,\n\t\tdimensions: plausibleDimensions,\n\t\tbatchPageReport: true,\n\t\trateLimit: { requestsPerHour: 600 },\n\t\trecommendedTtl: { realtime: 300, aggregate: 3600 },\n\t}\n\n\treturn {\n\t\tid: 'plausible',\n\t\tlabel: 'Plausible',\n\t\tcapabilities,\n\t\tisConfigured: () => Boolean(config.siteId && config.apiKey),\n\t\tasync query(q: AnalyticsQuery, ctx: AdapterContext): Promise<AnalyticsResult> {\n\t\t\tconst fetchedAt = q.dateRange.end.toISOString()\n\t\t\tconst wanted = q.metrics.filter((m) => METRIC_MAP[m])\n\t\t\t// Several contract metrics alias one Plausible metric (sessions and visits both\n\t\t\t// map to \"visits\"), so dedupe before sending and read each contract metric back\n\t\t\t// from its provider key's position rather than the request index.\n\t\t\tconst providerMetrics = [...new Set(wanted.map((m) => METRIC_MAP[m] as string))]\n\t\t\tconst dims = (q.dimensions ?? []).filter((d) => DIMENSION_MAP[d])\n\t\t\tconst filters: Array<[string, string, string[]]> = []\n\t\t\tif (q.path) {\n\t\t\t\tfilters.push(['is', 'event:page', [q.path]])\n\t\t\t}\n\t\t\tif (q.hostname) {\n\t\t\t\tfilters.push(['is', 'event:hostname', [q.hostname]])\n\t\t\t}\n\n\t\t\tconst readRow = (row: { metrics: number[] }): Partial<Record<MetricKey, number>> => {\n\t\t\t\tconst out: Partial<Record<MetricKey, number>> = {}\n\t\t\t\tfor (const m of wanted) {\n\t\t\t\t\tconst idx = providerMetrics.indexOf(METRIC_MAP[m] as string)\n\t\t\t\t\tout[m] = toContractValue(m, row.metrics[idx] ?? 0)\n\t\t\t\t}\n\t\t\t\treturn out\n\t\t\t}\n\n\t\t\tconst postQuery = (extra: Record<string, unknown>): Promise<PlausibleResponse> =>\n\t\t\t\tfetchJson<PlausibleResponse>(`${host}/api/v2/query`, {\n\t\t\t\t\tmethod: 'POST',\n\t\t\t\t\theaders: { authorization: `Bearer ${config.apiKey}` },\n\t\t\t\t\tbody: {\n\t\t\t\t\t\tsite_id: config.siteId,\n\t\t\t\t\t\tmetrics: providerMetrics,\n\t\t\t\t\t\tdate_range: [\n\t\t\t\t\t\t\tq.dateRange.start.toISOString().slice(0, 10),\n\t\t\t\t\t\t\tq.dateRange.end.toISOString().slice(0, 10),\n\t\t\t\t\t\t],\n\t\t\t\t\t\t...(filters.length ? { filters } : {}),\n\t\t\t\t\t\t...extra,\n\t\t\t\t\t},\n\t\t\t\t\tsignal: ctx.signal,\n\t\t\t\t\tprovider: 'plausible',\n\t\t\t\t})\n\n\t\t\tconst fetchTotals = async (): Promise<Partial<Record<MetricKey, number>>> => {\n\t\t\t\tconst data = await postQuery({})\n\t\t\t\treturn data.results[0] ? readRow(data.results[0]) : {}\n\t\t\t}\n\n\t\t\tif (q.granularity === 'day' && !dims.length) {\n\t\t\t\tconst [seriesData, totals] = await Promise.all([\n\t\t\t\t\tpostQuery({ dimensions: ['time:day'] }),\n\t\t\t\t\tfetchTotals(),\n\t\t\t\t])\n\t\t\t\tconst rows: AnalyticsRow[] = []\n\t\t\t\tfor (const row of seriesData.results) {\n\t\t\t\t\tconst ts = dayIso(row.dimensions[0] ?? '')\n\t\t\t\t\tif (ts) {\n\t\t\t\t\t\trows.push({ timestamp: ts, metrics: readRow(row) })\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn { rows, totals, meta: { provider: 'plausible', fetchedAt } }\n\t\t\t}\n\n\t\t\tif (!dims.length) {\n\t\t\t\tconst totals = await fetchTotals()\n\t\t\t\treturn { rows: [{ metrics: totals }], totals, meta: { provider: 'plausible', fetchedAt } }\n\t\t\t}\n\n\t\t\tconst data = await postQuery({ dimensions: dims.map((d) => DIMENSION_MAP[d] as string) })\n\t\t\tconst rows: AnalyticsRow[] = data.results.map((row) => {\n\t\t\t\tconst dimValues: Partial<Record<DimensionKey, string>> = {}\n\t\t\t\tfor (let i = 0; i < dims.length; i++) {\n\t\t\t\t\tconst d = dims[i]\n\t\t\t\t\tif (d !== undefined) {\n\t\t\t\t\t\tdimValues[d] = row.dimensions[i] ?? ''\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn { dimensions: dimValues, metrics: readRow(row) }\n\t\t\t})\n\t\t\treturn { rows, totals: undefined, meta: { provider: 'plausible', fetchedAt } }\n\t\t},\n\t}\n}\n"],"mappings":";;;AAsBA,MAAM,aAAiD;CACtD,WAAW;CACX,UAAU;CACV,QAAQ;CACR,UAAU;CACV,YAAY;CACZ,aAAa;CACb,QAAQ;CACR,aAAa;CACb,SAAS;AACV;AAEA,MAAM,gBAAuD;CAC5D,MAAM;CACN,QAAQ;CACR,UAAU;CACV,QAAQ;CACR,SAAS;CACT,IAAI;CACJ,SAAS;CACT,QAAQ;CACR,MAAM;CACN,WAAW;CACX,WAAW;CACX,aAAa;AACd;AAEA,MAAM,mBAA2C,IAAI,IAAI,OAAO,KAAK,UAAU,CAAgB;AAC/F,MAAM,sBAAiD,IAAI,IAC1D,OAAO,KAAK,aAAa,CAC1B;AAOA,MAAM,mBAAmB,QAAmB,QAC3C,WAAW,gBAAgB,KAAK,MAAM,MAAM,GAAI,IAAI;AAErD,SAAgB,UAAU,QAA2C;CACpE,MAAM,OAAO,OAAO,QAAQ;CAgB5B,OAAO;EACN,IAAI;EACJ,OAAO;EACP,cAAA;GAfA,cAAc;GACd,UAAU;GACV,YAAY;GACZ,gBAAgB;GAChB,iBAPuB,OAAO,oBAAoB,KAAA,IAAY,OAAO,kBAAkB;GAQvF,SAAS;GACT,YAAY;GACZ,iBAAiB;GACjB,WAAW,EAAE,iBAAiB,IAAI;GAClC,gBAAgB;IAAE,UAAU;IAAK,WAAW;GAAK;EAMtC;EACX,oBAAoB,QAAQ,OAAO,UAAU,OAAO,MAAM;EAC1D,MAAM,MAAM,GAAmB,KAA+C;GAC7E,MAAM,YAAY,EAAE,UAAU,IAAI,YAAY;GAC9C,MAAM,SAAS,EAAE,QAAQ,QAAQ,MAAM,WAAW,EAAE;GAIpD,MAAM,kBAAkB,CAAC,GAAG,IAAI,IAAI,OAAO,KAAK,MAAM,WAAW,EAAY,CAAC,CAAC;GAC/E,MAAM,QAAQ,EAAE,cAAc,CAAC,GAAG,QAAQ,MAAM,cAAc,EAAE;GAChE,MAAM,UAA6C,CAAC;GACpD,IAAI,EAAE,MACL,QAAQ,KAAK;IAAC;IAAM;IAAc,CAAC,EAAE,IAAI;GAAC,CAAC;GAE5C,IAAI,EAAE,UACL,QAAQ,KAAK;IAAC;IAAM;IAAkB,CAAC,EAAE,QAAQ;GAAC,CAAC;GAGpD,MAAM,WAAW,QAAmE;IACnF,MAAM,MAA0C,CAAC;IACjD,KAAK,MAAM,KAAK,QAAQ;KACvB,MAAM,MAAM,gBAAgB,QAAQ,WAAW,EAAY;KAC3D,IAAI,KAAK,gBAAgB,GAAG,IAAI,QAAQ,QAAQ,CAAC;IAClD;IACA,OAAO;GACR;GAEA,MAAM,aAAa,UAClB,UAA6B,GAAG,KAAK,gBAAgB;IACpD,QAAQ;IACR,SAAS,EAAE,eAAe,UAAU,OAAO,SAAS;IACpD,MAAM;KACL,SAAS,OAAO;KAChB,SAAS;KACT,YAAY,CACX,EAAE,UAAU,MAAM,YAAY,EAAE,MAAM,GAAG,EAAE,GAC3C,EAAE,UAAU,IAAI,YAAY,EAAE,MAAM,GAAG,EAAE,CAC1C;KACA,GAAI,QAAQ,SAAS,EAAE,QAAQ,IAAI,CAAC;KACpC,GAAG;IACJ;IACA,QAAQ,IAAI;IACZ,UAAU;GACX,CAAC;GAEF,MAAM,cAAc,YAAyD;IAC5E,MAAM,OAAO,MAAM,UAAU,CAAC,CAAC;IAC/B,OAAO,KAAK,QAAQ,KAAK,QAAQ,KAAK,QAAQ,EAAE,IAAI,CAAC;GACtD;GAEA,IAAI,EAAE,gBAAgB,SAAS,CAAC,KAAK,QAAQ;IAC5C,MAAM,CAAC,YAAY,UAAU,MAAM,QAAQ,IAAI,CAC9C,UAAU,EAAE,YAAY,CAAC,UAAU,EAAE,CAAC,GACtC,YAAY,CACb,CAAC;IACD,MAAM,OAAuB,CAAC;IAC9B,KAAK,MAAM,OAAO,WAAW,SAAS;KACrC,MAAM,KAAK,OAAO,IAAI,WAAW,MAAM,EAAE;KACzC,IAAI,IACH,KAAK,KAAK;MAAE,WAAW;MAAI,SAAS,QAAQ,GAAG;KAAE,CAAC;IAEpD;IACA,OAAO;KAAE;KAAM;KAAQ,MAAM;MAAE,UAAU;MAAa;KAAU;IAAE;GACnE;GAEA,IAAI,CAAC,KAAK,QAAQ;IACjB,MAAM,SAAS,MAAM,YAAY;IACjC,OAAO;KAAE,MAAM,CAAC,EAAE,SAAS,OAAO,CAAC;KAAG;KAAQ,MAAM;MAAE,UAAU;MAAa;KAAU;IAAE;GAC1F;GAaA,OAAO;IAAE,OAVoB,MADV,UAAU,EAAE,YAAY,KAAK,KAAK,MAAM,cAAc,EAAY,EAAE,CAAC,GACtD,QAAQ,KAAK,QAAQ;KACtD,MAAM,YAAmD,CAAC;KAC1D,KAAK,IAAI,IAAI,GAAG,IAAI,KAAK,QAAQ,KAAK;MACrC,MAAM,IAAI,KAAK;MACf,IAAI,MAAM,KAAA,GACT,UAAU,KAAK,IAAI,WAAW,MAAM;KAEtC;KACA,OAAO;MAAE,YAAY;MAAW,SAAS,QAAQ,GAAG;KAAE;IACvD,CACY;IAAG,QAAQ,KAAA;IAAW,MAAM;KAAE,UAAU;KAAa;IAAU;GAAE;EAC9E;CACD;AACD"}
|
|
1
|
+
{"version":3,"file":"plausible.js","names":[],"sources":["../../../src/adapters/plausible/plausible.ts"],"sourcesContent":["import type { CaptureSupport } from '../../core/capture'\nimport type {\n\tAdapterContext,\n\tAnalyticsAdapter,\n\tAnalyticsCapabilities,\n\tAnalyticsQuery,\n\tAnalyticsResult,\n\tAnalyticsRow,\n\tDimensionKey,\n\tFilterOperator,\n\tMetricKey,\n} from '../../core/contract'\nimport { DEFAULT_TIMEZONE, zonedCalendarDay } from '../../timeframe/tz'\nimport {\n\temptyGoalBreakdown,\n\ttype GoalKeyedRow,\n\tgoalHint,\n\thintSlugs,\n\tmergeGoalRows,\n\tproviderMetricKeys,\n\treadGoalPair,\n\tsplitGoalMetrics,\n} from '../goalRead'\nimport { fetchJson } from '../http/fetchJson'\nimport { dayIso } from '../series'\n\nexport interface PlausibleConfig {\n\tsiteId: string\n\tapiKey: string\n\t/** Base URL for self-hosted CE. Defaults to Plausible Cloud. */\n\thost?: string\n\t/** Maximum days of historical data. Defaults to 730. Pass null to disable clamping. */\n\tmaxLookbackDays?: number | null\n\t/**\n\t * Site domain for the legacy script tag (`data-domain`). Takes priority over `scriptId`.\n\t * The adapter declares `capture` only when one of the two is set.\n\t */\n\tdomain?: string\n\t/**\n\t * Per-site tracker id (`pa-<id>.js`) for the newer per-site script model. The adapter\n\t * declares `capture` only when one of it and `domain` is set.\n\t */\n\tscriptId?: string\n\t/**\n\t * The ISO currency of the site's revenue goals. Declaring it turns on the `revenue`\n\t * metric: Plausible serves `total_revenue` only where a revenue goal exists, and errors\n\t * the whole request on a site that has none.\n\t */\n\trevenueCurrency?: string\n}\n\n/**\n * Plausible's official per-site stub, as served on plausible.io's own pages: `plausible.q`\n * queues calls the tracker replays on load, and `plausible.init` parks the options on\n * `plausible.o` for it to read. It makes the inline safe next to the async loader in either\n * order, which the bare `plausible.init(...)` call was not. `init` is guarded with `||`\n * (the official one assigns unconditionally) because here the tracker is a separate async\n * tag and may win the race, and overwriting the real `init` with the stub would lose the\n * endpoint.\n */\nconst PLAUSIBLE_STUB =\n\t'window.plausible=window.plausible||function(){(window.plausible.q=window.plausible.q||[]).push(arguments)},window.plausible.init=window.plausible.init||function(e){window.plausible.o=e||{}};'\n\nfunction buildCapture(config: PlausibleConfig): CaptureSupport {\n\tconst base = config.host ?? 'https://plausible.io'\n\tconst scripts = (path: string) => {\n\t\tif (config.domain) {\n\t\t\treturn [\n\t\t\t\t{\n\t\t\t\t\tsrc: `${path}/js/script.js`,\n\t\t\t\t\tdefer: true,\n\t\t\t\t\tattrs: { 'data-domain': config.domain, 'data-api': `${path}/api/event` },\n\t\t\t\t},\n\t\t\t]\n\t\t}\n\t\tif (config.scriptId) {\n\t\t\treturn [\n\t\t\t\t{ src: `${path}/js/pa-${config.scriptId}.js`, async: true },\n\t\t\t\t{\n\t\t\t\t\tinline: `${PLAUSIBLE_STUB}plausible.init({endpoint:${JSON.stringify(`${path}/api/event`)}})`,\n\t\t\t\t},\n\t\t\t]\n\t\t}\n\t\treturn []\n\t}\n\treturn {\n\t\tproxy: {\n\t\t\troutes: [\n\t\t\t\t{ source: '/js/:script*', upstream: `${base}/js/:script*` },\n\t\t\t\t{ source: '/api/event', upstream: `${base}/api/event` },\n\t\t\t],\n\t\t},\n\t\tsnippet: ({ path }) => ({ scripts: scripts(path) }),\n\t\tclient: { kind: 'plausible' },\n\t}\n}\n\nconst METRIC_MAP: Partial<Record<MetricKey, string>> = {\n\tpageviews: 'pageviews',\n\tvisitors: 'visitors',\n\tvisits: 'visits',\n\tsessions: 'visits',\n\tbounceRate: 'bounce_rate',\n\tavgDuration: 'visit_duration',\n\tevents: 'events',\n\tscrollDepth: 'scroll_depth',\n\t// Both only mean anything under an event:goal filter or dimension, which is the one\n\t// shape they are requested in: \"events\" on goal rows is Plausible's Total Conversions.\n\tconversions: 'events',\n\trevenue: 'total_revenue',\n}\n\n/** Metrics Plausible answers only for a goal-restricted read. */\nconst GOAL_METRICS: ReadonlySet<MetricKey> = new Set(['conversions', 'revenue'])\n\nconst DIMENSION_MAP: Partial<Record<DimensionKey, string>> = {\n\tpage: 'event:page',\n\tsource: 'visit:source',\n\tchannel: 'visit:channel',\n\treferrer: 'visit:referrer',\n\tdevice: 'visit:device',\n\tbrowser: 'visit:browser',\n\tos: 'visit:os',\n\tcountry: 'visit:country',\n\tregion: 'visit:region',\n\tcity: 'visit:city',\n\tutmSource: 'visit:utm_source',\n\tutmMedium: 'visit:utm_medium',\n\tutmCampaign: 'visit:utm_campaign',\n\tgoal: 'event:goal',\n}\n\n/**\n * Stats API v2 filter operators, available on every dimension this adapter offers as a\n * filter (event:goal is the grammar's one exception, taking `is` and `contains` only, and\n * is a breakdown here rather than a filter). `matches` is an re2 full match, so a pattern\n * has to cover the whole value (`/docs/.*`, not `^/docs`).\n */\nconst OPERATOR_MAP: Record<FilterOperator, string> = {\n\teq: 'is',\n\tcontains: 'contains',\n\tmatches: 'matches',\n}\n\nconst plausibleMetrics: ReadonlySet<MetricKey> = new Set(Object.keys(METRIC_MAP) as MetricKey[])\n// A site without revenue goals has no total_revenue at all, so the metric is opt-in.\nconst plausibleMetricsNoRevenue: ReadonlySet<MetricKey> = new Set(\n\t[...plausibleMetrics].filter((m) => m !== 'revenue')\n)\nconst plausibleDimensions: ReadonlySet<DimensionKey> = new Set(\n\tObject.keys(DIMENSION_MAP) as DimensionKey[]\n)\n// `goal` is a breakdown, not a filter: the read's own goal slugs own the event:goal clause,\n// and the grammar allows no `matches` on it anyway.\nconst plausibleFilters: ReadonlySet<DimensionKey> = new Set(\n\t[...plausibleDimensions].filter((dimension) => dimension !== 'goal')\n)\n\n/** `total_revenue` is an object, and null when the rows mix currencies. Every other metric is a number. */\ntype PlausibleMetricValue = number | { value: number | null } | null\n\ninterface PlausibleResult {\n\tmetrics: PlausibleMetricValue[]\n\tdimensions: string[]\n}\n\ninterface PlausibleResponse {\n\tresults: PlausibleResult[]\n}\n\nconst revenueAmount = (raw: PlausibleMetricValue | undefined): number | undefined =>\n\ttypeof raw === 'object' && raw !== null && typeof raw.value === 'number' ? raw.value : undefined\n\n// visit_duration is reported in seconds; the contract avgDuration is milliseconds.\nconst toContractValue = (metric: MetricKey, raw: number): number =>\n\tmetric === 'avgDuration' ? Math.round(raw * 1000) : raw\n\n/**\n * Plausible identifies a goal by its display name in the site's own goal list (\"Signup\",\n * \"Visit /thank-you\"), so a plugin goal's slug must equal that name for its conversions to\n * read. Conversions are the `events` metric on goal rows, which is the dashboard's Total\n * Conversions; revenue is `total_revenue`, which Plausible serves only for a revenue goal\n * and reports as an object whose `value` is null when the rows mix currencies. Revenue is\n * offered only when `revenueCurrency` says the site has such a goal: asking for it on a site\n * without one errors the request.\n */\nexport function plausible(config: PlausibleConfig): AnalyticsAdapter {\n\tconst host = config.host ?? 'https://plausible.io'\n\tconst maxLookbackDays = config.maxLookbackDays !== undefined ? config.maxLookbackDays : 730\n\tconst revenueGoals = Boolean(config.revenueCurrency)\n\n\tconst capabilities: AnalyticsCapabilities = {\n\t\tperPageQuery: true,\n\t\trealtime: false,\n\t\tminGranularity: 'day',\n\t\tmaxLookbackDays,\n\t\tmetrics: revenueGoals ? plausibleMetrics : plausibleMetricsNoRevenue,\n\t\tdimensions: plausibleDimensions,\n\t\tfilters: plausibleFilters,\n\t\tfilterOperators: new Set(['eq', 'contains', 'matches']),\n\t\tbatchPageReport: true,\n\t\trateLimit: { requestsPerHour: 600 },\n\t\trecommendedTtl: { realtime: 300, aggregate: 3600 },\n\t}\n\n\treturn {\n\t\tid: 'plausible',\n\t\tlabel: 'Plausible',\n\t\tcapabilities,\n\t\t...(config.domain || config.scriptId ? { capture: buildCapture(config) } : {}),\n\t\tisConfigured: () => Boolean(config.siteId && config.apiKey),\n\t\tasync query(q: AnalyticsQuery, ctx: AdapterContext): Promise<AnalyticsResult> {\n\t\t\tconst fetchedAt = q.dateRange.end.toISOString()\n\t\t\tconst dims = (q.dimensions ?? []).filter((d) => DIMENSION_MAP[d])\n\t\t\tconst goalBreakdown = dims.includes('goal')\n\t\t\tconst hint = goalHint(q)\n\t\t\tconst slugs = hintSlugs(hint)\n\t\t\tconst empty = goalBreakdown ? emptyGoalBreakdown({ provider: 'plausible', q, hint }) : null\n\t\t\tif (empty) {\n\t\t\t\treturn empty\n\t\t\t}\n\t\t\tconst wanted = q.metrics.filter((m) => METRIC_MAP[m] && (revenueGoals || m !== 'revenue'))\n\t\t\tconst { siteMetrics, goalMetrics, unresolved } = splitGoalMetrics({\n\t\t\t\twanted,\n\t\t\t\tgoalOnly: GOAL_METRICS,\n\t\t\t\tgoalBreakdown,\n\t\t\t\thint,\n\t\t\t})\n\t\t\tconst siteKeys = providerMetricKeys(siteMetrics, METRIC_MAP)\n\t\t\tconst goalKeys = providerMetricKeys(goalMetrics, METRIC_MAP)\n\n\t\t\tconst filters: Array<[string, string, string[]]> = []\n\t\t\tif (q.path) {\n\t\t\t\tfilters.push(['is', 'event:page', [q.path]])\n\t\t\t}\n\t\t\tif (q.hostname) {\n\t\t\t\tfilters.push(['is', 'event:hostname', [q.hostname]])\n\t\t\t}\n\t\t\t// Capability gating (filters/filterOperators) is the real contract upstream; an\n\t\t\t// unsupported dimension is dropped here as the safety net.\n\t\t\tfor (const filter of q.filters ?? []) {\n\t\t\t\tconst mapped = plausibleFilters.has(filter.dimension)\n\t\t\t\t\t? DIMENSION_MAP[filter.dimension]\n\t\t\t\t\t: undefined\n\t\t\t\tif (!mapped) {\n\t\t\t\t\tcontinue\n\t\t\t\t}\n\t\t\t\tfilters.push([OPERATOR_MAP[filter.operator], mapped, [filter.value]])\n\t\t\t}\n\t\t\tconst goalFilters: Array<[string, string, string[]]> = slugs\n\t\t\t\t? [...filters, ['is', 'event:goal', slugs]]\n\t\t\t\t: filters\n\t\t\tconst siteFilters = goalBreakdown ? goalFilters : filters\n\t\t\t// Set when the provider rejects a goal request the site request survived, so the\n\t\t\t// rows keep their site metrics and lose only their goal numbers.\n\t\t\tlet goalsFailed = false\n\t\t\tconst meta = (): AnalyticsResult['meta'] => ({\n\t\t\t\tprovider: 'plausible',\n\t\t\t\tfetchedAt,\n\t\t\t\t...(unresolved || goalsFailed ? { goalsUnresolved: true as const } : {}),\n\t\t\t})\n\n\t\t\tconst readMetrics = (\n\t\t\t\tms: MetricKey[],\n\t\t\t\tkeys: string[],\n\t\t\t\trow: PlausibleResult\n\t\t\t): Partial<Record<MetricKey, number>> => {\n\t\t\t\tconst out: Partial<Record<MetricKey, number>> = {}\n\t\t\t\tfor (const m of ms) {\n\t\t\t\t\tconst raw = row.metrics[keys.indexOf(METRIC_MAP[m] as string)]\n\t\t\t\t\tif (m === 'revenue') {\n\t\t\t\t\t\tconst amount = revenueAmount(raw)\n\t\t\t\t\t\tif (amount !== undefined) {\n\t\t\t\t\t\t\tout.revenue = amount\n\t\t\t\t\t\t}\n\t\t\t\t\t\tcontinue\n\t\t\t\t\t}\n\t\t\t\t\tout[m] = toContractValue(m, typeof raw === 'number' ? raw : 0)\n\t\t\t\t}\n\t\t\t\treturn out\n\t\t\t}\n\n\t\t\tconst postQuery = (\n\t\t\t\tmetrics: string[],\n\t\t\t\tclauses: Array<[string, string, string[]]>,\n\t\t\t\textra: Record<string, unknown>\n\t\t\t): Promise<PlausibleResponse> =>\n\t\t\t\tfetchJson<PlausibleResponse>(`${host}/api/v2/query`, {\n\t\t\t\t\tmethod: 'POST',\n\t\t\t\t\theaders: { authorization: `Bearer ${config.apiKey}` },\n\t\t\t\t\tbody: {\n\t\t\t\t\t\tsite_id: config.siteId,\n\t\t\t\t\t\tmetrics,\n\t\t\t\t\t\tdate_range: [\n\t\t\t\t\t\t\tzonedCalendarDay(q.dateRange.start, q.timezone ?? DEFAULT_TIMEZONE),\n\t\t\t\t\t\t\tzonedCalendarDay(q.dateRange.end, q.timezone ?? DEFAULT_TIMEZONE),\n\t\t\t\t\t\t],\n\t\t\t\t\t\t...(clauses.length ? { filters: clauses } : {}),\n\t\t\t\t\t\t...extra,\n\t\t\t\t\t},\n\t\t\t\t\tsignal: ctx.signal,\n\t\t\t\t\tprovider: 'plausible',\n\t\t\t\t})\n\n\t\t\tconst keyedRows = (\n\t\t\t\tresponse: PlausibleResponse | undefined,\n\t\t\t\tms: MetricKey[],\n\t\t\t\tkeys: string[]\n\t\t\t): GoalKeyedRow[] | undefined =>\n\t\t\t\tresponse?.results.map((row) => ({\n\t\t\t\t\tkeys: row.dimensions,\n\t\t\t\t\tmetrics: readMetrics(ms, keys, row),\n\t\t\t\t}))\n\n\t\t\t/**\n\t\t\t * One request shape read twice, plainly and goal-filtered, unioned per row. A row the\n\t\t\t * goal read has no counterpart for carries no conversions: no goal was completed there.\n\t\t\t */\n\t\t\tconst readPair = async (extra: Record<string, unknown>): Promise<GoalKeyedRow[]> => {\n\t\t\t\tconst pair = await readGoalPair({\n\t\t\t\t\tsite: siteKeys.length ? () => postQuery(siteKeys, siteFilters, extra) : undefined,\n\t\t\t\t\tgoals: goalKeys.length ? () => postQuery(goalKeys, goalFilters, extra) : undefined,\n\t\t\t\t})\n\t\t\t\tif (pair.failed) {\n\t\t\t\t\tgoalsFailed = true\n\t\t\t\t}\n\t\t\t\treturn mergeGoalRows(\n\t\t\t\t\tkeyedRows(pair.site, siteMetrics, siteKeys),\n\t\t\t\t\tkeyedRows(pair.goals, goalMetrics, goalKeys)\n\t\t\t\t)\n\t\t\t}\n\n\t\t\tif (q.granularity === 'day' && !dims.length) {\n\t\t\t\tconst [series, totalRows] = await Promise.all([\n\t\t\t\t\treadPair({ dimensions: ['time:day'] }),\n\t\t\t\t\treadPair({}),\n\t\t\t\t])\n\t\t\t\tconst rows: AnalyticsRow[] = []\n\t\t\t\tfor (const row of series) {\n\t\t\t\t\tconst ts = dayIso(row.keys[0] ?? '')\n\t\t\t\t\tif (ts) {\n\t\t\t\t\t\trows.push({ timestamp: ts, metrics: row.metrics })\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn { rows, totals: totalRows[0]?.metrics ?? {}, meta: meta() }\n\t\t\t}\n\n\t\t\tif (!dims.length) {\n\t\t\t\tconst totals = (await readPair({}))[0]?.metrics ?? {}\n\t\t\t\treturn { rows: [{ metrics: totals }], totals, meta: meta() }\n\t\t\t}\n\n\t\t\tconst merged = await readPair({ dimensions: dims.map((d) => DIMENSION_MAP[d] as string) })\n\t\t\tconst rows: AnalyticsRow[] = merged.map((row) => {\n\t\t\t\tconst dimValues: Partial<Record<DimensionKey, string>> = {}\n\t\t\t\tfor (let i = 0; i < dims.length; i++) {\n\t\t\t\t\tconst d = dims[i]\n\t\t\t\t\tif (d !== undefined) {\n\t\t\t\t\t\tdimValues[d] = row.keys[i] ?? ''\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn { dimensions: dimValues, metrics: row.metrics }\n\t\t\t})\n\t\t\treturn { rows, totals: undefined, meta: meta() }\n\t\t},\n\t}\n}\n"],"mappings":";;;;;;;;;;;;;;AA4DA,MAAM,iBACL;AAED,SAAS,aAAa,QAAyC;CAC9D,MAAM,OAAO,OAAO,QAAQ;CAC5B,MAAM,WAAW,SAAiB;EACjC,IAAI,OAAO,QACV,OAAO,CACN;GACC,KAAK,GAAG,KAAK;GACb,OAAO;GACP,OAAO;IAAE,eAAe,OAAO;IAAQ,YAAY,GAAG,KAAK;GAAY;EACxE,CACD;EAED,IAAI,OAAO,UACV,OAAO,CACN;GAAE,KAAK,GAAG,KAAK,SAAS,OAAO,SAAS;GAAM,OAAO;EAAK,GAC1D,EACC,QAAQ,GAAG,eAAe,2BAA2B,KAAK,UAAU,GAAG,KAAK,WAAW,EAAE,IAC1F,CACD;EAED,OAAO,CAAC;CACT;CACA,OAAO;EACN,OAAO,EACN,QAAQ,CACP;GAAE,QAAQ;GAAgB,UAAU,GAAG,KAAK;EAAc,GAC1D;GAAE,QAAQ;GAAc,UAAU,GAAG,KAAK;EAAY,CACvD,EACD;EACA,UAAU,EAAE,YAAY,EAAE,SAAS,QAAQ,IAAI,EAAE;EACjD,QAAQ,EAAE,MAAM,YAAY;CAC7B;AACD;AAEA,MAAM,aAAiD;CACtD,WAAW;CACX,UAAU;CACV,QAAQ;CACR,UAAU;CACV,YAAY;CACZ,aAAa;CACb,QAAQ;CACR,aAAa;CAGb,aAAa;CACb,SAAS;AACV;;AAGA,MAAM,eAAuC,IAAI,IAAI,CAAC,eAAe,SAAS,CAAC;AAE/E,MAAM,gBAAuD;CAC5D,MAAM;CACN,QAAQ;CACR,SAAS;CACT,UAAU;CACV,QAAQ;CACR,SAAS;CACT,IAAI;CACJ,SAAS;CACT,QAAQ;CACR,MAAM;CACN,WAAW;CACX,WAAW;CACX,aAAa;CACb,MAAM;AACP;;;;;;;AAQA,MAAM,eAA+C;CACpD,IAAI;CACJ,UAAU;CACV,SAAS;AACV;AAEA,MAAM,mBAA2C,IAAI,IAAI,OAAO,KAAK,UAAU,CAAgB;AAE/F,MAAM,4BAAoD,IAAI,IAC7D,CAAC,GAAG,gBAAgB,EAAE,QAAQ,MAAM,MAAM,SAAS,CACpD;AACA,MAAM,sBAAiD,IAAI,IAC1D,OAAO,KAAK,aAAa,CAC1B;AAGA,MAAM,mBAA8C,IAAI,IACvD,CAAC,GAAG,mBAAmB,EAAE,QAAQ,cAAc,cAAc,MAAM,CACpE;AAcA,MAAM,iBAAiB,QACtB,OAAO,QAAQ,YAAY,QAAQ,QAAQ,OAAO,IAAI,UAAU,WAAW,IAAI,QAAQ,KAAA;AAGxF,MAAM,mBAAmB,QAAmB,QAC3C,WAAW,gBAAgB,KAAK,MAAM,MAAM,GAAI,IAAI;;;;;;;;;;AAWrD,SAAgB,UAAU,QAA2C;CACpE,MAAM,OAAO,OAAO,QAAQ;CAC5B,MAAM,kBAAkB,OAAO,oBAAoB,KAAA,IAAY,OAAO,kBAAkB;CACxF,MAAM,eAAe,QAAQ,OAAO,eAAe;CAgBnD,OAAO;EACN,IAAI;EACJ,OAAO;EACP,cAAA;GAhBA,cAAc;GACd,UAAU;GACV,gBAAgB;GAChB;GACA,SAAS,eAAe,mBAAmB;GAC3C,YAAY;GACZ,SAAS;GACT,iBAAiB,IAAI,IAAI;IAAC;IAAM;IAAY;GAAS,CAAC;GACtD,iBAAiB;GACjB,WAAW,EAAE,iBAAiB,IAAI;GAClC,gBAAgB;IAAE,UAAU;IAAK,WAAW;GAAK;EAMtC;EACX,GAAI,OAAO,UAAU,OAAO,WAAW,EAAE,SAAS,aAAa,MAAM,EAAE,IAAI,CAAC;EAC5E,oBAAoB,QAAQ,OAAO,UAAU,OAAO,MAAM;EAC1D,MAAM,MAAM,GAAmB,KAA+C;GAC7E,MAAM,YAAY,EAAE,UAAU,IAAI,YAAY;GAC9C,MAAM,QAAQ,EAAE,cAAc,CAAC,GAAG,QAAQ,MAAM,cAAc,EAAE;GAChE,MAAM,gBAAgB,KAAK,SAAS,MAAM;GAC1C,MAAM,OAAO,SAAS,CAAC;GACvB,MAAM,QAAQ,UAAU,IAAI;GAC5B,MAAM,QAAQ,gBAAgB,mBAAmB;IAAE,UAAU;IAAa;IAAG;GAAK,CAAC,IAAI;GACvF,IAAI,OACH,OAAO;GAGR,MAAM,EAAE,aAAa,aAAa,eAAe,iBAAiB;IACjE,QAFc,EAAE,QAAQ,QAAQ,MAAM,WAAW,OAAO,gBAAgB,MAAM,UAEzE;IACL,UAAU;IACV;IACA;GACD,CAAC;GACD,MAAM,WAAW,mBAAmB,aAAa,UAAU;GAC3D,MAAM,WAAW,mBAAmB,aAAa,UAAU;GAE3D,MAAM,UAA6C,CAAC;GACpD,IAAI,EAAE,MACL,QAAQ,KAAK;IAAC;IAAM;IAAc,CAAC,EAAE,IAAI;GAAC,CAAC;GAE5C,IAAI,EAAE,UACL,QAAQ,KAAK;IAAC;IAAM;IAAkB,CAAC,EAAE,QAAQ;GAAC,CAAC;GAIpD,KAAK,MAAM,UAAU,EAAE,WAAW,CAAC,GAAG;IACrC,MAAM,SAAS,iBAAiB,IAAI,OAAO,SAAS,IACjD,cAAc,OAAO,aACrB,KAAA;IACH,IAAI,CAAC,QACJ;IAED,QAAQ,KAAK;KAAC,aAAa,OAAO;KAAW;KAAQ,CAAC,OAAO,KAAK;IAAC,CAAC;GACrE;GACA,MAAM,cAAiD,QACpD,CAAC,GAAG,SAAS;IAAC;IAAM;IAAc;GAAK,CAAC,IACxC;GACH,MAAM,cAAc,gBAAgB,cAAc;GAGlD,IAAI,cAAc;GAClB,MAAM,cAAuC;IAC5C,UAAU;IACV;IACA,GAAI,cAAc,cAAc,EAAE,iBAAiB,KAAc,IAAI,CAAC;GACvE;GAEA,MAAM,eACL,IACA,MACA,QACwC;IACxC,MAAM,MAA0C,CAAC;IACjD,KAAK,MAAM,KAAK,IAAI;KACnB,MAAM,MAAM,IAAI,QAAQ,KAAK,QAAQ,WAAW,EAAY;KAC5D,IAAI,MAAM,WAAW;MACpB,MAAM,SAAS,cAAc,GAAG;MAChC,IAAI,WAAW,KAAA,GACd,IAAI,UAAU;MAEf;KACD;KACA,IAAI,KAAK,gBAAgB,GAAG,OAAO,QAAQ,WAAW,MAAM,CAAC;IAC9D;IACA,OAAO;GACR;GAEA,MAAM,aACL,SACA,SACA,UAEA,UAA6B,GAAG,KAAK,gBAAgB;IACpD,QAAQ;IACR,SAAS,EAAE,eAAe,UAAU,OAAO,SAAS;IACpD,MAAM;KACL,SAAS,OAAO;KAChB;KACA,YAAY,CACX,iBAAiB,EAAE,UAAU,OAAO,EAAE,YAAA,KAA4B,GAClE,iBAAiB,EAAE,UAAU,KAAK,EAAE,YAAA,KAA4B,CACjE;KACA,GAAI,QAAQ,SAAS,EAAE,SAAS,QAAQ,IAAI,CAAC;KAC7C,GAAG;IACJ;IACA,QAAQ,IAAI;IACZ,UAAU;GACX,CAAC;GAEF,MAAM,aACL,UACA,IACA,SAEA,UAAU,QAAQ,KAAK,SAAS;IAC/B,MAAM,IAAI;IACV,SAAS,YAAY,IAAI,MAAM,GAAG;GACnC,EAAE;;;;;GAMH,MAAM,WAAW,OAAO,UAA4D;IACnF,MAAM,OAAO,MAAM,aAAa;KAC/B,MAAM,SAAS,eAAe,UAAU,UAAU,aAAa,KAAK,IAAI,KAAA;KACxE,OAAO,SAAS,eAAe,UAAU,UAAU,aAAa,KAAK,IAAI,KAAA;IAC1E,CAAC;IACD,IAAI,KAAK,QACR,cAAc;IAEf,OAAO,cACN,UAAU,KAAK,MAAM,aAAa,QAAQ,GAC1C,UAAU,KAAK,OAAO,aAAa,QAAQ,CAC5C;GACD;GAEA,IAAI,EAAE,gBAAgB,SAAS,CAAC,KAAK,QAAQ;IAC5C,MAAM,CAAC,QAAQ,aAAa,MAAM,QAAQ,IAAI,CAC7C,SAAS,EAAE,YAAY,CAAC,UAAU,EAAE,CAAC,GACrC,SAAS,CAAC,CAAC,CACZ,CAAC;IACD,MAAM,OAAuB,CAAC;IAC9B,KAAK,MAAM,OAAO,QAAQ;KACzB,MAAM,KAAK,OAAO,IAAI,KAAK,MAAM,EAAE;KACnC,IAAI,IACH,KAAK,KAAK;MAAE,WAAW;MAAI,SAAS,IAAI;KAAQ,CAAC;IAEnD;IACA,OAAO;KAAE;KAAM,QAAQ,UAAU,IAAI,WAAW,CAAC;KAAG,MAAM,KAAK;IAAE;GAClE;GAEA,IAAI,CAAC,KAAK,QAAQ;IACjB,MAAM,UAAU,MAAM,SAAS,CAAC,CAAC,GAAG,IAAI,WAAW,CAAC;IACpD,OAAO;KAAE,MAAM,CAAC,EAAE,SAAS,OAAO,CAAC;KAAG;KAAQ,MAAM,KAAK;IAAE;GAC5D;GAaA,OAAO;IAAE,OAVoB,MADR,SAAS,EAAE,YAAY,KAAK,KAAK,MAAM,cAAc,EAAY,EAAE,CAAC,GACrD,KAAK,QAAQ;KAChD,MAAM,YAAmD,CAAC;KAC1D,KAAK,IAAI,IAAI,GAAG,IAAI,KAAK,QAAQ,KAAK;MACrC,MAAM,IAAI,KAAK;MACf,IAAI,MAAM,KAAA,GACT,UAAU,KAAK,IAAI,KAAK,MAAM;KAEhC;KACA,OAAO;MAAE,YAAY;MAAW,SAAS,IAAI;KAAQ;IACtD,CACY;IAAG,QAAQ,KAAA;IAAW,MAAM,KAAK;GAAE;EAChD;CACD;AACD"}
|
|
@@ -4,7 +4,7 @@ import { AnalyticsAdapter } from "../../core/contract.js";
|
|
|
4
4
|
interface PosthogConfig {
|
|
5
5
|
/** PostHog project id (numeric). */
|
|
6
6
|
projectId: string;
|
|
7
|
-
/** Personal API key with the "Query Read" scope (phx_...). */
|
|
7
|
+
/** Personal API key with the "Query Read" scope (phx_...). Never exposed to the browser. */
|
|
8
8
|
apiKey: string;
|
|
9
9
|
/** API host. Defaults to US Cloud; EU is https://eu.posthog.com, self-host is your instance URL. */
|
|
10
10
|
host?: string;
|
|
@@ -16,6 +16,15 @@ interface PosthogConfig {
|
|
|
16
16
|
* read filters on it. Both the property name and value are escaped literals.
|
|
17
17
|
*/
|
|
18
18
|
scopeProperty?: string;
|
|
19
|
+
/** Cloud region for the proxied capture routes. Derived from `host` when omitted. */
|
|
20
|
+
region?: 'us' | 'eu';
|
|
21
|
+
/**
|
|
22
|
+
* The public browser key (phc_...) sent to `posthog.init`. Distinct from `apiKey`, the
|
|
23
|
+
* private Query API key, which must never reach the client. The adapter declares
|
|
24
|
+
* `capture` only when this is set: without it the install reads dashboards and captures
|
|
25
|
+
* nothing, so it gets no public proxy and no snippet.
|
|
26
|
+
*/
|
|
27
|
+
projectToken?: string;
|
|
19
28
|
}
|
|
20
29
|
declare function posthog(config: PosthogConfig): AnalyticsAdapter;
|
|
21
30
|
//#endregion
|
|
@@ -1,7 +1,54 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { emptyGoalBreakdown, goalHint, hintFailed, hintSlugs } from "../goalRead.js";
|
|
2
|
+
import { dayIso, hourIso } from "../series.js";
|
|
2
3
|
import { fetchJson } from "../http/fetchJson.js";
|
|
3
4
|
//#region src/adapters/posthog/posthog.ts
|
|
4
5
|
const US_CLOUD = "https://us.posthog.com";
|
|
6
|
+
const resolveRegion = (config) => {
|
|
7
|
+
if (config.region) return config.region;
|
|
8
|
+
return config.host?.includes("eu.posthog.com") ? "eu" : "us";
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* PostHog's official install stub (https://posthog.com/docs/libraries/js), trimmed to the
|
|
12
|
+
* methods this plugin and a host are likely to call before the SDK lands. It has to be one
|
|
13
|
+
* self-sequencing script: `init` is what injects `array.js`, deriving the URL from
|
|
14
|
+
* `api_host` (the `.i.posthog.com` rewrite is a no-op on a first-party proxy path, so it
|
|
15
|
+
* resolves to `<path>/static/array.js`, exactly the route the proxy declares). Every call
|
|
16
|
+
* made before the SDK arrives is queued on the stub and replayed by it.
|
|
17
|
+
*
|
|
18
|
+
* One addition to the official code: the injected tag inherits the nonce of the inline that
|
|
19
|
+
* injected it, or a nonce CSP without `strict-dynamic` would pass the inline and block the
|
|
20
|
+
* bundle. `document.currentScript` is the inline itself during its own synchronous run, on
|
|
21
|
+
* the server-rendered path and the loader's path alike. The IDL property is read first
|
|
22
|
+
* because browsers blank the content attribute once the document is parsed.
|
|
23
|
+
*/
|
|
24
|
+
const POSTHOG_STUB = "!function(t,e){var o,n,p,r,c;e.__SV||(window.posthog=e,e._i=[],e.init=function(i,s,a){function g(t,e){var o=e.split(\".\");2==o.length&&(t=t[o[0]],e=o[1]),t[e]=function(){t.push([e].concat(Array.prototype.slice.call(arguments,0)))}}(p=t.createElement(\"script\")).type=\"text/javascript\",p.crossOrigin=\"anonymous\",p.async=!0,p.src=s.api_host.replace(\".i.posthog.com\",\"-assets.i.posthog.com\")+\"/static/array.js\",(c=t.currentScript&&(t.currentScript.nonce||t.currentScript.getAttribute(\"nonce\")))&&(p.nonce=c,p.setAttribute(\"nonce\",c)),(r=t.getElementsByTagName(\"script\")[0]).parentNode.insertBefore(p,r);var u=e;for(void 0!==a?u=e[a]=[]:a=\"posthog\",u.people=u.people||[],o=\"init capture register register_once identify group alias reset setPersonProperties captureException opt_in_capturing opt_out_capturing has_opted_in_capturing has_opted_out_capturing getFeatureFlag isFeatureEnabled reloadFeatureFlags onFeatureFlags on debug\".split(\" \"),n=0;n<o.length;n++)g(u,o[n]);e._i.push([i,s,a])},e.__SV=1)}(document,window.posthog||[]);";
|
|
25
|
+
function buildCapture(config, token) {
|
|
26
|
+
const region = resolveRegion(config);
|
|
27
|
+
return {
|
|
28
|
+
proxy: {
|
|
29
|
+
trailingSlashes: true,
|
|
30
|
+
routes: [
|
|
31
|
+
{
|
|
32
|
+
source: "/static/:p*",
|
|
33
|
+
upstream: `https://${region}-assets.i.posthog.com/static/:p*`
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
source: "/array/:p*",
|
|
37
|
+
upstream: `https://${region}-assets.i.posthog.com/array/:p*`
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
source: "/:p*",
|
|
41
|
+
upstream: `https://${region}.i.posthog.com/:p*`
|
|
42
|
+
}
|
|
43
|
+
]
|
|
44
|
+
},
|
|
45
|
+
snippet: ({ path }) => ({ scripts: [{ inline: `${POSTHOG_STUB}posthog.init(${JSON.stringify(token)},{api_host:${JSON.stringify(path)},ui_host:${JSON.stringify(`https://${region}.posthog.com`)}})` }] }),
|
|
46
|
+
client: {
|
|
47
|
+
kind: "posthog",
|
|
48
|
+
token
|
|
49
|
+
}
|
|
50
|
+
};
|
|
51
|
+
}
|
|
5
52
|
const METRIC_SQL_PAGEVIEW = {
|
|
6
53
|
pageviews: "count()",
|
|
7
54
|
visitors: "count(DISTINCT person_id)",
|
|
@@ -15,14 +62,36 @@ const METRIC_SQL_ALL = {
|
|
|
15
62
|
sessions: "count(DISTINCT if(event = '$pageview', properties.$session_id, NULL))",
|
|
16
63
|
events: "count()"
|
|
17
64
|
};
|
|
65
|
+
const METRIC_SQL_GOAL = {
|
|
66
|
+
pageviews: "count()",
|
|
67
|
+
visitors: "count(DISTINCT person_id)",
|
|
68
|
+
visits: "count(DISTINCT properties.$session_id)",
|
|
69
|
+
sessions: "count(DISTINCT properties.$session_id)",
|
|
70
|
+
events: "count()"
|
|
71
|
+
};
|
|
72
|
+
/**
|
|
73
|
+
* A goal is an event name here, so a plugin goal's slug must equal the captured event's name.
|
|
74
|
+
* `channel` reads PostHog's own acquisition classification: the events table declares a
|
|
75
|
+
* `session` join on `$session_id`, and the sessions table computes `$channel_type` from the
|
|
76
|
+
* session's entry URL, honouring a project's custom channel rules.
|
|
77
|
+
*/
|
|
18
78
|
const DIMENSION_SQL = {
|
|
19
79
|
page: "properties.$pathname",
|
|
20
|
-
|
|
80
|
+
channel: "session.$channel_type",
|
|
81
|
+
event: "event",
|
|
82
|
+
goal: "event"
|
|
21
83
|
};
|
|
22
|
-
const posthogMetrics = new Set(Object.keys(METRIC_SQL_ALL));
|
|
84
|
+
const posthogMetrics = new Set([...Object.keys(METRIC_SQL_ALL), "conversions"]);
|
|
23
85
|
const posthogDimensions = new Set(Object.keys(DIMENSION_SQL));
|
|
86
|
+
const posthogFilters = new Set([...posthogDimensions].filter((dimension) => dimension !== "goal"));
|
|
24
87
|
const sqlString = (value) => `'${value.replace(/\\/g, "\\\\").replace(/'/g, "\\'")}'`;
|
|
25
|
-
const
|
|
88
|
+
const escapeLikeValue = (value) => value.replace(/[\\%_]/g, (c) => `\\${c}`);
|
|
89
|
+
/**
|
|
90
|
+
* A bare HogQL date literal parses in the project's timezone, so the UTC wall time
|
|
91
|
+
* `toISOString` produces would drift by that offset; the zone is passed explicitly to keep
|
|
92
|
+
* the bound an absolute instant (https://posthog.com/docs/hogql/expressions).
|
|
93
|
+
*/
|
|
94
|
+
const utcDateTime = (d) => `toDateTime(${sqlString(d.toISOString().slice(0, 19).replace("T", " "))}, 'UTC')`;
|
|
26
95
|
function posthog(config) {
|
|
27
96
|
const host = config.host ?? US_CLOUD;
|
|
28
97
|
return {
|
|
@@ -31,11 +100,16 @@ function posthog(config) {
|
|
|
31
100
|
capabilities: {
|
|
32
101
|
perPageQuery: true,
|
|
33
102
|
realtime: false,
|
|
34
|
-
|
|
35
|
-
minGranularity: "day",
|
|
103
|
+
minGranularity: "hour",
|
|
36
104
|
maxLookbackDays: config.maxLookbackDays !== void 0 ? config.maxLookbackDays : 730,
|
|
37
105
|
metrics: posthogMetrics,
|
|
38
106
|
dimensions: posthogDimensions,
|
|
107
|
+
filters: posthogFilters,
|
|
108
|
+
filterOperators: new Set([
|
|
109
|
+
"eq",
|
|
110
|
+
"contains",
|
|
111
|
+
"matches"
|
|
112
|
+
]),
|
|
39
113
|
batchPageReport: true,
|
|
40
114
|
rateLimit: {
|
|
41
115
|
requestsPerMinute: 240,
|
|
@@ -47,19 +121,46 @@ function posthog(config) {
|
|
|
47
121
|
},
|
|
48
122
|
...config.scopeProperty ? { scopedQueries: true } : {}
|
|
49
123
|
},
|
|
124
|
+
...config.projectToken ? { capture: buildCapture(config, config.projectToken) } : {},
|
|
50
125
|
isConfigured: () => Boolean(config.projectId && config.apiKey),
|
|
51
126
|
async query(q, ctx) {
|
|
52
127
|
const fetchedAt = q.dateRange.end.toISOString();
|
|
53
128
|
const breakdownDim = (q.dimensions ?? []).find((d) => DIMENSION_SQL[d]);
|
|
54
|
-
const
|
|
55
|
-
const
|
|
129
|
+
const hint = goalHint(q);
|
|
130
|
+
const slugs = hintSlugs(hint);
|
|
131
|
+
const empty = breakdownDim === "goal" ? emptyGoalBreakdown({
|
|
132
|
+
provider: "posthog",
|
|
133
|
+
q,
|
|
134
|
+
hint
|
|
135
|
+
}) : null;
|
|
136
|
+
if (empty) return empty;
|
|
137
|
+
const scanAllEvents = q.metrics.includes("events") || q.metrics.includes("conversions") || breakdownDim === "event" || breakdownDim === "goal" || (q.filters ?? []).some((f) => f.dimension === "event" && DIMENSION_SQL[f.dimension]);
|
|
138
|
+
const eventInHint = slugs ? `event IN (${slugs.map(sqlString).join(", ")})` : void 0;
|
|
139
|
+
const metricSql = {
|
|
140
|
+
...breakdownDim === "goal" ? METRIC_SQL_GOAL : scanAllEvents ? METRIC_SQL_ALL : METRIC_SQL_PAGEVIEW,
|
|
141
|
+
...eventInHint ? { conversions: `countIf(${eventInHint})` } : {}
|
|
142
|
+
};
|
|
143
|
+
const unresolved = q.metrics.includes("conversions") && hintFailed(hint);
|
|
56
144
|
const wanted = q.metrics.filter((m) => metricSql[m]);
|
|
57
145
|
const exprs = [...new Set(wanted.map((m) => metricSql[m]))];
|
|
58
|
-
const
|
|
146
|
+
const meta = {
|
|
147
|
+
provider: "posthog",
|
|
148
|
+
fetchedAt,
|
|
149
|
+
...unresolved ? { goalsUnresolved: true } : {}
|
|
150
|
+
};
|
|
151
|
+
const where = [`timestamp >= ${utcDateTime(q.dateRange.start)}`, `timestamp <= ${utcDateTime(q.dateRange.end)}`];
|
|
59
152
|
if (!scanAllEvents) where.unshift("event = '$pageview'");
|
|
153
|
+
if (breakdownDim === "goal" && eventInHint) where.push(eventInHint);
|
|
60
154
|
if (q.path) where.push(`properties.$pathname = ${sqlString(q.path)}`);
|
|
61
155
|
if (q.hostname) where.push(`properties.$host = ${sqlString(q.hostname)}`);
|
|
62
156
|
if (config.scopeProperty && q.scope !== void 0) where.push(`properties[${sqlString(config.scopeProperty)}] = ${sqlString(q.scope)}`);
|
|
157
|
+
for (const filter of q.filters ?? []) {
|
|
158
|
+
const expr = posthogFilters.has(filter.dimension) ? DIMENSION_SQL[filter.dimension] : void 0;
|
|
159
|
+
if (!expr) continue;
|
|
160
|
+
if (filter.operator === "eq") where.push(`${expr} = ${sqlString(filter.value)}`);
|
|
161
|
+
else if (filter.operator === "contains") where.push(`${expr} ILIKE ${sqlString(`%${escapeLikeValue(filter.value)}%`)}`);
|
|
162
|
+
else if (filter.operator === "matches") where.push(`match(${expr}, ${sqlString(filter.value)})`);
|
|
163
|
+
}
|
|
63
164
|
const selectMetrics = exprs.map((expr, i) => `${expr} AS m${i}`);
|
|
64
165
|
const runSql = (sql) => fetchJson(`${host}/api/projects/${config.projectId}/query/`, {
|
|
65
166
|
method: "POST",
|
|
@@ -97,10 +198,24 @@ function posthog(config) {
|
|
|
97
198
|
return {
|
|
98
199
|
rows,
|
|
99
200
|
totals,
|
|
100
|
-
meta
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
201
|
+
meta
|
|
202
|
+
};
|
|
203
|
+
}
|
|
204
|
+
if (q.granularity === "hour" && !breakdownDim) {
|
|
205
|
+
const seriesSql = `SELECT ${`toStartOfHour(timestamp, ${sqlString(q.timezone ?? "UTC")})`} AS hour, ${selectMetrics.join(", ")} FROM events WHERE ${where.join(" AND ")} GROUP BY hour ORDER BY hour`;
|
|
206
|
+
const [seriesData, totals] = await Promise.all([runSql(seriesSql), fetchTotals()]);
|
|
207
|
+
const rows = [];
|
|
208
|
+
for (const row of seriesData.results) {
|
|
209
|
+
const ts = hourIso(String(row[0] ?? ""));
|
|
210
|
+
if (ts) rows.push({
|
|
211
|
+
timestamp: ts,
|
|
212
|
+
metrics: readRow(row, 1)
|
|
213
|
+
});
|
|
214
|
+
}
|
|
215
|
+
return {
|
|
216
|
+
rows,
|
|
217
|
+
totals,
|
|
218
|
+
meta
|
|
104
219
|
};
|
|
105
220
|
}
|
|
106
221
|
if (breakdownDim) return {
|
|
@@ -109,19 +224,13 @@ function posthog(config) {
|
|
|
109
224
|
metrics: readRow(row, 1)
|
|
110
225
|
})),
|
|
111
226
|
totals: void 0,
|
|
112
|
-
meta
|
|
113
|
-
provider: "posthog",
|
|
114
|
-
fetchedAt
|
|
115
|
-
}
|
|
227
|
+
meta
|
|
116
228
|
};
|
|
117
229
|
const totals = await fetchTotals();
|
|
118
230
|
return {
|
|
119
231
|
rows: [{ metrics: totals }],
|
|
120
232
|
totals,
|
|
121
|
-
meta
|
|
122
|
-
provider: "posthog",
|
|
123
|
-
fetchedAt
|
|
124
|
-
}
|
|
233
|
+
meta
|
|
125
234
|
};
|
|
126
235
|
}
|
|
127
236
|
};
|