auth-vir 2.0.3 → 2.0.4

package/dist/auth-client/frontend-auth.client.d.ts

@@ -31,8 +31,12 @@ export declare class FrontendAuthClient<AssumedUserParams extends JsonCompatible
     constructor(config?: FrontendAuthClientConfig);
     /** Wraps {@link getCurrentCsrfToken} to automatically handle wiping an invalid CSRF token. */
     getCurrentCsrfToken(): Promise<string | undefined>;
-    /** @returns Whether the user assuming succeeded or not. */
-    assumeUser(assumedUserParams: Readonly<AssumedUserParams>): Promise<boolean>;
+    /**
+     * Assume the given user. Pass `undefined` to wipe the currently assumed user.
+     *
+     * @returns Whether the assumed user setting or clearing succeeded or not.
+     */
+    assumeUser(assumedUserParams: Readonly<AssumedUserParams> | undefined): Promise<boolean>;
     /** Gets the assumed user params stored in local storage, if any. */
     getAssumedUser(): AssumedUserParams | undefined;
     /**

package/dist/auth-client/frontend-auth.client.js

@@ -25,12 +25,22 @@ export class FrontendAuthClient {
             return csrfTokenResult.csrfToken?.token;
         }
     }
-    /** @returns Whether the user assuming succeeded or not. */
+    /**
+     * Assume the given user. Pass `undefined` to wipe the currently assumed user.
+     *
+     * @returns Whether the assumed user setting or clearing succeeded or not.
+     */
     async assumeUser(assumedUserParams) {
+        const localStorage = this.config.overrides?.localStorage || globalThis.localStorage;
+        const storageKey = this.config.overrides?.assumedUserHeaderName || AuthHeaderName.AssumedUser;
+        if (!assumedUserParams) {
+            localStorage.removeItem(storageKey);
+            return true;
+        }
         if (!(await this.config.canAssumeUser?.())) {
             return false;
         }
-        (this.config.overrides?.localStorage || globalThis.localStorage).setItem(this.config.overrides?.assumedUserHeaderName || AuthHeaderName.AssumedUser, JSON.stringify(assumedUserParams));
+        localStorage.setItem(storageKey, JSON.stringify(assumedUserParams));
         return true;
     }
     /** Gets the assumed user params stored in local storage, if any. */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "auth-vir",
-    "version": "2.0.3",
+    "version": "2.0.4",
     "description": "Auth made easy and secure via JWT cookies, CSRF tokens, and password hashing helpers.",
     "keywords": [
         "auth",

package/src/auth-client/frontend-auth.client.ts

@@ -60,16 +60,28 @@ export class FrontendAuthClient<AssumedUserParams extends JsonCompatibleObject =
         }
     }
 
-    /** @returns Whether the user assuming succeeded or not. */
-    public async assumeUser(assumedUserParams: Readonly<AssumedUserParams>): Promise<boolean> {
+    /**
+     * Assume the given user. Pass `undefined` to wipe the currently assumed user.
+     *
+     * @returns Whether the assumed user setting or clearing succeeded or not.
+     */
+    public async assumeUser(
+        assumedUserParams: Readonly<AssumedUserParams> | undefined,
+    ): Promise<boolean> {
+        const localStorage = this.config.overrides?.localStorage || globalThis.localStorage;
+        const storageKey =
+            this.config.overrides?.assumedUserHeaderName || AuthHeaderName.AssumedUser;
+
+        if (!assumedUserParams) {
+            localStorage.removeItem(storageKey);
+            return true;
+        }
+
         if (!(await this.config.canAssumeUser?.())) {
             return false;
         }
 
-        (this.config.overrides?.localStorage || globalThis.localStorage).setItem(
-            this.config.overrides?.assumedUserHeaderName || AuthHeaderName.AssumedUser,
-            JSON.stringify(assumedUserParams),
-        );
+        localStorage.setItem(storageKey, JSON.stringify(assumedUserParams));
 
         return true;
     }