ogi-addon 1.9.3 → 1.9.5

package/build/config/ConfigurationBuilder.cjs.map

@@ -1 +0,0 @@
-{"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(\n  option: ConfigurationOption\n): option is StringOption {\n  return option.type === 'string';\n}\n\nexport function isNumberOption(\n  option: ConfigurationOption\n): option is NumberOption {\n  return option.type === 'number';\n}\n\nexport function isBooleanOption(\n  option: ConfigurationOption\n): option is BooleanOption {\n  return option.type === 'boolean';\n}\n\nexport class ConfigurationBuilder {\n  private options: ConfigurationOption[] = [];\n\n  /**\n   * Add a number option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.\n   * @param option { (option: NumberOption) => NumberOption }\n   * @returns\n   */\n  public addNumberOption(\n    option: (option: NumberOption) => NumberOption\n  ): ConfigurationBuilder {\n    let newOption = new NumberOption();\n    newOption = option(newOption);\n    this.options.push(newOption);\n    return this;\n  }\n\n  /**\n   * Add a string option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.\n   * @param option { (option: StringOption) => StringOption }\n   */\n  public addStringOption(option: (option: StringOption) => StringOption) {\n    let newOption = new StringOption();\n    newOption = option(newOption);\n    this.options.push(newOption);\n    return this;\n  }\n\n  /**\n   * Add a boolean option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.\n   * @param option { (option: BooleanOption) => BooleanOption }\n   */\n  public addBooleanOption(option: (option: BooleanOption) => BooleanOption) {\n    let newOption = new BooleanOption();\n    newOption = option(newOption);\n    this.options.push(newOption);\n    return this;\n  }\n\n  public build(includeFunctions: boolean): ConfigurationFile {\n    let config: ConfigurationFile = {};\n    this.options.forEach((option) => {\n      // remove all functions from the option object\n      if (!includeFunctions) {\n        option = JSON.parse(JSON.stringify(option));\n        const optionData = configValidation.safeParse(option);\n        if (!optionData.success) {\n          throw new ZodError(optionData.error.errors);\n        }\n\n        config[option.name] = option;\n      } else {\n        config[option.name] = option;\n      }\n    });\n    return config;\n  }\n}\n\nexport type ConfigurationOptionType = 'string' | 'number' | 'boolean' | 'unset';\nexport class ConfigurationOption {\n  public name: string = '';\n  public defaultValue: unknown = '';\n  public displayName: string = '';\n  public description: string = '';\n  public type: ConfigurationOptionType = 'unset';\n\n  /**\n   * Set the name of the option. **REQUIRED**\n   * @param name {string} The name of the option. This is used to reference the option in the configuration file.\n   */\n  setName(name: string) {\n    this.name = name;\n    return this;\n  }\n\n  /**\n   * Set the display name of the option. This is used to show the user a human readable version of what the option is. **REQUIRED**\n   * @param displayName {string} The display name of the option.\n   * @returns\n   */\n  setDisplayName(displayName: string) {\n    this.displayName = displayName;\n    return this;\n  }\n\n  /**\n   * Set the description of the option. This is to show the user a brief description of what this option does. **REQUIRED**\n   * @param description {string} The description of the option.\n   * @returns\n   */\n  setDescription(description: string) {\n    this.description = description;\n    return this;\n  }\n\n  /**\n   * Validation code for the option. This is called when the user provides input to the option. If the validation fails, the user will be prompted to provide input again.\n   * @param input {unknown} The input to validate\n   */\n  validate(input: unknown): [boolean, string] {\n    throw new Error('Validation code not implemented. Value: ' + input);\n  }\n}\n\nexport class StringOption extends ConfigurationOption {\n  public allowedValues: string[] = [];\n  public minTextLength: number = 0;\n  public maxTextLength: number = Number.MAX_SAFE_INTEGER;\n  public defaultValue: string = '';\n  public inputType: 'text' | 'file' | 'password' | 'folder' = 'text';\n  public type: ConfigurationOptionType = 'string';\n\n  /**\n   * Set the allowed values for the string. If the array is empty, any value is allowed. When provided, the client will act like this option is a dropdown.\n   * @param allowedValues {string[]} An array of allowed values for the string. If the array is empty, any value is allowed.\n   */\n  setAllowedValues(allowedValues: string[]): this {\n    this.allowedValues = allowedValues;\n    return this;\n  }\n\n  /**\n   * Set the default value for the string. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**\n   * @param defaultValue {string} The default value for the string.\n   */\n  setDefaultValue(defaultValue: string): this {\n    this.defaultValue = defaultValue;\n    return this;\n  }\n\n  /**\n   * Set the minimum text length for the string. If the user provides a string that is less than this value, the validation will fail.\n   * @param minTextLength {number} The minimum text length for the string.\n   */\n  setMinTextLength(minTextLength: number): this {\n    this.minTextLength = minTextLength;\n    return this;\n  }\n\n  /**\n   * Set the maximum text length for the string. If the user provides a string that is greater than this value, the validation will fail.\n   * @param maxTextLength {number} The maximum text length for the string.\n   */\n  setMaxTextLength(maxTextLength: number): this {\n    this.maxTextLength = maxTextLength;\n    return this;\n  }\n\n  /**\n   * Set the input type for the string. This will change how the client renders the input.\n   * @param inputType {'text' | 'file' | 'password' | 'folder'} The input type for the string.\n   */\n  setInputType(inputType: 'text' | 'file' | 'password' | 'folder'): this {\n    this.inputType = inputType;\n    return this;\n  }\n\n  override validate(input: unknown): [boolean, string] {\n    if (typeof input !== 'string') {\n      return [false, 'Input is not a string'];\n    }\n    if (this.allowedValues.length === 0 && input.length !== 0)\n      return [true, ''];\n    if (\n      input.length < this.minTextLength ||\n      input.length > this.maxTextLength\n    ) {\n      return [\n        false,\n        'Input is not within the text length ' +\n          this.minTextLength +\n          ' and ' +\n          this.maxTextLength +\n          ' characters (currently ' +\n          input.length +\n          ' characters)',\n      ];\n    }\n\n    return [\n      this.allowedValues.includes(input),\n      'Input is not an allowed value',\n    ];\n  }\n}\n\nexport class NumberOption extends ConfigurationOption {\n  public min: number = 0;\n  public max: number = Number.MAX_SAFE_INTEGER;\n  public defaultValue: number = 0;\n  public type: ConfigurationOptionType = 'number';\n  public inputType: 'range' | 'number' = 'number';\n\n  /**\n   * Set the minimum value for the number. If the user provides a number that is less than this value, the validation will fail.\n   * @param min {number} The minimum value for the number.\n   */\n  setMin(min: number): this {\n    this.min = min;\n    return this;\n  }\n\n  /**\n   * Set the input type for the number. This will change how the client renders the input.\n   * @param type {'range' | 'number'} The input type for the number.\n   */\n  setInputType(type: 'range' | 'number'): this {\n    this.inputType = type;\n    return this;\n  }\n\n  /**\n   * Set the maximum value for the number. If the user provides a number that is greater than this value, the validation will fail.\n   * @param max {number} The maximum value for the number.\n   */\n  setMax(max: number): this {\n    this.max = max;\n    return this;\n  }\n\n  /**\n   * Set the default value for the number. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**\n   * @param defaultValue {number} The default value for the number.\n   */\n  setDefaultValue(defaultValue: number): this {\n    this.defaultValue = defaultValue;\n    return this;\n  }\n\n  override validate(input: unknown): [boolean, string] {\n    if (isNaN(Number(input))) {\n      return [false, 'Input is not a number'];\n    }\n    if (Number(input) < this.min || Number(input) > this.max) {\n      return [\n        false,\n        'Input is not within the range of ' + this.min + ' and ' + this.max,\n      ];\n    }\n    return [true, ''];\n  }\n}\n\nexport class BooleanOption extends ConfigurationOption {\n  public type: ConfigurationOptionType = 'boolean';\n  public defaultValue: boolean = false;\n\n  /**\n   * Set the default value for the boolean. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**\n   * @param defaultValue {boolean} The default value for the boolean.\n   */\n  setDefaultValue(defaultValue: boolean): this {\n    this.defaultValue = defaultValue;\n    return this;\n  }\n\n  override validate(input: unknown): [boolean, string] {\n    if (typeof input !== 'boolean') {\n      return [false, 'Input is not a boolean'];\n    }\n    return [true, ''];\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,iBAA4B;AAM5B,IAAM,mBAAmB,WAAAA,QAAE,OAAO;AAAA,EAChC,MAAM,WAAAA,QAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EACtB,aAAa,WAAAA,QAAE,OAAO,EAAE,IAAI,CAAC;AAAA,EAC7B,aAAa,WAAAA,QAAE,OAAO,EAAE,IAAI,CAAC;AAC/B,CAAC;AAEM,SAAS,eACd,QACwB;AACxB,SAAO,OAAO,SAAS;AACzB;AAEO,SAAS,eACd,QACwB;AACxB,SAAO,OAAO,SAAS;AACzB;AAEO,SAAS,gBACd,QACyB;AACzB,SAAO,OAAO,SAAS;AACzB;AAEO,IAAM,uBAAN,MAA2B;AAAA,EACxB,UAAiC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOnC,gBACL,QACsB;AACtB,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,CAAC,WAAW;AAE/B,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,oBAAS,WAAW,MAAM,MAAM;AAAA,QAC5C;AAEA,eAAO,OAAO,IAAI,IAAI;AAAA,MACxB,OAAO;AACL,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,OAAmC;AAC1C,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,OAAmC;AACnD,QAAI,OAAO,UAAU,UAAU;AAC7B,aAAO,CAAC,OAAO,uBAAuB;AAAA,IACxC;AACA,QAAI,KAAK,cAAc,WAAW,KAAK,MAAM,WAAW;AACtD,aAAO,CAAC,MAAM,EAAE;AAClB,QACE,MAAM,SAAS,KAAK,iBACpB,MAAM,SAAS,KAAK,eACpB;AACA,aAAO;AAAA,QACL;AAAA,QACA,yCACE,KAAK,gBACL,UACA,KAAK,gBACL,4BACA,MAAM,SACN;AAAA,MACJ;AAAA,IACF;AAEA,WAAO;AAAA,MACL,KAAK,cAAc,SAAS,KAAK;AAAA,MACjC;AAAA,IACF;AAAA,EACF;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,OAAmC;AACnD,QAAI,MAAM,OAAO,KAAK,CAAC,GAAG;AACxB,aAAO,CAAC,OAAO,uBAAuB;AAAA,IACxC;AACA,QAAI,OAAO,KAAK,IAAI,KAAK,OAAO,OAAO,KAAK,IAAI,KAAK,KAAK;AACxD,aAAO;AAAA,QACL;AAAA,QACA,sCAAsC,KAAK,MAAM,UAAU,KAAK;AAAA,MAClE;AAAA,IACF;AACA,WAAO,CAAC,MAAM,EAAE;AAAA,EAClB;AACF;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,OAAmC;AACnD,QAAI,OAAO,UAAU,WAAW;AAC9B,aAAO,CAAC,OAAO,wBAAwB;AAAA,IACzC;AACA,WAAO,CAAC,MAAM,EAAE;AAAA,EAClB;AACF;","names":["z"]}

package/build/config/ConfigurationBuilder.d.ts

@@ -1,130 +0,0 @@
-interface ConfigurationFile {
-    [key: string]: ConfigurationOption;
-}
-declare function isStringOption(option: ConfigurationOption): option is StringOption;
-declare function isNumberOption(option: ConfigurationOption): option is NumberOption;
-declare function isBooleanOption(option: ConfigurationOption): option is BooleanOption;
-declare class ConfigurationBuilder {
-    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;
-}
-type ConfigurationOptionType = 'string' | 'number' | 'boolean' | 'unset';
-declare class ConfigurationOption {
-    name: string;
-    defaultValue: unknown;
-    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 {
-    allowedValues: string[];
-    minTextLength: number;
-    maxTextLength: number;
-    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];
-}
-declare class NumberOption extends ConfigurationOption {
-    min: number;
-    max: number;
-    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];
-}
-
-export { BooleanOption, ConfigurationBuilder, type ConfigurationFile, ConfigurationOption, type ConfigurationOptionType, NumberOption, StringOption, isBooleanOption, isNumberOption, isStringOption };

package/build/config/ConfigurationBuilder.js

@@ -1,251 +0,0 @@
-// src/config/ConfigurationBuilder.ts
-import z, { ZodError } from "zod";
-var configValidation = z.object({
-  name: z.string().min(1),
-  displayName: z.string().min(1),
-  description: z.string().min(1)
-});
-function isStringOption(option) {
-  return option.type === "string";
-}
-function isNumberOption(option) {
-  return option.type === "number";
-}
-function isBooleanOption(option) {
-  return option.type === "boolean";
-}
-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);
-    this.options.push(newOption);
-    return this;
-  }
-  build(includeFunctions) {
-    let config = {};
-    this.options.forEach((option) => {
-      if (!includeFunctions) {
-        option = JSON.parse(JSON.stringify(option));
-        const optionData = configValidation.safeParse(option);
-        if (!optionData.success) {
-          throw new ZodError(optionData.error.errors);
-        }
-        config[option.name] = option;
-      } else {
-        config[option.name] = option;
-      }
-    });
-    return config;
-  }
-};
-var ConfigurationOption = class {
-  name = "";
-  defaultValue = "";
-  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);
-  }
-};
-var StringOption = class extends ConfigurationOption {
-  allowedValues = [];
-  minTextLength = 0;
-  maxTextLength = Number.MAX_SAFE_INTEGER;
-  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;
-  }
-  validate(input) {
-    if (typeof input !== "string") {
-      return [false, "Input is not a string"];
-    }
-    if (this.allowedValues.length === 0 && input.length !== 0)
-      return [true, ""];
-    if (input.length < this.minTextLength || input.length > this.maxTextLength) {
-      return [
-        false,
-        "Input is not within the text length " + this.minTextLength + " and " + this.maxTextLength + " characters (currently " + input.length + " characters)"
-      ];
-    }
-    return [
-      this.allowedValues.includes(input),
-      "Input is not an allowed value"
-    ];
-  }
-};
-var NumberOption = class extends ConfigurationOption {
-  min = 0;
-  max = Number.MAX_SAFE_INTEGER;
-  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;
-  }
-  validate(input) {
-    if (isNaN(Number(input))) {
-      return [false, "Input is not a number"];
-    }
-    if (Number(input) < this.min || Number(input) > this.max) {
-      return [
-        false,
-        "Input is not within the range of " + this.min + " and " + this.max
-      ];
-    }
-    return [true, ""];
-  }
-};
-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;
-  }
-  validate(input) {
-    if (typeof input !== "boolean") {
-      return [false, "Input is not a boolean"];
-    }
-    return [true, ""];
-  }
-};
-export {
-  BooleanOption,
-  ConfigurationBuilder,
-  ConfigurationOption,
-  NumberOption,
-  StringOption,
-  isBooleanOption,
-  isNumberOption,
-  isStringOption
-};
-//# sourceMappingURL=ConfigurationBuilder.js.map

package/build/config/ConfigurationBuilder.js.map

@@ -1 +0,0 @@
-{"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(\n  option: ConfigurationOption\n): option is StringOption {\n  return option.type === 'string';\n}\n\nexport function isNumberOption(\n  option: ConfigurationOption\n): option is NumberOption {\n  return option.type === 'number';\n}\n\nexport function isBooleanOption(\n  option: ConfigurationOption\n): option is BooleanOption {\n  return option.type === 'boolean';\n}\n\nexport class ConfigurationBuilder {\n  private options: ConfigurationOption[] = [];\n\n  /**\n   * Add a number option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.\n   * @param option { (option: NumberOption) => NumberOption }\n   * @returns\n   */\n  public addNumberOption(\n    option: (option: NumberOption) => NumberOption\n  ): ConfigurationBuilder {\n    let newOption = new NumberOption();\n    newOption = option(newOption);\n    this.options.push(newOption);\n    return this;\n  }\n\n  /**\n   * Add a string option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.\n   * @param option { (option: StringOption) => StringOption }\n   */\n  public addStringOption(option: (option: StringOption) => StringOption) {\n    let newOption = new StringOption();\n    newOption = option(newOption);\n    this.options.push(newOption);\n    return this;\n  }\n\n  /**\n   * Add a boolean option to the configuration builder and return the builder for chaining. You must provide a name, display name, and description for the option.\n   * @param option { (option: BooleanOption) => BooleanOption }\n   */\n  public addBooleanOption(option: (option: BooleanOption) => BooleanOption) {\n    let newOption = new BooleanOption();\n    newOption = option(newOption);\n    this.options.push(newOption);\n    return this;\n  }\n\n  public build(includeFunctions: boolean): ConfigurationFile {\n    let config: ConfigurationFile = {};\n    this.options.forEach((option) => {\n      // remove all functions from the option object\n      if (!includeFunctions) {\n        option = JSON.parse(JSON.stringify(option));\n        const optionData = configValidation.safeParse(option);\n        if (!optionData.success) {\n          throw new ZodError(optionData.error.errors);\n        }\n\n        config[option.name] = option;\n      } else {\n        config[option.name] = option;\n      }\n    });\n    return config;\n  }\n}\n\nexport type ConfigurationOptionType = 'string' | 'number' | 'boolean' | 'unset';\nexport class ConfigurationOption {\n  public name: string = '';\n  public defaultValue: unknown = '';\n  public displayName: string = '';\n  public description: string = '';\n  public type: ConfigurationOptionType = 'unset';\n\n  /**\n   * Set the name of the option. **REQUIRED**\n   * @param name {string} The name of the option. This is used to reference the option in the configuration file.\n   */\n  setName(name: string) {\n    this.name = name;\n    return this;\n  }\n\n  /**\n   * Set the display name of the option. This is used to show the user a human readable version of what the option is. **REQUIRED**\n   * @param displayName {string} The display name of the option.\n   * @returns\n   */\n  setDisplayName(displayName: string) {\n    this.displayName = displayName;\n    return this;\n  }\n\n  /**\n   * Set the description of the option. This is to show the user a brief description of what this option does. **REQUIRED**\n   * @param description {string} The description of the option.\n   * @returns\n   */\n  setDescription(description: string) {\n    this.description = description;\n    return this;\n  }\n\n  /**\n   * Validation code for the option. This is called when the user provides input to the option. If the validation fails, the user will be prompted to provide input again.\n   * @param input {unknown} The input to validate\n   */\n  validate(input: unknown): [boolean, string] {\n    throw new Error('Validation code not implemented. Value: ' + input);\n  }\n}\n\nexport class StringOption extends ConfigurationOption {\n  public allowedValues: string[] = [];\n  public minTextLength: number = 0;\n  public maxTextLength: number = Number.MAX_SAFE_INTEGER;\n  public defaultValue: string = '';\n  public inputType: 'text' | 'file' | 'password' | 'folder' = 'text';\n  public type: ConfigurationOptionType = 'string';\n\n  /**\n   * Set the allowed values for the string. If the array is empty, any value is allowed. When provided, the client will act like this option is a dropdown.\n   * @param allowedValues {string[]} An array of allowed values for the string. If the array is empty, any value is allowed.\n   */\n  setAllowedValues(allowedValues: string[]): this {\n    this.allowedValues = allowedValues;\n    return this;\n  }\n\n  /**\n   * Set the default value for the string. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**\n   * @param defaultValue {string} The default value for the string.\n   */\n  setDefaultValue(defaultValue: string): this {\n    this.defaultValue = defaultValue;\n    return this;\n  }\n\n  /**\n   * Set the minimum text length for the string. If the user provides a string that is less than this value, the validation will fail.\n   * @param minTextLength {number} The minimum text length for the string.\n   */\n  setMinTextLength(minTextLength: number): this {\n    this.minTextLength = minTextLength;\n    return this;\n  }\n\n  /**\n   * Set the maximum text length for the string. If the user provides a string that is greater than this value, the validation will fail.\n   * @param maxTextLength {number} The maximum text length for the string.\n   */\n  setMaxTextLength(maxTextLength: number): this {\n    this.maxTextLength = maxTextLength;\n    return this;\n  }\n\n  /**\n   * Set the input type for the string. This will change how the client renders the input.\n   * @param inputType {'text' | 'file' | 'password' | 'folder'} The input type for the string.\n   */\n  setInputType(inputType: 'text' | 'file' | 'password' | 'folder'): this {\n    this.inputType = inputType;\n    return this;\n  }\n\n  override validate(input: unknown): [boolean, string] {\n    if (typeof input !== 'string') {\n      return [false, 'Input is not a string'];\n    }\n    if (this.allowedValues.length === 0 && input.length !== 0)\n      return [true, ''];\n    if (\n      input.length < this.minTextLength ||\n      input.length > this.maxTextLength\n    ) {\n      return [\n        false,\n        'Input is not within the text length ' +\n          this.minTextLength +\n          ' and ' +\n          this.maxTextLength +\n          ' characters (currently ' +\n          input.length +\n          ' characters)',\n      ];\n    }\n\n    return [\n      this.allowedValues.includes(input),\n      'Input is not an allowed value',\n    ];\n  }\n}\n\nexport class NumberOption extends ConfigurationOption {\n  public min: number = 0;\n  public max: number = Number.MAX_SAFE_INTEGER;\n  public defaultValue: number = 0;\n  public type: ConfigurationOptionType = 'number';\n  public inputType: 'range' | 'number' = 'number';\n\n  /**\n   * Set the minimum value for the number. If the user provides a number that is less than this value, the validation will fail.\n   * @param min {number} The minimum value for the number.\n   */\n  setMin(min: number): this {\n    this.min = min;\n    return this;\n  }\n\n  /**\n   * Set the input type for the number. This will change how the client renders the input.\n   * @param type {'range' | 'number'} The input type for the number.\n   */\n  setInputType(type: 'range' | 'number'): this {\n    this.inputType = type;\n    return this;\n  }\n\n  /**\n   * Set the maximum value for the number. If the user provides a number that is greater than this value, the validation will fail.\n   * @param max {number} The maximum value for the number.\n   */\n  setMax(max: number): this {\n    this.max = max;\n    return this;\n  }\n\n  /**\n   * Set the default value for the number. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**\n   * @param defaultValue {number} The default value for the number.\n   */\n  setDefaultValue(defaultValue: number): this {\n    this.defaultValue = defaultValue;\n    return this;\n  }\n\n  override validate(input: unknown): [boolean, string] {\n    if (isNaN(Number(input))) {\n      return [false, 'Input is not a number'];\n    }\n    if (Number(input) < this.min || Number(input) > this.max) {\n      return [\n        false,\n        'Input is not within the range of ' + this.min + ' and ' + this.max,\n      ];\n    }\n    return [true, ''];\n  }\n}\n\nexport class BooleanOption extends ConfigurationOption {\n  public type: ConfigurationOptionType = 'boolean';\n  public defaultValue: boolean = false;\n\n  /**\n   * Set the default value for the boolean. This value will be used if the user does not provide a value. **HIGHLY RECOMMENDED**\n   * @param defaultValue {boolean} The default value for the boolean.\n   */\n  setDefaultValue(defaultValue: boolean): this {\n    this.defaultValue = defaultValue;\n    return this;\n  }\n\n  override validate(input: unknown): [boolean, string] {\n    if (typeof input !== 'boolean') {\n      return [false, 'Input is not a boolean'];\n    }\n    return [true, ''];\n  }\n}\n"],"mappings":";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,eACd,QACwB;AACxB,SAAO,OAAO,SAAS;AACzB;AAEO,SAAS,eACd,QACwB;AACxB,SAAO,OAAO,SAAS;AACzB;AAEO,SAAS,gBACd,QACyB;AACzB,SAAO,OAAO,SAAS;AACzB;AAEO,IAAM,uBAAN,MAA2B;AAAA,EACxB,UAAiC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOnC,gBACL,QACsB;AACtB,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,CAAC,WAAW;AAE/B,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,OAAO;AACL,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,OAAmC;AAC1C,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,OAAmC;AACnD,QAAI,OAAO,UAAU,UAAU;AAC7B,aAAO,CAAC,OAAO,uBAAuB;AAAA,IACxC;AACA,QAAI,KAAK,cAAc,WAAW,KAAK,MAAM,WAAW;AACtD,aAAO,CAAC,MAAM,EAAE;AAClB,QACE,MAAM,SAAS,KAAK,iBACpB,MAAM,SAAS,KAAK,eACpB;AACA,aAAO;AAAA,QACL;AAAA,QACA,yCACE,KAAK,gBACL,UACA,KAAK,gBACL,4BACA,MAAM,SACN;AAAA,MACJ;AAAA,IACF;AAEA,WAAO;AAAA,MACL,KAAK,cAAc,SAAS,KAAK;AAAA,MACjC;AAAA,IACF;AAAA,EACF;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,OAAmC;AACnD,QAAI,MAAM,OAAO,KAAK,CAAC,GAAG;AACxB,aAAO,CAAC,OAAO,uBAAuB;AAAA,IACxC;AACA,QAAI,OAAO,KAAK,IAAI,KAAK,OAAO,OAAO,KAAK,IAAI,KAAK,KAAK;AACxD,aAAO;AAAA,QACL;AAAA,QACA,sCAAsC,KAAK,MAAM,UAAU,KAAK;AAAA,MAClE;AAAA,IACF;AACA,WAAO,CAAC,MAAM,EAAE;AAAA,EAClB;AACF;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,OAAmC;AACnD,QAAI,OAAO,UAAU,WAAW;AAC9B,aAAO,CAAC,OAAO,wBAAwB;AAAA,IACzC;AACA,WAAO,CAAC,MAAM,EAAE;AAAA,EAClB;AACF;","names":[]}