jsonapi2simple's Introduction

jsonapi2simple

Utility to allow conversion between simple JSON data and JSONAPI service based structure.

Usage

The conversion process will allow you to convert JSONAPI structures into more managable JSON. This tool was built for allowing front-end applications to work with a simplified structure during view/editing and then transform back to JSONAPI for server interactions.

var converter = require('jsonapi2simple');
var objectInfo = {
  'type': 'articles',
  'baseUrl': '/api',
  'relates': {
    'author': 'people'
  }
};
var simpleContent = converter.toSimple({
  'data': {
    'id': '4f32132',
    'type': 'articles',
    'title': 'This Tool is Easy',
    'links': {
      'self': '/api/articles/4f32132'
    }
  }
}, objectInfo);
/*
simpleContent now contains:
{
  'id': '4f32132',
  'title': 'This Tool is Easy'
}
*/
var jsonApiContent = converter.toJsonApi(simple, objectInfo);
/*
jsonApiContent now contains:
{
  'data': {
    'id': '4f32132',
    'type': 'articles',
    'title': 'This Tool is Easy',
    'links': {
      'self': '/api/articles/4f32132'
    }
  }
}
*/

This can also be used for more complex structures. Usually with a front-end application the code that is interacting with the server will contain some meta data about the request such as its type and the resource's relationships to other resources.

For more complex structures or other use cases please refer to the included tests.

jsonapi2simple's People

Contributors

Stargazers

Watchers

jsonapi2simple's Issues

Bring up to spec with RC3 of jsonapi

Ensure that jsonapi JSON that is generated passes RC3 specs.

Make tests pass for general usage

Just ensure that current tests pass.

Handle Camel Cases

I wanted to request that ability to handle full camel case support for links. So if I have an id like orderTemplateId it converts to a link of order_template.

Here is an example test case for this:

describe('camel cased relationships', function () {
    var info = {
        "type": "order_template_images",
        "baseUrl": "/api",
        "relates": {
            "order_template": "order_templates",
            "order": "orders",
            "image": "images"
        }
    };

    var apiData = {
        "data": {
            "id": 1,
            "type": "order_template_images",
            "links": {
                "order": {
                    "linkage": {
                        "id": 3,
                        "type": "orders"
                    }
                },
                "order_template": {
                    "linkage": {
                        "id": 4,
                        "type": "order_templates"
                    }
                },
                "image": {
                    "linkage": {
                        "id": 2,
                        "type": "images"
                    }
                }
            }
        }
    };

    var simpleData = {
        "id": "1"
        "imageId": 2
        "orderId": 3
        "orderTemplateId": 4
    };


    it('should convert jsonapi data to simple', function (done) {
        var result = transform.toSimple(apiData);
        expect(result).to.eql(simpleData);
        done();
    });
    it('should convert simple data to jsonapi', function (done) {
        var result = transform.toJsonApi(simpleData, info);
        expect(result).to.eql(apiData);
        done();
    });
});