api 3.3.2 → 4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api",
-  "version": "3.3.2",
+  "version": "4.0.0",
   "description": "Generate an SDK from an OpenAPI definition",
   "main": "src/index.js",
   "scripts": {
@@ -23,9 +23,8 @@
     "node": "^12 || ^14 || ^16"
   },
   "dependencies": {
-    "@apidevtools/json-schema-ref-parser": "^9.0.1",
-    "@apidevtools/swagger-parser": "^10.0.1",
-    "@readme/oas-to-har": "^13.6.0",
+    "@readme/oas-to-har": "^13.8.1",
+    "@readme/openapi-parser": "^1.1.0",
     "datauri": "^4.1.0",
     "fetch-har": "^5.0.0",
     "find-cache-dir": "^3.3.1",
@@ -35,16 +34,16 @@
     "make-dir": "^3.1.0",
     "mimer": "^2.0.2",
     "node-fetch": "^2.6.0",
-    "oas": "^14.0.0"
+    "oas": "^16.0.3"
   },
   "devDependencies": {
-    "@readme/eslint-config": "^6.0.0",
-    "@readme/oas-examples": "^4.2.0",
+    "@readme/eslint-config": "^7.2.2",
+    "@readme/oas-examples": "^4.3.2",
     "eslint": "^7.32.0",
-    "jest": "^27.0.6",
-    "memfs": "^3.2.2",
-    "nock": "^13.1.1",
-    "prettier": "^2.3.2"
+    "jest": "^27.3.1",
+    "memfs": "^3.2.4",
+    "nock": "^13.1.3",
+    "prettier": "^2.4.1"
   },
   "prettier": "@readme/eslint-config/prettier",
   "jest": {
@@ -52,5 +51,5 @@
       "__tests__/__fixtures__/"
     ]
   },
-  "gitHead": "0781286b8ed5048b50c2e90dcb3b477c5367eac0"
+  "gitHead": "f1d2c251f1468bceb78e39731e20f30c6745c419"
 }

package/src/cache.js

@@ -1,6 +1,5 @@
 const fetch = require('node-fetch');
-const SwaggerParser = require('@apidevtools/swagger-parser');
-const $RefParser = require('@apidevtools/json-schema-ref-parser');
+const OpenAPIParser = require('@readme/openapi-parser');
 const yaml = require('js-yaml');
 const crypto = require('crypto');
 const findCacheDir = require('find-cache-dir');
@@ -127,17 +126,22 @@ class SdkCache {
       return resolve(json);
     })
       .then(res => {
-        return SwaggerParser.validate(res).catch(err => {
-          if (/is not a valid openapi api definition/i.test(err.message)) {
+        // The `validate` method handles dereferencing for us.
+        return OpenAPIParser.validate(res, {
+          dereference: {
+            // If circular `$refs` are ignored they'll remain in the API definition as `$ref: String`. This allows us to
+            // not only do easy circular reference detection but also stringify and  save dereferenced API definitions
+            // back into the cache directory.
+            circular: 'ignore',
+          },
+        }).catch(err => {
+          if (/is not a valid openapi definition/i.test(err.message)) {
             throw new Error("Sorry, that doesn't look like a valid OpenAPI definition.");
           }
 
           throw err;
         });
       })
-      .then(res => {
-        return $RefParser.dereference(res);
-      })
       .then(async spec => {
         if (!fs.existsSync(self.dir)) {
           fs.mkdirSync(self.dir, { recursive: true });

package/src/lib/parseResponse.js

@@ -1,6 +1,8 @@
 // Nabbed from here:
 // https://github.com/readmeio/api-explorer/blob/77b90ebed4673f168354cdcd730e34b7ee016360/packages/api-explorer/src/lib/parse-response.js#L13-L30
-const { matchesMimeType } = require('oas/src/utils');
+const {
+  utils: { matchesMimeType },
+} = require('oas');
 
 module.exports = async function getResponseBody(response) {
   const contentType = response.headers.get('Content-Type');

package/src/lib/prepareParams.js

@@ -4,7 +4,9 @@ const stream = require('stream');
 const mimer = require('mimer');
 const getStream = require('get-stream');
 const datauri = require('datauri');
-const { getSchema } = require('oas/src/utils');
+const {
+  utils: { getSchema },
+} = require('oas');
 
 function digestParameters(parameters) {
   return parameters.reduce((prev, param) => {