relocate framework files

src/openapi.context.ts → src/framework/openapi.context.ts

@@ -1,5 +1,5 @@
 import { OpenApiSpecLoader } from './openapi.spec.loader';
-import { OpenAPIFrameworkArgs } from './framework';
+import { OpenAPIFrameworkArgs } from './index';
 
 export class OpenApiContext {
   // TODO cleanup structure (group related functionality)
@@ -13,7 +13,7 @@ export class OpenApiContext {
     const { apiDoc, basePaths, routes } = openApiRouteDiscovery.load();
 
     this.apiDoc = apiDoc;
-    this.basePaths = <Set<string>> basePaths;
+    this.basePaths = <Set<string>>basePaths;
     this.routes = this.initializeRoutes(routes);
   }
 

src/openapi.spec.loader.ts → src/framework/openapi.spec.loader.ts

@@ -2,8 +2,8 @@ import * as _ from 'lodash';
 import OpenAPIFramework, {
   OpenAPIFrameworkArgs,
   OpenAPIFrameworkConstructorArgs,
-} from './framework';
-import { OpenAPIFrameworkAPIContext } from './framework/types';
+} from './index';
+import { OpenAPIFrameworkAPIContext } from './types';
 
 export class OpenApiSpecLoader {
   private opts: OpenAPIFrameworkArgs;

src/index.ts

@@ -1,9 +1,9 @@
-import * as _ from 'lodash';
-import { Application, Request, Response, NextFunction } from 'express';
-import { OpenApiContext } from './openapi.context';
-import * as middlewares from './middlewares';
 import ono from 'ono';
+import * as _ from 'lodash';
+import { Application } from 'express';
+import { OpenApiContext } from './framework/openapi.context';
 import { OpenAPIV3, OpenApiRequest } from './framework/types';
+import * as middlewares from './middlewares';
 
 export interface OpenApiValidatorOpts {
   apiSpec: OpenAPIV3.Document | string;

src/middlewares/openapi.metadata.ts

@@ -1,6 +1,6 @@
 import * as pathToRegexp from 'path-to-regexp';
 import * as _ from 'lodash';
-import { OpenApiContext } from '../openapi.context';
+import { OpenApiContext } from '../framework/openapi.context';
 
 export function applyOpenApiMetadata(openApiContext: OpenApiContext) {
   return (req, res, next) => {

src/middlewares/openapi.multipart.ts

@@ -1,5 +1,5 @@
-import { OpenApiContext } from '../openapi.context';
-import { validationError } from '../errors';
+import { OpenApiContext } from '../framework/openapi.context';
+import { validationError } from './util';
 import * as multer from 'multer';
 
 export function multipart(openApiContext: OpenApiContext, multerOpts: {} = {}) {

src/middlewares/openapi.request.validator.ts

@@ -1,6 +1,9 @@
 import { createRequestAjv } from './ajv';
-import { extractContentType } from './util';
-import { validationError, ajvErrorsToValidatorError } from '../errors';
+import {
+  extractContentType,
+  validationError,
+  ajvErrorsToValidatorError,
+} from './util';
 import ono from 'ono';
 
 const TYPE_JSON = 'application/json';

src/middlewares/openapi.response.validator.ts

@@ -1,9 +1,8 @@
+import ono from 'ono';
 import * as Ajv from 'ajv';
 import * as mung from 'express-mung';
-import { validationError, ajvErrorsToValidatorError } from '../errors';
-import ono from 'ono';
 import { createResponseAjv } from './ajv';
-import { extractContentType } from './util';
+import { extractContentType, ajvErrorsToValidatorError } from './util';
 
 const TYPE_JSON = 'application/json';
 

src/middlewares/util.ts

@@ -1,3 +1,5 @@
+import ono from 'ono';
+
 export function extractContentType(req) {
   let contentType = req.headers['content-type'] || 'not_provided';
   let end = contentType.indexOf(';');
@@ -7,3 +9,41 @@ export function extractContentType(req) {
   }
   return contentType;
 }
+
+const _validationError = (
+  status: number,
+  path: string,
+  message: string,
+  errors?: any, // TODO rename - normalize...something else
+) => ({
+  status,
+  errors: [
+    {
+      path,
+      message,
+      ...({ errors } || {}),
+    },
+  ],
+});
+
+export function validationError(status, path, message) {
+  const err = _validationError(status, path, message);
+  return ono(err, message);
+}
+
+export function ajvErrorsToValidatorError(status, errors) {
+  return {
+    status,
+    errors: errors.map(e => {
+      const required =
+        e.params &&
+        e.params.missingProperty &&
+        e.dataPath + '.' + e.params.missingProperty;
+      return {
+        path: required || e.dataPath || e.schemaPath,
+        message: e.message,
+        errorCode: `${e.keyword}.openapi.validation`,
+      };
+    }),
+  };
+}