@speclynx/apidom-ns-openapi-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-ns-openapi-2
+
 ## [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-2.browser.js

@@ -27552,7 +27552,9 @@ class Path {
    *
    * @example
    * // For a path to $.paths['/pets'].get in an OpenAPI document:
+   * ```
    * path.getPathKeys(); // => ['paths', '/pets', 'get']
+   * ```
    */
   getPathKeys() {
     const keys = [];
@@ -27587,18 +27589,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();
@@ -27806,15 +27812,15 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var _traversal_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(2078);
 
 /**
- * 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);
       }
     }
   });
@@ -27839,7 +27845,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
  */
@@ -27864,7 +27870,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
@@ -27886,15 +27892,15 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var _traversal_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(2078);
 
 /**
- * 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();
       }
     }
@@ -27912,9 +27918,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__(5162);
-/* harmony import */ var _traversal_mjs__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(2078);
-
+/* harmony import */ var _traversal_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(2078);
 
 /**
  * @public
@@ -27923,7 +27927,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) => {
@@ -27931,15 +27935,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);
       }
     }
   });
@@ -27986,11 +27990,11 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var _filter_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(5247);
 
 /**
- * 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);
 
@@ -28006,7 +28010,7 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var _find_mjs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(4860);
 
 /**
- * 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-2",
-  "version": "3.2.1",
+  "version": "4.0.0",
   "description": "OpenAPI 2.0 namespace for ApiDOM.",
   "keywords": [
     "apidom",
@@ -56,11 +56,11 @@
   "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-error": "3.2.1",
-    "@speclynx/apidom-ns-json-schema-draft-4": "3.2.1",
-    "@speclynx/apidom-traverse": "3.2.1",
+    "@speclynx/apidom-core": "4.0.0",
+    "@speclynx/apidom-datamodel": "4.0.0",
+    "@speclynx/apidom-error": "4.0.0",
+    "@speclynx/apidom-ns-json-schema-draft-4": "4.0.0",
+    "@speclynx/apidom-traverse": "4.0.0",
     "ramda": "~0.32.0",
     "ramda-adjunct": "^6.0.0",
     "ts-mixer": "^6.0.4"
@@ -75,5 +75,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "83a1e97089ef29134e41ff7cacd351973114ea5b"
+  "gitHead": "384ff82a1bb68d015fd6801de641898b4b582876"
 }

package/src/elements/Contact.cjs

@@ -1,33 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomDatamodel = require("@speclynx/apidom-datamodel");
-/**
- * @public
- */
-class Contact extends _apidomDatamodel.ObjectElement {
-  constructor(content, meta, attributes) {
-    super(content, meta, attributes);
-    this.element = 'contact';
-  }
-  get name() {
-    return this.get('name');
-  }
-  set name(name) {
-    this.set('name', name);
-  }
-  get url() {
-    return this.get('url');
-  }
-  set url(url) {
-    this.set('url', url);
-  }
-  get email() {
-    return this.get('email');
-  }
-  set email(email) {
-    this.set('email', email);
-  }
-}
-var _default = exports.default = Contact;

package/src/elements/Contact.mjs

@@ -1,30 +0,0 @@
-import { ObjectElement } from '@speclynx/apidom-datamodel';
-
-/**
- * @public
- */
-class Contact extends ObjectElement {
-  constructor(content, meta, attributes) {
-    super(content, meta, attributes);
-    this.element = 'contact';
-  }
-  get name() {
-    return this.get('name');
-  }
-  set name(name) {
-    this.set('name', name);
-  }
-  get url() {
-    return this.get('url');
-  }
-  set url(url) {
-    this.set('url', url);
-  }
-  get email() {
-    return this.get('email');
-  }
-  set email(email) {
-    this.set('email', email);
-  }
-}
-export default Contact;

package/src/elements/Definitions.cjs

@@ -1,15 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomDatamodel = require("@speclynx/apidom-datamodel");
-/**
- * @public
- */
-class Definitions extends _apidomDatamodel.ObjectElement {
-  constructor(content, meta, attributes) {
-    super(content, meta, attributes);
-    this.element = 'definitions';
-  }
-}
-var _default = exports.default = Definitions;

package/src/elements/Definitions.mjs

@@ -1,12 +0,0 @@
-import { ObjectElement } from '@speclynx/apidom-datamodel';
-
-/**
- * @public
- */
-class Definitions extends ObjectElement {
-  constructor(content, meta, attributes) {
-    super(content, meta, attributes);
-    this.element = 'definitions';
-  }
-}
-export default Definitions;

package/src/elements/Example.cjs

@@ -1,15 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomDatamodel = require("@speclynx/apidom-datamodel");
-/**
- * @public
- */
-class Example extends _apidomDatamodel.ObjectElement {
-  constructor(content, meta, attributes) {
-    super(content, meta, attributes);
-    this.element = 'example';
-  }
-}
-var _default = exports.default = Example;

package/src/elements/Example.mjs

@@ -1,12 +0,0 @@
-import { ObjectElement } from '@speclynx/apidom-datamodel';
-
-/**
- * @public
- */
-class Example extends ObjectElement {
-  constructor(content, meta, attributes) {
-    super(content, meta, attributes);
-    this.element = 'example';
-  }
-}
-export default Example;

package/src/elements/ExternalDocumentation.cjs

@@ -1,27 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomDatamodel = require("@speclynx/apidom-datamodel");
-/**
- * @public
- */
-class ExternalDocumentation extends _apidomDatamodel.ObjectElement {
-  constructor(content, meta, attributes) {
-    super(content, meta, attributes);
-    this.element = 'externalDocumentation';
-  }
-  get description() {
-    return this.get('description');
-  }
-  set description(description) {
-    this.set('description', description);
-  }
-  get url() {
-    return this.get('url');
-  }
-  set url(url) {
-    this.set('url', url);
-  }
-}
-var _default = exports.default = ExternalDocumentation;

package/src/elements/ExternalDocumentation.mjs

@@ -1,24 +0,0 @@
-import { ObjectElement } from '@speclynx/apidom-datamodel';
-
-/**
- * @public
- */
-class ExternalDocumentation extends ObjectElement {
-  constructor(content, meta, attributes) {
-    super(content, meta, attributes);
-    this.element = 'externalDocumentation';
-  }
-  get description() {
-    return this.get('description');
-  }
-  set description(description) {
-    this.set('description', description);
-  }
-  get url() {
-    return this.get('url');
-  }
-  set url(url) {
-    this.set('url', url);
-  }
-}
-export default ExternalDocumentation;

package/src/elements/Header.cjs

@@ -1,185 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomError = require("@speclynx/apidom-error");
-var _apidomNsJsonSchemaDraft = require("@speclynx/apidom-ns-json-schema-draft-4");
-/**
- * @public
- */
-class Header extends _apidomNsJsonSchemaDraft.JSONSchemaElement {
-  constructor(content, meta, attributes) {
-    super(content, meta, attributes);
-    this.element = 'header';
-    this.classes.push('json-schema-draft-4');
-  }
-
-  /**
-   * Core vocabulary
-   *
-   * URI: https://tools.ietf.org/html/draft-wright-json-schema-00
-   */
-
-  get idField() {
-    throw new _apidomError.UnsupportedOperationError('idField getter in Header class is not not supported.');
-  }
-  set idField(idField) {
-    throw new _apidomError.UnsupportedOperationError('idField setter in Header class is not not supported.');
-  }
-  get $schema() {
-    throw new _apidomError.UnsupportedOperationError('$schema getter in Header class is not not supported.');
-  }
-  set $schema($schema) {
-    throw new _apidomError.UnsupportedOperationError('$schema setter in Header class is not not supported.');
-  }
-
-  /**
-   * Validation keywords for arrays
-   */
-
-  get additionalItems() {
-    throw new _apidomError.UnsupportedOperationError('additionalItems getter in Header class is not not supported.');
-  }
-  set additionalItems(additionalItems) {
-    throw new _apidomError.UnsupportedOperationError('additionalItems setter in Header class is not not supported.');
-  }
-  get itemsField() {
-    return this.get('items');
-  }
-  set itemsField(items) {
-    this.set('items', items);
-  }
-
-  /**
-   * Validation keywords for objects
-   */
-
-  get maxProperties() {
-    throw new _apidomError.UnsupportedOperationError('maxProperties getter in Header class is not not supported.');
-  }
-  set maxProperties(maxProperties) {
-    throw new _apidomError.UnsupportedOperationError('maxProperties setter in Header class is not not supported.');
-  }
-  get minProperties() {
-    throw new _apidomError.UnsupportedOperationError('minProperties getter in Header class is not not supported.');
-  }
-  set minProperties(minProperties) {
-    throw new _apidomError.UnsupportedOperationError('minProperties setter in Header class is not not supported.');
-  }
-  get required() {
-    throw new _apidomError.UnsupportedOperationError('required getter in Header class is not not supported.');
-  }
-  set required(required) {
-    throw new _apidomError.UnsupportedOperationError('required setter in Header class is not not supported.');
-  }
-  get properties() {
-    throw new _apidomError.UnsupportedOperationError('properties getter in Header class is not not supported.');
-  }
-  set properties(properties) {
-    throw new _apidomError.UnsupportedOperationError('properties setter in Header class is not not supported.');
-  }
-  get additionalProperties() {
-    throw new _apidomError.UnsupportedOperationError('additionalProperties getter in Header class is not not supported.');
-  }
-  set additionalProperties(additionalProperties) {
-    throw new _apidomError.UnsupportedOperationError('additionalProperties setter in Header class is not not supported.');
-  }
-  get patternProperties() {
-    throw new _apidomError.UnsupportedOperationError('patternProperties getter in Header class is not not supported.');
-  }
-  set patternProperties(patternProperties) {
-    throw new _apidomError.UnsupportedOperationError('patternProperties setter in Header class is not not supported.');
-  }
-  get dependencies() {
-    throw new _apidomError.UnsupportedOperationError('dependencies getter in Header class is not not supported.');
-  }
-  set dependencies(dependencies) {
-    throw new _apidomError.UnsupportedOperationError('dependencies setter in Header class is not not supported.');
-  }
-
-  /**
-   *  Validation keywords for any instance type
-   */
-
-  get type() {
-    return this.get('type');
-  }
-  set type(type) {
-    this.set('type', type);
-  }
-  get allOf() {
-    throw new _apidomError.UnsupportedOperationError('allOf getter in Header class is not not supported.');
-  }
-  set allOf(allOf) {
-    throw new _apidomError.UnsupportedOperationError('allOf setter in Header class is not not supported.');
-  }
-  get anyOf() {
-    throw new _apidomError.UnsupportedOperationError('anyOf getter in Header class is not not supported.');
-  }
-  set anyOf(anyOf) {
-    throw new _apidomError.UnsupportedOperationError('anyOf setter in Header class is not not supported.');
-  }
-  get oneOf() {
-    throw new _apidomError.UnsupportedOperationError('oneOf getter in Header class is not not supported.');
-  }
-  set oneOf(oneOf) {
-    throw new _apidomError.UnsupportedOperationError('oneOf setter in Header class is not not supported.');
-  }
-  get not() {
-    throw new _apidomError.UnsupportedOperationError('not getter in Header class is not not supported.');
-  }
-  set not(not) {
-    throw new _apidomError.UnsupportedOperationError('not setter in Header class is not not supported.');
-  }
-  get definitions() {
-    throw new _apidomError.UnsupportedOperationError('definitions getter in Header class is not not supported.');
-  }
-  set definitions(definitions) {
-    throw new _apidomError.UnsupportedOperationError('definitions setter in Header class is not not supported.');
-  }
-
-  /**
-   * Metadata keywords
-   *
-   * URI: https://datatracker.ietf.org/doc/html/draft-wright-json-schema-validation-00#section-6
-   */
-
-  get title() {
-    throw new _apidomError.UnsupportedOperationError('title getter in Header class is not not supported.');
-  }
-  set title(title) {
-    throw new _apidomError.UnsupportedOperationError('title setter in Header class is not not supported.');
-  }
-
-  /**
-   * JSON Hyper-Schema
-   *
-   * URI: https://datatracker.ietf.org/doc/html/draft-wright-json-schema-hyperschema-00
-   */
-
-  get base() {
-    throw new _apidomError.UnsupportedOperationError('base getter in Header class is not not supported.');
-  }
-  set base(base) {
-    throw new _apidomError.UnsupportedOperationError('base setter in Header class is not not supported.');
-  }
-  get linksField() {
-    throw new _apidomError.UnsupportedOperationError('linksField getter in Header class is not not supported.');
-  }
-  set linksField(links) {
-    throw new _apidomError.UnsupportedOperationError('linksField setter in Header class is not not supported.');
-  }
-  get media() {
-    throw new _apidomError.UnsupportedOperationError('media getter in Header class is not not supported.');
-  }
-  set media(media) {
-    throw new _apidomError.UnsupportedOperationError('media setter in Header class is not not supported.');
-  }
-  get readOnly() {
-    throw new _apidomError.UnsupportedOperationError('readOnly getter in Header class is not not supported.');
-  }
-  set readOnly(readOnly) {
-    throw new _apidomError.UnsupportedOperationError('readOnly setter in Header class is not not supported.');
-  }
-}
-var _default = exports.default = Header;