auth-vir 2.3.5 → 2.3.6

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.js

@@ -1,4 +1,5 @@
 import { createBlockingInterval, HttpStatus, } from '@augment-vir/common';
+import { isPageActive } from 'page-active';
 import { CsrfTokenFailureReason, extractCsrfTokenHeader, getCurrentCsrfToken, storeCsrfToken, wipeCurrentCsrfToken, } from '../csrf-token.js';
 import { AuthHeaderName } from '../headers.js';
 /**
@@ -15,6 +16,10 @@ export class FrontendAuthClient {
         this.config = config;
         if (config.checkUser) {
             this.userCheckInterval = createBlockingInterval(async () => {
+                if (!isPageActive()) {
+                    /** Do not refresh the user when the page is inactive. */
+                    return;
+                }
                 const response = await config.checkUser?.performCheck();
                 if (response) {
                     await this.verifyResponseAuth({

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "auth-vir",
-    "version": "2.3.5",
+    "version": "2.3.6",
     "description": "Auth made easy and secure via JWT cookies, CSRF tokens, and password hashing helpers.",
     "keywords": [
         "auth",
@@ -48,6 +48,7 @@
         "hash-wasm": "^4.12.0",
         "jose": "^6.1.0",
         "object-shape-tester": "^6.9.3",
+        "page-active": "^1.0.3",
         "type-fest": "^5.1.0",
         "url-vir": "^2.1.6"
     },

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

@@ -7,6 +7,7 @@ import {
     type SelectFrom,
 } from '@augment-vir/common';
 import {type AnyDuration} from 'date-vir';
+import {isPageActive} from 'page-active';
 import {type EmptyObject} from 'type-fest';
 import {
     CsrfTokenFailureReason,
@@ -78,6 +79,10 @@ export class FrontendAuthClient<AssumedUserParams extends JsonCompatibleObject =
         if (config.checkUser) {
             this.userCheckInterval = createBlockingInterval(
                 async () => {
+                    if (!isPageActive()) {
+                        /** Do not refresh the user when the page is inactive. */
+                        return;
+                    }
                     const response = await config.checkUser?.performCheck();
 
                     if (response) {