@speclynx/apidom-reference 6.1.2 → 7.0.0

package/src/dereference/strategies/openapi-2/visitor.mjs

@@ -1,363 +1,147 @@
-import { propEq } from 'ramda';
-import { RefElement, isStringElement, isElement, cloneShallow, cloneDeep } from '@speclynx/apidom-datamodel';
-import { toValue, toYAML } from '@speclynx/apidom-core';
+import { isStringElement, cloneShallow } from '@speclynx/apidom-datamodel';
+import { toValue } from '@speclynx/apidom-core';
 import { ApiDOMStructuredError } from '@speclynx/apidom-error';
-import { traverse, traverseAsync } from '@speclynx/apidom-traverse';
-import { evaluate, URIFragmentIdentifier } from '@speclynx/apidom-json-pointer';
-import { isReferenceElement, isJSONReferenceElement, isPathItemElement, isReferenceLikeElement, isJSONReferenceLikeElement, refract, refractReference, refractPathItem, refractJSONReference } from '@speclynx/apidom-ns-openapi-2';
-import UnresolvableReferenceError from "../../../errors/UnresolvableReferenceError.mjs";
-import MaximumDereferenceDepthError from "../../../errors/MaximumDereferenceDepthError.mjs";
-import MaximumResolveDepthError from "../../../errors/MaximumResolveDepthError.mjs";
-import { AncestorLineage } from "../../util.mjs";
+import { evaluate as jsonPointerEvaluate, URIFragmentIdentifier } from '@speclynx/apidom-json-pointer';
+import { isReferenceLikeElement, isJSONReferenceLikeElement, isPathItemElement, isReferenceElement, isJSONReferenceElement, refract, refractReference, refractJSONReference } from '@speclynx/apidom-ns-openapi-2';
+import DereferenceVisitor from "../DereferenceVisitor.mjs";
 import * as url from "../../../util/url.mjs";
-import parse from "../../../parse/index.mjs";
-import Reference from "../../../Reference.mjs";
 /**
  * @public
  */
 /**
+ * Dereferences an OpenAPI 2.0 document. Reference Objects and JSON Reference Objects expect
+ * the type of their `referenced-element` meta, Path Item `$ref`s a Path Item Object.
+ *
  * @public
  */
-class OpenAPI2DereferenceVisitor {
-  indirections;
-  reference;
-  options;
-  refractCache;
-  visited;
-
-  /**
-   * 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,
-    options,
-    indirections = [],
-    ancestors = new AncestorLineage(),
-    refractCache = new WeakMap(),
-    visited = new WeakSet()
-  }) {
-    this.indirections = indirections;
-    this.reference = reference;
-    this.options = options;
-    this.refractCache = refractCache;
-    this.ancestors = new AncestorLineage(...ancestors);
-    this.visited = visited;
-  }
-  toAncestorLineage(path) {
-    const ancestorNodes = path.getAncestorNodes();
-    const directAncestors = new Set(ancestorNodes.filter(isElement));
-    const ancestorsLineage = new AncestorLineage(...this.ancestors, directAncestors);
-    return [ancestorsLineage, directAncestors];
+class OpenAPI2DereferenceVisitor extends DereferenceVisitor {
+  get strategyName() {
+    return 'openapi-2';
   }
-  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(`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 {
-      refSet
-    } = this.reference;
-
-    // we've already processed this Reference in past
-    if (refSet.has(baseURI)) {
-      return refSet.find(propEq(baseURI, 'uri'));
-    }
-    const parseResult = await parse(url.unsanitize(baseURI), {
-      ...this.options,
-      parse: {
-        ...this.options.parse,
-        mediaType: 'text/plain'
-      }
-    });
-
-    // 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({
-      uri: baseURI,
-      value: this.options.dereference.immutable ? cloneDeep(parseResult) : parseResult,
-      depth: this.reference.depth + 1
+  createVisitor(reference) {
+    return new OpenAPI2DereferenceVisitor({
+      reference,
+      options: this.options
     });
-    refSet.add(mutableReference);
-    if (this.options.dereference.immutable) {
-      // register new immutable reference with a refSet
-      const immutableReference = new Reference({
-        uri: `immutable://${baseURI}`,
-        value: parseResult,
-        depth: this.reference.depth + 1
-      });
-      refSet.add(immutableReference);
-    }
-    return mutableReference;
   }
 
   /**
-   * 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).
+   * A (JSON) Reference Object stands for the type its reference expects: it's dereferenced as that type.
    */
-  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 = toYAML(referencingElement);
+  isOfType(element, type) {
+    return isReferenceElement(element) || isJSONReferenceElement(element) || element.element === type;
+  }
 
-    // find element location by identity in the document tree.
-    // guarded: this.reference.value may not be a ParseResultElement or may lack a result.
-    // falls back to visitorPath which may produce an incomplete path when
-    // dereferenceApiDOM is called with a fragment (cloneShallow creates a new root identity).
-    let location;
-    const root = this.reference.value.result;
-    if (isElement(root)) {
-      traverse(root, {
-        enter: p => {
-          if (p.node === referencingElement || this.refractCache.get(p.node) === referencingElement) {
-            location = p.formatPath();
-            p.stop();
-          }
-        }
-      });
+  /**
+   * A generic structure holding a `$ref` is a reference to the expected type: a JSON Reference
+   * Object for a Schema Object, a Reference Object otherwise, unless the type has its own `$ref`
+   * field (Path Item Object).
+   */
+  refractTo(element, type) {
+    if (type === 'schema' && isJSONReferenceLikeElement(element)) {
+      const referenceElement = refractJSONReference(element);
+      referenceElement.meta.set('referenced-element', type);
+      return referenceElement;
     }
-    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) {
-      // prefix relative locations for entries belonging to the referenced document
-      const refBaseURI = this.toBaseURI(refFieldValue);
-      const fragment = 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(message, {
-        cause: error,
-        type,
-        uri,
-        location,
-        codeFrame,
-        refFieldName,
-        refFieldValue,
-        trace: []
-      });
+    if (type !== 'schema' && type !== 'pathItem' && isReferenceLikeElement(element)) {
+      const referenceElement = refractReference(element);
+      referenceElement.meta.set('referenced-element', type);
+      return referenceElement;
     }
-    if (!isEntryDocument || continueOnError === false) throw unresolvedError;
-    if (typeof continueOnError === 'function') continueOnError(unresolvedError);
+    return refract(element, {
+      element: type
+    });
   }
   async ReferenceElement(path) {
     const referencingElement = path.node;
 
-    // ignore Reference Object without a string $ref, e.g. an empty YAML value
-    if (!isStringElement(referencingElement.$ref)) {
-      return;
-    }
+    // the fields of a Reference Object hold no references
+    path.skip();
 
-    // skip current referencing element as it's already been access
-    if (this.indirections.includes(referencingElement)) {
-      path.skip();
+    // ignore Reference Object without a string $ref, e.g. an empty YAML value
+    if (this.isTranscluded(referencingElement) || !isStringElement(referencingElement.$ref)) {
       return;
     }
-    const retrievalURI = this.toBaseURI(toValue(referencingElement.$ref));
+    const $ref = toValue(referencingElement.$ref);
+    const retrievalURI = this.toBaseURI($ref);
     const isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
     const isExternalReference = !isInternalReference;
 
     // ignore resolving internal Reference Objects
     if (!this.options.resolve.internal && isInternalReference) {
-      // skip traversing this reference element and all it's child elements
-      path.skip();
       return;
     }
     // ignore resolving external Reference Objects
     if (!this.options.resolve.external && isExternalReference) {
-      // skip traversing this reference element and all it's child elements
-      path.skip();
       return;
     }
-    const $refBaseURI = url.resolve(retrievalURI, toValue(referencingElement.$ref));
-    const indirectionsSize = this.indirections.length;
+    const $refBaseURI = url.resolve(retrievalURI, $ref);
     try {
-      const reference = await this.toReference(toValue(referencingElement.$ref));
-      this.indirections.push(referencingElement);
+      const reference = await this.toReference($ref);
       const jsonPointer = URIFragmentIdentifier.fromURIReference($refBaseURI);
-
       // possibly non-semantic fragment
-      let referencedElement = evaluate(reference.value.result, jsonPointer);
+      const referencedElement = jsonPointerEvaluate(reference.value.result, jsonPointer);
 
-      // applying semantics to a fragment
-      const referencedElementType = referencingElement.meta.get('referenced-element');
-      if (referencedElement.element !== referencedElementType && !isReferenceElement(referencedElement)) {
-        if (this.refractCache.has(referencedElement)) {
-          referencedElement = this.refractCache.get(referencedElement);
-        } else if (isReferenceLikeElement(referencedElement)) {
-          // handling generic indirect references
-          const sourceElement = referencedElement;
-          referencedElement = refractReference(referencedElement);
-          referencedElement.meta.set('referenced-element', referencedElementType);
-          this.refractCache.set(sourceElement, referencedElement);
-        } else {
-          // handling direct references
-          const sourceElement = referencedElement;
-          referencedElement = refract(referencedElement, {
-            element: referencedElementType
-          });
-          this.refractCache.set(sourceElement, referencedElement);
-        }
-      }
-
-      // detect direct or indirect reference
+      // detect direct reference
       if (referencingElement === referencedElement) {
         throw new ApiDOMStructuredError('Recursive Reference Object detected', {
-          $ref: toValue(referencingElement.$ref)
+          $ref
         });
       }
 
-      // detect maximum depth of dereferencing
-      if (this.indirections.length > this.options.dereference.maxDepth) {
-        throw new MaximumDereferenceDepthError(`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
-        });
-      }
-
-      // 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 ApiDOMStructuredError('Circular reference detected', {
-            $ref: toValue(referencingElement.$ref)
+      // a reference without an expected type reads its target as its own type
+      const type = toValue(referencingElement.meta.get('referenced-element')) ?? referencedElement.element;
+      await this.addTransclusion(path, {
+        source: referencedElement,
+        type,
+        reference,
+        context: undefined
+      }, {
+        toTranscludedElement: (element, target) => {
+          // a chain of Reference Objects leading back to itself never reaches a value
+          if (isReferenceElement(target)) return element;
+
+          /**
+           * Creating a new version of referenced element to avoid modifying the original one.
+           */
+          const mergedElement = cloneShallow(target);
+          // annotate referenced element with info about original referencing element
+          mergedElement.meta.set('ref-fields', {
+            $ref
           });
-        } else if (this.options.dereference.circular === 'replace') {
-          const refElement = new RefElement($refBaseURI, {
-            type: referencingElement.element,
+          // annotate fragment with info about origin
+          mergedElement.meta.set('ref-origin', reference.uri);
+          mergedElement.meta.set('ref-type', element.element);
+          return mergedElement;
+        },
+        circular: {
+          uri: $refBaseURI,
+          meta: {
             uri: reference.uri,
-            $ref: toValue(referencingElement.$ref)
-          });
-          const replacer = this.options.dereference.strategyOpts['openapi-2']?.circularReplacer ?? this.options.dereference.circularReplacer;
-          const replacement = replacer(refElement);
-          path.replaceWith(replacement);
-          path.skip();
-          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 Reference Object. 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 || isReferenceElement(referencedElement) || shouldDetectCircular && !this.visited.has(referencedElement)) && !ancestorsLineage.includesCycle(referencedElement)) {
-        if (shouldDetectCircular) {
-          this.visited.add(referencedElement);
+            $ref
+          },
+          details: {
+            $ref
+          }
         }
-
-        // append referencing reference to ancestors lineage
-        directAncestors.add(referencingElement);
-        const visitor = new OpenAPI2DereferenceVisitor({
-          reference,
-          indirections: [...this.indirections],
-          options: this.options,
-          refractCache: this.refractCache,
-          visited: this.visited,
-          ancestors: ancestorsLineage
-        });
-        referencedElement = await traverseAsync(referencedElement, visitor, {
-          mutable: true,
-          skipVisited: 'skip'
-        });
-        directAncestors.delete(referencingElement);
-      }
-
-      /**
-       * Creating a new version of referenced element to avoid modifying the original one.
-       */
-      const mergedElement = cloneShallow(referencedElement);
-      // annotate referenced element with info about original referencing element
-      mergedElement.meta.set('ref-fields', {
-        $ref: toValue(referencingElement.$ref)
       });
-      // annotate fragment with info about origin
-      mergedElement.meta.set('ref-origin', reference.uri);
-      mergedElement.meta.set('ref-type', referencingElement.element);
-
-      /**
-       * Transclude referencing element with merged referenced element.
-       */
-      path.replaceWith(mergedElement);
-      path.skip();
     } catch (error) {
-      const $ref = toValue(referencingElement.$ref);
       this.handleError(`Error while dereferencing Reference Object. Cannot resolve $ref "${$ref}": ${error.message}`, error, referencingElement, '$ref', $ref, path);
-    } finally {
-      if (this.indirections.length > indirectionsSize) this.indirections.pop();
     }
   }
   async PathItemElement(path) {
     const referencingElement = path.node;
-
-    // ignore PathItemElement without $ref field
-    if (!isStringElement(referencingElement.$ref)) {
+    if (this.isTranscluded(referencingElement)) {
+      path.skip();
       return;
     }
 
-    // skip current referencing element as it's already been access
-    if (this.indirections.includes(referencingElement)) {
-      path.skip();
+    // ignore PathItemElement without $ref field
+    if (!isStringElement(referencingElement.$ref)) {
       return;
     }
-    const retrievalURI = this.toBaseURI(toValue(referencingElement.$ref));
+    const $ref = toValue(referencingElement.$ref);
+    const retrievalURI = this.toBaseURI($ref);
     const isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
     const isExternalReference = !isInternalReference;
 
@@ -371,287 +155,139 @@ class OpenAPI2DereferenceVisitor {
       // skip traversing this Path Item element but traverse all it's child elements
       return;
     }
-    const $refBaseURI = url.resolve(retrievalURI, toValue(referencingElement.$ref));
-    const indirectionsSize = this.indirections.length;
+    const $refBaseURI = url.resolve(retrievalURI, $ref);
     try {
-      const reference = await this.toReference(toValue(referencingElement.$ref));
-      this.indirections.push(referencingElement);
+      const reference = await this.toReference($ref);
       const jsonPointer = URIFragmentIdentifier.fromURIReference($refBaseURI);
-
       // possibly non-semantic referenced element
-      let referencedElement = evaluate(reference.value.result, jsonPointer);
-
-      // applying semantics to a referenced element
-      if (!isPathItemElement(referencedElement)) {
-        if (this.refractCache.has(referencedElement)) {
-          referencedElement = this.refractCache.get(referencedElement);
-        } else {
-          const sourceElement = referencedElement;
-          referencedElement = refractPathItem(referencedElement);
-          this.refractCache.set(sourceElement, referencedElement);
-        }
-      }
+      const referencedElement = jsonPointerEvaluate(reference.value.result, jsonPointer);
 
-      // detect direct or indirect reference
+      // detect direct reference
       if (referencingElement === referencedElement) {
         throw new ApiDOMStructuredError('Recursive Path Item Object reference detected', {
-          $ref: toValue(referencingElement.$ref)
-        });
-      }
-
-      // detect maximum depth of dereferencing
-      if (this.indirections.length > this.options.dereference.maxDepth) {
-        throw new MaximumDereferenceDepthError(`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
+          $ref
         });
       }
+      await this.addTransclusion(path, {
+        source: referencedElement,
+        type: 'pathItem',
+        reference,
+        context: undefined
+      }, {
+        toTranscludedElement: (element, target) => {
+          if (!isPathItemElement(target)) return target;
+
+          /**
+           * Creating a new version of Path Item by merging fields from referenced Path Item with referencing one.
+           */
+          const mergedElement = cloneShallow(target);
+          // existing keywords from referencing PathItemElement overrides ones from referenced element
+          element.forEach((value, keyElement, item) => {
+            mergedElement.remove(toValue(keyElement));
+            mergedElement.content.push(item);
+          });
+          mergedElement.remove('$ref');
 
-      // 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 ApiDOMStructuredError('Circular reference detected', {
-            $ref: toValue(referencingElement.$ref)
+          // annotate referenced element with info about original referencing element
+          mergedElement.meta.set('ref-fields', {
+            $ref
           });
-        } else if (this.options.dereference.circular === 'replace') {
-          const refElement = new RefElement($refBaseURI, {
-            type: referencingElement.element,
+          // annotate referenced element with info about origin and type
+          mergedElement.meta.set('ref-origin', reference.uri);
+          mergedElement.meta.set('ref-type', element.element);
+          return mergedElement;
+        },
+        aliasField: '$ref',
+        circular: {
+          uri: $refBaseURI,
+          meta: {
             uri: reference.uri,
-            $ref: toValue(referencingElement.$ref)
-          });
-          const replacer = this.options.dereference.strategyOpts['openapi-2']?.circularReplacer ?? this.options.dereference.circularReplacer;
-          const replacement = replacer(refElement);
-          path.replaceWith(replacement);
-          path.skip();
-          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 Path Item Object 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 || isPathItemElement(referencedElement) && isStringElement(referencedElement.$ref) || shouldDetectCircular && !this.visited.has(referencedElement)) && !ancestorsLineage.includesCycle(referencedElement)) {
-        if (shouldDetectCircular) {
-          this.visited.add(referencedElement);
+            $ref
+          },
+          details: {
+            $ref
+          }
         }
-
-        // append referencing reference to ancestors lineage
-        directAncestors.add(referencingElement);
-        const visitor = new OpenAPI2DereferenceVisitor({
-          reference,
-          indirections: [...this.indirections],
-          options: this.options,
-          refractCache: this.refractCache,
-          visited: this.visited,
-          ancestors: ancestorsLineage
-        });
-        referencedElement = await traverseAsync(referencedElement, visitor, {
-          mutable: true,
-          skipVisited: 'skip'
-        });
-
-        // remove referencing reference from ancestors lineage
-        directAncestors.delete(referencingElement);
-      }
-
-      /**
-       * Creating a new version of Path Item by merging fields from referenced Path Item with referencing one.
-       */
-      if (isPathItemElement(referencedElement)) {
-        const mergedElement = cloneShallow(referencedElement);
-        // existing keywords from referencing PathItemElement overrides ones from referenced element
-        referencingElement.forEach((value, keyElement, item) => {
-          mergedElement.remove(toValue(keyElement));
-          mergedElement.content.push(item);
-        });
-        mergedElement.remove('$ref');
-
-        // annotate referenced element with info about original referencing element
-        mergedElement.meta.set('ref-fields', {
-          $ref: toValue(referencingElement.$ref)
-        });
-        // annotate referenced element with info about origin and type
-        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);
-      return;
+      });
     } catch (error) {
-      const $ref = toValue(referencingElement.$ref);
       this.handleError(`Error while dereferencing Path Item Object. Cannot resolve $ref "${$ref}": ${error.message}`, error, referencingElement, '$ref', $ref, path);
-    } finally {
-      if (this.indirections.length > indirectionsSize) this.indirections.pop();
     }
   }
   async JSONReferenceElement(path) {
     const referencingElement = path.node;
 
-    // ignore Reference Object without a string $ref, e.g. an empty YAML value
-    if (!isStringElement(referencingElement.$ref)) {
-      return;
-    }
+    // the fields of a JSON Reference Object hold no references
+    path.skip();
 
-    // skip current referencing element as it's already been access
-    if (this.indirections.includes(referencingElement)) {
-      path.skip();
+    // ignore JSON Reference Object without a string $ref, e.g. an empty YAML value
+    if (this.isTranscluded(referencingElement) || !isStringElement(referencingElement.$ref)) {
       return;
     }
-    const retrievalURI = this.toBaseURI(toValue(referencingElement.$ref));
+    const $ref = toValue(referencingElement.$ref);
+    const retrievalURI = this.toBaseURI($ref);
     const isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
     const isExternalReference = !isInternalReference;
 
-    // ignore resolving internal JSONReference Objects
+    // ignore resolving internal JSON Reference Objects
     if (!this.options.resolve.internal && isInternalReference) {
-      // skip traversing this JSONReference element and all it's child elements
-      path.skip();
       return;
     }
-    // ignore resolving external JSONReference Objects
+    // ignore resolving external JSON Reference Objects
     if (!this.options.resolve.external && isExternalReference) {
-      // skip traversing this JSONReference element and all it's child elements
-      path.skip();
       return;
     }
-    const $refBaseURI = url.resolve(retrievalURI, toValue(referencingElement.$ref));
-    const indirectionsSize = this.indirections.length;
+    const $refBaseURI = url.resolve(retrievalURI, $ref);
     try {
-      const reference = await this.toReference(toValue(referencingElement.$ref));
-      this.indirections.push(referencingElement);
+      const reference = await this.toReference($ref);
       const jsonPointer = URIFragmentIdentifier.fromURIReference($refBaseURI);
-
       // possibly non-semantic fragment
-      let referencedElement = evaluate(reference.value.result, jsonPointer);
+      const referencedElement = jsonPointerEvaluate(reference.value.result, jsonPointer);
 
-      // applying semantics to a fragment
-      const referencedElementType = referencingElement.meta.get('referenced-element');
-      if (referencedElement.element !== referencedElementType && !isJSONReferenceElement(referencedElement)) {
-        if (this.refractCache.has(referencedElement)) {
-          referencedElement = this.refractCache.get(referencedElement);
-        } else if (isJSONReferenceLikeElement(referencedElement)) {
-          // handling generic indirect references
-          const sourceElement = referencedElement;
-          referencedElement = refractJSONReference(referencedElement);
-          referencedElement.meta.set('referenced-element', referencedElementType);
-          this.refractCache.set(sourceElement, referencedElement);
-        } else {
-          // handling direct references
-          const sourceElement = referencedElement;
-          referencedElement = refract(referencedElement, {
-            element: referencedElementType
-          });
-          this.refractCache.set(sourceElement, referencedElement);
-        }
-      }
-
-      // detect direct or indirect reference
+      // detect direct reference
       if (referencingElement === referencedElement) {
         throw new ApiDOMStructuredError('Recursive JSON Reference Object detected', {
-          $ref: toValue(referencingElement.$ref)
-        });
-      }
-
-      // detect maximum depth of dereferencing
-      if (this.indirections.length > this.options.dereference.maxDepth) {
-        throw new MaximumDereferenceDepthError(`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
+          $ref
         });
       }
 
-      // 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 ApiDOMStructuredError('Circular reference detected', {
-            $ref: toValue(referencingElement.$ref)
+      // a reference without an expected type reads its target as its own type
+      const type = toValue(referencingElement.meta.get('referenced-element')) ?? referencedElement.element;
+      await this.addTransclusion(path, {
+        source: referencedElement,
+        type,
+        reference,
+        context: undefined
+      }, {
+        toTranscludedElement: (element, target) => {
+          // a chain of JSON Reference Objects leading back to itself never reaches a value
+          if (isJSONReferenceElement(target)) return element;
+
+          /**
+           * Creating a new version of referenced element to avoid modifying the original one.
+           */
+          const mergedElement = cloneShallow(target);
+          // annotate referenced element with info about original referencing element
+          mergedElement.meta.set('ref-fields', {
+            $ref
           });
-        } else if (this.options.dereference.circular === 'replace') {
-          const refElement = new RefElement($refBaseURI, {
-            type: referencingElement.element,
+          // annotate fragment with info about origin
+          mergedElement.meta.set('ref-origin', reference.uri);
+          mergedElement.meta.set('ref-type', element.element);
+          return mergedElement;
+        },
+        circular: {
+          uri: $refBaseURI,
+          meta: {
             uri: reference.uri,
-            $ref: toValue(referencingElement.$ref)
-          });
-          const replacer = this.options.dereference.strategyOpts['openapi-2']?.circularReplacer ?? this.options.dereference.circularReplacer;
-          const replacement = replacer(refElement);
-          path.replaceWith(replacement);
-          path.skip();
-          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 Reference Object. 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 || isJSONReferenceElement(referencedElement) || shouldDetectCircular && !this.visited.has(referencedElement)) && !ancestorsLineage.includesCycle(referencedElement)) {
-        if (shouldDetectCircular) {
-          this.visited.add(referencedElement);
+            $ref
+          },
+          details: {
+            $ref
+          }
         }
-
-        // append referencing reference to ancestors lineage
-        directAncestors.add(referencingElement);
-        const visitor = new OpenAPI2DereferenceVisitor({
-          reference,
-          indirections: [...this.indirections],
-          options: this.options,
-          refractCache: this.refractCache,
-          visited: this.visited,
-          ancestors: ancestorsLineage
-        });
-        referencedElement = await traverseAsync(referencedElement, visitor, {
-          mutable: true,
-          skipVisited: 'skip'
-        });
-
-        // remove referencing reference from ancestors lineage
-        directAncestors.delete(referencingElement);
-      }
-
-      /**
-       * Creating a new version of referenced element to avoid modifying the original one.
-       */
-      const mergedElement = cloneShallow(referencedElement);
-      // annotate referenced element with info about original referencing element
-      mergedElement.meta.set('ref-fields', {
-        $ref: toValue(referencingElement.$ref)
       });
-      // annotate fragment with info about origin
-      mergedElement.meta.set('ref-origin', reference.uri);
-      mergedElement.meta.set('ref-type', referencingElement.element);
-
-      /**
-       * Transclude referencing element with merged referenced element.
-       */
-      path.replaceWith(mergedElement);
-      path.skip();
     } catch (error) {
-      const $ref = toValue(referencingElement.$ref);
       this.handleError(`Error while dereferencing JSON Reference Object. Cannot resolve $ref "${$ref}": ${error.message}`, error, referencingElement, '$ref', $ref, path);
-    } finally {
-      if (this.indirections.length > indirectionsSize) this.indirections.pop();
     }
   }
 }