Goku

Transform & serialize to simple JS objects

Goku takes simple descriptors and transforms + serializes complex JS objects into simple JSON objects.

Features:

• recursion
• es6 support (class name based serialization)
• field aliases
• serialization groups

Sample

// descriptor in user-descriptor.json
{
    // aliases
    number: { as: 'id' },
    // always serialized
    firstName: true,
    lastName: true,
    // not serialized by default
    email: [ 'details' ],
    createdAt: [ 'details' ],
    children: [ 'details' ]
};

const user = new User({
    number: 1,
    firstName: 'Jane',
    lastName: 'Doe',
    email: '[email protected]',
    createdAt: new Date(),
    children: [ child1, child2 ]
});

goku.serialize(user);
// --› {
//      id: 1,
//      firstName: 'Jane',
//      lastName: 'Doe'
//  }

goku.serialize(user, ['details']);
// --› {
//      id: 1,
//      firstName: 'Jane',
//      lastName: 'Doe',
//      email: '[email protected]',
//      createdAt: [ Date ],
//      children: [
//          {...},
//          {...}
//      ]
//  }

Usage

Installation

$ npm install goku

Then

// ES6
import Goku from 'goku';
// ES5
var Goku = require('goku');

Using in an ES6 project

require('babel/register')({
    stage: 1,
    ignore: /node_modules\/(?!goku)/
})

Descriptors

Defining and registering your descriptors

• direct registration

goku.registerDescriptor('User', {
    firstName: true,
    lastName: true
});
goku.serialize(user);

• json files

// in user-descriptor.json
{
    "firstName": true,
    "lastName": true
}

goku.registerDescriptor('User', require('user-descriptor.json'));
goku.serialize(user);

• js files

// in user-descriptor.js
export default {
    firstName: true,
    lastName: true
}

goku.registerDescriptor('User', require('./user-descriptor'));
goku.serialize(user);

Descriptor syntax

• always serialized

{
    firstName: true
}

• conditional group based serialization

{
    firstName: [ 'details' ]
}

• aliased serialization

{
    firstName: {
        as: 'first'
    }
}

• mixed

{
    firstName: {
        as: 'first',
        groups: [ 'details' ]
    }
}

Recipes

Rest APIs with Express + Goku

// initialize goku
const goku = new Goku();
goku.registerDescriptor('User', ...);
goku.registerDescriptor('Invoice', ...);

// middlewares for serialization

function groups(...data) {
    return function(req, res, next) {
        req.groups = data;
        next();
    };
}

server.use(function(req, res, next) {
    res.goku = function(data) {
        return res.json(goku.serialize(data, req.groups));
    }
    next();
});

function list(req, res, next) {
    const users = ...;
    res.goku(users);
}

function read(req, res, next) {
    const user = ...;
    res.goku(user);
}

router.route('/users')
    .get([ list ]);

router.route('/users/:id')
    .get([ groups('details'), read ]);

Contributions

gulp watch
gulp test

# this module is written in ES6 - so it has to be transpiled
# before being published to NPM

npm publish