1.0.14

README.md

@@ -0,0 +1,86 @@
+# smartdata
+
+> Note: Still in Beta
+
+smartdata is an 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 an ODM that uses TypeScript,
+acts smart while still embracing an 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:{
+        property1:string,
+        property2:number
+    }) {
+        super(this,myDb1)
+    }
+} 
+let myCollection = myDb1.getCollectionByName<myObject>(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 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. 
+
+[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)

dist/index.d.ts

@@ -1,14 +1,3 @@
-/// <reference types="q" />
-import * as plugins from './smartdata.plugins';
-export declare class DbCollection<T> {
-    constructor(nameArg: string, db: plugins.mongodb.Db);
-}
-export declare type TDbConnectionStatus = 'disconnected' | 'connected' | 'failed';
-export declare class DbConnection {
-    dbUrl: string;
-    db: plugins.mongodb.Db;
-    status: TDbConnectionStatus;
-    constructor(dbUrl: string);
-    connect(): plugins.q.Promise<any>;
-    close(): plugins.q.Promise<any>;
-}
+export * from './smartdata.classes.db';
+export * from './smartdata.classes.dbcollection';
+export * from './smartdata.classes.dbdoc';

dist/index.js

@@ -1,35 +1,8 @@
 "use strict";
-const plugins = require('./smartdata.plugins');
-class DbCollection {
-    constructor(nameArg, db) {
-        let collection = db.collection(nameArg);
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
 }
-}
-exports.DbCollection = DbCollection;
-class DbConnection {
-    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.DbConnection = DbConnection;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsTUFBWSxPQUFPLFdBQU0scUJBRXpCLENBQUMsQ0FGNkM7QUFFOUM7SUFDSSxZQUFZLE9BQWUsRUFBRSxFQUFzQjtRQUMvQyxJQUFJLFVBQVUsR0FBRyxFQUFFLENBQUMsVUFBVSxDQUFDLE9BQU8sQ0FBQyxDQUFBO0lBQzNDLENBQUM7QUFDTCxDQUFDO0FBSlksb0JBQVksZUFJeEIsQ0FBQTtBQUlEO0lBS0ksWUFBWSxLQUFhO1FBQ3JCLElBQUksQ0FBQyxLQUFLLEdBQUcsS0FBSyxDQUFBO0lBQ3RCLENBQUM7SUFFRCxPQUFPO1FBQ0gsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQTtRQUM1QixPQUFPLENBQUMsT0FBTyxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDLEdBQUcsRUFBRSxFQUFFO1lBQ3BELEVBQUUsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7Z0JBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQTtZQUFDLENBQUM7WUFDN0IsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFBO1lBQy9CLElBQUksQ0FBQyxFQUFFLEdBQUcsRUFBRSxDQUFBO1lBQ1osT0FBTyxDQUFDLFNBQVMsQ0FBQyxPQUFPLENBQUMsNEJBQTRCLElBQUksQ0FBQyxLQUFLLEVBQUUsQ0FBQyxDQUFBO1lBQ25FLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFBO1FBQ3pCLENBQUMsQ0FBQyxDQUFBO1FBQ0YsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUE7SUFDdkIsQ0FBQztJQUVELEtBQUs7UUFDRCxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFBO1FBQzVCLElBQUksQ0FBQyxFQUFFLENBQUMsS0FBSyxFQUFFLENBQUE7UUFDZixPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQywrQkFBK0IsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDLENBQUE7UUFDakUsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFBO1FBQ2QsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUE7SUFDdkIsQ0FBQztBQUNMLENBQUM7QUE1Qlksb0JBQVksZUE0QnhCLENBQUEifQ==
+__export(require('./smartdata.classes.db'));
+__export(require('./smartdata.classes.dbcollection'));
+__export(require('./smartdata.classes.dbdoc'));
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7O0FBRUEsaUJBQWMsd0JBQ2QsQ0FBQyxFQURxQztBQUN0QyxpQkFBYyxrQ0FDZCxDQUFDLEVBRCtDO0FBQ2hELGlCQUFjLDJCQUNkLENBQUMsRUFEd0MifQ==

dist/smartdata.classes.db.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="q" />
+import * as plugins from './smartdata.plugins';
+import { Objectmap } from 'lik';
+import { DbCollection } from './smartdata.classes.dbcollection';
+export declare type TConnectionStatus = 'disconnected' | 'connected' | 'failed';
+export declare class Db {
+    dbUrl: string;
+    db: plugins.mongodb.Db;
+    status: TConnectionStatus;
+    collections: Objectmap<DbCollection<any>>;
+    constructor(dbUrl: string);
+    /**
+     * connects to the database that was specified during instance creation
+     */
+    connect(): plugins.q.Promise<any>;
+    /**
+     * closes the connection to the databse
+     */
+    close(): plugins.q.Promise<any>;
+    /**
+     * gets a collection by name: string
+     */
+    getCollectionByName<T>(nameArg: string): plugins.q.Promise<DbCollection<T>>;
+}

dist/smartdata.classes.db.js

@@ -0,0 +1,53 @@
+"use strict";
+const plugins = require('./smartdata.plugins');
+const lik_1 = require('lik');
+class Db {
+    constructor(dbUrl) {
+        this.collections = new lik_1.Objectmap();
+        this.dbUrl = dbUrl;
+    }
+    // basic connection stuff ----------------------------------------------
+    /**
+     * connects to the database that was specified during instance creation
+     */
+    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;
+    }
+    /**
+     * closes the connection to the databse
+     */
+    close() {
+        let done = plugins.q.defer();
+        this.db.close();
+        plugins.beautylog.ok(`disconnected to database at ${this.dbUrl}`);
+        done.resolve();
+        return done.promise;
+    }
+    // advanced communication with the database --------------------------------
+    /**
+     * gets a collection by name: string
+     */
+    getCollectionByName(nameArg) {
+        let done = plugins.q.defer();
+        let resultCollection = this.collections.find((dbCollectionArg) => {
+            return dbCollectionArg.name === nameArg;
+        });
+        if (resultCollection !== null) {
+            done.resolve(resultCollection);
+        }
+        return done.promise;
+    }
+    ;
+}
+exports.Db = Db;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRkYXRhLmNsYXNzZXMuZGIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGRhdGEuY2xhc3Nlcy5kYi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsTUFBWSxPQUFPLFdBQU0scUJBQ3pCLENBQUMsQ0FENkM7QUFDOUMsc0JBQTBCLEtBRTFCLENBQUMsQ0FGOEI7QUFNL0I7SUFNSSxZQUFZLEtBQWE7UUFGekIsZ0JBQVcsR0FBRyxJQUFJLGVBQVMsRUFBcUIsQ0FBQTtRQUc1QyxJQUFJLENBQUMsS0FBSyxHQUFHLEtBQUssQ0FBQTtJQUN0QixDQUFDO0lBRUQsd0VBQXdFO0lBRXhFOztPQUVHO0lBQ0gsT0FBTztRQUNILElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUE7UUFDNUIsT0FBTyxDQUFDLE9BQU8sQ0FBQyxXQUFXLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxLQUFLLEVBQUUsQ0FBQyxHQUFHLEVBQUUsRUFBRTtZQUNwRCxFQUFFLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDO2dCQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLENBQUE7WUFBQyxDQUFDO1lBQzdCLE9BQU8sQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQTtZQUMvQixJQUFJLENBQUMsRUFBRSxHQUFHLEVBQUUsQ0FBQTtZQUNaLE9BQU8sQ0FBQyxTQUFTLENBQUMsT0FBTyxDQUFDLDRCQUE0QixJQUFJLENBQUMsS0FBSyxFQUFFLENBQUMsQ0FBQTtZQUNuRSxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQTtRQUN6QixDQUFDLENBQUMsQ0FBQTtRQUNGLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFBO0lBQ3ZCLENBQUM7SUFFRDs7T0FFRztJQUNILEtBQUs7UUFDRCxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFBO1FBQzVCLElBQUksQ0FBQyxFQUFFLENBQUMsS0FBSyxFQUFFLENBQUE7UUFDZixPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQywrQkFBK0IsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDLENBQUE7UUFDakUsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFBO1FBQ2QsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUE7SUFDdkIsQ0FBQztJQUVELDRFQUE0RTtJQUU1RTs7T0FFRztJQUNILG1CQUFtQixDQUFJLE9BQWU7UUFDbEMsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQXFCLENBQUE7UUFDL0MsSUFBSSxnQkFBZ0IsR0FBRyxJQUFJLENBQUMsV0FBVyxDQUFDLElBQUksQ0FBQyxDQUFDLGVBQWU7WUFDekQsTUFBTSxDQUFDLGVBQWUsQ0FBQyxJQUFJLEtBQUssT0FBTyxDQUFBO1FBQzNDLENBQUMsQ0FBQyxDQUFBO1FBQ0YsRUFBRSxDQUFDLENBQUMsZ0JBQWdCLEtBQUssSUFBSSxDQUFDLENBQUMsQ0FBQztZQUM1QixJQUFJLENBQUMsT0FBTyxDQUFDLGdCQUFnQixDQUFDLENBQUE7UUFDbEMsQ0FBQztRQUNELE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFBO0lBQ3ZCLENBQUM7O0FBQ0wsQ0FBQztBQXJEWSxVQUFFLEtBcURkLENBQUEifQ==

dist/smartdata.classes.dbcollection.d.ts

@@ -0,0 +1,28 @@
+/// <reference types="q" />
+import * as plugins from './smartdata.plugins';
+import { Db } from './smartdata.classes.db';
+export interface IFindOptions {
+    limit?: number;
+}
+export declare class DbCollection<T> {
+    collection: plugins.mongodb.Collection;
+    name: string;
+    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, optionsArg?: IFindOptions): 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

@@ -0,0 +1,64 @@
+"use strict";
+const plugins = require('./smartdata.plugins');
+class DbCollection {
+    constructor(nameArg, dbArg) {
+        this.name = nameArg;
+        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, optionsArg) {
+        let done = plugins.q.defer();
+        let findCursor = this.collection.find(docMatchArg);
+        if (optionsArg) {
+            if (optionsArg.limit) {
+                findCursor = findCursor.limit(1);
+            }
+        }
+        findCursor.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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRkYXRhLmNsYXNzZXMuZGJjb2xsZWN0aW9uLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRkYXRhLmNsYXNzZXMuZGJjb2xsZWN0aW9uLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxNQUFZLE9BQU8sV0FBTSxxQkFDekIsQ0FBQyxDQUQ2QztBQU85QztJQUdJLFlBQVksT0FBZSxFQUFFLEtBQVM7UUFDbEMsSUFBSSxDQUFDLElBQUksR0FBRyxPQUFPLENBQUE7UUFDbkIsSUFBSSxDQUFDLFVBQVUsR0FBRyxLQUFLLENBQUMsRUFBRSxDQUFDLFVBQVUsQ0FBQyxPQUFPLENBQUMsQ0FBQTtJQUNsRCxDQUFDO0lBRUQ7O09BRUc7SUFDSCxtQkFBbUIsQ0FBQyxPQUFPLElBQUksQ0FBQztJQUVoQzs7T0FFRztJQUNILElBQUksQ0FBQyxXQUFvQixFQUFFLFVBQXlCO1FBQ2hELElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFPLENBQUE7UUFDakMsSUFBSSxVQUFVLEdBQUcsSUFBSSxDQUFDLFVBQVUsQ0FBQyxJQUFJLENBQUMsV0FBVyxDQUFDLENBQUE7UUFDbEQsRUFBRSxDQUFDLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQztZQUNiLEVBQUUsQ0FBQyxDQUFFLFVBQVUsQ0FBQyxLQUFNLENBQUMsQ0FBQyxDQUFDO2dCQUFDLFVBQVUsR0FBRyxVQUFVLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFBO1lBQUMsQ0FBQztRQUNoRSxDQUFDO1FBQ0QsVUFBVSxDQUFDLE9BQU8sQ0FBQyxDQUFDLEdBQUcsRUFBRSxJQUFJO1lBQ3pCLEVBQUUsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7Z0JBQUMsTUFBTSxHQUFHLENBQUE7WUFBQyxDQUFDO1lBQ3RCLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUE7UUFDdEIsQ0FBQyxDQUFDLENBQUE7UUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUN2QixDQUFDO0lBRUQ7O09BRUc7SUFDSCxTQUFTLENBQUMsTUFBUztRQUNmLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFRLENBQUE7UUFDbEMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsQ0FBQyxJQUFJLENBQUM7WUFDdkIsSUFBSSxDQUFDLFVBQVUsQ0FBQyxTQUFTLENBQUMsTUFBTSxDQUFDO2lCQUM1QixJQUFJLENBQUMsUUFBUSxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUEsQ0FBQyxDQUFDLENBQUMsQ0FBQTtRQUN2QyxDQUFDLENBQUMsQ0FBQTtRQUNGLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFBO0lBQ3ZCLENBQUM7SUFFRDs7T0FFRztJQUNILFVBQVUsQ0FBQyxXQUFnQjtRQUN2QixJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBUSxDQUFBO1FBQ2xDLElBQUksb0JBQW9CLEdBQThCLEVBQUUsQ0FBQTtRQUN4RCxHQUFHLENBQUMsQ0FBQyxJQUFJLE1BQU0sSUFBSSxXQUFXLENBQUMsQ0FBQSxDQUFDO1lBQzVCLG9CQUFvQixDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUE7UUFDcEQsQ0FBQztRQUNELE9BQU8sQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLG9CQUFvQixDQUFDLENBQUMsSUFBSSxDQUFDO1lBQ3JDLElBQUksQ0FBQyxVQUFVLENBQUMsVUFBVSxDQUFDLFdBQVcsQ0FBQztpQkFDbEMsSUFBSSxDQUFDLFFBQVEsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFBLENBQUMsQ0FBQyxDQUFDLENBQUE7UUFDdkMsQ0FBQyxDQUFDLENBQUE7UUFDRixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUN2QixDQUFDO0lBRU8sUUFBUSxDQUFDLEdBQU07UUFDbkIsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQVEsQ0FBQTtRQUNsQyxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUE7UUFDZCxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUN2QixDQUFDO0FBQ0wsQ0FBQztBQTlEWSxvQkFBWSxlQThEeEIsQ0FBQSJ9

dist/smartdata.classes.dbdoc.d.ts

@@ -0,0 +1,10 @@
+import { Db } from './smartdata.classes.db';
+import { DbCollection } from './smartdata.classes.dbcollection';
+export declare type TDocCreation = 'db' | 'data' | 'mixed';
+export declare class DbDoc<T> {
+    collection: DbCollection<T>;
+    creationType: TDocCreation;
+    constructor(collectionNameArg: string, dbArg: Db);
+    save(): void;
+    saveDeep(): void;
+}

dist/smartdata.classes.dbdoc.js

@@ -0,0 +1,13 @@
+"use strict";
+const smartdata_classes_dbcollection_1 = require('./smartdata.classes.dbcollection');
+class DbDoc {
+    constructor(collectionNameArg, dbArg) {
+        this.collection = new smartdata_classes_dbcollection_1.DbCollection(collectionNameArg, dbArg);
+    }
+    save() {
+    }
+    saveDeep() {
+    }
+}
+exports.DbDoc = DbDoc;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRkYXRhLmNsYXNzZXMuZGJkb2MuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGRhdGEuY2xhc3Nlcy5kYmRvYy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBR0EsaURBQTZCLGtDQUU3QixDQUFDLENBRjhEO0FBSS9EO0lBR0ksWUFBWSxpQkFBeUIsRUFBRSxLQUFTO1FBQzVDLElBQUksQ0FBQyxVQUFVLEdBQUcsSUFBSSw2Q0FBWSxDQUFJLGlCQUFpQixFQUFFLEtBQUssQ0FBQyxDQUFBO0lBQ25FLENBQUM7SUFDRCxJQUFJO0lBRUosQ0FBQztJQUNELFFBQVE7SUFFUixDQUFDO0FBQ0wsQ0FBQztBQVpZLGFBQUssUUFZakIsQ0FBQSJ9

docs/index.md

@@ -0,0 +1,19 @@
+# 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)

package.json

@@ -1,11 +1,12 @@
 {
   "name": "smartdata",
-  "version": "1.0.1",
+  "version": "1.0.14",
   "description": "do more with data",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(npm run prepareMongo && npmts)",
+    "prepareMongo": "(rm -rf ./test/data && mkdir ./test/data/)"
   },
   "repository": {
     "type": "git",
@@ -21,6 +22,7 @@
     "@types/mongodb": "^2.1.32",
     "@types/q": "0.0.30",
     "beautylog": "^5.0.23",
+    "lik": "^1.0.15",
     "mongodb": "^2.2.9",
     "q": "^1.4.1",
     "typings-global": "^1.0.14"
@@ -30,6 +32,7 @@
     "@types/should": "^8.1.29",
     "shelljs": "^0.7.4",
     "should": "^11.1.0",
+    "smartstring": "^2.0.17",
     "typings-test": "^1.0.3"
   }
 }

test/test.js

@@ -1,30 +1,90 @@
 "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 testDbConnection;
+let testDb;
+let testDbCollection;
 describe('mongodb', function () {
     it('should start mongodb', function (done) {
-        mongoChildProcess = shelljs.exec('mongod --dbpath=./test/data --port 27017', { async: true });
-        setTimeout(() => { done(); }, 1500);
+        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) {
-        testDbConnection = new smartdata.DbConnection('mongodb://localhost:27017/smartdata');
-        testDbConnection.connect().then(() => { 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 () {
-        testDbConnection.close();
+        testDb.close();
+    });
+    it('should create an extended class', function () {
+        class TestCar extends smartdata.DbDoc {
+            constructor(optionsArg) {
+                super('testCar', testDb);
+            }
+        }
+        ;
+        let testCarInstance = new TestCar({
+            color: 'red',
+            property2: 2
+        });
+        should(testCarInstance).be.instanceof(smartdata.DbDoc);
+        testCarInstance.save();
+        it('should get a collection for testCar', function () {
+        });
     });
 });
 describe('mongodb', function () {
-    it('should kill 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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FDUCxDQUFDLENBRG9CO0FBQ3JCLE1BQVksT0FBTyxXQUFNLFNBQ3pCLENBQUMsQ0FEaUM7QUFFbEMsTUFBWSxTQUFTLFdBQU0sZUFHM0IsQ0FBQyxDQUh5QztBQUcxQyxJQUFJLGlCQUFpQixDQUFBO0FBQ3JCLElBQUksZ0JBQXdDLENBQUE7QUFHNUMsUUFBUSxDQUFDLFNBQVMsRUFBQztJQUNmLEVBQUUsQ0FBQyxzQkFBc0IsRUFBQyxVQUFTLElBQUk7UUFDbkMsaUJBQWlCLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQywwQ0FBMEMsRUFBQyxFQUFDLEtBQUssRUFBRSxJQUFJLEVBQUMsQ0FBQyxDQUFBO1FBQzFGLFVBQVUsQ0FBQyxRQUFRLElBQUksRUFBRSxDQUFBLENBQUMsQ0FBQyxFQUFFLElBQUksQ0FBQyxDQUFBO0lBQ3RDLENBQUMsQ0FBQyxDQUFBO0FBQ04sQ0FBQyxDQUFDLENBQUE7QUFDRixRQUFRLENBQUMsV0FBVyxFQUFDO0lBQ2pCLEVBQUUsQ0FBQywwQ0FBMEMsRUFBQyxVQUFTLElBQUk7UUFDdkQsZ0JBQWdCLEdBQUcsSUFBSSxTQUFTLENBQUMsWUFBWSxDQUFDLHFDQUFxQyxDQUFDLENBQUE7UUFDcEYsZ0JBQWdCLENBQUMsT0FBTyxFQUFFLENBQUMsSUFBSSxDQUFDLFFBQVEsSUFBSSxFQUFFLENBQUEsQ0FBQyxDQUFDLENBQUMsQ0FBQTtJQUNyRCxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyw0QkFBNEIsRUFBQztJQUVoQyxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyxnQ0FBZ0MsRUFBQztRQUNoQyxnQkFBZ0IsQ0FBQyxLQUFLLEVBQUUsQ0FBQTtJQUM1QixDQUFDLENBQUMsQ0FBQTtBQUNOLENBQUMsQ0FBQyxDQUFBO0FBRUYsUUFBUSxDQUFDLFNBQVMsRUFBQztJQUNmLEVBQUUsQ0FBQyxxQkFBcUIsRUFBQztRQUNyQixPQUFPLENBQUMsSUFBSSxDQUFDLHdDQUF3QyxDQUFDLENBQUE7UUFDdEQsaUJBQWlCLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFBO0lBQ3JDLENBQUMsQ0FBQyxDQUFBO0FBQ04sQ0FBQyxDQUFDLENBQUEifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FFUCxDQUFDLENBRm9CO0FBRXJCLE1BQVksT0FBTyxXQUFNLFNBQ3pCLENBQUMsQ0FEaUM7QUFDbEMsTUFBWSxNQUFNLFdBQU0sUUFDeEIsQ0FBQyxDQUQrQjtBQUNoQyxNQUFZLFdBQVcsV0FBTSxhQUc3QixDQUFDLENBSHlDO0FBRTFDLG9CQUFvQjtBQUNwQixNQUFZLFNBQVMsV0FBTSxlQUUzQixDQUFDLENBRnlDO0FBRTFDLElBQUksaUJBQWlCLENBQUE7QUFDckIsSUFBSSxNQUFvQixDQUFBO0FBUXhCLElBQUksZ0JBQXNELENBQUE7QUFJMUQsUUFBUSxDQUFDLFNBQVMsRUFBRTtJQUNoQixFQUFFLENBQUMsc0JBQXNCLEVBQUUsVUFBVSxJQUFJO1FBQ3JDLElBQUksQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLENBQUE7UUFDbkIsaUJBQWlCLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQywwQ0FBMEMsRUFBRSxFQUFFLEtBQUssRUFBRSxJQUFJLEVBQUUsTUFBTSxFQUFFLElBQUksRUFBRSxDQUFDLENBQUE7UUFDM0csSUFBSSxVQUFVLEdBQUcsS0FBSyxDQUFBO1FBQ3RCLGlCQUFpQixDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsTUFBTSxFQUFFLFVBQVUsSUFBSTtZQUM5QyxPQUFPLENBQUMsR0FBRyxDQUFDLFdBQVcsQ0FBQyxNQUFNLENBQUMsZ0JBQWdCLENBQUMsSUFBSSxFQUFFLDRCQUE0QixDQUFDLENBQUMsQ0FBQTtZQUNwRixFQUFFLENBQUMsQ0FBQyxDQUFDLFVBQVUsQ0FBQyxDQUFDLENBQUM7Z0JBQ2QsRUFBRSxDQUFDLENBQUMsdUNBQXVDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztvQkFDckQsVUFBVSxHQUFHLElBQUksQ0FBQTtvQkFDakIsSUFBSSxFQUFFLENBQUE7Z0JBQ1YsQ0FBQztZQUNMLENBQUM7UUFDTCxDQUFDLENBQUMsQ0FBQTtJQUNOLENBQUMsQ0FBQyxDQUFBO0FBQ04sQ0FBQyxDQUFDLENBQUE7QUFFRixRQUFRLENBQUMsV0FBVyxFQUFFO0lBQ2xCLEVBQUUsQ0FBQywwQ0FBMEMsRUFBRSxVQUFVLElBQUk7UUFDekQsTUFBTSxHQUFHLElBQUksU0FBUyxDQUFDLEVBQUUsQ0FBQyxxQ0FBcUMsQ0FBQyxDQUFBO1FBQ2hFLE1BQU0sQ0FBQyxPQUFPLEVBQUUsQ0FBQyxJQUFJLENBQUMsUUFBUSxJQUFJLEVBQUUsQ0FBQSxDQUFDLENBQUMsQ0FBQyxDQUFBO0lBQzNDLENBQUMsQ0FBQyxDQUFBO0lBQ0YsRUFBRSxDQUFDLDRCQUE0QixFQUFFO1FBQzdCLGdCQUFnQixHQUFHLElBQUksU0FBUyxDQUFDLFlBQVksQ0FBZSxXQUFXLEVBQUUsTUFBTSxDQUFDLENBQUE7SUFDcEYsQ0FBQyxDQUFDLENBQUE7SUFDRixFQUFFLENBQUMseUNBQXlDLEVBQUUsVUFBVSxJQUFJO1FBQ3hELGdCQUFnQixDQUFDLFNBQVMsQ0FBQyxFQUFFLE1BQU0sRUFBRSxNQUFNLEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxRQUFRLElBQUksRUFBRSxDQUFBLENBQUMsQ0FBQyxDQUFDLENBQUE7SUFDekUsQ0FBQyxDQUFDLENBQUE7SUFDRixFQUFFLENBQUMsMENBQTBDLEVBQUUsVUFBVSxJQUFJO1FBQ3pELGdCQUFnQixDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxXQUFXO1lBQ3ZDLE9BQU8sQ0FBQyxHQUFHLENBQUMsV0FBVyxDQUFDLENBQUE7WUFDeEIsTUFBTSxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxNQUFNLENBQUMsQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLENBQUE7WUFDM0MsSUFBSSxFQUFFLENBQUE7UUFDVixDQUFDLENBQUMsQ0FBQTtJQUNOLENBQUMsQ0FBQyxDQUFBO0lBQ0YsRUFBRSxDQUFDLDZDQUE2QyxFQUFFLFVBQVUsSUFBSTtRQUM1RCxnQkFBZ0IsQ0FBQyxVQUFVLENBQUM7WUFDeEIsRUFBRSxNQUFNLEVBQUUsT0FBTyxFQUFFO1lBQ25CLEVBQUUsTUFBTSxFQUFFLE1BQU0sRUFBRSxNQUFNLEVBQUUsQ0FBQyxFQUFFLE1BQU0sRUFBRSxJQUFJLEVBQUU7U0FDOUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxRQUFRLElBQUksRUFBRSxDQUFBLENBQUMsQ0FBQyxDQUFDLENBQUE7SUFDN0IsQ0FBQyxDQUFDLENBQUE7SUFDRixFQUFFLENBQUMsNkJBQTZCLEVBQUUsVUFBVSxJQUFJO1FBQzVDLGdCQUFnQixDQUFDLElBQUksQ0FBQyxFQUFFLFFBQVEsRUFBRSxFQUFFLFNBQVMsRUFBRSxJQUFJLEVBQUUsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsV0FBVztZQUN0RSxPQUFPLENBQUMsR0FBRyxDQUFDLFdBQVcsQ0FBQyxDQUFBO1lBQ3hCLE1BQU0sQ0FBQyxXQUFXLENBQUMsQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFBO1lBQ3pDLElBQUksRUFBRSxDQUFBO1FBQ1YsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsQ0FBQTtJQUN6QixDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyxnQ0FBZ0MsRUFBRTtRQUNqQyxNQUFNLENBQUMsS0FBSyxFQUFFLENBQUE7SUFDbEIsQ0FBQyxDQUFDLENBQUE7SUFDRixFQUFFLENBQUMsaUNBQWlDLEVBQUU7UUFDbEMsc0JBQXNCLFNBQVMsQ0FBQyxLQUFLO1lBRWpDLFlBQVksVUFHWDtnQkFDRyxNQUFNLFNBQVMsRUFBQyxNQUFNLENBQUMsQ0FBQTtZQUMzQixDQUFDO1FBQ0wsQ0FBQztRQUFBLENBQUM7UUFDRixJQUFJLGVBQWUsR0FBRyxJQUFJLE9BQU8sQ0FBQztZQUM5QixLQUFLLEVBQUUsS0FBSztZQUNaLFNBQVMsRUFBRSxDQUFDO1NBQ2YsQ0FBQyxDQUFBO1FBQ0YsTUFBTSxDQUFDLGVBQWUsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxVQUFVLENBQUMsU0FBUyxDQUFDLEtBQUssQ0FBQyxDQUFBO1FBQ3RELGVBQWUsQ0FBQyxJQUFJLEVBQUUsQ0FBQTtRQUN0QixFQUFFLENBQUMscUNBQXFDLEVBQUM7UUFDekMsQ0FBQyxDQUFDLENBQUE7SUFDTixDQUFDLENBQUMsQ0FBQTtBQUNOLENBQUMsQ0FBQyxDQUFBO0FBRUYsUUFBUSxDQUFDLFNBQVMsRUFBRTtJQUNoQixFQUFFLENBQUMscUJBQXFCLEVBQUUsVUFBVSxJQUFJO1FBQ3BDLElBQUksQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLENBQUE7UUFDbkIsaUJBQWlCLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQyxNQUFNLEVBQUUsVUFBVSxJQUFJO1lBQzlDLEVBQUUsQ0FBQyxDQUFDLGdCQUFnQixDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUM7Z0JBQzlCLElBQUksRUFBRSxDQUFBO1lBQ1YsQ0FBQztRQUNMLENBQUMsQ0FBQyxDQUFBO1FBQ0YsT0FBTyxDQUFDLElBQUksQ0FBQyx3Q0FBd0MsQ0FBQyxDQUFBO1FBQ3RELGlCQUFpQixDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsQ0FBQTtJQUNyQyxDQUFDLENBQUMsQ0FBQTtBQUNOLENBQUMsQ0FBQyxDQUFBIn0=

test/test.ts

@@ -1,34 +1,105 @@
 import 'typings-test'
+
 import * as shelljs from 'shelljs'
 import * as should from 'should'
+import * as smartstring from 'smartstring'
+
+// the tested module
 import * as smartdata from '../dist/index'
 
-
 let mongoChildProcess
-let testDbConnection: smartdata.DbConnection
+let testDb: smartdata.Db
+
+interface ITestObject1 {
+    value1: string
+    value2?: number
+    value3?: string
+}
+
+let testDbCollection: smartdata.DbCollection<ITestObject1>
+
 
 
 describe('mongodb', function () {
     it('should start mongodb', function (done) {
-        mongoChildProcess = shelljs.exec('mongod --dbpath=./test/data --port 27017',{async: true})
-        setTimeout(() => { done() }, 1500)
+        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) {
-        testDbConnection = new smartdata.DbConnection('mongodb://localhost:27017/smartdata')
-        testDbConnection.connect().then(() => { 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 () {
-        testDbConnection.close()
+        testDb.close()
+    })
+    it('should create an extended class', function () {
+        class TestCar extends smartdata.DbDoc<TestCar> {
+            color: string
+            constructor(optionsArg: {
+                color: string,
+                property2: number
+            }) {
+                super('testCar',testDb)
+            }
+        };
+        let testCarInstance = new TestCar({
+            color: 'red',
+            property2: 2
+        })
+        should(testCarInstance).be.instanceof(smartdata.DbDoc)
+        testCarInstance.save()
+        it('should get a collection for testCar',function() {
+        })
     })
 })
 
 describe('mongodb', function () {
-    it('should kill 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')
     })

ts/index.ts

@@ -1,39 +1,5 @@
 import * as plugins from './smartdata.plugins'
 
-export class DbCollection<T> {
-    constructor(nameArg: string, db: plugins.mongodb.Db) {
-        let collection = db.collection(nameArg)
-    }
-}
-
-export type TDbConnectionStatus = 'disconnected' | 'connected' | 'failed'
-
-export class DbConnection {
-    dbUrl: string
-    db: plugins.mongodb.Db
-    status: TDbConnectionStatus
-
-    constructor(dbUrl: string) {
-        this.dbUrl = dbUrl
-    }
-
-    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
-    }
-
-    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
-    }
-}
+export * from './smartdata.classes.db'
+export * from './smartdata.classes.dbcollection'
+export * from './smartdata.classes.dbdoc'

ts/smartdata.classes.db.ts

@@ -0,0 +1,61 @@
+import * as plugins from './smartdata.plugins'
+import { Objectmap } from 'lik'
+
+import { DbCollection } from './smartdata.classes.dbcollection'
+
+export type TConnectionStatus = 'disconnected' | 'connected' | 'failed'
+
+export class Db {
+    dbUrl: string
+    db: plugins.mongodb.Db
+    status: TConnectionStatus
+    collections = new Objectmap<DbCollection<any>>()
+
+    constructor(dbUrl: string) {
+        this.dbUrl = dbUrl
+    }
+
+    // basic connection stuff ----------------------------------------------
+
+    /**
+     * connects to the database that was specified during instance creation
+     */
+    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
+    }
+
+    /**
+     * closes the connection to the databse
+     */
+    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
+    }
+
+    // advanced communication with the database --------------------------------
+
+    /**
+     * gets a collection by name: string
+     */
+    getCollectionByName<T>(nameArg: string): plugins.q.Promise<DbCollection<T>> {
+        let done = plugins.q.defer<DbCollection<any>>()
+        let resultCollection = this.collections.find((dbCollectionArg) => {
+            return dbCollectionArg.name === nameArg
+        })
+        if (resultCollection !== null) {
+            done.resolve(resultCollection)
+        }
+        return done.promise
+    };
+}

ts/smartdata.classes.dbcollection.ts

@@ -0,0 +1,70 @@
+import * as plugins from './smartdata.plugins'
+import { Db } from './smartdata.classes.db'
+
+export interface IFindOptions {
+    limit?: number
+}
+
+export class DbCollection<T> {
+    collection: plugins.mongodb.Collection
+    name: string
+    constructor(nameArg: string, dbArg: Db) {
+        this.name = nameArg
+        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, optionsArg?: IFindOptions): plugins.q.Promise<T[]> {
+        let done = plugins.q.defer<T[]>()
+        let findCursor = this.collection.find(docMatchArg)
+        if (optionsArg) {
+            if ( optionsArg.limit ) { findCursor = findCursor.limit(1) }
+        }
+        findCursor.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.dbdoc.ts

@@ -0,0 +1,20 @@
+import * as plugins from './smartdata.plugins'
+
+import { Db } from './smartdata.classes.db'
+import { DbCollection } from './smartdata.classes.dbcollection'
+
+export type TDocCreation = 'db' | 'data' | 'mixed'
+
+export class DbDoc<T> {
+    collection: DbCollection<T>
+    creationType: TDocCreation
+    constructor(collectionNameArg: string, dbArg: Db ) {
+        this.collection = new DbCollection<T>(collectionNameArg, dbArg)
+    }
+    save() {
+
+    }
+    saveDeep() {
+        
+    }
+}