3.1.29

.gitignore

@@ -1,5 +1,20 @@
-node_modules/
-test/data
-pages/
+.nogit/
+
+# artifacts
 coverage/
 public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,43 +1,127 @@
-image: hosttoday/ht-docker-node:npmts
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- test
-- release
+  - security
+  - test
+  - release
+  - metadata
 
-before_script:
-  - apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv EA312927
-  - echo "deb http://repo.mongodb.org/apt/ubuntu xenial/mongodb-org/3.2 multiverse" | tee /etc/apt/sources.list.d/mongodb-org-3.2.list
-  - apt-get update
-  - apt-get install -y mongodb-org
+# ====================
+# security stage
+# ====================
+mirror:
+  stage: security
+  script:
+    - npmci git mirror
+  tags:
+    - lossless
+    - docker
+    - notpriv
 
-testLEGACY:
+audit:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+# ====================
+# test stage
+# ====================
+
+testStable:
   stage: test
   script:
-    - npmci test legacy
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
+    - lossless
     - docker
-  allow_failure: true
+    - priv
 
-testLTS:
+testBuild:
   stage: test
   script:
-    - npmci test lts
-  tags:
-    - docker
-    
-testSTABLE:
-  stage: test
-  script:
-    - npmci test stable
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
+    - lossless
     - docker
+    - notpriv
 
 release:
   stage: release
-  environment: npm_registry
   script:
-    - npmci publish
+    - npmci node install stable
+    - npmci npm publish
   only:
     - tags
   tags:
-    - docker
+    - lossless
+    - docker
+    - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  allow_failure: true
+  script:
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
+  tags:
+    - lossless
+    - docker
+    - priv
+
+trigger:
+  stage: metadata
+  script:
+    - npmci trigger
+  only:
+    - tags
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+pages:
+  stage: metadata
+  script:
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
+  tags:
+    - lossless
+    - docker
+    - notpriv
+  only:
+    - tags
+  artifacts:
+    expire_in: 1 week
+    paths:
+      - public
+  allow_failure: true

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,89 +0,0 @@
-# smartdata
-
-> Note: Still in Beta
-
-smartdata is a ODM that adheres to TypeScript practices and uses classes to organize data.
-It uses MongoDB as persistent storage.
-
-## Intention
-There are many ODMs out there, however when we searched for a ODM that uses TypeScript,
-acts smart while still embracing an easy the NoSQL idea we didn't find a matching solution.
-This is why we started smartdata
-
-How MongoDB terms map to smartdata classes
-
-MongoDB term | smartdata class
---- | ---
-Database | smartdata.Db
-Collection | smartdata.DbCollection
-Document | smartdata.DbDoc
-
-### class Db
-represents a Database. Naturally it has .connect() etc. methods on it.
-Since it is a class you can have multiple DBs defined.
-```typescript
-import * as smartdata from 'smartdata'
-
-let myDb1 = new smartdata.Db('someConnectionUrl')
-let myDb2 = new smartdata.Db('someConnectionUrl')
-
-myDb1.connect()
-myDb2.connect()
-
-// continues in next block... 
-```
-
-### class DbCollection
-represents a collection of objects.
-A collection is defined by the object class (that is extending smartdata.dbdoc) it respresents
-
-So to get to get access to a specific collection you document
-```typescript
-// continues from the block before...
-
-class myObject extends smartdata.DbDoc { // read the next block about DbDoc
-    property1:string
-    property2:number
-    constructor(optionsArg:{
-        queryArg?:any,
-        dataArg?:{
-            property1:string,
-            property2:number
-        }
-    }) {
-        super(this,optionsArg)
-    }
-} 
-let myCollection = myDb1.getCollection(myObject)
-``` 
-
-> Alert: You NEVER instantiate a collection.
-This is done for you!!!
-
-### class DbDoc
-represents a individual document in a collection
-and thereby is ideally suited to extend the class you want to actually store.
-
-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()`.
-  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
-
-So now we can **store** instances of classes to Db...
-How do we **get** a new class instance from a Doc in the DB?
-Easy! Take a look at the constructor. When you specify `optionsArg.queryArg`
-smartdata will fill in the data from the database!
-But when you specify a `optionsArg.dataArg` instead
-the data for the class is taken from there :)
-
-## TypeScript
-How does TypeScript play into this?
-Since you define your classes in TapeScript 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 whenimporting smartdata. 
-
-[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)

dist/index.d.ts

@@ -1,2 +0,0 @@
-export * from './smartdata.classes.dbcollection';
-export * from './smartdata.classes.db';

dist/index.js

@@ -1,7 +0,0 @@
-"use strict";
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
-__export(require('./smartdata.classes.dbcollection'));
-__export(require('./smartdata.classes.db'));
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7O0FBRUEsaUJBQWMsa0NBQ2QsQ0FBQyxFQUQrQztBQUNoRCxpQkFBYyx3QkFDZCxDQUFDLEVBRHFDIn0=

dist/smartdata.classes.db.d.ts

@@ -1,11 +0,0 @@
-/// <reference types="q" />
-import * as plugins from './smartdata.plugins';
-export declare type TConnectionStatus = 'disconnected' | 'connected' | 'failed';
-export declare class Db {
-    dbUrl: string;
-    db: plugins.mongodb.Db;
-    status: TConnectionStatus;
-    constructor(dbUrl: string);
-    connect(): plugins.q.Promise<any>;
-    close(): plugins.q.Promise<any>;
-}

dist/smartdata.classes.db.js

@@ -1,29 +0,0 @@
-"use strict";
-const plugins = require('./smartdata.plugins');
-class Db {
-    constructor(dbUrl) {
-        this.dbUrl = dbUrl;
-    }
-    connect() {
-        let done = plugins.q.defer();
-        plugins.mongodb.MongoClient.connect(this.dbUrl, (err, db) => {
-            if (err) {
-                console.log(err);
-            }
-            plugins.assert.equal(null, err);
-            this.db = db;
-            plugins.beautylog.success(`connected to database at ${this.dbUrl}`);
-            done.resolve(this.db);
-        });
-        return done.promise;
-    }
-    close() {
-        let done = plugins.q.defer();
-        this.db.close();
-        plugins.beautylog.ok(`disconnected to database at ${this.dbUrl}`);
-        done.resolve();
-        return done.promise;
-    }
-}
-exports.Db = Db;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRkYXRhLmNsYXNzZXMuZGIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGRhdGEuY2xhc3Nlcy5kYi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsTUFBWSxPQUFPLFdBQU0scUJBRXpCLENBQUMsQ0FGNkM7QUFJOUM7SUFLSSxZQUFZLEtBQWE7UUFDckIsSUFBSSxDQUFDLEtBQUssR0FBRyxLQUFLLENBQUE7SUFDdEIsQ0FBQztJQUVELE9BQU87UUFDSCxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFBO1FBQzVCLE9BQU8sQ0FBQyxPQUFPLENBQUMsV0FBVyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsS0FBSyxFQUFFLENBQUMsR0FBRyxFQUFFLEVBQUU7WUFDcEQsRUFBRSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztnQkFBQyxPQUFPLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxDQUFBO1lBQUMsQ0FBQztZQUM3QixPQUFPLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUE7WUFDL0IsSUFBSSxDQUFDLEVBQUUsR0FBRyxFQUFFLENBQUE7WUFDWixPQUFPLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyw0QkFBNEIsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDLENBQUE7WUFDbkUsSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUE7UUFDekIsQ0FBQyxDQUFDLENBQUE7UUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUN2QixDQUFDO0lBRUQsS0FBSztRQUNELElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUE7UUFDNUIsSUFBSSxDQUFDLEVBQUUsQ0FBQyxLQUFLLEVBQUUsQ0FBQTtRQUNmLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLCtCQUErQixJQUFJLENBQUMsS0FBSyxFQUFFLENBQUMsQ0FBQTtRQUNqRSxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUE7UUFDZCxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUN2QixDQUFDO0FBQ0wsQ0FBQztBQTVCWSxVQUFFLEtBNEJkLENBQUEifQ==

dist/smartdata.classes.dbcollection.d.ts

@@ -1,24 +0,0 @@
-/// <reference types="q" />
-import * as plugins from './smartdata.plugins';
-import { Db } from './smartdata.classes.db';
-export declare class DbCollection<T> {
-    collection: plugins.mongodb.Collection;
-    constructor(nameArg: string, dbArg: Db);
-    /**
-     * adds a validation function that all newly inserted and updated objects have to pass
-     */
-    addObjectValidation(funcArg: any): void;
-    /**
-     * finds an object in the DbCollection
-     */
-    find(docMatchArg: T | any): plugins.q.Promise<T[]>;
-    /**
-     * inserts  object into the DbCollection
-     */
-    insertOne(docArg: T): plugins.q.Promise<void>;
-    /**
-     * inserts many objects at once into the DbCollection
-     */
-    insertMany(docArrayArg: T[]): plugins.q.Promise<void>;
-    private checkDoc(doc);
-}

dist/smartdata.classes.dbcollection.js

@@ -1,57 +0,0 @@
-"use strict";
-const plugins = require('./smartdata.plugins');
-class DbCollection {
-    constructor(nameArg, dbArg) {
-        this.collection = dbArg.db.collection(nameArg);
-    }
-    /**
-     * adds a validation function that all newly inserted and updated objects have to pass
-     */
-    addObjectValidation(funcArg) { }
-    /**
-     * finds an object in the DbCollection
-     */
-    find(docMatchArg) {
-        let done = plugins.q.defer();
-        this.collection.find(docMatchArg).toArray((err, docs) => {
-            if (err) {
-                throw err;
-            }
-            done.resolve(docs);
-        });
-        return done.promise;
-    }
-    /**
-     * inserts  object into the DbCollection
-     */
-    insertOne(docArg) {
-        let done = plugins.q.defer();
-        this.checkDoc(docArg).then(() => {
-            this.collection.insertOne(docArg)
-                .then(() => { done.resolve(); });
-        });
-        return done.promise;
-    }
-    /**
-     * inserts many objects at once into the DbCollection
-     */
-    insertMany(docArrayArg) {
-        let done = plugins.q.defer();
-        let checkDocPromiseArray = [];
-        for (let docArg of docArrayArg) {
-            checkDocPromiseArray.push(this.checkDoc(docArg));
-        }
-        plugins.q.all(checkDocPromiseArray).then(() => {
-            this.collection.insertMany(docArrayArg)
-                .then(() => { done.resolve(); });
-        });
-        return done.promise;
-    }
-    checkDoc(doc) {
-        let done = plugins.q.defer();
-        done.resolve();
-        return done.promise;
-    }
-}
-exports.DbCollection = DbCollection;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRkYXRhLmNsYXNzZXMuZGJjb2xsZWN0aW9uLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRkYXRhLmNsYXNzZXMuZGJjb2xsZWN0aW9uLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxNQUFZLE9BQU8sV0FBTSxxQkFDekIsQ0FBQyxDQUQ2QztBQUc5QztJQUVJLFlBQVksT0FBZSxFQUFFLEtBQVM7UUFDbEMsSUFBSSxDQUFDLFVBQVUsR0FBRyxLQUFLLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxPQUFPLENBQUMsQ0FBQTtJQUNsRCxDQUFDO0lBRUQ7O09BRUc7SUFDSCxtQkFBbUIsQ0FBQyxPQUFPLElBQUksQ0FBQztJQUVoQzs7T0FFRztJQUNILElBQUksQ0FBQyxXQUFvQjtRQUNyQixJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBTyxDQUFBO1FBQ2pDLElBQUksQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxDQUFDLEdBQUcsRUFBRSxJQUFJO1lBQ2hELEVBQUUsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7Z0JBQUMsTUFBTSxHQUFHLENBQUE7WUFBQyxDQUFDO1lBQ3RCLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUE7UUFDdEIsQ0FBQyxDQUFDLENBQUE7UUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUN2QixDQUFDO0lBRUQ7O09BRUc7SUFDSCxTQUFTLENBQUMsTUFBUztRQUNmLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFRLENBQUE7UUFDbEMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsQ0FBQyxJQUFJLENBQUM7WUFDdkIsSUFBSSxDQUFDLFVBQVUsQ0FBQyxTQUFTLENBQUMsTUFBTSxDQUFDO2lCQUM1QixJQUFJLENBQUMsUUFBUSxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUEsQ0FBQyxDQUFDLENBQUMsQ0FBQTtRQUN2QyxDQUFDLENBQUMsQ0FBQTtRQUNGLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFBO0lBQ3ZCLENBQUM7SUFFRDs7T0FFRztJQUNILFVBQVUsQ0FBQyxXQUFnQjtRQUN2QixJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBUSxDQUFBO1FBQ2xDLElBQUksb0JBQW9CLEdBQThCLEVBQUUsQ0FBQTtRQUN4RCxHQUFHLENBQUMsQ0FBQyxJQUFJLE1BQU0sSUFBSSxXQUFXLENBQUMsQ0FBQSxDQUFDO1lBQzVCLG9CQUFvQixDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUE7UUFDcEQsQ0FBQztRQUNELE9BQU8sQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLG9CQUFvQixDQUFDLENBQUMsSUFBSSxDQUFDO1lBQ3JDLElBQUksQ0FBQyxVQUFVLENBQUMsVUFBVSxDQUFDLFdBQVcsQ0FBQztpQkFDbEMsSUFBSSxDQUFDLFFBQVEsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFBLENBQUMsQ0FBQyxDQUFDLENBQUE7UUFDdkMsQ0FBQyxDQUFDLENBQUE7UUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUN2QixDQUFDO0lBRU8sUUFBUSxDQUFDLEdBQU07UUFDbkIsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQVEsQ0FBQTtRQUNsQyxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUE7UUFDZCxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUN2QixDQUFDO0FBQ0wsQ0FBQztBQXhEWSxvQkFBWSxlQXdEeEIsQ0FBQSJ9

dist/smartdata.classes.dbdoc.js

@@ -1 +0,0 @@
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRkYXRhLmNsYXNzZXMuZGJkb2MuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGRhdGEuY2xhc3Nlcy5kYmRvYy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=

dist/smartdata.plugins.d.ts

@@ -1,5 +0,0 @@
-import 'typings-global';
-export import assert = require('assert');
-export import beautylog = require('beautylog');
-export import mongodb = require('mongodb');
-export import q = require('q');

dist/smartdata.plugins.js

@@ -1,7 +0,0 @@
-"use strict";
-require('typings-global');
-exports.assert = require('assert');
-exports.beautylog = require('beautylog');
-exports.mongodb = require('mongodb');
-exports.q = require('q');
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRkYXRhLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGRhdGEucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsUUFBTyxnQkFDUCxDQUFDLENBRHNCO0FBQ1QsY0FBTSxXQUFXLFFBQVEsQ0FBQyxDQUFBO0FBQzFCLGlCQUFTLFdBQVcsV0FBVyxDQUFDLENBQUE7QUFDaEMsZUFBTyxXQUFXLFNBQVMsQ0FBQyxDQUFBO0FBQzVCLFNBQUMsV0FBVyxHQUFHLENBQUMsQ0FBQSJ9

docs/index.md

@@ -1,19 +0,0 @@
-# smartdata
-
-smartdata is a ODM that adheres to TypeScript practices and uses classes to organize data.
-It uses MongoDB as persistent storage.
-
-## Intention
-There are many ODMs out there, however when we searched for a ODM that uses TypeScript,
-acts smart while still embracing an easy the NoSQL idea we didn't find a matching solution.
-This is why we started smartdata
-
-How MongoDB terms map to smartdata classes
-
-MongoDB term | smartdata class
---- | ---
-Database | smartdata.DbConnection
-Collection | smartdata.DbCollection
-Document | smartdata.DbDoc
-
-[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)

npmextra.json

@@ -0,0 +1,23 @@
+{
+  "npmdocker": {
+    "baseImage": "hosttoday/ht-docker-node:mongo",
+    "command": "npmci test stable",
+    "dockerSock": false
+  },
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public",
+    "npmRegistryUrl": "registry.npmjs.org"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartdata",
+      "shortDescription": "do more with data",
+      "npmPackagename": "@pushrocks/smartdata",
+      "license": "MIT"
+    }
+  }
+}

package.json

@@ -1,12 +1,14 @@
 {
-  "name": "smartdata",
-  "version": "1.0.13",
+  "name": "@pushrocks/smartdata",
+  "version": "3.1.29",
+  "private": false,
   "description": "do more with data",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
-    "test": "(npm run prepareMongo && npmts)",
-    "prepareMongo": "(rm -rf ./test/data && mkdir ./test/data/)"
+    "test": "(tstest test/)",
+    "testLocal": "(npmdocker)",
+    "build": "(tsbuild --web)"
   },
   "repository": {
     "type": "git",
@@ -19,19 +21,39 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartdata#README",
   "dependencies": {
-    "@types/mongodb": "^2.1.32",
-    "@types/q": "0.0.30",
-    "beautylog": "^5.0.23",
-    "mongodb": "^2.2.9",
-    "q": "^1.4.1",
-    "typings-global": "^1.0.14"
+    "@pushrocks/lik": "^4.0.13",
+    "@pushrocks/smartlog": "^2.0.35",
+    "@pushrocks/smartpromise": "^3.0.6",
+    "@pushrocks/smartstring": "^3.0.18",
+    "@pushrocks/smartunique": "^3.0.3",
+    "@types/lodash": "^4.14.155",
+    "@types/mongodb": "^3.5.20",
+    "lodash": "^4.17.15",
+    "mongodb": "^3.5.8",
+    "runtime-type-checks": "0.0.4"
   },
   "devDependencies": {
-    "@types/shelljs": "^0.3.30",
-    "@types/should": "^8.1.29",
-    "shelljs": "^0.7.4",
-    "should": "^11.1.0",
-    "smartstring": "^2.0.17",
-    "typings-test": "^1.0.3"
-  }
+    "@gitzone/tsbuild": "^2.1.24",
+    "@gitzone/tstest": "^1.0.33",
+    "@pushrocks/qenv": "^4.0.10",
+    "@pushrocks/tapbundle": "^3.2.1",
+    "@types/mongodb-memory-server": "^2.3.0",
+    "@types/node": "^14.0.13",
+    "@types/shortid": "0.0.29",
+    "mongodb-memory-server": "^6.6.1",
+    "tslint": "^6.1.2",
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

qenv.yml

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

readme.md

@@ -0,0 +1,147 @@
+# @pushrocks/smartdata
+do more with data
+
+## 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
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartdata/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartdata/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartdata)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartdata)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartdata)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartdata)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartdata)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
+
+## Usage
+
+Use TypeScript for best in class instellisense.
+
+smartdata is an ODM that adheres to TypeScript practices and uses classes to organize data.
+It uses RethinkDB as persistent storage.
+
+## Intention
+
+There are many ODMs out there, however when we searched for an ODM that uses TypeScript,
+acts smart while still embracing the NoSQL idea we didn't find a matching solution.
+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       |
+
+### class Db
+
+represents a Database. Naturally it has .connect() etc. methods on it.
+
+```typescript
+import * as smartdata from 'smartdata';
+
+const smartdataDb = new smartdata.SmartdataDb({
+  mongoDbUrl: '//someurl',
+  mongoDbName: 'myDatabase',
+  mongoDbPass: 'mypassword'
+});
+
+smartdataDb.connect();
+```
+
+### class DbCollection
+
+represents a collection of objects.
+A collection is defined by the object class (that is extending smartdata.dbdoc) it respresents
+
+So to get to get access to a specific collection you document
+
+```typescript
+// continues from the block before...
+
+@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
+
+  property2: number; // this one is not marked, so it won't be save upon calling this.save()
+
+  constructor() {
+    super(); // the super call is important ;) But you probably know that.
+  }
+}
+
+// start to instantiate instances of classes from scratch or database
+
+const localObject = new MyObject({
+  property1: 'hi',
+  property2: 2
+});
+localObject.save(); // saves the object to the database
+
+// start retrieving instances
+
+MyObject.getInstance<MyObject>({
+  property: 'hi'
+}); // outputs a new instance of MyObject with the values from db assigned
+```
+
+### class DbDoc
+
+represents a individual document in a collection
+and thereby is ideally suited to extend the class you want to actually store.
+
+### CRUD operations
+
+smartdata supports full CRUD operations
+
+**Store** or **Update** instances of classes to MongoDB:
+DbDoc extends your class with the following methods:
+
+- 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 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.
+
+## 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. You don't need to install any additional types for smartdata.
+
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+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)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.d.ts

@@ -1 +0,0 @@
-import 'typings-test';

test/test.js

@@ -1,79 +0,0 @@
-"use strict";
-require('typings-test');
-const shelljs = require('shelljs');
-const should = require('should');
-const smartstring = require('smartstring');
-// the tested module
-const smartdata = require('../dist/index');
-let mongoChildProcess;
-let testDb;
-let testDbCollection;
-class testCar {
-    constructor(colorArg) {
-        this.color = colorArg;
-    }
-}
-describe('mongodb', function () {
-    it('should start mongodb', function (done) {
-        this.timeout(30000);
-        mongoChildProcess = shelljs.exec('mongod --dbpath=./test/data --port 27017', { async: true, silent: true });
-        let doneCalled = false;
-        mongoChildProcess.stdout.on('data', function (data) {
-            console.log(smartstring.indent.indentWithPrefix(data, "*** MongoDB Process *** : "));
-            if (!doneCalled) {
-                if (/waiting for connections on port 27017/.test(data)) {
-                    doneCalled = true;
-                    done();
-                }
-            }
-        });
-    });
-});
-describe('smartdata', function () {
-    it('should establish a connection to mongodb', function (done) {
-        testDb = new smartdata.Db('mongodb://localhost:27017/smartdata');
-        testDb.connect().then(() => { done(); });
-    });
-    it('should create a collection', function () {
-        testDbCollection = new smartdata.DbCollection('something', testDb);
-    });
-    it('should insert a doc into the collection', function (done) {
-        testDbCollection.insertOne({ value1: 'test' }).then(() => { done(); });
-    });
-    it('should find all docs of testDbCollection', function (done) {
-        testDbCollection.find({}).then((resultArray) => {
-            console.log(resultArray);
-            should(resultArray[0].value1).equal('test');
-            done();
-        });
-    });
-    it('should insert many docs into the collection', function (done) {
-        testDbCollection.insertMany([
-            { value1: 'test2' },
-            { value1: 'test', value2: 3, value3: 'hi' }
-        ]).then(() => { done(); });
-    });
-    it('should find a specified doc', function (done) {
-        testDbCollection.find({ 'value3': { '$exists': true } }).then((resultArray) => {
-            console.log(resultArray);
-            should(resultArray[0].value3).equal('hi');
-            done();
-        }).catch(console.log);
-    });
-    it('should close the db Connection', function () {
-        testDb.close();
-    });
-});
-describe('mongodb', function () {
-    it('should kill mongodb', function (done) {
-        this.timeout(30000);
-        mongoChildProcess.stdout.on('data', function (data) {
-            if (/dbexit:  rc: 0/.test(data)) {
-                done();
-            }
-        });
-        shelljs.exec('mongod --dbpath=./test/data --shutdown');
-        mongoChildProcess.kill('SIGTERM');
-    });
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FFUCxDQUFDLENBRm9CO0FBRXJCLE1BQVksT0FBTyxXQUFNLFNBQ3pCLENBQUMsQ0FEaUM7QUFDbEMsTUFBWSxNQUFNLFdBQU0sUUFDeEIsQ0FBQyxDQUQrQjtBQUNoQyxNQUFZLFdBQVcsV0FBTSxhQUc3QixDQUFDLENBSHlDO0FBRTFDLG9CQUFvQjtBQUNwQixNQUFZLFNBQVMsV0FBTSxlQUUzQixDQUFDLENBRnlDO0FBRTFDLElBQUksaUJBQWlCLENBQUE7QUFDckIsSUFBSSxNQUFvQixDQUFBO0FBUXhCLElBQUksZ0JBQXNELENBQUE7QUFFMUQ7SUFFSSxZQUFZLFFBQWU7UUFDdkIsSUFBSSxDQUFDLEtBQUssR0FBRyxRQUFRLENBQUE7SUFDekIsQ0FBQztBQUNMLENBQUM7QUFHRCxRQUFRLENBQUMsU0FBUyxFQUFFO0lBQ2hCLEVBQUUsQ0FBQyxzQkFBc0IsRUFBRSxVQUFVLElBQUk7UUFDckMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQTtRQUNuQixpQkFBaUIsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLDBDQUEwQyxFQUFFLEVBQUUsS0FBSyxFQUFFLElBQUksRUFBRSxNQUFNLEVBQUUsSUFBSSxFQUFFLENBQUMsQ0FBQTtRQUMzRyxJQUFJLFVBQVUsR0FBRyxLQUFLLENBQUE7UUFDdEIsaUJBQWlCLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQyxNQUFNLEVBQUUsVUFBVSxJQUFJO1lBQzlDLE9BQU8sQ0FBQyxHQUFHLENBQUMsV0FBVyxDQUFDLE1BQU0sQ0FBQyxnQkFBZ0IsQ0FBQyxJQUFJLEVBQUUsNEJBQTRCLENBQUMsQ0FBQyxDQUFBO1lBQ3BGLEVBQUUsQ0FBQyxDQUFDLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQztnQkFDZCxFQUFFLENBQUMsQ0FBQyx1Q0FBdUMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDO29CQUNyRCxVQUFVLEdBQUcsSUFBSSxDQUFBO29CQUNqQixJQUFJLEVBQUUsQ0FBQTtnQkFDVixDQUFDO1lBQ0wsQ0FBQztRQUNMLENBQUMsQ0FBQyxDQUFBO0lBQ04sQ0FBQyxDQUFDLENBQUE7QUFDTixDQUFDLENBQUMsQ0FBQTtBQUVGLFFBQVEsQ0FBQyxXQUFXLEVBQUU7SUFDbEIsRUFBRSxDQUFDLDBDQUEwQyxFQUFFLFVBQVUsSUFBSTtRQUN6RCxNQUFNLEdBQUcsSUFBSSxTQUFTLENBQUMsRUFBRSxDQUFDLHFDQUFxQyxDQUFDLENBQUE7UUFDaEUsTUFBTSxDQUFDLE9BQU8sRUFBRSxDQUFDLElBQUksQ0FBQyxRQUFRLElBQUksRUFBRSxDQUFBLENBQUMsQ0FBQyxDQUFDLENBQUE7SUFDM0MsQ0FBQyxDQUFDLENBQUE7SUFDRixFQUFFLENBQUMsNEJBQTRCLEVBQUU7UUFDN0IsZ0JBQWdCLEdBQUcsSUFBSSxTQUFTLENBQUMsWUFBWSxDQUFlLFdBQVcsRUFBRSxNQUFNLENBQUMsQ0FBQTtJQUNwRixDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyx5Q0FBeUMsRUFBRSxVQUFVLElBQUk7UUFDeEQsZ0JBQWdCLENBQUMsU0FBUyxDQUFDLEVBQUUsTUFBTSxFQUFFLE1BQU0sRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLFFBQVEsSUFBSSxFQUFFLENBQUEsQ0FBQyxDQUFDLENBQUMsQ0FBQTtJQUN6RSxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQywwQ0FBMEMsRUFBRSxVQUFVLElBQUk7UUFDekQsZ0JBQWdCLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLFdBQVc7WUFDdkMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxXQUFXLENBQUMsQ0FBQTtZQUN4QixNQUFNLENBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsQ0FBQTtZQUMzQyxJQUFJLEVBQUUsQ0FBQTtRQUNWLENBQUMsQ0FBQyxDQUFBO0lBQ04sQ0FBQyxDQUFDLENBQUE7SUFDRixFQUFFLENBQUMsNkNBQTZDLEVBQUUsVUFBVSxJQUFJO1FBQzVELGdCQUFnQixDQUFDLFVBQVUsQ0FBQztZQUN4QixFQUFFLE1BQU0sRUFBRSxPQUFPLEVBQUU7WUFDbkIsRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFLE1BQU0sRUFBRSxDQUFDLEVBQUUsTUFBTSxFQUFFLElBQUksRUFBRTtTQUM5QyxDQUFDLENBQUMsSUFBSSxDQUFDLFFBQVEsSUFBSSxFQUFFLENBQUEsQ0FBQyxDQUFDLENBQUMsQ0FBQTtJQUM3QixDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyw2QkFBNkIsRUFBRSxVQUFVLElBQUk7UUFDNUMsZ0JBQWdCLENBQUMsSUFBSSxDQUFDLEVBQUMsUUFBUSxFQUFFLEVBQUMsU0FBUyxFQUFFLElBQUksRUFBQyxFQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxXQUFXO1lBQ2xFLE9BQU8sQ0FBQyxHQUFHLENBQUMsV0FBVyxDQUFDLENBQUE7WUFDeEIsTUFBTSxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxNQUFNLENBQUMsQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUE7WUFDekMsSUFBSSxFQUFFLENBQUE7UUFDVixDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxDQUFBO0lBQ3pCLENBQUMsQ0FBQyxDQUFBO0lBQ0YsRUFBRSxDQUFDLGdDQUFnQyxFQUFFO1FBQ2pDLE1BQU0sQ0FBQyxLQUFLLEVBQUUsQ0FBQTtJQUNsQixDQUFDLENBQUMsQ0FBQTtBQUNOLENBQUMsQ0FBQyxDQUFBO0FBRUYsUUFBUSxDQUFDLFNBQVMsRUFBRTtJQUNoQixFQUFFLENBQUMscUJBQXFCLEVBQUUsVUFBVSxJQUFJO1FBQ3BDLElBQUksQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLENBQUE7UUFDbkIsaUJBQWlCLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQyxNQUFNLEVBQUUsVUFBVSxJQUFJO1lBQzlDLEVBQUUsQ0FBQyxDQUFDLGdCQUFnQixDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUM7Z0JBQzlCLElBQUksRUFBRSxDQUFBO1lBQ1YsQ0FBQztRQUNMLENBQUMsQ0FBQyxDQUFBO1FBQ0YsT0FBTyxDQUFDLElBQUksQ0FBQyx3Q0FBd0MsQ0FBQyxDQUFBO1FBQ3RELGlCQUFpQixDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsQ0FBQTtJQUNyQyxDQUFDLENBQUMsQ0FBQTtBQUNOLENBQUMsQ0FBQyxDQUFBIn0=

test/test.ts

@@ -1,93 +1,143 @@
-import 'typings-test'
+import { tap, expect } from '@pushrocks/tapbundle';
+import { Qenv } from '@pushrocks/qenv';
 
-import * as shelljs from 'shelljs'
-import * as should from 'should'
-import * as smartstring from 'smartstring'
+const testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit/');
 
 // the tested module
-import * as smartdata from '../dist/index'
+import * as smartdata from '../ts/index';
+import { smartstring } from '../ts/smartdata.plugins';
+import * as smartunique from '@pushrocks/smartunique';
 
-let mongoChildProcess
-let testDb: smartdata.Db
+import * as mongoPlugin from 'mongodb-memory-server';
 
-interface ITestObject1 {
-    value1: string
-    value2?: number
-    value3?: string
+// =======================================
+// Connecting to the database server
+// =======================================
+
+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.init();
+});
+
+// =======================================
+// The actual tests
+// =======================================
+
+// ------
+// Collections
+// ------
+
+@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;
+    this.brand = brandArg;
+  }
 }
 
-let testDbCollection: smartdata.DbCollection<ITestObject1>
+tap.test('should save the car to the db', async () => {
+  const myCar = new Car('red', 'Volvo');
+  await myCar.save();
 
-class testCar {
-    color: string
-    constructor(colorArg:string) {
-        this.color = colorArg
-    }
+  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 () => {
+  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);
+});
 
-describe('mongodb', function () {
-    it('should start mongodb', function (done) {
-        this.timeout(30000)
-        mongoChildProcess = shelljs.exec('mongod --dbpath=./test/data --port 27017', { async: true, silent: true })
-        let doneCalled = false
-        mongoChildProcess.stdout.on('data', function (data) {
-            console.log(smartstring.indent.indentWithPrefix(data, "*** MongoDB Process *** : "))
-            if (!doneCalled) {
-                if (/waiting for connections on port 27017/.test(data)) {
-                    doneCalled = true
-                    done()
-                }
-            }
-        })
-    })
-})
+// =======================================
+// close the database connection
+// =======================================
+tap.test('should close the database connection', async tools => {
+  await testDb.close();
+  await mongod.stop();
+});
 
-describe('smartdata', function () {
-    it('should establish a connection to mongodb', function (done) {
-        testDb = new smartdata.Db('mongodb://localhost:27017/smartdata')
-        testDb.connect().then(() => { done() })
-    })
-    it('should create a collection', function () {
-        testDbCollection = new smartdata.DbCollection<ITestObject1>('something', testDb)
-    })
-    it('should insert a doc into the collection', function (done) {
-        testDbCollection.insertOne({ value1: 'test' }).then(() => { done() })
-    })
-    it('should find all docs of testDbCollection', function (done) {
-        testDbCollection.find({}).then((resultArray) => {
-            console.log(resultArray)
-            should(resultArray[0].value1).equal('test')
-            done()
-        })
-    })
-    it('should insert many docs into the collection', function (done) {
-        testDbCollection.insertMany([
-            { value1: 'test2' },
-            { value1: 'test', value2: 3, value3: 'hi' }
-        ]).then(() => { done() })
-    })
-    it('should find a specified doc', function (done) {
-        testDbCollection.find({'value3': {'$exists': true}}).then((resultArray) => {
-            console.log(resultArray)
-            should(resultArray[0].value3).equal('hi')
-            done()
-        }).catch(console.log)
-    })
-    it('should close the db Connection', function () {
-        testDb.close()
-    })
-})
-
-describe('mongodb', function () {
-    it('should kill mongodb', function (done) {
-        this.timeout(30000)
-        mongoChildProcess.stdout.on('data', function (data) {
-            if (/dbexit:  rc: 0/.test(data)) {
-                done()
-            }
-        })
-        shelljs.exec('mongod --dbpath=./test/data --shutdown')
-        mongoChildProcess.kill('SIGTERM')
-    })
-})
+tap.start({ throwOnError: true });

ts/index.ts

@@ -1,4 +1,5 @@
-import * as plugins from './smartdata.plugins'
+export * from './smartdata.classes.db';
+export * from './smartdata.classes.collection';
+export * from './smartdata.classes.doc';
 
-export * from './smartdata.classes.dbcollection'
-export * from './smartdata.classes.db'
+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

@@ -0,0 +1,163 @@
+import * as plugins from './smartdata.plugins';
+import { SmartdataDb } from './smartdata.classes.db';
+import { SmartDataDbDoc } from './smartdata.classes.doc';
+
+export interface IFindOptions {
+  limit?: number;
+}
+
+/**
+ *
+ */
+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 dbArg
+ */
+export function Collection(dbArg: SmartdataDb | TDelayedDbCreation) {
+  return function(constructor) {
+    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());
+      };
+    }
+  };
+}
+
+export class SmartdataCollection<T> {
+  /**
+   * the collection that is used
+   */
+  public mongoDbCollection: plugins.mongodb.Collection;
+  public objectValidation: IDocValidationFunc<T> = null;
+  public collectionName: string;
+  public smartdataDb: SmartdataDb;
+  public uniqueIndexes: string[] = [];
+
+  constructor(collectedClassArg: T & SmartDataDbDoc<T, unknown>, smartDataDbArg: SmartdataDb) {
+    // tell the collection where it belongs
+    this.collectionName = collectedClassArg.name;
+    this.smartdataDb = smartDataDbArg;
+
+    // tell the db class about it (important since Db uses different systems under the hood)
+    this.smartdataDb.addTable(this);
+  }
+
+  /**
+   * makes sure a collection exists within MongoDb that maps to the SmartdataCollection
+   */
+  public async init() {
+    if (!this.mongoDbCollection) {
+      // connect this instance to a MongoDB collection
+      const availableMongoDbCollections = await this.smartdataDb.mongoDb.collections();
+      const wantedCollection = availableMongoDbCollections.find(collection => {
+        return collection.collectionName === this.collectionName;
+      });
+      if (!wantedCollection) {
+        await this.smartdataDb.mongoDb.createCollection(this.collectionName);
+      }
+      this.mongoDbCollection = await this.smartdataDb.mongoDb.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
+   */
+  public addDocValidation(funcArg: IDocValidationFunc<T>) {
+    this.objectValidation = funcArg;
+  }
+
+  /**
+   * finds an object in the DbCollection
+   */
+  public async find(filterObject: any): Promise<any> {
+    await this.init();
+    const result = await this.mongoDbCollection.find(filterObject).toArray();
+    return result;
+  }
+
+  /**
+   * create an object in the database
+   */
+  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();
+    const result = await this.mongoDbCollection.insertOne(saveableObject);
+    return result;
+  }
+
+  /**
+   * inserts object into the DbCollection
+   */
+  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();
+    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
+    });
+  }
+
+  /**
+   * checks a Doc for constraints
+   * if this.objectValidation is not set it passes.
+   */
+  private checkDoc(docArg: T): Promise<void> {
+    const done = plugins.smartq.defer<void>();
+    let validationResult = true;
+    if (this.objectValidation) {
+      validationResult = this.objectValidation(docArg);
+    }
+    if (validationResult) {
+      done.resolve();
+    } else {
+      done.reject('validation of object did not pass');
+    }
+    return done.promise;
+  }
+}

ts/smartdata.classes.db.ts

@@ -1,33 +1,92 @@
-import * as plugins from './smartdata.plugins'
+import * as plugins from './smartdata.plugins';
+import { ObjectMap } from '@pushrocks/lik';
 
-export type TConnectionStatus = 'disconnected' | 'connected' | 'failed'
+import { SmartdataCollection } from './smartdata.classes.collection';
 
-export class Db {
-    dbUrl: string
-    db: plugins.mongodb.Db
-    status: TConnectionStatus
+import * as mongoHelpers from './smartdata.mongohelpers';
+import { logger } from './smartdata.logging';
 
-    constructor(dbUrl: string) {
-        this.dbUrl = dbUrl
-    }
+/**
+ * interface - indicates the connection status of the db
+ */
+export type TConnectionStatus = 'initial' | 'disconnected' | 'connected' | 'failed';
 
-    connect(): plugins.q.Promise<any> {
-        let done = plugins.q.defer()
-        plugins.mongodb.MongoClient.connect(this.dbUrl, (err, db) => {
-            if (err) { console.log(err) }
-            plugins.assert.equal(null, err)
-            this.db = db
-            plugins.beautylog.success(`connected to database at ${this.dbUrl}`)
-            done.resolve(this.db)
-        })
-        return done.promise
-    }
+export interface ISmartdataOptions {
+  /**
+   * the URL to connect to
+   */
+  mongoDbUrl: string;
 
-    close(): plugins.q.Promise<any> {
-        let done = plugins.q.defer()
-        this.db.close()
-        plugins.beautylog.ok(`disconnected to database at ${this.dbUrl}`)
-        done.resolve()
-        return done.promise
-    }
+  /**
+   * the db to use for the project
+   */
+  mongoDbName: string;
+
+  /**
+   * an optional password that will be replace <PASSWORD> in the connection string
+   */
+  mongoDbPass?: string;
+}
+
+export class SmartdataDb {
+  smartdataOptions: ISmartdataOptions;
+  mongoDbClient: plugins.mongodb.MongoClient;
+  mongoDb: plugins.mongodb.Db;
+  status: TConnectionStatus;
+  smartdataCollectionMap = new ObjectMap<SmartdataCollection<any>>();
+
+  constructor(smartdataOptions: ISmartdataOptions) {
+    this.smartdataOptions = smartdataOptions;
+    this.status = 'initial';
+  }
+
+  // basic connection stuff ----------------------------------------------
+
+  /**
+   * connects to the database that was specified during instance creation
+   */
+  public async init(): Promise<any> {
+    let finalConnectionUrl = this.smartdataOptions.mongoDbUrl;
+    if (this.smartdataOptions.mongoDbPass) {
+      finalConnectionUrl = mongoHelpers.addPassword(
+        this.smartdataOptions.mongoDbUrl,
+        this.smartdataOptions.mongoDbPass
+      );
+    }
+    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}`);
+  }
+
+  /**
+   * closes the connection to the databse
+   */
+  public async close(): Promise<any> {
+    await this.mongoDbClient.close();
+    this.status = 'disconnected';
+    logger.log('info', `disconnected from database ${this.smartdataOptions.mongoDbName}`);
+  }
+
+  // handle table to class distribution
+
+  public addTable(SmartdataCollectionArg: SmartdataCollection<any>) {
+    this.smartdataCollectionMap.add(SmartdataCollectionArg);
+  }
+
+  /**
+   * Gets a collection's name and returns a SmartdataCollection instance
+   * @param nameArg
+   * @returns DbTable
+   */
+  public async getSmartdataCollectionByName<T>(nameArg: string): Promise<SmartdataCollection<T>> {
+    const resultCollection = this.smartdataCollectionMap.find(dbTableArg => {
+      return dbTableArg.collectionName === nameArg;
+    });
+    return resultCollection;
+  }
 }

ts/smartdata.classes.dbcollection.ts

@@ -1,60 +0,0 @@
-import * as plugins from './smartdata.plugins'
-import { Db } from './smartdata.classes.db'
-
-export class DbCollection<T> {
-    collection: plugins.mongodb.Collection
-    constructor(nameArg: string, dbArg: Db) {
-        this.collection = dbArg.db.collection(nameArg)
-    }
-
-    /**
-     * adds a validation function that all newly inserted and updated objects have to pass
-     */
-    addObjectValidation(funcArg) { }
-
-    /**
-     * finds an object in the DbCollection
-     */
-    find(docMatchArg: T | any): plugins.q.Promise<T[]> {
-        let done = plugins.q.defer<T[]>()
-        this.collection.find(docMatchArg).toArray((err, docs) => {
-            if (err) { throw err }
-            done.resolve(docs)
-        })
-        return done.promise
-    }
-
-    /**
-     * inserts  object into the DbCollection
-     */
-    insertOne(docArg: T): plugins.q.Promise<void> {
-        let done = plugins.q.defer<void>()
-        this.checkDoc(docArg).then(() => {
-            this.collection.insertOne(docArg)
-                .then(() => { done.resolve() })
-        })
-        return done.promise
-    }
-
-    /**
-     * inserts many objects at once into the DbCollection
-     */
-    insertMany(docArrayArg: T[]): plugins.q.Promise<void> {
-        let done = plugins.q.defer<void>()
-        let checkDocPromiseArray: plugins.q.Promise<void>[] = []
-        for (let docArg of docArrayArg){
-            checkDocPromiseArray.push(this.checkDoc(docArg))
-        }
-        plugins.q.all(checkDocPromiseArray).then(() => {
-            this.collection.insertMany(docArrayArg)
-                .then(() => { done.resolve() })
-        })
-        return done.promise
-    }
-
-    private checkDoc(doc: T): plugins.q.Promise<void> {
-        let done = plugins.q.defer<void>()
-        done.resolve()
-        return done.promise
-    }
-}

ts/smartdata.classes.doc.ts

@@ -0,0 +1,188 @@
+import * as plugins from './smartdata.plugins';
+
+import { ObjectMap } from '@pushrocks/lik';
+
+import { SmartdataDb } from './smartdata.classes.db';
+import { SmartdataCollection } from './smartdata.classes.collection';
+
+export type TDocCreation = 'db' | 'new' | 'mixed';
+
+/**
+ * saveable - saveable decorator to be used on class properties
+ */
+export function svDb() {
+  return (target: SmartDataDbDoc<unknown, unknown>, key: string) => {
+    console.log(`called svDb() on ${key}`);
+    if (!target.saveableProperties) {
+      target.saveableProperties = [];
+    }
+    target.saveableProperties.push(key);
+  };
+}
+
+/**
+ * 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
+   */
+  public collection: SmartdataCollection<T>;
+
+  /**
+   * how the Doc in memory was created, may prove useful later.
+   */
+  public creationStatus: TDocCreation = 'new';
+
+  /**
+   * unique indexes
+   */
+  public uniqueIndexes: string[];
+
+  /**
+   * an array of saveable properties of a doc
+   */
+  public saveableProperties: string[];
+
+  /**
+   * name
+   */
+  public name: string;
+
+  /**
+   * primary id in the database
+   */
+  public dbDocUniqueId: string;
+
+  /**
+   * class constructor
+   */
+  constructor() {
+    this.name = this.constructor['name'];
+    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');
+    }
+  }
+
+  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 (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;
+  }
+
+  public static async getInstance<T>(filterArg): Promise<T> {
+    const result = await this.getInstances<T>(filterArg);
+    if (result && result.length > 0) {
+      return result[0];
+    }
+  }
+
+  /**
+   * saves this instance but not any connected items
+   * may lead to data inconsistencies, but is faster
+   */
+  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':
+        const writeResult = await this.collection.insert(self);
+        this.creationStatus = 'db';
+        break;
+      default:
+        console.error('neither new nor in db?');
+    }
+  }
+
+  /**
+   * 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
+   */
+  public saveDeep(savedMapArg: ObjectMap<SmartDataDbDoc<any, any>> = null) {
+    if (!savedMapArg) {
+      savedMapArg = new ObjectMap<SmartDataDbDoc<any, any>>();
+    }
+    savedMapArg.add(this);
+    this.save();
+    for (const propertyKey of Object.keys(this)) {
+      const property: any = this[propertyKey];
+      if (property instanceof SmartDataDbDoc && !savedMapArg.checkForObject(property)) {
+        property.saveDeep(savedMapArg);
+      }
+    }
+  }
+
+  /**
+   * 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 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.logging.ts

@@ -0,0 +1,3 @@
+import * as plugins from './smartdata.plugins';
+
+export const logger = new plugins.smartlog.ConsoleLog();

ts/smartdata.mongohelpers.ts

@@ -0,0 +1,7 @@
+export const addUsername = (mongoUrlArg: string, usernameArg: string): string => {
+  return mongoUrlArg.replace('<USERNAME>', usernameArg);
+};
+
+export const addPassword = (mongoUrlArg: string, passwordArg: string): string => {
+  return mongoUrlArg.replace('<PASSWORD>', passwordArg);
+};

ts/smartdata.plugins.ts

@@ -1,5 +1,9 @@
-import 'typings-global'
-export import assert = require('assert')
-export import beautylog = require('beautylog')
-export import mongodb = require('mongodb')
-export import q = require('q')
+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 '@pushrocks/smartpromise';
+import * as smartstring from '@pushrocks/smartstring';
+import * as smartunique from '@pushrocks/smartunique';
+
+export { assert, smartlog, lodash, smartq, mongodb, smartstring, smartunique };

tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "target": "es2017",
+    "module": "commonjs"
+  }
+}

tslint.json

@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
-}
+  "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"
+}