Deserialising object attributes

[andrewn]

I'm working with an API that returns an attribute that is an object e.g. interest:

{
  "data": [
    {
      "type": "accounts",
      "attributes": {
        "accrued_interest": 0,
        "interest": {
          "rate_terms": "FIXED",
          "charge_frequency": "ANNUALIZED",
        }
      },
    }
  ]
}

I'm using ES6 to create a JSORM model:

const Account = Base.extend({
  static: {
    jsonapiType: 'accounts'
  },
  attrs: {
    accruedInterest: attr(),
    interest: attr(),
  }
});

(Base is a JSORMBase I've extended to centralise the API endpoint and Auth config.)

Is there a way for JSORM to parse the interest attribute, so that model.interest.rateTerms would be available? In that example above, it's only available as model.interest.rate_terms.

I've also tried interest: attr({ type: Interest }) where Interest is a class I've created to contain this data.

A pointer to the recommended way of doing this would be very helpful. Thanks!

[richmolj]

Hey @andrewn! We haven't really touched key casing for nested objects (I've been content with underscores so far). But I don't think it would be difficult to add.

We have methods Model.serializeKey and Model.deserializeKey for going to/from the server. When we assign attributes to the model instance, deserializeKey is applied here. When going to the server, the transformation is applied here. I think we could enhance both these areas applying the same logic for nested objects. Then we'd just need to add a test, probably around here.

I can get to this when I have time, but it's not a short-term priority. I'd be down for merging a PR if you'd like.

[andrewn]

Thanks for the response. I don't have time in the short-term to work on this but maybe one day!

[richmolj]

Thanks @andrewn - we'll keep it in our backlog and see when we can get to it.

/cc @wadetandy just for a heads up