@flowscripter/dynamic-cli-framework 2.4.0 → 3.0.0

package/src/service/fetch/FetchServiceProvider.ts

@@ -0,0 +1,33 @@
+import type {
+  CLIConfig,
+  Context,
+  ServiceInfo,
+  ServiceProvider,
+  ShutdownService,
+} from "@flowscripter/dynamic-cli-framework-api";
+import { FETCH_SERVICE_ID, SHUTDOWN_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+import DefaultFetchService from "./DefaultFetchService.ts";
+
+export default class FetchServiceProvider implements ServiceProvider {
+  readonly serviceId: string = FETCH_SERVICE_ID;
+  readonly servicePriority: number;
+  #fetchService: DefaultFetchService | undefined;
+
+  public constructor(servicePriority: number) {
+    this.servicePriority = servicePriority;
+  }
+
+  public getServiceInfo(_cliConfig: CLIConfig): Promise<ServiceInfo> {
+    this.#fetchService = new DefaultFetchService();
+    return Promise.resolve({
+      service: this.#fetchService,
+      commands: [],
+    });
+  }
+
+  public initService(context: Context): Promise<void> {
+    const shutdownService = context.getServiceById(SHUTDOWN_SERVICE_ID) as ShutdownService;
+    this.#fetchService!.setDependencies(shutdownService);
+    return Promise.resolve();
+  }
+}

package/src/service/plugin/DefaultPluginServiceProvider.ts

@@ -3,7 +3,10 @@ import type { Context } from "@flowscripter/dynamic-cli-framework-api";
 import type { CLIConfig } from "@flowscripter/dynamic-cli-framework-api";
 import type { PrinterService, SpawnService } from "@flowscripter/dynamic-cli-framework-api";
 import { PRINTER_SERVICE_ID, SPAWN_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+import type { FetchService } from "@flowscripter/dynamic-cli-framework-api";
+import { FETCH_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 import type {
+  FetchCapable,
   MarketplacePluginManager,
   SpawnCapable,
 } from "@flowscripter/dynamic-plugin-framework";
@@ -13,6 +16,9 @@ import { PluginGroupCommand } from "./command/PluginGroupCommand.ts";
 import SpawnInterfaceAdapter, {
   type SpawnInterfaceAdapterOptions,
 } from "./SpawnInterfaceAdapter.ts";
+import FetchInterfaceAdapter, {
+  type FetchInterfaceAdapterOptions,
+} from "./FetchInterfaceAdapter.ts";
 import getLogger from "../../util/logger.ts";
 
 const logger = getLogger("DefaultPluginServiceProvider");
@@ -22,16 +28,19 @@ export default class DefaultPluginServiceProvider implements ServiceProvider {
   readonly servicePriority: number;
   readonly #pluginManager: MarketplacePluginManager;
   readonly #spawnInterfaceAdapterOptions: SpawnInterfaceAdapterOptions;
+  readonly #fetchInterfaceAdapterOptions: FetchInterfaceAdapterOptions;
   #pluginService: DefaultPluginService | undefined;
 
   constructor(
     pluginManager: MarketplacePluginManager,
     servicePriority = 50,
     spawnInterfaceAdapterOptions: SpawnInterfaceAdapterOptions = {},
+    fetchInterfaceAdapterOptions: FetchInterfaceAdapterOptions = {},
   ) {
     this.#pluginManager = pluginManager;
     this.servicePriority = servicePriority;
     this.#spawnInterfaceAdapterOptions = spawnInterfaceAdapterOptions;
+    this.#fetchInterfaceAdapterOptions = fetchInterfaceAdapterOptions;
   }
 
   async getServiceInfo(_cliConfig: CLIConfig): Promise<ServiceInfo> {
@@ -45,21 +54,29 @@ export default class DefaultPluginServiceProvider implements ServiceProvider {
   initService(context: Context): Promise<void> {
     if (!context.doesServiceExist(SPAWN_SERVICE_ID)) {
       logger.debug("SpawnService not available, plugin manager will spawn processes directly");
-      return Promise.resolve();
-    }
-    if (!("setSpawn" in this.#pluginManager)) {
+    } else if (!("setSpawn" in this.#pluginManager)) {
       logger.debug("Plugin manager does not support SpawnCapable, skipping spawn injection");
-      return Promise.resolve();
+    } else {
+      const spawnService = context.getServiceById(SPAWN_SERVICE_ID) as SpawnService;
+      const printerService = context.getServiceById(PRINTER_SERVICE_ID) as PrinterService;
+      const adapter = new SpawnInterfaceAdapter(
+        spawnService,
+        printerService,
+        this.#spawnInterfaceAdapterOptions,
+      );
+      (this.#pluginManager as unknown as SpawnCapable).setSpawn(adapter);
+    }
+
+    if (!context.doesServiceExist(FETCH_SERVICE_ID)) {
+      logger.debug("FetchService not available, plugin manager will fetch directly");
+    } else if (!("setFetch" in this.#pluginManager)) {
+      logger.debug("Plugin manager does not support FetchCapable, skipping fetch injection");
+    } else {
+      const fetchService = context.getServiceById(FETCH_SERVICE_ID) as FetchService;
+      const adapter = new FetchInterfaceAdapter(fetchService, this.#fetchInterfaceAdapterOptions);
+      (this.#pluginManager as unknown as FetchCapable).setFetch(adapter);
     }
 
-    const spawnService = context.getServiceById(SPAWN_SERVICE_ID) as SpawnService;
-    const printerService = context.getServiceById(PRINTER_SERVICE_ID) as PrinterService;
-    const adapter = new SpawnInterfaceAdapter(
-      spawnService,
-      printerService,
-      this.#spawnInterfaceAdapterOptions,
-    );
-    (this.#pluginManager as unknown as SpawnCapable).setSpawn(adapter);
     return Promise.resolve();
   }
 }

package/src/service/plugin/FetchInterfaceAdapter.ts

@@ -0,0 +1,28 @@
+import type { FetchService } from "@flowscripter/dynamic-cli-framework-api";
+import type { FetchInterface } from "@flowscripter/dynamic-plugin-framework";
+
+export interface FetchInterfaceAdapterOptions {
+  timeoutMs?: number;
+}
+
+/**
+ * Adapts a {@link FetchService} to dynamic-plugin-framework's {@link FetchInterface}, so plugin
+ * manager/repository fetches respect the host CLI's shutdown handling and default timeout.
+ */
+export default class FetchInterfaceAdapter implements FetchInterface {
+  readonly #fetchService: FetchService;
+  readonly #timeoutMs: number | undefined;
+
+  public constructor(fetchService: FetchService, options: FetchInterfaceAdapterOptions = {}) {
+    this.#fetchService = fetchService;
+    this.#timeoutMs = options.timeoutMs;
+  }
+
+  public async fetch(
+    input: string,
+    init?: RequestInit & { timeoutMs?: number },
+  ): Promise<Response> {
+    const { timeoutMs = this.#timeoutMs, ...requestInit } = init ?? {};
+    return this.#fetchService.fetch(input, { ...requestInit, timeoutMs });
+  }
+}

package/src/service/plugin/SpawnInterfaceAdapter.ts

@@ -45,7 +45,7 @@ export default class SpawnInterfaceAdapter implements SpawnInterface {
 
     const result = await this.#spawnService.spawn(command, {
       cwd: options.cwd,
-      stdio: "wrapped",
+      mode: "wrapped",
       onOutput,
     });
 

package/src/service/plugin/command/PluginAddSubCommand.ts

@@ -1,7 +1,7 @@
 import type { SubCommand } from "@flowscripter/dynamic-cli-framework-api";
 import type { Context } from "@flowscripter/dynamic-cli-framework-api";
-import type { ArgumentValues } from "@flowscripter/dynamic-cli-framework-api";
-import { ArgumentValueTypeName } from "@flowscripter/dynamic-cli-framework-api";
+import type { Values } from "@flowscripter/dynamic-cli-framework-api";
+import { ValueTypeName } from "@flowscripter/dynamic-cli-framework-api";
 import type { PrinterService } from "@flowscripter/dynamic-cli-framework-api";
 import { Icon, PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 import { PLUGIN_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
@@ -18,11 +18,11 @@ export class PluginAddSubCommand implements SubCommand {
     {
       name: "pluginId",
       description: "Plugin ID to install (e.g. @scope/name)",
-      type: ArgumentValueTypeName.STRING,
+      type: ValueTypeName.STRING,
     },
   ];
 
-  async execute(context: Context, argumentValues: ArgumentValues): Promise<void> {
+  async execute(context: Context, argumentValues: Values): Promise<void> {
     const printerService = context.getServiceById(PRINTER_SERVICE_ID) as PrinterService;
     const pluginService = context.getServiceById(PLUGIN_SERVICE_ID) as PluginService;
 

package/src/service/plugin/command/PluginListSubCommand.ts

@@ -1,6 +1,6 @@
 import type { SubCommand } from "@flowscripter/dynamic-cli-framework-api";
 import type { Context } from "@flowscripter/dynamic-cli-framework-api";
-import type { ArgumentValues } from "@flowscripter/dynamic-cli-framework-api";
+import type { Values } from "@flowscripter/dynamic-cli-framework-api";
 import type { PrinterService } from "@flowscripter/dynamic-cli-framework-api";
 import { PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 import { PLUGIN_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
@@ -14,7 +14,7 @@ export class PluginListSubCommand implements SubCommand {
   readonly options = [];
   readonly positionals = [];
 
-  async execute(context: Context, _argumentValues: ArgumentValues): Promise<void> {
+  async execute(context: Context, _argumentValues: Values): Promise<void> {
     const printerService = context.getServiceById(PRINTER_SERVICE_ID) as PrinterService;
     const pluginService = context.getServiceById(PLUGIN_SERVICE_ID) as PluginService;
 

package/src/service/plugin/command/PluginRemoveSubCommand.ts

@@ -1,7 +1,7 @@
 import type { SubCommand } from "@flowscripter/dynamic-cli-framework-api";
 import type { Context } from "@flowscripter/dynamic-cli-framework-api";
-import type { ArgumentValues } from "@flowscripter/dynamic-cli-framework-api";
-import { ArgumentValueTypeName } from "@flowscripter/dynamic-cli-framework-api";
+import type { Values } from "@flowscripter/dynamic-cli-framework-api";
+import { ValueTypeName } from "@flowscripter/dynamic-cli-framework-api";
 import type { PrinterService } from "@flowscripter/dynamic-cli-framework-api";
 import { Icon, PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 import { PLUGIN_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
@@ -16,11 +16,11 @@ export class PluginRemoveSubCommand implements SubCommand {
     {
       name: "pluginId",
       description: "Plugin ID to remove (e.g. @scope/name)",
-      type: ArgumentValueTypeName.STRING,
+      type: ValueTypeName.STRING,
     },
   ];
 
-  async execute(context: Context, argumentValues: ArgumentValues): Promise<void> {
+  async execute(context: Context, argumentValues: Values): Promise<void> {
     const printerService = context.getServiceById(PRINTER_SERVICE_ID) as PrinterService;
     const pluginService = context.getServiceById(PLUGIN_SERVICE_ID) as PluginService;
 

package/src/service/plugin/command/PluginSearchSubCommand.ts

@@ -1,7 +1,7 @@
 import type { SubCommand } from "@flowscripter/dynamic-cli-framework-api";
 import type { Context } from "@flowscripter/dynamic-cli-framework-api";
-import type { ArgumentValues } from "@flowscripter/dynamic-cli-framework-api";
-import { ArgumentValueTypeName } from "@flowscripter/dynamic-cli-framework-api";
+import type { Values } from "@flowscripter/dynamic-cli-framework-api";
+import { ValueTypeName } from "@flowscripter/dynamic-cli-framework-api";
 import type { PrinterService } from "@flowscripter/dynamic-cli-framework-api";
 import { PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 import { PLUGIN_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
@@ -17,12 +17,12 @@ export class PluginSearchSubCommand implements SubCommand {
     {
       name: "query",
       description: "Search query",
-      type: ArgumentValueTypeName.STRING,
+      type: ValueTypeName.STRING,
       isVarargOptional: true,
     },
   ];
 
-  async execute(context: Context, argumentValues: ArgumentValues): Promise<void> {
+  async execute(context: Context, argumentValues: Values): Promise<void> {
     const printerService = context.getServiceById(PRINTER_SERVICE_ID) as PrinterService;
     const pluginService = context.getServiceById(PLUGIN_SERVICE_ID) as PluginService;
 

package/src/service/plugin/command/PluginUpgradeSubCommand.ts

@@ -1,6 +1,6 @@
 import type { SubCommand } from "@flowscripter/dynamic-cli-framework-api";
 import type { Context } from "@flowscripter/dynamic-cli-framework-api";
-import type { ArgumentValues } from "@flowscripter/dynamic-cli-framework-api";
+import type { Values } from "@flowscripter/dynamic-cli-framework-api";
 import type { PrinterService } from "@flowscripter/dynamic-cli-framework-api";
 import { Icon, PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 import { PLUGIN_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
@@ -14,7 +14,7 @@ export class PluginUpgradeSubCommand implements SubCommand {
   readonly options = [];
   readonly positionals = [];
 
-  async execute(context: Context, _argumentValues: ArgumentValues): Promise<void> {
+  async execute(context: Context, _argumentValues: Values): Promise<void> {
     const printerService = context.getServiceById(PRINTER_SERVICE_ID) as PrinterService;
     const pluginService = context.getServiceById(PLUGIN_SERVICE_ID) as PluginService;
 

package/src/service/printer/command/DarkModeCommand.ts

@@ -1,9 +1,6 @@
 import type { GlobalModifierCommand } from "@flowscripter/dynamic-cli-framework-api";
 import type { GlobalCommandArgument } from "@flowscripter/dynamic-cli-framework-api";
-import {
-  type ArgumentSingleValueType,
-  ArgumentValueTypeName,
-} from "@flowscripter/dynamic-cli-framework-api";
+import { type SingleValueType, ValueTypeName } from "@flowscripter/dynamic-cli-framework-api";
 import type { Context } from "@flowscripter/dynamic-cli-framework-api";
 import type PrinterServiceProvider from "../PrinterServiceProvider.ts";
 
@@ -15,7 +12,7 @@ export default class DarkModeCommand implements GlobalModifierCommand {
   readonly description = "Enable dark mode for output";
   readonly enableConfiguration = true;
   readonly argument: GlobalCommandArgument = {
-    type: ArgumentValueTypeName.BOOLEAN,
+    type: ValueTypeName.BOOLEAN,
     defaultValue: false,
     configurationKey: "DARK_MODE",
   };
@@ -28,7 +25,7 @@ export default class DarkModeCommand implements GlobalModifierCommand {
     this.executePriority = executePriority;
   }
 
-  public execute(_context: Context, argumentValue: ArgumentSingleValueType): Promise<void> {
+  public execute(_context: Context, argumentValue: SingleValueType): Promise<void> {
     this.#printerServiceProvider.printerService!.darkMode = argumentValue as boolean;
 
     return Promise.resolve();

package/src/service/printer/command/LogLevelCommand.ts

@@ -1,8 +1,5 @@
 import type { GlobalCommandArgument } from "@flowscripter/dynamic-cli-framework-api";
-import {
-  type ArgumentSingleValueType,
-  ArgumentValueTypeName,
-} from "@flowscripter/dynamic-cli-framework-api";
+import { type SingleValueType, ValueTypeName } from "@flowscripter/dynamic-cli-framework-api";
 import type { GlobalModifierCommand } from "@flowscripter/dynamic-cli-framework-api";
 import type { Context } from "@flowscripter/dynamic-cli-framework-api";
 import type PrinterServiceProvider from "../PrinterServiceProvider.ts";
@@ -16,7 +13,7 @@ export default class LogLevelCommand implements GlobalModifierCommand {
   readonly description = "Set the logging threshold";
   readonly enableConfiguration = true;
   readonly argument: GlobalCommandArgument = {
-    type: ArgumentValueTypeName.STRING,
+    type: ValueTypeName.STRING,
     allowableValues: ["DEBUG", "INFO", "WARN", "ERROR"],
     isCaseInsensitive: true,
     defaultValue: "INFO",
@@ -31,7 +28,7 @@ export default class LogLevelCommand implements GlobalModifierCommand {
     this.executePriority = executePriority;
   }
 
-  public execute(_context: Context, argumentValue: ArgumentSingleValueType): Promise<void> {
+  public execute(_context: Context, argumentValue: SingleValueType): Promise<void> {
     const logLevel = argumentValue as string;
 
     switch (logLevel.toUpperCase()) {

package/src/service/printer/command/NoColorCommand.ts

@@ -1,9 +1,6 @@
 import type { GlobalModifierCommand } from "@flowscripter/dynamic-cli-framework-api";
 import type { GlobalCommandArgument } from "@flowscripter/dynamic-cli-framework-api";
-import {
-  type ArgumentSingleValueType,
-  ArgumentValueTypeName,
-} from "@flowscripter/dynamic-cli-framework-api";
+import { type SingleValueType, ValueTypeName } from "@flowscripter/dynamic-cli-framework-api";
 import type { Context } from "@flowscripter/dynamic-cli-framework-api";
 import type PrinterServiceProvider from "../PrinterServiceProvider.ts";
 
@@ -15,7 +12,7 @@ export default class NoColorCommand implements GlobalModifierCommand {
   readonly description = "Disable color for output";
   readonly enableConfiguration = true;
   readonly argument: GlobalCommandArgument = {
-    type: ArgumentValueTypeName.BOOLEAN,
+    type: ValueTypeName.BOOLEAN,
     defaultValue: false,
     configurationKey: "NO_COLOR",
   };
@@ -28,7 +25,7 @@ export default class NoColorCommand implements GlobalModifierCommand {
     this.executePriority = executePriority;
   }
 
-  public execute(_context: Context, argumentValue: ArgumentSingleValueType): Promise<void> {
+  public execute(_context: Context, argumentValue: SingleValueType): Promise<void> {
     this.#printerServiceProvider.printerService!.colorEnabled = !argumentValue as boolean;
 
     return Promise.resolve();

package/src/service/printer/command/NoHyperlinksCommand.ts

@@ -1,9 +1,6 @@
 import type { GlobalModifierCommand } from "@flowscripter/dynamic-cli-framework-api";
 import type { GlobalCommandArgument } from "@flowscripter/dynamic-cli-framework-api";
-import {
-  type ArgumentSingleValueType,
-  ArgumentValueTypeName,
-} from "@flowscripter/dynamic-cli-framework-api";
+import { type SingleValueType, ValueTypeName } from "@flowscripter/dynamic-cli-framework-api";
 import type { Context } from "@flowscripter/dynamic-cli-framework-api";
 import type PrinterServiceProvider from "../PrinterServiceProvider.ts";
 
@@ -12,7 +9,7 @@ export default class NoHyperlinksCommand implements GlobalModifierCommand {
   readonly description = "Disable hyperlinks for output";
   readonly enableConfiguration = true;
   readonly argument: GlobalCommandArgument = {
-    type: ArgumentValueTypeName.BOOLEAN,
+    type: ValueTypeName.BOOLEAN,
     defaultValue: false,
     configurationKey: "NO_HYPERLINKS",
   };
@@ -25,7 +22,7 @@ export default class NoHyperlinksCommand implements GlobalModifierCommand {
     this.executePriority = executePriority;
   }
 
-  public execute(_context: Context, argumentValue: ArgumentSingleValueType): Promise<void> {
+  public execute(_context: Context, argumentValue: SingleValueType): Promise<void> {
     this.#printerServiceProvider.printerService!.hyperlinksEnabled = !argumentValue as boolean;
 
     return Promise.resolve();

package/src/service/prompter/command/NoPromptCommand.ts

@@ -1,9 +1,6 @@
 import type { GlobalModifierCommand } from "@flowscripter/dynamic-cli-framework-api";
 import type { GlobalCommandArgument } from "@flowscripter/dynamic-cli-framework-api";
-import {
-  type ArgumentSingleValueType,
-  ArgumentValueTypeName,
-} from "@flowscripter/dynamic-cli-framework-api";
+import { type SingleValueType, ValueTypeName } from "@flowscripter/dynamic-cli-framework-api";
 import type { Context } from "@flowscripter/dynamic-cli-framework-api";
 import type PrompterServiceProvider from "../PrompterServiceProvider.ts";
 
@@ -12,7 +9,7 @@ export default class NoPromptCommand implements GlobalModifierCommand {
   readonly description = "Disable interactive prompting";
   readonly enableConfiguration = true;
   readonly argument: GlobalCommandArgument = {
-    type: ArgumentValueTypeName.BOOLEAN,
+    type: ValueTypeName.BOOLEAN,
     defaultValue: false,
     configurationKey: "NO_PROMPT",
   };
@@ -25,7 +22,7 @@ export default class NoPromptCommand implements GlobalModifierCommand {
     this.executePriority = executePriority;
   }
 
-  public execute(_context: Context, argumentValue: ArgumentSingleValueType): Promise<void> {
+  public execute(_context: Context, argumentValue: SingleValueType): Promise<void> {
     this.#prompterServiceProvider.prompterService.promptEnabled = !(argumentValue as boolean);
 
     return Promise.resolve();

package/src/service/prompter/prompt/promptText.ts

@@ -1,5 +1,5 @@
 import type { Prompt, PromptResult } from "@flowscripter/dynamic-cli-framework-api";
-import type { ArgumentSingleValueType } from "@flowscripter/dynamic-cli-framework-api";
+import type { SingleValueType } from "@flowscripter/dynamic-cli-framework-api";
 import { SpecialKey } from "../../../terminal/KeyReader.ts";
 import ShutdownServiceProvider from "../../shutdown/ShutdownServiceProvider.ts";
 import { renderPromptHeader } from "./PromptContext.ts";
@@ -52,7 +52,7 @@ export default async function promptText(
         continue;
       }
 
-      const value: ArgumentSingleValueType = buffer;
+      const value: SingleValueType = buffer;
 
       const validationOption = promptDef.options.length > 0 ? promptDef.options[0] : undefined;
       if (validationOption?.validate) {

package/src/service/spawn/DefaultSpawnService.ts

@@ -95,10 +95,10 @@ export default class DefaultSpawnService implements SpawnService {
     }
     const printerService = this.#printerService;
     const shutdownService = this.#shutdownService;
-    const stdio = options.stdio ?? "inherit";
+    const mode = options.mode ?? "inherit";
     const longRunning = options.longRunning ?? true;
 
-    if (stdio === "inherit") {
+    if (mode === "inherit") {
       await printerService.hideSpinner();
       await printerService.hideAllProgressBars();
     }
@@ -107,9 +107,9 @@ export default class DefaultSpawnService implements SpawnService {
     try {
       proc = Bun.spawn(resolveForPlatform(command), {
         cwd: options.cwd,
-        stdin: stdio === "wrapped" ? "ignore" : "inherit",
-        stdout: stdio === "wrapped" ? "pipe" : "inherit",
-        stderr: stdio === "wrapped" ? "pipe" : "inherit",
+        stdin: mode === "inherit" ? "inherit" : "ignore",
+        stdout: mode === "wrapped" ? "pipe" : mode === "ignore" ? "ignore" : "inherit",
+        stderr: mode === "wrapped" ? "pipe" : mode === "ignore" ? "ignore" : "inherit",
       });
     } catch (error) {
       logger.debug(() => `Failed to launch command '${command.join(" ")}': ${error}`);
@@ -129,7 +129,7 @@ export default class DefaultSpawnService implements SpawnService {
       await this.#terminate(proc, command);
     });
 
-    if (stdio === "wrapped" && options.onOutput) {
+    if (mode === "wrapped" && options.onOutput) {
       const onOutput = options.onOutput;
       void this.#pipeLines(proc.stdout, "stdout", onOutput);
       void this.#pipeLines(proc.stderr, "stderr", onOutput);