4.0.18

.gitlab-ci.yml

@@ -12,6 +12,10 @@ stages:
   - release
   - metadata
 
+before_script:
+  - apt-get update && apt-get install -y libcurl3 libssl-dev openssl libssl1.0.0 mongodb
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
@@ -36,6 +40,7 @@ auditProductionDependencies:
     - npmci command npm audit --audit-level=high --only=prod --production
   tags:
     - docker
+  allow_failure: true
 
 auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@pushrocks/smartdata",
-  "version": "4.0.14",
+  "version": "4.0.18",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@pushrocks/smartdata",
-      "version": "4.0.14",
+      "version": "4.0.18",
       "license": "MIT",
       "dependencies": {
         "@pushrocks/lik": "^4.0.20",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartdata",
-  "version": "4.0.14",
+  "version": "4.0.18",
   "private": false,
   "description": "do more with data",
   "main": "dist_ts/index.js",

readme.md

@@ -90,7 +90,7 @@ class MyObject extends smartdata.DbDoc<MyObject /* ,[an optional interface to im
 const localObject = new MyObject({
   property1: 'hi',
   property2: {
-    deep: 3
+    deep: 3,
   },
 });
 await localObject.save(); // saves the object to the database
@@ -102,9 +102,9 @@ const myInstance = await MyObject.getInstance({
   property1: 'hi',
   property2: {
     deep: {
-      $gt: 2
-    } as any
-  }
+      $gt: 2,
+    } as any,
+  },
 }); // outputs a new instance of MyObject with the values from db assigned
 ```
 

test/test.easystore.ts

@@ -19,7 +19,6 @@ let testDb: smartdata.SmartdataDb;
 let smartdataOptions: smartdata.IMongoDescriptor;
 let mongod: mongoPlugin.MongoMemoryServer;
 
-
 tap.test('should create a testinstance as database', async () => {
   mongod = new mongoPlugin.MongoMemoryServer({});
   console.log('created mongod instance');
@@ -47,14 +46,14 @@ tap.test('should create an easystore', async () => {
   await easyStore.writeKey('key1', 'hello');
   const retrievedKey = await easyStore.readKey('key1');
   expect(retrievedKey).to.equal('hello');
-})
+});
 
 tap.test('close', async () => {
   testDb.close();
   mongod.stop();
   setTimeout(() => {
     process.exit(0);
-  }, 1000)
-})
+  }, 1000);
+});
 
 tap.start();

test/test.ts

@@ -134,7 +134,7 @@ tap.test('expect to get instance of Car with deep match', async () => {
     const timeStart = Date.now();
     const myCars2 = await Car.getInstances({
       deepData: {
-        sodeep: 'yes'
+        sodeep: 'yes',
       },
     });
     if (counter % 10 === 0) {
@@ -200,14 +200,19 @@ class Truck extends smartdata.SmartDataDbDoc<Car, Car> {
 tap.test('should store a new Truck', async () => {
   const truck = new Truck('blue', 'MAN');
   await truck.save();
-  const myTruck = await Truck.getInstance({ color: 'blue' });
-  myTruck.id = 'foo';
-  await myTruck.save();
   const myTruck2 = await Truck.getInstance({ color: 'blue' });
-  console.log(myTruck2);
+  myTruck2.color = 'red';
+  await myTruck2.save();
+  const myTruck3 = await Truck.getInstance({ color: 'blue' });
+  console.log(myTruck3);
 });
 
-tap.test('should ', async () => {})
+tap.test('should use a cursor', async () => {
+  const cursor = await Truck.getCursor({});
+  cursor.forEach(async truckArg => {
+    console.log(truckArg.id);
+  });
+});
 
 // =======================================
 // close the database connection

test/test.typescript.ts

@@ -92,9 +92,9 @@ tap.test('should produce a car', async () => {
 
 tap.test('should get a car', async () => {
   const car = Car.getInstance({
-    color: 'red'
-  })
-})
+    color: 'red',
+  });
+});
 
 // =======================================
 // close the database connection

ts/smartdata.classes.collection.ts

@@ -1,5 +1,6 @@
 import * as plugins from './smartdata.plugins';
 import { SmartdataDb } from './smartdata.classes.db';
+import { SmartdataDbCursor } from './smartdata.classes.cursor';
 import { SmartDataDbDoc } from './smartdata.classes.doc';
 import { CollectionFactory } from './smartdata.classes.collectionfactory';
 
@@ -42,13 +43,13 @@ export function Collection(dbArg: SmartdataDb | TDelayed<SmartdataDb>) {
 }
 
 export interface IManager {
-  db: SmartdataDb
+  db: SmartdataDb;
 }
 
 export const setDefaultManagerForDoc = <T>(managerArg: IManager, dbDocArg: T): T => {
   (dbDocArg as any).prototype.defaultManager = managerArg;
   return dbDocArg;
-}
+};
 
 /**
  * This is a decorator that will tell the decorated class what dbTable to use
@@ -62,7 +63,7 @@ export const setDefaultManagerForDoc = <T>(managerArg: IManager,  dbDocArg: T):
         if (!managerArg) {
           dbArg = this.prototype.defaultManager.db;
         } else if (managerArg['db']) {
-          dbArg = (managerArg as TManager).db
+          dbArg = (managerArg as TManager).db;
         } else {
           dbArg = (managerArg as TDelayed<TManager>)().db;
         }
@@ -75,7 +76,7 @@ export const setDefaultManagerForDoc = <T>(managerArg: IManager,  dbDocArg: T):
           //process.exit(0)
           dbArg = this.defaultManager.db;
         } else if (managerArg['db']) {
-          dbArg = (managerArg as TManager).db
+          dbArg = (managerArg as TManager).db;
         } else {
           dbArg = (managerArg as TDelayed<TManager>)().db;
         }
@@ -83,8 +84,10 @@ export const setDefaultManagerForDoc = <T>(managerArg: IManager,  dbDocArg: T):
       }
       public static get manager() {
         let manager: TManager;
-        if (managerArg['db']) {
-          manager = (managerArg as TManager);
+        if (!managerArg) {
+          manager = this.prototype.defaultManager
+        } else if (managerArg['db']) {
+          manager = managerArg as TManager;
         } else {
           manager = (managerArg as TDelayed<TManager>)();
         }
@@ -92,8 +95,10 @@ export const setDefaultManagerForDoc = <T>(managerArg: IManager,  dbDocArg: T):
       }
       public get manager() {
         let manager: TManager;
-        if (managerArg['db']) {
-          manager = (managerArg as TManager);
+        if (!managerArg) {
+          manager = this.defaultManager
+        } else if (managerArg['db']) {
+          manager = managerArg as TManager;
         } else {
           manager = (managerArg as TDelayed<TManager>)();
         }
@@ -166,9 +171,28 @@ export class SmartdataCollection<T> {
   /**
    * finds an object in the DbCollection
    */
-  public async find(filterObject: any): Promise<any> {
+   public async findOne(filterObject: any): Promise<any> {
     await this.init();
-    const result = await this.mongoDbCollection.find(filterObject).toArray();
+    const cursor = this.mongoDbCollection.find(filterObject);
+    const result = await cursor.next();
+    cursor.close();
+    return result;
+  }
+
+  public async getCursor(filterObject: any): Promise<SmartdataDbCursor<any>> {
+    await this.init();
+    const cursor = this.mongoDbCollection.find(filterObject);
+    return new SmartdataDbCursor(cursor);
+  }
+
+  /**
+   * finds an object in the DbCollection
+   */
+  public async findAll(filterObject: any): Promise<any[]> {
+    await this.init();
+    const cursor = this.mongoDbCollection.find(filterObject);
+    const result = await cursor.toArray();
+    cursor.close();
     return result;
   }
 

ts/smartdata.classes.collectionfactory.ts

@@ -5,10 +5,7 @@ import { SmartdataDb } from './smartdata.classes.db';
 export class CollectionFactory {
   public collections: { [key: string]: SmartdataCollection<any> } = {};
 
-  public getCollection = (
-    nameArg: string,
-    dbArg: SmartdataDb
-  ): SmartdataCollection<any> => {
+  public getCollection = (nameArg: string, dbArg: SmartdataDb): SmartdataCollection<any> => {
     if (!this.collections[nameArg]) {
       this.collections[nameArg] = (() => {
         if (dbArg instanceof SmartdataDb) {

ts/smartdata.classes.cursor.ts

@@ -0,0 +1,39 @@
+import * as plugins from './smartdata.plugins';
+
+/**
+ * a wrapper for the native mongodb cursor. Exposes better 
+ */
+export class SmartdataDbCursor<T = any> {
+  // STATIC
+
+  // INSTANCE
+  public mongodbCursor: plugins.mongodb.Cursor<T>;
+  constructor(cursorArg: plugins.mongodb.Cursor<T>) {
+    this.mongodbCursor = cursorArg
+  };
+
+  public async next(closeAtEnd = true) {
+    const result = await this.mongodbCursor.next();
+    if (!result && closeAtEnd) {
+      await this.close();
+    };
+    return result;
+  };
+
+  public async forEach(forEachFuncArg: (itemArg: T) => Promise<any>, closeCursorAtEnd = true) {
+    let currentValue: T;
+    do {
+      currentValue = await this.mongodbCursor.next();
+      if (currentValue) {
+        await forEachFuncArg(currentValue);
+      }
+    } while (currentValue);
+    if (closeCursorAtEnd) {
+      await this.close();
+    }
+  }
+
+  public async close() {
+    await this.mongodbCursor.close();
+  }
+}

ts/smartdata.classes.doc.ts

@@ -3,6 +3,7 @@ import * as plugins from './smartdata.plugins';
 import { ObjectMap } from '@pushrocks/lik';
 
 import { SmartdataDb } from './smartdata.classes.db';
+import { SmartdataDbCursor } from './smartdata.classes.cursor';
 import { IManager, SmartdataCollection } from './smartdata.classes.collection';
 
 export type TDocCreation = 'db' | 'new' | 'mixed';
@@ -41,6 +42,31 @@ export function unI() {
   };
 }
 
+export const convertFilterForMongoDb = (filterArg: { [key: string]: any }) => {
+  const convertedFilter: { [key: string]: any } = {};
+  const convertFilterArgument = (keyPathArg2: string, filterArg2: any) => {
+    if (typeof filterArg2 === 'object') {
+      for (const key of Object.keys(filterArg2)) {
+        if (key.startsWith('$')) {
+          convertedFilter[keyPathArg2] = filterArg2;
+          return;
+        } else if (key.includes('.')) {
+          throw new Error('keys cannot contain dots');
+        }
+      }
+      for (const key of Object.keys(filterArg2)) {
+        convertFilterArgument(`${keyPathArg2}.${key}`, filterArg2[key]);
+      }
+    } else {
+      convertedFilter[keyPathArg2] = filterArg2;
+    }
+  };
+  for (const key of Object.keys(filterArg)) {
+    convertFilterArgument(key, filterArg[key]);
+  }
+  return convertedFilter;
+};
+
 export class SmartDataDbDoc<T extends TImplements, TImplements, TManager extends IManager = any> {
   /**
    * the collection object an Doc belongs to
@@ -81,54 +107,81 @@ export class SmartDataDbDoc<T extends TImplements, TImplements, TManager extends
    */
   constructor() {}
 
+  public static createInstanceFromMongoDbNativeDoc<T>(
+    this: plugins.tsclass.typeFest.Class<T>,
+    mongoDbNativeDocArg: any
+  ): T {
+    const newInstance = new this();
+    (newInstance as any).creationStatus = 'db';
+    for (const key of Object.keys(mongoDbNativeDocArg)) {
+      newInstance[key] = mongoDbNativeDocArg[key];
+    }
+    return newInstance;
+  }
+
+  /**
+   * gets all instances as array
+   * @param this
+   * @param filterArg
+   * @returns
+   */
   public static async getInstances<T>(
     this: plugins.tsclass.typeFest.Class<T>,
     filterArg: plugins.tsclass.typeFest.PartialDeep<T>
   ): Promise<T[]> {
-    const convertedFilter: any = {};
-    const convertFilterArgument = (keyPathArg: string, filterArg2: any) => {
-      if (typeof filterArg2 === 'object') {
-        for (const key of Object.keys(filterArg2)) {
-          if (key.startsWith('$')) {
-            convertedFilter[keyPathArg] = filterArg2;
-            return;
-          } else if (key.includes('.')) {
-            throw new Error('keys cannot contain dots');
-          }
-        }
-        for (const key of Object.keys(filterArg2)) {
-          convertFilterArgument(`${keyPathArg}.${key}`, filterArg2[key]);
-        } 
-      } else {
-        convertedFilter[keyPathArg] = filterArg2
-      }
-    }
-    for (const key of Object.keys(filterArg)) {
-      convertFilterArgument(key, filterArg[key]);
-    }
-    const foundDocs = await (this as any).collection.find(convertedFilter);
+    const foundDocs = await (this as any).collection.findAll(convertFilterForMongoDb(filterArg));
     const returnArray = [];
-    for (const item of foundDocs) {
-      const newInstance = new this();
-      (newInstance as any).creationStatus = 'db';
-      for (const key of Object.keys(item)) {
-        newInstance[key] = item[key];
-      }
+    for (const foundDoc of foundDocs) {
+      const newInstance: T = (this as any).createInstanceFromMongoDbNativeDoc(foundDoc);
       returnArray.push(newInstance);
     }
     return returnArray;
   }
 
+  /**
+   * gets the first matching instance
+   * @param this
+   * @param filterArg
+   * @returns
+   */
   public static async getInstance<T>(
     this: plugins.tsclass.typeFest.Class<T>,
     filterArg: plugins.tsclass.typeFest.PartialDeep<T>
   ): Promise<T> {
-    const result = await (this as any).getInstances(filterArg);
-    if (result && result.length > 0) {
-      return result[0];
+    const foundDoc = await (this as any).collection.findOne(convertFilterForMongoDb(filterArg));
+    if (foundDoc) {
+      const newInstance: T = (this as any).createInstanceFromMongoDbNativeDoc(foundDoc);
+      return newInstance;
+    } else {
+      return null;
     }
   }
 
+  /**
+   * get cursor
+   * @returns
+   */
+  public static async getCursor<T>(
+    this: plugins.tsclass.typeFest.Class<T>,
+    filterArg: plugins.tsclass.typeFest.PartialDeep<T>
+  ) {
+    const cursor: SmartdataDbCursor<T> = await (this as any).collection.getCursor(convertFilterForMongoDb(filterArg));
+    return cursor;
+  }
+
+  /**
+   * run a function for all instances
+   * @returns
+   */
+  public static async forEach<T>(
+    this: plugins.tsclass.typeFest.Class<T>,
+    filterArg: plugins.tsclass.typeFest.PartialDeep<T>,
+    forEachFunction: (itemArg: T) => Promise<any>
+  ) {
+    const cursor: SmartdataDbCursor<T> = await (this as any).getCursor(filterArg);
+    await cursor.forEach(forEachFunction)
+  }
+
   /**
    * saves this instance but not any connected items
    * may lead to data inconsistencies, but is faster

ts/smartdata.classes.easystore.ts

@@ -28,9 +28,9 @@ export class EasyStore<T> {
     this.nameId = nameIdArg;
   }
 
-  public async getEasyStore() {
+  private async getEasyStore() {
     let easyStore = await this.easyStoreClass.getInstance({
-      nameId: this.nameId
+      nameId: this.nameId,
     });
 
     if (!easyStore) {