@rosen-bridge/config 0.1.0 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @rosen-bridge/config
 
+## 0.2.1
+
+### Patch Changes
+
+- add field validation for boolean type
+
+## 0.2.0
+
+### Minor Changes
+
+- added array type support
+
 ## 0.1.0
 
 ### Minor Changes

package/dist/config.d.ts

@@ -2,130 +2,147 @@ import { IConfig } from 'config';
 import { ConfigField, ConfigSchema } from './schema/types/fields';
 import { When } from './schema/types/validations';
 export declare class ConfigValidator {
-  private schema;
-  constructor(schema: ConfigSchema);
-  /**
-   * validates the passed config against the instance's schema
-   *
-   * @param {Record<string, any>} config
-   */
-  validateConfig(config: Record<string, any>): void;
-  /**
-   * validates a value in config object
-   *
-   * @private
-   * @param {*} value
-   * @param {ConfigField} field the field specification in schema
-   * @param {Record<string, any>} config the config object
-   */
-  private validateValue;
-  /**
-   * determines if a when clause in validations section of a schema field is
-   * satisfied
-   *
-   * @param {When} when
-   * @param {Record<string, any>} config
-   * @return {boolean}
-   */
-  isWhenTrue: (when: When, config: Record<string, any>) => boolean;
-  /**
-   * returns the value at specified path in config object
-   *
-   * @static
-   * @param {Record<string, any>} config
-   * @param {string[]} path
-   * @return {*}
-   */
-  static valueAt: (config: Record<string, any>, path: string[]) => any;
-  /**
-   * validates this.schema and throws exception if any errors found
-   */
-  private validateSchema;
-  /**
-   * validates config key name
-   *
-   * @param {string} name
-   */
-  private validateConfigName;
-  /**
-   * validates passed schema field structure
-   *
-   * @param {ConfigField} field
-   */
-  private validateSchemaField;
-  /**
-   * returns a field corresponding to a path in schema tree
-   *
-   * @param {string[]} path
-   * @return {(ConfigField | undefined)} returns undefined if field is not found
-   */
-  getSchemaField: (path: string[]) => ConfigField | undefined;
-  /**
-   * extracts default values from a schema
-   *
-   * @return {Record<string, any>} object of default values
-   */
-  generateDefault: () => Record<string, any>;
-  /**
-   * generates compatible TypeScript interface for this instance's schema
-   *
-   * @param {string} name the name of root type
-   * @return {string}
-   */
-  generateTSTypes: (name: string) => string;
-  /**
-   * generates a TypeScript interface definition for passed name and attributes
-   *
-   * @param {string} name
-   * @param {Array<[string, string]>} attributes
-   * @return {string}
-   */
-  private genTSInterface;
-  /**
-   * returns a characteristic object for values at a specific node config level
-   *
-   * @param {IConfig} config
-   * @param {string} level
-   * @return {Record<string, any>}
-   */
-  getConfigForLevel(config: IConfig, level: string): Record<string, any>;
-  /**
-   *traverses the config schema depth first to produce characteristic object
-   *
-   * @private
-   * @static
-   * @param {ConfigSchema} schema
-   * @param {string[]} path
-   * @param {IConfigSource[]} higherLevelSources
-   * @param {(IConfigSource | undefined)} currentLevelSource
-   * @param {IConfigSource[]} lowerLevelSources
-   * @return {Record<string, any>}
-   * @memberof ConfigValidator
-   */
-  private static processConfigForLevelNode;
-  /**
-   * returns a list of config sources used by node config package, ordered from
-   * the lowest to the highest priority
-   *
-   * @static
-   * @param {IConfig} config
-   * @return  {string[]}
-   */
-  private static getNodeConfigLevels;
-  /**
-   * validates a config object and writes it to the node-config file
-   * corresponding to the passed level
-   *
-   * @param {Record<string, any>} configObj
-   * @param {IConfig} config
-   * @param {string} level output node-config file level
-   * @param {string} format the format of the output file
-   */
-  validateAndWriteConfig: (
-    configObj: Record<string, any>,
-    config: IConfig,
-    level: string,
-    format: string
-  ) => void;
+    private schema;
+    constructor(schema: ConfigSchema);
+    /**
+     * validates the passed config against the instance's schema
+     *
+     * @param {Record<string, any>} config
+     */
+    validateConfig(config: Record<string, any>): void;
+    /**
+     * traverses and validates a subconfig using the subschema
+     *
+     * @private
+     * @param {Record<string, any>} config
+     * @param {Record<string, any>} subConfig
+     * @param {ConfigSchema} subSchema
+     * @param {string[]} path
+     * @memberof ConfigValidator
+     */
+    private validateSubConfig;
+    /**
+     * sets an object's specific subtree to the specified value
+     *
+     * @static
+     * @param {Record<string, any>} obj
+     * @param {*} newValue
+     * @param {string[]} path
+     * @return {*}
+     * @memberof ConfigValidator
+     */
+    static modifyObject(obj: Record<string, any>, newValue: any, path: string[]): void;
+    /**
+     * validates a value in config object
+     *
+     * @private
+     * @param {*} value
+     * @param {ConfigField} field the field specification in schema
+     * @param {Record<string, any>} config the config object
+     */
+    private validateValue;
+    /**
+     * determines if a when clause in validations section of a schema field is
+     * satisfied
+     *
+     * @param {When} when
+     * @param {Record<string, any>} config
+     * @return {boolean}
+     */
+    isWhenTrue: (when: When, config: Record<string, any>) => boolean;
+    /**
+     * returns the value at specified path in config object
+     *
+     * @static
+     * @param {Record<string, any>} config
+     * @param {string[]} path
+     * @return {*}
+     */
+    static valueAt: (config: Record<string, any>, path: string[]) => any;
+    /**
+     * validates this.schema and throws exception if any errors found
+     */
+    private validateSchema;
+    /**
+     * validates config key name
+     *
+     * @param {string} name
+     */
+    private validateConfigName;
+    /**
+     * validates passed schema field structure
+     *
+     * @param {ConfigField} field
+     */
+    private validateSchemaField;
+    /**
+     * returns a field corresponding to a path in schema tree
+     *
+     * @param {string[]} path
+     * @return {(ConfigField | undefined)} returns undefined if field is not found
+     */
+    getSchemaField: (path: string[]) => ConfigField | undefined;
+    /**
+     * extracts default values from a schema
+     *
+     * @return {Record<string, any>} object of default values
+     */
+    generateDefault: () => Record<string, any>;
+    /**
+     * generates compatible TypeScript interface for this instance's schema
+     *
+     * @param {string} name the name of root type
+     * @return {string}
+     */
+    generateTSTypes: (name: string) => string;
+    /**
+     * generates a TypeScript interface definition for passed name and attributes
+     *
+     * @param {string} name
+     * @param {Array<[string, string]>} attributes
+     * @return {string}
+     */
+    private genTSInterface;
+    /**
+     * returns a characteristic object for values at a specific node config level
+     *
+     * @param {IConfig} config
+     * @param {string} level
+     * @return {Record<string, any>}
+     */
+    getConfigForLevel(config: IConfig, level: string): Record<string, any>;
+    /**
+     *traverses the config schema depth first to produce characteristic object
+     *
+     * @private
+     * @static
+     * @param {ConfigSchema} schema
+     * @param {string[]} path
+     * @param {IConfigSource[]} higherLevelSources
+     * @param {(IConfigSource | undefined)} currentLevelSource
+     * @param {IConfigSource[]} lowerLevelSources
+     * @return {Record<string, any>}
+     * @memberof ConfigValidator
+     */
+    private static processConfigForLevelNode;
+    /**
+     * returns a list of config sources used by node config package, ordered from
+     * the lowest to the highest priority
+     *
+     * @static
+     * @param {IConfig} config
+     * @return  {string[]}
+     */
+    private static getNodeConfigLevels;
+    /**
+     * validates a config object and writes it to the node-config file
+     * corresponding to the passed level
+     *
+     * @param {Record<string, any>} configObj
+     * @param {IConfig} config
+     * @param {string} level output node-config file level
+     * @param {string} format the format of the output file
+     */
+    validateAndWriteConfig: (configObj: Record<string, any>, config: IConfig, level: string, format: string) => void;
 }
-//# sourceMappingURL=config.d.ts.map
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../lib/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAiB,MAAM,QAAQ,CAAC;AAShD,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AAIlD,qBAAa,eAAe;IACd,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,YAAY;IAIxC;;;;OAIG;IACI,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAsDjD;;;;;;;OAOG;IACH,OAAO,CAAC,aAAa,CA+BnB;IAEF;;;;;;;OAOG;IACI,UAAU,SAAU,IAAI,UAAU,OAAO,MAAM,EAAE,GAAG,CAAC,KAAG,OAAO,CAIpE;IAEF;;;;;;;OAOG;IACH,MAAM,CAAC,OAAO,WAAY,OAAO,MAAM,EAAE,GAAG,CAAC,QAAQ,MAAM,EAAE,SAW3D;IAEF;;OAEG;IACH,OAAO,CAAC,cAAc,CAkDpB;IAEF;;;;OAIG;IACH,OAAO,CAAC,kBAAkB,CAIxB;IAEF;;;;OAIG;IACH,OAAO,CAAC,mBAAmB,CA2BzB;IAEF;;;;;OAKG;IACH,cAAc,SAAU,MAAM,EAAE,KAAG,WAAW,GAAG,SAAS,CAYxD;IAEF;;;;OAIG;IACH,eAAe,QAAO,OAAO,MAAM,EAAE,GAAG,CAAC,CAuDvC;IAEF;;;;;OAKG;IACH,eAAe,SAAU,MAAM,KAAG,MAAM,CAwEtC;IAEF;;;;;;OAMG;IACH,OAAO,CAAC,cAAc,CAOpB;IAEF;;;;;;OAMG;IACH,iBAAiB,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAmCtE;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,MAAM,CAAC,yBAAyB;IA6CxC;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAkDhC;IAEF;;;;;;;;OAQG;IACH,sBAAsB,cACT,OAAO,MAAM,EAAE,GAAG,CAAC,UACtB,OAAO,SACR,MAAM,UACL,MAAM,UAyDd;CACH"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../lib/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAiB,MAAM,QAAQ,CAAC;AAShD,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AAIlD,qBAAa,eAAe;IACd,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,YAAY;IAIxC;;;;OAIG;IACI,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAUjD;;;;;;;;;OASG;IACH,OAAO,CAAC,iBAAiB;IA0CzB;;;;;;;;;OASG;IACH,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE;IAgB3E;;;;;;;OAOG;IACH,OAAO,CAAC,aAAa,CAmCnB;IAEF;;;;;;;OAOG;IACI,UAAU,SAAU,IAAI,UAAU,OAAO,MAAM,EAAE,GAAG,CAAC,KAAG,OAAO,CAIpE;IAEF;;;;;;;OAOG;IACH,MAAM,CAAC,OAAO,WAAY,OAAO,MAAM,EAAE,GAAG,CAAC,QAAQ,MAAM,EAAE,SAW3D;IAEF;;OAEG;IACH,OAAO,CAAC,cAAc,CAuDpB;IAEF;;;;OAIG;IACH,OAAO,CAAC,kBAAkB,CAIxB;IAEF;;;;OAIG;IACH,OAAO,CAAC,mBAAmB,CA2BzB;IAEF;;;;;OAKG;IACH,cAAc,SAAU,MAAM,EAAE,KAAG,WAAW,GAAG,SAAS,CAiBxD;IAEF;;;;OAIG;IACH,eAAe,QAAO,OAAO,MAAM,EAAE,GAAG,CAAC,CAuDvC;IAEF;;;;;OAKG;IACH,eAAe,SAAU,MAAM,KAAG,MAAM,CAsGtC;IAEF;;;;;;OAMG;IACH,OAAO,CAAC,cAAc,CAOpB;IAEF;;;;;;OAMG;IACH,iBAAiB,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAmCtE;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,MAAM,CAAC,yBAAyB;IA6CxC;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAkDhC;IAEF;;;;;;;;OAQG;IACH,sBAAsB,cACT,OAAO,MAAM,EAAE,GAAG,CAAC,UACtB,OAAO,SACR,MAAM,UACL,MAAM,UAyDd;CACH"}