Add option to transform a record

Author: andrglo

src/index.js

@@ -363,7 +363,7 @@ class TableRecord {
       })
     )
     setIs(this, record, it, isNew)
-    Object.freeze(this)
+    // Object.freeze(this)
   }
 
   get entity() {
@@ -1330,7 +1330,7 @@ module.exports = function (schemaName, schema, config) {
                 return db
                   .query(view.statement, view.params, options)
                   .then(function (res) {
-                    return res.map(function (record) {
+                    const recordset = res.map(function (record) {
                       return options.toPlainObject === true ||
                         options.fetchExternalDescription === true
                         ? buildPlainObject(record, data)
@@ -1343,10 +1343,16 @@ module.exports = function (schemaName, schema, config) {
                             self
                           )
                     })
+                    return config.transforms?.read
+                      ? recordset.map(config.transforms.read)
+                      : recordset
                   })
               })
             },
             create: function (entity, options) {
+              if (config.transforms?.write) {
+                entity = config.transforms.write(entity)
+              }
               options = options || {}
               var self = this
               var isInstance =
@@ -1387,21 +1393,28 @@ module.exports = function (schemaName, schema, config) {
                     })
                     .then(function (record) {
                       orderAssociations(record, data)
-                      return options.toPlainObject === true &&
-                        !isInstance
-                        ? record
-                        : buildEntity(
-                            record,
-                            data,
-                            false,
-                            false,
-                            entity,
-                            self
-                          )
+                      let res =
+                        options.toPlainObject === true && !isInstance
+                          ? record
+                          : buildEntity(
+                              record,
+                              data,
+                              false,
+                              false,
+                              entity,
+                              self
+                            )
+                      if (config.transforms?.read) {
+                        res = config.transforms.read(res)
+                      }
+                      return res
                     })
                 })
             },
             update: function (entity, key, options) {
+              if (config.transforms?.write) {
+                entity = config.transforms.write(entity)
+              }
               var self = this
               key = key || entity[data.primaryKeyAttributes[0]]
               if (!key) {
@@ -1509,17 +1522,21 @@ module.exports = function (schemaName, schema, config) {
                   })
                   .then(function (record) {
                     orderAssociations(record, data)
-                    return options.toPlainObject === true &&
-                      !isInstance
-                      ? record
-                      : buildEntity(
-                          record,
-                          data,
-                          false,
-                          false,
-                          entity,
-                          self
-                        )
+                    let res =
+                      options.toPlainObject === true && !isInstance
+                        ? record
+                        : buildEntity(
+                            record,
+                            data,
+                            false,
+                            false,
+                            entity,
+                            self
+                          )
+                    if (config.transforms?.read) {
+                      res = config.transforms.read(res)
+                    }
+                    return res
                   })
               })
             },
@@ -1685,6 +1702,13 @@ module.exports = function (schemaName, schema, config) {
           rebuild()
           return data.public
         },
+        setTransforms: function ({read, write}) {
+          config.transforms = {
+            read,
+            write
+          }
+          return data.public
+        },
         setScope: function (scope) {
           data.scope = scope
           rebuild()

test/spec.js

@@ -100,6 +100,17 @@ module.exports = function (options) {
         }
       })
       entityCadastro.setDialect(db.dialect)
+      entityCadastro.setTransforms({
+        read: record => {
+          record.emails = ['hi_1@abc.com', 'hi_2@abc.com']
+          return record
+        },
+        write: record => {
+          record.EMAIL = record.emails?.[0]
+          delete record.emails
+          return record
+        }
+      })
       tableCadastro = entityCadastro.new(db)
       tableCadastro2 = entityCadastro.new(db2)
       tableCadastro
@@ -194,6 +205,42 @@ module.exports = function (options) {
           expect(record.id).to.not.equal(undefined)
           expect(record.updatedAt).to.not.equal(undefined)
           expect(end[1]).above(minNanoSecsToSave)
+          expect(record.emails).to.deep.equal([
+            'hi_1@abc.com',
+            'hi_2@abc.com'
+          ])
+          return tableCadastro2
+            .update({...record, EMAIL: 'z@a.com'})
+            .then(function (record) {
+              end = process.hrtime(start)
+              expect(record.id).to.not.equal(undefined)
+              expect(record.updatedAt).to.not.equal(undefined)
+              expect(end[1]).above(minNanoSecsToSave)
+              expect(record.EMAIL).to.equal('hi_1@abc.com')
+              expect(record.emails).to.deep.equal([
+                'hi_1@abc.com',
+                'hi_2@abc.com'
+              ])
+              done()
+            })
+        })
+        .catch(function (err) {
+          done(err)
+        })
+    })
+    it('record should be readable in db 2', function (done) {
+      tableCadastro2
+        .fetch()
+        .then(function (recordset) {
+          expect(recordset).to.be.a('array')
+          expect(recordset.length).to.equal(1)
+          expect(tableCadastro2.db).to.equal(db2)
+          const record = recordset[0]
+          expect(record.EMAIL).to.equal('hi_1@abc.com')
+          expect(record.emails).to.deep.equal([
+            'hi_1@abc.com',
+            'hi_2@abc.com'
+          ])
           done()
         })
         .catch(function (err) {