@swagger-api/apidom-core 0.97.0 → 0.99.0

package/es/index.mjs

@@ -1,4 +1,4 @@
-export { dispatchPlugins as dispatchRefractorPlugins } from "./refractor/plugins/utils/index.mjs";
+export { dispatchPluginsSync as dispatchRefractorPlugins } from "./refractor/plugins/dispatcher/index.mjs";
 export { default as refractorPluginElementIdentity } from "./refractor/plugins/element-identity.mjs";
 export { default as refractorPluginSemanticElementIdentity } from "./refractor/plugins/semantic-element-identity.mjs";
 export { default as MediaTypes } from "./media-types.mjs";

package/es/refractor/index.mjs

@@ -1,4 +1,4 @@
-import { dispatchPlugins } from "./plugins/utils/index.mjs";
+import { dispatchPluginsSync } from "./plugins/dispatcher/index.mjs";
 import { getNodeType } from "../traversal/visitor.mjs";
 import { cloneDeep } from "../clone/index.mjs";
 import { isElement } from "../predicates/index.mjs";
@@ -26,7 +26,7 @@ const refract = (value, {
    * Run plugins only when necessary.
    * Running plugins visitors means extra single traversal === performance hit.
    */
-  return dispatchPlugins(element, plugins, {
+  return dispatchPluginsSync(element, plugins, {
     toolboxCreator: createToolbox,
     visitorOptions: {
       nodeTypeGetter: getNodeType

package/es/refractor/plugins/dispatcher/index.mjs

@@ -0,0 +1,48 @@
+import { mergeDeepRight, propOr } from 'ramda';
+import { invokeArgs } from 'ramda-adjunct';
+import createToolbox from "../../toolbox.mjs";
+import { getNodeType, mergeAllVisitors, visit } from "../../../traversal/visitor.mjs";
+const defaultDispatchPluginsOptions = {
+  toolboxCreator: createToolbox,
+  visitorOptions: {
+    nodeTypeGetter: getNodeType,
+    exposeEdits: true
+  }
+};
+export const dispatchPluginsSync = (element, plugins, options = {}) => {
+  if (plugins.length === 0) return element;
+  const mergedOptions = mergeDeepRight(defaultDispatchPluginsOptions, options);
+  const {
+    toolboxCreator,
+    visitorOptions
+  } = mergedOptions;
+  const toolbox = toolboxCreator();
+  const pluginsSpecs = plugins.map(plugin => plugin(toolbox));
+  const mergedPluginsVisitor = mergeAllVisitors(pluginsSpecs.map(propOr({}, 'visitor')), {
+    ...visitorOptions
+  });
+  pluginsSpecs.forEach(invokeArgs(['pre'], []));
+  const newElement = visit(element, mergedPluginsVisitor, visitorOptions);
+  pluginsSpecs.forEach(invokeArgs(['post'], []));
+  return newElement;
+};
+export const dispatchPluginsAsync = async (element, plugins, options = {}) => {
+  if (plugins.length === 0) return element;
+  const mergedOptions = mergeDeepRight(defaultDispatchPluginsOptions, options);
+  const {
+    toolboxCreator,
+    visitorOptions
+  } = mergedOptions;
+  const toolbox = toolboxCreator();
+  const pluginsSpecs = plugins.map(plugin => plugin(toolbox));
+  const mergeAllVisitorsAsync = mergeAllVisitors[Symbol.for('nodejs.util.promisify.custom')];
+  const visitAsync = visit[Symbol.for('nodejs.util.promisify.custom')];
+  const mergedPluginsVisitor = mergeAllVisitorsAsync(pluginsSpecs.map(propOr({}, 'visitor')), {
+    ...visitorOptions
+  });
+  await Promise.allSettled(pluginsSpecs.map(invokeArgs(['pre'], [])));
+  const newElement = await visitAsync(element, mergedPluginsVisitor, visitorOptions);
+  await Promise.allSettled(pluginsSpecs.map(invokeArgs(['post'], [])));
+  return newElement;
+};
+dispatchPluginsSync[Symbol.for('nodejs.util.promisify.custom')] = dispatchPluginsAsync;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swagger-api/apidom-core",
-  "version": "0.97.0",
+  "version": "0.99.0",
   "description": "Tools for manipulating ApiDOM structures.",
   "publishConfig": {
     "access": "public",
@@ -42,8 +42,8 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.20.7",
-    "@swagger-api/apidom-ast": "^0.97.0",
-    "@swagger-api/apidom-error": "^0.97.0",
+    "@swagger-api/apidom-ast": "^0.99.0",
+    "@swagger-api/apidom-error": "^0.99.0",
     "@types/ramda": "~0.29.6",
     "minim": "~0.23.8",
     "ramda": "~0.29.1",
@@ -62,5 +62,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "b616e76738c48401d651a272daef174f6c1a6510"
+  "gitHead": "e3c5ac3e738d561a0eb6d9d0f729e0d6bf20b00f"
 }

package/types/dist.d.ts

@@ -1,26 +1,17 @@
 /// <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';
 import { ApiDOMStructuredError, ApiDOMErrorOptions } from '@swagger-api/apidom-error';
 import stampit from 'stampit';
 import ShortUniqueId from 'short-unique-id';
 export { BREAK, mergeAllVisitors } from '@swagger-api/apidom-ast';
 
-declare const dispatchPlugins: <T extends Element>(element: T, plugins: ((toolbox: any) => object)[], options?: {}) => T;
-
-/**
- * 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 Namespace extends Namespace$1 {
+    constructor();
+}
+declare const namespace: Namespace;
+declare const createNamespace: (namespacePlugin?: NamespacePlugin) => Namespace;
 
 declare class Annotation extends StringElement {
     constructor(content?: string, meta?: Meta, attributes?: Attributes);
@@ -60,6 +51,94 @@ declare class SourceMap extends ArrayElement {
     set position(position: PositionRange | undefined);
 }
 
+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 {
     hasMethod: typeof hasMethod;
     hasBasicElementProps: typeof hasBasicElementProps;
@@ -133,12 +212,6 @@ declare class MediaTypes<T> extends Array<T> {
     latest(): void;
 }
 
-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;
 
 declare const find: <T extends Element>(predicate: (element: any) => boolean, element: T) => T | undefined;
@@ -153,41 +226,6 @@ declare const reject: <T extends Element>(predicate: (element: any) => boolean,
 
 declare const some: <T extends Element>(predicate: (element: any) => boolean, element: T) => boolean;
 
-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;
 interface TraverseOptions {
     callback?: Callback;
@@ -342,4 +380,4 @@ declare const mergeLeft: {
     all(list: ObjectOrArrayElement[], options?: MergeRightOptions | undefined): any;
 };
 
-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 };

package/cjs/refractor/plugins/utils/index.cjs

@@ -1,36 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.dispatchPlugins = void 0;
-var _ramda = require("ramda");
-var _ramdaAdjunct = require("ramda-adjunct");
-var _toolbox = _interopRequireDefault(require("../../toolbox.cjs"));
-var _visitor = require("../../../traversal/visitor.cjs");
-const defaultDispatchPluginsOptions = {
-  toolboxCreator: _toolbox.default,
-  visitorOptions: {
-    nodeTypeGetter: _visitor.getNodeType,
-    exposeEdits: true
-  }
-};
-
-// eslint-disable-next-line import/prefer-default-export
-const dispatchPlugins = (element, plugins, options = {}) => {
-  if (plugins.length === 0) return element;
-  const mergedOptions = (0, _ramda.mergeDeepRight)(defaultDispatchPluginsOptions, options);
-  const {
-    toolboxCreator,
-    visitorOptions
-  } = mergedOptions;
-  const toolbox = toolboxCreator();
-  const pluginsSpecs = plugins.map(plugin => plugin(toolbox));
-  const mergedPluginsVisitor = (0, _visitor.mergeAllVisitors)(pluginsSpecs.map((0, _ramda.propOr)({}, 'visitor')), {
-    ...visitorOptions
-  });
-  pluginsSpecs.forEach((0, _ramdaAdjunct.invokeArgs)(['pre'], []));
-  const newElement = (0, _visitor.visit)(element, mergedPluginsVisitor, visitorOptions);
-  pluginsSpecs.forEach((0, _ramdaAdjunct.invokeArgs)(['post'], []));
-  return newElement;
-};
-exports.dispatchPlugins = dispatchPlugins;

package/es/refractor/plugins/utils/index.mjs

@@ -1,30 +0,0 @@
-import { mergeDeepRight, propOr } from 'ramda';
-import { invokeArgs } from 'ramda-adjunct';
-import createToolbox from "../../toolbox.mjs";
-import { getNodeType, mergeAllVisitors, visit } from "../../../traversal/visitor.mjs";
-const defaultDispatchPluginsOptions = {
-  toolboxCreator: createToolbox,
-  visitorOptions: {
-    nodeTypeGetter: getNodeType,
-    exposeEdits: true
-  }
-};
-
-// eslint-disable-next-line import/prefer-default-export
-export const dispatchPlugins = (element, plugins, options = {}) => {
-  if (plugins.length === 0) return element;
-  const mergedOptions = mergeDeepRight(defaultDispatchPluginsOptions, options);
-  const {
-    toolboxCreator,
-    visitorOptions
-  } = mergedOptions;
-  const toolbox = toolboxCreator();
-  const pluginsSpecs = plugins.map(plugin => plugin(toolbox));
-  const mergedPluginsVisitor = mergeAllVisitors(pluginsSpecs.map(propOr({}, 'visitor')), {
-    ...visitorOptions
-  });
-  pluginsSpecs.forEach(invokeArgs(['pre'], []));
-  const newElement = visit(element, mergedPluginsVisitor, visitorOptions);
-  pluginsSpecs.forEach(invokeArgs(['post'], []));
-  return newElement;
-};