@swagger-api/apidom-core - npm Package Compare versions

Comparing version 0.98.0 to 0.99.0

CHANGELOG.md

@@ -6,2 +6,8 @@ # Change Log
 
+# [0.99.0](https://github.com/swagger-api/apidom/compare/v0.98.3...v0.99.0) (2024-04-03)
+
+### Features
+
+- **core:** introduce async version of plugin dispatch mechanism ([#3994](https://github.com/swagger-api/apidom/issues/3994)) ([36011bc](https://github.com/swagger-api/apidom/commit/36011bc3b7e50e2d12c08b18b2d45aeb9aa6f594)), closes [#3993](https://github.com/swagger-api/apidom/issues/3993)
+
 # [0.98.0](https://github.com/swagger-api/apidom/compare/v0.97.1...v0.98.0) (2024-03-21)
@@ -8,0 +14,0 @@

package.json

 {
   "name": "@swagger-api/apidom-core",
-  "version": "0.98.0",
+  "version": "0.99.0",
   "description": "Tools for manipulating ApiDOM structures.",
@@ -45,4 +45,4 @@ "publishConfig": {
     "@babel/runtime-corejs3": "^7.20.7",
-    "@swagger-api/apidom-ast": "^0.98.0",
-    "@swagger-api/apidom-error": "^0.98.0",
+    "@swagger-api/apidom-ast": "^0.99.0",
+    "@swagger-api/apidom-error": "^0.99.0",
     "@types/ramda": "~0.29.6",
@@ -66,3 +66,3 @@ "minim": "~0.23.8",
   ],
-  "gitHead": "1ab373182c91e23f960e01b8722d3381b2dfa936"
+  "gitHead": "e3c5ac3e738d561a0eb6d9d0f729e0d6bf20b00f"
 }

types/dist.d.ts

 /// <reference path="./minim.d.ts" />
 import * as minim from 'minim';
-import { Element, StringElement, Meta, Attributes, ArrayElement, ArraySlice, NumberElement, NullElement, BooleanElement, ObjectElement, MemberElement, LinkElement, RefElement, Namespace as Namespace$1, NamespacePlugin, KeyValuePair, ObjectSlice } from 'minim';
+import { Namespace as Namespace$1, NamespacePlugin, StringElement, Meta, Attributes, ArrayElement, Element, ArraySlice, NumberElement, NullElement, BooleanElement, ObjectElement, MemberElement, LinkElement, RefElement, KeyValuePair, ObjectSlice } from 'minim';
 export { ArrayElement, ArraySlice, Attributes, BooleanElement, Element, KeyValuePair, LinkElement, MemberElement, Meta, NamespacePluginOptions, NullElement, NumberElement, ObjectElement, ObjectSlice, RefElement, StringElement, refract } from 'minim';
@@ -10,17 +10,8 @@ import { ApiDOMStructuredError, ApiDOMErrorOptions } from '@swagger-api/apidom-error';
 
-declare const dispatchPlugins: <T extends Element>(element: T, plugins: ((toolbox: any) => object)[], options?: {}) => T;
+declare class Namespace extends Namespace$1 {
+    constructor();
+}
+declare const namespace: Namespace;
+declare const createNamespace: (namespacePlugin?: NamespacePlugin) => Namespace;
 
-/**
- * Plugin for decorating every element in ApiDOM tree with UUID.
- */
-declare const plugin$1: ({ length }?: {
-    length?: number | undefined;
-}) => () => {
-    pre(): void;
-    visitor: {
-        enter<T extends Element>(element: T): void;
-    };
-    post(): void;
-};
-
 declare class Annotation extends StringElement {
@@ -64,2 +55,90 @@ constructor(content?: string, meta?: Meta, attributes?: Attributes);
 
+declare const createToolbox: () => {
+    predicates: {
+        isElement: ElementPredicate<minim.Element>;
+        isStringElement: ElementPredicate<minim.StringElement>;
+        isNumberElement: ElementPredicate<minim.NumberElement>;
+        isNullElement: ElementPredicate<minim.NullElement>;
+        isBooleanElement: ElementPredicate<minim.BooleanElement>;
+        isObjectElement: ElementPredicate<minim.ObjectElement>;
+        isArrayElement: ElementPredicate<minim.ArrayElement>;
+        isMemberElement: ElementPredicate<minim.MemberElement>;
+        isLinkElement: ElementPredicate<minim.LinkElement>;
+        isRefElement: ElementPredicate<minim.RefElement>;
+        isAnnotationElement: ElementPredicate<Annotation>;
+        isCommentElement: ElementPredicate<Comment>;
+        isParseResultElement: ElementPredicate<ParseResult>;
+        isSourceMapElement: ElementPredicate<SourceMap>;
+        isPrimitiveElement: ElementPredicate<minim.StringElement | minim.ObjectElement | minim.ArrayElement | minim.NumberElement | minim.NullElement | minim.BooleanElement | minim.MemberElement>;
+        hasElementSourceMap: <T extends minim.Element>(element: T) => boolean;
+        includesSymbols: <T_1 extends minim.Element>(symbols: string[], element: T_1) => boolean;
+        includesClasses: <T_2 extends minim.Element>(classes: string[], element: T_2) => boolean;
+    };
+    namespace: Namespace;
+};
+
+declare const getNodeType: <T extends Element>(element: T) => string | undefined;
+declare const cloneNode: <T>(node: T) => T;
+declare const keyMapDefault: {
+    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[];
+};
+declare const visit: (root: Element, 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;
+
+interface DispatchPluginsOptions {
+    toolboxCreator: typeof createToolbox;
+    visitorOptions: {
+        nodeTypeGetter: typeof getNodeType;
+        exposeEdits: boolean;
+    };
+}
+interface DispatchPluginsSync {
+    <T extends Element, U extends Element = Element>(element: T, plugins: ((toolbox: any) => object)[], options?: Record<string, unknown>): U;
+    [key: symbol]: DispatchPluginsAsync;
+}
+interface DispatchPluginsAsync {
+    <T extends Element, U extends Element = Element>(element: T, plugins: ((toolbox: any) => object)[], options?: Record<string, unknown>): Promise<U>;
+}
+declare const dispatchPluginsSync: DispatchPluginsSync;
+
+/**
+ * Plugin for decorating every element in ApiDOM tree with UUID.
+ */
+declare const plugin$1: ({ length }?: {
+    length?: number | undefined;
+}) => () => {
+    pre(): void;
+    visitor: {
+        enter<T extends Element>(element: T): void;
+    };
+    post(): void;
+};
+
 interface PredicateHelpers {
@@ -138,8 +217,2 @@ hasMethod: typeof hasMethod;
 
-declare class Namespace extends Namespace$1 {
-    constructor();
-}
-declare const namespace: Namespace;
-declare const createNamespace: (namespacePlugin?: NamespacePlugin) => Namespace;
-
 declare const filter: <T extends Element>(predicate: (element: any) => boolean, element: T) => ArraySlice;
@@ -159,37 +232,2 @@
 
-declare const getNodeType: <T extends Element>(element: T) => string | undefined;
-declare const cloneNode: <T>(node: T) => T;
-declare const keyMapDefault: {
-    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[];
-};
-declare const visit: (root: Element, 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;
-
 type Callback = <T extends Element>(element: T) => void;
@@ -349,2 +387,2 @@ interface TraverseOptions {
 
-export { Annotation as AnnotationElement, CloneError, Comment as CommentElement, DeepCloneError, type DeepMergeUserOptions, ElementIdentityError, type ElementPredicate, IdentityManager, MediaTypes, type MergeRightOptions as MergeLeftOptions, type MergeRightOptions, Namespace, type ObjectOrArrayElement, ParseResult as ParseResultElement, type Position, type PositionRange, ShallowCloneError, SourceMap as SourceMapElement, Transcluder, cloneDeep, cloneNode, cloneShallow, createNamespace, createPredicate, deepmerge, defaultIdentityManager, dehydrate, dereference, dispatchPlugins as dispatchRefractorPlugins, filter, find, findAtOffset, fromFn as from, getNodeType, hasElementSourceMap, includesClasses, includesSymbols, isAnnotationElement, isArrayElement, isBooleanElement, isElement, isLinkElement, isMemberElement, isNullElement, isNumberElement, isObjectElement, isParseResultElement, isPrimitiveElement, isRefElement, isSourceMapElement, isStringElement, keyMapDefault as keyMap, mergeLeft, mergeRight, namespace, parents, plugin$1 as refractorPluginElementIdentity, plugin as refractorPluginSemanticElementIdentity, reject, sexprs, some, serializer$1 as toJSON, toString, serializer$2 as toValue, serializer as toYAML, transclude, traverse, visit };
+export { Annotation as AnnotationElement, CloneError, Comment as CommentElement, DeepCloneError, type DeepMergeUserOptions, type DispatchPluginsAsync, type DispatchPluginsOptions, type DispatchPluginsSync, ElementIdentityError, type ElementPredicate, IdentityManager, MediaTypes, type MergeRightOptions as MergeLeftOptions, type MergeRightOptions, Namespace, type ObjectOrArrayElement, ParseResult as ParseResultElement, type Position, type PositionRange, ShallowCloneError, SourceMap as SourceMapElement, Transcluder, cloneDeep, cloneNode, cloneShallow, createNamespace, createPredicate, deepmerge, defaultIdentityManager, dehydrate, dereference, dispatchPluginsSync as dispatchRefractorPlugins, filter, find, findAtOffset, fromFn as from, getNodeType, hasElementSourceMap, includesClasses, includesSymbols, isAnnotationElement, isArrayElement, isBooleanElement, isElement, isLinkElement, isMemberElement, isNullElement, isNumberElement, isObjectElement, isParseResultElement, isPrimitiveElement, isRefElement, isSourceMapElement, isStringElement, keyMapDefault as keyMap, mergeLeft, mergeRight, namespace, parents, plugin$1 as refractorPluginElementIdentity, plugin as refractorPluginSemanticElementIdentity, reject, sexprs, some, serializer$1 as toJSON, toString, serializer$2 as toValue, serializer as toYAML, transclude, traverse, visit };

No alert changes

Improved metrics

Total package byte prevSize

889623

increased by1.05%

Lines of code

18389

increased by0.86%

Dependency changes

• + Added@swagger-api/apidom-ast@0.99.2(transitive)

• + Added@swagger-api/apidom-error@0.99.0(transitive)

• + Addedramda@0.30.0(transitive)

• + Addedramda-adjunct@5.0.0(transitive)

• - Removed@swagger-api/apidom-ast@0.98.0(transitive)

• - Removed@swagger-api/apidom-error@0.98.0(transitive)

• Updated@swagger-api/apidom-ast@^0.99.0

• Updated@swagger-api/apidom-error@^0.99.0