ogi-addon 2.4.0 → 3.1.0

package/build/config/ConfigurationBuilder.cjs

@@ -25,7 +25,7 @@ function isActionOption(option) {
 * 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 {
@@ -61,7 +61,7 @@ var ConfigurationBuilder = class {
 		return this;
 	}
 	/**
-	* Add an action option to the configuration builder and return the builder for chaining. 
+	* 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> }

package/build/config/ConfigurationBuilder.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"ConfigurationBuilder.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"}
+{"version":3,"file":"ConfigurationBuilder.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  N extends string = string,\n> 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  N extends string = string,\n> 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  N extends string = string,\n> 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  N extends string = string,\n> 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,cAEU,oBAAuB;CAC/B,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,cAEU,oBAAuB;CAC/B,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,cAEU,oBAAuB;CAC/B,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,cAEU,oBAAuB;CAC/B,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/config/ConfigurationBuilder.mjs

@@ -22,7 +22,7 @@ function isActionOption(option) {
 * 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 {
@@ -58,7 +58,7 @@ var ConfigurationBuilder = class {
 		return this;
 	}
 	/**
-	* Add an action option to the configuration builder and return the builder for chaining. 
+	* 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> }

package/build/config/ConfigurationBuilder.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"ConfigurationBuilder.mjs","names":[],"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,mBAAmB,EAAE,OAAO;CAChC,MAAM,EAAE,QAAQ,CAAC,IAAI,EAAE;CACvB,aAAa,EAAE,QAAQ,CAAC,IAAI,EAAE;CAC9B,aAAa,EAAE,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,IAAI,SAAS,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"}
+{"version":3,"file":"ConfigurationBuilder.mjs","names":[],"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  N extends string = string,\n> 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  N extends string = string,\n> 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  N extends string = string,\n> 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  N extends string = string,\n> 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,mBAAmB,EAAE,OAAO;CAChC,MAAM,EAAE,QAAQ,CAAC,IAAI,EAAE;CACvB,aAAa,EAAE,QAAQ,CAAC,IAAI,EAAE;CAC9B,aAAa,EAAE,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,IAAI,SAAS,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,cAEU,oBAAuB;CAC/B,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,cAEU,oBAAuB;CAC/B,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,cAEU,oBAAuB;CAC/B,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,cAEU,oBAAuB;CAC/B,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/extraction.cjs

@@ -0,0 +1,80 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_chunk = require('./chunk-C0xms8kb.cjs');
+let child_process = require("child_process");
+
+//#region src/extraction.ts
+const s7ZipPath = "C:\\Program Files\\7-Zip\\7z.exe";
+function waitForChildProcess(childProcess, errorMessage) {
+	return new Promise((resolve, reject) => {
+		childProcess.once("error", reject);
+		childProcess.once("close", (code) => {
+			if (code !== 0) {
+				reject(new Error(errorMessage));
+				return;
+			}
+			resolve();
+		});
+	});
+}
+async function detectUnrarType() {
+	const childProcess = (0, child_process.spawn)("unrar");
+	return await new Promise((resolve, reject) => {
+		let output = "";
+		const collectOutput = (data) => {
+			output += data.toString();
+		};
+		childProcess.stdout.on("data", collectOutput);
+		childProcess.stderr.on("data", collectOutput);
+		childProcess.once("error", reject);
+		childProcess.once("close", () => {
+			if (output.includes("unrar-free")) {
+				resolve("unrar-free");
+				return;
+			}
+			if (output.includes("unrar-nonfree")) {
+				resolve("unrar-nonfree");
+				return;
+			}
+			resolve("unknown");
+		});
+	});
+}
+async function extraction(filePath, outputDir) {
+	const lowerCaseFilePath = filePath.toLowerCase();
+	if (process.platform === "win32") return await waitForChildProcess((0, child_process.spawn)(s7ZipPath, [
+		"x",
+		filePath,
+		"-o",
+		outputDir
+	]), "Failed to extract file");
+	else if (process.platform === "linux" || process.platform === "darwin") {
+		if (lowerCaseFilePath.endsWith(".zip")) return await waitForChildProcess((0, child_process.spawn)("unzip", [
+			"-o",
+			filePath,
+			"-d",
+			outputDir
+		]), "Failed to unzip file");
+		else if (lowerCaseFilePath.endsWith(".rar")) {
+			const unrarType = await detectUnrarType();
+			if (unrarType === "unrar-free") return await waitForChildProcess((0, child_process.spawn)("unrar", [
+				"-f",
+				"-x",
+				filePath,
+				outputDir
+			]), "Failed to unrar file");
+			else if (unrarType === "unrar-nonfree") return await waitForChildProcess((0, child_process.spawn)("unrar", [
+				"-o",
+				filePath,
+				"-d",
+				outputDir
+			]), "Failed to unrar file");
+			else throw new Error("Unknown unrar type");
+		}
+		throw new Error(`Unsupported archive type: ${filePath}`);
+	}
+	throw new Error(`Unsupported platform: ${process.platform}`);
+}
+
+//#endregion
+exports.extraction = extraction;
+//# sourceMappingURL=extraction.cjs.map

package/build/extraction.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"extraction.cjs","names":[],"sources":["../src/extraction.ts"],"sourcesContent":["import { spawn } from 'child_process';\n\nconst s7ZipPath = 'C:\\\\Program Files\\\\7-Zip\\\\7z.exe';\n\nfunction waitForChildProcess(\n  childProcess: ReturnType<typeof spawn>,\n  errorMessage: string\n): Promise<void> {\n  return new Promise<void>((resolve, reject) => {\n    childProcess.once('error', reject);\n    childProcess.once('close', (code) => {\n      if (code !== 0) {\n        reject(new Error(errorMessage));\n        return;\n      }\n\n      resolve();\n    });\n  });\n}\n\nasync function detectUnrarType(): Promise<\n  'unrar-free' | 'unrar-nonfree' | 'unknown'\n> {\n  const childProcess = spawn('unrar');\n\n  return await new Promise((resolve, reject) => {\n    let output = '';\n\n    const collectOutput = (data: Buffer) => {\n      output += data.toString();\n    };\n\n    childProcess.stdout.on('data', collectOutput);\n    childProcess.stderr.on('data', collectOutput);\n    childProcess.once('error', reject);\n    childProcess.once('close', () => {\n      if (output.includes('unrar-free')) {\n        resolve('unrar-free');\n        return;\n      }\n\n      if (output.includes('unrar-nonfree')) {\n        resolve('unrar-nonfree');\n        return;\n      }\n\n      resolve('unknown');\n    });\n  });\n}\n\nexport async function extraction(filePath: string, outputDir: string) {\n  const lowerCaseFilePath = filePath.toLowerCase();\n\n  if (process.platform === 'win32') {\n    // expect 7zip to be installed, and use 7zip to unrar\n    const childProcess = spawn(s7ZipPath, ['x', filePath, '-o', outputDir]);\n    return await waitForChildProcess(childProcess, 'Failed to extract file');\n  } else if (process.platform === 'linux' || process.platform === 'darwin') {\n    if (lowerCaseFilePath.endsWith('.zip')) {\n      // expect unzip to be installed, and use unzip to unzip\n      const childProcess = spawn('unzip', ['-o', filePath, '-d', outputDir]);\n      return await waitForChildProcess(childProcess, 'Failed to unzip file');\n    } else if (lowerCaseFilePath.endsWith('.rar')) {\n      // check if unrar-nonfree is installed or unrar is installed\n      const unrarType = await detectUnrarType();\n\n      // now use the according unrar version to unrar\n      if (unrarType === 'unrar-free') {\n        // use unrar-free to unrar\n        const childProcess = spawn('unrar', ['-f', '-x', filePath, outputDir]);\n        return await waitForChildProcess(childProcess, 'Failed to unrar file');\n      } else if (unrarType === 'unrar-nonfree') {\n        // use unrar-nonfree to unrar\n        const childProcess = spawn('unrar', ['-o', filePath, '-d', outputDir]);\n        return await waitForChildProcess(childProcess, 'Failed to unrar file');\n      } else {\n        throw new Error('Unknown unrar type');\n      }\n    }\n\n    throw new Error(`Unsupported archive type: ${filePath}`);\n  }\n\n  throw new Error(`Unsupported platform: ${process.platform}`);\n}\n"],"mappings":";;;;;AAEA,MAAM,YAAY;AAElB,SAAS,oBACP,cACA,cACe;AACf,QAAO,IAAI,SAAe,SAAS,WAAW;AAC5C,eAAa,KAAK,SAAS,OAAO;AAClC,eAAa,KAAK,UAAU,SAAS;AACnC,OAAI,SAAS,GAAG;AACd,WAAO,IAAI,MAAM,aAAa,CAAC;AAC/B;;AAGF,YAAS;IACT;GACF;;AAGJ,eAAe,kBAEb;CACA,MAAM,wCAAqB,QAAQ;AAEnC,QAAO,MAAM,IAAI,SAAS,SAAS,WAAW;EAC5C,IAAI,SAAS;EAEb,MAAM,iBAAiB,SAAiB;AACtC,aAAU,KAAK,UAAU;;AAG3B,eAAa,OAAO,GAAG,QAAQ,cAAc;AAC7C,eAAa,OAAO,GAAG,QAAQ,cAAc;AAC7C,eAAa,KAAK,SAAS,OAAO;AAClC,eAAa,KAAK,eAAe;AAC/B,OAAI,OAAO,SAAS,aAAa,EAAE;AACjC,YAAQ,aAAa;AACrB;;AAGF,OAAI,OAAO,SAAS,gBAAgB,EAAE;AACpC,YAAQ,gBAAgB;AACxB;;AAGF,WAAQ,UAAU;IAClB;GACF;;AAGJ,eAAsB,WAAW,UAAkB,WAAmB;CACpE,MAAM,oBAAoB,SAAS,aAAa;AAEhD,KAAI,QAAQ,aAAa,QAGvB,QAAO,MAAM,6CADc,WAAW;EAAC;EAAK;EAAU;EAAM;EAAU,CAAC,EACxB,yBAAyB;UAC/D,QAAQ,aAAa,WAAW,QAAQ,aAAa,UAAU;AACxE,MAAI,kBAAkB,SAAS,OAAO,CAGpC,QAAO,MAAM,6CADc,SAAS;GAAC;GAAM;GAAU;GAAM;GAAU,CAAC,EACvB,uBAAuB;WAC7D,kBAAkB,SAAS,OAAO,EAAE;GAE7C,MAAM,YAAY,MAAM,iBAAiB;AAGzC,OAAI,cAAc,aAGhB,QAAO,MAAM,6CADc,SAAS;IAAC;IAAM;IAAM;IAAU;IAAU,CAAC,EACvB,uBAAuB;YAC7D,cAAc,gBAGvB,QAAO,MAAM,6CADc,SAAS;IAAC;IAAM;IAAU;IAAM;IAAU,CAAC,EACvB,uBAAuB;OAEtE,OAAM,IAAI,MAAM,qBAAqB;;AAIzC,QAAM,IAAI,MAAM,6BAA6B,WAAW;;AAG1D,OAAM,IAAI,MAAM,yBAAyB,QAAQ,WAAW"}

package/build/extraction.d.cts

@@ -0,0 +1,5 @@
+//#region src/extraction.d.ts
+declare function extraction(filePath: string, outputDir: string): Promise<void>;
+//#endregion
+export { extraction };
+//# sourceMappingURL=extraction.d.cts.map

package/build/extraction.d.mts

@@ -0,0 +1,5 @@
+//#region src/extraction.d.ts
+declare function extraction(filePath: string, outputDir: string): Promise<void>;
+//#endregion
+export { extraction };
+//# sourceMappingURL=extraction.d.mts.map

package/build/extraction.mjs

@@ -0,0 +1,78 @@
+import { spawn } from "child_process";
+
+//#region src/extraction.ts
+const s7ZipPath = "C:\\Program Files\\7-Zip\\7z.exe";
+function waitForChildProcess(childProcess, errorMessage) {
+	return new Promise((resolve, reject) => {
+		childProcess.once("error", reject);
+		childProcess.once("close", (code) => {
+			if (code !== 0) {
+				reject(new Error(errorMessage));
+				return;
+			}
+			resolve();
+		});
+	});
+}
+async function detectUnrarType() {
+	const childProcess = spawn("unrar");
+	return await new Promise((resolve, reject) => {
+		let output = "";
+		const collectOutput = (data) => {
+			output += data.toString();
+		};
+		childProcess.stdout.on("data", collectOutput);
+		childProcess.stderr.on("data", collectOutput);
+		childProcess.once("error", reject);
+		childProcess.once("close", () => {
+			if (output.includes("unrar-free")) {
+				resolve("unrar-free");
+				return;
+			}
+			if (output.includes("unrar-nonfree")) {
+				resolve("unrar-nonfree");
+				return;
+			}
+			resolve("unknown");
+		});
+	});
+}
+async function extraction(filePath, outputDir) {
+	const lowerCaseFilePath = filePath.toLowerCase();
+	if (process.platform === "win32") return await waitForChildProcess(spawn(s7ZipPath, [
+		"x",
+		filePath,
+		"-o",
+		outputDir
+	]), "Failed to extract file");
+	else if (process.platform === "linux" || process.platform === "darwin") {
+		if (lowerCaseFilePath.endsWith(".zip")) return await waitForChildProcess(spawn("unzip", [
+			"-o",
+			filePath,
+			"-d",
+			outputDir
+		]), "Failed to unzip file");
+		else if (lowerCaseFilePath.endsWith(".rar")) {
+			const unrarType = await detectUnrarType();
+			if (unrarType === "unrar-free") return await waitForChildProcess(spawn("unrar", [
+				"-f",
+				"-x",
+				filePath,
+				outputDir
+			]), "Failed to unrar file");
+			else if (unrarType === "unrar-nonfree") return await waitForChildProcess(spawn("unrar", [
+				"-o",
+				filePath,
+				"-d",
+				outputDir
+			]), "Failed to unrar file");
+			else throw new Error("Unknown unrar type");
+		}
+		throw new Error(`Unsupported archive type: ${filePath}`);
+	}
+	throw new Error(`Unsupported platform: ${process.platform}`);
+}
+
+//#endregion
+export { extraction };
+//# sourceMappingURL=extraction.mjs.map

package/build/extraction.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"extraction.mjs","names":[],"sources":["../src/extraction.ts"],"sourcesContent":["import { spawn } from 'child_process';\n\nconst s7ZipPath = 'C:\\\\Program Files\\\\7-Zip\\\\7z.exe';\n\nfunction waitForChildProcess(\n  childProcess: ReturnType<typeof spawn>,\n  errorMessage: string\n): Promise<void> {\n  return new Promise<void>((resolve, reject) => {\n    childProcess.once('error', reject);\n    childProcess.once('close', (code) => {\n      if (code !== 0) {\n        reject(new Error(errorMessage));\n        return;\n      }\n\n      resolve();\n    });\n  });\n}\n\nasync function detectUnrarType(): Promise<\n  'unrar-free' | 'unrar-nonfree' | 'unknown'\n> {\n  const childProcess = spawn('unrar');\n\n  return await new Promise((resolve, reject) => {\n    let output = '';\n\n    const collectOutput = (data: Buffer) => {\n      output += data.toString();\n    };\n\n    childProcess.stdout.on('data', collectOutput);\n    childProcess.stderr.on('data', collectOutput);\n    childProcess.once('error', reject);\n    childProcess.once('close', () => {\n      if (output.includes('unrar-free')) {\n        resolve('unrar-free');\n        return;\n      }\n\n      if (output.includes('unrar-nonfree')) {\n        resolve('unrar-nonfree');\n        return;\n      }\n\n      resolve('unknown');\n    });\n  });\n}\n\nexport async function extraction(filePath: string, outputDir: string) {\n  const lowerCaseFilePath = filePath.toLowerCase();\n\n  if (process.platform === 'win32') {\n    // expect 7zip to be installed, and use 7zip to unrar\n    const childProcess = spawn(s7ZipPath, ['x', filePath, '-o', outputDir]);\n    return await waitForChildProcess(childProcess, 'Failed to extract file');\n  } else if (process.platform === 'linux' || process.platform === 'darwin') {\n    if (lowerCaseFilePath.endsWith('.zip')) {\n      // expect unzip to be installed, and use unzip to unzip\n      const childProcess = spawn('unzip', ['-o', filePath, '-d', outputDir]);\n      return await waitForChildProcess(childProcess, 'Failed to unzip file');\n    } else if (lowerCaseFilePath.endsWith('.rar')) {\n      // check if unrar-nonfree is installed or unrar is installed\n      const unrarType = await detectUnrarType();\n\n      // now use the according unrar version to unrar\n      if (unrarType === 'unrar-free') {\n        // use unrar-free to unrar\n        const childProcess = spawn('unrar', ['-f', '-x', filePath, outputDir]);\n        return await waitForChildProcess(childProcess, 'Failed to unrar file');\n      } else if (unrarType === 'unrar-nonfree') {\n        // use unrar-nonfree to unrar\n        const childProcess = spawn('unrar', ['-o', filePath, '-d', outputDir]);\n        return await waitForChildProcess(childProcess, 'Failed to unrar file');\n      } else {\n        throw new Error('Unknown unrar type');\n      }\n    }\n\n    throw new Error(`Unsupported archive type: ${filePath}`);\n  }\n\n  throw new Error(`Unsupported platform: ${process.platform}`);\n}\n"],"mappings":";;;AAEA,MAAM,YAAY;AAElB,SAAS,oBACP,cACA,cACe;AACf,QAAO,IAAI,SAAe,SAAS,WAAW;AAC5C,eAAa,KAAK,SAAS,OAAO;AAClC,eAAa,KAAK,UAAU,SAAS;AACnC,OAAI,SAAS,GAAG;AACd,WAAO,IAAI,MAAM,aAAa,CAAC;AAC/B;;AAGF,YAAS;IACT;GACF;;AAGJ,eAAe,kBAEb;CACA,MAAM,eAAe,MAAM,QAAQ;AAEnC,QAAO,MAAM,IAAI,SAAS,SAAS,WAAW;EAC5C,IAAI,SAAS;EAEb,MAAM,iBAAiB,SAAiB;AACtC,aAAU,KAAK,UAAU;;AAG3B,eAAa,OAAO,GAAG,QAAQ,cAAc;AAC7C,eAAa,OAAO,GAAG,QAAQ,cAAc;AAC7C,eAAa,KAAK,SAAS,OAAO;AAClC,eAAa,KAAK,eAAe;AAC/B,OAAI,OAAO,SAAS,aAAa,EAAE;AACjC,YAAQ,aAAa;AACrB;;AAGF,OAAI,OAAO,SAAS,gBAAgB,EAAE;AACpC,YAAQ,gBAAgB;AACxB;;AAGF,WAAQ,UAAU;IAClB;GACF;;AAGJ,eAAsB,WAAW,UAAkB,WAAmB;CACpE,MAAM,oBAAoB,SAAS,aAAa;AAEhD,KAAI,QAAQ,aAAa,QAGvB,QAAO,MAAM,oBADQ,MAAM,WAAW;EAAC;EAAK;EAAU;EAAM;EAAU,CAAC,EACxB,yBAAyB;UAC/D,QAAQ,aAAa,WAAW,QAAQ,aAAa,UAAU;AACxE,MAAI,kBAAkB,SAAS,OAAO,CAGpC,QAAO,MAAM,oBADQ,MAAM,SAAS;GAAC;GAAM;GAAU;GAAM;GAAU,CAAC,EACvB,uBAAuB;WAC7D,kBAAkB,SAAS,OAAO,EAAE;GAE7C,MAAM,YAAY,MAAM,iBAAiB;AAGzC,OAAI,cAAc,aAGhB,QAAO,MAAM,oBADQ,MAAM,SAAS;IAAC;IAAM;IAAM;IAAU;IAAU,CAAC,EACvB,uBAAuB;YAC7D,cAAc,gBAGvB,QAAO,MAAM,oBADQ,MAAM,SAAS;IAAC;IAAM;IAAU;IAAM;IAAU,CAAC,EACvB,uBAAuB;OAEtE,OAAM,IAAI,MAAM,qBAAqB;;AAIzC,QAAM,IAAI,MAAM,6BAA6B,WAAW;;AAG1D,OAAM,IAAI,MAAM,yBAAyB,QAAQ,WAAW"}

package/build/main.cjs

@@ -1,6 +1,7 @@
 Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
 const require_chunk = require('./chunk-C0xms8kb.cjs');
 const require_EventResponse = require('./EventResponse.cjs');
+const require_extraction = require('./extraction.cjs');
 const require_config_ConfigurationBuilder = require('./config/ConfigurationBuilder.cjs');
 const require_config_Configuration = require('./config/Configuration.cjs');
 let ws = require("ws");
@@ -10,12 +11,9 @@ node_events = require_chunk.__toESM(node_events);
 let zod = require("zod");
 let fuse_js = require("fuse.js");
 fuse_js = require_chunk.__toESM(fuse_js);
-let node_child_process = require("node:child_process");
-let node_fs = require("node:fs");
-node_fs = require_chunk.__toESM(node_fs);
 
 //#region package.json
-var version = "2.4.0";
+var version = "3.1.0";
 
 //#endregion
 //#region src/main.ts
@@ -152,83 +150,10 @@ var OGIAddon = class {
 	* Extract a file using 7-Zip on Windows, unzip on Linux/Mac.
 	* @param path {string}
 	* @param outputPath {string}
-	* @param type {'unrar' | 'unzip'}
 	* @returns {Promise<void>}
 	*/
-	async extractFile(path, outputPath, type) {
-		return new Promise((resolve, reject) => {
-			if (!node_fs.default.existsSync(outputPath)) node_fs.default.mkdirSync(outputPath, { recursive: true });
-			if (type === "unzip") if (process.platform === "win32") (0, node_child_process.exec)(`"C:\\Program Files\\7-Zip\\7z.exe" x "${path}" -o"${outputPath}"`, (err, stdout, stderr) => {
-				if (err) {
-					console.error(err);
-					console.log(stderr);
-					reject(/* @__PURE__ */ new Error("Failed to extract ZIP file"));
-					return;
-				}
-				console.log(stdout);
-				console.log(stderr);
-				resolve();
-			});
-			else {
-				const unzipProcess = (0, node_child_process.spawn)("unzip", [
-					"-o",
-					path,
-					"-d",
-					outputPath
-				], { env: {
-					...process.env,
-					UNZIP_DISABLE_ZIPBOMB_DETECTION: "TRUE"
-				} });
-				unzipProcess.stdout.on("data", (data) => {
-					console.log(`[unzip stdout]: ${data}`);
-				});
-				unzipProcess.stderr.on("data", (data) => {
-					console.error(`[unzip stderr]: ${data}`);
-				});
-				unzipProcess.on("close", (code) => {
-					if (code !== 0) {
-						console.error(`unzip process exited with code ${code}`);
-						reject(/* @__PURE__ */ new Error("Failed to extract ZIP file"));
-						return;
-					}
-					resolve();
-				});
-			}
-			else if (type === "unrar") if (process.platform === "win32") (0, node_child_process.exec)(`"C:\\Program Files\\7-Zip\\7z.exe" x "${path}" -o"${outputPath}"`, (err, stdout, stderr) => {
-				if (err) {
-					console.error(err);
-					console.log(stderr);
-					reject(/* @__PURE__ */ new Error("Failed to extract RAR file"));
-					return;
-				}
-				console.log(stdout);
-				console.log(stderr);
-				resolve();
-			});
-			else {
-				const unrarProcess = (0, node_child_process.spawn)("unrar", [
-					"x",
-					"-y",
-					path,
-					outputPath
-				]);
-				unrarProcess.stdout.on("data", (data) => {
-					console.log(`[unrar stdout]: ${data}`);
-				});
-				unrarProcess.stderr.on("data", (data) => {
-					console.error(`[unrar stderr]: ${data}`);
-				});
-				unrarProcess.on("close", (code) => {
-					if (code !== 0) {
-						console.error(`unrar process exited with code ${code}`);
-						reject(/* @__PURE__ */ new Error("Failed to extract RAR file"));
-						return;
-					}
-					resolve();
-				});
-			}
-			else reject(/* @__PURE__ */ new Error("Unknown extraction type"));
-		});
+	async extractFile(path, outputPath) {
+		return await require_extraction.extraction(path, outputPath);
 	}
 };
 /**
@@ -364,20 +289,20 @@ const ZodLibraryInfo = zod.z.object({
 	appID: zod.z.number(),
 	launchExecutable: zod.z.string(),
 	launchArguments: zod.z.string().optional(),
+	launchEnv: zod.z.record(zod.z.string(), zod.z.string()).optional(),
 	capsuleImage: zod.z.string(),
 	storefront: zod.z.string(),
 	addonsource: zod.z.string(),
 	coverImage: zod.z.string(),
 	titleImage: zod.z.string().optional(),
 	umu: zod.z.object({
-		umuId: zod.z.string().regex(/^(steam|umu):\d+$/, "Must be in format steam:{number} or umu:{number}"),
+		umuId: zod.z.string().regex(/^(steam|umu):\S+$/, "Must be in format steam:{number} or umu:{string | number}"),
 		dllOverrides: zod.z.array(zod.z.string()).optional(),
 		protonVersion: zod.z.string().optional(),
 		store: zod.z.string().optional(),
 		winePrefixPath: zod.z.string().optional(),
 		steamShortcutId: zod.z.number().optional()
 	}).optional(),
-	legacyMode: zod.z.boolean().optional(),
 	redistributables: zod.z.array(zod.z.object({
 		name: zod.z.string(),
 		path: zod.z.string()
@@ -653,4 +578,5 @@ exports.Task = Task;
 exports.VERSION = VERSION;
 exports.ZodLibraryInfo = ZodLibraryInfo;
 exports.default = OGIAddon;
+exports.extraction = require_extraction.extraction;
 //# sourceMappingURL=main.cjs.map