@10x-media/analytics 0.1.0-beta.1 → 0.1.0-beta.3
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 +64 -0
- package/README.md +1 -0
- package/dist/adapters/ga4/ga4.js +17 -7
- package/dist/adapters/ga4/ga4.js.map +1 -1
- package/dist/adapters/plausible/plausible.js +5 -0
- package/dist/adapters/plausible/plausible.js.map +1 -1
- package/dist/adapters/posthog/posthog.js +28 -17
- package/dist/adapters/posthog/posthog.js.map +1 -1
- package/dist/adapters/umami/umami.js +1 -1
- package/dist/adapters/umami/umami.js.map +1 -1
- package/dist/binding/types.d.ts +9 -7
- package/dist/charts/TrendChart.js +17 -8
- package/dist/charts/TrendChart.js.map +1 -1
- package/dist/charts/bucket.js +31 -24
- package/dist/charts/bucket.js.map +1 -1
- package/dist/core/cacheKey.js +4 -7
- package/dist/core/cacheKey.js.map +1 -1
- package/dist/core/contract.d.ts +12 -1
- package/dist/core/contract.js.map +1 -1
- package/dist/core/options.d.ts +27 -2
- package/dist/core/options.js +15 -8
- package/dist/core/options.js.map +1 -1
- package/dist/exports/rsc.d.ts +6 -3
- package/dist/exports/rsc.js +5 -2
- package/dist/fields/AnalyticsPanelClient.js +193 -0
- package/dist/fields/AnalyticsPanelClient.js.map +1 -0
- package/dist/fields/AnalyticsPanelField.d.ts +28 -0
- package/dist/fields/AnalyticsPanelField.js +54 -0
- package/dist/fields/AnalyticsPanelField.js.map +1 -0
- package/dist/fields/AnalyticsStatField.d.ts +1 -1
- package/dist/fields/AnalyticsStatField.js +14 -3
- package/dist/fields/AnalyticsStatField.js.map +1 -1
- package/dist/fields/emptyState.js +46 -0
- package/dist/fields/emptyState.js.map +1 -0
- package/dist/fields/factories.d.ts +10 -2
- package/dist/fields/factories.js +33 -4
- package/dist/fields/factories.js.map +1 -1
- package/dist/fields/readForDocument.d.ts +57 -0
- package/dist/fields/readForDocument.js +50 -10
- package/dist/fields/readForDocument.js.map +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.js +29 -4
- package/dist/index.js.map +1 -1
- package/dist/native/ingest/endpoint.js +5 -2
- package/dist/native/ingest/endpoint.js.map +1 -1
- package/dist/native/ingest/normalizeEvent.js +3 -2
- package/dist/native/ingest/normalizeEvent.js.map +1 -1
- package/dist/native/ingest/writeEvent.js +2 -1
- package/dist/native/ingest/writeEvent.js.map +1 -1
- package/dist/native/nativeAdapter.js +7 -4
- package/dist/native/nativeAdapter.js.map +1 -1
- package/dist/native/rollupAcc.js +9 -6
- package/dist/native/rollupAcc.js.map +1 -1
- package/dist/native/rollups/bumpRollup.js +17 -1
- package/dist/native/rollups/bumpRollup.js.map +1 -1
- package/dist/native/rollups/deltas.js +2 -2
- package/dist/native/rollups/deltas.js.map +1 -1
- package/dist/plugin/documentEndpoint.js +80 -0
- package/dist/plugin/documentEndpoint.js.map +1 -0
- package/dist/plugin/paths.js +11 -0
- package/dist/plugin/paths.js.map +1 -0
- package/dist/plugin/runtime.js +2 -1
- package/dist/plugin/runtime.js.map +1 -1
- package/dist/plugin/warmTask.js +1 -1
- package/dist/surfacing/engine.js +5 -5
- package/dist/surfacing/engine.js.map +1 -1
- package/dist/sync/collection.js +11 -6
- package/dist/sync/collection.js.map +1 -1
- package/dist/sync/syncTask.js +1 -1
- package/dist/timeframe/presets.js +12 -16
- package/dist/timeframe/presets.js.map +1 -1
- package/dist/timeframe/tz.js +110 -0
- package/dist/timeframe/tz.js.map +1 -0
- package/dist/translations/de.js +78 -0
- package/dist/translations/de.js.map +1 -0
- package/dist/translations/en.js +5 -2
- package/dist/translations/en.js.map +1 -1
- package/dist/translations/index.d.ts +2 -1
- package/dist/translations/index.js +6 -2
- package/dist/translations/index.js.map +1 -1
- package/dist/translations/keys.d.ts +5 -2
- package/dist/translations/keys.js +5 -2
- package/dist/translations/keys.js.map +1 -1
- package/dist/translations/metricKeys.js +0 -2
- package/dist/translations/metricKeys.js.map +1 -1
- package/dist/widgets/AnalyticsBreakdownWidget.js +1 -1
- package/dist/widgets/AnalyticsMetricWidget.js +9 -1
- package/dist/widgets/AnalyticsMetricWidget.js.map +1 -1
- package/dist/widgets/AnalyticsRealtimeWidget.js +1 -1
- package/dist/widgets/AnalyticsTrendWidget.js +10 -2
- package/dist/widgets/AnalyticsTrendWidget.js.map +1 -1
- package/dist/widgets/ComparisonDelta.js +83 -0
- package/dist/widgets/ComparisonDelta.js.map +1 -0
- package/dist/widgets/cardChrome.d.ts +8 -0
- package/dist/widgets/comparison.js +43 -0
- package/dist/widgets/comparison.js.map +1 -0
- package/dist/widgets/readForWidget.d.ts +4 -0
- package/dist/widgets/readForWidget.js +26 -11
- package/dist/widgets/readForWidget.js.map +1 -1
- package/dist/widgets/readForWidgetBreakdown.js +13 -8
- package/dist/widgets/readForWidgetBreakdown.js.map +1 -1
- package/dist/widgets/readForWidgetRealtime.js +1 -1
- package/dist/widgets/readForWidgetRealtime.js.map +1 -1
- package/dist/widgets/readForWidgetSeries.d.ts +6 -0
- package/dist/widgets/readForWidgetSeries.js +60 -40
- package/dist/widgets/readForWidgetSeries.js.map +1 -1
- package/dist/widgets/registerWidgets.js +148 -169
- package/dist/widgets/registerWidgets.js.map +1 -1
- package/package.json +5 -5
package/dist/charts/bucket.js
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { startOfDayInTz, startOfMonthInTz, startOfWeekInTz } from "../timeframe/tz.js";
|
|
1
2
|
//#region src/charts/bucket.ts
|
|
2
3
|
const UNIT_BY_TIMEFRAME = {
|
|
3
4
|
today: "day",
|
|
@@ -9,21 +10,15 @@ const UNIT_BY_TIMEFRAME = {
|
|
|
9
10
|
lastYear: "month",
|
|
10
11
|
allTime: "month"
|
|
11
12
|
};
|
|
12
|
-
const
|
|
13
|
-
|
|
14
|
-
if (unit === "
|
|
15
|
-
|
|
16
|
-
const day = startOfUtcDay(d);
|
|
17
|
-
const dow = (day.getUTCDay() + 6) % 7;
|
|
18
|
-
day.setUTCDate(day.getUTCDate() - dow);
|
|
19
|
-
return day;
|
|
20
|
-
}
|
|
21
|
-
return startOfUtcDay(d);
|
|
13
|
+
const bucketStart = (d, unit, tz) => {
|
|
14
|
+
if (unit === "month") return startOfMonthInTz(d, tz);
|
|
15
|
+
if (unit === "week") return startOfWeekInTz(d, tz);
|
|
16
|
+
return startOfDayInTz(d, tz);
|
|
22
17
|
};
|
|
23
|
-
const bucketByUnit = (points, unit, weekday) => {
|
|
18
|
+
const bucketByUnit = (points, { unit, weekday, tz }) => {
|
|
24
19
|
const groups = /* @__PURE__ */ new Map();
|
|
25
20
|
for (const p of points) {
|
|
26
|
-
const d = bucketStart(new Date(p.date), unit);
|
|
21
|
+
const d = bucketStart(new Date(p.date), unit, tz);
|
|
27
22
|
const key = d.toISOString();
|
|
28
23
|
const g = groups.get(key);
|
|
29
24
|
if (g) g.value += p.value;
|
|
@@ -33,23 +28,24 @@ const bucketByUnit = (points, unit, weekday) => {
|
|
|
33
28
|
});
|
|
34
29
|
}
|
|
35
30
|
const sorted = [...groups.values()].sort((a, b) => a.date.getTime() - b.date.getTime());
|
|
36
|
-
const
|
|
37
|
-
|
|
38
|
-
|
|
31
|
+
const multiYear = new Set(sorted.map((g) => new Intl.DateTimeFormat("en-US", {
|
|
32
|
+
year: "numeric",
|
|
33
|
+
timeZone: tz
|
|
34
|
+
}).format(g.date))).size > 1;
|
|
39
35
|
const format = (d) => {
|
|
40
36
|
if (weekday) return new Intl.DateTimeFormat("en-US", {
|
|
41
37
|
weekday: "short",
|
|
42
|
-
timeZone:
|
|
38
|
+
timeZone: tz
|
|
43
39
|
}).format(d);
|
|
44
40
|
if (unit === "month") return new Intl.DateTimeFormat("en-US", {
|
|
45
41
|
month: "short",
|
|
46
42
|
year: multiYear ? "numeric" : void 0,
|
|
47
|
-
timeZone:
|
|
43
|
+
timeZone: tz
|
|
48
44
|
}).format(d);
|
|
49
45
|
return new Intl.DateTimeFormat("en-US", {
|
|
50
46
|
month: "short",
|
|
51
47
|
day: "numeric",
|
|
52
|
-
timeZone:
|
|
48
|
+
timeZone: tz
|
|
53
49
|
}).format(d);
|
|
54
50
|
};
|
|
55
51
|
return sorted.map((g) => ({
|
|
@@ -59,19 +55,30 @@ const bucketByUnit = (points, unit, weekday) => {
|
|
|
59
55
|
};
|
|
60
56
|
/**
|
|
61
57
|
* Aggregate a daily series into display buckets sized to the timeframe (day for short
|
|
62
|
-
* ranges, week for ~quarter, month for year+), each with a formatted label.
|
|
63
|
-
*
|
|
58
|
+
* ranges, week for ~quarter, month for year+), each with a formatted label. Buckets and
|
|
59
|
+
* labels resolve in `tz` (defaulting to UTC) so the axis lines up with the reporting
|
|
60
|
+
* timezone the series and comparison windows are aligned to. Distinct metrics are summed
|
|
61
|
+
* per bucket (a documented daily-uniques approximation).
|
|
64
62
|
*/
|
|
65
|
-
const bucketSeries = (points, timeframe,
|
|
63
|
+
const bucketSeries = (points, timeframe, tz = "UTC") => bucketByUnit(points, {
|
|
64
|
+
unit: UNIT_BY_TIMEFRAME[timeframe],
|
|
65
|
+
weekday: timeframe === "last7days" || timeframe === "today",
|
|
66
|
+
tz
|
|
67
|
+
});
|
|
66
68
|
const DAY = 864e5;
|
|
67
69
|
const unitForSpan = (spanDays) => spanDays <= 31 ? "day" : spanDays <= 120 ? "week" : "month";
|
|
68
70
|
/**
|
|
69
71
|
* Bucket a daily series for a custom (arbitrary) range, choosing the bucket unit from
|
|
70
72
|
* the span the way the presets do: short ranges by day, a quarter by week, longer by
|
|
71
|
-
* month.
|
|
73
|
+
* month. Buckets resolve in `tz` (defaulting to UTC); weekday labels are only used for
|
|
74
|
+
* the fixed 7-day preset, never here.
|
|
72
75
|
*/
|
|
73
|
-
const bucketByRange = (points, range) => {
|
|
74
|
-
return bucketByUnit(points,
|
|
76
|
+
const bucketByRange = (points, range, tz = "UTC") => {
|
|
77
|
+
return bucketByUnit(points, {
|
|
78
|
+
unit: unitForSpan(Math.round((range.end.getTime() - range.start.getTime()) / DAY)),
|
|
79
|
+
weekday: false,
|
|
80
|
+
tz
|
|
81
|
+
});
|
|
75
82
|
};
|
|
76
83
|
//#endregion
|
|
77
84
|
export { bucketByRange, bucketSeries };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bucket.js","names":[],"sources":["../../src/charts/bucket.ts"],"sourcesContent":["import type { DateRange } from '../core/contract'\nimport type { TimeframePreset } from '../timeframe/presets'\nimport type { SeriesPoint } from '../widgets/readForWidgetSeries'\n\nexport interface ChartBucket {\n\tlabel: string\n\tvalue: number\n}\n\ntype Unit = 'day' | 'week' | 'month'\n\nconst UNIT_BY_TIMEFRAME: Record<TimeframePreset, Unit> = {\n\ttoday: 'day',\n\tlast7days: 'day',\n\tlast30days: 'day',\n\tthisMonth: 'day',\n\tlast90days: 'week',\n\tthisYear: 'month',\n\tlastYear: 'month',\n\tallTime: 'month',\n}\n\nconst
|
|
1
|
+
{"version":3,"file":"bucket.js","names":[],"sources":["../../src/charts/bucket.ts"],"sourcesContent":["import type { DateRange } from '../core/contract'\nimport type { TimeframePreset } from '../timeframe/presets'\nimport {\n\tDEFAULT_TIMEZONE,\n\tstartOfDayInTz,\n\tstartOfMonthInTz,\n\tstartOfWeekInTz,\n} from '../timeframe/tz'\nimport type { SeriesPoint } from '../widgets/readForWidgetSeries'\n\nexport interface ChartBucket {\n\tlabel: string\n\tvalue: number\n}\n\ntype Unit = 'day' | 'week' | 'month'\n\nconst UNIT_BY_TIMEFRAME: Record<TimeframePreset, Unit> = {\n\ttoday: 'day',\n\tlast7days: 'day',\n\tlast30days: 'day',\n\tthisMonth: 'day',\n\tlast90days: 'week',\n\tthisYear: 'month',\n\tlastYear: 'month',\n\tallTime: 'month',\n}\n\nconst bucketStart = (d: Date, unit: Unit, tz: string): Date => {\n\tif (unit === 'month') return startOfMonthInTz(d, tz)\n\tif (unit === 'week') return startOfWeekInTz(d, tz)\n\treturn startOfDayInTz(d, tz)\n}\n\ninterface BucketConfig {\n\tunit: Unit\n\t/** Label each bucket by weekday (only the fixed 7-day / today presets). */\n\tweekday: boolean\n\ttz: string\n}\n\nconst bucketByUnit = (\n\tpoints: SeriesPoint[],\n\t{ unit, weekday, tz }: BucketConfig\n): ChartBucket[] => {\n\tconst groups = new Map<string, { date: Date; value: number }>()\n\tfor (const p of points) {\n\t\tconst d = bucketStart(new Date(p.date), unit, tz)\n\t\tconst key = d.toISOString()\n\t\tconst g = groups.get(key)\n\t\tif (g) {\n\t\t\tg.value += p.value\n\t\t} else {\n\t\t\tgroups.set(key, { date: d, value: p.value })\n\t\t}\n\t}\n\tconst sorted = [...groups.values()].sort((a, b) => a.date.getTime() - b.date.getTime())\n\t// The label reads each bucket's start in the reporting timezone, so a zone whose day\n\t// starts fall on the previous UTC calendar day still labels the correct local date.\n\tconst years = new Set(\n\t\tsorted.map((g) =>\n\t\t\tnew Intl.DateTimeFormat('en-US', { year: 'numeric', timeZone: tz }).format(g.date)\n\t\t)\n\t)\n\tconst multiYear = years.size > 1\n\tconst format = (d: Date): string => {\n\t\tif (weekday) {\n\t\t\treturn new Intl.DateTimeFormat('en-US', { weekday: 'short', timeZone: tz }).format(d)\n\t\t}\n\t\tif (unit === 'month') {\n\t\t\treturn new Intl.DateTimeFormat('en-US', {\n\t\t\t\tmonth: 'short',\n\t\t\t\tyear: multiYear ? 'numeric' : undefined,\n\t\t\t\ttimeZone: tz,\n\t\t\t}).format(d)\n\t\t}\n\t\treturn new Intl.DateTimeFormat('en-US', {\n\t\t\tmonth: 'short',\n\t\t\tday: 'numeric',\n\t\t\ttimeZone: tz,\n\t\t}).format(d)\n\t}\n\treturn sorted.map((g) => ({ label: format(g.date), value: g.value }))\n}\n\n/**\n * Aggregate a daily series into display buckets sized to the timeframe (day for short\n * ranges, week for ~quarter, month for year+), each with a formatted label. Buckets and\n * labels resolve in `tz` (defaulting to UTC) so the axis lines up with the reporting\n * timezone the series and comparison windows are aligned to. Distinct metrics are summed\n * per bucket (a documented daily-uniques approximation).\n */\nexport const bucketSeries = (\n\tpoints: SeriesPoint[],\n\ttimeframe: TimeframePreset,\n\ttz: string = DEFAULT_TIMEZONE\n): ChartBucket[] =>\n\tbucketByUnit(points, {\n\t\tunit: UNIT_BY_TIMEFRAME[timeframe],\n\t\tweekday: timeframe === 'last7days' || timeframe === 'today',\n\t\ttz,\n\t})\n\nconst DAY = 86_400_000\n\nconst unitForSpan = (spanDays: number): Unit =>\n\tspanDays <= 31 ? 'day' : spanDays <= 120 ? 'week' : 'month'\n\n/**\n * Bucket a daily series for a custom (arbitrary) range, choosing the bucket unit from\n * the span the way the presets do: short ranges by day, a quarter by week, longer by\n * month. Buckets resolve in `tz` (defaulting to UTC); weekday labels are only used for\n * the fixed 7-day preset, never here.\n */\nexport const bucketByRange = (\n\tpoints: SeriesPoint[],\n\trange: DateRange,\n\ttz: string = DEFAULT_TIMEZONE\n): ChartBucket[] => {\n\tconst spanDays = Math.round((range.end.getTime() - range.start.getTime()) / DAY)\n\treturn bucketByUnit(points, { unit: unitForSpan(spanDays), weekday: false, tz })\n}\n"],"mappings":";;AAiBA,MAAM,oBAAmD;CACxD,OAAO;CACP,WAAW;CACX,YAAY;CACZ,WAAW;CACX,YAAY;CACZ,UAAU;CACV,UAAU;CACV,SAAS;AACV;AAEA,MAAM,eAAe,GAAS,MAAY,OAAqB;CAC9D,IAAI,SAAS,SAAS,OAAO,iBAAiB,GAAG,EAAE;CACnD,IAAI,SAAS,QAAQ,OAAO,gBAAgB,GAAG,EAAE;CACjD,OAAO,eAAe,GAAG,EAAE;AAC5B;AASA,MAAM,gBACL,QACA,EAAE,MAAM,SAAS,SACE;CACnB,MAAM,yBAAS,IAAI,IAA2C;CAC9D,KAAK,MAAM,KAAK,QAAQ;EACvB,MAAM,IAAI,YAAY,IAAI,KAAK,EAAE,IAAI,GAAG,MAAM,EAAE;EAChD,MAAM,MAAM,EAAE,YAAY;EAC1B,MAAM,IAAI,OAAO,IAAI,GAAG;EACxB,IAAI,GACH,EAAE,SAAS,EAAE;OAEb,OAAO,IAAI,KAAK;GAAE,MAAM;GAAG,OAAO,EAAE;EAAM,CAAC;CAE7C;CACA,MAAM,SAAS,CAAC,GAAG,OAAO,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,QAAQ,IAAI,EAAE,KAAK,QAAQ,CAAC;CAQtF,MAAM,YAAY,IALA,IACjB,OAAO,KAAK,MACX,IAAI,KAAK,eAAe,SAAS;EAAE,MAAM;EAAW,UAAU;CAAG,CAAC,EAAE,OAAO,EAAE,IAAI,CAClF,CAEqB,EAAE,OAAO;CAC/B,MAAM,UAAU,MAAoB;EACnC,IAAI,SACH,OAAO,IAAI,KAAK,eAAe,SAAS;GAAE,SAAS;GAAS,UAAU;EAAG,CAAC,EAAE,OAAO,CAAC;EAErF,IAAI,SAAS,SACZ,OAAO,IAAI,KAAK,eAAe,SAAS;GACvC,OAAO;GACP,MAAM,YAAY,YAAY,KAAA;GAC9B,UAAU;EACX,CAAC,EAAE,OAAO,CAAC;EAEZ,OAAO,IAAI,KAAK,eAAe,SAAS;GACvC,OAAO;GACP,KAAK;GACL,UAAU;EACX,CAAC,EAAE,OAAO,CAAC;CACZ;CACA,OAAO,OAAO,KAAK,OAAO;EAAE,OAAO,OAAO,EAAE,IAAI;EAAG,OAAO,EAAE;CAAM,EAAE;AACrE;;;;;;;;AASA,MAAa,gBACZ,QACA,WACA,KAAA,UAEA,aAAa,QAAQ;CACpB,MAAM,kBAAkB;CACxB,SAAS,cAAc,eAAe,cAAc;CACpD;AACD,CAAC;AAEF,MAAM,MAAM;AAEZ,MAAM,eAAe,aACpB,YAAY,KAAK,QAAQ,YAAY,MAAM,SAAS;;;;;;;AAQrD,MAAa,iBACZ,QACA,OACA,KAAA,UACmB;CAEnB,OAAO,aAAa,QAAQ;EAAE,MAAM,YADnB,KAAK,OAAO,MAAM,IAAI,QAAQ,IAAI,MAAM,MAAM,QAAQ,KAAK,GACrB,CAAC;EAAG,SAAS;EAAO;CAAG,CAAC;AAChF"}
|
package/dist/core/cacheKey.js
CHANGED
|
@@ -1,14 +1,10 @@
|
|
|
1
|
+
import { addDaysInTz, startOfDayInTz } from "../timeframe/tz.js";
|
|
1
2
|
//#region src/core/cacheKey.ts
|
|
2
3
|
const stable = (xs) => xs ? [...xs].sort().join(",") : "";
|
|
3
|
-
const startOfUtcDay = (d) => new Date(Date.UTC(d.getUTCFullYear(), d.getUTCMonth(), d.getUTCDate()));
|
|
4
|
-
const startOfNextUtcDay = (d) => {
|
|
5
|
-
const day = startOfUtcDay(d);
|
|
6
|
-
day.setUTCDate(day.getUTCDate() + 1);
|
|
7
|
-
return day;
|
|
8
|
-
};
|
|
9
4
|
function buildCacheKey(provider, q) {
|
|
10
5
|
const pathKey = q.path ?? "site";
|
|
11
|
-
const
|
|
6
|
+
const tz = q.timezone ?? "UTC";
|
|
7
|
+
const range = `${startOfDayInTz(q.dateRange.start, tz).toISOString()}_${addDaysInTz(q.dateRange.end, 1, tz).toISOString()}`;
|
|
12
8
|
const filters = (q.filters ?? []).map((f) => `${f.dimension}${f.operator}${f.value}`).sort().join(";");
|
|
13
9
|
return [
|
|
14
10
|
"analytics",
|
|
@@ -22,6 +18,7 @@ function buildCacheKey(provider, q) {
|
|
|
22
18
|
filters,
|
|
23
19
|
String(q.limit ?? "_"),
|
|
24
20
|
q.order ? `${q.order.metric}:${q.order.direction}` : "_",
|
|
21
|
+
...q.timezone !== void 0 && q.timezone !== "UTC" ? [q.timezone] : [],
|
|
25
22
|
...q.scope !== void 0 ? [encodeURIComponent(q.scope)] : []
|
|
26
23
|
].join("|");
|
|
27
24
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cacheKey.js","names":[],"sources":["../../src/core/cacheKey.ts"],"sourcesContent":["import type { AnalyticsQuery } from './contract'\n\nconst stable = (xs?: string[]): string => (xs ? [...xs].sort().join(',') : '')\n\
|
|
1
|
+
{"version":3,"file":"cacheKey.js","names":[],"sources":["../../src/core/cacheKey.ts"],"sourcesContent":["import { addDaysInTz, DEFAULT_TIMEZONE, startOfDayInTz } from '../timeframe/tz'\nimport type { AnalyticsQuery } from './contract'\n\nconst stable = (xs?: string[]): string => (xs ? [...xs].sort().join(',') : '')\n\nexport function buildCacheKey(provider: string, q: AnalyticsQuery): string {\n\tconst pathKey = q.path ?? 'site'\n\tconst tz = q.timezone ?? DEFAULT_TIMEZONE\n\tconst range = `${startOfDayInTz(q.dateRange.start, tz).toISOString()}_${addDaysInTz(q.dateRange.end, 1, tz).toISOString()}`\n\tconst filters = (q.filters ?? [])\n\t\t.map((f) => `${f.dimension}${f.operator}${f.value}`)\n\t\t.sort()\n\t\t.join(';')\n\treturn [\n\t\t'analytics',\n\t\tprovider,\n\t\tq.hostname ?? '_',\n\t\tpathKey,\n\t\tstable(q.metrics),\n\t\tstable(q.dimensions),\n\t\trange,\n\t\tq.granularity ?? '_',\n\t\tfilters,\n\t\tString(q.limit ?? '_'),\n\t\tq.order ? `${q.order.metric}:${q.order.direction}` : '_',\n\t\t// Appended only for a non-UTC timezone so default (UTC) keys keep their format.\n\t\t...(q.timezone !== undefined && q.timezone !== DEFAULT_TIMEZONE ? [q.timezone] : []),\n\t\t...(q.scope !== undefined ? [encodeURIComponent(q.scope)] : []),\n\t].join('|')\n}\n"],"mappings":";;AAGA,MAAM,UAAU,OAA2B,KAAK,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI;AAE3E,SAAgB,cAAc,UAAkB,GAA2B;CAC1E,MAAM,UAAU,EAAE,QAAQ;CAC1B,MAAM,KAAK,EAAE,YAAA;CACb,MAAM,QAAQ,GAAG,eAAe,EAAE,UAAU,OAAO,EAAE,EAAE,YAAY,EAAE,GAAG,YAAY,EAAE,UAAU,KAAK,GAAG,EAAE,EAAE,YAAY;CACxH,MAAM,WAAW,EAAE,WAAW,CAAC,GAC7B,KAAK,MAAM,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,OAAO,EAClD,KAAK,EACL,KAAK,GAAG;CACV,OAAO;EACN;EACA;EACA,EAAE,YAAY;EACd;EACA,OAAO,EAAE,OAAO;EAChB,OAAO,EAAE,UAAU;EACnB;EACA,EAAE,eAAe;EACjB;EACA,OAAO,EAAE,SAAS,GAAG;EACrB,EAAE,QAAQ,GAAG,EAAE,MAAM,OAAO,GAAG,EAAE,MAAM,cAAc;EAErD,GAAI,EAAE,aAAa,KAAA,KAAa,EAAE,aAAA,QAAgC,CAAC,EAAE,QAAQ,IAAI,CAAC;EAClF,GAAI,EAAE,UAAU,KAAA,IAAY,CAAC,mBAAmB,EAAE,KAAK,CAAC,IAAI,CAAC;CAC9D,EAAE,KAAK,GAAG;AACX"}
|
package/dist/core/contract.d.ts
CHANGED
|
@@ -6,7 +6,7 @@ import { Config, PayloadRequest } from "payload";
|
|
|
6
6
|
* scope. Gated by `access.platformRead`; the query reaches the adapter unscoped.
|
|
7
7
|
*/
|
|
8
8
|
declare const PLATFORM_SCOPE = "*";
|
|
9
|
-
type MetricKey = 'pageviews' | 'visitors' | 'visits' | 'sessions' | 'bounceRate' | 'avgDuration' | '
|
|
9
|
+
type MetricKey = 'pageviews' | 'visitors' | 'visits' | 'sessions' | 'bounceRate' | 'avgDuration' | 'scrollDepth' | 'events' | 'conversions' | 'revenue';
|
|
10
10
|
type DimensionKey = 'page' | 'referrer' | 'source' | 'medium' | 'campaign' | 'utmSource' | 'utmMedium' | 'utmCampaign' | 'utmContent' | 'utmTerm' | 'device' | 'browser' | 'os' | 'country' | 'region' | 'city' | 'language' | 'event';
|
|
11
11
|
type Granularity = 'minute' | 'hour' | 'day' | 'week' | 'month';
|
|
12
12
|
interface DateRange {
|
|
@@ -38,6 +38,12 @@ interface AnalyticsQuery {
|
|
|
38
38
|
* instances sharing an id never share cached results.
|
|
39
39
|
*/
|
|
40
40
|
scope?: string;
|
|
41
|
+
/**
|
|
42
|
+
* IANA reporting timezone the read's day boundaries are aligned to. Undefined
|
|
43
|
+
* means UTC. Adapters that can bucket in a timezone apply it (PostHog, Umami);
|
|
44
|
+
* others report in their own account timezone. Part of the cache key when set.
|
|
45
|
+
*/
|
|
46
|
+
timezone?: string;
|
|
41
47
|
}
|
|
42
48
|
interface AnalyticsRow {
|
|
43
49
|
dimensions?: Partial<Record<DimensionKey, string>>;
|
|
@@ -93,6 +99,11 @@ interface AdapterRegisterContext {
|
|
|
93
99
|
scoped: boolean;
|
|
94
100
|
/** The plugin's scopeResolver bound for adapter use (e.g. ingest stamping). */
|
|
95
101
|
resolveScope: (req: PayloadRequest) => Promise<string | null>;
|
|
102
|
+
/**
|
|
103
|
+
* The plugin's reportingTimezone bound for adapter use (e.g. bucketing native
|
|
104
|
+
* rollups at ingest). Resolves to `'UTC'` when no reportingTimezone is set.
|
|
105
|
+
*/
|
|
106
|
+
resolveTimezone: (req: PayloadRequest, scope?: string | null) => Promise<string>;
|
|
96
107
|
}
|
|
97
108
|
interface AnalyticsAdapter {
|
|
98
109
|
readonly id: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contract.js","names":[],"sources":["../../src/core/contract.ts"],"sourcesContent":["import type { Config, PayloadRequest } from 'payload'\n\n/**\n * Explicit cross-scope read marker: pass as a read's `scope` to aggregate over every\n * scope. Gated by `access.platformRead`; the query reaches the adapter unscoped.\n */\nexport const PLATFORM_SCOPE = '*'\n\nexport type MetricKey =\n\t| 'pageviews'\n\t| 'visitors'\n\t| 'visits'\n\t| 'sessions'\n\t| 'bounceRate'\n\t| 'avgDuration'\n\t| '
|
|
1
|
+
{"version":3,"file":"contract.js","names":[],"sources":["../../src/core/contract.ts"],"sourcesContent":["import type { Config, PayloadRequest } from 'payload'\n\n/**\n * Explicit cross-scope read marker: pass as a read's `scope` to aggregate over every\n * scope. Gated by `access.platformRead`; the query reaches the adapter unscoped.\n */\nexport const PLATFORM_SCOPE = '*'\n\nexport type MetricKey =\n\t| 'pageviews'\n\t| 'visitors'\n\t| 'visits'\n\t| 'sessions'\n\t| 'bounceRate'\n\t| 'avgDuration'\n\t| 'scrollDepth'\n\t| 'events'\n\t| 'conversions'\n\t| 'revenue'\n\nexport type DimensionKey =\n\t| 'page'\n\t| 'referrer'\n\t| 'source'\n\t| 'medium'\n\t| 'campaign'\n\t| 'utmSource'\n\t| 'utmMedium'\n\t| 'utmCampaign'\n\t| 'utmContent'\n\t| 'utmTerm'\n\t| 'device'\n\t| 'browser'\n\t| 'os'\n\t| 'country'\n\t| 'region'\n\t| 'city'\n\t| 'language'\n\t| 'event'\n\nexport type Granularity = 'minute' | 'hour' | 'day' | 'week' | 'month'\n\nexport interface DateRange {\n\tstart: Date\n\tend: Date\n}\n\nexport interface AnalyticsFilter {\n\tdimension: DimensionKey\n\toperator: 'eq' | 'contains' | 'matches'\n\tvalue: string\n}\n\nexport interface AnalyticsQuery {\n\tpath?: string\n\thostname?: string\n\tmetrics: MetricKey[]\n\tdimensions?: DimensionKey[]\n\tdateRange: DateRange\n\tgranularity?: Granularity\n\tfilters?: AnalyticsFilter[]\n\tlimit?: number\n\torder?: { metric: MetricKey; direction: 'asc' | 'desc' }\n\t/**\n\t * Analytics boundary this read belongs to (tenant id, site key). Undefined means\n\t * install-wide (the default). Adapters that can filter by scope apply it; others\n\t * ignore it. Always part of the surfacing cache key, so per-scope adapter\n\t * instances sharing an id never share cached results.\n\t */\n\tscope?: string\n\t/**\n\t * IANA reporting timezone the read's day boundaries are aligned to. Undefined\n\t * means UTC. Adapters that can bucket in a timezone apply it (PostHog, Umami);\n\t * others report in their own account timezone. Part of the cache key when set.\n\t */\n\ttimezone?: string\n}\n\nexport interface AnalyticsRow {\n\tdimensions?: Partial<Record<DimensionKey, string>>\n\tmetrics: Partial<Record<MetricKey, number>>\n\ttimestamp?: string\n}\n\nexport interface AnalyticsResult {\n\trows: AnalyticsRow[]\n\ttotals?: Partial<Record<MetricKey, number>>\n\tmeta: { provider: string; sampled?: boolean; clamped?: boolean; fetchedAt: string }\n}\n\nexport interface RateLimitDescriptor {\n\trequestsPerMinute?: number\n\trequestsPerHour?: number\n\tmaxConcurrent?: number\n\tquotaModel?: 'requests' | 'tokens'\n\treadsCountAsUsage?: boolean\n}\n\nexport interface AnalyticsCapabilities {\n\tperPageQuery: boolean\n\trealtime: boolean\n\trealtimeWindowMinutes?: number\n\tcomparison: boolean\n\tminGranularity: Granularity\n\tmaxLookbackDays: number | null\n\tmetrics: ReadonlySet<MetricKey>\n\tdimensions: ReadonlySet<DimensionKey>\n\tbatchPageReport: boolean\n\trateLimit: RateLimitDescriptor | null\n\trecommendedTtl: { realtime: number; aggregate: number }\n\t/**\n\t * The adapter applies `AnalyticsQuery.scope` as a provider-native filter (native\n\t * scope column, PostHog `scopeProperty`, ...). Without it, a scoped read through\n\t * a shared platform adapter would expose cross-scope data, so such reads are\n\t * gated by `access.platformRead`.\n\t */\n\tscopedQueries?: boolean\n}\n\nexport interface AdapterContext {\n\tsignal?: AbortSignal\n}\n\n/** Extra context the plugin hands adapters when they register config surface. */\nexport interface AdapterRegisterContext {\n\t/** True when the plugin has a scopeResolver configured. */\n\tscoped: boolean\n\t/** The plugin's scopeResolver bound for adapter use (e.g. ingest stamping). */\n\tresolveScope: (req: PayloadRequest) => Promise<string | null>\n\t/**\n\t * The plugin's reportingTimezone bound for adapter use (e.g. bucketing native\n\t * rollups at ingest). Resolves to `'UTC'` when no reportingTimezone is set.\n\t */\n\tresolveTimezone: (req: PayloadRequest, scope?: string | null) => Promise<string>\n}\n\nexport interface AnalyticsAdapter {\n\treadonly id: string\n\treadonly label: string\n\treadonly capabilities: AnalyticsCapabilities\n\tisConfigured(): boolean\n\tquery(query: AnalyticsQuery, ctx: AdapterContext): Promise<AnalyticsResult>\n\trealtime?(query: AnalyticsQuery, ctx: AdapterContext): Promise<AnalyticsResult>\n\tregister?(config: Config, context?: AdapterRegisterContext): void\n}\n\nexport type AnalyticsAdapterFactory<Config> = (config: Config) => AnalyticsAdapter\n"],"mappings":";;;;;AAMA,MAAa,iBAAiB"}
|
package/dist/core/options.d.ts
CHANGED
|
@@ -13,6 +13,16 @@ import { CollectionConfig, CollectionSlug, Payload, PayloadRequest } from "paylo
|
|
|
13
13
|
type ScopeResolver = (args: {
|
|
14
14
|
req: PayloadRequest;
|
|
15
15
|
}) => string | null | Promise<string | null>;
|
|
16
|
+
/**
|
|
17
|
+
* Resolves the IANA reporting timezone a read's (or ingest's) day boundaries align
|
|
18
|
+
* to. Receives the request and its already-resolved scope, so per-tenant, per-user
|
|
19
|
+
* (`req.user`), and selector (cookie/preference) strategies are all expressible.
|
|
20
|
+
* Return `null` to fall back to UTC.
|
|
21
|
+
*/
|
|
22
|
+
type TimezoneResolver = (args: {
|
|
23
|
+
req: PayloadRequest;
|
|
24
|
+
scope: string | null;
|
|
25
|
+
}) => string | null | Promise<string | null>;
|
|
16
26
|
/**
|
|
17
27
|
* Escape hatch replacing the provider-collection lookup: return the runtime
|
|
18
28
|
* adapters for a scope yourself (any store, any shape). Results are layered onto
|
|
@@ -63,6 +73,14 @@ type AnalyticsPluginOptions = {
|
|
|
63
73
|
adapters?: AnalyticsAdapter[];
|
|
64
74
|
defaultAdapter?: string;
|
|
65
75
|
scopeResolver?: ScopeResolver;
|
|
76
|
+
/**
|
|
77
|
+
* IANA reporting timezone that day boundaries (timeframe windows, series axes,
|
|
78
|
+
* native rollup buckets) align to. Defaults to UTC. A string forces one timezone
|
|
79
|
+
* (the single-tenant / no-multi-tenancy case); a resolver derives it per request
|
|
80
|
+
* from the scope, user, or a selector. Native rollups bucket at ingest in the
|
|
81
|
+
* resolved timezone, so changing it does not re-bucket existing history.
|
|
82
|
+
*/
|
|
83
|
+
reportingTimezone?: string | TimezoneResolver;
|
|
66
84
|
providers?: ProvidersOptions;
|
|
67
85
|
/**
|
|
68
86
|
* Id of one config adapter shared by every scope (the platform's own analytics,
|
|
@@ -96,6 +114,12 @@ type AnalyticsPluginOptions = {
|
|
|
96
114
|
* enables localization (Payload strips the flag otherwise).
|
|
97
115
|
*/
|
|
98
116
|
localizeText?: boolean;
|
|
117
|
+
/**
|
|
118
|
+
* Period-over-period comparison on the metric and trend widgets. On by
|
|
119
|
+
* default for adapters that declare `capabilities.comparison`; set false
|
|
120
|
+
* to skip the second (previous-window) read entirely.
|
|
121
|
+
*/
|
|
122
|
+
comparison?: boolean;
|
|
99
123
|
};
|
|
100
124
|
/**
|
|
101
125
|
* Opt-in sync tier: a cron job that persists each provider's daily metrics into a
|
|
@@ -107,9 +131,10 @@ type AnalyticsPluginOptions = {
|
|
|
107
131
|
collectionSlug?: CollectionSlug;
|
|
108
132
|
cron?: string;
|
|
109
133
|
lookbackDays?: number;
|
|
110
|
-
adapters?: string[];
|
|
134
|
+
adapters?: string[]; /** Surface the analytics-daily collection in the admin nav. Default false (hidden). */
|
|
135
|
+
hidden?: boolean;
|
|
111
136
|
};
|
|
112
137
|
};
|
|
113
138
|
//#endregion
|
|
114
|
-
export { AnalyticsAccessOptions, AnalyticsPluginOptions, PlatformReadAccess, ProvidersCollectionOptions, ProvidersOptions, ProvidersResolve, ScopeResolver };
|
|
139
|
+
export { AnalyticsAccessOptions, AnalyticsPluginOptions, PlatformReadAccess, ProvidersCollectionOptions, ProvidersOptions, ProvidersResolve, ScopeResolver, TimezoneResolver };
|
|
115
140
|
//# sourceMappingURL=options.d.ts.map
|
package/dist/core/options.js
CHANGED
|
@@ -21,17 +21,20 @@ function resolveOptions(options) {
|
|
|
21
21
|
enabled: false,
|
|
22
22
|
disabled: [],
|
|
23
23
|
register: [],
|
|
24
|
-
localizeText: false
|
|
24
|
+
localizeText: false,
|
|
25
|
+
comparison: true
|
|
25
26
|
} : options.widgets === void 0 || options.widgets === true ? {
|
|
26
27
|
enabled: true,
|
|
27
28
|
disabled: [],
|
|
28
29
|
register: [],
|
|
29
|
-
localizeText: false
|
|
30
|
+
localizeText: false,
|
|
31
|
+
comparison: true
|
|
30
32
|
} : {
|
|
31
33
|
enabled: true,
|
|
32
34
|
disabled: options.widgets.disabled ?? [],
|
|
33
35
|
register: options.widgets.register ?? [],
|
|
34
|
-
localizeText: options.widgets.localizeText ?? false
|
|
36
|
+
localizeText: options.widgets.localizeText ?? false,
|
|
37
|
+
comparison: options.widgets.comparison ?? true
|
|
35
38
|
};
|
|
36
39
|
const warmOpt = options.cache?.warm;
|
|
37
40
|
const warm = warmOpt === true ? {
|
|
@@ -68,32 +71,36 @@ function resolveOptions(options) {
|
|
|
68
71
|
enabled: true,
|
|
69
72
|
collectionSlug: DEFAULT_SYNC_COLLECTION,
|
|
70
73
|
cron: DEFAULT_SYNC_CRON,
|
|
71
|
-
lookbackDays: DEFAULT_SYNC_LOOKBACK
|
|
74
|
+
lookbackDays: DEFAULT_SYNC_LOOKBACK,
|
|
75
|
+
hidden: true
|
|
72
76
|
} : syncOpt && typeof syncOpt === "object" ? {
|
|
73
77
|
enabled: true,
|
|
74
78
|
collectionSlug: syncOpt.collectionSlug ?? DEFAULT_SYNC_COLLECTION,
|
|
75
79
|
cron: syncOpt.cron ?? DEFAULT_SYNC_CRON,
|
|
76
80
|
lookbackDays: syncOpt.lookbackDays ?? DEFAULT_SYNC_LOOKBACK,
|
|
77
|
-
adapters: syncOpt.adapters
|
|
81
|
+
adapters: syncOpt.adapters,
|
|
82
|
+
hidden: syncOpt.hidden ?? true
|
|
78
83
|
} : {
|
|
79
84
|
enabled: false,
|
|
80
85
|
collectionSlug: DEFAULT_SYNC_COLLECTION,
|
|
81
86
|
cron: DEFAULT_SYNC_CRON,
|
|
82
|
-
lookbackDays: DEFAULT_SYNC_LOOKBACK
|
|
87
|
+
lookbackDays: DEFAULT_SYNC_LOOKBACK,
|
|
88
|
+
hidden: true
|
|
83
89
|
};
|
|
84
90
|
return {
|
|
85
91
|
adapters: options.adapters,
|
|
86
92
|
defaultAdapter: options.defaultAdapter,
|
|
87
93
|
scopeResolver: options.scopeResolver ?? (() => null),
|
|
88
94
|
scoped: options.scopeResolver !== void 0,
|
|
95
|
+
reportingTimezone: options.reportingTimezone,
|
|
89
96
|
platformAdapter: options.platformAdapter,
|
|
90
97
|
access: { platformRead: options.access?.platformRead ?? (({ req }) => Boolean(req.user)) },
|
|
91
98
|
providers,
|
|
92
99
|
bindings: resolveBindings(options.collections),
|
|
93
100
|
cache: {
|
|
94
101
|
ttl: {
|
|
95
|
-
aggregate: options.cache?.ttl?.aggregate
|
|
96
|
-
realtime: options.cache?.ttl?.realtime
|
|
102
|
+
aggregate: options.cache?.ttl?.aggregate,
|
|
103
|
+
realtime: options.cache?.ttl?.realtime
|
|
97
104
|
},
|
|
98
105
|
warm
|
|
99
106
|
},
|
package/dist/core/options.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"options.js","names":[],"sources":["../../src/core/options.ts"],"sourcesContent":["import type { CollectionConfig, CollectionSlug, Payload, PayloadRequest } from 'payload'\nimport type { AnalyticsBinding, ResolvedBinding } from '../binding/types'\nimport { PROVIDERS_SLUG } from '../providers/collection'\nimport type { TranslationsOption } from '../translations'\nimport type { CustomWidgetDef } from '../widgets/customWidget'\nimport type { AnalyticsAdapter } from './contract'\n\nconst DEFAULT_WARM_CRON = '*/30 * * * *'\nconst DEFAULT_SYNC_CRON = '0 */6 * * *'\nconst DEFAULT_SYNC_COLLECTION = 'analytics-daily'\nconst DEFAULT_SYNC_LOOKBACK = 3\nconst DEFAULT_SCOPE_FIELD = 'scope'\n\n/**\n * Maps a request to its analytics boundary (tenant id, site key). Null means the\n * whole install, which is the default single-site behavior. With a multi-tenant\n * plugin, return the request's tenant id here.\n */\nexport type ScopeResolver = (args: {\n\treq: PayloadRequest\n}) => string | null | Promise<string | null>\n\n/**\n * Escape hatch replacing the provider-collection lookup: return the runtime\n * adapters for a scope yourself (any store, any shape). Results are layered onto\n * the static config adapters exactly like collection-resolved ones, but are not\n * cached; memoize inside the function if lookups are expensive.\n */\nexport type ProvidersResolve = (args: {\n\tpayload: Payload\n\treq?: PayloadRequest\n\tscope: string | null\n}) => AnalyticsAdapter[] | Promise<AnalyticsAdapter[]>\n\nexport type ProvidersCollectionOptions = {\n\tslug?: string\n\t/**\n\t * Field matched against the resolved scope when looking up a scope's providers.\n\t * Point it at a tenant plugin's field (e.g. 'tenant') when that plugin manages\n\t * scoping for the collection.\n\t */\n\tscopeField?: string\n\toverrides?: (collection: CollectionConfig) => CollectionConfig\n\taccess?: Partial<CollectionConfig['access']>\n}\n\nexport type ProvidersOptions = {\n\t/** Opt-in admin collection storing runtime provider configurations. */\n\tcollection?: boolean | ProvidersCollectionOptions\n\tresolve?: ProvidersResolve\n}\n\n/** Access checker for cross-scope (platform) analytics reads. */\nexport type PlatformReadAccess = (args: { req: PayloadRequest }) => boolean | Promise<boolean>\n\nexport type AnalyticsAccessOptions = {\n\t/**\n\t * Gates cross-scope reads: explicit `scope: '*'` reads, and scoped reads through\n\t * a platform adapter that cannot filter by scope. Defaults to any authenticated\n\t * admin-panel user.\n\t */\n\tplatformRead?: PlatformReadAccess\n}\n\nexport type AnalyticsPluginOptions = {\n\tdisabled?: boolean\n\t/**\n\t * Per-locale overrides for this plugin's UI strings, keyed by the typed\n\t * translation keys exported from `@10x-media/analytics/i18n`. Values win over\n\t * the built-in locales key-by-key; locales the plugin does not ship are added\n\t * whole. App-level `i18n.translations` still wins over both.\n\t */\n\ttranslations?: TranslationsOption\n\tadapters?: AnalyticsAdapter[]\n\tdefaultAdapter?: string\n\tscopeResolver?: ScopeResolver\n\tproviders?: ProvidersOptions\n\t/**\n\t * Id of one config adapter shared by every scope (the platform's own analytics,\n\t * e.g. a PostHog project capturing all tenants). Included in each scope's\n\t * registry like any config adapter; reads through it are scope-filtered only\n\t * when the adapter supports scoped queries, otherwise they are cross-scope and\n\t * require `access.platformRead`.\n\t */\n\tplatformAdapter?: string\n\taccess?: AnalyticsAccessOptions\n\t/**\n\t * Per-collection bindings, keyed by collection slug. With generated types\n\t * augmented, each slug's resolvers receive that collection's typed document.\n\t */\n\tcollections?: { [TSlug in CollectionSlug]?: AnalyticsBinding<TSlug> }\n\tcache?: { ttl?: { aggregate?: number; realtime?: number }; warm?: boolean | { cron?: string } }\n\twidgets?:\n\t\t| boolean\n\t\t| {\n\t\t\t\tdisabled?: string[]\n\t\t\t\tregister?: CustomWidgetDef[]\n\t\t\t\t/**\n\t\t\t\t * Marks the free-text widget config fields (each widget's Title) as\n\t\t\t\t * `localized`. Off by default; takes effect only when the Payload config\n\t\t\t\t * enables localization (Payload strips the flag otherwise).\n\t\t\t\t */\n\t\t\t\tlocalizeText?: boolean\n\t\t }\n\t/**\n\t * Opt-in sync tier: a cron job that persists each provider's daily metrics into a\n\t * queryable collection. Reads go through the surfacing cache, so persisted rows reflect\n\t * cached values up to `cache.ttl.aggregate` old; keep that TTL below the sync interval\n\t * for the freshest data.\n\t */\n\tsync?:\n\t\t| boolean\n\t\t| { collectionSlug?: CollectionSlug; cron?: string; lookbackDays?: number; adapters?: string[] }\n}\n\nexport interface ResolvedOptions {\n\tadapters: AnalyticsAdapter[]\n\tdefaultAdapter?: string\n\tscopeResolver: ScopeResolver\n\t/** True when the app configured a scopeResolver (scoped install). */\n\tscoped: boolean\n\tplatformAdapter?: string\n\taccess: { platformRead: PlatformReadAccess }\n\tproviders: {\n\t\tcollection: {\n\t\t\tenabled: boolean\n\t\t\tslug: string\n\t\t\tscopeField: string\n\t\t\toverrides?: (collection: CollectionConfig) => CollectionConfig\n\t\t\taccess?: Partial<CollectionConfig['access']>\n\t\t}\n\t\tresolve?: ProvidersResolve\n\t}\n\tbindings: Record<string, ResolvedBinding>\n\tcache: { ttl: { aggregate: number; realtime: number }; warm: { enabled: boolean; cron: string } }\n\twidgets: {\n\t\tenabled: boolean\n\t\tdisabled: string[]\n\t\tregister: CustomWidgetDef[]\n\t\tlocalizeText: boolean\n\t}\n\tsync: {\n\t\tenabled: boolean\n\t\tcollectionSlug: string\n\t\tcron: string\n\t\tlookbackDays: number\n\t\tadapters?: string[]\n\t}\n}\n\nconst resolveBindings = (\n\tcollections: AnalyticsPluginOptions['collections']\n): Record<string, ResolvedBinding> => {\n\tconst out: Record<string, ResolvedBinding> = {}\n\tfor (const [slug, binding] of Object.entries(collections ?? {})) {\n\t\tif (!binding) continue\n\t\tif (!binding.path && !binding.pathField) {\n\t\t\tthrow new Error(`analytics: binding for \"${slug}\" needs a path resolver or a pathField`)\n\t\t}\n\t\t// Erases the per-slug doc generic; safe because the runtime only ever hands\n\t\t// a binding documents from its own collection.\n\t\tout[slug] = binding as ResolvedBinding\n\t}\n\treturn out\n}\n\nexport function resolveOptions(options: AnalyticsPluginOptions): ResolvedOptions {\n\tif (!options.adapters || options.adapters.length === 0) {\n\t\tthrow new Error('analytics: at least one adapter is required')\n\t}\n\tif (\n\t\toptions.platformAdapter !== undefined &&\n\t\t!options.adapters.some((a) => a.id === options.platformAdapter)\n\t) {\n\t\tthrow new Error(`analytics: unknown platform adapter \"${options.platformAdapter}\"`)\n\t}\n\tconst widgets =\n\t\toptions.widgets === false\n\t\t\t? {\n\t\t\t\t\tenabled: false,\n\t\t\t\t\tdisabled: [] as string[],\n\t\t\t\t\tregister: [] as CustomWidgetDef[],\n\t\t\t\t\tlocalizeText: false,\n\t\t\t\t}\n\t\t\t: options.widgets === undefined || options.widgets === true\n\t\t\t\t? {\n\t\t\t\t\t\tenabled: true,\n\t\t\t\t\t\tdisabled: [] as string[],\n\t\t\t\t\t\tregister: [] as CustomWidgetDef[],\n\t\t\t\t\t\tlocalizeText: false,\n\t\t\t\t\t}\n\t\t\t\t: {\n\t\t\t\t\t\tenabled: true,\n\t\t\t\t\t\tdisabled: options.widgets.disabled ?? [],\n\t\t\t\t\t\tregister: options.widgets.register ?? [],\n\t\t\t\t\t\tlocalizeText: options.widgets.localizeText ?? false,\n\t\t\t\t\t}\n\tconst warmOpt = options.cache?.warm\n\tconst warm =\n\t\twarmOpt === true\n\t\t\t? { enabled: true, cron: DEFAULT_WARM_CRON }\n\t\t\t: warmOpt && typeof warmOpt === 'object'\n\t\t\t\t? { enabled: true, cron: warmOpt.cron ?? DEFAULT_WARM_CRON }\n\t\t\t\t: { enabled: false, cron: DEFAULT_WARM_CRON }\n\tconst collectionOpt = options.providers?.collection\n\tconst providers = {\n\t\tcollection:\n\t\t\tcollectionOpt === true\n\t\t\t\t? { enabled: true, slug: PROVIDERS_SLUG, scopeField: DEFAULT_SCOPE_FIELD }\n\t\t\t\t: collectionOpt && typeof collectionOpt === 'object'\n\t\t\t\t\t? {\n\t\t\t\t\t\t\tenabled: true,\n\t\t\t\t\t\t\tslug: collectionOpt.slug ?? PROVIDERS_SLUG,\n\t\t\t\t\t\t\tscopeField: collectionOpt.scopeField ?? DEFAULT_SCOPE_FIELD,\n\t\t\t\t\t\t\toverrides: collectionOpt.overrides,\n\t\t\t\t\t\t\taccess: collectionOpt.access,\n\t\t\t\t\t\t}\n\t\t\t\t\t: { enabled: false, slug: PROVIDERS_SLUG, scopeField: DEFAULT_SCOPE_FIELD },\n\t\tresolve: options.providers?.resolve,\n\t}\n\tconst syncOpt = options.sync\n\tconst sync =\n\t\tsyncOpt === true\n\t\t\t? {\n\t\t\t\t\tenabled: true,\n\t\t\t\t\tcollectionSlug: DEFAULT_SYNC_COLLECTION,\n\t\t\t\t\tcron: DEFAULT_SYNC_CRON,\n\t\t\t\t\tlookbackDays: DEFAULT_SYNC_LOOKBACK,\n\t\t\t\t}\n\t\t\t: syncOpt && typeof syncOpt === 'object'\n\t\t\t\t? {\n\t\t\t\t\t\tenabled: true,\n\t\t\t\t\t\tcollectionSlug: syncOpt.collectionSlug ?? DEFAULT_SYNC_COLLECTION,\n\t\t\t\t\t\tcron: syncOpt.cron ?? DEFAULT_SYNC_CRON,\n\t\t\t\t\t\tlookbackDays: syncOpt.lookbackDays ?? DEFAULT_SYNC_LOOKBACK,\n\t\t\t\t\t\tadapters: syncOpt.adapters,\n\t\t\t\t\t}\n\t\t\t\t: {\n\t\t\t\t\t\tenabled: false,\n\t\t\t\t\t\tcollectionSlug: DEFAULT_SYNC_COLLECTION,\n\t\t\t\t\t\tcron: DEFAULT_SYNC_CRON,\n\t\t\t\t\t\tlookbackDays: DEFAULT_SYNC_LOOKBACK,\n\t\t\t\t\t}\n\treturn {\n\t\tadapters: options.adapters,\n\t\tdefaultAdapter: options.defaultAdapter,\n\t\tscopeResolver: options.scopeResolver ?? (() => null),\n\t\tscoped: options.scopeResolver !== undefined,\n\t\tplatformAdapter: options.platformAdapter,\n\t\taccess: { platformRead: options.access?.platformRead ?? (({ req }) => Boolean(req.user)) },\n\t\tproviders,\n\t\tbindings: resolveBindings(options.collections),\n\t\tcache: {\n\t\t\tttl: {\n\t\t\t\taggregate: options.cache?.ttl?.aggregate ?? 3600,\n\t\t\t\trealtime: options.cache?.ttl?.realtime ?? 300,\n\t\t\t},\n\t\t\twarm,\n\t\t},\n\t\twidgets,\n\t\tsync,\n\t}\n}\n"],"mappings":";;AAOA,MAAM,oBAAoB;AAC1B,MAAM,oBAAoB;AAC1B,MAAM,0BAA0B;AAChC,MAAM,wBAAwB;AAC9B,MAAM,sBAAsB;AA2I5B,MAAM,mBACL,gBACqC;CACrC,MAAM,MAAuC,CAAC;CAC9C,KAAK,MAAM,CAAC,MAAM,YAAY,OAAO,QAAQ,eAAe,CAAC,CAAC,GAAG;EAChE,IAAI,CAAC,SAAS;EACd,IAAI,CAAC,QAAQ,QAAQ,CAAC,QAAQ,WAC7B,MAAM,IAAI,MAAM,2BAA2B,KAAK,uCAAuC;EAIxF,IAAI,QAAQ;CACb;CACA,OAAO;AACR;AAEA,SAAgB,eAAe,SAAkD;CAChF,IAAI,CAAC,QAAQ,YAAY,QAAQ,SAAS,WAAW,GACpD,MAAM,IAAI,MAAM,6CAA6C;CAE9D,IACC,QAAQ,oBAAoB,KAAA,KAC5B,CAAC,QAAQ,SAAS,MAAM,MAAM,EAAE,OAAO,QAAQ,eAAe,GAE9D,MAAM,IAAI,MAAM,wCAAwC,QAAQ,gBAAgB,EAAE;CAEnF,MAAM,UACL,QAAQ,YAAY,QACjB;EACA,SAAS;EACT,UAAU,CAAC;EACX,UAAU,CAAC;EACX,cAAc;CACf,IACC,QAAQ,YAAY,KAAA,KAAa,QAAQ,YAAY,OACpD;EACA,SAAS;EACT,UAAU,CAAC;EACX,UAAU,CAAC;EACX,cAAc;CACf,IACC;EACA,SAAS;EACT,UAAU,QAAQ,QAAQ,YAAY,CAAC;EACvC,UAAU,QAAQ,QAAQ,YAAY,CAAC;EACvC,cAAc,QAAQ,QAAQ,gBAAgB;CAC/C;CACJ,MAAM,UAAU,QAAQ,OAAO;CAC/B,MAAM,OACL,YAAY,OACT;EAAE,SAAS;EAAM,MAAM;CAAkB,IACzC,WAAW,OAAO,YAAY,WAC7B;EAAE,SAAS;EAAM,MAAM,QAAQ,QAAQ;CAAkB,IACzD;EAAE,SAAS;EAAO,MAAM;CAAkB;CAC/C,MAAM,gBAAgB,QAAQ,WAAW;CACzC,MAAM,YAAY;EACjB,YACC,kBAAkB,OACf;GAAE,SAAS;GAAM,MAAM;GAAgB,YAAY;EAAoB,IACvE,iBAAiB,OAAO,kBAAkB,WACzC;GACA,SAAS;GACT,MAAM,cAAc,QAAA;GACpB,YAAY,cAAc,cAAc;GACxC,WAAW,cAAc;GACzB,QAAQ,cAAc;EACvB,IACC;GAAE,SAAS;GAAO,MAAM;GAAgB,YAAY;EAAoB;EAC7E,SAAS,QAAQ,WAAW;CAC7B;CACA,MAAM,UAAU,QAAQ;CACxB,MAAM,OACL,YAAY,OACT;EACA,SAAS;EACT,gBAAgB;EAChB,MAAM;EACN,cAAc;CACf,IACC,WAAW,OAAO,YAAY,WAC7B;EACA,SAAS;EACT,gBAAgB,QAAQ,kBAAkB;EAC1C,MAAM,QAAQ,QAAQ;EACtB,cAAc,QAAQ,gBAAgB;EACtC,UAAU,QAAQ;CACnB,IACC;EACA,SAAS;EACT,gBAAgB;EAChB,MAAM;EACN,cAAc;CACf;CACJ,OAAO;EACN,UAAU,QAAQ;EAClB,gBAAgB,QAAQ;EACxB,eAAe,QAAQ,wBAAwB;EAC/C,QAAQ,QAAQ,kBAAkB,KAAA;EAClC,iBAAiB,QAAQ;EACzB,QAAQ,EAAE,cAAc,QAAQ,QAAQ,kBAAkB,EAAE,UAAU,QAAQ,IAAI,IAAI,GAAG;EACzF;EACA,UAAU,gBAAgB,QAAQ,WAAW;EAC7C,OAAO;GACN,KAAK;IACJ,WAAW,QAAQ,OAAO,KAAK,aAAa;IAC5C,UAAU,QAAQ,OAAO,KAAK,YAAY;GAC3C;GACA;EACD;EACA;EACA;CACD;AACD"}
|
|
1
|
+
{"version":3,"file":"options.js","names":[],"sources":["../../src/core/options.ts"],"sourcesContent":["import type { CollectionConfig, CollectionSlug, Payload, PayloadRequest } from 'payload'\nimport type { AnalyticsBinding, ResolvedBinding } from '../binding/types'\nimport { PROVIDERS_SLUG } from '../providers/collection'\nimport type { TranslationsOption } from '../translations'\nimport type { CustomWidgetDef } from '../widgets/customWidget'\nimport type { AnalyticsAdapter } from './contract'\n\nconst DEFAULT_WARM_CRON = '*/30 * * * *'\nconst DEFAULT_SYNC_CRON = '0 */6 * * *'\nconst DEFAULT_SYNC_COLLECTION = 'analytics-daily'\nconst DEFAULT_SYNC_LOOKBACK = 3\nconst DEFAULT_SCOPE_FIELD = 'scope'\n\n/**\n * Maps a request to its analytics boundary (tenant id, site key). Null means the\n * whole install, which is the default single-site behavior. With a multi-tenant\n * plugin, return the request's tenant id here.\n */\nexport type ScopeResolver = (args: {\n\treq: PayloadRequest\n}) => string | null | Promise<string | null>\n\n/**\n * Resolves the IANA reporting timezone a read's (or ingest's) day boundaries align\n * to. Receives the request and its already-resolved scope, so per-tenant, per-user\n * (`req.user`), and selector (cookie/preference) strategies are all expressible.\n * Return `null` to fall back to UTC.\n */\nexport type TimezoneResolver = (args: {\n\treq: PayloadRequest\n\tscope: string | null\n}) => string | null | Promise<string | null>\n\n/**\n * Escape hatch replacing the provider-collection lookup: return the runtime\n * adapters for a scope yourself (any store, any shape). Results are layered onto\n * the static config adapters exactly like collection-resolved ones, but are not\n * cached; memoize inside the function if lookups are expensive.\n */\nexport type ProvidersResolve = (args: {\n\tpayload: Payload\n\treq?: PayloadRequest\n\tscope: string | null\n}) => AnalyticsAdapter[] | Promise<AnalyticsAdapter[]>\n\nexport type ProvidersCollectionOptions = {\n\tslug?: string\n\t/**\n\t * Field matched against the resolved scope when looking up a scope's providers.\n\t * Point it at a tenant plugin's field (e.g. 'tenant') when that plugin manages\n\t * scoping for the collection.\n\t */\n\tscopeField?: string\n\toverrides?: (collection: CollectionConfig) => CollectionConfig\n\taccess?: Partial<CollectionConfig['access']>\n}\n\nexport type ProvidersOptions = {\n\t/** Opt-in admin collection storing runtime provider configurations. */\n\tcollection?: boolean | ProvidersCollectionOptions\n\tresolve?: ProvidersResolve\n}\n\n/** Access checker for cross-scope (platform) analytics reads. */\nexport type PlatformReadAccess = (args: { req: PayloadRequest }) => boolean | Promise<boolean>\n\nexport type AnalyticsAccessOptions = {\n\t/**\n\t * Gates cross-scope reads: explicit `scope: '*'` reads, and scoped reads through\n\t * a platform adapter that cannot filter by scope. Defaults to any authenticated\n\t * admin-panel user.\n\t */\n\tplatformRead?: PlatformReadAccess\n}\n\nexport type AnalyticsPluginOptions = {\n\tdisabled?: boolean\n\t/**\n\t * Per-locale overrides for this plugin's UI strings, keyed by the typed\n\t * translation keys exported from `@10x-media/analytics/i18n`. Values win over\n\t * the built-in locales key-by-key; locales the plugin does not ship are added\n\t * whole. App-level `i18n.translations` still wins over both.\n\t */\n\ttranslations?: TranslationsOption\n\tadapters?: AnalyticsAdapter[]\n\tdefaultAdapter?: string\n\tscopeResolver?: ScopeResolver\n\t/**\n\t * IANA reporting timezone that day boundaries (timeframe windows, series axes,\n\t * native rollup buckets) align to. Defaults to UTC. A string forces one timezone\n\t * (the single-tenant / no-multi-tenancy case); a resolver derives it per request\n\t * from the scope, user, or a selector. Native rollups bucket at ingest in the\n\t * resolved timezone, so changing it does not re-bucket existing history.\n\t */\n\treportingTimezone?: string | TimezoneResolver\n\tproviders?: ProvidersOptions\n\t/**\n\t * Id of one config adapter shared by every scope (the platform's own analytics,\n\t * e.g. a PostHog project capturing all tenants). Included in each scope's\n\t * registry like any config adapter; reads through it are scope-filtered only\n\t * when the adapter supports scoped queries, otherwise they are cross-scope and\n\t * require `access.platformRead`.\n\t */\n\tplatformAdapter?: string\n\taccess?: AnalyticsAccessOptions\n\t/**\n\t * Per-collection bindings, keyed by collection slug. With generated types\n\t * augmented, each slug's resolvers receive that collection's typed document.\n\t */\n\tcollections?: { [TSlug in CollectionSlug]?: AnalyticsBinding<TSlug> }\n\tcache?: { ttl?: { aggregate?: number; realtime?: number }; warm?: boolean | { cron?: string } }\n\twidgets?:\n\t\t| boolean\n\t\t| {\n\t\t\t\tdisabled?: string[]\n\t\t\t\tregister?: CustomWidgetDef[]\n\t\t\t\t/**\n\t\t\t\t * Marks the free-text widget config fields (each widget's Title) as\n\t\t\t\t * `localized`. Off by default; takes effect only when the Payload config\n\t\t\t\t * enables localization (Payload strips the flag otherwise).\n\t\t\t\t */\n\t\t\t\tlocalizeText?: boolean\n\t\t\t\t/**\n\t\t\t\t * Period-over-period comparison on the metric and trend widgets. On by\n\t\t\t\t * default for adapters that declare `capabilities.comparison`; set false\n\t\t\t\t * to skip the second (previous-window) read entirely.\n\t\t\t\t */\n\t\t\t\tcomparison?: boolean\n\t\t }\n\t/**\n\t * Opt-in sync tier: a cron job that persists each provider's daily metrics into a\n\t * queryable collection. Reads go through the surfacing cache, so persisted rows reflect\n\t * cached values up to `cache.ttl.aggregate` old; keep that TTL below the sync interval\n\t * for the freshest data.\n\t */\n\tsync?:\n\t\t| boolean\n\t\t| {\n\t\t\t\tcollectionSlug?: CollectionSlug\n\t\t\t\tcron?: string\n\t\t\t\tlookbackDays?: number\n\t\t\t\tadapters?: string[]\n\t\t\t\t/** Surface the analytics-daily collection in the admin nav. Default false (hidden). */\n\t\t\t\thidden?: boolean\n\t\t }\n}\n\nexport interface ResolvedOptions {\n\tadapters: AnalyticsAdapter[]\n\tdefaultAdapter?: string\n\tscopeResolver: ScopeResolver\n\t/** True when the app configured a scopeResolver (scoped install). */\n\tscoped: boolean\n\t/** Raw reportingTimezone option; normalized into a resolver at init. */\n\treportingTimezone?: string | TimezoneResolver\n\tplatformAdapter?: string\n\taccess: { platformRead: PlatformReadAccess }\n\tproviders: {\n\t\tcollection: {\n\t\t\tenabled: boolean\n\t\t\tslug: string\n\t\t\tscopeField: string\n\t\t\toverrides?: (collection: CollectionConfig) => CollectionConfig\n\t\t\taccess?: Partial<CollectionConfig['access']>\n\t\t}\n\t\tresolve?: ProvidersResolve\n\t}\n\tbindings: Record<string, ResolvedBinding>\n\tcache: {\n\t\t/** Undefined when unset: adapter recommendedTtl is the fallback, an explicit value wins. */\n\t\tttl: { aggregate?: number; realtime?: number }\n\t\twarm: { enabled: boolean; cron: string }\n\t}\n\twidgets: {\n\t\tenabled: boolean\n\t\tdisabled: string[]\n\t\tregister: CustomWidgetDef[]\n\t\tlocalizeText: boolean\n\t\tcomparison: boolean\n\t}\n\tsync: {\n\t\tenabled: boolean\n\t\tcollectionSlug: string\n\t\tcron: string\n\t\tlookbackDays: number\n\t\tadapters?: string[]\n\t\t/** True hides the analytics-daily collection from the admin nav (default). */\n\t\thidden: boolean\n\t}\n}\n\nconst resolveBindings = (\n\tcollections: AnalyticsPluginOptions['collections']\n): Record<string, ResolvedBinding> => {\n\tconst out: Record<string, ResolvedBinding> = {}\n\tfor (const [slug, binding] of Object.entries(collections ?? {})) {\n\t\tif (!binding) continue\n\t\tif (!binding.path && !binding.pathField) {\n\t\t\tthrow new Error(`analytics: binding for \"${slug}\" needs a path resolver or a pathField`)\n\t\t}\n\t\t// Erases the per-slug doc generic; safe because the runtime only ever hands\n\t\t// a binding documents from its own collection.\n\t\tout[slug] = binding as ResolvedBinding\n\t}\n\treturn out\n}\n\nexport function resolveOptions(options: AnalyticsPluginOptions): ResolvedOptions {\n\tif (!options.adapters || options.adapters.length === 0) {\n\t\tthrow new Error('analytics: at least one adapter is required')\n\t}\n\tif (\n\t\toptions.platformAdapter !== undefined &&\n\t\t!options.adapters.some((a) => a.id === options.platformAdapter)\n\t) {\n\t\tthrow new Error(`analytics: unknown platform adapter \"${options.platformAdapter}\"`)\n\t}\n\tconst widgets =\n\t\toptions.widgets === false\n\t\t\t? {\n\t\t\t\t\tenabled: false,\n\t\t\t\t\tdisabled: [] as string[],\n\t\t\t\t\tregister: [] as CustomWidgetDef[],\n\t\t\t\t\tlocalizeText: false,\n\t\t\t\t\tcomparison: true,\n\t\t\t\t}\n\t\t\t: options.widgets === undefined || options.widgets === true\n\t\t\t\t? {\n\t\t\t\t\t\tenabled: true,\n\t\t\t\t\t\tdisabled: [] as string[],\n\t\t\t\t\t\tregister: [] as CustomWidgetDef[],\n\t\t\t\t\t\tlocalizeText: false,\n\t\t\t\t\t\tcomparison: true,\n\t\t\t\t\t}\n\t\t\t\t: {\n\t\t\t\t\t\tenabled: true,\n\t\t\t\t\t\tdisabled: options.widgets.disabled ?? [],\n\t\t\t\t\t\tregister: options.widgets.register ?? [],\n\t\t\t\t\t\tlocalizeText: options.widgets.localizeText ?? false,\n\t\t\t\t\t\tcomparison: options.widgets.comparison ?? true,\n\t\t\t\t\t}\n\tconst warmOpt = options.cache?.warm\n\tconst warm =\n\t\twarmOpt === true\n\t\t\t? { enabled: true, cron: DEFAULT_WARM_CRON }\n\t\t\t: warmOpt && typeof warmOpt === 'object'\n\t\t\t\t? { enabled: true, cron: warmOpt.cron ?? DEFAULT_WARM_CRON }\n\t\t\t\t: { enabled: false, cron: DEFAULT_WARM_CRON }\n\tconst collectionOpt = options.providers?.collection\n\tconst providers = {\n\t\tcollection:\n\t\t\tcollectionOpt === true\n\t\t\t\t? { enabled: true, slug: PROVIDERS_SLUG, scopeField: DEFAULT_SCOPE_FIELD }\n\t\t\t\t: collectionOpt && typeof collectionOpt === 'object'\n\t\t\t\t\t? {\n\t\t\t\t\t\t\tenabled: true,\n\t\t\t\t\t\t\tslug: collectionOpt.slug ?? PROVIDERS_SLUG,\n\t\t\t\t\t\t\tscopeField: collectionOpt.scopeField ?? DEFAULT_SCOPE_FIELD,\n\t\t\t\t\t\t\toverrides: collectionOpt.overrides,\n\t\t\t\t\t\t\taccess: collectionOpt.access,\n\t\t\t\t\t\t}\n\t\t\t\t\t: { enabled: false, slug: PROVIDERS_SLUG, scopeField: DEFAULT_SCOPE_FIELD },\n\t\tresolve: options.providers?.resolve,\n\t}\n\tconst syncOpt = options.sync\n\tconst sync =\n\t\tsyncOpt === true\n\t\t\t? {\n\t\t\t\t\tenabled: true,\n\t\t\t\t\tcollectionSlug: DEFAULT_SYNC_COLLECTION,\n\t\t\t\t\tcron: DEFAULT_SYNC_CRON,\n\t\t\t\t\tlookbackDays: DEFAULT_SYNC_LOOKBACK,\n\t\t\t\t\thidden: true,\n\t\t\t\t}\n\t\t\t: syncOpt && typeof syncOpt === 'object'\n\t\t\t\t? {\n\t\t\t\t\t\tenabled: true,\n\t\t\t\t\t\tcollectionSlug: syncOpt.collectionSlug ?? DEFAULT_SYNC_COLLECTION,\n\t\t\t\t\t\tcron: syncOpt.cron ?? DEFAULT_SYNC_CRON,\n\t\t\t\t\t\tlookbackDays: syncOpt.lookbackDays ?? DEFAULT_SYNC_LOOKBACK,\n\t\t\t\t\t\tadapters: syncOpt.adapters,\n\t\t\t\t\t\thidden: syncOpt.hidden ?? true,\n\t\t\t\t\t}\n\t\t\t\t: {\n\t\t\t\t\t\tenabled: false,\n\t\t\t\t\t\tcollectionSlug: DEFAULT_SYNC_COLLECTION,\n\t\t\t\t\t\tcron: DEFAULT_SYNC_CRON,\n\t\t\t\t\t\tlookbackDays: DEFAULT_SYNC_LOOKBACK,\n\t\t\t\t\t\thidden: true,\n\t\t\t\t\t}\n\treturn {\n\t\tadapters: options.adapters,\n\t\tdefaultAdapter: options.defaultAdapter,\n\t\tscopeResolver: options.scopeResolver ?? (() => null),\n\t\tscoped: options.scopeResolver !== undefined,\n\t\treportingTimezone: options.reportingTimezone,\n\t\tplatformAdapter: options.platformAdapter,\n\t\taccess: { platformRead: options.access?.platformRead ?? (({ req }) => Boolean(req.user)) },\n\t\tproviders,\n\t\tbindings: resolveBindings(options.collections),\n\t\tcache: {\n\t\t\t// Left undefined when the app did not set them so the adapter's recommendedTtl\n\t\t\t// applies as the default; an explicit value overrides the adapter recommendation.\n\t\t\tttl: {\n\t\t\t\taggregate: options.cache?.ttl?.aggregate,\n\t\t\t\trealtime: options.cache?.ttl?.realtime,\n\t\t\t},\n\t\t\twarm,\n\t\t},\n\t\twidgets,\n\t\tsync,\n\t}\n}\n"],"mappings":";;AAOA,MAAM,oBAAoB;AAC1B,MAAM,oBAAoB;AAC1B,MAAM,0BAA0B;AAChC,MAAM,wBAAwB;AAC9B,MAAM,sBAAsB;AAoL5B,MAAM,mBACL,gBACqC;CACrC,MAAM,MAAuC,CAAC;CAC9C,KAAK,MAAM,CAAC,MAAM,YAAY,OAAO,QAAQ,eAAe,CAAC,CAAC,GAAG;EAChE,IAAI,CAAC,SAAS;EACd,IAAI,CAAC,QAAQ,QAAQ,CAAC,QAAQ,WAC7B,MAAM,IAAI,MAAM,2BAA2B,KAAK,uCAAuC;EAIxF,IAAI,QAAQ;CACb;CACA,OAAO;AACR;AAEA,SAAgB,eAAe,SAAkD;CAChF,IAAI,CAAC,QAAQ,YAAY,QAAQ,SAAS,WAAW,GACpD,MAAM,IAAI,MAAM,6CAA6C;CAE9D,IACC,QAAQ,oBAAoB,KAAA,KAC5B,CAAC,QAAQ,SAAS,MAAM,MAAM,EAAE,OAAO,QAAQ,eAAe,GAE9D,MAAM,IAAI,MAAM,wCAAwC,QAAQ,gBAAgB,EAAE;CAEnF,MAAM,UACL,QAAQ,YAAY,QACjB;EACA,SAAS;EACT,UAAU,CAAC;EACX,UAAU,CAAC;EACX,cAAc;EACd,YAAY;CACb,IACC,QAAQ,YAAY,KAAA,KAAa,QAAQ,YAAY,OACpD;EACA,SAAS;EACT,UAAU,CAAC;EACX,UAAU,CAAC;EACX,cAAc;EACd,YAAY;CACb,IACC;EACA,SAAS;EACT,UAAU,QAAQ,QAAQ,YAAY,CAAC;EACvC,UAAU,QAAQ,QAAQ,YAAY,CAAC;EACvC,cAAc,QAAQ,QAAQ,gBAAgB;EAC9C,YAAY,QAAQ,QAAQ,cAAc;CAC3C;CACJ,MAAM,UAAU,QAAQ,OAAO;CAC/B,MAAM,OACL,YAAY,OACT;EAAE,SAAS;EAAM,MAAM;CAAkB,IACzC,WAAW,OAAO,YAAY,WAC7B;EAAE,SAAS;EAAM,MAAM,QAAQ,QAAQ;CAAkB,IACzD;EAAE,SAAS;EAAO,MAAM;CAAkB;CAC/C,MAAM,gBAAgB,QAAQ,WAAW;CACzC,MAAM,YAAY;EACjB,YACC,kBAAkB,OACf;GAAE,SAAS;GAAM,MAAM;GAAgB,YAAY;EAAoB,IACvE,iBAAiB,OAAO,kBAAkB,WACzC;GACA,SAAS;GACT,MAAM,cAAc,QAAA;GACpB,YAAY,cAAc,cAAc;GACxC,WAAW,cAAc;GACzB,QAAQ,cAAc;EACvB,IACC;GAAE,SAAS;GAAO,MAAM;GAAgB,YAAY;EAAoB;EAC7E,SAAS,QAAQ,WAAW;CAC7B;CACA,MAAM,UAAU,QAAQ;CACxB,MAAM,OACL,YAAY,OACT;EACA,SAAS;EACT,gBAAgB;EAChB,MAAM;EACN,cAAc;EACd,QAAQ;CACT,IACC,WAAW,OAAO,YAAY,WAC7B;EACA,SAAS;EACT,gBAAgB,QAAQ,kBAAkB;EAC1C,MAAM,QAAQ,QAAQ;EACtB,cAAc,QAAQ,gBAAgB;EACtC,UAAU,QAAQ;EAClB,QAAQ,QAAQ,UAAU;CAC3B,IACC;EACA,SAAS;EACT,gBAAgB;EAChB,MAAM;EACN,cAAc;EACd,QAAQ;CACT;CACJ,OAAO;EACN,UAAU,QAAQ;EAClB,gBAAgB,QAAQ;EACxB,eAAe,QAAQ,wBAAwB;EAC/C,QAAQ,QAAQ,kBAAkB,KAAA;EAClC,mBAAmB,QAAQ;EAC3B,iBAAiB,QAAQ;EACzB,QAAQ,EAAE,cAAc,QAAQ,QAAQ,kBAAkB,EAAE,UAAU,QAAQ,IAAI,IAAI,GAAG;EACzF;EACA,UAAU,gBAAgB,QAAQ,WAAW;EAC7C,OAAO;GAGN,KAAK;IACJ,WAAW,QAAQ,OAAO,KAAK;IAC/B,UAAU,QAAQ,OAAO,KAAK;GAC/B;GACA;EACD;EACA;EACA;CACD;AACD"}
|
package/dist/exports/rsc.d.ts
CHANGED
|
@@ -2,12 +2,15 @@ import { DateRange, DimensionKey, MetricKey } from "../core/contract.js";
|
|
|
2
2
|
import { ReadForWidgetRealtimeArgs, RealtimePoint, WidgetRealtimeResult, WidgetRealtimeStatus, readForWidgetRealtime } from "../widgets/readForWidgetRealtime.js";
|
|
3
3
|
import { CapabilityRequirement } from "../core/capabilities.js";
|
|
4
4
|
import { AnalyticsStatField } from "../fields/AnalyticsStatField.js";
|
|
5
|
+
import { AnalyticsPanelField } from "../fields/AnalyticsPanelField.js";
|
|
5
6
|
import { formatMetricValue } from "../fields/format.js";
|
|
7
|
+
import { ReadForWidgetArgs, WidgetReadResult, WidgetReadStatus, readForWidget } from "../widgets/readForWidget.js";
|
|
8
|
+
import { ReadForWidgetSeriesArgs, SeriesPoint, WidgetSeriesResult, readForWidgetSeries } from "../widgets/readForWidgetSeries.js";
|
|
9
|
+
import { FieldReadResult, FieldReadStatus, ReadForFieldArgs, readForField } from "../fields/readForDocument.js";
|
|
6
10
|
import { AnalyticsBreakdownWidget } from "../widgets/AnalyticsBreakdownWidget.js";
|
|
7
11
|
import { AnalyticsMetricWidget } from "../widgets/AnalyticsMetricWidget.js";
|
|
8
12
|
import { AnalyticsRealtimeWidget } from "../widgets/AnalyticsRealtimeWidget.js";
|
|
9
13
|
import { AnalyticsTrendWidget } from "../widgets/AnalyticsTrendWidget.js";
|
|
10
|
-
import {
|
|
14
|
+
import { cardStyle, labelStyle } from "../widgets/cardChrome.js";
|
|
11
15
|
import { BreakdownRow, ReadForWidgetBreakdownArgs, WidgetBreakdownResult, readForWidgetBreakdown } from "../widgets/readForWidgetBreakdown.js";
|
|
12
|
-
|
|
13
|
-
export { AnalyticsBreakdownWidget, AnalyticsMetricWidget, AnalyticsRealtimeWidget, AnalyticsStatField, AnalyticsTrendWidget, type BreakdownRow, type CapabilityRequirement, type DateRange, type DimensionKey, type MetricKey, type ReadForWidgetArgs, type ReadForWidgetBreakdownArgs, type ReadForWidgetRealtimeArgs, type ReadForWidgetSeriesArgs, type RealtimePoint, type SeriesPoint, type WidgetBreakdownResult, type WidgetReadResult, type WidgetReadStatus, type WidgetRealtimeResult, type WidgetRealtimeStatus, type WidgetSeriesResult, formatMetricValue, readForWidget, readForWidgetBreakdown, readForWidgetRealtime, readForWidgetSeries };
|
|
16
|
+
export { AnalyticsBreakdownWidget, AnalyticsMetricWidget, AnalyticsPanelField, AnalyticsRealtimeWidget, AnalyticsStatField, AnalyticsTrendWidget, type BreakdownRow, type CapabilityRequirement, type DateRange, type DimensionKey, type FieldReadResult, type FieldReadStatus, type MetricKey, type ReadForFieldArgs, type ReadForWidgetArgs, type ReadForWidgetBreakdownArgs, type ReadForWidgetRealtimeArgs, type ReadForWidgetSeriesArgs, type RealtimePoint, type SeriesPoint, type WidgetBreakdownResult, type WidgetReadResult, type WidgetReadStatus, type WidgetRealtimeResult, type WidgetRealtimeStatus, type WidgetSeriesResult, formatMetricValue, readForField, readForWidget, readForWidgetBreakdown, readForWidgetRealtime, readForWidgetSeries, cardStyle as widgetCardStyle, labelStyle as widgetLabelStyle };
|
package/dist/exports/rsc.js
CHANGED
|
@@ -1,11 +1,14 @@
|
|
|
1
|
+
import { readForWidgetSeries } from "../widgets/readForWidgetSeries.js";
|
|
2
|
+
import { readForField } from "../fields/readForDocument.js";
|
|
1
3
|
import { readForWidgetRealtime } from "../widgets/readForWidgetRealtime.js";
|
|
2
4
|
import { readForWidget } from "../widgets/readForWidget.js";
|
|
3
5
|
import { readForWidgetBreakdown } from "../widgets/readForWidgetBreakdown.js";
|
|
4
|
-
import { readForWidgetSeries } from "../widgets/readForWidgetSeries.js";
|
|
5
6
|
import { formatMetricValue } from "../fields/format.js";
|
|
6
7
|
import { AnalyticsStatField } from "../fields/AnalyticsStatField.js";
|
|
8
|
+
import { AnalyticsPanelField } from "../fields/AnalyticsPanelField.js";
|
|
9
|
+
import { cardStyle, labelStyle } from "../widgets/cardChrome.js";
|
|
7
10
|
import AnalyticsBreakdownWidget from "../widgets/AnalyticsBreakdownWidget.js";
|
|
8
11
|
import AnalyticsMetricWidget from "../widgets/AnalyticsMetricWidget.js";
|
|
9
12
|
import AnalyticsRealtimeWidget from "../widgets/AnalyticsRealtimeWidget.js";
|
|
10
13
|
import AnalyticsTrendWidget from "../widgets/AnalyticsTrendWidget.js";
|
|
11
|
-
export { AnalyticsBreakdownWidget, AnalyticsMetricWidget, AnalyticsRealtimeWidget, AnalyticsStatField, AnalyticsTrendWidget, formatMetricValue, readForWidget, readForWidgetBreakdown, readForWidgetRealtime, readForWidgetSeries };
|
|
14
|
+
export { AnalyticsBreakdownWidget, AnalyticsMetricWidget, AnalyticsPanelField, AnalyticsRealtimeWidget, AnalyticsStatField, AnalyticsTrendWidget, formatMetricValue, readForField, readForWidget, readForWidgetBreakdown, readForWidgetRealtime, readForWidgetSeries, cardStyle as widgetCardStyle, labelStyle as widgetLabelStyle };
|