Find & include data structure shape

I have a roles model and a permissions model. In the roles model I have: roles.belongsToMany(models.permissions, { through: ‘rolePermissions’ });

Then in the roles hook I have the following function that runs in the Before.Find Hook

const attachAssociations = (context) => {
  // Get the Sequelize instance. In the generated application via:
  const sequelize = context.app.get('sequelizeClient');
  const { permissions } = sequelize.models;
  context.params.sequelize = {
    include: [permissions]
  }
  return context;
}

When I do a request then to users I get the following output:

{ total: 1,
  limit: 10,
  skip: 0,
  data: 
   [ { id: 1,
       name: 'anonymous',
       createdAt: 2018-07-18T06:13:29.971Z,
       updatedAt: 2018-07-18T06:13:29.971Z,
       'permissions.id': 2,
       'permissions.name': 'create-user',
       'permissions.createdAt': 2018-07-18T06:13:29.895Z,
       'permissions.updatedAt': 2018-07-18T06:13:29.895Z,
       'permissions.rolePermissions.createdAt': 2018-07-18T06:13:29.985Z,
       'permissions.rolePermissions.updatedAt': 2018-07-18T06:13:29.985Z,
       'permissions.rolePermissions.roleId': 1,
       'permissions.rolePermissions.permissionId': 2 },
     { id: 1,
       name: 'anonymous',
       createdAt: 2018-07-18T06:13:29.971Z,
       updatedAt: 2018-07-18T06:13:29.971Z,
       'permissions.id': 10,
       'permissions.name': 'read-orgs',
       'permissions.createdAt': 2018-07-18T06:13:29.897Z,
       'permissions.updatedAt': 2018-07-18T06:13:29.897Z,
       'permissions.rolePermissions.createdAt': 2018-07-18T06:13:29.985Z,
       'permissions.rolePermissions.updatedAt': 2018-07-18T06:13:29.985Z,
       'permissions.rolePermissions.roleId': 1,
       'permissions.rolePermissions.permissionId': 10 },
     { id: 1,
       name: 'anonymous',
       createdAt: 2018-07-18T06:13:29.971Z,
       updatedAt: 2018-07-18T06:13:29.971Z,
       'permissions.id': 12,
       'permissions.name': 'read-supplies',
       'permissions.createdAt': 2018-07-18T06:13:29.898Z,
       'permissions.updatedAt': 2018-07-18T06:13:29.898Z,
       'permissions.rolePermissions.createdAt': 2018-07-18T06:13:29.985Z,
       'permissions.rolePermissions.updatedAt': 2018-07-18T06:13:29.985Z,
       'permissions.rolePermissions.roleId': 1,
       'permissions.rolePermissions.permissionId': 12 } ] }

So the request works but the structure of the output to me seems a little strange, I would expact that I would get back 1 array entry per role with an array of permissions inside it, instead I am getting a duplication of roles decided by the number of permissions that the user has.

I would expect / prefer a structure more like this:

{ total: 1,
  limit: 10,
  skip: 0,
  data: 
   [ { id: 1,
       name: 'anonymous',
       createdAt: 2018-07-18T06:13:29.971Z,
       updatedAt: 2018-07-18T06:13:29.971Z,
       permissionIds: [2, 10, 12] ] }

Are there any ways of doing this / suggestions on the best way to do this?

Thank you and regards, Emir

[daffl]

What I mean is that all you have to do to get the nested models is updated you attachAssociation (which is a before hook) to:

const attachAssociations = (context) => {
  // Get the Sequelize instance. In the generated application via:
  const sequelize = context.app.get('sequelizeClient');
  const { permissions } = sequelize.models;
  context.params.sequelize = {
    raw: false,
    include: [permissions]
  }
  return context;
}

[daffl]

If you have an idea how it could be improved, a pull request is definitely welcome. Although the docs for params.sequelize does mention that it should be done in a before hook. Maybe an example that shows the hook being registered might make it more clear.

Closing this issue since the problem has been solved.