npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

hal-serializer

v1.2.0

Published

Framework agnostic HAL serializer.

Downloads

338

Readme

hal-serializer

Build Status Coverage Status npm

A Node.js framework agnostic library for serializing your data to HAL compliant responses (a specification for building APIs in JSON).

Installation

npm install --save hal-serializer

Documentation

Register

var HALSerializer = require('hal-serializer');
var Serializer = new HALSerializer();
Serializer.register(type, options);

Available options :

  • blacklist (optional): An array of blacklisted attributes. Default = [].
  • whitelist (optional): An array of whitelisted attributes. Default = [].
  • links (optional): An object or a function that describes the links inside data. (If it is an object values can be string or function).
  • topLevelMeta (optional): An object or a function that describes the links inside data. (If it is an object values can be string or function).
  • topLevelLinks (optional): An object or a function that describes the links inside data. (If it is an object values can be string or function).
  • embedded (optional): An object defining some embedded resources
    • embedded: The property in data to use as an embedded resource
      • type: The type to use for serializing the embedded resource (type need to be register)
      • schema (optional): A custom schema for serializing the embedded resource. If no schema define, it use the default one.
      • links (optional): An object or a function that describes the links for the relationship. (If it is an object values can be string or function).
  • convertCase (optional): Case conversion for serializing data. Value can be : kebab-case, snake_case, camelCase

Usage

input data (can be a simple object or an array of objects)

// Data
var data = {
  id: "1",
  title: "HAL Hypertext Application Language",
  body: "The shortest article. Ever.",
  created: "2015-05-22T14:56:29.000Z",
  updated: "2015-05-22T14:56:28.000Z",
  author: {
    id: "1",
    firstName: "Kaley",
    lastName: "Maggio",
    email: "[email protected]",
    age: "80",
    gender: "male"
  },
  tags: ["1", "2"],
  photos: ["ed70cf44-9a34-4878-84e6-0c0e4a450cfe", "24ba3666-a593-498c-9f5d-55a4ee08c72e", "f386492d-df61-4573-b4e3-54f6f5d08acf"],
  comments: [{
    _id: "1",
    body: "First !",
    created: "2015-08-14T18:42:16.475Z"
  }, {
    _id: "2",
    body: "I Like !",
    created: "2015-09-14T18:42:12.475Z"
  }, {
    _id: "3",
    body: "Awesome",
    created: "2015-09-15T18:42:12.475Z"
  }]
}

Register your resources types :

var HALSerializer = require('hal-serializer');
var Serializer = new HALSerializer();

// Register 'article' type
Serializer.register('article', {
  blacklist: ['updated'], // An array of blacklisted attributes. Default = []
  links: function(data) { // An object or a function that describes links.
    return {
      self: {
        href: '/articles/' + data.id
      }
    }
  },
  embedded: { // An object defining some embedded resources.
    author: {
      type: 'people', // The type of the embedded resource
      links: function(data) {
        return {
          href: '/peoples/' + data.id
        }
      }
    },
    tags: {
      type: 'tag'
    },
    photos: {
      type: 'photo'
    },
    comments: {
      type: 'comment',
      schema: 'only-body' // A custom schema
    }
  },
  topLevelMeta: function(extraOptions) { // An object or a function that describes top level meta.
    return {
      count: extraOptions.count
    }
  },
  topLevelLinks: { // An object or a function that describes top level links.
    self: {
      href: '/articles'
    }
  }
});

// Register 'people' type
Serializer.register('people', {
  links: {
    self: function(data) {
      return {
        href: '/peoples/' + data.id
      };
    }
  }
});

// Register 'tag' type
Serializer.register('tag', {});

// Register 'photo' type
Serializer.register('photo', {});

// Register 'comment' type with a custom schema
Serializer.register('comment', 'only-body', {
  whitelist: ['body'],
});

Serialize it with the corresponding resource type, data and optional extra options :

// Synchronously (blocking)
Serializer.serialize('article', data, {count: 2});

// Asynchronously (non-blocking)
Serializer.serializeAsync('article', data, {count: 2})
  .then((result) => {
    ...
  });

The output data will be :

{
  "_links": {
    "self": {
      "href": "/articles/1"
    },
    "author": {
      "href": "/peoples/1"
    }
  },
  "count": 2,
  "id": "1",
  "title": "HAL Hypertext Application Language",
  "body": "The shortest article. Ever.",
  "created": "2015-05-22T14:56:29.000Z",
  "_embedded": {
    "author": {
      "_links": {
        "self": {
          "href": "/peoples/1"
        }
      },
      "id": "1",
      "firstName": "Kaley",
      "lastName": "Maggio",
      "email": "[email protected]",
      "age": "80",
      "gender": "male"
    },
    "comments": [
      {
        "body": "First !"
      },
      {
        "body": "I Like !"
      },
      {
        "body": "Awesome"
      }
    ]
  }
}

Deserialize

input data (can be an simple object or an array of objects)

var data = {
  _links: {
    self: {
      href: '/articles/1'
    },
    author: {
      href: '/peoples/1'
    }
  },
  id: '1',
  title: 'HAL Hypertext Application Language',
  body: 'The shortest article. Ever.',
  created: '2015-05-22T14:56:29.000Z',
  _embedded: {
    author: {
      _links: {
        self: {
          href: '/peoples/1'
        }
      },
      id: '1',
      firstName: 'Kaley',
      lastName: 'Maggio',
      email: '[email protected]',
      age: '80',
      gender: 'male'
    }
  }
};

Serializer.deserialize('article', data);
{
  "id": "1",
  "title": "HAL Hypertext Application Language",
  "body": "The shortest article. Ever.",
  "created": "2015-05-22T14:56:29.000Z",
  "author": {
    "id": "1",
    "firstName": "Kaley",
    "lastName": "Maggio",
    "email": "[email protected]",
    "age": "80",
    "gender": "male"
  }
}

Custom schemas

It is possible to define multiple custom schemas for a resource type :

Serializer.register(type, 'customSchema', options);

If you want to apply this schema on the primary data :

Serializer.serialize('article', data, 'customSchema', {count: 2});

Or if you want to apply this schema on a embedded resource, define this schema on embedded resource options with the key schema :

Example :

embedded: {
  comments: {
    type: 'comment'
    schema: 'customSchema'
  }
}

Requirements

hal-serializer use ECMAScript 2015 (ES6) features supported natively by Node.js 4 and above (ECMAScript 2015 (ES6) | Node.js). Make sure that you have Node.js 4+ or above.

License

MIT