Merge pull request #2 from Rhosys/fix-string-literal-issues

Fix string literal issues

Author: wparad

.eslintrc

@@ -4,7 +4,10 @@
       "node": true
     },
     "extends": [
-      "cimpress-atsquad"
+      "cimpress-atsquad",
+      "eslint:recommended",
+      "plugin:@typescript-eslint/eslint-recommended",
+      "plugin:@typescript-eslint/recommended"
     ],
     "plugins": [
       "@typescript-eslint",
@@ -26,9 +29,19 @@
       "no-continue": "off",
       "require-atomic-updates": "off",
       "no-constant-condition": ["error", { "checkLoops": false }],
+      "node/no-missing-import": ["error", {
+        "allowModules": [],
+        "resolvePaths": [],
+        "tryExtensions": [".js", ".ts", ".json", ".node"]
+      }],
       "node/no-missing-require": ["error", {
-        "allowModules": ["jose"]
-      }]
+        "allowModules": [],
+        "resolvePaths": [],
+        "tryExtensions": [".js", ".ts", ".json", ".node"]
+      }],
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/no-var-requires": "off",
+      "@typescript-eslint/no-empty-function": "off"
     }
   }
 

.vscode/settings.json

@@ -2,6 +2,7 @@
     "cSpell.words": [
         "apidevtools",
         "expressjs",
+        "middlewares",
         "unopinionated"
     ]
 }

package.json

@@ -47,14 +47,14 @@
     "@types/ajv": "^1.0.0",
     "@types/mocha": "^8.2.2",
     "@types/node": "^15.3.1",
-    "@typescript-eslint/eslint-plugin": "^5.0.0",
-    "@typescript-eslint/parser": "^5.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.3.0",
+    "@typescript-eslint/parser": "^5.3.0",
     "chai": "^4.3.4",
     "ci-build-tools": "^1.0.13",
     "commander": "^7.2.0",
     "coveralls": "^3.1.0",
     "error-object-polyfill": "^1.1.14",
-    "eslint": "^7.20.0",
+    "eslint": "^8.1.0",
     "eslint-config-cimpress-atsquad": "^1.0.67",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-mocha": "^8.0.0",

src/framework/ajv.ts

@@ -16,7 +16,7 @@ export function createRequestAjv(
     logger: {
       log(...args) { console.log(...args); },
       warn(...args) {
-        if (!arguments[0]?.match('jsPropertySyntax')) {
+        if (!(args[0] as string)?.match('jsPropertySyntax')) {
           console.warn(...args);
         }
       },

src/framework/types.ts

@@ -1,7 +1,10 @@
-/* eslint-disable no-unused-vars */
 /* eslint-disable no-use-before-define */
-import { ErrorObject, Options as AjvOptions } from 'ajv';
+import { Options as AjvOptions } from 'ajv';
 
+/********
+ Typescript string literals are broken and require this garbage to work: https://stackoverflow.com/questions/37978528/typescript-type-string-is-not-assignable-to-type so we'll break the allowed validation using typescript interfaces, we don't really care to use this for validation of the schema, so any place we use string literals we'll allow any "STRING" until it is fixed.
+  => When fixed search here for places with `'literal' | string` and remove the string part.
+*/
 export type BodySchema =
   | OpenAPIV3.ReferenceObject
   | OpenAPIV3.SchemaObject
@@ -80,6 +83,7 @@ export interface OpenApiValidatorOpts {
   formats?: Format[];
 }
 
+// eslint-disable-next-line @typescript-eslint/no-namespace
 export namespace OpenAPIV3 {
   export interface Document {
     openapi: string;
@@ -169,7 +173,7 @@ export namespace OpenAPIV3 {
     in: string;
   }
 
-  export interface HeaderObject extends ParameterBaseObject {}
+  export type HeaderObject = ParameterBaseObject
 
   interface ParameterBaseObject {
     description?: string;
@@ -184,23 +188,34 @@ export namespace OpenAPIV3 {
     examples?: { [media: string]: ReferenceObject | ExampleObject };
     content?: { [media: string]: MediaTypeObject };
   }
-  export type NonArraySchemaObjectType =
-    | 'null'
-    | 'boolean'
-    | 'object'
-    | 'number'
-    | 'string'
-    | 'integer';
-  export type ArraySchemaObjectType = 'array';
-  export type SchemaObject = ArraySchemaObject | NonArraySchemaObject;
 
+  export type SchemaObject = ArraySchemaObject | NonArraySchemaObject | AllOfSchemaObject | OneOfSchemaObject | anyOfSchemaObject | notSchemaObject;
+
+  export interface AllOfSchemaObject extends BaseSchemaObject {
+    allOf: Array<ReferenceObject | SchemaObject>;
+  }
+
+  export interface OneOfSchemaObject extends BaseSchemaObject {
+    oneOf: Array<ReferenceObject | SchemaObject>;
+  }
+
+  export interface anyOfSchemaObject extends BaseSchemaObject {
+    anyOf: Array<ReferenceObject | SchemaObject>;
+  }
+
+  export interface notSchemaObject extends BaseSchemaObject {
+    not: Array<ReferenceObject | SchemaObject>;
+  }
+
+  export type ArraySchemaObjectType = 'array';
   export interface ArraySchemaObject extends BaseSchemaObject {
-    type: ArraySchemaObjectType;
+    type: ArraySchemaObjectType | string;
     items: ReferenceObject | SchemaObject;
   }
 
+  export type NonArraySchemaObjectType = 'null' | 'boolean' | 'object' | 'number' | 'string' | 'integer';
   export interface NonArraySchemaObject extends BaseSchemaObject {
-    type: NonArraySchemaObjectType;
+    type: NonArraySchemaObjectType | string;
   }
 
   interface BaseSchemaObject {
@@ -228,10 +243,6 @@ export namespace OpenAPIV3 {
     properties?: {
       [name: string]: ReferenceObject | SchemaObject;
     };
-    allOf?: Array<ReferenceObject | SchemaObject>;
-    oneOf?: Array<ReferenceObject | SchemaObject>;
-    anyOf?: Array<ReferenceObject | SchemaObject>;
-    not?: ReferenceObject | SchemaObject;
 
     // OpenAPI-specific properties
     nullable?: boolean;
@@ -339,21 +350,22 @@ export namespace OpenAPIV3 {
     | OpenIdSecurityScheme;
 
   export interface HttpSecurityScheme {
-    type: 'http';
+    type: 'http' | string;
     description?: string;
     scheme: string;
     bearerFormat?: string;
   }
 
   export interface ApiKeySecurityScheme {
-    type: 'apiKey';
+    type: 'apiKey' | string;
     description?: string;
     name: string;
     in: string;
   }
 
   export interface OAuth2SecurityScheme {
-    type: 'oauth2';
+    type: 'oauth2' | string;
+    description?: string;
     flows: {
       implicit?: {
         authorizationUrl: string;
@@ -380,7 +392,7 @@ export namespace OpenAPIV3 {
   }
 
   export interface OpenIdSecurityScheme {
-    type: 'openIdConnect';
+    type: 'openIdConnect' | string;
     description?: string;
     openIdConnectUrl: string;
   }
@@ -481,9 +493,9 @@ interface ErrorHeaders {
 }
 
 export class BadRequest extends Error implements ValidationError {
-  status: number = 400;
+  status = 400;
   path?: string;
-  name: string = 'Bad Request';
+  name = 'Bad Request';
   message!: string;
   headers?: ErrorHeaders;
   errors!: ValidationErrorItem[];

src/index.ts

@@ -1,12 +1,11 @@
 import { RequestValidator } from './middlewares/openapi.request.validator';
 import {
   OpenApiValidatorOpts,
-  OpenApiRequest
+  OpenApiRequest,
+  OpenAPIV3
 } from './framework/types';
 import { defaultSerDes } from './framework/base.serdes';
 import { AjvOptions } from './framework/ajvOptions';
-import { OpenAPIV3 } from './framework/types';
-
 export { OpenApiValidatorOpts } from './framework/types';
 
 export class OpenApiValidator {
@@ -31,7 +30,7 @@ export class OpenApiValidator {
     this.ajvOpts = new AjvOptions(options);
   }
 
-  createValidator(): Function {
+  createValidator(): (request: OpenApiRequest) => Promise<void> {
     const specAsync = this.loadSpec(this.options.apiSpec);
 
     let requestValidator;
@@ -86,7 +85,7 @@ export class OpenApiValidator {
     return Object.assign(handler.schema);
   }
 
-  public async loadValidator(): Promise<Function> {
+  public async loadValidator(): Promise<(request: OpenApiRequest) => Promise<void>> {
     const requestValidator = new RequestValidator(null, this.ajvOpts.request);
     await requestValidator.loadCompiled(this.options.compiledFilePath);
     return async (request: OpenApiRequest): Promise<void> => {
@@ -105,7 +104,7 @@ export class OpenApiValidator {
       options.serDes = defaultSerDes;
     } else {
       defaultSerDes.forEach(currentDefaultSerDes => {
-        let defaultSerDesOverride = options.serDes.find(
+        const defaultSerDesOverride = options.serDes.find(
           currentOptionSerDes => {
             return currentDefaultSerDes.format === currentOptionSerDes.format;
           }

src/middlewares/openapi.request.validator.ts

@@ -191,7 +191,7 @@ export class RequestValidator {
   ): OpenApiRequestHandler {
     const reqSchema = this.apiDoc && this.apiDoc.paths[path] && this.apiDoc.paths[path][method.toLowerCase()];
     if (!reqSchema) {
-      return (): void => {};
+      return (() => {});
     }
 
     if (!this.ajv) {

src/middlewares/parsers/body.parse.ts

@@ -6,8 +6,6 @@ import {
 } from '../../framework/types';
 
 export class BodySchemaParser {
-  constructor() {
-  }
   public parse(
     path: string,
     pathSchema: OpenAPIV3.OperationObject,

src/middlewares/parsers/schema.preprocessor.ts

@@ -33,6 +33,7 @@ class Root<T> extends Node<T, T> {
 }
 
 type SchemaObject = OpenAPIV3.SchemaObject;
+type NonArraySchemaObject = OpenAPIV3.NonArraySchemaObject;
 type SchemaObjectNode = Node<SchemaObject, SchemaObject>;
 
 interface TopLevelPathNodes {
@@ -217,15 +218,15 @@ export class SchemaPreprocessor {
 
       if (nschema) {
         // This null check should no longer be necessary
-        this.handleSerDes(pschema, nschema);
+        this.handleSerDes(pschema, nschema as NonArraySchemaObject);
         this.handleReadonly(pschema, nschema, options);
       }
     }
   }
 
   private handleSerDes(
     parent: SchemaObject,
-    schema: SchemaObject
+    schema: NonArraySchemaObject
   ) {
     if (
       schema.type === 'string'