ogi-addon 1.9.2 → 1.9.4

package/build/config/ConfigurationBuilder.mjs

@@ -0,0 +1,221 @@
+import z, { ZodError } from "zod";
+
+//#region src/config/ConfigurationBuilder.ts
+const 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, ""];
+	}
+};
+
+//#endregion
+export { BooleanOption, ConfigurationBuilder, ConfigurationOption, NumberOption, StringOption, isBooleanOption, isNumberOption, isStringOption };
+//# sourceMappingURL=ConfigurationBuilder.mjs.map

package/build/config/ConfigurationBuilder.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigurationBuilder.mjs","names":[],"sources":["../../src/config/ConfigurationBuilder.ts"],"sourcesContent":["import z, { ZodError } from 'zod';\n\nexport interface ConfigurationFile {\n  [key: string]: ConfigurationOption;\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":";;;AAMA,MAAM,mBAAmB,EAAE,OAAO;CAChC,MAAM,EAAE,QAAQ,CAAC,IAAI,EAAE;CACvB,aAAa,EAAE,QAAQ,CAAC,IAAI,EAAE;CAC9B,aAAa,EAAE,QAAQ,CAAC,IAAI,EAAE;CAC/B,CAAC;AAEF,SAAgB,eACd,QACwB;AACxB,QAAO,OAAO,SAAS;;AAGzB,SAAgB,eACd,QACwB;AACxB,QAAO,OAAO,SAAS;;AAGzB,SAAgB,gBACd,QACyB;AACzB,QAAO,OAAO,SAAS;;AAGzB,IAAa,uBAAb,MAAkC;CAChC,AAAQ,UAAiC,EAAE;;;;;;CAO3C,AAAO,gBACL,QACsB;EACtB,IAAI,YAAY,IAAI,cAAc;AAClC,cAAY,OAAO,UAAU;AAC7B,OAAK,QAAQ,KAAK,UAAU;AAC5B,SAAO;;;;;;CAOT,AAAO,gBAAgB,QAAgD;EACrE,IAAI,YAAY,IAAI,cAAc;AAClC,cAAY,OAAO,UAAU;AAC7B,OAAK,QAAQ,KAAK,UAAU;AAC5B,SAAO;;;;;;CAOT,AAAO,iBAAiB,QAAkD;EACxE,IAAI,YAAY,IAAI,eAAe;AACnC,cAAY,OAAO,UAAU;AAC7B,OAAK,QAAQ,KAAK,UAAU;AAC5B,SAAO;;CAGT,AAAO,MAAM,kBAA8C;EACzD,IAAI,SAA4B,EAAE;AAClC,OAAK,QAAQ,SAAS,WAAW;AAE/B,OAAI,CAAC,kBAAkB;AACrB,aAAS,KAAK,MAAM,KAAK,UAAU,OAAO,CAAC;IAC3C,MAAM,aAAa,iBAAiB,UAAU,OAAO;AACrD,QAAI,CAAC,WAAW,QACd,OAAM,IAAI,SAAS,WAAW,MAAM,OAAO;AAG7C,WAAO,OAAO,QAAQ;SAEtB,QAAO,OAAO,QAAQ;IAExB;AACF,SAAO;;;AAKX,IAAa,sBAAb,MAAiC;CAC/B,AAAO,OAAe;CACtB,AAAO,eAAwB;CAC/B,AAAO,cAAsB;CAC7B,AAAO,cAAsB;CAC7B,AAAO,OAAgC;;;;;CAMvC,QAAQ,MAAc;AACpB,OAAK,OAAO;AACZ,SAAO;;;;;;;CAQT,eAAe,aAAqB;AAClC,OAAK,cAAc;AACnB,SAAO;;;;;;;CAQT,eAAe,aAAqB;AAClC,OAAK,cAAc;AACnB,SAAO;;;;;;CAOT,SAAS,OAAmC;AAC1C,QAAM,IAAI,MAAM,6CAA6C,MAAM;;;AAIvE,IAAa,eAAb,cAAkC,oBAAoB;CACpD,AAAO,gBAA0B,EAAE;CACnC,AAAO,gBAAwB;CAC/B,AAAO,gBAAwB,OAAO;CACtC,AAAO,eAAuB;CAC9B,AAAO,YAAqD;CAC5D,AAAO,OAAgC;;;;;CAMvC,iBAAiB,eAA+B;AAC9C,OAAK,gBAAgB;AACrB,SAAO;;;;;;CAOT,gBAAgB,cAA4B;AAC1C,OAAK,eAAe;AACpB,SAAO;;;;;;CAOT,iBAAiB,eAA6B;AAC5C,OAAK,gBAAgB;AACrB,SAAO;;;;;;CAOT,iBAAiB,eAA6B;AAC5C,OAAK,gBAAgB;AACrB,SAAO;;;;;;CAOT,aAAa,WAA0D;AACrE,OAAK,YAAY;AACjB,SAAO;;CAGT,AAAS,SAAS,OAAmC;AACnD,MAAI,OAAO,UAAU,SACnB,QAAO,CAAC,OAAO,wBAAwB;AAEzC,MAAI,KAAK,cAAc,WAAW,KAAK,MAAM,WAAW,EACtD,QAAO,CAAC,MAAM,GAAG;AACnB,MACE,MAAM,SAAS,KAAK,iBACpB,MAAM,SAAS,KAAK,cAEpB,QAAO,CACL,OACA,yCACE,KAAK,gBACL,UACA,KAAK,gBACL,4BACA,MAAM,SACN,eACH;AAGH,SAAO,CACL,KAAK,cAAc,SAAS,MAAM,EAClC,gCACD;;;AAIL,IAAa,eAAb,cAAkC,oBAAoB;CACpD,AAAO,MAAc;CACrB,AAAO,MAAc,OAAO;CAC5B,AAAO,eAAuB;CAC9B,AAAO,OAAgC;CACvC,AAAO,YAAgC;;;;;CAMvC,OAAO,KAAmB;AACxB,OAAK,MAAM;AACX,SAAO;;;;;;CAOT,aAAa,MAAgC;AAC3C,OAAK,YAAY;AACjB,SAAO;;;;;;CAOT,OAAO,KAAmB;AACxB,OAAK,MAAM;AACX,SAAO;;;;;;CAOT,gBAAgB,cAA4B;AAC1C,OAAK,eAAe;AACpB,SAAO;;CAGT,AAAS,SAAS,OAAmC;AACnD,MAAI,MAAM,OAAO,MAAM,CAAC,CACtB,QAAO,CAAC,OAAO,wBAAwB;AAEzC,MAAI,OAAO,MAAM,GAAG,KAAK,OAAO,OAAO,MAAM,GAAG,KAAK,IACnD,QAAO,CACL,OACA,sCAAsC,KAAK,MAAM,UAAU,KAAK,IACjE;AAEH,SAAO,CAAC,MAAM,GAAG;;;AAIrB,IAAa,gBAAb,cAAmC,oBAAoB;CACrD,AAAO,OAAgC;CACvC,AAAO,eAAwB;;;;;CAM/B,gBAAgB,cAA6B;AAC3C,OAAK,eAAe;AACpB,SAAO;;CAGT,AAAS,SAAS,OAAmC;AACnD,MAAI,OAAO,UAAU,UACnB,QAAO,CAAC,OAAO,yBAAyB;AAE1C,SAAO,CAAC,MAAM,GAAG"}