@ontrails/config 1.0.0-beta.12
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/.turbo/turbo-build.log +1 -0
- package/.turbo/turbo-lint.log +3 -0
- package/.turbo/turbo-typecheck.log +1 -0
- package/CHANGELOG.md +19 -0
- package/dist/app-config.d.ts +65 -0
- package/dist/app-config.d.ts.map +1 -0
- package/dist/app-config.js +172 -0
- package/dist/app-config.js.map +1 -0
- package/dist/collect.d.ts +11 -0
- package/dist/collect.d.ts.map +1 -0
- package/dist/collect.js +81 -0
- package/dist/collect.js.map +1 -0
- package/dist/compose.d.ts +26 -0
- package/dist/compose.d.ts.map +1 -0
- package/dist/compose.js +19 -0
- package/dist/compose.js.map +1 -0
- package/dist/config-layer.d.ts +11 -0
- package/dist/config-layer.d.ts.map +1 -0
- package/dist/config-layer.js +6 -0
- package/dist/config-layer.js.map +1 -0
- package/dist/config-service.d.ts +3 -0
- package/dist/config-service.d.ts.map +1 -0
- package/dist/config-service.js +26 -0
- package/dist/config-service.js.map +1 -0
- package/dist/define-config.d.ts +61 -0
- package/dist/define-config.d.ts.map +1 -0
- package/dist/define-config.js +90 -0
- package/dist/define-config.js.map +1 -0
- package/dist/describe.d.ts +25 -0
- package/dist/describe.d.ts.map +1 -0
- package/dist/describe.js +147 -0
- package/dist/describe.js.map +1 -0
- package/dist/doctor.d.ts +27 -0
- package/dist/doctor.d.ts.map +1 -0
- package/dist/doctor.js +167 -0
- package/dist/doctor.js.map +1 -0
- package/dist/explain.d.ts +30 -0
- package/dist/explain.d.ts.map +1 -0
- package/dist/explain.js +114 -0
- package/dist/explain.js.map +1 -0
- package/dist/extensions.d.ts +38 -0
- package/dist/extensions.d.ts.map +1 -0
- package/dist/extensions.js +35 -0
- package/dist/extensions.js.map +1 -0
- package/dist/generate/env.d.ts +15 -0
- package/dist/generate/env.d.ts.map +1 -0
- package/dist/generate/env.js +65 -0
- package/dist/generate/env.js.map +1 -0
- package/dist/generate/example.d.ts +16 -0
- package/dist/generate/example.d.ts.map +1 -0
- package/dist/generate/example.js +136 -0
- package/dist/generate/example.js.map +1 -0
- package/dist/generate/helpers.d.ts +35 -0
- package/dist/generate/helpers.d.ts.map +1 -0
- package/dist/generate/helpers.js +116 -0
- package/dist/generate/helpers.js.map +1 -0
- package/dist/generate/index.d.ts +4 -0
- package/dist/generate/index.d.ts.map +1 -0
- package/dist/generate/index.js +4 -0
- package/dist/generate/index.js.map +1 -0
- package/dist/generate/json-schema.d.ts +18 -0
- package/dist/generate/json-schema.d.ts.map +1 -0
- package/dist/generate/json-schema.js +97 -0
- package/dist/generate/json-schema.js.map +1 -0
- package/dist/index.d.ts +21 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +21 -0
- package/dist/index.js.map +1 -0
- package/dist/merge.d.ts +16 -0
- package/dist/merge.d.ts.map +1 -0
- package/dist/merge.js +34 -0
- package/dist/merge.js.map +1 -0
- package/dist/ref.d.ts +24 -0
- package/dist/ref.d.ts.map +1 -0
- package/dist/ref.js +25 -0
- package/dist/ref.js.map +1 -0
- package/dist/registry.d.ts +24 -0
- package/dist/registry.d.ts.map +1 -0
- package/dist/registry.js +12 -0
- package/dist/registry.js.map +1 -0
- package/dist/resolve.d.ts +21 -0
- package/dist/resolve.d.ts.map +1 -0
- package/dist/resolve.js +174 -0
- package/dist/resolve.js.map +1 -0
- package/dist/secret-heuristics.d.ts +10 -0
- package/dist/secret-heuristics.d.ts.map +1 -0
- package/dist/secret-heuristics.js +11 -0
- package/dist/secret-heuristics.js.map +1 -0
- package/dist/trails/config-check.d.ts +11 -0
- package/dist/trails/config-check.d.ts.map +1 -0
- package/dist/trails/config-check.js +53 -0
- package/dist/trails/config-check.js.map +1 -0
- package/dist/trails/config-describe.d.ts +12 -0
- package/dist/trails/config-describe.d.ts.map +1 -0
- package/dist/trails/config-describe.js +41 -0
- package/dist/trails/config-describe.js.map +1 -0
- package/dist/trails/config-explain.d.ts +8 -0
- package/dist/trails/config-explain.d.ts.map +1 -0
- package/dist/trails/config-explain.js +74 -0
- package/dist/trails/config-explain.js.map +1 -0
- package/dist/trails/config-init.d.ts +9 -0
- package/dist/trails/config-init.d.ts.map +1 -0
- package/dist/trails/config-init.js +78 -0
- package/dist/trails/config-init.js.map +1 -0
- package/dist/workspace.d.ts +9 -0
- package/dist/workspace.d.ts.map +1 -0
- package/dist/workspace.js +44 -0
- package/dist/workspace.js.map +1 -0
- package/dist/zod-utils.d.ts +14 -0
- package/dist/zod-utils.d.ts.map +1 -0
- package/dist/zod-utils.js +41 -0
- package/dist/zod-utils.js.map +1 -0
- package/package.json +20 -0
- package/src/__tests__/app-config.test.ts +329 -0
- package/src/__tests__/compose.test.ts +59 -0
- package/src/__tests__/config-check.test.ts +171 -0
- package/src/__tests__/config-describe.test.ts +154 -0
- package/src/__tests__/config-explain.test.ts +167 -0
- package/src/__tests__/config-init.test.ts +210 -0
- package/src/__tests__/config-layer.test.ts +53 -0
- package/src/__tests__/config-service.test.ts +87 -0
- package/src/__tests__/define-config.test.ts +263 -0
- package/src/__tests__/describe.test.ts +158 -0
- package/src/__tests__/doctor.test.ts +172 -0
- package/src/__tests__/explain.test.ts +139 -0
- package/src/__tests__/extensions.test.ts +134 -0
- package/src/__tests__/generate.test.ts +269 -0
- package/src/__tests__/ref.test.ts +35 -0
- package/src/__tests__/resolve.test.ts +246 -0
- package/src/__tests__/workspace.test.ts +64 -0
- package/src/app-config.ts +307 -0
- package/src/collect.ts +118 -0
- package/src/compose.ts +46 -0
- package/src/config-layer.ts +15 -0
- package/src/config-service.ts +32 -0
- package/src/define-config.ts +134 -0
- package/src/describe.ts +252 -0
- package/src/doctor.ts +219 -0
- package/src/explain.ts +176 -0
- package/src/extensions.ts +51 -0
- package/src/generate/env.ts +104 -0
- package/src/generate/example.ts +222 -0
- package/src/generate/helpers.ts +158 -0
- package/src/generate/index.ts +3 -0
- package/src/generate/json-schema.ts +137 -0
- package/src/index.ts +44 -0
- package/src/merge.ts +43 -0
- package/src/ref.ts +38 -0
- package/src/registry.ts +33 -0
- package/src/resolve.ts +279 -0
- package/src/secret-heuristics.ts +13 -0
- package/src/trails/config-check.ts +60 -0
- package/src/trails/config-describe.ts +44 -0
- package/src/trails/config-explain.ts +93 -0
- package/src/trails/config-init.ts +96 -0
- package/src/workspace.ts +51 -0
- package/src/zod-utils.ts +53 -0
- package/tsconfig.json +9 -0
- package/tsconfig.tsbuildinfo +1 -0
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Trails-specific config wrapper — `appConfig('trails', ...)` with
|
|
3
|
+
* framework conventions for loadout selection and local overrides.
|
|
4
|
+
*/
|
|
5
|
+
import { existsSync } from 'node:fs';
|
|
6
|
+
import { join } from 'node:path';
|
|
7
|
+
import { appConfig } from './app-config.js';
|
|
8
|
+
import { resolveConfig } from './resolve.js';
|
|
9
|
+
// ---------------------------------------------------------------------------
|
|
10
|
+
// Local overrides discovery
|
|
11
|
+
// ---------------------------------------------------------------------------
|
|
12
|
+
const LOCAL_OVERRIDE_CANDIDATES = ['local.ts', 'local.js'];
|
|
13
|
+
/**
|
|
14
|
+
* Discover and synchronously import a `.trails/config/local.{ts,js}` file.
|
|
15
|
+
*
|
|
16
|
+
* Skipped when `TRAILS_ENV=test` for hermetic test environments.
|
|
17
|
+
*/
|
|
18
|
+
const discoverLocalOverrides = async (cwd, envRecord) => {
|
|
19
|
+
if (envRecord['TRAILS_ENV'] === 'test') {
|
|
20
|
+
return undefined;
|
|
21
|
+
}
|
|
22
|
+
for (const filename of LOCAL_OVERRIDE_CANDIDATES) {
|
|
23
|
+
const candidate = join(cwd, '.trails', 'config', filename);
|
|
24
|
+
if (existsSync(candidate)) {
|
|
25
|
+
const mod = await import(candidate);
|
|
26
|
+
return (mod['default'] ?? mod);
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
return undefined;
|
|
30
|
+
};
|
|
31
|
+
// ---------------------------------------------------------------------------
|
|
32
|
+
// Public API
|
|
33
|
+
// ---------------------------------------------------------------------------
|
|
34
|
+
/**
|
|
35
|
+
* Define Trails app config.
|
|
36
|
+
*
|
|
37
|
+
* This is `appConfig('trails', ...)` with the framework's own conventions:
|
|
38
|
+
* `TRAILS_ENV` selects the loadout. When `envFromNodeEnv` is true,
|
|
39
|
+
* `NODE_ENV` is used as a fallback when `TRAILS_ENV` is unset.
|
|
40
|
+
*
|
|
41
|
+
* @example
|
|
42
|
+
* ```ts
|
|
43
|
+
* const config = defineConfig({
|
|
44
|
+
* schema: z.object({
|
|
45
|
+
* port: z.number().default(3000),
|
|
46
|
+
* debug: z.boolean().default(false),
|
|
47
|
+
* }),
|
|
48
|
+
* base: { port: 8080 },
|
|
49
|
+
* loadouts: {
|
|
50
|
+
* production: { debug: false },
|
|
51
|
+
* test: { debug: true, port: 0 },
|
|
52
|
+
* },
|
|
53
|
+
* });
|
|
54
|
+
*
|
|
55
|
+
* const result = config.resolve();
|
|
56
|
+
* ```
|
|
57
|
+
*/
|
|
58
|
+
export const defineConfig = (options) => {
|
|
59
|
+
const config = appConfig('trails', {
|
|
60
|
+
formats: ['toml', 'json'],
|
|
61
|
+
schema: options.schema,
|
|
62
|
+
});
|
|
63
|
+
return {
|
|
64
|
+
...config,
|
|
65
|
+
base: options.base,
|
|
66
|
+
loadouts: options.loadouts,
|
|
67
|
+
resolve: async (resolveOpts) => {
|
|
68
|
+
const envRecord = {
|
|
69
|
+
...(resolveOpts?.env ?? process.env),
|
|
70
|
+
};
|
|
71
|
+
if (options.envFromNodeEnv &&
|
|
72
|
+
envRecord['TRAILS_ENV'] === undefined &&
|
|
73
|
+
envRecord['NODE_ENV'] !== undefined) {
|
|
74
|
+
envRecord['TRAILS_ENV'] = envRecord['NODE_ENV'];
|
|
75
|
+
}
|
|
76
|
+
const cwd = resolveOpts?.cwd ?? process.cwd();
|
|
77
|
+
const localOverrides = await discoverLocalOverrides(cwd, envRecord);
|
|
78
|
+
return resolveConfig({
|
|
79
|
+
base: options.base,
|
|
80
|
+
env: envRecord,
|
|
81
|
+
loadout: resolveOpts?.loadout ?? envRecord['TRAILS_ENV'],
|
|
82
|
+
loadouts: options.loadouts,
|
|
83
|
+
localOverrides,
|
|
84
|
+
schema: options.schema,
|
|
85
|
+
});
|
|
86
|
+
},
|
|
87
|
+
schema: options.schema,
|
|
88
|
+
};
|
|
89
|
+
};
|
|
90
|
+
//# sourceMappingURL=define-config.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"define-config.js","sourceRoot":"","sources":["../src/define-config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAIjC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAuB7C,8EAA8E;AAC9E,4BAA4B;AAC5B,8EAA8E;AAE9E,MAAM,yBAAyB,GAAG,CAAC,UAAU,EAAE,UAAU,CAAU,CAAC;AAEpE;;;;GAIG;AACH,MAAM,sBAAsB,GAAG,KAAK,EAClC,GAAW,EACX,SAA6C,EACC,EAAE;IAChD,IAAI,SAAS,CAAC,YAAY,CAAC,KAAK,MAAM,EAAE,CAAC;QACvC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,KAAK,MAAM,QAAQ,IAAI,yBAAyB,EAAE,CAAC;QACjD,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC3D,IAAI,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1B,MAAM,GAAG,GAA4B,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC;YAC7D,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,GAAG,CAA4B,CAAC;QAC5D,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,8EAA8E;AAC9E,aAAa;AACb,8EAA8E;AAE9E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,OAA+B,EAC/B,EAAE;IACF,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,EAAE;QACjC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;QACzB,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAC;IAEH,OAAO;QACL,GAAG,MAAM;QACT,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,OAAO,EAAE,KAAK,EAAE,WAAwC,EAAE,EAAE;YAC1D,MAAM,SAAS,GAAG;gBAChB,GAAG,CAAC,WAAW,EAAE,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;aACC,CAAC;YAExC,IACE,OAAO,CAAC,cAAc;gBACtB,SAAS,CAAC,YAAY,CAAC,KAAK,SAAS;gBACrC,SAAS,CAAC,UAAU,CAAC,KAAK,SAAS,EACnC,CAAC;gBACD,SAAS,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;YAClD,CAAC;YAED,MAAM,GAAG,GAAG,WAAW,EAAE,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;YAC9C,MAAM,cAAc,GAAG,MAAM,sBAAsB,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YAEpE,OAAO,aAAa,CAAC;gBACnB,IAAI,EAAE,OAAO,CAAC,IAA2C;gBACzD,GAAG,EAAE,SAAS;gBACd,OAAO,EAAE,WAAW,EAAE,OAAO,IAAI,SAAS,CAAC,YAAY,CAAC;gBACxD,QAAQ,EAAE,OAAO,CAAC,QAEL;gBACb,cAAc;gBACd,MAAM,EAAE,OAAO,CAAC,MAAM;aACvB,CAAC,CAAC;QACL,CAAC;QACD,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC;AACJ,CAAC,CAAC"}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Config introspection — describe all fields in a schema without values.
|
|
3
|
+
*
|
|
4
|
+
* Returns a structured catalog suitable for CLI rendering or agent inspection.
|
|
5
|
+
*/
|
|
6
|
+
import type { z } from 'zod';
|
|
7
|
+
/** Description of a single config field. */
|
|
8
|
+
export interface FieldDescription {
|
|
9
|
+
readonly path: string;
|
|
10
|
+
readonly type: string;
|
|
11
|
+
readonly description?: string;
|
|
12
|
+
readonly default?: unknown;
|
|
13
|
+
readonly required: boolean;
|
|
14
|
+
readonly env?: string;
|
|
15
|
+
readonly secret?: boolean;
|
|
16
|
+
readonly deprecated?: string;
|
|
17
|
+
readonly constraints?: Record<string, unknown>;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Describe all fields in a schema without needing a config file.
|
|
21
|
+
*
|
|
22
|
+
* Returns a structured catalog suitable for CLI rendering or agent inspection.
|
|
23
|
+
*/
|
|
24
|
+
export declare const describeConfig: (schema: z.ZodObject<Record<string, z.ZodType>>) => readonly FieldDescription[];
|
|
25
|
+
//# sourceMappingURL=describe.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"describe.d.ts","sourceRoot":"","sources":["../src/describe.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAS7B,4CAA4C;AAC5C,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChD;AAsMD;;;;GAIG;AACH,eAAO,MAAM,cAAc,GACzB,QAAQ,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,KAC7C,SAAS,gBAAgB,EAmB3B,CAAC"}
|
package/dist/describe.js
ADDED
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Config introspection — describe all fields in a schema without values.
|
|
3
|
+
*
|
|
4
|
+
* Returns a structured catalog suitable for CLI rendering or agent inspection.
|
|
5
|
+
*/
|
|
6
|
+
import { globalRegistry } from 'zod';
|
|
7
|
+
import { collectConfigMeta } from './collect.js';
|
|
8
|
+
import { isZodObject, unwrapToBase, zodDef } from './zod-utils.js';
|
|
9
|
+
// ---------------------------------------------------------------------------
|
|
10
|
+
// Helpers (defined before consumers — satisfies no-use-before-define)
|
|
11
|
+
// ---------------------------------------------------------------------------
|
|
12
|
+
/** Read the description from the Zod global registry. */
|
|
13
|
+
const getDescription = (schema) => {
|
|
14
|
+
const meta = globalRegistry.get(schema);
|
|
15
|
+
return meta?.description;
|
|
16
|
+
};
|
|
17
|
+
/** Handle a single unwrap step; returns updated inner type and state, or null to stop. */
|
|
18
|
+
const unwrapStep = (def, state) => {
|
|
19
|
+
const typeName = def['type'];
|
|
20
|
+
if (typeName === 'default') {
|
|
21
|
+
return {
|
|
22
|
+
inner: def['innerType'],
|
|
23
|
+
state: { ...state, defaultValue: def['defaultValue'], hasDefault: true },
|
|
24
|
+
};
|
|
25
|
+
}
|
|
26
|
+
if (typeName === 'optional') {
|
|
27
|
+
return {
|
|
28
|
+
inner: def['innerType'],
|
|
29
|
+
state: { ...state, isOptional: true },
|
|
30
|
+
};
|
|
31
|
+
}
|
|
32
|
+
if (typeName === 'nullable') {
|
|
33
|
+
return { inner: def['innerType'], state };
|
|
34
|
+
}
|
|
35
|
+
return null;
|
|
36
|
+
};
|
|
37
|
+
/** Unwrap through default/optional/nullable wrappers to find the base type. */
|
|
38
|
+
const unwrapSchema = (schema) => {
|
|
39
|
+
let current = schema;
|
|
40
|
+
let state = {
|
|
41
|
+
defaultValue: undefined,
|
|
42
|
+
hasDefault: false,
|
|
43
|
+
isOptional: false,
|
|
44
|
+
};
|
|
45
|
+
for (let depth = 0; depth < 10; depth += 1) {
|
|
46
|
+
const result = unwrapStep(zodDef(current), state);
|
|
47
|
+
if (!result) {
|
|
48
|
+
break;
|
|
49
|
+
}
|
|
50
|
+
current = result.inner;
|
|
51
|
+
({ state } = result);
|
|
52
|
+
}
|
|
53
|
+
return { base: current, ...state };
|
|
54
|
+
};
|
|
55
|
+
/** Resolve the user-facing type name from a base Zod schema. */
|
|
56
|
+
const resolveTypeName = (schema) => {
|
|
57
|
+
const typeName = zodDef(schema)['type'];
|
|
58
|
+
const typeMap = {
|
|
59
|
+
boolean: 'boolean',
|
|
60
|
+
enum: 'enum',
|
|
61
|
+
number: 'number',
|
|
62
|
+
string: 'string',
|
|
63
|
+
};
|
|
64
|
+
return typeMap[typeName] ?? typeName;
|
|
65
|
+
};
|
|
66
|
+
/** Extract enum values from an enum def. */
|
|
67
|
+
const extractEnumConstraints = (def) => {
|
|
68
|
+
const entries = def['entries'];
|
|
69
|
+
if (!entries) {
|
|
70
|
+
return undefined;
|
|
71
|
+
}
|
|
72
|
+
return { values: Object.values(entries) };
|
|
73
|
+
};
|
|
74
|
+
/** Extract min/max from a number schema's properties. */
|
|
75
|
+
const extractNumberConstraints = (schema) => {
|
|
76
|
+
const result = {};
|
|
77
|
+
const numSchema = schema;
|
|
78
|
+
if (numSchema.minValue !== undefined && numSchema.minValue !== null) {
|
|
79
|
+
result['min'] = numSchema.minValue;
|
|
80
|
+
}
|
|
81
|
+
if (numSchema.maxValue !== undefined && numSchema.maxValue !== null) {
|
|
82
|
+
result['max'] = numSchema.maxValue;
|
|
83
|
+
}
|
|
84
|
+
return Object.keys(result).length > 0 ? result : undefined;
|
|
85
|
+
};
|
|
86
|
+
/** Extract constraints from a base schema (min, max, enum values). */
|
|
87
|
+
const extractConstraints = (schema) => {
|
|
88
|
+
const def = zodDef(schema);
|
|
89
|
+
const typeName = def['type'];
|
|
90
|
+
if (typeName === 'enum') {
|
|
91
|
+
return extractEnumConstraints(def);
|
|
92
|
+
}
|
|
93
|
+
if (typeName === 'number') {
|
|
94
|
+
return extractNumberConstraints(schema);
|
|
95
|
+
}
|
|
96
|
+
return undefined;
|
|
97
|
+
};
|
|
98
|
+
/** Build a single FieldDescription from a leaf schema and its metadata. */
|
|
99
|
+
const buildFieldDescription = (path, fieldSchema, configMeta) => {
|
|
100
|
+
const { base, defaultValue, hasDefault, isOptional } = unwrapSchema(fieldSchema);
|
|
101
|
+
const meta = configMeta.get(path);
|
|
102
|
+
const description = getDescription(base) ?? getDescription(fieldSchema);
|
|
103
|
+
const constraints = extractConstraints(base);
|
|
104
|
+
return {
|
|
105
|
+
...(constraints ? { constraints } : {}),
|
|
106
|
+
...(hasDefault ? { default: defaultValue } : {}),
|
|
107
|
+
...(meta?.deprecated ? { deprecated: meta.deprecated } : {}),
|
|
108
|
+
...(description ? { description } : {}),
|
|
109
|
+
...(meta?.env ? { env: meta.env } : {}),
|
|
110
|
+
path,
|
|
111
|
+
required: !hasDefault && !isOptional,
|
|
112
|
+
...(meta?.secret ? { secret: meta.secret } : {}),
|
|
113
|
+
type: resolveTypeName(base),
|
|
114
|
+
};
|
|
115
|
+
};
|
|
116
|
+
/** Walk one level of an object shape, collecting leaves and queuing nested objects. */
|
|
117
|
+
const walkShapeLevel = (shape, prefix, configMeta, results, queue) => {
|
|
118
|
+
for (const [key, fieldSchema] of Object.entries(shape)) {
|
|
119
|
+
const path = prefix ? `${prefix}.${key}` : key;
|
|
120
|
+
if (isZodObject(fieldSchema)) {
|
|
121
|
+
queue.push({ prefix: path, schema: unwrapToBase(fieldSchema) });
|
|
122
|
+
}
|
|
123
|
+
else {
|
|
124
|
+
results.push(buildFieldDescription(path, fieldSchema, configMeta));
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
};
|
|
128
|
+
// ---------------------------------------------------------------------------
|
|
129
|
+
// Public API
|
|
130
|
+
// ---------------------------------------------------------------------------
|
|
131
|
+
/**
|
|
132
|
+
* Describe all fields in a schema without needing a config file.
|
|
133
|
+
*
|
|
134
|
+
* Returns a structured catalog suitable for CLI rendering or agent inspection.
|
|
135
|
+
*/
|
|
136
|
+
export const describeConfig = (schema) => {
|
|
137
|
+
const configMeta = collectConfigMeta(schema);
|
|
138
|
+
const queue = [];
|
|
139
|
+
const results = [];
|
|
140
|
+
walkShapeLevel(schema.shape, '', configMeta, results, queue);
|
|
141
|
+
for (let entry = queue.pop(); entry; entry = queue.pop()) {
|
|
142
|
+
const nested = zodDef(entry.schema)['shape'];
|
|
143
|
+
walkShapeLevel(nested, entry.prefix, configMeta, results, queue);
|
|
144
|
+
}
|
|
145
|
+
return results;
|
|
146
|
+
};
|
|
147
|
+
//# sourceMappingURL=describe.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"describe.js","sourceRoot":"","sources":["../src/describe.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,KAAK,CAAC;AAGrC,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAkCnE,8EAA8E;AAC9E,sEAAsE;AACtE,8EAA8E;AAE9E,yDAAyD;AACzD,MAAM,cAAc,GAAG,CAAC,MAAiB,EAAsB,EAAE;IAC/D,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACxC,OAAO,IAAI,EAAE,WAAiC,CAAC;AACjD,CAAC,CAAC;AAEF,0FAA0F;AAC1F,MAAM,UAAU,GAAG,CACjB,GAA4B,EAC5B,KAAkB,EAC+B,EAAE;IACnD,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAW,CAAC;IAEvC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO;YACL,KAAK,EAAE,GAAG,CAAC,WAAW,CAAc;YACpC,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,YAAY,EAAE,GAAG,CAAC,cAAc,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE;SACzE,CAAC;IACJ,CAAC;IAED,IAAI,QAAQ,KAAK,UAAU,EAAE,CAAC;QAC5B,OAAO;YACL,KAAK,EAAE,GAAG,CAAC,WAAW,CAAc;YACpC,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE;SACtC,CAAC;IACJ,CAAC;IAED,IAAI,QAAQ,KAAK,UAAU,EAAE,CAAC;QAC5B,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC,WAAW,CAAc,EAAE,KAAK,EAAE,CAAC;IACzD,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,+EAA+E;AAC/E,MAAM,YAAY,GAAG,CAAC,MAAiB,EAAgB,EAAE;IACvD,IAAI,OAAO,GAAG,MAAM,CAAC;IACrB,IAAI,KAAK,GAAgB;QACvB,YAAY,EAAE,SAAS;QACvB,UAAU,EAAE,KAAK;QACjB,UAAU,EAAE,KAAK;KAClB,CAAC;IAEF,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,EAAE,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QAC3C,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM;QACR,CAAC;QACD,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;QACvB,CAAC,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,CAAC;IACvB,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,CAAC;AACrC,CAAC,CAAC;AAEF,gEAAgE;AAChE,MAAM,eAAe,GAAG,CAAC,MAAiB,EAAU,EAAE;IACpD,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAW,CAAC;IAClD,MAAM,OAAO,GAA2B;QACtC,OAAO,EAAE,SAAS;QAClB,IAAI,EAAE,MAAM;QACZ,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE,QAAQ;KACjB,CAAC;IACF,OAAO,OAAO,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC;AACvC,CAAC,CAAC;AAEF,4CAA4C;AAC5C,MAAM,sBAAsB,GAAG,CAC7B,GAA4B,EACS,EAAE;IACvC,MAAM,OAAO,GAAG,GAAG,CAAC,SAAS,CAAuC,CAAC;IACrE,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;AAC5C,CAAC,CAAC;AAEF,yDAAyD;AACzD,MAAM,wBAAwB,GAAG,CAC/B,MAAiB,EACoB,EAAE;IACvC,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,MAAM,SAAS,GAAG,MAGjB,CAAC;IAEF,IAAI,SAAS,CAAC,QAAQ,KAAK,SAAS,IAAI,SAAS,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;QACpE,MAAM,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC;IACrC,CAAC;IACD,IAAI,SAAS,CAAC,QAAQ,KAAK,SAAS,IAAI,SAAS,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;QACpE,MAAM,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC;IACrC,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AAC7D,CAAC,CAAC;AAEF,sEAAsE;AACtE,MAAM,kBAAkB,GAAG,CACzB,MAAiB,EACoB,EAAE;IACvC,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAC3B,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAW,CAAC;IAEvC,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;QACxB,OAAO,sBAAsB,CAAC,GAAG,CAAC,CAAC;IACrC,CAAC;IACD,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC1B,OAAO,wBAAwB,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAYF,2EAA2E;AAC3E,MAAM,qBAAqB,GAAG,CAC5B,IAAY,EACZ,WAAsB,EACtB,UAGC,EACiB,EAAE;IACpB,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,GAClD,YAAY,CAAC,WAAW,CAAC,CAAC;IAC5B,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAClC,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,WAAW,CAAC,CAAC;IACxE,MAAM,WAAW,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAE7C,OAAO;QACL,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAChD,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5D,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvC,IAAI;QACJ,QAAQ,EAAE,CAAC,UAAU,IAAI,CAAC,UAAU;QACpC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAChD,IAAI,EAAE,eAAe,CAAC,IAAI,CAAC;KAC5B,CAAC;AACJ,CAAC,CAAC;AAEF,uFAAuF;AACvF,MAAM,cAAc,GAAG,CACrB,KAAgC,EAChC,MAAc,EACd,UAGC,EACD,OAA2B,EAC3B,KAAkB,EACZ,EAAE;IACR,KAAK,MAAM,CAAC,GAAG,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACvD,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;QAC/C,IAAI,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC;YAC7B,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAClE,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAEF,8EAA8E;AAC9E,aAAa;AACb,8EAA8E;AAE9E;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,MAA8C,EACjB,EAAE;IAC/B,MAAM,UAAU,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC7C,MAAM,KAAK,GAAgB,EAAE,CAAC;IAC9B,MAAM,OAAO,GAAuB,EAAE,CAAC;IAEvC,cAAc,CACZ,MAAM,CAAC,KAAkC,EACzC,EAAE,EACF,UAAU,EACV,OAAO,EACP,KAAK,CACN,CAAC;IAEF,KAAK,IAAI,KAAK,GAAG,KAAK,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,KAAK,GAAG,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC;QACzD,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,CAA8B,CAAC;QAC1E,cAAc,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IACnE,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC"}
|
package/dist/doctor.d.ts
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Config doctor — structured diagnostics for a config object against a schema.
|
|
3
|
+
*
|
|
4
|
+
* Reports which fields are valid, missing, using defaults, deprecated, or invalid.
|
|
5
|
+
*/
|
|
6
|
+
import type { z } from 'zod';
|
|
7
|
+
/** Diagnostic status for a single config field. */
|
|
8
|
+
export interface ConfigDiagnostic {
|
|
9
|
+
readonly path: string;
|
|
10
|
+
readonly status: 'valid' | 'missing' | 'invalid' | 'deprecated' | 'default';
|
|
11
|
+
readonly message: string;
|
|
12
|
+
readonly value?: unknown;
|
|
13
|
+
}
|
|
14
|
+
/** Aggregated result from checking config against a schema. */
|
|
15
|
+
export interface CheckResult {
|
|
16
|
+
readonly diagnostics: readonly ConfigDiagnostic[];
|
|
17
|
+
readonly valid: boolean;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Check a config object against a schema and return structured diagnostics.
|
|
21
|
+
*
|
|
22
|
+
* Reports which fields are valid, missing, using defaults, deprecated, or invalid.
|
|
23
|
+
*/
|
|
24
|
+
export declare const checkConfig: <T extends z.ZodType>(schema: T, values: Record<string, unknown>, options?: {
|
|
25
|
+
readonly env?: Record<string, string | undefined>;
|
|
26
|
+
}) => CheckResult;
|
|
27
|
+
//# sourceMappingURL=doctor.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"doctor.d.ts","sourceRoot":"","sources":["../src/doctor.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAS7B,mDAAmD;AACnD,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,YAAY,GAAG,SAAS,CAAC;IAC5E,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,+DAA+D;AAC/D,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,WAAW,EAAE,SAAS,gBAAgB,EAAE,CAAC;IAClD,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;CACzB;AAsND;;;;GAIG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAC7C,QAAQ,CAAC,EACT,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,UAAU;IAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAA;CAAE,KAC9D,WAkBF,CAAC"}
|
package/dist/doctor.js
ADDED
|
@@ -0,0 +1,167 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Config doctor — structured diagnostics for a config object against a schema.
|
|
3
|
+
*
|
|
4
|
+
* Reports which fields are valid, missing, using defaults, deprecated, or invalid.
|
|
5
|
+
*/
|
|
6
|
+
import { collectConfigMeta } from './collect.js';
|
|
7
|
+
import { getAtPath, isZodObject, unwrapToBase, zodDef } from './zod-utils.js';
|
|
8
|
+
// ---------------------------------------------------------------------------
|
|
9
|
+
// Helpers (defined before consumers)
|
|
10
|
+
// ---------------------------------------------------------------------------
|
|
11
|
+
/** Check if a schema wraps a ZodDefault. */
|
|
12
|
+
const isDefaultWrapper = (schema) => zodDef(schema)['type'] === 'default';
|
|
13
|
+
/** Check if a schema wraps a ZodOptional. */
|
|
14
|
+
const isOptionalWrapper = (schema) => zodDef(schema)['type'] === 'optional';
|
|
15
|
+
/** Get the default value from a ZodDefault wrapper. */
|
|
16
|
+
const getDefaultValue = (schema) => zodDef(schema)['defaultValue'];
|
|
17
|
+
const BOOL_TRUE = new Set(['true', '1']);
|
|
18
|
+
const BOOL_FALSE = new Set(['false', '0']);
|
|
19
|
+
/** Set a value at a dot-separated path, creating intermediate objects. */
|
|
20
|
+
const setAtPath = (obj, path, value) => {
|
|
21
|
+
const parts = path.split('.');
|
|
22
|
+
let current = obj;
|
|
23
|
+
for (let i = 0; i < parts.length - 1; i += 1) {
|
|
24
|
+
const part = parts[i];
|
|
25
|
+
const next = current[part];
|
|
26
|
+
const nested = typeof next === 'object' && next !== null
|
|
27
|
+
? next
|
|
28
|
+
: {};
|
|
29
|
+
current[part] = nested;
|
|
30
|
+
current = nested;
|
|
31
|
+
}
|
|
32
|
+
const lastPart = parts.at(-1);
|
|
33
|
+
current[lastPart] = value;
|
|
34
|
+
};
|
|
35
|
+
const resolveBaseTypeName = (schema) => zodDef(unwrapToBase(schema))['type'];
|
|
36
|
+
const coerceEnvValue = (raw, schema) => {
|
|
37
|
+
switch (resolveBaseTypeName(schema)) {
|
|
38
|
+
case 'number':
|
|
39
|
+
return Number(raw);
|
|
40
|
+
case 'boolean':
|
|
41
|
+
if (BOOL_TRUE.has(raw)) {
|
|
42
|
+
return true;
|
|
43
|
+
}
|
|
44
|
+
if (BOOL_FALSE.has(raw)) {
|
|
45
|
+
return false;
|
|
46
|
+
}
|
|
47
|
+
return raw;
|
|
48
|
+
default:
|
|
49
|
+
return raw;
|
|
50
|
+
}
|
|
51
|
+
};
|
|
52
|
+
const getFieldSchema = (schema, path) => {
|
|
53
|
+
let current = schema;
|
|
54
|
+
for (const part of path.split('.')) {
|
|
55
|
+
if (!isZodObject(current)) {
|
|
56
|
+
return undefined;
|
|
57
|
+
}
|
|
58
|
+
const shape = zodDef(unwrapToBase(current))['shape'];
|
|
59
|
+
const next = shape?.[part];
|
|
60
|
+
if (!next) {
|
|
61
|
+
return undefined;
|
|
62
|
+
}
|
|
63
|
+
current = next;
|
|
64
|
+
}
|
|
65
|
+
return current;
|
|
66
|
+
};
|
|
67
|
+
/** Build values object with env overrides applied. */
|
|
68
|
+
const applyEnvToValues = (values, schema, envVars) => {
|
|
69
|
+
const meta = collectConfigMeta(schema);
|
|
70
|
+
const result = structuredClone(values);
|
|
71
|
+
for (const [path, fieldMeta] of meta) {
|
|
72
|
+
if (fieldMeta.env && envVars[fieldMeta.env] !== undefined) {
|
|
73
|
+
const envValue = envVars[fieldMeta.env];
|
|
74
|
+
const fieldSchema = getFieldSchema(schema, path);
|
|
75
|
+
setAtPath(result, path, fieldSchema ? coerceEnvValue(envValue, fieldSchema) : envValue);
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
return result;
|
|
79
|
+
};
|
|
80
|
+
/** Validate a single field value against its schema. */
|
|
81
|
+
const validateFieldValue = (path, fieldSchema, value) => {
|
|
82
|
+
const result = fieldSchema.safeParse(value);
|
|
83
|
+
if (result.success) {
|
|
84
|
+
return { message: 'OK', path, status: 'valid', value };
|
|
85
|
+
}
|
|
86
|
+
const issue = result.error?.issues?.[0];
|
|
87
|
+
const msg = issue ? issue.message : 'Invalid value';
|
|
88
|
+
return { message: msg, path, status: 'invalid', value };
|
|
89
|
+
};
|
|
90
|
+
/** Classify a single field and produce a diagnostic. */
|
|
91
|
+
const classifyField = (path, fieldSchema, values, deprecatedMeta) => {
|
|
92
|
+
const value = getAtPath(values, path);
|
|
93
|
+
const deprecationMsg = deprecatedMeta.get(path);
|
|
94
|
+
if (deprecationMsg && value !== undefined) {
|
|
95
|
+
return { message: deprecationMsg, path, status: 'deprecated', value };
|
|
96
|
+
}
|
|
97
|
+
if (value === undefined && isDefaultWrapper(fieldSchema)) {
|
|
98
|
+
return {
|
|
99
|
+
message: 'Using default value',
|
|
100
|
+
path,
|
|
101
|
+
status: 'default',
|
|
102
|
+
value: getDefaultValue(fieldSchema),
|
|
103
|
+
};
|
|
104
|
+
}
|
|
105
|
+
if (value === undefined && !isOptionalWrapper(fieldSchema)) {
|
|
106
|
+
return {
|
|
107
|
+
message: `Required field "${path}" is missing`,
|
|
108
|
+
path,
|
|
109
|
+
status: 'missing',
|
|
110
|
+
};
|
|
111
|
+
}
|
|
112
|
+
return validateFieldValue(path, fieldSchema, value);
|
|
113
|
+
};
|
|
114
|
+
/** Collect deprecated metadata paths from config meta. */
|
|
115
|
+
const collectDeprecatedPaths = (schema) => {
|
|
116
|
+
const meta = collectConfigMeta(schema);
|
|
117
|
+
const result = new Map();
|
|
118
|
+
for (const [path, fieldMeta] of meta) {
|
|
119
|
+
if (fieldMeta.deprecated) {
|
|
120
|
+
result.set(path, fieldMeta.deprecated);
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
return result;
|
|
124
|
+
};
|
|
125
|
+
/** Walk an object shape and enqueue leaf fields or nested objects. */
|
|
126
|
+
const walkShape = (schema, prefix, queue, leaves) => {
|
|
127
|
+
const shape = zodDef(schema)['shape'];
|
|
128
|
+
for (const [key, fieldSchema] of Object.entries(shape)) {
|
|
129
|
+
const path = prefix ? `${prefix}.${key}` : key;
|
|
130
|
+
if (isZodObject(fieldSchema)) {
|
|
131
|
+
queue.push({ path, schema: unwrapToBase(fieldSchema) });
|
|
132
|
+
}
|
|
133
|
+
else {
|
|
134
|
+
leaves.push({ path, schema: fieldSchema });
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
};
|
|
138
|
+
/** Collect all leaf fields from a schema, walking nested objects iteratively. */
|
|
139
|
+
const collectLeaves = (schema) => {
|
|
140
|
+
const queue = [];
|
|
141
|
+
const leaves = [];
|
|
142
|
+
walkShape(schema, '', queue, leaves);
|
|
143
|
+
for (let entry = queue.pop(); entry; entry = queue.pop()) {
|
|
144
|
+
walkShape(entry.schema, entry.path, queue, leaves);
|
|
145
|
+
}
|
|
146
|
+
return leaves;
|
|
147
|
+
};
|
|
148
|
+
// ---------------------------------------------------------------------------
|
|
149
|
+
// Public API
|
|
150
|
+
// ---------------------------------------------------------------------------
|
|
151
|
+
/**
|
|
152
|
+
* Check a config object against a schema and return structured diagnostics.
|
|
153
|
+
*
|
|
154
|
+
* Reports which fields are valid, missing, using defaults, deprecated, or invalid.
|
|
155
|
+
*/
|
|
156
|
+
export const checkConfig = (schema, values, options) => {
|
|
157
|
+
const objSchema = schema;
|
|
158
|
+
const effectiveValues = options?.env
|
|
159
|
+
? applyEnvToValues(values, objSchema, options.env)
|
|
160
|
+
: values;
|
|
161
|
+
const deprecatedMeta = collectDeprecatedPaths(objSchema);
|
|
162
|
+
const leaves = collectLeaves(objSchema);
|
|
163
|
+
const diagnostics = leaves.map((leaf) => classifyField(leaf.path, leaf.schema, effectiveValues, deprecatedMeta));
|
|
164
|
+
const valid = diagnostics.every((d) => d.status !== 'missing' && d.status !== 'invalid');
|
|
165
|
+
return { diagnostics, valid };
|
|
166
|
+
};
|
|
167
|
+
//# sourceMappingURL=doctor.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"doctor.js","sourceRoot":"","sources":["../src/doctor.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAoB9E,8EAA8E;AAC9E,qCAAqC;AACrC,8EAA8E;AAE9E,4CAA4C;AAC5C,MAAM,gBAAgB,GAAG,CAAC,MAAiB,EAAW,EAAE,CACtD,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,SAAS,CAAC;AAEvC,6CAA6C;AAC7C,MAAM,iBAAiB,GAAG,CAAC,MAAiB,EAAW,EAAE,CACvD,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,UAAU,CAAC;AAExC,uDAAuD;AACvD,MAAM,eAAe,GAAG,CAAC,MAAiB,EAAW,EAAE,CACrD,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,CAAC;AAEjC,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;AACzC,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;AAE3C,0EAA0E;AAC1E,MAAM,SAAS,GAAG,CAChB,GAA4B,EAC5B,IAAY,EACZ,KAAc,EACR,EAAE;IACR,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,OAAO,GAA4B,GAAG,CAAC;IAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7C,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAW,CAAC;QAChC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAC3B,MAAM,MAAM,GACV,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI;YACvC,CAAC,CAAE,IAAgC;YACnC,CAAC,CAAC,EAAE,CAAC;QACT,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;QACvB,OAAO,GAAG,MAAM,CAAC;IACnB,CAAC;IACD,MAAM,QAAQ,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAW,CAAC;IACxC,OAAO,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;AAC5B,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,MAAiB,EAAU,EAAE,CACxD,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAW,CAAC;AAEjD,MAAM,cAAc,GAAG,CAAC,GAAW,EAAE,MAAiB,EAAW,EAAE;IACjE,QAAQ,mBAAmB,CAAC,MAAM,CAAC,EAAE,CAAC;QACpC,KAAK,QAAQ;YACX,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;QACrB,KAAK,SAAS;YACZ,IAAI,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvB,OAAO,IAAI,CAAC;YACd,CAAC;YACD,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBACxB,OAAO,KAAK,CAAC;YACf,CAAC;YACD,OAAO,GAAG,CAAC;QACb;YACE,OAAO,GAAG,CAAC;IACf,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CACrB,MAAiB,EACjB,IAAY,EACW,EAAE;IACzB,IAAI,OAAO,GAAc,MAAM,CAAC;IAChC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACnC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1B,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,KAAK,GAAG,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAEtC,CAAC;QACd,MAAM,IAAI,GAAG,KAAK,EAAE,CAAC,IAAI,CAAC,CAAC;QAC3B,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,GAAG,IAAI,CAAC;IACjB,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF,sDAAsD;AACtD,MAAM,gBAAgB,GAAG,CACvB,MAA+B,EAC/B,MAA8C,EAC9C,OAA2C,EAClB,EAAE;IAC3B,MAAM,IAAI,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,MAAM,GAAG,eAAe,CAAC,MAAM,CAA4B,CAAC;IAClE,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;QACrC,IAAI,SAAS,CAAC,GAAG,IAAI,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;YAC1D,MAAM,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAW,CAAC;YAClD,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YACjD,SAAS,CACP,MAAM,EACN,IAAI,EACJ,WAAW,CAAC,CAAC,CAAC,cAAc,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAC/D,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAYF,wDAAwD;AACxD,MAAM,kBAAkB,GAAG,CACzB,IAAY,EACZ,WAAsB,EACtB,KAAc,EACI,EAAE;IACpB,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC5C,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IACzD,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IACxC,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;IACpD,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;AAC1D,CAAC,CAAC;AAEF,wDAAwD;AACxD,MAAM,aAAa,GAAG,CACpB,IAAY,EACZ,WAAsB,EACtB,MAA+B,EAC/B,cAAmC,EACjB,EAAE;IACpB,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACtC,MAAM,cAAc,GAAG,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAEhD,IAAI,cAAc,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC;IACxE,CAAC;IAED,IAAI,KAAK,KAAK,SAAS,IAAI,gBAAgB,CAAC,WAAW,CAAC,EAAE,CAAC;QACzD,OAAO;YACL,OAAO,EAAE,qBAAqB;YAC9B,IAAI;YACJ,MAAM,EAAE,SAAS;YACjB,KAAK,EAAE,eAAe,CAAC,WAAW,CAAC;SACpC,CAAC;IACJ,CAAC;IAED,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,EAAE,CAAC;QAC3D,OAAO;YACL,OAAO,EAAE,mBAAmB,IAAI,cAAc;YAC9C,IAAI;YACJ,MAAM,EAAE,SAAS;SAClB,CAAC;IACJ,CAAC;IAED,OAAO,kBAAkB,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;AACtD,CAAC,CAAC;AAEF,0DAA0D;AAC1D,MAAM,sBAAsB,GAAG,CAC7B,MAA8C,EACzB,EAAE;IACvB,MAAM,IAAI,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACzC,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;QACrC,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC;YACzB,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,sEAAsE;AACtE,MAAM,SAAS,GAAG,CAChB,MAAiB,EACjB,MAAc,EACd,KAAkB,EAClB,MAAmB,EACb,EAAE;IACR,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAA8B,CAAC;IACnE,KAAK,MAAM,CAAC,GAAG,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACvD,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;QAC/C,IAAI,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC;YAC7B,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAC1D,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAEF,iFAAiF;AACjF,MAAM,aAAa,GAAG,CAAC,MAAiB,EAAe,EAAE;IACvD,MAAM,KAAK,GAAgB,EAAE,CAAC;IAC9B,MAAM,MAAM,GAAgB,EAAE,CAAC;IAC/B,SAAS,CAAC,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAErC,KAAK,IAAI,KAAK,GAAG,KAAK,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,KAAK,GAAG,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC;QACzD,SAAS,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,8EAA8E;AAC9E,aAAa;AACb,8EAA8E;AAE9E;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,MAAS,EACT,MAA+B,EAC/B,OAA+D,EAClD,EAAE;IACf,MAAM,SAAS,GAAG,MAA2D,CAAC;IAC9E,MAAM,eAAe,GAAG,OAAO,EAAE,GAAG;QAClC,CAAC,CAAC,gBAAgB,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC;QAClD,CAAC,CAAC,MAAM,CAAC;IAEX,MAAM,cAAc,GAAG,sBAAsB,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,MAAM,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;IAExC,MAAM,WAAW,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACtC,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,eAAe,EAAE,cAAc,CAAC,CACvE,CAAC;IAEF,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAC7B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,KAAK,SAAS,CACxD,CAAC;IAEF,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;AAChC,CAAC,CAAC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Config provenance — show which source won for each config field.
|
|
3
|
+
*
|
|
4
|
+
* Used for debugging: answers "where did this value come from?"
|
|
5
|
+
*/
|
|
6
|
+
import type { z } from 'zod';
|
|
7
|
+
/** Provenance entry describing the source of a resolved config value. */
|
|
8
|
+
export interface ProvenanceEntry {
|
|
9
|
+
readonly path: string;
|
|
10
|
+
readonly value: unknown;
|
|
11
|
+
readonly source: 'default' | 'base' | 'loadout' | 'local' | 'env';
|
|
12
|
+
readonly redacted: boolean;
|
|
13
|
+
}
|
|
14
|
+
/** Options for explaining config provenance. */
|
|
15
|
+
export interface ExplainConfigOptions<T extends z.ZodType> {
|
|
16
|
+
readonly schema: T;
|
|
17
|
+
readonly base?: Record<string, unknown>;
|
|
18
|
+
readonly loadout?: Record<string, unknown>;
|
|
19
|
+
readonly local?: Record<string, unknown>;
|
|
20
|
+
readonly env?: Record<string, string | undefined>;
|
|
21
|
+
readonly resolved: Record<string, unknown>;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Show which source won for each config field.
|
|
25
|
+
*
|
|
26
|
+
* Used for debugging — answers "where did this value come from?"
|
|
27
|
+
*
|
|
28
|
+
*/
|
|
29
|
+
export declare const explainConfig: <T extends z.ZodType>(options: ExplainConfigOptions<T>) => readonly ProvenanceEntry[];
|
|
30
|
+
//# sourceMappingURL=explain.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"explain.d.ts","sourceRoot":"","sources":["../src/explain.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAU7B,yEAAyE;AACzE,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,KAAK,CAAC;IAClE,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;CAC5B;AAED,gDAAgD;AAChD,MAAM,WAAW,oBAAoB,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO;IACvD,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IACnB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC3C,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACzC,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IAClD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC5C;AAiHD;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAC/C,SAAS,oBAAoB,CAAC,CAAC,CAAC,KAC/B,SAAS,eAAe,EAoC1B,CAAC"}
|
package/dist/explain.js
ADDED
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Config provenance — show which source won for each config field.
|
|
3
|
+
*
|
|
4
|
+
* Used for debugging: answers "where did this value come from?"
|
|
5
|
+
*/
|
|
6
|
+
import { collectConfigMeta } from './collect.js';
|
|
7
|
+
import { isLikelySecret } from './secret-heuristics.js';
|
|
8
|
+
import { getAtPath, isZodObject, unwrapToBase, zodDef } from './zod-utils.js';
|
|
9
|
+
// ---------------------------------------------------------------------------
|
|
10
|
+
// Helpers (defined before consumers)
|
|
11
|
+
// ---------------------------------------------------------------------------
|
|
12
|
+
/** Build a map of path → env var name from config metadata. */
|
|
13
|
+
const buildEnvMap = (schema) => {
|
|
14
|
+
const meta = collectConfigMeta(schema);
|
|
15
|
+
const result = new Map();
|
|
16
|
+
for (const [path, fieldMeta] of meta) {
|
|
17
|
+
if (fieldMeta.env) {
|
|
18
|
+
result.set(path, fieldMeta.env);
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
return result;
|
|
22
|
+
};
|
|
23
|
+
/** Build a set of paths marked as secret from config metadata. */
|
|
24
|
+
const buildSecretSet = (schema) => {
|
|
25
|
+
const meta = collectConfigMeta(schema);
|
|
26
|
+
const result = new Set();
|
|
27
|
+
for (const [path, fieldMeta] of meta) {
|
|
28
|
+
if (fieldMeta.secret) {
|
|
29
|
+
result.add(path);
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
return result;
|
|
33
|
+
};
|
|
34
|
+
const hasPath = (obj, path) => {
|
|
35
|
+
let current = obj;
|
|
36
|
+
for (const part of path.split('.')) {
|
|
37
|
+
if (typeof current !== 'object' || current === null) {
|
|
38
|
+
return false;
|
|
39
|
+
}
|
|
40
|
+
if (!Object.hasOwn(current, part)) {
|
|
41
|
+
return false;
|
|
42
|
+
}
|
|
43
|
+
current = current[part];
|
|
44
|
+
}
|
|
45
|
+
return true;
|
|
46
|
+
};
|
|
47
|
+
/** Determine which source provided the winning value for a given path. */
|
|
48
|
+
const determineSource = (path, resolved, layers, envMap, envVars) => {
|
|
49
|
+
if (envVars && envMap.has(path)) {
|
|
50
|
+
const envVar = envMap.get(path);
|
|
51
|
+
if (envVar && envVars[envVar] !== undefined) {
|
|
52
|
+
return 'env';
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
const resolvedValue = getAtPath(resolved, path);
|
|
56
|
+
for (const [name, values] of layers) {
|
|
57
|
+
if (values && hasPath(values, path) && getAtPath(values, path) === resolvedValue) {
|
|
58
|
+
return name;
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
return 'default';
|
|
62
|
+
};
|
|
63
|
+
/** Collect all leaf field paths from an object schema. */
|
|
64
|
+
const collectLeafPaths = (schema, prefix) => {
|
|
65
|
+
const paths = [];
|
|
66
|
+
const queue = [{ prefix, schema }];
|
|
67
|
+
for (let entry = queue.pop(); entry; entry = queue.pop()) {
|
|
68
|
+
const shape = zodDef(entry.schema)['shape'];
|
|
69
|
+
for (const [key, fieldSchema] of Object.entries(shape)) {
|
|
70
|
+
const path = entry.prefix ? `${entry.prefix}.${key}` : key;
|
|
71
|
+
if (isZodObject(fieldSchema)) {
|
|
72
|
+
queue.push({ prefix: path, schema: unwrapToBase(fieldSchema) });
|
|
73
|
+
}
|
|
74
|
+
else {
|
|
75
|
+
paths.push(path);
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
return paths;
|
|
80
|
+
};
|
|
81
|
+
// ---------------------------------------------------------------------------
|
|
82
|
+
// Public API
|
|
83
|
+
// ---------------------------------------------------------------------------
|
|
84
|
+
/**
|
|
85
|
+
* Show which source won for each config field.
|
|
86
|
+
*
|
|
87
|
+
* Used for debugging — answers "where did this value come from?"
|
|
88
|
+
*
|
|
89
|
+
*/
|
|
90
|
+
export const explainConfig = (options) => {
|
|
91
|
+
const objSchema = options.schema;
|
|
92
|
+
const envMap = buildEnvMap(objSchema);
|
|
93
|
+
const secretSet = buildSecretSet(objSchema);
|
|
94
|
+
const layers = [
|
|
95
|
+
['local', options.local],
|
|
96
|
+
['loadout', options.loadout],
|
|
97
|
+
['base', options.base],
|
|
98
|
+
];
|
|
99
|
+
const paths = collectLeafPaths(objSchema, '');
|
|
100
|
+
return paths.map((path) => {
|
|
101
|
+
const source = determineSource(path, options.resolved, layers, envMap, options.env);
|
|
102
|
+
const envVarName = envMap.get(path);
|
|
103
|
+
const isSecret = secretSet.has(path) ||
|
|
104
|
+
(envVarName !== undefined && isLikelySecret(envVarName));
|
|
105
|
+
const rawValue = getAtPath(options.resolved, path);
|
|
106
|
+
return {
|
|
107
|
+
path,
|
|
108
|
+
redacted: isSecret,
|
|
109
|
+
source,
|
|
110
|
+
value: isSecret ? '[REDACTED]' : rawValue,
|
|
111
|
+
};
|
|
112
|
+
});
|
|
113
|
+
};
|
|
114
|
+
//# sourceMappingURL=explain.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"explain.js","sourceRoot":"","sources":["../src/explain.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAwB9E,8EAA8E;AAC9E,qCAAqC;AACrC,8EAA8E;AAE9E,+DAA+D;AAC/D,MAAM,WAAW,GAAG,CAClB,MAA8C,EACzB,EAAE;IACvB,MAAM,IAAI,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACzC,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;QACrC,IAAI,SAAS,CAAC,GAAG,EAAE,CAAC;YAClB,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,kEAAkE;AAClE,MAAM,cAAc,GAAG,CACrB,MAA8C,EACjC,EAAE;IACf,MAAM,IAAI,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;IACjC,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;QACrC,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;YACrB,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAQF,MAAM,OAAO,GAAG,CAAC,GAA4B,EAAE,IAAY,EAAW,EAAE;IACtE,IAAI,OAAO,GAAY,GAAG,CAAC;IAC3B,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACnC,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACpD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAkC,EAAE,IAAI,CAAC,EAAE,CAAC;YAC7D,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,GAAI,OAAmC,CAAC,IAAI,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,0EAA0E;AAC1E,MAAM,eAAe,GAAG,CACtB,IAAY,EACZ,QAAiC,EACjC,MAA8B,EAC9B,MAA2B,EAC3B,OAAuD,EAC5B,EAAE;IAC7B,IAAI,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QAChC,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChC,IAAI,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE,CAAC;YAC5C,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,MAAM,aAAa,GAAG,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAChD,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;QACpC,IAAI,MAAM,IAAI,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,aAAa,EAAE,CAAC;YACjF,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAYF,0DAA0D;AAC1D,MAAM,gBAAgB,GAAG,CAAC,MAAiB,EAAE,MAAc,EAAY,EAAE;IACvE,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,KAAK,GAAgB,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAEhD,KAAK,IAAI,KAAK,GAAG,KAAK,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,KAAK,GAAG,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC;QACzD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,CAA8B,CAAC;QACzE,KAAK,MAAM,CAAC,GAAG,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;YAC3D,IAAI,WAAW,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC7B,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;YAClE,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnB,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,8EAA8E;AAC9E,aAAa;AACb,8EAA8E;AAE9E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,OAAgC,EACJ,EAAE;IAC9B,MAAM,SAAS,GAAG,OAAO,CAAC,MAEzB,CAAC;IACF,MAAM,MAAM,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;IACtC,MAAM,SAAS,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;IAE5C,MAAM,MAAM,GAA2B;QACrC,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC;QACxB,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC;QAC5B,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC;KACvB,CAAC;IAEF,MAAM,KAAK,GAAG,gBAAgB,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAE9C,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACxB,MAAM,MAAM,GAAG,eAAe,CAC5B,IAAI,EACJ,OAAO,CAAC,QAAQ,EAChB,MAAM,EACN,MAAM,EACN,OAAO,CAAC,GAAG,CACZ,CAAC;QACF,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,QAAQ,GACZ,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC;YACnB,CAAC,UAAU,KAAK,SAAS,IAAI,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC;QAC3D,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAEnD,OAAO;YACL,IAAI;YACJ,QAAQ,EAAE,QAAQ;YAClB,MAAM;YACN,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ;SAC1C,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}
|