@10x-media/analytics 0.1.0-beta.5 → 1.0.0-beta.6
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 +15 -0
- package/LICENSE +21 -21
- package/dist/adapters/ga4/ga4.js +13 -0
- package/dist/adapters/ga4/ga4.js.map +1 -1
- package/dist/adapters/plausible/plausible.js +11 -0
- package/dist/adapters/plausible/plausible.js.map +1 -1
- package/dist/adapters/posthog/posthog.js +37 -3
- package/dist/adapters/posthog/posthog.js.map +1 -1
- package/dist/adapters/series.js +11 -1
- package/dist/adapters/series.js.map +1 -1
- package/dist/adapters/umami/umami.js +2 -0
- package/dist/adapters/umami/umami.js.map +1 -1
- package/dist/core/capabilities.d.ts +5 -1
- package/dist/core/capabilities.js +4 -0
- package/dist/core/capabilities.js.map +1 -1
- package/dist/core/contract.d.ts +7 -2
- package/dist/core/contract.js.map +1 -1
- package/dist/exports/rsc.d.ts +2 -2
- package/dist/exports/types.d.ts +2 -2
- package/dist/index.js +6 -1
- package/dist/index.js.map +1 -1
- package/dist/native/collections/rollups.js +15 -3
- package/dist/native/collections/rollups.js.map +1 -1
- package/dist/native/nativeAdapter.js +81 -2
- package/dist/native/nativeAdapter.js.map +1 -1
- package/dist/native/query/eventAgg.js +135 -0
- package/dist/native/query/eventAgg.js.map +1 -0
- package/dist/native/rollups/applyDistinctDeltas.js +1 -1
- package/dist/native/rollups/applyDistinctDeltas.js.map +1 -1
- package/dist/native/rollups/bumpRollup.js +2 -1
- package/dist/native/rollups/bumpRollup.js.map +1 -1
- package/dist/native/rollups/deltas.js +45 -8
- package/dist/native/rollups/deltas.js.map +1 -1
- package/dist/sync/collection.js +23 -7
- package/dist/sync/collection.js.map +1 -1
- package/dist/sync/syncTask.js +12 -4
- package/dist/sync/syncTask.js.map +1 -1
- package/dist/testing/memoryAdapter.js +7 -0
- package/dist/testing/memoryAdapter.js.map +1 -1
- package/dist/translations/ar.js +77 -0
- package/dist/translations/ar.js.map +1 -0
- package/dist/translations/es.js +77 -0
- package/dist/translations/es.js.map +1 -0
- package/dist/translations/fr.js +77 -0
- package/dist/translations/fr.js.map +1 -0
- package/dist/translations/id.js +77 -0
- package/dist/translations/id.js.map +1 -0
- package/dist/translations/index.d.ts +10 -1
- package/dist/translations/index.js +19 -1
- package/dist/translations/index.js.map +1 -1
- package/dist/translations/ko.js +77 -0
- package/dist/translations/ko.js.map +1 -0
- package/dist/translations/pt.js +77 -0
- package/dist/translations/pt.js.map +1 -0
- package/dist/translations/ru.js +77 -0
- package/dist/translations/ru.js.map +1 -0
- package/dist/translations/uk.js +77 -0
- package/dist/translations/uk.js.map +1 -0
- package/dist/translations/zh.js +77 -0
- package/dist/translations/zh.js.map +1 -0
- package/dist/widgets/readForWidget.d.ts +2 -1
- package/dist/widgets/readForWidget.js +10 -2
- package/dist/widgets/readForWidget.js.map +1 -1
- package/dist/widgets/readForWidgetBreakdown.d.ts +2 -1
- package/dist/widgets/readForWidgetBreakdown.js +7 -2
- package/dist/widgets/readForWidgetBreakdown.js.map +1 -1
- package/dist/widgets/readForWidgetSeries.d.ts +2 -1
- package/dist/widgets/readForWidgetSeries.js +10 -2
- package/dist/widgets/readForWidgetSeries.js.map +1 -1
- package/package.json +6 -6
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { DateRange, MetricKey } from "../core/contract.js";
|
|
1
|
+
import { AnalyticsFilter, DateRange, MetricKey } from "../core/contract.js";
|
|
2
2
|
import { TimeframePreset } from "../timeframe/presets.js";
|
|
3
3
|
import { PayloadRequest } from "payload";
|
|
4
4
|
|
|
@@ -24,6 +24,7 @@ interface ReadForWidgetArgs {
|
|
|
24
24
|
range?: DateRange;
|
|
25
25
|
/** Explicit scope override; omitted resolves via the plugin's scopeResolver. */
|
|
26
26
|
scope?: string | null;
|
|
27
|
+
filters?: AnalyticsFilter[];
|
|
27
28
|
}
|
|
28
29
|
declare const readForWidget: (args: ReadForWidgetArgs) => Promise<WidgetReadResult>;
|
|
29
30
|
//#endregion
|
|
@@ -5,7 +5,7 @@ import { resolveTimeframe } from "../timeframe/presets.js";
|
|
|
5
5
|
import { previousWindow } from "./comparison.js";
|
|
6
6
|
//#region src/widgets/readForWidget.ts
|
|
7
7
|
const readForWidget = async (args) => {
|
|
8
|
-
const { req, metrics, timeframe, adapterId, now, range } = args;
|
|
8
|
+
const { req, metrics, timeframe, adapterId, now, range, filters } = args;
|
|
9
9
|
const emptyMetrics = {};
|
|
10
10
|
const runtime = getRuntime(req.payload);
|
|
11
11
|
if (!runtime) return {
|
|
@@ -38,7 +38,13 @@ const readForWidget = async (args) => {
|
|
|
38
38
|
adapterId: adapter.id,
|
|
39
39
|
...base
|
|
40
40
|
};
|
|
41
|
-
if (!satisfiesCapabilities(adapter.capabilities, {
|
|
41
|
+
if (!satisfiesCapabilities(adapter.capabilities, {
|
|
42
|
+
metrics,
|
|
43
|
+
...filters && filters.length > 0 ? {
|
|
44
|
+
filters: filters.map((f) => f.dimension),
|
|
45
|
+
filterOperators: filters.map((f) => f.operator)
|
|
46
|
+
} : {}
|
|
47
|
+
})) return {
|
|
42
48
|
status: "unavailable",
|
|
43
49
|
adapterId: adapter.id,
|
|
44
50
|
...base
|
|
@@ -47,11 +53,13 @@ const readForWidget = async (args) => {
|
|
|
47
53
|
const [result, previous] = await Promise.all([runtime.engine.read(adapter, {
|
|
48
54
|
metrics,
|
|
49
55
|
dateRange,
|
|
56
|
+
filters,
|
|
50
57
|
timezone: tz,
|
|
51
58
|
scope: ctx.queryScope
|
|
52
59
|
}), comparisonRange ? runtime.engine.read(adapter, {
|
|
53
60
|
metrics,
|
|
54
61
|
dateRange: comparisonRange,
|
|
62
|
+
filters,
|
|
55
63
|
timezone: tz,
|
|
56
64
|
scope: ctx.queryScope
|
|
57
65
|
}) : void 0]);
|
|
@@ -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 { AnalyticsAdapter, DateRange, MetricKey } 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}\n\nexport const readForWidget = async (args: ReadForWidgetArgs): Promise<WidgetReadResult> => {\n\tconst { req, metrics, timeframe, adapterId, now, range } = 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 (!satisfiesCapabilities(adapter.capabilities, {
|
|
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 { AnalyticsAdapter, AnalyticsFilter, DateRange, MetricKey } 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\tconst [result, previous] = await Promise.all([\n\t\truntime.engine.read(adapter, {\n\t\t\tmetrics,\n\t\t\tdateRange,\n\t\t\tfilters,\n\t\t\ttimezone: tz,\n\t\t\tscope: ctx.queryScope,\n\t\t}),\n\t\tcomparisonRange\n\t\t\t? runtime.engine.read(adapter, {\n\t\t\t\t\tmetrics,\n\t\t\t\t\tdateRange: comparisonRange,\n\t\t\t\t\tfilters,\n\t\t\t\t\ttimezone: tz,\n\t\t\t\t\tscope: ctx.queryScope,\n\t\t\t\t})\n\t\t\t: undefined,\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":";;;;;;AAkCA,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,MAAM,CAAC,QAAQ,YAAY,MAAM,QAAQ,IAAI,CAC5C,QAAQ,OAAO,KAAK,SAAS;EAC5B;EACA;EACA;EACA,UAAU;EACV,OAAO,IAAI;CACZ,CAAC,GACD,kBACG,QAAQ,OAAO,KAAK,SAAS;EAC7B;EACA,WAAW;EACX;EACA,UAAU;EACV,OAAO,IAAI;CACZ,CAAC,IACA,KAAA,CACJ,CAAC;CACD,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,4 +1,4 @@
|
|
|
1
|
-
import { DateRange, DimensionKey, MetricKey } from "../core/contract.js";
|
|
1
|
+
import { AnalyticsFilter, DateRange, DimensionKey, MetricKey } from "../core/contract.js";
|
|
2
2
|
import { TimeframePreset } from "../timeframe/presets.js";
|
|
3
3
|
import { WidgetReadStatus } from "./readForWidget.js";
|
|
4
4
|
import { PayloadRequest } from "payload";
|
|
@@ -26,6 +26,7 @@ interface ReadForWidgetBreakdownArgs {
|
|
|
26
26
|
range?: DateRange;
|
|
27
27
|
/** Explicit scope override; omitted resolves via the plugin's scopeResolver. */
|
|
28
28
|
scope?: string | null;
|
|
29
|
+
filters?: AnalyticsFilter[];
|
|
29
30
|
}
|
|
30
31
|
/**
|
|
31
32
|
* Site-wide ranked breakdown of one metric by one dimension, read through the engine.
|
|
@@ -9,7 +9,7 @@ import { resolveTimeframe } from "../timeframe/presets.js";
|
|
|
9
9
|
* `{ label, value }` pair the bar list renders. The adapter owns sorting and limiting.
|
|
10
10
|
*/
|
|
11
11
|
const readForWidgetBreakdown = async (args) => {
|
|
12
|
-
const { req, metric, dimension, timeframe, limit, adapterId, now, range } = args;
|
|
12
|
+
const { req, metric, dimension, timeframe, limit, adapterId, now, range, filters } = args;
|
|
13
13
|
const emptyRows = [];
|
|
14
14
|
const runtime = getRuntime(req.payload);
|
|
15
15
|
if (!runtime) return {
|
|
@@ -44,7 +44,11 @@ const readForWidgetBreakdown = async (args) => {
|
|
|
44
44
|
};
|
|
45
45
|
if (!satisfiesCapabilities(adapter.capabilities, {
|
|
46
46
|
metrics: [metric],
|
|
47
|
-
dimensions: [dimension]
|
|
47
|
+
dimensions: [dimension],
|
|
48
|
+
...filters && filters.length > 0 ? {
|
|
49
|
+
filters: filters.map((f) => f.dimension),
|
|
50
|
+
filterOperators: filters.map((f) => f.operator)
|
|
51
|
+
} : {}
|
|
48
52
|
})) return {
|
|
49
53
|
status: "unavailable",
|
|
50
54
|
adapterId: adapter.id,
|
|
@@ -59,6 +63,7 @@ const readForWidgetBreakdown = async (args) => {
|
|
|
59
63
|
metric,
|
|
60
64
|
direction: "desc"
|
|
61
65
|
},
|
|
66
|
+
filters,
|
|
62
67
|
timezone: tz,
|
|
63
68
|
scope: ctx.queryScope
|
|
64
69
|
});
|
|
@@ -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 {
|
|
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\tconst result = await runtime.engine.read(adapter, {\n\t\tmetrics: [metric],\n\t\tdimensions: [dimension],\n\t\tdateRange,\n\t\tlimit,\n\t\torder: { metric, direction: 'desc' },\n\t\tfilters,\n\t\ttimezone: tz,\n\t\tscope: ctx.queryScope,\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":";;;;;;;;;;AA8CA,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,MAAM,SAAS,MAAM,QAAQ,OAAO,KAAK,SAAS;EACjD,SAAS,CAAC,MAAM;EAChB,YAAY,CAAC,SAAS;EACtB;EACA;EACA,OAAO;GAAE;GAAQ,WAAW;EAAO;EACnC;EACA,UAAU;EACV,OAAO,IAAI;CACZ,CAAC;CACD,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,4 +1,4 @@
|
|
|
1
|
-
import { DateRange, MetricKey } from "../core/contract.js";
|
|
1
|
+
import { AnalyticsFilter, DateRange, MetricKey } from "../core/contract.js";
|
|
2
2
|
import { TimeframePreset } from "../timeframe/presets.js";
|
|
3
3
|
import { WidgetReadStatus } from "./readForWidget.js";
|
|
4
4
|
import { PayloadRequest } from "payload";
|
|
@@ -31,6 +31,7 @@ interface ReadForWidgetSeriesArgs {
|
|
|
31
31
|
range?: DateRange;
|
|
32
32
|
/** Explicit scope override; omitted resolves via the plugin's scopeResolver. */
|
|
33
33
|
scope?: string | null;
|
|
34
|
+
filters?: AnalyticsFilter[];
|
|
34
35
|
}
|
|
35
36
|
/**
|
|
36
37
|
* Site-wide time-series read for a trend widget: resolve the timeframe, pick the
|
|
@@ -43,7 +43,7 @@ const fillDailySeries = (args) => {
|
|
|
43
43
|
* `readForWidget` but yields points instead of a single value.
|
|
44
44
|
*/
|
|
45
45
|
const readForWidgetSeries = async (args) => {
|
|
46
|
-
const { req, metric, timeframe, adapterId, now, range } = args;
|
|
46
|
+
const { req, metric, timeframe, adapterId, now, range, filters } = args;
|
|
47
47
|
const fallback = (status, id) => ({
|
|
48
48
|
status,
|
|
49
49
|
adapterId: id,
|
|
@@ -75,7 +75,13 @@ const readForWidgetSeries = async (args) => {
|
|
|
75
75
|
adapterId: adapter.id,
|
|
76
76
|
...base
|
|
77
77
|
};
|
|
78
|
-
if (!satisfiesCapabilities(adapter.capabilities, {
|
|
78
|
+
if (!satisfiesCapabilities(adapter.capabilities, {
|
|
79
|
+
metrics: [metric],
|
|
80
|
+
...filters && filters.length > 0 ? {
|
|
81
|
+
filters: filters.map((f) => f.dimension),
|
|
82
|
+
filterOperators: filters.map((f) => f.operator)
|
|
83
|
+
} : {}
|
|
84
|
+
}) || !supportsGranularity(adapter.capabilities, "day")) return {
|
|
79
85
|
status: "unavailable",
|
|
80
86
|
adapterId: adapter.id,
|
|
81
87
|
...base
|
|
@@ -85,11 +91,13 @@ const readForWidgetSeries = async (args) => {
|
|
|
85
91
|
metrics: [metric],
|
|
86
92
|
dateRange,
|
|
87
93
|
granularity: "day",
|
|
94
|
+
filters,
|
|
88
95
|
timezone: tz,
|
|
89
96
|
scope: ctx.queryScope
|
|
90
97
|
}), comparisonRange ? runtime.engine.read(adapter, {
|
|
91
98
|
metrics: [metric],
|
|
92
99
|
dateRange: comparisonRange,
|
|
100
|
+
filters,
|
|
93
101
|
timezone: tz,
|
|
94
102
|
scope: ctx.queryScope
|
|
95
103
|
}) : void 0]);
|
|
@@ -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 {
|
|
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\tconst [result, previous] = await Promise.all([\n\t\truntime.engine.read(adapter, {\n\t\t\tmetrics: [metric],\n\t\t\tdateRange,\n\t\t\tgranularity: 'day',\n\t\t\tfilters,\n\t\t\ttimezone: tz,\n\t\t\tscope: ctx.queryScope,\n\t\t}),\n\t\tcomparisonRange\n\t\t\t? runtime.engine.read(adapter, {\n\t\t\t\t\tmetrics: [metric],\n\t\t\t\t\tdateRange: comparisonRange,\n\t\t\t\t\tfilters,\n\t\t\t\t\ttimezone: tz,\n\t\t\t\t\tscope: ctx.queryScope,\n\t\t\t\t})\n\t\t\t: undefined,\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":";;;;;;;;AAiDA,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,MAAM,CAAC,QAAQ,YAAY,MAAM,QAAQ,IAAI,CAC5C,QAAQ,OAAO,KAAK,SAAS;EAC5B,SAAS,CAAC,MAAM;EAChB;EACA,aAAa;EACb;EACA,UAAU;EACV,OAAO,IAAI;CACZ,CAAC,GACD,kBACG,QAAQ,OAAO,KAAK,SAAS;EAC7B,SAAS,CAAC,MAAM;EAChB,WAAW;EACX;EACA,UAAU;EACV,OAAO,IAAI;CACZ,CAAC,IACA,KAAA,CACJ,CAAC;CACD,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"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@10x-media/analytics",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "1.0.0-beta.6",
|
|
4
4
|
"description": "Adapter-based analytics for Payload: providers, a native engine, dashboard widgets, and portable fields.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -95,7 +95,7 @@
|
|
|
95
95
|
"LICENSE"
|
|
96
96
|
],
|
|
97
97
|
"peerDependencies": {
|
|
98
|
-
"@10x-media/fields": "^0.1.0-beta.
|
|
98
|
+
"@10x-media/fields": "^0.1.0-beta.6",
|
|
99
99
|
"@google-analytics/data": "^6.0.0",
|
|
100
100
|
"@payloadcms/db-postgres": "^3.82.0",
|
|
101
101
|
"@payloadcms/ui": "^3.83.0",
|
|
@@ -138,11 +138,11 @@
|
|
|
138
138
|
"tsdown": "0.22.1",
|
|
139
139
|
"typescript": "5.9.3",
|
|
140
140
|
"vitest": "4.1.7",
|
|
141
|
-
"@10x-media/tsconfig": "0.0.0",
|
|
142
|
-
"@10x-media/fields": "0.1.0-beta.5",
|
|
143
|
-
"@10x-media/vitest-config": "0.0.0",
|
|
144
141
|
"@10x-media/payload-test-harness": "0.0.0",
|
|
145
|
-
"@10x-media/
|
|
142
|
+
"@10x-media/vitest-config": "0.0.0",
|
|
143
|
+
"@10x-media/tsdown-config": "0.0.0",
|
|
144
|
+
"@10x-media/fields": "0.1.0-beta.6",
|
|
145
|
+
"@10x-media/tsconfig": "0.0.0"
|
|
146
146
|
},
|
|
147
147
|
"publishConfig": {
|
|
148
148
|
"access": "public"
|