rollback renaming for SchemaValidateResult

Author: smoya

src/schema-parser/asyncapi-schema-parser.ts

@@ -1,7 +1,7 @@
 import { SchemaParser, ParseSchemaInput, ValidateSchemaInput } from "../schema-parser";
 import Ajv from "ajv";
 import { JSONSchema7 } from "json-schema"
-import type { AsyncAPISchema, SchemaValidateError } from '../types';
+import type { AsyncAPISchema, SchemaValidateResult } from '../types';
 
 const ajv = new Ajv({
   allErrors: true,
@@ -15,9 +15,9 @@ export function AsyncAPISchemaParser(): SchemaParser {
   }
 }
 
-async function validate(input: ValidateSchemaInput<unknown, unknown>): Promise<SchemaValidateError[]> {
+async function validate(input: ValidateSchemaInput<unknown, unknown>): Promise<SchemaValidateResult[]> {
   const schema = input.data as JSONSchema7;
-  let errors: SchemaValidateError[] = [];
+  let errors: SchemaValidateResult[] = [];
 
   try {
     ajv.compile(schema);
@@ -33,8 +33,8 @@ async function validate(input: ValidateSchemaInput<unknown, unknown>): Promise<S
   return errors;
 }
 
-function ajvToSpectralErrors(error: Error): SchemaValidateError[] {
-  let errors: SchemaValidateError[] = [];
+function ajvToSpectralErrors(error: Error): SchemaValidateResult[] {
+  let errors: SchemaValidateResult[] = [];
   let errorMessage = error.message;
 
   // Validation errors. 
@@ -51,7 +51,7 @@ function ajvToSpectralErrors(error: Error): SchemaValidateError[] {
       const path = message.slice(0, splitIndex);
       const error = message.slice(splitIndex + 1);
 
-      const resultErr: SchemaValidateError = {
+      const resultErr: SchemaValidateResult = {
         message: error,
         path: path.split("/")
       };
@@ -60,7 +60,7 @@ function ajvToSpectralErrors(error: Error): SchemaValidateError[] {
     });
   } else {
     // Not a validation error
-    const resultErr: SchemaValidateError = {
+    const resultErr: SchemaValidateResult = {
       message: error.message,
     };
 

src/schema-parser/index.ts

@@ -1,5 +1,5 @@
 import type { Parser } from '../parser';
-import type { AsyncAPISchema, DetailedAsyncAPI, SchemaValidateError } from '../types';
+import type { AsyncAPISchema, DetailedAsyncAPI, SchemaValidateResult } from '../types';
 
 export interface ValidateSchemaInput<D = unknown, M = unknown> {
   readonly asyncapi: DetailedAsyncAPI;
@@ -20,7 +20,7 @@ export interface ParseSchemaInput<D = unknown, M = unknown> {
 }
 
 export interface SchemaParser<D = unknown, M = unknown> {
-  validate: (input: ValidateSchemaInput<D, M>) => void | SchemaValidateError[] | Promise<void | SchemaValidateError[]>;
+  validate: (input: ValidateSchemaInput<D, M>) => void | SchemaValidateResult[] | Promise<void | SchemaValidateResult[]>;
   parse: (input: ParseSchemaInput<D, M>) => AsyncAPISchema | Promise<AsyncAPISchema>;
   getMimeTypes: () => Array<string>;
 }

src/types.ts

@@ -17,5 +17,5 @@ export interface DetailedAsyncAPI {
 }
 
 export type Diagnostic = ISpectralDiagnostic;
-export type SchemaValidateError = IFunctionResult;
+export type SchemaValidateResult = IFunctionResult;
 export type AsyncAPISchema = JSONSchema7;

test/schema-parser/asyncapi-schema-parser.spec.ts

@@ -1,6 +1,6 @@
 import { ParseSchemaInput, ValidateSchemaInput } from '../../src/schema-parser/index';
 import { AsyncAPISchemaParser } from '../../src/schema-parser/asyncapi-schema-parser';
-import { SchemaValidateError } from '../../src/types';
+import { SchemaValidateResult } from '../../src/types';
 
 describe('AsyncAPISchemaParser', function () {
 
@@ -59,7 +59,7 @@ describe('AsyncAPISchemaParser', function () {
     };
 
     const result = await parser.validate(schema);
-    const expectedResult: SchemaValidateError[] = [
+    const expectedResult: SchemaValidateResult[] = [
       { "message": "must be object,boolean", "path": ["data", "properties", "name", "if"] },
       { "message": "must be array", "path": ["data", "oneOf"] }
     ];
@@ -80,7 +80,7 @@ describe('AsyncAPISchemaParser', function () {
     };
 
     const result = await parser.validate(schema);
-    const expectedResult: SchemaValidateError[] = [
+    const expectedResult: SchemaValidateResult[] = [
       { "message": "no schema with key or ref \"non-existent-meta-schema\"" },
     ];