Merge pull request #50 from AthennaIO/develop

feat(model): make toJSON execute in relations

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/database",
-  "version": "1.3.3",
+  "version": "1.3.4",
   "description": "The Athenna database handler for SQL/NoSQL.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",

src/Models/Model.js

@@ -507,9 +507,32 @@ export class Model {
    * @return {any|any[]}
    */
   toJSON() {
+    const Model = this.constructor
+
     const json = {}
+    const relations = Model.getSchema().relations.map(relation => relation.name)
+
+    Object.keys(this).forEach(key => {
+      if (relations.includes(key)) {
+        if (Is.Array(this[key])) {
+          json[key] = this[key].map(d => {
+            if (d.toJSON) {
+              return d.toJSON()
+            }
+
+            return d
+          })
+
+          return
+        }
 
-    Object.keys(this).forEach(key => (json[key] = this[key]))
+        json[key] = this[key].toJSON ? this[key].toJSON() : this[key]
+
+        return
+      }
+
+      json[key] = this[key]
+    })
 
     return json
   }

tests/Unit/Models/ProductModelTest.js

@@ -548,4 +548,11 @@ test.group('ProductModelTest', group => {
     assert.isUndefined(criterias.select)
     assert.isUndefined(criterias.orderBy)
   })
+
+  test('should be able to transform to json the relations included in the model', async ({ assert }) => {
+    const product = await ProductMySql.query().includes('user').find()
+    const productJson = product.toJSON()
+
+    assert.notInstanceOf(productJson.user, UserMySql)
+  })
 })

tests/Unit/Models/UserModelTest.js

@@ -574,4 +574,14 @@ test.group('UserModelTest', group => {
     assert.isUndefined(criterias.select)
     assert.isUndefined(criterias.orderBy)
   })
+
+  test('should be able to transform to json the relations included in the model', async ({ assert }) => {
+    const { id } = await User.query().find()
+    await Product.factory().create({ userId: id })
+
+    const user = await User.query().includes('products').find()
+    const userJson = user.toJSON()
+
+    assert.notInstanceOf(userJson.products[0], Product)
+  })
 })