ADD RxDocument.toJSON() is leaking _deleted

Author: pubkey

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ### X.X.X (comming soon)
 
+Bugfixes:
+  - `RxDocument.toJSON()` is leaking meta field `_deleted`. [#3645](https://github.com/pubkey/rxdb/pull/3645) Thanks [@Bessonov](https://github.com/Bessonov)
+
 Features:
   - Allow truthy values for the GraphQL replication `deletedFlag` field. [#3644](https://github.com/pubkey/rxdb/pull/3644) Thanks [@nirvdrum](https://github.com/nirvdrum)
 

docs-src/rx-document.md

@@ -158,6 +158,21 @@ console.dir(json);
 */
 ```
 
+You can also set `withMetaFields: true` to get additional meta fields like the revision, attachments or the deleted flag.
+
+```js
+const json = myDocument.toJSON(true);
+console.dir(json);
+/* { passportId: 'h1rg9ugdd30o',
+  firstName: 'Carolina',
+  lastName: 'Gibson',
+  _deleted: false,
+  _attachments: { ... },
+  _rev: '1-aklsdjfhaklsdjhf...'
+*/
+```
+
+
 ### set()
 **Only temporary documents**
 

src/rx-document.ts

@@ -238,11 +238,12 @@ export const basePrototype = {
         return valueObj;
     },
 
-    toJSON(this: RxDocument, withRevAndAttachments = false) {
-        if (!withRevAndAttachments) {
+    toJSON(this: RxDocument, withMetaFields = false) {
+        if (!withMetaFields) {
             const data = flatClone(this._data);
             delete (data as any)._rev;
             delete (data as any)._attachments;
+            delete (data as any)._deleted;
             return overwritable.deepFreezeWhenDevMode(data);
         } else {
             return overwritable.deepFreezeWhenDevMode(this._data);

test/unit/rx-document.test.ts

@@ -687,21 +687,28 @@ config.parallel('rx-document.test.js', () => {
         });
         it('should get a fresh object each time', async () => {
             const c = await humansCollection.create(1);
-            const doc: any = await c.findOne().exec();
+            const doc = await c.findOne().exec(true);
             const json = doc.toJSON();
             const json2 = doc.toJSON();
             assert.ok(json !== json2);
             c.database.destroy();
         });
-        it('should not return _rev if not wanted', async () => {
-            const c = await humansCollection.create(1);
-            const doc: any = await c.findOne().exec();
-            const json = doc.toJSON(
-                false // no ._rev
-            );
-            assert.ok(json.passportId);
-            assert.ok(json.firstName);
-            assert.strictEqual(typeof json._rev, 'undefined');
+        it('should not return meta fields if not wanted', async () => {
+            const c = await humansCollection.create(0);
+            await c.insert({
+                passportId: 'aatspywninca',
+                firstName: 'Tester',
+                lastName: 'Test',
+                age: 10
+            });
+            const newHuman = await c.findOne('aatspywninca').exec(true);
+            const jsonWithWithoutMetaFields = newHuman.toJSON();
+
+            const metaField = Object.keys(jsonWithWithoutMetaFields).find(key => key.startsWith('_'));
+            if (metaField) {
+                throw new Error('should not contain meta field ' + metaField);
+            }
+
             c.database.destroy();
         });
         it('should not return _attachments if not wanted', async () => {