@wirecat/cli-core 0.430.0 → 0.431.0

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 CHANGED
@@ -7,6 +7,19 @@ shape of this file.
7
7
 
8
8
  ## Unreleased
9
9
 
10
+ ## 0.431.0 — 25.10.2026
11
+
12
+ ### Added
13
+
14
+ - **`readConfigText(path)`, `readConfigFile(path)`, `withoutSetting(raw, setting)` and `settingPathOf(setting)` from `/cli`**, for a tool with its own config file and `config unset`. `readConfigText` gives the text, `undefined` for no file, or an issue for a folder at the path or a file that cannot be read. `readConfigFile` adds the JSON parse. `withoutSetting` removes one setting at any depth, list items included (`mail.accounts.0.colour`, `permissions.messages.send`), and any object the removal leaves empty, but keeps a list item so the items after it keep their numbers.
15
+
16
+ ### Fixed
17
+
18
+ - **A bad setting inside a list item is removed alone.** Before, `checkConfigText` could not reach into a list. It reported `mail.accounts.0.colour`, then loaded the rest of the file as empty, and missed issues elsewhere (an unknown permission key) until the next run. Now everything else loads, and every issue is found in one pass, in nested lists too. An item of the wrong type is dropped, and the items after it are still named by their place in the file. `config unset` with no profile reaches a path through a list.
19
+ - **A config file that cannot be read is reported, not taken for no file.** A folder at the path gives `invalid_value` "the path is a folder, not a file"; a file this user may not read gives "the file could not be read". Neither has a `fix`. `loadSnakeCaseConfig` refuses both instead of using its fallback.
20
+ - **A file holding a list, a string, a number or `null` is refused as a whole**: `invalid_value` "the file must hold a JSON object", with no `key` and no `fix`. Before, valibot read `[]` as `{}`.
21
+ - **`privateFiles` suggests no file mode for a folder where a file should be**, or for a file where a folder should be: the config issue says what is wrong.
22
+
10
23
  ## 0.430.0 — 25.10.2026
11
24
 
12
25
  ### Added
@@ -46,6 +46,21 @@ export declare const permissionIssues: (saved: readonly {
46
46
  }) => LocatedIssue[];
47
47
  /** The file without the settings the issues name: what still loads, and what `config unset` would leave. */
48
48
  export declare const withoutIssues: (raw: unknown, issues: readonly LocatedIssue[]) => unknown;
49
+ /** The path `config unset <setting>` names: a permission key keeps its dots; a number is a list item. */
50
+ export declare const settingPathOf: (setting: string) => string[];
51
+ /**
52
+ * The file without one setting, at any depth and inside list items, and without any object the removal left empty
53
+ * — a list item stays, so the items after it keep their numbers. `removed` is false when nothing was there.
54
+ */
55
+ export declare const withoutPath: (raw: unknown, at: readonly string[]) => {
56
+ config: unknown;
57
+ removed: boolean;
58
+ };
59
+ /** `withoutPath` for a setting as `config unset` takes it: `mail.accounts.0.colour`, `permissions.messages.send`. */
60
+ export declare const withoutSetting: (raw: unknown, setting: string) => {
61
+ config: unknown;
62
+ removed: boolean;
63
+ };
49
64
  /** The public shape: where in the file is the loader's own business. */
50
65
  export declare const publicIssue: ({ at: _, ...issue }: LocatedIssue) => ConfigIssue;
51
66
  /**
@@ -68,3 +83,18 @@ export declare const checkConfigText: <T extends v.GenericSchema>(text: string,
68
83
  issues: ConfigIssue[];
69
84
  config: v.InferOutput<T> | undefined;
70
85
  };
86
+ /**
87
+ * A config file's text, `undefined` when there is no file, or the issue when one is there and cannot be read: a
88
+ * folder at the path, or a file this user may not read. Neither has a fix `config` could run.
89
+ */
90
+ export declare const readConfigText: (path: string) => {
91
+ text: string | undefined;
92
+ } | {
93
+ issue: ConfigIssue;
94
+ };
95
+ /** A config file as written, `raw: undefined` when there is none, or the one issue that stops it being read. */
96
+ export declare const readConfigFile: (path: string) => {
97
+ raw: unknown;
98
+ } | {
99
+ issue: ConfigIssue;
100
+ };
@@ -1,3 +1,4 @@
1
+ import { readFileSync } from "node:fs";
1
2
  import * as v from "valibot";
2
3
  const isNode = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
3
4
  const SECTIONS = ["personal", "bot"];
@@ -171,12 +172,12 @@ const ruleOf = (issue) => {
171
172
  return issue.expected === null ? "has a value it does not take" : `has to be ${issue.expected}`;
172
173
  };
173
174
  /** One pass of the schema: valibot names only the first unknown key of each object. */
174
- const onePass = (raw, schema, context) => {
175
+ const onePass = (raw, schema, context, original) => {
175
176
  const result = v.safeParse(schema, raw);
176
177
  if (result.success)
177
178
  return [];
178
179
  return result.issues.map((issue) => {
179
- const at = keyOfPath(issue);
180
+ const at = original(keyOfPath(issue));
180
181
  const located = isPermissionKey(issue, at)
181
182
  ? locate("unknown_permission", at, context, (key) => `${key} names no command`)
182
183
  : isUnknownKey(issue)
@@ -186,6 +187,8 @@ const onePass = (raw, schema, context) => {
186
187
  : locate("invalid_value", at, context, (key) => at.length === 0 ? "the file has to be an object, in braces" : `setting ${key} ${ruleOf(issue)}`);
187
188
  if (located.kind === "missing_setting" || at.length === 0)
188
189
  delete located.fix;
190
+ if (at.length === 0)
191
+ delete located.key;
189
192
  return located;
190
193
  });
191
194
  };
@@ -193,7 +196,8 @@ const onePass = (raw, schema, context) => {
193
196
  export const schemaIssues = (raw, schema, context) => {
194
197
  const found = new Map();
195
198
  for (;;) {
196
- const fresh = onePass(withoutIssues(raw, [...found.values()]), schema, context).filter((issue) => !found.has(issue.at.join("\u0000")));
199
+ const { pruned, original } = prune(raw, [...found.values()].map(({ at }) => at));
200
+ const fresh = onePass(pruned, schema, context, original).filter((issue) => !found.has(issue.at.join("\u0000")));
197
201
  if (fresh.length === 0)
198
202
  return [...found.values()];
199
203
  for (const issue of fresh)
@@ -235,18 +239,60 @@ export const savedPermissionKeys = (raw) => scopes(raw).flatMap(([path, scope])
235
239
  export const permissionIssues = (saved, known, context) => saved
236
240
  .filter(({ key }) => !known.has(key))
237
241
  .map(({ at }) => locate("unknown_permission", at, context, (key) => `${key} names no command`));
242
+ const pathId = (path) => path.join("\u0000");
243
+ /**
244
+ * The file without the parts at `paths`, through objects and lists alike, and a map from a path in what is left
245
+ * back to the file: a list that lost an item numbers the rest differently.
246
+ */
247
+ const prune = (raw, paths) => {
248
+ const drop = new Set(paths.map(pathId));
249
+ const kept = new Map();
250
+ const walk = (node, at) => {
251
+ if (Array.isArray(node)) {
252
+ const indices = node.flatMap((_, index) => (drop.has(pathId([...at, String(index)])) ? [] : [index]));
253
+ kept.set(pathId(at), indices);
254
+ return indices.map((index) => walk(node[index], [...at, String(index)]));
255
+ }
256
+ if (!isNode(node))
257
+ return node;
258
+ return Object.fromEntries(Object.entries(node).flatMap(([key, item]) => drop.has(pathId([...at, key])) ? [] : [[key, walk(item, [...at, key])]]));
259
+ };
260
+ const pruned = drop.has("") ? {} : walk(raw, []);
261
+ const original = (path) => {
262
+ const at = [];
263
+ for (const part of path) {
264
+ const indices = kept.get(pathId(at));
265
+ at.push(indices ? String(indices[Number(part)] ?? part) : part);
266
+ }
267
+ return at;
268
+ };
269
+ return { pruned, original };
270
+ };
238
271
  /** The file without the settings the issues name: what still loads, and what `config unset` would leave. */
239
- export const withoutIssues = (raw, issues) => {
240
- if (issues.some((issue) => issue.at.length === 0))
241
- return {};
242
- const copy = structuredClone(raw);
243
- for (const { at } of issues) {
244
- const parent = at.slice(0, -1).reduce((node, key) => (isNode(node) ? node[key] : undefined), copy);
245
- if (isNode(parent))
246
- delete parent[at.at(-1)];
272
+ export const withoutIssues = (raw, issues) => prune(raw, issues.map(({ at }) => at)).pruned;
273
+ /** The path `config unset <setting>` names: a permission key keeps its dots; a number is a list item. */
274
+ export const settingPathOf = (setting) => setting.startsWith("permissions.") ? ["permissions", setting.slice("permissions.".length)] : setting.split(".");
275
+ /**
276
+ * The file without one setting, at any depth and inside list items, and without any object the removal left empty
277
+ * — a list item stays, so the items after it keep their numbers. `removed` is false when nothing was there.
278
+ */
279
+ export const withoutPath = (raw, at) => {
280
+ const valueAt = (path) => path.reduce((node, key) => (isNode(node) || Array.isArray(node) ? node[key] : undefined), raw);
281
+ if (at.length === 0 || valueAt(at) === undefined)
282
+ return { config: raw, removed: false };
283
+ let gone = [...at];
284
+ for (let parent = at.slice(0, -1); parent.length > 0; parent = parent.slice(0, -1)) {
285
+ if (Array.isArray(valueAt(parent.slice(0, -1))))
286
+ break;
287
+ const node = valueAt(parent);
288
+ if (!isNode(node) || Object.keys(node).some((key) => pathId([...parent, key]) !== pathId(gone)))
289
+ break;
290
+ gone = parent;
247
291
  }
248
- return copy;
292
+ return { config: prune(raw, [gone]).pruned, removed: true };
249
293
  };
294
+ /** `withoutPath` for a setting as `config unset` takes it: `mail.accounts.0.colour`, `permissions.messages.send`. */
295
+ export const withoutSetting = (raw, setting) => withoutPath(raw, settingPathOf(setting));
250
296
  /** The public shape: where in the file is the loader's own business. */
251
297
  export const publicIssue = ({ at: _, ...issue }) => issue;
252
298
  /**
@@ -272,6 +318,9 @@ export const checkConfigText = (text, { file, tool, schema, knownPermissions, })
272
318
  const parsed = parseConfigText(text, file);
273
319
  if ("issue" in parsed)
274
320
  return { issues: [publicIssue(parsed.issue)], config: undefined };
321
+ // valibot reads a list as an object, so `[]` would pass for `{}`.
322
+ if (!isNode(parsed.raw))
323
+ return { issues: [wholeFile(file, "the file must hold a JSON object")], config: undefined };
275
324
  const context = { file, tool };
276
325
  const located = schemaIssues(parsed.raw, schema, context);
277
326
  const loaded = v.safeParse(schema, withoutIssues(parsed.raw, located));
@@ -279,3 +328,32 @@ export const checkConfigText = (text, { file, tool, schema, knownPermissions, })
279
328
  const unknown = knownPermissions ? permissionIssues(savedPermissionKeys(config), knownPermissions, context) : [];
280
329
  return { issues: [...located, ...unknown].map(publicIssue), config };
281
330
  };
331
+ /** A problem with the file as a whole: no setting to name, and no `config unset` to remove it. */
332
+ const wholeFile = (file, what) => ({ kind: "invalid_value", file, what });
333
+ /**
334
+ * A config file's text, `undefined` when there is no file, or the issue when one is there and cannot be read: a
335
+ * folder at the path, or a file this user may not read. Neither has a fix `config` could run.
336
+ */
337
+ export const readConfigText = (path) => {
338
+ try {
339
+ return { text: readFileSync(path, "utf8") };
340
+ }
341
+ catch (error) {
342
+ const code = error.code;
343
+ if (code === "ENOENT")
344
+ return { text: undefined };
345
+ return {
346
+ issue: wholeFile(path, code === "EISDIR" ? "the path is a folder, not a file" : "the file could not be read"),
347
+ };
348
+ }
349
+ };
350
+ /** A config file as written, `raw: undefined` when there is none, or the one issue that stops it being read. */
351
+ export const readConfigFile = (path) => {
352
+ const read = readConfigText(path);
353
+ if ("issue" in read)
354
+ return read;
355
+ if (read.text === undefined)
356
+ return { raw: undefined };
357
+ const parsed = parseConfigText(read.text, path);
358
+ return "issue" in parsed ? { issue: publicIssue(parsed.issue) } : parsed;
359
+ };
@@ -1,6 +1,6 @@
1
- import { readFileSync } from "node:fs";
2
1
  import { CliError } from "@wirecat/cli-base";
3
2
  import * as v from "valibot";
3
+ import { readConfigText } from "./config-issues.js";
4
4
  const reasonOf = (issue) => {
5
5
  if (issue.expected === "never")
6
6
  return "is an unknown setting";
@@ -23,13 +23,12 @@ const problemOf = (issues) => {
23
23
  };
24
24
  /** Reads and checks a config file; a missing one is the fallback, a broken one an error naming its first problem. */
25
25
  export const loadSnakeCaseConfig = (path, schema, fallback) => {
26
- let text;
27
- try {
28
- text = readFileSync(path, "utf8");
29
- }
30
- catch {
26
+ const read = readConfigText(path);
27
+ if ("issue" in read)
28
+ throw new CliError("configuration_error", `${path}: ${read.issue.what}`);
29
+ if (read.text === undefined)
31
30
  return fallback();
32
- }
31
+ const text = read.text;
33
32
  let parsed;
34
33
  try {
35
34
  parsed = JSON.parse(text);
@@ -53,7 +53,7 @@ export { commandContract, type JsonSchema, SCHEMA_DIALECT } from "./command-cont
53
53
  export { type CommandRunOptions, type CommandRuns, commandRuns, providerEvent, providerRequest, type RunSettings, recordRuns, runSettings, type SavedRunSettings, } from "./command-runs.js";
54
54
  export { CONTRACT } from "./commands-command.js";
55
55
  export { refuseUnknownKey } from "./config-command.js";
56
- export { type ConfigIssue, type ConfigIssueKind, checkConfigText, issueMessage } from "./config-issues.js";
56
+ export { type ConfigIssue, type ConfigIssueKind, checkConfigText, issueMessage, readConfigFile, readConfigText, settingPathOf, withoutSetting, } from "./config-issues.js";
57
57
  export { loadSnakeCaseConfig } from "./config-keys.js";
58
58
  export { type AgentRun, type BaseContext, type BaseEnvironment, baseContext, environmentOf, outputFor, provide, secretInputOf, } from "./context.js";
59
59
  export { addContractInfo, type ContractEvidenceOptions, contractEvidence } from "./contract-evidence.js";
package/dist/cli/index.js CHANGED
@@ -46,7 +46,7 @@ export { commandContract, SCHEMA_DIALECT } from "./command-contract.js";
46
46
  export { commandRuns, providerEvent, providerRequest, recordRuns, runSettings, } from "./command-runs.js";
47
47
  export { CONTRACT } from "./commands-command.js";
48
48
  export { refuseUnknownKey } from "./config-command.js";
49
- export { checkConfigText, issueMessage } from "./config-issues.js";
49
+ export { checkConfigText, issueMessage, readConfigFile, readConfigText, settingPathOf, withoutSetting, } from "./config-issues.js";
50
50
  export { loadSnakeCaseConfig } from "./config-keys.js";
51
51
  export { baseContext, environmentOf, outputFor, provide, secretInputOf, } from "./context.js";
52
52
  export { addContractInfo, contractEvidence } from "./contract-evidence.js";
@@ -8,19 +8,23 @@ export const privateFiles = ({ files, dirs }, platform = process.platform) => {
8
8
  if (platform === "win32")
9
9
  return { checked: false, reason: "Windows has no Unix file modes" };
10
10
  const problems = [];
11
- const check = (path, want) => {
11
+ // A folder where a file should be, or the reverse, is a problem of its own; a mode is no fix for it.
12
+ const check = (path, want, folder) => {
12
13
  if (!existsSync(path))
13
14
  return;
14
- const mode = statSync(path).mode & 0o777;
15
+ const stat = statSync(path);
16
+ if (stat.isDirectory() !== folder)
17
+ return;
18
+ const mode = stat.mode & 0o777;
15
19
  if ((mode & 0o077) === 0)
16
20
  return;
17
21
  const octal = (value) => `0${value.toString(8)}`;
18
22
  problems.push({ path, mode: octal(mode), want: octal(want), fix: `chmod ${want.toString(8)} ${shellQuoted(path)}` });
19
23
  };
20
24
  for (const file of files)
21
- check(file, 0o600);
25
+ check(file, 0o600, false);
22
26
  for (const dir of dirs)
23
- check(dir, 0o700);
27
+ check(dir, 0o700, true);
24
28
  return { checked: true, ok: problems.length === 0, problems };
25
29
  };
26
30
  /** A SQLite database in write-ahead mode keeps its newest pages beside it. */
@@ -1,4 +1,4 @@
1
- import { existsSync, readFileSync } from "node:fs";
1
+ import { existsSync } from "node:fs";
2
2
  import { CliError, configFilePath, resolvePaths, saveConfigFile } from "@wirecat/cli-base";
3
3
  import * as v from "valibot";
4
4
  import { AI_ENTRIES, resolveAISettings } from "../analysis/settings.js";
@@ -7,7 +7,7 @@ import { envName, readOnlyLockOf } from "../ports/app.js";
7
7
  import { assertOverridesTighten, CEILING_KEY, LEVELS, layerPermissions, permissionOverrides, RESOURCES, } from "../sends/permissions.js";
8
8
  import { storePath } from "../store/path.js";
9
9
  import { sharedConfigPath } from "../store/shared-config.js";
10
- import { checkConfigText, issueMessage, parseConfigText, publicIssue, savedPermissionKeys, schemaIssues, } from "./config-issues.js";
10
+ import { checkConfigText, issueMessage, readConfigFile, readConfigText, savedPermissionKeys, schemaIssues, settingPathOf, withoutPath, } from "./config-issues.js";
11
11
  import { DEFAULT_CONFIG, ensureDefaultConfig } from "./default-config.js";
12
12
  import { profilesHere } from "./messenger/accounts.js";
13
13
  import { usableProfileName } from "./profile.js";
@@ -144,27 +144,14 @@ export const settingsFor = (app, extension = {}) => {
144
144
  const configPathFor = ({ env = process.env, configDir }) => configFilePath(configDir ?? resolvePaths({ appName: app.appName, prefix: app.envPrefix, env }).config);
145
145
  const readSchema = extension.schema ?? schema;
146
146
  const context = (file) => ({ file, tool: app.command });
147
- /** The file as written, `undefined` when there is none, or the issue that says it is not JSON. */
148
- const readRaw = (path) => {
149
- let text;
150
- try {
151
- text = readFileSync(path, "utf8");
152
- }
153
- catch {
154
- return { raw: undefined };
155
- }
156
- return parseConfigText(text, path);
157
- };
158
147
  /** The file with every problem found; what loads is the file without the settings they name. */
159
148
  const loadConfig = (path) => {
160
- let text;
161
- try {
162
- text = readFileSync(path, "utf8");
163
- }
164
- catch {
149
+ const read = readConfigText(path);
150
+ if ("issue" in read)
151
+ return { config: { profiles: {} }, issues: [read.issue] };
152
+ if (read.text === undefined)
165
153
  return { config: { profiles: {} }, issues: [] };
166
- }
167
- const { config, issues } = checkConfigText(text, { file: path, tool: app.command, schema: readSchema });
154
+ const { config, issues } = checkConfigText(read.text, { file: path, tool: app.command, schema: readSchema });
168
155
  return { config: (config ?? { profiles: {} }), issues };
169
156
  };
170
157
  /**
@@ -365,9 +352,9 @@ export const settingsFor = (app, extension = {}) => {
365
352
  const level = name === "permissions" && rest.length > 0 ? rest.join(".") : undefined;
366
353
  const modelField = /^models\.([a-z][a-z0-9-]*)\.(provider|model|base_url)$/.exec(setting);
367
354
  const known = allSettings.includes(setting) || level !== undefined || modelField !== null;
368
- const read = readRaw(path);
355
+ const read = readConfigFile(path);
369
356
  if ("issue" in read)
370
- throw new CliError("configuration_error", issueMessage([publicIssue(read.issue)]));
357
+ throw new CliError("configuration_error", issueMessage([read.issue]));
371
358
  const raw = read.raw === undefined ? {} : read.raw;
372
359
  if (!isScope(raw))
373
360
  throw new CliError("configuration_error", `${path}: the file has to be an object, in braces`);
@@ -375,7 +362,7 @@ export const settingsFor = (app, extension = {}) => {
375
362
  ? []
376
363
  : [...(kind === undefined ? [] : [kind]), ...(profile === undefined ? ["defaults"] : ["profiles", profile])];
377
364
  const keyPath = root
378
- ? setting.split(".")
365
+ ? settingPathOf(setting)
379
366
  : level !== undefined
380
367
  ? ["permissions", level]
381
368
  : modelField
@@ -388,9 +375,7 @@ export const settingsFor = (app, extension = {}) => {
388
375
  throw new CliError("validation_error", `${setting} has no problem to remove — name the profile, or add --defaults, to unset a setting`);
389
376
  if (!known && valueAt(raw, at) === undefined)
390
377
  throw new CliError("validation_error", `no setting called "${setting}" — one of: ${allSettings.join(", ")}`);
391
- const changed = structuredClone(raw);
392
- removeAt(changed, at);
393
- saveConfigFile(path, changed);
378
+ saveConfigFile(path, withoutPath(raw, at).config);
394
379
  return null;
395
380
  }
396
381
  if (!known)
@@ -417,7 +402,7 @@ export const settingsFor = (app, extension = {}) => {
417
402
  return { resolveSettings, configuredProfiles, changeSetting, allSettings, defaultsOnlyKeys, schema };
418
403
  };
419
404
  const isScope = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
420
- const valueAt = (node, path) => path.reduce((at, key) => (isScope(at) ? at[key] : undefined), node);
405
+ const valueAt = (node, path) => path.reduce((at, key) => (isScope(at) || Array.isArray(at) ? at[key] : undefined), node);
421
406
  const setAt = (node, path, value) => {
422
407
  let at = node;
423
408
  for (const key of path.slice(0, -1)) {
@@ -427,22 +412,6 @@ const setAt = (node, path, value) => {
427
412
  }
428
413
  at[path.at(-1)] = value;
429
414
  };
430
- /** Removes the value and every section it leaves empty, so an unset leaves no `{}` behind. */
431
- const removeAt = (node, path) => {
432
- const [key, ...rest] = path;
433
- if (key === undefined)
434
- return;
435
- if (rest.length === 0) {
436
- delete node[key];
437
- return;
438
- }
439
- const child = node[key];
440
- if (!isScope(child))
441
- return;
442
- removeAt(child, rest);
443
- if (Object.keys(child).length === 0)
444
- delete node[key];
445
- };
446
415
  /** Every profile the file names, in any section. */
447
416
  const namedProfiles = (config) => [
448
417
  ...new Set([
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wirecat/cli-core",
3
- "version": "0.430.0",
3
+ "version": "0.431.0",
4
4
  "description": "The messenger-neutral half of a messaging CLI: domain model, message locators, rendering, name resolution, the SQLite seam, the command skeleton and shared read commands, the send guard, run records and the message store",
5
5
  "license": "Apache-2.0",
6
6
  "author": "Viacheslav Ptsarev",