@modernpoacher/halacious 7.0.1 → 7.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modernpoacher/halacious",
-  "version": "7.0.1",
+  "version": "7.0.3",
   "description": "A HAL processor for Hapi",
   "keywords": [
     "HAL",
@@ -53,7 +53,7 @@
     "@babel/eslint-parser": "^7.23.3",
     "@hapi/hapi": "^21.3.2",
     "@hapi/vision": "^7.0.3",
-    "@modernpoacher/hooks": "^1.0.456",
+    "@modernpoacher/hooks": "^1.0.457",
     "@sequencemedia/sinon-chai": "^0.0.6",
     "@typescript-eslint/eslint-plugin": "^6.19.0",
     "@typescript-eslint/parser": "^6.19.0",
@@ -61,7 +61,7 @@
     "cross-env": "^7.0.3",
     "eslint": "^8.56.0",
     "eslint-config-standard": "^17.1.0",
-    "eslint-config-standard-with-typescript": "^43.0.0",
+    "eslint-config-standard-with-typescript": "^43.0.1",
     "husky": "^8.0.3",
     "mocha": "^10.2.0",
     "sinon": "^17.0.1"

package/examples/api-root.cjs

@@ -1,89 +0,0 @@
-const hapi = require('@hapi/hapi')
-const vision = require('@hapi/vision')
-const halacious = require('#halacious')
-
-const PLUGIN = 'halacious' // '@modernpoacher/halacious'
-
-async function init () {
-  const server = hapi.server({ port: 8080 })
-
-  await server.register(vision)
-
-  await server.register({ plugin: halacious, options: { absolute: true } })
-
-  const namespace = server.plugins[PLUGIN].namespaces.add({
-    name: 'mycompany',
-    description: 'My Companys namespace',
-    prefix: 'mco'
-  })
-  namespace.rel({ name: 'users', description: 'a collection of users' })
-  namespace.rel({ name: 'user', description: 'a single user' })
-  namespace.rel({ name: 'widgets', description: 'a collection of widgets' })
-  namespace.rel({ name: 'widget', description: 'a single widget' })
-
-  server.route({
-    method: 'get',
-    path: '/users',
-    config: {
-      handler () {
-        return {}
-      },
-      plugins: {
-        hal: {
-          api: 'mco:users'
-        }
-      }
-    }
-  })
-
-  server.route({
-    method: 'get',
-    path: '/users/{userId}',
-    config: {
-      handler () {
-        return {}
-      },
-      plugins: {
-        hal: {
-          api: 'mco:user'
-        }
-      }
-    }
-  })
-
-  server.route({
-    method: 'get',
-    path: '/widgets',
-    config: {
-      handler () {
-        return {}
-      },
-      plugins: {
-        hal: {
-          api: 'mco:widgets'
-        }
-      }
-    }
-  })
-
-  server.route({
-    method: 'get',
-    path: '/widgets/{widgetId}',
-    config: {
-      handler () {
-        return {}
-      },
-      plugins: {
-        hal: {
-          api: 'mco:widget'
-        }
-      }
-    }
-  })
-
-  await server.start()
-
-  console.log('Server started at %s', server.info.uri)
-}
-
-init()

package/examples/array-of-links.cjs

@@ -1,68 +0,0 @@
-const hapi = require('@hapi/hapi')
-const vision = require('@hapi/vision')
-const halacious = require('#halacious')
-
-async function init () {
-  const server = hapi.server({ port: 8080 })
-
-  await server.register(vision)
-
-  await server.register(halacious)
-
-  server.route({
-    method: 'get',
-    path: '/employees/{id}',
-    config: {
-      id: 'employee.lookup',
-      handler (req, next) {
-        next(req.params)
-      }
-    }
-  })
-
-  server.route({
-    method: 'get',
-    path: '/departments/{id}',
-    config: {
-      handler (req) {
-        return {
-          id: req.params.id,
-          employees: [
-            { id: 100, name: 'Tom' },
-            { id: 101, name: 'Dick' },
-            { id: 102, name: 'Harry' }
-          ]
-        }
-      },
-      plugins: {
-        hal: {
-          prepare (rep, next) {
-            const employees = rep.entity.employees
-
-            // adding multiple links with the same rel will create an array of links in the payload
-
-            // link by route id
-            rep.link(
-              'mco:employee',
-              rep.route('employee.lookup', employees[0])
-            )
-
-            // or by relative path
-            rep.link('mco:employee', `../../employees/${employees[1].id}`)
-
-            // or by absolute path
-            rep.link('mco:employee', `/employees/${employees[2].id}`)
-
-            next()
-          }
-        }
-      }
-    }
-  })
-
-  await server.start()
-
-  console.log('Server started at %s', server.info.uri)
-}
-
-init()

package/examples/auto-namespace.cjs

@@ -1,48 +0,0 @@
-const path = require('path')
-
-const hapi = require('@hapi/hapi')
-const vision = require('@hapi/vision')
-const halacious = require('#halacious')
-
-const PLUGIN = 'halacious' // '@modernpoacher/halacious'
-
-async function init () {
-  const server = hapi.server({ port: 8080 })
-
-  await server.register(vision)
-
-  await server.register(halacious)
-
-  server.plugins[PLUGIN].namespaces.add({
-    dir: path.resolve(__dirname, 'rels/mycompany'),
-    prefix: 'mco'
-  })
-
-  server.route({
-    method: 'GET',
-    path: '/users/{userId}',
-    handler (req) {
-      return {
-        id: req.params.userId,
-        name: `User ${req.params.userId}`,
-        bossId: 200
-      }
-    },
-    config: {
-      plugins: {
-        hal: {
-          links: {
-            'mco:boss': '../{bossId}'
-          },
-          ignore: 'bossId'
-        }
-      }
-    }
-  })
-
-  await server.start()
-
-  console.log('Server started at %s', server.info.uri)
-}
-
-init()

package/examples/functional-href.cjs

@@ -1,67 +0,0 @@
-const hapi = require('@hapi/hapi')
-const vision = require('@hapi/vision')
-const halacious = require('#halacious')
-
-async function init () {
-  const server = hapi.server({ port: 8080 })
-
-  await server.register(vision)
-
-  await server.register(halacious)
-
-  server.route({
-    method: 'get',
-    path: '/users/{id}',
-    handler (req) {
-      return { id: req.params.id, bossId: 101 }
-    },
-    config: {
-      id: 'user',
-      plugins: {
-        hal: {
-          links: {
-            boss (rep, entity) {
-              return rep.route('user', { id: entity.bossId })
-            }
-          }
-        }
-      }
-    }
-  })
-
-  server.route({
-    method: 'get',
-    path: '/users',
-    handler () {
-      return {
-        start: 0,
-        count: 2,
-        limit: 2,
-        items: [
-          { id: 100, firstName: 'Brad', lastName: 'Leupen' },
-          { id: 101, firstName: 'Barack', lastName: 'Obama' }
-        ]
-      }
-    },
-    config: {
-      plugins: {
-        hal: {
-          embedded: {
-            item: {
-              path: 'items',
-              href (rep, ctx) {
-                return rep.route('user', { id: ctx.item.id })
-              }
-            }
-          }
-        }
-      }
-    }
-  })
-
-  await server.start()
-
-  console.log('Server started at %s', server.info.uri)
-}
-
-init()

package/examples/hello-world.cjs

@@ -1,25 +0,0 @@
-const hapi = require('@hapi/hapi')
-const vision = require('@hapi/vision')
-const halacious = require('#halacious')
-
-async function init () {
-  const server = hapi.server({ port: 8080 })
-
-  await server.register(vision)
-
-  await server.register(halacious)
-
-  server.route({
-    method: 'get',
-    path: '/hello/{name}',
-    handler (req) {
-      return { message: `Hello, ${req.params.name}` }
-    }
-  })
-
-  await server.start()
-
-  console.log('Server started at %s', server.info.uri)
-}
-
-init()

package/examples/manual-namespace.cjs

@@ -1,52 +0,0 @@
-const hapi = require('@hapi/hapi')
-const vision = require('@hapi/vision')
-const halacious = require('#halacious')
-
-const { name: PLUGIN } = require('#halacious/package')
-
-async function init () {
-  const server = hapi.server({ port: 8080 })
-
-  await server.register(vision)
-
-  await server.register(halacious)
-
-  const namespace = server.plugins[PLUGIN].namespaces.add({
-    name: 'mycompany',
-    description: 'My Companys namespace',
-    prefix: 'mco'
-  })
-  namespace.rel({ name: 'users', description: 'a collection of users' })
-  namespace.rel({ name: 'user', description: 'a single user' })
-  namespace.rel({ name: 'boss', description: 'a users boss' })
-
-  server.route({
-    method: 'get',
-    path: '/users/{userId}',
-
-    handler (req) {
-      return {
-        id: req.params.userId,
-        name: `User ${req.params.userId}`,
-        bossId: 200
-      }
-    },
-
-    config: {
-      plugins: {
-        hal: {
-          links: {
-            'mco:boss': '../{bossId}'
-          },
-          ignore: 'bossId'
-        }
-      }
-    }
-  })
-
-  await server.start()
-
-  console.log('Server started at %s', server.info.uri)
-}
-
-init()

package/examples/media-types.cjs

@@ -1,44 +0,0 @@
-const hapi = require('@hapi/hapi')
-const vision = require('@hapi/vision')
-const halacious = require('#halacious')
-
-async function init () {
-  const server = hapi.server({ port: 8080 })
-
-  await server.register(vision)
-
-  await server.register({
-    plugin: halacious,
-    options: {
-      mediaTypes: ['application/json', 'application/hal+json']
-    }
-  })
-
-  server.route({
-    method: 'get',
-    path: '/users/{userId}',
-    handler (req) {
-      return {
-        id: req.params.userId,
-        name: `User ${req.params.userId}`,
-        googlePlusId: '107835557095464780852'
-      }
-    },
-    config: {
-      plugins: {
-        hal: {
-          links: {
-            home: 'http://plus.google.com/{googlePlusId}'
-          },
-          ignore: 'googlePlusId' // remove the id property from the response
-        }
-      }
-    }
-  })
-
-  await server.start()
-
-  console.log('Server started at %s', server.info.uri)
-}
-
-init()

package/examples/paging.cjs

@@ -1,88 +0,0 @@
-const hapi = require('@hapi/hapi')
-const vision = require('@hapi/vision')
-const hoek = require('@hapi/hoek')
-const Uri = require('urijs')
-const halacious = require('#halacious')
-
-const { name: PLUGIN } = require('#halacious/package')
-
-const users = []
-
-for (let i = 0; i < 100; i++) {
-  users.push({ id: 1000 + i, firstName: 'Test', lastName: `User ${i}` })
-}
-
-function Collection (items, start, total) {
-  this.items = items || []
-  this.start = start || 0
-  this.count = this.items.length
-  this.total = total || this.items.count
-}
-
-Collection.prototype.toHal = function (rep, done) {
-  const limit = Number(rep.request.query.limit) || 10
-  const uri = new Uri(rep.self)
-  const prev = Math.max(0, this.start - limit)
-  const next = Math.min(this.total, this.start + limit)
-
-  const query = uri.search(true)
-
-  if (this.start > 0) {
-    rep.link(
-      'prev',
-      uri.search(hoek.applyToDefaults(query, { start: prev, limit })).toString()
-    )
-  }
-  if (this.start + this.count < this.total) {
-    rep.link(
-      'next',
-      uri.search(hoek.applyToDefaults(query, { start: next, limit })).toString()
-    )
-  }
-  done()
-}
-
-async function init () {
-  const server = hapi.server({ port: 8080 })
-
-  await server.register(vision)
-
-  await server.register({
-    plugin: halacious,
-    options: { mediaTypes: ['application/json', 'application/hal+json'] }
-  })
-
-  server.plugins[PLUGIN].namespaces
-    .add({ name: 'mycompay', prefix: 'mco' })
-    .rel('user')
-
-  server.route({
-    method: 'get',
-    path: '/users',
-    handler (req) {
-      const start = Number(req.query.start) || 0
-      const limit = Number(req.query.limit) || 10
-      const items = users.slice(start, start + limit)
-      return new Collection(items, start, users.length)
-    },
-    config: {
-      plugins: {
-        hal: {
-          query: '{?start,limit,q}',
-          embedded: {
-            'mco:item': {
-              path: 'items',
-              href: './{item.id}'
-            }
-          }
-        }
-      }
-    }
-  })
-
-  await server.start()
-
-  console.log('Server started at %s', server.info.uri)
-}
-
-init()

package/examples/programmatic-entity.cjs

@@ -1,60 +0,0 @@
-const hapi = require('@hapi/hapi')
-const vision = require('@hapi/vision')
-const halacious = require('#halacious')
-
-function User (id, firstName, lastName, googlePlusId) {
-  this.id = id
-  this.firstName = firstName
-  this.lastName = lastName
-  this.googlePlusId = googlePlusId
-}
-
-User.prototype.toHal = function (rep, next) {
-  if (this.googlePlusId) {
-    rep.link('home', `http://plus.google.com/${this.googlePlusId}`)
-    rep.ignore('googlePlusId')
-  }
-  next()
-}
-
-async function init () {
-  const server = hapi.server({ port: 8080 })
-
-  await server.register(vision)
-
-  await server.register(halacious)
-
-  server.route({
-    method: 'get',
-    path: '/users',
-    handler () {
-      return {
-        start: 0,
-        count: 2,
-        limit: 2,
-        items: [
-          new User(100, 'Brad', 'Leupen', '107835557095464780852'),
-          new User(101, 'Mark', 'Zuckerberg')
-        ]
-      }
-    },
-    config: {
-      plugins: {
-        hal: {
-          embedded: {
-            item: {
-              path: 'items',
-              href: './{item.id}'
-            }
-          }
-        }
-      }
-    }
-  })
-
-  await server.start()
-
-  console.log('Server started at %s', server.info.uri)
-}
-
-init()

package/examples/programmatic-route.cjs

@@ -1,60 +0,0 @@
-const hapi = require('@hapi/hapi')
-const vision = require('@hapi/vision')
-const halacious = require('#halacious')
-
-async function init () {
-  const server = hapi.server({ port: 8080 })
-
-  await server.register(vision)
-
-  await server.register(halacious)
-
-  server.route({
-    method: 'get',
-    path: '/users',
-    handler () {
-      return {
-        start: 0,
-        count: 2,
-        limit: 2,
-        items: [
-          {
-            id: 100,
-            firstName: 'Brad',
-            lastName: 'Leupen',
-            googlePlusId: '107835557095464780852'
-          },
-          { id: 101, firstName: 'Mark', lastName: 'Zuckerberg' }
-        ]
-      }
-    },
-    config: {
-      plugins: {
-        hal: {
-          // you can also assign this function directly to the hal property above as a shortcut
-          prepare (rep, next) {
-            rep.entity.items.forEach((item) => {
-              const embed = rep.embed('item', `./${item.id}`, item)
-              if (item.googlePlusId) {
-                embed.link(
-                  'home',
-                  `http://plus.google.com/${item.googlePlusId}`
-                )
-                embed.ignore('googlePlusId')
-              }
-            })
-            rep.ignore('items')
-            // dont forget to call next!
-            next()
-          }
-        }
-      }
-    }
-  })
-
-  await server.start()
-
-  console.log('Server started at %s', server.info.uri)
-}
-
-init()

package/examples/query-string.cjs

@@ -1,53 +0,0 @@
-const path = require('path')
-
-const hapi = require('@hapi/hapi')
-const vision = require('@hapi/vision')
-const halacious = require('#halacious')
-
-const { name: PLUGIN } = require('#halacious/package')
-
-async function init () {
-  const server = hapi.server({ port: 8080 })
-
-  await server.register(vision)
-
-  await server.register({
-    plugin: halacious,
-    options: {
-      mediaTypes: ['application/json', 'application/hal+json']
-    }
-  })
-
-  server.plugins[PLUGIN].namespaces.add({
-    dir: path.resolve(__dirname, 'rels/mycompany'),
-    prefix: 'mco'
-  })
-
-  server.route({
-    method: 'get',
-    path: '/users',
-    handler () {
-      return { items: [{ id: 100, firstName: 'Louis', lastName: 'CK' }] }
-    },
-    config: {
-      plugins: {
-        hal: {
-          api: 'mco:users',
-          embedded: {
-            'mco:user': {
-              path: 'items',
-              href: './{item.id}'
-            }
-          },
-          query: '{?q*,start,limit}'
-        }
-      }
-    }
-  })
-
-  await server.start()
-
-  console.log('Server started at %s', server.info.uri)
-}
-
-init()

package/examples/rels/mycompany/boss.md

@@ -1 +0,0 @@
-## A boss user

package/examples/rels/mycompany/user.md

@@ -1,7 +0,0 @@
-## a single user
-
-a user contains the properties:
-- id
-- first
-- last
-- full

package/examples/rels/mycompany/users.md

@@ -1 +0,0 @@
-## a collection of users