@speclynx/apidom-reference 4.0.1 → 4.0.3

package/src/parse/parsers/openapi-yaml-3-0/index.cjs

@@ -0,0 +1,54 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _ramda = require("ramda");
+var _apidomParserAdapterOpenapiYaml = require("@speclynx/apidom-parser-adapter-openapi-yaml-3-0");
+var _ParserError = _interopRequireDefault(require("../../../errors/ParserError.cjs"));
+var _Parser = _interopRequireDefault(require("../Parser.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class OpenAPIYAML3_0Parser extends _Parser.default {
+  refractorOpts;
+  constructor(options) {
+    const {
+      fileExtensions = [],
+      mediaTypes = _apidomParserAdapterOpenapiYaml.mediaTypes,
+      ...rest
+    } = options ?? {};
+    super({
+      ...rest,
+      name: 'openapi-yaml-3-0',
+      fileExtensions,
+      mediaTypes
+    });
+  }
+  async canParse(file) {
+    const hasSupportedFileExtension = this.fileExtensions.length === 0 ? true : this.fileExtensions.includes(file.extension);
+    const hasSupportedMediaType = this.mediaTypes.includes(file.mediaType);
+    if (!hasSupportedFileExtension) return false;
+    if (hasSupportedMediaType) return true;
+    if (!hasSupportedMediaType) {
+      return (0, _apidomParserAdapterOpenapiYaml.detect)(file.toString());
+    }
+    return false;
+  }
+  async parse(file) {
+    const source = file.toString();
+    try {
+      const parserOpts = (0, _ramda.pick)(['sourceMap', 'style', 'strict', 'refractorOpts'], this);
+      return await (0, _apidomParserAdapterOpenapiYaml.parse)(source, parserOpts);
+    } catch (error) {
+      throw new _ParserError.default(`Error parsing "${file.uri}"`, {
+        cause: error
+      });
+    }
+  }
+}
+var _default = exports.default = OpenAPIYAML3_0Parser;

package/src/parse/parsers/openapi-yaml-3-0/index.mjs

@@ -0,0 +1,48 @@
+import { pick } from 'ramda';
+import { parse, mediaTypes as OpenAPIYAML3_0MediaTypes, detect } from '@speclynx/apidom-parser-adapter-openapi-yaml-3-0';
+import ParserError from "../../../errors/ParserError.mjs";
+import Parser from "../Parser.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class OpenAPIYAML3_0Parser extends Parser {
+  refractorOpts;
+  constructor(options) {
+    const {
+      fileExtensions = [],
+      mediaTypes = OpenAPIYAML3_0MediaTypes,
+      ...rest
+    } = options ?? {};
+    super({
+      ...rest,
+      name: 'openapi-yaml-3-0',
+      fileExtensions,
+      mediaTypes
+    });
+  }
+  async canParse(file) {
+    const hasSupportedFileExtension = this.fileExtensions.length === 0 ? true : this.fileExtensions.includes(file.extension);
+    const hasSupportedMediaType = this.mediaTypes.includes(file.mediaType);
+    if (!hasSupportedFileExtension) return false;
+    if (hasSupportedMediaType) return true;
+    if (!hasSupportedMediaType) {
+      return detect(file.toString());
+    }
+    return false;
+  }
+  async parse(file) {
+    const source = file.toString();
+    try {
+      const parserOpts = pick(['sourceMap', 'style', 'strict', 'refractorOpts'], this);
+      return await parse(source, parserOpts);
+    } catch (error) {
+      throw new ParserError(`Error parsing "${file.uri}"`, {
+        cause: error
+      });
+    }
+  }
+}
+export default OpenAPIYAML3_0Parser;

package/src/parse/parsers/openapi-yaml-3-0/index.ts

@@ -0,0 +1,59 @@
+import { pick } from 'ramda';
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
+import {
+  parse,
+  mediaTypes as OpenAPIYAML3_0MediaTypes,
+  detect,
+} from '@speclynx/apidom-parser-adapter-openapi-yaml-3-0';
+
+import ParserError from '../../../errors/ParserError.ts';
+import Parser, { ParserOptions } from '../Parser.ts';
+import File from '../../../File.ts';
+
+export type { default as Parser, ParserOptions } from '../Parser.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+
+/**
+ * @public
+ */
+
+export interface OpenAPIYAML3_0ParserOptions extends Omit<ParserOptions, 'name'> {}
+
+/**
+ * @public
+ */
+class OpenAPIYAML3_0Parser extends Parser {
+  public refractorOpts!: object;
+
+  constructor(options?: OpenAPIYAML3_0ParserOptions) {
+    const { fileExtensions = [], mediaTypes = OpenAPIYAML3_0MediaTypes, ...rest } = options ?? {};
+
+    super({ ...rest, name: 'openapi-yaml-3-0', fileExtensions, mediaTypes });
+  }
+
+  async canParse(file: File): Promise<boolean> {
+    const hasSupportedFileExtension =
+      this.fileExtensions.length === 0 ? true : this.fileExtensions.includes(file.extension);
+    const hasSupportedMediaType = this.mediaTypes.includes(file.mediaType);
+
+    if (!hasSupportedFileExtension) return false;
+    if (hasSupportedMediaType) return true;
+    if (!hasSupportedMediaType) {
+      return detect(file.toString());
+    }
+    return false;
+  }
+
+  async parse(file: File): Promise<ParseResultElement> {
+    const source = file.toString();
+
+    try {
+      const parserOpts = pick(['sourceMap', 'style', 'strict', 'refractorOpts'], this);
+      return await parse(source, parserOpts);
+    } catch (error: unknown) {
+      throw new ParserError(`Error parsing "${file.uri}"`, { cause: error });
+    }
+  }
+}
+
+export default OpenAPIYAML3_0Parser;

package/src/parse/parsers/openapi-yaml-3-1/index.cjs

@@ -0,0 +1,54 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _ramda = require("ramda");
+var _apidomParserAdapterOpenapiYaml = require("@speclynx/apidom-parser-adapter-openapi-yaml-3-1");
+var _ParserError = _interopRequireDefault(require("../../../errors/ParserError.cjs"));
+var _Parser = _interopRequireDefault(require("../Parser.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class OpenAPIYAML3_1Parser extends _Parser.default {
+  refractorOpts;
+  constructor(options) {
+    const {
+      fileExtensions = [],
+      mediaTypes = _apidomParserAdapterOpenapiYaml.mediaTypes,
+      ...rest
+    } = options ?? {};
+    super({
+      ...rest,
+      name: 'openapi-yaml-3-1',
+      fileExtensions,
+      mediaTypes
+    });
+  }
+  async canParse(file) {
+    const hasSupportedFileExtension = this.fileExtensions.length === 0 ? true : this.fileExtensions.includes(file.extension);
+    const hasSupportedMediaType = this.mediaTypes.includes(file.mediaType);
+    if (!hasSupportedFileExtension) return false;
+    if (hasSupportedMediaType) return true;
+    if (!hasSupportedMediaType) {
+      return (0, _apidomParserAdapterOpenapiYaml.detect)(file.toString());
+    }
+    return false;
+  }
+  async parse(file) {
+    const source = file.toString();
+    try {
+      const parserOpts = (0, _ramda.pick)(['sourceMap', 'style', 'strict', 'refractorOpts'], this);
+      return await (0, _apidomParserAdapterOpenapiYaml.parse)(source, parserOpts);
+    } catch (error) {
+      throw new _ParserError.default(`Error parsing "${file.uri}"`, {
+        cause: error
+      });
+    }
+  }
+}
+var _default = exports.default = OpenAPIYAML3_1Parser;

package/src/parse/parsers/openapi-yaml-3-1/index.mjs

@@ -0,0 +1,48 @@
+import { pick } from 'ramda';
+import { parse, mediaTypes as OpenAPIYAML3_1MediaTypes, detect } from '@speclynx/apidom-parser-adapter-openapi-yaml-3-1';
+import ParserError from "../../../errors/ParserError.mjs";
+import Parser from "../Parser.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class OpenAPIYAML3_1Parser extends Parser {
+  refractorOpts;
+  constructor(options) {
+    const {
+      fileExtensions = [],
+      mediaTypes = OpenAPIYAML3_1MediaTypes,
+      ...rest
+    } = options ?? {};
+    super({
+      ...rest,
+      name: 'openapi-yaml-3-1',
+      fileExtensions,
+      mediaTypes
+    });
+  }
+  async canParse(file) {
+    const hasSupportedFileExtension = this.fileExtensions.length === 0 ? true : this.fileExtensions.includes(file.extension);
+    const hasSupportedMediaType = this.mediaTypes.includes(file.mediaType);
+    if (!hasSupportedFileExtension) return false;
+    if (hasSupportedMediaType) return true;
+    if (!hasSupportedMediaType) {
+      return detect(file.toString());
+    }
+    return false;
+  }
+  async parse(file) {
+    const source = file.toString();
+    try {
+      const parserOpts = pick(['sourceMap', 'style', 'strict', 'refractorOpts'], this);
+      return await parse(source, parserOpts);
+    } catch (error) {
+      throw new ParserError(`Error parsing "${file.uri}"`, {
+        cause: error
+      });
+    }
+  }
+}
+export default OpenAPIYAML3_1Parser;

package/src/parse/parsers/openapi-yaml-3-1/index.ts

@@ -0,0 +1,59 @@
+import { pick } from 'ramda';
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
+import {
+  parse,
+  mediaTypes as OpenAPIYAML3_1MediaTypes,
+  detect,
+} from '@speclynx/apidom-parser-adapter-openapi-yaml-3-1';
+
+import ParserError from '../../../errors/ParserError.ts';
+import Parser, { ParserOptions } from '../Parser.ts';
+import File from '../../../File.ts';
+
+export type { default as Parser, ParserOptions } from '../Parser.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+
+/**
+ * @public
+ */
+
+export interface OpenAPIYAML3_1ParserOptions extends Omit<ParserOptions, 'name'> {}
+
+/**
+ * @public
+ */
+class OpenAPIYAML3_1Parser extends Parser {
+  public refractorOpts!: object;
+
+  constructor(options?: OpenAPIYAML3_1ParserOptions) {
+    const { fileExtensions = [], mediaTypes = OpenAPIYAML3_1MediaTypes, ...rest } = options ?? {};
+
+    super({ ...rest, name: 'openapi-yaml-3-1', fileExtensions, mediaTypes });
+  }
+
+  async canParse(file: File): Promise<boolean> {
+    const hasSupportedFileExtension =
+      this.fileExtensions.length === 0 ? true : this.fileExtensions.includes(file.extension);
+    const hasSupportedMediaType = this.mediaTypes.includes(file.mediaType);
+
+    if (!hasSupportedFileExtension) return false;
+    if (hasSupportedMediaType) return true;
+    if (!hasSupportedMediaType) {
+      return detect(file.toString());
+    }
+    return false;
+  }
+
+  async parse(file: File): Promise<ParseResultElement> {
+    const source = file.toString();
+
+    try {
+      const parserOpts = pick(['sourceMap', 'style', 'strict', 'refractorOpts'], this);
+      return await parse(source, parserOpts);
+    } catch (error: unknown) {
+      throw new ParserError(`Error parsing "${file.uri}"`, { cause: error });
+    }
+  }
+}
+
+export default OpenAPIYAML3_1Parser;

package/src/parse/parsers/yaml-1-2/index.cjs

@@ -0,0 +1,56 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomParserAdapterYaml = require("@speclynx/apidom-parser-adapter-yaml-1-2");
+var _ParserError = _interopRequireDefault(require("../../../errors/ParserError.cjs"));
+var _Parser = _interopRequireDefault(require("../Parser.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class YAML1Parser extends _Parser.default {
+  refractorOpts;
+  constructor(options) {
+    const {
+      fileExtensions = [],
+      mediaTypes = _apidomParserAdapterYaml.mediaTypes,
+      ...rest
+    } = options ?? {};
+    super({
+      ...rest,
+      name: 'yaml-1-2',
+      fileExtensions,
+      mediaTypes
+    });
+  }
+  async canParse(file) {
+    const hasSupportedFileExtension = this.fileExtensions.length === 0 ? true : this.fileExtensions.includes(file.extension);
+    const hasSupportedMediaType = this.mediaTypes.includes(file.mediaType);
+    if (!hasSupportedFileExtension) return false;
+    if (hasSupportedMediaType) return true;
+    if (!hasSupportedMediaType) {
+      return (0, _apidomParserAdapterYaml.detect)(file.toString());
+    }
+    return false;
+  }
+  async parse(file) {
+    const source = file.toString();
+    try {
+      return await (0, _apidomParserAdapterYaml.parse)(source, {
+        sourceMap: this.sourceMap,
+        style: this.style,
+        strict: this.strict
+      });
+    } catch (error) {
+      throw new _ParserError.default(`Error parsing "${file.uri}"`, {
+        cause: error
+      });
+    }
+  }
+}
+var _default = exports.default = YAML1Parser;

package/src/parse/parsers/yaml-1-2/index.mjs

@@ -0,0 +1,50 @@
+import { parse, mediaTypes as YAMLMediaTypes, detect } from '@speclynx/apidom-parser-adapter-yaml-1-2';
+import ParserError from "../../../errors/ParserError.mjs";
+import Parser from "../Parser.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class YAML1Parser extends Parser {
+  refractorOpts;
+  constructor(options) {
+    const {
+      fileExtensions = [],
+      mediaTypes = YAMLMediaTypes,
+      ...rest
+    } = options ?? {};
+    super({
+      ...rest,
+      name: 'yaml-1-2',
+      fileExtensions,
+      mediaTypes
+    });
+  }
+  async canParse(file) {
+    const hasSupportedFileExtension = this.fileExtensions.length === 0 ? true : this.fileExtensions.includes(file.extension);
+    const hasSupportedMediaType = this.mediaTypes.includes(file.mediaType);
+    if (!hasSupportedFileExtension) return false;
+    if (hasSupportedMediaType) return true;
+    if (!hasSupportedMediaType) {
+      return detect(file.toString());
+    }
+    return false;
+  }
+  async parse(file) {
+    const source = file.toString();
+    try {
+      return await parse(source, {
+        sourceMap: this.sourceMap,
+        style: this.style,
+        strict: this.strict
+      });
+    } catch (error) {
+      throw new ParserError(`Error parsing "${file.uri}"`, {
+        cause: error
+      });
+    }
+  }
+}
+export default YAML1Parser;

package/src/parse/parsers/yaml-1-2/index.ts

@@ -0,0 +1,60 @@
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
+import {
+  parse,
+  mediaTypes as YAMLMediaTypes,
+  detect,
+} from '@speclynx/apidom-parser-adapter-yaml-1-2';
+
+import ParserError from '../../../errors/ParserError.ts';
+import Parser, { ParserOptions } from '../Parser.ts';
+import File from '../../../File.ts';
+
+export type { default as Parser, ParserOptions } from '../Parser.ts';
+export type { default as File, FileOptions } from '../../../File.ts';
+
+/**
+ * @public
+ */
+export interface YAMLParserOptions extends Omit<ParserOptions, 'name'> {}
+
+/**
+ * @public
+ */
+class YAML1Parser extends Parser {
+  public refractorOpts!: object;
+
+  constructor(options?: YAMLParserOptions) {
+    const { fileExtensions = [], mediaTypes = YAMLMediaTypes, ...rest } = options ?? {};
+
+    super({ ...rest, name: 'yaml-1-2', fileExtensions, mediaTypes });
+  }
+
+  async canParse(file: File): Promise<boolean> {
+    const hasSupportedFileExtension =
+      this.fileExtensions.length === 0 ? true : this.fileExtensions.includes(file.extension);
+    const hasSupportedMediaType = this.mediaTypes.includes(file.mediaType);
+
+    if (!hasSupportedFileExtension) return false;
+    if (hasSupportedMediaType) return true;
+    if (!hasSupportedMediaType) {
+      return detect(file.toString());
+    }
+    return false;
+  }
+
+  async parse(file: File): Promise<ParseResultElement> {
+    const source = file.toString();
+
+    try {
+      return await parse(source, {
+        sourceMap: this.sourceMap,
+        style: this.style,
+        strict: this.strict,
+      });
+    } catch (error: unknown) {
+      throw new ParserError(`Error parsing "${file.uri}"`, { cause: error });
+    }
+  }
+}
+
+export default YAML1Parser;

package/src/resolve/index.cjs

@@ -0,0 +1,67 @@
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.resolveApiDOM = exports.default = void 0;
+var _ramda = require("ramda");
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+var _util = require("../options/util.cjs");
+var _index = _interopRequireDefault(require("../parse/index.cjs"));
+var plugins = _interopRequireWildcard(require("../util/plugins.cjs"));
+var _File = _interopRequireDefault(require("../File.cjs"));
+var _ResolverError = _interopRequireDefault(require("../errors/ResolverError.cjs"));
+var _UnmatchedResolveStrategyError = _interopRequireDefault(require("../errors/UnmatchedResolveStrategyError.cjs"));
+var url = _interopRequireWildcard(require("../util/url.cjs"));
+/**
+ * Resolves ApiDOM with all its external references.
+ */
+const resolveApiDOM = async (element, options) => {
+  // @ts-ignore
+  let parseResult = element;
+
+  // wrap element into parse result
+  if (!(0, _apidomDatamodel.isParseResultElement)(element)) {
+    // shallow clone of the element
+    const elementClone = (0, _apidomDatamodel.cloneShallow)(element);
+    elementClone.classes.push('result');
+    parseResult = new _apidomDatamodel.ParseResultElement([elementClone]);
+  }
+  const sanitizedURI = url.sanitize(url.stripHash(options.resolve.baseURI));
+  const file = new _File.default({
+    uri: sanitizedURI,
+    parseResult,
+    mediaType: options.parse.mediaType
+  });
+  const resolveStrategies = await plugins.filter('canResolve', [file, options], options.resolve.strategies);
+
+  // we couldn't find any resolve strategy for this File
+  if ((0, _ramda.isEmpty)(resolveStrategies)) {
+    throw new _UnmatchedResolveStrategyError.default(`Could not find a resolve strategy that can resolve the file "${file.uri}"`);
+  }
+  try {
+    const {
+      result
+    } = await plugins.run('resolve', [file, options], resolveStrategies);
+    return result;
+  } catch (error) {
+    throw new _ResolverError.default(`Error while resolving file "${file.uri}"`, {
+      cause: error
+    });
+  }
+};
+
+/**
+ * Resolves a file with all its external references.
+ */
+exports.resolveApiDOM = resolveApiDOM;
+const resolve = async (uri, options) => {
+  const parseResult = await (0, _index.default)(uri, options);
+  const mergedOptions = (0, _util.merge)(options, {
+    resolve: {
+      baseURI: url.sanitize(uri)
+    }
+  });
+  return resolveApiDOM(parseResult, mergedOptions);
+};
+var _default = exports.default = resolve;

package/src/resolve/index.mjs

@@ -0,0 +1,60 @@
+import { isEmpty } from 'ramda';
+import { isParseResultElement, ParseResultElement, cloneShallow } from '@speclynx/apidom-datamodel';
+import { merge as mergeOptions } from "../options/util.mjs";
+import parse from "../parse/index.mjs";
+import * as plugins from "../util/plugins.mjs";
+import File from "../File.mjs";
+import ResolveError from "../errors/ResolverError.mjs";
+import UnmatchedResolveStrategyError from "../errors/UnmatchedResolveStrategyError.mjs";
+import * as url from "../util/url.mjs";
+/**
+ * Resolves ApiDOM with all its external references.
+ */
+export const resolveApiDOM = async (element, options) => {
+  // @ts-ignore
+  let parseResult = element;
+
+  // wrap element into parse result
+  if (!isParseResultElement(element)) {
+    // shallow clone of the element
+    const elementClone = cloneShallow(element);
+    elementClone.classes.push('result');
+    parseResult = new ParseResultElement([elementClone]);
+  }
+  const sanitizedURI = url.sanitize(url.stripHash(options.resolve.baseURI));
+  const file = new File({
+    uri: sanitizedURI,
+    parseResult,
+    mediaType: options.parse.mediaType
+  });
+  const resolveStrategies = await plugins.filter('canResolve', [file, options], options.resolve.strategies);
+
+  // we couldn't find any resolve strategy for this File
+  if (isEmpty(resolveStrategies)) {
+    throw new UnmatchedResolveStrategyError(`Could not find a resolve strategy that can resolve the file "${file.uri}"`);
+  }
+  try {
+    const {
+      result
+    } = await plugins.run('resolve', [file, options], resolveStrategies);
+    return result;
+  } catch (error) {
+    throw new ResolveError(`Error while resolving file "${file.uri}"`, {
+      cause: error
+    });
+  }
+};
+
+/**
+ * Resolves a file with all its external references.
+ */
+const resolve = async (uri, options) => {
+  const parseResult = await parse(uri, options);
+  const mergedOptions = mergeOptions(options, {
+    resolve: {
+      baseURI: url.sanitize(uri)
+    }
+  });
+  return resolveApiDOM(parseResult, mergedOptions);
+};
+export default resolve;