@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 +1 @@
|
|
|
1
|
-
{"version":3,"file":"warmTask.js","names":[],"sources":["../../src/plugin/warmTask.ts"],"sourcesContent":["import type { PayloadRequest, TaskConfig, WidgetInstance } from 'payload'\nimport type { DateRange, DimensionKey, MetricKey } from '../core/contract'\nimport { TIMEFRAME_PRESETS, type TimeframePreset } from '../timeframe/presets'\nimport { breakdownSpecBySlug } from '../widgets/breakdownTypes'\nimport { resolveCustomRange } from '../widgets/range'\nimport { readForWidget } from '../widgets/readForWidget'\nimport { readForWidgetBreakdown } from '../widgets/readForWidgetBreakdown'\nimport { readForWidgetSeries } from '../widgets/readForWidgetSeries'\nimport { WIDGET_METRICS, type WidgetRange } from '../widgets/types'\n\n/** Minimal shape of a dashboard widget instance the warm job reads. */\nexport interface WarmWidgetInstance {\n\twidgetSlug?: string\n\tdata?: Record<string, unknown>\n}\n\nexport type WarmTarget =\n\t| {\n\t\t\tkind: 'metric'\n\t\t\tmetric: MetricKey\n\t\t\ttimeframe: TimeframePreset\n\t\t\trange?: DateRange\n\t\t\tadapterId?: string\n\t }\n\t| {\n\t\t\tkind: 'series'\n\t\t\tmetric: MetricKey\n\t\t\ttimeframe: TimeframePreset\n\t\t\trange?: DateRange\n\t\t\tadapterId?: string\n\t }\n\t| {\n\t\t\tkind: 'breakdown'\n\t\t\tmetric: MetricKey\n\t\t\tdimension: DimensionKey\n\t\t\ttimeframe: TimeframePreset\n\t\t\tlimit: number\n\t\t\trange?: DateRange\n\t\t\tadapterId?: string\n\t }\n\nconst asString = (v: unknown): string | undefined => (typeof v === 'string' ? v : undefined)\n\nconst asMetric = (v: unknown): MetricKey =>\n\ttypeof v === 'string' && (WIDGET_METRICS as readonly string[]).includes(v)\n\t\t? (v as MetricKey)\n\t\t: 'pageviews'\n\nconst asTimeframe = (v: unknown): TimeframePreset | 'custom' => {\n\tif (v === 'custom') {\n\t\treturn 'custom'\n\t}\n\tif (typeof v === 'string' && (TIMEFRAME_PRESETS as readonly string[]).includes(v)) {\n\t\treturn v as TimeframePreset\n\t}\n\treturn 'last30days'\n}\n\nconst asLimit = (v: unknown): number => (typeof v === 'number' && v > 0 ? v : 5)\n\nconst asRange = (v: unknown): WidgetRange | undefined => {\n\tif (!v || typeof v !== 'object') {\n\t\treturn undefined\n\t}\n\tconst r = v as { from?: unknown; to?: unknown }\n\treturn { from: asString(r.from), to: asString(r.to) }\n}\n\nconst targetKey = (t: WarmTarget): string => {\n\tconst range = t.range ? `${t.range.start.toISOString()}:${t.range.end.toISOString()}` : ''\n\tconst dimension = t.kind === 'breakdown' ? t.dimension : ''\n\tconst limit = t.kind === 'breakdown' ? String(t.limit) : ''\n\treturn `${t.kind}:${t.metric}:${dimension}:${t.timeframe}:${limit}:${t.adapterId ?? ''}:${range}`\n}\n\n/**\n * Map a dashboard's widget layout to the set of reads that warm its cache. Built-in\n * metric, trend, and breakdown widgets become targets; the realtime widget is skipped\n * (its short-TTL key is kept warm by the live poller) and any other slug is a custom app\n * widget whose read shape the plugin does not know. A `custom` timeframe is kept only when\n * its range resolves (the read takes an explicit range; `timeframe` is then unused).\n * Identical targets are de-duplicated so a repeated widget warms its tuple once.\n */\nexport const deriveWarmTargets = (widgets: readonly WarmWidgetInstance[]): WarmTarget[] => {\n\tconst out: WarmTarget[] = []\n\tconst seen = new Set<string>()\n\tfor (const widget of widgets) {\n\t\tconst slug = widget.widgetSlug\n\t\tif (!slug || slug === 'analytics-realtime') {\n\t\t\tcontinue\n\t\t}\n\t\tconst data = widget.data ?? {}\n\t\tconst metric = asMetric(data.metric)\n\t\tconst adapterId = asString(data.dataSource)\n\t\tconst timeframeRaw = asTimeframe(data.timeframe)\n\t\tlet timeframe: TimeframePreset = 'last30days'\n\t\tlet range: DateRange | undefined\n\t\tif (timeframeRaw === 'custom') {\n\t\t\tconst resolved = resolveCustomRange('custom', asRange(data.range))\n\t\t\tif (!resolved) {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\trange = resolved\n\t\t} else {\n\t\t\ttimeframe = timeframeRaw\n\t\t}\n\n\t\tlet target: WarmTarget | undefined\n\t\tif (slug === 'analytics-metric') {\n\t\t\ttarget = { kind: 'metric', metric, timeframe, range, adapterId }\n\t\t} else if (slug === 'analytics-trend') {\n\t\t\ttarget = { kind: 'series', metric, timeframe, range, adapterId }\n\t\t} else {\n\t\t\tconst spec = breakdownSpecBySlug(slug)\n\t\t\tif (spec) {\n\t\t\t\ttarget = {\n\t\t\t\t\tkind: 'breakdown',\n\t\t\t\t\tmetric,\n\t\t\t\t\tdimension: spec.dimension,\n\t\t\t\t\ttimeframe,\n\t\t\t\t\tlimit: asLimit(data.limit),\n\t\t\t\t\trange,\n\t\t\t\t\tadapterId,\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tif (!target) {\n\t\t\tcontinue\n\t\t}\n\t\tconst key = targetKey(target)\n\t\tif (seen.has(key)) {\n\t\t\tcontinue\n\t\t}\n\t\tseen.add(key)\n\t\tout.push(target)\n\t}\n\treturn out\n}\n\nexport const WARM_TASK_SLUG = 'analytics-warm-cache'\n\n/** A dashboard `defaultLayout`: an array, or a function resolving one per request. */\nexport type WarmLayout =\n\t| ((args: { req: PayloadRequest }) => WidgetInstance[] | Promise<WidgetInstance[]>)\n\t| WidgetInstance[]\n\t| undefined\n\nconst resolveLayout = async (\n\tlayout: WarmLayout,\n\treq: PayloadRequest\n): Promise<WarmWidgetInstance[]> => {\n\ttry {\n\t\tconst list = typeof layout === 'function' ? await layout({ req }) : (layout ?? [])\n\t\treturn list.map((w) => ({ widgetSlug: w.widgetSlug, data: w.data }))\n\t} catch (err) {\n\t\treq.payload.logger.warn(\n\t\t\t`analytics warm-cache: could not resolve the dashboard layout: ${String(err)}`\n\t\t)\n\t\treturn []\n\t}\n}\n\n/** Run one target's read; returns true when the read served data (status `ok`). */\nconst runTarget = async (target: WarmTarget, req: PayloadRequest, now: Date): Promise<boolean> => {\n\tif (target.kind === 'metric') {\n\t\tconst result = await readForWidget({\n\t\t\treq,\n\t\t\tmetrics: [target.metric],\n\t\t\ttimeframe: target.timeframe,\n\t\t\tadapterId: target.adapterId,\n\t\t\tnow,\n\t\t\trange: target.range,\n\t\t})\n\t\treturn result.status === 'ok'\n\t}\n\tif (target.kind === 'series') {\n\t\tconst result = await readForWidgetSeries({\n\t\t\treq,\n\t\t\tmetric: target.metric,\n\t\t\ttimeframe: target.timeframe,\n\t\t\tadapterId: target.adapterId,\n\t\t\tnow,\n\t\t\trange: target.range,\n\t\t})\n\t\treturn result.status === 'ok'\n\t}\n\tconst result = await readForWidgetBreakdown({\n\t\treq,\n\t\tmetric: target.metric,\n\t\tdimension: target.dimension,\n\t\ttimeframe: target.timeframe,\n\t\tlimit: target.limit,\n\t\tadapterId: target.adapterId,\n\t\tnow,\n\t\trange: target.range,\n\t})\n\treturn result.status === 'ok'\n}\n\n/**\n * Opt-in Payload task that pre-runs the dashboard's widget reads through the surfacing\n * engine so `payload.kv` is warm before a user opens the dashboard. Targets are derived\n * from `layout` (the app's `defaultLayout`, captured at registration and resolved here);\n * each read is isolated so one failing provider does not abort the rest. Most valuable\n * for slow or rate-limited provider adapters; native reads are cheap and harmless to warm.\n */\nexport const warmTask = (\n\tcron: string,\n\tlayout: WarmLayout\n): TaskConfig<{ input: Record<string, never>; output: { warmed: number; failed: number } }> => ({\n\tslug: WARM_TASK_SLUG,\n\thandler: async ({ req }) => {\n\t\tconst targets = deriveWarmTargets(await resolveLayout(layout, req))\n\t\tconst now = new Date()\n\t\tlet warmed = 0\n\t\tlet failed = 0\n\t\tfor (const target of targets) {\n\t\t\ttry {\n\t\t\t\tif (await runTarget(target, req, now)) {\n\t\t\t\t\twarmed++\n\t\t\t\t}\n\t\t\t} catch (err) {\n\t\t\t\tfailed++\n\t\t\t\treq.payload.logger.warn(\n\t\t\t\t\t`analytics warm-cache: ${target.kind} read for \"${target.metric}\" failed: ${String(err)}`\n\t\t\t\t)\n\t\t\t}\n\t\t}\n\t\treturn { output: { warmed, failed } }\n\t},\n\tschedule: [{ cron, queue: 'default' }],\n})\n"],"mappings":";;;;;;;;AAyCA,MAAM,YAAY,MAAoC,OAAO,MAAM,WAAW,IAAI,KAAA;AAElF,MAAM,YAAY,MACjB,OAAO,MAAM,YAAa,eAAqC,SAAS,CAAC,IACrE,IACD;AAEJ,MAAM,eAAe,MAA2C;CAC/D,IAAI,MAAM,UACT,OAAO;CAER,IAAI,OAAO,MAAM,YAAa,kBAAwC,SAAS,CAAC,GAC/E,OAAO;CAER,OAAO;AACR;AAEA,MAAM,WAAW,MAAwB,OAAO,MAAM,YAAY,IAAI,IAAI,IAAI;AAE9E,MAAM,WAAW,MAAwC;CACxD,IAAI,CAAC,KAAK,OAAO,MAAM,UACtB;CAED,MAAM,IAAI;CACV,OAAO;EAAE,MAAM,SAAS,EAAE,IAAI;EAAG,IAAI,SAAS,EAAE,EAAE;CAAE;AACrD;AAEA,MAAM,aAAa,MAA0B;CAC5C,MAAM,QAAQ,EAAE,QAAQ,GAAG,EAAE,MAAM,MAAM,YAAY,EAAE,GAAG,EAAE,MAAM,IAAI,YAAY,MAAM;CACxF,MAAM,YAAY,EAAE,SAAS,cAAc,EAAE,YAAY;CACzD,MAAM,QAAQ,EAAE,SAAS,cAAc,OAAO,EAAE,KAAK,IAAI;CACzD,OAAO,GAAG,EAAE,KAAK,GAAG,EAAE,OAAO,GAAG,UAAU,GAAG,EAAE,UAAU,GAAG,MAAM,GAAG,EAAE,aAAa,GAAG,GAAG;AAC3F;;;;;;;;;AAUA,MAAa,qBAAqB,YAAyD;CAC1F,MAAM,MAAoB,CAAC;CAC3B,MAAM,uBAAO,IAAI,IAAY;CAC7B,KAAK,MAAM,UAAU,SAAS;EAC7B,MAAM,OAAO,OAAO;EACpB,IAAI,CAAC,QAAQ,SAAS,sBACrB;EAED,MAAM,OAAO,OAAO,QAAQ,CAAC;EAC7B,MAAM,SAAS,SAAS,KAAK,MAAM;EACnC,MAAM,YAAY,SAAS,KAAK,UAAU;EAC1C,MAAM,eAAe,YAAY,KAAK,SAAS;EAC/C,IAAI,YAA6B;EACjC,IAAI;EACJ,IAAI,iBAAiB,UAAU;GAC9B,MAAM,WAAW,mBAAmB,UAAU,QAAQ,KAAK,KAAK,CAAC;GACjE,IAAI,CAAC,UACJ;GAED,QAAQ;EACT,OACC,YAAY;EAGb,IAAI;EACJ,IAAI,SAAS,oBACZ,SAAS;GAAE,MAAM;GAAU;GAAQ;GAAW;GAAO;EAAU;OACzD,IAAI,SAAS,mBACnB,SAAS;GAAE,MAAM;GAAU;GAAQ;GAAW;GAAO;EAAU;OACzD;GACN,MAAM,OAAO,oBAAoB,IAAI;GACrC,IAAI,MACH,SAAS;IACR,MAAM;IACN;IACA,WAAW,KAAK;IAChB;IACA,OAAO,QAAQ,KAAK,KAAK;IACzB;IACA;GACD;EAEF;EACA,IAAI,CAAC,QACJ;EAED,MAAM,MAAM,UAAU,MAAM;EAC5B,IAAI,KAAK,IAAI,GAAG,GACf;EAED,KAAK,IAAI,GAAG;EACZ,IAAI,KAAK,MAAM;CAChB;CACA,OAAO;AACR;AAEA,MAAa,iBAAiB;AAQ9B,MAAM,gBAAgB,OACrB,QACA,QACmC;CACnC,IAAI;EAEH,QADa,OAAO,WAAW,aAAa,MAAM,OAAO,EAAE,IAAI,CAAC,IAAK,UAAU,CAAC,GACpE,KAAK,OAAO;GAAE,YAAY,EAAE;GAAY,MAAM,EAAE;EAAK,EAAE;CACpE,SAAS,KAAK;EACb,IAAI,QAAQ,OAAO,KAClB,iEAAiE,OAAO,GAAG,GAC5E;EACA,OAAO,CAAC;CACT;AACD;;AAGA,MAAM,YAAY,OAAO,QAAoB,KAAqB,QAAgC;CACjG,IAAI,OAAO,SAAS,UASnB,QAAO,MARc,cAAc;EAClC;EACA,SAAS,CAAC,OAAO,MAAM;EACvB,WAAW,OAAO;EAClB,WAAW,OAAO;EAClB;EACA,OAAO,OAAO;CACf,CAAC,GACa,WAAW;CAE1B,IAAI,OAAO,SAAS,UASnB,QAAO,MARc,oBAAoB;EACxC;EACA,QAAQ,OAAO;EACf,WAAW,OAAO;EAClB,WAAW,OAAO;EAClB;EACA,OAAO,OAAO;CACf,CAAC,GACa,WAAW;CAY1B,QAAO,MAVc,uBAAuB;EAC3C;EACA,QAAQ,OAAO;EACf,WAAW,OAAO;EAClB,WAAW,OAAO;EAClB,OAAO,OAAO;EACd,WAAW,OAAO;EAClB;EACA,OAAO,OAAO;CACf,CAAC,GACa,WAAW;AAC1B;;;;;;;;AASA,MAAa,YACZ,MACA,YAC+F;CAC/F,MAAM;CACN,SAAS,OAAO,EAAE,UAAU;EAC3B,MAAM,UAAU,kBAAkB,MAAM,cAAc,QAAQ,GAAG,CAAC;EAClE,MAAM,sBAAM,IAAI,KAAK;EACrB,IAAI,SAAS;EACb,IAAI,SAAS;EACb,KAAK,MAAM,UAAU,SACpB,IAAI;GACH,IAAI,MAAM,UAAU,QAAQ,KAAK,GAAG,GACnC;EAEF,SAAS,KAAK;GACb;GACA,IAAI,QAAQ,OAAO,KAClB,yBAAyB,OAAO,KAAK,aAAa,OAAO,OAAO,YAAY,OAAO,GAAG,GACvF;EACD;EAED,OAAO,EAAE,QAAQ;GAAE;GAAQ;EAAO,EAAE;CACrC;CACA,UAAU,CAAC;EAAE;EAAM,OAAO;CAAU,CAAC;AACtC"}
|
|
1
|
+
{"version":3,"file":"warmTask.js","names":[],"sources":["../../src/plugin/warmTask.ts"],"sourcesContent":["import type { PayloadRequest, TaskConfig, WidgetInstance } from 'payload'\nimport type { DimensionKey, MetricKey } from '../core/contract'\nimport type { ScopesResolver } from '../core/options'\nimport { resolveScopeList } from '../core/scopeList'\nimport { TIMEFRAME_PRESETS, type TimeframePreset } from '../timeframe/presets'\nimport { DEFAULT_TIMEZONE } from '../timeframe/tz'\nimport { breakdownSpecBySlug } from '../widgets/breakdownTypes'\nimport { resolveCustomRange } from '../widgets/range'\nimport { readForWidget, type WidgetReadStatus } from '../widgets/readForWidget'\nimport { readForWidgetBreakdown } from '../widgets/readForWidgetBreakdown'\nimport { readForWidgetSeries } from '../widgets/readForWidgetSeries'\nimport { WIDGET_METRICS, type WidgetRange } from '../widgets/types'\nimport { getRuntime, resolveTimezoneFor } from './runtime'\n\n/** Minimal shape of a dashboard widget instance the warm job reads. */\nexport interface WarmWidgetInstance {\n\twidgetSlug?: string\n\tdata?: Record<string, unknown>\n}\n\nexport type WarmTarget =\n\t| {\n\t\t\tkind: 'metric'\n\t\t\tmetric: MetricKey\n\t\t\ttimeframe: TimeframePreset\n\t\t\trange?: WidgetRange\n\t\t\tadapterId?: string\n\t }\n\t| {\n\t\t\tkind: 'series'\n\t\t\tmetric: MetricKey\n\t\t\ttimeframe: TimeframePreset\n\t\t\trange?: WidgetRange\n\t\t\tadapterId?: string\n\t }\n\t| {\n\t\t\tkind: 'breakdown'\n\t\t\tmetric: MetricKey\n\t\t\tdimension: DimensionKey\n\t\t\ttimeframe: TimeframePreset\n\t\t\tlimit: number\n\t\t\trange?: WidgetRange\n\t\t\tadapterId?: string\n\t }\n\nconst asString = (v: unknown): string | undefined => (typeof v === 'string' ? v : undefined)\n\nconst asMetric = (v: unknown): MetricKey =>\n\ttypeof v === 'string' && (WIDGET_METRICS as readonly string[]).includes(v)\n\t\t? (v as MetricKey)\n\t\t: 'pageviews'\n\nconst asTimeframe = (v: unknown): TimeframePreset | 'custom' => {\n\tif (v === 'custom') {\n\t\treturn 'custom'\n\t}\n\tif (typeof v === 'string' && (TIMEFRAME_PRESETS as readonly string[]).includes(v)) {\n\t\treturn v as TimeframePreset\n\t}\n\treturn 'last30days'\n}\n\nconst asLimit = (v: unknown): number => (typeof v === 'number' && v > 0 ? v : 5)\n\nconst asRange = (v: unknown): WidgetRange | undefined => {\n\tif (!v || typeof v !== 'object') {\n\t\treturn undefined\n\t}\n\tconst r = v as { from?: unknown; to?: unknown }\n\treturn { from: asString(r.from), to: asString(r.to) }\n}\n\nconst targetKey = (t: WarmTarget): string => {\n\tconst range = t.range ? `${t.range.from ?? ''}:${t.range.to ?? ''}` : ''\n\tconst dimension = t.kind === 'breakdown' ? t.dimension : ''\n\tconst limit = t.kind === 'breakdown' ? String(t.limit) : ''\n\treturn `${t.kind}:${t.metric}:${dimension}:${t.timeframe}:${limit}:${t.adapterId ?? ''}:${range}`\n}\n\n/**\n * Map a dashboard's widget layout to the set of reads that warm its cache. Built-in\n * metric, trend, and breakdown widgets become targets; the realtime widget is skipped\n * (its short-TTL key is kept warm by the live poller) and any other slug is a custom app\n * widget whose read shape the plugin does not know. A `custom` timeframe is kept only when\n * its range resolves (the read takes an explicit range; `timeframe` is then unused), and\n * the stored bounds travel with the target rather than concrete instants: which instants\n * two picked days span depends on the reporting timezone, which is per scope and so only\n * known inside the warm loop. Identical targets are de-duplicated so a repeated widget\n * warms its tuple once.\n */\nexport const deriveWarmTargets = (widgets: readonly WarmWidgetInstance[]): WarmTarget[] => {\n\tconst out: WarmTarget[] = []\n\tconst seen = new Set<string>()\n\tfor (const widget of widgets) {\n\t\tconst slug = widget.widgetSlug\n\t\tif (!slug || slug === 'analytics-realtime') {\n\t\t\tcontinue\n\t\t}\n\t\tconst data = widget.data ?? {}\n\t\tconst metric = asMetric(data.metric)\n\t\tconst adapterId = asString(data.dataSource)\n\t\tconst timeframeRaw = asTimeframe(data.timeframe)\n\t\tlet timeframe: TimeframePreset = 'last30days'\n\t\tlet range: WidgetRange | undefined\n\t\tif (timeframeRaw === 'custom') {\n\t\t\tconst stored = asRange(data.range)\n\t\t\t// Whether the bounds name real days is timezone-independent, so the skip decision\n\t\t\t// can be taken here even though the window itself cannot.\n\t\t\tif (!resolveCustomRange('custom', stored, DEFAULT_TIMEZONE)) {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\trange = stored\n\t\t} else {\n\t\t\ttimeframe = timeframeRaw\n\t\t}\n\n\t\tlet target: WarmTarget | undefined\n\t\tif (slug === 'analytics-metric') {\n\t\t\ttarget = { kind: 'metric', metric, timeframe, range, adapterId }\n\t\t} else if (slug === 'analytics-trend') {\n\t\t\ttarget = { kind: 'series', metric, timeframe, range, adapterId }\n\t\t} else {\n\t\t\tconst spec = breakdownSpecBySlug(slug)\n\t\t\tif (spec) {\n\t\t\t\ttarget = {\n\t\t\t\t\tkind: 'breakdown',\n\t\t\t\t\tmetric,\n\t\t\t\t\tdimension: spec.dimension,\n\t\t\t\t\ttimeframe,\n\t\t\t\t\tlimit: asLimit(data.limit),\n\t\t\t\t\trange,\n\t\t\t\t\tadapterId,\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tif (!target) {\n\t\t\tcontinue\n\t\t}\n\t\tconst key = targetKey(target)\n\t\tif (seen.has(key)) {\n\t\t\tcontinue\n\t\t}\n\t\tseen.add(key)\n\t\tout.push(target)\n\t}\n\treturn out\n}\n\nexport const WARM_TASK_SLUG = 'analytics-warm-cache'\n\n/** A dashboard `defaultLayout`: an array, or a function resolving one per request. */\nexport type WarmLayout =\n\t| ((args: { req: PayloadRequest }) => WidgetInstance[] | Promise<WidgetInstance[]>)\n\t| WidgetInstance[]\n\t| undefined\n\nconst resolveLayout = async (\n\tlayout: WarmLayout,\n\treq: PayloadRequest\n): Promise<WarmWidgetInstance[]> => {\n\ttry {\n\t\tconst list = typeof layout === 'function' ? await layout({ req }) : (layout ?? [])\n\t\treturn list.map((w) => ({ widgetSlug: w.widgetSlug, data: w.data }))\n\t} catch (err) {\n\t\treq.payload.logger.warn(\n\t\t\t`analytics warm-cache: could not resolve the dashboard layout: ${String(err)}`\n\t\t)\n\t\treturn []\n\t}\n}\n\ninterface TargetRunResult {\n\tstatus: WidgetReadStatus\n\tadapterId: string\n}\n\n/**\n * Run one target's read for one scope; the caller decides how to count/log the status. The\n * stored custom bounds resolve here, in that scope's reporting timezone, so the warmed key\n * is the one the rendered widget will ask for.\n */\nconst runTarget = async (args: {\n\ttarget: WarmTarget\n\treq: PayloadRequest\n\tnow: Date\n\tscope: string | null\n\ttimezone: string\n}): Promise<TargetRunResult> => {\n\tconst { target, req, now, scope, timezone } = args\n\tconst range = resolveCustomRange('custom', target.range, timezone)\n\tif (target.kind === 'metric') {\n\t\tconst result = await readForWidget({\n\t\t\treq,\n\t\t\tmetrics: [target.metric],\n\t\t\ttimeframe: target.timeframe,\n\t\t\tadapterId: target.adapterId,\n\t\t\tnow,\n\t\t\trange,\n\t\t\tscope,\n\t\t\ttimezone,\n\t\t})\n\t\treturn { status: result.status, adapterId: result.adapterId }\n\t}\n\tif (target.kind === 'series') {\n\t\tconst result = await readForWidgetSeries({\n\t\t\treq,\n\t\t\tmetric: target.metric,\n\t\t\ttimeframe: target.timeframe,\n\t\t\tadapterId: target.adapterId,\n\t\t\tnow,\n\t\t\trange,\n\t\t\tscope,\n\t\t\ttimezone,\n\t\t})\n\t\treturn { status: result.status, adapterId: result.adapterId }\n\t}\n\tconst result = await readForWidgetBreakdown({\n\t\treq,\n\t\tmetric: target.metric,\n\t\tdimension: target.dimension,\n\t\ttimeframe: target.timeframe,\n\t\tlimit: target.limit,\n\t\tadapterId: target.adapterId,\n\t\tnow,\n\t\trange,\n\t\tscope,\n\t\ttimezone,\n\t})\n\treturn { status: result.status, adapterId: result.adapterId }\n}\n\n/**\n * Opt-in Payload task that pre-runs the dashboard's widget reads through the surfacing\n * engine so `payload.kv` is warm before a user opens the dashboard. Targets are derived\n * from `layout` (the app's `defaultLayout`, captured at registration and resolved here);\n * each read is isolated so one failing provider does not abort the rest. Most valuable\n * for slow or rate-limited provider adapters; native reads are cheap and harmless to warm.\n * With `scopes` configured, every target runs once per tenant scope (plus the install-wide\n * scope) so a multi-tenant install warms every tenant's dashboard, not just the null one.\n */\nexport const warmTask = (\n\tcron: string,\n\tlayout: WarmLayout,\n\tscopes?: ScopesResolver\n): TaskConfig<{ input: Record<string, never>; output: { warmed: number; failed: number } }> => ({\n\tslug: WARM_TASK_SLUG,\n\thandler: async ({ req }) => {\n\t\tconst targets = deriveWarmTargets(await resolveLayout(layout, req))\n\t\tif (targets.length === 0) {\n\t\t\treturn { output: { warmed: 0, failed: 0 } }\n\t\t}\n\t\tconst scopeList = await resolveScopeList(scopes, req.payload)\n\t\tconst now = new Date()\n\t\tlet warmed = 0\n\t\tlet failed = 0\n\t\t// A tenant-pass target that degrades (e.g. a shared config adapter gated for\n\t\t// that scope) is not a failure, but a silent one leaves `warmed` unexplainably\n\t\t// short of `scopes x targets`; warn once per (scope, adapter) so it is visible.\n\t\tconst warnedGated = new Set<string>()\n\t\tconst runtime = getRuntime(req.payload)\n\t\tfor (const scope of scopeList) {\n\t\t\tconst timezone = runtime ? await resolveTimezoneFor(runtime, req, scope) : DEFAULT_TIMEZONE\n\t\t\tfor (const target of targets) {\n\t\t\t\ttry {\n\t\t\t\t\tconst result = await runTarget({ target, req, now, scope, timezone })\n\t\t\t\t\tif (result.status === 'ok') {\n\t\t\t\t\t\twarmed++\n\t\t\t\t\t} else if (scope !== null) {\n\t\t\t\t\t\tconst key = `${scope}\u0000${result.adapterId}`\n\t\t\t\t\t\tif (!warnedGated.has(key)) {\n\t\t\t\t\t\t\twarnedGated.add(key)\n\t\t\t\t\t\t\treq.payload.logger.warn(\n\t\t\t\t\t\t\t\t`analytics warm-cache: scope \"${scope}\" adapter \"${result.adapterId}\" returned \"${result.status}\", skipping`\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} catch (err) {\n\t\t\t\t\tfailed++\n\t\t\t\t\treq.payload.logger.warn(\n\t\t\t\t\t\t`analytics warm-cache: ${target.kind} read for \"${target.metric}\" (scope \"${scope ?? ''}\") failed: ${String(err)}`\n\t\t\t\t\t)\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn { output: { warmed, failed } }\n\t},\n\tschedule: [{ cron, queue: 'default' }],\n})\n"],"mappings":";;;;;;;;;;AA6CA,MAAM,YAAY,MAAoC,OAAO,MAAM,WAAW,IAAI,KAAA;AAElF,MAAM,YAAY,MACjB,OAAO,MAAM,YAAa,eAAqC,SAAS,CAAC,IACrE,IACD;AAEJ,MAAM,eAAe,MAA2C;CAC/D,IAAI,MAAM,UACT,OAAO;CAER,IAAI,OAAO,MAAM,YAAa,kBAAwC,SAAS,CAAC,GAC/E,OAAO;CAER,OAAO;AACR;AAEA,MAAM,WAAW,MAAwB,OAAO,MAAM,YAAY,IAAI,IAAI,IAAI;AAE9E,MAAM,WAAW,MAAwC;CACxD,IAAI,CAAC,KAAK,OAAO,MAAM,UACtB;CAED,MAAM,IAAI;CACV,OAAO;EAAE,MAAM,SAAS,EAAE,IAAI;EAAG,IAAI,SAAS,EAAE,EAAE;CAAE;AACrD;AAEA,MAAM,aAAa,MAA0B;CAC5C,MAAM,QAAQ,EAAE,QAAQ,GAAG,EAAE,MAAM,QAAQ,GAAG,GAAG,EAAE,MAAM,MAAM,OAAO;CACtE,MAAM,YAAY,EAAE,SAAS,cAAc,EAAE,YAAY;CACzD,MAAM,QAAQ,EAAE,SAAS,cAAc,OAAO,EAAE,KAAK,IAAI;CACzD,OAAO,GAAG,EAAE,KAAK,GAAG,EAAE,OAAO,GAAG,UAAU,GAAG,EAAE,UAAU,GAAG,MAAM,GAAG,EAAE,aAAa,GAAG,GAAG;AAC3F;;;;;;;;;;;;AAaA,MAAa,qBAAqB,YAAyD;CAC1F,MAAM,MAAoB,CAAC;CAC3B,MAAM,uBAAO,IAAI,IAAY;CAC7B,KAAK,MAAM,UAAU,SAAS;EAC7B,MAAM,OAAO,OAAO;EACpB,IAAI,CAAC,QAAQ,SAAS,sBACrB;EAED,MAAM,OAAO,OAAO,QAAQ,CAAC;EAC7B,MAAM,SAAS,SAAS,KAAK,MAAM;EACnC,MAAM,YAAY,SAAS,KAAK,UAAU;EAC1C,MAAM,eAAe,YAAY,KAAK,SAAS;EAC/C,IAAI,YAA6B;EACjC,IAAI;EACJ,IAAI,iBAAiB,UAAU;GAC9B,MAAM,SAAS,QAAQ,KAAK,KAAK;GAGjC,IAAI,CAAC,mBAAmB,UAAU,QAAA,KAAwB,GACzD;GAED,QAAQ;EACT,OACC,YAAY;EAGb,IAAI;EACJ,IAAI,SAAS,oBACZ,SAAS;GAAE,MAAM;GAAU;GAAQ;GAAW;GAAO;EAAU;OACzD,IAAI,SAAS,mBACnB,SAAS;GAAE,MAAM;GAAU;GAAQ;GAAW;GAAO;EAAU;OACzD;GACN,MAAM,OAAO,oBAAoB,IAAI;GACrC,IAAI,MACH,SAAS;IACR,MAAM;IACN;IACA,WAAW,KAAK;IAChB;IACA,OAAO,QAAQ,KAAK,KAAK;IACzB;IACA;GACD;EAEF;EACA,IAAI,CAAC,QACJ;EAED,MAAM,MAAM,UAAU,MAAM;EAC5B,IAAI,KAAK,IAAI,GAAG,GACf;EAED,KAAK,IAAI,GAAG;EACZ,IAAI,KAAK,MAAM;CAChB;CACA,OAAO;AACR;AAEA,MAAa,iBAAiB;AAQ9B,MAAM,gBAAgB,OACrB,QACA,QACmC;CACnC,IAAI;EAEH,QADa,OAAO,WAAW,aAAa,MAAM,OAAO,EAAE,IAAI,CAAC,IAAK,UAAU,CAAC,GACpE,KAAK,OAAO;GAAE,YAAY,EAAE;GAAY,MAAM,EAAE;EAAK,EAAE;CACpE,SAAS,KAAK;EACb,IAAI,QAAQ,OAAO,KAClB,iEAAiE,OAAO,GAAG,GAC5E;EACA,OAAO,CAAC;CACT;AACD;;;;;;AAYA,MAAM,YAAY,OAAO,SAMO;CAC/B,MAAM,EAAE,QAAQ,KAAK,KAAK,OAAO,aAAa;CAC9C,MAAM,QAAQ,mBAAmB,UAAU,OAAO,OAAO,QAAQ;CACjE,IAAI,OAAO,SAAS,UAAU;EAC7B,MAAM,SAAS,MAAM,cAAc;GAClC;GACA,SAAS,CAAC,OAAO,MAAM;GACvB,WAAW,OAAO;GAClB,WAAW,OAAO;GAClB;GACA;GACA;GACA;EACD,CAAC;EACD,OAAO;GAAE,QAAQ,OAAO;GAAQ,WAAW,OAAO;EAAU;CAC7D;CACA,IAAI,OAAO,SAAS,UAAU;EAC7B,MAAM,SAAS,MAAM,oBAAoB;GACxC;GACA,QAAQ,OAAO;GACf,WAAW,OAAO;GAClB,WAAW,OAAO;GAClB;GACA;GACA;GACA;EACD,CAAC;EACD,OAAO;GAAE,QAAQ,OAAO;GAAQ,WAAW,OAAO;EAAU;CAC7D;CACA,MAAM,SAAS,MAAM,uBAAuB;EAC3C;EACA,QAAQ,OAAO;EACf,WAAW,OAAO;EAClB,WAAW,OAAO;EAClB,OAAO,OAAO;EACd,WAAW,OAAO;EAClB;EACA;EACA;EACA;CACD,CAAC;CACD,OAAO;EAAE,QAAQ,OAAO;EAAQ,WAAW,OAAO;CAAU;AAC7D;;;;;;;;;;AAWA,MAAa,YACZ,MACA,QACA,YAC+F;CAC/F,MAAM;CACN,SAAS,OAAO,EAAE,UAAU;EAC3B,MAAM,UAAU,kBAAkB,MAAM,cAAc,QAAQ,GAAG,CAAC;EAClE,IAAI,QAAQ,WAAW,GACtB,OAAO,EAAE,QAAQ;GAAE,QAAQ;GAAG,QAAQ;EAAE,EAAE;EAE3C,MAAM,YAAY,MAAM,iBAAiB,QAAQ,IAAI,OAAO;EAC5D,MAAM,sBAAM,IAAI,KAAK;EACrB,IAAI,SAAS;EACb,IAAI,SAAS;EAIb,MAAM,8BAAc,IAAI,IAAY;EACpC,MAAM,UAAU,WAAW,IAAI,OAAO;EACtC,KAAK,MAAM,SAAS,WAAW;GAC9B,MAAM,WAAW,UAAU,MAAM,mBAAmB,SAAS,KAAK,KAAK,IAAA;GACvE,KAAK,MAAM,UAAU,SACpB,IAAI;IACH,MAAM,SAAS,MAAM,UAAU;KAAE;KAAQ;KAAK;KAAK;KAAO;IAAS,CAAC;IACpE,IAAI,OAAO,WAAW,MACrB;SACM,IAAI,UAAU,MAAM;KAC1B,MAAM,MAAM,GAAG,MAAM,GAAG,OAAO;KAC/B,IAAI,CAAC,YAAY,IAAI,GAAG,GAAG;MAC1B,YAAY,IAAI,GAAG;MACnB,IAAI,QAAQ,OAAO,KAClB,gCAAgC,MAAM,aAAa,OAAO,UAAU,cAAc,OAAO,OAAO,YACjG;KACD;IACD;GACD,SAAS,KAAK;IACb;IACA,IAAI,QAAQ,OAAO,KAClB,yBAAyB,OAAO,KAAK,aAAa,OAAO,OAAO,YAAY,SAAS,GAAG,aAAa,OAAO,GAAG,GAChH;GACD;EAEF;EACA,OAAO,EAAE,QAAQ;GAAE;GAAQ;EAAO,EAAE;CACrC;CACA,UAAU,CAAC;EAAE;EAAM,OAAO;CAAU,CAAC;AACtC"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { keys } from "../translations/keys.js";
|
|
2
|
-
import { labelForKey } from "../translations/server.js";
|
|
3
1
|
import { providerCreateAccess, providerRowAccess } from "./access.js";
|
|
4
2
|
import { stampScope } from "./stampScope.js";
|
|
3
|
+
import { keys } from "../translations/keys.js";
|
|
4
|
+
import { labelForKey } from "../translations/server.js";
|
|
5
5
|
//#region src/providers/collection.ts
|
|
6
6
|
const PROVIDERS_SLUG = "analytics-providers";
|
|
7
7
|
const textField = (name, label, width) => ({
|
|
@@ -16,6 +16,32 @@ const secretField = (args, opts) => args.buildSecret({
|
|
|
16
16
|
label: labelForKey(opts.label),
|
|
17
17
|
...opts.width ? { admin: { width: opts.width } } : {}
|
|
18
18
|
});
|
|
19
|
+
/**
|
|
20
|
+
* Public capture config: plain text, never a sealed secret, because the tracker config
|
|
21
|
+
* serves it to the browser. An adapter declares `capture` only when its public field is
|
|
22
|
+
* filled, so these are what let a provider document fill a capture slot.
|
|
23
|
+
*/
|
|
24
|
+
const captureField = (name, label, width) => ({
|
|
25
|
+
name,
|
|
26
|
+
type: "text",
|
|
27
|
+
label: labelForKey(label),
|
|
28
|
+
admin: {
|
|
29
|
+
description: labelForKey(keys.providerFieldCaptureHelp),
|
|
30
|
+
...width ? { width } : {}
|
|
31
|
+
}
|
|
32
|
+
});
|
|
33
|
+
/**
|
|
34
|
+
* The plugin's own scope field, and only when `scopeField` still names it: a host-owned
|
|
35
|
+
* field (a tenant plugin's relationship) is the host's to register, and shadowing it with a
|
|
36
|
+
* hidden text field of another name would store the scope twice.
|
|
37
|
+
*/
|
|
38
|
+
const scopeField = (args) => args.scopeField === "scope" ? [{
|
|
39
|
+
name: "scope",
|
|
40
|
+
type: "text",
|
|
41
|
+
index: true,
|
|
42
|
+
label: labelForKey(keys.providerFieldScope),
|
|
43
|
+
admin: { hidden: true }
|
|
44
|
+
}] : [];
|
|
19
45
|
const hostField = () => ({
|
|
20
46
|
name: "host",
|
|
21
47
|
type: "text",
|
|
@@ -114,21 +140,22 @@ const buildProvidersCollection = (args) => {
|
|
|
114
140
|
}
|
|
115
141
|
}]
|
|
116
142
|
},
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
}
|
|
131
|
-
|
|
143
|
+
...scopeField(args),
|
|
144
|
+
providerGroup("plausible", keys.providerNamePlausible, [
|
|
145
|
+
{
|
|
146
|
+
type: "row",
|
|
147
|
+
fields: [textField("siteId", keys.providerFieldSiteId, "50%"), ...secretField(args, {
|
|
148
|
+
name: "apiKey",
|
|
149
|
+
label: keys.providerFieldApiKey,
|
|
150
|
+
width: "50%"
|
|
151
|
+
})]
|
|
152
|
+
},
|
|
153
|
+
{
|
|
154
|
+
type: "row",
|
|
155
|
+
fields: [captureField("domain", keys.providerFieldDomain, "50%"), captureField("scriptId", keys.providerFieldScriptId, "50%")]
|
|
156
|
+
},
|
|
157
|
+
hostField()
|
|
158
|
+
]),
|
|
132
159
|
providerGroup("umami", keys.providerNameUmami, [
|
|
133
160
|
{
|
|
134
161
|
type: "row",
|
|
@@ -156,14 +183,33 @@ const buildProvidersCollection = (args) => {
|
|
|
156
183
|
label: labelForKey(keys.providerFieldPrivateKey)
|
|
157
184
|
})
|
|
158
185
|
]),
|
|
159
|
-
providerGroup("posthog", keys.providerNamePosthog, [
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
186
|
+
providerGroup("posthog", keys.providerNamePosthog, [
|
|
187
|
+
{
|
|
188
|
+
type: "row",
|
|
189
|
+
fields: [textField("projectId", keys.providerFieldProjectId, "50%"), ...secretField(args, {
|
|
190
|
+
name: "apiKey",
|
|
191
|
+
label: keys.providerFieldApiKey,
|
|
192
|
+
width: "50%"
|
|
193
|
+
})]
|
|
194
|
+
},
|
|
195
|
+
{
|
|
196
|
+
type: "row",
|
|
197
|
+
fields: [captureField("projectToken", keys.providerFieldProjectToken, "50%"), {
|
|
198
|
+
name: "region",
|
|
199
|
+
type: "select",
|
|
200
|
+
label: labelForKey(keys.providerFieldRegion),
|
|
201
|
+
options: [{
|
|
202
|
+
label: "US",
|
|
203
|
+
value: "us"
|
|
204
|
+
}, {
|
|
205
|
+
label: "EU",
|
|
206
|
+
value: "eu"
|
|
207
|
+
}],
|
|
208
|
+
admin: { width: "50%" }
|
|
209
|
+
}]
|
|
210
|
+
},
|
|
211
|
+
hostField()
|
|
212
|
+
])
|
|
167
213
|
]
|
|
168
214
|
};
|
|
169
215
|
return args.overrides ? args.overrides(collection) : collection;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"collection.js","names":[],"sources":["../../src/providers/collection.ts"],"sourcesContent":["import type { CollectionConfig, Field, TextareaField, TextField } from 'payload'\nimport { keys, type TranslationKey } from '../translations/keys'\nimport { labelForKey } from '../translations/server'\nimport type { ProviderAccessArgs } from './access'\nimport { providerCreateAccess, providerRowAccess } from './access'\nimport type { ProviderId } from './factory'\nimport { stampScope } from './stampScope'\n\nexport const PROVIDERS_SLUG = 'analytics-providers'\n\n/** Builds the sealed variant of a secret source field; injected so the fields peer stays lazy. */\nexport type BuildSecretField = (source: TextField | TextareaField) => Field[]\n\nexport interface BuildProvidersCollectionArgs extends ProviderAccessArgs {\n\tslug: string\n\taccess?: Partial<CollectionConfig['access']>\n\toverrides?: (collection: CollectionConfig) => CollectionConfig\n\t/** Called after any change or delete so the per-scope registry cache drops stale adapters. */\n\tonChange: () => void\n\tbuildSecret: BuildSecretField\n}\n\nconst textField = (name: string, label: TranslationKey, width?: string): Field => ({\n\tname,\n\ttype: 'text',\n\tlabel: labelForKey(label),\n\t...(width ? { admin: { width } } : {}),\n})\n\nconst secretField = (\n\targs: BuildProvidersCollectionArgs,\n\topts: { name: string; label: TranslationKey; width?: string }\n): Field[] =>\n\targs.buildSecret({\n\t\tname: opts.name,\n\t\ttype: 'text',\n\t\tlabel: labelForKey(opts.label),\n\t\t...(opts.width ? { admin: { width: opts.width } } : {}),\n\t})\n\nconst hostField = (): Field => ({\n\tname: 'host',\n\ttype: 'text',\n\tlabel: labelForKey(keys.providerFieldHost),\n\tadmin: { description: labelForKey(keys.providerFieldHostHelp) },\n})\n\nconst providerGroup = (provider: ProviderId, label: TranslationKey, fields: Field[]): Field => ({\n\tname: provider,\n\ttype: 'group',\n\tlabel: labelForKey(label),\n\tadmin: { condition: (data) => data?.provider === provider },\n\tfields,\n})\n\n/**\n * The runtime provider-settings collection: one document per provider (and per scope\n * in scoped installs). Admin-only by default; `access` entries override individual\n * operations and `overrides` reshapes the whole config last, so slugs, labels,\n * fields, and access all stay overridable.\n */\nexport const buildProvidersCollection = (args: BuildProvidersCollectionArgs): CollectionConfig => {\n\tconst collection: CollectionConfig = {\n\t\tslug: args.slug,\n\t\tlabels: {\n\t\t\tsingular: labelForKey(keys.providersCollectionSingular),\n\t\t\tplural: labelForKey(keys.providersCollectionPlural),\n\t\t},\n\t\tdisableDuplicate: true,\n\t\tadmin: {\n\t\t\tuseAsTitle: 'name',\n\t\t\tdefaultColumns: ['name', 'provider', 'enabled'],\n\t\t\tgroup: 'Analytics',\n\t\t},\n\t\taccess: {\n\t\t\tread: providerRowAccess(args),\n\t\t\tcreate: providerCreateAccess(args),\n\t\t\tupdate: providerRowAccess(args),\n\t\t\tdelete: providerRowAccess(args),\n\t\t\t...args.access,\n\t\t},\n\t\thooks: {\n\t\t\tbeforeChange: [stampScope(args)],\n\t\t\tafterChange: [\n\t\t\t\t({ doc }) => {\n\t\t\t\t\targs.onChange()\n\t\t\t\t\treturn doc\n\t\t\t\t},\n\t\t\t],\n\t\t\tafterDelete: [\n\t\t\t\t({ doc }) => {\n\t\t\t\t\targs.onChange()\n\t\t\t\t\treturn doc\n\t\t\t\t},\n\t\t\t],\n\t\t},\n\t\tfields: [\n\t\t\t{\n\t\t\t\tname: 'name',\n\t\t\t\ttype: 'text',\n\t\t\t\trequired: true,\n\t\t\t\tlabel: labelForKey(keys.providerFieldName),\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: 'row',\n\t\t\t\tfields: [\n\t\t\t\t\t{\n\t\t\t\t\t\tname: 'provider',\n\t\t\t\t\t\ttype: 'select',\n\t\t\t\t\t\trequired: true,\n\t\t\t\t\t\tlabel: labelForKey(keys.providerFieldProvider),\n\t\t\t\t\t\toptions: [\n\t\t\t\t\t\t\t{ label: labelForKey(keys.providerNamePlausible), value: 'plausible' },\n\t\t\t\t\t\t\t{ label: labelForKey(keys.providerNameUmami), value: 'umami' },\n\t\t\t\t\t\t\t{ label: labelForKey(keys.providerNameGa4), value: 'ga4' },\n\t\t\t\t\t\t\t{ label: labelForKey(keys.providerNamePosthog), value: 'posthog' },\n\t\t\t\t\t\t],\n\t\t\t\t\t\tadmin: { width: '50%' },\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tname: 'enabled',\n\t\t\t\t\t\ttype: 'checkbox',\n\t\t\t\t\t\tdefaultValue: true,\n\t\t\t\t\t\tlabel: labelForKey(keys.providerFieldEnabled),\n\t\t\t\t\t\tadmin: { width: '50%', style: { alignSelf: 'flex-end' } },\n\t\t\t\t\t},\n\t\t\t\t],\n\t\t\t},\n\t\t\t{\n\t\t\t\t// Written by scoped setups (or a tenant plugin's own field via `scopeField`);\n\t\t\t\t// hidden because single-site installs never touch it.\n\t\t\t\tname: 'scope',\n\t\t\t\ttype: 'text',\n\t\t\t\tindex: true,\n\t\t\t\tlabel: labelForKey(keys.providerFieldScope),\n\t\t\t\tadmin: { hidden: true },\n\t\t\t},\n\t\t\tproviderGroup('plausible', keys.providerNamePlausible, [\n\t\t\t\t{\n\t\t\t\t\ttype: 'row',\n\t\t\t\t\tfields: [\n\t\t\t\t\t\ttextField('siteId', keys.providerFieldSiteId, '50%'),\n\t\t\t\t\t\t...secretField(args, { name: 'apiKey', label: keys.providerFieldApiKey, width: '50%' }),\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t\thostField(),\n\t\t\t]),\n\t\t\tproviderGroup('umami', keys.providerNameUmami, [\n\t\t\t\t{\n\t\t\t\t\ttype: 'row',\n\t\t\t\t\tfields: [\n\t\t\t\t\t\ttextField('websiteId', keys.providerFieldWebsiteId, '50%'),\n\t\t\t\t\t\t...secretField(args, { name: 'apiKey', label: keys.providerFieldApiKey, width: '50%' }),\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t\t...secretField(args, { name: 'token', label: keys.providerFieldToken }),\n\t\t\t\thostField(),\n\t\t\t]),\n\t\t\tproviderGroup('ga4', keys.providerNameGa4, [\n\t\t\t\t{\n\t\t\t\t\ttype: 'row',\n\t\t\t\t\tfields: [\n\t\t\t\t\t\ttextField('propertyId', keys.providerFieldPropertyId, '50%'),\n\t\t\t\t\t\ttextField('projectId', keys.providerFieldProjectId, '50%'),\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t\ttextField('clientEmail', keys.providerFieldClientEmail),\n\t\t\t\t...args.buildSecret({\n\t\t\t\t\tname: 'privateKey',\n\t\t\t\t\ttype: 'textarea',\n\t\t\t\t\tlabel: labelForKey(keys.providerFieldPrivateKey),\n\t\t\t\t}),\n\t\t\t]),\n\t\t\tproviderGroup('posthog', keys.providerNamePosthog, [\n\t\t\t\t{\n\t\t\t\t\ttype: 'row',\n\t\t\t\t\tfields: [\n\t\t\t\t\t\ttextField('projectId', keys.providerFieldProjectId, '50%'),\n\t\t\t\t\t\t...secretField(args, { name: 'apiKey', label: keys.providerFieldApiKey, width: '50%' }),\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t\thostField(),\n\t\t\t]),\n\t\t],\n\t}\n\treturn args.overrides ? args.overrides(collection) : collection\n}\n"],"mappings":";;;;;AAQA,MAAa,iBAAiB;AAc9B,MAAM,aAAa,MAAc,OAAuB,WAA2B;CAClF;CACA,MAAM;CACN,OAAO,YAAY,KAAK;CACxB,GAAI,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC;AACrC;AAEA,MAAM,eACL,MACA,SAEA,KAAK,YAAY;CAChB,MAAM,KAAK;CACX,MAAM;CACN,OAAO,YAAY,KAAK,KAAK;CAC7B,GAAI,KAAK,QAAQ,EAAE,OAAO,EAAE,OAAO,KAAK,MAAM,EAAE,IAAI,CAAC;AACtD,CAAC;AAEF,MAAM,mBAA0B;CAC/B,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,iBAAiB;CACzC,OAAO,EAAE,aAAa,YAAY,KAAK,qBAAqB,EAAE;AAC/D;AAEA,MAAM,iBAAiB,UAAsB,OAAuB,YAA4B;CAC/F,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK;CACxB,OAAO,EAAE,YAAY,SAAS,MAAM,aAAa,SAAS;CAC1D;AACD;;;;;;;AAQA,MAAa,4BAA4B,SAAyD;CACjG,MAAM,aAA+B;EACpC,MAAM,KAAK;EACX,QAAQ;GACP,UAAU,YAAY,KAAK,2BAA2B;GACtD,QAAQ,YAAY,KAAK,yBAAyB;EACnD;EACA,kBAAkB;EAClB,OAAO;GACN,YAAY;GACZ,gBAAgB;IAAC;IAAQ;IAAY;GAAS;GAC9C,OAAO;EACR;EACA,QAAQ;GACP,MAAM,kBAAkB,IAAI;GAC5B,QAAQ,qBAAqB,IAAI;GACjC,QAAQ,kBAAkB,IAAI;GAC9B,QAAQ,kBAAkB,IAAI;GAC9B,GAAG,KAAK;EACT;EACA,OAAO;GACN,cAAc,CAAC,WAAW,IAAI,CAAC;GAC/B,aAAa,EACX,EAAE,UAAU;IACZ,KAAK,SAAS;IACd,OAAO;GACR,CACD;GACA,aAAa,EACX,EAAE,UAAU;IACZ,KAAK,SAAS;IACd,OAAO;GACR,CACD;EACD;EACA,QAAQ;GACP;IACC,MAAM;IACN,MAAM;IACN,UAAU;IACV,OAAO,YAAY,KAAK,iBAAiB;GAC1C;GACA;IACC,MAAM;IACN,QAAQ,CACP;KACC,MAAM;KACN,MAAM;KACN,UAAU;KACV,OAAO,YAAY,KAAK,qBAAqB;KAC7C,SAAS;MACR;OAAE,OAAO,YAAY,KAAK,qBAAqB;OAAG,OAAO;MAAY;MACrE;OAAE,OAAO,YAAY,KAAK,iBAAiB;OAAG,OAAO;MAAQ;MAC7D;OAAE,OAAO,YAAY,KAAK,eAAe;OAAG,OAAO;MAAM;MACzD;OAAE,OAAO,YAAY,KAAK,mBAAmB;OAAG,OAAO;MAAU;KAClE;KACA,OAAO,EAAE,OAAO,MAAM;IACvB,GACA;KACC,MAAM;KACN,MAAM;KACN,cAAc;KACd,OAAO,YAAY,KAAK,oBAAoB;KAC5C,OAAO;MAAE,OAAO;MAAO,OAAO,EAAE,WAAW,WAAW;KAAE;IACzD,CACD;GACD;GACA;IAGC,MAAM;IACN,MAAM;IACN,OAAO;IACP,OAAO,YAAY,KAAK,kBAAkB;IAC1C,OAAO,EAAE,QAAQ,KAAK;GACvB;GACA,cAAc,aAAa,KAAK,uBAAuB,CACtD;IACC,MAAM;IACN,QAAQ,CACP,UAAU,UAAU,KAAK,qBAAqB,KAAK,GACnD,GAAG,YAAY,MAAM;KAAE,MAAM;KAAU,OAAO,KAAK;KAAqB,OAAO;IAAM,CAAC,CACvF;GACD,GACA,UAAU,CACX,CAAC;GACD,cAAc,SAAS,KAAK,mBAAmB;IAC9C;KACC,MAAM;KACN,QAAQ,CACP,UAAU,aAAa,KAAK,wBAAwB,KAAK,GACzD,GAAG,YAAY,MAAM;MAAE,MAAM;MAAU,OAAO,KAAK;MAAqB,OAAO;KAAM,CAAC,CACvF;IACD;IACA,GAAG,YAAY,MAAM;KAAE,MAAM;KAAS,OAAO,KAAK;IAAmB,CAAC;IACtE,UAAU;GACX,CAAC;GACD,cAAc,OAAO,KAAK,iBAAiB;IAC1C;KACC,MAAM;KACN,QAAQ,CACP,UAAU,cAAc,KAAK,yBAAyB,KAAK,GAC3D,UAAU,aAAa,KAAK,wBAAwB,KAAK,CAC1D;IACD;IACA,UAAU,eAAe,KAAK,wBAAwB;IACtD,GAAG,KAAK,YAAY;KACnB,MAAM;KACN,MAAM;KACN,OAAO,YAAY,KAAK,uBAAuB;IAChD,CAAC;GACF,CAAC;GACD,cAAc,WAAW,KAAK,qBAAqB,CAClD;IACC,MAAM;IACN,QAAQ,CACP,UAAU,aAAa,KAAK,wBAAwB,KAAK,GACzD,GAAG,YAAY,MAAM;KAAE,MAAM;KAAU,OAAO,KAAK;KAAqB,OAAO;IAAM,CAAC,CACvF;GACD,GACA,UAAU,CACX,CAAC;EACF;CACD;CACA,OAAO,KAAK,YAAY,KAAK,UAAU,UAAU,IAAI;AACtD"}
|
|
1
|
+
{"version":3,"file":"collection.js","names":[],"sources":["../../src/providers/collection.ts"],"sourcesContent":["import type { CollectionConfig, Field, TextareaField, TextField } from 'payload'\nimport { keys, type TranslationKey } from '../translations/keys'\nimport { labelForKey } from '../translations/server'\nimport type { ProviderAccessArgs } from './access'\nimport { providerCreateAccess, providerRowAccess } from './access'\nimport type { ProviderId } from './factory'\nimport { stampScope } from './stampScope'\n\nexport const PROVIDERS_SLUG = 'analytics-providers'\n\n/** Builds the sealed variant of a secret source field; injected so the fields peer stays lazy. */\nexport type BuildSecretField = (source: TextField | TextareaField) => Field[]\n\nexport interface BuildProvidersCollectionArgs extends ProviderAccessArgs {\n\tslug: string\n\taccess?: Partial<CollectionConfig['access']>\n\toverrides?: (collection: CollectionConfig) => CollectionConfig\n\t/** Called after any change or delete so the per-scope registry cache drops stale adapters. */\n\tonChange: () => void\n\tbuildSecret: BuildSecretField\n}\n\nconst textField = (name: string, label: TranslationKey, width?: string): Field => ({\n\tname,\n\ttype: 'text',\n\tlabel: labelForKey(label),\n\t...(width ? { admin: { width } } : {}),\n})\n\nconst secretField = (\n\targs: BuildProvidersCollectionArgs,\n\topts: { name: string; label: TranslationKey; width?: string }\n): Field[] =>\n\targs.buildSecret({\n\t\tname: opts.name,\n\t\ttype: 'text',\n\t\tlabel: labelForKey(opts.label),\n\t\t...(opts.width ? { admin: { width: opts.width } } : {}),\n\t})\n\n/**\n * Public capture config: plain text, never a sealed secret, because the tracker config\n * serves it to the browser. An adapter declares `capture` only when its public field is\n * filled, so these are what let a provider document fill a capture slot.\n */\nconst captureField = (name: string, label: TranslationKey, width?: string): Field => ({\n\tname,\n\ttype: 'text',\n\tlabel: labelForKey(label),\n\tadmin: {\n\t\tdescription: labelForKey(keys.providerFieldCaptureHelp),\n\t\t...(width ? { width } : {}),\n\t},\n})\n\n/**\n * The plugin's own scope field, and only when `scopeField` still names it: a host-owned\n * field (a tenant plugin's relationship) is the host's to register, and shadowing it with a\n * hidden text field of another name would store the scope twice.\n */\nconst scopeField = (args: BuildProvidersCollectionArgs): Field[] =>\n\targs.scopeField === 'scope'\n\t\t? [\n\t\t\t\t{\n\t\t\t\t\t// Written by scoped setups; hidden because single-site installs never touch it.\n\t\t\t\t\tname: 'scope',\n\t\t\t\t\ttype: 'text',\n\t\t\t\t\tindex: true,\n\t\t\t\t\tlabel: labelForKey(keys.providerFieldScope),\n\t\t\t\t\tadmin: { hidden: true },\n\t\t\t\t},\n\t\t\t]\n\t\t: []\n\nconst hostField = (): Field => ({\n\tname: 'host',\n\ttype: 'text',\n\tlabel: labelForKey(keys.providerFieldHost),\n\tadmin: { description: labelForKey(keys.providerFieldHostHelp) },\n})\n\nconst providerGroup = (provider: ProviderId, label: TranslationKey, fields: Field[]): Field => ({\n\tname: provider,\n\ttype: 'group',\n\tlabel: labelForKey(label),\n\tadmin: { condition: (data) => data?.provider === provider },\n\tfields,\n})\n\n/**\n * The runtime provider-settings collection: one document per provider (and per scope\n * in scoped installs). Admin-only by default; `access` entries override individual\n * operations and `overrides` reshapes the whole config last, so slugs, labels,\n * fields, and access all stay overridable.\n */\nexport const buildProvidersCollection = (args: BuildProvidersCollectionArgs): CollectionConfig => {\n\tconst collection: CollectionConfig = {\n\t\tslug: args.slug,\n\t\tlabels: {\n\t\t\tsingular: labelForKey(keys.providersCollectionSingular),\n\t\t\tplural: labelForKey(keys.providersCollectionPlural),\n\t\t},\n\t\tdisableDuplicate: true,\n\t\tadmin: {\n\t\t\tuseAsTitle: 'name',\n\t\t\tdefaultColumns: ['name', 'provider', 'enabled'],\n\t\t\tgroup: 'Analytics',\n\t\t},\n\t\taccess: {\n\t\t\tread: providerRowAccess(args),\n\t\t\tcreate: providerCreateAccess(args),\n\t\t\tupdate: providerRowAccess(args),\n\t\t\tdelete: providerRowAccess(args),\n\t\t\t...args.access,\n\t\t},\n\t\thooks: {\n\t\t\tbeforeChange: [stampScope(args)],\n\t\t\tafterChange: [\n\t\t\t\t({ doc }) => {\n\t\t\t\t\targs.onChange()\n\t\t\t\t\treturn doc\n\t\t\t\t},\n\t\t\t],\n\t\t\tafterDelete: [\n\t\t\t\t({ doc }) => {\n\t\t\t\t\targs.onChange()\n\t\t\t\t\treturn doc\n\t\t\t\t},\n\t\t\t],\n\t\t},\n\t\tfields: [\n\t\t\t{\n\t\t\t\tname: 'name',\n\t\t\t\ttype: 'text',\n\t\t\t\trequired: true,\n\t\t\t\tlabel: labelForKey(keys.providerFieldName),\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: 'row',\n\t\t\t\tfields: [\n\t\t\t\t\t{\n\t\t\t\t\t\tname: 'provider',\n\t\t\t\t\t\ttype: 'select',\n\t\t\t\t\t\trequired: true,\n\t\t\t\t\t\tlabel: labelForKey(keys.providerFieldProvider),\n\t\t\t\t\t\toptions: [\n\t\t\t\t\t\t\t{ label: labelForKey(keys.providerNamePlausible), value: 'plausible' },\n\t\t\t\t\t\t\t{ label: labelForKey(keys.providerNameUmami), value: 'umami' },\n\t\t\t\t\t\t\t{ label: labelForKey(keys.providerNameGa4), value: 'ga4' },\n\t\t\t\t\t\t\t{ label: labelForKey(keys.providerNamePosthog), value: 'posthog' },\n\t\t\t\t\t\t],\n\t\t\t\t\t\tadmin: { width: '50%' },\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tname: 'enabled',\n\t\t\t\t\t\ttype: 'checkbox',\n\t\t\t\t\t\tdefaultValue: true,\n\t\t\t\t\t\tlabel: labelForKey(keys.providerFieldEnabled),\n\t\t\t\t\t\tadmin: { width: '50%', style: { alignSelf: 'flex-end' } },\n\t\t\t\t\t},\n\t\t\t\t],\n\t\t\t},\n\t\t\t...scopeField(args),\n\t\t\tproviderGroup('plausible', keys.providerNamePlausible, [\n\t\t\t\t{\n\t\t\t\t\ttype: 'row',\n\t\t\t\t\tfields: [\n\t\t\t\t\t\ttextField('siteId', keys.providerFieldSiteId, '50%'),\n\t\t\t\t\t\t...secretField(args, { name: 'apiKey', label: keys.providerFieldApiKey, width: '50%' }),\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\ttype: 'row',\n\t\t\t\t\tfields: [\n\t\t\t\t\t\tcaptureField('domain', keys.providerFieldDomain, '50%'),\n\t\t\t\t\t\tcaptureField('scriptId', keys.providerFieldScriptId, '50%'),\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t\thostField(),\n\t\t\t]),\n\t\t\tproviderGroup('umami', keys.providerNameUmami, [\n\t\t\t\t{\n\t\t\t\t\ttype: 'row',\n\t\t\t\t\tfields: [\n\t\t\t\t\t\ttextField('websiteId', keys.providerFieldWebsiteId, '50%'),\n\t\t\t\t\t\t...secretField(args, { name: 'apiKey', label: keys.providerFieldApiKey, width: '50%' }),\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t\t...secretField(args, { name: 'token', label: keys.providerFieldToken }),\n\t\t\t\thostField(),\n\t\t\t]),\n\t\t\tproviderGroup('ga4', keys.providerNameGa4, [\n\t\t\t\t{\n\t\t\t\t\ttype: 'row',\n\t\t\t\t\tfields: [\n\t\t\t\t\t\ttextField('propertyId', keys.providerFieldPropertyId, '50%'),\n\t\t\t\t\t\ttextField('projectId', keys.providerFieldProjectId, '50%'),\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t\ttextField('clientEmail', keys.providerFieldClientEmail),\n\t\t\t\t...args.buildSecret({\n\t\t\t\t\tname: 'privateKey',\n\t\t\t\t\ttype: 'textarea',\n\t\t\t\t\tlabel: labelForKey(keys.providerFieldPrivateKey),\n\t\t\t\t}),\n\t\t\t]),\n\t\t\tproviderGroup('posthog', keys.providerNamePosthog, [\n\t\t\t\t{\n\t\t\t\t\ttype: 'row',\n\t\t\t\t\tfields: [\n\t\t\t\t\t\ttextField('projectId', keys.providerFieldProjectId, '50%'),\n\t\t\t\t\t\t...secretField(args, { name: 'apiKey', label: keys.providerFieldApiKey, width: '50%' }),\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\ttype: 'row',\n\t\t\t\t\tfields: [\n\t\t\t\t\t\tcaptureField('projectToken', keys.providerFieldProjectToken, '50%'),\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tname: 'region',\n\t\t\t\t\t\t\ttype: 'select',\n\t\t\t\t\t\t\tlabel: labelForKey(keys.providerFieldRegion),\n\t\t\t\t\t\t\toptions: [\n\t\t\t\t\t\t\t\t{ label: 'US', value: 'us' },\n\t\t\t\t\t\t\t\t{ label: 'EU', value: 'eu' },\n\t\t\t\t\t\t\t],\n\t\t\t\t\t\t\tadmin: { width: '50%' },\n\t\t\t\t\t\t},\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t\thostField(),\n\t\t\t]),\n\t\t],\n\t}\n\treturn args.overrides ? args.overrides(collection) : collection\n}\n"],"mappings":";;;;;AAQA,MAAa,iBAAiB;AAc9B,MAAM,aAAa,MAAc,OAAuB,WAA2B;CAClF;CACA,MAAM;CACN,OAAO,YAAY,KAAK;CACxB,GAAI,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC;AACrC;AAEA,MAAM,eACL,MACA,SAEA,KAAK,YAAY;CAChB,MAAM,KAAK;CACX,MAAM;CACN,OAAO,YAAY,KAAK,KAAK;CAC7B,GAAI,KAAK,QAAQ,EAAE,OAAO,EAAE,OAAO,KAAK,MAAM,EAAE,IAAI,CAAC;AACtD,CAAC;;;;;;AAOF,MAAM,gBAAgB,MAAc,OAAuB,WAA2B;CACrF;CACA,MAAM;CACN,OAAO,YAAY,KAAK;CACxB,OAAO;EACN,aAAa,YAAY,KAAK,wBAAwB;EACtD,GAAI,QAAQ,EAAE,MAAM,IAAI,CAAC;CAC1B;AACD;;;;;;AAOA,MAAM,cAAc,SACnB,KAAK,eAAe,UACjB,CACA;CAEC,MAAM;CACN,MAAM;CACN,OAAO;CACP,OAAO,YAAY,KAAK,kBAAkB;CAC1C,OAAO,EAAE,QAAQ,KAAK;AACvB,CACD,IACC,CAAC;AAEL,MAAM,mBAA0B;CAC/B,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,iBAAiB;CACzC,OAAO,EAAE,aAAa,YAAY,KAAK,qBAAqB,EAAE;AAC/D;AAEA,MAAM,iBAAiB,UAAsB,OAAuB,YAA4B;CAC/F,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK;CACxB,OAAO,EAAE,YAAY,SAAS,MAAM,aAAa,SAAS;CAC1D;AACD;;;;;;;AAQA,MAAa,4BAA4B,SAAyD;CACjG,MAAM,aAA+B;EACpC,MAAM,KAAK;EACX,QAAQ;GACP,UAAU,YAAY,KAAK,2BAA2B;GACtD,QAAQ,YAAY,KAAK,yBAAyB;EACnD;EACA,kBAAkB;EAClB,OAAO;GACN,YAAY;GACZ,gBAAgB;IAAC;IAAQ;IAAY;GAAS;GAC9C,OAAO;EACR;EACA,QAAQ;GACP,MAAM,kBAAkB,IAAI;GAC5B,QAAQ,qBAAqB,IAAI;GACjC,QAAQ,kBAAkB,IAAI;GAC9B,QAAQ,kBAAkB,IAAI;GAC9B,GAAG,KAAK;EACT;EACA,OAAO;GACN,cAAc,CAAC,WAAW,IAAI,CAAC;GAC/B,aAAa,EACX,EAAE,UAAU;IACZ,KAAK,SAAS;IACd,OAAO;GACR,CACD;GACA,aAAa,EACX,EAAE,UAAU;IACZ,KAAK,SAAS;IACd,OAAO;GACR,CACD;EACD;EACA,QAAQ;GACP;IACC,MAAM;IACN,MAAM;IACN,UAAU;IACV,OAAO,YAAY,KAAK,iBAAiB;GAC1C;GACA;IACC,MAAM;IACN,QAAQ,CACP;KACC,MAAM;KACN,MAAM;KACN,UAAU;KACV,OAAO,YAAY,KAAK,qBAAqB;KAC7C,SAAS;MACR;OAAE,OAAO,YAAY,KAAK,qBAAqB;OAAG,OAAO;MAAY;MACrE;OAAE,OAAO,YAAY,KAAK,iBAAiB;OAAG,OAAO;MAAQ;MAC7D;OAAE,OAAO,YAAY,KAAK,eAAe;OAAG,OAAO;MAAM;MACzD;OAAE,OAAO,YAAY,KAAK,mBAAmB;OAAG,OAAO;MAAU;KAClE;KACA,OAAO,EAAE,OAAO,MAAM;IACvB,GACA;KACC,MAAM;KACN,MAAM;KACN,cAAc;KACd,OAAO,YAAY,KAAK,oBAAoB;KAC5C,OAAO;MAAE,OAAO;MAAO,OAAO,EAAE,WAAW,WAAW;KAAE;IACzD,CACD;GACD;GACA,GAAG,WAAW,IAAI;GAClB,cAAc,aAAa,KAAK,uBAAuB;IACtD;KACC,MAAM;KACN,QAAQ,CACP,UAAU,UAAU,KAAK,qBAAqB,KAAK,GACnD,GAAG,YAAY,MAAM;MAAE,MAAM;MAAU,OAAO,KAAK;MAAqB,OAAO;KAAM,CAAC,CACvF;IACD;IACA;KACC,MAAM;KACN,QAAQ,CACP,aAAa,UAAU,KAAK,qBAAqB,KAAK,GACtD,aAAa,YAAY,KAAK,uBAAuB,KAAK,CAC3D;IACD;IACA,UAAU;GACX,CAAC;GACD,cAAc,SAAS,KAAK,mBAAmB;IAC9C;KACC,MAAM;KACN,QAAQ,CACP,UAAU,aAAa,KAAK,wBAAwB,KAAK,GACzD,GAAG,YAAY,MAAM;MAAE,MAAM;MAAU,OAAO,KAAK;MAAqB,OAAO;KAAM,CAAC,CACvF;IACD;IACA,GAAG,YAAY,MAAM;KAAE,MAAM;KAAS,OAAO,KAAK;IAAmB,CAAC;IACtE,UAAU;GACX,CAAC;GACD,cAAc,OAAO,KAAK,iBAAiB;IAC1C;KACC,MAAM;KACN,QAAQ,CACP,UAAU,cAAc,KAAK,yBAAyB,KAAK,GAC3D,UAAU,aAAa,KAAK,wBAAwB,KAAK,CAC1D;IACD;IACA,UAAU,eAAe,KAAK,wBAAwB;IACtD,GAAG,KAAK,YAAY;KACnB,MAAM;KACN,MAAM;KACN,OAAO,YAAY,KAAK,uBAAuB;IAChD,CAAC;GACF,CAAC;GACD,cAAc,WAAW,KAAK,qBAAqB;IAClD;KACC,MAAM;KACN,QAAQ,CACP,UAAU,aAAa,KAAK,wBAAwB,KAAK,GACzD,GAAG,YAAY,MAAM;MAAE,MAAM;MAAU,OAAO,KAAK;MAAqB,OAAO;KAAM,CAAC,CACvF;IACD;IACA;KACC,MAAM;KACN,QAAQ,CACP,aAAa,gBAAgB,KAAK,2BAA2B,KAAK,GAClE;MACC,MAAM;MACN,MAAM;MACN,OAAO,YAAY,KAAK,mBAAmB;MAC3C,SAAS,CACR;OAAE,OAAO;OAAM,OAAO;MAAK,GAC3B;OAAE,OAAO;OAAM,OAAO;MAAK,CAC5B;MACA,OAAO,EAAE,OAAO,MAAM;KACvB,CACD;IACD;IACA,UAAU;GACX,CAAC;EACF;CACD;CACA,OAAO,KAAK,YAAY,KAAK,UAAU,UAAU,IAAI;AACtD"}
|
|
@@ -4,6 +4,8 @@ import { posthog } from "../adapters/posthog/posthog.js";
|
|
|
4
4
|
import { umami } from "../adapters/umami/umami.js";
|
|
5
5
|
//#region src/providers/factory.ts
|
|
6
6
|
const orUndefined = (value) => value || void 0;
|
|
7
|
+
/** An unset or unrecognized stored region falls back to host-derived detection. */
|
|
8
|
+
const posthogRegion = (value) => value === "us" || value === "eu" ? value : void 0;
|
|
7
9
|
/**
|
|
8
10
|
* Keys pasted from a service-account JSON often carry escaped newlines; the gRPC
|
|
9
11
|
* client needs real ones.
|
|
@@ -26,7 +28,9 @@ const buildBaseAdapter = (doc) => {
|
|
|
26
28
|
return plausible({
|
|
27
29
|
siteId: cfg.siteId ?? "",
|
|
28
30
|
apiKey: cfg.apiKey ?? "",
|
|
29
|
-
host: orUndefined(cfg.host)
|
|
31
|
+
host: orUndefined(cfg.host),
|
|
32
|
+
domain: orUndefined(cfg.domain),
|
|
33
|
+
scriptId: orUndefined(cfg.scriptId)
|
|
30
34
|
});
|
|
31
35
|
}
|
|
32
36
|
case "umami": {
|
|
@@ -54,7 +58,9 @@ const buildBaseAdapter = (doc) => {
|
|
|
54
58
|
return posthog({
|
|
55
59
|
projectId: cfg.projectId ?? "",
|
|
56
60
|
apiKey: cfg.apiKey ?? "",
|
|
57
|
-
host: orUndefined(cfg.host)
|
|
61
|
+
host: orUndefined(cfg.host),
|
|
62
|
+
projectToken: orUndefined(cfg.projectToken),
|
|
63
|
+
region: posthogRegion(cfg.region)
|
|
58
64
|
});
|
|
59
65
|
}
|
|
60
66
|
default: return null;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"factory.js","names":[],"sources":["../../src/providers/factory.ts"],"sourcesContent":["import { ga4 } from '../adapters/ga4/ga4'\nimport { plausible } from '../adapters/plausible/plausible'\nimport { posthog } from '../adapters/posthog/posthog'\nimport { umami } from '../adapters/umami/umami'\nimport type { AnalyticsAdapter } from '../core/contract'\n\nexport const PROVIDER_IDS = ['plausible', 'umami', 'ga4', 'posthog'] as const\nexport type ProviderId = (typeof PROVIDER_IDS)[number]\n\n/** The provider-settings document shape the adapter factory reads (depth 0, secrets revealed). */\nexport type ProviderDoc = {\n\tid?: number | string\n\tname?: string | null\n\tprovider?: string | null\n\tenabled?: boolean | null\n\tscope?: string | null\n\tplausible?: {
|
|
1
|
+
{"version":3,"file":"factory.js","names":[],"sources":["../../src/providers/factory.ts"],"sourcesContent":["import { ga4 } from '../adapters/ga4/ga4'\nimport { plausible } from '../adapters/plausible/plausible'\nimport { posthog } from '../adapters/posthog/posthog'\nimport { umami } from '../adapters/umami/umami'\nimport type { AnalyticsAdapter } from '../core/contract'\n\nexport const PROVIDER_IDS = ['plausible', 'umami', 'ga4', 'posthog'] as const\nexport type ProviderId = (typeof PROVIDER_IDS)[number]\n\n/** The provider-settings document shape the adapter factory reads (depth 0, secrets revealed). */\nexport type ProviderDoc = {\n\tid?: number | string\n\tname?: string | null\n\tprovider?: string | null\n\tenabled?: boolean | null\n\tscope?: string | null\n\tplausible?: {\n\t\tsiteId?: string | null\n\t\tapiKey?: string | null\n\t\thost?: string | null\n\t\tdomain?: string | null\n\t\tscriptId?: string | null\n\t} | null\n\tumami?: {\n\t\twebsiteId?: string | null\n\t\tapiKey?: string | null\n\t\ttoken?: string | null\n\t\thost?: string | null\n\t} | null\n\tga4?: {\n\t\tpropertyId?: string | null\n\t\tclientEmail?: string | null\n\t\tprivateKey?: string | null\n\t\tprojectId?: string | null\n\t} | null\n\tposthog?: {\n\t\tprojectId?: string | null\n\t\tapiKey?: string | null\n\t\thost?: string | null\n\t\tprojectToken?: string | null\n\t\tregion?: string | null\n\t} | null\n}\n\nconst orUndefined = (value: string | null | undefined): string | undefined => value || undefined\n\n/** An unset or unrecognized stored region falls back to host-derived detection. */\nconst posthogRegion = (value: string | null | undefined): 'us' | 'eu' | undefined =>\n\tvalue === 'us' || value === 'eu' ? value : undefined\n\n/**\n * Keys pasted from a service-account JSON often carry escaped newlines; the gRPC\n * client needs real ones.\n */\nexport const normalizePrivateKey = (key: string): string => key.replace(/\\\\n/g, '\\n')\n\nconst shortId = (id: number | string): string => String(id).slice(-6)\n\n/** Runtime adapters carry a per-document instance id so two projects of one provider type never collide in a registry; config adapters keep their plain ids. */\nconst withInstanceIdentity = (adapter: AnalyticsAdapter, doc: ProviderDoc): AnalyticsAdapter => {\n\tif (doc.id === undefined || doc.id === null || doc.id === '') {\n\t\treturn adapter\n\t}\n\treturn {\n\t\t...adapter,\n\t\tid: `${doc.provider}:${doc.id}`,\n\t\tlabel: doc.name || `${adapter.label} ${shortId(doc.id)}`,\n\t}\n}\n\nconst buildBaseAdapter = (doc: ProviderDoc): AnalyticsAdapter | null => {\n\tswitch (doc.provider) {\n\t\tcase 'plausible': {\n\t\t\tconst cfg = doc.plausible ?? {}\n\t\t\treturn plausible({\n\t\t\t\tsiteId: cfg.siteId ?? '',\n\t\t\t\tapiKey: cfg.apiKey ?? '',\n\t\t\t\thost: orUndefined(cfg.host),\n\t\t\t\tdomain: orUndefined(cfg.domain),\n\t\t\t\tscriptId: orUndefined(cfg.scriptId),\n\t\t\t})\n\t\t}\n\t\tcase 'umami': {\n\t\t\tconst cfg = doc.umami ?? {}\n\t\t\treturn umami({\n\t\t\t\twebsiteId: cfg.websiteId ?? '',\n\t\t\t\tapiKey: orUndefined(cfg.apiKey),\n\t\t\t\ttoken: orUndefined(cfg.token),\n\t\t\t\thost: orUndefined(cfg.host),\n\t\t\t})\n\t\t}\n\t\tcase 'ga4': {\n\t\t\tconst cfg = doc.ga4 ?? {}\n\t\t\treturn ga4({\n\t\t\t\tpropertyId: cfg.propertyId ?? '',\n\t\t\t\tcredentials: {\n\t\t\t\t\tclient_email: cfg.clientEmail ?? '',\n\t\t\t\t\tprivate_key: normalizePrivateKey(cfg.privateKey ?? ''),\n\t\t\t\t},\n\t\t\t\tprojectId: orUndefined(cfg.projectId),\n\t\t\t})\n\t\t}\n\t\tcase 'posthog': {\n\t\t\tconst cfg = doc.posthog ?? {}\n\t\t\treturn posthog({\n\t\t\t\tprojectId: cfg.projectId ?? '',\n\t\t\t\tapiKey: cfg.apiKey ?? '',\n\t\t\t\thost: orUndefined(cfg.host),\n\t\t\t\tprojectToken: orUndefined(cfg.projectToken),\n\t\t\t\tregion: posthogRegion(cfg.region),\n\t\t\t})\n\t\t}\n\t\tdefault:\n\t\t\treturn null\n\t}\n}\n\n/**\n * Build an adapter instance from a provider-settings document using the same\n * constructors as config-time adapters. Missing credentials are passed through as\n * empty strings so the adapter reports `isConfigured() === false` instead of the\n * factory throwing; an unknown provider value returns null and is skipped.\n */\nexport const adapterFromProviderDoc = (doc: ProviderDoc): AnalyticsAdapter | null => {\n\tconst base = buildBaseAdapter(doc)\n\treturn base ? withInstanceIdentity(base, doc) : null\n}\n"],"mappings":";;;;;AA4CA,MAAM,eAAe,UAAyD,SAAS,KAAA;;AAGvF,MAAM,iBAAiB,UACtB,UAAU,QAAQ,UAAU,OAAO,QAAQ,KAAA;;;;;AAM5C,MAAa,uBAAuB,QAAwB,IAAI,QAAQ,QAAQ,IAAI;AAEpF,MAAM,WAAW,OAAgC,OAAO,EAAE,EAAE,MAAM,EAAE;;AAGpE,MAAM,wBAAwB,SAA2B,QAAuC;CAC/F,IAAI,IAAI,OAAO,KAAA,KAAa,IAAI,OAAO,QAAQ,IAAI,OAAO,IACzD,OAAO;CAER,OAAO;EACN,GAAG;EACH,IAAI,GAAG,IAAI,SAAS,GAAG,IAAI;EAC3B,OAAO,IAAI,QAAQ,GAAG,QAAQ,MAAM,GAAG,QAAQ,IAAI,EAAE;CACtD;AACD;AAEA,MAAM,oBAAoB,QAA8C;CACvE,QAAQ,IAAI,UAAZ;EACC,KAAK,aAAa;GACjB,MAAM,MAAM,IAAI,aAAa,CAAC;GAC9B,OAAO,UAAU;IAChB,QAAQ,IAAI,UAAU;IACtB,QAAQ,IAAI,UAAU;IACtB,MAAM,YAAY,IAAI,IAAI;IAC1B,QAAQ,YAAY,IAAI,MAAM;IAC9B,UAAU,YAAY,IAAI,QAAQ;GACnC,CAAC;EACF;EACA,KAAK,SAAS;GACb,MAAM,MAAM,IAAI,SAAS,CAAC;GAC1B,OAAO,MAAM;IACZ,WAAW,IAAI,aAAa;IAC5B,QAAQ,YAAY,IAAI,MAAM;IAC9B,OAAO,YAAY,IAAI,KAAK;IAC5B,MAAM,YAAY,IAAI,IAAI;GAC3B,CAAC;EACF;EACA,KAAK,OAAO;GACX,MAAM,MAAM,IAAI,OAAO,CAAC;GACxB,OAAO,IAAI;IACV,YAAY,IAAI,cAAc;IAC9B,aAAa;KACZ,cAAc,IAAI,eAAe;KACjC,aAAa,oBAAoB,IAAI,cAAc,EAAE;IACtD;IACA,WAAW,YAAY,IAAI,SAAS;GACrC,CAAC;EACF;EACA,KAAK,WAAW;GACf,MAAM,MAAM,IAAI,WAAW,CAAC;GAC5B,OAAO,QAAQ;IACd,WAAW,IAAI,aAAa;IAC5B,QAAQ,IAAI,UAAU;IACtB,MAAM,YAAY,IAAI,IAAI;IAC1B,cAAc,YAAY,IAAI,YAAY;IAC1C,QAAQ,cAAc,IAAI,MAAM;GACjC,CAAC;EACF;EACA,SACC,OAAO;CACT;AACD;;;;;;;AAQA,MAAa,0BAA0B,QAA8C;CACpF,MAAM,OAAO,iBAAiB,GAAG;CACjC,OAAO,OAAO,qBAAqB,MAAM,GAAG,IAAI;AACjD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"resolver.js","names":[],"sources":["../../src/providers/resolver.ts"],"sourcesContent":["import { createLocalReq, type Where } from 'payload'\nimport type { AnalyticsAdapter } from '../core/contract'\nimport {\n\ttype AdapterRegistry,\n\tcreateRegistry,\n\ttype RegistryResolver,\n\ttype ResolveRegistryArgs,\n} from '../core/registry'\nimport { adapterFromProviderDoc, type ProviderDoc } from './factory'\nimport { SECRET_PATHS } from './secrets'\n\nexport const PROVIDERS_CACHE_TTL_MS = 30_000\n\n/** Produces the runtime adapters layered onto the static base for one scope. */\nexport type ProvidersSource = (args: ResolveRegistryArgs) => Promise<AnalyticsAdapter[]>\n\nexport interface RegistryBase {\n\tadapters: AnalyticsAdapter[]\n\tdefaultId?: string\n}\n\n/**\n * Append runtime adapters after the static base. Ids are disjoint by\n * construction (instance ids carry a ':', config ids do not); an extra that\n * still collides with a base id (a custom providers.resolve returning a plain\n * provider id) is skipped so config adapters always win, and the default\n * adapter is always a config adapter.\n */\nexport const combineRegistries = (\n\tbase: RegistryBase,\n\textra: AnalyticsAdapter[]\n): AdapterRegistry => {\n\tif (extra.length === 0) {\n\t\treturn createRegistry(base.adapters, base.defaultId)\n\t}\n\tconst seen = new Set(base.adapters.map((a) => a.id))\n\tconst merged = [...base.adapters]\n\tfor (const adapter of extra) {\n\t\tif (!seen.has(adapter.id)) {\n\t\t\tmerged.push(adapter)\n\t\t\tseen.add(adapter.id)\n\t\t}\n\t}\n\treturn createRegistry(merged, base.defaultId)\n}\n\nconst setAtPath = (doc: Record<string, unknown>, path: string, value: unknown): void => {\n\tconst [group, field] = path.split('.') as [string, string]\n\tconst target = doc[group]\n\tif (target && typeof target === 'object') {\n\t\t;(target as Record<string, unknown>)[field] = value\n\t}\n}\n\nconst getAtPath = (doc: Record<string, unknown>, path: string): unknown => {\n\tconst [group, field] = path.split('.') as [string, string]\n\tconst target = doc[group]\n\treturn target && typeof target === 'object'\n\t\t? (target as Record<string, unknown>)[field]\n\t\t: undefined\n}\n\n/**\n * Look up a scope's enabled provider documents and build adapters from them.\n * Reads raw ciphertext inside a withRawEncrypted window (write-only secrets\n * are stripped from ordinary reads), then decrypts each credential through\n * the fields key ring. Legacy plaintext rows pass through decryptFieldValue\n * unchanged, so pre-encryption documents keep working until re-saved.\n */\nexport const collectionProvidersSource = (slug: string, scopeField: string): ProvidersSource => {\n\treturn async ({ payload, req, scope }) => {\n\t\tconst { decryptFieldValue, withRawEncrypted } = await import('@10x-media/fields/encrypted')\n\t\tconst readReq = req ?? (await createLocalReq({}, payload))\n\t\tconst scopeWhere: Where =\n\t\t\tscope === null\n\t\t\t\t? { or: [{ [scopeField]: { equals: null } }, { [scopeField]: { equals: '' } }] }\n\t\t\t\t: { [scopeField]: { equals: scope } }\n\t\tconst { docs } = await withRawEncrypted(readReq, () =>\n\t\t\tpayload.find({\n\t\t\t\tcollection: slug as never,\n\t\t\t\twhere: { and: [{ enabled: { equals: true } }, scopeWhere] },\n\t\t\t\tlimit: 100,\n\t\t\t\tpagination: false,\n\t\t\t\tdepth: 0,\n\t\t\t\toverrideAccess: true,\n\t\t\t\treq: readReq,\n\t\t\t})\n\t\t)\n\t\tconst adapters: AnalyticsAdapter[] = []\n\t\tfor (const raw of docs as Array<Record<string, unknown>>) {\n\t\t\ttry {\n\t\t\t\tconst doc = structuredClone(raw) as Record<string, unknown>\n\t\t\t\tfor (const { path } of SECRET_PATHS) {\n\t\t\t\t\tconst value = getAtPath(doc, path)\n\t\t\t\t\tif (typeof value === 'string' && value !== '') {\n\t\t\t\t\t\tconst plain = await decryptFieldValue(payload, { collection: slug, path, value })\n\t\t\t\t\t\tsetAtPath(doc, path, typeof plain === 'string' ? plain : '')\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tconst adapter = adapterFromProviderDoc(doc as ProviderDoc)\n\t\t\t\tif (adapter) adapters.push(adapter)\n\t\t\t} catch (err) {\n\t\t\t\t// A corrupted or key-rotated-away ciphertext must not take the whole\n\t\t\t\t// scope's registry down; skip just this document's adapter.\n\t\t\t\tpayload.logger.warn(\n\t\t\t\t\t`analytics: provider document \"${String(raw.id)}\" (${String(raw.provider)}) failed to decrypt, skipping it: ${String(err)}`\n\t\t\t\t)\n\t\t\t}\n\t\t}\n\t\treturn adapters\n\t}\n}\n\nexport interface ScopedRegistryResolver {\n\tresolver: RegistryResolver\n\t/** Drops every cached scope registry; wired to the provider collection's change hooks. */\n\tinvalidate: () => void\n}\n\n/**\n * Cache resolved registries per scope for a short TTL so widget-heavy dashboards\n * do not re-query the provider collection on every read. Invalidation clears all\n * scopes at once: a document's scope binding can itself change, so per-scope\n * eviction could leave a stale entry under the old scope.\n */\nexport const createScopedRegistryResolver = (args: {\n\tbase: RegistryBase\n\tsource: ProvidersSource\n\tttlMs?: number\n}): ScopedRegistryResolver => {\n\tconst ttlMs = args.ttlMs ?? PROVIDERS_CACHE_TTL_MS\n\tconst cache = new Map<string | null, { registry: AdapterRegistry; expiresAt: number }>()\n\treturn {\n\t\tresolver: async (resolveArgs) => {\n\t\t\tconst now = Date.now()\n\t\t\tconst hit = cache.get(resolveArgs.scope)\n\t\t\tif (hit && hit.expiresAt > now) {\n\t\t\t\treturn hit.registry\n\t\t\t}\n\t\t\tconst registry = combineRegistries(args.base, await args.source(resolveArgs))\n\t\t\tcache.set(resolveArgs.scope, { registry, expiresAt: now + ttlMs })\n\t\t\treturn registry\n\t\t},\n\t\tinvalidate: () => cache.clear(),\n\t}\n}\n"],"mappings":";;;;;;;;;;;AA4BA,MAAa,qBACZ,MACA,UACqB;CACrB,IAAI,MAAM,WAAW,GACpB,OAAO,eAAe,KAAK,UAAU,KAAK,SAAS;CAEpD,MAAM,OAAO,IAAI,IAAI,KAAK,SAAS,KAAK,MAAM,EAAE,EAAE,CAAC;CACnD,MAAM,SAAS,CAAC,GAAG,KAAK,QAAQ;CAChC,KAAK,MAAM,WAAW,OACrB,IAAI,CAAC,KAAK,IAAI,QAAQ,EAAE,GAAG;EAC1B,OAAO,KAAK,OAAO;EACnB,KAAK,IAAI,QAAQ,EAAE;CACpB;CAED,OAAO,eAAe,QAAQ,KAAK,SAAS;AAC7C;AAEA,MAAM,aAAa,KAA8B,MAAc,UAAyB;CACvF,MAAM,CAAC,OAAO,SAAS,KAAK,MAAM,GAAG;CACrC,MAAM,SAAS,IAAI;CACnB,IAAI,UAAU,OAAO,WAAW,UAC9B,OAAoC,SAAS;AAEhD;AAEA,MAAM,aAAa,KAA8B,SAA0B;CAC1E,MAAM,CAAC,OAAO,SAAS,KAAK,MAAM,GAAG;CACrC,MAAM,SAAS,IAAI;CACnB,OAAO,UAAU,OAAO,WAAW,WAC/B,OAAmC,SACpC,KAAA;AACJ;;;;;;;;AASA,MAAa,6BAA6B,MAAc,eAAwC;CAC/F,OAAO,OAAO,EAAE,SAAS,KAAK,YAAY;EACzC,MAAM,EAAE,mBAAmB,qBAAqB,MAAM,OAAO;EAC7D,MAAM,UAAU,OAAQ,MAAM,eAAe,CAAC,GAAG,OAAO;
|
|
1
|
+
{"version":3,"file":"resolver.js","names":[],"sources":["../../src/providers/resolver.ts"],"sourcesContent":["import { createLocalReq, type Where } from 'payload'\nimport type { AnalyticsAdapter } from '../core/contract'\nimport {\n\ttype AdapterRegistry,\n\tcreateRegistry,\n\ttype RegistryResolver,\n\ttype ResolveRegistryArgs,\n} from '../core/registry'\nimport { adapterFromProviderDoc, type ProviderDoc } from './factory'\nimport { SECRET_PATHS } from './secrets'\n\nexport const PROVIDERS_CACHE_TTL_MS = 30_000\n\n/** Produces the runtime adapters layered onto the static base for one scope. */\nexport type ProvidersSource = (args: ResolveRegistryArgs) => Promise<AnalyticsAdapter[]>\n\nexport interface RegistryBase {\n\tadapters: AnalyticsAdapter[]\n\tdefaultId?: string\n}\n\n/**\n * Append runtime adapters after the static base. Ids are disjoint by\n * construction (instance ids carry a ':', config ids do not); an extra that\n * still collides with a base id (a custom providers.resolve returning a plain\n * provider id) is skipped so config adapters always win, and the default\n * adapter is always a config adapter.\n */\nexport const combineRegistries = (\n\tbase: RegistryBase,\n\textra: AnalyticsAdapter[]\n): AdapterRegistry => {\n\tif (extra.length === 0) {\n\t\treturn createRegistry(base.adapters, base.defaultId)\n\t}\n\tconst seen = new Set(base.adapters.map((a) => a.id))\n\tconst merged = [...base.adapters]\n\tfor (const adapter of extra) {\n\t\tif (!seen.has(adapter.id)) {\n\t\t\tmerged.push(adapter)\n\t\t\tseen.add(adapter.id)\n\t\t}\n\t}\n\treturn createRegistry(merged, base.defaultId)\n}\n\nconst setAtPath = (doc: Record<string, unknown>, path: string, value: unknown): void => {\n\tconst [group, field] = path.split('.') as [string, string]\n\tconst target = doc[group]\n\tif (target && typeof target === 'object') {\n\t\t;(target as Record<string, unknown>)[field] = value\n\t}\n}\n\nconst getAtPath = (doc: Record<string, unknown>, path: string): unknown => {\n\tconst [group, field] = path.split('.') as [string, string]\n\tconst target = doc[group]\n\treturn target && typeof target === 'object'\n\t\t? (target as Record<string, unknown>)[field]\n\t\t: undefined\n}\n\n/**\n * Look up a scope's enabled provider documents and build adapters from them.\n * Reads raw ciphertext inside a withRawEncrypted window (write-only secrets\n * are stripped from ordinary reads), then decrypts each credential through\n * the fields key ring. Legacy plaintext rows pass through decryptFieldValue\n * unchanged, so pre-encryption documents keep working until re-saved.\n */\nexport const collectionProvidersSource = (slug: string, scopeField: string): ProvidersSource => {\n\treturn async ({ payload, req, scope }) => {\n\t\tconst { decryptFieldValue, withRawEncrypted } = await import('@10x-media/fields/encrypted')\n\t\tconst readReq = req ?? (await createLocalReq({}, payload))\n\t\t// The empty string is not castable on a relationship-typed scopeField, so install-wide\n\t\t// lookups on a host-owned relationship field resolve the config adapters only.\n\t\tconst scopeWhere: Where =\n\t\t\tscope === null\n\t\t\t\t? { or: [{ [scopeField]: { equals: null } }, { [scopeField]: { equals: '' } }] }\n\t\t\t\t: { [scopeField]: { equals: scope } }\n\t\tconst { docs } = await withRawEncrypted(readReq, () =>\n\t\t\tpayload.find({\n\t\t\t\tcollection: slug as never,\n\t\t\t\twhere: { and: [{ enabled: { equals: true } }, scopeWhere] },\n\t\t\t\tlimit: 100,\n\t\t\t\tpagination: false,\n\t\t\t\tdepth: 0,\n\t\t\t\toverrideAccess: true,\n\t\t\t\treq: readReq,\n\t\t\t})\n\t\t)\n\t\tconst adapters: AnalyticsAdapter[] = []\n\t\tfor (const raw of docs as Array<Record<string, unknown>>) {\n\t\t\ttry {\n\t\t\t\tconst doc = structuredClone(raw) as Record<string, unknown>\n\t\t\t\tfor (const { path } of SECRET_PATHS) {\n\t\t\t\t\tconst value = getAtPath(doc, path)\n\t\t\t\t\tif (typeof value === 'string' && value !== '') {\n\t\t\t\t\t\tconst plain = await decryptFieldValue(payload, { collection: slug, path, value })\n\t\t\t\t\t\tsetAtPath(doc, path, typeof plain === 'string' ? plain : '')\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tconst adapter = adapterFromProviderDoc(doc as ProviderDoc)\n\t\t\t\tif (adapter) adapters.push(adapter)\n\t\t\t} catch (err) {\n\t\t\t\t// A corrupted or key-rotated-away ciphertext must not take the whole\n\t\t\t\t// scope's registry down; skip just this document's adapter.\n\t\t\t\tpayload.logger.warn(\n\t\t\t\t\t`analytics: provider document \"${String(raw.id)}\" (${String(raw.provider)}) failed to decrypt, skipping it: ${String(err)}`\n\t\t\t\t)\n\t\t\t}\n\t\t}\n\t\treturn adapters\n\t}\n}\n\nexport interface ScopedRegistryResolver {\n\tresolver: RegistryResolver\n\t/** Drops every cached scope registry; wired to the provider collection's change hooks. */\n\tinvalidate: () => void\n}\n\n/**\n * Cache resolved registries per scope for a short TTL so widget-heavy dashboards\n * do not re-query the provider collection on every read. Invalidation clears all\n * scopes at once: a document's scope binding can itself change, so per-scope\n * eviction could leave a stale entry under the old scope.\n */\nexport const createScopedRegistryResolver = (args: {\n\tbase: RegistryBase\n\tsource: ProvidersSource\n\tttlMs?: number\n}): ScopedRegistryResolver => {\n\tconst ttlMs = args.ttlMs ?? PROVIDERS_CACHE_TTL_MS\n\tconst cache = new Map<string | null, { registry: AdapterRegistry; expiresAt: number }>()\n\treturn {\n\t\tresolver: async (resolveArgs) => {\n\t\t\tconst now = Date.now()\n\t\t\tconst hit = cache.get(resolveArgs.scope)\n\t\t\tif (hit && hit.expiresAt > now) {\n\t\t\t\treturn hit.registry\n\t\t\t}\n\t\t\tconst registry = combineRegistries(args.base, await args.source(resolveArgs))\n\t\t\tcache.set(resolveArgs.scope, { registry, expiresAt: now + ttlMs })\n\t\t\treturn registry\n\t\t},\n\t\tinvalidate: () => cache.clear(),\n\t}\n}\n"],"mappings":";;;;;;;;;;;AA4BA,MAAa,qBACZ,MACA,UACqB;CACrB,IAAI,MAAM,WAAW,GACpB,OAAO,eAAe,KAAK,UAAU,KAAK,SAAS;CAEpD,MAAM,OAAO,IAAI,IAAI,KAAK,SAAS,KAAK,MAAM,EAAE,EAAE,CAAC;CACnD,MAAM,SAAS,CAAC,GAAG,KAAK,QAAQ;CAChC,KAAK,MAAM,WAAW,OACrB,IAAI,CAAC,KAAK,IAAI,QAAQ,EAAE,GAAG;EAC1B,OAAO,KAAK,OAAO;EACnB,KAAK,IAAI,QAAQ,EAAE;CACpB;CAED,OAAO,eAAe,QAAQ,KAAK,SAAS;AAC7C;AAEA,MAAM,aAAa,KAA8B,MAAc,UAAyB;CACvF,MAAM,CAAC,OAAO,SAAS,KAAK,MAAM,GAAG;CACrC,MAAM,SAAS,IAAI;CACnB,IAAI,UAAU,OAAO,WAAW,UAC9B,OAAoC,SAAS;AAEhD;AAEA,MAAM,aAAa,KAA8B,SAA0B;CAC1E,MAAM,CAAC,OAAO,SAAS,KAAK,MAAM,GAAG;CACrC,MAAM,SAAS,IAAI;CACnB,OAAO,UAAU,OAAO,WAAW,WAC/B,OAAmC,SACpC,KAAA;AACJ;;;;;;;;AASA,MAAa,6BAA6B,MAAc,eAAwC;CAC/F,OAAO,OAAO,EAAE,SAAS,KAAK,YAAY;EACzC,MAAM,EAAE,mBAAmB,qBAAqB,MAAM,OAAO;EAC7D,MAAM,UAAU,OAAQ,MAAM,eAAe,CAAC,GAAG,OAAO;EAGxD,MAAM,aACL,UAAU,OACP,EAAE,IAAI,CAAC,GAAG,aAAa,EAAE,QAAQ,KAAK,EAAE,GAAG,GAAG,aAAa,EAAE,QAAQ,GAAG,EAAE,CAAC,EAAE,IAC7E,GAAG,aAAa,EAAE,QAAQ,MAAM,EAAE;EACtC,MAAM,EAAE,SAAS,MAAM,iBAAiB,eACvC,QAAQ,KAAK;GACZ,YAAY;GACZ,OAAO,EAAE,KAAK,CAAC,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,GAAG,UAAU,EAAE;GAC1D,OAAO;GACP,YAAY;GACZ,OAAO;GACP,gBAAgB;GAChB,KAAK;EACN,CAAC,CACF;EACA,MAAM,WAA+B,CAAC;EACtC,KAAK,MAAM,OAAO,MACjB,IAAI;GACH,MAAM,MAAM,gBAAgB,GAAG;GAC/B,KAAK,MAAM,EAAE,UAAU,cAAc;IACpC,MAAM,QAAQ,UAAU,KAAK,IAAI;IACjC,IAAI,OAAO,UAAU,YAAY,UAAU,IAAI;KAC9C,MAAM,QAAQ,MAAM,kBAAkB,SAAS;MAAE,YAAY;MAAM;MAAM;KAAM,CAAC;KAChF,UAAU,KAAK,MAAM,OAAO,UAAU,WAAW,QAAQ,EAAE;IAC5D;GACD;GACA,MAAM,UAAU,uBAAuB,GAAkB;GACzD,IAAI,SAAS,SAAS,KAAK,OAAO;EACnC,SAAS,KAAK;GAGb,QAAQ,OAAO,KACd,iCAAiC,OAAO,IAAI,EAAE,EAAE,KAAK,OAAO,IAAI,QAAQ,EAAE,oCAAoC,OAAO,GAAG,GACzH;EACD;EAED,OAAO;CACR;AACD;;;;;;;AAcA,MAAa,gCAAgC,SAIf;CAC7B,MAAM,QAAQ,KAAK,SAAA;CACnB,MAAM,wBAAQ,IAAI,IAAqE;CACvF,OAAO;EACN,UAAU,OAAO,gBAAgB;GAChC,MAAM,MAAM,KAAK,IAAI;GACrB,MAAM,MAAM,MAAM,IAAI,YAAY,KAAK;GACvC,IAAI,OAAO,IAAI,YAAY,KAC1B,OAAO,IAAI;GAEZ,MAAM,WAAW,kBAAkB,KAAK,MAAM,MAAM,KAAK,OAAO,WAAW,CAAC;GAC5E,MAAM,IAAI,YAAY,OAAO;IAAE;IAAU,WAAW,MAAM;GAAM,CAAC;GACjE,OAAO;EACR;EACA,kBAAkB,MAAM,MAAM;CAC/B;AACD"}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import { addDaysInTz, startOfCalendarDayInTz } from "../timeframe/tz.js";
|
|
2
|
+
//#region src/query/dates.ts
|
|
3
|
+
/**
|
|
4
|
+
* Range-bound parsing, shared by every surface that takes `from`/`to` from outside: the
|
|
5
|
+
* query endpoint's parser, the document panel endpoint, and the widgets' stored custom
|
|
6
|
+
* range. A leaf module so those cannot drift apart on what a calendar day means.
|
|
7
|
+
*/
|
|
8
|
+
/** The only offset-free bound form: a `YYYY-MM-DD` calendar day. */
|
|
9
|
+
const DATE_ONLY = /^\d{4}-\d{2}-\d{2}$/;
|
|
10
|
+
const DATE_TIME = /^(\d{4}-\d{2}-\d{2})T\d{2}:\d{2}(:\d{2}(\.\d{1,9})?)?([Zz]|[+-]\d{2}:\d{2})$/;
|
|
11
|
+
const DAYS_IN_MONTH = [
|
|
12
|
+
31,
|
|
13
|
+
28,
|
|
14
|
+
31,
|
|
15
|
+
30,
|
|
16
|
+
31,
|
|
17
|
+
30,
|
|
18
|
+
31,
|
|
19
|
+
31,
|
|
20
|
+
30,
|
|
21
|
+
31,
|
|
22
|
+
30,
|
|
23
|
+
31
|
|
24
|
+
];
|
|
25
|
+
const isLeapYear = (year) => year % 4 === 0 && year % 100 !== 0 || year % 400 === 0;
|
|
26
|
+
/** Calendar parts of a `YYYY-MM-DD` string, or null when it names no real day. */
|
|
27
|
+
const calendarParts = (raw) => {
|
|
28
|
+
const year = Number(raw.slice(0, 4));
|
|
29
|
+
const month = Number(raw.slice(5, 7));
|
|
30
|
+
const day = Number(raw.slice(8, 10));
|
|
31
|
+
if (month < 1 || month > 12) return null;
|
|
32
|
+
const lastDay = month === 2 && isLeapYear(year) ? 29 : DAYS_IN_MONTH[month - 1];
|
|
33
|
+
if (lastDay === void 0 || day < 1 || day > lastDay) return null;
|
|
34
|
+
return {
|
|
35
|
+
year,
|
|
36
|
+
month,
|
|
37
|
+
day
|
|
38
|
+
};
|
|
39
|
+
};
|
|
40
|
+
/**
|
|
41
|
+
* A range bound. `YYYY-MM-DD` is the whole calendar day in `timezone`: the start edge is
|
|
42
|
+
* its first instant, the end edge its last, matching the inclusive `end` every adapter
|
|
43
|
+
* reads (`less_than_equal`, `timestamp <=`, GA4's inclusive `endDate`). The only other
|
|
44
|
+
* accepted form is a full datetime carrying `Z` or a `±HH:MM` offset, taken as the instant
|
|
45
|
+
* it names. A datetime without an offset is rejected rather than silently read in the
|
|
46
|
+
* server's own zone, and so are the loose forms `Date` would otherwise accept (`2026`,
|
|
47
|
+
* `Sep 1 2026`).
|
|
48
|
+
*/
|
|
49
|
+
const parseDayOrInstant = (raw, args) => {
|
|
50
|
+
if (DATE_ONLY.test(raw)) {
|
|
51
|
+
const ymd = calendarParts(raw);
|
|
52
|
+
if (!ymd) return null;
|
|
53
|
+
const dayStart = startOfCalendarDayInTz(ymd, args.timezone);
|
|
54
|
+
return args.edge === "start" ? dayStart : /* @__PURE__ */ new Date(addDaysInTz(dayStart, 1, args.timezone).getTime() - 1);
|
|
55
|
+
}
|
|
56
|
+
const datePart = DATE_TIME.exec(raw)?.[1];
|
|
57
|
+
if (datePart === void 0 || !calendarParts(datePart)) return null;
|
|
58
|
+
const parsed = new Date(raw);
|
|
59
|
+
return Number.isNaN(parsed.getTime()) ? null : parsed;
|
|
60
|
+
};
|
|
61
|
+
//#endregion
|
|
62
|
+
export { DATE_ONLY, parseDayOrInstant };
|
|
63
|
+
|
|
64
|
+
//# sourceMappingURL=dates.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"dates.js","names":[],"sources":["../../src/query/dates.ts"],"sourcesContent":["import { addDaysInTz, startOfCalendarDayInTz } from '../timeframe/tz'\n\n/**\n * Range-bound parsing, shared by every surface that takes `from`/`to` from outside: the\n * query endpoint's parser, the document panel endpoint, and the widgets' stored custom\n * range. A leaf module so those cannot drift apart on what a calendar day means.\n */\n\n/** The only offset-free bound form: a `YYYY-MM-DD` calendar day. */\nexport const DATE_ONLY = /^\\d{4}-\\d{2}-\\d{2}$/\n\n// Fractional seconds run to nanoseconds because Python emits microseconds; `Date` truncates.\nconst DATE_TIME = /^(\\d{4}-\\d{2}-\\d{2})T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?([Zz]|[+-]\\d{2}:\\d{2})$/\n\nconst DAYS_IN_MONTH = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]\n\nconst isLeapYear = (year: number): boolean =>\n\t(year % 4 === 0 && year % 100 !== 0) || year % 400 === 0\n\n/** Calendar parts of a `YYYY-MM-DD` string, or null when it names no real day. */\nconst calendarParts = (raw: string): { year: number; month: number; day: number } | null => {\n\tconst year = Number(raw.slice(0, 4))\n\tconst month = Number(raw.slice(5, 7))\n\tconst day = Number(raw.slice(8, 10))\n\tif (month < 1 || month > 12) {\n\t\treturn null\n\t}\n\tconst lastDay = month === 2 && isLeapYear(year) ? 29 : DAYS_IN_MONTH[month - 1]\n\tif (lastDay === undefined || day < 1 || day > lastDay) {\n\t\treturn null\n\t}\n\treturn { year, month, day }\n}\n\nexport interface BoundArgs {\n\t/** Reporting timezone a day string is read in; ignored for an instant. */\n\ttimezone: string\n\t/** Which end of the window this value bounds. */\n\tedge: 'start' | 'end'\n}\n\n/**\n * A range bound. `YYYY-MM-DD` is the whole calendar day in `timezone`: the start edge is\n * its first instant, the end edge its last, matching the inclusive `end` every adapter\n * reads (`less_than_equal`, `timestamp <=`, GA4's inclusive `endDate`). The only other\n * accepted form is a full datetime carrying `Z` or a `±HH:MM` offset, taken as the instant\n * it names. A datetime without an offset is rejected rather than silently read in the\n * server's own zone, and so are the loose forms `Date` would otherwise accept (`2026`,\n * `Sep 1 2026`).\n */\nexport const parseDayOrInstant = (raw: string, args: BoundArgs): Date | null => {\n\tif (DATE_ONLY.test(raw)) {\n\t\tconst ymd = calendarParts(raw)\n\t\tif (!ymd) {\n\t\t\treturn null\n\t\t}\n\t\tconst dayStart = startOfCalendarDayInTz(ymd, args.timezone)\n\t\treturn args.edge === 'start'\n\t\t\t? dayStart\n\t\t\t: new Date(addDaysInTz(dayStart, 1, args.timezone).getTime() - 1)\n\t}\n\tconst datePart = DATE_TIME.exec(raw)?.[1]\n\tif (datePart === undefined || !calendarParts(datePart)) {\n\t\treturn null\n\t}\n\tconst parsed = new Date(raw)\n\treturn Number.isNaN(parsed.getTime()) ? null : parsed\n}\n"],"mappings":";;;;;;;;AASA,MAAa,YAAY;AAGzB,MAAM,YAAY;AAElB,MAAM,gBAAgB;CAAC;CAAI;CAAI;CAAI;CAAI;CAAI;CAAI;CAAI;CAAI;CAAI;CAAI;CAAI;AAAE;AAErE,MAAM,cAAc,SAClB,OAAO,MAAM,KAAK,OAAO,QAAQ,KAAM,OAAO,QAAQ;;AAGxD,MAAM,iBAAiB,QAAqE;CAC3F,MAAM,OAAO,OAAO,IAAI,MAAM,GAAG,CAAC,CAAC;CACnC,MAAM,QAAQ,OAAO,IAAI,MAAM,GAAG,CAAC,CAAC;CACpC,MAAM,MAAM,OAAO,IAAI,MAAM,GAAG,EAAE,CAAC;CACnC,IAAI,QAAQ,KAAK,QAAQ,IACxB,OAAO;CAER,MAAM,UAAU,UAAU,KAAK,WAAW,IAAI,IAAI,KAAK,cAAc,QAAQ;CAC7E,IAAI,YAAY,KAAA,KAAa,MAAM,KAAK,MAAM,SAC7C,OAAO;CAER,OAAO;EAAE;EAAM;EAAO;CAAI;AAC3B;;;;;;;;;;AAkBA,MAAa,qBAAqB,KAAa,SAAiC;CAC/E,IAAI,UAAU,KAAK,GAAG,GAAG;EACxB,MAAM,MAAM,cAAc,GAAG;EAC7B,IAAI,CAAC,KACJ,OAAO;EAER,MAAM,WAAW,uBAAuB,KAAK,KAAK,QAAQ;EAC1D,OAAO,KAAK,SAAS,UAClB,2BACA,IAAI,KAAK,YAAY,UAAU,GAAG,KAAK,QAAQ,EAAE,QAAQ,IAAI,CAAC;CAClE;CACA,MAAM,WAAW,UAAU,KAAK,GAAG,IAAI;CACvC,IAAI,aAAa,KAAA,KAAa,CAAC,cAAc,QAAQ,GACpD,OAAO;CAER,MAAM,SAAS,IAAI,KAAK,GAAG;CAC3B,OAAO,OAAO,MAAM,OAAO,QAAQ,CAAC,IAAI,OAAO;AAChD"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
//#region src/query/errors.d.ts
|
|
2
|
+
/**
|
|
3
|
+
* The query endpoint's whole error vocabulary. The parameter parser raises only the
|
|
4
|
+
* `400` codes; the handler raises the rest: `unauthorized` (`401`), `forbidden` (`403`,
|
|
5
|
+
* `access.read` or a cross-scope read the caller may not make), `unknown_source`
|
|
6
|
+
* (`404`), `untrusted_scope` (`400`), `unavailable` (`503`) and `internal` (`500`).
|
|
7
|
+
*/
|
|
8
|
+
type QueryErrorCode = 'invalid_param' | 'unsupported_metric' | 'unsupported_dimension' | 'unsupported_filter' | 'unsupported_operator' | 'unsupported_granularity' | 'range_too_long' | 'unknown_source' | 'untrusted_scope' | 'unauthorized' | 'forbidden' | 'unavailable' | 'internal';
|
|
9
|
+
/** Wire shape of a rejected read: `param` names the query parameter at fault. */
|
|
10
|
+
interface QueryError {
|
|
11
|
+
code: QueryErrorCode;
|
|
12
|
+
message: string;
|
|
13
|
+
param?: string;
|
|
14
|
+
}
|
|
15
|
+
//#endregion
|
|
16
|
+
export { QueryError, QueryErrorCode };
|
|
17
|
+
//# sourceMappingURL=errors.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"errors.js","names":[],"sources":["../../src/query/errors.ts"],"sourcesContent":["/**\n * The query endpoint's whole error vocabulary. The parameter parser raises only the\n * `400` codes; the handler raises the rest: `unauthorized` (`401`), `forbidden` (`403`,\n * `access.read` or a cross-scope read the caller may not make), `unknown_source`\n * (`404`), `untrusted_scope` (`400`), `unavailable` (`503`) and `internal` (`500`).\n */\nexport type QueryErrorCode =\n\t| 'invalid_param'\n\t| 'unsupported_metric'\n\t| 'unsupported_dimension'\n\t| 'unsupported_filter'\n\t| 'unsupported_operator'\n\t| 'unsupported_granularity'\n\t| 'range_too_long'\n\t| 'unknown_source'\n\t| 'untrusted_scope'\n\t| 'unauthorized'\n\t| 'forbidden'\n\t| 'unavailable'\n\t| 'internal'\n\n/** Wire shape of a rejected read: `param` names the query parameter at fault. */\nexport interface QueryError {\n\tcode: QueryErrorCode\n\tmessage: string\n\tparam?: string\n}\n\nexport const queryError = (code: QueryErrorCode, message: string, param?: string): QueryError => ({\n\tcode,\n\tmessage,\n\t...(param === undefined ? {} : { param }),\n})\n"],"mappings":";AA4BA,MAAa,cAAc,MAAsB,SAAiB,WAAgC;CACjG;CACA;CACA,GAAI,UAAU,KAAA,IAAY,CAAC,IAAI,EAAE,MAAM;AACxC"}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import { AnalyticsFilter, DimensionKey, Granularity, MetricKey } from "../core/contract.js";
|
|
2
|
+
import { QueryError } from "./errors.js";
|
|
3
|
+
import { QueryResponse } from "./response.js";
|
|
4
|
+
|
|
5
|
+
//#region src/query/fetchQuery.d.ts
|
|
6
|
+
/** A client-side mirror of the parameters `parseQueryParams` reads off the request. */
|
|
7
|
+
interface QueryRequest {
|
|
8
|
+
metrics: MetricKey[];
|
|
9
|
+
dimensions?: DimensionKey[];
|
|
10
|
+
from: string;
|
|
11
|
+
to: string;
|
|
12
|
+
granularity?: Granularity;
|
|
13
|
+
filters?: AnalyticsFilter[];
|
|
14
|
+
limit?: number;
|
|
15
|
+
order?: {
|
|
16
|
+
metric: MetricKey;
|
|
17
|
+
direction: 'asc' | 'desc';
|
|
18
|
+
};
|
|
19
|
+
compare?: 'previous';
|
|
20
|
+
source?: string;
|
|
21
|
+
/**
|
|
22
|
+
* Read another scope's data. Platform readers only: the endpoint answers
|
|
23
|
+
* `400 untrusted_scope` for any caller that may not read across scopes.
|
|
24
|
+
*/
|
|
25
|
+
scope?: string;
|
|
26
|
+
path?: string;
|
|
27
|
+
hostname?: string;
|
|
28
|
+
timezone?: string;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Builds the query endpoint URL from a fixed field order (not object insertion order),
|
|
32
|
+
* so two `QueryRequest`s with the same values always produce the same URL string. That
|
|
33
|
+
* determinism is what `fetchQuery`'s in-flight dedupe keys on.
|
|
34
|
+
*/
|
|
35
|
+
declare const buildQueryUrl: (apiRoute: string, request: QueryRequest) => string;
|
|
36
|
+
/** Thrown by `fetchQuery` for any non-2xx response; `error` is set only when the body parsed as the endpoint's error shape. */
|
|
37
|
+
declare class QueryFetchError extends Error {
|
|
38
|
+
readonly status: number;
|
|
39
|
+
readonly error?: QueryError;
|
|
40
|
+
readonly retryAfter?: number;
|
|
41
|
+
constructor(status: number, error?: QueryError, retryAfter?: number);
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Fetches `GET /analytics/query`, deduping concurrent identical requests (same URL) into
|
|
45
|
+
* one underlying fetch; the entry clears on settle (success or failure), so a later call
|
|
46
|
+
* always sees fresh data and a failed one retries instead of pinning the error.
|
|
47
|
+
*
|
|
48
|
+
* Dedupe means the shared fetch itself never carries a caller's `AbortSignal`, since
|
|
49
|
+
* aborting it would also cancel every other caller sharing that in-flight request.
|
|
50
|
+
* `init.signal` instead races the caller's own promise against the abort: aborting
|
|
51
|
+
* rejects that caller without touching the shared fetch. Use distinct requests (varying
|
|
52
|
+
* a param) when one caller's cancellation must actually stop the network call.
|
|
53
|
+
*/
|
|
54
|
+
declare const fetchQuery: (apiRoute: string, request: QueryRequest, init?: {
|
|
55
|
+
signal?: AbortSignal;
|
|
56
|
+
}) => Promise<QueryResponse>;
|
|
57
|
+
//#endregion
|
|
58
|
+
export { QueryFetchError, QueryRequest, buildQueryUrl, fetchQuery };
|
|
59
|
+
//# sourceMappingURL=fetchQuery.d.ts.map
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
import { QUERY_PATH } from "../plugin/paths.js";
|
|
2
|
+
//#region src/query/fetchQuery.ts
|
|
3
|
+
/**
|
|
4
|
+
* Builds the query endpoint URL from a fixed field order (not object insertion order),
|
|
5
|
+
* so two `QueryRequest`s with the same values always produce the same URL string. That
|
|
6
|
+
* determinism is what `fetchQuery`'s in-flight dedupe keys on.
|
|
7
|
+
*/
|
|
8
|
+
const buildQueryUrl = (apiRoute, request) => {
|
|
9
|
+
const params = new URLSearchParams();
|
|
10
|
+
params.set("metrics", request.metrics.join(","));
|
|
11
|
+
if (request.dimensions && request.dimensions.length > 0) params.set("dimensions", request.dimensions.join(","));
|
|
12
|
+
params.set("from", request.from);
|
|
13
|
+
params.set("to", request.to);
|
|
14
|
+
if (request.granularity !== void 0) params.set("granularity", request.granularity);
|
|
15
|
+
if (request.filters && request.filters.length > 0) params.set("filters", JSON.stringify(request.filters));
|
|
16
|
+
if (request.limit !== void 0) params.set("limit", String(request.limit));
|
|
17
|
+
if (request.order !== void 0) params.set("order", `${request.order.metric}:${request.order.direction}`);
|
|
18
|
+
if (request.compare !== void 0) params.set("compare", request.compare);
|
|
19
|
+
if (request.source !== void 0) params.set("source", request.source);
|
|
20
|
+
if (request.scope !== void 0) params.set("scope", request.scope);
|
|
21
|
+
if (request.path !== void 0) params.set("path", request.path);
|
|
22
|
+
if (request.hostname !== void 0) params.set("hostname", request.hostname);
|
|
23
|
+
if (request.timezone !== void 0) params.set("timezone", request.timezone);
|
|
24
|
+
return `${apiRoute.endsWith("/") ? apiRoute.slice(0, -1) : apiRoute}${QUERY_PATH}?${params.toString()}`;
|
|
25
|
+
};
|
|
26
|
+
const isRecord = (value) => typeof value === "object" && value !== null;
|
|
27
|
+
/**
|
|
28
|
+
* Only the query endpoint's structured body counts. The plugin's other read endpoints
|
|
29
|
+
* answer a flat `{ "error": "forbidden" }`, which must not land in `QueryFetchError.error`
|
|
30
|
+
* as a string where a `QueryError` is declared.
|
|
31
|
+
*/
|
|
32
|
+
const isQueryErrorResponse = (value) => {
|
|
33
|
+
if (!isRecord(value)) return false;
|
|
34
|
+
const error = value.error;
|
|
35
|
+
return isRecord(error) && typeof error.code === "string" && typeof error.message === "string";
|
|
36
|
+
};
|
|
37
|
+
/** Thrown by `fetchQuery` for any non-2xx response; `error` is set only when the body parsed as the endpoint's error shape. */
|
|
38
|
+
var QueryFetchError = class extends Error {
|
|
39
|
+
status;
|
|
40
|
+
error;
|
|
41
|
+
retryAfter;
|
|
42
|
+
constructor(status, error, retryAfter) {
|
|
43
|
+
super(error?.message ?? `analytics query request failed with status ${status}`);
|
|
44
|
+
this.name = "QueryFetchError";
|
|
45
|
+
this.status = status;
|
|
46
|
+
if (error !== void 0) this.error = error;
|
|
47
|
+
if (retryAfter !== void 0) this.retryAfter = retryAfter;
|
|
48
|
+
}
|
|
49
|
+
};
|
|
50
|
+
const readRetryAfter = (res) => {
|
|
51
|
+
const header = res.headers.get("Retry-After");
|
|
52
|
+
if (header === null) return void 0;
|
|
53
|
+
const seconds = Number(header);
|
|
54
|
+
return Number.isFinite(seconds) ? Math.floor(seconds) : void 0;
|
|
55
|
+
};
|
|
56
|
+
const runFetch = async (url) => {
|
|
57
|
+
const res = await fetch(url, {
|
|
58
|
+
credentials: "include",
|
|
59
|
+
headers: { Accept: "application/json" }
|
|
60
|
+
});
|
|
61
|
+
if (!res.ok) {
|
|
62
|
+
let error;
|
|
63
|
+
try {
|
|
64
|
+
const body = await res.json();
|
|
65
|
+
if (isQueryErrorResponse(body)) error = body.error;
|
|
66
|
+
} catch {}
|
|
67
|
+
throw new QueryFetchError(res.status, error, readRetryAfter(res));
|
|
68
|
+
}
|
|
69
|
+
return await res.json();
|
|
70
|
+
};
|
|
71
|
+
const inFlight = /* @__PURE__ */ new Map();
|
|
72
|
+
/**
|
|
73
|
+
* Fetches `GET /analytics/query`, deduping concurrent identical requests (same URL) into
|
|
74
|
+
* one underlying fetch; the entry clears on settle (success or failure), so a later call
|
|
75
|
+
* always sees fresh data and a failed one retries instead of pinning the error.
|
|
76
|
+
*
|
|
77
|
+
* Dedupe means the shared fetch itself never carries a caller's `AbortSignal`, since
|
|
78
|
+
* aborting it would also cancel every other caller sharing that in-flight request.
|
|
79
|
+
* `init.signal` instead races the caller's own promise against the abort: aborting
|
|
80
|
+
* rejects that caller without touching the shared fetch. Use distinct requests (varying
|
|
81
|
+
* a param) when one caller's cancellation must actually stop the network call.
|
|
82
|
+
*/
|
|
83
|
+
const fetchQuery = (apiRoute, request, init) => {
|
|
84
|
+
const url = buildQueryUrl(apiRoute, request);
|
|
85
|
+
let pending = inFlight.get(url);
|
|
86
|
+
if (!pending) {
|
|
87
|
+
pending = runFetch(url).finally(() => {
|
|
88
|
+
inFlight.delete(url);
|
|
89
|
+
});
|
|
90
|
+
inFlight.set(url, pending);
|
|
91
|
+
}
|
|
92
|
+
const signal = init?.signal;
|
|
93
|
+
if (!signal) return pending;
|
|
94
|
+
if (signal.aborted) return Promise.reject(signal.reason);
|
|
95
|
+
return new Promise((resolve, reject) => {
|
|
96
|
+
const onAbort = () => reject(signal.reason);
|
|
97
|
+
signal.addEventListener("abort", onAbort, { once: true });
|
|
98
|
+
pending.then((value) => {
|
|
99
|
+
signal.removeEventListener("abort", onAbort);
|
|
100
|
+
resolve(value);
|
|
101
|
+
}, (err) => {
|
|
102
|
+
signal.removeEventListener("abort", onAbort);
|
|
103
|
+
reject(err);
|
|
104
|
+
});
|
|
105
|
+
});
|
|
106
|
+
};
|
|
107
|
+
//#endregion
|
|
108
|
+
export { QueryFetchError, buildQueryUrl, fetchQuery };
|
|
109
|
+
|
|
110
|
+
//# sourceMappingURL=fetchQuery.js.map
|