1.0.22

README.md

@@ -2,12 +2,28 @@
 
 > Note: Still in Beta
 
+## Availabililty
+[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartdata)
+[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/smartdata)
+[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartdata)
+[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartdata/)
+
+## Status for master
+[![build status](https://gitlab.com/pushrocks/smartdata/badges/master/build.svg)](https://gitlab.com/pushrocks/smartdata/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smartdata/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartdata/commits/master)
+[![Dependency Status](https://david-dm.org/pushrocks/smartdata.svg)](https://david-dm.org/pushrocks/smartdata)
+[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartdata/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartdata/master/dependencies/npm)
+[![bitHound Code](https://www.bithound.io/github/pushrocks/smartdata/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartdata)
+[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
+
 smartdata is an ODM that adheres to TypeScript practices and uses classes to organize data.
-It uses MongoDB as persistent storage.
+It uses MongoDB or NeDb 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.
+acts smart while still embracing the NoSQL idea we didn't find a matching solution.
 This is why we started smartdata.
 
 How MongoDB terms map to smartdata classes
@@ -21,12 +37,16 @@ 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
+```javascript
 import * as smartdata from 'smartdata'
 
+// mongodb
 let myDb1 = new smartdata.Db('someConnectionUrl')
 let myDb2 = new smartdata.Db('someConnectionUrl')
 
+// nedb
+let myDb3 = new smartdata('/some/path/for/persistence', 'nedb') // you may set first argument to null for just in memory db
+
 myDb1.connect()
 myDb2.connect()
 
@@ -38,21 +58,23 @@ 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
+```javascript
 // continues from the block before...
 
 @Collection(myDb1)
 class myObject extends smartdata.DbDoc<myObject> { // read the next block about DbDoc
-    property1:string
-    property2:number
+    @smartdata.svDb() property1: string // @smartdata.svDb() marks the property for db save
+    property2: number // this one is not marked, so it won't be save upon calling this.save() 
     constructor(optionsArg:{
-        property1:string,
-        property2:number
+        property1: string,
+        property2: number
     }) {
         super()
     }
 }
 let myCollection = myDb1.getCollectionByName<myObject>(myObject)
+
+// start to instantiate classes from scratch or database
 ``` 
 
 > Alert: You NEVER instantiate a collection.

dist/smartdata.classes.db.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="nedb" />
 /// <reference types="q" />
 import * as plugins from './smartdata.plugins';
 import { Objectmap } from 'lik';
@@ -14,7 +13,7 @@ export declare type TConnectionStatus = 'disconnected' | 'connected' | 'failed';
 export declare class Db {
     dbType: TDbType;
     dbUrl: string;
-    db: plugins.mongodb.Db | plugins.nedb;
+    db: plugins.mongodb.Db;
     status: TConnectionStatus;
     collections: Objectmap<DbCollection<any>>;
     constructor(dbUrlArg: string, dbTypeArg?: TDbType);

dist/smartdata.classes.db.js

@@ -25,7 +25,7 @@ class Db {
             });
         }
         else if (this.dbType === 'nedb') {
-            this.db = new plugins.nedb();
+            this.db = null;
         }
         return done.promise;
     }
@@ -34,7 +34,9 @@ class Db {
      */
     close() {
         let done = plugins.q.defer();
-        this.db.close();
+        if (this.dbType === 'mongodb') {
+            this.db.close();
+        }
         plugins.beautylog.ok(`disconnected to database at ${this.dbUrl}`);
         done.resolve();
         return done.promise;
@@ -59,4 +61,4 @@ class Db {
     }
 }
 exports.Db = Db;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRkYXRhLmNsYXNzZXMuZGIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGRhdGEuY2xhc3Nlcy5kYi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsK0NBQThDO0FBQzlDLDZCQUErQjtBQWMvQjtJQU9JLFlBQVksUUFBZ0IsRUFBRSxZQUFxQixTQUFTO1FBRjVELGdCQUFXLEdBQUcsSUFBSSxlQUFTLEVBQXFCLENBQUE7UUFHNUMsSUFBSSxDQUFDLE1BQU0sR0FBRyxTQUFTLENBQUE7UUFDdkIsSUFBSSxDQUFDLEtBQUssR0FBRyxRQUFRLENBQUE7SUFDekIsQ0FBQztJQUVELHdFQUF3RTtJQUV4RTs7T0FFRztJQUNILE9BQU87UUFDSCxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFBO1FBQzVCLEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxNQUFNLEtBQUssU0FBUyxDQUFDLENBQUMsQ0FBQztZQUM1QixPQUFPLENBQUMsT0FBTyxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDLEdBQUcsRUFBRSxFQUFFO2dCQUNwRCxFQUFFLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDO29CQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLENBQUE7Z0JBQUMsQ0FBQztnQkFDN0IsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFBO2dCQUMvQixJQUFJLENBQUMsRUFBRSxHQUFHLEVBQUUsQ0FBQTtnQkFDWixPQUFPLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyw0QkFBNEIsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDLENBQUE7Z0JBQ25FLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFBO1lBQ3pCLENBQUMsQ0FBQyxDQUFBO1FBQ04sQ0FBQztRQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsTUFBTSxLQUFLLE1BQU0sQ0FBQyxDQUFDLENBQUM7WUFDaEMsSUFBSSxDQUFDLEVBQUUsR0FBRyxJQUFJLE9BQU8sQ0FBQyxJQUFJLEVBQUUsQ0FBQTtRQUNoQyxDQUFDO1FBQ0QsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUE7SUFDdkIsQ0FBQztJQUVEOztPQUVHO0lBQ0gsS0FBSztRQUNELElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUE7UUFDNUIsSUFBSSxDQUFDLEVBQUUsQ0FBQyxLQUFLLEVBQUUsQ0FBQTtRQUNmLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLCtCQUErQixJQUFJLENBQUMsS0FBSyxFQUFFLENBQUMsQ0FBQTtRQUNqRSxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUE7UUFDZCxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQTtJQUN2QixDQUFDO0lBRUQsNEVBQTRFO0lBRTVFOztPQUVHO0lBQ0gsbUJBQW1CLENBQUksT0FBZTtRQUNsQyxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBcUIsQ0FBQTtRQUMvQyxJQUFJLGdCQUFnQixHQUFHLElBQUksQ0FBQyxXQUFXLENBQUMsSUFBSSxDQUFDLENBQUMsZUFBZTtZQUN6RCxNQUFNLENBQUMsZUFBZSxDQUFDLElBQUksS0FBSyxPQUFPLENBQUE7UUFDM0MsQ0FBQyxDQUFDLENBQUE7UUFDRixFQUFFLENBQUMsQ0FBQyxnQkFBZ0IsS0FBSyxJQUFJLENBQUMsQ0FBQyxDQUFDO1lBQzVCLElBQUksQ0FBQyxPQUFPLENBQUMsZ0JBQWdCLENBQUMsQ0FBQTtRQUNsQyxDQUFDO1FBQ0QsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUE7SUFDdkIsQ0FBQztJQUFBLENBQUM7SUFFRixhQUFhLENBQUMsZUFBa0M7UUFDNUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxHQUFHLENBQUMsZUFBZSxDQUFDLENBQUE7SUFDekMsQ0FBQztDQUNKO0FBL0RELGdCQStEQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRkYXRhLmNsYXNzZXMuZGIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGRhdGEuY2xhc3Nlcy5kYi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsK0NBQThDO0FBQzlDLDZCQUErQjtBQWMvQjtJQU9JLFlBQVksUUFBZ0IsRUFBRSxZQUFxQixTQUFTO1FBRjVELGdCQUFXLEdBQUcsSUFBSSxlQUFTLEVBQXFCLENBQUE7UUFHNUMsSUFBSSxDQUFDLE1BQU0sR0FBRyxTQUFTLENBQUE7UUFDdkIsSUFBSSxDQUFDLEtBQUssR0FBRyxRQUFRLENBQUE7SUFDekIsQ0FBQztJQUVELHdFQUF3RTtJQUV4RTs7T0FFRztJQUNILE9BQU87UUFDSCxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFBO1FBQzVCLEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxNQUFNLEtBQUssU0FBUyxDQUFDLENBQUMsQ0FBQztZQUM1QixPQUFPLENBQUMsT0FBTyxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDLEdBQUcsRUFBRSxFQUFFO2dCQUNwRCxFQUFFLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDO29CQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLENBQUE7Z0JBQUMsQ0FBQztnQkFDN0IsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFBO2dCQUMvQixJQUFJLENBQUMsRUFBRSxHQUFHLEVBQUUsQ0FBQTtnQkFDWixPQUFPLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyw0QkFBNEIsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDLENBQUE7Z0JBQ25FLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFBO1lBQ3pCLENBQUMsQ0FBQyxDQUFBO1FBQ04sQ0FBQztRQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsTUFBTSxLQUFLLE1BQU0sQ0FBQyxDQUFDLENBQUM7WUFDaEMsSUFBSSxDQUFDLEVBQUUsR0FBRyxJQUFJLENBQUE7UUFDbEIsQ0FBQztRQUNELE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFBO0lBQ3ZCLENBQUM7SUFFRDs7T0FFRztJQUNILEtBQUs7UUFDRCxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFBO1FBQzVCLEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxNQUFNLEtBQUssU0FBUyxDQUFDLENBQUMsQ0FBQztZQUM1QixJQUFJLENBQUMsRUFBRSxDQUFDLEtBQUssRUFBRSxDQUFBO1FBQ25CLENBQUM7UUFDRCxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQywrQkFBK0IsSUFBSSxDQUFDLEtBQUssRUFBRSxDQUFDLENBQUE7UUFDakUsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFBO1FBQ2QsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUE7SUFDdkIsQ0FBQztJQUVELDRFQUE0RTtJQUU1RTs7T0FFRztJQUNILG1CQUFtQixDQUFJLE9BQWU7UUFDbEMsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQXFCLENBQUE7UUFDL0MsSUFBSSxnQkFBZ0IsR0FBRyxJQUFJLENBQUMsV0FBVyxDQUFDLElBQUksQ0FBQyxDQUFDLGVBQWU7WUFDekQsTUFBTSxDQUFDLGVBQWUsQ0FBQyxJQUFJLEtBQUssT0FBTyxDQUFBO1FBQzNDLENBQUMsQ0FBQyxDQUFBO1FBQ0YsRUFBRSxDQUFDLENBQUMsZ0JBQWdCLEtBQUssSUFBSSxDQUFDLENBQUMsQ0FBQztZQUM1QixJQUFJLENBQUMsT0FBTyxDQUFDLGdCQUFnQixDQUFDLENBQUE7UUFDbEMsQ0FBQztRQUNELE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFBO0lBQ3ZCLENBQUM7SUFBQSxDQUFDO0lBRUYsYUFBYSxDQUFDLGVBQWtDO1FBQzVDLElBQUksQ0FBQyxXQUFXLENBQUMsR0FBRyxDQUFDLGVBQWUsQ0FBQyxDQUFBO0lBQ3pDLENBQUM7Q0FFSjtBQWxFRCxnQkFrRUMifQ==

dist/smartdata.classes.dbcollection.d.ts

@@ -4,29 +4,38 @@ import { Db } from './smartdata.classes.db';
 export interface IFindOptions {
     limit?: number;
 }
+export interface IDocValidation<T> {
+    (doc: T): boolean;
+}
 export declare function Collection(db: Db): (constructor: any) => void;
 export declare class DbCollection<T> {
     /**
-     * the collection that is used
+     * the collection that is used, defaults to mongodb collection,
+     * can be nedb datastore (sub api of mongodb)
      */
     collection: plugins.mongodb.Collection;
     name: string;
+    db: Db;
+    objectValidation: IDocValidation<T>;
     constructor(nameArg: string, dbArg: Db);
     /**
      * adds a validation function that all newly inserted and updated objects have to pass
      */
-    addObjectValidation(funcArg: any): void;
+    addDocValidation(funcArg: IDocValidation<T>): void;
     /**
      * finds an object in the DbCollection
      */
     find(docMatchArg: T | any, optionsArg?: IFindOptions): plugins.q.Promise<T[]>;
     /**
-     * inserts  object into the DbCollection
+     * 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);
+    /**
+     * checks a Doc for constraints
+     */
+    private checkDoc(docArg);
 }

dist/smartdata.classes.dbdoc.d.ts

@@ -1,9 +1,34 @@
 import { DbCollection } from './smartdata.classes.dbcollection';
-export declare type TDocCreation = 'db' | 'data' | 'mixed';
+export declare type TDocCreation = 'db' | 'new' | 'mixed';
+/**
+ * saveable - saveable decorator to be used on class properties
+ */
+export declare function svDb(): (target: DbDoc<any>, key: string) => void;
 export declare class DbDoc<T> {
+    /**
+     * the collection object an Doc belongs to
+     */
     collection: DbCollection<T>;
+    /**
+     * how the Doc in memory was created, may prove useful later.
+     */
     creationType: TDocCreation;
+    /**
+     * an array of saveable properties of a doc
+     */
+    saveableProperties: string[];
+    /**
+     * class constructor
+     */
     constructor();
+    /**
+     * saves this instance but not any connected items
+     * may lead to data inconsistencies, but is faster
+     */
     save(): void;
+    /**
+     * also store any referenced objects to DB
+     * better for data consistency
+     */
     saveDeep(): void;
 }

dist/smartdata.classes.dbdoc.js

@@ -1,12 +1,48 @@
 "use strict";
+/**
+ * saveable - saveable decorator to be used on class properties
+ */
+function svDb() {
+    return (target, key) => {
+        console.log('called sva');
+        if (!target.saveableProperties) {
+            target.saveableProperties = [];
+        }
+        target.saveableProperties.push(key);
+    };
+}
+exports.svDb = svDb;
 class DbDoc {
+    /**
+     * class constructor
+     */
     constructor() {
         this.collection = this.constructor['dbCollection'];
     }
+    /**
+     * saves this instance but not any connected items
+     * may lead to data inconsistencies, but is faster
+     */
     save() {
+        let saveableObject = {};
+        for (let propertyNameString of this.saveableProperties) {
+            saveableObject[propertyNameString] = this[propertyNameString];
+        }
+        switch (this.creationType) {
+            case 'db':
+                this.collection; // TODO implement collection.update()
+                break;
+            case 'new':
+                this.collection.insertOne(saveableObject);
+        }
     }
+    /**
+     * also store any referenced objects to DB
+     * better for data consistency
+     */
     saveDeep() {
+        this.save();
     }
 }
 exports.DbDoc = DbDoc;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRkYXRhLmNsYXNzZXMuZGJkb2MuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGRhdGEuY2xhc3Nlcy5kYmRvYy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBUUE7SUFHSTtRQUNJLElBQUksQ0FBQyxVQUFVLEdBQUcsSUFBSSxDQUFDLFdBQVcsQ0FBQyxjQUFjLENBQUMsQ0FBQTtJQUN0RCxDQUFDO0lBQ0QsSUFBSTtJQUVKLENBQUM7SUFDRCxRQUFRO0lBRVIsQ0FBQztDQUNKO0FBWkQsc0JBWUMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRkYXRhLmNsYXNzZXMuZGJkb2MuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGRhdGEuY2xhc3Nlcy5kYmRvYy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBT0E7O0dBRUc7QUFDSDtJQUNJLE1BQU0sQ0FBQyxDQUFDLE1BQWtCLEVBQUUsR0FBVztRQUNuQyxPQUFPLENBQUMsR0FBRyxDQUFDLFlBQVksQ0FBQyxDQUFBO1FBQ3pCLEVBQUUsQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLGtCQUFrQixDQUFDLENBQUMsQ0FBQztZQUFDLE1BQU0sQ0FBQyxrQkFBa0IsR0FBRyxFQUFFLENBQUE7UUFBQyxDQUFDO1FBQ2xFLE1BQU0sQ0FBQyxrQkFBa0IsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUE7SUFDdkMsQ0FBQyxDQUFBO0FBQ0wsQ0FBQztBQU5ELG9CQU1DO0FBRUQ7SUFpQkk7O09BRUc7SUFDSDtRQUNJLElBQUksQ0FBQyxVQUFVLEdBQUcsSUFBSSxDQUFDLFdBQVcsQ0FBQyxjQUFjLENBQUMsQ0FBQTtJQUN0RCxDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsSUFBSTtRQUNBLElBQUksY0FBYyxHQUFHLEVBQUUsQ0FBQTtRQUN2QixHQUFHLENBQUMsQ0FBQyxJQUFJLGtCQUFrQixJQUFJLElBQUksQ0FBQyxrQkFBa0IsQ0FBQyxDQUFDLENBQUM7WUFDckQsY0FBYyxDQUFDLGtCQUFrQixDQUFDLEdBQUcsSUFBSSxDQUFDLGtCQUFrQixDQUFDLENBQUE7UUFDakUsQ0FBQztRQUNELE1BQU0sQ0FBQyxDQUFDLElBQUksQ0FBQyxZQUFZLENBQUMsQ0FBQyxDQUFDO1lBQ3hCLEtBQUssSUFBSTtnQkFDTCxJQUFJLENBQUMsVUFBVSxDQUFBLENBQUMscUNBQXFDO2dCQUNyRCxLQUFLLENBQUE7WUFDVCxLQUFLLEtBQUs7Z0JBQ04sSUFBSSxDQUFDLFVBQVUsQ0FBQyxTQUFTLENBQUMsY0FBYyxDQUFDLENBQUE7UUFDakQsQ0FBQztJQUNMLENBQUM7SUFFRDs7O09BR0c7SUFDSCxRQUFRO1FBQ0osSUFBSSxDQUFDLElBQUksRUFBRSxDQUFBO0lBQ2YsQ0FBQztDQUNKO0FBakRELHNCQWlEQyJ9

dist/smartdata.plugins.d.ts

@@ -1,6 +1,8 @@
 import 'typings-global';
-export import assert = require('assert');
-export import beautylog = require('beautylog');
-export import mongodb = require('mongodb');
-export import q = require('q');
-export import nedb = require('nedb');
+import * as assert from 'assert';
+import * as beautylog from 'beautylog';
+import * as lodash from 'lodash';
+import * as mongodb from 'mongodb';
+import * as q from 'q';
+declare let nedb: any;
+export { assert, beautylog, lodash, mongodb, q, nedb };

dist/smartdata.plugins.js

@@ -1,8 +1,15 @@
 "use strict";
 require("typings-global");
-exports.assert = require("assert");
-exports.beautylog = require("beautylog");
-exports.mongodb = require("mongodb");
-exports.q = require("q");
-exports.nedb = require("nedb");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRkYXRhLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGRhdGEucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLG1DQUF3QztBQUN4Qyx5Q0FBOEM7QUFDOUMscUNBQTBDO0FBQzFDLHlCQUE4QjtBQUM5QiwrQkFBb0MifQ==
+const assert = require("assert");
+exports.assert = assert;
+const beautylog = require("beautylog");
+exports.beautylog = beautylog;
+const lodash = require("lodash");
+exports.lodash = lodash;
+const mongodb = require("mongodb");
+exports.mongodb = mongodb;
+const q = require("q");
+exports.q = q;
+let nedb = require('nedb');
+exports.nedb = nedb;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRkYXRhLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGRhdGEucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLGlDQUFnQztBQVE1Qix3QkFBTTtBQVBWLHVDQUFzQztBQVFsQyw4QkFBUztBQVBiLGlDQUFnQztBQVE1Qix3QkFBTTtBQVBWLG1DQUFrQztBQVE5QiwwQkFBTztBQVBYLHVCQUFzQjtBQVFsQixjQUFDO0FBUEwsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFBO0FBUXRCLG9CQUFJIn0=

package.json

@@ -1,6 +1,6 @@
 {
   "name": "smartdata",
-  "version": "1.0.16",
+  "version": "1.0.22",
   "description": "do more with data",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -19,11 +19,13 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartdata#README",
   "dependencies": {
+    "@types/lodash": "^4.14.39",
     "@types/mongodb": "^2.1.34",
     "@types/nedb": "0.0.31",
     "@types/q": "0.0.32",
     "beautylog": "^6.0.0",
     "lik": "^1.0.24",
+    "lodash": "^4.17.2",
     "mongodb": "^2.2.11",
     "nedb": "^1.8.0",
     "q": "^1.4.1",

test/test.ts

@@ -72,6 +72,7 @@ describe('smartdata', function () {
     it('should create an extended class', function () {
         @smartdata.Collection(testDb)
         class TestCar extends smartdata.DbDoc<TestCar> {
+            @smartdata.svDb()
             color: string
             constructor(optionsArg: {
                 color: string,
@@ -85,11 +86,13 @@ describe('smartdata', function () {
             color: 'red',
             property2: 2
         })
+
+        should(testCarInstance.saveableProperties[0]).equal('color')
         console.log(TestCar)
         should(testCarInstance.collection).be.instanceof(smartdata.DbCollection)
         should(testCarInstance).be.instanceof(smartdata.DbDoc)
         testCarInstance.save()
-        it('should get a collection for testCar',function() {
+        it('should get a collection for testCar', function () {
 
         })
     })
@@ -107,3 +110,24 @@ describe('mongodb', function () {
         mongoChildProcess.kill('SIGTERM')
     })
 })
+
+describe('smartdata with nedb', function () {
+    let testDb: smartdata.Db
+    let testCollection: smartdata.DbCollection<ITestObject1>
+    it('should create a DB with nedb', function () {
+        testDb = new smartdata.Db('any', 'nedb')
+        testDb.connect()
+        testCollection = new smartdata.DbCollection<ITestObject1>('anyName', testDb)
+    })
+
+    it('should insert a doc', function(done){
+        testCollection.insertOne({ value1: 'hi' }).then(() => {done()})
+    })
+
+    it('should find the inserted document', function(done){
+        testCollection.find({ value1: 'hi' }).then(x => {
+            console.log(x)
+            done()
+        })
+    })
+})

ts/smartdata.classes.db.ts

@@ -16,7 +16,7 @@ export type TConnectionStatus = 'disconnected' | 'connected' | 'failed'
 export class Db {
     dbType: TDbType
     dbUrl: string
-    db: plugins.mongodb.Db | plugins.nedb
+    db: plugins.mongodb.Db
     status: TConnectionStatus
     collections = new Objectmap<DbCollection<any>>()
 
@@ -41,7 +41,7 @@ export class Db {
                 done.resolve(this.db)
             })
         } else if (this.dbType === 'nedb') {
-            this.db = new plugins.nedb()
+            this.db = null
         }
         return done.promise
     }
@@ -51,7 +51,9 @@ export class Db {
      */
     close(): plugins.q.Promise<any> {
         let done = plugins.q.defer()
-        this.db.close()
+        if (this.dbType === 'mongodb') {
+            this.db.close()
+        }
         plugins.beautylog.ok(`disconnected to database at ${this.dbUrl}`)
         done.resolve()
         return done.promise
@@ -76,4 +78,5 @@ export class Db {
     addCollection(dbCollectionArg: DbCollection<any>) {
         this.collections.add(dbCollectionArg)
     }
+    
 }

ts/smartdata.classes.dbcollection.ts

@@ -5,53 +5,96 @@ export interface IFindOptions {
     limit?: number
 }
 
+export interface IDocValidation<T> {
+    (doc: T): boolean
+}
+
 export function Collection(db: Db) {
-    return function(constructor){
+    return function (constructor) {
         constructor['dbCollection'] = new DbCollection(constructor.name, db)
     }
 }
 
 export class DbCollection<T> {
     /**
-     * the collection that is used
+     * the collection that is used, defaults to mongodb collection,
+     * can be nedb datastore (sub api of mongodb)
      */
     collection: plugins.mongodb.Collection
     name: string
+    db: Db
+    objectValidation: IDocValidation<T> = null
+
+
     constructor(nameArg: string, dbArg: Db) {
         this.name = nameArg
-        this.collection = dbArg.db.collection(nameArg)
+        this.db = dbArg
+        if (this.db.dbType === 'mongodb') {
+            this.collection = dbArg.db.collection(nameArg)
+        } else {
+            this.collection = new plugins.nedb()
+        }
     }
 
     /**
      * adds a validation function that all newly inserted and updated objects have to pass
      */
-    addObjectValidation(funcArg) { }
+    addDocValidation(funcArg: IDocValidation<T>) {
+        this.objectValidation = 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) }
+        if (this.db.dbType === 'mongodb') {
+            let findCursor = this.collection.find(docMatchArg)
+            if (optionsArg) {
+                if (optionsArg.limit) { findCursor = findCursor.limit(1) }
+            }
+            findCursor.toArray((err, docs) => {
+                if (err) {
+                    done.reject(err)
+                    throw err
+                }
+                done.resolve(docs)
+            })
+        } else if (this.db.dbType === 'nedb') {
+            this.collection.find(docMatchArg, (err, docs) => {
+                if (err) {
+                    done.reject(err)
+                    throw err
+                }
+                done.resolve(docs)
+            })
         }
-        findCursor.toArray((err, docs) => {
-            if (err) { throw err }
-            done.resolve(docs)
-        })
         return done.promise
     }
 
     /**
-     * inserts  object into the DbCollection
+     * 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() })
-        })
+        this.checkDoc(docArg).then(
+            () => {
+                if (this.db.dbType === 'mongodb') {
+                    this.collection.insertOne(docArg)
+                        .then(() => { done.resolve() })
+                } else if (this.db.dbType === 'nedb') {
+                    this.collection.insert(docArg, (err, newDoc) => {
+                        if (err) {
+                            done.reject(err)
+                            throw err
+                        }
+                        done.resolve()
+                    })
+                }
+            },
+            () => {
+                done.reject(new Error('one the docs did not pass validation'))
+            })
         return done.promise
     }
 
@@ -61,19 +104,41 @@ export class DbCollection<T> {
     insertMany(docArrayArg: T[]): plugins.q.Promise<void> {
         let done = plugins.q.defer<void>()
         let checkDocPromiseArray: plugins.q.Promise<void>[] = []
-        for (let docArg of docArrayArg){
+        for (let docArg of docArrayArg) {
             checkDocPromiseArray.push(this.checkDoc(docArg))
         }
         plugins.q.all(checkDocPromiseArray).then(() => {
-            this.collection.insertMany(docArrayArg)
-                .then(() => { done.resolve() })
+            if (this.db.dbType === 'mongodb') {
+                this.collection.insertMany(docArrayArg)
+                    .then(() => { done.resolve() })
+            } else if (this.db.dbType === 'nedb') {
+                let paramArray = plugins.lodash.concat<any>(docArrayArg, (err, newDoc) => {
+                    if (err) {
+                        done.reject(err)
+                        throw err
+                    }
+                    done.resolve()
+                })
+                this.collection.insert.apply(null, paramArray)
+            }
         })
         return done.promise
     }
 
-    private checkDoc(doc: T): plugins.q.Promise<void> {
+    /**
+     * checks a Doc for constraints
+     */
+    private checkDoc(docArg: T): plugins.q.Promise<void> {
         let done = plugins.q.defer<void>()
-        done.resolve()
+        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.dbdoc.ts

@@ -3,19 +3,66 @@ 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 type TDocCreation = 'db' | 'new' | 'mixed'
 
+/**
+ * saveable - saveable decorator to be used on class properties
+ */
+export function svDb() {
+    return (target: DbDoc<any>, key: string) => {
+        console.log('called sva')
+        if (!target.saveableProperties) { target.saveableProperties = [] }
+        target.saveableProperties.push(key)
+    }
+}
 
 export class DbDoc<T> {
+
+    /**
+     * the collection object an Doc belongs to
+     */
     collection: DbCollection<T>
+
+    /**
+     * how the Doc in memory was created, may prove useful later.
+     */
     creationType: TDocCreation
+
+    /**
+     * an array of saveable properties of a doc
+     */
+    saveableProperties: string[]
+
+    /**
+     * class constructor
+     */
     constructor() {
         this.collection = this.constructor['dbCollection']
     }
-    save() {
-        
-    }
-    saveDeep() {
 
+    /**
+     * saves this instance but not any connected items
+     * may lead to data inconsistencies, but is faster
+     */
+    save() {
+        let saveableObject = {}
+        for (let propertyNameString of this.saveableProperties) {
+            saveableObject[propertyNameString] = this[propertyNameString]
+        }
+        switch (this.creationType) {
+            case 'db':
+                this.collection // TODO implement collection.update()
+                break
+            case 'new':
+                this.collection.insertOne(saveableObject)
+        }
+    }
+
+    /**
+     * also store any referenced objects to DB
+     * better for data consistency
+     */
+    saveDeep() {
+        this.save()
     }
 }

ts/smartdata.plugins.ts

@@ -1,6 +1,16 @@
 import 'typings-global'
-export import assert = require('assert')
-export import beautylog = require('beautylog')
-export import mongodb = require('mongodb')
-export import q = require('q')
-export import nedb = require('nedb')
+import * as assert from 'assert'
+import * as beautylog from 'beautylog'
+import * as lodash from 'lodash'
+import * as mongodb from 'mongodb'
+import * as q from 'q'
+let nedb = require('nedb')
+
+export {
+    assert,
+    beautylog,
+    lodash,
+    mongodb,
+    q,
+    nedb
+}

tsconfig.json

@@ -0,0 +1,5 @@
+{
+    "compilerOptions": {
+        "experimentalDecorators": true
+    }
+}