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

package/dist/src/FlinkApp.d.ts

@@ -171,6 +171,7 @@ export declare class FlinkApp<C extends FlinkContext> {
     private rawContentTypes?;
     private schedulingOptions?;
     private disableHttpServer;
+    private expressServer;
     private repos;
     /**
      * Internal cache used to track registered handlers and potentially any overlapping routes
@@ -181,6 +182,7 @@ export declare class FlinkApp<C extends FlinkContext> {
     constructor(opts: FlinkOptions);
     get ctx(): C;
     start(): Promise<this>;
+    stop(): Promise<void>;
     /**
      * Manually registers a handler.
      *

package/dist/src/FlinkApp.js

@@ -231,7 +231,7 @@ var FlinkApp = /** @class */ (function () {
                             this.started = true;
                         }
                         else {
-                            (_d = this.expressApp) === null || _d === void 0 ? void 0 : _d.listen(this.port, function () {
+                            this.expressServer = (_d = this.expressApp) === null || _d === void 0 ? void 0 : _d.listen(this.port, function () {
                                 FlinkLog_1.log.fontColorLog("magenta", "\u26A1\uFE0F HTTP server '".concat(_this.name, "' is running and waiting for connections on ").concat(_this.port));
                                 _this.started = true;
                             });
@@ -241,6 +241,36 @@ var FlinkApp = /** @class */ (function () {
             });
         });
     };
+    FlinkApp.prototype.stop = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        FlinkLog_1.log.info("🛑 Stopping Flink app...");
+                        if (!this.scheduler) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.scheduler.stop()];
+                    case 1:
+                        _a.sent();
+                        _a.label = 2;
+                    case 2:
+                        if (this.expressServer) {
+                            return [2 /*return*/, new Promise(function (resolve, reject) {
+                                    var int = setTimeout(function () {
+                                        reject("Failed to stop HTTP server in time");
+                                    }, 2000);
+                                    _this.expressServer.close(function () {
+                                        clearInterval(int);
+                                        FlinkLog_1.log.info("HTTP server stopped");
+                                        resolve();
+                                    });
+                                })];
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     /**
      * Manually registers a handler.
      *

package/dist/src/FlinkRepo.d.ts

@@ -1,5 +1,12 @@
 import { Collection, Db, Document, 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 declare abstract class FlinkRepo<C extends FlinkContext, Model extends Document> {
     private collectionName;
     private db;
@@ -14,9 +21,10 @@ export declare abstract class FlinkRepo<C extends FlinkContext, Model extends Do
     create<C = Omit<Model, "_id">>(model: C): Promise<C & {
         _id: string;
     }>;
-    updateOne(id: string | ObjectId, model: Partial<Model>): Promise<Model | null>;
-    updateMany<U = Partial<Model>>(query: any, model: U): Promise<number>;
+    updateOne(id: string | ObjectId, model: PartialModel<Model>): Promise<Model | null>;
+    updateMany<U = PartialModel<Model>>(query: any, model: U): Promise<number>;
     deleteById(id: string | ObjectId): Promise<number>;
     private buildId;
     private objectIdToString;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@flink-app/flink",
-    "version": "0.12.1-alpha.3",
+    "version": "0.12.1-alpha.5",
     "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",
@@ -66,5 +66,5 @@
         "rimraf": "^3.0.2",
         "ts-node": "^9.1.1"
     },
-    "gitHead": "51b6524e233acb2430953ffaed6382909f34db8e"
+    "gitHead": "1ff7b8cf9b30287d3be72af96c5767e90a562fbf"
 }

package/spec/FlinkRepo.spec.ts

@@ -4,6 +4,7 @@ import { FlinkRepo } from "../src/FlinkRepo";
 interface Model {
     _id: string;
     name: string;
+    nested?: { field: number };
 }
 
 class Repo extends FlinkRepo<any, Model> {}
@@ -61,9 +62,19 @@ describe("FlinkRepo", () => {
 
         const updatedDoc = await repo.updateOne(createdDoc._id + "", {
             name: "foo",
+            "nested.field": 1,
         });
 
         expect(updatedDoc).toBeDefined();
         expect(updatedDoc?.name).toBe("foo");
+        expect(updatedDoc?.nested?.field).toBe(1);
+    });
+
+    it("should update many documents", async () => {
+        await collection.insertMany([{ name: "foo" }, { name: "foo" }, { name: "foo" }]);
+
+        const updatedCount = await repo.updateMany({ name: "foo" }, { name: "bar", "nested.field": 1 });
+
+        expect(updatedCount).toBe(3);
     });
 });

package/src/FlinkApp.ts

@@ -234,6 +234,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 +368,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 +377,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.
      *

package/src/FlinkRepo.ts

@@ -1,6 +1,12 @@
 import { Collection, Db, Document, InsertOneResult, 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;
 
@@ -45,7 +51,7 @@ 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 });
@@ -58,7 +64,7 @@ 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 { modifiedCount } = await this.collection.updateMany(query, {
             $set: model as any,
         });