refactor: remove nullable from columns and add serialize property

Serialize property allows stopping the column from getting serialized

adonis-typings/model.ts

@@ -18,7 +18,7 @@ declare module '@ioc:Adonis/Lucid/Model' {
   export type ColumnNode = {
     castAs: string,
     serializeAs: string,
-    nullable: boolean,
+    serialize: boolean,
     primary: boolean,
     hasGetter: boolean,
     hasSetter: boolean,

src/Orm/BaseModel/index.ts

@@ -198,12 +198,12 @@ export class BaseModel implements ModelContract {
     const descriptor = Object.getOwnPropertyDescriptor(this.prototype, name)
 
     const column: ColumnNode = {
-      castAs: options.castAs || snakeCase(name),
-      serializeAs: options.serializeAs || snakeCase(name),
-      nullable: options.nullable || false,
       primary: options.primary || false,
+      castAs: options.castAs || snakeCase(name),
       hasGetter: !!(descriptor && descriptor.get),
       hasSetter: !!(descriptor && descriptor.set),
+      serializeAs: options.serializeAs || snakeCase(name),
+      serialize: options.serialize === false ? false : true,
     }
 
     /**
@@ -782,12 +782,18 @@ export class BaseModel implements ModelContract {
     const Model = this.constructor as typeof BaseModel
     const results = {}
 
-    Model.$computed.forEach((value, key) => {
-      results[value.serializeAs] = this[key]
+    Object.keys(this.$attributes).forEach((key) => {
+      const column = Model.$getColumn(key)!
+      if (column.serialize) {
+        results[column.serializeAs] = this.$attributes[key]
+      }
     })
 
-    Object.keys(this.$attributes).forEach((key) => {
-      results[Model.$getColumn(key)!.serializeAs] = this.$attributes[key]
+    Model.$computed.forEach((value, key) => {
+      const computedValue = this[key]
+      if (computedValue !== undefined) {
+        results[value.serializeAs] = computedValue
+      }
     })
 
     Object.keys(this.$preloaded).forEach((key) => {

test/orm/base-model.spec.ts

@@ -722,6 +722,20 @@ test.group('Base Model | toJSON', () => {
     assert.deepEqual(user.toJSON(), { theUsername: 'virk' })
   })
 
+  test('do not serialize when serialize is set to false', async (assert) => {
+    const BaseModel = getBaseModel(ormAdapter())
+
+    class User extends BaseModel {
+      @column({ serialize: false })
+      public username: string
+    }
+
+    const user = new User()
+    user.username = 'virk'
+
+    assert.deepEqual(user.toJSON(), {})
+  })
+
   test('add computed properties to toJSON result', async (assert) => {
     const BaseModel = getBaseModel(ormAdapter())
 
@@ -740,6 +754,25 @@ test.group('Base Model | toJSON', () => {
 
     assert.deepEqual(user.toJSON(), { username: 'virk', fullName: 'VIRK' })
   })
+
+  test('do not add computed property when it returns undefined', async (assert) => {
+    const BaseModel = getBaseModel(ormAdapter())
+
+    class User extends BaseModel {
+      @column()
+      public username: string
+
+      @computed()
+      public get fullName () {
+        return undefined
+      }
+    }
+
+    const user = new User()
+    user.username = 'virk'
+
+    assert.deepEqual(user.toJSON(), { username: 'virk' })
+  })
 })
 
 test.group('BaseModel | cache', () => {