@speclynx/apidom-reference 1.12.1

package/src/parse/parsers/Parser.mjs

@@ -0,0 +1,44 @@
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class Parser {
+  name;
+
+  /**
+   * Whether to allow "empty" files. This includes zero-byte files.
+   */
+  allowEmpty;
+
+  /**
+   * Whether to generate source map during parsing.
+   */
+  sourceMap;
+
+  /**
+   * List of supported file extensions.
+   */
+  fileExtensions;
+
+  /**
+   * List of supported media types.
+   */
+  mediaTypes;
+  constructor({
+    name,
+    allowEmpty = true,
+    sourceMap = false,
+    fileExtensions = [],
+    mediaTypes = []
+  }) {
+    this.name = name;
+    this.allowEmpty = allowEmpty;
+    this.sourceMap = sourceMap;
+    this.fileExtensions = fileExtensions;
+    this.mediaTypes = mediaTypes;
+  }
+}
+export default Parser;

package/src/parse/parsers/api-design-systems-json/index.cjs

@@ -0,0 +1,55 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _ramda = require("ramda");
+var _apidomParserAdapterApiDesignSystemsJson = require("@speclynx/apidom-parser-adapter-api-design-systems-json");
+var _ParserError = _interopRequireDefault(require("../../../errors/ParserError.cjs"));
+var _Parser = _interopRequireDefault(require("../Parser.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class APIDesignSystemsJSONParser extends _Parser.default {
+  syntacticAnalysis;
+  refractorOpts;
+  constructor(options) {
+    const {
+      fileExtensions = [],
+      mediaTypes = _apidomParserAdapterApiDesignSystemsJson.mediaTypes,
+      ...rest
+    } = options ?? {};
+    super({
+      ...rest,
+      name: 'api-design-systems-json',
+      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, _apidomParserAdapterApiDesignSystemsJson.detect)(file.toString());
+    }
+    return false;
+  }
+  async parse(file) {
+    const source = file.toString();
+    try {
+      const parserOpts = (0, _ramda.pick)(['sourceMap', 'syntacticAnalysis', 'refractorOpts'], this);
+      return await (0, _apidomParserAdapterApiDesignSystemsJson.parse)(source, parserOpts);
+    } catch (error) {
+      throw new _ParserError.default(`Error parsing "${file.uri}"`, {
+        cause: error
+      });
+    }
+  }
+}
+var _default = exports.default = APIDesignSystemsJSONParser;

package/src/parse/parsers/api-design-systems-json/index.mjs

@@ -0,0 +1,49 @@
+import { pick } from 'ramda';
+import { parse, mediaTypes as ADSMediaTypes, detect } from '@speclynx/apidom-parser-adapter-api-design-systems-json';
+import ParserError from "../../../errors/ParserError.mjs";
+import Parser from "../Parser.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class APIDesignSystemsJSONParser extends Parser {
+  syntacticAnalysis;
+  refractorOpts;
+  constructor(options) {
+    const {
+      fileExtensions = [],
+      mediaTypes = ADSMediaTypes,
+      ...rest
+    } = options ?? {};
+    super({
+      ...rest,
+      name: 'api-design-systems-json',
+      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', 'syntacticAnalysis', 'refractorOpts'], this);
+      return await parse(source, parserOpts);
+    } catch (error) {
+      throw new ParserError(`Error parsing "${file.uri}"`, {
+        cause: error
+      });
+    }
+  }
+}
+export default APIDesignSystemsJSONParser;

package/src/parse/parsers/api-design-systems-yaml/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 _apidomParserAdapterApiDesignSystemsYaml = require("@speclynx/apidom-parser-adapter-api-design-systems-yaml");
+var _ParserError = _interopRequireDefault(require("../../../errors/ParserError.cjs"));
+var _Parser = _interopRequireDefault(require("../Parser.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class APIDesignSystemsYAMLParser extends _Parser.default {
+  refractorOpts;
+  constructor(options) {
+    const {
+      fileExtensions = [],
+      mediaTypes = _apidomParserAdapterApiDesignSystemsYaml.mediaTypes,
+      ...rest
+    } = options ?? {};
+    super({
+      ...rest,
+      name: 'api-design-systems-yaml',
+      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, _apidomParserAdapterApiDesignSystemsYaml.detect)(file.toString());
+    }
+    return false;
+  }
+  async parse(file) {
+    const source = file.toString();
+    try {
+      const parserOpts = (0, _ramda.pick)(['sourceMap', 'refractorOpts'], this);
+      return await (0, _apidomParserAdapterApiDesignSystemsYaml.parse)(source, parserOpts);
+    } catch (error) {
+      throw new _ParserError.default(`Error parsing "${file.uri}"`, {
+        cause: error
+      });
+    }
+  }
+}
+var _default = exports.default = APIDesignSystemsYAMLParser;

package/src/parse/parsers/api-design-systems-yaml/index.mjs

@@ -0,0 +1,48 @@
+import { pick } from 'ramda';
+import { parse, mediaTypes as ADSMediaTypes, detect } from '@speclynx/apidom-parser-adapter-api-design-systems-yaml';
+import ParserError from "../../../errors/ParserError.mjs";
+import Parser from "../Parser.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class APIDesignSystemsYAMLParser extends Parser {
+  refractorOpts;
+  constructor(options) {
+    const {
+      fileExtensions = [],
+      mediaTypes = ADSMediaTypes,
+      ...rest
+    } = options ?? {};
+    super({
+      ...rest,
+      name: 'api-design-systems-yaml',
+      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', 'refractorOpts'], this);
+      return await parse(source, parserOpts);
+    } catch (error) {
+      throw new ParserError(`Error parsing "${file.uri}"`, {
+        cause: error
+      });
+    }
+  }
+}
+export default APIDesignSystemsYAMLParser;

package/src/parse/parsers/apidom-json/index.cjs

@@ -0,0 +1,70 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomCore = require("@speclynx/apidom-core");
+var _ParserError = _interopRequireDefault(require("../../../errors/ParserError.cjs"));
+var _Parser = _interopRequireDefault(require("../Parser.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class ApiDOMJSONParser extends _Parser.default {
+  namespace;
+  ['apidom-json'];
+  constructor(options) {
+    const {
+      fileExtensions = [],
+      mediaTypes = ['application/vnd.apidom', 'application/vnd.apidom+json'],
+      namespace = _apidomCore.namespace,
+      ...rest
+    } = options ?? {};
+    super({
+      ...rest,
+      name: 'apidom-json',
+      fileExtensions,
+      mediaTypes
+    });
+    this.namespace = namespace;
+  }
+  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) {
+      try {
+        return this.namespace.fromRefract(JSON.parse(file.toString())) && true;
+      } catch {
+        return false;
+      }
+    }
+    return false;
+  }
+  parse(file) {
+    const source = file.toString();
+    const namespace = this['apidom-json']?.namespace ?? this.namespace;
+
+    // allow empty files
+    if (this.allowEmpty && source.trim() === '') {
+      return new _apidomCore.ParseResultElement();
+    }
+    try {
+      const element = namespace.fromRefract(JSON.parse(source));
+      if (!(0, _apidomCore.isParseResultElement)(element)) {
+        element.classes.push('result');
+        return new _apidomCore.ParseResultElement([element]);
+      }
+      return element;
+    } catch (error) {
+      throw new _ParserError.default(`Error parsing "${file.uri}"`, {
+        cause: error
+      });
+    }
+  }
+}
+var _default = exports.default = ApiDOMJSONParser;

package/src/parse/parsers/apidom-json/index.mjs

@@ -0,0 +1,64 @@
+import { ParseResultElement, isParseResultElement, namespace as baseNamespace } from '@speclynx/apidom-core';
+import ParserError from "../../../errors/ParserError.mjs";
+import Parser from "../Parser.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class ApiDOMJSONParser extends Parser {
+  namespace;
+  ['apidom-json'];
+  constructor(options) {
+    const {
+      fileExtensions = [],
+      mediaTypes = ['application/vnd.apidom', 'application/vnd.apidom+json'],
+      namespace = baseNamespace,
+      ...rest
+    } = options ?? {};
+    super({
+      ...rest,
+      name: 'apidom-json',
+      fileExtensions,
+      mediaTypes
+    });
+    this.namespace = namespace;
+  }
+  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) {
+      try {
+        return this.namespace.fromRefract(JSON.parse(file.toString())) && true;
+      } catch {
+        return false;
+      }
+    }
+    return false;
+  }
+  parse(file) {
+    const source = file.toString();
+    const namespace = this['apidom-json']?.namespace ?? this.namespace;
+
+    // allow empty files
+    if (this.allowEmpty && source.trim() === '') {
+      return new ParseResultElement();
+    }
+    try {
+      const element = namespace.fromRefract(JSON.parse(source));
+      if (!isParseResultElement(element)) {
+        element.classes.push('result');
+        return new ParseResultElement([element]);
+      }
+      return element;
+    } catch (error) {
+      throw new ParserError(`Error parsing "${file.uri}"`, {
+        cause: error
+      });
+    }
+  }
+}
+export default ApiDOMJSONParser;

package/src/parse/parsers/arazzo-json-1/index.cjs

@@ -0,0 +1,55 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _ramda = require("ramda");
+var _apidomParserAdapterArazzoJson = require("@speclynx/apidom-parser-adapter-arazzo-json-1");
+var _ParserError = _interopRequireDefault(require("../../../errors/ParserError.cjs"));
+var _Parser = _interopRequireDefault(require("../Parser.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class ArazzoJSON1Parser extends _Parser.default {
+  syntacticAnalysis;
+  refractorOpts;
+  constructor(options) {
+    const {
+      fileExtensions = [],
+      mediaTypes = _apidomParserAdapterArazzoJson.mediaTypes,
+      ...rest
+    } = options ?? {};
+    super({
+      ...rest,
+      name: 'arazzo-json-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, _apidomParserAdapterArazzoJson.detect)(file.toString());
+    }
+    return false;
+  }
+  async parse(file) {
+    const source = file.toString();
+    try {
+      const parserOpts = (0, _ramda.pick)(['sourceMap', 'syntacticAnalysis', 'refractorOpts'], this);
+      return await (0, _apidomParserAdapterArazzoJson.parse)(source, parserOpts);
+    } catch (error) {
+      throw new _ParserError.default(`Error parsing "${file.uri}"`, {
+        cause: error
+      });
+    }
+  }
+}
+var _default = exports.default = ArazzoJSON1Parser;

package/src/parse/parsers/arazzo-json-1/index.mjs

@@ -0,0 +1,49 @@
+import { pick } from 'ramda';
+import { parse, mediaTypes as Arazzo1MediaTypes, detect } from '@speclynx/apidom-parser-adapter-arazzo-json-1';
+import ParserError from "../../../errors/ParserError.mjs";
+import Parser from "../Parser.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class ArazzoJSON1Parser extends Parser {
+  syntacticAnalysis;
+  refractorOpts;
+  constructor(options) {
+    const {
+      fileExtensions = [],
+      mediaTypes = Arazzo1MediaTypes,
+      ...rest
+    } = options ?? {};
+    super({
+      ...rest,
+      name: 'arazzo-json-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', 'syntacticAnalysis', 'refractorOpts'], this);
+      return await parse(source, parserOpts);
+    } catch (error) {
+      throw new ParserError(`Error parsing "${file.uri}"`, {
+        cause: error
+      });
+    }
+  }
+}
+export default ArazzoJSON1Parser;

package/src/parse/parsers/arazzo-yaml-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 _apidomParserAdapterArazzoYaml = require("@speclynx/apidom-parser-adapter-arazzo-yaml-1");
+var _ParserError = _interopRequireDefault(require("../../../errors/ParserError.cjs"));
+var _Parser = _interopRequireDefault(require("../Parser.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class ArazzoYAML1Parser extends _Parser.default {
+  refractorOpts;
+  constructor(options) {
+    const {
+      fileExtensions = [],
+      mediaTypes = _apidomParserAdapterArazzoYaml.mediaTypes,
+      ...rest
+    } = options ?? {};
+    super({
+      ...rest,
+      name: 'arazzo-yaml-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, _apidomParserAdapterArazzoYaml.detect)(file.toString());
+    }
+    return false;
+  }
+  async parse(file) {
+    const source = file.toString();
+    try {
+      const parserOpts = (0, _ramda.pick)(['sourceMap', 'refractorOpts'], this);
+      return await (0, _apidomParserAdapterArazzoYaml.parse)(source, parserOpts);
+    } catch (error) {
+      throw new _ParserError.default(`Error parsing "${file.uri}"`, {
+        cause: error
+      });
+    }
+  }
+}
+var _default = exports.default = ArazzoYAML1Parser;

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

@@ -0,0 +1,48 @@
+import { pick } from 'ramda';
+import { parse, mediaTypes as ArazzoYAML1MediaTypes, detect } from '@speclynx/apidom-parser-adapter-arazzo-yaml-1';
+import ParserError from "../../../errors/ParserError.mjs";
+import Parser from "../Parser.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class ArazzoYAML1Parser extends Parser {
+  refractorOpts;
+  constructor(options) {
+    const {
+      fileExtensions = [],
+      mediaTypes = ArazzoYAML1MediaTypes,
+      ...rest
+    } = options ?? {};
+    super({
+      ...rest,
+      name: 'arazzo-yaml-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', 'refractorOpts'], this);
+      return await parse(source, parserOpts);
+    } catch (error) {
+      throw new ParserError(`Error parsing "${file.uri}"`, {
+        cause: error
+      });
+    }
+  }
+}
+export default ArazzoYAML1Parser;

package/src/parse/parsers/asyncapi-json-2/index.cjs

@@ -0,0 +1,55 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _ramda = require("ramda");
+var _apidomParserAdapterAsyncapiJson = require("@speclynx/apidom-parser-adapter-asyncapi-json-2");
+var _ParserError = _interopRequireDefault(require("../../../errors/ParserError.cjs"));
+var _Parser = _interopRequireDefault(require("../Parser.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class AsyncAPIJSON2Parser extends _Parser.default {
+  syntacticAnalysis;
+  refractorOpts;
+  constructor(options) {
+    const {
+      fileExtensions = [],
+      mediaTypes = _apidomParserAdapterAsyncapiJson.mediaTypes,
+      ...rest
+    } = options ?? {};
+    super({
+      ...rest,
+      name: 'asyncapi-json-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, _apidomParserAdapterAsyncapiJson.detect)(file.toString());
+    }
+    return false;
+  }
+  async parse(file) {
+    const source = file.toString();
+    try {
+      const parserOpts = (0, _ramda.pick)(['sourceMap', 'syntacticAnalysis', 'refractorOpts'], this);
+      return await (0, _apidomParserAdapterAsyncapiJson.parse)(source, parserOpts);
+    } catch (error) {
+      throw new _ParserError.default(`Error parsing "${file.uri}"`, {
+        cause: error
+      });
+    }
+  }
+}
+var _default = exports.default = AsyncAPIJSON2Parser;