rescheme

Rescheme

JSON Rescheme project will help you change any JSON structure using declarative syntax.

Install

$ npm install rescheme --save

Usage

var rescheme = require('rescheme');
var output_json = rescheme(original_json, scheme_json);

How it works ?

1. Give it a JSON original_json
2. Define in what scheme you want your data back extracted from the original JSON scheme_json
3. Get new JSON in your defined scheme output_json

Lets see some examples

We will use this JSON:

{
    book:  {
        name: "JavaScript: The Good Parts",
        publisher: "O'Reilly Media",
        author: {
            name: "Douglas Crockford",
            website: "http://crockford.com"
        },
        translations: ["English", "Spanish"]
    }
}

Here is one example schema we can build:

{
    book_name: "book.name",
    book_details: {
        author_name: "book.author.name",
        author_details: ["book.author.name", "book.author.website"],
        contact: "book.author.website",
        details: {
            book_publisher: "book.publisher",
            langs: "book.translations"
        }
    }
}

The result will be :

{
    book_name: "JavaScript: The Good Parts",
    book_details:{
        author_name: "Douglas Crockford",
        author_details: [ "Douglas Crockford", "http://crockford.com" ],
        contact: "http://crockford.com",
        details:{
            book_publisher: "O'Reilly Media",
            langs: [ "English", "Spanish" ]
        }
    }
}

Note that:

1. We define all the keys in our scheme (for example book_name)
2. We define the our new structure: (for example book_details as object and author_details as array)
3. The values for each key is the information we want to extract and replace from our original JSON (for example "book.name")

How about arrays ?

Here is the previous JSON, but this time we have 2 books in array

[
    {
        name: "JavaScript: The Good Parts",
        publisher: "O'Reilly Media",
        author: {
            name: "Douglas Crockford",
            website: "http://crockford.com"
        },
        translations: ["English", "Spanish"]
    },
    {
        name: "JavaScript: The Definitive Guide",
        publisher: "O'Reilly Media",
        author: {
            name: "David Flanagan",
            website: "https://github.com/davidflanagan"
        },
        translations: ["French", "English"]
    }
]

Our scheme is pretty simple:

{
    name: "name",
    author: "author.name"
}

The result will be:

[
    {
        name: 'JavaScript: The Good Parts',
        author: 'Douglas Crockford'
    },
    {
        name: 'JavaScript: The Definitive Guide',
        author: 'David Flanagan'
    }
]

Author

Alex Kolarski ([e-mail])

License

(The MIT License)

Copyright (c) 2015 Alex Kolarski <[e-mail]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.