@middy/validator 3.0.0-alpha.2 → 3.0.0-alpha.3

package/README.md

@@ -62,7 +62,7 @@ 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.
 - Default ajv plugins used: `ajv-i18n`, `ajv-formats`, `ajv-formats-draft2019`
-- If you'd like to have the error details as part of the response, it will need to be handled separately. You can access them from `request.error.details`, the original response can be found at `request.error.response`. 
+- If you'd like to have the error details as part of the response, it will need to be handled separately. You can access them from `request.error.cause`, the original response can be found at `request.error.response`. 
 
 ## Sample usage
 

package/index.js

@@ -1,17 +1,20 @@
-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;
+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 // esm workaround for linting
+
+let ajv
 const ajvDefaults = {
   strict: true,
-  coerceTypes: 'array',
+  coerceTypes: 'array', // important for query string params
   allErrors: true,
   useDefaults: 'empty',
-  messages: false
-};
+  messages: false // allow i18n
+}
+
 const defaults = {
   inputSchema: undefined,
   outputSchema: undefined,
@@ -19,7 +22,7 @@ const defaults = {
   ajvInstance: undefined,
   defaultLanguage: 'en',
   i18nEnabled: true
-};
+}
 
 const validatorMiddleware = (opts = {}) => {
   let {
@@ -29,66 +32,56 @@ const validatorMiddleware = (opts = {}) => {
     ajvInstance,
     defaultLanguage,
     i18nEnabled
-  } = { ...defaults,
-    ...opts
-  };
-  inputSchema = compile(inputSchema, ajvOptions, ajvInstance);
-  outputSchema = compile(outputSchema, ajvOptions, ajvInstance);
+  } = { ...defaults, ...opts }
+  inputSchema = compile(inputSchema, ajvOptions, ajvInstance)
+  outputSchema = compile(outputSchema, ajvOptions, ajvInstance)
 
-  const validatorMiddlewareBefore = async request => {
-    const valid = inputSchema(request.event);
+  const validatorMiddlewareBefore = async (request) => {
+    const valid = inputSchema(request.event)
 
     if (!valid) {
-      const error = createError(400, 'Event object failed validation');
-      request.event.headers = { ...request.event.headers
-      };
-
       if (i18nEnabled) {
-        const language = chooseLanguage(request.event, defaultLanguage);
-        localize[language](inputSchema.errors);
+        const language = chooseLanguage(request.event, defaultLanguage)
+        localize[language](inputSchema.errors)
       }
 
-      error.details = inputSchema.errors;
-      throw error;
+      // Bad Request
+      throw createError(400, 'Event object failed validation', { cause: inputSchema.errors })
     }
-  };
+  }
 
-  const validatorMiddlewareAfter = async request => {
-    const valid = outputSchema(request.response);
+  const validatorMiddlewareAfter = async (request) => {
+    const valid = outputSchema(request.response)
 
     if (!valid) {
-      const error = createError(500, 'Response object failed validation');
-      error.details = outputSchema.errors;
-      error.response = request.response;
-      throw error;
+      // Internal Server Error
+      throw createError(500, 'Response object failed validation', { cause: outputSchema.errors })
     }
-  };
-
+  }
   return {
     before: inputSchema ? validatorMiddlewareBefore : undefined,
     after: outputSchema ? validatorMiddlewareAfter : undefined
-  };
-};
+  }
+}
 
+// This is pulled out due to it's performance cost (50-100ms on cold start)
+// Precompile your schema during a build step is recommended.
 const compile = (schema, ajvOptions, ajvInstance = null) => {
-  if (typeof schema === 'function' || !schema) return schema;
-  const options = { ...ajvDefaults,
-    ...ajvOptions
-  };
-
+  // Check if already compiled
+  if (typeof schema === 'function' || !schema) return schema
+  const options = { ...ajvDefaults, ...ajvOptions }
   if (!ajv) {
-    ajv = ajvInstance ?? new Ajv(options);
-    formats(ajv);
-    formatsDraft2019(ajv);
+    ajv = ajvInstance ?? new Ajv(options)
+    formats(ajv)
+    formatsDraft2019(ajv)
   } else if (!ajvInstance) {
-    ajv.opts = { ...ajv.opts,
-      ...options
-    };
+    // Update options when initializing the middleware multiple times
+    ajv.opts = { ...ajv.opts, ...options }
   }
+  return ajv.compile(schema)
+}
 
-  return ajv.compile(schema);
-};
-
+/* in ajv-i18n Portuguese is represented as pt-BR */
 const languageNormalizationMap = {
   pt: 'pt-BR',
   'pt-br': 'pt-BR',
@@ -97,24 +90,21 @@ const languageNormalizationMap = {
   'zh-tw': 'zh-TW',
   zh_TW: 'zh-TW',
   zh_tw: 'zh-TW'
-};
-
-const normalizePreferredLanguage = lang => languageNormalizationMap[lang] ?? lang;
+}
 
-const availableLanguages = Object.keys(localize);
+const normalizePreferredLanguage = (lang) =>
+  languageNormalizationMap[lang] ?? lang
 
-const chooseLanguage = ({
-  preferredLanguage
-}, defaultLanguage) => {
+const availableLanguages = Object.keys(localize)
+const chooseLanguage = ({ preferredLanguage }, defaultLanguage) => {
   if (preferredLanguage) {
-    const lang = normalizePreferredLanguage(preferredLanguage);
-
+    const lang = normalizePreferredLanguage(preferredLanguage)
     if (availableLanguages.includes(lang)) {
-      return lang;
+      return lang
     }
   }
 
-  return defaultLanguage;
-};
+  return defaultLanguage
+}
 
-export default validatorMiddleware;
+export default validatorMiddleware

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/validator",
-  "version": "3.0.0-alpha.2",
+  "version": "3.0.0-alpha.3",
   "description": "Validator middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -18,7 +18,8 @@
   ],
   "scripts": {
     "test": "npm run test:unit",
-    "test:unit": "ava"
+    "test:unit": "ava",
+    "test:benchmark": "node __benchmarks__/index.js"
   },
   "license": "MIT",
   "keywords": [
@@ -46,16 +47,16 @@
   },
   "homepage": "https://github.com/middyjs/middy#readme",
   "dependencies": {
-    "@middy/util": "^3.0.0-alpha.2",
+    "@middy/util": "^3.0.0-alpha.3",
     "ajv": "8.8.2",
     "ajv-formats": "2.1.1",
     "ajv-formats-draft2019": "1.6.1",
     "ajv-i18n": "4.2.0"
   },
   "devDependencies": {
-    "@middy/core": "^3.0.0-alpha.2",
+    "@middy/core": "^3.0.0-alpha.3",
     "@types/http-errors": "^1.8.1",
     "ajv-bsontype": "^1.0.7"
   },
-  "gitHead": "de30419273ecbff08f367f47c7e320ec981cf145"
+  "gitHead": "1441158711580313765e6d156046ef0fade0d156"
 }