@swagger-api/apidom-json-pointer-relative 0.75.0 → 0.76.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.76.0](https://github.com/swagger-api/apidom/compare/v0.75.0...v0.76.0) (2023-09-01)
+
+### Features
+
+- **json-pointer-relative:** use error hierarchy and metadata when trowing errors ([#3108](https://github.com/swagger-api/apidom/issues/3108)) ([deaed14](https://github.com/swagger-api/apidom/commit/deaed142acd9881062fc65156e1162b48a580751)), closes [#3039](https://github.com/swagger-api/apidom/issues/3039)
+
 # [0.75.0](https://github.com/swagger-api/apidom/compare/v0.74.1...v0.75.0) (2023-08-22)
 
 ### Features

package/cjs/compile.cjs

@@ -1,27 +1,36 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
 exports.__esModule = true;
 exports.default = void 0;
 var _apidomJsonPointer = require("@swagger-api/apidom-json-pointer");
+var _CompilationRelativeJsonPointerError = _interopRequireDefault(require("./errors/CompilationRelativeJsonPointerError.cjs"));
 // compile :: RelativeJSONPointer -> String
 const compile = relativeJsonPointer => {
-  let relativePointer = '';
+  try {
+    let relativePointer = '';
 
-  // non-negative-integer
-  relativePointer += String(relativeJsonPointer.nonNegativeIntegerPrefix);
+    // non-negative-integer
+    relativePointer += String(relativeJsonPointer.nonNegativeIntegerPrefix);
 
-  // index-manipulation
-  if (typeof relativeJsonPointer.indexManipulation === 'number') {
-    relativePointer += String(relativeJsonPointer.indexManipulation);
+    // 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
+    });
   }
-  if (Array.isArray(relativeJsonPointer.jsonPointerTokens)) {
-    // <json-pointer>
-    relativePointer += (0, _apidomJsonPointer.compile)(relativeJsonPointer.jsonPointerTokens);
-  } else if (relativeJsonPointer.hashCharacter) {
-    // "#"
-    relativePointer += '#';
-  }
-  return relativePointer;
 };
 var _default = compile;
 exports.default = _default;

package/cjs/errors/CompilationRelativeJsonPointerError.cjs

@@ -0,0 +1,21 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.default = void 0;
+var _RelativeJsonPointerError = _interopRequireDefault(require("./RelativeJsonPointerError.cjs"));
+class CompilationRelativeJsonPointerError extends _RelativeJsonPointerError.default {
+  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 = CompilationRelativeJsonPointerError;
+exports.default = _default;

package/cjs/errors/EvaluationRelativeJsonPointerError.cjs

@@ -1,17 +1,31 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
 exports.__esModule = true;
 exports.default = void 0;
-class EvaluationRelativeJsonPointerError extends Error {
-  constructor(message) {
-    super(message);
-    this.name = this.constructor.name;
-    this.message = message;
-    if (typeof Error.captureStackTrace === 'function') {
-      Error.captureStackTrace(this, this.constructor);
-    } else {
-      this.stack = new Error(message).stack;
+var _apidomCore = require("@swagger-api/apidom-core");
+var _RelativeJsonPointerError = _interopRequireDefault(require("./RelativeJsonPointerError.cjs"));
+class EvaluationRelativeJsonPointerError extends _RelativeJsonPointerError.default {
+  constructor(message, structuredOptions) {
+    super(message, structuredOptions);
+    if (typeof structuredOptions !== 'undefined') {
+      this.relativePointer = structuredOptions.relativePointer;
+      this.currentElement = structuredOptions.currentElement.element;
+      if ((0, _apidomCore.hasElementSourceMap)(structuredOptions.currentElement)) {
+        this.currentElementSourceMap = (0, _apidomCore.toValue)(structuredOptions.currentElement.getMetaProperty('sourceMap'));
+      }
+      this.rootElement = structuredOptions.rootElement.element;
+      if ((0, _apidomCore.hasElementSourceMap)(structuredOptions.rootElement)) {
+        this.rootElementSourceMap = (0, _apidomCore.toValue)(structuredOptions.rootElement.getMetaProperty('sourceMap'));
+      }
+      if (typeof structuredOptions.cursorElement !== 'undefined') {
+        this.cursorElement = structuredOptions.cursorElement.element;
+        if ((0, _apidomCore.hasElementSourceMap)(structuredOptions.cursorElement)) {
+          this.cursorElementSourceMap = (0, _apidomCore.toValue)(structuredOptions.cursorElement.getMetaProperty('sourceMap'));
+        }
+      }
     }
   }
 }
-exports.default = EvaluationRelativeJsonPointerError;
+var _default = EvaluationRelativeJsonPointerError;
+exports.default = _default;

package/cjs/errors/InvalidRelativeJsonPointerError.cjs

@@ -1,16 +1,14 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
 exports.__esModule = true;
 exports.default = void 0;
-class InvalidRelativeJsonPointerError extends Error {
-  constructor(relativePointer) {
-    super(`Invalid Relative JSON Pointer "${relativePointer}".`);
-    this.name = this.constructor.name;
-    this.message = `Invalid Relative JSON Pointer "${relativePointer}".`;
-    if (typeof Error.captureStackTrace === 'function') {
-      Error.captureStackTrace(this, this.constructor);
-    } else {
-      this.stack = new Error(`Invalid Relative JSON Pointer "${relativePointer}".`).stack;
+var _RelativeJsonPointerError = _interopRequireDefault(require("./RelativeJsonPointerError.cjs"));
+class InvalidRelativeJsonPointerError extends _RelativeJsonPointerError.default {
+  constructor(message, structuredOptions) {
+    super(message, structuredOptions);
+    if (typeof structuredOptions !== 'undefined') {
+      this.relativePointer = structuredOptions.relativePointer;
     }
   }
 }

package/cjs/errors/RelativeJsonPointerError.cjs

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

package/cjs/evaluate.cjs

@@ -6,7 +6,7 @@ exports.default = void 0;
 var _apidomCore = require("@swagger-api/apidom-core");
 var _apidomJsonPointer = require("@swagger-api/apidom-json-pointer");
 var _ramda = require("ramda");
-var _index = require("./errors/index.cjs");
+var _EvaluationRelativeJsonPointerError = _interopRequireDefault(require("./errors/EvaluationRelativeJsonPointerError.cjs"));
 var _parse = _interopRequireDefault(require("./parse.cjs"));
 // evaluates Relative JSON Pointer against ApiDOM fragment
 const evaluate = (relativePointer, currentElement, rootElement) => {
@@ -22,12 +22,33 @@ const evaluate = (relativePointer, currentElement, rootElement) => {
     }
   });
   if (ancestorLineage.length === 0) {
-    throw new _index.EvaluationRelativeJsonPointerError('Current element not found inside the root element');
+    throw new _EvaluationRelativeJsonPointerError.default('Relative JSON Pointer evaluation failed. Current element not found inside the root element', {
+      relativePointer,
+      currentElement,
+      rootElement,
+      cursorElement: cursor
+    });
   }
   if ((0, _ramda.last)(ancestorLineage) === rootElement) {
-    throw new _index.EvaluationRelativeJsonPointerError('Current element cannot be the root element');
+    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,
+      rootElement,
+      cursorElement: cursor,
+      cause: error
+    });
   }
-  const relativeJsonPointer = (0, _parse.default)(relativePointer);
 
   // non-negative-integer
   if (relativeJsonPointer.nonNegativeIntegerPrefix > 0) {
@@ -41,7 +62,12 @@ const evaluate = (relativePointer, currentElement, rootElement) => {
       }
     }
     if (typeof cursor === 'undefined') {
-      throw new _index.EvaluationRelativeJsonPointerError(`Evaluation failed on non-negative-integer prefix of "${relativeJsonPointer.nonNegativeIntegerPrefix}"`);
+      throw new _EvaluationRelativeJsonPointerError.default(`Relative JSON Pointer evaluation failed on non-negative-integer prefix of "${relativeJsonPointer.nonNegativeIntegerPrefix}"`, {
+        relativePointer,
+        currentElement,
+        rootElement,
+        cursorElement: cursor
+      });
     }
     ancestorLineage = ancestorLineageCopy;
   }
@@ -50,13 +76,23 @@ const evaluate = (relativePointer, currentElement, rootElement) => {
   if (typeof relativeJsonPointer.indexManipulation === 'number') {
     const containedArray = (0, _ramda.last)(ancestorLineage);
     if (typeof containedArray === 'undefined' || !(0, _apidomCore.isArrayElement)(containedArray)) {
-      throw new _index.EvaluationRelativeJsonPointerError(`Evaluation failed on index-manipulation "${relativeJsonPointer.indexManipulation}"`);
+      throw new _EvaluationRelativeJsonPointerError.default(`Relative JSON Pointer evaluation failed failed on index-manipulation "${relativeJsonPointer.indexManipulation}"`, {
+        relativePointer,
+        currentElement,
+        rootElement,
+        cursorElement: cursor
+      });
     }
     const currentCursorIndex = containedArray.content.indexOf(cursor);
     const newCursorIndex = currentCursorIndex + relativeJsonPointer.indexManipulation;
     cursor = containedArray.content[newCursorIndex];
     if (typeof cursor === 'undefined') {
-      throw new _index.EvaluationRelativeJsonPointerError(`Evaluation failed on index-manipulation "${relativeJsonPointer.indexManipulation}"`);
+      throw new _EvaluationRelativeJsonPointerError.default(`Relative JSON Pointer evaluation failed on index-manipulation "${relativeJsonPointer.indexManipulation}"`, {
+        relativePointer,
+        currentElement,
+        rootElement,
+        cursorElement: cursor
+      });
     }
   }
   if (Array.isArray(relativeJsonPointer.jsonPointerTokens)) {
@@ -66,7 +102,12 @@ const evaluate = (relativePointer, currentElement, rootElement) => {
   } else if (relativeJsonPointer.hashCharacter) {
     // "#"
     if (cursor === rootElement) {
-      throw new _index.EvaluationRelativeJsonPointerError('Current element cannot be the root element to apply "#"');
+      throw new _EvaluationRelativeJsonPointerError.default('Relative JSON Pointer evaluation failed. Current element cannot be the root element to apply "#"', {
+        relativePointer,
+        currentElement,
+        rootElement,
+        cursorElement: cursor
+      });
     }
     const parentElement = (0, _ramda.last)(ancestorLineage);
     if (typeof parentElement !== 'undefined') {

package/cjs/index.cjs

@@ -2,7 +2,15 @@
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
 exports.__esModule = true;
-exports.parse = exports.isRelativeJsonPointer = exports.evaluate = exports.compile = exports.InvalidRelativeJsonPointerError = exports.EvaluationRelativeJsonPointerError = void 0;
+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;
@@ -10,8 +18,5 @@ var _compile = _interopRequireDefault(require("./compile.cjs"));
 exports.compile = _compile.default;
 var _evaluate = _interopRequireDefault(require("./evaluate.cjs"));
 exports.evaluate = _evaluate.default;
-var _index = require("./errors/index.cjs");
-exports.InvalidRelativeJsonPointerError = _index.InvalidRelativeJsonPointerError;
-exports.EvaluationRelativeJsonPointerError = _index.EvaluationRelativeJsonPointerError;
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }

package/cjs/parse.cjs

@@ -1,9 +1,10 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
 exports.__esModule = true;
 exports.isRelativeJsonPointer = exports.default = void 0;
 var _apidomJsonPointer = require("@swagger-api/apidom-json-pointer");
-var _index = require("./errors/index.cjs");
+var _InvalidRelativeJsonPointerError = _interopRequireDefault(require("./errors/InvalidRelativeJsonPointerError.cjs"));
 const nonNegativeIntegerPrefixRegExp = '(?<nonNegativeIntegerPrefix>[1-9]\\d*|0)';
 const indexManipulationRegExp = '(?<indexManipulation>[+-][1-9]\\d*|0)';
 const hashCharacterRegExp = '(?<hashCharacter>#)';
@@ -18,23 +19,31 @@ exports.isRelativeJsonPointer = isRelativeJsonPointer;
 const parse = relativePointer => {
   const match = relativePointer.match(relativeJsonPointerRegExp);
   if (match === null || typeof match.groups === 'undefined') {
-    throw new _index.InvalidRelativeJsonPointerError(relativePointer);
+    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) : 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
+    });
   }
-
-  // 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) : undefined;
-  // "#"
-  const hashCharacter = typeof match.groups.hashCharacter === 'string';
-  return {
-    nonNegativeIntegerPrefix,
-    indexManipulation,
-    jsonPointerTokens,
-    hashCharacter
-  };
 };
 var _default = parse;
 exports.default = _default;