ogi-addon 1.9.5 → 2.0.0

package/src/config/ConfigurationBuilder.ts

@@ -1,7 +1,7 @@
 import z, { ZodError } from 'zod';
 
 export interface ConfigurationFile {
-  [key: string]: ConfigurationOption;
+  [key: string]: ConfigurationOption<string>;
 }
 
 const configValidation = z.object({
@@ -10,61 +10,98 @@ const configValidation = z.object({
   description: z.string().min(1),
 });
 
-export function isStringOption(
-  option: ConfigurationOption
-): option is StringOption {
+export function isStringOption<N extends string = string>(
+  option: ConfigurationOption<N>
+): option is StringOption<N> {
   return option.type === 'string';
 }
 
-export function isNumberOption(
-  option: ConfigurationOption
-): option is NumberOption {
+export function isNumberOption<N extends string = string>(
+  option: ConfigurationOption<N>
+): option is NumberOption<N> {
   return option.type === 'number';
 }
 
-export function isBooleanOption(
-  option: ConfigurationOption
-): option is BooleanOption {
+export function isBooleanOption<N extends string = string>(
+  option: ConfigurationOption<N>
+): option is BooleanOption<N> {
   return option.type === 'boolean';
 }
 
-export class ConfigurationBuilder {
-  private options: ConfigurationOption[] = [];
+export function isActionOption<N extends string = string>(
+  option: ConfigurationOption<N>
+): option is ActionOption<N> {
+  return option.type === 'action';
+}
+
+/**
+ * A builder for creating configuration screens. The generic type T accumulates
+ * the types of all options added to the builder, enabling type-safe access to
+ * the configuration values.
+ * 
+ * @template T - The accumulated type of all configuration options
+ */
+export class ConfigurationBuilder<
+  T extends Record<string, string | number | boolean> = {}
+> {
+  private options: ConfigurationOption<string>[] = [];
 
   /**
    * Add a number option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.
-   * @param option { (option: NumberOption) => NumberOption }
-   * @returns
+   * @param option { (option: NumberOption) => NumberOption<K> }
+   * @returns A new ConfigurationBuilder with the number option's type added
    */
-  public addNumberOption(
-    option: (option: NumberOption) => NumberOption
-  ): ConfigurationBuilder {
+  public addNumberOption<K extends string>(
+    option: (option: NumberOption) => NumberOption<K>
+  ): ConfigurationBuilder<T & { [P in K]: number }> {
     let newOption = new NumberOption();
-    newOption = option(newOption);
-    this.options.push(newOption);
-    return this;
+    const configuredOption = option(newOption);
+    this.options.push(configuredOption);
+    return this as unknown as ConfigurationBuilder<T & { [P in K]: number }>;
   }
 
   /**
    * Add a string option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.
-   * @param option { (option: StringOption) => StringOption }
+   * @param option { (option: StringOption) => StringOption<K> }
+   * @returns A new ConfigurationBuilder with the string option's type added
    */
-  public addStringOption(option: (option: StringOption) => StringOption) {
+  public addStringOption<K extends string>(
+    option: (option: StringOption) => StringOption<K>
+  ): ConfigurationBuilder<T & { [P in K]: string }> {
     let newOption = new StringOption();
-    newOption = option(newOption);
-    this.options.push(newOption);
-    return this;
+    const configuredOption = option(newOption);
+    this.options.push(configuredOption);
+    return this as unknown as ConfigurationBuilder<T & { [P in K]: string }>;
   }
 
   /**
    * Add a boolean option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.
-   * @param option { (option: BooleanOption) => BooleanOption }
+   * @param option { (option: BooleanOption) => BooleanOption<K> }
+   * @returns A new ConfigurationBuilder with the boolean option's type added
    */
-  public addBooleanOption(option: (option: BooleanOption) => BooleanOption) {
+  public addBooleanOption<K extends string>(
+    option: (option: BooleanOption) => BooleanOption<K>
+  ): ConfigurationBuilder<T & { [P in K]: boolean }> {
     let newOption = new BooleanOption();
-    newOption = option(newOption);
-    this.options.push(newOption);
-    return this;
+    const configuredOption = option(newOption);
+    this.options.push(configuredOption);
+    return this as unknown as ConfigurationBuilder<T & { [P in K]: boolean }>;
+  }
+
+  /**
+   * Add an action option to the configuration builder and return the builder for chaining. 
+   * Action options contribute a boolean to the return type (true if clicked, false if not).
+   * You must provide a name, display name, and description for the option.
+   * @param option { (option: ActionOption) => ActionOption<K> }
+   * @returns A new ConfigurationBuilder with the action option's type added as boolean
+   */
+  public addActionOption<K extends string>(
+    option: (option: ActionOption) => ActionOption<K>
+  ): ConfigurationBuilder<T & { [P in K]: boolean }> {
+    let newOption = new ActionOption();
+    const configuredOption = option(newOption);
+    this.options.push(configuredOption);
+    return this as unknown as ConfigurationBuilder<T & { [P in K]: boolean }>;
   }
 
   public build(includeFunctions: boolean): ConfigurationFile {
@@ -87,9 +124,14 @@ export class ConfigurationBuilder {
   }
 }
 
-export type ConfigurationOptionType = 'string' | 'number' | 'boolean' | 'unset';
-export class ConfigurationOption {
-  public name: string = '';
+export type ConfigurationOptionType =
+  | 'string'
+  | 'number'
+  | 'boolean'
+  | 'action'
+  | 'unset';
+export class ConfigurationOption<N extends string = string> {
+  public name: N = '' as N;
   public defaultValue: unknown = '';
   public displayName: string = '';
   public description: string = '';
@@ -99,9 +141,9 @@ export class ConfigurationOption {
    * Set the name of the option. **REQUIRED**
    * @param name {string} The name of the option. This is used to reference the option in the configuration file.
    */
-  setName(name: string) {
-    this.name = name;
-    return this;
+  setName<K extends string>(name: K): ConfigurationOption<K> {
+    this.name = name as unknown as N;
+    return this as unknown as ConfigurationOption<K>;
   }
 
   /**
@@ -109,7 +151,7 @@ export class ConfigurationOption {
    * @param displayName {string} The display name of the option.
    * @returns
    */
-  setDisplayName(displayName: string) {
+  setDisplayName(displayName: string): this {
     this.displayName = displayName;
     return this;
   }
@@ -119,7 +161,7 @@ export class ConfigurationOption {
    * @param description {string} The description of the option.
    * @returns
    */
-  setDescription(description: string) {
+  setDescription(description: string): this {
     this.description = description;
     return this;
   }
@@ -133,7 +175,7 @@ export class ConfigurationOption {
   }
 }
 
-export class StringOption extends ConfigurationOption {
+export class StringOption<N extends string = string> extends ConfigurationOption<N> {
   public allowedValues: string[] = [];
   public minTextLength: number = 0;
   public maxTextLength: number = Number.MAX_SAFE_INTEGER;
@@ -141,6 +183,15 @@ export class StringOption extends ConfigurationOption {
   public inputType: 'text' | 'file' | 'password' | 'folder' = 'text';
   public type: ConfigurationOptionType = 'string';
 
+  /**
+   * Set the name of the option. **REQUIRED**
+   * @param name {string} The name of the option. This is used to reference the option in the configuration file.
+   */
+  override setName<K extends string>(name: K): StringOption<K> {
+    this.name = name as unknown as N;
+    return this as unknown as StringOption<K>;
+  }
+
   /**
    * Set the allowed values for the string. If the array is empty, any value is allowed. When provided, the client will act like this option is a dropdown.
    * @param allowedValues {string[]} An array of allowed values for the string. If the array is empty, any value is allowed.
@@ -215,13 +266,22 @@ export class StringOption extends ConfigurationOption {
   }
 }
 
-export class NumberOption extends ConfigurationOption {
+export class NumberOption<N extends string = string> extends ConfigurationOption<N> {
   public min: number = 0;
   public max: number = Number.MAX_SAFE_INTEGER;
   public defaultValue: number = 0;
   public type: ConfigurationOptionType = 'number';
   public inputType: 'range' | 'number' = 'number';
 
+  /**
+   * Set the name of the option. **REQUIRED**
+   * @param name {string} The name of the option. This is used to reference the option in the configuration file.
+   */
+  override setName<K extends string>(name: K): NumberOption<K> {
+    this.name = name as unknown as N;
+    return this as unknown as NumberOption<K>;
+  }
+
   /**
    * Set the minimum value for the number. If the user provides a number that is less than this value, the validation will fail.
    * @param min {number} The minimum value for the number.
@@ -272,10 +332,19 @@ export class NumberOption extends ConfigurationOption {
   }
 }
 
-export class BooleanOption extends ConfigurationOption {
+export class BooleanOption<N extends string = string> extends ConfigurationOption<N> {
   public type: ConfigurationOptionType = 'boolean';
   public defaultValue: boolean = false;
 
+  /**
+   * Set the name of the option. **REQUIRED**
+   * @param name {string} The name of the option. This is used to reference the option in the configuration file.
+   */
+  override setName<K extends string>(name: K): BooleanOption<K> {
+    this.name = name as unknown as N;
+    return this as unknown as BooleanOption<K>;
+  }
+
   /**
    * Set the default value for the boolean. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**
    * @param defaultValue {boolean} The default value for the boolean.
@@ -292,3 +361,50 @@ export class BooleanOption extends ConfigurationOption {
     return [true, ''];
   }
 }
+
+export class ActionOption<N extends string = string> extends ConfigurationOption<N> {
+  public type: ConfigurationOptionType = 'action';
+  public manifest: Record<string, unknown> = {};
+  public buttonText: string = 'Run';
+  public taskName: string = '';
+
+  /**
+   * Set the name of the option. **REQUIRED**
+   * @param name {string} The name of the option. This is used to reference the option in the configuration file.
+   */
+  override setName<K extends string>(name: K): ActionOption<K> {
+    this.name = name as unknown as N;
+    return this as unknown as ActionOption<K>;
+  }
+
+  /**
+   * Set the task name that will be used to identify which task handler to run. This should match the name used in `addon.onTask()`.
+   * @param taskName {string} The task name to identify the handler.
+   */
+  setTaskName(taskName: string): this {
+    this.taskName = taskName;
+    return this;
+  }
+
+  /**
+   * Set the manifest object that will be passed to the task-run handler. The task name should be set via setTaskName() rather than in the manifest.
+   * @param manifest {Record<string, unknown>} The manifest object to pass to the task handler.
+   */
+  setManifest(manifest: Record<string, unknown>): this {
+    this.manifest = manifest;
+    return this;
+  }
+
+  /**
+   * Set the text displayed on the action button.
+   * @param text {string} The button text.
+   */
+  setButtonText(text: string): this {
+    this.buttonText = text;
+    return this;
+  }
+
+  override validate(_input: unknown): [boolean, string] {
+    return [true, ''];
+  }
+}

package/src/main.ts

@@ -1,8 +1,6 @@
 import ws, { WebSocket } from 'ws';
 import events from 'node:events';
-import {
-  ConfigurationBuilder,
-} from './config/ConfigurationBuilder';
+import { ConfigurationBuilder } from './config/ConfigurationBuilder';
 import type { ConfigurationFile } from './config/ConfigurationBuilder';
 import { Configuration } from './config/Configuration';
 import EventResponse from './EventResponse';
@@ -20,7 +18,6 @@ export type OGIAddonEvent =
   | 'game-details'
   | 'exit'
   | 'check-for-updates'
-  | 'task-run'
   | 'request-dl'
   | 'catalog';
 
@@ -73,7 +70,9 @@ export interface ClientSentEventTypes {
     progress: number;
   };
   notification: Notification;
-  'input-asked': ConfigurationBuilder;
+  'input-asked': ConfigurationBuilder<
+    Record<string, string | number | boolean>
+  >;
   'task-update': {
     id: string;
     progress: number;
@@ -214,21 +213,6 @@ export interface EventListenerTypes {
     event: EventResponse<BasicLibraryInfo[]>
   ) => void;
 
-  /**
-   * This event is emitted when the client requests for a task to be run. Addon should resolve the event with the task.
-   * @param task
-   * @param event
-   * @returns
-   */
-  'task-run': (
-    task: {
-      manifest: Record<string, unknown>;
-      downloadPath: string;
-      name: string;
-    },
-    event: EventResponse<void>
-  ) => void;
-
   /**
    * This event is emitted when the client requests for a game details to be fetched. Addon should resolve the event with the game details. This is used to generate a store page for the game.
    * @param appID
@@ -360,6 +344,17 @@ export default class OGIAddon {
   public config: Configuration = new Configuration({});
   private eventsAvailable: OGIAddonEvent[] = [];
   private registeredConnectEvent: boolean = false;
+  private taskHandlers: Map<
+    string,
+    (
+      task: Task,
+      data: {
+        manifest: Record<string, unknown>;
+        downloadPath: string;
+        name: string;
+      }
+    ) => Promise<void> | void
+  > = new Map();
 
   constructor(addonInfo: OGIAddonConfiguration) {
     this.addonInfo = addonInfo;
@@ -451,6 +446,62 @@ export default class OGIAddon {
     return task;
   }
 
+  /**
+   * Register a task handler for a specific task name. The task name should match the taskName field in SearchResult or ActionOption.
+   * @param taskName {string} The name of the task (should match taskName in SearchResult or ActionOption.setTaskName()).
+   * @param handler {(task: Task, data: { manifest: Record<string, unknown>; downloadPath: string; name: string }) => Promise<void> | void} The handler function.
+   * @example
+   * ```typescript
+   * addon.onTask('clearCache', async (task) => {
+   *   task.log('Clearing cache...');
+   *   task.setProgress(50);
+   *   await clearCacheFiles();
+   *   task.setProgress(100);
+   *   task.complete();
+   * });
+   * ```
+   */
+  public onTask(
+    taskName: string,
+    handler: (
+      task: Task,
+      data: {
+        manifest: Record<string, unknown>;
+        downloadPath: string;
+        name: string;
+      }
+    ) => Promise<void> | void
+  ): void {
+    this.taskHandlers.set(taskName, handler);
+  }
+
+  /**
+   * Check if a task handler is registered for the given task name.
+   * @param taskName {string} The task name to check.
+   * @returns {boolean} True if a handler is registered.
+   */
+  public hasTaskHandler(taskName: string): boolean {
+    return this.taskHandlers.has(taskName);
+  }
+
+  /**
+   * Get a task handler for the given task name.
+   * @param taskName {string} The task name.
+   * @returns The handler function or undefined if not found.
+   */
+  public getTaskHandler(taskName: string):
+    | ((
+        task: Task,
+        data: {
+          manifest: Record<string, unknown>;
+          downloadPath: string;
+          name: string;
+        }
+      ) => Promise<void> | void)
+    | undefined {
+    return this.taskHandlers.get(taskName);
+  }
+
   /**
    * Extract a file using 7-Zip on Windows, unzip on Linux/Mac.
    * @param path {string}
@@ -613,6 +664,68 @@ export class CustomTask {
     });
   }
 }
+
+/**
+ * A cleaner API wrapper around EventResponse for task handlers.
+ * Provides chainable methods for logging, progress updates, and completion.
+ */
+export class Task {
+  private event: EventResponse<void>;
+
+  constructor(event: EventResponse<void>) {
+    this.event = event;
+    this.event.defer();
+  }
+
+  /**
+   * Log a message to the task. Returns this for chaining.
+   * @param message {string} The message to log.
+   */
+  log(message: string): this {
+    this.event.log(message);
+    return this;
+  }
+
+  /**
+   * Set the progress of the task (0-100). Returns this for chaining.
+   * @param progress {number} The progress value (0-100).
+   */
+  setProgress(progress: number): this {
+    this.event.progress = progress;
+    return this;
+  }
+
+  /**
+   * Complete the task successfully.
+   */
+  complete(): void {
+    this.event.complete();
+  }
+
+  /**
+   * Fail the task with an error message.
+   * @param message {string} The error message.
+   */
+  fail(message: string): void {
+    this.event.fail(message);
+  }
+
+  /**
+   * Ask the user for input using a ConfigurationBuilder screen.
+   * The return type is inferred from the ConfigurationBuilder's accumulated option types.
+   * @param name {string} The name/title of the input prompt.
+   * @param description {string} The description of what input is needed.
+   * @param screen {ConfigurationBuilder<U>} The configuration builder for the input form.
+   * @returns {Promise<U>} The user's input with types matching the configuration options.
+   */
+  async askForInput<U extends Record<string, string | number | boolean>>(
+    name: string,
+    description: string,
+    screen: ConfigurationBuilder<U>
+  ): Promise<U> {
+    return this.event.askForInput(name, description, screen);
+  }
+}
 /**
  * A search tool wrapper over Fuse.js for the OGI Addon. This tool is used to search for items in the library.
  * @example
@@ -762,16 +875,18 @@ class OGIAddonWSListener {
     this.registerMessageReceiver();
   }
 
-  private async userInputAsked(
-    configBuilt: ConfigurationBuilder,
+  private async userInputAsked<
+    U extends Record<string, string | number | boolean>,
+  >(
+    configBuilt: ConfigurationBuilder<U>,
     name: string,
     description: string,
     socket: WebSocket
-  ): Promise<{ [key: string]: number | boolean | string }> {
+  ): Promise<U> {
     const config = configBuilt.build(false);
     const id = Math.random().toString(36).substring(7);
     if (!socket) {
-      return {};
+      throw new Error('Socket is not connected');
     }
     socket.send(
       JSON.stringify({
@@ -784,7 +899,7 @@ class OGIAddonWSListener {
         id: id,
       })
     );
-    return await this.waitForResponseFromServer(id);
+    return await this.waitForResponseFromServer<U>(id);
   }
 
   private registerMessageReceiver() {
@@ -971,19 +1086,62 @@ class OGIAddonWSListener {
             (screen, name, description) =>
               this.userInputAsked(screen, name, description, this.socket)
           );
-          this.eventEmitter.emit('task-run', message.args, taskRunEvent);
-          const interval = setInterval(() => {
-            if (taskRunEvent.resolved) {
+
+          // Check for taskName: first from args directly (from SearchResult), then from manifest.__taskName (for ActionOption)
+          const taskName =
+            message.args.taskName && typeof message.args.taskName === 'string'
+              ? message.args.taskName
+              : message.args.manifest &&
+                  typeof message.args.manifest === 'object'
+                ? (message.args.manifest as Record<string, unknown>).__taskName
+                : undefined;
+
+          if (
+            taskName &&
+            typeof taskName === 'string' &&
+            this.addon.hasTaskHandler(taskName)
+          ) {
+            // Use the registered task handler
+            const handler = this.addon.getTaskHandler(taskName)!;
+            const task = new Task(taskRunEvent);
+            try {
+              const interval = setInterval(() => {
+                if (taskRunEvent.resolved) {
+                  clearInterval(interval);
+                  return;
+                }
+                this.send('defer-update', {
+                  logs: taskRunEvent.logs,
+                  deferID: message.args.deferID,
+                  progress: taskRunEvent.progress,
+                  failed: taskRunEvent.failed,
+                } as ClientSentEventTypes['defer-update']);
+              }, 100);
+              const result = handler(task, {
+                manifest: message.args.manifest || {},
+                downloadPath: message.args.downloadPath || '',
+                name: message.args.name || '',
+              });
+              // If handler returns a promise, wait for it
+              if (result instanceof Promise) {
+                await result;
+              }
+
               clearInterval(interval);
-              return;
+            } catch (error) {
+              taskRunEvent.fail(
+                error instanceof Error ? error.message : String(error)
+              );
             }
-            this.send('defer-update', {
-              logs: taskRunEvent.logs,
-              deferID: message.args.deferID,
-              progress: taskRunEvent.progress,
-              failed: taskRunEvent.failed,
-            } as ClientSentEventTypes['defer-update']);
-          }, 100);
+          } else {
+            // No handler found - fail the task
+            taskRunEvent.fail(
+              taskName
+                ? `No task handler registered for task name: ${taskName}`
+                : 'No task name provided'
+            );
+          }
+
           const taskRunResult = await this.waitForEventToRespond(taskRunEvent);
           this.respondToMessage(message.id!!, taskRunResult.data, taskRunEvent);
           break;

package/build/ConfigurationBuilder-BSuJ4rSI.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"ConfigurationBuilder-BSuJ4rSI.cjs","names":["z","ZodError"],"sources":["../src/config/ConfigurationBuilder.ts"],"sourcesContent":["import z, { ZodError } from 'zod';\n\nexport interface ConfigurationFile {\n  [key: string]: ConfigurationOption;\n}\n\nconst configValidation = z.object({\n  name: z.string().min(1),\n  displayName: z.string().min(1),\n  description: z.string().min(1),\n});\n\nexport function isStringOption(\n  option: ConfigurationOption\n): option is StringOption {\n  return option.type === 'string';\n}\n\nexport function isNumberOption(\n  option: ConfigurationOption\n): option is NumberOption {\n  return option.type === 'number';\n}\n\nexport function isBooleanOption(\n  option: ConfigurationOption\n): option is BooleanOption {\n  return option.type === 'boolean';\n}\n\nexport class ConfigurationBuilder {\n  private options: ConfigurationOption[] = [];\n\n  /**\n   * Add a number option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.\n   * @param option { (option: NumberOption) => NumberOption }\n   * @returns\n   */\n  public addNumberOption(\n    option: (option: NumberOption) => NumberOption\n  ): ConfigurationBuilder {\n    let newOption = new NumberOption();\n    newOption = option(newOption);\n    this.options.push(newOption);\n    return this;\n  }\n\n  /**\n   * Add a string option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.\n   * @param option { (option: StringOption) => StringOption }\n   */\n  public addStringOption(option: (option: StringOption) => StringOption) {\n    let newOption = new StringOption();\n    newOption = option(newOption);\n    this.options.push(newOption);\n    return this;\n  }\n\n  /**\n   * Add a boolean option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.\n   * @param option { (option: BooleanOption) => BooleanOption }\n   */\n  public addBooleanOption(option: (option: BooleanOption) => BooleanOption) {\n    let newOption = new BooleanOption();\n    newOption = option(newOption);\n    this.options.push(newOption);\n    return this;\n  }\n\n  public build(includeFunctions: boolean): ConfigurationFile {\n    let config: ConfigurationFile = {};\n    this.options.forEach((option) => {\n      // remove all functions from the option object\n      if (!includeFunctions) {\n        option = JSON.parse(JSON.stringify(option));\n        const optionData = configValidation.safeParse(option);\n        if (!optionData.success) {\n          throw new ZodError(optionData.error.errors);\n        }\n\n        config[option.name] = option;\n      } else {\n        config[option.name] = option;\n      }\n    });\n    return config;\n  }\n}\n\nexport type ConfigurationOptionType = 'string' | 'number' | 'boolean' | 'unset';\nexport class ConfigurationOption {\n  public name: string = '';\n  public defaultValue: unknown = '';\n  public displayName: string = '';\n  public description: string = '';\n  public type: ConfigurationOptionType = 'unset';\n\n  /**\n   * Set the name of the option. **REQUIRED**\n   * @param name {string} The name of the option. This is used to reference the option in the configuration file.\n   */\n  setName(name: string) {\n    this.name = name;\n    return this;\n  }\n\n  /**\n   * Set the display name of the option. This is used to show the user a human readable version of what the option is. **REQUIRED**\n   * @param displayName {string} The display name of the option.\n   * @returns\n   */\n  setDisplayName(displayName: string) {\n    this.displayName = displayName;\n    return this;\n  }\n\n  /**\n   * Set the description of the option. This is to show the user a brief description of what this option does. **REQUIRED**\n   * @param description {string} The description of the option.\n   * @returns\n   */\n  setDescription(description: string) {\n    this.description = description;\n    return this;\n  }\n\n  /**\n   * Validation code for the option. This is called when the user provides input to the option. If the validation fails, the user will be prompted to provide input again.\n   * @param input {unknown} The input to validate\n   */\n  validate(input: unknown): [boolean, string] {\n    throw new Error('Validation code not implemented. Value: ' + input);\n  }\n}\n\nexport class StringOption extends ConfigurationOption {\n  public allowedValues: string[] = [];\n  public minTextLength: number = 0;\n  public maxTextLength: number = Number.MAX_SAFE_INTEGER;\n  public defaultValue: string = '';\n  public inputType: 'text' | 'file' | 'password' | 'folder' = 'text';\n  public type: ConfigurationOptionType = 'string';\n\n  /**\n   * Set the allowed values for the string. If the array is empty, any value is allowed. When provided, the client will act like this option is a dropdown.\n   * @param allowedValues {string[]} An array of allowed values for the string. If the array is empty, any value is allowed.\n   */\n  setAllowedValues(allowedValues: string[]): this {\n    this.allowedValues = allowedValues;\n    return this;\n  }\n\n  /**\n   * Set the default value for the string. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**\n   * @param defaultValue {string} The default value for the string.\n   */\n  setDefaultValue(defaultValue: string): this {\n    this.defaultValue = defaultValue;\n    return this;\n  }\n\n  /**\n   * Set the minimum text length for the string. If the user provides a string that is less than this value, the validation will fail.\n   * @param minTextLength {number} The minimum text length for the string.\n   */\n  setMinTextLength(minTextLength: number): this {\n    this.minTextLength = minTextLength;\n    return this;\n  }\n\n  /**\n   * Set the maximum text length for the string. If the user provides a string that is greater than this value, the validation will fail.\n   * @param maxTextLength {number} The maximum text length for the string.\n   */\n  setMaxTextLength(maxTextLength: number): this {\n    this.maxTextLength = maxTextLength;\n    return this;\n  }\n\n  /**\n   * Set the input type for the string. This will change how the client renders the input.\n   * @param inputType {'text' | 'file' | 'password' | 'folder'} The input type for the string.\n   */\n  setInputType(inputType: 'text' | 'file' | 'password' | 'folder'): this {\n    this.inputType = inputType;\n    return this;\n  }\n\n  override validate(input: unknown): [boolean, string] {\n    if (typeof input !== 'string') {\n      return [false, 'Input is not a string'];\n    }\n    if (this.allowedValues.length === 0 && input.length !== 0)\n      return [true, ''];\n    if (\n      input.length < this.minTextLength ||\n      input.length > this.maxTextLength\n    ) {\n      return [\n        false,\n        'Input is not within the text length ' +\n          this.minTextLength +\n          ' and ' +\n          this.maxTextLength +\n          ' characters (currently ' +\n          input.length +\n          ' characters)',\n      ];\n    }\n\n    return [\n      this.allowedValues.includes(input),\n      'Input is not an allowed value',\n    ];\n  }\n}\n\nexport class NumberOption extends ConfigurationOption {\n  public min: number = 0;\n  public max: number = Number.MAX_SAFE_INTEGER;\n  public defaultValue: number = 0;\n  public type: ConfigurationOptionType = 'number';\n  public inputType: 'range' | 'number' = 'number';\n\n  /**\n   * Set the minimum value for the number. If the user provides a number that is less than this value, the validation will fail.\n   * @param min {number} The minimum value for the number.\n   */\n  setMin(min: number): this {\n    this.min = min;\n    return this;\n  }\n\n  /**\n   * Set the input type for the number. This will change how the client renders the input.\n   * @param type {'range' | 'number'} The input type for the number.\n   */\n  setInputType(type: 'range' | 'number'): this {\n    this.inputType = type;\n    return this;\n  }\n\n  /**\n   * Set the maximum value for the number. If the user provides a number that is greater than this value, the validation will fail.\n   * @param max {number} The maximum value for the number.\n   */\n  setMax(max: number): this {\n    this.max = max;\n    return this;\n  }\n\n  /**\n   * Set the default value for the number. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**\n   * @param defaultValue {number} The default value for the number.\n   */\n  setDefaultValue(defaultValue: number): this {\n    this.defaultValue = defaultValue;\n    return this;\n  }\n\n  override validate(input: unknown): [boolean, string] {\n    if (isNaN(Number(input))) {\n      return [false, 'Input is not a number'];\n    }\n    if (Number(input) < this.min || Number(input) > this.max) {\n      return [\n        false,\n        'Input is not within the range of ' + this.min + ' and ' + this.max,\n      ];\n    }\n    return [true, ''];\n  }\n}\n\nexport class BooleanOption extends ConfigurationOption {\n  public type: ConfigurationOptionType = 'boolean';\n  public defaultValue: boolean = false;\n\n  /**\n   * Set the default value for the boolean. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**\n   * @param defaultValue {boolean} The default value for the boolean.\n   */\n  setDefaultValue(defaultValue: boolean): this {\n    this.defaultValue = defaultValue;\n    return this;\n  }\n\n  override validate(input: unknown): [boolean, string] {\n    if (typeof input !== 'boolean') {\n      return [false, 'Input is not a boolean'];\n    }\n    return [true, ''];\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAMA,MAAM,mBAAmBA,YAAE,OAAO;CAChC,MAAMA,YAAE,QAAQ,CAAC,IAAI,EAAE;CACvB,aAAaA,YAAE,QAAQ,CAAC,IAAI,EAAE;CAC9B,aAAaA,YAAE,QAAQ,CAAC,IAAI,EAAE;CAC/B,CAAC;AAEF,SAAgB,eACd,QACwB;AACxB,QAAO,OAAO,SAAS;;AAGzB,SAAgB,eACd,QACwB;AACxB,QAAO,OAAO,SAAS;;AAGzB,SAAgB,gBACd,QACyB;AACzB,QAAO,OAAO,SAAS;;AAGzB,IAAa,uBAAb,MAAkC;CAChC,AAAQ,UAAiC,EAAE;;;;;;CAO3C,AAAO,gBACL,QACsB;EACtB,IAAI,YAAY,IAAI,cAAc;AAClC,cAAY,OAAO,UAAU;AAC7B,OAAK,QAAQ,KAAK,UAAU;AAC5B,SAAO;;;;;;CAOT,AAAO,gBAAgB,QAAgD;EACrE,IAAI,YAAY,IAAI,cAAc;AAClC,cAAY,OAAO,UAAU;AAC7B,OAAK,QAAQ,KAAK,UAAU;AAC5B,SAAO;;;;;;CAOT,AAAO,iBAAiB,QAAkD;EACxE,IAAI,YAAY,IAAI,eAAe;AACnC,cAAY,OAAO,UAAU;AAC7B,OAAK,QAAQ,KAAK,UAAU;AAC5B,SAAO;;CAGT,AAAO,MAAM,kBAA8C;EACzD,IAAI,SAA4B,EAAE;AAClC,OAAK,QAAQ,SAAS,WAAW;AAE/B,OAAI,CAAC,kBAAkB;AACrB,aAAS,KAAK,MAAM,KAAK,UAAU,OAAO,CAAC;IAC3C,MAAM,aAAa,iBAAiB,UAAU,OAAO;AACrD,QAAI,CAAC,WAAW,QACd,OAAM,IAAIC,aAAS,WAAW,MAAM,OAAO;AAG7C,WAAO,OAAO,QAAQ;SAEtB,QAAO,OAAO,QAAQ;IAExB;AACF,SAAO;;;AAKX,IAAa,sBAAb,MAAiC;CAC/B,AAAO,OAAe;CACtB,AAAO,eAAwB;CAC/B,AAAO,cAAsB;CAC7B,AAAO,cAAsB;CAC7B,AAAO,OAAgC;;;;;CAMvC,QAAQ,MAAc;AACpB,OAAK,OAAO;AACZ,SAAO;;;;;;;CAQT,eAAe,aAAqB;AAClC,OAAK,cAAc;AACnB,SAAO;;;;;;;CAQT,eAAe,aAAqB;AAClC,OAAK,cAAc;AACnB,SAAO;;;;;;CAOT,SAAS,OAAmC;AAC1C,QAAM,IAAI,MAAM,6CAA6C,MAAM;;;AAIvE,IAAa,eAAb,cAAkC,oBAAoB;CACpD,AAAO,gBAA0B,EAAE;CACnC,AAAO,gBAAwB;CAC/B,AAAO,gBAAwB,OAAO;CACtC,AAAO,eAAuB;CAC9B,AAAO,YAAqD;CAC5D,AAAO,OAAgC;;;;;CAMvC,iBAAiB,eAA+B;AAC9C,OAAK,gBAAgB;AACrB,SAAO;;;;;;CAOT,gBAAgB,cAA4B;AAC1C,OAAK,eAAe;AACpB,SAAO;;;;;;CAOT,iBAAiB,eAA6B;AAC5C,OAAK,gBAAgB;AACrB,SAAO;;;;;;CAOT,iBAAiB,eAA6B;AAC5C,OAAK,gBAAgB;AACrB,SAAO;;;;;;CAOT,aAAa,WAA0D;AACrE,OAAK,YAAY;AACjB,SAAO;;CAGT,AAAS,SAAS,OAAmC;AACnD,MAAI,OAAO,UAAU,SACnB,QAAO,CAAC,OAAO,wBAAwB;AAEzC,MAAI,KAAK,cAAc,WAAW,KAAK,MAAM,WAAW,EACtD,QAAO,CAAC,MAAM,GAAG;AACnB,MACE,MAAM,SAAS,KAAK,iBACpB,MAAM,SAAS,KAAK,cAEpB,QAAO,CACL,OACA,yCACE,KAAK,gBACL,UACA,KAAK,gBACL,4BACA,MAAM,SACN,eACH;AAGH,SAAO,CACL,KAAK,cAAc,SAAS,MAAM,EAClC,gCACD;;;AAIL,IAAa,eAAb,cAAkC,oBAAoB;CACpD,AAAO,MAAc;CACrB,AAAO,MAAc,OAAO;CAC5B,AAAO,eAAuB;CAC9B,AAAO,OAAgC;CACvC,AAAO,YAAgC;;;;;CAMvC,OAAO,KAAmB;AACxB,OAAK,MAAM;AACX,SAAO;;;;;;CAOT,aAAa,MAAgC;AAC3C,OAAK,YAAY;AACjB,SAAO;;;;;;CAOT,OAAO,KAAmB;AACxB,OAAK,MAAM;AACX,SAAO;;;;;;CAOT,gBAAgB,cAA4B;AAC1C,OAAK,eAAe;AACpB,SAAO;;CAGT,AAAS,SAAS,OAAmC;AACnD,MAAI,MAAM,OAAO,MAAM,CAAC,CACtB,QAAO,CAAC,OAAO,wBAAwB;AAEzC,MAAI,OAAO,MAAM,GAAG,KAAK,OAAO,OAAO,MAAM,GAAG,KAAK,IACnD,QAAO,CACL,OACA,sCAAsC,KAAK,MAAM,UAAU,KAAK,IACjE;AAEH,SAAO,CAAC,MAAM,GAAG;;;AAIrB,IAAa,gBAAb,cAAmC,oBAAoB;CACrD,AAAO,OAAgC;CACvC,AAAO,eAAwB;;;;;CAM/B,gBAAgB,cAA6B;AAC3C,OAAK,eAAe;AACpB,SAAO;;CAGT,AAAS,SAAS,OAAmC;AACnD,MAAI,OAAO,UAAU,UACnB,QAAO,CAAC,OAAO,yBAAyB;AAE1C,SAAO,CAAC,MAAM,GAAG"}