auth-vir 2.3.5 → 2.3.7

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

@@ -99,7 +99,7 @@ export type BackendAuthClientConfig<DatabaseUser extends AnyObject, UserId exten
      * How long before a user's session times out when we should start trying to refresh their
      * session.
      *
-     * @default {minutes: 5}
+     * @default {minutes: 10}
      */
     sessionRefreshThreshold: Readonly<AnyDuration>;
     overrides: PartialWithUndefined<{

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

@@ -7,6 +7,9 @@ import { parseJwtKeys } from '../jwt/jwt-keys.js';
 const defaultSessionIdleTimeout = {
     minutes: 20,
 };
+const defaultSessionRefreshThreshold = {
+    minutes: 10,
+};
 /**
  * An auth client for creating and validating JWTs embedded in cookies. This should only be used in
  * a backend environment as it accesses native Node packages.
@@ -72,9 +75,7 @@ export class BackendAuthClient {
          * - Z = JWT expiration outside the refresh threshold: {@link isRefreshReady} = false.
          */
         const isRefreshReady = isDateAfter({
-            fullDate: calculateRelativeDate(now, this.config.sessionRefreshThreshold || {
-                minutes: 5,
-            }),
+            fullDate: calculateRelativeDate(now, this.config.sessionRefreshThreshold || defaultSessionRefreshThreshold),
             relativeTo: userIdResult.jwtExpiration,
         });
         if (isRefreshReady) {

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

@@ -1,4 +1,4 @@
-import { createBlockingInterval, type JsonCompatibleObject, type MaybePromise, type PartialWithUndefined, type SelectFrom } from '@augment-vir/common';
+import { type createBlockingInterval, type JsonCompatibleObject, type MaybePromise, type PartialWithUndefined, type SelectFrom } from '@augment-vir/common';
 import { type AnyDuration } from 'date-vir';
 import { type EmptyObject } from 'type-fest';
 /**
@@ -26,12 +26,19 @@ export type FrontendAuthClientConfig = PartialWithUndefined<{
          *
          * If the user is not currently authorized, this should return `undefined` to prevent
          * unnecessary network traffic.
+         *
+         * This will be called any time the user interacts with the page, debounced by the adjacent
+         * `debounce` property.
          */
         performCheck: () => MaybePromise<SelectFrom<Response, {
             status: true;
         }> | undefined>;
-        /** @default {minutes: 1} */
-        interval?: AnyDuration | undefined;
+        /**
+         * Debounce for firing `performCheck`.
+         *
+         * @default {minutes: 1}
+         */
+        debounce?: AnyDuration | undefined;
     };
     overrides: PartialWithUndefined<{
         localStorage: Pick<Storage, 'setItem' | 'removeItem' | 'getItem'>;

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

@@ -1,4 +1,5 @@
-import { createBlockingInterval, HttpStatus, } from '@augment-vir/common';
+import { HttpStatus, } from '@augment-vir/common';
+import { listenToActivity } from 'detect-activity';
 import { CsrfTokenFailureReason, extractCsrfTokenHeader, getCurrentCsrfToken, storeCsrfToken, wipeCurrentCsrfToken, } from '../csrf-token.js';
 import { AuthHeaderName } from '../headers.js';
 /**
@@ -14,14 +15,18 @@ export class FrontendAuthClient {
     constructor(config = {}) {
         this.config = config;
         if (config.checkUser) {
-            this.userCheckInterval = createBlockingInterval(async () => {
-                const response = await config.checkUser?.performCheck();
-                if (response) {
-                    await this.verifyResponseAuth({
-                        status: response.status,
-                    });
-                }
-            }, config.checkUser.interval || { minutes: 1 });
+            listenToActivity({
+                listener: async () => {
+                    const response = await config.checkUser?.performCheck();
+                    if (response) {
+                        await this.verifyResponseAuth({
+                            status: response.status,
+                        });
+                    }
+                },
+                debounce: config.checkUser.debounce || { minutes: 5 },
+                fireImmediately: false,
+            });
         }
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "auth-vir",
-    "version": "2.3.5",
+    "version": "2.3.7",
     "description": "Auth made easy and secure via JWT cookies, CSRF tokens, and password hashing helpers.",
     "keywords": [
         "auth",
@@ -45,6 +45,7 @@
         "@augment-vir/assert": "^31.47.0",
         "@augment-vir/common": "^31.47.0",
         "date-vir": "^8.0.0",
+        "detect-activity": "^0.0.1",
         "hash-wasm": "^4.12.0",
         "jose": "^6.1.0",
         "object-shape-tester": "^6.9.3",

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

@@ -123,7 +123,7 @@ export type BackendAuthClientConfig<
          * How long before a user's session times out when we should start trying to refresh their
          * session.
          *
-         * @default {minutes: 5}
+         * @default {minutes: 10}
          */
         sessionRefreshThreshold: Readonly<AnyDuration>;
         overrides: PartialWithUndefined<{
@@ -137,6 +137,10 @@ const defaultSessionIdleTimeout: Readonly<AnyDuration> = {
     minutes: 20,
 };
 
+const defaultSessionRefreshThreshold: Readonly<AnyDuration> = {
+    minutes: 10,
+};
+
 /**
  * An auth client for creating and validating JWTs embedded in cookies. This should only be used in
  * a backend environment as it accesses native Node packages.
@@ -245,9 +249,7 @@ export class BackendAuthClient<
         const isRefreshReady = isDateAfter({
             fullDate: calculateRelativeDate(
                 now,
-                this.config.sessionRefreshThreshold || {
-                    minutes: 5,
-                },
+                this.config.sessionRefreshThreshold || defaultSessionRefreshThreshold,
             ),
             relativeTo: userIdResult.jwtExpiration,
         });

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

@@ -1,5 +1,5 @@
 import {
-    createBlockingInterval,
+    type createBlockingInterval,
     HttpStatus,
     type JsonCompatibleObject,
     type MaybePromise,
@@ -7,6 +7,7 @@ import {
     type SelectFrom,
 } from '@augment-vir/common';
 import {type AnyDuration} from 'date-vir';
+import {listenToActivity} from 'detect-activity';
 import {type EmptyObject} from 'type-fest';
 import {
     CsrfTokenFailureReason,
@@ -43,6 +44,9 @@ export type FrontendAuthClientConfig = PartialWithUndefined<{
          *
          * If the user is not currently authorized, this should return `undefined` to prevent
          * unnecessary network traffic.
+         *
+         * This will be called any time the user interacts with the page, debounced by the adjacent
+         * `debounce` property.
          */
         performCheck: () => MaybePromise<
             | SelectFrom<
@@ -53,8 +57,12 @@ export type FrontendAuthClientConfig = PartialWithUndefined<{
               >
             | undefined
         >;
-        /** @default {minutes: 1} */
-        interval?: AnyDuration | undefined;
+        /**
+         * Debounce for firing `performCheck`.
+         *
+         * @default {minutes: 1}
+         */
+        debounce?: AnyDuration | undefined;
     };
 
     overrides: PartialWithUndefined<{
@@ -76,8 +84,8 @@ export class FrontendAuthClient<AssumedUserParams extends JsonCompatibleObject =
 
     constructor(protected readonly config: FrontendAuthClientConfig = {}) {
         if (config.checkUser) {
-            this.userCheckInterval = createBlockingInterval(
-                async () => {
+            listenToActivity({
+                listener: async () => {
                     const response = await config.checkUser?.performCheck();
 
                     if (response) {
@@ -86,8 +94,9 @@ export class FrontendAuthClient<AssumedUserParams extends JsonCompatibleObject =
                         });
                     }
                 },
-                config.checkUser.interval || {minutes: 1},
-            );
+                debounce: config.checkUser.debounce || {minutes: 5},
+                fireImmediately: false,
+            });
         }
     }