json-views: a simple DSL for defining JSON views

What is a json-view? A json-view allows you to map internal objects to external views.

Why use json-views

There are two common reasons for using json-views, consistency and security. By using views we ensure consistency to how objects are presented. Since attributes are whitelisted, this also increases security by limiting the chance of accidental internal value exposure.

Basic Example

The following example simply creates a new object that lacks the "password" field.

var user = {
  firstName: 'First',
  lastName: 'Last',
  email: '[email protected]',
  password: 'password'
};

views.describe('user', function () {
    this.allow([ 'firstName', 'lastName', 'email' ]);
    this.deny('password');
});

var results = views.view('user', user);

results === {
  firstName: 'First',
  lastName: 'Last',
  email: '[email protected]'  
}

Allowing and Denying

JSON serializers works as a combination whitelist/blacklist for object attributes where attributes must first be this.allow()'ed. this.deny() will always take priority in cases where an attribute is both allowed and denied.

var user = {
  firstName: 'First',
  lastName: 'Last',
  email: '[email protected]',
  password: 'password',
  address: {
    street: '1234 Example',
    city: 'Indianapolis',
    state: 'IN'
  }
};

views.describe('user.address', function() {
  this.allow('state');
});

views.describe('user', function() {
  this.allow([ 'firstName', 'lastName', 'email' ]);
  this.deny('password');
  this.reference('address', 'user.address');
  this.transform(function(obj) { return obj.firstName + ' ' + obj.lastName }, { as: 'fullName' });
  this.transform('fullName', function(obj) { return obj.firstName + ' ' + obj.lastName });
});

var results = views.view('user', user);

results === {
  firstName: 'First',
  lastName: 'Last',
  email: '[email protected]',
  address: {
    state: 'IN'
  }
}

var results = views.view('user', user);

results === {
  firstName: 'First',
  lastName: 'Last',
  email: '[email protected]'  
}

Nested Objects

Serializers can also be nested using this.reference().

var user = {
  firstName: 'First',
  lastName: 'Last',
  email: '[email protected]',
  password: 'password',
};

views.describe('user.address', function() {
  this.allow('state');
});

views.describe('user', function() {
    this.allow([ 'firstName', 'lastName', 'email', 'address' ]);
    this.deny('password');
    this.reference('address', 'user.address');
});

var results = views.view('user', user);

results === {
  firstName: 'First',
  lastName: 'Last',
  email: '[email protected]',
  address: {
    state: 'IN'
  }
}

Renaming Keys