@speclynx/apidom-reference 4.0.2 → 4.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@speclynx/apidom-reference",
-  "version": "4.0.2",
+  "version": "4.0.4",
   "description": "Advanced algorithms for semantic ApiDOM manipulations like dereferencing or resolution.",
   "keywords": [
     "apidom",
@@ -254,29 +254,29 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.28.4",
-    "@speclynx/apidom-core": "4.0.2",
-    "@speclynx/apidom-datamodel": "4.0.2",
-    "@speclynx/apidom-error": "4.0.2",
-    "@speclynx/apidom-json-pointer": "4.0.2",
-    "@speclynx/apidom-ns-arazzo-1": "4.0.2",
-    "@speclynx/apidom-ns-asyncapi-2": "4.0.2",
-    "@speclynx/apidom-ns-json-schema-2020-12": "4.0.2",
-    "@speclynx/apidom-ns-openapi-2": "4.0.2",
-    "@speclynx/apidom-ns-openapi-3-0": "4.0.2",
-    "@speclynx/apidom-ns-openapi-3-1": "4.0.2",
-    "@speclynx/apidom-parser-adapter-arazzo-json-1": "4.0.2",
-    "@speclynx/apidom-parser-adapter-arazzo-yaml-1": "4.0.2",
-    "@speclynx/apidom-parser-adapter-asyncapi-json-2": "4.0.2",
-    "@speclynx/apidom-parser-adapter-asyncapi-yaml-2": "4.0.2",
-    "@speclynx/apidom-parser-adapter-json": "4.0.2",
-    "@speclynx/apidom-parser-adapter-openapi-json-2": "4.0.2",
-    "@speclynx/apidom-parser-adapter-openapi-json-3-0": "4.0.2",
-    "@speclynx/apidom-parser-adapter-openapi-json-3-1": "4.0.2",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-2": "4.0.2",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-3-0": "4.0.2",
-    "@speclynx/apidom-parser-adapter-openapi-yaml-3-1": "4.0.2",
-    "@speclynx/apidom-parser-adapter-yaml-1-2": "4.0.2",
-    "@speclynx/apidom-traverse": "4.0.2",
+    "@speclynx/apidom-core": "4.0.4",
+    "@speclynx/apidom-datamodel": "4.0.4",
+    "@speclynx/apidom-error": "4.0.4",
+    "@speclynx/apidom-json-pointer": "4.0.4",
+    "@speclynx/apidom-ns-arazzo-1": "4.0.4",
+    "@speclynx/apidom-ns-asyncapi-2": "4.0.4",
+    "@speclynx/apidom-ns-json-schema-2020-12": "4.0.4",
+    "@speclynx/apidom-ns-openapi-2": "4.0.4",
+    "@speclynx/apidom-ns-openapi-3-0": "4.0.4",
+    "@speclynx/apidom-ns-openapi-3-1": "4.0.4",
+    "@speclynx/apidom-parser-adapter-arazzo-json-1": "4.0.4",
+    "@speclynx/apidom-parser-adapter-arazzo-yaml-1": "4.0.4",
+    "@speclynx/apidom-parser-adapter-asyncapi-json-2": "4.0.4",
+    "@speclynx/apidom-parser-adapter-asyncapi-yaml-2": "4.0.4",
+    "@speclynx/apidom-parser-adapter-json": "4.0.4",
+    "@speclynx/apidom-parser-adapter-openapi-json-2": "4.0.4",
+    "@speclynx/apidom-parser-adapter-openapi-json-3-0": "4.0.4",
+    "@speclynx/apidom-parser-adapter-openapi-json-3-1": "4.0.4",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-2": "4.0.4",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-3-0": "4.0.4",
+    "@speclynx/apidom-parser-adapter-openapi-yaml-3-1": "4.0.4",
+    "@speclynx/apidom-parser-adapter-yaml-1-2": "4.0.4",
+    "@speclynx/apidom-traverse": "4.0.4",
     "@swaggerexpert/arazzo-runtime-expression": "^2.0.3",
     "axios": "^1.13.5",
     "picomatch": "^4.0.3",
@@ -298,5 +298,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "af1b05d4d5e48a11a3a03cd5699324e0f1b62765"
+  "gitHead": "a06f6ef3d37ad5bf860cbbf4b442bfbe3a522cc2"
 }

package/src/File.cjs

@@ -0,0 +1,50 @@
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _ramda = require("ramda");
+var _ramdaAdjunct = require("ramda-adjunct");
+var url = _interopRequireWildcard(require("./util/url.cjs"));
+/**
+ * This class represents a File object with url and data.
+ * @public
+ */
+
+/**
+ * @public
+ */
+class File {
+  uri;
+  mediaType;
+  data;
+  parseResult;
+  constructor({
+    uri,
+    mediaType = 'text/plain',
+    data,
+    parseResult
+  }) {
+    this.uri = uri;
+    this.mediaType = mediaType;
+    this.data = data;
+    this.parseResult = parseResult;
+  }
+  get extension() {
+    if ((0, _ramdaAdjunct.isString)(this.uri)) {
+      return url.getExtension(this.uri);
+    }
+    return '';
+  }
+  toString() {
+    if (typeof this.data === 'string') {
+      return this.data;
+    }
+    if (this.data instanceof ArrayBuffer || ['ArrayBuffer'].includes((0, _ramda.type)(this.data)) || ArrayBuffer.isView(this.data)) {
+      const textDecoder = new TextDecoder('utf-8');
+      return textDecoder.decode(this.data);
+    }
+    return String(this.data);
+  }
+}
+var _default = exports.default = File;

package/src/File.mjs

@@ -0,0 +1,44 @@
+import { type } from 'ramda';
+import { isString } from 'ramda-adjunct';
+import * as url from "./util/url.mjs";
+/**
+ * This class represents a File object with url and data.
+ * @public
+ */
+/**
+ * @public
+ */
+class File {
+  uri;
+  mediaType;
+  data;
+  parseResult;
+  constructor({
+    uri,
+    mediaType = 'text/plain',
+    data,
+    parseResult
+  }) {
+    this.uri = uri;
+    this.mediaType = mediaType;
+    this.data = data;
+    this.parseResult = parseResult;
+  }
+  get extension() {
+    if (isString(this.uri)) {
+      return url.getExtension(this.uri);
+    }
+    return '';
+  }
+  toString() {
+    if (typeof this.data === 'string') {
+      return this.data;
+    }
+    if (this.data instanceof ArrayBuffer || ['ArrayBuffer'].includes(type(this.data)) || ArrayBuffer.isView(this.data)) {
+      const textDecoder = new TextDecoder('utf-8');
+      return textDecoder.decode(this.data);
+    }
+    return String(this.data);
+  }
+}
+export default File;

package/src/Reference.cjs

@@ -0,0 +1,31 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class Reference {
+  uri;
+  depth;
+  value;
+  refSet;
+  errors;
+  constructor({
+    uri,
+    depth = 0,
+    refSet,
+    value
+  }) {
+    this.uri = uri;
+    this.value = value;
+    this.depth = depth;
+    this.refSet = refSet;
+    this.errors = [];
+  }
+}
+var _default = exports.default = Reference;

package/src/Reference.mjs

@@ -0,0 +1,27 @@
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class Reference {
+  uri;
+  depth;
+  value;
+  refSet;
+  errors;
+  constructor({
+    uri,
+    depth = 0,
+    refSet,
+    value
+  }) {
+    this.uri = uri;
+    this.value = value;
+    this.depth = depth;
+    this.refSet = refSet;
+    this.errors = [];
+  }
+}
+export default Reference;

package/src/ReferenceSet.cjs

@@ -0,0 +1,60 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _ramdaAdjunct = require("ramda-adjunct");
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class ReferenceSet {
+  rootRef;
+  refs;
+  circular;
+  constructor({
+    refs = [],
+    circular = false
+  } = {}) {
+    this.refs = [];
+    this.circular = circular;
+    refs.forEach(this.add.bind(this));
+  }
+  get size() {
+    return this.refs.length;
+  }
+  add(reference) {
+    if (!this.has(reference)) {
+      this.refs.push(reference);
+      this.rootRef = this.rootRef === undefined ? reference : this.rootRef;
+      reference.refSet = this;
+    }
+    return this;
+  }
+  merge(anotherRefSet) {
+    for (const reference of anotherRefSet.values()) {
+      this.add(reference);
+    }
+    return this;
+  }
+  has(thing) {
+    const uri = (0, _ramdaAdjunct.isString)(thing) ? thing : thing.uri;
+    return (0, _ramdaAdjunct.isNotUndefined)(this.find(ref => ref.uri === uri));
+  }
+  find(predicate) {
+    return this.refs.find(predicate);
+  }
+  *values() {
+    yield* this.refs;
+  }
+  clean() {
+    this.refs.forEach(ref => {
+      ref.refSet = undefined;
+    });
+    this.rootRef = undefined;
+    this.refs.length = 0;
+  }
+}
+var _default = exports.default = ReferenceSet;

package/src/ReferenceSet.mjs

@@ -0,0 +1,57 @@
+import { isNotUndefined, isString } from 'ramda-adjunct';
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class ReferenceSet {
+  rootRef;
+  refs;
+  circular;
+  constructor({
+    refs = [],
+    circular = false
+  } = {}) {
+    this.refs = [];
+    this.circular = circular;
+    refs.forEach(this.add.bind(this));
+  }
+  get size() {
+    return this.refs.length;
+  }
+  add(reference) {
+    if (!this.has(reference)) {
+      this.refs.push(reference);
+      this.rootRef = this.rootRef === undefined ? reference : this.rootRef;
+      reference.refSet = this;
+    }
+    return this;
+  }
+  merge(anotherRefSet) {
+    for (const reference of anotherRefSet.values()) {
+      this.add(reference);
+    }
+    return this;
+  }
+  has(thing) {
+    const uri = isString(thing) ? thing : thing.uri;
+    return isNotUndefined(this.find(ref => ref.uri === uri));
+  }
+  find(predicate) {
+    return this.refs.find(predicate);
+  }
+  *values() {
+    yield* this.refs;
+  }
+  clean() {
+    this.refs.forEach(ref => {
+      ref.refSet = undefined;
+    });
+    this.rootRef = undefined;
+    this.refs.length = 0;
+  }
+}
+export default ReferenceSet;

package/src/bundle/index.cjs

@@ -0,0 +1,61 @@
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = 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 _index = _interopRequireDefault(require("../parse/index.cjs"));
+var _util = require("../options/util.cjs");
+var url = _interopRequireWildcard(require("../util/url.cjs"));
+/**
+ * Bundle a file with all its external references to a compound document.
+ */
+const bundle = async (uri, options) => {
+  const {
+    refSet
+  } = options.bundle;
+  const sanitizedURI = url.sanitize(uri);
+  const mergedOptions = (0, _util.merge)(options, {
+    resolve: {
+      baseURI: sanitizedURI
+    }
+  });
+  let parseResult;
+
+  // if refSet was provided, use it to avoid unnecessary parsing
+  if (refSet !== null && refSet.has(sanitizedURI)) {
+    // @ts-ignore
+    ({
+      value: parseResult
+    } = refSet.find((0, _ramda.propEq)(sanitizedURI, 'uri')));
+  } else {
+    parseResult = await (0, _index.default)(uri, mergedOptions);
+  }
+  const file = new _File.default({
+    uri: mergedOptions.resolve.baseURI,
+    parseResult,
+    mediaType: mergedOptions.parse.mediaType
+  });
+  const bundleStrategies = await plugins.filter('canBundle', [file, mergedOptions], mergedOptions.bundle.strategies);
+
+  // we couldn't find any bundle strategy for this File
+  if ((0, _ramda.isEmpty)(bundleStrategies)) {
+    throw new _UnmatchedBundleStrategyError.default(`Could not find a bundle strategy that can bundle the file "${file.uri}"`);
+  }
+  try {
+    const {
+      result
+    } = await plugins.run('bundle', [file, mergedOptions], bundleStrategies);
+    return result;
+  } catch (error) {
+    throw new _BundleError.default(`Error while bundling file "${file.uri}"`, {
+      cause: error
+    });
+  }
+};
+var _default = exports.default = bundle;

package/src/bundle/index.mjs

@@ -0,0 +1,55 @@
+import { isEmpty, propEq } from 'ramda';
+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 parse from "../parse/index.mjs";
+import { merge as mergeOptions } from "../options/util.mjs";
+import * as url from "../util/url.mjs";
+/**
+ * Bundle a file with all its external references to a compound document.
+ */
+const bundle = async (uri, options) => {
+  const {
+    refSet
+  } = options.bundle;
+  const sanitizedURI = url.sanitize(uri);
+  const mergedOptions = mergeOptions(options, {
+    resolve: {
+      baseURI: sanitizedURI
+    }
+  });
+  let parseResult;
+
+  // if refSet was provided, use it to avoid unnecessary parsing
+  if (refSet !== null && refSet.has(sanitizedURI)) {
+    // @ts-ignore
+    ({
+      value: parseResult
+    } = refSet.find(propEq(sanitizedURI, 'uri')));
+  } else {
+    parseResult = await parse(uri, mergedOptions);
+  }
+  const file = new File({
+    uri: mergedOptions.resolve.baseURI,
+    parseResult,
+    mediaType: mergedOptions.parse.mediaType
+  });
+  const bundleStrategies = await plugins.filter('canBundle', [file, mergedOptions], mergedOptions.bundle.strategies);
+
+  // we couldn't find any bundle strategy for this File
+  if (isEmpty(bundleStrategies)) {
+    throw new UnmatchedBundleStrategyError(`Could not find a bundle strategy that can bundle the file "${file.uri}"`);
+  }
+  try {
+    const {
+      result
+    } = await plugins.run('bundle', [file, mergedOptions], bundleStrategies);
+    return result;
+  } catch (error) {
+    throw new BundleError(`Error while bundling file "${file.uri}"`, {
+      cause: error
+    });
+  }
+};
+export default bundle;

package/src/bundle/strategies/BundleStrategy.cjs

@@ -0,0 +1,20 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class BundleStrategy {
+  name;
+  constructor({
+    name
+  }) {
+    this.name = name;
+  }
+}
+var _default = exports.default = BundleStrategy;

package/src/bundle/strategies/BundleStrategy.mjs

@@ -0,0 +1,16 @@
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class BundleStrategy {
+  name;
+  constructor({
+    name
+  }) {
+    this.name = name;
+  }
+}
+export default BundleStrategy;

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

@@ -0,0 +1,35 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-3-1");
+var _BundleStrategy = _interopRequireDefault(require("../BundleStrategy.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class OpenAPI3_1BundleStrategy extends _BundleStrategy.default {
+  constructor(options) {
+    super({
+      ...(options ?? {}),
+      name: 'openapi-3-1'
+    });
+  }
+  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_1Element)(file.parseResult?.result);
+  }
+  async bundle(file) {
+    return file.parseResult;
+  }
+}
+var _default = exports.default = OpenAPI3_1BundleStrategy;

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

@@ -0,0 +1,29 @@
+import { mediaTypes, isOpenApi3_1Element } from '@speclynx/apidom-ns-openapi-3-1';
+import BundleStrategy from "../BundleStrategy.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class OpenAPI3_1BundleStrategy extends BundleStrategy {
+  constructor(options) {
+    super({
+      ...(options ?? {}),
+      name: 'openapi-3-1'
+    });
+  }
+  canBundle(file) {
+    // assert by media type
+    if (file.mediaType !== 'text/plain') {
+      return mediaTypes.includes(file.mediaType);
+    }
+
+    // assert by inspecting ApiDOM
+    return isOpenApi3_1Element(file.parseResult?.result);
+  }
+  async bundle(file) {
+    return file.parseResult;
+  }
+}
+export default OpenAPI3_1BundleStrategy;

package/src/configuration/empty.cjs

@@ -0,0 +1,9 @@
+"use strict";
+
+exports.__esModule = true;
+var _index = require("../index.cjs");
+Object.keys(_index).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _index[key]) return;
+  exports[key] = _index[key];
+});

package/src/configuration/empty.mjs

@@ -0,0 +1 @@
+export * from "../index.mjs";

package/src/configuration/saturated.cjs

@@ -0,0 +1,88 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+var _indexNode = _interopRequireDefault(require("../resolve/resolvers/file/index-node.cjs"));
+var _index = _interopRequireDefault(require("../resolve/resolvers/http-axios/index.cjs"));
+var _index2 = _interopRequireDefault(require("../resolve/strategies/openapi-2/index.cjs"));
+var _index3 = _interopRequireDefault(require("../resolve/strategies/openapi-3-0/index.cjs"));
+var _index4 = _interopRequireDefault(require("../resolve/strategies/openapi-3-1/index.cjs"));
+var _index5 = _interopRequireDefault(require("../resolve/strategies/asyncapi-2/index.cjs"));
+var _index6 = _interopRequireDefault(require("../resolve/strategies/apidom/index.cjs"));
+var _index7 = _interopRequireDefault(require("../parse/parsers/openapi-json-2/index.cjs"));
+var _index8 = _interopRequireDefault(require("../parse/parsers/openapi-yaml-2/index.cjs"));
+var _index9 = _interopRequireDefault(require("../parse/parsers/openapi-json-3-0/index.cjs"));
+var _index0 = _interopRequireDefault(require("../parse/parsers/openapi-yaml-3-0/index.cjs"));
+var _index1 = _interopRequireDefault(require("../parse/parsers/openapi-json-3-1/index.cjs"));
+var _index10 = _interopRequireDefault(require("../parse/parsers/openapi-yaml-3-1/index.cjs"));
+var _index11 = _interopRequireDefault(require("../parse/parsers/asyncapi-json-2/index.cjs"));
+var _index12 = _interopRequireDefault(require("../parse/parsers/asyncapi-yaml-2/index.cjs"));
+var _index13 = _interopRequireDefault(require("../parse/parsers/arazzo-json-1/index.cjs"));
+var _index14 = _interopRequireDefault(require("../parse/parsers/arazzo-yaml-1/index.cjs"));
+var _index15 = _interopRequireDefault(require("../parse/parsers/apidom-json/index.cjs"));
+var _index16 = _interopRequireDefault(require("../parse/parsers/json/index.cjs"));
+var _index17 = _interopRequireDefault(require("../parse/parsers/yaml-1-2/index.cjs"));
+var _indexNode2 = _interopRequireDefault(require("../parse/parsers/binary/index-node.cjs"));
+var _index18 = _interopRequireDefault(require("../dereference/strategies/apidom/index.cjs"));
+var _index19 = _interopRequireDefault(require("../dereference/strategies/openapi-2/index.cjs"));
+var _index20 = _interopRequireDefault(require("../dereference/strategies/openapi-3-0/index.cjs"));
+var _index21 = _interopRequireDefault(require("../dereference/strategies/openapi-3-1/index.cjs"));
+var _index22 = _interopRequireDefault(require("../dereference/strategies/asyncapi-2/index.cjs"));
+var _index23 = _interopRequireDefault(require("../dereference/strategies/arazzo-1/index.cjs"));
+var _index24 = _interopRequireDefault(require("../bundle/strategies/openapi-3-1/index.cjs"));
+var _index25 = require("../index.cjs");
+Object.keys(_index25).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _index25[key]) return;
+  exports[key] = _index25[key];
+});
+_index25.options.parse.parsers = [new _index7.default({
+  allowEmpty: true,
+  sourceMap: false
+}), new _index8.default({
+  allowEmpty: true,
+  sourceMap: false
+}), new _index9.default({
+  allowEmpty: true,
+  sourceMap: false
+}), new _index0.default({
+  allowEmpty: true,
+  sourceMap: false
+}), new _index1.default({
+  allowEmpty: true,
+  sourceMap: false
+}), new _index10.default({
+  allowEmpty: true,
+  sourceMap: false
+}), new _index11.default({
+  allowEmpty: true,
+  sourceMap: false
+}), new _index12.default({
+  allowEmpty: true,
+  sourceMap: false
+}), new _index13.default({
+  allowEmpty: true,
+  sourceMap: false
+}), new _index14.default({
+  allowEmpty: true,
+  sourceMap: false
+}), new _index15.default({
+  allowEmpty: true,
+  sourceMap: false
+}), new _index16.default({
+  allowEmpty: true,
+  sourceMap: false
+}), new _index17.default({
+  allowEmpty: true,
+  sourceMap: false
+}), new _indexNode2.default({
+  allowEmpty: true
+})];
+_index25.options.resolve.resolvers = [new _indexNode.default(), new _index.default({
+  timeout: 5000,
+  redirects: 5,
+  withCredentials: false
+})];
+_index25.options.resolve.strategies = [new _index2.default(), new _index3.default(), new _index4.default(), new _index5.default(), new _index6.default()];
+_index25.options.dereference.strategies = [new _index19.default(), new _index20.default(), new _index21.default(), new _index22.default(), new _index23.default(), new _index18.default()];
+_index25.options.bundle.strategies = [new _index24.default()];