Links property for relationships

[m-bodmer]

If I have code such as the following:

new JSONAPISerializer('users', data, {
  apiEndpoint: 'http://localhost:3000/api/users',
  attributes: ['firstName', 'lastName', 'books'],
  books: {
    ref: '_id',
    attributes: ['title', 'ISBN']
  }
}).then(function (users) {  
  // `users` here are JSON API compliant. 
});

{
  "links": {
    "self": "http://localhost:3000/api/users"
  },
  "data": [{
    "type": "users",
    "id": "1",
    "attributes": {
      "firstName": "Sandro",
      "lastName": "Munda"
    },
    "relationships": {
      "books": {
        // Is there add a links attribute such as this one for relationships?
        "links": {
          "self": "http://example.com/users/1/relationships/books",
          "related": "http://example.com/users/1/books"
        },
        "data": [
          { "type": "books", "id": "1" },
          { "type": "books", "id": "2" }
        ]
      }
    }
  }

Is there a way I can add the links attribute for compound documents?

[SeyZ]

Hi @m-bodmer,

Not yet. I'm working on it. I'll notice you when available (help are welcome too 😄)

[SeyZ]

@m-bodmer I implemented the links feature (top-level and compound documents). Check the example here:

https://github.com/SeyZ/jsonapi-serializer#compount-document

new JSONAPISerializer('users', data, {
  links: { self: 'http://localhost:3000/api/users' },
  attributes: ['firstName', 'lastName', 'books'],
  books: {
    ref: '_id',
    attributes: ['title', 'isbn'],
    'links': {
      "self": 'http://example.com/users/1/relationships/books',
      "related": function (book) {
        return 'http://example.com/users/1/books/' + book.id;
      }
    }
  }
}).then(function (users) {  
  // `users` here are JSON API compliant. 
});

If you need more. don't hesitate to comment. Feedbacks are welcome ;)

[m-bodmer]

Great work! One thing is missing, the links attribute should be within the data return object as per the JSON API specs here: http://jsonapi.org/format/#document-compound-documents

This is what I get now:

{  
   data: [ ],
   included: [],
   links:{  
      self: "http://localhost:3000/collections/"
   }
}

What it should be:

{  
   data: [ 
       links: {  
           self: "http://localhost:3000/collections/"
       }
   ],
   included: []
}

[m-bodmer]

Here is a sample input object I want to serialize:

{ id: 229,
  title: 'Awesome blog post',
  subcategory:
   { self: 'http://localhost:3000/posts/229/relationships/subcategory',
     related: 'http://localhost:3000/posts/229/subcategory',
     type: 'subcategory',
     id: 124 },
  comments:
   { self: 'http://localhost:3000/posts/229/relationships/comments',
     related: 'http://localhost:3000/posts/229/comments',
     links: [
      {
         type: "comments",
         id: "2289"
      }, {
         type: "comments",
         id: "3263"
      } ]

The serialized output should look something like:

"data" : [...],
"included": [{
    "type": "comments",
    "id": "2289",
    "attributes": {
      "body": "First post!"
    },
    "links": {
      "self": "http://example.com/comments/2289"
    }
  }

Notice there is also an array of comments within my comments relationship. Not sure if this is already supported or something you are working on as well.

[SeyZ]

25f8eed and 071e361 should fix your issue. Thanks for your request.

Version 1.0.1 available on NPM ;)

[SeyZ]

I will close this issue as soon as you confirm that all works well about links.

[m-bodmer]

Top level links now work great, as do links for objects directly nested within data. However, there is one more issue, and one note:

If I am passing in the following data

{
    id: 229,
    title: 'Awesome blog post',
    subcategory: {
        self: 'http://localhost:3000/posts/229/relationships/subcategory',
        type: 'subcategory',
        id: 124
    },
    comments: {
        self: 'http://localhost:3000/posts/229/relationships/comments',
        links: [{
            type: "comments",
            id: "2289"
        }, {
            type: "comments",
            id: "3263"
        }]
    }
}

and my jsonapi-serializer config looks like

JSONAPISerializerConfig = {
    resourceType: resourceType,
    topLevelLinks: {
        self: apiEndpoint
    },
    links: {
        self: function(post) {
            return apiEndpoint + post.id;
        }
    },
    attributes: ['title', 'subcategories', 'classes'],
    subcategories: {
        ref: 'id',
        attributes: ['id'],
        links: {
            self: function(subcategory) {
                // Another note, jsonapi-serializer should produce these links on its own
                return config.domain + '/subcategories/' + subcategory.id;
            }
        }
    },
    comments: {
        ref: 'id',
        attributes: ['id'],
        links: {
            self: function(comment) {
                return apiEndpoint + comment.id;
            }
        }
    }
};

My output should look like

data:[{
    type: "posts",
    id: "207",
    attributes: {
        title: "Awesome post title",
    },
    links: {
        self: "http://localhost:3000/posts/207"
    },
    relationships: {
        subcategories: {
           // This links object is missing
           links: {
                // Note: This self link could be produced by jsonapi-serializer
                self: "http://localhost:3000/posts/207/relationships/subcategories"
            },
            data: {
                type: "subcategories",
                id: "118"
            }
        },
included:[{
   type: "subcategories",
   id: "118",
   links: {
     // Note: This self link could be produced by jsonapi-serializer 
     self: "http://localhost:3000/subcategories/118"
   }
}

Does that make sense?

[SeyZ]

@m-bodmer Yes, it makes sense 👍

I implement the concept of "relationship links" in this commit e8a086c

Thought?