@modernpoacher/halacious 6.2.8 → 6.3.0

package/examples/{api-root.js → api-root.cjs}

@@ -2,7 +2,7 @@ const hapi = require('@hapi/hapi')
 const vision = require('@hapi/vision')
 const halacious = require('#halacious')
 
-const { name: PLUGIN } = require('#halacious/package.json')
+const PLUGIN = '@modernpoacher/halacious'
 
 async function init () {
   const server = hapi.server({ port: 8080 })

package/examples/{auto-namespace.js → auto-namespace.cjs}

@@ -4,7 +4,7 @@ const hapi = require('@hapi/hapi')
 const vision = require('@hapi/vision')
 const halacious = require('#halacious')
 
-const { name: PLUGIN } = require('#halacious/package.json')
+const PLUGIN = '@modernpoacher/halacious'
 
 async function init () {
   const server = hapi.server({ port: 8080 })

package/index.mjs

@@ -0,0 +1 @@
+export * as default from './src/index.mjs'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modernpoacher/halacious",
-  "version": "6.2.8",
+  "version": "6.3.0",
   "description": "A HAL processor for Hapi",
   "keywords": [
     "HAL",
@@ -8,11 +8,11 @@
     "hypermedia",
     "HATEOAS"
   ],
-  "main": "./index.js",
-  "types": "./types/index.d.ts",
-  "author": "Brad Leupen",
+  "type": "module",
+  "main": "./src/index.mjs",
+  "author": "Jonathan Perry <modernpoacher@modernpoacher.com> (Modern Poacher Limited)",
   "contributors": [
-    "Jonathan Perry <modernpoacher@modernpoacher.com> (Modern Poacher Limited)"
+    "Brad Leupen"
   ],
   "license": "MIT",
   "engines": {
@@ -27,7 +27,7 @@
     "url": "https://github.com/modernpoacher/halacious/issues"
   },
   "scripts": {
-    "lint": "eslint .",
+    "lint": "eslint . --ext .mjs --ext .cjs --ext .mts --ext .cts",
     "lint:fix": "npm run lint -- --fix",
     "test": "cross-env NODE_ENV=test mocha test",
     "prepare": "husky install"
@@ -69,12 +69,11 @@
     "sinon-chai": "^3.7.0"
   },
   "imports": {
-    "#halacious/package.json": "./package.json",
-    "#halacious/lib/*": "./lib/*.js",
-    "#halacious": "./lib/index.js"
+    "#halacious/*": "./src/*.mjs",
+    "#halacious": "./src/index.mjs",
+    "#where-am-i": "./where-am-i.mjs"
   },
   "exports": {
-    "./lib": "./lib/*.js",
-    ".": "./lib/index.js"
+    ".": "./src/index.mjs"
   }
 }

package/{types/index.d.ts → src/index.d.mts}

@@ -1,4 +1,4 @@
-declare namespace halacious {
+declare namespace HalaciousTypes {
   export interface Collection {
     uid: string
   }
@@ -27,4 +27,4 @@ declare namespace halacious {
   }
 }
 
-export = halacious
+export default HalaciousTypes

package/src/index.mjs

@@ -0,0 +1,2 @@
+
+export * as default from './plugin.mjs'

package/{lib/plugin.js → src/plugin.mjs}

@@ -1,34 +1,34 @@
-const joi = require('@hapi/joi')
-const boom = require('@hapi/boom')
-const hoek = require('@hapi/hoek')
-const _ = require('lodash')
-const fs = require('fs')
-const path = require('path')
-const pug = require('pug')
-const util = require('util')
-const async = require('async')
-const {
+import joi from '@hapi/joi'
+import boom from '@hapi/boom'
+import hoek from '@hapi/hoek'
+import _ from 'lodash'
+import fs from 'node:fs'
+import path from 'node:path'
+import pug from 'pug'
+import util from 'util'
+import async from 'async'
+import {
   marked
-} = require('marked')
-const {
+} from 'marked'
+import {
   mangle
-} = require('marked-mangle')
-const {
+} from 'marked-mangle'
+import {
   gfmHeadingId
-} = require('marked-gfm-heading-id')
-const urlTemplate = require('url-template')
-const Negotiator = require('negotiator')
-const URITemplate = require('urijs/src/URITemplate')
-const url = require('url')
-const URI = require('urijs')
-
-const {
-  RepresentationFactory
-} = require('./representation')
+} from 'marked-gfm-heading-id'
+import urlTemplate from 'url-template'
+import Negotiator from 'negotiator'
+import URITemplate from 'urijs/src/URITemplate.js'
+import url from 'url'
+import URI from 'urijs'
+import IAM from '#where-am-i'
+import RepresentationFactory from './representation.mjs'
 
 const HAL_MIME_TYPE = 'application/hal+json'
 
-const re = /{([^{}]+)}|([^{}]+)/g
+const REG = /{([^{}]+)}|([^{}]+)/g
+
+const PKG = JSON.parse(fs.readFileSync(path.join(IAM, './package.json')))
 
 function reach (object, path) {
   const parts = path ? path.split('.') : []
@@ -51,7 +51,7 @@ function flattenContext (template, ctx) {
   let arr
   const result = {}
 
-  while ((arr = re.exec(template)) !== null) {
+  while ((arr = REG.exec(template)) !== null) {
     if (arr[1]) {
       const value = reach(ctx, arr[1])
       result[arr[1]] = value && value.toString()
@@ -92,8 +92,8 @@ const optionsSchema = {
  * @param opts
  * @param next
  */
-exports.plugin = {
-  pkg: require('../package'),
+const plugin = {
+  pkg: PKG,
 
   async register (server, opts) {
     let settings = opts
@@ -964,7 +964,7 @@ exports.plugin = {
           engines: {
             jade: pug
           },
-          path: path.join(__dirname, '../views'),
+          path: path.join(IAM, './views'),
           isCached: false
         })
         server.route({
@@ -983,3 +983,7 @@ exports.plugin = {
     server.ext('onPreStart', internals.preStart)
   }
 }
+
+export {
+  plugin
+}

package/src/representation.mjs

@@ -0,0 +1,272 @@
+
+import _ from 'lodash'
+import hoek from '@hapi/hoek'
+import URI from 'urijs'
+
+const templatedRE = /{*}/
+
+/**
+ * A HAL wrapper interface around an entity. Provides an api for adding new links and recursively embedding child
+ * entities.
+ *
+ * @param factory
+ * @param self
+ * @param entity
+ * @param root
+ * @constructor
+ */
+export 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
+   */
+  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}
+   */
+  prop (name, value) {
+    this._props[name] = value
+    return this
+  }
+
+  /**
+   * 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}
+   */
+  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 {{}}
+   */
+  toJSON () {
+    // 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
+      }
+    })
+
+    // merge in any extra properties
+    _.assign(payload, this._props)
+
+    const embeddedKeys = _.keys(this._embedded)
+    if (embeddedKeys.length > 0) {
+      payload._embedded = {}
+
+      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] = []
+        }
+
+        JSON.stringify(self._embedded[embedKey], (key, value) => {
+          if (!key) {
+            return value
+          }
+
+          payload._embedded[embedKey][key] = value
+        })
+      })
+    }
+
+    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)
+    }
+
+    // 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
+  }
+
+  /**
+   * 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()
+  }
+
+  /**
+   * 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)
+  }
+
+  /**
+   * 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)
+    }
+
+    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]
+    }
+
+    return 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
+  }
+
+  /**
+   * 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)
+  }
+}
+
+/**
+ * Responsible for creating all hal entities, top level or embedded, needed for a hapi request
+ * @param halacious a reference to the plugin api
+ * @param request a hapi request object
+ * @constructor
+ */
+export 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}
+   */
+  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)
+  }
+}
+
+export default RepresentationFactory

package/test/{plugin.spec.js → plugin.spec.mjs}

@@ -1,22 +1,24 @@
-const path = require('path')
+import path from 'path'
 
-const chai = require('chai')
+import chai from 'chai'
+
+import hapi from '@hapi/hapi'
+import vision from '@hapi/vision'
+import sinon from 'sinon'
+import sinonChai from 'sinon-chai'
+import chaiString from 'chai-string'
+import halacious from '#halacious'
+import { plugin } from '#halacious/plugin'
+import _ from 'lodash'
+import url from 'url'
+import IAM from '#where-am-i'
 
 const should = chai.should()
-const hapi = require('@hapi/hapi')
-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 _ = require('lodash')
-const url = require('url')
 
 chai.use(sinonChai)
 chai.use(chaiString)
 
-const { name: PLUGIN } = require('#halacious/package.json')
+const PLUGIN = '@modernpoacher/halacious'
 
 describe('Halacious Plugin', () => {
   let server
@@ -346,7 +348,7 @@ describe('Halacious Plugin', () => {
         } = server
 
         namespaces.add({
-          dir: path.resolve(__dirname, 'rels/mycompany'),
+          dir: path.join(IAM, './test/rels/mycompany'),
           prefix: 'mco'
         })
       })
@@ -373,7 +375,7 @@ describe('Halacious Plugin', () => {
         } = server
 
         const namespace = plugin.namespaces.add({
-          dir: path.resolve(__dirname, 'rels/mycompany'),
+          dir: path.join(IAM, './test/rels/mycompany'),
           prefix: 'mco'
         })
 
@@ -402,7 +404,7 @@ describe('Halacious Plugin', () => {
         } = server
 
         plugin.namespaces.add({
-          dir: path.resolve(__dirname, 'rels/mycompany'),
+          dir: path.join(IAM, './test/rels/mycompany'),
           prefix: 'mco'
         })
       })

package/test/{representation.spec.js → representation.spec.mjs}

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

package/where-am-i.mjs

@@ -0,0 +1,9 @@
+import {
+  fileURLToPath
+} from 'node:url'
+
+import {
+  dirname
+} from 'node:path'
+
+export default dirname(fileURLToPath(import.meta.url))

package/index.js

@@ -1,3 +0,0 @@
-//
-
-module.exports = require('./lib')

package/lib/index.js

@@ -1,2 +0,0 @@
-
-module.exports = require('./plugin')

package/lib/representation.js

@@ -1,268 +0,0 @@
-
-const _ = require('lodash')
-const hoek = require('@hapi/hoek')
-
-const URI = require('urijs')
-const templatedRE = /{*}/
-
-/**
- * A HAL wrapper interface around an entity. Provides an api for adding new links and recursively embedding child
- * entities.
- *
- * @param factory
- * @param self
- * @param entity
- * @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
-}
-
-/**
- * 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 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
-}
-
-/**
- * Merges an object's properties into the custom properties collection.
- * @param obj
- */
-Representation.prototype.merge = function (obj) {
-  hoek.merge(this._props, obj)
-}
-
-/**
- * @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
-}
-
-/**
- * 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
-    }
-  })
-
-  // merge in any extra properties
-  _.assign(payload, this._props)
-
-  const embeddedKeys = _.keys(this._embedded)
-  if (embeddedKeys.length > 0) {
-    payload._embedded = {}
-
-    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] = []
-      }
-
-      JSON.stringify(self._embedded[embedKey], (key, value) => {
-        if (!key) {
-          return value
-        }
-
-        payload._embedded[embedKey][key] = value
-      })
-    })
-  }
-
-  return payload
-}
-
-/**
- * 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
-}
-
-/**
- * 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()
-}
-
-/**
- * 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)
-}
-
-/**
- * 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()
-
-  this.curie(rel.namespace)
-
-  if (_.isArray(entity)) {
-    const that = this
-    this._embedded[qname] = []
-    return entity.map((e) => that.embed(originalRel, self, e), this)
-  }
-
-  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]
-  }
-
-  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)
-}
-
-/**
- * Responsible for creating all hal entities, top level or embedded, needed for a hapi request
- * @param halacious a reference to the plugin api
- * @param request a hapi request object
- * @constructor
- */
-function RepresentationFactory (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)
-}
-
-module.exports.RepresentationFactory = RepresentationFactory