@swagger-api/apidom-ast 0.76.2 → 0.78.0

package/es/traversal/visitor.mjs

@@ -43,6 +43,9 @@ export const getNodeType = node => node === null || node === void 0 ? void 0 : n
 // isNode :: Node -> Boolean
 export const isNode = node => typeof getNodeType(node) === 'string';
 
+// cloneNode :: a -> a
+export const cloneNode = node => Object.create(Object.getPrototypeOf(node), Object.getOwnPropertyDescriptors(node));
+
 /**
  * Creates a new visitor instance which delegates to many visitors to run in
  * parallel. Each visitor will be visited for each node before moving on.
@@ -53,11 +56,11 @@ export const mergeAll = (visitors, {
   visitFnGetter = getVisitFn,
   nodeTypeGetter = getNodeType
 } = {}) => {
-  const skipping = new Array(visitors.length);
+  const skipping = new Array(visitors.length).fill(null);
   return {
     enter(node, ...rest) {
       for (let i = 0; i < visitors.length; i += 1) {
-        if (skipping[i] == null) {
+        if (skipping[i] === null) {
           const fn = visitFnGetter(visitors[i], nodeTypeGetter(node), /* isLeaving */false);
           if (typeof fn === 'function') {
             const result = fn.call(visitors[i], node, ...rest);
@@ -75,7 +78,7 @@ export const mergeAll = (visitors, {
     },
     leave(node, ...rest) {
       for (let i = 0; i < visitors.length; i += 1) {
-        if (skipping[i] == null) {
+        if (skipping[i] === null) {
           const fn = visitFnGetter(visitors[i], nodeTypeGetter(node), /* isLeaving */true);
           if (typeof fn === 'function') {
             const result = fn.call(visitors[i], node, ...rest);
@@ -197,6 +200,7 @@ visitor, {
   visitFnGetter = getVisitFn,
   nodeTypeGetter = getNodeType,
   nodePredicate = isNode,
+  nodeCloneFn = cloneNode,
   detectCycles = true
 } = {}) => {
   const visitorKeys = keyMap || {};
@@ -206,15 +210,14 @@ visitor, {
   let index = -1;
   let parent;
   let edits = [];
+  let node = root;
   const path = [];
   // @ts-ignore
   const ancestors = [];
-  let newRoot = root;
   do {
     index += 1;
     const isLeaving = index === keys.length;
     let key;
-    let node;
     const isEdited = isLeaving && edits.length !== 0;
     if (isLeaving) {
       key = ancestors.length === 0 ? undefined : path.pop();
@@ -223,23 +226,22 @@ visitor, {
       parent = ancestors.pop();
       if (isEdited) {
         if (inArray) {
-          // @ts-ignore
+          // @ts-ignore; creating clone
           node = node.slice();
+          let editOffset = 0;
+          for (const [editKey, editValue] of edits) {
+            const arrayKey = editKey - editOffset;
+            if (editValue === deleteNodeSymbol) {
+              node.splice(arrayKey, 1);
+              editOffset += 1;
+            } else {
+              node[arrayKey] = editValue;
+            }
+          }
         } else {
           // creating clone
-          node = Object.create(Object.getPrototypeOf(node), Object.getOwnPropertyDescriptors(node));
-        }
-        let editOffset = 0;
-        for (let ii = 0; ii < edits.length; ii += 1) {
-          let editKey = edits[ii][0];
-          const editValue = edits[ii][1];
-          if (inArray) {
-            editKey -= editOffset;
-          }
-          if (inArray && editValue === deleteNodeSymbol) {
-            node.splice(editKey, 1);
-            editOffset += 1;
-          } else {
+          node = nodeCloneFn(node);
+          for (const [editKey, editValue] of edits) {
             node[editKey] = editValue;
           }
         }
@@ -252,15 +254,13 @@ visitor, {
       inArray = stack.inArray;
       // @ts-ignore
       stack = stack.prev;
-    } else {
-      key = parent ? inArray ? index : keys[index] : undefined;
-      node = parent ? parent[key] : newRoot;
+    } else if (parent !== deleteNodeSymbol && parent !== undefined) {
+      key = inArray ? index : keys[index];
+      node = parent[key];
       if (node === deleteNodeSymbol || node === undefined) {
         continue;
       }
-      if (parent) {
-        path.push(key);
-      }
+      path.push(key);
     }
     if (ancestors.includes(node)) {
       continue;
@@ -270,6 +270,7 @@ visitor, {
       if (!nodePredicate(node)) {
         throw new ApiDOMError(`Invalid AST Node:  ${JSON.stringify(node)}`);
       }
+
       // cycle detected; skipping over a sub-tree to avoid recursion
       if (detectCycles && ancestors.includes(node)) {
         path.pop();
@@ -282,25 +283,26 @@ visitor, {
         for (const [stateKey, stateValue] of Object.entries(state)) {
           visitor[stateKey] = stateValue;
         }
+        // retrieve result
         result = visitFn.call(visitor, node, key, parent, path, ancestors);
-        if (result === breakSymbol) {
-          break;
+      }
+      if (result === breakSymbol) {
+        break;
+      }
+      if (result === skipVisitingNodeSymbol) {
+        if (!isLeaving) {
+          path.pop();
+          continue;
         }
-        if (result === skipVisitingNodeSymbol) {
-          if (!isLeaving) {
+      } else if (result !== undefined) {
+        edits.push([key, result]);
+        if (!isLeaving) {
+          if (nodePredicate(result)) {
+            node = result;
+          } else {
             path.pop();
             continue;
           }
-        } else if (result !== undefined) {
-          edits.push([key, result]);
-          if (!isLeaving) {
-            if (nodePredicate(result)) {
-              node = result;
-            } else {
-              path.pop();
-              continue;
-            }
-          }
         }
       }
     }
@@ -308,6 +310,7 @@ visitor, {
       edits.push([key, node]);
     }
     if (!isLeaving) {
+      var _visitorKeys$nodeType;
       stack = {
         inArray,
         index,
@@ -317,19 +320,19 @@ visitor, {
       };
       inArray = Array.isArray(node);
       // @ts-ignore
-      keys = inArray ? node : visitorKeys[nodeTypeGetter(node)] || [];
+      keys = inArray ? node : (_visitorKeys$nodeType = visitorKeys[nodeTypeGetter(node)]) !== null && _visitorKeys$nodeType !== void 0 ? _visitorKeys$nodeType : [];
       index = -1;
       edits = [];
-      if (parent) {
+      if (parent !== deleteNodeSymbol && parent !== undefined) {
         ancestors.push(parent);
       }
       parent = node;
     }
   } while (stack !== undefined);
   if (edits.length !== 0) {
-    [, newRoot] = edits[edits.length - 1];
+    return edits.at(-1)[1];
   }
-  return newRoot;
+  return root;
 };
 
 /**
@@ -349,6 +352,7 @@ visitor, {
   visitFnGetter = getVisitFn,
   nodeTypeGetter = getNodeType,
   nodePredicate = isNode,
+  nodeCloneFn = cloneNode,
   detectCycles = true
 } = {}) => {
   const visitorKeys = keyMap || {};
@@ -358,15 +362,14 @@ visitor, {
   let index = -1;
   let parent;
   let edits = [];
+  let node = root;
   const path = [];
   // @ts-ignore
   const ancestors = [];
-  let newRoot = root;
   do {
     index += 1;
     const isLeaving = index === keys.length;
     let key;
-    let node;
     const isEdited = isLeaving && edits.length !== 0;
     if (isLeaving) {
       key = ancestors.length === 0 ? undefined : path.pop();
@@ -375,23 +378,22 @@ visitor, {
       parent = ancestors.pop();
       if (isEdited) {
         if (inArray) {
-          // @ts-ignore
+          // @ts-ignore; creating clone
           node = node.slice();
+          let editOffset = 0;
+          for (const [editKey, editValue] of edits) {
+            const arrayKey = editKey - editOffset;
+            if (editValue === deleteNodeSymbol) {
+              node.splice(arrayKey, 1);
+              editOffset += 1;
+            } else {
+              node[arrayKey] = editValue;
+            }
+          }
         } else {
           // creating clone
-          node = Object.create(Object.getPrototypeOf(node), Object.getOwnPropertyDescriptors(node));
-        }
-        let editOffset = 0;
-        for (let ii = 0; ii < edits.length; ii += 1) {
-          let editKey = edits[ii][0];
-          const editValue = edits[ii][1];
-          if (inArray) {
-            editKey -= editOffset;
-          }
-          if (inArray && editValue === deleteNodeSymbol) {
-            node.splice(editKey, 1);
-            editOffset += 1;
-          } else {
+          node = nodeCloneFn(node);
+          for (const [editKey, editValue] of edits) {
             node[editKey] = editValue;
           }
         }
@@ -404,21 +406,20 @@ visitor, {
       inArray = stack.inArray;
       // @ts-ignore
       stack = stack.prev;
-    } else {
-      key = parent ? inArray ? index : keys[index] : undefined;
-      node = parent ? parent[key] : newRoot;
+    } else if (parent !== deleteNodeSymbol && parent !== undefined) {
+      key = inArray ? index : keys[index];
+      node = parent[key];
       if (node === deleteNodeSymbol || node === undefined) {
         continue;
       }
-      if (parent) {
-        path.push(key);
-      }
+      path.push(key);
     }
     let result;
     if (!Array.isArray(node)) {
       if (!nodePredicate(node)) {
         throw new ApiDOMError(`Invalid AST Node:  ${JSON.stringify(node)}`);
       }
+
       // cycle detected; skipping over a sub-tree to avoid recursion
       if (detectCycles && ancestors.includes(node)) {
         path.pop();
@@ -431,26 +432,27 @@ visitor, {
           visitor[stateKey] = stateValue;
         }
 
-        // eslint-disable-next-line no-await-in-loop
-        result = await visitFn.call(visitor, node, key, parent, path, ancestors);
-        if (result === breakSymbol) {
-          break;
+        // retrieve result
+        result = await visitFn.call(visitor, node, key, parent, path, ancestors); // eslint-disable-line no-await-in-loop
+      }
+
+      if (result === breakSymbol) {
+        break;
+      }
+      if (result === skipVisitingNodeSymbol) {
+        if (!isLeaving) {
+          path.pop();
+          continue;
         }
-        if (result === skipVisitingNodeSymbol) {
-          if (!isLeaving) {
+      } else if (result !== undefined) {
+        edits.push([key, result]);
+        if (!isLeaving) {
+          if (nodePredicate(result)) {
+            node = result;
+          } else {
             path.pop();
             continue;
           }
-        } else if (result !== undefined) {
-          edits.push([key, result]);
-          if (!isLeaving) {
-            if (nodePredicate(result)) {
-              node = result;
-            } else {
-              path.pop();
-              continue;
-            }
-          }
         }
       }
     }
@@ -458,6 +460,7 @@ visitor, {
       edits.push([key, node]);
     }
     if (!isLeaving) {
+      var _visitorKeys$nodeType2;
       stack = {
         inArray,
         index,
@@ -467,19 +470,19 @@ visitor, {
       };
       inArray = Array.isArray(node);
       // @ts-ignore
-      keys = inArray ? node : visitorKeys[nodeTypeGetter(node)] || [];
+      keys = inArray ? node : (_visitorKeys$nodeType2 = visitorKeys[nodeTypeGetter(node)]) !== null && _visitorKeys$nodeType2 !== void 0 ? _visitorKeys$nodeType2 : [];
       index = -1;
       edits = [];
-      if (parent) {
+      if (parent !== deleteNodeSymbol && parent !== undefined) {
         ancestors.push(parent);
       }
       parent = node;
     }
   } while (stack !== undefined);
   if (edits.length !== 0) {
-    [, newRoot] = edits[edits.length - 1];
+    return edits.at(-1)[1];
   }
-  return newRoot;
+  return root;
 };
 
 /* eslint-enable */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swagger-api/apidom-ast",
-  "version": "0.76.2",
+  "version": "0.78.0",
   "description": "Tools necessary for parsing stage of ApiDOM, specifically for syntactic analysis.",
   "publishConfig": {
     "access": "public",
@@ -42,8 +42,8 @@
   "homepage": "https://github.com/swagger-api/apidom#readme",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.20.7",
-    "@swagger-api/apidom-error": "^0.76.2",
-    "@types/ramda": "~0.29.3",
+    "@swagger-api/apidom-error": "^0.78.0",
+    "@types/ramda": "~0.29.6",
     "ramda": "~0.29.0",
     "ramda-adjunct": "^4.1.1",
     "stampit": "^4.3.2",
@@ -59,5 +59,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "8c6c02f813a663cfaf0ac0963f2b4fd25b8dffe8"
+  "gitHead": "d6587217f8a7bec5bbc49ca4dabff8d3d66e0913"
 }

package/types/dist.d.ts

@@ -265,6 +265,7 @@ declare const getVisitFn: (visitor: any, type: string, isLeaving: boolean) => an
 declare const BREAK: {};
 declare const getNodeType: (node: any) => any;
 declare const isNode: (node: any) => boolean;
+declare const cloneNode: (node: any) => any;
 /**
  * Creates a new visitor instance which delegates to many visitors to run in
  * parallel. Each visitor will be visited for each node before moving on.
@@ -367,7 +368,7 @@ declare const mergeAll: (visitors: any[], { visitFnGetter, nodeTypeGetter }?: {
  *  @sig visit :: (Node, Visitor, Options)
  *  @sig      Options = { keyMap: Object, state: Object }
  */
-declare const visit: (root: any, visitor: any, { keyMap, state, breakSymbol, deleteNodeSymbol, skipVisitingNodeSymbol, visitFnGetter, nodeTypeGetter, nodePredicate, detectCycles, }?: {
+declare const visit: (root: any, visitor: any, { keyMap, state, breakSymbol, deleteNodeSymbol, skipVisitingNodeSymbol, visitFnGetter, nodeTypeGetter, nodePredicate, nodeCloneFn, detectCycles, }?: {
     keyMap?: null | undefined;
     state?: {} | undefined;
     breakSymbol?: {} | undefined;
@@ -376,7 +377,8 @@ declare const visit: (root: any, visitor: any, { keyMap, state, breakSymbol, del
     visitFnGetter?: ((visitor: any, type: string, isLeaving: boolean) => any) | undefined;
     nodeTypeGetter?: ((node: any) => any) | undefined;
     nodePredicate?: ((node: any) => boolean) | undefined;
+    nodeCloneFn?: ((node: any) => any) | undefined;
     detectCycles?: boolean | undefined;
 }) => any;
 
-export { BREAK, Error, JsonArray, JsonDocument, JsonEscapeSequence, JsonFalse, JsonKey, JsonNode, JsonNull, JsonNumber, JsonObject, JsonProperty, JsonString, JsonStringContent, JsonTrue, JsonValue, Literal, ParseResult, Point, Position, YamlAlias, YamlAnchor, YamlCollection, YamlComment, YamlDirective, YamlDocument, FailsafeSchema as YamlFailsafeSchema, JsonSchema as YamlJsonSchema, YamlKeyValuePair, YamlMapping, YamlNode, YamlNodeKind, YamlScalar, YamlSchemaError, YamlSequence, YamlStream, YamlStyle, YamlStyleGroup, YamlTag, YamlTagError, YamlTagErrorOptions, getNodeType, getVisitFn, isArray as isJsonArray, isDocument$1 as isJsonDocument, isEscapeSequence as isJsonEscapeSequence, isFalse as isJsonFalse, isKey as isJsonKey, isNull as isJsonNull, isNumber as isJsonNumber, isObject as isJsonObject, isProperty as isJsonProperty, isString as isJsonString, isStringContent as isJsonStringContent, isTrue as isJsonTrue, isLiteral, isNode, isParseResult, isPoint, isPosition, isAlias as isYamlAlias, isDirective as isYamlDirective, isDocument as isYamlDocument, isKeyValuePair as isYamlKeyValuePair, isMapping as isYamlMapping, isScalar as isYamlScalar, isSequence as isYamlSequence, isStream as isYamlStream, isTag as isYamlTag, mergeAll as mergeAllVisitors, visit };
+export { BREAK, Error, JsonArray, JsonDocument, JsonEscapeSequence, JsonFalse, JsonKey, JsonNode, JsonNull, JsonNumber, JsonObject, JsonProperty, JsonString, JsonStringContent, JsonTrue, JsonValue, Literal, ParseResult, Point, Position, YamlAlias, YamlAnchor, YamlCollection, YamlComment, YamlDirective, YamlDocument, FailsafeSchema as YamlFailsafeSchema, JsonSchema as YamlJsonSchema, YamlKeyValuePair, YamlMapping, YamlNode, YamlNodeKind, YamlScalar, YamlSchemaError, YamlSequence, YamlStream, YamlStyle, YamlStyleGroup, YamlTag, YamlTagError, type YamlTagErrorOptions, cloneNode, getNodeType, getVisitFn, isArray as isJsonArray, isDocument$1 as isJsonDocument, isEscapeSequence as isJsonEscapeSequence, isFalse as isJsonFalse, isKey as isJsonKey, isNull as isJsonNull, isNumber as isJsonNumber, isObject as isJsonObject, isProperty as isJsonProperty, isString as isJsonString, isStringContent as isJsonStringContent, isTrue as isJsonTrue, isLiteral, isNode, isParseResult, isPoint, isPosition, isAlias as isYamlAlias, isDirective as isYamlDirective, isDocument as isYamlDocument, isKeyValuePair as isYamlKeyValuePair, isMapping as isYamlMapping, isScalar as isYamlScalar, isSequence as isYamlSequence, isStream as isYamlStream, isTag as isYamlTag, mergeAll as mergeAllVisitors, visit };