@middy/validator 2.5.3 → 3.0.0-alpha.2

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2021 Luciano Mammino, will Farrell and the [Middy team](https://github.com/middyjs/middy/graphs/contributors)
+Copyright (c) 2017-2022 Luciano Mammino, will Farrell and the [Middy team](https://github.com/middyjs/middy/graphs/contributors)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -57,7 +57,7 @@ npm install --save @middy/validator
    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)
     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`
 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.
@@ -148,7 +148,7 @@ Everyone is very welcome to contribute to this repository. Feel free to [raise i
 
 ## License
 
-Licensed under [MIT License](LICENSE). Copyright (c) 2017-2021 Luciano Mammino, will Farrell, and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).
+Licensed under [MIT License](LICENSE). Copyright (c) 2017-2022 Luciano Mammino, will Farrell, and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).
 
 <a href="https://app.fossa.io/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy?ref=badge_large">
   <img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy.svg?type=large" alt="FOSSA Status"  style="max-width:100%;">

package/index.d.ts

@@ -8,6 +8,7 @@ interface Options {
   ajvOptions?: Partial<AjvOptions>
   ajvInstance?: Ajv
   defaultLanguage?: string
+  i18nEnabled?: boolean
 }
 
 declare function validator (options?: Options): middy.MiddlewareObj

package/index.js

@@ -1,35 +1,24 @@
-"use strict";
-
-const {
-  createError
-} = require('@middy/util');
-
-const _ajv = require('ajv/dist/2019');
-
-const localize = require('ajv-i18n');
-
-const formats = require('ajv-formats');
-
-const formatsDraft2019 = require('ajv-formats-draft2019');
-
-const Ajv = _ajv.default; // esm workaround for linting
-
+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',
-  // important for query string params
   allErrors: true,
   useDefaults: 'empty',
-  messages: false // allow i18n
-
+  messages: false
 };
 const defaults = {
   inputSchema: undefined,
   outputSchema: undefined,
   ajvOptions: {},
   ajvInstance: undefined,
-  defaultLanguage: 'en'
+  defaultLanguage: 'en',
+  i18nEnabled: true
 };
 
 const validatorMiddleware = (opts = {}) => {
@@ -38,7 +27,8 @@ const validatorMiddleware = (opts = {}) => {
     outputSchema,
     ajvOptions,
     ajvInstance,
-    defaultLanguage
+    defaultLanguage,
+    i18nEnabled
   } = { ...defaults,
     ...opts
   };
@@ -49,12 +39,15 @@ const validatorMiddleware = (opts = {}) => {
     const valid = inputSchema(request.event);
 
     if (!valid) {
-      // Bad Request
       const error = createError(400, 'Event object failed validation');
       request.event.headers = { ...request.event.headers
       };
-      const language = chooseLanguage(request.event, defaultLanguage);
-      localize[language](inputSchema.errors);
+
+      if (i18nEnabled) {
+        const language = chooseLanguage(request.event, defaultLanguage);
+        localize[language](inputSchema.errors);
+      }
+
       error.details = inputSchema.errors;
       throw error;
     }
@@ -64,7 +57,6 @@ const validatorMiddleware = (opts = {}) => {
     const valid = outputSchema(request.response);
 
     if (!valid) {
-      // Internal Server Error
       const error = createError(500, 'Response object failed validation');
       error.details = outputSchema.errors;
       error.response = request.response;
@@ -76,23 +68,19 @@ const validatorMiddleware = (opts = {}) => {
     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) => {
-  // Check if already compiled
   if (typeof schema === 'function' || !schema) return schema;
   const options = { ...ajvDefaults,
     ...ajvOptions
   };
 
   if (!ajv) {
-    ajv = ajvInstance !== null && ajvInstance !== void 0 ? ajvInstance : new Ajv(options);
+    ajv = ajvInstance ?? new Ajv(options);
     formats(ajv);
     formatsDraft2019(ajv);
   } else if (!ajvInstance) {
-    // Update options when initializing the middleware multiple times
     ajv.opts = { ...ajv.opts,
       ...options
     };
@@ -100,25 +88,18 @@ const compile = (schema, ajvOptions, ajvInstance = null) => {
 
   return ajv.compile(schema);
 };
-/* in ajv-i18n Portuguese is represented as pt-BR */
-
 
 const languageNormalizationMap = {
   pt: 'pt-BR',
   'pt-br': 'pt-BR',
   pt_BR: 'pt-BR',
   pt_br: 'pt-BR',
-  zh: 'zh-TW',
   'zh-tw': 'zh-TW',
   zh_TW: 'zh-TW',
   zh_tw: 'zh-TW'
 };
 
-const normalizePreferredLanguage = lang => {
-  var _languageNormalizatio;
-
-  return (_languageNormalizatio = languageNormalizationMap[lang]) !== null && _languageNormalizatio !== void 0 ? _languageNormalizatio : lang;
-};
+const normalizePreferredLanguage = lang => languageNormalizationMap[lang] ?? lang;
 
 const availableLanguages = Object.keys(localize);
 
@@ -136,4 +117,4 @@ const chooseLanguage = ({
   return defaultLanguage;
 };
 
-module.exports = validatorMiddleware;
+export default validatorMiddleware;

package/package.json

@@ -1,18 +1,19 @@
 {
   "name": "@middy/validator",
-  "version": "2.5.3",
+  "version": "3.0.0-alpha.2",
   "description": "Validator middleware for the middy framework",
-  "type": "commonjs",
+  "type": "module",
   "engines": {
-    "node": ">=12"
+    "node": ">=14"
   },
   "engineStrict": true,
   "publishConfig": {
     "access": "public"
   },
-  "main": "index.js",
+  "exports": "./index.js",
   "types": "index.d.ts",
   "files": [
+    "index.js",
     "index.d.ts"
   ],
   "scripts": {
@@ -45,17 +46,16 @@
   },
   "homepage": "https://github.com/middyjs/middy#readme",
   "dependencies": {
-    "@middy/util": "^2.5.3",
-    "ajv": "8.6.3",
+    "@middy/util": "^3.0.0-alpha.2",
+    "ajv": "8.8.2",
     "ajv-formats": "2.1.1",
     "ajv-formats-draft2019": "1.6.1",
-    "ajv-i18n": "4.1.0"
+    "ajv-i18n": "4.2.0"
   },
   "devDependencies": {
-    "@middy/core": "^2.5.3",
+    "@middy/core": "^3.0.0-alpha.2",
     "@types/http-errors": "^1.8.1",
-    "ajv-bsontype": "^1.0.7",
-    "http-errors": "^1.8.0"
+    "ajv-bsontype": "^1.0.7"
   },
-  "gitHead": "690884d43b9cd632aeca9a5eba1612160b987cd4"
+  "gitHead": "de30419273ecbff08f367f47c7e320ec981cf145"
 }