feat: added getter & setter methods for access token, refresh

Author: aman19K

lib/core/oauthHandler.js

@@ -1,3 +1,5 @@
+import errorFormatter from './contentstackError';
+
 /**
  * @description OAuthHandler class to handle OAuth authorization and token management
  * @class OAuthHandler
@@ -61,8 +63,8 @@ export default class OAuthHandler {
       const base64String = btoa(String.fromCharCode(...hashArray));
       return base64String.replace(/\+/g, '-').replace(/\//g, '_').replace(/=+$/, ''); // URL-safe Base64
     } else {
-    // In Node.js: Use the native `crypto` module for hashing
-      const crypto = require('crypto'); 
+      // In Node.js: Use the native `crypto` module for hashing
+      const crypto = require('crypto');
 
       const hash = crypto.createHash('sha256');
       hash.update(codeVerifier);
@@ -71,8 +73,8 @@ export default class OAuthHandler {
       // Convert to Base64 and URL-safe Base64
       let base64String = hashBuffer.toString('base64');
       return base64String.replace(/\+/g, '-').replace(/\//g, '_').replace(/=+$/, ''); // URL-safe Base64
-    } 
-}
+    }
+  }
 
   /**
    * @description Authorize the user by redirecting to the OAuth provider's authorization page
@@ -86,18 +88,22 @@ export default class OAuthHandler {
    * const authUrl = await oauthHandler.authorize();
    */
   async authorize() {
-    const baseUrl = `${this.OAuthBaseURL}/#!/apps/${this.appId}/authorize`;
-    const authUrl = new URL(baseUrl);
-    authUrl.searchParams.set('response_type', 'code'); // Using set() to avoid duplicate parameters
-    authUrl.searchParams.set('client_id', this.clientId);
-    if (this.clientSecret) {
-      return authUrl.toString();
-    } else {
-      // PKCE flow: add code_challenge to the authorization URL
-      this.codeChallenge = await this.generateCodeChallenge(this.codeVerifier);
-      authUrl.searchParams.set('code_challenge', this.codeChallenge);
-      authUrl.searchParams.set('code_challenge_method', 'S256');
-      return authUrl.toString();
+    try {
+      const baseUrl = `${this.OAuthBaseURL}/#!/apps/${this.appId}/authorize`;
+      const authUrl = new URL(baseUrl);
+      authUrl.searchParams.set('response_type', 'code'); // Using set() to avoid duplicate parameters
+      authUrl.searchParams.set('client_id', this.clientId);
+      if (this.clientSecret) {
+        return authUrl.toString();
+      } else {
+        // PKCE flow: add code_challenge to the authorization URL
+        this.codeChallenge = await this.generateCodeChallenge(this.codeVerifier);
+        authUrl.searchParams.set('code_challenge', this.codeChallenge);
+        authUrl.searchParams.set('code_challenge_method', 'S256');
+        return authUrl.toString();
+      }
+    } catch (error) {
+      errorFormatter(error);
     }
   }
 
@@ -125,14 +131,11 @@ export default class OAuthHandler {
     this.axiosInstance.defaults.headers = this._getHeaders();
     try {
       const response = await this.axiosInstance.post(`${this.OAuthBaseURL}/apps-api/apps/token`, body);
-      if (response.status !== 200) {
-        throw new Error('Failed to exchange authorization code for token');
-      }
 
       this._saveTokens(response.data);
       return response.data;
     } catch (error) {
-      throw new Error('Failed to exchange authorization code for token:', error);
+      errorFormatter(error);
     }
   }
 
@@ -176,17 +179,13 @@ export default class OAuthHandler {
     try {
       const response = await this.axiosInstance.post(`${this.developerHubBaseUrl}/apps/token`, body);
 
-      if (response.status !== 200) {
-        throw new Error(`Failed to refresh access token. Status: ${response.status}`);
-      }
-
       const data = response.data;
       this.axiosInstance.oauth.accessToken = data.access_token;
       this.axiosInstance.oauth.refreshToken = data.refresh_token || this.axiosInstance.oauth.refreshToken; // Optionally update refresh token
       this.axiosInstance.oauth.tokenExpiryTime = Date.now() + (data.expires_in - 60) * 1000; // Update expiry time
       return data;
     } catch (error) {
-      throw new Error('Failed to refresh access token:', error);
+      errorFormatter(error);
     }
   }
 
@@ -206,13 +205,10 @@ export default class OAuthHandler {
     try {
       const authorizationId = await this.getOauthAppAuthorization();
       await this.revokeOauthAppAuthorization(authorizationId);
-      this.axiosInstance.oauth.accessToken = null;
-      this.axiosInstance.oauth.refreshToken = null;
-      this.axiosInstance.oauth.tokenExpiryTime = null;
-      delete this.axiosInstance.oauth;
+      this.axiosInstance.oauth = {}; // Clear OAuth data
       return 'Logged out successfully';
     } catch (error) {
-      throw new Error('Failed to log out:', error);
+      errorFormatter(error);
     }
   }
 
@@ -231,6 +227,156 @@ export default class OAuthHandler {
     return this.axiosInstance.oauth.accessToken;
   }
 
+  /**
+   * @description Get the refresh token from the axios instance
+   * @memberof OAuthHandler
+   * @func getRefreshToken
+   * @returns {string|null}
+   * @example
+   * import * as contentstack from '@contentstack/management'
+   * const client = contentstack.client();
+   * const oauthHandler = client.oauth({ appId: 'appId', clientId: 'clientId', redirectUri: 'http://localhost:8184' });
+   * const refreshToken = oauthHandler.getRefreshToken();
+   */
+  getRefreshToken() {
+    return this.axiosInstance.oauth.refreshToken || null;
+  }
+
+  /**
+   * @description Get the organization UID from the axios instance
+   * @memberof OAuthHandler
+   * @func getOrganizationUID
+   * @returns {string|null}
+   * @example
+   * import * as contentstack from '@contentstack/management'
+   * const client = contentstack.client();
+   * const oauthHandler = client.oauth({ appId: 'appId', clientId: 'clientId', redirectUri: 'http://localhost:8184' });
+   * const orgUID = oauthHandler.getOrganizationUID();
+   */
+  getOrganizationUID() {
+    return this.axiosInstance.oauth.organizationUID || null;
+  }
+
+  /**
+   * @description Get the user UID from the axios instance
+   * @memberof OAuthHandler
+   * @func getUserUID
+   * @returns {string|null}
+   * @example
+   * import * as contentstack from '@contentstack/management'
+   * const client = contentstack.client();
+   * const oauthHandler = client.oauth({ appId: 'appId', clientId: 'clientId', redirectUri: 'http://localhost:8184' });
+   * const userId = oauthHandler.getUserUID();
+   */
+  getUserUID() {
+    return this.axiosInstance.oauth.userUID || null;
+  }
+
+  /**
+   * @description Get the token expiry time from the axios instance
+   * @memberof OAuthHandler
+   * @func getTokenExpiryTime
+   * @returns {number|null}
+   * @example
+   * import * as contentstack from '@contentstack/management'
+   * const client = contentstack.client();
+   * const oauthHandler = client.oauth({ appId: 'appId', clientId: 'clientId', redirectUri: 'http://localhost:8184' });
+   * const expiryTime = oauthHandler.getTokenExpiryTime();
+   */
+  getTokenExpiryTime() {
+    return this.axiosInstance.oauth.tokenExpiryTime || null;
+  }
+
+  /**
+   * @description Set the access token in the axios instance
+   * @memberof OAuthHandler
+   * @func setAccessToken
+   * @param {*} token
+   * @example
+   * import * as contentstack from '@contentstack/management'
+   * const client = contentstack.client();
+   * const oauthHandler = client.oauth({ appId: 'appId', clientId: 'clientId', redirectUri: 'http://localhost:8184' });
+   * oauthHandler.setAccessToken('accessToken');
+   */
+  setAccessToken(token) {
+    if (!token) {
+      throw new Error('Access token is required');
+    }
+    this.axiosInstance.oauth.accessToken = token;
+  }
+
+  /**
+   * @description Set the refresh token in the axios instance
+   * @memberof OAuthHandler
+   * @func setRefreshToken
+   * @param {*} token
+   * @example
+   * import * as contentstack from '@contentstack/management'
+   * const client = contentstack.client();
+   * const oauthHandler = client.oauth({ appId: 'appId', clientId: 'clientId', redirectUri: 'http://localhost:8184' });
+   * oauthHandler.setRefreshToken('refreshToken');
+   */
+  setRefreshToken(token) {
+    if (!token) {
+      throw new Error('Refresh token is required');
+    }
+    this.axiosInstance.oauth.refreshToken = token;
+  }
+
+  /**
+   * @description Set the organization UID in the axios instance
+   * @memberof OAuthHandler
+   * @func setOrganizationUID
+   * @param {*} organizationUID
+   * @example
+   * import * as contentstack from '@contentstack/management'
+   * const client = contentstack.client();
+   * const oauthHandler = client.oauth({ appId: 'appId', clientId: 'clientId', redirectUri: 'http://localhost:8184' });
+   * oauthHandler.setOrganizationUID('organizationUID');
+   */
+  setOrganizationUID(organizationUID) {
+    if (!organizationUID) {
+      throw new Error('Organization UID is required');
+    }
+    this.axiosInstance.oauth.organizationUID = organizationUID;
+  }
+
+  /**
+   * @description Set the user UID in the axios instance
+   * @memberof OAuthHandler
+   * @func setUserUID
+   * @param {*} userUID
+   * @example
+   * import * as contentstack from '@contentstack/management'
+   * const client = contentstack.client();
+   * const oauthHandler = client.oauth({ appId: 'appId', clientId: 'clientId', redirectUri: 'http://localhost:8184' });
+   * oauthHandler.setUserUID('userID');
+   */
+  setUserUID(userUID) {
+    if (!userUID) {
+      throw new Error('User UID is required');
+    }
+    this.axiosInstance.oauth.userUID = userUID;
+  }
+
+  /**
+   * @description Set the token expiry time in the axios instance
+   * @memberof OAuthHandler
+   * @func setTokenExpiryTime
+   * @param {*} expiryTime
+   * @example
+   * import * as contentstack from '@contentstack/management'
+   * const client = contentstack.client();
+   * const oauthHandler = client.oauth({ appId: 'appId', clientId: 'clientId', redirectUri: 'http://localhost:8184' });
+   * oauthHandler.setTokenExpiryTime('expiryTime'); // date format
+   */
+  setTokenExpiryTime(expiryTime) {
+    if (!expiryTime) {
+      throw new Error('Token expiry time is required');
+    }
+    this.axiosInstance.oauth.tokenExpiryTime = expiryTime;
+  }
+
   /**
    * @description Handles the redirect URL after OAuth authorization
    * @memberof OAuthHandler
@@ -253,7 +399,7 @@ export default class OAuthHandler {
       try {
         await this.exchangeCodeForToken(code);
       } catch (error) {
-        throw new Error('OAuth Authentication failed:', error);
+        errorFormatter(error);
       }
     } else {
       throw new Error('Authorization code not found in redirect URL.');
@@ -291,7 +437,7 @@ export default class OAuthHandler {
         throw new Error('No authorizations found for the app!');
       }
     } catch (error) {
-      throw new Error('Failed to get authorizations:', error);
+      errorFormatter(error);
     }
   }
 
@@ -318,7 +464,7 @@ export default class OAuthHandler {
 
         return res.data;
       } catch (error) {
-        throw new Error('Failed to revoke authorization:', error);
+        errorFormatter(error);
       }
     }
   }