@flink-app/flink 0.12.1-alpha.3 → 0.12.1-alpha.35

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

@@ -53,3 +53,5 @@ var GetCarWithLiteralSchema = function (_a) { return __awaiter(void 0, [_a], voi
 exports.default = GetCarWithLiteralSchema;
 exports.__assumedHttpMethod = "get", exports.__file = "GetCarWithLiteralSchema.ts", exports.__query = [], exports.__params = [];
 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": {} } };
+exports.__assumedHttpMethod = "get", exports.__file = "GetCarWithLiteralSchema.ts", exports.__query = [], exports.__params = [];
+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

@@ -53,3 +53,5 @@ var GetCarWithLiteralSchema2 = function (_a) { return __awaiter(void 0, [_a], vo
 exports.default = GetCarWithLiteralSchema2;
 exports.__assumedHttpMethod = "get", exports.__file = "GetCarWithLiteralSchema2.ts", exports.__query = [], exports.__params = [];
 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": {} } };
+exports.__assumedHttpMethod = "get", exports.__file = "GetCarWithLiteralSchema2.ts", exports.__query = [], exports.__params = [];
+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

@@ -56,3 +56,5 @@ var GetCarWithSchemaInFile = function (_a) { return __awaiter(void 0, [_a], void
 exports.default = GetCarWithSchemaInFile;
 exports.__assumedHttpMethod = "get", exports.__file = "GetCarWithSchemaInFile.ts", exports.__query = [], exports.__params = [];
 exports.__schemas = { reqSchema: undefined, resSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "model": { "type": "string" } }, "required": ["model"], "additionalProperties": false, "definitions": {} } };
+exports.__assumedHttpMethod = "get", exports.__file = "GetCarWithSchemaInFile.ts", exports.__query = [], exports.__params = [];
+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

@@ -56,3 +56,5 @@ var GetCarWithSchemaInFile2 = function (_a) { return __awaiter(void 0, [_a], voi
 exports.default = GetCarWithSchemaInFile2;
 exports.__assumedHttpMethod = "get", exports.__file = "GetCarWithSchemaInFile2.ts", exports.__query = [], exports.__params = [];
 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": {} } };
+exports.__assumedHttpMethod = "get", exports.__file = "GetCarWithSchemaInFile2.ts", exports.__query = [], exports.__params = [];
+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

@@ -52,3 +52,5 @@ var manuallyAddedHandler = function (_a) { return __awaiter(void 0, [_a], void 0
 exports.default = manuallyAddedHandler;
 exports.__assumedHttpMethod = "", exports.__file = "ManuallyAddedHandler.ts", exports.__query = [], exports.__params = [];
 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 };
+exports.__assumedHttpMethod = "", exports.__file = "ManuallyAddedHandler.ts", exports.__query = [], exports.__params = [];
+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

@@ -54,3 +54,5 @@ var manuallyAddedHandler = function (_a) { return __awaiter(void 0, [_a], void 0
 exports.default = manuallyAddedHandler;
 exports.__assumedHttpMethod = "", exports.__file = "ManuallyAddedHandler2.ts", exports.__query = [], exports.__params = [];
 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 };
+exports.__assumedHttpMethod = "", exports.__file = "ManuallyAddedHandler2.ts", exports.__query = [], exports.__params = [];
+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

@@ -53,3 +53,5 @@ var PostCar = function (_a) { return __awaiter(void 0, [_a], void 0, function (_
 exports.default = PostCar;
 exports.__assumedHttpMethod = "post", exports.__file = "PostCar.ts", exports.__query = [], exports.__params = [];
 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": {} } };
+exports.__assumedHttpMethod = "post", exports.__file = "PostCar.ts", exports.__query = [], exports.__params = [];
+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/PostLogin.js

@@ -54,3 +54,5 @@ var PostLogin = function (_a) { return __awaiter(void 0, [_a], void 0, function
 exports.default = PostLogin;
 exports.__assumedHttpMethod = "post", exports.__file = "PostLogin.ts", exports.__query = [], exports.__params = [];
 exports.__schemas = { reqSchema: undefined, resSchema: undefined };
+exports.__assumedHttpMethod = "post", exports.__file = "PostLogin.ts", exports.__query = [], exports.__params = [];
+exports.__schemas = { reqSchema: undefined, resSchema: undefined };

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

@@ -0,0 +1,57 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    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 {
+            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]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.__schemas = exports.__params = exports.__query = exports.__file = exports.__assumedHttpMethod = exports.Route = void 0;
+exports.Route = {
+    path: "/logout",
+};
+var PostLogout = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
+    var ctx = _b.ctx, req = _b.req;
+    return __generator(this, function (_c) {
+        return [2 /*return*/, {
+                data: {
+                    success: true,
+                },
+            }];
+    });
+}); };
+exports.default = PostLogout;
+exports.__assumedHttpMethod = "post", exports.__file = "PostLogout.ts", exports.__query = [], exports.__params = [];
+exports.__schemas = { reqSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "definitions": {} }, resSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "success": { "type": "boolean" } }, "required": ["success"], "additionalProperties": false, "definitions": {} } };
+exports.__assumedHttpMethod = "post", exports.__file = "PostLogout.ts", exports.__query = [], exports.__params = [];
+exports.__schemas = { reqSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "definitions": {} }, resSchema: { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "success": { "type": "boolean" } }, "required": ["success"], "additionalProperties": false, "definitions": {} } };

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

@@ -53,3 +53,5 @@ var PutCar = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b
 exports.default = PutCar;
 exports.__assumedHttpMethod = "put", exports.__file = "PutCar.ts", exports.__query = [], exports.__params = [];
 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 };
+exports.__assumedHttpMethod = "put", exports.__file = "PutCar.ts", exports.__query = [], exports.__params = [];
+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/src/handlers/PostLogout.ts

@@ -0,0 +1,19 @@
+import { Handler, RouteProps } from "@flink-app/flink";
+
+interface LogoutResponse {
+  success: boolean;
+}
+
+export const Route: RouteProps = {
+  path: "/logout",
+};
+
+const PostLogout: Handler<any, {}, LogoutResponse> = async ({ ctx, req }) => {
+  return {
+    data: {
+      success: true,
+    },
+  };
+};
+
+export default PostLogout;

package/src/FlinkApp.ts

@@ -12,7 +12,7 @@ import { v4 } from "uuid";
 import { FlinkAuthPlugin } from "./auth/FlinkAuthPlugin";
 import { FlinkContext } from "./FlinkContext";
 import { internalServerError, notFound, unauthorized } from "./FlinkErrors";
-import { Handler, HandlerFile, HttpMethod, QueryParamMetadata, RouteProps } from "./FlinkHttpHandler";
+import { FlinkRequest, Handler, HandlerFile, HttpMethod, QueryParamMetadata, RouteProps } from "./FlinkHttpHandler";
 import { FlinkJobFile } from "./FlinkJob";
 import { log } from "./FlinkLog";
 import { FlinkPlugin } from "./FlinkPlugin";
@@ -217,6 +217,7 @@ export class FlinkApp<C extends FlinkContext> {
     public name: string;
     public expressApp?: Express;
     public db?: Db;
+    public dbClient?: MongoClient;
     public handlers: HandlerConfig[] = [];
     public port?: number;
     public started = false;
@@ -234,6 +235,7 @@ export class FlinkApp<C extends FlinkContext> {
     private rawContentTypes?: string[];
     private schedulingOptions?: FlinkOptions["scheduling"];
     private disableHttpServer = false;
+    private expressServer: any; // for simplicity, we don't want to import types from express/node here
 
     private repos: { [x: string]: FlinkRepo<C, any> } = {};
 
@@ -367,7 +369,7 @@ export class FlinkApp<C extends FlinkContext> {
             log.info("🚧 HTTP server is disabled, but flink app is running");
             this.started = true;
         } else {
-            this.expressApp?.listen(this.port, () => {
+            this.expressServer = this.expressApp?.listen(this.port, () => {
                 log.fontColorLog("magenta", `⚡️ HTTP server '${this.name}' is running and waiting for connections on ${this.port}`);
                 this.started = true;
             });
@@ -376,6 +378,28 @@ export class FlinkApp<C extends FlinkContext> {
         return this;
     }
 
+    async stop() {
+        log.info("🛑 Stopping Flink app...");
+
+        if (this.scheduler) {
+            await this.scheduler.stop();
+        }
+
+        if (this.expressServer) {
+            return new Promise<void>((resolve, reject) => {
+                const int = setTimeout(() => {
+                    reject("Failed to stop HTTP server in time");
+                }, 2000);
+
+                this.expressServer.close(() => {
+                    clearInterval(int);
+                    log.info("HTTP server stopped");
+                    resolve();
+                });
+            });
+        }
+    }
+
     /**
      * Manually registers a handler.
      *
@@ -506,7 +530,7 @@ export class FlinkApp<C extends FlinkContext> {
                 try {
                     // 👇 This is where the actual handler gets invoked
                     handlerRes = await handler({
-                        req,
+                        req: req as FlinkRequest,
                         ctx: this.ctx,
                         origin: routeProps.origin,
                     });
@@ -570,7 +594,7 @@ export class FlinkApp<C extends FlinkContext> {
      * Will not register any handlers added programmatically.
      */
     private async registerAutoRegisterableHandlers() {
-        for (const { handler, assumedHttpMethod } of autoRegisteredHandlers) {
+        for (const { handler, assumedHttpMethod } of autoRegisteredHandlers.sort((a, b) => (a.handler.Route?.order || 0) - (b.handler.Route?.order || 0))) {
             if (!handler.Route) {
                 log.error(`Missing Props in handler ${handler.__file}`);
                 continue;
@@ -717,7 +741,7 @@ export class FlinkApp<C extends FlinkContext> {
     private async buildContext() {
         if (this.dbOpts) {
             for (const { collectionName, repoInstanceName, Repo } of autoRegisteredRepos) {
-                const repoInstance: FlinkRepo<C, any> = new Repo(collectionName, this.db);
+                const repoInstance: FlinkRepo<C, any> = new Repo(collectionName, this.db, this.dbClient);
 
                 this.repos[repoInstanceName] = repoInstance;
 
@@ -753,8 +777,10 @@ export class FlinkApp<C extends FlinkContext> {
         if (this.dbOpts) {
             try {
                 log.debug("Connecting to db");
+
                 const client = await MongoClient.connect(this.dbOpts.uri, this.getMongoConnectionOptions());
                 this.db = client.db();
+                this.dbClient = client;
             } catch (err) {
                 log.error("Failed to connect to db: " + err);
                 process.exit(1);
@@ -797,7 +823,7 @@ export class FlinkApp<C extends FlinkContext> {
         if (!this.auth) {
             throw new Error(`Attempting to authenticate request (${req.method} ${req.path}) but no authPlugin is set`);
         }
-        return await this.auth.authenticateRequest(req, permissions);
+        return await this.auth.authenticateRequest(req as FlinkRequest, permissions);
     }
 
     public getRegisteredRoutes() {
@@ -813,6 +839,18 @@ export class FlinkApp<C extends FlinkContext> {
             throw new Error("No db configured");
         }
 
+        const { version: driverVersion } = require("mongodb/package.json");
+
+        if (driverVersion.startsWith("3")) {
+            log.debug(`Using legacy mongodb connection options as mongo client is version ${driverVersion}`);
+            return {
+                useNewUrlParser: true,
+                useUnifiedTopology: true,
+            };
+        }
+
+        log.debug(`Using modern MongoDB client options (driver version ${driverVersion})`);
+
         return {
             serverApi: {
                 version: ServerApiVersion.v1,

package/src/FlinkHttpHandler.ts

@@ -5,24 +5,25 @@ import { FlinkError } from "./FlinkErrors";
 import { FlinkResponse } from "./FlinkResponse";
 
 export enum HttpMethod {
-  get = "get",
-  post = "post",
-  put = "put",
-  delete = "delete",
+    get = "get",
+    post = "post",
+    put = "put",
+    delete = "delete",
 }
 
 type Params = Request["params"];
-type Query = Request["query"];
+
+/**
+ * Query type for request query parameters.
+ * Does currently not allow nested objects, although
+ * underlying express Request does allow it.
+ */
+type Query = Record<string, string | string[] | undefined>;
 
 /**
  * Flink request extends express Request but adds reqId and user object.
  */
-export type FlinkRequest<T = any, P = Params, Q = Query> = Request<
-  P,
-  any,
-  T,
-  Q
-> & { reqId: string; user?: any };
+export type FlinkRequest<T = any, P = Params, Q = Query> = Request<P, any, T, Q> & { reqId: string; user?: any };
 
 /**
  * Route props to control routing.
@@ -31,66 +32,69 @@ export type FlinkRequest<T = any, P = Params, Q = Query> = Request<
  * instructs express web server how to route traffic.
  */
 export interface RouteProps {
-  /**
-   * HTTP method which this handlers responds to.
-   *
-   * Will if not set attempt to extract HTTP method based
-   * on handler file name prefix, for example `GetFoo.ts` will assume
-   * HTTP method `GET`.
-   */
-  method?: HttpMethod;
-
-  /**
-   * Route path including any path params.
-   * Example: `/user/:id`
-   */
-  path: string;
-
-  /**
-   * Generates mock response based on handlers response schema.
-   *
-   * Will be ignored if handler does not have any response schema defined.
-   *
-   * This should only be used during development 💥
-   */
-  mockApi?: boolean;
-
-  /**
-   * Set permissions needed to access route if route requires authentication.
-   */
-  permissions?: string | string[];
-
-  /**
-   * Optional documentation of endpoint. Can be used for example in API docs.
-   * Supports markdown strings.
-   */
-  docs?: string; // TODO
-
-  /**
-   * If handler should not be auto registered
-   */
-  skipAutoRegister?: boolean;
-
-  /**
-   * I.e. filename or plugin name that describes where handler origins from
-   */
-  origin?: string;
+    /**
+     * HTTP method which this handlers responds to.
+     *
+     * Will if not set attempt to extract HTTP method based
+     * on handler file name prefix, for example `GetFoo.ts` will assume
+     * HTTP method `GET`.
+     */
+    method?: HttpMethod;
+
+    /**
+     * Route path including any path params.
+     * Example: `/user/:id`
+     */
+    path: string;
+
+    /**
+     * Generates mock response based on handlers response schema.
+     *
+     * Will be ignored if handler does not have any response schema defined.
+     *
+     * This should only be used during development 💥
+     */
+    mockApi?: boolean;
+
+    /**
+     * Set permissions needed to access route if route requires authentication.
+     */
+    permissions?: string | string[];
+
+    /**
+     * Optional documentation of endpoint. Can be used for example in API docs.
+     * Supports markdown strings.
+     */
+    docs?: string; // TODO
+
+    /**
+     * If handler should not be auto registered
+     */
+    skipAutoRegister?: boolean;
+
+    /**
+     * I.e. filename or plugin name that describes where handler origins from
+     */
+    origin?: string;
+
+    /**
+     * Order handler should be registered in.
+     *
+     * By default all handlers has order 0 and in most cases this is fine,
+     * but if for example you want to register a handler before all others
+     * to avoid conflicts you can set a negative order.
+     */
+    order?: number;
 }
 
 /**
  * Http handler function that handlers implements in order to
  * handle HTTP requests and return a JSON response.
  */
-export type Handler<
-  Ctx extends FlinkContext,
-  ReqSchema = any,
-  ResSchema = any,
-  P extends Params = Params,
-  Q extends Query = Query
-> = (props: {
-  req: FlinkRequest<ReqSchema, P, Q>;
-  ctx: Ctx;
-  origin?: string;
+export type Handler<Ctx extends FlinkContext, ReqSchema = any, ResSchema = any, P extends Params = Params, Q extends Query = Query> = (props: {
+    req: FlinkRequest<ReqSchema, P, Q>;
+    ctx: Ctx;
+    origin?: string;
 }) => Promise<FlinkResponse<ResSchema | FlinkError>>;
 
 /**
@@ -99,12 +103,7 @@ export type Handler<
  *
  * Just syntactic sugar on top op `HandlerFn`
  */
-export type GetHandler<
-  Ctx extends FlinkContext,
-  ResSchema = any,
-  P extends Params = Params,
-  Q extends Query = Query
-> = Handler<Ctx, any, ResSchema, P, Q>;
+export type GetHandler<Ctx extends FlinkContext, ResSchema = any, P extends Params = Params, Q extends Query = Query> = Handler<Ctx, any, ResSchema, P, Q>;
 
 /**
  * Type for Handler file. Describes shape of exports when using
@@ -113,32 +112,32 @@ export type GetHandler<
  * `import * as FooHandler from "./src/handlers/FooHandler"
  */
 export type HandlerFile = {
-  default: Handler<any, any, any, any, any>;
-  Route?: RouteProps;
-  /**
-   * Name of schemas, is set at compile time by Flink compiler.
-   */
-  __schemas?: {
-    reqSchema?: JSONSchema;
-    resSchema?: JSONSchema;
-  };
-  /**
-   * Typescript source file name, is set at compile time by Flink compiler.
-   */
-  __file?: string;
-
-  /**
-   * Description of query params, is set at compile time by Flink compiler.
-   */
-  __query?: QueryParamMetadata[];
-
-  /**
-   * Description of path params, is set at compile time by Flink compiler.
-   */
-  __params?: QueryParamMetadata[];
+    default: Handler<any, any, any, any, any>;
+    Route?: RouteProps;
+    /**
+     * Name of schemas, is set at compile time by Flink compiler.
+     */
+    __schemas?: {
+        reqSchema?: JSONSchema;
+        resSchema?: JSONSchema;
+    };
+    /**
+     * Typescript source file name, is set at compile time by Flink compiler.
+     */
+    __file?: string;
+
+    /**
+     * Description of query params, is set at compile time by Flink compiler.
+     */
+    __query?: QueryParamMetadata[];
+
+    /**
+     * Description of path params, is set at compile time by Flink compiler.
+     */
+    __params?: QueryParamMetadata[];
 };
 
 export type QueryParamMetadata = {
-  name: string;
-  description: string;
+    name: string;
+    description: string;
 };

package/src/FlinkRepo.ts

@@ -1,6 +1,12 @@
-import { Collection, Db, Document, InsertOneResult, ObjectId } from "mongodb";
+import { Collection, Db, Document, InsertOneResult, MongoClient, ObjectId } from "mongodb";
 import { FlinkContext } from "./FlinkContext";
 
+/**
+ * Partial model to have intellisense for partial updates but
+ * also allow any other properties to be set such as nested objects etc.
+ */
+type PartialModel<Model> = Partial<Model> & { [x: string]: any };
+
 export abstract class FlinkRepo<C extends FlinkContext, Model extends Document> {
     collection: Collection;
 
@@ -15,7 +21,7 @@ export abstract class FlinkRepo<C extends FlinkContext, Model extends Document>
         return this._ctx;
     }
 
-    constructor(private collectionName: string, private db: Db) {
+    constructor(public collectionName: string, public db: Db, public client?: MongoClient) {
         this.collection = db.collection(this.collectionName);
     }
 
@@ -45,10 +51,12 @@ export abstract class FlinkRepo<C extends FlinkContext, Model extends Document>
         return { ...model, _id: result.insertedId.toString() };
     }
 
-    async updateOne(id: string | ObjectId, model: Partial<Model>): Promise<Model | null> {
+    async updateOne(id: string | ObjectId, model: PartialModel<Model>): Promise<Model | null> {
         const oid = this.buildId(id);
 
-        await this.collection.updateOne({ _id: oid }, { $set: model });
+        const { _id, ...modelWithoutId } = model;
+
+        await this.collection.updateOne({ _id: oid }, { $set: modelWithoutId });
 
         const res = await this.collection.findOne<Model>({ _id: oid });
 
@@ -58,9 +66,11 @@ export abstract class FlinkRepo<C extends FlinkContext, Model extends Document>
         return null;
     }
 
-    async updateMany<U = Partial<Model>>(query: any, model: U): Promise<number> {
+    async updateMany<U = PartialModel<Model>>(query: any, model: U): Promise<number> {
+        const { _id, ...modelWithoutId } = model as any;
+
         const { modifiedCount } = await this.collection.updateMany(query, {
-            $set: model as any,
+            $set: modelWithoutId as any,
         });
         return modifiedCount;
     }
@@ -72,7 +82,14 @@ export abstract class FlinkRepo<C extends FlinkContext, Model extends Document>
         return deletedCount || 0;
     }
 
-    private buildId(id: string | ObjectId) {
+    /**
+     * Helper to ensure the id is always an ObjectId.
+     * If a string is passed, it will be converted to an ObjectId.
+     * If an ObjectId is passed, it will be returned as is.
+     * @param id
+     * @returns
+     */
+    buildId(id: string | ObjectId) {
         let oid: ObjectId | string;
 
         if (typeof id === "string") {