@middy/validator 5.0.3 → 5.2.0

package/index.js

@@ -1,57 +1,75 @@
-import { createError } from '@middy/util';
+import { createError } from '@middy/util'
+
 const defaults = {
-    eventSchema: undefined,
-    contextSchema: undefined,
-    responseSchema: undefined,
-    defaultLanguage: 'en',
-    languages: {}
-};
-const validatorMiddleware = (opts = {})=>{
-    const { eventSchema, contextSchema, responseSchema, defaultLanguage, languages } = {
-        ...defaults,
-        ...opts
-    };
-    const validatorMiddlewareBefore = async (request)=>{
-        if (eventSchema) {
-            const validEvent = await eventSchema(request.event);
-            if (!validEvent) {
-                const localize = languages[request.context.preferredLanguage] ?? languages[defaultLanguage];
-                localize?.(eventSchema.errors);
-                throw createError(400, 'Event object failed validation', {
-                    cause: {
-                        package: '@middy/validator',
-                        data: eventSchema.errors
-                    }
-                });
-            }
-        }
-        if (contextSchema) {
-            const validContext = await contextSchema(request.context);
-            if (!validContext) {
-                throw createError(500, 'Context object failed validation', {
-                    cause: {
-                        package: '@middy/validator',
-                        data: contextSchema.errors
-                    }
-                });
-            }
-        }
-    };
-    const validatorMiddlewareAfter = async (request)=>{
-        const validResponse = await responseSchema(request.response);
-        if (!validResponse) {
-            throw createError(500, 'Response object failed validation', {
-                cause: {
-                    package: '@middy/validator',
-                    data: responseSchema.errors
-                }
-            });
+  eventSchema: undefined,
+  contextSchema: undefined,
+  responseSchema: undefined,
+  defaultLanguage: 'en',
+  languages: {}
+}
+
+const validatorMiddleware = (opts = {}) => {
+  const {
+    eventSchema,
+    contextSchema,
+    responseSchema,
+    defaultLanguage,
+    languages
+  } = { ...defaults, ...opts }
+
+  const validatorMiddlewareBefore = async (request) => {
+    if (eventSchema) {
+      const validEvent = await eventSchema(request.event)
+
+      if (!validEvent) {
+        const localize =
+          languages[request.context.preferredLanguage] ??
+          languages[defaultLanguage]
+        localize?.(eventSchema.errors)
+
+        // Bad Request
+        throw createError(400, 'Event object failed validation', {
+          cause: {
+            package: '@middy/validator',
+            data: eventSchema.errors
+          }
+        })
+      }
+    }
+
+    if (contextSchema) {
+      const validContext = await contextSchema(request.context)
+
+      if (!validContext) {
+        // Internal Server Error
+        throw createError(500, 'Context object failed validation', {
+          cause: {
+            package: '@middy/validator',
+            data: contextSchema.errors
+          }
+        })
+      }
+    }
+  }
+
+  const validatorMiddlewareAfter = async (request) => {
+    const validResponse = await responseSchema(request.response)
+
+    if (!validResponse) {
+      // Internal Server Error
+      throw createError(500, 'Response object failed validation', {
+        cause: {
+          package: '@middy/validator',
+          data: responseSchema.errors
         }
-    };
-    return {
-        before: eventSchema ?? contextSchema ? validatorMiddlewareBefore : undefined,
-        after: responseSchema ? validatorMiddlewareAfter : undefined
-    };
-};
-export default validatorMiddleware;
+      })
+    }
+  }
+  return {
+    before:
+      eventSchema ?? contextSchema ? validatorMiddlewareBefore : undefined,
+    after: responseSchema ? validatorMiddlewareAfter : undefined
+  }
+}
 
+export default validatorMiddleware

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/validator",
-  "version": "5.0.3",
+  "version": "5.2.0",
   "description": "Validator middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -67,7 +67,7 @@
     "url": "https://github.com/sponsors/willfarrell"
   },
   "dependencies": {
-    "@middy/util": "5.0.3",
+    "@middy/util": "5.2.0",
     "ajv": "8.12.0",
     "ajv-errors": "3.0.0",
     "ajv-formats": "2.1.1",
@@ -77,10 +77,10 @@
     "fast-uri": "2.3.0"
   },
   "devDependencies": {
-    "@middy/core": "5.0.3",
+    "@middy/core": "5.2.0",
     "@types/http-errors": "^2.0.0",
     "ajv-bsontype": "^1.0.7",
     "ajv-cmd": "0.3.4"
   },
-  "gitHead": "87660575a7ac2b52e4153c407a4c63c9449dcd0d"
+  "gitHead": "2d9096a49cd8fb62359517be96d6c93609df41f0"
 }

package/transpile.js

@@ -1,48 +1,73 @@
-import Ajv from 'ajv/dist/2020.js';
-import ajvFormats from 'ajv-formats';
-import ajvFormatsDraft2019 from 'ajv-formats-draft2019';
-import ajvKeywords from 'ajv-keywords';
-import ajvErrors from 'ajv-errors';
-import uriResolver from 'fast-uri';
-import { transpile } from 'ajv-ftl-i18n';
-export const transpileFTL = transpile;
+/*
+import compileSchema from 'ajv-cmd/compile'
+import transpileFTL from 'ajv-cmd/ftl'
+
+const ajvDefaults = {
+  strict: true,
+  coerceTypes: 'array', // important for query string params
+  allErrors: true,
+  useDefaults: 'empty',
+  messages: true // needs to be true to allow multi-locale errorMessage to work
+}
+
+// This is pulled out due to it's performance cost (50-100ms on cold start)
+// Precompile your schema during a build step is recommended.
+export const transpileSchema = (schema, ajvOptions) => {
+  const options = { ...ajvDefaults, ...ajvOptions }
+  return compileSchema(schema, options)
+}
+
+export const transpileLocale = transpileFTL
+*/
+
+import Ajv from 'ajv/dist/2020.js'
+import ajvFormats from 'ajv-formats'
+import ajvFormatsDraft2019 from 'ajv-formats-draft2019'
+import ajvKeywords from 'ajv-keywords'
+import ajvErrors from 'ajv-errors'
+import uriResolver from 'fast-uri'
+
+import { transpile } from 'ajv-ftl-i18n'
+
+// import transpileFTL from 'ajv-cmd/ftl'
+export const transpileFTL = transpile
+
+// *** Start `ajv-cmd/compile` *** //
+// import compileSchema from 'ajv-cmd/compile'
+
 const defaultOptions = {
-    uriResolver
-};
-const instance = (options = {})=>{
-    options = {
-        ...defaultOptions,
-        ...options,
-        keywords: []
-    };
-    const ajv = new Ajv(options);
-    ajvFormats(ajv);
-    ajvFormatsDraft2019(ajv);
-    ajvKeywords(ajv);
-    ajvErrors(ajv);
-    return ajv;
-};
-const compileSchema = (schema, options = {})=>{
-    options = {
-        ...defaultOptions,
-        ...options,
-        keywords: []
-    };
-    const ajv = instance(options);
-    return ajv.compile(schema);
-};
+  uriResolver // faster than default
+}
+
+const instance = (options = {}) => {
+  options = { ...defaultOptions, ...options, keywords: [] }
+
+  const ajv = new Ajv(options)
+  ajvFormats(ajv)
+  ajvFormatsDraft2019(ajv)
+  ajvKeywords(ajv)
+  ajvErrors(ajv)
+  return ajv
+}
+
+const compileSchema = (schema, options = {}) => {
+  options = { ...defaultOptions, ...options, keywords: [] }
+  const ajv = instance(options)
+  return ajv.compile(schema)
+}
+// *** End `ajv-cmd/compile` *** //
+
 const ajvDefaults = {
-    strict: true,
-    coerceTypes: 'array',
-    allErrors: true,
-    useDefaults: 'empty',
-    messages: true
-};
-export const transpileSchema = (schema, ajvOptions)=>{
-    const options = {
-        ...ajvDefaults,
-        ...ajvOptions
-    };
-    return compileSchema(schema, options);
-};
+  strict: true,
+  coerceTypes: 'array', // important for query string params
+  allErrors: true,
+  useDefaults: 'empty',
+  messages: true // needs to be true to allow multi-locale errorMessage to work
+}
 
+// This is pulled out due to it's performance cost (50-100ms on cold start)
+// Precompile your schema during a build step is recommended.
+export const transpileSchema = (schema, ajvOptions) => {
+  const options = { ...ajvDefaults, ...ajvOptions }
+  return compileSchema(schema, options)
+}