@jentic/arazzo-parser 1.0.0-alpha.25 → 1.0.0-alpha.26
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.
- package/CHANGELOG.md +6 -0
- package/README.md +5 -18
- package/dist/jentic-arazzo-parser.browser.js +2 -2
- package/dist/jentic-arazzo-parser.browser.min.js +1 -1
- package/package.json +2 -2
- package/src/index.cjs +3 -3
- package/src/index.mjs +2 -2
- package/types/arazzo-parser.d.ts +20 -20
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jentic/arazzo-parser",
|
|
3
|
-
"version": "1.0.0-alpha.
|
|
3
|
+
"version": "1.0.0-alpha.26",
|
|
4
4
|
"description": "Parser for Arazzo Documents producing SpecLynx ApiDOM data model.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"arazzo",
|
|
@@ -75,5 +75,5 @@
|
|
|
75
75
|
"README.md",
|
|
76
76
|
"CHANGELOG.md"
|
|
77
77
|
],
|
|
78
|
-
"gitHead": "
|
|
78
|
+
"gitHead": "fa8637a6e4ad80e321a5808da52e4346a1a1f0d7"
|
|
79
79
|
}
|
package/src/index.cjs
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
|
|
3
3
|
exports.__esModule = true;
|
|
4
|
-
exports.parseOpenAPI = exports.parseArazzo = exports.
|
|
4
|
+
exports.parseOpenAPI = exports.parseArazzo = exports.defaultParseOpenAPIOptions = exports.defaultParseArazzoOptions = void 0;
|
|
5
5
|
var _parseArazzo = require("./parse-arazzo.cjs");
|
|
6
6
|
exports.parseArazzo = _parseArazzo.parse;
|
|
7
|
-
exports.
|
|
7
|
+
exports.defaultParseArazzoOptions = _parseArazzo.defaultOptions;
|
|
8
8
|
var _parseOpenapi = require("./parse-openapi.cjs");
|
|
9
9
|
exports.parseOpenAPI = _parseOpenapi.parse;
|
|
10
|
-
exports.
|
|
10
|
+
exports.defaultParseOpenAPIOptions = _parseOpenapi.defaultOptions;
|
package/src/index.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export { parse as parseArazzo, defaultOptions as
|
|
2
|
-
export { parse as parseOpenAPI, defaultOptions as
|
|
1
|
+
export { parse as parseArazzo, defaultOptions as defaultParseArazzoOptions } from "./parse-arazzo.mjs";
|
|
2
|
+
export { parse as parseOpenAPI, defaultOptions as defaultParseOpenAPIOptions } from "./parse-openapi.mjs";
|
package/types/arazzo-parser.d.ts
CHANGED
|
@@ -2,29 +2,17 @@ import type { ApiDOMReferenceOptions } from '@speclynx/apidom-reference';
|
|
|
2
2
|
import { ParseResultElement } from '@speclynx/apidom-datamodel';
|
|
3
3
|
import type { PartialDeep } from 'type-fest';
|
|
4
4
|
|
|
5
|
-
/**
|
|
6
|
-
* Options for parsing Arazzo Documents.
|
|
7
|
-
* @public
|
|
8
|
-
*/
|
|
9
|
-
export declare type ArazzoOptions = PartialDeep<ApiDOMReferenceOptions>;
|
|
10
|
-
|
|
11
5
|
/**
|
|
12
6
|
* Default reference options for parsing Arazzo Documents.
|
|
13
7
|
* @public
|
|
14
8
|
*/
|
|
15
|
-
export declare const
|
|
9
|
+
export declare const defaultParseArazzoOptions: ParseArazzoOptions;
|
|
16
10
|
|
|
17
11
|
/**
|
|
18
12
|
* Default reference options for parsing OpenAPI Documents.
|
|
19
13
|
* @public
|
|
20
14
|
*/
|
|
21
|
-
export declare const
|
|
22
|
-
|
|
23
|
-
/**
|
|
24
|
-
* Options for parsing OpenAPI Documents.
|
|
25
|
-
* @public
|
|
26
|
-
*/
|
|
27
|
-
export declare type OpenAPIOptions = PartialDeep<ApiDOMReferenceOptions>;
|
|
15
|
+
export declare const defaultParseOpenAPIOptions: ParseOpenAPIOptions;
|
|
28
16
|
|
|
29
17
|
/**
|
|
30
18
|
* Parses an Arazzo Document from an object.
|
|
@@ -34,7 +22,7 @@ export declare type OpenAPIOptions = PartialDeep<ApiDOMReferenceOptions>;
|
|
|
34
22
|
* @throws ParseError - When parsing fails for any reason. The original error is available via the `cause` property.
|
|
35
23
|
* @public
|
|
36
24
|
*/
|
|
37
|
-
export declare function parseArazzo(source: Record<string, unknown>, options?:
|
|
25
|
+
export declare function parseArazzo(source: Record<string, unknown>, options?: ParseArazzoOptions): Promise<ParseResultElement>;
|
|
38
26
|
|
|
39
27
|
/**
|
|
40
28
|
* Parses an Arazzo Document from a string or URI.
|
|
@@ -44,7 +32,7 @@ export declare function parseArazzo(source: Record<string, unknown>, options?: A
|
|
|
44
32
|
* @throws ParseError - When parsing fails for any reason. The original error is available via the `cause` property.
|
|
45
33
|
* @public
|
|
46
34
|
*/
|
|
47
|
-
export declare function parseArazzo(source: string, options?:
|
|
35
|
+
export declare function parseArazzo(source: string, options?: ParseArazzoOptions): Promise<ParseResultElement>;
|
|
48
36
|
|
|
49
37
|
/**
|
|
50
38
|
* Parses an Arazzo Document from a string, object, or URI.
|
|
@@ -54,7 +42,13 @@ export declare function parseArazzo(source: string, options?: ArazzoOptions): Pr
|
|
|
54
42
|
* @throws ParseError - When parsing fails for any reason. The original error is available via the `cause` property.
|
|
55
43
|
* @public
|
|
56
44
|
*/
|
|
57
|
-
export declare function parseArazzo(source: string | Record<string, unknown>, options?:
|
|
45
|
+
export declare function parseArazzo(source: string | Record<string, unknown>, options?: ParseArazzoOptions): Promise<ParseResultElement>;
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* Options for parsing Arazzo Documents.
|
|
49
|
+
* @public
|
|
50
|
+
*/
|
|
51
|
+
export declare type ParseArazzoOptions = PartialDeep<ApiDOMReferenceOptions>;
|
|
58
52
|
|
|
59
53
|
/**
|
|
60
54
|
* Parses an OpenAPI Document from an object.
|
|
@@ -64,7 +58,7 @@ export declare function parseArazzo(source: string | Record<string, unknown>, op
|
|
|
64
58
|
* @throws ParseError - When parsing fails for any reason. The original error is available via the `cause` property.
|
|
65
59
|
* @public
|
|
66
60
|
*/
|
|
67
|
-
export declare function parseOpenAPI(source: Record<string, unknown>, options?:
|
|
61
|
+
export declare function parseOpenAPI(source: Record<string, unknown>, options?: ParseOpenAPIOptions): Promise<ParseResultElement>;
|
|
68
62
|
|
|
69
63
|
/**
|
|
70
64
|
* Parses an OpenAPI Document from a string or URI.
|
|
@@ -74,7 +68,7 @@ export declare function parseOpenAPI(source: Record<string, unknown>, options?:
|
|
|
74
68
|
* @throws ParseError - When parsing fails for any reason. The original error is available via the `cause` property.
|
|
75
69
|
* @public
|
|
76
70
|
*/
|
|
77
|
-
export declare function parseOpenAPI(source: string, options?:
|
|
71
|
+
export declare function parseOpenAPI(source: string, options?: ParseOpenAPIOptions): Promise<ParseResultElement>;
|
|
78
72
|
|
|
79
73
|
/**
|
|
80
74
|
* Parses an OpenAPI Document from a string, object, or URI.
|
|
@@ -84,7 +78,13 @@ export declare function parseOpenAPI(source: string, options?: OpenAPIOptions):
|
|
|
84
78
|
* @throws ParseError - When parsing fails for any reason. The original error is available via the `cause` property.
|
|
85
79
|
* @public
|
|
86
80
|
*/
|
|
87
|
-
export declare function parseOpenAPI(source: string | Record<string, unknown>, options?:
|
|
81
|
+
export declare function parseOpenAPI(source: string | Record<string, unknown>, options?: ParseOpenAPIOptions): Promise<ParseResultElement>;
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* Options for parsing OpenAPI Documents.
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
export declare type ParseOpenAPIOptions = PartialDeep<ApiDOMReferenceOptions>;
|
|
88
88
|
|
|
89
89
|
export { ParseResultElement }
|
|
90
90
|
|