@speclynx/apidom-ns-json-schema-draft-4 3.2.0 → 4.0.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 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)
+
+**Note:** Version bump only for package @speclynx/apidom-ns-json-schema-draft-4
+
 # [3.2.0](https://github.com/speclynx/apidom/compare/v3.1.0...v3.2.0) (2026-03-08)
 
 ### Features

package/dist/apidom-ns-json-schema-draft-4.browser.js

@@ -21365,7 +21365,9 @@ class Path {
    *
    * @example
    * // For a path to $.paths['/pets'].get in an OpenAPI document:
+   * ```
    * path.getPathKeys(); // => ['paths', '/pets', 'get']
+   * ```
    */
   getPathKeys() {
     const keys = [];
@@ -21400,18 +21402,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();
@@ -21619,15 +21625,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);
       }
     }
   });
@@ -21652,7 +21658,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
  */
@@ -21677,7 +21683,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
@@ -21699,15 +21705,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();
       }
     }
@@ -21725,9 +21731,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
@@ -21736,7 +21740,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) => {
@@ -21744,15 +21748,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);
       }
     }
   });
@@ -21799,11 +21803,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);
 
@@ -21819,7 +21823,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-json-schema-draft-4",
-  "version": "3.2.0",
+  "version": "4.0.0",
   "description": "JSON Schema Draft 4 namespace for ApiDOM.",
   "keywords": [
     "apidom",
@@ -59,9 +59,9 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.28.4",
-    "@speclynx/apidom-core": "3.2.0",
-    "@speclynx/apidom-datamodel": "3.2.0",
-    "@speclynx/apidom-traverse": "3.2.0",
+    "@speclynx/apidom-core": "4.0.0",
+    "@speclynx/apidom-datamodel": "4.0.0",
+    "@speclynx/apidom-traverse": "4.0.0",
     "ramda": "~0.32.0",
     "ramda-adjunct": "^6.0.0",
     "ts-mixer": "^6.0.4"
@@ -76,5 +76,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "eeb2f01cd34fb0a95617f02bc1b6683aefc028f2"
+  "gitHead": "384ff82a1bb68d015fd6801de641898b4b582876"
 }

package/src/elements/JSONReference.cjs

@@ -1,29 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomDatamodel = require("@speclynx/apidom-datamodel");
-/**
- * In Draft 4, $ref behaves a little differently. When an object contains a $ref property,
- * the object is considered a reference, not a schema. Therefore, any other properties you put in that object will
- * not be treated as JSON Schema keywords and will be ignored by the validator.
- * $ref can only be used where a schema is expected.
- *
- * URI: https://json-schema.org/understanding-json-schema/structuring.html?highlight=ref#id18
- * @public
- */
-
-class JSONReference extends _apidomDatamodel.ObjectElement {
-  constructor(content, meta, attributes) {
-    super(content, meta, attributes);
-    this.element = 'JSONReference';
-    this.classes.push('json-reference');
-  }
-  get $ref() {
-    return this.get('$ref');
-  }
-  set $ref($ref) {
-    this.set('$ref', $ref);
-  }
-}
-var _default = exports.default = JSONReference;

package/src/elements/JSONReference.mjs

@@ -1,25 +0,0 @@
-import { ObjectElement } from '@speclynx/apidom-datamodel';
-/**
- * In Draft 4, $ref behaves a little differently. When an object contains a $ref property,
- * the object is considered a reference, not a schema. Therefore, any other properties you put in that object will
- * not be treated as JSON Schema keywords and will be ignored by the validator.
- * $ref can only be used where a schema is expected.
- *
- * URI: https://json-schema.org/understanding-json-schema/structuring.html?highlight=ref#id18
- * @public
- */
-
-class JSONReference extends ObjectElement {
-  constructor(content, meta, attributes) {
-    super(content, meta, attributes);
-    this.element = 'JSONReference';
-    this.classes.push('json-reference');
-  }
-  get $ref() {
-    return this.get('$ref');
-  }
-  set $ref($ref) {
-    this.set('$ref', $ref);
-  }
-}
-export default JSONReference;

package/src/elements/JSONSchema.cjs

@@ -1,296 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomDatamodel = require("@speclynx/apidom-datamodel");
-/**
- * @public
- */
-class JSONSchema extends _apidomDatamodel.ObjectElement {
-  constructor(content, meta, attributes) {
-    super(content, meta, attributes);
-    this.element = 'JSONSchemaDraft4';
-  }
-
-  /**
-   * Core vocabulary
-   *
-   * URI: https://tools.ietf.org/html/draft-wright-json-schema-00
-   */
-
-  get idField() {
-    return this.get('id');
-  }
-  set idField(idField) {
-    this.set('id', idField);
-  }
-  get $schema() {
-    return this.get('$schema');
-  }
-  set $schema($schema) {
-    this.set('$schema', $schema);
-  }
-
-  /**
-   * Validation vocabulary
-   *
-   * URI: https://tools.ietf.org/html/draft-wright-json-schema-validation-00
-   */
-
-  /**
-   *  Validation keywords for numeric instances (number and integer)
-   */
-
-  get multipleOf() {
-    return this.get('multipleOf');
-  }
-  set multipleOf(multipleOf) {
-    this.set('multipleOf', multipleOf);
-  }
-  get maximum() {
-    return this.get('maximum');
-  }
-  set maximum(maximum) {
-    this.set('maximum', maximum);
-  }
-  get exclusiveMaximum() {
-    return this.get('exclusiveMaximum');
-  }
-  set exclusiveMaximum(exclusiveMaximum) {
-    this.set('exclusiveMaximum', exclusiveMaximum);
-  }
-  get minimum() {
-    return this.get('minimum');
-  }
-  set minimum(minimum) {
-    this.set('minimum', minimum);
-  }
-  get exclusiveMinimum() {
-    return this.get('exclusiveMinimum');
-  }
-  set exclusiveMinimum(exclusiveMinimum) {
-    this.set('exclusiveMinimum', exclusiveMinimum);
-  }
-
-  /**
-   * Validation keywords for strings
-   */
-
-  get maxLength() {
-    return this.get('maxLength');
-  }
-  set maxLength(maxLength) {
-    this.set('maxLength', maxLength);
-  }
-  get minLength() {
-    return this.get('minLength');
-  }
-  set minLength(minLength) {
-    this.set('minLength', minLength);
-  }
-  get pattern() {
-    return this.get('pattern');
-  }
-  set pattern(pattern) {
-    this.set('pattern', pattern);
-  }
-
-  /**
-   * Validation keywords for arrays
-   */
-
-  get additionalItems() {
-    return this.get('additionalItems');
-  }
-  set additionalItems(additionalItems) {
-    this.set('additionalItems', additionalItems);
-  }
-  get itemsField() {
-    return this.get('items');
-  }
-  set itemsField(items) {
-    this.set('items', items);
-  }
-  get maxItems() {
-    return this.get('maxItems');
-  }
-  set maxItems(maxItems) {
-    this.set('maxItems', maxItems);
-  }
-  get minItems() {
-    return this.get('minItems');
-  }
-  set minItems(minItems) {
-    this.set('minItems', minItems);
-  }
-  get uniqueItems() {
-    return this.get('uniqueItems');
-  }
-  set uniqueItems(uniqueItems) {
-    this.set('uniqueItems', uniqueItems);
-  }
-
-  /**
-   * Validation keywords for objects
-   */
-
-  get maxProperties() {
-    return this.get('maxProperties');
-  }
-  set maxProperties(maxProperties) {
-    this.set('maxProperties', maxProperties);
-  }
-  get minProperties() {
-    return this.get('minProperties');
-  }
-  set minProperties(minProperties) {
-    this.set('minProperties', minProperties);
-  }
-  get required() {
-    return this.get('required');
-  }
-  set required(required) {
-    this.set('required', required);
-  }
-  get properties() {
-    return this.get('properties');
-  }
-  set properties(properties) {
-    this.set('properties', properties);
-  }
-  get additionalProperties() {
-    return this.get('additionalProperties');
-  }
-  set additionalProperties(additionalProperties) {
-    this.set('additionalProperties', additionalProperties);
-  }
-  get patternProperties() {
-    return this.get('patternProperties');
-  }
-  set patternProperties(patternProperties) {
-    this.set('patternProperties', patternProperties);
-  }
-  get dependencies() {
-    return this.get('dependencies');
-  }
-  set dependencies(dependencies) {
-    this.set('dependencies', dependencies);
-  }
-
-  /**
-   *  Validation keywords for any instance type
-   */
-
-  get enum() {
-    return this.get('enum');
-  }
-  set enum(enumValue) {
-    this.set('enum', enumValue);
-  }
-  get type() {
-    return this.get('type');
-  }
-  set type(type) {
-    this.set('type', type);
-  }
-  get allOf() {
-    return this.get('allOf');
-  }
-  set allOf(allOf) {
-    this.set('allOf', allOf);
-  }
-  get anyOf() {
-    return this.get('anyOf');
-  }
-  set anyOf(anyOf) {
-    this.set('anyOf', anyOf);
-  }
-  get oneOf() {
-    return this.get('oneOf');
-  }
-  set oneOf(oneOf) {
-    this.set('oneOf', oneOf);
-  }
-  get not() {
-    return this.get('not');
-  }
-  set not(not) {
-    this.set('not', not);
-  }
-  get definitions() {
-    return this.get('definitions');
-  }
-  set definitions(definitions) {
-    this.set('definitions', definitions);
-  }
-
-  /**
-   * Metadata keywords
-   *
-   * URI: https://datatracker.ietf.org/doc/html/draft-wright-json-schema-validation-00#section-6
-   */
-
-  get title() {
-    return this.get('title');
-  }
-  set title(title) {
-    this.set('title', title);
-  }
-  get description() {
-    return this.get('description');
-  }
-  set description(description) {
-    this.set('description', description);
-  }
-  get default() {
-    return this.get('default');
-  }
-  set default(defaultValue) {
-    this.set('default', defaultValue);
-  }
-
-  /**
-   * Semantic validation with "format"
-   *
-   * URI: https://datatracker.ietf.org/doc/html/draft-wright-json-schema-validation-00#section-7
-   */
-
-  get format() {
-    return this.get('format');
-  }
-  set format(format) {
-    this.set('format', format);
-  }
-
-  /**
-   * JSON Hyper-Schema
-   *
-   * URI: https://datatracker.ietf.org/doc/html/draft-wright-json-schema-hyperschema-00
-   */
-
-  get base() {
-    return this.get('base');
-  }
-  set base(base) {
-    this.set('base', base);
-  }
-  get linksField() {
-    return this.get('links');
-  }
-  set linksField(links) {
-    this.set('links', links);
-  }
-  get media() {
-    return this.get('media');
-  }
-  set media(media) {
-    this.set('media', media);
-  }
-  get readOnly() {
-    return this.get('readOnly');
-  }
-  set readOnly(readOnly) {
-    this.set('readOnly', readOnly);
-  }
-}
-var _default = exports.default = JSONSchema;