@modernpoacher/halacious 6.2.7 → 6.2.9

package/README.md

@@ -42,7 +42,7 @@ yarn add @modernpoacher/halacious --dev
 Register the plugin with the app server
 ```javascript
 const hapi = require('@hapi/hapi');
-const halacious = require('@modernpoacher/halacious');
+const halacious = require('#halacious');
 
 const server = hapi.server({ port: 8080 });
 
@@ -376,7 +376,7 @@ happily let you be lazy but its much better if we do things the Right Way.
 Halacious exposes its api to your Hapi server so that you may configure it at runtime like so:
  ```javascript
 const hapi = require('@hapi/hapi');
-const halacious = require('@modernpoacher/halacious');
+const halacious = require('#halacious');
 
 async function init () {
     await server.register(halacious);
@@ -441,7 +441,7 @@ company's namespace. We can suck all these into the system in one fell swoop:
 
 ```javascript
 const hapi = require('@hapi/hapi');
-const halacious = require('@modernpoacher/halacious');
+const halacious = require('#halacious');
 
 async function init () {
     const server = hapi.server({ port: 8080 });
@@ -472,7 +472,7 @@ configuration option. For example:
 
 ```javascript
 const hapi = require('@hapi/hapi');
-const halacious = require('@modernpoacher/halacious');
+const halacious = require('#halacious');
 
 async function init () {
     const server = hapi.server({ port: 8080 });

package/examples/api-root.js

@@ -1,10 +1,8 @@
-require('module-alias/register')
-
 const hapi = require('@hapi/hapi')
 const vision = require('@hapi/vision')
-const halacious = require('halacious')
+const halacious = require('#halacious')
 
-const { name: PLUGIN } = require('halacious/package.json')
+const { name: PLUGIN } = require('#halacious/package.json')
 
 async function init () {
   const server = hapi.server({ port: 8080 })

package/examples/array-of-links.js

@@ -1,8 +1,6 @@
-require('module-alias/register')
-
 const hapi = require('@hapi/hapi')
 const vision = require('@hapi/vision')
-const halacious = require('halacious')
+const halacious = require('#halacious')
 
 async function init () {
   const server = hapi.server({ port: 8080 })

package/examples/auto-namespace.js

@@ -1,12 +1,10 @@
-require('module-alias/register')
-
 const path = require('path')
 
 const hapi = require('@hapi/hapi')
 const vision = require('@hapi/vision')
-const halacious = require('halacious')
+const halacious = require('#halacious')
 
-const { name: PLUGIN } = require('halacious/package.json')
+const { name: PLUGIN } = require('#halacious/package.json')
 
 async function init () {
   const server = hapi.server({ port: 8080 })

package/examples/functional-href.js

@@ -1,8 +1,6 @@
-require('module-alias/register')
-
 const hapi = require('@hapi/hapi')
 const vision = require('@hapi/vision')
-const halacious = require('halacious')
+const halacious = require('#halacious')
 
 async function init () {
   const server = hapi.server({ port: 8080 })

package/examples/hello-world.js

@@ -1,8 +1,6 @@
-require('module-alias/register')
-
 const hapi = require('@hapi/hapi')
 const vision = require('@hapi/vision')
-const halacious = require('halacious')
+const halacious = require('#halacious')
 
 async function init () {
   const server = hapi.server({ port: 8080 })

package/examples/manual-namespace.js

@@ -1,10 +1,8 @@
-require('module-alias/register')
-
 const hapi = require('@hapi/hapi')
 const vision = require('@hapi/vision')
-const halacious = require('halacious')
+const halacious = require('#halacious')
 
-const { name: PLUGIN } = require('halacious/package')
+const { name: PLUGIN } = require('#halacious/package')
 
 async function init () {
   const server = hapi.server({ port: 8080 })

package/examples/media-types.js

@@ -1,8 +1,6 @@
-require('module-alias/register')
-
 const hapi = require('@hapi/hapi')
 const vision = require('@hapi/vision')
-const halacious = require('halacious')
+const halacious = require('#halacious')
 
 async function init () {
   const server = hapi.server({ port: 8080 })

package/examples/paging.js

@@ -1,12 +1,10 @@
-require('module-alias/register')
-
 const hapi = require('@hapi/hapi')
 const vision = require('@hapi/vision')
 const hoek = require('@hapi/hoek')
 const Uri = require('urijs')
-const halacious = require('halacious')
+const halacious = require('#halacious')
 
-const { name: PLUGIN } = require('halacious/package')
+const { name: PLUGIN } = require('#halacious/package')
 
 const users = []
 

package/examples/programmatic-entity.js

@@ -1,8 +1,6 @@
-require('module-alias/register')
-
 const hapi = require('@hapi/hapi')
 const vision = require('@hapi/vision')
-const halacious = require('halacious')
+const halacious = require('#halacious')
 
 function User (id, firstName, lastName, googlePlusId) {
   this.id = id

package/examples/programmatic-route.js

@@ -1,8 +1,6 @@
-require('module-alias/register')
-
 const hapi = require('@hapi/hapi')
 const vision = require('@hapi/vision')
-const halacious = require('halacious')
+const halacious = require('#halacious')
 
 async function init () {
   const server = hapi.server({ port: 8080 })

package/examples/query-string.js

@@ -1,12 +1,10 @@
-require('module-alias/register')
-
 const path = require('path')
 
 const hapi = require('@hapi/hapi')
 const vision = require('@hapi/vision')
-const halacious = require('halacious')
+const halacious = require('#halacious')
 
-const { name: PLUGIN } = require('halacious/package')
+const { name: PLUGIN } = require('#halacious/package')
 
 async function init () {
   const server = hapi.server({ port: 8080 })

package/examples/simple-embed.js

@@ -1,8 +1,6 @@
-require('module-alias/register')
-
 const hapi = require('@hapi/hapi')
 const vision = require('@hapi/vision')
-const halacious = require('halacious')
+const halacious = require('#halacious')
 
 async function init () {
   const server = hapi.server({ port: 8080 })

package/examples/simple-link.js

@@ -1,8 +1,6 @@
-require('module-alias/register')
-
 const hapi = require('@hapi/hapi')
 const vision = require('@hapi/vision')
-const halacious = require('halacious')
+const halacious = require('#halacious')
 
 async function init () {
   const server = hapi.server({ port: 8080 })

package/index.d.ts

@@ -1,5 +1,6 @@
 declare module '@modernpoacher/halacious' {
   const plugin: object
+
   export {
     plugin
   }

package/lib/representation.js

@@ -15,228 +15,230 @@ const templatedRE = /{*}/
  * @param root
  * @constructor
  */
-function Representation (factory, self, entity, root) {
-  this._halacious = factory._halacious
-  this.factory = factory
-  this.request = factory._request
-  this._root = root || this
-  this.self = self.href
-  this._links = { self }
-  this._embedded = {}
-  this._namespaces = {}
-  this._props = {}
-  this._ignore = {}
-  this.entity = entity
-}
+class Representation {
+  constructor (factory, self, entity, root) {
+    this._halacious = factory._halacious
+    this.factory = factory
+    this.request = factory._request
+    this._root = root || this
+    this.self = self.href
+    this._links = { self }
+    this._embedded = {}
+    this._namespaces = {}
+    this._props = {}
+    this._ignore = {}
+    this.entity = entity
+  }
 
-/**
- * Adds a namespace to the 'curie' link collection. all curies in a response, top level or nested, should be declared
- * in the top level _links collection. a reference '_root' is kept to the top level representation for this purpose
- * @param namespace
- */
-Representation.prototype.curie = function (namespace) {
-  if (namespace && !this._root._namespaces[namespace.prefix]) {
-    this._root._namespaces[namespace.prefix] = namespace
-    this._root._links.curies = this._root._links.curies || []
-    this._root._links.curies.push({
-      name: namespace.prefix,
-      href: `${this._halacious.namespaceUrl(this.request, namespace)}/{rel}`,
-      templated: true
-    })
+  /**
+   * Adds a namespace to the 'curie' link collection. all curies in a response, top level or nested, should be declared
+   * in the top level _links collection. a reference '_root' is kept to the top level representation for this purpose
+   * @param namespace
+   */
+  curie (namespace) {
+    if (namespace && !this._root._namespaces[namespace.prefix]) {
+      this._root._namespaces[namespace.prefix] = namespace
+      this._root._links.curies = this._root._links.curies || []
+      this._root._links.curies.push({
+        name: namespace.prefix,
+        href: `${this._halacious.namespaceUrl(this.request, namespace)}/{rel}`,
+        templated: true
+      })
+    }
   }
-}
 
-/**
- * Adds a custom property to the HAL payload
- * @param {String} name the property name
- * @param {*} value the property value
- * @return {Representation}
- */
-Representation.prototype.prop = function (name, value) {
-  this._props[name] = value
-  return this
-}
+  /**
+   * Adds a custom property to the HAL payload
+   * @param {String} name the property name
+   * @param {*} value the property value
+   * @return {Representation}
+   */
+  prop (name, value) {
+    this._props[name] = value
+    return this
+  }
 
-/**
- * Merges an object's properties into the custom properties collection.
- * @param obj
- */
-Representation.prototype.merge = function (obj) {
-  hoek.merge(this._props, obj)
-}
+  /**
+   * Merges an object's properties into the custom properties collection.
+   * @param prop
+   */
+  merge (prop) {
+    hoek.merge(this._props, prop)
+  }
 
-/**
- * @param {...String || String[]} args properties to ignore
- * @return {Representation}
- */
-Representation.prototype.ignore = function (...args) {
-  const props = _.isArray(args[0]) ? args[0] : args
-  props.forEach(function (prop) {
-    this._ignore[prop] = true
-  }, this)
-  return this
-}
+  /**
+   * @param {...String || String[]} args properties to ignore
+   * @return {Representation}
+   */
+  ignore (...args) {
+    const props = _.isArray(args[0]) ? args[0] : args
+    props.forEach(function (prop) {
+      this._ignore[prop] = true
+    }, this)
+    return this
+  }
 
-/**
- * Prepares the representation for JSON serialization.
- * @return {{}}
- */
-Representation.prototype.toJSON = function () {
-  // initialize the json entity
-  const payload = { _links: this._links }
-  const self = this
-
-  // copy all target properties in the entity using JSON.stringify(). if the entity has a .toJSON() implementation,
-  // it will be called. properties on the ignore list will not be copied
-  const { entity } = this
-  JSON.stringify(entity, (key, value) => {
-    if (!key) {
-      return value
-    }
-    if (!self._ignore[key]) {
-      payload[key] = value
-    }
-  })
+  /**
+   * Prepares the representation for JSON serialization.
+   * @return {{}}
+   */
+  toJSON () {
+    // initialize the json entity
+    const payload = { _links: this._links }
+    const self = this
 
-  // merge in any extra properties
-  _.assign(payload, this._props)
+    // copy all target properties in the entity using JSON.stringify(). if the entity has a .toJSON() implementation,
+    // it will be called. properties on the ignore list will not be copied
+    const { entity } = this
+    JSON.stringify(entity, (key, value) => {
+      if (!key) {
+        return value
+      }
+      if (!self._ignore[key]) {
+        payload[key] = value
+      }
+    })
 
-  const embeddedKeys = _.keys(this._embedded)
-  if (embeddedKeys.length > 0) {
-    payload._embedded = {}
+    // merge in any extra properties
+    _.assign(payload, this._props)
 
-    const self = this
-    embeddedKeys.forEach((embedKey) => {
-      if (self._embedded[embedKey] instanceof Representation) {
-        payload._embedded[embedKey] = {}
-      } else if (self._embedded[embedKey] instanceof Array) {
-        payload._embedded[embedKey] = []
-      }
+    const embeddedKeys = _.keys(this._embedded)
+    if (embeddedKeys.length > 0) {
+      payload._embedded = {}
 
-      JSON.stringify(self._embedded[embedKey], (key, value) => {
-        if (!key) {
-          return value
+      const self = this
+      embeddedKeys.forEach((embedKey) => {
+        if (self._embedded[embedKey] instanceof Representation) {
+          payload._embedded[embedKey] = {}
+        } else if (self._embedded[embedKey] instanceof Array) {
+          payload._embedded[embedKey] = []
         }
 
-        payload._embedded[embedKey][key] = value
+        JSON.stringify(self._embedded[embedKey], (key, value) => {
+          if (!key) {
+            return value
+          }
+
+          payload._embedded[embedKey][key] = value
+        })
       })
-    })
+    }
+
+    return payload
   }
 
-  return payload
-}
+  /**
+   * Creates a new link and adds it to the _links collection
+   * @param rel
+   * @param link
+   * @return {{} || []} the new link
+   */
+  link (originalRel, link) {
+    const rel = this._halacious.rel(originalRel)
+    const qname = rel.qname()
+
+    if (_.isArray(link)) {
+      const that = this
+      this._links[qname] = []
+      return link.map((l) => that.link(originalRel, l), this)
+    }
 
-/**
- * Creates a new link and adds it to the _links collection
- * @param rel
- * @param link
- * @return {{} || []} the new link
- */
-Representation.prototype.link = function (originalRel, link) {
-  const rel = this._halacious.rel(originalRel)
-  const qname = rel.qname()
-
-  if (_.isArray(link)) {
-    const that = this
-    this._links[qname] = []
-    return link.map((l) => that.link(originalRel, l), this)
+    // adds the namespace to the top level curie list
+    this.curie(rel.namespace)
+
+    link = this._halacious.link(link, this._links.self.href)
+    link.templated = templatedRE.test(link.href) ? true : undefined
+    // e.g. 'mco:rel'
+    if (!this._links[qname]) {
+      this._links[qname] = link
+    } else if (_.isArray(this._links[qname])) {
+      this._links[qname].push(link)
+    } else {
+      this._links[qname] = [this._links[qname], link]
+    }
+
+    return link
   }
 
-  // adds the namespace to the top level curie list
-  this.curie(rel.namespace)
-
-  link = this._halacious.link(link, this._links.self.href)
-  link.templated = templatedRE.test(link.href) ? true : undefined
-  // e.g. 'mco:rel'
-  if (!this._links[qname]) {
-    this._links[qname] = link
-  } else if (_.isArray(this._links[qname])) {
-    this._links[qname].push(link)
-  } else {
-    this._links[qname] = [this._links[qname], link]
+  /**
+   * Resolves a relative path against the representation's self href
+   * @param relativePath
+   * @return {*}
+   */
+  resolve (relativePath) {
+    return new URI(relativePath)
+      .absoluteTo(`${this._links.self.href}/`)
+      .toString()
   }
 
-  return link
-}
+  /**
+   * Returns the path to a named route (specified by the plugins.hal.name configuration parameter), expanding any supplied
+   * path parameters.
+   * @param {String} routeName the route's name
+   * @param {{}=} params for expanding templated urls
+   * @return {*}
+   */
+  route (routeName, params) {
+    return this._halacious.route(routeName, params)
+  }
 
-/**
- * Resolves a relative path against the representation's self href
- * @param relativePath
- * @return {*}
- */
-Representation.prototype.resolve = function (relativePath) {
-  return new URI(relativePath)
-    .absoluteTo(`${this._links.self.href}/`)
-    .toString()
-}
+  /**
+   * Wraps an entity into a HAL representation and adds it to the _embedded collection
+   * @param {String} rel the rel name
+   * @param {String || {}} self an href or link object for the entity
+   * @param {{} || []} entity an object to wrap
+   * @return {entity || []}
+   */
+  embed (originalRel, self, entity) {
+    const rel = this._halacious.rel(originalRel)
+    const qname = rel.qname()
+
+    this.curie(rel.namespace)
+
+    if (_.isArray(entity)) {
+      const that = this
+      this._embedded[qname] = []
+      return entity.map((e) => that.embed(originalRel, self, e), this)
+    }
 
-/**
- * Returns the path to a named route (specified by the plugins.hal.name configuration parameter), expanding any supplied
- * path parameters.
- * @param {String} routeName the route's name
- * @param {{}=} params for expanding templated urls
- * @return {*}
- */
-Representation.prototype.route = function (routeName, params) {
-  return this._halacious.route(routeName, params)
-}
+    self = this._halacious.link(self, this._links.self.href)
 
-/**
- * Wraps an entity into a HAL representation and adds it to the _embedded collection
- * @param {String} rel the rel name
- * @param {String || {}} self an href or link object for the entity
- * @param {{} || []} entity an object to wrap
- * @return {entity || []}
- */
-Representation.prototype.embed = function (originalRel, self, entity) {
-  const rel = this._halacious.rel(originalRel)
-  const qname = rel.qname()
+    const embedded = this.factory.create(entity, self, this._root)
 
-  this.curie(rel.namespace)
+    if (!this._embedded[qname]) {
+      this._embedded[qname] = embedded
+    } else if (_.isArray(this._embedded[qname])) {
+      this._embedded[qname].push(embedded)
+    } else {
+      this._embedded[qname] = [this._embedded[qname], embedded]
+    }
 
-  if (_.isArray(entity)) {
-    const that = this
-    this._embedded[qname] = []
-    return entity.map((e) => that.embed(originalRel, self, e), this)
+    return embedded
   }
 
-  self = this._halacious.link(self, this._links.self.href)
-
-  const embedded = this.factory.create(entity, self, this._root)
-
-  if (!this._embedded[qname]) {
-    this._embedded[qname] = embedded
-  } else if (_.isArray(this._embedded[qname])) {
-    this._embedded[qname].push(embedded)
-  } else {
-    this._embedded[qname] = [this._embedded[qname], embedded]
+  /**
+   * Convenience method for embedding an array of entities
+   * @param rel
+   * @param self
+   * @param entities
+   * @return {Representation}
+   */
+  embedCollection (rel, self, entities) {
+    entities = _.isArray(entities) ? entities : [entities]
+    entities.forEach(function (entity) {
+      this.embed(rel, hoek.clone(self), entity)
+    }, this)
+    return this
   }
 
-  return embedded
-}
-
-/**
- * Convenience method for embedding an array of entities
- * @param rel
- * @param self
- * @param entities
- * @return {Representation}
- */
-Representation.prototype.embedCollection = function (rel, self, entities) {
-  entities = _.isArray(entities) ? entities : [entities]
-  entities.forEach(function (entity) {
-    this.embed(rel, hoek.clone(self), entity)
-  }, this)
-  return this
-}
-
-/**
- * Configures a representation using a configuration object such as those found in route definitions
- * @param config
- * @param callback
- */
-Representation.prototype.configure = function (config, callback) {
-  this._halacious.configureRepresentation(this, config, callback)
+  /**
+   * Configures a representation using a configuration object such as those found in route definitions
+   * @param config
+   * @param callback
+   */
+  configure (config, callback) {
+    this._halacious.configureRepresentation(this, config, callback)
+  }
 }
 
 /**
@@ -245,24 +247,26 @@ Representation.prototype.configure = function (config, callback) {
  * @param request a hapi request object
  * @constructor
  */
-function RepresentationFactory (halacious, request) {
-  this._halacious = halacious
-  this._request = request
-}
+class RepresentationFactory {
+  constructor (halacious, request) {
+    this._halacious = halacious
+    this._request = request
+  }
 
-/**
- * Creates a new hal representation out of a javascript object
- * @param {{}=} entity the entity to wrap with a representation. an empty object is created by default
- * @param {String || {}=} self the self href or link object. The request's path is used by default
- * @param {Representation} root a pointer to the top level representation for adding curied links
- * should be expanded into absolute urls
- * @return {Representation}
- */
-RepresentationFactory.prototype.create = function (entity, self, root) {
-  entity = entity || {}
-  self = self || (this._request && this._request.path)
-  self = this._halacious.link(self)
-  return new Representation(this, self, entity, root)
+  /**
+   * Creates a new hal representation out of a javascript object
+   * @param {{}=} entity the entity to wrap with a representation. an empty object is created by default
+   * @param {String || {}=} self the self href or link object. The request's path is used by default
+   * @param {Representation} root a pointer to the top level representation for adding curied links
+   * should be expanded into absolute urls
+   * @return {Representation}
+   */
+  create (entity, self, root) {
+    entity = entity || {}
+    self = self || (this._request && this._request.path)
+    self = this._halacious.link(self)
+    return new Representation(this, self, entity, root)
+  }
 }
 
 module.exports.RepresentationFactory = RepresentationFactory

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modernpoacher/halacious",
-  "version": "6.2.7",
+  "version": "6.2.9",
   "description": "A HAL processor for Hapi",
   "keywords": [
     "HAL",
@@ -9,10 +9,9 @@
     "HATEOAS"
   ],
   "main": "./index.js",
-  "types": "./types/index.d.ts",
-  "author": "Brad Leupen",
+  "author": "Jonathan Perry <modernpoacher@modernpoacher.com> (Modern Poacher Limited)",
   "contributors": [
-    "Jonathan Perry <modernpoacher@modernpoacher.com> (Modern Poacher Limited)"
+    "Brad Leupen"
   ],
   "license": "MIT",
   "engines": {
@@ -54,7 +53,6 @@
     "@babel/eslint-parser": "^7.21.8",
     "@hapi/hapi": "18.4.1",
     "@hapi/vision": "6.0.1",
-    "babel-loader": "^9.1.2",
     "chai": "^4.3.7",
     "chai-string": "^1.5.0",
     "cross-env": "^7.0.3",
@@ -66,11 +64,16 @@
     "eslint-plugin-promise": "^6.1.1",
     "husky": "^8.0.3",
     "mocha": "^10.2.0",
-    "module-alias": "^2.2.2",
     "sinon": "^15.1.0",
     "sinon-chai": "^3.7.0"
   },
-  "_moduleAliases": {
-    "halacious": "."
+  "imports": {
+    "#halacious/package.json": "./package.json",
+    "#halacious/lib/*": "./lib/*.js",
+    "#halacious": "./lib/index.js"
+  },
+  "exports": {
+    "./lib": "./lib/*.js",
+    ".": "./lib/index.js"
   }
 }

package/test/plugin.spec.js

@@ -1,5 +1,3 @@
-require('module-alias/register')
-
 const path = require('path')
 
 const chai = require('chai')
@@ -10,15 +8,15 @@ const vision = require('@hapi/vision')
 const sinon = require('sinon')
 const sinonChai = require('sinon-chai')
 const chaiString = require('chai-string')
-const halacious = require('halacious')
-const { plugin } = require('halacious/lib/plugin')
+const halacious = require('#halacious')
+const { plugin } = require('#halacious/lib/plugin')
 const _ = require('lodash')
 const url = require('url')
 
 chai.use(sinonChai)
 chai.use(chaiString)
 
-const { name: PLUGIN } = require('halacious/package')
+const { name: PLUGIN } = require('#halacious/package.json')
 
 describe('Halacious Plugin', () => {
   let server

package/test/representation.spec.js

@@ -1,14 +1,12 @@
-require('module-alias/register')
-
 const chai = require('chai')
 
 const should = chai.should()
 const hapi = require('@hapi/hapi')
-const halacious = require('halacious')
+const halacious = require('#halacious')
 
-const { RepresentationFactory } = require('halacious/lib/representation')
+const { RepresentationFactory } = require('#halacious/lib/representation')
 
-const { name: PLUGIN } = require('halacious/package')
+const { name: PLUGIN } = require('#halacious/package.json')
 
 describe('Representation Factory', () => {
   let server