@middy/validator 5.0.0-alpha.0 → 5.0.0-alpha.1

package/README.md

@@ -19,8 +19,9 @@
   <a href="https://snyk.io/test/github/middyjs/middy">
     <img src="https://snyk.io/test/github/middyjs/middy/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/middyjs/middy" style="max-width:100%;">
   </a>
-  <a href="https://lgtm.com/projects/g/middyjs/middy/context:javascript">
-    <img src="https://img.shields.io/lgtm/grade/javascript/g/middyjs/middy.svg?logo=lgtm&logoWidth=18" alt="Language grade: JavaScript" style="max-width:100%;">
+  <a href="https://github.com/middyjs/middy/actions/workflows/sast.yml">
+    <img src="https://github.com/middyjs/middy/actions/workflows/sast.yml/badge.svg
+?branch=main&event=push" alt="CodeQL" style="max-width:100%;">
   </a>
   <a href="https://bestpractices.coreinfrastructure.org/projects/5280">
     <img src="https://bestpractices.coreinfrastructure.org/projects/5280/badge" alt="Core Infrastructure Initiative (CII) Best Practices"  style="max-width:100%;">

package/index.js

@@ -1,48 +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.event.preferredLanguage] ?? languages[defaultLanguage];
-                localize?.(eventSchema.errors);
-                throw createError(400, 'Event object failed validation', {
-                    cause: eventSchema.errors
-                });
-            }
-        }
-        if (contextSchema) {
-            const validContext = await contextSchema(request.context);
-            if (!validContext) {
-                throw createError(500, 'Context object failed validation', {
-                    cause: contextSchema.errors
-                });
-            }
-        }
-    };
-    const validatorMiddlewareAfter = async (request)=>{
-        const validResponse = await responseSchema(request.response);
-        if (!validResponse) {
-            throw createError(500, 'Response object failed validation', {
-                cause: 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: {
+            pacakge: '@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.0-alpha.0",
+  "version": "5.0.0-alpha.1",
   "description": "Validator middleware for the middy framework",
   "type": "module",
   "engines": {
@@ -10,37 +10,26 @@
   "publishConfig": {
     "access": "public"
   },
-  "main": "./index.cjs",
   "module": "./index.js",
   "exports": {
     ".": {
       "import": {
         "types": "./index.d.ts",
         "default": "./index.js"
-      },
-      "require": {
-        "types": "./index.d.ts",
-        "default": "./index.cjs"
       }
     },
     "./transpile": {
       "import": {
         "types": "./transpile.d.ts",
         "default": "./transpile.js"
-      },
-      "require": {
-        "types": "./transpile.d.ts",
-        "default": "./transpile.cjs"
       }
     }
   },
   "types": "index.d.ts",
   "files": [
     "index.js",
-    "index.cjs",
     "index.d.ts",
     "transpile.js",
-    "transpile.cjs",
     "transpile.d.ts"
   ],
   "scripts": {
@@ -78,13 +67,20 @@
     "url": "https://github.com/sponsors/willfarrell"
   },
   "dependencies": {
-    "@middy/util": "5.0.0-alpha.0",
-    "ajv-cmd": "0.3.3"
+    "@middy/util": "5.0.0-alpha.1",
+    "ajv": "8.12.0",
+    "ajv-errors": "3.0.0",
+    "ajv-formats": "2.1.1",
+    "ajv-formats-draft2019": "1.6.1",
+    "ajv-ftl-i18n": "0.1.1",
+    "ajv-keywords": "5.1.0",
+    "fast-uri": "2.2.0"
   },
   "devDependencies": {
-    "@middy/core": "5.0.0-alpha.0",
+    "@middy/core": "5.0.0-alpha.1",
     "@types/http-errors": "^2.0.0",
-    "ajv-bsontype": "^1.0.7"
+    "ajv-bsontype": "^1.0.7",
+    "ajv-cmd": "0.3.4"
   },
-  "gitHead": "08c35e3dba9efdad0b86666ce206ce302cc65d07"
+  "gitHead": "ebce8d5df8783077fa49ba62ee9be20e8486a7f1"
 }

package/transpile.js

@@ -1,18 +1,73 @@
-import compileSchema from 'ajv-cmd/compile';
-import transpileFTL from 'ajv-cmd/ftl';
+/*
+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 // 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);
-};
-export const transpileLocale = transpileFTL;
+  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)
+}

package/index.cjs

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(module, "exports", {
-    enumerable: true,
-    get: ()=>_default
-});
-const _util = require("@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.event.preferredLanguage] ?? languages[defaultLanguage];
-                localize?.(eventSchema.errors);
-                throw (0, _util.createError)(400, 'Event object failed validation', {
-                    cause: eventSchema.errors
-                });
-            }
-        }
-        if (contextSchema) {
-            const validContext = await contextSchema(request.context);
-            if (!validContext) {
-                throw (0, _util.createError)(500, 'Context object failed validation', {
-                    cause: contextSchema.errors
-                });
-            }
-        }
-    };
-    const validatorMiddlewareAfter = async (request)=>{
-        const validResponse = await responseSchema(request.response);
-        if (!validResponse) {
-            throw (0, _util.createError)(500, 'Response object failed validation', {
-                cause: responseSchema.errors
-            });
-        }
-    };
-    return {
-        before: eventSchema ?? contextSchema ? validatorMiddlewareBefore : undefined,
-        after: responseSchema ? validatorMiddlewareAfter : undefined
-    };
-};
-const _default = validatorMiddleware;
-

package/transpile.cjs

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: all[name]
-    });
-}
-_export(exports, {
-    transpileSchema: ()=>transpileSchema,
-    transpileLocale: ()=>transpileLocale
-});
-const _compile = _interopRequireDefault(require("ajv-cmd/compile"));
-const _ftl = _interopRequireDefault(require("ajv-cmd/ftl"));
-function _interopRequireDefault(obj) {
-    return obj && obj.__esModule ? obj : {
-        default: obj
-    };
-}
-const ajvDefaults = {
-    strict: true,
-    coerceTypes: 'array',
-    allErrors: true,
-    useDefaults: 'empty',
-    messages: true
-};
-const transpileSchema = (schema, ajvOptions)=>{
-    const options = {
-        ...ajvDefaults,
-        ...ajvOptions
-    };
-    return (0, _compile.default)(schema, options);
-};
-const transpileLocale = _ftl.default;
-