@swagger-api/apidom-parser-adapter-json 0.70.3 → 0.71.0

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.71.0](https://github.com/swagger-api/apidom/compare/v0.70.4...v0.71.0) (2023-07-13)
+
+**Note:** Version bump only for package @swagger-api/apidom-parser-adapter-json
+
+
+
+
+
+## [0.70.4](https://github.com/swagger-api/apidom/compare/v0.70.3...v0.70.4) (2023-06-28)
+
+### Bug Fixes
+
+- **parser-adapter-json:** construct proper JavaScript string value ([#2896](https://github.com/swagger-api/apidom/issues/2896)) ([fcdd3d5](https://github.com/swagger-api/apidom/commit/fcdd3d5144fe74eb5a05af20a1f8ddb1c9411ae4)), closes [#2670](https://github.com/swagger-api/apidom/issues/2670)
+
+### Performance Improvements
+
+- **parser-adapter-json:** use tree-sitter cursor for CST traversal ([#2891](https://github.com/swagger-api/apidom/issues/2891)) ([13a8567](https://github.com/swagger-api/apidom/commit/13a85672e8ae158ce635d5b52b6828180876d21c)), closes [#691](https://github.com/swagger-api/apidom/issues/691)
+- **parser-adapter-json:** use tree-sitter cursor for CST traversal (indirect) ([#2895](https://github.com/swagger-api/apidom/issues/2895)) ([3f9c9a2](https://github.com/swagger-api/apidom/commit/3f9c9a2fbbfd4afdcf17cdce34523c0229444b15)), closes [#691](https://github.com/swagger-api/apidom/issues/691)
+
 ## [0.70.3](https://github.com/swagger-api/apidom/compare/v0.70.2...v0.70.3) (2023-06-27)
 
 ### Bug Fixes

package/cjs/syntactic-analysis/TreeCursorIterator.cjs

@@ -0,0 +1,62 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.default = void 0;
+var _TreeCursorSyntaxNode = _interopRequireDefault(require("./TreeCursorSyntaxNode.cjs"));
+class TreeCursorIterator {
+  constructor(cursor) {
+    this.cursor = cursor;
+  }
+  document() {
+    return new _TreeCursorSyntaxNode.default(this.cursor);
+  }
+  object() {
+    return new _TreeCursorSyntaxNode.default(this.cursor).setFieldName(this.cursor);
+  }
+  array() {
+    return new _TreeCursorSyntaxNode.default(this.cursor).setFieldName(this.cursor);
+  }
+  pair() {
+    return new _TreeCursorSyntaxNode.default(this.cursor);
+  }
+  string() {
+    return new _TreeCursorSyntaxNode.default(this.cursor).setFieldName(this.cursor);
+  }
+  number() {
+    return new _TreeCursorSyntaxNode.default(this.cursor).setFieldName(this.cursor);
+  }
+  null() {
+    return new _TreeCursorSyntaxNode.default(this.cursor).setFieldName(this.cursor);
+  }
+  true() {
+    return new _TreeCursorSyntaxNode.default(this.cursor).setFieldName(this.cursor);
+  }
+  false() {
+    return new _TreeCursorSyntaxNode.default(this.cursor).setFieldName(this.cursor);
+  }
+  ERROR() {
+    return new _TreeCursorSyntaxNode.default(this.cursor).setHasError(this.cursor);
+  }
+  *[Symbol.iterator]() {
+    let node;
+    if (this.cursor.nodeType in this) {
+      // @ts-ignore
+      node = this[this.cursor.nodeType]();
+    } else {
+      node = new _TreeCursorSyntaxNode.default(this.cursor);
+    }
+    if (this.cursor.gotoFirstChild()) {
+      const [firstChild] = new TreeCursorIterator(this.cursor);
+      node.pushChildren(firstChild);
+      while (this.cursor.gotoNextSibling()) {
+        const firstChildSiblings = new TreeCursorIterator(this.cursor);
+        node.pushChildren(...firstChildSiblings);
+      }
+      this.cursor.gotoParent();
+    }
+    yield node;
+  }
+}
+var _default = TreeCursorIterator;
+exports.default = _default;

package/cjs/syntactic-analysis/TreeCursorSyntaxNode.cjs

@@ -0,0 +1,51 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+class TreeCursorSyntaxNode {
+  hasError = false;
+  children = [];
+  constructor(cursor) {
+    this.type = cursor.nodeType;
+    this.startPosition = cursor.startPosition;
+    this.endPosition = cursor.endPosition;
+    this.startIndex = cursor.startIndex;
+    this.endIndex = cursor.endIndex;
+    this.text = cursor.nodeText;
+    this.isNamed = cursor.nodeIsNamed;
+    this.isMissing = cursor.nodeIsMissing;
+  }
+  get keyNode() {
+    if (this.type === 'pair') {
+      return this.children.find(node => node.fieldName === 'key');
+    }
+    return undefined;
+  }
+  get valueNode() {
+    if (this.type === 'pair') {
+      return this.children.find(node => node.fieldName === 'value');
+    }
+    return undefined;
+  }
+  setFieldName(cursor) {
+    if (typeof cursor.currentFieldName === 'function') {
+      this.fieldName = cursor.currentFieldName();
+    } else {
+      this.fieldName = cursor.currentFieldName;
+    }
+    return this;
+  }
+  setHasError(cursor) {
+    if (typeof cursor.currentNode === 'function') {
+      this.hasError = cursor.currentNode().hasError();
+    } else {
+      this.hasError = cursor.currentNode.hasError();
+    }
+    return this;
+  }
+  pushChildren(...children) {
+    this.children.push(...children);
+  }
+}
+var _default = TreeCursorSyntaxNode;
+exports.default = _default;

package/cjs/syntactic-analysis/direct/index.cjs

@@ -3,11 +3,10 @@
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
 exports.__esModule = true;
 exports.default = void 0;
-var _stampit = _interopRequireDefault(require("stampit"));
 var _apidomAst = require("@swagger-api/apidom-ast");
 var _apidomCore = require("@swagger-api/apidom-core");
-/* eslint-disable no-underscore-dangle */
-
+var _CstVisitor = _interopRequireDefault(require("./visitors/CstVisitor.cjs"));
+var _TreeCursorIterator = _interopRequireDefault(require("../TreeCursorIterator.cjs"));
 const keyMap = {
   document: ['children'],
   object: ['children'],
@@ -30,196 +29,31 @@ const getNodeType = node => {
 
 // @ts-ignore
 const isNode = element => (0, _apidomCore.isElement)(element) || (0, _apidomAst.isNode)(element);
-const Visitor = (0, _stampit.default)({
-  props: {
-    sourceMap: false,
-    annotations: []
-  },
-  init() {
-    /**
-     * Private API.
-     */
-
-    this.annotations = [];
-    const toPosition = node => {
-      if (node === null) {
-        return null;
-      }
-      const start = new _apidomCore.ArrayElement([node.startPosition.row, node.startPosition.column, node.startIndex]);
-      const end = new _apidomCore.ArrayElement([node.endPosition.row, node.endPosition.column, node.endIndex]);
-      start.classes.push('position');
-      end.classes.push('position');
-      return [start, end];
-    };
-    const maybeAddSourceMap = (node, element) => {
-      if (!this.sourceMap) {
-        return;
-      }
-      const sourceMap = new _apidomCore.SourceMapElement();
-      const position = toPosition(node);
-      if (position !== null) {
-        const [start, end] = position;
-        sourceMap.push(start);
-        sourceMap.push(end);
-      }
-      // @ts-ignore
-      sourceMap.astNode = node;
-      element.meta.set('sourceMap', sourceMap);
-    };
-    const getFieldFromNode = (fieldName, node) => {
-      var _node$childForFieldNa;
-      return `${fieldName}Node` in node ?
-      // @ts-ignore
-      node[`${fieldName}Node`] : 'childForFieldName' in node ? (_node$childForFieldNa = node.childForFieldName) === null || _node$childForFieldNa === void 0 ? void 0 : _node$childForFieldNa.call(node, fieldName) : null;
-    };
-
-    /**
-     * Public API.
-     */
-
-    this.enter = function enter(node) {
-      // missing anonymous literals from CST transformed into AnnotationElements.
-      // WARNING: be aware that web-tree-sitter and tree-sitter node bindings have inconsistency
-      // in `SyntaxNode.isNamed` property. web-tree-sitter has it defined as method
-      // whether tree-sitter node binding has it defined as a boolean property.
-      if ((typeof node.isNamed === 'function' && !node.isNamed() || node.isNamed === false) && node.isMissing()) {
-        // collect annotations from missing literals
-        const value = node.type || node.text;
-        const message = `(Missing ${value})`;
-        const element = new _apidomCore.AnnotationElement(message);
-        element.classes.push('warning');
-        maybeAddSourceMap(node, element);
-        this.annotations.push(element);
-      }
-      return null; // remove everything unrecognized
-    };
-
-    this.document = function document(node) {
-      const element = new _apidomCore.ParseResultElement();
-      // @ts-ignore
-      element._content = node.children;
-      maybeAddSourceMap(node, element);
-      return element;
-    };
-    this.ParseResultElement = {
-      leave(element) {
-        // mark first-non Annotation element as result
-        // @ts-ignore
-        const elements = element.findElements(_apidomCore.isPrimitiveElement);
-        if (elements.length > 0) {
-          const resultElement = elements[0];
-          resultElement.classes.push('result');
-        }
-
-        // provide annotations
-        this.annotations.forEach(annotationElement => {
-          element.push(annotationElement);
-        });
-        this.annotations = [];
-      }
-    };
-    this.object = function object(node) {
-      const element = new _apidomCore.ObjectElement();
-      // @ts-ignore
-      element._content = node.children;
-      maybeAddSourceMap(node, element);
-      return element;
-    };
-    this.array = function array(node) {
-      const element = new _apidomCore.ArrayElement();
-      // @ts-ignore
-      element._content = node.children;
-      maybeAddSourceMap(node, element);
-      return element;
-    };
-    this.pair = function pair(node) {
-      const element = new _apidomCore.MemberElement();
-      // @ts-ignore
-      element.content.key = getFieldFromNode('key', node);
-      // @ts-ignore
-      element.content.value = getFieldFromNode('value', node);
-      maybeAddSourceMap(node, element);
-
-      /**
-       * Process possible errors here that may be present in pair node children as we're using direct field access.
-       * There are usually 3 children here found: "key", ":", "value".
-       */
-      if (node.children.length > 3) {
-        node.children
-        // @ts-ignore
-        .filter(child => child.type === 'ERROR').forEach(errorNode => {
-          this.ERROR(errorNode, node, [], [node]);
-        });
-      }
-      return element;
-    };
-    this.string = function string(node) {
-      const element = new _apidomCore.StringElement(node.text.slice(1, -1));
-      maybeAddSourceMap(node, element);
-      return element;
-    };
-    this.number = function number(node) {
-      const element = new _apidomCore.NumberElement(Number(node.text));
-      maybeAddSourceMap(node, element);
-      return element;
-    };
-
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    this.null = function _null(node) {
-      const element = new _apidomCore.NullElement();
-      maybeAddSourceMap(node, element);
-      return element;
-    };
-
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    this.true = function _true(node) {
-      const element = new _apidomCore.BooleanElement(true);
-      maybeAddSourceMap(node, element);
-      return element;
-    };
-
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    this.false = function _false(node) {
-      const element = new _apidomCore.BooleanElement(false);
-      maybeAddSourceMap(node, element);
-      return element;
-    };
-    this.ERROR = function ERROR(node, key, parent, path) {
-      // collect errors as annotations
-      const isUnexpected = !node.hasError();
-      const value = node.text;
-      const message = isUnexpected ? `(Unexpected ${value})` : `(Error ${value})`;
-      const element = new _apidomCore.AnnotationElement(message);
-      element.classes.push('error');
-      maybeAddSourceMap(node, element);
-      if (path.length === 0) {
-        // no document to visit, only error is present in CST
-        const parseResultElement = new _apidomCore.ParseResultElement();
-        parseResultElement.push(element);
-        return parseResultElement;
-      }
-
-      // we have CST node for document
-      this.annotations.push(element);
-      return null;
-    };
-  }
-});
 
 /**
- * This version of syntactic analysis translates TreeSitter CTS into ApiDOM.
+ * This version of syntactic analysis translates TreeSitter CTS
+ * directly into ApiDOM.
+ *
+ * Transient transformation of TreeSitter CST is performed
+ * using TreeSitter cursor. TreeSitter cursor is a stateful object
+ * that allows us to walk syntax tree containing large number of nodes
+ * with maximum efficiency. Using this transient CST transformation
+ * gives us double the performance when syntactically analyzing
+ * CST into ApiDOM.
+ *
  * Single traversal pass is needed to get from CST to ApiDOM.
  */
 const analyze = (cst, {
   sourceMap = false
 } = {}) => {
-  const visitor = Visitor();
-  return (0, _apidomAst.visit)(cst.rootNode, visitor, {
+  const visitor = (0, _CstVisitor.default)();
+  const cursor = cst.walk();
+  const iterator = new _TreeCursorIterator.default(cursor);
+  const rootNode = [...iterator].at(0);
+  return (0, _apidomAst.visit)(rootNode, visitor, {
     // @ts-ignore
     keyMap,
-    // @ts-ignore
     nodeTypeGetter: getNodeType,
-    // @ts-ignore
     nodePredicate: isNode,
     state: {
       sourceMap

package/cjs/syntactic-analysis/direct/visitors/CstVisitor.cjs

@@ -0,0 +1,175 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.default = void 0;
+var _stampit = _interopRequireDefault(require("stampit"));
+var _apidomCore = require("@swagger-api/apidom-core");
+var _TreeCursorSyntaxNode = _interopRequireDefault(require("../../TreeCursorSyntaxNode.cjs"));
+/* eslint-disable no-underscore-dangle */
+
+const CstVisitor = (0, _stampit.default)({
+  props: {
+    sourceMap: false,
+    annotations: []
+  },
+  init() {
+    /**
+     * Private API.
+     */
+
+    this.annotations = [];
+    const toPosition = node => {
+      const start = new _apidomCore.ArrayElement([node.startPosition.row, node.startPosition.column, node.startIndex]);
+      const end = new _apidomCore.ArrayElement([node.endPosition.row, node.endPosition.column, node.endIndex]);
+      start.classes.push('position');
+      end.classes.push('position');
+      return [start, end];
+    };
+    const maybeAddSourceMap = (node, element) => {
+      if (!this.sourceMap) {
+        return;
+      }
+      const sourceMap = new _apidomCore.SourceMapElement();
+      const position = toPosition(node);
+      if (position !== null) {
+        const [start, end] = position;
+        sourceMap.push(start);
+        sourceMap.push(end);
+      }
+      // @ts-ignore
+      sourceMap.astNode = node;
+      element.meta.set('sourceMap', sourceMap);
+    };
+
+    /**
+     * Public API.
+     */
+
+    this.enter = function enter(node) {
+      // missing anonymous literals from CST transformed into AnnotationElements.
+      if (node instanceof _TreeCursorSyntaxNode.default && !node.isNamed && node.isMissing) {
+        // collect annotations from missing literals
+        const value = node.type || node.text;
+        const message = `(Missing ${value})`;
+        const element = new _apidomCore.AnnotationElement(message);
+        element.classes.push('warning');
+        maybeAddSourceMap(node, element);
+        this.annotations.push(element);
+      }
+      return null; // remove everything unrecognized
+    };
+
+    this.document = function document(node) {
+      const element = new _apidomCore.ParseResultElement();
+      // @ts-ignore
+      element._content = node.children;
+      maybeAddSourceMap(node, element);
+      return element;
+    };
+    this.ParseResultElement = {
+      leave(element) {
+        // mark first-non Annotation element as result
+        // @ts-ignore
+        const elements = element.findElements(_apidomCore.isPrimitiveElement);
+        if (elements.length > 0) {
+          const resultElement = elements[0];
+          resultElement.classes.push('result');
+        }
+
+        // provide annotations
+        this.annotations.forEach(annotationElement => {
+          element.push(annotationElement);
+        });
+        this.annotations = [];
+      }
+    };
+    this.object = function object(node) {
+      const element = new _apidomCore.ObjectElement();
+      // @ts-ignore
+      element._content = node.children;
+      maybeAddSourceMap(node, element);
+      return element;
+    };
+    this.array = function array(node) {
+      const element = new _apidomCore.ArrayElement();
+      // @ts-ignore
+      element._content = node.children;
+      maybeAddSourceMap(node, element);
+      return element;
+    };
+    this.pair = function pair(node) {
+      const element = new _apidomCore.MemberElement();
+      // @ts-ignore
+      element.content.key = node.keyNode;
+      // @ts-ignore
+      element.content.value = node.valueNode;
+      maybeAddSourceMap(node, element);
+
+      /**
+       * Process possible errors here that may be present in pair node children as we're using direct field access.
+       * There are usually 3 children here found: "key", ":", "value".
+       */
+      if (node.children.length > 3) {
+        node.children.filter(child => child.type === 'ERROR').forEach(errorNode => {
+          this.ERROR(errorNode, node, [], [node]);
+        });
+      }
+      return element;
+    };
+    this.string = function string(node) {
+      const element = new _apidomCore.StringElement(JSON.parse(node.text));
+      maybeAddSourceMap(node, element);
+      return element;
+    };
+    this.number = function number(node) {
+      const element = new _apidomCore.NumberElement(Number(node.text));
+      maybeAddSourceMap(node, element);
+      return element;
+    };
+
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    this.null = function _null(node) {
+      const element = new _apidomCore.NullElement();
+      maybeAddSourceMap(node, element);
+      return element;
+    };
+
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    this.true = function _true(node) {
+      const element = new _apidomCore.BooleanElement(true);
+      maybeAddSourceMap(node, element);
+      return element;
+    };
+
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    this.false = function _false(node) {
+      const element = new _apidomCore.BooleanElement(false);
+      maybeAddSourceMap(node, element);
+      return element;
+    };
+    this.ERROR = function ERROR(node, key, parent, path) {
+      // collect errors as annotations
+      const isUnexpected = !node.hasError;
+      const value = node.text;
+      const message = isUnexpected ? `(Unexpected ${value})` : `(Error ${value})`;
+      const element = new _apidomCore.AnnotationElement(message);
+      element.classes.push('error');
+      maybeAddSourceMap(node, element);
+      if (path.length === 0) {
+        // no document to visit, only error is present in CST
+        const parseResultElement = new _apidomCore.ParseResultElement();
+        parseResultElement.push(element);
+        return parseResultElement;
+      }
+
+      // we have CST node for document
+      this.annotations.push(element);
+      return null;
+    };
+  }
+});
+
+/* eslint-enable no-underscore-dangle */
+var _default = CstVisitor;
+exports.default = _default;

package/cjs/syntactic-analysis/indirect/index.cjs

@@ -1,8 +1,10 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
 exports.__esModule = true;
 exports.default = void 0;
 var _apidomAst = require("@swagger-api/apidom-ast");
+var _TreeCursorIterator = _interopRequireDefault(require("../TreeCursorIterator.cjs"));
 var _CstVisitor = _interopRequireWildcard(require("./visitors/CstVisitor.cjs"));
 var _JsonAstVisitor = _interopRequireWildcard(require("./visitors/JsonAstVisitor.cjs"));
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
@@ -10,6 +12,14 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
 /**
  * This version of syntactic analysis does following transformations:
  *   TreeSitter CST -> JSON AST -> ApiDOM
+ *
+ * Transient transformation of TreeSitter CST is performed
+ * using TreeSitter cursor. TreeSitter cursor is a stateful object
+ * that allows us to walk syntax tree containing large number of nodes
+ * with maximum efficiency. Using this transient CST transformation
+ * gives us double the performance when syntactically analyzing
+ * CST into JSON AST.
+ *
  * Two traversals passes are needed to get from CST to ApiDOM.
  * This analysis is much slower than the direct one, but allows
  * to do additional analysis magic on JSON AST.
@@ -17,9 +27,12 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
 const analyze = (cst, {
   sourceMap = false
 } = {}) => {
+  const cursor = cst.walk();
+  const iterator = new _TreeCursorIterator.default(cursor);
+  const rootNode = [...iterator].at(0);
   const cstVisitor = (0, _CstVisitor.default)();
   const astVisitor = (0, _JsonAstVisitor.default)();
-  const jsonAst = (0, _apidomAst.visit)(cst.rootNode, cstVisitor, {
+  const jsonAst = (0, _apidomAst.visit)(rootNode, cstVisitor, {
     // @ts-ignore
     keyMap: _CstVisitor.keyMap,
     state: {
@@ -29,7 +42,6 @@ const analyze = (cst, {
   return (0, _apidomAst.visit)(jsonAst.rootNode, astVisitor, {
     // @ts-ignore
     keyMap: _JsonAstVisitor.keyMap,
-    // @ts-ignore
     nodeTypeGetter: _JsonAstVisitor.getNodeType,
     nodePredicate: _JsonAstVisitor.isNode,
     state: {