@speclynx/apidom-json-pointer-relative 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-json-pointer-relative
+
 ## [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-json-pointer-relative

package/dist/apidom-json-pointer-relative.browser.js

@@ -15693,7 +15693,9 @@ class Path {
    *
    * @example
    * // For a path to $.paths['/pets'].get in an OpenAPI document:
+   * ```
    * path.getPathKeys(); // => ['paths', '/pets', 'get']
+   * ```
    */
   getPathKeys() {
     const keys = [];
@@ -15728,18 +15730,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();
@@ -15947,15 +15953,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);
       }
     }
   });
@@ -15980,7 +15986,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
  */
@@ -16005,7 +16011,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
@@ -16027,15 +16033,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();
       }
     }
@@ -16053,9 +16059,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
@@ -16064,7 +16068,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) => {
@@ -16072,15 +16076,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);
       }
     }
   });
@@ -16127,11 +16131,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);
 
@@ -16147,7 +16151,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-json-pointer-relative",
-  "version": "3.2.1",
+  "version": "4.0.0",
   "description": "Evaluate Relative JSON Pointer expressions against ApiDOM.",
   "keywords": [
     "apidom",
@@ -54,10 +54,10 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.28.4",
-    "@speclynx/apidom-datamodel": "3.2.1",
-    "@speclynx/apidom-error": "3.2.1",
-    "@speclynx/apidom-json-pointer": "3.2.1",
-    "@speclynx/apidom-traverse": "3.2.1",
+    "@speclynx/apidom-datamodel": "4.0.0",
+    "@speclynx/apidom-error": "4.0.0",
+    "@speclynx/apidom-json-pointer": "4.0.0",
+    "@speclynx/apidom-traverse": "4.0.0",
     "ramda": "~0.32.0",
     "ramda-adjunct": "^6.0.0"
   },
@@ -71,5 +71,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "83a1e97089ef29134e41ff7cacd351973114ea5b"
+  "gitHead": "384ff82a1bb68d015fd6801de641898b4b582876"
 }

package/src/compile.cjs

@@ -1,37 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomJsonPointer = require("@speclynx/apidom-json-pointer");
-var _CompilationRelativeJsonPointerError = _interopRequireDefault(require("./errors/CompilationRelativeJsonPointerError.cjs"));
-/**
- * @public
- */
-const compile = relativeJsonPointer => {
-  try {
-    let relativePointer = '';
-
-    // non-negative-integer
-    relativePointer += String(relativeJsonPointer.nonNegativeIntegerPrefix);
-
-    // index-manipulation
-    if (typeof relativeJsonPointer.indexManipulation === 'number') {
-      relativePointer += String(relativeJsonPointer.indexManipulation);
-    }
-    if (Array.isArray(relativeJsonPointer.jsonPointerTokens)) {
-      // <json-pointer>
-      relativePointer += (0, _apidomJsonPointer.compile)(relativeJsonPointer.jsonPointerTokens);
-    } else if (relativeJsonPointer.hashCharacter) {
-      // "#"
-      relativePointer += '#';
-    }
-    return relativePointer;
-  } catch (error) {
-    throw new _CompilationRelativeJsonPointerError.default('Relative JSON Pointer compilation encountered an error.', {
-      relativePointer: relativeJsonPointer,
-      cause: error
-    });
-  }
-};
-var _default = exports.default = compile;

package/src/compile.mjs

@@ -1,32 +0,0 @@
-import { compile as compileJsonPointer } from '@speclynx/apidom-json-pointer';
-import CompilationRelativeJsonPointerError from "./errors/CompilationRelativeJsonPointerError.mjs";
-/**
- * @public
- */
-const compile = relativeJsonPointer => {
-  try {
-    let relativePointer = '';
-
-    // non-negative-integer
-    relativePointer += String(relativeJsonPointer.nonNegativeIntegerPrefix);
-
-    // index-manipulation
-    if (typeof relativeJsonPointer.indexManipulation === 'number') {
-      relativePointer += String(relativeJsonPointer.indexManipulation);
-    }
-    if (Array.isArray(relativeJsonPointer.jsonPointerTokens)) {
-      // <json-pointer>
-      relativePointer += compileJsonPointer(relativeJsonPointer.jsonPointerTokens);
-    } else if (relativeJsonPointer.hashCharacter) {
-      // "#"
-      relativePointer += '#';
-    }
-    return relativePointer;
-  } catch (error) {
-    throw new CompilationRelativeJsonPointerError('Relative JSON Pointer compilation encountered an error.', {
-      relativePointer: relativeJsonPointer,
-      cause: error
-    });
-  }
-};
-export default compile;

package/src/errors/CompilationRelativeJsonPointerError.cjs

@@ -1,31 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _RelativeJsonPointerError = _interopRequireDefault(require("./RelativeJsonPointerError.cjs"));
-/**
- * @public
- */
-
-/**
- * @public
- */
-class CompilationRelativeJsonPointerError extends _RelativeJsonPointerError.default {
-  nonNegativeIntegerPrefix;
-  indexManipulation;
-  jsonPointerTokens;
-  hashCharacter;
-  constructor(message, structuredOptions) {
-    super(message, structuredOptions);
-    if (typeof structuredOptions !== 'undefined') {
-      this.nonNegativeIntegerPrefix = structuredOptions.relativePointer.nonNegativeIntegerPrefix;
-      this.indexManipulation = structuredOptions.relativePointer.indexManipulation;
-      this.hashCharacter = structuredOptions.relativePointer.hashCharacter;
-      if (Array.isArray(structuredOptions.relativePointer.jsonPointerTokens)) {
-        this.jsonPointerTokens = [...structuredOptions.relativePointer.jsonPointerTokens];
-      }
-    }
-  }
-}
-var _default = exports.default = CompilationRelativeJsonPointerError;

package/src/errors/CompilationRelativeJsonPointerError.mjs

@@ -1,25 +0,0 @@
-import RelativeJsonPointerError from "./RelativeJsonPointerError.mjs";
-/**
- * @public
- */
-/**
- * @public
- */
-class CompilationRelativeJsonPointerError extends RelativeJsonPointerError {
-  nonNegativeIntegerPrefix;
-  indexManipulation;
-  jsonPointerTokens;
-  hashCharacter;
-  constructor(message, structuredOptions) {
-    super(message, structuredOptions);
-    if (typeof structuredOptions !== 'undefined') {
-      this.nonNegativeIntegerPrefix = structuredOptions.relativePointer.nonNegativeIntegerPrefix;
-      this.indexManipulation = structuredOptions.relativePointer.indexManipulation;
-      this.hashCharacter = structuredOptions.relativePointer.hashCharacter;
-      if (Array.isArray(structuredOptions.relativePointer.jsonPointerTokens)) {
-        this.jsonPointerTokens = [...structuredOptions.relativePointer.jsonPointerTokens];
-      }
-    }
-  }
-}
-export default CompilationRelativeJsonPointerError;

package/src/errors/EvaluationRelativeJsonPointerError.cjs

@@ -1,29 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _RelativeJsonPointerError = _interopRequireDefault(require("./RelativeJsonPointerError.cjs"));
-/**
- * @public
- */
-
-/**
- * @public
- */
-class EvaluationRelativeJsonPointerError extends _RelativeJsonPointerError.default {
-  relativePointer;
-  currentElement;
-  rootElement;
-  cursorElement;
-  constructor(message, structuredOptions) {
-    super(message, structuredOptions);
-    if (typeof structuredOptions !== 'undefined') {
-      this.relativePointer = structuredOptions.relativePointer;
-      this.currentElement = structuredOptions.currentElement;
-      this.rootElement = structuredOptions.rootElement;
-      this.cursorElement = structuredOptions.cursorElement;
-    }
-  }
-}
-var _default = exports.default = EvaluationRelativeJsonPointerError;

package/src/errors/EvaluationRelativeJsonPointerError.mjs

@@ -1,23 +0,0 @@
-import RelativeJsonPointerError from "./RelativeJsonPointerError.mjs";
-/**
- * @public
- */
-/**
- * @public
- */
-class EvaluationRelativeJsonPointerError extends RelativeJsonPointerError {
-  relativePointer;
-  currentElement;
-  rootElement;
-  cursorElement;
-  constructor(message, structuredOptions) {
-    super(message, structuredOptions);
-    if (typeof structuredOptions !== 'undefined') {
-      this.relativePointer = structuredOptions.relativePointer;
-      this.currentElement = structuredOptions.currentElement;
-      this.rootElement = structuredOptions.rootElement;
-      this.cursorElement = structuredOptions.cursorElement;
-    }
-  }
-}
-export default EvaluationRelativeJsonPointerError;

package/src/errors/InvalidRelativeJsonPointerError.cjs

@@ -1,23 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _RelativeJsonPointerError = _interopRequireDefault(require("./RelativeJsonPointerError.cjs"));
-/**
- * @public
- */
-
-/**
- * @public
- */
-class InvalidRelativeJsonPointerError extends _RelativeJsonPointerError.default {
-  relativePointer;
-  constructor(message, structuredOptions) {
-    super(message, structuredOptions);
-    if (typeof structuredOptions !== 'undefined') {
-      this.relativePointer = structuredOptions.relativePointer;
-    }
-  }
-}
-exports.default = InvalidRelativeJsonPointerError;

package/src/errors/InvalidRelativeJsonPointerError.mjs

@@ -1,16 +0,0 @@
-import RelativeJsonPointerError from "./RelativeJsonPointerError.mjs";
-/**
- * @public
- */
-/**
- * @public
- */
-export default class InvalidRelativeJsonPointerError extends RelativeJsonPointerError {
-  relativePointer;
-  constructor(message, structuredOptions) {
-    super(message, structuredOptions);
-    if (typeof structuredOptions !== 'undefined') {
-      this.relativePointer = structuredOptions.relativePointer;
-    }
-  }
-}

package/src/errors/RelativeJsonPointerError.cjs

@@ -1,10 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomError = require("@speclynx/apidom-error");
-/**
- * @public
- */
-class RelativeJsonPointerError extends _apidomError.ApiDOMStructuredError {}
-var _default = exports.default = RelativeJsonPointerError;

package/src/errors/RelativeJsonPointerError.mjs

@@ -1,7 +0,0 @@
-import { ApiDOMStructuredError } from '@speclynx/apidom-error';
-
-/**
- * @public
- */
-class RelativeJsonPointerError extends ApiDOMStructuredError {}
-export default RelativeJsonPointerError;

package/src/evaluate.cjs

@@ -1,127 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomDatamodel = require("@speclynx/apidom-datamodel");
-var _apidomTraverse = require("@speclynx/apidom-traverse");
-var _apidomJsonPointer = require("@speclynx/apidom-json-pointer");
-var _ramda = require("ramda");
-var _EvaluationRelativeJsonPointerError = _interopRequireDefault(require("./errors/EvaluationRelativeJsonPointerError.cjs"));
-var _parse = _interopRequireDefault(require("./parse.cjs"));
-/**
- * Evaluates Relative JSON Pointer against ApiDOM fragment.
- * @public
- */
-const evaluate = (relativePointer, currentElement, rootElement) => {
-  let ancestorLineage = [];
-  let cursor = currentElement;
-  (0, _apidomTraverse.traverse)(rootElement, {
-    enter(path) {
-      if (path.node === currentElement) {
-        ancestorLineage = path.getAncestorNodes().reverse().filter(_apidomDatamodel.isElement);
-        path.stop();
-      }
-    }
-  });
-  if (ancestorLineage.length === 0) {
-    throw new _EvaluationRelativeJsonPointerError.default('Relative JSON Pointer evaluation failed. Current element not found inside the root element', {
-      relativePointer,
-      currentElement: (0, _apidomDatamodel.cloneDeep)(currentElement),
-      rootElement: (0, _apidomDatamodel.cloneDeep)(rootElement),
-      cursorElement: _apidomDatamodel.cloneDeep.safe(cursor)
-    });
-  }
-  if ((0, _ramda.last)(ancestorLineage) === rootElement) {
-    throw new _EvaluationRelativeJsonPointerError.default('Relative JSON Pointer evaluation failed. Current element cannot be the root element', {
-      relativePointer,
-      currentElement,
-      rootElement,
-      cursorElement: cursor
-    });
-  }
-  let relativeJsonPointer;
-  try {
-    relativeJsonPointer = (0, _parse.default)(relativePointer);
-  } catch (error) {
-    throw new _EvaluationRelativeJsonPointerError.default('Relative JSON Pointer evaluation failed while parsing the pointer.', {
-      relativePointer,
-      currentElement: (0, _apidomDatamodel.cloneDeep)(currentElement),
-      rootElement: (0, _apidomDatamodel.cloneDeep)(currentElement),
-      cursorElement: _apidomDatamodel.cloneDeep.safe(cursor),
-      cause: error
-    });
-  }
-
-  // non-negative-integer
-  if (relativeJsonPointer.nonNegativeIntegerPrefix > 0) {
-    const ancestorLineageCopy = [...ancestorLineage];
-    for (let {
-      nonNegativeIntegerPrefix
-    } = relativeJsonPointer; nonNegativeIntegerPrefix > 0; nonNegativeIntegerPrefix -= 1) {
-      cursor = ancestorLineageCopy.pop();
-      if ((0, _apidomDatamodel.isMemberElement)(cursor)) {
-        cursor = ancestorLineageCopy.pop();
-      }
-    }
-    if (typeof cursor === 'undefined') {
-      throw new _EvaluationRelativeJsonPointerError.default(`Relative JSON Pointer evaluation failed on non-negative-integer prefix of "${relativeJsonPointer.nonNegativeIntegerPrefix}"`, {
-        relativePointer,
-        currentElement: (0, _apidomDatamodel.cloneDeep)(currentElement),
-        rootElement: (0, _apidomDatamodel.cloneDeep)(rootElement),
-        cursorElement: _apidomDatamodel.cloneDeep.safe(cursor)
-      });
-    }
-    ancestorLineage = ancestorLineageCopy;
-  }
-
-  // index-manipulation
-  if (typeof relativeJsonPointer.indexManipulation === 'number') {
-    const containedArray = (0, _ramda.last)(ancestorLineage);
-    if (typeof containedArray === 'undefined' || !(0, _apidomDatamodel.isArrayElement)(containedArray)) {
-      throw new _EvaluationRelativeJsonPointerError.default(`Relative JSON Pointer evaluation failed failed on index-manipulation "${relativeJsonPointer.indexManipulation}"`, {
-        relativePointer,
-        currentElement: (0, _apidomDatamodel.cloneDeep)(currentElement),
-        rootElement: (0, _apidomDatamodel.cloneDeep)(rootElement),
-        cursorElement: _apidomDatamodel.cloneDeep.safe(cursor)
-      });
-    }
-    const arrayContent = containedArray.content;
-    const currentCursorIndex = arrayContent.indexOf(cursor);
-    const newCursorIndex = currentCursorIndex + relativeJsonPointer.indexManipulation;
-    cursor = arrayContent[newCursorIndex];
-    if (typeof cursor === 'undefined') {
-      throw new _EvaluationRelativeJsonPointerError.default(`Relative JSON Pointer evaluation failed on index-manipulation "${relativeJsonPointer.indexManipulation}"`, {
-        relativePointer,
-        currentElement: (0, _apidomDatamodel.cloneDeep)(currentElement),
-        rootElement: (0, _apidomDatamodel.cloneDeep)(rootElement),
-        cursorElement: _apidomDatamodel.cloneDeep.safe(cursor)
-      });
-    }
-  }
-  if (Array.isArray(relativeJsonPointer.jsonPointerTokens)) {
-    // <json-pointer>
-    const jsonPointer = (0, _apidomJsonPointer.compile)(relativeJsonPointer.jsonPointerTokens);
-    cursor = (0, _apidomJsonPointer.evaluate)(cursor, jsonPointer);
-  } else if (relativeJsonPointer.hashCharacter) {
-    // "#"
-    if (cursor === rootElement) {
-      throw new _EvaluationRelativeJsonPointerError.default('Relative JSON Pointer evaluation failed. Current element cannot be the root element to apply "#"', {
-        relativePointer,
-        currentElement: (0, _apidomDatamodel.cloneDeep)(currentElement),
-        rootElement: (0, _apidomDatamodel.cloneDeep)(rootElement),
-        cursorElement: _apidomDatamodel.cloneDeep.safe(cursor)
-      });
-    }
-    const parentElement = (0, _ramda.last)(ancestorLineage);
-    if (typeof parentElement !== 'undefined') {
-      if ((0, _apidomDatamodel.isMemberElement)(parentElement)) {
-        cursor = parentElement.key;
-      } else if ((0, _apidomDatamodel.isArrayElement)(parentElement)) {
-        cursor = new _apidomDatamodel.NumberElement(parentElement.content.indexOf(cursor));
-      }
-    }
-  }
-  return cursor;
-};
-var _default = exports.default = evaluate;

package/src/evaluate.mjs

@@ -1,122 +0,0 @@
-import { isElement, isMemberElement, isArrayElement, NumberElement, cloneDeep } from '@speclynx/apidom-datamodel';
-import { traverse } from '@speclynx/apidom-traverse';
-import { compile as compileJsonPointer, evaluate as evaluateJsonPointer } from '@speclynx/apidom-json-pointer';
-import { last } from 'ramda';
-import EvaluationRelativeJsonPointerError from "./errors/EvaluationRelativeJsonPointerError.mjs";
-import parse from "./parse.mjs";
-/**
- * Evaluates Relative JSON Pointer against ApiDOM fragment.
- * @public
- */
-const evaluate = (relativePointer, currentElement, rootElement) => {
-  let ancestorLineage = [];
-  let cursor = currentElement;
-  traverse(rootElement, {
-    enter(path) {
-      if (path.node === currentElement) {
-        ancestorLineage = path.getAncestorNodes().reverse().filter(isElement);
-        path.stop();
-      }
-    }
-  });
-  if (ancestorLineage.length === 0) {
-    throw new EvaluationRelativeJsonPointerError('Relative JSON Pointer evaluation failed. Current element not found inside the root element', {
-      relativePointer,
-      currentElement: cloneDeep(currentElement),
-      rootElement: cloneDeep(rootElement),
-      cursorElement: cloneDeep.safe(cursor)
-    });
-  }
-  if (last(ancestorLineage) === rootElement) {
-    throw new EvaluationRelativeJsonPointerError('Relative JSON Pointer evaluation failed. Current element cannot be the root element', {
-      relativePointer,
-      currentElement,
-      rootElement,
-      cursorElement: cursor
-    });
-  }
-  let relativeJsonPointer;
-  try {
-    relativeJsonPointer = parse(relativePointer);
-  } catch (error) {
-    throw new EvaluationRelativeJsonPointerError('Relative JSON Pointer evaluation failed while parsing the pointer.', {
-      relativePointer,
-      currentElement: cloneDeep(currentElement),
-      rootElement: cloneDeep(currentElement),
-      cursorElement: cloneDeep.safe(cursor),
-      cause: error
-    });
-  }
-
-  // non-negative-integer
-  if (relativeJsonPointer.nonNegativeIntegerPrefix > 0) {
-    const ancestorLineageCopy = [...ancestorLineage];
-    for (let {
-      nonNegativeIntegerPrefix
-    } = relativeJsonPointer; nonNegativeIntegerPrefix > 0; nonNegativeIntegerPrefix -= 1) {
-      cursor = ancestorLineageCopy.pop();
-      if (isMemberElement(cursor)) {
-        cursor = ancestorLineageCopy.pop();
-      }
-    }
-    if (typeof cursor === 'undefined') {
-      throw new EvaluationRelativeJsonPointerError(`Relative JSON Pointer evaluation failed on non-negative-integer prefix of "${relativeJsonPointer.nonNegativeIntegerPrefix}"`, {
-        relativePointer,
-        currentElement: cloneDeep(currentElement),
-        rootElement: cloneDeep(rootElement),
-        cursorElement: cloneDeep.safe(cursor)
-      });
-    }
-    ancestorLineage = ancestorLineageCopy;
-  }
-
-  // index-manipulation
-  if (typeof relativeJsonPointer.indexManipulation === 'number') {
-    const containedArray = last(ancestorLineage);
-    if (typeof containedArray === 'undefined' || !isArrayElement(containedArray)) {
-      throw new EvaluationRelativeJsonPointerError(`Relative JSON Pointer evaluation failed failed on index-manipulation "${relativeJsonPointer.indexManipulation}"`, {
-        relativePointer,
-        currentElement: cloneDeep(currentElement),
-        rootElement: cloneDeep(rootElement),
-        cursorElement: cloneDeep.safe(cursor)
-      });
-    }
-    const arrayContent = containedArray.content;
-    const currentCursorIndex = arrayContent.indexOf(cursor);
-    const newCursorIndex = currentCursorIndex + relativeJsonPointer.indexManipulation;
-    cursor = arrayContent[newCursorIndex];
-    if (typeof cursor === 'undefined') {
-      throw new EvaluationRelativeJsonPointerError(`Relative JSON Pointer evaluation failed on index-manipulation "${relativeJsonPointer.indexManipulation}"`, {
-        relativePointer,
-        currentElement: cloneDeep(currentElement),
-        rootElement: cloneDeep(rootElement),
-        cursorElement: cloneDeep.safe(cursor)
-      });
-    }
-  }
-  if (Array.isArray(relativeJsonPointer.jsonPointerTokens)) {
-    // <json-pointer>
-    const jsonPointer = compileJsonPointer(relativeJsonPointer.jsonPointerTokens);
-    cursor = evaluateJsonPointer(cursor, jsonPointer);
-  } else if (relativeJsonPointer.hashCharacter) {
-    // "#"
-    if (cursor === rootElement) {
-      throw new EvaluationRelativeJsonPointerError('Relative JSON Pointer evaluation failed. Current element cannot be the root element to apply "#"', {
-        relativePointer,
-        currentElement: cloneDeep(currentElement),
-        rootElement: cloneDeep(rootElement),
-        cursorElement: cloneDeep.safe(cursor)
-      });
-    }
-    const parentElement = last(ancestorLineage);
-    if (typeof parentElement !== 'undefined') {
-      if (isMemberElement(parentElement)) {
-        cursor = parentElement.key;
-      } else if (isArrayElement(parentElement)) {
-        cursor = new NumberElement(parentElement.content.indexOf(cursor));
-      }
-    }
-  }
-  return cursor;
-};
-export default evaluate;

package/src/index.cjs

@@ -1,21 +0,0 @@
-"use strict";
-
-var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.parse = exports.isRelativeJsonPointer = exports.evaluate = exports.compile = exports.RelativeJsonPointerError = exports.InvalidRelativeJsonPointerError = exports.EvaluationRelativeJsonPointerError = exports.CompilationRelativeJsonPointerError = void 0;
-var _RelativeJsonPointerError = _interopRequireDefault(require("./errors/RelativeJsonPointerError.cjs"));
-exports.RelativeJsonPointerError = _RelativeJsonPointerError.default;
-var _InvalidRelativeJsonPointerError = _interopRequireDefault(require("./errors/InvalidRelativeJsonPointerError.cjs"));
-exports.InvalidRelativeJsonPointerError = _InvalidRelativeJsonPointerError.default;
-var _EvaluationRelativeJsonPointerError = _interopRequireDefault(require("./errors/EvaluationRelativeJsonPointerError.cjs"));
-exports.EvaluationRelativeJsonPointerError = _EvaluationRelativeJsonPointerError.default;
-var _CompilationRelativeJsonPointerError = _interopRequireDefault(require("./errors/CompilationRelativeJsonPointerError.cjs"));
-exports.CompilationRelativeJsonPointerError = _CompilationRelativeJsonPointerError.default;
-var _parse = _interopRequireWildcard(require("./parse.cjs"));
-exports.parse = _parse.default;
-exports.isRelativeJsonPointer = _parse.isRelativeJsonPointer;
-var _compile = _interopRequireDefault(require("./compile.cjs"));
-exports.compile = _compile.default;
-var _evaluate = _interopRequireDefault(require("./evaluate.cjs"));
-exports.evaluate = _evaluate.default;

package/src/index.mjs

@@ -1,7 +0,0 @@
-export { default as RelativeJsonPointerError } from "./errors/RelativeJsonPointerError.mjs";
-export { default as InvalidRelativeJsonPointerError } from "./errors/InvalidRelativeJsonPointerError.mjs";
-export { default as EvaluationRelativeJsonPointerError } from "./errors/EvaluationRelativeJsonPointerError.mjs";
-export { default as CompilationRelativeJsonPointerError } from "./errors/CompilationRelativeJsonPointerError.mjs";
-export { default as parse, isRelativeJsonPointer } from "./parse.mjs";
-export { default as compile } from "./compile.mjs";
-export { default as evaluate } from "./evaluate.mjs";

package/src/parse.cjs

@@ -1,54 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.isRelativeJsonPointer = exports.default = void 0;
-var _apidomJsonPointer = require("@speclynx/apidom-json-pointer");
-var _InvalidRelativeJsonPointerError = _interopRequireDefault(require("./errors/InvalidRelativeJsonPointerError.cjs"));
-const nonNegativeIntegerPrefixRegExp = '(?<nonNegativeIntegerPrefix>[1-9]\\d*|0)';
-const indexManipulationRegExp = '(?<indexManipulation>[+-][1-9]\\d*|0)';
-const hashCharacterRegExp = '(?<hashCharacter>#)';
-const jsonPointerRegExp = '(?<jsonPointer>\\/.*)';
-const relativeJsonPointerRegExp = new RegExp(`^${nonNegativeIntegerPrefixRegExp}${indexManipulationRegExp}?(${hashCharacterRegExp}|${jsonPointerRegExp})?$`);
-
-/**
- * @public
- */
-const isRelativeJsonPointer = value => {
-  return typeof value === 'string' && relativeJsonPointerRegExp.test(value);
-};
-
-/**
- * @public
- */
-exports.isRelativeJsonPointer = isRelativeJsonPointer;
-const parse = relativePointer => {
-  const match = relativePointer.match(relativeJsonPointerRegExp);
-  if (match === null || typeof match.groups === 'undefined') {
-    throw new _InvalidRelativeJsonPointerError.default(`Invalid Relative JSON Pointer "${relativePointer}".`, {
-      relativePointer
-    });
-  }
-  try {
-    // non-negative-integer
-    const nonNegativeIntegerPrefix = parseInt(match.groups.nonNegativeIntegerPrefix, 10);
-    // index-manipulation
-    const indexManipulation = typeof match.groups.indexManipulation === 'string' ? parseInt(match.groups.indexManipulation, 10) : undefined;
-    // <json-pointer>
-    const jsonPointerTokens = typeof match.groups.jsonPointer === 'string' ? (0, _apidomJsonPointer.parse)(match.groups.jsonPointer).tree : undefined;
-    // "#"
-    const hashCharacter = typeof match.groups.hashCharacter === 'string';
-    return {
-      nonNegativeIntegerPrefix,
-      indexManipulation,
-      jsonPointerTokens,
-      hashCharacter
-    };
-  } catch (error) {
-    throw new _InvalidRelativeJsonPointerError.default(`Relative JSON Pointer parsing of "${relativePointer}" encountered an error.`, {
-      relativePointer,
-      cause: error
-    });
-  }
-};
-var _default = exports.default = parse;

package/src/parse.mjs

@@ -1,48 +0,0 @@
-import { parse as parseJsonPointer } from '@speclynx/apidom-json-pointer';
-import InvalidRelativeJsonPointerError from "./errors/InvalidRelativeJsonPointerError.mjs";
-const nonNegativeIntegerPrefixRegExp = '(?<nonNegativeIntegerPrefix>[1-9]\\d*|0)';
-const indexManipulationRegExp = '(?<indexManipulation>[+-][1-9]\\d*|0)';
-const hashCharacterRegExp = '(?<hashCharacter>#)';
-const jsonPointerRegExp = '(?<jsonPointer>\\/.*)';
-const relativeJsonPointerRegExp = new RegExp(`^${nonNegativeIntegerPrefixRegExp}${indexManipulationRegExp}?(${hashCharacterRegExp}|${jsonPointerRegExp})?$`);
-
-/**
- * @public
- */
-export const isRelativeJsonPointer = value => {
-  return typeof value === 'string' && relativeJsonPointerRegExp.test(value);
-};
-
-/**
- * @public
- */
-const parse = relativePointer => {
-  const match = relativePointer.match(relativeJsonPointerRegExp);
-  if (match === null || typeof match.groups === 'undefined') {
-    throw new InvalidRelativeJsonPointerError(`Invalid Relative JSON Pointer "${relativePointer}".`, {
-      relativePointer
-    });
-  }
-  try {
-    // non-negative-integer
-    const nonNegativeIntegerPrefix = parseInt(match.groups.nonNegativeIntegerPrefix, 10);
-    // index-manipulation
-    const indexManipulation = typeof match.groups.indexManipulation === 'string' ? parseInt(match.groups.indexManipulation, 10) : undefined;
-    // <json-pointer>
-    const jsonPointerTokens = typeof match.groups.jsonPointer === 'string' ? parseJsonPointer(match.groups.jsonPointer).tree : undefined;
-    // "#"
-    const hashCharacter = typeof match.groups.hashCharacter === 'string';
-    return {
-      nonNegativeIntegerPrefix,
-      indexManipulation,
-      jsonPointerTokens,
-      hashCharacter
-    };
-  } catch (error) {
-    throw new InvalidRelativeJsonPointerError(`Relative JSON Pointer parsing of "${relativePointer}" encountered an error.`, {
-      relativePointer,
-      cause: error
-    });
-  }
-};
-export default parse;

package/src/types.cjs

@@ -1,3 +0,0 @@
-"use strict";
-
-exports.__esModule = true;

package/src/types.mjs

@@ -1 +0,0 @@
-export {};