@modernpoacher/halacious 6.3.1 → 7.0.0

package/examples/api-root.cjs

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

package/examples/auto-namespace.cjs

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modernpoacher/halacious",
-  "version": "6.3.1",
+  "version": "7.0.0",
   "description": "A HAL processor for Hapi",
   "keywords": [
     "HAL",
@@ -37,33 +37,30 @@
     "prepare": "husky install"
   },
   "dependencies": {
-    "@hapi/boom": "9.1.0",
-    "@hapi/hoek": "9.0.4",
-    "@hapi/joi": "15.1.1",
+    "@hapi/boom": "^10.0.1",
+    "@hapi/hoek": "^11.0.4",
     "async": "^3.2.5",
+    "joi": "^17.12.0",
     "lodash": "^4.17.21",
     "marked": "^11.1.1",
-    "marked-gfm-heading-id": "^3.1.2",
-    "marked-mangle": "^1.1.6",
     "negotiator": "^0.6.3",
     "pug": "^3.0.2",
     "urijs": "^1.19.11",
-    "url-template": "2.0.8"
+    "url-template": "^3.1.1"
   },
   "devDependencies": {
     "@babel/core": "^7.23.7",
     "@babel/eslint-parser": "^7.23.3",
-    "@hapi/hapi": "18.4.1",
-    "@hapi/vision": "6.0.1",
+    "@hapi/hapi": "^21.3.2",
+    "@hapi/vision": "^7.0.3",
     "@sequencemedia/sinon-chai": "^0.0.6",
-    "@typescript-eslint/eslint-plugin": "5.61.0",
-    "@typescript-eslint/parser": "5.61.0",
+    "@typescript-eslint/eslint-plugin": "^6.19.0",
+    "@typescript-eslint/parser": "^6.19.0",
     "chai": "^5.0.0",
-    "chai-string": "^1.5.0",
     "cross-env": "^7.0.3",
     "eslint": "^8.56.0",
     "eslint-config-standard": "^17.1.0",
-    "eslint-config-standard-with-typescript": "35.0.0",
+    "eslint-config-standard-with-typescript": "^43.0.0",
     "husky": "^8.0.3",
     "mocha": "^10.2.0",
     "sinon": "^17.0.1"

package/src/plugin.mjs

@@ -1,6 +1,6 @@
-import joi from '@hapi/joi'
-import boom from '@hapi/boom'
-import hoek from '@hapi/hoek'
+import joi from 'joi'
+import * as boom from '@hapi/boom'
+import * as hoek from '@hapi/hoek'
 import _ from 'lodash'
 import fs from 'node:fs'
 import path from 'node:path'
@@ -10,17 +10,11 @@ import async from 'async'
 import {
   marked
 } from 'marked'
-import {
-  mangle
-} from 'marked-mangle'
-import {
-  gfmHeadingId
-} 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 * as urlTemplate from 'url-template'
+import Negotiator from 'negotiator'
+import URITemplate from 'urijs/src/URITemplate.js'
 import IAM from '#where-am-i'
 import RepresentationFactory from './representation.mjs'
 
@@ -61,7 +55,7 @@ function flattenContext (template, ctx) {
   return result
 }
 
-const optionsSchema = {
+const optionsSchema = joi.object({
   absolute: joi.boolean().default(false),
   host: joi.string(),
   hostname: joi.string(),
@@ -84,7 +78,7 @@ const optionsSchema = {
   mediaTypes: joi.array().items(joi.string()).single().default([HAL_MIME_TYPE]),
   requireHalJsonAcceptHeader: joi.boolean().default(false),
   marked: joi.object().default({})
-}
+})
 
 /**
  * Registers plugin routes and an "api" object with the hapi server.
@@ -92,20 +86,19 @@ const optionsSchema = {
  * @param opts
  * @param next
  */
-const plugin = {
+export const plugin = {
   pkg: PKG,
 
   async register (server, opts) {
     let settings = opts
 
-    joi.validate(opts, optionsSchema, (err, validated) => {
-      if (err) throw err
+    const { error, value } = optionsSchema.validate(opts)
 
-      settings = validated
-    })
+    if (error) throw error
+
+    settings = value
 
-    marked.use(gfmHeadingId(settings.marked))
-    marked.use(mangle(settings.marked))
+    marked.setOptions(settings.marked)
 
     const selection = settings.apiServerLabel
       ? server.select(settings.apiServerLabel)
@@ -118,7 +111,7 @@ const plugin = {
     internals.byPrefix = {}
 
     // valid rel options
-    internals.relSchema = {
+    internals.relSchema = joi.object({
       // the rel name, will default to file's basename if available
       name: joi.string().required(),
 
@@ -130,17 +123,19 @@ const plugin = {
 
       // returns the qualified name of the rel (including the namespace)
       qname: joi
-        .func()
+        .function()
         .optional()
         .default(function () {
-          return this.namespace
-            ? util.format('%s:%s', this.namespace.prefix, this.name)
-            : this.name
+          return function () {
+            return this.namespace
+              ? util.format('%s:%s', this.namespace.prefix, this.name)
+              : this.name
+          }
         })
-    }
+    }).unknown()
 
     // valid namespace options
-    internals.nsSchema = {
+    internals.nsSchema = joi.object({
       // the namespace name, will default to dir basename if available
       name: joi.string().required(),
 
@@ -158,38 +153,44 @@ const plugin = {
 
       // validates and adds a rel to the namespace
       rel: joi
-        .func()
+        .function()
         .optional()
-        .default(function (rel) {
-          this.rels = this.rels || {}
+        .default(function () {
+          return function (rel) {
+            this.rels = this.rels || {}
+
+            if (_.isString(rel)) rel = { name: rel }
 
-          if (_.isString(rel)) rel = { name: rel }
+            rel.name =
+              rel.name ||
+              (rel.file && path.basename(rel.file, path.extname(rel.file)))
+
+            const { error, value } = internals.relSchema.validate(rel)
+            if (error) throw error
 
-          rel.name =
-            rel.name ||
-            (rel.file && path.basename(rel.file, path.extname(rel.file)))
-          joi.validate(rel, internals.relSchema, (err, value) => {
-            if (err) throw err
             rel = value
-          })
-          this.rels[rel.name] = rel
-          rel.namespace = this
-          return this
+
+            this.rels[rel.name] = rel
+            rel.namespace = this
+            return this
+          }
         }),
 
       // synchronously scans a directory for rel descriptors and adds them to the namespace
       scanDirectory: joi
-        .func()
+        .function()
         .optional()
-        .default(function (directory) {
-          const files = fs.readdirSync(directory)
-          files.forEach(function (file) {
-            this.rel({ file: path.join(directory, file) })
-          }, this)
+        .default(function () {
+          return function (directory) {
+            const files = fs.readdirSync(directory)
+            files.forEach(function (file) {
+              this.rel({ file: path.join(directory, file) })
+            }, this)
 
-          return this
+            return this
+          }
         })
-    }
+    })
 
     internals.filter = function (request) {
       return _.get(request.route.settings, 'plugins.hal', true)
@@ -214,13 +215,14 @@ const plugin = {
         namespace.name || (namespace.dir && path.basename(namespace.dir))
 
       // fail fast if the namespace isnt valid
-      joi.validate(namespace, internals.nsSchema, (err, value) => {
-        if (err) throw err
-        namespace = value
+      const { error, value } = internals.nsSchema.validate(namespace)
 
-        // would prefer to initialize w/ joi but it keeps a static reference to the value for some reason
-        namespace.rels = {}
-      })
+      if (error) throw error
+
+      namespace = value
+
+      // would prefer to initialize w/ joi but it keeps a static reference to the value for some reason
+      namespace.rels = {}
 
       if (namespace.dir) {
         namespace.scanDirectory(namespace.dir)
@@ -321,11 +323,10 @@ const plugin = {
         }
       } else {
         // could be globally qualified (e.g. 'self')
-        joi.validate({ name: namespace }, internals.relSchema, (err, value) => {
-          if (err) throw err
+        const { error, value } = internals.relSchema.validate({ name: namespace })
+        if (error) throw error
 
-          rel = value
-        })
+        rel = value
       }
 
       return rel
@@ -377,8 +378,8 @@ const plugin = {
     }
 
     // see http://tools.ietf.org/html/draft-kelly-json-hal-06#section-8.2
-    internals.linkSchema = {
-      href: joi.alternatives([joi.string(), joi.func()]).required(),
+    internals.linkSchema = joi.object({
+      href: joi.alternatives([joi.string(), joi.function()]).required(),
       templated: joi.boolean().optional(),
       title: joi.string().optional(),
       type: joi.string().optional(),
@@ -386,7 +387,7 @@ const plugin = {
       name: joi.string().optional(),
       profile: joi.string().optional(),
       hreflang: joi.string().optional()
-    }
+    })
 
     internals.isRelativePath = function (path) {
       return (
@@ -406,10 +407,10 @@ const plugin = {
         _.isFunction(link) || _.isString(link)
           ? { href: link }
           : hoek.clone(link)
-      joi.validate(link, internals.linkSchema, (err, value) => {
-        if (err) throw err
-        link = value
-      })
+      const { error, value } = internals.linkSchema.validate(link)
+
+      if (error) throw error
+      link = value
 
       if (
         relativeTo &&
@@ -505,7 +506,7 @@ const plugin = {
       const resolveHref = function (href, ctx) {
         return _.isFunction(href)
           ? href(rep, ctx)
-          : urlTemplate.parse(href).expand(flattenContext(href, ctx))
+          : urlTemplate.parseTemplate(href).expand(flattenContext(href, ctx))
       }
 
       try {
@@ -855,19 +856,17 @@ const plugin = {
      * @param filterFn
      */
     internals.setFilter = function (filterFn) {
-      joi.validate(filterFn, joi.func(), (err) => {
-        if (err) throw err
+      const { error } = joi.function().validate(filterFn)
+      if (error) throw error
 
-        internals.filter = filterFn
-      })
+      internals.filter = filterFn
     }
 
     internals.setUrlBuilder = function (urlBuilder) {
-      joi.validate(urlBuilder, joi.func(), (err) => {
-        if (err) throw err
+      const { error } = joi.function().validate(urlBuilder)
+      if (error) throw error
 
-        internals.buildUrl = urlBuilder
-      })
+      internals.buildUrl = urlBuilder
     }
 
     const api = {
@@ -983,7 +982,3 @@ const plugin = {
     server.ext('onPreStart', internals.preStart)
   }
 }
-
-export {
-  plugin
-}

package/src/representation.mjs

@@ -1,5 +1,5 @@
 import _ from 'lodash'
-import hoek from '@hapi/hoek'
+import * as hoek from '@hapi/hoek'
 import URI from 'urijs'
 
 const templatedRE = /{*}/

package/test/plugin.spec.mjs

@@ -6,9 +6,10 @@ import hapi from '@hapi/hapi'
 import vision from '@hapi/vision'
 import sinon from 'sinon'
 import sinonChai from '@sequencemedia/sinon-chai'
-import chaiString from 'chai-string'
 import halacious from '#halacious'
-import { plugin } from '#halacious/plugin'
+import {
+  plugin
+} from '#halacious/plugin'
 import _ from 'lodash'
 import url from 'url'
 import IAM from '#where-am-i'
@@ -16,9 +17,8 @@ import IAM from '#where-am-i'
 const should = chai.should()
 
 chai.use(sinonChai)
-chai.use(chaiString)
 
-const PLUGIN = '@modernpoacher/halacious'
+const PLUGIN = 'halacious' // '@modernpoacher/halacious'
 
 describe('Halacious Plugin', () => {
   let server
@@ -35,7 +35,7 @@ describe('Halacious Plugin', () => {
 
   xit('should have a registration function', () => {
     plugin.should.have.property('register')
-    plugin.register.should.be.a('Function')
+    plugin.register.should.be.a('function')
   })
 
   it('should expose a namespace function', (done) => {
@@ -47,7 +47,7 @@ describe('Halacious Plugin', () => {
         } = server
 
         plugin.should.have.property('namespaces')
-        plugin.namespace.should.be.a('Function')
+        plugin.namespace.should.be.a('function')
       })
       .then(done)
       .catch(done)
@@ -70,7 +70,7 @@ describe('Halacious Plugin', () => {
         namespace.should.have.property('name', 'mycompany')
         namespace.should.have.property('prefix', 'mco')
         namespace.should.have.property('rel')
-        namespace.rel.should.be.a('Function')
+        namespace.rel.should.be.a('function')
       })
       .then(done)
       .catch(done)
@@ -1456,7 +1456,7 @@ describe('Halacious Plugin', () => {
           .property('_links')
           .that.has.a.property('self')
           .that.has.a.property('href')
-          .that.endsWith('/people/100?donotbreakthis=true')
+          .and.satisfies(href => href.endsWith('/people/100?donotbreakthis=true'))
       })
       .then(done)
       .catch(done)

package/test/representation.spec.mjs

@@ -5,30 +5,28 @@ import RepresentationFactory from '#halacious/representation'
 
 const should = chai.should()
 
-const PLUGIN = '@modernpoacher/halacious'
+const PLUGIN = 'halacious' // '@modernpoacher/halacious'
 
 describe('Representation Factory', () => {
   let server
-  let plugin
   let representationFactory
 
-  beforeEach((done) => {
+  beforeEach(async () => {
     server = hapi.server({ port: 9191 })
 
-    server
-      .register(halacious)
-      .then(() => {
-        plugin = server.plugins[PLUGIN]
-        representationFactory = new RepresentationFactory(plugin)
-        done()
-      })
-      .catch((err) => {
-        done(err)
-      })
+    await server.register(halacious)
+
+    const {
+      plugins: {
+        [PLUGIN]: plugin
+      }
+    } = server
+
+    representationFactory = new RepresentationFactory(plugin)
   })
 
-  afterEach((done) => {
-    server.stop().then(done).catch(done)
+  afterEach(async () => {
+    await server.stop()
   })
 
   it('should create a new representation', () => {
@@ -210,6 +208,12 @@ describe('Representation Factory', () => {
   })
 
   it('should link to a registered rel', () => {
+    const {
+      plugins: {
+        [PLUGIN]: plugin
+      }
+    } = server
+
     plugin.namespaces
       .add({ name: 'mycompany', prefix: 'mco' })
       .rel({ name: 'boss' })
@@ -236,6 +240,12 @@ describe('Representation Factory', () => {
   })
 
   it('should include a curie link', () => {
+    const {
+      plugins: {
+        [PLUGIN]: plugin
+      }
+    } = server
+
     plugin.namespaces
       .add({ name: 'mycompany', prefix: 'mco' })
       .rel({ name: 'boss' })
@@ -249,6 +259,12 @@ describe('Representation Factory', () => {
   })
 
   it('should embed an entity', () => {
+    const {
+      plugins: {
+        [PLUGIN]: plugin
+      }
+    } = server
+
     plugin.namespaces
       .add({ name: 'mycompany', prefix: 'mco' })
       .rel({ name: 'boss' })
@@ -284,6 +300,12 @@ describe('Representation Factory', () => {
   })
 
   it('should embed an empty array', () => {
+    const {
+      plugins: {
+        [PLUGIN]: plugin
+      }
+    } = server
+
     plugin.namespaces
       .add({ name: 'mycompany', prefix: 'mco' })
       .rel({ name: 'boss' })
@@ -312,6 +334,12 @@ describe('Representation Factory', () => {
   })
 
   it('should use top level curie link', () => {
+    const {
+      plugins: {
+        [PLUGIN]: plugin
+      }
+    } = server
+
     plugin.namespaces
       .add({ name: 'mycompany', prefix: 'mco' })
       .rel({ name: 'boss' })