@10x-media/analytics 1.0.0-beta.16 → 1.0.0-beta.17
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 +46 -0
- package/dist/adapters/ga4/ga4.js +33 -2
- package/dist/adapters/ga4/ga4.js.map +1 -1
- package/dist/adapters/ga4/measurementId.js +4 -1
- package/dist/adapters/ga4/measurementId.js.map +1 -1
- package/dist/adapters/ga4/propertyId.js +17 -0
- package/dist/adapters/ga4/propertyId.js.map +1 -0
- package/dist/adapters/http/fetchJson.js +24 -1
- package/dist/adapters/http/fetchJson.js.map +1 -1
- package/dist/adapters/plausible/plausible.js +16 -1
- package/dist/adapters/plausible/plausible.js.map +1 -1
- package/dist/adapters/plausible/siteId.js +31 -0
- package/dist/adapters/plausible/siteId.js.map +1 -0
- package/dist/adapters/posthog/posthog.js +17 -3
- package/dist/adapters/posthog/posthog.js.map +1 -1
- package/dist/adapters/umami/umami.js +34 -7
- package/dist/adapters/umami/umami.js.map +1 -1
- package/dist/charts/series.js +1 -1
- package/dist/core/contract.d.ts +16 -1
- package/dist/core/contract.js.map +1 -1
- package/dist/core/options.d.ts +1 -1
- package/dist/core/options.js +1 -1
- package/dist/core/options.js.map +1 -1
- package/dist/core/scopedRead.js +62 -14
- package/dist/core/scopedRead.js.map +1 -1
- package/dist/core/sourceErrors.js +12 -1
- package/dist/core/sourceErrors.js.map +1 -1
- package/dist/core/sourceOptions.js +1 -1
- package/dist/core/sourceOptions.js.map +1 -1
- package/dist/core/sourcePolicy.d.ts +8 -1
- package/dist/core/sourcePolicy.js.map +1 -1
- package/dist/core/throttle.js +3 -1
- package/dist/core/throttle.js.map +1 -1
- package/dist/exports/adapters/contract.d.ts +1 -1
- package/dist/exports/adapters/ga4.d.ts +2 -2
- package/dist/exports/adapters/native.d.ts +2 -2
- package/dist/exports/adapters/plausible.d.ts +2 -2
- package/dist/exports/adapters/posthog.d.ts +2 -2
- package/dist/exports/adapters/umami.d.ts +2 -2
- package/dist/exports/client.d.ts +3 -1
- package/dist/exports/client.js +3 -1
- package/dist/exports/next.d.ts +2 -2
- package/dist/exports/testing.d.ts +2 -2
- package/dist/exports/types.d.ts +3 -3
- package/dist/fields/config/fetchSources.js +1 -1
- package/dist/fields/config/fetchSources.js.map +1 -1
- package/dist/goals/collection.js +3 -2
- package/dist/goals/collection.js.map +1 -1
- package/dist/goals/resolver.js +1 -1
- package/dist/index.d.ts +4 -3
- package/dist/index.js +50 -4
- package/dist/index.js.map +1 -1
- package/dist/native/geo/maxmindResolver.js +1 -1
- package/dist/native/nativeAdapter.js +1 -1
- package/dist/plugin/createRuntime.js +57 -13
- package/dist/plugin/createRuntime.js.map +1 -1
- package/dist/plugin/pluginCollections.js +4 -1
- package/dist/plugin/pluginCollections.js.map +1 -1
- package/dist/plugin/providerStatusEndpoint.js +80 -0
- package/dist/plugin/providerStatusEndpoint.js.map +1 -0
- package/dist/plugin/queryEndpoint.js +1 -1
- package/dist/plugin/queryEndpoint.js.map +1 -1
- package/dist/plugin/readContextForRequest.d.ts +4 -3
- package/dist/plugin/readContextForRequest.js +2 -2
- package/dist/plugin/readContextForRequest.js.map +1 -1
- package/dist/plugin/refreshEndpoint.js +1 -1
- package/dist/plugin/routes.d.ts +5 -0
- package/dist/plugin/routes.js +1 -0
- package/dist/plugin/routes.js.map +1 -1
- package/dist/plugin/runtime.js.map +1 -1
- package/dist/providers/ProviderConnection.d.ts +12 -0
- package/dist/providers/ProviderConnection.js +105 -0
- package/dist/providers/ProviderConnection.js.map +1 -0
- package/dist/providers/ProviderConnectionTest.d.ts +12 -0
- package/dist/providers/ProviderConnectionTest.js +55 -0
- package/dist/providers/ProviderConnectionTest.js.map +1 -0
- package/dist/providers/ProvidersListNotice.d.ts +1 -1
- package/dist/providers/ProvidersListNotice.js +3 -2
- package/dist/providers/ProvidersListNotice.js.map +1 -1
- package/dist/providers/collection.d.ts +1 -1
- package/dist/providers/collection.js +97 -38
- package/dist/providers/collection.js.map +1 -1
- package/dist/providers/connectionCheck.d.ts +1 -0
- package/dist/providers/connectionCheck.js +80 -0
- package/dist/providers/connectionCheck.js.map +1 -0
- package/dist/providers/connectionState.js +53 -0
- package/dist/providers/connectionState.js.map +1 -0
- package/dist/providers/factory.d.ts +1 -3
- package/dist/providers/factory.js +18 -21
- package/dist/providers/factory.js.map +1 -1
- package/dist/providers/hosts.js +20 -6
- package/dist/providers/hosts.js.map +1 -1
- package/dist/providers/ids.d.ts +6 -0
- package/dist/providers/ids.js +32 -0
- package/dist/providers/ids.js.map +1 -0
- package/dist/providers/providerStatusClient.js +60 -0
- package/dist/providers/providerStatusClient.js.map +1 -0
- package/dist/providers/registry.js +56 -20
- package/dist/providers/registry.js.map +1 -1
- package/dist/providers/retarget.js +39 -8
- package/dist/providers/retarget.js.map +1 -1
- package/dist/providers/secrets.d.ts +1 -1
- package/dist/providers/secrets.js.map +1 -1
- package/dist/providers/status.d.ts +1 -0
- package/dist/providers/status.js +181 -0
- package/dist/providers/status.js.map +1 -0
- package/dist/surfacing/classifyError.js +37 -5
- package/dist/surfacing/classifyError.js.map +1 -1
- package/dist/surfacing/engine.js +2 -2
- package/dist/surfacing/engine.js.map +1 -1
- package/dist/surfacing/lanes.js +29 -22
- package/dist/surfacing/lanes.js.map +1 -1
- package/dist/surfacing/rebucket.js +1 -1
- package/dist/testing/settle.d.ts +2 -1
- package/dist/testing/settle.js +6 -2
- package/dist/testing/settle.js.map +1 -1
- package/dist/tracker/sinks/ga4.js +2 -2
- package/dist/translations/ar.js +40 -8
- package/dist/translations/ar.js.map +1 -1
- package/dist/translations/de.js +40 -8
- package/dist/translations/de.js.map +1 -1
- package/dist/translations/en.js +40 -8
- package/dist/translations/en.js.map +1 -1
- package/dist/translations/es.js +40 -8
- package/dist/translations/es.js.map +1 -1
- package/dist/translations/fr.js +40 -8
- package/dist/translations/fr.js.map +1 -1
- package/dist/translations/id.js +40 -8
- package/dist/translations/id.js.map +1 -1
- package/dist/translations/keys.d.ts +32 -0
- package/dist/translations/keys.js +32 -0
- package/dist/translations/keys.js.map +1 -1
- package/dist/translations/ko.js +40 -8
- package/dist/translations/ko.js.map +1 -1
- package/dist/translations/pt.js +40 -8
- package/dist/translations/pt.js.map +1 -1
- package/dist/translations/ru.js +40 -8
- package/dist/translations/ru.js.map +1 -1
- package/dist/translations/uk.js +40 -8
- package/dist/translations/uk.js.map +1 -1
- package/dist/translations/zh.js +40 -8
- package/dist/translations/zh.js.map +1 -1
- package/dist/ui/analytics.css +63 -0
- package/dist/ui/components/SourcesNoticeBanner.js +4 -3
- package/dist/ui/components/SourcesNoticeBanner.js.map +1 -1
- package/dist/view/ViewSections.js +9 -2
- package/dist/view/ViewSections.js.map +1 -1
- package/dist/view/sections/EmptyStates.js +5 -4
- package/dist/view/sections/EmptyStates.js.map +1 -1
- package/dist/view/sections/OverviewCards.js +6 -2
- package/dist/view/sections/OverviewCards.js.map +1 -1
- package/dist/view/sections/SourceConnectionNote.js +56 -0
- package/dist/view/sections/SourceConnectionNote.js.map +1 -0
- package/dist/view/viewProps.d.ts +2 -0
- package/dist/view/viewProps.js +2 -1
- package/dist/view/viewProps.js.map +1 -1
- package/package.json +1 -1
|
@@ -1,18 +1,21 @@
|
|
|
1
1
|
import { isOneOf, kindOf, listOf } from "../core/values.js";
|
|
2
2
|
import { keys } from "../translations/keys.js";
|
|
3
|
+
import { PROVIDER_IDS, PROVIDER_NAMES } from "./ids.js";
|
|
3
4
|
import { optionsObject } from "../core/optionChecks.js";
|
|
4
5
|
import { providerCreateAccess, providerRowAccess } from "./access.js";
|
|
5
6
|
import { asTranslate, labelForKey } from "../translations/server.js";
|
|
6
7
|
import { builtInStaticLabel } from "../translations/staticLabel.js";
|
|
7
8
|
import { validateMeasurementId } from "../adapters/ga4/measurementId.js";
|
|
9
|
+
import { validatePropertyId } from "../adapters/ga4/propertyId.js";
|
|
8
10
|
import { validateScriptId } from "../adapters/plausible/scriptId.js";
|
|
11
|
+
import { validateSiteDomain, validateSiteDomains } from "../adapters/plausible/siteId.js";
|
|
9
12
|
import { validatePersonalApiKey, validateProjectToken } from "../adapters/posthog/credentials.js";
|
|
10
13
|
import { validateCurrency } from "../goals/currency.js";
|
|
11
14
|
import { overrideField } from "../plugin/collectionFields.js";
|
|
12
15
|
import { docScope } from "../plugin/scopeChange.js";
|
|
13
|
-
import { validatePosthogHost, validateProviderHost } from "./hosts.js";
|
|
14
|
-
import {
|
|
15
|
-
import { retargetSecrets } from "./retarget.js";
|
|
16
|
+
import { validatePosthogHost, validatePosthogRegion, validateProviderHost } from "./hosts.js";
|
|
17
|
+
import { versionOf } from "./probe.js";
|
|
18
|
+
import { reconnects, retargetSecrets } from "./retarget.js";
|
|
16
19
|
import { takenInScope } from "./scopeUnique.js";
|
|
17
20
|
import { stampScope } from "./stampScope.js";
|
|
18
21
|
import { ValidationError, validations } from "payload";
|
|
@@ -20,6 +23,8 @@ import { ValidationError, validations } from "payload";
|
|
|
20
23
|
const PROVIDERS_SLUG = "analytics-providers";
|
|
21
24
|
/** The list's note to a tenant reading the platform's source in `fallback`. */
|
|
22
25
|
const PROVIDERS_LIST_NOTICE_COMPONENT = "@10x-media/analytics/client#ProvidersListNotice";
|
|
26
|
+
const PROVIDER_CONNECTION_COMPONENT = "@10x-media/analytics/client#ProviderConnection";
|
|
27
|
+
const PROVIDER_CONNECTION_TEST_COMPONENT = "@10x-media/analytics/client#ProviderConnectionTest";
|
|
23
28
|
/** `connectionAccess` in its object form, checked at boot; undefined while unset. */
|
|
24
29
|
const connectionFieldAccess = (path, option) => {
|
|
25
30
|
if (option === void 0) return;
|
|
@@ -55,25 +60,38 @@ const servedProviderTypes = (path, option, available = PROVIDER_IDS) => {
|
|
|
55
60
|
if (served.length === 0) throw new Error(`analytics: ${path} leaves no provider type this install serves, which are ${listOf(available.map((id) => `"${id}"`))}; "native" needs native() in adapters`);
|
|
56
61
|
return served;
|
|
57
62
|
};
|
|
63
|
+
/**
|
|
64
|
+
* The ids of the documents whose update changes how they connect, kept on `req.context` for their
|
|
65
|
+
* afterChange: a bulk update hands every document the same context.
|
|
66
|
+
*/
|
|
67
|
+
const RECONNECTED_KEY = "__analyticsReconnected";
|
|
68
|
+
const reconnectedOf = (context) => {
|
|
69
|
+
const existing = context[RECONNECTED_KEY];
|
|
70
|
+
if (existing instanceof Set) return existing;
|
|
71
|
+
const created = /* @__PURE__ */ new Set();
|
|
72
|
+
context[RECONNECTED_KEY] = created;
|
|
73
|
+
return created;
|
|
74
|
+
};
|
|
58
75
|
const plainSecret = (source) => [source];
|
|
59
76
|
const textField = (name, label, opts = {}) => ({
|
|
60
77
|
name,
|
|
61
78
|
type: "text",
|
|
62
79
|
label: labelForKey(label),
|
|
63
80
|
...opts.access ? { access: opts.access } : {},
|
|
81
|
+
...opts.validate ? { validate: opts.validate } : {},
|
|
64
82
|
...opts.width || opts.help ? { admin: {
|
|
65
83
|
...opts.width ? { width: opts.width } : {},
|
|
66
84
|
...opts.help ? { description: labelForKey(opts.help) } : {}
|
|
67
85
|
} } : {}
|
|
68
86
|
});
|
|
69
87
|
/**
|
|
70
|
-
* A sealed credential. Its help
|
|
71
|
-
* the client field, which the write-only editor renders.
|
|
88
|
+
* A sealed credential. Its label and help are a string per locale: Payload drops a function label
|
|
89
|
+
* and description from the client field, which the write-only editor renders.
|
|
72
90
|
*/
|
|
73
91
|
const secretField = (buildSecret, staticLabel, opts) => buildSecret({
|
|
74
92
|
name: opts.name,
|
|
75
93
|
type: "text",
|
|
76
|
-
label:
|
|
94
|
+
label: staticLabel(opts.label),
|
|
77
95
|
...opts.validate ? { validate: opts.validate } : {},
|
|
78
96
|
admin: {
|
|
79
97
|
description: staticLabel(opts.help),
|
|
@@ -109,7 +127,7 @@ const hostField = (allowPrivateNetwork, access, opts = {}) => ({
|
|
|
109
127
|
name: "host",
|
|
110
128
|
type: "text",
|
|
111
129
|
label: labelForKey(keys.providerFieldHost),
|
|
112
|
-
validate: opts.validate ?? validateProviderHost(allowPrivateNetwork),
|
|
130
|
+
validate: opts.validate ?? validateProviderHost(allowPrivateNetwork, opts.listed),
|
|
113
131
|
...access ? { access } : {},
|
|
114
132
|
admin: { description: labelForKey(keys.providerFieldHostHelp) }
|
|
115
133
|
});
|
|
@@ -147,13 +165,6 @@ const nameField = () => ({
|
|
|
147
165
|
label: labelForKey(keys.providerFieldName),
|
|
148
166
|
admin: { description: labelForKey(keys.providerFieldNameHelp) }
|
|
149
167
|
});
|
|
150
|
-
const PROVIDER_NAMES = {
|
|
151
|
-
native: keys.providerNameNative,
|
|
152
|
-
plausible: keys.providerNamePlausible,
|
|
153
|
-
umami: keys.providerNameUmami,
|
|
154
|
-
ga4: keys.providerNameGa4,
|
|
155
|
-
posthog: keys.providerNamePosthog
|
|
156
|
-
};
|
|
157
168
|
/**
|
|
158
169
|
* Names the refusal of a stored type the install no longer serves (native() removed, `types`
|
|
159
170
|
* narrowed), which the select's own check would only call an invalid selection.
|
|
@@ -252,8 +263,9 @@ const checkSingleDefault = (args) => {
|
|
|
252
263
|
label: labelForKey(keys.providerFieldIsDefault),
|
|
253
264
|
message: asTranslate(req.t)(keys.providerErrorDefaultTaken),
|
|
254
265
|
path: "isDefault"
|
|
255
|
-
}]
|
|
256
|
-
|
|
266
|
+
}],
|
|
267
|
+
req
|
|
268
|
+
}, req.t);
|
|
257
269
|
return data;
|
|
258
270
|
};
|
|
259
271
|
};
|
|
@@ -266,10 +278,15 @@ const providerFields = (options, staticLabel, list) => {
|
|
|
266
278
|
const buildSecret = options.buildSecret ?? plainSecret;
|
|
267
279
|
const access = connectionFieldAccess("analyticsProviderFields({ connectionAccess })", options.connectionAccess);
|
|
268
280
|
const allowPrivateNetwork = options.allowPrivateNetwork === true;
|
|
269
|
-
const
|
|
281
|
+
const { allow } = list;
|
|
282
|
+
const listedFor = (provider) => allow ? {
|
|
283
|
+
provider,
|
|
284
|
+
allow
|
|
285
|
+
} : void 0;
|
|
286
|
+
const apiKeyField = ({ validate, help = keys.providerFieldApiKeyHelp } = {}) => secretField(buildSecret, staticLabel, {
|
|
270
287
|
name: "apiKey",
|
|
271
288
|
label: keys.providerFieldApiKey,
|
|
272
|
-
help
|
|
289
|
+
help,
|
|
273
290
|
width: "50%",
|
|
274
291
|
...validate ? { validate } : {}
|
|
275
292
|
});
|
|
@@ -286,14 +303,16 @@ const providerFields = (options, staticLabel, list) => {
|
|
|
286
303
|
fields: [textField("siteId", keys.providerFieldSiteId, {
|
|
287
304
|
width: "50%",
|
|
288
305
|
help: keys.providerFieldSiteIdHelp,
|
|
289
|
-
access
|
|
306
|
+
access,
|
|
307
|
+
validate: validateSiteDomain
|
|
290
308
|
}), ...apiKeyField()]
|
|
291
309
|
},
|
|
292
310
|
{
|
|
293
311
|
type: "row",
|
|
294
312
|
fields: [captureField("domain", keys.providerFieldDomain, {
|
|
295
313
|
width: "50%",
|
|
296
|
-
help: keys.providerFieldDomainHelp
|
|
314
|
+
help: keys.providerFieldDomainHelp,
|
|
315
|
+
validate: validateSiteDomains
|
|
297
316
|
}), captureField("scriptId", keys.providerFieldScriptId, {
|
|
298
317
|
width: "50%",
|
|
299
318
|
help: keys.providerFieldScriptIdHelp,
|
|
@@ -301,7 +320,7 @@ const providerFields = (options, staticLabel, list) => {
|
|
|
301
320
|
})]
|
|
302
321
|
},
|
|
303
322
|
currencyField("revenueCurrency", keys.providerFieldRevenueCurrencyHelp),
|
|
304
|
-
hostField(allowPrivateNetwork, access)
|
|
323
|
+
hostField(allowPrivateNetwork, access, { listed: listedFor("plausible") })
|
|
305
324
|
]),
|
|
306
325
|
providerGroup("umami", keys.providerNameUmami, [
|
|
307
326
|
{
|
|
@@ -310,14 +329,14 @@ const providerFields = (options, staticLabel, list) => {
|
|
|
310
329
|
width: "50%",
|
|
311
330
|
help: keys.providerFieldWebsiteIdHelp,
|
|
312
331
|
access
|
|
313
|
-
}), ...apiKeyField()]
|
|
332
|
+
}), ...apiKeyField({ help: keys.providerFieldUmamiApiKeyHelp })]
|
|
314
333
|
},
|
|
315
334
|
...secretField(buildSecret, staticLabel, {
|
|
316
335
|
name: "token",
|
|
317
336
|
label: keys.providerFieldToken,
|
|
318
337
|
help: keys.providerFieldTokenHelp
|
|
319
338
|
}),
|
|
320
|
-
hostField(allowPrivateNetwork, access)
|
|
339
|
+
hostField(allowPrivateNetwork, access, { listed: listedFor("umami") })
|
|
321
340
|
]),
|
|
322
341
|
providerGroup("ga4", keys.providerNameGa4, [
|
|
323
342
|
{
|
|
@@ -325,7 +344,8 @@ const providerFields = (options, staticLabel, list) => {
|
|
|
325
344
|
fields: [textField("propertyId", keys.providerFieldPropertyId, {
|
|
326
345
|
width: "50%",
|
|
327
346
|
help: keys.providerFieldPropertyIdHelp,
|
|
328
|
-
access
|
|
347
|
+
access,
|
|
348
|
+
validate: validatePropertyId
|
|
329
349
|
}), textField("projectId", keys.providerFieldProjectId, {
|
|
330
350
|
width: "50%",
|
|
331
351
|
help: keys.providerFieldProjectIdHelp,
|
|
@@ -336,12 +356,15 @@ const providerFields = (options, staticLabel, list) => {
|
|
|
336
356
|
help: keys.providerFieldClientEmailHelp,
|
|
337
357
|
access
|
|
338
358
|
}),
|
|
339
|
-
captureField("measurementId", keys.providerFieldMeasurementId, {
|
|
359
|
+
captureField("measurementId", keys.providerFieldMeasurementId, {
|
|
360
|
+
help: keys.providerFieldMeasurementIdHelp,
|
|
361
|
+
validate: validateMeasurementId
|
|
362
|
+
}),
|
|
340
363
|
currencyField("currency", keys.providerFieldGa4CurrencyHelp),
|
|
341
364
|
...buildSecret({
|
|
342
365
|
name: "privateKey",
|
|
343
366
|
type: "textarea",
|
|
344
|
-
label:
|
|
367
|
+
label: staticLabel(keys.providerFieldPrivateKey),
|
|
345
368
|
admin: { description: staticLabel(keys.providerFieldPrivateKeyHelp) }
|
|
346
369
|
})
|
|
347
370
|
]),
|
|
@@ -350,9 +373,12 @@ const providerFields = (options, staticLabel, list) => {
|
|
|
350
373
|
type: "row",
|
|
351
374
|
fields: [textField("projectId", keys.providerFieldProjectId, {
|
|
352
375
|
width: "50%",
|
|
353
|
-
help: keys.
|
|
376
|
+
help: keys.providerFieldPosthogProjectIdHelp,
|
|
354
377
|
access
|
|
355
|
-
}), ...apiKeyField(
|
|
378
|
+
}), ...apiKeyField({
|
|
379
|
+
validate: validatePersonalApiKey,
|
|
380
|
+
help: keys.providerFieldPosthogApiKeyHelp
|
|
381
|
+
})]
|
|
356
382
|
},
|
|
357
383
|
{
|
|
358
384
|
type: "row",
|
|
@@ -363,6 +389,7 @@ const providerFields = (options, staticLabel, list) => {
|
|
|
363
389
|
name: "region",
|
|
364
390
|
type: "select",
|
|
365
391
|
label: labelForKey(keys.providerFieldRegion),
|
|
392
|
+
validate: validatePosthogRegion,
|
|
366
393
|
options: [{
|
|
367
394
|
label: "US",
|
|
368
395
|
value: "us"
|
|
@@ -381,11 +408,21 @@ const providerFields = (options, staticLabel, list) => {
|
|
|
381
408
|
help: keys.providerFieldScopePropertyHelp,
|
|
382
409
|
access
|
|
383
410
|
}),
|
|
384
|
-
hostField(allowPrivateNetwork, access, { validate: validatePosthogHost(allowPrivateNetwork) })
|
|
411
|
+
hostField(allowPrivateNetwork, access, { validate: validatePosthogHost(allowPrivateNetwork, listedFor("posthog")) })
|
|
385
412
|
]),
|
|
386
413
|
overrideField(withoutConsentField(staticLabel), options.fields?.withoutConsent)
|
|
387
414
|
];
|
|
388
415
|
};
|
|
416
|
+
/** The sidebar's Connection panel of a vendor document; its Test connection button sits beside Save. */
|
|
417
|
+
const connectionField = {
|
|
418
|
+
name: "connection",
|
|
419
|
+
type: "ui",
|
|
420
|
+
admin: {
|
|
421
|
+
position: "sidebar",
|
|
422
|
+
components: { Field: PROVIDER_CONNECTION_COMPONENT },
|
|
423
|
+
condition: (data) => isOneOf(PROVIDER_IDS, data?.provider) && data?.provider !== "native"
|
|
424
|
+
}
|
|
425
|
+
};
|
|
389
426
|
/**
|
|
390
427
|
* Runtime provider-settings collection, one document per provider (and scope). Admin-only by
|
|
391
428
|
* default; `access` overrides single operations, `overrides` reshapes the whole config last.
|
|
@@ -408,7 +445,10 @@ const buildProvidersCollection = (args) => {
|
|
|
408
445
|
],
|
|
409
446
|
group: staticLabel(keys.adminGroup),
|
|
410
447
|
description: staticLabel(keys.providersCollectionDescription),
|
|
411
|
-
|
|
448
|
+
components: {
|
|
449
|
+
...args.listNotice ? { beforeList: [PROVIDERS_LIST_NOTICE_COMPONENT] } : {},
|
|
450
|
+
edit: { beforeDocumentControls: [PROVIDER_CONNECTION_TEST_COMPONENT] }
|
|
451
|
+
}
|
|
412
452
|
},
|
|
413
453
|
access: {
|
|
414
454
|
read: providerRowAccess(args),
|
|
@@ -419,23 +459,41 @@ const buildProvidersCollection = (args) => {
|
|
|
419
459
|
},
|
|
420
460
|
hooks: {
|
|
421
461
|
...args.scoped ? { beforeValidate: [checkSingleDefault(args)] } : {},
|
|
422
|
-
beforeChange: [
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
462
|
+
beforeChange: [
|
|
463
|
+
stampScope(args),
|
|
464
|
+
({ context, data, operation, originalDoc }) => {
|
|
465
|
+
if (operation === "update" && reconnects({
|
|
466
|
+
scopeField: args.scopeField,
|
|
467
|
+
isSealed: args.isSealed,
|
|
468
|
+
data,
|
|
469
|
+
originalDoc
|
|
470
|
+
})) reconnectedOf(context).add(String(originalDoc?.id));
|
|
471
|
+
return data;
|
|
472
|
+
},
|
|
473
|
+
retargetSecrets({
|
|
474
|
+
scopeField: args.scopeField,
|
|
475
|
+
isSealed: args.isSealed
|
|
476
|
+
})
|
|
477
|
+
],
|
|
478
|
+
afterChange: [async ({ context, doc, operation, previousDoc, req }) => {
|
|
479
|
+
if (operation === "update" && reconnectedOf(context).delete(String(doc.id))) await args.forgetStatus?.(String(doc.id), req);
|
|
480
|
+
else if (operation === "update") await args.carryStatus?.(String(doc.id), {
|
|
481
|
+
from: versionOf(previousDoc.updatedAt),
|
|
482
|
+
to: versionOf(doc.updatedAt)
|
|
483
|
+
}, req);
|
|
427
484
|
await args.onChange({
|
|
428
485
|
scope: docScope(doc, args.scopeField),
|
|
429
486
|
...operation === "update" ? { previousScope: docScope(previousDoc, args.scopeField) } : {}
|
|
430
487
|
}, req);
|
|
431
488
|
return doc;
|
|
432
489
|
}],
|
|
433
|
-
afterDelete: [async ({ doc, req }) => {
|
|
490
|
+
afterDelete: [async ({ doc, id, req }) => {
|
|
491
|
+
await args.forgetStatus?.(String(id), req);
|
|
434
492
|
await args.onChange({ scope: docScope(doc, args.scopeField) }, req);
|
|
435
493
|
return doc;
|
|
436
494
|
}]
|
|
437
495
|
},
|
|
438
|
-
fields: providerFields({
|
|
496
|
+
fields: [...providerFields({
|
|
439
497
|
buildSecret: args.buildSecret,
|
|
440
498
|
...args.fields ? { fields: args.fields } : {},
|
|
441
499
|
scopeField: args.scopeField === "scope",
|
|
@@ -443,8 +501,9 @@ const buildProvidersCollection = (args) => {
|
|
|
443
501
|
...args.connectionAccess ? { connectionAccess: args.connectionAccess } : {}
|
|
444
502
|
}, staticLabel, {
|
|
445
503
|
types: args.types ?? PROVIDER_IDS,
|
|
504
|
+
...args.allow ? { allow: args.allow } : {},
|
|
446
505
|
...args.scoped ? { isDefault: overrideField(isDefaultField(args.defaultAccess), args.fields?.isDefault) } : {}
|
|
447
|
-
})
|
|
506
|
+
}), connectionField]
|
|
448
507
|
};
|
|
449
508
|
return args.overrides ? args.overrides(collection) : collection;
|
|
450
509
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"collection.js","names":[],"sources":["../../src/providers/collection.ts"],"sourcesContent":["import {\n\ttype CollectionBeforeValidateHook,\n\ttype CollectionConfig,\n\ttype Field,\n\ttype FieldAccess,\n\ttype PayloadRequest,\n\ttype SelectField,\n\ttype SelectFieldSingleValidation,\n\ttype TextareaField,\n\ttype TextField,\n\ttype TextFieldSingleValidation,\n\tValidationError,\n\tvalidations,\n} from 'payload'\nimport { validateMeasurementId } from '../adapters/ga4/measurementId'\nimport { validateScriptId } from '../adapters/plausible/scriptId'\nimport { validatePersonalApiKey, validateProjectToken } from '../adapters/posthog/credentials'\nimport { optionsObject } from '../core/optionChecks'\nimport { isOneOf, kindOf, listOf } from '../core/values'\nimport { validateCurrency } from '../goals/currency'\nimport { type CollectionFieldOverride, overrideField } from '../plugin/collectionFields'\nimport { docScope, type ScopeChange } from '../plugin/scopeChange'\nimport { keys, type SingularKey, type TranslationKey } from '../translations/keys'\nimport { asTranslate, labelForKey } from '../translations/server'\nimport { builtInStaticLabel, type StaticLabelFor } from '../translations/staticLabel'\nimport { type ProviderAccessArgs, providerCreateAccess, providerRowAccess } from './access'\nimport { PROVIDER_IDS, type ProviderId } from './factory'\nimport { validatePosthogHost, validateProviderHost } from './hosts'\nimport { retargetSecrets } from './retarget'\nimport { takenInScope } from './scopeUnique'\nimport { stampScope } from './stampScope'\n\nexport const PROVIDERS_SLUG = 'analytics-providers'\n\n/** The list's note to a tenant reading the platform's source in `fallback`. */\nexport const PROVIDERS_LIST_NOTICE_COMPONENT = '@10x-media/analytics/client#ProvidersListNotice'\n\n/** Builds the sealed variant of a secret source field; injected so the fields peer stays lazy. */\nexport type BuildSecretField = (source: TextField | TextareaField) => Field[]\n\n/**\n * Replaces a default field; it receives the plugin's own field to spread and may return any field\n * type (a `row`, a `collapsible`) that still holds a field of that name.\n */\nexport type ProviderFieldOverride = CollectionFieldOverride\n\nexport interface ProviderCollectionFieldOverrides {\n\tname?: ProviderFieldOverride\n\tprovider?: ProviderFieldOverride\n\tenabled?: ProviderFieldOverride\n\t/** The \"Default for this site\" checkbox, which only a scoped install's collection carries. */\n\tisDefault?: ProviderFieldOverride\n\t/** What a vendor source does without consent; empty follows `capture.withoutConsent`. */\n\twithoutConsent?: ProviderFieldOverride\n}\n\n/** Field access on the fields that decide where a provider document connects (`CONNECTION_PATHS`). */\nexport interface ConnectionFieldAccess {\n\tcreate?: FieldAccess\n\tupdate?: FieldAccess\n}\n\n/** One field access function for create and update alike, or `{ create, update }`. */\nexport type ConnectionAccess = FieldAccess | ConnectionFieldAccess\n\n/** `connectionAccess` in its object form, checked at boot; undefined while unset. */\nexport const connectionFieldAccess = (\n\tpath: string,\n\toption: ConnectionAccess | undefined\n): ConnectionFieldAccess | undefined => {\n\tif (option === undefined) {\n\t\treturn undefined\n\t}\n\tif (typeof option === 'function') {\n\t\treturn { create: option, update: option }\n\t}\n\tconst halves = optionsObject(option, {\n\t\tpath,\n\t\tknown: ['create', 'update'],\n\t\texample: 'a function, or { create, update } with a function in each',\n\t})\n\tfor (const [half, access] of Object.entries(halves)) {\n\t\tif (access !== undefined && typeof access !== 'function') {\n\t\t\tthrow new Error(\n\t\t\t\t`analytics: ${path}.${half} must be a field access function, got ${kindOf(access)}`\n\t\t\t)\n\t\t}\n\t}\n\tconst { create, update } = option\n\treturn { ...(create ? { create } : {}), ...(update ? { update } : {}) }\n}\n\n/**\n * The provider types documents may be saved with: every type `available` serves, narrowed to\n * `option` in its order when given, checked at boot.\n */\nexport const servedProviderTypes = (\n\tpath: string,\n\toption: unknown,\n\tavailable: readonly ProviderId[] = PROVIDER_IDS\n): ProviderId[] => {\n\tif (option === undefined) {\n\t\treturn [...available]\n\t}\n\tif (!Array.isArray(option)) {\n\t\tthrow new Error(\n\t\t\t`analytics: ${path} must be a list of provider types such as ['plausible', 'umami'], got ${kindOf(option)}`\n\t\t)\n\t}\n\tconst listed: ProviderId[] = []\n\tfor (const type of option) {\n\t\tif (!isOneOf(PROVIDER_IDS, type)) {\n\t\t\tthrow new Error(\n\t\t\t\t`analytics: ${path} lists ${kindOf(type)}, which is no provider type; use ${listOf(PROVIDER_IDS.map((id) => `\"${id}\"`))}`\n\t\t\t)\n\t\t}\n\t\tlisted.push(type)\n\t}\n\tconst served = [...new Set(listed)].filter((type) => available.includes(type))\n\tif (served.length === 0) {\n\t\tthrow new Error(\n\t\t\t`analytics: ${path} leaves no provider type this install serves, which are ${listOf(available.map((id) => `\"${id}\"`))}; \"native\" needs native() in adapters`\n\t\t)\n\t}\n\treturn served\n}\n\nexport interface BuildProvidersCollectionArgs extends ProviderAccessArgs {\n\tslug: string\n\taccess?: Partial<CollectionConfig['access']>\n\t/** Per-field overrides, applied before the whole-collection `overrides`. */\n\tfields?: ProviderCollectionFieldOverrides\n\toverrides?: (collection: CollectionConfig) => CollectionConfig\n\t/**\n\t * Called after any change or delete with the scopes the write touched and the request that\n\t * wrote, so that request's own Payload instance reads those scopes again once the write commits.\n\t */\n\tonChange: (change: ScopeChange, req: PayloadRequest) => void | Promise<void>\n\tbuildSecret: BuildSecretField\n\t/** The fields plugin's test for a sealed value, which tells a resent secret from a kept one. */\n\tisSealed: (value: unknown) => boolean\n\t/** `providers.hosts.allowPrivateNetwork`: the `host` fields accept `http://` too. */\n\tallowPrivateNetwork?: boolean\n\tconnectionAccess?: ConnectionFieldAccess\n\t/** The provider types a document may be saved with; every type when absent. */\n\ttypes?: readonly ProviderId[]\n\t/** Field access on `isDefault`, which a scoped install's collection carries. */\n\tdefaultAccess?: ConnectionFieldAccess\n\t/** The install's static labels; the built-in strings alone when absent. */\n\tstaticLabel?: StaticLabelFor\n\t/** Mount the list's note on the platform fallback, for an install with a `fallback` policy. */\n\tlistNotice?: boolean\n}\n\nconst plainSecret: BuildSecretField = (source) => [source]\n\nconst textField = (\n\tname: string,\n\tlabel: TranslationKey,\n\topts: { width?: string; help?: TranslationKey; access?: ConnectionFieldAccess } = {}\n): Field => ({\n\tname,\n\ttype: 'text',\n\tlabel: labelForKey(label),\n\t...(opts.access ? { access: opts.access } : {}),\n\t...(opts.width || opts.help\n\t\t? {\n\t\t\t\tadmin: {\n\t\t\t\t\t...(opts.width ? { width: opts.width } : {}),\n\t\t\t\t\t...(opts.help ? { description: labelForKey(opts.help) } : {}),\n\t\t\t\t},\n\t\t\t}\n\t\t: {}),\n})\n\n/**\n * A sealed credential. Its help is a string per locale: Payload drops a function description from\n * the client field, which the write-only editor renders.\n */\nconst secretField = (\n\tbuildSecret: BuildSecretField,\n\tstaticLabel: StaticLabelFor,\n\topts: {\n\t\tname: string\n\t\tlabel: TranslationKey\n\t\thelp: SingularKey\n\t\twidth?: string\n\t\tvalidate?: TextFieldSingleValidation\n\t}\n): Field[] =>\n\tbuildSecret({\n\t\tname: opts.name,\n\t\ttype: 'text',\n\t\tlabel: labelForKey(opts.label),\n\t\t...(opts.validate ? { validate: opts.validate } : {}),\n\t\tadmin: {\n\t\t\tdescription: staticLabel(opts.help),\n\t\t\t...(opts.width ? { width: opts.width } : {}),\n\t\t},\n\t})\n\n/**\n * Public capture config, plain text because the tracker config serves it to the browser. An adapter\n * declares `capture` only once its public field is filled.\n */\nconst captureField = (\n\tname: string,\n\tlabel: TranslationKey,\n\topts: { width?: string; validate?: TextFieldSingleValidation; help?: TranslationKey } = {}\n): Field => ({\n\tname,\n\ttype: 'text',\n\tlabel: labelForKey(label),\n\t...(opts.validate ? { validate: opts.validate } : {}),\n\tadmin: {\n\t\tdescription: labelForKey(opts.help ?? keys.providerFieldCaptureHelp),\n\t\t...(opts.width ? { width: opts.width } : {}),\n\t},\n})\n\n/**\n * Only when `scopeField` names the plugin's own field: a host-owned scope field is the host's to\n * register, and shadowing it would store the scope twice.\n */\nconst scopeField = (include: boolean): Field[] =>\n\tinclude\n\t\t? [\n\t\t\t\t{\n\t\t\t\t\t// Written by scoped setups; hidden because single-site installs never touch it.\n\t\t\t\t\tname: 'scope',\n\t\t\t\t\ttype: 'text',\n\t\t\t\t\tindex: true,\n\t\t\t\t\tlabel: labelForKey(keys.providerFieldScope),\n\t\t\t\t\tadmin: { hidden: true },\n\t\t\t\t},\n\t\t\t]\n\t\t: []\n\nconst hostField = (\n\tallowPrivateNetwork: boolean,\n\taccess: ConnectionFieldAccess | undefined,\n\topts: { validate?: TextFieldSingleValidation } = {}\n): Field => ({\n\tname: 'host',\n\ttype: 'text',\n\tlabel: labelForKey(keys.providerFieldHost),\n\tvalidate: opts.validate ?? validateProviderHost(allowPrivateNetwork),\n\t...(access ? { access } : {}),\n\tadmin: { description: labelForKey(keys.providerFieldHostHelp) },\n})\n\nconst currencyField = (name: string, help: TranslationKey): Field => ({\n\tname,\n\ttype: 'text',\n\tlabel: labelForKey(keys.providerFieldRevenueCurrency),\n\tvalidate: validateCurrency,\n\tadmin: { description: labelForKey(help) },\n})\n\nconst providerGroup = (provider: ProviderId, label: TranslationKey, fields: Field[]): Field => ({\n\tname: provider,\n\ttype: 'group',\n\tlabel: labelForKey(label),\n\tadmin: { condition: (data) => data?.provider === provider },\n\tfields,\n})\n\n/**\n * The native choice configures nothing, so it gets a note in place of a settings group:\n * an unnamed group stores no data and reads as the section its siblings occupy.\n */\nconst nativeNote = (): Field => ({\n\ttype: 'group',\n\tlabel: labelForKey(keys.providerNameNative),\n\tadmin: {\n\t\tcondition: (data) => data?.provider === 'native',\n\t\tdescription: labelForKey(keys.providerNameNativeHelp),\n\t},\n\tfields: [],\n})\n\nconst nameField = (): Field => ({\n\tname: 'name',\n\ttype: 'text',\n\trequired: true,\n\tlabel: labelForKey(keys.providerFieldName),\n\tadmin: { description: labelForKey(keys.providerFieldNameHelp) },\n})\n\nconst PROVIDER_NAMES: Record<ProviderId, TranslationKey> = {\n\tnative: keys.providerNameNative,\n\tplausible: keys.providerNamePlausible,\n\tumami: keys.providerNameUmami,\n\tga4: keys.providerNameGa4,\n\tposthog: keys.providerNamePosthog,\n}\n\n/**\n * Names the refusal of a stored type the install no longer serves (native() removed, `types`\n * narrowed), which the select's own check would only call an invalid selection.\n */\nconst validateServed =\n\t(types: readonly string[]): SelectFieldSingleValidation =>\n\t(value, options) =>\n\t\ttypeof value === 'string' && value !== '' && !types.includes(value)\n\t\t\t? asTranslate(options.req.t)(keys.providerErrorTypeUnserved)\n\t\t\t: validations.select(value, options)\n\n/**\n * The values a narrowed select offers: the served types, and a stored type no longer served so its\n * save is refused by name. Values only, since form state carries the result to the client, where\n * a label function cannot cross; Payload's select reads nothing else from it.\n */\nconst offeredTypes = (types: readonly ProviderId[], stored: unknown): ProviderId[] =>\n\tisOneOf(PROVIDER_IDS, stored) && !types.includes(stored) ? [...types, stored] : [...types]\n\n/**\n * Sits in the sidebar with `enabled`: every body field is conditional on the provider and\n * meaningless while `enabled` is off. The schema keeps every type (options, groups, a static\n * default while `native` leads), so narrowing the offer neither alters a column nor drops settings.\n */\nconst providerField = (\n\taccess: ConnectionFieldAccess | undefined,\n\tstaticLabel: StaticLabelFor,\n\ttypes: readonly ProviderId[]\n): SelectField => {\n\tconst [first = 'native'] = types\n\tconst narrowed = types.length < PROVIDER_IDS.length\n\treturn {\n\t\tname: 'provider',\n\t\ttype: 'select',\n\t\trequired: true,\n\t\tlabel: labelForKey(keys.providerFieldProvider),\n\t\tdefaultValue: first === 'native' ? first : () => first,\n\t\t...(access ? { access } : {}),\n\t\t...(narrowed\n\t\t\t? {\n\t\t\t\t\tvalidate: validateServed(types),\n\t\t\t\t\tfilterOptions: ({ data }) => offeredTypes(types, data?.provider),\n\t\t\t\t}\n\t\t\t: {}),\n\t\toptions: PROVIDER_IDS.map((type) => ({\n\t\t\tlabel: labelForKey(PROVIDER_NAMES[type]),\n\t\t\tvalue: type,\n\t\t})),\n\t\t// `admin.description` on a select is read where a label function never runs.\n\t\tadmin: { position: 'sidebar', description: staticLabel(keys.providerFieldProviderHelp) },\n\t}\n}\n\n/**\n * A vendor document's own `withoutConsent`. Unset follows `capture.withoutConsent`; no option\n * stands for that, since an empty string is no portable enum value.\n */\nconst withoutConsentField = (staticLabel: StaticLabelFor): SelectField => ({\n\tname: 'withoutConsent',\n\ttype: 'select',\n\tlabel: labelForKey(keys.providerFieldWithoutConsent),\n\toptions: [\n\t\t{ label: staticLabel(keys.providerWithoutConsentCookieless), value: 'cookieless' },\n\t\t{ label: staticLabel(keys.providerWithoutConsentOff), value: 'off' },\n\t],\n\tadmin: {\n\t\tcondition: (data) => isOneOf(PROVIDER_IDS, data?.provider) && data?.provider !== 'native',\n\t\tdescription: staticLabel(keys.providerFieldWithoutConsentHelp),\n\t},\n})\n\nconst enabledField = (): Field => ({\n\tname: 'enabled',\n\ttype: 'checkbox',\n\tdefaultValue: true,\n\tlabel: labelForKey(keys.providerFieldEnabled),\n\tadmin: { position: 'sidebar', description: labelForKey(keys.providerFieldEnabledHelp) },\n})\n\nconst isDefaultField = (access: ConnectionFieldAccess | undefined): Field => ({\n\tname: 'isDefault',\n\ttype: 'checkbox',\n\tdefaultValue: false,\n\tlabel: labelForKey(keys.providerFieldIsDefault),\n\t...(access ? { access } : {}),\n\tadmin: { position: 'sidebar', description: labelForKey(keys.providerFieldIsDefaultHelp) },\n})\n\n/**\n * At most one document per scope is the default, checked at collection level so a replaced\n * `isDefault` field keeps it. No index backs it: a unique one would also cover the unflagged rows.\n */\nconst checkSingleDefault = (args: BuildProvidersCollectionArgs): CollectionBeforeValidateHook => {\n\treturn async ({ data, originalDoc, req }) => {\n\t\tif ((data?.isDefault ?? originalDoc?.isDefault) !== true) {\n\t\t\treturn data\n\t\t}\n\t\tif (await takenInScope(args, { data, originalDoc, req }, { isDefault: { equals: true } })) {\n\t\t\tthrow new ValidationError({\n\t\t\t\tcollection: args.slug,\n\t\t\t\terrors: [\n\t\t\t\t\t{\n\t\t\t\t\t\tlabel: labelForKey(keys.providerFieldIsDefault),\n\t\t\t\t\t\tmessage: asTranslate(req.t)(keys.providerErrorDefaultTaken),\n\t\t\t\t\t\tpath: 'isDefault',\n\t\t\t\t\t},\n\t\t\t\t],\n\t\t\t})\n\t\t}\n\t\treturn data\n\t}\n}\n\nexport interface ProviderFieldsOptions {\n\t/**\n\t * Seals each credential field, normally `encryptedField` from `@10x-media/fields` in write-only\n\t * mode. Left out, credentials are plain text and securing them is the host's job.\n\t */\n\tbuildSecret?: BuildSecretField\n\t/** Replaces one of the default fields, applied per field. */\n\tfields?: Omit<ProviderCollectionFieldOverrides, 'isDefault'>\n\t/** Adds the plugin's own hidden `scope` text field. Off by default. */\n\tscopeField?: boolean\n\t/**\n\t * Accepts `http://` in a `host` field, for a vendor on a private network. Set it together with\n\t * `providers.hosts.allowPrivateNetwork`, which lets the plugin connect there. Off, https only.\n\t */\n\tallowPrivateNetwork?: boolean\n\t/**\n\t * Field access on every `CONNECTION_PATHS` field except the scope field. One function for create\n\t * and update alike, or `{ create, update }`.\n\t */\n\tconnectionAccess?: ConnectionAccess\n\t/**\n\t * The provider types the select offers, the first being its default; a document saved with any\n\t * other type is refused. Default: every type, `native` first.\n\t */\n\ttypes?: ProviderId[]\n}\n\n/** What the field list takes beyond the public options. */\ninterface FieldListArgs {\n\ttypes: readonly ProviderId[]\n\t/** The `isDefault` checkbox, overridden, placed after `enabled`; only a scoped collection has it. */\n\tisDefault?: Field\n}\n\n/**\n * Provider-settings fields alone, for a host that stores them elsewhere and feeds them back through\n * `providers.resolve`; {@link adapterFromProviderDoc} reads the result as is.\n */\nexport const analyticsProviderFields = (options: ProviderFieldsOptions = {}): Field[] =>\n\tproviderFields(options, builtInStaticLabel, {\n\t\ttypes: servedProviderTypes('analyticsProviderFields({ types })', options.types),\n\t})\n\nconst providerFields = (\n\toptions: ProviderFieldsOptions,\n\tstaticLabel: StaticLabelFor,\n\tlist: FieldListArgs\n): Field[] => {\n\tconst buildSecret = options.buildSecret ?? plainSecret\n\tconst access = connectionFieldAccess(\n\t\t'analyticsProviderFields({ connectionAccess })',\n\t\toptions.connectionAccess\n\t)\n\tconst allowPrivateNetwork = options.allowPrivateNetwork === true\n\tconst apiKeyField = (validate?: TextFieldSingleValidation): Field[] =>\n\t\tsecretField(buildSecret, staticLabel, {\n\t\t\tname: 'apiKey',\n\t\t\tlabel: keys.providerFieldApiKey,\n\t\t\thelp: keys.providerFieldApiKeyHelp,\n\t\t\twidth: '50%',\n\t\t\t...(validate ? { validate } : {}),\n\t\t})\n\treturn [\n\t\toverrideField(nameField(), options.fields?.name),\n\t\toverrideField(providerField(access, staticLabel, list.types), options.fields?.provider),\n\t\toverrideField(enabledField(), options.fields?.enabled),\n\t\t...(list.isDefault ? [list.isDefault] : []),\n\t\t...scopeField(options.scopeField === true),\n\t\tnativeNote(),\n\t\tproviderGroup('plausible', keys.providerNamePlausible, [\n\t\t\t{\n\t\t\t\ttype: 'row',\n\t\t\t\tfields: [\n\t\t\t\t\ttextField('siteId', keys.providerFieldSiteId, {\n\t\t\t\t\t\twidth: '50%',\n\t\t\t\t\t\thelp: keys.providerFieldSiteIdHelp,\n\t\t\t\t\t\taccess,\n\t\t\t\t\t}),\n\t\t\t\t\t...apiKeyField(),\n\t\t\t\t],\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: 'row',\n\t\t\t\tfields: [\n\t\t\t\t\tcaptureField('domain', keys.providerFieldDomain, {\n\t\t\t\t\t\twidth: '50%',\n\t\t\t\t\t\thelp: keys.providerFieldDomainHelp,\n\t\t\t\t\t}),\n\t\t\t\t\tcaptureField('scriptId', keys.providerFieldScriptId, {\n\t\t\t\t\t\twidth: '50%',\n\t\t\t\t\t\thelp: keys.providerFieldScriptIdHelp,\n\t\t\t\t\t\tvalidate: validateScriptId,\n\t\t\t\t\t}),\n\t\t\t\t],\n\t\t\t},\n\t\t\tcurrencyField('revenueCurrency', keys.providerFieldRevenueCurrencyHelp),\n\t\t\thostField(allowPrivateNetwork, access),\n\t\t]),\n\t\tproviderGroup('umami', keys.providerNameUmami, [\n\t\t\t{\n\t\t\t\ttype: 'row',\n\t\t\t\tfields: [\n\t\t\t\t\ttextField('websiteId', keys.providerFieldWebsiteId, {\n\t\t\t\t\t\twidth: '50%',\n\t\t\t\t\t\thelp: keys.providerFieldWebsiteIdHelp,\n\t\t\t\t\t\taccess,\n\t\t\t\t\t}),\n\t\t\t\t\t...apiKeyField(),\n\t\t\t\t],\n\t\t\t},\n\t\t\t...secretField(buildSecret, staticLabel, {\n\t\t\t\tname: 'token',\n\t\t\t\tlabel: keys.providerFieldToken,\n\t\t\t\thelp: keys.providerFieldTokenHelp,\n\t\t\t}),\n\t\t\thostField(allowPrivateNetwork, access),\n\t\t]),\n\t\tproviderGroup('ga4', keys.providerNameGa4, [\n\t\t\t{\n\t\t\t\ttype: 'row',\n\t\t\t\tfields: [\n\t\t\t\t\ttextField('propertyId', keys.providerFieldPropertyId, {\n\t\t\t\t\t\twidth: '50%',\n\t\t\t\t\t\thelp: keys.providerFieldPropertyIdHelp,\n\t\t\t\t\t\taccess,\n\t\t\t\t\t}),\n\t\t\t\t\ttextField('projectId', keys.providerFieldProjectId, {\n\t\t\t\t\t\twidth: '50%',\n\t\t\t\t\t\thelp: keys.providerFieldProjectIdHelp,\n\t\t\t\t\t\taccess,\n\t\t\t\t\t}),\n\t\t\t\t],\n\t\t\t},\n\t\t\ttextField('clientEmail', keys.providerFieldClientEmail, {\n\t\t\t\thelp: keys.providerFieldClientEmailHelp,\n\t\t\t\taccess,\n\t\t\t}),\n\t\t\tcaptureField('measurementId', keys.providerFieldMeasurementId, {\n\t\t\t\tvalidate: validateMeasurementId,\n\t\t\t}),\n\t\t\tcurrencyField('currency', keys.providerFieldGa4CurrencyHelp),\n\t\t\t...buildSecret({\n\t\t\t\tname: 'privateKey',\n\t\t\t\ttype: 'textarea',\n\t\t\t\tlabel: labelForKey(keys.providerFieldPrivateKey),\n\t\t\t\tadmin: { description: staticLabel(keys.providerFieldPrivateKeyHelp) },\n\t\t\t}),\n\t\t]),\n\t\tproviderGroup('posthog', keys.providerNamePosthog, [\n\t\t\t{\n\t\t\t\ttype: 'row',\n\t\t\t\tfields: [\n\t\t\t\t\ttextField('projectId', keys.providerFieldProjectId, {\n\t\t\t\t\t\twidth: '50%',\n\t\t\t\t\t\thelp: keys.providerFieldProjectIdHelp,\n\t\t\t\t\t\taccess,\n\t\t\t\t\t}),\n\t\t\t\t\t...apiKeyField(validatePersonalApiKey),\n\t\t\t\t],\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: 'row',\n\t\t\t\tfields: [\n\t\t\t\t\tcaptureField('projectToken', keys.providerFieldProjectToken, {\n\t\t\t\t\t\twidth: '50%',\n\t\t\t\t\t\tvalidate: validateProjectToken,\n\t\t\t\t\t}),\n\t\t\t\t\t{\n\t\t\t\t\t\tname: 'region',\n\t\t\t\t\t\ttype: 'select',\n\t\t\t\t\t\tlabel: labelForKey(keys.providerFieldRegion),\n\t\t\t\t\t\toptions: [\n\t\t\t\t\t\t\t{ label: 'US', value: 'us' },\n\t\t\t\t\t\t\t{ label: 'EU', value: 'eu' },\n\t\t\t\t\t\t],\n\t\t\t\t\t\t...(access ? { access } : {}),\n\t\t\t\t\t\tadmin: {\n\t\t\t\t\t\t\twidth: '50%',\n\t\t\t\t\t\t\tdescription: staticLabel(keys.providerFieldRegionHelp),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t],\n\t\t\t},\n\t\t\ttextField('scopeProperty', keys.providerFieldScopeProperty, {\n\t\t\t\thelp: keys.providerFieldScopePropertyHelp,\n\t\t\t\taccess,\n\t\t\t}),\n\t\t\thostField(allowPrivateNetwork, access, {\n\t\t\t\tvalidate: validatePosthogHost(allowPrivateNetwork),\n\t\t\t}),\n\t\t]),\n\t\toverrideField(withoutConsentField(staticLabel), options.fields?.withoutConsent),\n\t]\n}\n\n/**\n * Runtime provider-settings collection, one document per provider (and scope). Admin-only by\n * default; `access` overrides single operations, `overrides` reshapes the whole config last.\n */\nexport const buildProvidersCollection = (args: BuildProvidersCollectionArgs): CollectionConfig => {\n\tconst staticLabel = args.staticLabel ?? builtInStaticLabel\n\tconst collection: CollectionConfig = {\n\t\tslug: args.slug,\n\t\tlabels: {\n\t\t\tsingular: labelForKey(keys.providersCollectionSingular),\n\t\t\tplural: labelForKey(keys.providersCollectionPlural),\n\t\t},\n\t\tdisableDuplicate: true,\n\t\tadmin: {\n\t\t\tuseAsTitle: 'name',\n\t\t\tdefaultColumns: ['name', 'provider', 'enabled'],\n\t\t\tgroup: staticLabel(keys.adminGroup),\n\t\t\tdescription: staticLabel(keys.providersCollectionDescription),\n\t\t\t...(args.listNotice ? { components: { beforeList: [PROVIDERS_LIST_NOTICE_COMPONENT] } } : {}),\n\t\t},\n\t\taccess: {\n\t\t\tread: providerRowAccess(args),\n\t\t\tcreate: providerCreateAccess(args),\n\t\t\tupdate: providerRowAccess(args),\n\t\t\tdelete: providerRowAccess(args),\n\t\t\t...args.access,\n\t\t},\n\t\thooks: {\n\t\t\t...(args.scoped ? { beforeValidate: [checkSingleDefault(args)] } : {}),\n\t\t\tbeforeChange: [\n\t\t\t\tstampScope(args),\n\t\t\t\tretargetSecrets({ scopeField: args.scopeField, isSealed: args.isSealed }),\n\t\t\t],\n\t\t\tafterChange: [\n\t\t\t\tasync ({ doc, operation, previousDoc, req }) => {\n\t\t\t\t\tawait args.onChange(\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tscope: docScope(doc, args.scopeField),\n\t\t\t\t\t\t\t...(operation === 'update'\n\t\t\t\t\t\t\t\t? { previousScope: docScope(previousDoc, args.scopeField) }\n\t\t\t\t\t\t\t\t: {}),\n\t\t\t\t\t\t},\n\t\t\t\t\t\treq\n\t\t\t\t\t)\n\t\t\t\t\treturn doc\n\t\t\t\t},\n\t\t\t],\n\t\t\tafterDelete: [\n\t\t\t\tasync ({ doc, req }) => {\n\t\t\t\t\tawait args.onChange({ scope: docScope(doc, args.scopeField) }, req)\n\t\t\t\t\treturn doc\n\t\t\t\t},\n\t\t\t],\n\t\t},\n\t\tfields: providerFields(\n\t\t\t{\n\t\t\t\tbuildSecret: args.buildSecret,\n\t\t\t\t...(args.fields ? { fields: args.fields } : {}),\n\t\t\t\tscopeField: args.scopeField === 'scope',\n\t\t\t\tallowPrivateNetwork: args.allowPrivateNetwork === true,\n\t\t\t\t...(args.connectionAccess ? { connectionAccess: args.connectionAccess } : {}),\n\t\t\t},\n\t\t\tstaticLabel,\n\t\t\t{\n\t\t\t\ttypes: args.types ?? PROVIDER_IDS,\n\t\t\t\t// A default is picked per scope: an unscoped install has one site and nothing to pick.\n\t\t\t\t...(args.scoped\n\t\t\t\t\t? {\n\t\t\t\t\t\t\tisDefault: overrideField(isDefaultField(args.defaultAccess), args.fields?.isDefault),\n\t\t\t\t\t\t}\n\t\t\t\t\t: {}),\n\t\t\t}\n\t\t),\n\t}\n\treturn args.overrides ? args.overrides(collection) : collection\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAgCA,MAAa,iBAAiB;;AAG9B,MAAa,kCAAkC;;AA+B/C,MAAa,yBACZ,MACA,WACuC;CACvC,IAAI,WAAW,KAAA,GACd;CAED,IAAI,OAAO,WAAW,YACrB,OAAO;EAAE,QAAQ;EAAQ,QAAQ;CAAO;CAEzC,MAAM,SAAS,cAAc,QAAQ;EACpC;EACA,OAAO,CAAC,UAAU,QAAQ;EAC1B,SAAS;CACV,CAAC;CACD,KAAK,MAAM,CAAC,MAAM,WAAW,OAAO,QAAQ,MAAM,GACjD,IAAI,WAAW,KAAA,KAAa,OAAO,WAAW,YAC7C,MAAM,IAAI,MACT,cAAc,KAAK,GAAG,KAAK,wCAAwC,OAAO,MAAM,GACjF;CAGF,MAAM,EAAE,QAAQ,WAAW;CAC3B,OAAO;EAAE,GAAI,SAAS,EAAE,OAAO,IAAI,CAAC;EAAI,GAAI,SAAS,EAAE,OAAO,IAAI,CAAC;CAAG;AACvE;;;;;AAMA,MAAa,uBACZ,MACA,QACA,YAAmC,iBACjB;CAClB,IAAI,WAAW,KAAA,GACd,OAAO,CAAC,GAAG,SAAS;CAErB,IAAI,CAAC,MAAM,QAAQ,MAAM,GACxB,MAAM,IAAI,MACT,cAAc,KAAK,wEAAwE,OAAO,MAAM,GACzG;CAED,MAAM,SAAuB,CAAC;CAC9B,KAAK,MAAM,QAAQ,QAAQ;EAC1B,IAAI,CAAC,QAAQ,cAAc,IAAI,GAC9B,MAAM,IAAI,MACT,cAAc,KAAK,SAAS,OAAO,IAAI,EAAE,mCAAmC,OAAO,aAAa,KAAK,OAAO,IAAI,GAAG,EAAE,CAAC,GACvH;EAED,OAAO,KAAK,IAAI;CACjB;CACA,MAAM,SAAS,CAAC,GAAG,IAAI,IAAI,MAAM,CAAC,EAAE,QAAQ,SAAS,UAAU,SAAS,IAAI,CAAC;CAC7E,IAAI,OAAO,WAAW,GACrB,MAAM,IAAI,MACT,cAAc,KAAK,0DAA0D,OAAO,UAAU,KAAK,OAAO,IAAI,GAAG,EAAE,CAAC,EAAE,sCACvH;CAED,OAAO;AACR;AA6BA,MAAM,eAAiC,WAAW,CAAC,MAAM;AAEzD,MAAM,aACL,MACA,OACA,OAAkF,CAAC,OACvE;CACZ;CACA,MAAM;CACN,OAAO,YAAY,KAAK;CACxB,GAAI,KAAK,SAAS,EAAE,QAAQ,KAAK,OAAO,IAAI,CAAC;CAC7C,GAAI,KAAK,SAAS,KAAK,OACpB,EACA,OAAO;EACN,GAAI,KAAK,QAAQ,EAAE,OAAO,KAAK,MAAM,IAAI,CAAC;EAC1C,GAAI,KAAK,OAAO,EAAE,aAAa,YAAY,KAAK,IAAI,EAAE,IAAI,CAAC;CAC5D,EACD,IACC,CAAC;AACL;;;;;AAMA,MAAM,eACL,aACA,aACA,SAQA,YAAY;CACX,MAAM,KAAK;CACX,MAAM;CACN,OAAO,YAAY,KAAK,KAAK;CAC7B,GAAI,KAAK,WAAW,EAAE,UAAU,KAAK,SAAS,IAAI,CAAC;CACnD,OAAO;EACN,aAAa,YAAY,KAAK,IAAI;EAClC,GAAI,KAAK,QAAQ,EAAE,OAAO,KAAK,MAAM,IAAI,CAAC;CAC3C;AACD,CAAC;;;;;AAMF,MAAM,gBACL,MACA,OACA,OAAwF,CAAC,OAC7E;CACZ;CACA,MAAM;CACN,OAAO,YAAY,KAAK;CACxB,GAAI,KAAK,WAAW,EAAE,UAAU,KAAK,SAAS,IAAI,CAAC;CACnD,OAAO;EACN,aAAa,YAAY,KAAK,QAAQ,KAAK,wBAAwB;EACnE,GAAI,KAAK,QAAQ,EAAE,OAAO,KAAK,MAAM,IAAI,CAAC;CAC3C;AACD;;;;;AAMA,MAAM,cAAc,YACnB,UACG,CACA;CAEC,MAAM;CACN,MAAM;CACN,OAAO;CACP,OAAO,YAAY,KAAK,kBAAkB;CAC1C,OAAO,EAAE,QAAQ,KAAK;AACvB,CACD,IACC,CAAC;AAEL,MAAM,aACL,qBACA,QACA,OAAiD,CAAC,OACtC;CACZ,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,iBAAiB;CACzC,UAAU,KAAK,YAAY,qBAAqB,mBAAmB;CACnE,GAAI,SAAS,EAAE,OAAO,IAAI,CAAC;CAC3B,OAAO,EAAE,aAAa,YAAY,KAAK,qBAAqB,EAAE;AAC/D;AAEA,MAAM,iBAAiB,MAAc,UAAiC;CACrE;CACA,MAAM;CACN,OAAO,YAAY,KAAK,4BAA4B;CACpD,UAAU;CACV,OAAO,EAAE,aAAa,YAAY,IAAI,EAAE;AACzC;AAEA,MAAM,iBAAiB,UAAsB,OAAuB,YAA4B;CAC/F,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK;CACxB,OAAO,EAAE,YAAY,SAAS,MAAM,aAAa,SAAS;CAC1D;AACD;;;;;AAMA,MAAM,oBAA2B;CAChC,MAAM;CACN,OAAO,YAAY,KAAK,kBAAkB;CAC1C,OAAO;EACN,YAAY,SAAS,MAAM,aAAa;EACxC,aAAa,YAAY,KAAK,sBAAsB;CACrD;CACA,QAAQ,CAAC;AACV;AAEA,MAAM,mBAA0B;CAC/B,MAAM;CACN,MAAM;CACN,UAAU;CACV,OAAO,YAAY,KAAK,iBAAiB;CACzC,OAAO,EAAE,aAAa,YAAY,KAAK,qBAAqB,EAAE;AAC/D;AAEA,MAAM,iBAAqD;CAC1D,QAAQ,KAAK;CACb,WAAW,KAAK;CAChB,OAAO,KAAK;CACZ,KAAK,KAAK;CACV,SAAS,KAAK;AACf;;;;;AAMA,MAAM,kBACJ,WACA,OAAO,YACP,OAAO,UAAU,YAAY,UAAU,MAAM,CAAC,MAAM,SAAS,KAAK,IAC/D,YAAY,QAAQ,IAAI,CAAC,EAAE,KAAK,yBAAyB,IACzD,YAAY,OAAO,OAAO,OAAO;;;;;;AAOtC,MAAM,gBAAgB,OAA8B,WACnD,QAAQ,cAAc,MAAM,KAAK,CAAC,MAAM,SAAS,MAAM,IAAI,CAAC,GAAG,OAAO,MAAM,IAAI,CAAC,GAAG,KAAK;;;;;;AAO1F,MAAM,iBACL,QACA,aACA,UACiB;CACjB,MAAM,CAAC,QAAQ,YAAY;CAC3B,MAAM,WAAW,MAAM,SAAS,aAAa;CAC7C,OAAO;EACN,MAAM;EACN,MAAM;EACN,UAAU;EACV,OAAO,YAAY,KAAK,qBAAqB;EAC7C,cAAc,UAAU,WAAW,cAAc;EACjD,GAAI,SAAS,EAAE,OAAO,IAAI,CAAC;EAC3B,GAAI,WACD;GACA,UAAU,eAAe,KAAK;GAC9B,gBAAgB,EAAE,WAAW,aAAa,OAAO,MAAM,QAAQ;EAChE,IACC,CAAC;EACJ,SAAS,aAAa,KAAK,UAAU;GACpC,OAAO,YAAY,eAAe,KAAK;GACvC,OAAO;EACR,EAAE;EAEF,OAAO;GAAE,UAAU;GAAW,aAAa,YAAY,KAAK,yBAAyB;EAAE;CACxF;AACD;;;;;AAMA,MAAM,uBAAuB,iBAA8C;CAC1E,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,2BAA2B;CACnD,SAAS,CACR;EAAE,OAAO,YAAY,KAAK,gCAAgC;EAAG,OAAO;CAAa,GACjF;EAAE,OAAO,YAAY,KAAK,yBAAyB;EAAG,OAAO;CAAM,CACpE;CACA,OAAO;EACN,YAAY,SAAS,QAAQ,cAAc,MAAM,QAAQ,KAAK,MAAM,aAAa;EACjF,aAAa,YAAY,KAAK,+BAA+B;CAC9D;AACD;AAEA,MAAM,sBAA6B;CAClC,MAAM;CACN,MAAM;CACN,cAAc;CACd,OAAO,YAAY,KAAK,oBAAoB;CAC5C,OAAO;EAAE,UAAU;EAAW,aAAa,YAAY,KAAK,wBAAwB;CAAE;AACvF;AAEA,MAAM,kBAAkB,YAAsD;CAC7E,MAAM;CACN,MAAM;CACN,cAAc;CACd,OAAO,YAAY,KAAK,sBAAsB;CAC9C,GAAI,SAAS,EAAE,OAAO,IAAI,CAAC;CAC3B,OAAO;EAAE,UAAU;EAAW,aAAa,YAAY,KAAK,0BAA0B;CAAE;AACzF;;;;;AAMA,MAAM,sBAAsB,SAAqE;CAChG,OAAO,OAAO,EAAE,MAAM,aAAa,UAAU;EAC5C,KAAK,MAAM,aAAa,aAAa,eAAe,MACnD,OAAO;EAER,IAAI,MAAM,aAAa,MAAM;GAAE;GAAM;GAAa;EAAI,GAAG,EAAE,WAAW,EAAE,QAAQ,KAAK,EAAE,CAAC,GACvF,MAAM,IAAI,gBAAgB;GACzB,YAAY,KAAK;GACjB,QAAQ,CACP;IACC,OAAO,YAAY,KAAK,sBAAsB;IAC9C,SAAS,YAAY,IAAI,CAAC,EAAE,KAAK,yBAAyB;IAC1D,MAAM;GACP,CACD;EACD,CAAC;EAEF,OAAO;CACR;AACD;;;;;AAwCA,MAAa,2BAA2B,UAAiC,CAAC,MACzE,eAAe,SAAS,oBAAoB,EAC3C,OAAO,oBAAoB,sCAAsC,QAAQ,KAAK,EAC/E,CAAC;AAEF,MAAM,kBACL,SACA,aACA,SACa;CACb,MAAM,cAAc,QAAQ,eAAe;CAC3C,MAAM,SAAS,sBACd,iDACA,QAAQ,gBACT;CACA,MAAM,sBAAsB,QAAQ,wBAAwB;CAC5D,MAAM,eAAe,aACpB,YAAY,aAAa,aAAa;EACrC,MAAM;EACN,OAAO,KAAK;EACZ,MAAM,KAAK;EACX,OAAO;EACP,GAAI,WAAW,EAAE,SAAS,IAAI,CAAC;CAChC,CAAC;CACF,OAAO;EACN,cAAc,UAAU,GAAG,QAAQ,QAAQ,IAAI;EAC/C,cAAc,cAAc,QAAQ,aAAa,KAAK,KAAK,GAAG,QAAQ,QAAQ,QAAQ;EACtF,cAAc,aAAa,GAAG,QAAQ,QAAQ,OAAO;EACrD,GAAI,KAAK,YAAY,CAAC,KAAK,SAAS,IAAI,CAAC;EACzC,GAAG,WAAW,QAAQ,eAAe,IAAI;EACzC,WAAW;EACX,cAAc,aAAa,KAAK,uBAAuB;GACtD;IACC,MAAM;IACN,QAAQ,CACP,UAAU,UAAU,KAAK,qBAAqB;KAC7C,OAAO;KACP,MAAM,KAAK;KACX;IACD,CAAC,GACD,GAAG,YAAY,CAChB;GACD;GACA;IACC,MAAM;IACN,QAAQ,CACP,aAAa,UAAU,KAAK,qBAAqB;KAChD,OAAO;KACP,MAAM,KAAK;IACZ,CAAC,GACD,aAAa,YAAY,KAAK,uBAAuB;KACpD,OAAO;KACP,MAAM,KAAK;KACX,UAAU;IACX,CAAC,CACF;GACD;GACA,cAAc,mBAAmB,KAAK,gCAAgC;GACtE,UAAU,qBAAqB,MAAM;EACtC,CAAC;EACD,cAAc,SAAS,KAAK,mBAAmB;GAC9C;IACC,MAAM;IACN,QAAQ,CACP,UAAU,aAAa,KAAK,wBAAwB;KACnD,OAAO;KACP,MAAM,KAAK;KACX;IACD,CAAC,GACD,GAAG,YAAY,CAChB;GACD;GACA,GAAG,YAAY,aAAa,aAAa;IACxC,MAAM;IACN,OAAO,KAAK;IACZ,MAAM,KAAK;GACZ,CAAC;GACD,UAAU,qBAAqB,MAAM;EACtC,CAAC;EACD,cAAc,OAAO,KAAK,iBAAiB;GAC1C;IACC,MAAM;IACN,QAAQ,CACP,UAAU,cAAc,KAAK,yBAAyB;KACrD,OAAO;KACP,MAAM,KAAK;KACX;IACD,CAAC,GACD,UAAU,aAAa,KAAK,wBAAwB;KACnD,OAAO;KACP,MAAM,KAAK;KACX;IACD,CAAC,CACF;GACD;GACA,UAAU,eAAe,KAAK,0BAA0B;IACvD,MAAM,KAAK;IACX;GACD,CAAC;GACD,aAAa,iBAAiB,KAAK,4BAA4B,EAC9D,UAAU,sBACX,CAAC;GACD,cAAc,YAAY,KAAK,4BAA4B;GAC3D,GAAG,YAAY;IACd,MAAM;IACN,MAAM;IACN,OAAO,YAAY,KAAK,uBAAuB;IAC/C,OAAO,EAAE,aAAa,YAAY,KAAK,2BAA2B,EAAE;GACrE,CAAC;EACF,CAAC;EACD,cAAc,WAAW,KAAK,qBAAqB;GAClD;IACC,MAAM;IACN,QAAQ,CACP,UAAU,aAAa,KAAK,wBAAwB;KACnD,OAAO;KACP,MAAM,KAAK;KACX;IACD,CAAC,GACD,GAAG,YAAY,sBAAsB,CACtC;GACD;GACA;IACC,MAAM;IACN,QAAQ,CACP,aAAa,gBAAgB,KAAK,2BAA2B;KAC5D,OAAO;KACP,UAAU;IACX,CAAC,GACD;KACC,MAAM;KACN,MAAM;KACN,OAAO,YAAY,KAAK,mBAAmB;KAC3C,SAAS,CACR;MAAE,OAAO;MAAM,OAAO;KAAK,GAC3B;MAAE,OAAO;MAAM,OAAO;KAAK,CAC5B;KACA,GAAI,SAAS,EAAE,OAAO,IAAI,CAAC;KAC3B,OAAO;MACN,OAAO;MACP,aAAa,YAAY,KAAK,uBAAuB;KACtD;IACD,CACD;GACD;GACA,UAAU,iBAAiB,KAAK,4BAA4B;IAC3D,MAAM,KAAK;IACX;GACD,CAAC;GACD,UAAU,qBAAqB,QAAQ,EACtC,UAAU,oBAAoB,mBAAmB,EAClD,CAAC;EACF,CAAC;EACD,cAAc,oBAAoB,WAAW,GAAG,QAAQ,QAAQ,cAAc;CAC/E;AACD;;;;;AAMA,MAAa,4BAA4B,SAAyD;CACjG,MAAM,cAAc,KAAK,eAAe;CACxC,MAAM,aAA+B;EACpC,MAAM,KAAK;EACX,QAAQ;GACP,UAAU,YAAY,KAAK,2BAA2B;GACtD,QAAQ,YAAY,KAAK,yBAAyB;EACnD;EACA,kBAAkB;EAClB,OAAO;GACN,YAAY;GACZ,gBAAgB;IAAC;IAAQ;IAAY;GAAS;GAC9C,OAAO,YAAY,KAAK,UAAU;GAClC,aAAa,YAAY,KAAK,8BAA8B;GAC5D,GAAI,KAAK,aAAa,EAAE,YAAY,EAAE,YAAY,CAAC,+BAA+B,EAAE,EAAE,IAAI,CAAC;EAC5F;EACA,QAAQ;GACP,MAAM,kBAAkB,IAAI;GAC5B,QAAQ,qBAAqB,IAAI;GACjC,QAAQ,kBAAkB,IAAI;GAC9B,QAAQ,kBAAkB,IAAI;GAC9B,GAAG,KAAK;EACT;EACA,OAAO;GACN,GAAI,KAAK,SAAS,EAAE,gBAAgB,CAAC,mBAAmB,IAAI,CAAC,EAAE,IAAI,CAAC;GACpE,cAAc,CACb,WAAW,IAAI,GACf,gBAAgB;IAAE,YAAY,KAAK;IAAY,UAAU,KAAK;GAAS,CAAC,CACzE;GACA,aAAa,CACZ,OAAO,EAAE,KAAK,WAAW,aAAa,UAAU;IAC/C,MAAM,KAAK,SACV;KACC,OAAO,SAAS,KAAK,KAAK,UAAU;KACpC,GAAI,cAAc,WACf,EAAE,eAAe,SAAS,aAAa,KAAK,UAAU,EAAE,IACxD,CAAC;IACL,GACA,GACD;IACA,OAAO;GACR,CACD;GACA,aAAa,CACZ,OAAO,EAAE,KAAK,UAAU;IACvB,MAAM,KAAK,SAAS,EAAE,OAAO,SAAS,KAAK,KAAK,UAAU,EAAE,GAAG,GAAG;IAClE,OAAO;GACR,CACD;EACD;EACA,QAAQ,eACP;GACC,aAAa,KAAK;GAClB,GAAI,KAAK,SAAS,EAAE,QAAQ,KAAK,OAAO,IAAI,CAAC;GAC7C,YAAY,KAAK,eAAe;GAChC,qBAAqB,KAAK,wBAAwB;GAClD,GAAI,KAAK,mBAAmB,EAAE,kBAAkB,KAAK,iBAAiB,IAAI,CAAC;EAC5E,GACA,aACA;GACC,OAAO,KAAK,SAAS;GAErB,GAAI,KAAK,SACN,EACA,WAAW,cAAc,eAAe,KAAK,aAAa,GAAG,KAAK,QAAQ,SAAS,EACpF,IACC,CAAC;EACL,CACD;CACD;CACA,OAAO,KAAK,YAAY,KAAK,UAAU,UAAU,IAAI;AACtD"}
|
|
1
|
+
{"version":3,"file":"collection.js","names":[],"sources":["../../src/providers/collection.ts"],"sourcesContent":["import {\n\ttype CollectionBeforeValidateHook,\n\ttype CollectionConfig,\n\ttype Field,\n\ttype FieldAccess,\n\ttype PayloadRequest,\n\ttype SelectField,\n\ttype SelectFieldSingleValidation,\n\ttype TextareaField,\n\ttype TextField,\n\ttype TextFieldSingleValidation,\n\tValidationError,\n\tvalidations,\n} from 'payload'\nimport { validateMeasurementId } from '../adapters/ga4/measurementId'\nimport { validatePropertyId } from '../adapters/ga4/propertyId'\nimport { validateScriptId } from '../adapters/plausible/scriptId'\nimport { validateSiteDomain, validateSiteDomains } from '../adapters/plausible/siteId'\nimport { validatePersonalApiKey, validateProjectToken } from '../adapters/posthog/credentials'\nimport { optionsObject } from '../core/optionChecks'\nimport { isOneOf, kindOf, listOf } from '../core/values'\nimport { validateCurrency } from '../goals/currency'\nimport { type CollectionFieldOverride, overrideField } from '../plugin/collectionFields'\nimport { docScope, type ScopeChange } from '../plugin/scopeChange'\nimport { keys, type SingularKey, type TranslationKey } from '../translations/keys'\nimport { asTranslate, labelForKey } from '../translations/server'\nimport { builtInStaticLabel, type StaticLabelFor } from '../translations/staticLabel'\nimport { type ProviderAccessArgs, providerCreateAccess, providerRowAccess } from './access'\nimport {\n\ttype HostedProvider,\n\ttype HostPattern,\n\ttype ListedHosts,\n\tvalidatePosthogHost,\n\tvalidatePosthogRegion,\n\tvalidateProviderHost,\n} from './hosts'\nimport { PROVIDER_IDS, PROVIDER_NAMES, type ProviderId } from './ids'\nimport { versionOf } from './probe'\nimport { reconnects, retargetSecrets } from './retarget'\nimport { takenInScope } from './scopeUnique'\nimport { stampScope } from './stampScope'\n\nexport const PROVIDERS_SLUG = 'analytics-providers'\n\n/** The list's note to a tenant reading the platform's source in `fallback`. */\nexport const PROVIDERS_LIST_NOTICE_COMPONENT = '@10x-media/analytics/client#ProvidersListNotice'\nconst PROVIDER_CONNECTION_COMPONENT = '@10x-media/analytics/client#ProviderConnection'\nconst PROVIDER_CONNECTION_TEST_COMPONENT = '@10x-media/analytics/client#ProviderConnectionTest'\n\n/** Builds the sealed variant of a secret source field; injected so the fields peer stays lazy. */\nexport type BuildSecretField = (source: TextField | TextareaField) => Field[]\n\n/**\n * Replaces a default field; it receives the plugin's own field to spread and may return any field\n * type (a `row`, a `collapsible`) that still holds a field of that name.\n */\nexport type ProviderFieldOverride = CollectionFieldOverride\n\nexport interface ProviderCollectionFieldOverrides {\n\tname?: ProviderFieldOverride\n\tprovider?: ProviderFieldOverride\n\tenabled?: ProviderFieldOverride\n\t/** The \"Default for this site\" checkbox, which only a scoped install's collection carries. */\n\tisDefault?: ProviderFieldOverride\n\t/** What a vendor source does without consent; empty follows `capture.withoutConsent`. */\n\twithoutConsent?: ProviderFieldOverride\n}\n\n/** Field access on the fields that decide where a provider document connects (`CONNECTION_PATHS`). */\nexport interface ConnectionFieldAccess {\n\tcreate?: FieldAccess\n\tupdate?: FieldAccess\n}\n\n/** One field access function for create and update alike, or `{ create, update }`. */\nexport type ConnectionAccess = FieldAccess | ConnectionFieldAccess\n\n/** `connectionAccess` in its object form, checked at boot; undefined while unset. */\nexport const connectionFieldAccess = (\n\tpath: string,\n\toption: ConnectionAccess | undefined\n): ConnectionFieldAccess | undefined => {\n\tif (option === undefined) {\n\t\treturn undefined\n\t}\n\tif (typeof option === 'function') {\n\t\treturn { create: option, update: option }\n\t}\n\tconst halves = optionsObject(option, {\n\t\tpath,\n\t\tknown: ['create', 'update'],\n\t\texample: 'a function, or { create, update } with a function in each',\n\t})\n\tfor (const [half, access] of Object.entries(halves)) {\n\t\tif (access !== undefined && typeof access !== 'function') {\n\t\t\tthrow new Error(\n\t\t\t\t`analytics: ${path}.${half} must be a field access function, got ${kindOf(access)}`\n\t\t\t)\n\t\t}\n\t}\n\tconst { create, update } = option\n\treturn { ...(create ? { create } : {}), ...(update ? { update } : {}) }\n}\n\n/**\n * The provider types documents may be saved with: every type `available` serves, narrowed to\n * `option` in its order when given, checked at boot.\n */\nexport const servedProviderTypes = (\n\tpath: string,\n\toption: unknown,\n\tavailable: readonly ProviderId[] = PROVIDER_IDS\n): ProviderId[] => {\n\tif (option === undefined) {\n\t\treturn [...available]\n\t}\n\tif (!Array.isArray(option)) {\n\t\tthrow new Error(\n\t\t\t`analytics: ${path} must be a list of provider types such as ['plausible', 'umami'], got ${kindOf(option)}`\n\t\t)\n\t}\n\tconst listed: ProviderId[] = []\n\tfor (const type of option) {\n\t\tif (!isOneOf(PROVIDER_IDS, type)) {\n\t\t\tthrow new Error(\n\t\t\t\t`analytics: ${path} lists ${kindOf(type)}, which is no provider type; use ${listOf(PROVIDER_IDS.map((id) => `\"${id}\"`))}`\n\t\t\t)\n\t\t}\n\t\tlisted.push(type)\n\t}\n\tconst served = [...new Set(listed)].filter((type) => available.includes(type))\n\tif (served.length === 0) {\n\t\tthrow new Error(\n\t\t\t`analytics: ${path} leaves no provider type this install serves, which are ${listOf(available.map((id) => `\"${id}\"`))}; \"native\" needs native() in adapters`\n\t\t)\n\t}\n\treturn served\n}\n\nexport interface BuildProvidersCollectionArgs extends ProviderAccessArgs {\n\tslug: string\n\taccess?: Partial<CollectionConfig['access']>\n\t/** Per-field overrides, applied before the whole-collection `overrides`. */\n\tfields?: ProviderCollectionFieldOverrides\n\toverrides?: (collection: CollectionConfig) => CollectionConfig\n\t/**\n\t * Called after any change or delete with the scopes the write touched and the request that\n\t * wrote, so that request's own Payload instance reads those scopes again once the write commits.\n\t */\n\tonChange: (change: ScopeChange, req: PayloadRequest) => void | Promise<void>\n\tbuildSecret: BuildSecretField\n\t/** The fields plugin's test for a sealed value, which tells a resent secret from a kept one. */\n\tisSealed: (value: unknown) => boolean\n\t/** `providers.hosts.allowPrivateNetwork`: the `host` fields accept `http://` too. */\n\tallowPrivateNetwork?: boolean\n\t/** `providers.hosts.allow`: a `host` outside it and its vendor's cloud is refused on save. */\n\tallow?: readonly HostPattern[]\n\tconnectionAccess?: ConnectionFieldAccess\n\t/** The provider types a document may be saved with; every type when absent. */\n\ttypes?: readonly ProviderId[]\n\t/** Field access on `isDefault`, which a scoped install's collection carries. */\n\tdefaultAccess?: ConnectionFieldAccess\n\t/** The install's static labels; the built-in strings alone when absent. */\n\tstaticLabel?: StaticLabelFor\n\t/** Mount the list's note on the platform fallback, for an install with a `fallback` policy. */\n\tlistNotice?: boolean\n\t/**\n\t * Forgets a document's last connection result: on its delete, and on a save that changes how\n\t * it connects.\n\t */\n\tforgetStatus?: (docId: string, req: PayloadRequest) => Promise<void>\n\t/**\n\t * Moves a document's last connection result to the version a save gave it, when the save left\n\t * how the document connects as it was.\n\t */\n\tcarryStatus?: (\n\t\tdocId: string,\n\t\tversions: { from: string; to: string },\n\t\treq: PayloadRequest\n\t) => Promise<void>\n}\n\n/**\n * The ids of the documents whose update changes how they connect, kept on `req.context` for their\n * afterChange: a bulk update hands every document the same context.\n */\nconst RECONNECTED_KEY = '__analyticsReconnected'\n\nconst reconnectedOf = (context: Record<string, unknown>): Set<string> => {\n\tconst existing = context[RECONNECTED_KEY]\n\tif (existing instanceof Set) {\n\t\treturn existing\n\t}\n\tconst created = new Set<string>()\n\tcontext[RECONNECTED_KEY] = created\n\treturn created\n}\n\nconst plainSecret: BuildSecretField = (source) => [source]\n\nconst textField = (\n\tname: string,\n\tlabel: TranslationKey,\n\topts: {\n\t\twidth?: string\n\t\thelp?: TranslationKey\n\t\taccess?: ConnectionFieldAccess\n\t\tvalidate?: TextFieldSingleValidation\n\t} = {}\n): Field => ({\n\tname,\n\ttype: 'text',\n\tlabel: labelForKey(label),\n\t...(opts.access ? { access: opts.access } : {}),\n\t...(opts.validate ? { validate: opts.validate } : {}),\n\t...(opts.width || opts.help\n\t\t? {\n\t\t\t\tadmin: {\n\t\t\t\t\t...(opts.width ? { width: opts.width } : {}),\n\t\t\t\t\t...(opts.help ? { description: labelForKey(opts.help) } : {}),\n\t\t\t\t},\n\t\t\t}\n\t\t: {}),\n})\n\n/**\n * A sealed credential. Its label and help are a string per locale: Payload drops a function label\n * and description from the client field, which the write-only editor renders.\n */\nconst secretField = (\n\tbuildSecret: BuildSecretField,\n\tstaticLabel: StaticLabelFor,\n\topts: {\n\t\tname: string\n\t\tlabel: SingularKey\n\t\thelp: SingularKey\n\t\twidth?: string\n\t\tvalidate?: TextFieldSingleValidation\n\t}\n): Field[] =>\n\tbuildSecret({\n\t\tname: opts.name,\n\t\ttype: 'text',\n\t\tlabel: staticLabel(opts.label),\n\t\t...(opts.validate ? { validate: opts.validate } : {}),\n\t\tadmin: {\n\t\t\tdescription: staticLabel(opts.help),\n\t\t\t...(opts.width ? { width: opts.width } : {}),\n\t\t},\n\t})\n\n/**\n * Public capture config, plain text because the tracker config serves it to the browser. An adapter\n * declares `capture` only once its public field is filled.\n */\nconst captureField = (\n\tname: string,\n\tlabel: TranslationKey,\n\topts: { width?: string; validate?: TextFieldSingleValidation; help?: TranslationKey } = {}\n): Field => ({\n\tname,\n\ttype: 'text',\n\tlabel: labelForKey(label),\n\t...(opts.validate ? { validate: opts.validate } : {}),\n\tadmin: {\n\t\tdescription: labelForKey(opts.help ?? keys.providerFieldCaptureHelp),\n\t\t...(opts.width ? { width: opts.width } : {}),\n\t},\n})\n\n/**\n * Only when `scopeField` names the plugin's own field: a host-owned scope field is the host's to\n * register, and shadowing it would store the scope twice.\n */\nconst scopeField = (include: boolean): Field[] =>\n\tinclude\n\t\t? [\n\t\t\t\t{\n\t\t\t\t\t// Written by scoped setups; hidden because single-site installs never touch it.\n\t\t\t\t\tname: 'scope',\n\t\t\t\t\ttype: 'text',\n\t\t\t\t\tindex: true,\n\t\t\t\t\tlabel: labelForKey(keys.providerFieldScope),\n\t\t\t\t\tadmin: { hidden: true },\n\t\t\t\t},\n\t\t\t]\n\t\t: []\n\nconst hostField = (\n\tallowPrivateNetwork: boolean,\n\taccess: ConnectionFieldAccess | undefined,\n\topts: {\n\t\tvalidate?: TextFieldSingleValidation\n\t\tlisted?: ListedHosts\n\t} = {}\n): Field => ({\n\tname: 'host',\n\ttype: 'text',\n\tlabel: labelForKey(keys.providerFieldHost),\n\tvalidate: opts.validate ?? validateProviderHost(allowPrivateNetwork, opts.listed),\n\t...(access ? { access } : {}),\n\tadmin: { description: labelForKey(keys.providerFieldHostHelp) },\n})\n\nconst currencyField = (name: string, help: TranslationKey): Field => ({\n\tname,\n\ttype: 'text',\n\tlabel: labelForKey(keys.providerFieldRevenueCurrency),\n\tvalidate: validateCurrency,\n\tadmin: { description: labelForKey(help) },\n})\n\nconst providerGroup = (provider: ProviderId, label: TranslationKey, fields: Field[]): Field => ({\n\tname: provider,\n\ttype: 'group',\n\tlabel: labelForKey(label),\n\tadmin: { condition: (data) => data?.provider === provider },\n\tfields,\n})\n\n/**\n * The native choice configures nothing, so it gets a note in place of a settings group:\n * an unnamed group stores no data and reads as the section its siblings occupy.\n */\nconst nativeNote = (): Field => ({\n\ttype: 'group',\n\tlabel: labelForKey(keys.providerNameNative),\n\tadmin: {\n\t\tcondition: (data) => data?.provider === 'native',\n\t\tdescription: labelForKey(keys.providerNameNativeHelp),\n\t},\n\tfields: [],\n})\n\nconst nameField = (): Field => ({\n\tname: 'name',\n\ttype: 'text',\n\trequired: true,\n\tlabel: labelForKey(keys.providerFieldName),\n\tadmin: { description: labelForKey(keys.providerFieldNameHelp) },\n})\n\n/**\n * Names the refusal of a stored type the install no longer serves (native() removed, `types`\n * narrowed), which the select's own check would only call an invalid selection.\n */\nconst validateServed =\n\t(types: readonly string[]): SelectFieldSingleValidation =>\n\t(value, options) =>\n\t\ttypeof value === 'string' && value !== '' && !types.includes(value)\n\t\t\t? asTranslate(options.req.t)(keys.providerErrorTypeUnserved)\n\t\t\t: validations.select(value, options)\n\n/**\n * The values a narrowed select offers: the served types, and a stored type no longer served so its\n * save is refused by name. Values only, since form state carries the result to the client, where\n * a label function cannot cross; Payload's select reads nothing else from it.\n */\nconst offeredTypes = (types: readonly ProviderId[], stored: unknown): ProviderId[] =>\n\tisOneOf(PROVIDER_IDS, stored) && !types.includes(stored) ? [...types, stored] : [...types]\n\n/**\n * Sits in the sidebar with `enabled`: every body field is conditional on the provider and\n * meaningless while `enabled` is off. The schema keeps every type (options, groups, a static\n * default while `native` leads), so narrowing the offer neither alters a column nor drops settings.\n */\nconst providerField = (\n\taccess: ConnectionFieldAccess | undefined,\n\tstaticLabel: StaticLabelFor,\n\ttypes: readonly ProviderId[]\n): SelectField => {\n\tconst [first = 'native'] = types\n\tconst narrowed = types.length < PROVIDER_IDS.length\n\treturn {\n\t\tname: 'provider',\n\t\ttype: 'select',\n\t\trequired: true,\n\t\tlabel: labelForKey(keys.providerFieldProvider),\n\t\tdefaultValue: first === 'native' ? first : () => first,\n\t\t...(access ? { access } : {}),\n\t\t...(narrowed\n\t\t\t? {\n\t\t\t\t\tvalidate: validateServed(types),\n\t\t\t\t\tfilterOptions: ({ data }) => offeredTypes(types, data?.provider),\n\t\t\t\t}\n\t\t\t: {}),\n\t\toptions: PROVIDER_IDS.map((type) => ({\n\t\t\tlabel: labelForKey(PROVIDER_NAMES[type]),\n\t\t\tvalue: type,\n\t\t})),\n\t\t// `admin.description` on a select is read where a label function never runs.\n\t\tadmin: { position: 'sidebar', description: staticLabel(keys.providerFieldProviderHelp) },\n\t}\n}\n\n/**\n * A vendor document's own `withoutConsent`. Unset follows `capture.withoutConsent`; no option\n * stands for that, since an empty string is no portable enum value.\n */\nconst withoutConsentField = (staticLabel: StaticLabelFor): SelectField => ({\n\tname: 'withoutConsent',\n\ttype: 'select',\n\tlabel: labelForKey(keys.providerFieldWithoutConsent),\n\toptions: [\n\t\t{ label: staticLabel(keys.providerWithoutConsentCookieless), value: 'cookieless' },\n\t\t{ label: staticLabel(keys.providerWithoutConsentOff), value: 'off' },\n\t],\n\tadmin: {\n\t\tcondition: (data) => isOneOf(PROVIDER_IDS, data?.provider) && data?.provider !== 'native',\n\t\tdescription: staticLabel(keys.providerFieldWithoutConsentHelp),\n\t},\n})\n\nconst enabledField = (): Field => ({\n\tname: 'enabled',\n\ttype: 'checkbox',\n\tdefaultValue: true,\n\tlabel: labelForKey(keys.providerFieldEnabled),\n\tadmin: { position: 'sidebar', description: labelForKey(keys.providerFieldEnabledHelp) },\n})\n\nconst isDefaultField = (access: ConnectionFieldAccess | undefined): Field => ({\n\tname: 'isDefault',\n\ttype: 'checkbox',\n\tdefaultValue: false,\n\tlabel: labelForKey(keys.providerFieldIsDefault),\n\t...(access ? { access } : {}),\n\tadmin: { position: 'sidebar', description: labelForKey(keys.providerFieldIsDefaultHelp) },\n})\n\n/**\n * At most one document per scope is the default, checked at collection level so a replaced\n * `isDefault` field keeps it. No index backs it: a unique one would also cover the unflagged rows.\n */\nconst checkSingleDefault = (args: BuildProvidersCollectionArgs): CollectionBeforeValidateHook => {\n\treturn async ({ data, originalDoc, req }) => {\n\t\tif ((data?.isDefault ?? originalDoc?.isDefault) !== true) {\n\t\t\treturn data\n\t\t}\n\t\tif (await takenInScope(args, { data, originalDoc, req }, { isDefault: { equals: true } })) {\n\t\t\tthrow new ValidationError(\n\t\t\t\t{\n\t\t\t\t\tcollection: args.slug,\n\t\t\t\t\terrors: [\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tlabel: labelForKey(keys.providerFieldIsDefault),\n\t\t\t\t\t\t\tmessage: asTranslate(req.t)(keys.providerErrorDefaultTaken),\n\t\t\t\t\t\t\tpath: 'isDefault',\n\t\t\t\t\t\t},\n\t\t\t\t\t],\n\t\t\t\t\treq,\n\t\t\t\t},\n\t\t\t\treq.t\n\t\t\t)\n\t\t}\n\t\treturn data\n\t}\n}\n\nexport interface ProviderFieldsOptions {\n\t/**\n\t * Seals each credential field, normally `encryptedField` from `@10x-media/fields` in write-only\n\t * mode. Left out, credentials are plain text and securing them is the host's job.\n\t */\n\tbuildSecret?: BuildSecretField\n\t/** Replaces one of the default fields, applied per field. */\n\tfields?: Omit<ProviderCollectionFieldOverrides, 'isDefault'>\n\t/** Adds the plugin's own hidden `scope` text field. Off by default. */\n\tscopeField?: boolean\n\t/**\n\t * Accepts `http://` in a `host` field, for a vendor on a private network. Set it together with\n\t * `providers.hosts.allowPrivateNetwork`, which lets the plugin connect there. Off, https only.\n\t */\n\tallowPrivateNetwork?: boolean\n\t/**\n\t * Field access on every `CONNECTION_PATHS` field except the scope field. One function for create\n\t * and update alike, or `{ create, update }`.\n\t */\n\tconnectionAccess?: ConnectionAccess\n\t/**\n\t * The provider types the select offers, the first being its default; a document saved with any\n\t * other type is refused. Default: every type, `native` first.\n\t */\n\ttypes?: ProviderId[]\n}\n\n/** What the field list takes beyond the public options. */\ninterface FieldListArgs {\n\ttypes: readonly ProviderId[]\n\t/** The `isDefault` checkbox, overridden, placed after `enabled`; only a scoped collection has it. */\n\tisDefault?: Field\n\t/** `providers.hosts.allow`: a `host` outside it and its vendor's cloud is refused on save. */\n\tallow?: readonly HostPattern[]\n}\n\n/**\n * Provider-settings fields alone, for a host that stores them elsewhere and feeds them back through\n * `providers.resolve`; {@link adapterFromProviderDoc} reads the result as is.\n */\nexport const analyticsProviderFields = (options: ProviderFieldsOptions = {}): Field[] =>\n\tproviderFields(options, builtInStaticLabel, {\n\t\ttypes: servedProviderTypes('analyticsProviderFields({ types })', options.types),\n\t})\n\nconst providerFields = (\n\toptions: ProviderFieldsOptions,\n\tstaticLabel: StaticLabelFor,\n\tlist: FieldListArgs\n): Field[] => {\n\tconst buildSecret = options.buildSecret ?? plainSecret\n\tconst access = connectionFieldAccess(\n\t\t'analyticsProviderFields({ connectionAccess })',\n\t\toptions.connectionAccess\n\t)\n\tconst allowPrivateNetwork = options.allowPrivateNetwork === true\n\tconst { allow } = list\n\tconst listedFor = (provider: HostedProvider) => (allow ? { provider, allow } : undefined)\n\tconst apiKeyField = ({\n\t\tvalidate,\n\t\thelp = keys.providerFieldApiKeyHelp,\n\t}: {\n\t\tvalidate?: TextFieldSingleValidation\n\t\thelp?: SingularKey\n\t} = {}): Field[] =>\n\t\tsecretField(buildSecret, staticLabel, {\n\t\t\tname: 'apiKey',\n\t\t\tlabel: keys.providerFieldApiKey,\n\t\t\thelp,\n\t\t\twidth: '50%',\n\t\t\t...(validate ? { validate } : {}),\n\t\t})\n\treturn [\n\t\toverrideField(nameField(), options.fields?.name),\n\t\toverrideField(providerField(access, staticLabel, list.types), options.fields?.provider),\n\t\toverrideField(enabledField(), options.fields?.enabled),\n\t\t...(list.isDefault ? [list.isDefault] : []),\n\t\t...scopeField(options.scopeField === true),\n\t\tnativeNote(),\n\t\tproviderGroup('plausible', keys.providerNamePlausible, [\n\t\t\t{\n\t\t\t\ttype: 'row',\n\t\t\t\tfields: [\n\t\t\t\t\ttextField('siteId', keys.providerFieldSiteId, {\n\t\t\t\t\t\twidth: '50%',\n\t\t\t\t\t\thelp: keys.providerFieldSiteIdHelp,\n\t\t\t\t\t\taccess,\n\t\t\t\t\t\tvalidate: validateSiteDomain,\n\t\t\t\t\t}),\n\t\t\t\t\t...apiKeyField(),\n\t\t\t\t],\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: 'row',\n\t\t\t\tfields: [\n\t\t\t\t\tcaptureField('domain', keys.providerFieldDomain, {\n\t\t\t\t\t\twidth: '50%',\n\t\t\t\t\t\thelp: keys.providerFieldDomainHelp,\n\t\t\t\t\t\tvalidate: validateSiteDomains,\n\t\t\t\t\t}),\n\t\t\t\t\tcaptureField('scriptId', keys.providerFieldScriptId, {\n\t\t\t\t\t\twidth: '50%',\n\t\t\t\t\t\thelp: keys.providerFieldScriptIdHelp,\n\t\t\t\t\t\tvalidate: validateScriptId,\n\t\t\t\t\t}),\n\t\t\t\t],\n\t\t\t},\n\t\t\tcurrencyField('revenueCurrency', keys.providerFieldRevenueCurrencyHelp),\n\t\t\thostField(allowPrivateNetwork, access, { listed: listedFor('plausible') }),\n\t\t]),\n\t\tproviderGroup('umami', keys.providerNameUmami, [\n\t\t\t{\n\t\t\t\ttype: 'row',\n\t\t\t\tfields: [\n\t\t\t\t\ttextField('websiteId', keys.providerFieldWebsiteId, {\n\t\t\t\t\t\twidth: '50%',\n\t\t\t\t\t\thelp: keys.providerFieldWebsiteIdHelp,\n\t\t\t\t\t\taccess,\n\t\t\t\t\t}),\n\t\t\t\t\t...apiKeyField({ help: keys.providerFieldUmamiApiKeyHelp }),\n\t\t\t\t],\n\t\t\t},\n\t\t\t...secretField(buildSecret, staticLabel, {\n\t\t\t\tname: 'token',\n\t\t\t\tlabel: keys.providerFieldToken,\n\t\t\t\thelp: keys.providerFieldTokenHelp,\n\t\t\t}),\n\t\t\thostField(allowPrivateNetwork, access, { listed: listedFor('umami') }),\n\t\t]),\n\t\tproviderGroup('ga4', keys.providerNameGa4, [\n\t\t\t{\n\t\t\t\ttype: 'row',\n\t\t\t\tfields: [\n\t\t\t\t\ttextField('propertyId', keys.providerFieldPropertyId, {\n\t\t\t\t\t\twidth: '50%',\n\t\t\t\t\t\thelp: keys.providerFieldPropertyIdHelp,\n\t\t\t\t\t\taccess,\n\t\t\t\t\t\tvalidate: validatePropertyId,\n\t\t\t\t\t}),\n\t\t\t\t\ttextField('projectId', keys.providerFieldProjectId, {\n\t\t\t\t\t\twidth: '50%',\n\t\t\t\t\t\thelp: keys.providerFieldProjectIdHelp,\n\t\t\t\t\t\taccess,\n\t\t\t\t\t}),\n\t\t\t\t],\n\t\t\t},\n\t\t\ttextField('clientEmail', keys.providerFieldClientEmail, {\n\t\t\t\thelp: keys.providerFieldClientEmailHelp,\n\t\t\t\taccess,\n\t\t\t}),\n\t\t\tcaptureField('measurementId', keys.providerFieldMeasurementId, {\n\t\t\t\thelp: keys.providerFieldMeasurementIdHelp,\n\t\t\t\tvalidate: validateMeasurementId,\n\t\t\t}),\n\t\t\tcurrencyField('currency', keys.providerFieldGa4CurrencyHelp),\n\t\t\t...buildSecret({\n\t\t\t\tname: 'privateKey',\n\t\t\t\ttype: 'textarea',\n\t\t\t\tlabel: staticLabel(keys.providerFieldPrivateKey),\n\t\t\t\tadmin: { description: staticLabel(keys.providerFieldPrivateKeyHelp) },\n\t\t\t}),\n\t\t]),\n\t\tproviderGroup('posthog', keys.providerNamePosthog, [\n\t\t\t{\n\t\t\t\ttype: 'row',\n\t\t\t\tfields: [\n\t\t\t\t\ttextField('projectId', keys.providerFieldProjectId, {\n\t\t\t\t\t\twidth: '50%',\n\t\t\t\t\t\thelp: keys.providerFieldPosthogProjectIdHelp,\n\t\t\t\t\t\taccess,\n\t\t\t\t\t}),\n\t\t\t\t\t...apiKeyField({\n\t\t\t\t\t\tvalidate: validatePersonalApiKey,\n\t\t\t\t\t\thelp: keys.providerFieldPosthogApiKeyHelp,\n\t\t\t\t\t}),\n\t\t\t\t],\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: 'row',\n\t\t\t\tfields: [\n\t\t\t\t\tcaptureField('projectToken', keys.providerFieldProjectToken, {\n\t\t\t\t\t\twidth: '50%',\n\t\t\t\t\t\tvalidate: validateProjectToken,\n\t\t\t\t\t}),\n\t\t\t\t\t{\n\t\t\t\t\t\tname: 'region',\n\t\t\t\t\t\ttype: 'select',\n\t\t\t\t\t\tlabel: labelForKey(keys.providerFieldRegion),\n\t\t\t\t\t\tvalidate: validatePosthogRegion,\n\t\t\t\t\t\toptions: [\n\t\t\t\t\t\t\t{ label: 'US', value: 'us' },\n\t\t\t\t\t\t\t{ label: 'EU', value: 'eu' },\n\t\t\t\t\t\t],\n\t\t\t\t\t\t...(access ? { access } : {}),\n\t\t\t\t\t\tadmin: {\n\t\t\t\t\t\t\twidth: '50%',\n\t\t\t\t\t\t\tdescription: staticLabel(keys.providerFieldRegionHelp),\n\t\t\t\t\t\t},\n\t\t\t\t\t},\n\t\t\t\t],\n\t\t\t},\n\t\t\ttextField('scopeProperty', keys.providerFieldScopeProperty, {\n\t\t\t\thelp: keys.providerFieldScopePropertyHelp,\n\t\t\t\taccess,\n\t\t\t}),\n\t\t\thostField(allowPrivateNetwork, access, {\n\t\t\t\tvalidate: validatePosthogHost(allowPrivateNetwork, listedFor('posthog')),\n\t\t\t}),\n\t\t]),\n\t\toverrideField(withoutConsentField(staticLabel), options.fields?.withoutConsent),\n\t]\n}\n\n/** The sidebar's Connection panel of a vendor document; its Test connection button sits beside Save. */\nconst connectionField: Field = {\n\tname: 'connection',\n\ttype: 'ui',\n\tadmin: {\n\t\tposition: 'sidebar',\n\t\tcomponents: { Field: PROVIDER_CONNECTION_COMPONENT },\n\t\tcondition: (data) => isOneOf(PROVIDER_IDS, data?.provider) && data?.provider !== 'native',\n\t},\n}\n\n/**\n * Runtime provider-settings collection, one document per provider (and scope). Admin-only by\n * default; `access` overrides single operations, `overrides` reshapes the whole config last.\n */\nexport const buildProvidersCollection = (args: BuildProvidersCollectionArgs): CollectionConfig => {\n\tconst staticLabel = args.staticLabel ?? builtInStaticLabel\n\tconst collection: CollectionConfig = {\n\t\tslug: args.slug,\n\t\tlabels: {\n\t\t\tsingular: labelForKey(keys.providersCollectionSingular),\n\t\t\tplural: labelForKey(keys.providersCollectionPlural),\n\t\t},\n\t\tdisableDuplicate: true,\n\t\tadmin: {\n\t\t\tuseAsTitle: 'name',\n\t\t\tdefaultColumns: ['name', 'provider', 'enabled'],\n\t\t\tgroup: staticLabel(keys.adminGroup),\n\t\t\tdescription: staticLabel(keys.providersCollectionDescription),\n\t\t\tcomponents: {\n\t\t\t\t...(args.listNotice ? { beforeList: [PROVIDERS_LIST_NOTICE_COMPONENT] } : {}),\n\t\t\t\tedit: { beforeDocumentControls: [PROVIDER_CONNECTION_TEST_COMPONENT] },\n\t\t\t},\n\t\t},\n\t\taccess: {\n\t\t\tread: providerRowAccess(args),\n\t\t\tcreate: providerCreateAccess(args),\n\t\t\tupdate: providerRowAccess(args),\n\t\t\tdelete: providerRowAccess(args),\n\t\t\t...args.access,\n\t\t},\n\t\thooks: {\n\t\t\t...(args.scoped ? { beforeValidate: [checkSingleDefault(args)] } : {}),\n\t\t\tbeforeChange: [\n\t\t\t\tstampScope(args),\n\t\t\t\t// Only notes the change: field validation runs after this hook, and a save it refuses\n\t\t\t\t// keeps the status. afterChange forgets it.\n\t\t\t\t({ context, data, operation, originalDoc }) => {\n\t\t\t\t\tif (\n\t\t\t\t\t\toperation === 'update' &&\n\t\t\t\t\t\treconnects({ scopeField: args.scopeField, isSealed: args.isSealed, data, originalDoc })\n\t\t\t\t\t) {\n\t\t\t\t\t\treconnectedOf(context).add(String(originalDoc?.id))\n\t\t\t\t\t}\n\t\t\t\t\treturn data\n\t\t\t\t},\n\t\t\t\tretargetSecrets({ scopeField: args.scopeField, isSealed: args.isSealed }),\n\t\t\t],\n\t\t\tafterChange: [\n\t\t\t\tasync ({ context, doc, operation, previousDoc, req }) => {\n\t\t\t\t\tif (operation === 'update' && reconnectedOf(context).delete(String(doc.id))) {\n\t\t\t\t\t\tawait args.forgetStatus?.(String(doc.id), req)\n\t\t\t\t\t} else if (operation === 'update') {\n\t\t\t\t\t\tawait args.carryStatus?.(\n\t\t\t\t\t\t\tString(doc.id),\n\t\t\t\t\t\t\t{ from: versionOf(previousDoc.updatedAt), to: versionOf(doc.updatedAt) },\n\t\t\t\t\t\t\treq\n\t\t\t\t\t\t)\n\t\t\t\t\t}\n\t\t\t\t\tawait args.onChange(\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\tscope: docScope(doc, args.scopeField),\n\t\t\t\t\t\t\t...(operation === 'update'\n\t\t\t\t\t\t\t\t? { previousScope: docScope(previousDoc, args.scopeField) }\n\t\t\t\t\t\t\t\t: {}),\n\t\t\t\t\t\t},\n\t\t\t\t\t\treq\n\t\t\t\t\t)\n\t\t\t\t\treturn doc\n\t\t\t\t},\n\t\t\t],\n\t\t\tafterDelete: [\n\t\t\t\tasync ({ doc, id, req }) => {\n\t\t\t\t\tawait args.forgetStatus?.(String(id), req)\n\t\t\t\t\tawait args.onChange({ scope: docScope(doc, args.scopeField) }, req)\n\t\t\t\t\treturn doc\n\t\t\t\t},\n\t\t\t],\n\t\t},\n\t\tfields: [\n\t\t\t...providerFields(\n\t\t\t\t{\n\t\t\t\t\tbuildSecret: args.buildSecret,\n\t\t\t\t\t...(args.fields ? { fields: args.fields } : {}),\n\t\t\t\t\tscopeField: args.scopeField === 'scope',\n\t\t\t\t\tallowPrivateNetwork: args.allowPrivateNetwork === true,\n\t\t\t\t\t...(args.connectionAccess ? { connectionAccess: args.connectionAccess } : {}),\n\t\t\t\t},\n\t\t\t\tstaticLabel,\n\t\t\t\t{\n\t\t\t\t\ttypes: args.types ?? PROVIDER_IDS,\n\t\t\t\t\t...(args.allow ? { allow: args.allow } : {}),\n\t\t\t\t\t// A default is picked per scope: an unscoped install has one site and nothing to pick.\n\t\t\t\t\t...(args.scoped\n\t\t\t\t\t\t? {\n\t\t\t\t\t\t\t\tisDefault: overrideField(\n\t\t\t\t\t\t\t\t\tisDefaultField(args.defaultAccess),\n\t\t\t\t\t\t\t\t\targs.fields?.isDefault\n\t\t\t\t\t\t\t\t),\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t: {}),\n\t\t\t\t}\n\t\t\t),\n\t\t\tconnectionField,\n\t\t],\n\t}\n\treturn args.overrides ? args.overrides(collection) : collection\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AA0CA,MAAa,iBAAiB;;AAG9B,MAAa,kCAAkC;AAC/C,MAAM,gCAAgC;AACtC,MAAM,qCAAqC;;AA+B3C,MAAa,yBACZ,MACA,WACuC;CACvC,IAAI,WAAW,KAAA,GACd;CAED,IAAI,OAAO,WAAW,YACrB,OAAO;EAAE,QAAQ;EAAQ,QAAQ;CAAO;CAEzC,MAAM,SAAS,cAAc,QAAQ;EACpC;EACA,OAAO,CAAC,UAAU,QAAQ;EAC1B,SAAS;CACV,CAAC;CACD,KAAK,MAAM,CAAC,MAAM,WAAW,OAAO,QAAQ,MAAM,GACjD,IAAI,WAAW,KAAA,KAAa,OAAO,WAAW,YAC7C,MAAM,IAAI,MACT,cAAc,KAAK,GAAG,KAAK,wCAAwC,OAAO,MAAM,GACjF;CAGF,MAAM,EAAE,QAAQ,WAAW;CAC3B,OAAO;EAAE,GAAI,SAAS,EAAE,OAAO,IAAI,CAAC;EAAI,GAAI,SAAS,EAAE,OAAO,IAAI,CAAC;CAAG;AACvE;;;;;AAMA,MAAa,uBACZ,MACA,QACA,YAAmC,iBACjB;CAClB,IAAI,WAAW,KAAA,GACd,OAAO,CAAC,GAAG,SAAS;CAErB,IAAI,CAAC,MAAM,QAAQ,MAAM,GACxB,MAAM,IAAI,MACT,cAAc,KAAK,wEAAwE,OAAO,MAAM,GACzG;CAED,MAAM,SAAuB,CAAC;CAC9B,KAAK,MAAM,QAAQ,QAAQ;EAC1B,IAAI,CAAC,QAAQ,cAAc,IAAI,GAC9B,MAAM,IAAI,MACT,cAAc,KAAK,SAAS,OAAO,IAAI,EAAE,mCAAmC,OAAO,aAAa,KAAK,OAAO,IAAI,GAAG,EAAE,CAAC,GACvH;EAED,OAAO,KAAK,IAAI;CACjB;CACA,MAAM,SAAS,CAAC,GAAG,IAAI,IAAI,MAAM,CAAC,EAAE,QAAQ,SAAS,UAAU,SAAS,IAAI,CAAC;CAC7E,IAAI,OAAO,WAAW,GACrB,MAAM,IAAI,MACT,cAAc,KAAK,0DAA0D,OAAO,UAAU,KAAK,OAAO,IAAI,GAAG,EAAE,CAAC,EAAE,sCACvH;CAED,OAAO;AACR;;;;;AAiDA,MAAM,kBAAkB;AAExB,MAAM,iBAAiB,YAAkD;CACxE,MAAM,WAAW,QAAQ;CACzB,IAAI,oBAAoB,KACvB,OAAO;CAER,MAAM,0BAAU,IAAI,IAAY;CAChC,QAAQ,mBAAmB;CAC3B,OAAO;AACR;AAEA,MAAM,eAAiC,WAAW,CAAC,MAAM;AAEzD,MAAM,aACL,MACA,OACA,OAKI,CAAC,OACO;CACZ;CACA,MAAM;CACN,OAAO,YAAY,KAAK;CACxB,GAAI,KAAK,SAAS,EAAE,QAAQ,KAAK,OAAO,IAAI,CAAC;CAC7C,GAAI,KAAK,WAAW,EAAE,UAAU,KAAK,SAAS,IAAI,CAAC;CACnD,GAAI,KAAK,SAAS,KAAK,OACpB,EACA,OAAO;EACN,GAAI,KAAK,QAAQ,EAAE,OAAO,KAAK,MAAM,IAAI,CAAC;EAC1C,GAAI,KAAK,OAAO,EAAE,aAAa,YAAY,KAAK,IAAI,EAAE,IAAI,CAAC;CAC5D,EACD,IACC,CAAC;AACL;;;;;AAMA,MAAM,eACL,aACA,aACA,SAQA,YAAY;CACX,MAAM,KAAK;CACX,MAAM;CACN,OAAO,YAAY,KAAK,KAAK;CAC7B,GAAI,KAAK,WAAW,EAAE,UAAU,KAAK,SAAS,IAAI,CAAC;CACnD,OAAO;EACN,aAAa,YAAY,KAAK,IAAI;EAClC,GAAI,KAAK,QAAQ,EAAE,OAAO,KAAK,MAAM,IAAI,CAAC;CAC3C;AACD,CAAC;;;;;AAMF,MAAM,gBACL,MACA,OACA,OAAwF,CAAC,OAC7E;CACZ;CACA,MAAM;CACN,OAAO,YAAY,KAAK;CACxB,GAAI,KAAK,WAAW,EAAE,UAAU,KAAK,SAAS,IAAI,CAAC;CACnD,OAAO;EACN,aAAa,YAAY,KAAK,QAAQ,KAAK,wBAAwB;EACnE,GAAI,KAAK,QAAQ,EAAE,OAAO,KAAK,MAAM,IAAI,CAAC;CAC3C;AACD;;;;;AAMA,MAAM,cAAc,YACnB,UACG,CACA;CAEC,MAAM;CACN,MAAM;CACN,OAAO;CACP,OAAO,YAAY,KAAK,kBAAkB;CAC1C,OAAO,EAAE,QAAQ,KAAK;AACvB,CACD,IACC,CAAC;AAEL,MAAM,aACL,qBACA,QACA,OAGI,CAAC,OACO;CACZ,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,iBAAiB;CACzC,UAAU,KAAK,YAAY,qBAAqB,qBAAqB,KAAK,MAAM;CAChF,GAAI,SAAS,EAAE,OAAO,IAAI,CAAC;CAC3B,OAAO,EAAE,aAAa,YAAY,KAAK,qBAAqB,EAAE;AAC/D;AAEA,MAAM,iBAAiB,MAAc,UAAiC;CACrE;CACA,MAAM;CACN,OAAO,YAAY,KAAK,4BAA4B;CACpD,UAAU;CACV,OAAO,EAAE,aAAa,YAAY,IAAI,EAAE;AACzC;AAEA,MAAM,iBAAiB,UAAsB,OAAuB,YAA4B;CAC/F,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK;CACxB,OAAO,EAAE,YAAY,SAAS,MAAM,aAAa,SAAS;CAC1D;AACD;;;;;AAMA,MAAM,oBAA2B;CAChC,MAAM;CACN,OAAO,YAAY,KAAK,kBAAkB;CAC1C,OAAO;EACN,YAAY,SAAS,MAAM,aAAa;EACxC,aAAa,YAAY,KAAK,sBAAsB;CACrD;CACA,QAAQ,CAAC;AACV;AAEA,MAAM,mBAA0B;CAC/B,MAAM;CACN,MAAM;CACN,UAAU;CACV,OAAO,YAAY,KAAK,iBAAiB;CACzC,OAAO,EAAE,aAAa,YAAY,KAAK,qBAAqB,EAAE;AAC/D;;;;;AAMA,MAAM,kBACJ,WACA,OAAO,YACP,OAAO,UAAU,YAAY,UAAU,MAAM,CAAC,MAAM,SAAS,KAAK,IAC/D,YAAY,QAAQ,IAAI,CAAC,EAAE,KAAK,yBAAyB,IACzD,YAAY,OAAO,OAAO,OAAO;;;;;;AAOtC,MAAM,gBAAgB,OAA8B,WACnD,QAAQ,cAAc,MAAM,KAAK,CAAC,MAAM,SAAS,MAAM,IAAI,CAAC,GAAG,OAAO,MAAM,IAAI,CAAC,GAAG,KAAK;;;;;;AAO1F,MAAM,iBACL,QACA,aACA,UACiB;CACjB,MAAM,CAAC,QAAQ,YAAY;CAC3B,MAAM,WAAW,MAAM,SAAS,aAAa;CAC7C,OAAO;EACN,MAAM;EACN,MAAM;EACN,UAAU;EACV,OAAO,YAAY,KAAK,qBAAqB;EAC7C,cAAc,UAAU,WAAW,cAAc;EACjD,GAAI,SAAS,EAAE,OAAO,IAAI,CAAC;EAC3B,GAAI,WACD;GACA,UAAU,eAAe,KAAK;GAC9B,gBAAgB,EAAE,WAAW,aAAa,OAAO,MAAM,QAAQ;EAChE,IACC,CAAC;EACJ,SAAS,aAAa,KAAK,UAAU;GACpC,OAAO,YAAY,eAAe,KAAK;GACvC,OAAO;EACR,EAAE;EAEF,OAAO;GAAE,UAAU;GAAW,aAAa,YAAY,KAAK,yBAAyB;EAAE;CACxF;AACD;;;;;AAMA,MAAM,uBAAuB,iBAA8C;CAC1E,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,2BAA2B;CACnD,SAAS,CACR;EAAE,OAAO,YAAY,KAAK,gCAAgC;EAAG,OAAO;CAAa,GACjF;EAAE,OAAO,YAAY,KAAK,yBAAyB;EAAG,OAAO;CAAM,CACpE;CACA,OAAO;EACN,YAAY,SAAS,QAAQ,cAAc,MAAM,QAAQ,KAAK,MAAM,aAAa;EACjF,aAAa,YAAY,KAAK,+BAA+B;CAC9D;AACD;AAEA,MAAM,sBAA6B;CAClC,MAAM;CACN,MAAM;CACN,cAAc;CACd,OAAO,YAAY,KAAK,oBAAoB;CAC5C,OAAO;EAAE,UAAU;EAAW,aAAa,YAAY,KAAK,wBAAwB;CAAE;AACvF;AAEA,MAAM,kBAAkB,YAAsD;CAC7E,MAAM;CACN,MAAM;CACN,cAAc;CACd,OAAO,YAAY,KAAK,sBAAsB;CAC9C,GAAI,SAAS,EAAE,OAAO,IAAI,CAAC;CAC3B,OAAO;EAAE,UAAU;EAAW,aAAa,YAAY,KAAK,0BAA0B;CAAE;AACzF;;;;;AAMA,MAAM,sBAAsB,SAAqE;CAChG,OAAO,OAAO,EAAE,MAAM,aAAa,UAAU;EAC5C,KAAK,MAAM,aAAa,aAAa,eAAe,MACnD,OAAO;EAER,IAAI,MAAM,aAAa,MAAM;GAAE;GAAM;GAAa;EAAI,GAAG,EAAE,WAAW,EAAE,QAAQ,KAAK,EAAE,CAAC,GACvF,MAAM,IAAI,gBACT;GACC,YAAY,KAAK;GACjB,QAAQ,CACP;IACC,OAAO,YAAY,KAAK,sBAAsB;IAC9C,SAAS,YAAY,IAAI,CAAC,EAAE,KAAK,yBAAyB;IAC1D,MAAM;GACP,CACD;GACA;EACD,GACA,IAAI,CACL;EAED,OAAO;CACR;AACD;;;;;AA0CA,MAAa,2BAA2B,UAAiC,CAAC,MACzE,eAAe,SAAS,oBAAoB,EAC3C,OAAO,oBAAoB,sCAAsC,QAAQ,KAAK,EAC/E,CAAC;AAEF,MAAM,kBACL,SACA,aACA,SACa;CACb,MAAM,cAAc,QAAQ,eAAe;CAC3C,MAAM,SAAS,sBACd,iDACA,QAAQ,gBACT;CACA,MAAM,sBAAsB,QAAQ,wBAAwB;CAC5D,MAAM,EAAE,UAAU;CAClB,MAAM,aAAa,aAA8B,QAAQ;EAAE;EAAU;CAAM,IAAI,KAAA;CAC/E,MAAM,eAAe,EACpB,UACA,OAAO,KAAK,4BAIT,CAAC,MACJ,YAAY,aAAa,aAAa;EACrC,MAAM;EACN,OAAO,KAAK;EACZ;EACA,OAAO;EACP,GAAI,WAAW,EAAE,SAAS,IAAI,CAAC;CAChC,CAAC;CACF,OAAO;EACN,cAAc,UAAU,GAAG,QAAQ,QAAQ,IAAI;EAC/C,cAAc,cAAc,QAAQ,aAAa,KAAK,KAAK,GAAG,QAAQ,QAAQ,QAAQ;EACtF,cAAc,aAAa,GAAG,QAAQ,QAAQ,OAAO;EACrD,GAAI,KAAK,YAAY,CAAC,KAAK,SAAS,IAAI,CAAC;EACzC,GAAG,WAAW,QAAQ,eAAe,IAAI;EACzC,WAAW;EACX,cAAc,aAAa,KAAK,uBAAuB;GACtD;IACC,MAAM;IACN,QAAQ,CACP,UAAU,UAAU,KAAK,qBAAqB;KAC7C,OAAO;KACP,MAAM,KAAK;KACX;KACA,UAAU;IACX,CAAC,GACD,GAAG,YAAY,CAChB;GACD;GACA;IACC,MAAM;IACN,QAAQ,CACP,aAAa,UAAU,KAAK,qBAAqB;KAChD,OAAO;KACP,MAAM,KAAK;KACX,UAAU;IACX,CAAC,GACD,aAAa,YAAY,KAAK,uBAAuB;KACpD,OAAO;KACP,MAAM,KAAK;KACX,UAAU;IACX,CAAC,CACF;GACD;GACA,cAAc,mBAAmB,KAAK,gCAAgC;GACtE,UAAU,qBAAqB,QAAQ,EAAE,QAAQ,UAAU,WAAW,EAAE,CAAC;EAC1E,CAAC;EACD,cAAc,SAAS,KAAK,mBAAmB;GAC9C;IACC,MAAM;IACN,QAAQ,CACP,UAAU,aAAa,KAAK,wBAAwB;KACnD,OAAO;KACP,MAAM,KAAK;KACX;IACD,CAAC,GACD,GAAG,YAAY,EAAE,MAAM,KAAK,6BAA6B,CAAC,CAC3D;GACD;GACA,GAAG,YAAY,aAAa,aAAa;IACxC,MAAM;IACN,OAAO,KAAK;IACZ,MAAM,KAAK;GACZ,CAAC;GACD,UAAU,qBAAqB,QAAQ,EAAE,QAAQ,UAAU,OAAO,EAAE,CAAC;EACtE,CAAC;EACD,cAAc,OAAO,KAAK,iBAAiB;GAC1C;IACC,MAAM;IACN,QAAQ,CACP,UAAU,cAAc,KAAK,yBAAyB;KACrD,OAAO;KACP,MAAM,KAAK;KACX;KACA,UAAU;IACX,CAAC,GACD,UAAU,aAAa,KAAK,wBAAwB;KACnD,OAAO;KACP,MAAM,KAAK;KACX;IACD,CAAC,CACF;GACD;GACA,UAAU,eAAe,KAAK,0BAA0B;IACvD,MAAM,KAAK;IACX;GACD,CAAC;GACD,aAAa,iBAAiB,KAAK,4BAA4B;IAC9D,MAAM,KAAK;IACX,UAAU;GACX,CAAC;GACD,cAAc,YAAY,KAAK,4BAA4B;GAC3D,GAAG,YAAY;IACd,MAAM;IACN,MAAM;IACN,OAAO,YAAY,KAAK,uBAAuB;IAC/C,OAAO,EAAE,aAAa,YAAY,KAAK,2BAA2B,EAAE;GACrE,CAAC;EACF,CAAC;EACD,cAAc,WAAW,KAAK,qBAAqB;GAClD;IACC,MAAM;IACN,QAAQ,CACP,UAAU,aAAa,KAAK,wBAAwB;KACnD,OAAO;KACP,MAAM,KAAK;KACX;IACD,CAAC,GACD,GAAG,YAAY;KACd,UAAU;KACV,MAAM,KAAK;IACZ,CAAC,CACF;GACD;GACA;IACC,MAAM;IACN,QAAQ,CACP,aAAa,gBAAgB,KAAK,2BAA2B;KAC5D,OAAO;KACP,UAAU;IACX,CAAC,GACD;KACC,MAAM;KACN,MAAM;KACN,OAAO,YAAY,KAAK,mBAAmB;KAC3C,UAAU;KACV,SAAS,CACR;MAAE,OAAO;MAAM,OAAO;KAAK,GAC3B;MAAE,OAAO;MAAM,OAAO;KAAK,CAC5B;KACA,GAAI,SAAS,EAAE,OAAO,IAAI,CAAC;KAC3B,OAAO;MACN,OAAO;MACP,aAAa,YAAY,KAAK,uBAAuB;KACtD;IACD,CACD;GACD;GACA,UAAU,iBAAiB,KAAK,4BAA4B;IAC3D,MAAM,KAAK;IACX;GACD,CAAC;GACD,UAAU,qBAAqB,QAAQ,EACtC,UAAU,oBAAoB,qBAAqB,UAAU,SAAS,CAAC,EACxE,CAAC;EACF,CAAC;EACD,cAAc,oBAAoB,WAAW,GAAG,QAAQ,QAAQ,cAAc;CAC/E;AACD;;AAGA,MAAM,kBAAyB;CAC9B,MAAM;CACN,MAAM;CACN,OAAO;EACN,UAAU;EACV,YAAY,EAAE,OAAO,8BAA8B;EACnD,YAAY,SAAS,QAAQ,cAAc,MAAM,QAAQ,KAAK,MAAM,aAAa;CAClF;AACD;;;;;AAMA,MAAa,4BAA4B,SAAyD;CACjG,MAAM,cAAc,KAAK,eAAe;CACxC,MAAM,aAA+B;EACpC,MAAM,KAAK;EACX,QAAQ;GACP,UAAU,YAAY,KAAK,2BAA2B;GACtD,QAAQ,YAAY,KAAK,yBAAyB;EACnD;EACA,kBAAkB;EAClB,OAAO;GACN,YAAY;GACZ,gBAAgB;IAAC;IAAQ;IAAY;GAAS;GAC9C,OAAO,YAAY,KAAK,UAAU;GAClC,aAAa,YAAY,KAAK,8BAA8B;GAC5D,YAAY;IACX,GAAI,KAAK,aAAa,EAAE,YAAY,CAAC,+BAA+B,EAAE,IAAI,CAAC;IAC3E,MAAM,EAAE,wBAAwB,CAAC,kCAAkC,EAAE;GACtE;EACD;EACA,QAAQ;GACP,MAAM,kBAAkB,IAAI;GAC5B,QAAQ,qBAAqB,IAAI;GACjC,QAAQ,kBAAkB,IAAI;GAC9B,QAAQ,kBAAkB,IAAI;GAC9B,GAAG,KAAK;EACT;EACA,OAAO;GACN,GAAI,KAAK,SAAS,EAAE,gBAAgB,CAAC,mBAAmB,IAAI,CAAC,EAAE,IAAI,CAAC;GACpE,cAAc;IACb,WAAW,IAAI;KAGd,EAAE,SAAS,MAAM,WAAW,kBAAkB;KAC9C,IACC,cAAc,YACd,WAAW;MAAE,YAAY,KAAK;MAAY,UAAU,KAAK;MAAU;MAAM;KAAY,CAAC,GAEtF,cAAc,OAAO,EAAE,IAAI,OAAO,aAAa,EAAE,CAAC;KAEnD,OAAO;IACR;IACA,gBAAgB;KAAE,YAAY,KAAK;KAAY,UAAU,KAAK;IAAS,CAAC;GACzE;GACA,aAAa,CACZ,OAAO,EAAE,SAAS,KAAK,WAAW,aAAa,UAAU;IACxD,IAAI,cAAc,YAAY,cAAc,OAAO,EAAE,OAAO,OAAO,IAAI,EAAE,CAAC,GACzE,MAAM,KAAK,eAAe,OAAO,IAAI,EAAE,GAAG,GAAG;SACvC,IAAI,cAAc,UACxB,MAAM,KAAK,cACV,OAAO,IAAI,EAAE,GACb;KAAE,MAAM,UAAU,YAAY,SAAS;KAAG,IAAI,UAAU,IAAI,SAAS;IAAE,GACvE,GACD;IAED,MAAM,KAAK,SACV;KACC,OAAO,SAAS,KAAK,KAAK,UAAU;KACpC,GAAI,cAAc,WACf,EAAE,eAAe,SAAS,aAAa,KAAK,UAAU,EAAE,IACxD,CAAC;IACL,GACA,GACD;IACA,OAAO;GACR,CACD;GACA,aAAa,CACZ,OAAO,EAAE,KAAK,IAAI,UAAU;IAC3B,MAAM,KAAK,eAAe,OAAO,EAAE,GAAG,GAAG;IACzC,MAAM,KAAK,SAAS,EAAE,OAAO,SAAS,KAAK,KAAK,UAAU,EAAE,GAAG,GAAG;IAClE,OAAO;GACR,CACD;EACD;EACA,QAAQ,CACP,GAAG,eACF;GACC,aAAa,KAAK;GAClB,GAAI,KAAK,SAAS,EAAE,QAAQ,KAAK,OAAO,IAAI,CAAC;GAC7C,YAAY,KAAK,eAAe;GAChC,qBAAqB,KAAK,wBAAwB;GAClD,GAAI,KAAK,mBAAmB,EAAE,kBAAkB,KAAK,iBAAiB,IAAI,CAAC;EAC5E,GACA,aACA;GACC,OAAO,KAAK,SAAS;GACrB,GAAI,KAAK,QAAQ,EAAE,OAAO,KAAK,MAAM,IAAI,CAAC;GAE1C,GAAI,KAAK,SACN,EACA,WAAW,cACV,eAAe,KAAK,aAAa,GACjC,KAAK,QAAQ,SACd,EACD,IACC,CAAC;EACL,CACD,GACA,eACD;CACD;CACA,OAAO,KAAK,YAAY,KAAK,UAAU,UAAU,IAAI;AACtD"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import { Payload } from "payload";
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import { isUnknownSite } from "../core/sourceErrors.js";
|
|
2
|
+
import { classifyError, vendorAnswerOf } from "../surfacing/classifyError.js";
|
|
3
|
+
//#region src/providers/connectionCheck.ts
|
|
4
|
+
/** How long a connection check waits for the vendor before it counts as unreachable. */
|
|
5
|
+
const CONNECTION_CHECK_TIMEOUT_MS = 1e4;
|
|
6
|
+
/**
|
|
7
|
+
* What a check's failure says about the connection: a vendor refusing the cheapest read it has is
|
|
8
|
+
* set up wrong whatever its status code, so only an outage stays `unavailable`.
|
|
9
|
+
*/
|
|
10
|
+
const checkFailureOf = (err) => {
|
|
11
|
+
const failure = classifyError(err);
|
|
12
|
+
const vendorAnswer = failure.hostRefused ? void 0 : vendorAnswerOf(err);
|
|
13
|
+
return {
|
|
14
|
+
ok: false,
|
|
15
|
+
kind: failure.kind === "unavailable" ? "unavailable" : "source_misconfigured",
|
|
16
|
+
...isUnknownSite(err) ? { reason: "unknownSite" } : {},
|
|
17
|
+
...vendorAnswer === void 0 ? {} : { detail: vendorAnswer }
|
|
18
|
+
};
|
|
19
|
+
};
|
|
20
|
+
/** What a provider document's check found; an incomplete document is refused without asking the vendor. */
|
|
21
|
+
const checkConnectionOf = async (payload, adapter) => {
|
|
22
|
+
if (!adapter.isConfigured()) return {
|
|
23
|
+
ok: false,
|
|
24
|
+
kind: "source_misconfigured",
|
|
25
|
+
reason: "incomplete"
|
|
26
|
+
};
|
|
27
|
+
try {
|
|
28
|
+
await adapter.checkConnection?.({
|
|
29
|
+
signal: AbortSignal.timeout(CONNECTION_CHECK_TIMEOUT_MS),
|
|
30
|
+
timeoutMs: CONNECTION_CHECK_TIMEOUT_MS,
|
|
31
|
+
payload
|
|
32
|
+
});
|
|
33
|
+
return { ok: true };
|
|
34
|
+
} catch (err) {
|
|
35
|
+
return checkFailureOf(err);
|
|
36
|
+
}
|
|
37
|
+
};
|
|
38
|
+
/**
|
|
39
|
+
* Background checks of failing provider documents, at most one per document per `cooldownMs`, so
|
|
40
|
+
* a document that cannot be checked (a refused host, a key that will not decrypt) is not rebuilt
|
|
41
|
+
* on every read.
|
|
42
|
+
*/
|
|
43
|
+
const createConnectionRecheck = (args) => {
|
|
44
|
+
const startedAt = /* @__PURE__ */ new Map();
|
|
45
|
+
const running = /* @__PURE__ */ new Set();
|
|
46
|
+
return {
|
|
47
|
+
request(docId) {
|
|
48
|
+
const at = args.now();
|
|
49
|
+
const last = startedAt.get(docId);
|
|
50
|
+
if (last !== void 0 && at - last < args.cooldownMs) return;
|
|
51
|
+
for (const [seen, when] of startedAt) if (at - when >= args.cooldownMs) startedAt.delete(seen);
|
|
52
|
+
startedAt.set(docId, at);
|
|
53
|
+
const check = async () => {
|
|
54
|
+
const adapter = await args.adapterFor(docId);
|
|
55
|
+
if (!adapter?.checkConnection) return;
|
|
56
|
+
try {
|
|
57
|
+
const version = args.versionOf?.(adapter);
|
|
58
|
+
await args.store.record(docId, await checkConnectionOf(args.payload, adapter), version === void 0 ? {} : { version });
|
|
59
|
+
} finally {
|
|
60
|
+
await adapter.close?.(args.payload);
|
|
61
|
+
}
|
|
62
|
+
};
|
|
63
|
+
const run = check().catch((err) => {
|
|
64
|
+
args.warn(`analytics: checking provider document "${docId}" again failed: ${String(err)}`);
|
|
65
|
+
});
|
|
66
|
+
running.add(run);
|
|
67
|
+
run.finally(() => running.delete(run));
|
|
68
|
+
},
|
|
69
|
+
idle: async () => {
|
|
70
|
+
await Promise.all(running);
|
|
71
|
+
},
|
|
72
|
+
get size() {
|
|
73
|
+
return startedAt.size;
|
|
74
|
+
}
|
|
75
|
+
};
|
|
76
|
+
};
|
|
77
|
+
//#endregion
|
|
78
|
+
export { checkConnectionOf, createConnectionRecheck };
|
|
79
|
+
|
|
80
|
+
//# sourceMappingURL=connectionCheck.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"connectionCheck.js","names":[],"sources":["../../src/providers/connectionCheck.ts"],"sourcesContent":["import type { Payload } from 'payload'\nimport type { AnalyticsAdapter } from '../core/contract'\nimport { isUnknownSite } from '../core/sourceErrors'\nimport { classifyError, vendorAnswerOf } from '../surfacing/classifyError'\nimport type { ConnectionOutcome } from './connectionState'\nimport type { ProviderStatusStore } from './status'\n\n/** How long a connection check waits for the vendor before it counts as unreachable. */\nconst CONNECTION_CHECK_TIMEOUT_MS = 10_000\n\n/**\n * What a check's failure says about the connection: a vendor refusing the cheapest read it has is\n * set up wrong whatever its status code, so only an outage stays `unavailable`.\n */\nconst checkFailureOf = (err: unknown): ConnectionOutcome => {\n\tconst failure = classifyError(err)\n\tconst vendorAnswer = failure.hostRefused ? undefined : vendorAnswerOf(err)\n\treturn {\n\t\tok: false,\n\t\tkind: failure.kind === 'unavailable' ? 'unavailable' : 'source_misconfigured',\n\t\t...(isUnknownSite(err) ? { reason: 'unknownSite' } : {}),\n\t\t...(vendorAnswer === undefined ? {} : { detail: vendorAnswer }),\n\t}\n}\n\n/** What a provider document's check found; an incomplete document is refused without asking the vendor. */\nexport const checkConnectionOf = async (\n\tpayload: Payload,\n\tadapter: AnalyticsAdapter\n): Promise<ConnectionOutcome> => {\n\tif (!adapter.isConfigured()) {\n\t\treturn { ok: false, kind: 'source_misconfigured', reason: 'incomplete' }\n\t}\n\ttry {\n\t\tawait adapter.checkConnection?.({\n\t\t\tsignal: AbortSignal.timeout(CONNECTION_CHECK_TIMEOUT_MS),\n\t\t\ttimeoutMs: CONNECTION_CHECK_TIMEOUT_MS,\n\t\t\tpayload,\n\t\t})\n\t\treturn { ok: true }\n\t} catch (err) {\n\t\treturn checkFailureOf(err)\n\t}\n}\n\n/** Checks of failing provider documents that run without anyone waiting on them. */\nexport interface ConnectionRecheck {\n\t/** Starts a check of `docId` and writes what it found, unless one started within the cooldown. */\n\trequest(docId: string): void\n\t/** Waits for the checks still running, for a runtime that closes or a test that settles. */\n\tidle(): Promise<void>\n\t/** Documents currently held, which is one cooldown's distinct documents at most. */\n\treadonly size: number\n}\n\n/**\n * Background checks of failing provider documents, at most one per document per `cooldownMs`, so\n * a document that cannot be checked (a refused host, a key that will not decrypt) is not rebuilt\n * on every read.\n */\nexport const createConnectionRecheck = (args: {\n\tpayload: Payload\n\tstore: ProviderStatusStore\n\tadapterFor: (docId: string) => Promise<AnalyticsAdapter | null>\n\t/** The saved version of the document an adapter was built from, stamped on what it found. */\n\tversionOf?: (adapter: AnalyticsAdapter) => string | undefined\n\tnow: () => number\n\tcooldownMs: number\n\twarn: (message: string) => void\n}): ConnectionRecheck => {\n\tconst startedAt = new Map<string, number>()\n\tconst running = new Set<Promise<void>>()\n\treturn {\n\t\trequest(docId) {\n\t\t\tconst at = args.now()\n\t\t\tconst last = startedAt.get(docId)\n\t\t\tif (last !== undefined && at - last < args.cooldownMs) {\n\t\t\t\treturn\n\t\t\t}\n\t\t\tfor (const [seen, when] of startedAt) {\n\t\t\t\tif (at - when >= args.cooldownMs) {\n\t\t\t\t\tstartedAt.delete(seen)\n\t\t\t\t}\n\t\t\t}\n\t\t\tstartedAt.set(docId, at)\n\t\t\tconst check = async () => {\n\t\t\t\tconst adapter = await args.adapterFor(docId)\n\t\t\t\t// Nothing to check, and nothing to close: a native document's adapter is the\n\t\t\t\t// instance's engine, lent rather than built for the check.\n\t\t\t\tif (!adapter?.checkConnection) {\n\t\t\t\t\treturn\n\t\t\t\t}\n\t\t\t\ttry {\n\t\t\t\t\tconst version = args.versionOf?.(adapter)\n\t\t\t\t\tawait args.store.record(\n\t\t\t\t\t\tdocId,\n\t\t\t\t\t\tawait checkConnectionOf(args.payload, adapter),\n\t\t\t\t\t\tversion === undefined ? {} : { version }\n\t\t\t\t\t)\n\t\t\t\t} finally {\n\t\t\t\t\tawait adapter.close?.(args.payload)\n\t\t\t\t}\n\t\t\t}\n\t\t\tconst run = check().catch((err: unknown) => {\n\t\t\t\targs.warn(`analytics: checking provider document \"${docId}\" again failed: ${String(err)}`)\n\t\t\t})\n\t\t\trunning.add(run)\n\t\t\tvoid run.finally(() => running.delete(run))\n\t\t},\n\t\tidle: async () => {\n\t\t\tawait Promise.all(running)\n\t\t},\n\t\tget size() {\n\t\t\treturn startedAt.size\n\t\t},\n\t}\n}\n"],"mappings":";;;;AAQA,MAAM,8BAA8B;;;;;AAMpC,MAAM,kBAAkB,QAAoC;CAC3D,MAAM,UAAU,cAAc,GAAG;CACjC,MAAM,eAAe,QAAQ,cAAc,KAAA,IAAY,eAAe,GAAG;CACzE,OAAO;EACN,IAAI;EACJ,MAAM,QAAQ,SAAS,gBAAgB,gBAAgB;EACvD,GAAI,cAAc,GAAG,IAAI,EAAE,QAAQ,cAAc,IAAI,CAAC;EACtD,GAAI,iBAAiB,KAAA,IAAY,CAAC,IAAI,EAAE,QAAQ,aAAa;CAC9D;AACD;;AAGA,MAAa,oBAAoB,OAChC,SACA,YACgC;CAChC,IAAI,CAAC,QAAQ,aAAa,GACzB,OAAO;EAAE,IAAI;EAAO,MAAM;EAAwB,QAAQ;CAAa;CAExE,IAAI;EACH,MAAM,QAAQ,kBAAkB;GAC/B,QAAQ,YAAY,QAAQ,2BAA2B;GACvD,WAAW;GACX;EACD,CAAC;EACD,OAAO,EAAE,IAAI,KAAK;CACnB,SAAS,KAAK;EACb,OAAO,eAAe,GAAG;CAC1B;AACD;;;;;;AAiBA,MAAa,2BAA2B,SASf;CACxB,MAAM,4BAAY,IAAI,IAAoB;CAC1C,MAAM,0BAAU,IAAI,IAAmB;CACvC,OAAO;EACN,QAAQ,OAAO;GACd,MAAM,KAAK,KAAK,IAAI;GACpB,MAAM,OAAO,UAAU,IAAI,KAAK;GAChC,IAAI,SAAS,KAAA,KAAa,KAAK,OAAO,KAAK,YAC1C;GAED,KAAK,MAAM,CAAC,MAAM,SAAS,WAC1B,IAAI,KAAK,QAAQ,KAAK,YACrB,UAAU,OAAO,IAAI;GAGvB,UAAU,IAAI,OAAO,EAAE;GACvB,MAAM,QAAQ,YAAY;IACzB,MAAM,UAAU,MAAM,KAAK,WAAW,KAAK;IAG3C,IAAI,CAAC,SAAS,iBACb;IAED,IAAI;KACH,MAAM,UAAU,KAAK,YAAY,OAAO;KACxC,MAAM,KAAK,MAAM,OAChB,OACA,MAAM,kBAAkB,KAAK,SAAS,OAAO,GAC7C,YAAY,KAAA,IAAY,CAAC,IAAI,EAAE,QAAQ,CACxC;IACD,UAAU;KACT,MAAM,QAAQ,QAAQ,KAAK,OAAO;IACnC;GACD;GACA,MAAM,MAAM,MAAM,EAAE,OAAO,QAAiB;IAC3C,KAAK,KAAK,0CAA0C,MAAM,kBAAkB,OAAO,GAAG,GAAG;GAC1F,CAAC;GACD,QAAQ,IAAI,GAAG;GACf,IAAS,cAAc,QAAQ,OAAO,GAAG,CAAC;EAC3C;EACA,MAAM,YAAY;GACjB,MAAM,QAAQ,IAAI,OAAO;EAC1B;EACA,IAAI,OAAO;GACV,OAAO,UAAU;EAClB;CACD;AACD"}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import { isRecord } from "../core/values.js";
|
|
2
|
+
import { PROVIDER_IDS } from "./ids.js";
|
|
3
|
+
//#region src/providers/connectionState.ts
|
|
4
|
+
const CONNECTION_FAILURE_REASONS = ["incomplete", "unknownSite"];
|
|
5
|
+
/** A stored reason as the type it names, or undefined for any other value. */
|
|
6
|
+
const connectionFailureReasonOf = (value) => CONNECTION_FAILURE_REASONS.find((reason) => reason === value);
|
|
7
|
+
const timeOf = (iso) => {
|
|
8
|
+
const at = iso === void 0 ? NaN : Date.parse(iso);
|
|
9
|
+
return Number.isNaN(at) ? void 0 : at;
|
|
10
|
+
};
|
|
11
|
+
/** The later of the last success and the last failure decides; neither yet is unchecked. */
|
|
12
|
+
const connectionStateOf = (status) => {
|
|
13
|
+
const success = timeOf(status.lastSuccessAt);
|
|
14
|
+
const failure = timeOf(status.lastErrorAt);
|
|
15
|
+
if (failure !== void 0 && (success === void 0 || failure > success)) return status.errorKind === "unavailable" ? "unreachable" : "refused";
|
|
16
|
+
return success === void 0 ? "unchecked" : "works";
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* Whether a document's source counts as failing, for a `fallback` policy to stand in for it:
|
|
20
|
+
* refused until a read or a check works again, unreachable only while its reads rest, so one slow
|
|
21
|
+
* answer moves no one off their own numbers.
|
|
22
|
+
*/
|
|
23
|
+
const isFailingConnection = (status, now) => {
|
|
24
|
+
const state = connectionStateOf(status);
|
|
25
|
+
return state === "refused" || state === "unreachable" && (timeOf(status.pausedUntil) ?? 0) > now;
|
|
26
|
+
};
|
|
27
|
+
const isOptionalString = (value) => value === void 0 || typeof value === "string";
|
|
28
|
+
/** Whether a body is the endpoint's answer; the fields the form reads are checked, the rest kept. */
|
|
29
|
+
const isProviderStatusResponse = (value) => isRecord(value) && isRecord(value.status) && [
|
|
30
|
+
"lastSuccessAt",
|
|
31
|
+
"lastErrorAt",
|
|
32
|
+
"errorKind",
|
|
33
|
+
"errorReason",
|
|
34
|
+
"errorDetail",
|
|
35
|
+
"pausedUntil"
|
|
36
|
+
].every((key) => isOptionalString(isRecord(value.status) ? value.status[key] : void 0)) && (value.checked === void 0 || isRecord(value.checked) && typeof value.checked.ok === "boolean");
|
|
37
|
+
/**
|
|
38
|
+
* `posthog: HTTP 403 Bad key`, as `fetchJson` words a refusal, into its parts; any other text is
|
|
39
|
+
* the message as it is.
|
|
40
|
+
*/
|
|
41
|
+
const vendorWordsOf = (detail) => {
|
|
42
|
+
const match = /^([a-z0-9]+): HTTP (\d{3})\s*([\s\S]*)$/.exec(detail);
|
|
43
|
+
const provider = PROVIDER_IDS.find((id) => id === match?.[1]);
|
|
44
|
+
if (!match || !provider) return { message: detail.trim() };
|
|
45
|
+
return {
|
|
46
|
+
provider,
|
|
47
|
+
message: (match[3] ?? "").trim()
|
|
48
|
+
};
|
|
49
|
+
};
|
|
50
|
+
//#endregion
|
|
51
|
+
export { connectionFailureReasonOf, connectionStateOf, isFailingConnection, isProviderStatusResponse, vendorWordsOf };
|
|
52
|
+
|
|
53
|
+
//# sourceMappingURL=connectionState.js.map
|