@10x-media/analytics 1.0.0-beta.8 → 4.0.0-alpha.1
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 +780 -0
- package/LICENSE +21 -21
- package/README.md +35 -36
- package/dist/access/adminUser.d.ts +15 -0
- package/dist/access/adminUser.js +13 -0
- package/dist/access/adminUser.js.map +1 -0
- package/dist/access/decideOnce.js +16 -0
- package/dist/access/decideOnce.js.map +1 -0
- package/dist/access/membership.d.ts +23 -0
- package/dist/access/membership.js +63 -0
- package/dist/access/membership.js.map +1 -0
- package/dist/access/principal.d.ts +37 -0
- package/dist/access/principal.js +29 -0
- package/dist/access/principal.js.map +1 -0
- package/dist/access/readGate.js +16 -0
- package/dist/access/readGate.js.map +1 -0
- package/dist/adapters/ga4/disableKey.js +19 -0
- package/dist/adapters/ga4/disableKey.js.map +1 -0
- package/dist/adapters/ga4/eventName.d.ts +9 -0
- package/dist/adapters/ga4/eventName.js +13 -0
- package/dist/adapters/ga4/eventName.js.map +1 -0
- package/dist/adapters/ga4/ga4.d.ts +29 -0
- package/dist/adapters/ga4/ga4.js +324 -112
- package/dist/adapters/ga4/ga4.js.map +1 -1
- package/dist/adapters/ga4/measurementId.js +14 -0
- package/dist/adapters/ga4/measurementId.js.map +1 -0
- package/dist/adapters/goalRead.js +112 -0
- package/dist/adapters/goalRead.js.map +1 -0
- package/dist/adapters/http/baseUrl.js +15 -0
- package/dist/adapters/http/baseUrl.js.map +1 -0
- package/dist/adapters/http/fetchJson.d.ts +19 -0
- package/dist/adapters/http/fetchJson.js +27 -8
- package/dist/adapters/http/fetchJson.js.map +1 -1
- package/dist/adapters/mapping.js +52 -0
- package/dist/adapters/mapping.js.map +1 -0
- package/dist/adapters/plausible/plausible.d.ts +30 -3
- package/dist/adapters/plausible/plausible.js +198 -110
- package/dist/adapters/plausible/plausible.js.map +1 -1
- package/dist/adapters/plausible/scriptId.js +19 -0
- package/dist/adapters/plausible/scriptId.js.map +1 -0
- package/dist/adapters/posthog/posthog.d.ts +33 -9
- package/dist/adapters/posthog/posthog.js +307 -127
- package/dist/adapters/posthog/posthog.js.map +1 -1
- package/dist/adapters/posthog/projectCheck.js +56 -0
- package/dist/adapters/posthog/projectCheck.js.map +1 -0
- package/dist/adapters/readTime.js +7 -0
- package/dist/adapters/readTime.js.map +1 -0
- package/dist/adapters/series.js +14 -8
- package/dist/adapters/series.js.map +1 -1
- package/dist/adapters/umami/umami.d.ts +21 -3
- package/dist/adapters/umami/umami.js +334 -95
- package/dist/adapters/umami/umami.js.map +1 -1
- package/dist/adapters/upstream.js +16 -0
- package/dist/adapters/upstream.js.map +1 -0
- package/dist/binding/report.d.ts +8 -0
- package/dist/binding/report.js +24 -0
- package/dist/binding/report.js.map +1 -0
- package/dist/binding/resolvePath.js +28 -25
- package/dist/binding/resolvePath.js.map +1 -1
- package/dist/binding/types.d.ts +14 -29
- package/dist/capture/captureRequest.js +28 -0
- package/dist/capture/captureRequest.js.map +1 -0
- package/dist/capture/exclusionEndpoint.js +98 -0
- package/dist/capture/exclusionEndpoint.js.map +1 -0
- package/dist/capture/exclusionPrelude.js +14 -0
- package/dist/capture/exclusionPrelude.js.map +1 -0
- package/dist/capture/exclusionToken.js +23 -0
- package/dist/capture/exclusionToken.js.map +1 -0
- package/dist/capture/jsLiteral.js +19 -0
- package/dist/capture/jsLiteral.js.map +1 -0
- package/dist/capture/mountPath.js +2 -3
- package/dist/capture/mountPath.js.map +1 -1
- package/dist/capture/proxyEndpoint.js +49 -92
- package/dist/capture/proxyEndpoint.js.map +1 -1
- package/dist/capture/proxyRoutes.js +58 -21
- package/dist/capture/proxyRoutes.js.map +1 -1
- package/dist/capture/relay.js +91 -0
- package/dist/capture/relay.js.map +1 -0
- package/dist/capture/requestBody.js +2 -6
- package/dist/capture/requestBody.js.map +1 -1
- package/dist/capture/requestTrust.js +45 -0
- package/dist/capture/requestTrust.js.map +1 -0
- package/dist/capture/sameSite.js +40 -0
- package/dist/capture/sameSite.js.map +1 -0
- package/dist/capture/slots.js +50 -25
- package/dist/capture/slots.js.map +1 -1
- package/dist/capture/trackerConfig.js +131 -36
- package/dist/capture/trackerConfig.js.map +1 -1
- package/dist/capture/trackerEndpoint.js +22 -21
- package/dist/capture/trackerEndpoint.js.map +1 -1
- package/dist/capture/withoutConsent.js +91 -0
- package/dist/capture/withoutConsent.js.map +1 -0
- package/dist/charts/BarList.d.ts +27 -13
- package/dist/charts/BarList.js +38 -77
- package/dist/charts/BarList.js.map +1 -1
- package/dist/charts/TrendChart.d.ts +40 -7
- package/dist/charts/TrendChart.js +243 -215
- package/dist/charts/TrendChart.js.map +1 -1
- package/dist/charts/bars.d.ts +17 -1
- package/dist/charts/bars.js +12 -11
- package/dist/charts/bars.js.map +1 -1
- package/dist/charts/bucket.js +106 -73
- package/dist/charts/bucket.js.map +1 -1
- package/dist/charts/inProgress.js +22 -0
- package/dist/charts/inProgress.js.map +1 -0
- package/dist/charts/series.d.ts +15 -0
- package/dist/charts/series.js +123 -0
- package/dist/charts/series.js.map +1 -0
- package/dist/charts/spline.js +91 -25
- package/dist/charts/spline.js.map +1 -1
- package/dist/charts/trendGeometry.js +91 -0
- package/dist/charts/trendGeometry.js.map +1 -0
- package/dist/core/adminOptions.d.ts +1 -0
- package/dist/core/adminOptions.js +198 -0
- package/dist/core/adminOptions.js.map +1 -0
- package/dist/core/budget.js +24 -0
- package/dist/core/budget.js.map +1 -0
- package/dist/core/cacheKey.d.ts +1 -0
- package/dist/core/cacheKey.js +51 -29
- package/dist/core/cacheKey.js.map +1 -1
- package/dist/core/cacheOptions.js +165 -0
- package/dist/core/cacheOptions.js.map +1 -0
- package/dist/core/capabilities.d.ts +24 -11
- package/dist/core/capabilities.js +101 -17
- package/dist/core/capabilities.js.map +1 -1
- package/dist/core/capture.d.ts +59 -26
- package/dist/core/captureOptions.d.ts +1 -0
- package/dist/core/captureOptions.js +347 -0
- package/dist/core/captureOptions.js.map +1 -0
- package/dist/core/clock.js +13 -0
- package/dist/core/clock.js.map +1 -0
- package/dist/core/collectionOption.d.ts +17 -0
- package/dist/core/collectionOption.js +105 -0
- package/dist/core/collectionOption.js.map +1 -0
- package/dist/core/collectionSlug.js +7 -0
- package/dist/core/collectionSlug.js.map +1 -0
- package/dist/core/contract.d.ts +340 -49
- package/dist/core/contract.js +7 -4
- package/dist/core/contract.js.map +1 -1
- package/dist/core/cron.js +57 -0
- package/dist/core/cron.js.map +1 -0
- package/dist/core/fetch.d.ts +17 -0
- package/dist/core/goalOptions.d.ts +1 -0
- package/dist/core/goalOptions.js +166 -0
- package/dist/core/goalOptions.js.map +1 -0
- package/dist/core/granularity.js +3 -2
- package/dist/core/granularity.js.map +1 -1
- package/dist/core/guards.js +17 -0
- package/dist/core/guards.js.map +1 -0
- package/dist/core/jobs.d.ts +40 -0
- package/dist/core/jobs.js +132 -0
- package/dist/core/jobs.js.map +1 -0
- package/dist/core/legacyOptions.js +145 -0
- package/dist/core/legacyOptions.js.map +1 -0
- package/dist/core/metricAliases.js +81 -0
- package/dist/core/metricAliases.js.map +1 -0
- package/dist/core/metricValues.js +57 -0
- package/dist/core/metricValues.js.map +1 -0
- package/dist/core/monotonic.js +10 -0
- package/dist/core/monotonic.js.map +1 -0
- package/dist/core/optionChecks.js +51 -0
- package/dist/core/optionChecks.js.map +1 -0
- package/dist/core/options.d.ts +535 -151
- package/dist/core/options.js +158 -214
- package/dist/core/options.js.map +1 -1
- package/dist/core/registry.js +45 -5
- package/dist/core/registry.js.map +1 -1
- package/dist/core/scopeList.js +7 -9
- package/dist/core/scopeList.js.map +1 -1
- package/dist/core/scopeOptions.d.ts +1 -0
- package/dist/core/scopeOptions.js +114 -0
- package/dist/core/scopeOptions.js.map +1 -0
- package/dist/core/scopedRead.js +349 -36
- package/dist/core/scopedRead.js.map +1 -1
- package/dist/core/sdks.d.ts +81 -0
- package/dist/core/sdks.js +23 -0
- package/dist/core/sdks.js.map +1 -0
- package/dist/core/serverEvent.d.ts +50 -14
- package/dist/core/serverEvent.js.map +1 -1
- package/dist/core/siteAddress.js +20 -0
- package/dist/core/siteAddress.js.map +1 -0
- package/dist/core/sourceErrors.js +109 -0
- package/dist/core/sourceErrors.js.map +1 -0
- package/dist/core/sourceLabel.d.ts +10 -0
- package/dist/core/sourceLabel.js +63 -0
- package/dist/core/sourceLabel.js.map +1 -0
- package/dist/core/sourceOptions.js +107 -0
- package/dist/core/sourceOptions.js.map +1 -0
- package/dist/core/sourcePolicy.d.ts +55 -0
- package/dist/core/sourcePolicy.js +51 -0
- package/dist/core/sourcePolicy.js.map +1 -0
- package/dist/core/throttle.js +18 -0
- package/dist/core/throttle.js.map +1 -0
- package/dist/core/values.js +61 -0
- package/dist/core/values.js.map +1 -0
- package/dist/core/widgetSlugs.d.ts +17 -0
- package/dist/core/widgetSlugs.js +29 -0
- package/dist/core/widgetSlugs.js.map +1 -0
- package/dist/db/detachedWrite.js +36 -0
- package/dist/db/detachedWrite.js.map +1 -0
- package/dist/db/errors.js +182 -0
- package/dist/db/errors.js.map +1 -0
- package/dist/db/kind.js +32 -0
- package/dist/db/kind.js.map +1 -0
- package/dist/db/openTransaction.js +51 -0
- package/dist/db/openTransaction.js.map +1 -0
- package/dist/exports/adapters/contract.d.ts +15 -0
- package/dist/exports/adapters/ga4.d.ts +17 -1
- package/dist/exports/adapters/ga4.js +2 -1
- package/dist/exports/adapters/native.d.ts +29 -2
- package/dist/exports/adapters/native.js +5 -1
- package/dist/exports/adapters/plausible.d.ts +16 -1
- package/dist/exports/adapters/posthog.d.ts +16 -1
- package/dist/exports/adapters/umami.d.ts +16 -1
- package/dist/exports/attributes.d.ts +42 -0
- package/dist/exports/attributes.js +83 -0
- package/dist/exports/attributes.js.map +1 -0
- package/dist/exports/client.d.ts +45 -11
- package/dist/exports/client.js +23 -6
- package/dist/exports/geo.d.ts +4 -2
- package/dist/exports/geo.js +1 -1
- package/dist/exports/i18n.d.ts +2 -2
- package/dist/exports/i18n.js +2 -2
- package/dist/exports/migrations.d.ts +2 -0
- package/dist/exports/migrations.js +2 -0
- package/dist/exports/react.d.ts +5 -3
- package/dist/exports/react.js +1 -2
- package/dist/exports/routes.d.ts +19 -0
- package/dist/exports/routes.js +3 -0
- package/dist/exports/rsc.d.ts +33 -14
- package/dist/exports/rsc.js +11 -6
- package/dist/exports/site.d.ts +5 -0
- package/dist/exports/site.js +3 -0
- package/dist/exports/testing.d.ts +18 -0
- package/dist/exports/testing.js +3 -0
- package/dist/exports/tracker.d.ts +6 -17
- package/dist/exports/tracker.js +3 -11
- package/dist/exports/types.d.ts +46 -14
- package/dist/exports/types.js +7 -1
- package/dist/fields/AnalyticsPanelClient.js +265 -154
- package/dist/fields/AnalyticsPanelClient.js.map +1 -1
- package/dist/fields/AnalyticsPanelField.d.ts +19 -7
- package/dist/fields/AnalyticsPanelField.js +123 -30
- package/dist/fields/AnalyticsPanelField.js.map +1 -1
- package/dist/fields/AnalyticsStatField.d.ts +17 -6
- package/dist/fields/AnalyticsStatField.js +98 -63
- package/dist/fields/AnalyticsStatField.js.map +1 -1
- package/dist/fields/FieldShimmer.js +15 -0
- package/dist/fields/FieldShimmer.js.map +1 -0
- package/dist/fields/PanelContent.js +222 -0
- package/dist/fields/PanelContent.js.map +1 -0
- package/dist/fields/PanelList.js +82 -0
- package/dist/fields/PanelList.js.map +1 -0
- package/dist/fields/PanelLiveCounter.js +63 -0
- package/dist/fields/PanelLiveCounter.js.map +1 -0
- package/dist/fields/PanelSkeleton.js +63 -0
- package/dist/fields/PanelSkeleton.js.map +1 -0
- package/dist/fields/componentPaths.js +8 -0
- package/dist/fields/componentPaths.js.map +1 -0
- package/dist/fields/config/FilterDimensionSelectField.d.ts +14 -0
- package/dist/fields/config/FilterDimensionSelectField.js +49 -0
- package/dist/fields/config/FilterDimensionSelectField.js.map +1 -0
- package/dist/fields/config/FilterKeySelect.js +66 -0
- package/dist/fields/config/FilterKeySelect.js.map +1 -0
- package/dist/fields/config/FilterOperatorSelectField.d.ts +19 -0
- package/dist/fields/config/FilterOperatorSelectField.js +59 -0
- package/dist/fields/config/FilterOperatorSelectField.js.map +1 -0
- package/dist/fields/config/FilterValueField.d.ts +17 -0
- package/dist/fields/config/FilterValueField.js +130 -0
- package/dist/fields/config/FilterValueField.js.map +1 -0
- package/dist/fields/config/MetricSelectField.d.ts +5 -12
- package/dist/fields/config/MetricSelectField.js +19 -31
- package/dist/fields/config/MetricSelectField.js.map +1 -1
- package/dist/fields/config/OptionSelect.js +52 -0
- package/dist/fields/config/OptionSelect.js.map +1 -0
- package/dist/fields/config/SourceSelectField.js +16 -31
- package/dist/fields/config/SourceSelectField.js.map +1 -1
- package/dist/fields/config/fetchSources.d.ts +3 -0
- package/dist/fields/config/fetchSources.js +17 -23
- package/dist/fields/config/fetchSources.js.map +1 -1
- package/dist/fields/config/filterValues.js +106 -0
- package/dist/fields/config/filterValues.js.map +1 -0
- package/dist/fields/config/narrow.js +8 -10
- package/dist/fields/config/narrow.js.map +1 -1
- package/dist/fields/config/retiredPickers.d.ts +45 -0
- package/dist/fields/config/retiredPickers.js +46 -0
- package/dist/fields/config/retiredPickers.js.map +1 -0
- package/dist/fields/config/scopedFields.d.ts +40 -0
- package/dist/fields/config/scopedFields.js +68 -0
- package/dist/fields/config/scopedFields.js.map +1 -0
- package/dist/fields/config/sourcesState.js +19 -3
- package/dist/fields/config/sourcesState.js.map +1 -1
- package/dist/fields/config/toSelectOption.js +13 -7
- package/dist/fields/config/toSelectOption.js.map +1 -1
- package/dist/fields/config/useAnalyticsSources.d.ts +10 -7
- package/dist/fields/config/useAnalyticsSources.js +23 -24
- package/dist/fields/config/useAnalyticsSources.js.map +1 -1
- package/dist/fields/config/useFilterCapabilities.d.ts +31 -0
- package/dist/fields/config/useFilterCapabilities.js +60 -0
- package/dist/fields/config/useFilterCapabilities.js.map +1 -0
- package/dist/fields/config/useFormString.js +12 -0
- package/dist/fields/config/useFormString.js.map +1 -0
- package/dist/fields/dateRange/field.js +7 -19
- package/dist/fields/dateRange/field.js.map +1 -1
- package/dist/fields/dateRange/types.d.ts +5 -1
- package/dist/fields/dateRange/ui.d.ts +3 -2
- package/dist/fields/dateRange/ui.js +57 -319
- package/dist/fields/dateRange/ui.js.map +1 -1
- package/dist/fields/documentScope.js +21 -0
- package/dist/fields/documentScope.js.map +1 -0
- package/dist/fields/emptyState.js +30 -26
- package/dist/fields/emptyState.js.map +1 -1
- package/dist/fields/factories.d.ts +35 -16
- package/dist/fields/factories.js +67 -38
- package/dist/fields/factories.js.map +1 -1
- package/dist/fields/format.d.ts +12 -3
- package/dist/fields/format.js +77 -13
- package/dist/fields/format.js.map +1 -1
- package/dist/fields/itemReport.js +45 -0
- package/dist/fields/itemReport.js.map +1 -0
- package/dist/fields/readForDocument.d.ts +79 -26
- package/dist/fields/readForDocument.js +451 -105
- package/dist/fields/readForDocument.js.map +1 -1
- package/dist/fields/stateKeys.js +20 -0
- package/dist/fields/stateKeys.js.map +1 -0
- package/dist/goals/GoalAmountField.d.ts +10 -0
- package/dist/goals/GoalAmountField.js +179 -0
- package/dist/goals/GoalAmountField.js.map +1 -0
- package/dist/goals/GoalSelectField.js +89 -40
- package/dist/goals/GoalSelectField.js.map +1 -1
- package/dist/goals/GoalSelectFieldServer.d.ts +13 -0
- package/dist/goals/GoalSelectFieldServer.js +21 -0
- package/dist/goals/GoalSelectFieldServer.js.map +1 -0
- package/dist/goals/amountField.d.ts +20 -0
- package/dist/goals/amountField.js +37 -0
- package/dist/goals/amountField.js.map +1 -0
- package/dist/goals/builtin.js +17 -0
- package/dist/goals/builtin.js.map +1 -0
- package/dist/goals/collection.d.ts +22 -0
- package/dist/goals/collection.js +143 -124
- package/dist/goals/collection.js.map +1 -1
- package/dist/goals/constants.d.ts +38 -0
- package/dist/goals/constants.js +49 -0
- package/dist/goals/constants.js.map +1 -0
- package/dist/goals/currency.d.ts +16 -0
- package/dist/goals/currency.js +46 -4
- package/dist/goals/currency.js.map +1 -1
- package/dist/goals/currencyOptions.js +70 -0
- package/dist/goals/currencyOptions.js.map +1 -0
- package/dist/goals/fetchGoals.d.ts +10 -0
- package/dist/goals/fetchGoals.js +12 -22
- package/dist/goals/fetchGoals.js.map +1 -1
- package/dist/goals/goalField.d.ts +4 -6
- package/dist/goals/goalField.js +9 -19
- package/dist/goals/goalField.js.map +1 -1
- package/dist/goals/goalsEndpoint.js +40 -38
- package/dist/goals/goalsEndpoint.js.map +1 -1
- package/dist/goals/items.js +35 -0
- package/dist/goals/items.js.map +1 -0
- package/dist/goals/latent.js +9 -0
- package/dist/goals/latent.js.map +1 -0
- package/dist/goals/linkFields.d.ts +35 -0
- package/dist/goals/linkFields.js +31 -0
- package/dist/goals/linkFields.js.map +1 -0
- package/dist/goals/match.d.ts +14 -0
- package/dist/goals/match.js +67 -46
- package/dist/goals/match.js.map +1 -1
- package/dist/goals/moneyFields.js +56 -0
- package/dist/goals/moneyFields.js.map +1 -0
- package/dist/goals/pathMatch.js +122 -0
- package/dist/goals/pathMatch.js.map +1 -0
- package/dist/goals/placeholder.js +12 -0
- package/dist/goals/placeholder.js.map +1 -0
- package/dist/goals/resolver.d.ts +3 -3
- package/dist/goals/resolver.js +155 -47
- package/dist/goals/resolver.js.map +1 -1
- package/dist/goals/serverRevenue.d.ts +60 -0
- package/dist/goals/serverRevenue.js +41 -0
- package/dist/goals/serverRevenue.js.map +1 -0
- package/dist/goals/trackGoalAction.d.ts +26 -25
- package/dist/goals/trackGoalAction.js +71 -66
- package/dist/goals/trackGoalAction.js.map +1 -1
- package/dist/goals/types.d.ts +13 -28
- package/dist/goals/types.js +1 -1
- package/dist/goals/types.js.map +1 -1
- package/dist/goals/useAnalyticsGoals.d.ts +6 -5
- package/dist/goals/useAnalyticsGoals.js +17 -18
- package/dist/goals/useAnalyticsGoals.js.map +1 -1
- package/dist/index.d.ts +69 -11
- package/dist/index.js +262 -192
- package/dist/index.js.map +1 -1
- package/dist/items/collectionIdType.js +20 -0
- package/dist/items/collectionIdType.js.map +1 -0
- package/dist/items/idType.js +31 -0
- package/dist/items/idType.js.map +1 -0
- package/dist/items/ref.js +73 -0
- package/dist/items/ref.js.map +1 -0
- package/dist/maintenance/apiTaskState.js +141 -0
- package/dist/maintenance/apiTaskState.js.map +1 -0
- package/dist/maintenance/heartbeat.js +51 -0
- package/dist/maintenance/heartbeat.js.map +1 -0
- package/dist/maintenance/lease.d.ts +1 -0
- package/dist/maintenance/lease.js +79 -0
- package/dist/maintenance/lease.js.map +1 -0
- package/dist/maintenance/taskSchedule.js +27 -0
- package/dist/maintenance/taskSchedule.js.map +1 -0
- package/dist/maintenance/underLease.js +35 -0
- package/dist/maintenance/underLease.js.map +1 -0
- package/dist/migrations/legacy.d.ts +54 -0
- package/dist/migrations/legacy.js +117 -0
- package/dist/migrations/legacy.js.map +1 -0
- package/dist/migrations/predefined/dropLegacyMongo.d.ts +11 -0
- package/dist/migrations/predefined/dropLegacyMongo.js +12 -0
- package/dist/migrations/predefined/dropLegacyMongo.js.map +1 -0
- package/dist/native/collections/aggregates.js +54 -0
- package/dist/native/collections/aggregates.js.map +1 -0
- package/dist/native/collections/hits.js +103 -0
- package/dist/native/collections/hits.js.map +1 -0
- package/dist/native/collections/slugs.d.ts +10 -0
- package/dist/native/collections/slugs.js +16 -0
- package/dist/native/collections/slugs.js.map +1 -0
- package/dist/native/collections/state.js +84 -0
- package/dist/native/collections/state.js.map +1 -0
- package/dist/native/collections/storeCollection.js +31 -0
- package/dist/native/collections/storeCollection.js.map +1 -0
- package/dist/native/engine/buckets.d.ts +1 -0
- package/dist/native/engine/buckets.js +53 -0
- package/dist/native/engine/buckets.js.map +1 -0
- package/dist/native/engine/capabilities.js +87 -0
- package/dist/native/engine/capabilities.js.map +1 -0
- package/dist/native/engine/cost.js +72 -0
- package/dist/native/engine/cost.js.map +1 -0
- package/dist/native/engine/days.d.ts +1 -0
- package/dist/native/engine/days.js +182 -0
- package/dist/native/engine/days.js.map +1 -0
- package/dist/native/engine/engine.d.ts +1 -0
- package/dist/native/engine/engine.js +1627 -0
- package/dist/native/engine/engine.js.map +1 -0
- package/dist/native/engine/instance.js +58 -0
- package/dist/native/engine/instance.js.map +1 -0
- package/dist/native/engine/maintenance.d.ts +1 -0
- package/dist/native/engine/maintenance.js +677 -0
- package/dist/native/engine/maintenance.js.map +1 -0
- package/dist/native/engine/merge.js +41 -0
- package/dist/native/engine/merge.js.map +1 -0
- package/dist/native/engine/nudge.js +26 -0
- package/dist/native/engine/nudge.js.map +1 -0
- package/dist/native/engine/planner.js +199 -0
- package/dist/native/engine/planner.js.map +1 -0
- package/dist/native/engine/rebuild.d.ts +22 -0
- package/dist/native/engine/rebuild.js +76 -0
- package/dist/native/engine/rebuild.js.map +1 -0
- package/dist/native/engine/recent.js +17 -0
- package/dist/native/engine/recent.js.map +1 -0
- package/dist/native/engine/salt.d.ts +1 -0
- package/dist/native/engine/salt.js +98 -0
- package/dist/native/engine/salt.js.map +1 -0
- package/dist/native/engine/siteHosts.d.ts +1 -0
- package/dist/native/engine/siteHosts.js +58 -0
- package/dist/native/engine/siteHosts.js.map +1 -0
- package/dist/native/engine/toHit.js +110 -0
- package/dist/native/engine/toHit.js.map +1 -0
- package/dist/native/engine/writeBuffer.d.ts +14 -0
- package/dist/native/engine/writeBuffer.js +317 -0
- package/dist/native/engine/writeBuffer.js.map +1 -0
- package/dist/native/geo/composeGeoResolvers.d.ts +1 -0
- package/dist/native/geo/composeGeoResolvers.js +5 -2
- package/dist/native/geo/composeGeoResolvers.js.map +1 -1
- package/dist/native/geo/geoResolver.d.ts +27 -2
- package/dist/native/geo/geoResolver.js +42 -6
- package/dist/native/geo/geoResolver.js.map +1 -1
- package/dist/native/geo/maxmindResolver.d.ts +8 -4
- package/dist/native/geo/maxmindResolver.js +20 -16
- package/dist/native/geo/maxmindResolver.js.map +1 -1
- package/dist/native/geo/resolveGeo.js +31 -0
- package/dist/native/geo/resolveGeo.js.map +1 -0
- package/dist/native/ingest/bots.d.ts +10 -0
- package/dist/native/ingest/bots.js +66 -0
- package/dist/native/ingest/bots.js.map +1 -0
- package/dist/native/ingest/browser.js +45 -0
- package/dist/native/ingest/browser.js.map +1 -0
- package/dist/native/ingest/clientIp.js +34 -8
- package/dist/native/ingest/clientIp.js.map +1 -1
- package/dist/native/ingest/device.js +4 -6
- package/dist/native/ingest/device.js.map +1 -1
- package/dist/native/ingest/endpoint.d.ts +1 -1
- package/dist/native/ingest/endpoint.js +185 -32
- package/dist/native/ingest/endpoint.js.map +1 -1
- package/dist/native/ingest/itemSignature.d.ts +26 -0
- package/dist/native/ingest/itemSignature.js +45 -0
- package/dist/native/ingest/itemSignature.js.map +1 -0
- package/dist/native/ingest/language.js +13 -0
- package/dist/native/ingest/language.js.map +1 -0
- package/dist/native/ingest/normalizeEvent.d.ts +73 -5
- package/dist/native/ingest/normalizeEvent.js +257 -51
- package/dist/native/ingest/normalizeEvent.js.map +1 -1
- package/dist/native/ingest/orderSignature.d.ts +13 -0
- package/dist/native/ingest/orderSignature.js +50 -0
- package/dist/native/ingest/orderSignature.js.map +1 -0
- package/dist/native/ingest/referrer.js +46 -0
- package/dist/native/ingest/referrer.js.map +1 -0
- package/dist/native/ingest/requestHost.js +44 -0
- package/dist/native/ingest/requestHost.js.map +1 -0
- package/dist/native/ingest/resolveHostname.d.ts +20 -0
- package/dist/native/ingest/resolveHostname.js +51 -0
- package/dist/native/ingest/resolveHostname.js.map +1 -0
- package/dist/native/ingest/revenue.d.ts +1 -0
- package/dist/native/ingest/revenue.js +121 -0
- package/dist/native/ingest/revenue.js.map +1 -0
- package/dist/native/ingest/route.d.ts +10 -0
- package/dist/native/ingest/route.js +85 -0
- package/dist/native/ingest/route.js.map +1 -0
- package/dist/native/ingest/serverTrack.d.ts +2 -10
- package/dist/native/ingest/serverTrack.js +188 -68
- package/dist/native/ingest/serverTrack.js.map +1 -1
- package/dist/native/ingest/signature.js +28 -0
- package/dist/native/ingest/signature.js.map +1 -0
- package/dist/native/ingest/source.d.ts +10 -0
- package/dist/native/ingest/source.js +245 -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 +25 -13
- package/dist/native/ingest/validate.js.map +1 -1
- package/dist/native/ingest/visitorHash.js +6 -8
- package/dist/native/ingest/visitorHash.js.map +1 -1
- package/dist/native/nativeAdapter.d.ts +128 -9
- package/dist/native/nativeAdapter.js +395 -281
- package/dist/native/nativeAdapter.js.map +1 -1
- package/dist/native/rebuildDays.d.ts +12 -0
- package/dist/native/rebuildDays.js +16 -0
- package/dist/native/rebuildDays.js.map +1 -0
- package/dist/native/store/aggregate.js +450 -0
- package/dist/native/store/aggregate.js.map +1 -0
- package/dist/native/store/caps.d.ts +18 -0
- package/dist/native/store/caps.js +76 -0
- package/dist/native/store/caps.js.map +1 -0
- package/dist/native/store/chunks.js +34 -0
- package/dist/native/store/chunks.js.map +1 -0
- package/dist/native/store/columnValues.js +31 -0
- package/dist/native/store/columnValues.js.map +1 -0
- package/dist/native/store/dialect.js +106 -0
- package/dist/native/store/dialect.js.map +1 -0
- package/dist/native/store/eventStore.js +44 -0
- package/dist/native/store/eventStore.js.map +1 -0
- package/dist/native/store/hitRow.js +119 -0
- package/dist/native/store/hitRow.js.map +1 -0
- package/dist/native/store/hits.js +65 -0
- package/dist/native/store/hits.js.map +1 -0
- package/dist/native/store/ids.js +105 -0
- package/dist/native/store/ids.js.map +1 -0
- package/dist/native/store/mongo/aggregatePipelines.js +438 -0
- package/dist/native/store/mongo/aggregatePipelines.js.map +1 -0
- package/dist/native/store/mongo/mongoState.js +375 -0
- package/dist/native/store/mongo/mongoState.js.map +1 -0
- package/dist/native/store/mongo/mongoStore.js +618 -0
- package/dist/native/store/mongo/mongoStore.js.map +1 -0
- package/dist/native/store/mongo/pipelines.js +705 -0
- package/dist/native/store/mongo/pipelines.js.map +1 -0
- package/dist/native/store/mongo/results.js +20 -0
- package/dist/native/store/mongo/results.js.map +1 -0
- package/dist/native/store/parts.d.ts +1 -0
- package/dist/native/store/parts.js +101 -0
- package/dist/native/store/parts.js.map +1 -0
- package/dist/native/store/pattern.js +213 -0
- package/dist/native/store/pattern.js.map +1 -0
- package/dist/native/store/rawRead.d.ts +23 -0
- package/dist/native/store/rawRead.js +387 -0
- package/dist/native/store/rawRead.js.map +1 -0
- package/dist/native/store/reclassify.js +53 -0
- package/dist/native/store/reclassify.js.map +1 -0
- package/dist/native/store/sql/aggregateSql.js +349 -0
- package/dist/native/store/sql/aggregateSql.js.map +1 -0
- package/dist/native/store/sql/columns.js +49 -0
- package/dist/native/store/sql/columns.js.map +1 -0
- package/dist/native/store/sql/compile.js +668 -0
- package/dist/native/store/sql/compile.js.map +1 -0
- package/dist/native/store/sql/drivers.js +218 -0
- package/dist/native/store/sql/drivers.js.map +1 -0
- package/dist/native/store/sql/executor.js +132 -0
- package/dist/native/store/sql/executor.js.map +1 -0
- package/dist/native/store/sql/fragment.js +104 -0
- package/dist/native/store/sql/fragment.js.map +1 -0
- package/dist/native/store/sql/maintenanceSql.js +59 -0
- package/dist/native/store/sql/maintenanceSql.js.map +1 -0
- package/dist/native/store/sql/ownConnection.js +107 -0
- package/dist/native/store/sql/ownConnection.js.map +1 -0
- package/dist/native/store/sql/poolShare.js +101 -0
- package/dist/native/store/sql/poolShare.js.map +1 -0
- package/dist/native/store/sql/sqlState.js +325 -0
- package/dist/native/store/sql/sqlState.js.map +1 -0
- package/dist/native/store/sql/sqlStore.js +355 -0
- package/dist/native/store/sql/sqlStore.js.map +1 -0
- package/dist/native/store/sql/sqliteThread.d.ts +9 -0
- package/dist/native/store/sql/sqliteThread.js +314 -0
- package/dist/native/store/sql/sqliteThread.js.map +1 -0
- package/dist/native/store/sql/sqliteWorker.js +327 -0
- package/dist/native/store/sql/sqliteWorker.js.map +1 -0
- package/dist/native/store/sql/sqliteWorkerSource.js +347 -0
- package/dist/native/store/sql/sqliteWorkerSource.js.map +1 -0
- package/dist/native/store/state.js +151 -0
- package/dist/native/store/state.js.map +1 -0
- package/dist/native/store/stateStore.js +29 -0
- package/dist/native/store/stateStore.js.map +1 -0
- package/dist/native/store/types.d.ts +15 -0
- package/dist/native/store/types.js +10 -0
- package/dist/native/store/types.js.map +1 -0
- package/dist/native/tasks/maintainTask.d.ts +19 -0
- package/dist/native/tasks/maintainTask.js +57 -0
- package/dist/native/tasks/maintainTask.js.map +1 -0
- package/dist/net/guardedFetch.d.ts +32 -0
- package/dist/net/guardedFetch.js +220 -0
- package/dist/net/guardedFetch.js.map +1 -0
- package/dist/net/origin.js +40 -0
- package/dist/net/origin.js.map +1 -0
- package/dist/net/platform.d.ts +9 -0
- package/dist/net/platform.js +35 -0
- package/dist/net/platform.js.map +1 -0
- package/dist/plugin/adminDependencies.js +34 -0
- package/dist/plugin/adminDependencies.js.map +1 -0
- package/dist/plugin/apiPath.js +23 -0
- package/dist/plugin/apiPath.js.map +1 -0
- package/dist/plugin/boundDocument.js +58 -0
- package/dist/plugin/boundDocument.js.map +1 -0
- package/dist/plugin/buildPhase.js +10 -0
- package/dist/plugin/buildPhase.js.map +1 -0
- package/dist/plugin/collectionChecks.js +232 -0
- package/dist/plugin/collectionChecks.js.map +1 -0
- package/dist/plugin/collectionFields.d.ts +13 -0
- package/dist/plugin/collectionFields.js +22 -0
- package/dist/plugin/collectionFields.js.map +1 -0
- package/dist/plugin/createRuntime.js +346 -0
- package/dist/plugin/createRuntime.js.map +1 -0
- package/dist/plugin/destroy.js +58 -0
- package/dist/plugin/destroy.js.map +1 -0
- package/dist/plugin/documentEndpoint.js +106 -53
- package/dist/plugin/documentEndpoint.js.map +1 -1
- package/dist/plugin/documentScopes.js +37 -0
- package/dist/plugin/documentScopes.js.map +1 -0
- package/dist/plugin/encrypted.js +25 -0
- package/dist/plugin/encrypted.js.map +1 -0
- package/dist/plugin/errors.d.ts +24 -0
- package/dist/plugin/errors.js +86 -0
- package/dist/plugin/errors.js.map +1 -0
- package/dist/plugin/flagsEndpoint.js +41 -0
- package/dist/plugin/flagsEndpoint.js.map +1 -0
- package/dist/plugin/goalHint.d.ts +1 -0
- package/dist/plugin/goalHint.js +35 -0
- package/dist/plugin/goalHint.js.map +1 -0
- package/dist/plugin/itemLabels.js +114 -0
- package/dist/plugin/itemLabels.js.map +1 -0
- package/dist/plugin/keepAlive.js +48 -0
- package/dist/plugin/keepAlive.js.map +1 -0
- package/dist/plugin/peerImportError.js +3 -6
- package/dist/plugin/peerImportError.js.map +1 -1
- package/dist/plugin/peers.js +64 -0
- package/dist/plugin/peers.js.map +1 -0
- package/dist/plugin/pluginCollections.js +161 -0
- package/dist/plugin/pluginCollections.js.map +1 -0
- package/dist/plugin/queryEndpoint.js +88 -52
- package/dist/plugin/queryEndpoint.js.map +1 -1
- package/dist/plugin/queryParams.js +7 -0
- package/dist/plugin/queryParams.js.map +1 -0
- package/dist/plugin/readContextForRequest.d.ts +11 -0
- package/dist/plugin/readContextForRequest.js +79 -32
- package/dist/plugin/readContextForRequest.js.map +1 -1
- package/dist/plugin/readFailure.js +22 -0
- package/dist/plugin/readFailure.js.map +1 -0
- package/dist/plugin/readableProviders.js +67 -0
- package/dist/plugin/readableProviders.js.map +1 -0
- package/dist/plugin/realtimeEndpoint.js +91 -21
- package/dist/plugin/realtimeEndpoint.js.map +1 -1
- package/dist/plugin/refreshEndpoint.js +138 -0
- package/dist/plugin/refreshEndpoint.js.map +1 -0
- package/dist/plugin/relabelFields.js +36 -0
- package/dist/plugin/relabelFields.js.map +1 -0
- package/dist/plugin/requestMemo.js +35 -0
- package/dist/plugin/requestMemo.js.map +1 -0
- package/dist/plugin/routeChecks.js +39 -0
- package/dist/plugin/routeChecks.js.map +1 -0
- package/dist/plugin/routes.d.ts +53 -0
- package/dist/plugin/routes.js +92 -0
- package/dist/plugin/routes.js.map +1 -0
- package/dist/plugin/runtime.d.ts +1 -1
- package/dist/plugin/runtime.js +235 -29
- package/dist/plugin/runtime.js.map +1 -1
- package/dist/plugin/schemaOnly.js +61 -0
- package/dist/plugin/schemaOnly.js.map +1 -0
- package/dist/plugin/scopeChange.js +23 -0
- package/dist/plugin/scopeChange.js.map +1 -0
- package/dist/plugin/scopeFieldBoot.js +4 -4
- package/dist/plugin/scopeFieldBoot.js.map +1 -1
- package/dist/plugin/scopeToken.js +33 -0
- package/dist/plugin/scopeToken.js.map +1 -0
- package/dist/plugin/sourcesEndpoint.js +50 -16
- package/dist/plugin/sourcesEndpoint.js.map +1 -1
- package/dist/plugin/unbundledLanguages.js +25 -0
- package/dist/plugin/unbundledLanguages.js.map +1 -0
- package/dist/plugin/walkFields.js +24 -0
- package/dist/plugin/walkFields.js.map +1 -0
- package/dist/plugin/warmTask.js +0 -0
- package/dist/plugin/warmTask.js.map +1 -1
- package/dist/providers/ProvidersListNotice.d.ts +11 -0
- package/dist/providers/ProvidersListNotice.js +36 -0
- package/dist/providers/ProvidersListNotice.js.map +1 -0
- package/dist/providers/access.d.ts +1 -0
- package/dist/providers/access.js +35 -26
- package/dist/providers/access.js.map +1 -1
- package/dist/providers/adapterPool.js +121 -0
- package/dist/providers/adapterPool.js.map +1 -0
- package/dist/providers/collection.d.ts +63 -0
- package/dist/providers/collection.js +372 -143
- package/dist/providers/collection.js.map +1 -1
- package/dist/providers/factory.d.ts +84 -0
- package/dist/providers/factory.js +86 -25
- package/dist/providers/factory.js.map +1 -1
- package/dist/providers/hosts.d.ts +25 -0
- package/dist/providers/hosts.js +128 -0
- package/dist/providers/hosts.js.map +1 -0
- package/dist/providers/probe.d.ts +1 -0
- package/dist/providers/probe.js +105 -0
- package/dist/providers/probe.js.map +1 -0
- package/dist/providers/refresh.d.ts +18 -0
- package/dist/providers/refresh.js +49 -0
- package/dist/providers/refresh.js.map +1 -0
- package/dist/providers/registry.js +329 -0
- package/dist/providers/registry.js.map +1 -0
- package/dist/providers/resolver.js +26 -88
- package/dist/providers/resolver.js.map +1 -1
- package/dist/providers/retarget.js +45 -0
- package/dist/providers/retarget.js.map +1 -0
- package/dist/providers/scopeUnique.js +41 -0
- package/dist/providers/scopeUnique.js.map +1 -0
- package/dist/providers/secrets.d.ts +26 -0
- package/dist/providers/secrets.js +61 -4
- package/dist/providers/secrets.js.map +1 -1
- package/dist/providers/stampScope.js +9 -6
- package/dist/providers/stampScope.js.map +1 -1
- package/dist/query/dates.js +10 -12
- package/dist/query/dates.js.map +1 -1
- package/dist/query/errors.d.ts +6 -13
- package/dist/query/fetchQuery.d.ts +36 -23
- package/dist/query/fetchQuery.js +96 -89
- package/dist/query/fetchQuery.js.map +1 -1
- package/dist/query/limits.js +8 -0
- package/dist/query/limits.js.map +1 -0
- package/dist/query/parse.d.ts +8 -2
- package/dist/query/parse.js +155 -108
- package/dist/query/parse.js.map +1 -1
- package/dist/query/response.d.ts +27 -4
- package/dist/query/response.js +18 -0
- package/dist/query/response.js.map +1 -0
- package/dist/react/AnalyticsProvider.d.ts +42 -20
- package/dist/react/AnalyticsProvider.js +24 -22
- package/dist/react/AnalyticsProvider.js.map +1 -1
- package/dist/react/TrackerBoot.js +15 -9
- package/dist/react/TrackerBoot.js.map +1 -1
- package/dist/react/useAnalytics.d.ts +2 -8
- package/dist/react/useAnalytics.js +31 -13
- package/dist/react/useAnalytics.js.map +1 -1
- package/dist/routes/captureRoute.d.ts +28 -0
- package/dist/routes/captureRoute.js +67 -0
- package/dist/routes/captureRoute.js.map +1 -0
- package/dist/routes/ingestRoute.d.ts +17 -0
- package/dist/routes/ingestRoute.js +17 -0
- package/dist/routes/ingestRoute.js.map +1 -0
- package/dist/site/AnalyticsScripts.d.ts +35 -0
- package/dist/site/AnalyticsScripts.js +44 -0
- package/dist/site/AnalyticsScripts.js.map +1 -0
- package/dist/site/getTrackerConfig.d.ts +15 -0
- package/dist/site/getTrackerConfig.js +43 -0
- package/dist/site/getTrackerConfig.js.map +1 -0
- package/dist/surfacing/afterRead.d.ts +37 -0
- package/dist/surfacing/bounded.js +38 -0
- package/dist/surfacing/bounded.js.map +1 -0
- package/dist/surfacing/breaker.js +107 -0
- package/dist/surfacing/breaker.js.map +1 -0
- package/dist/surfacing/cacheCollection.d.ts +8 -0
- package/dist/surfacing/cacheCollection.js +71 -0
- package/dist/surfacing/cacheCollection.js.map +1 -0
- package/dist/surfacing/cacheStore.d.ts +71 -1
- package/dist/surfacing/cacheStore.js +16 -37
- package/dist/surfacing/cacheStore.js.map +1 -1
- package/dist/surfacing/cacheSweep.d.ts +1 -0
- package/dist/surfacing/cacheSweep.js +59 -0
- package/dist/surfacing/cacheSweep.js.map +1 -0
- package/dist/surfacing/classifyError.js +282 -0
- package/dist/surfacing/classifyError.js.map +1 -0
- package/dist/surfacing/coalesce.js +2 -1
- package/dist/surfacing/coalesce.js.map +1 -1
- package/dist/surfacing/coldBudget.js +60 -0
- package/dist/surfacing/coldBudget.js.map +1 -0
- package/dist/surfacing/collectionCacheStore.js +183 -0
- package/dist/surfacing/collectionCacheStore.js.map +1 -0
- package/dist/surfacing/engine.d.ts +1 -1
- package/dist/surfacing/engine.js +514 -71
- package/dist/surfacing/engine.js.map +1 -1
- package/dist/surfacing/epoch.d.ts +1 -0
- package/dist/surfacing/epoch.js +116 -0
- package/dist/surfacing/epoch.js.map +1 -0
- package/dist/surfacing/lanes.d.ts +1 -0
- package/dist/surfacing/lanes.js +297 -0
- package/dist/surfacing/lanes.js.map +1 -0
- package/dist/surfacing/memo.js +40 -0
- package/dist/surfacing/memo.js.map +1 -0
- package/dist/surfacing/rateLimiter.d.ts +1 -0
- package/dist/surfacing/rateLimiter.js +69 -94
- package/dist/surfacing/rateLimiter.js.map +1 -1
- package/dist/surfacing/rebucket.js +178 -0
- package/dist/surfacing/rebucket.js.map +1 -0
- package/dist/surfacing/recipe.js +28 -0
- package/dist/surfacing/recipe.js.map +1 -0
- package/dist/surfacing/shape.js +22 -0
- package/dist/surfacing/shape.js.map +1 -0
- package/dist/surfacing/todaySplit.js +119 -0
- package/dist/surfacing/todaySplit.js.map +1 -0
- package/dist/sync/collection.d.ts +8 -0
- package/dist/sync/collection.js +30 -18
- package/dist/sync/collection.js.map +1 -1
- package/dist/sync/rekeyDurations.js +70 -0
- package/dist/sync/rekeyDurations.js.map +1 -0
- package/dist/sync/syncTask.js +222 -109
- package/dist/sync/syncTask.js.map +1 -1
- package/dist/testing/memoryAdapter.d.ts +6 -3
- package/dist/testing/memoryAdapter.js +12 -11
- package/dist/testing/memoryAdapter.js.map +1 -1
- package/dist/testing/settle.d.ts +11 -0
- package/dist/testing/settle.js +19 -0
- package/dist/testing/settle.js.map +1 -0
- package/dist/timeframe/calendar.js +65 -0
- package/dist/timeframe/calendar.js.map +1 -0
- package/dist/timeframe/comparison.js +46 -0
- package/dist/timeframe/comparison.js.map +1 -0
- package/dist/timeframe/presets.d.ts +1 -1
- package/dist/timeframe/presets.js +5 -5
- package/dist/timeframe/presets.js.map +1 -1
- package/dist/timeframe/reportingTimezone.d.ts +1 -0
- package/dist/timeframe/reportingTimezone.js +64 -0
- package/dist/timeframe/reportingTimezone.js.map +1 -0
- package/dist/timeframe/tz.js +55 -39
- package/dist/timeframe/tz.js.map +1 -1
- package/dist/tracker/autoCapture.js +125 -38
- package/dist/tracker/autoCapture.js.map +1 -1
- package/dist/tracker/campaign.js +52 -0
- package/dist/tracker/campaign.js.map +1 -0
- package/dist/tracker/config.d.ts +174 -0
- package/dist/tracker/config.js +25 -0
- package/dist/tracker/config.js.map +1 -0
- package/dist/tracker/createTracker.d.ts +5 -10
- package/dist/tracker/createTracker.js +437 -82
- package/dist/tracker/createTracker.js.map +1 -1
- package/dist/tracker/digest.js +28 -0
- package/dist/tracker/digest.js.map +1 -0
- package/dist/tracker/engagement.js +100 -0
- package/dist/tracker/engagement.js.map +1 -0
- package/dist/tracker/events.js +37 -0
- package/dist/tracker/events.js.map +1 -0
- package/dist/tracker/exclusion.d.ts +8 -0
- package/dist/tracker/exclusion.js +82 -0
- package/dist/tracker/exclusion.js.map +1 -0
- package/dist/tracker/gate.d.ts +8 -0
- package/dist/tracker/gate.js +244 -0
- package/dist/tracker/gate.js.map +1 -0
- package/dist/tracker/initTracker.d.ts +5 -8
- package/dist/tracker/initTracker.js +42 -14
- package/dist/tracker/initTracker.js.map +1 -1
- package/dist/tracker/itemCapture.js +224 -0
- package/dist/tracker/itemCapture.js.map +1 -0
- package/dist/tracker/loadScript.js +23 -15
- package/dist/tracker/loadScript.js.map +1 -1
- package/dist/tracker/pageTracking.js +6 -6
- package/dist/tracker/pageTracking.js.map +1 -1
- package/dist/tracker/registry.js +129 -30
- package/dist/tracker/registry.js.map +1 -1
- package/dist/tracker/sinks/createSink.js +60 -0
- package/dist/tracker/sinks/createSink.js.map +1 -0
- package/dist/tracker/sinks/ga4.js +106 -0
- package/dist/tracker/sinks/ga4.js.map +1 -0
- package/dist/tracker/sinks/native.js +21 -42
- package/dist/tracker/sinks/native.js.map +1 -1
- package/dist/tracker/sinks/plausible.js +36 -18
- package/dist/tracker/sinks/plausible.js.map +1 -1
- package/dist/tracker/sinks/posthog.js +145 -9
- package/dist/tracker/sinks/posthog.js.map +1 -1
- package/dist/tracker/sinks/umami.js +18 -10
- package/dist/tracker/sinks/umami.js.map +1 -1
- package/dist/tracker/sinks/vendor.js +54 -22
- package/dist/tracker/sinks/vendor.js.map +1 -1
- package/dist/tracker/skip.js +81 -0
- package/dist/tracker/skip.js.map +1 -0
- package/dist/tracker/storage.js +23 -0
- package/dist/tracker/storage.js.map +1 -0
- package/dist/tracker/transport.js +2 -5
- package/dist/tracker/transport.js.map +1 -1
- package/dist/tracker/types.d.ts +99 -44
- package/dist/tracker/window.js +7 -0
- package/dist/tracker/window.js.map +1 -0
- package/dist/translations/ar.js +266 -56
- package/dist/translations/ar.js.map +1 -1
- package/dist/translations/de.js +256 -55
- package/dist/translations/de.js.map +1 -1
- package/dist/translations/en.js +253 -56
- package/dist/translations/en.js.map +1 -1
- package/dist/translations/es.js +261 -57
- package/dist/translations/es.js.map +1 -1
- package/dist/translations/fr.js +265 -61
- package/dist/translations/fr.js.map +1 -1
- package/dist/translations/id.js +256 -56
- package/dist/translations/id.js.map +1 -1
- package/dist/translations/index.d.ts +1 -1
- package/dist/translations/index.js +5 -7
- package/dist/translations/index.js.map +1 -1
- package/dist/translations/intl.js +71 -0
- package/dist/translations/intl.js.map +1 -0
- package/dist/translations/keys.d.ts +240 -14
- package/dist/translations/keys.js +245 -14
- package/dist/translations/keys.js.map +1 -1
- package/dist/translations/ko.js +258 -58
- package/dist/translations/ko.js.map +1 -1
- package/dist/translations/labelMap.d.ts +10 -0
- package/dist/translations/labelMap.js +22 -0
- package/dist/translations/labelMap.js.map +1 -0
- package/dist/translations/metricKeys.js +16 -2
- package/dist/translations/metricKeys.js.map +1 -1
- package/dist/translations/parts.js +20 -0
- package/dist/translations/parts.js.map +1 -0
- package/dist/translations/plural.js +61 -0
- package/dist/translations/plural.js.map +1 -0
- package/dist/translations/pt.js +270 -66
- package/dist/translations/pt.js.map +1 -1
- package/dist/translations/ru.js +261 -55
- package/dist/translations/ru.js.map +1 -1
- package/dist/translations/server.d.ts +1 -0
- package/dist/translations/server.js +2 -3
- package/dist/translations/server.js.map +1 -1
- package/dist/translations/staticLabel.js +69 -0
- package/dist/translations/staticLabel.js.map +1 -0
- package/dist/translations/uk.js +261 -55
- package/dist/translations/uk.js.map +1 -1
- package/dist/translations/zh.js +256 -56
- package/dist/translations/zh.js.map +1 -1
- package/dist/ui/RangePicker.js +110 -0
- package/dist/ui/RangePicker.js.map +1 -0
- package/dist/ui/analytics.css +1667 -0
- package/dist/ui/calendarDays.js +27 -0
- package/dist/ui/calendarDays.js.map +1 -0
- package/dist/ui/classNames.js +7 -0
- package/dist/ui/classNames.js.map +1 -0
- package/dist/ui/components/Card.d.ts +28 -0
- package/dist/ui/components/Card.js +21 -0
- package/dist/ui/components/Card.js.map +1 -0
- package/dist/ui/components/ChartDataTable.d.ts +41 -0
- package/dist/ui/components/ChartDataTable.js +48 -0
- package/dist/ui/components/ChartDataTable.js.map +1 -0
- package/dist/ui/components/ChoiceMenu.js +48 -0
- package/dist/ui/components/ChoiceMenu.js.map +1 -0
- package/dist/ui/components/DataTable.d.ts +82 -0
- package/dist/ui/components/DataTable.js +214 -0
- package/dist/ui/components/DataTable.js.map +1 -0
- package/dist/ui/components/LabeledSelect.js +62 -0
- package/dist/ui/components/LabeledSelect.js.map +1 -0
- package/dist/ui/components/LiveAnnouncement.js +21 -0
- package/dist/ui/components/LiveAnnouncement.js.map +1 -0
- package/dist/ui/components/MetricCard.d.ts +38 -0
- package/dist/ui/components/MetricCard.js +39 -0
- package/dist/ui/components/MetricCard.js.map +1 -0
- package/dist/ui/components/NoValue.js +22 -0
- package/dist/ui/components/NoValue.js.map +1 -0
- package/dist/ui/components/ReadState.js +27 -0
- package/dist/ui/components/ReadState.js.map +1 -0
- package/dist/ui/components/RefreshButton.js +25 -0
- package/dist/ui/components/RefreshButton.js.map +1 -0
- package/dist/ui/components/SourcesNoticeBanner.js +20 -0
- package/dist/ui/components/SourcesNoticeBanner.js.map +1 -0
- package/dist/ui/cssVars.js +7 -0
- package/dist/ui/cssVars.js.map +1 -0
- package/dist/ui/data/WithScopeToken.d.ts +20 -0
- package/dist/ui/data/WithScopeToken.js +20 -0
- package/dist/ui/data/WithScopeToken.js.map +1 -0
- package/dist/ui/data/clientFieldProps.js +16 -0
- package/dist/ui/data/clientFieldProps.js.map +1 -0
- package/dist/ui/data/request.d.ts +46 -0
- package/dist/ui/data/request.js +119 -0
- package/dist/ui/data/request.js.map +1 -0
- package/dist/ui/data/scopeTokenContext.js +18 -0
- package/dist/ui/data/scopeTokenContext.js.map +1 -0
- package/dist/ui/data/sharedCache.js +48 -0
- package/dist/ui/data/sharedCache.js.map +1 -0
- package/dist/ui/data/useRequest.d.ts +19 -0
- package/dist/ui/data/useRequest.js +123 -0
- package/dist/ui/data/useRequest.js.map +1 -0
- package/dist/ui/data/useRequestScope.js +25 -0
- package/dist/ui/data/useRequestScope.js.map +1 -0
- package/dist/ui/hooks/useDirection.js +47 -0
- package/dist/ui/hooks/useDirection.js.map +1 -0
- package/dist/ui/hooks/useDismissOnEscape.js +25 -0
- package/dist/ui/hooks/useDismissOnEscape.js.map +1 -0
- package/dist/ui/hooks/useLiveAnnouncement.js +57 -0
- package/dist/ui/hooks/useLiveAnnouncement.js.map +1 -0
- package/dist/ui/hooks/useRealtimePoll.js +112 -0
- package/dist/ui/hooks/useRealtimePoll.js.map +1 -0
- package/dist/ui/readState.js +19 -0
- package/dist/ui/readState.js.map +1 -0
- package/dist/ui/rows/toDisplayRows.js +49 -0
- package/dist/ui/rows/toDisplayRows.js.map +1 -0
- package/dist/ui/viewerClock.js +7 -0
- package/dist/ui/viewerClock.js.map +1 -0
- package/dist/view/AnalyticsNavLink.d.ts +5 -3
- package/dist/view/AnalyticsNavLink.js +12 -8
- package/dist/view/AnalyticsNavLink.js.map +1 -1
- package/dist/view/AnalyticsView.d.ts +9 -10
- package/dist/view/AnalyticsView.js +47 -19
- package/dist/view/AnalyticsView.js.map +1 -1
- package/dist/view/AnalyticsViewClient.d.ts +4 -7
- package/dist/view/AnalyticsViewClient.js +15 -174
- package/dist/view/AnalyticsViewClient.js.map +1 -1
- package/dist/view/CountryFlag.d.ts +27 -0
- package/dist/view/CountryFlag.js +44 -0
- package/dist/view/CountryFlag.js.map +1 -0
- package/dist/view/DocumentTitle.js +27 -0
- package/dist/view/DocumentTitle.js.map +1 -0
- package/dist/view/ViewRoot.d.ts +21 -0
- package/dist/view/ViewRoot.js +155 -0
- package/dist/view/ViewRoot.js.map +1 -0
- package/dist/view/ViewSections.d.ts +38 -0
- package/dist/view/ViewSections.js +190 -0
- package/dist/view/ViewSections.js.map +1 -0
- package/dist/view/authRedirect.js +2 -4
- package/dist/view/authRedirect.js.map +1 -1
- package/dist/view/consentShare.js +15 -0
- package/dist/view/consentShare.js.map +1 -0
- package/dist/view/conversionRate.js +9 -7
- package/dist/view/conversionRate.js.map +1 -1
- package/dist/view/dayRange.js +6 -10
- package/dist/view/dayRange.js.map +1 -1
- package/dist/view/exclusionLink.d.ts +27 -0
- package/dist/view/exclusionLink.js +46 -0
- package/dist/view/exclusionLink.js.map +1 -0
- package/dist/view/flagSrc.js +14 -0
- package/dist/view/flagSrc.js.map +1 -0
- package/dist/view/gating.d.ts +15 -1
- package/dist/view/gating.js +92 -20
- package/dist/view/gating.js.map +1 -1
- package/dist/view/hostCountryFlag.js +41 -0
- package/dist/view/hostCountryFlag.js.map +1 -0
- package/dist/view/labels.js +120 -3
- package/dist/view/labels.js.map +1 -1
- package/dist/view/metricAliases.js +10 -0
- package/dist/view/metricAliases.js.map +1 -0
- package/dist/view/navLabel.js +15 -0
- package/dist/view/navLabel.js.map +1 -0
- package/dist/view/registerView.js +13 -11
- package/dist/view/registerView.js.map +1 -1
- package/dist/view/scopeLabel.js +21 -0
- package/dist/view/scopeLabel.js.map +1 -0
- package/dist/view/sections/Breakdowns.js +221 -118
- package/dist/view/sections/Breakdowns.js.map +1 -1
- package/dist/view/sections/EmptyStates.js +120 -32
- package/dist/view/sections/EmptyStates.js.map +1 -1
- package/dist/view/sections/ExcludeBrowser.js +188 -0
- package/dist/view/sections/ExcludeBrowser.js.map +1 -0
- package/dist/view/sections/FilterChips.js +130 -25
- package/dist/view/sections/FilterChips.js.map +1 -1
- package/dist/view/sections/GoalsPanel.js +68 -59
- package/dist/view/sections/GoalsPanel.js.map +1 -1
- package/dist/view/sections/OverviewCards.js +42 -36
- package/dist/view/sections/OverviewCards.js.map +1 -1
- package/dist/view/sections/RealtimeStrip.js +70 -56
- package/dist/view/sections/RealtimeStrip.js.map +1 -1
- package/dist/view/sections/SectionBoundary.js +34 -0
- package/dist/view/sections/SectionBoundary.js.map +1 -0
- package/dist/view/sections/Toolbar.d.ts +11 -0
- package/dist/view/sections/Toolbar.js +182 -116
- package/dist/view/sections/Toolbar.js.map +1 -1
- package/dist/view/sections/Trend.js +179 -73
- package/dist/view/sections/Trend.js.map +1 -1
- package/dist/view/state.d.ts +42 -0
- package/dist/view/state.js +97 -53
- package/dist/view/state.js.map +1 -1
- package/dist/view/useViewClock.js +31 -0
- package/dist/view/useViewClock.js.map +1 -0
- package/dist/view/useViewQueries.d.ts +21 -0
- package/dist/view/useViewQueries.js +50 -79
- package/dist/view/useViewQueries.js.map +1 -1
- package/dist/view/useViewState.js +42 -0
- package/dist/view/useViewState.js.map +1 -0
- package/dist/view/useViewUrl.js +52 -0
- package/dist/view/useViewUrl.js.map +1 -0
- package/dist/view/viewBody.js +30 -0
- package/dist/view/viewBody.js.map +1 -0
- package/dist/view/viewContext.d.ts +81 -0
- package/dist/view/viewContext.js +49 -0
- package/dist/view/viewContext.js.map +1 -0
- package/dist/view/viewProps.d.ts +65 -8
- package/dist/view/viewProps.js +123 -36
- package/dist/view/viewProps.js.map +1 -1
- package/dist/widgets/AnalyticsBreakdownWidget.d.ts +7 -3
- package/dist/widgets/AnalyticsBreakdownWidget.js +153 -78
- package/dist/widgets/AnalyticsBreakdownWidget.js.map +1 -1
- package/dist/widgets/AnalyticsGoalsWidget.d.ts +6 -7
- package/dist/widgets/AnalyticsGoalsWidget.js +126 -159
- package/dist/widgets/AnalyticsGoalsWidget.js.map +1 -1
- package/dist/widgets/AnalyticsMetricWidget.d.ts +7 -3
- package/dist/widgets/AnalyticsMetricWidget.js +85 -83
- package/dist/widgets/AnalyticsMetricWidget.js.map +1 -1
- package/dist/widgets/AnalyticsRealtimeWidget.d.ts +7 -3
- package/dist/widgets/AnalyticsRealtimeWidget.js +81 -61
- package/dist/widgets/AnalyticsRealtimeWidget.js.map +1 -1
- package/dist/widgets/AnalyticsTrendWidget.d.ts +7 -3
- package/dist/widgets/AnalyticsTrendWidget.js +134 -100
- package/dist/widgets/AnalyticsTrendWidget.js.map +1 -1
- package/dist/widgets/ComparisonDelta.js +33 -42
- package/dist/widgets/ComparisonDelta.js.map +1 -1
- package/dist/widgets/RealtimeCounter.d.ts +27 -3
- package/dist/widgets/RealtimeCounter.js +90 -62
- package/dist/widgets/RealtimeCounter.js.map +1 -1
- package/dist/widgets/WidgetCard.d.ts +80 -0
- package/dist/widgets/WidgetCard.js +99 -0
- package/dist/widgets/WidgetCard.js.map +1 -0
- package/dist/widgets/WidgetFrame.js +42 -0
- package/dist/widgets/WidgetFrame.js.map +1 -0
- package/dist/widgets/WidgetShimmer.d.ts +55 -0
- package/dist/widgets/WidgetShimmer.js +86 -0
- package/dist/widgets/WidgetShimmer.js.map +1 -0
- package/dist/widgets/breakdownTypes.js +18 -2
- package/dist/widgets/breakdownTypes.js.map +1 -1
- package/dist/widgets/customWidget.d.ts +5 -1
- package/dist/widgets/customWidget.js +6 -7
- package/dist/widgets/customWidget.js.map +1 -1
- package/dist/widgets/defaultLayout.d.ts +26 -0
- package/dist/widgets/defaultLayout.js +51 -0
- package/dist/widgets/defaultLayout.js.map +1 -0
- package/dist/widgets/defaults.d.ts +4 -3
- package/dist/widgets/defaults.js +76 -24
- package/dist/widgets/defaults.js.map +1 -1
- package/dist/widgets/fieldRows.js +14 -0
- package/dist/widgets/fieldRows.js.map +1 -0
- package/dist/widgets/filterCaption.js +26 -0
- package/dist/widgets/filterCaption.js.map +1 -0
- package/dist/widgets/filterField.d.ts +15 -0
- package/dist/widgets/filterField.js +86 -0
- package/dist/widgets/filterField.js.map +1 -0
- package/dist/widgets/filterValueLabel.d.ts +1 -0
- package/dist/widgets/filterValueLabel.js +45 -0
- package/dist/widgets/filterValueLabel.js.map +1 -0
- package/dist/widgets/notices.js +79 -0
- package/dist/widgets/notices.js.map +1 -0
- package/dist/widgets/prepareWidgetRead.d.ts +24 -0
- package/dist/widgets/prepareWidgetRead.js +110 -0
- package/dist/widgets/prepareWidgetRead.js.map +1 -0
- package/dist/widgets/range.js +26 -21
- package/dist/widgets/range.js.map +1 -1
- package/dist/widgets/readForWidget.d.ts +32 -13
- package/dist/widgets/readForWidget.js +52 -63
- package/dist/widgets/readForWidget.js.map +1 -1
- package/dist/widgets/readForWidgetBreakdown.d.ts +45 -18
- package/dist/widgets/readForWidgetBreakdown.js +71 -58
- package/dist/widgets/readForWidgetBreakdown.js.map +1 -1
- package/dist/widgets/readForWidgetGoals.d.ts +21 -17
- package/dist/widgets/readForWidgetGoals.js +72 -52
- package/dist/widgets/readForWidgetGoals.js.map +1 -1
- package/dist/widgets/readForWidgetRealtime.d.ts +24 -11
- package/dist/widgets/readForWidgetRealtime.js +69 -41
- package/dist/widgets/readForWidgetRealtime.js.map +1 -1
- package/dist/widgets/readForWidgetSeries.d.ts +29 -24
- package/dist/widgets/readForWidgetSeries.js +66 -114
- package/dist/widgets/readForWidgetSeries.js.map +1 -1
- package/dist/widgets/readMeta.d.ts +48 -0
- package/dist/widgets/readMeta.js +66 -0
- package/dist/widgets/readMeta.js.map +1 -0
- package/dist/widgets/realtimePoll.d.ts +1 -0
- package/dist/widgets/realtimePoll.js +56 -16
- package/dist/widgets/realtimePoll.js.map +1 -1
- package/dist/widgets/registerWidgets.js +207 -124
- package/dist/widgets/registerWidgets.js.map +1 -1
- package/dist/widgets/stateKeys.js +30 -0
- package/dist/widgets/stateKeys.js.map +1 -0
- package/dist/widgets/titleForecast.js +89 -0
- package/dist/widgets/titleForecast.js.map +1 -0
- package/dist/widgets/types.d.ts +16 -0
- package/dist/widgets/types.js +2 -0
- package/dist/widgets/types.js.map +1 -1
- package/dist/widgets/viewLink.d.ts +24 -6
- package/dist/widgets/viewLink.js +36 -26
- package/dist/widgets/viewLink.js.map +1 -1
- package/dist/widgets/widgetData.js +34 -0
- package/dist/widgets/widgetData.js.map +1 -0
- package/dist/widgets/widgetWindow.d.ts +1 -0
- package/dist/widgets/widgetWindow.js +51 -0
- package/dist/widgets/widgetWindow.js.map +1 -0
- package/package.json +61 -42
- package/dist/capture/getTrackerConfig.d.ts +0 -20
- package/dist/capture/getTrackerConfig.js +0 -31
- package/dist/capture/getTrackerConfig.js.map +0 -1
- package/dist/capture/slots.d.ts +0 -8
- package/dist/capture/trackerConfig.d.ts +0 -33
- package/dist/charts/styles.js +0 -59
- package/dist/charts/styles.js.map +0 -1
- package/dist/exports/next.d.ts +0 -3
- package/dist/exports/next.js +0 -3
- package/dist/fields/config/SourceSelectField.d.ts +0 -14
- package/dist/fields/dateRange/styles.js +0 -23
- package/dist/fields/dateRange/styles.js.map +0 -1
- package/dist/goals/GoalSelectField.d.ts +0 -7
- package/dist/native/collections/events.js +0 -121
- package/dist/native/collections/events.js.map +0 -1
- package/dist/native/collections/rollups.js +0 -151
- package/dist/native/collections/rollups.js.map +0 -1
- package/dist/native/collections/seen.js +0 -47
- package/dist/native/collections/seen.js.map +0 -1
- package/dist/native/ingest/flushBatch.js +0 -60
- package/dist/native/ingest/flushBatch.js.map +0 -1
- package/dist/native/ingest/salt.js +0 -14
- package/dist/native/ingest/salt.js.map +0 -1
- package/dist/native/ingest/writeBuffer.js +0 -55
- package/dist/native/ingest/writeBuffer.js.map +0 -1
- package/dist/native/ingest/writeEvent.js +0 -14
- package/dist/native/ingest/writeEvent.js.map +0 -1
- package/dist/native/query/eventAgg.js +0 -161
- package/dist/native/query/eventAgg.js.map +0 -1
- package/dist/native/realtime/buildRealtime.js +0 -53
- package/dist/native/realtime/buildRealtime.js.map +0 -1
- package/dist/native/retention/pruneTask.js +0 -29
- package/dist/native/retention/pruneTask.js.map +0 -1
- package/dist/native/rollupAcc.js +0 -64
- package/dist/native/rollupAcc.js.map +0 -1
- package/dist/native/rollups/applyDistinctDeltas.js +0 -9
- package/dist/native/rollups/applyDistinctDeltas.js.map +0 -1
- package/dist/native/rollups/bumpRollup.js +0 -73
- package/dist/native/rollups/bumpRollup.js.map +0 -1
- package/dist/native/rollups/deltas.js +0 -90
- package/dist/native/rollups/deltas.js.map +0 -1
- package/dist/native/rollups/insertIfNew.js +0 -53
- package/dist/native/rollups/insertIfNew.js.map +0 -1
- package/dist/next/captureRewrites.d.ts +0 -41
- package/dist/next/captureRewrites.js +0 -56
- package/dist/next/captureRewrites.js.map +0 -1
- package/dist/next/posthogProxyRewrites.d.ts +0 -41
- package/dist/next/posthogProxyRewrites.js +0 -45
- package/dist/next/posthogProxyRewrites.js.map +0 -1
- package/dist/plugin/paths.js +0 -27
- package/dist/plugin/paths.js.map +0 -1
- package/dist/query/errors.js +0 -10
- package/dist/query/errors.js.map +0 -1
- package/dist/react/TrackerBoot.d.ts +0 -22
- package/dist/rsc/AnalyticsScripts.d.ts +0 -30
- package/dist/rsc/AnalyticsScripts.js +0 -41
- package/dist/rsc/AnalyticsScripts.js.map +0 -1
- package/dist/surfacing/queue.js +0 -60
- package/dist/surfacing/queue.js.map +0 -1
- package/dist/surfacing/retryPolicy.js +0 -15
- package/dist/surfacing/retryPolicy.js.map +0 -1
- package/dist/tracker/autoCapture.d.ts +0 -48
- package/dist/tracker/consent.d.ts +0 -24
- package/dist/tracker/consent.js +0 -48
- package/dist/tracker/consent.js.map +0 -1
- package/dist/tracker/loadScript.d.ts +0 -14
- package/dist/tracker/pageTracking.d.ts +0 -17
- package/dist/tracker/registry.d.ts +0 -27
- package/dist/tracker/sinks/native.d.ts +0 -22
- package/dist/tracker/sinks/plausible.d.ts +0 -14
- package/dist/tracker/sinks/posthog.d.ts +0 -14
- package/dist/tracker/sinks/umami.d.ts +0 -13
- package/dist/tracker/sinks/vendor.d.ts +0 -14
- package/dist/view/sections/styles.js +0 -74
- package/dist/view/sections/styles.js.map +0 -1
- package/dist/widgets/WidgetViewLink.js +0 -17
- package/dist/widgets/WidgetViewLink.js.map +0 -1
- package/dist/widgets/cardChrome.d.ts +0 -8
- package/dist/widgets/cardChrome.js +0 -46
- package/dist/widgets/cardChrome.js.map +0 -1
- package/dist/widgets/comparison.js +0 -43
- package/dist/widgets/comparison.js.map +0 -1
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import { MetricKey } from "../core/contract.js";
|
|
1
|
+
import { DimensionKey, MetricKey } from "../core/contract.js";
|
|
2
2
|
import { TimeframePreset } from "../timeframe/presets.js";
|
|
3
|
+
import { ReportOption } from "../binding/report.js";
|
|
3
4
|
import { LabelFunction, StaticLabel, Tab, TabsField, UIField, UnnamedTab } from "payload";
|
|
4
5
|
|
|
5
6
|
//#region src/fields/factories.d.ts
|
|
@@ -9,17 +10,22 @@ import { LabelFunction, StaticLabel, Tab, TabsField, UIField, UnnamedTab } from
|
|
|
9
10
|
*/
|
|
10
11
|
type AnalyticsMetricLabel = LabelFunction | StaticLabel;
|
|
11
12
|
type AnalyticsMetricLabels = Partial<Record<MetricKey, AnalyticsMetricLabel>>;
|
|
12
|
-
type
|
|
13
|
+
type AnalyticsStatBaseOptions = {
|
|
13
14
|
timeframe?: TimeframePreset;
|
|
14
15
|
adapter?: string;
|
|
15
16
|
position?: 'sidebar';
|
|
16
17
|
name?: string;
|
|
18
|
+
/**
|
|
19
|
+
* `'page'` is the document's own page, `'item'` the document as content shown on other pages;
|
|
20
|
+
* `'auto'` (default) follows the binding, the item first where bound as both.
|
|
21
|
+
*/
|
|
22
|
+
report?: ReportOption;
|
|
17
23
|
};
|
|
18
|
-
type AnalyticsStatOptions =
|
|
24
|
+
type AnalyticsStatOptions = AnalyticsStatBaseOptions & {
|
|
19
25
|
metric: MetricKey; /** Overrides the stat's metric card label. */
|
|
20
26
|
label?: AnalyticsMetricLabel;
|
|
21
27
|
};
|
|
22
|
-
type AnalyticsStatRowOptions =
|
|
28
|
+
type AnalyticsStatRowOptions = AnalyticsStatBaseOptions & {
|
|
23
29
|
metrics?: MetricKey[]; /** Per-metric card label overrides. */
|
|
24
30
|
labels?: AnalyticsMetricLabels;
|
|
25
31
|
};
|
|
@@ -32,29 +38,42 @@ type AnalyticsFieldsOptions = {
|
|
|
32
38
|
type AnalyticsTabOptions = {
|
|
33
39
|
metrics?: MetricKey[];
|
|
34
40
|
timeframe?: TimeframePreset;
|
|
35
|
-
adapter?: string;
|
|
36
|
-
label?: UnnamedTab['label']; /** Optional tab description. */
|
|
37
|
-
description?: UnnamedTab['description']; /** Per-metric card label overrides. */
|
|
38
|
-
labels?: AnalyticsMetricLabels;
|
|
41
|
+
adapter?: string;
|
|
39
42
|
/**
|
|
40
|
-
*
|
|
41
|
-
*
|
|
43
|
+
* Sources the switcher offers: `'auto'` (default) is every source of the document's scope the
|
|
44
|
+
* reader may read, a list narrows to those ids. Drawn only when more than one survives.
|
|
42
45
|
*/
|
|
46
|
+
sources?: 'auto' | string[]; /** Overrides the tab label (default: the translated "Analytics"). */
|
|
47
|
+
label?: UnnamedTab['label'];
|
|
48
|
+
description?: UnnamedTab['description']; /** Per-metric card label overrides. */
|
|
49
|
+
labels?: AnalyticsMetricLabels; /** Interactive panel by default; `false` renders the static stats row instead. */
|
|
43
50
|
interactive?: boolean;
|
|
51
|
+
/**
|
|
52
|
+
* Top countries, sources and devices under the trend; `false` omits them, a list picks others
|
|
53
|
+
* (at most three). Any the source cannot rank for a single page are dropped.
|
|
54
|
+
*/
|
|
55
|
+
breakdowns?: boolean | DimensionKey[];
|
|
56
|
+
/**
|
|
57
|
+
* The live counter for this page, drawn only where the source counts live visitors.
|
|
58
|
+
* Default on; `false` leaves it out and stops the poll.
|
|
59
|
+
*/
|
|
60
|
+
liveVisitors?: boolean;
|
|
61
|
+
/**
|
|
62
|
+
* `'page'` is the document's own page, `'item'` the document as content shown elsewhere;
|
|
63
|
+
* `'auto'` (default) follows the binding, and bound as both gets a switch opening on the item.
|
|
64
|
+
*/
|
|
65
|
+
report?: ReportOption;
|
|
44
66
|
};
|
|
45
67
|
declare const analyticsStat: (options: AnalyticsStatOptions) => UIField;
|
|
46
68
|
declare const analyticsStatRow: (options?: AnalyticsStatRowOptions) => UIField;
|
|
47
69
|
declare const analyticsFields: (options?: AnalyticsFieldsOptions) => UIField[];
|
|
48
70
|
/**
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
* authenticated document endpoint. Pass `interactive: false` for the static stats row
|
|
52
|
-
* ({@link analyticsStatRow}) instead. Use {@link analyticsTabsField} for a standalone
|
|
53
|
-
* tabs field wrapping this tab.
|
|
71
|
+
* Unnamed "Analytics" `Tab` for your own tabs field: the interactive panel, or the static
|
|
72
|
+
* {@link analyticsStatRow} with `interactive: false`. See {@link analyticsTabsField}.
|
|
54
73
|
*/
|
|
55
74
|
declare const analyticsTab: (options?: AnalyticsTabOptions) => Tab;
|
|
56
75
|
/** A ready-made tabs field containing a single {@link analyticsTab}. */
|
|
57
76
|
declare const analyticsTabsField: (options?: AnalyticsTabOptions) => TabsField;
|
|
58
77
|
//#endregion
|
|
59
|
-
export { AnalyticsFieldsOptions, AnalyticsMetricLabel, AnalyticsMetricLabels, AnalyticsStatOptions, AnalyticsStatRowOptions, AnalyticsTabOptions, analyticsFields, analyticsStat, analyticsStatRow, analyticsTab, analyticsTabsField };
|
|
78
|
+
export { AnalyticsFieldsOptions, AnalyticsMetricLabel, AnalyticsMetricLabels, AnalyticsStatBaseOptions, AnalyticsStatOptions, AnalyticsStatRowOptions, AnalyticsTabOptions, analyticsFields, analyticsStat, analyticsStatRow, analyticsTab, analyticsTabsField };
|
|
60
79
|
//# sourceMappingURL=factories.d.ts.map
|
package/dist/fields/factories.js
CHANGED
|
@@ -1,47 +1,72 @@
|
|
|
1
1
|
import { keys } from "../translations/keys.js";
|
|
2
2
|
import { labelForKey } from "../translations/server.js";
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
3
|
+
import { builtInStaticLabel } from "../translations/staticLabel.js";
|
|
4
|
+
import { PANEL_FIELD_COMPONENT, STAT_FIELD_COMPONENT } from "./componentPaths.js";
|
|
5
5
|
//#region src/fields/factories.ts
|
|
6
|
-
/**
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
const
|
|
12
|
-
const PANEL_PATH = "@10x-media/analytics/rsc#AnalyticsPanelField";
|
|
6
|
+
/**
|
|
7
|
+
* UI fields take static labels only, so the label is the locale map. A host builds these fields
|
|
8
|
+
* before the plugin sees its options; the plugin then swaps in its install's own strings.
|
|
9
|
+
*/
|
|
10
|
+
const ANALYTICS_LABEL = builtInStaticLabel(keys.tabAnalytics);
|
|
11
|
+
const DEFAULT_TIMEFRAME = "last30days";
|
|
13
12
|
const DEFAULT_ROW_METRICS = [
|
|
14
13
|
"pageviews",
|
|
15
14
|
"visitors",
|
|
16
15
|
"sessions",
|
|
17
16
|
"avgDuration"
|
|
18
17
|
];
|
|
18
|
+
/**
|
|
19
|
+
* Opportunistic: a source serving none shows four cards and warns nobody, so they are optional.
|
|
20
|
+
* `QUIET_PANEL_METRICS` adds time on page, which no vendor but GA4 reports per pageview.
|
|
21
|
+
*/
|
|
22
|
+
const OPTIONAL_PANEL_METRICS = [
|
|
23
|
+
"conversions",
|
|
24
|
+
"revenue",
|
|
25
|
+
"scrollDepth"
|
|
26
|
+
];
|
|
27
|
+
const DEFAULT_PANEL_METRICS = [...DEFAULT_ROW_METRICS, ...OPTIONAL_PANEL_METRICS];
|
|
28
|
+
const QUIET_PANEL_METRICS = ["avgDuration", ...OPTIONAL_PANEL_METRICS];
|
|
29
|
+
const DEFAULT_PANEL_DIMENSIONS = [
|
|
30
|
+
"country",
|
|
31
|
+
"source",
|
|
32
|
+
"device"
|
|
33
|
+
];
|
|
34
|
+
/** Lists the panel lays out under its trend. */
|
|
35
|
+
const MAX_PANEL_LISTS = 3;
|
|
36
|
+
const panelDimensions = (option) => {
|
|
37
|
+
if (option === false) return [];
|
|
38
|
+
return Array.isArray(option) ? option.slice(0, MAX_PANEL_LISTS) : DEFAULT_PANEL_DIMENSIONS;
|
|
39
|
+
};
|
|
40
|
+
const reportOf = (report) => report === void 0 ? {} : { report };
|
|
19
41
|
const statField = (name, serverProps, position) => ({
|
|
20
42
|
name,
|
|
21
43
|
type: "ui",
|
|
22
44
|
label: ANALYTICS_LABEL,
|
|
23
45
|
admin: {
|
|
24
46
|
...position ? { position } : {},
|
|
25
|
-
|
|
47
|
+
disabled: { column: true },
|
|
26
48
|
components: { Field: {
|
|
27
|
-
path:
|
|
49
|
+
path: STAT_FIELD_COMPONENT,
|
|
28
50
|
serverProps
|
|
29
51
|
} }
|
|
30
52
|
}
|
|
31
53
|
});
|
|
32
54
|
const analyticsStat = (options) => statField(options.name ?? `analytics_${options.metric}`, {
|
|
33
55
|
metrics: [options.metric],
|
|
34
|
-
timeframe: options.timeframe ??
|
|
56
|
+
timeframe: options.timeframe ?? DEFAULT_TIMEFRAME,
|
|
35
57
|
variant: "stat",
|
|
36
58
|
adapterId: options.adapter,
|
|
37
|
-
...options.label ? { labels: { [options.metric]: options.label } } : {}
|
|
59
|
+
...options.label ? { labels: { [options.metric]: options.label } } : {},
|
|
60
|
+
...reportOf(options.report)
|
|
38
61
|
}, options.position);
|
|
39
62
|
const analyticsStatRow = (options = {}) => statField(options.name ?? "analytics_stats", {
|
|
40
63
|
metrics: options.metrics ?? DEFAULT_ROW_METRICS,
|
|
41
|
-
|
|
64
|
+
...options.metrics === void 0 ? { defaultMetrics: true } : {},
|
|
65
|
+
timeframe: options.timeframe ?? DEFAULT_TIMEFRAME,
|
|
42
66
|
variant: "row",
|
|
43
67
|
adapterId: options.adapter,
|
|
44
|
-
labels: options.labels
|
|
68
|
+
labels: options.labels,
|
|
69
|
+
...reportOf(options.report)
|
|
45
70
|
}, options.position);
|
|
46
71
|
const analyticsFields = (options = {}) => (options.metrics ?? DEFAULT_ROW_METRICS).map((metric) => analyticsStat({
|
|
47
72
|
metric,
|
|
@@ -50,12 +75,31 @@ const analyticsFields = (options = {}) => (options.metrics ?? DEFAULT_ROW_METRIC
|
|
|
50
75
|
name: `analytics_${metric}`,
|
|
51
76
|
label: options.labels?.[metric]
|
|
52
77
|
}));
|
|
78
|
+
const panelField = (options) => ({
|
|
79
|
+
name: "analytics_panel",
|
|
80
|
+
type: "ui",
|
|
81
|
+
label: ANALYTICS_LABEL,
|
|
82
|
+
admin: {
|
|
83
|
+
disabled: { column: true },
|
|
84
|
+
components: { Field: {
|
|
85
|
+
path: PANEL_FIELD_COMPONENT,
|
|
86
|
+
serverProps: {
|
|
87
|
+
metrics: options.metrics ?? DEFAULT_PANEL_METRICS,
|
|
88
|
+
...options.metrics ? {} : { optionalMetrics: QUIET_PANEL_METRICS },
|
|
89
|
+
timeframe: options.timeframe ?? DEFAULT_TIMEFRAME,
|
|
90
|
+
adapterId: options.adapter,
|
|
91
|
+
labels: options.labels,
|
|
92
|
+
dimensions: panelDimensions(options.breakdowns),
|
|
93
|
+
liveVisitors: options.liveVisitors !== false,
|
|
94
|
+
...options.sources === void 0 ? {} : { sources: options.sources },
|
|
95
|
+
...reportOf(options.report)
|
|
96
|
+
}
|
|
97
|
+
} }
|
|
98
|
+
}
|
|
99
|
+
});
|
|
53
100
|
/**
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
* authenticated document endpoint. Pass `interactive: false` for the static stats row
|
|
57
|
-
* ({@link analyticsStatRow}) instead. Use {@link analyticsTabsField} for a standalone
|
|
58
|
-
* tabs field wrapping this tab.
|
|
101
|
+
* Unnamed "Analytics" `Tab` for your own tabs field: the interactive panel, or the static
|
|
102
|
+
* {@link analyticsStatRow} with `interactive: false`. See {@link analyticsTabsField}.
|
|
59
103
|
*/
|
|
60
104
|
const analyticsTab = (options = {}) => ({
|
|
61
105
|
label: options.label ?? labelForKey(keys.tabAnalytics),
|
|
@@ -64,24 +108,9 @@ const analyticsTab = (options = {}) => ({
|
|
|
64
108
|
metrics: options.metrics,
|
|
65
109
|
timeframe: options.timeframe,
|
|
66
110
|
adapter: options.adapter,
|
|
67
|
-
labels: options.labels
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
type: "ui",
|
|
71
|
-
label: ANALYTICS_LABEL,
|
|
72
|
-
admin: {
|
|
73
|
-
disableListColumn: true,
|
|
74
|
-
components: { Field: {
|
|
75
|
-
path: PANEL_PATH,
|
|
76
|
-
serverProps: {
|
|
77
|
-
metrics: options.metrics ?? DEFAULT_ROW_METRICS,
|
|
78
|
-
timeframe: options.timeframe ?? "last30days",
|
|
79
|
-
adapterId: options.adapter,
|
|
80
|
-
labels: options.labels
|
|
81
|
-
}
|
|
82
|
-
} }
|
|
83
|
-
}
|
|
84
|
-
}]
|
|
111
|
+
labels: options.labels,
|
|
112
|
+
...reportOf(options.report)
|
|
113
|
+
}) : panelField(options)]
|
|
85
114
|
});
|
|
86
115
|
/** A ready-made tabs field containing a single {@link analyticsTab}. */
|
|
87
116
|
const analyticsTabsField = (options = {}) => ({
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"factories.js","names":[],"sources":["../../src/fields/factories.ts"],"sourcesContent":["import type { LabelFunction, StaticLabel, Tab, TabsField, UIField, UnnamedTab } from 'payload'\nimport type { MetricKey } from '../core/contract'\nimport type { TimeframePreset } from '../timeframe/presets'\nimport { de } from '../translations/de'\nimport { en } from '../translations/en'\nimport { keys } from '../translations/keys'\nimport { labelForKey } from '../translations/server'\n\n/** UI fields accept static labels only, so the tab label ships as a locale map. */\nconst ANALYTICS_LABEL: Record<string, string> = {\n\tde: de[keys.tabAnalytics],\n\ten: en[keys.tabAnalytics],\n}\n\nconst RSC_PATH = '@10x-media/analytics/rsc#AnalyticsStatField'\nconst PANEL_PATH = '@10x-media/analytics/rsc#AnalyticsPanelField'\n\nconst DEFAULT_ROW_METRICS: MetricKey[] = ['pageviews', 'visitors', 'sessions', 'avgDuration']\n\n/**\n * A metric card label override: a plain string, a locale-to-label map, or a Payload\n * label function receiving `{ t, i18n }`. Defaults to the metric's translated name.\n */\nexport type AnalyticsMetricLabel = LabelFunction | StaticLabel\n\nexport type AnalyticsMetricLabels = Partial<Record<MetricKey, AnalyticsMetricLabel>>\n\ninterface StatServerProps {\n\tmetrics: MetricKey[]\n\ttimeframe: TimeframePreset\n\tvariant: 'stat' | 'row'\n\tadapterId?: string\n\tlabels?: AnalyticsMetricLabels\n}\n\ntype BaseFieldOptions = {\n\ttimeframe?: TimeframePreset\n\tadapter?: string\n\tposition?: 'sidebar'\n\tname?: string\n}\n\nexport type AnalyticsStatOptions = BaseFieldOptions & {\n\tmetric: MetricKey\n\t/** Overrides the stat's metric card label. */\n\tlabel?: AnalyticsMetricLabel\n}\n\nexport type AnalyticsStatRowOptions = BaseFieldOptions & {\n\tmetrics?: MetricKey[]\n\t/** Per-metric card label overrides. */\n\tlabels?: AnalyticsMetricLabels\n}\n\nexport type AnalyticsFieldsOptions = {\n\tmetrics?: MetricKey[]\n\ttimeframe?: TimeframePreset\n\tadapter?: string\n\t/** Per-metric card label overrides. */\n\tlabels?: AnalyticsMetricLabels\n}\n\nexport type AnalyticsTabOptions = {\n\tmetrics?: MetricKey[]\n\ttimeframe?: TimeframePreset\n\tadapter?: string\n\t/** Overrides the tab label (default: the translated \"Analytics\"). */\n\tlabel?: UnnamedTab['label']\n\t/** Optional tab description. */\n\tdescription?: UnnamedTab['description']\n\t/** Per-metric card label overrides. */\n\tlabels?: AnalyticsMetricLabels\n\t/**\n\t * The tab renders the interactive panel (timeframe picker, comparison, daily\n\t * trend) by default; false renders the static stats row instead.\n\t */\n\tinteractive?: boolean\n}\n\nconst statField = (name: string, serverProps: StatServerProps, position?: 'sidebar'): UIField => ({\n\tname,\n\ttype: 'ui',\n\tlabel: ANALYTICS_LABEL,\n\tadmin: {\n\t\t...(position ? { position } : {}),\n\t\t// Read-only display fields have no cell value; a list column would render empty.\n\t\tdisableListColumn: true,\n\t\tcomponents: {\n\t\t\tField: { path: RSC_PATH, serverProps },\n\t\t},\n\t},\n})\n\nexport const analyticsStat = (options: AnalyticsStatOptions): UIField =>\n\tstatField(\n\t\toptions.name ?? `analytics_${options.metric}`,\n\t\t{\n\t\t\tmetrics: [options.metric],\n\t\t\ttimeframe: options.timeframe ?? 'last30days',\n\t\t\tvariant: 'stat',\n\t\t\tadapterId: options.adapter,\n\t\t\t...(options.label ? { labels: { [options.metric]: options.label } } : {}),\n\t\t},\n\t\toptions.position\n\t)\n\nexport const analyticsStatRow = (options: AnalyticsStatRowOptions = {}): UIField =>\n\tstatField(\n\t\toptions.name ?? 'analytics_stats',\n\t\t{\n\t\t\tmetrics: options.metrics ?? DEFAULT_ROW_METRICS,\n\t\t\ttimeframe: options.timeframe ?? 'last30days',\n\t\t\tvariant: 'row',\n\t\t\tadapterId: options.adapter,\n\t\t\tlabels: options.labels,\n\t\t},\n\t\toptions.position\n\t)\n\nexport const analyticsFields = (options: AnalyticsFieldsOptions = {}): UIField[] =>\n\t(options.metrics ?? DEFAULT_ROW_METRICS).map((metric) =>\n\t\tanalyticsStat({\n\t\t\tmetric,\n\t\t\ttimeframe: options.timeframe,\n\t\t\tadapter: options.adapter,\n\t\t\tname: `analytics_${metric}`,\n\t\t\tlabel: options.labels?.[metric],\n\t\t})\n\t)\n\n/**\n * An unnamed \"Analytics\" `Tab` to push into your own tabs field's `tabs` array: the\n * interactive panel (timeframe picker, comparison deltas, daily trend) backed by the\n * authenticated document endpoint. Pass `interactive: false` for the static stats row\n * ({@link analyticsStatRow}) instead. Use {@link analyticsTabsField} for a standalone\n * tabs field wrapping this tab.\n */\nexport const analyticsTab = (options: AnalyticsTabOptions = {}): Tab => ({\n\tlabel: options.label ?? labelForKey(keys.tabAnalytics),\n\t...(options.description ? { description: options.description } : {}),\n\tfields: [\n\t\toptions.interactive === false\n\t\t\t? analyticsStatRow({\n\t\t\t\t\tmetrics: options.metrics,\n\t\t\t\t\ttimeframe: options.timeframe,\n\t\t\t\t\tadapter: options.adapter,\n\t\t\t\t\tlabels: options.labels,\n\t\t\t\t})\n\t\t\t: {\n\t\t\t\t\tname: 'analytics_panel',\n\t\t\t\t\ttype: 'ui',\n\t\t\t\t\tlabel: ANALYTICS_LABEL,\n\t\t\t\t\tadmin: {\n\t\t\t\t\t\tdisableListColumn: true,\n\t\t\t\t\t\tcomponents: {\n\t\t\t\t\t\t\tField: {\n\t\t\t\t\t\t\t\tpath: PANEL_PATH,\n\t\t\t\t\t\t\t\tserverProps: {\n\t\t\t\t\t\t\t\t\tmetrics: options.metrics ?? DEFAULT_ROW_METRICS,\n\t\t\t\t\t\t\t\t\ttimeframe: options.timeframe ?? 'last30days',\n\t\t\t\t\t\t\t\t\tadapterId: options.adapter,\n\t\t\t\t\t\t\t\t\tlabels: options.labels,\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t},\n\t],\n})\n\n/** A ready-made tabs field containing a single {@link analyticsTab}. */\nexport const analyticsTabsField = (options: AnalyticsTabOptions = {}): TabsField => ({\n\ttype: 'tabs',\n\ttabs: [analyticsTab(options)],\n})\n"],"mappings":";;;;;;AASA,MAAM,kBAA0C;CAC/C,IAAI,GAAG,KAAK;CACZ,IAAI,GAAG,KAAK;AACb;AAEA,MAAM,WAAW;AACjB,MAAM,aAAa;AAEnB,MAAM,sBAAmC;CAAC;CAAa;CAAY;CAAY;AAAa;AA8D5F,MAAM,aAAa,MAAc,aAA8B,cAAmC;CACjG;CACA,MAAM;CACN,OAAO;CACP,OAAO;EACN,GAAI,WAAW,EAAE,SAAS,IAAI,CAAC;EAE/B,mBAAmB;EACnB,YAAY,EACX,OAAO;GAAE,MAAM;GAAU;EAAY,EACtC;CACD;AACD;AAEA,MAAa,iBAAiB,YAC7B,UACC,QAAQ,QAAQ,aAAa,QAAQ,UACrC;CACC,SAAS,CAAC,QAAQ,MAAM;CACxB,WAAW,QAAQ,aAAa;CAChC,SAAS;CACT,WAAW,QAAQ;CACnB,GAAI,QAAQ,QAAQ,EAAE,QAAQ,GAAG,QAAQ,SAAS,QAAQ,MAAM,EAAE,IAAI,CAAC;AACxE,GACA,QAAQ,QACT;AAED,MAAa,oBAAoB,UAAmC,CAAC,MACpE,UACC,QAAQ,QAAQ,mBAChB;CACC,SAAS,QAAQ,WAAW;CAC5B,WAAW,QAAQ,aAAa;CAChC,SAAS;CACT,WAAW,QAAQ;CACnB,QAAQ,QAAQ;AACjB,GACA,QAAQ,QACT;AAED,MAAa,mBAAmB,UAAkC,CAAC,OACjE,QAAQ,WAAW,qBAAqB,KAAK,WAC7C,cAAc;CACb;CACA,WAAW,QAAQ;CACnB,SAAS,QAAQ;CACjB,MAAM,aAAa;CACnB,OAAO,QAAQ,SAAS;AACzB,CAAC,CACF;;;;;;;;AASD,MAAa,gBAAgB,UAA+B,CAAC,OAAY;CACxE,OAAO,QAAQ,SAAS,YAAY,KAAK,YAAY;CACrD,GAAI,QAAQ,cAAc,EAAE,aAAa,QAAQ,YAAY,IAAI,CAAC;CAClE,QAAQ,CACP,QAAQ,gBAAgB,QACrB,iBAAiB;EACjB,SAAS,QAAQ;EACjB,WAAW,QAAQ;EACnB,SAAS,QAAQ;EACjB,QAAQ,QAAQ;CACjB,CAAC,IACA;EACA,MAAM;EACN,MAAM;EACN,OAAO;EACP,OAAO;GACN,mBAAmB;GACnB,YAAY,EACX,OAAO;IACN,MAAM;IACN,aAAa;KACZ,SAAS,QAAQ,WAAW;KAC5B,WAAW,QAAQ,aAAa;KAChC,WAAW,QAAQ;KACnB,QAAQ,QAAQ;IACjB;GACD,EACD;EACD;CACD,CACH;AACD;;AAGA,MAAa,sBAAsB,UAA+B,CAAC,OAAkB;CACpF,MAAM;CACN,MAAM,CAAC,aAAa,OAAO,CAAC;AAC7B"}
|
|
1
|
+
{"version":3,"file":"factories.js","names":[],"sources":["../../src/fields/factories.ts"],"sourcesContent":["import type { LabelFunction, StaticLabel, Tab, TabsField, UIField, UnnamedTab } from 'payload'\nimport type { ReportOption } from '../binding/report'\nimport type { DimensionKey, MetricKey } from '../core/contract'\nimport type { TimeframePreset } from '../timeframe/presets'\nimport { keys } from '../translations/keys'\nimport { labelForKey } from '../translations/server'\nimport { builtInStaticLabel } from '../translations/staticLabel'\nimport { PANEL_FIELD_COMPONENT, STAT_FIELD_COMPONENT } from './componentPaths'\n\n/**\n * UI fields take static labels only, so the label is the locale map. A host builds these fields\n * before the plugin sees its options; the plugin then swaps in its install's own strings.\n */\nconst ANALYTICS_LABEL = builtInStaticLabel(keys.tabAnalytics)\n\nconst DEFAULT_TIMEFRAME: TimeframePreset = 'last30days'\n\nconst DEFAULT_ROW_METRICS: MetricKey[] = ['pageviews', 'visitors', 'sessions', 'avgDuration']\n\n/**\n * Opportunistic: a source serving none shows four cards and warns nobody, so they are optional.\n * `QUIET_PANEL_METRICS` adds time on page, which no vendor but GA4 reports per pageview.\n */\nconst OPTIONAL_PANEL_METRICS: MetricKey[] = ['conversions', 'revenue', 'scrollDepth']\nconst DEFAULT_PANEL_METRICS: MetricKey[] = [...DEFAULT_ROW_METRICS, ...OPTIONAL_PANEL_METRICS]\nconst QUIET_PANEL_METRICS: MetricKey[] = ['avgDuration', ...OPTIONAL_PANEL_METRICS]\n\nconst DEFAULT_PANEL_DIMENSIONS: DimensionKey[] = ['country', 'source', 'device']\n\n/** Lists the panel lays out under its trend. */\nconst MAX_PANEL_LISTS = 3\n\nconst panelDimensions = (option: boolean | DimensionKey[] | undefined): DimensionKey[] => {\n\tif (option === false) {\n\t\treturn []\n\t}\n\treturn Array.isArray(option) ? option.slice(0, MAX_PANEL_LISTS) : DEFAULT_PANEL_DIMENSIONS\n}\n\nconst reportOf = (report: ReportOption | undefined): { report?: ReportOption } =>\n\treport === undefined ? {} : { report }\n\n/**\n * A metric card label override: a plain string, a locale-to-label map, or a Payload\n * label function receiving `{ t, i18n }`. Defaults to the metric's translated name.\n */\nexport type AnalyticsMetricLabel = LabelFunction | StaticLabel\n\nexport type AnalyticsMetricLabels = Partial<Record<MetricKey, AnalyticsMetricLabel>>\n\ninterface StatServerProps {\n\tmetrics: MetricKey[]\n\t/** The metrics are the row's defaults rather than a list the developer chose. */\n\tdefaultMetrics?: boolean\n\ttimeframe: TimeframePreset\n\tvariant: 'stat' | 'row'\n\tadapterId?: string\n\tlabels?: AnalyticsMetricLabels\n\treport?: ReportOption\n}\n\nexport type AnalyticsStatBaseOptions = {\n\ttimeframe?: TimeframePreset\n\tadapter?: string\n\tposition?: 'sidebar'\n\tname?: string\n\t/**\n\t * `'page'` is the document's own page, `'item'` the document as content shown on other pages;\n\t * `'auto'` (default) follows the binding, the item first where bound as both.\n\t */\n\treport?: ReportOption\n}\n\nexport type AnalyticsStatOptions = AnalyticsStatBaseOptions & {\n\tmetric: MetricKey\n\t/** Overrides the stat's metric card label. */\n\tlabel?: AnalyticsMetricLabel\n}\n\nexport type AnalyticsStatRowOptions = AnalyticsStatBaseOptions & {\n\tmetrics?: MetricKey[]\n\t/** Per-metric card label overrides. */\n\tlabels?: AnalyticsMetricLabels\n}\n\nexport type AnalyticsFieldsOptions = {\n\tmetrics?: MetricKey[]\n\ttimeframe?: TimeframePreset\n\tadapter?: string\n\t/** Per-metric card label overrides. */\n\tlabels?: AnalyticsMetricLabels\n}\n\nexport type AnalyticsTabOptions = {\n\tmetrics?: MetricKey[]\n\ttimeframe?: TimeframePreset\n\tadapter?: string\n\t/**\n\t * Sources the switcher offers: `'auto'` (default) is every source of the document's scope the\n\t * reader may read, a list narrows to those ids. Drawn only when more than one survives.\n\t */\n\tsources?: 'auto' | string[]\n\t/** Overrides the tab label (default: the translated \"Analytics\"). */\n\tlabel?: UnnamedTab['label']\n\tdescription?: UnnamedTab['description']\n\t/** Per-metric card label overrides. */\n\tlabels?: AnalyticsMetricLabels\n\t/** Interactive panel by default; `false` renders the static stats row instead. */\n\tinteractive?: boolean\n\t/**\n\t * Top countries, sources and devices under the trend; `false` omits them, a list picks others\n\t * (at most three). Any the source cannot rank for a single page are dropped.\n\t */\n\tbreakdowns?: boolean | DimensionKey[]\n\t/**\n\t * The live counter for this page, drawn only where the source counts live visitors.\n\t * Default on; `false` leaves it out and stops the poll.\n\t */\n\tliveVisitors?: boolean\n\t/**\n\t * `'page'` is the document's own page, `'item'` the document as content shown elsewhere;\n\t * `'auto'` (default) follows the binding, and bound as both gets a switch opening on the item.\n\t */\n\treport?: ReportOption\n}\n\nconst statField = (name: string, serverProps: StatServerProps, position?: 'sidebar'): UIField => ({\n\tname,\n\ttype: 'ui',\n\tlabel: ANALYTICS_LABEL,\n\tadmin: {\n\t\t...(position ? { position } : {}),\n\t\t// Read-only display fields have no cell value; a list column would render empty.\n\t\tdisabled: { column: true },\n\t\tcomponents: {\n\t\t\tField: { path: STAT_FIELD_COMPONENT, serverProps },\n\t\t},\n\t},\n})\n\nexport const analyticsStat = (options: AnalyticsStatOptions): UIField =>\n\tstatField(\n\t\toptions.name ?? `analytics_${options.metric}`,\n\t\t{\n\t\t\tmetrics: [options.metric],\n\t\t\ttimeframe: options.timeframe ?? DEFAULT_TIMEFRAME,\n\t\t\tvariant: 'stat',\n\t\t\tadapterId: options.adapter,\n\t\t\t...(options.label ? { labels: { [options.metric]: options.label } } : {}),\n\t\t\t...reportOf(options.report),\n\t\t},\n\t\toptions.position\n\t)\n\nexport const analyticsStatRow = (options: AnalyticsStatRowOptions = {}): UIField =>\n\tstatField(\n\t\toptions.name ?? 'analytics_stats',\n\t\t{\n\t\t\tmetrics: options.metrics ?? DEFAULT_ROW_METRICS,\n\t\t\t...(options.metrics === undefined ? { defaultMetrics: true } : {}),\n\t\t\ttimeframe: options.timeframe ?? DEFAULT_TIMEFRAME,\n\t\t\tvariant: 'row',\n\t\t\tadapterId: options.adapter,\n\t\t\tlabels: options.labels,\n\t\t\t...reportOf(options.report),\n\t\t},\n\t\toptions.position\n\t)\n\nexport const analyticsFields = (options: AnalyticsFieldsOptions = {}): UIField[] =>\n\t(options.metrics ?? DEFAULT_ROW_METRICS).map((metric) =>\n\t\tanalyticsStat({\n\t\t\tmetric,\n\t\t\ttimeframe: options.timeframe,\n\t\t\tadapter: options.adapter,\n\t\t\tname: `analytics_${metric}`,\n\t\t\tlabel: options.labels?.[metric],\n\t\t})\n\t)\n\nconst panelField = (options: AnalyticsTabOptions): UIField => ({\n\tname: 'analytics_panel',\n\ttype: 'ui',\n\tlabel: ANALYTICS_LABEL,\n\tadmin: {\n\t\tdisabled: { column: true },\n\t\tcomponents: {\n\t\t\tField: {\n\t\t\t\tpath: PANEL_FIELD_COMPONENT,\n\t\t\t\tserverProps: {\n\t\t\t\t\tmetrics: options.metrics ?? DEFAULT_PANEL_METRICS,\n\t\t\t\t\t...(options.metrics ? {} : { optionalMetrics: QUIET_PANEL_METRICS }),\n\t\t\t\t\ttimeframe: options.timeframe ?? DEFAULT_TIMEFRAME,\n\t\t\t\t\tadapterId: options.adapter,\n\t\t\t\t\tlabels: options.labels,\n\t\t\t\t\tdimensions: panelDimensions(options.breakdowns),\n\t\t\t\t\tliveVisitors: options.liveVisitors !== false,\n\t\t\t\t\t...(options.sources === undefined ? {} : { sources: options.sources }),\n\t\t\t\t\t...reportOf(options.report),\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t},\n})\n\n/**\n * Unnamed \"Analytics\" `Tab` for your own tabs field: the interactive panel, or the static\n * {@link analyticsStatRow} with `interactive: false`. See {@link analyticsTabsField}.\n */\nexport const analyticsTab = (options: AnalyticsTabOptions = {}): Tab => ({\n\tlabel: options.label ?? labelForKey(keys.tabAnalytics),\n\t...(options.description ? { description: options.description } : {}),\n\tfields: [\n\t\toptions.interactive === false\n\t\t\t? analyticsStatRow({\n\t\t\t\t\tmetrics: options.metrics,\n\t\t\t\t\ttimeframe: options.timeframe,\n\t\t\t\t\tadapter: options.adapter,\n\t\t\t\t\tlabels: options.labels,\n\t\t\t\t\t...reportOf(options.report),\n\t\t\t\t})\n\t\t\t: panelField(options),\n\t],\n})\n\n/** A ready-made tabs field containing a single {@link analyticsTab}. */\nexport const analyticsTabsField = (options: AnalyticsTabOptions = {}): TabsField => ({\n\ttype: 'tabs',\n\ttabs: [analyticsTab(options)],\n})\n"],"mappings":";;;;;;;;;AAaA,MAAM,kBAAkB,mBAAmB,KAAK,YAAY;AAE5D,MAAM,oBAAqC;AAE3C,MAAM,sBAAmC;CAAC;CAAa;CAAY;CAAY;AAAa;;;;;AAM5F,MAAM,yBAAsC;CAAC;CAAe;CAAW;AAAa;AACpF,MAAM,wBAAqC,CAAC,GAAG,qBAAqB,GAAG,sBAAsB;AAC7F,MAAM,sBAAmC,CAAC,eAAe,GAAG,sBAAsB;AAElF,MAAM,2BAA2C;CAAC;CAAW;CAAU;AAAQ;;AAG/E,MAAM,kBAAkB;AAExB,MAAM,mBAAmB,WAAiE;CACzF,IAAI,WAAW,OACd,OAAO,CAAC;CAET,OAAO,MAAM,QAAQ,MAAM,IAAI,OAAO,MAAM,GAAG,eAAe,IAAI;AACnE;AAEA,MAAM,YAAY,WACjB,WAAW,KAAA,IAAY,CAAC,IAAI,EAAE,OAAO;AAsFtC,MAAM,aAAa,MAAc,aAA8B,cAAmC;CACjG;CACA,MAAM;CACN,OAAO;CACP,OAAO;EACN,GAAI,WAAW,EAAE,SAAS,IAAI,CAAC;EAE/B,UAAU,EAAE,QAAQ,KAAK;EACzB,YAAY,EACX,OAAO;GAAE,MAAM;GAAsB;EAAY,EAClD;CACD;AACD;AAEA,MAAa,iBAAiB,YAC7B,UACC,QAAQ,QAAQ,aAAa,QAAQ,UACrC;CACC,SAAS,CAAC,QAAQ,MAAM;CACxB,WAAW,QAAQ,aAAa;CAChC,SAAS;CACT,WAAW,QAAQ;CACnB,GAAI,QAAQ,QAAQ,EAAE,QAAQ,GAAG,QAAQ,SAAS,QAAQ,MAAM,EAAE,IAAI,CAAC;CACvE,GAAG,SAAS,QAAQ,MAAM;AAC3B,GACA,QAAQ,QACT;AAED,MAAa,oBAAoB,UAAmC,CAAC,MACpE,UACC,QAAQ,QAAQ,mBAChB;CACC,SAAS,QAAQ,WAAW;CAC5B,GAAI,QAAQ,YAAY,KAAA,IAAY,EAAE,gBAAgB,KAAK,IAAI,CAAC;CAChE,WAAW,QAAQ,aAAa;CAChC,SAAS;CACT,WAAW,QAAQ;CACnB,QAAQ,QAAQ;CAChB,GAAG,SAAS,QAAQ,MAAM;AAC3B,GACA,QAAQ,QACT;AAED,MAAa,mBAAmB,UAAkC,CAAC,OACjE,QAAQ,WAAW,qBAAqB,KAAK,WAC7C,cAAc;CACb;CACA,WAAW,QAAQ;CACnB,SAAS,QAAQ;CACjB,MAAM,aAAa;CACnB,OAAO,QAAQ,SAAS;AACzB,CAAC,CACF;AAED,MAAM,cAAc,aAA2C;CAC9D,MAAM;CACN,MAAM;CACN,OAAO;CACP,OAAO;EACN,UAAU,EAAE,QAAQ,KAAK;EACzB,YAAY,EACX,OAAO;GACN,MAAM;GACN,aAAa;IACZ,SAAS,QAAQ,WAAW;IAC5B,GAAI,QAAQ,UAAU,CAAC,IAAI,EAAE,iBAAiB,oBAAoB;IAClE,WAAW,QAAQ,aAAa;IAChC,WAAW,QAAQ;IACnB,QAAQ,QAAQ;IAChB,YAAY,gBAAgB,QAAQ,UAAU;IAC9C,cAAc,QAAQ,iBAAiB;IACvC,GAAI,QAAQ,YAAY,KAAA,IAAY,CAAC,IAAI,EAAE,SAAS,QAAQ,QAAQ;IACpE,GAAG,SAAS,QAAQ,MAAM;GAC3B;EACD,EACD;CACD;AACD;;;;;AAMA,MAAa,gBAAgB,UAA+B,CAAC,OAAY;CACxE,OAAO,QAAQ,SAAS,YAAY,KAAK,YAAY;CACrD,GAAI,QAAQ,cAAc,EAAE,aAAa,QAAQ,YAAY,IAAI,CAAC;CAClE,QAAQ,CACP,QAAQ,gBAAgB,QACrB,iBAAiB;EACjB,SAAS,QAAQ;EACjB,WAAW,QAAQ;EACnB,SAAS,QAAQ;EACjB,QAAQ,QAAQ;EAChB,GAAG,SAAS,QAAQ,MAAM;CAC3B,CAAC,IACA,WAAW,OAAO,CACtB;AACD;;AAGA,MAAa,sBAAsB,UAA+B,CAAC,OAAkB;CACpF,MAAM;CACN,MAAM,CAAC,aAAa,OAAO,CAAC;AAC7B"}
|
package/dist/fields/format.d.ts
CHANGED
|
@@ -1,7 +1,16 @@
|
|
|
1
|
-
import { MetricKey } from "../core/contract.js";
|
|
1
|
+
import { MetricKey, MetricValue } from "../core/contract.js";
|
|
2
2
|
|
|
3
3
|
//#region src/fields/format.d.ts
|
|
4
|
-
|
|
4
|
+
/** Admin language alone, or with the install's resolved `revenue.currency`. */
|
|
5
|
+
type MetricFormat = string | {
|
|
6
|
+
locale: string;
|
|
7
|
+
currency?: string;
|
|
8
|
+
};
|
|
9
|
+
/**
|
|
10
|
+
* One metric as the admin language writes it. Revenue is money only with a resolved reporting
|
|
11
|
+
* currency, else a plain number; a missing or `null` reading is {@link NO_VALUE}.
|
|
12
|
+
*/
|
|
13
|
+
declare const formatMetricValue: (metric: MetricKey, value: MetricValue | undefined, format: MetricFormat) => string;
|
|
5
14
|
//#endregion
|
|
6
|
-
export { formatMetricValue };
|
|
15
|
+
export { MetricFormat, formatMetricValue };
|
|
7
16
|
//# sourceMappingURL=format.d.ts.map
|
package/dist/fields/format.js
CHANGED
|
@@ -1,22 +1,86 @@
|
|
|
1
|
+
import { listFormat, numberFormat } from "../translations/intl.js";
|
|
1
2
|
//#region src/fields/format.ts
|
|
2
|
-
const
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
3
|
+
const unitFormat = (locale, unit) => numberFormat(locale, {
|
|
4
|
+
style: "unit",
|
|
5
|
+
unit,
|
|
6
|
+
unitDisplay: "narrow"
|
|
7
|
+
});
|
|
8
|
+
/**
|
|
9
|
+
* Duration in the admin language, built from unit parts rather than `Intl.DurationFormat`, which
|
|
10
|
+
* Node 22 lacks while browsers have it, so server render and hydration agree.
|
|
11
|
+
*/
|
|
12
|
+
const formatDuration = (ms, locale) => {
|
|
13
|
+
const totalSeconds = Math.max(0, Math.round(ms / 1e3));
|
|
14
|
+
const hours = Math.floor(totalSeconds / 3600);
|
|
15
|
+
const minutes = Math.floor(totalSeconds % 3600 / 60);
|
|
6
16
|
const seconds = totalSeconds % 60;
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
17
|
+
const parts = [];
|
|
18
|
+
if (hours > 0) parts.push(unitFormat(locale, "hour").format(hours));
|
|
19
|
+
if (minutes > 0) parts.push(unitFormat(locale, "minute").format(minutes));
|
|
20
|
+
if (seconds > 0 || parts.length === 0) parts.push(unitFormat(locale, "second").format(seconds));
|
|
21
|
+
return listFormat(locale, {
|
|
22
|
+
type: "unit",
|
|
23
|
+
style: "narrow"
|
|
24
|
+
}).format(parts);
|
|
11
25
|
};
|
|
12
|
-
const formatCount = (value, locale) =>
|
|
26
|
+
const formatCount = (value, locale) => numberFormat(locale).format(value);
|
|
27
|
+
/** A window of whole minutes written out in the admin language: "30 minutes". */
|
|
28
|
+
const formatMinutes = (minutes, locale) => numberFormat(locale, {
|
|
29
|
+
style: "unit",
|
|
30
|
+
unit: "minute",
|
|
31
|
+
unitDisplay: "long"
|
|
32
|
+
}).format(minutes);
|
|
13
33
|
const PERCENT_METRICS = new Set(["bounceRate", "scrollDepth"]);
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
34
|
+
/** Metrics read in milliseconds and written as a duration. */
|
|
35
|
+
const DURATION_METRICS = new Set(["avgDuration", "visitDuration"]);
|
|
36
|
+
/** A 0..100 rate as the admin language writes a percentage, sign and spacing included. */
|
|
37
|
+
const formatPercent = (value, locale) => numberFormat(locale, {
|
|
38
|
+
style: "percent",
|
|
39
|
+
maximumFractionDigits: 0
|
|
40
|
+
}).format(value / 100);
|
|
41
|
+
/**
|
|
42
|
+
* Share between 0 and 1, one decimal on every surface alike; the no-value dash when either side of
|
|
43
|
+
* the ratio is missing. A share under one percent keeps two significant digits rather than
|
|
44
|
+
* rounding a few conversions to 0%.
|
|
45
|
+
*/
|
|
46
|
+
const formatRate = (ratio, locale) => {
|
|
47
|
+
if (typeof ratio !== "number") return "-";
|
|
48
|
+
return ratio > 0 && ratio < .01 ? numberFormat(locale, {
|
|
49
|
+
style: "percent",
|
|
50
|
+
maximumSignificantDigits: 2
|
|
51
|
+
}).format(ratio) : numberFormat(locale, {
|
|
52
|
+
style: "percent",
|
|
53
|
+
maximumFractionDigits: 1
|
|
54
|
+
}).format(ratio);
|
|
55
|
+
};
|
|
56
|
+
/**
|
|
57
|
+
* Revenue in the install's reporting currency. A code the runtime refuses falls back to a
|
|
58
|
+
* plain number rather than throwing in the middle of a render.
|
|
59
|
+
*/
|
|
60
|
+
const formatCurrency = (value, locale, currency) => {
|
|
61
|
+
try {
|
|
62
|
+
return numberFormat(locale, {
|
|
63
|
+
style: "currency",
|
|
64
|
+
currency
|
|
65
|
+
}).format(value);
|
|
66
|
+
} catch {
|
|
67
|
+
return formatCount(value, locale);
|
|
68
|
+
}
|
|
69
|
+
};
|
|
70
|
+
/**
|
|
71
|
+
* One metric as the admin language writes it. Revenue is money only with a resolved reporting
|
|
72
|
+
* currency, else a plain number; a missing or `null` reading is {@link NO_VALUE}.
|
|
73
|
+
*/
|
|
74
|
+
const formatMetricValue = (metric, value, format) => {
|
|
75
|
+
if (value === null || value === void 0) return "-";
|
|
76
|
+
const locale = typeof format === "string" ? format : format.locale;
|
|
77
|
+
const currency = typeof format === "string" ? void 0 : format.currency;
|
|
78
|
+
if (DURATION_METRICS.has(metric)) return formatDuration(value, locale);
|
|
79
|
+
if (PERCENT_METRICS.has(metric)) return formatPercent(value, locale);
|
|
80
|
+
if (metric === "revenue" && currency) return formatCurrency(value, locale, currency);
|
|
17
81
|
return formatCount(value, locale);
|
|
18
82
|
};
|
|
19
83
|
//#endregion
|
|
20
|
-
export { formatMetricValue };
|
|
84
|
+
export { formatDuration, formatMetricValue, formatMinutes, formatRate };
|
|
21
85
|
|
|
22
86
|
//# sourceMappingURL=format.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"format.js","names":[],"sources":["../../src/fields/format.ts"],"sourcesContent":["import type { MetricKey } from '../core/contract'\n\nexport const formatDuration = (ms: number): string => {\n\tconst totalSeconds = Math.round(ms / 1000)\n\
|
|
1
|
+
{"version":3,"file":"format.js","names":[],"sources":["../../src/fields/format.ts"],"sourcesContent":["import type { MetricKey, MetricValue } from '../core/contract'\nimport { NO_VALUE } from '../core/metricValues'\nimport { listFormat, numberFormat } from '../translations/intl'\n\ntype DurationUnit = 'hour' | 'minute' | 'second'\n\nconst unitFormat = (locale: string, unit: DurationUnit): Intl.NumberFormat =>\n\tnumberFormat(locale, { style: 'unit', unit, unitDisplay: 'narrow' })\n\n/**\n * Duration in the admin language, built from unit parts rather than `Intl.DurationFormat`, which\n * Node 22 lacks while browsers have it, so server render and hydration agree.\n */\nexport const formatDuration = (ms: number, locale: string): string => {\n\tconst totalSeconds = Math.max(0, Math.round(ms / 1000))\n\tconst hours = Math.floor(totalSeconds / 3600)\n\tconst minutes = Math.floor((totalSeconds % 3600) / 60)\n\tconst seconds = totalSeconds % 60\n\tconst parts: string[] = []\n\tif (hours > 0) parts.push(unitFormat(locale, 'hour').format(hours))\n\tif (minutes > 0) parts.push(unitFormat(locale, 'minute').format(minutes))\n\tif (seconds > 0 || parts.length === 0) parts.push(unitFormat(locale, 'second').format(seconds))\n\treturn listFormat(locale, { type: 'unit', style: 'narrow' }).format(parts)\n}\n\nexport const formatCount = (value: number, locale: string): string =>\n\tnumberFormat(locale).format(value)\n\n/** A window of whole minutes written out in the admin language: \"30 minutes\". */\nexport const formatMinutes = (minutes: number, locale: string): string =>\n\tnumberFormat(locale, { style: 'unit', unit: 'minute', unitDisplay: 'long' }).format(minutes)\n\nconst PERCENT_METRICS: ReadonlySet<MetricKey> = new Set(['bounceRate', 'scrollDepth'])\n\n/** Metrics read in milliseconds and written as a duration. */\nconst DURATION_METRICS: ReadonlySet<MetricKey> = new Set(['avgDuration', 'visitDuration'])\n\n/** A 0..100 rate as the admin language writes a percentage, sign and spacing included. */\nexport const formatPercent = (value: number, locale: string): string =>\n\tnumberFormat(locale, { style: 'percent', maximumFractionDigits: 0 }).format(value / 100)\n\n/**\n * Share between 0 and 1, one decimal on every surface alike; the no-value dash when either side of\n * the ratio is missing. A share under one percent keeps two significant digits rather than\n * rounding a few conversions to 0%.\n */\nexport const formatRate = (ratio: number | null | undefined, locale: string): string => {\n\tif (typeof ratio !== 'number') {\n\t\treturn NO_VALUE\n\t}\n\treturn ratio > 0 && ratio < 0.01\n\t\t? numberFormat(locale, { style: 'percent', maximumSignificantDigits: 2 }).format(ratio)\n\t\t: numberFormat(locale, { style: 'percent', maximumFractionDigits: 1 }).format(ratio)\n}\n\n/**\n * Revenue in the install's reporting currency. A code the runtime refuses falls back to a\n * plain number rather than throwing in the middle of a render.\n */\nexport const formatCurrency = (value: number, locale: string, currency: string): string => {\n\ttry {\n\t\treturn numberFormat(locale, { style: 'currency', currency }).format(value)\n\t} catch {\n\t\treturn formatCount(value, locale)\n\t}\n}\n\n/** Admin language alone, or with the install's resolved `revenue.currency`. */\nexport type MetricFormat = string | { locale: string; currency?: string }\n\n/**\n * One metric as the admin language writes it. Revenue is money only with a resolved reporting\n * currency, else a plain number; a missing or `null` reading is {@link NO_VALUE}.\n */\nexport const formatMetricValue = (\n\tmetric: MetricKey,\n\tvalue: MetricValue | undefined,\n\tformat: MetricFormat\n): string => {\n\tif (value === null || value === undefined) {\n\t\treturn NO_VALUE\n\t}\n\tconst locale = typeof format === 'string' ? format : format.locale\n\tconst currency = typeof format === 'string' ? undefined : format.currency\n\tif (DURATION_METRICS.has(metric)) return formatDuration(value, locale)\n\tif (PERCENT_METRICS.has(metric)) return formatPercent(value, locale)\n\tif (metric === 'revenue' && currency) return formatCurrency(value, locale, currency)\n\treturn formatCount(value, locale)\n}\n"],"mappings":";;AAMA,MAAM,cAAc,QAAgB,SACnC,aAAa,QAAQ;CAAE,OAAO;CAAQ;CAAM,aAAa;AAAS,CAAC;;;;;AAMpE,MAAa,kBAAkB,IAAY,WAA2B;CACrE,MAAM,eAAe,KAAK,IAAI,GAAG,KAAK,MAAM,KAAK,GAAI,CAAC;CACtD,MAAM,QAAQ,KAAK,MAAM,eAAe,IAAI;CAC5C,MAAM,UAAU,KAAK,MAAO,eAAe,OAAQ,EAAE;CACrD,MAAM,UAAU,eAAe;CAC/B,MAAM,QAAkB,CAAC;CACzB,IAAI,QAAQ,GAAG,MAAM,KAAK,WAAW,QAAQ,MAAM,EAAE,OAAO,KAAK,CAAC;CAClE,IAAI,UAAU,GAAG,MAAM,KAAK,WAAW,QAAQ,QAAQ,EAAE,OAAO,OAAO,CAAC;CACxE,IAAI,UAAU,KAAK,MAAM,WAAW,GAAG,MAAM,KAAK,WAAW,QAAQ,QAAQ,EAAE,OAAO,OAAO,CAAC;CAC9F,OAAO,WAAW,QAAQ;EAAE,MAAM;EAAQ,OAAO;CAAS,CAAC,EAAE,OAAO,KAAK;AAC1E;AAEA,MAAa,eAAe,OAAe,WAC1C,aAAa,MAAM,EAAE,OAAO,KAAK;;AAGlC,MAAa,iBAAiB,SAAiB,WAC9C,aAAa,QAAQ;CAAE,OAAO;CAAQ,MAAM;CAAU,aAAa;AAAO,CAAC,EAAE,OAAO,OAAO;AAE5F,MAAM,kBAA0C,IAAI,IAAI,CAAC,cAAc,aAAa,CAAC;;AAGrF,MAAM,mBAA2C,IAAI,IAAI,CAAC,eAAe,eAAe,CAAC;;AAGzF,MAAa,iBAAiB,OAAe,WAC5C,aAAa,QAAQ;CAAE,OAAO;CAAW,uBAAuB;AAAE,CAAC,EAAE,OAAO,QAAQ,GAAG;;;;;;AAOxF,MAAa,cAAc,OAAkC,WAA2B;CACvF,IAAI,OAAO,UAAU,UACpB,OAAA;CAED,OAAO,QAAQ,KAAK,QAAQ,MACzB,aAAa,QAAQ;EAAE,OAAO;EAAW,0BAA0B;CAAE,CAAC,EAAE,OAAO,KAAK,IACpF,aAAa,QAAQ;EAAE,OAAO;EAAW,uBAAuB;CAAE,CAAC,EAAE,OAAO,KAAK;AACrF;;;;;AAMA,MAAa,kBAAkB,OAAe,QAAgB,aAA6B;CAC1F,IAAI;EACH,OAAO,aAAa,QAAQ;GAAE,OAAO;GAAY;EAAS,CAAC,EAAE,OAAO,KAAK;CAC1E,QAAQ;EACP,OAAO,YAAY,OAAO,MAAM;CACjC;AACD;;;;;AASA,MAAa,qBACZ,QACA,OACA,WACY;CACZ,IAAI,UAAU,QAAQ,UAAU,KAAA,GAC/B,OAAA;CAED,MAAM,SAAS,OAAO,WAAW,WAAW,SAAS,OAAO;CAC5D,MAAM,WAAW,OAAO,WAAW,WAAW,KAAA,IAAY,OAAO;CACjE,IAAI,iBAAiB,IAAI,MAAM,GAAG,OAAO,eAAe,OAAO,MAAM;CACrE,IAAI,gBAAgB,IAAI,MAAM,GAAG,OAAO,cAAc,OAAO,MAAM;CACnE,IAAI,WAAW,aAAa,UAAU,OAAO,eAAe,OAAO,QAAQ,QAAQ;CACnF,OAAO,YAAY,OAAO,MAAM;AACjC"}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import { keys } from "../translations/keys.js";
|
|
2
|
+
//#region src/fields/itemReport.ts
|
|
3
|
+
/** Metrics the panel's item report reads. */
|
|
4
|
+
const ITEM_PANEL_METRICS = [
|
|
5
|
+
"impressions",
|
|
6
|
+
"visitors",
|
|
7
|
+
"interactions",
|
|
8
|
+
"conversions",
|
|
9
|
+
"revenue"
|
|
10
|
+
];
|
|
11
|
+
/** An install that measures no money has no revenue to read, which is no reason to warn. */
|
|
12
|
+
const ITEM_PANEL_OPTIONAL_METRICS = ["revenue"];
|
|
13
|
+
/** Defaults of a stat row on an item. */
|
|
14
|
+
const ITEM_STAT_METRICS = [
|
|
15
|
+
"impressions",
|
|
16
|
+
"visitors",
|
|
17
|
+
"interactions",
|
|
18
|
+
"conversions"
|
|
19
|
+
];
|
|
20
|
+
/** The item lists: where it was seen, then the countries and devices of the people who clicked. */
|
|
21
|
+
const ITEM_PANEL_DIMENSIONS = [
|
|
22
|
+
"page",
|
|
23
|
+
"country",
|
|
24
|
+
"device"
|
|
25
|
+
];
|
|
26
|
+
/**
|
|
27
|
+
* Metrics an item's own buckets count. Anything else (pageviews, sessions, time on page) would
|
|
28
|
+
* always read zero for an item, so it is dropped like an unserved metric.
|
|
29
|
+
*/
|
|
30
|
+
const ITEM_READ_METRICS = new Set([
|
|
31
|
+
"impressions",
|
|
32
|
+
"interactions",
|
|
33
|
+
"visitors",
|
|
34
|
+
"events",
|
|
35
|
+
"conversions",
|
|
36
|
+
"revenue"
|
|
37
|
+
]);
|
|
38
|
+
/** Names an item report gives a metric where the metric's own name would mislead. */
|
|
39
|
+
const ITEM_METRIC_LABELS = { visitors: keys.itemViewers };
|
|
40
|
+
/** The name an item report gives `metric`, else `fallback`. */
|
|
41
|
+
const itemMetricLabel = (metric, fallback) => ITEM_METRIC_LABELS[metric] ?? fallback;
|
|
42
|
+
//#endregion
|
|
43
|
+
export { ITEM_PANEL_DIMENSIONS, ITEM_PANEL_METRICS, ITEM_PANEL_OPTIONAL_METRICS, ITEM_READ_METRICS, ITEM_STAT_METRICS, itemMetricLabel };
|
|
44
|
+
|
|
45
|
+
//# sourceMappingURL=itemReport.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"itemReport.js","names":[],"sources":["../../src/fields/itemReport.ts"],"sourcesContent":["import type { DimensionKey, MetricKey } from '../core/contract'\nimport { keys, type TranslationKey } from '../translations/keys'\n\n/** Metrics the panel's item report reads. */\nexport const ITEM_PANEL_METRICS: MetricKey[] = [\n\t'impressions',\n\t'visitors',\n\t'interactions',\n\t'conversions',\n\t'revenue',\n]\n\n/** An install that measures no money has no revenue to read, which is no reason to warn. */\nexport const ITEM_PANEL_OPTIONAL_METRICS: MetricKey[] = ['revenue']\n\n/** Defaults of a stat row on an item. */\nexport const ITEM_STAT_METRICS: MetricKey[] = [\n\t'impressions',\n\t'visitors',\n\t'interactions',\n\t'conversions',\n]\n\n/** The item lists: where it was seen, then the countries and devices of the people who clicked. */\nexport const ITEM_PANEL_DIMENSIONS: DimensionKey[] = ['page', 'country', 'device']\n\n/**\n * Metrics an item's own buckets count. Anything else (pageviews, sessions, time on page) would\n * always read zero for an item, so it is dropped like an unserved metric.\n */\nexport const ITEM_READ_METRICS: ReadonlySet<MetricKey> = new Set<MetricKey>([\n\t'impressions',\n\t'interactions',\n\t'visitors',\n\t'events',\n\t'conversions',\n\t'revenue',\n])\n\n/** Names an item report gives a metric where the metric's own name would mislead. */\nconst ITEM_METRIC_LABELS: Partial<Record<MetricKey, TranslationKey>> = {\n\tvisitors: keys.itemViewers,\n}\n\n/** The name an item report gives `metric`, else `fallback`. */\nexport const itemMetricLabel = (metric: MetricKey, fallback: TranslationKey): TranslationKey =>\n\tITEM_METRIC_LABELS[metric] ?? fallback\n"],"mappings":";;;AAIA,MAAa,qBAAkC;CAC9C;CACA;CACA;CACA;CACA;AACD;;AAGA,MAAa,8BAA2C,CAAC,SAAS;;AAGlE,MAAa,oBAAiC;CAC7C;CACA;CACA;CACA;AACD;;AAGA,MAAa,wBAAwC;CAAC;CAAQ;CAAW;AAAQ;;;;;AAMjF,MAAa,oBAA4C,IAAI,IAAe;CAC3E;CACA;CACA;CACA;CACA;CACA;AACD,CAAC;;AAGD,MAAM,qBAAiE,EACtE,UAAU,KAAK,YAChB;;AAGA,MAAa,mBAAmB,QAAmB,aAClD,mBAAmB,WAAW"}
|
|
@@ -1,62 +1,115 @@
|
|
|
1
|
-
import { DateRange, MetricKey } from "../core/contract.js";
|
|
1
|
+
import { DateRange, DimensionKey, MetricKey, MetricValues } from "../core/contract.js";
|
|
2
|
+
import { ReadPrincipal } from "../access/principal.js";
|
|
2
3
|
import { BindingDoc } from "../binding/types.js";
|
|
3
4
|
import { TimeframePreset } from "../timeframe/presets.js";
|
|
4
|
-
import {
|
|
5
|
+
import { ReadNotices } from "../widgets/readMeta.js";
|
|
6
|
+
import { StoredSourceRead, SubstitutedSource } from "../widgets/prepareWidgetRead.js";
|
|
7
|
+
import { ReportMode } from "../binding/report.js";
|
|
8
|
+
import { SeriesGranularity, SeriesPoint } from "../charts/series.js";
|
|
5
9
|
import { PayloadRequest } from "payload";
|
|
6
10
|
|
|
7
11
|
//#region src/fields/readForDocument.d.ts
|
|
8
|
-
|
|
9
|
-
|
|
12
|
+
/**
|
|
13
|
+
* `no-access` is about the reader, never a page without traffic; `unavailable` a source that
|
|
14
|
+
* cannot read the document at all; `busy` a failure for now, which a retry can fix.
|
|
15
|
+
*/
|
|
16
|
+
type FieldReadStatus = 'ok' | 'no-path' | 'not-bound' | 'not-configured' | 'no-access' | 'no-scope' | 'unavailable' | 'busy' | 'invalid' | 'range-too-long' | 'misconfigured' | 'host-refused';
|
|
17
|
+
/** One ranked value of a dimension, for this document's page only. */
|
|
18
|
+
interface FieldBreakdownRow {
|
|
19
|
+
value: string;
|
|
20
|
+
metric: number;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* A dimension ranked for this page. The read is a `page eq <path>` filter rather than the
|
|
24
|
+
* per-page report, because that is the only shape a source can group another dimension by.
|
|
25
|
+
*/
|
|
26
|
+
interface FieldBreakdown extends Partial<ReadNotices> {
|
|
27
|
+
dimension: DimensionKey;
|
|
28
|
+
/** The metric the rows are ranked by; `visitors` wherever the source serves it. */
|
|
29
|
+
metric: MetricKey;
|
|
30
|
+
rows: FieldBreakdownRow[];
|
|
31
|
+
/** The source that answered, for the value labels that read differently per provider. */
|
|
32
|
+
provider?: string;
|
|
33
|
+
}
|
|
34
|
+
interface FieldReadResult extends SubstitutedSource {
|
|
10
35
|
status: FieldReadStatus;
|
|
36
|
+
/** How long until a `busy` read can succeed, when the source or the plugin knows. */
|
|
37
|
+
retryAfterMs?: number;
|
|
38
|
+
/** The headline numbers answered but a comparison, series or list did not: try again for it. */
|
|
39
|
+
incomplete?: true;
|
|
40
|
+
/** `item` when the read was about the document as a content item, absent for its page. */
|
|
41
|
+
report?: 'item';
|
|
11
42
|
adapterId: string;
|
|
12
43
|
dateRange: DateRange;
|
|
13
44
|
/** The reporting timezone the read resolved in; the trend axis buckets in it. */
|
|
14
45
|
timezone: string;
|
|
15
|
-
|
|
46
|
+
/** An average with nothing to average over reads `null`; render it as no data, not zero. */
|
|
47
|
+
metrics: MetricValues;
|
|
16
48
|
/** Requested metrics the adapter supports, in request order; the set actually read. */
|
|
17
49
|
supportedMetrics: MetricKey[];
|
|
18
50
|
/** Requested metrics the adapter cannot serve, dropped from the read. */
|
|
19
51
|
droppedMetrics: MetricKey[];
|
|
20
52
|
/** Previous-window totals, present only when comparison was requested and supported. */
|
|
21
|
-
previousMetrics?:
|
|
53
|
+
previousMetrics?: MetricValues;
|
|
22
54
|
/** The previous comparable window, present only when comparison ran. */
|
|
23
55
|
comparisonRange?: DateRange;
|
|
24
|
-
/**
|
|
56
|
+
/** Series for the first supported metric, present only when requested. */
|
|
25
57
|
points?: SeriesPoint[];
|
|
58
|
+
/**
|
|
59
|
+
* The bucket `points` carry. A window of a day or two is charted by hour, so `day` there
|
|
60
|
+
* says the source serves no hourly rows and the panel has a single value, not a line.
|
|
61
|
+
*/
|
|
62
|
+
seriesGranularity?: SeriesGranularity;
|
|
63
|
+
/** The source counts live visitors, so the panel may poll for this page's own count. */
|
|
64
|
+
realtime?: boolean;
|
|
65
|
+
/** One entry per requested dimension the source can rank for a single page. */
|
|
66
|
+
breakdowns?: FieldBreakdown[];
|
|
67
|
+
/** What the totals' and the series' reads say about their numbers. */
|
|
68
|
+
notices?: ReadNotices;
|
|
69
|
+
/**
|
|
70
|
+
* Reader may not read into the document's scope (or is no member of the request's), so the
|
|
71
|
+
* read never ran. Rendered as `no-access`; the endpoint answers `untrusted_scope`.
|
|
72
|
+
*/
|
|
73
|
+
untrustedScope?: boolean;
|
|
26
74
|
}
|
|
27
|
-
|
|
75
|
+
/**
|
|
76
|
+
* Without `scope` the read takes the document's scope (binding `scopeField`) else the request's,
|
|
77
|
+
* gated as endpoints gate it; a given `scope` is already cleared, or a job's under `SYSTEM`.
|
|
78
|
+
*/
|
|
79
|
+
type ReadForFieldArgs = ReadPrincipal & StoredSourceRead & {
|
|
28
80
|
req: PayloadRequest;
|
|
29
81
|
collectionSlug: string;
|
|
30
82
|
data: BindingDoc;
|
|
31
83
|
metrics: MetricKey[];
|
|
32
|
-
timeframe: TimeframePreset;
|
|
33
|
-
/** Overrides the preset window (custom range). */
|
|
84
|
+
timeframe: TimeframePreset; /** Overrides the preset window (custom range). */
|
|
34
85
|
range?: DateRange;
|
|
35
86
|
adapterId?: string;
|
|
36
87
|
now: Date;
|
|
37
|
-
/** Explicit scope override; omitted resolves via the plugin's scopeResolver. */
|
|
38
|
-
scope?: string | null;
|
|
39
88
|
/**
|
|
40
89
|
* Reporting timezone the caller already resolved, reused rather than resolved again so
|
|
41
90
|
* a caller-supplied `range` is read in the very timezone it was interpreted in.
|
|
42
91
|
*/
|
|
43
|
-
timezone?: string;
|
|
44
|
-
/** Also read the
|
|
45
|
-
compare?: boolean;
|
|
46
|
-
/** Also read a daily series for the first supported metric when the adapter can. */
|
|
92
|
+
timezone?: string; /** Also read the previous comparable window when the adapter supports comparison. */
|
|
93
|
+
compare?: boolean; /** Also read a series for the first supported metric, bucketed to suit the window. */
|
|
47
94
|
series?: boolean;
|
|
48
|
-
|
|
95
|
+
/**
|
|
96
|
+
* Metrics the caller added speculatively rather than asked for, so a source that serves none
|
|
97
|
+
* of them is not worth a warning on every render.
|
|
98
|
+
*/
|
|
99
|
+
optionalMetrics?: MetricKey[]; /** Rank these dimensions for the document's own page; each one the source cannot is skipped. */
|
|
100
|
+
dimensions?: DimensionKey[]; /** Rows per breakdown. Default 5. */
|
|
101
|
+
limit?: number;
|
|
102
|
+
/**
|
|
103
|
+
* `item` reads the document as content shown on other pages: its views, clicks and outcomes,
|
|
104
|
+
* wherever it appeared. Absent, or `page`, reads the document's own page.
|
|
105
|
+
*/
|
|
106
|
+
report?: ReportMode;
|
|
107
|
+
};
|
|
49
108
|
/**
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
* then read through the surfacing engine. Returns a discriminated status so the
|
|
53
|
-
* rendering component can show the right empty state without throwing.
|
|
54
|
-
*
|
|
55
|
-
* A metric the adapter does not support is dropped (with one warning per field
|
|
56
|
-
* render), not fatal; `unavailable` is returned only when no requested metric
|
|
57
|
-
* survives or the adapter cannot query per page at all.
|
|
109
|
+
* Reads a document's analytics for one display field, never throwing: a status picks the empty
|
|
110
|
+
* state. An unsupported metric is dropped with a warning; `unavailable` only when none survives.
|
|
58
111
|
*/
|
|
59
112
|
declare const readForField: (args: ReadForFieldArgs) => Promise<FieldReadResult>;
|
|
60
113
|
//#endregion
|
|
61
|
-
export { FieldReadResult, FieldReadStatus, ReadForFieldArgs, readForField };
|
|
114
|
+
export { FieldBreakdown, FieldBreakdownRow, FieldReadResult, FieldReadStatus, ReadForFieldArgs, readForField };
|
|
62
115
|
//# sourceMappingURL=readForDocument.d.ts.map
|