Relationships order is dropped

[germanp]

The method getRelationships() returns an object without taking into account the original ordering given in the array.

[mrichar1]

Hi,

Thanks for the issue. You're right that the implementation of pinia-jsonapi doesn't attempt to preserve order in relationships. Since pinia-jsonapi converts all jsonapi data to nested objects, it would be relatively difficult to preserve order without using other mechanisms to do so, since object ordering is not guaranteed in JS. But this does not conflict with the jsonapi specification, which does not consider order in relationships by default: https://jsonapi.org/format/#document-resource-object-linkage

Note: The spec does not impart meaning to order of resource identifier objects in linkage arrays of to-many relationships, although implementations may do that. Arrays of resource identifier objects may represent ordered or unordered relationships, and both types can be mixed in one response object.

Of course if there is a way to implement ordered relationships without detracting from the accessibility of the current object syntax or overloading the relative simplicity of the current implementation, I would be happy to consider a PR.

Alternatively the simplest way to work round this if order is important is to use preserveJSON and then use the order in the original jsonapi as an index when iterating over the relationship objects. (Or, if you are in control of the backend schema, add extra metadata to record order information within the relationship data).