ADD(RxSchema) default values

Author: pubkey

CHANGELOG.md

@@ -4,10 +4,11 @@
 
 Features:
   - Added [RxCollection.atomicUpsert](https://pubkey.github.io/rxdb/RxCollection.html#atomicUpsert)
+  - Added [defaul values](https://pubkey.github.io/rxdb/RxSchema.html#default)
 
 Other:
   - Split out test-util into its own npm-module [async-test-util](https://github.com/pubkey/async-test-util)
-  - Upgrade to pouchdb version [6.3.2](https://github.com/pouchdb/pouchdb/releases/tag/6.3.2)
+  - Upgrade to pouchdb version [6.3.4](https://github.com/pouchdb/pouchdb/releases/tag/6.3.4)
 
 Bugfixes:
   - Settings values to `null` did not work on temporaryDocuments [#215](https://github.com/pubkey/rxdb/issues/215)

docs-src/RxSchema.md

@@ -129,6 +129,30 @@ const schemaWithIndexes = {
 ```
 
 
+## default
+Default values can only be defined for first-level fields.
+Whenever you insert a document or create a temporary-document, unset fields will be filled with default-values.
+
+```js
+const schemaWithDefaultAge = {
+  version: 0,
+  type: 'object',
+  properties: {
+      firstName: {
+          type: 'string'
+      },
+      lastName: {
+          type: 'string'
+      },
+      age: {
+          type: 'integer',
+          default: 20       // <- default will be used
+      }
+  },
+};
+```
+
+
 ## NOTICE: Not everything within the jsonschema-spec is allowed
 The schema is not only used to validate objects before they are written into the database, but also used to map getters to observe and populate single fieldnames, keycompression and other things. Therefore you can not use every schema which would be valid for the spec of [json-schema.org](http://json-schema.org/).
 For example, fieldnames must match the regex `^[a-zA-Z][[a-zA-Z0-9_]*]?[a-zA-Z0-9]$` and `additionalProperties` is always set to `false`. But don't worry, RxDB will instantly throw an error when you pass a invalid schema into it.

docs-src/SUMMARY.md

@@ -24,7 +24,9 @@
       * [Create a collection with the schema](./RxSchema.md#create-a-collection-with-the-schema)
       * [version](./RxSchema.md#version)
       * [disableKeyCompression](./RxSchema.md#disableKeyCompression)
-      * [Indexes](./RxSchema.md#indexes)
+      * [indexes](./RxSchema.md#indexes)
+      * [default](./RxSchema.md#default)
+
 
 * [RxCollection](./RxCollection.md)
     * [Creation](./RxCollection.md#creating-a-collection)

examples/angular2/app/src/components/hero-insert/hero-insert.component.ts

@@ -25,10 +25,7 @@ export class HeroInsertComponent implements OnInit {
     async reset() {
         const db = await this.databaseService.get();
         this.tempDoc = db['hero'].newDocument({
-            name: '',
-            color: '',
-            maxHP: randomInt(100, 1000),
-            hp: 100
+            maxHP: randomInt(100, 1000)
         });
     }
 

examples/angular2/app/src/schemas/hero.schema.json

@@ -6,10 +6,12 @@
     "properties": {
         "name": {
             "type": "string",
-            "primary": true
+            "primary": true,
+            "default": ""
         },
         "color": {
-            "type": "string"
+            "type": "string",
+            "default": ""
         },
         "maxHP": {
           "type": "number",
@@ -19,7 +21,8 @@
         "hp": {
             "type": "number",
             "min": 0,
-            "max": 100
+            "max": 100,
+            "default": 100
         },
         "team": {
             "description": "color of the team this hero belongs to",

examples/angular2/package.json

@@ -19,65 +19,65 @@
   "author": "pubkey",
   "license": "MIT",
   "dependencies": {
-    "@angular/common": "^4.2.6",
-    "@angular/compiler": "^4.2.6",
-    "@angular/compiler-cli": "^4.2.6",
-    "@angular/core": "^4.2.6",
-    "@angular/forms": "^4.2.6",
-    "@angular/http": "^4.2.6",
+    "@angular/common": "4.3.0",
+    "@angular/compiler": "4.3.0",
+    "@angular/compiler-cli": "4.3.0",
+    "@angular/core": "4.3.0",
+    "@angular/forms": "4.3.0",
+    "@angular/http": "4.3.0",
     "@angular/material": "2.0.0-beta.2",
-    "@angular/platform-browser": "^4.2.6",
-    "@angular/platform-browser-dynamic": "^4.2.6",
-    "@angular/platform-server": "^4.2.6",
-    "@angular/router": "^4.2.6",
+    "@angular/platform-browser": "4.3.0",
+    "@angular/platform-browser-dynamic": "4.3.0",
+    "@angular/platform-server": "4.3.0",
+    "@angular/router": "4.3.0",
     "babel-polyfill": "6.23.0",
-    "concurrently": "^3.5.0",
+    "concurrently": "3.5.0",
     "core-js": "2.4.1",
-    "font-awesome": "^4.7.0",
+    "font-awesome": "4.7.0",
     "hammerjs": "2.0.8",
     "json-loader": "0.5.4",
-    "node-gyp": "^3.6.0",
-    "normalize.css": "^7.0.0",
-    "pouchdb-adapter-http": "^6.2.0",
-    "pouchdb-adapter-idb": "^6.2.0",
-    "pouchdb-adapter-localstorage": "^6.2.0",
-    "pouchdb-replication": "^6.2.0",
-    "pouchdb-server": "^2.3.7",
+    "node-gyp": "3.6.2",
+    "normalize.css": "7.0.0",
+    "pouchdb-adapter-http": "6.3.4",
+    "pouchdb-adapter-idb": "6.3.4",
+    "pouchdb-adapter-localstorage": "6.3.4",
+    "pouchdb-replication": "6.3.4",
+    "pouchdb-server": "2.3.7",
     "random-int": "1.0.0",
     "regenerator": "0.9.7",
     "roboto-npm-webfont": "0.0.4",
-    "rxjs": "^5.4.2",
-    "zone.js": "^0.8.12"
+    "rxjs": "5.4.2",
+    "zone.js": "0.8.13"
   },
   "devDependencies": {
-    "@types/chai": "^4.0.1",
-    "@types/core-js": "^0.9.42",
+    "@types/chai": "4.0.1",
+    "@types/core-js": "0.9.42",
     "@types/hammerjs": "2.0.34",
-    "@types/requirejs": "^2.1.29",
+    "@types/requirejs": "2.1.29",
     "angular2-template-loader": "0.6.2",
     "appcache-webpack-plugin": "1.3.0",
-    "awesome-typescript-loader": "^3.2.1",
-    "babel-core": "^6.25.0",
-    "babel-loader": "^7.1.1",
-    "babel-preset-env": "^1.6.0",
+    "awesome-typescript-loader": "3.2.1",
+    "babel-core": "6.25.0",
+    "babel-loader": "7.1.1",
+    "babel-preset-env": "1.6.0",
     "copy-webpack-plugin": "4.0.1",
-    "css-loader": "^0.28.0",
-    "extract-text-webpack-plugin": "^3.0.0",
-    "file-loader": "^0.11.1",
+    "css-loader": "0.28.4",
+    "extract-text-webpack-plugin": "3.0.0",
+    "file-loader": "0.11.2",
     "fsmonitor": "0.2.4",
-    "html-webpack-plugin": "^2.29.0",
+    "html-webpack-plugin": "2.29.0",
     "less": "2.7.2",
-    "less-loader": "^4.0.5",
+    "less-loader": "4.0.5",
     "npm-run-all": "4.0.2",
-    "postcss-cli": "^4.1.0",
+    "postcss-cli": "4.1.0",
     "raw-loader": "0.5.1",
-    "rimraf": "^2.6.1",
-    "style-loader": "^0.18.2",
-    "tslint": "^5.5.0",
-    "typescript": "^2.4.1",
-    "url-loader": "^0.5.9",
-    "webpack": "^3.2.0",
-    "webpack-dev-server": "^2.5.1",
-    "webpack-merge": "^4.1.0"
+    "rimraf": "2.6.1",
+    "style-loader": "0.18.2",
+    "tslint": "5.5.0",
+    "typescript": "2.4.1",
+    "url-loader": "0.5.9",
+    "webpack": "3.3.0",
+    "webpack-dev-server": "2.5.1",
+    "webpack-merge": "4.1.0"
   }
 }

src/RxCollection.js

@@ -242,6 +242,7 @@ class RxCollection {
         }
 
         json = clone(json);
+        json = this.schema.fillObjectWithDefaults(json);
 
         if (json._id)
             throw new Error('do not provide ._id, it will be generated');
@@ -589,6 +590,7 @@ class RxCollection {
      * @return {RxDocument}
      */
     newDocument(docData = {}) {
+        docData = this.schema.fillObjectWithDefaults(docData);
         const doc = RxDocument.create(this, docData);
         doc._isTemporary = true;
         this._assignMethodsToDocument(doc);

src/RxSchema.js

@@ -78,6 +78,16 @@ export class RxSchema {
         return Object.keys(this.normalized.properties);
     }
 
+    get defaultValues() {
+        if (!this._defaultValues) {
+            this._defaultValues = {};
+            Object.entries(this.normalized.properties)
+                .filter(entry => entry[1].default)
+                .forEach(entry => this._defaultValues[entry[0]] = entry[1].default);
+        }
+        return this._defaultValues;
+    }
+
     /**
      * get all encrypted paths
      */
@@ -130,6 +140,24 @@ export class RxSchema {
         return this._hash;
     }
 
+    /**
+     * fills all unset fields with default-values if set
+     * @param  {object} obj
+     * @return {object}
+     */
+    fillObjectWithDefaults(obj) {
+        obj = clone(obj);
+        Object
+            .entries(this.defaultValues)
+            .filter(entry => !obj.hasOwnProperty(entry[0]))
+            .forEach(entry => {
+                const fieldName = entry[0];
+                const value = entry[0];
+                obj[entry[0]] = entry[1];
+            });
+        return obj;
+    }
+
     swapIdToPrimary(obj) {
         if (this.primaryPath == '_id' || obj[this.primaryPath]) return obj;
         obj[this.primaryPath] = obj._id;
@@ -301,6 +329,9 @@ export function validateFieldsDeep(jsonSchema) {
         if (isNested) {
             if (schemaObj.primary)
                 throw new Error('primary can only be defined at top-level');
+
+            if (schemaObj.default)
+                throw new Error('default-values can only be defined at top-level');
         }
 
         // first level
@@ -435,11 +466,11 @@ export function normalize(jsonSchema) {
 }
 
 /**
- * fills the schema-json with default-values
+ * fills the schema-json with default-settings
  * @param  {Object} schemaObj
  * @return {Object} cloned schemaObj
  */
-const fillWithDefaults = function(schemaObj) {
+const fillWithDefaultSettings = function(schemaObj) {
     schemaObj = clone(schemaObj);
 
     // additionalProperties is always false
@@ -470,7 +501,7 @@ const fillWithDefaults = function(schemaObj) {
 
 export function create(jsonID, doCheck = true) {
     if (doCheck) checkSchema(jsonID);
-    return new RxSchema(fillWithDefaults(jsonID));
+    return new RxSchema(fillWithDefaultSettings(jsonID));
 }
 
 export function isInstanceOf(obj) {

src/index.d.ts

@@ -15,37 +15,38 @@ declare class RxSchema {
  */
 type JsonSchemaTypes = "array" | "boolean" | "integer" | "number" | "null" | "object" | "string";
 interface JsonSchema {
+    allOf?: JsonSchema[];
+    anyOf?: JsonSchema[];
+    oneOf?: JsonSchema[];
+    additionalItems?: boolean | JsonSchema;
     type?: JsonSchemaTypes | JsonSchemaTypes[];
+    default?: any;
     description?: string;
+    dependencies?: {
+        [key: string]: JsonSchema | string[];
+    };
+    exclusiveMinimum?: boolean;
+    exclusiveMaximum?: boolean;
+    items?: JsonSchema | JsonSchema[];
     multipleOf?: number;
+    maxProperties?: number;
     maximum?: number;
-    exclusiveMaximum?: boolean;
     minimum?: number;
-    exclusiveMinimum?: boolean;
     maxLength?: number;
     minLength?: number;
-    pattern?: string;
-    additionalItems?: boolean | JsonSchema;
-    items?: JsonSchema | JsonSchema[];
     maxItems?: number;
     minItems?: number;
-    uniqueItems?: boolean;
-    maxProperties?: number;
     minProperties?: number;
-    required?: string[] | boolean;
-    properties?: {
-        [key: string]: JsonSchema;
-    };
+    pattern?: string;
     patternProperties?: {
         [key: string]: JsonSchema;
     };
-    dependencies?: {
-        [key: string]: JsonSchema | string[];
+    properties?: {
+        [key: string]: JsonSchema;
     };
+    required?: string[] | boolean;
+    uniqueItems?: boolean;
     enum?: any[];
-    allOf?: JsonSchema[];
-    anyOf?: JsonSchema[];
-    oneOf?: JsonSchema[];
     not?: JsonSchema;
     definitions?: {
         [key: string]: JsonSchema;

test/helper/schemas.js

@@ -24,6 +24,32 @@ export const human = {
     required: ['firstName', 'lastName']
 };
 
+export const humanDefault = {
+    title: 'human schema',
+    version: 0,
+    description: 'describes a human being',
+    type: 'object',
+    properties: {
+        passportId: {
+            type: 'string',
+            index: true
+        },
+        firstName: {
+            type: 'string'
+        },
+        lastName: {
+            type: 'string'
+        },
+        age: {
+            description: 'age in years',
+            type: 'integer',
+            minimum: 0,
+            maximum: 150,
+            default: 20
+        }
+    },
+    required: ['passportId']
+};
 
 export const simpleHuman = {
     title: 'human schema',