refactor(reference): base all errors on apidom-error package (#3220)

Refs #3039

packages/apidom-core/src/media-types.ts

@@ -5,17 +5,19 @@ class MediaTypes<T> extends Array<T> {
 
   // eslint-disable-next-line class-methods-use-this
   filterByFormat() {
-    throw new NotImplementedError('"filterByFormat" method is not implemented.');
+    throw new NotImplementedError(
+      'filterByFormat method in MediaTypes class is not yet implemented.',
+    );
   }
 
   // eslint-disable-next-line class-methods-use-this
   findBy() {
-    throw new NotImplementedError('"findBy" method is not implemented.');
+    throw new NotImplementedError('findBy method in MediaTypes class is not yet implemented.');
   }
 
   // eslint-disable-next-line class-methods-use-this
   latest() {
-    throw new NotImplementedError('"latest" method is not implemented.');
+    throw new NotImplementedError('latest method in MediaTypes class is not yet implemented.');
   }
 }
 

packages/apidom-ns-api-design-systems/src/validator/openapi-3-1/validator.ts

@@ -33,9 +33,7 @@ const makeMessage = (
     return `"${primitiveValue}" not allowed for subject ${primitiveStandardIdentifier}`;
   }
 
-  throw new NotImplementedError(
-    '[Requirement levels] other than "may" are currently not implemented.',
-  );
+  throw new NotImplementedError('[Requirement levels] other than "may" are not yet implemented.');
 };
 
 // @ts-ignore

packages/apidom-reference/package.json

@@ -146,14 +146,14 @@
       "types": "./types/dereference/strategies/openapi-3-1/index.d.ts"
     },
     "./dereference/strategies/openapi-3-1/selectors/$anchor": {
-      "import": "./es/dereference/strategies/openapi-3-1/selectors/$anchor/index.mjs",
-      "require": "./cjs/dereference/strategies/openapi-3-1/selectors/$anchor/index.cjs",
-      "types": "./types/dereference/strategies/openapi-3-1/selectors/$anchor/index.d.ts"
+      "import": "./es/dereference/strategies/openapi-3-1/selectors/$anchor.mjs",
+      "require": "./cjs/dereference/strategies/openapi-3-1/selectors/$anchor.cjs",
+      "types": "./types/dereference/strategies/openapi-3-1/selectors/$anchor.d.ts"
     },
     "./dereference/strategies/openapi-3-1/selectors/uri": {
-      "import": "./es/dereference/strategies/openapi-3-1/selectors/uri/index.mjs",
-      "require": "./cjs/dereference/strategies/openapi-3-1/selectors/uri/index.cjs",
-      "types": "./types/dereference/strategies/openapi-3-1/selectors/uri/index.d.ts"
+      "import": "./es/dereference/strategies/openapi-3-1/selectors/uri.mjs",
+      "require": "./cjs/dereference/strategies/openapi-3-1/selectors/uri.cjs",
+      "types": "./types/dereference/strategies/openapi-3-1/selectors/uri.d.ts"
     }
   },
   "imports": {

packages/apidom-reference/src/dereference/index.ts

@@ -8,8 +8,8 @@ import {
 
 import File from '../util/File';
 import * as plugins from '../util/plugins';
-import { UnmatchedDereferenceStrategyError } from '../util/errors';
-import DereferenceError from '../util/errors/DereferenceError';
+import UnmatchedDereferenceStrategyError from '../errors/UnmatchedDereferenceStrategyError';
+import DereferenceError from '../errors/DereferenceError';
 import { ReferenceOptions as IReferenceOptions } from '../types';
 import parse from '../parse';
 import { merge as mergeOptions } from '../options/util';

packages/apidom-reference/src/dereference/strategies/DereferenceStrategy.ts

@@ -1,7 +1,7 @@
 import stampit from 'stampit';
+import { NotImplementedError } from '@swagger-api/apidom-error';
 
 import { DereferenceStrategy as IDereferenceStrategy } from '../../types';
-import { NotImplementedError } from '../../util/errors';
 
 const DereferenceStrategy: stampit.Stamp<IDereferenceStrategy> = stampit({
   props: {
@@ -13,7 +13,9 @@ const DereferenceStrategy: stampit.Stamp<IDereferenceStrategy> = stampit({
     },
 
     async dereference(): Promise<never> {
-      throw new NotImplementedError();
+      throw new NotImplementedError(
+        'dereference method in DereferenceStrategy stamp is not yet implemented.',
+      );
     },
   },
 });

packages/apidom-reference/src/dereference/strategies/asyncapi-2/visitor.ts

@@ -11,6 +11,7 @@ import {
   visit,
   toValue,
 } from '@swagger-api/apidom-core';
+import { ApiDOMError } from '@swagger-api/apidom-error';
 import { evaluate, uriToPointer } from '@swagger-api/apidom-json-pointer';
 import {
   ChannelItemElement,
@@ -23,7 +24,8 @@ import {
 } from '@swagger-api/apidom-ns-asyncapi-2';
 
 import { Reference as IReference } from '../../../types';
-import { MaximumDereferenceDepthError, MaximumResolverDepthError } from '../../../util/errors';
+import MaximumDereferenceDepthError from '../../../errors/MaximumDereferenceDepthError';
+import MaximumResolverDepthError from '../../../errors/MaximumResolverDepthError';
 import { AncestorLineage } from '../../util';
 import * as url from '../../../util/url';
 import parse from '../../../parse';
@@ -141,7 +143,7 @@ const AsyncApi2DereferenceVisitor = stampit({
 
       // detect direct or circular reference
       if (this.indirections.includes(referencedElement)) {
-        throw new Error('Recursive Reference Object detected');
+        throw new ApiDOMError('Recursive Reference Object detected');
       }
 
       // detect maximum depth of dereferencing
@@ -242,7 +244,7 @@ const AsyncApi2DereferenceVisitor = stampit({
 
       // detect direct or indirect reference
       if (this.indirections.includes(referencedElement)) {
-        throw new Error('Recursive Channel Item Object reference detected');
+        throw new ApiDOMError('Recursive Channel Item Object reference detected');
       }
 
       // detect maximum depth of dereferencing

packages/apidom-reference/src/dereference/strategies/openapi-3-0/visitor.ts

@@ -13,6 +13,7 @@ import {
   toValue,
   isMemberElement,
 } from '@swagger-api/apidom-core';
+import { ApiDOMError } from '@swagger-api/apidom-error';
 import { evaluate, uriToPointer } from '@swagger-api/apidom-json-pointer';
 import {
   getNodeType,
@@ -30,7 +31,8 @@ import {
 } from '@swagger-api/apidom-ns-openapi-3-0';
 
 import { Reference as IReference } from '../../../types';
-import { MaximumDereferenceDepthError, MaximumResolverDepthError } from '../../../util/errors';
+import MaximumDereferenceDepthError from '../../../errors/MaximumDereferenceDepthError';
+import MaximumResolverDepthError from '../../../errors/MaximumResolverDepthError';
 import { AncestorLineage } from '../../util';
 import * as url from '../../../util/url';
 import parse from '../../../parse';
@@ -149,7 +151,7 @@ const OpenApi3_0DereferenceVisitor = stampit({
 
       // detect direct or circular reference
       if (this.indirections.includes(referencedElement)) {
-        throw new Error('Recursive Reference Object detected');
+        throw new ApiDOMError('Recursive Reference Object detected');
       }
 
       // detect maximum depth of dereferencing
@@ -251,7 +253,7 @@ const OpenApi3_0DereferenceVisitor = stampit({
 
       // detect direct or indirect reference
       if (this.indirections.includes(referencedElement)) {
-        throw new Error('Recursive Path Item Object reference detected');
+        throw new ApiDOMError('Recursive Path Item Object reference detected');
       }
 
       // detect maximum depth of dereferencing
@@ -336,7 +338,9 @@ const OpenApi3_0DereferenceVisitor = stampit({
 
       // operationRef and operationId fields are mutually exclusive
       if (isStringElement(linkElement.operationRef) && isStringElement(linkElement.operationId)) {
-        throw new Error('LinkElement operationRef and operationId fields are mutually exclusive.');
+        throw new ApiDOMError(
+          'LinkElement operationRef and operationId fields are mutually exclusive.',
+        );
       }
 
       let operationElement: any;
@@ -369,7 +373,7 @@ const OpenApi3_0DereferenceVisitor = stampit({
         );
         // OperationElement not found by its operationId
         if (isUndefined(operationElement)) {
-          throw new Error(`OperationElement(operationId=${operationId}) not found.`);
+          throw new ApiDOMError(`OperationElement(operationId=${operationId}) not found.`);
         }
 
         const linkElementCopy = cloneShallow(linkElement);
@@ -406,7 +410,9 @@ const OpenApi3_0DereferenceVisitor = stampit({
 
       // value and externalValue fields are mutually exclusive
       if (exampleElement.hasKey('value') && isStringElement(exampleElement.externalValue)) {
-        throw new Error('ExampleElement value and externalValue fields are mutually exclusive.');
+        throw new ApiDOMError(
+          'ExampleElement value and externalValue fields are mutually exclusive.',
+        );
       }
 
       const reference = await this.toReference(toValue(exampleElement.externalValue));

packages/apidom-reference/src/dereference/strategies/openapi-3-1/selectors/$anchor/index.ts → packages/apidom-reference/src/dereference/strategies/openapi-3-1/selectors/$anchor.ts

@@ -2,8 +2,9 @@ import { trimCharsStart, isUndefined } from 'ramda-adjunct';
 import { Element, find, toValue } from '@swagger-api/apidom-core';
 import { isSchemaElement } from '@swagger-api/apidom-ns-openapi-3-1';
 
-import { getHash } from '../../../../../util/url';
-import { EvaluationJsonSchema$anchorError, InvalidJsonSchema$anchorError } from './errors';
+import { getHash } from '../../../../util/url';
+import EvaluationJsonSchema$anchorError from '../../../../errors/EvaluationJsonSchema$anchorError';
+import InvalidJsonSchema$anchorError from '../../../../errors/InvalidJsonSchema$anchorError';
 
 // isAnchor :: String -> Boolean
 export const isAnchor = (uri: string) => {
@@ -47,3 +48,4 @@ export const evaluate = <T extends Element>(anchor: string, element: T): Element
 };
 
 export { EvaluationJsonSchema$anchorError, InvalidJsonSchema$anchorError };
+export { default as JsonSchema$anchorError } from '../../../../errors/JsonSchema$anchorError';

packages/apidom-reference/src/dereference/strategies/openapi-3-1/selectors/uri/index.ts → packages/apidom-reference/src/dereference/strategies/openapi-3-1/selectors/uri.ts

@@ -3,10 +3,10 @@ import { Element, filter } from '@swagger-api/apidom-core';
 import { isSchemaElement, SchemaElement } from '@swagger-api/apidom-ns-openapi-3-1';
 import { uriToPointer, evaluate as jsonPointerEvaluate } from '@swagger-api/apidom-json-pointer';
 
-import * as url from '../../../../../util/url';
-import { EvaluationJsonSchemaUriError } from './errors';
-import { isAnchor, uriToAnchor, evaluate as $anchorEvaluate } from '../$anchor';
-import { resolveSchema$idField } from '../../../../../resolve/strategies/openapi-3-1/util';
+import * as url from '../../../../util/url';
+import EvaluationJsonSchemaUriError from '../../../../errors/EvaluationJsonSchemaUriError';
+import { isAnchor, uriToAnchor, evaluate as $anchorEvaluate } from './$anchor';
+import { resolveSchema$idField } from '../../../../resolve/strategies/openapi-3-1/util';
 
 /**
  * Evaluates JSON Schema $ref containing unknown URI against ApiDOM fragment.
@@ -50,3 +50,4 @@ export const evaluate = <T extends Element>(uri: string, element: T): Element |
 evaluate.cache = new WeakMap();
 
 export { EvaluationJsonSchemaUriError };
+export { default as JsonSchemaUriError } from '../../../../errors/JsonSchemaUriError';

packages/apidom-reference/src/dereference/strategies/openapi-3-1/visitor.ts

@@ -14,6 +14,7 @@ import {
   toValue,
   Element,
 } from '@swagger-api/apidom-core';
+import { ApiDOMError } from '@swagger-api/apidom-error';
 import { evaluate as jsonPointerEvaluate, uriToPointer } from '@swagger-api/apidom-json-pointer';
 import {
   getNodeType,
@@ -35,7 +36,8 @@ import {
 import { isAnchor, uriToAnchor, evaluate as $anchorEvaluate } from './selectors/$anchor';
 import { evaluate as uriEvaluate } from './selectors/uri';
 import { Reference as IReference, Resolver as IResolver } from '../../../types';
-import { MaximumDereferenceDepthError, MaximumResolverDepthError } from '../../../util/errors';
+import MaximumDereferenceDepthError from '../../../errors/MaximumDereferenceDepthError';
+import MaximumResolverDepthError from '../../../errors/MaximumResolverDepthError';
 import * as url from '../../../util/url';
 import parse from '../../../parse';
 import Reference from '../../../Reference';
@@ -45,7 +47,7 @@ import {
   maybeRefractToSchemaElement,
 } from '../../../resolve/strategies/openapi-3-1/util';
 import { AncestorLineage } from '../../util';
-import EvaluationJsonSchemaUriError from './selectors/uri/errors/EvaluationJsonSchemaUriError';
+import EvaluationJsonSchemaUriError from '../../../errors/EvaluationJsonSchemaUriError';
 
 // @ts-ignore
 const visitAsync = visit[Symbol.for('nodejs.util.promisify.custom')];
@@ -162,7 +164,7 @@ const OpenApi3_1DereferenceVisitor = stampit({
 
       // detect direct or indirect reference
       if (this.indirections.includes(referencedElement)) {
-        throw new Error('Recursive Reference Object detected');
+        throw new ApiDOMError('Recursive Reference Object detected');
       }
 
       // detect maximum depth of dereferencing
@@ -283,7 +285,7 @@ const OpenApi3_1DereferenceVisitor = stampit({
 
       // detect direct or indirect reference
       if (this.indirections.includes(referencedElement)) {
-        throw new Error('Recursive Path Item Object reference detected');
+        throw new ApiDOMError('Recursive Path Item Object reference detected');
       }
 
       // detect maximum depth of dereferencing
@@ -368,7 +370,9 @@ const OpenApi3_1DereferenceVisitor = stampit({
 
       // operationRef and operationId fields are mutually exclusive
       if (isStringElement(linkElement.operationRef) && isStringElement(linkElement.operationId)) {
-        throw new Error('LinkElement operationRef and operationId fields are mutually exclusive.');
+        throw new ApiDOMError(
+          'LinkElement operationRef and operationId fields are mutually exclusive.',
+        );
       }
 
       let operationElement: any;
@@ -401,7 +405,7 @@ const OpenApi3_1DereferenceVisitor = stampit({
         );
         // OperationElement not found by its operationId
         if (isUndefined(operationElement)) {
-          throw new Error(`OperationElement(operationId=${operationId}) not found.`);
+          throw new ApiDOMError(`OperationElement(operationId=${operationId}) not found.`);
         }
 
         const linkElementCopy = cloneShallow(linkElement);
@@ -438,7 +442,9 @@ const OpenApi3_1DereferenceVisitor = stampit({
 
       // value and externalValue fields are mutually exclusive
       if (exampleElement.hasKey('value') && isStringElement(exampleElement.externalValue)) {
-        throw new Error('ExampleElement value and externalValue fields are mutually exclusive.');
+        throw new ApiDOMError(
+          'ExampleElement value and externalValue fields are mutually exclusive.',
+        );
       }
 
       const reference = await this.toReference(toValue(exampleElement.externalValue));
@@ -545,7 +551,7 @@ const OpenApi3_1DereferenceVisitor = stampit({
 
       // detect direct or indirect reference
       if (this.indirections.includes(referencedElement)) {
-        throw new Error('Recursive Schema Object reference detected');
+        throw new ApiDOMError('Recursive Schema Object reference detected');
       }
 
       // detect maximum depth of dereferencing

packages/apidom-reference/src/errors/EvaluationJsonSchema$anchorError.ts

@@ -0,0 +1,5 @@
+import JsonSchema$anchorError from './JsonSchema$anchorError';
+
+class EvaluationJsonSchema$anchorError extends JsonSchema$anchorError {}
+
+export default EvaluationJsonSchema$anchorError;

packages/apidom-reference/src/errors/EvaluationJsonSchemaUriError.ts

@@ -0,0 +1,5 @@
+import JsonSchemaUriError from './JsonSchemaUriError';
+
+class EvaluationJsonSchemaUriError extends JsonSchemaUriError {}
+
+export default EvaluationJsonSchemaUriError;

packages/apidom-reference/src/errors/InvalidJsonSchema$anchorError.ts

@@ -0,0 +1,9 @@
+import JsonSchema$anchorError from './JsonSchema$anchorError';
+
+class InvalidJsonSchema$anchorError extends JsonSchema$anchorError {
+  constructor(anchor: string) {
+    super(`Invalid JSON Schema $anchor "${anchor}".`);
+  }
+}
+
+export default InvalidJsonSchema$anchorError;

packages/apidom-reference/src/errors/JsonSchema$anchorError.ts

@@ -0,0 +1,5 @@
+import { ApiDOMError } from '@swagger-api/apidom-error';
+
+class JsonSchema$anchorError extends ApiDOMError {}
+
+export default JsonSchema$anchorError;

packages/apidom-reference/src/errors/JsonSchemaUriError.ts

@@ -0,0 +1,5 @@
+import { ApiDOMError } from '@swagger-api/apidom-error';
+
+class JsonSchemaUriError extends ApiDOMError {}
+
+export default JsonSchemaUriError;