@swagger-api/apidom-json-pointer 1.0.0-beta.1 → 1.0.0-beta.3

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.0.0-beta.3](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.2...v1.0.0-beta.3) (2024-11-25)
+
+**Note:** Version bump only for package @swagger-api/apidom-json-pointer
+
+# [1.0.0-beta.2](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.1...v1.0.0-beta.2) (2024-11-22)
+
+### Bug Fixes
+
+- **json-pointer:** fix non existing package entry point ([#4549](https://github.com/swagger-api/apidom/issues/4549)) ([764a1c5](https://github.com/swagger-api/apidom/commit/764a1c5bdf7c5300b878b5eadccab00faef84d1a)), closes [#4539](https://github.com/swagger-api/apidom/issues/4539)
+
 # [1.0.0-beta.1](https://github.com/swagger-api/apidom/compare/v1.0.0-beta.0...v1.0.0-beta.1) (2024-11-22)
 
 **Note:** Version bump only for package @swagger-api/apidom-json-pointer

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swagger-api/apidom-json-pointer",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.3",
   "description": "Evaluate JSON Pointer expressions against ApiDOM.",
   "publishConfig": {
     "access": "public",
@@ -38,21 +38,21 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.20.7",
-    "@swagger-api/apidom-core": "^1.0.0-beta.1",
-    "@swagger-api/apidom-error": "^1.0.0-beta.1",
+    "@swagger-api/apidom-core": "^1.0.0-beta.3",
+    "@swagger-api/apidom-error": "^1.0.0-beta.3",
     "@types/ramda": "~0.30.0",
     "ramda": "~0.30.0",
     "ramda-adjunct": "^5.0.0"
   },
   "files": [
-    "cjs/",
+    "src/**/*.mjs",
+    "src/**/*.cjs",
     "dist/",
-    "es/",
     "types/apidom-json-pointer.d.ts",
     "LICENSES",
     "NOTICE",
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "605eed17c44883c182280c2297c9f6e46d639eec"
+  "gitHead": "a0cf66f3e4520986db154bd2b97001715a8a3287"
 }

package/src/compile.cjs

@@ -0,0 +1,24 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _escape = _interopRequireDefault(require("./escape.cjs"));
+var _CompilationJsonPointerError = _interopRequireDefault(require("./errors/CompilationJsonPointerError.cjs"));
+/**
+ * @public
+ */
+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 = exports.default = compile;

package/src/compile.mjs

@@ -0,0 +1,19 @@
+import escape from "./escape.mjs";
+import CompilationJsonPointerError from "./errors/CompilationJsonPointerError.mjs";
+/**
+ * @public
+ */
+const compile = tokens => {
+  try {
+    if (tokens.length === 0) {
+      return '';
+    }
+    return `/${tokens.map(escape).join('/')}`;
+  } catch (error) {
+    throw new CompilationJsonPointerError('JSON Pointer compilation of tokens encountered an error.', {
+      tokens,
+      cause: error
+    });
+  }
+};
+export default compile;

package/src/errors/CompilationJsonPointerError.cjs

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

package/src/errors/CompilationJsonPointerError.mjs

@@ -0,0 +1,17 @@
+import JsonPointerError from "./JsonPointerError.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class CompilationJsonPointerError extends JsonPointerError {
+  tokens;
+  constructor(message, structuredOptions) {
+    super(message, structuredOptions);
+    if (typeof structuredOptions !== 'undefined') {
+      this.tokens = [...structuredOptions.tokens];
+    }
+  }
+}
+export default CompilationJsonPointerError;

package/src/errors/EvaluationJsonPointerError.cjs

@@ -0,0 +1,33 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _JsonPointerError = _interopRequireDefault(require("./JsonPointerError.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class EvaluationJsonPointerError extends _JsonPointerError.default {
+  pointer;
+  tokens;
+  failedToken;
+  failedTokenPosition;
+  element;
+  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;
+    }
+  }
+}
+var _default = exports.default = EvaluationJsonPointerError;

package/src/errors/EvaluationJsonPointerError.mjs

@@ -0,0 +1,27 @@
+import JsonPointerError from "./JsonPointerError.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class EvaluationJsonPointerError extends JsonPointerError {
+  pointer;
+  tokens;
+  failedToken;
+  failedTokenPosition;
+  element;
+  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;
+    }
+  }
+}
+export default EvaluationJsonPointerError;

package/src/errors/InvalidJsonPointerError.cjs

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

package/src/errors/InvalidJsonPointerError.mjs

@@ -0,0 +1,17 @@
+import JsonPointerError from "./JsonPointerError.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+class InvalidJsonPointerError extends JsonPointerError {
+  pointer;
+  constructor(message, structuredOptions) {
+    super(message, structuredOptions);
+    if (typeof structuredOptions !== 'undefined') {
+      this.pointer = structuredOptions.pointer;
+    }
+  }
+}
+export default InvalidJsonPointerError;

package/src/errors/JsonPointerError.cjs

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

package/src/errors/JsonPointerError.mjs

@@ -0,0 +1,7 @@
+import { ApiDOMStructuredError } from '@swagger-api/apidom-error';
+
+/**
+ * @public
+ */
+class JsonPointerError extends ApiDOMStructuredError {}
+export default JsonPointerError;

package/src/escape.cjs

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

package/src/escape.mjs

@@ -0,0 +1,7 @@
+import { pipe, replace } from 'ramda';
+
+/**
+ * @public
+ */
+const escape = pipe(replace(/~/g, '~0'), replace(/\//g, '~1'), encodeURIComponent);
+export default escape;

package/src/evaluate.cjs

@@ -0,0 +1,62 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+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.
+ * @public
+ */
+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: (0, _apidomCore.cloneDeep)(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: (0, _apidomCore.cloneDeep)(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: (0, _apidomCore.cloneDeep)(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: (0, _apidomCore.cloneDeep)(acc)
+    });
+  }, element);
+};
+var _default = exports.default = evaluate;

package/src/evaluate.mjs

@@ -0,0 +1,57 @@
+import { isInteger } from 'ramda-adjunct';
+import { isObjectElement, isArrayElement, cloneDeep } from '@swagger-api/apidom-core';
+import parse from "./parse.mjs";
+import EvaluationJsonPointerError from "./errors/EvaluationJsonPointerError.mjs";
+/**
+ * Evaluates JSON Pointer against ApiDOM fragment.
+ * @public
+ */
+const evaluate = (pointer, element) => {
+  let tokens;
+  try {
+    tokens = parse(pointer);
+  } catch (error) {
+    throw new EvaluationJsonPointerError(`JSON Pointer evaluation failed while parsing the pointer "${pointer}".`, {
+      pointer,
+      element: cloneDeep(element),
+      cause: error
+    });
+  }
+  return tokens.reduce((acc, token, tokenPosition) => {
+    if (isObjectElement(acc)) {
+      // @ts-ignore
+      if (!acc.hasKey(token)) {
+        throw new EvaluationJsonPointerError(`JSON Pointer evaluation failed while evaluating token "${token}" against an ObjectElement`, {
+          pointer,
+          tokens,
+          failedToken: token,
+          failedTokenPosition: tokenPosition,
+          element: cloneDeep(acc)
+        });
+      }
+      // @ts-ignore
+      return acc.get(token);
+    }
+    if (isArrayElement(acc)) {
+      if (!(token in acc.content) || !isInteger(Number(token))) {
+        throw new EvaluationJsonPointerError(`JSON Pointer evaluation failed while evaluating token "${token}" against an ArrayElement`, {
+          pointer,
+          tokens,
+          failedToken: token,
+          failedTokenPosition: tokenPosition,
+          element: cloneDeep(acc)
+        });
+      }
+      // @ts-ignore
+      return acc.get(Number(token));
+    }
+    throw new EvaluationJsonPointerError(`JSON Pointer evaluation failed while evaluating token "${token}" against an unexpected Element`, {
+      pointer,
+      tokens,
+      failedToken: token,
+      failedTokenPosition: tokenPosition,
+      element: cloneDeep(acc)
+    });
+  }, element);
+};
+export default evaluate;

package/src/index.cjs

@@ -0,0 +1,25 @@
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+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;

package/src/index.mjs

@@ -0,0 +1,9 @@
+export { default as JsonPointerError } from "./errors/JsonPointerError.mjs";
+export { default as InvalidJsonPointerError } from "./errors/InvalidJsonPointerError.mjs";
+export { default as CompilationJsonPointerError } from "./errors/CompilationJsonPointerError.mjs";
+export { default as EvaluationJsonPointerError } from "./errors/EvaluationJsonPointerError.mjs";
+export { default as escape } from "./escape.mjs";
+export { default as unescape } from "./unescape.mjs";
+export { default as parse, uriToPointer } from "./parse.mjs";
+export { default as compile } from "./compile.mjs";
+export { default as evaluate } from "./evaluate.mjs";

package/src/parse.cjs

@@ -0,0 +1,53 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+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"));
+/**
+ * @public
+ */
+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 '#';
+};
+
+/**
+ * @public
+ */
+const uriToPointer = uri => {
+  const hash = getHash(uri);
+  return (0, _ramdaAdjunct.trimCharsStart)('#', hash);
+};
+exports.uriToPointer = uriToPointer;
+var _default = exports.default = parse;

package/src/parse.mjs

@@ -0,0 +1,47 @@
+import { map, pipe, split, startsWith, tail } from 'ramda';
+import { isEmptyString, trimCharsStart } from 'ramda-adjunct';
+import unescape from "./unescape.mjs";
+import InvalidJsonPointerError from "./errors/InvalidJsonPointerError.mjs";
+/**
+ * @public
+ */
+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 '#';
+};
+
+/**
+ * @public
+ */
+export const uriToPointer = uri => {
+  const hash = getHash(uri);
+  return trimCharsStart('#', hash);
+};
+export default parse;

package/src/unescape.cjs

@@ -0,0 +1,24 @@
+"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;
+  }
+};
+
+/**
+ * @public
+ */
+const unescape = (0, _ramda.pipe)((0, _ramda.replace)(/~1/g, '/'), (0, _ramda.replace)(/~0/g, '~'), safeDecodeURIComponent);
+var _default = exports.default = unescape;

package/src/unescape.mjs

@@ -0,0 +1,21 @@
+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;
+  }
+};
+
+/**
+ * @public
+ */
+const unescape = pipe(replace(/~1/g, '/'), replace(/~0/g, '~'), safeDecodeURIComponent);
+export default unescape;