@rosen-bridge/config 2.0.0 → 2.1.0-411c498c

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @rosen-bridge/config
 
+## 2.1.0-411c498c
+
+### Minor Changes
+
+- Add supporting union type in config
+
 ## 2.0.0
 
 ### Major Changes

package/dist/config.d.ts

@@ -5,19 +5,12 @@ export declare class ConfigValidator {
     private schema;
     private constructor();
     /**
-     * Builds the final configuration object
+     * Builds and returns the final configuration object by transforming and validating
      *
-     * @returns {Record<string, any>} The normalized configuration object
+     *  T - The type of the final normalized configuration object.
+     * @returns {T} The normalized configuration object
      */
-    buildConfigs: () => Record<string, any>;
-    /**
-     * Recursively transforms a configuration object based on the provided schema.
-     * @param {any} data
-     * @param {any} schema
-     *
-     * @returns {Record<string, any>} A new object with transformed and normalized values
-     */
-    private transformBySchema;
+    buildConfigs: <T>() => T;
     /**
      * create ConfigValidator from schema file path
      */
@@ -38,13 +31,30 @@ export declare class ConfigValidator {
      * traverses and validates a subconfig using the subschema
      *
      * @private
-     * @param {Record<string, any>} config
-     * @param {Record<string, any>} subConfig
+     * @param {Record<string, any>} config - The full root configuration object
+     * @param {Record<string, any>} subConfig - The slice of config currently being
+     *   validated
      * @param {ConfigSchema} subSchema
      * @param {string[]} path
+     * @param {Record<string, any>} context - he local scope object for
+     *   resolving `when` conditions.
      * @memberof ConfigValidator
      */
     private validateSubConfig;
+    /**
+     * traverses and validates a union subconfig using the subschema
+     *
+     * @private
+     * @param {any} value
+     * @param {string} name
+     * @param {UnionField} field
+     * @param {Record<string, any>} config
+     * @param {string[]} childPath
+     *
+     * @param {Record<string, any>} context - he local scope object for
+     *   resolving `when` conditions.
+     */
+    private validateUnionValue;
     /**
      * sets an object's specific subtree to the specified value
      *
@@ -63,6 +73,8 @@ export declare class ConfigValidator {
      * @param {*} value
      * @param {ConfigField} field the field specification in schema
      * @param {Record<string, any>} config the config object
+     * @param {string[]} path
+     * @param {Record<string, any> | undefined} context
      */
     private validateValue;
     /**
@@ -71,9 +83,10 @@ export declare class ConfigValidator {
      *
      * @param {When} when
      * @param {Record<string, any>} config
+     * @param {Record<string, any>} context
      * @return {boolean}
      */
-    isWhenTrue: (when: When, config: Record<string, any>) => boolean;
+    isWhenTrue: (when: When, config: Record<string, any>, context?: Record<string, any>) => boolean;
     /**
      * returns the value at specified path in config object
      *
@@ -82,7 +95,7 @@ export declare class ConfigValidator {
      * @param {string[]} path
      * @return {*}
      */
-    static valueAt: (config: Record<string, any>, path: string[]) => any;
+    static valueAt: (config: any, path: string[]) => any;
     /**
      * validates this.schema and throws exception if any errors found
      */

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;AAQhD,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAC7E,OAAO,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AAYlD,qBAAa,eAAe;IAC1B,OAAO,CAAC,MAAM,CAAe;IAE7B,OAAO;IAKP;;;;OAIG;IAEH,YAAY,QAAO,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAIpC;IAEF;;;;;;OAMG;IAEH,OAAO,CAAC,iBAAiB,CA+BvB;IAEF;;OAEG;IACH,MAAM,CAAC,QAAQ,GAAI,YAAY,MAAM,KAAG,eAAe,CAUrD;IAEF;;;;OAIG;IACH,MAAM,CAAC,UAAU,GAAI,QAAQ,YAAY,KAAG,eAAe,CAEzD;IAEF;;;;OAIG;IAEI,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAWjD;;;;;;;;;OASG;IACH,OAAO,CAAC,iBAAiB;IA8CzB;;;;;;;;;OASG;IACH,MAAM,CAAC,YAAY,CAEjB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACxB,QAAQ,EAAE,SAAS,EACnB,IAAI,EAAE,MAAM,EAAE;IAiBhB;;;;;;;OAOG;IACH,OAAO,CAAC,aAAa,CAmEnB;IAEF;;;;;;;OAOG;IAEI,UAAU,GAAI,MAAM,IAAI,EAAE,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAG,OAAO,CAIpE;IAEF;;;;;;;OAOG;IAEH,MAAM,CAAC,OAAO,GAAI,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,MAAM,EAAE,SAY3D;IAEF;;OAEG;IACH,OAAO,CAAC,cAAc,CAyDpB;IAEF;;;;OAIG;IACH,OAAO,CAAC,kBAAkB,CAIxB;IAEF;;;;OAIG;IACH,OAAO,CAAC,mBAAmB,CA2BzB;IAEF;;;;;OAKG;IACH,cAAc,GAAI,MAAM,MAAM,EAAE,KAAG,WAAW,GAAG,SAAS,CAiBxD;IAEF;;;;OAIG;IAEH,eAAe,GAAI,UAAU;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,KAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAMvE;IAGF,OAAO,CAAC,sBAAsB,CAwC5B;IAEF;;;;;OAKG;IACH,eAAe,GAAI,MAAM,MAAM,KAAG,MAAM,CA0GtC;IAEF;;;;;;OAMG;IACH,OAAO,CAAC,cAAc,CAOpB;IAEF;;;;;;OAMG;IAEH,iBAAiB,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAmCtE;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,MAAM,CAAC,yBAAyB;IA8CxC;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAkDhC;IAEF;;;;;;;;OAQG;IACH,sBAAsB,GAEpB,WAAW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC9B,QAAQ,OAAO,EACf,OAAO,MAAM,EACb,QAAQ,MAAM,UAqDd;CACH"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../lib/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAiB,MAAM,QAAQ,CAAC;AAQhD,OAAO,EACL,WAAW,EACX,YAAY,EAEZ,SAAS,EACV,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AAYlD,qBAAa,eAAe;IAC1B,OAAO,CAAC,MAAM,CAAe;IAE7B,OAAO;IAKP;;;;;OAKG;IACH,YAAY,GAAI,CAAC,OAAK,CAAC,CAIrB;IAEF;;OAEG;IACH,MAAM,CAAC,QAAQ,GAAI,YAAY,MAAM,KAAG,eAAe,CAUrD;IAEF;;;;OAIG;IACH,MAAM,CAAC,UAAU,GAAI,QAAQ,YAAY,KAAG,eAAe,CAEzD;IAEF;;;;OAIG;IAEI,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAWjD;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,iBAAiB;IAyDzB;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,kBAAkB;IAsE1B;;;;;;;;;OASG;IACH,MAAM,CAAC,YAAY,CAEjB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACxB,QAAQ,EAAE,SAAS,EACnB,IAAI,EAAE,MAAM,EAAE;IAkBhB;;;;;;;;;OASG;IACH,OAAO,CAAC,aAAa,CAqFnB;IAEF;;;;;;;;OAQG;IACI,UAAU,GACf,MAAM,IAAI,EAEV,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAE3B,UAAU,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5B,OAAO,CAkBR;IAEF;;;;;;;OAOG;IAEH,MAAM,CAAC,OAAO,GAAI,QAAQ,GAAG,EAAE,MAAM,MAAM,EAAE,SAiB3C;IAEF;;OAEG;IACH,OAAO,CAAC,cAAc,CAgEpB;IAEF;;;;OAIG;IACH,OAAO,CAAC,kBAAkB,CAIxB;IAEF;;;;OAIG;IACH,OAAO,CAAC,mBAAmB,CA4BzB;IAEF;;;;;OAKG;IACH,cAAc,GAAI,MAAM,MAAM,EAAE,KAAG,WAAW,GAAG,SAAS,CAwFxD;IAEF;;;;OAIG;IAEH,eAAe,GAAI,UAAU;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,KAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAMvE;IAGF,OAAO,CAAC,sBAAsB,CAsC5B;IAEF;;;;;OAKG;IACH,eAAe,GAAI,MAAM,MAAM,KAAG,MAAM,CA4MtC;IAEF;;;;;;OAMG;IACH,OAAO,CAAC,cAAc,CAOpB;IAEF;;;;;;OAMG;IAEH,iBAAiB,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAmCtE;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,MAAM,CAAC,yBAAyB;IA8CxC;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAkDhC;IAEF;;;;;;;;OAQG;IACH,sBAAsB,GAEpB,WAAW,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC9B,QAAQ,OAAO,EACf,OAAO,MAAM,EACb,QAAQ,MAAM,UAqDd;CACH"}