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

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.4",
+    "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": "8f06a4ab98e7179322d36546756d4305fd196f5a"
+    "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/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,
         });