@speclynx/apidom-reference 3.0.0 → 3.2.0

package/src/dereference/strategies/arazzo-1/visitor.cjs

@@ -16,6 +16,7 @@ var _$anchor = require("./selectors/$anchor.cjs");
 var _uri = require("./selectors/uri.cjs");
 var _util = require("../openapi-3-1/util.cjs");
 var _util2 = require("./util.cjs");
+var _UnresolvableReferenceError = _interopRequireDefault(require("../../../errors/UnresolvableReferenceError.cjs"));
 var _MaximumDereferenceDepthError = _interopRequireDefault(require("../../../errors/MaximumDereferenceDepthError.cjs"));
 var _MaximumResolveDepthError = _interopRequireDefault(require("../../../errors/MaximumResolveDepthError.cjs"));
 var url = _interopRequireWildcard(require("../../../util/url.cjs"));
@@ -24,9 +25,6 @@ var _Reference = _interopRequireDefault(require("../../../Reference.cjs"));
 var _File = _interopRequireDefault(require("../../../File.cjs"));
 var _util3 = require("../../util.cjs");
 var _EvaluationJsonSchemaUriError = _interopRequireDefault(require("../../../errors/EvaluationJsonSchemaUriError.cjs"));
-// initialize element identity manager
-const identityManager = new _apidomCore.IdentityManager();
-
 /**
  * @public
  */
@@ -36,30 +34,42 @@ const identityManager = new _apidomCore.IdentityManager();
  */
 class Arazzo1DereferenceVisitor {
   indirections;
-  namespace;
   reference;
   options;
+
+  /**
+   * Tracks element ancestors across dive-deep traversal boundaries.
+   * Used for cycle detection: if a referenced element is found in
+   * the ancestor lineage, a circular reference is detected.
+   */
   ancestors;
   constructor({
     reference,
-    namespace,
     options,
     indirections = [],
     ancestors = new _util3.AncestorLineage()
   }) {
     this.indirections = indirections;
-    this.namespace = namespace;
     this.reference = reference;
     this.options = options;
     this.ancestors = new _util3.AncestorLineage(...ancestors);
   }
+  toAncestorLineage(path) {
+    const ancestorNodes = path.getAncestorNodes();
+    const directAncestors = new Set(ancestorNodes.filter(_apidomDatamodel.isElement));
+    const ancestorsLineage = new _util3.AncestorLineage(...this.ancestors, directAncestors);
+    return [ancestorsLineage, directAncestors];
+  }
   toBaseURI(uri) {
     return url.resolve(this.reference.uri, url.sanitize(url.stripHash(uri)));
   }
   async toReference(uri) {
     // detect maximum depth of resolution
     if (this.reference.depth >= this.options.resolve.maxDepth) {
-      throw new _MaximumResolveDepthError.default(`Maximum resolution depth of ${this.options.resolve.maxDepth} has been exceeded by file "${this.reference.uri}"`);
+      throw new _MaximumResolveDepthError.default(`Maximum resolution depth of ${this.options.resolve.maxDepth} has been exceeded by file "${this.reference.uri}"`, {
+        maxDepth: this.options.resolve.maxDepth,
+        uri: this.reference.uri
+      });
     }
     const baseURI = this.toBaseURI(uri);
     const {
@@ -79,9 +89,23 @@ class Arazzo1DereferenceVisitor {
     });
 
     // register new mutable reference with a refSet
+    //
+    // NOTE(known limitation): the mutable reference is mutated in place during traversal
+    // (via `{ mutable: true }`). When an external document evaluates a JSON pointer back
+    // into this document, it may receive an already-resolved element instead of the original
+    // $ref. That resolved element was produced using the entry document's resolution context
+    // (ancestors, indirections), which may differ from the external document's context.
+    // This can affect cycle detection in rare cross-document circular reference patterns.
+    //
+    // Remediation: evaluate JSON pointers against the immutable (original) parse tree
+    // instead of the mutable working copy. The `immutable://` reference below preserves
+    // the original tree and could be used for pointer evaluation, ensuring every resolution
+    // context always sees raw, unresolved elements and processes them with its own
+    // ancestors/indirections. The trade-off is that elements referenced by multiple
+    // documents would be resolved once per context instead of being reused.
     const mutableReference = new _Reference.default({
       uri: baseURI,
-      value: (0, _apidomDatamodel.cloneDeep)(parseResult),
+      value: this.options.dereference.immutable ? (0, _apidomDatamodel.cloneDeep)(parseResult) : parseResult,
       depth: this.reference.depth + 1
     });
     refSet.add(mutableReference);
@@ -96,15 +120,77 @@ class Arazzo1DereferenceVisitor {
     }
     return mutableReference;
   }
-  toAncestorLineage(path) {
-    /**
-     * Compute full ancestors lineage.
-     * Ancestors are flatten to unwrap all Element instances.
-     */
-    const ancestorNodes = path.getAncestorNodes();
-    const directAncestors = new Set(ancestorNodes.filter(_apidomDatamodel.isElement));
-    const ancestorsLineage = new _util3.AncestorLineage(...this.ancestors, directAncestors);
-    return [ancestorsLineage, directAncestors];
+
+  /**
+   * Handles an error according to the continueOnError option.
+   *
+   * For new errors: wraps in UnresolvableReferenceError with structured context
+   * (type, uri, location, codeFrame, refFieldName, refFieldValue, trace).
+   * For errors already wrapped by a nested visitor: prepends the current hop to the trace.
+   *
+   * Inner/intermediate visitors always throw to let the trace accumulate.
+   * Only the entry document visitor respects continueOnError (callback/swallow/throw).
+   */
+  handleError(message, error, referencingElement, refFieldName, refFieldValue, visitorPath) {
+    const {
+      continueOnError
+    } = this.options.dereference;
+    const isEntryDocument = url.stripHash(this.reference.refSet?.rootRef?.uri ?? '') === this.reference.uri;
+    const uri = this.reference.uri;
+    const type = referencingElement.element;
+    const codeFrame = (0, _apidomCore.toYAML)(referencingElement);
+
+    // find element location: tree search for entry documents, visitor path for external
+    let location;
+    (0, _apidomTraverse.traverse)(this.reference.value.result, {
+      enter: p => {
+        if (p.node === referencingElement) {
+          location = p.formatPath();
+          p.stop();
+        }
+      }
+    });
+    location ??= visitorPath.formatPath();
+    const hop = {
+      uri,
+      type,
+      refFieldName,
+      refFieldValue,
+      location,
+      codeFrame
+    };
+
+    // enrich existing error from nested visitor or create new one
+    let unresolvedError;
+    if (error instanceof _UnresolvableReferenceError.default) {
+      // prefix relative locations for entries belonging to the referenced document
+      const refBaseURI = this.toBaseURI(refFieldValue);
+      const fragment = _apidomJsonPointer.URIFragmentIdentifier.fromURIReference(refFieldValue);
+      if (fragment) {
+        if (refBaseURI === error.uri && error.location) {
+          error.location = fragment + error.location;
+        }
+        for (const h of error.trace) {
+          if (h.uri === refBaseURI && h.location) h.location = fragment + h.location;
+        }
+      }
+      // @ts-ignore
+      error.trace = [hop, ...error.trace];
+      unresolvedError = error;
+    } else {
+      unresolvedError = new _UnresolvableReferenceError.default(message, {
+        cause: error,
+        type,
+        uri,
+        location,
+        codeFrame,
+        refFieldName,
+        refFieldValue,
+        trace: []
+      });
+    }
+    if (!isEntryDocument || continueOnError === false) throw unresolvedError;
+    if (typeof continueOnError === 'function') continueOnError(unresolvedError);
   }
   ReusableElement(path) {
     const referencingElement = path.node;
@@ -128,12 +214,16 @@ class Arazzo1DereferenceVisitor {
       tree
     } = (0, _arazzoRuntimeExpression.parse)(runtimeExpression);
     if (!result.success) {
-      throw new _apidomError.ApiDOMError(`Invalid Reusable Object reference format: "${runtimeExpression}"`);
+      throw new _apidomError.ApiDOMStructuredError(`Invalid Reusable Object reference format: "${runtimeExpression}"`, {
+        runtimeExpression
+      });
     }
 
     // ReusableElement can only reference components
     if (tree.type !== 'ComponentsExpression') {
-      throw new _apidomError.ApiDOMError(`Reusable Object reference "${runtimeExpression}" must be a components expression`);
+      throw new _apidomError.ApiDOMStructuredError(`Reusable Object reference "${runtimeExpression}" must be a components expression`, {
+        runtimeExpression
+      });
     }
 
     // evaluate runtime expression as JSON Pointer to get the referenced element
@@ -142,15 +232,15 @@ class Arazzo1DereferenceVisitor {
     try {
       referencedElement = (0, _apidomJsonPointer.evaluate)(this.reference.value.result, jsonPointer);
     } catch {
-      throw new _apidomError.ApiDOMError(`Reusable Object reference "${runtimeExpression}" cannot be resolved`);
+      throw new _apidomError.ApiDOMStructuredError(`Reusable Object reference "${runtimeExpression}" cannot be resolved`, {
+        runtimeExpression
+      });
     }
 
     /**
      * Create a shallow clone of the referenced element to avoid modifying the original.
      */
     const mergedElement = (0, _apidomDatamodel.cloneShallow)(referencedElement);
-    // assign unique id to merged element
-    mergedElement.meta.set('id', identityManager.generateId());
     // annotate with info about original referencing element
     mergedElement.meta.set('ref-fields', {
       reference: runtimeExpression,
@@ -158,8 +248,7 @@ class Arazzo1DereferenceVisitor {
     });
     // annotate with info about origin
     mergedElement.meta.set('ref-origin', this.reference.uri);
-    // annotate with info about referencing element
-    mergedElement.meta.set('ref-referencing-element-id', identityManager.identify(referencingElement));
+    mergedElement.meta.set('ref-type', referencingElement.element);
 
     // override value field if present for Parameter Objects
     if ((0, _apidomNsArazzo.isParameterElement)(mergedElement) && referencingElement.hasKey('value')) {
@@ -185,78 +274,33 @@ class Arazzo1DereferenceVisitor {
       path.skip();
       return;
     }
-    const [ancestorsLineage, directAncestors] = this.toAncestorLineage(path);
-
-    // compute baseURI using rules around $id and $ref keywords
-    let reference = await this.toReference(url.unsanitize(this.reference.uri));
-    let {
-      uri: retrievalURI
-    } = reference;
-    const $refBaseURI = (0, _util.resolveSchema$refField)(retrievalURI, referencingElement);
-    const $refBaseURIStrippedHash = url.stripHash($refBaseURI);
-    const file = new _File.default({
-      uri: $refBaseURIStrippedHash
-    });
-    const isUnknownURI = (0, _ramda.none)(r => r.canRead(file), this.options.resolve.resolvers);
-    const isURL = !isUnknownURI;
-    let isInternalReference = url.stripHash(this.reference.uri) === $refBaseURI;
-    let isExternalReference = !isInternalReference;
-
-    // determining reference, proper evaluation and selection mechanism
-    let referencedElement;
+    const indirectionsSize = this.indirections.length;
     try {
-      if (isUnknownURI || isURL) {
-        // we're dealing with canonical URI or URL with possible fragment
-        retrievalURI = this.toBaseURI($refBaseURI);
-        const selector = $refBaseURI;
-        const referenceAsSchema = (0, _util2.maybeRefractToJSONSchemaElement)(reference.value.result);
-        referencedElement = (0, _uri.evaluate)(selector, referenceAsSchema);
-        referencedElement = (0, _util2.maybeRefractToJSONSchemaElement)(referencedElement);
-        referencedElement.id = identityManager.identify(referencedElement);
-
-        // ignore resolving internal Schema Objects
-        if (!this.options.resolve.internal && isInternalReference) {
-          // skip traversing this schema element but traverse all its child elements
-          return;
-        }
-        // ignore resolving external Schema Objects
-        if (!this.options.resolve.external && isExternalReference) {
-          // skip traversing this schema element but traverse all its child elements
-          return;
-        }
-      } else {
-        // we're assuming here that we're dealing with JSON Pointer here
-        retrievalURI = this.toBaseURI($refBaseURI);
-        isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
-        isExternalReference = !isInternalReference;
+      // compute baseURI using rules around $id and $ref keywords
+      let reference = await this.toReference(url.unsanitize(this.reference.uri));
+      let {
+        uri: retrievalURI
+      } = reference;
+      const $refBaseURI = (0, _util.resolveSchema$refField)(retrievalURI, referencingElement);
+      const $refBaseURIStrippedHash = url.stripHash($refBaseURI);
+      const file = new _File.default({
+        uri: $refBaseURIStrippedHash
+      });
+      const isUnknownURI = (0, _ramda.none)(r => r.canRead(file), this.options.resolve.resolvers);
+      const isURL = !isUnknownURI;
+      let isInternalReference = url.stripHash(this.reference.uri) === $refBaseURI;
+      let isExternalReference = !isInternalReference;
 
-        // ignore resolving internal Schema Objects
-        if (!this.options.resolve.internal && isInternalReference) {
-          // skip traversing this schema element but traverse all its child elements
-          return;
-        }
-        // ignore resolving external Schema Objects
-        if (!this.options.resolve.external && isExternalReference) {
-          // skip traversing this schema element but traverse all its child elements
-          return;
-        }
-        reference = await this.toReference(url.unsanitize($refBaseURI));
-        const selector = _apidomJsonPointer.URIFragmentIdentifier.fromURIReference($refBaseURI);
-        const referenceAsSchema = (0, _util2.maybeRefractToJSONSchemaElement)(reference.value.result);
-        referencedElement = (0, _apidomJsonPointer.evaluate)(referenceAsSchema, selector);
-        referencedElement = (0, _util2.maybeRefractToJSONSchemaElement)(referencedElement);
-        referencedElement.id = identityManager.identify(referencedElement);
-      }
-    } catch (error) {
-      /**
-       * JSONSchemaElement($id=URL) was not found, so we're going to try to resolve
-       * the URL and assume the returned response is a JSON Schema.
-       */
-      if (isURL && error instanceof _EvaluationJsonSchemaUriError.default) {
-        if ((0, _$anchor.isAnchor)((0, _$anchor.uriToAnchor)($refBaseURI))) {
-          // we're dealing with JSON Schema $anchor here
-          isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
-          isExternalReference = !isInternalReference;
+      // determining reference, proper evaluation and selection mechanism
+      let referencedElement;
+      try {
+        if (isUnknownURI || isURL) {
+          // we're dealing with canonical URI or URL with possible fragment
+          retrievalURI = this.toBaseURI($refBaseURI);
+          const selector = $refBaseURI;
+          const referenceAsSchema = (0, _util2.maybeRefractToJSONSchemaElement)(reference.value.result);
+          referencedElement = (0, _uri.evaluate)(selector, referenceAsSchema);
+          referencedElement = (0, _util2.maybeRefractToJSONSchemaElement)(referencedElement);
 
           // ignore resolving internal Schema Objects
           if (!this.options.resolve.internal && isInternalReference) {
@@ -268,12 +312,6 @@ class Arazzo1DereferenceVisitor {
             // skip traversing this schema element but traverse all its child elements
             return;
           }
-          reference = await this.toReference(url.unsanitize($refBaseURI));
-          const selector = (0, _$anchor.uriToAnchor)($refBaseURI);
-          const referenceAsSchema = (0, _util2.maybeRefractToJSONSchemaElement)(reference.value.result);
-          referencedElement = (0, _$anchor.evaluate)(selector, referenceAsSchema);
-          referencedElement = (0, _util2.maybeRefractToJSONSchemaElement)(referencedElement);
-          referencedElement.id = identityManager.identify(referencedElement);
         } else {
           // we're assuming here that we're dealing with JSON Pointer here
           retrievalURI = this.toBaseURI($refBaseURI);
@@ -295,117 +333,169 @@ class Arazzo1DereferenceVisitor {
           const referenceAsSchema = (0, _util2.maybeRefractToJSONSchemaElement)(reference.value.result);
           referencedElement = (0, _apidomJsonPointer.evaluate)(referenceAsSchema, selector);
           referencedElement = (0, _util2.maybeRefractToJSONSchemaElement)(referencedElement);
-          referencedElement.id = identityManager.identify(referencedElement);
         }
-      } else {
-        throw error;
-      }
-    }
-    this.indirections.push(referencingElement);
+      } catch (error) {
+        /**
+         * JSONSchemaElement($id=URL) was not found, so we're going to try to resolve
+         * the URL and assume the returned response is a JSON Schema.
+         */
+        if (isURL && error instanceof _EvaluationJsonSchemaUriError.default) {
+          if ((0, _$anchor.isAnchor)((0, _$anchor.uriToAnchor)($refBaseURI))) {
+            // we're dealing with JSON Schema $anchor here
+            isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
+            isExternalReference = !isInternalReference;
 
-    // detect direct or indirect reference
-    if (referencingElement === referencedElement) {
-      throw new _apidomError.ApiDOMError('Recursive JSON Schema reference detected');
-    }
+            // ignore resolving internal Schema Objects
+            if (!this.options.resolve.internal && isInternalReference) {
+              // skip traversing this schema element but traverse all its child elements
+              return;
+            }
+            // ignore resolving external Schema Objects
+            if (!this.options.resolve.external && isExternalReference) {
+              // skip traversing this schema element but traverse all its child elements
+              return;
+            }
+            reference = await this.toReference(url.unsanitize($refBaseURI));
+            const selector = (0, _$anchor.uriToAnchor)($refBaseURI);
+            const referenceAsSchema = (0, _util2.maybeRefractToJSONSchemaElement)(reference.value.result);
+            referencedElement = (0, _$anchor.evaluate)(selector, referenceAsSchema);
+            referencedElement = (0, _util2.maybeRefractToJSONSchemaElement)(referencedElement);
+          } else {
+            // we're assuming here that we're dealing with JSON Pointer here
+            retrievalURI = this.toBaseURI($refBaseURI);
+            isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
+            isExternalReference = !isInternalReference;
 
-    // detect maximum depth of dereferencing
-    if (this.indirections.length > this.options.dereference.maxDepth) {
-      throw new _MaximumDereferenceDepthError.default(`Maximum dereference depth of "${this.options.dereference.maxDepth}" has been exceeded in file "${this.reference.uri}"`);
-    }
+            // ignore resolving internal Schema Objects
+            if (!this.options.resolve.internal && isInternalReference) {
+              // skip traversing this schema element but traverse all its child elements
+              return;
+            }
+            // ignore resolving external Schema Objects
+            if (!this.options.resolve.external && isExternalReference) {
+              // skip traversing this schema element but traverse all its child elements
+              return;
+            }
+            reference = await this.toReference(url.unsanitize($refBaseURI));
+            const selector = _apidomJsonPointer.URIFragmentIdentifier.fromURIReference($refBaseURI);
+            const referenceAsSchema = (0, _util2.maybeRefractToJSONSchemaElement)(reference.value.result);
+            referencedElement = (0, _apidomJsonPointer.evaluate)(referenceAsSchema, selector);
+            referencedElement = (0, _util2.maybeRefractToJSONSchemaElement)(referencedElement);
+          }
+        } else {
+          throw error;
+        }
+      }
+      this.indirections.push(referencingElement);
 
-    // detect second deep dive into the same fragment and avoid it
-    if (ancestorsLineage.includes(referencedElement)) {
-      reference.refSet.circular = true;
-      if (this.options.dereference.circular === 'error') {
-        throw new _apidomError.ApiDOMError('Circular reference detected');
-      } else if (this.options.dereference.circular === 'replace') {
-        const refElement = new _apidomDatamodel.RefElement(referencedElement.id, {
-          type: 'json-schema',
-          uri: reference.uri,
+      // detect direct or indirect reference
+      if (referencingElement === referencedElement) {
+        throw new _apidomError.ApiDOMStructuredError('Recursive JSON Schema reference detected', {
           $ref: (0, _apidomCore.toValue)(referencingElement.$ref)
         });
-        const replacer = this.options.dereference.strategyOpts['arazzo-1']?.circularReplacer ?? this.options.dereference.circularReplacer;
-        const replacement = replacer(refElement);
-        this.indirections.pop();
-        path.replaceWith(replacement);
-        return;
       }
-    }
 
-    /**
-     * Dive deep into the fragment.
-     *
-     * Cases to consider:
-     *  1. We're crossing document boundary
-     *  2. Fragment is from non-root document
-     *  3. Fragment is a JSON Schema with $ref field. We need to follow it to get the eventual value
-     *  4. We are dereferencing the fragment lazily/eagerly depending on circular mode
-     */
-    const isNonRootDocument = url.stripHash(reference.refSet.rootRef.uri) !== reference.uri;
-    const shouldDetectCircular = ['error', 'replace'].includes(this.options.dereference.circular);
-    if ((isExternalReference || isNonRootDocument || (0, _apidomNsArazzo.isJSONSchemaElement)(referencedElement) && (0, _apidomDatamodel.isStringElement)(referencedElement.$ref) || shouldDetectCircular) && !ancestorsLineage.includesCycle(referencedElement)) {
-      // append referencing reference to ancestors lineage
-      directAncestors.add(referencingElement);
-      const visitor = new Arazzo1DereferenceVisitor({
-        reference,
-        namespace: this.namespace,
-        indirections: [...this.indirections],
-        options: this.options,
-        ancestors: ancestorsLineage
-      });
-      referencedElement = await (0, _apidomTraverse.traverseAsync)(referencedElement, visitor, {
-        mutable: true
-      });
+      // detect maximum depth of dereferencing
+      if (this.indirections.length > this.options.dereference.maxDepth) {
+        throw new _MaximumDereferenceDepthError.default(`Maximum dereference depth of "${this.options.dereference.maxDepth}" has been exceeded in file "${this.reference.uri}"`, {
+          maxDepth: this.options.dereference.maxDepth,
+          uri: this.reference.uri
+        });
+      }
 
-      // remove referencing reference from ancestors lineage
-      directAncestors.delete(referencingElement);
-    }
-    this.indirections.pop();
+      // detect cross-boundary cycle
+      const [ancestorsLineage, directAncestors] = this.toAncestorLineage(path);
+      if (ancestorsLineage.includes(referencedElement)) {
+        reference.refSet.circular = true;
+        if (this.options.dereference.circular === 'error') {
+          throw new _apidomError.ApiDOMStructuredError('Circular reference detected', {
+            $ref: (0, _apidomCore.toValue)(referencingElement.$ref)
+          });
+        } else if (this.options.dereference.circular === 'replace') {
+          const refElement = new _apidomDatamodel.RefElement($refBaseURI, {
+            type: referencingElement.element,
+            uri: reference.uri,
+            $ref: (0, _apidomCore.toValue)(referencingElement.$ref)
+          });
+          const replacer = this.options.dereference.strategyOpts['arazzo-1']?.circularReplacer ?? this.options.dereference.circularReplacer;
+          const replacement = replacer(refElement);
+          path.replaceWith(replacement);
+          return;
+        }
+      }
 
-    // Boolean JSON Schemas
-    if ((0, _apidomNsArazzo.isBooleanJSONSchemaElement)(referencedElement)) {
-      const booleanJsonSchemaElement = (0, _apidomDatamodel.cloneDeep)(referencedElement);
-      // assign unique id to merged element
-      booleanJsonSchemaElement.meta.set('id', identityManager.generateId());
-      // annotate referenced element with info about original referencing element
-      booleanJsonSchemaElement.meta.set('ref-fields', {
-        $ref: (0, _apidomCore.toValue)(referencingElement.$ref)
-      });
-      // annotate referenced element with info about origin
-      booleanJsonSchemaElement.meta.set('ref-origin', reference.uri);
-      // annotate fragment with info about referencing element
-      booleanJsonSchemaElement.meta.set('ref-referencing-element-id', identityManager.identify(referencingElement));
-      path.replaceWith(booleanJsonSchemaElement);
-      return;
-    }
+      /**
+       * Dive deep into the fragment.
+       *
+       * Cases to consider:
+       *  1. We're crossing document boundary
+       *  2. Fragment is from non-entry document
+       *  3. Fragment is a JSON Schema with $ref field. We need to follow it to get the eventual value
+       *  4. We are dereferencing the fragment lazily/eagerly depending on circular mode
+       */
+      const isNonEntryDocument = url.stripHash(reference.refSet.rootRef.uri) !== reference.uri;
+      const shouldDetectCircular = ['error', 'replace'].includes(this.options.dereference.circular);
+      if ((isExternalReference || isNonEntryDocument || (0, _apidomNsArazzo.isJSONSchemaElement)(referencedElement) && (0, _apidomDatamodel.isStringElement)(referencedElement.$ref) || shouldDetectCircular) && !ancestorsLineage.includesCycle(referencedElement)) {
+        // append referencing reference to ancestors lineage
+        directAncestors.add(referencingElement);
+        const visitor = new Arazzo1DereferenceVisitor({
+          reference,
+          indirections: [...this.indirections],
+          options: this.options,
+          ancestors: ancestorsLineage
+        });
+        referencedElement = await (0, _apidomTraverse.traverseAsync)(referencedElement, visitor, {
+          mutable: true
+        });
 
-    /**
-     * Creating a new version of JSON Schema by merging fields from referenced Schema with referencing one.
-     */
-    if ((0, _apidomNsArazzo.isJSONSchemaElement)(referencedElement)) {
-      const mergedElement = (0, _apidomDatamodel.cloneShallow)(referencedElement);
-      // assign unique id to merged element
-      mergedElement.meta.set('id', identityManager.generateId());
-      // existing keywords from referencing schema overrides ones from referenced schema
-      referencingElement.forEach((value, keyElement, item) => {
-        mergedElement.remove((0, _apidomCore.toValue)(keyElement));
-        mergedElement.content.push(item);
-      });
-      mergedElement.remove('$ref');
-      // annotate referenced element with info about original referencing element
-      mergedElement.meta.set('ref-fields', {
-        $ref: (0, _apidomCore.toValue)(referencingElement.$ref)
-      });
-      // annotate fragment with info about origin
-      mergedElement.meta.set('ref-origin', reference.uri);
-      // annotate fragment with info about referencing element
-      mergedElement.meta.set('ref-referencing-element-id', identityManager.identify(referencingElement));
-      referencedElement = mergedElement;
+        // remove referencing reference from ancestors lineage
+        directAncestors.delete(referencingElement);
+      }
+
+      // Boolean JSON Schemas
+      if ((0, _apidomNsArazzo.isBooleanJSONSchemaElement)(referencedElement)) {
+        const booleanJsonSchemaElement = (0, _apidomDatamodel.cloneDeep)(referencedElement);
+        // annotate referenced element with info about original referencing element
+        booleanJsonSchemaElement.meta.set('ref-fields', {
+          $ref: (0, _apidomCore.toValue)(referencingElement.$ref)
+        });
+        // annotate referenced element with info about origin
+        booleanJsonSchemaElement.meta.set('ref-origin', reference.uri);
+        booleanJsonSchemaElement.meta.set('ref-type', referencingElement.element);
+        path.replaceWith(booleanJsonSchemaElement);
+        return;
+      }
+
+      /**
+       * Creating a new version of JSON Schema by merging fields from referenced Schema with referencing one.
+       */
+      if ((0, _apidomNsArazzo.isJSONSchemaElement)(referencedElement)) {
+        const mergedElement = (0, _apidomDatamodel.cloneShallow)(referencedElement);
+        // existing keywords from referencing schema overrides ones from referenced schema
+        referencingElement.forEach((value, keyElement, item) => {
+          mergedElement.remove((0, _apidomCore.toValue)(keyElement));
+          mergedElement.content.push(item);
+        });
+        mergedElement.remove('$ref');
+        // annotate referenced element with info about original referencing element
+        mergedElement.meta.set('ref-fields', {
+          $ref: (0, _apidomCore.toValue)(referencingElement.$ref)
+        });
+        // annotate fragment with info about origin
+        mergedElement.meta.set('ref-origin', reference.uri);
+        mergedElement.meta.set('ref-type', referencingElement.element);
+        referencedElement = mergedElement;
+      }
+      /**
+       * Transclude referencing element with merged referenced element.
+       */
+      path.replaceWith(referencedElement);
+    } catch (error) {
+      const $ref = (0, _apidomCore.toValue)(referencingElement.$ref);
+      this.handleError(`Error while dereferencing Schema Object. Cannot resolve $ref "${$ref}": ${error.message}`, error, referencingElement, '$ref', $ref, path);
+    } finally {
+      if (this.indirections.length > indirectionsSize) this.indirections.pop();
     }
-    /**
-     * Transclude referencing element with merged referenced element.
-     */
-    path.replaceWith(referencedElement);
   }
 }
 var _default = exports.default = Arazzo1DereferenceVisitor;