auth-vir 2.0.0 → 2.0.2

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

@@ -31,7 +31,7 @@ export type GetUserResult<DatabaseUser extends AnyObject> = {
  *
  * @category Internal
  */
-export type BackendAuthClientConfig<DatabaseUser extends AnyObject, UserId extends string | number, CsrfHeaderName extends string = AuthHeaderName.CsrfToken, AssumedUserParams extends JsonCompatibleObject = EmptyObject> = Readonly<{
+export type BackendAuthClientConfig<DatabaseUser extends AnyObject, UserId extends string | number, AssumedUserParams extends JsonCompatibleObject = EmptyObject, CsrfHeaderName extends string = AuthHeaderName.CsrfToken> = Readonly<{
     /** The origin of your backend that is offering auth cookies. */
     serviceOrigin: string;
     /** Finds the relevant user from your own database. */
@@ -117,10 +117,10 @@ export type BackendAuthClientConfig<DatabaseUser extends AnyObject, UserId exten
  * @category Auth : Host
  * @category Client
  */
-export declare class BackendAuthClient<DatabaseUser extends AnyObject, UserId extends string | number, CsrfHeaderName extends string = AuthHeaderName.CsrfToken, AssumedUserParams extends AnyObject = EmptyObject> {
-    protected readonly config: BackendAuthClientConfig<DatabaseUser, UserId, CsrfHeaderName, AssumedUserParams>;
+export declare class BackendAuthClient<DatabaseUser extends AnyObject, UserId extends string | number, AssumedUserParams extends AnyObject = EmptyObject, CsrfHeaderName extends string = AuthHeaderName.CsrfToken> {
+    protected readonly config: BackendAuthClientConfig<DatabaseUser, UserId, AssumedUserParams, CsrfHeaderName>;
     protected cachedParsedJwtKeys: Record<string, Readonly<JwtKeys>>;
-    constructor(config: BackendAuthClientConfig<DatabaseUser, UserId, CsrfHeaderName, AssumedUserParams>);
+    constructor(config: BackendAuthClientConfig<DatabaseUser, UserId, AssumedUserParams, CsrfHeaderName>);
     /** Get all the parameters used for cookie generation. */
     protected getCookieParams({ isSignUpCookie, }: {
         /**

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

@@ -33,6 +33,7 @@ export declare class FrontendAuthClient<AssumedUserParams extends JsonCompatible
     getCurrentCsrfToken(): Promise<string | undefined>;
     /** @returns Whether the user assuming succeeded or not. */
     assumeUser(assumedUserParams: Readonly<AssumedUserParams>): Promise<boolean>;
+    /** Gets the assumed user params stored in local storage, if any. */
     getAssumedUser(): AssumedUserParams | undefined;
     /**
      * Creates a `RequestInit` object for the `fetch` API. If you have other request init options,

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

@@ -33,6 +33,7 @@ export class FrontendAuthClient {
         (this.config.overrides?.localStorage || globalThis.localStorage).setItem(this.config.overrides?.assumedUserHeaderName || AuthHeaderName.AssumedUser, JSON.stringify(assumedUserParams));
         return true;
     }
+    /** Gets the assumed user params stored in local storage, if any. */
     getAssumedUser() {
         const rawValue = (this.config.overrides?.localStorage || globalThis.localStorage).getItem(this.config.overrides?.assumedUserHeaderName || AuthHeaderName.AssumedUser);
         if (!rawValue) {

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './auth-client/backend-auth.client.js';
+export * from './auth-client/frontend-auth.client.js';
 export * from './auth.js';
 export * from './cookie.js';
 export * from './csrf-token.js';

package/dist/index.js

@@ -1,4 +1,5 @@
 export * from './auth-client/backend-auth.client.js';
+export * from './auth-client/frontend-auth.client.js';
 export * from './auth.js';
 export * from './cookie.js';
 export * from './csrf-token.js';

package/package.json

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

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

@@ -49,8 +49,8 @@ export type GetUserResult<DatabaseUser extends AnyObject> = {
 export type BackendAuthClientConfig<
     DatabaseUser extends AnyObject,
     UserId extends string | number,
-    CsrfHeaderName extends string = AuthHeaderName.CsrfToken,
     AssumedUserParams extends JsonCompatibleObject = EmptyObject,
+    CsrfHeaderName extends string = AuthHeaderName.CsrfToken,
 > = Readonly<
     {
         /** The origin of your backend that is offering auth cookies. */
@@ -149,8 +149,8 @@ const defaultSessionIdleTimeout: Readonly<AnyDuration> = {
 export class BackendAuthClient<
     DatabaseUser extends AnyObject,
     UserId extends string | number,
-    CsrfHeaderName extends string = AuthHeaderName.CsrfToken,
     AssumedUserParams extends AnyObject = EmptyObject,
+    CsrfHeaderName extends string = AuthHeaderName.CsrfToken,
 > {
     protected cachedParsedJwtKeys: Record<string, Readonly<JwtKeys>> = {};
 
@@ -158,8 +158,8 @@ export class BackendAuthClient<
         protected readonly config: BackendAuthClientConfig<
             DatabaseUser,
             UserId,
-            CsrfHeaderName,
-            AssumedUserParams
+            AssumedUserParams,
+            CsrfHeaderName
         >,
     ) {}
 

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

@@ -74,6 +74,7 @@ export class FrontendAuthClient<AssumedUserParams extends JsonCompatibleObject =
         return true;
     }
 
+    /** Gets the assumed user params stored in local storage, if any. */
     public getAssumedUser(): AssumedUserParams | undefined {
         const rawValue = (this.config.overrides?.localStorage || globalThis.localStorage).getItem(
             this.config.overrides?.assumedUserHeaderName || AuthHeaderName.AssumedUser,

package/src/index.ts

@@ -1,4 +1,5 @@
 export * from './auth-client/backend-auth.client.js';
+export * from './auth-client/frontend-auth.client.js';
 export * from './auth.js';
 export * from './cookie.js';
 export * from './csrf-token.js';