@speclynx/apidom-reference 4.0.3 → 4.0.4

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

@@ -1,58 +0,0 @@
-import { pick } from 'ramda';
-import { ParseResultElement } from '@speclynx/apidom-datamodel';
-import {
-  parse,
-  mediaTypes as AsyncAPI2MediaTypes,
-  detect,
-} from '@speclynx/apidom-parser-adapter-asyncapi-json-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 AsyncAPIJSON2ParserOptions extends Omit<ParserOptions, 'name'> {}
-
-/**
- * @public
- */
-class AsyncAPIJSON2Parser extends Parser {
-  public refractorOpts!: object;
-
-  constructor(options?: AsyncAPIJSON2ParserOptions) {
-    const { fileExtensions = [], mediaTypes = AsyncAPI2MediaTypes, ...rest } = options ?? {};
-
-    super({ ...rest, name: 'asyncapi-json-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 {
-      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 AsyncAPIJSON2Parser;

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

@@ -1,58 +0,0 @@
-import { pick } from 'ramda';
-import { ParseResultElement } from '@speclynx/apidom-datamodel';
-import {
-  parse,
-  mediaTypes as AsyncAPI2MediaTypes,
-  detect,
-} from '@speclynx/apidom-parser-adapter-asyncapi-yaml-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 AsyncAPIYAML2ParserOptions extends Omit<ParserOptions, 'name'> {}
-
-/**
- * @public
- */
-class AsyncAPIYAML2Parser extends Parser {
-  public refractorOpts!: object;
-
-  constructor(options?: AsyncAPIYAML2ParserOptions) {
-    const { fileExtensions = [], mediaTypes = AsyncAPI2MediaTypes, ...rest } = options ?? {};
-
-    super({ ...rest, name: 'asyncapi-yaml-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 {
-      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 AsyncAPIYAML2Parser;

package/src/parse/parsers/binary/index-browser.ts

@@ -1,60 +0,0 @@
-import { ParseResultElement, StringElement } from '@speclynx/apidom-datamodel';
-
-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';
-
-/**
- * Everything that is not recognized by other parsers will be considered by this parser
- * as a binary data and will be encoded to Base64 format.
- * @public
- */
-
-export interface BinaryParserOptions extends Omit<ParserOptions, 'name'> {}
-
-/**
- * @public
- */
-class BinaryParser extends Parser {
-  constructor(options?: BinaryParserOptions) {
-    super({ ...(options ?? {}), name: 'binary' });
-  }
-
-  canParse(file: File): boolean {
-    return this.fileExtensions.length === 0 ? true : this.fileExtensions.includes(file.extension);
-  }
-
-  parse(file: File): ParseResultElement {
-    try {
-      /**
-       * More information about binary strings and btoa function in following link:
-       *   https://developer.mozilla.org/en-US/docs/Web/API/btoa
-       *
-       * @example
-       * ArrayBuffer to base64 conversion:
-       *
-       * const binaryString = String.fromCharCode.apply(null, file.data);
-       * base64String = btoa(binaryString);
-       */
-      const binaryString = unescape(encodeURIComponent(file.toString()));
-      const base64String = btoa(binaryString);
-
-      const parseResultElement = new ParseResultElement();
-
-      if (base64String.length !== 0) {
-        const base64StringElement = new StringElement(base64String);
-        base64StringElement.classes.push('result');
-        parseResultElement.push(base64StringElement);
-      }
-
-      return parseResultElement;
-    } catch (error: unknown) {
-      throw new ParserError(`Error parsing "${file.uri}"`, { cause: error });
-    }
-  }
-}
-
-export default BinaryParser;

package/src/parse/parsers/binary/index-node.ts

@@ -1,57 +0,0 @@
-import { Buffer } from 'node:buffer';
-import { ParseResultElement, StringElement } from '@speclynx/apidom-datamodel';
-
-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';
-
-/**
- * Everything that is not recognized by other parsers will be considered by this parser
- * as a binary data and will be encoded to Base64 format.
- * @public
- */
-
-export interface BinaryParserOptions extends Omit<ParserOptions, 'name'> {}
-
-/**
- * @public
- */
-class BinaryParser extends Parser {
-  constructor(options?: BinaryParserOptions) {
-    super({ ...(options ?? {}), name: 'binary' });
-  }
-
-  canParse(file: File): boolean {
-    return this.fileExtensions.length === 0 ? true : this.fileExtensions.includes(file.extension);
-  }
-
-  parse(file: File): ParseResultElement {
-    let base64String: string;
-
-    try {
-      type BufferData = Parameters<typeof Buffer.from>[0];
-      base64String = Buffer.from(file.data as BufferData).toString('base64');
-    } catch {
-      base64String = Buffer.from(file.toString()).toString('base64');
-    }
-
-    try {
-      const parseResultElement = new ParseResultElement();
-
-      if (base64String.length !== 0) {
-        const base64StringElement = new StringElement(base64String);
-        base64StringElement.classes.push('result');
-        parseResultElement.push(base64StringElement);
-      }
-
-      return parseResultElement;
-    } catch (error: unknown) {
-      throw new ParserError(`Error parsing "${file.uri}"`, { cause: error });
-    }
-  }
-}
-
-export default BinaryParser;

package/src/parse/parsers/json/index.ts

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

package/src/parse/parsers/openapi-json-2/index.ts

@@ -1,58 +0,0 @@
-import { pick } from 'ramda';
-import { ParseResultElement } from '@speclynx/apidom-datamodel';
-import {
-  parse,
-  mediaTypes as OpenAPI2MediaTypes,
-  detect,
-} from '@speclynx/apidom-parser-adapter-openapi-json-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 OpenAPIJSON2ParserOptions extends Omit<ParserOptions, 'name'> {}
-
-/**
- * @public
- */
-class OpenAPIJSON2Parser extends Parser {
-  public refractorOpts!: object;
-
-  constructor(options?: OpenAPIJSON2ParserOptions) {
-    const { fileExtensions = [], mediaTypes = OpenAPI2MediaTypes, ...rest } = options ?? {};
-
-    super({ ...rest, name: 'openapi-json-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 {
-      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 OpenAPIJSON2Parser;

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

@@ -1,59 +0,0 @@
-import { pick } from 'ramda';
-import { ParseResultElement } from '@speclynx/apidom-datamodel';
-import {
-  parse,
-  mediaTypes as OpenAPI3_0MediaTypes,
-  detect,
-} from '@speclynx/apidom-parser-adapter-openapi-json-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 OpenAPIJSON3_0ParserOptions extends Omit<ParserOptions, 'name'> {}
-
-/**
- * @public
- */
-class OpenAPIJSON3_0Parser extends Parser {
-  public refractorOpts!: object;
-
-  constructor(options?: OpenAPIJSON3_0ParserOptions) {
-    const { fileExtensions = [], mediaTypes = OpenAPI3_0MediaTypes, ...rest } = options ?? {};
-
-    super({ ...rest, name: 'openapi-json-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 OpenAPIJSON3_0Parser;

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

@@ -1,59 +0,0 @@
-import { pick } from 'ramda';
-import { ParseResultElement } from '@speclynx/apidom-datamodel';
-import {
-  parse,
-  mediaTypes as OpenAPI3_1MediaTypes,
-  detect,
-} from '@speclynx/apidom-parser-adapter-openapi-json-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 OpenAPIJSON3_1ParserOptions extends Omit<ParserOptions, 'name'> {}
-
-/**
- * @public
- */
-class OpenAPIJSON3_1Parser extends Parser {
-  public refractorOpts!: object;
-
-  constructor(options?: OpenAPIJSON3_1ParserOptions) {
-    const { fileExtensions = [], mediaTypes = OpenAPI3_1MediaTypes, ...rest } = options ?? {};
-
-    super({ ...rest, name: 'openapi-json-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 OpenAPIJSON3_1Parser;

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

@@ -1,58 +0,0 @@
-import { pick } from 'ramda';
-import { ParseResultElement } from '@speclynx/apidom-datamodel';
-import {
-  parse,
-  mediaTypes as OpenAPIYAML2MediaTypes,
-  detect,
-} from '@speclynx/apidom-parser-adapter-openapi-yaml-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 OpenAPIYAML2ParserOptions extends Omit<ParserOptions, 'name'> {}
-
-/**
- * @public
- */
-class OpenAPIYAML2Parser extends Parser {
-  public refractorOpts!: object;
-
-  constructor(options?: OpenAPIYAML2ParserOptions) {
-    const { fileExtensions = [], mediaTypes = OpenAPIYAML2MediaTypes, ...rest } = options ?? {};
-
-    super({ ...rest, name: 'openapi-yaml-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 {
-      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 OpenAPIYAML2Parser;

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

@@ -1,59 +0,0 @@
-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.ts

@@ -1,59 +0,0 @@
-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;