Adds Shutdown. Moved docs to interfaces.

Gotrue/Constants.cs

@@ -103,7 +103,8 @@ public enum AuthState
             SignedOut,
             UserUpdated,
             PasswordRecovery,
-            TokenRefreshed
+            TokenRefreshed,
+            Shutdown
         }
 
         /// <summary>

Gotrue/DebugNotification.cs

@@ -1,6 +1,5 @@
 using System;
 using System.Collections.Generic;
-
 namespace Supabase.Gotrue
 {
 	/// <summary>

Gotrue/Exceptions/GotrueException.cs

@@ -1,6 +1,5 @@
 using System;
 using System.Net.Http;
-
 namespace Supabase.Gotrue.Exceptions
 {
 	/// <summary>

Gotrue/Helpers.cs

@@ -9,7 +9,6 @@
 using Newtonsoft.Json;
 using Supabase.Gotrue.Exceptions;
 using Supabase.Gotrue.Responses;
-
 namespace Supabase.Gotrue
 {
 	/// <summary>

Gotrue/Interfaces/IGotrueStatelessClient.cs

@@ -2,37 +2,253 @@
 using System.Threading.Tasks;
 using static Supabase.Gotrue.Constants;
 using static Supabase.Gotrue.StatelessClient;
-#pragma warning disable CS1591
 
 namespace Supabase.Gotrue.Interfaces
 {
+    /// <summary>
+    /// A Stateless Gotrue Client
+    /// </summary>
+    /// <example>
+    /// var options = new StatelessClientOptions { Url = "https://mygotrueurl.com" };
+    /// var user = await client.SignIn("user@email.com", "fancyPassword", options);
+    /// </example>
     public interface IGotrueStatelessClient<TUser, TSession>
         where TUser : User
         where TSession : Session
     {
+        /// <summary>
+        /// Create a user
+        /// </summary>
+        /// <param name="jwt">A valid JWT. Must be a full-access API key (e.g. service_role key).</param>
+        /// <param name="options"></param>
+        /// <param name="attributes"></param>
+        /// <returns></returns>
         Task<TUser?> CreateUser(string jwt, StatelessClientOptions options, AdminUserAttributes attributes);
+
+        /// <summary>
+        /// Create a user
+        /// </summary>
+        /// <param name="jwt">A valid JWT. Must be a full-access API key (e.g. service_role key).</param>
+        /// <param name="options"></param>
+        /// <param name="email"></param>
+        /// <param name="password"></param>
+        /// <param name="attributes"></param>
+        /// <returns></returns>
         Task<TUser?> CreateUser(string jwt, StatelessClientOptions options, string email, string password, AdminUserAttributes? attributes = null);
+
+        /// <summary>
+        /// Deletes a User.
+        /// </summary>
+        /// <param name="uid"></param>
+        /// <param name="jwt">this token needs role 'supabase_admin' or 'service_role'</param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         Task<bool> DeleteUser(string uid, string jwt, StatelessClientOptions options);
+
+        /// <summary>
+        /// Initialize/retrieve the underlying API for this client
+        /// </summary>
+        /// <param name="options"></param>
+        /// <returns></returns>
         IGotrueApi<TUser, TSession> GetApi(StatelessClientOptions options);
+
+        /// <summary>
+        /// Parses a <see cref="Session"/> out of a <see cref="Uri"/>'s Query parameters.
+        /// </summary>
+        /// <param name="uri"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         Task<TSession?> GetSessionFromUrl(Uri uri, StatelessClientOptions options);
+
+        /// <summary>
+        /// Get User details by JWT. Can be used to validate a JWT.
+        /// </summary>
+        /// <param name="jwt">A valid JWT. Must be a JWT that originates from a user.</param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         Task<TUser?> GetUser(string jwt, StatelessClientOptions options);
+
+        /// <summary>
+        /// Get User details by Id
+        /// </summary>
+        /// <param name="jwt">A valid JWT. Must be a full-access API key (e.g. service_role key).</param>
+        /// <param name="options"></param>
+        /// <param name="userId"></param>
+        /// <returns></returns>
         Task<TUser?> GetUserById(string jwt, StatelessClientOptions options, string userId);
+
+        /// <summary>
+        /// Sends an invite email link to the specified email.
+        /// </summary>
+        /// <param name="email"></param>
+        /// <param name="jwt">this token needs role 'supabase_admin' or 'service_role'</param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         Task<bool> InviteUserByEmail(string email, string jwt, StatelessClientOptions options);
+
+        /// <summary>
+        /// Lists users
+        /// </summary>
+        /// <param name="jwt">A valid JWT. Must be a full-access API key (e.g. service_role key).</param>
+        /// <param name="options"></param>
+        /// <param name="filter">A string for example part of the email</param>
+        /// <param name="sortBy">Snake case string of the given key, currently only created_at is supported</param>
+        /// <param name="sortOrder">asc or desc, if null desc is used</param>
+        /// <param name="page">page to show for pagination</param>
+        /// <param name="perPage">items per page for pagination</param>
+        /// <returns></returns>
         Task<UserList<User>?> ListUsers(string jwt, StatelessClientOptions options, string? filter = null, string? sortBy = null, SortOrder sortOrder = SortOrder.Descending, int? page = null, int? perPage = null);
+
+        /// <summary>
+        /// Refreshes a Token
+        /// </summary>
+        /// <returns></returns>
         Task<TSession?> RefreshToken(string refreshToken, StatelessClientOptions options);
+
+        /// <summary>
+        /// Sends a reset request to an email address.
+        /// </summary>
+        /// <param name="email"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
+        /// <exception cref="Exception"></exception>
         Task<bool> ResetPasswordForEmail(string email, StatelessClientOptions options);
+
+        /// <summary>
+        /// Sends a Magic email login link to the specified email.
+        /// </summary>
+        /// <param name="email"></param>
+        /// <param name="options"></param>
+        /// <param name="signInOptions"></param>
+        /// <returns></returns>
         Task<bool> SendMagicLink(string email, StatelessClientOptions options, SignInOptions? signInOptions = null);
+
+        /// <summary>
+        /// Retrieves a Url to redirect to for signing in with a <see cref="Provider"/>.
+        /// 
+        /// This method will need to be combined with <see cref="GetSessionFromUrl(Uri,StatelessClientOptions)"/> when the
+        /// Application receives the Oauth Callback.
+        /// </summary>
+        /// <example>
+        /// var client = Supabase.Gotrue.Client.Initialize(options);
+        /// var url = client.SignIn(Provider.Github);
+        /// 
+        /// // Do Redirect User
+        /// 
+        /// // Example code
+        /// Application.HasReceivedOauth += async (uri) => {
+        ///     var session = await client.GetSessionFromUri(uri, true);
+        /// }
+        /// </example>
+        /// <param name="provider"></param>
+        /// <param name="options"></param>
+        /// <param name="signInOptions"></param>
+        /// <returns></returns>
         ProviderAuthState SignIn(Provider provider, StatelessClientOptions options, SignInOptions? signInOptions = null);
+
+        /// <summary>
+        /// Log in an existing user, or login via a third-party provider.
+        /// </summary>
+        /// <param name="type">Type of Credentials being passed</param>
+        /// <param name="identifierOrToken">An email, phone, or RefreshToken</param>
+        /// <param name="password">Password to account (optional if `RefreshToken`)</param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         Task<TSession?> SignIn(SignInType type, string identifierOrToken, string? password = null, StatelessClientOptions? options = null);
+
+        /// <summary>
+        /// Sends a Magic email login link to the specified email.
+        /// </summary>
+        /// <param name="email"></param>
+        /// <param name="options"></param>
+        /// <param name="signInOptions"></param>
+        /// <returns></returns>
         Task<bool> SignIn(string email, StatelessClientOptions options, SignInOptions? signInOptions = null);
+
+        /// <summary>
+        /// Signs in a User with an email address and password.
+        /// </summary>
+        /// <param name="email"></param>
+        /// <param name="password"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         Task<TSession?> SignIn(string email, string password, StatelessClientOptions options);
+
+        /// <summary>
+        /// Logout a User
+        /// This will revoke all refresh tokens for the user.
+        /// JWT tokens will still be valid for stateless auth until they expire.
+        /// </summary>
+        /// <param name="jwt"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         Task<bool> SignOut(string jwt, StatelessClientOptions options);
+
+        /// <summary>
+        /// Signs up a user
+        /// </summary>
+        /// <param name="type">Type of #</param>
+        /// <param name="identifier">Phone or Email</param>
+        /// <param name="password"></param>
+        /// <param name="options"></param>
+        /// <param name="#Options">Object containing redirectTo and optional user metadata (data)</param>
+        /// <returns></returns>
         Task<TSession?> #(#Type type, string identifier, string password, StatelessClientOptions options, #Options? #Options = null);
+
+        /// <summary>
+        /// Signs up a user by email address
+        /// </summary>
+        /// <param name="email"></param>
+        /// <param name="password"></param>
+        /// <param name="options"></param>
+        /// <param name="#Options">Object containing redirectTo and optional user metadata (data)</param>
+        /// <returns></returns>
         Task<TSession?> #(string email, string password, StatelessClientOptions options, #Options? #Options = null);
+
+        /// <summary>
+        /// Updates a User's attributes
+        /// </summary>
+        /// <param name="accessToken"></param>
+        /// <param name="attributes"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         Task<TUser?> Update(string accessToken, UserAttributes attributes, StatelessClientOptions options);
+
+        /// <summary>
+        /// Update user by Id
+        /// </summary>
+        /// <param name="jwt">A valid JWT. Must be a full-access API key (e.g. service_role key).</param>
+        /// <param name="options"></param>
+        /// <param name="userId"></param>
+        /// <param name="userData"></param>
+        /// <returns></returns>
         Task<TUser?> UpdateUserById(string jwt, StatelessClientOptions options, string userId, AdminUserAttributes userData);
+
+        /// <summary>
+        /// Log in a user given a User supplied OTP received via mobile.
+        /// </summary>
+        /// <param name="phone">The user's phone number.</param>
+        /// <param name="token">Token sent to the user's phone.</param>
+        /// <param name="options"></param>
+        /// <param name="type"></param>
+        /// <returns></returns>
         Task<TSession?> VerifyOTP(string phone, string token, StatelessClientOptions options, MobileOtpType type = MobileOtpType.SMS);
+
+        /// <summary>
+        /// Log in a user give a user supplied OTP received via email.
+        /// </summary>
+        /// <param name="email"></param>
+        /// <param name="token"></param>
+        /// <param name="options"></param>
+        /// <param name="type"></param>
+        /// <returns></returns>
         Task<TSession?> VerifyOTP(string email, string token, StatelessClientOptions options, EmailOtpType type = EmailOtpType.MagicLink);
+
+        /// <summary>
+        /// Retrieve the current settings for the Gotrue instance.
+        /// </summary>
+        /// <param name="options"></param>
+        /// <returns></returns>
         Task<Settings?> Settings(StatelessClientOptions options);
     }
 }

Gotrue/NetworkStatus.cs

@@ -1,7 +1,6 @@
 using System;
 using System.Net.NetworkInformation;
 using System.Threading.Tasks;
-
 namespace Supabase.Gotrue
 {
 	/// <summary>

Gotrue/PersistenceListener.cs

@@ -1,6 +1,5 @@
 using System;
 using Supabase.Gotrue.Interfaces;
-
 namespace Supabase.Gotrue
 {
 	/// <summary>
@@ -58,6 +57,9 @@ public void EventHandler(IGotrueClient<User, Session> sender, Constants.AuthStat
 						Persistence.SaveSession(sender.CurrentSession);
 					}
 					break;
+				case Constants.AuthState.Shutdown:
+					// The session should have already been saved, so we don't need to do anything here.
+					break;
 				default: throw new ArgumentOutOfRangeException(nameof(stateChanged), stateChanged, null);
 			}
 		}

Gotrue/ProviderAuthState.cs

@@ -1,5 +1,4 @@
 using System;
-
 namespace Supabase.Gotrue
 {
     /// <summary>
@@ -19,6 +18,10 @@ public class ProviderAuthState
         /// </summary>
         public string? PKCEVerifier { get; set; }
 
+        /// <summary>
+        /// Constructor
+        /// </summary>
+        /// <param name="uri"></param>
         public ProviderAuthState(Uri uri)
         {
             Uri = uri;

Gotrue/Responses/BaseResponse.cs

@@ -1,6 +1,5 @@
 using System.Net.Http;
 using Newtonsoft.Json;
-
 namespace Supabase.Gotrue.Responses
 {
     /// <summary>

Gotrue/SignInWithPasswordlessEmailOptions.cs

@@ -57,10 +57,19 @@ public SignInWithPasswordlessEmailOptions(string email)
 	/// <inheritdoc />
 	public class SignInWithPasswordlessPhoneOptions : SignInWithPasswordlessOptions
 	{
+		/// <summary>
+		/// Represents a messaging channel to use for sending the OTP.
+		/// </summary>
 		public enum MessagingChannel
 		{
+			/// <summary>
+			/// SMS
+			/// </summary>
 			[MapTo("sms")]
 			SMS,
+			/// <summary>
+			/// 
+			/// </summary>
 			[MapTo("whatsapp")]
 			WHATSAPP
 		}

Gotrue/#Options.cs

@@ -1,5 +1,4 @@
 using System.Collections.Generic;
-
 namespace Supabase.Gotrue
 {
     /// <summary>