@flowscripter/dynamic-cli-framework-api 1.0.0

package/dist/src/registry/CommandRegistry.d.ts

@@ -0,0 +1,89 @@
+import type GroupCommand from "../command/GroupCommand.ts";
+import type SubCommand from "../command/SubCommand.ts";
+import type GlobalCommand from "../command/GlobalCommand.ts";
+import type GlobalModifierCommand from "../command/GlobalModifierCommand.ts";
+import type Command from "../command/Command.ts";
+/**
+ * Interface used by a {@link CLI} to register {@link Command} instances.
+ */
+export default interface CommandRegistry {
+    /**
+     * Get all registered {@link SubCommand} instances.
+     */
+    getSubCommands(): ReadonlyArray<SubCommand>;
+    /**
+     * Get all registered {@link GroupCommand} instances.
+     */
+    getGroupCommands(): ReadonlyArray<GroupCommand>;
+    /**
+     * Get all registered {@link GlobalCommand} instances.
+     */
+    getGlobalCommands(): ReadonlyArray<GlobalCommand>;
+    /**
+     * Get all registered {@link GlobalModifierCommand} instances.
+     */
+    getGlobalModifierCommands(): ReadonlyArray<GlobalModifierCommand>;
+    /**
+     * Get a registered {@link SubCommand} by name.
+     */
+    getSubCommandByName(name: string): SubCommand | undefined;
+    /**
+     * Get a registered {@link GroupCommand} by name.
+     */
+    getGroupCommandByName(name: string): GroupCommand | undefined;
+    /**
+     * Get a registered {@link GroupCommand} and member {@link SubCommand} by
+     * combined name e.g. `<group-command-name>:<member-sub-command-name>`.
+     */
+    getGroupCommandAndMemberSubCommandByJoinedName(getGroupCommandAndMemberSubCommandByName: string): {
+        groupCommand: GroupCommand;
+        command: SubCommand;
+    } | undefined;
+    /**
+     * Get a registered {@link GlobalCommand} by name.
+     */
+    getGlobalCommandByName(name: string): GlobalCommand | undefined;
+    /**
+     * Get a registered {@link GlobalCommand} by short alias.
+     */
+    /**
+     * Get a registered {@link GlobalModifierCommand} by name.
+     */
+    getGlobalModifierCommandByName(name: string): GlobalModifierCommand | undefined;
+    /**
+     * Get a registered {@link GlobalModifierCommand} by short alias.
+     */
+    /**
+     * Get a map of all registered {@link GroupCommand} and member {@link SubCommand} instance combinations by
+     * combined name e.g. `<group-command-name>:<member-sub-command-name>`.
+     */
+    getGroupAndMemberCommandsByJoinedName(): ReadonlyMap<string, {
+        groupCommand: GroupCommand;
+        command: SubCommand;
+    }>;
+    /**
+     * Get a map of all registered {@link GlobalModifierCommand} instances by name provided by the specified service.
+     */
+    getGlobalModifierCommandsByNameProvidedByService(serviceId: string): ReadonlyMap<string, GlobalModifierCommand>;
+    /**
+     * Get a map of all registered {@link GlobalModifierCommand} instances by short alias provided by the specified service.
+     */
+    getGlobalModifierCommandsByShortAliasProvidedByService(serviceId: string): ReadonlyMap<string, GlobalModifierCommand>;
+    /**
+     * Get a map of all registered {@link GlobalModifierCommand} instances by name not provided by a service.
+     */
+    getGlobalModifierCommandsByNameNotProvidedByService(): ReadonlyMap<string, GlobalModifierCommand>;
+    /**
+     * Get a map of all registered {@link GlobalModifierCommand} instances by short alias not provided by a service.
+     */
+    getGlobalModifierCommandsByShortAliasNotProvidedByService(): ReadonlyMap<string, GlobalModifierCommand>;
+    /**
+     * Get a map of all registered non-modifier {@link Command} instances by name.
+     */
+    getNonModifierCommandsByName(): ReadonlyMap<string, Command>;
+    /**
+     * Get a map of all registered {@link GlobalCommand} instances by short alias.
+     */
+    getGlobalCommandsByShortAlias(): ReadonlyMap<string, GlobalCommand>;
+}
+//# sourceMappingURL=CommandRegistry.d.ts.map

package/dist/src/registry/CommandRegistry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommandRegistry.d.ts","sourceRoot":"","sources":["../../../src/registry/CommandRegistry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,4BAA4B,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,0BAA0B,CAAC;AACvD,OAAO,KAAK,aAAa,MAAM,6BAA6B,CAAC;AAC7D,OAAO,KAAK,qBAAqB,MAAM,qCAAqC,CAAC;AAC7E,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAC;AAEjD;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,eAAe;IACtC;;OAEG;IACH,cAAc,IAAI,aAAa,CAAC,UAAU,CAAC,CAAC;IAE5C;;OAEG;IACH,gBAAgB,IAAI,aAAa,CAAC,YAAY,CAAC,CAAC;IAEhD;;OAEG;IACH,iBAAiB,IAAI,aAAa,CAAC,aAAa,CAAC,CAAC;IAElD;;OAEG;IACH,yBAAyB,IAAI,aAAa,CAAC,qBAAqB,CAAC,CAAC;IAElE;;OAEG;IACH,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;IAE1D;;OAEG;IACH,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAAC;IAE9D;;;OAGG;IACH,8CAA8C,CAC5C,wCAAwC,EAAE,MAAM,GAC/C;QAAE,YAAY,EAAE,YAAY,CAAC;QAAC,OAAO,EAAE,UAAU,CAAA;KAAE,GAAG,SAAS,CAAC;IAEnE;;OAEG;IACH,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAAC;IAEhE;;OAEG;IAGH;;OAEG;IACH,8BAA8B,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS,CAAC;IAEhF;;OAEG;IAKH;;;OAGG;IACH,qCAAqC,IAAI,WAAW,CAClD,MAAM,EACN;QAAE,YAAY,EAAE,YAAY,CAAC;QAAC,OAAO,EAAE,UAAU,CAAA;KAAE,CACpD,CAAC;IAEF;;OAEG;IACH,gDAAgD,CAC9C,SAAS,EAAE,MAAM,GAChB,WAAW,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IAE9C;;OAEG;IACH,sDAAsD,CACpD,SAAS,EAAE,MAAM,GAChB,WAAW,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IAE9C;;OAEG;IACH,mDAAmD,IAAI,WAAW,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IAElG;;OAEG;IACH,yDAAyD,IAAI,WAAW,CACtE,MAAM,EACN,qBAAqB,CACtB,CAAC;IAEF;;OAEG;IACH,4BAA4B,IAAI,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE7D;;OAEG;IACH,6BAA6B,IAAI,WAAW,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;CACrE"}

package/dist/src/registry/ServiceProviderRegistry.d.ts

@@ -0,0 +1,11 @@
+import type { ServiceProvider } from "../service/ServiceProvider.ts";
+/**
+ * Interface used by a {@link CLI} to register {@link ServiceProvider} instances.
+ */
+export default interface ServiceProviderRegistry {
+    /**
+     * Return all {@link ServiceProvider} instances registered in order of descending {@link ServiceProvider.servicePriority}
+     */
+    getServiceProviders(): ReadonlyArray<ServiceProvider>;
+}
+//# sourceMappingURL=ServiceProviderRegistry.d.ts.map

package/dist/src/registry/ServiceProviderRegistry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServiceProviderRegistry.d.ts","sourceRoot":"","sources":["../../../src/registry/ServiceProviderRegistry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAErE;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,uBAAuB;IAC9C;;OAEG;IACH,mBAAmB,IAAI,aAAa,CAAC,eAAe,CAAC,CAAC;CACvD"}

package/dist/src/service/ServiceProvider.d.ts

@@ -0,0 +1,47 @@
+import type Command from "../command/Command.ts";
+import type Context from "../Context.ts";
+import type CLIConfig from "../CLIConfig.ts";
+/**
+ * Information regarding a service instance provided by a {@link ServiceProvider}.
+ */
+export interface ServiceInfo {
+    /**
+     * Optional, a service in the {@link Context}.
+     */
+    readonly service?: unknown;
+    /**
+     * Zero or more {@link Command} instances related to the service which should be registered.
+     */
+    readonly commands: ReadonlyArray<Command>;
+}
+/**
+ * Interface allowing a service to be provided to the CLI.
+ */
+export interface ServiceProvider {
+    /**
+     * The ID which identifies the service provided.
+     */
+    readonly serviceId: string;
+    /**
+     * Used to determine the order in which multiple service instances will be initialised. Higher values
+     * will be initialised before lower values.
+     */
+    readonly servicePriority: number;
+    /**
+     * Return {@link ServiceInfo} containing the service and any commands it provides which should be registered in the CLI.
+     *
+     * @param cliConfig the {@link CLIConfig} for the CLI.
+     */
+    getServiceInfo(cliConfig: CLIConfig): Promise<ServiceInfo>;
+    /**
+     * Initialise the service. This will be invoked AFTER any {@link GlobalModifierCommand} provided in the
+     * {@link ServiceInfo} have been invoked (if specified as CLI arguments or CLI configuration).
+     *
+     * NOTE: Other services within the provided context will only have been initialised if they have a higher
+     * {@link servicePriority} value than the current service.
+     *
+     * @param context the {@link Context} in which the CLI is running.
+     */
+    initService(context: Context): Promise<void>;
+}
+//# sourceMappingURL=ServiceProvider.d.ts.map

package/dist/src/service/ServiceProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServiceProvider.d.ts","sourceRoot":"","sources":["../../../src/service/ServiceProvider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAC;AACjD,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,SAAS,MAAM,iBAAiB,CAAC;AAE7C;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAEjC;;;;OAIG;IACH,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAE3D;;;;;;;;OAQG;IACH,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9C"}

package/dist/src/service/core/ArgumentPrompterService.d.ts

@@ -0,0 +1,6 @@
+import type { ParseResult } from "../../ParseResult.ts";
+export declare const ARGUMENT_PROMPTER_SERVICE_ID = "@flowscripter/dynamic-cli-framework/argument-prompter-service";
+export default interface ArgumentPrompterService {
+    promptForMissingArguments(parseResult: ParseResult): Promise<ParseResult>;
+}
+//# sourceMappingURL=ArgumentPrompterService.d.ts.map

package/dist/src/service/core/ArgumentPrompterService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArgumentPrompterService.d.ts","sourceRoot":"","sources":["../../../../src/service/core/ArgumentPrompterService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAExD,eAAO,MAAM,4BAA4B,kEACwB,CAAC;AAElE,MAAM,CAAC,OAAO,WAAW,uBAAuB;IAC9C,yBAAyB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CAC3E"}

package/dist/src/service/core/ArgumentPrompterService.js

@@ -0,0 +1 @@
+export const ARGUMENT_PROMPTER_SERVICE_ID = "@flowscripter/dynamic-cli-framework/argument-prompter-service";

package/dist/src/service/core/AsciiBannerGeneratorService.d.ts

@@ -0,0 +1,59 @@
+export declare const ASCII_BANNER_GENERATOR_SERVICE_ID = "@flowscripter/dynamic-cli-framework/ascii-banner-generator-service";
+export type ColorEffectDirection = "horizontal" | "vertical";
+export interface FixedColorEffect {
+    type: "fixed";
+    color: string;
+}
+export interface GradientColorEffect {
+    type: "gradient";
+    colors: string[];
+    direction: ColorEffectDirection;
+}
+export interface RainbowColorEffect {
+    type: "rainbow";
+    spread?: number;
+    frequency?: number;
+    seed?: number;
+    direction: ColorEffectDirection;
+}
+export type ColorEffect = FixedColorEffect | GradientColorEffect | RainbowColorEffect;
+export interface BannerColorEffects {
+    background?: ColorEffect;
+    messageForeground?: ColorEffect;
+    subMessageForeground?: ColorEffect;
+}
+export interface BannerGenerateOptions {
+    fontName?: string;
+    subMessage?: string;
+    colorEffects?: BannerColorEffects;
+}
+/**
+ * Service allowing a text string to be rendered using an ASCII banner font.
+ */
+export default interface AsciiBannerGeneratorService {
+    /**
+     * Register a new font.
+     *
+     * The recommended way to load the font definition is to convert the font definition to a JSON string
+     * (replacing newlines with `\n`) and placing in a simple JSON file: `{ "font": "<figlet font definition>" }`.
+     * This can then be imported as follows:
+     *
+     * `import { font as myFont } from "./myfont.json" with { type: "json" };`
+     *
+     * @param fontName the name used to refer to the font.
+     * @param fontDefinition the definition for the syntax conforming to the FIGfont format.
+     */
+    registerFont(fontName: string, fontDefinition: string): void;
+    /**
+     * Return the names of the currently registered fonts.
+     */
+    getRegisteredFonts(): ReadonlyArray<string>;
+    /**
+     * Generate an ASCII banner text for the message using the specified options.
+     *
+     * @param message the message to output.
+     * @param options optional generation options.
+     */
+    generate(message: string, options?: BannerGenerateOptions): Promise<string>;
+}
+//# sourceMappingURL=AsciiBannerGeneratorService.d.ts.map

package/dist/src/service/core/AsciiBannerGeneratorService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AsciiBannerGeneratorService.d.ts","sourceRoot":"","sources":["../../../../src/service/core/AsciiBannerGeneratorService.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,iCAAiC,uEACwB,CAAC;AAEvE,MAAM,MAAM,oBAAoB,GAAG,YAAY,GAAG,UAAU,CAAC;AAE7D,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,SAAS,EAAE,oBAAoB,CAAC;CACjC;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,oBAAoB,CAAC;CACjC;AAED,MAAM,MAAM,WAAW,GAAG,gBAAgB,GAAG,mBAAmB,GAAG,kBAAkB,CAAC;AAEtF,MAAM,WAAW,kBAAkB;IACjC,UAAU,CAAC,EAAE,WAAW,CAAC;IACzB,iBAAiB,CAAC,EAAE,WAAW,CAAC;IAChC,oBAAoB,CAAC,EAAE,WAAW,CAAC;CACpC;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,kBAAkB,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,2BAA2B;IAClD;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,kBAAkB,IAAI,aAAa,CAAC,MAAM,CAAC,CAAC;IAE5C;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC7E"}

package/dist/src/service/core/AsciiBannerGeneratorService.js

@@ -0,0 +1 @@
+export const ASCII_BANNER_GENERATOR_SERVICE_ID = "@flowscripter/dynamic-cli-framework/ascii-banner-generator-service";

package/dist/src/service/core/CompletionService.d.ts

@@ -0,0 +1,22 @@
+export declare const COMPLETION_SERVICE_ID = "@flowscripter/dynamic-cli-framework/completion-service";
+export declare enum ShellType {
+    BASH = "bash",
+    ZSH = "zsh",
+    FISH = "fish",
+    POWERSHELL = "powershell"
+}
+export interface CompletionItem {
+    readonly value: string;
+    readonly description?: string;
+}
+/**
+ * Interface for a service providing shell auto-completion support.
+ */
+export default interface CompletionService {
+    generateCompletions(shellType: ShellType, line: string, cursorPosition: number): Promise<ReadonlyArray<CompletionItem>>;
+    getBootstrapScript(shellType: ShellType, cliName: string, executablePath: string): string;
+    getDefaultConfigPath(shellType: ShellType): string;
+    validateShellEnvironment(shellType: ShellType): Promise<boolean>;
+    formatCompletions(shellType: ShellType, completions: ReadonlyArray<CompletionItem>): string;
+}
+//# sourceMappingURL=CompletionService.d.ts.map

package/dist/src/service/core/CompletionService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CompletionService.d.ts","sourceRoot":"","sources":["../../../../src/service/core/CompletionService.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,qBAAqB,2DAA2D,CAAC;AAE9F,oBAAY,SAAS;IACnB,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,UAAU,eAAe;CAC1B;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,iBAAiB;IACxC,mBAAmB,CACjB,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,MAAM,GACrB,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC;IAE1C,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,MAAM,CAAC;IAE1F,oBAAoB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAAC;IAEnD,wBAAwB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEjE,iBAAiB,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,aAAa,CAAC,cAAc,CAAC,GAAG,MAAM,CAAC;CAC7F"}

package/dist/src/service/core/CompletionService.js

@@ -0,0 +1,8 @@
+export const COMPLETION_SERVICE_ID = "@flowscripter/dynamic-cli-framework/completion-service";
+export var ShellType;
+(function (ShellType) {
+    ShellType["BASH"] = "bash";
+    ShellType["ZSH"] = "zsh";
+    ShellType["FISH"] = "fish";
+    ShellType["POWERSHELL"] = "powershell";
+})(ShellType || (ShellType = {}));

package/dist/src/service/core/DataDumpGeneratorService.d.ts

@@ -0,0 +1,22 @@
+import { Buffer } from "node:buffer";
+export declare const DATA_DUMP_GENERATOR_SERVICE_ID = "@flowscripter/dynamic-cli-framework/data-dump-generator-service";
+export declare enum DumpFormat {
+    HEX = "HEX",
+    ASCII = "ASCII"
+}
+export interface ByteRangeColor {
+    start: number;
+    end: number;
+    color: string;
+}
+export interface HexDumpGenerateOptions {
+    format?: DumpFormat;
+    bytesPerGroup?: number;
+    groupsPerRow?: number;
+    spacesBetweenGroups?: number;
+    colorScheme?: ByteRangeColor[];
+}
+export default interface DataDumpGeneratorService {
+    generate(data: Buffer, options?: HexDumpGenerateOptions): string;
+}
+//# sourceMappingURL=DataDumpGeneratorService.d.ts.map

package/dist/src/service/core/DataDumpGeneratorService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataDumpGeneratorService.d.ts","sourceRoot":"","sources":["../../../../src/service/core/DataDumpGeneratorService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,eAAO,MAAM,8BAA8B,oEACwB,CAAC;AAEpE,oBAAY,UAAU;IACpB,GAAG,QAAQ;IACX,KAAK,UAAU;CAChB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,WAAW,CAAC,EAAE,cAAc,EAAE,CAAC;CAChC;AAED,MAAM,CAAC,OAAO,WAAW,wBAAwB;IAC/C,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,MAAM,CAAC;CAClE"}

package/dist/src/service/core/DataDumpGeneratorService.js

@@ -0,0 +1,7 @@
+import { Buffer } from "node:buffer";
+export const DATA_DUMP_GENERATOR_SERVICE_ID = "@flowscripter/dynamic-cli-framework/data-dump-generator-service";
+export var DumpFormat;
+(function (DumpFormat) {
+    DumpFormat["HEX"] = "HEX";
+    DumpFormat["ASCII"] = "ASCII";
+})(DumpFormat || (DumpFormat = {}));

package/dist/src/service/core/ImagePrinterService.d.ts

@@ -0,0 +1,21 @@
+export declare const IMAGE_PRINTER_SERVICE_ID = "@flowscripter/dynamic-cli-framework/image-printer-service";
+/**
+ * Service for rendering images in the terminal.
+ *
+ * Uses the Kitty or iTerm2 graphics protocol when supported, otherwise falls back
+ * to ANSI half-block character rendering. Terminal multiplexers (tmux, screen) always
+ * use the ANSI fallback as they do not pass through graphics protocol escape sequences.
+ */
+export default interface ImagePrinterService {
+    /**
+     * Render an image as a string suitable for terminal output.
+     *
+     * @param imageBuffer the raw image data (e.g. PNG file contents).
+     * @param widthPercentage the percentage of terminal width to use for rendering. Defaults to 100.
+     * @param hexFormattedBackgroundColor optional background color for transparent pixels.
+     *   This should be a valid hex formatted string e.g. "#rrggbb". If not specified,
+     *   transparent pixels show through to the terminal background.
+     */
+    image(imageBuffer: Uint8Array, widthPercentage?: number, hexFormattedBackgroundColor?: string): Promise<string>;
+}
+//# sourceMappingURL=ImagePrinterService.d.ts.map

package/dist/src/service/core/ImagePrinterService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ImagePrinterService.d.ts","sourceRoot":"","sources":["../../../../src/service/core/ImagePrinterService.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,wBAAwB,8DAA8D,CAAC;AAEpG;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,WAAW,mBAAmB;IAC1C;;;;;;;;OAQG;IACH,KAAK,CACH,WAAW,EAAE,UAAU,EACvB,eAAe,CAAC,EAAE,MAAM,EACxB,2BAA2B,CAAC,EAAE,MAAM,GACnC,OAAO,CAAC,MAAM,CAAC,CAAC;CACpB"}

package/dist/src/service/core/ImagePrinterService.js

@@ -0,0 +1 @@
+export const IMAGE_PRINTER_SERVICE_ID = "@flowscripter/dynamic-cli-framework/image-printer-service";

package/dist/src/service/core/KeyValueService.d.ts

@@ -0,0 +1,40 @@
+export declare const KEY_VALUE_SERVICE_ID = "@flowscripter/dynamic-cli-framework/key-value-service";
+/**
+ * The sentinel prefix used to indicate a value is stored as an OS-native secret.
+ * Values starting with this prefix are resolved via the {@link SecretService}.
+ * This prefix is reserved and must not be used for regular key-value data.
+ */
+export declare const SECRET_SENTINEL_PREFIX = "__SECRET__:";
+/**
+ * Service providing keystore functionality for the CLI. The keystore data is scoped to the
+ * service or {@link Command} instances accessing this service via {@link Context.getServiceById}.
+ *
+ * Values can optionally be stored as OS-native secrets using the `isSecret` parameter on
+ * {@link setKey}. Secret values are stored via {@link SecretService} and only a sentinel
+ * reference is kept in the key-value Map. The sentinel prefix `__SECRET__:` is reserved.
+ */
+export default interface KeyValueService {
+    /**
+     * Get a value for a specified key in the keystore.
+     * If the stored value is a secret sentinel, the actual value is retrieved from the OS secret store.
+     */
+    getKey(key: string): Promise<string>;
+    /**
+     * Set a value for a specified key in the keystore.
+     *
+     * @param isSecret if true, the value is stored in the OS-native secret store and a sentinel
+     *   reference is kept in the key-value Map. Requires that the service was constructed with
+     *   secret support enabled.
+     */
+    setKey(key: string, value: string, isSecret?: boolean): Promise<void>;
+    /**
+     * Check if a value for a specified key exists in the keystore.
+     */
+    hasKey(key: string): Promise<boolean>;
+    /**
+     * Delete the value for a specified key in the keystore.
+     * If the stored value is a secret sentinel, the secret is also deleted from the OS secret store.
+     */
+    deleteKey(key: string): Promise<void>;
+}
+//# sourceMappingURL=KeyValueService.d.ts.map

package/dist/src/service/core/KeyValueService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyValueService.d.ts","sourceRoot":"","sources":["../../../../src/service/core/KeyValueService.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,oBAAoB,0DAA0D,CAAC;AAE5F;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,gBAAgB,CAAC;AAEpD;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,WAAW,eAAe;IACtC;;;OAGG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAErC;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtE;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAEtC;;;OAGG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvC"}

package/dist/src/service/core/KeyValueService.js

@@ -0,0 +1,7 @@
+export const KEY_VALUE_SERVICE_ID = "@flowscripter/dynamic-cli-framework/key-value-service";
+/**
+ * The sentinel prefix used to indicate a value is stored as an OS-native secret.
+ * Values starting with this prefix are resolved via the {@link SecretService}.
+ * This prefix is reserved and must not be used for regular key-value data.
+ */
+export const SECRET_SENTINEL_PREFIX = "__SECRET__:";

package/dist/src/service/core/PluginService.d.ts

@@ -0,0 +1,56 @@
+import type { VersionedPluginDescriptor, SearchQuery } from "@flowscripter/dynamic-plugin-framework";
+/**
+ * Service ID for {@link PluginService}.
+ *
+ * Pass to {@link Context.getServiceById} to retrieve the active {@link PluginService} instance.
+ */
+export declare const PLUGIN_SERVICE_ID = "PLUGIN_SERVICE";
+/**
+ * Service providing plugin lifecycle management for a CLI with dynamic plugin support.
+ *
+ * Exposes search, install, uninstall, list, and update operations backed by a
+ * `MarketplacePluginManager` (see dynamic-plugin-framework). Provided by
+ * `DefaultPluginServiceProvider` when plugin support is enabled via
+ * `DynamicPluginRuntimeCLI` (see dynamic-cli-framework).
+ *
+ * After {@link install} or an upgrade, the CLI must be restarted for new or updated
+ * plugin commands and service providers to become active.
+ */
+export default interface PluginService {
+    /**
+     * Search the remote marketplace for plugins matching the given query.
+     *
+     * @param query criteria to filter results by.
+     * @returns an async iterable of matching {@link VersionedPluginDescriptor} entries.
+     */
+    search(query: Readonly<SearchQuery>): AsyncIterable<Readonly<VersionedPluginDescriptor>>;
+    /**
+     * Install a plugin from the remote marketplace into the local plugin store.
+     *
+     * @param descriptor the plugin to install, as returned by {@link search}.
+     */
+    install(descriptor: Readonly<VersionedPluginDescriptor>): Promise<void>;
+    /**
+     * Remove a previously installed plugin from the local plugin store.
+     *
+     * @param pluginId the package identifier of the plugin to remove (e.g. `@scope/my-plugin`).
+     */
+    uninstall(pluginId: string): Promise<void>;
+    /**
+     * List all plugins currently installed in the local plugin store.
+     *
+     * @returns an async iterable of {@link VersionedPluginDescriptor} entries for each installed plugin.
+     */
+    listInstalled(): AsyncIterable<Readonly<VersionedPluginDescriptor>>;
+    /**
+     * Check each installed plugin for a newer version available on the remote marketplace.
+     *
+     * @returns an async iterable of objects pairing the installed plugin descriptor with the
+     * latest available version string for plugins that have an update available.
+     */
+    checkForUpdates(): AsyncIterable<{
+        descriptor: Readonly<VersionedPluginDescriptor>;
+        availableVersion: string;
+    }>;
+}
+//# sourceMappingURL=PluginService.d.ts.map

package/dist/src/service/core/PluginService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PluginService.d.ts","sourceRoot":"","sources":["../../../../src/service/core/PluginService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,yBAAyB,EACzB,WAAW,EACZ,MAAM,wCAAwC,CAAC;AAEhD;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,mBAAmB,CAAC;AAElD;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,WAAW,aAAa;IACpC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,GAAG,aAAa,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC,CAAC;IAEzF;;;;OAIG;IACH,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,yBAAyB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExE;;;;OAIG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3C;;;;OAIG;IACH,aAAa,IAAI,aAAa,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC,CAAC;IAEpE;;;;;OAKG;IACH,eAAe,IAAI,aAAa,CAAC;QAC/B,UAAU,EAAE,QAAQ,CAAC,yBAAyB,CAAC,CAAC;QAChD,gBAAgB,EAAE,MAAM,CAAC;KAC1B,CAAC,CAAC;CACJ"}

package/dist/src/service/core/PluginService.js

@@ -0,0 +1,6 @@
+/**
+ * Service ID for {@link PluginService}.
+ *
+ * Pass to {@link Context.getServiceById} to retrieve the active {@link PluginService} instance.
+ */
+export const PLUGIN_SERVICE_ID = "PLUGIN_SERVICE";

package/dist/src/service/core/PrettyPrinterService.d.ts

@@ -0,0 +1,35 @@
+export declare const PRETTY_PRINTER_SERVICE_ID = "@flowscripter/dynamic-cli-framework/pretty-printer-service";
+import type { Plugin } from "prettier";
+/**
+ * Service providing syntax based pretty printing of text for the CLI using [prettier](https://github.com/prettier/prettier).
+ */
+export default interface PrettyPrinterService {
+    /**
+     * Register a new syntax.
+     *
+     * The recommended way to define a new language syntax plugin is to follow the instructions here:
+     *
+     * https://prettier.io/docs/plugins#developing-plugins
+     *
+     * There is a list of already defined languages available for import here:
+     *
+     * * https://prettier.io/docs/
+     * * https://prettier.io/docs/plugins
+     *
+     * @param syntaxName the name used to refer to the syntax.
+     * @param syntaxDefinition the definition for the syntax conforming to the Prettier plugin interface.
+     */
+    registerSyntax(syntaxName: string, syntaxDefinition: Plugin<unknown>): Promise<void>;
+    /**
+     * Return the names of the currently registered syntaxes.
+     */
+    getRegisteredSyntaxes(): Promise<ReadonlyArray<string>>;
+    /**
+     * Return a pretty printed version of the provided text using the specified syntax.
+     *
+     * @param text the text to prettify.
+     * @param syntaxName the syntax to use.
+     */
+    prettify(text: string, syntaxName: string): Promise<string>;
+}
+//# sourceMappingURL=PrettyPrinterService.d.ts.map

package/dist/src/service/core/PrettyPrinterService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrettyPrinterService.d.ts","sourceRoot":"","sources":["../../../../src/service/core/PrettyPrinterService.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,yBAAyB,+DACwB,CAAC;AAE/D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,oBAAoB;IAC3C;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErF;;OAEG;IACH,qBAAqB,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IAExD;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC7D"}

package/dist/src/service/core/PrettyPrinterService.js

@@ -0,0 +1 @@
+export const PRETTY_PRINTER_SERVICE_ID = "@flowscripter/dynamic-cli-framework/pretty-printer-service";