@swagger-api/apidom-json-path 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-path:** use error hierarchy and metadata when throwing errors ([#3107](https://github.com/swagger-api/apidom/issues/3107)) ([d55a846](https://github.com/swagger-api/apidom/commit/d55a8466de9814f19aedbacb48c55761f2f3fe38)), 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)
 
 **Note:** Version bump only for package @swagger-api/apidom-json-path

package/cjs/errors/EvaluationJsonPathError.cjs

@@ -0,0 +1,21 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomCore = require("@swagger-api/apidom-core");
+var _JsonPathError = _interopRequireDefault(require("./JsonPathError.cjs"));
+class EvaluationJsonPathError extends _JsonPathError.default {
+  constructor(message, structuredOptions) {
+    super(message, structuredOptions);
+    if (typeof structuredOptions !== 'undefined') {
+      this.path = structuredOptions.path;
+      this.element = structuredOptions.element.element;
+      if ((0, _apidomCore.hasElementSourceMap)(structuredOptions.element)) {
+        this.elementSourceMap = (0, _apidomCore.toValue)(structuredOptions.element.getMetaProperty('sourceMap'));
+      }
+    }
+  }
+}
+var _default = EvaluationJsonPathError;
+exports.default = _default;

package/cjs/errors/JsonPathError.cjs

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

package/cjs/errors/MultiEvaluationJsonPathError.cjs

@@ -0,0 +1,21 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomCore = require("@swagger-api/apidom-core");
+var _JsonPathError = _interopRequireDefault(require("./JsonPathError.cjs"));
+class MultiEvaluationJsonPathError extends _JsonPathError.default {
+  constructor(message, structuredOptions) {
+    super(message, structuredOptions);
+    if (typeof structuredOptions !== 'undefined') {
+      this.paths = structuredOptions.paths;
+      this.element = structuredOptions.element.element;
+      if ((0, _apidomCore.hasElementSourceMap)(structuredOptions.element)) {
+        this.elementSourceMap = (0, _apidomCore.toValue)(structuredOptions.element.getMetaProperty('sourceMap'));
+      }
+    }
+  }
+}
+var _default = MultiEvaluationJsonPathError;
+exports.default = _default;

package/cjs/evaluate-multi.cjs

@@ -0,0 +1,44 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.default = void 0;
+var _jsonpathPlus = require("jsonpath-plus");
+var _apidomCore = require("@swagger-api/apidom-core");
+var _apidomJsonPointer = require("@swagger-api/apidom-json-pointer");
+var _MultiEvaluationJsonPathError = _interopRequireDefault(require("./errors/MultiEvaluationJsonPathError.cjs"));
+/**
+ * Evaluates multiple JSONPaths on ApiDOM element.
+ */
+const evaluateMulti = (paths, element) => {
+  try {
+    const json = (0, _apidomCore.toValue)(element);
+    const results = [];
+    for (const path of paths) {
+      const pointers = (0, _jsonpathPlus.JSONPath)({
+        path,
+        json,
+        resultType: 'pointer'
+      });
+      const endPointValues = [];
+      for (const pointer of pointers) {
+        const endPointValue = (0, _apidomJsonPointer.evaluate)(pointer, element);
+        endPointValues.push(endPointValue);
+      }
+      if (Array.isArray(path)) {
+        results.push([_jsonpathPlus.JSONPath.toPathString(path), endPointValues]);
+      } else {
+        results.push([path, endPointValues]);
+      }
+    }
+    return results;
+  } catch (error) {
+    throw new _MultiEvaluationJsonPathError.default(`JSON Path evaluation failed while multi-evaluating "${String(paths)}".`, {
+      paths,
+      element,
+      cause: error
+    });
+  }
+};
+var _default = evaluateMulti;
+exports.default = _default;

package/cjs/evaluate.cjs

@@ -0,0 +1,31 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.default = void 0;
+var _jsonpathPlus = require("jsonpath-plus");
+var _apidomCore = require("@swagger-api/apidom-core");
+var _apidomJsonPointer = require("@swagger-api/apidom-json-pointer");
+var _EvaluationJsonPathError = _interopRequireDefault(require("./errors/EvaluationJsonPathError.cjs"));
+/**
+ * Evaluates single JSONPath on ApiDOM element.
+ */
+const evaluate = (path, element) => {
+  try {
+    const json = (0, _apidomCore.toValue)(element);
+    const pointers = (0, _jsonpathPlus.JSONPath)({
+      path,
+      json,
+      resultType: 'pointer'
+    });
+    return pointers.map(pointer => (0, _apidomJsonPointer.evaluate)(pointer, element));
+  } catch (error) {
+    throw new _EvaluationJsonPathError.default(`JSON Path evaluation failed while evaluating "${String(path)}".`, {
+      path,
+      element,
+      cause: error
+    });
+  }
+};
+var _default = evaluate;
+exports.default = _default;

package/cjs/index.cjs

@@ -1,47 +1,13 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
 exports.__esModule = true;
-exports.evaluateMulti = exports.evaluate = void 0;
-var _jsonpathPlus = require("jsonpath-plus");
-var _apidomCore = require("@swagger-api/apidom-core");
-var _apidomJsonPointer = require("@swagger-api/apidom-json-pointer");
-/**
- * Evaluates single JSONPath on ApiDOM element.
- */
-const evaluate = (path, element) => {
-  const json = (0, _apidomCore.toValue)(element);
-  const pointers = (0, _jsonpathPlus.JSONPath)({
-    path,
-    json,
-    resultType: 'pointer'
-  });
-  return pointers.map(pointer => (0, _apidomJsonPointer.evaluate)(pointer, element));
-};
-
-/**
- * Evaluates multiple JSONPaths on ApiDOM element.
- */
-exports.evaluate = evaluate;
-const evaluateMulti = (paths, element) => {
-  const json = (0, _apidomCore.toValue)(element);
-  const results = [];
-  for (const path of paths) {
-    const pointers = (0, _jsonpathPlus.JSONPath)({
-      path,
-      json,
-      resultType: 'pointer'
-    });
-    const endPointValues = [];
-    for (const pointer of pointers) {
-      const endPointValue = (0, _apidomJsonPointer.evaluate)(pointer, element);
-      endPointValues.push(endPointValue);
-    }
-    if (Array.isArray(path)) {
-      results.push([_jsonpathPlus.JSONPath.toPathString(path), endPointValues]);
-    } else {
-      results.push([path, endPointValues]);
-    }
-  }
-  return results;
-};
-exports.evaluateMulti = evaluateMulti;
+exports.evaluateMulti = exports.evaluate = exports.MultiEvaluationJsonPathError = exports.EvaluationJsonPathError = void 0;
+var _EvaluationJsonPathError = _interopRequireDefault(require("./errors/EvaluationJsonPathError.cjs"));
+exports.EvaluationJsonPathError = _EvaluationJsonPathError.default;
+var _MultiEvaluationJsonPathError = _interopRequireDefault(require("./errors/MultiEvaluationJsonPathError.cjs"));
+exports.MultiEvaluationJsonPathError = _MultiEvaluationJsonPathError.default;
+var _evaluate = _interopRequireDefault(require("./evaluate.cjs"));
+exports.evaluate = _evaluate.default;
+var _evaluateMulti = _interopRequireDefault(require("./evaluate-multi.cjs"));
+exports.evaluateMulti = _evaluateMulti.default;