@flowscripter/dynamic-cli-framework 12.1.0 → 12.2.0

package/dist/src/cli/BaseCLI.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BaseCLI.d.ts","sourceRoot":"","sources":["../../../src/cli/BaseCLI.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,yCAAyC,CAAC;AACnE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAIzE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AAGvE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAC/E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAsBzE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AAW3E,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,QAAQ,MAAM,yBAAyB,CAAC;AAGpD,OAAO,KAAK,MAAM,MAAM,uBAAuB,CAAC;AAEhD,OAAO,KAAK,SAAS,MAAM,0BAA0B,CAAC;AACtD,OAAO,KAAK,qBAAqB,MAAM,4BAA4B,CAAC;AAqCpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,CAAC,OAAO,OAAO,OAAQ,YAAW,GAAG;;IAazC,YACE,SAAS,EAAE,SAAS,EACpB,oBAAoB,EAAE,cAAc,EACpC,oBAAoB,EAAE,cAAc,EACpC,aAAa,EAAE,OAAO,EACtB,aAAa,EAAE,OAAO,EACtB,cAAc,EAAE,QAAQ,EACxB,cAAc,EAAE,QAAQ,EACxB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,SAAS,GAAG,SAAS,EAChC,OAAO,CAAC,EAAE,qBAAqB,EAwEhC;IAED;;;;;;;OAOG;IACI,kBAAkB,CAAC,eAAe,EAAE,eAAe,QAEzD;IAED;;;;;;;;OAQG;IACH;;;;;OAKG;IACI,cAAc,CAAC,IAAI,EAAE,WAAW,QAEtC;IAEM,UAAU,CAAC,OAAO,EAAE,OAAO,QAQjC;IAEK,GAAG,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CA4QzD;CACF"}
+{"version":3,"file":"BaseCLI.d.ts","sourceRoot":"","sources":["../../../src/cli/BaseCLI.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,yCAAyC,CAAC;AACnE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAIzE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AAGvE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAC/E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAsBzE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yCAAyC,CAAC;AAW3E,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,QAAQ,MAAM,yBAAyB,CAAC;AAGpD,OAAO,KAAK,MAAM,MAAM,uBAAuB,CAAC;AAEhD,OAAO,KAAK,SAAS,MAAM,0BAA0B,CAAC;AACtD,OAAO,KAAK,qBAAqB,MAAM,4BAA4B,CAAC;AAqCpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,CAAC,OAAO,OAAO,OAAQ,YAAW,GAAG;;IAazC,YACE,SAAS,EAAE,SAAS,EACpB,oBAAoB,EAAE,cAAc,EACpC,oBAAoB,EAAE,cAAc,EACpC,aAAa,EAAE,OAAO,EACtB,aAAa,EAAE,OAAO,EACtB,cAAc,EAAE,QAAQ,EACxB,cAAc,EAAE,QAAQ,EACxB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,SAAS,GAAG,SAAS,EAChC,OAAO,CAAC,EAAE,qBAAqB,EAwEhC;IAED;;;;;;;OAOG;IACI,kBAAkB,CAAC,eAAe,EAAE,eAAe,QAEzD;IAED;;;;;;;;OAQG;IACH;;;;;OAKG;IACI,cAAc,CAAC,IAAI,EAAE,WAAW,QAEtC;IAEM,UAAU,CAAC,OAAO,EAAE,OAAO,QAQjC;IAEK,GAAG,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CA6QzD;CACF"}

package/dist/src/cli/BaseCLI.js

@@ -247,7 +247,7 @@ export default class BaseCLI {
         if (this.#options.pluginServiceEnabled) {
             this.addServiceProvider(new PluginServiceProvider(PLUGIN_SERVICE_PRIORITY, this.#options.pluginServiceRemoteConfig, this.#options.pluginServiceLocalConfig, this.#commandRegistry, this.#serviceProviderRegistry));
         }
-        const configurationServiceProvider = new ConfigurationServiceProvider(CONFIGURATION_SERVICE_PRIORITY, this.#options.envVarsSupportEnabled, this.#options.configFileSupportEnabled, this.#options.secretServiceEnabled, this.#options.configFormat);
+        const configurationServiceProvider = new ConfigurationServiceProvider(CONFIGURATION_SERVICE_PRIORITY, this.#options.envVarsSupportEnabled, this.#options.configFileSupportEnabled, this.#options.secretServiceEnabled, this.#options.configFormat, this.#commandRegistry);
         this.addServiceProvider(configurationServiceProvider);
         const keyValueServiceProvider = new KeyValueServiceProvider(KEY_VALUE_SERVICE_PRIORITY, configurationServiceProvider, this.#options.keyValueServiceEnabled, this.#options.secretServiceEnabled);
         this.addServiceProvider(keyValueServiceProvider);

package/dist/src/runtime/runner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runner.d.ts","sourceRoot":"","sources":["../../../src/runtime/runner.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAEzE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAkB/E,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,yCAAyC,CAAC;AAEvF,OAAO,KAAK,4BAA4B,MAAM,0DAA0D,CAAC;AACzG,OAAO,KAAK,uBAAuB,MAAM,qDAAqD,CAAC;AAK/F,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AAKvE,OAAO,qBAAqB,MAAM,6CAA6C,CAAC;AAMhF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG;IAAE,QAAQ,CAAC,aAAa,CAAC,EAAE,IAAI,CAAA;CAAE,CAAC;AAsfzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2EG;AACH,wBAAsB,GAAG,CACvB,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,EAC3B,eAAe,EAAE,eAAe,EAChC,uBAAuB,EAAE,uBAAuB,EAChD,4BAA4B,EAAE,4BAA4B,GAAG,SAAS,EACtE,uBAAuB,EAAE,uBAAuB,GAAG,SAAS,EAC5D,OAAO,EAAE,OAAO,EAChB,cAAc,CAAC,EAAE,OAAO,EACxB,cAAc,CAAC,EAAE,qBAAqB,GACrC,OAAO,CAAC,YAAY,CAAC,CAkKvB"}
+{"version":3,"file":"runner.d.ts","sourceRoot":"","sources":["../../../src/runtime/runner.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAEzE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAkB/E,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,yCAAyC,CAAC;AAEvF,OAAO,KAAK,4BAA4B,MAAM,0DAA0D,CAAC;AACzG,OAAO,KAAK,uBAAuB,MAAM,qDAAqD,CAAC;AAK/F,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AAKvE,OAAO,qBAAqB,MAAM,6CAA6C,CAAC;AAMhF;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG;IAAE,QAAQ,CAAC,aAAa,CAAC,EAAE,IAAI,CAAA;CAAE,CAAC;AAyfzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2EG;AACH,wBAAsB,GAAG,CACvB,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,EAC3B,eAAe,EAAE,eAAe,EAChC,uBAAuB,EAAE,uBAAuB,EAChD,4BAA4B,EAAE,4BAA4B,GAAG,SAAS,EACtE,uBAAuB,EAAE,uBAAuB,GAAG,SAAS,EAC5D,OAAO,EAAE,OAAO,EAChB,cAAc,CAAC,EAAE,OAAO,EACxB,cAAc,CAAC,EAAE,qBAAqB,GACrC,OAAO,CAAC,YAAY,CAAC,CAkKvB"}

package/dist/src/runtime/runner.js

@@ -62,8 +62,11 @@ async function executeParsedCommand(parseResult, context, keyValueServiceProvide
             await parseResult.groupCommand.execute(groupContext);
         }
         logger.debug("Executing command with name: %s and args: %O", parseResult.command.name, parseResult.populatedArgumentValues);
+        const commandScopeKey = parseResult.groupCommand
+            ? `${parseResult.groupCommand.name}:${parseResult.command.name}`
+            : parseResult.command.name;
         const commandContext = keyValueServiceProvider
-            ? keyValueServiceProvider.getContextForScope(context, "command", parseResult.command.name)
+            ? keyValueServiceProvider.getContextForScope(context, "command", commandScopeKey)
             : context;
         if (isSubCommand(parseResult.command)) {
             await parseResult.command.execute(commandContext, parseResult.populatedArgumentValues);

package/dist/src/service/configuration/ConfigurationServiceProvider.d.ts

@@ -2,21 +2,22 @@ import type { ServiceInfo, ServiceProvider } from "@flowscripter/dynamic-cli-fra
 import type { SingleValueType, Values, ValueNode, PopulatedValues, PopulatedValueType } from "@flowscripter/dynamic-cli-framework-api";
 import type { Context } from "@flowscripter/dynamic-cli-framework-api";
 import type { GroupCommand } from "@flowscripter/dynamic-cli-framework-api";
+import type { CommandRegistry } from "@flowscripter/dynamic-cli-framework-api";
+import DefaultConfigurationService, { type KeyValueServiceScopeType } from "./DefaultConfigurationService.ts";
+import { type SecretsApi } from "./DefaultSecretService.ts";
 import type ConfigFormat from "./format/ConfigFormat.ts";
 import type { Command } from "@flowscripter/dynamic-cli-framework-api";
 import type { CLIConfig } from "@flowscripter/dynamic-cli-framework-api";
-export type KeyValueServiceScopeType = "command" | "service";
+export type { KeyValueServiceScopeType };
 /**
  * Provides configuration of default command arguments using a configuration file and/or
  * environment variables.
  *
  * The same configuration file also backs the raw, per-scope key-value data consumed by
  * {@link KeyValueServiceProvider} (which holds a direct reference to this provider - see
- * {@link getKeyValueData} and {@link flushIfDirty} - rather than looking this provider up via
- * {@link Context}, since only {@link configLocation}/{@link setConfigLocation} are safe to expose
- * generally; {@link getConfigString} is wired directly to {@link ConfigDumpSubCommand} for the same
- * reason - a full config dump would leak every other command's/service's key-value data if it
- * were reachable through a general lookup).
+ * {@link getKeyValueData} and {@link flushIfDirty}). The configuration data and its persistence are
+ * owned by {@link DefaultConfigurationService}, which is passed directly to the `config` group commands. Only a
+ * view exposing the config file location is registered under {@link CONFIGURATION_SERVICE_ID}.
  *
  * **Default Command Arguments**
  *
@@ -67,10 +68,10 @@ export type KeyValueServiceScopeType = "command" | "service";
  * default configuration will be used. The location of the configuration file can be modified via the
  * {@link ConfigCommand}.
  *
- * NOTE: You may store default arguments for secrets by manually configuring secrets in your OS
- * credential store and referencing them in the config file using the sentinel format
- * `__SECRET__:<bun_secret_name>`. These values will be resolved from the OS secret store
- * before being returned as default argument values. See {@link KeyValueServiceProvider} for the
+ * NOTE: Secrets in default arguments are referenced in the config file or an environment variable using
+ * the sentinel format `__SECRET__:<bun_secret_name>` and resolved from the OS secret store before being
+ * returned as default argument values. A command's defaults may only reference secrets stored for that
+ * command via `config set` (named `defaults_Z<command>_Z<option path>`, each part escaped). See {@link KeyValueServiceProvider} for the
  * generic key-value store which uses the same secret sentinel mechanism.
  *
  * *Environment Variables*
@@ -120,8 +121,6 @@ export default class ConfigurationServiceProvider implements ServiceProvider {
     readonly configEnabled: boolean;
     readonly secretServiceEnabled: boolean;
     readonly configFormat: ConfigFormat;
-    configLocation: string | undefined;
-    defaultsData: Map<string, Values | SingleValueType>;
     /**
      * Create an instance of the service provider with the specified details.
      *
@@ -131,9 +130,20 @@ export default class ConfigurationServiceProvider implements ServiceProvider {
      * @param secretServiceEnabled optionally enable OS-native secret storage via Bun.secrets for resolving
      * secrets embedded in default argument values: `configEnabled` must be true in this case
      * @param configFormat optionally set the syntax of the configuration file, defaults to JSON.
+     * @param commandRegistry optionally provide the registry of all commands, required for the `config:get`,
+     * `config:set` and `config:unset` commands to be provided.
+     * @param secretsApi optionally override the OS secret store used for storing SECRET default values.
      */
-    constructor(servicePriority: number, envVarsEnabled?: boolean, configEnabled?: boolean, secretServiceEnabled?: boolean, configFormat?: ConfigFormat);
+    constructor(servicePriority: number, envVarsEnabled?: boolean, configEnabled?: boolean, secretServiceEnabled?: boolean, configFormat?: ConfigFormat, commandRegistry?: CommandRegistry, secretsApi?: SecretsApi);
     getServiceInfo(cliConfig: CLIConfig): Promise<ServiceInfo>;
+    /**
+     * The {@link DefaultConfigurationService} which owns the configuration data, for trusted wiring and tests.
+     */
+    get configurationService(): DefaultConfigurationService;
+    get configLocation(): string | undefined;
+    set configLocation(location: string | undefined);
+    get defaultsData(): Map<string, Values | SingleValueType>;
+    set defaultsData(data: Map<string, Values | SingleValueType>);
     setConfigLocation(configLocation: string): void;
     /**
      * Retrieve the default command argument values (if any) for the provided {@link Command}.

package/dist/src/service/configuration/ConfigurationServiceProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ConfigurationServiceProvider.d.ts","sourceRoot":"","sources":["../../../../src/service/configuration/ConfigurationServiceProvider.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAE5F,OAAO,KAAK,EACV,eAAe,EACf,MAAM,EACN,SAAS,EACT,eAAe,EACf,kBAAkB,EACnB,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yCAAyC,CAAC;AAS5E,OAAO,KAAK,YAAY,MAAM,0BAA0B,CAAC;AAIzD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AAOvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAQzE,MAAM,MAAM,wBAAwB,GAAG,SAAS,GAAG,SAAS,CAAC;AAkB7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyGG;AACH,MAAM,CAAC,OAAO,OAAO,4BAA6B,YAAW,eAAe;;IAC1E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAA4B;IACtD,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAEjC,SAAgB,cAAc,EAAE,OAAO,CAAC;IACxC,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC,SAAgB,oBAAoB,EAAE,OAAO,CAAC;IAC9C,SAAgB,YAAY,EAAE,YAAY,CAAC;IAGpC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAQnC,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,CAAC,CAAa;IAqBvE;;;;;;;;;OASG;IACH,YACE,eAAe,EAAE,MAAM,EACvB,cAAc,UAAQ,EACtB,aAAa,UAAQ,EACrB,oBAAoB,UAAQ,EAC5B,YAAY,GAAE,YAAyB,EAYxC;IAEM,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAiBhE;IAEM,iBAAiB,CAAC,cAAc,EAAE,MAAM,QAE9C;IAED;;;;;;;;;OASG;IACU,wBAAwB,CACnC,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,OAAO,EAChB,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,eAAe,GAAG,kBAAkB,GAAG,SAAS,CAAC,CAsD3D;IAED;;;;;;OAMG;IACI,eAAe,CACpB,SAAS,EAAE,wBAAwB,EACnC,QAAQ,EAAE,MAAM,GACf,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAOxB;IAED;;;;;;OAMG;IACU,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAQzD;IAEY,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CA6CxD;IAgEM,eAAe,IAAI,MAAM,CAE/B;CAmCF"}
+{"version":3,"file":"ConfigurationServiceProvider.d.ts","sourceRoot":"","sources":["../../../../src/service/configuration/ConfigurationServiceProvider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAE5F,OAAO,KAAK,EACV,eAAe,EACf,MAAM,EACN,SAAS,EACT,eAAe,EACf,kBAAkB,EACnB,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,KAAK,EAAc,YAAY,EAAE,MAAM,yCAAyC,CAAC;AAMxF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAK/E,OAAO,2BAA2B,EAAE,EAClC,KAAK,wBAAwB,EAC9B,MAAM,kCAAkC,CAAC;AAC1C,OAA6B,EAAE,KAAK,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAClF,OAAO,KAAK,YAAY,MAAM,0BAA0B,CAAC;AAEzD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AAOvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAMzE,YAAY,EAAE,wBAAwB,EAAE,CAAC;AA0BzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuGG;AACH,MAAM,CAAC,OAAO,OAAO,4BAA6B,YAAW,eAAe;;IAC1E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAA4B;IACtD,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAEjC,SAAgB,cAAc,EAAE,OAAO,CAAC;IACxC,SAAgB,aAAa,EAAE,OAAO,CAAC;IACvC,SAAgB,oBAAoB,EAAE,OAAO,CAAC;IAC9C,SAAgB,YAAY,EAAE,YAAY,CAAC;IAY3C;;;;;;;;;;;;OAYG;IACH,YACE,eAAe,EAAE,MAAM,EACvB,cAAc,UAAQ,EACtB,aAAa,UAAQ,EACrB,oBAAoB,UAAQ,EAC5B,YAAY,GAAE,YAAyB,EACvC,eAAe,CAAC,EAAE,eAAe,EACjC,UAAU,CAAC,EAAE,UAAU,EAkBxB;IAEM,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAyBhE;IAED;;OAEG;IACH,IAAW,oBAAoB,IAAI,2BAA2B,CAE7D;IAED,IAAW,cAAc,IAAI,MAAM,GAAG,SAAS,CAE9C;IAED,IAAW,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAErD;IAED,IAAW,YAAY,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,CAAC,CAE/D;IAED,IAAW,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,CAAC,EAElE;IAEM,iBAAiB,CAAC,cAAc,EAAE,MAAM,QAE9C;IAED;;;;;;;;;OASG;IACU,wBAAwB,CACnC,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,OAAO,EAChB,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,eAAe,GAAG,kBAAkB,GAAG,SAAS,CAAC,CA2C3D;IAED;;;;;;OAMG;IACI,eAAe,CACpB,SAAS,EAAE,wBAAwB,EACnC,QAAQ,EAAE,MAAM,GACf,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAExB;IAED;;;;;;OAMG;IACI,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAEnD;IAEY,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAKxD;IAEM,eAAe,IAAI,MAAM,CAE/B;CACF"}

package/dist/src/service/configuration/ConfigurationServiceProvider.js

@@ -1,29 +1,34 @@
-import process from "node:process";
-import path from "node:path";
-import fs from "node:fs/promises";
-import { Stats } from "node:fs";
 import ConfigCommand from "./command/ConfigCommand.js";
 import getLogger from "../../util/logger.js";
 import ConfigDumpSubCommand from "./command/ConfigDumpSubCommand.js";
 import ConfigGroupCommand from "./command/ConfigGroupCommand.js";
-import { CONFIGURATION_SERVICE_ID, SECRET_SENTINEL_PREFIX, } from "@flowscripter/dynamic-cli-framework-api";
-import DefaultSecretService from "./DefaultSecretService.js";
+import ConfigGetSubCommand from "./command/ConfigGetSubCommand.js";
+import ConfigSetSubCommand from "./command/ConfigSetSubCommand.js";
+import ConfigUnsetSubCommand from "./command/ConfigUnsetSubCommand.js";
+import { CONFIGURATION_SERVICE_ID, } from "@flowscripter/dynamic-cli-framework-api";
+import DefaultConfigurationService, {} from "./DefaultConfigurationService.js";
+import DefaultSecretService, {} from "./DefaultSecretService.js";
 import jsonFormat from "./format/JsonConfigFormat.js";
-import resolveSecrets from "./resolveSecrets.js";
 import argumentValueMerge from "../../runtime/values/argumentValueMerge.js";
 import { isGlobalCommand, isGlobalModifierCommand, isSubCommand, } from "../../runtime/command/CommandTypeGuards.js";
 import { getGlobalCommandValueFromEnvVars, getSubCommandValuesFromEnvVars, } from "../../util/envVarHelper.js";
 const logger = getLogger("ConfigurationServiceProvider");
-class ConfigurationServiceImpl {
-    #provider;
-    constructor(provider) {
-        this.#provider = provider;
+/**
+ * The only view of the configuration which is registered in the {@link Context}, and therefore reachable by
+ * every command and service. It deliberately exposes nothing but the config file location: the
+ * {@link DefaultConfigurationService} (default values, per-scope key-value data, secret resolution and
+ * persistence) is only handed to the `config` group commands and {@link KeyValueServiceProvider}.
+ */
+class ConfigurationLocationService {
+    #service;
+    constructor(service) {
+        this.#service = service;
     }
     get configLocation() {
-        return this.#provider.configLocation;
+        return this.#service.configLocation;
     }
     setConfigLocation(location) {
-        this.#provider.setConfigLocation(location);
+        this.#service.setConfigLocation(location);
     }
 }
 /**
@@ -32,11 +37,9 @@ class ConfigurationServiceImpl {
  *
  * The same configuration file also backs the raw, per-scope key-value data consumed by
  * {@link KeyValueServiceProvider} (which holds a direct reference to this provider - see
- * {@link getKeyValueData} and {@link flushIfDirty} - rather than looking this provider up via
- * {@link Context}, since only {@link configLocation}/{@link setConfigLocation} are safe to expose
- * generally; {@link getConfigString} is wired directly to {@link ConfigDumpSubCommand} for the same
- * reason - a full config dump would leak every other command's/service's key-value data if it
- * were reachable through a general lookup).
+ * {@link getKeyValueData} and {@link flushIfDirty}). The configuration data and its persistence are
+ * owned by {@link DefaultConfigurationService}, which is passed directly to the `config` group commands. Only a
+ * view exposing the config file location is registered under {@link CONFIGURATION_SERVICE_ID}.
  *
  * **Default Command Arguments**
  *
@@ -87,10 +90,10 @@ class ConfigurationServiceImpl {
  * default configuration will be used. The location of the configuration file can be modified via the
  * {@link ConfigCommand}.
  *
- * NOTE: You may store default arguments for secrets by manually configuring secrets in your OS
- * credential store and referencing them in the config file using the sentinel format
- * `__SECRET__:<bun_secret_name>`. These values will be resolved from the OS secret store
- * before being returned as default argument values. See {@link KeyValueServiceProvider} for the
+ * NOTE: Secrets in default arguments are referenced in the config file or an environment variable using
+ * the sentinel format `__SECRET__:<bun_secret_name>` and resolved from the OS secret store before being
+ * returned as default argument values. A command's defaults may only reference secrets stored for that
+ * command via `config set` (named `defaults_Z<command>_Z<option path>`, each part escaped). See {@link KeyValueServiceProvider} for the
  * generic key-value store which uses the same secret sentinel mechanism.
  *
  * *Environment Variables*
@@ -139,30 +142,13 @@ export default class ConfigurationServiceProvider {
     configEnabled;
     secretServiceEnabled;
     configFormat;
-    // the location of the currently managed configuration data
-    configLocation;
-    // the format specific handle for the text last read or written, used to preserve comments and layout on write
-    #configHandle;
-    // the configuration data to be used by the CLI runner implementation when setting command defaults.
-    // SingleValueType is for GlobalCommandArgument values, Values is for
-    // SubCommandArgument values.
-    defaultsData = new Map();
-    // the underlying per-scope key-value data, read from/written to the configuration file. Exposed
-    // (raw, not wrapped in a KeyValueService) only via getKeyValueData(), for KeyValueServiceProvider's
-    // exclusive use.
-    #commandKeyValueData = new Map();
-    #serviceKeyValueData = new Map();
-    // secret service used only to resolve secret sentinels embedded in default command argument
-    // values (getDefaultArgumentValues()) - unrelated to per-command/per-service KV scoping, so it
-    // uses its own fixed, dedicated scope prefix ("defaults"). Its scope is otherwise irrelevant,
-    // since only getSecret() (which doesn't consult scope) is ever called on it.
-    #defaultsSecretService;
     /**
-     * A {@link ConfigurationService} view of this provider, registered in the {@link Context} under
-     * {@link CONFIGURATION_SERVICE_ID}. Its `configLocation` getter always reflects this provider's
-     * current value.
+     * The {@link DefaultConfigurationService} which owns the configuration data. It is never registered
+     * in the {@link Context}: it is handed directly to the `config` group commands only.
      */
     #configurationService;
+    #hasCommandRegistry;
+    #secretsApi;
     /**
      * Create an instance of the service provider with the specified details.
      *
@@ -172,8 +158,11 @@ export default class ConfigurationServiceProvider {
      * @param secretServiceEnabled optionally enable OS-native secret storage via Bun.secrets for resolving
      * secrets embedded in default argument values: `configEnabled` must be true in this case
      * @param configFormat optionally set the syntax of the configuration file, defaults to JSON.
+     * @param commandRegistry optionally provide the registry of all commands, required for the `config:get`,
+     * `config:set` and `config:unset` commands to be provided.
+     * @param secretsApi optionally override the OS secret store used for storing SECRET default values.
      */
-    constructor(servicePriority, envVarsEnabled = false, configEnabled = false, secretServiceEnabled = false, configFormat = jsonFormat) {
+    constructor(servicePriority, envVarsEnabled = false, configEnabled = false, secretServiceEnabled = false, configFormat = jsonFormat, commandRegistry, secretsApi) {
         if (!configEnabled && secretServiceEnabled) {
             throw new Error("configEnabled must be true if secretServiceEnabled is true");
         }
@@ -182,25 +171,49 @@ export default class ConfigurationServiceProvider {
         this.configEnabled = configEnabled;
         this.secretServiceEnabled = secretServiceEnabled;
         this.configFormat = configFormat;
-        this.#configurationService = new ConfigurationServiceImpl(this);
+        this.#hasCommandRegistry = commandRegistry !== undefined;
+        this.#secretsApi = secretsApi;
+        this.#configurationService = new DefaultConfigurationService(envVarsEnabled, configFormat, commandRegistry);
     }
     getServiceInfo(cliConfig) {
         const commands = [];
         if (this.configEnabled) {
             commands.push(new ConfigCommand(this.servicePriority));
-            commands.push(new ConfigGroupCommand([new ConfigDumpSubCommand(() => this.getConfigString())]));
+            const members = [new ConfigDumpSubCommand(this.#configurationService)];
+            if (this.#hasCommandRegistry) {
+                members.push(new ConfigGetSubCommand(this.#configurationService), new ConfigSetSubCommand(this.#configurationService), new ConfigUnsetSubCommand(this.#configurationService));
+            }
+            commands.push(new ConfigGroupCommand(members));
         }
         if (this.secretServiceEnabled) {
-            this.#defaultsSecretService = new DefaultSecretService(cliConfig.name, "defaults");
+            this.#configurationService.setDefaultsSecretService(new DefaultSecretService(cliConfig.name, ["defaults"], this.#secretsApi));
         }
         return Promise.resolve({
-            service: this.#configurationService,
+            service: new ConfigurationLocationService(this.#configurationService),
             // this may be empty if configEnabled is false
             commands,
         });
     }
+    /**
+     * The {@link DefaultConfigurationService} which owns the configuration data, for trusted wiring and tests.
+     */
+    get configurationService() {
+        return this.#configurationService;
+    }
+    get configLocation() {
+        return this.#configurationService.configLocation;
+    }
+    set configLocation(location) {
+        this.#configurationService.configLocation = location;
+    }
+    get defaultsData() {
+        return this.#configurationService.defaultsData;
+    }
+    set defaultsData(data) {
+        this.#configurationService.defaultsData = data;
+    }
     setConfigLocation(configLocation) {
-        this.configLocation = configLocation;
+        this.#configurationService.setConfigLocation(configLocation);
     }
     /**
      * Retrieve the default command argument values (if any) for the provided {@link Command}.
@@ -247,14 +260,8 @@ export default class ConfigurationServiceProvider {
                 result = argumentValueMerge(envVarValues, configuredValues);
             }
         }
-        if (result !== undefined && this.#defaultsSecretService) {
-            result = await resolveSecrets(result, async (bunSecretName) => {
-                const secretValue = await this.#defaultsSecretService.getSecret(bunSecretName);
-                if (secretValue === null) {
-                    throw new Error(`Secret not found in OS secret store for sentinel: '${SECRET_SENTINEL_PREFIX}${bunSecretName}'`);
-                }
-                return secretValue;
-            });
+        if (result !== undefined) {
+            result = await this.#configurationService.resolveDefaultSecrets(result, commandKey);
         }
         return result;
     }
@@ -266,11 +273,7 @@ export default class ConfigurationServiceProvider {
      * @param scopeKey the command name or service/task ID to scope the key-value data to.
      */
     getKeyValueData(scopeType, scopeKey) {
-        const keyValueData = scopeType === "command" ? this.#commandKeyValueData : this.#serviceKeyValueData;
-        if (!keyValueData.has(scopeKey)) {
-            keyValueData.set(scopeKey, new Map());
-        }
-        return keyValueData.get(scopeKey);
+        return this.#configurationService.getKeyValueData(scopeType, scopeKey);
     }
     /**
      * Write the configuration file, if `isDirty` is true - for {@link KeyValueServiceProvider}'s
@@ -279,129 +282,16 @@ export default class ConfigurationServiceProvider {
      *
      * @param isDirty whether any scoped KeyValueService has unwritten changes.
      */
-    async flushIfDirty(isDirty) {
-        if (!isDirty) {
-            return;
-        }
-        if (this.configLocation === undefined) {
-            throw new Error("Attempt to write updated config with no configLocation set");
-        }
-        await this.#writeConfig(this.configLocation);
+    flushIfDirty(isDirty) {
+        return this.#configurationService.flushIfDirty(isDirty);
     }
     async initService(context) {
         if (!this.configEnabled) {
             return;
         }
-        let isDefault = false;
-        if (this.configLocation === undefined) {
-            isDefault = true;
-            // default to `$HOME/.<application_name>.<format extension>`
-            const home = process.env["HOME"];
-            if (home) {
-                this.configLocation = path.join(home, `.${context.cliConfig.name.replace(/\W/g, "")}.${this.configFormat.fileExtension}`);
-            }
-        }
-        if (this.configLocation === undefined) {
-            return;
-        }
-        let fileInfo;
-        try {
-            fileInfo = await fs.lstat(this.configLocation);
-        }
-        catch (err) {
-            const error = err;
-            if (isDefault) {
-                logger.debug("Default config file location: %s does not exist or is not visible - ignoring: %s", this.configLocation, error.message);
-                return;
-            }
-            else {
-                throw new Error(`Config file location: '${this.configLocation}' doesn't exist or not visible: ${error.message}`);
-            }
-        }
-        if (fileInfo.isDirectory()) {
-            throw new Error(`Config file location: '${this.configLocation}' is a directory and not a file!`);
-        }
-        await this.#readConfig(this.configLocation);
-    }
-    async #readConfig(location) {
-        try {
-            logger.debug("Reading config from: %s", location);
-            const data = await fs.readFile(location);
-            const { data: config, handle } = this.configFormat.parse(data.toString());
-            this.#configHandle = handle;
-            this.defaultsData.clear();
-            this.#commandKeyValueData.clear();
-            this.#serviceKeyValueData.clear();
-            if (config.defaults !== undefined) {
-                const defaults = config.defaults;
-                Object.keys(defaults).forEach((commandName) => {
-                    this.defaultsData.set(commandName, defaults[commandName]);
-                    logger.debug("Set default argument values for command name: %s", commandName);
-                });
-            }
-            if (config["key-values"] !== undefined) {
-                const keyValues = config["key-values"];
-                if (keyValues.commands !== undefined) {
-                    const commandKeyValues = keyValues.commands;
-                    Object.keys(commandKeyValues).forEach((commandName) => {
-                        this.#commandKeyValueData.set(commandName, new Map(Object.entries(commandKeyValues[commandName])));
-                        logger.debug("Set default argument values for command name: %s", commandName);
-                    });
-                }
-                if (keyValues.services !== undefined) {
-                    const serviceKeyValues = keyValues.services;
-                    Object.keys(serviceKeyValues).forEach((serviceId) => {
-                        this.#serviceKeyValueData.set(serviceId, new Map(Object.entries(serviceKeyValues[serviceId])));
-                        logger.debug("Set default argument values for service ID: %s", serviceId);
-                    });
-                }
-            }
-        }
-        catch (err) {
-            throw new Error(`Failed to read config at location: '${this.configLocation}': ${err}`);
-        }
-    }
-    async #writeConfig(location) {
-        logger.debug("Writing config to: %s", location);
-        try {
-            const config = this.#getConfigData();
-            const text = this.#configHandle === undefined
-                ? this.configFormat.serialize(config)
-                : this.configFormat.apply(this.#configHandle, config);
-            await fs.writeFile(location, text);
-            this.#configHandle = this.configFormat.parse(text).handle;
-        }
-        catch (err) {
-            throw new Error(`Failed to write config at location: '${this.configLocation}': ${err}`);
-        }
+        await this.#configurationService.init(context.cliConfig.name);
     }
     getConfigString() {
-        return this.configFormat.serialize(this.#getConfigData());
-    }
-    #getConfigData() {
-        const config = {};
-        if (this.defaultsData.size > 0) {
-            config.defaults = Object.fromEntries(this.defaultsData);
-        }
-        if (this.#commandKeyValueData.size > 0 || this.#serviceKeyValueData.size > 0) {
-            config["key-values"] = {};
-            if (this.#commandKeyValueData.size > 0) {
-                config["key-values"].commands = {};
-                for (const [commandName, keyValueData] of this.#commandKeyValueData.entries()) {
-                    if (keyValueData.size > 0) {
-                        config["key-values"].commands[commandName] = Object.fromEntries(keyValueData);
-                    }
-                }
-            }
-            if (this.#serviceKeyValueData.size > 0) {
-                config["key-values"].services = {};
-                for (const [serviceId, keyValueData] of this.#serviceKeyValueData.entries()) {
-                    if (keyValueData.size > 0) {
-                        config["key-values"].services[serviceId] = Object.fromEntries(keyValueData);
-                    }
-                }
-            }
-        }
-        return config;
+        return this.#configurationService.getConfigString();
     }
 }

package/dist/src/service/configuration/DefaultConfigurationService.d.ts

@@ -0,0 +1,78 @@
+import { type CommandRegistry, type ConfigurationService, type SingleValueType, type ValueNode, type Values } from "@flowscripter/dynamic-cli-framework-api";
+import { type ConfigTarget } from "./configTargets.ts";
+import type DefaultSecretService from "./DefaultSecretService.ts";
+import type ConfigFormat from "./format/ConfigFormat.ts";
+export type KeyValueServiceScopeType = "command" | "service";
+/**
+ * Owns the configuration data read from (and written back to) the configuration file: the default
+ * command argument values and the raw per-scope key-value data.
+ *
+ * The `config` group commands are constructed with this instance. It must never be registered in the
+ * {@link Context}: it exposes every command's defaults, the raw key-value data of every scope and secret
+ * resolution. Only a location-only view is registered under {@link CONFIGURATION_SERVICE_ID}.
+ */
+export default class DefaultConfigurationService implements ConfigurationService {
+    #private;
+    readonly envVarsEnabled: boolean;
+    readonly configFormat: ConfigFormat;
+    configLocation: string | undefined;
+    defaultsData: Map<string, Values | SingleValueType>;
+    /**
+     * @param envVarsEnabled whether environment variables may override stored default values.
+     * @param configFormat the syntax of the configuration file.
+     * @param commandRegistry optional registry of all commands, required for {@link getConfigTargets}.
+     */
+    constructor(envVarsEnabled: boolean, configFormat: ConfigFormat, commandRegistry?: CommandRegistry);
+    setConfigLocation(location: string): void;
+    setDefaultsSecretService(secretService: DefaultSecretService): void;
+    /**
+     * Resolve any secret sentinels within the value using the OS secret store (if enabled).
+     *
+     * @param commandKey the key of the command under `defaults` the value belongs to: a sentinel
+     * may only refer to a secret stored for this command.
+     */
+    resolveDefaultSecrets<T>(value: T, commandKey: string): Promise<T>;
+    /**
+     * Get-or-create the underlying, raw {@link ValueNode} `Map` for the given scope.
+     *
+     * @param scopeType whether `scopeKey` is a command name or a service/task ID.
+     * @param scopeKey the command name or service/task ID to scope the key-value data to.
+     */
+    getKeyValueData(scopeType: KeyValueServiceScopeType, scopeKey: string): Map<string, ValueNode>;
+    /**
+     * Write the configuration file, if `isDirty` is true.
+     *
+     * @param isDirty whether any scoped KeyValueService has unwritten changes.
+     */
+    flushIfDirty(isDirty: boolean): Promise<void>;
+    /**
+     * Determine the configuration location (defaulting to `$HOME/.<application_name>.<format extension>`)
+     * and read the configuration from it if it exists.
+     *
+     * @param applicationName the name of the CLI.
+     */
+    init(applicationName: string): Promise<void>;
+    getConfigString(): string;
+    /**
+     * The configuration text with secret sentinels and the values of SECRET typed arguments of
+     * known commands masked.
+     */
+    getMaskedConfigString(): string;
+    /**
+     * The commands whose defaults can be managed via the `config` group commands.
+     */
+    getConfigTargets(): Map<string, ConfigTarget>;
+    /**
+     * Replace (or remove, if `build` returns `undefined`) the stored defaults of a command and write the
+     * configuration file immediately. Memory, file and secret store are left unchanged if anything fails.
+     *
+     * @param commandKey the key of the command under `defaults`.
+     * @param secrets plain text secrets to store in the OS secret store, keyed to be used for naming.
+     * @param build creates the new value given the sentinels (one per secret) to reference the stored secrets.
+     */
+    commitDefault(commandKey: string, secrets: ReadonlyArray<{
+        key: ReadonlyArray<string>;
+        value: string;
+    }>, build: (sentinels: ReadonlyArray<string>) => Values | SingleValueType | undefined): Promise<void>;
+}
+//# sourceMappingURL=DefaultConfigurationService.d.ts.map

package/dist/src/service/configuration/DefaultConfigurationService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultConfigurationService.d.ts","sourceRoot":"","sources":["../../../../src/service/configuration/DefaultConfigurationService.ts"],"names":[],"mappings":"AAIA,OAAO,EAEL,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACpB,KAAK,SAAS,EACd,KAAK,MAAM,EACZ,MAAM,yCAAyC,CAAC;AAEjD,OAAO,EAIL,KAAK,YAAY,EAClB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,oBAAoB,MAAM,2BAA2B,CAAC;AAClE,OAAO,KAAK,YAAY,MAAM,0BAA0B,CAAC;AAMzD,MAAM,MAAM,wBAAwB,GAAG,SAAS,GAAG,SAAS,CAAC;AAE7D;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,2BAA4B,YAAW,oBAAoB;;IAC9E,SAAgB,cAAc,EAAE,OAAO,CAAC;IACxC,SAAgB,YAAY,EAAE,YAAY,CAAC;IAGpC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAInC,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,CAAC,CAAa;IAcvE;;;;OAIG;IACH,YACE,cAAc,EAAE,OAAO,EACvB,YAAY,EAAE,YAAY,EAC1B,eAAe,CAAC,EAAE,eAAe,EAKlC;IAEM,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAE/C;IAEM,wBAAwB,CAAC,aAAa,EAAE,oBAAoB,GAAG,IAAI,CAEzE;IAED;;;;;OAKG;IACU,qBAAqB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAmB9E;IAED;;;;;OAKG;IACI,eAAe,CACpB,SAAS,EAAE,wBAAwB,EACnC,QAAQ,EAAE,MAAM,GACf,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAOxB;IAED;;;;OAIG;IACU,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAQzD;IAED;;;;;OAKG;IACU,IAAI,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAwCxD;IAiEM,eAAe,IAAI,MAAM,CAE/B;IAED;;;OAGG;IACI,qBAAqB,IAAI,MAAM,CAarC;IAED;;OAEG;IACI,gBAAgB,IAAI,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAInD;IAED;;;;;;;OAOG;IACU,aAAa,CACxB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,aAAa,CAAC;QAAE,GAAG,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,EACrE,KAAK,EAAE,CAAC,SAAS,EAAE,aAAa,CAAC,MAAM,CAAC,KAAK,MAAM,GAAG,eAAe,GAAG,SAAS,GAChF,OAAO,CAAC,IAAI,CAAC,CA6Cf;CAmCF"}