@10x-media/analytics 1.0.0-beta.7 → 1.0.0-beta.8
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 +48 -0
- package/README.md +8 -2
- package/dist/adapters/ga4/ga4.js +3 -2
- package/dist/adapters/ga4/ga4.js.map +1 -1
- package/dist/adapters/plausible/plausible.js +2 -1
- package/dist/adapters/plausible/plausible.js.map +1 -1
- package/dist/capture/slots.js +16 -5
- package/dist/capture/slots.js.map +1 -1
- package/dist/capture/trackerConfig.d.ts +1 -0
- package/dist/capture/trackerConfig.js +28 -3
- package/dist/capture/trackerConfig.js.map +1 -1
- package/dist/charts/BarList.d.ts +15 -1
- package/dist/charts/BarList.js +34 -18
- package/dist/charts/BarList.js.map +1 -1
- package/dist/charts/TrendChart.d.ts +16 -3
- package/dist/charts/TrendChart.js +172 -106
- package/dist/charts/TrendChart.js.map +1 -1
- package/dist/charts/bars.d.ts +2 -0
- package/dist/charts/bars.js +2 -1
- package/dist/charts/bars.js.map +1 -1
- package/dist/charts/bucket.js +10 -1
- package/dist/charts/bucket.js.map +1 -1
- package/dist/charts/spline.js +2 -2
- package/dist/charts/spline.js.map +1 -1
- package/dist/charts/styles.js +18 -1
- package/dist/charts/styles.js.map +1 -1
- package/dist/core/cacheKey.js +13 -1
- package/dist/core/cacheKey.js.map +1 -1
- package/dist/core/contract.d.ts +14 -7
- package/dist/core/contract.js +29 -1
- package/dist/core/contract.js.map +1 -1
- package/dist/core/granularity.js +1 -1
- package/dist/core/options.d.ts +54 -5
- package/dist/core/options.js +59 -2
- package/dist/core/options.js.map +1 -1
- package/dist/core/scopedRead.js +33 -23
- package/dist/core/scopedRead.js.map +1 -1
- package/dist/core/serverEvent.d.ts +42 -0
- package/dist/core/serverEvent.js +12 -0
- package/dist/core/serverEvent.js.map +1 -0
- package/dist/exports/client.d.ts +8 -2
- package/dist/exports/client.js +6 -1
- package/dist/exports/rsc.d.ts +5 -1
- package/dist/exports/rsc.js +6 -3
- package/dist/exports/types.d.ts +12 -4
- package/dist/exports/types.js +2 -2
- package/dist/fields/AnalyticsPanelClient.js +1 -1
- package/dist/fields/AnalyticsPanelField.js +1 -1
- package/dist/fields/AnalyticsStatField.js +2 -2
- package/dist/fields/config/MetricSelectField.js +2 -2
- package/dist/fields/config/MetricSelectField.js.map +1 -1
- package/dist/fields/config/SourceSelectField.js +2 -2
- package/dist/fields/config/SourceSelectField.js.map +1 -1
- package/dist/fields/config/fetchSources.d.ts +5 -1
- package/dist/fields/readForDocument.d.ts +5 -0
- package/dist/fields/readForDocument.js +5 -5
- package/dist/fields/readForDocument.js.map +1 -1
- package/dist/goals/GoalSelectField.d.ts +7 -0
- package/dist/goals/GoalSelectField.js +77 -0
- package/dist/goals/GoalSelectField.js.map +1 -0
- package/dist/goals/collection.js +250 -0
- package/dist/goals/collection.js.map +1 -0
- package/dist/goals/currency.js +14 -0
- package/dist/goals/currency.js.map +1 -0
- package/dist/goals/fetchGoals.d.ts +18 -0
- package/dist/goals/fetchGoals.js +29 -0
- package/dist/goals/fetchGoals.js.map +1 -0
- package/dist/goals/goalField.d.ts +31 -0
- package/dist/goals/goalField.js +56 -0
- package/dist/goals/goalField.js.map +1 -0
- package/dist/goals/goalsEndpoint.d.ts +1 -0
- package/dist/goals/goalsEndpoint.js +55 -0
- package/dist/goals/goalsEndpoint.js.map +1 -0
- package/dist/goals/resolver.d.ts +8 -0
- package/dist/goals/resolver.js +147 -0
- package/dist/goals/resolver.js.map +1 -0
- package/dist/goals/trackGoalAction.d.ts +74 -0
- package/dist/goals/trackGoalAction.js +139 -0
- package/dist/goals/trackGoalAction.js.map +1 -0
- package/dist/goals/useAnalyticsGoals.d.ts +20 -0
- package/dist/goals/useAnalyticsGoals.js +67 -0
- package/dist/goals/useAnalyticsGoals.js.map +1 -0
- package/dist/index.d.ts +10 -3
- package/dist/index.js +74 -11
- package/dist/index.js.map +1 -1
- package/dist/native/ingest/device.js +11 -3
- package/dist/native/ingest/device.js.map +1 -1
- package/dist/native/ingest/endpoint.d.ts +1 -0
- package/dist/native/ingest/endpoint.js +2 -17
- package/dist/native/ingest/endpoint.js.map +1 -1
- package/dist/native/ingest/normalizeEvent.d.ts +20 -0
- package/dist/native/ingest/normalizeEvent.js +3 -2
- package/dist/native/ingest/normalizeEvent.js.map +1 -1
- package/dist/native/ingest/serverTrack.d.ts +20 -0
- package/dist/native/ingest/serverTrack.js +99 -0
- package/dist/native/ingest/serverTrack.js.map +1 -0
- package/dist/native/ingest/validate.js +27 -0
- package/dist/native/ingest/validate.js.map +1 -0
- package/dist/native/nativeAdapter.d.ts +1 -1
- package/dist/native/nativeAdapter.js +21 -10
- package/dist/native/nativeAdapter.js.map +1 -1
- package/dist/native/retention/pruneTask.js +1 -1
- package/dist/native/rollups/insertIfNew.js +36 -2
- package/dist/native/rollups/insertIfNew.js.map +1 -1
- package/dist/plugin/documentEndpoint.js +27 -9
- package/dist/plugin/documentEndpoint.js.map +1 -1
- package/dist/plugin/paths.js +5 -1
- package/dist/plugin/paths.js.map +1 -1
- package/dist/plugin/queryEndpoint.js +113 -0
- package/dist/plugin/queryEndpoint.js.map +1 -0
- package/dist/plugin/readContextForRequest.js +71 -0
- package/dist/plugin/readContextForRequest.js.map +1 -0
- package/dist/plugin/realtimeEndpoint.js +6 -3
- package/dist/plugin/realtimeEndpoint.js.map +1 -1
- package/dist/plugin/runtime.js +31 -1
- package/dist/plugin/runtime.js.map +1 -1
- package/dist/plugin/scopeFieldBoot.js +22 -0
- package/dist/plugin/scopeFieldBoot.js.map +1 -0
- package/dist/plugin/sourcesEndpoint.js +13 -51
- package/dist/plugin/sourcesEndpoint.js.map +1 -1
- package/dist/plugin/warmTask.js +0 -0
- package/dist/plugin/warmTask.js.map +1 -1
- package/dist/providers/collection.js +15 -9
- package/dist/providers/collection.js.map +1 -1
- package/dist/providers/resolver.js.map +1 -1
- package/dist/query/dates.js +64 -0
- package/dist/query/dates.js.map +1 -0
- package/dist/query/errors.d.ts +17 -0
- package/dist/query/errors.js +10 -0
- package/dist/query/errors.js.map +1 -0
- package/dist/query/fetchQuery.d.ts +59 -0
- package/dist/query/fetchQuery.js +110 -0
- package/dist/query/fetchQuery.js.map +1 -0
- package/dist/query/parse.d.ts +22 -0
- package/dist/query/parse.js +168 -0
- package/dist/query/parse.js.map +1 -0
- package/dist/query/response.d.ts +36 -0
- package/dist/timeframe/tz.js +17 -6
- package/dist/timeframe/tz.js.map +1 -1
- package/dist/translations/ar.js +98 -1
- package/dist/translations/ar.js.map +1 -1
- package/dist/translations/de.js +98 -1
- package/dist/translations/de.js.map +1 -1
- package/dist/translations/en.js +98 -1
- package/dist/translations/en.js.map +1 -1
- package/dist/translations/es.js +98 -1
- package/dist/translations/es.js.map +1 -1
- package/dist/translations/fr.js +98 -1
- package/dist/translations/fr.js.map +1 -1
- package/dist/translations/id.js +98 -1
- package/dist/translations/id.js.map +1 -1
- package/dist/translations/keys.d.ts +97 -0
- package/dist/translations/keys.js +98 -1
- package/dist/translations/keys.js.map +1 -1
- package/dist/translations/ko.js +98 -1
- package/dist/translations/ko.js.map +1 -1
- package/dist/translations/metricKeys.js +1 -1
- package/dist/translations/metricKeys.js.map +1 -1
- package/dist/translations/pt.js +98 -1
- package/dist/translations/pt.js.map +1 -1
- package/dist/translations/ru.js +98 -1
- package/dist/translations/ru.js.map +1 -1
- package/dist/translations/uk.js +98 -1
- package/dist/translations/uk.js.map +1 -1
- package/dist/translations/zh.js +98 -1
- package/dist/translations/zh.js.map +1 -1
- package/dist/view/AnalyticsNavLink.d.ts +19 -0
- package/dist/view/AnalyticsNavLink.js +40 -0
- package/dist/view/AnalyticsNavLink.js.map +1 -0
- package/dist/view/AnalyticsView.d.ts +23 -0
- package/dist/view/AnalyticsView.js +45 -0
- package/dist/view/AnalyticsView.js.map +1 -0
- package/dist/view/AnalyticsViewClient.d.ts +15 -0
- package/dist/view/AnalyticsViewClient.js +189 -0
- package/dist/view/AnalyticsViewClient.js.map +1 -0
- package/dist/view/authRedirect.js +32 -0
- package/dist/view/authRedirect.js.map +1 -0
- package/dist/view/conversionRate.js +18 -0
- package/dist/view/conversionRate.js.map +1 -0
- package/dist/view/dayRange.js +68 -0
- package/dist/view/dayRange.js.map +1 -0
- package/dist/view/gating.d.ts +1 -0
- package/dist/view/gating.js +105 -0
- package/dist/view/gating.js.map +1 -0
- package/dist/view/labels.js +44 -0
- package/dist/view/labels.js.map +1 -0
- package/dist/view/registerView.js +48 -0
- package/dist/view/registerView.js.map +1 -0
- package/dist/view/sections/Breakdowns.js +157 -0
- package/dist/view/sections/Breakdowns.js.map +1 -0
- package/dist/view/sections/EmptyStates.js +92 -0
- package/dist/view/sections/EmptyStates.js.map +1 -0
- package/dist/view/sections/FilterChips.js +41 -0
- package/dist/view/sections/FilterChips.js.map +1 -0
- package/dist/view/sections/GoalsPanel.js +81 -0
- package/dist/view/sections/GoalsPanel.js.map +1 -0
- package/dist/view/sections/OverviewCards.js +65 -0
- package/dist/view/sections/OverviewCards.js.map +1 -0
- package/dist/view/sections/RealtimeStrip.js +77 -0
- package/dist/view/sections/RealtimeStrip.js.map +1 -0
- package/dist/view/sections/Toolbar.js +179 -0
- package/dist/view/sections/Toolbar.js.map +1 -0
- package/dist/view/sections/Trend.js +119 -0
- package/dist/view/sections/Trend.js.map +1 -0
- package/dist/view/sections/styles.js +74 -0
- package/dist/view/sections/styles.js.map +1 -0
- package/dist/view/state.js +206 -0
- package/dist/view/state.js.map +1 -0
- package/dist/view/useViewQueries.js +150 -0
- package/dist/view/useViewQueries.js.map +1 -0
- package/dist/view/viewProps.d.ts +40 -0
- package/dist/view/viewProps.js +90 -0
- package/dist/view/viewProps.js.map +1 -0
- package/dist/widgets/AnalyticsBreakdownWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsBreakdownWidget.js +22 -4
- package/dist/widgets/AnalyticsBreakdownWidget.js.map +1 -1
- package/dist/widgets/AnalyticsGoalsWidget.d.ts +14 -0
- package/dist/widgets/AnalyticsGoalsWidget.js +188 -0
- package/dist/widgets/AnalyticsGoalsWidget.js.map +1 -0
- package/dist/widgets/AnalyticsMetricWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsMetricWidget.js +35 -12
- package/dist/widgets/AnalyticsMetricWidget.js.map +1 -1
- package/dist/widgets/AnalyticsRealtimeWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsRealtimeWidget.js +42 -22
- package/dist/widgets/AnalyticsRealtimeWidget.js.map +1 -1
- package/dist/widgets/AnalyticsTrendWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsTrendWidget.js +51 -15
- package/dist/widgets/AnalyticsTrendWidget.js.map +1 -1
- package/dist/widgets/WidgetViewLink.js +17 -0
- package/dist/widgets/WidgetViewLink.js.map +1 -0
- package/dist/widgets/breakdownTypes.js +28 -1
- package/dist/widgets/breakdownTypes.js.map +1 -1
- package/dist/widgets/cardChrome.js +31 -7
- package/dist/widgets/cardChrome.js.map +1 -1
- package/dist/widgets/range.js +43 -12
- package/dist/widgets/range.js.map +1 -1
- package/dist/widgets/readForWidget.d.ts +12 -0
- package/dist/widgets/readForWidget.js +6 -5
- package/dist/widgets/readForWidget.js.map +1 -1
- package/dist/widgets/readForWidgetBreakdown.d.ts +15 -0
- package/dist/widgets/readForWidgetBreakdown.js +10 -7
- package/dist/widgets/readForWidgetBreakdown.js.map +1 -1
- package/dist/widgets/readForWidgetGoals.d.ts +57 -0
- package/dist/widgets/readForWidgetGoals.js +126 -0
- package/dist/widgets/readForWidgetGoals.js.map +1 -0
- package/dist/widgets/readForWidgetSeries.d.ts +13 -0
- package/dist/widgets/readForWidgetSeries.js +30 -12
- package/dist/widgets/readForWidgetSeries.js.map +1 -1
- package/dist/widgets/registerWidgets.js +49 -6
- package/dist/widgets/registerWidgets.js.map +1 -1
- package/dist/widgets/types.js +12 -1
- package/dist/widgets/types.js.map +1 -1
- package/dist/widgets/viewLink.d.ts +22 -0
- package/dist/widgets/viewLink.js +83 -0
- package/dist/widgets/viewLink.js.map +1 -0
- package/package.json +9 -4
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import "./paths.js";
|
|
2
|
+
import { getRuntime, readAccessFor } from "./runtime.js";
|
|
2
3
|
import { readForWidgetRealtime } from "../widgets/readForWidgetRealtime.js";
|
|
3
4
|
//#region src/plugin/realtimeEndpoint.ts
|
|
4
5
|
const ALLOWED_METRICS = ["visitors", "pageviews"];
|
|
@@ -11,12 +12,14 @@ const ALLOWED_WINDOWS = [
|
|
|
11
12
|
const DEFAULT_WINDOW = 30;
|
|
12
13
|
/**
|
|
13
14
|
* Authenticated GET handler for the realtime widget poller. Reads + clamps the query
|
|
14
|
-
* params, then delegates to readForWidgetRealtime. Returns 401 for an anonymous request
|
|
15
|
-
*
|
|
16
|
-
*
|
|
15
|
+
* params, then delegates to readForWidgetRealtime. Returns 401 for an anonymous request
|
|
16
|
+
* and 403 when `access.read` denies, which defaults to any authenticated user (not
|
|
17
|
+
* admin-panel access specifically); the response is integer counts only.
|
|
17
18
|
*/
|
|
18
19
|
const makeRealtimeHandler = () => async (req) => {
|
|
19
20
|
if (!req.user) return Response.json({ error: "unauthorized" }, { status: 401 });
|
|
21
|
+
const runtime = getRuntime(req.payload);
|
|
22
|
+
if (runtime && !await readAccessFor(runtime, req)) return Response.json({ error: "forbidden" }, { status: 403 });
|
|
20
23
|
const params = new URL(req.url ?? "", "http://localhost").searchParams;
|
|
21
24
|
const rawMetric = params.get("metric");
|
|
22
25
|
const metric = ALLOWED_METRICS.includes(rawMetric) ? rawMetric : "visitors";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"realtimeEndpoint.js","names":[],"sources":["../../src/plugin/realtimeEndpoint.ts"],"sourcesContent":["import type { PayloadHandler } from 'payload'\nimport type { MetricKey } from '../core/contract'\nimport { readForWidgetRealtime } from '../widgets/readForWidgetRealtime'\nimport { REALTIME_PATH } from './paths'\n\nexport { REALTIME_PATH }\n\nconst ALLOWED_METRICS: MetricKey[] = ['visitors', 'pageviews']\nconst ALLOWED_WINDOWS = [5, 15, 30, 60]\nconst DEFAULT_WINDOW = 30\n\n/**\n * Authenticated GET handler for the realtime widget poller. Reads + clamps the query\n * params, then delegates to readForWidgetRealtime. Returns 401 for an anonymous request
|
|
1
|
+
{"version":3,"file":"realtimeEndpoint.js","names":[],"sources":["../../src/plugin/realtimeEndpoint.ts"],"sourcesContent":["import type { PayloadHandler } from 'payload'\nimport type { MetricKey } from '../core/contract'\nimport { readForWidgetRealtime } from '../widgets/readForWidgetRealtime'\nimport { REALTIME_PATH } from './paths'\nimport { getRuntime, readAccessFor } from './runtime'\n\nexport { REALTIME_PATH }\n\nconst ALLOWED_METRICS: MetricKey[] = ['visitors', 'pageviews']\nconst ALLOWED_WINDOWS = [5, 15, 30, 60]\nconst DEFAULT_WINDOW = 30\n\n/**\n * Authenticated GET handler for the realtime widget poller. Reads + clamps the query\n * params, then delegates to readForWidgetRealtime. Returns 401 for an anonymous request\n * and 403 when `access.read` denies, which defaults to any authenticated user (not\n * admin-panel access specifically); the response is integer counts only.\n */\nexport const makeRealtimeHandler = (): PayloadHandler => async (req) => {\n\tif (!req.user) {\n\t\treturn Response.json({ error: 'unauthorized' }, { status: 401 })\n\t}\n\tconst runtime = getRuntime(req.payload)\n\t// No runtime means no adapter to read, so the skipped gate protects no data.\n\tif (runtime && !(await readAccessFor(runtime, req))) {\n\t\treturn Response.json({ error: 'forbidden' }, { status: 403 })\n\t}\n\tconst params = new URL(req.url ?? '', 'http://localhost').searchParams\n\tconst rawMetric = params.get('metric')\n\tconst metric: MetricKey = ALLOWED_METRICS.includes(rawMetric as MetricKey)\n\t\t? (rawMetric as MetricKey)\n\t\t: 'visitors'\n\tconst rawWindow = Number(params.get('windowMinutes'))\n\tconst windowMinutes = ALLOWED_WINDOWS.includes(rawWindow) ? rawWindow : DEFAULT_WINDOW\n\tconst dataSource = params.get('dataSource') ?? undefined\n\tconst result = await readForWidgetRealtime({\n\t\treq,\n\t\tmetric,\n\t\twindowMinutes,\n\t\tadapterId: dataSource,\n\t\tnow: new Date(),\n\t})\n\treturn Response.json(result)\n}\n"],"mappings":";;;;AAQA,MAAM,kBAA+B,CAAC,YAAY,WAAW;AAC7D,MAAM,kBAAkB;CAAC;CAAG;CAAI;CAAI;AAAE;AACtC,MAAM,iBAAiB;;;;;;;AAQvB,MAAa,4BAA4C,OAAO,QAAQ;CACvE,IAAI,CAAC,IAAI,MACR,OAAO,SAAS,KAAK,EAAE,OAAO,eAAe,GAAG,EAAE,QAAQ,IAAI,CAAC;CAEhE,MAAM,UAAU,WAAW,IAAI,OAAO;CAEtC,IAAI,WAAW,CAAE,MAAM,cAAc,SAAS,GAAG,GAChD,OAAO,SAAS,KAAK,EAAE,OAAO,YAAY,GAAG,EAAE,QAAQ,IAAI,CAAC;CAE7D,MAAM,SAAS,IAAI,IAAI,IAAI,OAAO,IAAI,kBAAkB,EAAE;CAC1D,MAAM,YAAY,OAAO,IAAI,QAAQ;CACrC,MAAM,SAAoB,gBAAgB,SAAS,SAAsB,IACrE,YACD;CACH,MAAM,YAAY,OAAO,OAAO,IAAI,eAAe,CAAC;CAGpD,MAAM,SAAS,MAAM,sBAAsB;EAC1C;EACA;EACA,eALqB,gBAAgB,SAAS,SAAS,IAAI,YAAY;EAMvE,WALkB,OAAO,IAAI,YAAY,KAAK,KAAA;EAM9C,qBAAK,IAAI,KAAK;CACf,CAAC;CACD,OAAO,SAAS,KAAK,MAAM;AAC5B"}
|
package/dist/plugin/runtime.js
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import "../core/contract.js";
|
|
1
2
|
//#region src/plugin/runtime.ts
|
|
2
3
|
/**
|
|
3
4
|
* Stored on the Payload instance (not a module global) so the runtime survives the
|
|
@@ -13,9 +14,38 @@ const setRuntime = (payload, runtime) => {
|
|
|
13
14
|
const getRuntime = (payload) => payload[RUNTIME_KEY];
|
|
14
15
|
const resolveScopeFor = (runtime, req) => runtime.resolveScope?.(req) ?? Promise.resolve(null);
|
|
15
16
|
const resolveTimezoneFor = (runtime, req, scope) => runtime.resolveTimezone?.(req, scope) ?? Promise.resolve("UTC");
|
|
17
|
+
/**
|
|
18
|
+
* The reporting timezone of a request, resolving its scope first and falling back to UTC
|
|
19
|
+
* when the plugin is not booted or resolution throws. Callers that must interpret a
|
|
20
|
+
* client-supplied or stored calendar day before the read begins use this; a read path
|
|
21
|
+
* already holding a resolved scope calls {@link resolveTimezoneFor} directly.
|
|
22
|
+
*/
|
|
23
|
+
const requestTimezone = async (req) => {
|
|
24
|
+
const runtime = getRuntime(req.payload);
|
|
25
|
+
if (!runtime) return "UTC";
|
|
26
|
+
try {
|
|
27
|
+
const scope = await resolveScopeFor(runtime, req);
|
|
28
|
+
return await resolveTimezoneFor(runtime, req, scope === "*" ? null : scope);
|
|
29
|
+
} catch {
|
|
30
|
+
return "UTC";
|
|
31
|
+
}
|
|
32
|
+
};
|
|
16
33
|
const resolveRegistryFor = (runtime, args) => runtime.resolveRegistry?.(args) ?? Promise.resolve(runtime.registry);
|
|
34
|
+
const resolveGoalsFor = (runtime, req, scope) => runtime.resolveGoals?.(req, scope) ?? Promise.resolve(runtime.goals ?? []);
|
|
35
|
+
const resolveGoalsDetailedFor = (runtime, req, scope) => runtime.resolveGoalsDetailed?.(req, scope) ?? Promise.resolve((runtime.goals ?? []).map((goal) => ({
|
|
36
|
+
goal,
|
|
37
|
+
source: "config"
|
|
38
|
+
})));
|
|
39
|
+
const readAccessFor = async (runtime, req) => runtime.readAccess ? await runtime.readAccess({ req }) : Boolean(req.user);
|
|
17
40
|
const platformReadFor = async (runtime, req) => runtime.platformRead ? await runtime.platformRead({ req }) : Boolean(req.user);
|
|
41
|
+
const platformReadGate = (runtime, req) => {
|
|
42
|
+
let pending;
|
|
43
|
+
return () => {
|
|
44
|
+
pending ??= platformReadFor(runtime, req);
|
|
45
|
+
return pending;
|
|
46
|
+
};
|
|
47
|
+
};
|
|
18
48
|
//#endregion
|
|
19
|
-
export { getRuntime, platformReadFor, resolveRegistryFor, resolveScopeFor, resolveTimezoneFor, setRuntime };
|
|
49
|
+
export { getRuntime, platformReadFor, platformReadGate, readAccessFor, requestTimezone, resolveGoalsDetailedFor, resolveGoalsFor, resolveRegistryFor, resolveScopeFor, resolveTimezoneFor, setRuntime };
|
|
20
50
|
|
|
21
51
|
//# sourceMappingURL=runtime.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"runtime.js","names":[],"sources":["../../src/plugin/runtime.ts"],"sourcesContent":["import type { Payload, PayloadRequest } from 'payload'\nimport type { ResolvedBinding } from '../binding/types'\nimport type { CaptureSlotOption, ConsentPolicy, ResolvedAutoCapture } from '../core/options'\nimport type { AdapterRegistry, RegistryResolver, ResolveRegistryArgs } from '../core/registry'\nimport type { Goal } from '../goals/types'\nimport type { Engine } from '../surfacing/engine'\nimport { DEFAULT_TIMEZONE } from '../timeframe/tz'\n\nexport interface AnalyticsRuntime {\n\tregistry: AdapterRegistry\n\t/** Per-scope adapter resolution; absent runtimes fall back to the static registry. */\n\tresolveRegistry?: RegistryResolver\n\t/** The plugin's scopeResolver bound at init; absent runtimes resolve null. */\n\tresolveScope?: (req: PayloadRequest) => Promise<string | null>\n\t/** The plugin's reportingTimezone bound at init; absent runtimes resolve 'UTC'. */\n\tresolveTimezone?: (req: PayloadRequest, scope?: string | null) => Promise<string>\n\t/** Id of the config adapter shared by every scope, when one is designated. */\n\tplatformAdapterId?: string\n\t/** `capture.slots` overrides naming the adapter that fills each capture slot. */\n\tcaptureSlots?: { global?: CaptureSlotOption; tenant?: CaptureSlotOption }\n\t/**\n\t * `capture.paths` overrides for a slot's mount. Unset, the tracker config derives the\n\t * runtime proxy mount; set when the slot is served through Next rewrites instead.\n\t */\n\tcapturePaths?: { global?: string; tenant?: string }\n\t/**\n\t * Whether a slot's tracker waits for consent, evaluated per request-resolved adapter.\n\t * Absent runtimes fall back to the default: no gate for native, one for a vendor.\n\t */\n\tconsentFor?: ConsentPolicy\n\t/** Browser auto-capture toggles handed to the tracker; absent runtimes default all on. */\n\tautoCapture?: ResolvedAutoCapture\n\t/** Config goals
|
|
1
|
+
{"version":3,"file":"runtime.js","names":[],"sources":["../../src/plugin/runtime.ts"],"sourcesContent":["import type { Payload, PayloadRequest } from 'payload'\nimport type { ResolvedBinding } from '../binding/types'\nimport { PLATFORM_SCOPE } from '../core/contract'\nimport type { CaptureSlotOption, ConsentPolicy, ResolvedAutoCapture } from '../core/options'\nimport type { AdapterRegistry, RegistryResolver, ResolveRegistryArgs } from '../core/registry'\nimport type { ServerTrack } from '../core/serverEvent'\nimport type { GoalsResolver, ResolvedGoal } from '../goals/resolver'\nimport type { Goal } from '../goals/types'\nimport type { Engine } from '../surfacing/engine'\nimport { DEFAULT_TIMEZONE } from '../timeframe/tz'\n\nexport interface AnalyticsRuntime {\n\tregistry: AdapterRegistry\n\t/** Per-scope adapter resolution; absent runtimes fall back to the static registry. */\n\tresolveRegistry?: RegistryResolver\n\t/** The plugin's scopeResolver bound at init; absent runtimes resolve null. */\n\tresolveScope?: (req: PayloadRequest) => Promise<string | null>\n\t/** The plugin's reportingTimezone bound at init; absent runtimes resolve 'UTC'. */\n\tresolveTimezone?: (req: PayloadRequest, scope?: string | null) => Promise<string>\n\t/** Id of the config adapter shared by every scope, when one is designated. */\n\tplatformAdapterId?: string\n\t/** `capture.slots` overrides naming the adapter that fills each capture slot. */\n\tcaptureSlots?: { global?: CaptureSlotOption; tenant?: CaptureSlotOption }\n\t/**\n\t * `capture.paths` overrides for a slot's mount. Unset, the tracker config derives the\n\t * runtime proxy mount; set when the slot is served through Next rewrites instead.\n\t */\n\tcapturePaths?: { global?: string; tenant?: string }\n\t/**\n\t * Whether a slot's tracker waits for consent, evaluated per request-resolved adapter.\n\t * Absent runtimes fall back to the default: no gate for native, one for a vendor.\n\t */\n\tconsentFor?: ConsentPolicy\n\t/** Browser auto-capture toggles handed to the tracker; absent runtimes default all on. */\n\tautoCapture?: ResolvedAutoCapture\n\t/** Config goals, and the fallback wherever the merged resolution is unavailable. */\n\tgoals?: Goal[]\n\t/**\n\t * Config goals merged with the goals collection for a request's scope. Absent runtimes\n\t * fall back to `goals`.\n\t */\n\tresolveGoals?: GoalsResolver['resolve']\n\t/** The same merge, each goal tagged with where it came from. */\n\tresolveGoalsDetailed?: GoalsResolver['resolveDetailed']\n\t/** Slug of the goals collection when the install enabled it; the picker links to it. */\n\tgoalsCollectionSlug?: string\n\t/**\n\t * Records an event from server code, through whichever registered adapter accepts\n\t * server events. Rejects with an `AnalyticsTrackError` when none does.\n\t */\n\ttrack?: ServerTrack\n\t/**\n\t * Where the ingest endpoint listens, relative to `routes.api`, lifted at init from the\n\t * adapter that registered one. Absent runtimes fall back to the default mount.\n\t */\n\tingestPath?: string\n\t/**\n\t * `capture.proxy` limits for the runtime capture proxy. Deliberately separate from\n\t * `cache.timeoutMs`: that is a per-read provider deadline for authenticated dashboard\n\t * queries, this is a public request path with entirely different traffic.\n\t */\n\tcaptureProxy?: { timeoutMs: number; maxBodyBytes: number }\n\t/** True when the app configured a scopeResolver (scoped install); mirrors `resolved.scoped`. */\n\tscoped?: boolean\n\t/**\n\t * Ids of the config-time adapters shared by every scope (the ones passed to\n\t * `adapters` in plugin options). Runtime provider adapters (resolved per scope\n\t * from the providers collection or `providers.resolve`) are never in it.\n\t */\n\tconfigAdapterIds: ReadonlySet<string>\n\t/** Gate for cross-scope reads; absent runtimes require an authenticated user. */\n\tplatformRead?: (args: { req: PayloadRequest }) => boolean | Promise<boolean>\n\t/** Gate for the query endpoint; absent runtimes require an authenticated user. */\n\treadAccess?: (args: { req: PayloadRequest }) => boolean | Promise<boolean>\n\tbindings: Record<string, ResolvedBinding>\n\tengine: Engine\n\t/** Explicit TTL overrides; when a value is unset the adapter's recommendedTtl applies. */\n\tttl: { aggregate?: number; realtime?: number }\n\t/** Widget period-over-period comparison; false skips the previous-window read. */\n\tcomparison: boolean\n}\n\n/**\n * Stored on the Payload instance (not a module global) so the runtime survives the\n * separate `.` and `/rsc` bundles a consumer loads: a server-component bundle that\n * imported its own copy of a module-level map would never see what the plugin wrote.\n * `Symbol.for` keys into the cross-realm global symbol registry, so both bundles\n * resolve the same key on the same `payload` object.\n */\nconst RUNTIME_KEY = Symbol.for('@10x-media/analytics/runtime')\n\ntype RuntimeHost = { [RUNTIME_KEY]?: AnalyticsRuntime }\n\nexport const setRuntime = (payload: Payload, runtime: AnalyticsRuntime): void => {\n\t;(payload as unknown as RuntimeHost)[RUNTIME_KEY] = runtime\n}\n\nexport const getRuntime = (payload: Payload): AnalyticsRuntime | undefined =>\n\t(payload as unknown as RuntimeHost)[RUNTIME_KEY]\n\nexport const resolveScopeFor = (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest\n): Promise<string | null> => runtime.resolveScope?.(req) ?? Promise.resolve(null)\n\nexport const resolveTimezoneFor = (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest,\n\tscope?: string | null\n): Promise<string> => runtime.resolveTimezone?.(req, scope) ?? Promise.resolve(DEFAULT_TIMEZONE)\n\n/**\n * The reporting timezone of a request, resolving its scope first and falling back to UTC\n * when the plugin is not booted or resolution throws. Callers that must interpret a\n * client-supplied or stored calendar day before the read begins use this; a read path\n * already holding a resolved scope calls {@link resolveTimezoneFor} directly.\n */\nexport const requestTimezone = async (req: PayloadRequest): Promise<string> => {\n\tconst runtime = getRuntime(req.payload)\n\tif (!runtime) {\n\t\treturn DEFAULT_TIMEZONE\n\t}\n\ttry {\n\t\t// The cross-scope marker is not a scope a reporting timezone can be resolved for;\n\t\t// `resolveReadContext` narrows it to null the same way.\n\t\tconst scope = await resolveScopeFor(runtime, req)\n\t\treturn await resolveTimezoneFor(runtime, req, scope === PLATFORM_SCOPE ? null : scope)\n\t} catch {\n\t\treturn DEFAULT_TIMEZONE\n\t}\n}\n\nexport const resolveRegistryFor = (\n\truntime: AnalyticsRuntime,\n\targs: ResolveRegistryArgs\n): Promise<AdapterRegistry> => runtime.resolveRegistry?.(args) ?? Promise.resolve(runtime.registry)\n\nexport const resolveGoalsFor = (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest,\n\tscope?: string | null\n): Promise<Goal[]> => runtime.resolveGoals?.(req, scope) ?? Promise.resolve(runtime.goals ?? [])\n\nexport const resolveGoalsDetailedFor = (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest,\n\tscope?: string | null\n): Promise<ResolvedGoal[]> =>\n\truntime.resolveGoalsDetailed?.(req, scope) ??\n\tPromise.resolve((runtime.goals ?? []).map((goal) => ({ goal, source: 'config' as const })))\n\nexport const readAccessFor = async (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest\n): Promise<boolean> => (runtime.readAccess ? await runtime.readAccess({ req }) : Boolean(req.user))\n\nexport const platformReadFor = async (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest\n): Promise<boolean> =>\n\truntime.platformRead ? await runtime.platformRead({ req }) : Boolean(req.user)\n\n/** A `platformRead` decision evaluated at most once, however many gates consult it. */\nexport type PlatformReadGate = () => Promise<boolean>\n\nexport const platformReadGate = (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest\n): PlatformReadGate => {\n\tlet pending: Promise<boolean> | undefined\n\treturn () => {\n\t\tpending ??= platformReadFor(runtime, req)\n\t\treturn pending\n\t}\n}\n"],"mappings":";;;;;;;;;AAyFA,MAAM,cAAc,OAAO,IAAI,8BAA8B;AAI7D,MAAa,cAAc,SAAkB,YAAoC;CAC/E,QAAoC,eAAe;AACrD;AAEA,MAAa,cAAc,YACzB,QAAmC;AAErC,MAAa,mBACZ,SACA,QAC4B,QAAQ,eAAe,GAAG,KAAK,QAAQ,QAAQ,IAAI;AAEhF,MAAa,sBACZ,SACA,KACA,UACqB,QAAQ,kBAAkB,KAAK,KAAK,KAAK,QAAQ,QAAA,KAAwB;;;;;;;AAQ/F,MAAa,kBAAkB,OAAO,QAAyC;CAC9E,MAAM,UAAU,WAAW,IAAI,OAAO;CACtC,IAAI,CAAC,SACJ,OAAA;CAED,IAAI;EAGH,MAAM,QAAQ,MAAM,gBAAgB,SAAS,GAAG;EAChD,OAAO,MAAM,mBAAmB,SAAS,KAAK,UAAA,MAA2B,OAAO,KAAK;CACtF,QAAQ;EACP,OAAA;CACD;AACD;AAEA,MAAa,sBACZ,SACA,SAC8B,QAAQ,kBAAkB,IAAI,KAAK,QAAQ,QAAQ,QAAQ,QAAQ;AAElG,MAAa,mBACZ,SACA,KACA,UACqB,QAAQ,eAAe,KAAK,KAAK,KAAK,QAAQ,QAAQ,QAAQ,SAAS,CAAC,CAAC;AAE/F,MAAa,2BACZ,SACA,KACA,UAEA,QAAQ,uBAAuB,KAAK,KAAK,KACzC,QAAQ,SAAS,QAAQ,SAAS,CAAC,GAAG,KAAK,UAAU;CAAE;CAAM,QAAQ;AAAkB,EAAE,CAAC;AAE3F,MAAa,gBAAgB,OAC5B,SACA,QACuB,QAAQ,aAAa,MAAM,QAAQ,WAAW,EAAE,IAAI,CAAC,IAAI,QAAQ,IAAI,IAAI;AAEjG,MAAa,kBAAkB,OAC9B,SACA,QAEA,QAAQ,eAAe,MAAM,QAAQ,aAAa,EAAE,IAAI,CAAC,IAAI,QAAQ,IAAI,IAAI;AAK9E,MAAa,oBACZ,SACA,QACsB;CACtB,IAAI;CACJ,aAAa;EACZ,YAAY,gBAAgB,SAAS,GAAG;EACxC,OAAO;CACR;AACD"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
//#region src/plugin/scopeFieldBoot.ts
|
|
2
|
+
/** Whether a top-level field of that name exists, looking through presentational wrappers. */
|
|
3
|
+
const hasField = (fields, name) => fields.some((field) => {
|
|
4
|
+
if ("name" in field && field.name) return field.name === name;
|
|
5
|
+
if ("fields" in field) return hasField(field.fields, name);
|
|
6
|
+
if ("tabs" in field) return field.tabs.some((tab) => !("name" in tab && tab.name) && hasField(tab.fields, name));
|
|
7
|
+
return false;
|
|
8
|
+
});
|
|
9
|
+
/**
|
|
10
|
+
* Fails the boot when a `scopeField` the plugin does not own never materialized on the
|
|
11
|
+
* collection. A tenant plugin registers its field after this plugin runs, so the check
|
|
12
|
+
* waits for the assembled config at init rather than guessing at config time.
|
|
13
|
+
*/
|
|
14
|
+
const validateScopeField = (payload, args) => {
|
|
15
|
+
const collection = payload.config.collections.find((c) => c.slug === args.slug);
|
|
16
|
+
if (!collection || hasField(collection.fields, args.scopeField)) return;
|
|
17
|
+
throw new Error(`analytics: ${args.option} "${args.scopeField}" does not exist on ${args.slug}; register the collection with your tenant plugin or use the default scope field`);
|
|
18
|
+
};
|
|
19
|
+
//#endregion
|
|
20
|
+
export { validateScopeField };
|
|
21
|
+
|
|
22
|
+
//# sourceMappingURL=scopeFieldBoot.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"scopeFieldBoot.js","names":[],"sources":["../../src/plugin/scopeFieldBoot.ts"],"sourcesContent":["import type { Field, Payload } from 'payload'\n\n/** Whether a top-level field of that name exists, looking through presentational wrappers. */\nconst hasField = (fields: Field[], name: string): boolean =>\n\tfields.some((field) => {\n\t\tif ('name' in field && field.name) {\n\t\t\treturn field.name === name\n\t\t}\n\t\tif ('fields' in field) {\n\t\t\treturn hasField(field.fields, name)\n\t\t}\n\t\tif ('tabs' in field) {\n\t\t\treturn field.tabs.some(\n\t\t\t\t(tab) => !('name' in tab && tab.name) && hasField(tab.fields as Field[], name)\n\t\t\t)\n\t\t}\n\t\treturn false\n\t})\n\nexport interface ValidateScopeFieldArgs {\n\t/** Option path quoted in the error, e.g. `goals.collection.scopeField`. */\n\toption: string\n\tslug: string\n\tscopeField: string\n}\n\n/**\n * Fails the boot when a `scopeField` the plugin does not own never materialized on the\n * collection. A tenant plugin registers its field after this plugin runs, so the check\n * waits for the assembled config at init rather than guessing at config time.\n */\nexport const validateScopeField = (payload: Payload, args: ValidateScopeFieldArgs): void => {\n\tconst collection = payload.config.collections.find((c) => c.slug === args.slug)\n\tif (!collection || hasField(collection.fields, args.scopeField)) {\n\t\treturn\n\t}\n\tthrow new Error(\n\t\t`analytics: ${args.option} \"${args.scopeField}\" does not exist on ${args.slug}; register the collection with your tenant plugin or use the default scope field`\n\t)\n}\n"],"mappings":";;AAGA,MAAM,YAAY,QAAiB,SAClC,OAAO,MAAM,UAAU;CACtB,IAAI,UAAU,SAAS,MAAM,MAC5B,OAAO,MAAM,SAAS;CAEvB,IAAI,YAAY,OACf,OAAO,SAAS,MAAM,QAAQ,IAAI;CAEnC,IAAI,UAAU,OACb,OAAO,MAAM,KAAK,MAChB,QAAQ,EAAE,UAAU,OAAO,IAAI,SAAS,SAAS,IAAI,QAAmB,IAAI,CAC9E;CAED,OAAO;AACR,CAAC;;;;;;AAcF,MAAa,sBAAsB,SAAkB,SAAuC;CAC3F,MAAM,aAAa,QAAQ,OAAO,YAAY,MAAM,MAAM,EAAE,SAAS,KAAK,IAAI;CAC9E,IAAI,CAAC,cAAc,SAAS,WAAW,QAAQ,KAAK,UAAU,GAC7D;CAED,MAAM,IAAI,MACT,cAAc,KAAK,OAAO,IAAI,KAAK,WAAW,sBAAsB,KAAK,KAAK,iFAC/E;AACD"}
|
|
@@ -1,63 +1,25 @@
|
|
|
1
1
|
import "./paths.js";
|
|
2
|
-
import { getRuntime,
|
|
3
|
-
import {
|
|
2
|
+
import { getRuntime, readAccessFor } from "./runtime.js";
|
|
3
|
+
import { resolveSourcesForRequest } from "./readContextForRequest.js";
|
|
4
4
|
//#region src/plugin/sourcesEndpoint.ts
|
|
5
5
|
/**
|
|
6
6
|
* Authenticated GET listing the adapters visible to the requesting scope, with
|
|
7
|
-
* serialized capabilities for client-side pickers.
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
* back to the static config registry; a scoped install answers empty, since a
|
|
14
|
-
* failed resolution is indistinguishable from a forged one.
|
|
7
|
+
* serialized capabilities for client-side pickers. Gated by `access.read` like
|
|
8
|
+
* every other read endpoint. Always answers for the caller's own resolved scope;
|
|
9
|
+
* there is deliberately no scope parameter, so a tenant can never enumerate
|
|
10
|
+
* another tenant's sources. Everything else about the resolution, including how a
|
|
11
|
+
* null scope and a failed resolution fail closed, lives in
|
|
12
|
+
* {@link resolveSourcesForRequest}, which the query endpoint shares.
|
|
15
13
|
*/
|
|
16
14
|
const makeSourcesHandler = () => async (req) => {
|
|
17
15
|
if (!req.user) return Response.json({ error: "unauthorized" }, { status: 401 });
|
|
18
16
|
const runtime = getRuntime(req.payload);
|
|
19
|
-
if (!runtime) return Response.json({
|
|
20
|
-
|
|
21
|
-
|
|
17
|
+
if (runtime && !await readAccessFor(runtime, req)) return Response.json({ error: "forbidden" }, { status: 403 });
|
|
18
|
+
const { sources, defaultId } = await resolveSourcesForRequest(req);
|
|
19
|
+
return Response.json({
|
|
20
|
+
defaultId,
|
|
21
|
+
sources
|
|
22
22
|
});
|
|
23
|
-
try {
|
|
24
|
-
const scope = await resolveScopeFor(runtime, req);
|
|
25
|
-
if (runtime.scoped && scope === null && !await platformReadFor(runtime, req)) return Response.json({
|
|
26
|
-
defaultId: null,
|
|
27
|
-
sources: []
|
|
28
|
-
});
|
|
29
|
-
const registry = await resolveRegistryFor(runtime, {
|
|
30
|
-
payload: req.payload,
|
|
31
|
-
req,
|
|
32
|
-
scope
|
|
33
|
-
});
|
|
34
|
-
const sources = registry.all().map((a) => ({
|
|
35
|
-
id: a.id,
|
|
36
|
-
label: a.label,
|
|
37
|
-
kind: runtime.configAdapterIds.has(a.id) ? "config" : "runtime",
|
|
38
|
-
capabilities: serializeCapabilities(a.capabilities)
|
|
39
|
-
}));
|
|
40
|
-
return Response.json({
|
|
41
|
-
defaultId: registry.default().id,
|
|
42
|
-
sources
|
|
43
|
-
});
|
|
44
|
-
} catch (err) {
|
|
45
|
-
req.payload.logger?.warn(`analytics: sources listing failed: ${String(err)}`);
|
|
46
|
-
if (runtime.scoped) return Response.json({
|
|
47
|
-
defaultId: null,
|
|
48
|
-
sources: []
|
|
49
|
-
});
|
|
50
|
-
const sources = runtime.registry.all().map((a) => ({
|
|
51
|
-
id: a.id,
|
|
52
|
-
label: a.label,
|
|
53
|
-
kind: "config",
|
|
54
|
-
capabilities: serializeCapabilities(a.capabilities)
|
|
55
|
-
}));
|
|
56
|
-
return Response.json({
|
|
57
|
-
defaultId: runtime.registry.default().id,
|
|
58
|
-
sources
|
|
59
|
-
});
|
|
60
|
-
}
|
|
61
23
|
};
|
|
62
24
|
//#endregion
|
|
63
25
|
export { makeSourcesHandler };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sourcesEndpoint.js","names":[],"sources":["../../src/plugin/sourcesEndpoint.ts"],"sourcesContent":["import type { PayloadHandler } from 'payload'\nimport {
|
|
1
|
+
{"version":3,"file":"sourcesEndpoint.js","names":[],"sources":["../../src/plugin/sourcesEndpoint.ts"],"sourcesContent":["import type { PayloadHandler } from 'payload'\nimport { SOURCES_PATH } from './paths'\nimport { resolveSourcesForRequest } from './readContextForRequest'\nimport { getRuntime, readAccessFor } from './runtime'\n\nexport { SOURCES_PATH }\n\n/**\n * Authenticated GET listing the adapters visible to the requesting scope, with\n * serialized capabilities for client-side pickers. Gated by `access.read` like\n * every other read endpoint. Always answers for the caller's own resolved scope;\n * there is deliberately no scope parameter, so a tenant can never enumerate\n * another tenant's sources. Everything else about the resolution, including how a\n * null scope and a failed resolution fail closed, lives in\n * {@link resolveSourcesForRequest}, which the query endpoint shares.\n */\nexport const makeSourcesHandler = (): PayloadHandler => async (req) => {\n\tif (!req.user) {\n\t\treturn Response.json({ error: 'unauthorized' }, { status: 401 })\n\t}\n\tconst runtime = getRuntime(req.payload)\n\t// No runtime means the plugin served nothing to gate: the listing below is empty anyway.\n\tif (runtime && !(await readAccessFor(runtime, req))) {\n\t\treturn Response.json({ error: 'forbidden' }, { status: 403 })\n\t}\n\tconst { sources, defaultId } = await resolveSourcesForRequest(req)\n\treturn Response.json({ defaultId, sources })\n}\n"],"mappings":";;;;;;;;;;;;;AAgBA,MAAa,2BAA2C,OAAO,QAAQ;CACtE,IAAI,CAAC,IAAI,MACR,OAAO,SAAS,KAAK,EAAE,OAAO,eAAe,GAAG,EAAE,QAAQ,IAAI,CAAC;CAEhE,MAAM,UAAU,WAAW,IAAI,OAAO;CAEtC,IAAI,WAAW,CAAE,MAAM,cAAc,SAAS,GAAG,GAChD,OAAO,SAAS,KAAK,EAAE,OAAO,YAAY,GAAG,EAAE,QAAQ,IAAI,CAAC;CAE7D,MAAM,EAAE,SAAS,cAAc,MAAM,yBAAyB,GAAG;CACjE,OAAO,SAAS,KAAK;EAAE;EAAW;CAAQ,CAAC;AAC5C"}
|
package/dist/plugin/warmTask.js
CHANGED
|
Binary file
|
|
@@ -1 +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 type { ScopesResolver } from '../core/options'\nimport { resolveScopeList } from '../core/scopeList'\nimport { TIMEFRAME_PRESETS, type TimeframePreset } from '../timeframe/presets'\nimport { breakdownSpecBySlug } from '../widgets/breakdownTypes'\nimport { resolveCustomRange } from '../widgets/range'\nimport { readForWidget, type WidgetReadStatus } 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\ninterface TargetRunResult {\n\tstatus: WidgetReadStatus\n\tadapterId: string\n}\n\n/** Run one target's read for one scope; the caller decides how to count/log the status. */\nconst runTarget = async (args: {\n\ttarget: WarmTarget\n\treq: PayloadRequest\n\tnow: Date\n\tscope: string | null\n}): Promise<TargetRunResult> => {\n\tconst { target, req, now, scope } = args\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\tscope,\n\t\t})\n\t\treturn { status: result.status, adapterId: result.adapterId }\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\tscope,\n\t\t})\n\t\treturn { status: result.status, adapterId: result.adapterId }\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\tscope,\n\t})\n\treturn { status: result.status, adapterId: result.adapterId }\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 * With `scopes` configured, every target runs once per tenant scope (plus the install-wide\n * scope) so a multi-tenant install warms every tenant's dashboard, not just the null one.\n */\nexport const warmTask = (\n\tcron: string,\n\tlayout: WarmLayout,\n\tscopes?: ScopesResolver\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\tif (targets.length === 0) {\n\t\t\treturn { output: { warmed: 0, failed: 0 } }\n\t\t}\n\t\tconst scopeList = await resolveScopeList(scopes, req.payload)\n\t\tconst now = new Date()\n\t\tlet warmed = 0\n\t\tlet failed = 0\n\t\t// A tenant-pass target that degrades (e.g. a shared config adapter gated for\n\t\t// that scope) is not a failure, but a silent one leaves `warmed` unexplainably\n\t\t// short of `scopes x targets`; warn once per (scope, adapter) so it is visible.\n\t\tconst warnedGated = new Set<string>()\n\t\tfor (const scope of scopeList) {\n\t\t\tfor (const target of targets) {\n\t\t\t\ttry {\n\t\t\t\t\tconst result = await runTarget({ target, req, now, scope })\n\t\t\t\t\tif (result.status === 'ok') {\n\t\t\t\t\t\twarmed++\n\t\t\t\t\t} else if (scope !== null) {\n\t\t\t\t\t\tconst key = `${scope}\u0000${result.adapterId}`\n\t\t\t\t\t\tif (!warnedGated.has(key)) {\n\t\t\t\t\t\t\twarnedGated.add(key)\n\t\t\t\t\t\t\treq.payload.logger.warn(\n\t\t\t\t\t\t\t\t`analytics warm-cache: scope \"${scope}\" adapter \"${result.adapterId}\" returned \"${result.status}\", skipping`\n\t\t\t\t\t\t\t)\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t} catch (err) {\n\t\t\t\t\tfailed++\n\t\t\t\t\treq.payload.logger.warn(\n\t\t\t\t\t\t`analytics warm-cache: ${target.kind} read for \"${target.metric}\" (scope \"${scope ?? ''}\") failed: ${String(err)}`\n\t\t\t\t\t)\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":";;;;;;;;;AA2CA,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;;AAQA,MAAM,YAAY,OAAO,SAKO;CAC/B,MAAM,EAAE,QAAQ,KAAK,KAAK,UAAU;CACpC,IAAI,OAAO,SAAS,UAAU;EAC7B,MAAM,SAAS,MAAM,cAAc;GAClC;GACA,SAAS,CAAC,OAAO,MAAM;GACvB,WAAW,OAAO;GAClB,WAAW,OAAO;GAClB;GACA,OAAO,OAAO;GACd;EACD,CAAC;EACD,OAAO;GAAE,QAAQ,OAAO;GAAQ,WAAW,OAAO;EAAU;CAC7D;CACA,IAAI,OAAO,SAAS,UAAU;EAC7B,MAAM,SAAS,MAAM,oBAAoB;GACxC;GACA,QAAQ,OAAO;GACf,WAAW,OAAO;GAClB,WAAW,OAAO;GAClB;GACA,OAAO,OAAO;GACd;EACD,CAAC;EACD,OAAO;GAAE,QAAQ,OAAO;GAAQ,WAAW,OAAO;EAAU;CAC7D;CACA,MAAM,SAAS,MAAM,uBAAuB;EAC3C;EACA,QAAQ,OAAO;EACf,WAAW,OAAO;EAClB,WAAW,OAAO;EAClB,OAAO,OAAO;EACd,WAAW,OAAO;EAClB;EACA,OAAO,OAAO;EACd;CACD,CAAC;CACD,OAAO;EAAE,QAAQ,OAAO;EAAQ,WAAW,OAAO;CAAU;AAC7D;;;;;;;;;;AAWA,MAAa,YACZ,MACA,QACA,YAC+F;CAC/F,MAAM;CACN,SAAS,OAAO,EAAE,UAAU;EAC3B,MAAM,UAAU,kBAAkB,MAAM,cAAc,QAAQ,GAAG,CAAC;EAClE,IAAI,QAAQ,WAAW,GACtB,OAAO,EAAE,QAAQ;GAAE,QAAQ;GAAG,QAAQ;EAAE,EAAE;EAE3C,MAAM,YAAY,MAAM,iBAAiB,QAAQ,IAAI,OAAO;EAC5D,MAAM,sBAAM,IAAI,KAAK;EACrB,IAAI,SAAS;EACb,IAAI,SAAS;EAIb,MAAM,8BAAc,IAAI,IAAY;EACpC,KAAK,MAAM,SAAS,WACnB,KAAK,MAAM,UAAU,SACpB,IAAI;GACH,MAAM,SAAS,MAAM,UAAU;IAAE;IAAQ;IAAK;IAAK;GAAM,CAAC;GAC1D,IAAI,OAAO,WAAW,MACrB;QACM,IAAI,UAAU,MAAM;IAC1B,MAAM,MAAM,GAAG,MAAM,GAAG,OAAO;IAC/B,IAAI,CAAC,YAAY,IAAI,GAAG,GAAG;KAC1B,YAAY,IAAI,GAAG;KACnB,IAAI,QAAQ,OAAO,KAClB,gCAAgC,MAAM,aAAa,OAAO,UAAU,cAAc,OAAO,OAAO,YACjG;IACD;GACD;EACD,SAAS,KAAK;GACb;GACA,IAAI,QAAQ,OAAO,KAClB,yBAAyB,OAAO,KAAK,aAAa,OAAO,OAAO,YAAY,SAAS,GAAG,aAAa,OAAO,GAAG,GAChH;EACD;EAGF,OAAO,EAAE,QAAQ;GAAE;GAAQ;EAAO,EAAE;CACrC;CACA,UAAU,CAAC;EAAE;EAAM,OAAO;CAAU,CAAC;AACtC"}
|
|
1
|
+
{"version":3,"file":"warmTask.js","names":[],"sources":["../../src/plugin/warmTask.ts"],"sourcesContent":["import type { PayloadRequest, TaskConfig, WidgetInstance } from 'payload'\nimport type { DimensionKey, MetricKey } from '../core/contract'\nimport type { ScopesResolver } from '../core/options'\nimport { resolveScopeList } from '../core/scopeList'\nimport { TIMEFRAME_PRESETS, type TimeframePreset } from '../timeframe/presets'\nimport { DEFAULT_TIMEZONE } from '../timeframe/tz'\nimport { breakdownSpecBySlug } from '../widgets/breakdownTypes'\nimport { resolveCustomRange } from '../widgets/range'\nimport { readForWidget, type WidgetReadStatus } from '../widgets/readForWidget'\nimport { readForWidgetBreakdown } from '../widgets/readForWidgetBreakdown'\nimport { readForWidgetSeries } from '../widgets/readForWidgetSeries'\nimport { WIDGET_METRICS, type WidgetRange } from '../widgets/types'\nimport { getRuntime, resolveTimezoneFor } from './runtime'\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?: WidgetRange\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?: WidgetRange\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?: WidgetRange\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.from ?? ''}:${t.range.to ?? ''}` : ''\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), and\n * the stored bounds travel with the target rather than concrete instants: which instants\n * two picked days span depends on the reporting timezone, which is per scope and so only\n * known inside the warm loop. Identical targets are de-duplicated so a repeated widget\n * 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: WidgetRange | undefined\n\t\tif (timeframeRaw === 'custom') {\n\t\t\tconst stored = asRange(data.range)\n\t\t\t// Whether the bounds name real days is timezone-independent, so the skip decision\n\t\t\t// can be taken here even though the window itself cannot.\n\t\t\tif (!resolveCustomRange('custom', stored, DEFAULT_TIMEZONE)) {\n\t\t\t\tcontinue\n\t\t\t}\n\t\t\trange = stored\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\ninterface TargetRunResult {\n\tstatus: WidgetReadStatus\n\tadapterId: string\n}\n\n/**\n * Run one target's read for one scope; the caller decides how to count/log the status. The\n * stored custom bounds resolve here, in that scope's reporting timezone, so the warmed key\n * is the one the rendered widget will ask for.\n */\nconst runTarget = async (args: {\n\ttarget: WarmTarget\n\treq: PayloadRequest\n\tnow: Date\n\tscope: string | null\n\ttimezone: string\n}): Promise<TargetRunResult> => {\n\tconst { target, req, now, scope, timezone } = args\n\tconst range = resolveCustomRange('custom', target.range, timezone)\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,\n\t\t\tscope,\n\t\t\ttimezone,\n\t\t})\n\t\treturn { status: result.status, adapterId: result.adapterId }\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,\n\t\t\tscope,\n\t\t\ttimezone,\n\t\t})\n\t\treturn { status: result.status, adapterId: result.adapterId }\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,\n\t\tscope,\n\t\ttimezone,\n\t})\n\treturn { status: result.status, adapterId: result.adapterId }\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 * With `scopes` configured, every target runs once per tenant scope (plus the install-wide\n * scope) so a multi-tenant install warms every tenant's dashboard, not just the null one.\n */\nexport const warmTask = (\n\tcron: string,\n\tlayout: WarmLayout,\n\tscopes?: ScopesResolver\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\tif (targets.length === 0) {\n\t\t\treturn { output: { warmed: 0, failed: 0 } }\n\t\t}\n\t\tconst scopeList = await resolveScopeList(scopes, req.payload)\n\t\tconst now = new Date()\n\t\tlet warmed = 0\n\t\tlet failed = 0\n\t\t// A tenant-pass target that degrades (e.g. a shared config adapter gated for\n\t\t// that scope) is not a failure, but a silent one leaves `warmed` unexplainably\n\t\t// short of `scopes x targets`; warn once per (scope, adapter) so it is visible.\n\t\tconst warnedGated = new Set<string>()\n\t\tconst runtime = getRuntime(req.payload)\n\t\tfor (const scope of scopeList) {\n\t\t\tconst timezone = runtime ? await resolveTimezoneFor(runtime, req, scope) : DEFAULT_TIMEZONE\n\t\t\tfor (const target of targets) {\n\t\t\t\ttry {\n\t\t\t\t\tconst result = await runTarget({ target, req, now, scope, timezone })\n\t\t\t\t\tif (result.status === 'ok') {\n\t\t\t\t\t\twarmed++\n\t\t\t\t\t} else if (scope !== null) {\n\t\t\t\t\t\tconst key = `${scope}\u0000${result.adapterId}`\n\t\t\t\t\t\tif (!warnedGated.has(key)) {\n\t\t\t\t\t\t\twarnedGated.add(key)\n\t\t\t\t\t\t\treq.payload.logger.warn(\n\t\t\t\t\t\t\t\t`analytics warm-cache: scope \"${scope}\" adapter \"${result.adapterId}\" returned \"${result.status}\", skipping`\n\t\t\t\t\t\t\t)\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t} catch (err) {\n\t\t\t\t\tfailed++\n\t\t\t\t\treq.payload.logger.warn(\n\t\t\t\t\t\t`analytics warm-cache: ${target.kind} read for \"${target.metric}\" (scope \"${scope ?? ''}\") failed: ${String(err)}`\n\t\t\t\t\t)\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":";;;;;;;;;;AA6CA,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,QAAQ,GAAG,GAAG,EAAE,MAAM,MAAM,OAAO;CACtE,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;;;;;;;;;;;;AAaA,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,SAAS,QAAQ,KAAK,KAAK;GAGjC,IAAI,CAAC,mBAAmB,UAAU,QAAA,KAAwB,GACzD;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;;;;;;AAYA,MAAM,YAAY,OAAO,SAMO;CAC/B,MAAM,EAAE,QAAQ,KAAK,KAAK,OAAO,aAAa;CAC9C,MAAM,QAAQ,mBAAmB,UAAU,OAAO,OAAO,QAAQ;CACjE,IAAI,OAAO,SAAS,UAAU;EAC7B,MAAM,SAAS,MAAM,cAAc;GAClC;GACA,SAAS,CAAC,OAAO,MAAM;GACvB,WAAW,OAAO;GAClB,WAAW,OAAO;GAClB;GACA;GACA;GACA;EACD,CAAC;EACD,OAAO;GAAE,QAAQ,OAAO;GAAQ,WAAW,OAAO;EAAU;CAC7D;CACA,IAAI,OAAO,SAAS,UAAU;EAC7B,MAAM,SAAS,MAAM,oBAAoB;GACxC;GACA,QAAQ,OAAO;GACf,WAAW,OAAO;GAClB,WAAW,OAAO;GAClB;GACA;GACA;GACA;EACD,CAAC;EACD,OAAO;GAAE,QAAQ,OAAO;GAAQ,WAAW,OAAO;EAAU;CAC7D;CACA,MAAM,SAAS,MAAM,uBAAuB;EAC3C;EACA,QAAQ,OAAO;EACf,WAAW,OAAO;EAClB,WAAW,OAAO;EAClB,OAAO,OAAO;EACd,WAAW,OAAO;EAClB;EACA;EACA;EACA;CACD,CAAC;CACD,OAAO;EAAE,QAAQ,OAAO;EAAQ,WAAW,OAAO;CAAU;AAC7D;;;;;;;;;;AAWA,MAAa,YACZ,MACA,QACA,YAC+F;CAC/F,MAAM;CACN,SAAS,OAAO,EAAE,UAAU;EAC3B,MAAM,UAAU,kBAAkB,MAAM,cAAc,QAAQ,GAAG,CAAC;EAClE,IAAI,QAAQ,WAAW,GACtB,OAAO,EAAE,QAAQ;GAAE,QAAQ;GAAG,QAAQ;EAAE,EAAE;EAE3C,MAAM,YAAY,MAAM,iBAAiB,QAAQ,IAAI,OAAO;EAC5D,MAAM,sBAAM,IAAI,KAAK;EACrB,IAAI,SAAS;EACb,IAAI,SAAS;EAIb,MAAM,8BAAc,IAAI,IAAY;EACpC,MAAM,UAAU,WAAW,IAAI,OAAO;EACtC,KAAK,MAAM,SAAS,WAAW;GAC9B,MAAM,WAAW,UAAU,MAAM,mBAAmB,SAAS,KAAK,KAAK,IAAA;GACvE,KAAK,MAAM,UAAU,SACpB,IAAI;IACH,MAAM,SAAS,MAAM,UAAU;KAAE;KAAQ;KAAK;KAAK;KAAO;IAAS,CAAC;IACpE,IAAI,OAAO,WAAW,MACrB;SACM,IAAI,UAAU,MAAM;KAC1B,MAAM,MAAM,GAAG,MAAM,GAAG,OAAO;KAC/B,IAAI,CAAC,YAAY,IAAI,GAAG,GAAG;MAC1B,YAAY,IAAI,GAAG;MACnB,IAAI,QAAQ,OAAO,KAClB,gCAAgC,MAAM,aAAa,OAAO,UAAU,cAAc,OAAO,OAAO,YACjG;KACD;IACD;GACD,SAAS,KAAK;IACb;IACA,IAAI,QAAQ,OAAO,KAClB,yBAAyB,OAAO,KAAK,aAAa,OAAO,OAAO,YAAY,SAAS,GAAG,aAAa,OAAO,GAAG,GAChH;GACD;EAEF;EACA,OAAO,EAAE,QAAQ;GAAE;GAAQ;EAAO,EAAE;CACrC;CACA,UAAU,CAAC;EAAE;EAAM,OAAO;CAAU,CAAC;AACtC"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { keys } from "../translations/keys.js";
|
|
2
|
-
import { labelForKey } from "../translations/server.js";
|
|
3
1
|
import { providerCreateAccess, providerRowAccess } from "./access.js";
|
|
4
2
|
import { stampScope } from "./stampScope.js";
|
|
3
|
+
import { keys } from "../translations/keys.js";
|
|
4
|
+
import { labelForKey } from "../translations/server.js";
|
|
5
5
|
//#region src/providers/collection.ts
|
|
6
6
|
const PROVIDERS_SLUG = "analytics-providers";
|
|
7
7
|
const textField = (name, label, width) => ({
|
|
@@ -30,6 +30,18 @@ const captureField = (name, label, width) => ({
|
|
|
30
30
|
...width ? { width } : {}
|
|
31
31
|
}
|
|
32
32
|
});
|
|
33
|
+
/**
|
|
34
|
+
* The plugin's own scope field, and only when `scopeField` still names it: a host-owned
|
|
35
|
+
* field (a tenant plugin's relationship) is the host's to register, and shadowing it with a
|
|
36
|
+
* hidden text field of another name would store the scope twice.
|
|
37
|
+
*/
|
|
38
|
+
const scopeField = (args) => args.scopeField === "scope" ? [{
|
|
39
|
+
name: "scope",
|
|
40
|
+
type: "text",
|
|
41
|
+
index: true,
|
|
42
|
+
label: labelForKey(keys.providerFieldScope),
|
|
43
|
+
admin: { hidden: true }
|
|
44
|
+
}] : [];
|
|
33
45
|
const hostField = () => ({
|
|
34
46
|
name: "host",
|
|
35
47
|
type: "text",
|
|
@@ -128,13 +140,7 @@ const buildProvidersCollection = (args) => {
|
|
|
128
140
|
}
|
|
129
141
|
}]
|
|
130
142
|
},
|
|
131
|
-
|
|
132
|
-
name: "scope",
|
|
133
|
-
type: "text",
|
|
134
|
-
index: true,
|
|
135
|
-
label: labelForKey(keys.providerFieldScope),
|
|
136
|
-
admin: { hidden: true }
|
|
137
|
-
},
|
|
143
|
+
...scopeField(args),
|
|
138
144
|
providerGroup("plausible", keys.providerNamePlausible, [
|
|
139
145
|
{
|
|
140
146
|
type: "row",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"collection.js","names":[],"sources":["../../src/providers/collection.ts"],"sourcesContent":["import type { CollectionConfig, Field, TextareaField, TextField } from 'payload'\nimport { keys, type TranslationKey } from '../translations/keys'\nimport { labelForKey } from '../translations/server'\nimport type { ProviderAccessArgs } from './access'\nimport { providerCreateAccess, providerRowAccess } from './access'\nimport type { ProviderId } from './factory'\nimport { stampScope } from './stampScope'\n\nexport const PROVIDERS_SLUG = 'analytics-providers'\n\n/** Builds the sealed variant of a secret source field; injected so the fields peer stays lazy. */\nexport type BuildSecretField = (source: TextField | TextareaField) => Field[]\n\nexport interface BuildProvidersCollectionArgs extends ProviderAccessArgs {\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\tbuildSecret: BuildSecretField\n}\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 = (\n\targs: BuildProvidersCollectionArgs,\n\topts: { name: string; label: TranslationKey; width?: string }\n): Field[] =>\n\targs.buildSecret({\n\t\tname: opts.name,\n\t\ttype: 'text',\n\t\tlabel: labelForKey(opts.label),\n\t\t...(opts.width ? { admin: { width: opts.width } } : {}),\n\t})\n\n/**\n * Public capture config: plain text, never a sealed secret, because the tracker config\n * serves it to the browser. An adapter declares `capture` only when its public field is\n * filled, so these are what let a provider document fill a capture slot.\n */\nconst captureField = (name: string, label: TranslationKey, width?: string): Field => ({\n\tname,\n\ttype: 'text',\n\tlabel: labelForKey(label),\n\tadmin: {\n\t\tdescription: labelForKey(keys.providerFieldCaptureHelp),\n\t\t...(width ? { width } : {}),\n\t},\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\tdisableDuplicate: true,\n\t\tadmin: {\n\t\t\tuseAsTitle: 'name',\n\t\t\tdefaultColumns: ['name', 'provider', 'enabled'],\n\t\t\tgroup: 'Analytics',\n\t\t},\n\t\taccess: {\n\t\t\tread: providerRowAccess(args),\n\t\t\tcreate: providerCreateAccess(args),\n\t\t\tupdate: providerRowAccess(args),\n\t\t\tdelete: providerRowAccess(args),\n\t\t\t...args.access,\n\t\t},\n\t\thooks: {\n\t\t\tbeforeChange: [stampScope(args)],\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\tname: 'name',\n\t\t\t\ttype: 'text',\n\t\t\t\trequired: true,\n\t\t\t\tlabel: labelForKey(keys.providerFieldName),\n\t\t\t},\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\t...secretField(args, { name: 'apiKey', label: keys.providerFieldApiKey, width: '50%' }),\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\ttype: 'row',\n\t\t\t\t\tfields: [\n\t\t\t\t\t\tcaptureField('domain', keys.providerFieldDomain, '50%'),\n\t\t\t\t\t\tcaptureField('scriptId', keys.providerFieldScriptId, '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\t...secretField(args, { name: 'apiKey', label: keys.providerFieldApiKey, width: '50%' }),\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t\t...secretField(args, { name: 'token', label: 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...args.buildSecret({\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}),\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\t...secretField(args, { name: 'apiKey', label: keys.providerFieldApiKey, width: '50%' }),\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\ttype: 'row',\n\t\t\t\t\tfields: [\n\t\t\t\t\t\tcaptureField('projectToken', keys.providerFieldProjectToken, '50%'),\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tname: 'region',\n\t\t\t\t\t\t\ttype: 'select',\n\t\t\t\t\t\t\tlabel: labelForKey(keys.providerFieldRegion),\n\t\t\t\t\t\t\toptions: [\n\t\t\t\t\t\t\t\t{ label: 'US', value: 'us' },\n\t\t\t\t\t\t\t\t{ label: 'EU', value: 'eu' },\n\t\t\t\t\t\t\t],\n\t\t\t\t\t\t\tadmin: { width: '50%' },\n\t\t\t\t\t\t},\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":";;;;;AAQA,MAAa,iBAAiB;AAc9B,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,eACL,MACA,SAEA,KAAK,YAAY;CAChB,MAAM,KAAK;CACX,MAAM;CACN,OAAO,YAAY,KAAK,KAAK;CAC7B,GAAI,KAAK,QAAQ,EAAE,OAAO,EAAE,OAAO,KAAK,MAAM,EAAE,IAAI,CAAC;AACtD,CAAC;;;;;;AAOF,MAAM,gBAAgB,MAAc,OAAuB,WAA2B;CACrF;CACA,MAAM;CACN,OAAO,YAAY,KAAK;CACxB,OAAO;EACN,aAAa,YAAY,KAAK,wBAAwB;EACtD,GAAI,QAAQ,EAAE,MAAM,IAAI,CAAC;CAC1B;AACD;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,kBAAkB;EAClB,OAAO;GACN,YAAY;GACZ,gBAAgB;IAAC;IAAQ;IAAY;GAAS;GAC9C,OAAO;EACR;EACA,QAAQ;GACP,MAAM,kBAAkB,IAAI;GAC5B,QAAQ,qBAAqB,IAAI;GACjC,QAAQ,kBAAkB,IAAI;GAC9B,QAAQ,kBAAkB,IAAI;GAC9B,GAAG,KAAK;EACT;EACA,OAAO;GACN,cAAc,CAAC,WAAW,IAAI,CAAC;GAC/B,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,MAAM;IACN,UAAU;IACV,OAAO,YAAY,KAAK,iBAAiB;GAC1C;GACA;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;IACtD;KACC,MAAM;KACN,QAAQ,CACP,UAAU,UAAU,KAAK,qBAAqB,KAAK,GACnD,GAAG,YAAY,MAAM;MAAE,MAAM;MAAU,OAAO,KAAK;MAAqB,OAAO;KAAM,CAAC,CACvF;IACD;IACA;KACC,MAAM;KACN,QAAQ,CACP,aAAa,UAAU,KAAK,qBAAqB,KAAK,GACtD,aAAa,YAAY,KAAK,uBAAuB,KAAK,CAC3D;IACD;IACA,UAAU;GACX,CAAC;GACD,cAAc,SAAS,KAAK,mBAAmB;IAC9C;KACC,MAAM;KACN,QAAQ,CACP,UAAU,aAAa,KAAK,wBAAwB,KAAK,GACzD,GAAG,YAAY,MAAM;MAAE,MAAM;MAAU,OAAO,KAAK;MAAqB,OAAO;KAAM,CAAC,CACvF;IACD;IACA,GAAG,YAAY,MAAM;KAAE,MAAM;KAAS,OAAO,KAAK;IAAmB,CAAC;IACtE,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,GAAG,KAAK,YAAY;KACnB,MAAM;KACN,MAAM;KACN,OAAO,YAAY,KAAK,uBAAuB;IAChD,CAAC;GACF,CAAC;GACD,cAAc,WAAW,KAAK,qBAAqB;IAClD;KACC,MAAM;KACN,QAAQ,CACP,UAAU,aAAa,KAAK,wBAAwB,KAAK,GACzD,GAAG,YAAY,MAAM;MAAE,MAAM;MAAU,OAAO,KAAK;MAAqB,OAAO;KAAM,CAAC,CACvF;IACD;IACA;KACC,MAAM;KACN,QAAQ,CACP,aAAa,gBAAgB,KAAK,2BAA2B,KAAK,GAClE;MACC,MAAM;MACN,MAAM;MACN,OAAO,YAAY,KAAK,mBAAmB;MAC3C,SAAS,CACR;OAAE,OAAO;OAAM,OAAO;MAAK,GAC3B;OAAE,OAAO;OAAM,OAAO;MAAK,CAC5B;MACA,OAAO,EAAE,OAAO,MAAM;KACvB,CACD;IACD;IACA,UAAU;GACX,CAAC;EACF;CACD;CACA,OAAO,KAAK,YAAY,KAAK,UAAU,UAAU,IAAI;AACtD"}
|
|
1
|
+
{"version":3,"file":"collection.js","names":[],"sources":["../../src/providers/collection.ts"],"sourcesContent":["import type { CollectionConfig, Field, TextareaField, TextField } from 'payload'\nimport { keys, type TranslationKey } from '../translations/keys'\nimport { labelForKey } from '../translations/server'\nimport type { ProviderAccessArgs } from './access'\nimport { providerCreateAccess, providerRowAccess } from './access'\nimport type { ProviderId } from './factory'\nimport { stampScope } from './stampScope'\n\nexport const PROVIDERS_SLUG = 'analytics-providers'\n\n/** Builds the sealed variant of a secret source field; injected so the fields peer stays lazy. */\nexport type BuildSecretField = (source: TextField | TextareaField) => Field[]\n\nexport interface BuildProvidersCollectionArgs extends ProviderAccessArgs {\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\tbuildSecret: BuildSecretField\n}\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 = (\n\targs: BuildProvidersCollectionArgs,\n\topts: { name: string; label: TranslationKey; width?: string }\n): Field[] =>\n\targs.buildSecret({\n\t\tname: opts.name,\n\t\ttype: 'text',\n\t\tlabel: labelForKey(opts.label),\n\t\t...(opts.width ? { admin: { width: opts.width } } : {}),\n\t})\n\n/**\n * Public capture config: plain text, never a sealed secret, because the tracker config\n * serves it to the browser. An adapter declares `capture` only when its public field is\n * filled, so these are what let a provider document fill a capture slot.\n */\nconst captureField = (name: string, label: TranslationKey, width?: string): Field => ({\n\tname,\n\ttype: 'text',\n\tlabel: labelForKey(label),\n\tadmin: {\n\t\tdescription: labelForKey(keys.providerFieldCaptureHelp),\n\t\t...(width ? { width } : {}),\n\t},\n})\n\n/**\n * The plugin's own scope field, and only when `scopeField` still names it: a host-owned\n * field (a tenant plugin's relationship) is the host's to register, and shadowing it with a\n * hidden text field of another name would store the scope twice.\n */\nconst scopeField = (args: BuildProvidersCollectionArgs): Field[] =>\n\targs.scopeField === 'scope'\n\t\t? [\n\t\t\t\t{\n\t\t\t\t\t// Written by scoped setups; hidden because single-site installs never touch it.\n\t\t\t\t\tname: 'scope',\n\t\t\t\t\ttype: 'text',\n\t\t\t\t\tindex: true,\n\t\t\t\t\tlabel: labelForKey(keys.providerFieldScope),\n\t\t\t\t\tadmin: { hidden: true },\n\t\t\t\t},\n\t\t\t]\n\t\t: []\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\tdisableDuplicate: true,\n\t\tadmin: {\n\t\t\tuseAsTitle: 'name',\n\t\t\tdefaultColumns: ['name', 'provider', 'enabled'],\n\t\t\tgroup: 'Analytics',\n\t\t},\n\t\taccess: {\n\t\t\tread: providerRowAccess(args),\n\t\t\tcreate: providerCreateAccess(args),\n\t\t\tupdate: providerRowAccess(args),\n\t\t\tdelete: providerRowAccess(args),\n\t\t\t...args.access,\n\t\t},\n\t\thooks: {\n\t\t\tbeforeChange: [stampScope(args)],\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\tname: 'name',\n\t\t\t\ttype: 'text',\n\t\t\t\trequired: true,\n\t\t\t\tlabel: labelForKey(keys.providerFieldName),\n\t\t\t},\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...scopeField(args),\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\t...secretField(args, { name: 'apiKey', label: keys.providerFieldApiKey, width: '50%' }),\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\ttype: 'row',\n\t\t\t\t\tfields: [\n\t\t\t\t\t\tcaptureField('domain', keys.providerFieldDomain, '50%'),\n\t\t\t\t\t\tcaptureField('scriptId', keys.providerFieldScriptId, '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\t...secretField(args, { name: 'apiKey', label: keys.providerFieldApiKey, width: '50%' }),\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t\t...secretField(args, { name: 'token', label: 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...args.buildSecret({\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}),\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\t...secretField(args, { name: 'apiKey', label: keys.providerFieldApiKey, width: '50%' }),\n\t\t\t\t\t],\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\ttype: 'row',\n\t\t\t\t\tfields: [\n\t\t\t\t\t\tcaptureField('projectToken', keys.providerFieldProjectToken, '50%'),\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tname: 'region',\n\t\t\t\t\t\t\ttype: 'select',\n\t\t\t\t\t\t\tlabel: labelForKey(keys.providerFieldRegion),\n\t\t\t\t\t\t\toptions: [\n\t\t\t\t\t\t\t\t{ label: 'US', value: 'us' },\n\t\t\t\t\t\t\t\t{ label: 'EU', value: 'eu' },\n\t\t\t\t\t\t\t],\n\t\t\t\t\t\t\tadmin: { width: '50%' },\n\t\t\t\t\t\t},\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":";;;;;AAQA,MAAa,iBAAiB;AAc9B,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,eACL,MACA,SAEA,KAAK,YAAY;CAChB,MAAM,KAAK;CACX,MAAM;CACN,OAAO,YAAY,KAAK,KAAK;CAC7B,GAAI,KAAK,QAAQ,EAAE,OAAO,EAAE,OAAO,KAAK,MAAM,EAAE,IAAI,CAAC;AACtD,CAAC;;;;;;AAOF,MAAM,gBAAgB,MAAc,OAAuB,WAA2B;CACrF;CACA,MAAM;CACN,OAAO,YAAY,KAAK;CACxB,OAAO;EACN,aAAa,YAAY,KAAK,wBAAwB;EACtD,GAAI,QAAQ,EAAE,MAAM,IAAI,CAAC;CAC1B;AACD;;;;;;AAOA,MAAM,cAAc,SACnB,KAAK,eAAe,UACjB,CACA;CAEC,MAAM;CACN,MAAM;CACN,OAAO;CACP,OAAO,YAAY,KAAK,kBAAkB;CAC1C,OAAO,EAAE,QAAQ,KAAK;AACvB,CACD,IACC,CAAC;AAEL,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,kBAAkB;EAClB,OAAO;GACN,YAAY;GACZ,gBAAgB;IAAC;IAAQ;IAAY;GAAS;GAC9C,OAAO;EACR;EACA,QAAQ;GACP,MAAM,kBAAkB,IAAI;GAC5B,QAAQ,qBAAqB,IAAI;GACjC,QAAQ,kBAAkB,IAAI;GAC9B,QAAQ,kBAAkB,IAAI;GAC9B,GAAG,KAAK;EACT;EACA,OAAO;GACN,cAAc,CAAC,WAAW,IAAI,CAAC;GAC/B,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,MAAM;IACN,UAAU;IACV,OAAO,YAAY,KAAK,iBAAiB;GAC1C;GACA;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,GAAG,WAAW,IAAI;GAClB,cAAc,aAAa,KAAK,uBAAuB;IACtD;KACC,MAAM;KACN,QAAQ,CACP,UAAU,UAAU,KAAK,qBAAqB,KAAK,GACnD,GAAG,YAAY,MAAM;MAAE,MAAM;MAAU,OAAO,KAAK;MAAqB,OAAO;KAAM,CAAC,CACvF;IACD;IACA;KACC,MAAM;KACN,QAAQ,CACP,aAAa,UAAU,KAAK,qBAAqB,KAAK,GACtD,aAAa,YAAY,KAAK,uBAAuB,KAAK,CAC3D;IACD;IACA,UAAU;GACX,CAAC;GACD,cAAc,SAAS,KAAK,mBAAmB;IAC9C;KACC,MAAM;KACN,QAAQ,CACP,UAAU,aAAa,KAAK,wBAAwB,KAAK,GACzD,GAAG,YAAY,MAAM;MAAE,MAAM;MAAU,OAAO,KAAK;MAAqB,OAAO;KAAM,CAAC,CACvF;IACD;IACA,GAAG,YAAY,MAAM;KAAE,MAAM;KAAS,OAAO,KAAK;IAAmB,CAAC;IACtE,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,GAAG,KAAK,YAAY;KACnB,MAAM;KACN,MAAM;KACN,OAAO,YAAY,KAAK,uBAAuB;IAChD,CAAC;GACF,CAAC;GACD,cAAc,WAAW,KAAK,qBAAqB;IAClD;KACC,MAAM;KACN,QAAQ,CACP,UAAU,aAAa,KAAK,wBAAwB,KAAK,GACzD,GAAG,YAAY,MAAM;MAAE,MAAM;MAAU,OAAO,KAAK;MAAqB,OAAO;KAAM,CAAC,CACvF;IACD;IACA;KACC,MAAM;KACN,QAAQ,CACP,aAAa,gBAAgB,KAAK,2BAA2B,KAAK,GAClE;MACC,MAAM;MACN,MAAM;MACN,OAAO,YAAY,KAAK,mBAAmB;MAC3C,SAAS,CACR;OAAE,OAAO;OAAM,OAAO;MAAK,GAC3B;OAAE,OAAO;OAAM,OAAO;MAAK,CAC5B;MACA,OAAO,EAAE,OAAO,MAAM;KACvB,CACD;IACD;IACA,UAAU;GACX,CAAC;EACF;CACD;CACA,OAAO,KAAK,YAAY,KAAK,UAAU,UAAU,IAAI;AACtD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"resolver.js","names":[],"sources":["../../src/providers/resolver.ts"],"sourcesContent":["import { createLocalReq, 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 { SECRET_PATHS } 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 * Append runtime adapters after the static base. Ids are disjoint by\n * construction (instance ids carry a ':', config ids do not); an extra that\n * still collides with a base id (a custom providers.resolve returning a plain\n * provider id) is skipped so config adapters always win, and the default\n * adapter is always a config adapter.\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 seen = new Set(base.adapters.map((a) => a.id))\n\tconst merged = [...base.adapters]\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\nconst setAtPath = (doc: Record<string, unknown>, path: string, value: unknown): void => {\n\tconst [group, field] = path.split('.') as [string, string]\n\tconst target = doc[group]\n\tif (target && typeof target === 'object') {\n\t\t;(target as Record<string, unknown>)[field] = value\n\t}\n}\n\nconst getAtPath = (doc: Record<string, unknown>, path: string): unknown => {\n\tconst [group, field] = path.split('.') as [string, string]\n\tconst target = doc[group]\n\treturn target && typeof target === 'object'\n\t\t? (target as Record<string, unknown>)[field]\n\t\t: undefined\n}\n\n/**\n * Look up a scope's enabled provider documents and build adapters from them.\n * Reads raw ciphertext inside a withRawEncrypted window (write-only secrets\n * are stripped from ordinary reads), then decrypts each credential through\n * the fields key ring. Legacy plaintext rows pass through decryptFieldValue\n * unchanged, so pre-encryption documents keep working until re-saved.\n */\nexport const collectionProvidersSource = (slug: string, scopeField: string): ProvidersSource => {\n\treturn async ({ payload, req, scope }) => {\n\t\tconst { decryptFieldValue, withRawEncrypted } = await import('@10x-media/fields/encrypted')\n\t\tconst readReq = req ?? (await createLocalReq({}, payload))\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 withRawEncrypted(readReq, () =>\n\t\t\tpayload.find({\n\t\t\t\tcollection: slug as never,\n\t\t\t\twhere: { and: [{ enabled: { equals: true } }, scopeWhere] },\n\t\t\t\tlimit: 100,\n\t\t\t\tpagination: false,\n\t\t\t\tdepth: 0,\n\t\t\t\toverrideAccess: true,\n\t\t\t\treq: readReq,\n\t\t\t})\n\t\t)\n\t\tconst adapters: AnalyticsAdapter[] = []\n\t\tfor (const raw of docs as Array<Record<string, unknown>>) {\n\t\t\ttry {\n\t\t\t\tconst doc = structuredClone(raw) as Record<string, unknown>\n\t\t\t\tfor (const { path } of SECRET_PATHS) {\n\t\t\t\t\tconst value = getAtPath(doc, path)\n\t\t\t\t\tif (typeof value === 'string' && value !== '') {\n\t\t\t\t\t\tconst plain = await decryptFieldValue(payload, { collection: slug, path, value })\n\t\t\t\t\t\tsetAtPath(doc, path, typeof plain === 'string' ? plain : '')\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tconst adapter = adapterFromProviderDoc(doc as ProviderDoc)\n\t\t\t\tif (adapter) adapters.push(adapter)\n\t\t\t} catch (err) {\n\t\t\t\t// A corrupted or key-rotated-away ciphertext must not take the whole\n\t\t\t\t// scope's registry down; skip just this document's adapter.\n\t\t\t\tpayload.logger.warn(\n\t\t\t\t\t`analytics: provider document \"${String(raw.id)}\" (${String(raw.provider)}) failed to decrypt, skipping it: ${String(err)}`\n\t\t\t\t)\n\t\t\t}\n\t\t}\n\t\treturn adapters\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":";;;;;;;;;;;AA4BA,MAAa,qBACZ,MACA,UACqB;CACrB,IAAI,MAAM,WAAW,GACpB,OAAO,eAAe,KAAK,UAAU,KAAK,SAAS;CAEpD,MAAM,OAAO,IAAI,IAAI,KAAK,SAAS,KAAK,MAAM,EAAE,EAAE,CAAC;CACnD,MAAM,SAAS,CAAC,GAAG,KAAK,QAAQ;CAChC,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;AAEA,MAAM,aAAa,KAA8B,MAAc,UAAyB;CACvF,MAAM,CAAC,OAAO,SAAS,KAAK,MAAM,GAAG;CACrC,MAAM,SAAS,IAAI;CACnB,IAAI,UAAU,OAAO,WAAW,UAC9B,OAAoC,SAAS;AAEhD;AAEA,MAAM,aAAa,KAA8B,SAA0B;CAC1E,MAAM,CAAC,OAAO,SAAS,KAAK,MAAM,GAAG;CACrC,MAAM,SAAS,IAAI;CACnB,OAAO,UAAU,OAAO,WAAW,WAC/B,OAAmC,SACpC,KAAA;AACJ;;;;;;;;AASA,MAAa,6BAA6B,MAAc,eAAwC;CAC/F,OAAO,OAAO,EAAE,SAAS,KAAK,YAAY;EACzC,MAAM,EAAE,mBAAmB,qBAAqB,MAAM,OAAO;EAC7D,MAAM,UAAU,OAAQ,MAAM,eAAe,CAAC,GAAG,OAAO;
|
|
1
|
+
{"version":3,"file":"resolver.js","names":[],"sources":["../../src/providers/resolver.ts"],"sourcesContent":["import { createLocalReq, 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 { SECRET_PATHS } 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 * Append runtime adapters after the static base. Ids are disjoint by\n * construction (instance ids carry a ':', config ids do not); an extra that\n * still collides with a base id (a custom providers.resolve returning a plain\n * provider id) is skipped so config adapters always win, and the default\n * adapter is always a config adapter.\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 seen = new Set(base.adapters.map((a) => a.id))\n\tconst merged = [...base.adapters]\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\nconst setAtPath = (doc: Record<string, unknown>, path: string, value: unknown): void => {\n\tconst [group, field] = path.split('.') as [string, string]\n\tconst target = doc[group]\n\tif (target && typeof target === 'object') {\n\t\t;(target as Record<string, unknown>)[field] = value\n\t}\n}\n\nconst getAtPath = (doc: Record<string, unknown>, path: string): unknown => {\n\tconst [group, field] = path.split('.') as [string, string]\n\tconst target = doc[group]\n\treturn target && typeof target === 'object'\n\t\t? (target as Record<string, unknown>)[field]\n\t\t: undefined\n}\n\n/**\n * Look up a scope's enabled provider documents and build adapters from them.\n * Reads raw ciphertext inside a withRawEncrypted window (write-only secrets\n * are stripped from ordinary reads), then decrypts each credential through\n * the fields key ring. Legacy plaintext rows pass through decryptFieldValue\n * unchanged, so pre-encryption documents keep working until re-saved.\n */\nexport const collectionProvidersSource = (slug: string, scopeField: string): ProvidersSource => {\n\treturn async ({ payload, req, scope }) => {\n\t\tconst { decryptFieldValue, withRawEncrypted } = await import('@10x-media/fields/encrypted')\n\t\tconst readReq = req ?? (await createLocalReq({}, payload))\n\t\t// The empty string is not castable on a relationship-typed scopeField, so install-wide\n\t\t// lookups on a host-owned relationship field resolve the config adapters only.\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 withRawEncrypted(readReq, () =>\n\t\t\tpayload.find({\n\t\t\t\tcollection: slug as never,\n\t\t\t\twhere: { and: [{ enabled: { equals: true } }, scopeWhere] },\n\t\t\t\tlimit: 100,\n\t\t\t\tpagination: false,\n\t\t\t\tdepth: 0,\n\t\t\t\toverrideAccess: true,\n\t\t\t\treq: readReq,\n\t\t\t})\n\t\t)\n\t\tconst adapters: AnalyticsAdapter[] = []\n\t\tfor (const raw of docs as Array<Record<string, unknown>>) {\n\t\t\ttry {\n\t\t\t\tconst doc = structuredClone(raw) as Record<string, unknown>\n\t\t\t\tfor (const { path } of SECRET_PATHS) {\n\t\t\t\t\tconst value = getAtPath(doc, path)\n\t\t\t\t\tif (typeof value === 'string' && value !== '') {\n\t\t\t\t\t\tconst plain = await decryptFieldValue(payload, { collection: slug, path, value })\n\t\t\t\t\t\tsetAtPath(doc, path, typeof plain === 'string' ? plain : '')\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tconst adapter = adapterFromProviderDoc(doc as ProviderDoc)\n\t\t\t\tif (adapter) adapters.push(adapter)\n\t\t\t} catch (err) {\n\t\t\t\t// A corrupted or key-rotated-away ciphertext must not take the whole\n\t\t\t\t// scope's registry down; skip just this document's adapter.\n\t\t\t\tpayload.logger.warn(\n\t\t\t\t\t`analytics: provider document \"${String(raw.id)}\" (${String(raw.provider)}) failed to decrypt, skipping it: ${String(err)}`\n\t\t\t\t)\n\t\t\t}\n\t\t}\n\t\treturn adapters\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":";;;;;;;;;;;AA4BA,MAAa,qBACZ,MACA,UACqB;CACrB,IAAI,MAAM,WAAW,GACpB,OAAO,eAAe,KAAK,UAAU,KAAK,SAAS;CAEpD,MAAM,OAAO,IAAI,IAAI,KAAK,SAAS,KAAK,MAAM,EAAE,EAAE,CAAC;CACnD,MAAM,SAAS,CAAC,GAAG,KAAK,QAAQ;CAChC,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;AAEA,MAAM,aAAa,KAA8B,MAAc,UAAyB;CACvF,MAAM,CAAC,OAAO,SAAS,KAAK,MAAM,GAAG;CACrC,MAAM,SAAS,IAAI;CACnB,IAAI,UAAU,OAAO,WAAW,UAC9B,OAAoC,SAAS;AAEhD;AAEA,MAAM,aAAa,KAA8B,SAA0B;CAC1E,MAAM,CAAC,OAAO,SAAS,KAAK,MAAM,GAAG;CACrC,MAAM,SAAS,IAAI;CACnB,OAAO,UAAU,OAAO,WAAW,WAC/B,OAAmC,SACpC,KAAA;AACJ;;;;;;;;AASA,MAAa,6BAA6B,MAAc,eAAwC;CAC/F,OAAO,OAAO,EAAE,SAAS,KAAK,YAAY;EACzC,MAAM,EAAE,mBAAmB,qBAAqB,MAAM,OAAO;EAC7D,MAAM,UAAU,OAAQ,MAAM,eAAe,CAAC,GAAG,OAAO;EAGxD,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,iBAAiB,eACvC,QAAQ,KAAK;GACZ,YAAY;GACZ,OAAO,EAAE,KAAK,CAAC,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,GAAG,UAAU,EAAE;GAC1D,OAAO;GACP,YAAY;GACZ,OAAO;GACP,gBAAgB;GAChB,KAAK;EACN,CAAC,CACF;EACA,MAAM,WAA+B,CAAC;EACtC,KAAK,MAAM,OAAO,MACjB,IAAI;GACH,MAAM,MAAM,gBAAgB,GAAG;GAC/B,KAAK,MAAM,EAAE,UAAU,cAAc;IACpC,MAAM,QAAQ,UAAU,KAAK,IAAI;IACjC,IAAI,OAAO,UAAU,YAAY,UAAU,IAAI;KAC9C,MAAM,QAAQ,MAAM,kBAAkB,SAAS;MAAE,YAAY;MAAM;MAAM;KAAM,CAAC;KAChF,UAAU,KAAK,MAAM,OAAO,UAAU,WAAW,QAAQ,EAAE;IAC5D;GACD;GACA,MAAM,UAAU,uBAAuB,GAAkB;GACzD,IAAI,SAAS,SAAS,KAAK,OAAO;EACnC,SAAS,KAAK;GAGb,QAAQ,OAAO,KACd,iCAAiC,OAAO,IAAI,EAAE,EAAE,KAAK,OAAO,IAAI,QAAQ,EAAE,oCAAoC,OAAO,GAAG,GACzH;EACD;EAED,OAAO;CACR;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,64 @@
|
|
|
1
|
+
import { addDaysInTz, startOfCalendarDayInTz } from "../timeframe/tz.js";
|
|
2
|
+
//#region src/query/dates.ts
|
|
3
|
+
/**
|
|
4
|
+
* Range-bound parsing, shared by every surface that takes `from`/`to` from outside: the
|
|
5
|
+
* query endpoint's parser, the document panel endpoint, and the widgets' stored custom
|
|
6
|
+
* range. A leaf module so those cannot drift apart on what a calendar day means.
|
|
7
|
+
*/
|
|
8
|
+
/** The only offset-free bound form: a `YYYY-MM-DD` calendar day. */
|
|
9
|
+
const DATE_ONLY = /^\d{4}-\d{2}-\d{2}$/;
|
|
10
|
+
const DATE_TIME = /^(\d{4}-\d{2}-\d{2})T\d{2}:\d{2}(:\d{2}(\.\d{1,9})?)?([Zz]|[+-]\d{2}:\d{2})$/;
|
|
11
|
+
const DAYS_IN_MONTH = [
|
|
12
|
+
31,
|
|
13
|
+
28,
|
|
14
|
+
31,
|
|
15
|
+
30,
|
|
16
|
+
31,
|
|
17
|
+
30,
|
|
18
|
+
31,
|
|
19
|
+
31,
|
|
20
|
+
30,
|
|
21
|
+
31,
|
|
22
|
+
30,
|
|
23
|
+
31
|
|
24
|
+
];
|
|
25
|
+
const isLeapYear = (year) => year % 4 === 0 && year % 100 !== 0 || year % 400 === 0;
|
|
26
|
+
/** Calendar parts of a `YYYY-MM-DD` string, or null when it names no real day. */
|
|
27
|
+
const calendarParts = (raw) => {
|
|
28
|
+
const year = Number(raw.slice(0, 4));
|
|
29
|
+
const month = Number(raw.slice(5, 7));
|
|
30
|
+
const day = Number(raw.slice(8, 10));
|
|
31
|
+
if (month < 1 || month > 12) return null;
|
|
32
|
+
const lastDay = month === 2 && isLeapYear(year) ? 29 : DAYS_IN_MONTH[month - 1];
|
|
33
|
+
if (lastDay === void 0 || day < 1 || day > lastDay) return null;
|
|
34
|
+
return {
|
|
35
|
+
year,
|
|
36
|
+
month,
|
|
37
|
+
day
|
|
38
|
+
};
|
|
39
|
+
};
|
|
40
|
+
/**
|
|
41
|
+
* A range bound. `YYYY-MM-DD` is the whole calendar day in `timezone`: the start edge is
|
|
42
|
+
* its first instant, the end edge its last, matching the inclusive `end` every adapter
|
|
43
|
+
* reads (`less_than_equal`, `timestamp <=`, GA4's inclusive `endDate`). The only other
|
|
44
|
+
* accepted form is a full datetime carrying `Z` or a `±HH:MM` offset, taken as the instant
|
|
45
|
+
* it names. A datetime without an offset is rejected rather than silently read in the
|
|
46
|
+
* server's own zone, and so are the loose forms `Date` would otherwise accept (`2026`,
|
|
47
|
+
* `Sep 1 2026`).
|
|
48
|
+
*/
|
|
49
|
+
const parseDayOrInstant = (raw, args) => {
|
|
50
|
+
if (DATE_ONLY.test(raw)) {
|
|
51
|
+
const ymd = calendarParts(raw);
|
|
52
|
+
if (!ymd) return null;
|
|
53
|
+
const dayStart = startOfCalendarDayInTz(ymd, args.timezone);
|
|
54
|
+
return args.edge === "start" ? dayStart : /* @__PURE__ */ new Date(addDaysInTz(dayStart, 1, args.timezone).getTime() - 1);
|
|
55
|
+
}
|
|
56
|
+
const datePart = DATE_TIME.exec(raw)?.[1];
|
|
57
|
+
if (datePart === void 0 || !calendarParts(datePart)) return null;
|
|
58
|
+
const parsed = new Date(raw);
|
|
59
|
+
return Number.isNaN(parsed.getTime()) ? null : parsed;
|
|
60
|
+
};
|
|
61
|
+
//#endregion
|
|
62
|
+
export { DATE_ONLY, parseDayOrInstant };
|
|
63
|
+
|
|
64
|
+
//# sourceMappingURL=dates.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"dates.js","names":[],"sources":["../../src/query/dates.ts"],"sourcesContent":["import { addDaysInTz, startOfCalendarDayInTz } from '../timeframe/tz'\n\n/**\n * Range-bound parsing, shared by every surface that takes `from`/`to` from outside: the\n * query endpoint's parser, the document panel endpoint, and the widgets' stored custom\n * range. A leaf module so those cannot drift apart on what a calendar day means.\n */\n\n/** The only offset-free bound form: a `YYYY-MM-DD` calendar day. */\nexport const DATE_ONLY = /^\\d{4}-\\d{2}-\\d{2}$/\n\n// Fractional seconds run to nanoseconds because Python emits microseconds; `Date` truncates.\nconst DATE_TIME = /^(\\d{4}-\\d{2}-\\d{2})T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,9})?)?([Zz]|[+-]\\d{2}:\\d{2})$/\n\nconst DAYS_IN_MONTH = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]\n\nconst isLeapYear = (year: number): boolean =>\n\t(year % 4 === 0 && year % 100 !== 0) || year % 400 === 0\n\n/** Calendar parts of a `YYYY-MM-DD` string, or null when it names no real day. */\nconst calendarParts = (raw: string): { year: number; month: number; day: number } | null => {\n\tconst year = Number(raw.slice(0, 4))\n\tconst month = Number(raw.slice(5, 7))\n\tconst day = Number(raw.slice(8, 10))\n\tif (month < 1 || month > 12) {\n\t\treturn null\n\t}\n\tconst lastDay = month === 2 && isLeapYear(year) ? 29 : DAYS_IN_MONTH[month - 1]\n\tif (lastDay === undefined || day < 1 || day > lastDay) {\n\t\treturn null\n\t}\n\treturn { year, month, day }\n}\n\nexport interface BoundArgs {\n\t/** Reporting timezone a day string is read in; ignored for an instant. */\n\ttimezone: string\n\t/** Which end of the window this value bounds. */\n\tedge: 'start' | 'end'\n}\n\n/**\n * A range bound. `YYYY-MM-DD` is the whole calendar day in `timezone`: the start edge is\n * its first instant, the end edge its last, matching the inclusive `end` every adapter\n * reads (`less_than_equal`, `timestamp <=`, GA4's inclusive `endDate`). The only other\n * accepted form is a full datetime carrying `Z` or a `±HH:MM` offset, taken as the instant\n * it names. A datetime without an offset is rejected rather than silently read in the\n * server's own zone, and so are the loose forms `Date` would otherwise accept (`2026`,\n * `Sep 1 2026`).\n */\nexport const parseDayOrInstant = (raw: string, args: BoundArgs): Date | null => {\n\tif (DATE_ONLY.test(raw)) {\n\t\tconst ymd = calendarParts(raw)\n\t\tif (!ymd) {\n\t\t\treturn null\n\t\t}\n\t\tconst dayStart = startOfCalendarDayInTz(ymd, args.timezone)\n\t\treturn args.edge === 'start'\n\t\t\t? dayStart\n\t\t\t: new Date(addDaysInTz(dayStart, 1, args.timezone).getTime() - 1)\n\t}\n\tconst datePart = DATE_TIME.exec(raw)?.[1]\n\tif (datePart === undefined || !calendarParts(datePart)) {\n\t\treturn null\n\t}\n\tconst parsed = new Date(raw)\n\treturn Number.isNaN(parsed.getTime()) ? null : parsed\n}\n"],"mappings":";;;;;;;;AASA,MAAa,YAAY;AAGzB,MAAM,YAAY;AAElB,MAAM,gBAAgB;CAAC;CAAI;CAAI;CAAI;CAAI;CAAI;CAAI;CAAI;CAAI;CAAI;CAAI;CAAI;AAAE;AAErE,MAAM,cAAc,SAClB,OAAO,MAAM,KAAK,OAAO,QAAQ,KAAM,OAAO,QAAQ;;AAGxD,MAAM,iBAAiB,QAAqE;CAC3F,MAAM,OAAO,OAAO,IAAI,MAAM,GAAG,CAAC,CAAC;CACnC,MAAM,QAAQ,OAAO,IAAI,MAAM,GAAG,CAAC,CAAC;CACpC,MAAM,MAAM,OAAO,IAAI,MAAM,GAAG,EAAE,CAAC;CACnC,IAAI,QAAQ,KAAK,QAAQ,IACxB,OAAO;CAER,MAAM,UAAU,UAAU,KAAK,WAAW,IAAI,IAAI,KAAK,cAAc,QAAQ;CAC7E,IAAI,YAAY,KAAA,KAAa,MAAM,KAAK,MAAM,SAC7C,OAAO;CAER,OAAO;EAAE;EAAM;EAAO;CAAI;AAC3B;;;;;;;;;;AAkBA,MAAa,qBAAqB,KAAa,SAAiC;CAC/E,IAAI,UAAU,KAAK,GAAG,GAAG;EACxB,MAAM,MAAM,cAAc,GAAG;EAC7B,IAAI,CAAC,KACJ,OAAO;EAER,MAAM,WAAW,uBAAuB,KAAK,KAAK,QAAQ;EAC1D,OAAO,KAAK,SAAS,UAClB,2BACA,IAAI,KAAK,YAAY,UAAU,GAAG,KAAK,QAAQ,EAAE,QAAQ,IAAI,CAAC;CAClE;CACA,MAAM,WAAW,UAAU,KAAK,GAAG,IAAI;CACvC,IAAI,aAAa,KAAA,KAAa,CAAC,cAAc,QAAQ,GACpD,OAAO;CAER,MAAM,SAAS,IAAI,KAAK,GAAG;CAC3B,OAAO,OAAO,MAAM,OAAO,QAAQ,CAAC,IAAI,OAAO;AAChD"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
//#region src/query/errors.d.ts
|
|
2
|
+
/**
|
|
3
|
+
* The query endpoint's whole error vocabulary. The parameter parser raises only the
|
|
4
|
+
* `400` codes; the handler raises the rest: `unauthorized` (`401`), `forbidden` (`403`,
|
|
5
|
+
* `access.read` or a cross-scope read the caller may not make), `unknown_source`
|
|
6
|
+
* (`404`), `untrusted_scope` (`400`), `unavailable` (`503`) and `internal` (`500`).
|
|
7
|
+
*/
|
|
8
|
+
type QueryErrorCode = 'invalid_param' | 'unsupported_metric' | 'unsupported_dimension' | 'unsupported_filter' | 'unsupported_operator' | 'unsupported_granularity' | 'range_too_long' | 'unknown_source' | 'untrusted_scope' | 'unauthorized' | 'forbidden' | 'unavailable' | 'internal';
|
|
9
|
+
/** Wire shape of a rejected read: `param` names the query parameter at fault. */
|
|
10
|
+
interface QueryError {
|
|
11
|
+
code: QueryErrorCode;
|
|
12
|
+
message: string;
|
|
13
|
+
param?: string;
|
|
14
|
+
}
|
|
15
|
+
//#endregion
|
|
16
|
+
export { QueryError, QueryErrorCode };
|
|
17
|
+
//# sourceMappingURL=errors.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"errors.js","names":[],"sources":["../../src/query/errors.ts"],"sourcesContent":["/**\n * The query endpoint's whole error vocabulary. The parameter parser raises only the\n * `400` codes; the handler raises the rest: `unauthorized` (`401`), `forbidden` (`403`,\n * `access.read` or a cross-scope read the caller may not make), `unknown_source`\n * (`404`), `untrusted_scope` (`400`), `unavailable` (`503`) and `internal` (`500`).\n */\nexport type QueryErrorCode =\n\t| 'invalid_param'\n\t| 'unsupported_metric'\n\t| 'unsupported_dimension'\n\t| 'unsupported_filter'\n\t| 'unsupported_operator'\n\t| 'unsupported_granularity'\n\t| 'range_too_long'\n\t| 'unknown_source'\n\t| 'untrusted_scope'\n\t| 'unauthorized'\n\t| 'forbidden'\n\t| 'unavailable'\n\t| 'internal'\n\n/** Wire shape of a rejected read: `param` names the query parameter at fault. */\nexport interface QueryError {\n\tcode: QueryErrorCode\n\tmessage: string\n\tparam?: string\n}\n\nexport const queryError = (code: QueryErrorCode, message: string, param?: string): QueryError => ({\n\tcode,\n\tmessage,\n\t...(param === undefined ? {} : { param }),\n})\n"],"mappings":";AA4BA,MAAa,cAAc,MAAsB,SAAiB,WAAgC;CACjG;CACA;CACA,GAAI,UAAU,KAAA,IAAY,CAAC,IAAI,EAAE,MAAM;AACxC"}
|