@speclynx/apidom-reference 1.12.1 → 2.0.1

package/src/dereference/strategies/asyncapi-2/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 _apidomNsAsyncapi = _interopRequireWildcard(require("@speclynx/apidom-ns-asyncapi-2"));
 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.AsyncAPI2DereferenceVisitor = _visitor.default;
-// @ts-ignore
-const visitAsync = _apidomCore.visit[Symbol.for('nodejs.util.promisify.custom')];
-
 /**
  * @public
  */
@@ -38,7 +36,7 @@ class AsyncAPI2DereferenceStrategy extends _DereferenceStrategy.default {
     return (0, _apidomNsAsyncapi.isAsyncApi2Element)(file.parseResult?.api);
   }
   async dereference(file, options) {
-    const namespace = (0, _apidomCore.createNamespace)(_apidomNsAsyncapi.default);
+    const namespace = new _apidomDatamodel.Namespace().use(_apidomNsAsyncapi.default);
     const immutableRefSet = options.dereference.refSet ?? new _ReferenceSet.default();
     const mutableRefSet = new _ReferenceSet.default();
     let refSet = immutableRefSet;
@@ -61,7 +59,7 @@ class AsyncAPI2DereferenceStrategy 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;
@@ -71,9 +69,8 @@ class AsyncAPI2DereferenceStrategy extends _DereferenceStrategy.default {
       namespace,
       options
     });
-    const dereferencedElement = await visitAsync(refSet.rootRef.value, visitor, {
-      keyMap: _apidomNsAsyncapi.keyMap,
-      nodeTypeGetter: _apidomNsAsyncapi.getNodeType
+    const dereferencedElement = await (0, _apidomTraverse.traverseAsync)(refSet.rootRef.value, visitor, {
+      mutable: true
     });
 
     /**

package/src/dereference/strategies/asyncapi-2/index.mjs

@@ -1,16 +1,13 @@
-import { createNamespace, visit, cloneDeep } from '@speclynx/apidom-core';
-import asyncApi2Namespace, { getNodeType, isAsyncApi2Element, keyMap, mediaTypes } from '@speclynx/apidom-ns-asyncapi-2';
+import { Namespace, cloneDeep } from '@speclynx/apidom-datamodel';
+import { traverseAsync } from '@speclynx/apidom-traverse';
+import asyncApi2Namespace, { isAsyncApi2Element, mediaTypes } from '@speclynx/apidom-ns-asyncapi-2';
 import DereferenceStrategy from "../DereferenceStrategy.mjs";
 import Reference from "../../../Reference.mjs";
 import ReferenceSet from "../../../ReferenceSet.mjs";
 import AsyncAPI2DereferenceVisitor from "./visitor.mjs";
-// @ts-ignore
-const visitAsync = visit[Symbol.for('nodejs.util.promisify.custom')];
-
 /**
  * @public
  */
-
 /**
  * @public
  */
@@ -31,7 +28,7 @@ class AsyncAPI2DereferenceStrategy extends DereferenceStrategy {
     return isAsyncApi2Element(file.parseResult?.api);
   }
   async dereference(file, options) {
-    const namespace = createNamespace(asyncApi2Namespace);
+    const namespace = new Namespace().use(asyncApi2Namespace);
     const immutableRefSet = options.dereference.refSet ?? new ReferenceSet();
     const mutableRefSet = new ReferenceSet();
     let refSet = immutableRefSet;
@@ -64,9 +61,8 @@ class AsyncAPI2DereferenceStrategy 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
     });
 
     /**

package/src/dereference/strategies/asyncapi-2/visitor.cjs

@@ -3,10 +3,12 @@
 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 _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 _apidomNsAsyncapi = require("@speclynx/apidom-ns-asyncapi-2");
 var _MaximumDereferenceDepthError = _interopRequireDefault(require("../../../errors/MaximumDereferenceDepthError.cjs"));
@@ -15,28 +17,13 @@ var _util = require("../../util.cjs");
 var url = _interopRequireWildcard(require("../../../util/url.cjs"));
 var _index = _interopRequireDefault(require("../../../parse/index.cjs"));
 var _Reference = _interopRequireDefault(require("../../../Reference.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
  */
@@ -90,7 +77,7 @@ class AsyncAPI2DereferenceVisitor {
     // 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);
@@ -105,21 +92,25 @@ class AsyncAPI2DereferenceVisitor {
     }
     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;
@@ -127,12 +118,14 @@ class AsyncAPI2DereferenceVisitor {
     // ignore resolving internal Reference Objects
     if (!this.options.resolve.internal && isInternalReference) {
       // skip traversing this reference 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 and all it's child elements
-      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));
@@ -146,20 +139,21 @@ class AsyncAPI2DereferenceVisitor {
     /**
      * 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, _apidomNsAsyncapi.isReferenceLikeElement)(referencedElement)) {
         // handling indirect references
-        referencedElement = _apidomNsAsyncapi.ReferenceElement.refract(referencedElement);
-        referencedElement.setMetaProperty('referenced-element', referencedElementType);
+        referencedElement = (0, _apidomNsAsyncapi.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, _apidomNsAsyncapi.refract)(referencedElement, {
+          element: referencedElementType
+        });
         this.refractCache.set(cacheKey, referencedElement);
       }
     }
@@ -180,15 +174,16 @@ class AsyncAPI2DereferenceVisitor {
       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['asyncapi-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;
       }
     }
 
@@ -214,9 +209,8 @@ class AsyncAPI2DereferenceVisitor {
         refractCache: this.refractCache,
         ancestors: ancestorsLineage
       });
-      referencedElement = await visitAsync(referencedElement, visitor, {
-        keyMap: _apidomNsAsyncapi.keyMap,
-        nodeTypeGetter: _apidomNsAsyncapi.getNodeType
+      referencedElement = await (0, _apidomTraverse.traverseAsync)(referencedElement, visitor, {
+        mutable: true
       });
 
       // remove referencing reference from ancestors lineage
@@ -226,57 +220,55 @@ class AsyncAPI2DereferenceVisitor {
 
     // Boolean JSON Schemas
     if ((0, _apidomNsAsyncapi.isBooleanJsonSchemaElement)(referencedElement)) {
-      const booleanJsonSchemaElement = (0, _apidomCore.cloneDeep)(referencedElement);
+      const booleanJsonSchemaElement = (0, _apidomDatamodel.cloneDeep)(referencedElement);
       // assign unique id to merged element
-      booleanJsonSchemaElement.setMetaProperty('id', identityManager.generateId());
+      booleanJsonSchemaElement.meta.set('id', identityManager.generateId());
       // annotate referenced element with info about original referencing element
-      booleanJsonSchemaElement.setMetaProperty('ref-fields', {
+      booleanJsonSchemaElement.meta.set('ref-fields', {
         $ref: (0, _apidomCore.toValue)(referencingElement.$ref)
       });
       // annotate referenced element with info about origin
-      booleanJsonSchemaElement.setMetaProperty('ref-origin', reference.uri);
+      booleanJsonSchemaElement.meta.set('ref-origin', reference.uri);
       // annotate fragment with info about referencing element
-      booleanJsonSchemaElement.setMetaProperty('ref-referencing-element-id', (0, _apidomCore.cloneDeep)(identityManager.identify(referencingElement)));
-      link.replaceWith(booleanJsonSchemaElement, mutationReplacer);
-      return !parent ? booleanJsonSchemaElement : false;
+      booleanJsonSchemaElement.meta.set('ref-referencing-element-id', (0, _apidomDatamodel.cloneDeep)(identityManager.identify(referencingElement)));
+      path.replaceWith(booleanJsonSchemaElement);
+      return;
     }
 
     /**
      * 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 ChannelItemElement(referencingElement, key, parent, path, ancestors, link) {
+  async ChannelItemElement(path) {
+    const referencingElement = path.node;
+
     // ignore ChannelItemElement 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;
@@ -284,12 +276,12 @@ class AsyncAPI2DereferenceVisitor {
     // ignore resolving internal Channel Item Objects
     if (!this.options.resolve.internal && isInternalReference) {
       // skip traversing this channel item but traverse all it's child elements
-      return undefined;
+      return;
     }
     // ignore resolving external Channel Item Objects
     if (!this.options.resolve.external && isExternalReference) {
       // skip traversing this channel item 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));
@@ -303,12 +295,12 @@ class AsyncAPI2DereferenceVisitor {
     /**
      * Applying semantics to a referenced element if semantics are missing.
      */
-    if ((0, _apidomCore.isPrimitiveElement)(referencedElement)) {
+    if ((0, _apidomDatamodel.isPrimitiveElement)(referencedElement)) {
       const cacheKey = `channel-item-${(0, _apidomCore.toValue)(identityManager.identify(referencedElement))}`;
       if (this.refractCache.has(cacheKey)) {
         referencedElement = this.refractCache.get(cacheKey);
       } else {
-        referencedElement = _apidomNsAsyncapi.ChannelItemElement.refract(referencedElement);
+        referencedElement = (0, _apidomNsAsyncapi.refractChannelItem)(referencedElement);
         this.refractCache.set(cacheKey, referencedElement);
       }
     }
@@ -329,15 +321,16 @@ class AsyncAPI2DereferenceVisitor {
       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: 'channel-item',
           uri: reference.uri,
           $ref: (0, _apidomCore.toValue)(referencingElement.$ref)
         });
         const replacer = this.options.dereference.strategyOpts['asyncapi-2']?.circularReplacer ?? this.options.dereference.circularReplacer;
         const replacement = replacer(refElement);
-        link.replaceWith(replacement, mutationReplacer);
-        return !parent ? replacement : undefined;
+        this.indirections.pop();
+        path.replaceWith(replacement);
+        return;
       }
     }
 
@@ -352,7 +345,7 @@ class AsyncAPI2DereferenceVisitor {
      */
     const isNonRootDocument = url.stripHash(reference.refSet.rootRef.uri) !== reference.uri;
     const shouldDetectCircular = ['error', 'replace'].includes(this.options.dereference.circular);
-    if ((isExternalReference || isNonRootDocument || (0, _apidomNsAsyncapi.isChannelItemElement)(referencedElement) && (0, _apidomCore.isStringElement)(referencedElement.$ref) || shouldDetectCircular) && !ancestorsLineage.includesCycle(referencedElement)) {
+    if ((isExternalReference || isNonRootDocument || (0, _apidomNsAsyncapi.isChannelItemElement)(referencedElement) && (0, _apidomDatamodel.isStringElement)(referencedElement.$ref) || shouldDetectCircular) && !ancestorsLineage.includesCycle(referencedElement)) {
       // append referencing reference to ancestors lineage
       directAncestors.add(referencingElement);
       const visitor = new AsyncAPI2DereferenceVisitor({
@@ -363,9 +356,8 @@ class AsyncAPI2DereferenceVisitor {
         refractCache: this.refractCache,
         ancestors: ancestorsLineage
       });
-      referencedElement = await visitAsync(referencedElement, visitor, {
-        keyMap: _apidomNsAsyncapi.keyMap,
-        nodeTypeGetter: _apidomNsAsyncapi.getNodeType
+      referencedElement = await (0, _apidomTraverse.traverseAsync)(referencedElement, visitor, {
+        mutable: true
       });
 
       // remove referencing reference from ancestors lineage
@@ -377,9 +369,9 @@ class AsyncAPI2DereferenceVisitor {
      * Creating a new version of Channel Item by merging fields from referenced Channel Item with referencing one.
      */
     if ((0, _apidomNsAsyncapi.isChannelItemElement)(referencedElement)) {
-      const mergedElement = new _apidomNsAsyncapi.ChannelItemElement([...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 ChannelItemElement overrides ones from referenced ChannelItemElement
       referencingElement.forEach((value, keyElement, item) => {
         mergedElement.remove((0, _apidomCore.toValue)(keyElement));
@@ -388,25 +380,20 @@ class AsyncAPI2DereferenceVisitor {
       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 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);
   }
 }
 var _default = exports.default = AsyncAPI2DereferenceVisitor;