@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 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cacheKey.js","names":[],"sources":["../../src/core/cacheKey.ts"],"sourcesContent":["import { addDaysInTz, DEFAULT_TIMEZONE, startOfDayInTz } from '../timeframe/tz'\nimport type { AnalyticsQuery } from './contract'\n\nconst stable = (xs?: string[]): string => (xs ? [...xs].sort().join(',') : '')\n\nexport function buildCacheKey(provider: string, q: AnalyticsQuery): string {\n\tconst pathKey = q.path ?? 'site'\n\tconst tz = q.timezone ?? DEFAULT_TIMEZONE\n\tconst range =
|
|
1
|
+
{"version":3,"file":"cacheKey.js","names":[],"sources":["../../src/core/cacheKey.ts"],"sourcesContent":["import { addDaysInTz, DEFAULT_TIMEZONE, startOfDayInTz } from '../timeframe/tz'\nimport type { AnalyticsQuery } from './contract'\n\nconst stable = (xs?: string[]): string => (xs ? [...xs].sort().join(',') : '')\n\n/**\n * The window segment. A live window (a preset ends at `now`) snaps to whole days, so every\n * render within one day shares one entry. A closed window, whose end is the final instant\n * of its day in `tz`, keys on its exact bounds instead: snapping those too would let two\n * windows that differ only inside their last day share an entry, and an instant-comparing\n * adapter read the narrower one's answer.\n */\nconst rangeKey = (range: AnalyticsQuery['dateRange'], tz: string): string => {\n\tconst nextDay = addDaysInTz(range.end, 1, tz)\n\tif (nextDay.getTime() - 1 === range.end.getTime()) {\n\t\treturn `${range.start.toISOString()}_${range.end.toISOString()}`\n\t}\n\treturn `${startOfDayInTz(range.start, tz).toISOString()}_${nextDay.toISOString()}`\n}\n\nexport function buildCacheKey(provider: string, q: AnalyticsQuery): string {\n\tconst pathKey = q.path ?? 'site'\n\tconst tz = q.timezone ?? DEFAULT_TIMEZONE\n\tconst range = rangeKey(q.dateRange, tz)\n\tconst filters = (q.filters ?? [])\n\t\t.map((f) => `${f.dimension}${f.operator}${f.value}`)\n\t\t.sort()\n\t\t.join(';')\n\treturn [\n\t\t'analytics',\n\t\tprovider,\n\t\tq.hostname ?? '_',\n\t\tpathKey,\n\t\tstable(q.metrics),\n\t\tstable(q.dimensions),\n\t\trange,\n\t\tq.granularity ?? '_',\n\t\tfilters,\n\t\tString(q.limit ?? '_'),\n\t\tq.order ? `${q.order.metric}:${q.order.direction}` : '_',\n\t\t// Appended only for a non-UTC timezone so default (UTC) keys keep their format.\n\t\t...(q.timezone !== undefined && q.timezone !== DEFAULT_TIMEZONE ? [q.timezone] : []),\n\t\t...(q.scope !== undefined ? [encodeURIComponent(q.scope)] : []),\n\t].join('|')\n}\n"],"mappings":";;AAGA,MAAM,UAAU,OAA2B,KAAK,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI;;;;;;;;AAS3E,MAAM,YAAY,OAAoC,OAAuB;CAC5E,MAAM,UAAU,YAAY,MAAM,KAAK,GAAG,EAAE;CAC5C,IAAI,QAAQ,QAAQ,IAAI,MAAM,MAAM,IAAI,QAAQ,GAC/C,OAAO,GAAG,MAAM,MAAM,YAAY,EAAE,GAAG,MAAM,IAAI,YAAY;CAE9D,OAAO,GAAG,eAAe,MAAM,OAAO,EAAE,EAAE,YAAY,EAAE,GAAG,QAAQ,YAAY;AAChF;AAEA,SAAgB,cAAc,UAAkB,GAA2B;CAC1E,MAAM,UAAU,EAAE,QAAQ;CAC1B,MAAM,KAAK,EAAE,YAAA;CACb,MAAM,QAAQ,SAAS,EAAE,WAAW,EAAE;CACtC,MAAM,WAAW,EAAE,WAAW,CAAC,GAC7B,KAAK,MAAM,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,OAAO,EAClD,KAAK,EACL,KAAK,GAAG;CACV,OAAO;EACN;EACA;EACA,EAAE,YAAY;EACd;EACA,OAAO,EAAE,OAAO;EAChB,OAAO,EAAE,UAAU;EACnB;EACA,EAAE,eAAe;EACjB;EACA,OAAO,EAAE,SAAS,GAAG;EACrB,EAAE,QAAQ,GAAG,EAAE,MAAM,OAAO,GAAG,EAAE,MAAM,cAAc;EAErD,GAAI,EAAE,aAAa,KAAA,KAAa,EAAE,aAAA,QAAgC,CAAC,EAAE,QAAQ,IAAI,CAAC;EAClF,GAAI,EAAE,UAAU,KAAA,IAAY,CAAC,mBAAmB,EAAE,KAAK,CAAC,IAAI,CAAC;CAC9D,EAAE,KAAK,GAAG;AACX"}
|
package/dist/core/contract.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { Goal } from "../goals/types.js";
|
|
2
2
|
import { CaptureSupport } from "./capture.js";
|
|
3
|
+
import { ServerTrack } from "./serverEvent.js";
|
|
3
4
|
import { Config, PayloadRequest } from "payload";
|
|
4
5
|
|
|
5
6
|
//#region src/core/contract.d.ts
|
|
@@ -9,13 +10,17 @@ import { Config, PayloadRequest } from "payload";
|
|
|
9
10
|
*/
|
|
10
11
|
declare const PLATFORM_SCOPE = "*";
|
|
11
12
|
type MetricKey = 'pageviews' | 'visitors' | 'visits' | 'sessions' | 'bounceRate' | 'avgDuration' | 'scrollDepth' | 'events' | 'conversions' | 'revenue';
|
|
12
|
-
|
|
13
|
+
/** Every breakdown key the contract defines; the registry request parsers validate against. */
|
|
14
|
+
declare const DIMENSION_KEYS: readonly ["page", "referrer", "source", "medium", "campaign", "utmSource", "utmMedium", "utmCampaign", "utmContent", "utmTerm", "device", "browser", "os", "country", "region", "city", "language", "event", "goal"];
|
|
15
|
+
type DimensionKey = (typeof DIMENSION_KEYS)[number];
|
|
13
16
|
type Granularity = 'minute' | 'hour' | 'day' | 'week' | 'month';
|
|
14
17
|
interface DateRange {
|
|
15
18
|
start: Date;
|
|
16
19
|
end: Date;
|
|
17
20
|
}
|
|
18
|
-
|
|
21
|
+
/** Every filter operator the contract defines; the registry request parsers validate against. */
|
|
22
|
+
declare const FILTER_OPERATORS: readonly ["eq", "contains", "matches"];
|
|
23
|
+
type FilterOperator = (typeof FILTER_OPERATORS)[number];
|
|
19
24
|
interface AnalyticsFilter {
|
|
20
25
|
dimension: DimensionKey;
|
|
21
26
|
operator: FilterOperator;
|
|
@@ -119,8 +124,8 @@ interface AdapterRegisterContext {
|
|
|
119
124
|
resolveTimezone: (req: PayloadRequest, scope?: string | null) => Promise<string>;
|
|
120
125
|
/**
|
|
121
126
|
* The install's goals for a request's scope, for adapters that match completions
|
|
122
|
-
* themselves (the native engine, at ingest). Config goals
|
|
123
|
-
*
|
|
127
|
+
* themselves (the native engine, at ingest). Config goals, with the goals collection
|
|
128
|
+
* merged over them per scope once the install enables it.
|
|
124
129
|
*/
|
|
125
130
|
resolveGoals: (req: PayloadRequest, scope?: string | null) => Promise<Goal[]>;
|
|
126
131
|
}
|
|
@@ -132,11 +137,13 @@ interface AnalyticsAdapter {
|
|
|
132
137
|
readonly capture?: CaptureSupport;
|
|
133
138
|
/**
|
|
134
139
|
* Where this adapter's own ingest endpoint listens, relative to `routes.api`, for the
|
|
135
|
-
* adapters that register one (the native engine)
|
|
136
|
-
*
|
|
140
|
+
* adapters that register one (the native engine), and how server code reaches the same
|
|
141
|
+
* pipeline without an HTTP round trip. Server-side only: the tracker learns the path
|
|
142
|
+
* from `TrackerConfig.ingestPath`, and this object is never serialized.
|
|
137
143
|
*/
|
|
138
144
|
readonly ingest?: {
|
|
139
145
|
path: string;
|
|
146
|
+
track?: ServerTrack;
|
|
140
147
|
};
|
|
141
148
|
isConfigured(): boolean;
|
|
142
149
|
query(query: AnalyticsQuery, ctx: AdapterContext): Promise<AnalyticsResult>;
|
|
@@ -145,5 +152,5 @@ interface AnalyticsAdapter {
|
|
|
145
152
|
}
|
|
146
153
|
type AnalyticsAdapterFactory<Config> = (config: Config) => AnalyticsAdapter;
|
|
147
154
|
//#endregion
|
|
148
|
-
export { AdapterContext, AdapterRegisterContext, AnalyticsAdapter, AnalyticsAdapterFactory, AnalyticsCapabilities, AnalyticsFilter, AnalyticsQuery, AnalyticsResult, AnalyticsRow, DateRange, DimensionKey, FilterOperator, Granularity, MetricKey, PLATFORM_SCOPE, RateLimitDescriptor };
|
|
155
|
+
export { AdapterContext, AdapterRegisterContext, AnalyticsAdapter, AnalyticsAdapterFactory, AnalyticsCapabilities, AnalyticsFilter, AnalyticsQuery, AnalyticsResult, AnalyticsRow, DIMENSION_KEYS, DateRange, DimensionKey, FILTER_OPERATORS, FilterOperator, Granularity, MetricKey, PLATFORM_SCOPE, RateLimitDescriptor };
|
|
149
156
|
//# sourceMappingURL=contract.d.ts.map
|
package/dist/core/contract.js
CHANGED
|
@@ -4,7 +4,35 @@
|
|
|
4
4
|
* scope. Gated by `access.platformRead`; the query reaches the adapter unscoped.
|
|
5
5
|
*/
|
|
6
6
|
const PLATFORM_SCOPE = "*";
|
|
7
|
+
/** Every breakdown key the contract defines; the registry request parsers validate against. */
|
|
8
|
+
const DIMENSION_KEYS = [
|
|
9
|
+
"page",
|
|
10
|
+
"referrer",
|
|
11
|
+
"source",
|
|
12
|
+
"medium",
|
|
13
|
+
"campaign",
|
|
14
|
+
"utmSource",
|
|
15
|
+
"utmMedium",
|
|
16
|
+
"utmCampaign",
|
|
17
|
+
"utmContent",
|
|
18
|
+
"utmTerm",
|
|
19
|
+
"device",
|
|
20
|
+
"browser",
|
|
21
|
+
"os",
|
|
22
|
+
"country",
|
|
23
|
+
"region",
|
|
24
|
+
"city",
|
|
25
|
+
"language",
|
|
26
|
+
"event",
|
|
27
|
+
"goal"
|
|
28
|
+
];
|
|
29
|
+
/** Every filter operator the contract defines; the registry request parsers validate against. */
|
|
30
|
+
const FILTER_OPERATORS = [
|
|
31
|
+
"eq",
|
|
32
|
+
"contains",
|
|
33
|
+
"matches"
|
|
34
|
+
];
|
|
7
35
|
//#endregion
|
|
8
|
-
export { PLATFORM_SCOPE };
|
|
36
|
+
export { DIMENSION_KEYS, FILTER_OPERATORS, PLATFORM_SCOPE };
|
|
9
37
|
|
|
10
38
|
//# sourceMappingURL=contract.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contract.js","names":[],"sources":["../../src/core/contract.ts"],"sourcesContent":["import type { Config, PayloadRequest } from 'payload'\nimport type { Goal } from '../goals/types'\nimport type { CaptureSupport } from './capture'\n\n/**\n * Explicit cross-scope read marker: pass as a read's `scope` to aggregate over every\n * scope. Gated by `access.platformRead`; the query reaches the adapter unscoped.\n */\nexport const PLATFORM_SCOPE = '*'\n\nexport type MetricKey =\n\t| 'pageviews'\n\t| 'visitors'\n\t| 'visits'\n\t| 'sessions'\n\t| 'bounceRate'\n\t| 'avgDuration'\n\t| 'scrollDepth'\n\t| 'events'\n\t| 'conversions'\n\t| 'revenue'\n\nexport
|
|
1
|
+
{"version":3,"file":"contract.js","names":[],"sources":["../../src/core/contract.ts"],"sourcesContent":["import type { Config, PayloadRequest } from 'payload'\nimport type { Goal } from '../goals/types'\nimport type { CaptureSupport } from './capture'\nimport type { ServerTrack } from './serverEvent'\n\n/**\n * Explicit cross-scope read marker: pass as a read's `scope` to aggregate over every\n * scope. Gated by `access.platformRead`; the query reaches the adapter unscoped.\n */\nexport const PLATFORM_SCOPE = '*'\n\nexport type MetricKey =\n\t| 'pageviews'\n\t| 'visitors'\n\t| 'visits'\n\t| 'sessions'\n\t| 'bounceRate'\n\t| 'avgDuration'\n\t| 'scrollDepth'\n\t| 'events'\n\t| 'conversions'\n\t| 'revenue'\n\n/** Every breakdown key the contract defines; the registry request parsers validate against. */\nexport const DIMENSION_KEYS = [\n\t'page',\n\t'referrer',\n\t'source',\n\t'medium',\n\t'campaign',\n\t'utmSource',\n\t'utmMedium',\n\t'utmCampaign',\n\t'utmContent',\n\t'utmTerm',\n\t'device',\n\t'browser',\n\t'os',\n\t'country',\n\t'region',\n\t'city',\n\t'language',\n\t'event',\n\t'goal',\n] as const\n\nexport type DimensionKey = (typeof DIMENSION_KEYS)[number]\n\nexport type Granularity = 'minute' | 'hour' | 'day' | 'week' | 'month'\n\nexport interface DateRange {\n\tstart: Date\n\tend: Date\n}\n\n/** Every filter operator the contract defines; the registry request parsers validate against. */\nexport const FILTER_OPERATORS = ['eq', 'contains', 'matches'] as const\n\nexport type FilterOperator = (typeof FILTER_OPERATORS)[number]\n\nexport interface AnalyticsFilter {\n\tdimension: DimensionKey\n\toperator: FilterOperator\n\tvalue: string\n}\n\nexport interface AnalyticsQuery {\n\tpath?: string\n\thostname?: string\n\tmetrics: MetricKey[]\n\tdimensions?: DimensionKey[]\n\tdateRange: DateRange\n\tgranularity?: Granularity\n\tfilters?: AnalyticsFilter[]\n\tlimit?: number\n\torder?: { metric: MetricKey; direction: 'asc' | 'desc' }\n\t/**\n\t * Analytics boundary this read belongs to (tenant id, site key). Undefined means\n\t * install-wide (the default). Adapters that can filter by scope apply it; others\n\t * ignore it. Always part of the surfacing cache key, so per-scope adapter\n\t * instances sharing an id never share cached results.\n\t */\n\tscope?: string\n\t/**\n\t * IANA reporting timezone the read's day boundaries are aligned to. Undefined\n\t * means UTC. Adapters that can bucket in a timezone apply it (PostHog, Umami);\n\t * others report in their own account timezone. Part of the cache key when set.\n\t */\n\ttimezone?: string\n}\n\nexport interface AnalyticsRow {\n\tdimensions?: Partial<Record<DimensionKey, string>>\n\tmetrics: Partial<Record<MetricKey, number>>\n\ttimestamp?: string\n}\n\nexport interface AnalyticsResult {\n\trows: AnalyticsRow[]\n\ttotals?: Partial<Record<MetricKey, number>>\n\tmeta: {\n\t\tprovider: string\n\t\tsampled?: boolean\n\t\tclamped?: boolean\n\t\tfetchedAt: string\n\t\t/** Served from an expired cache entry because the live refresh failed. */\n\t\tstale?: boolean\n\t}\n}\n\nexport interface RateLimitDescriptor {\n\trequestsPerMinute?: number\n\trequestsPerHour?: number\n\tmaxConcurrent?: number\n\t/**\n\t * Describes the provider's quota model for documentation; the limiter always\n\t * throttles by request count regardless of this value.\n\t */\n\tquotaModel?: 'requests' | 'tokens'\n\t/** Documents whether reads consume the provider's write/ingest quota too. */\n\treadsCountAsUsage?: boolean\n}\n\nexport interface AnalyticsCapabilities {\n\tperPageQuery: boolean\n\trealtime: boolean\n\trealtimeWindowMinutes?: number\n\tcomparison: boolean\n\tminGranularity: Granularity\n\tmaxLookbackDays: number | null\n\tmetrics: ReadonlySet<MetricKey>\n\tdimensions: ReadonlySet<DimensionKey>\n\t/** Dimensions the adapter can apply AnalyticsQuery.filters on; empty = filters unsupported. */\n\tfilters: ReadonlySet<DimensionKey>\n\t/** Operators the adapter honors in filters; adapters ignore filters whose operator they lack. */\n\tfilterOperators: ReadonlySet<FilterOperator>\n\tbatchPageReport: boolean\n\trateLimit: RateLimitDescriptor | null\n\trecommendedTtl: { realtime: number; aggregate: number }\n\t/**\n\t * The adapter applies `AnalyticsQuery.scope` as a provider-native filter (native\n\t * scope column, PostHog `scopeProperty`, ...). Without it, a scoped read through\n\t * a shared platform adapter would expose cross-scope data, so such reads are\n\t * gated by `access.platformRead`.\n\t */\n\tscopedQueries?: boolean\n}\n\nexport interface AdapterContext {\n\tsignal?: AbortSignal\n}\n\n/** Extra context the plugin hands adapters when they register config surface. */\nexport interface AdapterRegisterContext {\n\t/** True when the plugin has a scopeResolver configured. */\n\tscoped: boolean\n\t/** The plugin's scopeResolver bound for adapter use (e.g. ingest stamping). */\n\tresolveScope: (req: PayloadRequest) => Promise<string | null>\n\t/**\n\t * The plugin's reportingTimezone bound for adapter use (e.g. bucketing native\n\t * rollups at ingest). Resolves to `'UTC'` when no reportingTimezone is set.\n\t */\n\tresolveTimezone: (req: PayloadRequest, scope?: string | null) => Promise<string>\n\t/**\n\t * The install's goals for a request's scope, for adapters that match completions\n\t * themselves (the native engine, at ingest). Config goals, with the goals collection\n\t * merged over them per scope once the install enables it.\n\t */\n\tresolveGoals: (req: PayloadRequest, scope?: string | null) => Promise<Goal[]>\n}\n\nexport interface AnalyticsAdapter {\n\treadonly id: string\n\treadonly label: string\n\treadonly capabilities: AnalyticsCapabilities\n\t/** Browser-tracker proxying/boot descriptor. Absent when the adapter has no client-side script (GA4). */\n\treadonly capture?: CaptureSupport\n\t/**\n\t * Where this adapter's own ingest endpoint listens, relative to `routes.api`, for the\n\t * adapters that register one (the native engine), and how server code reaches the same\n\t * pipeline without an HTTP round trip. Server-side only: the tracker learns the path\n\t * from `TrackerConfig.ingestPath`, and this object is never serialized.\n\t */\n\treadonly ingest?: { path: string; track?: ServerTrack }\n\tisConfigured(): boolean\n\tquery(query: AnalyticsQuery, ctx: AdapterContext): Promise<AnalyticsResult>\n\trealtime?(query: AnalyticsQuery, ctx: AdapterContext): Promise<AnalyticsResult>\n\tregister?(config: Config, context?: AdapterRegisterContext): void\n}\n\nexport type AnalyticsAdapterFactory<Config> = (config: Config) => AnalyticsAdapter\n"],"mappings":";;;;;AASA,MAAa,iBAAiB;;AAe9B,MAAa,iBAAiB;CAC7B;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;;AAYA,MAAa,mBAAmB;CAAC;CAAM;CAAY;AAAS"}
|
package/dist/core/granularity.js
CHANGED
|
@@ -12,6 +12,6 @@ const GRANULARITY_ORDER = [
|
|
|
12
12
|
*/
|
|
13
13
|
const supportsGranularity = (caps, g) => GRANULARITY_ORDER.indexOf(g) >= GRANULARITY_ORDER.indexOf(caps.minGranularity);
|
|
14
14
|
//#endregion
|
|
15
|
-
export { supportsGranularity };
|
|
15
|
+
export { GRANULARITY_ORDER, supportsGranularity };
|
|
16
16
|
|
|
17
17
|
//# sourceMappingURL=granularity.js.map
|
package/dist/core/options.d.ts
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { Goal } from "../goals/types.js";
|
|
2
|
-
import { AnalyticsAdapter } from "./contract.js";
|
|
3
|
-
import { TranslationsOption } from "../translations/index.js";
|
|
2
|
+
import { AnalyticsAdapter, MetricKey } from "./contract.js";
|
|
4
3
|
import { AnalyticsBinding } from "../binding/types.js";
|
|
5
4
|
import { CaptureSlot } from "../capture/slots.js";
|
|
5
|
+
import { TimeframePreset } from "../timeframe/presets.js";
|
|
6
|
+
import { TranslationsOption } from "../translations/index.js";
|
|
6
7
|
import { CustomWidgetDef } from "../widgets/customWidget.js";
|
|
7
8
|
import { CollectionConfig, CollectionSlug, Payload, PayloadRequest } from "payload";
|
|
8
9
|
import { KeysConfig } from "@10x-media/fields/encrypted";
|
|
@@ -72,7 +73,22 @@ type ProvidersOptions = {
|
|
|
72
73
|
type PlatformReadAccess = (args: {
|
|
73
74
|
req: PayloadRequest;
|
|
74
75
|
}) => boolean | Promise<boolean>;
|
|
76
|
+
/** Access checker for authenticated analytics reads. */
|
|
77
|
+
type AnalyticsReadAccess = (args: {
|
|
78
|
+
req: PayloadRequest;
|
|
79
|
+
}) => boolean | Promise<boolean>;
|
|
80
|
+
/** Access checker for the analytics admin view. */
|
|
81
|
+
type AnalyticsViewAccess = (args: {
|
|
82
|
+
req: PayloadRequest;
|
|
83
|
+
}) => boolean | Promise<boolean>;
|
|
75
84
|
type AnalyticsAccessOptions = {
|
|
85
|
+
/**
|
|
86
|
+
* Gates every authenticated read endpoint: query, document panel, realtime, sources
|
|
87
|
+
* and goals. Defaults to any authenticated user; narrow it to a role check to keep
|
|
88
|
+
* analytics away from admins who should not see them. Scope gating is separate and
|
|
89
|
+
* always applies: granting `read` never widens which scope a user reads.
|
|
90
|
+
*/
|
|
91
|
+
read?: AnalyticsReadAccess;
|
|
76
92
|
/**
|
|
77
93
|
* Gates cross-scope reads: explicit `scope: '*'` reads, and scoped reads through
|
|
78
94
|
* a shared config adapter that cannot filter by scope. Scoped installs
|
|
@@ -81,6 +97,12 @@ type AnalyticsAccessOptions = {
|
|
|
81
97
|
* providers. Unscoped installs default to any authenticated admin-panel user.
|
|
82
98
|
*/
|
|
83
99
|
platformRead?: PlatformReadAccess;
|
|
100
|
+
/**
|
|
101
|
+
* Gates the analytics admin view. Defaults to `read`, so one gate covers the view and
|
|
102
|
+
* the endpoints behind it. A reader this denies still sees the nav link (it is a client
|
|
103
|
+
* component with no access context) and lands on the view's no-access message.
|
|
104
|
+
*/
|
|
105
|
+
view?: AnalyticsViewAccess;
|
|
84
106
|
};
|
|
85
107
|
type ConsentMode = 'none' | 'required';
|
|
86
108
|
/** Per-slot consent decision, evaluated against the slot's resolved adapter. */
|
|
@@ -112,9 +134,21 @@ type AutoCaptureOptions = {
|
|
|
112
134
|
goalAttribute?: boolean;
|
|
113
135
|
};
|
|
114
136
|
type ResolvedAutoCapture = Required<AutoCaptureOptions>;
|
|
115
|
-
|
|
137
|
+
type AnalyticsGoalsCollectionOptions = {
|
|
138
|
+
/** Set false to keep the object form's other settings while leaving the collection off. */enabled?: boolean;
|
|
139
|
+
slug?: string;
|
|
140
|
+
/**
|
|
141
|
+
* Field matched against the resolved scope when looking up a scope's goals. Point it at
|
|
142
|
+
* a tenant plugin's field (e.g. 'tenant') when that plugin manages scoping.
|
|
143
|
+
*/
|
|
144
|
+
scopeField?: string;
|
|
145
|
+
overrides?: (collection: CollectionConfig) => CollectionConfig;
|
|
146
|
+
access?: Partial<CollectionConfig['access']>;
|
|
147
|
+
};
|
|
148
|
+
/** Goals as config, plus the opt-in collection editors manage their own goals through. */
|
|
116
149
|
type AnalyticsGoalsOptions = {
|
|
117
|
-
defaults?: Goal[];
|
|
150
|
+
defaults?: Goal[]; /** Opt-in admin collection whose goals merge over `defaults`, by slug, per scope. */
|
|
151
|
+
collection?: boolean | AnalyticsGoalsCollectionOptions;
|
|
118
152
|
};
|
|
119
153
|
type AnalyticsCaptureOptions = {
|
|
120
154
|
/**
|
|
@@ -155,6 +189,16 @@ type AnalyticsCaptureOptions = {
|
|
|
155
189
|
maxBodyBytes?: number;
|
|
156
190
|
};
|
|
157
191
|
};
|
|
192
|
+
type AnalyticsViewOptions = {
|
|
193
|
+
/** Admin path the view mounts at, under `routes.admin`. Default `/analytics`. */path?: `/${string}`; /** Timeframe the view opens on before the URL says otherwise. Default `last30days`. */
|
|
194
|
+
defaultRange?: TimeframePreset; /** Metric the cards and the trend open on. Default `pageviews`. */
|
|
195
|
+
defaultMetric?: MetricKey;
|
|
196
|
+
/**
|
|
197
|
+
* Nav link label. A string is used as-is; a map is keyed by admin language code and
|
|
198
|
+
* falls back to `en`. Unset, the plugin's own translated label applies.
|
|
199
|
+
*/
|
|
200
|
+
navLabel?: string | Record<string, string>;
|
|
201
|
+
};
|
|
158
202
|
type AnalyticsPluginOptions = {
|
|
159
203
|
disabled?: boolean;
|
|
160
204
|
/**
|
|
@@ -191,6 +235,11 @@ type AnalyticsPluginOptions = {
|
|
|
191
235
|
*/
|
|
192
236
|
platformAdapter?: string;
|
|
193
237
|
access?: AnalyticsAccessOptions;
|
|
238
|
+
/**
|
|
239
|
+
* The analytics admin view and its nav link, on by default. `false` registers neither;
|
|
240
|
+
* the read endpoints stay mounted either way, so a custom surface keeps working.
|
|
241
|
+
*/
|
|
242
|
+
view?: false | AnalyticsViewOptions;
|
|
194
243
|
capture?: AnalyticsCaptureOptions;
|
|
195
244
|
/**
|
|
196
245
|
* Conversion goals the tracker and the native ingest match events against. Slugs must
|
|
@@ -243,5 +292,5 @@ type AnalyticsPluginOptions = {
|
|
|
243
292
|
};
|
|
244
293
|
};
|
|
245
294
|
//#endregion
|
|
246
|
-
export { AnalyticsAccessOptions, AnalyticsCaptureOptions, AnalyticsGoalsOptions, AnalyticsPluginOptions, AutoCaptureOptions, CaptureConsentOption, ConsentMode, ConsentResolver, PlatformReadAccess, ProvidersCollectionOptions, ProvidersOptions, ProvidersResolve, ResolvedAutoCapture, ScopeResolver, ScopesResolver, TimezoneResolver };
|
|
295
|
+
export { AnalyticsAccessOptions, AnalyticsCaptureOptions, AnalyticsGoalsCollectionOptions, AnalyticsGoalsOptions, AnalyticsPluginOptions, AnalyticsReadAccess, AnalyticsViewAccess, AnalyticsViewOptions, AutoCaptureOptions, CaptureConsentOption, ConsentMode, ConsentResolver, PlatformReadAccess, ProvidersCollectionOptions, ProvidersOptions, ProvidersResolve, ResolvedAutoCapture, ScopeResolver, ScopesResolver, TimezoneResolver };
|
|
247
296
|
//# sourceMappingURL=options.d.ts.map
|
package/dist/core/options.js
CHANGED
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
import "../capture/proxyEndpoint.js";
|
|
2
2
|
import { GOAL_SLUG_PATTERN } from "../goals/types.js";
|
|
3
|
+
import { GOALS_SLUG } from "../goals/collection.js";
|
|
3
4
|
import { PROVIDERS_SLUG } from "../providers/collection.js";
|
|
5
|
+
import { TIMEFRAME_PRESETS } from "../timeframe/presets.js";
|
|
6
|
+
import { METRIC_KEYS } from "../translations/metricKeys.js";
|
|
4
7
|
//#region src/core/options.ts
|
|
5
8
|
const DEFAULT_WARM_CRON = "*/30 * * * *";
|
|
6
9
|
const DEFAULT_SYNC_CRON = "0 */6 * * *";
|
|
@@ -44,6 +47,53 @@ const resolveGoals = (option) => {
|
|
|
44
47
|
}
|
|
45
48
|
return goals;
|
|
46
49
|
};
|
|
50
|
+
const resolveGoalsCollection = (option) => {
|
|
51
|
+
const off = {
|
|
52
|
+
enabled: false,
|
|
53
|
+
slug: GOALS_SLUG,
|
|
54
|
+
scopeField: DEFAULT_SCOPE_FIELD
|
|
55
|
+
};
|
|
56
|
+
const collection = Array.isArray(option) ? void 0 : option?.collection;
|
|
57
|
+
if (!collection) return off;
|
|
58
|
+
const resolved = collection === true ? {
|
|
59
|
+
...off,
|
|
60
|
+
enabled: true
|
|
61
|
+
} : {
|
|
62
|
+
enabled: collection.enabled ?? true,
|
|
63
|
+
slug: collection.slug ?? "analytics-goals",
|
|
64
|
+
scopeField: collection.scopeField ?? DEFAULT_SCOPE_FIELD,
|
|
65
|
+
overrides: collection.overrides,
|
|
66
|
+
access: collection.access
|
|
67
|
+
};
|
|
68
|
+
if (!resolved.enabled) return off;
|
|
69
|
+
if (typeof resolved.slug !== "string" || resolved.slug.trim() === "") throw new Error("analytics: goals.collection.slug must be a non-empty collection slug");
|
|
70
|
+
if (resolved.scopeField.trim() === "") throw new Error("analytics: goals.collection.scopeField must be a non-empty field name");
|
|
71
|
+
if (resolved.scopeField.includes(".")) throw new Error("analytics: goals.collection.scopeField must be a top-level field name (no dots); the scope stamp writes it as a flat key");
|
|
72
|
+
return {
|
|
73
|
+
...resolved,
|
|
74
|
+
slug: resolved.slug.trim()
|
|
75
|
+
};
|
|
76
|
+
};
|
|
77
|
+
const DEFAULT_VIEW = {
|
|
78
|
+
path: "/analytics",
|
|
79
|
+
defaultRange: "last30days",
|
|
80
|
+
defaultMetric: "pageviews"
|
|
81
|
+
};
|
|
82
|
+
const resolveView = (option) => {
|
|
83
|
+
if (option === false) return false;
|
|
84
|
+
const path = option?.path ?? DEFAULT_VIEW.path;
|
|
85
|
+
if (typeof path !== "string" || !path.startsWith("/")) throw new Error(`analytics: view.path must start with "/", got "${String(path)}"`);
|
|
86
|
+
const defaultRange = option?.defaultRange ?? DEFAULT_VIEW.defaultRange;
|
|
87
|
+
if (!TIMEFRAME_PRESETS.includes(defaultRange)) throw new Error(`analytics: unknown view.defaultRange "${String(defaultRange)}"`);
|
|
88
|
+
const defaultMetric = option?.defaultMetric ?? DEFAULT_VIEW.defaultMetric;
|
|
89
|
+
if (!(defaultMetric in METRIC_KEYS)) throw new Error(`analytics: unknown view.defaultMetric "${String(defaultMetric)}"`);
|
|
90
|
+
return {
|
|
91
|
+
path,
|
|
92
|
+
defaultRange,
|
|
93
|
+
defaultMetric,
|
|
94
|
+
...option?.navLabel !== void 0 ? { navLabel: option.navLabel } : {}
|
|
95
|
+
};
|
|
96
|
+
};
|
|
47
97
|
const resolveBindings = (collections) => {
|
|
48
98
|
const out = {};
|
|
49
99
|
for (const [slug, binding] of Object.entries(collections ?? {})) {
|
|
@@ -135,6 +185,7 @@ function resolveOptions(options) {
|
|
|
135
185
|
hidden: true
|
|
136
186
|
};
|
|
137
187
|
const scoped = options.scopeResolver !== void 0;
|
|
188
|
+
const read = options.access?.read ?? (({ req }) => Boolean(req.user));
|
|
138
189
|
return {
|
|
139
190
|
adapters: options.adapters,
|
|
140
191
|
defaultAdapter: options.defaultAdapter,
|
|
@@ -143,7 +194,12 @@ function resolveOptions(options) {
|
|
|
143
194
|
scopes: options.scopes,
|
|
144
195
|
reportingTimezone: options.reportingTimezone,
|
|
145
196
|
platformAdapter: options.platformAdapter,
|
|
146
|
-
access: {
|
|
197
|
+
access: {
|
|
198
|
+
platformRead: options.access?.platformRead ?? (scoped ? () => false : ({ req }) => Boolean(req.user)),
|
|
199
|
+
read,
|
|
200
|
+
view: options.access?.view ?? read
|
|
201
|
+
},
|
|
202
|
+
view: resolveView(options.view),
|
|
147
203
|
capture: {
|
|
148
204
|
slots: {
|
|
149
205
|
global: options.capture?.slots?.global,
|
|
@@ -161,6 +217,7 @@ function resolveOptions(options) {
|
|
|
161
217
|
}
|
|
162
218
|
},
|
|
163
219
|
goals: resolveGoals(options.goals),
|
|
220
|
+
goalsCollection: resolveGoalsCollection(options.goals),
|
|
164
221
|
providers,
|
|
165
222
|
bindings: resolveBindings(options.collections),
|
|
166
223
|
cache: {
|
|
@@ -176,6 +233,6 @@ function resolveOptions(options) {
|
|
|
176
233
|
};
|
|
177
234
|
}
|
|
178
235
|
//#endregion
|
|
179
|
-
export { DEFAULT_AUTO_CAPTURE, defaultConsentFor, resolveOptions };
|
|
236
|
+
export { DEFAULT_AUTO_CAPTURE, DEFAULT_VIEW, defaultConsentFor, resolveOptions };
|
|
180
237
|
|
|
181
238
|
//# sourceMappingURL=options.js.map
|
package/dist/core/options.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"options.js","names":[],"sources":["../../src/core/options.ts"],"sourcesContent":["import type { KeysConfig } from '@10x-media/fields/encrypted'\nimport type { CollectionConfig, CollectionSlug, Payload, PayloadRequest } from 'payload'\nimport type { AnalyticsBinding, ResolvedBinding } from '../binding/types'\nimport { DEFAULT_PROXY_MAX_BODY_BYTES, DEFAULT_PROXY_TIMEOUT_MS } from '../capture/proxyEndpoint'\nimport type { CaptureSlot } from '../capture/slots'\nimport { GOAL_SLUG_PATTERN, type Goal } from '../goals/types'\nimport { PROVIDERS_SLUG } from '../providers/collection'\nimport type { TranslationsOption } from '../translations'\nimport type { CustomWidgetDef } from '../widgets/customWidget'\nimport type { CaptureClientKind } from './capture'\nimport type { AnalyticsAdapter } from './contract'\n\nconst DEFAULT_WARM_CRON = '*/30 * * * *'\nconst DEFAULT_SYNC_CRON = '0 */6 * * *'\nconst DEFAULT_SYNC_COLLECTION = 'analytics-daily'\nconst DEFAULT_SYNC_LOOKBACK = 3\nconst DEFAULT_SCOPE_FIELD = 'scope'\nconst DEFAULT_TIMEOUT_MS = 15_000\n\n/**\n * Maps a request to its analytics boundary (tenant id, site key). Null means the\n * whole install, which is the default single-site behavior. With a multi-tenant\n * plugin, return the request's tenant id here.\n */\nexport type ScopeResolver = (args: {\n\treq: PayloadRequest\n}) => string | null | Promise<string | null>\n\n/**\n * Resolves the IANA reporting timezone a read's (or ingest's) day boundaries align\n * to. Receives the request and its already-resolved scope, so per-tenant, per-user\n * (`req.user`), and selector (cookie/preference) strategies are all expressible.\n * Return `null` to fall back to UTC.\n */\nexport type TimezoneResolver = (args: {\n\treq: PayloadRequest\n\tscope: string | null\n}) => string | null | Promise<string | null>\n\n/**\n * Enumerates the tenant scopes the cron tiers (cache warming, sync) fan out over.\n * Absent, each tier runs once for the install-wide scope.\n */\nexport type ScopesResolver = (args: { payload: Payload }) => string[] | Promise<string[]>\n\n/**\n * Escape hatch replacing the provider-collection lookup: return the runtime\n * adapters for a scope yourself (any store, any shape). Results are layered onto\n * the static config adapters exactly like collection-resolved ones, but are not\n * cached; memoize inside the function if lookups are expensive.\n */\nexport type ProvidersResolve = (args: {\n\tpayload: Payload\n\treq?: PayloadRequest\n\tscope: string | null\n}) => AnalyticsAdapter[] | Promise<AnalyticsAdapter[]>\n\nexport type ProvidersCollectionOptions = {\n\tslug?: string\n\t/**\n\t * Field matched against the resolved scope when looking up a scope's providers.\n\t * Point it at a tenant plugin's field (e.g. 'tenant') when that plugin manages\n\t * scoping for the collection.\n\t */\n\tscopeField?: string\n\toverrides?: (collection: CollectionConfig) => CollectionConfig\n\taccess?: Partial<CollectionConfig['access']>\n\t/**\n\t * Dedicated key ring for the stored provider credentials. Unset, the\n\t * fields plugin's global `encrypted.keys` applies, and with neither the\n\t * ring derives from the Payload secret. Configure a dedicated key for\n\t * anything beyond a dev install.\n\t */\n\tencryption?: { keys?: KeysConfig }\n}\n\nexport type ProvidersOptions = {\n\t/** Opt-in admin collection storing runtime provider configurations. */\n\tcollection?: boolean | ProvidersCollectionOptions\n\tresolve?: ProvidersResolve\n}\n\n/** Access checker for cross-scope (platform) analytics reads. */\nexport type PlatformReadAccess = (args: { req: PayloadRequest }) => boolean | Promise<boolean>\n\nexport type AnalyticsAccessOptions = {\n\t/**\n\t * Gates cross-scope reads: explicit `scope: '*'` reads, and scoped reads through\n\t * a shared config adapter that cannot filter by scope. Scoped installs\n\t * (`scopeResolver` configured) default to deny; configure it, for example a role\n\t * check, so platform admins can read cross-scope and manage every tenant's\n\t * providers. Unscoped installs default to any authenticated admin-panel user.\n\t */\n\tplatformRead?: PlatformReadAccess\n}\n\nexport type ConsentMode = 'none' | 'required'\n\n/** Per-slot consent decision, evaluated against the slot's resolved adapter. */\nexport type ConsentResolver = (args: { slot: CaptureSlot; adapterId: string }) => ConsentMode\n\n/** An adapter id to fill a capture slot with, or `false` to leave it deliberately empty. */\nexport type CaptureSlotOption = string | false\n\n/**\n * A bare mode applies to every slot; a resolver decides per request-resolved adapter; the\n * object form maps ids and slots, with an adapter entry winning over a slot entry. Every\n * form overrides the default, which is `none` for the cookieless native tracker and\n * `required` for a vendor's.\n */\nexport type CaptureConsentOption =\n\t| ConsentMode\n\t| ConsentResolver\n\t| {\n\t\t\tslots?: Partial<Record<CaptureSlot, ConsentMode>>\n\t\t\t/**\n\t\t\t * Keyed by adapter id. A bare id must name a config adapter; a runtime provider\n\t\t\t * instance id (`<provider>:<instance>`) is taken on trust, since the providers it\n\t\t\t * comes from are only resolved per request.\n\t\t\t */\n\t\t\tadapters?: Record<string, ConsentMode>\n\t }\n\n/** The normalized policy the runtime evaluates; `kind` carries the adapter's tracker family. */\nexport type ConsentPolicy = (\n\tslot: CaptureSlot,\n\tadapterId: string,\n\tkind: CaptureClientKind\n) => ConsentMode\n\nexport type AutoCaptureOptions = {\n\tscrollDepth?: boolean\n\toutboundLinks?: boolean\n\tfileDownloads?: boolean\n\tgoalAttribute?: boolean\n}\n\nexport type ResolvedAutoCapture = Required<AutoCaptureOptions>\n\n/** Goals as config: the array form, or the object form 1b grows a collection source on. */\nexport type AnalyticsGoalsOptions = { defaults?: Goal[] }\n\nexport type AnalyticsCaptureOptions = {\n\t/**\n\t * Which adapter fills each capture slot, overriding the defaults: `global` is the\n\t * designated `platformAdapter`, or the single config adapter when only one is\n\t * configured; `tenant` is the resolved scope's default adapter. A `global` id must\n\t * name a config adapter; a `tenant` id may also name a runtime provider instance,\n\t * so it is resolved per request rather than validated at config time.\n\t *\n\t * `false` disables a slot outright: it fills with nothing, its proxy mount 404s, and\n\t * the tracker config omits it. Use it to keep a default from filling a slot at all.\n\t */\n\tslots?: { global?: CaptureSlotOption; tenant?: CaptureSlotOption }\n\t/**\n\t * Mount each slot's snippet points at. Defaults to the runtime proxy endpoint\n\t * (`<routes.api>/analytics/p/<slot>`); set it when the slot is served through Next\n\t * rewrites instead, passing the same path `captureRewrites` was mounted at.\n\t */\n\tpaths?: { global?: string; tenant?: string }\n\t/** Whether a slot's tracker waits for consent. Native defaults to no gate, vendors to one. */\n\tconsent?: CaptureConsentOption\n\t/** Browser auto-capture listeners, all on by default except `scrollDepth`. */\n\tautoCapture?: AutoCaptureOptions\n\t/** Limits for the public runtime capture proxy, separate from the read-path `cache`. */\n\tproxy?: {\n\t\t/**\n\t\t * Deadline for the upstream response headers, in ms. Default 10000. The body\n\t\t * download is not on the clock, so a large tracker bundle streams to completion.\n\t\t */\n\t\ttimeoutMs?: number\n\t\t/**\n\t\t * Largest proxied request body, in bytes. Default 1 MiB, which clears a PostHog\n\t\t * batch carrying session-replay data. Anything larger is refused with 413.\n\t\t */\n\t\tmaxBodyBytes?: number\n\t}\n}\n\nexport type AnalyticsPluginOptions = {\n\tdisabled?: boolean\n\t/**\n\t * Per-locale overrides for this plugin's UI strings, keyed by the typed\n\t * translation keys exported from `@10x-media/analytics/i18n`. Values win over\n\t * the built-in locales key-by-key; locales the plugin does not ship are added\n\t * whole. App-level `i18n.translations` still wins over both.\n\t */\n\ttranslations?: TranslationsOption\n\tadapters?: AnalyticsAdapter[]\n\tdefaultAdapter?: string\n\tscopeResolver?: ScopeResolver\n\t/**\n\t * Enumerates the tenant scopes the cache-warming and sync cron tiers fan out\n\t * over, in addition to the install-wide (null) scope every tier already runs.\n\t * Unset, those tiers run once for the whole install, same as before.\n\t */\n\tscopes?: ScopesResolver\n\t/**\n\t * IANA reporting timezone that day boundaries (timeframe windows, series axes,\n\t * native rollup buckets) align to. Defaults to UTC. A string forces one timezone\n\t * (the single-tenant / no-multi-tenancy case); a resolver derives it per request\n\t * from the scope, user, or a selector. Native rollups bucket at ingest in the\n\t * resolved timezone, so changing it does not re-bucket existing history.\n\t */\n\treportingTimezone?: string | TimezoneResolver\n\tproviders?: ProvidersOptions\n\t/**\n\t * Id of one config adapter shared by every scope (the platform's own analytics,\n\t * e.g. a PostHog project capturing all tenants). Included in each scope's\n\t * registry like any config adapter; reads through it are scope-filtered only\n\t * when the adapter supports scoped queries, otherwise they are cross-scope and\n\t * require `access.platformRead`.\n\t */\n\tplatformAdapter?: string\n\taccess?: AnalyticsAccessOptions\n\tcapture?: AnalyticsCaptureOptions\n\t/**\n\t * Conversion goals the tracker and the native ingest match events against. Slugs must\n\t * be unique and kebab-case; only the slug and its match reach the browser.\n\t */\n\tgoals?: Goal[] | AnalyticsGoalsOptions\n\t/**\n\t * Per-collection bindings, keyed by collection slug. With generated types\n\t * augmented, each slug's resolvers receive that collection's typed document.\n\t */\n\tcollections?: { [TSlug in CollectionSlug]?: AnalyticsBinding<TSlug> }\n\tcache?: {\n\t\tttl?: { aggregate?: number; realtime?: number }\n\t\twarm?: boolean | { cron?: string }\n\t\t/** Per-read provider timeout in ms, spanning retries and limiter waits. Default 15000. */\n\t\ttimeoutMs?: number\n\t}\n\twidgets?:\n\t\t| boolean\n\t\t| {\n\t\t\t\tdisabled?: string[]\n\t\t\t\tregister?: CustomWidgetDef[]\n\t\t\t\t/**\n\t\t\t\t * Marks the free-text widget config fields (each widget's Title) as\n\t\t\t\t * `localized`. Off by default; takes effect only when the Payload config\n\t\t\t\t * enables localization (Payload strips the flag otherwise).\n\t\t\t\t */\n\t\t\t\tlocalizeText?: boolean\n\t\t\t\t/**\n\t\t\t\t * Period-over-period comparison on the metric and trend widgets. On by\n\t\t\t\t * default for adapters that declare `capabilities.comparison`; set false\n\t\t\t\t * to skip the second (previous-window) read entirely.\n\t\t\t\t */\n\t\t\t\tcomparison?: boolean\n\t\t }\n\t/**\n\t * Opt-in sync tier: a cron job that persists each provider's daily metrics into a\n\t * queryable collection. Reads go through the surfacing cache, so persisted rows reflect\n\t * cached values up to `cache.ttl.aggregate` old; keep that TTL below the sync interval\n\t * for the freshest data.\n\t */\n\tsync?:\n\t\t| boolean\n\t\t| {\n\t\t\t\tcollectionSlug?: CollectionSlug\n\t\t\t\tcron?: string\n\t\t\t\tlookbackDays?: number\n\t\t\t\tadapters?: string[]\n\t\t\t\t/** Surface the analytics-daily collection in the admin nav. Default false (hidden). */\n\t\t\t\thidden?: boolean\n\t\t }\n}\n\nexport interface ResolvedCapture {\n\tslots: { global?: CaptureSlotOption; tenant?: CaptureSlotOption }\n\tpaths: { global?: string; tenant?: string }\n\tconsent: ConsentPolicy\n\tautoCapture: ResolvedAutoCapture\n\tproxy: { timeoutMs: number; maxBodyBytes: number }\n}\n\nexport interface ResolvedOptions {\n\tadapters: AnalyticsAdapter[]\n\tdefaultAdapter?: string\n\tscopeResolver: ScopeResolver\n\t/** True when the app configured a scopeResolver (scoped install). */\n\tscoped: boolean\n\t/** Raw scopes option; undefined runs the cron tiers install-wide only. */\n\tscopes?: ScopesResolver\n\t/** Raw reportingTimezone option; normalized into a resolver at init. */\n\treportingTimezone?: string | TimezoneResolver\n\tplatformAdapter?: string\n\taccess: { platformRead: PlatformReadAccess }\n\tcapture: ResolvedCapture\n\t/** Config goals, validated; 1b layers collection-sourced goals on top of these. */\n\tgoals: Goal[]\n\tproviders: {\n\t\tcollection: {\n\t\t\tenabled: boolean\n\t\t\tslug: string\n\t\t\tscopeField: string\n\t\t\toverrides?: (collection: CollectionConfig) => CollectionConfig\n\t\t\taccess?: Partial<CollectionConfig['access']>\n\t\t\tencryption?: { keys?: KeysConfig }\n\t\t}\n\t\tresolve?: ProvidersResolve\n\t}\n\tbindings: Record<string, ResolvedBinding>\n\tcache: {\n\t\t/** Undefined when unset: adapter recommendedTtl is the fallback, an explicit value wins. */\n\t\tttl: { aggregate?: number; realtime?: number }\n\t\twarm: { enabled: boolean; cron: string }\n\t\ttimeoutMs: number\n\t}\n\twidgets: {\n\t\tenabled: boolean\n\t\tdisabled: string[]\n\t\tregister: CustomWidgetDef[]\n\t\tlocalizeText: boolean\n\t\tcomparison: boolean\n\t}\n\tsync: {\n\t\tenabled: boolean\n\t\tcollectionSlug: string\n\t\tcron: string\n\t\tlookbackDays: number\n\t\tadapters?: string[]\n\t\t/** True hides the analytics-daily collection from the admin nav (default). */\n\t\thidden: boolean\n\t}\n}\n\n/** Scroll depth is the one listener off by default: it fires on every page, for every visitor. */\nexport const DEFAULT_AUTO_CAPTURE: ResolvedAutoCapture = {\n\tscrollDepth: false,\n\toutboundLinks: true,\n\tfileDownloads: true,\n\tgoalAttribute: true,\n}\n\nconst resolveAutoCapture = (option: AutoCaptureOptions | undefined): ResolvedAutoCapture => ({\n\tscrollDepth: option?.scrollDepth ?? DEFAULT_AUTO_CAPTURE.scrollDepth,\n\toutboundLinks: option?.outboundLinks ?? DEFAULT_AUTO_CAPTURE.outboundLinks,\n\tfileDownloads: option?.fileDownloads ?? DEFAULT_AUTO_CAPTURE.fileDownloads,\n\tgoalAttribute: option?.goalAttribute ?? DEFAULT_AUTO_CAPTURE.goalAttribute,\n})\n\n/** Cookieless native capture needs no consent gate; a vendor's tracker does. */\nexport const defaultConsentFor = (kind: CaptureClientKind): ConsentMode =>\n\tkind === 'native' ? 'none' : 'required'\n\nconst resolveConsent = (\n\toption: CaptureConsentOption | undefined,\n\tadapters: AnalyticsAdapter[]\n): ConsentPolicy => {\n\tif (option === 'none' || option === 'required') {\n\t\treturn () => option\n\t}\n\tif (typeof option === 'function') {\n\t\treturn (slot, adapterId) => option({ slot, adapterId })\n\t}\n\tfor (const id of Object.keys(option?.adapters ?? {})) {\n\t\t// A runtime provider instance id is `<provider>:<instance>` and only exists once a\n\t\t// scope resolves, so it cannot be checked here; a bare id must name a config adapter.\n\t\tif (!id.includes(':') && !adapters.some((a) => a.id === id)) {\n\t\t\tthrow new Error(`analytics: unknown consent adapter \"${id}\"`)\n\t\t}\n\t}\n\treturn (slot, adapterId, kind) =>\n\t\toption?.adapters?.[adapterId] ?? option?.slots?.[slot] ?? defaultConsentFor(kind)\n}\n\nconst resolveGoals = (option: AnalyticsPluginOptions['goals']): Goal[] => {\n\tconst goals = Array.isArray(option) ? option : (option?.defaults ?? [])\n\tconst seen = new Set<string>()\n\tfor (const goal of goals) {\n\t\tif (!GOAL_SLUG_PATTERN.test(goal.slug)) {\n\t\t\tthrow new Error(`analytics: goal slug \"${goal.slug}\" must be kebab-case`)\n\t\t}\n\t\tif (seen.has(goal.slug)) {\n\t\t\tthrow new Error(`analytics: duplicate goal slug \"${goal.slug}\"`)\n\t\t}\n\t\tconst fixed = goal.value?.fixed\n\t\t// Revenue is money: a negative or non-finite fixed value would be silently ignored at\n\t\t// ingest, so it fails the boot instead.\n\t\tif (fixed !== undefined && (!Number.isFinite(fixed) || fixed < 0)) {\n\t\t\tthrow new Error(\n\t\t\t\t`analytics: goal \"${goal.slug}\" value.fixed must be a finite number >= 0, got ${String(fixed)}`\n\t\t\t)\n\t\t}\n\t\tseen.add(goal.slug)\n\t}\n\treturn goals\n}\n\nconst resolveBindings = (\n\tcollections: AnalyticsPluginOptions['collections']\n): Record<string, ResolvedBinding> => {\n\tconst out: Record<string, ResolvedBinding> = {}\n\tfor (const [slug, binding] of Object.entries(collections ?? {})) {\n\t\tif (!binding) continue\n\t\tif (!binding.path && !binding.pathField) {\n\t\t\tthrow new Error(`analytics: binding for \"${slug}\" needs a path resolver or a pathField`)\n\t\t}\n\t\t// Erases the per-slug doc generic; safe because the runtime only ever hands\n\t\t// a binding documents from its own collection.\n\t\tout[slug] = binding as ResolvedBinding\n\t}\n\treturn out\n}\n\nexport function resolveOptions(options: AnalyticsPluginOptions): ResolvedOptions {\n\tif (!options.adapters || options.adapters.length === 0) {\n\t\tthrow new Error('analytics: at least one adapter is required')\n\t}\n\tif (\n\t\toptions.platformAdapter !== undefined &&\n\t\t!options.adapters.some((a) => a.id === options.platformAdapter)\n\t) {\n\t\tthrow new Error(`analytics: unknown platform adapter \"${options.platformAdapter}\"`)\n\t}\n\tfor (const [slot, value] of Object.entries(options.capture?.slots ?? {})) {\n\t\tif (value !== false && typeof value !== 'string' && value !== undefined) {\n\t\t\tthrow new Error(\n\t\t\t\t`analytics: capture slot \"${slot}\" must be an adapter id or false, got ${typeof value}`\n\t\t\t)\n\t\t}\n\t}\n\tconst globalSlot = options.capture?.slots?.global\n\t// A tenant id may name a runtime provider instance, which only exists once a scope\n\t// resolves; a global one can only come from the config registry, so it is checked here.\n\tif (typeof globalSlot === 'string' && !options.adapters.some((a) => a.id === globalSlot)) {\n\t\tthrow new Error(`analytics: unknown global capture slot adapter \"${globalSlot}\"`)\n\t}\n\tconst widgets =\n\t\toptions.widgets === false\n\t\t\t? {\n\t\t\t\t\tenabled: false,\n\t\t\t\t\tdisabled: [] as string[],\n\t\t\t\t\tregister: [] as CustomWidgetDef[],\n\t\t\t\t\tlocalizeText: false,\n\t\t\t\t\tcomparison: true,\n\t\t\t\t}\n\t\t\t: options.widgets === undefined || options.widgets === true\n\t\t\t\t? {\n\t\t\t\t\t\tenabled: true,\n\t\t\t\t\t\tdisabled: [] as string[],\n\t\t\t\t\t\tregister: [] as CustomWidgetDef[],\n\t\t\t\t\t\tlocalizeText: false,\n\t\t\t\t\t\tcomparison: true,\n\t\t\t\t\t}\n\t\t\t\t: {\n\t\t\t\t\t\tenabled: true,\n\t\t\t\t\t\tdisabled: options.widgets.disabled ?? [],\n\t\t\t\t\t\tregister: options.widgets.register ?? [],\n\t\t\t\t\t\tlocalizeText: options.widgets.localizeText ?? false,\n\t\t\t\t\t\tcomparison: options.widgets.comparison ?? true,\n\t\t\t\t\t}\n\tconst warmOpt = options.cache?.warm\n\tconst warm =\n\t\twarmOpt === true\n\t\t\t? { enabled: true, cron: DEFAULT_WARM_CRON }\n\t\t\t: warmOpt && typeof warmOpt === 'object'\n\t\t\t\t? { enabled: true, cron: warmOpt.cron ?? DEFAULT_WARM_CRON }\n\t\t\t\t: { enabled: false, cron: DEFAULT_WARM_CRON }\n\tconst collectionOpt = options.providers?.collection\n\tconst providers = {\n\t\tcollection:\n\t\t\tcollectionOpt === true\n\t\t\t\t? { enabled: true, slug: PROVIDERS_SLUG, scopeField: DEFAULT_SCOPE_FIELD }\n\t\t\t\t: collectionOpt && typeof collectionOpt === 'object'\n\t\t\t\t\t? {\n\t\t\t\t\t\t\tenabled: true,\n\t\t\t\t\t\t\tslug: collectionOpt.slug ?? PROVIDERS_SLUG,\n\t\t\t\t\t\t\tscopeField: collectionOpt.scopeField ?? DEFAULT_SCOPE_FIELD,\n\t\t\t\t\t\t\toverrides: collectionOpt.overrides,\n\t\t\t\t\t\t\taccess: collectionOpt.access,\n\t\t\t\t\t\t\tencryption: collectionOpt.encryption,\n\t\t\t\t\t\t}\n\t\t\t\t\t: { enabled: false, slug: PROVIDERS_SLUG, scopeField: DEFAULT_SCOPE_FIELD },\n\t\tresolve: options.providers?.resolve,\n\t}\n\tif (providers.collection.enabled) {\n\t\tif (providers.collection.scopeField.trim() === '') {\n\t\t\tthrow new Error('analytics: providers.collection.scopeField must be a non-empty field name')\n\t\t}\n\t\tif (providers.collection.scopeField.includes('.')) {\n\t\t\tthrow new Error(\n\t\t\t\t'analytics: providers.collection.scopeField must be a top-level field name (no dots); the scope stamp writes it as a flat key'\n\t\t\t)\n\t\t}\n\t}\n\tconst syncOpt = options.sync\n\tconst sync =\n\t\tsyncOpt === true\n\t\t\t? {\n\t\t\t\t\tenabled: true,\n\t\t\t\t\tcollectionSlug: DEFAULT_SYNC_COLLECTION,\n\t\t\t\t\tcron: DEFAULT_SYNC_CRON,\n\t\t\t\t\tlookbackDays: DEFAULT_SYNC_LOOKBACK,\n\t\t\t\t\thidden: true,\n\t\t\t\t}\n\t\t\t: syncOpt && typeof syncOpt === 'object'\n\t\t\t\t? {\n\t\t\t\t\t\tenabled: true,\n\t\t\t\t\t\tcollectionSlug: syncOpt.collectionSlug ?? DEFAULT_SYNC_COLLECTION,\n\t\t\t\t\t\tcron: syncOpt.cron ?? DEFAULT_SYNC_CRON,\n\t\t\t\t\t\tlookbackDays: syncOpt.lookbackDays ?? DEFAULT_SYNC_LOOKBACK,\n\t\t\t\t\t\tadapters: syncOpt.adapters,\n\t\t\t\t\t\thidden: syncOpt.hidden ?? true,\n\t\t\t\t\t}\n\t\t\t\t: {\n\t\t\t\t\t\tenabled: false,\n\t\t\t\t\t\tcollectionSlug: DEFAULT_SYNC_COLLECTION,\n\t\t\t\t\t\tcron: DEFAULT_SYNC_CRON,\n\t\t\t\t\t\tlookbackDays: DEFAULT_SYNC_LOOKBACK,\n\t\t\t\t\t\thidden: true,\n\t\t\t\t\t}\n\tconst scoped = options.scopeResolver !== undefined\n\treturn {\n\t\tadapters: options.adapters,\n\t\tdefaultAdapter: options.defaultAdapter,\n\t\tscopeResolver: options.scopeResolver ?? (() => null),\n\t\tscoped,\n\t\tscopes: options.scopes,\n\t\treportingTimezone: options.reportingTimezone,\n\t\tplatformAdapter: options.platformAdapter,\n\t\taccess: {\n\t\t\tplatformRead:\n\t\t\t\toptions.access?.platformRead ?? (scoped ? () => false : ({ req }) => Boolean(req.user)),\n\t\t},\n\t\tcapture: {\n\t\t\tslots: {\n\t\t\t\tglobal: options.capture?.slots?.global,\n\t\t\t\ttenant: options.capture?.slots?.tenant,\n\t\t\t},\n\t\t\tpaths: {\n\t\t\t\tglobal: options.capture?.paths?.global,\n\t\t\t\ttenant: options.capture?.paths?.tenant,\n\t\t\t},\n\t\t\tconsent: resolveConsent(options.capture?.consent, options.adapters),\n\t\t\tautoCapture: resolveAutoCapture(options.capture?.autoCapture),\n\t\t\tproxy: {\n\t\t\t\ttimeoutMs: options.capture?.proxy?.timeoutMs ?? DEFAULT_PROXY_TIMEOUT_MS,\n\t\t\t\tmaxBodyBytes: options.capture?.proxy?.maxBodyBytes ?? DEFAULT_PROXY_MAX_BODY_BYTES,\n\t\t\t},\n\t\t},\n\t\tgoals: resolveGoals(options.goals),\n\t\tproviders,\n\t\tbindings: resolveBindings(options.collections),\n\t\tcache: {\n\t\t\t// Left undefined when the app did not set them so the adapter's recommendedTtl\n\t\t\t// applies as the default; an explicit value overrides the adapter recommendation.\n\t\t\tttl: {\n\t\t\t\taggregate: options.cache?.ttl?.aggregate,\n\t\t\t\trealtime: options.cache?.ttl?.realtime,\n\t\t\t},\n\t\t\twarm,\n\t\t\ttimeoutMs: options.cache?.timeoutMs ?? DEFAULT_TIMEOUT_MS,\n\t\t},\n\t\twidgets,\n\t\tsync,\n\t}\n}\n"],"mappings":";;;;AAYA,MAAM,oBAAoB;AAC1B,MAAM,oBAAoB;AAC1B,MAAM,0BAA0B;AAChC,MAAM,wBAAwB;AAC9B,MAAM,sBAAsB;AAC5B,MAAM,qBAAqB;;AAuT3B,MAAa,uBAA4C;CACxD,aAAa;CACb,eAAe;CACf,eAAe;CACf,eAAe;AAChB;AAEA,MAAM,sBAAsB,YAAiE;CAC5F,aAAa,QAAQ,eAAe,qBAAqB;CACzD,eAAe,QAAQ,iBAAiB,qBAAqB;CAC7D,eAAe,QAAQ,iBAAiB,qBAAqB;CAC7D,eAAe,QAAQ,iBAAiB,qBAAqB;AAC9D;;AAGA,MAAa,qBAAqB,SACjC,SAAS,WAAW,SAAS;AAE9B,MAAM,kBACL,QACA,aACmB;CACnB,IAAI,WAAW,UAAU,WAAW,YACnC,aAAa;CAEd,IAAI,OAAO,WAAW,YACrB,QAAQ,MAAM,cAAc,OAAO;EAAE;EAAM;CAAU,CAAC;CAEvD,KAAK,MAAM,MAAM,OAAO,KAAK,QAAQ,YAAY,CAAC,CAAC,GAGlD,IAAI,CAAC,GAAG,SAAS,GAAG,KAAK,CAAC,SAAS,MAAM,MAAM,EAAE,OAAO,EAAE,GACzD,MAAM,IAAI,MAAM,uCAAuC,GAAG,EAAE;CAG9D,QAAQ,MAAM,WAAW,SACxB,QAAQ,WAAW,cAAc,QAAQ,QAAQ,SAAS,kBAAkB,IAAI;AAClF;AAEA,MAAM,gBAAgB,WAAoD;CACzE,MAAM,QAAQ,MAAM,QAAQ,MAAM,IAAI,SAAU,QAAQ,YAAY,CAAC;CACrE,MAAM,uBAAO,IAAI,IAAY;CAC7B,KAAK,MAAM,QAAQ,OAAO;EACzB,IAAI,CAAC,kBAAkB,KAAK,KAAK,IAAI,GACpC,MAAM,IAAI,MAAM,yBAAyB,KAAK,KAAK,qBAAqB;EAEzE,IAAI,KAAK,IAAI,KAAK,IAAI,GACrB,MAAM,IAAI,MAAM,mCAAmC,KAAK,KAAK,EAAE;EAEhE,MAAM,QAAQ,KAAK,OAAO;EAG1B,IAAI,UAAU,KAAA,MAAc,CAAC,OAAO,SAAS,KAAK,KAAK,QAAQ,IAC9D,MAAM,IAAI,MACT,oBAAoB,KAAK,KAAK,kDAAkD,OAAO,KAAK,GAC7F;EAED,KAAK,IAAI,KAAK,IAAI;CACnB;CACA,OAAO;AACR;AAEA,MAAM,mBACL,gBACqC;CACrC,MAAM,MAAuC,CAAC;CAC9C,KAAK,MAAM,CAAC,MAAM,YAAY,OAAO,QAAQ,eAAe,CAAC,CAAC,GAAG;EAChE,IAAI,CAAC,SAAS;EACd,IAAI,CAAC,QAAQ,QAAQ,CAAC,QAAQ,WAC7B,MAAM,IAAI,MAAM,2BAA2B,KAAK,uCAAuC;EAIxF,IAAI,QAAQ;CACb;CACA,OAAO;AACR;AAEA,SAAgB,eAAe,SAAkD;CAChF,IAAI,CAAC,QAAQ,YAAY,QAAQ,SAAS,WAAW,GACpD,MAAM,IAAI,MAAM,6CAA6C;CAE9D,IACC,QAAQ,oBAAoB,KAAA,KAC5B,CAAC,QAAQ,SAAS,MAAM,MAAM,EAAE,OAAO,QAAQ,eAAe,GAE9D,MAAM,IAAI,MAAM,wCAAwC,QAAQ,gBAAgB,EAAE;CAEnF,KAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAQ,QAAQ,SAAS,SAAS,CAAC,CAAC,GACtE,IAAI,UAAU,SAAS,OAAO,UAAU,YAAY,UAAU,KAAA,GAC7D,MAAM,IAAI,MACT,4BAA4B,KAAK,wCAAwC,OAAO,OACjF;CAGF,MAAM,aAAa,QAAQ,SAAS,OAAO;CAG3C,IAAI,OAAO,eAAe,YAAY,CAAC,QAAQ,SAAS,MAAM,MAAM,EAAE,OAAO,UAAU,GACtF,MAAM,IAAI,MAAM,mDAAmD,WAAW,EAAE;CAEjF,MAAM,UACL,QAAQ,YAAY,QACjB;EACA,SAAS;EACT,UAAU,CAAC;EACX,UAAU,CAAC;EACX,cAAc;EACd,YAAY;CACb,IACC,QAAQ,YAAY,KAAA,KAAa,QAAQ,YAAY,OACpD;EACA,SAAS;EACT,UAAU,CAAC;EACX,UAAU,CAAC;EACX,cAAc;EACd,YAAY;CACb,IACC;EACA,SAAS;EACT,UAAU,QAAQ,QAAQ,YAAY,CAAC;EACvC,UAAU,QAAQ,QAAQ,YAAY,CAAC;EACvC,cAAc,QAAQ,QAAQ,gBAAgB;EAC9C,YAAY,QAAQ,QAAQ,cAAc;CAC3C;CACJ,MAAM,UAAU,QAAQ,OAAO;CAC/B,MAAM,OACL,YAAY,OACT;EAAE,SAAS;EAAM,MAAM;CAAkB,IACzC,WAAW,OAAO,YAAY,WAC7B;EAAE,SAAS;EAAM,MAAM,QAAQ,QAAQ;CAAkB,IACzD;EAAE,SAAS;EAAO,MAAM;CAAkB;CAC/C,MAAM,gBAAgB,QAAQ,WAAW;CACzC,MAAM,YAAY;EACjB,YACC,kBAAkB,OACf;GAAE,SAAS;GAAM,MAAM;GAAgB,YAAY;EAAoB,IACvE,iBAAiB,OAAO,kBAAkB,WACzC;GACA,SAAS;GACT,MAAM,cAAc,QAAA;GACpB,YAAY,cAAc,cAAc;GACxC,WAAW,cAAc;GACzB,QAAQ,cAAc;GACtB,YAAY,cAAc;EAC3B,IACC;GAAE,SAAS;GAAO,MAAM;GAAgB,YAAY;EAAoB;EAC7E,SAAS,QAAQ,WAAW;CAC7B;CACA,IAAI,UAAU,WAAW,SAAS;EACjC,IAAI,UAAU,WAAW,WAAW,KAAK,MAAM,IAC9C,MAAM,IAAI,MAAM,2EAA2E;EAE5F,IAAI,UAAU,WAAW,WAAW,SAAS,GAAG,GAC/C,MAAM,IAAI,MACT,8HACD;CAEF;CACA,MAAM,UAAU,QAAQ;CACxB,MAAM,OACL,YAAY,OACT;EACA,SAAS;EACT,gBAAgB;EAChB,MAAM;EACN,cAAc;EACd,QAAQ;CACT,IACC,WAAW,OAAO,YAAY,WAC7B;EACA,SAAS;EACT,gBAAgB,QAAQ,kBAAkB;EAC1C,MAAM,QAAQ,QAAQ;EACtB,cAAc,QAAQ,gBAAgB;EACtC,UAAU,QAAQ;EAClB,QAAQ,QAAQ,UAAU;CAC3B,IACC;EACA,SAAS;EACT,gBAAgB;EAChB,MAAM;EACN,cAAc;EACd,QAAQ;CACT;CACJ,MAAM,SAAS,QAAQ,kBAAkB,KAAA;CACzC,OAAO;EACN,UAAU,QAAQ;EAClB,gBAAgB,QAAQ;EACxB,eAAe,QAAQ,wBAAwB;EAC/C;EACA,QAAQ,QAAQ;EAChB,mBAAmB,QAAQ;EAC3B,iBAAiB,QAAQ;EACzB,QAAQ,EACP,cACC,QAAQ,QAAQ,iBAAiB,eAAe,SAAS,EAAE,UAAU,QAAQ,IAAI,IAAI,GACvF;EACA,SAAS;GACR,OAAO;IACN,QAAQ,QAAQ,SAAS,OAAO;IAChC,QAAQ,QAAQ,SAAS,OAAO;GACjC;GACA,OAAO;IACN,QAAQ,QAAQ,SAAS,OAAO;IAChC,QAAQ,QAAQ,SAAS,OAAO;GACjC;GACA,SAAS,eAAe,QAAQ,SAAS,SAAS,QAAQ,QAAQ;GAClE,aAAa,mBAAmB,QAAQ,SAAS,WAAW;GAC5D,OAAO;IACN,WAAW,QAAQ,SAAS,OAAO,aAAA;IACnC,cAAc,QAAQ,SAAS,OAAO,gBAAA;GACvC;EACD;EACA,OAAO,aAAa,QAAQ,KAAK;EACjC;EACA,UAAU,gBAAgB,QAAQ,WAAW;EAC7C,OAAO;GAGN,KAAK;IACJ,WAAW,QAAQ,OAAO,KAAK;IAC/B,UAAU,QAAQ,OAAO,KAAK;GAC/B;GACA;GACA,WAAW,QAAQ,OAAO,aAAa;EACxC;EACA;EACA;CACD;AACD"}
|
|
1
|
+
{"version":3,"file":"options.js","names":[],"sources":["../../src/core/options.ts"],"sourcesContent":["import type { KeysConfig } from '@10x-media/fields/encrypted'\nimport type { CollectionConfig, CollectionSlug, Payload, PayloadRequest } from 'payload'\nimport type { AnalyticsBinding, ResolvedBinding } from '../binding/types'\nimport { DEFAULT_PROXY_MAX_BODY_BYTES, DEFAULT_PROXY_TIMEOUT_MS } from '../capture/proxyEndpoint'\nimport type { CaptureSlot } from '../capture/slots'\nimport { GOALS_SLUG } from '../goals/collection'\nimport { GOAL_SLUG_PATTERN, type Goal } from '../goals/types'\nimport { PROVIDERS_SLUG } from '../providers/collection'\nimport { TIMEFRAME_PRESETS, type TimeframePreset } from '../timeframe/presets'\nimport type { TranslationsOption } from '../translations'\nimport { METRIC_KEYS } from '../translations/metricKeys'\nimport type { CustomWidgetDef } from '../widgets/customWidget'\nimport type { CaptureClientKind } from './capture'\nimport type { AnalyticsAdapter, MetricKey } from './contract'\n\nconst DEFAULT_WARM_CRON = '*/30 * * * *'\nconst DEFAULT_SYNC_CRON = '0 */6 * * *'\nconst DEFAULT_SYNC_COLLECTION = 'analytics-daily'\nconst DEFAULT_SYNC_LOOKBACK = 3\nconst DEFAULT_SCOPE_FIELD = 'scope'\nconst DEFAULT_TIMEOUT_MS = 15_000\n\n/**\n * Maps a request to its analytics boundary (tenant id, site key). Null means the\n * whole install, which is the default single-site behavior. With a multi-tenant\n * plugin, return the request's tenant id here.\n */\nexport type ScopeResolver = (args: {\n\treq: PayloadRequest\n}) => string | null | Promise<string | null>\n\n/**\n * Resolves the IANA reporting timezone a read's (or ingest's) day boundaries align\n * to. Receives the request and its already-resolved scope, so per-tenant, per-user\n * (`req.user`), and selector (cookie/preference) strategies are all expressible.\n * Return `null` to fall back to UTC.\n */\nexport type TimezoneResolver = (args: {\n\treq: PayloadRequest\n\tscope: string | null\n}) => string | null | Promise<string | null>\n\n/**\n * Enumerates the tenant scopes the cron tiers (cache warming, sync) fan out over.\n * Absent, each tier runs once for the install-wide scope.\n */\nexport type ScopesResolver = (args: { payload: Payload }) => string[] | Promise<string[]>\n\n/**\n * Escape hatch replacing the provider-collection lookup: return the runtime\n * adapters for a scope yourself (any store, any shape). Results are layered onto\n * the static config adapters exactly like collection-resolved ones, but are not\n * cached; memoize inside the function if lookups are expensive.\n */\nexport type ProvidersResolve = (args: {\n\tpayload: Payload\n\treq?: PayloadRequest\n\tscope: string | null\n}) => AnalyticsAdapter[] | Promise<AnalyticsAdapter[]>\n\nexport type ProvidersCollectionOptions = {\n\tslug?: string\n\t/**\n\t * Field matched against the resolved scope when looking up a scope's providers.\n\t * Point it at a tenant plugin's field (e.g. 'tenant') when that plugin manages\n\t * scoping for the collection.\n\t */\n\tscopeField?: string\n\toverrides?: (collection: CollectionConfig) => CollectionConfig\n\taccess?: Partial<CollectionConfig['access']>\n\t/**\n\t * Dedicated key ring for the stored provider credentials. Unset, the\n\t * fields plugin's global `encrypted.keys` applies, and with neither the\n\t * ring derives from the Payload secret. Configure a dedicated key for\n\t * anything beyond a dev install.\n\t */\n\tencryption?: { keys?: KeysConfig }\n}\n\nexport type ProvidersOptions = {\n\t/** Opt-in admin collection storing runtime provider configurations. */\n\tcollection?: boolean | ProvidersCollectionOptions\n\tresolve?: ProvidersResolve\n}\n\n/** Access checker for cross-scope (platform) analytics reads. */\nexport type PlatformReadAccess = (args: { req: PayloadRequest }) => boolean | Promise<boolean>\n\n/** Access checker for authenticated analytics reads. */\nexport type AnalyticsReadAccess = (args: { req: PayloadRequest }) => boolean | Promise<boolean>\n\n/** Access checker for the analytics admin view. */\nexport type AnalyticsViewAccess = (args: { req: PayloadRequest }) => boolean | Promise<boolean>\n\nexport type AnalyticsAccessOptions = {\n\t/**\n\t * Gates every authenticated read endpoint: query, document panel, realtime, sources\n\t * and goals. Defaults to any authenticated user; narrow it to a role check to keep\n\t * analytics away from admins who should not see them. Scope gating is separate and\n\t * always applies: granting `read` never widens which scope a user reads.\n\t */\n\tread?: AnalyticsReadAccess\n\t/**\n\t * Gates cross-scope reads: explicit `scope: '*'` reads, and scoped reads through\n\t * a shared config adapter that cannot filter by scope. Scoped installs\n\t * (`scopeResolver` configured) default to deny; configure it, for example a role\n\t * check, so platform admins can read cross-scope and manage every tenant's\n\t * providers. Unscoped installs default to any authenticated admin-panel user.\n\t */\n\tplatformRead?: PlatformReadAccess\n\t/**\n\t * Gates the analytics admin view. Defaults to `read`, so one gate covers the view and\n\t * the endpoints behind it. A reader this denies still sees the nav link (it is a client\n\t * component with no access context) and lands on the view's no-access message.\n\t */\n\tview?: AnalyticsViewAccess\n}\n\nexport type ConsentMode = 'none' | 'required'\n\n/** Per-slot consent decision, evaluated against the slot's resolved adapter. */\nexport type ConsentResolver = (args: { slot: CaptureSlot; adapterId: string }) => ConsentMode\n\n/** An adapter id to fill a capture slot with, or `false` to leave it deliberately empty. */\nexport type CaptureSlotOption = string | false\n\n/**\n * A bare mode applies to every slot; a resolver decides per request-resolved adapter; the\n * object form maps ids and slots, with an adapter entry winning over a slot entry. Every\n * form overrides the default, which is `none` for the cookieless native tracker and\n * `required` for a vendor's.\n */\nexport type CaptureConsentOption =\n\t| ConsentMode\n\t| ConsentResolver\n\t| {\n\t\t\tslots?: Partial<Record<CaptureSlot, ConsentMode>>\n\t\t\t/**\n\t\t\t * Keyed by adapter id. A bare id must name a config adapter; a runtime provider\n\t\t\t * instance id (`<provider>:<instance>`) is taken on trust, since the providers it\n\t\t\t * comes from are only resolved per request.\n\t\t\t */\n\t\t\tadapters?: Record<string, ConsentMode>\n\t }\n\n/** The normalized policy the runtime evaluates; `kind` carries the adapter's tracker family. */\nexport type ConsentPolicy = (\n\tslot: CaptureSlot,\n\tadapterId: string,\n\tkind: CaptureClientKind\n) => ConsentMode\n\nexport type AutoCaptureOptions = {\n\tscrollDepth?: boolean\n\toutboundLinks?: boolean\n\tfileDownloads?: boolean\n\tgoalAttribute?: boolean\n}\n\nexport type ResolvedAutoCapture = Required<AutoCaptureOptions>\n\nexport type AnalyticsGoalsCollectionOptions = {\n\t/** Set false to keep the object form's other settings while leaving the collection off. */\n\tenabled?: boolean\n\tslug?: string\n\t/**\n\t * Field matched against the resolved scope when looking up a scope's goals. Point it at\n\t * a tenant plugin's field (e.g. 'tenant') when that plugin manages scoping.\n\t */\n\tscopeField?: string\n\toverrides?: (collection: CollectionConfig) => CollectionConfig\n\taccess?: Partial<CollectionConfig['access']>\n}\n\n/** Goals as config, plus the opt-in collection editors manage their own goals through. */\nexport type AnalyticsGoalsOptions = {\n\tdefaults?: Goal[]\n\t/** Opt-in admin collection whose goals merge over `defaults`, by slug, per scope. */\n\tcollection?: boolean | AnalyticsGoalsCollectionOptions\n}\n\nexport type AnalyticsCaptureOptions = {\n\t/**\n\t * Which adapter fills each capture slot, overriding the defaults: `global` is the\n\t * designated `platformAdapter`, or the single config adapter when only one is\n\t * configured; `tenant` is the resolved scope's default adapter. A `global` id must\n\t * name a config adapter; a `tenant` id may also name a runtime provider instance,\n\t * so it is resolved per request rather than validated at config time.\n\t *\n\t * `false` disables a slot outright: it fills with nothing, its proxy mount 404s, and\n\t * the tracker config omits it. Use it to keep a default from filling a slot at all.\n\t */\n\tslots?: { global?: CaptureSlotOption; tenant?: CaptureSlotOption }\n\t/**\n\t * Mount each slot's snippet points at. Defaults to the runtime proxy endpoint\n\t * (`<routes.api>/analytics/p/<slot>`); set it when the slot is served through Next\n\t * rewrites instead, passing the same path `captureRewrites` was mounted at.\n\t */\n\tpaths?: { global?: string; tenant?: string }\n\t/** Whether a slot's tracker waits for consent. Native defaults to no gate, vendors to one. */\n\tconsent?: CaptureConsentOption\n\t/** Browser auto-capture listeners, all on by default except `scrollDepth`. */\n\tautoCapture?: AutoCaptureOptions\n\t/** Limits for the public runtime capture proxy, separate from the read-path `cache`. */\n\tproxy?: {\n\t\t/**\n\t\t * Deadline for the upstream response headers, in ms. Default 10000. The body\n\t\t * download is not on the clock, so a large tracker bundle streams to completion.\n\t\t */\n\t\ttimeoutMs?: number\n\t\t/**\n\t\t * Largest proxied request body, in bytes. Default 1 MiB, which clears a PostHog\n\t\t * batch carrying session-replay data. Anything larger is refused with 413.\n\t\t */\n\t\tmaxBodyBytes?: number\n\t}\n}\n\nexport type AnalyticsViewOptions = {\n\t/** Admin path the view mounts at, under `routes.admin`. Default `/analytics`. */\n\tpath?: `/${string}`\n\t/** Timeframe the view opens on before the URL says otherwise. Default `last30days`. */\n\tdefaultRange?: TimeframePreset\n\t/** Metric the cards and the trend open on. Default `pageviews`. */\n\tdefaultMetric?: MetricKey\n\t/**\n\t * Nav link label. A string is used as-is; a map is keyed by admin language code and\n\t * falls back to `en`. Unset, the plugin's own translated label applies.\n\t */\n\tnavLabel?: string | Record<string, string>\n}\n\nexport interface ResolvedView {\n\tpath: `/${string}`\n\tdefaultRange: TimeframePreset\n\tdefaultMetric: MetricKey\n\tnavLabel?: string | Record<string, string>\n}\n\nexport type AnalyticsPluginOptions = {\n\tdisabled?: boolean\n\t/**\n\t * Per-locale overrides for this plugin's UI strings, keyed by the typed\n\t * translation keys exported from `@10x-media/analytics/i18n`. Values win over\n\t * the built-in locales key-by-key; locales the plugin does not ship are added\n\t * whole. App-level `i18n.translations` still wins over both.\n\t */\n\ttranslations?: TranslationsOption\n\tadapters?: AnalyticsAdapter[]\n\tdefaultAdapter?: string\n\tscopeResolver?: ScopeResolver\n\t/**\n\t * Enumerates the tenant scopes the cache-warming and sync cron tiers fan out\n\t * over, in addition to the install-wide (null) scope every tier already runs.\n\t * Unset, those tiers run once for the whole install, same as before.\n\t */\n\tscopes?: ScopesResolver\n\t/**\n\t * IANA reporting timezone that day boundaries (timeframe windows, series axes,\n\t * native rollup buckets) align to. Defaults to UTC. A string forces one timezone\n\t * (the single-tenant / no-multi-tenancy case); a resolver derives it per request\n\t * from the scope, user, or a selector. Native rollups bucket at ingest in the\n\t * resolved timezone, so changing it does not re-bucket existing history.\n\t */\n\treportingTimezone?: string | TimezoneResolver\n\tproviders?: ProvidersOptions\n\t/**\n\t * Id of one config adapter shared by every scope (the platform's own analytics,\n\t * e.g. a PostHog project capturing all tenants). Included in each scope's\n\t * registry like any config adapter; reads through it are scope-filtered only\n\t * when the adapter supports scoped queries, otherwise they are cross-scope and\n\t * require `access.platformRead`.\n\t */\n\tplatformAdapter?: string\n\taccess?: AnalyticsAccessOptions\n\t/**\n\t * The analytics admin view and its nav link, on by default. `false` registers neither;\n\t * the read endpoints stay mounted either way, so a custom surface keeps working.\n\t */\n\tview?: false | AnalyticsViewOptions\n\tcapture?: AnalyticsCaptureOptions\n\t/**\n\t * Conversion goals the tracker and the native ingest match events against. Slugs must\n\t * be unique and kebab-case; only the slug and its match reach the browser.\n\t */\n\tgoals?: Goal[] | AnalyticsGoalsOptions\n\t/**\n\t * Per-collection bindings, keyed by collection slug. With generated types\n\t * augmented, each slug's resolvers receive that collection's typed document.\n\t */\n\tcollections?: { [TSlug in CollectionSlug]?: AnalyticsBinding<TSlug> }\n\tcache?: {\n\t\tttl?: { aggregate?: number; realtime?: number }\n\t\twarm?: boolean | { cron?: string }\n\t\t/** Per-read provider timeout in ms, spanning retries and limiter waits. Default 15000. */\n\t\ttimeoutMs?: number\n\t}\n\twidgets?:\n\t\t| boolean\n\t\t| {\n\t\t\t\tdisabled?: string[]\n\t\t\t\tregister?: CustomWidgetDef[]\n\t\t\t\t/**\n\t\t\t\t * Marks the free-text widget config fields (each widget's Title) as\n\t\t\t\t * `localized`. Off by default; takes effect only when the Payload config\n\t\t\t\t * enables localization (Payload strips the flag otherwise).\n\t\t\t\t */\n\t\t\t\tlocalizeText?: boolean\n\t\t\t\t/**\n\t\t\t\t * Period-over-period comparison on the metric and trend widgets. On by\n\t\t\t\t * default for adapters that declare `capabilities.comparison`; set false\n\t\t\t\t * to skip the second (previous-window) read entirely.\n\t\t\t\t */\n\t\t\t\tcomparison?: boolean\n\t\t }\n\t/**\n\t * Opt-in sync tier: a cron job that persists each provider's daily metrics into a\n\t * queryable collection. Reads go through the surfacing cache, so persisted rows reflect\n\t * cached values up to `cache.ttl.aggregate` old; keep that TTL below the sync interval\n\t * for the freshest data.\n\t */\n\tsync?:\n\t\t| boolean\n\t\t| {\n\t\t\t\tcollectionSlug?: CollectionSlug\n\t\t\t\tcron?: string\n\t\t\t\tlookbackDays?: number\n\t\t\t\tadapters?: string[]\n\t\t\t\t/** Surface the analytics-daily collection in the admin nav. Default false (hidden). */\n\t\t\t\thidden?: boolean\n\t\t }\n}\n\nexport interface ResolvedCapture {\n\tslots: { global?: CaptureSlotOption; tenant?: CaptureSlotOption }\n\tpaths: { global?: string; tenant?: string }\n\tconsent: ConsentPolicy\n\tautoCapture: ResolvedAutoCapture\n\tproxy: { timeoutMs: number; maxBodyBytes: number }\n}\n\nexport interface ResolvedOptions {\n\tadapters: AnalyticsAdapter[]\n\tdefaultAdapter?: string\n\tscopeResolver: ScopeResolver\n\t/** True when the app configured a scopeResolver (scoped install). */\n\tscoped: boolean\n\t/** Raw scopes option; undefined runs the cron tiers install-wide only. */\n\tscopes?: ScopesResolver\n\t/** Raw reportingTimezone option; normalized into a resolver at init. */\n\treportingTimezone?: string | TimezoneResolver\n\tplatformAdapter?: string\n\taccess: {\n\t\tplatformRead: PlatformReadAccess\n\t\tread: AnalyticsReadAccess\n\t\tview: AnalyticsViewAccess\n\t}\n\t/** The admin view, filled with its defaults, or false when the app turned it off. */\n\tview: false | ResolvedView\n\tcapture: ResolvedCapture\n\t/** Config goals, validated; the goals collection layers its own on top of these. */\n\tgoals: Goal[]\n\tgoalsCollection: {\n\t\tenabled: boolean\n\t\tslug: string\n\t\tscopeField: string\n\t\toverrides?: (collection: CollectionConfig) => CollectionConfig\n\t\taccess?: Partial<CollectionConfig['access']>\n\t}\n\tproviders: {\n\t\tcollection: {\n\t\t\tenabled: boolean\n\t\t\tslug: string\n\t\t\tscopeField: string\n\t\t\toverrides?: (collection: CollectionConfig) => CollectionConfig\n\t\t\taccess?: Partial<CollectionConfig['access']>\n\t\t\tencryption?: { keys?: KeysConfig }\n\t\t}\n\t\tresolve?: ProvidersResolve\n\t}\n\tbindings: Record<string, ResolvedBinding>\n\tcache: {\n\t\t/** Undefined when unset: adapter recommendedTtl is the fallback, an explicit value wins. */\n\t\tttl: { aggregate?: number; realtime?: number }\n\t\twarm: { enabled: boolean; cron: string }\n\t\ttimeoutMs: number\n\t}\n\twidgets: {\n\t\tenabled: boolean\n\t\tdisabled: string[]\n\t\tregister: CustomWidgetDef[]\n\t\tlocalizeText: boolean\n\t\tcomparison: boolean\n\t}\n\tsync: {\n\t\tenabled: boolean\n\t\tcollectionSlug: string\n\t\tcron: string\n\t\tlookbackDays: number\n\t\tadapters?: string[]\n\t\t/** True hides the analytics-daily collection from the admin nav (default). */\n\t\thidden: boolean\n\t}\n}\n\n/** Scroll depth is the one listener off by default: it fires on every page, for every visitor. */\nexport const DEFAULT_AUTO_CAPTURE: ResolvedAutoCapture = {\n\tscrollDepth: false,\n\toutboundLinks: true,\n\tfileDownloads: true,\n\tgoalAttribute: true,\n}\n\nconst resolveAutoCapture = (option: AutoCaptureOptions | undefined): ResolvedAutoCapture => ({\n\tscrollDepth: option?.scrollDepth ?? DEFAULT_AUTO_CAPTURE.scrollDepth,\n\toutboundLinks: option?.outboundLinks ?? DEFAULT_AUTO_CAPTURE.outboundLinks,\n\tfileDownloads: option?.fileDownloads ?? DEFAULT_AUTO_CAPTURE.fileDownloads,\n\tgoalAttribute: option?.goalAttribute ?? DEFAULT_AUTO_CAPTURE.goalAttribute,\n})\n\n/** Cookieless native capture needs no consent gate; a vendor's tracker does. */\nexport const defaultConsentFor = (kind: CaptureClientKind): ConsentMode =>\n\tkind === 'native' ? 'none' : 'required'\n\nconst resolveConsent = (\n\toption: CaptureConsentOption | undefined,\n\tadapters: AnalyticsAdapter[]\n): ConsentPolicy => {\n\tif (option === 'none' || option === 'required') {\n\t\treturn () => option\n\t}\n\tif (typeof option === 'function') {\n\t\treturn (slot, adapterId) => option({ slot, adapterId })\n\t}\n\tfor (const id of Object.keys(option?.adapters ?? {})) {\n\t\t// A runtime provider instance id is `<provider>:<instance>` and only exists once a\n\t\t// scope resolves, so it cannot be checked here; a bare id must name a config adapter.\n\t\tif (!id.includes(':') && !adapters.some((a) => a.id === id)) {\n\t\t\tthrow new Error(`analytics: unknown consent adapter \"${id}\"`)\n\t\t}\n\t}\n\treturn (slot, adapterId, kind) =>\n\t\toption?.adapters?.[adapterId] ?? option?.slots?.[slot] ?? defaultConsentFor(kind)\n}\n\nconst resolveGoals = (option: AnalyticsPluginOptions['goals']): Goal[] => {\n\tconst goals = Array.isArray(option) ? option : (option?.defaults ?? [])\n\tconst seen = new Set<string>()\n\tfor (const goal of goals) {\n\t\tif (!GOAL_SLUG_PATTERN.test(goal.slug)) {\n\t\t\tthrow new Error(`analytics: goal slug \"${goal.slug}\" must be kebab-case`)\n\t\t}\n\t\tif (seen.has(goal.slug)) {\n\t\t\tthrow new Error(`analytics: duplicate goal slug \"${goal.slug}\"`)\n\t\t}\n\t\tconst fixed = goal.value?.fixed\n\t\t// Revenue is money: a negative or non-finite fixed value would be silently ignored at\n\t\t// ingest, so it fails the boot instead.\n\t\tif (fixed !== undefined && (!Number.isFinite(fixed) || fixed < 0)) {\n\t\t\tthrow new Error(\n\t\t\t\t`analytics: goal \"${goal.slug}\" value.fixed must be a finite number >= 0, got ${String(fixed)}`\n\t\t\t)\n\t\t}\n\t\tseen.add(goal.slug)\n\t}\n\treturn goals\n}\n\nconst resolveGoalsCollection = (\n\toption: AnalyticsPluginOptions['goals']\n): ResolvedOptions['goalsCollection'] => {\n\tconst off = { enabled: false, slug: GOALS_SLUG, scopeField: DEFAULT_SCOPE_FIELD }\n\tconst collection = Array.isArray(option) ? undefined : option?.collection\n\tif (!collection) {\n\t\treturn off\n\t}\n\tconst resolved =\n\t\tcollection === true\n\t\t\t? { ...off, enabled: true }\n\t\t\t: {\n\t\t\t\t\tenabled: collection.enabled ?? true,\n\t\t\t\t\tslug: collection.slug ?? GOALS_SLUG,\n\t\t\t\t\tscopeField: collection.scopeField ?? DEFAULT_SCOPE_FIELD,\n\t\t\t\t\toverrides: collection.overrides,\n\t\t\t\t\taccess: collection.access,\n\t\t\t\t}\n\tif (!resolved.enabled) {\n\t\treturn off\n\t}\n\tif (typeof resolved.slug !== 'string' || resolved.slug.trim() === '') {\n\t\tthrow new Error('analytics: goals.collection.slug must be a non-empty collection slug')\n\t}\n\tif (resolved.scopeField.trim() === '') {\n\t\tthrow new Error('analytics: goals.collection.scopeField must be a non-empty field name')\n\t}\n\tif (resolved.scopeField.includes('.')) {\n\t\tthrow new Error(\n\t\t\t'analytics: goals.collection.scopeField must be a top-level field name (no dots); the scope stamp writes it as a flat key'\n\t\t)\n\t}\n\treturn { ...resolved, slug: resolved.slug.trim() }\n}\n\nexport const DEFAULT_VIEW: ResolvedView = {\n\tpath: '/analytics',\n\tdefaultRange: 'last30days',\n\tdefaultMetric: 'pageviews',\n}\n\nconst resolveView = (option: AnalyticsPluginOptions['view']): false | ResolvedView => {\n\tif (option === false) {\n\t\treturn false\n\t}\n\tconst path = option?.path ?? DEFAULT_VIEW.path\n\tif (typeof path !== 'string' || !path.startsWith('/')) {\n\t\tthrow new Error(`analytics: view.path must start with \"/\", got \"${String(path)}\"`)\n\t}\n\tconst defaultRange = option?.defaultRange ?? DEFAULT_VIEW.defaultRange\n\tif (!TIMEFRAME_PRESETS.includes(defaultRange)) {\n\t\tthrow new Error(`analytics: unknown view.defaultRange \"${String(defaultRange)}\"`)\n\t}\n\tconst defaultMetric = option?.defaultMetric ?? DEFAULT_VIEW.defaultMetric\n\tif (!(defaultMetric in METRIC_KEYS)) {\n\t\tthrow new Error(`analytics: unknown view.defaultMetric \"${String(defaultMetric)}\"`)\n\t}\n\treturn {\n\t\tpath,\n\t\tdefaultRange,\n\t\tdefaultMetric,\n\t\t...(option?.navLabel !== undefined ? { navLabel: option.navLabel } : {}),\n\t}\n}\n\nconst resolveBindings = (\n\tcollections: AnalyticsPluginOptions['collections']\n): Record<string, ResolvedBinding> => {\n\tconst out: Record<string, ResolvedBinding> = {}\n\tfor (const [slug, binding] of Object.entries(collections ?? {})) {\n\t\tif (!binding) continue\n\t\tif (!binding.path && !binding.pathField) {\n\t\t\tthrow new Error(`analytics: binding for \"${slug}\" needs a path resolver or a pathField`)\n\t\t}\n\t\t// Erases the per-slug doc generic; safe because the runtime only ever hands\n\t\t// a binding documents from its own collection.\n\t\tout[slug] = binding as ResolvedBinding\n\t}\n\treturn out\n}\n\nexport function resolveOptions(options: AnalyticsPluginOptions): ResolvedOptions {\n\tif (!options.adapters || options.adapters.length === 0) {\n\t\tthrow new Error('analytics: at least one adapter is required')\n\t}\n\tif (\n\t\toptions.platformAdapter !== undefined &&\n\t\t!options.adapters.some((a) => a.id === options.platformAdapter)\n\t) {\n\t\tthrow new Error(`analytics: unknown platform adapter \"${options.platformAdapter}\"`)\n\t}\n\tfor (const [slot, value] of Object.entries(options.capture?.slots ?? {})) {\n\t\tif (value !== false && typeof value !== 'string' && value !== undefined) {\n\t\t\tthrow new Error(\n\t\t\t\t`analytics: capture slot \"${slot}\" must be an adapter id or false, got ${typeof value}`\n\t\t\t)\n\t\t}\n\t}\n\tconst globalSlot = options.capture?.slots?.global\n\t// A tenant id may name a runtime provider instance, which only exists once a scope\n\t// resolves; a global one can only come from the config registry, so it is checked here.\n\tif (typeof globalSlot === 'string' && !options.adapters.some((a) => a.id === globalSlot)) {\n\t\tthrow new Error(`analytics: unknown global capture slot adapter \"${globalSlot}\"`)\n\t}\n\tconst widgets =\n\t\toptions.widgets === false\n\t\t\t? {\n\t\t\t\t\tenabled: false,\n\t\t\t\t\tdisabled: [] as string[],\n\t\t\t\t\tregister: [] as CustomWidgetDef[],\n\t\t\t\t\tlocalizeText: false,\n\t\t\t\t\tcomparison: true,\n\t\t\t\t}\n\t\t\t: options.widgets === undefined || options.widgets === true\n\t\t\t\t? {\n\t\t\t\t\t\tenabled: true,\n\t\t\t\t\t\tdisabled: [] as string[],\n\t\t\t\t\t\tregister: [] as CustomWidgetDef[],\n\t\t\t\t\t\tlocalizeText: false,\n\t\t\t\t\t\tcomparison: true,\n\t\t\t\t\t}\n\t\t\t\t: {\n\t\t\t\t\t\tenabled: true,\n\t\t\t\t\t\tdisabled: options.widgets.disabled ?? [],\n\t\t\t\t\t\tregister: options.widgets.register ?? [],\n\t\t\t\t\t\tlocalizeText: options.widgets.localizeText ?? false,\n\t\t\t\t\t\tcomparison: options.widgets.comparison ?? true,\n\t\t\t\t\t}\n\tconst warmOpt = options.cache?.warm\n\tconst warm =\n\t\twarmOpt === true\n\t\t\t? { enabled: true, cron: DEFAULT_WARM_CRON }\n\t\t\t: warmOpt && typeof warmOpt === 'object'\n\t\t\t\t? { enabled: true, cron: warmOpt.cron ?? DEFAULT_WARM_CRON }\n\t\t\t\t: { enabled: false, cron: DEFAULT_WARM_CRON }\n\tconst collectionOpt = options.providers?.collection\n\tconst providers = {\n\t\tcollection:\n\t\t\tcollectionOpt === true\n\t\t\t\t? { enabled: true, slug: PROVIDERS_SLUG, scopeField: DEFAULT_SCOPE_FIELD }\n\t\t\t\t: collectionOpt && typeof collectionOpt === 'object'\n\t\t\t\t\t? {\n\t\t\t\t\t\t\tenabled: true,\n\t\t\t\t\t\t\tslug: collectionOpt.slug ?? PROVIDERS_SLUG,\n\t\t\t\t\t\t\tscopeField: collectionOpt.scopeField ?? DEFAULT_SCOPE_FIELD,\n\t\t\t\t\t\t\toverrides: collectionOpt.overrides,\n\t\t\t\t\t\t\taccess: collectionOpt.access,\n\t\t\t\t\t\t\tencryption: collectionOpt.encryption,\n\t\t\t\t\t\t}\n\t\t\t\t\t: { enabled: false, slug: PROVIDERS_SLUG, scopeField: DEFAULT_SCOPE_FIELD },\n\t\tresolve: options.providers?.resolve,\n\t}\n\tif (providers.collection.enabled) {\n\t\tif (providers.collection.scopeField.trim() === '') {\n\t\t\tthrow new Error('analytics: providers.collection.scopeField must be a non-empty field name')\n\t\t}\n\t\tif (providers.collection.scopeField.includes('.')) {\n\t\t\tthrow new Error(\n\t\t\t\t'analytics: providers.collection.scopeField must be a top-level field name (no dots); the scope stamp writes it as a flat key'\n\t\t\t)\n\t\t}\n\t}\n\tconst syncOpt = options.sync\n\tconst sync =\n\t\tsyncOpt === true\n\t\t\t? {\n\t\t\t\t\tenabled: true,\n\t\t\t\t\tcollectionSlug: DEFAULT_SYNC_COLLECTION,\n\t\t\t\t\tcron: DEFAULT_SYNC_CRON,\n\t\t\t\t\tlookbackDays: DEFAULT_SYNC_LOOKBACK,\n\t\t\t\t\thidden: true,\n\t\t\t\t}\n\t\t\t: syncOpt && typeof syncOpt === 'object'\n\t\t\t\t? {\n\t\t\t\t\t\tenabled: true,\n\t\t\t\t\t\tcollectionSlug: syncOpt.collectionSlug ?? DEFAULT_SYNC_COLLECTION,\n\t\t\t\t\t\tcron: syncOpt.cron ?? DEFAULT_SYNC_CRON,\n\t\t\t\t\t\tlookbackDays: syncOpt.lookbackDays ?? DEFAULT_SYNC_LOOKBACK,\n\t\t\t\t\t\tadapters: syncOpt.adapters,\n\t\t\t\t\t\thidden: syncOpt.hidden ?? true,\n\t\t\t\t\t}\n\t\t\t\t: {\n\t\t\t\t\t\tenabled: false,\n\t\t\t\t\t\tcollectionSlug: DEFAULT_SYNC_COLLECTION,\n\t\t\t\t\t\tcron: DEFAULT_SYNC_CRON,\n\t\t\t\t\t\tlookbackDays: DEFAULT_SYNC_LOOKBACK,\n\t\t\t\t\t\thidden: true,\n\t\t\t\t\t}\n\tconst scoped = options.scopeResolver !== undefined\n\t// The view gate defaults to this exact function, so one `access.read` covers both.\n\tconst read: AnalyticsReadAccess = options.access?.read ?? (({ req }) => Boolean(req.user))\n\treturn {\n\t\tadapters: options.adapters,\n\t\tdefaultAdapter: options.defaultAdapter,\n\t\tscopeResolver: options.scopeResolver ?? (() => null),\n\t\tscoped,\n\t\tscopes: options.scopes,\n\t\treportingTimezone: options.reportingTimezone,\n\t\tplatformAdapter: options.platformAdapter,\n\t\taccess: {\n\t\t\tplatformRead:\n\t\t\t\toptions.access?.platformRead ?? (scoped ? () => false : ({ req }) => Boolean(req.user)),\n\t\t\tread,\n\t\t\tview: options.access?.view ?? read,\n\t\t},\n\t\tview: resolveView(options.view),\n\t\tcapture: {\n\t\t\tslots: {\n\t\t\t\tglobal: options.capture?.slots?.global,\n\t\t\t\ttenant: options.capture?.slots?.tenant,\n\t\t\t},\n\t\t\tpaths: {\n\t\t\t\tglobal: options.capture?.paths?.global,\n\t\t\t\ttenant: options.capture?.paths?.tenant,\n\t\t\t},\n\t\t\tconsent: resolveConsent(options.capture?.consent, options.adapters),\n\t\t\tautoCapture: resolveAutoCapture(options.capture?.autoCapture),\n\t\t\tproxy: {\n\t\t\t\ttimeoutMs: options.capture?.proxy?.timeoutMs ?? DEFAULT_PROXY_TIMEOUT_MS,\n\t\t\t\tmaxBodyBytes: options.capture?.proxy?.maxBodyBytes ?? DEFAULT_PROXY_MAX_BODY_BYTES,\n\t\t\t},\n\t\t},\n\t\tgoals: resolveGoals(options.goals),\n\t\tgoalsCollection: resolveGoalsCollection(options.goals),\n\t\tproviders,\n\t\tbindings: resolveBindings(options.collections),\n\t\tcache: {\n\t\t\t// Left undefined when the app did not set them so the adapter's recommendedTtl\n\t\t\t// applies as the default; an explicit value overrides the adapter recommendation.\n\t\t\tttl: {\n\t\t\t\taggregate: options.cache?.ttl?.aggregate,\n\t\t\t\trealtime: options.cache?.ttl?.realtime,\n\t\t\t},\n\t\t\twarm,\n\t\t\ttimeoutMs: options.cache?.timeoutMs ?? DEFAULT_TIMEOUT_MS,\n\t\t},\n\t\twidgets,\n\t\tsync,\n\t}\n}\n"],"mappings":";;;;;;;AAeA,MAAM,oBAAoB;AAC1B,MAAM,oBAAoB;AAC1B,MAAM,0BAA0B;AAChC,MAAM,wBAAwB;AAC9B,MAAM,sBAAsB;AAC5B,MAAM,qBAAqB;;AAkY3B,MAAa,uBAA4C;CACxD,aAAa;CACb,eAAe;CACf,eAAe;CACf,eAAe;AAChB;AAEA,MAAM,sBAAsB,YAAiE;CAC5F,aAAa,QAAQ,eAAe,qBAAqB;CACzD,eAAe,QAAQ,iBAAiB,qBAAqB;CAC7D,eAAe,QAAQ,iBAAiB,qBAAqB;CAC7D,eAAe,QAAQ,iBAAiB,qBAAqB;AAC9D;;AAGA,MAAa,qBAAqB,SACjC,SAAS,WAAW,SAAS;AAE9B,MAAM,kBACL,QACA,aACmB;CACnB,IAAI,WAAW,UAAU,WAAW,YACnC,aAAa;CAEd,IAAI,OAAO,WAAW,YACrB,QAAQ,MAAM,cAAc,OAAO;EAAE;EAAM;CAAU,CAAC;CAEvD,KAAK,MAAM,MAAM,OAAO,KAAK,QAAQ,YAAY,CAAC,CAAC,GAGlD,IAAI,CAAC,GAAG,SAAS,GAAG,KAAK,CAAC,SAAS,MAAM,MAAM,EAAE,OAAO,EAAE,GACzD,MAAM,IAAI,MAAM,uCAAuC,GAAG,EAAE;CAG9D,QAAQ,MAAM,WAAW,SACxB,QAAQ,WAAW,cAAc,QAAQ,QAAQ,SAAS,kBAAkB,IAAI;AAClF;AAEA,MAAM,gBAAgB,WAAoD;CACzE,MAAM,QAAQ,MAAM,QAAQ,MAAM,IAAI,SAAU,QAAQ,YAAY,CAAC;CACrE,MAAM,uBAAO,IAAI,IAAY;CAC7B,KAAK,MAAM,QAAQ,OAAO;EACzB,IAAI,CAAC,kBAAkB,KAAK,KAAK,IAAI,GACpC,MAAM,IAAI,MAAM,yBAAyB,KAAK,KAAK,qBAAqB;EAEzE,IAAI,KAAK,IAAI,KAAK,IAAI,GACrB,MAAM,IAAI,MAAM,mCAAmC,KAAK,KAAK,EAAE;EAEhE,MAAM,QAAQ,KAAK,OAAO;EAG1B,IAAI,UAAU,KAAA,MAAc,CAAC,OAAO,SAAS,KAAK,KAAK,QAAQ,IAC9D,MAAM,IAAI,MACT,oBAAoB,KAAK,KAAK,kDAAkD,OAAO,KAAK,GAC7F;EAED,KAAK,IAAI,KAAK,IAAI;CACnB;CACA,OAAO;AACR;AAEA,MAAM,0BACL,WACwC;CACxC,MAAM,MAAM;EAAE,SAAS;EAAO,MAAM;EAAY,YAAY;CAAoB;CAChF,MAAM,aAAa,MAAM,QAAQ,MAAM,IAAI,KAAA,IAAY,QAAQ;CAC/D,IAAI,CAAC,YACJ,OAAO;CAER,MAAM,WACL,eAAe,OACZ;EAAE,GAAG;EAAK,SAAS;CAAK,IACxB;EACA,SAAS,WAAW,WAAW;EAC/B,MAAM,WAAW,QAAA;EACjB,YAAY,WAAW,cAAc;EACrC,WAAW,WAAW;EACtB,QAAQ,WAAW;CACpB;CACH,IAAI,CAAC,SAAS,SACb,OAAO;CAER,IAAI,OAAO,SAAS,SAAS,YAAY,SAAS,KAAK,KAAK,MAAM,IACjE,MAAM,IAAI,MAAM,sEAAsE;CAEvF,IAAI,SAAS,WAAW,KAAK,MAAM,IAClC,MAAM,IAAI,MAAM,uEAAuE;CAExF,IAAI,SAAS,WAAW,SAAS,GAAG,GACnC,MAAM,IAAI,MACT,0HACD;CAED,OAAO;EAAE,GAAG;EAAU,MAAM,SAAS,KAAK,KAAK;CAAE;AAClD;AAEA,MAAa,eAA6B;CACzC,MAAM;CACN,cAAc;CACd,eAAe;AAChB;AAEA,MAAM,eAAe,WAAiE;CACrF,IAAI,WAAW,OACd,OAAO;CAER,MAAM,OAAO,QAAQ,QAAQ,aAAa;CAC1C,IAAI,OAAO,SAAS,YAAY,CAAC,KAAK,WAAW,GAAG,GACnD,MAAM,IAAI,MAAM,kDAAkD,OAAO,IAAI,EAAE,EAAE;CAElF,MAAM,eAAe,QAAQ,gBAAgB,aAAa;CAC1D,IAAI,CAAC,kBAAkB,SAAS,YAAY,GAC3C,MAAM,IAAI,MAAM,yCAAyC,OAAO,YAAY,EAAE,EAAE;CAEjF,MAAM,gBAAgB,QAAQ,iBAAiB,aAAa;CAC5D,IAAI,EAAE,iBAAiB,cACtB,MAAM,IAAI,MAAM,0CAA0C,OAAO,aAAa,EAAE,EAAE;CAEnF,OAAO;EACN;EACA;EACA;EACA,GAAI,QAAQ,aAAa,KAAA,IAAY,EAAE,UAAU,OAAO,SAAS,IAAI,CAAC;CACvE;AACD;AAEA,MAAM,mBACL,gBACqC;CACrC,MAAM,MAAuC,CAAC;CAC9C,KAAK,MAAM,CAAC,MAAM,YAAY,OAAO,QAAQ,eAAe,CAAC,CAAC,GAAG;EAChE,IAAI,CAAC,SAAS;EACd,IAAI,CAAC,QAAQ,QAAQ,CAAC,QAAQ,WAC7B,MAAM,IAAI,MAAM,2BAA2B,KAAK,uCAAuC;EAIxF,IAAI,QAAQ;CACb;CACA,OAAO;AACR;AAEA,SAAgB,eAAe,SAAkD;CAChF,IAAI,CAAC,QAAQ,YAAY,QAAQ,SAAS,WAAW,GACpD,MAAM,IAAI,MAAM,6CAA6C;CAE9D,IACC,QAAQ,oBAAoB,KAAA,KAC5B,CAAC,QAAQ,SAAS,MAAM,MAAM,EAAE,OAAO,QAAQ,eAAe,GAE9D,MAAM,IAAI,MAAM,wCAAwC,QAAQ,gBAAgB,EAAE;CAEnF,KAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAQ,QAAQ,SAAS,SAAS,CAAC,CAAC,GACtE,IAAI,UAAU,SAAS,OAAO,UAAU,YAAY,UAAU,KAAA,GAC7D,MAAM,IAAI,MACT,4BAA4B,KAAK,wCAAwC,OAAO,OACjF;CAGF,MAAM,aAAa,QAAQ,SAAS,OAAO;CAG3C,IAAI,OAAO,eAAe,YAAY,CAAC,QAAQ,SAAS,MAAM,MAAM,EAAE,OAAO,UAAU,GACtF,MAAM,IAAI,MAAM,mDAAmD,WAAW,EAAE;CAEjF,MAAM,UACL,QAAQ,YAAY,QACjB;EACA,SAAS;EACT,UAAU,CAAC;EACX,UAAU,CAAC;EACX,cAAc;EACd,YAAY;CACb,IACC,QAAQ,YAAY,KAAA,KAAa,QAAQ,YAAY,OACpD;EACA,SAAS;EACT,UAAU,CAAC;EACX,UAAU,CAAC;EACX,cAAc;EACd,YAAY;CACb,IACC;EACA,SAAS;EACT,UAAU,QAAQ,QAAQ,YAAY,CAAC;EACvC,UAAU,QAAQ,QAAQ,YAAY,CAAC;EACvC,cAAc,QAAQ,QAAQ,gBAAgB;EAC9C,YAAY,QAAQ,QAAQ,cAAc;CAC3C;CACJ,MAAM,UAAU,QAAQ,OAAO;CAC/B,MAAM,OACL,YAAY,OACT;EAAE,SAAS;EAAM,MAAM;CAAkB,IACzC,WAAW,OAAO,YAAY,WAC7B;EAAE,SAAS;EAAM,MAAM,QAAQ,QAAQ;CAAkB,IACzD;EAAE,SAAS;EAAO,MAAM;CAAkB;CAC/C,MAAM,gBAAgB,QAAQ,WAAW;CACzC,MAAM,YAAY;EACjB,YACC,kBAAkB,OACf;GAAE,SAAS;GAAM,MAAM;GAAgB,YAAY;EAAoB,IACvE,iBAAiB,OAAO,kBAAkB,WACzC;GACA,SAAS;GACT,MAAM,cAAc,QAAA;GACpB,YAAY,cAAc,cAAc;GACxC,WAAW,cAAc;GACzB,QAAQ,cAAc;GACtB,YAAY,cAAc;EAC3B,IACC;GAAE,SAAS;GAAO,MAAM;GAAgB,YAAY;EAAoB;EAC7E,SAAS,QAAQ,WAAW;CAC7B;CACA,IAAI,UAAU,WAAW,SAAS;EACjC,IAAI,UAAU,WAAW,WAAW,KAAK,MAAM,IAC9C,MAAM,IAAI,MAAM,2EAA2E;EAE5F,IAAI,UAAU,WAAW,WAAW,SAAS,GAAG,GAC/C,MAAM,IAAI,MACT,8HACD;CAEF;CACA,MAAM,UAAU,QAAQ;CACxB,MAAM,OACL,YAAY,OACT;EACA,SAAS;EACT,gBAAgB;EAChB,MAAM;EACN,cAAc;EACd,QAAQ;CACT,IACC,WAAW,OAAO,YAAY,WAC7B;EACA,SAAS;EACT,gBAAgB,QAAQ,kBAAkB;EAC1C,MAAM,QAAQ,QAAQ;EACtB,cAAc,QAAQ,gBAAgB;EACtC,UAAU,QAAQ;EAClB,QAAQ,QAAQ,UAAU;CAC3B,IACC;EACA,SAAS;EACT,gBAAgB;EAChB,MAAM;EACN,cAAc;EACd,QAAQ;CACT;CACJ,MAAM,SAAS,QAAQ,kBAAkB,KAAA;CAEzC,MAAM,OAA4B,QAAQ,QAAQ,UAAU,EAAE,UAAU,QAAQ,IAAI,IAAI;CACxF,OAAO;EACN,UAAU,QAAQ;EAClB,gBAAgB,QAAQ;EACxB,eAAe,QAAQ,wBAAwB;EAC/C;EACA,QAAQ,QAAQ;EAChB,mBAAmB,QAAQ;EAC3B,iBAAiB,QAAQ;EACzB,QAAQ;GACP,cACC,QAAQ,QAAQ,iBAAiB,eAAe,SAAS,EAAE,UAAU,QAAQ,IAAI,IAAI;GACtF;GACA,MAAM,QAAQ,QAAQ,QAAQ;EAC/B;EACA,MAAM,YAAY,QAAQ,IAAI;EAC9B,SAAS;GACR,OAAO;IACN,QAAQ,QAAQ,SAAS,OAAO;IAChC,QAAQ,QAAQ,SAAS,OAAO;GACjC;GACA,OAAO;IACN,QAAQ,QAAQ,SAAS,OAAO;IAChC,QAAQ,QAAQ,SAAS,OAAO;GACjC;GACA,SAAS,eAAe,QAAQ,SAAS,SAAS,QAAQ,QAAQ;GAClE,aAAa,mBAAmB,QAAQ,SAAS,WAAW;GAC5D,OAAO;IACN,WAAW,QAAQ,SAAS,OAAO,aAAA;IACnC,cAAc,QAAQ,SAAS,OAAO,gBAAA;GACvC;EACD;EACA,OAAO,aAAa,QAAQ,KAAK;EACjC,iBAAiB,uBAAuB,QAAQ,KAAK;EACrD;EACA,UAAU,gBAAgB,QAAQ,WAAW;EAC7C,OAAO;GAGN,KAAK;IACJ,WAAW,QAAQ,OAAO,KAAK;IAC/B,UAAU,QAAQ,OAAO,KAAK;GAC/B;GACA;GACA,WAAW,QAAQ,OAAO,aAAa;EACxC;EACA;EACA;CACD;AACD"}
|
package/dist/core/scopedRead.js
CHANGED
|
@@ -1,7 +1,26 @@
|
|
|
1
|
-
import { platformReadFor, resolveRegistryFor, resolveScopeFor } from "../plugin/runtime.js";
|
|
2
1
|
import "./contract.js";
|
|
2
|
+
import { platformReadGate, resolveRegistryFor, resolveScopeFor } from "../plugin/runtime.js";
|
|
3
3
|
//#region src/core/scopedRead.ts
|
|
4
4
|
/**
|
|
5
|
+
* The scope to stamp on one adapter query, or a refusal. Cross-scope reads fail closed
|
|
6
|
+
* behind `platformRead`: the `'*'` marker, and any scoped read through a shared config
|
|
7
|
+
* adapter that cannot narrow the query to one scope (whether or not it is the designated
|
|
8
|
+
* platform adapter), which would otherwise answer with every scope's data. A tenant's own
|
|
9
|
+
* runtime adapters are never gated. Every read path decides this here, so the widgets and
|
|
10
|
+
* the query endpoint cannot drift apart on what counts as cross-scope.
|
|
11
|
+
*/
|
|
12
|
+
const resolveQueryScope = async (args) => {
|
|
13
|
+
const { runtime, req, scope, adapter } = args;
|
|
14
|
+
const allowed = args.platformRead ?? platformReadGate(runtime, req);
|
|
15
|
+
if (scope === "*") return await allowed() ? { ok: true } : { ok: false };
|
|
16
|
+
if (scope === null) return { ok: true };
|
|
17
|
+
if (runtime.configAdapterIds.has(adapter.id) && !adapter.capabilities.scopedQueries) return await allowed() ? { ok: true } : { ok: false };
|
|
18
|
+
return {
|
|
19
|
+
ok: true,
|
|
20
|
+
queryScope: scope
|
|
21
|
+
};
|
|
22
|
+
};
|
|
23
|
+
/**
|
|
5
24
|
* Resolve one read's scope and adapter: explicit scope wins over the request's
|
|
6
25
|
* resolved scope, the registry is resolved per scope, then the adapter is picked
|
|
7
26
|
* by id (or the registry default). Cross-scope reads fail closed behind
|
|
@@ -20,9 +39,10 @@ import "./contract.js";
|
|
|
20
39
|
*/
|
|
21
40
|
const resolveReadContext = async (args) => {
|
|
22
41
|
const { runtime, req, adapterId } = args;
|
|
42
|
+
const allowed = platformReadGate(runtime, req);
|
|
23
43
|
try {
|
|
24
44
|
const scope = args.scope !== void 0 ? args.scope : await resolveScopeFor(runtime, req);
|
|
25
|
-
if (runtime.scoped && args.scope === void 0 && scope === null && !await
|
|
45
|
+
if (runtime.scoped && args.scope === void 0 && scope === null && !await allowed()) return { ok: false };
|
|
26
46
|
const registryScope = scope === "*" ? null : scope;
|
|
27
47
|
const registry = await resolveRegistryFor(runtime, {
|
|
28
48
|
payload: req.payload,
|
|
@@ -30,29 +50,19 @@ const resolveReadContext = async (args) => {
|
|
|
30
50
|
scope: registryScope
|
|
31
51
|
});
|
|
32
52
|
const adapter = adapterId ? registry.get(adapterId) : registry.default();
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
}
|
|
42
|
-
if (scope !== null && runtime.configAdapterIds.has(adapter.id) && !adapter.capabilities.scopedQueries) {
|
|
43
|
-
if (!await platformReadFor(runtime, req)) return { ok: false };
|
|
44
|
-
return {
|
|
45
|
-
ok: true,
|
|
46
|
-
adapter,
|
|
47
|
-
scope,
|
|
48
|
-
queryScope: void 0
|
|
49
|
-
};
|
|
50
|
-
}
|
|
53
|
+
const decision = await resolveQueryScope({
|
|
54
|
+
runtime,
|
|
55
|
+
req,
|
|
56
|
+
scope,
|
|
57
|
+
adapter,
|
|
58
|
+
platformRead: allowed
|
|
59
|
+
});
|
|
60
|
+
if (!decision.ok) return { ok: false };
|
|
51
61
|
return {
|
|
52
62
|
ok: true,
|
|
53
63
|
adapter,
|
|
54
|
-
scope,
|
|
55
|
-
queryScope:
|
|
64
|
+
scope: registryScope,
|
|
65
|
+
queryScope: decision.queryScope
|
|
56
66
|
};
|
|
57
67
|
} catch (err) {
|
|
58
68
|
req.payload.logger?.warn(`analytics: read context resolution failed: ${String(err)}`);
|
|
@@ -60,6 +70,6 @@ const resolveReadContext = async (args) => {
|
|
|
60
70
|
}
|
|
61
71
|
};
|
|
62
72
|
//#endregion
|
|
63
|
-
export { resolveReadContext };
|
|
73
|
+
export { resolveQueryScope, resolveReadContext };
|
|
64
74
|
|
|
65
75
|
//# sourceMappingURL=scopedRead.js.map
|