@speclynx/apidom-reference 1.12.1 → 2.0.1

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

@@ -3,11 +3,13 @@
 var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 exports.__esModule = true;
-exports.mutationReplacer = exports.default = void 0;
+exports.default = void 0;
 var _ramda = require("ramda");
 var _ramdaAdjunct = require("ramda-adjunct");
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
 var _apidomCore = require("@speclynx/apidom-core");
 var _apidomError = require("@speclynx/apidom-error");
+var _apidomTraverse = require("@speclynx/apidom-traverse");
 var _apidomJsonPointer = require("@speclynx/apidom-json-pointer");
 var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-3-0");
 var _MaximumDereferenceDepthError = _interopRequireDefault(require("../../../errors/MaximumDereferenceDepthError.cjs"));
@@ -16,28 +18,13 @@ var url = _interopRequireWildcard(require("../../../util/url.cjs"));
 var _index = _interopRequireDefault(require("../../../parse/index.cjs"));
 var _Reference = _interopRequireDefault(require("../../../Reference.cjs"));
 var _util = require("../../util.cjs");
-// @ts-ignore
-const visitAsync = _apidomCore.visit[Symbol.for('nodejs.util.promisify.custom')];
-
 // initialize element identity manager
 const identityManager = new _apidomCore.IdentityManager();
 
 /**
- * Custom mutation replacer.
  * @public
  */
-const mutationReplacer = (newElement, oldElement, key, parent) => {
-  if ((0, _apidomCore.isMemberElement)(parent)) {
-    parent.value = newElement;
-  } else if (Array.isArray(parent)) {
-    parent[key] = newElement;
-  }
-};
 
-/**
- * @public
- */
-exports.mutationReplacer = mutationReplacer;
 /**
  * @public
  */
@@ -91,7 +78,7 @@ class OpenAPI3_0DereferenceVisitor {
     // register new mutable reference with a refSet
     const mutableReference = new _Reference.default({
       uri: baseURI,
-      value: (0, _apidomCore.cloneDeep)(parseResult),
+      value: (0, _apidomDatamodel.cloneDeep)(parseResult),
       depth: this.reference.depth + 1
     });
     refSet.add(mutableReference);
@@ -106,21 +93,25 @@ class OpenAPI3_0DereferenceVisitor {
     }
     return mutableReference;
   }
-  toAncestorLineage(ancestors) {
+  toAncestorLineage(path) {
     /**
      * Compute full ancestors lineage.
      * Ancestors are flatten to unwrap all Element instances.
      */
-    const directAncestors = new Set(ancestors.filter(_apidomCore.isElement));
+    const ancestorNodes = path.getAncestorNodes();
+    const directAncestors = new Set(ancestorNodes.filter(_apidomDatamodel.isElement));
     const ancestorsLineage = new _util.AncestorLineage(...this.ancestors, directAncestors);
     return [ancestorsLineage, directAncestors];
   }
-  async ReferenceElement(referencingElement, key, parent, path, ancestors, link) {
+  async ReferenceElement(path) {
+    const referencingElement = path.node;
+
     // skip current referencing element as it's already been access
     if (this.indirections.includes(referencingElement)) {
-      return false;
+      path.skip();
+      return;
     }
-    const [ancestorsLineage, directAncestors] = this.toAncestorLineage([...ancestors, parent]);
+    const [ancestorsLineage, directAncestors] = this.toAncestorLineage(path);
     const retrievalURI = this.toBaseURI((0, _apidomCore.toValue)(referencingElement.$ref));
     const isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
     const isExternalReference = !isInternalReference;
@@ -128,12 +119,14 @@ class OpenAPI3_0DereferenceVisitor {
     // ignore resolving internal Reference Objects
     if (!this.options.resolve.internal && isInternalReference) {
       // skip traversing this reference element
-      return false;
+      path.skip();
+      return;
     }
     // ignore resolving external Reference Objects
     if (!this.options.resolve.external && isExternalReference) {
       // skip traversing this reference element
-      return false;
+      path.skip();
+      return;
     }
     const reference = await this.toReference((0, _apidomCore.toValue)(referencingElement.$ref));
     const $refBaseURI = url.resolve(retrievalURI, (0, _apidomCore.toValue)(referencingElement.$ref));
@@ -147,20 +140,21 @@ class OpenAPI3_0DereferenceVisitor {
     /**
      * Applying semantics to a referenced element if semantics are missing.
      */
-    if ((0, _apidomCore.isPrimitiveElement)(referencedElement)) {
+    if ((0, _apidomDatamodel.isPrimitiveElement)(referencedElement)) {
       const referencedElementType = (0, _apidomCore.toValue)(referencingElement.meta.get('referenced-element'));
       const cacheKey = `${referencedElementType}-${(0, _apidomCore.toValue)(identityManager.identify(referencedElement))}`;
       if (this.refractCache.has(cacheKey)) {
         referencedElement = this.refractCache.get(cacheKey);
       } else if ((0, _apidomNsOpenapi.isReferenceLikeElement)(referencedElement)) {
         // handling indirect references
-        referencedElement = _apidomNsOpenapi.ReferenceElement.refract(referencedElement);
-        referencedElement.setMetaProperty('referenced-element', referencedElementType);
+        referencedElement = (0, _apidomNsOpenapi.refractReference)(referencedElement);
+        referencedElement.meta.set('referenced-element', referencedElementType);
         this.refractCache.set(cacheKey, referencedElement);
       } else {
         // handling direct references
-        const ElementClass = this.namespace.getElementClass(referencedElementType);
-        referencedElement = ElementClass.refract(referencedElement);
+        referencedElement = (0, _apidomNsOpenapi.refract)(referencedElement, {
+          element: referencedElementType
+        });
         this.refractCache.set(cacheKey, referencedElement);
       }
     }
@@ -181,15 +175,16 @@ class OpenAPI3_0DereferenceVisitor {
       if (this.options.dereference.circular === 'error') {
         throw new _apidomError.ApiDOMError('Circular reference detected');
       } else if (this.options.dereference.circular === 'replace') {
-        const refElement = new _apidomCore.RefElement(referencedElement.id, {
+        const refElement = new _apidomDatamodel.RefElement(referencedElement.id, {
           type: 'reference',
           uri: reference.uri,
           $ref: (0, _apidomCore.toValue)(referencingElement.$ref)
         });
         const replacer = this.options.dereference.strategyOpts['openapi-3-0']?.circularReplacer ?? this.options.dereference.circularReplacer;
         const replacement = replacer(refElement);
-        link.replaceWith(replacement, mutationReplacer);
-        return !parent ? replacement : false;
+        this.indirections.pop();
+        path.replaceWith(replacement);
+        return;
       }
     }
 
@@ -215,9 +210,8 @@ class OpenAPI3_0DereferenceVisitor {
         refractCache: this.refractCache,
         ancestors: ancestorsLineage
       });
-      referencedElement = await visitAsync(referencedElement, visitor, {
-        keyMap: _apidomNsOpenapi.keyMap,
-        nodeTypeGetter: _apidomNsOpenapi.getNodeType
+      referencedElement = await (0, _apidomTraverse.traverseAsync)(referencedElement, visitor, {
+        mutable: true
       });
 
       // remove referencing reference from ancestors lineage
@@ -228,39 +222,37 @@ class OpenAPI3_0DereferenceVisitor {
     /**
      * Creating a new version of referenced element to avoid modifying the original one.
      */
-    const mergedElement = (0, _apidomCore.cloneShallow)(referencedElement);
+    const mergedElement = (0, _apidomDatamodel.cloneShallow)(referencedElement);
     // assign unique id to merged element
-    mergedElement.setMetaProperty('id', identityManager.generateId());
+    mergedElement.meta.set('id', identityManager.generateId());
     // annotate referenced element with info about original referencing element
-    mergedElement.setMetaProperty('ref-fields', {
+    mergedElement.meta.set('ref-fields', {
       $ref: (0, _apidomCore.toValue)(referencingElement.$ref)
     });
     // annotate fragment with info about origin
-    mergedElement.setMetaProperty('ref-origin', reference.uri);
+    mergedElement.meta.set('ref-origin', reference.uri);
     // annotate fragment with info about referencing element
-    mergedElement.setMetaProperty('ref-referencing-element-id', (0, _apidomCore.cloneDeep)(identityManager.identify(referencingElement)));
+    mergedElement.meta.set('ref-referencing-element-id', (0, _apidomDatamodel.cloneDeep)(identityManager.identify(referencingElement)));
 
     /**
      * Transclude referencing element with merged referenced element.
      */
-    link.replaceWith(mergedElement, mutationReplacer);
-
-    /**
-     * We're at the root of the tree, so we're just replacing the entire tree.
-     */
-    return !parent ? mergedElement : false;
+    path.replaceWith(mergedElement);
   }
-  async PathItemElement(referencingElement, key, parent, path, ancestors, link) {
+  async PathItemElement(path) {
+    const referencingElement = path.node;
+
     // ignore PathItemElement without $ref field
-    if (!(0, _apidomCore.isStringElement)(referencingElement.$ref)) {
-      return undefined;
+    if (!(0, _apidomDatamodel.isStringElement)(referencingElement.$ref)) {
+      return;
     }
 
     // skip current referencing element as it's already been access
     if (this.indirections.includes(referencingElement)) {
-      return false;
+      path.skip();
+      return;
     }
-    const [ancestorsLineage, directAncestors] = this.toAncestorLineage([...ancestors, parent]);
+    const [ancestorsLineage, directAncestors] = this.toAncestorLineage(path);
     const retrievalURI = this.toBaseURI((0, _apidomCore.toValue)(referencingElement.$ref));
     const isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
     const isExternalReference = !isInternalReference;
@@ -268,12 +260,12 @@ class OpenAPI3_0DereferenceVisitor {
     // ignore resolving internal Path Item Objects
     if (!this.options.resolve.internal && isInternalReference) {
       // skip traversing this Path Item element but traverse all it's child elements
-      return undefined;
+      return;
     }
     // ignore resolving external Path Item Objects
     if (!this.options.resolve.external && isExternalReference) {
       // skip traversing this Path Item element but traverse all it's child elements
-      return undefined;
+      return;
     }
     const reference = await this.toReference((0, _apidomCore.toValue)(referencingElement.$ref));
     const $refBaseURI = url.resolve(retrievalURI, (0, _apidomCore.toValue)(referencingElement.$ref));
@@ -292,7 +284,7 @@ class OpenAPI3_0DereferenceVisitor {
       if (this.refractCache.has(cacheKey)) {
         referencedElement = this.refractCache.get(cacheKey);
       } else {
-        referencedElement = _apidomNsOpenapi.PathItemElement.refract(referencedElement);
+        referencedElement = (0, _apidomNsOpenapi.refractPathItem)(referencedElement);
         this.refractCache.set(cacheKey, referencedElement);
       }
     }
@@ -313,15 +305,16 @@ class OpenAPI3_0DereferenceVisitor {
       if (this.options.dereference.circular === 'error') {
         throw new _apidomError.ApiDOMError('Circular reference detected');
       } else if (this.options.dereference.circular === 'replace') {
-        const refElement = new _apidomCore.RefElement(referencedElement.id, {
+        const refElement = new _apidomDatamodel.RefElement(referencedElement.id, {
           type: 'path-item',
           uri: reference.uri,
           $ref: (0, _apidomCore.toValue)(referencingElement.$ref)
         });
         const replacer = this.options.dereference.strategyOpts['openapi-3-0']?.circularReplacer ?? this.options.dereference.circularReplacer;
         const replacement = replacer(refElement);
-        link.replaceWith(replacement, mutationReplacer);
-        return !parent ? replacement : undefined;
+        this.indirections.pop();
+        path.replaceWith(replacement);
+        return;
       }
     }
 
@@ -336,7 +329,7 @@ class OpenAPI3_0DereferenceVisitor {
      */
     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, _apidomCore.isStringElement)(referencedElement.$ref) || shouldDetectCircular) && !ancestorsLineage.includesCycle(referencedElement)) {
+    if ((isExternalReference || isNonEntryDocument || (0, _apidomNsOpenapi.isPathItemElement)(referencedElement) && (0, _apidomDatamodel.isStringElement)(referencedElement.$ref) || shouldDetectCircular) && !ancestorsLineage.includesCycle(referencedElement)) {
       // append referencing reference to ancestors lineage
       directAncestors.add(referencingElement);
       const visitor = new OpenAPI3_0DereferenceVisitor({
@@ -347,9 +340,8 @@ class OpenAPI3_0DereferenceVisitor {
         refractCache: this.refractCache,
         ancestors: ancestorsLineage
       });
-      referencedElement = await visitAsync(referencedElement, visitor, {
-        keyMap: _apidomNsOpenapi.keyMap,
-        nodeTypeGetter: _apidomNsOpenapi.getNodeType
+      referencedElement = await (0, _apidomTraverse.traverseAsync)(referencedElement, visitor, {
+        mutable: true
       });
 
       // remove referencing reference from ancestors lineage
@@ -361,9 +353,9 @@ class OpenAPI3_0DereferenceVisitor {
      * Creating a new version of Path Item by merging fields from referenced Path Item with referencing one.
      */
     if ((0, _apidomNsOpenapi.isPathItemElement)(referencedElement)) {
-      const mergedElement = new _apidomNsOpenapi.PathItemElement([...referencedElement.content], (0, _apidomCore.cloneDeep)(referencedElement.meta), (0, _apidomCore.cloneDeep)(referencedElement.attributes));
+      const mergedElement = (0, _apidomDatamodel.cloneShallow)(referencedElement);
       // assign unique id to merged element
-      mergedElement.setMetaProperty('id', identityManager.generateId());
+      mergedElement.meta.set('id', identityManager.generateId());
       // existing keywords from referencing PathItemElement overrides ones from referenced element
       referencingElement.forEach((value, keyElement, item) => {
         mergedElement.remove((0, _apidomCore.toValue)(keyElement));
@@ -372,38 +364,35 @@ class OpenAPI3_0DereferenceVisitor {
       mergedElement.remove('$ref');
 
       // annotate referenced element with info about original referencing element
-      mergedElement.setMetaProperty('ref-fields', {
+      mergedElement.meta.set('ref-fields', {
         $ref: (0, _apidomCore.toValue)(referencingElement.$ref)
       });
       // annotate referenced element with info about origin
-      mergedElement.setMetaProperty('ref-origin', reference.uri);
+      mergedElement.meta.set('ref-origin', reference.uri);
       // annotate fragment with info about referencing element
-      mergedElement.setMetaProperty('ref-referencing-element-id', (0, _apidomCore.cloneDeep)(identityManager.identify(referencingElement)));
+      mergedElement.meta.set('ref-referencing-element-id', (0, _apidomDatamodel.cloneDeep)(identityManager.identify(referencingElement)));
       referencedElement = mergedElement;
     }
 
     /**
      * Transclude referencing element with merged referenced element.
      */
-    link.replaceWith(referencedElement, mutationReplacer);
-
-    /**
-     * We're at the root of the tree, so we're just replacing the entire tree.
-     */
-    return !parent ? referencedElement : undefined;
+    path.replaceWith(referencedElement);
   }
-  async LinkElement(linkElement, key, parent, path, ancestors, link) {
+  async LinkElement(path) {
+    const linkElement = path.node;
+
     // ignore LinkElement without operationRef or operationId field
-    if (!(0, _apidomCore.isStringElement)(linkElement.operationRef) && !(0, _apidomCore.isStringElement)(linkElement.operationId)) {
-      return undefined;
+    if (!(0, _apidomDatamodel.isStringElement)(linkElement.operationRef) && !(0, _apidomDatamodel.isStringElement)(linkElement.operationId)) {
+      return;
     }
 
     // operationRef and operationId fields are mutually exclusive
-    if ((0, _apidomCore.isStringElement)(linkElement.operationRef) && (0, _apidomCore.isStringElement)(linkElement.operationId)) {
+    if ((0, _apidomDatamodel.isStringElement)(linkElement.operationRef) && (0, _apidomDatamodel.isStringElement)(linkElement.operationId)) {
       throw new _apidomError.ApiDOMError('LinkElement operationRef and operationId fields are mutually exclusive.');
     }
     let operationElement;
-    if ((0, _apidomCore.isStringElement)(linkElement.operationRef)) {
+    if ((0, _apidomDatamodel.isStringElement)(linkElement.operationRef)) {
       // possibly non-semantic referenced element
       const jsonPointer = _apidomJsonPointer.URIFragmentIdentifier.fromURIReference((0, _apidomCore.toValue)(linkElement.operationRef));
       const retrievalURI = this.toBaseURI((0, _apidomCore.toValue)(linkElement.operationRef));
@@ -413,73 +402,66 @@ class OpenAPI3_0DereferenceVisitor {
       // ignore resolving internal Operation Object reference
       if (!this.options.resolve.internal && isInternalReference) {
         // skip traversing this Link element but traverse all it's child elements
-        return undefined;
+        return;
       }
       // ignore resolving external Operation Object reference
       if (!this.options.resolve.external && isExternalReference) {
         // skip traversing this Link element but traverse all it's child elements
-        return undefined;
+        return;
       }
       const reference = await this.toReference((0, _apidomCore.toValue)(linkElement.operationRef));
       operationElement = (0, _apidomJsonPointer.evaluate)(reference.value.result, jsonPointer);
       // applying semantics to a referenced element
-      if ((0, _apidomCore.isPrimitiveElement)(operationElement)) {
+      if ((0, _apidomDatamodel.isPrimitiveElement)(operationElement)) {
         const cacheKey = `operation-${(0, _apidomCore.toValue)(identityManager.identify(operationElement))}`;
         if (this.refractCache.has(cacheKey)) {
           operationElement = this.refractCache.get(cacheKey);
         } else {
-          operationElement = _apidomNsOpenapi.OperationElement.refract(operationElement);
+          operationElement = (0, _apidomNsOpenapi.refractOperation)(operationElement);
           this.refractCache.set(cacheKey, operationElement);
         }
       }
       // create shallow clone to be able to annotate with metadata
-      operationElement = (0, _apidomCore.cloneShallow)(operationElement);
+      operationElement = (0, _apidomDatamodel.cloneShallow)(operationElement);
       // annotate operation element with info about origin
-      operationElement.setMetaProperty('ref-origin', reference.uri);
-      const linkElementCopy = (0, _apidomCore.cloneShallow)(linkElement);
+      operationElement.meta.set('ref-origin', reference.uri);
+      const linkElementCopy = (0, _apidomDatamodel.cloneShallow)(linkElement);
       linkElementCopy.operationRef?.meta.set('operation', operationElement);
 
       /**
        * Transclude Link Object containing Operation Object in its meta.
        */
-      link.replaceWith(linkElementCopy, mutationReplacer);
-
-      /**
-       * We're at the root of the tree, so we're just replacing the entire tree.
-       */
-      return !parent ? linkElementCopy : undefined;
+      path.replaceWith(linkElementCopy);
+      return;
     }
-    if ((0, _apidomCore.isStringElement)(linkElement.operationId)) {
+    if ((0, _apidomDatamodel.isStringElement)(linkElement.operationId)) {
       const operationId = (0, _apidomCore.toValue)(linkElement.operationId);
       const reference = await this.toReference(url.unsanitize(this.reference.uri));
-      operationElement = (0, _apidomCore.find)(e => (0, _apidomNsOpenapi.isOperationElement)(e) && (0, _apidomCore.isElement)(e.operationId) && e.operationId.equals(operationId), reference.value.result);
+      operationElement = (0, _apidomTraverse.find)(reference.value.result, e => (0, _apidomNsOpenapi.isOperationElement)(e) && (0, _apidomDatamodel.isElement)(e.operationId) && e.operationId.equals(operationId));
       // OperationElement not found by its operationId
       if ((0, _ramdaAdjunct.isUndefined)(operationElement)) {
         throw new _apidomError.ApiDOMError(`OperationElement(operationId=${operationId}) not found.`);
       }
-      const linkElementCopy = (0, _apidomCore.cloneShallow)(linkElement);
+      const linkElementCopy = (0, _apidomDatamodel.cloneShallow)(linkElement);
       linkElementCopy.operationId?.meta.set('operation', operationElement);
 
       /**
        * Transclude Link Object containing Operation Object in its meta.
        */
-      link.replaceWith(linkElementCopy, mutationReplacer);
-
-      /**
-       * We're at the root of the tree, so we're just replacing the entire tree.
-       */
-      return !parent ? linkElementCopy : undefined;
+      path.replaceWith(linkElementCopy);
+      return;
     }
-    return undefined;
   }
-  async ExampleElement(exampleElement, key, parent, path, ancestors, link) {
+  async ExampleElement(path) {
+    const exampleElement = path.node;
+
     // ignore ExampleElement without externalValue field
-    if (!(0, _apidomCore.isStringElement)(exampleElement.externalValue)) {
-      return undefined;
+    if (!(0, _apidomDatamodel.isStringElement)(exampleElement.externalValue)) {
+      return;
     }
 
     // value and externalValue fields are mutually exclusive
-    if (exampleElement.hasKey('value') && (0, _apidomCore.isStringElement)(exampleElement.externalValue)) {
+    if (exampleElement.hasKey('value') && (0, _apidomDatamodel.isStringElement)(exampleElement.externalValue)) {
       throw new _apidomError.ApiDOMError('ExampleElement value and externalValue fields are mutually exclusive.');
     }
     const retrievalURI = this.toBaseURI((0, _apidomCore.toValue)(exampleElement.externalValue));
@@ -489,31 +471,26 @@ class OpenAPI3_0DereferenceVisitor {
     // ignore resolving external Example Objects
     if (!this.options.resolve.internal && isInternalReference) {
       // skip traversing this Example element but traverse all it's child elements
-      return undefined;
+      return;
     }
     // ignore resolving external Example Objects
     if (!this.options.resolve.external && isExternalReference) {
       // skip traversing this Example element but traverse all it's child elements
-      return undefined;
+      return;
     }
     const reference = await this.toReference((0, _apidomCore.toValue)(exampleElement.externalValue));
 
     // shallow clone of the referenced element
-    const valueElement = (0, _apidomCore.cloneShallow)(reference.value.result);
+    const valueElement = (0, _apidomDatamodel.cloneShallow)(reference.value.result);
     // annotate operation element with info about origin
-    valueElement.setMetaProperty('ref-origin', reference.uri);
-    const exampleElementCopy = (0, _apidomCore.cloneShallow)(exampleElement);
+    valueElement.meta.set('ref-origin', reference.uri);
+    const exampleElementCopy = (0, _apidomDatamodel.cloneShallow)(exampleElement);
     exampleElementCopy.value = valueElement;
 
     /**
      * Transclude Example Object containing external value.
      */
-    link.replaceWith(exampleElementCopy, mutationReplacer);
-
-    /**
-     * We're at the root of the tree, so we're just replacing the entire tree.
-     */
-    return !parent ? exampleElementCopy : undefined;
+    path.replaceWith(exampleElementCopy);
   }
 }
 var _default = exports.default = OpenAPI3_0DereferenceVisitor;