@10x-media/analytics 0.1.0-beta.0 → 0.1.0-beta.2
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 +127 -0
- package/README.md +38 -357
- package/dist/adapters/ga4/ga4.d.ts +20 -0
- package/dist/adapters/ga4/ga4.js +187 -0
- package/dist/adapters/ga4/ga4.js.map +1 -0
- package/dist/{fetchJson-DZb2_Puj.js → adapters/http/fetchJson.js} +2 -2
- package/dist/adapters/http/fetchJson.js.map +1 -0
- package/dist/adapters/plausible/plausible.d.ts +15 -0
- package/dist/adapters/plausible/plausible.js +148 -0
- package/dist/adapters/plausible/plausible.js.map +1 -0
- package/dist/adapters/posthog/posthog.d.ts +23 -0
- package/dist/adapters/posthog/posthog.js +132 -0
- package/dist/adapters/posthog/posthog.js.map +1 -0
- package/dist/{series-zytbzPoc.js → adapters/series.js} +2 -2
- package/dist/adapters/series.js.map +1 -0
- package/dist/adapters/umami/umami.d.ts +18 -0
- package/dist/adapters/umami/umami.js +139 -0
- package/dist/{exports/adapters → adapters/umami}/umami.js.map +1 -1
- package/dist/binding/resolvePath.js +61 -0
- package/dist/binding/resolvePath.js.map +1 -0
- package/dist/binding/types.d.ts +55 -0
- package/dist/charts/BarList.d.ts +20 -0
- package/dist/charts/BarList.js +73 -0
- package/dist/charts/BarList.js.map +1 -0
- package/dist/charts/TrendChart.d.ts +25 -0
- package/dist/charts/TrendChart.js +195 -0
- package/dist/charts/TrendChart.js.map +1 -0
- package/dist/charts/bars.d.ts +9 -0
- package/dist/charts/bars.js +19 -0
- package/dist/charts/bars.js.map +1 -0
- package/dist/charts/bucket.js +86 -0
- package/dist/charts/bucket.js.map +1 -0
- package/dist/charts/spline.js +84 -0
- package/dist/charts/spline.js.map +1 -0
- package/dist/charts/styles.js +42 -0
- package/dist/charts/styles.js.map +1 -0
- package/dist/core/cacheKey.js +28 -0
- package/dist/core/cacheKey.js.map +1 -0
- package/dist/core/capabilities.d.ts +12 -0
- package/dist/core/capabilities.js +12 -0
- package/dist/core/capabilities.js.map +1 -0
- package/dist/{contract-CWZPKWuR.d.ts → core/contract.d.ts} +42 -5
- package/dist/core/contract.js +10 -0
- package/dist/core/contract.js.map +1 -0
- package/dist/core/granularity.js +17 -0
- package/dist/core/granularity.js.map +1 -0
- package/dist/core/options.d.ts +140 -0
- package/dist/core/options.js +114 -0
- package/dist/core/options.js.map +1 -0
- package/dist/core/registry.js +24 -0
- package/dist/core/registry.js.map +1 -0
- package/dist/core/scopedRead.js +57 -0
- package/dist/core/scopedRead.js.map +1 -0
- package/dist/exports/adapters/ga4.d.ts +2 -20
- package/dist/exports/adapters/ga4.js +1 -176
- package/dist/exports/adapters/native.d.ts +2 -22
- package/dist/exports/adapters/native.js +1 -848
- package/dist/exports/adapters/plausible.d.ts +2 -15
- package/dist/exports/adapters/plausible.js +1 -142
- package/dist/exports/adapters/posthog.d.ts +2 -17
- package/dist/exports/adapters/posthog.js +1 -118
- package/dist/exports/adapters/umami.d.ts +2 -18
- package/dist/exports/adapters/umami.js +1 -138
- package/dist/exports/client.d.ts +5 -77
- package/dist/exports/client.js +4 -386
- package/dist/exports/geo.d.ts +4 -19
- package/dist/exports/geo.js +3 -1
- package/dist/exports/i18n.d.ts +3 -63
- package/dist/exports/i18n.js +2 -2
- package/dist/exports/next.d.ts +2 -0
- package/dist/exports/next.js +2 -0
- package/dist/exports/rsc.d.ts +16 -120
- package/dist/exports/rsc.js +14 -598
- package/dist/exports/types.d.ts +6 -4
- package/dist/exports/types.js +2 -1
- 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 +31 -0
- package/dist/fields/AnalyticsStatField.js +104 -0
- package/dist/fields/AnalyticsStatField.js.map +1 -0
- package/dist/fields/dateRange/field.js +55 -0
- package/dist/fields/dateRange/field.js.map +1 -0
- package/dist/fields/dateRange/styles.js +23 -0
- package/dist/fields/dateRange/styles.js.map +1 -0
- package/dist/fields/dateRange/types.d.ts +11 -0
- package/dist/fields/dateRange/ui.d.ts +9 -0
- package/dist/fields/dateRange/ui.js +373 -0
- package/dist/fields/dateRange/ui.js.map +1 -0
- package/dist/fields/emptyState.js +46 -0
- package/dist/fields/emptyState.js.map +1 -0
- package/dist/fields/factories.d.ts +60 -0
- package/dist/fields/factories.js +94 -0
- package/dist/fields/factories.js.map +1 -0
- package/dist/fields/format.d.ts +7 -0
- package/dist/fields/format.js +22 -0
- package/dist/fields/format.js.map +1 -0
- package/dist/fields/readForDocument.d.ts +57 -0
- package/dist/fields/readForDocument.js +147 -0
- package/dist/fields/readForDocument.js.map +1 -0
- package/dist/index.d.ts +18 -3
- package/dist/index.js +83 -1028
- package/dist/index.js.map +1 -1
- package/dist/native/collections/events.js +101 -0
- package/dist/native/collections/events.js.map +1 -0
- package/dist/native/collections/rollups.js +115 -0
- package/dist/native/collections/rollups.js.map +1 -0
- package/dist/native/collections/seen.js +47 -0
- package/dist/native/collections/seen.js.map +1 -0
- package/dist/native/geo/composeGeoResolvers.d.ts +7 -0
- package/dist/native/geo/composeGeoResolvers.js +14 -0
- package/dist/native/geo/composeGeoResolvers.js.map +1 -0
- package/dist/{geoResolver-CasIa4T9.d.ts → native/geo/geoResolver.d.ts} +2 -2
- package/dist/native/geo/geoResolver.js +11 -0
- package/dist/native/geo/geoResolver.js.map +1 -0
- package/dist/native/geo/maxmindResolver.d.ts +16 -0
- package/dist/native/geo/maxmindResolver.js +55 -0
- package/dist/native/geo/maxmindResolver.js.map +1 -0
- package/dist/native/ingest/device.js +15 -0
- package/dist/native/ingest/device.js.map +1 -0
- package/dist/native/ingest/endpoint.js +30 -0
- package/dist/native/ingest/endpoint.js.map +1 -0
- package/dist/native/ingest/flushBatch.js +69 -0
- package/dist/native/ingest/flushBatch.js.map +1 -0
- package/dist/native/ingest/normalizeEvent.js +39 -0
- package/dist/native/ingest/normalizeEvent.js.map +1 -0
- package/dist/native/ingest/salt.js +14 -0
- package/dist/native/ingest/salt.js.map +1 -0
- package/dist/native/ingest/source.js +22 -0
- package/dist/native/ingest/source.js.map +1 -0
- package/dist/native/ingest/visitorHash.js +12 -0
- package/dist/native/ingest/visitorHash.js.map +1 -0
- package/dist/native/ingest/writeBuffer.js +55 -0
- package/dist/native/ingest/writeBuffer.js.map +1 -0
- package/dist/native/ingest/writeEvent.js +14 -0
- package/dist/native/ingest/writeEvent.js.map +1 -0
- package/dist/native/nativeAdapter.d.ts +22 -0
- package/dist/native/nativeAdapter.js +216 -0
- package/dist/native/nativeAdapter.js.map +1 -0
- package/dist/native/realtime/buildRealtime.js +53 -0
- package/dist/native/realtime/buildRealtime.js.map +1 -0
- package/dist/native/retention/pruneTask.js +29 -0
- package/dist/native/retention/pruneTask.js.map +1 -0
- package/dist/native/rollupAcc.js +53 -0
- package/dist/native/rollupAcc.js.map +1 -0
- package/dist/native/rollups/applyDistinctDeltas.js +9 -0
- package/dist/native/rollups/applyDistinctDeltas.js.map +1 -0
- package/dist/native/rollups/bumpRollup.js +52 -0
- package/dist/native/rollups/bumpRollup.js.map +1 -0
- package/dist/native/rollups/deltas.js +31 -0
- package/dist/native/rollups/deltas.js.map +1 -0
- package/dist/native/rollups/insertIfNew.js +19 -0
- package/dist/native/rollups/insertIfNew.js.map +1 -0
- package/dist/next/posthogProxyRewrites.d.ts +36 -0
- package/dist/next/posthogProxyRewrites.js +50 -0
- package/dist/next/posthogProxyRewrites.js.map +1 -0
- 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/realtimeEndpoint.js +36 -0
- package/dist/plugin/realtimeEndpoint.js.map +1 -0
- package/dist/plugin/registerTranslations.js +19 -0
- package/dist/plugin/registerTranslations.js.map +1 -0
- package/dist/plugin/runtime.js +21 -0
- package/dist/plugin/runtime.js.map +1 -0
- package/dist/plugin/warmTask.js +165 -0
- package/dist/plugin/warmTask.js.map +1 -0
- package/dist/providers/collection.js +159 -0
- package/dist/providers/collection.js.map +1 -0
- package/dist/providers/factory.js +62 -0
- package/dist/providers/factory.js.map +1 -0
- package/dist/providers/resolver.js +67 -0
- package/dist/providers/resolver.js.map +1 -0
- package/dist/providers/secrets.js +27 -0
- package/dist/providers/secrets.js.map +1 -0
- package/dist/surfacing/cacheStore.js +26 -0
- package/dist/surfacing/cacheStore.js.map +1 -0
- package/dist/surfacing/coalesce.js +15 -0
- package/dist/surfacing/coalesce.js.map +1 -0
- package/dist/surfacing/engine.js +63 -0
- package/dist/surfacing/engine.js.map +1 -0
- package/dist/surfacing/queue.js +44 -0
- package/dist/surfacing/queue.js.map +1 -0
- package/dist/sync/collection.js +70 -0
- package/dist/sync/collection.js.map +1 -0
- package/dist/sync/syncTask.js +123 -0
- package/dist/sync/syncTask.js.map +1 -0
- package/dist/testing/memoryAdapter.d.ts +1 -1
- package/dist/timeframe/presets.d.ts +6 -0
- package/dist/timeframe/presets.js +59 -0
- package/dist/timeframe/presets.js.map +1 -0
- 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-keiKtSjF.js → translations/en.js} +30 -25
- package/dist/translations/en.js.map +1 -0
- package/dist/translations/index.d.ts +15 -0
- package/dist/translations/index.js +30 -0
- package/dist/translations/index.js.map +1 -0
- package/dist/translations/keys.d.ts +81 -0
- package/dist/{keys-DEqL4LOT.js → translations/keys.js} +29 -5
- package/dist/translations/keys.js.map +1 -0
- package/dist/translations/metricKeys.js +28 -0
- package/dist/translations/metricKeys.js.map +1 -0
- package/dist/translations/server.js +13 -0
- package/dist/translations/server.js.map +1 -0
- package/dist/translations/useTranslation.js +12 -0
- package/dist/translations/useTranslation.js.map +1 -0
- package/dist/widgets/AnalyticsBreakdownWidget.d.ts +7 -0
- package/dist/widgets/AnalyticsBreakdownWidget.js +85 -0
- package/dist/widgets/AnalyticsBreakdownWidget.js.map +1 -0
- package/dist/widgets/AnalyticsMetricWidget.d.ts +7 -0
- package/dist/widgets/AnalyticsMetricWidget.js +89 -0
- package/dist/widgets/AnalyticsMetricWidget.js.map +1 -0
- package/dist/widgets/AnalyticsRealtimeWidget.d.ts +7 -0
- package/dist/widgets/AnalyticsRealtimeWidget.js +64 -0
- package/dist/widgets/AnalyticsRealtimeWidget.js.map +1 -0
- package/dist/widgets/AnalyticsTrendWidget.d.ts +7 -0
- package/dist/widgets/AnalyticsTrendWidget.js +99 -0
- package/dist/widgets/AnalyticsTrendWidget.js.map +1 -0
- package/dist/widgets/ComparisonDelta.js +83 -0
- package/dist/widgets/ComparisonDelta.js.map +1 -0
- package/dist/widgets/RealtimeCounter.d.ts +19 -0
- package/dist/widgets/RealtimeCounter.js +76 -0
- package/dist/widgets/RealtimeCounter.js.map +1 -0
- package/dist/widgets/breakdownTypes.js +29 -0
- package/dist/widgets/breakdownTypes.js.map +1 -0
- package/dist/widgets/cardChrome.d.ts +8 -0
- package/dist/widgets/cardChrome.js +22 -0
- package/dist/widgets/cardChrome.js.map +1 -0
- package/dist/widgets/comparison.js +43 -0
- package/dist/widgets/comparison.js.map +1 -0
- package/dist/widgets/customWidget.d.ts +20 -0
- package/dist/widgets/customWidget.js +30 -0
- package/dist/widgets/customWidget.js.map +1 -0
- package/dist/widgets/defaults.d.ts +12 -0
- package/dist/widgets/defaults.js +72 -0
- package/dist/widgets/defaults.js.map +1 -0
- package/dist/widgets/range.js +28 -0
- package/dist/widgets/range.js.map +1 -0
- package/dist/widgets/readForWidget.d.ts +31 -0
- package/dist/widgets/readForWidget.js +72 -0
- package/dist/widgets/readForWidget.js.map +1 -0
- package/dist/widgets/readForWidgetBreakdown.d.ts +38 -0
- package/dist/widgets/readForWidgetBreakdown.js +80 -0
- package/dist/widgets/readForWidgetBreakdown.js.map +1 -0
- package/dist/{readForWidgetRealtime-D1BD37ST.d.ts → widgets/readForWidgetRealtime.d.ts} +5 -3
- package/dist/widgets/readForWidgetRealtime.js +63 -0
- package/dist/widgets/readForWidgetRealtime.js.map +1 -0
- package/dist/widgets/readForWidgetSeries.d.ts +44 -0
- package/dist/widgets/readForWidgetSeries.js +117 -0
- package/dist/widgets/readForWidgetSeries.js.map +1 -0
- package/dist/widgets/realtimePoll.js +26 -0
- package/dist/widgets/realtimePoll.js.map +1 -0
- package/dist/widgets/registerWidgets.js +228 -0
- package/dist/widgets/registerWidgets.js.map +1 -0
- package/dist/widgets/types.js +13 -0
- package/dist/widgets/types.js.map +1 -0
- package/package.json +19 -5
- package/dist/RealtimeCounter-BJrjMPSa.js +0 -473
- package/dist/RealtimeCounter-BJrjMPSa.js.map +0 -1
- package/dist/dist-B6HruP5v.js +0 -4731
- package/dist/dist-B6HruP5v.js.map +0 -1
- package/dist/exports/adapters/ga4.js.map +0 -1
- package/dist/exports/adapters/native.js.map +0 -1
- package/dist/exports/adapters/plausible.js.map +0 -1
- package/dist/exports/adapters/posthog.js.map +0 -1
- package/dist/exports/client.js.map +0 -1
- package/dist/exports/rsc.js.map +0 -1
- package/dist/fetchJson-DZb2_Puj.js.map +0 -1
- package/dist/index-CZdCT0WJ.d.ts +0 -98
- package/dist/keys-DEqL4LOT.js.map +0 -1
- package/dist/lib-CE5x1zLQ.js +0 -1058
- package/dist/lib-CE5x1zLQ.js.map +0 -1
- package/dist/maxmindResolver-CXYXXdul.js +0 -99
- package/dist/maxmindResolver-CXYXXdul.js.map +0 -1
- package/dist/presets-CBfq_uJX.d.ts +0 -38
- package/dist/series-zytbzPoc.js.map +0 -1
- package/dist/server-Cuvhgz-S.js +0 -492
- package/dist/server-Cuvhgz-S.js.map +0 -1
- package/dist/translations-keiKtSjF.js.map +0 -1
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
import { PROVIDERS_SLUG } from "../providers/collection.js";
|
|
2
|
+
//#region src/core/options.ts
|
|
3
|
+
const DEFAULT_WARM_CRON = "*/30 * * * *";
|
|
4
|
+
const DEFAULT_SYNC_CRON = "0 */6 * * *";
|
|
5
|
+
const DEFAULT_SYNC_COLLECTION = "analytics-daily";
|
|
6
|
+
const DEFAULT_SYNC_LOOKBACK = 3;
|
|
7
|
+
const DEFAULT_SCOPE_FIELD = "scope";
|
|
8
|
+
const resolveBindings = (collections) => {
|
|
9
|
+
const out = {};
|
|
10
|
+
for (const [slug, binding] of Object.entries(collections ?? {})) {
|
|
11
|
+
if (!binding) continue;
|
|
12
|
+
if (!binding.path && !binding.pathField) throw new Error(`analytics: binding for "${slug}" needs a path resolver or a pathField`);
|
|
13
|
+
out[slug] = binding;
|
|
14
|
+
}
|
|
15
|
+
return out;
|
|
16
|
+
};
|
|
17
|
+
function resolveOptions(options) {
|
|
18
|
+
if (!options.adapters || options.adapters.length === 0) throw new Error("analytics: at least one adapter is required");
|
|
19
|
+
if (options.platformAdapter !== void 0 && !options.adapters.some((a) => a.id === options.platformAdapter)) throw new Error(`analytics: unknown platform adapter "${options.platformAdapter}"`);
|
|
20
|
+
const widgets = options.widgets === false ? {
|
|
21
|
+
enabled: false,
|
|
22
|
+
disabled: [],
|
|
23
|
+
register: [],
|
|
24
|
+
localizeText: false,
|
|
25
|
+
comparison: true
|
|
26
|
+
} : options.widgets === void 0 || options.widgets === true ? {
|
|
27
|
+
enabled: true,
|
|
28
|
+
disabled: [],
|
|
29
|
+
register: [],
|
|
30
|
+
localizeText: false,
|
|
31
|
+
comparison: true
|
|
32
|
+
} : {
|
|
33
|
+
enabled: true,
|
|
34
|
+
disabled: options.widgets.disabled ?? [],
|
|
35
|
+
register: options.widgets.register ?? [],
|
|
36
|
+
localizeText: options.widgets.localizeText ?? false,
|
|
37
|
+
comparison: options.widgets.comparison ?? true
|
|
38
|
+
};
|
|
39
|
+
const warmOpt = options.cache?.warm;
|
|
40
|
+
const warm = warmOpt === true ? {
|
|
41
|
+
enabled: true,
|
|
42
|
+
cron: DEFAULT_WARM_CRON
|
|
43
|
+
} : warmOpt && typeof warmOpt === "object" ? {
|
|
44
|
+
enabled: true,
|
|
45
|
+
cron: warmOpt.cron ?? DEFAULT_WARM_CRON
|
|
46
|
+
} : {
|
|
47
|
+
enabled: false,
|
|
48
|
+
cron: DEFAULT_WARM_CRON
|
|
49
|
+
};
|
|
50
|
+
const collectionOpt = options.providers?.collection;
|
|
51
|
+
const providers = {
|
|
52
|
+
collection: collectionOpt === true ? {
|
|
53
|
+
enabled: true,
|
|
54
|
+
slug: PROVIDERS_SLUG,
|
|
55
|
+
scopeField: DEFAULT_SCOPE_FIELD
|
|
56
|
+
} : collectionOpt && typeof collectionOpt === "object" ? {
|
|
57
|
+
enabled: true,
|
|
58
|
+
slug: collectionOpt.slug ?? "analytics-providers",
|
|
59
|
+
scopeField: collectionOpt.scopeField ?? DEFAULT_SCOPE_FIELD,
|
|
60
|
+
overrides: collectionOpt.overrides,
|
|
61
|
+
access: collectionOpt.access
|
|
62
|
+
} : {
|
|
63
|
+
enabled: false,
|
|
64
|
+
slug: PROVIDERS_SLUG,
|
|
65
|
+
scopeField: DEFAULT_SCOPE_FIELD
|
|
66
|
+
},
|
|
67
|
+
resolve: options.providers?.resolve
|
|
68
|
+
};
|
|
69
|
+
const syncOpt = options.sync;
|
|
70
|
+
const sync = syncOpt === true ? {
|
|
71
|
+
enabled: true,
|
|
72
|
+
collectionSlug: DEFAULT_SYNC_COLLECTION,
|
|
73
|
+
cron: DEFAULT_SYNC_CRON,
|
|
74
|
+
lookbackDays: DEFAULT_SYNC_LOOKBACK,
|
|
75
|
+
hidden: true
|
|
76
|
+
} : syncOpt && typeof syncOpt === "object" ? {
|
|
77
|
+
enabled: true,
|
|
78
|
+
collectionSlug: syncOpt.collectionSlug ?? DEFAULT_SYNC_COLLECTION,
|
|
79
|
+
cron: syncOpt.cron ?? DEFAULT_SYNC_CRON,
|
|
80
|
+
lookbackDays: syncOpt.lookbackDays ?? DEFAULT_SYNC_LOOKBACK,
|
|
81
|
+
adapters: syncOpt.adapters,
|
|
82
|
+
hidden: syncOpt.hidden ?? true
|
|
83
|
+
} : {
|
|
84
|
+
enabled: false,
|
|
85
|
+
collectionSlug: DEFAULT_SYNC_COLLECTION,
|
|
86
|
+
cron: DEFAULT_SYNC_CRON,
|
|
87
|
+
lookbackDays: DEFAULT_SYNC_LOOKBACK,
|
|
88
|
+
hidden: true
|
|
89
|
+
};
|
|
90
|
+
return {
|
|
91
|
+
adapters: options.adapters,
|
|
92
|
+
defaultAdapter: options.defaultAdapter,
|
|
93
|
+
scopeResolver: options.scopeResolver ?? (() => null),
|
|
94
|
+
scoped: options.scopeResolver !== void 0,
|
|
95
|
+
reportingTimezone: options.reportingTimezone,
|
|
96
|
+
platformAdapter: options.platformAdapter,
|
|
97
|
+
access: { platformRead: options.access?.platformRead ?? (({ req }) => Boolean(req.user)) },
|
|
98
|
+
providers,
|
|
99
|
+
bindings: resolveBindings(options.collections),
|
|
100
|
+
cache: {
|
|
101
|
+
ttl: {
|
|
102
|
+
aggregate: options.cache?.ttl?.aggregate,
|
|
103
|
+
realtime: options.cache?.ttl?.realtime
|
|
104
|
+
},
|
|
105
|
+
warm
|
|
106
|
+
},
|
|
107
|
+
widgets,
|
|
108
|
+
sync
|
|
109
|
+
};
|
|
110
|
+
}
|
|
111
|
+
//#endregion
|
|
112
|
+
export { resolveOptions };
|
|
113
|
+
|
|
114
|
+
//# sourceMappingURL=options.js.map
|
|
@@ -0,0 +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 * 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"}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
//#region src/core/registry.ts
|
|
2
|
+
/** Wrap a config-time registry as a resolver: every scope sees the same adapters. */
|
|
3
|
+
const staticRegistryResolver = (registry) => () => Promise.resolve(registry);
|
|
4
|
+
function createRegistry(adapters, defaultId) {
|
|
5
|
+
if (adapters.length === 0) throw new Error("analytics: at least one adapter is required");
|
|
6
|
+
const first = adapters[0];
|
|
7
|
+
const byId = new Map(adapters.map((a) => [a.id, a]));
|
|
8
|
+
if (defaultId !== void 0 && !byId.has(defaultId)) throw new Error(`analytics: unknown default adapter "${defaultId}"`);
|
|
9
|
+
const fallback = defaultId ?? first.id;
|
|
10
|
+
return {
|
|
11
|
+
get(id) {
|
|
12
|
+
const a = byId.get(id);
|
|
13
|
+
if (!a) throw new Error(`analytics: unknown adapter "${id}"`);
|
|
14
|
+
return a;
|
|
15
|
+
},
|
|
16
|
+
default: () => byId.get(fallback) ?? first,
|
|
17
|
+
all: () => adapters,
|
|
18
|
+
isMultiProvider: () => adapters.length > 1
|
|
19
|
+
};
|
|
20
|
+
}
|
|
21
|
+
//#endregion
|
|
22
|
+
export { createRegistry, staticRegistryResolver };
|
|
23
|
+
|
|
24
|
+
//# sourceMappingURL=registry.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"registry.js","names":[],"sources":["../../src/core/registry.ts"],"sourcesContent":["import type { Payload, PayloadRequest } from 'payload'\nimport type { AnalyticsAdapter } from './contract'\n\nexport interface AdapterRegistry {\n\tget(id: string): AnalyticsAdapter\n\tdefault(): AnalyticsAdapter\n\tall(): AnalyticsAdapter[]\n\tisMultiProvider(): boolean\n}\n\nexport type ResolveRegistryArgs = {\n\tpayload: Payload\n\treq?: PayloadRequest\n\t/** The analytics boundary to resolve adapters for; null is the whole install. */\n\tscope: string | null\n}\n\n/**\n * The seam every read path resolves its adapters through. The static config\n * registry is the base for all scopes; runtime provider sources (collection,\n * `providers.resolve`) layer per-scope adapters on top of it.\n */\nexport type RegistryResolver = (args: ResolveRegistryArgs) => Promise<AdapterRegistry>\n\n/** Wrap a config-time registry as a resolver: every scope sees the same adapters. */\nexport const staticRegistryResolver =\n\t(registry: AdapterRegistry): RegistryResolver =>\n\t() =>\n\t\tPromise.resolve(registry)\n\nexport function createRegistry(adapters: AnalyticsAdapter[], defaultId?: string): AdapterRegistry {\n\tif (adapters.length === 0) throw new Error('analytics: at least one adapter is required')\n\tconst first = adapters[0] as AnalyticsAdapter\n\tconst byId = new Map(adapters.map((a) => [a.id, a]))\n\tif (defaultId !== undefined && !byId.has(defaultId)) {\n\t\tthrow new Error(`analytics: unknown default adapter \"${defaultId}\"`)\n\t}\n\tconst fallback = defaultId ?? first.id\n\treturn {\n\t\tget(id) {\n\t\t\tconst a = byId.get(id)\n\t\t\tif (!a) throw new Error(`analytics: unknown adapter \"${id}\"`)\n\t\t\treturn a\n\t\t},\n\t\tdefault: () => byId.get(fallback) ?? first,\n\t\tall: () => adapters,\n\t\tisMultiProvider: () => adapters.length > 1,\n\t}\n}\n"],"mappings":";;AAyBA,MAAa,0BACX,mBAEA,QAAQ,QAAQ,QAAQ;AAE1B,SAAgB,eAAe,UAA8B,WAAqC;CACjG,IAAI,SAAS,WAAW,GAAG,MAAM,IAAI,MAAM,6CAA6C;CACxF,MAAM,QAAQ,SAAS;CACvB,MAAM,OAAO,IAAI,IAAI,SAAS,KAAK,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;CACnD,IAAI,cAAc,KAAA,KAAa,CAAC,KAAK,IAAI,SAAS,GACjD,MAAM,IAAI,MAAM,uCAAuC,UAAU,EAAE;CAEpE,MAAM,WAAW,aAAa,MAAM;CACpC,OAAO;EACN,IAAI,IAAI;GACP,MAAM,IAAI,KAAK,IAAI,EAAE;GACrB,IAAI,CAAC,GAAG,MAAM,IAAI,MAAM,+BAA+B,GAAG,EAAE;GAC5D,OAAO;EACR;EACA,eAAe,KAAK,IAAI,QAAQ,KAAK;EACrC,WAAW;EACX,uBAAuB,SAAS,SAAS;CAC1C;AACD"}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import { platformReadFor, resolveRegistryFor, resolveScopeFor } from "../plugin/runtime.js";
|
|
2
|
+
import "./contract.js";
|
|
3
|
+
//#region src/core/scopedRead.ts
|
|
4
|
+
/**
|
|
5
|
+
* Resolve one read's scope and adapter: explicit scope wins over the request's
|
|
6
|
+
* resolved scope, the registry is resolved per scope, then the adapter is picked
|
|
7
|
+
* by id (or the registry default). Cross-scope reads fail closed behind
|
|
8
|
+
* `platformRead`: an explicit `'*'` scope always, and a scoped read through the
|
|
9
|
+
* platform adapter when it cannot narrow the query to one scope. Any resolution
|
|
10
|
+
* failure (unknown adapter id, a throwing scopeResolver or provider lookup)
|
|
11
|
+
* degrades to `{ ok: false }` so read paths render their unavailable state
|
|
12
|
+
* instead of throwing.
|
|
13
|
+
*/
|
|
14
|
+
const resolveReadContext = async (args) => {
|
|
15
|
+
const { runtime, req, adapterId } = args;
|
|
16
|
+
try {
|
|
17
|
+
const scope = args.scope !== void 0 ? args.scope : await resolveScopeFor(runtime, req);
|
|
18
|
+
const registryScope = scope === "*" ? null : scope;
|
|
19
|
+
const registry = await resolveRegistryFor(runtime, {
|
|
20
|
+
payload: req.payload,
|
|
21
|
+
req,
|
|
22
|
+
scope: registryScope
|
|
23
|
+
});
|
|
24
|
+
const adapter = adapterId ? registry.get(adapterId) : registry.default();
|
|
25
|
+
if (scope === "*") {
|
|
26
|
+
if (!await platformReadFor(runtime, req)) return { ok: false };
|
|
27
|
+
return {
|
|
28
|
+
ok: true,
|
|
29
|
+
adapter,
|
|
30
|
+
scope: null,
|
|
31
|
+
queryScope: void 0
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
if (scope !== null && adapter.id === runtime.platformAdapterId && !adapter.capabilities.scopedQueries) {
|
|
35
|
+
if (!await platformReadFor(runtime, req)) return { ok: false };
|
|
36
|
+
return {
|
|
37
|
+
ok: true,
|
|
38
|
+
adapter,
|
|
39
|
+
scope,
|
|
40
|
+
queryScope: void 0
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
return {
|
|
44
|
+
ok: true,
|
|
45
|
+
adapter,
|
|
46
|
+
scope,
|
|
47
|
+
queryScope: scope ?? void 0
|
|
48
|
+
};
|
|
49
|
+
} catch (err) {
|
|
50
|
+
req.payload.logger?.warn(`analytics: read context resolution failed: ${String(err)}`);
|
|
51
|
+
return { ok: false };
|
|
52
|
+
}
|
|
53
|
+
};
|
|
54
|
+
//#endregion
|
|
55
|
+
export { resolveReadContext };
|
|
56
|
+
|
|
57
|
+
//# sourceMappingURL=scopedRead.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"scopedRead.js","names":[],"sources":["../../src/core/scopedRead.ts"],"sourcesContent":["import type { PayloadRequest } from 'payload'\nimport {\n\ttype AnalyticsRuntime,\n\tplatformReadFor,\n\tresolveRegistryFor,\n\tresolveScopeFor,\n} from '../plugin/runtime'\nimport { type AnalyticsAdapter, PLATFORM_SCOPE } from './contract'\n\nexport type ReadContext =\n\t| {\n\t\t\tok: true\n\t\t\tadapter: AnalyticsAdapter\n\t\t\tscope: string | null\n\t\t\t/** The scope to stamp on the adapter query; undefined for install-wide reads. */\n\t\t\tqueryScope?: string\n\t }\n\t| { ok: false }\n\nexport interface ResolveReadContextArgs {\n\truntime: AnalyticsRuntime\n\treq: PayloadRequest\n\tadapterId?: string\n\t/** Explicit scope override; undefined resolves via the plugin's scopeResolver. */\n\tscope?: string | null\n}\n\n/**\n * Resolve one read's scope and adapter: explicit scope wins over the request's\n * resolved scope, the registry is resolved per scope, then the adapter is picked\n * by id (or the registry default). Cross-scope reads fail closed behind\n * `platformRead`: an explicit `'*'` scope always, and a scoped read through the\n * platform adapter when it cannot narrow the query to one scope. Any resolution\n * failure (unknown adapter id, a throwing scopeResolver or provider lookup)\n * degrades to `{ ok: false }` so read paths render their unavailable state\n * instead of throwing.\n */\nexport const resolveReadContext = async (args: ResolveReadContextArgs): Promise<ReadContext> => {\n\tconst { runtime, req, adapterId } = args\n\ttry {\n\t\tconst scope = args.scope !== undefined ? args.scope : await resolveScopeFor(runtime, req)\n\t\tconst registryScope = scope === PLATFORM_SCOPE ? null : scope\n\t\tconst registry = await resolveRegistryFor(runtime, {\n\t\t\tpayload: req.payload,\n\t\t\treq,\n\t\t\tscope: registryScope,\n\t\t})\n\t\tconst adapter = adapterId ? registry.get(adapterId) : registry.default()\n\t\tif (scope === PLATFORM_SCOPE) {\n\t\t\tif (!(await platformReadFor(runtime, req))) {\n\t\t\t\treturn { ok: false }\n\t\t\t}\n\t\t\treturn { ok: true, adapter, scope: null, queryScope: undefined }\n\t\t}\n\t\tif (\n\t\t\tscope !== null &&\n\t\t\tadapter.id === runtime.platformAdapterId &&\n\t\t\t!adapter.capabilities.scopedQueries\n\t\t) {\n\t\t\tif (!(await platformReadFor(runtime, req))) {\n\t\t\t\treturn { ok: false }\n\t\t\t}\n\t\t\treturn { ok: true, adapter, scope, queryScope: undefined }\n\t\t}\n\t\treturn { ok: true, adapter, scope, queryScope: scope ?? undefined }\n\t} catch (err) {\n\t\treq.payload.logger?.warn(`analytics: read context resolution failed: ${String(err)}`)\n\t\treturn { ok: false }\n\t}\n}\n"],"mappings":";;;;;;;;;;;;;AAqCA,MAAa,qBAAqB,OAAO,SAAuD;CAC/F,MAAM,EAAE,SAAS,KAAK,cAAc;CACpC,IAAI;EACH,MAAM,QAAQ,KAAK,UAAU,KAAA,IAAY,KAAK,QAAQ,MAAM,gBAAgB,SAAS,GAAG;EACxF,MAAM,gBAAgB,UAAA,MAA2B,OAAO;EACxD,MAAM,WAAW,MAAM,mBAAmB,SAAS;GAClD,SAAS,IAAI;GACb;GACA,OAAO;EACR,CAAC;EACD,MAAM,UAAU,YAAY,SAAS,IAAI,SAAS,IAAI,SAAS,QAAQ;EACvE,IAAI,UAAA,KAA0B;GAC7B,IAAI,CAAE,MAAM,gBAAgB,SAAS,GAAG,GACvC,OAAO,EAAE,IAAI,MAAM;GAEpB,OAAO;IAAE,IAAI;IAAM;IAAS,OAAO;IAAM,YAAY,KAAA;GAAU;EAChE;EACA,IACC,UAAU,QACV,QAAQ,OAAO,QAAQ,qBACvB,CAAC,QAAQ,aAAa,eACrB;GACD,IAAI,CAAE,MAAM,gBAAgB,SAAS,GAAG,GACvC,OAAO,EAAE,IAAI,MAAM;GAEpB,OAAO;IAAE,IAAI;IAAM;IAAS;IAAO,YAAY,KAAA;GAAU;EAC1D;EACA,OAAO;GAAE,IAAI;GAAM;GAAS;GAAO,YAAY,SAAS,KAAA;EAAU;CACnE,SAAS,KAAK;EACb,IAAI,QAAQ,QAAQ,KAAK,8CAA8C,OAAO,GAAG,GAAG;EACpF,OAAO,EAAE,IAAI,MAAM;CACpB;AACD"}
|
|
@@ -1,20 +1,2 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
//#region src/adapters/ga4/ga4.d.ts
|
|
4
|
-
interface Ga4Config {
|
|
5
|
-
/** GA4 property id (numeric), e.g. '123456789'. */
|
|
6
|
-
propertyId: string;
|
|
7
|
-
/** Service-account credentials. */
|
|
8
|
-
credentials: {
|
|
9
|
-
client_email: string;
|
|
10
|
-
private_key: string;
|
|
11
|
-
};
|
|
12
|
-
/** GCP project id; inferred from the credentials when omitted. */
|
|
13
|
-
projectId?: string;
|
|
14
|
-
/** Maximum days of historical data. Defaults to 425 (GA4's rolling-window limit). Pass null to disable clamping. */
|
|
15
|
-
maxLookbackDays?: number | null;
|
|
16
|
-
}
|
|
17
|
-
declare function ga4(config: Ga4Config): AnalyticsAdapter;
|
|
18
|
-
//#endregion
|
|
19
|
-
export { type Ga4Config, ga4 };
|
|
20
|
-
//# sourceMappingURL=ga4.d.ts.map
|
|
1
|
+
import { Ga4Config, ga4 } from "../../adapters/ga4/ga4.js";
|
|
2
|
+
export { type Ga4Config, ga4 };
|
|
@@ -1,177 +1,2 @@
|
|
|
1
|
-
import {
|
|
2
|
-
//#region src/adapters/ga4/ga4.ts
|
|
3
|
-
const METRIC_MAP = {
|
|
4
|
-
pageviews: "screenPageViews",
|
|
5
|
-
visitors: "totalUsers",
|
|
6
|
-
visits: "sessions",
|
|
7
|
-
sessions: "sessions",
|
|
8
|
-
bounceRate: "bounceRate",
|
|
9
|
-
avgDuration: "averageSessionDuration",
|
|
10
|
-
events: "eventCount",
|
|
11
|
-
conversions: "keyEvents",
|
|
12
|
-
revenue: "totalRevenue"
|
|
13
|
-
};
|
|
14
|
-
const DIMENSION_MAP = {
|
|
15
|
-
page: "pagePath",
|
|
16
|
-
referrer: "pageReferrer",
|
|
17
|
-
source: "sessionSource",
|
|
18
|
-
medium: "sessionMedium",
|
|
19
|
-
campaign: "sessionCampaignName",
|
|
20
|
-
utmSource: "sessionSource",
|
|
21
|
-
utmMedium: "sessionMedium",
|
|
22
|
-
utmCampaign: "sessionCampaignName",
|
|
23
|
-
device: "deviceCategory",
|
|
24
|
-
browser: "browser",
|
|
25
|
-
os: "operatingSystem",
|
|
26
|
-
country: "countryId",
|
|
27
|
-
region: "region",
|
|
28
|
-
city: "city",
|
|
29
|
-
language: "language",
|
|
30
|
-
event: "eventName"
|
|
31
|
-
};
|
|
32
|
-
const ga4Metrics = new Set(Object.keys(METRIC_MAP));
|
|
33
|
-
const ga4Dimensions = new Set(Object.keys(DIMENSION_MAP));
|
|
34
|
-
const toContractValue = (metric, raw) => {
|
|
35
|
-
if (metric === "avgDuration") return Math.round(raw * 1e3);
|
|
36
|
-
if (metric === "bounceRate") return Math.round(raw * 100);
|
|
37
|
-
return raw;
|
|
38
|
-
};
|
|
39
|
-
function ga4(config) {
|
|
40
|
-
const capabilities = {
|
|
41
|
-
perPageQuery: true,
|
|
42
|
-
realtime: false,
|
|
43
|
-
comparison: false,
|
|
44
|
-
minGranularity: "day",
|
|
45
|
-
maxLookbackDays: config.maxLookbackDays !== void 0 ? config.maxLookbackDays : 425,
|
|
46
|
-
metrics: ga4Metrics,
|
|
47
|
-
dimensions: ga4Dimensions,
|
|
48
|
-
batchPageReport: true,
|
|
49
|
-
rateLimit: {
|
|
50
|
-
maxConcurrent: 10,
|
|
51
|
-
quotaModel: "tokens",
|
|
52
|
-
readsCountAsUsage: true
|
|
53
|
-
},
|
|
54
|
-
recommendedTtl: {
|
|
55
|
-
realtime: 300,
|
|
56
|
-
aggregate: 21600
|
|
57
|
-
}
|
|
58
|
-
};
|
|
59
|
-
let clientPromise;
|
|
60
|
-
const getClient = () => {
|
|
61
|
-
if (!clientPromise) clientPromise = (async () => {
|
|
62
|
-
let mod;
|
|
63
|
-
try {
|
|
64
|
-
mod = await import("@google-analytics/data");
|
|
65
|
-
} catch {
|
|
66
|
-
throw new Error("@10x-media/analytics: the GA4 adapter requires the optional peer dependency \"@google-analytics/data\". Install it with: pnpm add @google-analytics/data");
|
|
67
|
-
}
|
|
68
|
-
return new mod.BetaAnalyticsDataClient({
|
|
69
|
-
credentials: config.credentials,
|
|
70
|
-
projectId: config.projectId
|
|
71
|
-
});
|
|
72
|
-
})();
|
|
73
|
-
return clientPromise;
|
|
74
|
-
};
|
|
75
|
-
return {
|
|
76
|
-
id: "ga4",
|
|
77
|
-
label: "Google Analytics 4",
|
|
78
|
-
capabilities,
|
|
79
|
-
isConfigured: () => Boolean(config.propertyId && config.credentials?.client_email && config.credentials?.private_key),
|
|
80
|
-
async query(q, _ctx) {
|
|
81
|
-
const fetchedAt = q.dateRange.end.toISOString();
|
|
82
|
-
const wanted = q.metrics.filter((m) => METRIC_MAP[m]);
|
|
83
|
-
const providerMetrics = [...new Set(wanted.map((m) => METRIC_MAP[m]))];
|
|
84
|
-
const dims = (q.dimensions ?? []).filter((d) => DIMENSION_MAP[d]);
|
|
85
|
-
const providerDims = [...new Set(dims.map((d) => DIMENSION_MAP[d]))];
|
|
86
|
-
const readRow = (row) => {
|
|
87
|
-
const out = {};
|
|
88
|
-
for (const m of wanted) {
|
|
89
|
-
const idx = providerMetrics.indexOf(METRIC_MAP[m]);
|
|
90
|
-
out[m] = toContractValue(m, Number(row.metricValues?.[idx]?.value ?? 0));
|
|
91
|
-
}
|
|
92
|
-
return out;
|
|
93
|
-
};
|
|
94
|
-
const baseRequest = {
|
|
95
|
-
property: `properties/${config.propertyId}`,
|
|
96
|
-
dateRanges: [{
|
|
97
|
-
startDate: q.dateRange.start.toISOString().slice(0, 10),
|
|
98
|
-
endDate: q.dateRange.end.toISOString().slice(0, 10)
|
|
99
|
-
}],
|
|
100
|
-
metrics: providerMetrics.map((name) => ({ name })),
|
|
101
|
-
...q.path ? { dimensionFilter: { filter: {
|
|
102
|
-
fieldName: "pagePath",
|
|
103
|
-
stringFilter: {
|
|
104
|
-
matchType: "EXACT",
|
|
105
|
-
value: q.path
|
|
106
|
-
}
|
|
107
|
-
} } } : {}
|
|
108
|
-
};
|
|
109
|
-
const client = await getClient();
|
|
110
|
-
if (q.granularity === "day" && !dims.length) {
|
|
111
|
-
const [response] = await client.runReport({
|
|
112
|
-
...baseRequest,
|
|
113
|
-
dimensions: [{ name: "date" }],
|
|
114
|
-
metricAggregations: ["TOTAL"],
|
|
115
|
-
orderBys: [{ dimension: { dimensionName: "date" } }]
|
|
116
|
-
});
|
|
117
|
-
const rows = [];
|
|
118
|
-
for (const row of response.rows ?? []) {
|
|
119
|
-
const ymd = row.dimensionValues?.[0]?.value ?? "";
|
|
120
|
-
const ts = dayIso(`${ymd.slice(0, 4)}-${ymd.slice(4, 6)}-${ymd.slice(6, 8)}`);
|
|
121
|
-
if (ts) rows.push({
|
|
122
|
-
timestamp: ts,
|
|
123
|
-
metrics: readRow(row)
|
|
124
|
-
});
|
|
125
|
-
}
|
|
126
|
-
const totalsRow = response.totals?.[0];
|
|
127
|
-
return {
|
|
128
|
-
rows,
|
|
129
|
-
totals: totalsRow ? readRow(totalsRow) : {},
|
|
130
|
-
meta: {
|
|
131
|
-
provider: "ga4",
|
|
132
|
-
fetchedAt
|
|
133
|
-
}
|
|
134
|
-
};
|
|
135
|
-
}
|
|
136
|
-
const [response] = await client.runReport({
|
|
137
|
-
...baseRequest,
|
|
138
|
-
...providerDims.length ? { dimensions: providerDims.map((name) => ({ name })) } : {},
|
|
139
|
-
...q.limit ? { limit: q.limit } : {}
|
|
140
|
-
});
|
|
141
|
-
if (!dims.length) {
|
|
142
|
-
const row = response.rows?.[0];
|
|
143
|
-
const totals = row ? readRow(row) : {};
|
|
144
|
-
return {
|
|
145
|
-
rows: [{ metrics: totals }],
|
|
146
|
-
totals,
|
|
147
|
-
meta: {
|
|
148
|
-
provider: "ga4",
|
|
149
|
-
fetchedAt
|
|
150
|
-
}
|
|
151
|
-
};
|
|
152
|
-
}
|
|
153
|
-
return {
|
|
154
|
-
rows: (response.rows ?? []).map((row) => {
|
|
155
|
-
const dimValues = {};
|
|
156
|
-
for (const d of dims) {
|
|
157
|
-
const idx = providerDims.indexOf(DIMENSION_MAP[d]);
|
|
158
|
-
dimValues[d] = row.dimensionValues?.[idx]?.value ?? "";
|
|
159
|
-
}
|
|
160
|
-
return {
|
|
161
|
-
dimensions: dimValues,
|
|
162
|
-
metrics: readRow(row)
|
|
163
|
-
};
|
|
164
|
-
}),
|
|
165
|
-
totals: void 0,
|
|
166
|
-
meta: {
|
|
167
|
-
provider: "ga4",
|
|
168
|
-
fetchedAt
|
|
169
|
-
}
|
|
170
|
-
};
|
|
171
|
-
}
|
|
172
|
-
};
|
|
173
|
-
}
|
|
174
|
-
//#endregion
|
|
1
|
+
import { ga4 } from "../../adapters/ga4/ga4.js";
|
|
175
2
|
export { ga4 };
|
|
176
|
-
|
|
177
|
-
//# sourceMappingURL=ga4.js.map
|
|
@@ -1,22 +1,2 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
//#region src/native/nativeAdapter.d.ts
|
|
5
|
-
interface NativeOptions {
|
|
6
|
-
geoResolver?: GeoResolver;
|
|
7
|
-
geoDbPath?: string;
|
|
8
|
-
ingestPath?: string;
|
|
9
|
-
retentionDays?: number;
|
|
10
|
-
/** Opt-in in-process write batching. `true` uses defaults (maxSize 50, maxAgeMs 2000). */
|
|
11
|
-
buffer?: boolean | {
|
|
12
|
-
maxSize?: number;
|
|
13
|
-
maxAgeMs?: number;
|
|
14
|
-
};
|
|
15
|
-
}
|
|
16
|
-
type NativeAdapter = AnalyticsAdapter & {
|
|
17
|
-
flush: () => Promise<void>;
|
|
18
|
-
};
|
|
19
|
-
declare function native(options?: NativeOptions): NativeAdapter;
|
|
20
|
-
//#endregion
|
|
21
|
-
export { type NativeOptions, native };
|
|
22
|
-
//# sourceMappingURL=native.d.ts.map
|
|
1
|
+
import { NativeOptions, native } from "../../native/nativeAdapter.js";
|
|
2
|
+
export { type NativeOptions, native };
|