@scalar/postman-to-openapi 0.1.5 → 0.1.8
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 +26 -0
- package/dist/convert.d.ts.map +1 -1
- package/dist/convert.js +27 -0
- package/dist/helpers/authHelpers.d.ts +1 -1
- package/dist/helpers/authHelpers.d.ts.map +1 -1
- package/dist/helpers/authHelpers.js +17 -4
- package/dist/helpers/itemHelpers.d.ts.map +1 -1
- package/dist/helpers/itemHelpers.js +1 -45
- package/dist/helpers/requestBodyHelpers.js +1 -1
- package/dist/helpers/responseHelpers.d.ts +2 -2
- package/dist/helpers/responseHelpers.d.ts.map +1 -1
- package/dist/helpers/responseHelpers.js +31 -8
- package/dist/helpers/serverHelpers.d.ts +0 -2
- package/dist/helpers/serverHelpers.d.ts.map +1 -1
- package/dist/helpers/serverHelpers.js +32 -17
- package/dist/types.d.ts +7 -8
- package/dist/types.d.ts.map +1 -1
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,31 @@
|
|
|
1
1
|
# @scalar/postman-to-openapi
|
|
2
2
|
|
|
3
|
+
## 0.1.8
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- eeb2a8b: fix: postman examples are misinterpreted as folders
|
|
8
|
+
- Updated dependencies [3b4a788]
|
|
9
|
+
- Updated dependencies [4c5be96]
|
|
10
|
+
- Updated dependencies [4c5be96]
|
|
11
|
+
- @scalar/oas-utils@0.2.85
|
|
12
|
+
|
|
13
|
+
## 0.1.7
|
|
14
|
+
|
|
15
|
+
### Patch Changes
|
|
16
|
+
|
|
17
|
+
- Updated dependencies [9b4f85d]
|
|
18
|
+
- @scalar/oas-utils@0.2.84
|
|
19
|
+
|
|
20
|
+
## 0.1.6
|
|
21
|
+
|
|
22
|
+
### Patch Changes
|
|
23
|
+
|
|
24
|
+
- Updated dependencies [f524411]
|
|
25
|
+
- Updated dependencies [10c9016]
|
|
26
|
+
- Updated dependencies [b11294c]
|
|
27
|
+
- @scalar/oas-utils@0.2.83
|
|
28
|
+
|
|
3
29
|
## 0.1.5
|
|
4
30
|
|
|
5
31
|
### Patch Changes
|
package/dist/convert.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"convert.d.ts","sourceRoot":"","sources":["../src/convert.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AASxD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;
|
|
1
|
+
{"version":3,"file":"convert.d.ts","sourceRoot":"","sources":["../src/convert.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AASxD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AA+BhD;;;;GAIG;AACH,wBAAgB,OAAO,CACrB,iBAAiB,EAAE,iBAAiB,GAAG,MAAM,GAC5C,WAAW,CAAC,QAAQ,CA6KtB"}
|
package/dist/convert.js
CHANGED
|
@@ -5,6 +5,28 @@ import { processLicenseAndContact } from './helpers/licenseContactHelper.js';
|
|
|
5
5
|
import { processLogo } from './helpers/logoHelper.js';
|
|
6
6
|
import { parseServers } from './helpers/serverHelpers.js';
|
|
7
7
|
import { normalizePath } from './helpers/urlHelpers.js';
|
|
8
|
+
/**
|
|
9
|
+
* Extracts tags from Postman collection folders
|
|
10
|
+
*/
|
|
11
|
+
function extractTags(items) {
|
|
12
|
+
const tags = [];
|
|
13
|
+
function processTagItem(item, parentPath = '') {
|
|
14
|
+
if (item.item) {
|
|
15
|
+
const currentPath = parentPath
|
|
16
|
+
? `${parentPath} > ${item.name}`
|
|
17
|
+
: item.name;
|
|
18
|
+
// Add tag for the current folder
|
|
19
|
+
tags.push({
|
|
20
|
+
name: currentPath,
|
|
21
|
+
...(item.description && { description: item.description }),
|
|
22
|
+
});
|
|
23
|
+
// Process nested folders
|
|
24
|
+
item.item.forEach((subItem) => processTagItem(subItem, currentPath));
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
items.forEach((item) => processTagItem(item));
|
|
28
|
+
return tags;
|
|
29
|
+
}
|
|
8
30
|
/**
|
|
9
31
|
* Converts a Postman Collection to an OpenAPI 3.1.0 document.
|
|
10
32
|
* This function processes the collection's information, servers, authentication,
|
|
@@ -59,6 +81,11 @@ export function convert(postmanCollection) {
|
|
|
59
81
|
}
|
|
60
82
|
// Process each item in the collection and merge into OpenAPI spec
|
|
61
83
|
if (collection.item) {
|
|
84
|
+
// Extract tags from folders
|
|
85
|
+
const tags = extractTags(collection.item);
|
|
86
|
+
if (tags.length > 0) {
|
|
87
|
+
openapi.tags = tags;
|
|
88
|
+
}
|
|
62
89
|
collection.item.forEach((item) => {
|
|
63
90
|
const { paths: itemPaths, components: itemComponents } = processItem(item);
|
|
64
91
|
// Merge paths from the current item
|
|
@@ -3,7 +3,7 @@ import type { Auth } from '../types.js';
|
|
|
3
3
|
/**
|
|
4
4
|
* Processes authentication information from a Postman collection and updates
|
|
5
5
|
* the OpenAPI document with the corresponding security schemes and requirements.
|
|
6
|
-
* Supports API key, basic auth, bearer token, and
|
|
6
|
+
* Supports API key, basic auth, bearer token, OAuth2, and no authentication types.
|
|
7
7
|
*/
|
|
8
8
|
export declare function processAuth(auth: Auth): {
|
|
9
9
|
securitySchemes: Record<string, OpenAPIV3_1.SecuritySchemeObject>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"authHelpers.d.ts","sourceRoot":"","sources":["../../src/helpers/authHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;
|
|
1
|
+
{"version":3,"file":"authHelpers.d.ts","sourceRoot":"","sources":["../../src/helpers/authHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AAoGpC;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG;IACvC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,oBAAoB,CAAC,CAAA;IACjE,QAAQ,EAAE,WAAW,CAAC,yBAAyB,EAAE,CAAA;CAClD,CAwBA"}
|
|
@@ -64,6 +64,15 @@ function createOAuth2Config() {
|
|
|
64
64
|
requirement: { [AUTH_SCHEMES.OAUTH2]: [] },
|
|
65
65
|
};
|
|
66
66
|
}
|
|
67
|
+
/**
|
|
68
|
+
* Creates security configuration for no authentication
|
|
69
|
+
*/
|
|
70
|
+
function createNoAuthConfig() {
|
|
71
|
+
return {
|
|
72
|
+
scheme: {},
|
|
73
|
+
requirement: {},
|
|
74
|
+
};
|
|
75
|
+
}
|
|
67
76
|
/**
|
|
68
77
|
* Maps authentication types to their configuration creators
|
|
69
78
|
*/
|
|
@@ -72,11 +81,12 @@ const AUTH_TYPE_HANDLERS = {
|
|
|
72
81
|
basic: createBasicConfig,
|
|
73
82
|
bearer: createBearerConfig,
|
|
74
83
|
oauth2: createOAuth2Config,
|
|
84
|
+
noauth: createNoAuthConfig,
|
|
75
85
|
};
|
|
76
86
|
/**
|
|
77
87
|
* Processes authentication information from a Postman collection and updates
|
|
78
88
|
* the OpenAPI document with the corresponding security schemes and requirements.
|
|
79
|
-
* Supports API key, basic auth, bearer token, and
|
|
89
|
+
* Supports API key, basic auth, bearer token, OAuth2, and no authentication types.
|
|
80
90
|
*/
|
|
81
91
|
export function processAuth(auth) {
|
|
82
92
|
const securitySchemes = {};
|
|
@@ -87,9 +97,12 @@ export function processAuth(auth) {
|
|
|
87
97
|
throw new Error(`Unsupported authentication type: ${auth.type}`);
|
|
88
98
|
}
|
|
89
99
|
const { scheme, requirement } = handler();
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
100
|
+
// Only add security schemes and requirements if they're not empty
|
|
101
|
+
if (Object.keys(scheme).length > 0) {
|
|
102
|
+
const schemeKey = `${auth.type}Auth`;
|
|
103
|
+
securitySchemes[schemeKey] = scheme;
|
|
104
|
+
security.push(requirement);
|
|
105
|
+
}
|
|
93
106
|
}
|
|
94
107
|
catch (error) {
|
|
95
108
|
console.error('Error processing authentication:', error);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"itemHelpers.d.ts","sourceRoot":"","sources":["../../src/helpers/itemHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;
|
|
1
|
+
{"version":3,"file":"itemHelpers.d.ts","sourceRoot":"","sources":["../../src/helpers/itemHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AAsB/C;;;;;GAKG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,IAAI,GAAG,SAAS,EACtB,UAAU,GAAE,MAAM,EAAO,EACzB,UAAU,GAAE,MAAW,GACtB;IACD,KAAK,EAAE,WAAW,CAAC,WAAW,CAAA;IAC9B,UAAU,EAAE,WAAW,CAAC,gBAAgB,CAAA;CACzC,CAkJA"}
|
|
@@ -3,7 +3,6 @@ import { parseMdTable } from './md-utils.js';
|
|
|
3
3
|
import { extractParameters } from './parameterHelpers.js';
|
|
4
4
|
import { extractRequestBody } from './requestBodyHelpers.js';
|
|
5
5
|
import { extractResponses } from './responseHelpers.js';
|
|
6
|
-
import { extractStatusCodesFromTests } from './statusCodeHelpers.js';
|
|
7
6
|
import { extractPathFromUrl, extractPathParameterNames, normalizePath, } from './urlHelpers.js';
|
|
8
7
|
/**
|
|
9
8
|
* Processes a Postman collection item or item group and returns
|
|
@@ -65,7 +64,7 @@ export function processItem(item, parentTags = [], parentPath = '') {
|
|
|
65
64
|
tags: parentTags.length > 0 ? [parentTags.join(' > ')] : ['default'],
|
|
66
65
|
summary,
|
|
67
66
|
description,
|
|
68
|
-
responses: extractResponses(response || []),
|
|
67
|
+
responses: extractResponses(response || [], item),
|
|
69
68
|
parameters: [],
|
|
70
69
|
};
|
|
71
70
|
// Only add operationId if it was explicitly provided
|
|
@@ -123,49 +122,6 @@ export function processItem(item, parentTags = [], parentPath = '') {
|
|
|
123
122
|
paths[path] = {};
|
|
124
123
|
const pathItem = paths[path];
|
|
125
124
|
pathItem[method] = operationObject;
|
|
126
|
-
// Extract status codes from tests
|
|
127
|
-
const statusCodes = extractStatusCodesFromTests(item);
|
|
128
|
-
// Handle responses
|
|
129
|
-
if (statusCodes.length > 0) {
|
|
130
|
-
const responses = {};
|
|
131
|
-
statusCodes.forEach((code) => {
|
|
132
|
-
responses[code.toString()] = {
|
|
133
|
-
description: 'Successful response',
|
|
134
|
-
content: {
|
|
135
|
-
'application/json': {},
|
|
136
|
-
},
|
|
137
|
-
};
|
|
138
|
-
});
|
|
139
|
-
if (pathItem[method]) {
|
|
140
|
-
pathItem[method].responses = responses;
|
|
141
|
-
}
|
|
142
|
-
}
|
|
143
|
-
else if (item.response && item.response.length > 0) {
|
|
144
|
-
const firstResponse = item.response[0];
|
|
145
|
-
const statusCode = firstResponse.code || 200;
|
|
146
|
-
if (pathItem[method]) {
|
|
147
|
-
pathItem[method].responses = {
|
|
148
|
-
[statusCode.toString()]: {
|
|
149
|
-
description: firstResponse.status || 'Successful response',
|
|
150
|
-
content: {
|
|
151
|
-
'application/json': {},
|
|
152
|
-
},
|
|
153
|
-
},
|
|
154
|
-
};
|
|
155
|
-
}
|
|
156
|
-
}
|
|
157
|
-
else {
|
|
158
|
-
if (pathItem[method]) {
|
|
159
|
-
pathItem[method].responses = {
|
|
160
|
-
'200': {
|
|
161
|
-
description: 'Successful response',
|
|
162
|
-
content: {
|
|
163
|
-
'application/json': {},
|
|
164
|
-
},
|
|
165
|
-
},
|
|
166
|
-
};
|
|
167
|
-
}
|
|
168
|
-
}
|
|
169
125
|
return { paths, components };
|
|
170
126
|
}
|
|
171
127
|
// Helper function to parse parameters from the description if it is markdown
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import type { OpenAPIV3_1 } from '@scalar/openapi-types';
|
|
2
|
-
import type { Response } from '../types.js';
|
|
2
|
+
import type { Item, Response } from '../types.js';
|
|
3
3
|
/**
|
|
4
4
|
* Extracts and converts Postman response objects to OpenAPI response objects.
|
|
5
5
|
* Processes response status codes, descriptions, headers, and body content,
|
|
6
6
|
* inferring schemas from example responses when possible.
|
|
7
7
|
*/
|
|
8
|
-
export declare function extractResponses(responses: Response[]): OpenAPIV3_1.ResponsesObject;
|
|
8
|
+
export declare function extractResponses(responses: Response[], item?: Item): OpenAPIV3_1.ResponsesObject;
|
|
9
9
|
//# sourceMappingURL=responseHelpers.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"responseHelpers.d.ts","sourceRoot":"","sources":["../../src/helpers/responseHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAc,QAAQ,EAAE,MAAM,UAAU,CAAA;
|
|
1
|
+
{"version":3,"file":"responseHelpers.d.ts","sourceRoot":"","sources":["../../src/helpers/responseHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAc,IAAI,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAI1D;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,QAAQ,EAAE,EACrB,IAAI,CAAC,EAAE,IAAI,GACV,WAAW,CAAC,eAAe,CA8C7B"}
|
|
@@ -1,17 +1,18 @@
|
|
|
1
1
|
import { inferSchemaFromExample } from './schemaHelpers.js';
|
|
2
|
+
import { extractStatusCodesFromTests } from './statusCodeHelpers.js';
|
|
2
3
|
/**
|
|
3
4
|
* Extracts and converts Postman response objects to OpenAPI response objects.
|
|
4
5
|
* Processes response status codes, descriptions, headers, and body content,
|
|
5
6
|
* inferring schemas from example responses when possible.
|
|
6
7
|
*/
|
|
7
|
-
export function extractResponses(responses) {
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
8
|
+
export function extractResponses(responses, item) {
|
|
9
|
+
// Extract status codes from tests
|
|
10
|
+
const statusCodes = item ? extractStatusCodesFromTests(item) : [];
|
|
11
|
+
// Create a map of status codes to descriptions from responses
|
|
12
|
+
const responseMap = responses.reduce((acc, response) => {
|
|
12
13
|
const statusCode = response.code?.toString() || 'default';
|
|
13
|
-
|
|
14
|
-
description: response.status || '',
|
|
14
|
+
acc[statusCode] = {
|
|
15
|
+
description: response.status || 'Successful response',
|
|
15
16
|
headers: extractHeaders(response.header),
|
|
16
17
|
content: {
|
|
17
18
|
'application/json': {
|
|
@@ -22,8 +23,30 @@ export function extractResponses(responses) {
|
|
|
22
23
|
},
|
|
23
24
|
},
|
|
24
25
|
};
|
|
25
|
-
return
|
|
26
|
+
return acc;
|
|
26
27
|
}, {});
|
|
28
|
+
// Add status codes from tests if not already present
|
|
29
|
+
statusCodes.forEach((code) => {
|
|
30
|
+
const codeStr = code.toString();
|
|
31
|
+
if (!responseMap[codeStr]) {
|
|
32
|
+
responseMap[codeStr] = {
|
|
33
|
+
description: 'Successful response',
|
|
34
|
+
content: {
|
|
35
|
+
'application/json': {},
|
|
36
|
+
},
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
});
|
|
40
|
+
// If no responses and no status codes, return default 200
|
|
41
|
+
if (Object.keys(responseMap).length === 0) {
|
|
42
|
+
responseMap['200'] = {
|
|
43
|
+
description: 'Successful response',
|
|
44
|
+
content: {
|
|
45
|
+
'application/json': {},
|
|
46
|
+
},
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
return responseMap;
|
|
27
50
|
}
|
|
28
51
|
function extractHeaders(headers) {
|
|
29
52
|
if (!headers || typeof headers === 'string') {
|
|
@@ -2,8 +2,6 @@ import type { OpenAPIV3_1 } from '@scalar/openapi-types';
|
|
|
2
2
|
import type { PostmanCollection } from '../types.js';
|
|
3
3
|
/**
|
|
4
4
|
* Parses a Postman collection to extract unique server URLs.
|
|
5
|
-
* Iterates through collection items, extracts domains from request URLs,
|
|
6
|
-
* and returns an array of unique server objects for the OpenAPI specification.
|
|
7
5
|
*/
|
|
8
6
|
export declare function parseServers(postmanCollection: PostmanCollection): OpenAPIV3_1.ServerObject[];
|
|
9
7
|
//# sourceMappingURL=serverHelpers.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"serverHelpers.d.ts","sourceRoot":"","sources":["../../src/helpers/serverHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"serverHelpers.d.ts","sourceRoot":"","sources":["../../src/helpers/serverHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAmB,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAmClE;;GAEG;AACH,wBAAgB,YAAY,CAC1B,iBAAiB,EAAE,iBAAiB,GACnC,WAAW,CAAC,YAAY,EAAE,CAU5B"}
|
|
@@ -1,29 +1,44 @@
|
|
|
1
|
-
import { getDomainFromUrl } from './urlHelpers.js';
|
|
2
1
|
/**
|
|
3
|
-
*
|
|
4
|
-
* Iterates through collection items, extracts domains from request URLs,
|
|
5
|
-
* and returns an array of unique server objects for the OpenAPI specification.
|
|
2
|
+
* Recursively processes collection items to extract server URLs
|
|
6
3
|
*/
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
4
|
+
function processItems(items, domains) {
|
|
5
|
+
items.forEach((item) => {
|
|
6
|
+
if ('item' in item && Array.isArray(item.item)) {
|
|
7
|
+
processItems(item.item, domains);
|
|
8
|
+
}
|
|
9
|
+
else if ('request' in item) {
|
|
10
|
+
const request = item.request;
|
|
11
|
+
if (typeof request !== 'string') {
|
|
12
|
+
const url = typeof request.url === 'string' ? request.url : request.url?.raw;
|
|
16
13
|
if (url) {
|
|
17
14
|
try {
|
|
18
|
-
|
|
19
|
-
|
|
15
|
+
// Extract domain from URL
|
|
16
|
+
const urlMatch = url.match(/^(?:https?:\/\/)?([^/?#]+)/i);
|
|
17
|
+
if (urlMatch && urlMatch[1]) {
|
|
18
|
+
// Ensure we have the protocol
|
|
19
|
+
const serverUrl = urlMatch[1].startsWith('http')
|
|
20
|
+
? urlMatch[1].replace(/\/$/, '')
|
|
21
|
+
: `https://${urlMatch[1]}`.replace(/\/$/, '');
|
|
22
|
+
domains.add(serverUrl);
|
|
23
|
+
}
|
|
20
24
|
}
|
|
21
25
|
catch (error) {
|
|
22
26
|
console.error(`Error extracting domain from URL "${url}":`, error);
|
|
23
27
|
}
|
|
24
28
|
}
|
|
25
29
|
}
|
|
26
|
-
}
|
|
30
|
+
}
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Parses a Postman collection to extract unique server URLs.
|
|
35
|
+
*/
|
|
36
|
+
export function parseServers(postmanCollection) {
|
|
37
|
+
const domains = new Set();
|
|
38
|
+
if (postmanCollection.item && Array.isArray(postmanCollection.item)) {
|
|
39
|
+
processItems(postmanCollection.item, domains);
|
|
27
40
|
}
|
|
28
|
-
return Array.from(domains).map((domain) => ({
|
|
41
|
+
return Array.from(domains).map((domain) => ({
|
|
42
|
+
url: domain,
|
|
43
|
+
}));
|
|
29
44
|
}
|
package/dist/types.d.ts
CHANGED
|
@@ -34,6 +34,7 @@ export type Item = {
|
|
|
34
34
|
request: Request;
|
|
35
35
|
response?: Response[];
|
|
36
36
|
protocolProfileBehavior?: ProtocolProfileBehavior;
|
|
37
|
+
variables?: Variable[];
|
|
37
38
|
};
|
|
38
39
|
export type ItemGroup = {
|
|
39
40
|
name?: string;
|
|
@@ -43,6 +44,7 @@ export type ItemGroup = {
|
|
|
43
44
|
event?: Event[];
|
|
44
45
|
auth?: Auth | null;
|
|
45
46
|
protocolProfileBehavior?: ProtocolProfileBehavior;
|
|
47
|
+
variables?: Variable[];
|
|
46
48
|
};
|
|
47
49
|
export type Event = {
|
|
48
50
|
id?: string;
|
|
@@ -77,14 +79,11 @@ export type QueryParam = {
|
|
|
77
79
|
description?: Description;
|
|
78
80
|
};
|
|
79
81
|
export type Variable = {
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
description?: Description;
|
|
86
|
-
system?: boolean;
|
|
87
|
-
disabled?: boolean;
|
|
82
|
+
key: string;
|
|
83
|
+
value: string | number | boolean;
|
|
84
|
+
type?: 'string' | 'number' | 'boolean' | 'environment';
|
|
85
|
+
enum?: string[];
|
|
86
|
+
description?: string;
|
|
88
87
|
};
|
|
89
88
|
export type Auth = {
|
|
90
89
|
type: string;
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,IAAI,CAAA;IACV,IAAI,EAAE,CAAC,IAAI,GAAG,SAAS,CAAC,EAAE,CAAA;IAC1B,KAAK,CAAC,EAAE,KAAK,EAAE,CAAA;IACf,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAA;IACrB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,uBAAuB,CAAC,EAAE,uBAAuB,CAAA;CAClD,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,WAAW,GACnB,MAAM,GACN;IACE,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC1B,CAAA;AAEL,MAAM,MAAM,OAAO,GACf,MAAM,GACN;IACE,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;CACjD,CAAA;AAEL,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAA;IACrB,KAAK,CAAC,EAAE,KAAK,EAAE,CAAA;IACf,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAA;IACrB,uBAAuB,CAAC,EAAE,uBAAuB,CAAA;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,IAAI,CAAA;IACV,IAAI,EAAE,CAAC,IAAI,GAAG,SAAS,CAAC,EAAE,CAAA;IAC1B,KAAK,CAAC,EAAE,KAAK,EAAE,CAAA;IACf,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAA;IACrB,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,uBAAuB,CAAC,EAAE,uBAAuB,CAAA;CAClD,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,WAAW,GACnB,MAAM,GACN;IACE,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC1B,CAAA;AAEL,MAAM,MAAM,OAAO,GACf,MAAM,GACN;IACE,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;CACjD,CAAA;AAEL,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAA;IACrB,KAAK,CAAC,EAAE,KAAK,EAAE,CAAA;IACf,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAA;IACrB,uBAAuB,CAAC,EAAE,uBAAuB,CAAA;IACjD,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAA;IACrB,IAAI,EAAE,CAAC,IAAI,GAAG,SAAS,CAAC,EAAE,CAAA;IAC1B,KAAK,CAAC,EAAE,KAAK,EAAE,CAAA;IACf,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,uBAAuB,CAAC,EAAE,uBAAuB,CAAA;IACjD,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,KAAK,GAAG;IAClB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;IACxB,GAAG,CAAC,EAAE,GAAG,CAAA;IACT,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,GAAG,GACX,MAAM,GACN;IACE,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB,IAAI,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAA;IAC5D,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,UAAU,EAAE,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAA;CACtB,CAAA;AAEL,MAAM,MAAM,UAAU,GAAG;IACvB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAClB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;IAChC,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,aAAa,CAAA;IACtD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,IAAI,CAAA;IACb,MAAM,CAAC,EAAE,aAAa,EAAE,CAAA;IACxB,KAAK,CAAC,EAAE,aAAa,EAAE,CAAA;IACvB,KAAK,CAAC,EAAE,aAAa,EAAE,CAAA;IACvB,MAAM,CAAC,EAAE,aAAa,EAAE,CAAA;IACxB,MAAM,CAAC,EAAE,aAAa,EAAE,CAAA;IACxB,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAA;IAC1B,IAAI,CAAC,EAAE,aAAa,EAAE,CAAA;IACtB,IAAI,CAAC,EAAE,aAAa,EAAE,CAAA;IACtB,MAAM,CAAC,EAAE,aAAa,EAAE,CAAA;IACxB,MAAM,CAAC,EAAE,aAAa,EAAE,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;IACjC,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,OAAO,GACf,MAAM,GACN;IACE,GAAG,CAAC,EAAE,GAAG,CAAA;IACT,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAClB,KAAK,CAAC,EAAE,WAAW,CAAA;IACnB,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM,CAAA;IAC5B,IAAI,CAAC,EAAE,WAAW,GAAG,IAAI,CAAA;CAC1B,CAAA;AAEL,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,GAAG,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACtB,IAAI,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG,MAAM,EAAE,CAAA;AAEjC,MAAM,MAAM,MAAM,GAAG;IACnB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,CAAC,EAAE,KAAK,GAAG,YAAY,GAAG,UAAU,GAAG,MAAM,GAAG,SAAS,CAAA;IAC7D,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE;QACR,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC,CAAA;KAC7D,CAAA;IACD,UAAU,CAAC,EAAE,mBAAmB,EAAE,CAAA;IAClC,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAA;IAC1B,IAAI,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAChD,OAAO,CAAC,EAAE;QACR,GAAG,CAAC,EAAE;YAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;QAC3B,UAAU,CAAC,EAAE;YAAE,WAAW,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;QACrC,QAAQ,CAAC,EAAE;YAAE,WAAW,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KACpC,CAAA;IACD,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,aAAa,GACrB;IACE,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B,GACD;IACE,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI,CAAA;IAC9B,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B,CAAA;AAEL,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;IACrC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM,GAAG,IAAI,CAAA;IACnC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,KAAK,CAAC;QACjB,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,MAAM,CAAA;KACd,CAAC,CAAA;CACH,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG,EAErC,CAAA"}
|
package/package.json
CHANGED
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
"export",
|
|
20
20
|
"scalar"
|
|
21
21
|
],
|
|
22
|
-
"version": "0.1.
|
|
22
|
+
"version": "0.1.8",
|
|
23
23
|
"engines": {
|
|
24
24
|
"node": ">=18"
|
|
25
25
|
},
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
],
|
|
39
39
|
"module": "dist/index.js",
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@scalar/oas-utils": "0.2.
|
|
41
|
+
"@scalar/oas-utils": "0.2.85",
|
|
42
42
|
"@scalar/openapi-types": "0.1.5"
|
|
43
43
|
},
|
|
44
44
|
"devDependencies": {
|