linter fixes

src/framework/types.ts

@@ -25,7 +25,7 @@ export type ValidateRequestOpts = {
 };
 
 export type ValidateResponseOpts = {
-  removeAdditional?: string | boolean;
+  removeAdditional?: 'failing' | boolean;
 };
 
 export interface OpenApiValidatorOpts {

src/middlewares/ajv/index.ts

@@ -15,14 +15,14 @@ export function createRequestAjv(
 
 export function createResponseAjv(
   openApiSpec: OpenAPIV3.Document,
-  options: any = {},
+  options: ajv.Options = {},
 ): Ajv.Ajv {
   return createAjv(openApiSpec, options, false);
 }
 
 function createAjv(
   openApiSpec: OpenAPIV3.Document,
-  options: any = {},
+  options: ajv.Options = {},
   request = true,
 ): Ajv.Ajv {
   const ajv = new Ajv({
@@ -36,7 +36,7 @@ function createAjv(
   ajv.removeKeyword('propertyNames');
   ajv.removeKeyword('contains');
   ajv.removeKeyword('const');
-  
+
   if (request) {
     ajv.removeKeyword('readOnly');
     ajv.addKeyword('readOnly', {

src/middlewares/openapi.multipart.ts

@@ -6,6 +6,7 @@ import {
   OpenApiRequestHandler,
   OpenApiRequestMetadata,
   OpenAPIV3,
+  ValidationError,
 } from '../framework/types';
 const multer = require('multer');
 
@@ -67,7 +68,7 @@ function isMultipart(req: OpenApiRequest): boolean {
   );
 }
 
-function error(req: OpenApiRequest, err: Error) {
+function error(req: OpenApiRequest, err: Error): ValidationError {
   if (err instanceof multer.MulterError) {
     // TODO is special handling for MulterErrors needed
     return validationError(500, req.path, err.message);

src/middlewares/openapi.request.validator.ts

@@ -20,7 +20,7 @@ import { HandleFunction } from 'connect';
 const TYPE_JSON = 'application/json';
 
 export class RequestValidator {
-  private _middlewareCache;
+  private _middlewareCache: { string?: (string) => HandleFunction } = {};
   private _apiDocs: OpenAPIV3.Document;
   private ajv: Ajv;
   private _requestOpts: ValidateRequestOpts = {};
@@ -84,7 +84,7 @@ export class RequestValidator {
   ): HandleFunction {
     const parameters = this.parametersToSchema(path, pathSchema.parameters);
 
-    let usedSecuritySchema = [];
+    let usedSecuritySchema: OpenAPIV3.SecurityRequirementObject[] = [];
     if (
       pathSchema.hasOwnProperty('security') &&
       pathSchema.security.length > 0
@@ -206,7 +206,11 @@ export class RequestValidator {
     };
   }
 
-  private rejectUnknownQueryParams(query, schema, whiteList = []) {
+  private rejectUnknownQueryParams(
+    query,
+    schema,
+    whiteList: string[] = [],
+  ): void {
     if (!schema.properties) return;
     const knownQueryParams = new Set(Object.keys(schema.properties));
     whiteList.forEach(item => knownQueryParams.add(item));
@@ -226,7 +230,7 @@ export class RequestValidator {
     path: string,
     contentType: ContentType,
     requestBody: OpenAPIV3.RequestBodyObject,
-  ) {
+  ): object {
     if (requestBody.content) {
       let content = null;
       for (const type of contentType.equivalents()) {
@@ -287,7 +291,10 @@ export class RequestValidator {
     }
   }
 
-  private getSecurityQueryParams(usedSecuritySchema, securitySchema) {
+  private getSecurityQueryParams(
+    usedSecuritySchema: OpenAPIV3.SecurityRequirementObject[],
+    securitySchema,
+  ): string[] {
     return usedSecuritySchema && securitySchema
       ? usedSecuritySchema
           .filter(obj => Object.entries(obj).length !== 0)
@@ -300,7 +307,7 @@ export class RequestValidator {
       : [];
   }
 
-  private parametersToSchema(path, parameters = []) {
+  private parametersToSchema(path: string, parameters = []) {
     const schema = { query: {}, headers: {}, params: {}, cookies: {} };
     const reqFields = {
       query: 'query',

src/middlewares/openapi.response.validator.ts

@@ -1,5 +1,5 @@
 import ono from 'ono';
-import * as Ajv from 'ajv';
+import * as ajv from 'ajv';
 import mung from './modded.express.mung';
 import { createResponseAjv } from './ajv';
 import {
@@ -13,11 +13,11 @@ import { OpenAPIV3 } from '../framework/types';
 const TYPE_JSON = 'application/json';
 
 export class ResponseValidator {
-  private ajv: Ajv.Ajv;
+  private ajv: ajv.Ajv;
   private spec: OpenAPIV3.Document;
   private validatorsCache = {};
 
-  constructor(openApiSpec: OpenAPIV3.Document, options: any = {}) {
+  constructor(openApiSpec: OpenAPIV3.Document, options: ajv.Options = {}) {
     this.spec = openApiSpec;
     this.ajv = createResponseAjv(openApiSpec, options);
     (<any>mung).onError = (err, req, res, next) => {
@@ -45,7 +45,8 @@ export class ResponseValidator {
       return this.buildValidators(responses);
     }
 
-    const contentTypeKey = ContentType.from(req).equivalents()[0] || 'not_provided';
+    const contentTypeKey =
+      ContentType.from(req).equivalents()[0] || 'not_provided';
     const key = `${req.method}-${req.originalUrl}-${contentTypeKey}`;
 
     let validators = this.validatorsCache[key];

src/middlewares/openapi.security.ts

@@ -177,7 +177,7 @@ class AuthValidator {
     this.scopes = scopes;
   }
 
-  validate() {
+  public validate(): void {
     this.validateApiKey();
     this.validateHttp();
     this.validateOauth2();
@@ -252,7 +252,7 @@ class AuthValidator {
 }
 
 class Util {
-  static isEmptyObject(o: Object) {
+  static isEmptyObject(o: {}) {
     return (
       typeof o === 'object' &&
       Object.entries(o).length === 0 &&

src/middlewares/util.ts

@@ -19,11 +19,11 @@ export class ContentType {
       }
     }
   }
-  static from(req: Request): ContentType {
+  public static from(req: Request): ContentType {
     return new ContentType(req.headers['content-type']);
   }
 
-  equivalents(): string[] {
+  public equivalents(): string[] {
     if (!this.withoutBoundary) return [];
     if (this.charSet) {
       return [this.mediaType, `${this.mediaType}; ${this.charSet}`];

test/additional.props.spec.ts

@@ -3,8 +3,7 @@ import * as path from 'path';
 import * as express from 'express';
 import { expect } from 'chai';
 import { createApp } from './common/app';
-
-const packageJson = require('../package.json');
+import * as packageJson from '../package.json';
 
 describe(packageJson.name, () => {
   let app = null;

test/coercion.spec.ts

@@ -3,8 +3,7 @@ import * as express from 'express';
 import { expect } from 'chai';
 import * as request from 'supertest';
 import { createApp } from './common/app';
-
-const packageJson = require('../package.json');
+import * as packageJson from '../package.json';
 
 describe(packageJson.name, () => {
   let app = null;

test/common/app.common.ts

@@ -1,7 +1,7 @@
 import * as http from 'http';
 import * as express from 'express';
 
-export function startServer(app, port): Promise<http.Server> {
+export function startServer(app, port: number): Promise<http.Server> {
   return new Promise((resolve, reject) => {
     const http = require('http');
     const server = http.createServer(app);

test/common/app.ts

@@ -10,9 +10,9 @@ import { OpenApiValidatorOpts } from '../../src/framework/types';
 
 export async function createApp(
   opts?: OpenApiValidatorOpts,
-  port: number = 3000,
-  customRoutes: (app) => void = () => {},
-  useRoutes: boolean = true,
+  port = 3000,
+  customRoutes = app => {},
+  useRoutes = true,
 ) {
   var app = express();
   (<any>app).basePath = '/v1';
@@ -25,7 +25,7 @@ export async function createApp(
   app.use(cookieParser());
   app.use(express.static(path.join(__dirname, 'public')));
 
-  await new OpenApiValidator(opts).install(app)
+  await new OpenApiValidator(opts).install(app);
 
   if (useRoutes) {
     // register common routes

test/common/myapp.ts

@@ -1,10 +1,11 @@
-const express = require('express');
-const path = require('path');
-const cookieParser = require('cookie-parser');
-const bodyParser = require('body-parser');
-const logger = require('morgan');
-const http = require('http');
-const OpenApiValidator = require('../../src').OpenApiValidator;
+import * as express from 'express';
+import * as path from 'path';
+import * as cookieParser from 'cookie-parser';
+import * as bodyParser from 'body-parser';
+import * as logger from 'morgan';
+import * as http from 'http';
+import { OpenApiValidator } from '../../src';
+
 const app = express();
 
 app.use(bodyParser.urlencoded());

test/nullable.spec.ts

@@ -3,12 +3,10 @@ import * as express from 'express';
 import { expect } from 'chai';
 import * as request from 'supertest';
 import { createApp } from './common/app';
-
-const packageJson = require('../package.json');
+import * as packageJson from '../package.json';
 
 describe(packageJson.name, () => {
   let app = null;
-  let basePath = null;
 
   before(async () => {
     // Set up the express app

test/one.of.spec.ts

@@ -1,10 +1,8 @@
 import * as path from 'path';
-import * as express from 'express';
 import { expect } from 'chai';
 import * as request from 'supertest';
 import { createApp } from './common/app';
-
-const packageJson = require('../package.json');
+import * as packageJson from '../package.json';
 
 describe(packageJson.name, () => {
   let app = null;

test/openapi.spec.ts

@@ -2,8 +2,7 @@ import * as path from 'path';
 import { expect } from 'chai';
 import * as request from 'supertest';
 import { createApp } from './common/app';
-
-const packageJson = require('../package.json');
+import * as packageJson from '../package.json';
 
 describe(packageJson.name, () => {
   let apps = [];

test/path.level.parameters.spec.ts

@@ -3,8 +3,7 @@ import * as express from 'express';
 import { expect } from 'chai';
 import * as request from 'supertest';
 import { createApp } from './common/app';
-
-const packageJson = require('../package.json');
+import * as packageJson from '../package.json';
 
 describe(packageJson.name, () => {
   let app = null;

test/query.params.allow.unknown.spec.ts

@@ -2,8 +2,7 @@ import * as path from 'path';
 import * as express from 'express';
 import * as request from 'supertest';
 import { createApp } from './common/app';
-
-const packageJson = require('../package.json');
+import * as packageJson from '../package.json';
 
 describe(packageJson.name, () => {
   let app = null;

test/query.params.spec.ts

@@ -3,8 +3,7 @@ import * as express from 'express';
 import { expect } from 'chai';
 import * as request from 'supertest';
 import { createApp } from './common/app';
-
-const packageJson = require('../package.json');
+import * as packageJson from '../package.json';
 
 describe(packageJson.name, () => {
   let app = null;

test/read.only.spec.ts

@@ -3,8 +3,7 @@ import * as express from 'express';
 import { expect } from 'chai';
 import * as request from 'supertest';
 import { createApp } from './common/app';
-
-const packageJson = require('../package.json');
+import * as packageJson from '../package.json';
 
 describe(packageJson.name, () => {
   let app = null;

test/request.bodies.ref.spec.ts

@@ -3,8 +3,7 @@ import * as express from 'express';
 import { expect } from 'chai';
 import * as request from 'supertest';
 import { createApp } from './common/app';
-
-const packageJson = require('../package.json');
+import * as packageJson from '../package.json';
 
 describe(packageJson.name, () => {
   let app = null;

test/response.validation.options.spec.ts

@@ -3,8 +3,8 @@ import * as express from 'express';
 import { expect } from 'chai';
 import * as request from 'supertest';
 import { createApp } from './common/app';
+import * as packageJson from '../package.json';
 
-const packageJson = require('../package.json');
 const apiSpecPath = path.join('test', 'resources', 'response.validation.yaml');
 
 describe(packageJson.name, () => {

test/response.validation.spec.ts

@@ -1,10 +1,9 @@
 import * as path from 'path';
-import * as express from 'express';
 import { expect } from 'chai';
 import * as request from 'supertest';
 import { createApp } from './common/app';
+import * as packageJson from '../package.json';
 
-const packageJson = require('../package.json');
 const apiSpecPath = path.join('test', 'resources', 'response.validation.yaml');
 const today = new Date();
 
@@ -31,8 +30,14 @@ describe(packageJson.name, () => {
           } else if (req.query.mode == 'check_null') {
             json = [
               { id: 1, name: 'name', tag: 'tag', bought_at: null },
-              { id: 2, name: 'name', tag: 'tag', bought_at: today.toISOString() },
-              { id: 3, name: 'name', tag: 'tag'}];
+              {
+                id: 2,
+                name: 'name',
+                tag: 'tag',
+                bought_at: today.toISOString(),
+              },
+              { id: 3, name: 'name', tag: 'tag' },
+            ];
           }
           return res.json(json);
         });
@@ -113,12 +118,9 @@ describe(packageJson.name, () => {
         expect(r.body)
           .is.an('array')
           .with.length(3);
-        expect(r.body[0].bought_at)
-          .equal(null);
-        expect(r.body[1].bought_at)
-          .equal(today.toISOString());
-        expect(r.body[2].bought_at)
-          .to.be.undefined;
+        expect(r.body[0].bought_at).equal(null);
+        expect(r.body[1].bought_at).equal(today.toISOString());
+        expect(r.body[2].bought_at).to.be.undefined;
       }));
 
   it('should pass if response is a list', async () =>

test/response.validator.spec.ts

@@ -3,8 +3,8 @@ import * as fs from 'fs';
 import * as jsyaml from 'js-yaml';
 import { expect } from 'chai';
 import { ResponseValidator } from '../src/middlewares/openapi.response.validator';
+import * as packageJson from '../package.json';
 
-const packageJson = require('../package.json');
 const apiSpecPath = path.join('test', 'resources', 'response.validation.yaml');
 const apiSpec = jsyaml.safeLoad(fs.readFileSync(apiSpecPath, 'utf8'));