@flowscripter/dynamic-cli-framework 11.0.0 → 12.0.0

package/dist/src/service/argumentPrompter/DefaultArgumentPrompterService.js

@@ -2,6 +2,11 @@ import { PromptType, } from "@flowscripter/dynamic-cli-framework-api";
 import { InvalidArgumentReason } from "@flowscripter/dynamic-cli-framework-api";
 import { ValueTypeName, ComplexValueTypeName, } from "@flowscripter/dynamic-cli-framework-api";
 import { isGlobalCommand, isSubCommand } from "../../runtime/command/CommandTypeGuards.js";
+/**
+ * Used as {@link ValidationContext.command} when prompting via {@link ArgumentPrompterService.promptForArguments},
+ * which is not associated with a specific command.
+ */
+const NO_COMMAND = { name: "" };
 export default class DefaultArgumentPrompterService {
     #prompterService;
     constructor(prompterService) {
@@ -34,12 +39,40 @@ export default class DefaultArgumentPrompterService {
         }
         return parseResult;
     }
+    async promptForArguments(args, existing = {}) {
+        if (!this.#prompterService.promptEnabled) {
+            return undefined;
+        }
+        const prompted = {};
+        const merged = { ...existing };
+        const scope = { command: NO_COMMAND, values: merged };
+        for (const arg of args) {
+            if (arg.name in existing) {
+                continue;
+            }
+            const value = (await this.#promptForArgument(arg.name, arg, scope));
+            prompted[arg.name] = value;
+            merged[arg.name] = value;
+        }
+        return prompted;
+    }
+    async #promptForArgument(name, arg, scope) {
+        if ("type" in arg && arg.type === ComplexValueTypeName.COMPLEX) {
+            return await this.#promptForComplexOption(name, arg, scope);
+        }
+        if (DefaultArgumentPrompterService.#isArrayArgument(arg)) {
+            return await this.#promptForArrayArgument(name, arg, scope);
+        }
+        const prompt = DefaultArgumentPrompterService.#argumentToPrompt(name, arg.description ?? name, arg, name, scope);
+        const result = await this.#prompterService.prompt(prompt);
+        return DefaultArgumentPrompterService.#coerceValue(result.value, arg.type);
+    }
     async #promptForGlobalCommand(parseResult) {
         const command = parseResult.command;
         if (!command.argument) {
             return parseResult;
         }
-        const prompt = DefaultArgumentPrompterService.#argumentToPrompt(command.name, command.name, command.argument);
+        const prompt = DefaultArgumentPrompterService.#argumentToPrompt(command.name, command.name, command.argument, command.name, { command, values: undefined });
         const result = await this.#prompterService.prompt(prompt);
         const value = DefaultArgumentPrompterService.#coerceValue(result.value, command.argument.type);
         return {
@@ -57,6 +90,7 @@ export default class DefaultArgumentPrompterService {
             ...existingValues,
         };
         const remainingInvalid = [];
+        const scope = { command, values: newValues };
         for (const invalid of parseResult.invalidArguments) {
             if (invalid.reason !== InvalidArgumentReason.MISSING_VALUE || !invalid.name) {
                 remainingInvalid.push(invalid);
@@ -67,19 +101,7 @@ export default class DefaultArgumentPrompterService {
                 remainingInvalid.push(invalid);
                 continue;
             }
-            if ("type" in arg && arg.type === ComplexValueTypeName.COMPLEX) {
-                const complexValues = await this.#promptForComplexOption(invalid.name, arg);
-                newValues[invalid.name] = complexValues;
-            }
-            else if (DefaultArgumentPrompterService.#isArrayArgument(arg)) {
-                const arrayValues = await this.#promptForArrayArgument(invalid.name, arg);
-                newValues[invalid.name] = arrayValues;
-            }
-            else {
-                const prompt = DefaultArgumentPrompterService.#argumentToPrompt(invalid.name, arg.description ?? invalid.name, arg);
-                const result = await this.#prompterService.prompt(prompt);
-                newValues[invalid.name] = DefaultArgumentPrompterService.#coerceValue(result.value, arg.type);
-            }
+            newValues[invalid.name] = await this.#promptForArgument(invalid.name, arg, scope);
         }
         return {
             command: parseResult.command,
@@ -89,28 +111,28 @@ export default class DefaultArgumentPrompterService {
             unusedArgs: parseResult.unusedArgs,
         };
     }
-    async #promptForComplexOption(name, complexOption) {
+    async #promptForComplexOption(name, complexOption, scope) {
         const values = {};
         for (const prop of complexOption.properties) {
             if ("type" in prop && prop.type === ComplexValueTypeName.COMPLEX) {
-                values[prop.name] = await this.#promptForComplexOption(`${name}.${prop.name}`, prop);
+                values[prop.name] = await this.#promptForComplexOption(`${name}.${prop.name}`, prop, scope);
             }
             else {
                 const option = prop;
                 if (option.isOptional && option.defaultValue !== undefined) {
                     continue;
                 }
-                const prompt = DefaultArgumentPrompterService.#argumentToPrompt(`${name}.${option.name}`, option.description ?? `${name}.${option.name}`, option);
+                const prompt = DefaultArgumentPrompterService.#argumentToPrompt(`${name}.${option.name}`, option.description ?? `${name}.${option.name}`, option, `${name}.${option.name}`, scope);
                 const result = await this.#prompterService.prompt(prompt);
                 values[option.name] = DefaultArgumentPrompterService.#coerceValue(result.value, option.type);
             }
         }
         return values;
     }
-    async #promptForArrayArgument(name, arg) {
+    async #promptForArrayArgument(name, arg, scope) {
         const values = [];
         while (true) {
-            const prompt = DefaultArgumentPrompterService.#argumentToPrompt(name, `${arg.description ?? name}${values.length > 0 ? ` [${values.length + 1}]` : ""}`, arg);
+            const prompt = DefaultArgumentPrompterService.#argumentToPrompt(name, `${arg.description ?? name}${values.length > 0 ? ` [${values.length + 1}]` : ""}`, arg, name, scope);
             const result = await this.#prompterService.prompt(prompt);
             values.push(DefaultArgumentPrompterService.#coerceValue(result.value, arg.type));
             const addAnother = {
@@ -126,7 +148,7 @@ export default class DefaultArgumentPrompterService {
         }
         return values;
     }
-    static #argumentToPrompt(name, description, arg) {
+    static #argumentToPrompt(name, description, arg, path, scope) {
         if (arg.type === ValueTypeName.BOOLEAN) {
             return {
                 name,
@@ -152,7 +174,17 @@ export default class DefaultArgumentPrompterService {
             returnedValue: "",
             min: arg.minValueInclusive,
             max: arg.maxValueInclusive,
-            validate: arg.validate ? (v) => arg.validate(v) : undefined,
+            validate: arg.validate
+                ? (v) => {
+                    const value = DefaultArgumentPrompterService.#coerceValue(v, arg.type);
+                    return arg.validate(value, {
+                        argument: arg,
+                        path,
+                        values: scope.values === undefined ? value : scope.values,
+                        command: scope.command,
+                    });
+                }
+                : undefined,
         };
         return {
             name,

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

@@ -1 +1 @@
-{"version":3,"file":"KeyValueServiceProvider.d.ts","sourceRoot":"","sources":["../../../../src/service/configuration/KeyValueServiceProvider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAC5F,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACzE,OAAO,KAAK,EACV,eAAe,EAGhB,MAAM,yCAAyC,CAAC;AAIjD,OAAO,KAAK,4BAA4B,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAoClF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,MAAM,CAAC,OAAO,OAAO,uBAAwB,YAAW,eAAe;;IACrE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAwB;IAClD,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAIjC,SAAgB,sBAAsB,EAAE,OAAO,CAAC;IAChD,SAAgB,oBAAoB,EAAE,OAAO,CAAC;IAW9C;;;;;;;;OAQG;IACH,YACE,eAAe,EAAE,MAAM,EACvB,4BAA4B,EAAE,4BAA4B,EAC1D,sBAAsB,UAAQ,EAC9B,oBAAoB,UAAQ,EAY7B;IAEM,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAUhE;IAED;;;;;;;;;;OAUG;IACI,wBAAwB,CAC7B,SAAS,EAAE,wBAAwB,EACnC,QAAQ,EAAE,MAAM,GACf,eAAe,CAwBjB;IAED;;;;;;;;;;;;;;OAcG;IACI,kBAAkB,CACvB,OAAO,EAAE,OAAO,EAChB,SAAS,EAAE,wBAAwB,EACnC,QAAQ,EAAE,MAAM,GACf,OAAO,CAaT;IAqBY,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CASxD;CACF"}
+{"version":3,"file":"KeyValueServiceProvider.d.ts","sourceRoot":"","sources":["../../../../src/service/configuration/KeyValueServiceProvider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAC5F,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AACvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACzE,OAAO,KAAK,EACV,eAAe,EAGhB,MAAM,yCAAyC,CAAC;AAIjD,OAAO,KAAK,4BAA4B,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAoClF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,MAAM,CAAC,OAAO,OAAO,uBAAwB,YAAW,eAAe;;IACrE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAwB;IAClD,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAIjC,SAAgB,sBAAsB,EAAE,OAAO,CAAC;IAChD,SAAgB,oBAAoB,EAAE,OAAO,CAAC;IAW9C;;;;;;;;OAQG;IACH,YACE,eAAe,EAAE,MAAM,EACvB,4BAA4B,EAAE,4BAA4B,EAC1D,sBAAsB,UAAQ,EAC9B,oBAAoB,UAAQ,EAY7B;IAEM,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAUhE;IAED;;;;;;;;;;OAUG;IACI,wBAAwB,CAC7B,SAAS,EAAE,wBAAwB,EACnC,QAAQ,EAAE,MAAM,GACf,eAAe,CAwBjB;IAED;;;;;;;;;;;;;;OAcG;IACI,kBAAkB,CACvB,OAAO,EAAE,OAAO,EAChB,SAAS,EAAE,wBAAwB,EACnC,QAAQ,EAAE,MAAM,GACf,OAAO,CAcT;IAqBY,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CASxD;CACF"}

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

@@ -180,6 +180,7 @@ export default class KeyValueServiceProvider {
         const scopedKeyValueService = this.getScopedKeyValueService(scopeType, scopeKey);
         return {
             cliConfig: context.cliConfig,
+            isTty: context.isTty,
             getServiceById: (id) => id === KEY_VALUE_SERVICE_ID ? scopedKeyValueService : context.getServiceById(id),
             doesServiceExist: (id) => context.doesServiceExist(id),
             addServiceInstance: (id, serviceInstance) => context.addServiceInstance(id, serviceInstance),

package/dist/src/service/printer/PrinterServiceProvider.d.ts

@@ -9,13 +9,15 @@ export default class PrinterServiceProvider implements ServiceProvider {
     readonly serviceId: string;
     readonly servicePriority: number;
     readonly printerService: PrinterService;
+    readonly detectDarkBackground: (() => Promise<boolean | undefined>) | undefined;
     /**
      * Create an instance of the service provider with the specified details.
      *
      * @param servicePriority the priority of the service.
      * @param printerService the PrinterService implementation to use.
+     * @param detectDarkBackground optional function detecting whether the terminal background is dark.
      */
-    constructor(servicePriority: number, printerService: PrinterService);
+    constructor(servicePriority: number, printerService: PrinterService, detectDarkBackground?: () => Promise<boolean | undefined>);
     getServiceInfo(_cliConfig: CLIConfig): Promise<ServiceInfo>;
     initService(context: Context): Promise<void>;
 }

package/dist/src/service/printer/PrinterServiceProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PrinterServiceProvider.d.ts","sourceRoot":"","sources":["../../../../src/service/printer/PrinterServiceProvider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AAEvE,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAC5F,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAC;AAK9E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAKzE;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,sBAAuB,YAAW,eAAe;IACpE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAsB;IAChD,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;IAExC;;;;;OAKG;IACH,YAAmB,eAAe,EAAE,MAAM,EAAE,cAAc,EAAE,cAAc,EAGzE;IAEM,cAAc,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAUjE;IAED,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAY3C;CACF"}
+{"version":3,"file":"PrinterServiceProvider.d.ts","sourceRoot":"","sources":["../../../../src/service/printer/PrinterServiceProvider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AAEvE,OAAO,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAC5F,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAC;AAK9E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAKzE;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,sBAAuB,YAAW,eAAe;IACpE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAsB;IAChD,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;IACxC,QAAQ,CAAC,oBAAoB,EAAE,CAAC,MAAM,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC,GAAG,SAAS,CAAC;IAEhF;;;;;;OAMG;IACH,YACE,eAAe,EAAE,MAAM,EACvB,cAAc,EAAE,cAAc,EAC9B,oBAAoB,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,EAK1D;IAEM,cAAc,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAUjE;IAED,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAY3C;CACF"}

package/dist/src/service/printer/PrinterServiceProvider.js

@@ -1,6 +1,6 @@
 import LogLevelCommand from "./command/LogLevelCommand.js";
 import { PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
-import DarkModeCommand from "./command/DarkModeCommand.js";
+import ThemeCommand from "./command/ThemeCommand.js";
 import NoColorCommand from "./command/NoColorCommand.js";
 import NoHyperlinksCommand from "./command/NoHyperlinksCommand.js";
 import { SHUTDOWN_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
@@ -12,23 +12,26 @@ export default class PrinterServiceProvider {
     serviceId = PRINTER_SERVICE_ID;
     servicePriority;
     printerService;
+    detectDarkBackground;
     /**
      * Create an instance of the service provider with the specified details.
      *
      * @param servicePriority the priority of the service.
      * @param printerService the PrinterService implementation to use.
+     * @param detectDarkBackground optional function detecting whether the terminal background is dark.
      */
-    constructor(servicePriority, printerService) {
+    constructor(servicePriority, printerService, detectDarkBackground) {
         this.servicePriority = servicePriority;
         this.printerService = printerService;
+        this.detectDarkBackground = detectDarkBackground;
     }
     getServiceInfo(_cliConfig) {
         return Promise.resolve({
             service: this.printerService,
             commands: [
                 new NoHyperlinksCommand(this.servicePriority + 3),
-                new DarkModeCommand(this.servicePriority + 2),
-                new NoColorCommand(this.servicePriority + 1),
+                new ThemeCommand(this.servicePriority + 1, this.detectDarkBackground),
+                new NoColorCommand(this.servicePriority + 2),
                 new LogLevelCommand(this.servicePriority),
             ],
         });

package/dist/src/service/printer/command/ThemeCommand.d.ts

@@ -0,0 +1,24 @@
+import type { GlobalModifierCommand } from "@flowscripter/dynamic-cli-framework-api";
+import type { GlobalCommandArgument } from "@flowscripter/dynamic-cli-framework-api";
+import { type SingleValueType } from "@flowscripter/dynamic-cli-framework-api";
+import type { Context } from "@flowscripter/dynamic-cli-framework-api";
+/**
+ * Command allowing the specification of the dark/light theme for the {@link PrinterService}.
+ *
+ * With the `auto` value the terminal background is detected and light is used if it cannot be determined.
+ */
+export default class ThemeCommand implements GlobalModifierCommand {
+    #private;
+    readonly name = "theme";
+    readonly description = "Theme for output";
+    readonly enableConfiguration = true;
+    readonly argument: GlobalCommandArgument;
+    readonly executePriority: number;
+    /**
+     * @param executePriority the priority of the command.
+     * @param detect optional function detecting whether the terminal background is dark.
+     */
+    constructor(executePriority: number, detect?: () => Promise<boolean | undefined>);
+    execute(context: Context, argumentValue: SingleValueType): Promise<void>;
+}
+//# sourceMappingURL=ThemeCommand.d.ts.map

package/dist/src/service/printer/command/ThemeCommand.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ThemeCommand.d.ts","sourceRoot":"","sources":["../../../../../src/service/printer/command/ThemeCommand.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yCAAyC,CAAC;AACrF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yCAAyC,CAAC;AACrF,OAAO,EAAE,KAAK,eAAe,EAAiB,MAAM,yCAAyC,CAAC;AAC9F,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yCAAyC,CAAC;AAIvE;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,YAAa,YAAW,qBAAqB;;IAChE,QAAQ,CAAC,IAAI,WAAW;IACxB,QAAQ,CAAC,WAAW,sBAAsB;IAC1C,QAAQ,CAAC,mBAAmB,QAAQ;IACpC,QAAQ,CAAC,QAAQ,EAAE,qBAAqB,CAKtC;IACF,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAGjC;;;OAGG;IACH,YAAmB,eAAe,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,EAGtF;IAEY,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAWpF;CACF"}

package/dist/src/service/printer/command/ThemeCommand.js

@@ -0,0 +1,40 @@
+import { ValueTypeName } from "@flowscripter/dynamic-cli-framework-api";
+import { PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+/**
+ * Command allowing the specification of the dark/light theme for the {@link PrinterService}.
+ *
+ * With the `auto` value the terminal background is detected and light is used if it cannot be determined.
+ */
+export default class ThemeCommand {
+    name = "theme";
+    description = "Theme for output";
+    enableConfiguration = true;
+    argument = {
+        type: ValueTypeName.STRING,
+        defaultValue: "auto",
+        allowableValues: ["auto", "dark", "light"],
+        configurationKey: "THEME",
+    };
+    executePriority;
+    #detect;
+    /**
+     * @param executePriority the priority of the command.
+     * @param detect optional function detecting whether the terminal background is dark.
+     */
+    constructor(executePriority, detect) {
+        this.executePriority = executePriority;
+        this.#detect = detect;
+    }
+    async execute(context, argumentValue) {
+        const printerService = context.getServiceById(PRINTER_SERVICE_ID);
+        if (argumentValue === "auto") {
+            printerService.darkMode =
+                printerService.colorEnabled && this.#detect !== undefined
+                    ? ((await this.#detect()) ?? false)
+                    : false;
+        }
+        else {
+            printerService.darkMode = argumentValue === "dark";
+        }
+    }
+}

package/dist/src/terminal/Ansi.d.ts

@@ -1,3 +1,5 @@
+export declare const ESC = "\u001B";
+export declare const BEL = "\u0007";
 export declare const CLEAR_LINE: string;
 export declare const CURSOR_LEFT: string;
 export declare const CURSOR_UP: string;
@@ -7,6 +9,8 @@ export declare const ITALIC_START: string;
 export declare const ITALIC_END: string;
 export declare const FOREGROUND_COLOR_END: string;
 export declare const BACKGROUND_COLOR_END: string;
+export declare const QUERY_BACKGROUND_COLOR = "\u001B]11;?\u001B\\";
+export declare const QUERY_DEVICE_ATTRIBUTES: string;
 export declare const HYPERLINK_END = "\u001B]8;;\u0007";
 export declare function foregroundColorStart(r: number, g: number, b: number): string;
 export declare function backgroundColorStart(r: number, g: number, b: number): string;

package/dist/src/terminal/Ansi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Ansi.d.ts","sourceRoot":"","sources":["../../../src/terminal/Ansi.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,UAAU,QAAa,CAAC;AACrC,eAAO,MAAM,WAAW,QAAY,CAAC;AACrC,eAAO,MAAM,SAAS,QAAa,CAAC;AACpC,eAAO,MAAM,WAAW,QAAe,CAAC;AACxC,eAAO,MAAM,WAAW,QAAe,CAAC;AACxC,eAAO,MAAM,YAAY,QAAa,CAAC;AACvC,eAAO,MAAM,UAAU,QAAc,CAAC;AACtC,eAAO,MAAM,oBAAoB,QAAc,CAAC;AAChD,eAAO,MAAM,oBAAoB,QAAc,CAAC;AAChD,eAAO,MAAM,aAAa,qBAA8B,CAAC;AAEzD,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAE5E;AAED,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAE5E;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAElD"}
+{"version":3,"file":"Ansi.d.ts","sourceRoot":"","sources":["../../../src/terminal/Ansi.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,GAAG,WAAS,CAAC;AAC1B,eAAO,MAAM,GAAG,WAAS,CAAC;AAM1B,eAAO,MAAM,UAAU,QAAa,CAAC;AACrC,eAAO,MAAM,WAAW,QAAY,CAAC;AACrC,eAAO,MAAM,SAAS,QAAa,CAAC;AACpC,eAAO,MAAM,WAAW,QAAe,CAAC;AACxC,eAAO,MAAM,WAAW,QAAe,CAAC;AACxC,eAAO,MAAM,YAAY,QAAa,CAAC;AACvC,eAAO,MAAM,UAAU,QAAc,CAAC;AACtC,eAAO,MAAM,oBAAoB,QAAc,CAAC;AAChD,eAAO,MAAM,oBAAoB,QAAc,CAAC;AAChD,eAAO,MAAM,sBAAsB,wBAAoB,CAAC;AACxD,eAAO,MAAM,uBAAuB,QAAY,CAAC;AACjD,eAAO,MAAM,aAAa,qBAA8B,CAAC;AAEzD,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAE5E;AAED,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAE5E;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAElD"}

package/dist/src/terminal/Ansi.js

@@ -1,6 +1,8 @@
-const CSI = "\x1b[";
-const OSC = "\x1b]";
-const BEL = "\x07";
+export const ESC = "\x1b";
+export const BEL = "\x07";
+const CSI = ESC + "[";
+const OSC = ESC + "]";
+const ST = ESC + "\\";
 const SEP = ";";
 export const CLEAR_LINE = CSI + "2K";
 export const CURSOR_LEFT = CSI + "G";
@@ -11,6 +13,8 @@ export const ITALIC_START = CSI + "3m";
 export const ITALIC_END = CSI + "23m";
 export const FOREGROUND_COLOR_END = CSI + "39m";
 export const BACKGROUND_COLOR_END = CSI + "49m";
+export const QUERY_BACKGROUND_COLOR = `${OSC}11;?${ST}`;
+export const QUERY_DEVICE_ATTRIBUTES = CSI + "c";
 export const HYPERLINK_END = `${OSC}8${SEP}${SEP}${BEL}`;
 export function foregroundColorStart(r, g, b) {
     return `\x1b[38;2;${r};${g};${b}m`;

package/dist/src/terminal/BackgroundDetector.d.ts

@@ -0,0 +1,25 @@
+import type KeyReader from "./KeyReader.ts";
+import type Terminal from "./Terminal.ts";
+export declare const DEFAULT_DETECTION_TIMEOUT_MS = 150;
+/**
+ * Parse the COLORFGBG environment variable value into a dark background flag.
+ *
+ * @returns `true` for a dark background, `false` for a light background or `undefined` if not determinable.
+ */
+export declare function parseColorFgBg(value: string | undefined): boolean | undefined;
+/**
+ * Parse an OSC 11 background colour reply into a dark background flag.
+ *
+ * @returns `true` for a dark background, `false` for a light background or `undefined` if no reply is present.
+ */
+export declare function parseOsc11Reply(data: string): boolean | undefined;
+/**
+ * Detect whether the terminal background is dark.
+ *
+ * Checks COLORFGBG first and then queries the terminal for its background colour (OSC 11).
+ * The query is skipped unless the terminal is a TTY and is bounded by a timeout.
+ *
+ * @returns `true` for a dark background, `false` for a light background or `undefined` if not determinable.
+ */
+export declare function detectDarkBackground(keyReader: KeyReader, terminal: Terminal, env?: Record<string, string | undefined>, timeoutMs?: number): Promise<boolean | undefined>;
+//# sourceMappingURL=BackgroundDetector.d.ts.map

package/dist/src/terminal/BackgroundDetector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackgroundDetector.d.ts","sourceRoot":"","sources":["../../../src/terminal/BackgroundDetector.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAC;AAQ1C,eAAO,MAAM,4BAA4B,MAAM,CAAC;AAEhD;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAc7E;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CASjE;AAED;;;;;;;GAOG;AACH,wBAAsB,oBAAoB,CACxC,SAAS,EAAE,SAAS,EACpB,QAAQ,EAAE,QAAQ,EAClB,GAAG,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAe,EACrD,SAAS,GAAE,MAAqC,GAC/C,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAe9B"}

package/dist/src/terminal/BackgroundDetector.js

@@ -0,0 +1,63 @@
+import process from "node:process";
+import { BEL, ESC, QUERY_BACKGROUND_COLOR, QUERY_DEVICE_ATTRIBUTES } from "./Ansi.js";
+const OSC_11_REPLY = new RegExp(`${ESC}\\]11;rgb:([0-9a-fA-F]{1,4})/([0-9a-fA-F]{1,4})/([0-9a-fA-F]{1,4})(?:${BEL}|${ESC}\\\\)`);
+const DA1_REPLY = new RegExp(`${ESC}\\[\\?[0-9;]*c`);
+export const DEFAULT_DETECTION_TIMEOUT_MS = 150;
+/**
+ * Parse the COLORFGBG environment variable value into a dark background flag.
+ *
+ * @returns `true` for a dark background, `false` for a light background or `undefined` if not determinable.
+ */
+export function parseColorFgBg(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    const parts = value.split(";");
+    const background = parts[parts.length - 1];
+    if (!/^\d{1,2}$/.test(background)) {
+        return undefined;
+    }
+    const index = Number(background);
+    if (index > 15) {
+        return undefined;
+    }
+    return index <= 6 || index === 8;
+}
+/**
+ * Parse an OSC 11 background colour reply into a dark background flag.
+ *
+ * @returns `true` for a dark background, `false` for a light background or `undefined` if no reply is present.
+ */
+export function parseOsc11Reply(data) {
+    const match = OSC_11_REPLY.exec(data);
+    if (match === null) {
+        return undefined;
+    }
+    const [r, g, b] = [match[1], match[2], match[3]].map((channel) => parseInt(channel, 16) / (16 ** channel.length - 1));
+    return 0.2126 * r + 0.7152 * g + 0.0722 * b < 0.5;
+}
+/**
+ * Detect whether the terminal background is dark.
+ *
+ * Checks COLORFGBG first and then queries the terminal for its background colour (OSC 11).
+ * The query is skipped unless the terminal is a TTY and is bounded by a timeout.
+ *
+ * @returns `true` for a dark background, `false` for a light background or `undefined` if not determinable.
+ */
+export async function detectDarkBackground(keyReader, terminal, env = process.env, timeoutMs = DEFAULT_DETECTION_TIMEOUT_MS) {
+    if (!terminal.isTty() || env.TERM === "dumb") {
+        return undefined;
+    }
+    const fromEnv = parseColorFgBg(env.COLORFGBG);
+    if (fromEnv !== undefined) {
+        return fromEnv;
+    }
+    try {
+        const reply = keyReader.readRaw((received) => DA1_REPLY.test(received), timeoutMs);
+        await terminal.write(QUERY_BACKGROUND_COLOR + QUERY_DEVICE_ATTRIBUTES);
+        return parseOsc11Reply(await reply);
+    }
+    catch {
+        return undefined;
+    }
+}

package/dist/src/terminal/KeyReader.d.ts

@@ -18,5 +18,12 @@ export default interface KeyReader {
     enableRawMode(): void;
     disableRawMode(): void;
     readKey(): Promise<KeyEvent>;
+    /**
+     * Read raw input until `isComplete` returns `true` for the accumulated input or `timeoutMs` elapses.
+     * Raw mode and paused state are restored afterwards.
+     *
+     * @returns the accumulated input.
+     */
+    readRaw(isComplete: (received: string) => boolean, timeoutMs: number): Promise<string>;
 }
 //# sourceMappingURL=KeyReader.d.ts.map

package/dist/src/terminal/KeyReader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"KeyReader.d.ts","sourceRoot":"","sources":["../../../src/terminal/KeyReader.ts"],"names":[],"mappings":"AAAA,oBAAY,UAAU;IACpB,EAAE,IAAI;IACN,IAAI,IAAI;IACR,IAAI,IAAI;IACR,KAAK,IAAI;IACT,KAAK,IAAI;IACT,KAAK,IAAI;IACT,SAAS,IAAI;IACb,MAAM,IAAI;IACV,GAAG,IAAI;IACP,SAAS,IAAI;CACd;AAED,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC;CAClC;AAED,MAAM,CAAC,OAAO,WAAW,SAAS;IAChC,aAAa,IAAI,IAAI,CAAC;IACtB,cAAc,IAAI,IAAI,CAAC;IACvB,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC9B"}
+{"version":3,"file":"KeyReader.d.ts","sourceRoot":"","sources":["../../../src/terminal/KeyReader.ts"],"names":[],"mappings":"AAAA,oBAAY,UAAU;IACpB,EAAE,IAAI;IACN,IAAI,IAAI;IACR,IAAI,IAAI;IACR,KAAK,IAAI;IACT,KAAK,IAAI;IACT,KAAK,IAAI;IACT,SAAS,IAAI;IACb,MAAM,IAAI;IACV,GAAG,IAAI;IACP,SAAS,IAAI;CACd;AAED,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC;CAClC;AAED,MAAM,CAAC,OAAO,WAAW,SAAS;IAChC,aAAa,IAAI,IAAI,CAAC;IACtB,cAAc,IAAI,IAAI,CAAC;IACvB,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC7B;;;;;OAKG;IACH,OAAO,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACxF"}

package/dist/src/terminal/TtyKeyReader.d.ts

@@ -7,5 +7,6 @@ export default class TtyKeyReader implements KeyReader {
     enableRawMode(): void;
     disableRawMode(): void;
     readKey(): Promise<KeyEvent>;
+    readRaw(isComplete: (received: string) => boolean, timeoutMs: number): Promise<string>;
 }
 //# sourceMappingURL=TtyKeyReader.d.ts.map

package/dist/src/terminal/TtyKeyReader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TtyKeyReader.d.ts","sourceRoot":"","sources":["../../../src/terminal/TtyKeyReader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,KAAK,QAAQ,EAAc,MAAM,gBAAgB,CAAC;AAE3D,MAAM,CAAC,OAAO,OAAO,YAAa,YAAW,SAAS;;IAGpD,YAAY,aAAa,EAAE,UAAU,EAKpC;IAED,aAAa,IAAI,IAAI,CAGpB;IAED,cAAc,IAAI,IAAI,CAGrB;IAED,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,CA2B3B;CAiDF"}
+{"version":3,"file":"TtyKeyReader.d.ts","sourceRoot":"","sources":["../../../src/terminal/TtyKeyReader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,KAAK,QAAQ,EAAc,MAAM,gBAAgB,CAAC;AAE3D,MAAM,CAAC,OAAO,OAAO,YAAa,YAAW,SAAS;;IAGpD,YAAY,aAAa,EAAE,UAAU,EAKpC;IAED,aAAa,IAAI,IAAI,CAGpB;IAED,cAAc,IAAI,IAAI,CAGrB;IAED,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,CA2B3B;IAED,OAAO,CAAC,UAAU,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAiCrF;CAiDF"}

package/dist/src/terminal/TtyKeyReader.js

@@ -41,6 +41,36 @@ export default class TtyKeyReader {
             this.#ttyReadStream.on("data", onData);
         });
     }
+    readRaw(isComplete, timeoutMs) {
+        const stream = this.#ttyReadStream;
+        const wasRaw = stream.isRaw === true;
+        const wasPaused = stream.isPaused();
+        return new Promise((resolve) => {
+            let received = "";
+            let timer;
+            const finish = () => {
+                clearTimeout(timer);
+                stream.removeListener("data", onData);
+                if (!wasRaw) {
+                    stream.setRawMode(false);
+                }
+                if (wasPaused) {
+                    stream.pause();
+                }
+                resolve(received);
+            };
+            const onData = (data) => {
+                received += data.toString();
+                if (isComplete(received)) {
+                    finish();
+                }
+            };
+            stream.setRawMode(true);
+            stream.on("data", onData);
+            stream.resume();
+            timer = setTimeout(finish, timeoutMs);
+        });
+    }
     static #decodeKeyEvent(data) {
         if (data.length === 0) {
             return {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowscripter/dynamic-cli-framework",
-  "version": "11.0.0",
+  "version": "12.0.0",
   "description": "A framework for developing CLI applications which supports dynamic discovery and installation of new commands",
   "keywords": [
     "bun",
@@ -49,7 +49,7 @@
     "build": "tsc -p tsconfig.build.json"
   },
   "dependencies": {
-    "@flowscripter/dynamic-cli-framework-api": "^5.0.2",
+    "@flowscripter/dynamic-cli-framework-api": "^5.1.0",
     "@flowscripter/dynamic-plugin-framework": "^2.2.22",
     "emphasize": "^7.0.0",
     "fastest-levenshtein": "^1.0.16",

package/src/cli/BaseCLI.ts

@@ -44,6 +44,7 @@ import type Terminal from "../terminal/Terminal.ts";
 import type { PrinterService } from "@flowscripter/dynamic-cli-framework-api";
 import DefaultPrinterService from "../service/printer/DefaultPrinterService.ts";
 import type Styler from "../terminal/Styler.ts";
+import { detectDarkBackground } from "../terminal/BackgroundDetector.ts";
 import type KeyReader from "../terminal/KeyReader.ts";
 import type BaseCLIFeatureOptions from "./BaseCLIFeatureOptions.ts";
 import DefaultPrompterService, {
@@ -196,7 +197,11 @@ export default class BaseCLI implements CLI {
     this.#commandRegistry = new DefaultCommandRegistry([], commandValidator);
 
     // create a context
-    this.#context = new DefaultContext(this.#cliConfig);
+    this.#context = new DefaultContext(this.#cliConfig, {
+      stdin: keyReader !== undefined,
+      stdout: stdoutTerminal.isTty(),
+      stderr: stderrTerminal.isTty(),
+    });
 
     this.#startupServiceProvider = new StartupServiceProvider(STARTUP_SERVICE_PRIORITY);
 
@@ -272,13 +277,19 @@ export default class BaseCLI implements CLI {
     // create and add core services
     this.addServiceProvider(new ShutdownServiceProvider(SHUTDOWN_SERVICE_PRIORITY));
     this.addServiceProvider(this.#startupServiceProvider);
+    const canPrompt = this.#context.isTty.stdin && this.#context.isTty.stderr;
+
     this.addServiceProvider(
-      new PrinterServiceProvider(PRINTER_SERVICE_PRIORITY, this.#printerService),
+      new PrinterServiceProvider(
+        PRINTER_SERVICE_PRIORITY,
+        this.#printerService,
+        canPrompt && this.#keyReader !== undefined
+          ? () => detectDarkBackground(this.#keyReader!, this.#stderrTerminal)
+          : undefined,
+      ),
     );
     this.addServiceProvider(new TableGeneratorServiceProvider(TABLE_GENERATOR_SERVICE_PRIORITY));
 
-    const canPrompt = this.#keyReader !== undefined && this.#stderrTerminal.isTty();
-
     if (this.#options.promptingEnabled && !canPrompt) {
       throw new Error("promptingEnabled requires a keyReader and a TTY stderr terminal");
     }

package/src/runtime/DefaultContext.ts

@@ -7,7 +7,10 @@ import type { CLIConfig } from "@flowscripter/dynamic-cli-framework-api";
 export default class DefaultContext implements Context {
   readonly #serviceInstancesById: Map<string, unknown> = new Map();
 
-  public constructor(readonly cliConfig: CLIConfig) {}
+  public constructor(
+    readonly cliConfig: CLIConfig,
+    readonly isTty: Context["isTty"] = { stdin: false, stdout: false, stderr: false },
+  ) {}
 
   public addServiceInstance(id: string, serviceInstance: unknown) {
     if (this.#serviceInstancesById.has(id)) {