@did-btcr2/cli 0.14.0 → 0.15.0

package/dist/esm/src/config-schema.js

@@ -0,0 +1,149 @@
+import { CLIError } from './error.js';
+import { SUPPORTED_NETWORKS } from './types.js';
+/**
+ * Declarative schema of the known config-file paths, used by both the write-time
+ * validation in `config set` and the strict `config validate` check so the two
+ * cannot disagree. Leaves name a value kind: `'string'`, `'number'`, `'object'`
+ * (a free-form map, e.g. headers), or `'enum:<name>'`. The `'*'` key under
+ * `profiles` matches any profile name.
+ */
+const CONFIG_SCHEMA = {
+    schemaVersion: 'number',
+    defaults: {
+        profile: 'string',
+        network: 'enum:network',
+        output: 'enum:output',
+    },
+    profiles: {
+        '*': {
+            network: 'enum:network',
+            btc: {
+                rest: 'string',
+                rpcUrl: 'string',
+                rpcUser: 'string',
+                rpcPass: 'string',
+                feeRate: 'number',
+                changeAddress: 'string',
+                timeoutMs: 'number',
+                headers: 'object',
+                wallet: 'string',
+                rpcHeaders: 'object',
+            },
+            cas: {
+                gateway: 'string',
+                rpcUrl: 'string',
+                timeoutMs: 'number',
+            },
+            identity: {
+                keystore: 'string',
+                default: 'string',
+            },
+        },
+    },
+};
+/**
+ * Resolves a dotted config path to its schema node: a leaf kind string, a nested
+ * {@link SchemaNode}, or `undefined` when the path is not part of the known
+ * schema. A segment under `profiles` matches the `'*'` template.
+ */
+function lookupSchemaNode(dotted) {
+    let node = CONFIG_SCHEMA;
+    for (const segment of dotted.split('.')) {
+        if (typeof node !== 'object')
+            return undefined;
+        // Own-property checks only: `in` would match inherited Object.prototype names
+        // (`toString`, `constructor`, `__proto__`), treating a builtin as a known key.
+        if (Object.hasOwn(node, segment)) {
+            node = node[segment];
+        }
+        else if (Object.hasOwn(node, '*')) {
+            node = node['*'];
+        }
+        else {
+            return undefined;
+        }
+    }
+    return node;
+}
+/** Whether a dotted path is part of the known config schema (leaf or intermediate). */
+export function isKnownConfigPath(dotted) {
+    return lookupSchemaNode(dotted) !== undefined;
+}
+/**
+ * Validates a value against a leaf kind, throwing a {@link CLIError} for a value
+ * that does not match: an out-of-range enum, a non-number for a `number` leaf, or
+ * a non-object for an `object` leaf (a map such as `headers`). A no-op for
+ * `string` leaves and for intermediate nodes.
+ */
+function assertLeafValue(kind, dotted, value) {
+    if (kind === 'enum:network' && !SUPPORTED_NETWORKS.includes(value)) {
+        throw new CLIError(`Invalid value for ${dotted}: "${String(value)}". Expected one of ${SUPPORTED_NETWORKS.join(', ')}.`, 'INVALID_ARGUMENT_ERROR', { path: dotted, value });
+    }
+    if (kind === 'enum:output' && value !== 'json' && value !== 'text') {
+        throw new CLIError(`Invalid value for ${dotted}: "${String(value)}". Expected "json" or "text".`, 'INVALID_ARGUMENT_ERROR', { path: dotted, value });
+    }
+    if (kind === 'number' && typeof value !== 'number') {
+        throw new CLIError(`Invalid value for ${dotted}: expected a number, got ${typeof value}. `
+            + 'Pass a bare number (e.g. `config set ' + dotted + ' 5`).', 'INVALID_ARGUMENT_ERROR', { path: dotted, value });
+    }
+    if (kind === 'object' && (typeof value !== 'object' || value === null || Array.isArray(value))) {
+        throw new CLIError(`Invalid value for ${dotted}: expected a JSON object (e.g. \`config set ${dotted} '{"Key":"Value"}'\`).`, 'INVALID_ARGUMENT_ERROR', { path: dotted, value });
+    }
+}
+/**
+ * Write-time validation for `config set`. An enum, number, or object leaf whose
+ * value has the wrong kind is a hard rejection (throws). An unknown path is
+ * permitted but reported, so `config set` can warn and still write (keeping
+ * forward-compatible and third-party keys usable). Returns `{ unknownPath }`.
+ */
+export function validateConfigSet(dotted, value) {
+    const node = lookupSchemaNode(dotted);
+    if (node === undefined)
+        return { unknownPath: true };
+    if (typeof node === 'string') {
+        assertLeafValue(node, dotted, value);
+    }
+    return { unknownPath: false };
+}
+/**
+ * Strict validation for `config validate`: walks a parsed config and collects
+ * every unknown key and out-of-enum value, plus a `schemaVersion` that is newer
+ * than this CLI supports. Never throws; returns the full list so the caller can
+ * report all problems at once.
+ */
+export function findConfigIssues(config, supportedSchemaVersion) {
+    const issues = [];
+    const version = config.schemaVersion;
+    if (typeof version === 'number' && version > supportedSchemaVersion) {
+        issues.push({
+            path: 'schemaVersion',
+            issue: `newer than supported (${version} > ${supportedSchemaVersion}); upgrade the CLI to use this file`,
+        });
+    }
+    walk(config, [], issues);
+    return issues;
+}
+/** Recursively collects unknown-key and bad-enum issues under `prefix`. */
+function walk(obj, prefix, issues) {
+    for (const [key, value] of Object.entries(obj)) {
+        const path = [...prefix, key];
+        const dotted = path.join('.');
+        const node = lookupSchemaNode(dotted);
+        if (node === undefined) {
+            issues.push({ path: dotted, issue: 'unknown key' });
+            continue; // Do not descend into an unknown subtree.
+        }
+        if (typeof node === 'string') {
+            try {
+                assertLeafValue(node, dotted, value);
+            }
+            catch (error) {
+                issues.push({ path: dotted, issue: error.message });
+            }
+        }
+        else if (value !== null && typeof value === 'object' && !Array.isArray(value)) {
+            walk(value, path, issues);
+        }
+    }
+}
+//# sourceMappingURL=config-schema.js.map

package/dist/esm/src/config-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-schema.js","sourceRoot":"","sources":["../../../src/config-schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAEhD;;;;;;GAMG;AACH,MAAM,aAAa,GAAe;IAChC,aAAa,EAAG,QAAQ;IACxB,QAAQ,EAAQ;QACd,OAAO,EAAG,QAAQ;QAClB,OAAO,EAAG,cAAc;QACxB,MAAM,EAAI,aAAa;KACxB;IACD,QAAQ,EAAG;QACT,GAAG,EAAG;YACJ,OAAO,EAAG,cAAc;YACxB,GAAG,EAAO;gBACR,IAAI,EAAY,QAAQ;gBACxB,MAAM,EAAU,QAAQ;gBACxB,OAAO,EAAS,QAAQ;gBACxB,OAAO,EAAS,QAAQ;gBACxB,OAAO,EAAS,QAAQ;gBACxB,aAAa,EAAG,QAAQ;gBACxB,SAAS,EAAO,QAAQ;gBACxB,OAAO,EAAS,QAAQ;gBACxB,MAAM,EAAU,QAAQ;gBACxB,UAAU,EAAM,QAAQ;aACzB;YACD,GAAG,EAAG;gBACJ,OAAO,EAAK,QAAQ;gBACpB,MAAM,EAAM,QAAQ;gBACpB,SAAS,EAAG,QAAQ;aACrB;YACD,QAAQ,EAAG;gBACT,QAAQ,EAAG,QAAQ;gBACnB,OAAO,EAAI,QAAQ;aACpB;SACF;KACF;CACF,CAAC;AAWF;;;;GAIG;AACH,SAAS,gBAAgB,CAAC,MAAc;IACtC,IAAI,IAAI,GAAwC,aAAa,CAAC;IAC9D,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QACxC,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,OAAO,SAAS,CAAC;QAC/C,8EAA8E;QAC9E,+EAA+E;QAC/E,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;YACjC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;aAAM,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;YACpC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,uFAAuF;AACvF,MAAM,UAAU,iBAAiB,CAAC,MAAc;IAC9C,OAAO,gBAAgB,CAAC,MAAM,CAAC,KAAK,SAAS,CAAC;AAChD,CAAC;AAED;;;;;GAKG;AACH,SAAS,eAAe,CAAC,IAAgB,EAAE,MAAc,EAAE,KAAc;IACvE,IAAI,IAAI,KAAK,cAAc,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,KAAc,CAAC,EAAE,CAAC;QAC5E,MAAM,IAAI,QAAQ,CAChB,qBAAqB,MAAM,MAAM,MAAM,CAAC,KAAK,CAAC,sBAAsB,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EACpG,wBAAwB,EACxB,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CACxB,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,KAAK,aAAa,IAAI,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;QACnE,MAAM,IAAI,QAAQ,CAChB,qBAAqB,MAAM,MAAM,MAAM,CAAC,KAAK,CAAC,+BAA+B,EAC7E,wBAAwB,EACxB,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CACxB,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACnD,MAAM,IAAI,QAAQ,CAChB,qBAAqB,MAAM,4BAA4B,OAAO,KAAK,IAAI;cACrE,uCAAuC,GAAG,MAAM,GAAG,OAAO,EAC5D,wBAAwB,EACxB,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CACxB,CAAC;IACJ,CAAC;IACD,IAAI,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QAC/F,MAAM,IAAI,QAAQ,CAChB,qBAAqB,MAAM,+CAA+C,MAAM,wBAAwB,EACxG,wBAAwB,EACxB,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CACxB,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAAc,EAAE,KAAc;IAC9D,MAAM,IAAI,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACtC,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;IACrD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;AAChC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAA+B,EAAE,sBAA8B;IAC9F,MAAM,MAAM,GAAkB,EAAE,CAAC;IAEjC,MAAM,OAAO,GAAG,MAAM,CAAC,aAAa,CAAC;IACrC,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,GAAG,sBAAsB,EAAE,CAAC;QACpE,MAAM,CAAC,IAAI,CAAC;YACV,IAAI,EAAI,eAAe;YACvB,KAAK,EAAG,yBAAyB,OAAO,MAAM,sBAAsB,qCAAqC;SAC1G,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IACzB,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,2EAA2E;AAC3E,SAAS,IAAI,CAAC,GAA4B,EAAE,MAAgB,EAAE,MAAqB;IACjF,KAAK,MAAM,CAAE,GAAG,EAAE,KAAK,CAAE,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACjD,MAAM,IAAI,GAAG,CAAE,GAAG,MAAM,EAAE,GAAG,CAAE,CAAC;QAChC,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,IAAI,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAEtC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC;YACpD,SAAS,CAAC,0CAA0C;QACtD,CAAC;QAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,IAAI,CAAC;gBACH,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;YACvC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAG,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;YACjE,CAAC;QACH,CAAC;aAAM,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAChF,IAAI,CAAC,KAAgC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;AACH,CAAC"}