@speclynx/apidom-reference 4.7.0 → 4.8.0

package/src/dereference/strategies/openapi-3-1/visitor.cjs

@@ -36,6 +36,7 @@ class OpenAPI3_1DereferenceVisitor {
   reference;
   options;
   refractCache;
+  visited;
 
   /**
    * Tracks element ancestors across dive-deep traversal boundaries.
@@ -48,13 +49,15 @@ class OpenAPI3_1DereferenceVisitor {
     options,
     indirections = [],
     refractCache = new WeakMap(),
-    ancestors = new _util2.AncestorLineage()
+    ancestors = new _util2.AncestorLineage(),
+    visited = new WeakSet()
   }) {
     this.indirections = indirections;
     this.reference = reference;
     this.options = options;
     this.refractCache = refractCache;
     this.ancestors = new _util2.AncestorLineage(...ancestors);
+    this.visited = visited;
   }
   toAncestorLineage(path) {
     const ancestorNodes = path.getAncestorNodes();
@@ -287,6 +290,7 @@ class OpenAPI3_1DereferenceVisitor {
           const replacer = this.options.dereference.strategyOpts['openapi-3-1']?.circularReplacer ?? this.options.dereference.circularReplacer;
           const replacement = replacer(refElement);
           path.replaceWith(replacement);
+          path.skip();
           return;
         }
       }
@@ -302,17 +306,22 @@ class OpenAPI3_1DereferenceVisitor {
        */
       const isNonEntryDocument = url.stripHash(reference.refSet.rootRef.uri) !== reference.uri;
       const shouldDetectCircular = ['error', 'replace'].includes(this.options.dereference.circular);
-      if ((isExternalReference || isNonEntryDocument || (0, _apidomNsOpenapi.isReferenceElement)(referencedElement) || shouldDetectCircular) && !ancestorsLineage.includesCycle(referencedElement)) {
+      if ((isExternalReference || isNonEntryDocument || (0, _apidomNsOpenapi.isReferenceElement)(referencedElement) || shouldDetectCircular && !this.visited.has(referencedElement)) && !ancestorsLineage.includesCycle(referencedElement)) {
+        if (shouldDetectCircular) {
+          this.visited.add(referencedElement);
+        }
         directAncestors.add(referencingElement);
         const visitor = new OpenAPI3_1DereferenceVisitor({
           reference,
           indirections: [...this.indirections],
           options: this.options,
           refractCache: this.refractCache,
+          visited: this.visited,
           ancestors: ancestorsLineage
         });
         referencedElement = await (0, _apidomTraverse.traverseAsync)(referencedElement, visitor, {
-          mutable: true
+          mutable: true,
+          skipVisited: true
         });
         directAncestors.delete(referencingElement);
       }
@@ -439,6 +448,7 @@ class OpenAPI3_1DereferenceVisitor {
           const replacer = this.options.dereference.strategyOpts['openapi-3-1']?.circularReplacer ?? this.options.dereference.circularReplacer;
           const replacement = replacer(refElement);
           path.replaceWith(replacement);
+          path.skip();
           return;
         }
       }
@@ -454,17 +464,22 @@ class OpenAPI3_1DereferenceVisitor {
        */
       const isNonEntryDocument = url.stripHash(reference.refSet.rootRef.uri) !== reference.uri;
       const shouldDetectCircular = ['error', 'replace'].includes(this.options.dereference.circular);
-      if ((isExternalReference || isNonEntryDocument || (0, _apidomNsOpenapi.isPathItemElement)(referencedElement) && (0, _apidomDatamodel.isStringElement)(referencedElement.$ref) || shouldDetectCircular) && !ancestorsLineage.includesCycle(referencedElement)) {
+      if ((isExternalReference || isNonEntryDocument || (0, _apidomNsOpenapi.isPathItemElement)(referencedElement) && (0, _apidomDatamodel.isStringElement)(referencedElement.$ref) || shouldDetectCircular && !this.visited.has(referencedElement)) && !ancestorsLineage.includesCycle(referencedElement)) {
+        if (shouldDetectCircular) {
+          this.visited.add(referencedElement);
+        }
         directAncestors.add(referencingElement);
         const visitor = new OpenAPI3_1DereferenceVisitor({
           reference,
           indirections: [...this.indirections],
           options: this.options,
           refractCache: this.refractCache,
+          visited: this.visited,
           ancestors: ancestorsLineage
         });
         referencedElement = await (0, _apidomTraverse.traverseAsync)(referencedElement, visitor, {
-          mutable: true
+          mutable: true,
+          skipVisited: true
         });
         directAncestors.delete(referencingElement);
       }
@@ -795,6 +810,7 @@ class OpenAPI3_1DereferenceVisitor {
           const replacer = this.options.dereference.strategyOpts['openapi-3-1']?.circularReplacer ?? this.options.dereference.circularReplacer;
           const replacement = replacer(refElement);
           path.replaceWith(replacement);
+          path.skip();
           return;
         }
       }
@@ -810,17 +826,22 @@ class OpenAPI3_1DereferenceVisitor {
        */
       const isNonEntryDocument = url.stripHash(reference.refSet.rootRef.uri) !== reference.uri;
       const shouldDetectCircular = ['error', 'replace'].includes(this.options.dereference.circular);
-      if ((isExternalReference || isNonEntryDocument || (0, _apidomNsOpenapi.isSchemaElement)(referencedElement) && (0, _apidomDatamodel.isStringElement)(referencedElement.$ref) || shouldDetectCircular) && !ancestorsLineage.includesCycle(referencedElement)) {
+      if ((isExternalReference || isNonEntryDocument || (0, _apidomNsOpenapi.isSchemaElement)(referencedElement) && (0, _apidomDatamodel.isStringElement)(referencedElement.$ref) || shouldDetectCircular && !this.visited.has(referencedElement)) && !ancestorsLineage.includesCycle(referencedElement)) {
+        if (shouldDetectCircular) {
+          this.visited.add(referencedElement);
+        }
         directAncestors.add(referencingElement);
         const visitor = new OpenAPI3_1DereferenceVisitor({
           reference,
           indirections: [...this.indirections],
           options: this.options,
           refractCache: this.refractCache,
+          visited: this.visited,
           ancestors: ancestorsLineage
         });
         referencedElement = await (0, _apidomTraverse.traverseAsync)(referencedElement, visitor, {
-          mutable: true
+          mutable: true,
+          skipVisited: true
         });
         directAncestors.delete(referencingElement);
       }
@@ -836,6 +857,7 @@ class OpenAPI3_1DereferenceVisitor {
         booleanJsonSchemaElement.meta.set('ref-origin', reference.uri);
         booleanJsonSchemaElement.meta.set('ref-type', referencingElement.element);
         path.replaceWith(booleanJsonSchemaElement);
+        path.skip();
         return;
       }
 

package/src/dereference/strategies/openapi-3-1/visitor.mjs

@@ -29,6 +29,7 @@ class OpenAPI3_1DereferenceVisitor {
   reference;
   options;
   refractCache;
+  visited;
 
   /**
    * Tracks element ancestors across dive-deep traversal boundaries.
@@ -41,13 +42,15 @@ class OpenAPI3_1DereferenceVisitor {
     options,
     indirections = [],
     refractCache = new WeakMap(),
-    ancestors = new AncestorLineage()
+    ancestors = new AncestorLineage(),
+    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();
@@ -280,6 +283,7 @@ class OpenAPI3_1DereferenceVisitor {
           const replacer = this.options.dereference.strategyOpts['openapi-3-1']?.circularReplacer ?? this.options.dereference.circularReplacer;
           const replacement = replacer(refElement);
           path.replaceWith(replacement);
+          path.skip();
           return;
         }
       }
@@ -295,17 +299,22 @@ class OpenAPI3_1DereferenceVisitor {
        */
       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) && !ancestorsLineage.includesCycle(referencedElement)) {
+      if ((isExternalReference || isNonEntryDocument || isReferenceElement(referencedElement) || shouldDetectCircular && !this.visited.has(referencedElement)) && !ancestorsLineage.includesCycle(referencedElement)) {
+        if (shouldDetectCircular) {
+          this.visited.add(referencedElement);
+        }
         directAncestors.add(referencingElement);
         const visitor = new OpenAPI3_1DereferenceVisitor({
           reference,
           indirections: [...this.indirections],
           options: this.options,
           refractCache: this.refractCache,
+          visited: this.visited,
           ancestors: ancestorsLineage
         });
         referencedElement = await traverseAsync(referencedElement, visitor, {
-          mutable: true
+          mutable: true,
+          skipVisited: true
         });
         directAncestors.delete(referencingElement);
       }
@@ -432,6 +441,7 @@ class OpenAPI3_1DereferenceVisitor {
           const replacer = this.options.dereference.strategyOpts['openapi-3-1']?.circularReplacer ?? this.options.dereference.circularReplacer;
           const replacement = replacer(refElement);
           path.replaceWith(replacement);
+          path.skip();
           return;
         }
       }
@@ -447,17 +457,22 @@ class OpenAPI3_1DereferenceVisitor {
        */
       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) && !ancestorsLineage.includesCycle(referencedElement)) {
+      if ((isExternalReference || isNonEntryDocument || isPathItemElement(referencedElement) && isStringElement(referencedElement.$ref) || shouldDetectCircular && !this.visited.has(referencedElement)) && !ancestorsLineage.includesCycle(referencedElement)) {
+        if (shouldDetectCircular) {
+          this.visited.add(referencedElement);
+        }
         directAncestors.add(referencingElement);
         const visitor = new OpenAPI3_1DereferenceVisitor({
           reference,
           indirections: [...this.indirections],
           options: this.options,
           refractCache: this.refractCache,
+          visited: this.visited,
           ancestors: ancestorsLineage
         });
         referencedElement = await traverseAsync(referencedElement, visitor, {
-          mutable: true
+          mutable: true,
+          skipVisited: true
         });
         directAncestors.delete(referencingElement);
       }
@@ -788,6 +803,7 @@ class OpenAPI3_1DereferenceVisitor {
           const replacer = this.options.dereference.strategyOpts['openapi-3-1']?.circularReplacer ?? this.options.dereference.circularReplacer;
           const replacement = replacer(refElement);
           path.replaceWith(replacement);
+          path.skip();
           return;
         }
       }
@@ -803,17 +819,22 @@ class OpenAPI3_1DereferenceVisitor {
        */
       const isNonEntryDocument = url.stripHash(reference.refSet.rootRef.uri) !== reference.uri;
       const shouldDetectCircular = ['error', 'replace'].includes(this.options.dereference.circular);
-      if ((isExternalReference || isNonEntryDocument || isSchemaElement(referencedElement) && isStringElement(referencedElement.$ref) || shouldDetectCircular) && !ancestorsLineage.includesCycle(referencedElement)) {
+      if ((isExternalReference || isNonEntryDocument || isSchemaElement(referencedElement) && isStringElement(referencedElement.$ref) || shouldDetectCircular && !this.visited.has(referencedElement)) && !ancestorsLineage.includesCycle(referencedElement)) {
+        if (shouldDetectCircular) {
+          this.visited.add(referencedElement);
+        }
         directAncestors.add(referencingElement);
         const visitor = new OpenAPI3_1DereferenceVisitor({
           reference,
           indirections: [...this.indirections],
           options: this.options,
           refractCache: this.refractCache,
+          visited: this.visited,
           ancestors: ancestorsLineage
         });
         referencedElement = await traverseAsync(referencedElement, visitor, {
-          mutable: true
+          mutable: true,
+          skipVisited: true
         });
         directAncestors.delete(referencingElement);
       }
@@ -829,6 +850,7 @@ class OpenAPI3_1DereferenceVisitor {
         booleanJsonSchemaElement.meta.set('ref-origin', reference.uri);
         booleanJsonSchemaElement.meta.set('ref-type', referencingElement.element);
         path.replaceWith(booleanJsonSchemaElement);
+        path.skip();
         return;
       }
 

package/types/dereference/strategies/arazzo-1/visitor.d.ts

@@ -11,6 +11,7 @@ export interface Arazzo1DereferenceVisitorOptions {
     readonly options: ReferenceOptions;
     readonly indirections?: Element[];
     readonly ancestors?: AncestorLineage<Element>;
+    readonly visited?: WeakSet<Element>;
 }
 /**
  * @public
@@ -19,13 +20,14 @@ declare class Arazzo1DereferenceVisitor {
     protected readonly indirections: Element[];
     protected readonly reference: Reference;
     protected readonly options: ReferenceOptions;
+    protected readonly visited: WeakSet<Element>;
     /**
      * 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.
      */
     protected readonly ancestors: AncestorLineage<Element>;
-    constructor({ reference, options, indirections, ancestors, }: Arazzo1DereferenceVisitorOptions);
+    constructor({ reference, options, indirections, ancestors, visited, }: Arazzo1DereferenceVisitorOptions);
     protected toAncestorLineage(path: Path<Element>): [AncestorLineage<Element>, Set<Element>];
     protected toBaseURI(uri: string): string;
     protected toReference(uri: string): Promise<Reference>;

package/types/dereference/strategies/asyncapi-2/visitor.d.ts

@@ -12,6 +12,7 @@ export interface AsyncAPI2DereferenceVisitorOptions {
     readonly indirections?: Element[];
     readonly refractCache?: WeakMap<Element, Element>;
     readonly ancestors?: AncestorLineage<Element>;
+    readonly visited?: WeakSet<Element>;
 }
 /**
  * @public
@@ -21,13 +22,14 @@ declare class AsyncAPI2DereferenceVisitor {
     protected readonly reference: Reference;
     protected readonly options: ReferenceOptions;
     protected readonly refractCache: WeakMap<Element, Element>;
+    protected readonly visited: WeakSet<Element>;
     /**
      * 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.
      */
     protected readonly ancestors: AncestorLineage<Element>;
-    constructor({ reference, options, indirections, ancestors, refractCache, }: AsyncAPI2DereferenceVisitorOptions);
+    constructor({ reference, options, indirections, ancestors, refractCache, visited, }: AsyncAPI2DereferenceVisitorOptions);
     protected toAncestorLineage(path: Path<Element>): [AncestorLineage<Element>, Set<Element>];
     protected toBaseURI(uri: string): string;
     protected toReference(uri: string): Promise<Reference>;

package/types/dereference/strategies/openapi-2/visitor.d.ts

@@ -12,6 +12,7 @@ export interface OpenAPI2DereferenceVisitorOptions {
     readonly indirections?: Element[];
     readonly refractCache?: WeakMap<Element, Element>;
     readonly ancestors?: AncestorLineage<Element>;
+    readonly visited?: WeakSet<Element>;
 }
 /**
  * @public
@@ -21,13 +22,14 @@ declare class OpenAPI2DereferenceVisitor {
     protected readonly reference: Reference;
     protected readonly options: ReferenceOptions;
     protected readonly refractCache: WeakMap<Element, Element>;
+    protected readonly visited: WeakSet<Element>;
     /**
      * 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.
      */
     protected readonly ancestors: AncestorLineage<Element>;
-    constructor({ reference, options, indirections, ancestors, refractCache, }: OpenAPI2DereferenceVisitorOptions);
+    constructor({ reference, options, indirections, ancestors, refractCache, visited, }: OpenAPI2DereferenceVisitorOptions);
     protected toAncestorLineage(path: Path<Element>): [AncestorLineage<Element>, Set<Element>];
     protected toBaseURI(uri: string): string;
     protected toReference(uri: string): Promise<Reference>;

package/types/dereference/strategies/openapi-3-0/visitor.d.ts

@@ -12,6 +12,7 @@ export interface OpenAPI3_0DereferenceVisitorOptions {
     readonly indirections?: Element[];
     readonly refractCache?: WeakMap<Element, Element>;
     readonly ancestors?: AncestorLineage<Element>;
+    readonly visited?: WeakSet<Element>;
 }
 /**
  * @public
@@ -21,13 +22,14 @@ declare class OpenAPI3_0DereferenceVisitor {
     protected readonly reference: Reference;
     protected readonly options: ReferenceOptions;
     protected readonly refractCache: WeakMap<Element, Element>;
+    protected readonly visited: WeakSet<Element>;
     /**
      * 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.
      */
     protected readonly ancestors: AncestorLineage<Element>;
-    constructor({ reference, options, indirections, ancestors, refractCache, }: OpenAPI3_0DereferenceVisitorOptions);
+    constructor({ reference, options, indirections, ancestors, refractCache, visited, }: OpenAPI3_0DereferenceVisitorOptions);
     protected toAncestorLineage(path: Path<Element>): [AncestorLineage<Element>, Set<Element>];
     protected toBaseURI(uri: string): string;
     protected toReference(uri: string): Promise<Reference>;

package/types/dereference/strategies/openapi-3-1/visitor.d.ts

@@ -12,6 +12,7 @@ export interface OpenAPI3_1DereferenceVisitorOptions {
     readonly indirections?: Element[];
     readonly refractCache?: WeakMap<Element, Element>;
     readonly ancestors?: AncestorLineage<Element>;
+    readonly visited?: WeakSet<Element>;
 }
 /**
  * @public
@@ -21,13 +22,14 @@ declare class OpenAPI3_1DereferenceVisitor {
     protected readonly reference: Reference;
     protected readonly options: ReferenceOptions;
     protected readonly refractCache: WeakMap<Element, Element>;
+    protected readonly visited: WeakSet<Element>;
     /**
      * 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.
      */
     protected readonly ancestors: AncestorLineage<Element>;
-    constructor({ reference, options, indirections, refractCache, ancestors, }: OpenAPI3_1DereferenceVisitorOptions);
+    constructor({ reference, options, indirections, refractCache, ancestors, visited, }: OpenAPI3_1DereferenceVisitorOptions);
     protected toAncestorLineage(path: Path<Element>): [AncestorLineage<Element>, Set<Element>];
     protected toBaseURI(uri: string): string;
     protected toReference(uri: string): Promise<Reference>;