@speclynx/apidom-reference 1.12.1 → 2.0.1

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

@@ -1,32 +1,19 @@
 import { propEq } from 'ramda';
-import { RefElement, isPrimitiveElement, isStringElement, isMemberElement, isElement, IdentityManager, visit, cloneShallow, cloneDeep, toValue } from '@speclynx/apidom-core';
+import { RefElement, isPrimitiveElement, isStringElement, isElement, cloneShallow, cloneDeep } from '@speclynx/apidom-datamodel';
+import { IdentityManager, toValue } from '@speclynx/apidom-core';
 import { ApiDOMError } from '@speclynx/apidom-error';
+import { traverseAsync } from '@speclynx/apidom-traverse';
 import { evaluate, URIFragmentIdentifier } from '@speclynx/apidom-json-pointer';
-import { getNodeType, isReferenceElement, isJSONReferenceElement, isPathItemElement, isReferenceLikeElement, isJSONReferenceLikeElement, keyMap, ReferenceElement, PathItemElement } from '@speclynx/apidom-ns-openapi-2';
+import { isReferenceElement, isJSONReferenceElement, isPathItemElement, isReferenceLikeElement, isJSONReferenceLikeElement, refract, refractReference, refractPathItem } from '@speclynx/apidom-ns-openapi-2';
 import MaximumDereferenceDepthError from "../../../errors/MaximumDereferenceDepthError.mjs";
 import MaximumResolveDepthError from "../../../errors/MaximumResolveDepthError.mjs";
 import { AncestorLineage } from "../../util.mjs";
 import * as url from "../../../util/url.mjs";
 import parse from "../../../parse/index.mjs";
 import Reference from "../../../Reference.mjs";
-// @ts-ignore
-const visitAsync = visit[Symbol.for('nodejs.util.promisify.custom')];
-
 // initialize element identity manager
 const identityManager = new IdentityManager();
 
-/**
- * Custom mutation replacer.
- * @public
- */
-export const mutationReplacer = (newElement, oldElement, key, parent) => {
-  if (isMemberElement(parent)) {
-    parent.value = newElement;
-  } else if (Array.isArray(parent)) {
-    parent[key] = newElement;
-  }
-};
-
 /**
  * @public
  */
@@ -99,21 +86,25 @@ class OpenAPI2DereferenceVisitor {
     }
     return mutableReference;
   }
-  toAncestorLineage(ancestors) {
+  toAncestorLineage(path) {
     /**
      * Compute full ancestors lineage.
      * Ancestors are flatten to unwrap all Element instances.
      */
-    const directAncestors = new Set(ancestors.filter(isElement));
+    const ancestorNodes = path.getAncestorNodes();
+    const directAncestors = new Set(ancestorNodes.filter(isElement));
     const ancestorsLineage = new 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(toValue(referencingElement.$ref));
     const isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
     const isExternalReference = !isInternalReference;
@@ -121,12 +112,14 @@ class OpenAPI2DereferenceVisitor {
     // ignore resolving internal Reference Objects
     if (!this.options.resolve.internal && isInternalReference) {
       // skip traversing this reference element and all it's child elements
-      return false;
+      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
-      return false;
+      path.skip();
+      return;
     }
     const reference = await this.toReference(toValue(referencingElement.$ref));
     const $refBaseURI = url.resolve(retrievalURI, toValue(referencingElement.$ref));
@@ -147,13 +140,14 @@ class OpenAPI2DereferenceVisitor {
         referencedElement = this.refractCache.get(cacheKey);
       } else if (isReferenceLikeElement(referencedElement)) {
         // handling indirect references
-        referencedElement = ReferenceElement.refract(referencedElement);
-        referencedElement.setMetaProperty('referenced-element', referencedElementType);
+        referencedElement = 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 = refract(referencedElement, {
+          element: referencedElementType
+        });
         this.refractCache.set(cacheKey, referencedElement);
       }
     }
@@ -181,8 +175,9 @@ class OpenAPI2DereferenceVisitor {
         });
         const replacer = this.options.dereference.strategyOpts['openapi-2']?.circularReplacer ?? this.options.dereference.circularReplacer;
         const replacement = replacer(refElement);
-        link.replaceWith(replacement, mutationReplacer);
-        return !parent ? replacement : false;
+        this.indirections.pop();
+        path.replaceWith(replacement);
+        return;
       }
     }
 
@@ -208,9 +203,8 @@ class OpenAPI2DereferenceVisitor {
         refractCache: this.refractCache,
         ancestors: ancestorsLineage
       });
-      referencedElement = await visitAsync(referencedElement, visitor, {
-        keyMap,
-        nodeTypeGetter: getNodeType
+      referencedElement = await traverseAsync(referencedElement, visitor, {
+        mutable: true
       });
 
       // remove referencing reference from ancestors lineage
@@ -223,38 +217,37 @@ class OpenAPI2DereferenceVisitor {
      */
     const mergedElement = 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', {
       // @ts-ignore
       $ref: 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', cloneDeep(identityManager.identify(referencingElement)));
+    mergedElement.meta.set('ref-referencing-element-id', 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);
+    return;
   }
-  async PathItemElement(referencingElement, key, parent, path, ancestors, link) {
+  async PathItemElement(path) {
+    const referencingElement = path.node;
+
     // ignore PathItemElement without $ref field
     if (!isStringElement(referencingElement.$ref)) {
-      return undefined;
+      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(toValue(referencingElement.$ref));
     const isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
     const isExternalReference = !isInternalReference;
@@ -262,12 +255,12 @@ class OpenAPI2DereferenceVisitor {
     // 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(toValue(referencingElement.$ref));
     const $refBaseURI = url.resolve(retrievalURI, toValue(referencingElement.$ref));
@@ -286,7 +279,7 @@ class OpenAPI2DereferenceVisitor {
       if (this.refractCache.has(cacheKey)) {
         referencedElement = this.refractCache.get(cacheKey);
       } else {
-        referencedElement = PathItemElement.refract(referencedElement);
+        referencedElement = refractPathItem(referencedElement);
         this.refractCache.set(cacheKey, referencedElement);
       }
     }
@@ -314,8 +307,9 @@ class OpenAPI2DereferenceVisitor {
         });
         const replacer = this.options.dereference.strategyOpts['openapi-2']?.circularReplacer ?? this.options.dereference.circularReplacer;
         const replacement = replacer(refElement);
-        link.replaceWith(replacement, mutationReplacer);
-        return !parent ? replacement : false;
+        this.indirections.pop();
+        path.replaceWith(replacement);
+        return;
       }
     }
 
@@ -341,9 +335,8 @@ class OpenAPI2DereferenceVisitor {
         refractCache: this.refractCache,
         ancestors: ancestorsLineage
       });
-      referencedElement = await visitAsync(referencedElement, visitor, {
-        keyMap,
-        nodeTypeGetter: getNodeType
+      referencedElement = await traverseAsync(referencedElement, visitor, {
+        mutable: true
       });
 
       // remove referencing reference from ancestors lineage
@@ -353,9 +346,9 @@ class OpenAPI2DereferenceVisitor {
 
     // merge fields from referenced Path Item with referencing one
     if (isPathItemElement(referencedElement)) {
-      const mergedElement = new PathItemElement([...referencedElement.content], cloneDeep(referencedElement.meta), cloneDeep(referencedElement.attributes));
+      const mergedElement = 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(toValue(keyElement));
@@ -364,32 +357,31 @@ class OpenAPI2DereferenceVisitor {
       mergedElement.remove('$ref');
 
       // annotate referenced element with info about original referencing element
-      mergedElement.setMetaProperty('ref-fields', {
+      mergedElement.meta.set('ref-fields', {
         $ref: 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', cloneDeep(identityManager.identify(referencingElement)));
+      mergedElement.meta.set('ref-referencing-element-id', 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);
+    return;
   }
-  async JSONReferenceElement(referencingElement, key, parent, path, ancestors, link) {
+  async JSONReferenceElement(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(toValue(referencingElement.$ref));
     const isInternalReference = url.stripHash(this.reference.uri) === retrievalURI;
     const isExternalReference = !isInternalReference;
@@ -397,12 +389,14 @@ class OpenAPI2DereferenceVisitor {
     // ignore resolving internal JSONReference Objects
     if (!this.options.resolve.internal && isInternalReference) {
       // skip traversing this JSONReference element and all it's child elements
-      return false;
+      path.skip();
+      return;
     }
     // ignore resolving external JSONReference Objects
     if (!this.options.resolve.external && isExternalReference) {
       // skip traversing this JSONReference element and all it's child elements
-      return false;
+      path.skip();
+      return;
     }
     const reference = await this.toReference(toValue(referencingElement.$ref));
     const $refBaseURI = url.resolve(retrievalURI, toValue(referencingElement.$ref));
@@ -423,13 +417,14 @@ class OpenAPI2DereferenceVisitor {
         referencedElement = this.refractCache.get(cacheKey);
       } else if (isJSONReferenceLikeElement(referencedElement)) {
         // handling indirect references
-        referencedElement = ReferenceElement.refract(referencedElement);
-        referencedElement.setMetaProperty('referenced-element', referencedElementType);
+        referencedElement = refractReference(toValue(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 = refract(toValue(referencedElement), {
+          element: referencedElementType
+        });
         this.refractCache.set(cacheKey, referencedElement);
       }
     }
@@ -457,8 +452,9 @@ class OpenAPI2DereferenceVisitor {
         });
         const replacer = this.options.dereference.strategyOpts['openapi-2']?.circularReplacer ?? this.options.dereference.circularReplacer;
         const replacement = replacer(refElement);
-        link.replaceWith(replacement, mutationReplacer);
-        return !parent ? replacement : false;
+        this.indirections.pop();
+        path.replaceWith(replacement);
+        return;
       }
     }
 
@@ -484,9 +480,8 @@ class OpenAPI2DereferenceVisitor {
         refractCache: this.refractCache,
         ancestors: ancestorsLineage
       });
-      referencedElement = await visitAsync(referencedElement, visitor, {
-        keyMap,
-        nodeTypeGetter: getNodeType
+      referencedElement = await traverseAsync(referencedElement, visitor, {
+        mutable: true
       });
 
       // remove referencing reference from ancestors lineage
@@ -499,26 +494,22 @@ class OpenAPI2DereferenceVisitor {
      */
     const mergedElement = 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', {
       // @ts-ignore
       $ref: 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', cloneDeep(identityManager.identify(referencingElement)));
+    mergedElement.meta.set('ref-referencing-element-id', 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);
+    return;
   }
 }
 export default OpenAPI2DereferenceVisitor;

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

@@ -4,16 +4,14 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
 var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
 exports.__esModule = true;
 exports.default = void 0;
-var _apidomCore = require("@speclynx/apidom-core");
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+var _apidomTraverse = require("@speclynx/apidom-traverse");
 var _apidomNsOpenapi = _interopRequireWildcard(require("@speclynx/apidom-ns-openapi-3-0"));
 var _DereferenceStrategy = _interopRequireDefault(require("../DereferenceStrategy.cjs"));
 var _Reference = _interopRequireDefault(require("../../../Reference.cjs"));
 var _ReferenceSet = _interopRequireDefault(require("../../../ReferenceSet.cjs"));
 var _visitor = _interopRequireDefault(require("./visitor.cjs"));
 exports.OpenAPI3_0DereferenceVisitor = _visitor.default;
-// @ts-ignore
-const visitAsync = _apidomCore.visit[Symbol.for('nodejs.util.promisify.custom')];
-
 /**
  * @public
  */
@@ -38,7 +36,7 @@ class OpenAPI3_0DereferenceStrategy extends _DereferenceStrategy.default {
     return (0, _apidomNsOpenapi.isOpenApi3_0Element)(file.parseResult?.api);
   }
   async dereference(file, options) {
-    const namespace = (0, _apidomCore.createNamespace)(_apidomNsOpenapi.default);
+    const namespace = new _apidomDatamodel.Namespace().use(_apidomNsOpenapi.default);
     const immutableRefSet = options.dereference.refSet ?? new _ReferenceSet.default();
     const mutableRefSet = new _ReferenceSet.default();
     let refSet = immutableRefSet;
@@ -63,7 +61,7 @@ class OpenAPI3_0DereferenceStrategy extends _DereferenceStrategy.default {
     if (options.dereference.immutable) {
       immutableRefSet.refs.map(ref => new _Reference.default({
         ...ref,
-        value: (0, _apidomCore.cloneDeep)(ref.value)
+        value: (0, _apidomDatamodel.cloneDeep)(ref.value)
       })).forEach(ref => mutableRefSet.add(ref));
       reference = mutableRefSet.find(ref => ref.uri === file.uri);
       refSet = mutableRefSet;
@@ -73,9 +71,8 @@ class OpenAPI3_0DereferenceStrategy extends _DereferenceStrategy.default {
       namespace,
       options
     });
-    const dereferencedElement = await visitAsync(refSet.rootRef.value, visitor, {
-      keyMap: _apidomNsOpenapi.keyMap,
-      nodeTypeGetter: _apidomNsOpenapi.getNodeType
+    const dereferencedElement = await (0, _apidomTraverse.traverseAsync)(refSet.rootRef.value, visitor, {
+      mutable: true
     });
 
     /**

package/src/dereference/strategies/openapi-3-0/index.mjs

@@ -1,16 +1,13 @@
-import { createNamespace, visit, cloneDeep } from '@speclynx/apidom-core';
-import openApi3_0Namespace, { getNodeType, isOpenApi3_0Element, keyMap, mediaTypes } from '@speclynx/apidom-ns-openapi-3-0';
+import { Namespace, cloneDeep } from '@speclynx/apidom-datamodel';
+import { traverseAsync } from '@speclynx/apidom-traverse';
+import openApi3_0Namespace, { isOpenApi3_0Element, mediaTypes } from '@speclynx/apidom-ns-openapi-3-0';
 import DereferenceStrategy from "../DereferenceStrategy.mjs";
 import Reference from "../../../Reference.mjs";
 import ReferenceSet from "../../../ReferenceSet.mjs";
 import OpenAPI3_0DereferenceVisitor from "./visitor.mjs";
-// @ts-ignore
-const visitAsync = visit[Symbol.for('nodejs.util.promisify.custom')];
-
 /**
  * @public
  */
-
 /**
  * @public
  */
@@ -31,7 +28,7 @@ class OpenAPI3_0DereferenceStrategy extends DereferenceStrategy {
     return isOpenApi3_0Element(file.parseResult?.api);
   }
   async dereference(file, options) {
-    const namespace = createNamespace(openApi3_0Namespace);
+    const namespace = new Namespace().use(openApi3_0Namespace);
     const immutableRefSet = options.dereference.refSet ?? new ReferenceSet();
     const mutableRefSet = new ReferenceSet();
     let refSet = immutableRefSet;
@@ -66,9 +63,8 @@ class OpenAPI3_0DereferenceStrategy extends DereferenceStrategy {
       namespace,
       options
     });
-    const dereferencedElement = await visitAsync(refSet.rootRef.value, visitor, {
-      keyMap,
-      nodeTypeGetter: getNodeType
+    const dereferencedElement = await traverseAsync(refSet.rootRef.value, visitor, {
+      mutable: true
     });
 
     /**