Added an option to expose the flags through the Model.prototype.$fields() method, used by $toJSON internally, thus exposing the flags to any JSON.stringify output.

See vuex-orm/vuex-orm#319 for rationale.

Author: tvillaren

README.md

@@ -131,17 +131,19 @@ store.dispatch['entities/resetAllDirtyFlags']({}, { root: true });
 By default, the flags are named `$isDirty` and `$isNew`.  
 You can override those default by setting the corresponding options at plugin initialization.
 
-| Option name     | Description                         | Default value |
-| --------------- | ----------------------------------- | :-----------: |
-| isNewFlagName   | Sets the name of the _isNew_ flag   |   `$isNew`    |
-| isDirtyFlagName | Sets the name of the _isDirty_ flag |  `$isDirty`   |
+| Option name           | Description                                                         | Default value |
+| --------------------- | ------------------------------------------------------------------- | :-----------: |
+| isNewFlagName         | Sets the name of the _isNew_ flag                                   |   `$isNew`    |
+| isDirtyFlagName       | Sets the name of the _isDirty_ flag                                 |  `$isDirty`   |
+| exposeFlagsExternally | Adds the _isNew_ and _isDirty_ flags to the JSON stringified output |    `true`     |
 
 In order to use those options, you can pass them as the second parameter of the `install` call:
 
 ```javascript
 VuexORM.use(VuexORMisDirtyPlugin, {
     isNewFlagName: 'IsNew',
-    isDirtyFlagName: 'IsDirty'
+    isDirtyFlagName: 'IsDirty',
+    exposeFlagsExternally: true
 });
 ```
 

dist/index.js

@@ -1,6 +1,6 @@
 {
   "name": "@vuex-orm/plugin-change-flags",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Vuex ORM plugin adding IsDirty / IsNew flags to model entities",
   "author": "Thomas Villaren",
   "main": "dist/index.js",

package.json

@@ -1,6 +1,7 @@
 const defaultOptions = {
     isDirtyFlagName: '$isDirty',
-    isNewFlagName: '$isNew'
+    isNewFlagName: '$isNew',
+    exposeFlagsExternally: true
 };
 
 export default {
@@ -20,6 +21,23 @@ export default {
             Actions
         } = components;
 
+        /**
+         * Flags are exposed by default when stringiying into JSON.
+         * This can be deactivated by setting the flag to false
+         */
+        if (pluginOptions.exposeFlagsExternally) {
+            const localFieldModel = {
+                [pluginOptions.isDirtyFlagName]: Model.attr(false),
+                [pluginOptions.isNewFlagName]: Model.attr(false)
+            };
+
+            const _saveGetFiedsMethod = Model.prototype.$fields;
+            Model.prototype.$fields = function () {
+                const existing = _saveGetFiedsMethod.call(this);
+                return Object.assign({}, existing, localFieldModel);
+            }
+        }
+
         /**
          * Overwriting the $fill method used when calling
          * new Model() to inject automatically the 2 flags
@@ -61,7 +79,6 @@ export default {
         RootActions.resetAllDirtyFlags = function ({
             rootGetters
         }) {
-            debugger
             const allDirty = rootGetters['entities/allDirty']();
             _ignoreIsDirtyFlag = true;
             allDirty.forEach(e =>

src/index.js

@@ -322,4 +322,24 @@ describe('Vuex ORM $isDirty/$isNew plugin default installation', function () {
         expect(users.length).to.equal(2);
 
     });
+
+    it('should expose flags by default', async function () {
+        const store = createStore([{
+            model: User
+        }]);
+
+        let user = new User({
+            id: 1,
+            roleId: 1,
+            name: "Test",
+            email: "Test"
+        });
+
+        User.insert({
+            data: [user]
+        });
+
+        let u = store.getters['entities/users/find'](1);
+        expect(JSON.stringify(u)).to.equal('{"id":1,"name":"Test","email":"Test","phone":"","roleId":1,"role":null,"$isDirty":false,"$isNew":false}');
+    });
 });