Model Relationships

[ferpintado]

How would this work with relationship to other models i.e

const CompanySchema = new mongoose.Schema({
  name: {
    type: String,
    unique: false,
    required: true,
  },
  admins:[{
    type: mongoose.Schema.Types.ObjectId,
    ref: 'User',
  }]
});

The plugin returns the first level model without problem the second one is returned as plain JSON

{
    "data": {
        "type": "Companies",
        "id": "605f6d5d4e0394e86bc2ee00",
        "attributes": {
            "name": "Hermann - Schumm",
           "admins": [
                {
                    "isActivated": true,
                    "roles": [],
                    "companies": [
                        "605f6d5d4e0394e86bc2ee00"
                    ],
                    "_id": "605f738c689affeb0a640c68",
                    "firstName": "Fernando",
                    "lastName": "Pintado",
                    "email": "[email protected]",
                    "profilePicture": "+213550569497",
                    "createdBy": "605f6d5c4e0394e86bc2edf5",
                    "createdAt": "2021-03-27T18:03:56.707Z",
                    "updatedAt": "2021-03-27T18:03:56.707Z",
                    "__v": 0
                }
            ]
        }
    }
}                        

My initial idea is to have to .serialize for every model.

const query = await Company.findById(id).populate('admins');
const extended = {
    ...query,
    admins: User.serialize(query ? query.admins : null),
};
const json = Company.serialize(extended);
return json;

Unfortunately it did not work as expected. Any thoughts?

[carsondarling]

This package is a light wrapper around https://github.com/SeyZ/jsonapi-serializer, so it's best to look at the options for specifying the attributes from that package.

In your case, you can add options when you attach the plugin to your CompanySchema like so:

const jsonapi = require('@carsondarling/mongoose-jsonapi');

CompanySchema.plugin(jsonapi, {
  serializer: {
    admins: {
      ref: 'id',
      attributes: ['firstName', 'lastName'], // You'll have to customize this to serialize what you want
    },

    // Specify the JSONAPI type for the admins attribute only
    typeForAttribute(attribute) {
      if (attribute === 'admins') return 'User';
      return undefined;
    },
  },
});

That should give you a decent starting point, and digging into the options from SeyZ/jsonapi-serializer will give you a better idea of what's possible.

[ferpintado]

I'll give it a try.

Thanks for your prompt reply.