ogi-addon 1.0.0 → 1.1.5

package/build/config/ConfigurationBuilder.d.ts

@@ -6,8 +6,21 @@ declare function isNumberOption(option: ConfigurationOption): option is NumberOp
 declare function isBooleanOption(option: ConfigurationOption): option is BooleanOption;
 declare class ConfigurationBuilder {
     private options;
+    /**
+     * Add a number option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.
+     * @param option { (option: NumberOption) => NumberOption }
+     * @returns
+     */
     addNumberOption(option: (option: NumberOption) => NumberOption): ConfigurationBuilder;
+    /**
+     * Add a string option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.
+     * @param option { (option: StringOption) => StringOption }
+    */
     addStringOption(option: (option: StringOption) => StringOption): this;
+    /**
+     * Add a boolean option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.
+     * @param option { (option: BooleanOption) => BooleanOption }
+    */
     addBooleanOption(option: (option: BooleanOption) => BooleanOption): this;
     build(includeFunctions: boolean): ConfigurationFile;
 }
@@ -18,9 +31,27 @@ declare class ConfigurationOption {
     displayName: string;
     description: string;
     type: ConfigurationOptionType;
+    /**
+     * Set the name of the option. **REQUIRED**
+     * @param name {string} The name of the option. This is used to reference the option in the configuration file.
+     */
     setName(name: string): this;
+    /**
+     * Set the display name of the option. This is used to show the user a human readable version of what the option is. **REQUIRED**
+     * @param displayName {string} The display name of the option.
+     * @returns
+     */
     setDisplayName(displayName: string): this;
+    /**
+     * Set the description of the option. This is to show the user a brief description of what this option does. **REQUIRED**
+     * @param description {string} The description of the option.
+     * @returns
+     */
     setDescription(description: string): this;
+    /**
+     * 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.
+     * @param input {unknown} The input to validate
+     */
     validate(input: unknown): [boolean, string];
 }
 declare class StringOption extends ConfigurationOption {
@@ -30,10 +61,30 @@ declare class StringOption extends ConfigurationOption {
     defaultValue: string;
     inputType: 'text' | 'file' | 'password' | 'folder';
     type: ConfigurationOptionType;
+    /**
+     * Set the allowed values for the string. If the array is empty, any value is allowed. When provided, the client will act like this option is a dropdown.
+     * @param allowedValues {string[]} An array of allowed values for the string. If the array is empty, any value is allowed.
+     */
     setAllowedValues(allowedValues: string[]): this;
+    /**
+     * Set the default value for the string. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**
+     * @param defaultValue {string} The default value for the string.
+     */
     setDefaultValue(defaultValue: string): this;
+    /**
+     * Set the minimum text length for the string. If the user provides a string that is less than this value, the validation will fail.
+     * @param minTextLength {number} The minimum text length for the string.
+     */
     setMinTextLength(minTextLength: number): this;
+    /**
+     * Set the maximum text length for the string. If the user provides a string that is greater than this value, the validation will fail.
+     * @param maxTextLength {number} The maximum text length for the string.
+     */
     setMaxTextLength(maxTextLength: number): this;
+    /**
+     * Set the input type for the string. This will change how the client renders the input.
+     * @param inputType {'text' | 'file' | 'password' | 'folder'} The input type for the string.
+     */
     setInputType(inputType: 'text' | 'file' | 'password' | 'folder'): this;
     validate(input: unknown): [boolean, string];
 }
@@ -43,15 +94,35 @@ declare class NumberOption extends ConfigurationOption {
     defaultValue: number;
     type: ConfigurationOptionType;
     inputType: 'range' | 'number';
+    /**
+     * Set the minimum value for the number. If the user provides a number that is less than this value, the validation will fail.
+     * @param min {number} The minimum value for the number.
+     */
     setMin(min: number): this;
+    /**
+     * Set the input type for the number. This will change how the client renders the input.
+     * @param type {'range' | 'number'} The input type for the number.
+     */
     setInputType(type: 'range' | 'number'): this;
+    /**
+     * Set the maximum value for the number. If the user provides a number that is greater than this value, the validation will fail.
+     * @param max {number} The maximum value for the number.
+     */
     setMax(max: number): this;
+    /**
+     * Set the default value for the number. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**
+     * @param defaultValue {number} The default value for the number.
+     */
     setDefaultValue(defaultValue: number): this;
     validate(input: unknown): [boolean, string];
 }
 declare class BooleanOption extends ConfigurationOption {
     type: ConfigurationOptionType;
     defaultValue: boolean;
+    /**
+     * Set the default value for the boolean. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**
+     * @param defaultValue {boolean} The default value for the boolean.
+     */
     setDefaultValue(defaultValue: boolean): this;
     validate(input: unknown): [boolean, string];
 }

package/build/config/ConfigurationBuilder.js

@@ -16,18 +16,31 @@ function isBooleanOption(option) {
 }
 var ConfigurationBuilder = class {
   options = [];
+  /**
+   * Add a number option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.
+   * @param option { (option: NumberOption) => NumberOption }
+   * @returns 
+   */
   addNumberOption(option) {
     let newOption = new NumberOption();
     newOption = option(newOption);
     this.options.push(newOption);
     return this;
   }
+  /**
+   * Add a string option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.
+   * @param option { (option: StringOption) => StringOption }
+  */
   addStringOption(option) {
     let newOption = new StringOption();
     newOption = option(newOption);
     this.options.push(newOption);
     return this;
   }
+  /**
+   * Add a boolean option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.
+   * @param option { (option: BooleanOption) => BooleanOption }
+  */
   addBooleanOption(option) {
     let newOption = new BooleanOption();
     newOption = option(newOption);
@@ -57,18 +70,36 @@ var ConfigurationOption = class {
   displayName = "";
   description = "";
   type = "unset";
+  /**
+   * Set the name of the option. **REQUIRED**
+   * @param name {string} The name of the option. This is used to reference the option in the configuration file.
+   */
   setName(name) {
     this.name = name;
     return this;
   }
+  /**
+   * Set the display name of the option. This is used to show the user a human readable version of what the option is. **REQUIRED** 
+   * @param displayName {string} The display name of the option. 
+   * @returns 
+   */
   setDisplayName(displayName) {
     this.displayName = displayName;
     return this;
   }
+  /**
+   * Set the description of the option. This is to show the user a brief description of what this option does. **REQUIRED**
+   * @param description {string} The description of the option. 
+   * @returns 
+   */
   setDescription(description) {
     this.description = description;
     return this;
   }
+  /**
+   * 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.
+   * @param input {unknown} The input to validate
+   */
   validate(input) {
     throw new Error("Validation code not implemented. Value: " + input);
   }
@@ -80,22 +111,42 @@ var StringOption = class extends ConfigurationOption {
   defaultValue = "";
   inputType = "text";
   type = "string";
+  /**
+   * Set the allowed values for the string. If the array is empty, any value is allowed. When provided, the client will act like this option is a dropdown.  
+   * @param allowedValues {string[]} An array of allowed values for the string. If the array is empty, any value is allowed.
+   */
   setAllowedValues(allowedValues) {
     this.allowedValues = allowedValues;
     return this;
   }
+  /**
+   * Set the default value for the string. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**
+   * @param defaultValue {string} The default value for the string.
+   */
   setDefaultValue(defaultValue) {
     this.defaultValue = defaultValue;
     return this;
   }
+  /**
+   * Set the minimum text length for the string. If the user provides a string that is less than this value, the validation will fail. 
+   * @param minTextLength {number} The minimum text length for the string. 
+   */
   setMinTextLength(minTextLength) {
     this.minTextLength = minTextLength;
     return this;
   }
+  /**
+   * Set the maximum text length for the string. If the user provides a string that is greater than this value, the validation will fail. 
+   * @param maxTextLength {number} The maximum text length for the string.
+   */
   setMaxTextLength(maxTextLength) {
     this.maxTextLength = maxTextLength;
     return this;
   }
+  /**
+   * Set the input type for the string. This will change how the client renders the input. 
+   * @param inputType {'text' | 'file' | 'password' | 'folder'} The input type for the string. 
+   */
   setInputType(inputType) {
     this.inputType = inputType;
     return this;
@@ -118,18 +169,34 @@ var NumberOption = class extends ConfigurationOption {
   defaultValue = 0;
   type = "number";
   inputType = "number";
+  /**
+   * Set the minimum value for the number. If the user provides a number that is less than this value, the validation will fail.
+   * @param min {number} The minimum value for the number.
+   */
   setMin(min) {
     this.min = min;
     return this;
   }
+  /**
+   * Set the input type for the number. This will change how the client renders the input. 
+   * @param type {'range' | 'number'} The input type for the number. 
+   */
   setInputType(type) {
     this.inputType = type;
     return this;
   }
+  /**
+   * Set the maximum value for the number. If the user provides a number that is greater than this value, the validation will fail.
+   * @param max {number} The maximum value for the number.
+   */
   setMax(max) {
     this.max = max;
     return this;
   }
+  /**
+   * Set the default value for the number. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**
+   * @param defaultValue {number} The default value for the number.
+   */
   setDefaultValue(defaultValue) {
     this.defaultValue = defaultValue;
     return this;
@@ -147,6 +214,10 @@ var NumberOption = class extends ConfigurationOption {
 var BooleanOption = class extends ConfigurationOption {
   type = "boolean";
   defaultValue = false;
+  /**
+   * Set the default value for the boolean. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**
+   * @param defaultValue {boolean} The default value for the boolean.
+   */
   setDefaultValue(defaultValue) {
     this.defaultValue = defaultValue;
     return this;

package/build/config/ConfigurationBuilder.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/config/ConfigurationBuilder.ts"],"sourcesContent":["import z, { ZodError } from \"zod\"\r\n\r\nexport interface ConfigurationFile {\r\n  [key: string]: ConfigurationOption\r\n}\r\n\r\nconst configValidation = z.object({\r\n  name: z.string().min(1),\r\n  displayName: z.string().min(1),\r\n  description: z.string().min(1),\r\n})\r\n\r\nexport function isStringOption(option: ConfigurationOption): option is StringOption {\r\n    return option.type === 'string';\r\n  }\r\n\r\nexport function isNumberOption(option: ConfigurationOption): option is NumberOption {\r\n  return option.type === 'number';\r\n}\r\n\r\nexport function isBooleanOption(option: ConfigurationOption): option is BooleanOption {\r\n  return option.type === 'boolean';\r\n}\r\n\r\nexport class ConfigurationBuilder {\r\n  private options: ConfigurationOption[] = [];\r\n  public addNumberOption(option: (option: NumberOption) => NumberOption): ConfigurationBuilder {\r\n    let newOption = new NumberOption();\r\n    newOption = option(newOption);\r\n    this.options.push(newOption);\r\n    return this;\r\n  }\r\n\r\n  public addStringOption(option: (option: StringOption) => StringOption) {\r\n    let newOption = new StringOption();\r\n    newOption = option(newOption);\r\n    this.options.push(newOption);\r\n    return this;\r\n  }\r\n\r\n  public addBooleanOption(option: (option: BooleanOption) => BooleanOption) {\r\n    let newOption = new BooleanOption();\r\n    newOption = option(newOption);\r\n    this.options.push(newOption);\r\n    return this;\r\n  }\r\n\r\n  public build(includeFunctions: boolean): ConfigurationFile {\r\n    let config: ConfigurationFile = {};\r\n    this.options.forEach(option => {\r\n      // remove all functions from the option object\r\n      if (!includeFunctions) {\r\n        option = JSON.parse(JSON.stringify(option));\r\n        const optionData = configValidation.safeParse(option)\r\n        if (!optionData.success) {\r\n          throw new ZodError(optionData.error.errors)\r\n        }\r\n\r\n        config[option.name] = option;\r\n      }\r\n      else {\r\n        config[option.name] = option;\r\n      }\r\n    });\r\n    return config;\r\n  }\r\n}\r\n\r\nexport type ConfigurationOptionType = 'string' | 'number' | 'boolean' | 'unset'\r\nexport class ConfigurationOption {\r\n  public name: string = '';\r\n  public defaultValue: unknown = '';\r\n  public displayName: string = '';\r\n  public description: string = '';\r\n  public type: ConfigurationOptionType = 'unset'\r\n  \r\n  setName(name: string) {\r\n    this.name = name;\r\n    return this;\r\n  }\r\n\r\n  setDisplayName(displayName: string) {\r\n    this.displayName = displayName;\r\n    return this;\r\n  }\r\n\r\n  setDescription(description: string) {\r\n    this.description = description;\r\n    return this;\r\n  }\r\n\r\n\r\n  validate(input: unknown): [ boolean, string ] {\r\n    throw new Error('Validation code not implemented. Value: ' + input)\r\n  };\r\n}\r\n\r\nexport class StringOption extends ConfigurationOption {\r\n  public allowedValues: string[] = [];\r\n  public minTextLength: number = 0;\r\n  public maxTextLength: number = Number.MAX_SAFE_INTEGER;\r\n  public defaultValue: string = '';\r\n  public inputType: 'text' | 'file' | 'password' | 'folder' = 'text';\r\n  public type: ConfigurationOptionType = 'string'\r\n\r\n  setAllowedValues(allowedValues: string[]): this {\r\n    this.allowedValues = allowedValues;\r\n    return this;\r\n  }\r\n\r\n  setDefaultValue(defaultValue: string): this {\r\n    this.defaultValue = defaultValue;\r\n    return this;\r\n  }\r\n\r\n  setMinTextLength(minTextLength: number): this {\r\n    this.minTextLength = minTextLength;\r\n    return this;\r\n  }\r\n\r\n  setMaxTextLength(maxTextLength: number): this {\r\n    this.maxTextLength = maxTextLength;\r\n    return this;\r\n  }\r\n\r\n  setInputType(inputType: 'text' | 'file' | 'password' | 'folder'): this {\r\n    this.inputType = inputType;\r\n    return this;\r\n  }\r\n\r\n  override validate(input: unknown): [ boolean, string ] {\r\n    if (typeof input !== 'string') {\r\n      return [ false, 'Input is not a string' ];\r\n    }\r\n    if (this.allowedValues.length === 0 && input.length !== 0)\r\n      return [ true, '' ];\r\n    if (input.length < this.minTextLength || input.length > this.maxTextLength) {\r\n      return [ false, 'Input is not within the text length ' + this.minTextLength + ' and ' + this.maxTextLength + ' characters (currently ' + input.length + ' characters)' ];\r\n    }\r\n\r\n    return [ this.allowedValues.includes(input), 'Input is not an allowed value' ];\r\n  }\r\n}\r\n\r\nexport class NumberOption extends ConfigurationOption {\r\n  public min: number = 0;\r\n  public max: number = Number.MAX_SAFE_INTEGER;\r\n  public defaultValue: number = 0;\r\n  public type: ConfigurationOptionType = 'number'\r\n  public inputType: 'range' | 'number' = 'number';\r\n  setMin(min: number): this {\r\n    this.min = min;\r\n    return this;\r\n  }\r\n\r\n  setInputType(type: 'range' | 'number'): this {\r\n    this.inputType = type;\r\n    return this;\r\n  }\r\n\r\n  setMax(max: number): this {\r\n    this.max = max;\r\n    return this\r\n  }\r\n\r\n  setDefaultValue(defaultValue: number): this {\r\n    this.defaultValue = defaultValue;\r\n    return this;\r\n  }\r\n\r\n  override validate(input: unknown): [ boolean, string ] {\r\n    if (isNaN(Number(input))) {\r\n      return [ false, 'Input is not a number' ];\r\n    }\r\n    if (Number(input) < this.min || Number(input) > this.max) {\r\n      return [ false, 'Input is not within the range of ' + this.min + ' and ' + this.max ];\r\n    }\r\n    return [ true, '' ];\r\n  }\r\n\r\n}\r\n\r\nexport class BooleanOption extends ConfigurationOption {\r\n  public type: ConfigurationOptionType = 'boolean'\r\n  public defaultValue: boolean = false;\r\n\r\n  setDefaultValue(defaultValue: boolean): this {\r\n    this.defaultValue = defaultValue;\r\n    return this;\r\n  }\r\n\r\n  override validate(input: unknown): [ boolean, string ] {\r\n    if (typeof input !== 'boolean') {\r\n      return [ false, 'Input is not a boolean' ];\r\n    }\r\n    return [ true, '' ];\r\n  }\r\n\r\n}"],"mappings":";AAAA,OAAO,KAAK,gBAAgB;AAM5B,IAAM,mBAAmB,EAAE,OAAO;AAAA,EAChC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EACtB,aAAa,EAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EAC7B,aAAa,EAAE,OAAO,EAAE,IAAI,CAAC;AAC/B,CAAC;AAEM,SAAS,eAAe,QAAqD;AAChF,SAAO,OAAO,SAAS;AACzB;AAEK,SAAS,eAAe,QAAqD;AAClF,SAAO,OAAO,SAAS;AACzB;AAEO,SAAS,gBAAgB,QAAsD;AACpF,SAAO,OAAO,SAAS;AACzB;AAEO,IAAM,uBAAN,MAA2B;AAAA,EACxB,UAAiC,CAAC;AAAA,EACnC,gBAAgB,QAAsE;AAC3F,QAAI,YAAY,IAAI,aAAa;AACjC,gBAAY,OAAO,SAAS;AAC5B,SAAK,QAAQ,KAAK,SAAS;AAC3B,WAAO;AAAA,EACT;AAAA,EAEO,gBAAgB,QAAgD;AACrE,QAAI,YAAY,IAAI,aAAa;AACjC,gBAAY,OAAO,SAAS;AAC5B,SAAK,QAAQ,KAAK,SAAS;AAC3B,WAAO;AAAA,EACT;AAAA,EAEO,iBAAiB,QAAkD;AACxE,QAAI,YAAY,IAAI,cAAc;AAClC,gBAAY,OAAO,SAAS;AAC5B,SAAK,QAAQ,KAAK,SAAS;AAC3B,WAAO;AAAA,EACT;AAAA,EAEO,MAAM,kBAA8C;AACzD,QAAI,SAA4B,CAAC;AACjC,SAAK,QAAQ,QAAQ,YAAU;AAE7B,UAAI,CAAC,kBAAkB;AACrB,iBAAS,KAAK,MAAM,KAAK,UAAU,MAAM,CAAC;AAC1C,cAAM,aAAa,iBAAiB,UAAU,MAAM;AACpD,YAAI,CAAC,WAAW,SAAS;AACvB,gBAAM,IAAI,SAAS,WAAW,MAAM,MAAM;AAAA,QAC5C;AAEA,eAAO,OAAO,IAAI,IAAI;AAAA,MACxB,OACK;AACH,eAAO,OAAO,IAAI,IAAI;AAAA,MACxB;AAAA,IACF,CAAC;AACD,WAAO;AAAA,EACT;AACF;AAGO,IAAM,sBAAN,MAA0B;AAAA,EACxB,OAAe;AAAA,EACf,eAAwB;AAAA,EACxB,cAAsB;AAAA,EACtB,cAAsB;AAAA,EACtB,OAAgC;AAAA,EAEvC,QAAQ,MAAc;AACpB,SAAK,OAAO;AACZ,WAAO;AAAA,EACT;AAAA,EAEA,eAAe,aAAqB;AAClC,SAAK,cAAc;AACnB,WAAO;AAAA,EACT;AAAA,EAEA,eAAe,aAAqB;AAClC,SAAK,cAAc;AACnB,WAAO;AAAA,EACT;AAAA,EAGA,SAAS,OAAqC;AAC5C,UAAM,IAAI,MAAM,6CAA6C,KAAK;AAAA,EACpE;AACF;AAEO,IAAM,eAAN,cAA2B,oBAAoB;AAAA,EAC7C,gBAA0B,CAAC;AAAA,EAC3B,gBAAwB;AAAA,EACxB,gBAAwB,OAAO;AAAA,EAC/B,eAAuB;AAAA,EACvB,YAAqD;AAAA,EACrD,OAAgC;AAAA,EAEvC,iBAAiB,eAA+B;AAC9C,SAAK,gBAAgB;AACrB,WAAO;AAAA,EACT;AAAA,EAEA,gBAAgB,cAA4B;AAC1C,SAAK,eAAe;AACpB,WAAO;AAAA,EACT;AAAA,EAEA,iBAAiB,eAA6B;AAC5C,SAAK,gBAAgB;AACrB,WAAO;AAAA,EACT;AAAA,EAEA,iBAAiB,eAA6B;AAC5C,SAAK,gBAAgB;AACrB,WAAO;AAAA,EACT;AAAA,EAEA,aAAa,WAA0D;AACrE,SAAK,YAAY;AACjB,WAAO;AAAA,EACT;AAAA,EAES,SAAS,OAAqC;AACrD,QAAI,OAAO,UAAU,UAAU;AAC7B,aAAO,CAAE,OAAO,uBAAwB;AAAA,IAC1C;AACA,QAAI,KAAK,cAAc,WAAW,KAAK,MAAM,WAAW;AACtD,aAAO,CAAE,MAAM,EAAG;AACpB,QAAI,MAAM,SAAS,KAAK,iBAAiB,MAAM,SAAS,KAAK,eAAe;AAC1E,aAAO,CAAE,OAAO,yCAAyC,KAAK,gBAAgB,UAAU,KAAK,gBAAgB,4BAA4B,MAAM,SAAS,cAAe;AAAA,IACzK;AAEA,WAAO,CAAE,KAAK,cAAc,SAAS,KAAK,GAAG,+BAAgC;AAAA,EAC/E;AACF;AAEO,IAAM,eAAN,cAA2B,oBAAoB;AAAA,EAC7C,MAAc;AAAA,EACd,MAAc,OAAO;AAAA,EACrB,eAAuB;AAAA,EACvB,OAAgC;AAAA,EAChC,YAAgC;AAAA,EACvC,OAAO,KAAmB;AACxB,SAAK,MAAM;AACX,WAAO;AAAA,EACT;AAAA,EAEA,aAAa,MAAgC;AAC3C,SAAK,YAAY;AACjB,WAAO;AAAA,EACT;AAAA,EAEA,OAAO,KAAmB;AACxB,SAAK,MAAM;AACX,WAAO;AAAA,EACT;AAAA,EAEA,gBAAgB,cAA4B;AAC1C,SAAK,eAAe;AACpB,WAAO;AAAA,EACT;AAAA,EAES,SAAS,OAAqC;AACrD,QAAI,MAAM,OAAO,KAAK,CAAC,GAAG;AACxB,aAAO,CAAE,OAAO,uBAAwB;AAAA,IAC1C;AACA,QAAI,OAAO,KAAK,IAAI,KAAK,OAAO,OAAO,KAAK,IAAI,KAAK,KAAK;AACxD,aAAO,CAAE,OAAO,sCAAsC,KAAK,MAAM,UAAU,KAAK,GAAI;AAAA,IACtF;AACA,WAAO,CAAE,MAAM,EAAG;AAAA,EACpB;AAEF;AAEO,IAAM,gBAAN,cAA4B,oBAAoB;AAAA,EAC9C,OAAgC;AAAA,EAChC,eAAwB;AAAA,EAE/B,gBAAgB,cAA6B;AAC3C,SAAK,eAAe;AACpB,WAAO;AAAA,EACT;AAAA,EAES,SAAS,OAAqC;AACrD,QAAI,OAAO,UAAU,WAAW;AAC9B,aAAO,CAAE,OAAO,wBAAyB;AAAA,IAC3C;AACA,WAAO,CAAE,MAAM,EAAG;AAAA,EACpB;AAEF;","names":[]}
+{"version":3,"sources":["../../src/config/ConfigurationBuilder.ts"],"sourcesContent":["import z, { ZodError } from \"zod\"\n\nexport interface ConfigurationFile {\n  [key: string]: ConfigurationOption\n}\n\nconst configValidation = z.object({\n  name: z.string().min(1),\n  displayName: z.string().min(1),\n  description: z.string().min(1),\n})\n\nexport function isStringOption(option: ConfigurationOption): option is StringOption {\n    return option.type === 'string';\n  }\n\nexport function isNumberOption(option: ConfigurationOption): option is NumberOption {\n  return option.type === 'number';\n}\n\nexport function isBooleanOption(option: ConfigurationOption): option is BooleanOption {\n  return option.type === 'boolean';\n}\n\nexport class ConfigurationBuilder {\n  private options: ConfigurationOption[] = [];\n\n  /**\n   * Add a number option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.\n   * @param option { (option: NumberOption) => NumberOption }\n   * @returns \n   */\n  public addNumberOption(option: (option: NumberOption) => NumberOption): ConfigurationBuilder {\n    let newOption = new NumberOption();\n    newOption = option(newOption);\n    this.options.push(newOption);\n    return this;\n  }\n\n  /**\n   * Add a string option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.\n   * @param option { (option: StringOption) => StringOption }\n  */\n  public addStringOption(option: (option: StringOption) => StringOption) {\n    let newOption = new StringOption();\n    newOption = option(newOption);\n    this.options.push(newOption);\n    return this;\n  }\n\n  /**\n   * Add a boolean option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.\n   * @param option { (option: BooleanOption) => BooleanOption }\n  */\n  public addBooleanOption(option: (option: BooleanOption) => BooleanOption) {\n    let newOption = new BooleanOption();\n    newOption = option(newOption);\n    this.options.push(newOption);\n    return this;\n  }\n\n  public build(includeFunctions: boolean): ConfigurationFile {\n    let config: ConfigurationFile = {};\n    this.options.forEach(option => {\n      // remove all functions from the option object\n      if (!includeFunctions) {\n        option = JSON.parse(JSON.stringify(option));\n        const optionData = configValidation.safeParse(option)\n        if (!optionData.success) {\n          throw new ZodError(optionData.error.errors)\n        }\n\n        config[option.name] = option;\n      }\n      else {\n        config[option.name] = option;\n      }\n    });\n    return config;\n  }\n}\n\nexport type ConfigurationOptionType = 'string' | 'number' | 'boolean' | 'unset'\nexport class ConfigurationOption {\n  public name: string = '';\n  public defaultValue: unknown = '';\n  public displayName: string = '';\n  public description: string = '';\n  public type: ConfigurationOptionType = 'unset'\n  \n  /**\n   * Set the name of the option. **REQUIRED**\n   * @param name {string} The name of the option. This is used to reference the option in the configuration file.\n   */\n  setName(name: string) {\n    this.name = name;\n    return this;\n  }\n\n  /**\n   * Set the display name of the option. This is used to show the user a human readable version of what the option is. **REQUIRED** \n   * @param displayName {string} The display name of the option. \n   * @returns \n   */\n  setDisplayName(displayName: string) {\n    this.displayName = displayName;\n    return this;\n  }\n\n  /**\n   * Set the description of the option. This is to show the user a brief description of what this option does. **REQUIRED**\n   * @param description {string} The description of the option. \n   * @returns \n   */\n  setDescription(description: string) {\n    this.description = description;\n    return this;\n  }\n\n  /**\n   * Validation code for the option. This is called when the user provides input to the option. If the validation fails, the user will be prompted to provide input again.\n   * @param input {unknown} The input to validate\n   */\n  validate(input: unknown): [ boolean, string ] {\n    throw new Error('Validation code not implemented. Value: ' + input)\n  };\n}\n\nexport class StringOption extends ConfigurationOption {\n  public allowedValues: string[] = [];\n  public minTextLength: number = 0;\n  public maxTextLength: number = Number.MAX_SAFE_INTEGER;\n  public defaultValue: string = '';\n  public inputType: 'text' | 'file' | 'password' | 'folder' = 'text';\n  public type: ConfigurationOptionType = 'string'\n\n  /**\n   * Set the allowed values for the string. If the array is empty, any value is allowed. When provided, the client will act like this option is a dropdown.  \n   * @param allowedValues {string[]} An array of allowed values for the string. If the array is empty, any value is allowed.\n   */\n  setAllowedValues(allowedValues: string[]): this {\n    this.allowedValues = allowedValues;\n    return this;\n  }\n\n  /**\n   * Set the default value for the string. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**\n   * @param defaultValue {string} The default value for the string.\n   */\n  setDefaultValue(defaultValue: string): this {\n    this.defaultValue = defaultValue;\n    return this;\n  }\n\n  /**\n   * Set the minimum text length for the string. If the user provides a string that is less than this value, the validation will fail. \n   * @param minTextLength {number} The minimum text length for the string. \n   */\n  setMinTextLength(minTextLength: number): this {\n    this.minTextLength = minTextLength;\n    return this;\n  }\n\n  /**\n   * Set the maximum text length for the string. If the user provides a string that is greater than this value, the validation will fail. \n   * @param maxTextLength {number} The maximum text length for the string.\n   */\n  setMaxTextLength(maxTextLength: number): this {\n    this.maxTextLength = maxTextLength;\n    return this;\n  }\n\n  /**\n   * Set the input type for the string. This will change how the client renders the input. \n   * @param inputType {'text' | 'file' | 'password' | 'folder'} The input type for the string. \n   */\n  setInputType(inputType: 'text' | 'file' | 'password' | 'folder'): this {\n    this.inputType = inputType;\n    return this;\n  }\n\n  override validate(input: unknown): [ boolean, string ] {\n    if (typeof input !== 'string') {\n      return [ false, 'Input is not a string' ];\n    }\n    if (this.allowedValues.length === 0 && input.length !== 0)\n      return [ true, '' ];\n    if (input.length < this.minTextLength || input.length > this.maxTextLength) {\n      return [ false, 'Input is not within the text length ' + this.minTextLength + ' and ' + this.maxTextLength + ' characters (currently ' + input.length + ' characters)' ];\n    }\n\n    return [ this.allowedValues.includes(input), 'Input is not an allowed value' ];\n  }\n}\n\nexport class NumberOption extends ConfigurationOption {\n  public min: number = 0;\n  public max: number = Number.MAX_SAFE_INTEGER;\n  public defaultValue: number = 0;\n  public type: ConfigurationOptionType = 'number'\n  public inputType: 'range' | 'number' = 'number';\n\n  /**\n   * Set the minimum value for the number. If the user provides a number that is less than this value, the validation will fail.\n   * @param min {number} The minimum value for the number.\n   */\n  setMin(min: number): this {\n    this.min = min;\n    return this;\n  }\n\n  /**\n   * Set the input type for the number. This will change how the client renders the input. \n   * @param type {'range' | 'number'} The input type for the number. \n   */\n  setInputType(type: 'range' | 'number'): this {\n    this.inputType = type;\n    return this;\n  }\n\n  /**\n   * Set the maximum value for the number. If the user provides a number that is greater than this value, the validation will fail.\n   * @param max {number} The maximum value for the number.\n   */\n  setMax(max: number): this {\n    this.max = max;\n    return this\n  }\n\n  /**\n   * Set the default value for the number. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**\n   * @param defaultValue {number} The default value for the number.\n   */\n  setDefaultValue(defaultValue: number): this {\n    this.defaultValue = defaultValue;\n    return this;\n  }\n\n  override validate(input: unknown): [ boolean, string ] {\n    if (isNaN(Number(input))) {\n      return [ false, 'Input is not a number' ];\n    }\n    if (Number(input) < this.min || Number(input) > this.max) {\n      return [ false, 'Input is not within the range of ' + this.min + ' and ' + this.max ];\n    }\n    return [ true, '' ];\n  }\n\n}\n\nexport class BooleanOption extends ConfigurationOption {\n  public type: ConfigurationOptionType = 'boolean'\n  public defaultValue: boolean = false;\n\n  /**\n   * Set the default value for the boolean. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**\n   * @param defaultValue {boolean} The default value for the boolean.\n   */\n  setDefaultValue(defaultValue: boolean): this {\n    this.defaultValue = defaultValue;\n    return this;\n  }\n\n  override validate(input: unknown): [ boolean, string ] {\n    if (typeof input !== 'boolean') {\n      return [ false, 'Input is not a boolean' ];\n    }\n    return [ true, '' ];\n  }\n\n}"],"mappings":";AAAA,OAAO,KAAK,gBAAgB;AAM5B,IAAM,mBAAmB,EAAE,OAAO;AAAA,EAChC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EACtB,aAAa,EAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EAC7B,aAAa,EAAE,OAAO,EAAE,IAAI,CAAC;AAC/B,CAAC;AAEM,SAAS,eAAe,QAAqD;AAChF,SAAO,OAAO,SAAS;AACzB;AAEK,SAAS,eAAe,QAAqD;AAClF,SAAO,OAAO,SAAS;AACzB;AAEO,SAAS,gBAAgB,QAAsD;AACpF,SAAO,OAAO,SAAS;AACzB;AAEO,IAAM,uBAAN,MAA2B;AAAA,EACxB,UAAiC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOnC,gBAAgB,QAAsE;AAC3F,QAAI,YAAY,IAAI,aAAa;AACjC,gBAAY,OAAO,SAAS;AAC5B,SAAK,QAAQ,KAAK,SAAS;AAC3B,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,gBAAgB,QAAgD;AACrE,QAAI,YAAY,IAAI,aAAa;AACjC,gBAAY,OAAO,SAAS;AAC5B,SAAK,QAAQ,KAAK,SAAS;AAC3B,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,iBAAiB,QAAkD;AACxE,QAAI,YAAY,IAAI,cAAc;AAClC,gBAAY,OAAO,SAAS;AAC5B,SAAK,QAAQ,KAAK,SAAS;AAC3B,WAAO;AAAA,EACT;AAAA,EAEO,MAAM,kBAA8C;AACzD,QAAI,SAA4B,CAAC;AACjC,SAAK,QAAQ,QAAQ,YAAU;AAE7B,UAAI,CAAC,kBAAkB;AACrB,iBAAS,KAAK,MAAM,KAAK,UAAU,MAAM,CAAC;AAC1C,cAAM,aAAa,iBAAiB,UAAU,MAAM;AACpD,YAAI,CAAC,WAAW,SAAS;AACvB,gBAAM,IAAI,SAAS,WAAW,MAAM,MAAM;AAAA,QAC5C;AAEA,eAAO,OAAO,IAAI,IAAI;AAAA,MACxB,OACK;AACH,eAAO,OAAO,IAAI,IAAI;AAAA,MACxB;AAAA,IACF,CAAC;AACD,WAAO;AAAA,EACT;AACF;AAGO,IAAM,sBAAN,MAA0B;AAAA,EACxB,OAAe;AAAA,EACf,eAAwB;AAAA,EACxB,cAAsB;AAAA,EACtB,cAAsB;AAAA,EACtB,OAAgC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMvC,QAAQ,MAAc;AACpB,SAAK,OAAO;AACZ,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,eAAe,aAAqB;AAClC,SAAK,cAAc;AACnB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,eAAe,aAAqB;AAClC,SAAK,cAAc;AACnB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAS,OAAqC;AAC5C,UAAM,IAAI,MAAM,6CAA6C,KAAK;AAAA,EACpE;AACF;AAEO,IAAM,eAAN,cAA2B,oBAAoB;AAAA,EAC7C,gBAA0B,CAAC;AAAA,EAC3B,gBAAwB;AAAA,EACxB,gBAAwB,OAAO;AAAA,EAC/B,eAAuB;AAAA,EACvB,YAAqD;AAAA,EACrD,OAAgC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMvC,iBAAiB,eAA+B;AAC9C,SAAK,gBAAgB;AACrB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,gBAAgB,cAA4B;AAC1C,SAAK,eAAe;AACpB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,iBAAiB,eAA6B;AAC5C,SAAK,gBAAgB;AACrB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,iBAAiB,eAA6B;AAC5C,SAAK,gBAAgB;AACrB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,aAAa,WAA0D;AACrE,SAAK,YAAY;AACjB,WAAO;AAAA,EACT;AAAA,EAES,SAAS,OAAqC;AACrD,QAAI,OAAO,UAAU,UAAU;AAC7B,aAAO,CAAE,OAAO,uBAAwB;AAAA,IAC1C;AACA,QAAI,KAAK,cAAc,WAAW,KAAK,MAAM,WAAW;AACtD,aAAO,CAAE,MAAM,EAAG;AACpB,QAAI,MAAM,SAAS,KAAK,iBAAiB,MAAM,SAAS,KAAK,eAAe;AAC1E,aAAO,CAAE,OAAO,yCAAyC,KAAK,gBAAgB,UAAU,KAAK,gBAAgB,4BAA4B,MAAM,SAAS,cAAe;AAAA,IACzK;AAEA,WAAO,CAAE,KAAK,cAAc,SAAS,KAAK,GAAG,+BAAgC;AAAA,EAC/E;AACF;AAEO,IAAM,eAAN,cAA2B,oBAAoB;AAAA,EAC7C,MAAc;AAAA,EACd,MAAc,OAAO;AAAA,EACrB,eAAuB;AAAA,EACvB,OAAgC;AAAA,EAChC,YAAgC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMvC,OAAO,KAAmB;AACxB,SAAK,MAAM;AACX,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,aAAa,MAAgC;AAC3C,SAAK,YAAY;AACjB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAO,KAAmB;AACxB,SAAK,MAAM;AACX,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,gBAAgB,cAA4B;AAC1C,SAAK,eAAe;AACpB,WAAO;AAAA,EACT;AAAA,EAES,SAAS,OAAqC;AACrD,QAAI,MAAM,OAAO,KAAK,CAAC,GAAG;AACxB,aAAO,CAAE,OAAO,uBAAwB;AAAA,IAC1C;AACA,QAAI,OAAO,KAAK,IAAI,KAAK,OAAO,OAAO,KAAK,IAAI,KAAK,KAAK;AACxD,aAAO,CAAE,OAAO,sCAAsC,KAAK,MAAM,UAAU,KAAK,GAAI;AAAA,IACtF;AACA,WAAO,CAAE,MAAM,EAAG;AAAA,EACpB;AAEF;AAEO,IAAM,gBAAN,cAA4B,oBAAoB;AAAA,EAC9C,OAAgC;AAAA,EAChC,eAAwB;AAAA;AAAA;AAAA;AAAA;AAAA,EAM/B,gBAAgB,cAA6B;AAC3C,SAAK,eAAe;AACpB,WAAO;AAAA,EACT;AAAA,EAES,SAAS,OAAqC;AACrD,QAAI,OAAO,UAAU,WAAW;AAC9B,aAAO,CAAE,OAAO,wBAAyB;AAAA,IAC3C;AACA,WAAO,CAAE,MAAM,EAAG;AAAA,EACpB;AAEF;","names":[]}