@speclynx/apidom-reference 3.2.1 → 4.0.0

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

@@ -1,43 +0,0 @@
-import ResolveStrategy from "../ResolveStrategy.mjs";
-import ReferenceSet from "../../../ReferenceSet.mjs";
-import { merge as mergeOptions } from "../../../options/util.mjs";
-import UnmatchedDereferenceStrategyError from "../../../errors/UnmatchedDereferenceStrategyError.mjs";
-/**
- * @public
- */
-/**
- * @public
- */
-class AsyncAPI2ResolveStrategy extends ResolveStrategy {
-  constructor(options) {
-    super({
-      ...(options ?? {}),
-      name: 'asyncapi-2'
-    });
-  }
-  canResolve(file, options) {
-    const dereferenceStrategy = options.dereference.strategies.find(strategy => strategy.name === 'asyncapi-2');
-    if (dereferenceStrategy === undefined) {
-      return false;
-    }
-    return dereferenceStrategy.canDereference(file, options);
-  }
-  async resolve(file, options) {
-    const dereferenceStrategy = options.dereference.strategies.find(strategy => strategy.name === 'asyncapi-2');
-    if (dereferenceStrategy === undefined) {
-      throw new UnmatchedDereferenceStrategyError(`"asyncapi-2" resolve strategy requires "asyncapi-2" dereference strategy to be configured for file "${file.uri}"`);
-    }
-    const refSet = new ReferenceSet();
-    const mergedOptions = mergeOptions(options, {
-      resolve: {
-        internal: false
-      },
-      dereference: {
-        refSet
-      }
-    });
-    await dereferenceStrategy.dereference(file, mergedOptions);
-    return refSet;
-  }
-}
-export default AsyncAPI2ResolveStrategy;

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

@@ -1,49 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _ResolveStrategy = _interopRequireDefault(require("../ResolveStrategy.cjs"));
-var _ReferenceSet = _interopRequireDefault(require("../../../ReferenceSet.cjs"));
-var _util = require("../../../options/util.cjs");
-var _UnmatchedDereferenceStrategyError = _interopRequireDefault(require("../../../errors/UnmatchedDereferenceStrategyError.cjs"));
-/**
- * @public
- */
-
-/**
- * @public
- */
-class OpenAPI2ResolveStrategy extends _ResolveStrategy.default {
-  constructor(options) {
-    super({
-      ...(options ?? {}),
-      name: 'openapi-2'
-    });
-  }
-  canResolve(file, options) {
-    const dereferenceStrategy = options.dereference.strategies.find(strategy => strategy.name === 'openapi-2');
-    if (dereferenceStrategy === undefined) {
-      return false;
-    }
-    return dereferenceStrategy.canDereference(file, options);
-  }
-  async resolve(file, options) {
-    const dereferenceStrategy = options.dereference.strategies.find(strategy => strategy.name === 'openapi-2');
-    if (dereferenceStrategy === undefined) {
-      throw new _UnmatchedDereferenceStrategyError.default(`"openapi-2" resolve strategy requires "openapi-2" dereference strategy to be configured for file "${file.uri}"`);
-    }
-    const refSet = new _ReferenceSet.default();
-    const mergedOptions = (0, _util.merge)(options, {
-      resolve: {
-        internal: false
-      },
-      dereference: {
-        refSet
-      }
-    });
-    await dereferenceStrategy.dereference(file, mergedOptions);
-    return refSet;
-  }
-}
-var _default = exports.default = OpenAPI2ResolveStrategy;

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

@@ -1,43 +0,0 @@
-import ResolveStrategy from "../ResolveStrategy.mjs";
-import ReferenceSet from "../../../ReferenceSet.mjs";
-import { merge as mergeOptions } from "../../../options/util.mjs";
-import UnmatchedDereferenceStrategyError from "../../../errors/UnmatchedDereferenceStrategyError.mjs";
-/**
- * @public
- */
-/**
- * @public
- */
-class OpenAPI2ResolveStrategy extends ResolveStrategy {
-  constructor(options) {
-    super({
-      ...(options ?? {}),
-      name: 'openapi-2'
-    });
-  }
-  canResolve(file, options) {
-    const dereferenceStrategy = options.dereference.strategies.find(strategy => strategy.name === 'openapi-2');
-    if (dereferenceStrategy === undefined) {
-      return false;
-    }
-    return dereferenceStrategy.canDereference(file, options);
-  }
-  async resolve(file, options) {
-    const dereferenceStrategy = options.dereference.strategies.find(strategy => strategy.name === 'openapi-2');
-    if (dereferenceStrategy === undefined) {
-      throw new UnmatchedDereferenceStrategyError(`"openapi-2" resolve strategy requires "openapi-2" dereference strategy to be configured for file "${file.uri}"`);
-    }
-    const refSet = new ReferenceSet();
-    const mergedOptions = mergeOptions(options, {
-      resolve: {
-        internal: false
-      },
-      dereference: {
-        refSet
-      }
-    });
-    await dereferenceStrategy.dereference(file, mergedOptions);
-    return refSet;
-  }
-}
-export default OpenAPI2ResolveStrategy;

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

@@ -1,49 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _ResolveStrategy = _interopRequireDefault(require("../ResolveStrategy.cjs"));
-var _ReferenceSet = _interopRequireDefault(require("../../../ReferenceSet.cjs"));
-var _util = require("../../../options/util.cjs");
-var _UnmatchedDereferenceStrategyError = _interopRequireDefault(require("../../../errors/UnmatchedDereferenceStrategyError.cjs"));
-/**
- * @public
- */
-
-/**
- * @public
- */
-class OpenAPI3_0ResolveStrategy extends _ResolveStrategy.default {
-  constructor(options) {
-    super({
-      ...(options ?? {}),
-      name: 'openapi-3-0'
-    });
-  }
-  canResolve(file, options) {
-    const dereferenceStrategy = options.dereference.strategies.find(strategy => strategy.name === 'openapi-3-0');
-    if (dereferenceStrategy === undefined) {
-      return false;
-    }
-    return dereferenceStrategy.canDereference(file, options);
-  }
-  async resolve(file, options) {
-    const dereferenceStrategy = options.dereference.strategies.find(strategy => strategy.name === 'openapi-3-0');
-    if (dereferenceStrategy === undefined) {
-      throw new _UnmatchedDereferenceStrategyError.default(`"openapi-3-0" resolve strategy requires "openapi-3-0" dereference strategy to be configured for file "${file.uri}"`);
-    }
-    const refSet = new _ReferenceSet.default();
-    const mergedOptions = (0, _util.merge)(options, {
-      resolve: {
-        internal: false
-      },
-      dereference: {
-        refSet
-      }
-    });
-    await dereferenceStrategy.dereference(file, mergedOptions);
-    return refSet;
-  }
-}
-var _default = exports.default = OpenAPI3_0ResolveStrategy;

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

@@ -1,43 +0,0 @@
-import ResolveStrategy from "../ResolveStrategy.mjs";
-import ReferenceSet from "../../../ReferenceSet.mjs";
-import { merge as mergeOptions } from "../../../options/util.mjs";
-import UnmatchedDereferenceStrategyError from "../../../errors/UnmatchedDereferenceStrategyError.mjs";
-/**
- * @public
- */
-/**
- * @public
- */
-class OpenAPI3_0ResolveStrategy extends ResolveStrategy {
-  constructor(options) {
-    super({
-      ...(options ?? {}),
-      name: 'openapi-3-0'
-    });
-  }
-  canResolve(file, options) {
-    const dereferenceStrategy = options.dereference.strategies.find(strategy => strategy.name === 'openapi-3-0');
-    if (dereferenceStrategy === undefined) {
-      return false;
-    }
-    return dereferenceStrategy.canDereference(file, options);
-  }
-  async resolve(file, options) {
-    const dereferenceStrategy = options.dereference.strategies.find(strategy => strategy.name === 'openapi-3-0');
-    if (dereferenceStrategy === undefined) {
-      throw new UnmatchedDereferenceStrategyError(`"openapi-3-0" resolve strategy requires "openapi-3-0" dereference strategy to be configured for file "${file.uri}"`);
-    }
-    const refSet = new ReferenceSet();
-    const mergedOptions = mergeOptions(options, {
-      resolve: {
-        internal: false
-      },
-      dereference: {
-        refSet
-      }
-    });
-    await dereferenceStrategy.dereference(file, mergedOptions);
-    return refSet;
-  }
-}
-export default OpenAPI3_0ResolveStrategy;

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

@@ -1,49 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _ResolveStrategy = _interopRequireDefault(require("../ResolveStrategy.cjs"));
-var _ReferenceSet = _interopRequireDefault(require("../../../ReferenceSet.cjs"));
-var _util = require("../../../options/util.cjs");
-var _UnmatchedDereferenceStrategyError = _interopRequireDefault(require("../../../errors/UnmatchedDereferenceStrategyError.cjs"));
-/**
- * @public
- */
-
-/**
- * @public
- */
-class OpenAPI3_1ResolveStrategy extends _ResolveStrategy.default {
-  constructor(options) {
-    super({
-      ...(options ?? {}),
-      name: 'openapi-3-1'
-    });
-  }
-  canResolve(file, options) {
-    const dereferenceStrategy = options.dereference.strategies.find(strategy => strategy.name === 'openapi-3-1');
-    if (dereferenceStrategy === undefined) {
-      return false;
-    }
-    return dereferenceStrategy.canDereference(file, options);
-  }
-  async resolve(file, options) {
-    const dereferenceStrategy = options.dereference.strategies.find(strategy => strategy.name === 'openapi-3-1');
-    if (dereferenceStrategy === undefined) {
-      throw new _UnmatchedDereferenceStrategyError.default(`"openapi-3-1" resolve strategy requires "openapi-3-1" dereference strategy to be configured for file "${file.uri}"`);
-    }
-    const refSet = new _ReferenceSet.default();
-    const mergedOptions = (0, _util.merge)(options, {
-      resolve: {
-        internal: false
-      },
-      dereference: {
-        refSet
-      }
-    });
-    await dereferenceStrategy.dereference(file, mergedOptions);
-    return refSet;
-  }
-}
-var _default = exports.default = OpenAPI3_1ResolveStrategy;

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

@@ -1,43 +0,0 @@
-import ResolveStrategy from "../ResolveStrategy.mjs";
-import ReferenceSet from "../../../ReferenceSet.mjs";
-import { merge as mergeOptions } from "../../../options/util.mjs";
-import UnmatchedDereferenceStrategyError from "../../../errors/UnmatchedDereferenceStrategyError.mjs";
-/**
- * @public
- */
-/**
- * @public
- */
-class OpenAPI3_1ResolveStrategy extends ResolveStrategy {
-  constructor(options) {
-    super({
-      ...(options ?? {}),
-      name: 'openapi-3-1'
-    });
-  }
-  canResolve(file, options) {
-    const dereferenceStrategy = options.dereference.strategies.find(strategy => strategy.name === 'openapi-3-1');
-    if (dereferenceStrategy === undefined) {
-      return false;
-    }
-    return dereferenceStrategy.canDereference(file, options);
-  }
-  async resolve(file, options) {
-    const dereferenceStrategy = options.dereference.strategies.find(strategy => strategy.name === 'openapi-3-1');
-    if (dereferenceStrategy === undefined) {
-      throw new UnmatchedDereferenceStrategyError(`"openapi-3-1" resolve strategy requires "openapi-3-1" dereference strategy to be configured for file "${file.uri}"`);
-    }
-    const refSet = new ReferenceSet();
-    const mergedOptions = mergeOptions(options, {
-      resolve: {
-        internal: false
-      },
-      dereference: {
-        refSet
-      }
-    });
-    await dereferenceStrategy.dereference(file, mergedOptions);
-    return refSet;
-  }
-}
-export default OpenAPI3_1ResolveStrategy;

package/src/resolve/util.cjs

@@ -1,37 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
-exports.__esModule = true;
-exports.readFile = void 0;
-var _ramda = require("ramda");
-var plugins = _interopRequireWildcard(require("../util/plugins.cjs"));
-var _ResolveError = _interopRequireDefault(require("../errors/ResolveError.cjs"));
-var _UnmatchedResolverError = _interopRequireDefault(require("../errors/UnmatchedResolverError.cjs"));
-/**
- * Reads the given file, using the configured resolver plugins.
- */
-
-const readFile = async (file, options) => {
-  const optsBoundResolvers = options.resolve.resolvers.map(resolver => {
-    const clonedResolver = Object.create(resolver);
-    return Object.assign(clonedResolver, options.resolve.resolverOpts);
-  });
-  const resolvers = await plugins.filter('canRead', [file, options], optsBoundResolvers);
-
-  // we couldn't find any resolver for this File
-  if ((0, _ramda.isEmpty)(resolvers)) {
-    throw new _UnmatchedResolverError.default(`Could not find a resolver that can read the file "${file.uri}"`);
-  }
-  try {
-    const {
-      result
-    } = await plugins.run('read', [file, options], resolvers);
-    return result;
-  } catch (error) {
-    throw new _ResolveError.default(`Error while reading file "${file.uri}"`, {
-      cause: error
-    });
-  }
-};
-exports.readFile = readFile;

package/src/resolve/util.mjs

@@ -1,30 +0,0 @@
-import { isEmpty } from 'ramda';
-import * as plugins from "../util/plugins.mjs";
-import ResolveError from "../errors/ResolveError.mjs";
-import UnmatchedResolverError from "../errors/UnmatchedResolverError.mjs";
-/**
- * Reads the given file, using the configured resolver plugins.
- */
-
-export const readFile = async (file, options) => {
-  const optsBoundResolvers = options.resolve.resolvers.map(resolver => {
-    const clonedResolver = Object.create(resolver);
-    return Object.assign(clonedResolver, options.resolve.resolverOpts);
-  });
-  const resolvers = await plugins.filter('canRead', [file, options], optsBoundResolvers);
-
-  // we couldn't find any resolver for this File
-  if (isEmpty(resolvers)) {
-    throw new UnmatchedResolverError(`Could not find a resolver that can read the file "${file.uri}"`);
-  }
-  try {
-    const {
-      result
-    } = await plugins.run('read', [file, options], resolvers);
-    return result;
-  } catch (error) {
-    throw new ResolveError(`Error while reading file "${file.uri}"`, {
-      cause: error
-    });
-  }
-};

package/src/util/plugins.cjs

@@ -1,39 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.run = exports.filter = void 0;
-var _ramdaAdjunct = require("ramda-adjunct");
-/**
- * Filters the given plugins, returning only the ones return `true` for the given method.
- */
-const filter = async (method, parameters, plugins) => {
-  const pluginResults = await Promise.all(plugins.map((0, _ramdaAdjunct.invokeArgs)([method], parameters)));
-  return plugins.filter((plugin, index) => pluginResults[index]);
-};
-
-/**
- * Runs the specified method of the given plugins, in order,
- * until one of them returns a successful result.
- * Each method can return a synchronous value or a Promise.
- * If the promise resolves successfully then the result
- * is immediately returned and no further plugins are called.
- * If the promise rejects then the next plugin is called.
- * If ALL plugins fail, then the last error is thrown.
- */
-exports.filter = filter;
-const run = async (method, parameters, plugins) => {
-  let lastError;
-  for (const plugin of plugins) {
-    try {
-      const result = await plugin[method].call(plugin, ...parameters);
-      return {
-        plugin,
-        result
-      };
-    } catch (error) {
-      lastError = error;
-    }
-  }
-  return Promise.reject(lastError);
-};
-exports.run = run;

package/src/util/plugins.mjs

@@ -1,34 +0,0 @@
-import { invokeArgs } from 'ramda-adjunct';
-
-/**
- * Filters the given plugins, returning only the ones return `true` for the given method.
- */
-export const filter = async (method, parameters, plugins) => {
-  const pluginResults = await Promise.all(plugins.map(invokeArgs([method], parameters)));
-  return plugins.filter((plugin, index) => pluginResults[index]);
-};
-
-/**
- * Runs the specified method of the given plugins, in order,
- * until one of them returns a successful result.
- * Each method can return a synchronous value or a Promise.
- * If the promise resolves successfully then the result
- * is immediately returned and no further plugins are called.
- * If the promise rejects then the next plugin is called.
- * If ALL plugins fail, then the last error is thrown.
- */
-export const run = async (method, parameters, plugins) => {
-  let lastError;
-  for (const plugin of plugins) {
-    try {
-      const result = await plugin[method].call(plugin, ...parameters);
-      return {
-        plugin,
-        result
-      };
-    } catch (error) {
-      lastError = error;
-    }
-  }
-  return Promise.reject(lastError);
-};