ogi-addon 1.6.0 → 1.7.0

package/build/config/Configuration.cjs

@@ -304,7 +304,7 @@ var Configuration = class {
     for (const key in this.storedConfigTemplate) {
       if (this.definiteConfig[key] === null || this.definiteConfig[key] === void 0) {
         console.warn(
-          "Option " + key + " is not defined. Using default value Value: " + this.definiteConfig[key]
+          "Option " + key + " is not defined. Using default value Value: " + this.storedConfigTemplate[key].defaultValue
         );
         this.definiteConfig[key] = this.storedConfigTemplate[key].defaultValue;
       }
@@ -319,9 +319,10 @@ var Configuration = class {
       }
     }
     for (const key in this.definiteConfig) {
-      if (!this.storedConfigTemplate[key]) {
-        throw new Error(
-          "Option " + key + " is not defined in the configuration template"
+      if (this.storedConfigTemplate[key] === void 0) {
+        delete this.definiteConfig[key];
+        console.warn(
+          "Option " + key + " is not defined in the configuration template. Removing from config."
         );
       }
     }

package/build/config/Configuration.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/config/Configuration.ts","../../src/config/ConfigurationBuilder.ts"],"sourcesContent":["import {\n  ConfigurationFile,\n  ConfigurationBuilder,\n  BooleanOption,\n  ConfigurationOption,\n  ConfigurationOptionType,\n  NumberOption,\n  StringOption,\n  isBooleanOption,\n  isNumberOption,\n  isStringOption,\n} from './ConfigurationBuilder';\n\ninterface DefiniteConfig {\n  [key: string]: string | number | boolean;\n}\nexport class Configuration {\n  readonly storedConfigTemplate: ConfigurationFile;\n  definiteConfig: DefiniteConfig = {};\n  constructor(configTemplate: ConfigurationFile) {\n    this.storedConfigTemplate = configTemplate;\n  }\n\n  updateConfig(\n    config: DefiniteConfig,\n    validate: boolean = true\n  ): [boolean, { [key: string]: string }] {\n    this.definiteConfig = config;\n    if (validate) {\n      const result = this.validateConfig();\n      return result;\n    }\n    return [true, {}];\n  }\n  // provides falsey or truthy value, and an error message if falsey\n  private validateConfig(): [boolean, { [key: string]: string }] {\n    const erroredKeys = new Map<string, string>();\n    for (const key in this.storedConfigTemplate) {\n      if (\n        this.definiteConfig[key] === null ||\n        this.definiteConfig[key] === undefined\n      ) {\n        console.warn(\n          'Option ' +\n            key +\n            ' is not defined. Using default value Value: ' +\n            this.definiteConfig[key]\n        );\n        this.definiteConfig[key] = this.storedConfigTemplate[key]\n          .defaultValue as string | number | boolean;\n      }\n      if (\n        this.storedConfigTemplate[key].type !== typeof this.definiteConfig[key]\n      ) {\n        throw new Error('Option ' + key + ' is not of the correct type');\n      }\n\n      const result = this.storedConfigTemplate[key].validate(\n        this.definiteConfig[key]\n      );\n      if (!result[0]) {\n        erroredKeys.set(key, result[1]);\n      }\n    }\n\n    for (const key in this.definiteConfig) {\n      if (!this.storedConfigTemplate[key]) {\n        throw new Error(\n          'Option ' + key + ' is not defined in the configuration template'\n        );\n      }\n    }\n\n    if (erroredKeys.size > 0) {\n      return [false, Object.fromEntries(erroredKeys)];\n    }\n\n    return [true, Object.fromEntries(erroredKeys)];\n  }\n\n  getStringValue(optionName: string): string {\n    if (!this.definiteConfig[optionName] === null) {\n      throw new Error('Option ' + optionName + ' is not defined');\n    }\n    if (typeof this.definiteConfig[optionName] !== 'string') {\n      throw new Error('Option ' + optionName + ' is not a string');\n    }\n    return this.definiteConfig[optionName];\n  }\n\n  getNumberValue(optionName: string): number {\n    if (!this.definiteConfig[optionName] === null) {\n      throw new Error('Option ' + optionName + ' is not defined');\n    }\n    if (typeof this.definiteConfig[optionName] !== 'number') {\n      throw new Error('Option ' + optionName + ' is not a number');\n    }\n    return this.definiteConfig[optionName];\n  }\n\n  getBooleanValue(optionName: string): boolean {\n    if (this.definiteConfig[optionName] === null) {\n      throw new Error('Option ' + optionName + ' is not defined');\n    }\n    if (typeof this.definiteConfig[optionName] !== 'boolean') {\n      throw new Error('Option ' + optionName + ' is not a boolean');\n    }\n    return this.definiteConfig[optionName];\n  }\n}\n\nexport {\n  ConfigurationFile,\n  ConfigurationBuilder,\n  BooleanOption,\n  ConfigurationOption,\n  ConfigurationOptionType,\n  NumberOption,\n  StringOption,\n  isBooleanOption,\n  isNumberOption,\n  isStringOption,\n};\n","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;;;ACAA,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;;;ADrRO,IAAM,gBAAN,MAAoB;AAAA,EAChB;AAAA,EACT,iBAAiC,CAAC;AAAA,EAClC,YAAY,gBAAmC;AAC7C,SAAK,uBAAuB;AAAA,EAC9B;AAAA,EAEA,aACE,QACA,WAAoB,MACkB;AACtC,SAAK,iBAAiB;AACtB,QAAI,UAAU;AACZ,YAAM,SAAS,KAAK,eAAe;AACnC,aAAO;AAAA,IACT;AACA,WAAO,CAAC,MAAM,CAAC,CAAC;AAAA,EAClB;AAAA;AAAA,EAEQ,iBAAuD;AAC7D,UAAM,cAAc,oBAAI,IAAoB;AAC5C,eAAW,OAAO,KAAK,sBAAsB;AAC3C,UACE,KAAK,eAAe,GAAG,MAAM,QAC7B,KAAK,eAAe,GAAG,MAAM,QAC7B;AACA,gBAAQ;AAAA,UACN,YACE,MACA,iDACA,KAAK,eAAe,GAAG;AAAA,QAC3B;AACA,aAAK,eAAe,GAAG,IAAI,KAAK,qBAAqB,GAAG,EACrD;AAAA,MACL;AACA,UACE,KAAK,qBAAqB,GAAG,EAAE,SAAS,OAAO,KAAK,eAAe,GAAG,GACtE;AACA,cAAM,IAAI,MAAM,YAAY,MAAM,6BAA6B;AAAA,MACjE;AAEA,YAAM,SAAS,KAAK,qBAAqB,GAAG,EAAE;AAAA,QAC5C,KAAK,eAAe,GAAG;AAAA,MACzB;AACA,UAAI,CAAC,OAAO,CAAC,GAAG;AACd,oBAAY,IAAI,KAAK,OAAO,CAAC,CAAC;AAAA,MAChC;AAAA,IACF;AAEA,eAAW,OAAO,KAAK,gBAAgB;AACrC,UAAI,CAAC,KAAK,qBAAqB,GAAG,GAAG;AACnC,cAAM,IAAI;AAAA,UACR,YAAY,MAAM;AAAA,QACpB;AAAA,MACF;AAAA,IACF;AAEA,QAAI,YAAY,OAAO,GAAG;AACxB,aAAO,CAAC,OAAO,OAAO,YAAY,WAAW,CAAC;AAAA,IAChD;AAEA,WAAO,CAAC,MAAM,OAAO,YAAY,WAAW,CAAC;AAAA,EAC/C;AAAA,EAEA,eAAe,YAA4B;AACzC,QAAI,CAAC,KAAK,eAAe,UAAU,MAAM,MAAM;AAC7C,YAAM,IAAI,MAAM,YAAY,aAAa,iBAAiB;AAAA,IAC5D;AACA,QAAI,OAAO,KAAK,eAAe,UAAU,MAAM,UAAU;AACvD,YAAM,IAAI,MAAM,YAAY,aAAa,kBAAkB;AAAA,IAC7D;AACA,WAAO,KAAK,eAAe,UAAU;AAAA,EACvC;AAAA,EAEA,eAAe,YAA4B;AACzC,QAAI,CAAC,KAAK,eAAe,UAAU,MAAM,MAAM;AAC7C,YAAM,IAAI,MAAM,YAAY,aAAa,iBAAiB;AAAA,IAC5D;AACA,QAAI,OAAO,KAAK,eAAe,UAAU,MAAM,UAAU;AACvD,YAAM,IAAI,MAAM,YAAY,aAAa,kBAAkB;AAAA,IAC7D;AACA,WAAO,KAAK,eAAe,UAAU;AAAA,EACvC;AAAA,EAEA,gBAAgB,YAA6B;AAC3C,QAAI,KAAK,eAAe,UAAU,MAAM,MAAM;AAC5C,YAAM,IAAI,MAAM,YAAY,aAAa,iBAAiB;AAAA,IAC5D;AACA,QAAI,OAAO,KAAK,eAAe,UAAU,MAAM,WAAW;AACxD,YAAM,IAAI,MAAM,YAAY,aAAa,mBAAmB;AAAA,IAC9D;AACA,WAAO,KAAK,eAAe,UAAU;AAAA,EACvC;AACF;","names":["z"]}
+{"version":3,"sources":["../../src/config/Configuration.ts","../../src/config/ConfigurationBuilder.ts"],"sourcesContent":["import {\n  ConfigurationFile,\n  ConfigurationBuilder,\n  BooleanOption,\n  ConfigurationOption,\n  ConfigurationOptionType,\n  NumberOption,\n  StringOption,\n  isBooleanOption,\n  isNumberOption,\n  isStringOption,\n} from './ConfigurationBuilder';\n\ninterface DefiniteConfig {\n  [key: string]: string | number | boolean;\n}\nexport class Configuration {\n  readonly storedConfigTemplate: ConfigurationFile;\n  definiteConfig: DefiniteConfig = {};\n  constructor(configTemplate: ConfigurationFile) {\n    this.storedConfigTemplate = configTemplate;\n  }\n\n  updateConfig(\n    config: DefiniteConfig,\n    validate: boolean = true\n  ): [boolean, { [key: string]: string }] {\n    this.definiteConfig = config;\n    if (validate) {\n      const result = this.validateConfig();\n      return result;\n    }\n    return [true, {}];\n  }\n  // provides falsey or truthy value, and an error message if falsey\n  private validateConfig(): [boolean, { [key: string]: string }] {\n    const erroredKeys = new Map<string, string>();\n    for (const key in this.storedConfigTemplate) {\n      if (\n        this.definiteConfig[key] === null ||\n        this.definiteConfig[key] === undefined\n      ) {\n        console.warn(\n          'Option ' +\n            key +\n            ' is not defined. Using default value Value: ' +\n            this.storedConfigTemplate[key].defaultValue\n        );\n        this.definiteConfig[key] = this.storedConfigTemplate[key]\n          .defaultValue as string | number | boolean;\n      }\n      if (\n        this.storedConfigTemplate[key].type !== typeof this.definiteConfig[key]\n      ) {\n        throw new Error('Option ' + key + ' is not of the correct type');\n      }\n\n      const result = this.storedConfigTemplate[key].validate(\n        this.definiteConfig[key]\n      );\n      if (!result[0]) {\n        erroredKeys.set(key, result[1]);\n      }\n    }\n\n    for (const key in this.definiteConfig) {\n      if (this.storedConfigTemplate[key] === undefined) {\n        // remove the key from the definite config\n        delete this.definiteConfig[key];\n        console.warn(\n          'Option ' +\n            key +\n            ' is not defined in the configuration template. Removing from config.'\n        );\n      }\n    }\n\n    if (erroredKeys.size > 0) {\n      return [false, Object.fromEntries(erroredKeys)];\n    }\n\n    return [true, Object.fromEntries(erroredKeys)];\n  }\n\n  getStringValue(optionName: string): string {\n    if (!this.definiteConfig[optionName] === null) {\n      throw new Error('Option ' + optionName + ' is not defined');\n    }\n    if (typeof this.definiteConfig[optionName] !== 'string') {\n      throw new Error('Option ' + optionName + ' is not a string');\n    }\n    return this.definiteConfig[optionName];\n  }\n\n  getNumberValue(optionName: string): number {\n    if (!this.definiteConfig[optionName] === null) {\n      throw new Error('Option ' + optionName + ' is not defined');\n    }\n    if (typeof this.definiteConfig[optionName] !== 'number') {\n      throw new Error('Option ' + optionName + ' is not a number');\n    }\n    return this.definiteConfig[optionName];\n  }\n\n  getBooleanValue(optionName: string): boolean {\n    if (this.definiteConfig[optionName] === null) {\n      throw new Error('Option ' + optionName + ' is not defined');\n    }\n    if (typeof this.definiteConfig[optionName] !== 'boolean') {\n      throw new Error('Option ' + optionName + ' is not a boolean');\n    }\n    return this.definiteConfig[optionName];\n  }\n}\n\nexport {\n  ConfigurationFile,\n  ConfigurationBuilder,\n  BooleanOption,\n  ConfigurationOption,\n  ConfigurationOptionType,\n  NumberOption,\n  StringOption,\n  isBooleanOption,\n  isNumberOption,\n  isStringOption,\n};\n","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;;;ACAA,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;;;ADrRO,IAAM,gBAAN,MAAoB;AAAA,EAChB;AAAA,EACT,iBAAiC,CAAC;AAAA,EAClC,YAAY,gBAAmC;AAC7C,SAAK,uBAAuB;AAAA,EAC9B;AAAA,EAEA,aACE,QACA,WAAoB,MACkB;AACtC,SAAK,iBAAiB;AACtB,QAAI,UAAU;AACZ,YAAM,SAAS,KAAK,eAAe;AACnC,aAAO;AAAA,IACT;AACA,WAAO,CAAC,MAAM,CAAC,CAAC;AAAA,EAClB;AAAA;AAAA,EAEQ,iBAAuD;AAC7D,UAAM,cAAc,oBAAI,IAAoB;AAC5C,eAAW,OAAO,KAAK,sBAAsB;AAC3C,UACE,KAAK,eAAe,GAAG,MAAM,QAC7B,KAAK,eAAe,GAAG,MAAM,QAC7B;AACA,gBAAQ;AAAA,UACN,YACE,MACA,iDACA,KAAK,qBAAqB,GAAG,EAAE;AAAA,QACnC;AACA,aAAK,eAAe,GAAG,IAAI,KAAK,qBAAqB,GAAG,EACrD;AAAA,MACL;AACA,UACE,KAAK,qBAAqB,GAAG,EAAE,SAAS,OAAO,KAAK,eAAe,GAAG,GACtE;AACA,cAAM,IAAI,MAAM,YAAY,MAAM,6BAA6B;AAAA,MACjE;AAEA,YAAM,SAAS,KAAK,qBAAqB,GAAG,EAAE;AAAA,QAC5C,KAAK,eAAe,GAAG;AAAA,MACzB;AACA,UAAI,CAAC,OAAO,CAAC,GAAG;AACd,oBAAY,IAAI,KAAK,OAAO,CAAC,CAAC;AAAA,MAChC;AAAA,IACF;AAEA,eAAW,OAAO,KAAK,gBAAgB;AACrC,UAAI,KAAK,qBAAqB,GAAG,MAAM,QAAW;AAEhD,eAAO,KAAK,eAAe,GAAG;AAC9B,gBAAQ;AAAA,UACN,YACE,MACA;AAAA,QACJ;AAAA,MACF;AAAA,IACF;AAEA,QAAI,YAAY,OAAO,GAAG;AACxB,aAAO,CAAC,OAAO,OAAO,YAAY,WAAW,CAAC;AAAA,IAChD;AAEA,WAAO,CAAC,MAAM,OAAO,YAAY,WAAW,CAAC;AAAA,EAC/C;AAAA,EAEA,eAAe,YAA4B;AACzC,QAAI,CAAC,KAAK,eAAe,UAAU,MAAM,MAAM;AAC7C,YAAM,IAAI,MAAM,YAAY,aAAa,iBAAiB;AAAA,IAC5D;AACA,QAAI,OAAO,KAAK,eAAe,UAAU,MAAM,UAAU;AACvD,YAAM,IAAI,MAAM,YAAY,aAAa,kBAAkB;AAAA,IAC7D;AACA,WAAO,KAAK,eAAe,UAAU;AAAA,EACvC;AAAA,EAEA,eAAe,YAA4B;AACzC,QAAI,CAAC,KAAK,eAAe,UAAU,MAAM,MAAM;AAC7C,YAAM,IAAI,MAAM,YAAY,aAAa,iBAAiB;AAAA,IAC5D;AACA,QAAI,OAAO,KAAK,eAAe,UAAU,MAAM,UAAU;AACvD,YAAM,IAAI,MAAM,YAAY,aAAa,kBAAkB;AAAA,IAC7D;AACA,WAAO,KAAK,eAAe,UAAU;AAAA,EACvC;AAAA,EAEA,gBAAgB,YAA6B;AAC3C,QAAI,KAAK,eAAe,UAAU,MAAM,MAAM;AAC5C,YAAM,IAAI,MAAM,YAAY,aAAa,iBAAiB;AAAA,IAC5D;AACA,QAAI,OAAO,KAAK,eAAe,UAAU,MAAM,WAAW;AACxD,YAAM,IAAI,MAAM,YAAY,aAAa,mBAAmB;AAAA,IAC9D;AACA,WAAO,KAAK,eAAe,UAAU;AAAA,EACvC;AACF;","names":["z"]}

package/build/config/Configuration.js

@@ -260,7 +260,7 @@ var Configuration = class {
     for (const key in this.storedConfigTemplate) {
       if (this.definiteConfig[key] === null || this.definiteConfig[key] === void 0) {
         console.warn(
-          "Option " + key + " is not defined. Using default value Value: " + this.definiteConfig[key]
+          "Option " + key + " is not defined. Using default value Value: " + this.storedConfigTemplate[key].defaultValue
         );
         this.definiteConfig[key] = this.storedConfigTemplate[key].defaultValue;
       }
@@ -275,9 +275,10 @@ var Configuration = class {
       }
     }
     for (const key in this.definiteConfig) {
-      if (!this.storedConfigTemplate[key]) {
-        throw new Error(
-          "Option " + key + " is not defined in the configuration template"
+      if (this.storedConfigTemplate[key] === void 0) {
+        delete this.definiteConfig[key];
+        console.warn(
+          "Option " + key + " is not defined in the configuration template. Removing from config."
         );
       }
     }

package/build/config/Configuration.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/config/ConfigurationBuilder.ts","../../src/config/Configuration.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","import {\n  ConfigurationFile,\n  ConfigurationBuilder,\n  BooleanOption,\n  ConfigurationOption,\n  ConfigurationOptionType,\n  NumberOption,\n  StringOption,\n  isBooleanOption,\n  isNumberOption,\n  isStringOption,\n} from './ConfigurationBuilder';\n\ninterface DefiniteConfig {\n  [key: string]: string | number | boolean;\n}\nexport class Configuration {\n  readonly storedConfigTemplate: ConfigurationFile;\n  definiteConfig: DefiniteConfig = {};\n  constructor(configTemplate: ConfigurationFile) {\n    this.storedConfigTemplate = configTemplate;\n  }\n\n  updateConfig(\n    config: DefiniteConfig,\n    validate: boolean = true\n  ): [boolean, { [key: string]: string }] {\n    this.definiteConfig = config;\n    if (validate) {\n      const result = this.validateConfig();\n      return result;\n    }\n    return [true, {}];\n  }\n  // provides falsey or truthy value, and an error message if falsey\n  private validateConfig(): [boolean, { [key: string]: string }] {\n    const erroredKeys = new Map<string, string>();\n    for (const key in this.storedConfigTemplate) {\n      if (\n        this.definiteConfig[key] === null ||\n        this.definiteConfig[key] === undefined\n      ) {\n        console.warn(\n          'Option ' +\n            key +\n            ' is not defined. Using default value Value: ' +\n            this.definiteConfig[key]\n        );\n        this.definiteConfig[key] = this.storedConfigTemplate[key]\n          .defaultValue as string | number | boolean;\n      }\n      if (\n        this.storedConfigTemplate[key].type !== typeof this.definiteConfig[key]\n      ) {\n        throw new Error('Option ' + key + ' is not of the correct type');\n      }\n\n      const result = this.storedConfigTemplate[key].validate(\n        this.definiteConfig[key]\n      );\n      if (!result[0]) {\n        erroredKeys.set(key, result[1]);\n      }\n    }\n\n    for (const key in this.definiteConfig) {\n      if (!this.storedConfigTemplate[key]) {\n        throw new Error(\n          'Option ' + key + ' is not defined in the configuration template'\n        );\n      }\n    }\n\n    if (erroredKeys.size > 0) {\n      return [false, Object.fromEntries(erroredKeys)];\n    }\n\n    return [true, Object.fromEntries(erroredKeys)];\n  }\n\n  getStringValue(optionName: string): string {\n    if (!this.definiteConfig[optionName] === null) {\n      throw new Error('Option ' + optionName + ' is not defined');\n    }\n    if (typeof this.definiteConfig[optionName] !== 'string') {\n      throw new Error('Option ' + optionName + ' is not a string');\n    }\n    return this.definiteConfig[optionName];\n  }\n\n  getNumberValue(optionName: string): number {\n    if (!this.definiteConfig[optionName] === null) {\n      throw new Error('Option ' + optionName + ' is not defined');\n    }\n    if (typeof this.definiteConfig[optionName] !== 'number') {\n      throw new Error('Option ' + optionName + ' is not a number');\n    }\n    return this.definiteConfig[optionName];\n  }\n\n  getBooleanValue(optionName: string): boolean {\n    if (this.definiteConfig[optionName] === null) {\n      throw new Error('Option ' + optionName + ' is not defined');\n    }\n    if (typeof this.definiteConfig[optionName] !== 'boolean') {\n      throw new Error('Option ' + optionName + ' is not a boolean');\n    }\n    return this.definiteConfig[optionName];\n  }\n}\n\nexport {\n  ConfigurationFile,\n  ConfigurationBuilder,\n  BooleanOption,\n  ConfigurationOption,\n  ConfigurationOptionType,\n  NumberOption,\n  StringOption,\n  isBooleanOption,\n  isNumberOption,\n  isStringOption,\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;;;ACrRO,IAAM,gBAAN,MAAoB;AAAA,EAChB;AAAA,EACT,iBAAiC,CAAC;AAAA,EAClC,YAAY,gBAAmC;AAC7C,SAAK,uBAAuB;AAAA,EAC9B;AAAA,EAEA,aACE,QACA,WAAoB,MACkB;AACtC,SAAK,iBAAiB;AACtB,QAAI,UAAU;AACZ,YAAM,SAAS,KAAK,eAAe;AACnC,aAAO;AAAA,IACT;AACA,WAAO,CAAC,MAAM,CAAC,CAAC;AAAA,EAClB;AAAA;AAAA,EAEQ,iBAAuD;AAC7D,UAAM,cAAc,oBAAI,IAAoB;AAC5C,eAAW,OAAO,KAAK,sBAAsB;AAC3C,UACE,KAAK,eAAe,GAAG,MAAM,QAC7B,KAAK,eAAe,GAAG,MAAM,QAC7B;AACA,gBAAQ;AAAA,UACN,YACE,MACA,iDACA,KAAK,eAAe,GAAG;AAAA,QAC3B;AACA,aAAK,eAAe,GAAG,IAAI,KAAK,qBAAqB,GAAG,EACrD;AAAA,MACL;AACA,UACE,KAAK,qBAAqB,GAAG,EAAE,SAAS,OAAO,KAAK,eAAe,GAAG,GACtE;AACA,cAAM,IAAI,MAAM,YAAY,MAAM,6BAA6B;AAAA,MACjE;AAEA,YAAM,SAAS,KAAK,qBAAqB,GAAG,EAAE;AAAA,QAC5C,KAAK,eAAe,GAAG;AAAA,MACzB;AACA,UAAI,CAAC,OAAO,CAAC,GAAG;AACd,oBAAY,IAAI,KAAK,OAAO,CAAC,CAAC;AAAA,MAChC;AAAA,IACF;AAEA,eAAW,OAAO,KAAK,gBAAgB;AACrC,UAAI,CAAC,KAAK,qBAAqB,GAAG,GAAG;AACnC,cAAM,IAAI;AAAA,UACR,YAAY,MAAM;AAAA,QACpB;AAAA,MACF;AAAA,IACF;AAEA,QAAI,YAAY,OAAO,GAAG;AACxB,aAAO,CAAC,OAAO,OAAO,YAAY,WAAW,CAAC;AAAA,IAChD;AAEA,WAAO,CAAC,MAAM,OAAO,YAAY,WAAW,CAAC;AAAA,EAC/C;AAAA,EAEA,eAAe,YAA4B;AACzC,QAAI,CAAC,KAAK,eAAe,UAAU,MAAM,MAAM;AAC7C,YAAM,IAAI,MAAM,YAAY,aAAa,iBAAiB;AAAA,IAC5D;AACA,QAAI,OAAO,KAAK,eAAe,UAAU,MAAM,UAAU;AACvD,YAAM,IAAI,MAAM,YAAY,aAAa,kBAAkB;AAAA,IAC7D;AACA,WAAO,KAAK,eAAe,UAAU;AAAA,EACvC;AAAA,EAEA,eAAe,YAA4B;AACzC,QAAI,CAAC,KAAK,eAAe,UAAU,MAAM,MAAM;AAC7C,YAAM,IAAI,MAAM,YAAY,aAAa,iBAAiB;AAAA,IAC5D;AACA,QAAI,OAAO,KAAK,eAAe,UAAU,MAAM,UAAU;AACvD,YAAM,IAAI,MAAM,YAAY,aAAa,kBAAkB;AAAA,IAC7D;AACA,WAAO,KAAK,eAAe,UAAU;AAAA,EACvC;AAAA,EAEA,gBAAgB,YAA6B;AAC3C,QAAI,KAAK,eAAe,UAAU,MAAM,MAAM;AAC5C,YAAM,IAAI,MAAM,YAAY,aAAa,iBAAiB;AAAA,IAC5D;AACA,QAAI,OAAO,KAAK,eAAe,UAAU,MAAM,WAAW;AACxD,YAAM,IAAI,MAAM,YAAY,aAAa,mBAAmB;AAAA,IAC9D;AACA,WAAO,KAAK,eAAe,UAAU;AAAA,EACvC;AACF;","names":[]}
+{"version":3,"sources":["../../src/config/ConfigurationBuilder.ts","../../src/config/Configuration.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","import {\n  ConfigurationFile,\n  ConfigurationBuilder,\n  BooleanOption,\n  ConfigurationOption,\n  ConfigurationOptionType,\n  NumberOption,\n  StringOption,\n  isBooleanOption,\n  isNumberOption,\n  isStringOption,\n} from './ConfigurationBuilder';\n\ninterface DefiniteConfig {\n  [key: string]: string | number | boolean;\n}\nexport class Configuration {\n  readonly storedConfigTemplate: ConfigurationFile;\n  definiteConfig: DefiniteConfig = {};\n  constructor(configTemplate: ConfigurationFile) {\n    this.storedConfigTemplate = configTemplate;\n  }\n\n  updateConfig(\n    config: DefiniteConfig,\n    validate: boolean = true\n  ): [boolean, { [key: string]: string }] {\n    this.definiteConfig = config;\n    if (validate) {\n      const result = this.validateConfig();\n      return result;\n    }\n    return [true, {}];\n  }\n  // provides falsey or truthy value, and an error message if falsey\n  private validateConfig(): [boolean, { [key: string]: string }] {\n    const erroredKeys = new Map<string, string>();\n    for (const key in this.storedConfigTemplate) {\n      if (\n        this.definiteConfig[key] === null ||\n        this.definiteConfig[key] === undefined\n      ) {\n        console.warn(\n          'Option ' +\n            key +\n            ' is not defined. Using default value Value: ' +\n            this.storedConfigTemplate[key].defaultValue\n        );\n        this.definiteConfig[key] = this.storedConfigTemplate[key]\n          .defaultValue as string | number | boolean;\n      }\n      if (\n        this.storedConfigTemplate[key].type !== typeof this.definiteConfig[key]\n      ) {\n        throw new Error('Option ' + key + ' is not of the correct type');\n      }\n\n      const result = this.storedConfigTemplate[key].validate(\n        this.definiteConfig[key]\n      );\n      if (!result[0]) {\n        erroredKeys.set(key, result[1]);\n      }\n    }\n\n    for (const key in this.definiteConfig) {\n      if (this.storedConfigTemplate[key] === undefined) {\n        // remove the key from the definite config\n        delete this.definiteConfig[key];\n        console.warn(\n          'Option ' +\n            key +\n            ' is not defined in the configuration template. Removing from config.'\n        );\n      }\n    }\n\n    if (erroredKeys.size > 0) {\n      return [false, Object.fromEntries(erroredKeys)];\n    }\n\n    return [true, Object.fromEntries(erroredKeys)];\n  }\n\n  getStringValue(optionName: string): string {\n    if (!this.definiteConfig[optionName] === null) {\n      throw new Error('Option ' + optionName + ' is not defined');\n    }\n    if (typeof this.definiteConfig[optionName] !== 'string') {\n      throw new Error('Option ' + optionName + ' is not a string');\n    }\n    return this.definiteConfig[optionName];\n  }\n\n  getNumberValue(optionName: string): number {\n    if (!this.definiteConfig[optionName] === null) {\n      throw new Error('Option ' + optionName + ' is not defined');\n    }\n    if (typeof this.definiteConfig[optionName] !== 'number') {\n      throw new Error('Option ' + optionName + ' is not a number');\n    }\n    return this.definiteConfig[optionName];\n  }\n\n  getBooleanValue(optionName: string): boolean {\n    if (this.definiteConfig[optionName] === null) {\n      throw new Error('Option ' + optionName + ' is not defined');\n    }\n    if (typeof this.definiteConfig[optionName] !== 'boolean') {\n      throw new Error('Option ' + optionName + ' is not a boolean');\n    }\n    return this.definiteConfig[optionName];\n  }\n}\n\nexport {\n  ConfigurationFile,\n  ConfigurationBuilder,\n  BooleanOption,\n  ConfigurationOption,\n  ConfigurationOptionType,\n  NumberOption,\n  StringOption,\n  isBooleanOption,\n  isNumberOption,\n  isStringOption,\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;;;ACrRO,IAAM,gBAAN,MAAoB;AAAA,EAChB;AAAA,EACT,iBAAiC,CAAC;AAAA,EAClC,YAAY,gBAAmC;AAC7C,SAAK,uBAAuB;AAAA,EAC9B;AAAA,EAEA,aACE,QACA,WAAoB,MACkB;AACtC,SAAK,iBAAiB;AACtB,QAAI,UAAU;AACZ,YAAM,SAAS,KAAK,eAAe;AACnC,aAAO;AAAA,IACT;AACA,WAAO,CAAC,MAAM,CAAC,CAAC;AAAA,EAClB;AAAA;AAAA,EAEQ,iBAAuD;AAC7D,UAAM,cAAc,oBAAI,IAAoB;AAC5C,eAAW,OAAO,KAAK,sBAAsB;AAC3C,UACE,KAAK,eAAe,GAAG,MAAM,QAC7B,KAAK,eAAe,GAAG,MAAM,QAC7B;AACA,gBAAQ;AAAA,UACN,YACE,MACA,iDACA,KAAK,qBAAqB,GAAG,EAAE;AAAA,QACnC;AACA,aAAK,eAAe,GAAG,IAAI,KAAK,qBAAqB,GAAG,EACrD;AAAA,MACL;AACA,UACE,KAAK,qBAAqB,GAAG,EAAE,SAAS,OAAO,KAAK,eAAe,GAAG,GACtE;AACA,cAAM,IAAI,MAAM,YAAY,MAAM,6BAA6B;AAAA,MACjE;AAEA,YAAM,SAAS,KAAK,qBAAqB,GAAG,EAAE;AAAA,QAC5C,KAAK,eAAe,GAAG;AAAA,MACzB;AACA,UAAI,CAAC,OAAO,CAAC,GAAG;AACd,oBAAY,IAAI,KAAK,OAAO,CAAC,CAAC;AAAA,MAChC;AAAA,IACF;AAEA,eAAW,OAAO,KAAK,gBAAgB;AACrC,UAAI,KAAK,qBAAqB,GAAG,MAAM,QAAW;AAEhD,eAAO,KAAK,eAAe,GAAG;AAC9B,gBAAQ;AAAA,UACN,YACE,MACA;AAAA,QACJ;AAAA,MACF;AAAA,IACF;AAEA,QAAI,YAAY,OAAO,GAAG;AACxB,aAAO,CAAC,OAAO,OAAO,YAAY,WAAW,CAAC;AAAA,IAChD;AAEA,WAAO,CAAC,MAAM,OAAO,YAAY,WAAW,CAAC;AAAA,EAC/C;AAAA,EAEA,eAAe,YAA4B;AACzC,QAAI,CAAC,KAAK,eAAe,UAAU,MAAM,MAAM;AAC7C,YAAM,IAAI,MAAM,YAAY,aAAa,iBAAiB;AAAA,IAC5D;AACA,QAAI,OAAO,KAAK,eAAe,UAAU,MAAM,UAAU;AACvD,YAAM,IAAI,MAAM,YAAY,aAAa,kBAAkB;AAAA,IAC7D;AACA,WAAO,KAAK,eAAe,UAAU;AAAA,EACvC;AAAA,EAEA,eAAe,YAA4B;AACzC,QAAI,CAAC,KAAK,eAAe,UAAU,MAAM,MAAM;AAC7C,YAAM,IAAI,MAAM,YAAY,aAAa,iBAAiB;AAAA,IAC5D;AACA,QAAI,OAAO,KAAK,eAAe,UAAU,MAAM,UAAU;AACvD,YAAM,IAAI,MAAM,YAAY,aAAa,kBAAkB;AAAA,IAC7D;AACA,WAAO,KAAK,eAAe,UAAU;AAAA,EACvC;AAAA,EAEA,gBAAgB,YAA6B;AAC3C,QAAI,KAAK,eAAe,UAAU,MAAM,MAAM;AAC5C,YAAM,IAAI,MAAM,YAAY,aAAa,iBAAiB;AAAA,IAC5D;AACA,QAAI,OAAO,KAAK,eAAe,UAAU,MAAM,WAAW;AACxD,YAAM,IAAI,MAAM,YAAY,aAAa,mBAAmB;AAAA,IAC9D;AACA,WAAO,KAAK,eAAe,UAAU;AAAA,EACvC;AACF;","names":[]}

package/build/main.cjs

@@ -295,7 +295,7 @@ var Configuration = class {
     for (const key in this.storedConfigTemplate) {
       if (this.definiteConfig[key] === null || this.definiteConfig[key] === void 0) {
         console.warn(
-          "Option " + key + " is not defined. Using default value Value: " + this.definiteConfig[key]
+          "Option " + key + " is not defined. Using default value Value: " + this.storedConfigTemplate[key].defaultValue
         );
         this.definiteConfig[key] = this.storedConfigTemplate[key].defaultValue;
       }
@@ -310,9 +310,10 @@ var Configuration = class {
       }
     }
     for (const key in this.definiteConfig) {
-      if (!this.storedConfigTemplate[key]) {
-        throw new Error(
-          "Option " + key + " is not defined in the configuration template"
+      if (this.storedConfigTemplate[key] === void 0) {
+        delete this.definiteConfig[key];
+        console.warn(
+          "Option " + key + " is not defined in the configuration template. Removing from config."
         );
       }
     }
@@ -418,7 +419,7 @@ var package_default = {
   module: "./build/main.js",
   type: "module",
   main: "./build/main.cjs",
-  version: "1.6.0",
+  version: "1.7.0",
   exports: {
     ".": {
       import: {
@@ -469,6 +470,8 @@ var package_default = {
 };
 
 // src/main.ts
+var import_node_child_process = require("child_process");
+var import_node_fs = __toESM(require("fs"), 1);
 var defaultPort = 7654;
 var VERSION = package_default.version;
 var OGIAddon = class {
@@ -543,6 +546,107 @@ var OGIAddon = class {
     });
     return task;
   }
+  /**
+   * 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 (!import_node_fs.default.existsSync(outputPath)) {
+        import_node_fs.default.mkdirSync(outputPath, { recursive: true });
+      }
+      if (type === "unzip") {
+        if (process.platform === "win32") {
+          const s7ZipPath = '"C:\\Program Files\\7-Zip\\7z.exe"';
+          (0, import_node_child_process.exec)(
+            `${s7ZipPath} x "${path}" -o"${outputPath}"`,
+            (err, stdout, stderr) => {
+              if (err) {
+                console.error(err);
+                console.log(stderr);
+                reject(new Error("Failed to extract ZIP file"));
+                return;
+              }
+              console.log(stdout);
+              console.log(stderr);
+              resolve();
+            }
+          );
+        } else {
+          const unzipProcess = (0, import_node_child_process.spawn)(
+            "unzip",
+            [
+              "-o",
+              // overwrite files without prompting
+              path,
+              "-d",
+              // specify output directory
+              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(new Error("Failed to extract ZIP file"));
+              return;
+            }
+            resolve();
+          });
+        }
+      } else if (type === "unrar") {
+        if (process.platform === "win32") {
+          const s7ZipPath = '"C:\\Program Files\\7-Zip\\7z.exe"';
+          (0, import_node_child_process.exec)(
+            `${s7ZipPath} x "${path}" -o"${outputPath}"`,
+            (err, stdout, stderr) => {
+              if (err) {
+                console.error(err);
+                console.log(stderr);
+                reject(new Error("Failed to extract RAR file"));
+                return;
+              }
+              console.log(stdout);
+              console.log(stderr);
+              resolve();
+            }
+          );
+        } else {
+          const unrarProcess = (0, import_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(new Error("Failed to extract RAR file"));
+              return;
+            }
+            resolve();
+          });
+        }
+      } else {
+        reject(new Error("Unknown extraction type"));
+      }
+    });
+  }
 };
 var CustomTask = class {
   id;
@@ -622,11 +726,42 @@ var OGIAddonWSListener = class {
         secret: process.argv[process.argv.length - 1].split("=")[1],
         ogiVersion: VERSION
       });
-      this.eventEmitter.emit("connect");
       let configBuilder = new ConfigurationBuilder();
       this.eventEmitter.emit("configure", configBuilder);
       this.send("configure", configBuilder.build(false));
       this.addon.config = new Configuration(configBuilder.build(true));
+      const configListener = (event) => {
+        if (event === void 0) return;
+        let data;
+        if (typeof event === "string") {
+          data = event;
+        } else if (event instanceof Buffer) {
+          data = event.toString();
+        } else if (event && typeof event.data === "string") {
+          data = event.data;
+        } else if (event && event.data instanceof Buffer) {
+          data = event.data.toString();
+        } else {
+          data = event.toString();
+        }
+        const message = JSON.parse(data);
+        if (message.event === "config-update") {
+          console.log("Config update received");
+          this.socket.off("message", configListener);
+          this.eventEmitter.emit(
+            "connect",
+            new EventResponse((screen, name, description) => {
+              return this.userInputAsked(
+                screen,
+                name,
+                description,
+                this.socket
+              );
+            })
+          );
+        }
+      };
+      this.socket.on("message", configListener);
     });
     this.socket.on("error", (error) => {
       if (error.message.includes("Failed to connect")) {