3.1.26

README.md

@@ -66,16 +66,19 @@ So to get to get access to a specific collection you document
 @smartdata.Collection(smartdataDb)
 class MyObject extends smartdata.DbDoc<MyObject> {
   // read the next block about DbDoc
-  @smartdata.svDb() property1: string; // @smartdata.svDb() marks the property for db save
+  @smartdata.svDb()
+  property1: string; // @smartdata.svDb() marks the property for db save
+  
   property2: number; // this one is not marked, so it won't be save upon calling this.save()
-  constructor(optionsArg: { property1: string; property2: number }) {
-    super();
+  
+  constructor() {
+    super(); // the super call is important ;) But you probably know that.
   }
 }
 
 // start to instantiate instances of classes from scratch or database
 
-let localObject = new MyObject({
+const localObject = new MyObject({
   property1: 'hi',
   property2: 2
 });
@@ -93,27 +96,38 @@ MyObject.getInstance<MyObject>({
 represents a individual document in a collection
 and thereby is ideally suited to extend the class you want to actually store.
 
-**sStore** instances of classes to Db:
+### CRUD operations
+smartdata supports full CRUD operations 
+
+**Store** or **Update** instances of classes to MongoDB:
 DbDoc extends your class with the following methods:
 
-- `.save()` will save (or update) the object you call it on only. Any referenced non-savable objects will not get stored.
-- `.saveDeep()` does the same like `.save()`.
+- async `.save()` will save (or update) the object you call it on only. Any referenced non-savable objects will not get stored.
+- async `.saveDeep()` does the same like `.save()`.
   In addition it will look for properties that reference an object
   that extends DbDoc as well and call .saveDeep() on them as well.
   Loops are prevented
 
-**Get** a new class instance from a Doc in the DB:
-DbDoc exposes a static method that allows you specify a filter to retrieve a cloned class of the one you used to that doc at some point later in time. Yes, let that sink in a minute :)
+**Get** a new class instance from MongoDB:
+DbDoc exposes a static method that allows you specify a filter to retrieve a cloned class of the one you used to that doc at some point later in time:
+
+* static async `.getInstance({ /* filter props here */ })` gets you an instance that has the data of the first matched document as properties.
+* static async `getInstances({ /* filter props here */ })` get you an array instances (one instance for every matched document).
+
+**Delete** instances from MongoDb:
+smartdata extends your class with a method to easily delete the doucment from DB:
+
+* async `.delete()`will delete the document from DB. 
+
+
 
-So you can just call `.getInstance({ /* filter props here */ })`.
 
 ## TypeScript
 
 How does TypeScript play into this?
 Since you define your classes in TypeScript and types flow through smartdata in a generic way
 you should get all the Intellisense and type checking you love when using smartdata.
-smartdata itself also bundles typings.
-So you don't need to install any additional types when importing smartdata.
+smartdata itself also bundles typings. You don't need to install any additional types for smartdata.
 
 For further information read the linked docs at the top of this readme.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartdata",
-  "version": "3.1.18",
+  "version": "3.1.26",
   "private": false,
   "description": "do more with data",
   "main": "dist/index.js",
@@ -21,27 +21,27 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartdata#README",
   "dependencies": {
-    "@pushrocks/lik": "^3.0.11",
-    "@pushrocks/smartlog": "^2.0.19",
-    "@pushrocks/smartpromise": "^3.0.2",
-    "@pushrocks/smartstring": "^3.0.10",
+    "@pushrocks/lik": "^3.0.19",
+    "@pushrocks/smartlog": "^2.0.21",
+    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartstring": "^3.0.18",
     "@pushrocks/smartunique": "^3.0.1",
-    "@types/lodash": "^4.14.138",
-    "@types/mongodb": "^3.3.1",
+    "@types/lodash": "^4.14.149",
+    "@types/mongodb": "^3.3.16",
     "lodash": "^4.17.15",
-    "mongodb": "^3.3.2",
+    "mongodb": "^3.5.3",
     "runtime-type-checks": "0.0.4"
   },
   "devDependencies": {
     "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/qenv": "^4.0.4",
-    "@pushrocks/tapbundle": "^3.0.13",
-    "@types/mongodb-memory-server": "^1.8.0",
-    "@types/node": "^12.7.3",
+    "@gitzone/tstest": "^1.0.28",
+    "@pushrocks/qenv": "^4.0.6",
+    "@pushrocks/tapbundle": "^3.2.0",
+    "@types/mongodb-memory-server": "^2.3.0",
+    "@types/node": "^13.7.2",
     "@types/shortid": "0.0.29",
-    "mongodb-memory-server": "^5.2.0",
-    "tslint": "^5.19.0",
+    "mongodb-memory-server": "^6.2.4",
+    "tslint": "^6.0.0",
     "tslint-config-prettier": "^1.18.0"
   },
   "files": [

test/test.ts

@@ -29,14 +29,6 @@ tap.test('should create a testinstance as database', async () => {
   testDb = new smartdata.SmartdataDb(smartdataOptions);
 });
 
-tap.skip.test('should create a smartdb', async () => {
-  testDb = new smartdata.SmartdataDb({
-    mongoDbName: testQenv.getEnvVarOnDemand('MONGO_DBNAME'),
-    mongoDbUrl: testQenv.getEnvVarOnDemand('MONGO_URL'),
-    mongoDbPass: testQenv.getEnvVarOnDemand('MONGO_PASS')
-  });
-});
-
 tap.test('should establish a connection to the rethink Db cluster', async () => {
   await testDb.init();
 });
@@ -52,7 +44,7 @@ tap.test('should establish a connection to the rethink Db cluster', async () =>
 @smartdata.Collection(() => {
   return testDb;
 })
-class Car extends smartdata.SmartDataDbDoc<Car> {
+class Car extends smartdata.SmartDataDbDoc<Car, Car> {
   @smartdata.unI()
   public index: string = smartunique.shortId();
 
@@ -109,6 +101,41 @@ tap.test('should be able to delete an instance of car', async () => {
   expect(myCar2.color).to.equal('red');
 });
 
+
+
+// tslint:disable-next-line: max-classes-per-file
+@smartdata.Collection(() => {
+  return testDb;
+})
+class Truck extends smartdata.SmartDataDbDoc<Car, Car> {
+  @smartdata.unI()
+  public id: string = smartunique.shortId();
+
+  @smartdata.svDb()
+  public color: string;
+
+  @smartdata.svDb()
+  public brand: string;
+
+  constructor(colorArg: string, brandArg: string) {
+    super();
+    this.color = colorArg;
+    this.brand = brandArg;
+  }
+}
+
+tap.test('should store a new Truck', async () => {
+  const truck = new Truck('blue', 'MAN');
+  await truck.save();
+  const myTruck = await Truck.getInstance<Truck>({color: 'blue'});
+  myTruck.id = 'foo';
+  await myTruck.save();
+  const myTruck2 = await Truck.getInstance<Truck>({color: 'blue'});
+  console.log(myTruck2);
+
+});
+
+
 // =======================================
 // close the database connection
 // =======================================

ts/smartdata.classes.collection.ts

@@ -42,7 +42,7 @@ export class SmartdataCollection<T> {
   public smartdataDb: SmartdataDb;
   public uniqueIndexes: string[] = [];
 
-  constructor(collectedClassArg: T & SmartDataDbDoc<T>, smartDataDbArg: SmartdataDb) {
+  constructor(collectedClassArg: T & SmartDataDbDoc<T, unknown>, smartDataDbArg: SmartdataDb) {
     // tell the collection where it belongs
     this.collectionName = collectedClassArg.name;
     this.smartdataDb = smartDataDbArg;
@@ -103,7 +103,7 @@ export class SmartdataCollection<T> {
   /**
    * create an object in the database
    */
-  public async insert(dbDocArg: T & SmartDataDbDoc<T>): Promise<any> {
+  public async insert(dbDocArg: T & SmartDataDbDoc<T, unknown>): Promise<any> {
     await this.init();
     await this.checkDoc(dbDocArg);
     this.markUniqueIndexes(dbDocArg.uniqueIndexes);
@@ -115,13 +115,11 @@ export class SmartdataCollection<T> {
   /**
    * inserts object into the DbCollection
    */
-  public async update(dbDocArg: T & SmartDataDbDoc<T>): Promise<any> {
+  public async update(dbDocArg: T & SmartDataDbDoc<T, unknown>): Promise<any> {
     await this.init();
     await this.checkDoc(dbDocArg);
     const identifiableObject = await dbDocArg.createIdentifiableObject();
     const saveableObject = await dbDocArg.createSavableObject();
-    console.log(identifiableObject);
-    console.log(saveableObject);
     const updateableObject: any = {};
     for (const key of Object.keys(saveableObject)) {
       if (identifiableObject[key]) {
@@ -129,7 +127,6 @@ export class SmartdataCollection<T> {
       }
       updateableObject[key] = saveableObject[key];
     }
-    console.log(updateableObject);
     this.mongoDbCollection.updateOne(
       identifiableObject,
       { $set: updateableObject },
@@ -137,11 +134,13 @@ export class SmartdataCollection<T> {
     );
   }
 
-  public async delete(dbDocArg: T & SmartDataDbDoc<T>): Promise<any> {
+  public async delete(dbDocArg: T & SmartDataDbDoc<T, unknown>): Promise<any> {
     await this.init();
     await this.checkDoc(dbDocArg);
     const identifiableObject = await dbDocArg.createIdentifiableObject();
-    this.mongoDbCollection.deleteOne(identifiableObject);
+    await this.mongoDbCollection.deleteOne(identifiableObject, {
+      w: 1
+    });
   }
 
   /**

ts/smartdata.classes.db.ts

@@ -54,7 +54,8 @@ export class SmartdataDb {
     }
     console.log(`connection Url: ${finalConnectionUrl}`);
     this.mongoDbClient = await plugins.mongodb.MongoClient.connect(finalConnectionUrl, {
-      useNewUrlParser: true
+      useNewUrlParser: true,
+      useUnifiedTopology: true
     });
     this.mongoDb = this.mongoDbClient.db(this.smartdataOptions.mongoDbName);
     this.status = 'connected';

ts/smartdata.classes.doc.ts

@@ -11,7 +11,7 @@ export type TDocCreation = 'db' | 'new' | 'mixed';
  * saveable - saveable decorator to be used on class properties
  */
 export function svDb() {
-  return (target: SmartDataDbDoc<any>, key: string) => {
+  return (target: SmartDataDbDoc<unknown, unknown>, key: string) => {
     console.log(`called svDb() on ${key}`);
     if (!target.saveableProperties) {
       target.saveableProperties = [];
@@ -24,7 +24,7 @@ export function svDb() {
  * unique index - decorator to mark a unique index
  */
 export function unI() {
-  return (target: SmartDataDbDoc<any>, key: string) => {
+  return (target: SmartDataDbDoc<unknown, unknown>, key: string) => {
     console.log('called unI');
 
     // mark the index as unique
@@ -41,7 +41,7 @@ export function unI() {
   };
 }
 
-export class SmartDataDbDoc<T> {
+export class SmartDataDbDoc<T, TImplements> {
   /**
    * the collection object an Doc belongs to
    */
@@ -103,17 +103,15 @@ export class SmartDataDbDoc<T> {
     for (const item of foundDocs) {
       const newInstance = new this();
       newInstance.creationStatus = 'db';
-      for (const key in item) {
-        if (key !== 'id') {
-          newInstance[key] = item[key];
-        }
+      for (const key of Object.keys(item)) {
+        newInstance[key] = item[key];
       }
       returnArray.push(newInstance);
     }
     return returnArray;
   }
 
-  static async getInstance<T>(filterArg): Promise<T> {
+  public static async getInstance<T>(filterArg): Promise<T> {
     const result = await this.getInstances<T>(filterArg);
     if (result && result.length > 0) {
       return result[0];
@@ -152,9 +150,9 @@ export class SmartDataDbDoc<T> {
    * also store any referenced objects to DB
    * better for data consistency
    */
-  public saveDeep(savedMapArg: Objectmap<SmartDataDbDoc<any>> = null) {
+  public saveDeep(savedMapArg: Objectmap<SmartDataDbDoc<any, any>> = null) {
     if (!savedMapArg) {
-      savedMapArg = new Objectmap<SmartDataDbDoc<any>>();
+      savedMapArg = new Objectmap<SmartDataDbDoc<any, any>>();
     }
     savedMapArg.add(this);
     this.save();
@@ -169,12 +167,12 @@ export class SmartDataDbDoc<T> {
   /**
    * creates a saveable object so the instance can be persisted as json in the database
    */
-  public async createSavableObject() {
-    const saveableObject: any = {}; // is not exposed to outside, so any is ok here
+  public async createSavableObject(): Promise<TImplements> {
+    const saveableObject: unknown = {}; // is not exposed to outside, so any is ok here
     for (const propertyNameString of this.saveableProperties) {
       saveableObject[propertyNameString] = this[propertyNameString];
     }
-    return saveableObject;
+    return saveableObject as TImplements;
   }
 
   /**