@swagger-api/apidom-json-path 0.75.0 → 0.76.1

package/es/errors/EvaluationJsonPathError.js

@@ -0,0 +1,19 @@
+import _defineProperty from "@babel/runtime-corejs3/helpers/esm/defineProperty";
+import { hasElementSourceMap, toValue } from '@swagger-api/apidom-core';
+import JsonPathError from "./JsonPathError.js";
+class EvaluationJsonPathError extends JsonPathError {
+  constructor(message, structuredOptions) {
+    super(message, structuredOptions);
+    _defineProperty(this, "path", void 0);
+    _defineProperty(this, "element", void 0);
+    _defineProperty(this, "elementSourceMap", void 0);
+    if (typeof structuredOptions !== 'undefined') {
+      this.path = structuredOptions.path;
+      this.element = structuredOptions.element.element;
+      if (hasElementSourceMap(structuredOptions.element)) {
+        this.elementSourceMap = toValue(structuredOptions.element.getMetaProperty('sourceMap'));
+      }
+    }
+  }
+}
+export default EvaluationJsonPathError;

package/es/errors/JsonPathError.js

@@ -0,0 +1,3 @@
+import { ApiDOMStructuredError } from '@swagger-api/apidom-error';
+class JsonPathError extends ApiDOMStructuredError {}
+export default JsonPathError;

package/es/errors/MultiEvaluationJsonPathError.js

@@ -0,0 +1,19 @@
+import _defineProperty from "@babel/runtime-corejs3/helpers/esm/defineProperty";
+import { hasElementSourceMap, toValue } from '@swagger-api/apidom-core';
+import JsonPathError from "./JsonPathError.js";
+class MultiEvaluationJsonPathError extends JsonPathError {
+  constructor(message, structuredOptions) {
+    super(message, structuredOptions);
+    _defineProperty(this, "paths", void 0);
+    _defineProperty(this, "element", void 0);
+    _defineProperty(this, "elementSourceMap", void 0);
+    if (typeof structuredOptions !== 'undefined') {
+      this.paths = structuredOptions.paths;
+      this.element = structuredOptions.element.element;
+      if (hasElementSourceMap(structuredOptions.element)) {
+        this.elementSourceMap = toValue(structuredOptions.element.getMetaProperty('sourceMap'));
+      }
+    }
+  }
+}
+export default MultiEvaluationJsonPathError;

package/es/evaluate-multi.js

@@ -0,0 +1,38 @@
+import { JSONPath } from 'jsonpath-plus';
+import { toValue } from '@swagger-api/apidom-core';
+import { evaluate as jsonPointerEvaluate } from '@swagger-api/apidom-json-pointer';
+import MultiEvaluationJsonPathError from "./errors/MultiEvaluationJsonPathError.js";
+/**
+ * Evaluates multiple JSONPaths on ApiDOM element.
+ */
+const evaluateMulti = (paths, element) => {
+  try {
+    const json = toValue(element);
+    const results = [];
+    for (const path of paths) {
+      const pointers = JSONPath({
+        path,
+        json,
+        resultType: 'pointer'
+      });
+      const endPointValues = [];
+      for (const pointer of pointers) {
+        const endPointValue = jsonPointerEvaluate(pointer, element);
+        endPointValues.push(endPointValue);
+      }
+      if (Array.isArray(path)) {
+        results.push([JSONPath.toPathString(path), endPointValues]);
+      } else {
+        results.push([path, endPointValues]);
+      }
+    }
+    return results;
+  } catch (error) {
+    throw new MultiEvaluationJsonPathError(`JSON Path evaluation failed while multi-evaluating "${String(paths)}".`, {
+      paths,
+      element,
+      cause: error
+    });
+  }
+};
+export default evaluateMulti;

package/es/evaluate.js

@@ -0,0 +1,25 @@
+import { JSONPath } from 'jsonpath-plus';
+import { toValue } from '@swagger-api/apidom-core';
+import { evaluate as jsonPointerEvaluate } from '@swagger-api/apidom-json-pointer';
+import EvaluationJsonPathError from "./errors/EvaluationJsonPathError.js";
+/**
+ * Evaluates single JSONPath on ApiDOM element.
+ */
+const evaluate = (path, element) => {
+  try {
+    const json = toValue(element);
+    const pointers = JSONPath({
+      path,
+      json,
+      resultType: 'pointer'
+    });
+    return pointers.map(pointer => jsonPointerEvaluate(pointer, element));
+  } catch (error) {
+    throw new EvaluationJsonPathError(`JSON Path evaluation failed while evaluating "${String(path)}".`, {
+      path,
+      element,
+      cause: error
+    });
+  }
+};
+export default evaluate;

package/es/index.js

@@ -1,41 +1,4 @@
-import { JSONPath } from 'jsonpath-plus';
-import { toValue } from '@swagger-api/apidom-core';
-import { evaluate as jsonPointerEvaluate } from '@swagger-api/apidom-json-pointer';
-/**
- * Evaluates single JSONPath on ApiDOM element.
- */
-export const evaluate = (path, element) => {
-  const json = toValue(element);
-  const pointers = JSONPath({
-    path,
-    json,
-    resultType: 'pointer'
-  });
-  return pointers.map(pointer => jsonPointerEvaluate(pointer, element));
-};
-
-/**
- * Evaluates multiple JSONPaths on ApiDOM element.
- */
-export const evaluateMulti = (paths, element) => {
-  const json = toValue(element);
-  const results = [];
-  for (const path of paths) {
-    const pointers = JSONPath({
-      path,
-      json,
-      resultType: 'pointer'
-    });
-    const endPointValues = [];
-    for (const pointer of pointers) {
-      const endPointValue = jsonPointerEvaluate(pointer, element);
-      endPointValues.push(endPointValue);
-    }
-    if (Array.isArray(path)) {
-      results.push([JSONPath.toPathString(path), endPointValues]);
-    } else {
-      results.push([path, endPointValues]);
-    }
-  }
-  return results;
-};
+export { default as EvaluationJsonPathError } from "./errors/EvaluationJsonPathError.js";
+export { default as MultiEvaluationJsonPathError } from "./errors/MultiEvaluationJsonPathError.js";
+export { default as evaluate } from "./evaluate.js";
+export { default as evaluateMulti } from "./evaluate-multi.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swagger-api/apidom-json-path",
-  "version": "0.75.0",
+  "version": "0.76.1",
   "description": "Evaluate JSONPath expressions against ApiDOM.",
   "publishConfig": {
     "access": "public",
@@ -38,8 +38,9 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.20.7",
-    "@swagger-api/apidom-core": "^0.75.0",
-    "@swagger-api/apidom-json-pointer": "^0.75.0",
+    "@swagger-api/apidom-core": "^0.76.1",
+    "@swagger-api/apidom-error": "^0.76.1",
+    "@swagger-api/apidom-json-pointer": "^0.76.1",
     "jsonpath-plus": "^7.2.0"
   },
   "files": [
@@ -52,5 +53,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "1be099d8de39f3fb703cbb5e3f59076e1110fd9b"
+  "gitHead": "33290820a04e212ffb88da36abaa8cc1fb06892f"
 }

package/types/dist.d.ts

@@ -1,21 +1,48 @@
 import { Element } from '@swagger-api/apidom-core';
+import { ApiDOMStructuredError, ApiDOMErrorOptions } from '@swagger-api/apidom-error';
+
+declare class JsonPathError extends ApiDOMStructuredError {
+}
+
+interface EvaluationJsonPathErrorOptions<T extends Element> extends ApiDOMErrorOptions {
+    path: string | string[];
+    element: T;
+}
+declare class EvaluationJsonPathError<T extends Element> extends JsonPathError {
+    readonly path: string | string[];
+    readonly element: string;
+    readonly elementSourceMap?: [[number, number, number], [number, number, number]];
+    constructor(message?: string, structuredOptions?: EvaluationJsonPathErrorOptions<T>);
+}
+
+interface MultiEvaluationJsonPathErrorOptions<T extends Element> extends ApiDOMErrorOptions {
+    paths: string[] | string[][];
+    element: T;
+}
+declare class MultiEvaluationJsonPathError<T extends Element> extends JsonPathError {
+    readonly paths: string[] | string[][];
+    readonly element: string;
+    readonly elementSourceMap?: [[number, number, number], [number, number, number]];
+    constructor(message?: string, structuredOptions?: MultiEvaluationJsonPathErrorOptions<T>);
+}
 
 type Evaluate = {
     <T extends Element>(path: string, element: T): Element[];
     <T extends Element>(path: string[], element: T): Element[];
 };
+/**
+ * Evaluates single JSONPath on ApiDOM element.
+ */
+declare const evaluate: Evaluate;
+
 type JSONPathEvalTuple = [string, Element[]];
 type EvaluateMulti = {
     <T extends Element>(paths: string[], element: T): JSONPathEvalTuple[];
     <T extends Element>(paths: string[][], element: T): JSONPathEvalTuple[];
 };
-/**
- * Evaluates single JSONPath on ApiDOM element.
- */
-declare const evaluate: Evaluate;
 /**
  * Evaluates multiple JSONPaths on ApiDOM element.
  */
 declare const evaluateMulti: EvaluateMulti;
 
-export { evaluate, evaluateMulti };
+export { EvaluationJsonPathError, EvaluationJsonPathErrorOptions, MultiEvaluationJsonPathError, MultiEvaluationJsonPathErrorOptions, evaluate, evaluateMulti };