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

package/es/index.js

@@ -1,86 +1,9 @@
-import { split, replace, tail, startsWith, map, pipe } from 'ramda';
-import { isEmptyString, isInteger, trimCharsStart } from 'ramda-adjunct';
-import { isObjectElement, isArrayElement } from '@swagger-api/apidom-core';
-import { InvalidJsonPointerError, EvaluationJsonPointerError } from "./errors/index.js";
-export { InvalidJsonPointerError, EvaluationJsonPointerError };
-
-/**
- * decodeURIComponent can throw URIError in certain cases like 'c%d'.
- * safeDecodeURIComponent is a safe variant of decodeURIComponent that never trows.
- *
- * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Errors/Malformed_URI|More info about URIError}
- */
-const safeDecodeURIComponent = encodedURIComponent => {
-  try {
-    return decodeURIComponent(encodedURIComponent);
-  } catch {
-    return encodedURIComponent;
-  }
-};
-
-// escape :: String -> String
-export const escape = pipe(replace(/~/g, '~0'), replace(/\//g, '~1'), encodeURIComponent);
-
-// unescape :: String -> String
-export const unescape = pipe(replace(/~1/g, '/'), replace(/~0/g, '~'), safeDecodeURIComponent);
-
-// parse :: String -> String[]
-export const parse = pointer => {
-  if (isEmptyString(pointer)) {
-    return [];
-  }
-  if (!startsWith('/', pointer)) {
-    throw new InvalidJsonPointerError(pointer);
-  }
-  const tokens = pipe(split('/'), map(unescape))(pointer);
-  return tail(tokens);
-};
-
-// compile :: String[] -> String
-export const compile = tokens => {
-  if (tokens.length === 0) {
-    return '';
-  }
-  return `/${tokens.map(escape).join('/')}`;
-};
-
-// evaluates JSON Pointer against ApiDOM fragment
-export const evaluate = (pointer, element) => {
-  const tokens = parse(pointer);
-  return tokens.reduce((acc, token) => {
-    if (isObjectElement(acc)) {
-      // @ts-ignore
-      if (!acc.hasKey(token)) {
-        throw new EvaluationJsonPointerError(`Evaluation failed on token: "${token}"`);
-      }
-      // @ts-ignore
-      return acc.get(token);
-    }
-    if (isArrayElement(acc)) {
-      if (!(token in acc.content) || !isInteger(Number(token))) {
-        throw new EvaluationJsonPointerError(`Evaluation failed on token: "${token}"`);
-      }
-      // @ts-ignore
-      return acc.get(Number(token));
-    }
-    throw new EvaluationJsonPointerError(`Evaluation failed on token: "${token}"`);
-  }, element);
-};
-
-/**
- * Returns the hash (URL fragment), of the given path.
- * If there is no hash, then the root hash ("#") is returned.
- */
-const getHash = uri => {
-  const hashIndex = uri.indexOf('#');
-  if (hashIndex !== -1) {
-    return uri.substring(hashIndex);
-  }
-  return '#';
-};
-
-// uriToPointer :: String -> String
-export const uriToPointer = uri => {
-  const hash = getHash(uri);
-  return trimCharsStart('#', hash);
-};
+export { default as JsonPointerError } from "./errors/JsonPointerError.js";
+export { default as InvalidJsonPointerError } from "./errors/InvalidJsonPointerError.js";
+export { default as CompilationJsonPointerError } from "./errors/CompilationJsonPointerError.js";
+export { default as EvaluationJsonPointerError } from "./errors/EvaluationJsonPointerError.js";
+export { default as escape } from "./escape.js";
+export { default as unescape } from "./unescape.js";
+export { default as parse, uriToPointer } from "./parse.js";
+export { default as compile } from "./compile.js";
+export { default as evaluate } from "./evaluate.js";

package/es/parse.js

@@ -0,0 +1,42 @@
+import { map, pipe, split, startsWith, tail } from 'ramda';
+import { isEmptyString, trimCharsStart } from 'ramda-adjunct';
+import unescape from "./unescape.js";
+import InvalidJsonPointerError from "./errors/InvalidJsonPointerError.js"; // parse :: String -> String[]
+const parse = pointer => {
+  if (isEmptyString(pointer)) {
+    return [];
+  }
+  if (!startsWith('/', pointer)) {
+    throw new InvalidJsonPointerError(`Invalid JSON Pointer "${pointer}". JSON Pointers must begin with "/"`, {
+      pointer
+    });
+  }
+  try {
+    const tokens = pipe(split('/'), map(unescape))(pointer);
+    return tail(tokens);
+  } catch (error) {
+    throw new InvalidJsonPointerError(`JSON Pointer parsing of "${pointer}" encountered an error.`, {
+      pointer,
+      cause: error
+    });
+  }
+};
+
+/**
+ * Returns the hash (URL fragment), of the given path.
+ * If there is no hash, then the root hash ("#") is returned.
+ */
+const getHash = uri => {
+  const hashIndex = uri.indexOf('#');
+  if (hashIndex !== -1) {
+    return uri.substring(hashIndex);
+  }
+  return '#';
+};
+
+// uriToPointer :: String -> String
+export const uriToPointer = uri => {
+  const hash = getHash(uri);
+  return trimCharsStart('#', hash);
+};
+export default parse;

package/es/unescape.js

@@ -0,0 +1,19 @@
+import { pipe, replace } from 'ramda';
+
+/**
+ * decodeURIComponent can throw URIError in certain cases like 'c%d'.
+ * safeDecodeURIComponent is a safe variant of decodeURIComponent that never trows.
+ *
+ * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Errors/Malformed_URI|More info about URIError}
+ */
+const safeDecodeURIComponent = encodedURIComponent => {
+  try {
+    return decodeURIComponent(encodedURIComponent);
+  } catch {
+    return encodedURIComponent;
+  }
+};
+
+// unescape :: String -> String
+const unescape = pipe(replace(/~1/g, '/'), replace(/~0/g, '~'), safeDecodeURIComponent);
+export default unescape;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swagger-api/apidom-json-pointer",
-  "version": "0.75.0",
+  "version": "0.76.0",
   "description": "Evaluate JSON Pointer expressions against ApiDOM.",
   "publishConfig": {
     "access": "public",
@@ -38,7 +38,8 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.20.7",
-    "@swagger-api/apidom-core": "^0.75.0",
+    "@swagger-api/apidom-core": "^0.76.0",
+    "@swagger-api/apidom-error": "^0.76.0",
     "@types/ramda": "~0.29.3",
     "ramda": "~0.29.0",
     "ramda-adjunct": "^4.0.0"
@@ -53,5 +54,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "1be099d8de39f3fb703cbb5e3f59076e1110fd9b"
+  "gitHead": "ce497d1083df34162b9cf2047d6cbd8843af3314"
 }

package/types/dist.d.ts

@@ -1,17 +1,51 @@
+import { ApiDOMStructuredError, ApiDOMErrorOptions } from '@swagger-api/apidom-error';
 import { Element } from '@swagger-api/apidom-core';
 
-declare class EvaluationJsonPointerError extends Error {
+declare class JsonPointerError extends ApiDOMStructuredError {
 }
 
-declare class InvalidJsonPointerError extends Error {
-    constructor(pointer: string);
+interface InvalidJsonPointerErrorOptions extends ApiDOMErrorOptions {
+    readonly pointer: string;
+}
+declare class InvalidJsonPointerError extends JsonPointerError {
+    readonly pointer: string;
+    constructor(message?: string, structuredOptions?: InvalidJsonPointerErrorOptions);
+}
+
+interface CompilationJsonPointerErrorOptions extends ApiDOMErrorOptions {
+    readonly tokens: string[];
+}
+declare class CompilationJsonPointerError extends JsonPointerError {
+    readonly tokens: string[];
+    constructor(message?: string, structuredOptions?: CompilationJsonPointerErrorOptions);
+}
+
+interface EvaluationJsonPointerErrorOptions<T extends Element> extends ApiDOMErrorOptions {
+    readonly pointer: string;
+    readonly tokens?: string[];
+    readonly failedToken?: string;
+    readonly failedTokenPosition?: number;
+    readonly element: T;
+}
+declare class EvaluationJsonPointerError<T extends Element> extends JsonPointerError {
+    readonly pointer: string;
+    readonly tokens?: string[];
+    readonly failedToken?: string;
+    readonly failedTokenPosition?: number;
+    readonly element: string;
+    readonly elementSourceMap?: [[number, number, number], [number, number, number]];
+    constructor(message?: string, structuredOptions?: EvaluationJsonPointerErrorOptions<T>);
 }
 
 declare const escape: (str: string) => string;
+
 declare const unescape: (str: string) => string;
+
 declare const parse: (pointer: string) => string[];
+declare const uriToPointer: (uri: string) => string;
+
 declare const compile: (tokens: string[]) => string;
+
 declare const evaluate: <T extends Element>(pointer: string, element: T) => Element;
-declare const uriToPointer: (uri: string) => string;
 
-export { EvaluationJsonPointerError, InvalidJsonPointerError, compile, escape, evaluate, parse, unescape, uriToPointer };
+export { CompilationJsonPointerError, CompilationJsonPointerErrorOptions, EvaluationJsonPointerError, EvaluationJsonPointerErrorOptions, InvalidJsonPointerError, InvalidJsonPointerErrorOptions, JsonPointerError, compile, escape, evaluate, parse, unescape, uriToPointer };

package/cjs/errors/index.cjs

@@ -1,9 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
-exports.__esModule = true;
-exports.InvalidJsonPointerError = exports.EvaluationJsonPointerError = void 0;
-var _EvaluationJsonPointerError = _interopRequireDefault(require("./EvaluationJsonPointerError.cjs"));
-exports.EvaluationJsonPointerError = _EvaluationJsonPointerError.default;
-var _InvalidJsonPointerError = _interopRequireDefault(require("./InvalidJsonPointerError.cjs"));
-exports.InvalidJsonPointerError = _InvalidJsonPointerError.default;

package/es/errors/index.js

@@ -1,2 +0,0 @@
-export { default as EvaluationJsonPointerError } from "./EvaluationJsonPointerError.js";
-export { default as InvalidJsonPointerError } from "./InvalidJsonPointerError.js";