@adobe/fetch - npm Package Compare versions

Comparing version 0.1.4 to 0.1.5

index.js

@@ -81,3 +81,4 @@ /*
     privateKey,
-    metaScopes
+    metaScopes,
+    storage
   } = options;
@@ -106,2 +107,11 @@
   }
+
+  if (storage) {
+    let { read, write } = storage;
+    if (!read) {
+      throw 'Storage read method missing!';
+    } else if (!write) {
+      throw 'Storage write method missing!';
+    }
+  }
 }
@@ -108,0 +118,0 @@

package.json

 {
   "name": "@adobe/fetch",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "Call Adobe APIs",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -65,3 +65,3 @@ [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 | metaScopes         |                      | true     | Comma separated Sting or an Array |                                |
-| ims                |                      | false    | String                            | https://ims-na1.adobelogin.com |
+| ims                |                      | false    | String                            | <https://ims-na1.adobelogin.com> |
 
@@ -72,4 +72,4 @@ In order to determine which **metaScopes** you need to register for you can look them up by product in this [handy table](https://www.adobe.io/authentication/auth-methods.html#!AdobeDocs/adobeio-auth/master/JWT/Scopes.md).
 
-- GDPR: https://ims-na1.adobelogin.com/s/ent_gdpr_sdk
-- User Management: https://ims-na1.adobelogin.com/s/ent_user_sdk
+- GDPR: <https://ims-na1.adobelogin.com/s/ent_gdpr_sdk>
+- User Management: <https://ims-na1.adobelogin.com/s/ent_user_sdk>
 
@@ -109,2 +109,60 @@ They you would create an array of **metaScopes** as part of the config object. For instance:
 
+#### Custom Storage
+
+By default, [node-persist](https://github.com/bitinn/node-persist) is used to store all the active tokens locally.  
+Tokens will be stored under **/.node-perist/storage**
+
+It is possible to use any other storage for token persistance. This is done by providing **read** and **write** methods as follows:  
+
+```javascript
+const config = {
+  auth: {
+      clientId: 'asasdfasf',
+      
+      ...
+      
+      storage: {
+        read: function() {
+          return new Promise(function(resolve, reject) {
+            let tokens;
+            
+            // .. Some logic to read the tokens ..
+            
+            resolve(tokens);
+          });
+        },
+        write: function(tokens) {
+          return new Promise(function(resolve, reject) {
+            
+            // .. Some logic to save the tokens ..
+            
+            resolve();
+          });
+        }
+      }
+  }
+};
+```
+
+Alternatively, use async/await:
+
+```javascript
+const config = {
+  auth: {
+      clientId: 'asasdfasf',
+      
+      ...
+      
+      storage: {
+        read: async function() {
+          return await myGetTokensImplementation();            
+        },
+        write: async function(tokens) {
+          await myStoreTokensImplementation(tokens);
+        }
+      }
+  }
+};
+```
+
 ### Contributing
@@ -111,0 +169,0 @@

src/cache.js

@@ -26,3 +26,3 @@ /* eslint-disable require-atomic-updates */
   if (!cache.disableStorage) {
-    cache.tokens = await storage.read();
+    cache.tokens = await cache.read();
     cache.readOnce = true;
@@ -39,3 +39,3 @@ }
   if (!cache.disableStorage) {
-    await storage.save(cache.tokens);
+    await cache.write(cache.tokens);
   }
@@ -94,5 +94,10 @@ }
   const disableStorage = (options && options.disableStorage) || false;
+  const readFunc = options.storage ? options.storage.read : storage.read;
+  const writeFunc = options.storage ? options.storage.write : storage.write;
+
   const cache = {
     disableStorage: disableStorage,
     readOnce: disableStorage,
+    read: readFunc,
+    write: writeFunc,
     tokens: {}
@@ -99,0 +104,0 @@ };

src/storage.js

@@ -52,3 +52,3 @@ /*
  */
-async function save(tokens) {
+async function write(tokens) {
   return await storage.setItem(TOKENS, tokens);
@@ -58,2 +58,2 @@ }
 module.exports.read = read;
-module.exports.save = save;
+module.exports.write = write;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

92586

increased by10.15%

Number of package files

27

increased by3.85%

Lines of code

815

increased by25.19%

Number of lines in readme file

172

increased by50.88%

Worsened metrics

Number of medium supply chain risk alerts

13

increased by44.44%

No dependency changes