@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,165 @@
|
|
|
1
|
+
import { TIMEFRAME_PRESETS } from "../timeframe/presets.js";
|
|
2
|
+
import { readForWidgetSeries } from "../widgets/readForWidgetSeries.js";
|
|
3
|
+
import { breakdownSpecBySlug } from "../widgets/breakdownTypes.js";
|
|
4
|
+
import { resolveCustomRange } from "../widgets/range.js";
|
|
5
|
+
import { readForWidget } from "../widgets/readForWidget.js";
|
|
6
|
+
import { readForWidgetBreakdown } from "../widgets/readForWidgetBreakdown.js";
|
|
7
|
+
import { WIDGET_METRICS } from "../widgets/types.js";
|
|
8
|
+
//#region src/plugin/warmTask.ts
|
|
9
|
+
const asString = (v) => typeof v === "string" ? v : void 0;
|
|
10
|
+
const asMetric = (v) => typeof v === "string" && WIDGET_METRICS.includes(v) ? v : "pageviews";
|
|
11
|
+
const asTimeframe = (v) => {
|
|
12
|
+
if (v === "custom") return "custom";
|
|
13
|
+
if (typeof v === "string" && TIMEFRAME_PRESETS.includes(v)) return v;
|
|
14
|
+
return "last30days";
|
|
15
|
+
};
|
|
16
|
+
const asLimit = (v) => typeof v === "number" && v > 0 ? v : 5;
|
|
17
|
+
const asRange = (v) => {
|
|
18
|
+
if (!v || typeof v !== "object") return;
|
|
19
|
+
const r = v;
|
|
20
|
+
return {
|
|
21
|
+
from: asString(r.from),
|
|
22
|
+
to: asString(r.to)
|
|
23
|
+
};
|
|
24
|
+
};
|
|
25
|
+
const targetKey = (t) => {
|
|
26
|
+
const range = t.range ? `${t.range.start.toISOString()}:${t.range.end.toISOString()}` : "";
|
|
27
|
+
const dimension = t.kind === "breakdown" ? t.dimension : "";
|
|
28
|
+
const limit = t.kind === "breakdown" ? String(t.limit) : "";
|
|
29
|
+
return `${t.kind}:${t.metric}:${dimension}:${t.timeframe}:${limit}:${t.adapterId ?? ""}:${range}`;
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* Map a dashboard's widget layout to the set of reads that warm its cache. Built-in
|
|
33
|
+
* metric, trend, and breakdown widgets become targets; the realtime widget is skipped
|
|
34
|
+
* (its short-TTL key is kept warm by the live poller) and any other slug is a custom app
|
|
35
|
+
* widget whose read shape the plugin does not know. A `custom` timeframe is kept only when
|
|
36
|
+
* its range resolves (the read takes an explicit range; `timeframe` is then unused).
|
|
37
|
+
* Identical targets are de-duplicated so a repeated widget warms its tuple once.
|
|
38
|
+
*/
|
|
39
|
+
const deriveWarmTargets = (widgets) => {
|
|
40
|
+
const out = [];
|
|
41
|
+
const seen = /* @__PURE__ */ new Set();
|
|
42
|
+
for (const widget of widgets) {
|
|
43
|
+
const slug = widget.widgetSlug;
|
|
44
|
+
if (!slug || slug === "analytics-realtime") continue;
|
|
45
|
+
const data = widget.data ?? {};
|
|
46
|
+
const metric = asMetric(data.metric);
|
|
47
|
+
const adapterId = asString(data.dataSource);
|
|
48
|
+
const timeframeRaw = asTimeframe(data.timeframe);
|
|
49
|
+
let timeframe = "last30days";
|
|
50
|
+
let range;
|
|
51
|
+
if (timeframeRaw === "custom") {
|
|
52
|
+
const resolved = resolveCustomRange("custom", asRange(data.range));
|
|
53
|
+
if (!resolved) continue;
|
|
54
|
+
range = resolved;
|
|
55
|
+
} else timeframe = timeframeRaw;
|
|
56
|
+
let target;
|
|
57
|
+
if (slug === "analytics-metric") target = {
|
|
58
|
+
kind: "metric",
|
|
59
|
+
metric,
|
|
60
|
+
timeframe,
|
|
61
|
+
range,
|
|
62
|
+
adapterId
|
|
63
|
+
};
|
|
64
|
+
else if (slug === "analytics-trend") target = {
|
|
65
|
+
kind: "series",
|
|
66
|
+
metric,
|
|
67
|
+
timeframe,
|
|
68
|
+
range,
|
|
69
|
+
adapterId
|
|
70
|
+
};
|
|
71
|
+
else {
|
|
72
|
+
const spec = breakdownSpecBySlug(slug);
|
|
73
|
+
if (spec) target = {
|
|
74
|
+
kind: "breakdown",
|
|
75
|
+
metric,
|
|
76
|
+
dimension: spec.dimension,
|
|
77
|
+
timeframe,
|
|
78
|
+
limit: asLimit(data.limit),
|
|
79
|
+
range,
|
|
80
|
+
adapterId
|
|
81
|
+
};
|
|
82
|
+
}
|
|
83
|
+
if (!target) continue;
|
|
84
|
+
const key = targetKey(target);
|
|
85
|
+
if (seen.has(key)) continue;
|
|
86
|
+
seen.add(key);
|
|
87
|
+
out.push(target);
|
|
88
|
+
}
|
|
89
|
+
return out;
|
|
90
|
+
};
|
|
91
|
+
const WARM_TASK_SLUG = "analytics-warm-cache";
|
|
92
|
+
const resolveLayout = async (layout, req) => {
|
|
93
|
+
try {
|
|
94
|
+
return (typeof layout === "function" ? await layout({ req }) : layout ?? []).map((w) => ({
|
|
95
|
+
widgetSlug: w.widgetSlug,
|
|
96
|
+
data: w.data
|
|
97
|
+
}));
|
|
98
|
+
} catch (err) {
|
|
99
|
+
req.payload.logger.warn(`analytics warm-cache: could not resolve the dashboard layout: ${String(err)}`);
|
|
100
|
+
return [];
|
|
101
|
+
}
|
|
102
|
+
};
|
|
103
|
+
/** Run one target's read; returns true when the read served data (status `ok`). */
|
|
104
|
+
const runTarget = async (target, req, now) => {
|
|
105
|
+
if (target.kind === "metric") return (await readForWidget({
|
|
106
|
+
req,
|
|
107
|
+
metrics: [target.metric],
|
|
108
|
+
timeframe: target.timeframe,
|
|
109
|
+
adapterId: target.adapterId,
|
|
110
|
+
now,
|
|
111
|
+
range: target.range
|
|
112
|
+
})).status === "ok";
|
|
113
|
+
if (target.kind === "series") return (await readForWidgetSeries({
|
|
114
|
+
req,
|
|
115
|
+
metric: target.metric,
|
|
116
|
+
timeframe: target.timeframe,
|
|
117
|
+
adapterId: target.adapterId,
|
|
118
|
+
now,
|
|
119
|
+
range: target.range
|
|
120
|
+
})).status === "ok";
|
|
121
|
+
return (await readForWidgetBreakdown({
|
|
122
|
+
req,
|
|
123
|
+
metric: target.metric,
|
|
124
|
+
dimension: target.dimension,
|
|
125
|
+
timeframe: target.timeframe,
|
|
126
|
+
limit: target.limit,
|
|
127
|
+
adapterId: target.adapterId,
|
|
128
|
+
now,
|
|
129
|
+
range: target.range
|
|
130
|
+
})).status === "ok";
|
|
131
|
+
};
|
|
132
|
+
/**
|
|
133
|
+
* Opt-in Payload task that pre-runs the dashboard's widget reads through the surfacing
|
|
134
|
+
* engine so `payload.kv` is warm before a user opens the dashboard. Targets are derived
|
|
135
|
+
* from `layout` (the app's `defaultLayout`, captured at registration and resolved here);
|
|
136
|
+
* each read is isolated so one failing provider does not abort the rest. Most valuable
|
|
137
|
+
* for slow or rate-limited provider adapters; native reads are cheap and harmless to warm.
|
|
138
|
+
*/
|
|
139
|
+
const warmTask = (cron, layout) => ({
|
|
140
|
+
slug: WARM_TASK_SLUG,
|
|
141
|
+
handler: async ({ req }) => {
|
|
142
|
+
const targets = deriveWarmTargets(await resolveLayout(layout, req));
|
|
143
|
+
const now = /* @__PURE__ */ new Date();
|
|
144
|
+
let warmed = 0;
|
|
145
|
+
let failed = 0;
|
|
146
|
+
for (const target of targets) try {
|
|
147
|
+
if (await runTarget(target, req, now)) warmed++;
|
|
148
|
+
} catch (err) {
|
|
149
|
+
failed++;
|
|
150
|
+
req.payload.logger.warn(`analytics warm-cache: ${target.kind} read for "${target.metric}" failed: ${String(err)}`);
|
|
151
|
+
}
|
|
152
|
+
return { output: {
|
|
153
|
+
warmed,
|
|
154
|
+
failed
|
|
155
|
+
} };
|
|
156
|
+
},
|
|
157
|
+
schedule: [{
|
|
158
|
+
cron,
|
|
159
|
+
queue: "default"
|
|
160
|
+
}]
|
|
161
|
+
});
|
|
162
|
+
//#endregion
|
|
163
|
+
export { warmTask };
|
|
164
|
+
|
|
165
|
+
//# sourceMappingURL=warmTask.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"warmTask.js","names":[],"sources":["../../src/plugin/warmTask.ts"],"sourcesContent":["import type { PayloadRequest, TaskConfig, WidgetInstance } from 'payload'\nimport type { DateRange, DimensionKey, MetricKey } from '../core/contract'\nimport { TIMEFRAME_PRESETS, type TimeframePreset } from '../timeframe/presets'\nimport { breakdownSpecBySlug } from '../widgets/breakdownTypes'\nimport { resolveCustomRange } from '../widgets/range'\nimport { readForWidget } from '../widgets/readForWidget'\nimport { readForWidgetBreakdown } from '../widgets/readForWidgetBreakdown'\nimport { readForWidgetSeries } from '../widgets/readForWidgetSeries'\nimport { WIDGET_METRICS, type WidgetRange } from '../widgets/types'\n\n/** Minimal shape of a dashboard widget instance the warm job reads. */\nexport interface WarmWidgetInstance {\n\twidgetSlug?: string\n\tdata?: Record<string, unknown>\n}\n\nexport type WarmTarget =\n\t| {\n\t\t\tkind: 'metric'\n\t\t\tmetric: MetricKey\n\t\t\ttimeframe: TimeframePreset\n\t\t\trange?: DateRange\n\t\t\tadapterId?: string\n\t }\n\t| {\n\t\t\tkind: 'series'\n\t\t\tmetric: MetricKey\n\t\t\ttimeframe: TimeframePreset\n\t\t\trange?: DateRange\n\t\t\tadapterId?: string\n\t }\n\t| {\n\t\t\tkind: 'breakdown'\n\t\t\tmetric: MetricKey\n\t\t\tdimension: DimensionKey\n\t\t\ttimeframe: TimeframePreset\n\t\t\tlimit: number\n\t\t\trange?: DateRange\n\t\t\tadapterId?: string\n\t }\n\nconst asString = (v: unknown): string | undefined => (typeof v === 'string' ? v : undefined)\n\nconst asMetric = (v: unknown): MetricKey =>\n\ttypeof v === 'string' && (WIDGET_METRICS as readonly string[]).includes(v)\n\t\t? (v as MetricKey)\n\t\t: 'pageviews'\n\nconst asTimeframe = (v: unknown): TimeframePreset | 'custom' => {\n\tif (v === 'custom') {\n\t\treturn 'custom'\n\t}\n\tif (typeof v === 'string' && (TIMEFRAME_PRESETS as readonly string[]).includes(v)) {\n\t\treturn v as TimeframePreset\n\t}\n\treturn 'last30days'\n}\n\nconst asLimit = (v: unknown): number => (typeof v === 'number' && v > 0 ? v : 5)\n\nconst asRange = (v: unknown): WidgetRange | undefined => {\n\tif (!v || typeof v !== 'object') {\n\t\treturn undefined\n\t}\n\tconst r = v as { from?: unknown; to?: unknown }\n\treturn { from: asString(r.from), to: asString(r.to) }\n}\n\nconst targetKey = (t: WarmTarget): string => {\n\tconst range = t.range ? `${t.range.start.toISOString()}:${t.range.end.toISOString()}` : ''\n\tconst dimension = t.kind === 'breakdown' ? t.dimension : ''\n\tconst limit = t.kind === 'breakdown' ? String(t.limit) : ''\n\treturn `${t.kind}:${t.metric}:${dimension}:${t.timeframe}:${limit}:${t.adapterId ?? ''}:${range}`\n}\n\n/**\n * Map a dashboard's widget layout to the set of reads that warm its cache. Built-in\n * metric, trend, and breakdown widgets become targets; the realtime widget is skipped\n * (its short-TTL key is kept warm by the live poller) and any other slug is a custom app\n * widget whose read shape the plugin does not know. A `custom` timeframe is kept only when\n * its range resolves (the read takes an explicit range; `timeframe` is then unused).\n * Identical targets are de-duplicated so a repeated widget warms its tuple once.\n */\nexport const deriveWarmTargets = (widgets: readonly WarmWidgetInstance[]): WarmTarget[] => {\n\tconst out: WarmTarget[] = []\n\tconst seen = new Set<string>()\n\tfor (const widget of widgets) {\n\t\tconst slug = widget.widgetSlug\n\t\tif (!slug || slug === 'analytics-realtime') {\n\t\t\tcontinue\n\t\t}\n\t\tconst data = widget.data ?? {}\n\t\tconst metric = asMetric(data.metric)\n\t\tconst adapterId = asString(data.dataSource)\n\t\tconst timeframeRaw = asTimeframe(data.timeframe)\n\t\tlet timeframe: TimeframePreset = 'last30days'\n\t\tlet range: DateRange | undefined\n\t\tif (timeframeRaw === 'custom') {\n\t\t\tconst resolved = resolveCustomRange('custom', asRange(data.range))\n\t\t\tif (!resolved) {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\trange = resolved\n\t\t} else {\n\t\t\ttimeframe = timeframeRaw\n\t\t}\n\n\t\tlet target: WarmTarget | undefined\n\t\tif (slug === 'analytics-metric') {\n\t\t\ttarget = { kind: 'metric', metric, timeframe, range, adapterId }\n\t\t} else if (slug === 'analytics-trend') {\n\t\t\ttarget = { kind: 'series', metric, timeframe, range, adapterId }\n\t\t} else {\n\t\t\tconst spec = breakdownSpecBySlug(slug)\n\t\t\tif (spec) {\n\t\t\t\ttarget = {\n\t\t\t\t\tkind: 'breakdown',\n\t\t\t\t\tmetric,\n\t\t\t\t\tdimension: spec.dimension,\n\t\t\t\t\ttimeframe,\n\t\t\t\t\tlimit: asLimit(data.limit),\n\t\t\t\t\trange,\n\t\t\t\t\tadapterId,\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tif (!target) {\n\t\t\tcontinue\n\t\t}\n\t\tconst key = targetKey(target)\n\t\tif (seen.has(key)) {\n\t\t\tcontinue\n\t\t}\n\t\tseen.add(key)\n\t\tout.push(target)\n\t}\n\treturn out\n}\n\nexport const WARM_TASK_SLUG = 'analytics-warm-cache'\n\n/** A dashboard `defaultLayout`: an array, or a function resolving one per request. */\nexport type WarmLayout =\n\t| ((args: { req: PayloadRequest }) => WidgetInstance[] | Promise<WidgetInstance[]>)\n\t| WidgetInstance[]\n\t| undefined\n\nconst resolveLayout = async (\n\tlayout: WarmLayout,\n\treq: PayloadRequest\n): Promise<WarmWidgetInstance[]> => {\n\ttry {\n\t\tconst list = typeof layout === 'function' ? await layout({ req }) : (layout ?? [])\n\t\treturn list.map((w) => ({ widgetSlug: w.widgetSlug, data: w.data }))\n\t} catch (err) {\n\t\treq.payload.logger.warn(\n\t\t\t`analytics warm-cache: could not resolve the dashboard layout: ${String(err)}`\n\t\t)\n\t\treturn []\n\t}\n}\n\n/** Run one target's read; returns true when the read served data (status `ok`). */\nconst runTarget = async (target: WarmTarget, req: PayloadRequest, now: Date): Promise<boolean> => {\n\tif (target.kind === 'metric') {\n\t\tconst result = await readForWidget({\n\t\t\treq,\n\t\t\tmetrics: [target.metric],\n\t\t\ttimeframe: target.timeframe,\n\t\t\tadapterId: target.adapterId,\n\t\t\tnow,\n\t\t\trange: target.range,\n\t\t})\n\t\treturn result.status === 'ok'\n\t}\n\tif (target.kind === 'series') {\n\t\tconst result = await readForWidgetSeries({\n\t\t\treq,\n\t\t\tmetric: target.metric,\n\t\t\ttimeframe: target.timeframe,\n\t\t\tadapterId: target.adapterId,\n\t\t\tnow,\n\t\t\trange: target.range,\n\t\t})\n\t\treturn result.status === 'ok'\n\t}\n\tconst result = await readForWidgetBreakdown({\n\t\treq,\n\t\tmetric: target.metric,\n\t\tdimension: target.dimension,\n\t\ttimeframe: target.timeframe,\n\t\tlimit: target.limit,\n\t\tadapterId: target.adapterId,\n\t\tnow,\n\t\trange: target.range,\n\t})\n\treturn result.status === 'ok'\n}\n\n/**\n * Opt-in Payload task that pre-runs the dashboard's widget reads through the surfacing\n * engine so `payload.kv` is warm before a user opens the dashboard. Targets are derived\n * from `layout` (the app's `defaultLayout`, captured at registration and resolved here);\n * each read is isolated so one failing provider does not abort the rest. Most valuable\n * for slow or rate-limited provider adapters; native reads are cheap and harmless to warm.\n */\nexport const warmTask = (\n\tcron: string,\n\tlayout: WarmLayout\n): TaskConfig<{ input: Record<string, never>; output: { warmed: number; failed: number } }> => ({\n\tslug: WARM_TASK_SLUG,\n\thandler: async ({ req }) => {\n\t\tconst targets = deriveWarmTargets(await resolveLayout(layout, req))\n\t\tconst now = new Date()\n\t\tlet warmed = 0\n\t\tlet failed = 0\n\t\tfor (const target of targets) {\n\t\t\ttry {\n\t\t\t\tif (await runTarget(target, req, now)) {\n\t\t\t\t\twarmed++\n\t\t\t\t}\n\t\t\t} catch (err) {\n\t\t\t\tfailed++\n\t\t\t\treq.payload.logger.warn(\n\t\t\t\t\t`analytics warm-cache: ${target.kind} read for \"${target.metric}\" failed: ${String(err)}`\n\t\t\t\t)\n\t\t\t}\n\t\t}\n\t\treturn { output: { warmed, failed } }\n\t},\n\tschedule: [{ cron, queue: 'default' }],\n})\n"],"mappings":";;;;;;;;AAyCA,MAAM,YAAY,MAAoC,OAAO,MAAM,WAAW,IAAI,KAAA;AAElF,MAAM,YAAY,MACjB,OAAO,MAAM,YAAa,eAAqC,SAAS,CAAC,IACrE,IACD;AAEJ,MAAM,eAAe,MAA2C;CAC/D,IAAI,MAAM,UACT,OAAO;CAER,IAAI,OAAO,MAAM,YAAa,kBAAwC,SAAS,CAAC,GAC/E,OAAO;CAER,OAAO;AACR;AAEA,MAAM,WAAW,MAAwB,OAAO,MAAM,YAAY,IAAI,IAAI,IAAI;AAE9E,MAAM,WAAW,MAAwC;CACxD,IAAI,CAAC,KAAK,OAAO,MAAM,UACtB;CAED,MAAM,IAAI;CACV,OAAO;EAAE,MAAM,SAAS,EAAE,IAAI;EAAG,IAAI,SAAS,EAAE,EAAE;CAAE;AACrD;AAEA,MAAM,aAAa,MAA0B;CAC5C,MAAM,QAAQ,EAAE,QAAQ,GAAG,EAAE,MAAM,MAAM,YAAY,EAAE,GAAG,EAAE,MAAM,IAAI,YAAY,MAAM;CACxF,MAAM,YAAY,EAAE,SAAS,cAAc,EAAE,YAAY;CACzD,MAAM,QAAQ,EAAE,SAAS,cAAc,OAAO,EAAE,KAAK,IAAI;CACzD,OAAO,GAAG,EAAE,KAAK,GAAG,EAAE,OAAO,GAAG,UAAU,GAAG,EAAE,UAAU,GAAG,MAAM,GAAG,EAAE,aAAa,GAAG,GAAG;AAC3F;;;;;;;;;AAUA,MAAa,qBAAqB,YAAyD;CAC1F,MAAM,MAAoB,CAAC;CAC3B,MAAM,uBAAO,IAAI,IAAY;CAC7B,KAAK,MAAM,UAAU,SAAS;EAC7B,MAAM,OAAO,OAAO;EACpB,IAAI,CAAC,QAAQ,SAAS,sBACrB;EAED,MAAM,OAAO,OAAO,QAAQ,CAAC;EAC7B,MAAM,SAAS,SAAS,KAAK,MAAM;EACnC,MAAM,YAAY,SAAS,KAAK,UAAU;EAC1C,MAAM,eAAe,YAAY,KAAK,SAAS;EAC/C,IAAI,YAA6B;EACjC,IAAI;EACJ,IAAI,iBAAiB,UAAU;GAC9B,MAAM,WAAW,mBAAmB,UAAU,QAAQ,KAAK,KAAK,CAAC;GACjE,IAAI,CAAC,UACJ;GAED,QAAQ;EACT,OACC,YAAY;EAGb,IAAI;EACJ,IAAI,SAAS,oBACZ,SAAS;GAAE,MAAM;GAAU;GAAQ;GAAW;GAAO;EAAU;OACzD,IAAI,SAAS,mBACnB,SAAS;GAAE,MAAM;GAAU;GAAQ;GAAW;GAAO;EAAU;OACzD;GACN,MAAM,OAAO,oBAAoB,IAAI;GACrC,IAAI,MACH,SAAS;IACR,MAAM;IACN;IACA,WAAW,KAAK;IAChB;IACA,OAAO,QAAQ,KAAK,KAAK;IACzB;IACA;GACD;EAEF;EACA,IAAI,CAAC,QACJ;EAED,MAAM,MAAM,UAAU,MAAM;EAC5B,IAAI,KAAK,IAAI,GAAG,GACf;EAED,KAAK,IAAI,GAAG;EACZ,IAAI,KAAK,MAAM;CAChB;CACA,OAAO;AACR;AAEA,MAAa,iBAAiB;AAQ9B,MAAM,gBAAgB,OACrB,QACA,QACmC;CACnC,IAAI;EAEH,QADa,OAAO,WAAW,aAAa,MAAM,OAAO,EAAE,IAAI,CAAC,IAAK,UAAU,CAAC,GACpE,KAAK,OAAO;GAAE,YAAY,EAAE;GAAY,MAAM,EAAE;EAAK,EAAE;CACpE,SAAS,KAAK;EACb,IAAI,QAAQ,OAAO,KAClB,iEAAiE,OAAO,GAAG,GAC5E;EACA,OAAO,CAAC;CACT;AACD;;AAGA,MAAM,YAAY,OAAO,QAAoB,KAAqB,QAAgC;CACjG,IAAI,OAAO,SAAS,UASnB,QAAO,MARc,cAAc;EAClC;EACA,SAAS,CAAC,OAAO,MAAM;EACvB,WAAW,OAAO;EAClB,WAAW,OAAO;EAClB;EACA,OAAO,OAAO;CACf,CAAC,GACa,WAAW;CAE1B,IAAI,OAAO,SAAS,UASnB,QAAO,MARc,oBAAoB;EACxC;EACA,QAAQ,OAAO;EACf,WAAW,OAAO;EAClB,WAAW,OAAO;EAClB;EACA,OAAO,OAAO;CACf,CAAC,GACa,WAAW;CAY1B,QAAO,MAVc,uBAAuB;EAC3C;EACA,QAAQ,OAAO;EACf,WAAW,OAAO;EAClB,WAAW,OAAO;EAClB,OAAO,OAAO;EACd,WAAW,OAAO;EAClB;EACA,OAAO,OAAO;CACf,CAAC,GACa,WAAW;AAC1B;;;;;;;;AASA,MAAa,YACZ,MACA,YAC+F;CAC/F,MAAM;CACN,SAAS,OAAO,EAAE,UAAU;EAC3B,MAAM,UAAU,kBAAkB,MAAM,cAAc,QAAQ,GAAG,CAAC;EAClE,MAAM,sBAAM,IAAI,KAAK;EACrB,IAAI,SAAS;EACb,IAAI,SAAS;EACb,KAAK,MAAM,UAAU,SACpB,IAAI;GACH,IAAI,MAAM,UAAU,QAAQ,KAAK,GAAG,GACnC;EAEF,SAAS,KAAK;GACb;GACA,IAAI,QAAQ,OAAO,KAClB,yBAAyB,OAAO,KAAK,aAAa,OAAO,OAAO,YAAY,OAAO,GAAG,GACvF;EACD;EAED,OAAO,EAAE,QAAQ;GAAE;GAAQ;EAAO,EAAE;CACrC;CACA,UAAU,CAAC;EAAE;EAAM,OAAO;CAAU,CAAC;AACtC"}
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
import { keys } from "../translations/keys.js";
|
|
2
|
+
import { labelForKey } from "../translations/server.js";
|
|
3
|
+
import { maskSecret, preserveMaskedSecret } from "./secrets.js";
|
|
4
|
+
//#region src/providers/collection.ts
|
|
5
|
+
const PROVIDERS_SLUG = "analytics-providers";
|
|
6
|
+
const loggedIn = ({ req }) => Boolean(req.user);
|
|
7
|
+
const textField = (name, label, width) => ({
|
|
8
|
+
name,
|
|
9
|
+
type: "text",
|
|
10
|
+
label: labelForKey(label),
|
|
11
|
+
...width ? { admin: { width } } : {}
|
|
12
|
+
});
|
|
13
|
+
const secretField = (name, label, width) => ({
|
|
14
|
+
name,
|
|
15
|
+
type: "text",
|
|
16
|
+
label: labelForKey(label),
|
|
17
|
+
admin: {
|
|
18
|
+
description: labelForKey(keys.providerSecretHelp),
|
|
19
|
+
...width ? { width } : {}
|
|
20
|
+
},
|
|
21
|
+
hooks: {
|
|
22
|
+
beforeChange: [preserveMaskedSecret],
|
|
23
|
+
afterRead: [maskSecret]
|
|
24
|
+
}
|
|
25
|
+
});
|
|
26
|
+
const hostField = () => ({
|
|
27
|
+
name: "host",
|
|
28
|
+
type: "text",
|
|
29
|
+
label: labelForKey(keys.providerFieldHost),
|
|
30
|
+
admin: { description: labelForKey(keys.providerFieldHostHelp) }
|
|
31
|
+
});
|
|
32
|
+
const providerGroup = (provider, label, fields) => ({
|
|
33
|
+
name: provider,
|
|
34
|
+
type: "group",
|
|
35
|
+
label: labelForKey(label),
|
|
36
|
+
admin: { condition: (data) => data?.provider === provider },
|
|
37
|
+
fields
|
|
38
|
+
});
|
|
39
|
+
/**
|
|
40
|
+
* The runtime provider-settings collection: one document per provider (and per scope
|
|
41
|
+
* in scoped installs). Admin-only by default; `access` entries override individual
|
|
42
|
+
* operations and `overrides` reshapes the whole config last, so slugs, labels,
|
|
43
|
+
* fields, and access all stay overridable.
|
|
44
|
+
*/
|
|
45
|
+
const buildProvidersCollection = (args) => {
|
|
46
|
+
const collection = {
|
|
47
|
+
slug: args.slug,
|
|
48
|
+
labels: {
|
|
49
|
+
singular: labelForKey(keys.providersCollectionSingular),
|
|
50
|
+
plural: labelForKey(keys.providersCollectionPlural)
|
|
51
|
+
},
|
|
52
|
+
admin: {
|
|
53
|
+
useAsTitle: "provider",
|
|
54
|
+
defaultColumns: ["provider", "enabled"],
|
|
55
|
+
group: "Analytics"
|
|
56
|
+
},
|
|
57
|
+
access: {
|
|
58
|
+
read: loggedIn,
|
|
59
|
+
create: loggedIn,
|
|
60
|
+
update: loggedIn,
|
|
61
|
+
delete: loggedIn,
|
|
62
|
+
...args.access
|
|
63
|
+
},
|
|
64
|
+
hooks: {
|
|
65
|
+
afterChange: [({ doc }) => {
|
|
66
|
+
args.onChange();
|
|
67
|
+
return doc;
|
|
68
|
+
}],
|
|
69
|
+
afterDelete: [({ doc }) => {
|
|
70
|
+
args.onChange();
|
|
71
|
+
return doc;
|
|
72
|
+
}]
|
|
73
|
+
},
|
|
74
|
+
fields: [
|
|
75
|
+
{
|
|
76
|
+
type: "row",
|
|
77
|
+
fields: [{
|
|
78
|
+
name: "provider",
|
|
79
|
+
type: "select",
|
|
80
|
+
required: true,
|
|
81
|
+
label: labelForKey(keys.providerFieldProvider),
|
|
82
|
+
options: [
|
|
83
|
+
{
|
|
84
|
+
label: labelForKey(keys.providerNamePlausible),
|
|
85
|
+
value: "plausible"
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
label: labelForKey(keys.providerNameUmami),
|
|
89
|
+
value: "umami"
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
label: labelForKey(keys.providerNameGa4),
|
|
93
|
+
value: "ga4"
|
|
94
|
+
},
|
|
95
|
+
{
|
|
96
|
+
label: labelForKey(keys.providerNamePosthog),
|
|
97
|
+
value: "posthog"
|
|
98
|
+
}
|
|
99
|
+
],
|
|
100
|
+
admin: { width: "50%" }
|
|
101
|
+
}, {
|
|
102
|
+
name: "enabled",
|
|
103
|
+
type: "checkbox",
|
|
104
|
+
defaultValue: true,
|
|
105
|
+
label: labelForKey(keys.providerFieldEnabled),
|
|
106
|
+
admin: {
|
|
107
|
+
width: "50%",
|
|
108
|
+
style: { alignSelf: "flex-end" }
|
|
109
|
+
}
|
|
110
|
+
}]
|
|
111
|
+
},
|
|
112
|
+
{
|
|
113
|
+
name: "scope",
|
|
114
|
+
type: "text",
|
|
115
|
+
index: true,
|
|
116
|
+
label: labelForKey(keys.providerFieldScope),
|
|
117
|
+
admin: { hidden: true }
|
|
118
|
+
},
|
|
119
|
+
providerGroup("plausible", keys.providerNamePlausible, [{
|
|
120
|
+
type: "row",
|
|
121
|
+
fields: [textField("siteId", keys.providerFieldSiteId, "50%"), secretField("apiKey", keys.providerFieldApiKey, "50%")]
|
|
122
|
+
}, hostField()]),
|
|
123
|
+
providerGroup("umami", keys.providerNameUmami, [
|
|
124
|
+
{
|
|
125
|
+
type: "row",
|
|
126
|
+
fields: [textField("websiteId", keys.providerFieldWebsiteId, "50%"), secretField("apiKey", keys.providerFieldApiKey, "50%")]
|
|
127
|
+
},
|
|
128
|
+
secretField("token", keys.providerFieldToken),
|
|
129
|
+
hostField()
|
|
130
|
+
]),
|
|
131
|
+
providerGroup("ga4", keys.providerNameGa4, [
|
|
132
|
+
{
|
|
133
|
+
type: "row",
|
|
134
|
+
fields: [textField("propertyId", keys.providerFieldPropertyId, "50%"), textField("projectId", keys.providerFieldProjectId, "50%")]
|
|
135
|
+
},
|
|
136
|
+
textField("clientEmail", keys.providerFieldClientEmail),
|
|
137
|
+
{
|
|
138
|
+
name: "privateKey",
|
|
139
|
+
type: "textarea",
|
|
140
|
+
label: labelForKey(keys.providerFieldPrivateKey),
|
|
141
|
+
admin: { description: labelForKey(keys.providerSecretHelp) },
|
|
142
|
+
hooks: {
|
|
143
|
+
beforeChange: [preserveMaskedSecret],
|
|
144
|
+
afterRead: [maskSecret]
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
]),
|
|
148
|
+
providerGroup("posthog", keys.providerNamePosthog, [{
|
|
149
|
+
type: "row",
|
|
150
|
+
fields: [textField("projectId", keys.providerFieldProjectId, "50%"), secretField("apiKey", keys.providerFieldApiKey, "50%")]
|
|
151
|
+
}, hostField()])
|
|
152
|
+
]
|
|
153
|
+
};
|
|
154
|
+
return args.overrides ? args.overrides(collection) : collection;
|
|
155
|
+
};
|
|
156
|
+
//#endregion
|
|
157
|
+
export { PROVIDERS_SLUG, buildProvidersCollection };
|
|
158
|
+
|
|
159
|
+
//# sourceMappingURL=collection.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"collection.js","names":[],"sources":["../../src/providers/collection.ts"],"sourcesContent":["import type { CollectionConfig, Field } from 'payload'\nimport { keys, type TranslationKey } from '../translations/keys'\nimport { labelForKey } from '../translations/server'\nimport type { ProviderId } from './factory'\nimport { maskSecret, preserveMaskedSecret } from './secrets'\n\nexport const PROVIDERS_SLUG = 'analytics-providers'\n\nexport interface BuildProvidersCollectionArgs {\n\tslug: string\n\taccess?: Partial<CollectionConfig['access']>\n\toverrides?: (collection: CollectionConfig) => CollectionConfig\n\t/** Called after any change or delete so the per-scope registry cache drops stale adapters. */\n\tonChange: () => void\n}\n\nconst loggedIn = ({ req }: { req: { user?: unknown } }) => Boolean(req.user)\n\nconst textField = (name: string, label: TranslationKey, width?: string): Field => ({\n\tname,\n\ttype: 'text',\n\tlabel: labelForKey(label),\n\t...(width ? { admin: { width } } : {}),\n})\n\nconst secretField = (name: string, label: TranslationKey, width?: string): Field => ({\n\tname,\n\ttype: 'text',\n\tlabel: labelForKey(label),\n\tadmin: { description: labelForKey(keys.providerSecretHelp), ...(width ? { width } : {}) },\n\thooks: { beforeChange: [preserveMaskedSecret], afterRead: [maskSecret] },\n})\n\nconst hostField = (): Field => ({\n\tname: 'host',\n\ttype: 'text',\n\tlabel: labelForKey(keys.providerFieldHost),\n\tadmin: { description: labelForKey(keys.providerFieldHostHelp) },\n})\n\nconst providerGroup = (provider: ProviderId, label: TranslationKey, fields: Field[]): Field => ({\n\tname: provider,\n\ttype: 'group',\n\tlabel: labelForKey(label),\n\tadmin: { condition: (data) => data?.provider === provider },\n\tfields,\n})\n\n/**\n * The runtime provider-settings collection: one document per provider (and per scope\n * in scoped installs). Admin-only by default; `access` entries override individual\n * operations and `overrides` reshapes the whole config last, so slugs, labels,\n * fields, and access all stay overridable.\n */\nexport const buildProvidersCollection = (args: BuildProvidersCollectionArgs): CollectionConfig => {\n\tconst collection: CollectionConfig = {\n\t\tslug: args.slug,\n\t\tlabels: {\n\t\t\tsingular: labelForKey(keys.providersCollectionSingular),\n\t\t\tplural: labelForKey(keys.providersCollectionPlural),\n\t\t},\n\t\tadmin: {\n\t\t\tuseAsTitle: 'provider',\n\t\t\tdefaultColumns: ['provider', 'enabled'],\n\t\t\tgroup: 'Analytics',\n\t\t},\n\t\taccess: {\n\t\t\tread: loggedIn,\n\t\t\tcreate: loggedIn,\n\t\t\tupdate: loggedIn,\n\t\t\tdelete: loggedIn,\n\t\t\t...args.access,\n\t\t},\n\t\thooks: {\n\t\t\tafterChange: [\n\t\t\t\t({ doc }) => {\n\t\t\t\t\targs.onChange()\n\t\t\t\t\treturn doc\n\t\t\t\t},\n\t\t\t],\n\t\t\tafterDelete: [\n\t\t\t\t({ doc }) => {\n\t\t\t\t\targs.onChange()\n\t\t\t\t\treturn doc\n\t\t\t\t},\n\t\t\t],\n\t\t},\n\t\tfields: [\n\t\t\t{\n\t\t\t\ttype: 'row',\n\t\t\t\tfields: [\n\t\t\t\t\t{\n\t\t\t\t\t\tname: 'provider',\n\t\t\t\t\t\ttype: 'select',\n\t\t\t\t\t\trequired: true,\n\t\t\t\t\t\tlabel: labelForKey(keys.providerFieldProvider),\n\t\t\t\t\t\toptions: [\n\t\t\t\t\t\t\t{ label: labelForKey(keys.providerNamePlausible), value: 'plausible' },\n\t\t\t\t\t\t\t{ label: labelForKey(keys.providerNameUmami), value: 'umami' },\n\t\t\t\t\t\t\t{ label: labelForKey(keys.providerNameGa4), value: 'ga4' },\n\t\t\t\t\t\t\t{ label: labelForKey(keys.providerNamePosthog), value: 'posthog' },\n\t\t\t\t\t\t],\n\t\t\t\t\t\tadmin: { width: '50%' },\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\tname: 'enabled',\n\t\t\t\t\t\ttype: 'checkbox',\n\t\t\t\t\t\tdefaultValue: true,\n\t\t\t\t\t\tlabel: labelForKey(keys.providerFieldEnabled),\n\t\t\t\t\t\tadmin: { width: '50%', style: { alignSelf: 'flex-end' } },\n\t\t\t\t\t},\n\t\t\t\t],\n\t\t\t},\n\t\t\t{\n\t\t\t\t// Written by scoped setups (or a tenant plugin's own field via `scopeField`);\n\t\t\t\t// hidden because single-site installs never touch it.\n\t\t\t\tname: 'scope',\n\t\t\t\ttype: 'text',\n\t\t\t\tindex: true,\n\t\t\t\tlabel: labelForKey(keys.providerFieldScope),\n\t\t\t\tadmin: { hidden: true },\n\t\t\t},\n\t\t\tproviderGroup('plausible', keys.providerNamePlausible, [\n\t\t\t\t{\n\t\t\t\t\ttype: 'row',\n\t\t\t\t\tfields: [\n\t\t\t\t\t\ttextField('siteId', keys.providerFieldSiteId, '50%'),\n\t\t\t\t\t\tsecretField('apiKey', keys.providerFieldApiKey, '50%'),\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t\thostField(),\n\t\t\t]),\n\t\t\tproviderGroup('umami', keys.providerNameUmami, [\n\t\t\t\t{\n\t\t\t\t\ttype: 'row',\n\t\t\t\t\tfields: [\n\t\t\t\t\t\ttextField('websiteId', keys.providerFieldWebsiteId, '50%'),\n\t\t\t\t\t\tsecretField('apiKey', keys.providerFieldApiKey, '50%'),\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t\tsecretField('token', keys.providerFieldToken),\n\t\t\t\thostField(),\n\t\t\t]),\n\t\t\tproviderGroup('ga4', keys.providerNameGa4, [\n\t\t\t\t{\n\t\t\t\t\ttype: 'row',\n\t\t\t\t\tfields: [\n\t\t\t\t\t\ttextField('propertyId', keys.providerFieldPropertyId, '50%'),\n\t\t\t\t\t\ttextField('projectId', keys.providerFieldProjectId, '50%'),\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t\ttextField('clientEmail', keys.providerFieldClientEmail),\n\t\t\t\t{\n\t\t\t\t\tname: 'privateKey',\n\t\t\t\t\ttype: 'textarea',\n\t\t\t\t\tlabel: labelForKey(keys.providerFieldPrivateKey),\n\t\t\t\t\tadmin: { description: labelForKey(keys.providerSecretHelp) },\n\t\t\t\t\thooks: { beforeChange: [preserveMaskedSecret], afterRead: [maskSecret] },\n\t\t\t\t},\n\t\t\t]),\n\t\t\tproviderGroup('posthog', keys.providerNamePosthog, [\n\t\t\t\t{\n\t\t\t\t\ttype: 'row',\n\t\t\t\t\tfields: [\n\t\t\t\t\t\ttextField('projectId', keys.providerFieldProjectId, '50%'),\n\t\t\t\t\t\tsecretField('apiKey', keys.providerFieldApiKey, '50%'),\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t\thostField(),\n\t\t\t]),\n\t\t],\n\t}\n\treturn args.overrides ? args.overrides(collection) : collection\n}\n"],"mappings":";;;;AAMA,MAAa,iBAAiB;AAU9B,MAAM,YAAY,EAAE,UAAuC,QAAQ,IAAI,IAAI;AAE3E,MAAM,aAAa,MAAc,OAAuB,WAA2B;CAClF;CACA,MAAM;CACN,OAAO,YAAY,KAAK;CACxB,GAAI,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC;AACrC;AAEA,MAAM,eAAe,MAAc,OAAuB,WAA2B;CACpF;CACA,MAAM;CACN,OAAO,YAAY,KAAK;CACxB,OAAO;EAAE,aAAa,YAAY,KAAK,kBAAkB;EAAG,GAAI,QAAQ,EAAE,MAAM,IAAI,CAAC;CAAG;CACxF,OAAO;EAAE,cAAc,CAAC,oBAAoB;EAAG,WAAW,CAAC,UAAU;CAAE;AACxE;AAEA,MAAM,mBAA0B;CAC/B,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,iBAAiB;CACzC,OAAO,EAAE,aAAa,YAAY,KAAK,qBAAqB,EAAE;AAC/D;AAEA,MAAM,iBAAiB,UAAsB,OAAuB,YAA4B;CAC/F,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK;CACxB,OAAO,EAAE,YAAY,SAAS,MAAM,aAAa,SAAS;CAC1D;AACD;;;;;;;AAQA,MAAa,4BAA4B,SAAyD;CACjG,MAAM,aAA+B;EACpC,MAAM,KAAK;EACX,QAAQ;GACP,UAAU,YAAY,KAAK,2BAA2B;GACtD,QAAQ,YAAY,KAAK,yBAAyB;EACnD;EACA,OAAO;GACN,YAAY;GACZ,gBAAgB,CAAC,YAAY,SAAS;GACtC,OAAO;EACR;EACA,QAAQ;GACP,MAAM;GACN,QAAQ;GACR,QAAQ;GACR,QAAQ;GACR,GAAG,KAAK;EACT;EACA,OAAO;GACN,aAAa,EACX,EAAE,UAAU;IACZ,KAAK,SAAS;IACd,OAAO;GACR,CACD;GACA,aAAa,EACX,EAAE,UAAU;IACZ,KAAK,SAAS;IACd,OAAO;GACR,CACD;EACD;EACA,QAAQ;GACP;IACC,MAAM;IACN,QAAQ,CACP;KACC,MAAM;KACN,MAAM;KACN,UAAU;KACV,OAAO,YAAY,KAAK,qBAAqB;KAC7C,SAAS;MACR;OAAE,OAAO,YAAY,KAAK,qBAAqB;OAAG,OAAO;MAAY;MACrE;OAAE,OAAO,YAAY,KAAK,iBAAiB;OAAG,OAAO;MAAQ;MAC7D;OAAE,OAAO,YAAY,KAAK,eAAe;OAAG,OAAO;MAAM;MACzD;OAAE,OAAO,YAAY,KAAK,mBAAmB;OAAG,OAAO;MAAU;KAClE;KACA,OAAO,EAAE,OAAO,MAAM;IACvB,GACA;KACC,MAAM;KACN,MAAM;KACN,cAAc;KACd,OAAO,YAAY,KAAK,oBAAoB;KAC5C,OAAO;MAAE,OAAO;MAAO,OAAO,EAAE,WAAW,WAAW;KAAE;IACzD,CACD;GACD;GACA;IAGC,MAAM;IACN,MAAM;IACN,OAAO;IACP,OAAO,YAAY,KAAK,kBAAkB;IAC1C,OAAO,EAAE,QAAQ,KAAK;GACvB;GACA,cAAc,aAAa,KAAK,uBAAuB,CACtD;IACC,MAAM;IACN,QAAQ,CACP,UAAU,UAAU,KAAK,qBAAqB,KAAK,GACnD,YAAY,UAAU,KAAK,qBAAqB,KAAK,CACtD;GACD,GACA,UAAU,CACX,CAAC;GACD,cAAc,SAAS,KAAK,mBAAmB;IAC9C;KACC,MAAM;KACN,QAAQ,CACP,UAAU,aAAa,KAAK,wBAAwB,KAAK,GACzD,YAAY,UAAU,KAAK,qBAAqB,KAAK,CACtD;IACD;IACA,YAAY,SAAS,KAAK,kBAAkB;IAC5C,UAAU;GACX,CAAC;GACD,cAAc,OAAO,KAAK,iBAAiB;IAC1C;KACC,MAAM;KACN,QAAQ,CACP,UAAU,cAAc,KAAK,yBAAyB,KAAK,GAC3D,UAAU,aAAa,KAAK,wBAAwB,KAAK,CAC1D;IACD;IACA,UAAU,eAAe,KAAK,wBAAwB;IACtD;KACC,MAAM;KACN,MAAM;KACN,OAAO,YAAY,KAAK,uBAAuB;KAC/C,OAAO,EAAE,aAAa,YAAY,KAAK,kBAAkB,EAAE;KAC3D,OAAO;MAAE,cAAc,CAAC,oBAAoB;MAAG,WAAW,CAAC,UAAU;KAAE;IACxE;GACD,CAAC;GACD,cAAc,WAAW,KAAK,qBAAqB,CAClD;IACC,MAAM;IACN,QAAQ,CACP,UAAU,aAAa,KAAK,wBAAwB,KAAK,GACzD,YAAY,UAAU,KAAK,qBAAqB,KAAK,CACtD;GACD,GACA,UAAU,CACX,CAAC;EACF;CACD;CACA,OAAO,KAAK,YAAY,KAAK,UAAU,UAAU,IAAI;AACtD"}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import { ga4 } from "../adapters/ga4/ga4.js";
|
|
2
|
+
import { plausible } from "../adapters/plausible/plausible.js";
|
|
3
|
+
import { posthog } from "../adapters/posthog/posthog.js";
|
|
4
|
+
import { umami } from "../adapters/umami/umami.js";
|
|
5
|
+
//#region src/providers/factory.ts
|
|
6
|
+
const orUndefined = (value) => value || void 0;
|
|
7
|
+
/**
|
|
8
|
+
* Keys pasted from a service-account JSON often carry escaped newlines; the gRPC
|
|
9
|
+
* client needs real ones.
|
|
10
|
+
*/
|
|
11
|
+
const normalizePrivateKey = (key) => key.replace(/\\n/g, "\n");
|
|
12
|
+
/**
|
|
13
|
+
* Build an adapter instance from a provider-settings document using the same
|
|
14
|
+
* constructors as config-time adapters. Missing credentials are passed through as
|
|
15
|
+
* empty strings so the adapter reports `isConfigured() === false` instead of the
|
|
16
|
+
* factory throwing; an unknown provider value returns null and is skipped.
|
|
17
|
+
*/
|
|
18
|
+
const adapterFromProviderDoc = (doc) => {
|
|
19
|
+
switch (doc.provider) {
|
|
20
|
+
case "plausible": {
|
|
21
|
+
const cfg = doc.plausible ?? {};
|
|
22
|
+
return plausible({
|
|
23
|
+
siteId: cfg.siteId ?? "",
|
|
24
|
+
apiKey: cfg.apiKey ?? "",
|
|
25
|
+
host: orUndefined(cfg.host)
|
|
26
|
+
});
|
|
27
|
+
}
|
|
28
|
+
case "umami": {
|
|
29
|
+
const cfg = doc.umami ?? {};
|
|
30
|
+
return umami({
|
|
31
|
+
websiteId: cfg.websiteId ?? "",
|
|
32
|
+
apiKey: orUndefined(cfg.apiKey),
|
|
33
|
+
token: orUndefined(cfg.token),
|
|
34
|
+
host: orUndefined(cfg.host)
|
|
35
|
+
});
|
|
36
|
+
}
|
|
37
|
+
case "ga4": {
|
|
38
|
+
const cfg = doc.ga4 ?? {};
|
|
39
|
+
return ga4({
|
|
40
|
+
propertyId: cfg.propertyId ?? "",
|
|
41
|
+
credentials: {
|
|
42
|
+
client_email: cfg.clientEmail ?? "",
|
|
43
|
+
private_key: normalizePrivateKey(cfg.privateKey ?? "")
|
|
44
|
+
},
|
|
45
|
+
projectId: orUndefined(cfg.projectId)
|
|
46
|
+
});
|
|
47
|
+
}
|
|
48
|
+
case "posthog": {
|
|
49
|
+
const cfg = doc.posthog ?? {};
|
|
50
|
+
return posthog({
|
|
51
|
+
projectId: cfg.projectId ?? "",
|
|
52
|
+
apiKey: cfg.apiKey ?? "",
|
|
53
|
+
host: orUndefined(cfg.host)
|
|
54
|
+
});
|
|
55
|
+
}
|
|
56
|
+
default: return null;
|
|
57
|
+
}
|
|
58
|
+
};
|
|
59
|
+
//#endregion
|
|
60
|
+
export { adapterFromProviderDoc };
|
|
61
|
+
|
|
62
|
+
//# sourceMappingURL=factory.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"factory.js","names":[],"sources":["../../src/providers/factory.ts"],"sourcesContent":["import { ga4 } from '../adapters/ga4/ga4'\nimport { plausible } from '../adapters/plausible/plausible'\nimport { posthog } from '../adapters/posthog/posthog'\nimport { umami } from '../adapters/umami/umami'\nimport type { AnalyticsAdapter } from '../core/contract'\n\nexport const PROVIDER_IDS = ['plausible', 'umami', 'ga4', 'posthog'] as const\nexport type ProviderId = (typeof PROVIDER_IDS)[number]\n\n/** The provider-settings document shape the adapter factory reads (depth 0, secrets revealed). */\nexport type ProviderDoc = {\n\tprovider?: string | null\n\tenabled?: boolean | null\n\tscope?: string | null\n\tplausible?: { siteId?: string | null; apiKey?: string | null; host?: string | null } | null\n\tumami?: {\n\t\twebsiteId?: string | null\n\t\tapiKey?: string | null\n\t\ttoken?: string | null\n\t\thost?: string | null\n\t} | null\n\tga4?: {\n\t\tpropertyId?: string | null\n\t\tclientEmail?: string | null\n\t\tprivateKey?: string | null\n\t\tprojectId?: string | null\n\t} | null\n\tposthog?: { projectId?: string | null; apiKey?: string | null; host?: string | null } | null\n}\n\nconst orUndefined = (value: string | null | undefined): string | undefined => value || undefined\n\n/**\n * Keys pasted from a service-account JSON often carry escaped newlines; the gRPC\n * client needs real ones.\n */\nexport const normalizePrivateKey = (key: string): string => key.replace(/\\\\n/g, '\\n')\n\n/**\n * Build an adapter instance from a provider-settings document using the same\n * constructors as config-time adapters. Missing credentials are passed through as\n * empty strings so the adapter reports `isConfigured() === false` instead of the\n * factory throwing; an unknown provider value returns null and is skipped.\n */\nexport const adapterFromProviderDoc = (doc: ProviderDoc): AnalyticsAdapter | null => {\n\tswitch (doc.provider) {\n\t\tcase 'plausible': {\n\t\t\tconst cfg = doc.plausible ?? {}\n\t\t\treturn plausible({\n\t\t\t\tsiteId: cfg.siteId ?? '',\n\t\t\t\tapiKey: cfg.apiKey ?? '',\n\t\t\t\thost: orUndefined(cfg.host),\n\t\t\t})\n\t\t}\n\t\tcase 'umami': {\n\t\t\tconst cfg = doc.umami ?? {}\n\t\t\treturn umami({\n\t\t\t\twebsiteId: cfg.websiteId ?? '',\n\t\t\t\tapiKey: orUndefined(cfg.apiKey),\n\t\t\t\ttoken: orUndefined(cfg.token),\n\t\t\t\thost: orUndefined(cfg.host),\n\t\t\t})\n\t\t}\n\t\tcase 'ga4': {\n\t\t\tconst cfg = doc.ga4 ?? {}\n\t\t\treturn ga4({\n\t\t\t\tpropertyId: cfg.propertyId ?? '',\n\t\t\t\tcredentials: {\n\t\t\t\t\tclient_email: cfg.clientEmail ?? '',\n\t\t\t\t\tprivate_key: normalizePrivateKey(cfg.privateKey ?? ''),\n\t\t\t\t},\n\t\t\t\tprojectId: orUndefined(cfg.projectId),\n\t\t\t})\n\t\t}\n\t\tcase 'posthog': {\n\t\t\tconst cfg = doc.posthog ?? {}\n\t\t\treturn posthog({\n\t\t\t\tprojectId: cfg.projectId ?? '',\n\t\t\t\tapiKey: cfg.apiKey ?? '',\n\t\t\t\thost: orUndefined(cfg.host),\n\t\t\t})\n\t\t}\n\t\tdefault:\n\t\t\treturn null\n\t}\n}\n"],"mappings":";;;;;AA8BA,MAAM,eAAe,UAAyD,SAAS,KAAA;;;;;AAMvF,MAAa,uBAAuB,QAAwB,IAAI,QAAQ,QAAQ,IAAI;;;;;;;AAQpF,MAAa,0BAA0B,QAA8C;CACpF,QAAQ,IAAI,UAAZ;EACC,KAAK,aAAa;GACjB,MAAM,MAAM,IAAI,aAAa,CAAC;GAC9B,OAAO,UAAU;IAChB,QAAQ,IAAI,UAAU;IACtB,QAAQ,IAAI,UAAU;IACtB,MAAM,YAAY,IAAI,IAAI;GAC3B,CAAC;EACF;EACA,KAAK,SAAS;GACb,MAAM,MAAM,IAAI,SAAS,CAAC;GAC1B,OAAO,MAAM;IACZ,WAAW,IAAI,aAAa;IAC5B,QAAQ,YAAY,IAAI,MAAM;IAC9B,OAAO,YAAY,IAAI,KAAK;IAC5B,MAAM,YAAY,IAAI,IAAI;GAC3B,CAAC;EACF;EACA,KAAK,OAAO;GACX,MAAM,MAAM,IAAI,OAAO,CAAC;GACxB,OAAO,IAAI;IACV,YAAY,IAAI,cAAc;IAC9B,aAAa;KACZ,cAAc,IAAI,eAAe;KACjC,aAAa,oBAAoB,IAAI,cAAc,EAAE;IACtD;IACA,WAAW,YAAY,IAAI,SAAS;GACrC,CAAC;EACF;EACA,KAAK,WAAW;GACf,MAAM,MAAM,IAAI,WAAW,CAAC;GAC5B,OAAO,QAAQ;IACd,WAAW,IAAI,aAAa;IAC5B,QAAQ,IAAI,UAAU;IACtB,MAAM,YAAY,IAAI,IAAI;GAC3B,CAAC;EACF;EACA,SACC,OAAO;CACT;AACD"}
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import { PROVIDER_SECRET_REVEAL_CONTEXT } from "./secrets.js";
|
|
2
|
+
import { createRegistry } from "../core/registry.js";
|
|
3
|
+
import { adapterFromProviderDoc } from "./factory.js";
|
|
4
|
+
/**
|
|
5
|
+
* Overlay runtime adapters onto the static base: a runtime adapter sharing a base
|
|
6
|
+
* adapter's id replaces it in place (the scope's own configuration wins, including
|
|
7
|
+
* for the default), new ids append after the base.
|
|
8
|
+
*/
|
|
9
|
+
const combineRegistries = (base, extra) => {
|
|
10
|
+
if (extra.length === 0) return createRegistry(base.adapters, base.defaultId);
|
|
11
|
+
const byId = new Map(extra.map((a) => [a.id, a]));
|
|
12
|
+
const merged = base.adapters.map((a) => byId.get(a.id) ?? a);
|
|
13
|
+
const seen = new Set(merged.map((a) => a.id));
|
|
14
|
+
for (const adapter of extra) if (!seen.has(adapter.id)) {
|
|
15
|
+
merged.push(adapter);
|
|
16
|
+
seen.add(adapter.id);
|
|
17
|
+
}
|
|
18
|
+
return createRegistry(merged, base.defaultId);
|
|
19
|
+
};
|
|
20
|
+
/**
|
|
21
|
+
* Look up a scope's enabled provider documents and build adapters from them.
|
|
22
|
+
* Reads with `overrideAccess` plus the secret-reveal context (the masking hook
|
|
23
|
+
* runs regardless of access), depth 0, straight through the local API.
|
|
24
|
+
*/
|
|
25
|
+
const collectionProvidersSource = (slug, scopeField) => {
|
|
26
|
+
return async ({ payload, scope }) => {
|
|
27
|
+
const scopeWhere = scope === null ? { or: [{ [scopeField]: { equals: null } }, { [scopeField]: { equals: "" } }] } : { [scopeField]: { equals: scope } };
|
|
28
|
+
const { docs } = await payload.find({
|
|
29
|
+
collection: slug,
|
|
30
|
+
where: { and: [{ enabled: { equals: true } }, scopeWhere] },
|
|
31
|
+
limit: 100,
|
|
32
|
+
pagination: false,
|
|
33
|
+
depth: 0,
|
|
34
|
+
overrideAccess: true,
|
|
35
|
+
context: { [PROVIDER_SECRET_REVEAL_CONTEXT]: true }
|
|
36
|
+
});
|
|
37
|
+
return docs.map(adapterFromProviderDoc).filter((a) => a !== null);
|
|
38
|
+
};
|
|
39
|
+
};
|
|
40
|
+
/**
|
|
41
|
+
* Cache resolved registries per scope for a short TTL so widget-heavy dashboards
|
|
42
|
+
* do not re-query the provider collection on every read. Invalidation clears all
|
|
43
|
+
* scopes at once: a document's scope binding can itself change, so per-scope
|
|
44
|
+
* eviction could leave a stale entry under the old scope.
|
|
45
|
+
*/
|
|
46
|
+
const createScopedRegistryResolver = (args) => {
|
|
47
|
+
const ttlMs = args.ttlMs ?? 3e4;
|
|
48
|
+
const cache = /* @__PURE__ */ new Map();
|
|
49
|
+
return {
|
|
50
|
+
resolver: async (resolveArgs) => {
|
|
51
|
+
const now = Date.now();
|
|
52
|
+
const hit = cache.get(resolveArgs.scope);
|
|
53
|
+
if (hit && hit.expiresAt > now) return hit.registry;
|
|
54
|
+
const registry = combineRegistries(args.base, await args.source(resolveArgs));
|
|
55
|
+
cache.set(resolveArgs.scope, {
|
|
56
|
+
registry,
|
|
57
|
+
expiresAt: now + ttlMs
|
|
58
|
+
});
|
|
59
|
+
return registry;
|
|
60
|
+
},
|
|
61
|
+
invalidate: () => cache.clear()
|
|
62
|
+
};
|
|
63
|
+
};
|
|
64
|
+
//#endregion
|
|
65
|
+
export { collectionProvidersSource, combineRegistries, createScopedRegistryResolver };
|
|
66
|
+
|
|
67
|
+
//# sourceMappingURL=resolver.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resolver.js","names":[],"sources":["../../src/providers/resolver.ts"],"sourcesContent":["import type { Where } from 'payload'\nimport type { AnalyticsAdapter } from '../core/contract'\nimport {\n\ttype AdapterRegistry,\n\tcreateRegistry,\n\ttype RegistryResolver,\n\ttype ResolveRegistryArgs,\n} from '../core/registry'\nimport { adapterFromProviderDoc, type ProviderDoc } from './factory'\nimport { PROVIDER_SECRET_REVEAL_CONTEXT } from './secrets'\n\nexport const PROVIDERS_CACHE_TTL_MS = 30_000\n\n/** Produces the runtime adapters layered onto the static base for one scope. */\nexport type ProvidersSource = (args: ResolveRegistryArgs) => Promise<AnalyticsAdapter[]>\n\nexport interface RegistryBase {\n\tadapters: AnalyticsAdapter[]\n\tdefaultId?: string\n}\n\n/**\n * Overlay runtime adapters onto the static base: a runtime adapter sharing a base\n * adapter's id replaces it in place (the scope's own configuration wins, including\n * for the default), new ids append after the base.\n */\nexport const combineRegistries = (\n\tbase: RegistryBase,\n\textra: AnalyticsAdapter[]\n): AdapterRegistry => {\n\tif (extra.length === 0) {\n\t\treturn createRegistry(base.adapters, base.defaultId)\n\t}\n\tconst byId = new Map(extra.map((a) => [a.id, a]))\n\tconst merged = base.adapters.map((a) => byId.get(a.id) ?? a)\n\tconst seen = new Set(merged.map((a) => a.id))\n\tfor (const adapter of extra) {\n\t\tif (!seen.has(adapter.id)) {\n\t\t\tmerged.push(adapter)\n\t\t\tseen.add(adapter.id)\n\t\t}\n\t}\n\treturn createRegistry(merged, base.defaultId)\n}\n\n/**\n * Look up a scope's enabled provider documents and build adapters from them.\n * Reads with `overrideAccess` plus the secret-reveal context (the masking hook\n * runs regardless of access), depth 0, straight through the local API.\n */\nexport const collectionProvidersSource = (slug: string, scopeField: string): ProvidersSource => {\n\treturn async ({ payload, scope }) => {\n\t\t// equals null matches SQL NULL and a missing Mongo key alike; '' covers cleared text.\n\t\tconst scopeWhere: Where =\n\t\t\tscope === null\n\t\t\t\t? { or: [{ [scopeField]: { equals: null } }, { [scopeField]: { equals: '' } }] }\n\t\t\t\t: { [scopeField]: { equals: scope } }\n\t\tconst { docs } = await payload.find({\n\t\t\tcollection: slug as never,\n\t\t\twhere: { and: [{ enabled: { equals: true } }, scopeWhere] },\n\t\t\tlimit: 100,\n\t\t\tpagination: false,\n\t\t\tdepth: 0,\n\t\t\toverrideAccess: true,\n\t\t\tcontext: { [PROVIDER_SECRET_REVEAL_CONTEXT]: true },\n\t\t})\n\t\treturn (docs as ProviderDoc[])\n\t\t\t.map(adapterFromProviderDoc)\n\t\t\t.filter((a): a is AnalyticsAdapter => a !== null)\n\t}\n}\n\nexport interface ScopedRegistryResolver {\n\tresolver: RegistryResolver\n\t/** Drops every cached scope registry; wired to the provider collection's change hooks. */\n\tinvalidate: () => void\n}\n\n/**\n * Cache resolved registries per scope for a short TTL so widget-heavy dashboards\n * do not re-query the provider collection on every read. Invalidation clears all\n * scopes at once: a document's scope binding can itself change, so per-scope\n * eviction could leave a stale entry under the old scope.\n */\nexport const createScopedRegistryResolver = (args: {\n\tbase: RegistryBase\n\tsource: ProvidersSource\n\tttlMs?: number\n}): ScopedRegistryResolver => {\n\tconst ttlMs = args.ttlMs ?? PROVIDERS_CACHE_TTL_MS\n\tconst cache = new Map<string | null, { registry: AdapterRegistry; expiresAt: number }>()\n\treturn {\n\t\tresolver: async (resolveArgs) => {\n\t\t\tconst now = Date.now()\n\t\t\tconst hit = cache.get(resolveArgs.scope)\n\t\t\tif (hit && hit.expiresAt > now) {\n\t\t\t\treturn hit.registry\n\t\t\t}\n\t\t\tconst registry = combineRegistries(args.base, await args.source(resolveArgs))\n\t\t\tcache.set(resolveArgs.scope, { registry, expiresAt: now + ttlMs })\n\t\t\treturn registry\n\t\t},\n\t\tinvalidate: () => cache.clear(),\n\t}\n}\n"],"mappings":";;;;;;;;AA0BA,MAAa,qBACZ,MACA,UACqB;CACrB,IAAI,MAAM,WAAW,GACpB,OAAO,eAAe,KAAK,UAAU,KAAK,SAAS;CAEpD,MAAM,OAAO,IAAI,IAAI,MAAM,KAAK,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;CAChD,MAAM,SAAS,KAAK,SAAS,KAAK,MAAM,KAAK,IAAI,EAAE,EAAE,KAAK,CAAC;CAC3D,MAAM,OAAO,IAAI,IAAI,OAAO,KAAK,MAAM,EAAE,EAAE,CAAC;CAC5C,KAAK,MAAM,WAAW,OACrB,IAAI,CAAC,KAAK,IAAI,QAAQ,EAAE,GAAG;EAC1B,OAAO,KAAK,OAAO;EACnB,KAAK,IAAI,QAAQ,EAAE;CACpB;CAED,OAAO,eAAe,QAAQ,KAAK,SAAS;AAC7C;;;;;;AAOA,MAAa,6BAA6B,MAAc,eAAwC;CAC/F,OAAO,OAAO,EAAE,SAAS,YAAY;EAEpC,MAAM,aACL,UAAU,OACP,EAAE,IAAI,CAAC,GAAG,aAAa,EAAE,QAAQ,KAAK,EAAE,GAAG,GAAG,aAAa,EAAE,QAAQ,GAAG,EAAE,CAAC,EAAE,IAC7E,GAAG,aAAa,EAAE,QAAQ,MAAM,EAAE;EACtC,MAAM,EAAE,SAAS,MAAM,QAAQ,KAAK;GACnC,YAAY;GACZ,OAAO,EAAE,KAAK,CAAC,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,GAAG,UAAU,EAAE;GAC1D,OAAO;GACP,YAAY;GACZ,OAAO;GACP,gBAAgB;GAChB,SAAS,GAAG,iCAAiC,KAAK;EACnD,CAAC;EACD,OAAQ,KACN,IAAI,sBAAsB,EAC1B,QAAQ,MAA6B,MAAM,IAAI;CAClD;AACD;;;;;;;AAcA,MAAa,gCAAgC,SAIf;CAC7B,MAAM,QAAQ,KAAK,SAAA;CACnB,MAAM,wBAAQ,IAAI,IAAqE;CACvF,OAAO;EACN,UAAU,OAAO,gBAAgB;GAChC,MAAM,MAAM,KAAK,IAAI;GACrB,MAAM,MAAM,MAAM,IAAI,YAAY,KAAK;GACvC,IAAI,OAAO,IAAI,YAAY,KAC1B,OAAO,IAAI;GAEZ,MAAM,WAAW,kBAAkB,KAAK,MAAM,MAAM,KAAK,OAAO,WAAW,CAAC;GAC5E,MAAM,IAAI,YAAY,OAAO;IAAE;IAAU,WAAW,MAAM;GAAM,CAAC;GACjE,OAAO;EACR;EACA,kBAAkB,MAAM,MAAM;CAC/B;AACD"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
//#region src/providers/secrets.ts
|
|
2
|
+
/** Placeholder returned for provider secrets on every read after save. */
|
|
3
|
+
const PROVIDER_SECRET_MASK = "__redacted__";
|
|
4
|
+
/**
|
|
5
|
+
* `req.context` flag that opts a provider read into seeing raw secrets. The field
|
|
6
|
+
* `afterRead` mask runs even under `overrideAccess`, so the internal adapter factory
|
|
7
|
+
* read must set it to recover usable credentials.
|
|
8
|
+
*/
|
|
9
|
+
const PROVIDER_SECRET_REVEAL_CONTEXT = "analyticsRevealProviderSecrets";
|
|
10
|
+
const maskSecret = ({ value, req }) => {
|
|
11
|
+
if (req.context["analyticsRevealProviderSecrets"]) return value;
|
|
12
|
+
return value ? PROVIDER_SECRET_MASK : value;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* Admin form round-trips submit the masked placeholder for an untouched secret;
|
|
16
|
+
* writing it through would destroy the stored credential. Restore the stored value
|
|
17
|
+
* from the raw sibling doc: `previousValue` is unusable here because Payload runs
|
|
18
|
+
* `afterRead` (and so the mask) over the original doc before `beforeChange`.
|
|
19
|
+
*/
|
|
20
|
+
const preserveMaskedSecret = ({ value, field, siblingDocWithLocales }) => {
|
|
21
|
+
if (value !== "__redacted__") return value;
|
|
22
|
+
return (field.name ? siblingDocWithLocales?.[field.name] : void 0) ?? value;
|
|
23
|
+
};
|
|
24
|
+
//#endregion
|
|
25
|
+
export { PROVIDER_SECRET_REVEAL_CONTEXT, maskSecret, preserveMaskedSecret };
|
|
26
|
+
|
|
27
|
+
//# sourceMappingURL=secrets.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"secrets.js","names":[],"sources":["../../src/providers/secrets.ts"],"sourcesContent":["import type { FieldHook } from 'payload'\n\n/** Placeholder returned for provider secrets on every read after save. */\nexport const PROVIDER_SECRET_MASK = '__redacted__'\n\n/**\n * `req.context` flag that opts a provider read into seeing raw secrets. The field\n * `afterRead` mask runs even under `overrideAccess`, so the internal adapter factory\n * read must set it to recover usable credentials.\n */\nexport const PROVIDER_SECRET_REVEAL_CONTEXT = 'analyticsRevealProviderSecrets'\n\nexport const maskSecret: FieldHook = ({ value, req }) => {\n\tif (req.context[PROVIDER_SECRET_REVEAL_CONTEXT]) {\n\t\treturn value\n\t}\n\treturn value ? PROVIDER_SECRET_MASK : value\n}\n\n/**\n * Admin form round-trips submit the masked placeholder for an untouched secret;\n * writing it through would destroy the stored credential. Restore the stored value\n * from the raw sibling doc: `previousValue` is unusable here because Payload runs\n * `afterRead` (and so the mask) over the original doc before `beforeChange`.\n */\nexport const preserveMaskedSecret: FieldHook = ({ value, field, siblingDocWithLocales }) => {\n\tif (value !== PROVIDER_SECRET_MASK) {\n\t\treturn value\n\t}\n\tconst raw = field.name ? siblingDocWithLocales?.[field.name] : undefined\n\treturn raw ?? value\n}\n"],"mappings":";;AAGA,MAAa,uBAAuB;;;;;;AAOpC,MAAa,iCAAiC;AAE9C,MAAa,cAAyB,EAAE,OAAO,UAAU;CACxD,IAAI,IAAI,QAAA,mCACP,OAAO;CAER,OAAO,QAAQ,uBAAuB;AACvC;;;;;;;AAQA,MAAa,wBAAmC,EAAE,OAAO,OAAO,4BAA4B;CAC3F,IAAI,UAAA,gBACH,OAAO;CAGR,QADY,MAAM,OAAO,wBAAwB,MAAM,QAAQ,KAAA,MACjD;AACf"}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
//#region src/surfacing/cacheStore.ts
|
|
2
|
+
function kvCacheStore(kv) {
|
|
3
|
+
const store = {
|
|
4
|
+
now: () => Date.now(),
|
|
5
|
+
async get(key) {
|
|
6
|
+
const hit = await kv.get(key);
|
|
7
|
+
if (!hit) return null;
|
|
8
|
+
if (hit.expiresAt <= store.now()) {
|
|
9
|
+
await kv.delete(key);
|
|
10
|
+
return null;
|
|
11
|
+
}
|
|
12
|
+
return hit.value;
|
|
13
|
+
},
|
|
14
|
+
async set(key, value, ttlSeconds) {
|
|
15
|
+
await kv.set(key, {
|
|
16
|
+
value,
|
|
17
|
+
expiresAt: store.now() + ttlSeconds * 1e3
|
|
18
|
+
});
|
|
19
|
+
}
|
|
20
|
+
};
|
|
21
|
+
return store;
|
|
22
|
+
}
|
|
23
|
+
//#endregion
|
|
24
|
+
export { kvCacheStore };
|
|
25
|
+
|
|
26
|
+
//# sourceMappingURL=cacheStore.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cacheStore.js","names":[],"sources":["../../src/surfacing/cacheStore.ts"],"sourcesContent":["import type { KVAdapter } from 'payload'\n\nexport interface CacheStore {\n\tget<T>(key: string): Promise<T | null>\n\tset<T>(key: string, value: T, ttlSeconds: number): Promise<void>\n\t// Injected for testing; defaults to Date.now\n\tnow: () => number\n}\n\ninterface Wrapped<T> {\n\tvalue: T\n\texpiresAt: number\n}\n\nexport function kvCacheStore(kv: KVAdapter): CacheStore {\n\tconst store: CacheStore = {\n\t\tnow: () => Date.now(),\n\t\tasync get<T>(key: string): Promise<T | null> {\n\t\t\tconst hit = await kv.get<Wrapped<T>>(key)\n\t\t\tif (!hit) return null\n\t\t\tif (hit.expiresAt <= store.now()) {\n\t\t\t\tawait kv.delete(key)\n\t\t\t\treturn null\n\t\t\t}\n\t\t\treturn hit.value\n\t\t},\n\t\tasync set<T>(key: string, value: T, ttlSeconds: number): Promise<void> {\n\t\t\tawait kv.set(key, { value, expiresAt: store.now() + ttlSeconds * 1000 } satisfies Wrapped<T>)\n\t\t},\n\t}\n\treturn store\n}\n"],"mappings":";AAcA,SAAgB,aAAa,IAA2B;CACvD,MAAM,QAAoB;EACzB,WAAW,KAAK,IAAI;EACpB,MAAM,IAAO,KAAgC;GAC5C,MAAM,MAAM,MAAM,GAAG,IAAgB,GAAG;GACxC,IAAI,CAAC,KAAK,OAAO;GACjB,IAAI,IAAI,aAAa,MAAM,IAAI,GAAG;IACjC,MAAM,GAAG,OAAO,GAAG;IACnB,OAAO;GACR;GACA,OAAO,IAAI;EACZ;EACA,MAAM,IAAO,KAAa,OAAU,YAAmC;GACtE,MAAM,GAAG,IAAI,KAAK;IAAE;IAAO,WAAW,MAAM,IAAI,IAAI,aAAa;GAAK,CAAsB;EAC7F;CACD;CACA,OAAO;AACR"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
//#region src/surfacing/coalesce.ts
|
|
2
|
+
function createCoalescer() {
|
|
3
|
+
const inFlight = /* @__PURE__ */ new Map();
|
|
4
|
+
return (key, worker) => {
|
|
5
|
+
const existing = inFlight.get(key);
|
|
6
|
+
if (existing) return existing;
|
|
7
|
+
const promise = worker().finally(() => inFlight.delete(key));
|
|
8
|
+
inFlight.set(key, promise);
|
|
9
|
+
return promise;
|
|
10
|
+
};
|
|
11
|
+
}
|
|
12
|
+
//#endregion
|
|
13
|
+
export { createCoalescer };
|
|
14
|
+
|
|
15
|
+
//# sourceMappingURL=coalesce.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"coalesce.js","names":[],"sources":["../../src/surfacing/coalesce.ts"],"sourcesContent":["export type Coalescer<T> = (key: string, worker: () => Promise<T>) => Promise<T>\n\nexport function createCoalescer<T>(): Coalescer<T> {\n\tconst inFlight = new Map<string, Promise<T>>()\n\treturn (key, worker) => {\n\t\tconst existing = inFlight.get(key)\n\t\tif (existing) return existing\n\t\tconst promise = worker().finally(() => inFlight.delete(key))\n\t\tinFlight.set(key, promise)\n\t\treturn promise\n\t}\n}\n"],"mappings":";AAEA,SAAgB,kBAAmC;CAClD,MAAM,2BAAW,IAAI,IAAwB;CAC7C,QAAQ,KAAK,WAAW;EACvB,MAAM,WAAW,SAAS,IAAI,GAAG;EACjC,IAAI,UAAU,OAAO;EACrB,MAAM,UAAU,OAAO,EAAE,cAAc,SAAS,OAAO,GAAG,CAAC;EAC3D,SAAS,IAAI,KAAK,OAAO;EACzB,OAAO;CACR;AACD"}
|