api 3.4.0 → 4.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api",
-  "version": "3.4.0",
+  "version": "4.1.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.7.2",
+    "@readme/oas-to-har": "^14.0.0",
+    "@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.5.1"
+    "oas": "^17.1.0"
   },
   "devDependencies": {
-    "@readme/eslint-config": "^7.1.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.2.0",
+    "jest": "^27.3.1",
     "memfs": "^3.2.4",
     "nock": "^13.1.3",
-    "prettier": "^2.4.0"
+    "prettier": "^2.4.1"
   },
   "prettier": "@readme/eslint-config/prettier",
   "jest": {
@@ -52,5 +51,5 @@
       "__tests__/__fixtures__/"
     ]
   },
-  "gitHead": "142ce119c61b50b2689c0ebcf8a330861db4a0b2"
+  "gitHead": "057c930ba9ca953bda5413baae6efec062563807"
 }

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/index.js

@@ -1,11 +1,11 @@
 const fetch = require('node-fetch');
 const fetchHar = require('fetch-har');
-const Oas = require('oas');
+const Oas = require('oas').default;
 const oasToHar = require('@readme/oas-to-har');
 const pkg = require('../package.json');
 
 const Cache = require('./cache');
-const { parseResponse, prepareAuth, prepareParams, prepareServer } = require('./lib/index');
+const { parseResponse, prepareAuth, prepareParams, prepareServer } = require('./lib');
 
 global.fetch = fetch;
 global.Request = fetch.Request;
@@ -19,9 +19,9 @@ class Sdk {
   }
 
   static getOperations(spec) {
-    return Object.keys(spec.paths)
+    return Object.keys(spec.api.paths)
       .map(path => {
-        return Object.keys(spec.paths[path]).map(method => {
+        return Object.keys(spec.api.paths[path]).map(method => {
           return spec.operation(path, method);
         });
       })

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) => {
@@ -87,7 +89,7 @@ module.exports = async (operation, body, metadata) => {
   // body payload to see if anything in there is either a file path or a file stream so we can translate those into a
   // data URL for `@readme/oas-to-har` to make a request.
   if ('body' in params && operation.isMultipart()) {
-    let requestBody = getSchema(operation.schema, operation.oas);
+    let requestBody = getSchema(operation.schema, operation.api);
     if (requestBody) {
       requestBody = requestBody.schema;
     } else {

package/src/lib/prepareServer.js

@@ -18,7 +18,7 @@ function stripTrailingSlash(url) {
 module.exports = (spec, url, variables = {}) => {
   let serverIdx;
   const sanitizedUrl = stripTrailingSlash(url);
-  (spec.servers || []).forEach((server, i) => {
+  (spec.api.servers || []).forEach((server, i) => {
     if (server.url === sanitizedUrl) {
       serverIdx = i;
     }