1.0.19

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

dist/smartdata.classes.dbdoc.d.ts

@@ -1,9 +1,34 @@
 import { DbCollection } from './smartdata.classes.dbcollection';
 export declare type TDocCreation = 'db' | 'data' | 'mixed';
+/**
+ * sva - saveable decorator to be used on class properties
+ */
+export declare function saveable(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,39 @@
 "use strict";
+/**
+ * sva - saveable decorator to be used on class properties
+ */
+function saveable(target, key) {
+    console.log('called sva');
+    if (!target.saveableProperties) {
+        target.saveableProperties = [];
+    }
+    target.saveableProperties.push(key);
+}
+exports.saveable = saveable;
 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];
         }
+    }
+    /**
+     * 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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRkYXRhLmNsYXNzZXMuZGJkb2MuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydGRhdGEuY2xhc3Nlcy5kYmRvYy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBT0E7O0dBRUc7QUFDSCxrQkFBeUIsTUFBa0IsRUFBRSxHQUFXO0lBQ3BELE9BQU8sQ0FBQyxHQUFHLENBQUMsWUFBWSxDQUFDLENBQUE7SUFDekIsRUFBRSxDQUFDLENBQUMsQ0FBQyxNQUFNLENBQUMsa0JBQWtCLENBQUMsQ0FBQyxDQUFDO1FBQUMsTUFBTSxDQUFDLGtCQUFrQixHQUFHLEVBQUUsQ0FBQTtJQUFDLENBQUM7SUFDbEUsTUFBTSxDQUFDLGtCQUFrQixDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQTtBQUN2QyxDQUFDO0FBSkQsNEJBSUM7QUFFRDtJQWlCSTs7T0FFRztJQUNIO1FBQ0ksSUFBSSxDQUFDLFVBQVUsR0FBRyxJQUFJLENBQUMsV0FBVyxDQUFDLGNBQWMsQ0FBQyxDQUFBO0lBQ3RELENBQUM7SUFFRDs7O09BR0c7SUFDSCxJQUFJO1FBQ0EsSUFBSSxjQUFjLEdBQUcsRUFBRSxDQUFBO1FBQ3ZCLEdBQUcsQ0FBQyxDQUFDLElBQUksa0JBQWtCLElBQUksSUFBSSxDQUFDLGtCQUFrQixDQUFDLENBQUMsQ0FBQztZQUNyRCxjQUFjLENBQUMsa0JBQWtCLENBQUMsR0FBRyxJQUFJLENBQUMsa0JBQWtCLENBQUMsQ0FBQTtRQUNqRSxDQUFDO0lBQ0wsQ0FBQztJQUVEOzs7T0FHRztJQUNILFFBQVE7UUFDSixJQUFJLENBQUMsSUFBSSxFQUFFLENBQUE7SUFDZixDQUFDO0NBQ0o7QUExQ0Qsc0JBMENDIn0=

package.json

@@ -1,6 +1,6 @@
 {
   "name": "smartdata",
-  "version": "1.0.17",
+  "version": "1.0.19",
   "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.saveable
             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

@@ -5,17 +5,55 @@ import { DbCollection } from './smartdata.classes.dbcollection'
 
 export type TDocCreation = 'db' | 'data' | 'mixed'
 
+/**
+ * sva - saveable decorator to be used on class properties
+ */
+export function saveable(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]
         }
+    }
+
+    /**
+     * also store any referenced objects to DB
+     * better for data consistency
+     */
     saveDeep() {
-
+        this.save()
     }
 }

tsconfig.json

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