feat: add support for mixed type

Author: wojtek-krysiak

example-app/src/entity/Car.ts

@@ -10,6 +10,12 @@ export class Car extends BaseEntity {
   @Column()
   name: string;
 
+  @Column({
+    type: 'jsonb',
+    nullable: true,
+  })
+  meta: any;
+
   @ManyToOne((type) => User, (user) => user.cars)
   owner: User;
 

example-app/src/index.ts

@@ -25,7 +25,19 @@ const run = async () => {
           },
         },
       },
-    }, Car, Seller],
+    }, {
+      resource: Car,
+      options: {
+        properties: {
+          'meta.title': {
+            type: 'string',
+          },
+          'meta.description': {
+            type: 'string',
+          },
+        },
+      },
+    }, Seller],
   })
   const router = buildRouter(admin)
 

spec/Property.spec.ts

@@ -108,4 +108,12 @@ describe('Property', () => {
       ])
     })
   })
+
+  describe('#type', () => {
+    it('returns mixed type for an jsonb property', () => {
+      const column = columns.find((c) => c.propertyName === 'meta') as ColumnMetadata
+
+      expect(new Property(column).type()).to.equal('mixed')
+    })
+  })
 })

spec/Resource.spec.ts

@@ -17,6 +17,8 @@ describe('Resource', () => {
     streetNumber: 'something',
     age: 4,
     stringAge: '4',
+    'meta.title': 'Hyundai',
+    'meta.description': 'Hyundai Tucson',
   }
 
   before(async () => {
@@ -66,12 +68,12 @@ describe('Resource', () => {
 
   describe('#properties', () => {
     it('returns all the properties', () => {
-      expect(resource.properties()).to.have.lengthOf(11)
+      expect(resource.properties()).to.have.lengthOf(12)
     })
 
     it('returns all properties with the correct position', () => {
       expect(resource.properties().map((property) => property.position())).to.deep.equal([
-        0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10,
+        0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11,
       ])
     })
   })
@@ -126,6 +128,16 @@ describe('Resource', () => {
       expect(storedRecord.stringAge).to.equal(4)
     })
 
+    it('stores mixed type properties', async () => {
+      const params = await resource.create(data)
+      const storedRecord = await Car.findOne(params.id) as Car
+
+      expect(storedRecord.meta).to.deep.equal({
+        title: data['meta.title'],
+        description: data['meta.description'],
+      })
+    })
+
     it('throws ValidationError for defined validations', async () => {
       Resource.validate = validate
       try {

spec/entities/Car.ts

@@ -44,6 +44,12 @@ export class Car extends BaseEntity {
   })
   public carType: CarType;
 
+  @Column({
+    type: 'jsonb',
+    nullable: true,
+  })
+  public meta;
+
   @ManyToOne(() => CarDealer, (carDealer) => carDealer.cars)
   public carDealer: CarDealer;
 

src/Resource.ts

@@ -1,6 +1,6 @@
 /* eslint-disable no-param-reassign */
-import { BaseEntity, In } from 'typeorm'
-import { BaseResource, ValidationError, Filter, BaseRecord } from 'admin-bro'
+import { BaseEntity } from 'typeorm'
+import { BaseResource, ValidationError, Filter, BaseRecord, flat } from 'admin-bro'
 
 import { Property } from './Property'
 import { convertFilter } from './utils/convertFilter'
@@ -51,29 +51,6 @@ export class Resource extends BaseResource {
     }))
   }
 
-  public async populate(
-    baseRecords: Array<BaseRecord>,
-    property: Property,
-  ): Promise<Array<BaseRecord>> {
-    const fks: Array<any> = baseRecords.map((baseRecord) => baseRecord.params[property.name()])
-
-    const instances = await this.model.findByIds(fks)
-    const instancesRecord: Record<string, BaseEntity> = {}
-    instances.forEach((instance) => {
-      if (instance.hasId()) {
-        instancesRecord[(instance as any).id] = instance
-      }
-    })
-
-    baseRecords.forEach((baseRecord) => {
-      const fk = baseRecord.params[property.name()]
-      const instance = instancesRecord[fk]
-      // eslint-disable-next-line no-param-reassign
-      if (instance) { baseRecord.populated[property.name()] = new BaseRecord(instance, this) }
-    })
-    return baseRecords
-  }
-
   public async find(
     filter: Filter,
     params,
@@ -100,7 +77,7 @@ export class Resource extends BaseResource {
   }
 
   public async findMany(ids: Array<string | number>): Promise<Array<BaseRecord>> {
-    const instances = await this.model.find({ where: { id: In(ids) } })
+    const instances = await this.model.findByIds(ids)
     return instances.map((instance) => new BaseRecord(instance, this))
   }
 
@@ -154,17 +131,17 @@ export class Resource extends BaseResource {
   private prepareParams(params: Record<string, any>): Record<string, any> {
     const preparedParams: Record<string, any> = { ...params }
 
-    for (const key in params) {
-      const param = params[key]
-      const property = this.property(key)
+    this.properties().forEach((property) => {
+      const param = flat.get(preparedParams, property.path())
+      const key = property.path()
 
       // eslint-disable-next-line no-continue
-      if (!(property && param !== undefined)) continue
+      if (param === undefined) { return }
 
       const type = property.type()
 
       if (type === 'mixed') {
-        preparedParams[key] = JSON.parse(param)
+        preparedParams[key] = param
       }
 
       if (type === 'number') {
@@ -184,7 +161,7 @@ export class Resource extends BaseResource {
           preparedParams[property.column.propertyName] = { id }
         }
       }
-    }
+    })
     return preparedParams
   }
 

src/index.ts

@@ -1,6 +1,9 @@
 /**
  * @module @admin-bro/typeorm
- * @description
+ * @subcategory Adapters
+ * @section modules
+ *
+ * @classdesc
  * Database adapter which integrates [TypeORM](https://typeorm.io/) into admin-bro
  *
  * ## installation