@speclynx/apidom-reference 6.2.0 → 7.0.0

package/src/dereference/strategies/openapi-2/index.cjs

@@ -11,9 +11,8 @@ Object.defineProperty(exports, "OpenAPI2DereferenceVisitor", {
   }
 });
 exports.default = void 0;
-var _apidomDatamodel = require("@speclynx/apidom-datamodel");
 var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-2");
-var _apidomTraverse = require("@speclynx/apidom-traverse");
+var _mediaTypes = require("@swaggerexpert/media-types");
 var _DereferenceStrategy = _interopRequireDefault(require("../DereferenceStrategy.cjs"));
 var _Reference = _interopRequireDefault(require("../../../Reference.cjs"));
 var _ReferenceSet = _interopRequireDefault(require("../../../ReferenceSet.cjs"));
@@ -34,73 +33,44 @@ class OpenAPI2DereferenceStrategy extends _DereferenceStrategy.default {
   }
   canDereference(file) {
     // assert by media type
-    if (file.mediaType !== 'text/plain') {
-      return _apidomNsOpenapi.mediaTypes.includes(file.mediaType);
+    if (!(0, _mediaTypes.matches)('text/plain', file.mediaType)) {
+      return (0, _mediaTypes.selectBestMatch)(_apidomNsOpenapi.mediaTypes, file.mediaType) !== null;
     }
 
     // assert by inspecting ApiDOM
     return (0, _apidomNsOpenapi.isSwaggerElement)(file.parseResult?.result);
   }
   async dereference(file, options) {
-    const immutableRefSet = options.dereference.refSet ?? new _ReferenceSet.default();
-    const mutableRefSet = new _ReferenceSet.default();
-    let refSet = immutableRefSet;
+    const refSet = options.dereference.refSet ?? new _ReferenceSet.default();
     let reference;
-    if (!immutableRefSet.has(file.uri)) {
+    if (!refSet.has(file.uri)) {
       reference = new _Reference.default({
         uri: file.uri,
         value: file.parseResult
       });
-      immutableRefSet.add(reference);
+      refSet.add(reference);
     } else {
       // pre-computed refSet was provided as configuration option
-      reference = immutableRefSet.find(ref => ref.uri === file.uri);
+      reference = refSet.find(ref => ref.uri === file.uri);
     }
 
     /**
-     * Clone refSet due the dereferencing process being mutable.
-     * We don't want to mutate the original refSet and the references.
+     * With the immutable option the dereferenced element is a new tree,
+     * otherwise the dereferenced root is dereferenced in place.
      */
-    if (options.dereference.immutable) {
-      immutableRefSet.refs.map(ref => new _Reference.default({
-        ...ref,
-        value: (0, _apidomDatamodel.cloneDeep)(ref.value)
-      })).forEach(ref => mutableRefSet.add(ref));
-      reference = mutableRefSet.find(ref => ref.uri === file.uri);
-      refSet = mutableRefSet;
-    }
-    const shouldDetectCircular = ['error', 'replace'].includes(options.dereference.circular);
     const visitor = new _visitor.default({
-      reference: reference,
+      reference,
       options
     });
-    const dereferencedElement = await (0, _apidomTraverse.traverseAsync)(refSet.rootRef.value, visitor, {
-      mutable: true,
-      ...(shouldDetectCircular && {
-        skipVisited: 'skip'
-      })
-    });
-
-    /**
-     * If immutable option is set, replay refs from the refSet.
-     */
-    if (options.dereference.immutable) {
-      mutableRefSet.refs.filter(ref => ref.uri.startsWith('immutable://')).map(ref => new _Reference.default({
-        ...ref,
-        uri: ref.uri.replace(/^immutable:\/\//, '')
-      })).forEach(ref => immutableRefSet.add(ref));
-      reference = immutableRefSet.find(ref => ref.uri === file.uri);
-      refSet = immutableRefSet;
-    }
+    const dereferencedElement = await visitor.dereference(refSet.rootRef.value, undefined);
 
     /**
      * Release all memory if this refSet was not provided as a configuration option.
      * If provided as configuration option, then provider is responsible for cleanup.
      */
     if (options.dereference.refSet === null) {
-      immutableRefSet.clean();
+      refSet.clean();
     }
-    mutableRefSet.clean();
     return dereferencedElement;
   }
 }

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

@@ -1,6 +1,5 @@
-import { cloneDeep } from '@speclynx/apidom-datamodel';
 import { isSwaggerElement, mediaTypes } from '@speclynx/apidom-ns-openapi-2';
-import { traverseAsync } from '@speclynx/apidom-traverse';
+import { matches, selectBestMatch } from '@swaggerexpert/media-types';
 import DereferenceStrategy from "../DereferenceStrategy.mjs";
 import Reference from "../../../Reference.mjs";
 import ReferenceSet from "../../../ReferenceSet.mjs";
@@ -20,73 +19,44 @@ class OpenAPI2DereferenceStrategy extends DereferenceStrategy {
   }
   canDereference(file) {
     // assert by media type
-    if (file.mediaType !== 'text/plain') {
-      return mediaTypes.includes(file.mediaType);
+    if (!matches('text/plain', file.mediaType)) {
+      return selectBestMatch(mediaTypes, file.mediaType) !== null;
     }
 
     // assert by inspecting ApiDOM
     return isSwaggerElement(file.parseResult?.result);
   }
   async dereference(file, options) {
-    const immutableRefSet = options.dereference.refSet ?? new ReferenceSet();
-    const mutableRefSet = new ReferenceSet();
-    let refSet = immutableRefSet;
+    const refSet = options.dereference.refSet ?? new ReferenceSet();
     let reference;
-    if (!immutableRefSet.has(file.uri)) {
+    if (!refSet.has(file.uri)) {
       reference = new Reference({
         uri: file.uri,
         value: file.parseResult
       });
-      immutableRefSet.add(reference);
+      refSet.add(reference);
     } else {
       // pre-computed refSet was provided as configuration option
-      reference = immutableRefSet.find(ref => ref.uri === file.uri);
+      reference = refSet.find(ref => ref.uri === file.uri);
     }
 
     /**
-     * Clone refSet due the dereferencing process being mutable.
-     * We don't want to mutate the original refSet and the references.
+     * With the immutable option the dereferenced element is a new tree,
+     * otherwise the dereferenced root is dereferenced in place.
      */
-    if (options.dereference.immutable) {
-      immutableRefSet.refs.map(ref => new Reference({
-        ...ref,
-        value: cloneDeep(ref.value)
-      })).forEach(ref => mutableRefSet.add(ref));
-      reference = mutableRefSet.find(ref => ref.uri === file.uri);
-      refSet = mutableRefSet;
-    }
-    const shouldDetectCircular = ['error', 'replace'].includes(options.dereference.circular);
     const visitor = new OpenAPI2DereferenceVisitor({
-      reference: reference,
+      reference,
       options
     });
-    const dereferencedElement = await traverseAsync(refSet.rootRef.value, visitor, {
-      mutable: true,
-      ...(shouldDetectCircular && {
-        skipVisited: 'skip'
-      })
-    });
-
-    /**
-     * If immutable option is set, replay refs from the refSet.
-     */
-    if (options.dereference.immutable) {
-      mutableRefSet.refs.filter(ref => ref.uri.startsWith('immutable://')).map(ref => new Reference({
-        ...ref,
-        uri: ref.uri.replace(/^immutable:\/\//, '')
-      })).forEach(ref => immutableRefSet.add(ref));
-      reference = immutableRefSet.find(ref => ref.uri === file.uri);
-      refSet = immutableRefSet;
-    }
+    const dereferencedElement = await visitor.dereference(refSet.rootRef.value, undefined);
 
     /**
      * Release all memory if this refSet was not provided as a configuration option.
      * If provided as configuration option, then provider is responsible for cleanup.
      */
     if (options.dereference.refSet === null) {
-      immutableRefSet.clean();
+      refSet.clean();
     }
-    mutableRefSet.clean();
     return dereferencedElement;
   }
 }