@middy/http-content-negotiation 5.0.0-alpha.0 → 5.0.0-alpha.1

package/README.md

@@ -19,8 +19,9 @@
   <a href="https://snyk.io/test/github/middyjs/middy">
     <img src="https://snyk.io/test/github/middyjs/middy/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/middyjs/middy" style="max-width:100%;">
   </a>
-  <a href="https://lgtm.com/projects/g/middyjs/middy/context:javascript">
-    <img src="https://img.shields.io/lgtm/grade/javascript/g/middyjs/middy.svg?logo=lgtm&logoWidth=18" alt="Language grade: JavaScript" style="max-width:100%;">
+  <a href="https://github.com/middyjs/middy/actions/workflows/sast.yml">
+    <img src="https://github.com/middyjs/middy/actions/workflows/sast.yml/badge.svg
+?branch=main&event=push" alt="CodeQL" style="max-width:100%;">
   </a>
   <a href="https://bestpractices.coreinfrastructure.org/projects/5280">
     <img src="https://bestpractices.coreinfrastructure.org/projects/5280/badge" alt="Core Infrastructure Initiative (CII) Best Practices"  style="max-width:100%;">

package/index.d.ts

@@ -12,7 +12,10 @@ interface Options {
   failOnMismatch?: boolean
 }
 
-export interface Event {
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface Event {}
+
+export interface Context {
   preferredCharsets: string[]
   preferredCharset: string
   preferredEncodings: string[]

package/index.js

@@ -1,63 +1,120 @@
-import charset from 'negotiator/lib/charset.js';
-import encoding from 'negotiator/lib/encoding.js';
-import language from 'negotiator/lib/language.js';
-import mediaType from 'negotiator/lib/mediaType.js';
-import { createError } from '@middy/util';
+import charset from 'negotiator/lib/charset.js'
+import encoding from 'negotiator/lib/encoding.js'
+import language from 'negotiator/lib/language.js'
+import mediaType from 'negotiator/lib/mediaType.js'
+import { createError } from '@middy/util'
+
 const parseFn = {
-    Charset: charset,
-    Encoding: encoding,
-    Language: language,
-    MediaType: mediaType
-};
+  Charset: charset,
+  Encoding: encoding,
+  Language: language,
+  MediaType: mediaType
+}
+
 const defaults = {
-    parseCharsets: true,
-    availableCharsets: undefined,
-    parseEncodings: true,
-    availableEncodings: undefined,
-    parseLanguages: true,
-    availableLanguages: undefined,
-    defaultToFirstLanguage: false,
-    parseMediaTypes: true,
-    availableMediaTypes: undefined,
-    failOnMismatch: true
-};
-const httpContentNegotiationMiddleware = (opts = {})=>{
-    const options = {
-        ...defaults,
-        ...opts
-    };
-    const httpContentNegotiationMiddlewareBefore = async (request)=>{
-        const { event  } = request;
-        if (!event.headers) return;
-        if (options.parseCharsets) {
-            parseHeader('Accept-Charset', 'Charset', options.availableCharsets, options.defaultToFirstCharset, options.failOnMismatch, event);
-        }
-        if (options.parseEncodings) {
-            parseHeader('Accept-Encoding', 'Encoding', options.availableEncodings, options.defaultToFirstEncoding, options.failOnMismatch, event);
-        }
-        if (options.parseLanguages) {
-            parseHeader('Accept-Language', 'Language', options.availableLanguages, options.defaultToFirstLanguage, options.failOnMismatch, event);
-        }
-        if (options.parseMediaTypes) {
-            parseHeader('Accept', 'MediaType', options.availableMediaTypes, options.defaultToFirstMediaType, options.failOnMismatch, event);
-        }
-    };
-    return {
-        before: httpContentNegotiationMiddlewareBefore
-    };
-};
-const parseHeader = (headerName, type, availableValues, defaultToFirstValue, failOnMismatch, event)=>{
-    const resultsName = `preferred${type}s`;
-    const resultName = `preferred${type}`;
-    const headerValue = event.headers[headerName] ?? event.headers[headerName.toLowerCase()];
-    event[resultsName] = parseFn[type](headerValue, availableValues);
-    event[resultName] = event[resultsName][0];
-    if (defaultToFirstValue && event[resultName] === undefined) {
-        event[resultName] = availableValues[0];
+  parseCharsets: true,
+  availableCharsets: undefined,
+  // defaultToFirstCharset: false, // Should not be used
+  parseEncodings: true,
+  availableEncodings: undefined,
+  // defaultToFirstEncoding: false, // Should not be used
+  parseLanguages: true,
+  availableLanguages: undefined,
+  // defaultToFirstLanguage: false, // Should not be used
+  parseMediaTypes: true,
+  availableMediaTypes: undefined,
+  // defaultToFirstMediaType: false, // Should not be used
+  failOnMismatch: true
+}
+
+const httpContentNegotiationMiddleware = (opts = {}) => {
+  const options = { ...defaults, ...opts }
+
+  const httpContentNegotiationMiddlewareBefore = async (request) => {
+    const { event, context } = request
+    if (!event.headers) return
+    if (options.parseCharsets) {
+      parseHeader(
+        'Accept-Charset',
+        'Charset',
+        options.availableCharsets,
+        options.defaultToFirstCharset,
+        options.failOnMismatch,
+        event,
+        context
+      )
     }
-    if (failOnMismatch && event[resultName] === undefined) {
-        throw createError(406, `Unsupported ${type}. Acceptable values: ${availableValues.join(', ')}`);
+
+    if (options.parseEncodings) {
+      parseHeader(
+        'Accept-Encoding',
+        'Encoding',
+        options.availableEncodings,
+        options.defaultToFirstEncoding,
+        options.failOnMismatch,
+        event,
+        context
+      )
+    }
+
+    if (options.parseLanguages) {
+      parseHeader(
+        'Accept-Language',
+        'Language',
+        options.availableLanguages,
+        options.defaultToFirstLanguage,
+        options.failOnMismatch,
+        event,
+        context
+      )
     }
-};
-export default httpContentNegotiationMiddleware;
 
+    if (options.parseMediaTypes) {
+      parseHeader(
+        'Accept',
+        'MediaType',
+        options.availableMediaTypes,
+        options.defaultToFirstMediaType,
+        options.failOnMismatch,
+        event,
+        context
+      )
+    }
+  }
+
+  return {
+    before: httpContentNegotiationMiddlewareBefore
+  }
+}
+
+const parseHeader = (
+  headerName,
+  type,
+  availableValues,
+  defaultToFirstValue,
+  failOnMismatch,
+  event,
+  context
+) => {
+  const resultsName = `preferred${type}s`
+  const resultName = `preferred${type}`
+  const headerValue =
+    event.headers[headerName] ?? event.headers[headerName.toLowerCase()]
+
+  context[resultsName] = parseFn[type](headerValue, availableValues)
+  context[resultName] = context[resultsName][0]
+
+  if (defaultToFirstValue && context[resultName] === undefined) {
+    context[resultName] = availableValues[0]
+  }
+  if (failOnMismatch && context[resultName] === undefined) {
+    // NotAcceptable
+    throw createError(
+      406,
+      `Unsupported ${type}. Acceptable values: ${availableValues.join(', ')}`,
+      { cause: { package: '@middy/http-content-negotiation' } }
+    )
+  }
+}
+
+export default httpContentNegotiationMiddleware

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/http-content-negotiation",
-  "version": "5.0.0-alpha.0",
+  "version": "5.0.0-alpha.1",
   "description": "Http content negotiation middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -10,24 +10,18 @@
   "publishConfig": {
     "access": "public"
   },
-  "main": "./index.cjs",
   "module": "./index.js",
   "exports": {
     ".": {
       "import": {
         "types": "./index.d.ts",
         "default": "./index.js"
-      },
-      "require": {
-        "types": "./index.d.ts",
-        "default": "./index.cjs"
       }
     }
   },
   "types": "index.d.ts",
   "files": [
     "index.js",
-    "index.cjs",
     "index.d.ts"
   ],
   "scripts": {
@@ -66,11 +60,11 @@
     "url": "https://github.com/sponsors/willfarrell"
   },
   "dependencies": {
-    "@middy/util": "5.0.0-alpha.0",
+    "@middy/util": "5.0.0-alpha.1",
     "negotiator": "0.6.3"
   },
   "devDependencies": {
-    "@middy/core": "5.0.0-alpha.0"
+    "@middy/core": "5.0.0-alpha.1"
   },
-  "gitHead": "08c35e3dba9efdad0b86666ce206ce302cc65d07"
+  "gitHead": "ebce8d5df8783077fa49ba62ee9be20e8486a7f1"
 }

package/index.cjs

@@ -1,76 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(module, "exports", {
-    enumerable: true,
-    get: ()=>_default
-});
-const _charsetJs = _interopRequireDefault(require("negotiator/lib/charset.js"));
-const _encodingJs = _interopRequireDefault(require("negotiator/lib/encoding.js"));
-const _languageJs = _interopRequireDefault(require("negotiator/lib/language.js"));
-const _mediaTypeJs = _interopRequireDefault(require("negotiator/lib/mediaType.js"));
-const _util = require("@middy/util");
-function _interopRequireDefault(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
-const parseFn = {
-    Charset: _charsetJs.default,
-    Encoding: _encodingJs.default,
-    Language: _languageJs.default,
-    MediaType: _mediaTypeJs.default
-};
-const defaults = {
-    parseCharsets: true,
-    availableCharsets: undefined,
-    parseEncodings: true,
-    availableEncodings: undefined,
-    parseLanguages: true,
-    availableLanguages: undefined,
-    defaultToFirstLanguage: false,
-    parseMediaTypes: true,
-    availableMediaTypes: undefined,
-    failOnMismatch: true
-};
-const httpContentNegotiationMiddleware = (opts = {})=>{
-    const options = {
-        ...defaults,
-        ...opts
-    };
-    const httpContentNegotiationMiddlewareBefore = async (request)=>{
-        const { event  } = request;
-        if (!event.headers) return;
-        if (options.parseCharsets) {
-            parseHeader('Accept-Charset', 'Charset', options.availableCharsets, options.defaultToFirstCharset, options.failOnMismatch, event);
-        }
-        if (options.parseEncodings) {
-            parseHeader('Accept-Encoding', 'Encoding', options.availableEncodings, options.defaultToFirstEncoding, options.failOnMismatch, event);
-        }
-        if (options.parseLanguages) {
-            parseHeader('Accept-Language', 'Language', options.availableLanguages, options.defaultToFirstLanguage, options.failOnMismatch, event);
-        }
-        if (options.parseMediaTypes) {
-            parseHeader('Accept', 'MediaType', options.availableMediaTypes, options.defaultToFirstMediaType, options.failOnMismatch, event);
-        }
-    };
-    return {
-        before: httpContentNegotiationMiddlewareBefore
-    };
-};
-const parseHeader = (headerName, type, availableValues, defaultToFirstValue, failOnMismatch, event)=>{
-    const resultsName = `preferred${type}s`;
-    const resultName = `preferred${type}`;
-    const headerValue = event.headers[headerName] ?? event.headers[headerName.toLowerCase()];
-    event[resultsName] = parseFn[type](headerValue, availableValues);
-    event[resultName] = event[resultsName][0];
-    if (defaultToFirstValue && event[resultName] === undefined) {
-        event[resultName] = availableValues[0];
-    }
-    if (failOnMismatch && event[resultName] === undefined) {
-        throw (0, _util.createError)(406, `Unsupported ${type}. Acceptable values: ${availableValues.join(', ')}`);
-    }
-};
-const _default = httpContentNegotiationMiddleware;
-