feat(gotrue): add scope to signOut (#530)

* feat(gotrue): add scope to signOut * fix: always remove session * Update packages/gotrue/lib/src/constants.dart Co-authored-by: Tyler <18113850+dshukertjr@users.noreply.github.com> * fix: typo --------- Co-authored-by: Tyler <18113850+dshukertjr@users.noreply.github.com>
supabase · Jul 5, 2023 · 94a1cce · 94a1cce
1 parent 0a37cd4
commit 94a1cce
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 7 deletions.
diff --git a/packages/gotrue/lib/src/constants.dart b/packages/gotrue/lib/src/constants.dart
@@ -56,3 +56,12 @@ enum OtpType {
   recovery,
   emailChange
 }
+
+///Determines which sessions should be logged out.
+///
+///[global] means all sessions by this account will be signed out.
+///
+///[local] means only this session will be signed out.
+///
+///[others] means all other sessions except the current one will be signed out. When using others, there is no [AuthChangeEvent.signedOut] event fired on the current session!
+enum SignOutScope { global, local, others }
diff --git a/packages/gotrue/lib/src/gotrue_admin_api.dart b/packages/gotrue/lib/src/gotrue_admin_api.dart
@@ -1,4 +1,5 @@
 import 'package:gotrue/gotrue.dart';
+import 'package:gotrue/src/constants.dart';
 import 'package:gotrue/src/fetch.dart';
 import 'package:gotrue/src/types/auth_response.dart';
 import 'package:gotrue/src/types/fetch_options.dart';
@@ -28,9 +29,17 @@ class GoTrueAdminApi {
   }
 
   /// Removes a logged-in session.
-  Future<void> signOut(String jwt) async {
-    final options =
-        GotrueRequestOptions(headers: _headers, noResolveJson: true, jwt: jwt);
+  Future<void> signOut(
+    String jwt, {
+    SignOutScope scope = SignOutScope.global,
+  }) async {
+    final options = GotrueRequestOptions(
+      headers: _headers,
+      noResolveJson: true,
+      jwt: jwt,
+      query: {'scope': scope.name},
+    );
+
     await _fetch.request(
       '$_url/logout',
       RequestMethodType.post,

diff --git a/packages/gotrue/lib/src/gotrue_client.dart b/packages/gotrue/lib/src/gotrue_client.dart
@@ -618,13 +618,23 @@ class GoTrueClient {
   }
 
   /// Signs out the current user, if there is a logged in user.
-  Future<void> signOut() async {
+  ///
+  /// If using [SignOutScope.others] scope, no [AuthChangeEvent.signedOut] event is fired!
+  Future<void> signOut({
+    SignOutScope scope = SignOutScope.global,
+  }) async {
     final accessToken = currentSession?.accessToken;
-    _removeSession();
-    _notifyAllSubscribers(AuthChangeEvent.signedOut);
+
+    if (scope != SignOutScope.others) {
+      _removeSession();
+      await _asyncStorage?.removeItem(
+          key: '${Constants.defaultStorageKey}-code-verifier');
+      _notifyAllSubscribers(AuthChangeEvent.signedOut);
+    }
+
     if (accessToken != null) {
       try {
-        await admin.signOut(accessToken);
+        await admin.signOut(accessToken, scope: scope);
       } on AuthException catch (error) {
         // ignore 401s since an invalid or expired JWT should sign out the current session
         // ignore 404s since user might not exist anymore