@middy/validator 3.0.0-alpha.7 → 3.0.0-alpha.8

package/README.md

@@ -61,10 +61,12 @@ npm install --save @middy/validator
 
 ## Options
 
- - `inputSchema` (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.
- - `outputSchema` (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.
+ - `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) (default `true`): Option to disable i18n default package.

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 _2019Js=_interopRequireDefault(require("ajv/dist/2019.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=_2019Js.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=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=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=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,3 +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};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
+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";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=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=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=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
 
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/validator",
-  "version": "3.0.0-alpha.7",
+  "version": "3.0.0-alpha.8",
   "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.7",
+    "@middy/util": "^3.0.0-alpha.8",
     "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.7",
+    "@middy/core": "^3.0.0-alpha.8",
     "@types/http-errors": "^1.8.1",
     "ajv-bsontype": "^1.0.7"
   },
-  "gitHead": "5cef39ebe49c201f97d71bb0680004de4b82cb91"
+  "gitHead": "c04b3a0c2f326906b34973878d6f823778a5ea99"
 }