@middy/util 2.5.6 → 3.0.0-alpha.3

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2021 Luciano Mammino, will Farrell and the [Middy team](https://github.com/middyjs/middy/graphs/contributors)
+Copyright (c) 2017-2022 Luciano Mammino, will Farrell and the [Middy team](https://github.com/middyjs/middy/graphs/contributors)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -47,7 +47,7 @@ Everyone is very welcome to contribute to this repository. Feel free to [raise i
 
 ## License
 
-Licensed under [MIT License](LICENSE). Copyright (c) 2017-2021 Luciano Mammino, will Farrell, and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).
+Licensed under [MIT License](LICENSE). Copyright (c) 2017-2022 Luciano Mammino, will Farrell, and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).
 
 <a href="https://app.fossa.io/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy?ref=badge_large">
   <img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy.svg?type=large" alt="FOSSA Status"  style="max-width:100%;">

package/codes.js

@@ -0,0 +1,66 @@
+export default {
+  100: 'Continue',
+  101: 'Switching Protocols',
+  102: 'Processing',
+  103: 'Early Hints',
+  200: 'OK',
+  201: 'Created',
+  202: 'Accepted',
+  203: 'Non-Authoritative Information',
+  204: 'No Content',
+  205: 'Reset Content',
+  206: 'Partial Content',
+  207: 'Multi-Status',
+  208: 'Already Reported',
+  226: 'IM Used',
+  300: 'Multiple Choices',
+  301: 'Moved Permanently',
+  302: 'Found',
+  303: 'See Other',
+  304: 'Not Modified',
+  305: 'Use Proxy',
+  306: '(Unused)',
+  307: 'Temporary Redirect',
+  308: 'Permanent Redirect',
+  400: 'Bad Request',
+  401: 'Unauthorized',
+  402: 'Payment Required',
+  403: 'Forbidden',
+  404: 'Not Found',
+  405: 'Method Not Allowed',
+  406: 'Not Acceptable',
+  407: 'Proxy Authentication Required',
+  408: 'Request Timeout',
+  409: 'Conflict',
+  410: 'Gone',
+  411: 'Length Required',
+  412: 'Precondition Failed',
+  413: 'Payload Too Large',
+  414: 'URI Too Long',
+  415: 'Unsupported Media Type',
+  416: 'Range Not Satisfiable',
+  417: 'Expectation Failed',
+  418: "I'm a teapot",
+  421: 'Misdirected Request',
+  422: 'Unprocessable Entity',
+  423: 'Locked',
+  424: 'Failed Dependency',
+  425: 'Unordered Collection',
+  426: 'Upgrade Required',
+  428: 'Precondition Required',
+  429: 'Too Many Requests',
+  431: 'Request Header Fields Too Large',
+  451: 'Unavailable For Legal Reasons',
+  500: 'Internal Server Error',
+  501: 'Not Implemented',
+  502: 'Bad Gateway',
+  503: 'Service Unavailable',
+  504: 'Gateway Timeout',
+  505: 'HTTP Version Not Supported',
+  506: 'Variant Also Negotiates',
+  507: 'Insufficient Storage',
+  508: 'Loop Detected',
+  509: 'Bandwidth Limit Exceeded',
+  510: 'Not Extended',
+  511: 'Network Authentication Required'
+}

package/index.d.ts

@@ -9,7 +9,6 @@ interface Options<Client, ClientOptions> {
   disablePrefetch?: boolean
   cacheKey?: string
   cacheExpiry?: number
-  setToEnv?: boolean
   setToContext?: boolean
 }
 
@@ -39,7 +38,7 @@ declare function clearCache (keys?: string | string[] | null): void
 
 declare function jsonSafeParse (string: string, reviver?: (key: string, value: any) => any): any
 
-declare function normalizeHttpResponse (response: any, fallbackResponse?: any): any
+declare function normalizeHttpResponse (request: any, fallbackResponse?: any): any
 
 declare function createError (code: number, message: string, properties?: Record<string, any>): HttpError
 

package/index.js

@@ -1,7 +1,11 @@
-const { Agent } = require('https')
-// const { NodeHttpHandler } = require('@aws-sdk/node-http-handler') // aws-sdk v3
+import { Agent } from 'https'
 
-const awsClientDefaultOptions = {
+// smaller version of `http-errors`
+import statuses from './codes.js'
+import { inherits } from 'util'
+// import { NodeHttpHandler } from '@aws-sdk/node-http-handler' // aws-sdk v3
+
+export const awsClientDefaultOptions = {
   // AWS SDK v3
   // Docs: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/enforcing-tls.html
   /* requestHandler: new NodeHttpHandler({
@@ -19,7 +23,7 @@ const awsClientDefaultOptions = {
   }
 }
 
-const createPrefetchClient = (options) => {
+export const createPrefetchClient = (options) => {
   const awsClientOptions = {
     ...awsClientDefaultOptions,
     ...options.awsClientOptions
@@ -27,14 +31,16 @@ const createPrefetchClient = (options) => {
   const client = new options.AwsClient(awsClientOptions)
 
   // AWS XRay
-  if (options.awsClientCapture) {
+  if (options.awsClientCapture && options.disablePrefetch) {
     return options.awsClientCapture(client)
+  } else if (options.awsClientCapture) {
+    console.warn('Unable to apply X-Ray outside of handler invocation scope.')
   }
 
   return client
 }
 
-const createClient = async (options, request) => {
+export const createClient = async (options, request) => {
   let awsClientCredentials = {}
 
   // Role Credentials
@@ -57,12 +63,12 @@ const createClient = async (options, request) => {
   })
 }
 
-const canPrefetch = (options) => {
-  return !options?.awsClientAssumeRole && !options?.disablePrefetch
+export const canPrefetch = (options = {}) => {
+  return !options.awsClientAssumeRole && !options.disablePrefetch
 }
 
 // Internal Context
-const getInternal = async (variables, request) => {
+export const getInternal = async (variables, request) => {
   if (!variables || !request) return {}
   let keys = []
   let values = []
@@ -82,7 +88,7 @@ const getInternal = async (variables, request) => {
     const pathOptionKey = internalKey.split('.')
     const rootOptionKey = pathOptionKey.shift()
     let valuePromise = request.internal[rootOptionKey]
-    if (typeof valuePromise?.then !== 'function') {
+    if (typeof valuePromise.then !== 'function') {
       valuePromise = Promise.resolve(valuePromise)
     }
     promises.push(
@@ -96,8 +102,13 @@ const getInternal = async (variables, request) => {
   values = await Promise.allSettled(promises)
   const errors = values
     .filter((res) => res.status === 'rejected')
-    .map((res) => res.reason.message)
-  if (errors.length) throw new Error(JSON.stringify(errors))
+    .map((res) => res.reason)
+  if (errors.length) {
+    // throw new Error('Failed to resolve internal values', { cause: errors })
+    const error = new Error('Failed to resolve internal values')
+    error.cause = errors
+    throw error
+  }
   return keys.reduce(
     (obj, key, index) => ({ ...obj, [sanitizeKey(key)]: values[index].value }),
     {}
@@ -105,7 +116,7 @@ const getInternal = async (variables, request) => {
 }
 const sanitizeKeyPrefixLeadingNumber = /^([0-9])/
 const sanitizeKeyRemoveDisallowedChar = /[^a-zA-Z0-9]+/g
-const sanitizeKey = (key) => {
+export const sanitizeKey = (key) => {
   return key
     .replace(sanitizeKeyPrefixLeadingNumber, '_$1')
     .replace(sanitizeKeyRemoveDisallowedChar, '_')
@@ -113,11 +124,11 @@ const sanitizeKey = (key) => {
 
 // fetch Cache
 const cache = {} // key: { value:{fetchKey:Promise}, expiry }
-const processCache = (options, fetch = () => undefined, request) => {
+export const processCache = (options, fetch = () => undefined, request) => {
   const { cacheExpiry, cacheKey } = options
   if (cacheExpiry) {
     const cached = getCache(cacheKey)
-    const unexpired = cached && (cacheExpiry < 0 || cached.expiry > Date.now())
+    const unexpired = cached.expiry && (cacheExpiry < 0 || cached.expiry > Date.now())
 
     if (unexpired && cached.modified) {
       const value = fetch(request, cached.value)
@@ -140,17 +151,18 @@ const processCache = (options, fetch = () => undefined, request) => {
   return { value, expiry }
 }
 
-const getCache = (key) => {
+export const getCache = (key) => {
+  if (!cache[key]) return {}
   return cache[key]
 }
 
 // Used to remove parts of a cache
-const modifyCache = (cacheKey, value) => {
+export const modifyCache = (cacheKey, value) => {
   if (!cache[cacheKey]) return
   cache[cacheKey] = { ...cache[cacheKey], value, modified: true }
 }
 
-const clearCache = (keys = null) => {
+export const clearCache = (keys = null) => {
   keys = keys ?? Object.keys(cache)
   if (!Array.isArray(keys)) keys = [keys]
   for (const cacheKey of keys) {
@@ -158,7 +170,7 @@ const clearCache = (keys = null) => {
   }
 }
 
-const jsonSafeParse = (string, reviver) => {
+export const jsonSafeParse = (string, reviver) => {
   if (typeof string !== 'string') return string
   const firstChar = string[0]
   if (firstChar !== '{' && firstChar !== '[' && firstChar !== '"') return string
@@ -169,27 +181,20 @@ const jsonSafeParse = (string, reviver) => {
   return string
 }
 
-const normalizeHttpResponse = (response) => {
-  // May require updating to catch other types
+export const normalizeHttpResponse = (request) => {
+  let { response } = request
   if (response === undefined) {
     response = {}
-  } else if (
-    Array.isArray(response) ||
-    typeof response !== 'object' ||
-    response === null
-  ) {
+  } else if (response?.statusCode === undefined && response?.body === undefined && response?.headers === undefined) {
     response = { body: response }
   }
-  response.headers = response?.headers ?? {}
+  response.headers ??= {}
+  request.response = response
   return response
 }
 
-// smaller version of `http-errors`
-const statuses = require('./codes.json')
-const { inherits } = require('util')
-
 const createErrorRegexp = /[^a-zA-Z]/g
-const createError = (code, message, properties = {}) => {
+export const createError = (code, message, properties = {}) => {
   const name = statuses[code].replace(createErrorRegexp, '')
   const className = name.substr(-5) !== 'Error' ? name + 'Error' : name
 
@@ -237,7 +242,7 @@ const createError = (code, message, properties = {}) => {
   return new HttpError(message)
 }
 
-module.exports = {
+export default {
   createPrefetchClient,
   createClient,
   canPrefetch,

package/package.json

@@ -1,24 +1,26 @@
 {
   "name": "@middy/util",
-  "version": "2.5.6",
+  "version": "3.0.0-alpha.3",
   "description": "🛵 The stylish Node.js middleware engine for AWS Lambda (util package)",
-  "type": "commonjs",
+  "type": "module",
   "engines": {
-    "node": ">=12"
+    "node": ">=14"
   },
   "engineStrict": true,
   "publishConfig": {
     "access": "public"
   },
-  "main": "index.js",
+  "exports": "./index.js",
   "types": "index.d.ts",
   "files": [
+    "index.js",
     "index.d.ts",
-    "codes.json"
+    "codes.js"
   ],
   "scripts": {
     "test": "npm run test:unit",
-    "test:unit": "ava"
+    "test:unit": "ava",
+    "test:benchmark": "node __benchmarks__/index.js"
   },
   "license": "MIT",
   "keywords": [
@@ -44,12 +46,12 @@
     "url": "https://github.com/middyjs/middy/issues"
   },
   "devDependencies": {
-    "@middy/core": "^2.5.6",
+    "@middy/core": "^3.0.0-alpha.3",
     "@types/aws-lambda": "^8.10.76",
-    "@types/node": "^16.0.0",
+    "@types/node": "^17.0.0",
     "aws-sdk": "^2.939.0",
     "aws-xray-sdk": "^3.3.3"
   },
   "homepage": "https://github.com/middyjs/middy#readme",
-  "gitHead": "0c789f55b4adf691f977b0d9904d1a805bb3bb2b"
+  "gitHead": "1441158711580313765e6d156046ef0fade0d156"
 }

package/codes.json

@@ -1,66 +0,0 @@
-{
-  "100": "Continue",
-  "101": "Switching Protocols",
-  "102": "Processing",
-  "103": "Early Hints",
-  "200": "OK",
-  "201": "Created",
-  "202": "Accepted",
-  "203": "Non-Authoritative Information",
-  "204": "No Content",
-  "205": "Reset Content",
-  "206": "Partial Content",
-  "207": "Multi-Status",
-  "208": "Already Reported",
-  "226": "IM Used",
-  "300": "Multiple Choices",
-  "301": "Moved Permanently",
-  "302": "Found",
-  "303": "See Other",
-  "304": "Not Modified",
-  "305": "Use Proxy",
-  "306": "(Unused)",
-  "307": "Temporary Redirect",
-  "308": "Permanent Redirect",
-  "400": "Bad Request",
-  "401": "Unauthorized",
-  "402": "Payment Required",
-  "403": "Forbidden",
-  "404": "Not Found",
-  "405": "Method Not Allowed",
-  "406": "Not Acceptable",
-  "407": "Proxy Authentication Required",
-  "408": "Request Timeout",
-  "409": "Conflict",
-  "410": "Gone",
-  "411": "Length Required",
-  "412": "Precondition Failed",
-  "413": "Payload Too Large",
-  "414": "URI Too Long",
-  "415": "Unsupported Media Type",
-  "416": "Range Not Satisfiable",
-  "417": "Expectation Failed",
-  "418": "I'm a teapot",
-  "421": "Misdirected Request",
-  "422": "Unprocessable Entity",
-  "423": "Locked",
-  "424": "Failed Dependency",
-  "425": "Unordered Collection",
-  "426": "Upgrade Required",
-  "428": "Precondition Required",
-  "429": "Too Many Requests",
-  "431": "Request Header Fields Too Large",
-  "451": "Unavailable For Legal Reasons",
-  "500": "Internal Server Error",
-  "501": "Not Implemented",
-  "502": "Bad Gateway",
-  "503": "Service Unavailable",
-  "504": "Gateway Timeout",
-  "505": "HTTP Version Not Supported",
-  "506": "Variant Also Negotiates",
-  "507": "Insufficient Storage",
-  "508": "Loop Detected",
-  "509": "Bandwidth Limit Exceeded",
-  "510": "Not Extended",
-  "511": "Network Authentication Required"
-}