@middy/validator 3.0.0-alpha.6 → 3.0.0

package/README.md

@@ -1,32 +1,42 @@
-# Middy validator middleware
-
-<div align="center">
-  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.png"/>
-</div>
-
 <div align="center">
+  <h1>Middy validator middleware</h1>
+  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.svg"/>
   <p><strong>Validator middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda</strong></p>
-</div>
-
-<div align="center">
 <p>
-  <a href="http://badge.fury.io/js/%40middy%2Fvalidator">
+  <a href="https://www.npmjs.com/package/@middy/validator?activeTab=versions">
     <img src="https://badge.fury.io/js/%40middy%2Fvalidator.svg" alt="npm version" style="max-width:100%;">
   </a>
+  <a href="https://packagephobia.com/result?p=@middy/validator">
+    <img src="https://packagephobia.com/badge?p=@middy/validator" alt="npm install size" style="max-width:100%;">
+  </a>
+  <a href="https://github.com/middyjs/middy/actions">
+    <img src="https://github.com/middyjs/middy/workflows/Tests/badge.svg" alt="GitHub Actions test status badge" style="max-width:100%;">
+  </a>
+  <br/>
+   <a href="https://standardjs.com/">
+    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style"  style="max-width:100%;">
+  </a>
   <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://standardjs.com/">
-    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style"  style="max-width:100%;">
+  <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>
+  <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%;">
+  </a>
+  <br/>
   <a href="https://gitter.im/middyjs/Lobby">
-    <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter"  style="max-width:100%;">
+    <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter" style="max-width:100%;">
+  </a>
+  <a href="https://stackoverflow.com/questions/tagged/middy?sort=Newest&uqlId=35052">
+    <img src="https://img.shields.io/badge/StackOverflow-[middy]-yellow" alt="Ask questions on StackOverflow" style="max-width:100%;">
   </a>
 </p>
 </div>
 
 This middleware automatically validates incoming events and outgoing responses against custom
-schemas defined with the [JSON schema syntax](http://json-schema.org/).
+schemas defined with the [JSON schema syntax](https://json-schema.org/).
 
 If an incoming event fails validation a `BadRequest` error is raised.
 If an outgoing response fails validation a `InternalServerError` error is
@@ -36,7 +46,7 @@ This middleware can be used in combination with
 [`httpErrorHandler`](#httperrorhandler) to automatically return the right
 response to the user.
 
-It can also be used in combination with [`httpcontentnegotiation`](#httpContentNegotiation) to load localised translations for the error messages (based on the currently requested language). This feature uses internally [`ajv-i18n`](http://npm.im/ajv-i18n) module, so reference to this module for options and more advanced use cases. By default the language used will be English (`en`), but you can redefine the default language by passing it in the `ajvOptions` options with the key `defaultLanguage` and specifying as value one of the [supported locales](https://www.npmjs.com/package/ajv-i18n#supported-locales).
+It can also be used in combination with [`httpcontentnegotiation`](#httpContentNegotiation) to load localised translations for the error messages (based on the currently requested language). This feature uses internally [`ajv-i18n`](https://www.npmjs.com/package/ajv-i18n) module, so reference to this module for options and more advanced use cases. By default the language used will be English (`en`), but you can redefine the default language by passing it in the `ajvOptions` options with the key `defaultLanguage` and specifying as value one of the [supported locales](https://www.npmjs.com/package/ajv-i18n#supported-locales).
 
 Also, this middleware accepts an object with plugins to be applied to customize the internal `ajv` instance. Out-of-the-box `ajv-i18n` and `ajv-formats` are being used.
 
@@ -51,13 +61,16 @@ npm install --save @middy/validator
 
 ## Options
 
- - `inputSchema` (object) (optional): The JSON schema object or compiled ajv validator that will be used
-   to validate the input (`request.event`) of the Lambda handler.
- - `outputSchema` (object) (optional): The JSON schema object or compiled ajv validator that will be used
-   to validate the output (`request.response`) of the Lambda handler.
- - `ajvOptions` (object) (optional): Options to pass to [ajv](https://ajv.js.org/docs/api.html#options)
+ - `eventSchema` (object|function) (default `undefined`): The JSON schema object or compiled ajv validator that will be used
+   to validate the input (`request.event`) of the Lambda handler. Supports alias `inputSchema`
+- `contextSchema` (object|function) (default `undefined`): The JSON schema object or compiled ajv validator that will be used
+  to validate the input (`request.context`) of the Lambda handler. Has additional support for `typeof` keyword to allow validation of `"typeof":"function"`.
+ - `responseSchema` (object|function) (default `undefined`): The JSON schema object or compiled ajv validator that will be used
+   to validate the output (`request.response`) of the Lambda handler. Supports alias `inputSchema`
+ - `ajvOptions` (object) (default `undefined`): Options to pass to [ajv](https://ajv.js.org/docs/api.html#options)
     class constructor. Defaults are `{ strict: true, coerceTypes: 'array', allErrors: true, useDefaults: 'empty', messages: false, defaultLanguage: 'en' }`.
- - `i18nEnabled` (boolean) (optional): Option to disable i18n default package. Defaults to `true`
+ - `i18nEnabled` (boolean) (default `true`): Option to disable i18n default package.
+
 NOTES:
 - At least one of `inputSchema` or `outputSchema` is required.
 - **Important** Compiling schemas on the fly will cause a 50-100ms performance hit during cold start for simple JSON Schemas. Precompiling is highly recommended.

package/index.cjs

@@ -0,0 +1,3 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.default=void 0;var _util=require("@middy/util");var _2020Js=_interopRequireDefault(require("ajv/dist/2020.js"));var _ajvI18N=_interopRequireDefault(require("ajv-i18n"));var _ajvFormats=_interopRequireDefault(require("ajv-formats"));var _ajvFormatsDraft2019=_interopRequireDefault(require("ajv-formats-draft2019"));var _typeofJs=_interopRequireDefault(require("ajv-keywords/dist/definitions/typeof.js"));function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}const Ajv=_2020Js.default.default;let ajv;const ajvDefaults={strict:true,coerceTypes:"array",allErrors:true,useDefaults:"empty",messages:false,keywords:[(0,_typeofJs).default()]};const defaults={eventSchema:undefined,contextSchema:undefined,responseSchema:undefined,ajvOptions:{},ajvInstance:undefined,defaultLanguage:"en",i18nEnabled:true};const validatorMiddleware=(opts={})=>{let{inputSchema,outputSchema,eventSchema,contextSchema,responseSchema,ajvOptions,ajvInstance,defaultLanguage,i18nEnabled}={...defaults,...opts};eventSchema=compile(eventSchema??inputSchema,ajvOptions,ajvInstance);contextSchema=compile(contextSchema,ajvOptions,ajvInstance);responseSchema=compile(responseSchema??outputSchema,ajvOptions,ajvInstance);const validatorMiddlewareBefore=async request=>{if(eventSchema){const validEvent=await eventSchema(request.event);if(!validEvent){if(i18nEnabled){const language=chooseLanguage(request.event,defaultLanguage);_ajvI18N.default[language](eventSchema.errors)}const error=(0,_util).createError(400,"Event object failed validation");error.cause=eventSchema.errors;throw error}}if(contextSchema){const validContext=await contextSchema(request.context);if(!validContext){const error=(0,_util).createError(500,"Context object failed validation");error.cause=contextSchema.errors;throw error}}};const validatorMiddlewareAfter=async request=>{const valid=await responseSchema(request.response);if(!valid){const error=(0,_util).createError(500,"Response object failed validation");error.cause=responseSchema.errors;throw error}};return{before:(eventSchema??inputSchema)??contextSchema?validatorMiddlewareBefore:undefined,after:responseSchema??outputSchema?validatorMiddlewareAfter:undefined}};const compile=(schema,ajvOptions,ajvInstance=null)=>{if(typeof schema==="function"||!schema)return schema;const options={...ajvDefaults,...ajvOptions};if(!ajv){ajv=ajvInstance??new Ajv(options);(0,_ajvFormats).default(ajv);(0,_ajvFormatsDraft2019).default(ajv)}else if(!ajvInstance){ajv.opts={...ajv.opts,...options}}return ajv.compile(schema)};const languageNormalizationMap={pt:"pt-BR","pt-br":"pt-BR",pt_BR:"pt-BR",pt_br:"pt-BR","zh-tw":"zh-TW",zh_TW:"zh-TW",zh_tw:"zh-TW"};const normalizePreferredLanguage=lang=>languageNormalizationMap[lang]??lang;const availableLanguages=Object.keys(_ajvI18N.default);const chooseLanguage=({preferredLanguage},defaultLanguage)=>{if(preferredLanguage){const lang=normalizePreferredLanguage(preferredLanguage);if(availableLanguages.includes(lang)){return lang}}return defaultLanguage};var _default=validatorMiddleware;exports.default=_default
+
+//# sourceMappingURL=index.cjs.map

package/index.d.ts

@@ -3,8 +3,11 @@ import middy from '@middy/core'
 import Ajv, { Options as AjvOptions } from 'ajv'
 
 interface Options {
-  inputSchema?: object | any
-  outputSchema?: object | any
+  inputSchema?: object | any // Deprecate v4
+  outputSchema?: object | any // Deprecate v4
+  eventSchema?: object | any
+  contextSchema?: object | any
+  responseSchema?: object | any
   ajvOptions?: Partial<AjvOptions>
   ajvInstance?: Ajv
   defaultLanguage?: string

package/index.js

@@ -1,116 +1,3 @@
-import { createError } from '@middy/util';
-import _ajv from 'ajv/dist/2019.js';
-import localize from 'ajv-i18n';
-import formats from 'ajv-formats';
-import formatsDraft2019 from 'ajv-formats-draft2019';
-const Ajv = _ajv.default;
-let ajv;
-const ajvDefaults = {
-  strict: true,
-  coerceTypes: 'array',
-  allErrors: true,
-  useDefaults: 'empty',
-  messages: false
-};
-const defaults = {
-  inputSchema: undefined,
-  outputSchema: undefined,
-  ajvOptions: {},
-  ajvInstance: undefined,
-  defaultLanguage: 'en',
-  i18nEnabled: true
-};
+import{createError}from"@middy/util";import _ajv from"ajv/dist/2020.js";import localize from"ajv-i18n";import formats from"ajv-formats";import formatsDraft2019 from"ajv-formats-draft2019";import typeofKeyword from"ajv-keywords/dist/definitions/typeof.js";const Ajv=_ajv.default;let ajv;const ajvDefaults={strict:true,coerceTypes:"array",allErrors:true,useDefaults:"empty",messages:false,keywords:[typeofKeyword()]};const defaults={eventSchema:undefined,contextSchema:undefined,responseSchema:undefined,ajvOptions:{},ajvInstance:undefined,defaultLanguage:"en",i18nEnabled:true};const validatorMiddleware=(opts={})=>{let{inputSchema,outputSchema,eventSchema,contextSchema,responseSchema,ajvOptions,ajvInstance,defaultLanguage,i18nEnabled}={...defaults,...opts};eventSchema=compile(eventSchema??inputSchema,ajvOptions,ajvInstance);contextSchema=compile(contextSchema,ajvOptions,ajvInstance);responseSchema=compile(responseSchema??outputSchema,ajvOptions,ajvInstance);const validatorMiddlewareBefore=async request=>{if(eventSchema){const validEvent=await eventSchema(request.event);if(!validEvent){if(i18nEnabled){const language=chooseLanguage(request.event,defaultLanguage);localize[language](eventSchema.errors)}const error=createError(400,"Event object failed validation");error.cause=eventSchema.errors;throw error}}if(contextSchema){const validContext=await contextSchema(request.context);if(!validContext){const error=createError(500,"Context object failed validation");error.cause=contextSchema.errors;throw error}}};const validatorMiddlewareAfter=async request=>{const valid=await responseSchema(request.response);if(!valid){const error=createError(500,"Response object failed validation");error.cause=responseSchema.errors;throw error}};return{before:(eventSchema??inputSchema)??contextSchema?validatorMiddlewareBefore:undefined,after:responseSchema??outputSchema?validatorMiddlewareAfter:undefined}};const compile=(schema,ajvOptions,ajvInstance=null)=>{if(typeof schema==="function"||!schema)return schema;const options={...ajvDefaults,...ajvOptions};if(!ajv){ajv=ajvInstance??new Ajv(options);formats(ajv);formatsDraft2019(ajv)}else if(!ajvInstance){ajv.opts={...ajv.opts,...options}}return ajv.compile(schema)};const languageNormalizationMap={pt:"pt-BR","pt-br":"pt-BR",pt_BR:"pt-BR",pt_br:"pt-BR","zh-tw":"zh-TW",zh_TW:"zh-TW",zh_tw:"zh-TW"};const normalizePreferredLanguage=lang=>languageNormalizationMap[lang]??lang;const availableLanguages=Object.keys(localize);const chooseLanguage=({preferredLanguage},defaultLanguage)=>{if(preferredLanguage){const lang=normalizePreferredLanguage(preferredLanguage);if(availableLanguages.includes(lang)){return lang}}return defaultLanguage};export default validatorMiddleware
 
-const validatorMiddleware = (opts = {}) => {
-  let {
-    inputSchema,
-    outputSchema,
-    ajvOptions,
-    ajvInstance,
-    defaultLanguage,
-    i18nEnabled
-  } = { ...defaults,
-    ...opts
-  };
-  inputSchema = compile(inputSchema, ajvOptions, ajvInstance);
-  outputSchema = compile(outputSchema, ajvOptions, ajvInstance);
-
-  const validatorMiddlewareBefore = async request => {
-    const valid = inputSchema(request.event);
-
-    if (!valid) {
-      if (i18nEnabled) {
-        const language = chooseLanguage(request.event, defaultLanguage);
-        localize[language](inputSchema.errors);
-      }
-
-      const error = createError(400, 'Event object failed validation');
-      error.cause = inputSchema.errors;
-      throw error;
-    }
-  };
-
-  const validatorMiddlewareAfter = async request => {
-    const valid = outputSchema(request.response);
-
-    if (!valid) {
-      const error = createError(500, 'Response object failed validation');
-      error.cause = outputSchema.errors;
-      throw error;
-    }
-  };
-
-  return {
-    before: inputSchema ? validatorMiddlewareBefore : undefined,
-    after: outputSchema ? validatorMiddlewareAfter : undefined
-  };
-};
-
-const compile = (schema, ajvOptions, ajvInstance = null) => {
-  if (typeof schema === 'function' || !schema) return schema;
-  const options = { ...ajvDefaults,
-    ...ajvOptions
-  };
-
-  if (!ajv) {
-    ajv = ajvInstance ?? new Ajv(options);
-    formats(ajv);
-    formatsDraft2019(ajv);
-  } else if (!ajvInstance) {
-    ajv.opts = { ...ajv.opts,
-      ...options
-    };
-  }
-
-  return ajv.compile(schema);
-};
-
-const languageNormalizationMap = {
-  pt: 'pt-BR',
-  'pt-br': 'pt-BR',
-  pt_BR: 'pt-BR',
-  pt_br: 'pt-BR',
-  'zh-tw': 'zh-TW',
-  zh_TW: 'zh-TW',
-  zh_tw: 'zh-TW'
-};
-
-const normalizePreferredLanguage = lang => languageNormalizationMap[lang] ?? lang;
-
-const availableLanguages = Object.keys(localize);
-
-const chooseLanguage = ({
-  preferredLanguage
-}, defaultLanguage) => {
-  if (preferredLanguage) {
-    const lang = normalizePreferredLanguage(preferredLanguage);
-
-    if (availableLanguages.includes(lang)) {
-      return lang;
-    }
-  }
-
-  return defaultLanguage;
-};
-
-export default validatorMiddleware;
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/validator",
-  "version": "3.0.0-alpha.6",
+  "version": "3.0.0",
   "description": "Validator middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -10,10 +10,17 @@
   "publishConfig": {
     "access": "public"
   },
-  "exports": "./index.js",
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "require": "./index.cjs",
+      "types": "./index.d.ts"
+    }
+  },
   "types": "index.d.ts",
   "files": [
     "index.js",
+    "index.cjs",
     "index.d.ts"
   ],
   "scripts": {
@@ -45,18 +52,19 @@
   "bugs": {
     "url": "https://github.com/middyjs/middy/issues"
   },
-  "homepage": "https://github.com/middyjs/middy#readme",
+  "homepage": "https://middy.js.org",
   "dependencies": {
-    "@middy/util": "^3.0.0-alpha.6",
+    "@middy/util": "^3.0.0",
     "ajv": "8.9.0",
     "ajv-formats": "2.1.1",
     "ajv-formats-draft2019": "1.6.1",
-    "ajv-i18n": "4.2.0"
+    "ajv-i18n": "4.2.0",
+    "ajv-keywords": "5.1.0"
   },
   "devDependencies": {
-    "@middy/core": "^3.0.0-alpha.6",
+    "@middy/core": "^3.0.0",
     "@types/http-errors": "^1.8.1",
     "ajv-bsontype": "^1.0.7"
   },
-  "gitHead": "176660ed3e0716d6bfb635c77251b301e0e24720"
+  "gitHead": "01520fa8628a36c2f89e126cad656a16547ea0d6"
 }