@flink-app/flink 0.12.1-alpha.4 → 0.12.1-alpha.6

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/dist/src/FlinkRepo.js

@@ -46,6 +46,17 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FlinkRepo = void 0;
 var mongodb_1 = require("mongodb");
@@ -129,12 +140,13 @@ var FlinkRepo = /** @class */ (function () {
     };
     FlinkRepo.prototype.updateOne = function (id, model) {
         return __awaiter(this, void 0, void 0, function () {
-            var oid, res;
+            var oid, _id, modelWithoutId, res;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         oid = this.buildId(id);
-                        return [4 /*yield*/, this.collection.updateOne({ _id: oid }, { $set: model })];
+                        _id = model._id, modelWithoutId = __rest(model, ["_id"]);
+                        return [4 /*yield*/, this.collection.updateOne({ _id: oid }, { $set: modelWithoutId })];
                     case 1:
                         _a.sent();
                         return [4 /*yield*/, this.collection.findOne({ _id: oid })];
@@ -150,14 +162,16 @@ var FlinkRepo = /** @class */ (function () {
     };
     FlinkRepo.prototype.updateMany = function (query, model) {
         return __awaiter(this, void 0, void 0, function () {
-            var modifiedCount;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.collection.updateMany(query, {
-                            $set: model,
-                        })];
+            var _a, _id, modelWithoutId, modifiedCount;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _a = model, _id = _a._id, modelWithoutId = __rest(_a, ["_id"]);
+                        return [4 /*yield*/, this.collection.updateMany(query, {
+                                $set: modelWithoutId,
+                            })];
                     case 1:
-                        modifiedCount = (_a.sent()).modifiedCount;
+                        modifiedCount = (_b.sent()).modifiedCount;
                         return [2 /*return*/, modifiedCount];
                 }
             });

package/package.json

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

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/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,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;
     }