@speclynx/apidom-ns-openapi-3-1 3.2.1 → 4.0.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 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)
+
+### Features
+
+- **traverse:** all traverse operations work on Path and not Element ([#153](https://github.com/speclynx/apidom/issues/153)) ([67d244c](https://github.com/speclynx/apidom/commit/67d244cfd3e77f6a9db704cede50ba8e45d10b11))
+
+### BREAKING CHANGES
+
+- **traverse:** This is a breaking change as operation callbacks
+  now accept Path instead of Element. By accepting Path, full
+  context of traversal is exposed to consumer instead of just Element.
+
 ## [3.2.1](https://github.com/speclynx/apidom/compare/v3.2.0...v3.2.1) (2026-03-09)
 
 ### Bug Fixes

package/dist/apidom-ns-openapi-3-1.browser.js

@@ -36584,7 +36584,9 @@ class Path {
    *
    * @example
    * // For a path to $.paths['/pets'].get in an OpenAPI document:
+   * ```
    * path.getPathKeys(); // => ['paths', '/pets', 'get']
+   * ```
    */
   getPathKeys() {
     const keys = [];
@@ -36619,18 +36621,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();
@@ -36838,15 +36844,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);
       }
     }
   });
@@ -36871,7 +36877,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
  */
@@ -36896,7 +36902,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
@@ -36918,15 +36924,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();
       }
     }
@@ -36944,9 +36950,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
@@ -36955,7 +36959,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) => {
@@ -36963,15 +36967,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);
       }
     }
   });
@@ -37018,11 +37022,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);
 
@@ -37038,7 +37042,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-ns-openapi-3-1",
-  "version": "3.2.1",
+  "version": "4.0.0",
   "description": "OpenAPI 3.1.x namespace for ApiDOM.",
   "keywords": [
     "apidom",
@@ -60,12 +60,12 @@
   "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-json-pointer": "3.2.1",
-    "@speclynx/apidom-ns-json-schema-2020-12": "3.2.1",
-    "@speclynx/apidom-ns-openapi-3-0": "3.2.1",
-    "@speclynx/apidom-traverse": "3.2.1",
+    "@speclynx/apidom-core": "4.0.0",
+    "@speclynx/apidom-datamodel": "4.0.0",
+    "@speclynx/apidom-json-pointer": "4.0.0",
+    "@speclynx/apidom-ns-json-schema-2020-12": "4.0.0",
+    "@speclynx/apidom-ns-openapi-3-0": "4.0.0",
+    "@speclynx/apidom-traverse": "4.0.0",
     "ramda": "~0.32.0",
     "ramda-adjunct": "^6.0.0",
     "ts-mixer": "^6.0.4"
@@ -80,5 +80,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "83a1e97089ef29134e41ff7cacd351973114ea5b"
+  "gitHead": "384ff82a1bb68d015fd6801de641898b4b582876"
 }

package/src/elements/Callback.cjs

@@ -1,10 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-3-0");
-/**
- * @public
- */
-class Callback extends _apidomNsOpenapi.CallbackElement {}
-var _default = exports.default = Callback;

package/src/elements/Callback.mjs

@@ -1,7 +0,0 @@
-import { CallbackElement } from '@speclynx/apidom-ns-openapi-3-0';
-
-/**
- * @public
- */
-class Callback extends CallbackElement {}
-export default Callback;

package/src/elements/Components.cjs

@@ -1,17 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-3-0");
-/**
- * @public
- */
-class Components extends _apidomNsOpenapi.ComponentsElement {
-  get pathItems() {
-    return this.get('pathItems');
-  }
-  set pathItems(pathItems) {
-    this.set('pathItems', pathItems);
-  }
-}
-var _default = exports.default = Components;

package/src/elements/Components.mjs

@@ -1,14 +0,0 @@
-import { ComponentsElement } from '@speclynx/apidom-ns-openapi-3-0';
-
-/**
- * @public
- */
-class Components extends ComponentsElement {
-  get pathItems() {
-    return this.get('pathItems');
-  }
-  set pathItems(pathItems) {
-    this.set('pathItems', pathItems);
-  }
-}
-export default Components;

package/src/elements/Contact.cjs

@@ -1,10 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-3-0");
-/**
- * @public
- */
-class Contact extends _apidomNsOpenapi.ContactElement {}
-var _default = exports.default = Contact;

package/src/elements/Contact.mjs

@@ -1,7 +0,0 @@
-import { ContactElement } from '@speclynx/apidom-ns-openapi-3-0';
-
-/**
- * @public
- */
-class Contact extends ContactElement {}
-export default Contact;

package/src/elements/Discriminator.cjs

@@ -1,10 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-3-0");
-/**
- * @public
- */
-class Discriminator extends _apidomNsOpenapi.DiscriminatorElement {}
-var _default = exports.default = Discriminator;

package/src/elements/Discriminator.mjs

@@ -1,7 +0,0 @@
-import { DiscriminatorElement } from '@speclynx/apidom-ns-openapi-3-0';
-
-/**
- * @public
- */
-class Discriminator extends DiscriminatorElement {}
-export default Discriminator;

package/src/elements/Encoding.cjs

@@ -1,10 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-3-0");
-/**
- * @public
- */
-class Encoding extends _apidomNsOpenapi.EncodingElement {}
-var _default = exports.default = Encoding;

package/src/elements/Encoding.mjs

@@ -1,7 +0,0 @@
-import { EncodingElement } from '@speclynx/apidom-ns-openapi-3-0';
-
-/**
- * @public
- */
-class Encoding extends EncodingElement {}
-export default Encoding;

package/src/elements/Example.cjs

@@ -1,10 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-3-0");
-/**
- * @public
- */
-class Example extends _apidomNsOpenapi.ExampleElement {}
-var _default = exports.default = Example;

package/src/elements/Example.mjs

@@ -1,7 +0,0 @@
-import { ExampleElement } from '@speclynx/apidom-ns-openapi-3-0';
-
-/**
- * @public
- */
-class Example extends ExampleElement {}
-export default Example;

package/src/elements/ExternalDocumentation.cjs

@@ -1,10 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-3-0");
-/**
- * @public
- */
-class ExternalDocumentation extends _apidomNsOpenapi.ExternalDocumentationElement {}
-var _default = exports.default = ExternalDocumentation;

package/src/elements/ExternalDocumentation.mjs

@@ -1,7 +0,0 @@
-import { ExternalDocumentationElement } from '@speclynx/apidom-ns-openapi-3-0';
-
-/**
- * @public
- */
-class ExternalDocumentation extends ExternalDocumentationElement {}
-export default ExternalDocumentation;

package/src/elements/Header.cjs

@@ -1,17 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-3-0");
-/**
- * @public
- */
-class Header extends _apidomNsOpenapi.HeaderElement {
-  get schema() {
-    return this.get('schema');
-  }
-  set schema(schema) {
-    this.set('schema', schema);
-  }
-}
-var _default = exports.default = Header;

package/src/elements/Header.mjs

@@ -1,13 +0,0 @@
-import { HeaderElement } from '@speclynx/apidom-ns-openapi-3-0';
-/**
- * @public
- */
-class Header extends HeaderElement {
-  get schema() {
-    return this.get('schema');
-  }
-  set schema(schema) {
-    this.set('schema', schema);
-  }
-}
-export default Header;

package/src/elements/Info.cjs

@@ -1,23 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-3-0");
-/**
- * @public
- */
-class Info extends _apidomNsOpenapi.InfoElement {
-  get license() {
-    return this.get('license');
-  }
-  set license(licenseElement) {
-    this.set('license', licenseElement);
-  }
-  get summary() {
-    return this.get('summary');
-  }
-  set summary(summary) {
-    this.set('summary', summary);
-  }
-}
-var _default = exports.default = Info;

package/src/elements/Info.mjs

@@ -1,19 +0,0 @@
-import { InfoElement } from '@speclynx/apidom-ns-openapi-3-0';
-/**
- * @public
- */
-class Info extends InfoElement {
-  get license() {
-    return this.get('license');
-  }
-  set license(licenseElement) {
-    this.set('license', licenseElement);
-  }
-  get summary() {
-    return this.get('summary');
-  }
-  set summary(summary) {
-    this.set('summary', summary);
-  }
-}
-export default Info;

package/src/elements/JsonSchemaDialect.cjs

@@ -1,16 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomDatamodel = require("@speclynx/apidom-datamodel");
-/**
- * @public
- */
-class JsonSchemaDialect extends _apidomDatamodel.StringElement {
-  static default = new JsonSchemaDialect('https://spec.openapis.org/oas/3.1/dialect/base');
-  constructor(content, meta, attributes) {
-    super(content, meta, attributes);
-    this.element = 'jsonSchemaDialect';
-  }
-}
-var _default = exports.default = JsonSchemaDialect;

package/src/elements/JsonSchemaDialect.mjs

@@ -1,13 +0,0 @@
-import { StringElement } from '@speclynx/apidom-datamodel';
-
-/**
- * @public
- */
-class JsonSchemaDialect extends StringElement {
-  static default = new JsonSchemaDialect('https://spec.openapis.org/oas/3.1/dialect/base');
-  constructor(content, meta, attributes) {
-    super(content, meta, attributes);
-    this.element = 'jsonSchemaDialect';
-  }
-}
-export default JsonSchemaDialect;

package/src/elements/License.cjs

@@ -1,17 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-3-0");
-/**
- * @public
- */
-class License extends _apidomNsOpenapi.LicenseElement {
-  get identifier() {
-    return this.get('identifier');
-  }
-  set identifier(name) {
-    this.set('identifier', name);
-  }
-}
-var _default = exports.default = License;

package/src/elements/License.mjs

@@ -1,14 +0,0 @@
-import { LicenseElement } from '@speclynx/apidom-ns-openapi-3-0';
-
-/**
- * @public
- */
-class License extends LicenseElement {
-  get identifier() {
-    return this.get('identifier');
-  }
-  set identifier(name) {
-    this.set('identifier', name);
-  }
-}
-export default License;

package/src/elements/Link.cjs

@@ -1,10 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-3-0");
-/**
- * @public
- */
-class Link extends _apidomNsOpenapi.LinkElement {}
-var _default = exports.default = Link;

package/src/elements/Link.mjs

@@ -1,7 +0,0 @@
-import { LinkElement } from '@speclynx/apidom-ns-openapi-3-0';
-
-/**
- * @public
- */
-class Link extends LinkElement {}
-export default Link;

package/src/elements/MediaType.cjs

@@ -1,17 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-3-0");
-/**
- * @public
- */
-class MediaType extends _apidomNsOpenapi.MediaTypeElement {
-  get schema() {
-    return this.get('schema');
-  }
-  set schema(schema) {
-    this.set('schema', schema);
-  }
-}
-var _default = exports.default = MediaType;

package/src/elements/MediaType.mjs

@@ -1,13 +0,0 @@
-import { MediaTypeElement } from '@speclynx/apidom-ns-openapi-3-0';
-/**
- * @public
- */
-class MediaType extends MediaTypeElement {
-  get schema() {
-    return this.get('schema');
-  }
-  set schema(schema) {
-    this.set('schema', schema);
-  }
-}
-export default MediaType;

package/src/elements/OAuthFlow.cjs

@@ -1,10 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-3-0");
-/**
- * @public
- */
-class OAuthFlow extends _apidomNsOpenapi.OAuthFlowElement {}
-var _default = exports.default = OAuthFlow;

package/src/elements/OAuthFlow.mjs

@@ -1,7 +0,0 @@
-import { OAuthFlowElement } from '@speclynx/apidom-ns-openapi-3-0';
-
-/**
- * @public
- */
-class OAuthFlow extends OAuthFlowElement {}
-export default OAuthFlow;

package/src/elements/OAuthFlows.cjs

@@ -1,10 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomNsOpenapi = require("@speclynx/apidom-ns-openapi-3-0");
-/**
- * @public
- */
-class OAuthFlows extends _apidomNsOpenapi.OAuthFlowsElement {}
-var _default = exports.default = OAuthFlows;

package/src/elements/OAuthFlows.mjs

@@ -1,7 +0,0 @@
-import { OAuthFlowsElement } from '@speclynx/apidom-ns-openapi-3-0';
-
-/**
- * @public
- */
-class OAuthFlows extends OAuthFlowsElement {}
-export default OAuthFlows;