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 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
@@ -47,11 +63,11 @@ So to get to get access to a specific collection you document
 
 @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()
     }

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "smartdata",
-  "version": "1.0.17",
+  "version": "1.0.22",
   "description": "do more with data",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

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,6 +86,8 @@ 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)

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']
     }
+
+    /**
+     * 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)
+        }
     }
-    saveDeep() {
 
+    /**
+     * also store any referenced objects to DB
+     * better for data consistency
+     */
+    saveDeep() {
+        this.save()
     }
 }

tsconfig.json

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