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

package/types/apidom-json-pointer.d.ts

@@ -0,0 +1,97 @@
+import { ApiDOMErrorOptions } from '@swagger-api/apidom-error';
+import { ApiDOMStructuredError } from '@swagger-api/apidom-error';
+import { Element as Element_2 } from '@swagger-api/apidom-core';
+
+/**
+ * @public
+ */
+export declare class CompilationJsonPointerError extends JsonPointerError {
+    readonly tokens: string[];
+    constructor(message?: string, structuredOptions?: CompilationJsonPointerErrorOptions);
+}
+
+/**
+ * @public
+ */
+export declare interface CompilationJsonPointerErrorOptions extends ApiDOMErrorOptions {
+    readonly tokens: string[];
+}
+
+/**
+ * @public
+ */
+export declare const compile: (tokens: string[]) => string;
+
+/**
+ * @public
+ */
+declare const escape_2: (str: string) => string;
+export { escape_2 as escape }
+
+/**
+ * Evaluates JSON Pointer against ApiDOM fragment.
+ * @public
+ */
+export declare const evaluate: <T extends Element_2>(pointer: string, element: T) => Element_2;
+
+/**
+ * @public
+ */
+export declare class EvaluationJsonPointerError<T extends Element_2> extends JsonPointerError {
+    readonly pointer: string;
+    readonly tokens?: string[];
+    readonly failedToken?: string;
+    readonly failedTokenPosition?: number;
+    readonly element: T;
+    constructor(message?: string, structuredOptions?: EvaluationJsonPointerErrorOptions<T>);
+}
+
+/**
+ * @public
+ */
+export declare interface EvaluationJsonPointerErrorOptions<T extends Element_2> extends ApiDOMErrorOptions {
+    readonly pointer: string;
+    readonly tokens?: string[];
+    readonly failedToken?: string;
+    readonly failedTokenPosition?: number;
+    readonly element: T;
+}
+
+/**
+ * @public
+ */
+export declare class InvalidJsonPointerError extends JsonPointerError {
+    readonly pointer: string;
+    constructor(message?: string, structuredOptions?: InvalidJsonPointerErrorOptions);
+}
+
+/**
+ * @public
+ */
+export declare interface InvalidJsonPointerErrorOptions extends ApiDOMErrorOptions {
+    readonly pointer: string;
+}
+
+/**
+ * @public
+ */
+export declare class JsonPointerError extends ApiDOMStructuredError {
+}
+
+/**
+ * @public
+ */
+export declare const parse: (pointer: string) => string[];
+
+/**
+ * @public
+ */
+declare const unescape_2: (str: string) => string;
+export { unescape_2 as unescape }
+
+/**
+ * @public
+ */
+export declare const uriToPointer: (uri: string) => string;
+
+export { }

package/cjs/compile.cjs

@@ -1,22 +0,0 @@
-"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"));
-// 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 = exports.default = compile;

package/cjs/errors/CompilationJsonPointerError.cjs

@@ -1,16 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _JsonPointerError = _interopRequireDefault(require("./JsonPointerError.cjs"));
-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/cjs/errors/EvaluationJsonPointerError.cjs

@@ -1,26 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _JsonPointerError = _interopRequireDefault(require("./JsonPointerError.cjs"));
-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/cjs/errors/InvalidJsonPointerError.cjs

@@ -1,16 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _JsonPointerError = _interopRequireDefault(require("./JsonPointerError.cjs"));
-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/cjs/errors/JsonPointerError.cjs

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

package/cjs/escape.cjs

@@ -1,8 +0,0 @@
-"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 = exports.default = escape;

package/cjs/evaluate.cjs

@@ -1,59 +0,0 @@
-"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
-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/cjs/index.cjs

@@ -1,25 +0,0 @@
-"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/cjs/parse.cjs

@@ -1,49 +0,0 @@
-"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"));
-// 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 = exports.default = parse;

package/cjs/unescape.cjs

@@ -1,22 +0,0 @@
-"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 = exports.default = unescape;

package/es/compile.mjs

@@ -1,16 +0,0 @@
-import escape from "./escape.mjs";
-import CompilationJsonPointerError from "./errors/CompilationJsonPointerError.mjs"; // compile :: String[] -> String
-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/es/errors/CompilationJsonPointerError.mjs

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

package/es/errors/EvaluationJsonPointerError.mjs

@@ -1,21 +0,0 @@
-import JsonPointerError from "./JsonPointerError.mjs";
-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/es/errors/InvalidJsonPointerError.mjs

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

package/es/errors/JsonPointerError.mjs

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

package/es/escape.mjs

@@ -1,5 +0,0 @@
-import { pipe, replace } from 'ramda';
-
-// escape :: String -> String
-const escape = pipe(replace(/~/g, '~0'), replace(/\//g, '~1'), encodeURIComponent);
-export default escape;

package/es/evaluate.mjs

@@ -1,53 +0,0 @@
-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
-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/es/index.mjs

@@ -1,9 +0,0 @@
-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/es/parse.mjs

@@ -1,42 +0,0 @@
-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"; // 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.mjs

@@ -1,19 +0,0 @@
-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/types/dist.d.ts

@@ -1,50 +0,0 @@
-import { ApiDOMStructuredError, ApiDOMErrorOptions } from '@swagger-api/apidom-error';
-import { Element } from '@swagger-api/apidom-core';
-
-declare class JsonPointerError extends ApiDOMStructuredError {
-}
-
-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: T;
-    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;
-
-export { CompilationJsonPointerError, type CompilationJsonPointerErrorOptions, EvaluationJsonPointerError, type EvaluationJsonPointerErrorOptions, InvalidJsonPointerError, type InvalidJsonPointerErrorOptions, JsonPointerError, compile, escape, evaluate, parse, unescape, uriToPointer };