@speclynx/apidom-reference 1.12.2 → 2.1.0

package/types/dereference/strategies/openapi-3-1/util.d.ts

@@ -1,4 +1,4 @@
-import { Element } from '@speclynx/apidom-core';
+import { Element } from '@speclynx/apidom-datamodel';
 import { SchemaElement } from '@speclynx/apidom-ns-openapi-3-1';
 /**
  * @public

package/types/dereference/strategies/openapi-3-1/visitor.d.ts

@@ -1,13 +1,8 @@
-import { Element, Namespace } from '@speclynx/apidom-core';
-import { ReferenceElement, PathItemElement, LinkElement, ExampleElement, SchemaElement } from '@speclynx/apidom-ns-openapi-3-1';
+import { Element, Namespace } from '@speclynx/apidom-datamodel';
+import { Path } from '@speclynx/apidom-traverse';
 import Reference from '../../../Reference.ts';
 import { AncestorLineage } from '../../util.ts';
 import type { ReferenceOptions } from '../../../options/index.ts';
-/**
- * Custom mutation replacer.
- * @public
- */
-export declare const mutationReplacer: (newElement: Element, oldElement: Element, key: string | number, parent: Element | undefined) => void;
 /**
  * @public
  */
@@ -32,21 +27,11 @@ declare class OpenAPI3_1DereferenceVisitor {
     constructor({ reference, namespace, options, indirections, ancestors, refractCache, }: OpenAPI3_1DereferenceVisitorOptions);
     protected toBaseURI(uri: string): string;
     protected toReference(uri: string): Promise<Reference>;
-    protected toAncestorLineage(ancestors: (Element | Element[] | undefined)[]): [AncestorLineage<Element>, Set<Element>];
-    ReferenceElement(referencingElement: ReferenceElement, key: string | number, parent: Element | undefined, path: (string | number)[], ancestors: [Element | Element[]], link: {
-        replaceWith: (element: Element, replacer: typeof mutationReplacer) => void;
-    }): Promise<any>;
-    PathItemElement(referencingElement: PathItemElement, key: string | number, parent: Element | undefined, path: (string | number)[], ancestors: [Element | Element[]], link: {
-        replaceWith: (element: Element, replacer: typeof mutationReplacer) => void;
-    }): Promise<any>;
-    LinkElement(linkElement: LinkElement, key: string | number, parent: Element | undefined, path: (string | number)[], ancestors: [Element | Element[]], link: {
-        replaceWith: (element: Element, replacer: typeof mutationReplacer) => void;
-    }): Promise<LinkElement | undefined>;
-    ExampleElement(exampleElement: ExampleElement, key: string | number, parent: Element | undefined, path: (string | number)[], ancestors: [Element | Element[]], link: {
-        replaceWith: (element: Element, replacer: typeof mutationReplacer) => void;
-    }): Promise<ExampleElement | undefined>;
-    SchemaElement(referencingElement: SchemaElement, key: string | number, parent: Element | undefined, path: (string | number)[], ancestors: [Element | Element[]], link: {
-        replaceWith: (element: Element, replacer: typeof mutationReplacer) => void;
-    }): Promise<any>;
+    protected toAncestorLineage(path: Path<Element>): [AncestorLineage<Element>, Set<Element>];
+    ReferenceElement(path: Path<Element>): Promise<void>;
+    PathItemElement(path: Path<Element>): Promise<void>;
+    LinkElement(path: Path<Element>): Promise<void>;
+    ExampleElement(path: Path<Element>): Promise<void>;
+    SchemaElement(path: Path<Element>): Promise<void>;
 }
 export default OpenAPI3_1DereferenceVisitor;

package/types/dereference/util.d.ts

@@ -1,4 +1,4 @@
-import { Element } from '@speclynx/apidom-core';
+import { Element } from '@speclynx/apidom-datamodel';
 /**
  * @public
  */

package/types/index.d.ts

@@ -1,4 +1,4 @@
-import { ParseResultElement, Element } from '@speclynx/apidom-core';
+import { ParseResultElement, Element } from '@speclynx/apidom-datamodel';
 import File from './File.ts';
 import ReferenceSet from './ReferenceSet.ts';
 import * as url from './util/url.ts';

package/types/options/index.d.ts

@@ -1,4 +1,4 @@
-import { RefElement } from 'minim';
+import type { RefElement } from '@speclynx/apidom-datamodel';
 import type Parser from '../parse/parsers/Parser.ts';
 import type Resolver from '../resolve/resolvers/Resolver.ts';
 import type ResolveStrategy from '../resolve/strategies/ResolveStrategy.ts';

package/types/parse/index.d.ts

@@ -1,4 +1,4 @@
-import { ParseResultElement } from '@speclynx/apidom-core';
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import type { ReferenceOptions } from '../options/index.ts';
 /**
  * Parses a file into ApiDOM.

package/types/parse/parsers/Parser.d.ts

@@ -1,4 +1,4 @@
-import { ParseResultElement } from '@speclynx/apidom-core';
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import File from '../../File.ts';
 /**
  * @public

package/types/parse/parsers/apidom-json/index.d.ts

@@ -1,4 +1,4 @@
-import { Namespace, ParseResultElement } from '@speclynx/apidom-core';
+import { Namespace, ParseResultElement } from '@speclynx/apidom-datamodel';
 import Parser, { ParserOptions } from '../Parser.ts';
 import File from '../../../File.ts';
 export type { default as Parser, ParserOptions } from '../Parser.ts';

package/types/parse/parsers/arazzo-json-1/index.d.ts

@@ -1,4 +1,4 @@
-import { ParseResultElement } from '@speclynx/apidom-core';
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import Parser, { ParserOptions } from '../Parser.ts';
 import File from '../../../File.ts';
 export type { default as Parser, ParserOptions } from '../Parser.ts';
@@ -12,7 +12,6 @@ export interface ArazzoJSON1ParserOptions extends Omit<ParserOptions, 'name'> {
  * @public
  */
 declare class ArazzoJSON1Parser extends Parser {
-    syntacticAnalysis?: 'direct' | 'indirect';
     refractorOpts: object;
     constructor(options?: ArazzoJSON1ParserOptions);
     canParse(file: File): Promise<boolean>;

package/types/parse/parsers/arazzo-yaml-1/index.d.ts

@@ -1,4 +1,4 @@
-import { ParseResultElement } from '@speclynx/apidom-core';
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import Parser, { ParserOptions } from '../Parser.ts';
 import File from '../../../File.ts';
 export type { default as Parser, ParserOptions } from '../Parser.ts';

package/types/parse/parsers/asyncapi-json-2/index.d.ts

@@ -1,4 +1,4 @@
-import { ParseResultElement } from '@speclynx/apidom-core';
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import Parser, { ParserOptions } from '../Parser.ts';
 import File from '../../../File.ts';
 export type { default as Parser, ParserOptions } from '../Parser.ts';
@@ -12,7 +12,6 @@ export interface AsyncAPIJSON2ParserOptions extends Omit<ParserOptions, 'name'>
  * @public
  */
 declare class AsyncAPIJSON2Parser extends Parser {
-    syntacticAnalysis?: 'direct' | 'indirect';
     refractorOpts: object;
     constructor(options?: AsyncAPIJSON2ParserOptions);
     canParse(file: File): Promise<boolean>;

package/types/parse/parsers/asyncapi-yaml-2/index.d.ts

@@ -1,4 +1,4 @@
-import { ParseResultElement } from '@speclynx/apidom-core';
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import Parser, { ParserOptions } from '../Parser.ts';
 import File from '../../../File.ts';
 export type { default as Parser, ParserOptions } from '../Parser.ts';

package/types/parse/parsers/binary/index-browser.d.ts

@@ -1,4 +1,4 @@
-import { ParseResultElement } from '@speclynx/apidom-core';
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import Parser, { ParserOptions } from '../Parser.ts';
 import File from '../../../File.ts';
 export type { default as Parser, ParserOptions } from '../Parser.ts';

package/types/parse/parsers/binary/index-node.d.ts

@@ -1,4 +1,4 @@
-import { ParseResultElement } from '@speclynx/apidom-core';
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import Parser, { ParserOptions } from '../Parser.ts';
 import File from '../../../File.ts';
 export type { default as Parser, ParserOptions } from '../Parser.ts';

package/types/parse/parsers/json/index.d.ts

@@ -1,4 +1,4 @@
-import { ParseResultElement } from '@speclynx/apidom-core';
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import Parser, { ParserOptions } from '../Parser.ts';
 import File from '../../../File.ts';
 export type { default as Parser, ParserOptions } from '../Parser.ts';
@@ -12,7 +12,6 @@ export interface JSONParserOptions extends Omit<ParserOptions, 'name'> {
  * @public
  */
 declare class JSONParser extends Parser {
-    syntacticAnalysis?: 'direct' | 'indirect';
     constructor(options?: JSONParserOptions);
     canParse(file: File): Promise<boolean>;
     parse(file: File): Promise<ParseResultElement>;

package/types/parse/parsers/openapi-json-2/index.d.ts

@@ -1,4 +1,4 @@
-import { ParseResultElement } from '@speclynx/apidom-core';
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import Parser, { ParserOptions } from '../Parser.ts';
 import File from '../../../File.ts';
 export type { default as Parser, ParserOptions } from '../Parser.ts';
@@ -12,7 +12,6 @@ export interface OpenAPIJSON2ParserOptions extends Omit<ParserOptions, 'name'> {
  * @public
  */
 declare class OpenAPIJSON2Parser extends Parser {
-    syntacticAnalysis?: 'direct' | 'indirect';
     refractorOpts: object;
     constructor(options?: OpenAPIJSON2ParserOptions);
     canParse(file: File): Promise<boolean>;

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

@@ -1,4 +1,4 @@
-import { ParseResultElement } from '@speclynx/apidom-core';
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import Parser, { ParserOptions } from '../Parser.ts';
 import File from '../../../File.ts';
 export type { default as Parser, ParserOptions } from '../Parser.ts';
@@ -12,7 +12,6 @@ export interface OpenAPIJSON3_0ParserOptions extends Omit<ParserOptions, 'name'>
  * @public
  */
 declare class OpenAPIJSON3_0Parser extends Parser {
-    syntacticAnalysis?: 'direct' | 'indirect';
     refractorOpts: object;
     constructor(options?: OpenAPIJSON3_0ParserOptions);
     canParse(file: File): Promise<boolean>;

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

@@ -1,4 +1,4 @@
-import { ParseResultElement } from '@speclynx/apidom-core';
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import Parser, { ParserOptions } from '../Parser.ts';
 import File from '../../../File.ts';
 export type { default as Parser, ParserOptions } from '../Parser.ts';
@@ -12,7 +12,6 @@ export interface OpenAPIJSON3_1ParserOptions extends Omit<ParserOptions, 'name'>
  * @public
  */
 declare class OpenAPIJSON3_1Parser extends Parser {
-    syntacticAnalysis?: 'direct' | 'indirect';
     refractorOpts: object;
     constructor(options?: OpenAPIJSON3_1ParserOptions);
     canParse(file: File): Promise<boolean>;

package/types/parse/parsers/openapi-yaml-2/index.d.ts

@@ -1,4 +1,4 @@
-import { ParseResultElement } from '@speclynx/apidom-core';
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import Parser, { ParserOptions } from '../Parser.ts';
 import File from '../../../File.ts';
 export type { default as Parser, ParserOptions } from '../Parser.ts';

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

@@ -1,4 +1,4 @@
-import { ParseResultElement } from '@speclynx/apidom-core';
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import Parser, { ParserOptions } from '../Parser.ts';
 import File from '../../../File.ts';
 export type { default as Parser, ParserOptions } from '../Parser.ts';

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

@@ -1,4 +1,4 @@
-import { ParseResultElement } from '@speclynx/apidom-core';
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import Parser, { ParserOptions } from '../Parser.ts';
 import File from '../../../File.ts';
 export type { default as Parser, ParserOptions } from '../Parser.ts';

package/types/parse/parsers/yaml-1-2/index.d.ts

@@ -1,4 +1,4 @@
-import { ParseResultElement } from '@speclynx/apidom-core';
+import { ParseResultElement } from '@speclynx/apidom-datamodel';
 import Parser, { ParserOptions } from '../Parser.ts';
 import File from '../../../File.ts';
 export type { default as Parser, ParserOptions } from '../Parser.ts';

package/types/resolve/index.d.ts

@@ -1,4 +1,4 @@
-import { Element } from '@speclynx/apidom-core';
+import { Element } from '@speclynx/apidom-datamodel';
 import ReferenceSet from '../ReferenceSet.ts';
 import type { ReferenceOptions } from '../options/index.ts';
 /**

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

@@ -1,55 +0,0 @@
-"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

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

@@ -1,54 +0,0 @@
-"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

@@ -1,48 +0,0 @@
-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/types/parse/parsers/api-design-systems-json/index.d.ts

@@ -1,21 +0,0 @@
-import { ParseResultElement } from '@speclynx/apidom-core';
-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 APIDesignSystemsJSONParserOptions extends Omit<ParserOptions, 'name'> {
-}
-/**
- * @public
- */
-declare class APIDesignSystemsJSONParser extends Parser {
-    syntacticAnalysis?: 'direct' | 'indirect';
-    refractorOpts: object;
-    constructor(options?: APIDesignSystemsJSONParserOptions);
-    canParse(file: File): Promise<boolean>;
-    parse(file: File): Promise<ParseResultElement>;
-}
-export default APIDesignSystemsJSONParser;

package/types/parse/parsers/api-design-systems-yaml/index.d.ts

@@ -1,20 +0,0 @@
-import { ParseResultElement } from '@speclynx/apidom-core';
-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 APIDesignSystemsYAMLParserOptions extends Omit<ParserOptions, 'name'> {
-}
-/**
- * @public
- */
-declare class APIDesignSystemsYAMLParser extends Parser {
-    refractorOpts: object;
-    constructor(options?: APIDesignSystemsYAMLParserOptions);
-    canParse(file: File): Promise<boolean>;
-    parse(file: File): Promise<ParseResultElement>;
-}
-export default APIDesignSystemsYAMLParser;