@rosen-bridge/config 1.2.0 → 2.0.0-d62d28de
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +15 -0
- package/dist/cli.js +7 -7
- package/dist/config.d.ts +34 -5
- package/dist/config.d.ts.map +1 -1
- package/dist/config.js +427 -92
- package/dist/schema/Validators/fieldProperties.d.ts +3 -0
- package/dist/schema/Validators/fieldProperties.d.ts.map +1 -1
- package/dist/schema/Validators/fieldProperties.js +12 -1
- package/dist/schema/types/fields.d.ts +11 -2
- package/dist/schema/types/fields.d.ts.map +1 -1
- package/dist/schema/types/fields.js +1 -1
- package/dist/utils.d.ts.map +1 -1
- package/dist/utils.js +4 -2
- package/dist/value/validators.d.ts.map +1 -1
- package/dist/value/validators.js +55 -13
- package/package.json +9 -12
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,20 @@
|
|
|
1
1
|
# @rosen-bridge/config
|
|
2
2
|
|
|
3
|
+
## 2.0.0-d62d28de
|
|
4
|
+
|
|
5
|
+
### Major Changes
|
|
6
|
+
|
|
7
|
+
- Add `fromSchemaFile` method for loading and parsing a `schema.json` file from a specified path.
|
|
8
|
+
Add `buildConfigs` method to load configs, validate them, and return final config object.
|
|
9
|
+
|
|
10
|
+
### Minor Changes
|
|
11
|
+
|
|
12
|
+
- Add supporting union type in config
|
|
13
|
+
|
|
14
|
+
### Patch Changes
|
|
15
|
+
|
|
16
|
+
- Add ValueType to enforce type safety and avoid any
|
|
17
|
+
|
|
3
18
|
## 1.2.0
|
|
4
19
|
|
|
5
20
|
### Minor Changes
|
package/dist/cli.js
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
#!/usr/bin/env -S node --experimental-specifier-resolution=node
|
|
2
|
-
import yargs from 'yargs';
|
|
3
|
-
import { hideBin } from 'yargs/helpers';
|
|
4
2
|
import chalk from 'chalk';
|
|
5
|
-
import ora from 'ora';
|
|
6
|
-
import { ConfigValidator } from './index';
|
|
7
3
|
import * as fs from 'fs';
|
|
8
4
|
import * as yaml from 'js-yaml';
|
|
5
|
+
import ora from 'ora';
|
|
6
|
+
import yargs from 'yargs';
|
|
7
|
+
import { hideBin } from 'yargs/helpers';
|
|
9
8
|
import { JsonBigIntFactory } from '@rosen-bridge/json-bigint';
|
|
9
|
+
import { ConfigValidator } from './index';
|
|
10
10
|
const JsonBigInt = JsonBigIntFactory({
|
|
11
11
|
alwaysParseAsBig: false,
|
|
12
12
|
useNativeBigInt: true,
|
|
@@ -37,7 +37,7 @@ yargs(hideBin(process.argv))
|
|
|
37
37
|
spinner.start(`Generating config default values`);
|
|
38
38
|
const rawSchemaData = fs.readFileSync(argv.schema, 'utf-8');
|
|
39
39
|
const schema = JsonBigInt.parse(rawSchemaData);
|
|
40
|
-
const confValidator =
|
|
40
|
+
const confValidator = ConfigValidator.fromSchema(schema);
|
|
41
41
|
const defaultConf = confValidator.generateDefault();
|
|
42
42
|
let output = '';
|
|
43
43
|
switch (argv.format) {
|
|
@@ -76,11 +76,11 @@ yargs(hideBin(process.argv))
|
|
|
76
76
|
spinner.start(`Generating TypeScript types`);
|
|
77
77
|
const rawSchemaData = fs.readFileSync(argv.schema, 'utf-8');
|
|
78
78
|
const schema = JsonBigInt.parse(rawSchemaData);
|
|
79
|
-
const confValidator =
|
|
79
|
+
const confValidator = ConfigValidator.fromSchema(schema);
|
|
80
80
|
const tsTypes = confValidator.generateTSTypes(argv.rootType);
|
|
81
81
|
fs.writeFileSync(argv.output, tsTypes);
|
|
82
82
|
spinner.succeed(chalk.green(`TypeScript types were output at "${argv.output}"`));
|
|
83
83
|
})
|
|
84
84
|
.demandCommand(1)
|
|
85
85
|
.parse();
|
|
86
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
86
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"cli.js","sourceRoot":"","sources":["../lib/cli.ts"],"names":[],"mappings":";AAEA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAE9D,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C,MAAM,UAAU,GAAG,iBAAiB,CAAC;IACnC,gBAAgB,EAAE,KAAK;IACvB,eAAe,EAAE,IAAI;CACtB,CAAC,CAAC;AAEH,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;KACzB,OAAO,CACN,kBAAkB,EAClB,mEAAmE,EACnE,CAAC,KAAK,EAAE,EAAE,CACR,KAAK;KACF,MAAM,CAAC,QAAQ,EAAE;IAChB,KAAK,EAAE,GAAG;IACV,YAAY,EAAE,IAAI;IAClB,WAAW,EAAE,uDAAuD;IACpE,IAAI,EAAE,QAAQ;CACf,CAAC;KACD,MAAM,CAAC,QAAQ,EAAE;IAChB,KAAK,EAAE,GAAG;IACV,YAAY,EAAE,IAAI;IAClB,WAAW,EAAE,sCAAsC;IACnD,IAAI,EAAE,QAAQ;CACf,CAAC;KACD,MAAM,CAAC,QAAQ,EAAE;IAChB,KAAK,EAAE,GAAG;IACV,YAAY,EAAE,IAAI;IAClB,WAAW,EAAE,sCAAsC;IACnD,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,MAAM;IACf,IAAI,EAAE,QAAQ;CACf,CAAC,EACN,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC;IACtB,OAAO,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC;IAElD,MAAM,aAAa,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC5D,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IAE/C,MAAM,aAAa,GAAG,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACzD,MAAM,WAAW,GAAG,aAAa,CAAC,eAAe,EAAE,CAAC;IAEpD,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,QAAQ,IAAI,CAAC,MAAM,EAAE,CAAC;QACpB,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YAC3C,MAAM;QACR,CAAC;QACD,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAChC,MAAM;QACR,CAAC;IACH,CAAC;IAED,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEtC,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,KAAK,CAAC,yCAAyC,IAAI,CAAC,MAAM,GAAG,CAAC,CACrE,CAAC;AACJ,CAAC,CACF;KACA,OAAO,CACN,mBAAmB,EACnB,uEAAuE,EACvE,CAAC,KAAK,EAAE,EAAE,CACR,KAAK;KACF,MAAM,CAAC,QAAQ,EAAE;IAChB,KAAK,EAAE,GAAG;IACV,YAAY,EAAE,IAAI;IAClB,WAAW,EAAE,uDAAuD;IACpE,IAAI,EAAE,QAAQ;CACf,CAAC;KACD,MAAM,CAAC,QAAQ,EAAE;IAChB,KAAK,EAAE,GAAG;IACV,YAAY,EAAE,IAAI;IAClB,WAAW,EAAE,iCAAiC;IAC9C,IAAI,EAAE,QAAQ;CACf,CAAC;KACD,MAAM,CAAC,WAAW,EAAE;IACnB,KAAK,EAAE,GAAG;IACV,YAAY,EAAE,IAAI;IAClB,WAAW,EAAE,4BAA4B;IACzC,IAAI,EAAE,QAAQ;CACf,CAAC,EACN,KAAK,EAAE,IAAI,EAAE,EAAE;IACb,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC;IACtB,OAAO,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAE7C,MAAM,aAAa,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC5D,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IAE/C,MAAM,aAAa,GAAG,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACzD,MAAM,OAAO,GAAG,aAAa,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAE7D,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEvC,OAAO,CAAC,OAAO,CACb,KAAK,CAAC,KAAK,CAAC,oCAAoC,IAAI,CAAC,MAAM,GAAG,CAAC,CAChE,CAAC;AACJ,CAAC,CACF;KACA,aAAa,CAAC,CAAC,CAAC;KAChB,KAAK,EAAE,CAAC","sourcesContent":["#!/usr/bin/env -S node --experimental-specifier-resolution=node\n\nimport chalk from 'chalk';\nimport * as fs from 'fs';\nimport * as yaml from 'js-yaml';\nimport ora from 'ora';\nimport yargs from 'yargs';\nimport { hideBin } from 'yargs/helpers';\n\nimport { JsonBigIntFactory } from '@rosen-bridge/json-bigint';\n\nimport { ConfigValidator } from './index';\n\nconst JsonBigInt = JsonBigIntFactory({\n  alwaysParseAsBig: false,\n  useNativeBigInt: true,\n});\n\nyargs(hideBin(process.argv))\n  .command(\n    'generate-default',\n    'generates an object using the default values of the passed schema',\n    (yargs) =>\n      yargs\n        .option('schema', {\n          alias: 's',\n          demandOption: true,\n          description: 'input schema file path which should be in json format',\n          type: 'string',\n        })\n        .option('output', {\n          alias: 'o',\n          demandOption: true,\n          description: 'generated default values output path',\n          type: 'string',\n        })\n        .option('format', {\n          alias: 'f',\n          demandOption: true,\n          description: 'generated default values output path',\n          choices: ['json', 'yaml'],\n          default: 'yaml',\n          type: 'string',\n        }),\n    async (argv) => {\n      const spinner = ora();\n      spinner.start(`Generating config default values`);\n\n      const rawSchemaData = fs.readFileSync(argv.schema, 'utf-8');\n      const schema = JsonBigInt.parse(rawSchemaData);\n\n      const confValidator = ConfigValidator.fromSchema(schema);\n      const defaultConf = confValidator.generateDefault();\n\n      let output = '';\n      switch (argv.format) {\n        case 'json': {\n          output = JsonBigInt.stringify(defaultConf);\n          break;\n        }\n        case 'yaml': {\n          output = yaml.dump(defaultConf);\n          break;\n        }\n      }\n\n      fs.writeFileSync(argv.output, output);\n\n      spinner.succeed(\n        chalk.green(`default config values were output at \"${argv.output}\"`),\n      );\n    },\n  )\n  .command(\n    'generate-ts-types',\n    'generates compatible TypeScript interface types for the passed schema',\n    (yargs) =>\n      yargs\n        .option('schema', {\n          alias: 's',\n          demandOption: true,\n          description: 'input schema file path which should be in json format',\n          type: 'string',\n        })\n        .option('output', {\n          alias: 'o',\n          demandOption: true,\n          description: 'generated TypeScript interfaces',\n          type: 'string',\n        })\n        .option('root-type', {\n          alias: 'r',\n          demandOption: true,\n          description: 'Name of top root interface',\n          type: 'string',\n        }),\n    async (argv) => {\n      const spinner = ora();\n      spinner.start(`Generating TypeScript types`);\n\n      const rawSchemaData = fs.readFileSync(argv.schema, 'utf-8');\n      const schema = JsonBigInt.parse(rawSchemaData);\n\n      const confValidator = ConfigValidator.fromSchema(schema);\n      const tsTypes = confValidator.generateTSTypes(argv.rootType);\n\n      fs.writeFileSync(argv.output, tsTypes);\n\n      spinner.succeed(\n        chalk.green(`TypeScript types were output at \"${argv.output}\"`),\n      );\n    },\n  )\n  .demandCommand(1)\n  .parse();\n"]}
|
package/dist/config.d.ts
CHANGED
|
@@ -1,9 +1,26 @@
|
|
|
1
1
|
import { IConfig } from 'config';
|
|
2
|
-
import { ConfigField, ConfigSchema } from './schema/types/fields';
|
|
2
|
+
import { ConfigField, ConfigSchema, ValueType } from './schema/types/fields';
|
|
3
3
|
import { When } from './schema/types/validations';
|
|
4
4
|
export declare class ConfigValidator {
|
|
5
5
|
private schema;
|
|
6
|
-
constructor(
|
|
6
|
+
private constructor();
|
|
7
|
+
/**
|
|
8
|
+
* Builds and returns the final configuration object by transforming and validating
|
|
9
|
+
*
|
|
10
|
+
* T - The type of the final normalized configuration object.
|
|
11
|
+
* @returns {T} The normalized configuration object
|
|
12
|
+
*/
|
|
13
|
+
buildConfigs: <T>() => T;
|
|
14
|
+
/**
|
|
15
|
+
* create ConfigValidator from schema file path
|
|
16
|
+
*/
|
|
17
|
+
static fromFile: (schemaPath: string) => ConfigValidator;
|
|
18
|
+
/**
|
|
19
|
+
* create ConfigValidator from schema
|
|
20
|
+
*
|
|
21
|
+
* @param {ConfigSchema} schema
|
|
22
|
+
*/
|
|
23
|
+
static fromSchema: (schema: ConfigSchema) => ConfigValidator;
|
|
7
24
|
/**
|
|
8
25
|
* validates the passed config against the instance's schema
|
|
9
26
|
*
|
|
@@ -21,6 +38,18 @@ export declare class ConfigValidator {
|
|
|
21
38
|
* @memberof ConfigValidator
|
|
22
39
|
*/
|
|
23
40
|
private validateSubConfig;
|
|
41
|
+
/**
|
|
42
|
+
* traverses and validates a union subconfig using the subschema
|
|
43
|
+
*
|
|
44
|
+
* @private
|
|
45
|
+
* @param {any} value
|
|
46
|
+
* @param {UnionField} field
|
|
47
|
+
* @param {Record<string, any>} config
|
|
48
|
+
* @param {ConfigSchema} subSchema
|
|
49
|
+
* @param {string[]} childPath
|
|
50
|
+
* @param {string} name
|
|
51
|
+
*/
|
|
52
|
+
private validateUnionValue;
|
|
24
53
|
/**
|
|
25
54
|
* sets an object's specific subtree to the specified value
|
|
26
55
|
*
|
|
@@ -31,7 +60,7 @@ export declare class ConfigValidator {
|
|
|
31
60
|
* @return {*}
|
|
32
61
|
* @memberof ConfigValidator
|
|
33
62
|
*/
|
|
34
|
-
static modifyObject(obj: Record<string, any>, newValue:
|
|
63
|
+
static modifyObject(obj: Record<string, any>, newValue: ValueType, path: string[]): void;
|
|
35
64
|
/**
|
|
36
65
|
* validates a value in config object
|
|
37
66
|
*
|
|
@@ -49,7 +78,7 @@ export declare class ConfigValidator {
|
|
|
49
78
|
* @param {Record<string, any>} config
|
|
50
79
|
* @return {boolean}
|
|
51
80
|
*/
|
|
52
|
-
isWhenTrue: (when: When, config: Record<string, any>) => boolean;
|
|
81
|
+
isWhenTrue: (when: When, config: Record<string, any>, context?: Record<string, any>) => boolean;
|
|
53
82
|
/**
|
|
54
83
|
* returns the value at specified path in config object
|
|
55
84
|
*
|
|
@@ -58,7 +87,7 @@ export declare class ConfigValidator {
|
|
|
58
87
|
* @param {string[]} path
|
|
59
88
|
* @return {*}
|
|
60
89
|
*/
|
|
61
|
-
static valueAt: (config:
|
|
90
|
+
static valueAt: (config: any, path: string[]) => any;
|
|
62
91
|
/**
|
|
63
92
|
* validates this.schema and throws exception if any errors found
|
|
64
93
|
*/
|
package/dist/config.d.ts.map
CHANGED
|
@@ -1 +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,
|
|
1
|
+
{"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;;;;;;;;;OASG;IACH,OAAO,CAAC,iBAAiB;IA6FzB;;;;;;;;;;OAUG;IACH,OAAO,CAAC,kBAAkB;IA+F1B;;;;;;;;;OASG;IACH,MAAM,CAAC,YAAY,CAEjB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACxB,QAAQ,EAAE,SAAS,EACnB,IAAI,EAAE,MAAM,EAAE;IAgBhB;;;;;;;OAOG;IACH,OAAO,CAAC,aAAa,CA6EnB;IAEF;;;;;;;OAOG;IACI,UAAU,GACf,MAAM,IAAI,EAEV,QAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAE3B,UAAU,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAC5B,OAAO,CAUR;IAEF;;;;;;;OAOG;IAEH,MAAM,CAAC,OAAO,GAAI,QAAQ,GAAG,EAAE,MAAM,MAAM,EAAE,SAc3C;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,CA0FxD;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"}
|