ogi-addon 1.9.4 → 2.0.0

package/build/{Configuration-CdRZbO6z.d.mts → Configuration-DdkCGFMU.d.cts}

@@ -1,4 +1,4 @@
-import { r as ConfigurationFile } from "./ConfigurationBuilder-BbZDA_xx.mjs";
+import { i as ConfigurationFile } from "./ConfigurationBuilder-C83EP5v2.cjs";
 
 //#region src/config/Configuration.d.ts
 interface DefiniteConfig {
@@ -18,4 +18,4 @@ declare class Configuration {
 }
 //#endregion
 export { Configuration as t };
-//# sourceMappingURL=Configuration-CdRZbO6z.d.mts.map
+//# sourceMappingURL=Configuration-DdkCGFMU.d.cts.map

package/build/{Configuration-WeOm-F0_.d.cts → Configuration-fDtr2bmH.d.mts}

@@ -1,4 +1,4 @@
-import { r as ConfigurationFile } from "./ConfigurationBuilder-CfHLKMTO.cjs";
+import { i as ConfigurationFile } from "./ConfigurationBuilder-lzKf9gHw.mjs";
 
 //#region src/config/Configuration.d.ts
 interface DefiniteConfig {
@@ -18,4 +18,4 @@ declare class Configuration {
 }
 //#endregion
 export { Configuration as t };
-//# sourceMappingURL=Configuration-WeOm-F0_.d.cts.map
+//# sourceMappingURL=Configuration-fDtr2bmH.d.mts.map

package/build/{ConfigurationBuilder-BbZDA_xx.d.mts → ConfigurationBuilder-C83EP5v2.d.cts}

@@ -1,33 +1,51 @@
 //#region src/config/ConfigurationBuilder.d.ts
 interface ConfigurationFile {
-  [key: string]: ConfigurationOption;
+  [key: string]: ConfigurationOption<string>;
 }
-declare function isStringOption(option: ConfigurationOption): option is StringOption;
-declare function isNumberOption(option: ConfigurationOption): option is NumberOption;
-declare function isBooleanOption(option: ConfigurationOption): option is BooleanOption;
-declare class ConfigurationBuilder {
+declare function isStringOption<N extends string = string>(option: ConfigurationOption<N>): option is StringOption<N>;
+declare function isNumberOption<N extends string = string>(option: ConfigurationOption<N>): option is NumberOption<N>;
+declare function isBooleanOption<N extends string = string>(option: ConfigurationOption<N>): option is BooleanOption<N>;
+declare function isActionOption<N extends string = string>(option: ConfigurationOption<N>): option is ActionOption<N>;
+/**
+ * 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
+ */
+declare class ConfigurationBuilder<T extends Record<string, string | number | boolean> = {}> {
   private options;
   /**
    * 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
    */
-  addNumberOption(option: (option: NumberOption) => NumberOption): ConfigurationBuilder;
+  addNumberOption<K extends string>(option: (option: NumberOption) => NumberOption<K>): 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
    */
-  addStringOption(option: (option: StringOption) => StringOption): this;
+  addStringOption<K extends string>(option: (option: StringOption) => StringOption<K>): 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
+   */
+  addBooleanOption<K extends string>(option: (option: BooleanOption) => BooleanOption<K>): 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
    */
-  addBooleanOption(option: (option: BooleanOption) => BooleanOption): this;
+  addActionOption<K extends string>(option: (option: ActionOption) => ActionOption<K>): ConfigurationBuilder<T & { [P in K]: boolean }>;
   build(includeFunctions: boolean): ConfigurationFile;
 }
-type ConfigurationOptionType = 'string' | 'number' | 'boolean' | 'unset';
-declare class ConfigurationOption {
-  name: string;
+type ConfigurationOptionType = 'string' | 'number' | 'boolean' | 'action' | 'unset';
+declare class ConfigurationOption<N extends string = string> {
+  name: N;
   defaultValue: unknown;
   displayName: string;
   description: string;
@@ -36,7 +54,7 @@ declare 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;
+  setName<K extends string>(name: K): ConfigurationOption<K>;
   /**
    * Set the display name of the option. This is used to show the user a human readable version of what the option is. **REQUIRED**
    * @param displayName {string} The display name of the option.
@@ -55,13 +73,18 @@ declare class ConfigurationOption {
    */
   validate(input: unknown): [boolean, string];
 }
-declare class StringOption extends ConfigurationOption {
+declare class StringOption<N extends string = string> extends ConfigurationOption<N> {
   allowedValues: string[];
   minTextLength: number;
   maxTextLength: number;
   defaultValue: string;
   inputType: 'text' | 'file' | 'password' | 'folder';
   type: ConfigurationOptionType;
+  /**
+   * 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<K extends string>(name: K): 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.
@@ -89,12 +112,17 @@ declare class StringOption extends ConfigurationOption {
   setInputType(inputType: 'text' | 'file' | 'password' | 'folder'): this;
   validate(input: unknown): [boolean, string];
 }
-declare class NumberOption extends ConfigurationOption {
+declare class NumberOption<N extends string = string> extends ConfigurationOption<N> {
   min: number;
   max: number;
   defaultValue: number;
   type: ConfigurationOptionType;
   inputType: 'range' | '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.
+   */
+  setName<K extends string>(name: K): 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.
@@ -117,9 +145,14 @@ declare class NumberOption extends ConfigurationOption {
   setDefaultValue(defaultValue: number): this;
   validate(input: unknown): [boolean, string];
 }
-declare class BooleanOption extends ConfigurationOption {
+declare class BooleanOption<N extends string = string> extends ConfigurationOption<N> {
   type: ConfigurationOptionType;
   defaultValue: boolean;
+  /**
+   * 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<K extends string>(name: K): 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.
@@ -127,6 +160,33 @@ declare class BooleanOption extends ConfigurationOption {
   setDefaultValue(defaultValue: boolean): this;
   validate(input: unknown): [boolean, string];
 }
+declare class ActionOption<N extends string = string> extends ConfigurationOption<N> {
+  type: ConfigurationOptionType;
+  manifest: Record<string, unknown>;
+  buttonText: string;
+  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.
+   */
+  setName<K extends string>(name: K): 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;
+  /**
+   * 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;
+  /**
+   * Set the text displayed on the action button.
+   * @param text {string} The button text.
+   */
+  setButtonText(text: string): this;
+  validate(_input: unknown): [boolean, string];
+}
 //#endregion
-export { ConfigurationOptionType as a, isBooleanOption as c, ConfigurationOption as i, isNumberOption as l, ConfigurationBuilder as n, NumberOption as o, ConfigurationFile as r, StringOption as s, BooleanOption as t, isStringOption as u };
-//# sourceMappingURL=ConfigurationBuilder-BbZDA_xx.d.mts.map
+export { ConfigurationOption as a, StringOption as c, isNumberOption as d, isStringOption as f, ConfigurationFile as i, isActionOption as l, BooleanOption as n, ConfigurationOptionType as o, ConfigurationBuilder as r, NumberOption as s, ActionOption as t, isBooleanOption as u };
+//# sourceMappingURL=ConfigurationBuilder-C83EP5v2.d.cts.map

package/build/{ConfigurationBuilder-BSuJ4rSI.cjs → ConfigurationBuilder-CFXi6UwU.cjs}

@@ -43,37 +43,58 @@ function isNumberOption(option) {
 function isBooleanOption(option) {
 	return option.type === "boolean";
 }
+function isActionOption(option) {
+	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
+*/
 var ConfigurationBuilder = class {
 	options = [];
 	/**
 	* 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
 	*/
 	addNumberOption(option) {
-		let newOption = new NumberOption();
-		newOption = option(newOption);
-		this.options.push(newOption);
+		const configuredOption = option(new NumberOption());
+		this.options.push(configuredOption);
 		return this;
 	}
 	/**
 	* 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
 	*/
 	addStringOption(option) {
-		let newOption = new StringOption();
-		newOption = option(newOption);
-		this.options.push(newOption);
+		const configuredOption = option(new StringOption());
+		this.options.push(configuredOption);
 		return this;
 	}
 	/**
 	* 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
 	*/
 	addBooleanOption(option) {
-		let newOption = new BooleanOption();
-		newOption = option(newOption);
-		this.options.push(newOption);
+		const configuredOption = option(new BooleanOption());
+		this.options.push(configuredOption);
+		return this;
+	}
+	/**
+	* 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
+	*/
+	addActionOption(option) {
+		const configuredOption = option(new ActionOption());
+		this.options.push(configuredOption);
 		return this;
 	}
 	build(includeFunctions) {
@@ -137,6 +158,14 @@ var StringOption = class extends ConfigurationOption {
 	inputType = "text";
 	type = "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.
+	*/
+	setName(name) {
+		this.name = name;
+		return this;
+	}
+	/**
 	* 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.
 	*/
@@ -190,6 +219,14 @@ var NumberOption = class extends ConfigurationOption {
 	type = "number";
 	inputType = "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.
+	*/
+	setName(name) {
+		this.name = name;
+		return this;
+	}
+	/**
 	* 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.
 	*/
@@ -231,6 +268,14 @@ var BooleanOption = class extends ConfigurationOption {
 	type = "boolean";
 	defaultValue = 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.
+	*/
+	setName(name) {
+		this.name = name;
+		return this;
+	}
+	/**
 	* 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.
 	*/
@@ -243,8 +288,55 @@ var BooleanOption = class extends ConfigurationOption {
 		return [true, ""];
 	}
 };
+var ActionOption = class extends ConfigurationOption {
+	type = "action";
+	manifest = {};
+	buttonText = "Run";
+	taskName = "";
+	/**
+	* 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) {
+		this.name = name;
+		return this;
+	}
+	/**
+	* 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) {
+		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) {
+		this.manifest = manifest;
+		return this;
+	}
+	/**
+	* Set the text displayed on the action button.
+	* @param text {string} The button text.
+	*/
+	setButtonText(text) {
+		this.buttonText = text;
+		return this;
+	}
+	validate(_input) {
+		return [true, ""];
+	}
+};
 
 //#endregion
+Object.defineProperty(exports, 'ActionOption', {
+  enumerable: true,
+  get: function () {
+    return ActionOption;
+  }
+});
 Object.defineProperty(exports, 'BooleanOption', {
   enumerable: true,
   get: function () {
@@ -281,6 +373,12 @@ Object.defineProperty(exports, '__toESM', {
     return __toESM;
   }
 });
+Object.defineProperty(exports, 'isActionOption', {
+  enumerable: true,
+  get: function () {
+    return isActionOption;
+  }
+});
 Object.defineProperty(exports, 'isBooleanOption', {
   enumerable: true,
   get: function () {
@@ -299,4 +397,4 @@ Object.defineProperty(exports, 'isStringOption', {
     return isStringOption;
   }
 });
-//# sourceMappingURL=ConfigurationBuilder-BSuJ4rSI.cjs.map
+//# sourceMappingURL=ConfigurationBuilder-CFXi6UwU.cjs.map

package/build/ConfigurationBuilder-CFXi6UwU.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigurationBuilder-CFXi6UwU.cjs","names":["z","ZodError"],"sources":["../src/config/ConfigurationBuilder.ts"],"sourcesContent":["import z, { ZodError } from 'zod';\n\nexport interface ConfigurationFile {\n  [key: string]: ConfigurationOption<string>;\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 extends string = string>(\n  option: ConfigurationOption<N>\n): option is StringOption<N> {\n  return option.type === 'string';\n}\n\nexport function isNumberOption<N extends string = string>(\n  option: ConfigurationOption<N>\n): option is NumberOption<N> {\n  return option.type === 'number';\n}\n\nexport function isBooleanOption<N extends string = string>(\n  option: ConfigurationOption<N>\n): option is BooleanOption<N> {\n  return option.type === 'boolean';\n}\n\nexport function isActionOption<N extends string = string>(\n  option: ConfigurationOption<N>\n): option is ActionOption<N> {\n  return option.type === 'action';\n}\n\n/**\n * A builder for creating configuration screens. The generic type T accumulates\n * the types of all options added to the builder, enabling type-safe access to\n * the configuration values.\n * \n * @template T - The accumulated type of all configuration options\n */\nexport class ConfigurationBuilder<\n  T extends Record<string, string | number | boolean> = {}\n> {\n  private options: ConfigurationOption<string>[] = [];\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<K> }\n   * @returns A new ConfigurationBuilder with the number option's type added\n   */\n  public addNumberOption<K extends string>(\n    option: (option: NumberOption) => NumberOption<K>\n  ): ConfigurationBuilder<T & { [P in K]: number }> {\n    let newOption = new NumberOption();\n    const configuredOption = option(newOption);\n    this.options.push(configuredOption);\n    return this as unknown as ConfigurationBuilder<T & { [P in K]: number }>;\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<K> }\n   * @returns A new ConfigurationBuilder with the string option's type added\n   */\n  public addStringOption<K extends string>(\n    option: (option: StringOption) => StringOption<K>\n  ): ConfigurationBuilder<T & { [P in K]: string }> {\n    let newOption = new StringOption();\n    const configuredOption = option(newOption);\n    this.options.push(configuredOption);\n    return this as unknown as ConfigurationBuilder<T & { [P in K]: string }>;\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<K> }\n   * @returns A new ConfigurationBuilder with the boolean option's type added\n   */\n  public addBooleanOption<K extends string>(\n    option: (option: BooleanOption) => BooleanOption<K>\n  ): ConfigurationBuilder<T & { [P in K]: boolean }> {\n    let newOption = new BooleanOption();\n    const configuredOption = option(newOption);\n    this.options.push(configuredOption);\n    return this as unknown as ConfigurationBuilder<T & { [P in K]: boolean }>;\n  }\n\n  /**\n   * Add an action option to the configuration builder and return the builder for chaining. \n   * Action options contribute a boolean to the return type (true if clicked, false if not).\n   * You must provide a name, display name, and description for the option.\n   * @param option { (option: ActionOption) => ActionOption<K> }\n   * @returns A new ConfigurationBuilder with the action option's type added as boolean\n   */\n  public addActionOption<K extends string>(\n    option: (option: ActionOption) => ActionOption<K>\n  ): ConfigurationBuilder<T & { [P in K]: boolean }> {\n    let newOption = new ActionOption();\n    const configuredOption = option(newOption);\n    this.options.push(configuredOption);\n    return this as unknown as ConfigurationBuilder<T & { [P in K]: boolean }>;\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 =\n  | 'string'\n  | 'number'\n  | 'boolean'\n  | 'action'\n  | 'unset';\nexport class ConfigurationOption<N extends string = string> {\n  public name: N = '' as N;\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<K extends string>(name: K): ConfigurationOption<K> {\n    this.name = name as unknown as N;\n    return this as unknown as ConfigurationOption<K>;\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): this {\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): this {\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<N extends string = string> extends ConfigurationOption<N> {\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 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  override setName<K extends string>(name: K): StringOption<K> {\n    this.name = name as unknown as N;\n    return this as unknown as StringOption<K>;\n  }\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<N extends string = string> extends ConfigurationOption<N> {\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 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  override setName<K extends string>(name: K): NumberOption<K> {\n    this.name = name as unknown as N;\n    return this as unknown as NumberOption<K>;\n  }\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<N extends string = string> extends ConfigurationOption<N> {\n  public type: ConfigurationOptionType = 'boolean';\n  public defaultValue: boolean = false;\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  override setName<K extends string>(name: K): BooleanOption<K> {\n    this.name = name as unknown as N;\n    return this as unknown as BooleanOption<K>;\n  }\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\nexport class ActionOption<N extends string = string> extends ConfigurationOption<N> {\n  public type: ConfigurationOptionType = 'action';\n  public manifest: Record<string, unknown> = {};\n  public buttonText: string = 'Run';\n  public taskName: string = '';\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  override setName<K extends string>(name: K): ActionOption<K> {\n    this.name = name as unknown as N;\n    return this as unknown as ActionOption<K>;\n  }\n\n  /**\n   * Set the task name that will be used to identify which task handler to run. This should match the name used in `addon.onTask()`.\n   * @param taskName {string} The task name to identify the handler.\n   */\n  setTaskName(taskName: string): this {\n    this.taskName = taskName;\n    return this;\n  }\n\n  /**\n   * 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.\n   * @param manifest {Record<string, unknown>} The manifest object to pass to the task handler.\n   */\n  setManifest(manifest: Record<string, unknown>): this {\n    this.manifest = manifest;\n    return this;\n  }\n\n  /**\n   * Set the text displayed on the action button.\n   * @param text {string} The button text.\n   */\n  setButtonText(text: string): this {\n    this.buttonText = text;\n    return this;\n  }\n\n  override validate(_input: unknown): [boolean, string] {\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,QAC2B;AAC3B,QAAO,OAAO,SAAS;;AAGzB,SAAgB,eACd,QAC2B;AAC3B,QAAO,OAAO,SAAS;;AAGzB,SAAgB,gBACd,QAC4B;AAC5B,QAAO,OAAO,SAAS;;AAGzB,SAAgB,eACd,QAC2B;AAC3B,QAAO,OAAO,SAAS;;;;;;;;;AAUzB,IAAa,uBAAb,MAEE;CACA,AAAQ,UAAyC,EAAE;;;;;;CAOnD,AAAO,gBACL,QACgD;EAEhD,MAAM,mBAAmB,OADT,IAAI,cAAc,CACQ;AAC1C,OAAK,QAAQ,KAAK,iBAAiB;AACnC,SAAO;;;;;;;CAQT,AAAO,gBACL,QACgD;EAEhD,MAAM,mBAAmB,OADT,IAAI,cAAc,CACQ;AAC1C,OAAK,QAAQ,KAAK,iBAAiB;AACnC,SAAO;;;;;;;CAQT,AAAO,iBACL,QACiD;EAEjD,MAAM,mBAAmB,OADT,IAAI,eAAe,CACO;AAC1C,OAAK,QAAQ,KAAK,iBAAiB;AACnC,SAAO;;;;;;;;;CAUT,AAAO,gBACL,QACiD;EAEjD,MAAM,mBAAmB,OADT,IAAI,cAAc,CACQ;AAC1C,OAAK,QAAQ,KAAK,iBAAiB;AACnC,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;;;AAUX,IAAa,sBAAb,MAA4D;CAC1D,AAAO,OAAU;CACjB,AAAO,eAAwB;CAC/B,AAAO,cAAsB;CAC7B,AAAO,cAAsB;CAC7B,AAAO,OAAgC;;;;;CAMvC,QAA0B,MAAiC;AACzD,OAAK,OAAO;AACZ,SAAO;;;;;;;CAQT,eAAe,aAA2B;AACxC,OAAK,cAAc;AACnB,SAAO;;;;;;;CAQT,eAAe,aAA2B;AACxC,OAAK,cAAc;AACnB,SAAO;;;;;;CAOT,SAAS,OAAmC;AAC1C,QAAM,IAAI,MAAM,6CAA6C,MAAM;;;AAIvE,IAAa,eAAb,cAA6D,oBAAuB;CAClF,AAAO,gBAA0B,EAAE;CACnC,AAAO,gBAAwB;CAC/B,AAAO,gBAAwB,OAAO;CACtC,AAAO,eAAuB;CAC9B,AAAO,YAAqD;CAC5D,AAAO,OAAgC;;;;;CAMvC,AAAS,QAA0B,MAA0B;AAC3D,OAAK,OAAO;AACZ,SAAO;;;;;;CAOT,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,cAA6D,oBAAuB;CAClF,AAAO,MAAc;CACrB,AAAO,MAAc,OAAO;CAC5B,AAAO,eAAuB;CAC9B,AAAO,OAAgC;CACvC,AAAO,YAAgC;;;;;CAMvC,AAAS,QAA0B,MAA0B;AAC3D,OAAK,OAAO;AACZ,SAAO;;;;;;CAOT,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,cAA8D,oBAAuB;CACnF,AAAO,OAAgC;CACvC,AAAO,eAAwB;;;;;CAM/B,AAAS,QAA0B,MAA2B;AAC5D,OAAK,OAAO;AACZ,SAAO;;;;;;CAOT,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;;;AAIrB,IAAa,eAAb,cAA6D,oBAAuB;CAClF,AAAO,OAAgC;CACvC,AAAO,WAAoC,EAAE;CAC7C,AAAO,aAAqB;CAC5B,AAAO,WAAmB;;;;;CAM1B,AAAS,QAA0B,MAA0B;AAC3D,OAAK,OAAO;AACZ,SAAO;;;;;;CAOT,YAAY,UAAwB;AAClC,OAAK,WAAW;AAChB,SAAO;;;;;;CAOT,YAAY,UAAyC;AACnD,OAAK,WAAW;AAChB,SAAO;;;;;;CAOT,cAAc,MAAoB;AAChC,OAAK,aAAa;AAClB,SAAO;;CAGT,AAAS,SAAS,QAAoC;AACpD,SAAO,CAAC,MAAM,GAAG"}

package/build/{ConfigurationBuilder-CfHLKMTO.d.cts → ConfigurationBuilder-lzKf9gHw.d.mts}

@@ -1,33 +1,51 @@
 //#region src/config/ConfigurationBuilder.d.ts
 interface ConfigurationFile {
-  [key: string]: ConfigurationOption;
+  [key: string]: ConfigurationOption<string>;
 }
-declare function isStringOption(option: ConfigurationOption): option is StringOption;
-declare function isNumberOption(option: ConfigurationOption): option is NumberOption;
-declare function isBooleanOption(option: ConfigurationOption): option is BooleanOption;
-declare class ConfigurationBuilder {
+declare function isStringOption<N extends string = string>(option: ConfigurationOption<N>): option is StringOption<N>;
+declare function isNumberOption<N extends string = string>(option: ConfigurationOption<N>): option is NumberOption<N>;
+declare function isBooleanOption<N extends string = string>(option: ConfigurationOption<N>): option is BooleanOption<N>;
+declare function isActionOption<N extends string = string>(option: ConfigurationOption<N>): option is ActionOption<N>;
+/**
+ * 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
+ */
+declare class ConfigurationBuilder<T extends Record<string, string | number | boolean> = {}> {
   private options;
   /**
    * 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
    */
-  addNumberOption(option: (option: NumberOption) => NumberOption): ConfigurationBuilder;
+  addNumberOption<K extends string>(option: (option: NumberOption) => NumberOption<K>): 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
    */
-  addStringOption(option: (option: StringOption) => StringOption): this;
+  addStringOption<K extends string>(option: (option: StringOption) => StringOption<K>): 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
+   */
+  addBooleanOption<K extends string>(option: (option: BooleanOption) => BooleanOption<K>): 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
    */
-  addBooleanOption(option: (option: BooleanOption) => BooleanOption): this;
+  addActionOption<K extends string>(option: (option: ActionOption) => ActionOption<K>): ConfigurationBuilder<T & { [P in K]: boolean }>;
   build(includeFunctions: boolean): ConfigurationFile;
 }
-type ConfigurationOptionType = 'string' | 'number' | 'boolean' | 'unset';
-declare class ConfigurationOption {
-  name: string;
+type ConfigurationOptionType = 'string' | 'number' | 'boolean' | 'action' | 'unset';
+declare class ConfigurationOption<N extends string = string> {
+  name: N;
   defaultValue: unknown;
   displayName: string;
   description: string;
@@ -36,7 +54,7 @@ declare 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;
+  setName<K extends string>(name: K): ConfigurationOption<K>;
   /**
    * Set the display name of the option. This is used to show the user a human readable version of what the option is. **REQUIRED**
    * @param displayName {string} The display name of the option.
@@ -55,13 +73,18 @@ declare class ConfigurationOption {
    */
   validate(input: unknown): [boolean, string];
 }
-declare class StringOption extends ConfigurationOption {
+declare class StringOption<N extends string = string> extends ConfigurationOption<N> {
   allowedValues: string[];
   minTextLength: number;
   maxTextLength: number;
   defaultValue: string;
   inputType: 'text' | 'file' | 'password' | 'folder';
   type: ConfigurationOptionType;
+  /**
+   * 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<K extends string>(name: K): 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.
@@ -89,12 +112,17 @@ declare class StringOption extends ConfigurationOption {
   setInputType(inputType: 'text' | 'file' | 'password' | 'folder'): this;
   validate(input: unknown): [boolean, string];
 }
-declare class NumberOption extends ConfigurationOption {
+declare class NumberOption<N extends string = string> extends ConfigurationOption<N> {
   min: number;
   max: number;
   defaultValue: number;
   type: ConfigurationOptionType;
   inputType: 'range' | '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.
+   */
+  setName<K extends string>(name: K): 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.
@@ -117,9 +145,14 @@ declare class NumberOption extends ConfigurationOption {
   setDefaultValue(defaultValue: number): this;
   validate(input: unknown): [boolean, string];
 }
-declare class BooleanOption extends ConfigurationOption {
+declare class BooleanOption<N extends string = string> extends ConfigurationOption<N> {
   type: ConfigurationOptionType;
   defaultValue: boolean;
+  /**
+   * 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<K extends string>(name: K): 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.
@@ -127,6 +160,33 @@ declare class BooleanOption extends ConfigurationOption {
   setDefaultValue(defaultValue: boolean): this;
   validate(input: unknown): [boolean, string];
 }
+declare class ActionOption<N extends string = string> extends ConfigurationOption<N> {
+  type: ConfigurationOptionType;
+  manifest: Record<string, unknown>;
+  buttonText: string;
+  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.
+   */
+  setName<K extends string>(name: K): 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;
+  /**
+   * 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;
+  /**
+   * Set the text displayed on the action button.
+   * @param text {string} The button text.
+   */
+  setButtonText(text: string): this;
+  validate(_input: unknown): [boolean, string];
+}
 //#endregion
-export { ConfigurationOptionType as a, isBooleanOption as c, ConfigurationOption as i, isNumberOption as l, ConfigurationBuilder as n, NumberOption as o, ConfigurationFile as r, StringOption as s, BooleanOption as t, isStringOption as u };
-//# sourceMappingURL=ConfigurationBuilder-CfHLKMTO.d.cts.map
+export { ConfigurationOption as a, StringOption as c, isNumberOption as d, isStringOption as f, ConfigurationFile as i, isActionOption as l, BooleanOption as n, ConfigurationOptionType as o, ConfigurationBuilder as r, NumberOption as s, ActionOption as t, isBooleanOption as u };
+//# sourceMappingURL=ConfigurationBuilder-lzKf9gHw.d.mts.map