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

package/{es → src}/traversal/visitor.mjs

@@ -6,8 +6,11 @@ import { ApiDOMStructuredError } from '@swagger-api/apidom-error';
  * SPDX-License-Identifier: MIT
  */
 
-// getVisitFn :: (Visitor, String, Boolean) -> Function
+/**
+ * @public
+ */
 export const getVisitFn = (visitor, type, isLeaving) => {
+  // @ts-ignore
   const typeVisitor = visitor[type];
   if (typeVisitor != null) {
     if (!isLeaving && typeof typeVisitor === 'function') {
@@ -26,6 +29,7 @@ export const getVisitFn = (visitor, type, isLeaving) => {
         // { enter() {}, leave() {} }
         return specificVisitor;
       }
+      // @ts-ignore
       const specificTypeVisitor = specificVisitor[type];
       if (typeof specificTypeVisitor === 'function') {
         // { enter: { Type() {} }, leave: { Type() {} } }
@@ -35,15 +39,25 @@ export const getVisitFn = (visitor, type, isLeaving) => {
   }
   return null;
 };
+
+/**
+ * @public
+ */
 export const BREAK = {};
 
-// getNodeType :: Node -> String
+/**
+ * @public
+ */
 export const getNodeType = node => node === null || node === void 0 ? void 0 : node.type;
 
-// isNode :: Node -> Boolean
+/**
+ * @public
+ */
 export const isNode = node => typeof getNodeType(node) === 'string';
 
-// cloneNode :: a -> a
+/**
+ * @public
+ */
 export const cloneNode = node => Object.create(Object.getPrototypeOf(node), Object.getOwnPropertyDescriptors(node));
 
 /**
@@ -52,8 +66,16 @@ export const cloneNode = node => Object.create(Object.getPrototypeOf(node), Obje
  *
  * 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
+ */
+
+/**
+ * @public
+ */
 export const mergeAll = (visitors, {
   visitFnGetter = getVisitFn,
   nodeTypeGetter = getNodeType,
@@ -235,9 +257,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
@@ -245,7 +269,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
@@ -253,23 +277,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) {
@@ -280,9 +304,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
@@ -291,9 +315,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) {
@@ -306,9 +330,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
  */
 export const visit = (
 // @ts-ignore

package/{cjs → src}/yaml/anchors-aliases/ReferenceManager.cjs

@@ -8,6 +8,9 @@ var _YamlReferenceError = _interopRequireDefault(require("../errors/YamlReferenc
 var _predicates = require("../nodes/predicates.cjs");
 var _YamlStyle = require("../nodes/YamlStyle.cjs");
 /* eslint-disable class-methods-use-this */
+/**
+ * @public
+ */
 class ReferenceManager {
   addAnchor(node) {
     if (!(0, _predicates.isAnchor)(node.anchor)) {

package/{es → src}/yaml/anchors-aliases/ReferenceManager.mjs

@@ -3,6 +3,9 @@ import YamlReferenceError from "../errors/YamlReferenceError.mjs";
 import { isAnchor } from "../nodes/predicates.mjs";
 import { YamlStyle, YamlStyleGroup } from "../nodes/YamlStyle.mjs";
 /* eslint-disable class-methods-use-this */
+/**
+ * @public
+ */
 class ReferenceManager {
   addAnchor(node) {
     if (!isAnchor(node.anchor)) {

package/{cjs → src}/yaml/errors/YamlError.cjs

@@ -3,5 +3,8 @@
 exports.__esModule = true;
 exports.default = void 0;
 var _apidomError = require("@swagger-api/apidom-error");
+/**
+ * @public
+ */
 class YamlError extends _apidomError.ApiDOMStructuredError {}
 var _default = exports.default = YamlError;

package/{es → src}/yaml/errors/YamlError.mjs

@@ -1,3 +1,7 @@
 import { ApiDOMStructuredError } from '@swagger-api/apidom-error';
+
+/**
+ * @public
+ */
 class YamlError extends ApiDOMStructuredError {}
 export default YamlError;

package/{cjs → src}/yaml/errors/YamlReferenceError.cjs

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

package/{es → src}/yaml/errors/YamlReferenceError.mjs

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

package/{cjs → src}/yaml/errors/YamlSchemaError.cjs

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

package/{es → src}/yaml/errors/YamlSchemaError.mjs

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

package/{cjs → src}/yaml/errors/YamlTagError.cjs

@@ -4,6 +4,13 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
 exports.__esModule = true;
 exports.default = void 0;
 var _YamlSchemaError = _interopRequireDefault(require("./YamlSchemaError.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
 class YamlTagError extends _YamlSchemaError.default {
   specificTagName;
   explicitTagName;

package/{es → src}/yaml/errors/YamlTagError.mjs

@@ -1,4 +1,10 @@
 import YamlSchemaError from "./YamlSchemaError.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
 class YamlTagError extends YamlSchemaError {
   specificTagName;
   explicitTagName;

package/{cjs → src}/yaml/nodes/YamlAlias.cjs

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

package/{es → src}/yaml/nodes/YamlAlias.mjs

@@ -1,4 +1,10 @@
 import Node from "../../Node.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
 class YamlAlias extends Node {
   static type = 'alias';
   content;

package/{cjs → src}/yaml/nodes/YamlAnchor.cjs

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

package/{es → src}/yaml/nodes/YamlAnchor.mjs

@@ -1,4 +1,10 @@
 import Node from "../../Node.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
 class YamlAnchor extends Node {
   static type = 'anchor';
   name;

package/{cjs → src}/yaml/nodes/YamlCollection.cjs

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

package/{es → src}/yaml/nodes/YamlCollection.mjs

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

package/{cjs → src}/yaml/nodes/YamlComment.cjs

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

package/{es → src}/yaml/nodes/YamlComment.mjs

@@ -1,4 +1,10 @@
 import Node from "../../Node.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
 class YamlComment extends Node {
   static type = 'comment';
   content;

package/{cjs → src}/yaml/nodes/YamlDirective.cjs

@@ -5,6 +5,17 @@ exports.__esModule = true;
 exports.default = void 0;
 var _ramda = require("ramda");
 var _Node = _interopRequireDefault(require("../../Node.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
 class YamlDirective extends _Node.default {
   static type = 'directive';
   name;

package/{es → src}/yaml/nodes/YamlDirective.mjs

@@ -1,5 +1,14 @@
 import { mergeRight } from 'ramda';
 import Node from "../../Node.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+/**
+ * @public
+ */
 class YamlDirective extends Node {
   static type = 'directive';
   name;

package/{cjs → src}/yaml/nodes/YamlDocument.cjs

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

package/{es → src}/yaml/nodes/YamlDocument.mjs

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

package/{cjs → src}/yaml/nodes/YamlKeyValuePair.cjs

@@ -5,6 +5,13 @@ exports.__esModule = true;
 exports.default = void 0;
 var _Node = _interopRequireDefault(require("../../Node.cjs"));
 var _predicates = require("./predicates.cjs");
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
 class YamlKeyValuePair extends _Node.default {
   static type = 'keyValuePair';
   styleGroup;

package/{es → src}/yaml/nodes/YamlKeyValuePair.mjs

@@ -1,5 +1,11 @@
 import Node from "../../Node.mjs";
 import { isScalar, isMapping, isSequence, isAlias } from "./predicates.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
 class YamlKeyValuePair extends Node {
   static type = 'keyValuePair';
   styleGroup;

package/{cjs → src}/yaml/nodes/YamlMapping.cjs

@@ -5,6 +5,9 @@ exports.__esModule = true;
 exports.default = void 0;
 var _YamlCollection = _interopRequireDefault(require("./YamlCollection.cjs"));
 var _predicates = require("./predicates.cjs");
+/**
+ * @public
+ */
 class YamlMapping extends _YamlCollection.default {
   static type = 'mapping';
 }

package/{es → src}/yaml/nodes/YamlMapping.mjs

@@ -1,5 +1,8 @@
 import YamlCollection from "./YamlCollection.mjs";
 import { isKeyValuePair } from "./predicates.mjs";
+/**
+ * @public
+ */
 class YamlMapping extends YamlCollection {
   static type = 'mapping';
 }

package/{cjs → src}/yaml/nodes/YamlNode.cjs

@@ -4,6 +4,13 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
 exports.__esModule = true;
 exports.default = void 0;
 var _Node = _interopRequireDefault(require("../../Node.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
 class YamlNode extends _Node.default {
   anchor;
   tag;

package/{es → src}/yaml/nodes/YamlNode.mjs

@@ -1,4 +1,10 @@
 import Node from "../../Node.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
 class YamlNode extends Node {
   anchor;
   tag;

package/{cjs → src}/yaml/nodes/YamlScalar.cjs

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

package/{es → src}/yaml/nodes/YamlScalar.mjs

@@ -1,4 +1,10 @@
 import YamlNode from "./YamlNode.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
 class YamlScalar extends YamlNode {
   static type = 'scalar';
   content;

package/{cjs → src}/yaml/nodes/YamlSequence.cjs

@@ -5,6 +5,9 @@ exports.__esModule = true;
 exports.default = void 0;
 var _YamlCollection = _interopRequireDefault(require("./YamlCollection.cjs"));
 var _predicates = require("./predicates.cjs");
+/**
+ * @public
+ */
 class YamlSequence extends _YamlCollection.default {
   static type = 'sequence';
 }

package/{es → src}/yaml/nodes/YamlSequence.mjs

@@ -1,5 +1,8 @@
 import YamlCollection from "./YamlCollection.mjs";
 import { isMapping, isScalar, isSequence, isAlias } from "./predicates.mjs";
+/**
+ * @public
+ */
 class YamlSequence extends YamlCollection {
   static type = 'sequence';
 }

package/{cjs → src}/yaml/nodes/YamlStream.cjs

@@ -5,6 +5,9 @@ exports.__esModule = true;
 exports.default = void 0;
 var _Node = _interopRequireDefault(require("../../Node.cjs"));
 var _predicates = require("./predicates.cjs");
+/**
+ * @public
+ */
 class YamlStream extends _Node.default {
   static type = 'stream';
 }

package/{es → src}/yaml/nodes/YamlStream.mjs

@@ -1,5 +1,8 @@
 import Node from "../../Node.mjs";
 import { isComment, isDocument } from "./predicates.mjs";
+/**
+ * @public
+ */
 class YamlStream extends Node {
   static type = 'stream';
 }

package/{cjs → src}/yaml/nodes/YamlStyle.cjs

@@ -2,6 +2,9 @@
 
 exports.__esModule = true;
 exports.YamlStyleGroup = exports.YamlStyle = void 0;
+/**
+ * @public
+ */
 let YamlStyle = exports.YamlStyle = /*#__PURE__*/function (YamlStyle) {
   YamlStyle["Plain"] = "Plain";
   YamlStyle["SingleQuoted"] = "SingleQuoted";
@@ -14,6 +17,9 @@ let YamlStyle = exports.YamlStyle = /*#__PURE__*/function (YamlStyle) {
   YamlStyle["InLine"] = "InLine";
   return YamlStyle;
 }({});
+/**
+ * @public
+ */
 let YamlStyleGroup = exports.YamlStyleGroup = /*#__PURE__*/function (YamlStyleGroup) {
   YamlStyleGroup["Flow"] = "Flow";
   YamlStyleGroup["Block"] = "Block";

package/{es → src}/yaml/nodes/YamlStyle.mjs

@@ -1,3 +1,6 @@
+/**
+ * @public
+ */
 export let YamlStyle = /*#__PURE__*/function (YamlStyle) {
   YamlStyle["Plain"] = "Plain";
   YamlStyle["SingleQuoted"] = "SingleQuoted";
@@ -10,6 +13,10 @@ export let YamlStyle = /*#__PURE__*/function (YamlStyle) {
   YamlStyle["InLine"] = "InLine";
   return YamlStyle;
 }({});
+
+/**
+ * @public
+ */
 export let YamlStyleGroup = /*#__PURE__*/function (YamlStyleGroup) {
   YamlStyleGroup["Flow"] = "Flow";
   YamlStyleGroup["Block"] = "Block";

package/{cjs → src}/yaml/nodes/YamlTag.cjs

@@ -4,12 +4,21 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
 exports.__esModule = true;
 exports.default = exports.YamlNodeKind = void 0;
 var _Node = _interopRequireDefault(require("../../Node.cjs"));
+/**
+ * @public
+ */
 let YamlNodeKind = exports.YamlNodeKind = /*#__PURE__*/function (YamlNodeKind) {
   YamlNodeKind["Scalar"] = "Scalar";
   YamlNodeKind["Sequence"] = "Sequence";
   YamlNodeKind["Mapping"] = "Mapping";
   return YamlNodeKind;
 }({});
+/**
+ * @public
+ */
+/**
+ * @public
+ */
 class YamlTag extends _Node.default {
   static type = 'tag';
   explicitName;

package/{es → src}/yaml/nodes/YamlTag.mjs

@@ -1,10 +1,21 @@
 import Node from "../../Node.mjs";
+/**
+ * @public
+ */
 export let YamlNodeKind = /*#__PURE__*/function (YamlNodeKind) {
   YamlNodeKind["Scalar"] = "Scalar";
   YamlNodeKind["Sequence"] = "Sequence";
   YamlNodeKind["Mapping"] = "Mapping";
   return YamlNodeKind;
 }({});
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
 class YamlTag extends Node {
   static type = 'tag';
   explicitName;