@abaxx_tech/v-integration-react 1.1.2-dev.1 → 1.1.2-dev.3

package/README.md

@@ -11,6 +11,7 @@
 - **Error Handling**: Comprehensive error handling and user feedback.
 - **Customizable Styling**: Full control over colors, sizes, and text with support for both Tailwind classes and hex colors.
 - **Background Authentication Service**: Automatic token management and authentication flow handling.
+- **State Reset**: Built-in functionality to reset authentication state back to initial values.
 <br/><br/>
 
 ## Installation
@@ -129,6 +130,41 @@ const MyComponent = () => {
   return <div>Not authenticated</div>;
 };
 ```
+
+### 4. Reset Authentication State
+Use the `useVerifierReset` hook to reset the authentication state back to initial values:
+
+```ts
+import { useVerifierReset } from "@abaxx_tech/v-integration-react";
+
+const LogoutButton = () => {
+  const resetState = useVerifierReset();
+  
+  const handleLogout = () => {
+    resetState(); // Resets all authentication state to initial values
+  };
+  
+  return (
+    <button onClick={handleLogout}>
+      Logout & Reset
+    </button>
+  );
+};
+
+export default LogoutButton;
+```
+
+**What gets reset:**
+- `identity` → `""`
+- `authRequestId` → `""`
+- `isAuthenticating` → `false`
+- `codeVerifier` → `""`
+- `codeChallenge` → `""`
+- `authCode` → `""`
+- `authRequestIdExpires` → `new Date()`
+- `token` → `null`
+- `authError` → `null`
+
 <br/><br/>
 
 ## Components
@@ -237,6 +273,31 @@ The authentication context provides access to all authentication-related state a
 | `authCode` | `string` | Authorization code from successful auth |
 | `token` | `string \| null` | Authentication token |
 | `authError` | `string \| null` | Authentication error message |
+| `resetState` | `() => void` | Function to reset all state to initial values |
+
+### Reset Functionality
+The library provides a built-in reset function to clear all authentication state:
+
+```ts
+import { useContext } from 'react';
+import { VContext, useVerifierReset } from "@abaxx_tech/v-integration-react";
+
+const MyComponent = () => {
+  const { resetState: resetStateFromContext } = useContext(VContext);
+  const resetState = useVerifierReset();
+
+  return (
+    <>
+      <button onClick={resetStateFromContext}>
+        Reset Authentication from context
+      </button>
+      <button onClick={resetState}>
+        Reset Authentication
+      </button>
+    </>
+  );
+};
+```
 
 ## Authentication Flow
 

package/dist/v-integration-react.d.ts

@@ -7,6 +7,10 @@ declare type Props = {
     children: ReactNode;
 };
 
+export declare function resetVerifierStateUnsafe(ctx: default_2.ContextType<typeof VContext>): void;
+
+export declare function useVerifierReset(): () => void;
+
 export declare const VContext: default_2.Context<VContextObj>;
 
 export declare type VContextObj = {
@@ -30,6 +34,7 @@ export declare type VContextObj = {
     setToken: default_2.Dispatch<default_2.SetStateAction<string | null>>;
     authError: string | null;
     setAuthError: default_2.Dispatch<default_2.SetStateAction<string | null>>;
+    resetState: () => void;
 };
 
 export declare const VContextProvider: default_2.FC<Props>;