id not defined by a single column about json-api-serializer HOT 10 CLOSED

Nice addition! I just solved a similar problem with a composite key just by adding a virtual field to an objection.js model. But having it in the serializer is good approach, too.

from json-api-serializer.

Not supported yet... nobody is working on it.
PR is welcome !

from json-api-serializer.

I also notice I could have a _id column that just does loads this format before sending it in. What do you think?

from json-api-serializer.

@chamini2, Interesting addition 👍
json-api-serializer already does a lot of transformations on data, so why not on id.

PR is welcome !

Thanks

from json-api-serializer.

Hey, @danivek, I was thinking about this and one thing that worries me is how the deserialize would work?

from json-api-serializer.

@chamini2 You're right, deserialize needs to have an utility function to unconvertId. It could be also useful even if id is defined as a key for id on data.

E.g. if id on input data is an int, to be spec compliant, json-api-serialiser serialize id with toString().

Serializer.register('article', {
  id: '_id', 
  }
});

const jsonapi_payload = Serializer.serialize('article', {'_id': 123 });

jsonapi_payload = {
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "article",
    "id": "123" // serialized with toString()
  }
}

But when we deserialize it, it's not possible actually to convert it back to int.

Serializer.deserialize('article', jsonapi_payload);

{
 "_id": "123"
}

So, adding a function to unconvertId is not surprising.

from json-api-serializer.

Ok, what about:

Serializer.register('coment', {
  id: {
    serialize(attributes) { return `${attributes.user_id},${attributes.article_id}`; },
    deserialize(id) {
      const [user_id, article_id] = id.split(',');
      return { user_id, article_id };
    }
  }
})

Or could be

Serializer.register('coment', {
  id: {
    serialize(attributes) { return `${attributes.user_id},${attributes.article_id}`; },
    deserialize(id, attributes) {
      const [user_id, article_id] = id.split(',');
      attributes.user_id = user_id;
      attributes.article_id = article_id;
      return attributes;
    }
  }
})

I'm not sure which is better and why. I would really like your input and think about it well before making a decision.

from json-api-serializer.

Something like this is fine for me:

Serializer.register('coment', {
  id: {
    serialize(data) { // data looks like {"user_id": "1", "article_id": "2", ... }
      return `${data.user_id},${data.article_id}`; // should return a string
    },
    deserialize(data) { // data looks like {"type": "coment", "id": "1,2", attributes: { ... }}
      const [user_id, article_id] = data.id.split(',');
      return { user_id, article_id }; // Should return an object wich will be assign to deserialized data
    }
  }
})

from json-api-serializer.

Cool!

from json-api-serializer.

Is this feature supported? When I tried the above, I am getting the following error:

"ValidationError: child "id" fails because ["id" must be a string]"

from json-api-serializer.