feat: Allow state-specific arguments to be passed to the returned aut…

…horization function rather than the function factory
compwright · Oct 5, 2022 · c23458a · c23458a
1 parent ca10d60
commit c23458a
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 57 deletions.
diff --git a/README.md b/README.md
@@ -23,70 +23,66 @@ $ yarn add axios-oauth-client axios
 ### Authorization Code grant
 
 ```javascript
-const axios = require('axios');
-const oauth = require('axios-oauth-client');
+import axios from 'axios'
+import oauth from 'axios-oauth-client'
 const getAuthorizationCode = oauth.authorizationCode(
   axios.create(),
   'https://oauth.com/2.0/token', // OAuth 2.0 token endpoint
   'CLIENT_ID',
   'CLIENT_SECRET',
-  'https://your-app.com/oauth-redirect', // Redirect URL for your app
-  'AUTHORIZATION_CODE',
-  'OPTIONAL_SCOPES'
-);
+  'https://your-app.com/oauth-redirect' // Redirect URL for your app
+)
 
-const auth = await getAuthorizationCode(); // => { "access_token": "...", "expires_in": 900, ... }
+const auth = await getAuthorizationCode('AUTHORIZATION_CODE', 'OPTIONAL_SCOPES')
+// => { "access_token": "...", "expires_in": 900, ... }
 ```
 
 ### Owner Credentials grant
 
 ```javascript
-const axios = require('axios');
-const oauth = require('axios-oauth-client');
+import axios from 'axios'
+import oauth from 'axios-oauth-client'
 const getOwnerCredentials = oauth.ownerCredentials(
   axios.create(),
   'https://oauth.com/2.0/token', // OAuth 2.0 token endpoint
   'CLIENT_ID',
-  'CLIENT_SECRET',
-  'USERNAME',
-  'PASSWORD',
-  'OPTIONAL_SCOPES'
-);
+  'CLIENT_SECRET'
+)
 
-const auth = await getOwnerCredentials(); // => { "access_token": "...", "expires_in": 900, ... }
+const auth = await getOwnerCredentials('USERNAME', 'PASSWORD', 'OPTIONAL_SCOPES')
+// => { "access_token": "...", "expires_in": 900, ... }
 ```
 
 ### Client Credentials grant
 
 ```javascript
-const axios = require('axios');
-const oauth = require('axios-oauth-client');
+import axios from 'axios'
+import oauth from 'axios-oauth-client'
 const getClientCredentials = oauth.clientCredentials(
   axios.create(),
   'https://oauth.com/2.0/token',
   'CLIENT_ID',
-  'CLIENT_SECRET',
-  'OPTIONAL_SCOPES'
-});
+  'CLIENT_SECRET'
+})
 
-const auth = await getClientCredentials(); // => { "access_token": "...", "expires_in": 900, ... }
+const auth = await getClientCredentials('OPTIONAL_SCOPES')
+// => { "access_token": "...", "expires_in": 900, ... }
 ```
 
 ### Refresh Token grant
 
 ```javascript
-const axios = require('axios');
-const oauth = require('axios-oauth-client');
+import axios from 'axios'
+import oauth from 'axios-oauth-client'
 const getRefreshToken = oauth.refreshToken(
   axios.create(),
   'https://oauth.com/2.0/token',
   'CLIENT_ID',
-  'CLIENT_SECRET',
-  'REFRESH_TOKEN',
-  'OPTIONAL_SCOPES'
-);
+  'CLIENT_SECRET'
+)
 
-const auth = await getRefreshToken(); // => { "access_token": "...", "refresh_token": "...", "expires_in": 900, ... }
+const auth = await getRefreshToken('REFRESH_TOKEN', 'OPTIONAL_SCOPES')
+// => { "access_token": "...", "refresh_token": "...", "expires_in": 900, ... }
 ```
 
 ## License

diff --git a/dist/index.cjs b/dist/index.cjs
@@ -7,14 +7,16 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 const qs__default = /*#__PURE__*/_interopDefaultLegacy(qs);
 
 function oauth(axios, { url, ...credentials }) {
-  const config = {
+  return (moreCredentials = {}) => axios({
     url,
     method: "post",
-    data: qs__default.stringify(credentials)
-  };
-  return () => axios(config).then((res) => res.data);
+    data: qs__default.stringify({
+      ...credentials,
+      ...moreCredentials
+    })
+  }).then((res) => res.data);
 }
-oauth.authorizationCode = function(axios, url, client_id, client_secret, redirect_uri, code, scope = null) {
+oauth.authorizationCode = function(axios, url, client_id, client_secret, redirect_uri, code = null, scope = null) {
   return oauth(axios, {
     url,
     grant_type: "authorization_code",
@@ -25,7 +27,7 @@ oauth.authorizationCode = function(axios, url, client_id, client_secret, redirec
     scope
   });
 };
-oauth.ownerCredentials = function(axios, url, client_id, client_secret, username, password, scope = null) {
+oauth.ownerCredentials = function(axios, url, client_id, client_secret, username = null, password = null, scope = null) {
   return oauth(axios, {
     url,
     grant_type: "password",
@@ -45,7 +47,7 @@ oauth.clientCredentials = function(axios, url, client_id, client_secret, scope =
     scope
   });
 };
-oauth.refreshToken = function(axios, url, client_id, client_secret, refresh_token, scope = null) {
+oauth.refreshToken = function(axios, url, client_id, client_secret, refresh_token = null, scope = null) {
   return oauth(axios, {
     url,
     grant_type: "refresh_token",

diff --git a/dist/index.d.ts b/dist/index.d.ts
@@ -1,14 +1,16 @@
 import qs from 'qs';
 
 function oauth(axios, { url, ...credentials }) {
-  const config = {
+  return (moreCredentials = {}) => axios({
     url,
     method: "post",
-    data: qs.stringify(credentials)
-  };
-  return () => axios(config).then((res) => res.data);
+    data: qs.stringify({
+      ...credentials,
+      ...moreCredentials
+    })
+  }).then((res) => res.data);
 }
-oauth.authorizationCode = function(axios, url, client_id, client_secret, redirect_uri, code, scope = null) {
+oauth.authorizationCode = function(axios, url, client_id, client_secret, redirect_uri, code = null, scope = null) {
   return oauth(axios, {
     url,
     grant_type: "authorization_code",
@@ -19,7 +21,7 @@ oauth.authorizationCode = function(axios, url, client_id, client_secret, redirec
     scope
   });
 };
-oauth.ownerCredentials = function(axios, url, client_id, client_secret, username, password, scope = null) {
+oauth.ownerCredentials = function(axios, url, client_id, client_secret, username = null, password = null, scope = null) {
   return oauth(axios, {
     url,
     grant_type: "password",
@@ -39,7 +41,7 @@ oauth.clientCredentials = function(axios, url, client_id, client_secret, scope =
     scope
   });
 };
-oauth.refreshToken = function(axios, url, client_id, client_secret, refresh_token, scope = null) {
+oauth.refreshToken = function(axios, url, client_id, client_secret, refresh_token = null, scope = null) {
   return oauth(axios, {
     url,
     grant_type: "refresh_token",

diff --git a/dist/index.mjs b/dist/index.mjs
@@ -1,14 +1,16 @@
 import qs from 'qs';
 
 function oauth(axios, { url, ...credentials }) {
-  const config = {
+  return (moreCredentials = {}) => axios({
     url,
     method: "post",
-    data: qs.stringify(credentials)
-  };
-  return () => axios(config).then((res) => res.data);
+    data: qs.stringify({
+      ...credentials,
+      ...moreCredentials
+    })
+  }).then((res) => res.data);
 }
-oauth.authorizationCode = function(axios, url, client_id, client_secret, redirect_uri, code, scope = null) {
+oauth.authorizationCode = function(axios, url, client_id, client_secret, redirect_uri, code = null, scope = null) {
   return oauth(axios, {
     url,
     grant_type: "authorization_code",
@@ -19,7 +21,7 @@ oauth.authorizationCode = function(axios, url, client_id, client_secret, redirec
     scope
   });
 };
-oauth.ownerCredentials = function(axios, url, client_id, client_secret, username, password, scope = null) {
+oauth.ownerCredentials = function(axios, url, client_id, client_secret, username = null, password = null, scope = null) {
   return oauth(axios, {
     url,
     grant_type: "password",
@@ -39,7 +41,7 @@ oauth.clientCredentials = function(axios, url, client_id, client_secret, scope =
     scope
   });
 };
-oauth.refreshToken = function(axios, url, client_id, client_secret, refresh_token, scope = null) {
+oauth.refreshToken = function(axios, url, client_id, client_secret, refresh_token = null, scope = null) {
   return oauth(axios, {
     url,
     grant_type: "refresh_token",

diff --git a/src/index.js b/src/index.js
@@ -3,16 +3,17 @@ import qs from 'qs'
 /* eslint-disable camelcase */
 
 export default function oauth (axios, { url, ...credentials }) {
-  const config = {
+  return (moreCredentials = {}) => axios({
     url,
     method: 'post',
-    data: qs.stringify(credentials)
-  }
-
-  return () => axios(config).then(res => res.data)
+    data: qs.stringify({
+      ...credentials,
+      ...moreCredentials
+    })
+  }).then(res => res.data)
 }
 
-oauth.authorizationCode = function (axios, url, client_id, client_secret, redirect_uri, code, scope = null) {
+oauth.authorizationCode = function (axios, url, client_id, client_secret, redirect_uri, code = null, scope = null) {
   return oauth(axios, {
     url,
     grant_type: 'authorization_code',
@@ -24,7 +25,7 @@ oauth.authorizationCode = function (axios, url, client_id, client_secret, redire
   })
 }
 
-oauth.ownerCredentials = function (axios, url, client_id, client_secret, username, password, scope = null) {
+oauth.ownerCredentials = function (axios, url, client_id, client_secret, username = null, password = null, scope = null) {
   return oauth(axios, {
     url,
     grant_type: 'password',
@@ -46,7 +47,7 @@ oauth.clientCredentials = function (axios, url, client_id, client_secret, scope
   })
 }
 
-oauth.refreshToken = function (axios, url, client_id, client_secret, refresh_token, scope = null) {
+oauth.refreshToken = function (axios, url, client_id, client_secret, refresh_token = null, scope = null) {
   return oauth(axios, {
     url,
     grant_type: 'refresh_token',