@10x-media/analytics 0.1.0-beta.3 → 0.1.0-beta.5
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 +18 -0
- package/README.md +2 -0
- package/dist/core/capabilities.d.ts +13 -2
- package/dist/core/capabilities.js +11 -1
- package/dist/core/capabilities.js.map +1 -1
- package/dist/core/options.d.ts +14 -2
- package/dist/core/options.js +9 -3
- package/dist/core/options.js.map +1 -1
- package/dist/core/scopedRead.js +7 -6
- package/dist/core/scopedRead.js.map +1 -1
- package/dist/exports/client.d.ts +5 -1
- package/dist/exports/client.js +4 -1
- package/dist/exports/rsc.d.ts +1 -1
- package/dist/exports/types.d.ts +2 -1
- package/dist/fields/config/MetricSelectField.d.ts +23 -0
- package/dist/fields/config/MetricSelectField.js +51 -0
- package/dist/fields/config/MetricSelectField.js.map +1 -0
- package/dist/fields/config/SourceSelectField.d.ts +14 -0
- package/dist/fields/config/SourceSelectField.js +46 -0
- package/dist/fields/config/SourceSelectField.js.map +1 -0
- package/dist/fields/config/fetchSources.d.ts +12 -0
- package/dist/fields/config/fetchSources.js +29 -0
- package/dist/fields/config/fetchSources.js.map +1 -0
- package/dist/fields/config/narrow.js +30 -0
- package/dist/fields/config/narrow.js.map +1 -0
- package/dist/fields/config/sourcesState.js +11 -0
- package/dist/fields/config/sourcesState.js.map +1 -0
- package/dist/fields/config/toSelectOption.js +27 -0
- package/dist/fields/config/toSelectOption.js.map +1 -0
- package/dist/fields/config/useAnalyticsSources.d.ts +19 -0
- package/dist/fields/config/useAnalyticsSources.js +59 -0
- package/dist/fields/config/useAnalyticsSources.js.map +1 -0
- package/dist/index.js +51 -16
- package/dist/index.js.map +1 -1
- package/dist/plugin/paths.js +3 -1
- package/dist/plugin/paths.js.map +1 -1
- package/dist/plugin/peerImportError.js +16 -0
- package/dist/plugin/peerImportError.js.map +1 -0
- package/dist/plugin/realtimeEndpoint.js +2 -2
- package/dist/plugin/realtimeEndpoint.js.map +1 -1
- package/dist/plugin/runtime.js.map +1 -1
- package/dist/plugin/sourcesEndpoint.js +53 -0
- package/dist/plugin/sourcesEndpoint.js.map +1 -0
- package/dist/providers/access.js +44 -0
- package/dist/providers/access.js.map +1 -0
- package/dist/providers/collection.js +46 -31
- package/dist/providers/collection.js.map +1 -1
- package/dist/providers/factory.js +21 -7
- package/dist/providers/factory.js.map +1 -1
- package/dist/providers/resolver.js +49 -14
- package/dist/providers/resolver.js.map +1 -1
- package/dist/providers/secrets.js +26 -21
- package/dist/providers/secrets.js.map +1 -1
- package/dist/providers/stampScope.js +35 -0
- package/dist/providers/stampScope.js.map +1 -0
- package/dist/translations/de.js +1 -1
- package/dist/translations/de.js.map +1 -1
- package/dist/translations/en.js +1 -1
- package/dist/translations/en.js.map +1 -1
- package/dist/translations/keys.d.ts +1 -1
- package/dist/translations/keys.js +1 -1
- package/dist/translations/keys.js.map +1 -1
- package/dist/widgets/AnalyticsRealtimeWidget.js +2 -2
- package/dist/widgets/AnalyticsRealtimeWidget.js.map +1 -1
- package/dist/widgets/realtimePoll.js +4 -1
- package/dist/widgets/realtimePoll.js.map +1 -1
- package/dist/widgets/registerWidgets.js +14 -4
- package/dist/widgets/registerWidgets.js.map +1 -1
- package/package.json +9 -4
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
//#region src/fields/config/toSelectOption.ts
|
|
2
|
+
/**
|
|
3
|
+
* Static select options in this plugin carry per-locale label maps
|
|
4
|
+
* (Record<string, string>) from registerWidgets. Resolve an `Option` to a
|
|
5
|
+
* plain `{ value, label }` pair for the current locale, falling back to
|
|
6
|
+
* English, then to the raw value.
|
|
7
|
+
*/
|
|
8
|
+
const toSelectOption = (option, locale) => {
|
|
9
|
+
if (typeof option === "string") return {
|
|
10
|
+
label: option,
|
|
11
|
+
value: option
|
|
12
|
+
};
|
|
13
|
+
const { label, value } = option;
|
|
14
|
+
if (typeof label === "string") return {
|
|
15
|
+
label,
|
|
16
|
+
value
|
|
17
|
+
};
|
|
18
|
+
const map = label;
|
|
19
|
+
return {
|
|
20
|
+
label: map?.[locale] ?? map?.en ?? value,
|
|
21
|
+
value
|
|
22
|
+
};
|
|
23
|
+
};
|
|
24
|
+
//#endregion
|
|
25
|
+
export { toSelectOption };
|
|
26
|
+
|
|
27
|
+
//# sourceMappingURL=toSelectOption.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"toSelectOption.js","names":[],"sources":["../../../src/fields/config/toSelectOption.ts"],"sourcesContent":["import type { Option } from 'payload'\n\n/**\n * Static select options in this plugin carry per-locale label maps\n * (Record<string, string>) from registerWidgets. Resolve an `Option` to a\n * plain `{ value, label }` pair for the current locale, falling back to\n * English, then to the raw value.\n */\nexport const toSelectOption = (\n\toption: Option,\n\tlocale: string\n): { label: string; value: string } => {\n\tif (typeof option === 'string') return { label: option, value: option }\n\tconst { label, value } = option\n\tif (typeof label === 'string') return { label, value }\n\tconst map = label as Record<string, string> | undefined\n\treturn { label: map?.[locale] ?? map?.en ?? value, value }\n}\n"],"mappings":";;;;;;;AAQA,MAAa,kBACZ,QACA,WACsC;CACtC,IAAI,OAAO,WAAW,UAAU,OAAO;EAAE,OAAO;EAAQ,OAAO;CAAO;CACtE,MAAM,EAAE,OAAO,UAAU;CACzB,IAAI,OAAO,UAAU,UAAU,OAAO;EAAE;EAAO;CAAM;CACrD,MAAM,MAAM;CACZ,OAAO;EAAE,OAAO,MAAM,WAAW,KAAK,MAAM;EAAO;CAAM;AAC1D"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { WireSource } from "./fetchSources.js";
|
|
2
|
+
|
|
3
|
+
//#region src/fields/config/useAnalyticsSources.d.ts
|
|
4
|
+
interface AnalyticsSources {
|
|
5
|
+
sources: WireSource[] | null;
|
|
6
|
+
defaultId: string | null;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* Fetches the caller-scope source list for widget config pickers, sharing the
|
|
10
|
+
* per-user cache `fetchSources` already keeps. `sources` and `defaultId` stay
|
|
11
|
+
* null until the fetch resolves, on a failed fetch, or when there is no
|
|
12
|
+
* authenticated user yet; consumers fall back to their static option list in
|
|
13
|
+
* that window. Sources fetched for a previous user are never returned while
|
|
14
|
+
* a new user's fetch is pending.
|
|
15
|
+
*/
|
|
16
|
+
declare const useAnalyticsSources: () => AnalyticsSources;
|
|
17
|
+
//#endregion
|
|
18
|
+
export { useAnalyticsSources };
|
|
19
|
+
//# sourceMappingURL=useAnalyticsSources.d.ts.map
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
import { fetchSources } from "./fetchSources.js";
|
|
3
|
+
import { EMPTY_SOURCES, resolveSourcesState } from "./sourcesState.js";
|
|
4
|
+
import { useEffect, useState } from "react";
|
|
5
|
+
import { useAuth, useConfig } from "@payloadcms/ui";
|
|
6
|
+
//#region src/fields/config/useAnalyticsSources.ts
|
|
7
|
+
/**
|
|
8
|
+
* Fetches the caller-scope source list for widget config pickers, sharing the
|
|
9
|
+
* per-user cache `fetchSources` already keeps. `sources` and `defaultId` stay
|
|
10
|
+
* null until the fetch resolves, on a failed fetch, or when there is no
|
|
11
|
+
* authenticated user yet; consumers fall back to their static option list in
|
|
12
|
+
* that window. Sources fetched for a previous user are never returned while
|
|
13
|
+
* a new user's fetch is pending.
|
|
14
|
+
*/
|
|
15
|
+
const useAnalyticsSources = () => {
|
|
16
|
+
const { user } = useAuth();
|
|
17
|
+
const { config: { routes: { api }, serverURL } } = useConfig();
|
|
18
|
+
const userKey = String(user?.id ?? "");
|
|
19
|
+
const [state, setState] = useState({
|
|
20
|
+
key: "",
|
|
21
|
+
data: EMPTY_SOURCES
|
|
22
|
+
});
|
|
23
|
+
useEffect(() => {
|
|
24
|
+
if (!userKey) {
|
|
25
|
+
setState({
|
|
26
|
+
key: "",
|
|
27
|
+
data: EMPTY_SOURCES
|
|
28
|
+
});
|
|
29
|
+
return;
|
|
30
|
+
}
|
|
31
|
+
let cancelled = false;
|
|
32
|
+
fetchSources(serverURL ?? "", api, userKey).then(({ defaultId, sources }) => {
|
|
33
|
+
if (!cancelled) setState({
|
|
34
|
+
key: userKey,
|
|
35
|
+
data: {
|
|
36
|
+
sources,
|
|
37
|
+
defaultId
|
|
38
|
+
}
|
|
39
|
+
});
|
|
40
|
+
}).catch(() => {
|
|
41
|
+
if (!cancelled) setState({
|
|
42
|
+
key: userKey,
|
|
43
|
+
data: EMPTY_SOURCES
|
|
44
|
+
});
|
|
45
|
+
});
|
|
46
|
+
return () => {
|
|
47
|
+
cancelled = true;
|
|
48
|
+
};
|
|
49
|
+
}, [
|
|
50
|
+
api,
|
|
51
|
+
serverURL,
|
|
52
|
+
userKey
|
|
53
|
+
]);
|
|
54
|
+
return resolveSourcesState(state, userKey);
|
|
55
|
+
};
|
|
56
|
+
//#endregion
|
|
57
|
+
export { useAnalyticsSources };
|
|
58
|
+
|
|
59
|
+
//# sourceMappingURL=useAnalyticsSources.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useAnalyticsSources.js","names":[],"sources":["../../../src/fields/config/useAnalyticsSources.ts"],"sourcesContent":["'use client'\n\nimport { useAuth, useConfig } from '@payloadcms/ui'\nimport { useEffect, useState } from 'react'\nimport { fetchSources, type WireSource } from './fetchSources'\nimport { EMPTY_SOURCES, type KeyedSources, resolveSourcesState } from './sourcesState'\n\nexport interface AnalyticsSources {\n\tsources: WireSource[] | null\n\tdefaultId: string | null\n}\n\n/**\n * Fetches the caller-scope source list for widget config pickers, sharing the\n * per-user cache `fetchSources` already keeps. `sources` and `defaultId` stay\n * null until the fetch resolves, on a failed fetch, or when there is no\n * authenticated user yet; consumers fall back to their static option list in\n * that window. Sources fetched for a previous user are never returned while\n * a new user's fetch is pending.\n */\nexport const useAnalyticsSources = (): AnalyticsSources => {\n\tconst { user } = useAuth()\n\tconst {\n\t\tconfig: {\n\t\t\troutes: { api },\n\t\t\tserverURL,\n\t\t},\n\t} = useConfig()\n\tconst userKey = String(user?.id ?? '')\n\tconst [state, setState] = useState<KeyedSources>({ key: '', data: EMPTY_SOURCES })\n\n\tuseEffect(() => {\n\t\tif (!userKey) {\n\t\t\tsetState({ key: '', data: EMPTY_SOURCES })\n\t\t\treturn\n\t\t}\n\t\tlet cancelled = false\n\t\tfetchSources(serverURL ?? '', api, userKey)\n\t\t\t.then(({ defaultId, sources }) => {\n\t\t\t\tif (!cancelled) setState({ key: userKey, data: { sources, defaultId } })\n\t\t\t})\n\t\t\t.catch(() => {\n\t\t\t\tif (!cancelled) setState({ key: userKey, data: EMPTY_SOURCES })\n\t\t\t})\n\t\treturn () => {\n\t\t\tcancelled = true\n\t\t}\n\t}, [api, serverURL, userKey])\n\n\treturn resolveSourcesState(state, userKey)\n}\n"],"mappings":";;;;;;;;;;;;;;AAoBA,MAAa,4BAA8C;CAC1D,MAAM,EAAE,SAAS,QAAQ;CACzB,MAAM,EACL,QAAQ,EACP,QAAQ,EAAE,OACV,gBAEE,UAAU;CACd,MAAM,UAAU,OAAO,MAAM,MAAM,EAAE;CACrC,MAAM,CAAC,OAAO,YAAY,SAAuB;EAAE,KAAK;EAAI,MAAM;CAAc,CAAC;CAEjF,gBAAgB;EACf,IAAI,CAAC,SAAS;GACb,SAAS;IAAE,KAAK;IAAI,MAAM;GAAc,CAAC;GACzC;EACD;EACA,IAAI,YAAY;EAChB,aAAa,aAAa,IAAI,KAAK,OAAO,EACxC,MAAM,EAAE,WAAW,cAAc;GACjC,IAAI,CAAC,WAAW,SAAS;IAAE,KAAK;IAAS,MAAM;KAAE;KAAS;IAAU;GAAE,CAAC;EACxE,CAAC,EACA,YAAY;GACZ,IAAI,CAAC,WAAW,SAAS;IAAE,KAAK;IAAS,MAAM;GAAc,CAAC;EAC/D,CAAC;EACF,aAAa;GACZ,YAAY;EACb;CACD,GAAG;EAAC;EAAK;EAAW;CAAO,CAAC;CAE5B,OAAO,oBAAoB,OAAO,OAAO;AAC1C"}
|
package/dist/index.js
CHANGED
|
@@ -4,11 +4,13 @@ import { createRegistry, staticRegistryResolver } from "./core/registry.js";
|
|
|
4
4
|
import { isValidTimeZone } from "./timeframe/tz.js";
|
|
5
5
|
import { setRuntime } from "./plugin/runtime.js";
|
|
6
6
|
import { PLATFORM_SCOPE } from "./core/contract.js";
|
|
7
|
-
import { DOCUMENT_PATH } from "./plugin/paths.js";
|
|
7
|
+
import { DOCUMENT_PATH, REALTIME_PATH, SOURCES_PATH } from "./plugin/paths.js";
|
|
8
8
|
import { makeDocumentHandler } from "./plugin/documentEndpoint.js";
|
|
9
|
+
import { isModuleNotFoundError } from "./plugin/peerImportError.js";
|
|
9
10
|
import { kvCacheStore } from "./surfacing/cacheStore.js";
|
|
10
|
-
import {
|
|
11
|
+
import { makeRealtimeHandler } from "./plugin/realtimeEndpoint.js";
|
|
11
12
|
import { registerTranslations } from "./plugin/registerTranslations.js";
|
|
13
|
+
import { makeSourcesHandler } from "./plugin/sourcesEndpoint.js";
|
|
12
14
|
import { warmTask } from "./plugin/warmTask.js";
|
|
13
15
|
import { collectionProvidersSource, combineRegistries, createScopedRegistryResolver } from "./providers/resolver.js";
|
|
14
16
|
import { createEngine } from "./surfacing/engine.js";
|
|
@@ -21,7 +23,7 @@ import { definePlugin } from "payload";
|
|
|
21
23
|
//#region src/index.ts
|
|
22
24
|
const analytics = definePlugin({
|
|
23
25
|
slug: "@10x-media/analytics",
|
|
24
|
-
plugin: ({ config, plugins: _plugins, ...options }) => {
|
|
26
|
+
plugin: async ({ config, plugins: _plugins, ...options }) => {
|
|
25
27
|
if (options.disabled === true) return config;
|
|
26
28
|
const resolved = resolveOptions(options);
|
|
27
29
|
const defaultLayout = config.admin?.dashboard?.defaultLayout;
|
|
@@ -47,13 +49,32 @@ const analytics = definePlugin({
|
|
|
47
49
|
resolveRegistry = scoped.resolver;
|
|
48
50
|
invalidateProviders = scoped.invalidate;
|
|
49
51
|
}
|
|
50
|
-
if (resolved.providers.collection.enabled) config.collections = [...config.collections ?? [], buildProvidersCollection({
|
|
51
|
-
slug: resolved.providers.collection.slug,
|
|
52
|
-
access: resolved.providers.collection.access,
|
|
53
|
-
overrides: resolved.providers.collection.overrides,
|
|
54
|
-
onChange: () => invalidateProviders()
|
|
55
|
-
})];
|
|
56
52
|
const resolveScope = async (req) => resolved.scopeResolver({ req });
|
|
53
|
+
if (resolved.providers.collection.enabled) {
|
|
54
|
+
const { encryptedField, withEncryptedQueryRewrite } = await import("@10x-media/fields/encrypted").catch((err) => {
|
|
55
|
+
if (isModuleNotFoundError(err)) throw new Error("analytics: providers.collection requires @10x-media/fields (peer). Install it: pnpm add @10x-media/fields");
|
|
56
|
+
throw err;
|
|
57
|
+
});
|
|
58
|
+
const encryption = resolved.providers.collection.encryption;
|
|
59
|
+
const buildSecret = (source) => encryptedField(source, {
|
|
60
|
+
protection: "writeOnly",
|
|
61
|
+
aadScope: "10x-analytics:providers",
|
|
62
|
+
...source.type === "text" ? { hint: { suffix: 4 } } : {},
|
|
63
|
+
...encryption?.keys ? { keys: encryption.keys } : {}
|
|
64
|
+
});
|
|
65
|
+
const providersCollection = buildProvidersCollection({
|
|
66
|
+
slug: resolved.providers.collection.slug,
|
|
67
|
+
access: resolved.providers.collection.access,
|
|
68
|
+
overrides: resolved.providers.collection.overrides,
|
|
69
|
+
onChange: () => invalidateProviders(),
|
|
70
|
+
scoped: resolved.scoped,
|
|
71
|
+
scopeField: resolved.providers.collection.scopeField,
|
|
72
|
+
resolveScope,
|
|
73
|
+
platformRead: resolved.access.platformRead,
|
|
74
|
+
buildSecret
|
|
75
|
+
});
|
|
76
|
+
config.collections = [...config.collections ?? [], withEncryptedQueryRewrite(providersCollection)];
|
|
77
|
+
}
|
|
57
78
|
const resolveTimezone = async (req, scope) => {
|
|
58
79
|
const opt = resolved.reportingTimezone;
|
|
59
80
|
if (opt === void 0) return "UTC";
|
|
@@ -83,13 +104,22 @@ const analytics = definePlugin({
|
|
|
83
104
|
path: DOCUMENT_PATH,
|
|
84
105
|
handler: makeDocumentHandler()
|
|
85
106
|
}];
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
107
|
+
config.endpoints = [...config.endpoints ?? [], {
|
|
108
|
+
method: "get",
|
|
109
|
+
path: SOURCES_PATH,
|
|
110
|
+
handler: makeSourcesHandler()
|
|
111
|
+
}];
|
|
112
|
+
if (resolved.widgets.enabled) {
|
|
113
|
+
const multiProvider = registry.isMultiProvider() || resolved.providers.collection.enabled || Boolean(resolved.providers.resolve);
|
|
114
|
+
registerWidgets(config, {
|
|
115
|
+
adapters: resolved.adapters,
|
|
116
|
+
multiProvider,
|
|
117
|
+
disabled: resolved.widgets.disabled,
|
|
118
|
+
register: resolved.widgets.register,
|
|
119
|
+
localizeText: resolved.widgets.localizeText,
|
|
120
|
+
defaultId: resolved.defaultAdapter
|
|
121
|
+
});
|
|
122
|
+
}
|
|
93
123
|
if (resolved.cache.warm.enabled) config.jobs = {
|
|
94
124
|
...config.jobs,
|
|
95
125
|
tasks: [...config.jobs?.tasks ?? [], warmTask(resolved.cache.warm.cron, defaultLayout)]
|
|
@@ -108,6 +138,10 @@ const analytics = definePlugin({
|
|
|
108
138
|
}
|
|
109
139
|
const prevOnInit = config.onInit;
|
|
110
140
|
config.onInit = async (payload) => {
|
|
141
|
+
if (resolved.providers.collection.enabled) {
|
|
142
|
+
const { validateEncryptedBoot } = await import("@10x-media/fields/encrypted");
|
|
143
|
+
await validateEncryptedBoot(payload, resolved.providers.collection.encryption?.keys);
|
|
144
|
+
}
|
|
111
145
|
const engine = createEngine({
|
|
112
146
|
store: kvCacheStore(payload.kv),
|
|
113
147
|
queue: { concurrency: 4 },
|
|
@@ -119,6 +153,7 @@ const analytics = definePlugin({
|
|
|
119
153
|
resolveScope,
|
|
120
154
|
resolveTimezone,
|
|
121
155
|
platformAdapterId: resolved.platformAdapter,
|
|
156
|
+
configAdapterIds: new Set(resolved.adapters.map((a) => a.id)),
|
|
122
157
|
platformRead: resolved.access.platformRead,
|
|
123
158
|
bindings: resolved.bindings,
|
|
124
159
|
engine,
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { type Config, definePlugin, type PayloadRequest } from 'payload'\n\nimport { type AnalyticsPluginOptions, resolveOptions } from './core/options'\nimport { createRegistry, staticRegistryResolver } from './core/registry'\nimport { DOCUMENT_PATH, makeDocumentHandler } from './plugin/documentEndpoint'\nimport { makeRealtimeHandler, REALTIME_PATH } from './plugin/realtimeEndpoint'\nimport { registerTranslations } from './plugin/registerTranslations'\nimport { setRuntime } from './plugin/runtime'\nimport { warmTask } from './plugin/warmTask'\nimport { buildProvidersCollection } from './providers/collection'\nimport {\n\tcollectionProvidersSource,\n\tcombineRegistries,\n\tcreateScopedRegistryResolver,\n} from './providers/resolver'\nimport { kvCacheStore } from './surfacing/cacheStore'\nimport { createEngine } from './surfacing/engine'\nimport { syncCollection } from './sync/collection'\nimport { syncTask } from './sync/syncTask'\nimport { DEFAULT_TIMEZONE, isValidTimeZone } from './timeframe/tz'\nimport { registerWidgets } from './widgets/registerWidgets'\n\ndeclare module 'payload' {\n\tinterface RegisteredPlugins {\n\t\t'@10x-media/analytics': AnalyticsPluginOptions\n\t}\n}\n\nexport const analytics = definePlugin<AnalyticsPluginOptions>({\n\tslug: '@10x-media/analytics',\n\tplugin: ({ config, plugins: _plugins, ...options }): Config => {\n\t\tif (options.disabled === true) {\n\t\t\treturn config\n\t\t}\n\t\tconst resolved = resolveOptions(options)\n\t\tconst defaultLayout = config.admin?.dashboard?.defaultLayout\n\t\tregisterTranslations(config, options.translations)\n\t\tconst registry = createRegistry(resolved.adapters, resolved.defaultAdapter)\n\t\tconst registryBase = { adapters: resolved.adapters, defaultId: resolved.defaultAdapter }\n\t\tlet resolveRegistry = staticRegistryResolver(registry)\n\t\tlet invalidateProviders = () => {}\n\t\tconst providersResolve = resolved.providers.resolve\n\t\tif (providersResolve) {\n\t\t\tresolveRegistry = async (args) =>\n\t\t\t\tcombineRegistries(\n\t\t\t\t\tregistryBase,\n\t\t\t\t\tawait providersResolve({ payload: args.payload, req: args.req, scope: args.scope })\n\t\t\t\t)\n\t\t} else if (resolved.providers.collection.enabled) {\n\t\t\tconst scoped = createScopedRegistryResolver({\n\t\t\t\tbase: registryBase,\n\t\t\t\tsource: collectionProvidersSource(\n\t\t\t\t\tresolved.providers.collection.slug,\n\t\t\t\t\tresolved.providers.collection.scopeField\n\t\t\t\t),\n\t\t\t})\n\t\t\tresolveRegistry = scoped.resolver\n\t\t\tinvalidateProviders = scoped.invalidate\n\t\t}\n\t\tif (resolved.providers.collection.enabled) {\n\t\t\tconfig.collections = [\n\t\t\t\t...(config.collections ?? []),\n\t\t\t\tbuildProvidersCollection({\n\t\t\t\t\tslug: resolved.providers.collection.slug,\n\t\t\t\t\taccess: resolved.providers.collection.access,\n\t\t\t\t\toverrides: resolved.providers.collection.overrides,\n\t\t\t\t\tonChange: () => invalidateProviders(),\n\t\t\t\t}),\n\t\t\t]\n\t\t}\n\t\tconst resolveScope = async (req: PayloadRequest) => resolved.scopeResolver({ req })\n\t\tconst resolveTimezone = async (req: PayloadRequest, scope?: string | null): Promise<string> => {\n\t\t\tconst opt = resolved.reportingTimezone\n\t\t\tif (opt === undefined) {\n\t\t\t\treturn DEFAULT_TIMEZONE\n\t\t\t}\n\t\t\ttry {\n\t\t\t\tconst tz =\n\t\t\t\t\ttypeof opt === 'string'\n\t\t\t\t\t\t? opt\n\t\t\t\t\t\t: await opt({ req, scope: scope !== undefined ? scope : await resolveScope(req) })\n\t\t\t\treturn tz && isValidTimeZone(tz) ? tz : DEFAULT_TIMEZONE\n\t\t\t} catch (err) {\n\t\t\t\treq.payload?.logger?.warn?.(\n\t\t\t\t\t`analytics: reportingTimezone resolution failed, falling back to UTC: ${String(err)}`\n\t\t\t\t)\n\t\t\t\treturn DEFAULT_TIMEZONE\n\t\t\t}\n\t\t}\n\t\tfor (const adapter of resolved.adapters) {\n\t\t\tadapter.register?.(config, { scoped: resolved.scoped, resolveScope, resolveTimezone })\n\t\t}\n\t\tif (\n\t\t\tresolved.adapters.some((a) => a.capabilities.realtime && typeof a.realtime === 'function')\n\t\t) {\n\t\t\tconfig.endpoints = [\n\t\t\t\t...(config.endpoints ?? []),\n\t\t\t\t{ method: 'get', path: REALTIME_PATH, handler: makeRealtimeHandler() },\n\t\t\t]\n\t\t}\n\t\tif (Object.keys(resolved.bindings).length > 0) {\n\t\t\tconfig.endpoints = [\n\t\t\t\t...(config.endpoints ?? []),\n\t\t\t\t{ method: 'get', path: DOCUMENT_PATH, handler: makeDocumentHandler() },\n\t\t\t]\n\t\t}\n\t\tif (resolved.widgets.enabled) {\n\t\t\tregisterWidgets(config, {\n\t\t\t\tadapters: resolved.adapters,\n\t\t\t\tmultiProvider: registry.isMultiProvider(),\n\t\t\t\tdisabled: resolved.widgets.disabled,\n\t\t\t\tregister: resolved.widgets.register,\n\t\t\t\tlocalizeText: resolved.widgets.localizeText,\n\t\t\t})\n\t\t}\n\t\tif (resolved.cache.warm.enabled) {\n\t\t\tconfig.jobs = {\n\t\t\t\t...config.jobs,\n\t\t\t\ttasks: [...(config.jobs?.tasks ?? []), warmTask(resolved.cache.warm.cron, defaultLayout)],\n\t\t\t}\n\t\t}\n\t\tif (resolved.sync.enabled) {\n\t\t\tconfig.collections = [\n\t\t\t\t...(config.collections ?? []),\n\t\t\t\tsyncCollection(resolved.sync.collectionSlug, resolved.sync.hidden),\n\t\t\t]\n\t\t\tconfig.jobs = {\n\t\t\t\t...config.jobs,\n\t\t\t\ttasks: [\n\t\t\t\t\t...(config.jobs?.tasks ?? []),\n\t\t\t\t\tsyncTask({\n\t\t\t\t\t\tcron: resolved.sync.cron,\n\t\t\t\t\t\tlookbackDays: resolved.sync.lookbackDays,\n\t\t\t\t\t\tcollectionSlug: resolved.sync.collectionSlug,\n\t\t\t\t\t\tadapterIds: resolved.sync.adapters,\n\t\t\t\t\t}),\n\t\t\t\t],\n\t\t\t}\n\t\t}\n\t\tconst prevOnInit = config.onInit\n\t\t// The runtime is installed before the app's own onInit runs so consumer init code\n\t\t// (seeding, cache warming, sync passes) can already read through the plugin.\n\t\tconfig.onInit = async (payload) => {\n\t\t\tconst engine = createEngine({\n\t\t\t\tstore: kvCacheStore(payload.kv),\n\t\t\t\tqueue: { concurrency: 4 },\n\t\t\t\tttl: resolved.cache.ttl,\n\t\t\t})\n\t\t\tsetRuntime(payload, {\n\t\t\t\tregistry,\n\t\t\t\tresolveRegistry,\n\t\t\t\tresolveScope,\n\t\t\t\tresolveTimezone,\n\t\t\t\tplatformAdapterId: resolved.platformAdapter,\n\t\t\t\tplatformRead: resolved.access.platformRead,\n\t\t\t\tbindings: resolved.bindings,\n\t\t\t\tengine,\n\t\t\t\tttl: resolved.cache.ttl,\n\t\t\t\tcomparison: resolved.widgets.comparison,\n\t\t\t})\n\t\t\tawait prevOnInit?.(payload)\n\t\t}\n\t\treturn config\n\t},\n})\n\nexport type {\n\tAnalyticsBinding,\n\tBindingContext,\n\tHostnameResolver,\n\tPathResolver,\n} from './binding/types'\nexport { PLATFORM_SCOPE } from './core/contract'\nexport type {\n\tAnalyticsAccessOptions,\n\tAnalyticsPluginOptions,\n\tAnalyticsPluginOptions as PluginOptions,\n\tPlatformReadAccess,\n\tProvidersCollectionOptions,\n\tProvidersOptions,\n\tProvidersResolve,\n\tScopeResolver,\n\tTimezoneResolver,\n} from './core/options'\nexport type {\n\tAnalyticsFieldsOptions,\n\tAnalyticsMetricLabel,\n\tAnalyticsMetricLabels,\n\tAnalyticsStatOptions,\n\tAnalyticsStatRowOptions,\n\tAnalyticsTabOptions,\n} from './fields/factories'\nexport {\n\tanalyticsFields,\n\tanalyticsStat,\n\tanalyticsStatRow,\n\tanalyticsTab,\n\tanalyticsTabsField,\n} from './fields/factories'\nexport type { TimeframePreset } from './timeframe/presets'\nexport type { CustomWidgetDef } from './widgets/customWidget'\nexport { analyticsDefaultWidgets } from './widgets/defaults'\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AA4BA,MAAa,YAAY,aAAqC;CAC7D,MAAM;CACN,SAAS,EAAE,QAAQ,SAAS,UAAU,GAAG,cAAsB;EAC9D,IAAI,QAAQ,aAAa,MACxB,OAAO;EAER,MAAM,WAAW,eAAe,OAAO;EACvC,MAAM,gBAAgB,OAAO,OAAO,WAAW;EAC/C,qBAAqB,QAAQ,QAAQ,YAAY;EACjD,MAAM,WAAW,eAAe,SAAS,UAAU,SAAS,cAAc;EAC1E,MAAM,eAAe;GAAE,UAAU,SAAS;GAAU,WAAW,SAAS;EAAe;EACvF,IAAI,kBAAkB,uBAAuB,QAAQ;EACrD,IAAI,4BAA4B,CAAC;EACjC,MAAM,mBAAmB,SAAS,UAAU;EAC5C,IAAI,kBACH,kBAAkB,OAAO,SACxB,kBACC,cACA,MAAM,iBAAiB;GAAE,SAAS,KAAK;GAAS,KAAK,KAAK;GAAK,OAAO,KAAK;EAAM,CAAC,CACnF;OACK,IAAI,SAAS,UAAU,WAAW,SAAS;GACjD,MAAM,SAAS,6BAA6B;IAC3C,MAAM;IACN,QAAQ,0BACP,SAAS,UAAU,WAAW,MAC9B,SAAS,UAAU,WAAW,UAC/B;GACD,CAAC;GACD,kBAAkB,OAAO;GACzB,sBAAsB,OAAO;EAC9B;EACA,IAAI,SAAS,UAAU,WAAW,SACjC,OAAO,cAAc,CACpB,GAAI,OAAO,eAAe,CAAC,GAC3B,yBAAyB;GACxB,MAAM,SAAS,UAAU,WAAW;GACpC,QAAQ,SAAS,UAAU,WAAW;GACtC,WAAW,SAAS,UAAU,WAAW;GACzC,gBAAgB,oBAAoB;EACrC,CAAC,CACF;EAED,MAAM,eAAe,OAAO,QAAwB,SAAS,cAAc,EAAE,IAAI,CAAC;EAClF,MAAM,kBAAkB,OAAO,KAAqB,UAA2C;GAC9F,MAAM,MAAM,SAAS;GACrB,IAAI,QAAQ,KAAA,GACX,OAAA;GAED,IAAI;IACH,MAAM,KACL,OAAO,QAAQ,WACZ,MACA,MAAM,IAAI;KAAE;KAAK,OAAO,UAAU,KAAA,IAAY,QAAQ,MAAM,aAAa,GAAG;IAAE,CAAC;IACnF,OAAO,MAAM,gBAAgB,EAAE,IAAI,KAAA;GACpC,SAAS,KAAK;IACb,IAAI,SAAS,QAAQ,OACpB,wEAAwE,OAAO,GAAG,GACnF;IACA,OAAA;GACD;EACD;EACA,KAAK,MAAM,WAAW,SAAS,UAC9B,QAAQ,WAAW,QAAQ;GAAE,QAAQ,SAAS;GAAQ;GAAc;EAAgB,CAAC;EAEtF,IACC,SAAS,SAAS,MAAM,MAAM,EAAE,aAAa,YAAY,OAAO,EAAE,aAAa,UAAU,GAEzF,OAAO,YAAY,CAClB,GAAI,OAAO,aAAa,CAAC,GACzB;GAAE,QAAQ;GAAO,MAAM;GAAe,SAAS,oBAAoB;EAAE,CACtE;EAED,IAAI,OAAO,KAAK,SAAS,QAAQ,EAAE,SAAS,GAC3C,OAAO,YAAY,CAClB,GAAI,OAAO,aAAa,CAAC,GACzB;GAAE,QAAQ;GAAO,MAAM;GAAe,SAAS,oBAAoB;EAAE,CACtE;EAED,IAAI,SAAS,QAAQ,SACpB,gBAAgB,QAAQ;GACvB,UAAU,SAAS;GACnB,eAAe,SAAS,gBAAgB;GACxC,UAAU,SAAS,QAAQ;GAC3B,UAAU,SAAS,QAAQ;GAC3B,cAAc,SAAS,QAAQ;EAChC,CAAC;EAEF,IAAI,SAAS,MAAM,KAAK,SACvB,OAAO,OAAO;GACb,GAAG,OAAO;GACV,OAAO,CAAC,GAAI,OAAO,MAAM,SAAS,CAAC,GAAI,SAAS,SAAS,MAAM,KAAK,MAAM,aAAa,CAAC;EACzF;EAED,IAAI,SAAS,KAAK,SAAS;GAC1B,OAAO,cAAc,CACpB,GAAI,OAAO,eAAe,CAAC,GAC3B,eAAe,SAAS,KAAK,gBAAgB,SAAS,KAAK,MAAM,CAClE;GACA,OAAO,OAAO;IACb,GAAG,OAAO;IACV,OAAO,CACN,GAAI,OAAO,MAAM,SAAS,CAAC,GAC3B,SAAS;KACR,MAAM,SAAS,KAAK;KACpB,cAAc,SAAS,KAAK;KAC5B,gBAAgB,SAAS,KAAK;KAC9B,YAAY,SAAS,KAAK;IAC3B,CAAC,CACF;GACD;EACD;EACA,MAAM,aAAa,OAAO;EAG1B,OAAO,SAAS,OAAO,YAAY;GAClC,MAAM,SAAS,aAAa;IAC3B,OAAO,aAAa,QAAQ,EAAE;IAC9B,OAAO,EAAE,aAAa,EAAE;IACxB,KAAK,SAAS,MAAM;GACrB,CAAC;GACD,WAAW,SAAS;IACnB;IACA;IACA;IACA;IACA,mBAAmB,SAAS;IAC5B,cAAc,SAAS,OAAO;IAC9B,UAAU,SAAS;IACnB;IACA,KAAK,SAAS,MAAM;IACpB,YAAY,SAAS,QAAQ;GAC9B,CAAC;GACD,MAAM,aAAa,OAAO;EAC3B;EACA,OAAO;CACR;AACD,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { type Config, definePlugin, type PayloadRequest } from 'payload'\n\nimport { type AnalyticsPluginOptions, resolveOptions } from './core/options'\nimport { createRegistry, staticRegistryResolver } from './core/registry'\nimport { DOCUMENT_PATH, makeDocumentHandler } from './plugin/documentEndpoint'\nimport { isModuleNotFoundError } from './plugin/peerImportError'\nimport { makeRealtimeHandler, REALTIME_PATH } from './plugin/realtimeEndpoint'\nimport { registerTranslations } from './plugin/registerTranslations'\nimport { setRuntime } from './plugin/runtime'\nimport { makeSourcesHandler, SOURCES_PATH } from './plugin/sourcesEndpoint'\nimport { warmTask } from './plugin/warmTask'\nimport type { BuildSecretField } from './providers/collection'\nimport { buildProvidersCollection } from './providers/collection'\nimport {\n\tcollectionProvidersSource,\n\tcombineRegistries,\n\tcreateScopedRegistryResolver,\n} from './providers/resolver'\nimport { kvCacheStore } from './surfacing/cacheStore'\nimport { createEngine } from './surfacing/engine'\nimport { syncCollection } from './sync/collection'\nimport { syncTask } from './sync/syncTask'\nimport { DEFAULT_TIMEZONE, isValidTimeZone } from './timeframe/tz'\nimport { registerWidgets } from './widgets/registerWidgets'\n\ndeclare module 'payload' {\n\tinterface RegisteredPlugins {\n\t\t'@10x-media/analytics': AnalyticsPluginOptions\n\t}\n}\n\nexport const analytics = definePlugin<AnalyticsPluginOptions>({\n\tslug: '@10x-media/analytics',\n\tplugin: async ({ config, plugins: _plugins, ...options }): Promise<Config> => {\n\t\tif (options.disabled === true) {\n\t\t\treturn config\n\t\t}\n\t\tconst resolved = resolveOptions(options)\n\t\tconst defaultLayout = config.admin?.dashboard?.defaultLayout\n\t\tregisterTranslations(config, options.translations)\n\t\tconst registry = createRegistry(resolved.adapters, resolved.defaultAdapter)\n\t\tconst registryBase = { adapters: resolved.adapters, defaultId: resolved.defaultAdapter }\n\t\tlet resolveRegistry = staticRegistryResolver(registry)\n\t\tlet invalidateProviders = () => {}\n\t\tconst providersResolve = resolved.providers.resolve\n\t\tif (providersResolve) {\n\t\t\tresolveRegistry = async (args) =>\n\t\t\t\tcombineRegistries(\n\t\t\t\t\tregistryBase,\n\t\t\t\t\tawait providersResolve({ payload: args.payload, req: args.req, scope: args.scope })\n\t\t\t\t)\n\t\t} else if (resolved.providers.collection.enabled) {\n\t\t\tconst scoped = createScopedRegistryResolver({\n\t\t\t\tbase: registryBase,\n\t\t\t\tsource: collectionProvidersSource(\n\t\t\t\t\tresolved.providers.collection.slug,\n\t\t\t\t\tresolved.providers.collection.scopeField\n\t\t\t\t),\n\t\t\t})\n\t\t\tresolveRegistry = scoped.resolver\n\t\t\tinvalidateProviders = scoped.invalidate\n\t\t}\n\t\tconst resolveScope = async (req: PayloadRequest) => resolved.scopeResolver({ req })\n\t\tif (resolved.providers.collection.enabled) {\n\t\t\tconst { encryptedField, withEncryptedQueryRewrite } = await import(\n\t\t\t\t'@10x-media/fields/encrypted'\n\t\t\t).catch((err: unknown) => {\n\t\t\t\tif (isModuleNotFoundError(err)) {\n\t\t\t\t\tthrow new Error(\n\t\t\t\t\t\t'analytics: providers.collection requires @10x-media/fields (peer). Install it: pnpm add @10x-media/fields'\n\t\t\t\t\t)\n\t\t\t\t}\n\t\t\t\tthrow err\n\t\t\t})\n\t\t\tconst encryption = resolved.providers.collection.encryption\n\t\t\tconst buildSecret: BuildSecretField = (source) =>\n\t\t\t\tencryptedField(source, {\n\t\t\t\t\tprotection: 'writeOnly',\n\t\t\t\t\taadScope: '10x-analytics:providers',\n\t\t\t\t\t...(source.type === 'text' ? { hint: { suffix: 4 } } : {}),\n\t\t\t\t\t...(encryption?.keys ? { keys: encryption.keys } : {}),\n\t\t\t\t})\n\t\t\tconst providersCollection = buildProvidersCollection({\n\t\t\t\tslug: resolved.providers.collection.slug,\n\t\t\t\taccess: resolved.providers.collection.access,\n\t\t\t\toverrides: resolved.providers.collection.overrides,\n\t\t\t\tonChange: () => invalidateProviders(),\n\t\t\t\tscoped: resolved.scoped,\n\t\t\t\tscopeField: resolved.providers.collection.scopeField,\n\t\t\t\tresolveScope,\n\t\t\t\tplatformRead: resolved.access.platformRead,\n\t\t\t\tbuildSecret,\n\t\t\t})\n\t\t\t// Always wrap, even though a consumer's own @10x-media/fields plugin (if\n\t\t\t// registered) may wrap this collection again later: double application is\n\t\t\t// inert here (writeOnly forbids queryable, so there are no blind-index\n\t\t\t// markers to rewrite and the response strip is an idempotent delete),\n\t\t\t// while skipping would leak ciphertext whenever fields() runs before this\n\t\t\t// collection exists (e.g. an earlier plugin `order`).\n\t\t\tconfig.collections = [\n\t\t\t\t...(config.collections ?? []),\n\t\t\t\twithEncryptedQueryRewrite(providersCollection),\n\t\t\t]\n\t\t}\n\t\tconst resolveTimezone = async (req: PayloadRequest, scope?: string | null): Promise<string> => {\n\t\t\tconst opt = resolved.reportingTimezone\n\t\t\tif (opt === undefined) {\n\t\t\t\treturn DEFAULT_TIMEZONE\n\t\t\t}\n\t\t\ttry {\n\t\t\t\tconst tz =\n\t\t\t\t\ttypeof opt === 'string'\n\t\t\t\t\t\t? opt\n\t\t\t\t\t\t: await opt({ req, scope: scope !== undefined ? scope : await resolveScope(req) })\n\t\t\t\treturn tz && isValidTimeZone(tz) ? tz : DEFAULT_TIMEZONE\n\t\t\t} catch (err) {\n\t\t\t\treq.payload?.logger?.warn?.(\n\t\t\t\t\t`analytics: reportingTimezone resolution failed, falling back to UTC: ${String(err)}`\n\t\t\t\t)\n\t\t\t\treturn DEFAULT_TIMEZONE\n\t\t\t}\n\t\t}\n\t\tfor (const adapter of resolved.adapters) {\n\t\t\tadapter.register?.(config, { scoped: resolved.scoped, resolveScope, resolveTimezone })\n\t\t}\n\t\tif (\n\t\t\tresolved.adapters.some((a) => a.capabilities.realtime && typeof a.realtime === 'function')\n\t\t) {\n\t\t\tconfig.endpoints = [\n\t\t\t\t...(config.endpoints ?? []),\n\t\t\t\t{ method: 'get', path: REALTIME_PATH, handler: makeRealtimeHandler() },\n\t\t\t]\n\t\t}\n\t\tif (Object.keys(resolved.bindings).length > 0) {\n\t\t\tconfig.endpoints = [\n\t\t\t\t...(config.endpoints ?? []),\n\t\t\t\t{ method: 'get', path: DOCUMENT_PATH, handler: makeDocumentHandler() },\n\t\t\t]\n\t\t}\n\t\tconfig.endpoints = [\n\t\t\t...(config.endpoints ?? []),\n\t\t\t{ method: 'get', path: SOURCES_PATH, handler: makeSourcesHandler() },\n\t\t]\n\t\tif (resolved.widgets.enabled) {\n\t\t\tconst multiProvider =\n\t\t\t\tregistry.isMultiProvider() ||\n\t\t\t\tresolved.providers.collection.enabled ||\n\t\t\t\tBoolean(resolved.providers.resolve)\n\t\t\tregisterWidgets(config, {\n\t\t\t\tadapters: resolved.adapters,\n\t\t\t\tmultiProvider,\n\t\t\t\tdisabled: resolved.widgets.disabled,\n\t\t\t\tregister: resolved.widgets.register,\n\t\t\t\tlocalizeText: resolved.widgets.localizeText,\n\t\t\t\tdefaultId: resolved.defaultAdapter,\n\t\t\t})\n\t\t}\n\t\tif (resolved.cache.warm.enabled) {\n\t\t\tconfig.jobs = {\n\t\t\t\t...config.jobs,\n\t\t\t\ttasks: [...(config.jobs?.tasks ?? []), warmTask(resolved.cache.warm.cron, defaultLayout)],\n\t\t\t}\n\t\t}\n\t\tif (resolved.sync.enabled) {\n\t\t\tconfig.collections = [\n\t\t\t\t...(config.collections ?? []),\n\t\t\t\tsyncCollection(resolved.sync.collectionSlug, resolved.sync.hidden),\n\t\t\t]\n\t\t\tconfig.jobs = {\n\t\t\t\t...config.jobs,\n\t\t\t\ttasks: [\n\t\t\t\t\t...(config.jobs?.tasks ?? []),\n\t\t\t\t\tsyncTask({\n\t\t\t\t\t\tcron: resolved.sync.cron,\n\t\t\t\t\t\tlookbackDays: resolved.sync.lookbackDays,\n\t\t\t\t\t\tcollectionSlug: resolved.sync.collectionSlug,\n\t\t\t\t\t\tadapterIds: resolved.sync.adapters,\n\t\t\t\t\t}),\n\t\t\t\t],\n\t\t\t}\n\t\t}\n\t\tconst prevOnInit = config.onInit\n\t\t// The runtime is installed before the app's own onInit runs so consumer init code\n\t\t// (seeding, cache warming, sync passes) can already read through the plugin.\n\t\tconfig.onInit = async (payload) => {\n\t\t\tif (resolved.providers.collection.enabled) {\n\t\t\t\tconst { validateEncryptedBoot } = await import('@10x-media/fields/encrypted')\n\t\t\t\tawait validateEncryptedBoot(payload, resolved.providers.collection.encryption?.keys)\n\t\t\t}\n\t\t\tconst engine = createEngine({\n\t\t\t\tstore: kvCacheStore(payload.kv),\n\t\t\t\tqueue: { concurrency: 4 },\n\t\t\t\tttl: resolved.cache.ttl,\n\t\t\t})\n\t\t\tsetRuntime(payload, {\n\t\t\t\tregistry,\n\t\t\t\tresolveRegistry,\n\t\t\t\tresolveScope,\n\t\t\t\tresolveTimezone,\n\t\t\t\tplatformAdapterId: resolved.platformAdapter,\n\t\t\t\tconfigAdapterIds: new Set(resolved.adapters.map((a) => a.id)),\n\t\t\t\tplatformRead: resolved.access.platformRead,\n\t\t\t\tbindings: resolved.bindings,\n\t\t\t\tengine,\n\t\t\t\tttl: resolved.cache.ttl,\n\t\t\t\tcomparison: resolved.widgets.comparison,\n\t\t\t})\n\t\t\tawait prevOnInit?.(payload)\n\t\t}\n\t\treturn config\n\t},\n})\n\nexport type {\n\tAnalyticsBinding,\n\tBindingContext,\n\tHostnameResolver,\n\tPathResolver,\n} from './binding/types'\nexport { PLATFORM_SCOPE } from './core/contract'\nexport type {\n\tAnalyticsAccessOptions,\n\tAnalyticsPluginOptions,\n\tAnalyticsPluginOptions as PluginOptions,\n\tPlatformReadAccess,\n\tProvidersCollectionOptions,\n\tProvidersOptions,\n\tProvidersResolve,\n\tScopeResolver,\n\tTimezoneResolver,\n} from './core/options'\nexport type {\n\tAnalyticsFieldsOptions,\n\tAnalyticsMetricLabel,\n\tAnalyticsMetricLabels,\n\tAnalyticsStatOptions,\n\tAnalyticsStatRowOptions,\n\tAnalyticsTabOptions,\n} from './fields/factories'\nexport {\n\tanalyticsFields,\n\tanalyticsStat,\n\tanalyticsStatRow,\n\tanalyticsTab,\n\tanalyticsTabsField,\n} from './fields/factories'\nexport type { TimeframePreset } from './timeframe/presets'\nexport type { CustomWidgetDef } from './widgets/customWidget'\nexport { analyticsDefaultWidgets } from './widgets/defaults'\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AA+BA,MAAa,YAAY,aAAqC;CAC7D,MAAM;CACN,QAAQ,OAAO,EAAE,QAAQ,SAAS,UAAU,GAAG,cAA+B;EAC7E,IAAI,QAAQ,aAAa,MACxB,OAAO;EAER,MAAM,WAAW,eAAe,OAAO;EACvC,MAAM,gBAAgB,OAAO,OAAO,WAAW;EAC/C,qBAAqB,QAAQ,QAAQ,YAAY;EACjD,MAAM,WAAW,eAAe,SAAS,UAAU,SAAS,cAAc;EAC1E,MAAM,eAAe;GAAE,UAAU,SAAS;GAAU,WAAW,SAAS;EAAe;EACvF,IAAI,kBAAkB,uBAAuB,QAAQ;EACrD,IAAI,4BAA4B,CAAC;EACjC,MAAM,mBAAmB,SAAS,UAAU;EAC5C,IAAI,kBACH,kBAAkB,OAAO,SACxB,kBACC,cACA,MAAM,iBAAiB;GAAE,SAAS,KAAK;GAAS,KAAK,KAAK;GAAK,OAAO,KAAK;EAAM,CAAC,CACnF;OACK,IAAI,SAAS,UAAU,WAAW,SAAS;GACjD,MAAM,SAAS,6BAA6B;IAC3C,MAAM;IACN,QAAQ,0BACP,SAAS,UAAU,WAAW,MAC9B,SAAS,UAAU,WAAW,UAC/B;GACD,CAAC;GACD,kBAAkB,OAAO;GACzB,sBAAsB,OAAO;EAC9B;EACA,MAAM,eAAe,OAAO,QAAwB,SAAS,cAAc,EAAE,IAAI,CAAC;EAClF,IAAI,SAAS,UAAU,WAAW,SAAS;GAC1C,MAAM,EAAE,gBAAgB,8BAA8B,MAAM,OAC3D,+BACC,OAAO,QAAiB;IACzB,IAAI,sBAAsB,GAAG,GAC5B,MAAM,IAAI,MACT,2GACD;IAED,MAAM;GACP,CAAC;GACD,MAAM,aAAa,SAAS,UAAU,WAAW;GACjD,MAAM,eAAiC,WACtC,eAAe,QAAQ;IACtB,YAAY;IACZ,UAAU;IACV,GAAI,OAAO,SAAS,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,IAAI,CAAC;IACxD,GAAI,YAAY,OAAO,EAAE,MAAM,WAAW,KAAK,IAAI,CAAC;GACrD,CAAC;GACF,MAAM,sBAAsB,yBAAyB;IACpD,MAAM,SAAS,UAAU,WAAW;IACpC,QAAQ,SAAS,UAAU,WAAW;IACtC,WAAW,SAAS,UAAU,WAAW;IACzC,gBAAgB,oBAAoB;IACpC,QAAQ,SAAS;IACjB,YAAY,SAAS,UAAU,WAAW;IAC1C;IACA,cAAc,SAAS,OAAO;IAC9B;GACD,CAAC;GAOD,OAAO,cAAc,CACpB,GAAI,OAAO,eAAe,CAAC,GAC3B,0BAA0B,mBAAmB,CAC9C;EACD;EACA,MAAM,kBAAkB,OAAO,KAAqB,UAA2C;GAC9F,MAAM,MAAM,SAAS;GACrB,IAAI,QAAQ,KAAA,GACX,OAAA;GAED,IAAI;IACH,MAAM,KACL,OAAO,QAAQ,WACZ,MACA,MAAM,IAAI;KAAE;KAAK,OAAO,UAAU,KAAA,IAAY,QAAQ,MAAM,aAAa,GAAG;IAAE,CAAC;IACnF,OAAO,MAAM,gBAAgB,EAAE,IAAI,KAAA;GACpC,SAAS,KAAK;IACb,IAAI,SAAS,QAAQ,OACpB,wEAAwE,OAAO,GAAG,GACnF;IACA,OAAA;GACD;EACD;EACA,KAAK,MAAM,WAAW,SAAS,UAC9B,QAAQ,WAAW,QAAQ;GAAE,QAAQ,SAAS;GAAQ;GAAc;EAAgB,CAAC;EAEtF,IACC,SAAS,SAAS,MAAM,MAAM,EAAE,aAAa,YAAY,OAAO,EAAE,aAAa,UAAU,GAEzF,OAAO,YAAY,CAClB,GAAI,OAAO,aAAa,CAAC,GACzB;GAAE,QAAQ;GAAO,MAAM;GAAe,SAAS,oBAAoB;EAAE,CACtE;EAED,IAAI,OAAO,KAAK,SAAS,QAAQ,EAAE,SAAS,GAC3C,OAAO,YAAY,CAClB,GAAI,OAAO,aAAa,CAAC,GACzB;GAAE,QAAQ;GAAO,MAAM;GAAe,SAAS,oBAAoB;EAAE,CACtE;EAED,OAAO,YAAY,CAClB,GAAI,OAAO,aAAa,CAAC,GACzB;GAAE,QAAQ;GAAO,MAAM;GAAc,SAAS,mBAAmB;EAAE,CACpE;EACA,IAAI,SAAS,QAAQ,SAAS;GAC7B,MAAM,gBACL,SAAS,gBAAgB,KACzB,SAAS,UAAU,WAAW,WAC9B,QAAQ,SAAS,UAAU,OAAO;GACnC,gBAAgB,QAAQ;IACvB,UAAU,SAAS;IACnB;IACA,UAAU,SAAS,QAAQ;IAC3B,UAAU,SAAS,QAAQ;IAC3B,cAAc,SAAS,QAAQ;IAC/B,WAAW,SAAS;GACrB,CAAC;EACF;EACA,IAAI,SAAS,MAAM,KAAK,SACvB,OAAO,OAAO;GACb,GAAG,OAAO;GACV,OAAO,CAAC,GAAI,OAAO,MAAM,SAAS,CAAC,GAAI,SAAS,SAAS,MAAM,KAAK,MAAM,aAAa,CAAC;EACzF;EAED,IAAI,SAAS,KAAK,SAAS;GAC1B,OAAO,cAAc,CACpB,GAAI,OAAO,eAAe,CAAC,GAC3B,eAAe,SAAS,KAAK,gBAAgB,SAAS,KAAK,MAAM,CAClE;GACA,OAAO,OAAO;IACb,GAAG,OAAO;IACV,OAAO,CACN,GAAI,OAAO,MAAM,SAAS,CAAC,GAC3B,SAAS;KACR,MAAM,SAAS,KAAK;KACpB,cAAc,SAAS,KAAK;KAC5B,gBAAgB,SAAS,KAAK;KAC9B,YAAY,SAAS,KAAK;IAC3B,CAAC,CACF;GACD;EACD;EACA,MAAM,aAAa,OAAO;EAG1B,OAAO,SAAS,OAAO,YAAY;GAClC,IAAI,SAAS,UAAU,WAAW,SAAS;IAC1C,MAAM,EAAE,0BAA0B,MAAM,OAAO;IAC/C,MAAM,sBAAsB,SAAS,SAAS,UAAU,WAAW,YAAY,IAAI;GACpF;GACA,MAAM,SAAS,aAAa;IAC3B,OAAO,aAAa,QAAQ,EAAE;IAC9B,OAAO,EAAE,aAAa,EAAE;IACxB,KAAK,SAAS,MAAM;GACrB,CAAC;GACD,WAAW,SAAS;IACnB;IACA;IACA;IACA;IACA,mBAAmB,SAAS;IAC5B,kBAAkB,IAAI,IAAI,SAAS,SAAS,KAAK,MAAM,EAAE,EAAE,CAAC;IAC5D,cAAc,SAAS,OAAO;IAC9B,UAAU,SAAS;IACnB;IACA,KAAK,SAAS,MAAM;IACpB,YAAY,SAAS,QAAQ;GAC9B,CAAC;GACD,MAAM,aAAa,OAAO;EAC3B;EACA,OAAO;CACR;AACD,CAAC"}
|
package/dist/plugin/paths.js
CHANGED
|
@@ -5,7 +5,9 @@
|
|
|
5
5
|
* pulling server code into the bundle.
|
|
6
6
|
*/
|
|
7
7
|
const DOCUMENT_PATH = "/analytics/document";
|
|
8
|
+
const SOURCES_PATH = "/analytics/sources";
|
|
9
|
+
const REALTIME_PATH = "/analytics/realtime";
|
|
8
10
|
//#endregion
|
|
9
|
-
export { DOCUMENT_PATH };
|
|
11
|
+
export { DOCUMENT_PATH, REALTIME_PATH, SOURCES_PATH };
|
|
10
12
|
|
|
11
13
|
//# sourceMappingURL=paths.js.map
|
package/dist/plugin/paths.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"paths.js","names":[],"sources":["../../src/plugin/paths.ts"],"sourcesContent":["/**\n * Endpoint paths shared between server registration and client fetchers. Kept in a\n * dependency-free leaf module so client components can import the path without\n * pulling server code into the bundle.\n */\nexport const DOCUMENT_PATH = '/analytics/document'\n"],"mappings":";;;;;;AAKA,MAAa,gBAAgB"}
|
|
1
|
+
{"version":3,"file":"paths.js","names":[],"sources":["../../src/plugin/paths.ts"],"sourcesContent":["/**\n * Endpoint paths shared between server registration and client fetchers. Kept in a\n * dependency-free leaf module so client components can import the path without\n * pulling server code into the bundle.\n */\nexport const DOCUMENT_PATH = '/analytics/document'\nexport const SOURCES_PATH = '/analytics/sources'\nexport const REALTIME_PATH = '/analytics/realtime'\n"],"mappings":";;;;;;AAKA,MAAa,gBAAgB;AAC7B,MAAa,eAAe;AAC5B,MAAa,gBAAgB"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
//#region src/plugin/peerImportError.ts
|
|
2
|
+
/**
|
|
3
|
+
* True for Node's module-resolution failure codes (ESM `ERR_MODULE_NOT_FOUND`,
|
|
4
|
+
* CJS `MODULE_NOT_FOUND`): the only peer-import failures that mean "the peer
|
|
5
|
+
* isn't installed". Anything else is a real error surfacing from inside the
|
|
6
|
+
* peer module once resolved and must propagate unchanged, not get relabeled
|
|
7
|
+
* as a missing dependency.
|
|
8
|
+
*/
|
|
9
|
+
const isModuleNotFoundError = (err) => {
|
|
10
|
+
const code = err instanceof Error ? err.code : void 0;
|
|
11
|
+
return code === "ERR_MODULE_NOT_FOUND" || code === "MODULE_NOT_FOUND";
|
|
12
|
+
};
|
|
13
|
+
//#endregion
|
|
14
|
+
export { isModuleNotFoundError };
|
|
15
|
+
|
|
16
|
+
//# sourceMappingURL=peerImportError.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"peerImportError.js","names":[],"sources":["../../src/plugin/peerImportError.ts"],"sourcesContent":["/**\n * True for Node's module-resolution failure codes (ESM `ERR_MODULE_NOT_FOUND`,\n * CJS `MODULE_NOT_FOUND`): the only peer-import failures that mean \"the peer\n * isn't installed\". Anything else is a real error surfacing from inside the\n * peer module once resolved and must propagate unchanged, not get relabeled\n * as a missing dependency.\n */\nexport const isModuleNotFoundError = (err: unknown): boolean => {\n\tconst code = err instanceof Error ? (err as NodeJS.ErrnoException).code : undefined\n\treturn code === 'ERR_MODULE_NOT_FOUND' || code === 'MODULE_NOT_FOUND'\n}\n"],"mappings":";;;;;;;;AAOA,MAAa,yBAAyB,QAA0B;CAC/D,MAAM,OAAO,eAAe,QAAS,IAA8B,OAAO,KAAA;CAC1E,OAAO,SAAS,0BAA0B,SAAS;AACpD"}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import "./paths.js";
|
|
1
2
|
import { readForWidgetRealtime } from "../widgets/readForWidgetRealtime.js";
|
|
2
3
|
//#region src/plugin/realtimeEndpoint.ts
|
|
3
4
|
const ALLOWED_METRICS = ["visitors", "pageviews"];
|
|
@@ -8,7 +9,6 @@ const ALLOWED_WINDOWS = [
|
|
|
8
9
|
60
|
|
9
10
|
];
|
|
10
11
|
const DEFAULT_WINDOW = 30;
|
|
11
|
-
const REALTIME_PATH = "/analytics/realtime";
|
|
12
12
|
/**
|
|
13
13
|
* Authenticated GET handler for the realtime widget poller. Reads + clamps the query
|
|
14
14
|
* params, then delegates to readForWidgetRealtime. Returns 401 for an anonymous request.
|
|
@@ -31,6 +31,6 @@ const makeRealtimeHandler = () => async (req) => {
|
|
|
31
31
|
return Response.json(result);
|
|
32
32
|
};
|
|
33
33
|
//#endregion
|
|
34
|
-
export {
|
|
34
|
+
export { makeRealtimeHandler };
|
|
35
35
|
|
|
36
36
|
//# sourceMappingURL=realtimeEndpoint.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"realtimeEndpoint.js","names":[],"sources":["../../src/plugin/realtimeEndpoint.ts"],"sourcesContent":["import type { PayloadHandler } from 'payload'\nimport type { MetricKey } from '../core/contract'\nimport { readForWidgetRealtime } from '../widgets/readForWidgetRealtime'\n\nconst ALLOWED_METRICS: MetricKey[] = ['visitors', 'pageviews']\nconst ALLOWED_WINDOWS = [5, 15, 30, 60]\nconst DEFAULT_WINDOW = 30\n\
|
|
1
|
+
{"version":3,"file":"realtimeEndpoint.js","names":[],"sources":["../../src/plugin/realtimeEndpoint.ts"],"sourcesContent":["import type { PayloadHandler } from 'payload'\nimport type { MetricKey } from '../core/contract'\nimport { readForWidgetRealtime } from '../widgets/readForWidgetRealtime'\nimport { REALTIME_PATH } from './paths'\n\nexport { REALTIME_PATH }\n\nconst ALLOWED_METRICS: MetricKey[] = ['visitors', 'pageviews']\nconst ALLOWED_WINDOWS = [5, 15, 30, 60]\nconst DEFAULT_WINDOW = 30\n\n/**\n * Authenticated GET handler for the realtime widget poller. Reads + clamps the query\n * params, then delegates to readForWidgetRealtime. Returns 401 for an anonymous request.\n * The gate is any authenticated user (not admin-panel access specifically); the response\n * is integer counts only. Tightening to admin-only is a post-v1 option.\n */\nexport const makeRealtimeHandler = (): PayloadHandler => async (req) => {\n\tif (!req.user) {\n\t\treturn Response.json({ error: 'unauthorized' }, { status: 401 })\n\t}\n\tconst params = new URL(req.url ?? '', 'http://localhost').searchParams\n\tconst rawMetric = params.get('metric')\n\tconst metric: MetricKey = ALLOWED_METRICS.includes(rawMetric as MetricKey)\n\t\t? (rawMetric as MetricKey)\n\t\t: 'visitors'\n\tconst rawWindow = Number(params.get('windowMinutes'))\n\tconst windowMinutes = ALLOWED_WINDOWS.includes(rawWindow) ? rawWindow : DEFAULT_WINDOW\n\tconst dataSource = params.get('dataSource') ?? undefined\n\tconst result = await readForWidgetRealtime({\n\t\treq,\n\t\tmetric,\n\t\twindowMinutes,\n\t\tadapterId: dataSource,\n\t\tnow: new Date(),\n\t})\n\treturn Response.json(result)\n}\n"],"mappings":";;;AAOA,MAAM,kBAA+B,CAAC,YAAY,WAAW;AAC7D,MAAM,kBAAkB;CAAC;CAAG;CAAI;CAAI;AAAE;AACtC,MAAM,iBAAiB;;;;;;;AAQvB,MAAa,4BAA4C,OAAO,QAAQ;CACvE,IAAI,CAAC,IAAI,MACR,OAAO,SAAS,KAAK,EAAE,OAAO,eAAe,GAAG,EAAE,QAAQ,IAAI,CAAC;CAEhE,MAAM,SAAS,IAAI,IAAI,IAAI,OAAO,IAAI,kBAAkB,EAAE;CAC1D,MAAM,YAAY,OAAO,IAAI,QAAQ;CACrC,MAAM,SAAoB,gBAAgB,SAAS,SAAsB,IACrE,YACD;CACH,MAAM,YAAY,OAAO,OAAO,IAAI,eAAe,CAAC;CAGpD,MAAM,SAAS,MAAM,sBAAsB;EAC1C;EACA;EACA,eALqB,gBAAgB,SAAS,SAAS,IAAI,YAAY;EAMvE,WALkB,OAAO,IAAI,YAAY,KAAK,KAAA;EAM9C,qBAAK,IAAI,KAAK;CACf,CAAC;CACD,OAAO,SAAS,KAAK,MAAM;AAC5B"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"runtime.js","names":[],"sources":["../../src/plugin/runtime.ts"],"sourcesContent":["import type { Payload, PayloadRequest } from 'payload'\nimport type { ResolvedBinding } from '../binding/types'\nimport type { AdapterRegistry, RegistryResolver, ResolveRegistryArgs } from '../core/registry'\nimport type { Engine } from '../surfacing/engine'\nimport { DEFAULT_TIMEZONE } from '../timeframe/tz'\n\nexport interface AnalyticsRuntime {\n\tregistry: AdapterRegistry\n\t/** Per-scope adapter resolution; absent runtimes fall back to the static registry. */\n\tresolveRegistry?: RegistryResolver\n\t/** The plugin's scopeResolver bound at init; absent runtimes resolve null. */\n\tresolveScope?: (req: PayloadRequest) => Promise<string | null>\n\t/** The plugin's reportingTimezone bound at init; absent runtimes resolve 'UTC'. */\n\tresolveTimezone?: (req: PayloadRequest, scope?: string | null) => Promise<string>\n\t/** Id of the config adapter shared by every scope, when one is designated. */\n\tplatformAdapterId?: string\n\t/** Gate for cross-scope reads; absent runtimes require an authenticated user. */\n\tplatformRead?: (args: { req: PayloadRequest }) => boolean | Promise<boolean>\n\tbindings: Record<string, ResolvedBinding>\n\tengine: Engine\n\t/** Explicit TTL overrides; when a value is unset the adapter's recommendedTtl applies. */\n\tttl: { aggregate?: number; realtime?: number }\n\t/** Widget period-over-period comparison; false skips the previous-window read. */\n\tcomparison: boolean\n}\n\n/**\n * Stored on the Payload instance (not a module global) so the runtime survives the\n * separate `.` and `/rsc` bundles a consumer loads: a server-component bundle that\n * imported its own copy of a module-level map would never see what the plugin wrote.\n * `Symbol.for` keys into the cross-realm global symbol registry, so both bundles\n * resolve the same key on the same `payload` object.\n */\nconst RUNTIME_KEY = Symbol.for('@10x-media/analytics/runtime')\n\ntype RuntimeHost = { [RUNTIME_KEY]?: AnalyticsRuntime }\n\nexport const setRuntime = (payload: Payload, runtime: AnalyticsRuntime): void => {\n\t;(payload as unknown as RuntimeHost)[RUNTIME_KEY] = runtime\n}\n\nexport const getRuntime = (payload: Payload): AnalyticsRuntime | undefined =>\n\t(payload as unknown as RuntimeHost)[RUNTIME_KEY]\n\nexport const resolveScopeFor = (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest\n): Promise<string | null> => runtime.resolveScope?.(req) ?? Promise.resolve(null)\n\nexport const resolveTimezoneFor = (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest,\n\tscope?: string | null\n): Promise<string> => runtime.resolveTimezone?.(req, scope) ?? Promise.resolve(DEFAULT_TIMEZONE)\n\nexport const resolveRegistryFor = (\n\truntime: AnalyticsRuntime,\n\targs: ResolveRegistryArgs\n): Promise<AdapterRegistry> => runtime.resolveRegistry?.(args) ?? Promise.resolve(runtime.registry)\n\nexport const platformReadFor = async (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest\n): Promise<boolean> =>\n\truntime.platformRead ? await runtime.platformRead({ req }) : Boolean(req.user)\n"],"mappings":";;;;;;;;
|
|
1
|
+
{"version":3,"file":"runtime.js","names":[],"sources":["../../src/plugin/runtime.ts"],"sourcesContent":["import type { Payload, PayloadRequest } from 'payload'\nimport type { ResolvedBinding } from '../binding/types'\nimport type { AdapterRegistry, RegistryResolver, ResolveRegistryArgs } from '../core/registry'\nimport type { Engine } from '../surfacing/engine'\nimport { DEFAULT_TIMEZONE } from '../timeframe/tz'\n\nexport interface AnalyticsRuntime {\n\tregistry: AdapterRegistry\n\t/** Per-scope adapter resolution; absent runtimes fall back to the static registry. */\n\tresolveRegistry?: RegistryResolver\n\t/** The plugin's scopeResolver bound at init; absent runtimes resolve null. */\n\tresolveScope?: (req: PayloadRequest) => Promise<string | null>\n\t/** The plugin's reportingTimezone bound at init; absent runtimes resolve 'UTC'. */\n\tresolveTimezone?: (req: PayloadRequest, scope?: string | null) => Promise<string>\n\t/** Id of the config adapter shared by every scope, when one is designated. */\n\tplatformAdapterId?: string\n\t/**\n\t * Ids of the config-time adapters shared by every scope (the ones passed to\n\t * `adapters` in plugin options). Runtime provider adapters (resolved per scope\n\t * from the providers collection or `providers.resolve`) are never in it.\n\t */\n\tconfigAdapterIds: ReadonlySet<string>\n\t/** Gate for cross-scope reads; absent runtimes require an authenticated user. */\n\tplatformRead?: (args: { req: PayloadRequest }) => boolean | Promise<boolean>\n\tbindings: Record<string, ResolvedBinding>\n\tengine: Engine\n\t/** Explicit TTL overrides; when a value is unset the adapter's recommendedTtl applies. */\n\tttl: { aggregate?: number; realtime?: number }\n\t/** Widget period-over-period comparison; false skips the previous-window read. */\n\tcomparison: boolean\n}\n\n/**\n * Stored on the Payload instance (not a module global) so the runtime survives the\n * separate `.` and `/rsc` bundles a consumer loads: a server-component bundle that\n * imported its own copy of a module-level map would never see what the plugin wrote.\n * `Symbol.for` keys into the cross-realm global symbol registry, so both bundles\n * resolve the same key on the same `payload` object.\n */\nconst RUNTIME_KEY = Symbol.for('@10x-media/analytics/runtime')\n\ntype RuntimeHost = { [RUNTIME_KEY]?: AnalyticsRuntime }\n\nexport const setRuntime = (payload: Payload, runtime: AnalyticsRuntime): void => {\n\t;(payload as unknown as RuntimeHost)[RUNTIME_KEY] = runtime\n}\n\nexport const getRuntime = (payload: Payload): AnalyticsRuntime | undefined =>\n\t(payload as unknown as RuntimeHost)[RUNTIME_KEY]\n\nexport const resolveScopeFor = (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest\n): Promise<string | null> => runtime.resolveScope?.(req) ?? Promise.resolve(null)\n\nexport const resolveTimezoneFor = (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest,\n\tscope?: string | null\n): Promise<string> => runtime.resolveTimezone?.(req, scope) ?? Promise.resolve(DEFAULT_TIMEZONE)\n\nexport const resolveRegistryFor = (\n\truntime: AnalyticsRuntime,\n\targs: ResolveRegistryArgs\n): Promise<AdapterRegistry> => runtime.resolveRegistry?.(args) ?? Promise.resolve(runtime.registry)\n\nexport const platformReadFor = async (\n\truntime: AnalyticsRuntime,\n\treq: PayloadRequest\n): Promise<boolean> =>\n\truntime.platformRead ? await runtime.platformRead({ req }) : Boolean(req.user)\n"],"mappings":";;;;;;;;AAuCA,MAAM,cAAc,OAAO,IAAI,8BAA8B;AAI7D,MAAa,cAAc,SAAkB,YAAoC;CAC/E,QAAoC,eAAe;AACrD;AAEA,MAAa,cAAc,YACzB,QAAmC;AAErC,MAAa,mBACZ,SACA,QAC4B,QAAQ,eAAe,GAAG,KAAK,QAAQ,QAAQ,IAAI;AAEhF,MAAa,sBACZ,SACA,KACA,UACqB,QAAQ,kBAAkB,KAAK,KAAK,KAAK,QAAQ,QAAA,KAAwB;AAE/F,MAAa,sBACZ,SACA,SAC8B,QAAQ,kBAAkB,IAAI,KAAK,QAAQ,QAAQ,QAAQ,QAAQ;AAElG,MAAa,kBAAkB,OAC9B,SACA,QAEA,QAAQ,eAAe,MAAM,QAAQ,aAAa,EAAE,IAAI,CAAC,IAAI,QAAQ,IAAI,IAAI"}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import { serializeCapabilities } from "../core/capabilities.js";
|
|
2
|
+
import { getRuntime, resolveRegistryFor, resolveScopeFor } from "./runtime.js";
|
|
3
|
+
import "./paths.js";
|
|
4
|
+
//#region src/plugin/sourcesEndpoint.ts
|
|
5
|
+
/**
|
|
6
|
+
* Authenticated GET listing the adapters visible to the requesting scope, with
|
|
7
|
+
* serialized capabilities for client-side pickers. Always answers for the
|
|
8
|
+
* caller's own resolved scope; there is deliberately no scope parameter, so a
|
|
9
|
+
* tenant can never enumerate another tenant's sources. Resolution failures
|
|
10
|
+
* degrade to the static config registry the same way reads do.
|
|
11
|
+
*/
|
|
12
|
+
const makeSourcesHandler = () => async (req) => {
|
|
13
|
+
if (!req.user) return Response.json({ error: "unauthorized" }, { status: 401 });
|
|
14
|
+
const runtime = getRuntime(req.payload);
|
|
15
|
+
if (!runtime) return Response.json({
|
|
16
|
+
defaultId: null,
|
|
17
|
+
sources: []
|
|
18
|
+
});
|
|
19
|
+
try {
|
|
20
|
+
const scope = await resolveScopeFor(runtime, req);
|
|
21
|
+
const registry = await resolveRegistryFor(runtime, {
|
|
22
|
+
payload: req.payload,
|
|
23
|
+
req,
|
|
24
|
+
scope
|
|
25
|
+
});
|
|
26
|
+
const sources = registry.all().map((a) => ({
|
|
27
|
+
id: a.id,
|
|
28
|
+
label: a.label,
|
|
29
|
+
kind: runtime.configAdapterIds.has(a.id) ? "config" : "runtime",
|
|
30
|
+
capabilities: serializeCapabilities(a.capabilities)
|
|
31
|
+
}));
|
|
32
|
+
return Response.json({
|
|
33
|
+
defaultId: registry.default().id,
|
|
34
|
+
sources
|
|
35
|
+
});
|
|
36
|
+
} catch (err) {
|
|
37
|
+
req.payload.logger?.warn(`analytics: sources listing failed: ${String(err)}`);
|
|
38
|
+
const sources = runtime.registry.all().map((a) => ({
|
|
39
|
+
id: a.id,
|
|
40
|
+
label: a.label,
|
|
41
|
+
kind: "config",
|
|
42
|
+
capabilities: serializeCapabilities(a.capabilities)
|
|
43
|
+
}));
|
|
44
|
+
return Response.json({
|
|
45
|
+
defaultId: runtime.registry.default().id,
|
|
46
|
+
sources
|
|
47
|
+
});
|
|
48
|
+
}
|
|
49
|
+
};
|
|
50
|
+
//#endregion
|
|
51
|
+
export { makeSourcesHandler };
|
|
52
|
+
|
|
53
|
+
//# sourceMappingURL=sourcesEndpoint.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sourcesEndpoint.js","names":[],"sources":["../../src/plugin/sourcesEndpoint.ts"],"sourcesContent":["import type { PayloadHandler } from 'payload'\nimport { serializeCapabilities } from '../core/capabilities'\nimport { SOURCES_PATH } from './paths'\nimport { getRuntime, resolveRegistryFor, resolveScopeFor } from './runtime'\n\nexport { SOURCES_PATH }\n\n/**\n * Authenticated GET listing the adapters visible to the requesting scope, with\n * serialized capabilities for client-side pickers. Always answers for the\n * caller's own resolved scope; there is deliberately no scope parameter, so a\n * tenant can never enumerate another tenant's sources. Resolution failures\n * degrade to the static config registry the same way reads do.\n */\nexport const makeSourcesHandler = (): PayloadHandler => async (req) => {\n\tif (!req.user) {\n\t\treturn Response.json({ error: 'unauthorized' }, { status: 401 })\n\t}\n\tconst runtime = getRuntime(req.payload)\n\tif (!runtime) {\n\t\treturn Response.json({ defaultId: null, sources: [] })\n\t}\n\ttry {\n\t\tconst scope = await resolveScopeFor(runtime, req)\n\t\tconst registry = await resolveRegistryFor(runtime, { payload: req.payload, req, scope })\n\t\tconst sources = registry.all().map((a) => ({\n\t\t\tid: a.id,\n\t\t\tlabel: a.label,\n\t\t\tkind: runtime.configAdapterIds.has(a.id) ? ('config' as const) : ('runtime' as const),\n\t\t\tcapabilities: serializeCapabilities(a.capabilities),\n\t\t}))\n\t\treturn Response.json({ defaultId: registry.default().id, sources })\n\t} catch (err) {\n\t\treq.payload.logger?.warn(`analytics: sources listing failed: ${String(err)}`)\n\t\tconst sources = runtime.registry.all().map((a) => ({\n\t\t\tid: a.id,\n\t\t\tlabel: a.label,\n\t\t\tkind: 'config' as const,\n\t\t\tcapabilities: serializeCapabilities(a.capabilities),\n\t\t}))\n\t\treturn Response.json({ defaultId: runtime.registry.default().id, sources })\n\t}\n}\n"],"mappings":";;;;;;;;;;;AAcA,MAAa,2BAA2C,OAAO,QAAQ;CACtE,IAAI,CAAC,IAAI,MACR,OAAO,SAAS,KAAK,EAAE,OAAO,eAAe,GAAG,EAAE,QAAQ,IAAI,CAAC;CAEhE,MAAM,UAAU,WAAW,IAAI,OAAO;CACtC,IAAI,CAAC,SACJ,OAAO,SAAS,KAAK;EAAE,WAAW;EAAM,SAAS,CAAC;CAAE,CAAC;CAEtD,IAAI;EACH,MAAM,QAAQ,MAAM,gBAAgB,SAAS,GAAG;EAChD,MAAM,WAAW,MAAM,mBAAmB,SAAS;GAAE,SAAS,IAAI;GAAS;GAAK;EAAM,CAAC;EACvF,MAAM,UAAU,SAAS,IAAI,EAAE,KAAK,OAAO;GAC1C,IAAI,EAAE;GACN,OAAO,EAAE;GACT,MAAM,QAAQ,iBAAiB,IAAI,EAAE,EAAE,IAAK,WAAsB;GAClE,cAAc,sBAAsB,EAAE,YAAY;EACnD,EAAE;EACF,OAAO,SAAS,KAAK;GAAE,WAAW,SAAS,QAAQ,EAAE;GAAI;EAAQ,CAAC;CACnE,SAAS,KAAK;EACb,IAAI,QAAQ,QAAQ,KAAK,sCAAsC,OAAO,GAAG,GAAG;EAC5E,MAAM,UAAU,QAAQ,SAAS,IAAI,EAAE,KAAK,OAAO;GAClD,IAAI,EAAE;GACN,OAAO,EAAE;GACT,MAAM;GACN,cAAc,sBAAsB,EAAE,YAAY;EACnD,EAAE;EACF,OAAO,SAAS,KAAK;GAAE,WAAW,QAAQ,SAAS,QAAQ,EAAE;GAAI;EAAQ,CAAC;CAC3E;AACD"}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
//#region src/providers/access.ts
|
|
2
|
+
const resolveOrNull = async (args, req) => {
|
|
3
|
+
try {
|
|
4
|
+
const scope = await args.resolveScope(req);
|
|
5
|
+
return scope === "" ? null : scope;
|
|
6
|
+
} catch {
|
|
7
|
+
return null;
|
|
8
|
+
}
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* Row access (read/update/delete) for the provider collection. Unscoped
|
|
12
|
+
* installs keep the historical any-authenticated-user behavior. Scoped
|
|
13
|
+
* installs constrain every row operation to the request's resolved scope via
|
|
14
|
+
* a where clause (so list views filter instead of erroring); the platformRead
|
|
15
|
+
* gate lifts the constraint for platform admins. A null or unresolvable scope
|
|
16
|
+
* fails closed.
|
|
17
|
+
*/
|
|
18
|
+
const providerRowAccess = (args) => {
|
|
19
|
+
return async ({ req }) => {
|
|
20
|
+
if (!req.user) return false;
|
|
21
|
+
if (!args.scoped) return true;
|
|
22
|
+
if (await args.platformRead({ req })) return true;
|
|
23
|
+
const scope = await resolveOrNull(args, req);
|
|
24
|
+
if (scope === null) return false;
|
|
25
|
+
return { [args.scopeField]: { equals: scope } };
|
|
26
|
+
};
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* Create access: any authenticated user in unscoped installs; in scoped
|
|
30
|
+
* installs the requester needs a resolved scope (the stamp hook writes it) or
|
|
31
|
+
* the platform grant (install-wide providers have no scope to resolve).
|
|
32
|
+
*/
|
|
33
|
+
const providerCreateAccess = (args) => {
|
|
34
|
+
return async ({ req }) => {
|
|
35
|
+
if (!req.user) return false;
|
|
36
|
+
if (!args.scoped) return true;
|
|
37
|
+
if (await args.platformRead({ req })) return true;
|
|
38
|
+
return await resolveOrNull(args, req) !== null;
|
|
39
|
+
};
|
|
40
|
+
};
|
|
41
|
+
//#endregion
|
|
42
|
+
export { providerCreateAccess, providerRowAccess };
|
|
43
|
+
|
|
44
|
+
//# sourceMappingURL=access.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"access.js","names":[],"sources":["../../src/providers/access.ts"],"sourcesContent":["import type { Access, PayloadRequest } from 'payload'\nimport type { PlatformReadAccess } from '../core/options'\n\nexport interface ProviderAccessArgs {\n\t/** True when the install configured a scopeResolver. */\n\tscoped: boolean\n\tscopeField: string\n\tresolveScope: (req: PayloadRequest) => Promise<string | null>\n\tplatformRead: PlatformReadAccess\n}\n\nconst resolveOrNull = async (\n\targs: ProviderAccessArgs,\n\treq: PayloadRequest\n): Promise<string | null> => {\n\ttry {\n\t\tconst scope = await args.resolveScope(req)\n\t\treturn scope === '' ? null : scope\n\t} catch {\n\t\treturn null\n\t}\n}\n\n/**\n * Row access (read/update/delete) for the provider collection. Unscoped\n * installs keep the historical any-authenticated-user behavior. Scoped\n * installs constrain every row operation to the request's resolved scope via\n * a where clause (so list views filter instead of erroring); the platformRead\n * gate lifts the constraint for platform admins. A null or unresolvable scope\n * fails closed.\n */\nexport const providerRowAccess = (args: ProviderAccessArgs): Access => {\n\treturn async ({ req }) => {\n\t\tif (!req.user) return false\n\t\tif (!args.scoped) return true\n\t\tif (await args.platformRead({ req })) return true\n\t\tconst scope = await resolveOrNull(args, req)\n\t\tif (scope === null) return false\n\t\treturn { [args.scopeField]: { equals: scope } }\n\t}\n}\n\n/**\n * Create access: any authenticated user in unscoped installs; in scoped\n * installs the requester needs a resolved scope (the stamp hook writes it) or\n * the platform grant (install-wide providers have no scope to resolve).\n */\nexport const providerCreateAccess = (args: ProviderAccessArgs): Access => {\n\treturn async ({ req }) => {\n\t\tif (!req.user) return false\n\t\tif (!args.scoped) return true\n\t\tif (await args.platformRead({ req })) return true\n\t\treturn (await resolveOrNull(args, req)) !== null\n\t}\n}\n"],"mappings":";AAWA,MAAM,gBAAgB,OACrB,MACA,QAC4B;CAC5B,IAAI;EACH,MAAM,QAAQ,MAAM,KAAK,aAAa,GAAG;EACzC,OAAO,UAAU,KAAK,OAAO;CAC9B,QAAQ;EACP,OAAO;CACR;AACD;;;;;;;;;AAUA,MAAa,qBAAqB,SAAqC;CACtE,OAAO,OAAO,EAAE,UAAU;EACzB,IAAI,CAAC,IAAI,MAAM,OAAO;EACtB,IAAI,CAAC,KAAK,QAAQ,OAAO;EACzB,IAAI,MAAM,KAAK,aAAa,EAAE,IAAI,CAAC,GAAG,OAAO;EAC7C,MAAM,QAAQ,MAAM,cAAc,MAAM,GAAG;EAC3C,IAAI,UAAU,MAAM,OAAO;EAC3B,OAAO,GAAG,KAAK,aAAa,EAAE,QAAQ,MAAM,EAAE;CAC/C;AACD;;;;;;AAOA,MAAa,wBAAwB,SAAqC;CACzE,OAAO,OAAO,EAAE,UAAU;EACzB,IAAI,CAAC,IAAI,MAAM,OAAO;EACtB,IAAI,CAAC,KAAK,QAAQ,OAAO;EACzB,IAAI,MAAM,KAAK,aAAa,EAAE,IAAI,CAAC,GAAG,OAAO;EAC7C,OAAQ,MAAM,cAAc,MAAM,GAAG,MAAO;CAC7C;AACD"}
|
|
@@ -1,27 +1,20 @@
|
|
|
1
1
|
import { keys } from "../translations/keys.js";
|
|
2
2
|
import { labelForKey } from "../translations/server.js";
|
|
3
|
-
import {
|
|
3
|
+
import { providerCreateAccess, providerRowAccess } from "./access.js";
|
|
4
|
+
import { stampScope } from "./stampScope.js";
|
|
4
5
|
//#region src/providers/collection.ts
|
|
5
6
|
const PROVIDERS_SLUG = "analytics-providers";
|
|
6
|
-
const loggedIn = ({ req }) => Boolean(req.user);
|
|
7
7
|
const textField = (name, label, width) => ({
|
|
8
8
|
name,
|
|
9
9
|
type: "text",
|
|
10
10
|
label: labelForKey(label),
|
|
11
11
|
...width ? { admin: { width } } : {}
|
|
12
12
|
});
|
|
13
|
-
const secretField = (
|
|
14
|
-
name,
|
|
13
|
+
const secretField = (args, opts) => args.buildSecret({
|
|
14
|
+
name: opts.name,
|
|
15
15
|
type: "text",
|
|
16
|
-
label: labelForKey(label),
|
|
17
|
-
admin: {
|
|
18
|
-
description: labelForKey(keys.providerSecretHelp),
|
|
19
|
-
...width ? { width } : {}
|
|
20
|
-
},
|
|
21
|
-
hooks: {
|
|
22
|
-
beforeChange: [preserveMaskedSecret],
|
|
23
|
-
afterRead: [maskSecret]
|
|
24
|
-
}
|
|
16
|
+
label: labelForKey(opts.label),
|
|
17
|
+
...opts.width ? { admin: { width: opts.width } } : {}
|
|
25
18
|
});
|
|
26
19
|
const hostField = () => ({
|
|
27
20
|
name: "host",
|
|
@@ -49,19 +42,25 @@ const buildProvidersCollection = (args) => {
|
|
|
49
42
|
singular: labelForKey(keys.providersCollectionSingular),
|
|
50
43
|
plural: labelForKey(keys.providersCollectionPlural)
|
|
51
44
|
},
|
|
45
|
+
disableDuplicate: true,
|
|
52
46
|
admin: {
|
|
53
|
-
useAsTitle: "
|
|
54
|
-
defaultColumns: [
|
|
47
|
+
useAsTitle: "name",
|
|
48
|
+
defaultColumns: [
|
|
49
|
+
"name",
|
|
50
|
+
"provider",
|
|
51
|
+
"enabled"
|
|
52
|
+
],
|
|
55
53
|
group: "Analytics"
|
|
56
54
|
},
|
|
57
55
|
access: {
|
|
58
|
-
read:
|
|
59
|
-
create:
|
|
60
|
-
update:
|
|
61
|
-
delete:
|
|
56
|
+
read: providerRowAccess(args),
|
|
57
|
+
create: providerCreateAccess(args),
|
|
58
|
+
update: providerRowAccess(args),
|
|
59
|
+
delete: providerRowAccess(args),
|
|
62
60
|
...args.access
|
|
63
61
|
},
|
|
64
62
|
hooks: {
|
|
63
|
+
beforeChange: [stampScope(args)],
|
|
65
64
|
afterChange: [({ doc }) => {
|
|
66
65
|
args.onChange();
|
|
67
66
|
return doc;
|
|
@@ -72,6 +71,12 @@ const buildProvidersCollection = (args) => {
|
|
|
72
71
|
}]
|
|
73
72
|
},
|
|
74
73
|
fields: [
|
|
74
|
+
{
|
|
75
|
+
name: "name",
|
|
76
|
+
type: "text",
|
|
77
|
+
required: true,
|
|
78
|
+
label: labelForKey(keys.providerFieldName)
|
|
79
|
+
},
|
|
75
80
|
{
|
|
76
81
|
type: "row",
|
|
77
82
|
fields: [{
|
|
@@ -118,14 +123,25 @@ const buildProvidersCollection = (args) => {
|
|
|
118
123
|
},
|
|
119
124
|
providerGroup("plausible", keys.providerNamePlausible, [{
|
|
120
125
|
type: "row",
|
|
121
|
-
fields: [textField("siteId", keys.providerFieldSiteId, "50%"), secretField(
|
|
126
|
+
fields: [textField("siteId", keys.providerFieldSiteId, "50%"), ...secretField(args, {
|
|
127
|
+
name: "apiKey",
|
|
128
|
+
label: keys.providerFieldApiKey,
|
|
129
|
+
width: "50%"
|
|
130
|
+
})]
|
|
122
131
|
}, hostField()]),
|
|
123
132
|
providerGroup("umami", keys.providerNameUmami, [
|
|
124
133
|
{
|
|
125
134
|
type: "row",
|
|
126
|
-
fields: [textField("websiteId", keys.providerFieldWebsiteId, "50%"), secretField(
|
|
135
|
+
fields: [textField("websiteId", keys.providerFieldWebsiteId, "50%"), ...secretField(args, {
|
|
136
|
+
name: "apiKey",
|
|
137
|
+
label: keys.providerFieldApiKey,
|
|
138
|
+
width: "50%"
|
|
139
|
+
})]
|
|
127
140
|
},
|
|
128
|
-
secretField(
|
|
141
|
+
...secretField(args, {
|
|
142
|
+
name: "token",
|
|
143
|
+
label: keys.providerFieldToken
|
|
144
|
+
}),
|
|
129
145
|
hostField()
|
|
130
146
|
]),
|
|
131
147
|
providerGroup("ga4", keys.providerNameGa4, [
|
|
@@ -134,20 +150,19 @@ const buildProvidersCollection = (args) => {
|
|
|
134
150
|
fields: [textField("propertyId", keys.providerFieldPropertyId, "50%"), textField("projectId", keys.providerFieldProjectId, "50%")]
|
|
135
151
|
},
|
|
136
152
|
textField("clientEmail", keys.providerFieldClientEmail),
|
|
137
|
-
{
|
|
153
|
+
...args.buildSecret({
|
|
138
154
|
name: "privateKey",
|
|
139
155
|
type: "textarea",
|
|
140
|
-
label: labelForKey(keys.providerFieldPrivateKey)
|
|
141
|
-
|
|
142
|
-
hooks: {
|
|
143
|
-
beforeChange: [preserveMaskedSecret],
|
|
144
|
-
afterRead: [maskSecret]
|
|
145
|
-
}
|
|
146
|
-
}
|
|
156
|
+
label: labelForKey(keys.providerFieldPrivateKey)
|
|
157
|
+
})
|
|
147
158
|
]),
|
|
148
159
|
providerGroup("posthog", keys.providerNamePosthog, [{
|
|
149
160
|
type: "row",
|
|
150
|
-
fields: [textField("projectId", keys.providerFieldProjectId, "50%"), secretField(
|
|
161
|
+
fields: [textField("projectId", keys.providerFieldProjectId, "50%"), ...secretField(args, {
|
|
162
|
+
name: "apiKey",
|
|
163
|
+
label: keys.providerFieldApiKey,
|
|
164
|
+
width: "50%"
|
|
165
|
+
})]
|
|
151
166
|
}, hostField()])
|
|
152
167
|
]
|
|
153
168
|
};
|