@10x-media/analytics 1.0.0-beta.6 → 1.0.0-beta.7
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 +25 -0
- package/README.md +5 -1
- package/dist/adapters/http/fetchJson.js +1 -1
- package/dist/adapters/plausible/plausible.d.ts +10 -0
- package/dist/adapters/plausible/plausible.js +40 -0
- 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 +43 -0
- package/dist/capture/slots.js.map +1 -0
- package/dist/capture/trackerConfig.d.ts +32 -0
- package/dist/capture/trackerConfig.js +70 -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/core/capture.d.ts +49 -0
- package/dist/core/contract.d.ts +26 -2
- package/dist/core/contract.js.map +1 -1
- package/dist/core/options.d.ts +97 -2
- package/dist/core/options.js +63 -2
- 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 +13 -6
- package/dist/core/scopedRead.js.map +1 -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 +4 -1
- package/dist/exports/rsc.js +3 -1
- package/dist/exports/tracker.d.ts +18 -0
- package/dist/exports/tracker.js +12 -0
- package/dist/exports/types.d.ts +5 -2
- package/dist/fields/AnalyticsPanelClient.js +1 -1
- package/dist/fields/config/narrow.js +2 -0
- package/dist/fields/config/narrow.js.map +1 -1
- package/dist/fields/readForDocument.js +1 -1
- package/dist/goals/match.js +64 -0
- package/dist/goals/match.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/index.d.ts +4 -3
- package/dist/index.js +33 -9
- 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/endpoint.js +40 -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.js +76 -9
- package/dist/native/ingest/normalizeEvent.js.map +1 -1
- package/dist/native/nativeAdapter.js +20 -4
- 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/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/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 +1 -1
- package/dist/plugin/paths.js +11 -1
- package/dist/plugin/paths.js.map +1 -1
- package/dist/plugin/runtime.d.ts +1 -0
- package/dist/plugin/runtime.js.map +1 -1
- package/dist/plugin/sourcesEndpoint.js +16 -4
- 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 +56 -16
- 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/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/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 +6 -0
- package/dist/translations/ar.js.map +1 -1
- package/dist/translations/de.js +6 -0
- package/dist/translations/de.js.map +1 -1
- package/dist/translations/en.js +6 -0
- package/dist/translations/en.js.map +1 -1
- package/dist/translations/es.js +6 -0
- package/dist/translations/es.js.map +1 -1
- package/dist/translations/fr.js +6 -0
- package/dist/translations/fr.js.map +1 -1
- package/dist/translations/id.js +6 -0
- package/dist/translations/id.js.map +1 -1
- package/dist/translations/keys.d.ts +6 -0
- package/dist/translations/keys.js +6 -0
- package/dist/translations/keys.js.map +1 -1
- package/dist/translations/ko.js +6 -0
- package/dist/translations/ko.js.map +1 -1
- package/dist/translations/pt.js +6 -0
- package/dist/translations/pt.js.map +1 -1
- package/dist/translations/ru.js +6 -0
- package/dist/translations/ru.js.map +1 -1
- package/dist/translations/uk.js +6 -0
- package/dist/translations/uk.js.map +1 -1
- package/dist/translations/zh.js +6 -0
- package/dist/translations/zh.js.map +1 -1
- package/dist/widgets/breakdownTypes.js +5 -0
- package/dist/widgets/breakdownTypes.js.map +1 -1
- package/dist/widgets/readForWidget.js +24 -14
- package/dist/widgets/readForWidget.js.map +1 -1
- package/dist/widgets/readForWidgetBreakdown.js +23 -14
- package/dist/widgets/readForWidgetBreakdown.js.map +1 -1
- package/dist/widgets/readForWidgetRealtime.js +1 -1
- package/dist/widgets/readForWidgetSeries.js +26 -16
- package/dist/widgets/readForWidgetSeries.js.map +1 -1
- package/dist/widgets/registerWidgets.js +10 -4
- package/dist/widgets/registerWidgets.js.map +1 -1
- package/dist/widgets/types.js +4 -1
- package/dist/widgets/types.js.map +1 -1
- package/package.json +21 -6
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { satisfiesCapabilities } from "../core/capabilities.js";
|
|
2
1
|
import { getRuntime, resolveTimezoneFor } from "../plugin/runtime.js";
|
|
2
|
+
import { satisfiesCapabilities } from "../core/capabilities.js";
|
|
3
3
|
import { resolveReadContext } from "../core/scopedRead.js";
|
|
4
4
|
import { resolveTimeframe } from "../timeframe/presets.js";
|
|
5
5
|
import { previousWindow } from "./comparison.js";
|
|
@@ -50,19 +50,29 @@ const readForWidget = async (args) => {
|
|
|
50
50
|
...base
|
|
51
51
|
};
|
|
52
52
|
const comparisonRange = runtime.comparison && adapter.capabilities.comparison ? previousWindow(dateRange, tz) ?? void 0 : void 0;
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
53
|
+
let result;
|
|
54
|
+
let previous;
|
|
55
|
+
try {
|
|
56
|
+
[result, previous] = await Promise.all([runtime.engine.read(adapter, {
|
|
57
|
+
metrics,
|
|
58
|
+
dateRange,
|
|
59
|
+
filters,
|
|
60
|
+
timezone: tz,
|
|
61
|
+
scope: ctx.queryScope
|
|
62
|
+
}), comparisonRange ? runtime.engine.read(adapter, {
|
|
63
|
+
metrics,
|
|
64
|
+
dateRange: comparisonRange,
|
|
65
|
+
filters,
|
|
66
|
+
timezone: tz,
|
|
67
|
+
scope: ctx.queryScope
|
|
68
|
+
}) : void 0]);
|
|
69
|
+
} catch {
|
|
70
|
+
return {
|
|
71
|
+
status: "unavailable",
|
|
72
|
+
adapterId: adapter.id,
|
|
73
|
+
...base
|
|
74
|
+
};
|
|
75
|
+
}
|
|
66
76
|
const previousMetrics = previous ? previous.totals ?? {} : void 0;
|
|
67
77
|
return {
|
|
68
78
|
status: "ok",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"readForWidget.js","names":[],"sources":["../../src/widgets/readForWidget.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\nimport { satisfiesCapabilities } from '../core/capabilities'\nimport type {
|
|
1
|
+
{"version":3,"file":"readForWidget.js","names":[],"sources":["../../src/widgets/readForWidget.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\nimport { satisfiesCapabilities } from '../core/capabilities'\nimport type {\n\tAnalyticsAdapter,\n\tAnalyticsFilter,\n\tAnalyticsResult,\n\tDateRange,\n\tMetricKey,\n} from '../core/contract'\nimport { resolveReadContext } from '../core/scopedRead'\nimport { getRuntime, resolveTimezoneFor } from '../plugin/runtime'\nimport { resolveTimeframe, type TimeframePreset } from '../timeframe/presets'\nimport { previousWindow } from './comparison'\n\nexport type WidgetReadStatus = 'ok' | 'not-configured' | 'unavailable'\n\nexport interface WidgetReadResult {\n\tstatus: WidgetReadStatus\n\tadapterId: string\n\tdateRange: DateRange\n\tmetrics: Partial<Record<MetricKey, number>>\n\tclamped?: boolean\n\t/** Previous-window totals, present only when the adapter supports comparison. */\n\tpreviousMetrics?: Partial<Record<MetricKey, number>>\n\t/** The previous comparable window, present only when comparison ran. */\n\tcomparisonRange?: DateRange\n}\n\nexport interface ReadForWidgetArgs {\n\treq: PayloadRequest\n\tmetrics: MetricKey[]\n\ttimeframe: TimeframePreset\n\tadapterId?: string\n\tnow: Date\n\trange?: DateRange\n\t/** Explicit scope override; omitted resolves via the plugin's scopeResolver. */\n\tscope?: string | null\n\tfilters?: AnalyticsFilter[]\n}\n\nexport const readForWidget = async (args: ReadForWidgetArgs): Promise<WidgetReadResult> => {\n\tconst { req, metrics, timeframe, adapterId, now, range, filters } = args\n\tconst emptyMetrics = {} as Partial<Record<MetricKey, number>>\n\n\tconst runtime = getRuntime(req.payload)\n\tif (!runtime) {\n\t\treturn {\n\t\t\tstatus: 'unavailable',\n\t\t\tadapterId: adapterId ?? '',\n\t\t\tdateRange: range ?? resolveTimeframe(timeframe, now),\n\t\t\tmetrics: emptyMetrics,\n\t\t}\n\t}\n\tconst ctx = await resolveReadContext({ runtime, req, adapterId, scope: args.scope })\n\tif (!ctx.ok) {\n\t\treturn {\n\t\t\tstatus: 'unavailable',\n\t\t\tadapterId: adapterId ?? '',\n\t\t\tdateRange: range ?? resolveTimeframe(timeframe, now),\n\t\t\tmetrics: emptyMetrics,\n\t\t}\n\t}\n\tconst tz = await resolveTimezoneFor(runtime, req, ctx.scope)\n\tconst dateRange = range ?? resolveTimeframe(timeframe, now, tz)\n\tconst base = { dateRange, metrics: emptyMetrics }\n\tconst adapter: AnalyticsAdapter = ctx.adapter\n\tif (!adapter.isConfigured()) {\n\t\treturn { status: 'not-configured', adapterId: adapter.id, ...base }\n\t}\n\tif (\n\t\t!satisfiesCapabilities(adapter.capabilities, {\n\t\t\tmetrics,\n\t\t\t...(filters && filters.length > 0\n\t\t\t\t? {\n\t\t\t\t\t\tfilters: filters.map((f) => f.dimension),\n\t\t\t\t\t\tfilterOperators: filters.map((f) => f.operator),\n\t\t\t\t\t}\n\t\t\t\t: {}),\n\t\t})\n\t) {\n\t\treturn { status: 'unavailable', adapterId: adapter.id, ...base }\n\t}\n\tconst comparisonRange =\n\t\truntime.comparison && adapter.capabilities.comparison\n\t\t\t? (previousWindow(dateRange, tz) ?? undefined)\n\t\t\t: undefined\n\tlet result: AnalyticsResult\n\tlet previous: AnalyticsResult | undefined\n\ttry {\n\t\t;[result, previous] = await Promise.all([\n\t\t\truntime.engine.read(adapter, {\n\t\t\t\tmetrics,\n\t\t\t\tdateRange,\n\t\t\t\tfilters,\n\t\t\t\ttimezone: tz,\n\t\t\t\tscope: ctx.queryScope,\n\t\t\t}),\n\t\t\tcomparisonRange\n\t\t\t\t? runtime.engine.read(adapter, {\n\t\t\t\t\t\tmetrics,\n\t\t\t\t\t\tdateRange: comparisonRange,\n\t\t\t\t\t\tfilters,\n\t\t\t\t\t\ttimezone: tz,\n\t\t\t\t\t\tscope: ctx.queryScope,\n\t\t\t\t\t})\n\t\t\t\t: undefined,\n\t\t])\n\t} catch {\n\t\t// No cache entry (fresh or stale) survived the failed read; degrade like an\n\t\t// unsupported capability instead of throwing through the widget render tree.\n\t\treturn { status: 'unavailable', adapterId: adapter.id, ...base }\n\t}\n\tconst previousMetrics = previous ? (previous.totals ?? {}) : undefined\n\treturn {\n\t\tstatus: 'ok',\n\t\tadapterId: adapter.id,\n\t\tdateRange,\n\t\tmetrics: result.totals ?? {},\n\t\tclamped: result.meta.clamped ?? false,\n\t\tpreviousMetrics,\n\t\tcomparisonRange,\n\t}\n}\n"],"mappings":";;;;;;AAwCA,MAAa,gBAAgB,OAAO,SAAuD;CAC1F,MAAM,EAAE,KAAK,SAAS,WAAW,WAAW,KAAK,OAAO,YAAY;CACpE,MAAM,eAAe,CAAC;CAEtB,MAAM,UAAU,WAAW,IAAI,OAAO;CACtC,IAAI,CAAC,SACJ,OAAO;EACN,QAAQ;EACR,WAAW,aAAa;EACxB,WAAW,SAAS,iBAAiB,WAAW,GAAG;EACnD,SAAS;CACV;CAED,MAAM,MAAM,MAAM,mBAAmB;EAAE;EAAS;EAAK;EAAW,OAAO,KAAK;CAAM,CAAC;CACnF,IAAI,CAAC,IAAI,IACR,OAAO;EACN,QAAQ;EACR,WAAW,aAAa;EACxB,WAAW,SAAS,iBAAiB,WAAW,GAAG;EACnD,SAAS;CACV;CAED,MAAM,KAAK,MAAM,mBAAmB,SAAS,KAAK,IAAI,KAAK;CAC3D,MAAM,YAAY,SAAS,iBAAiB,WAAW,KAAK,EAAE;CAC9D,MAAM,OAAO;EAAE;EAAW,SAAS;CAAa;CAChD,MAAM,UAA4B,IAAI;CACtC,IAAI,CAAC,QAAQ,aAAa,GACzB,OAAO;EAAE,QAAQ;EAAkB,WAAW,QAAQ;EAAI,GAAG;CAAK;CAEnE,IACC,CAAC,sBAAsB,QAAQ,cAAc;EAC5C;EACA,GAAI,WAAW,QAAQ,SAAS,IAC7B;GACA,SAAS,QAAQ,KAAK,MAAM,EAAE,SAAS;GACvC,iBAAiB,QAAQ,KAAK,MAAM,EAAE,QAAQ;EAC/C,IACC,CAAC;CACL,CAAC,GAED,OAAO;EAAE,QAAQ;EAAe,WAAW,QAAQ;EAAI,GAAG;CAAK;CAEhE,MAAM,kBACL,QAAQ,cAAc,QAAQ,aAAa,aACvC,eAAe,WAAW,EAAE,KAAK,KAAA,IAClC,KAAA;CACJ,IAAI;CACJ,IAAI;CACJ,IAAI;EACF,CAAC,QAAQ,YAAY,MAAM,QAAQ,IAAI,CACvC,QAAQ,OAAO,KAAK,SAAS;GAC5B;GACA;GACA;GACA,UAAU;GACV,OAAO,IAAI;EACZ,CAAC,GACD,kBACG,QAAQ,OAAO,KAAK,SAAS;GAC7B;GACA,WAAW;GACX;GACA,UAAU;GACV,OAAO,IAAI;EACZ,CAAC,IACA,KAAA,CACJ,CAAC;CACF,QAAQ;EAGP,OAAO;GAAE,QAAQ;GAAe,WAAW,QAAQ;GAAI,GAAG;EAAK;CAChE;CACA,MAAM,kBAAkB,WAAY,SAAS,UAAU,CAAC,IAAK,KAAA;CAC7D,OAAO;EACN,QAAQ;EACR,WAAW,QAAQ;EACnB;EACA,SAAS,OAAO,UAAU,CAAC;EAC3B,SAAS,OAAO,KAAK,WAAW;EAChC;EACA;CACD;AACD"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { satisfiesCapabilities } from "../core/capabilities.js";
|
|
2
1
|
import { getRuntime, resolveTimezoneFor } from "../plugin/runtime.js";
|
|
2
|
+
import { satisfiesCapabilities } from "../core/capabilities.js";
|
|
3
3
|
import { resolveReadContext } from "../core/scopedRead.js";
|
|
4
4
|
import { resolveTimeframe } from "../timeframe/presets.js";
|
|
5
5
|
//#region src/widgets/readForWidgetBreakdown.ts
|
|
@@ -54,19 +54,28 @@ const readForWidgetBreakdown = async (args) => {
|
|
|
54
54
|
adapterId: adapter.id,
|
|
55
55
|
...base
|
|
56
56
|
};
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
57
|
+
let result;
|
|
58
|
+
try {
|
|
59
|
+
result = await runtime.engine.read(adapter, {
|
|
60
|
+
metrics: [metric],
|
|
61
|
+
dimensions: [dimension],
|
|
62
|
+
dateRange,
|
|
63
|
+
limit,
|
|
64
|
+
order: {
|
|
65
|
+
metric,
|
|
66
|
+
direction: "desc"
|
|
67
|
+
},
|
|
68
|
+
filters,
|
|
69
|
+
timezone: tz,
|
|
70
|
+
scope: ctx.queryScope
|
|
71
|
+
});
|
|
72
|
+
} catch {
|
|
73
|
+
return {
|
|
74
|
+
status: "unavailable",
|
|
75
|
+
adapterId: adapter.id,
|
|
76
|
+
...base
|
|
77
|
+
};
|
|
78
|
+
}
|
|
70
79
|
const rows = result.rows.map((row) => ({
|
|
71
80
|
label: row.dimensions?.[dimension] ?? "(none)",
|
|
72
81
|
value: row.metrics[metric] ?? 0
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"readForWidgetBreakdown.js","names":[],"sources":["../../src/widgets/readForWidgetBreakdown.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\nimport { satisfiesCapabilities } from '../core/capabilities'\nimport type {\n\tAnalyticsAdapter,\n\tAnalyticsFilter,\n\tDateRange,\n\tDimensionKey,\n\tMetricKey,\n} from '../core/contract'\nimport { resolveReadContext } from '../core/scopedRead'\nimport { getRuntime, resolveTimezoneFor } from '../plugin/runtime'\nimport { resolveTimeframe, type TimeframePreset } from '../timeframe/presets'\nimport type { WidgetReadStatus } from './readForWidget'\n\nexport interface BreakdownRow {\n\tlabel: string\n\tvalue: number\n}\n\nexport interface WidgetBreakdownResult {\n\tstatus: WidgetReadStatus\n\tadapterId: string\n\tdateRange: DateRange\n\trows: BreakdownRow[]\n\tclamped?: boolean\n}\n\nexport interface ReadForWidgetBreakdownArgs {\n\treq: PayloadRequest\n\tmetric: MetricKey\n\tdimension: DimensionKey\n\ttimeframe: TimeframePreset\n\tlimit: number\n\tadapterId?: string\n\tnow: Date\n\trange?: DateRange\n\t/** Explicit scope override; omitted resolves via the plugin's scopeResolver. */\n\tscope?: string | null\n\tfilters?: AnalyticsFilter[]\n}\n\n/**\n * Site-wide ranked breakdown of one metric by one dimension, read through the engine.\n * Mirrors `readForWidget` but gates on the dimension too and maps each result row to a\n * `{ label, value }` pair the bar list renders. The adapter owns sorting and limiting.\n */\nexport const readForWidgetBreakdown = async (\n\targs: ReadForWidgetBreakdownArgs\n): Promise<WidgetBreakdownResult> => {\n\tconst { req, metric, dimension, timeframe, limit, adapterId, now, range, filters } = args\n\tconst emptyRows = [] as BreakdownRow[]\n\n\tconst runtime = getRuntime(req.payload)\n\tif (!runtime) {\n\t\treturn {\n\t\t\tstatus: 'unavailable',\n\t\t\tadapterId: adapterId ?? '',\n\t\t\tdateRange: range ?? resolveTimeframe(timeframe, now),\n\t\t\trows: emptyRows,\n\t\t}\n\t}\n\tconst ctx = await resolveReadContext({ runtime, req, adapterId, scope: args.scope })\n\tif (!ctx.ok) {\n\t\treturn {\n\t\t\tstatus: 'unavailable',\n\t\t\tadapterId: adapterId ?? '',\n\t\t\tdateRange: range ?? resolveTimeframe(timeframe, now),\n\t\t\trows: emptyRows,\n\t\t}\n\t}\n\tconst tz = await resolveTimezoneFor(runtime, req, ctx.scope)\n\tconst dateRange = range ?? resolveTimeframe(timeframe, now, tz)\n\tconst base = { dateRange, rows: emptyRows }\n\tconst adapter: AnalyticsAdapter = ctx.adapter\n\tif (!adapter.isConfigured()) {\n\t\treturn { status: 'not-configured', adapterId: adapter.id, ...base }\n\t}\n\tif (\n\t\t!satisfiesCapabilities(adapter.capabilities, {\n\t\t\tmetrics: [metric],\n\t\t\tdimensions: [dimension],\n\t\t\t...(filters && filters.length > 0\n\t\t\t\t? {\n\t\t\t\t\t\tfilters: filters.map((f) => f.dimension),\n\t\t\t\t\t\tfilterOperators: filters.map((f) => f.operator),\n\t\t\t\t\t}\n\t\t\t\t: {}),\n\t\t})\n\t) {\n\t\treturn { status: 'unavailable', adapterId: adapter.id, ...base }\n\t}\n\
|
|
1
|
+
{"version":3,"file":"readForWidgetBreakdown.js","names":[],"sources":["../../src/widgets/readForWidgetBreakdown.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\nimport { satisfiesCapabilities } from '../core/capabilities'\nimport type {\n\tAnalyticsAdapter,\n\tAnalyticsFilter,\n\tAnalyticsResult,\n\tDateRange,\n\tDimensionKey,\n\tMetricKey,\n} from '../core/contract'\nimport { resolveReadContext } from '../core/scopedRead'\nimport { getRuntime, resolveTimezoneFor } from '../plugin/runtime'\nimport { resolveTimeframe, type TimeframePreset } from '../timeframe/presets'\nimport type { WidgetReadStatus } from './readForWidget'\n\nexport interface BreakdownRow {\n\tlabel: string\n\tvalue: number\n}\n\nexport interface WidgetBreakdownResult {\n\tstatus: WidgetReadStatus\n\tadapterId: string\n\tdateRange: DateRange\n\trows: BreakdownRow[]\n\tclamped?: boolean\n}\n\nexport interface ReadForWidgetBreakdownArgs {\n\treq: PayloadRequest\n\tmetric: MetricKey\n\tdimension: DimensionKey\n\ttimeframe: TimeframePreset\n\tlimit: number\n\tadapterId?: string\n\tnow: Date\n\trange?: DateRange\n\t/** Explicit scope override; omitted resolves via the plugin's scopeResolver. */\n\tscope?: string | null\n\tfilters?: AnalyticsFilter[]\n}\n\n/**\n * Site-wide ranked breakdown of one metric by one dimension, read through the engine.\n * Mirrors `readForWidget` but gates on the dimension too and maps each result row to a\n * `{ label, value }` pair the bar list renders. The adapter owns sorting and limiting.\n */\nexport const readForWidgetBreakdown = async (\n\targs: ReadForWidgetBreakdownArgs\n): Promise<WidgetBreakdownResult> => {\n\tconst { req, metric, dimension, timeframe, limit, adapterId, now, range, filters } = args\n\tconst emptyRows = [] as BreakdownRow[]\n\n\tconst runtime = getRuntime(req.payload)\n\tif (!runtime) {\n\t\treturn {\n\t\t\tstatus: 'unavailable',\n\t\t\tadapterId: adapterId ?? '',\n\t\t\tdateRange: range ?? resolveTimeframe(timeframe, now),\n\t\t\trows: emptyRows,\n\t\t}\n\t}\n\tconst ctx = await resolveReadContext({ runtime, req, adapterId, scope: args.scope })\n\tif (!ctx.ok) {\n\t\treturn {\n\t\t\tstatus: 'unavailable',\n\t\t\tadapterId: adapterId ?? '',\n\t\t\tdateRange: range ?? resolveTimeframe(timeframe, now),\n\t\t\trows: emptyRows,\n\t\t}\n\t}\n\tconst tz = await resolveTimezoneFor(runtime, req, ctx.scope)\n\tconst dateRange = range ?? resolveTimeframe(timeframe, now, tz)\n\tconst base = { dateRange, rows: emptyRows }\n\tconst adapter: AnalyticsAdapter = ctx.adapter\n\tif (!adapter.isConfigured()) {\n\t\treturn { status: 'not-configured', adapterId: adapter.id, ...base }\n\t}\n\tif (\n\t\t!satisfiesCapabilities(adapter.capabilities, {\n\t\t\tmetrics: [metric],\n\t\t\tdimensions: [dimension],\n\t\t\t...(filters && filters.length > 0\n\t\t\t\t? {\n\t\t\t\t\t\tfilters: filters.map((f) => f.dimension),\n\t\t\t\t\t\tfilterOperators: filters.map((f) => f.operator),\n\t\t\t\t\t}\n\t\t\t\t: {}),\n\t\t})\n\t) {\n\t\treturn { status: 'unavailable', adapterId: adapter.id, ...base }\n\t}\n\tlet result: AnalyticsResult\n\ttry {\n\t\tresult = await runtime.engine.read(adapter, {\n\t\t\tmetrics: [metric],\n\t\t\tdimensions: [dimension],\n\t\t\tdateRange,\n\t\t\tlimit,\n\t\t\torder: { metric, direction: 'desc' },\n\t\t\tfilters,\n\t\t\ttimezone: tz,\n\t\t\tscope: ctx.queryScope,\n\t\t})\n\t} catch {\n\t\t// No cache entry (fresh or stale) survived the failed read; degrade like an\n\t\t// unsupported capability instead of throwing through the widget render tree.\n\t\treturn { status: 'unavailable', adapterId: adapter.id, ...base }\n\t}\n\tconst rows = result.rows.map((row) => ({\n\t\tlabel: row.dimensions?.[dimension] ?? '(none)',\n\t\tvalue: row.metrics[metric] ?? 0,\n\t}))\n\treturn {\n\t\tstatus: 'ok',\n\t\tadapterId: adapter.id,\n\t\tdateRange,\n\t\trows,\n\t\tclamped: result.meta.clamped ?? false,\n\t}\n}\n"],"mappings":";;;;;;;;;;AA+CA,MAAa,yBAAyB,OACrC,SACoC;CACpC,MAAM,EAAE,KAAK,QAAQ,WAAW,WAAW,OAAO,WAAW,KAAK,OAAO,YAAY;CACrF,MAAM,YAAY,CAAC;CAEnB,MAAM,UAAU,WAAW,IAAI,OAAO;CACtC,IAAI,CAAC,SACJ,OAAO;EACN,QAAQ;EACR,WAAW,aAAa;EACxB,WAAW,SAAS,iBAAiB,WAAW,GAAG;EACnD,MAAM;CACP;CAED,MAAM,MAAM,MAAM,mBAAmB;EAAE;EAAS;EAAK;EAAW,OAAO,KAAK;CAAM,CAAC;CACnF,IAAI,CAAC,IAAI,IACR,OAAO;EACN,QAAQ;EACR,WAAW,aAAa;EACxB,WAAW,SAAS,iBAAiB,WAAW,GAAG;EACnD,MAAM;CACP;CAED,MAAM,KAAK,MAAM,mBAAmB,SAAS,KAAK,IAAI,KAAK;CAC3D,MAAM,YAAY,SAAS,iBAAiB,WAAW,KAAK,EAAE;CAC9D,MAAM,OAAO;EAAE;EAAW,MAAM;CAAU;CAC1C,MAAM,UAA4B,IAAI;CACtC,IAAI,CAAC,QAAQ,aAAa,GACzB,OAAO;EAAE,QAAQ;EAAkB,WAAW,QAAQ;EAAI,GAAG;CAAK;CAEnE,IACC,CAAC,sBAAsB,QAAQ,cAAc;EAC5C,SAAS,CAAC,MAAM;EAChB,YAAY,CAAC,SAAS;EACtB,GAAI,WAAW,QAAQ,SAAS,IAC7B;GACA,SAAS,QAAQ,KAAK,MAAM,EAAE,SAAS;GACvC,iBAAiB,QAAQ,KAAK,MAAM,EAAE,QAAQ;EAC/C,IACC,CAAC;CACL,CAAC,GAED,OAAO;EAAE,QAAQ;EAAe,WAAW,QAAQ;EAAI,GAAG;CAAK;CAEhE,IAAI;CACJ,IAAI;EACH,SAAS,MAAM,QAAQ,OAAO,KAAK,SAAS;GAC3C,SAAS,CAAC,MAAM;GAChB,YAAY,CAAC,SAAS;GACtB;GACA;GACA,OAAO;IAAE;IAAQ,WAAW;GAAO;GACnC;GACA,UAAU;GACV,OAAO,IAAI;EACZ,CAAC;CACF,QAAQ;EAGP,OAAO;GAAE,QAAQ;GAAe,WAAW,QAAQ;GAAI,GAAG;EAAK;CAChE;CACA,MAAM,OAAO,OAAO,KAAK,KAAK,SAAS;EACtC,OAAO,IAAI,aAAa,cAAc;EACtC,OAAO,IAAI,QAAQ,WAAW;CAC/B,EAAE;CACF,OAAO;EACN,QAAQ;EACR,WAAW,QAAQ;EACnB;EACA;EACA,SAAS,OAAO,KAAK,WAAW;CACjC;AACD"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { satisfiesCapabilities } from "../core/capabilities.js";
|
|
2
1
|
import { getRuntime } from "../plugin/runtime.js";
|
|
2
|
+
import { satisfiesCapabilities } from "../core/capabilities.js";
|
|
3
3
|
import { resolveReadContext } from "../core/scopedRead.js";
|
|
4
4
|
import { kvCacheStore } from "../surfacing/cacheStore.js";
|
|
5
5
|
//#region src/widgets/readForWidgetRealtime.ts
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { satisfiesCapabilities } from "../core/capabilities.js";
|
|
2
|
-
import { supportsGranularity } from "../core/granularity.js";
|
|
3
1
|
import { addDaysInTz, startOfDayInTz, zonedDayIso } from "../timeframe/tz.js";
|
|
4
2
|
import { getRuntime, resolveTimezoneFor } from "../plugin/runtime.js";
|
|
3
|
+
import { satisfiesCapabilities } from "../core/capabilities.js";
|
|
4
|
+
import { supportsGranularity } from "../core/granularity.js";
|
|
5
5
|
import { resolveReadContext } from "../core/scopedRead.js";
|
|
6
6
|
import { resolveTimeframe } from "../timeframe/presets.js";
|
|
7
7
|
import { previousWindow } from "./comparison.js";
|
|
@@ -87,20 +87,30 @@ const readForWidgetSeries = async (args) => {
|
|
|
87
87
|
...base
|
|
88
88
|
};
|
|
89
89
|
const comparisonRange = runtime.comparison && adapter.capabilities.comparison ? previousWindow(dateRange, tz) ?? void 0 : void 0;
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
90
|
+
let result;
|
|
91
|
+
let previous;
|
|
92
|
+
try {
|
|
93
|
+
[result, previous] = await Promise.all([runtime.engine.read(adapter, {
|
|
94
|
+
metrics: [metric],
|
|
95
|
+
dateRange,
|
|
96
|
+
granularity: "day",
|
|
97
|
+
filters,
|
|
98
|
+
timezone: tz,
|
|
99
|
+
scope: ctx.queryScope
|
|
100
|
+
}), comparisonRange ? runtime.engine.read(adapter, {
|
|
101
|
+
metrics: [metric],
|
|
102
|
+
dateRange: comparisonRange,
|
|
103
|
+
filters,
|
|
104
|
+
timezone: tz,
|
|
105
|
+
scope: ctx.queryScope
|
|
106
|
+
}) : void 0]);
|
|
107
|
+
} catch {
|
|
108
|
+
return {
|
|
109
|
+
status: "unavailable",
|
|
110
|
+
adapterId: adapter.id,
|
|
111
|
+
...base
|
|
112
|
+
};
|
|
113
|
+
}
|
|
104
114
|
const previousTotal = previous ? previous.totals?.[metric] : void 0;
|
|
105
115
|
return {
|
|
106
116
|
status: "ok",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"readForWidgetSeries.js","names":[],"sources":["../../src/widgets/readForWidgetSeries.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\nimport { satisfiesCapabilities } from '../core/capabilities'\nimport type {\n\tAnalyticsAdapter,\n\tAnalyticsFilter,\n\tAnalyticsRow,\n\tDateRange,\n\tMetricKey,\n} from '../core/contract'\nimport { supportsGranularity } from '../core/granularity'\nimport { resolveReadContext } from '../core/scopedRead'\nimport { getRuntime, resolveTimezoneFor } from '../plugin/runtime'\nimport { resolveTimeframe, type TimeframePreset } from '../timeframe/presets'\nimport { addDaysInTz, DEFAULT_TIMEZONE, startOfDayInTz, zonedDayIso } from '../timeframe/tz'\nimport { previousWindow } from './comparison'\nimport type { WidgetReadStatus } from './readForWidget'\n\nexport interface SeriesPoint {\n\tdate: string\n\tvalue: number\n}\n\nexport interface WidgetSeriesResult {\n\tstatus: WidgetReadStatus\n\tadapterId: string\n\tdateRange: DateRange\n\t/** Reporting timezone the read resolved in; the trend axis buckets in it. */\n\ttimezone: string\n\tpoints: SeriesPoint[]\n\ttotal: number\n\tclamped?: boolean\n\t/** Previous-window headline total, present only when the adapter supports comparison. */\n\tpreviousTotal?: number\n\t/** The previous comparable window, present only when comparison ran. */\n\tcomparisonRange?: DateRange\n}\n\nexport interface ReadForWidgetSeriesArgs {\n\treq: PayloadRequest\n\tmetric: MetricKey\n\ttimeframe: TimeframePreset\n\tadapterId?: string\n\tnow: Date\n\trange?: DateRange\n\t/** Explicit scope override; omitted resolves via the plugin's scopeResolver. */\n\tscope?: string | null\n\tfilters?: AnalyticsFilter[]\n}\n\nconst MAX_SERIES_DAYS = 366\n\n/**\n * Project time-series rows onto a contiguous daily axis, zero-filling gaps. Days are\n * counted in `tz` (defaulting to UTC), so a reporting-timezone read aligns each bucket\n * to that zone's midnight. The axis is capped at the most recent `MAX_SERIES_DAYS` so\n * an unbounded range (all time) stays a bounded, drawable sparkline; the headline total\n * still reflects the full range.\n */\nexport const fillDailySeries = (args: {\n\trows: AnalyticsRow[]\n\tdateRange: DateRange\n\tmetric: MetricKey\n\ttz?: string\n}): SeriesPoint[] => {\n\tconst { rows, dateRange, metric } = args\n\tconst tz = args.tz ?? DEFAULT_TIMEZONE\n\tconst lastDay = startOfDayInTz(dateRange.end, tz)\n\tconst requestedStart = startOfDayInTz(dateRange.start, tz)\n\tconst byDay = new Map<string, number>()\n\tfor (const row of rows) {\n\t\tif (!row.timestamp) {\n\t\t\tcontinue\n\t\t}\n\t\tconst day = zonedDayIso(new Date(row.timestamp), tz)\n\t\tbyDay.set(day, (byDay.get(day) ?? 0) + (row.metrics[metric] ?? 0))\n\t}\n\t// Walk calendar days back from the last day so DST-length days never mis-step, capping\n\t// the axis at MAX_SERIES_DAYS or the requested start, whichever is more recent.\n\tconst isoDays: string[] = []\n\tlet cursor = lastDay\n\tfor (let i = 0; i < MAX_SERIES_DAYS && cursor.getTime() >= requestedStart.getTime(); i += 1) {\n\t\tisoDays.push(cursor.toISOString())\n\t\tcursor = addDaysInTz(cursor, -1, tz)\n\t}\n\treturn isoDays.reverse().map((date) => ({ date, value: byDay.get(date) ?? 0 }))\n}\n\n/**\n * Site-wide time-series read for a trend widget: resolve the timeframe, pick the\n * adapter, gate on the metric and day-granularity support, read through the engine,\n * then return a zero-filled daily series plus the headline total. Mirrors\n * `readForWidget` but yields points instead of a single value.\n */\nexport const readForWidgetSeries = async (\n\targs: ReadForWidgetSeriesArgs\n): Promise<WidgetSeriesResult> => {\n\tconst { req, metric, timeframe, adapterId, now, range, filters } = args\n\tconst fallback = (status: WidgetReadStatus, id: string): WidgetSeriesResult => ({\n\t\tstatus,\n\t\tadapterId: id,\n\t\tdateRange: range ?? resolveTimeframe(timeframe, now),\n\t\ttimezone: DEFAULT_TIMEZONE,\n\t\tpoints: [],\n\t\ttotal: 0,\n\t})\n\n\tconst runtime = getRuntime(req.payload)\n\tif (!runtime) {\n\t\treturn fallback('unavailable', adapterId ?? '')\n\t}\n\tconst ctx = await resolveReadContext({ runtime, req, adapterId, scope: args.scope })\n\tif (!ctx.ok) {\n\t\treturn fallback('unavailable', adapterId ?? '')\n\t}\n\tconst tz = await resolveTimezoneFor(runtime, req, ctx.scope)\n\tconst dateRange = range ?? resolveTimeframe(timeframe, now, tz)\n\tconst base = { dateRange, timezone: tz, points: [] as SeriesPoint[], total: 0 }\n\tconst adapter: AnalyticsAdapter = ctx.adapter\n\tif (!adapter.isConfigured()) {\n\t\treturn { status: 'not-configured', adapterId: adapter.id, ...base }\n\t}\n\tif (\n\t\t!satisfiesCapabilities(adapter.capabilities, {\n\t\t\tmetrics: [metric],\n\t\t\t...(filters && filters.length > 0\n\t\t\t\t? {\n\t\t\t\t\t\tfilters: filters.map((f) => f.dimension),\n\t\t\t\t\t\tfilterOperators: filters.map((f) => f.operator),\n\t\t\t\t\t}\n\t\t\t\t: {}),\n\t\t}) ||\n\t\t!supportsGranularity(adapter.capabilities, 'day')\n\t) {\n\t\treturn { status: 'unavailable', adapterId: adapter.id, ...base }\n\t}\n\tconst comparisonRange =\n\t\truntime.comparison && adapter.capabilities.comparison\n\t\t\t? (previousWindow(dateRange, tz) ?? undefined)\n\t\t\t: undefined\n\
|
|
1
|
+
{"version":3,"file":"readForWidgetSeries.js","names":[],"sources":["../../src/widgets/readForWidgetSeries.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\nimport { satisfiesCapabilities } from '../core/capabilities'\nimport type {\n\tAnalyticsAdapter,\n\tAnalyticsFilter,\n\tAnalyticsResult,\n\tAnalyticsRow,\n\tDateRange,\n\tMetricKey,\n} from '../core/contract'\nimport { supportsGranularity } from '../core/granularity'\nimport { resolveReadContext } from '../core/scopedRead'\nimport { getRuntime, resolveTimezoneFor } from '../plugin/runtime'\nimport { resolveTimeframe, type TimeframePreset } from '../timeframe/presets'\nimport { addDaysInTz, DEFAULT_TIMEZONE, startOfDayInTz, zonedDayIso } from '../timeframe/tz'\nimport { previousWindow } from './comparison'\nimport type { WidgetReadStatus } from './readForWidget'\n\nexport interface SeriesPoint {\n\tdate: string\n\tvalue: number\n}\n\nexport interface WidgetSeriesResult {\n\tstatus: WidgetReadStatus\n\tadapterId: string\n\tdateRange: DateRange\n\t/** Reporting timezone the read resolved in; the trend axis buckets in it. */\n\ttimezone: string\n\tpoints: SeriesPoint[]\n\ttotal: number\n\tclamped?: boolean\n\t/** Previous-window headline total, present only when the adapter supports comparison. */\n\tpreviousTotal?: number\n\t/** The previous comparable window, present only when comparison ran. */\n\tcomparisonRange?: DateRange\n}\n\nexport interface ReadForWidgetSeriesArgs {\n\treq: PayloadRequest\n\tmetric: MetricKey\n\ttimeframe: TimeframePreset\n\tadapterId?: string\n\tnow: Date\n\trange?: DateRange\n\t/** Explicit scope override; omitted resolves via the plugin's scopeResolver. */\n\tscope?: string | null\n\tfilters?: AnalyticsFilter[]\n}\n\nconst MAX_SERIES_DAYS = 366\n\n/**\n * Project time-series rows onto a contiguous daily axis, zero-filling gaps. Days are\n * counted in `tz` (defaulting to UTC), so a reporting-timezone read aligns each bucket\n * to that zone's midnight. The axis is capped at the most recent `MAX_SERIES_DAYS` so\n * an unbounded range (all time) stays a bounded, drawable sparkline; the headline total\n * still reflects the full range.\n */\nexport const fillDailySeries = (args: {\n\trows: AnalyticsRow[]\n\tdateRange: DateRange\n\tmetric: MetricKey\n\ttz?: string\n}): SeriesPoint[] => {\n\tconst { rows, dateRange, metric } = args\n\tconst tz = args.tz ?? DEFAULT_TIMEZONE\n\tconst lastDay = startOfDayInTz(dateRange.end, tz)\n\tconst requestedStart = startOfDayInTz(dateRange.start, tz)\n\tconst byDay = new Map<string, number>()\n\tfor (const row of rows) {\n\t\tif (!row.timestamp) {\n\t\t\tcontinue\n\t\t}\n\t\tconst day = zonedDayIso(new Date(row.timestamp), tz)\n\t\tbyDay.set(day, (byDay.get(day) ?? 0) + (row.metrics[metric] ?? 0))\n\t}\n\t// Walk calendar days back from the last day so DST-length days never mis-step, capping\n\t// the axis at MAX_SERIES_DAYS or the requested start, whichever is more recent.\n\tconst isoDays: string[] = []\n\tlet cursor = lastDay\n\tfor (let i = 0; i < MAX_SERIES_DAYS && cursor.getTime() >= requestedStart.getTime(); i += 1) {\n\t\tisoDays.push(cursor.toISOString())\n\t\tcursor = addDaysInTz(cursor, -1, tz)\n\t}\n\treturn isoDays.reverse().map((date) => ({ date, value: byDay.get(date) ?? 0 }))\n}\n\n/**\n * Site-wide time-series read for a trend widget: resolve the timeframe, pick the\n * adapter, gate on the metric and day-granularity support, read through the engine,\n * then return a zero-filled daily series plus the headline total. Mirrors\n * `readForWidget` but yields points instead of a single value.\n */\nexport const readForWidgetSeries = async (\n\targs: ReadForWidgetSeriesArgs\n): Promise<WidgetSeriesResult> => {\n\tconst { req, metric, timeframe, adapterId, now, range, filters } = args\n\tconst fallback = (status: WidgetReadStatus, id: string): WidgetSeriesResult => ({\n\t\tstatus,\n\t\tadapterId: id,\n\t\tdateRange: range ?? resolveTimeframe(timeframe, now),\n\t\ttimezone: DEFAULT_TIMEZONE,\n\t\tpoints: [],\n\t\ttotal: 0,\n\t})\n\n\tconst runtime = getRuntime(req.payload)\n\tif (!runtime) {\n\t\treturn fallback('unavailable', adapterId ?? '')\n\t}\n\tconst ctx = await resolveReadContext({ runtime, req, adapterId, scope: args.scope })\n\tif (!ctx.ok) {\n\t\treturn fallback('unavailable', adapterId ?? '')\n\t}\n\tconst tz = await resolveTimezoneFor(runtime, req, ctx.scope)\n\tconst dateRange = range ?? resolveTimeframe(timeframe, now, tz)\n\tconst base = { dateRange, timezone: tz, points: [] as SeriesPoint[], total: 0 }\n\tconst adapter: AnalyticsAdapter = ctx.adapter\n\tif (!adapter.isConfigured()) {\n\t\treturn { status: 'not-configured', adapterId: adapter.id, ...base }\n\t}\n\tif (\n\t\t!satisfiesCapabilities(adapter.capabilities, {\n\t\t\tmetrics: [metric],\n\t\t\t...(filters && filters.length > 0\n\t\t\t\t? {\n\t\t\t\t\t\tfilters: filters.map((f) => f.dimension),\n\t\t\t\t\t\tfilterOperators: filters.map((f) => f.operator),\n\t\t\t\t\t}\n\t\t\t\t: {}),\n\t\t}) ||\n\t\t!supportsGranularity(adapter.capabilities, 'day')\n\t) {\n\t\treturn { status: 'unavailable', adapterId: adapter.id, ...base }\n\t}\n\tconst comparisonRange =\n\t\truntime.comparison && adapter.capabilities.comparison\n\t\t\t? (previousWindow(dateRange, tz) ?? undefined)\n\t\t\t: undefined\n\tlet result: AnalyticsResult\n\tlet previous: AnalyticsResult | undefined\n\ttry {\n\t\t;[result, previous] = await Promise.all([\n\t\t\truntime.engine.read(adapter, {\n\t\t\t\tmetrics: [metric],\n\t\t\t\tdateRange,\n\t\t\t\tgranularity: 'day',\n\t\t\t\tfilters,\n\t\t\t\ttimezone: tz,\n\t\t\t\tscope: ctx.queryScope,\n\t\t\t}),\n\t\t\tcomparisonRange\n\t\t\t\t? runtime.engine.read(adapter, {\n\t\t\t\t\t\tmetrics: [metric],\n\t\t\t\t\t\tdateRange: comparisonRange,\n\t\t\t\t\t\tfilters,\n\t\t\t\t\t\ttimezone: tz,\n\t\t\t\t\t\tscope: ctx.queryScope,\n\t\t\t\t\t})\n\t\t\t\t: undefined,\n\t\t])\n\t} catch {\n\t\t// No cache entry (fresh or stale) survived the failed read; degrade like an\n\t\t// unsupported capability instead of throwing through the widget render tree.\n\t\treturn { status: 'unavailable', adapterId: adapter.id, ...base }\n\t}\n\tconst previousTotal = previous ? previous.totals?.[metric] : undefined\n\treturn {\n\t\tstatus: 'ok',\n\t\tadapterId: adapter.id,\n\t\tdateRange,\n\t\ttimezone: tz,\n\t\tpoints: fillDailySeries({ rows: result.rows, dateRange, metric, tz }),\n\t\ttotal: result.totals?.[metric] ?? 0,\n\t\tclamped: result.meta.clamped ?? false,\n\t\tpreviousTotal,\n\t\tcomparisonRange,\n\t}\n}\n"],"mappings":";;;;;;;;AAkDA,MAAM,kBAAkB;;;;;;;;AASxB,MAAa,mBAAmB,SAKX;CACpB,MAAM,EAAE,MAAM,WAAW,WAAW;CACpC,MAAM,KAAK,KAAK,MAAA;CAChB,MAAM,UAAU,eAAe,UAAU,KAAK,EAAE;CAChD,MAAM,iBAAiB,eAAe,UAAU,OAAO,EAAE;CACzD,MAAM,wBAAQ,IAAI,IAAoB;CACtC,KAAK,MAAM,OAAO,MAAM;EACvB,IAAI,CAAC,IAAI,WACR;EAED,MAAM,MAAM,YAAY,IAAI,KAAK,IAAI,SAAS,GAAG,EAAE;EACnD,MAAM,IAAI,MAAM,MAAM,IAAI,GAAG,KAAK,MAAM,IAAI,QAAQ,WAAW,EAAE;CAClE;CAGA,MAAM,UAAoB,CAAC;CAC3B,IAAI,SAAS;CACb,KAAK,IAAI,IAAI,GAAG,IAAI,mBAAmB,OAAO,QAAQ,KAAK,eAAe,QAAQ,GAAG,KAAK,GAAG;EAC5F,QAAQ,KAAK,OAAO,YAAY,CAAC;EACjC,SAAS,YAAY,QAAQ,IAAI,EAAE;CACpC;CACA,OAAO,QAAQ,QAAQ,EAAE,KAAK,UAAU;EAAE;EAAM,OAAO,MAAM,IAAI,IAAI,KAAK;CAAE,EAAE;AAC/E;;;;;;;AAQA,MAAa,sBAAsB,OAClC,SACiC;CACjC,MAAM,EAAE,KAAK,QAAQ,WAAW,WAAW,KAAK,OAAO,YAAY;CACnE,MAAM,YAAY,QAA0B,QAAoC;EAC/E;EACA,WAAW;EACX,WAAW,SAAS,iBAAiB,WAAW,GAAG;EACnD,UAAA;EACA,QAAQ,CAAC;EACT,OAAO;CACR;CAEA,MAAM,UAAU,WAAW,IAAI,OAAO;CACtC,IAAI,CAAC,SACJ,OAAO,SAAS,eAAe,aAAa,EAAE;CAE/C,MAAM,MAAM,MAAM,mBAAmB;EAAE;EAAS;EAAK;EAAW,OAAO,KAAK;CAAM,CAAC;CACnF,IAAI,CAAC,IAAI,IACR,OAAO,SAAS,eAAe,aAAa,EAAE;CAE/C,MAAM,KAAK,MAAM,mBAAmB,SAAS,KAAK,IAAI,KAAK;CAC3D,MAAM,YAAY,SAAS,iBAAiB,WAAW,KAAK,EAAE;CAC9D,MAAM,OAAO;EAAE;EAAW,UAAU;EAAI,QAAQ,CAAC;EAAoB,OAAO;CAAE;CAC9E,MAAM,UAA4B,IAAI;CACtC,IAAI,CAAC,QAAQ,aAAa,GACzB,OAAO;EAAE,QAAQ;EAAkB,WAAW,QAAQ;EAAI,GAAG;CAAK;CAEnE,IACC,CAAC,sBAAsB,QAAQ,cAAc;EAC5C,SAAS,CAAC,MAAM;EAChB,GAAI,WAAW,QAAQ,SAAS,IAC7B;GACA,SAAS,QAAQ,KAAK,MAAM,EAAE,SAAS;GACvC,iBAAiB,QAAQ,KAAK,MAAM,EAAE,QAAQ;EAC/C,IACC,CAAC;CACL,CAAC,KACD,CAAC,oBAAoB,QAAQ,cAAc,KAAK,GAEhD,OAAO;EAAE,QAAQ;EAAe,WAAW,QAAQ;EAAI,GAAG;CAAK;CAEhE,MAAM,kBACL,QAAQ,cAAc,QAAQ,aAAa,aACvC,eAAe,WAAW,EAAE,KAAK,KAAA,IAClC,KAAA;CACJ,IAAI;CACJ,IAAI;CACJ,IAAI;EACF,CAAC,QAAQ,YAAY,MAAM,QAAQ,IAAI,CACvC,QAAQ,OAAO,KAAK,SAAS;GAC5B,SAAS,CAAC,MAAM;GAChB;GACA,aAAa;GACb;GACA,UAAU;GACV,OAAO,IAAI;EACZ,CAAC,GACD,kBACG,QAAQ,OAAO,KAAK,SAAS;GAC7B,SAAS,CAAC,MAAM;GAChB,WAAW;GACX;GACA,UAAU;GACV,OAAO,IAAI;EACZ,CAAC,IACA,KAAA,CACJ,CAAC;CACF,QAAQ;EAGP,OAAO;GAAE,QAAQ;GAAe,WAAW,QAAQ;GAAI,GAAG;EAAK;CAChE;CACA,MAAM,gBAAgB,WAAW,SAAS,SAAS,UAAU,KAAA;CAC7D,OAAO;EACN,QAAQ;EACR,WAAW,QAAQ;EACnB;EACA,UAAU;EACV,QAAQ,gBAAgB;GAAE,MAAM,OAAO;GAAM;GAAW;GAAQ;EAAG,CAAC;EACpE,OAAO,OAAO,SAAS,WAAW;EAClC,SAAS,OAAO,KAAK,WAAW;EAChC;EACA;CACD;AACD"}
|
|
@@ -29,7 +29,10 @@ const widgetIsSupported = (requires, adapters) => !requires || adapters.some((a)
|
|
|
29
29
|
* `dataSource`'s capabilities; an id not known at config time (a runtime/DB provider)
|
|
30
30
|
* keeps the union. The default clamps to the first option when the preferred metric is
|
|
31
31
|
* not servable, and options can come out empty for exotic adapter sets, which
|
|
32
|
-
* {@link registerWidgets} treats as "skip this widget".
|
|
32
|
+
* {@link registerWidgets} treats as "skip this widget". When `providersEnabled`, the
|
|
33
|
+
* config-adapter filter is skipped entirely: a tenant's own runtime adapter may serve
|
|
34
|
+
* metrics no config adapter does, so every candidate is offered and `filterOptions` alone
|
|
35
|
+
* narrows once a `dataSource` is picked.
|
|
33
36
|
*/
|
|
34
37
|
const metricSelectField = (candidates, args, opts = {}) => {
|
|
35
38
|
const { extra, preferredDefault = "pageviews" } = opts;
|
|
@@ -37,7 +40,7 @@ const metricSelectField = (candidates, args, opts = {}) => {
|
|
|
37
40
|
...extra,
|
|
38
41
|
metrics: [metric]
|
|
39
42
|
});
|
|
40
|
-
const options = candidates.filter((m) => args.adapters.some((a) => supports(a, m))).map((m) => ({
|
|
43
|
+
const options = (args.providersEnabled ? candidates : candidates.filter((m) => args.adapters.some((a) => supports(a, m)))).map((m) => ({
|
|
41
44
|
value: m,
|
|
42
45
|
label: staticLabel(METRIC_KEYS[m])
|
|
43
46
|
}));
|
|
@@ -125,7 +128,10 @@ const metricWidgetFields = (args) => [
|
|
|
125
128
|
];
|
|
126
129
|
const breakdownWidgetFields = (args, spec) => [
|
|
127
130
|
titleField(args, en[spec.label]),
|
|
128
|
-
metricSelectField(WIDGET_METRICS, args, {
|
|
131
|
+
metricSelectField(WIDGET_METRICS, args, {
|
|
132
|
+
extra: { dimensions: [spec.dimension] },
|
|
133
|
+
...spec.dimension === "goal" ? { preferredDefault: "conversions" } : {}
|
|
134
|
+
}),
|
|
129
135
|
timeframeSelectField(),
|
|
130
136
|
customRangeField(),
|
|
131
137
|
{
|
|
@@ -212,7 +218,7 @@ const registerWidgets = (config, args) => {
|
|
|
212
218
|
const built = [];
|
|
213
219
|
for (const def of WIDGET_DEFS) {
|
|
214
220
|
if (args.disabled.includes(def.slug)) continue;
|
|
215
|
-
if (!widgetIsSupported(def.requires, args.adapters)) continue;
|
|
221
|
+
if (!args.providersEnabled && !widgetIsSupported(def.requires, args.adapters)) continue;
|
|
216
222
|
const fields = def.fields(args);
|
|
217
223
|
const metricField = findMetricField(fields);
|
|
218
224
|
if (metricField && "options" in metricField && metricField.options.length === 0) continue;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"registerWidgets.js","names":[],"sources":["../../src/widgets/registerWidgets.ts"],"sourcesContent":["import type {\n\tConfig,\n\tField,\n\tSelectField,\n\tSelectFieldSingleValidation,\n\tWidget,\n\tWidgetWidth,\n} from 'payload'\nimport { type CapabilityRequirement, satisfiesCapabilities } from '../core/capabilities'\nimport type { AnalyticsAdapter, MetricKey } from '../core/contract'\nimport { dateRangeField } from '../fields/dateRange/field'\nimport { TIMEFRAME_PRESETS } from '../timeframe/presets'\nimport { de } from '../translations/de'\nimport { en } from '../translations/en'\nimport type { TranslationKey } from '../translations/keys'\nimport { keys } from '../translations/keys'\nimport { METRIC_KEYS, TIMEFRAME_KEYS } from '../translations/metricKeys'\nimport { labelForKey } from '../translations/server'\nimport { BREAKDOWN_SPECS, type BreakdownSpec } from './breakdownTypes'\nimport { buildCustomWidgets, type CustomWidgetDef } from './customWidget'\nimport { WIDGET_METRICS } from './types'\n\n/**\n * Select options must carry static labels: `filterOptions` results are serialized\n * into client form state at request time, where a label function cannot cross the\n * server/client boundary.\n */\nconst staticLabel = (key: TranslationKey): Record<string, string> => ({\n\tde: de[key],\n\ten: en[key],\n})\n\nexport interface RegisterWidgetsArgs {\n\tadapters: AnalyticsAdapter[]\n\tmultiProvider: boolean\n\tdisabled: string[]\n\tregister: CustomWidgetDef[]\n\tlocalizeText?: boolean\n\t/** The plugin's configured defaultAdapter, when set; falls back to the first adapter. */\n\tdefaultId?: string\n}\n\ninterface WidgetDef {\n\tslug: string\n\tcomponent: string\n\tlabel: TranslationKey\n\trequires?: CapabilityRequirement\n\tminWidth?: WidgetWidth\n\tmaxWidth?: WidgetWidth\n\tfields: (args: RegisterWidgetsArgs) => Field[]\n}\n\nexport const widgetIsSupported = (\n\trequires: CapabilityRequirement | undefined,\n\tadapters: AnalyticsAdapter[]\n): boolean => !requires || adapters.some((a) => satisfiesCapabilities(a.capabilities, requires))\n\n/**\n * The widget metric select. Options are limited to metrics at least one configured\n * adapter can serve, mirroring the OR-across-adapters gating used to hide whole widgets;\n * `extra` layers on further requirements (a breakdown widget's dimension, realtime) so\n * the picker never offers a metric the read path would report as unavailable. In\n * multi-provider installs `filterOptions` additionally narrows the picker to the selected\n * `dataSource`'s capabilities; an id not known at config time (a runtime/DB provider)\n * keeps the union. The default clamps to the first option when the preferred metric is\n * not servable, and options can come out empty for exotic adapter sets, which\n * {@link registerWidgets} treats as \"skip this widget\".\n */\nconst metricSelectField = (\n\tcandidates: MetricKey[],\n\targs: RegisterWidgetsArgs,\n\topts: {\n\t\textra?: Omit<CapabilityRequirement, 'metrics'>\n\t\tpreferredDefault?: MetricKey\n\t} = {}\n): Field => {\n\tconst { extra, preferredDefault = 'pageviews' } = opts\n\tconst supports = (adapter: AnalyticsAdapter, metric: MetricKey): boolean =>\n\t\tsatisfiesCapabilities(adapter.capabilities, { ...extra, metrics: [metric] })\n\tconst options = candidates\n\t\t.filter((m) => args.adapters.some((a) => supports(a, m)))\n\t\t.map((m) => ({ value: m, label: staticLabel(METRIC_KEYS[m]) }))\n\tconst defaultValue = options.some((o) => o.value === preferredDefault)\n\t\t? preferredDefault\n\t\t: options[0]?.value\n\tconst filterOptions: SelectField['filterOptions'] = ({ options: opts, siblingData }) => {\n\t\tconst sourceId = (siblingData as { dataSource?: unknown } | undefined)?.dataSource\n\t\tconst adapter =\n\t\t\ttypeof sourceId === 'string' ? args.adapters.find((a) => a.id === sourceId) : undefined\n\t\tif (!adapter) {\n\t\t\treturn opts\n\t\t}\n\t\treturn opts.filter((o) => typeof o === 'object' && supports(adapter, o.value as MetricKey))\n\t}\n\treturn {\n\t\tname: 'metric',\n\t\ttype: 'select',\n\t\trequired: true,\n\t\t...(defaultValue !== undefined ? { defaultValue } : {}),\n\t\tlabel: labelForKey(keys.widgetFieldMetric),\n\t\toptions,\n\t\tadmin: {\n\t\t\t// A required metric has no meaningful cleared state.\n\t\t\tisClearable: false,\n\t\t\tcomponents: {\n\t\t\t\tField: {\n\t\t\t\t\tpath: '@10x-media/analytics/client#MetricSelectField',\n\t\t\t\t\t...(extra ? { clientProps: { requires: extra } } : {}),\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t...(args.multiProvider ? { filterOptions } : {}),\n\t}\n}\n\nconst titleField = (args: RegisterWidgetsArgs, placeholder: string): Field => ({\n\tname: 'title',\n\ttype: 'text',\n\tlabel: labelForKey(keys.widgetFieldTitle),\n\t...(args.localizeText ? { localized: true } : {}),\n\tadmin: { placeholder },\n})\n\nconst timeframeSelectField = (): Field => ({\n\tname: 'timeframe',\n\ttype: 'select',\n\trequired: true,\n\tdefaultValue: 'last30days',\n\tlabel: labelForKey(keys.widgetFieldTimeframe),\n\tadmin: { isClearable: false },\n\toptions: [\n\t\t...TIMEFRAME_PRESETS.map((p) => ({ value: p, label: labelForKey(TIMEFRAME_KEYS[p]) })),\n\t\t{ value: 'custom', label: labelForKey(keys.widgetTimeframeCustom) },\n\t],\n})\n\nconst dataSourceField = (args: RegisterWidgetsArgs): Field => ({\n\tname: 'dataSource',\n\ttype: 'select',\n\tlabel: labelForKey(keys.widgetFieldDataSource),\n\tdefaultValue: args.defaultId ?? args.adapters[0]?.id,\n\tadmin: {\n\t\t// Clearing would leave no source; the widget always reads through one.\n\t\tisClearable: false,\n\t\tcomponents: { Field: { path: '@10x-media/analytics/client#SourceSelectField' } },\n\t},\n\toptions: args.adapters.map((a) => ({ value: a.id, label: a.label })),\n\t// Payload's select validator rejects any value absent from `options`, but runtime\n\t// (DB-registered) provider ids are only known per request, not at config time.\n\tvalidate: ((value) =>\n\t\tvalue === undefined || value === null || (typeof value === 'string' && value.length > 0)\n\t\t\t? true\n\t\t\t: 'invalid data source') as SelectFieldSingleValidation,\n})\n\nconst customRangeField = (): Field =>\n\tdateRangeField({\n\t\tname: 'range',\n\t\tlabel: labelForKey(keys.widgetFieldRange),\n\t\tpickerAppearance: 'dayOnly',\n\t\toverrides: (f) => ({\n\t\t\t...f,\n\t\t\tadmin: {\n\t\t\t\t...f.admin,\n\t\t\t\tcondition: (_data, siblingData) => siblingData?.timeframe === 'custom',\n\t\t\t},\n\t\t}),\n\t})\n\n/** The metric select in a widget's field list. */\nexport const findMetricField = (fields: Field[]): Field | undefined =>\n\tfields.find((field) => 'name' in field && field.name === 'metric')\n\nconst metricWidgetFields = (args: RegisterWidgetsArgs): Field[] => [\n\ttitleField(args, en[keys.widgetFieldTitlePlaceholder]),\n\tmetricSelectField(WIDGET_METRICS, args),\n\ttimeframeSelectField(),\n\tcustomRangeField(),\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\nconst breakdownWidgetFields = (args: RegisterWidgetsArgs, spec: BreakdownSpec): Field[] => [\n\ttitleField(args, en[spec.label]),\n\tmetricSelectField(WIDGET_METRICS, args, { extra: { dimensions: [spec.dimension] } }),\n\ttimeframeSelectField(),\n\tcustomRangeField(),\n\t{\n\t\tname: 'limit',\n\t\ttype: 'number',\n\t\tdefaultValue: 5,\n\t\tmin: 1,\n\t\tmax: 20,\n\t\tlabel: labelForKey(keys.widgetFieldLimit),\n\t},\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\nconst realtimeWidgetFields = (args: RegisterWidgetsArgs): Field[] => [\n\ttitleField(args, en[keys.widgetFieldTitlePlaceholder]),\n\tmetricSelectField(['visitors', 'pageviews'], args, {\n\t\textra: { realtime: true },\n\t\tpreferredDefault: 'visitors',\n\t}),\n\t{\n\t\tname: 'windowMinutes',\n\t\ttype: 'select',\n\t\tdefaultValue: '30',\n\t\tlabel: labelForKey(keys.widgetFieldWindow),\n\t\tadmin: { isClearable: false },\n\t\toptions: [\n\t\t\t{ value: '5', label: '5 min' },\n\t\t\t{ value: '15', label: '15 min' },\n\t\t\t{ value: '30', label: '30 min' },\n\t\t\t{ value: '60', label: '60 min' },\n\t\t],\n\t},\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\nconst WIDGET_DEFS: WidgetDef[] = [\n\t{\n\t\tslug: 'analytics-metric',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsMetricWidget',\n\t\tlabel: keys.widgetMetricLabel,\n\t\tminWidth: 'x-small',\n\t\tmaxWidth: 'medium',\n\t\tfields: metricWidgetFields,\n\t},\n\t{\n\t\tslug: 'analytics-trend',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsTrendWidget',\n\t\tlabel: keys.widgetTrendLabel,\n\t\trequires: { metrics: ['pageviews'] },\n\t\tminWidth: 'small',\n\t\tmaxWidth: 'full',\n\t\tfields: metricWidgetFields,\n\t},\n\t{\n\t\tslug: 'analytics-realtime',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsRealtimeWidget',\n\t\tlabel: keys.widgetRealtimeLabel,\n\t\trequires: { realtime: true },\n\t\tminWidth: 'small' as WidgetWidth,\n\t\tmaxWidth: 'medium' as WidgetWidth,\n\t\tfields: realtimeWidgetFields,\n\t},\n\t...BREAKDOWN_SPECS.map(\n\t\t(spec): WidgetDef => ({\n\t\t\tslug: spec.slug,\n\t\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsBreakdownWidget',\n\t\t\tlabel: spec.label,\n\t\t\trequires: { dimensions: [spec.dimension] },\n\t\t\tminWidth: 'small' as WidgetWidth,\n\t\t\tmaxWidth: 'large' as WidgetWidth,\n\t\t\tfields: (args) => breakdownWidgetFields(args, spec),\n\t\t})\n\t),\n]\n\nexport const registerWidgets = (config: Config, args: RegisterWidgetsArgs): void => {\n\tconst built: Widget[] = []\n\tfor (const def of WIDGET_DEFS) {\n\t\tif (args.disabled.includes(def.slug)) {\n\t\t\tcontinue\n\t\t}\n\t\tif (!widgetIsSupported(def.requires, args.adapters)) {\n\t\t\tcontinue\n\t\t}\n\t\tconst fields = def.fields(args)\n\t\t// A required metric select with no servable option would make the widget\n\t\t// impossible to configure; skip it like an unsupported widget.\n\t\tconst metricField = findMetricField(fields)\n\t\tif (metricField && 'options' in metricField && metricField.options.length === 0) {\n\t\t\tcontinue\n\t\t}\n\t\tbuilt.push({\n\t\t\tslug: def.slug,\n\t\t\tComponent: def.component,\n\t\t\tlabel: labelForKey(def.label),\n\t\t\tfields,\n\t\t\tminWidth: def.minWidth,\n\t\t\tmaxWidth: def.maxWidth,\n\t\t})\n\t}\n\tbuilt.push(...buildCustomWidgets(args.register, args.adapters, args.disabled))\n\tif (!built.length) {\n\t\treturn\n\t}\n\tconfig.admin ??= {}\n\tconfig.admin.dashboard ??= { widgets: [] }\n\tconfig.admin.dashboard.widgets ??= []\n\tconfig.admin.dashboard.widgets.push(...built)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AA2BA,MAAM,eAAe,SAAiD;CACrE,IAAI,GAAG;CACP,IAAI,GAAG;AACR;AAsBA,MAAa,qBACZ,UACA,aACa,CAAC,YAAY,SAAS,MAAM,MAAM,sBAAsB,EAAE,cAAc,QAAQ,CAAC;;;;;;;;;;;;AAa/F,MAAM,qBACL,YACA,MACA,OAGI,CAAC,MACM;CACX,MAAM,EAAE,OAAO,mBAAmB,gBAAgB;CAClD,MAAM,YAAY,SAA2B,WAC5C,sBAAsB,QAAQ,cAAc;EAAE,GAAG;EAAO,SAAS,CAAC,MAAM;CAAE,CAAC;CAC5E,MAAM,UAAU,WACd,QAAQ,MAAM,KAAK,SAAS,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,CAAC,EACvD,KAAK,OAAO;EAAE,OAAO;EAAG,OAAO,YAAY,YAAY,EAAE;CAAE,EAAE;CAC/D,MAAM,eAAe,QAAQ,MAAM,MAAM,EAAE,UAAU,gBAAgB,IAClE,mBACA,QAAQ,IAAI;CACf,MAAM,iBAA+C,EAAE,SAAS,MAAM,kBAAkB;EACvF,MAAM,WAAY,aAAsD;EACxE,MAAM,UACL,OAAO,aAAa,WAAW,KAAK,SAAS,MAAM,MAAM,EAAE,OAAO,QAAQ,IAAI,KAAA;EAC/E,IAAI,CAAC,SACJ,OAAO;EAER,OAAO,KAAK,QAAQ,MAAM,OAAO,MAAM,YAAY,SAAS,SAAS,EAAE,KAAkB,CAAC;CAC3F;CACA,OAAO;EACN,MAAM;EACN,MAAM;EACN,UAAU;EACV,GAAI,iBAAiB,KAAA,IAAY,EAAE,aAAa,IAAI,CAAC;EACrD,OAAO,YAAY,KAAK,iBAAiB;EACzC;EACA,OAAO;GAEN,aAAa;GACb,YAAY,EACX,OAAO;IACN,MAAM;IACN,GAAI,QAAQ,EAAE,aAAa,EAAE,UAAU,MAAM,EAAE,IAAI,CAAC;GACrD,EACD;EACD;EACA,GAAI,KAAK,gBAAgB,EAAE,cAAc,IAAI,CAAC;CAC/C;AACD;AAEA,MAAM,cAAc,MAA2B,iBAAgC;CAC9E,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,gBAAgB;CACxC,GAAI,KAAK,eAAe,EAAE,WAAW,KAAK,IAAI,CAAC;CAC/C,OAAO,EAAE,YAAY;AACtB;AAEA,MAAM,8BAAqC;CAC1C,MAAM;CACN,MAAM;CACN,UAAU;CACV,cAAc;CACd,OAAO,YAAY,KAAK,oBAAoB;CAC5C,OAAO,EAAE,aAAa,MAAM;CAC5B,SAAS,CACR,GAAG,kBAAkB,KAAK,OAAO;EAAE,OAAO;EAAG,OAAO,YAAY,eAAe,EAAE;CAAE,EAAE,GACrF;EAAE,OAAO;EAAU,OAAO,YAAY,KAAK,qBAAqB;CAAE,CACnE;AACD;AAEA,MAAM,mBAAmB,UAAsC;CAC9D,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,qBAAqB;CAC7C,cAAc,KAAK,aAAa,KAAK,SAAS,IAAI;CAClD,OAAO;EAEN,aAAa;EACb,YAAY,EAAE,OAAO,EAAE,MAAM,gDAAgD,EAAE;CAChF;CACA,SAAS,KAAK,SAAS,KAAK,OAAO;EAAE,OAAO,EAAE;EAAI,OAAO,EAAE;CAAM,EAAE;CAGnE,YAAY,UACX,UAAU,KAAA,KAAa,UAAU,QAAS,OAAO,UAAU,YAAY,MAAM,SAAS,IACnF,OACA;AACL;AAEA,MAAM,yBACL,eAAe;CACd,MAAM;CACN,OAAO,YAAY,KAAK,gBAAgB;CACxC,kBAAkB;CAClB,YAAY,OAAO;EAClB,GAAG;EACH,OAAO;GACN,GAAG,EAAE;GACL,YAAY,OAAO,gBAAgB,aAAa,cAAc;EAC/D;CACD;AACD,CAAC;;AAGF,MAAa,mBAAmB,WAC/B,OAAO,MAAM,UAAU,UAAU,SAAS,MAAM,SAAS,QAAQ;AAElE,MAAM,sBAAsB,SAAuC;CAClE,WAAW,MAAM,GAAG,KAAK,4BAA4B;CACrD,kBAAkB,gBAAgB,IAAI;CACtC,qBAAqB;CACrB,iBAAiB;CACjB,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;AAEA,MAAM,yBAAyB,MAA2B,SAAiC;CAC1F,WAAW,MAAM,GAAG,KAAK,MAAM;CAC/B,kBAAkB,gBAAgB,MAAM,EAAE,OAAO,EAAE,YAAY,CAAC,KAAK,SAAS,EAAE,EAAE,CAAC;CACnF,qBAAqB;CACrB,iBAAiB;CACjB;EACC,MAAM;EACN,MAAM;EACN,cAAc;EACd,KAAK;EACL,KAAK;EACL,OAAO,YAAY,KAAK,gBAAgB;CACzC;CACA,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;AAEA,MAAM,wBAAwB,SAAuC;CACpE,WAAW,MAAM,GAAG,KAAK,4BAA4B;CACrD,kBAAkB,CAAC,YAAY,WAAW,GAAG,MAAM;EAClD,OAAO,EAAE,UAAU,KAAK;EACxB,kBAAkB;CACnB,CAAC;CACD;EACC,MAAM;EACN,MAAM;EACN,cAAc;EACd,OAAO,YAAY,KAAK,iBAAiB;EACzC,OAAO,EAAE,aAAa,MAAM;EAC5B,SAAS;GACR;IAAE,OAAO;IAAK,OAAO;GAAQ;GAC7B;IAAE,OAAO;IAAM,OAAO;GAAS;GAC/B;IAAE,OAAO;IAAM,OAAO;GAAS;GAC/B;IAAE,OAAO;IAAM,OAAO;GAAS;EAChC;CACD;CACA,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;AAEA,MAAM,cAA2B;CAChC;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,SAAS,CAAC,WAAW,EAAE;EACnC,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,UAAU,KAAK;EAC3B,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA,GAAG,gBAAgB,KACjB,UAAqB;EACrB,MAAM,KAAK;EACX,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,YAAY,CAAC,KAAK,SAAS,EAAE;EACzC,UAAU;EACV,UAAU;EACV,SAAS,SAAS,sBAAsB,MAAM,IAAI;CACnD,EACD;AACD;AAEA,MAAa,mBAAmB,QAAgB,SAAoC;CACnF,MAAM,QAAkB,CAAC;CACzB,KAAK,MAAM,OAAO,aAAa;EAC9B,IAAI,KAAK,SAAS,SAAS,IAAI,IAAI,GAClC;EAED,IAAI,CAAC,kBAAkB,IAAI,UAAU,KAAK,QAAQ,GACjD;EAED,MAAM,SAAS,IAAI,OAAO,IAAI;EAG9B,MAAM,cAAc,gBAAgB,MAAM;EAC1C,IAAI,eAAe,aAAa,eAAe,YAAY,QAAQ,WAAW,GAC7E;EAED,MAAM,KAAK;GACV,MAAM,IAAI;GACV,WAAW,IAAI;GACf,OAAO,YAAY,IAAI,KAAK;GAC5B;GACA,UAAU,IAAI;GACd,UAAU,IAAI;EACf,CAAC;CACF;CACA,MAAM,KAAK,GAAG,mBAAmB,KAAK,UAAU,KAAK,UAAU,KAAK,QAAQ,CAAC;CAC7E,IAAI,CAAC,MAAM,QACV;CAED,OAAO,UAAU,CAAC;CAClB,OAAO,MAAM,cAAc,EAAE,SAAS,CAAC,EAAE;CACzC,OAAO,MAAM,UAAU,YAAY,CAAC;CACpC,OAAO,MAAM,UAAU,QAAQ,KAAK,GAAG,KAAK;AAC7C"}
|
|
1
|
+
{"version":3,"file":"registerWidgets.js","names":[],"sources":["../../src/widgets/registerWidgets.ts"],"sourcesContent":["import type {\n\tConfig,\n\tField,\n\tSelectField,\n\tSelectFieldSingleValidation,\n\tWidget,\n\tWidgetWidth,\n} from 'payload'\nimport { type CapabilityRequirement, satisfiesCapabilities } from '../core/capabilities'\nimport type { AnalyticsAdapter, MetricKey } from '../core/contract'\nimport { dateRangeField } from '../fields/dateRange/field'\nimport { TIMEFRAME_PRESETS } from '../timeframe/presets'\nimport { de } from '../translations/de'\nimport { en } from '../translations/en'\nimport type { TranslationKey } from '../translations/keys'\nimport { keys } from '../translations/keys'\nimport { METRIC_KEYS, TIMEFRAME_KEYS } from '../translations/metricKeys'\nimport { labelForKey } from '../translations/server'\nimport { BREAKDOWN_SPECS, type BreakdownSpec } from './breakdownTypes'\nimport { buildCustomWidgets, type CustomWidgetDef } from './customWidget'\nimport { WIDGET_METRICS } from './types'\n\n/**\n * Select options must carry static labels: `filterOptions` results are serialized\n * into client form state at request time, where a label function cannot cross the\n * server/client boundary.\n */\nconst staticLabel = (key: TranslationKey): Record<string, string> => ({\n\tde: de[key],\n\ten: en[key],\n})\n\nexport interface RegisterWidgetsArgs {\n\tadapters: AnalyticsAdapter[]\n\tmultiProvider: boolean\n\t/**\n\t * True when a tenant's own runtime adapter can exist (`providers.collection` or\n\t * `providers.resolve`). Such an adapter's capabilities are unknown at config time, so\n\t * gating on the config-adapter union would impose a false ceiling: widgets and metric\n\t * options open up, and the per-request sources endpoint plus client pickers narrow per\n\t * request instead.\n\t */\n\tprovidersEnabled: boolean\n\tdisabled: string[]\n\tregister: CustomWidgetDef[]\n\tlocalizeText?: boolean\n\t/** The plugin's configured defaultAdapter, when set; falls back to the first adapter. */\n\tdefaultId?: string\n}\n\ninterface WidgetDef {\n\tslug: string\n\tcomponent: string\n\tlabel: TranslationKey\n\trequires?: CapabilityRequirement\n\tminWidth?: WidgetWidth\n\tmaxWidth?: WidgetWidth\n\tfields: (args: RegisterWidgetsArgs) => Field[]\n}\n\nexport const widgetIsSupported = (\n\trequires: CapabilityRequirement | undefined,\n\tadapters: AnalyticsAdapter[]\n): boolean => !requires || adapters.some((a) => satisfiesCapabilities(a.capabilities, requires))\n\n/**\n * The widget metric select. Options are limited to metrics at least one configured\n * adapter can serve, mirroring the OR-across-adapters gating used to hide whole widgets;\n * `extra` layers on further requirements (a breakdown widget's dimension, realtime) so\n * the picker never offers a metric the read path would report as unavailable. In\n * multi-provider installs `filterOptions` additionally narrows the picker to the selected\n * `dataSource`'s capabilities; an id not known at config time (a runtime/DB provider)\n * keeps the union. The default clamps to the first option when the preferred metric is\n * not servable, and options can come out empty for exotic adapter sets, which\n * {@link registerWidgets} treats as \"skip this widget\". When `providersEnabled`, the\n * config-adapter filter is skipped entirely: a tenant's own runtime adapter may serve\n * metrics no config adapter does, so every candidate is offered and `filterOptions` alone\n * narrows once a `dataSource` is picked.\n */\nconst metricSelectField = (\n\tcandidates: MetricKey[],\n\targs: RegisterWidgetsArgs,\n\topts: {\n\t\textra?: Omit<CapabilityRequirement, 'metrics'>\n\t\tpreferredDefault?: MetricKey\n\t} = {}\n): Field => {\n\tconst { extra, preferredDefault = 'pageviews' } = opts\n\tconst supports = (adapter: AnalyticsAdapter, metric: MetricKey): boolean =>\n\t\tsatisfiesCapabilities(adapter.capabilities, { ...extra, metrics: [metric] })\n\tconst options = (\n\t\targs.providersEnabled\n\t\t\t? candidates\n\t\t\t: candidates.filter((m) => args.adapters.some((a) => supports(a, m)))\n\t).map((m) => ({ value: m, label: staticLabel(METRIC_KEYS[m]) }))\n\tconst defaultValue = options.some((o) => o.value === preferredDefault)\n\t\t? preferredDefault\n\t\t: options[0]?.value\n\tconst filterOptions: SelectField['filterOptions'] = ({ options: opts, siblingData }) => {\n\t\tconst sourceId = (siblingData as { dataSource?: unknown } | undefined)?.dataSource\n\t\tconst adapter =\n\t\t\ttypeof sourceId === 'string' ? args.adapters.find((a) => a.id === sourceId) : undefined\n\t\tif (!adapter) {\n\t\t\treturn opts\n\t\t}\n\t\treturn opts.filter((o) => typeof o === 'object' && supports(adapter, o.value as MetricKey))\n\t}\n\treturn {\n\t\tname: 'metric',\n\t\ttype: 'select',\n\t\trequired: true,\n\t\t...(defaultValue !== undefined ? { defaultValue } : {}),\n\t\tlabel: labelForKey(keys.widgetFieldMetric),\n\t\toptions,\n\t\tadmin: {\n\t\t\t// A required metric has no meaningful cleared state.\n\t\t\tisClearable: false,\n\t\t\tcomponents: {\n\t\t\t\tField: {\n\t\t\t\t\tpath: '@10x-media/analytics/client#MetricSelectField',\n\t\t\t\t\t...(extra ? { clientProps: { requires: extra } } : {}),\n\t\t\t\t},\n\t\t\t},\n\t\t},\n\t\t...(args.multiProvider ? { filterOptions } : {}),\n\t}\n}\n\nconst titleField = (args: RegisterWidgetsArgs, placeholder: string): Field => ({\n\tname: 'title',\n\ttype: 'text',\n\tlabel: labelForKey(keys.widgetFieldTitle),\n\t...(args.localizeText ? { localized: true } : {}),\n\tadmin: { placeholder },\n})\n\nconst timeframeSelectField = (): Field => ({\n\tname: 'timeframe',\n\ttype: 'select',\n\trequired: true,\n\tdefaultValue: 'last30days',\n\tlabel: labelForKey(keys.widgetFieldTimeframe),\n\tadmin: { isClearable: false },\n\toptions: [\n\t\t...TIMEFRAME_PRESETS.map((p) => ({ value: p, label: labelForKey(TIMEFRAME_KEYS[p]) })),\n\t\t{ value: 'custom', label: labelForKey(keys.widgetTimeframeCustom) },\n\t],\n})\n\nconst dataSourceField = (args: RegisterWidgetsArgs): Field => ({\n\tname: 'dataSource',\n\ttype: 'select',\n\tlabel: labelForKey(keys.widgetFieldDataSource),\n\tdefaultValue: args.defaultId ?? args.adapters[0]?.id,\n\tadmin: {\n\t\t// Clearing would leave no source; the widget always reads through one.\n\t\tisClearable: false,\n\t\tcomponents: { Field: { path: '@10x-media/analytics/client#SourceSelectField' } },\n\t},\n\toptions: args.adapters.map((a) => ({ value: a.id, label: a.label })),\n\t// Payload's select validator rejects any value absent from `options`, but runtime\n\t// (DB-registered) provider ids are only known per request, not at config time.\n\tvalidate: ((value) =>\n\t\tvalue === undefined || value === null || (typeof value === 'string' && value.length > 0)\n\t\t\t? true\n\t\t\t: 'invalid data source') as SelectFieldSingleValidation,\n})\n\nconst customRangeField = (): Field =>\n\tdateRangeField({\n\t\tname: 'range',\n\t\tlabel: labelForKey(keys.widgetFieldRange),\n\t\tpickerAppearance: 'dayOnly',\n\t\toverrides: (f) => ({\n\t\t\t...f,\n\t\t\tadmin: {\n\t\t\t\t...f.admin,\n\t\t\t\tcondition: (_data, siblingData) => siblingData?.timeframe === 'custom',\n\t\t\t},\n\t\t}),\n\t})\n\n/** The metric select in a widget's field list. */\nexport const findMetricField = (fields: Field[]): Field | undefined =>\n\tfields.find((field) => 'name' in field && field.name === 'metric')\n\nconst metricWidgetFields = (args: RegisterWidgetsArgs): Field[] => [\n\ttitleField(args, en[keys.widgetFieldTitlePlaceholder]),\n\tmetricSelectField(WIDGET_METRICS, args),\n\ttimeframeSelectField(),\n\tcustomRangeField(),\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\nconst breakdownWidgetFields = (args: RegisterWidgetsArgs, spec: BreakdownSpec): Field[] => [\n\ttitleField(args, en[spec.label]),\n\t// A goals breakdown is a conversion table: pageviews per goal is a stranger default.\n\tmetricSelectField(WIDGET_METRICS, args, {\n\t\textra: { dimensions: [spec.dimension] },\n\t\t...(spec.dimension === 'goal' ? { preferredDefault: 'conversions' as MetricKey } : {}),\n\t}),\n\ttimeframeSelectField(),\n\tcustomRangeField(),\n\t{\n\t\tname: 'limit',\n\t\ttype: 'number',\n\t\tdefaultValue: 5,\n\t\tmin: 1,\n\t\tmax: 20,\n\t\tlabel: labelForKey(keys.widgetFieldLimit),\n\t},\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\nconst realtimeWidgetFields = (args: RegisterWidgetsArgs): Field[] => [\n\ttitleField(args, en[keys.widgetFieldTitlePlaceholder]),\n\tmetricSelectField(['visitors', 'pageviews'], args, {\n\t\textra: { realtime: true },\n\t\tpreferredDefault: 'visitors',\n\t}),\n\t{\n\t\tname: 'windowMinutes',\n\t\ttype: 'select',\n\t\tdefaultValue: '30',\n\t\tlabel: labelForKey(keys.widgetFieldWindow),\n\t\tadmin: { isClearable: false },\n\t\toptions: [\n\t\t\t{ value: '5', label: '5 min' },\n\t\t\t{ value: '15', label: '15 min' },\n\t\t\t{ value: '30', label: '30 min' },\n\t\t\t{ value: '60', label: '60 min' },\n\t\t],\n\t},\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\nconst WIDGET_DEFS: WidgetDef[] = [\n\t{\n\t\tslug: 'analytics-metric',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsMetricWidget',\n\t\tlabel: keys.widgetMetricLabel,\n\t\tminWidth: 'x-small',\n\t\tmaxWidth: 'medium',\n\t\tfields: metricWidgetFields,\n\t},\n\t{\n\t\tslug: 'analytics-trend',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsTrendWidget',\n\t\tlabel: keys.widgetTrendLabel,\n\t\trequires: { metrics: ['pageviews'] },\n\t\tminWidth: 'small',\n\t\tmaxWidth: 'full',\n\t\tfields: metricWidgetFields,\n\t},\n\t{\n\t\tslug: 'analytics-realtime',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsRealtimeWidget',\n\t\tlabel: keys.widgetRealtimeLabel,\n\t\trequires: { realtime: true },\n\t\tminWidth: 'small' as WidgetWidth,\n\t\tmaxWidth: 'medium' as WidgetWidth,\n\t\tfields: realtimeWidgetFields,\n\t},\n\t...BREAKDOWN_SPECS.map(\n\t\t(spec): WidgetDef => ({\n\t\t\tslug: spec.slug,\n\t\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsBreakdownWidget',\n\t\t\tlabel: spec.label,\n\t\t\trequires: { dimensions: [spec.dimension] },\n\t\t\tminWidth: 'small' as WidgetWidth,\n\t\t\tmaxWidth: 'large' as WidgetWidth,\n\t\t\tfields: (args) => breakdownWidgetFields(args, spec),\n\t\t})\n\t),\n]\n\nexport const registerWidgets = (config: Config, args: RegisterWidgetsArgs): void => {\n\tconst built: Widget[] = []\n\tfor (const def of WIDGET_DEFS) {\n\t\tif (args.disabled.includes(def.slug)) {\n\t\t\tcontinue\n\t\t}\n\t\tif (!args.providersEnabled && !widgetIsSupported(def.requires, args.adapters)) {\n\t\t\tcontinue\n\t\t}\n\t\tconst fields = def.fields(args)\n\t\t// A required metric select with no servable option would make the widget\n\t\t// impossible to configure; skip it like an unsupported widget.\n\t\tconst metricField = findMetricField(fields)\n\t\tif (metricField && 'options' in metricField && metricField.options.length === 0) {\n\t\t\tcontinue\n\t\t}\n\t\tbuilt.push({\n\t\t\tslug: def.slug,\n\t\t\tComponent: def.component,\n\t\t\tlabel: labelForKey(def.label),\n\t\t\tfields,\n\t\t\tminWidth: def.minWidth,\n\t\t\tmaxWidth: def.maxWidth,\n\t\t})\n\t}\n\tbuilt.push(...buildCustomWidgets(args.register, args.adapters, args.disabled))\n\tif (!built.length) {\n\t\treturn\n\t}\n\tconfig.admin ??= {}\n\tconfig.admin.dashboard ??= { widgets: [] }\n\tconfig.admin.dashboard.widgets ??= []\n\tconfig.admin.dashboard.widgets.push(...built)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AA2BA,MAAM,eAAe,SAAiD;CACrE,IAAI,GAAG;CACP,IAAI,GAAG;AACR;AA8BA,MAAa,qBACZ,UACA,aACa,CAAC,YAAY,SAAS,MAAM,MAAM,sBAAsB,EAAE,cAAc,QAAQ,CAAC;;;;;;;;;;;;;;;AAgB/F,MAAM,qBACL,YACA,MACA,OAGI,CAAC,MACM;CACX,MAAM,EAAE,OAAO,mBAAmB,gBAAgB;CAClD,MAAM,YAAY,SAA2B,WAC5C,sBAAsB,QAAQ,cAAc;EAAE,GAAG;EAAO,SAAS,CAAC,MAAM;CAAE,CAAC;CAC5E,MAAM,WACL,KAAK,mBACF,aACA,WAAW,QAAQ,MAAM,KAAK,SAAS,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,CAAC,GACpE,KAAK,OAAO;EAAE,OAAO;EAAG,OAAO,YAAY,YAAY,EAAE;CAAE,EAAE;CAC/D,MAAM,eAAe,QAAQ,MAAM,MAAM,EAAE,UAAU,gBAAgB,IAClE,mBACA,QAAQ,IAAI;CACf,MAAM,iBAA+C,EAAE,SAAS,MAAM,kBAAkB;EACvF,MAAM,WAAY,aAAsD;EACxE,MAAM,UACL,OAAO,aAAa,WAAW,KAAK,SAAS,MAAM,MAAM,EAAE,OAAO,QAAQ,IAAI,KAAA;EAC/E,IAAI,CAAC,SACJ,OAAO;EAER,OAAO,KAAK,QAAQ,MAAM,OAAO,MAAM,YAAY,SAAS,SAAS,EAAE,KAAkB,CAAC;CAC3F;CACA,OAAO;EACN,MAAM;EACN,MAAM;EACN,UAAU;EACV,GAAI,iBAAiB,KAAA,IAAY,EAAE,aAAa,IAAI,CAAC;EACrD,OAAO,YAAY,KAAK,iBAAiB;EACzC;EACA,OAAO;GAEN,aAAa;GACb,YAAY,EACX,OAAO;IACN,MAAM;IACN,GAAI,QAAQ,EAAE,aAAa,EAAE,UAAU,MAAM,EAAE,IAAI,CAAC;GACrD,EACD;EACD;EACA,GAAI,KAAK,gBAAgB,EAAE,cAAc,IAAI,CAAC;CAC/C;AACD;AAEA,MAAM,cAAc,MAA2B,iBAAgC;CAC9E,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,gBAAgB;CACxC,GAAI,KAAK,eAAe,EAAE,WAAW,KAAK,IAAI,CAAC;CAC/C,OAAO,EAAE,YAAY;AACtB;AAEA,MAAM,8BAAqC;CAC1C,MAAM;CACN,MAAM;CACN,UAAU;CACV,cAAc;CACd,OAAO,YAAY,KAAK,oBAAoB;CAC5C,OAAO,EAAE,aAAa,MAAM;CAC5B,SAAS,CACR,GAAG,kBAAkB,KAAK,OAAO;EAAE,OAAO;EAAG,OAAO,YAAY,eAAe,EAAE;CAAE,EAAE,GACrF;EAAE,OAAO;EAAU,OAAO,YAAY,KAAK,qBAAqB;CAAE,CACnE;AACD;AAEA,MAAM,mBAAmB,UAAsC;CAC9D,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,qBAAqB;CAC7C,cAAc,KAAK,aAAa,KAAK,SAAS,IAAI;CAClD,OAAO;EAEN,aAAa;EACb,YAAY,EAAE,OAAO,EAAE,MAAM,gDAAgD,EAAE;CAChF;CACA,SAAS,KAAK,SAAS,KAAK,OAAO;EAAE,OAAO,EAAE;EAAI,OAAO,EAAE;CAAM,EAAE;CAGnE,YAAY,UACX,UAAU,KAAA,KAAa,UAAU,QAAS,OAAO,UAAU,YAAY,MAAM,SAAS,IACnF,OACA;AACL;AAEA,MAAM,yBACL,eAAe;CACd,MAAM;CACN,OAAO,YAAY,KAAK,gBAAgB;CACxC,kBAAkB;CAClB,YAAY,OAAO;EAClB,GAAG;EACH,OAAO;GACN,GAAG,EAAE;GACL,YAAY,OAAO,gBAAgB,aAAa,cAAc;EAC/D;CACD;AACD,CAAC;;AAGF,MAAa,mBAAmB,WAC/B,OAAO,MAAM,UAAU,UAAU,SAAS,MAAM,SAAS,QAAQ;AAElE,MAAM,sBAAsB,SAAuC;CAClE,WAAW,MAAM,GAAG,KAAK,4BAA4B;CACrD,kBAAkB,gBAAgB,IAAI;CACtC,qBAAqB;CACrB,iBAAiB;CACjB,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;AAEA,MAAM,yBAAyB,MAA2B,SAAiC;CAC1F,WAAW,MAAM,GAAG,KAAK,MAAM;CAE/B,kBAAkB,gBAAgB,MAAM;EACvC,OAAO,EAAE,YAAY,CAAC,KAAK,SAAS,EAAE;EACtC,GAAI,KAAK,cAAc,SAAS,EAAE,kBAAkB,cAA2B,IAAI,CAAC;CACrF,CAAC;CACD,qBAAqB;CACrB,iBAAiB;CACjB;EACC,MAAM;EACN,MAAM;EACN,cAAc;EACd,KAAK;EACL,KAAK;EACL,OAAO,YAAY,KAAK,gBAAgB;CACzC;CACA,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;AAEA,MAAM,wBAAwB,SAAuC;CACpE,WAAW,MAAM,GAAG,KAAK,4BAA4B;CACrD,kBAAkB,CAAC,YAAY,WAAW,GAAG,MAAM;EAClD,OAAO,EAAE,UAAU,KAAK;EACxB,kBAAkB;CACnB,CAAC;CACD;EACC,MAAM;EACN,MAAM;EACN,cAAc;EACd,OAAO,YAAY,KAAK,iBAAiB;EACzC,OAAO,EAAE,aAAa,MAAM;EAC5B,SAAS;GACR;IAAE,OAAO;IAAK,OAAO;GAAQ;GAC7B;IAAE,OAAO;IAAM,OAAO;GAAS;GAC/B;IAAE,OAAO;IAAM,OAAO;GAAS;GAC/B;IAAE,OAAO;IAAM,OAAO;GAAS;EAChC;CACD;CACA,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;AAEA,MAAM,cAA2B;CAChC;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,SAAS,CAAC,WAAW,EAAE;EACnC,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,UAAU,KAAK;EAC3B,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA,GAAG,gBAAgB,KACjB,UAAqB;EACrB,MAAM,KAAK;EACX,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,YAAY,CAAC,KAAK,SAAS,EAAE;EACzC,UAAU;EACV,UAAU;EACV,SAAS,SAAS,sBAAsB,MAAM,IAAI;CACnD,EACD;AACD;AAEA,MAAa,mBAAmB,QAAgB,SAAoC;CACnF,MAAM,QAAkB,CAAC;CACzB,KAAK,MAAM,OAAO,aAAa;EAC9B,IAAI,KAAK,SAAS,SAAS,IAAI,IAAI,GAClC;EAED,IAAI,CAAC,KAAK,oBAAoB,CAAC,kBAAkB,IAAI,UAAU,KAAK,QAAQ,GAC3E;EAED,MAAM,SAAS,IAAI,OAAO,IAAI;EAG9B,MAAM,cAAc,gBAAgB,MAAM;EAC1C,IAAI,eAAe,aAAa,eAAe,YAAY,QAAQ,WAAW,GAC7E;EAED,MAAM,KAAK;GACV,MAAM,IAAI;GACV,WAAW,IAAI;GACf,OAAO,YAAY,IAAI,KAAK;GAC5B;GACA,UAAU,IAAI;GACd,UAAU,IAAI;EACf,CAAC;CACF;CACA,MAAM,KAAK,GAAG,mBAAmB,KAAK,UAAU,KAAK,UAAU,KAAK,QAAQ,CAAC;CAC7E,IAAI,CAAC,MAAM,QACV;CAED,OAAO,UAAU,CAAC;CAClB,OAAO,MAAM,cAAc,EAAE,SAAS,CAAC,EAAE;CACzC,OAAO,MAAM,UAAU,YAAY,CAAC;CACpC,OAAO,MAAM,UAAU,QAAQ,KAAK,GAAG,KAAK;AAC7C"}
|
package/dist/widgets/types.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","names":[],"sources":["../../src/widgets/types.ts"],"sourcesContent":["import type { MetricKey } from '../core/contract'\nimport type { TimeframePreset } from '../timeframe/presets'\n\nexport interface WidgetRange {\n\tfrom?: string\n\tto?: string\n}\n\nexport interface MetricWidgetData {\n\ttitle?: string\n\tmetric?: MetricKey\n\ttimeframe?: TimeframePreset | 'custom'\n\trange?: WidgetRange\n\tdataSource?: string\n}\n\nexport const WIDGET_METRICS: MetricKey[] = [\n\t'pageviews',\n\t'visitors',\n\t'sessions',\n\t'avgDuration',\n\t'bounceRate',\n\t'events',\n]\n"],"mappings":";AAgBA,MAAa,iBAA8B;CAC1C;CACA;CACA;CACA;CACA;CACA;AACD"}
|
|
1
|
+
{"version":3,"file":"types.js","names":[],"sources":["../../src/widgets/types.ts"],"sourcesContent":["import type { MetricKey } from '../core/contract'\nimport type { TimeframePreset } from '../timeframe/presets'\n\nexport interface WidgetRange {\n\tfrom?: string\n\tto?: string\n}\n\nexport interface MetricWidgetData {\n\ttitle?: string\n\tmetric?: MetricKey\n\ttimeframe?: TimeframePreset | 'custom'\n\trange?: WidgetRange\n\tdataSource?: string\n}\n\nexport const WIDGET_METRICS: MetricKey[] = [\n\t'pageviews',\n\t'visitors',\n\t'sessions',\n\t'avgDuration',\n\t'bounceRate',\n\t'events',\n\t'conversions',\n\t'revenue',\n\t'scrollDepth',\n]\n"],"mappings":";AAgBA,MAAa,iBAA8B;CAC1C;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@10x-media/analytics",
|
|
3
|
-
"version": "1.0.0-beta.
|
|
3
|
+
"version": "1.0.0-beta.7",
|
|
4
4
|
"description": "Adapter-based analytics for Payload: providers, a native engine, dashboard widgets, and portable fields.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -37,6 +37,16 @@
|
|
|
37
37
|
"import": "./dist/exports/client.js",
|
|
38
38
|
"default": "./dist/exports/client.js"
|
|
39
39
|
},
|
|
40
|
+
"./tracker": {
|
|
41
|
+
"types": "./dist/exports/tracker.d.ts",
|
|
42
|
+
"import": "./dist/exports/tracker.js",
|
|
43
|
+
"default": "./dist/exports/tracker.js"
|
|
44
|
+
},
|
|
45
|
+
"./react": {
|
|
46
|
+
"types": "./dist/exports/react.d.ts",
|
|
47
|
+
"import": "./dist/exports/react.js",
|
|
48
|
+
"default": "./dist/exports/react.js"
|
|
49
|
+
},
|
|
40
50
|
"./rsc": {
|
|
41
51
|
"types": "./dist/exports/rsc.d.ts",
|
|
42
52
|
"import": "./dist/exports/rsc.js",
|
|
@@ -94,8 +104,11 @@
|
|
|
94
104
|
"CHANGELOG.md",
|
|
95
105
|
"LICENSE"
|
|
96
106
|
],
|
|
107
|
+
"dependencies": {
|
|
108
|
+
"path-to-regexp": "6.3.0"
|
|
109
|
+
},
|
|
97
110
|
"peerDependencies": {
|
|
98
|
-
"@10x-media/fields": "^0.1.0-beta.
|
|
111
|
+
"@10x-media/fields": "^0.1.0-beta.7",
|
|
99
112
|
"@google-analytics/data": "^6.0.0",
|
|
100
113
|
"@payloadcms/db-postgres": "^3.82.0",
|
|
101
114
|
"@payloadcms/ui": "^3.83.0",
|
|
@@ -125,9 +138,11 @@
|
|
|
125
138
|
"@payloadcms/db-postgres": "3.85.0",
|
|
126
139
|
"@payloadcms/ui": "3.85.0",
|
|
127
140
|
"@playwright/test": "1.60.0",
|
|
141
|
+
"@testing-library/react": "^16.1.0",
|
|
128
142
|
"@types/node": "22.19.19",
|
|
129
143
|
"@types/react": "19.2.15",
|
|
130
144
|
"@types/react-dom": "19.2.3",
|
|
145
|
+
"jsdom": "^25.0.1",
|
|
131
146
|
"maxmind": "^4.3.24",
|
|
132
147
|
"msw": "^2.14.6",
|
|
133
148
|
"payload": "3.85.0",
|
|
@@ -138,11 +153,11 @@
|
|
|
138
153
|
"tsdown": "0.22.1",
|
|
139
154
|
"typescript": "5.9.3",
|
|
140
155
|
"vitest": "4.1.7",
|
|
141
|
-
"@10x-media/
|
|
142
|
-
"@10x-media/vitest-config": "0.0.0",
|
|
156
|
+
"@10x-media/tsconfig": "0.0.0",
|
|
143
157
|
"@10x-media/tsdown-config": "0.0.0",
|
|
144
|
-
"@10x-media/
|
|
145
|
-
"@10x-media/
|
|
158
|
+
"@10x-media/vitest-config": "0.0.0",
|
|
159
|
+
"@10x-media/fields": "0.1.0-beta.7",
|
|
160
|
+
"@10x-media/payload-test-harness": "0.0.0"
|
|
146
161
|
},
|
|
147
162
|
"publishConfig": {
|
|
148
163
|
"access": "public"
|