@speclynx/apidom-parser-adapter-openapi-yaml-2 3.2.1 → 4.0.0

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.0.0](https://github.com/speclynx/apidom/compare/v3.2.1...v4.0.0) (2026-03-11)
+
+**Note:** Version bump only for package @speclynx/apidom-parser-adapter-openapi-yaml-2
+
 ## [3.2.1](https://github.com/speclynx/apidom/compare/v3.2.0...v3.2.1) (2026-03-09)
 
 **Note:** Version bump only for package @speclynx/apidom-parser-adapter-openapi-yaml-2

package/dist/apidom-parser-adapter-openapi-yaml-2.browser.js

@@ -44781,7 +44781,9 @@ class Path {
    *
    * @example
    * // For a path to $.paths['/pets'].get in an OpenAPI document:
+   * ```
    * path.getPathKeys(); // => ['paths', '/pets', 'get']
+   * ```
    */
   getPathKeys() {
     const keys = [];
@@ -44816,18 +44818,22 @@ class Path {
    *          or Normalized JSONPath like "$['paths']['/pets']['get']['responses']['200']"
    *
    * @example
+   * ```
    * // JSON Pointer examples:
    * path.formatPath(); // "" (root)
    * path.formatPath(); // "/info"
    * path.formatPath(); // "/paths/~1pets/get"
    * path.formatPath(); // "/paths/~1users~1{id}/parameters/0"
+   * ```
    *
    * @example
+   * ```
    * // JSONPath examples:
    * path.formatPath('jsonpath'); // "$" (root)
    * path.formatPath('jsonpath'); // "$['info']"
    * path.formatPath('jsonpath'); // "$['paths']['/pets']['get']"
    * path.formatPath('jsonpath'); // "$['paths']['/users/{id}']['parameters'][0]"
+   * ```
    */
   formatPath(pathFormat = 'jsonpointer') {
     const parts = this.getPathKeys();
@@ -45037,15 +45043,15 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var _traversal_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(72078);
 
 /**
- * Finds all elements matching the predicate.
+ * Finds all paths whose elements match the predicate.
  * @public
  */
 const filter = (element, predicate) => {
   const result = [];
   (0,_traversal_mjs__WEBPACK_IMPORTED_MODULE_0__.traverse)(element, {
     enter(path) {
-      if (predicate(path.node)) {
-        result.push(path.node);
+      if (predicate(path)) {
+        result.push(path);
       }
     }
   });
@@ -45071,7 +45077,7 @@ __webpack_require__.r(__webpack_exports__);
  * @public
  */
 /**
- * Finds the most inner node at the given offset.
+ * Finds the path of the most inner node at the given offset.
  * If includeRightBound is set, also finds nodes that end at the given offset.
  * @public
  */
@@ -45096,7 +45102,7 @@ const findAtOffset = (element, options) => {
       const endOffset = node.endOffset;
       const isWithinOffsetRange = offset >= startOffset && (offset < endOffset || includeRightBound && offset <= endOffset);
       if (isWithinOffsetRange) {
-        result.push(node);
+        result.push(path);
         return; // push to stack and dive in
       }
       path.skip(); // skip entire sub-tree
@@ -45119,15 +45125,15 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var _traversal_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(72078);
 
 /**
- * Find first element that satisfies the provided predicate.
+ * Finds first path whose element satisfies the provided predicate.
  * @public
  */
 const find = (element, predicate) => {
   let result;
   (0,_traversal_mjs__WEBPACK_IMPORTED_MODULE_0__.traverse)(element, {
     enter(path) {
-      if (predicate(path.node)) {
-        result = path.node;
+      if (predicate(path)) {
+        result = path;
         path.stop();
       }
     }
@@ -45146,9 +45152,7 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export */ __webpack_require__.d(__webpack_exports__, {
 /* harmony export */   "default": () => (__WEBPACK_DEFAULT_EXPORT__)
 /* harmony export */ });
-/* harmony import */ var _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(25162);
-/* harmony import */ var _traversal_mjs__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(72078);
-
+/* harmony import */ var _traversal_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(72078);
 
 /**
  * @public
@@ -45157,7 +45161,7 @@ __webpack_require__.r(__webpack_exports__);
  * @public
  */
 /**
- * Executes the callback on this element and all descendants.
+ * Executes the callback on this element's path and all descendant paths.
  * @public
  */
 const forEach = (element, options) => {
@@ -45165,15 +45169,15 @@ const forEach = (element, options) => {
   let predicate;
   if (typeof options === 'function') {
     callback = options;
-    predicate = _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_0__.isElement;
+    predicate = () => true;
   } else {
     callback = options.callback ?? (() => {});
-    predicate = options.predicate ?? _speclynx_apidom_datamodel__WEBPACK_IMPORTED_MODULE_0__.isElement;
+    predicate = options.predicate ?? (() => true);
   }
-  (0,_traversal_mjs__WEBPACK_IMPORTED_MODULE_1__.traverse)(element, {
+  (0,_traversal_mjs__WEBPACK_IMPORTED_MODULE_0__.traverse)(element, {
     enter(path) {
-      if (predicate(path.node)) {
-        callback(path.node);
+      if (predicate(path)) {
+        callback(path);
       }
     }
   });
@@ -45222,11 +45226,11 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var _filter_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(75247);
 
 /**
- * Complement of filter. Finds all elements NOT matching the predicate.
+ * Complement of filter. Finds all paths whose elements do NOT match the predicate.
  * @public
  */
 const reject = (element, predicate) => {
-  return (0,_filter_mjs__WEBPACK_IMPORTED_MODULE_0__["default"])(element, el => !predicate(el));
+  return (0,_filter_mjs__WEBPACK_IMPORTED_MODULE_0__["default"])(element, path => !predicate(path));
 };
 /* harmony default export */ const __WEBPACK_DEFAULT_EXPORT__ = (reject);
 
@@ -45243,7 +45247,7 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var _find_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(44860);
 
 /**
- * Tests whether at least one element passes the predicate.
+ * Tests whether at least one path's element passes the predicate.
  * @public
  */
 const some = (element, predicate) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@speclynx/apidom-parser-adapter-openapi-yaml-2",
-  "version": "3.2.1",
+  "version": "4.0.0",
   "description": "Parser adapter for parsing YAML documents into OpenAPI 2.0 namespace.",
   "keywords": [
     "apidom",
@@ -56,10 +56,10 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.28.4",
-    "@speclynx/apidom-core": "3.2.1",
-    "@speclynx/apidom-datamodel": "3.2.1",
-    "@speclynx/apidom-ns-openapi-2": "3.2.1",
-    "@speclynx/apidom-parser-adapter-yaml-1-2": "3.2.1",
+    "@speclynx/apidom-core": "4.0.0",
+    "@speclynx/apidom-datamodel": "4.0.0",
+    "@speclynx/apidom-ns-openapi-2": "4.0.0",
+    "@speclynx/apidom-parser-adapter-yaml-1-2": "4.0.0",
     "ramda": "~0.32.0",
     "ramda-adjunct": "^6.0.0"
   },
@@ -73,5 +73,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "83a1e97089ef29134e41ff7cacd351973114ea5b"
+  "gitHead": "384ff82a1bb68d015fd6801de641898b4b582876"
 }

package/src/adapter.cjs

@@ -1,53 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
-exports.__esModule = true;
-exports.parse = exports.namespace = exports.mediaTypes = exports.detectionRegExp = exports.detect = void 0;
-var _ramda = require("ramda");
-var _ramdaAdjunct = require("ramda-adjunct");
-var _apidomDatamodel = require("@speclynx/apidom-datamodel");
-var _apidomParserAdapterYaml = require("@speclynx/apidom-parser-adapter-yaml-1-2");
-var _apidomNsOpenapi = _interopRequireWildcard(require("@speclynx/apidom-ns-openapi-2"));
-var _mediaTypes = _interopRequireDefault(require("./media-types.cjs"));
-exports.mediaTypes = _mediaTypes.default;
-/**
- * @public
- */
-const detectionRegExp = exports.detectionRegExp = /(?<YAML>^(["']?)swagger\2\s*:\s*(["'])(?<version_yaml>2\.0)\3(?:\s+|$))|(?<JSON>"swagger"\s*:\s*"(?<version_json>2\.0)")/m;
-
-/**
- * @public
- */
-const detect = async (source, options = {}) => detectionRegExp.test(source) && (await (0, _apidomParserAdapterYaml.detect)(source, options));
-
-/**
- * @public
- */
-exports.detect = detect;
-/**
- * @public
- */
-const parse = async (source, options = {}) => {
-  const refractorOpts = (0, _ramda.propOr)({}, 'refractorOpts', options);
-  const parserOpts = (0, _ramda.omit)(['refractorOpts'], options);
-  const parseResultElement = await (0, _apidomParserAdapterYaml.parse)(source, parserOpts);
-  const {
-    result
-  } = parseResultElement;
-  if ((0, _ramdaAdjunct.isNotUndefined)(result)) {
-    const swaggerElement = (0, _apidomNsOpenapi.refractSwagger)(result, {
-      consume: true,
-      ...refractorOpts
-    });
-    swaggerElement.classes.push('result');
-    parseResultElement.replaceResult(swaggerElement);
-  }
-  return parseResultElement;
-};
-
-/**
- * @public
- */
-exports.parse = parse;
-const namespace = exports.namespace = new _apidomDatamodel.Namespace().use(_apidomNsOpenapi.default);

package/src/adapter.mjs

@@ -1,45 +0,0 @@
-import { propOr, omit } from 'ramda';
-import { isNotUndefined } from 'ramda-adjunct';
-import { Namespace } from '@speclynx/apidom-datamodel';
-import { parse as parseYAML, detect as detectYAML } from '@speclynx/apidom-parser-adapter-yaml-1-2';
-import openApiNamespace, { refractSwagger } from '@speclynx/apidom-ns-openapi-2';
-export { default as mediaTypes } from "./media-types.mjs";
-/**
- * @public
- */
-export const detectionRegExp = /(?<YAML>^(["']?)swagger\2\s*:\s*(["'])(?<version_yaml>2\.0)\3(?:\s+|$))|(?<JSON>"swagger"\s*:\s*"(?<version_json>2\.0)")/m;
-
-/**
- * @public
- */
-export const detect = async (source, options = {}) => detectionRegExp.test(source) && (await detectYAML(source, options));
-
-/**
- * @public
- */
-
-/**
- * @public
- */
-export const parse = async (source, options = {}) => {
-  const refractorOpts = propOr({}, 'refractorOpts', options);
-  const parserOpts = omit(['refractorOpts'], options);
-  const parseResultElement = await parseYAML(source, parserOpts);
-  const {
-    result
-  } = parseResultElement;
-  if (isNotUndefined(result)) {
-    const swaggerElement = refractSwagger(result, {
-      consume: true,
-      ...refractorOpts
-    });
-    swaggerElement.classes.push('result');
-    parseResultElement.replaceResult(swaggerElement);
-  }
-  return parseResultElement;
-};
-
-/**
- * @public
- */
-export const namespace = new Namespace().use(openApiNamespace);

package/src/media-types.cjs

@@ -1,10 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-2");
-/**
- * @public
- */
-const yamlMediaTypes = new _apidomNsOpenapi.OpenAPIMediaTypes(..._apidomNsOpenapi.mediaTypes.filterByFormat('generic'), ..._apidomNsOpenapi.mediaTypes.filterByFormat('yaml'));
-var _default = exports.default = yamlMediaTypes;

package/src/media-types.mjs

@@ -1,7 +0,0 @@
-import { mediaTypes, OpenAPIMediaTypes } from '@speclynx/apidom-ns-openapi-2';
-
-/**
- * @public
- */
-const yamlMediaTypes = new OpenAPIMediaTypes(...mediaTypes.filterByFormat('generic'), ...mediaTypes.filterByFormat('yaml'));
-export default yamlMediaTypes;