@swagger-api/apidom-core 0.98.0 → 0.99.1

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.99.1](https://github.com/swagger-api/apidom/compare/v0.99.0...v0.99.1) (2024-04-05)
+
+**Note:** Version bump only for package @swagger-api/apidom-core
+
+# [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)
 
 **Note:** Version bump only for package @swagger-api/apidom-core

package/cjs/index.cjs

@@ -4,8 +4,8 @@ var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopReq
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 exports.__esModule = true;
 exports.visit = exports.traverse = exports.transclude = exports.toYAML = exports.toValue = exports.toString = exports.toJSON = exports.some = exports.sexprs = exports.reject = exports.refractorPluginSemanticElementIdentity = exports.refractorPluginElementIdentity = exports.refract = exports.parents = exports.namespace = exports.mergeRight = exports.mergeLeft = exports.mergeAllVisitors = exports.keyMap = exports.isStringElement = exports.isSourceMapElement = exports.isRefElement = exports.isPrimitiveElement = exports.isParseResultElement = exports.isObjectElement = exports.isNumberElement = exports.isNullElement = exports.isMemberElement = exports.isLinkElement = exports.isElement = exports.isBooleanElement = exports.isArrayElement = exports.isAnnotationElement = exports.includesSymbols = exports.includesClasses = exports.hasElementSourceMap = exports.getNodeType = exports.from = exports.findAtOffset = exports.find = exports.filter = exports.dispatchRefractorPlugins = exports.dereference = exports.dehydrate = exports.defaultIdentityManager = exports.deepmerge = exports.createPredicate = exports.createNamespace = exports.cloneShallow = exports.cloneNode = exports.cloneDeep = exports.Transcluder = exports.StringElement = exports.SourceMapElement = exports.ShallowCloneError = exports.RefElement = exports.ParseResultElement = exports.ObjectSlice = exports.ObjectElement = exports.NumberElement = exports.NullElement = exports.Namespace = exports.MemberElement = exports.MediaTypes = exports.LinkElement = exports.KeyValuePair = exports.IdentityManager = exports.ElementIdentityError = exports.Element = exports.DeepCloneError = exports.CommentElement = exports.CloneError = exports.BooleanElement = exports.BREAK = exports.ArraySlice = exports.ArrayElement = exports.AnnotationElement = void 0;
-var _index = require("./refractor/plugins/utils/index.cjs");
-exports.dispatchRefractorPlugins = _index.dispatchPlugins;
+var _index = require("./refractor/plugins/dispatcher/index.cjs");
+exports.dispatchRefractorPlugins = _index.dispatchPluginsSync;
 var _elementIdentity = _interopRequireDefault(require("./refractor/plugins/element-identity.cjs"));
 exports.refractorPluginElementIdentity = _elementIdentity.default;
 var _semanticElementIdentity = _interopRequireDefault(require("./refractor/plugins/semantic-element-identity.cjs"));

package/cjs/refractor/index.cjs

@@ -3,7 +3,7 @@
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 exports.__esModule = true;
 exports.default = exports.createRefractor = void 0;
-var _index = require("./plugins/utils/index.cjs");
+var _index = require("./plugins/dispatcher/index.cjs");
 var _visitor = require("../traversal/visitor.cjs");
 var _index2 = require("../clone/index.cjs");
 var _index3 = require("../predicates/index.cjs");
@@ -31,7 +31,7 @@ const refract = (value, {
    * Run plugins only when necessary.
    * Running plugins visitors means extra single traversal === performance hit.
    */
-  return (0, _index.dispatchPlugins)(element, plugins, {
+  return (0, _index.dispatchPluginsSync)(element, plugins, {
     toolboxCreator: _toolbox.default,
     visitorOptions: {
       nodeTypeGetter: _visitor.getNodeType

package/cjs/refractor/plugins/dispatcher/index.cjs

@@ -0,0 +1,55 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.dispatchPluginsSync = exports.dispatchPluginsAsync = 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
+  }
+};
+const dispatchPluginsSync = (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.dispatchPluginsSync = dispatchPluginsSync;
+const dispatchPluginsAsync = async (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 mergeAllVisitorsAsync = _visitor.mergeAllVisitors[Symbol.for('nodejs.util.promisify.custom')];
+  const visitAsync = _visitor.visit[Symbol.for('nodejs.util.promisify.custom')];
+  const mergedPluginsVisitor = mergeAllVisitorsAsync(pluginsSpecs.map((0, _ramda.propOr)({}, 'visitor')), {
+    ...visitorOptions
+  });
+  await Promise.allSettled(pluginsSpecs.map((0, _ramdaAdjunct.invokeArgs)(['pre'], [])));
+  const newElement = await visitAsync(element, mergedPluginsVisitor, visitorOptions);
+  await Promise.allSettled(pluginsSpecs.map((0, _ramdaAdjunct.invokeArgs)(['post'], [])));
+  return newElement;
+};
+exports.dispatchPluginsAsync = dispatchPluginsAsync;
+dispatchPluginsSync[Symbol.for('nodejs.util.promisify.custom')] = dispatchPluginsAsync;

package/dist/apidom-core.browser.js

@@ -913,6 +913,72 @@ const includesClasses = (classes, element) => {
 
 /***/ }),
 
+/***/ 8999:
+/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
+
+"use strict";
+__webpack_require__.r(__webpack_exports__);
+/* harmony export */ __webpack_require__.d(__webpack_exports__, {
+/* harmony export */   dispatchPluginsAsync: () => (/* binding */ dispatchPluginsAsync),
+/* harmony export */   dispatchPluginsSync: () => (/* binding */ dispatchPluginsSync)
+/* harmony export */ });
+/* harmony import */ var ramda__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(1515);
+/* harmony import */ var ramda__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(5379);
+/* harmony import */ var ramda_adjunct__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(1465);
+/* harmony import */ var _toolbox__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(4225);
+/* harmony import */ var _traversal_visitor__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(192);
+/* harmony import */ var _traversal_visitor__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(7951);
+
+
+
+
+const defaultDispatchPluginsOptions = {
+  toolboxCreator: _toolbox__WEBPACK_IMPORTED_MODULE_0__["default"],
+  visitorOptions: {
+    nodeTypeGetter: _traversal_visitor__WEBPACK_IMPORTED_MODULE_1__.getNodeType,
+    exposeEdits: true
+  }
+};
+const dispatchPluginsSync = (element, plugins, options = {}) => {
+  if (plugins.length === 0) return element;
+  const mergedOptions = (0,ramda__WEBPACK_IMPORTED_MODULE_2__["default"])(defaultDispatchPluginsOptions, options);
+  const {
+    toolboxCreator,
+    visitorOptions
+  } = mergedOptions;
+  const toolbox = toolboxCreator();
+  const pluginsSpecs = plugins.map(plugin => plugin(toolbox));
+  const mergedPluginsVisitor = (0,_traversal_visitor__WEBPACK_IMPORTED_MODULE_3__.mergeAll)(pluginsSpecs.map((0,ramda__WEBPACK_IMPORTED_MODULE_4__["default"])({}, 'visitor')), {
+    ...visitorOptions
+  });
+  pluginsSpecs.forEach((0,ramda_adjunct__WEBPACK_IMPORTED_MODULE_5__["default"])(['pre'], []));
+  const newElement = (0,_traversal_visitor__WEBPACK_IMPORTED_MODULE_1__.visit)(element, mergedPluginsVisitor, visitorOptions);
+  pluginsSpecs.forEach((0,ramda_adjunct__WEBPACK_IMPORTED_MODULE_5__["default"])(['post'], []));
+  return newElement;
+};
+const dispatchPluginsAsync = async (element, plugins, options = {}) => {
+  if (plugins.length === 0) return element;
+  const mergedOptions = (0,ramda__WEBPACK_IMPORTED_MODULE_2__["default"])(defaultDispatchPluginsOptions, options);
+  const {
+    toolboxCreator,
+    visitorOptions
+  } = mergedOptions;
+  const toolbox = toolboxCreator();
+  const pluginsSpecs = plugins.map(plugin => plugin(toolbox));
+  const mergeAllVisitorsAsync = _traversal_visitor__WEBPACK_IMPORTED_MODULE_3__.mergeAll[Symbol.for('nodejs.util.promisify.custom')];
+  const visitAsync = _traversal_visitor__WEBPACK_IMPORTED_MODULE_1__.visit[Symbol.for('nodejs.util.promisify.custom')];
+  const mergedPluginsVisitor = mergeAllVisitorsAsync(pluginsSpecs.map((0,ramda__WEBPACK_IMPORTED_MODULE_4__["default"])({}, 'visitor')), {
+    ...visitorOptions
+  });
+  await Promise.allSettled(pluginsSpecs.map((0,ramda_adjunct__WEBPACK_IMPORTED_MODULE_5__["default"])(['pre'], [])));
+  const newElement = await visitAsync(element, mergedPluginsVisitor, visitorOptions);
+  await Promise.allSettled(pluginsSpecs.map((0,ramda_adjunct__WEBPACK_IMPORTED_MODULE_5__["default"])(['post'], [])));
+  return newElement;
+};
+dispatchPluginsSync[Symbol.for('nodejs.util.promisify.custom')] = dispatchPluginsAsync;
+
+/***/ }),
+
 /***/ 2836:
 /***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
 
@@ -995,53 +1061,6 @@ const plugin = ({
 
 /***/ }),
 
-/***/ 6967:
-/***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
-
-"use strict";
-__webpack_require__.r(__webpack_exports__);
-/* harmony export */ __webpack_require__.d(__webpack_exports__, {
-/* harmony export */   dispatchPlugins: () => (/* binding */ dispatchPlugins)
-/* harmony export */ });
-/* harmony import */ var ramda__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(1515);
-/* harmony import */ var ramda__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(5379);
-/* harmony import */ var ramda_adjunct__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(1465);
-/* harmony import */ var _toolbox__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(4225);
-/* harmony import */ var _traversal_visitor__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(192);
-/* harmony import */ var _traversal_visitor__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(7951);
-
-
-
-
-const defaultDispatchPluginsOptions = {
-  toolboxCreator: _toolbox__WEBPACK_IMPORTED_MODULE_0__["default"],
-  visitorOptions: {
-    nodeTypeGetter: _traversal_visitor__WEBPACK_IMPORTED_MODULE_1__.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__WEBPACK_IMPORTED_MODULE_2__["default"])(defaultDispatchPluginsOptions, options);
-  const {
-    toolboxCreator,
-    visitorOptions
-  } = mergedOptions;
-  const toolbox = toolboxCreator();
-  const pluginsSpecs = plugins.map(plugin => plugin(toolbox));
-  const mergedPluginsVisitor = (0,_traversal_visitor__WEBPACK_IMPORTED_MODULE_3__.mergeAll)(pluginsSpecs.map((0,ramda__WEBPACK_IMPORTED_MODULE_4__["default"])({}, 'visitor')), {
-    ...visitorOptions
-  });
-  pluginsSpecs.forEach((0,ramda_adjunct__WEBPACK_IMPORTED_MODULE_5__["default"])(['pre'], []));
-  const newElement = (0,_traversal_visitor__WEBPACK_IMPORTED_MODULE_1__.visit)(element, mergedPluginsVisitor, visitorOptions);
-  pluginsSpecs.forEach((0,ramda_adjunct__WEBPACK_IMPORTED_MODULE_5__["default"])(['post'], []));
-  return newElement;
-};
-
-/***/ }),
-
 /***/ 4225:
 /***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
 
@@ -16741,6 +16760,7 @@ const cloneNode = node => Object.create(Object.getPrototypeOf(node), Object.getO
  * If a prior visitor edits a node, no following visitors will see that node.
  * `exposeEdits=true` can be used to exoise the edited node from the previous visitors.
  */
+
 const mergeAll = (visitors, {
   visitFnGetter = getVisitFn,
   nodeTypeGetter = getNodeType,
@@ -16760,6 +16780,14 @@ const mergeAll = (visitors, {
           const visitFn = visitFnGetter(visitors[i], nodeTypeGetter(currentNode), false);
           if (typeof visitFn === 'function') {
             const result = visitFn.call(visitors[i], currentNode, ...rest);
+
+            // check if the visitor is async
+            if (typeof (result === null || result === void 0 ? void 0 : result.then) === 'function') {
+              throw new _swagger_api_apidom_error__WEBPACK_IMPORTED_MODULE_0__["default"]('Async visitor not supported in sync mode', {
+                visitor: visitors[i],
+                visitFn
+              });
+            }
             if (result === skipVisitingNodeSymbol) {
               skipping[i] = node;
             } else if (result === breakSymbol) {
@@ -16785,6 +16813,14 @@ const mergeAll = (visitors, {
           const visitFn = visitFnGetter(visitors[i], nodeTypeGetter(node), true);
           if (typeof visitFn === 'function') {
             const result = visitFn.call(visitors[i], node, ...rest);
+
+            // check if the visitor is async
+            if (typeof (result === null || result === void 0 ? void 0 : result.then) === 'function') {
+              throw new _swagger_api_apidom_error__WEBPACK_IMPORTED_MODULE_0__["default"]('Async visitor not supported in sync mode', {
+                visitor: visitors[i],
+                visitFn
+              });
+            }
             if (result === breakSymbol) {
               skipping[i] = breakSymbol;
             } else if (result !== undefined && result !== skipVisitingNodeSymbol) {
@@ -16799,6 +16835,67 @@ const mergeAll = (visitors, {
     }
   };
 };
+const mergeAllAsync = (visitors, {
+  visitFnGetter = getVisitFn,
+  nodeTypeGetter = getNodeType,
+  breakSymbol = BREAK,
+  deleteNodeSymbol = null,
+  skipVisitingNodeSymbol = false,
+  exposeEdits = false
+} = {}) => {
+  const skipSymbol = Symbol('skip');
+  const skipping = new Array(visitors.length).fill(skipSymbol);
+  return {
+    async enter(node, ...rest) {
+      let currentNode = node;
+      let hasChanged = false;
+      for (let i = 0; i < visitors.length; i += 1) {
+        if (skipping[i] === skipSymbol) {
+          const visitFn = visitFnGetter(visitors[i], nodeTypeGetter(currentNode), false);
+          if (typeof visitFn === 'function') {
+            // eslint-disable-next-line no-await-in-loop
+            const result = await visitFn.call(visitors[i], currentNode, ...rest);
+            if (result === skipVisitingNodeSymbol) {
+              skipping[i] = node;
+            } else if (result === breakSymbol) {
+              skipping[i] = breakSymbol;
+            } else if (result === deleteNodeSymbol) {
+              return result;
+            } else if (result !== undefined) {
+              if (exposeEdits) {
+                currentNode = result;
+                hasChanged = true;
+              } else {
+                return result;
+              }
+            }
+          }
+        }
+      }
+      return hasChanged ? currentNode : undefined;
+    },
+    async leave(node, ...rest) {
+      for (let i = 0; i < visitors.length; i += 1) {
+        if (skipping[i] === skipSymbol) {
+          const visitFn = visitFnGetter(visitors[i], nodeTypeGetter(node), true);
+          if (typeof visitFn === 'function') {
+            // eslint-disable-next-line no-await-in-loop
+            const result = await visitFn.call(visitors[i], node, ...rest);
+            if (result === breakSymbol) {
+              skipping[i] = breakSymbol;
+            } else if (result !== undefined && result !== skipVisitingNodeSymbol) {
+              return result;
+            }
+          }
+        } else if (skipping[i] === node) {
+          skipping[i] = skipSymbol;
+        }
+      }
+      return undefined;
+    }
+  };
+};
+mergeAll[Symbol.for('nodejs.util.promisify.custom')] = mergeAllAsync;
 
 /* eslint-disable no-continue, no-param-reassign */
 /**
@@ -16967,6 +17064,7 @@ visitor, {
     }
     let result;
     if (!Array.isArray(node)) {
+      var _result;
       if (!nodePredicate(node)) {
         throw new _swagger_api_apidom_error__WEBPACK_IMPORTED_MODULE_0__["default"](`Invalid AST Node:  ${String(node)}`, {
           node
@@ -16988,6 +17086,14 @@ visitor, {
         // retrieve result
         result = visitFn.call(visitor, node, key, parent, path, ancestors);
       }
+
+      // check if the visitor is async
+      if (typeof ((_result = result) === null || _result === void 0 ? void 0 : _result.then) === 'function') {
+        throw new _swagger_api_apidom_error__WEBPACK_IMPORTED_MODULE_0__["default"]('Async visitor not supported in sync mode', {
+          visitor,
+          visitFn
+        });
+      }
       if (result === breakSymbol) {
         break;
       }
@@ -17469,7 +17575,7 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export */   defaultIdentityManager: () => (/* reexport safe */ _identity__WEBPACK_IMPORTED_MODULE_27__.defaultIdentityManager),
 /* harmony export */   dehydrate: () => (/* reexport safe */ _transformers_dehydrate__WEBPACK_IMPORTED_MODULE_33__["default"]),
 /* harmony export */   dereference: () => (/* reexport safe */ _util__WEBPACK_IMPORTED_MODULE_22__.dereference),
-/* harmony export */   dispatchRefractorPlugins: () => (/* reexport safe */ _refractor_plugins_utils__WEBPACK_IMPORTED_MODULE_0__.dispatchPlugins),
+/* harmony export */   dispatchRefractorPlugins: () => (/* reexport safe */ _refractor_plugins_dispatcher__WEBPACK_IMPORTED_MODULE_0__.dispatchPluginsSync),
 /* harmony export */   filter: () => (/* reexport safe */ _traversal_index__WEBPACK_IMPORTED_MODULE_12__["default"]),
 /* harmony export */   find: () => (/* reexport safe */ _traversal_index__WEBPACK_IMPORTED_MODULE_14__["default"]),
 /* harmony export */   findAtOffset: () => (/* reexport safe */ _traversal_index__WEBPACK_IMPORTED_MODULE_15__["default"]),
@@ -17512,7 +17618,7 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export */   traverse: () => (/* reexport safe */ _traversal_index__WEBPACK_IMPORTED_MODULE_17__["default"]),
 /* harmony export */   visit: () => (/* reexport safe */ _traversal_visitor__WEBPACK_IMPORTED_MODULE_19__.visit)
 /* harmony export */ });
-/* harmony import */ var _refractor_plugins_utils__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(6967);
+/* harmony import */ var _refractor_plugins_dispatcher__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(8999);
 /* harmony import */ var _refractor_plugins_element_identity__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(2836);
 /* harmony import */ var _refractor_plugins_semantic_element_identity__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(4503);
 /* harmony import */ var _media_types__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(8267);