api 4.4.0 → 4.5.0

package/README.md

@@ -23,7 +23,7 @@ npm install api --save
 Using `api` is as simple as supplying it an OpenAPI and using the SDK as you would any other!
 
 ```js
-const sdk = require('api')('https://raw.githubusercontent.com/readmeio/oas/master/packages/examples/3.0/json/petstore.json');
+const sdk = require('api')('https://raw.githubusercontent.com/readmeio/oas-examples/main/3.0/json/petstore.json');
 
 sdk.listPets().then(res => {
   console.log(`My pets name is ${res[0].name}!`);
@@ -164,3 +164,17 @@ By default we parse the response based on the `content-type` header for you. You
 ```js
 sdk.config({ parseResponse: false });
 ```
+
+#### Where is the cache stored?
+
+By default the cache is configured with the [find-cache-dir](https://npm.im/find-cache-dir) library so the cache will be in `node_modules/.cache/api`. If placing this cache within the `node_modules/` directory is a problem for your environment (maybe you use `npm prune`) you can configure this by supplying an additional argument to the SDK instantiator:
+
+```js
+const sdk = require('api')('https://raw.githubusercontent.com/readmeio/oas-examples/main/3.0/json/petstore.json', {
+  cacheDir: './path/to/my/custom/cache/dir',
+});
+
+sdk.listPets().then(res => {
+  console.log(`My pets name is ${res[0].name}!`);
+});
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api",
-  "version": "4.4.0",
+  "version": "4.5.0",
   "description": "Generate an SDK from an OpenAPI definition",
   "main": "src/index.js",
   "scripts": {
@@ -48,8 +48,9 @@
   "prettier": "@readme/eslint-config/prettier",
   "jest": {
     "testPathIgnorePatterns": [
-      "__tests__/__fixtures__/"
+      "__tests__/__fixtures__/",
+      ".api-test/"
     ]
   },
-  "gitHead": "dab29250c2aea8ff2148aa35d50f9fc11cf69647"
+  "gitHead": "2cbe023cb5d2c1ff1f8b46a4c90d49bb7af0c5f1"
 }

package/src/cache.js

@@ -9,18 +9,8 @@ const os = require('os');
 const path = require('path');
 const makeDir = require('make-dir');
 
-let cacheDir = findCacheDir({ name: pkg.name });
-if (typeof cacheDir === 'undefined') {
-  // The `find-cache-dir` module returns `undefined` if the `node_modules/` directory isn't writable, or there's no
-  // `package.json` in the root-most directory. If this happens, we can instead adhoc create a cache directory in the
-  // users OS temp directory and store our data there.
-  //
-  // @link https://github.com/avajs/find-cache-dir/issues/29
-  cacheDir = makeDir.sync(path.join(os.tmpdir(), pkg.name));
-}
-
-class SdkCache {
-  constructor(uri) {
+class Cache {
+  constructor(uri, cacheDir = false) {
     /**
      * Resolve OpenAPI definition shorthand accessors from within the ReadMe API Registry.
      *
@@ -37,8 +27,23 @@ class SdkCache {
         : u;
 
     this.uri = resolveReadMeRegistryAccessor(uri);
-    this.uriHash = SdkCache.getCacheHash(this.uri);
-    this.dir = cacheDir;
+    this.uriHash = Cache.getCacheHash(this.uri);
+
+    if (cacheDir) {
+      this.dir = cacheDir;
+    } else {
+      this.dir = findCacheDir({ name: pkg.name });
+      if (typeof this.dir === 'undefined') {
+        // The `find-cache-dir` module returns `undefined` if the `node_modules/` directory isn't
+        // writable, or there's no `package.json` in the root-most directory. If this happens, we
+        // can instead adhoc create a cache directory in the users OS temp directory and store our
+        // data there.
+        //
+        // @link https://github.com/avajs/find-cache-dir/issues/29
+        this.dir = makeDir.sync(path.join(os.tmpdir(), pkg.name));
+      }
+    }
+
     this.cacheStore = path.join(this.dir, 'cache.json');
     this.specsCache = path.join(this.dir, 'specs');
 
@@ -206,4 +211,4 @@ class SdkCache {
   }
 }
 
-module.exports = SdkCache;
+module.exports = Cache;

package/src/index.js

@@ -13,9 +13,11 @@ global.Headers = fetch.Headers;
 global.FormData = require('form-data');
 
 class Sdk {
-  constructor(uri) {
+  constructor(uri, opts = {}) {
     this.uri = uri;
     this.userAgent = `${pkg.name} (node)/${pkg.version}`;
+
+    this.cacheDir = opts.cacheDir ? opts.cacheDir : false;
   }
 
   static getOperations(spec) {
@@ -30,7 +32,7 @@ class Sdk {
 
   load() {
     let authKeys = [];
-    const cache = new Cache(this.uri);
+    const cache = new Cache(this.uri, this.cacheDir);
     const self = this;
     let config = { parseResponse: true };
     let server = false;
@@ -170,6 +172,6 @@ class Sdk {
   }
 }
 
-module.exports = uri => {
-  return new Sdk(uri).load();
+module.exports = (uri, opts = {}) => {
+  return new Sdk(uri, opts).load();
 };