oas-normalize 8.3.2 → 8.3.4
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/README.md +1 -1
- package/dist/index.js +1 -1
- package/dist/lib/utils.js +24 -4
- package/package.json +7 -7
- package/src/index.ts +1 -1
- package/src/lib/utils.ts +2 -3
package/README.md
CHANGED
|
@@ -79,7 +79,7 @@ await oas.deref().then(definition => {
|
|
|
79
79
|
|
|
80
80
|
Validate and optionally convert to OpenAPI, a given API definition. This supports Swagger 2.0, OpenAPI 3.x API definitions as well as Postman 2.x collections.
|
|
81
81
|
|
|
82
|
-
Please note that if you've supplied a Postman collection to the library it will **always** be converted to OpenAPI, using [postman-to-openapi](https://
|
|
82
|
+
Please note that if you've supplied a Postman collection to the library it will **always** be converted to OpenAPI, using [@readme/postman-to-openapi](https://npm.im/@readme/postman-to-openapi), and we will only validate resulting OpenAPI definition.
|
|
83
83
|
|
|
84
84
|
```js
|
|
85
85
|
await oas.validate().then(definition => {
|
package/dist/index.js
CHANGED
|
@@ -76,8 +76,8 @@ exports.__esModule = true;
|
|
|
76
76
|
exports.getAPIDefinitionType = exports.isAPIDefinition = void 0;
|
|
77
77
|
var fs_1 = __importDefault(require("fs"));
|
|
78
78
|
var openapi_parser_1 = __importDefault(require("@readme/openapi-parser"));
|
|
79
|
+
var postman_to_openapi_1 = __importDefault(require("@readme/postman-to-openapi"));
|
|
79
80
|
var node_fetch_1 = __importDefault(require("node-fetch"));
|
|
80
|
-
var postman_to_openapi_1 = __importDefault(require("postman-to-openapi"));
|
|
81
81
|
var swagger2openapi_1 = __importDefault(require("swagger2openapi"));
|
|
82
82
|
var utils = __importStar(require("./lib/utils"));
|
|
83
83
|
exports.isAPIDefinition = utils.isAPIDefinition;
|
package/dist/lib/utils.js
CHANGED
|
@@ -1,10 +1,30 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
var
|
|
3
|
-
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
+
if (mod && mod.__esModule) return mod;
|
|
20
|
+
var result = {};
|
|
21
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
+
__setModuleDefault(result, mod);
|
|
23
|
+
return result;
|
|
4
24
|
};
|
|
5
25
|
exports.__esModule = true;
|
|
6
26
|
exports.getAPIDefinitionType = exports.isAPIDefinition = exports.stringToJSON = exports.isSwagger = exports.isPostman = exports.isOpenAPI = exports.getType = exports.normalizeURL = exports.isBuffer = void 0;
|
|
7
|
-
var js_yaml_1 =
|
|
27
|
+
var js_yaml_1 = __importStar(require("js-yaml"));
|
|
8
28
|
/**
|
|
9
29
|
* Determine if a given variable is a `Buffer`.
|
|
10
30
|
*
|
|
@@ -95,7 +115,7 @@ function stringToJSON(string) {
|
|
|
95
115
|
else if (string.match(/^\s*{/)) {
|
|
96
116
|
return JSON.parse(string);
|
|
97
117
|
}
|
|
98
|
-
return js_yaml_1["default"].load(string);
|
|
118
|
+
return js_yaml_1["default"].load(string, { schema: js_yaml_1.JSON_SCHEMA });
|
|
99
119
|
}
|
|
100
120
|
exports.stringToJSON = stringToJSON;
|
|
101
121
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "oas-normalize",
|
|
3
|
-
"version": "8.3.
|
|
3
|
+
"version": "8.3.4",
|
|
4
4
|
"description": "Tooling for converting, valiating, and parsing OpenAPI, Swagger, and Postman API definitions",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -43,22 +43,22 @@
|
|
|
43
43
|
"license": "MIT",
|
|
44
44
|
"dependencies": {
|
|
45
45
|
"@readme/openapi-parser": "^2.4.0",
|
|
46
|
+
"@readme/postman-to-openapi": "^4.0.0",
|
|
46
47
|
"js-yaml": "^4.1.0",
|
|
47
48
|
"node-fetch": "^2.6.1",
|
|
48
49
|
"openapi-types": "^12.1.0",
|
|
49
|
-
"postman-to-openapi": "^3.0.1",
|
|
50
50
|
"swagger2openapi": "^7.0.8"
|
|
51
51
|
},
|
|
52
52
|
"devDependencies": {
|
|
53
|
-
"@readme/eslint-config": "^10.5.
|
|
53
|
+
"@readme/eslint-config": "^10.5.1",
|
|
54
54
|
"@readme/oas-examples": "^5.8.1",
|
|
55
|
-
"@types/jest": "^29.
|
|
55
|
+
"@types/jest": "^29.5.0",
|
|
56
56
|
"@types/js-yaml": "^4.0.5",
|
|
57
57
|
"@types/node-fetch": "^2.6.2",
|
|
58
|
-
"eslint": "^8.
|
|
59
|
-
"jest": "^29.
|
|
58
|
+
"eslint": "^8.36.0",
|
|
59
|
+
"jest": "^29.5.0",
|
|
60
60
|
"nock": "^13.3.0",
|
|
61
|
-
"prettier": "^2.8.
|
|
61
|
+
"prettier": "^2.8.5",
|
|
62
62
|
"ts-jest": "^29.0.5",
|
|
63
63
|
"typescript": "^4.9.5"
|
|
64
64
|
},
|
package/src/index.ts
CHANGED
|
@@ -3,8 +3,8 @@ import type { OpenAPI } from 'openapi-types';
|
|
|
3
3
|
import fs from 'fs';
|
|
4
4
|
|
|
5
5
|
import openapiParser from '@readme/openapi-parser';
|
|
6
|
+
import postmanToOpenAPI from '@readme/postman-to-openapi';
|
|
6
7
|
import fetch from 'node-fetch';
|
|
7
|
-
import postmanToOpenAPI from 'postman-to-openapi';
|
|
8
8
|
|
|
9
9
|
import converter from 'swagger2openapi';
|
|
10
10
|
|
package/src/lib/utils.ts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
import YAML from 'js-yaml';
|
|
2
|
-
|
|
1
|
+
import YAML, { JSON_SCHEMA } from 'js-yaml';
|
|
3
2
|
/**
|
|
4
3
|
* Determine if a given variable is a `Buffer`.
|
|
5
4
|
*
|
|
@@ -90,7 +89,7 @@ export function stringToJSON(string: string | Record<string, unknown>) {
|
|
|
90
89
|
return JSON.parse(string);
|
|
91
90
|
}
|
|
92
91
|
|
|
93
|
-
return YAML.load(string);
|
|
92
|
+
return YAML.load(string, { schema: JSON_SCHEMA });
|
|
94
93
|
}
|
|
95
94
|
|
|
96
95
|
/**
|