@swagger-api/apidom-json-pointer 1.0.0-beta.33 → 1.0.0-beta.35

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +37 -6
  3. package/dist/apidom-json-pointer.browser.js +140 -3783
  4. package/dist/apidom-json-pointer.browser.min.js +1 -1
  5. package/package.json +22 -10
  6. package/src/index.cjs +26 -22
  7. package/src/index.mjs +36 -9
  8. package/src/{compile.cjs → legacy/compile.cjs} +1 -0
  9. package/src/{compile.mjs → legacy/compile.mjs} +1 -0
  10. package/src/{errors → legacy/errors}/CompilationJsonPointerError.cjs +2 -0
  11. package/src/{errors → legacy/errors}/CompilationJsonPointerError.mjs +2 -0
  12. package/src/{errors → legacy/errors}/EvaluationJsonPointerError.cjs +2 -0
  13. package/src/{errors → legacy/errors}/EvaluationJsonPointerError.mjs +2 -0
  14. package/src/{errors → legacy/errors}/InvalidJsonPointerError.cjs +2 -0
  15. package/src/{errors → legacy/errors}/InvalidJsonPointerError.mjs +2 -0
  16. package/src/{errors → legacy/errors}/JsonPointerError.cjs +1 -0
  17. package/src/{errors → legacy/errors}/JsonPointerError.mjs +1 -0
  18. package/src/{escape.cjs → legacy/escape.cjs} +1 -0
  19. package/src/{escape.mjs → legacy/escape.mjs} +1 -0
  20. package/src/{evaluate.cjs → legacy/evaluate.cjs} +1 -0
  21. package/src/{evaluate.mjs → legacy/evaluate.mjs} +1 -0
  22. package/src/legacy/index.cjs +25 -0
  23. package/src/legacy/index.mjs +9 -0
  24. package/src/{parse.cjs → legacy/parse.cjs} +2 -0
  25. package/src/{parse.mjs → legacy/parse.mjs} +2 -0
  26. package/src/{unescape.cjs → legacy/unescape.cjs} +1 -0
  27. package/src/{unescape.mjs → legacy/unescape.mjs} +1 -0
  28. package/types/apidom-json-pointer.d.ts +68 -92
package/src/index.mjs CHANGED
@@ -1,9 +1,36 @@
1
- export { default as JsonPointerError } from "./errors/JsonPointerError.mjs";
2
- export { default as InvalidJsonPointerError } from "./errors/InvalidJsonPointerError.mjs";
3
- export { default as CompilationJsonPointerError } from "./errors/CompilationJsonPointerError.mjs";
4
- export { default as EvaluationJsonPointerError } from "./errors/EvaluationJsonPointerError.mjs";
5
- export { default as parse, uriToPointer } from "./parse.mjs";
6
- export { default as evaluate } from "./evaluate.mjs";
7
- export { default as escape } from "./escape.mjs";
8
- export { default as unescape } from "./unescape.mjs";
9
- export { default as compile } from "./compile.mjs";
1
+ export {
2
+ /**
3
+ * Representation
4
+ */
5
+ JSONString, URIFragmentIdentifier,
6
+ /**
7
+ * Parsing
8
+ */
9
+ parse, CSTTranslator, ASTTranslator, XMLTranslator,
10
+ /**
11
+ * Testing
12
+ */
13
+ testJSONPointer, testReferenceToken, testArrayLocation, testArrayIndex, testArrayDash,
14
+ /**
15
+ * Compiling
16
+ */
17
+ compile,
18
+ /**
19
+ * Escaping
20
+ */
21
+ escape, unescape,
22
+ /**
23
+ * Grammar
24
+ */
25
+ Grammar,
26
+ /**
27
+ * Errors
28
+ */
29
+ JSONPointerError, JSONPointerParseError, JSONPointerCompileError, JSONPointerEvaluateError, JSONPointerTypeError, JSONPointerKeyError, JSONPointerIndexError } from '@swaggerexpert/json-pointer';
30
+ /**
31
+ * Contextual Evaluation for ApiDOM
32
+ */
33
+ export { evaluate } from '@swaggerexpert/json-pointer/evaluate/realms/apidom';
34
+ /**
35
+ * Re-export all types
36
+ */
@@ -7,6 +7,7 @@ var _jsonPointer = require("@swaggerexpert/json-pointer");
7
7
  var _CompilationJsonPointerError = _interopRequireDefault(require("./errors/CompilationJsonPointerError.cjs"));
8
8
  /**
9
9
  * @public
10
+ * @deprecated
10
11
  */
11
12
  const compile = tokens => {
12
13
  try {
@@ -2,6 +2,7 @@ import { compile as baseCompile, URIFragmentIdentifier, JSONPointerCompileError
2
2
  import CompilationJsonPointerError from "./errors/CompilationJsonPointerError.mjs";
3
3
  /**
4
4
  * @public
5
+ * @deprecated
5
6
  */
6
7
  const compile = tokens => {
7
8
  try {
@@ -6,10 +6,12 @@ exports.default = void 0;
6
6
  var _JsonPointerError = _interopRequireDefault(require("./JsonPointerError.cjs"));
7
7
  /**
8
8
  * @public
9
+ * @deprecated
9
10
  */
10
11
 
11
12
  /**
12
13
  * @public
14
+ * @deprecated
13
15
  */
14
16
  class CompilationJsonPointerError extends _JsonPointerError.default {
15
17
  tokens;
@@ -1,9 +1,11 @@
1
1
  import JsonPointerError from "./JsonPointerError.mjs";
2
2
  /**
3
3
  * @public
4
+ * @deprecated
4
5
  */
5
6
  /**
6
7
  * @public
8
+ * @deprecated
7
9
  */
8
10
  class CompilationJsonPointerError extends JsonPointerError {
9
11
  tokens;
@@ -6,10 +6,12 @@ exports.default = void 0;
6
6
  var _JsonPointerError = _interopRequireDefault(require("./JsonPointerError.cjs"));
7
7
  /**
8
8
  * @public
9
+ * @deprecated
9
10
  */
10
11
 
11
12
  /**
12
13
  * @public
14
+ * @deprecated
13
15
  */
14
16
  class EvaluationJsonPointerError extends _JsonPointerError.default {
15
17
  pointer;
@@ -1,9 +1,11 @@
1
1
  import JsonPointerError from "./JsonPointerError.mjs";
2
2
  /**
3
3
  * @public
4
+ * @deprecated
4
5
  */
5
6
  /**
6
7
  * @public
8
+ * @deprecated
7
9
  */
8
10
  class EvaluationJsonPointerError extends JsonPointerError {
9
11
  pointer;
@@ -6,10 +6,12 @@ exports.default = void 0;
6
6
  var _JsonPointerError = _interopRequireDefault(require("./JsonPointerError.cjs"));
7
7
  /**
8
8
  * @public
9
+ * @deprecated
9
10
  */
10
11
 
11
12
  /**
12
13
  * @public
14
+ * @deprecated
13
15
  */
14
16
  class InvalidJsonPointerError extends _JsonPointerError.default {
15
17
  pointer;
@@ -1,9 +1,11 @@
1
1
  import JsonPointerError from "./JsonPointerError.mjs";
2
2
  /**
3
3
  * @public
4
+ * @deprecated
4
5
  */
5
6
  /**
6
7
  * @public
8
+ * @deprecated
7
9
  */
8
10
  class InvalidJsonPointerError extends JsonPointerError {
9
11
  pointer;
@@ -5,6 +5,7 @@ exports.default = void 0;
5
5
  var _apidomError = require("@swagger-api/apidom-error");
6
6
  /**
7
7
  * @public
8
+ * @deprecated
8
9
  */
9
10
  class JsonPointerError extends _apidomError.ApiDOMStructuredError {}
10
11
  var _default = exports.default = JsonPointerError;
@@ -2,6 +2,7 @@ import { ApiDOMStructuredError } from '@swagger-api/apidom-error';
2
2
 
3
3
  /**
4
4
  * @public
5
+ * @deprecated
5
6
  */
6
7
  class JsonPointerError extends ApiDOMStructuredError {}
7
8
  export default JsonPointerError;
@@ -5,6 +5,7 @@ exports.default = void 0;
5
5
  var _jsonPointer = require("@swaggerexpert/json-pointer");
6
6
  /**
7
7
  * @public
8
+ * @deprecated
8
9
  */
9
10
  const escape = referenceToken => {
10
11
  return _jsonPointer.URIFragmentIdentifier.to((0, _jsonPointer.escape)(referenceToken)).slice(1);
@@ -2,6 +2,7 @@ import { escape as baseEscape, URIFragmentIdentifier } from '@swaggerexpert/json
2
2
 
3
3
  /**
4
4
  * @public
5
+ * @deprecated
5
6
  */
6
7
  const escape = referenceToken => {
7
8
  return URIFragmentIdentifier.to(baseEscape(referenceToken)).slice(1);
@@ -10,6 +10,7 @@ var _EvaluationJsonPointerError = _interopRequireDefault(require("./errors/Evalu
10
10
  /**
11
11
  * Evaluates JSON Pointer against ApiDOM fragment.
12
12
  * @public
13
+ * @deprecated
13
14
  */
14
15
  const evaluate = (pointer, element) => {
15
16
  try {
@@ -5,6 +5,7 @@ import EvaluationJsonPointerError from "./errors/EvaluationJsonPointerError.mjs"
5
5
  /**
6
6
  * Evaluates JSON Pointer against ApiDOM fragment.
7
7
  * @public
8
+ * @deprecated
8
9
  */
9
10
  const evaluate = (pointer, element) => {
10
11
  try {
@@ -0,0 +1,25 @@
1
+ "use strict";
2
+
3
+ var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
4
+ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
5
+ exports.__esModule = true;
6
+ exports.uriToPointer = exports.unescape = exports.parse = exports.evaluate = exports.escape = exports.compile = exports.JsonPointerError = exports.InvalidJsonPointerError = exports.EvaluationJsonPointerError = exports.CompilationJsonPointerError = void 0;
7
+ var _JsonPointerError = _interopRequireDefault(require("./errors/JsonPointerError.cjs"));
8
+ exports.JsonPointerError = _JsonPointerError.default;
9
+ var _InvalidJsonPointerError = _interopRequireDefault(require("./errors/InvalidJsonPointerError.cjs"));
10
+ exports.InvalidJsonPointerError = _InvalidJsonPointerError.default;
11
+ var _CompilationJsonPointerError = _interopRequireDefault(require("./errors/CompilationJsonPointerError.cjs"));
12
+ exports.CompilationJsonPointerError = _CompilationJsonPointerError.default;
13
+ var _EvaluationJsonPointerError = _interopRequireDefault(require("./errors/EvaluationJsonPointerError.cjs"));
14
+ exports.EvaluationJsonPointerError = _EvaluationJsonPointerError.default;
15
+ var _parse = _interopRequireWildcard(require("./parse.cjs"));
16
+ exports.parse = _parse.default;
17
+ exports.uriToPointer = _parse.uriToPointer;
18
+ var _evaluate = _interopRequireDefault(require("./evaluate.cjs"));
19
+ exports.evaluate = _evaluate.default;
20
+ var _escape = _interopRequireDefault(require("./escape.cjs"));
21
+ exports.escape = _escape.default;
22
+ var _unescape = _interopRequireDefault(require("./unescape.cjs"));
23
+ exports.unescape = _unescape.default;
24
+ var _compile = _interopRequireDefault(require("./compile.cjs"));
25
+ exports.compile = _compile.default;
@@ -0,0 +1,9 @@
1
+ export { default as JsonPointerError } from "./errors/JsonPointerError.mjs";
2
+ export { default as InvalidJsonPointerError } from "./errors/InvalidJsonPointerError.mjs";
3
+ export { default as CompilationJsonPointerError } from "./errors/CompilationJsonPointerError.mjs";
4
+ export { default as EvaluationJsonPointerError } from "./errors/EvaluationJsonPointerError.mjs";
5
+ export { default as parse, uriToPointer } from "./parse.mjs";
6
+ export { default as evaluate } from "./evaluate.mjs";
7
+ export { default as escape } from "./escape.mjs";
8
+ export { default as unescape } from "./unescape.mjs";
9
+ export { default as compile } from "./compile.mjs";
@@ -5,6 +5,7 @@ exports.uriToPointer = exports.default = void 0;
5
5
  var _jsonPointer = require("@swaggerexpert/json-pointer");
6
6
  /**
7
7
  * @public
8
+ * @deprecated
8
9
  */
9
10
  const parse = (pointer, options) => {
10
11
  const {
@@ -27,6 +28,7 @@ const getHash = uri => {
27
28
 
28
29
  /**
29
30
  * @public
31
+ * @deprecated
30
32
  */
31
33
  const uriToPointer = uri => {
32
34
  const hash = getHash(uri);
@@ -2,6 +2,7 @@ import { parse as jsonPointerParse, URIFragmentIdentifier } from '@swaggerexpert
2
2
 
3
3
  /**
4
4
  * @public
5
+ * @deprecated
5
6
  */
6
7
  const parse = (pointer, options) => {
7
8
  const {
@@ -24,6 +25,7 @@ const getHash = uri => {
24
25
 
25
26
  /**
26
27
  * @public
28
+ * @deprecated
27
29
  */
28
30
  export const uriToPointer = uri => {
29
31
  const hash = getHash(uri);
@@ -5,6 +5,7 @@ exports.default = void 0;
5
5
  var _jsonPointer = require("@swaggerexpert/json-pointer");
6
6
  /**
7
7
  * @public
8
+ * @deprecated
8
9
  */
9
10
  const unescape = referenceToken => {
10
11
  return _jsonPointer.URIFragmentIdentifier.from((0, _jsonPointer.unescape)(referenceToken));
@@ -2,6 +2,7 @@ import { unescape as baseUnescape, URIFragmentIdentifier } from '@swaggerexpert/
2
2
 
3
3
  /**
4
4
  * @public
5
+ * @deprecated
5
6
  */
6
7
  const unescape = referenceToken => {
7
8
  return URIFragmentIdentifier.from(baseUnescape(referenceToken));
@@ -1,98 +1,74 @@
1
- import { ApiDOMErrorOptions } from '@swagger-api/apidom-error';
2
- import { ApiDOMStructuredError } from '@swagger-api/apidom-error';
3
- import { Element as Element_2 } from '@swagger-api/apidom-core';
4
- import { ParseOptions } from '@swaggerexpert/json-pointer';
5
-
6
- /**
7
- * @public
8
- */
9
- export declare class CompilationJsonPointerError extends JsonPointerError {
10
- readonly tokens: string[];
11
- constructor(message?: string, structuredOptions?: CompilationJsonPointerErrorOptions);
12
- }
13
-
14
- /**
15
- * @public
16
- */
17
- export declare interface CompilationJsonPointerErrorOptions extends ApiDOMErrorOptions {
18
- readonly tokens: string[];
19
- }
20
-
21
- /**
22
- * @public
23
- */
24
- export declare const compile: (tokens: string[]) => string;
25
-
26
- /**
27
- * @public
28
- */
29
- declare const escape_2: (referenceToken: string) => string;
1
+ import { ASTTranslator } from '@swaggerexpert/json-pointer';
2
+ import { compile } from '@swaggerexpert/json-pointer';
3
+ import { CSTTranslator } from '@swaggerexpert/json-pointer';
4
+ import { escape as escape_2 } from '@swaggerexpert/json-pointer';
5
+ import { evaluate } from '@swaggerexpert/json-pointer/evaluate/realms/apidom';
6
+ import { Grammar } from '@swaggerexpert/json-pointer';
7
+ import { JSONPointerCompileError } from '@swaggerexpert/json-pointer';
8
+ import { JSONPointerError } from '@swaggerexpert/json-pointer';
9
+ import { JSONPointerEvaluateError } from '@swaggerexpert/json-pointer';
10
+ import { JSONPointerIndexError } from '@swaggerexpert/json-pointer';
11
+ import { JSONPointerKeyError } from '@swaggerexpert/json-pointer';
12
+ import { JSONPointerParseError } from '@swaggerexpert/json-pointer';
13
+ import { JSONPointerTypeError } from '@swaggerexpert/json-pointer';
14
+ import { JSONString } from '@swaggerexpert/json-pointer';
15
+ import { parse } from '@swaggerexpert/json-pointer';
16
+ import { testArrayDash } from '@swaggerexpert/json-pointer';
17
+ import { testArrayIndex } from '@swaggerexpert/json-pointer';
18
+ import { testArrayLocation } from '@swaggerexpert/json-pointer';
19
+ import { testJSONPointer } from '@swaggerexpert/json-pointer';
20
+ import { testReferenceToken } from '@swaggerexpert/json-pointer';
21
+ import { unescape as unescape_2 } from '@swaggerexpert/json-pointer';
22
+ import { URIFragmentIdentifier } from '@swaggerexpert/json-pointer';
23
+ import { XMLTranslator } from '@swaggerexpert/json-pointer';
24
+
25
+ export { ASTTranslator }
26
+
27
+ export { compile }
28
+
29
+ export { CSTTranslator }
30
+
30
31
  export { escape_2 as escape }
31
32
 
32
- /**
33
- * Evaluates JSON Pointer against ApiDOM fragment.
34
- * @public
35
- */
36
- export declare const evaluate: <T extends Element_2>(pointer: string, element: T) => Element_2;
37
-
38
- /**
39
- * @public
40
- */
41
- export declare class EvaluationJsonPointerError<T extends Element_2> extends JsonPointerError {
42
- readonly pointer: string;
43
- readonly tokens?: string[];
44
- readonly failedToken?: string;
45
- readonly failedTokenPosition?: number;
46
- readonly element: T;
47
- constructor(message?: string, structuredOptions?: EvaluationJsonPointerErrorOptions<T>);
48
- }
49
-
50
- /**
51
- * @public
52
- */
53
- export declare interface EvaluationJsonPointerErrorOptions<T extends Element_2> extends ApiDOMErrorOptions {
54
- readonly pointer: string;
55
- readonly tokens?: string[];
56
- readonly failedToken?: string;
57
- readonly failedTokenPosition?: number;
58
- readonly element: T;
59
- }
60
-
61
- /**
62
- * @public
63
- */
64
- export declare class InvalidJsonPointerError extends JsonPointerError {
65
- readonly pointer: string;
66
- constructor(message?: string, structuredOptions?: InvalidJsonPointerErrorOptions);
67
- }
68
-
69
- /**
70
- * @public
71
- */
72
- export declare interface InvalidJsonPointerErrorOptions extends ApiDOMErrorOptions {
73
- readonly pointer: string;
74
- }
75
-
76
- /**
77
- * @public
78
- */
79
- export declare class JsonPointerError extends ApiDOMStructuredError {
80
- }
81
-
82
- /**
83
- * @public
84
- */
85
- export declare const parse: (pointer: string, options?: ParseOptions) => string[];
86
-
87
- /**
88
- * @public
89
- */
90
- declare const unescape_2: (referenceToken: string) => string;
33
+ export { evaluate }
34
+
35
+ export { Grammar }
36
+
37
+ export { JSONPointerCompileError }
38
+
39
+ export { JSONPointerError }
40
+
41
+ export { JSONPointerEvaluateError }
42
+
43
+ export { JSONPointerIndexError }
44
+
45
+ export { JSONPointerKeyError }
46
+
47
+ export { JSONPointerParseError }
48
+
49
+ export { JSONPointerTypeError }
50
+
51
+ export { JSONString }
52
+
53
+ export { parse }
54
+
55
+ export { testArrayDash }
56
+
57
+ export { testArrayIndex }
58
+
59
+ export { testArrayLocation }
60
+
61
+ export { testJSONPointer }
62
+
63
+ export { testReferenceToken }
64
+
91
65
  export { unescape_2 as unescape }
92
66
 
93
- /**
94
- * @public
95
- */
96
- export declare const uriToPointer: (uri: string) => string;
67
+ export { URIFragmentIdentifier }
68
+
69
+ export { XMLTranslator }
70
+
71
+
72
+ export * from "@swaggerexpert/json-pointer";
97
73
 
98
74
  export { }