@speclynx/apidom-reference 4.12.1 → 4.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@speclynx/apidom-reference",
-  "version": "4.12.1",
+  "version": "4.14.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-2": {
+      "import": "./src/bundle/strategies/openapi-2/index.mjs",
+      "require": "./src/bundle/strategies/openapi-2/index.cjs",
+      "types": "./types/bundle/strategies/openapi-2/index.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",
@@ -284,32 +289,32 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^8.0.0",
-    "@speclynx/apidom-core": "4.12.1",
-    "@speclynx/apidom-datamodel": "4.12.1",
-    "@speclynx/apidom-error": "4.12.1",
-    "@speclynx/apidom-json-pointer": "4.12.1",
-    "@speclynx/apidom-ns-arazzo-1": "4.12.1",
-    "@speclynx/apidom-ns-asyncapi-2": "4.12.1",
-    "@speclynx/apidom-ns-json-schema-2020-12": "4.12.1",
-    "@speclynx/apidom-ns-openapi-2": "4.12.1",
-    "@speclynx/apidom-ns-openapi-3-0": "4.12.1",
-    "@speclynx/apidom-ns-openapi-3-1": "4.12.1",
-    "@speclynx/apidom-ns-overlay-1": "4.12.1",
-    "@speclynx/apidom-parser-adapter-arazzo-json-1": "4.12.1",
-    "@speclynx/apidom-parser-adapter-arazzo-yaml-1": "4.12.1",
-    "@speclynx/apidom-parser-adapter-asyncapi-json-2": "4.12.1",
-    "@speclynx/apidom-parser-adapter-asyncapi-yaml-2": "4.12.1",
-    "@speclynx/apidom-parser-adapter-json": "4.12.1",
-    "@speclynx/apidom-parser-adapter-openapi-json-2": "4.12.1",
-    "@speclynx/apidom-parser-adapter-openapi-json-3-0": "4.12.1",
-    "@speclynx/apidom-parser-adapter-openapi-json-3-1": "4.12.1",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-2": "4.12.1",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-3-0": "4.12.1",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-3-1": "4.12.1",
-    "@speclynx/apidom-parser-adapter-overlay-json-1": "4.12.1",
-    "@speclynx/apidom-parser-adapter-overlay-yaml-1": "4.12.1",
-    "@speclynx/apidom-parser-adapter-yaml-1-2": "4.12.1",
-    "@speclynx/apidom-traverse": "4.12.1",
+    "@speclynx/apidom-core": "4.14.0",
+    "@speclynx/apidom-datamodel": "4.14.0",
+    "@speclynx/apidom-error": "4.14.0",
+    "@speclynx/apidom-json-pointer": "4.14.0",
+    "@speclynx/apidom-ns-arazzo-1": "4.14.0",
+    "@speclynx/apidom-ns-asyncapi-2": "4.14.0",
+    "@speclynx/apidom-ns-json-schema-2020-12": "4.14.0",
+    "@speclynx/apidom-ns-openapi-2": "4.14.0",
+    "@speclynx/apidom-ns-openapi-3-0": "4.14.0",
+    "@speclynx/apidom-ns-openapi-3-1": "4.14.0",
+    "@speclynx/apidom-ns-overlay-1": "4.14.0",
+    "@speclynx/apidom-parser-adapter-arazzo-json-1": "4.14.0",
+    "@speclynx/apidom-parser-adapter-arazzo-yaml-1": "4.14.0",
+    "@speclynx/apidom-parser-adapter-asyncapi-json-2": "4.14.0",
+    "@speclynx/apidom-parser-adapter-asyncapi-yaml-2": "4.14.0",
+    "@speclynx/apidom-parser-adapter-json": "4.14.0",
+    "@speclynx/apidom-parser-adapter-openapi-json-2": "4.14.0",
+    "@speclynx/apidom-parser-adapter-openapi-json-3-0": "4.14.0",
+    "@speclynx/apidom-parser-adapter-openapi-json-3-1": "4.14.0",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-2": "4.14.0",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-3-0": "4.14.0",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-3-1": "4.14.0",
+    "@speclynx/apidom-parser-adapter-overlay-json-1": "4.14.0",
+    "@speclynx/apidom-parser-adapter-overlay-yaml-1": "4.14.0",
+    "@speclynx/apidom-parser-adapter-yaml-1-2": "4.14.0",
+    "@speclynx/apidom-traverse": "4.14.0",
     "@swaggerexpert/arazzo-runtime-expression": "^2.0.3",
     "axios": "^1.18.0",
     "picomatch": "^4.0.4",
@@ -331,5 +336,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "18a5bdbd578179f3fe3f6f0217884cd62a29f8f9"
+  "gitHead": "ae231056cc8865f2467fa97ca456975301bbe265"
 }

package/src/bundle/strategies/openapi-2/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, "OpenAPI2BundleVisitor", {
+  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-2");
+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 OpenAPI2BundleStrategy extends _BundleStrategy.default {
+  constructor(options) {
+    super({
+      ...(options ?? {}),
+      name: 'openapi-2'
+    });
+  }
+  canBundle(file) {
+    // assert by media type
+    if (file.mediaType !== 'text/plain') {
+      return _apidomNsOpenapi.mediaTypes.includes(file.mediaType);
+    }
+
+    // assert by inspecting ApiDOM
+    return (0, _apidomNsOpenapi.isSwaggerElement)(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 = OpenAPI2BundleStrategy;

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

@@ -0,0 +1,81 @@
+import { cloneDeep } from '@speclynx/apidom-datamodel';
+import { traverseAsync } from '@speclynx/apidom-traverse';
+import { mediaTypes, isSwaggerElement } from '@speclynx/apidom-ns-openapi-2';
+import Reference from "../../../Reference.mjs";
+import ReferenceSet from "../../../ReferenceSet.mjs";
+import BundleStrategy from "../BundleStrategy.mjs";
+import OpenAPI2BundleVisitor from "./visitor.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class OpenAPI2BundleStrategy extends BundleStrategy {
+  constructor(options) {
+    super({
+      ...(options ?? {}),
+      name: 'openapi-2'
+    });
+  }
+  canBundle(file) {
+    // assert by media type
+    if (file.mediaType !== 'text/plain') {
+      return mediaTypes.includes(file.mediaType);
+    }
+
+    // assert by inspecting ApiDOM
+    return isSwaggerElement(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 OpenAPI2BundleVisitor({
+      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 { OpenAPI2BundleVisitor };
+export default OpenAPI2BundleStrategy;