@speclynx/apidom-reference 4.11.1 → 4.12.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@speclynx/apidom-reference",
-  "version": "4.11.1",
+  "version": "4.12.0",
   "description": "Advanced algorithms for semantic ApiDOM manipulations like dereferencing or resolution.",
   "keywords": [
     "apidom",
@@ -249,6 +249,11 @@
       "require": "./src/dereference/strategies/openapi-3-1/selectors/uri.cjs",
       "types": "./types/dereference/strategies/openapi-3-1/selectors/uri.d.ts"
     },
+    "./bundle/strategies/openapi-3-0": {
+      "import": "./src/bundle/strategies/openapi-3-0/index.mjs",
+      "require": "./src/bundle/strategies/openapi-3-0/index.cjs",
+      "types": "./types/bundle/strategies/openapi-3-0/index.d.ts"
+    },
     "./bundle/strategies/openapi-3-1": {
       "import": "./src/bundle/strategies/openapi-3-1/index.mjs",
       "require": "./src/bundle/strategies/openapi-3-1/index.cjs",
@@ -278,35 +283,35 @@
   "author": "Vladimir Gorej",
   "license": "Apache-2.0",
   "dependencies": {
-    "@babel/runtime-corejs3": "^7.29.7",
-    "@speclynx/apidom-core": "4.11.1",
-    "@speclynx/apidom-datamodel": "4.11.1",
-    "@speclynx/apidom-error": "4.11.1",
-    "@speclynx/apidom-json-pointer": "4.11.1",
-    "@speclynx/apidom-ns-arazzo-1": "4.11.1",
-    "@speclynx/apidom-ns-asyncapi-2": "4.11.1",
-    "@speclynx/apidom-ns-json-schema-2020-12": "4.11.1",
-    "@speclynx/apidom-ns-openapi-2": "4.11.1",
-    "@speclynx/apidom-ns-openapi-3-0": "4.11.1",
-    "@speclynx/apidom-ns-openapi-3-1": "4.11.1",
-    "@speclynx/apidom-ns-overlay-1": "4.11.1",
-    "@speclynx/apidom-parser-adapter-arazzo-json-1": "4.11.1",
-    "@speclynx/apidom-parser-adapter-arazzo-yaml-1": "4.11.1",
-    "@speclynx/apidom-parser-adapter-asyncapi-json-2": "4.11.1",
-    "@speclynx/apidom-parser-adapter-asyncapi-yaml-2": "4.11.1",
-    "@speclynx/apidom-parser-adapter-json": "4.11.1",
-    "@speclynx/apidom-parser-adapter-openapi-json-2": "4.11.1",
-    "@speclynx/apidom-parser-adapter-openapi-json-3-0": "4.11.1",
-    "@speclynx/apidom-parser-adapter-openapi-json-3-1": "4.11.1",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-2": "4.11.1",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-3-0": "4.11.1",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-3-1": "4.11.1",
-    "@speclynx/apidom-parser-adapter-overlay-json-1": "4.11.1",
-    "@speclynx/apidom-parser-adapter-overlay-yaml-1": "4.11.1",
-    "@speclynx/apidom-parser-adapter-yaml-1-2": "4.11.1",
-    "@speclynx/apidom-traverse": "4.11.1",
+    "@babel/runtime-corejs3": "^8.0.0",
+    "@speclynx/apidom-core": "4.12.0",
+    "@speclynx/apidom-datamodel": "4.12.0",
+    "@speclynx/apidom-error": "4.12.0",
+    "@speclynx/apidom-json-pointer": "4.12.0",
+    "@speclynx/apidom-ns-arazzo-1": "4.12.0",
+    "@speclynx/apidom-ns-asyncapi-2": "4.12.0",
+    "@speclynx/apidom-ns-json-schema-2020-12": "4.12.0",
+    "@speclynx/apidom-ns-openapi-2": "4.12.0",
+    "@speclynx/apidom-ns-openapi-3-0": "4.12.0",
+    "@speclynx/apidom-ns-openapi-3-1": "4.12.0",
+    "@speclynx/apidom-ns-overlay-1": "4.12.0",
+    "@speclynx/apidom-parser-adapter-arazzo-json-1": "4.12.0",
+    "@speclynx/apidom-parser-adapter-arazzo-yaml-1": "4.12.0",
+    "@speclynx/apidom-parser-adapter-asyncapi-json-2": "4.12.0",
+    "@speclynx/apidom-parser-adapter-asyncapi-yaml-2": "4.12.0",
+    "@speclynx/apidom-parser-adapter-json": "4.12.0",
+    "@speclynx/apidom-parser-adapter-openapi-json-2": "4.12.0",
+    "@speclynx/apidom-parser-adapter-openapi-json-3-0": "4.12.0",
+    "@speclynx/apidom-parser-adapter-openapi-json-3-1": "4.12.0",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-2": "4.12.0",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-3-0": "4.12.0",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-3-1": "4.12.0",
+    "@speclynx/apidom-parser-adapter-overlay-json-1": "4.12.0",
+    "@speclynx/apidom-parser-adapter-overlay-yaml-1": "4.12.0",
+    "@speclynx/apidom-parser-adapter-yaml-1-2": "4.12.0",
+    "@speclynx/apidom-traverse": "4.12.0",
     "@swaggerexpert/arazzo-runtime-expression": "^2.0.3",
-    "axios": "^1.17.0",
+    "axios": "^1.18.0",
     "picomatch": "^4.0.4",
     "process": "^0.11.10",
     "ramda": "~0.32.0",
@@ -326,5 +331,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "76396e154f0b561793c096c852aaef9d8e01818b"
+  "gitHead": "7d5549ba93000f249ebbe1480ae01d1aaeb2ce15"
 }

package/src/File.cjs

@@ -1,7 +1,9 @@
 "use strict";
 
 var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _ramda = require("ramda");
 var _ramdaAdjunct = require("ramda-adjunct");

package/src/Reference.cjs

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 /**
  * @public

package/src/ReferenceSet.cjs

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _ramdaAdjunct = require("ramda-adjunct");
 /**

package/src/bundle/index.cjs

@@ -2,13 +2,16 @@
 
 var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 var _ramda = require("ramda");
 var _File = _interopRequireDefault(require("../File.cjs"));
 var plugins = _interopRequireWildcard(require("../util/plugins.cjs"));
 var _UnmatchedBundleStrategyError = _interopRequireDefault(require("../errors/UnmatchedBundleStrategyError.cjs"));
 var _BundleError = _interopRequireDefault(require("../errors/BundleError.cjs"));
+var _UnresolvableReferenceError = _interopRequireDefault(require("../errors/UnresolvableReferenceError.cjs"));
 var _index = _interopRequireDefault(require("../parse/index.cjs"));
 var _util = require("../options/util.cjs");
 var url = _interopRequireWildcard(require("../util/url.cjs"));
@@ -53,6 +56,11 @@ const bundle = async (uri, options) => {
     } = await plugins.run('bundle', [file, mergedOptions], bundleStrategies);
     return result;
   } catch (error) {
+    // pass through errors that are already part of the bundle/resolution
+    // taxonomy rather than nesting them inside another BundleError
+    if (error instanceof _BundleError.default || error instanceof _UnresolvableReferenceError.default) {
+      throw error;
+    }
     throw new _BundleError.default(`Error while bundling file "${file.uri}"`, {
       cause: error
     });

package/src/bundle/index.mjs

@@ -3,6 +3,7 @@ import File from "../File.mjs";
 import * as plugins from "../util/plugins.mjs";
 import UnmatchedBundleStrategyError from "../errors/UnmatchedBundleStrategyError.mjs";
 import BundleError from "../errors/BundleError.mjs";
+import UnresolvableReferenceError from "../errors/UnresolvableReferenceError.mjs";
 import parse from "../parse/index.mjs";
 import { merge as mergeOptions } from "../options/util.mjs";
 import * as url from "../util/url.mjs";
@@ -47,6 +48,11 @@ const bundle = async (uri, options) => {
     } = await plugins.run('bundle', [file, mergedOptions], bundleStrategies);
     return result;
   } catch (error) {
+    // pass through errors that are already part of the bundle/resolution
+    // taxonomy rather than nesting them inside another BundleError
+    if (error instanceof BundleError || error instanceof UnresolvableReferenceError) {
+      throw error;
+    }
     throw new BundleError(`Error while bundling file "${file.uri}"`, {
       cause: error
     });

package/src/bundle/strategies/BundleStrategy.cjs

@@ -1,6 +1,8 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.default = void 0;
 /**
  * @public

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

@@ -0,0 +1,94 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "OpenAPI3_0BundleVisitor", {
+  enumerable: true,
+  get: function () {
+    return _visitor.default;
+  }
+});
+exports.default = void 0;
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+var _apidomTraverse = require("@speclynx/apidom-traverse");
+var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-3-0");
+var _Reference = _interopRequireDefault(require("../../../Reference.cjs"));
+var _ReferenceSet = _interopRequireDefault(require("../../../ReferenceSet.cjs"));
+var _BundleStrategy = _interopRequireDefault(require("../BundleStrategy.cjs"));
+var _visitor = _interopRequireDefault(require("./visitor.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class OpenAPI3_0BundleStrategy extends _BundleStrategy.default {
+  constructor(options) {
+    super({
+      ...(options ?? {}),
+      name: 'openapi-3-0'
+    });
+  }
+  canBundle(file) {
+    // assert by media type
+    if (file.mediaType !== 'text/plain') {
+      return _apidomNsOpenapi.mediaTypes.includes(file.mediaType);
+    }
+
+    // assert by inspecting ApiDOM
+    return (0, _apidomNsOpenapi.isOpenApi3_0Element)(file.parseResult?.result);
+  }
+  async bundle(file, options) {
+    const immutableRefSet = options.bundle.refSet ?? new _ReferenceSet.default();
+    const mutableRefSet = new _ReferenceSet.default();
+    let refSet = immutableRefSet;
+    let reference;
+
+    // determine the initial reference
+    if (!immutableRefSet.has(file.uri)) {
+      reference = new _Reference.default({
+        uri: file.uri,
+        value: file.parseResult
+      });
+      immutableRefSet.add(reference);
+    } else {
+      // pre-computed refSet was provided as configuration option
+      reference = immutableRefSet.find(ref => ref.uri === file.uri);
+    }
+
+    /**
+     * Clone refSet due the bundling process being mutable.
+     * We don't want to mutate the original refSet and the references.
+     */
+    if (options.bundle.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 visitor = new _visitor.default({
+      reference: reference,
+      options
+    });
+    await (0, _apidomTraverse.traverseAsync)(refSet.rootRef.value, visitor, {
+      mutable: true
+    });
+    const parseResult = reference.value;
+
+    /**
+     * 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.bundle.refSet === null) {
+      immutableRefSet.clean();
+    }
+    mutableRefSet.clean();
+    return parseResult;
+  }
+}
+var _default = exports.default = OpenAPI3_0BundleStrategy;

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

@@ -0,0 +1,81 @@
+import { cloneDeep } from '@speclynx/apidom-datamodel';
+import { traverseAsync } from '@speclynx/apidom-traverse';
+import { mediaTypes, isOpenApi3_0Element } from '@speclynx/apidom-ns-openapi-3-0';
+import Reference from "../../../Reference.mjs";
+import ReferenceSet from "../../../ReferenceSet.mjs";
+import BundleStrategy from "../BundleStrategy.mjs";
+import OpenAPI3_0BundleVisitor from "./visitor.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class OpenAPI3_0BundleStrategy extends BundleStrategy {
+  constructor(options) {
+    super({
+      ...(options ?? {}),
+      name: 'openapi-3-0'
+    });
+  }
+  canBundle(file) {
+    // assert by media type
+    if (file.mediaType !== 'text/plain') {
+      return mediaTypes.includes(file.mediaType);
+    }
+
+    // assert by inspecting ApiDOM
+    return isOpenApi3_0Element(file.parseResult?.result);
+  }
+  async bundle(file, options) {
+    const immutableRefSet = options.bundle.refSet ?? new ReferenceSet();
+    const mutableRefSet = new ReferenceSet();
+    let refSet = immutableRefSet;
+    let reference;
+
+    // determine the initial reference
+    if (!immutableRefSet.has(file.uri)) {
+      reference = new Reference({
+        uri: file.uri,
+        value: file.parseResult
+      });
+      immutableRefSet.add(reference);
+    } else {
+      // pre-computed refSet was provided as configuration option
+      reference = immutableRefSet.find(ref => ref.uri === file.uri);
+    }
+
+    /**
+     * Clone refSet due the bundling process being mutable.
+     * We don't want to mutate the original refSet and the references.
+     */
+    if (options.bundle.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 visitor = new OpenAPI3_0BundleVisitor({
+      reference: reference,
+      options
+    });
+    await traverseAsync(refSet.rootRef.value, visitor, {
+      mutable: true
+    });
+    const parseResult = reference.value;
+
+    /**
+     * 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.bundle.refSet === null) {
+      immutableRefSet.clean();
+    }
+    mutableRefSet.clean();
+    return parseResult;
+  }
+}
+export { OpenAPI3_0BundleVisitor };
+export default OpenAPI3_0BundleStrategy;