oidc-spa 8.2.8 → 8.2.10

package/src/core/persistedAuthState.ts

@@ -1,5 +1,6 @@
 import { typeGuard } from "../tools/tsafe/typeGuard";
 import { id } from "../tools/tsafe/id";
+import { INFINITY_TIME } from "../tools/INFINITY_TIME";
 
 function getKey(params: { configId: string }) {
     const { configId } = params;
@@ -82,10 +83,16 @@ export function persistAuthState(params: {
                                         return Date.now() + idleSessionLifetimeInSeconds * 1000;
                                     })();
 
-                                    return Math.min(
-                                        untilTime_real ?? Number.POSITIVE_INFINITY,
-                                        unitTime_userOverwrite ?? Number.POSITIVE_INFINITY
+                                    const untilTime = Math.min(
+                                        untilTime_real ?? INFINITY_TIME,
+                                        unitTime_userOverwrite ?? INFINITY_TIME
                                     );
+
+                                    if (untilTime === INFINITY_TIME) {
+                                        return undefined;
+                                    }
+
+                                    return untilTime;
                                 })()
                             });
                         case "explicitly logged out":

package/src/react-spa/createOidcSpaApi.tsx

@@ -46,7 +46,7 @@ export function createOidcSpaApi<
         }
         assert<Equals<typeof paramsOfBootstrap.implementation, "real">>;
 
-        const { startCountdownSecondsBeforeAutoLogout = 45 } = paramsOfBootstrap;
+        const { warnUserSecondsBeforeAutoLogout = 45 } = paramsOfBootstrap;
 
         if (
             oidcCoreOrInitializationError === undefined ||
@@ -69,7 +69,7 @@ export function createOidcSpaApi<
                     };
                 }
 
-                if (secondsLeft > startCountdownSecondsBeforeAutoLogout) {
+                if (secondsLeft > warnUserSecondsBeforeAutoLogout) {
                     return {
                         shouldDisplayWarning: false
                     };

package/src/react-spa/types.tsx

@@ -158,7 +158,7 @@ export namespace ParamsOfBootstrap {
          * This is a server policy (that can be overwrote by idleSessionLifetimeInSeconds)
          * See: https://docs.oidc-spa.dev/v/v8/auto-logout
          */
-        startCountdownSecondsBeforeAutoLogout?: number;
+        warnUserSecondsBeforeAutoLogout?: number;
         /**
          * This parameter defines after how many seconds of inactivity the user should be
          * logged out automatically.

package/src/tanstack-start/react/createOidcSpaApi.tsx

@@ -31,6 +31,7 @@ import { getRequest, setResponseHeader, setResponseStatus } from "@tanstack/reac
 import { toFullyQualifiedUrl } from "../../tools/toFullyQualifiedUrl";
 import { UnifiedClientRetryForSsrLoadersError } from "./rfcUnifiedClientRetryForSsrLoaders/UnifiedClientRetryForSsrLoadersError";
 import { setDesiredPostLoginRedirectUrl } from "../../core/desiredPostLoginRedirectUrl";
+import type { MaybeAsync } from "../../tools/MaybeAsync";
 
 export function createOidcSpaApi<
     AutoLogin extends boolean,
@@ -77,7 +78,7 @@ export function createOidcSpaApi<
         }
         assert<Equals<typeof paramsOfBootstrap.implementation, "real">>;
 
-        const { startCountdownSecondsBeforeAutoLogout = 45 } = paramsOfBootstrap;
+        const { warnUserSecondsBeforeAutoLogout = 45 } = paramsOfBootstrap;
 
         if (
             oidcCoreOrInitializationError === undefined ||
@@ -100,7 +101,7 @@ export function createOidcSpaApi<
                     };
                 }
 
-                if (secondsLeft > startCountdownSecondsBeforeAutoLogout) {
+                if (secondsLeft > warnUserSecondsBeforeAutoLogout) {
                     return {
                         shouldDisplayWarning: false
                     };
@@ -823,7 +824,9 @@ export function createOidcSpaApi<
 
     function createFunctionMiddlewareServerFn(params?: {
         assert?: "user logged in";
-        hasRequiredClaims?: (params: { accessTokenClaims: AccessTokenClaims }) => Promise<boolean>;
+        hasRequiredClaims?: (params: {
+            accessTokenClaims: AccessTokenClaims;
+        }) => MaybeAsync<boolean | undefined>;
     }) {
         return async (options: {
             next: (options: { context: { oidc: OidcServerContext<AccessTokenClaims> } }) => any;
@@ -972,7 +975,9 @@ export function createOidcSpaApi<
 
     function oidcRequestMiddleware(params?: {
         assert?: "user logged in";
-        hasRequiredClaims?: (params: { accessTokenClaims: AccessTokenClaims }) => Promise<boolean>;
+        hasRequiredClaims?: (params: {
+            accessTokenClaims: AccessTokenClaims;
+        }) => MaybeAsync<boolean | undefined>;
     }) {
         return createMiddleware({ type: "request" }).server<{
             oidc: OidcServerContext<AccessTokenClaims>;
@@ -981,7 +986,9 @@ export function createOidcSpaApi<
 
     function oidcFnMiddleware(params?: {
         assert?: "user logged in";
-        hasRequiredClaims?: (params: { accessTokenClaims: AccessTokenClaims }) => Promise<boolean>;
+        hasRequiredClaims?: (params: {
+            accessTokenClaims: AccessTokenClaims;
+        }) => MaybeAsync<boolean | undefined>;
     }) {
         return createMiddleware({ type: "function" })
             .client(async ({ next }) => {

package/src/tanstack-start/react/types.tsx

@@ -3,6 +3,7 @@ import type { Oidc as Oidc_core, OidcInitializationError } from "../../core";
 import type { FunctionMiddlewareAfterServer, RequestMiddlewareAfterServer } from "@tanstack/react-start";
 import type { GetterOrDirectValue } from "../../tools/GetterOrDirectValue";
 import type { OidcMetadata } from "../../core/OidcMetadata";
+import type { MaybeAsync } from "../../tools/MaybeAsync";
 
 export type CreateOidcComponent<DecodedIdToken> = <
     Assert extends "user logged in" | "user not logged in" | undefined,
@@ -148,13 +149,17 @@ export namespace GetOidc {
 export type OidcFnMiddleware<AccessTokenClaims> = {
     (params?: {
         assert?: undefined;
-        hasRequiredClaims?: (params: { accessTokenClaims: AccessTokenClaims }) => Promise<boolean>;
+        hasRequiredClaims?: (params: {
+            accessTokenClaims: AccessTokenClaims;
+        }) => MaybeAsync<boolean | undefined>;
     }): OidcFnMiddleware.TanStackFnMiddleware<{
         oidc: OidcServerContext<AccessTokenClaims>;
     }>;
     (params?: {
         assert?: "user logged in";
-        hasRequiredClaims?: (params: { accessTokenClaims: AccessTokenClaims }) => Promise<boolean>;
+        hasRequiredClaims?: (params: {
+            accessTokenClaims: AccessTokenClaims;
+        }) => MaybeAsync<boolean | undefined>;
     }): OidcFnMiddleware.TanStackFnMiddleware<{
         oidc: OidcServerContext.LoggedIn<AccessTokenClaims>;
     }>;
@@ -163,7 +168,9 @@ export type OidcFnMiddleware<AccessTokenClaims> = {
 export namespace OidcFnMiddleware {
     export type WithAutoLogin<AccessTokenClaims> = (params?: {
         assert?: "user logged in";
-        hasRequiredClaims?: (params: { accessTokenClaims: AccessTokenClaims }) => Promise<boolean>;
+        hasRequiredClaims?: (params: {
+            accessTokenClaims: AccessTokenClaims;
+        }) => MaybeAsync<boolean | undefined>;
     }) => TanStackFnMiddleware<{
         oidc: OidcServerContext.LoggedIn<AccessTokenClaims>;
     }>;
@@ -201,13 +208,17 @@ export namespace OidcServerContext {
 export type OidcRequestMiddleware<AccessTokenClaims> = {
     (params?: {
         assert?: undefined;
-        hasRequiredClaims?: (params: { accessTokenClaims: AccessTokenClaims }) => Promise<boolean>;
+        hasRequiredClaims?: (params: {
+            accessTokenClaims: AccessTokenClaims;
+        }) => MaybeAsync<boolean | undefined>;
     }): OidcRequestMiddleware.TanstackRequestMiddleware<{
         oidc: OidcServerContext<AccessTokenClaims>;
     }>;
     (params?: {
         assert?: "user logged in";
-        hasRequiredClaims?: (params: { accessTokenClaims: AccessTokenClaims }) => Promise<boolean>;
+        hasRequiredClaims?: (params: {
+            accessTokenClaims: AccessTokenClaims;
+        }) => MaybeAsync<boolean | undefined>;
     }): OidcRequestMiddleware.TanstackRequestMiddleware<{
         oidc: OidcServerContext.LoggedIn<AccessTokenClaims>;
     }>;
@@ -216,7 +227,9 @@ export type OidcRequestMiddleware<AccessTokenClaims> = {
 export namespace OidcRequestMiddleware {
     export type WithAutoLogin<AccessTokenClaims> = (params?: {
         assert?: "user logged in";
-        hasRequiredClaims?: (params: { accessTokenClaims: AccessTokenClaims }) => Promise<boolean>;
+        hasRequiredClaims?: (params: {
+            accessTokenClaims: AccessTokenClaims;
+        }) => MaybeAsync<boolean | undefined>;
     }) => TanstackRequestMiddleware<{
         oidc: OidcServerContext.LoggedIn<AccessTokenClaims>;
     }>;
@@ -251,7 +264,7 @@ export namespace ParamsOfBootstrap {
          * This is a server policy (that can be overwrote by idleSessionLifetimeInSeconds)
          * See: https://docs.oidc-spa.dev/v/v8/auto-logout
          */
-        startCountdownSecondsBeforeAutoLogout?: number;
+        warnUserSecondsBeforeAutoLogout?: number;
         /**
          * This parameter defines after how many seconds of inactivity the user should be
          * logged out automatically.

package/src/tools/MaybeAsync.ts

@@ -0,0 +1 @@
+export type MaybeAsync<T> = Promise<T> | T;

package/tools/MaybeAsync.d.ts

@@ -0,0 +1 @@
+export type MaybeAsync<T> = Promise<T> | T;

package/tools/MaybeAsync.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=MaybeAsync.js.map

package/tools/MaybeAsync.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MaybeAsync.js","sourceRoot":"","sources":["../src/tools/MaybeAsync.ts"],"names":[],"mappings":""}