@ehuelsmann/openapi-validator 0.15.0 → 0.16.0

package/README.md

@@ -1,6 +1,12 @@
 # OpenAPI Validator
 
+> **Notice:** Support for responses from [`request`](https://github.com/request/request#deprecated) and [`request-promise`](https://github.com/request/request-promise#deprecated) has been removed because both upstream projects are deprecated.
+
 [![downloads](https://img.shields.io/npm/dm/@ehuelsmann%2Fopenapi-validator)](https://www.npmjs.com/package/@ehuelsmann/openapi-validator)
 [![npm](https://img.shields.io/npm/v/@ehuelsmann%2Fopenapi-validator.svg)](https://www.npmjs.com/package/@ehuelsmann/openapi-validator)
 
+**Note** This project is a fork from the [openapi-library](https://github.com/openapi-library) project because that project is not maintained at the moment. This project contains updates and security fixes, but ideally will be merged back into that project, as soon as it's maintained again.
+
+
+
 Common code for [@ehuelsmann/jest-openapi](https://www.npmjs.com/package/@ehuelsmann/jest-openapi) and [Chai OpenAPI Response Validator](https://www.npmjs.com/package/@ehuelsmann/chai-openapi-response-validator)

package/dist/index.d.mts

@@ -0,0 +1,149 @@
+import { OpenAPIV2, OpenAPIV3, OpenAPIV3_1, OpenAPI } from 'openapi-types';
+import { AxiosResponse as AxiosResponse$1 } from 'axios';
+import { Response, SuperAgentRequest } from 'superagent';
+
+type RawAxiosResponse = AxiosResponse$1;
+declare class AxiosResponse extends AbstractResponse {
+    protected res: RawAxiosResponse;
+    constructor(res: RawAxiosResponse);
+    getBodyForValidation(): AxiosResponse['body'];
+}
+
+type RawSuperAgentResponse = Response & {
+    req: SuperAgentRequest & {
+        path: string;
+    };
+};
+declare class SuperAgentResponse extends AbstractResponse {
+    protected res: RawSuperAgentResponse;
+    private isResTextPopulatedInsteadOfResBody;
+    constructor(res: RawSuperAgentResponse);
+    getBodyForValidation(): SuperAgentResponse['body'];
+    summary(): ReturnType<AbstractResponse['summary']> & {
+        text?: string;
+    };
+}
+
+type RawResponse = RawAxiosResponse | RawSuperAgentResponse;
+declare abstract class AbstractResponse {
+    protected res: RawResponse;
+    status: number;
+    req: {
+        method: string;
+        path: string;
+    };
+    abstract getBodyForValidation(): unknown;
+    protected body: unknown;
+    protected bodyHasNoContent: boolean;
+    constructor(res: RawResponse);
+    summary(): {
+        body: unknown;
+    };
+    toString(): string;
+}
+type ActualResponse = AbstractResponse;
+type ActualRequest = AbstractResponse['req'];
+
+declare enum ErrorCode {
+    ServerNotFound = 0,
+    BasePathNotFound = 1,
+    PathNotFound = 2,
+    MethodNotFound = 3,
+    StatusNotFound = 4,
+    InvalidBody = 5,
+    InvalidObject = 6
+}
+declare class ValidationError extends Error {
+    code: ErrorCode;
+    constructor(code: ErrorCode, message?: string);
+    toString(): string;
+}
+
+type Document = OpenAPIV2.Document | OpenAPIV3.Document;
+type Operation = OpenAPIV2.OperationObject | OpenAPIV3.OperationObject;
+type PathItemObject = OpenAPIV2.PathItemObject | OpenAPIV3.PathItemObject;
+type ResponseObjectWithSchema = (OpenAPIV2.ResponseObject & {
+    schema: OpenAPIV2.Schema;
+}) | (OpenAPIV3.ResponseObject & {
+    content: {
+        [media: string]: OpenAPIV3.MediaTypeObject & {
+            schema: OpenAPIV3.SchemaObject;
+        };
+    };
+}) | (OpenAPIV3_1.ResponseObject & {
+    content: {
+        [media: string]: OpenAPIV3_1.MediaTypeObject & {
+            schema: OpenAPIV3_1.SchemaObject;
+        };
+    };
+});
+type Schema = OpenAPIV2.Schema | OpenAPIV3.SchemaObject;
+declare abstract class OpenApiSpec$1 {
+    protected spec: Document;
+    protected abstract getSchemaObjects(): Record<string, Schema> | undefined;
+    protected abstract findResponseDefinition(referenceString: string): ResponseObjectWithSchema | undefined;
+    protected abstract findOpenApiPathMatchingPathname(pathname: string): string;
+    protected abstract getComponentDefinitionsProperty(): {
+        definitions: OpenAPIV2.Document['definitions'];
+    } | {
+        components: OpenAPIV3.Document['components'];
+    };
+    constructor(spec: Document);
+    pathsObject(): Document['paths'];
+    getPathItem(openApiPath: string): PathItemObject;
+    paths(): string[];
+    getSchemaObject(schemaName: string): Schema | undefined;
+    getExpectedResponse(responseOperation: Operation, status: ActualResponse['status']): ResponseObjectWithSchema | undefined;
+    findExpectedResponse(actualResponse: ActualResponse): Record<string, ResponseObjectWithSchema>;
+    findOpenApiPathMatchingRequest(actualRequest: ActualRequest): string;
+    findExpectedPathItem(actualRequest: ActualRequest): PathItemObject;
+    findExpectedResponseOperation(actualRequest: ActualRequest): Operation | undefined;
+    validateResponse(actualResponse: ActualResponse): ValidationError | null;
+    validateObject(actualObject: unknown, schema: Schema): ValidationError | null;
+}
+
+declare class OpenApi2Spec extends OpenApiSpec$1 {
+    spec: OpenAPIV2.Document;
+    didUserDefineBasePath: boolean;
+    constructor(spec: OpenAPIV2.Document);
+    /**
+     * "If the basePath property is not provided, the API is served directly under the host
+     * @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#fixed-fields
+     */
+    findOpenApiPathMatchingPathname(pathname: string): string;
+    findResponseDefinition(referenceString: string): ResponseObjectWithSchema | undefined;
+    getComponentDefinitionsProperty(): {
+        definitions: OpenAPIV2.Document['definitions'];
+    };
+    getSchemaObjects(): OpenAPIV2.Document['definitions'];
+}
+
+declare class OpenApi3Spec extends OpenApiSpec$1 {
+    protected spec: OpenAPIV3.Document;
+    didUserDefineServers: boolean;
+    constructor(spec: OpenAPIV3.Document);
+    /**
+     * "If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of '/'"
+     * @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#fixed-fields
+     */
+    ensureDefaultServer(): void;
+    servers(): OpenAPIV3.ServerObject[];
+    getServerUrls(): string[];
+    getMatchingServerUrls(pathname: string): string[];
+    getMatchingServerBasePaths(pathname: string): string[];
+    findOpenApiPathMatchingPathname(pathname: string): string;
+    findResponseDefinition(referenceString: string): ResponseObjectWithSchema | undefined;
+    getComponentDefinitionsProperty(): {
+        components: OpenAPIV3.Document['components'];
+    };
+    getSchemaObjects(): OpenAPIV3.ComponentsObject['schemas'];
+}
+
+declare function makeApiSpec(filepathOrObject: string | OpenAPI.Document): OpenApi2Spec | OpenApi3Spec;
+
+declare function makeResponse(res: RawResponse): AxiosResponse | SuperAgentResponse;
+
+type OpenApiSpec = OpenApi2Spec | OpenApi3Spec;
+type OpenAPISpecObject = OpenAPI.Document;
+
+export { type ActualRequest, type ActualResponse, ErrorCode, type OpenAPISpecObject, OpenApi2Spec, OpenApi3Spec, type OpenApiSpec, type RawResponse, type Schema, ValidationError, makeApiSpec, makeResponse };

package/dist/index.d.ts

@@ -1,14 +1,149 @@
-import type { OpenAPI } from 'openapi-types';
-import type OpenApi2Spec from './classes/OpenApi2Spec';
-import type OpenApi3Spec from './classes/OpenApi3Spec';
-export type { Schema } from './classes/AbstractOpenApiSpec';
-export type { ActualRequest, ActualResponse, RawResponse, } from './classes/AbstractResponse';
-export type { default as ValidationError } from './classes/errors/ValidationError';
-export { ErrorCode } from './classes/errors/ValidationError';
-export type { default as OpenApi2Spec } from './classes/OpenApi2Spec';
-export type { default as OpenApi3Spec } from './classes/OpenApi3Spec';
-export { default as makeApiSpec } from './openApiSpecFactory';
-export { default as makeResponse } from './responseFactory';
-export type OpenApiSpec = OpenApi2Spec | OpenApi3Spec;
-export type OpenAPISpecObject = OpenAPI.Document;
-//# sourceMappingURL=index.d.ts.map
+import { OpenAPIV2, OpenAPIV3, OpenAPIV3_1, OpenAPI } from 'openapi-types';
+import { AxiosResponse as AxiosResponse$1 } from 'axios';
+import { Response, SuperAgentRequest } from 'superagent';
+
+type RawAxiosResponse = AxiosResponse$1;
+declare class AxiosResponse extends AbstractResponse {
+    protected res: RawAxiosResponse;
+    constructor(res: RawAxiosResponse);
+    getBodyForValidation(): AxiosResponse['body'];
+}
+
+type RawSuperAgentResponse = Response & {
+    req: SuperAgentRequest & {
+        path: string;
+    };
+};
+declare class SuperAgentResponse extends AbstractResponse {
+    protected res: RawSuperAgentResponse;
+    private isResTextPopulatedInsteadOfResBody;
+    constructor(res: RawSuperAgentResponse);
+    getBodyForValidation(): SuperAgentResponse['body'];
+    summary(): ReturnType<AbstractResponse['summary']> & {
+        text?: string;
+    };
+}
+
+type RawResponse = RawAxiosResponse | RawSuperAgentResponse;
+declare abstract class AbstractResponse {
+    protected res: RawResponse;
+    status: number;
+    req: {
+        method: string;
+        path: string;
+    };
+    abstract getBodyForValidation(): unknown;
+    protected body: unknown;
+    protected bodyHasNoContent: boolean;
+    constructor(res: RawResponse);
+    summary(): {
+        body: unknown;
+    };
+    toString(): string;
+}
+type ActualResponse = AbstractResponse;
+type ActualRequest = AbstractResponse['req'];
+
+declare enum ErrorCode {
+    ServerNotFound = 0,
+    BasePathNotFound = 1,
+    PathNotFound = 2,
+    MethodNotFound = 3,
+    StatusNotFound = 4,
+    InvalidBody = 5,
+    InvalidObject = 6
+}
+declare class ValidationError extends Error {
+    code: ErrorCode;
+    constructor(code: ErrorCode, message?: string);
+    toString(): string;
+}
+
+type Document = OpenAPIV2.Document | OpenAPIV3.Document;
+type Operation = OpenAPIV2.OperationObject | OpenAPIV3.OperationObject;
+type PathItemObject = OpenAPIV2.PathItemObject | OpenAPIV3.PathItemObject;
+type ResponseObjectWithSchema = (OpenAPIV2.ResponseObject & {
+    schema: OpenAPIV2.Schema;
+}) | (OpenAPIV3.ResponseObject & {
+    content: {
+        [media: string]: OpenAPIV3.MediaTypeObject & {
+            schema: OpenAPIV3.SchemaObject;
+        };
+    };
+}) | (OpenAPIV3_1.ResponseObject & {
+    content: {
+        [media: string]: OpenAPIV3_1.MediaTypeObject & {
+            schema: OpenAPIV3_1.SchemaObject;
+        };
+    };
+});
+type Schema = OpenAPIV2.Schema | OpenAPIV3.SchemaObject;
+declare abstract class OpenApiSpec$1 {
+    protected spec: Document;
+    protected abstract getSchemaObjects(): Record<string, Schema> | undefined;
+    protected abstract findResponseDefinition(referenceString: string): ResponseObjectWithSchema | undefined;
+    protected abstract findOpenApiPathMatchingPathname(pathname: string): string;
+    protected abstract getComponentDefinitionsProperty(): {
+        definitions: OpenAPIV2.Document['definitions'];
+    } | {
+        components: OpenAPIV3.Document['components'];
+    };
+    constructor(spec: Document);
+    pathsObject(): Document['paths'];
+    getPathItem(openApiPath: string): PathItemObject;
+    paths(): string[];
+    getSchemaObject(schemaName: string): Schema | undefined;
+    getExpectedResponse(responseOperation: Operation, status: ActualResponse['status']): ResponseObjectWithSchema | undefined;
+    findExpectedResponse(actualResponse: ActualResponse): Record<string, ResponseObjectWithSchema>;
+    findOpenApiPathMatchingRequest(actualRequest: ActualRequest): string;
+    findExpectedPathItem(actualRequest: ActualRequest): PathItemObject;
+    findExpectedResponseOperation(actualRequest: ActualRequest): Operation | undefined;
+    validateResponse(actualResponse: ActualResponse): ValidationError | null;
+    validateObject(actualObject: unknown, schema: Schema): ValidationError | null;
+}
+
+declare class OpenApi2Spec extends OpenApiSpec$1 {
+    spec: OpenAPIV2.Document;
+    didUserDefineBasePath: boolean;
+    constructor(spec: OpenAPIV2.Document);
+    /**
+     * "If the basePath property is not provided, the API is served directly under the host
+     * @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#fixed-fields
+     */
+    findOpenApiPathMatchingPathname(pathname: string): string;
+    findResponseDefinition(referenceString: string): ResponseObjectWithSchema | undefined;
+    getComponentDefinitionsProperty(): {
+        definitions: OpenAPIV2.Document['definitions'];
+    };
+    getSchemaObjects(): OpenAPIV2.Document['definitions'];
+}
+
+declare class OpenApi3Spec extends OpenApiSpec$1 {
+    protected spec: OpenAPIV3.Document;
+    didUserDefineServers: boolean;
+    constructor(spec: OpenAPIV3.Document);
+    /**
+     * "If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of '/'"
+     * @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#fixed-fields
+     */
+    ensureDefaultServer(): void;
+    servers(): OpenAPIV3.ServerObject[];
+    getServerUrls(): string[];
+    getMatchingServerUrls(pathname: string): string[];
+    getMatchingServerBasePaths(pathname: string): string[];
+    findOpenApiPathMatchingPathname(pathname: string): string;
+    findResponseDefinition(referenceString: string): ResponseObjectWithSchema | undefined;
+    getComponentDefinitionsProperty(): {
+        components: OpenAPIV3.Document['components'];
+    };
+    getSchemaObjects(): OpenAPIV3.ComponentsObject['schemas'];
+}
+
+declare function makeApiSpec(filepathOrObject: string | OpenAPI.Document): OpenApi2Spec | OpenApi3Spec;
+
+declare function makeResponse(res: RawResponse): AxiosResponse | SuperAgentResponse;
+
+type OpenApiSpec = OpenApi2Spec | OpenApi3Spec;
+type OpenAPISpecObject = OpenAPI.Document;
+
+export { type ActualRequest, type ActualResponse, ErrorCode, type OpenAPISpecObject, OpenApi2Spec, OpenApi3Spec, type OpenApiSpec, type RawResponse, type Schema, ValidationError, makeApiSpec, makeResponse };