@speclynx/apidom-core 1.12.2 → 2.1.0

package/types/apidom-core.d.ts

@@ -1,155 +1,41 @@
-/// <reference path="./minim.d.ts" />
-import * as minim from "minim";
 import type { ApiDOMErrorOptions } from '@speclynx/apidom-error';
 import { ApiDOMStructuredError } from '@speclynx/apidom-error';
-import { ArrayElement } from 'minim';
-import { ArraySlice } from 'minim';
-import { Attributes } from 'minim';
-import { BooleanElement } from 'minim';
-import { BREAK } from '@speclynx/apidom-ast';
-import { Element as Element_2 } from 'minim';
-import { KeyValuePair } from 'minim';
-import { LinkElement } from 'minim';
-import { MemberElement } from 'minim';
-import { mergeAllVisitors } from '@speclynx/apidom-ast';
-import { Meta } from 'minim';
-import { Namespace as Namespace_2 } from 'minim';
-import { NamespacePlugin } from 'minim';
-import { NamespacePluginOptions } from 'minim';
-import { NullElement } from 'minim';
-import { NumberElement } from 'minim';
-import { ObjectElement } from 'minim';
-import { ObjectSlice } from 'minim';
-import { RefElement } from 'minim';
-import { refract } from 'minim';
+import { ArrayElement } from '@speclynx/apidom-datamodel';
+import { Element as Element_2 } from '@speclynx/apidom-datamodel';
+import { hasElementSourceMap } from '@speclynx/apidom-datamodel';
+import { includesClasses } from '@speclynx/apidom-datamodel';
+import { includesSymbols } from '@speclynx/apidom-datamodel';
+import { isAnnotationElement } from '@speclynx/apidom-datamodel';
+import { isArrayElement } from '@speclynx/apidom-datamodel';
+import { isBooleanElement } from '@speclynx/apidom-datamodel';
+import { isCommentElement } from '@speclynx/apidom-datamodel';
+import { isElement } from '@speclynx/apidom-datamodel';
+import { isLinkElement } from '@speclynx/apidom-datamodel';
+import { isMemberElement } from '@speclynx/apidom-datamodel';
+import { isNullElement } from '@speclynx/apidom-datamodel';
+import { isNumberElement } from '@speclynx/apidom-datamodel';
+import { isObjectElement } from '@speclynx/apidom-datamodel';
+import { isParseResultElement } from '@speclynx/apidom-datamodel';
+import { isPrimitiveElement } from '@speclynx/apidom-datamodel';
+import { isRefElement } from '@speclynx/apidom-datamodel';
+import { isSourceMapElement } from '@speclynx/apidom-datamodel';
+import { isStringElement } from '@speclynx/apidom-datamodel';
+import { Namespace } from '@speclynx/apidom-datamodel';
+import { ObjectElement } from '@speclynx/apidom-datamodel';
+import { Path } from '@speclynx/apidom-traverse';
 import ShortUniqueId from 'short-unique-id';
-import { StringElement } from 'minim';
-
-/**
- * @public
- */
-export declare class AnnotationElement extends StringElement {
-    constructor(content?: string, meta?: Meta, attributes?: Attributes);
-    get code(): any;
-    set code(value: any);
-}
+import { StringElement } from '@speclynx/apidom-datamodel';
 
 /**
  * @public
  */
 export declare type AnyElement = ObjectElement | ArrayElement | Element_2;
 
-export { ArrayElement }
-
-export { ArraySlice }
-
-export { Attributes }
-
-declare namespace basePredicates {
-    export {
-        isElement,
-        isStringElement,
-        isNumberElement,
-        isNullElement,
-        isBooleanElement,
-        isObjectElement,
-        isArrayElement,
-        isMemberElement,
-        isLinkElement,
-        isRefElement,
-        isAnnotationElement,
-        isCommentElement,
-        isParseResultElement,
-        isSourceMapElement,
-        PrimitiveElement,
-        isPrimitiveElement,
-        hasElementSourceMap,
-        includesSymbols,
-        includesClasses
-    }
-}
-export { basePredicates }
-
-export { BooleanElement }
-
-export { BREAK }
-
-/**
- * @public
- */
-export declare type Callback = <T extends Element_2>(element: T) => void;
-
-/**
- * @public
- */
-export declare const cloneDeep: {
-    <T extends Element_2 | FinalCloneTypes>(value: T, options?: DeepCloneOptions<T>): T;
-    safe<T>(value: T): T;
-};
-
-/**
- * @public
- */
-export declare class CloneError extends ApiDOMStructuredError {
-    readonly value: unknown;
-    constructor(message?: string, structuredOptions?: CloneErrorOptions);
-}
-
-/**
- * @public
- */
-export declare interface CloneErrorOptions extends ApiDOMErrorOptions {
-    readonly value: unknown;
-}
-
-/**
- * @public
- */
-export declare const cloneNode: <T>(node: T) => T;
-
-/**
- * @public
- */
-export declare const cloneShallow: {
-    <T extends Element_2 | FinalCloneTypes>(value: T): T;
-    safe<T>(value: T): T;
-};
-
-/**
- * @public
- */
-export declare class CommentElement extends StringElement {
-    constructor(content?: string, meta?: Meta, attributes?: Attributes);
-}
-
-/**
- * @public
- */
-export declare const createNamespace: (namespacePlugin?: NamespacePlugin) => Namespace;
-
-/**
- * @public
- */
-export declare const createPredicate: <T extends Element_2>(predicateCreator: PredicateCreator<T>) => ElementPredicate<T>;
-
 /**
  * @public
  */
 export declare const createToolbox: () => Toolbox;
 
-/**
- * @public
- */
-export declare class DeepCloneError extends CloneError {
-}
-
-/**
- * @public
- */
-export declare type DeepCloneOptions<T extends Element_2 | FinalCloneTypes> = {
-    visited?: WeakMap<T, T>;
-};
-
 /**
  * @public
  */
@@ -224,14 +110,7 @@ export declare const defaultIdentityManager: IdentityManager;
  * https://github.com/refractproject/refract-spec
  * @public
  */
-export declare const dehydrate: (element: Element_2, namespace?: Namespace_2) => any;
-
-/**
- * This dereference algorithm is used exclusively for dereferencing specification objects.
- * It doesn't handle circular references of external references and works on objects only (not arrays).
- * @public
- */
-export declare const dereference: (object: Record<string, any>, root?: Record<string, any>) => Record<string, any>;
+export declare const dehydrate: (element: Element_2, namespace?: Namespace) => unknown;
 
 /**
  * @public
@@ -246,7 +125,6 @@ export declare interface DispatchPluginsAsync {
 export declare interface DispatchPluginsOptions {
     toolboxCreator: typeof createToolbox;
     visitorOptions: {
-        nodeTypeGetter: typeof getNodeType;
         exposeEdits: boolean;
     };
 }
@@ -264,23 +142,6 @@ export declare interface DispatchPluginsSync {
  */
 export declare const dispatchRefractorPlugins: DispatchPluginsSync;
 
-export { Element_2 as Element }
-
-/**
- * @public
- */
-export declare interface ElementBasicsTrait {
-    _storedElement: string;
-    _content: unknown;
-}
-
-/**
- * @public
- */
-export declare interface ElementClassesTrait {
-    classes: ArrayElement | Array<string>;
-}
-
 /**
  * @public
  */
@@ -296,57 +157,6 @@ export declare interface ElementIdentityErrorOptions extends ApiDOMErrorOptions
     readonly value: unknown;
 }
 
-/**
- * @public
- */
-export declare type ElementPredicate<T extends Element_2> = (element: unknown) => element is T;
-
-/**
- * @public
- */
-export declare interface ElementPrimitiveBehavior {
-    primitive: () => unknown;
-}
-
-/**
- * @public
- */
-export declare interface ElementTypeTrait<T = string> {
-    element: T;
-}
-
-/**
- * Finds all elements matching the predicate.
- * @public
- */
-export declare const filter: <T extends Element_2>(predicate: (element: any) => boolean, element: T) => ArraySlice;
-
-/**
- * @public
- */
-export declare type FinalCloneTypes = KeyValuePair | ArraySlice | ObjectSlice;
-
-/**
- * Find first element that satisfies the provided predicate.
- * @public
- */
-export declare const find: <T extends Element_2>(predicate: (element: any) => boolean, element: T) => T | undefined;
-
-/**
- * Finds the most inner node at the given offset.
- * If includeRightBound is set, also finds nodes that end at the given offset.
- * @public
- */
-export declare const findAtOffset: <T extends Element_2>(options: number | FindAtOffsetOptions, element: T) => T | undefined;
-
-/**
- * @public
- */
-export declare interface FindAtOffsetOptions {
-    offset: number;
-    includeRightBound?: boolean;
-}
-
 /**
  * Transforms data to an Element from a particular namespace.
  *
@@ -357,32 +167,7 @@ export declare interface FindAtOffsetOptions {
  * - https://github.com/swagger-api/swagger-ui/issues/9466#issuecomment-1881053410
  * @public
  */
-export declare const from: (data: any, namespace?: Namespace_2) => Element_2;
-
-/**
- * @public
- */
-export declare const getNodeType: <T extends Element_2>(element: T) => string | undefined;
-
-/**
- * @public
- */
-export declare const hasBasicElementProps: (element: unknown) => element is ElementBasicsTrait;
-
-/**
- * @public
- */
-export declare const hasClass: (cls: string, element: unknown) => element is ElementClassesTrait;
-
-/**
- * @public
- */
-export declare const hasElementSourceMap: <T extends Element_2>(element: T) => boolean;
-
-/**
- * @public
- */
-export declare const hasMethod: <T extends string>(name: T, element: unknown) => element is { [key in T]: (...args: unknown[]) => unknown; };
+export declare const from: (data: unknown, namespace?: Namespace) => Element_2 | undefined;
 
 /**
  * @public
@@ -398,119 +183,6 @@ export declare class IdentityManager {
     generateId(): string;
 }
 
-/**
- * @public
- */
-export declare const includesClasses: <T extends Element_2>(classes: string[], element: T) => boolean;
-
-/**
- * @public
- */
-export declare const includesSymbols: <T extends Element_2>(symbols: string[], element: T) => boolean;
-
-/**
- * @public
- */
-export declare const isAnnotationElement: ElementPredicate<AnnotationElement>;
-
-/**
- * @public
- */
-export declare const isArrayElement: ElementPredicate<ArrayElement>;
-
-/**
- * @public
- */
-export declare const isBooleanElement: ElementPredicate<BooleanElement>;
-
-/**
- * @public
- */
-declare const isCommentElement: ElementPredicate<CommentElement>;
-
-/**
- * @public
- */
-export declare const isElement: ElementPredicate<Element_2>;
-
-/**
- * @public
- */
-export declare const isElementType: (name: string, element: unknown) => element is ElementTypeTrait;
-
-/**
- * @public
- */
-export declare const isLinkElement: ElementPredicate<LinkElement>;
-
-/**
- * @public
- */
-export declare const isMemberElement: ElementPredicate<MemberElement>;
-
-/**
- * @public
- */
-export declare const isNullElement: ElementPredicate<NullElement>;
-
-/**
- * @public
- */
-export declare const isNumberElement: ElementPredicate<NumberElement>;
-
-/**
- * @public
- */
-export declare const isObjectElement: ElementPredicate<ObjectElement>;
-
-/**
- * @public
- */
-export declare const isParseResultElement: ElementPredicate<ParseResultElement>;
-
-/**
- * @public
- */
-export declare const isPrimitiveElement: ElementPredicate<PrimitiveElement>;
-
-/**
- * @public
- */
-export declare const isRefElement: ElementPredicate<RefElement>;
-
-/**
- * @public
- */
-export declare const isSourceMapElement: ElementPredicate<SourceMapElement>;
-
-/**
- * @public
- */
-export declare const isStringElement: ElementPredicate<StringElement>;
-
-/**
- * @public
- */
-export declare const keyMap: {
-    ObjectElement: string[];
-    ArrayElement: string[];
-    MemberElement: string[];
-    StringElement: never[];
-    BooleanElement: never[];
-    NumberElement: never[];
-    NullElement: never[];
-    RefElement: never[];
-    LinkElement: never[];
-    Annotation: never[];
-    Comment: never[];
-    ParseResultElement: string[];
-    SourceMap: string[];
-};
-
-export { KeyValuePair }
-
-export { LinkElement }
-
 /**
  * @public
  */
@@ -521,10 +193,6 @@ export declare class MediaTypes<T> extends Array<T> {
     latest(): void;
 }
 
-export { MemberElement }
-
-export { mergeAllVisitors }
-
 /**
  * @public
  */
@@ -545,109 +213,34 @@ declare type MergeRightOptions = Omit<DeepMergeUserOptions, 'customMerge' | 'clo
 export { MergeRightOptions as MergeLeftOptions }
 export { MergeRightOptions }
 
-export { Meta }
-
-/**
- * @public
- */
-export declare class Namespace extends Namespace_2 {
-    constructor();
-}
-
-/**
- * @public
- */
-export declare const namespace: Namespace;
-
-export { NamespacePluginOptions }
-
-export { NullElement }
-
-export { NumberElement }
-
-export { ObjectElement }
-
 /**
  * @public
  */
 export declare type ObjectOrArrayElement = ObjectElement | ArrayElement;
 
-export { ObjectSlice }
-
-/**
- * Computes upwards edges from every child to its parent.
- * @public
- */
-export declare const parents: <T extends Element_2>(element: T) => WeakMap<Element_2, Element_2 | undefined>;
-
 /**
  * @public
  */
-export declare class ParseResultElement extends ArrayElement {
-    constructor(content?: Array<any>, meta?: Meta, attributes?: Attributes);
-    get api(): Element_2 | undefined;
-    get results(): ArraySlice;
-    get result(): Element_2 | undefined;
-    get annotations(): ArraySlice;
-    get warnings(): ArraySlice;
-    get errors(): ArraySlice;
-    get isEmpty(): boolean;
-    replaceResult(replacement: Element_2): boolean;
-}
-
-/**
- * @public
- */
-export declare interface Position {
-    row: number;
-    column: number;
-    char: number;
-}
-
-/**
- * @public
- */
-export declare interface PositionRange {
-    start: Position;
-    end: Position;
-}
-
-/**
- * @public
- */
-export declare type PredicateCreator<T extends Element_2> = (helpers: PredicateHelpers) => ElementPredicate<T>;
-
-/**
- * @public
- */
-export declare interface PredicateHelpers {
-    hasMethod: typeof hasMethod;
-    hasBasicElementProps: typeof hasBasicElementProps;
-    primitiveEq: typeof primitiveEq;
-    isElementType: typeof isElementType;
-    hasClass: typeof hasClass;
-}
-
-/**
- * @public
- */
-export declare type Predicates = {
+export declare interface Predicates {
+    isElement: typeof isElement;
+    isStringElement: typeof isStringElement;
+    isNumberElement: typeof isNumberElement;
+    isNullElement: typeof isNullElement;
+    isBooleanElement: typeof isBooleanElement;
+    isArrayElement: typeof isArrayElement;
+    isObjectElement: typeof isObjectElement;
+    isMemberElement: typeof isMemberElement;
     isPrimitiveElement: typeof isPrimitiveElement;
-};
-
-/**
- * @public
- */
-export declare type PrimitiveElement = ObjectElement | ArrayElement | BooleanElement | NumberElement | StringElement | NullElement | MemberElement;
-
-/**
- * @public
- */
-export declare const primitiveEq: (val: unknown, element: unknown) => element is ElementPrimitiveBehavior;
-
-export { RefElement }
-
-export { refract }
+    isLinkElement: typeof isLinkElement;
+    isRefElement: typeof isRefElement;
+    isAnnotationElement: typeof isAnnotationElement;
+    isCommentElement: typeof isCommentElement;
+    isParseResultElement: typeof isParseResultElement;
+    isSourceMapElement: typeof isSourceMapElement;
+    hasElementSourceMap: typeof hasElementSourceMap;
+    includesSymbols: typeof includesSymbols;
+    includesClasses: typeof includesClasses;
+}
 
 /**
  * Plugin for decorating every element in ApiDOM tree with UUID.
@@ -658,7 +251,7 @@ export declare const refractorPluginElementIdentity: ({ length }?: {
 }) => () => {
     pre(): void;
     visitor: {
-        enter<T extends Element_2>(element: T): void;
+        enter(path: Path<Element_2>): void;
     };
     post(): void;
 };
@@ -669,51 +262,38 @@ export declare const refractorPluginElementIdentity: ({ length }?: {
  */
 export declare const refractorPluginSemanticElementIdentity: ({ length }?: {
     length?: number | undefined;
-}) => ({ predicates }: {
-    predicates: Predicates;
-}) => {
+}) => () => {
     pre(): void;
     visitor: {
-        enter<T extends Element_2>(element: T): void;
+        enter(path: Path<Element_2>): void;
     };
     post(): void;
 };
 
 /**
- * Complement of filter.
+ * Base type for resolved specification objects.
+ * Extend this in namespace packages to add specific type information.
  * @public
  */
-export declare const reject: <T extends Element_2>(predicate: (element: any) => boolean, element: T) => ArraySlice;
-
-/**
- * Transforms ApiDOM into S-expressions (Symbolic Expressions).
- * @public
- */
-export declare const sexprs: (element: Element_2) => string;
-
-/**
- * @public
- */
-export declare class ShallowCloneError extends CloneError {
+export declare interface ResolvedSpecification {
+    elementMap: Record<string, string[]>;
 }
 
 /**
- * Tests whether at least one element passes the predicate.
+ * Resolves a specification object by:
+ * 1. Dereferencing all $ref pointers
+ * 2. Building elementMap from objects with `element` property
+ * 3. Caching results for efficiency
+ *
  * @public
  */
-export declare const some: <T extends Element_2>(predicate: (element: any) => boolean, element: T) => boolean;
+export declare const resolveSpecification: <T extends ResolvedSpecification = ResolvedSpecification>(specification: Record<string, unknown>) => T;
 
 /**
+ * Transforms ApiDOM into S-expressions (Symbolic Expressions).
  * @public
  */
-export declare class SourceMapElement extends ArrayElement {
-    constructor(content?: Array<any>, meta?: Meta, attributes?: Attributes);
-    get positionStart(): Element_2 | undefined;
-    get positionEnd(): Element_2 | undefined;
-    set position(position: PositionRange | undefined);
-}
-
-export { StringElement }
+export declare const sexprs: (element: Element_2) => string;
 
 /**
  * @public
@@ -724,21 +304,24 @@ export declare const toJSON: (element: Element_2, replacer?: (this: any, key: st
  * @public
  */
 export declare interface Toolbox {
-    predicates: typeof basePredicates;
-    namespace: typeof namespace;
+    predicates: Predicates;
+    namespace: Namespace;
 }
 
 /**
  * Create a refracted string representation of an Element.
  * @public
  */
-declare const toString_2: (element: Element_2, namespace?: Namespace_2) => string;
+declare const toString_2: (element: Element_2, namespace?: Namespace) => string;
 export { toString_2 as toString }
 
 /**
+ * Transforms the ApiDOM into JavaScript POJO.
+ * This POJO would be the result of interpreting the ApiDOM
+ * into JavaScript structure.
  * @public
  */
-export declare const toValue: <T extends Element_2 | unknown>(element: T) => any;
+export declare const toValue: <T extends Element_2 | unknown>(element: T) => unknown;
 
 /**
  * @public
@@ -768,39 +351,4 @@ export declare class Transcluder {
     transclude(search: Element_2, replace: Element_2): Element_2 | undefined;
 }
 
-/**
- * Executes the callback on this element and all descendants.
- * @public
- */
-export declare const traverse: <T extends Element_2>(options: Callback | TraverseOptions, element: T) => void;
-
-/**
- * @public
- */
-export declare interface TraverseOptions {
-    callback?: Callback;
-    predicate?: (element: any) => boolean;
-}
-
-/**
- * @public
- */
-export declare const visit: (root: Element_2, visitor: any, { keyMap, ...rest }?: {
-    keyMap?: {
-        ObjectElement: string[];
-        ArrayElement: string[];
-        MemberElement: string[];
-        StringElement: never[];
-        BooleanElement: never[];
-        NumberElement: never[];
-        NullElement: never[];
-        RefElement: never[];
-        LinkElement: never[];
-        Annotation: never[];
-        Comment: never[];
-        ParseResultElement: string[];
-        SourceMap: string[];
-    } | undefined;
-}) => Element_2;
-
 export { }