feat: Add suport for ARRAY type columns

fixes SoftwareBrothers/adminjs#353

Author: bakkerthehacker

migrations/20181211174223-create-user.js

@@ -26,6 +26,9 @@ module.exports = {
       email: {
         type: Sequelize.STRING,
       },
+      arrayed: {
+        type: Sequelize.ARRAY(Sequelize.STRING),
+      },
       createdAt: {
         allowNull: false,
         type: Sequelize.DATE,

models/user.js

@@ -11,6 +11,7 @@ module.exports = (sequelize, DataTypes) => {
       allowNull: false,
       validate: { isEmail: true },
     },
+    arrayed: DataTypes.ARRAY(DataTypes.STRING),
   }, {})
   User.associate = function (models) {
     User.hasMany(models.Post, { foreignKey: 'userId' })

package.json

@@ -49,6 +49,7 @@
     "@semantic-release/git": "^9.0.0"
   },
   "dependencies": {
-    "escape-regexp": "0.0.1"
+    "escape-regexp": "0.0.1",
+    "flat": "^5.0.0"
   }
 }

spec/database.spec.js

@@ -12,6 +12,7 @@ describe('Database', function () {
       firstName: Sequelize.STRING,
       lastName: Sequelize.STRING,
       email: Sequelize.STRING,
+      arrayed: Sequelize.ARRAY(Sequelize.STRING),
     }, {})
   })
 

spec/property.spec.js

@@ -12,6 +12,18 @@ describe('Property', function () {
     db.sequelize.close()
   })
 
+  describe('#isArray', function () {
+    it('returns false for regular (not arrayed) property', function () {
+      const property = new Property(this.rawAttributes.email)
+      expect(property.isArray()).to.equal(false)
+    })
+
+    it('returns true for array property', function () {
+      const property = new Property(this.rawAttributes.arrayed)
+      expect(property.isArray()).to.equal(true)
+    })
+  })
+
   describe('#type', function () {
     it('returns correct string type', function () {
       const property = new Property(this.rawAttributes.firstName)
@@ -27,6 +39,11 @@ describe('Property', function () {
       const property = new Property(this.rawAttributes.createdAt)
       expect(property.type()).to.equal('datetime')
     })
+
+    it('returns string when property is an array of strings', function () {
+      const property = new Property(this.rawAttributes.arrayed)
+      expect(property.type()).to.equal('string')
+    })
   })
 
   describe('#availableValues', function () {

spec/resource.spec.js

@@ -50,7 +50,7 @@ describe('Resource', function () {
 
   describe('#properties', function () {
     it('returns all properties', function () {
-      const length = 7 // there are 7 properties in the User model (4 regular + __v and _id)
+      const length = 8 // there are 8 properties in the User model (5 regular + __v and _id)
       expect(this.resource.properties()).to.have.lengthOf(length)
     })
   })

src/property.js

@@ -49,7 +49,7 @@ class Property extends BaseProperty {
   }
 
   reference() {
-    return this.sequelizePath.references && this.sequelizePath.references.model
+    return !this.isArray() && this.sequelizePath.references && this.sequelizePath.references.model
   }
 
   availableValues() {
@@ -58,9 +58,19 @@ class Property extends BaseProperty {
       : null
   }
 
+  isArray() {
+    return this.sequelizePath.type.constructor.name === 'ARRAY'
+  }
+
   type() {
+    let sequelizeType = this.sequelizePath.type
+    
+    if (this.isArray()) {
+      sequelizeType = sequelizeType.type
+    }
+
     const key = TYPES_MAPPING.find(element => (
-      this.sequelizePath.type.constructor.name === element[0]
+      sequelizeType.constructor.name === element[0]
     ))
 
     if (this.reference()) {
@@ -71,6 +81,10 @@ class Property extends BaseProperty {
     return type || 'string'
   }
 
+  isSortable() {
+    return this.type() !== 'mixed' && !this.isArray()
+  }
+
   isRequired() {
     return !(typeof this.sequelizePath.allowNull === 'undefined'
       || this.sequelizePath.allowNull === true)

src/resource.js

@@ -1,5 +1,5 @@
 /* eslint-disable no-param-reassign */
-
+const { unflatten } = require('flat')
 const { BaseResource, BaseRecord } = require('admin-bro')
 const { Op } = require('sequelize')
 
@@ -116,8 +116,9 @@ class Resource extends BaseResource {
 
   async create(params) {
     const parsedParams = this.parseParams(params)
+    const unflattedParams = unflatten(parsedParams)
     try {
-      const record = await this.SequelizeModel.create(parsedParams)
+      const record = await this.SequelizeModel.create(unflattedParams)
       return record.toJSON()
     } catch (error) {
       if (error.name === SEQUELIZE_VALIDATION_ERROR) {
@@ -129,8 +130,9 @@ class Resource extends BaseResource {
 
   async update(id, params) {
     const parsedParams = this.parseParams(params)
+    const unflattedParams = unflatten(parsedParams)
     try {
-      await this.SequelizeModel.update(parsedParams, {
+      await this.SequelizeModel.update(unflattedParams, {
         where: {
           [this.SequelizeModel.primaryKeyField]: id,
         },