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

package/CHANGELOG.md

@@ -3,46 +3,39 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [0.74.1](https://github.com/swagger-api/apidom/compare/v0.74.0...v0.74.1) (2023-07-28)
+# [0.76.0](https://github.com/swagger-api/apidom/compare/v0.75.0...v0.76.0) (2023-09-01)
 
-**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+### 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)
+- **json-pointer:** use error hierarchy and metadata when throwing errors ([#3106](https://github.com/swagger-api/apidom/issues/3106)) ([a17f250](https://github.com/swagger-api/apidom/commit/a17f25052db0d83f1ac3fcea94f2e58b50105df8)), 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
 
+- add support for Relative JSON Pointer ([#3031](https://github.com/swagger-api/apidom/issues/3031)) ([f537584](https://github.com/swagger-api/apidom/commit/f537584adc4559f682e2a5995b2419b043ad71c5)), closes [#3030](https://github.com/swagger-api/apidom/issues/3030)
 
-# [0.74.0](https://github.com/swagger-api/apidom/compare/v0.73.0...v0.74.0) (2023-07-24)
+## [0.74.1](https://github.com/swagger-api/apidom/compare/v0.74.0...v0.74.1) (2023-07-28)
 
 **Note:** Version bump only for package @swagger-api/apidom-json-pointer
 
+# [0.74.0](https://github.com/swagger-api/apidom/compare/v0.73.0...v0.74.0) (2023-07-24)
 
-
-
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
 
 # [0.73.0](https://github.com/swagger-api/apidom/compare/v0.72.0...v0.73.0) (2023-07-18)
 
 **Note:** Version bump only for package @swagger-api/apidom-json-pointer
 
-
-
-
-
 # [0.72.0](https://github.com/swagger-api/apidom/compare/v0.71.1...v0.72.0) (2023-07-17)
 
 **Note:** Version bump only for package @swagger-api/apidom-json-pointer
 
-
-
-
-
 # [0.71.0](https://github.com/swagger-api/apidom/compare/v0.70.4...v0.71.0) (2023-07-13)
 
 **Note:** Version bump only for package @swagger-api/apidom-json-pointer
 
-
-
-
-
 ## [0.70.1](https://github.com/swagger-api/apidom/compare/v0.70.0...v0.70.1) (2023-06-15)
 
 **Note:** Version bump only for package @swagger-api/apidom-json-pointer

package/NOTICE

@@ -38,7 +38,7 @@ Copyright (c) 2012 James Halliday, Josh Duff, and other contributors
 - File packages/apidom-core/src/deepmerge.ts contains algorithms that we originally created
   in https://github.com/TehShrike/deepmerge/blob/master/index.js to handle deep merging of JavaScript Objects and Arrays.
   These algorithms have been reverse engineered and adapted to support deep merging of ApiDOM structures.
-- File packages/apidom-core/test/deepmerge.ts contains tests and fixtures that we originally created
+- File packages/apidom-core/test/deepmerge.ts contains tests and fixtures that were originally created
   in https://github.com/TehShrike/deepmerge/blob/master/test/merge.js to test deep merging of JavaScript Objects and Arrays.
   These tests have been adapted to support testing deep merging of ApiDOM structures.
 - File packages/apidom-core/README.md contains text fragments that were originally created

package/cjs/compile.cjs

@@ -0,0 +1,23 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.default = void 0;
+var _escape = _interopRequireDefault(require("./escape.cjs"));
+var _CompilationJsonPointerError = _interopRequireDefault(require("./errors/CompilationJsonPointerError.cjs"));
+// compile :: String[] -> String
+const compile = tokens => {
+  try {
+    if (tokens.length === 0) {
+      return '';
+    }
+    return `/${tokens.map(_escape.default).join('/')}`;
+  } catch (error) {
+    throw new _CompilationJsonPointerError.default('JSON Pointer compilation of tokens encountered an error.', {
+      tokens,
+      cause: error
+    });
+  }
+};
+var _default = compile;
+exports.default = _default;

package/cjs/errors/CompilationJsonPointerError.cjs

@@ -0,0 +1,16 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.default = void 0;
+var _JsonPointerError = _interopRequireDefault(require("./JsonPointerError.cjs"));
+class CompilationJsonPointerError extends _JsonPointerError.default {
+  constructor(message, structuredOptions) {
+    super(message, structuredOptions);
+    if (typeof structuredOptions !== 'undefined') {
+      this.tokens = [...structuredOptions.tokens];
+    }
+  }
+}
+var _default = CompilationJsonPointerError;
+exports.default = _default;

package/cjs/errors/EvaluationJsonPointerError.cjs

@@ -1,17 +1,26 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
 exports.__esModule = true;
 exports.default = void 0;
-class EvaluationJsonPointerError 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 _JsonPointerError = _interopRequireDefault(require("./JsonPointerError.cjs"));
+class EvaluationJsonPointerError extends _JsonPointerError.default {
+  constructor(message, structuredOptions) {
+    super(message, structuredOptions);
+    if (typeof structuredOptions !== 'undefined') {
+      this.pointer = structuredOptions.pointer;
+      if (Array.isArray(structuredOptions.tokens)) {
+        this.tokens = [...structuredOptions.tokens];
+      }
+      this.failedToken = structuredOptions.failedToken;
+      this.failedTokenPosition = structuredOptions.failedTokenPosition;
+      this.element = structuredOptions.element.element;
+      if ((0, _apidomCore.hasElementSourceMap)(structuredOptions.element)) {
+        this.elementSourceMap = (0, _apidomCore.toValue)(structuredOptions.element.getMetaProperty('sourceMap'));
+      }
     }
   }
 }
-exports.default = EvaluationJsonPointerError;
+var _default = EvaluationJsonPointerError;
+exports.default = _default;

package/cjs/errors/InvalidJsonPointerError.cjs

@@ -1,17 +1,16 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
 exports.__esModule = true;
 exports.default = void 0;
-class InvalidJsonPointerError extends Error {
-  constructor(pointer) {
-    super(`Invalid $ref pointer "${pointer}". Pointers must begin with "/"`);
-    this.name = this.constructor.name;
-    this.message = `Invalid $ref pointer "${pointer}". Pointers must begin with "/"`;
-    if (typeof Error.captureStackTrace === 'function') {
-      Error.captureStackTrace(this, this.constructor);
-    } else {
-      this.stack = new Error(`Invalid $ref pointer "${pointer}". Pointers must begin with "/"`).stack;
+var _JsonPointerError = _interopRequireDefault(require("./JsonPointerError.cjs"));
+class InvalidJsonPointerError extends _JsonPointerError.default {
+  constructor(message, structuredOptions) {
+    super(message, structuredOptions);
+    if (typeof structuredOptions !== 'undefined') {
+      this.pointer = structuredOptions.pointer;
     }
   }
 }
-exports.default = InvalidJsonPointerError;
+var _default = InvalidJsonPointerError;
+exports.default = _default;

package/cjs/errors/JsonPointerError.cjs

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

package/cjs/escape.cjs

@@ -0,0 +1,9 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _ramda = require("ramda");
+// escape :: String -> String
+const escape = (0, _ramda.pipe)((0, _ramda.replace)(/~/g, '~0'), (0, _ramda.replace)(/\//g, '~1'), encodeURIComponent);
+var _default = escape;
+exports.default = _default;

package/cjs/evaluate.cjs

@@ -0,0 +1,60 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.default = void 0;
+var _ramdaAdjunct = require("ramda-adjunct");
+var _apidomCore = require("@swagger-api/apidom-core");
+var _parse = _interopRequireDefault(require("./parse.cjs"));
+var _EvaluationJsonPointerError = _interopRequireDefault(require("./errors/EvaluationJsonPointerError.cjs"));
+// evaluates JSON Pointer against ApiDOM fragment
+const evaluate = (pointer, element) => {
+  let tokens;
+  try {
+    tokens = (0, _parse.default)(pointer);
+  } catch (error) {
+    throw new _EvaluationJsonPointerError.default(`JSON Pointer evaluation failed while parsing the pointer "${pointer}".`, {
+      pointer,
+      element,
+      cause: error
+    });
+  }
+  return tokens.reduce((acc, token, tokenPosition) => {
+    if ((0, _apidomCore.isObjectElement)(acc)) {
+      // @ts-ignore
+      if (!acc.hasKey(token)) {
+        throw new _EvaluationJsonPointerError.default(`JSON Pointer evaluation failed while evaluating token "${token}" against an ObjectElement`, {
+          pointer,
+          tokens,
+          failedToken: token,
+          failedTokenPosition: tokenPosition,
+          element: acc
+        });
+      }
+      // @ts-ignore
+      return acc.get(token);
+    }
+    if ((0, _apidomCore.isArrayElement)(acc)) {
+      if (!(token in acc.content) || !(0, _ramdaAdjunct.isInteger)(Number(token))) {
+        throw new _EvaluationJsonPointerError.default(`JSON Pointer evaluation failed while evaluating token "${token}" against an ArrayElement`, {
+          pointer,
+          tokens,
+          failedToken: token,
+          failedTokenPosition: tokenPosition,
+          element: acc
+        });
+      }
+      // @ts-ignore
+      return acc.get(Number(token));
+    }
+    throw new _EvaluationJsonPointerError.default(`JSON Pointer evaluation failed while evaluating token "${token}" against an unexpected Element`, {
+      pointer,
+      tokens,
+      failedToken: token,
+      failedTokenPosition: tokenPosition,
+      element: acc
+    });
+  }, element);
+};
+var _default = evaluate;
+exports.default = _default;

package/cjs/index.cjs

@@ -1,96 +1,26 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
 exports.__esModule = true;
-exports.uriToPointer = exports.unescape = exports.parse = exports.evaluate = exports.escape = exports.compile = void 0;
-var _ramda = require("ramda");
-var _ramdaAdjunct = require("ramda-adjunct");
-var _apidomCore = require("@swagger-api/apidom-core");
-var _index = require("./errors/index.cjs");
-exports.InvalidJsonPointerError = _index.InvalidJsonPointerError;
-exports.EvaluationJsonPointerError = _index.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
-const escape = (0, _ramda.pipe)((0, _ramda.replace)(/~/g, '~0'), (0, _ramda.replace)(/\//g, '~1'), encodeURIComponent);
-
-// unescape :: String -> String
-exports.escape = escape;
-const unescape = (0, _ramda.pipe)((0, _ramda.replace)(/~1/g, '/'), (0, _ramda.replace)(/~0/g, '~'), safeDecodeURIComponent);
-
-// parse :: String -> String[]
-exports.unescape = unescape;
-const parse = pointer => {
-  if ((0, _ramdaAdjunct.isEmptyString)(pointer)) {
-    return [];
-  }
-  if (!(0, _ramda.startsWith)('/', pointer)) {
-    throw new _index.InvalidJsonPointerError(pointer);
-  }
-  const tokens = (0, _ramda.pipe)((0, _ramda.split)('/'), (0, _ramda.map)(unescape))(pointer);
-  return (0, _ramda.tail)(tokens);
-};
-
-// compile :: String[] -> String
-exports.parse = parse;
-const compile = tokens => {
-  if (tokens.length === 0) {
-    return '';
-  }
-  return `/${tokens.map(escape).join('/')}`;
-};
-
-// evaluates JSON Pointer against ApiDOM fragment
-exports.compile = compile;
-const evaluate = (pointer, element) => {
-  const tokens = parse(pointer);
-  return tokens.reduce((acc, token) => {
-    if ((0, _apidomCore.isObjectElement)(acc)) {
-      // @ts-ignore
-      if (!acc.hasKey(token)) {
-        throw new _index.EvaluationJsonPointerError(`Evaluation failed on token: "${token}"`);
-      }
-      // @ts-ignore
-      return acc.get(token);
-    }
-    if ((0, _apidomCore.isArrayElement)(acc)) {
-      if (!(token in acc.content) || !(0, _ramdaAdjunct.isInteger)(Number(token))) {
-        throw new _index.EvaluationJsonPointerError(`Evaluation failed on token: "${token}"`);
-      }
-      // @ts-ignore
-      return acc.get(Number(token));
-    }
-    throw new _index.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.
- */
-exports.evaluate = evaluate;
-const getHash = uri => {
-  const hashIndex = uri.indexOf('#');
-  if (hashIndex !== -1) {
-    return uri.substring(hashIndex);
-  }
-  return '#';
-};
-
-// uriToPointer :: String -> String
-const uriToPointer = uri => {
-  const hash = getHash(uri);
-  return (0, _ramdaAdjunct.trimCharsStart)('#', hash);
-};
-exports.uriToPointer = uriToPointer;
+exports.uriToPointer = exports.unescape = exports.parse = exports.evaluate = exports.escape = exports.compile = exports.JsonPointerError = exports.InvalidJsonPointerError = exports.EvaluationJsonPointerError = exports.CompilationJsonPointerError = void 0;
+var _JsonPointerError = _interopRequireDefault(require("./errors/JsonPointerError.cjs"));
+exports.JsonPointerError = _JsonPointerError.default;
+var _InvalidJsonPointerError = _interopRequireDefault(require("./errors/InvalidJsonPointerError.cjs"));
+exports.InvalidJsonPointerError = _InvalidJsonPointerError.default;
+var _CompilationJsonPointerError = _interopRequireDefault(require("./errors/CompilationJsonPointerError.cjs"));
+exports.CompilationJsonPointerError = _CompilationJsonPointerError.default;
+var _EvaluationJsonPointerError = _interopRequireDefault(require("./errors/EvaluationJsonPointerError.cjs"));
+exports.EvaluationJsonPointerError = _EvaluationJsonPointerError.default;
+var _escape = _interopRequireDefault(require("./escape.cjs"));
+exports.escape = _escape.default;
+var _unescape = _interopRequireDefault(require("./unescape.cjs"));
+exports.unescape = _unescape.default;
+var _parse = _interopRequireWildcard(require("./parse.cjs"));
+exports.parse = _parse.default;
+exports.uriToPointer = _parse.uriToPointer;
+var _compile = _interopRequireDefault(require("./compile.cjs"));
+exports.compile = _compile.default;
+var _evaluate = _interopRequireDefault(require("./evaluate.cjs"));
+exports.evaluate = _evaluate.default;
+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

@@ -0,0 +1,50 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.uriToPointer = exports.default = void 0;
+var _ramda = require("ramda");
+var _ramdaAdjunct = require("ramda-adjunct");
+var _unescape = _interopRequireDefault(require("./unescape.cjs"));
+var _InvalidJsonPointerError = _interopRequireDefault(require("./errors/InvalidJsonPointerError.cjs"));
+// parse :: String -> String[]
+const parse = pointer => {
+  if ((0, _ramdaAdjunct.isEmptyString)(pointer)) {
+    return [];
+  }
+  if (!(0, _ramda.startsWith)('/', pointer)) {
+    throw new _InvalidJsonPointerError.default(`Invalid JSON Pointer "${pointer}". JSON Pointers must begin with "/"`, {
+      pointer
+    });
+  }
+  try {
+    const tokens = (0, _ramda.pipe)((0, _ramda.split)('/'), (0, _ramda.map)(_unescape.default))(pointer);
+    return (0, _ramda.tail)(tokens);
+  } catch (error) {
+    throw new _InvalidJsonPointerError.default(`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
+const uriToPointer = uri => {
+  const hash = getHash(uri);
+  return (0, _ramdaAdjunct.trimCharsStart)('#', hash);
+};
+exports.uriToPointer = uriToPointer;
+var _default = parse;
+exports.default = _default;

package/cjs/unescape.cjs

@@ -0,0 +1,23 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _ramda = require("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 = (0, _ramda.pipe)((0, _ramda.replace)(/~1/g, '/'), (0, _ramda.replace)(/~0/g, '~'), safeDecodeURIComponent);
+var _default = unescape;
+exports.default = _default;