@swagger-api/apidom-ast 1.0.0-alpha.9 → 1.0.0-beta.0

package/{cjs → src}/json/nodes/JsonDocument.cjs

@@ -5,6 +5,9 @@ exports.__esModule = true;
 exports.default = void 0;
 var _ramda = require("ramda");
 var _JsonNode = _interopRequireDefault(require("./JsonNode.cjs"));
+/**
+ * @public
+ */
 class JsonDocument extends _JsonNode.default {
   static type = 'document';
   get child() {

package/{es → src}/json/nodes/JsonDocument.mjs

@@ -1,5 +1,8 @@
 import { head } from 'ramda';
 import JsonNode from "./JsonNode.mjs";
+/**
+ * @public
+ */
 class JsonDocument extends JsonNode {
   static type = 'document';
   get child() {

package/{cjs → src}/json/nodes/JsonEscapeSequence.cjs

@@ -4,6 +4,9 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
 exports.__esModule = true;
 exports.default = void 0;
 var _JsonValue = _interopRequireDefault(require("./JsonValue.cjs"));
+/**
+ * @public
+ */
 class JsonEscapeSequence extends _JsonValue.default {
   static type = 'escapeSequence';
 }

package/{es → src}/json/nodes/JsonEscapeSequence.mjs

@@ -1,4 +1,7 @@
 import JsonValue from "./JsonValue.mjs";
+/**
+ * @public
+ */
 class JsonEscapeSequence extends JsonValue {
   static type = 'escapeSequence';
 }

package/{cjs → src}/json/nodes/JsonFalse.cjs

@@ -4,6 +4,9 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
 exports.__esModule = true;
 exports.default = void 0;
 var _JsonValue = _interopRequireDefault(require("./JsonValue.cjs"));
+/**
+ * @public
+ */
 class JsonFalse extends _JsonValue.default {
   static type = 'false';
 }

package/{es → src}/json/nodes/JsonFalse.mjs

@@ -1,4 +1,7 @@
 import JsonValue from "./JsonValue.mjs";
+/**
+ * @public
+ */
 class JsonFalse extends JsonValue {
   static type = 'false';
 }

package/{cjs → src}/json/nodes/JsonKey.cjs

@@ -4,6 +4,9 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
 exports.__esModule = true;
 exports.default = void 0;
 var _JsonString = _interopRequireDefault(require("./JsonString.cjs"));
+/**
+ * @public
+ */
 class JsonKey extends _JsonString.default {
   static type = 'key';
 }

package/{es → src}/json/nodes/JsonKey.mjs

@@ -1,4 +1,7 @@
 import JsonString from "./JsonString.mjs";
+/**
+ * @public
+ */
 class JsonKey extends JsonString {
   static type = 'key';
 }

package/{cjs → src}/json/nodes/JsonNode.cjs

@@ -4,5 +4,8 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
 exports.__esModule = true;
 exports.default = void 0;
 var _Node = _interopRequireDefault(require("../../Node.cjs"));
+/**
+ * @public
+ */
 class JsonNode extends _Node.default {}
 var _default = exports.default = JsonNode;

package/{es → src}/json/nodes/JsonNode.mjs

@@ -1,3 +1,6 @@
 import Node from "../../Node.mjs";
+/**
+ * @public
+ */
 class JsonNode extends Node {}
 export default JsonNode;

package/{cjs → src}/json/nodes/JsonNull.cjs

@@ -4,6 +4,9 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
 exports.__esModule = true;
 exports.default = void 0;
 var _JsonValue = _interopRequireDefault(require("./JsonValue.cjs"));
+/**
+ * @public
+ */
 class JsonNull extends _JsonValue.default {
   static type = 'null';
 }

package/{es → src}/json/nodes/JsonNull.mjs

@@ -1,4 +1,7 @@
 import JsonValue from "./JsonValue.mjs";
+/**
+ * @public
+ */
 class JsonNull extends JsonValue {
   static type = 'null';
 }

package/{cjs → src}/json/nodes/JsonNumber.cjs

@@ -4,6 +4,9 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
 exports.__esModule = true;
 exports.default = void 0;
 var _JsonValue = _interopRequireDefault(require("./JsonValue.cjs"));
+/**
+ * @public
+ */
 class JsonNumber extends _JsonValue.default {
   static type = 'number';
 }

package/{es → src}/json/nodes/JsonNumber.mjs

@@ -1,4 +1,7 @@
 import JsonValue from "./JsonValue.mjs";
+/**
+ * @public
+ */
 class JsonNumber extends JsonValue {
   static type = 'number';
 }

package/{cjs → src}/json/nodes/JsonObject.cjs

@@ -5,6 +5,9 @@ exports.__esModule = true;
 exports.default = void 0;
 var _JsonNode = _interopRequireDefault(require("./JsonNode.cjs"));
 var _predicates = require("./predicates.cjs");
+/**
+ * @public
+ */
 class JsonObject extends _JsonNode.default {
   static type = 'object';
   get properties() {

package/{es → src}/json/nodes/JsonObject.mjs

@@ -1,5 +1,8 @@
 import JsonNode from "./JsonNode.mjs";
 import { isProperty } from "./predicates.mjs";
+/**
+ * @public
+ */
 class JsonObject extends JsonNode {
   static type = 'object';
   get properties() {

package/{cjs → src}/json/nodes/JsonProperty.cjs

@@ -5,6 +5,13 @@ exports.__esModule = true;
 exports.default = void 0;
 var _JsonNode = _interopRequireDefault(require("./JsonNode.cjs"));
 var _predicates = require("./predicates.cjs");
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
 class JsonProperty extends _JsonNode.default {
   static type = 'property';
   get key() {

package/{es → src}/json/nodes/JsonProperty.mjs

@@ -1,5 +1,11 @@
 import JsonNode from "./JsonNode.mjs";
 import { isArray, isFalse, isKey, isNull, isNumber, isObject, isString, isTrue } from "./predicates.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
 class JsonProperty extends JsonNode {
   static type = 'property';
   get key() {

package/{cjs → src}/json/nodes/JsonString.cjs

@@ -5,6 +5,9 @@ exports.__esModule = true;
 exports.default = void 0;
 var _JsonNode = _interopRequireDefault(require("./JsonNode.cjs"));
 var _predicates = require("./predicates.cjs");
+/**
+ * @public
+ */
 class JsonString extends _JsonNode.default {
   static type = 'string';
   get value() {

package/{es → src}/json/nodes/JsonString.mjs

@@ -1,5 +1,8 @@
 import JsonNode from "./JsonNode.mjs";
 import { isEscapeSequence, isStringContent } from "./predicates.mjs";
+/**
+ * @public
+ */
 class JsonString extends JsonNode {
   static type = 'string';
   get value() {

package/{cjs → src}/json/nodes/JsonStringContent.cjs

@@ -4,6 +4,9 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
 exports.__esModule = true;
 exports.default = void 0;
 var _JsonValue = _interopRequireDefault(require("./JsonValue.cjs"));
+/**
+ * @public
+ */
 class JsonStringContent extends _JsonValue.default {
   static type = 'stringContent';
 }

package/{es → src}/json/nodes/JsonStringContent.mjs

@@ -1,4 +1,7 @@
 import JsonValue from "./JsonValue.mjs";
+/**
+ * @public
+ */
 class JsonStringContent extends JsonValue {
   static type = 'stringContent';
 }

package/{cjs → src}/json/nodes/JsonTrue.cjs

@@ -4,6 +4,9 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
 exports.__esModule = true;
 exports.default = void 0;
 var _JsonValue = _interopRequireDefault(require("./JsonValue.cjs"));
+/**
+ * @public
+ */
 class JsonTrue extends _JsonValue.default {
   static type = 'true';
 }

package/{es → src}/json/nodes/JsonTrue.mjs

@@ -1,4 +1,7 @@
 import JsonValue from "./JsonValue.mjs";
+/**
+ * @public
+ */
 class JsonTrue extends JsonValue {
   static type = 'true';
 }

package/{cjs → src}/json/nodes/JsonValue.cjs

@@ -4,6 +4,13 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
 exports.__esModule = true;
 exports.default = void 0;
 var _JsonNode = _interopRequireDefault(require("./JsonNode.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
 class JsonValue extends _JsonNode.default {
   static type = 'value';
   value;

package/{es → src}/json/nodes/JsonValue.mjs

@@ -1,4 +1,10 @@
 import JsonNode from "./JsonNode.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
 class JsonValue extends JsonNode {
   static type = 'value';
   value;

package/{cjs → src}/json/nodes/predicates.cjs

@@ -3,27 +3,74 @@
 exports.__esModule = true;
 exports.isTrue = exports.isStringContent = exports.isString = exports.isProperty = exports.isObject = exports.isNumber = exports.isNull = exports.isKey = exports.isFalse = exports.isEscapeSequence = exports.isDocument = exports.isArray = void 0;
 var _predicates = require("../../predicates.cjs");
+/**
+ * @public
+ */
 const isDocument = node => (0, _predicates.isNodeType)('document', node);
+
+/**
+ * @public
+ */
 exports.isDocument = isDocument;
 const isString = node => (0, _predicates.isNodeType)('string', node);
+
+/**
+ * @public
+ */
 exports.isString = isString;
 const isFalse = node => (0, _predicates.isNodeType)('false', node);
+
+/**
+ * @public
+ */
 exports.isFalse = isFalse;
 const isTrue = node => (0, _predicates.isNodeType)('true', node);
+
+/**
+ * @public
+ */
 exports.isTrue = isTrue;
 const isNull = node => (0, _predicates.isNodeType)('null', node);
+
+/**
+ * @public
+ */
 exports.isNull = isNull;
 const isNumber = node => (0, _predicates.isNodeType)('number', node);
+
+/**
+ * @public
+ */
 exports.isNumber = isNumber;
 const isArray = node => (0, _predicates.isNodeType)('array', node);
+
+/**
+ * @public
+ */
 exports.isArray = isArray;
 const isObject = node => (0, _predicates.isNodeType)('object', node);
+
+/**
+ * @public
+ */
 exports.isObject = isObject;
 const isStringContent = node => (0, _predicates.isNodeType)('stringContent', node);
+
+/**
+ * @public
+ */
 exports.isStringContent = isStringContent;
 const isEscapeSequence = node => (0, _predicates.isNodeType)('escapeSequence', node);
+
+/**
+ * @public
+ */
 exports.isEscapeSequence = isEscapeSequence;
 const isProperty = node => (0, _predicates.isNodeType)('property', node);
+
+/**
+ * @public
+ */
 exports.isProperty = isProperty;
 const isKey = node => (0, _predicates.isNodeType)('key', node);
 exports.isKey = isKey;

package/{es → src}/json/nodes/predicates.mjs

@@ -1,13 +1,60 @@
 import { isNodeType } from "../../predicates.mjs";
+/**
+ * @public
+ */
 export const isDocument = node => isNodeType('document', node);
+
+/**
+ * @public
+ */
 export const isString = node => isNodeType('string', node);
+
+/**
+ * @public
+ */
 export const isFalse = node => isNodeType('false', node);
+
+/**
+ * @public
+ */
 export const isTrue = node => isNodeType('true', node);
+
+/**
+ * @public
+ */
 export const isNull = node => isNodeType('null', node);
+
+/**
+ * @public
+ */
 export const isNumber = node => isNodeType('number', node);
+
+/**
+ * @public
+ */
 export const isArray = node => isNodeType('array', node);
+
+/**
+ * @public
+ */
 export const isObject = node => isNodeType('object', node);
+
+/**
+ * @public
+ */
 export const isStringContent = node => isNodeType('stringContent', node);
+
+/**
+ * @public
+ */
 export const isEscapeSequence = node => isNodeType('escapeSequence', node);
+
+/**
+ * @public
+ */
 export const isProperty = node => isNodeType('property', node);
+
+/**
+ * @public
+ */
 export const isKey = node => isNodeType('key', node);

package/{cjs → src}/predicates.cjs

@@ -2,13 +2,32 @@
 
 exports.__esModule = true;
 exports.isPosition = exports.isPoint = exports.isParseResult = exports.isNodeType = exports.isLiteral = void 0;
+/**
+ * @public
+ */
 const isNodeType = (type, node) => node != null && typeof node === 'object' && 'type' in node && node.type === type;
+
+/**
+ * @public
+ */
 exports.isNodeType = isNodeType;
 const isLiteral = node => isNodeType('literal', node);
+
+/**
+ * @public
+ */
 exports.isLiteral = isLiteral;
 const isPosition = node => isNodeType('position', node);
+
+/**
+ * @public
+ */
 exports.isPosition = isPosition;
 const isPoint = node => isNodeType('point', node);
+
+/**
+ * @public
+ */
 exports.isPoint = isPoint;
 const isParseResult = node => isNodeType('parseResult', node);
 exports.isParseResult = isParseResult;

package/{es → src}/predicates.mjs

@@ -1,5 +1,24 @@
+/**
+ * @public
+ */
 export const isNodeType = (type, node) => node != null && typeof node === 'object' && 'type' in node && node.type === type;
+
+/**
+ * @public
+ */
 export const isLiteral = node => isNodeType('literal', node);
+
+/**
+ * @public
+ */
 export const isPosition = node => isNodeType('position', node);
+
+/**
+ * @public
+ */
 export const isPoint = node => isNodeType('point', node);
+
+/**
+ * @public
+ */
 export const isParseResult = node => isNodeType('parseResult', node);

package/{cjs → src}/traversal/visitor.cjs

@@ -9,8 +9,11 @@ var _apidomError = require("@swagger-api/apidom-error");
  * SPDX-License-Identifier: MIT
  */
 
-// getVisitFn :: (Visitor, String, Boolean) -> Function
+/**
+ * @public
+ */
 const getVisitFn = (visitor, type, isLeaving) => {
+  // @ts-ignore
   const typeVisitor = visitor[type];
   if (typeVisitor != null) {
     if (!isLeaving && typeof typeVisitor === 'function') {
@@ -29,6 +32,7 @@ const getVisitFn = (visitor, type, isLeaving) => {
         // { enter() {}, leave() {} }
         return specificVisitor;
       }
+      // @ts-ignore
       const specificTypeVisitor = specificVisitor[type];
       if (typeof specificTypeVisitor === 'function') {
         // { enter: { Type() {} }, leave: { Type() {} } }
@@ -38,17 +42,27 @@ const getVisitFn = (visitor, type, isLeaving) => {
   }
   return null;
 };
+
+/**
+ * @public
+ */
 exports.getVisitFn = getVisitFn;
 const BREAK = exports.BREAK = {};
 
-// getNodeType :: Node -> String
+/**
+ * @public
+ */
 const getNodeType = node => node == null ? void 0 : node.type;
 
-// isNode :: Node -> Boolean
+/**
+ * @public
+ */
 exports.getNodeType = getNodeType;
 const isNode = node => typeof getNodeType(node) === 'string';
 
-// cloneNode :: a -> a
+/**
+ * @public
+ */
 exports.isNode = isNode;
 const cloneNode = node => Object.create(Object.getPrototypeOf(node), Object.getOwnPropertyDescriptors(node));
 
@@ -58,8 +72,16 @@ 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 expose the edited node from the previous visitors.
+ * @public
+ */
+
+/**
+ * @public
  */
 exports.cloneNode = cloneNode;
+/**
+ * @public
+ */
 const mergeAll = (visitors, {
   visitFnGetter = getVisitFn,
   nodeTypeGetter = getNodeType,
@@ -242,9 +264,11 @@ mergeAll[Symbol.for('nodejs.util.promisify.custom')] = mergeAllAsync;
  * a new version of the AST with the changes applied will be returned from the
  * visit function.
  *
+ * @example
+ * ```
  *     const editedAST = visit(ast, {
  *       enter(node, key, parent, path, ancestors) {
- *         // @return
+ *         // return
  *         //   undefined: no action
  *         //   false: skip visiting this node
  *         //   BREAK: stop visiting altogether
@@ -252,7 +276,7 @@ mergeAll[Symbol.for('nodejs.util.promisify.custom')] = mergeAllAsync;
  *         //   any value: replace this node with the returned value
  *       },
  *       leave(node, key, parent, path, ancestors) {
- *         // @return
+ *         // return
  *         //   undefined: no action
  *         //   false: no action
  *         //   BREAK: stop visiting altogether
@@ -260,23 +284,23 @@ mergeAll[Symbol.for('nodejs.util.promisify.custom')] = mergeAllAsync;
  *         //   any value: replace this node with the returned value
  *       }
  *     });
- *
+ *```
  * Alternatively to providing enter() and leave() functions, a visitor can
  * instead provide functions named the same as the kinds of AST nodes, or
  * enter/leave visitors at a named key, leading to four permutations of
  * visitor API:
  *
  * 1) Named visitors triggered when entering a node a specific kind.
- *
+ * ```
  *     visit(ast, {
  *       Kind(node) {
  *         // enter the "Kind" node
  *       }
  *     })
- *
+ * ```
  * 2) Named visitors that trigger upon entering and leaving a node of
  *    a specific kind.
- *
+ * ```
  *     visit(ast, {
  *       Kind: {
  *         enter(node) {
@@ -287,9 +311,9 @@ mergeAll[Symbol.for('nodejs.util.promisify.custom')] = mergeAllAsync;
  *         }
  *       }
  *     })
- *
+ * ```
  * 3) Generic visitors that trigger upon entering and leaving any node.
- *
+ * ```
  *     visit(ast, {
  *       enter(node) {
  *         // enter any node
@@ -298,9 +322,9 @@ mergeAll[Symbol.for('nodejs.util.promisify.custom')] = mergeAllAsync;
  *         // leave any node
  *       }
  *     })
- *
+ * ```
  * 4) Parallel visitors for entering and leaving nodes of a specific kind.
- *
+ * ```
  *     visit(ast, {
  *       enter: {
  *         Kind(node) {
@@ -313,9 +337,12 @@ mergeAll[Symbol.for('nodejs.util.promisify.custom')] = mergeAllAsync;
  *         }
  *       }
  *     })
+ * ```
+ *  sig `visit :: (Node, Visitor, Options)`
+ *
+ *  sig `Options = { keyMap: Object, state: Object }`
  *
- *  @sig visit :: (Node, Visitor, Options)
- *  @sig      Options = { keyMap: Object, state: Object }
+ *  @public
  */
 const visit = (
 // @ts-ignore