@10x-media/analytics 1.0.0-beta.6 → 1.0.0-beta.8
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 +73 -0
- package/README.md +13 -3
- package/dist/adapters/ga4/ga4.js +3 -2
- package/dist/adapters/ga4/ga4.js.map +1 -1
- package/dist/adapters/http/fetchJson.js +1 -1
- package/dist/adapters/plausible/plausible.d.ts +10 -0
- package/dist/adapters/plausible/plausible.js +42 -1
- package/dist/adapters/plausible/plausible.js.map +1 -1
- package/dist/adapters/posthog/posthog.d.ts +10 -1
- package/dist/adapters/posthog/posthog.js +47 -0
- package/dist/adapters/posthog/posthog.js.map +1 -1
- package/dist/adapters/umami/umami.d.ts +5 -1
- package/dist/adapters/umami/umami.js +26 -0
- package/dist/adapters/umami/umami.js.map +1 -1
- package/dist/capture/getTrackerConfig.d.ts +20 -0
- package/dist/capture/getTrackerConfig.js +31 -0
- package/dist/capture/getTrackerConfig.js.map +1 -0
- package/dist/capture/mountPath.js +14 -0
- package/dist/capture/mountPath.js.map +1 -0
- package/dist/capture/proxyEndpoint.js +123 -0
- package/dist/capture/proxyEndpoint.js.map +1 -0
- package/dist/capture/proxyRoutes.js +108 -0
- package/dist/capture/proxyRoutes.js.map +1 -0
- package/dist/capture/requestBody.js +68 -0
- package/dist/capture/requestBody.js.map +1 -0
- package/dist/capture/slots.d.ts +8 -0
- package/dist/capture/slots.js +54 -0
- package/dist/capture/slots.js.map +1 -0
- package/dist/capture/trackerConfig.d.ts +33 -0
- package/dist/capture/trackerConfig.js +95 -0
- package/dist/capture/trackerConfig.js.map +1 -0
- package/dist/capture/trackerEndpoint.js +35 -0
- package/dist/capture/trackerEndpoint.js.map +1 -0
- package/dist/charts/BarList.d.ts +15 -1
- package/dist/charts/BarList.js +34 -18
- package/dist/charts/BarList.js.map +1 -1
- package/dist/charts/TrendChart.d.ts +16 -3
- package/dist/charts/TrendChart.js +172 -106
- package/dist/charts/TrendChart.js.map +1 -1
- package/dist/charts/bars.d.ts +2 -0
- package/dist/charts/bars.js +2 -1
- package/dist/charts/bars.js.map +1 -1
- package/dist/charts/bucket.js +10 -1
- package/dist/charts/bucket.js.map +1 -1
- package/dist/charts/spline.js +2 -2
- package/dist/charts/spline.js.map +1 -1
- package/dist/charts/styles.js +18 -1
- package/dist/charts/styles.js.map +1 -1
- package/dist/core/cacheKey.js +13 -1
- package/dist/core/cacheKey.js.map +1 -1
- package/dist/core/capture.d.ts +49 -0
- package/dist/core/contract.d.ts +35 -4
- package/dist/core/contract.js +29 -1
- package/dist/core/contract.js.map +1 -1
- package/dist/core/granularity.js +1 -1
- package/dist/core/options.d.ts +148 -4
- package/dist/core/options.js +121 -3
- package/dist/core/options.js.map +1 -1
- package/dist/core/registry.d.ts +1 -0
- package/dist/core/scopeList.js +32 -0
- package/dist/core/scopeList.js.map +1 -0
- package/dist/core/scopedRead.js +45 -28
- package/dist/core/scopedRead.js.map +1 -1
- package/dist/core/serverEvent.d.ts +42 -0
- package/dist/core/serverEvent.js +12 -0
- package/dist/core/serverEvent.js.map +1 -0
- package/dist/exports/client.d.ts +8 -2
- package/dist/exports/client.js +6 -1
- package/dist/exports/next.d.ts +2 -1
- package/dist/exports/next.js +2 -1
- package/dist/exports/react.d.ts +4 -0
- package/dist/exports/react.js +5 -0
- package/dist/exports/rsc.d.ts +8 -1
- package/dist/exports/rsc.js +7 -2
- package/dist/exports/tracker.d.ts +18 -0
- package/dist/exports/tracker.js +12 -0
- package/dist/exports/types.d.ts +14 -3
- package/dist/exports/types.js +2 -2
- package/dist/fields/AnalyticsPanelClient.js +2 -2
- package/dist/fields/AnalyticsPanelField.js +1 -1
- package/dist/fields/AnalyticsStatField.js +2 -2
- package/dist/fields/config/MetricSelectField.js +2 -2
- package/dist/fields/config/MetricSelectField.js.map +1 -1
- package/dist/fields/config/SourceSelectField.js +2 -2
- package/dist/fields/config/SourceSelectField.js.map +1 -1
- package/dist/fields/config/fetchSources.d.ts +5 -1
- package/dist/fields/config/narrow.js +2 -0
- package/dist/fields/config/narrow.js.map +1 -1
- package/dist/fields/readForDocument.d.ts +5 -0
- package/dist/fields/readForDocument.js +6 -6
- package/dist/fields/readForDocument.js.map +1 -1
- package/dist/goals/GoalSelectField.d.ts +7 -0
- package/dist/goals/GoalSelectField.js +77 -0
- package/dist/goals/GoalSelectField.js.map +1 -0
- package/dist/goals/collection.js +250 -0
- package/dist/goals/collection.js.map +1 -0
- package/dist/goals/currency.js +14 -0
- package/dist/goals/currency.js.map +1 -0
- package/dist/goals/fetchGoals.d.ts +18 -0
- package/dist/goals/fetchGoals.js +29 -0
- package/dist/goals/fetchGoals.js.map +1 -0
- package/dist/goals/goalField.d.ts +31 -0
- package/dist/goals/goalField.js +56 -0
- package/dist/goals/goalField.js.map +1 -0
- package/dist/goals/goalsEndpoint.d.ts +1 -0
- package/dist/goals/goalsEndpoint.js +55 -0
- package/dist/goals/goalsEndpoint.js.map +1 -0
- package/dist/goals/match.js +64 -0
- package/dist/goals/match.js.map +1 -0
- package/dist/goals/resolver.d.ts +8 -0
- package/dist/goals/resolver.js +147 -0
- package/dist/goals/resolver.js.map +1 -0
- package/dist/goals/trackGoalAction.d.ts +74 -0
- package/dist/goals/trackGoalAction.js +139 -0
- package/dist/goals/trackGoalAction.js.map +1 -0
- package/dist/goals/types.d.ts +33 -0
- package/dist/goals/types.js +7 -0
- package/dist/goals/types.js.map +1 -0
- package/dist/goals/useAnalyticsGoals.d.ts +20 -0
- package/dist/goals/useAnalyticsGoals.js +67 -0
- package/dist/goals/useAnalyticsGoals.js.map +1 -0
- package/dist/index.d.ts +11 -3
- package/dist/index.js +104 -17
- package/dist/index.js.map +1 -1
- package/dist/native/collections/events.js +21 -1
- package/dist/native/collections/events.js.map +1 -1
- package/dist/native/collections/rollups.js +24 -0
- package/dist/native/collections/rollups.js.map +1 -1
- package/dist/native/geo/maxmindResolver.js +2 -4
- package/dist/native/geo/maxmindResolver.js.map +1 -1
- package/dist/native/ingest/clientIp.js +15 -0
- package/dist/native/ingest/clientIp.js.map +1 -0
- package/dist/native/ingest/device.js +11 -3
- package/dist/native/ingest/device.js.map +1 -1
- package/dist/native/ingest/endpoint.d.ts +1 -0
- package/dist/native/ingest/endpoint.js +25 -4
- package/dist/native/ingest/endpoint.js.map +1 -1
- package/dist/native/ingest/flushBatch.js +4 -13
- package/dist/native/ingest/flushBatch.js.map +1 -1
- package/dist/native/ingest/normalizeEvent.d.ts +20 -0
- package/dist/native/ingest/normalizeEvent.js +78 -10
- package/dist/native/ingest/normalizeEvent.js.map +1 -1
- package/dist/native/ingest/serverTrack.d.ts +20 -0
- package/dist/native/ingest/serverTrack.js +99 -0
- package/dist/native/ingest/serverTrack.js.map +1 -0
- package/dist/native/ingest/validate.js +27 -0
- package/dist/native/ingest/validate.js.map +1 -0
- package/dist/native/nativeAdapter.d.ts +1 -1
- package/dist/native/nativeAdapter.js +38 -11
- package/dist/native/nativeAdapter.js.map +1 -1
- package/dist/native/query/eventAgg.js +39 -13
- package/dist/native/query/eventAgg.js.map +1 -1
- package/dist/native/retention/pruneTask.js +1 -1
- package/dist/native/rollupAcc.js +12 -1
- package/dist/native/rollupAcc.js.map +1 -1
- package/dist/native/rollups/bumpRollup.js +5 -1
- package/dist/native/rollups/bumpRollup.js.map +1 -1
- package/dist/native/rollups/deltas.js +28 -6
- package/dist/native/rollups/deltas.js.map +1 -1
- package/dist/native/rollups/insertIfNew.js +36 -2
- package/dist/native/rollups/insertIfNew.js.map +1 -1
- package/dist/next/captureRewrites.d.ts +41 -0
- package/dist/next/captureRewrites.js +56 -0
- package/dist/next/captureRewrites.js.map +1 -0
- package/dist/next/posthogProxyRewrites.d.ts +5 -0
- package/dist/next/posthogProxyRewrites.js +16 -21
- package/dist/next/posthogProxyRewrites.js.map +1 -1
- package/dist/plugin/documentEndpoint.js +28 -10
- package/dist/plugin/documentEndpoint.js.map +1 -1
- package/dist/plugin/paths.js +15 -1
- package/dist/plugin/paths.js.map +1 -1
- package/dist/plugin/queryEndpoint.js +113 -0
- package/dist/plugin/queryEndpoint.js.map +1 -0
- package/dist/plugin/readContextForRequest.js +71 -0
- package/dist/plugin/readContextForRequest.js.map +1 -0
- package/dist/plugin/realtimeEndpoint.js +6 -3
- package/dist/plugin/realtimeEndpoint.js.map +1 -1
- package/dist/plugin/runtime.d.ts +1 -0
- package/dist/plugin/runtime.js +31 -1
- package/dist/plugin/runtime.js.map +1 -1
- package/dist/plugin/scopeFieldBoot.js +22 -0
- package/dist/plugin/scopeFieldBoot.js.map +1 -0
- package/dist/plugin/sourcesEndpoint.js +13 -39
- package/dist/plugin/sourcesEndpoint.js.map +1 -1
- package/dist/plugin/warmTask.js +0 -0
- package/dist/plugin/warmTask.js.map +1 -1
- package/dist/providers/collection.js +71 -25
- package/dist/providers/collection.js.map +1 -1
- package/dist/providers/factory.js +8 -2
- package/dist/providers/factory.js.map +1 -1
- package/dist/providers/resolver.js.map +1 -1
- package/dist/query/dates.js +64 -0
- package/dist/query/dates.js.map +1 -0
- package/dist/query/errors.d.ts +17 -0
- package/dist/query/errors.js +10 -0
- package/dist/query/errors.js.map +1 -0
- package/dist/query/fetchQuery.d.ts +59 -0
- package/dist/query/fetchQuery.js +110 -0
- package/dist/query/fetchQuery.js.map +1 -0
- package/dist/query/parse.d.ts +22 -0
- package/dist/query/parse.js +168 -0
- package/dist/query/parse.js.map +1 -0
- package/dist/query/response.d.ts +36 -0
- package/dist/react/AnalyticsProvider.d.ts +43 -0
- package/dist/react/AnalyticsProvider.js +66 -0
- package/dist/react/AnalyticsProvider.js.map +1 -0
- package/dist/react/TrackerBoot.d.ts +22 -0
- package/dist/react/TrackerBoot.js +30 -0
- package/dist/react/TrackerBoot.js.map +1 -0
- package/dist/react/useAnalytics.d.ts +17 -0
- package/dist/react/useAnalytics.js +36 -0
- package/dist/react/useAnalytics.js.map +1 -0
- package/dist/rsc/AnalyticsScripts.d.ts +30 -0
- package/dist/rsc/AnalyticsScripts.js +41 -0
- package/dist/rsc/AnalyticsScripts.js.map +1 -0
- package/dist/surfacing/cacheStore.d.ts +1 -0
- package/dist/surfacing/cacheStore.js +18 -2
- package/dist/surfacing/cacheStore.js.map +1 -1
- package/dist/surfacing/engine.d.ts +1 -0
- package/dist/surfacing/engine.js +44 -4
- package/dist/surfacing/engine.js.map +1 -1
- package/dist/surfacing/queue.js +22 -6
- package/dist/surfacing/queue.js.map +1 -1
- package/dist/surfacing/rateLimiter.js +130 -0
- package/dist/surfacing/rateLimiter.js.map +1 -0
- package/dist/surfacing/retryPolicy.js +15 -0
- package/dist/surfacing/retryPolicy.js.map +1 -0
- package/dist/sync/syncTask.js +60 -33
- package/dist/sync/syncTask.js.map +1 -1
- package/dist/testing/memoryAdapter.d.ts +2 -0
- package/dist/testing/memoryAdapter.js +10 -0
- package/dist/testing/memoryAdapter.js.map +1 -1
- package/dist/timeframe/tz.js +17 -6
- package/dist/timeframe/tz.js.map +1 -1
- package/dist/tracker/autoCapture.d.ts +48 -0
- package/dist/tracker/autoCapture.js +129 -0
- package/dist/tracker/autoCapture.js.map +1 -0
- package/dist/tracker/consent.d.ts +24 -0
- package/dist/tracker/consent.js +48 -0
- package/dist/tracker/consent.js.map +1 -0
- package/dist/tracker/createTracker.d.ts +18 -0
- package/dist/tracker/createTracker.js +163 -0
- package/dist/tracker/createTracker.js.map +1 -0
- package/dist/tracker/initTracker.d.ts +22 -0
- package/dist/tracker/initTracker.js +33 -0
- package/dist/tracker/initTracker.js.map +1 -0
- package/dist/tracker/loadScript.d.ts +14 -0
- package/dist/tracker/loadScript.js +41 -0
- package/dist/tracker/loadScript.js.map +1 -0
- package/dist/tracker/pageTracking.d.ts +17 -0
- package/dist/tracker/pageTracking.js +38 -0
- package/dist/tracker/pageTracking.js.map +1 -0
- package/dist/tracker/registry.d.ts +27 -0
- package/dist/tracker/registry.js +73 -0
- package/dist/tracker/registry.js.map +1 -0
- package/dist/tracker/sinks/native.d.ts +22 -0
- package/dist/tracker/sinks/native.js +56 -0
- package/dist/tracker/sinks/native.js.map +1 -0
- package/dist/tracker/sinks/plausible.d.ts +14 -0
- package/dist/tracker/sinks/plausible.js +25 -0
- package/dist/tracker/sinks/plausible.js.map +1 -0
- package/dist/tracker/sinks/posthog.d.ts +14 -0
- package/dist/tracker/sinks/posthog.js +18 -0
- package/dist/tracker/sinks/posthog.js.map +1 -0
- package/dist/tracker/sinks/umami.d.ts +13 -0
- package/dist/tracker/sinks/umami.js +17 -0
- package/dist/tracker/sinks/umami.js.map +1 -0
- package/dist/tracker/sinks/vendor.d.ts +14 -0
- package/dist/tracker/sinks/vendor.js +66 -0
- package/dist/tracker/sinks/vendor.js.map +1 -0
- package/dist/tracker/transport.js +28 -0
- package/dist/tracker/transport.js.map +1 -0
- package/dist/tracker/types.d.ts +66 -0
- package/dist/translations/ar.js +104 -1
- package/dist/translations/ar.js.map +1 -1
- package/dist/translations/de.js +104 -1
- package/dist/translations/de.js.map +1 -1
- package/dist/translations/en.js +104 -1
- package/dist/translations/en.js.map +1 -1
- package/dist/translations/es.js +104 -1
- package/dist/translations/es.js.map +1 -1
- package/dist/translations/fr.js +104 -1
- package/dist/translations/fr.js.map +1 -1
- package/dist/translations/id.js +104 -1
- package/dist/translations/id.js.map +1 -1
- package/dist/translations/keys.d.ts +103 -0
- package/dist/translations/keys.js +104 -1
- package/dist/translations/keys.js.map +1 -1
- package/dist/translations/ko.js +104 -1
- package/dist/translations/ko.js.map +1 -1
- package/dist/translations/metricKeys.js +1 -1
- package/dist/translations/metricKeys.js.map +1 -1
- package/dist/translations/pt.js +104 -1
- package/dist/translations/pt.js.map +1 -1
- package/dist/translations/ru.js +104 -1
- package/dist/translations/ru.js.map +1 -1
- package/dist/translations/uk.js +104 -1
- package/dist/translations/uk.js.map +1 -1
- package/dist/translations/zh.js +104 -1
- package/dist/translations/zh.js.map +1 -1
- package/dist/view/AnalyticsNavLink.d.ts +19 -0
- package/dist/view/AnalyticsNavLink.js +40 -0
- package/dist/view/AnalyticsNavLink.js.map +1 -0
- package/dist/view/AnalyticsView.d.ts +23 -0
- package/dist/view/AnalyticsView.js +45 -0
- package/dist/view/AnalyticsView.js.map +1 -0
- package/dist/view/AnalyticsViewClient.d.ts +15 -0
- package/dist/view/AnalyticsViewClient.js +189 -0
- package/dist/view/AnalyticsViewClient.js.map +1 -0
- package/dist/view/authRedirect.js +32 -0
- package/dist/view/authRedirect.js.map +1 -0
- package/dist/view/conversionRate.js +18 -0
- package/dist/view/conversionRate.js.map +1 -0
- package/dist/view/dayRange.js +68 -0
- package/dist/view/dayRange.js.map +1 -0
- package/dist/view/gating.d.ts +1 -0
- package/dist/view/gating.js +105 -0
- package/dist/view/gating.js.map +1 -0
- package/dist/view/labels.js +44 -0
- package/dist/view/labels.js.map +1 -0
- package/dist/view/registerView.js +48 -0
- package/dist/view/registerView.js.map +1 -0
- package/dist/view/sections/Breakdowns.js +157 -0
- package/dist/view/sections/Breakdowns.js.map +1 -0
- package/dist/view/sections/EmptyStates.js +92 -0
- package/dist/view/sections/EmptyStates.js.map +1 -0
- package/dist/view/sections/FilterChips.js +41 -0
- package/dist/view/sections/FilterChips.js.map +1 -0
- package/dist/view/sections/GoalsPanel.js +81 -0
- package/dist/view/sections/GoalsPanel.js.map +1 -0
- package/dist/view/sections/OverviewCards.js +65 -0
- package/dist/view/sections/OverviewCards.js.map +1 -0
- package/dist/view/sections/RealtimeStrip.js +77 -0
- package/dist/view/sections/RealtimeStrip.js.map +1 -0
- package/dist/view/sections/Toolbar.js +179 -0
- package/dist/view/sections/Toolbar.js.map +1 -0
- package/dist/view/sections/Trend.js +119 -0
- package/dist/view/sections/Trend.js.map +1 -0
- package/dist/view/sections/styles.js +74 -0
- package/dist/view/sections/styles.js.map +1 -0
- package/dist/view/state.js +206 -0
- package/dist/view/state.js.map +1 -0
- package/dist/view/useViewQueries.js +150 -0
- package/dist/view/useViewQueries.js.map +1 -0
- package/dist/view/viewProps.d.ts +40 -0
- package/dist/view/viewProps.js +90 -0
- package/dist/view/viewProps.js.map +1 -0
- package/dist/widgets/AnalyticsBreakdownWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsBreakdownWidget.js +22 -4
- package/dist/widgets/AnalyticsBreakdownWidget.js.map +1 -1
- package/dist/widgets/AnalyticsGoalsWidget.d.ts +14 -0
- package/dist/widgets/AnalyticsGoalsWidget.js +188 -0
- package/dist/widgets/AnalyticsGoalsWidget.js.map +1 -0
- package/dist/widgets/AnalyticsMetricWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsMetricWidget.js +35 -12
- package/dist/widgets/AnalyticsMetricWidget.js.map +1 -1
- package/dist/widgets/AnalyticsRealtimeWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsRealtimeWidget.js +42 -22
- package/dist/widgets/AnalyticsRealtimeWidget.js.map +1 -1
- package/dist/widgets/AnalyticsTrendWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsTrendWidget.js +51 -15
- package/dist/widgets/AnalyticsTrendWidget.js.map +1 -1
- package/dist/widgets/WidgetViewLink.js +17 -0
- package/dist/widgets/WidgetViewLink.js.map +1 -0
- package/dist/widgets/breakdownTypes.js +32 -0
- package/dist/widgets/breakdownTypes.js.map +1 -1
- package/dist/widgets/cardChrome.js +31 -7
- package/dist/widgets/cardChrome.js.map +1 -1
- package/dist/widgets/range.js +43 -12
- package/dist/widgets/range.js.map +1 -1
- package/dist/widgets/readForWidget.d.ts +12 -0
- package/dist/widgets/readForWidget.js +30 -19
- package/dist/widgets/readForWidget.js.map +1 -1
- package/dist/widgets/readForWidgetBreakdown.d.ts +15 -0
- package/dist/widgets/readForWidgetBreakdown.js +32 -20
- package/dist/widgets/readForWidgetBreakdown.js.map +1 -1
- package/dist/widgets/readForWidgetGoals.d.ts +57 -0
- package/dist/widgets/readForWidgetGoals.js +126 -0
- package/dist/widgets/readForWidgetGoals.js.map +1 -0
- package/dist/widgets/readForWidgetRealtime.js +1 -1
- package/dist/widgets/readForWidgetSeries.d.ts +13 -0
- package/dist/widgets/readForWidgetSeries.js +56 -28
- package/dist/widgets/readForWidgetSeries.js.map +1 -1
- package/dist/widgets/registerWidgets.js +58 -9
- package/dist/widgets/registerWidgets.js.map +1 -1
- package/dist/widgets/types.js +16 -2
- package/dist/widgets/types.js.map +1 -1
- package/dist/widgets/viewLink.d.ts +22 -0
- package/dist/widgets/viewLink.js +83 -0
- package/dist/widgets/viewLink.js.map +1 -0
- package/package.json +25 -5
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import { keys } from "../translations/keys.js";
|
|
2
2
|
import { labelForKey } from "../translations/server.js";
|
|
3
|
-
import { satisfiesCapabilities } from "../core/capabilities.js";
|
|
4
3
|
import { TIMEFRAME_PRESETS } from "../timeframe/presets.js";
|
|
5
4
|
import { METRIC_KEYS, TIMEFRAME_KEYS } from "../translations/metricKeys.js";
|
|
5
|
+
import { satisfiesCapabilities } from "../core/capabilities.js";
|
|
6
6
|
import { de } from "../translations/de.js";
|
|
7
7
|
import { en } from "../translations/en.js";
|
|
8
8
|
import { BREAKDOWN_SPECS } from "./breakdownTypes.js";
|
|
9
|
-
import { WIDGET_METRICS } from "./types.js";
|
|
9
|
+
import { GOAL_ROW_LIMITS, WIDGET_METRICS } from "./types.js";
|
|
10
10
|
import { dateRangeField } from "../fields/dateRange/field.js";
|
|
11
11
|
import { buildCustomWidgets } from "./customWidget.js";
|
|
12
12
|
//#region src/widgets/registerWidgets.ts
|
|
@@ -29,7 +29,10 @@ const widgetIsSupported = (requires, adapters) => !requires || adapters.some((a)
|
|
|
29
29
|
* `dataSource`'s capabilities; an id not known at config time (a runtime/DB provider)
|
|
30
30
|
* keeps the union. The default clamps to the first option when the preferred metric is
|
|
31
31
|
* not servable, and options can come out empty for exotic adapter sets, which
|
|
32
|
-
* {@link registerWidgets} treats as "skip this widget".
|
|
32
|
+
* {@link registerWidgets} treats as "skip this widget". When `providersEnabled`, the
|
|
33
|
+
* config-adapter filter is skipped entirely: a tenant's own runtime adapter may serve
|
|
34
|
+
* metrics no config adapter does, so every candidate is offered and `filterOptions` alone
|
|
35
|
+
* narrows once a `dataSource` is picked.
|
|
33
36
|
*/
|
|
34
37
|
const metricSelectField = (candidates, args, opts = {}) => {
|
|
35
38
|
const { extra, preferredDefault = "pageviews" } = opts;
|
|
@@ -37,7 +40,7 @@ const metricSelectField = (candidates, args, opts = {}) => {
|
|
|
37
40
|
...extra,
|
|
38
41
|
metrics: [metric]
|
|
39
42
|
});
|
|
40
|
-
const options = candidates.filter((m) => args.adapters.some((a) => supports(a, m))).map((m) => ({
|
|
43
|
+
const options = (args.providersEnabled ? candidates : candidates.filter((m) => args.adapters.some((a) => supports(a, m)))).map((m) => ({
|
|
41
44
|
value: m,
|
|
42
45
|
label: staticLabel(METRIC_KEYS[m])
|
|
43
46
|
}));
|
|
@@ -87,6 +90,13 @@ const timeframeSelectField = () => ({
|
|
|
87
90
|
label: labelForKey(keys.widgetTimeframeCustom)
|
|
88
91
|
}]
|
|
89
92
|
});
|
|
93
|
+
/** Reads the previous period too: the trend overlays it, the goals table deltas against it. */
|
|
94
|
+
const compareField = () => ({
|
|
95
|
+
name: "compare",
|
|
96
|
+
type: "checkbox",
|
|
97
|
+
defaultValue: false,
|
|
98
|
+
label: labelForKey(keys.widgetFieldCompare)
|
|
99
|
+
});
|
|
90
100
|
const dataSourceField = (args) => ({
|
|
91
101
|
name: "dataSource",
|
|
92
102
|
type: "select",
|
|
@@ -116,16 +126,20 @@ const customRangeField = () => dateRangeField({
|
|
|
116
126
|
});
|
|
117
127
|
/** The metric select in a widget's field list. */
|
|
118
128
|
const findMetricField = (fields) => fields.find((field) => "name" in field && field.name === "metric");
|
|
119
|
-
const metricWidgetFields = (args) => [
|
|
129
|
+
const metricWidgetFields = (args, extra = []) => [
|
|
120
130
|
titleField(args, en[keys.widgetFieldTitlePlaceholder]),
|
|
121
131
|
metricSelectField(WIDGET_METRICS, args),
|
|
122
132
|
timeframeSelectField(),
|
|
123
133
|
customRangeField(),
|
|
134
|
+
...extra,
|
|
124
135
|
...args.multiProvider ? [dataSourceField(args)] : []
|
|
125
136
|
];
|
|
126
137
|
const breakdownWidgetFields = (args, spec) => [
|
|
127
138
|
titleField(args, en[spec.label]),
|
|
128
|
-
metricSelectField(WIDGET_METRICS, args, {
|
|
139
|
+
metricSelectField(WIDGET_METRICS, args, {
|
|
140
|
+
extra: { dimensions: [spec.dimension] },
|
|
141
|
+
...spec.preferredDefault ? { preferredDefault: spec.preferredDefault } : {}
|
|
142
|
+
}),
|
|
129
143
|
timeframeSelectField(),
|
|
130
144
|
customRangeField(),
|
|
131
145
|
{
|
|
@@ -138,6 +152,26 @@ const breakdownWidgetFields = (args, spec) => [
|
|
|
138
152
|
},
|
|
139
153
|
...args.multiProvider ? [dataSourceField(args)] : []
|
|
140
154
|
];
|
|
155
|
+
/** A select, not the breakdown's free number: the goals table is a summary, not a report. */
|
|
156
|
+
const goalLimitField = () => ({
|
|
157
|
+
name: "limit",
|
|
158
|
+
type: "select",
|
|
159
|
+
defaultValue: String(GOAL_ROW_LIMITS[0]),
|
|
160
|
+
label: labelForKey(keys.widgetFieldLimit),
|
|
161
|
+
admin: { isClearable: false },
|
|
162
|
+
options: GOAL_ROW_LIMITS.map((limit) => ({
|
|
163
|
+
value: String(limit),
|
|
164
|
+
label: String(limit)
|
|
165
|
+
}))
|
|
166
|
+
});
|
|
167
|
+
const goalsWidgetFields = (args) => [
|
|
168
|
+
titleField(args, en[keys.widgetGoals]),
|
|
169
|
+
timeframeSelectField(),
|
|
170
|
+
customRangeField(),
|
|
171
|
+
goalLimitField(),
|
|
172
|
+
...args.comparison === false ? [] : [compareField()],
|
|
173
|
+
...args.multiProvider ? [dataSourceField(args)] : []
|
|
174
|
+
];
|
|
141
175
|
const realtimeWidgetFields = (args) => [
|
|
142
176
|
titleField(args, en[keys.widgetFieldTitlePlaceholder]),
|
|
143
177
|
metricSelectField(["visitors", "pageviews"], args, {
|
|
@@ -187,7 +221,7 @@ const WIDGET_DEFS = [
|
|
|
187
221
|
requires: { metrics: ["pageviews"] },
|
|
188
222
|
minWidth: "small",
|
|
189
223
|
maxWidth: "full",
|
|
190
|
-
fields: metricWidgetFields
|
|
224
|
+
fields: (args) => metricWidgetFields(args, args.comparison === false ? [] : [compareField()])
|
|
191
225
|
},
|
|
192
226
|
{
|
|
193
227
|
slug: "analytics-realtime",
|
|
@@ -198,6 +232,18 @@ const WIDGET_DEFS = [
|
|
|
198
232
|
maxWidth: "medium",
|
|
199
233
|
fields: realtimeWidgetFields
|
|
200
234
|
},
|
|
235
|
+
{
|
|
236
|
+
slug: "analytics-goals",
|
|
237
|
+
component: "@10x-media/analytics/rsc#AnalyticsGoalsWidget",
|
|
238
|
+
label: keys.widgetGoals,
|
|
239
|
+
requires: {
|
|
240
|
+
metrics: ["conversions"],
|
|
241
|
+
dimensions: ["goal"]
|
|
242
|
+
},
|
|
243
|
+
minWidth: "small",
|
|
244
|
+
maxWidth: "large",
|
|
245
|
+
fields: goalsWidgetFields
|
|
246
|
+
},
|
|
201
247
|
...BREAKDOWN_SPECS.map((spec) => ({
|
|
202
248
|
slug: spec.slug,
|
|
203
249
|
component: "@10x-media/analytics/rsc#AnalyticsBreakdownWidget",
|
|
@@ -212,13 +258,16 @@ const registerWidgets = (config, args) => {
|
|
|
212
258
|
const built = [];
|
|
213
259
|
for (const def of WIDGET_DEFS) {
|
|
214
260
|
if (args.disabled.includes(def.slug)) continue;
|
|
215
|
-
if (!widgetIsSupported(def.requires, args.adapters)) continue;
|
|
261
|
+
if (!args.providersEnabled && !widgetIsSupported(def.requires, args.adapters)) continue;
|
|
216
262
|
const fields = def.fields(args);
|
|
217
263
|
const metricField = findMetricField(fields);
|
|
218
264
|
if (metricField && "options" in metricField && metricField.options.length === 0) continue;
|
|
219
265
|
built.push({
|
|
220
266
|
slug: def.slug,
|
|
221
|
-
Component:
|
|
267
|
+
Component: {
|
|
268
|
+
path: def.component,
|
|
269
|
+
serverProps: { view: args.view ?? false }
|
|
270
|
+
},
|
|
222
271
|
label: labelForKey(def.label),
|
|
223
272
|
fields,
|
|
224
273
|
minWidth: def.minWidth,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"registerWidgets.js","names":[],"sources":["../../src/widgets/registerWidgets.ts"],"sourcesContent":["import type {\n\tConfig,\n\tField,\n\tSelectField,\n\tSelectFieldSingleValidation,\n\tWidget,\n\tWidgetWidth,\n} from 'payload'\nimport { type CapabilityRequirement, satisfiesCapabilities } from '../core/capabilities'\nimport type { AnalyticsAdapter, MetricKey } from '../core/contract'\nimport { dateRangeField } from '../fields/dateRange/field'\nimport { TIMEFRAME_PRESETS } from '../timeframe/presets'\nimport { de } from '../translations/de'\nimport { en } from '../translations/en'\nimport type { TranslationKey } from '../translations/keys'\nimport { keys } from '../translations/keys'\nimport { METRIC_KEYS, TIMEFRAME_KEYS } from '../translations/metricKeys'\nimport { labelForKey } from '../translations/server'\nimport { BREAKDOWN_SPECS, type BreakdownSpec } from './breakdownTypes'\nimport { buildCustomWidgets, type CustomWidgetDef } from './customWidget'\nimport { WIDGET_METRICS } from './types'\n\n/**\n * Select options must carry static labels: `filterOptions` results are serialized\n * into client form state at request time, where a label function cannot cross the\n * server/client boundary.\n */\nconst staticLabel = (key: TranslationKey): Record<string, string> => ({\n\tde: de[key],\n\ten: en[key],\n})\n\nexport interface RegisterWidgetsArgs {\n\tadapters: AnalyticsAdapter[]\n\tmultiProvider: boolean\n\tdisabled: string[]\n\tregister: CustomWidgetDef[]\n\tlocalizeText?: boolean\n\t/** The plugin's configured defaultAdapter, when set; falls back to the first adapter. */\n\tdefaultId?: string\n}\n\ninterface WidgetDef {\n\tslug: string\n\tcomponent: string\n\tlabel: TranslationKey\n\trequires?: CapabilityRequirement\n\tminWidth?: WidgetWidth\n\tmaxWidth?: WidgetWidth\n\tfields: (args: RegisterWidgetsArgs) => Field[]\n}\n\nexport const widgetIsSupported = (\n\trequires: CapabilityRequirement | undefined,\n\tadapters: AnalyticsAdapter[]\n): boolean => !requires || adapters.some((a) => satisfiesCapabilities(a.capabilities, requires))\n\n/**\n * The widget metric select. Options are limited to metrics at least one configured\n * adapter can serve, mirroring the OR-across-adapters gating used to hide whole widgets;\n * `extra` layers on further requirements (a breakdown widget's dimension, realtime) so\n * the picker never offers a metric the read path would report as unavailable. In\n * multi-provider installs `filterOptions` additionally narrows the picker to the selected\n * `dataSource`'s capabilities; an id not known at config time (a runtime/DB provider)\n * keeps the union. The default clamps to the first option when the preferred metric is\n * not servable, and options can come out empty for exotic adapter sets, which\n * {@link registerWidgets} treats as \"skip this widget\".\n */\nconst metricSelectField = (\n\tcandidates: MetricKey[],\n\targs: RegisterWidgetsArgs,\n\topts: {\n\t\textra?: Omit<CapabilityRequirement, 'metrics'>\n\t\tpreferredDefault?: MetricKey\n\t} = {}\n): Field => {\n\tconst { extra, preferredDefault = 'pageviews' } = opts\n\tconst supports = (adapter: AnalyticsAdapter, metric: MetricKey): boolean =>\n\t\tsatisfiesCapabilities(adapter.capabilities, { ...extra, metrics: [metric] })\n\tconst options = candidates\n\t\t.filter((m) => args.adapters.some((a) => supports(a, m)))\n\t\t.map((m) => ({ value: m, label: staticLabel(METRIC_KEYS[m]) }))\n\tconst defaultValue = options.some((o) => o.value === preferredDefault)\n\t\t? preferredDefault\n\t\t: options[0]?.value\n\tconst filterOptions: SelectField['filterOptions'] = ({ options: opts, siblingData }) => {\n\t\tconst sourceId = (siblingData as { dataSource?: unknown } | undefined)?.dataSource\n\t\tconst adapter =\n\t\t\ttypeof sourceId === 'string' ? args.adapters.find((a) => a.id === sourceId) : undefined\n\t\tif (!adapter) {\n\t\t\treturn opts\n\t\t}\n\t\treturn opts.filter((o) => typeof o === 'object' && supports(adapter, o.value as MetricKey))\n\t}\n\treturn {\n\t\tname: 'metric',\n\t\ttype: 'select',\n\t\trequired: true,\n\t\t...(defaultValue !== undefined ? { defaultValue } : {}),\n\t\tlabel: labelForKey(keys.widgetFieldMetric),\n\t\toptions,\n\t\tadmin: {\n\t\t\t// A required metric has no meaningful cleared state.\n\t\t\tisClearable: false,\n\t\t\tcomponents: {\n\t\t\t\tField: {\n\t\t\t\t\tpath: '@10x-media/analytics/client#MetricSelectField',\n\t\t\t\t\t...(extra ? { clientProps: { requires: extra } } : {}),\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t...(args.multiProvider ? { filterOptions } : {}),\n\t}\n}\n\nconst titleField = (args: RegisterWidgetsArgs, placeholder: string): Field => ({\n\tname: 'title',\n\ttype: 'text',\n\tlabel: labelForKey(keys.widgetFieldTitle),\n\t...(args.localizeText ? { localized: true } : {}),\n\tadmin: { placeholder },\n})\n\nconst timeframeSelectField = (): Field => ({\n\tname: 'timeframe',\n\ttype: 'select',\n\trequired: true,\n\tdefaultValue: 'last30days',\n\tlabel: labelForKey(keys.widgetFieldTimeframe),\n\tadmin: { isClearable: false },\n\toptions: [\n\t\t...TIMEFRAME_PRESETS.map((p) => ({ value: p, label: labelForKey(TIMEFRAME_KEYS[p]) })),\n\t\t{ value: 'custom', label: labelForKey(keys.widgetTimeframeCustom) },\n\t],\n})\n\nconst dataSourceField = (args: RegisterWidgetsArgs): Field => ({\n\tname: 'dataSource',\n\ttype: 'select',\n\tlabel: labelForKey(keys.widgetFieldDataSource),\n\tdefaultValue: args.defaultId ?? args.adapters[0]?.id,\n\tadmin: {\n\t\t// Clearing would leave no source; the widget always reads through one.\n\t\tisClearable: false,\n\t\tcomponents: { Field: { path: '@10x-media/analytics/client#SourceSelectField' } },\n\t},\n\toptions: args.adapters.map((a) => ({ value: a.id, label: a.label })),\n\t// Payload's select validator rejects any value absent from `options`, but runtime\n\t// (DB-registered) provider ids are only known per request, not at config time.\n\tvalidate: ((value) =>\n\t\tvalue === undefined || value === null || (typeof value === 'string' && value.length > 0)\n\t\t\t? true\n\t\t\t: 'invalid data source') as SelectFieldSingleValidation,\n})\n\nconst customRangeField = (): Field =>\n\tdateRangeField({\n\t\tname: 'range',\n\t\tlabel: labelForKey(keys.widgetFieldRange),\n\t\tpickerAppearance: 'dayOnly',\n\t\toverrides: (f) => ({\n\t\t\t...f,\n\t\t\tadmin: {\n\t\t\t\t...f.admin,\n\t\t\t\tcondition: (_data, siblingData) => siblingData?.timeframe === 'custom',\n\t\t\t},\n\t\t}),\n\t})\n\n/** The metric select in a widget's field list. */\nexport const findMetricField = (fields: Field[]): Field | undefined =>\n\tfields.find((field) => 'name' in field && field.name === 'metric')\n\nconst metricWidgetFields = (args: RegisterWidgetsArgs): Field[] => [\n\ttitleField(args, en[keys.widgetFieldTitlePlaceholder]),\n\tmetricSelectField(WIDGET_METRICS, args),\n\ttimeframeSelectField(),\n\tcustomRangeField(),\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\nconst breakdownWidgetFields = (args: RegisterWidgetsArgs, spec: BreakdownSpec): Field[] => [\n\ttitleField(args, en[spec.label]),\n\tmetricSelectField(WIDGET_METRICS, args, { extra: { dimensions: [spec.dimension] } }),\n\ttimeframeSelectField(),\n\tcustomRangeField(),\n\t{\n\t\tname: 'limit',\n\t\ttype: 'number',\n\t\tdefaultValue: 5,\n\t\tmin: 1,\n\t\tmax: 20,\n\t\tlabel: labelForKey(keys.widgetFieldLimit),\n\t},\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\nconst realtimeWidgetFields = (args: RegisterWidgetsArgs): Field[] => [\n\ttitleField(args, en[keys.widgetFieldTitlePlaceholder]),\n\tmetricSelectField(['visitors', 'pageviews'], args, {\n\t\textra: { realtime: true },\n\t\tpreferredDefault: 'visitors',\n\t}),\n\t{\n\t\tname: 'windowMinutes',\n\t\ttype: 'select',\n\t\tdefaultValue: '30',\n\t\tlabel: labelForKey(keys.widgetFieldWindow),\n\t\tadmin: { isClearable: false },\n\t\toptions: [\n\t\t\t{ value: '5', label: '5 min' },\n\t\t\t{ value: '15', label: '15 min' },\n\t\t\t{ value: '30', label: '30 min' },\n\t\t\t{ value: '60', label: '60 min' },\n\t\t],\n\t},\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\nconst WIDGET_DEFS: WidgetDef[] = [\n\t{\n\t\tslug: 'analytics-metric',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsMetricWidget',\n\t\tlabel: keys.widgetMetricLabel,\n\t\tminWidth: 'x-small',\n\t\tmaxWidth: 'medium',\n\t\tfields: metricWidgetFields,\n\t},\n\t{\n\t\tslug: 'analytics-trend',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsTrendWidget',\n\t\tlabel: keys.widgetTrendLabel,\n\t\trequires: { metrics: ['pageviews'] },\n\t\tminWidth: 'small',\n\t\tmaxWidth: 'full',\n\t\tfields: metricWidgetFields,\n\t},\n\t{\n\t\tslug: 'analytics-realtime',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsRealtimeWidget',\n\t\tlabel: keys.widgetRealtimeLabel,\n\t\trequires: { realtime: true },\n\t\tminWidth: 'small' as WidgetWidth,\n\t\tmaxWidth: 'medium' as WidgetWidth,\n\t\tfields: realtimeWidgetFields,\n\t},\n\t...BREAKDOWN_SPECS.map(\n\t\t(spec): WidgetDef => ({\n\t\t\tslug: spec.slug,\n\t\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsBreakdownWidget',\n\t\t\tlabel: spec.label,\n\t\t\trequires: { dimensions: [spec.dimension] },\n\t\t\tminWidth: 'small' as WidgetWidth,\n\t\t\tmaxWidth: 'large' as WidgetWidth,\n\t\t\tfields: (args) => breakdownWidgetFields(args, spec),\n\t\t})\n\t),\n]\n\nexport const registerWidgets = (config: Config, args: RegisterWidgetsArgs): void => {\n\tconst built: Widget[] = []\n\tfor (const def of WIDGET_DEFS) {\n\t\tif (args.disabled.includes(def.slug)) {\n\t\t\tcontinue\n\t\t}\n\t\tif (!widgetIsSupported(def.requires, args.adapters)) {\n\t\t\tcontinue\n\t\t}\n\t\tconst fields = def.fields(args)\n\t\t// A required metric select with no servable option would make the widget\n\t\t// impossible to configure; skip it like an unsupported widget.\n\t\tconst metricField = findMetricField(fields)\n\t\tif (metricField && 'options' in metricField && metricField.options.length === 0) {\n\t\t\tcontinue\n\t\t}\n\t\tbuilt.push({\n\t\t\tslug: def.slug,\n\t\t\tComponent: def.component,\n\t\t\tlabel: labelForKey(def.label),\n\t\t\tfields,\n\t\t\tminWidth: def.minWidth,\n\t\t\tmaxWidth: def.maxWidth,\n\t\t})\n\t}\n\tbuilt.push(...buildCustomWidgets(args.register, args.adapters, args.disabled))\n\tif (!built.length) {\n\t\treturn\n\t}\n\tconfig.admin ??= {}\n\tconfig.admin.dashboard ??= { widgets: [] }\n\tconfig.admin.dashboard.widgets ??= []\n\tconfig.admin.dashboard.widgets.push(...built)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AA2BA,MAAM,eAAe,SAAiD;CACrE,IAAI,GAAG;CACP,IAAI,GAAG;AACR;AAsBA,MAAa,qBACZ,UACA,aACa,CAAC,YAAY,SAAS,MAAM,MAAM,sBAAsB,EAAE,cAAc,QAAQ,CAAC;;;;;;;;;;;;AAa/F,MAAM,qBACL,YACA,MACA,OAGI,CAAC,MACM;CACX,MAAM,EAAE,OAAO,mBAAmB,gBAAgB;CAClD,MAAM,YAAY,SAA2B,WAC5C,sBAAsB,QAAQ,cAAc;EAAE,GAAG;EAAO,SAAS,CAAC,MAAM;CAAE,CAAC;CAC5E,MAAM,UAAU,WACd,QAAQ,MAAM,KAAK,SAAS,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,CAAC,EACvD,KAAK,OAAO;EAAE,OAAO;EAAG,OAAO,YAAY,YAAY,EAAE;CAAE,EAAE;CAC/D,MAAM,eAAe,QAAQ,MAAM,MAAM,EAAE,UAAU,gBAAgB,IAClE,mBACA,QAAQ,IAAI;CACf,MAAM,iBAA+C,EAAE,SAAS,MAAM,kBAAkB;EACvF,MAAM,WAAY,aAAsD;EACxE,MAAM,UACL,OAAO,aAAa,WAAW,KAAK,SAAS,MAAM,MAAM,EAAE,OAAO,QAAQ,IAAI,KAAA;EAC/E,IAAI,CAAC,SACJ,OAAO;EAER,OAAO,KAAK,QAAQ,MAAM,OAAO,MAAM,YAAY,SAAS,SAAS,EAAE,KAAkB,CAAC;CAC3F;CACA,OAAO;EACN,MAAM;EACN,MAAM;EACN,UAAU;EACV,GAAI,iBAAiB,KAAA,IAAY,EAAE,aAAa,IAAI,CAAC;EACrD,OAAO,YAAY,KAAK,iBAAiB;EACzC;EACA,OAAO;GAEN,aAAa;GACb,YAAY,EACX,OAAO;IACN,MAAM;IACN,GAAI,QAAQ,EAAE,aAAa,EAAE,UAAU,MAAM,EAAE,IAAI,CAAC;GACrD,EACD;EACD;EACA,GAAI,KAAK,gBAAgB,EAAE,cAAc,IAAI,CAAC;CAC/C;AACD;AAEA,MAAM,cAAc,MAA2B,iBAAgC;CAC9E,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,gBAAgB;CACxC,GAAI,KAAK,eAAe,EAAE,WAAW,KAAK,IAAI,CAAC;CAC/C,OAAO,EAAE,YAAY;AACtB;AAEA,MAAM,8BAAqC;CAC1C,MAAM;CACN,MAAM;CACN,UAAU;CACV,cAAc;CACd,OAAO,YAAY,KAAK,oBAAoB;CAC5C,OAAO,EAAE,aAAa,MAAM;CAC5B,SAAS,CACR,GAAG,kBAAkB,KAAK,OAAO;EAAE,OAAO;EAAG,OAAO,YAAY,eAAe,EAAE;CAAE,EAAE,GACrF;EAAE,OAAO;EAAU,OAAO,YAAY,KAAK,qBAAqB;CAAE,CACnE;AACD;AAEA,MAAM,mBAAmB,UAAsC;CAC9D,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,qBAAqB;CAC7C,cAAc,KAAK,aAAa,KAAK,SAAS,IAAI;CAClD,OAAO;EAEN,aAAa;EACb,YAAY,EAAE,OAAO,EAAE,MAAM,gDAAgD,EAAE;CAChF;CACA,SAAS,KAAK,SAAS,KAAK,OAAO;EAAE,OAAO,EAAE;EAAI,OAAO,EAAE;CAAM,EAAE;CAGnE,YAAY,UACX,UAAU,KAAA,KAAa,UAAU,QAAS,OAAO,UAAU,YAAY,MAAM,SAAS,IACnF,OACA;AACL;AAEA,MAAM,yBACL,eAAe;CACd,MAAM;CACN,OAAO,YAAY,KAAK,gBAAgB;CACxC,kBAAkB;CAClB,YAAY,OAAO;EAClB,GAAG;EACH,OAAO;GACN,GAAG,EAAE;GACL,YAAY,OAAO,gBAAgB,aAAa,cAAc;EAC/D;CACD;AACD,CAAC;;AAGF,MAAa,mBAAmB,WAC/B,OAAO,MAAM,UAAU,UAAU,SAAS,MAAM,SAAS,QAAQ;AAElE,MAAM,sBAAsB,SAAuC;CAClE,WAAW,MAAM,GAAG,KAAK,4BAA4B;CACrD,kBAAkB,gBAAgB,IAAI;CACtC,qBAAqB;CACrB,iBAAiB;CACjB,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;AAEA,MAAM,yBAAyB,MAA2B,SAAiC;CAC1F,WAAW,MAAM,GAAG,KAAK,MAAM;CAC/B,kBAAkB,gBAAgB,MAAM,EAAE,OAAO,EAAE,YAAY,CAAC,KAAK,SAAS,EAAE,EAAE,CAAC;CACnF,qBAAqB;CACrB,iBAAiB;CACjB;EACC,MAAM;EACN,MAAM;EACN,cAAc;EACd,KAAK;EACL,KAAK;EACL,OAAO,YAAY,KAAK,gBAAgB;CACzC;CACA,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;AAEA,MAAM,wBAAwB,SAAuC;CACpE,WAAW,MAAM,GAAG,KAAK,4BAA4B;CACrD,kBAAkB,CAAC,YAAY,WAAW,GAAG,MAAM;EAClD,OAAO,EAAE,UAAU,KAAK;EACxB,kBAAkB;CACnB,CAAC;CACD;EACC,MAAM;EACN,MAAM;EACN,cAAc;EACd,OAAO,YAAY,KAAK,iBAAiB;EACzC,OAAO,EAAE,aAAa,MAAM;EAC5B,SAAS;GACR;IAAE,OAAO;IAAK,OAAO;GAAQ;GAC7B;IAAE,OAAO;IAAM,OAAO;GAAS;GAC/B;IAAE,OAAO;IAAM,OAAO;GAAS;GAC/B;IAAE,OAAO;IAAM,OAAO;GAAS;EAChC;CACD;CACA,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;AAEA,MAAM,cAA2B;CAChC;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,SAAS,CAAC,WAAW,EAAE;EACnC,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,UAAU,KAAK;EAC3B,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA,GAAG,gBAAgB,KACjB,UAAqB;EACrB,MAAM,KAAK;EACX,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,YAAY,CAAC,KAAK,SAAS,EAAE;EACzC,UAAU;EACV,UAAU;EACV,SAAS,SAAS,sBAAsB,MAAM,IAAI;CACnD,EACD;AACD;AAEA,MAAa,mBAAmB,QAAgB,SAAoC;CACnF,MAAM,QAAkB,CAAC;CACzB,KAAK,MAAM,OAAO,aAAa;EAC9B,IAAI,KAAK,SAAS,SAAS,IAAI,IAAI,GAClC;EAED,IAAI,CAAC,kBAAkB,IAAI,UAAU,KAAK,QAAQ,GACjD;EAED,MAAM,SAAS,IAAI,OAAO,IAAI;EAG9B,MAAM,cAAc,gBAAgB,MAAM;EAC1C,IAAI,eAAe,aAAa,eAAe,YAAY,QAAQ,WAAW,GAC7E;EAED,MAAM,KAAK;GACV,MAAM,IAAI;GACV,WAAW,IAAI;GACf,OAAO,YAAY,IAAI,KAAK;GAC5B;GACA,UAAU,IAAI;GACd,UAAU,IAAI;EACf,CAAC;CACF;CACA,MAAM,KAAK,GAAG,mBAAmB,KAAK,UAAU,KAAK,UAAU,KAAK,QAAQ,CAAC;CAC7E,IAAI,CAAC,MAAM,QACV;CAED,OAAO,UAAU,CAAC;CAClB,OAAO,MAAM,cAAc,EAAE,SAAS,CAAC,EAAE;CACzC,OAAO,MAAM,UAAU,YAAY,CAAC;CACpC,OAAO,MAAM,UAAU,QAAQ,KAAK,GAAG,KAAK;AAC7C"}
|
|
1
|
+
{"version":3,"file":"registerWidgets.js","names":[],"sources":["../../src/widgets/registerWidgets.ts"],"sourcesContent":["import type {\n\tConfig,\n\tField,\n\tSelectField,\n\tSelectFieldSingleValidation,\n\tWidget,\n\tWidgetWidth,\n} from 'payload'\nimport { type CapabilityRequirement, satisfiesCapabilities } from '../core/capabilities'\nimport type { AnalyticsAdapter, MetricKey } from '../core/contract'\nimport { dateRangeField } from '../fields/dateRange/field'\nimport { TIMEFRAME_PRESETS } from '../timeframe/presets'\nimport { de } from '../translations/de'\nimport { en } from '../translations/en'\nimport type { TranslationKey } from '../translations/keys'\nimport { keys } from '../translations/keys'\nimport { METRIC_KEYS, TIMEFRAME_KEYS } from '../translations/metricKeys'\nimport { labelForKey } from '../translations/server'\nimport { BREAKDOWN_SPECS, type BreakdownSpec } from './breakdownTypes'\nimport { buildCustomWidgets, type CustomWidgetDef } from './customWidget'\nimport { GOAL_ROW_LIMITS, WIDGET_METRICS } from './types'\nimport type { WidgetView } from './viewLink'\n\n/**\n * Select options must carry static labels: `filterOptions` results are serialized\n * into client form state at request time, where a label function cannot cross the\n * server/client boundary.\n */\nconst staticLabel = (key: TranslationKey): Record<string, string> => ({\n\tde: de[key],\n\ten: en[key],\n})\n\nexport interface RegisterWidgetsArgs {\n\tadapters: AnalyticsAdapter[]\n\tmultiProvider: boolean\n\t/**\n\t * True when a tenant's own runtime adapter can exist (`providers.collection` or\n\t * `providers.resolve`). Such an adapter's capabilities are unknown at config time, so\n\t * gating on the config-adapter union would impose a false ceiling: widgets and metric\n\t * options open up, and the per-request sources endpoint plus client pickers narrow per\n\t * request instead.\n\t */\n\tprovidersEnabled: boolean\n\tdisabled: string[]\n\tregister: CustomWidgetDef[]\n\tlocalizeText?: boolean\n\t/** The plugin's configured defaultAdapter, when set; falls back to the first adapter. */\n\tdefaultId?: string\n\t/** `widgets.comparison`; false hides every compare checkbox. Defaults to on. */\n\tcomparison?: boolean\n\t/**\n\t * Where the analytics view mounts, so every built-in widget can link into it. False or\n\t * absent means no view to link to, and the widgets render without the footer link.\n\t */\n\tview?: WidgetView\n}\n\ninterface WidgetDef {\n\tslug: string\n\tcomponent: string\n\tlabel: TranslationKey\n\trequires?: CapabilityRequirement\n\tminWidth?: WidgetWidth\n\tmaxWidth?: WidgetWidth\n\tfields: (args: RegisterWidgetsArgs) => Field[]\n}\n\nexport const widgetIsSupported = (\n\trequires: CapabilityRequirement | undefined,\n\tadapters: AnalyticsAdapter[]\n): boolean => !requires || adapters.some((a) => satisfiesCapabilities(a.capabilities, requires))\n\n/**\n * The widget metric select. Options are limited to metrics at least one configured\n * adapter can serve, mirroring the OR-across-adapters gating used to hide whole widgets;\n * `extra` layers on further requirements (a breakdown widget's dimension, realtime) so\n * the picker never offers a metric the read path would report as unavailable. In\n * multi-provider installs `filterOptions` additionally narrows the picker to the selected\n * `dataSource`'s capabilities; an id not known at config time (a runtime/DB provider)\n * keeps the union. The default clamps to the first option when the preferred metric is\n * not servable, and options can come out empty for exotic adapter sets, which\n * {@link registerWidgets} treats as \"skip this widget\". When `providersEnabled`, the\n * config-adapter filter is skipped entirely: a tenant's own runtime adapter may serve\n * metrics no config adapter does, so every candidate is offered and `filterOptions` alone\n * narrows once a `dataSource` is picked.\n */\nconst metricSelectField = (\n\tcandidates: MetricKey[],\n\targs: RegisterWidgetsArgs,\n\topts: {\n\t\textra?: Omit<CapabilityRequirement, 'metrics'>\n\t\tpreferredDefault?: MetricKey\n\t} = {}\n): Field => {\n\tconst { extra, preferredDefault = 'pageviews' } = opts\n\tconst supports = (adapter: AnalyticsAdapter, metric: MetricKey): boolean =>\n\t\tsatisfiesCapabilities(adapter.capabilities, { ...extra, metrics: [metric] })\n\tconst options = (\n\t\targs.providersEnabled\n\t\t\t? candidates\n\t\t\t: candidates.filter((m) => args.adapters.some((a) => supports(a, m)))\n\t).map((m) => ({ value: m, label: staticLabel(METRIC_KEYS[m]) }))\n\tconst defaultValue = options.some((o) => o.value === preferredDefault)\n\t\t? preferredDefault\n\t\t: options[0]?.value\n\tconst filterOptions: SelectField['filterOptions'] = ({ options: opts, siblingData }) => {\n\t\tconst sourceId = (siblingData as { dataSource?: unknown } | undefined)?.dataSource\n\t\tconst adapter =\n\t\t\ttypeof sourceId === 'string' ? args.adapters.find((a) => a.id === sourceId) : undefined\n\t\tif (!adapter) {\n\t\t\treturn opts\n\t\t}\n\t\treturn opts.filter((o) => typeof o === 'object' && supports(adapter, o.value as MetricKey))\n\t}\n\treturn {\n\t\tname: 'metric',\n\t\ttype: 'select',\n\t\trequired: true,\n\t\t...(defaultValue !== undefined ? { defaultValue } : {}),\n\t\tlabel: labelForKey(keys.widgetFieldMetric),\n\t\toptions,\n\t\tadmin: {\n\t\t\t// A required metric has no meaningful cleared state.\n\t\t\tisClearable: false,\n\t\t\tcomponents: {\n\t\t\t\tField: {\n\t\t\t\t\tpath: '@10x-media/analytics/client#MetricSelectField',\n\t\t\t\t\t...(extra ? { clientProps: { requires: extra } } : {}),\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t...(args.multiProvider ? { filterOptions } : {}),\n\t}\n}\n\nconst titleField = (args: RegisterWidgetsArgs, placeholder: string): Field => ({\n\tname: 'title',\n\ttype: 'text',\n\tlabel: labelForKey(keys.widgetFieldTitle),\n\t...(args.localizeText ? { localized: true } : {}),\n\tadmin: { placeholder },\n})\n\nconst timeframeSelectField = (): Field => ({\n\tname: 'timeframe',\n\ttype: 'select',\n\trequired: true,\n\tdefaultValue: 'last30days',\n\tlabel: labelForKey(keys.widgetFieldTimeframe),\n\tadmin: { isClearable: false },\n\toptions: [\n\t\t...TIMEFRAME_PRESETS.map((p) => ({ value: p, label: labelForKey(TIMEFRAME_KEYS[p]) })),\n\t\t{ value: 'custom', label: labelForKey(keys.widgetTimeframeCustom) },\n\t],\n})\n\n/** Reads the previous period too: the trend overlays it, the goals table deltas against it. */\nconst compareField = (): Field => ({\n\tname: 'compare',\n\ttype: 'checkbox',\n\tdefaultValue: false,\n\tlabel: labelForKey(keys.widgetFieldCompare),\n})\n\nconst dataSourceField = (args: RegisterWidgetsArgs): Field => ({\n\tname: 'dataSource',\n\ttype: 'select',\n\tlabel: labelForKey(keys.widgetFieldDataSource),\n\tdefaultValue: args.defaultId ?? args.adapters[0]?.id,\n\tadmin: {\n\t\t// Clearing would leave no source; the widget always reads through one.\n\t\tisClearable: false,\n\t\tcomponents: { Field: { path: '@10x-media/analytics/client#SourceSelectField' } },\n\t},\n\toptions: args.adapters.map((a) => ({ value: a.id, label: a.label })),\n\t// Payload's select validator rejects any value absent from `options`, but runtime\n\t// (DB-registered) provider ids are only known per request, not at config time.\n\tvalidate: ((value) =>\n\t\tvalue === undefined || value === null || (typeof value === 'string' && value.length > 0)\n\t\t\t? true\n\t\t\t: 'invalid data source') as SelectFieldSingleValidation,\n})\n\nconst customRangeField = (): Field =>\n\tdateRangeField({\n\t\tname: 'range',\n\t\tlabel: labelForKey(keys.widgetFieldRange),\n\t\tpickerAppearance: 'dayOnly',\n\t\toverrides: (f) => ({\n\t\t\t...f,\n\t\t\tadmin: {\n\t\t\t\t...f.admin,\n\t\t\t\tcondition: (_data, siblingData) => siblingData?.timeframe === 'custom',\n\t\t\t},\n\t\t}),\n\t})\n\n/** The metric select in a widget's field list. */\nexport const findMetricField = (fields: Field[]): Field | undefined =>\n\tfields.find((field) => 'name' in field && field.name === 'metric')\n\nconst metricWidgetFields = (args: RegisterWidgetsArgs, extra: Field[] = []): Field[] => [\n\ttitleField(args, en[keys.widgetFieldTitlePlaceholder]),\n\tmetricSelectField(WIDGET_METRICS, args),\n\ttimeframeSelectField(),\n\tcustomRangeField(),\n\t...extra,\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\nconst breakdownWidgetFields = (args: RegisterWidgetsArgs, spec: BreakdownSpec): Field[] => [\n\ttitleField(args, en[spec.label]),\n\tmetricSelectField(WIDGET_METRICS, args, {\n\t\textra: { dimensions: [spec.dimension] },\n\t\t...(spec.preferredDefault ? { preferredDefault: spec.preferredDefault } : {}),\n\t}),\n\ttimeframeSelectField(),\n\tcustomRangeField(),\n\t{\n\t\tname: 'limit',\n\t\ttype: 'number',\n\t\tdefaultValue: 5,\n\t\tmin: 1,\n\t\tmax: 20,\n\t\tlabel: labelForKey(keys.widgetFieldLimit),\n\t},\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\n/** A select, not the breakdown's free number: the goals table is a summary, not a report. */\nconst goalLimitField = (): Field => ({\n\tname: 'limit',\n\ttype: 'select',\n\tdefaultValue: String(GOAL_ROW_LIMITS[0]),\n\tlabel: labelForKey(keys.widgetFieldLimit),\n\tadmin: { isClearable: false },\n\toptions: GOAL_ROW_LIMITS.map((limit) => ({ value: String(limit), label: String(limit) })),\n})\n\nconst goalsWidgetFields = (args: RegisterWidgetsArgs): Field[] => [\n\ttitleField(args, en[keys.widgetGoals]),\n\ttimeframeSelectField(),\n\tcustomRangeField(),\n\tgoalLimitField(),\n\t...(args.comparison === false ? [] : [compareField()]),\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\nconst realtimeWidgetFields = (args: RegisterWidgetsArgs): Field[] => [\n\ttitleField(args, en[keys.widgetFieldTitlePlaceholder]),\n\tmetricSelectField(['visitors', 'pageviews'], args, {\n\t\textra: { realtime: true },\n\t\tpreferredDefault: 'visitors',\n\t}),\n\t{\n\t\tname: 'windowMinutes',\n\t\ttype: 'select',\n\t\tdefaultValue: '30',\n\t\tlabel: labelForKey(keys.widgetFieldWindow),\n\t\tadmin: { isClearable: false },\n\t\toptions: [\n\t\t\t{ value: '5', label: '5 min' },\n\t\t\t{ value: '15', label: '15 min' },\n\t\t\t{ value: '30', label: '30 min' },\n\t\t\t{ value: '60', label: '60 min' },\n\t\t],\n\t},\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\nconst WIDGET_DEFS: WidgetDef[] = [\n\t{\n\t\tslug: 'analytics-metric',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsMetricWidget',\n\t\tlabel: keys.widgetMetricLabel,\n\t\tminWidth: 'x-small',\n\t\tmaxWidth: 'medium',\n\t\tfields: metricWidgetFields,\n\t},\n\t{\n\t\tslug: 'analytics-trend',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsTrendWidget',\n\t\tlabel: keys.widgetTrendLabel,\n\t\trequires: { metrics: ['pageviews'] },\n\t\tminWidth: 'small',\n\t\tmaxWidth: 'full',\n\t\tfields: (args) => metricWidgetFields(args, args.comparison === false ? [] : [compareField()]),\n\t},\n\t{\n\t\tslug: 'analytics-realtime',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsRealtimeWidget',\n\t\tlabel: keys.widgetRealtimeLabel,\n\t\trequires: { realtime: true },\n\t\tminWidth: 'small' as WidgetWidth,\n\t\tmaxWidth: 'medium' as WidgetWidth,\n\t\tfields: realtimeWidgetFields,\n\t},\n\t{\n\t\tslug: 'analytics-goals',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsGoalsWidget',\n\t\tlabel: keys.widgetGoals,\n\t\trequires: { metrics: ['conversions'], dimensions: ['goal'] },\n\t\tminWidth: 'small' as WidgetWidth,\n\t\tmaxWidth: 'large' as WidgetWidth,\n\t\tfields: goalsWidgetFields,\n\t},\n\t...BREAKDOWN_SPECS.map(\n\t\t(spec): WidgetDef => ({\n\t\t\tslug: spec.slug,\n\t\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsBreakdownWidget',\n\t\t\tlabel: spec.label,\n\t\t\trequires: { dimensions: [spec.dimension] },\n\t\t\tminWidth: 'small' as WidgetWidth,\n\t\t\tmaxWidth: 'large' as WidgetWidth,\n\t\t\tfields: (args) => breakdownWidgetFields(args, spec),\n\t\t})\n\t),\n]\n\nexport const registerWidgets = (config: Config, args: RegisterWidgetsArgs): void => {\n\tconst built: Widget[] = []\n\tfor (const def of WIDGET_DEFS) {\n\t\tif (args.disabled.includes(def.slug)) {\n\t\t\tcontinue\n\t\t}\n\t\tif (!args.providersEnabled && !widgetIsSupported(def.requires, args.adapters)) {\n\t\t\tcontinue\n\t\t}\n\t\tconst fields = def.fields(args)\n\t\t// A required metric select with no servable option would make the widget\n\t\t// impossible to configure; skip it like an unsupported widget.\n\t\tconst metricField = findMetricField(fields)\n\t\tif (metricField && 'options' in metricField && metricField.options.length === 0) {\n\t\t\tcontinue\n\t\t}\n\t\tbuilt.push({\n\t\t\tslug: def.slug,\n\t\t\tComponent: { path: def.component, serverProps: { view: args.view ?? false } },\n\t\t\tlabel: labelForKey(def.label),\n\t\t\tfields,\n\t\t\tminWidth: def.minWidth,\n\t\t\tmaxWidth: def.maxWidth,\n\t\t})\n\t}\n\tbuilt.push(...buildCustomWidgets(args.register, args.adapters, args.disabled))\n\tif (!built.length) {\n\t\treturn\n\t}\n\tconfig.admin ??= {}\n\tconfig.admin.dashboard ??= { widgets: [] }\n\tconfig.admin.dashboard.widgets ??= []\n\tconfig.admin.dashboard.widgets.push(...built)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AA4BA,MAAM,eAAe,SAAiD;CACrE,IAAI,GAAG;CACP,IAAI,GAAG;AACR;AAqCA,MAAa,qBACZ,UACA,aACa,CAAC,YAAY,SAAS,MAAM,MAAM,sBAAsB,EAAE,cAAc,QAAQ,CAAC;;;;;;;;;;;;;;;AAgB/F,MAAM,qBACL,YACA,MACA,OAGI,CAAC,MACM;CACX,MAAM,EAAE,OAAO,mBAAmB,gBAAgB;CAClD,MAAM,YAAY,SAA2B,WAC5C,sBAAsB,QAAQ,cAAc;EAAE,GAAG;EAAO,SAAS,CAAC,MAAM;CAAE,CAAC;CAC5E,MAAM,WACL,KAAK,mBACF,aACA,WAAW,QAAQ,MAAM,KAAK,SAAS,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,CAAC,GACpE,KAAK,OAAO;EAAE,OAAO;EAAG,OAAO,YAAY,YAAY,EAAE;CAAE,EAAE;CAC/D,MAAM,eAAe,QAAQ,MAAM,MAAM,EAAE,UAAU,gBAAgB,IAClE,mBACA,QAAQ,IAAI;CACf,MAAM,iBAA+C,EAAE,SAAS,MAAM,kBAAkB;EACvF,MAAM,WAAY,aAAsD;EACxE,MAAM,UACL,OAAO,aAAa,WAAW,KAAK,SAAS,MAAM,MAAM,EAAE,OAAO,QAAQ,IAAI,KAAA;EAC/E,IAAI,CAAC,SACJ,OAAO;EAER,OAAO,KAAK,QAAQ,MAAM,OAAO,MAAM,YAAY,SAAS,SAAS,EAAE,KAAkB,CAAC;CAC3F;CACA,OAAO;EACN,MAAM;EACN,MAAM;EACN,UAAU;EACV,GAAI,iBAAiB,KAAA,IAAY,EAAE,aAAa,IAAI,CAAC;EACrD,OAAO,YAAY,KAAK,iBAAiB;EACzC;EACA,OAAO;GAEN,aAAa;GACb,YAAY,EACX,OAAO;IACN,MAAM;IACN,GAAI,QAAQ,EAAE,aAAa,EAAE,UAAU,MAAM,EAAE,IAAI,CAAC;GACrD,EACD;EACD;EACA,GAAI,KAAK,gBAAgB,EAAE,cAAc,IAAI,CAAC;CAC/C;AACD;AAEA,MAAM,cAAc,MAA2B,iBAAgC;CAC9E,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,gBAAgB;CACxC,GAAI,KAAK,eAAe,EAAE,WAAW,KAAK,IAAI,CAAC;CAC/C,OAAO,EAAE,YAAY;AACtB;AAEA,MAAM,8BAAqC;CAC1C,MAAM;CACN,MAAM;CACN,UAAU;CACV,cAAc;CACd,OAAO,YAAY,KAAK,oBAAoB;CAC5C,OAAO,EAAE,aAAa,MAAM;CAC5B,SAAS,CACR,GAAG,kBAAkB,KAAK,OAAO;EAAE,OAAO;EAAG,OAAO,YAAY,eAAe,EAAE;CAAE,EAAE,GACrF;EAAE,OAAO;EAAU,OAAO,YAAY,KAAK,qBAAqB;CAAE,CACnE;AACD;;AAGA,MAAM,sBAA6B;CAClC,MAAM;CACN,MAAM;CACN,cAAc;CACd,OAAO,YAAY,KAAK,kBAAkB;AAC3C;AAEA,MAAM,mBAAmB,UAAsC;CAC9D,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,qBAAqB;CAC7C,cAAc,KAAK,aAAa,KAAK,SAAS,IAAI;CAClD,OAAO;EAEN,aAAa;EACb,YAAY,EAAE,OAAO,EAAE,MAAM,gDAAgD,EAAE;CAChF;CACA,SAAS,KAAK,SAAS,KAAK,OAAO;EAAE,OAAO,EAAE;EAAI,OAAO,EAAE;CAAM,EAAE;CAGnE,YAAY,UACX,UAAU,KAAA,KAAa,UAAU,QAAS,OAAO,UAAU,YAAY,MAAM,SAAS,IACnF,OACA;AACL;AAEA,MAAM,yBACL,eAAe;CACd,MAAM;CACN,OAAO,YAAY,KAAK,gBAAgB;CACxC,kBAAkB;CAClB,YAAY,OAAO;EAClB,GAAG;EACH,OAAO;GACN,GAAG,EAAE;GACL,YAAY,OAAO,gBAAgB,aAAa,cAAc;EAC/D;CACD;AACD,CAAC;;AAGF,MAAa,mBAAmB,WAC/B,OAAO,MAAM,UAAU,UAAU,SAAS,MAAM,SAAS,QAAQ;AAElE,MAAM,sBAAsB,MAA2B,QAAiB,CAAC,MAAe;CACvF,WAAW,MAAM,GAAG,KAAK,4BAA4B;CACrD,kBAAkB,gBAAgB,IAAI;CACtC,qBAAqB;CACrB,iBAAiB;CACjB,GAAG;CACH,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;AAEA,MAAM,yBAAyB,MAA2B,SAAiC;CAC1F,WAAW,MAAM,GAAG,KAAK,MAAM;CAC/B,kBAAkB,gBAAgB,MAAM;EACvC,OAAO,EAAE,YAAY,CAAC,KAAK,SAAS,EAAE;EACtC,GAAI,KAAK,mBAAmB,EAAE,kBAAkB,KAAK,iBAAiB,IAAI,CAAC;CAC5E,CAAC;CACD,qBAAqB;CACrB,iBAAiB;CACjB;EACC,MAAM;EACN,MAAM;EACN,cAAc;EACd,KAAK;EACL,KAAK;EACL,OAAO,YAAY,KAAK,gBAAgB;CACzC;CACA,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;;AAGA,MAAM,wBAA+B;CACpC,MAAM;CACN,MAAM;CACN,cAAc,OAAO,gBAAgB,EAAE;CACvC,OAAO,YAAY,KAAK,gBAAgB;CACxC,OAAO,EAAE,aAAa,MAAM;CAC5B,SAAS,gBAAgB,KAAK,WAAW;EAAE,OAAO,OAAO,KAAK;EAAG,OAAO,OAAO,KAAK;CAAE,EAAE;AACzF;AAEA,MAAM,qBAAqB,SAAuC;CACjE,WAAW,MAAM,GAAG,KAAK,YAAY;CACrC,qBAAqB;CACrB,iBAAiB;CACjB,eAAe;CACf,GAAI,KAAK,eAAe,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC;CACpD,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;AAEA,MAAM,wBAAwB,SAAuC;CACpE,WAAW,MAAM,GAAG,KAAK,4BAA4B;CACrD,kBAAkB,CAAC,YAAY,WAAW,GAAG,MAAM;EAClD,OAAO,EAAE,UAAU,KAAK;EACxB,kBAAkB;CACnB,CAAC;CACD;EACC,MAAM;EACN,MAAM;EACN,cAAc;EACd,OAAO,YAAY,KAAK,iBAAiB;EACzC,OAAO,EAAE,aAAa,MAAM;EAC5B,SAAS;GACR;IAAE,OAAO;IAAK,OAAO;GAAQ;GAC7B;IAAE,OAAO;IAAM,OAAO;GAAS;GAC/B;IAAE,OAAO;IAAM,OAAO;GAAS;GAC/B;IAAE,OAAO;IAAM,OAAO;GAAS;EAChC;CACD;CACA,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;AAEA,MAAM,cAA2B;CAChC;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,SAAS,CAAC,WAAW,EAAE;EACnC,UAAU;EACV,UAAU;EACV,SAAS,SAAS,mBAAmB,MAAM,KAAK,eAAe,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;CAC7F;CACA;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,UAAU,KAAK;EAC3B,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU;GAAE,SAAS,CAAC,aAAa;GAAG,YAAY,CAAC,MAAM;EAAE;EAC3D,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA,GAAG,gBAAgB,KACjB,UAAqB;EACrB,MAAM,KAAK;EACX,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,YAAY,CAAC,KAAK,SAAS,EAAE;EACzC,UAAU;EACV,UAAU;EACV,SAAS,SAAS,sBAAsB,MAAM,IAAI;CACnD,EACD;AACD;AAEA,MAAa,mBAAmB,QAAgB,SAAoC;CACnF,MAAM,QAAkB,CAAC;CACzB,KAAK,MAAM,OAAO,aAAa;EAC9B,IAAI,KAAK,SAAS,SAAS,IAAI,IAAI,GAClC;EAED,IAAI,CAAC,KAAK,oBAAoB,CAAC,kBAAkB,IAAI,UAAU,KAAK,QAAQ,GAC3E;EAED,MAAM,SAAS,IAAI,OAAO,IAAI;EAG9B,MAAM,cAAc,gBAAgB,MAAM;EAC1C,IAAI,eAAe,aAAa,eAAe,YAAY,QAAQ,WAAW,GAC7E;EAED,MAAM,KAAK;GACV,MAAM,IAAI;GACV,WAAW;IAAE,MAAM,IAAI;IAAW,aAAa,EAAE,MAAM,KAAK,QAAQ,MAAM;GAAE;GAC5E,OAAO,YAAY,IAAI,KAAK;GAC5B;GACA,UAAU,IAAI;GACd,UAAU,IAAI;EACf,CAAC;CACF;CACA,MAAM,KAAK,GAAG,mBAAmB,KAAK,UAAU,KAAK,UAAU,KAAK,QAAQ,CAAC;CAC7E,IAAI,CAAC,MAAM,QACV;CAED,OAAO,UAAU,CAAC;CAClB,OAAO,MAAM,cAAc,EAAE,SAAS,CAAC,EAAE;CACzC,OAAO,MAAM,UAAU,YAAY,CAAC;CACpC,OAAO,MAAM,UAAU,QAAQ,KAAK,GAAG,KAAK;AAC7C"}
|
package/dist/widgets/types.js
CHANGED
|
@@ -1,13 +1,27 @@
|
|
|
1
1
|
//#region src/widgets/types.ts
|
|
2
|
+
/** Row counts the goals widget offers; the first is its default. */
|
|
3
|
+
const GOAL_ROW_LIMITS = [
|
|
4
|
+
10,
|
|
5
|
+
25,
|
|
6
|
+
50
|
|
7
|
+
];
|
|
8
|
+
/** The stored select value as a row count, falling back to the default for anything else. */
|
|
9
|
+
const resolveGoalRowLimit = (value) => {
|
|
10
|
+
const parsed = typeof value === "string" || typeof value === "number" ? Number(value) : NaN;
|
|
11
|
+
return GOAL_ROW_LIMITS.find((limit) => limit === parsed) ?? GOAL_ROW_LIMITS[0];
|
|
12
|
+
};
|
|
2
13
|
const WIDGET_METRICS = [
|
|
3
14
|
"pageviews",
|
|
4
15
|
"visitors",
|
|
5
16
|
"sessions",
|
|
6
17
|
"avgDuration",
|
|
7
18
|
"bounceRate",
|
|
8
|
-
"events"
|
|
19
|
+
"events",
|
|
20
|
+
"conversions",
|
|
21
|
+
"revenue",
|
|
22
|
+
"scrollDepth"
|
|
9
23
|
];
|
|
10
24
|
//#endregion
|
|
11
|
-
export { WIDGET_METRICS };
|
|
25
|
+
export { GOAL_ROW_LIMITS, WIDGET_METRICS, resolveGoalRowLimit };
|
|
12
26
|
|
|
13
27
|
//# sourceMappingURL=types.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","names":[],"sources":["../../src/widgets/types.ts"],"sourcesContent":["import type { MetricKey } from '../core/contract'\nimport type { TimeframePreset } from '../timeframe/presets'\n\nexport interface WidgetRange {\n\tfrom?: string\n\tto?: string\n}\n\nexport interface MetricWidgetData {\n\ttitle?: string\n\tmetric?: MetricKey\n\ttimeframe?: TimeframePreset | 'custom'\n\trange?: WidgetRange\n\tdataSource?: string\n}\n\nexport const WIDGET_METRICS: MetricKey[] = [\n\t'pageviews',\n\t'visitors',\n\t'sessions',\n\t'avgDuration',\n\t'bounceRate',\n\t'events',\n]\n"],"mappings":";
|
|
1
|
+
{"version":3,"file":"types.js","names":[],"sources":["../../src/widgets/types.ts"],"sourcesContent":["import type { MetricKey } from '../core/contract'\nimport type { TimeframePreset } from '../timeframe/presets'\n\nexport interface WidgetRange {\n\tfrom?: string\n\tto?: string\n}\n\nexport interface MetricWidgetData {\n\ttitle?: string\n\tmetric?: MetricKey\n\ttimeframe?: TimeframePreset | 'custom'\n\trange?: WidgetRange\n\tdataSource?: string\n\t/** Trend widget only: overlay the previous period on the chart. */\n\tcompare?: boolean\n}\n\nexport interface GoalsWidgetData {\n\ttitle?: string\n\ttimeframe?: TimeframePreset | 'custom'\n\trange?: WidgetRange\n\t/** One of {@link GOAL_ROW_LIMITS}, stored as the select's string value. */\n\tlimit?: string | number\n\tcompare?: boolean\n\tdataSource?: string\n}\n\n/** Row counts the goals widget offers; the first is its default. */\nexport const GOAL_ROW_LIMITS = [10, 25, 50] as const\n\nexport type GoalRowLimit = (typeof GOAL_ROW_LIMITS)[number]\n\n/** The stored select value as a row count, falling back to the default for anything else. */\nexport const resolveGoalRowLimit = (value: unknown): GoalRowLimit => {\n\tconst parsed = typeof value === 'string' || typeof value === 'number' ? Number(value) : Number.NaN\n\tconst match = GOAL_ROW_LIMITS.find((limit) => limit === parsed)\n\treturn match ?? GOAL_ROW_LIMITS[0]\n}\n\nexport const WIDGET_METRICS: MetricKey[] = [\n\t'pageviews',\n\t'visitors',\n\t'sessions',\n\t'avgDuration',\n\t'bounceRate',\n\t'events',\n\t'conversions',\n\t'revenue',\n\t'scrollDepth',\n]\n"],"mappings":";;AA6BA,MAAa,kBAAkB;CAAC;CAAI;CAAI;AAAE;;AAK1C,MAAa,uBAAuB,UAAiC;CACpE,MAAM,SAAS,OAAO,UAAU,YAAY,OAAO,UAAU,WAAW,OAAO,KAAK,IAAI;CAExF,OADc,gBAAgB,MAAM,UAAU,UAAU,MAC7C,KAAK,gBAAgB;AACjC;AAEA,MAAa,iBAA8B;CAC1C;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { MetricKey } from "../core/contract.js";
|
|
2
|
+
import { TimeframePreset } from "../timeframe/presets.js";
|
|
3
|
+
import { PayloadRequest } from "payload";
|
|
4
|
+
|
|
5
|
+
//#region src/widgets/viewLink.d.ts
|
|
6
|
+
/**
|
|
7
|
+
* The view as a widget sees it: where it mounts and what it opens on, or false when the
|
|
8
|
+
* app turned it off. The defaults travel with the path because a link must leave out
|
|
9
|
+
* exactly what the view would have defaulted to anyway.
|
|
10
|
+
*/
|
|
11
|
+
type WidgetView = {
|
|
12
|
+
path: string;
|
|
13
|
+
defaultRange: TimeframePreset;
|
|
14
|
+
defaultMetric: MetricKey;
|
|
15
|
+
} | false;
|
|
16
|
+
/** What `registerWidgets` adds to every built-in widget's server props. */
|
|
17
|
+
interface WidgetViewProps {
|
|
18
|
+
view?: WidgetView;
|
|
19
|
+
}
|
|
20
|
+
//#endregion
|
|
21
|
+
export { WidgetViewProps };
|
|
22
|
+
//# sourceMappingURL=viewLink.d.ts.map
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { zonedCalendarDay } from "../timeframe/tz.js";
|
|
2
|
+
import { BREAKDOWN_TABS, TAB_DIMENSIONS } from "../view/gating.js";
|
|
3
|
+
import { DEFAULT_VIEW_RANGE, VIEW_RANGE_PRESETS, serializeViewState } from "../view/state.js";
|
|
4
|
+
import { formatAdminURL } from "payload/shared";
|
|
5
|
+
//#region src/widgets/viewLink.ts
|
|
6
|
+
/** `allTime` is no range the view can hold, so an install defaulting to it opens here. */
|
|
7
|
+
const fallbackRange = (defaults) => defaults.range === "allTime" ? DEFAULT_VIEW_RANGE : defaults.range;
|
|
8
|
+
const DAY_MS = 864e5;
|
|
9
|
+
/**
|
|
10
|
+
* The widest custom window the view will accept, as a start day. `parseViewState` drops a
|
|
11
|
+
* wider one and opens on the default range instead, silently, so a widget on a longer
|
|
12
|
+
* window links to the last `MAX_QUERY_RANGE_DAYS` days of it: the most of what the widget
|
|
13
|
+
* shows that the view can show back.
|
|
14
|
+
*/
|
|
15
|
+
const clampStartDay = (from, to) => {
|
|
16
|
+
const start = Date.parse(`${from}T00:00:00.000Z`);
|
|
17
|
+
const end = Date.parse(`${to}T00:00:00.000Z`);
|
|
18
|
+
if (Number.isNaN(start) || Number.isNaN(end)) return from;
|
|
19
|
+
const earliest = end - 365 * DAY_MS;
|
|
20
|
+
return start < earliest ? new Date(earliest).toISOString().slice(0, 10) : from;
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* The widget's window as the view's toolbar can hold it. A preset the toolbar does not
|
|
24
|
+
* offer (`allTime`, `thisMonth`, `thisYear`) would select nothing there, so the link drops
|
|
25
|
+
* the range instead and the view opens on its own default.
|
|
26
|
+
*/
|
|
27
|
+
const rangeOf = (args, defaults) => {
|
|
28
|
+
if (args.timeframe === "custom") {
|
|
29
|
+
if (!args.range) return { range: fallbackRange(defaults) };
|
|
30
|
+
const to = zonedCalendarDay(args.range.end, args.timezone);
|
|
31
|
+
return {
|
|
32
|
+
range: "custom",
|
|
33
|
+
from: clampStartDay(zonedCalendarDay(args.range.start, args.timezone), to),
|
|
34
|
+
to
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
return VIEW_RANGE_PRESETS.includes(args.timeframe) ? { range: args.timeframe } : { range: fallbackRange(defaults) };
|
|
38
|
+
};
|
|
39
|
+
/**
|
|
40
|
+
* A relative admin link opening the analytics view on what the widget shows. Nothing is
|
|
41
|
+
* coerced against the source's capabilities here: the view does that on open, so a link
|
|
42
|
+
* naming something the selected source cannot serve still lands on a working view.
|
|
43
|
+
*/
|
|
44
|
+
const viewHref = (args) => {
|
|
45
|
+
const defaults = {
|
|
46
|
+
range: args.defaultRange,
|
|
47
|
+
metric: args.defaultMetric
|
|
48
|
+
};
|
|
49
|
+
const state = {
|
|
50
|
+
...rangeOf(args, defaults),
|
|
51
|
+
compare: args.compare === true,
|
|
52
|
+
...args.source === void 0 ? {} : { source: args.source },
|
|
53
|
+
metric: args.metric ?? defaults.metric,
|
|
54
|
+
tab: args.tab ?? "pages",
|
|
55
|
+
filters: [],
|
|
56
|
+
limit: 10
|
|
57
|
+
};
|
|
58
|
+
const path = formatAdminURL({
|
|
59
|
+
adminRoute: args.adminRoute,
|
|
60
|
+
path: args.viewPath
|
|
61
|
+
});
|
|
62
|
+
const query = serializeViewState(state, defaults).toString();
|
|
63
|
+
return query ? `${path}?${query}` : path;
|
|
64
|
+
};
|
|
65
|
+
/**
|
|
66
|
+
* The same link for a built-in widget, or nothing at all when the view is off. Omitting
|
|
67
|
+
* `timeframe` opens the view on its configured range, for a widget (realtime) whose own
|
|
68
|
+
* rolling window is no range the view can hold.
|
|
69
|
+
*/
|
|
70
|
+
const widgetViewHref = (view, req, args) => view ? viewHref({
|
|
71
|
+
...args,
|
|
72
|
+
timeframe: args.timeframe ?? view.defaultRange,
|
|
73
|
+
adminRoute: req.payload.config.routes.admin,
|
|
74
|
+
viewPath: view.path,
|
|
75
|
+
defaultRange: view.defaultRange,
|
|
76
|
+
defaultMetric: view.defaultMetric
|
|
77
|
+
}) : void 0;
|
|
78
|
+
/** The breakdown tab that offers a dimension; every contract dimension belongs to one. */
|
|
79
|
+
const viewTabForDimension = (dimension) => BREAKDOWN_TABS.find((tab) => TAB_DIMENSIONS[tab].includes(dimension));
|
|
80
|
+
//#endregion
|
|
81
|
+
export { viewTabForDimension, widgetViewHref };
|
|
82
|
+
|
|
83
|
+
//# sourceMappingURL=viewLink.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"viewLink.js","names":[],"sources":["../../src/widgets/viewLink.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\nimport { formatAdminURL } from 'payload/shared'\nimport type { DateRange, DimensionKey, MetricKey } from '../core/contract'\nimport { MAX_QUERY_RANGE_DAYS } from '../query/limits'\nimport type { TimeframePreset } from '../timeframe/presets'\nimport { zonedCalendarDay } from '../timeframe/tz'\nimport { BREAKDOWN_TABS, type BreakdownTab, TAB_DIMENSIONS } from '../view/gating'\nimport {\n\tDEFAULT_VIEW_LIMIT,\n\tDEFAULT_VIEW_RANGE,\n\tDEFAULT_VIEW_TAB,\n\tserializeViewState,\n\tVIEW_RANGE_PRESETS,\n\ttype ViewDefaults,\n\ttype ViewState,\n} from '../view/state'\n\n/**\n * The view as a widget sees it: where it mounts and what it opens on, or false when the\n * app turned it off. The defaults travel with the path because a link must leave out\n * exactly what the view would have defaulted to anyway.\n */\nexport type WidgetView =\n\t| { path: string; defaultRange: TimeframePreset; defaultMetric: MetricKey }\n\t| false\n\n/** What `registerWidgets` adds to every built-in widget's server props. */\nexport interface WidgetViewProps {\n\tview?: WidgetView\n}\n\nexport interface ViewHrefArgs {\n\tadminRoute: string\n\tviewPath: string\n\t/** The install's own starting point, so the link omits what the view defaults to. */\n\tdefaultRange: TimeframePreset\n\tdefaultMetric: MetricKey\n\tsource?: string\n\ttimeframe: TimeframePreset | 'custom'\n\t/** The widget's own window, needed only for a custom timeframe. */\n\trange?: DateRange\n\ttimezone: string\n\tcompare?: boolean\n\tmetric?: MetricKey\n\ttab?: BreakdownTab\n}\n\n/** `allTime` is no range the view can hold, so an install defaulting to it opens here. */\nconst fallbackRange = (defaults: ViewDefaults): TimeframePreset =>\n\tdefaults.range === 'allTime' ? DEFAULT_VIEW_RANGE : defaults.range\n\nconst DAY_MS = 86_400_000\n\n/**\n * The widest custom window the view will accept, as a start day. `parseViewState` drops a\n * wider one and opens on the default range instead, silently, so a widget on a longer\n * window links to the last `MAX_QUERY_RANGE_DAYS` days of it: the most of what the widget\n * shows that the view can show back.\n */\nconst clampStartDay = (from: string, to: string): string => {\n\tconst start = Date.parse(`${from}T00:00:00.000Z`)\n\tconst end = Date.parse(`${to}T00:00:00.000Z`)\n\tif (Number.isNaN(start) || Number.isNaN(end)) {\n\t\treturn from\n\t}\n\t// Both days are read whole, so the cap counts them inclusively.\n\tconst earliest = end - (MAX_QUERY_RANGE_DAYS - 1) * DAY_MS\n\treturn start < earliest ? new Date(earliest).toISOString().slice(0, 10) : from\n}\n\n/**\n * The widget's window as the view's toolbar can hold it. A preset the toolbar does not\n * offer (`allTime`, `thisMonth`, `thisYear`) would select nothing there, so the link drops\n * the range instead and the view opens on its own default.\n */\nconst rangeOf = (\n\targs: ViewHrefArgs,\n\tdefaults: ViewDefaults\n): Pick<ViewState, 'range' | 'from' | 'to'> => {\n\tif (args.timeframe === 'custom') {\n\t\tif (!args.range) {\n\t\t\treturn { range: fallbackRange(defaults) }\n\t\t}\n\t\tconst to = zonedCalendarDay(args.range.end, args.timezone)\n\t\treturn {\n\t\t\trange: 'custom',\n\t\t\tfrom: clampStartDay(zonedCalendarDay(args.range.start, args.timezone), to),\n\t\t\tto,\n\t\t}\n\t}\n\treturn VIEW_RANGE_PRESETS.includes(args.timeframe)\n\t\t? { range: args.timeframe }\n\t\t: { range: fallbackRange(defaults) }\n}\n\n/**\n * A relative admin link opening the analytics view on what the widget shows. Nothing is\n * coerced against the source's capabilities here: the view does that on open, so a link\n * naming something the selected source cannot serve still lands on a working view.\n */\nexport const viewHref = (args: ViewHrefArgs): string => {\n\tconst defaults: ViewDefaults = { range: args.defaultRange, metric: args.defaultMetric }\n\tconst state: ViewState = {\n\t\t...rangeOf(args, defaults),\n\t\tcompare: args.compare === true,\n\t\t...(args.source === undefined ? {} : { source: args.source }),\n\t\tmetric: args.metric ?? defaults.metric,\n\t\ttab: args.tab ?? DEFAULT_VIEW_TAB,\n\t\tfilters: [],\n\t\tlimit: DEFAULT_VIEW_LIMIT,\n\t}\n\t// `resolveView` refuses a path without a leading slash, so the option cannot be wider.\n\tconst path = formatAdminURL({\n\t\tadminRoute: args.adminRoute,\n\t\tpath: args.viewPath as `/${string}`,\n\t})\n\tconst query = serializeViewState(state, defaults).toString()\n\treturn query ? `${path}?${query}` : path\n}\n\n/**\n * The same link for a built-in widget, or nothing at all when the view is off. Omitting\n * `timeframe` opens the view on its configured range, for a widget (realtime) whose own\n * rolling window is no range the view can hold.\n */\nexport const widgetViewHref = (\n\tview: WidgetView | undefined,\n\treq: PayloadRequest,\n\targs: Omit<\n\t\tViewHrefArgs,\n\t\t'adminRoute' | 'viewPath' | 'defaultRange' | 'defaultMetric' | 'timeframe'\n\t> & { timeframe?: TimeframePreset | 'custom' }\n): string | undefined =>\n\tview\n\t\t? viewHref({\n\t\t\t\t...args,\n\t\t\t\ttimeframe: args.timeframe ?? view.defaultRange,\n\t\t\t\tadminRoute: req.payload.config.routes.admin,\n\t\t\t\tviewPath: view.path,\n\t\t\t\tdefaultRange: view.defaultRange,\n\t\t\t\tdefaultMetric: view.defaultMetric,\n\t\t\t})\n\t\t: undefined\n\n/** The breakdown tab that offers a dimension; every contract dimension belongs to one. */\nexport const viewTabForDimension = (dimension: DimensionKey): BreakdownTab | undefined =>\n\tBREAKDOWN_TABS.find((tab) => TAB_DIMENSIONS[tab].includes(dimension))\n"],"mappings":";;;;;;AAgDA,MAAM,iBAAiB,aACtB,SAAS,UAAU,YAAY,qBAAqB,SAAS;AAE9D,MAAM,SAAS;;;;;;;AAQf,MAAM,iBAAiB,MAAc,OAAuB;CAC3D,MAAM,QAAQ,KAAK,MAAM,GAAG,KAAK,eAAe;CAChD,MAAM,MAAM,KAAK,MAAM,GAAG,GAAG,eAAe;CAC5C,IAAI,OAAO,MAAM,KAAK,KAAK,OAAO,MAAM,GAAG,GAC1C,OAAO;CAGR,MAAM,WAAW,MAAA,MAAmC;CACpD,OAAO,QAAQ,WAAW,IAAI,KAAK,QAAQ,EAAE,YAAY,EAAE,MAAM,GAAG,EAAE,IAAI;AAC3E;;;;;;AAOA,MAAM,WACL,MACA,aAC8C;CAC9C,IAAI,KAAK,cAAc,UAAU;EAChC,IAAI,CAAC,KAAK,OACT,OAAO,EAAE,OAAO,cAAc,QAAQ,EAAE;EAEzC,MAAM,KAAK,iBAAiB,KAAK,MAAM,KAAK,KAAK,QAAQ;EACzD,OAAO;GACN,OAAO;GACP,MAAM,cAAc,iBAAiB,KAAK,MAAM,OAAO,KAAK,QAAQ,GAAG,EAAE;GACzE;EACD;CACD;CACA,OAAO,mBAAmB,SAAS,KAAK,SAAS,IAC9C,EAAE,OAAO,KAAK,UAAU,IACxB,EAAE,OAAO,cAAc,QAAQ,EAAE;AACrC;;;;;;AAOA,MAAa,YAAY,SAA+B;CACvD,MAAM,WAAyB;EAAE,OAAO,KAAK;EAAc,QAAQ,KAAK;CAAc;CACtF,MAAM,QAAmB;EACxB,GAAG,QAAQ,MAAM,QAAQ;EACzB,SAAS,KAAK,YAAY;EAC1B,GAAI,KAAK,WAAW,KAAA,IAAY,CAAC,IAAI,EAAE,QAAQ,KAAK,OAAO;EAC3D,QAAQ,KAAK,UAAU,SAAS;EAChC,KAAK,KAAK,OAAA;EACV,SAAS,CAAC;EACV,OAAA;CACD;CAEA,MAAM,OAAO,eAAe;EAC3B,YAAY,KAAK;EACjB,MAAM,KAAK;CACZ,CAAC;CACD,MAAM,QAAQ,mBAAmB,OAAO,QAAQ,EAAE,SAAS;CAC3D,OAAO,QAAQ,GAAG,KAAK,GAAG,UAAU;AACrC;;;;;;AAOA,MAAa,kBACZ,MACA,KACA,SAKA,OACG,SAAS;CACT,GAAG;CACH,WAAW,KAAK,aAAa,KAAK;CAClC,YAAY,IAAI,QAAQ,OAAO,OAAO;CACtC,UAAU,KAAK;CACf,cAAc,KAAK;CACnB,eAAe,KAAK;AACrB,CAAC,IACA,KAAA;;AAGJ,MAAa,uBAAuB,cACnC,eAAe,MAAM,QAAQ,eAAe,KAAK,SAAS,SAAS,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@10x-media/analytics",
|
|
3
|
-
"version": "1.0.0-beta.
|
|
3
|
+
"version": "1.0.0-beta.8",
|
|
4
4
|
"description": "Adapter-based analytics for Payload: providers, a native engine, dashboard widgets, and portable fields.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -37,6 +37,16 @@
|
|
|
37
37
|
"import": "./dist/exports/client.js",
|
|
38
38
|
"default": "./dist/exports/client.js"
|
|
39
39
|
},
|
|
40
|
+
"./tracker": {
|
|
41
|
+
"types": "./dist/exports/tracker.d.ts",
|
|
42
|
+
"import": "./dist/exports/tracker.js",
|
|
43
|
+
"default": "./dist/exports/tracker.js"
|
|
44
|
+
},
|
|
45
|
+
"./react": {
|
|
46
|
+
"types": "./dist/exports/react.d.ts",
|
|
47
|
+
"import": "./dist/exports/react.js",
|
|
48
|
+
"default": "./dist/exports/react.js"
|
|
49
|
+
},
|
|
40
50
|
"./rsc": {
|
|
41
51
|
"types": "./dist/exports/rsc.d.ts",
|
|
42
52
|
"import": "./dist/exports/rsc.js",
|
|
@@ -94,12 +104,17 @@
|
|
|
94
104
|
"CHANGELOG.md",
|
|
95
105
|
"LICENSE"
|
|
96
106
|
],
|
|
107
|
+
"dependencies": {
|
|
108
|
+
"path-to-regexp": "6.3.0"
|
|
109
|
+
},
|
|
97
110
|
"peerDependencies": {
|
|
98
|
-
"@10x-media/fields": "^0.1.0-beta.
|
|
111
|
+
"@10x-media/fields": "^0.1.0-beta.7",
|
|
99
112
|
"@google-analytics/data": "^6.0.0",
|
|
100
113
|
"@payloadcms/db-postgres": "^3.82.0",
|
|
114
|
+
"@payloadcms/next": "^3.83.0",
|
|
101
115
|
"@payloadcms/ui": "^3.83.0",
|
|
102
116
|
"maxmind": "^4.3.24",
|
|
117
|
+
"next": "^15.2.9 || ^16.2.6",
|
|
103
118
|
"payload": "^3.83.0",
|
|
104
119
|
"react": "^19.0.0",
|
|
105
120
|
"react-datepicker": "^7.6.0",
|
|
@@ -123,13 +138,17 @@
|
|
|
123
138
|
"@google-analytics/data": "^6.1.0",
|
|
124
139
|
"@payloadcms/db-mongodb": "3.85.0",
|
|
125
140
|
"@payloadcms/db-postgres": "3.85.0",
|
|
141
|
+
"@payloadcms/next": "3.85.0",
|
|
126
142
|
"@payloadcms/ui": "3.85.0",
|
|
127
143
|
"@playwright/test": "1.60.0",
|
|
144
|
+
"@testing-library/react": "^16.1.0",
|
|
128
145
|
"@types/node": "22.19.19",
|
|
129
146
|
"@types/react": "19.2.15",
|
|
130
147
|
"@types/react-dom": "19.2.3",
|
|
148
|
+
"jsdom": "^25.0.1",
|
|
131
149
|
"maxmind": "^4.3.24",
|
|
132
150
|
"msw": "^2.14.6",
|
|
151
|
+
"next": "16.2.6",
|
|
133
152
|
"payload": "3.85.0",
|
|
134
153
|
"playwright": "1.60.0",
|
|
135
154
|
"react": "19.2.6",
|
|
@@ -138,11 +157,12 @@
|
|
|
138
157
|
"tsdown": "0.22.1",
|
|
139
158
|
"typescript": "5.9.3",
|
|
140
159
|
"vitest": "4.1.7",
|
|
160
|
+
"@10x-media/fields": "0.1.0-beta.7",
|
|
141
161
|
"@10x-media/payload-test-harness": "0.0.0",
|
|
162
|
+
"@10x-media/tsconfig": "0.0.0",
|
|
142
163
|
"@10x-media/vitest-config": "0.0.0",
|
|
143
|
-
"@10x-media/
|
|
144
|
-
"@10x-media/
|
|
145
|
-
"@10x-media/tsconfig": "0.0.0"
|
|
164
|
+
"@10x-media/form-builder": "0.1.0-beta.23",
|
|
165
|
+
"@10x-media/tsdown-config": "0.0.0"
|
|
146
166
|
},
|
|
147
167
|
"publishConfig": {
|
|
148
168
|
"access": "public"
|