@middy/validator 3.0.0-alpha.0 → 3.0.0-alpha.4

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

@@ -0,0 +1,116 @@
+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);
+      }
+
+      throw createError(400, 'Event object failed validation', {
+        cause: inputSchema.errors
+      });
+    }
+  };
+
+  const validatorMiddlewareAfter = async request => {
+    const valid = outputSchema(request.response);
+
+    if (!valid) {
+      throw createError(500, 'Response object failed validation', {
+        cause: outputSchema.errors
+      });
+    }
+  };
+
+  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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/validator",
-  "version": "3.0.0-alpha.0",
+  "version": "3.0.0-alpha.4",
   "description": "Validator middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -13,11 +13,13 @@
   "exports": "./index.js",
   "types": "index.d.ts",
   "files": [
+    "index.js",
     "index.d.ts"
   ],
   "scripts": {
     "test": "npm run test:unit",
-    "test:unit": "ava"
+    "test:unit": "ava",
+    "test:benchmark": "node __benchmarks__/index.js"
   },
   "license": "MIT",
   "keywords": [
@@ -45,16 +47,16 @@
   },
   "homepage": "https://github.com/middyjs/middy#readme",
   "dependencies": {
-    "@middy/util": "^3.0.0-alpha.0",
+    "@middy/util": "^3.0.0-alpha.4",
     "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.0",
+    "@middy/core": "^3.0.0-alpha.4",
     "@types/http-errors": "^1.8.1",
     "ajv-bsontype": "^1.0.7"
   },
-  "gitHead": "c533f62841c8a39d061d7b94f30ba178f002c8db"
+  "gitHead": "d4bea7f4e21f6a9bbb1f6f6908361169598b9e53"
 }