Merge pull request #1 from vuex-orm/fix-createNew-signature

Fixing the method signature for Model.createNew

Author: Thomas V

README.md

@@ -13,22 +13,12 @@ It adds two flags `$isDirty` and `$isNew` (as _boolean_ attributes) on any insta
 
 ## Installation
 
-Simply reference the github project in your `package.json`
-
-```javascript
-dependencies: {
-    ...
-    "vuexorm-isdirty-plugin": "git://github.com/vuex-orm/vuexorm-isdirty-plugin"
-    ...
-}
-```
-
-and run `npm install`.
+Simply run `npm install @vuex-orm/plugin-change-flags --save` in your favorite terminal.
 
 Then, you need to install the plugin as any VuexORM plugin. In your store initialization code, simply add:
 
 ```javascript
-import VuexORMisDirtyPlugin from 'vuexorm-isdirty-plugin';
+import VuexORMisDirtyPlugin from '@vuex-orm/plugin-change-flags';
 ```
 
 and then

dist/index.js

@@ -1,6 +1,6 @@
 {
   "name": "@vuex-orm/plugin-change-flags",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Vuex ORM plugin adding IsDirty / IsNew flags to model entities",
   "author": "Thomas Villaren",
   "main": "dist/index.js",
@@ -75,4 +75,4 @@
     "url": "https://github.com/vuex-orm/plugin-change-flags/issues"
   },
   "homepage": "https://github.com/vuex-orm/plugin-change-flags#readme"
-}
+}

package.json

@@ -5,7 +5,9 @@ const defaultOptions = {
 
 export default {
     install(components, installOptions) {
-        const pluginOptions = { ...defaultOptions, ...installOptions };
+        const pluginOptions = { ...defaultOptions,
+            ...installOptions
+        };
 
         const {
             Model,
@@ -28,7 +30,7 @@ export default {
         const _saveFillMethod = Model.prototype.$fill;
 
         // Overwrite
-        Model.prototype.$fill = function(record) {
+        Model.prototype.$fill = function (record) {
             _saveFillMethod.call(this, record); // Calling initial
 
             // $isDirty
@@ -45,15 +47,15 @@ export default {
          * This is the only automatic way which sets this flag
          * to true once it's in the store.
          */
-        Query.on('beforeUpdate', function(model) {
+        Query.on('beforeUpdate', function (model) {
             model[pluginOptions.isDirtyFlagName] = true;
         });
 
         /**
          * Providing the allDirty getter
          */
-        RootGetters.allDirty = function(state) {
-            return function(entity) {
+        RootGetters.allDirty = function (state) {
+            return function (entity) {
                 if (entity) {
                     return new Query(state, entity)
                         .where(elt => elt[pluginOptions.isDirtyFlagName])
@@ -72,8 +74,8 @@ export default {
             };
         };
 
-        Getters.allDirty = function(state, _getters, _rootState, rootGetters) {
-            return function() {
+        Getters.allDirty = function (state, _getters, _rootState, rootGetters) {
+            return function () {
                 return rootGetters[`${state.$connection}/allDirty`](
                     state.$name
                 );
@@ -83,8 +85,8 @@ export default {
         /**
          * Providing the allNew getter
          */
-        RootGetters.allNew = function(state) {
-            return function(entity) {
+        RootGetters.allNew = function (state) {
+            return function (entity) {
                 if (entity) {
                     return new Query(state, entity)
                         .where(elt => elt[pluginOptions.isNewFlagName])
@@ -103,8 +105,8 @@ export default {
             };
         };
 
-        Getters.allNew = function(state, _getters, _rootState, rootGetters) {
-            return function() {
+        Getters.allNew = function (state, _getters, _rootState, rootGetters) {
+            return function () {
                 return rootGetters[`${state.$connection}/allNew`](state.$name);
             };
         };
@@ -114,17 +116,17 @@ export default {
          * When called on the Model instead of new, it will
          * set the 2 flags to true
          */
-        Model.createNew = function(insertInStore = true) {
+        Model.createNew = function (insertInStore = true) {
             if (insertInStore) return this.dispatch('createNew');
             else {
                 let record = new this();
                 record[pluginOptions.isNewFlagName] = true;
                 record[pluginOptions.isDirtyFlagName] = true;
-                return record;
+                return Promise.resolve(record);
             }
         };
 
-        RootMutations.createNew = function(state, payload) {
+        RootMutations.createNew = function (state, payload) {
             const entity = payload.entity;
             const result = payload.result;
 
@@ -133,19 +135,23 @@ export default {
             query.setResult(result).createNew();
         };
 
-        Actions.createNew = function(context) {
+        Actions.createNew = function (context) {
             const state = context.state;
             const entity = state.$name;
 
             return context.dispatch(
-                `${state.$connection}/createNew`,
-                { entity },
-                { root: true }
+                `${state.$connection}/createNew`, {
+                    entity
+                }, {
+                    root: true
+                }
             );
         };
 
-        RootActions.createNew = function(context, payload) {
-            const result = { data: {} };
+        RootActions.createNew = function (context, payload) {
+            const result = {
+                data: {}
+            };
 
             context.commit('createNew', {
                 ...payload,
@@ -155,7 +161,7 @@ export default {
             return result.data;
         };
 
-        Query.prototype.createNew = function() {
+        Query.prototype.createNew = function () {
             let record = new this.model().$toJson();
 
             record[pluginOptions.isNewFlagName] = true;
@@ -168,4 +174,4 @@ export default {
             return this.result.data;
         };
     }
-};
+};