Merge pull request #67 from Yoshify/feat/optional-commit-on-refresh

feat: allow the ability to refreshTokens without also committing them to the session

Author: DanielRivers

lib/sdk/oauth2-flows/AuthCodeAbstract.ts

@@ -88,10 +88,12 @@ export abstract class AuthCodeAbstract {
    * Abstract method will implement logic in child classes for refreshing access token
    * using refresh token available in current session.
    * @param {SessionManager} sessionManager
+   * @param {boolean} [commitToSession=true] - Optional parameter, determines whether to commit the refreshed tokens to the session. Defaults to true.
    * @returns {Promise<OAuth2CodeExchangeResponse>}
    */
   public abstract refreshTokens(
-    sessionManager: SessionManager
+    sessionManager: SessionManager,
+    commitToSession?: boolean
   ): Promise<OAuth2CodeExchangeResponse>;
 
   /**

lib/sdk/oauth2-flows/AuthCodeWithPKCE.ts

@@ -69,10 +69,12 @@ export class AuthCodeWithPKCE extends AuthCodeAbstract {
    * `AuthCodeAbstract` parent class, see corresponding comment in parent class for
    * further explanation.
    * @param {SessionManager} sessionManager
+   * @param {boolean} [commitToSession=true] - Optional parameter, determines whether to commit the refreshed tokens to the session. Defaults to true.
    * @returns {Promise<OAuth2CodeExchangeResponse>}
    */
   public async refreshTokens(
-    sessionManager: SessionManager
+    sessionManager: SessionManager,
+    commitToSession: boolean = true
   ): Promise<OAuth2CodeExchangeResponse> {
     const refreshToken = await utilities.getRefreshToken(sessionManager);
     const body = new URLSearchParams({
@@ -82,11 +84,13 @@ export class AuthCodeWithPKCE extends AuthCodeAbstract {
     });
 
     const tokens = await this.fetchTokensFor(sessionManager, body, true);
-    await utilities.commitTokensToSession(
-      sessionManager,
-      tokens,
-      this.tokenValidationDetails
-    );
+    if (commitToSession) {
+      await utilities.commitTokensToSession(
+        sessionManager,
+        tokens,
+        this.tokenValidationDetails
+      );
+    }
     return tokens;
   }
 

lib/sdk/oauth2-flows/AuthorizationCode.ts

@@ -54,10 +54,12 @@ export class AuthorizationCode extends AuthCodeAbstract {
    * `AuthCodeAbstract` parent class, see corresponding comment in parent class for
    * further explanation.
    * @param {SessionManager} sessionManager
+   * @param {boolean} [commitToSession=true] - Optional parameter, determines whether to commit the refreshed tokens to the session. Defaults to true.
    * @returns {Promise<OAuth2CodeExchangeResponse>}
    */
   public async refreshTokens(
-    sessionManager: SessionManager
+    sessionManager: SessionManager,
+    commitToSession: boolean = true
   ): Promise<OAuth2CodeExchangeResponse> {
     const refreshToken = await utilities.getRefreshToken(sessionManager);
 
@@ -73,11 +75,13 @@ export class AuthorizationCode extends AuthCodeAbstract {
     });
 
     const tokens = await this.fetchTokensFor(sessionManager, body);
-    await utilities.commitTokensToSession(
-      sessionManager,
-      tokens,
-      this.tokenValidationDetails
-    );
+    if (commitToSession) {
+      await utilities.commitTokensToSession(
+        sessionManager,
+        tokens,
+        this.tokenValidationDetails
+      );
+    }
     return tokens;
   }