@flink-app/flink 0.2.0-beta.9 → 0.3.7

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) Frost Experience AB https://www.frost.se
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/cli/generate-schemas.ts

@@ -110,7 +110,7 @@ module.exports = async function run(args: string[]) {
       console.error(
         "Failed to generate schema in file",
         sf.getBaseName() + ":",
-        err.message
+        err
       );
     }
   }

package/dist/cli/generate-schemas.js

@@ -106,7 +106,7 @@ module.exports = function run(args) {
                             // console.log("Created schemas");
                         }
                         catch (err) {
-                            console.error("Failed to generate schema in file", sf.getBaseName() + ":", err.message);
+                            console.error("Failed to generate schema in file", sf.getBaseName() + ":", err);
                         }
                     }
                     mergedSchemas = jsonSchemas.reduce(function (out, schema) {

package/dist/src/FlinkApp.js

@@ -198,7 +198,6 @@ var FlinkApp = /** @class */ (function () {
      * Typescript compiler will scan handler function and set schemas
      * which are derived from handler function type arguments.
      */
-    // TODO: Rename to addHandler
     FlinkApp.prototype.addHandler = function (handler, routePropsOverride) {
         var _a, _b, _c, _d, _e, _f;
         if (this.routingConfigured) {

package/dist/src/FlinkHttpHandler.d.ts

@@ -11,6 +11,9 @@ export declare enum HttpMethod {
 }
 declare type Params = Request["params"];
 declare type Query = Request["query"];
+/**
+ * Flink request extends express Request but adds reqId and user object.
+ */
 export declare type FlinkRequest<T = any, P = Params, Q = Query> = Request<P, any, T, Q> & {
     reqId: string;
     user?: any;
@@ -84,7 +87,7 @@ export declare type GetHandler<Ctx extends FlinkContext, ResSchema = any, P exte
  * `import * as FooHandler from "./src/handlers/FooHandler"
  */
 export declare type HandlerFile = {
-    default: Handler<any>;
+    default: Handler<any, any, any, any, any>;
     Route?: RouteProps;
     /**
      * Name of schemas, is set at compile time by Flink compiler.

package/dist/src/FlinkRepo.d.ts

@@ -9,7 +9,7 @@ export declare abstract class FlinkRepo<C extends FlinkContext, Model = any> {
     get ctx(): FlinkContext;
     constructor(collectionName: string, db: Db);
     findAll(query?: {}): Promise<Model[]>;
-    getBydId(id: string): Promise<Model | null>;
+    getById(id: string): Promise<Model | null>;
     getOne(query?: {}): Promise<Model | null>;
     create<C = Omit<Model, "_id">>(model: C): Promise<C & {
         _id: string;

package/dist/src/FlinkRepo.js

@@ -64,7 +64,7 @@ var FlinkRepo = /** @class */ (function () {
             });
         });
     };
-    FlinkRepo.prototype.getBydId = function (id) {
+    FlinkRepo.prototype.getById = function (id) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
                 return [2 /*return*/, this.collection.findOne({ _id: new mongodb_1.ObjectID(id) })];

package/dist/src/FlinkResponse.d.ts

@@ -1,3 +1,4 @@
+import { Response, Request } from "express";
 export interface FlinkResponse<T = any> {
     /**
      * Unique id of request.
@@ -36,3 +37,5 @@ export interface FlinkResponse<T = any> {
         [x: string]: string;
     };
 }
+export declare type ExpressResponse = Response;
+export declare type ExpressRequest = Request;

package/dist/src/FsUtils.js

@@ -110,7 +110,7 @@ function writeJsonFile(path, content, opts) {
                     }
                     catch (err) {
                         console.error("Failed to parse content into json string");
-                        throw new Error(err);
+                        throw err;
                     }
                     return [2 /*return*/, fs_1.promises.writeFile(path, jsonStr)];
             }

package/dist/src/utils.js

@@ -150,27 +150,25 @@ function deRefSchema(schemaToDeRef, jsonSchemas) {
     if (typeof schemaToDeRef === "boolean") {
         return schemaToDeRef;
     }
-    var theSchemaToDeRef = schemaToDeRef;
-    if (theSchemaToDeRef.type === "array") {
-        var items = theSchemaToDeRef.items;
+    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) {
-                theSchemaToDeRef.items = refedSchema;
-                deRefSchema(refedSchema, jsonSchemas);
+                schemaToDeRef.items = deRefSchema(refedSchema, jsonSchemas);
             }
             else {
                 console.warn("Failed to find deref " + schemaToDeRef.$ref);
             }
         }
         else {
-            deRefSchema(items, jsonSchemas);
+            schemaToDeRef.items = deRefSchema(schemaToDeRef.items, jsonSchemas);
         }
     }
-    else if (theSchemaToDeRef.properties) {
-        for (var k in theSchemaToDeRef.properties) {
-            var prop = theSchemaToDeRef.properties[k];
+    else if (schemaToDeRef.properties) {
+        for (var k in schemaToDeRef.properties) {
+            var prop = schemaToDeRef.properties[k];
             if (typeof prop === "boolean") {
                 continue;
             }
@@ -178,8 +176,7 @@ function deRefSchema(schemaToDeRef, jsonSchemas) {
                 var _b = prop.$ref.split("/"), _0 = _b[0], _1 = _b[1], defKey = _b[2];
                 var refedSchema = (jsonSchemas.definitions || {})[defKey];
                 if (refedSchema) {
-                    theSchemaToDeRef.properties[k] = refedSchema;
-                    deRefSchema(refedSchema, jsonSchemas);
+                    schemaToDeRef.properties[k] = deRefSchema(refedSchema, jsonSchemas);
                 }
                 else {
                     console.warn("Failed to find deref " + prop.$ref);
@@ -189,19 +186,18 @@ function deRefSchema(schemaToDeRef, jsonSchemas) {
                 var _c = prop.items.$ref.split("/"), _0 = _c[0], _1 = _c[1], defKey = _c[2];
                 var refedSchema = (jsonSchemas.definitions || {})[defKey];
                 if (refedSchema) {
-                    prop.items = refedSchema;
-                    deRefSchema(refedSchema, jsonSchemas);
+                    schemaToDeRef.properties[k].items = deRefSchema(refedSchema, jsonSchemas);
                 }
                 else {
                     console.warn("Failed to find deref " + prop.$ref);
                 }
             }
-            else if (prop.type === "object") {
-                deRefSchema(prop, jsonSchemas);
+            else if (prop.type === "object" || prop.type === "array") {
+                schemaToDeRef.properties[k] = deRefSchema(prop, jsonSchemas);
             }
         }
     }
-    return theSchemaToDeRef;
+    return schemaToDeRef;
 }
 exports.deRefSchema = deRefSchema;
 function getJsDocComment(comment) {

package/package.json

@@ -1,66 +1,66 @@
 {
-  "name": "@flink-app/flink",
-  "version": "0.2.0-beta.9",
-  "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",
-  "repository": "FrostDigital/flink",
-  "scripts": {
-    "test": "jasmine-ts --preserve-symlinks --config=./spec/support/jasmine.json",
-    "test:watch": "nodemon --ext ts --exec 'jasmine-ts  --config=./spec/support/jasmine.json'",
-    "start": "ts-node src/index.ts",
-    "postinstall": "npm run build",
-    "prepublish": "npm run build",
-    "build": "tsc --project tsconfig.dist.json",
-    "watch": "nodemon --exec 'tsc --project tsconfig.dist.json'",
-    "clean": "rimraf dist"
-  },
-  "bin": {
-    "flink": "./dist/bin/flink.js"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "author": "",
-  "license": "MIT",
-  "dependencies": {
-    "@types/cors": "^2.8.10",
-    "@types/express": "^4.17.11",
-    "@types/fs-extra": "^9.0.12",
-    "@types/mongodb": "3.6.12",
-    "@types/uuid": "^8.3.0",
-    "ajv": "^8.2.0",
-    "ajv-formats": "^2.1.0",
-    "body-parser": "^1.19.0",
-    "cors": "^2.8.5",
-    "express": "^4.17.1",
-    "folder-hash": "^4.0.1",
-    "fs-extra": "^10.0.0",
-    "mkdirp": "^1.0.4",
-    "mock-json-schema": "^1.0.8",
-    "mongodb": "^3.6.6",
-    "node-color-log": "^5.2.0",
-    "passport": "^0.4.1",
-    "passport-jwt": "^4.0.0",
-    "reflect-metadata": "^0.1.13",
-    "tiny-glob": "^0.2.9",
-    "ts-json-schema-generator": "^0.94.1",
-    "ts-morph": "^11.0.0",
-    "typescript": "4.2.3",
-    "uuid": "^8.3.2"
-  },
-  "devDependencies": {
-    "@types/folder-hash": "^4.0.0",
-    "@types/jasmine": "^3.7.1",
-    "@types/json-schema": "^7.0.7",
-    "@types/mkdirp": "^1.0.1",
-    "@types/node": "^15.0.1",
-    "jasmine": "^3.7.0",
-    "jasmine-spec-reporter": "^7.0.0",
-    "jasmine-ts": "^0.3.3",
-    "nodemon": "^2.0.7",
-    "rimraf": "^3.0.2",
-    "ts-node": "^9.1.1"
-  },
-  "gitHead": "9ea7b28898b3f40b17fa43d5dbbcb1f7c84a4ed6"
+    "name": "@flink-app/flink",
+    "version": "0.3.7",
+    "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",
+    "repository": "FrostDigital/flink",
+    "scripts": {
+        "test": "jasmine-ts --preserve-symlinks --config=./spec/support/jasmine.json",
+        "test:watch": "nodemon --ext ts --exec 'jasmine-ts  --config=./spec/support/jasmine.json'",
+        "start": "ts-node src/index.ts",
+        "postinstall": "npm run build",
+        "prepublish": "npm run build",
+        "build": "tsc --project tsconfig.dist.json",
+        "watch": "nodemon --exec 'tsc --project tsconfig.dist.json'",
+        "clean": "rimraf dist"
+    },
+    "bin": {
+        "flink": "./dist/bin/flink.js"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "author": "",
+    "license": "MIT",
+    "dependencies": {
+        "@types/cors": "^2.8.10",
+        "@types/express": "^4.17.13",
+        "@types/fs-extra": "^9.0.12",
+        "@types/mongodb": "3.6.12",
+        "@types/uuid": "^8.3.0",
+        "ajv": "^8.2.0",
+        "ajv-formats": "^2.1.0",
+        "body-parser": "^1.19.0",
+        "cors": "^2.8.5",
+        "express": "^4.17.1",
+        "folder-hash": "^4.0.1",
+        "fs-extra": "^10.0.0",
+        "mkdirp": "^1.0.4",
+        "mock-json-schema": "^1.0.8",
+        "mongodb": "^3.6.6",
+        "node-color-log": "^5.2.0",
+        "passport": "^0.4.1",
+        "passport-jwt": "^4.0.0",
+        "reflect-metadata": "^0.1.13",
+        "tiny-glob": "^0.2.9",
+        "ts-json-schema-generator": "0.94.1",
+        "ts-morph": "11.0.0",
+        "typescript": "4.2.3",
+        "uuid": "^8.3.2"
+    },
+    "devDependencies": {
+        "@types/folder-hash": "^4.0.0",
+        "@types/jasmine": "^3.7.1",
+        "@types/json-schema": "^7.0.7",
+        "@types/mkdirp": "^1.0.1",
+        "@types/node": "^15.0.1",
+        "jasmine": "^3.7.0",
+        "jasmine-spec-reporter": "^7.0.0",
+        "jasmine-ts": "^0.3.3",
+        "nodemon": "^2.0.7",
+        "rimraf": "^3.0.2",
+        "ts-node": "^9.1.1"
+    },
+    "gitHead": "e61be35839aa8d459dc07613d9bfa919570361f2"
 }

package/spec/FlinkRepo.spec.ts

@@ -31,7 +31,7 @@ describe("FlinkRepo", () => {
   it("should get document by id", async () => {
     const { insertedId } = await collection.insertOne({ name: "foo" });
 
-    const doc = await repo.getBydId(insertedId + "");
+    const doc = await repo.getById(insertedId + "");
 
     expect(doc).toBeDefined();
     expect(doc?.name).toBe("foo");

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" } }, "required": ["model"] } };
+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"] } };

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" } }, "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: { "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 } };

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" } }, "required": ["model"], "additionalProperties": false } } };
+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 } } };

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" } }, "required": ["model"], "additionalProperties": false } }, "required": ["car"], "additionalProperties": false } } };
+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 } } };

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" } }, "required": ["model"], "additionalProperties": false }, "year": { "type": "number" } }, "required": ["car", "year"], "additionalProperties": false } } };
+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 } } };

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" } }, "required": ["model"], "additionalProperties": false } }, "required": ["car"], "additionalProperties": false } };
+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 } };

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" } }, "required": ["model"], "additionalProperties": false } }, "required": ["nestedCar"], "additionalProperties": false } }, "required": ["car"], "additionalProperties": false } };
+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 } };

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" } }, "required": ["model"], "additionalProperties": false } }, "required": ["car"], "additionalProperties": false } };
+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 } };

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" } }, "required": ["model"] }, resSchema: undefined };
+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 };

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" } }, "required": ["model"] }, resSchema: undefined };
+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 };

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" } }, "required": ["model"] }, resSchema: { "type": "object", "additionalProperties": false, "properties": { "model": { "type": "string" } }, "required": ["model"] } };
+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"] } };

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" } }, "required": ["model"] }, resSchema: undefined };
+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 };

package/spec/mock-project/dist/src/schemas/DefaultExportSchema.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/spec/mock-project/src/schemas/Car.ts

@@ -1,5 +1,8 @@
+import Metadata from "./DefaultExportSchema";
+
 interface Car {
   model: string;
+  metadata?: Metadata;
 }
 
 export default Car;

package/spec/mock-project/src/schemas/DefaultExportSchema.ts

@@ -0,0 +1,3 @@
+export default interface Metadata {
+  created?: Date;
+}

package/spec/mock-project/src/schemas/FileWithTwoSchemas.ts

@@ -1,5 +1,8 @@
+import Metadata from "./DefaultExportSchema";
+
 export interface CarModel {
   name: string;
+  metadata?: Metadata;
 }
 
 export interface CarEngine {

package/spec/utils.spec.ts

@@ -63,6 +63,25 @@ describe("Utils", () => {
       // @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"
+      );
+    });
   });
 
   describe("getJsDocComment", () => {
@@ -205,3 +224,42 @@ const jsonSchemas: JSONSchema7 = {
     },
   },
 };
+
+const jsonSchemasSet2: JSONSchema7 = {
+  // $schema: "http://json-schema.org/draft-07/schema#",
+  // $ref: "#/definitions/Schemas",
+  definitions: {
+    Metadata: {
+      type: "object",
+      properties: {
+        created: { type: "string", format: "date-time" },
+        updated: { type: "string", format: "date-time" },
+      },
+      required: ["created"],
+      additionalProperties: false,
+    },
+
+    GetStorages_9_ResSchema: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        storages: {
+          type: "array",
+          items: {
+            type: "object",
+            properties: {
+              _id: { type: "string" },
+              name: { type: "string" },
+              metadata: { $ref: "#/definitions/Metadata" },
+            },
+            required: ["_id", "name", "metadata"],
+            additionalProperties: false,
+          },
+        },
+      },
+      required: ["storages"],
+    },
+
+    UserRole: { type: "string", enum: ["user", "admin", "teamLeader"] },
+  },
+};

package/src/FlinkApp.ts

@@ -288,7 +288,6 @@ export class FlinkApp<C extends FlinkContext> {
    * Typescript compiler will scan handler function and set schemas
    * which are derived from handler function type arguments.
    */
-  // TODO: Rename to addHandler
   public addHandler(
     handler: HandlerFile,
     routePropsOverride?: Partial<HandlerConfig["routeProps"]>
@@ -433,7 +432,7 @@ export class FlinkApp<C extends FlinkContext> {
           log.warn(
             `Handler '${methodAndRoute}' threw unhandled exception ${err}`
           );
-          return res.status(500).json(internalServerError(err));
+          return res.status(500).json(internalServerError(err as any));
         }
 
         if (schema.resSchema && !isError(handlerRes)) {

package/src/FlinkHttpHandler.ts

@@ -14,6 +14,9 @@ export enum HttpMethod {
 type Params = Request["params"];
 type Query = Request["query"];
 
+/**
+ * Flink request extends express Request but adds reqId and user object.
+ */
 export type FlinkRequest<T = any, P = Params, Q = Query> = Request<
   P,
   any,
@@ -110,7 +113,7 @@ export type GetHandler<
  * `import * as FooHandler from "./src/handlers/FooHandler"
  */
 export type HandlerFile = {
-  default: Handler<any>;
+  default: Handler<any, any, any, any, any>;
   Route?: RouteProps;
   /**
    * Name of schemas, is set at compile time by Flink compiler.

package/src/FlinkRepo.ts

@@ -23,14 +23,13 @@ export abstract class FlinkRepo<C extends FlinkContext, Model = any> {
     return this.collection.find(query).toArray();
   }
 
-  async getBydId(id: string): Promise<Model | null> {
+  async getById(id: string): Promise<Model | null> {
     return this.collection.findOne({ _id: new ObjectID(id) });
   }
 
-
   async getOne(query = {}): Promise<Model | null> {
     return this.collection.findOne(query);
-  }  
+  }
 
   async create<C = Omit<Model, "_id">>(model: C): Promise<C & { _id: string }> {
     const { ops } = await this.collection.insertOne(model);

package/src/FlinkResponse.ts

@@ -1,4 +1,4 @@
-import express from "express";
+import { Response, Request } from "express";
 
 export interface FlinkResponse<T = any> {
   /**
@@ -43,3 +43,6 @@ export interface FlinkResponse<T = any> {
     [x: string]: string;
   };
 }
+
+export type ExpressResponse = Response;
+export type ExpressRequest = Request;

package/src/FsUtils.ts

@@ -46,7 +46,7 @@ export async function writeJsonFile(
     jsonStr = JSON.stringify(content, null, 2);
   } catch (err) {
     console.error("Failed to parse content into json string");
-    throw new Error(err);
+    throw err;
   }
 
   return fsPromises.writeFile(path, jsonStr);

package/src/utils.ts

@@ -97,27 +97,27 @@ export function deRefSchema(
     return schemaToDeRef;
   }
 
-  const theSchemaToDeRef = schemaToDeRef as JSONSchema7;
-
-  if (theSchemaToDeRef.type === "array") {
-    const items = theSchemaToDeRef.items as JSONSchema7;
+  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) {
-        theSchemaToDeRef.items = refedSchema as JSONSchema7;
-        deRefSchema(refedSchema, jsonSchemas);
+        schemaToDeRef.items = deRefSchema(refedSchema, jsonSchemas);
       } else {
         console.warn(`Failed to find deref ${schemaToDeRef.$ref}`);
       }
     } else {
-      deRefSchema(items, jsonSchemas);
+      schemaToDeRef.items = deRefSchema(
+        schemaToDeRef.items as JSONSchema7,
+        jsonSchemas
+      );
     }
-  } else if (theSchemaToDeRef.properties) {
-    for (const k in theSchemaToDeRef.properties) {
-      const prop = theSchemaToDeRef.properties[k];
+  } else if (schemaToDeRef.properties) {
+    for (const k in schemaToDeRef.properties) {
+      let prop = schemaToDeRef.properties[k];
 
       if (typeof prop === "boolean") {
         continue;
@@ -127,8 +127,7 @@ export function deRefSchema(
         const [_0, _1, defKey] = prop.$ref.split("/");
         const refedSchema = (jsonSchemas.definitions || {})[defKey];
         if (refedSchema) {
-          theSchemaToDeRef.properties[k] = refedSchema;
-          deRefSchema(refedSchema, jsonSchemas);
+          schemaToDeRef.properties[k] = deRefSchema(refedSchema, jsonSchemas);
         } else {
           console.warn(`Failed to find deref ${prop.$ref}`);
         }
@@ -136,18 +135,19 @@ export function deRefSchema(
         const [_0, _1, defKey] = (prop.items as JSONSchema7).$ref!.split("/");
         const refedSchema = (jsonSchemas.definitions || {})[defKey];
         if (refedSchema) {
-          prop.items = refedSchema;
-          deRefSchema(refedSchema, jsonSchemas);
+          (schemaToDeRef.properties[k] as JSONSchema7).items = deRefSchema(
+            refedSchema,
+            jsonSchemas
+          );
         } else {
           console.warn(`Failed to find deref ${prop.$ref}`);
         }
-      } else if (prop.type === "object") {
-        deRefSchema(prop, jsonSchemas);
+      } else if (prop.type === "object" || prop.type === "array") {
+        schemaToDeRef.properties[k] = deRefSchema(prop, jsonSchemas);
       }
     }
   }
-
-  return theSchemaToDeRef;
+  return schemaToDeRef;
 }
 
 export function getJsDocComment(comment: string) {

package/dist/src/schema/CustomJsonSchemaFormatter.d.ts

@@ -1,8 +0,0 @@
-import { BaseType, Definition, FunctionType, SubTypeFormatter, TypeFormatter } from "ts-json-schema-generator";
-export declare class CustomRefFormatter implements SubTypeFormatter {
-    private childTypeFormatter;
-    constructor(childTypeFormatter: TypeFormatter);
-    supportsType(type: FunctionType): boolean;
-    getDefinition(type: FunctionType): Definition;
-    getChildren(type: FunctionType): BaseType[];
-}

package/dist/src/schema/CustomJsonSchemaFormatter.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomRefFormatter = void 0;
-var ts_json_schema_generator_1 = require("ts-json-schema-generator");
-var CustomRefFormatter = /** @class */ (function () {
-    // You can skip this line if you don't need childTypeFormatter
-    function CustomRefFormatter(childTypeFormatter) {
-        this.childTypeFormatter = childTypeFormatter;
-    }
-    CustomRefFormatter.prototype.supportsType = function (type) {
-        return type instanceof ts_json_schema_generator_1.FunctionType;
-    };
-    CustomRefFormatter.prototype.getDefinition = function (type) {
-        // Return a custom schema for the function property.
-        return {
-            type: "object",
-            properties: {
-                isFunction: {
-                    type: "boolean",
-                    const: true,
-                },
-            },
-        };
-    };
-    // If this type does NOT HAVE children, generally all you need is:
-    CustomRefFormatter.prototype.getChildren = function (type) {
-        return [];
-    };
-    // However, if children ARE supported, you'll need something similar to
-    // this (see src/TypeFormatter/{Array,Definition,etc}.ts for some examples):
-    CustomRefFormatter.prototype.getChildren = function (type) {
-        return this.childTypeFormatter.getChildren(type.getType());
-    };
-    return CustomRefFormatter;
-}());
-exports.CustomRefFormatter = CustomRefFormatter;