@modernpoacher/halacious 7.0.3 → 7.0.4

package/README.md

@@ -33,20 +33,20 @@ be accomplished without writing any code at all.
 Start by npm installing Halicious into your Hapi project folder:
 
 ```shell
-npm install @modernpoacher/halacious --save
+npm i -P @modernpoacher/halacious
 ```
 
 or
 
 ```shell
-yarn add @modernpoacher/halacious --dev
+yarn add @modernpoacher/halacious
 ```
 
 Register the plugin with the app server
 
 ```javascript
 import hapi from '@hapi/hapi'
-import halacious from '#halacious'
+import halacious from '@modernpoacher/halacious'
 
 async function init () {
   const server = hapi.server({ port: 8080 })
@@ -54,16 +54,14 @@ async function init () {
   await server.register(halacious)
 
   server.route({
-    method: 'get',
+    method: 'GET',
     path: '/hello/{name}',
     handler (req) {
-      return { message: 'Hello, '+req.params.name }
+      return { message: 'Hello, ' + req.params.name }
     }
   })
 
   await server.start()
-
-  console.info('Server started at %s', server.info.uri)
 }
 
 init()
@@ -100,7 +98,7 @@ Links may be declared directly within the route config.
 
 ```javascript
 server.route({
-  method: 'get',
+  method: 'GET',
   path: '/users/{userId}',
   handler (req) {
     return { id: req.params.userId, name: 'User ' + req.params.userId, googlePlusId: '107835557095464780852' }
@@ -146,7 +144,7 @@ automatically convert nested objects into embedded HAL representations (if you a
 
 ```javascript
 server.route({
-  method: 'get',
+  method: 'GET',
   path: '/users/{userId}',
   handler (req) {
     return {
@@ -233,7 +231,7 @@ In either case, the method signature is the same: `fn(rep, callback)` where
 
 ```javascript
 server.route({
-  method: 'get',
+  method: 'GET',
   path: '/users',
   handler (req) {
     return {
@@ -333,7 +331,7 @@ User.prototype.toHal = function(rep, next) {
 }
 
 server.route({
-    method: 'get',
+    method: 'GET',
     path: '/users',
     handler (req) {
         return {
@@ -401,7 +399,7 @@ Halacious exposes its api to your Hapi server so that you may configure it at ru
 
 ```javascript
 import hapi from '@hapi/hapi'
-import halacious from '#halacious'
+import halacious from '@modernpoacher/halacious'
 
 async function init () {
   const server = hapi.server({ port: 8080 })
@@ -414,7 +412,7 @@ async function init () {
   namespace.rel({ name: 'boss', description: 'a users boss' })
 
   server.route({
-    method: 'get',
+    method: 'GET',
     path: '/users/{userId}',
     handler (req) {
         return { id: req.params.userId, name: 'User ' + req.params.userId, bossId: 200 }
@@ -472,7 +470,7 @@ company's namespace. We can suck all these into the system in one fell swoop:
 
 ```javascript
 import hapi from '@hapi/hapi'
-import halacious from '#halacious'
+import halacious from '@modernpoacher/halacious'
 
 async function init () {
   const server = hapi.server({ port: 8080 })
@@ -505,7 +503,7 @@ configuration option. For example:
 
 ```javascript
 import hapi from '@hapi/hapi'
-import halacious from '#halacious'
+import halacious from '@modernpoacher/halacious'
 
 async function init () {
   const server = hapi.server({ port: 8080 })
@@ -517,7 +515,7 @@ async function init () {
   namespace.rel({ name: 'user', description: 'a single user' })
 
   server.route({
-    method: 'get',
+    method: 'GET',
     path: '/users',
     handler () {
       return {}
@@ -532,7 +530,7 @@ async function init () {
   })
 
   server.route({
-    method: 'get',
+    method: 'GET',
     path: '/users/{userId}',
     handler () {
       return {}

package/babel.config.cjs

@@ -0,0 +1,44 @@
+const debug = require('debug')
+
+const log = debug('@modernpoacher/halacious')
+
+const {
+  env: {
+    NODE_ENV = 'development'
+  }
+} = process
+
+log('`@modernpoacher/halacious` is awake')
+
+function env () {
+  log({ NODE_ENV })
+
+  return (
+    NODE_ENV === 'production'
+  )
+}
+
+const presets = [
+  [
+    '@babel/env', {
+      targets: {
+        node: 'current'
+      },
+      useBuiltIns: 'usage',
+      corejs: 3
+    }
+  ]
+]
+
+const plugins = [
+  '@babel/syntax-import-assertions'
+]
+
+module.exports = (api) => {
+  if (api) api.cache.using(env)
+
+  return {
+    presets,
+    plugins
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modernpoacher/halacious",
-  "version": "7.0.3",
+  "version": "7.0.4",
   "description": "A HAL processor for Hapi",
   "keywords": [
     "HAL",
@@ -10,6 +10,7 @@
   ],
   "main": "./src/index.mjs",
   "type": "module",
+  "types": "./src/index.d.mts",
   "author": {
     "name": "Jonathan Perry for Modern Poacher Limited",
     "email": "modernpoacher@modernpoacher.com",
@@ -40,6 +41,7 @@
     "@hapi/boom": "^10.0.1",
     "@hapi/hoek": "^11.0.4",
     "async": "^3.2.5",
+    "debug": "^4.3.4",
     "joi": "^17.12.0",
     "lodash": "^4.17.21",
     "marked": "^11.1.1",
@@ -51,6 +53,8 @@
   "devDependencies": {
     "@babel/core": "^7.23.7",
     "@babel/eslint-parser": "^7.23.3",
+    "@babel/plugin-syntax-import-assertions": "^7.23.3",
+    "@babel/preset-env": "^7.23.8",
     "@hapi/hapi": "^21.3.2",
     "@hapi/vision": "^7.0.3",
     "@modernpoacher/hooks": "^1.0.457",
@@ -67,11 +71,14 @@
     "sinon": "^17.0.1"
   },
   "imports": {
+    "#package": "./package.json",
     "#halacious/*": "./src/*.mjs",
     "#halacious": "./src/index.mjs",
     "#where-am-i": "./where-am-i.mjs"
   },
   "exports": {
-    ".": "./src/index.mjs"
+    ".": "./src/index.mjs",
+    "./utils/*": "./src/utils/*.mjs",
+    "./utils": "./src/utils.mjs"
   }
 }

package/src/index.d.mts

@@ -1,30 +1,215 @@
-declare namespace HalaciousTypes {
-  export interface Collection {
-    uid: string
-  }
+declare module '@modernpoacher/halacious/utils' {
+  import type Negotiator from 'negotiator'
 
-  export interface Member {
-    uid: string
-  }
+  import type {
+    HalaciousTypes
+  } from '@modernpoacher/halacious'
+
+  type Representation = HalaciousTypes.Representation
+
+  export function getRepresentationSelf (arg: Representation): Record<string, any> | undefined
+
+  export function hasRepresentationSelf (arg: Representation): boolean
+
+  export function getRepresentationSelfHref (arg: Representation): string | undefined
+
+  export function hasRepresentationSelfHref (arg: Representation): boolean
+
+  export function getRepresentationEntity (arg: Representation): Record<string, any> | undefined
+
+  export function hasRepresentationEntity (arg: Representation): boolean
+
+  export function getRepresentationRequest (arg: Representation): Record<string, any> | undefined
+
+  export function hasRepresentationRequest (arg: Representation): boolean
+
+  export function getRepresentationRequestServer (arg: Representation): Record<string, any> | undefined
+
+  export function hasRepresentationRequestServer (arg: Representation): boolean
+
+  export function getRepresentationRequestPath (arg: Representation): string | undefined
+
+  export function hasRepresentationRequestPath (arg: Representation): boolean
+
+  export function getRepresentationRequestRoute (arg: Representation): Record<string, any> | undefined
+
+  export function hasRepresentationRequestRoute (arg: Representation): boolean
+
+  export function getRepresentationRequestRoutePath (arg: Representation): string | undefined
+
+  export function hasRepresentationRequestRoutePath (arg: Representation): boolean
+
+  export function getRepresentationRequestRouteMethod (arg: Representation): string | undefined
+
+  export function hasRepresentationRequestRouteMethod (arg: Representation): boolean
+
+  export function getRoutePath (arg: { path?: string }): string | undefined
+
+  export function hasRoutePath (arg: { path?: string }): boolean
+
+  export function getRouteSettings (arg: { settings?: Record<string, any> }): Record<string, any>
+
+  export function getRouteSettingsIsInternal (arg: { settings?: { isInternal?: boolean } }): boolean
+
+  export function getRouteSettingsPlugins (arg: { settings?: { plugins?: Record<string, any> } }): Record<string, any>
+
+  export function getRouteSettingsPluginsHal (arg: { settings?: { plugins?: { hal?: Record<string, any> } } }): Record<string, any>
+
+  export function getRouteSettingsPluginsHalApi (arg: { settings?: { plugins?: { hal?: { api?: Record<string, any> } } } }): Record<string, any> | null
+
+  export function getRouteSettingsPluginsHalQuery (arg: { settings?: { plugins?: { hal?: { query?: string } } } }): string | null
+
+  export function getRouteSettingsPluginsHalAbsolute (arg: { settings?: { plugins?: { hal?: { absolute?: boolean } } } }): boolean | null
+
+  export function getRequestPath (arg: { path?: string }): string | undefined
+
+  export function hasRequestPath (arg: { path?: string }): boolean
+
+  export function getRequestMethod (arg: { method?: string }): string | undefined
+
+  export function hasRequestMethod (arg: { method?: string }): boolean
+
+  export function getRequestRoute (arg: { route?: Record<string, any> }): Record<string, any> | undefined
+
+  export function hasRequestRoute (arg: { route?: Record<string, any> }): boolean
+
+  export function getRequestRoutePath (arg: { route?: { path?: string } }): string | undefined
+
+  export function hasRequestRoutePath (arg: { route?: { path?: string } }): boolean
+
+  export function getRequestRouteMethod (arg: { route?: { method?: string } }): string | undefined
+
+  export function hasRequestRouteMethod (arg: { route?: { method?: string } }): boolean
+
+  export function getRequestServer (arg: { server?: Record<string, any> }): Record<string, any> | undefined
+
+  export function hasRequestServer (arg: { server?: Record<string, any> }): boolean
+
+  export function getRequestHeaders (arg: { headers?: Record<string, any> }): Record<string, any> | undefined
+
+  export function hasRequestHeaders (arg: { headers?: Record<string, any> }): boolean
+
+  export function getRequestHeadersAccept (arg: { headers?: { accept?: string } }): string | undefined
+
+  export function getRequestResponse (arg: { response?: Record<string, any> }): Record<string, any> | undefined
+
+  export function hasRequestResponse (arg: { response?: Record<string, any> }): boolean
+
+  export function getRequestResponseSource (arg: { response?: { source?: Record<string, any> } }): Record<string, any> | undefined
+
+  export function getRequestResponseHeaders (arg: { response?: { headers?: Record<string, any> } }): Record<string, any> | undefined
 
-  export interface Representation {
-    request: {
+  export function getRequestResponseHeadersLocation (arg: { response?: { headers?: { location?: string } } }): string | undefined
+
+  export function getResponseVariety (arg: { variety?: string }): string | undefined
+
+  export function getResponseStatusCode (arg: { statusCode?: number }): number | undefined
+
+  export function isResponseStatusCodeInSuccessRange (statusCode: number | undefined): boolean
+
+  export function getFieldValueByPath (path?: string, context: Record<string, any>): Record<string, any>
+
+  export function getMediaType (request: { headers: Negotiator.Headers }, mediaTypes: string[]): string
+
+  export function getTemplateContext (template: string, context: Record<string, any>): Record<string, any>
+
+  export function getPath (arg: { path?: string }): string | undefined
+
+  export function hasPath (arg: { path?: string }): boolean
+
+  export function getMethod (arg: { method?: string }): string | undefined
+
+  export function hasMethod (arg: { method?: string }): boolean
+
+  export function getSelf (arg: { self?: Record<string, any> }): Record<string, any> | undefined
+
+  export function hasSelf (arg: { self?: Record<string, any> }): boolean
+
+  export function getHref (arg: { href?: string }): string | undefined
+
+  export function hasHref (arg: { href?: string }): boolean
+
+  export function getServer (arg: { server?: Record<string, any> }): Record<string, any> | undefined
+
+  export function hasServer (arg: { server?: Record<string, any> }): boolean
+
+  export function getRequest (arg: { request?: Record<string, any> }): Record<string, any> | undefined
+
+  export function hasRequest (arg: { request?: Record<string, any> }): boolean
+
+  export function getResponse (arg: { response?: Record<string, any> }): Record<string, any> | undefined
+
+  export function hasResponse (arg: { response?: Record<string, any> }): boolean
+
+  export function getSettings (arg: { settings?: Record<string, any> }): Record<string, any> | undefined
+
+  export function hasSettings (arg: { settings?: Record<string, any> }): boolean
+
+  export function getHeaders (arg: { headers?: Record<string, any> }): Record<string, any> | undefined
+
+  export function hasHeaders (arg: { headers?: Record<string, any> }): boolean
+
+  export function getEntity (arg: { entity?: Record<string, any> }): Record<string, any> | undefined
+
+  export function hasEntity (arg: { entity?: Record<string, any> }): boolean
+
+  export function getRoute (arg: { route?: string }): string | undefined
+
+  export function hasRoute (arg: { route?: string }): boolean
+
+  export function getName (arg: { name?: string }): string | undefined
+
+  export function hasName (arg: { name?: string }): boolean
+
+  export function getPrefix (arg: { prefix?: string }): string | undefined
+
+  export function hasPrefix (arg: { prefix?: string }): boolean
+
+  export function getRels (arg: { rels?: Record<string, any> }): Record<string, any> | undefined
+
+  export function hasRels (arg: { rels?: Record<string, any> }): boolean
+
+  export function getAbsolute (arg: { absolute?: boolean }): boolean | undefined
+
+  export function hasAbsolute (arg: { absolute?: boolean }): boolean
+
+  export function getQuery (arg: { query?: string }): string | undefined
+
+  export function hasQuery (arg: { query?: string }): boolean
+
+  export function getIgnore (arg: { ignore?: string }): string | undefined
+
+  export function hasIgnore (arg: { ignore?: string }): boolean
+
+  export function isRelativePath (path?: string): boolean
+}
+
+declare module '@modernpoacher/halacious' {
+  export namespace HalaciousTypes {
+    interface Request {
+      method?: string
+      path?: string
+      server: Record<string, any>
       route: {
         method?: string
         path?: string
       }
-      params: {
-        collection?: string
-        member?: string
-      }
+      params: Record<string, any>
+    }
+
+    export interface Representation {
+      factory: RepresentationFactory
+      request: Request
+      self: string | { href?: string }
+      entity: Record<string, any>
+      ignore: (v: string) => void
+      embed: (v: string, u: string, m: object) => void
     }
-    entity: {
-      collections?: Collection[]
-      members?: Member[]
+
+    export interface RepresentationFactory {
+      create: (entity: Record<string, any>, self?: string | { href?: string }, root?: Representation) => Representation
     }
-    ignore: (v: string) => void
-    embed: (v: string, u: string, m: object) => void
   }
-}
 
-export default HalaciousTypes
+  export const plugin: object
+}