sugo-hub/lib/helpers/api_format.js

Hub server of SUGOS

/**
 * Format data to conform JSON-API
 * @module ApiFormat
 * @see http://jsonapi.org/format/
 */
'use strict'

const { pluralize } = require('inflection')
const { snakecase } = require('stringcase')

/** @lends ApiFormat */
module.exports = Object.assign(exports, {
  /**
   * Get type of resource
   * @param Entity
   * @returns {string}
   */
  resourceType (Entity) {
    let { $name } = Entity
    return pluralize(snakecase($name))
  },
  /**
   * Create resource identifier of JSON-API
   * @param Entity
   * @param entity
   */
  resourceIdentifier (Entity, entity) {
    let type = exports.resourceType(Entity)
    return { type, id: entity.key }
  },
  /**
   * Create resource data
   * @param Entity
   * @param entity
   */
  resource (Entity, entity) {
    let identifier = exports.resourceIdentifier(Entity, entity)
    return Object.assign(identifier, { attributes: entity })
  }
})