Merge pull request #951 from lens-protocol/feat/get-client-refresh-token

feat: adds client.authentication.getRefreshToken() method

.changeset/yellow-turkeys-appear.md

@@ -0,0 +1,5 @@
+---
+"@lens-protocol/client": patch
+---
+
+**feat:** adds `client.authentication.getRefreshToken()` method.

packages/client/src/authentication/Authentication.ts

@@ -112,6 +112,31 @@ export class Authentication implements IAuthentication {
     return failure(new CredentialsExpiredError());
   }
 
+  async getRefreshToken(): PromiseResult<string, CredentialsExpiredError | NotAuthenticatedError> {
+    const credentials = await this.credentials.get();
+
+    if (!credentials) {
+      return failure(new NotAuthenticatedError());
+    }
+
+    if (!credentials.shouldRefresh()) {
+      return success(credentials.refreshToken);
+    }
+
+    if (credentials.canRefresh()) {
+      const newCredentials = await this.api.refresh(credentials.refreshToken);
+      await this.credentials.set(newCredentials);
+
+      if (!newCredentials.refreshToken) {
+        return failure(new CredentialsExpiredError());
+      }
+
+      return success(newCredentials.refreshToken);
+    }
+
+    return failure(new CredentialsExpiredError());
+  }
+
   async getIdentityToken(): PromiseResult<string, CredentialsExpiredError | NotAuthenticatedError> {
     const credentials = await this.credentials.get();
 

packages/client/src/authentication/IAuthentication.ts

@@ -81,14 +81,21 @@ export interface IAuthentication {
   isAuthenticated(): Promise<boolean>;
 
   /**
-   * Get the access token. If it expired, try to refresh it.
+   * Get the access token.
    *
    * @returns A Result with the access token or possible error scenarios
    */
   getAccessToken(): PromiseResult<string, CredentialsExpiredError | NotAuthenticatedError>;
 
   /**
-   * Get the identity token. If it expired, try to refresh it.
+   * Get the refresh token.
+   *
+   * @returns A Result with the refresh token or possible error scenarios
+   */
+  getRefreshToken(): PromiseResult<string, CredentialsExpiredError | NotAuthenticatedError>;
+
+  /**
+   * Get the identity token.
    *
    * @returns A Result with the identity token or possible error scenarios
    */