@flink-app/flink 0.4.4 → 0.4.6

package/dist/src/mock-data-generator.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var mock_json_schema_1 = require("mock-json-schema");
 var generateMockData = function (schema) {
     // TODO: mock-json-schema does not seem to handle `examples` array, might want to switch to json-schema-faker
-    var mockData = (0, mock_json_schema_1.mock)(schema);
+    var mockData = mock_json_schema_1.mock(schema);
     return mockData;
 };
 exports.default = generateMockData;

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

@@ -14,7 +14,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+        while (_) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {
@@ -39,17 +39,17 @@ 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");
 var FlinkLog_1 = require("./FlinkLog");
 function handlersPath(appRoot) {
-    return (0, path_1.join)(appRoot, "src", "handlers");
+    return path_1.join(appRoot, "src", "handlers");
 }
 exports.handlersPath = handlersPath;
 function schemasPath(appRoot) {
-    return (0, path_1.join)(appRoot, "src", "schemas");
+    return path_1.join(appRoot, "src", "schemas");
 }
 exports.schemasPath = schemasPath;
 function isRouteMatch(req, routes) {
@@ -73,14 +73,14 @@ function getHandlerFiles(appRoot) {
             switch (_a.label) {
                 case 0:
                     _a.trys.push([0, 2, , 3]);
-                    return [4 /*yield*/, (0, tiny_glob_1.default)("**/*.ts", {
+                    return [4 /*yield*/, tiny_glob_1.default("**/*.ts", {
                             cwd: handlersPath(appRoot),
                             absolute: true,
                         })];
                 case 1: return [2 /*return*/, _a.sent()];
                 case 2:
                     err_1 = _a.sent();
-                    FlinkLog_1.log.debug("Failed getting handler files: ".concat(err_1));
+                    FlinkLog_1.log.debug("Failed getting handler files: " + err_1);
                     return [2 /*return*/, []];
                 case 3: return [2 /*return*/];
             }
@@ -95,7 +95,7 @@ function getSchemaFiles(appRoot) {
             switch (_a.label) {
                 case 0:
                     _a.trys.push([0, 2, , 3]);
-                    return [4 /*yield*/, (0, tiny_glob_1.default)("**/*.ts", {
+                    return [4 /*yield*/, tiny_glob_1.default("**/*.ts", {
                             cwd: schemasPath(appRoot),
                             absolute: true,
                         })];
@@ -138,68 +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 ".concat(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 ".concat(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 ".concat(prop.$ref));
-                }
-            }
-            else if (prop.type === "object" || prop.type === "array") {
-                schemaToDeRef.properties[k] = deRefSchema(prop, jsonSchemas);
-            }
-        }
-    }
-    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.4",
+    "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": "f7b39bc69a69b51311352b1368093bc4c5d05a39"
+    "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 };