3.1.14

README.md

@@ -1,25 +1,19 @@
 # @pushrocks/smartdata
+do more with data
 
-do more with data and RethinkDB
+## Availabililty and Links
-
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartdata)
-## Availabililty
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartdata)
-
+* [github.com (source mirror)](https://github.com/pushrocks/smartdata)
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartdata)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartdata/)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartdata)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartdata)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartdata/)
 
 ## Status for master
-
+[![build status](https://gitlab.com/pushrocks/smartdata/badges/master/build.svg)](https://gitlab.com/pushrocks/smartdata/commits/master)
-[![build status](https://GitLab.com/pushrocks/smartdata/badges/master/build.svg)](https://GitLab.com/pushrocks/smartdata/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smartdata/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartdata/commits/master)
-[![coverage report](https://GitLab.com/pushrocks/smartdata/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartdata/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartdata.svg)](https://www.npmjs.com/package/@pushrocks/smartdata)
-[![npm downloads per month](https://img.shields.io/npm/dm/smartdata.svg)](https://www.npmjs.com/package/smartdata)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartdata/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartdata)
-[![Dependency Status](https://david-dm.org/pushrocks/smartdata.svg)](https://david-dm.org/pushrocks/smartdata)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartdata/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartdata/master/dependencies/npm)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartdata/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartdata)
-[![Known Vulnerabilities](https://snyk.io/test/npm/smartdata/badge.svg)](https://snyk.io/test/npm/smartdata)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
 [![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
 
 ## Usage
@@ -121,9 +115,9 @@ you should get all the Intellisense and type checking you love when using smartd
 smartdata itself also bundles typings.
 So you don't need to install any additional types when importing smartdata.
 
-For further information read the linked docs at the top of this README.
+For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

npmextra.json

@@ -8,5 +8,15 @@
     "npmGlobalTools": [],
     "npmAccessLevel": "public",
     "npmRegistryUrl": "registry.npmjs.org"
+  },
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartdata",
+      "shortDescription": "do more with data",
+      "npmPackagename": "@pushrocks/smartdata",
+      "license": "MIT"
+    }
   }
-}
+}

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartdata",
-  "version": "3.1.10",
+  "version": "3.1.14",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

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

test/test.ts

@@ -20,7 +20,7 @@ let testDb = new smartdata.SmartdataDb({
 });
 
 tap.test('should establish a connection to the rethink Db cluster', async () => {
-  await testDb.connect();
+  await testDb.init();
 });
 
 // =======================================

ts/index.ts

@@ -2,4 +2,4 @@ export * from './smartdata.classes.db';
 export * from './smartdata.classes.collection';
 export * from './smartdata.classes.doc';
 
-export { IMongoDescriptor } from './interfaces';
+export { IMongoDescriptor } from './interfaces';

ts/interfaces/index.ts

@@ -1 +1 @@
-export * from './mongodescriptor';
+export * from './mongodescriptor';

ts/smartdata.classes.collection.ts

@@ -26,10 +26,9 @@ export function Collection(dbArg: SmartdataDb | TDelayedDbCreation) {
       constructor['smartdataCollection'] = new SmartdataCollection(constructor, dbArg);
     } else {
       constructor['smartdataDelayedCollection'] = () => {
-        return new SmartdataCollection(constructor, dbArg()); 
+        return new SmartdataCollection(constructor, dbArg());
       };
     }
-    
   };
 }
 
@@ -109,7 +108,6 @@ export class SmartdataCollection<T> {
     await this.checkDoc(dbDocArg);
     this.markUniqueIndexes(dbDocArg.uniqueIndexes);
     const saveableObject = await dbDocArg.createSavableObject();
-    console.log(saveableObject);
     const result = await this.mongoDbCollection.insertOne(saveableObject);
     return result;
   }
@@ -117,11 +115,19 @@ export class SmartdataCollection<T> {
   /**
    * inserts object into the DbCollection
    */
-  async update(dbDocArg: T & SmartDataDbDoc<T>): Promise<any> {
+  public async update(dbDocArg: T & SmartDataDbDoc<T>): Promise<any> {
     await this.init();
     await this.checkDoc(dbDocArg);
+    const identifiableObject = await dbDocArg.createIdentifiableObject();
     const saveableObject = await dbDocArg.createSavableObject();
-    this.mongoDbCollection.updateOne(saveableObject.dbDocUniqueId, saveableObject);
+    this.mongoDbCollection.updateOne(identifiableObject, saveableObject);
+  }
+
+  public async delete(dbDocArg: T & SmartDataDbDoc<T>): Promise<any> {
+    await this.init();
+    await this.checkDoc(dbDocArg);
+    const identifiableObject = await dbDocArg.createIdentifiableObject();
+    this.mongoDbCollection.deleteOne(identifiableObject);
   }
 
   /**
@@ -129,7 +135,7 @@ export class SmartdataCollection<T> {
    * if this.objectValidation is not set it passes.
    */
   private checkDoc(docArg: T): Promise<void> {
-    let done = plugins.smartq.defer<void>();
+    const done = plugins.smartq.defer<void>();
     let validationResult = true;
     if (this.objectValidation) {
       validationResult = this.objectValidation(docArg);

ts/smartdata.classes.db.ts

@@ -44,7 +44,7 @@ export class SmartdataDb {
   /**
    * connects to the database that was specified during instance creation
    */
-  async connect(): Promise<any> {
+  async init(): Promise<any> {
     let finalConnectionUrl = this.smartdataOptions.mongoDbUrl;
     if (this.smartdataOptions.mongoDbPass) {
       finalConnectionUrl = mongoHelpers.addPassword(
@@ -53,12 +53,9 @@ export class SmartdataDb {
       );
     }
     console.log(finalConnectionUrl);
-    this.mongoDbClient = await plugins.mongodb.MongoClient.connect(
+    this.mongoDbClient = await plugins.mongodb.MongoClient.connect(finalConnectionUrl, {
-      finalConnectionUrl,
+      useNewUrlParser: true
-      {
+    });
-        useNewUrlParser: true
-      }
-    );
     this.mongoDb = this.mongoDbClient.db(this.smartdataOptions.mongoDbName);
     this.status = 'connected';
     console.log(`Connected to database ${this.smartdataOptions.mongoDbName}`);

ts/smartdata.classes.doc.ts

@@ -77,7 +77,7 @@ export class SmartDataDbDoc<T> {
    */
   constructor() {
     this.name = this.constructor['name'];
-    if(this.constructor['smartdataCollection']) {
+    if (this.constructor['smartdataCollection']) {
       // tslint:disable-next-line: no-string-literal
       this.collection = this.constructor['smartdataCollection'];
       // tslint:disable-next-line: no-string-literal
@@ -92,12 +92,12 @@ export class SmartDataDbDoc<T> {
   static async getInstances<T>(filterArg): Promise<T[]> {
     let self: any = this; // fool typesystem
     let referenceMongoDBCollection: SmartdataCollection<T>;
-    
+
     if (self.smartdataCollection) {
       referenceMongoDBCollection = self.smartdataCollection;
     } else if (self.smartdataDelayedCollection) {
       referenceMongoDBCollection = self.smartdataDelayedCollection();
-    };
+    }
     const foundDocs = await referenceMongoDBCollection.find(filterArg);
     const returnArray = [];
     for (let item of foundDocs) {
@@ -139,6 +139,11 @@ export class SmartDataDbDoc<T> {
     }
   }
 
+  /**
+   * deletes a document from the database
+   */
+  async delete() {}
+
   /**
    * also store any referenced objects to DB
    * better for data consistency
@@ -157,11 +162,25 @@ export class SmartDataDbDoc<T> {
     }
   }
 
-  async createSavableObject() {
+  /**
-    let saveableObject: any = {}; // is not exposed to outside, so any is ok here
+   * creates a saveable object so the instance can be persisted as json in the database
-    for (let propertyNameString of this.saveableProperties) {
+   */
+  public async createSavableObject() {
+    const saveableObject: any = {}; // is not exposed to outside, so any is ok here
+    for (const propertyNameString of this.saveableProperties) {
       saveableObject[propertyNameString] = this[propertyNameString];
     }
     return saveableObject;
   }
+
+  /**
+   * creates an identifiable object for operations that require filtering
+   */
+  public async createIdentifiableObject() {
+    const identifiableObject: any = {}; // is not exposed to outside, so any is ok here
+    for (const propertyNameString of this.uniqueIndexes) {
+      identifiableObject[propertyNameString] = this[propertyNameString];
+    }
+    return identifiableObject;
+  }
 }