3.1.26

.gitignore

@@ -1,4 +1,22 @@
-node_modules/
-public/
-coverage/
 .nogit/
+
+# artifacts
+coverage/
+public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom

.gitlab-ci.yml

@@ -1,5 +1,5 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
@@ -26,6 +26,7 @@ mirror:
 snyk:
   stage: security
   script:
+    - npmci npm prepare
     - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
@@ -36,44 +37,35 @@ snyk:
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
-testLTS:
-  stage: test
-  script:
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+testStable:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install stable
   - npmci npm install
   - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - priv
+
+testBuild:
+  stage: test
+  script:
+  - npmci npm prepare
+  - npmci node install lts
+  - npmci npm install
+  - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+  - docker
   - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
+  - npmci node install lts
   - npmci npm publish
   only:
   - tags
@@ -86,19 +78,11 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
+    - npmci command npm install -g tslint typescript
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
   - docker
   - priv
@@ -114,11 +98,15 @@ trigger:
   - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
+  image: hosttoday/ht-docker-dbase:npmci
+  services:
+   - docker:stable-dind
   stage: metadata
   script:
-    - npmci command npm install -g npmpage
-    - npmci command npmpage
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
   tags:
     - docker
     - notpriv
@@ -129,13 +117,3 @@ pages:
     paths:
     - public
   allow_failure: true
-
-windowsCompatibility:
-  image: stefanscherer/node-windows:10-build-tools
-  stage: metadata
-  script:
-  - npm install & npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - windows
-  allow_failure: true

README.md

@@ -1,26 +1,20 @@
 # @pushrocks/smartdata
+do more with data
 
-do more with data and RethinkDB
-
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/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/)
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartdata)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartdata)
+* [github.com (source mirror)](https://github.com/pushrocks/smartdata)
+* [docs (typedoc)](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)
-[![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/smartdata.svg)](https://www.npmjs.com/package/smartdata)
-[![Dependency Status](https://david-dm.org/pushrocks/smartdata.svg)](https://david-dm.org/pushrocks/smartdata)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartdata/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartdata/master/dependencies/npm)
-[![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/)
+[![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)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartdata.svg)](https://www.npmjs.com/package/@pushrocks/smartdata)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartdata/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartdata)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
 
 ## Usage
 
@@ -37,11 +31,11 @@ This is why we started smartdata.
 
 How RethinkDB's terms map to the ones of smartdata:
 
-| MongoDb term   | smartdata class               |
-| -------------- | ------------------------------|
-| Database       | smartdata.SmartdataDb         |
-| Collection     | smartdata.SmartdataCollection |
-| Document       | smartdata.SmartadataDoc       |
+| MongoDb term | smartdata class               |
+| ------------ | ----------------------------- |
+| Database     | smartdata.SmartdataDb         |
+| Collection   | smartdata.SmartdataCollection |
+| Document     | smartdata.SmartadataDoc       |
 
 ### class Db
 
@@ -72,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
 });
@@ -99,31 +96,42 @@ 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.
+For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **&copy;** [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)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

docs/index.md

@@ -1,29 +0,0 @@
-# smartdata
-
-do more with data
-
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/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)
-[![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/smartdata.svg)](https://www.npmjs.com/package/smartdata)
-[![Dependency Status](https://david-dm.org/pushrocks/smartdata.svg)](https://david-dm.org/pushrocks/smartdata)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartdata/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartdata/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartdata/badges/code.svg)](https://www.bithound.io/github/pushrocks/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/)
-
-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)
-
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)

npmextra.json

@@ -5,14 +5,18 @@
     "dockerSock": false
   },
   "npmci": {
-    "npmGlobalTools": [
-      "npmts"
-    ],
-    "npmAccessLevel": "public"
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public",
+    "npmRegistryUrl": "registry.npmjs.org"
   },
-  "npmts": {
-    "testConfig": {
-      "parallel": false
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartdata",
+      "shortDescription": "do more with data",
+      "npmPackagename": "@pushrocks/smartdata",
+      "license": "MIT"
     }
   }
-}
+}

package.json

@@ -1,14 +1,14 @@
 {
   "name": "@pushrocks/smartdata",
-  "version": "3.0.3",
+  "version": "3.1.26",
   "private": false,
   "description": "do more with data",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "tsrun test/test.ts",
+    "test": "(tstest test/)",
     "testLocal": "(npmdocker)",
-    "build": "(npmts)"
+    "build": "(tsbuild)"
   },
   "repository": {
     "type": "git",
@@ -21,20 +21,38 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartdata#README",
   "dependencies": {
-    "@pushrocks/smartlog": "^1.0.6",
-    "@pushrocks/smartpromise": "^2.0.5",
-    "@types/lodash": "^4.14.110",
-    "@types/mongodb": "^3.1.1",
-    "lik": "^2.0.5",
-    "lodash": "^4.17.10",
-    "mongodb": "^3.1.1",
-    "runtime-type-checks": "0.0.4",
-    "smartstring": "^2.0.28"
+    "@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.149",
+    "@types/mongodb": "^3.3.16",
+    "lodash": "^4.17.15",
+    "mongodb": "^3.5.3",
+    "runtime-type-checks": "0.0.4"
   },
   "devDependencies": {
-    "@gitzone/tsrun": "^1.1.2",
-    "@types/node": "^10.5.2",
-    "qenv": "^1.1.7",
-    "tapbundle": "^2.0.2"
-  }
+    "@gitzone/tsbuild": "^2.1.17",
+    "@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": "^6.2.4",
+    "tslint": "^6.0.0",
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "files": [
+    "ts/*",
+    "ts_web/*",
+    "dist/*",
+    "dist_web/*",
+    "dist_ts_web/*",
+    "assets/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

qenv.yml

@@ -1,4 +1,4 @@
-vars:
+required:
   - MONGO_URL
   - MONGO_DBNAME
   - MONGO_PASS

test/test.ts

@@ -1,25 +1,36 @@
-import { tap, expect } from 'tapbundle';
-import * as smartpromise from '@pushrocks/smartpromise';
-import { Qenv } from 'qenv';
+import { tap, expect } from '@pushrocks/tapbundle';
+import { Qenv } from '@pushrocks/qenv';
 
-let testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit/');
+const testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit/');
 
 // the tested module
-import * as smartdata from '../ts';
+import * as smartdata from '../ts/index';
 import { smartstring } from '../ts/smartdata.plugins';
+import * as smartunique from '@pushrocks/smartunique';
+
+import * as mongoPlugin from 'mongodb-memory-server';
 
 // =======================================
 // Connecting to the database server
 // =======================================
 
-let testDb = new smartdata.SmartdataDb({
-  mongoDbName: process.env.MONGO_DBNAME,
-  mongoDbUrl: process.env.MONGO_URL,
-  mongoDbPass: process.env.MONGO_PASS
+let testDb: smartdata.SmartdataDb;
+let smartdataOptions: smartdata.ISmartdataOptions;
+let mongod: mongoPlugin.MongoMemoryServer;
+
+tap.test('should create a testinstance as database', async () => {
+  mongod = new mongoPlugin.MongoMemoryServer();
+  smartdataOptions = {
+    mongoDbName: await mongod.getDbName(),
+    mongoDbPass: '',
+    mongoDbUrl: await mongod.getConnectionString()
+  };
+  console.log(smartdataOptions);
+  testDb = new smartdata.SmartdataDb(smartdataOptions);
 });
 
 tap.test('should establish a connection to the rethink Db cluster', async () => {
-  await testDb.connect();
+  await testDb.init();
 });
 
 // =======================================
@@ -30,10 +41,19 @@ tap.test('should establish a connection to the rethink Db cluster', async () =>
 // Collections
 // ------
 
-@smartdata.Collection(testDb)
-class Car extends smartdata.SmartDataDbDoc<Car> {
-  @smartdata.svDb() color: string;
-  @smartdata.svDb() brand: string;
+@smartdata.Collection(() => {
+  return testDb;
+})
+class Car extends smartdata.SmartDataDbDoc<Car, Car> {
+  @smartdata.unI()
+  public index: string = smartunique.shortId();
+
+  @smartdata.svDb()
+  public color: string;
+
+  @smartdata.svDb()
+  public brand: string;
+
   constructor(colorArg: string, brandArg: string) {
     super();
     this.color = colorArg;
@@ -44,20 +64,84 @@ class Car extends smartdata.SmartDataDbDoc<Car> {
 tap.test('should save the car to the db', async () => {
   const myCar = new Car('red', 'Volvo');
   await myCar.save();
+
+  const myCar2 = new Car('red', 'Volvo');
+  await myCar2.save();
+
+  const myCar3 = new Car('red', 'Renault');
+  await myCar3.save();
 });
 
 tap.test('expect to get instance of Car', async () => {
-  let myCars = await Car.getInstances<Car>({
+  const myCars = await Car.getInstances<Car>({
     brand: 'Volvo'
   });
   expect(myCars[0].color).to.equal('red');
 });
 
+tap.test('expect to get instance of Car and update it', async () => {
+  const myCar = await Car.getInstance<Car>({
+    brand: 'Volvo'
+  });
+  expect(myCar.color).to.equal('red');
+  myCar.color = 'blue';
+  await myCar.save();
+});
+
+tap.test('should be able to delete an instance of car', async () => {
+  const myCar = await Car.getInstance<Car>({
+    brand: 'Volvo'
+  });
+  expect(myCar.color).to.equal('blue');
+  await myCar.delete();
+
+  const myCar2 = await Car.getInstance<Car>({
+    brand: 'Volvo'
+  });
+  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
 // =======================================
 tap.test('should close the database connection', async tools => {
   await testDb.close();
+  await mongod.stop();
 });
 
-tap.start();
+tap.start({ throwOnError: true });

ts/index.ts

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

ts/interfaces/index.ts

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

ts/interfaces/mongodescriptor.ts

@@ -0,0 +1,5 @@
+export interface IMongoDescriptor {
+  mongoDbName: string;
+  mongoDbUrl: string;
+  mongoDbPass: string;
+}

ts/smartdata.classes.collection.ts

@@ -13,13 +13,22 @@ export interface IDocValidationFunc<T> {
   (doc: T): boolean;
 }
 
+export type TDelayedDbCreation = () => SmartdataDb;
+
 /**
  * This is a decorator that will tell the decorated class what dbTable to use
- * @param db
+ * @param dbArg
  */
-export function Collection(db: SmartdataDb) {
+export function Collection(dbArg: SmartdataDb | TDelayedDbCreation) {
   return function(constructor) {
-    constructor['smartdataCollection'] = new SmartdataCollection(constructor, db);
+    if (dbArg instanceof SmartdataDb) {
+      // tslint:disable-next-line: no-string-literal
+      constructor['smartdataCollection'] = new SmartdataCollection(constructor, dbArg);
+    } else {
+      constructor['smartdataDelayedCollection'] = () => {
+        return new SmartdataCollection(constructor, dbArg());
+      };
+    }
   };
 }
 
@@ -27,12 +36,13 @@ export class SmartdataCollection<T> {
   /**
    * the collection that is used
    */
-  mongoDbCollection: plugins.mongodb.Collection;
-  objectValidation: IDocValidationFunc<T> = null;
-  collectionName: string;
-  smartdataDb: SmartdataDb;
+  public mongoDbCollection: plugins.mongodb.Collection;
+  public objectValidation: IDocValidationFunc<T> = null;
+  public collectionName: string;
+  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;
@@ -44,7 +54,7 @@ export class SmartdataCollection<T> {
   /**
    * makes sure a collection exists within MongoDb that maps to the SmartdataCollection
    */
-  async init() {
+  public async init() {
     if (!this.mongoDbCollection) {
       // connect this instance to a MongoDB collection
       const availableMongoDbCollections = await this.smartdataDb.mongoDb.collections();
@@ -55,21 +65,36 @@ export class SmartdataCollection<T> {
         await this.smartdataDb.mongoDb.createCollection(this.collectionName);
       }
       this.mongoDbCollection = await this.smartdataDb.mongoDb.collection(this.collectionName);
-      console.log(`Successfully initiated Collection ${this.collectionName}`)
+      // console.log(`Successfully initiated Collection ${this.collectionName}`);
+    }
+  }
+
+  /**
+   * mark unique index
+   */
+  public markUniqueIndexes(keyArrayArg: string[] = []) {
+    for (const key of keyArrayArg) {
+      if (!this.uniqueIndexes.includes(key)) {
+        this.mongoDbCollection.createIndex(key, {
+          unique: true
+        });
+        // make sure we only call this once and not for every doc we create
+        this.uniqueIndexes.push(key);
+      }
     }
   }
 
   /**
    * adds a validation function that all newly inserted and updated objects have to pass
    */
-  addDocValidation(funcArg: IDocValidationFunc<T>) {
+  public addDocValidation(funcArg: IDocValidationFunc<T>) {
     this.objectValidation = funcArg;
   }
 
   /**
    * finds an object in the DbCollection
    */
-  async find(filterObject: any): Promise<any> {
+  public async find(filterObject: any): Promise<any> {
     await this.init();
     const result = await this.mongoDbCollection.find(filterObject).toArray();
     return result;
@@ -78,11 +103,11 @@ export class SmartdataCollection<T> {
   /**
    * create an object in the database
    */
-  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);
     const saveableObject = await dbDocArg.createSavableObject();
-    console.log(saveableObject);
     const result = await this.mongoDbCollection.insertOne(saveableObject);
     return result;
   }
@@ -90,11 +115,32 @@ export class SmartdataCollection<T> {
   /**
    * inserts object into the DbCollection
    */
-  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();
-    this.mongoDbCollection.updateOne(saveableObject.dbDocUniqueId, saveableObject);
+    const updateableObject: any = {};
+    for (const key of Object.keys(saveableObject)) {
+      if (identifiableObject[key]) {
+        continue;
+      }
+      updateableObject[key] = saveableObject[key];
+    }
+    this.mongoDbCollection.updateOne(
+      identifiableObject,
+      { $set: updateableObject },
+      { upsert: true }
+    );
+  }
+
+  public async delete(dbDocArg: T & SmartDataDbDoc<T, unknown>): Promise<any> {
+    await this.init();
+    await this.checkDoc(dbDocArg);
+    const identifiableObject = await dbDocArg.createIdentifiableObject();
+    await this.mongoDbCollection.deleteOne(identifiableObject, {
+      w: 1
+    });
   }
 
   /**
@@ -102,7 +148,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

@@ -1,5 +1,5 @@
 import * as plugins from './smartdata.plugins';
-import { Objectmap } from 'lik';
+import { Objectmap } from '@pushrocks/lik';
 
 import { SmartdataCollection } from './smartdata.classes.collection';
 
@@ -44,7 +44,7 @@ export class SmartdataDb {
   /**
    * connects to the database that was specified during instance creation
    */
-  async connect(): Promise<any> {
+  public async init(): Promise<any> {
     let finalConnectionUrl = this.smartdataOptions.mongoDbUrl;
     if (this.smartdataOptions.mongoDbPass) {
       finalConnectionUrl = mongoHelpers.addPassword(
@@ -52,13 +52,11 @@ export class SmartdataDb {
         this.smartdataOptions.mongoDbPass
       );
     }
-    console.log(finalConnectionUrl);
-    this.mongoDbClient = await plugins.mongodb.MongoClient.connect(
-      finalConnectionUrl,
-      {
-        useNewUrlParser: true
-      }
-    );
+    console.log(`connection Url: ${finalConnectionUrl}`);
+    this.mongoDbClient = await plugins.mongodb.MongoClient.connect(finalConnectionUrl, {
+      useNewUrlParser: true,
+      useUnifiedTopology: true
+    });
     this.mongoDb = this.mongoDbClient.db(this.smartdataOptions.mongoDbName);
     this.status = 'connected';
     console.log(`Connected to database ${this.smartdataOptions.mongoDbName}`);
@@ -67,17 +65,18 @@ export class SmartdataDb {
   /**
    * closes the connection to the databse
    */
-  async close(): Promise<any> {
+  public async close(): Promise<any> {
     await this.mongoDbClient.close();
     this.status = 'disconnected';
-    plugins.smartlog
-      .getDefaultLogger()
-      .info(`disconnected from database ${this.smartdataOptions.mongoDbName}`);
+    plugins.smartlog.defaultLogger.log(
+      'info',
+      `disconnected from database ${this.smartdataOptions.mongoDbName}`
+    );
   }
 
   // handle table to class distribution
 
-  addTable(SmartdataCollectionArg: SmartdataCollection<any>) {
+  public addTable(SmartdataCollectionArg: SmartdataCollection<any>) {
     this.smartdataCollectionMap.add(SmartdataCollectionArg);
   }
 
@@ -86,8 +85,8 @@ export class SmartdataDb {
    * @param nameArg
    * @returns DbTable
    */
-  async getSmartdataCollectionByName<T>(nameArg: string): Promise<SmartdataCollection<T>> {
-    let resultCollection = this.smartdataCollectionMap.find(dbTableArg => {
+  public async getSmartdataCollectionByName<T>(nameArg: string): Promise<SmartdataCollection<T>> {
+    const resultCollection = this.smartdataCollectionMap.find(dbTableArg => {
       return dbTableArg.collectionName === nameArg;
     });
     return resultCollection;

ts/smartdata.classes.doc.ts

@@ -1,6 +1,6 @@
 import * as plugins from './smartdata.plugins';
 
-import { Objectmap } from 'lik';
+import { Objectmap } from '@pushrocks/lik';
 
 import { SmartdataDb } from './smartdata.classes.db';
 import { SmartdataCollection } from './smartdata.classes.collection';
@@ -11,8 +11,8 @@ export type TDocCreation = 'db' | 'new' | 'mixed';
  * saveable - saveable decorator to be used on class properties
  */
 export function svDb() {
-  return (target: SmartDataDbDoc<any>, key: string) => {
-    console.log('called sva');
+  return (target: SmartDataDbDoc<unknown, unknown>, key: string) => {
+    console.log(`called svDb() on ${key}`);
     if (!target.saveableProperties) {
       target.saveableProperties = [];
     }
@@ -20,59 +20,99 @@ export function svDb() {
   };
 }
 
-export class SmartDataDbDoc<T> {
+/**
+ * unique index - decorator to mark a unique index
+ */
+export function unI() {
+  return (target: SmartDataDbDoc<unknown, unknown>, key: string) => {
+    console.log('called unI');
+
+    // mark the index as unique
+    if (!target.uniqueIndexes) {
+      target.uniqueIndexes = [];
+    }
+    target.uniqueIndexes.push(key);
+
+    // and also save it
+    if (!target.saveableProperties) {
+      target.saveableProperties = [];
+    }
+    target.saveableProperties.push(key);
+  };
+}
+
+export class SmartDataDbDoc<T, TImplements> {
   /**
    * the collection object an Doc belongs to
    */
-  collection: SmartdataCollection<T>;
+  public collection: SmartdataCollection<T>;
 
   /**
    * how the Doc in memory was created, may prove useful later.
    */
-  creationStatus: TDocCreation = 'new';
+  public creationStatus: TDocCreation = 'new';
+
+  /**
+   * unique indexes
+   */
+  public uniqueIndexes: string[];
 
   /**
    * an array of saveable properties of a doc
    */
-  saveableProperties: string[];
+  public saveableProperties: string[];
 
   /**
    * name
    */
-  name: string;
+  public name: string;
 
   /**
    * primary id in the database
    */
-  dbDocUniqueId: string;
+  public dbDocUniqueId: string;
 
   /**
    * class constructor
    */
   constructor() {
     this.name = this.constructor['name'];
-    this.collection = 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
+    } else if (typeof this.constructor['smartdataDelayedCollection'] === 'function') {
+      // tslint:disable-next-line: no-string-literal
+      this.collection = this.constructor['smartdataDelayedCollection']();
+    } else {
+      console.error('Could not determine collection for DbDoc');
+    }
   }
 
-  static async getInstances<T>(filterArg): Promise<T[]> {
-    let self: any = this; // fool typesystem
-    let referenceMongoDBCollection: SmartdataCollection<T> = self.smartdataCollection;
+  public static async getInstances<T>(filterArg): Promise<T[]> {
+    const 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) {
-      let newInstance = new this();
-      for (let key in item) {
-        if (key !== 'id') {
-          newInstance[key] = item[key];
-        }
+    for (const item of foundDocs) {
+      const newInstance = new this();
+      newInstance.creationStatus = 'db';
+      for (const key of Object.keys(item)) {
+        newInstance[key] = item[key];
       }
       returnArray.push(newInstance);
     }
     return returnArray;
   }
 
-  static async getInstance<T>(filterArg): Promise<T> {
-    let result = await this.getInstances<T>(filterArg);
+  public static async getInstance<T>(filterArg): Promise<T> {
+    const result = await this.getInstances<T>(filterArg);
     if (result && result.length > 0) {
       return result[0];
     }
@@ -82,14 +122,15 @@ export class SmartDataDbDoc<T> {
    * saves this instance but not any connected items
    * may lead to data inconsistencies, but is faster
    */
-  async save() {
-    let self: any = this;
+  public async save() {
+    // tslint:disable-next-line: no-this-assignment
+    const self: any = this;
     switch (this.creationStatus) {
       case 'db':
         await this.collection.update(self);
         break;
       case 'new':
-        let writeResult = await this.collection.insert(self);
+        const writeResult = await this.collection.insert(self);
         this.creationStatus = 'db';
         break;
       default:
@@ -97,29 +138,51 @@ export class SmartDataDbDoc<T> {
     }
   }
 
+  /**
+   * deletes a document from the database
+   */
+  public async delete() {
+    const self: any = this;
+    await this.collection.delete(self);
+  }
+
   /**
    * also store any referenced objects to DB
    * better for data consistency
    */
-  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();
-    for (let propertyKey in this) {
-      let property: any = this[propertyKey];
+    for (const propertyKey of Object.keys(this)) {
+      const property: any = this[propertyKey];
       if (property instanceof SmartDataDbDoc && !savedMapArg.checkForObject(property)) {
         property.saveDeep(savedMapArg);
       }
     }
   }
 
-  async createSavableObject() {
-    let saveableObject: any = {}; // is not exposed to outside, so any is ok here
-    for (let propertyNameString of this.saveableProperties) {
+  /**
+   * creates a saveable object so the instance can be persisted as json in the database
+   */
+  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;
+  }
+
+  /**
+   * 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;
   }
 }

ts/smartdata.plugins.ts

@@ -2,7 +2,8 @@ import * as assert from 'assert';
 import * as smartlog from '@pushrocks/smartlog';
 import * as lodash from 'lodash';
 import * as mongodb from 'mongodb';
-import * as smartq from 'smartq';
-import * as smartstring from 'smartstring';
+import * as smartq from '@pushrocks/smartpromise';
+import * as smartstring from '@pushrocks/smartstring';
+import * as smartunique from '@pushrocks/smartunique';
 
-export { assert, smartlog, lodash, smartq, mongodb, smartstring };
+export { assert, smartlog, lodash, smartq, mongodb, smartstring, smartunique };

tslint.json

@@ -0,0 +1,17 @@
+{
+  "extends": ["tslint:latest", "tslint-config-prettier"],
+  "rules": {
+    "semicolon": [true, "always"],
+    "no-console": false,
+    "ordered-imports": false,
+    "object-literal-sort-keys": false,
+    "member-ordering": {
+      "options":{
+        "order": [
+          "static-method"
+        ]
+      }
+    }
+  },
+  "defaultSeverity": "warning"
+}