ts-runtime-validation 1.0.3 → 1.1.0

package/README.md

@@ -24,11 +24,12 @@ Ensure your project files containing the schemas you want to validate end with t
 Usage: ts-runtime-validation [options]
 
 Options:
-  --glob        Glob file path of typescript files to generate ts-interface -> json-schema validations - default: *.jsonschema.{ts,tsx}
-  --rootPath    RootPath of source - default: ./src
-  --output      Validation schema + typescript interface output directory (relative to root path) - default: ./.ts-runtime-validation
-  --no-helpers  Only generate JSON schema without typescript helper files
-  -h, --help    display help for command
+  --glob                  Glob file path of typescript files to generate ts-interface -> json-schema validations - default: *.jsonschema.{ts,tsx}
+  --rootPath              RootPath of source - default: ./src
+  --output                Validation schema + typescript interface output directory (relative to root path) - default: ./.ts-runtime-validation
+  --no-helpers            Only generate JSON schema without typescript helper files
+  --additionalProperties  Allow additional properties to pass validation (default: false)
+  -h, --help              display help for command
 ```
 
 ## Example usage of generated ts type validation

package/dist/SchemaGenerator.js

@@ -0,0 +1,241 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaGenerator = void 0;
+const fdir_1 = require("fdir");
+const fs_1 = __importDefault(require("fs"));
+const picomatch_1 = __importDefault(require("picomatch"));
+const path_1 = __importDefault(require("path"));
+const ts_morph_1 = require("ts-morph");
+const tsj = __importStar(require("ts-json-schema-generator"));
+const defaultTsMorphProjectSettings = {
+    manipulationSettings: {
+        indentationText: ts_morph_1.IndentationText.FourSpaces,
+        newLineKind: ts_morph_1.NewLineKind.LineFeed,
+        quoteKind: ts_morph_1.QuoteKind.Double,
+        usePrefixAndSuffixTextForRename: false,
+        useTrailingCommas: true,
+    },
+};
+const defaultCreateFileOptions = {
+    overwrite: true,
+};
+const validationSchemaFileName = "validation.schema.json";
+const schemaDefinitionFileName = "SchemaDefinition.ts";
+class SchemaGenerator {
+    constructor(options) {
+        this.options = options;
+        this.outputPath = path_1.default.join(this.options.rootPath, this.options.output);
+        this.jsonSchemaOutputFile = path_1.default.join(this.options.rootPath, this.options.output, validationSchemaFileName);
+        this.tsSchemaDefinitionOutputFile = path_1.default.join(this.options.rootPath, this.options.output, schemaDefinitionFileName);
+        this.isValidSchemaOutputFile = path_1.default.join(this.options.rootPath, this.options.output, "isSchemaValid.ts");
+        this.Generate = () => __awaiter(this, void 0, void 0, function* () {
+            const { helpers, glob } = this.options;
+            const fileList = yield this.getMatchingFiles();
+            console.log(`Found ${fileList.length} schema file(s)`);
+            if (fileList.length === 0) {
+                console.log(`Aborting - no files found with glob: ${glob}`);
+                return;
+            }
+            const fileSchemas = yield this.getJsonSchemaMap(fileList);
+            console.log(`Generating ${fileSchemas.size} validation schema(s)`);
+            if (fileSchemas.size === 0) {
+                console.log(`Aborting - no interfaces found: ${glob}`);
+                return;
+            }
+            this.writeSchemaMapToValidationSchema(fileSchemas);
+            if (helpers === false) {
+                console.log("Skipping helper file generation");
+                return;
+            }
+            yield this.writeSchemaMapToValidationTypes(fileSchemas);
+            this.writeValidatorFunction();
+        });
+        this.getMatchingFiles = () => __awaiter(this, void 0, void 0, function* () {
+            const { glob, rootPath } = this.options;
+            const api = new fdir_1.fdir().crawlWithOptions(rootPath, {
+                includeBasePath: true,
+                includeDirs: false,
+                filters: [
+                    (path) => {
+                        return picomatch_1.default.isMatch(path, glob, { contains: true });
+                    },
+                ],
+            });
+            return api.withPromise();
+        });
+        this.getJsonSchemaMap = (filesList) => __awaiter(this, void 0, void 0, function* () {
+            const { additionalProperties } = this.options;
+            const schemaMap = new Map();
+            filesList.forEach((file) => {
+                const config = {
+                    path: file,
+                    type: "*",
+                    additionalProperties,
+                };
+                const schemaGenerator = tsj.createGenerator(config);
+                const fileSchemas = schemaGenerator.createSchema(config.type);
+                schemaMap.set(file, fileSchemas);
+            });
+            return schemaMap;
+        });
+        this.getSchemaVersion = (schemaMap) => {
+            var _a;
+            const firstEntry = schemaMap.values().next().value;
+            return (_a = firstEntry["$schema"]) !== null && _a !== void 0 ? _a : "";
+        };
+        this.ensureOutputPathExists = () => {
+            if (!fs_1.default.existsSync(this.outputPath)) {
+                fs_1.default.mkdirSync(this.outputPath, { recursive: true });
+            }
+        };
+        this.writeSchemaMapToValidationSchema = (schemaMap) => {
+            const definitions = {};
+            schemaMap.forEach((fileSchema) => {
+                var _a;
+                const defs = (_a = fileSchema.definitions) !== null && _a !== void 0 ? _a : {};
+                Object.keys(defs).forEach((key) => {
+                    if (definitions[key] !== undefined) {
+                        throw new Error(`Duplicate symbol: ${key} found`);
+                    }
+                    const schema = defs[key];
+                    definitions[key] = schema;
+                });
+            });
+            const outputBuffer = {
+                $schema: this.getSchemaVersion(schemaMap),
+                definitions,
+            };
+            this.ensureOutputPathExists();
+            fs_1.default.writeFileSync(this.jsonSchemaOutputFile, JSON.stringify(outputBuffer, null, 4));
+        };
+        this.writeSchemaMapToValidationTypes = (schemaMap) => __awaiter(this, void 0, void 0, function* () {
+            const project = new ts_morph_1.Project(defaultTsMorphProjectSettings);
+            const symbols = [];
+            const importMap = new Map();
+            schemaMap.forEach((schema, filePath) => {
+                var _a;
+                const dir = path_1.default.dirname(filePath);
+                const fileWithoutExtension = path_1.default.parse(filePath).name;
+                const relativeFilePath = path_1.default.relative(this.outputPath, dir);
+                const importPath = `${relativeFilePath}/${fileWithoutExtension}`;
+                const defs = (_a = schema.definitions) !== null && _a !== void 0 ? _a : {};
+                Object.keys(defs).forEach((symbol) => {
+                    var _a;
+                    const namedImports = (_a = importMap.get(importPath)) !== null && _a !== void 0 ? _a : [];
+                    namedImports.push(symbol);
+                    importMap.set(importPath, namedImports);
+                    symbols.push(symbol);
+                });
+            });
+            const sourceFile = project.createSourceFile(this.tsSchemaDefinitionOutputFile, {}, defaultCreateFileOptions);
+            importMap.forEach((namedImports, importPath) => {
+                sourceFile.addImportDeclaration({ namedImports, moduleSpecifier: importPath });
+            });
+            sourceFile.addVariableStatement({
+                declarationKind: ts_morph_1.VariableDeclarationKind.Const,
+                declarations: [
+                    {
+                        name: "schemas",
+                        type: "Record<keyof ISchema, string>",
+                        initializer: (writer) => {
+                            writer.writeLine(`{`);
+                            symbols.forEach((symbol) => {
+                                writer.writeLine(`["#/definitions/${symbol}"] : "${symbol}",`);
+                            }),
+                                writer.writeLine(`}`);
+                        },
+                    },
+                ],
+            });
+            sourceFile.addInterface({
+                kind: ts_morph_1.StructureKind.Interface,
+                name: "ISchema",
+                isExported: false,
+                properties: symbols.map((symbol) => {
+                    return { name: `readonly ["#/definitions/${symbol}"]`, type: symbol };
+                }),
+            });
+            sourceFile.addExportDeclaration({
+                namedExports: ["schemas", "ISchema"],
+            });
+            yield project.save();
+        });
+        this.writeValidatorFunction = () => __awaiter(this, void 0, void 0, function* () {
+            const project = new ts_morph_1.Project(defaultTsMorphProjectSettings);
+            const sourceFile = project.createSourceFile(this.isValidSchemaOutputFile, {}, defaultCreateFileOptions);
+            sourceFile.addImportDeclaration({ namespaceImport: "schema", moduleSpecifier: `./${validationSchemaFileName}` });
+            sourceFile.addImportDeclaration({ defaultImport: "Ajv", moduleSpecifier: "ajv" });
+            sourceFile.addImportDeclaration({
+                namedImports: ["ISchema", "schemas"],
+                moduleSpecifier: `./${path_1.default.parse(schemaDefinitionFileName).name}`,
+            });
+            sourceFile.addVariableStatement({
+                declarationKind: ts_morph_1.VariableDeclarationKind.Const,
+                declarations: [
+                    {
+                        name: "validator",
+                        initializer: (writer) => {
+                            writer.writeLine(`new Ajv({ allErrors: true });`);
+                            writer.writeLine(`validator.compile(schema)`);
+                        },
+                    },
+                ],
+            });
+            sourceFile.addVariableStatement({
+                declarationKind: ts_morph_1.VariableDeclarationKind.Const,
+                declarations: [
+                    {
+                        name: "isValidSchema",
+                        initializer: (writer) => {
+                            writer.writeLine(`<T extends keyof typeof schemas>(data: unknown, schemaKeyRef: T): data is ISchema[T] => {`);
+                            writer.writeLine(`validator.validate(schemaKeyRef as string, data);`);
+                            writer.writeLine(`return Boolean(validator.errors) === false;`);
+                            writer.writeLine(`}`);
+                        },
+                    },
+                ],
+            });
+            sourceFile.addExportDeclaration({
+                namedExports: ["validator", "isValidSchema"],
+            });
+            yield project.save();
+        });
+    }
+}
+exports.SchemaGenerator = SchemaGenerator;
+//# sourceMappingURL=SchemaGenerator.js.map

package/dist/SchemaGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaGenerator.js","sourceRoot":"","sources":["../src/SchemaGenerator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+BAA4B;AAG5B,4CAAoB;AACpB,0DAAkC;AAClC,gDAAwB;AACxB,uCAUkB;AAClB,8DAAgD;AAGhD,MAAM,6BAA6B,GAAmB;IAClD,oBAAoB,EAAE;QAClB,eAAe,EAAE,0BAAe,CAAC,UAAU;QAC3C,WAAW,EAAE,sBAAW,CAAC,QAAQ;QACjC,SAAS,EAAE,oBAAS,CAAC,MAAM;QAC3B,+BAA+B,EAAE,KAAK;QACtC,iBAAiB,EAAE,IAAI;KAC1B;CACJ,CAAC;AAEF,MAAM,wBAAwB,GAA4B;IACtD,SAAS,EAAE,IAAI;CAClB,CAAC;AAEF,MAAM,wBAAwB,GAAG,wBAAwB,CAAC;AAC1D,MAAM,wBAAwB,GAAG,qBAAqB,CAAC;AAEvD,MAAa,eAAe;IAMxB,YAA2B,OAAwB;QAAxB,YAAO,GAAP,OAAO,CAAiB;QAL3C,eAAU,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACnE,yBAAoB,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;QACvG,iCAA4B,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;QAC/G,4BAAuB,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;QAIrG,aAAQ,GAAG,GAAS,EAAE;YACzB,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;YACvC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAE/C,OAAO,CAAC,GAAG,CAAC,SAAS,QAAQ,CAAC,MAAM,iBAAiB,CAAC,CAAC;YACvD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;gBACvB,OAAO,CAAC,GAAG,CAAC,wCAAwC,IAAI,EAAE,CAAC,CAAC;gBAC5D,OAAO;aACV;YACD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YAC1D,OAAO,CAAC,GAAG,CAAC,cAAc,WAAW,CAAC,IAAI,uBAAuB,CAAC,CAAC;YACnE,IAAI,WAAW,CAAC,IAAI,KAAK,CAAC,EAAE;gBACxB,OAAO,CAAC,GAAG,CAAC,mCAAmC,IAAI,EAAE,CAAC,CAAC;gBACvD,OAAO;aACV;YACD,IAAI,CAAC,gCAAgC,CAAC,WAAW,CAAC,CAAC;YACnD,IAAI,OAAO,KAAK,KAAK,EAAE;gBACnB,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC;gBAC/C,OAAO;aACV;YACD,MAAM,IAAI,CAAC,+BAA+B,CAAC,WAAW,CAAC,CAAC;YACxD,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAClC,CAAC,CAAA,CAAC;QAEM,qBAAgB,GAAG,GAAS,EAAE;YAClC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;YACxC,MAAM,GAAG,GAAG,IAAI,WAAI,EAAE,CAAC,gBAAgB,CAAC,QAAQ,EAAE;gBAC9C,eAAe,EAAE,IAAI;gBACrB,WAAW,EAAE,KAAK;gBAClB,OAAO,EAAE;oBACL,CAAC,IAAI,EAAE,EAAE;wBACL,OAAO,mBAAS,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;oBAC7D,CAAC;iBACJ;aACJ,CAAC,CAAC;YACH,OAAO,GAAG,CAAC,WAAW,EAA4B,CAAC;QACvD,CAAC,CAAA,CAAC;QAEM,qBAAgB,GAAG,CAAO,SAAwB,EAAE,EAAE;YAC1D,MAAM,EAAE,oBAAoB,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;YAC9C,MAAM,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;YAC5C,SAAS,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBACvB,MAAM,MAAM,GAAW;oBACnB,IAAI,EAAE,IAAI;oBACV,IAAI,EAAE,GAAG;oBACT,oBAAoB;iBACvB,CAAC;gBAEF,MAAM,eAAe,GAAG,GAAG,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;gBACpD,MAAM,WAAW,GAAG,eAAe,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC9D,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;YACrC,CAAC,CAAC,CAAC;YACH,OAAO,SAAS,CAAC;QACrB,CAAC,CAAA,CAAC;QAEM,qBAAgB,GAAG,CAAC,SAA8B,EAAE,EAAE;;YAC1D,MAAM,UAAU,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;YACnD,OAAO,MAAA,UAAU,CAAC,SAAS,CAAC,mCAAI,EAAE,CAAC;QACvC,CAAC,CAAC;QAEM,2BAAsB,GAAG,GAAG,EAAE;YAClC,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;gBACjC,YAAE,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;aACtD;QACL,CAAC,CAAC;QAEM,qCAAgC,GAAG,CAAC,SAA8B,EAAE,EAAE;YAC1E,MAAM,WAAW,GAA6B,EAAE,CAAC;YACjD,SAAS,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;;gBAC7B,MAAM,IAAI,GAAG,MAAA,UAAU,CAAC,WAAW,mCAAI,EAAE,CAAC;gBAE1C,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;oBAC9B,IAAI,WAAW,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;wBAChC,MAAM,IAAI,KAAK,CAAC,qBAAqB,GAAG,QAAQ,CAAC,CAAC;qBACrD;oBACD,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAW,CAAC;oBACnC,WAAW,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;gBAC9B,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YACH,MAAM,YAAY,GAAW;gBACzB,OAAO,EAAE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;gBACzC,WAAW;aACd,CAAC;YAEF,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAC9B,YAAE,CAAC,aAAa,CAAC,IAAI,CAAC,oBAAoB,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QACvF,CAAC,CAAC;QAEM,oCAA+B,GAAG,CAAO,SAA8B,EAAE,EAAE;YAC/E,MAAM,OAAO,GAAG,IAAI,kBAAO,CAAC,6BAA6B,CAAC,CAAC;YAE3D,MAAM,OAAO,GAAkB,EAAE,CAAC;YAElC,MAAM,SAAS,GAAG,IAAI,GAAG,EAAyB,CAAC;YACnD,SAAS,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE;;gBACnC,MAAM,GAAG,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACnC,MAAM,oBAAoB,GAAG,cAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC;gBACvD,MAAM,gBAAgB,GAAG,cAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;gBAC7D,MAAM,UAAU,GAAG,GAAG,gBAAgB,IAAI,oBAAoB,EAAE,CAAC;gBACjE,MAAM,IAAI,GAAG,MAAA,MAAM,CAAC,WAAW,mCAAI,EAAE,CAAC;gBAEtC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;;oBACjC,MAAM,YAAY,GAAG,MAAA,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,mCAAI,EAAE,CAAC;oBACrD,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBAC1B,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;oBACxC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACzB,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YAEH,MAAM,UAAU,GAAG,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,EAAE,wBAAwB,CAAC,CAAC;YAE7G,SAAS,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,UAAU,EAAE,EAAE;gBAC3C,UAAU,CAAC,oBAAoB,CAAC,EAAE,YAAY,EAAE,eAAe,EAAE,UAAU,EAAE,CAAC,CAAC;YACnF,CAAC,CAAC,CAAC;YAEH,UAAU,CAAC,oBAAoB,CAAC;gBAC5B,eAAe,EAAE,kCAAuB,CAAC,KAAK;gBAC9C,YAAY,EAAE;oBACV;wBACI,IAAI,EAAE,SAAS;wBACf,IAAI,EAAE,+BAA+B;wBACrC,WAAW,EAAE,CAAC,MAAuB,EAAE,EAAE;4BACrC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;4BACtB,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;gCACvB,MAAM,CAAC,SAAS,CAAC,mBAAmB,MAAM,SAAS,MAAM,IAAI,CAAC,CAAC;4BACnE,CAAC,CAAC;gCACE,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;wBAC9B,CAAC;qBACJ;iBACJ;aACJ,CAAC,CAAC;YAEH,UAAU,CAAC,YAAY,CAAC;gBACpB,IAAI,EAAE,wBAAa,CAAC,SAAS;gBAC7B,IAAI,EAAE,SAAS;gBACf,UAAU,EAAE,KAAK;gBACjB,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;oBAC/B,OAAO,EAAE,IAAI,EAAE,4BAA4B,MAAM,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;gBAC1E,CAAC,CAAC;aACL,CAAC,CAAC;YAEH,UAAU,CAAC,oBAAoB,CAAC;gBAC5B,YAAY,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;aACvC,CAAC,CAAC;YACH,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;QACzB,CAAC,CAAA,CAAC;QAEM,2BAAsB,GAAG,GAAS,EAAE;YACxC,MAAM,OAAO,GAAG,IAAI,kBAAO,CAAC,6BAA6B,CAAC,CAAC;YAC3D,MAAM,UAAU,GAAG,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,uBAAuB,EAAE,EAAE,EAAE,wBAAwB,CAAC,CAAC;YACxG,UAAU,CAAC,oBAAoB,CAAC,EAAE,eAAe,EAAE,QAAQ,EAAE,eAAe,EAAE,KAAK,wBAAwB,EAAE,EAAE,CAAC,CAAC;YACjH,UAAU,CAAC,oBAAoB,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,CAAC,CAAC;YAClF,UAAU,CAAC,oBAAoB,CAAC;gBAC5B,YAAY,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;gBACpC,eAAe,EAAE,KAAK,cAAI,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC,IAAI,EAAE;aACpE,CAAC,CAAC;YACH,UAAU,CAAC,oBAAoB,CAAC;gBAC5B,eAAe,EAAE,kCAAuB,CAAC,KAAK;gBAC9C,YAAY,EAAE;oBACV;wBACI,IAAI,EAAE,WAAW;wBACjB,WAAW,EAAE,CAAC,MAAuB,EAAE,EAAE;4BACrC,MAAM,CAAC,SAAS,CAAC,+BAA+B,CAAC,CAAC;4BAClD,MAAM,CAAC,SAAS,CAAC,2BAA2B,CAAC,CAAC;wBAClD,CAAC;qBACJ;iBACJ;aACJ,CAAC,CAAC;YAEH,UAAU,CAAC,oBAAoB,CAAC;gBAC5B,eAAe,EAAE,kCAAuB,CAAC,KAAK;gBAC9C,YAAY,EAAE;oBACV;wBACI,IAAI,EAAE,eAAe;wBACrB,WAAW,EAAE,CAAC,MAAuB,EAAE,EAAE;4BACrC,MAAM,CAAC,SAAS,CAAC,2FAA2F,CAAC,CAAC;4BAC9G,MAAM,CAAC,SAAS,CAAC,mDAAmD,CAAC,CAAC;4BACtE,MAAM,CAAC,SAAS,CAAC,6CAA6C,CAAC,CAAC;4BAChE,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;wBAC1B,CAAC;qBACJ;iBACJ;aACJ,CAAC,CAAC;YAEH,UAAU,CAAC,oBAAoB,CAAC;gBAC5B,YAAY,EAAE,CAAC,WAAW,EAAE,eAAe,CAAC;aAC/C,CAAC,CAAC;YACH,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC;QACzB,CAAC,CAAA,CAAC;IA9LoD,CAAC;CA+L1D;AArMD,0CAqMC"}

package/dist/index.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const SchemaGenerator_1 = require("./SchemaGenerator");
+const commander_1 = require("commander");
+const defaultGlobPattern = "*.jsonschema.{ts,tsx}";
+const defaultRootPath = "./src";
+const defaultOutputFolder = "./.ts-runtime-validation";
+commander_1.program.option("--glob", `Glob file path of typescript files to generate ts-interface -> json-schema validations - default: ${defaultGlobPattern}`, defaultGlobPattern);
+commander_1.program.option("--rootPath", `RootPath of source - default: ${defaultRootPath}`, defaultRootPath);
+commander_1.program.option("--output", `Validation schema + typescript interface output directory (relative to root path) - default: ${defaultOutputFolder}`, defaultOutputFolder);
+commander_1.program.option("--no-helpers", "Only generate JSON schema without typescript helper files", true);
+commander_1.program.option("--additionalProperties", "Allow additional properties to pass validation", false);
+commander_1.program.parse();
+const options = commander_1.program.opts();
+const generator = new SchemaGenerator_1.SchemaGenerator(options);
+generator.Generate();
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAEA,uDAAoD;AACpD,yCAAoC;AAEpC,MAAM,kBAAkB,GAAG,uBAAuB,CAAC;AAEnD,MAAM,eAAe,GAAG,OAAO,CAAC;AAChC,MAAM,mBAAmB,GAAG,0BAA0B,CAAC;AAUvD,mBAAO,CAAC,MAAM,CACV,QAAQ,EACR,qGAAqG,kBAAkB,EAAE,EACzH,kBAAkB,CACrB,CAAC;AACF,mBAAO,CAAC,MAAM,CAAC,YAAY,EAAE,iCAAiC,eAAe,EAAE,EAAE,eAAe,CAAC,CAAC;AAClG,mBAAO,CAAC,MAAM,CACV,UAAU,EACV,gGAAgG,mBAAmB,EAAE,EACrH,mBAAmB,CACtB,CAAC;AACF,mBAAO,CAAC,MAAM,CAAC,cAAc,EAAE,2DAA2D,EAAE,IAAI,CAAC,CAAC;AAClG,mBAAO,CAAC,MAAM,CAAC,wBAAwB,EAAE,gDAAgD,EAAE,KAAK,CAAC,CAAC;AAElG,mBAAO,CAAC,KAAK,EAAE,CAAC;AAEhB,MAAM,OAAO,GAAG,mBAAO,CAAC,IAAI,EAAmB,CAAC;AAEhD,MAAM,SAAS,GAAG,IAAI,iCAAe,CAAC,OAAO,CAAC,CAAC;AAC/C,SAAS,CAAC,QAAQ,EAAE,CAAC"}

package/package.json

@@ -1,14 +1,15 @@
 {
     "name": "ts-runtime-validation",
-    "version": "1.0.3",
+    "version": "1.1.0",
     "author": "Matthew Duong <thegalah@gmail.com>",
     "license": "MIT",
     "dependencies": {
         "commander": "^9.1.0",
         "fdir": "^5.2.0",
         "picomatch": "^2.3.1",
+        "ts-json-schema-generator": "^1.0.0",
         "ts-morph": "^14.0.0",
-        "typescript-json-schema": "^0.53.0"
+        "ts-runtime-validation": "../ts-runtime-validation"
     },
     "bin": {
         "ts-runtime-validation": "dist/index.js"

package/src/SchemaGenerator.ts

@@ -1,7 +1,6 @@
 import { fdir } from "fdir";
 import { ICommandOptions } from "./index";
 import { resolve } from "path";
-import * as TJS from "typescript-json-schema";
 import fs from "fs";
 import picomatch from "picomatch";
 import path from "path";
@@ -16,8 +15,10 @@ import {
     ProjectOptions,
     SourceFileCreateOptions,
 } from "ts-morph";
+import * as tsj from "ts-json-schema-generator";
+import { Config, Schema } from "ts-json-schema-generator";
 
-const defaultProjectSettings: ProjectOptions = {
+const defaultTsMorphProjectSettings: ProjectOptions = {
     manipulationSettings: {
         indentationText: IndentationText.FourSpaces,
         newLineKind: NewLineKind.LineFeed,
@@ -43,17 +44,26 @@ export class SchemaGenerator {
     public constructor(private options: ICommandOptions) {}
 
     public Generate = async () => {
-        const { helpers } = this.options;
+        const { helpers, glob } = this.options;
         const fileList = await this.getMatchingFiles();
+
         console.log(`Found ${fileList.length} schema file(s)`);
-        const map = await this.getJsonSchemaMap(fileList);
-        console.log(`Generating ${map.size} validation schema(s)`);
-        this.writeSchemaMapToValidationSchema(map);
+        if (fileList.length === 0) {
+            console.log(`Aborting - no files found with glob: ${glob}`);
+            return;
+        }
+        const fileSchemas = await this.getJsonSchemaMap(fileList);
+        console.log(`Generating ${fileSchemas.size} validation schema(s)`);
+        if (fileSchemas.size === 0) {
+            console.log(`Aborting - no interfaces found: ${glob}`);
+            return;
+        }
+        this.writeSchemaMapToValidationSchema(fileSchemas);
         if (helpers === false) {
             console.log("Skipping helper file generation");
             return;
         }
-        await this.writeSchemaMapToValidationTypes(map, fileList);
+        await this.writeSchemaMapToValidationTypes(fileSchemas);
         this.writeValidatorFunction();
     };
 
@@ -72,41 +82,23 @@ export class SchemaGenerator {
     };
 
     private getJsonSchemaMap = async (filesList: Array<string>) => {
-        const schemaMap = new Map<string, TJS.Definition>();
-        const files = filesList.map((fileName) => {
-            return resolve(fileName);
-        });
-        const settings: TJS.PartialArgs = {
-            required: true,
-            titles: true,
-            aliasRef: true,
-            ref: true,
-            noExtraProps: true,
-            propOrder: true,
-        };
-
-        const compilerOptions: TJS.CompilerOptions = {
-            strictNullChecks: true,
-        };
-
-        const program = TJS.getProgramFromFiles(files, compilerOptions);
-
-        const generator = TJS.buildGenerator(program, settings);
-        const userDefinedSymbols = generator?.getMainFileSymbols(program) ?? [];
-        userDefinedSymbols.forEach((symbol) => {
-            if (schemaMap.has(symbol)) {
-                throw new Error(`Duplicate symbol "${symbol}" found.`);
-            }
-            const schema = generator?.getSchemaForSymbol(symbol);
-            if (schema) {
-                schemaMap.set(symbol, schema);
-            }
+        const { additionalProperties } = this.options;
+        const schemaMap = new Map<string, Schema>();
+        filesList.forEach((file) => {
+            const config: Config = {
+                path: file,
+                type: "*",
+                additionalProperties,
+            };
+
+            const schemaGenerator = tsj.createGenerator(config);
+            const fileSchemas = schemaGenerator.createSchema(config.type);
+            schemaMap.set(file, fileSchemas);
         });
-
         return schemaMap;
     };
 
-    private getSchemaVersion = (schemaMap: Map<string, TJS.Definition>) => {
+    private getSchemaVersion = (schemaMap: Map<string, Schema>) => {
         const firstEntry = schemaMap.values().next().value;
         return firstEntry["$schema"] ?? "";
     };
@@ -117,12 +109,20 @@ export class SchemaGenerator {
         }
     };
 
-    private writeSchemaMapToValidationSchema = (schemaMap: Map<string, TJS.Definition>) => {
-        const definitions: { [id: string]: TJS.Definition } = {};
-        schemaMap.forEach((schema, key) => {
-            definitions[key] = schema;
+    private writeSchemaMapToValidationSchema = (schemaMap: Map<string, Schema>) => {
+        const definitions: { [id: string]: Schema } = {};
+        schemaMap.forEach((fileSchema) => {
+            const defs = fileSchema.definitions ?? {};
+
+            Object.keys(defs).forEach((key) => {
+                if (definitions[key] !== undefined) {
+                    throw new Error(`Duplicate symbol: ${key} found`);
+                }
+                const schema = defs[key] as Schema;
+                definitions[key] = schema;
+            });
         });
-        const outputBuffer: TJS.Definition = {
+        const outputBuffer: Schema = {
             $schema: this.getSchemaVersion(schemaMap),
             definitions,
         };
@@ -131,32 +131,29 @@ export class SchemaGenerator {
         fs.writeFileSync(this.jsonSchemaOutputFile, JSON.stringify(outputBuffer, null, 4));
     };
 
-    private writeSchemaMapToValidationTypes = async (schemaMap: Map<string, TJS.Definition>, fileList: Array<string>) => {
-        const project = new Project(defaultProjectSettings);
-
-        const symbols = Array.from(schemaMap.keys()).filter((symbol) => {
-            return symbol !== "ISchema" && symbol !== "Schemas";
-        });
+    private writeSchemaMapToValidationTypes = async (schemaMap: Map<string, Schema>) => {
+        const project = new Project(defaultTsMorphProjectSettings);
 
-        const readerProject = new Project();
-        readerProject.addSourceFilesAtPaths(fileList);
+        const symbols: Array<string> = [];
 
         const importMap = new Map<string, Array<string>>();
-        fileList.forEach((file) => {
-            const dir = path.dirname(file);
-            const fileWithoutExtension = path.parse(file).name;
+        schemaMap.forEach((schema, filePath) => {
+            const dir = path.dirname(filePath);
+            const fileWithoutExtension = path.parse(filePath).name;
             const relativeFilePath = path.relative(this.outputPath, dir);
             const importPath = `${relativeFilePath}/${fileWithoutExtension}`;
-            const source = readerProject.getSourceFile(file);
-            source?.getInterfaces().forEach((interfaceDeclaration) => {
-                const structure = interfaceDeclaration.getStructure();
+            const defs = schema.definitions ?? {};
+
+            Object.keys(defs).forEach((symbol) => {
                 const namedImports = importMap.get(importPath) ?? [];
-                namedImports.push(structure.name);
+                namedImports.push(symbol);
                 importMap.set(importPath, namedImports);
+                symbols.push(symbol);
             });
         });
 
         const sourceFile = project.createSourceFile(this.tsSchemaDefinitionOutputFile, {}, defaultCreateFileOptions);
+
         importMap.forEach((namedImports, importPath) => {
             sourceFile.addImportDeclaration({ namedImports, moduleSpecifier: importPath });
         });
@@ -190,12 +187,11 @@ export class SchemaGenerator {
         sourceFile.addExportDeclaration({
             namedExports: ["schemas", "ISchema"],
         });
-
         await project.save();
     };
 
     private writeValidatorFunction = async () => {
-        const project = new Project(defaultProjectSettings);
+        const project = new Project(defaultTsMorphProjectSettings);
         const sourceFile = project.createSourceFile(this.isValidSchemaOutputFile, {}, defaultCreateFileOptions);
         sourceFile.addImportDeclaration({ namespaceImport: "schema", moduleSpecifier: `./${validationSchemaFileName}` });
         sourceFile.addImportDeclaration({ defaultImport: "Ajv", moduleSpecifier: "ajv" });
@@ -203,7 +199,6 @@ export class SchemaGenerator {
             namedImports: ["ISchema", "schemas"],
             moduleSpecifier: `./${path.parse(schemaDefinitionFileName).name}`,
         });
-
         sourceFile.addVariableStatement({
             declarationKind: VariableDeclarationKind.Const,
             declarations: [

package/src/index.ts

@@ -13,6 +13,7 @@ export interface ICommandOptions {
     readonly rootPath: string;
     readonly output: string;
     readonly helpers: boolean;
+    readonly additionalProperties: boolean;
 }
 
 program.option(
@@ -27,6 +28,7 @@ program.option(
     defaultOutputFolder
 );
 program.option("--no-helpers", "Only generate JSON schema without typescript helper files", true);
+program.option("--additionalProperties", "Allow additional properties to pass validation", false);
 
 program.parse();