@flink-app/flink 0.4.5 → 0.4.6

package/dist/src/TypeScriptCompiler.js

@@ -475,8 +475,8 @@ var TypeScriptCompiler = /** @class */ (function () {
     };
     TypeScriptCompiler.prototype.initJsonSchemaGenerator = function () {
         var conf = {
-        // expose: "",
-        // topRef: false,
+            expose: "none",
+            topRef: false, // Removes the wrapper object around the schema.
         };
         var formatter = ts_json_schema_generator_1.createFormatter(conf);
         var parser = ts_json_schema_generator_1.createParser(this.project.getProgram().compilerObject, conf);
@@ -486,17 +486,18 @@ var TypeScriptCompiler = /** @class */ (function () {
     TypeScriptCompiler.prototype.generateAndSaveJsonSchemas = function (schemas) {
         return __awaiter(this, void 0, void 0, function () {
             var jsonSchemas, _i, schemas_1, _a, reqSchemaType, resSchemaType, mergedSchemas, filePath;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
+            var _b, _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
                     case 0:
                         jsonSchemas = [];
                         for (_i = 0, schemas_1 = schemas; _i < schemas_1.length; _i++) {
                             _a = schemas_1[_i], reqSchemaType = _a.reqSchemaType, resSchemaType = _a.resSchemaType;
                             if (reqSchemaType) {
-                                jsonSchemas.push(this.generateJsonSchema(reqSchemaType));
+                                jsonSchemas.push({ definitions: (_b = {}, _b[reqSchemaType] = this.generateJsonSchema(reqSchemaType), _b) });
                             }
                             if (resSchemaType) {
-                                jsonSchemas.push(this.generateJsonSchema(resSchemaType));
+                                jsonSchemas.push({ definitions: (_c = {}, _c[resSchemaType] = this.generateJsonSchema(resSchemaType), _c) });
                             }
                         }
                         mergedSchemas = jsonSchemas.reduce(function (out, schema) {
@@ -512,7 +513,7 @@ var TypeScriptCompiler = /** @class */ (function () {
                         filePath = path_1.join(this.cwd, ".flink", "schemas", "schemas.json");
                         return [4 /*yield*/, FsUtils_1.writeJsonFile(filePath, mergedSchemas)];
                     case 1:
-                        _b.sent();
+                        _d.sent();
                         this.project.addSourceFileAtPath(filePath);
                         return [2 /*return*/, mergedSchemas];
                 }
@@ -612,15 +613,15 @@ var TypeScriptCompiler = /** @class */ (function () {
         for (var _i = 0, handlers_1 = handlers; _i < handlers_1.length; _i++) {
             var _a = handlers_1[_i], sourceFile = _a.sourceFile, reqSchemaType = _a.reqSchemaType, resSchemaType = _a.resSchemaType;
             if (reqSchemaType && !jsonSchemaDefs[reqSchemaType]) {
-                console.error("Handler " + sourceFile.getBaseName + " has request schema\u00A0(" + reqSchemaType + ") defined, but JSON schema has been generated");
+                console.error("Handler " + sourceFile.getBaseName() + " has request schema\u00A0(" + reqSchemaType + ") defined, but no JSON schema has been generated");
                 continue;
             }
             if (resSchemaType && !jsonSchemaDefs[resSchemaType]) {
-                console.error("Handler " + sourceFile.getBaseName + " has response schema\u00A0(" + resSchemaType + ") defined, but JSON schema has been generated");
+                console.error("Handler " + sourceFile.getBaseName() + " has response schema\u00A0(" + resSchemaType + ") defined, but no JSON schema has been generated");
                 continue;
             }
-            var reqJsonSchema = JSON.stringify(reqSchemaType ? utils_1.deRefSchema(jsonSchemaDefs[reqSchemaType], jsonSchemas) : undefined);
-            var resJsonSchema = JSON.stringify(resSchemaType ? utils_1.deRefSchema(jsonSchemaDefs[resSchemaType], jsonSchemas) : undefined);
+            var reqJsonSchema = JSON.stringify(reqSchemaType ? jsonSchemaDefs[reqSchemaType] : undefined);
+            var resJsonSchema = JSON.stringify(resSchemaType ? jsonSchemaDefs[resSchemaType] : undefined);
             sourceFile.addVariableStatement({
                 declarationKind: ts_morph_1.VariableDeclarationKind.Const,
                 isExported: true,

package/dist/src/utils.d.ts

@@ -1,5 +1,4 @@
 import { Request } from "express";
-import { JSONSchema7, JSONSchema7Definition } from "json-schema";
 import { HttpMethod } from "./FlinkHttpHandler";
 import { FlinkResponse } from "./FlinkResponse";
 export declare function handlersPath(appRoot: string): string;
@@ -18,13 +17,4 @@ export declare function getRepoInstanceName(fn: string): string;
  * if it starts with i.e "GetFoo"
  */
 export declare function getHttpMethodFromHandlerName(handlerFilename: string): HttpMethod | undefined;
-/**
- * Recursively iterates thru json schema properties and replaces any $ref
- * with the actual definiton if it exists withing provided `jsonSchemas`.
- *
- * @param schemaToDeRef
- * @param jsonSchemas
- * @returns
- */
-export declare function deRefSchema(schemaToDeRef: JSONSchema7Definition, jsonSchemas: JSONSchema7): boolean | JSONSchema7;
 export declare function getJsDocComment(comment: string): string;

package/dist/src/utils.js

@@ -39,7 +39,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getJsDocComment = exports.deRefSchema = exports.getHttpMethodFromHandlerName = exports.getRepoInstanceName = exports.getCollectionNameForRepo = exports.getSchemaFiles = exports.getHandlerFiles = exports.isError = exports.isRouteMatch = exports.schemasPath = exports.handlersPath = void 0;
+exports.getJsDocComment = exports.getHttpMethodFromHandlerName = exports.getRepoInstanceName = exports.getCollectionNameForRepo = exports.getSchemaFiles = exports.getHandlerFiles = exports.isError = exports.isRouteMatch = exports.schemasPath = exports.handlersPath = void 0;
 var path_1 = require("path");
 var tiny_glob_1 = __importDefault(require("tiny-glob"));
 var FlinkHttpHandler_1 = require("./FlinkHttpHandler");
@@ -138,86 +138,6 @@ function getHttpMethodFromHandlerName(handlerFilename) {
         return FlinkHttpHandler_1.HttpMethod.delete;
 }
 exports.getHttpMethodFromHandlerName = getHttpMethodFromHandlerName;
-/**
- * Recursively iterates thru json schema properties and replaces any $ref
- * with the actual definiton if it exists withing provided `jsonSchemas`.
- *
- * @param schemaToDeRef
- * @param jsonSchemas
- * @returns
- */
-function deRefSchema(schemaToDeRef, jsonSchemas) {
-    if (typeof schemaToDeRef === "boolean") {
-        return schemaToDeRef;
-    }
-    if (schemaToDeRef.type === "array") {
-        var items = schemaToDeRef.items;
-        if (items.$ref) {
-            var _a = items.$ref.split("/"), _0 = _a[0], _1 = _a[1], defKey = _a[2];
-            var refedSchema = (jsonSchemas.definitions || {})[defKey];
-            if (refedSchema) {
-                schemaToDeRef.items = deRefSchema(refedSchema, jsonSchemas);
-            }
-            else {
-                console.warn("Failed to find deref " + schemaToDeRef.$ref);
-            }
-        }
-        else {
-            schemaToDeRef.items = deRefSchema(schemaToDeRef.items, jsonSchemas);
-        }
-    }
-    else if (schemaToDeRef.properties) {
-        for (var k in schemaToDeRef.properties) {
-            var prop = schemaToDeRef.properties[k];
-            if (typeof prop === "boolean") {
-                continue;
-            }
-            if (prop.$ref) {
-                var _b = prop.$ref.split("/"), _0 = _b[0], _1 = _b[1], defKey = _b[2];
-                var refedSchema = (jsonSchemas.definitions || {})[defKey];
-                if (refedSchema) {
-                    schemaToDeRef.properties[k] = deRefSchema(refedSchema, jsonSchemas);
-                }
-                else {
-                    console.warn("Failed to find deref " + prop.$ref);
-                }
-            }
-            else if (prop.type === "array" && prop.items.$ref) {
-                var _c = prop.items.$ref.split("/"), _0 = _c[0], _1 = _c[1], defKey = _c[2];
-                var refedSchema = (jsonSchemas.definitions || {})[defKey];
-                if (refedSchema) {
-                    schemaToDeRef.properties[k].items = deRefSchema(refedSchema, jsonSchemas);
-                }
-                else {
-                    console.warn("Failed to find deref " + prop.$ref);
-                }
-            }
-            else if (prop.type === "object" || prop.type === "array") {
-                schemaToDeRef.properties[k] = deRefSchema(prop, jsonSchemas);
-            }
-        }
-    }
-    else if (schemaToDeRef.anyOf) {
-        var i = 0;
-        for (var _i = 0, _d = schemaToDeRef.anyOf; _i < _d.length; _i++) {
-            var anyOf = _d[_i];
-            var anyOfSchema = anyOf;
-            if (anyOfSchema.$ref) {
-                var _e = anyOfSchema.$ref.split("/"), _0 = _e[0], _1 = _e[1], defKey = _e[2];
-                var refedSchema = (jsonSchemas.definitions || {})[defKey];
-                if (refedSchema) {
-                    schemaToDeRef.anyOf[i] = deRefSchema(refedSchema, jsonSchemas);
-                }
-                else {
-                    console.warn("Failed to find deref " + anyOfSchema.$ref);
-                }
-            }
-            i++;
-        }
-    }
-    return schemaToDeRef;
-}
-exports.deRefSchema = deRefSchema;
 function getJsDocComment(comment) {
     var rows = comment.split("\n").map(function (line) {
         line = line.trim();

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@flink-app/flink",
-    "version": "0.4.5",
+    "version": "0.4.6",
     "description": "Typescript only framework for creating REST-like APIs on top of Express and mongodb",
     "types": "dist/src/index.d.ts",
     "main": "dist/src/index.js",
@@ -65,5 +65,5 @@
         "rimraf": "^3.0.2",
         "ts-node": "^9.1.1"
     },
-    "gitHead": "38a0ca4c987f280accc5f4c7f408e51f7b076587"
+    "gitHead": "fc4e2f5febd2b8594d3ade42beb4e85eb7ada4ed"
 }

package/spec/mock-project/dist/src/handlers/GetCar.js

@@ -56,4 +56,4 @@ var GetCar = function (_a) {
 };
 exports.default = GetCar;
 exports.__assumedHttpMethod = "get", exports.__file = "GetCar.ts", exports.__query = [{ description: "For pagination", name: "page" }], exports.__params = [{ description: "", name: "id" }];
-exports.__schemas = { reqSchema: undefined, resSchema: { "type": "object", "additionalProperties": false, "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"] } };
+exports.__schemas = { reqSchema: undefined, resSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"], "definitions": {} } };

package/spec/mock-project/dist/src/handlers/GetCar2.js

@@ -58,4 +58,4 @@ var GetCar2 = function (_a) {
 };
 exports.default = GetCar2;
 exports.__assumedHttpMethod = "get", exports.__file = "GetCar2.ts", exports.__query = [], exports.__params = [];
-exports.__schemas = { reqSchema: undefined, resSchema: { "type": "object", "properties": { "model": { "type": "object", "properties": { "name": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["name"], "additionalProperties": false }, "engine": { "type": "object", "properties": { "name": { "type": "string" } }, "required": ["name"], "additionalProperties": false } }, "required": ["model", "engine"], "additionalProperties": false } };
+exports.__schemas = { reqSchema: undefined, resSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "model": { "type": "object", "properties": { "name": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["name"], "additionalProperties": false }, "engine": { "type": "object", "properties": { "name": { "type": "string" } }, "required": ["name"], "additionalProperties": false } }, "required": ["model", "engine"], "additionalProperties": false, "definitions": {} } };

package/spec/mock-project/dist/src/handlers/GetCarWithArraySchema.js

@@ -52,4 +52,4 @@ var GetCarWithArraySchema = function (_a) {
 };
 exports.default = GetCarWithArraySchema;
 exports.__assumedHttpMethod = "get", exports.__file = "GetCarWithArraySchema.ts", exports.__query = [], exports.__params = [];
-exports.__schemas = { reqSchema: undefined, resSchema: { "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"], "additionalProperties": false } } };
+exports.__schemas = { reqSchema: undefined, resSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": { "type": "object", "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"], "additionalProperties": false }, "definitions": {} } };

package/spec/mock-project/dist/src/handlers/GetCarWithArraySchema2.js

@@ -52,4 +52,4 @@ var GetCarWithArraySchema2 = function (_a) {
 };
 exports.default = GetCarWithArraySchema2;
 exports.__assumedHttpMethod = "get", exports.__file = "GetCarWithArraySchema2.ts", exports.__query = [], exports.__params = [];
-exports.__schemas = { reqSchema: undefined, resSchema: { "type": "array", "items": { "type": "object", "properties": { "car": { "type": "object", "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"], "additionalProperties": false } }, "required": ["car"], "additionalProperties": false } } };
+exports.__schemas = { reqSchema: undefined, resSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": { "type": "object", "properties": { "car": { "type": "object", "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"], "additionalProperties": false } }, "required": ["car"], "additionalProperties": false }, "definitions": {} } };

package/spec/mock-project/dist/src/handlers/GetCarWithArraySchema3.js

@@ -52,4 +52,4 @@ var GetCarWithArraySchema3 = function (_a) {
 };
 exports.default = GetCarWithArraySchema3;
 exports.__assumedHttpMethod = "get", exports.__file = "GetCarWithArraySchema3.ts", exports.__query = [], exports.__params = [];
-exports.__schemas = { reqSchema: undefined, resSchema: { "type": "array", "items": { "type": "object", "properties": { "car": { "type": "object", "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"], "additionalProperties": false }, "year": { "type": "number" } }, "required": ["car", "year"], "additionalProperties": false } } };
+exports.__schemas = { reqSchema: undefined, resSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": { "type": "object", "properties": { "car": { "type": "object", "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"], "additionalProperties": false }, "year": { "type": "number" } }, "required": ["car", "year"], "additionalProperties": false }, "definitions": {} } };

package/spec/mock-project/dist/src/handlers/GetCarWithLiteralSchema.js

@@ -54,4 +54,4 @@ var GetCarWithLiteralSchema = function (_a) {
 };
 exports.default = GetCarWithLiteralSchema;
 exports.__assumedHttpMethod = "get", exports.__file = "GetCarWithLiteralSchema.ts", exports.__query = [], exports.__params = [];
-exports.__schemas = { reqSchema: undefined, resSchema: { "type": "object", "properties": { "car": { "type": "object", "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"], "additionalProperties": false } }, "required": ["car"], "additionalProperties": false } };
+exports.__schemas = { reqSchema: undefined, resSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "car": { "type": "object", "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"], "additionalProperties": false } }, "required": ["car"], "additionalProperties": false, "definitions": {} } };

package/spec/mock-project/dist/src/handlers/GetCarWithLiteralSchema2.js

@@ -54,4 +54,4 @@ var GetCarWithLiteralSchema2 = function (_a) {
 };
 exports.default = GetCarWithLiteralSchema2;
 exports.__assumedHttpMethod = "get", exports.__file = "GetCarWithLiteralSchema2.ts", exports.__query = [], exports.__params = [];
-exports.__schemas = { reqSchema: undefined, resSchema: { "type": "object", "properties": { "car": { "type": "object", "properties": { "nestedCar": { "type": "object", "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"], "additionalProperties": false } }, "required": ["nestedCar"], "additionalProperties": false } }, "required": ["car"], "additionalProperties": false } };
+exports.__schemas = { reqSchema: undefined, resSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "car": { "type": "object", "properties": { "nestedCar": { "type": "object", "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"], "additionalProperties": false } }, "required": ["nestedCar"], "additionalProperties": false } }, "required": ["car"], "additionalProperties": false, "definitions": {} } };

package/spec/mock-project/dist/src/handlers/GetCarWithSchemaInFile.js

@@ -57,4 +57,4 @@ var GetCarWithSchemaInFile = function (_a) {
 };
 exports.default = GetCarWithSchemaInFile;
 exports.__assumedHttpMethod = "get", exports.__file = "GetCarWithSchemaInFile.ts", exports.__query = [], exports.__params = [];
-exports.__schemas = { reqSchema: undefined, resSchema: { "type": "object", "properties": { "model": { "type": "string" } }, "required": ["model"], "additionalProperties": false } };
+exports.__schemas = { reqSchema: undefined, resSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "model": { "type": "string" } }, "required": ["model"], "additionalProperties": false, "definitions": {} } };

package/spec/mock-project/dist/src/handlers/GetCarWithSchemaInFile2.js

@@ -57,4 +57,4 @@ var GetCarWithSchemaInFile2 = function (_a) {
 };
 exports.default = GetCarWithSchemaInFile2;
 exports.__assumedHttpMethod = "get", exports.__file = "GetCarWithSchemaInFile2.ts", exports.__query = [], exports.__params = [];
-exports.__schemas = { reqSchema: undefined, resSchema: { "type": "object", "properties": { "car": { "type": "object", "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"], "additionalProperties": false } }, "required": ["car"], "additionalProperties": false } };
+exports.__schemas = { reqSchema: undefined, resSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "car": { "type": "object", "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"], "additionalProperties": false } }, "required": ["car"], "additionalProperties": false, "definitions": {} } };

package/spec/mock-project/dist/src/handlers/ManuallyAddedHandler.js

@@ -53,4 +53,4 @@ var manuallyAddedHandler = function (_a) {
 };
 exports.default = manuallyAddedHandler;
 exports.__assumedHttpMethod = "", exports.__file = "ManuallyAddedHandler.ts", exports.__query = [], exports.__params = [];
-exports.__schemas = { reqSchema: { "type": "object", "additionalProperties": false, "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"] }, resSchema: undefined };
+exports.__schemas = { reqSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"], "definitions": {} }, resSchema: undefined };

package/spec/mock-project/dist/src/handlers/ManuallyAddedHandler2.js

@@ -55,4 +55,4 @@ var manuallyAddedHandler = function (_a) {
 };
 exports.default = manuallyAddedHandler;
 exports.__assumedHttpMethod = "", exports.__file = "ManuallyAddedHandler2.ts", exports.__query = [], exports.__params = [];
-exports.__schemas = { reqSchema: { "type": "object", "additionalProperties": false, "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"] }, resSchema: undefined };
+exports.__schemas = { reqSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"], "definitions": {} }, resSchema: undefined };

package/spec/mock-project/dist/src/handlers/PostCar.js

@@ -54,4 +54,4 @@ var PostCar = function (_a) {
 };
 exports.default = PostCar;
 exports.__assumedHttpMethod = "post", exports.__file = "PostCar.ts", exports.__query = [], exports.__params = [];
-exports.__schemas = { reqSchema: { "type": "object", "additionalProperties": false, "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"] }, resSchema: { "type": "object", "additionalProperties": false, "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"] } };
+exports.__schemas = { reqSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"], "definitions": {} }, resSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"], "definitions": {} } };

package/spec/mock-project/dist/src/handlers/PutCar.js

@@ -54,4 +54,4 @@ var PutCar = function (_a) {
 };
 exports.default = PutCar;
 exports.__assumedHttpMethod = "put", exports.__file = "PutCar.ts", exports.__query = [], exports.__params = [];
-exports.__schemas = { reqSchema: { "type": "object", "additionalProperties": false, "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"] }, resSchema: undefined };
+exports.__schemas = { reqSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": { "model": { "type": "string" }, "metadata": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false } }, "required": ["model"], "definitions": {} }, resSchema: undefined };

package/spec/utils.spec.ts

@@ -1,89 +1,7 @@
 import { JSONSchema7 } from "json-schema";
-import { deRefSchema, getJsDocComment } from "../src/utils";
+import { getJsDocComment } from "../src/utils";
 
 describe("Utils", () => {
-    describe("deref", () => {
-        it("should de-ref json schema", () => {
-            const dereffedSchema = deRefSchema(jsonSchemas.definitions!.GetCar2_10_ResSchema, jsonSchemas);
-
-            const schema = dereffedSchema as JSONSchema7;
-
-            // @ts-ignore
-            expect(schema.properties.engine.type).toBe("object");
-
-            // @ts-ignore
-            expect(schema.properties.model.properties.engine.type).toBe("object");
-
-            // @ts-ignore
-            expect(schema.properties.tires.items.type).toBe("object");
-        });
-
-        it("should de-ref json schema (nested prop)", () => {
-            const dereffedSchema = deRefSchema(jsonSchemas.definitions!.Login, jsonSchemas);
-
-            const schema = dereffedSchema as JSONSchema7;
-
-            // @ts-ignore
-            expect(schema.properties.user.properties.profile.type).toBe("object");
-        });
-
-        it("should de-ref json schema which is an array", () => {
-            const dereffedSchema = deRefSchema(jsonSchemas.definitions!.Cars, jsonSchemas);
-
-            const schema = dereffedSchema as JSONSchema7;
-
-            expect(schema.type).toBe("array");
-
-            // @ts-ignore
-            expect(schema.items.type).toBe("object");
-        });
-
-        it("should de-ref json schema which is an array 2", () => {
-            const dereffedSchema = deRefSchema(jsonSchemas.definitions!.Cars2, jsonSchemas);
-
-            const schema = dereffedSchema as JSONSchema7;
-
-            expect(schema.type).toBe("array");
-
-            // @ts-ignore
-            expect(schema.items.type).toBe("object");
-
-            // @ts-ignore
-            expect(schema.items.properties.model.type).toBe("object");
-        });
-
-        it("should de-ref complex json schema", () => {
-            const dereffedSchema = deRefSchema(jsonSchemasSet2.definitions!.GetStorages_9_ResSchema, jsonSchemasSet2);
-
-            const schema = dereffedSchema as JSONSchema7;
-
-            expect(schema.type).toBe("object");
-
-            // @ts-ignore
-            expect(schema.properties.storages.type).toBe("array");
-
-            // @ts-ignore
-            expect(schema.properties.storages.items.properties.metadata.type).toBe("object");
-        });
-
-        it("should de-ref with anyOf in array", () => {
-            const dereffedSchema = deRefSchema(jsonSchemaSet3.definitions!.GetStorages_9_ResSchema, jsonSchemaSet3);
-
-            const schema = dereffedSchema as JSONSchema7;
-
-            expect(schema.type).toBe("object");
-
-            // @ts-ignore
-            expect(schema.properties.storages.type).toBe("array");
-
-            // @ts-ignore
-            expect(schema.properties.storages.items.anyOf[0].type).toBe("object");
-
-            // @ts-ignore
-            expect(schema.properties.storages.items.anyOf[1].type).toBe("object");
-        });
-    });
-
     describe("getJsDocComment", () => {
         it("should strip comment chars and return string", () => {
             const comment = `

package/src/TypeScriptCompiler.ts

@@ -19,7 +19,7 @@ import {
 } from "ts-morph";
 import { writeJsonFile } from "./FsUtils";
 import { addImports, getDefaultExport, getInterfaceName, getTypeMetadata, getTypesToImport } from "./TypeScriptUtils";
-import { deRefSchema, getCollectionNameForRepo, getHttpMethodFromHandlerName, getRepoInstanceName } from "./utils";
+import { getCollectionNameForRepo, getHttpMethodFromHandlerName, getRepoInstanceName } from "./utils";
 
 class TypeScriptCompiler {
     private project: Project;
@@ -438,8 +438,8 @@ import "..${appEntryScript.replace(/\.ts/g, "")}";
 
     private initJsonSchemaGenerator() {
         const conf: Config = {
-            // expose: "",
-            // topRef: false,
+            expose: "none", // Do not create shared $ref definitions.
+            topRef: false, // Removes the wrapper object around the schema.
         };
         const formatter = createFormatter(conf);
         const parser = createParser(this.project.getProgram().compilerObject, conf);
@@ -453,10 +453,10 @@ import "..${appEntryScript.replace(/\.ts/g, "")}";
 
         for (const { reqSchemaType, resSchemaType } of schemas) {
             if (reqSchemaType) {
-                jsonSchemas.push(this.generateJsonSchema(reqSchemaType));
+                jsonSchemas.push({ definitions: { [reqSchemaType]: this.generateJsonSchema(reqSchemaType) } });
             }
             if (resSchemaType) {
-                jsonSchemas.push(this.generateJsonSchema(resSchemaType));
+                jsonSchemas.push({ definitions: { [resSchemaType]: this.generateJsonSchema(resSchemaType) } });
             }
         }
 
@@ -594,17 +594,17 @@ ${this.parsedTsSchemas.join("\n\n")}`
 
         for (const { sourceFile, reqSchemaType, resSchemaType } of handlers) {
             if (reqSchemaType && !jsonSchemaDefs[reqSchemaType]) {
-                console.error(`Handler ${sourceFile.getBaseName} has request schema (${reqSchemaType}) defined, but JSON schema has been generated`);
+                console.error(`Handler ${sourceFile.getBaseName()} has request schema (${reqSchemaType}) defined, but no JSON schema has been generated`);
                 continue;
             }
 
             if (resSchemaType && !jsonSchemaDefs[resSchemaType]) {
-                console.error(`Handler ${sourceFile.getBaseName} has response schema (${resSchemaType}) defined, but JSON schema has been generated`);
+                console.error(`Handler ${sourceFile.getBaseName()} has response schema (${resSchemaType}) defined, but no JSON schema has been generated`);
                 continue;
             }
 
-            const reqJsonSchema = JSON.stringify(reqSchemaType ? deRefSchema(jsonSchemaDefs[reqSchemaType], jsonSchemas) : undefined);
-            const resJsonSchema = JSON.stringify(resSchemaType ? deRefSchema(jsonSchemaDefs[resSchemaType], jsonSchemas) : undefined);
+            const reqJsonSchema = JSON.stringify(reqSchemaType ? jsonSchemaDefs[reqSchemaType] : undefined);
+            const resJsonSchema = JSON.stringify(resSchemaType ? jsonSchemaDefs[resSchemaType] : undefined);
 
             sourceFile.addVariableStatement({
                 declarationKind: VariableDeclarationKind.Const,

package/src/utils.ts

@@ -1,5 +1,4 @@
 import { Request } from "express";
-import { JSONSchema7, JSONSchema7Definition } from "json-schema";
 import { join, sep } from "path";
 import tinyGlob from "tiny-glob";
 import { HttpMethod } from "./FlinkHttpHandler";
@@ -78,84 +77,6 @@ export function getHttpMethodFromHandlerName(handlerFilename: string) {
     if (handlerFilename.startsWith(HttpMethod.delete)) return HttpMethod.delete;
 }
 
-/**
- * Recursively iterates thru json schema properties and replaces any $ref
- * with the actual definiton if it exists withing provided `jsonSchemas`.
- *
- * @param schemaToDeRef
- * @param jsonSchemas
- * @returns
- */
-export function deRefSchema(schemaToDeRef: JSONSchema7Definition, jsonSchemas: JSONSchema7) {
-    if (typeof schemaToDeRef === "boolean") {
-        return schemaToDeRef;
-    }
-
-    if (schemaToDeRef.type === "array") {
-        const items = schemaToDeRef.items as JSONSchema7;
-
-        if (items.$ref) {
-            const [_0, _1, defKey] = items.$ref.split("/");
-            const refedSchema = (jsonSchemas.definitions || {})[defKey];
-
-            if (refedSchema) {
-                schemaToDeRef.items = deRefSchema(refedSchema, jsonSchemas);
-            } else {
-                console.warn(`Failed to find deref ${schemaToDeRef.$ref}`);
-            }
-        } else {
-            schemaToDeRef.items = deRefSchema(schemaToDeRef.items as JSONSchema7, jsonSchemas);
-        }
-    } else if (schemaToDeRef.properties) {
-        for (const k in schemaToDeRef.properties) {
-            let prop = schemaToDeRef.properties[k];
-
-            if (typeof prop === "boolean") {
-                continue;
-            }
-
-            if (prop.$ref) {
-                const [_0, _1, defKey] = prop.$ref.split("/");
-                const refedSchema = (jsonSchemas.definitions || {})[defKey];
-                if (refedSchema) {
-                    schemaToDeRef.properties[k] = deRefSchema(refedSchema, jsonSchemas);
-                } else {
-                    console.warn(`Failed to find deref ${prop.$ref}`);
-                }
-            } else if (prop.type === "array" && (prop.items as JSONSchema7).$ref) {
-                const [_0, _1, defKey] = (prop.items as JSONSchema7).$ref!.split("/");
-                const refedSchema = (jsonSchemas.definitions || {})[defKey];
-                if (refedSchema) {
-                    (schemaToDeRef.properties[k] as JSONSchema7).items = deRefSchema(refedSchema, jsonSchemas);
-                } else {
-                    console.warn(`Failed to find deref ${prop.$ref}`);
-                }
-            } else if (prop.type === "object" || prop.type === "array") {
-                schemaToDeRef.properties[k] = deRefSchema(prop, jsonSchemas);
-            }
-        }
-    } else if (schemaToDeRef.anyOf) {
-        let i = 0;
-        for (const anyOf of schemaToDeRef.anyOf) {
-            const anyOfSchema = anyOf as JSONSchema7;
-
-            if (anyOfSchema.$ref) {
-                const [_0, _1, defKey] = anyOfSchema.$ref.split("/");
-                const refedSchema = (jsonSchemas.definitions || {})[defKey];
-                if (refedSchema) {
-                    schemaToDeRef.anyOf[i] = deRefSchema(refedSchema, jsonSchemas);
-                } else {
-                    console.warn(`Failed to find deref ${anyOfSchema.$ref}`);
-                }
-            }
-
-            i++;
-        }
-    }
-
-    return schemaToDeRef;
-}
-
 export function getJsDocComment(comment: string) {
     const rows = comment.split("\n").map((line) => {
         line = line.trim();