oidc-spa 6.15.1 → 7.0.1

package/src/react/react.tsx

@@ -3,8 +3,6 @@ import {
     useState,
     createContext,
     useContext,
-    useReducer,
-    useRef,
     type ReactNode,
     type ComponentType,
     type FC,
@@ -21,7 +19,11 @@ export type OidcReact<DecodedIdToken extends Record<string, unknown>> =
     | OidcReact.LoggedIn<DecodedIdToken>;
 
 export namespace OidcReact {
-    export type Common = Oidc.Common;
+    export type Common = Oidc.Common & {
+        useLogoutWarningCountdown: (params: { warningDurationSeconds: number }) => {
+            secondsLeft: number | undefined;
+        };
+    };
 
     export type NotLoggedIn = Common & {
         isUserLoggedIn: false;
@@ -33,12 +35,9 @@ export namespace OidcReact {
         }) => Promise<never>;
         initializationError: OidcInitializationError | undefined;
 
-        /** @deprecated: Use `const { decodedIdToken, tokens} = useOidc();` */
-        oidcTokens?: never;
         decodedIdToken?: never;
-        tokens?: never;
         logout?: never;
-        subscribeToAutoLogoutCountdown?: never;
+        renewTokens?: never;
         goToAuthServer?: never;
         backFromAuthServer?: never;
         isNewBrowserSession?: never;
@@ -46,16 +45,9 @@ export namespace OidcReact {
 
     export type LoggedIn<DecodedIdToken extends Record<string, unknown>> = Common & {
         isUserLoggedIn: true;
-        /** @deprecated: Use `const { decodedIdToken, tokens} = useOidc();` */
-        oidcTokens: Oidc.Tokens<DecodedIdToken>;
         decodedIdToken: DecodedIdToken;
-        tokens: Oidc.Tokens<DecodedIdToken> | undefined;
         logout: Oidc.LoggedIn["logout"];
         renewTokens: Oidc.LoggedIn["renewTokens"];
-        subscribeToAutoLogoutCountdown: (
-            tickCallback: (params: { secondsLeft: number | undefined }) => void
-        ) => { unsubscribeFromAutoLogoutCountdown: () => void };
-
         login?: never;
         initializationError?: never;
         goToAuthServer: (params: {
@@ -220,6 +212,39 @@ export function createOidcReactApi_dependencyInjection<
         );
     }
 
+    const useLogoutWarningCountdown: OidcReact.LoggedIn<DecodedIdToken>["useLogoutWarningCountdown"] = ({
+        warningDurationSeconds
+    }) => {
+        const contextValue = useContext(oidcContext);
+
+        assert(contextValue !== undefined);
+
+        const { oidc } = contextValue;
+
+        const [secondsLeft, setSecondsLeft] = useState<number | undefined>(undefined);
+
+        useEffect(() => {
+            if (!oidc.isUserLoggedIn) {
+                return;
+            }
+
+            const { unsubscribeFromAutoLogoutCountdown } = oidc.subscribeToAutoLogoutCountdown(
+                ({ secondsLeft }) =>
+                    setSecondsLeft(
+                        secondsLeft === undefined || secondsLeft > warningDurationSeconds
+                            ? undefined
+                            : secondsLeft
+                    )
+            );
+
+            return () => {
+                unsubscribeFromAutoLogoutCountdown();
+            };
+        }, [warningDurationSeconds]);
+
+        return { secondsLeft };
+    };
+
     function useOidc(params?: {
         assert?: "user logged in" | "user not logged in";
     }): OidcReact<DecodedIdToken> {
@@ -259,66 +284,27 @@ export function createOidcReactApi_dependencyInjection<
             }
         }
 
-        const [, forceUpdate] = useReducer(() => [], []);
-        // TODO: Remove in next major version
-        useEffect(() => {
-            if (!oidc.isUserLoggedIn) {
-                return;
-            }
-
-            const { unsubscribe } = oidc.subscribeToTokensChange(forceUpdate);
-
-            return unsubscribe;
-        }, [oidc]);
-
-        const tokensState_ref = useRef<{
-            isConsumerReadingTokens: boolean;
-            tokens: Oidc.Tokens<DecodedIdToken> | undefined;
-        }>({
-            isConsumerReadingTokens: false,
-            tokens: undefined
-        });
+        const [, reRenderIfDecodedIdTokenChanged] = useState(
+            !oidc.isUserLoggedIn ? undefined : oidc.getDecodedIdToken()
+        );
 
         useEffect(() => {
             if (!oidc.isUserLoggedIn) {
                 return;
             }
 
-            const updateTokens = (tokens: Oidc.Tokens<DecodedIdToken>) => {
-                if (tokens === tokensState_ref.current.tokens) {
-                    return;
-                }
-
-                const tokenState = tokensState_ref.current;
-
-                tokenState.tokens = tokens;
-
-                if (tokenState.isConsumerReadingTokens) {
-                    forceUpdate();
-                }
-            };
-
-            let isActive = true;
-
-            oidc.getTokens_next().then(tokens => {
-                if (!isActive) {
-                    return;
-                }
-                updateTokens(tokens);
-            });
+            const { unsubscribe } = oidc.subscribeToTokensChange(() =>
+                reRenderIfDecodedIdTokenChanged(oidc.getDecodedIdToken())
+            );
 
-            const { unsubscribe } = oidc.subscribeToTokensChange(tokens => {
-                updateTokens(tokens);
-            });
+            reRenderIfDecodedIdTokenChanged(oidc.getDecodedIdToken());
 
-            return () => {
-                isActive = false;
-                unsubscribe();
-            };
+            return unsubscribe;
         }, []);
 
         const common: OidcReact.Common = {
-            params: oidc.params
+            params: oidc.params,
+            useLogoutWarningCountdown
         };
 
         if (!oidc.isUserLoggedIn) {
@@ -334,16 +320,9 @@ export function createOidcReactApi_dependencyInjection<
         const oidcReact: OidcReact.LoggedIn<DecodedIdToken> = {
             ...common,
             isUserLoggedIn: true,
-            oidcTokens: oidc.getTokens(),
             decodedIdToken: oidc.getDecodedIdToken(),
-            get tokens() {
-                const tokensState = tokensState_ref.current;
-                tokensState.isConsumerReadingTokens = true;
-                return tokensState.tokens;
-            },
             logout: oidc.logout,
             renewTokens: oidc.renewTokens,
-            subscribeToAutoLogoutCountdown: oidc.subscribeToAutoLogoutCountdown,
             goToAuthServer: oidc.goToAuthServer,
             isNewBrowserSession: oidc.isNewBrowserSession,
             backFromAuthServer: oidc.backFromAuthServer
@@ -422,17 +401,10 @@ export function createOidcReactApi_dependencyInjection<
         return oidc;
     });
 
-    async function getOidc(): Promise<Oidc<DecodedIdToken>> {
+    function getOidc(): Promise<Oidc<DecodedIdToken>> {
         dReadyToCreate.resolve();
 
-        // TODO: Directly return oidc in next major version
-        const oidc = await prOidc;
-
-        if (oidc.isUserLoggedIn) {
-            await oidc.getTokens_next();
-        }
-
-        return oidc;
+        return prOidc;
     }
 
     const oidcReact: OidcReactApi<DecodedIdToken, false> = {
@@ -449,7 +421,7 @@ export function createOidcReactApi_dependencyInjection<
 
 /** @see: https://docs.oidc-spa.dev/v/v6/usage#react-api */
 export function createReactOidc<
-    DecodedIdToken extends Record<string, unknown> = Record<string, unknown>,
+    DecodedIdToken extends Record<string, unknown> = Oidc.Tokens.DecodedIdToken_base,
     AutoLogin extends boolean = false
 >(params: ValueOrAsyncGetter<ParamsOfCreateOidc<DecodedIdToken, AutoLogin>>) {
     return createOidcReactApi_dependencyInjection(params, createOidc);

package/src/tools/readExpirationTimeInJwt.ts

@@ -3,15 +3,14 @@ import { assert } from "../vendor/frontend/tsafe";
 
 // Return undefined if token provided wasn't a JWT or if it hasn't an exp claim number
 export function readExpirationTimeInJwt(token: string): number | undefined {
-    let expirationTime: number;
+    let exp: number;
 
     try {
-        expirationTime = decodeJwt<{ exp: number }>(token).exp * 1000;
-
-        assert(typeof expirationTime === "number" && !isNaN(expirationTime));
+        exp = decodeJwt<{ exp: number }>(token).exp;
+        assert(typeof exp === "number");
     } catch {
         return undefined;
     }
 
-    return expirationTime;
+    return exp * 1000;
 }

package/src/tools/startCountdown.ts

@@ -2,17 +2,16 @@ import { setTimeout, clearTimeout } from "../tools/workerTimers";
 
 export function createStartCountdown(params: {
     tickCallback: (params: { secondsLeft: number | undefined }) => void;
-    getCountdownEndTime: () => number;
 }) {
-    const { getCountdownEndTime, tickCallback } = params;
+    const { tickCallback } = params;
 
-    const getCountdownEndInMs = () => getCountdownEndTime() - Date.now();
+    function startCountdown(params: { countDownFromSeconds: number }) {
+        const { countDownFromSeconds } = params;
 
-    function startCountdown() {
         let timer: ReturnType<typeof setTimeout>;
 
         (async () => {
-            let secondsLeft = Math.floor(getCountdownEndInMs() / 1000);
+            let secondsLeft = Math.floor(countDownFromSeconds);
 
             while (secondsLeft >= 0) {
                 tickCallback({ secondsLeft });

package/tools/readExpirationTimeInJwt.js

@@ -5,14 +5,14 @@ var decodeJwt_1 = require("./decodeJwt");
 var tsafe_1 = require("../vendor/frontend/tsafe");
 // Return undefined if token provided wasn't a JWT or if it hasn't an exp claim number
 function readExpirationTimeInJwt(token) {
-    var expirationTime;
+    var exp;
     try {
-        expirationTime = (0, decodeJwt_1.decodeJwt)(token).exp * 1000;
-        (0, tsafe_1.assert)(typeof expirationTime === "number" && !isNaN(expirationTime));
+        exp = (0, decodeJwt_1.decodeJwt)(token).exp;
+        (0, tsafe_1.assert)(typeof exp === "number");
     }
     catch (_a) {
         return undefined;
     }
-    return expirationTime;
+    return exp * 1000;
 }
 //# sourceMappingURL=readExpirationTimeInJwt.js.map

package/tools/readExpirationTimeInJwt.js.map

@@ -1 +1 @@
-{"version":3,"file":"readExpirationTimeInJwt.js","sourceRoot":"","sources":["../src/tools/readExpirationTimeInJwt.ts"],"names":[],"mappings":";;AAIA,0DAYC;AAhBD,yCAAwC;AACxC,kDAAkD;AAElD,sFAAsF;AACtF,SAAgB,uBAAuB,CAAC,KAAa;IACjD,IAAI,cAAsB,CAAC;IAE3B,IAAI,CAAC;QACD,cAAc,GAAG,IAAA,qBAAS,EAAkB,KAAK,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC;QAE9D,IAAA,cAAM,EAAC,OAAO,cAAc,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC;IACzE,CAAC;IAAC,WAAM,CAAC;QACL,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,OAAO,cAAc,CAAC;AAC1B,CAAC"}
+{"version":3,"file":"readExpirationTimeInJwt.js","sourceRoot":"","sources":["../src/tools/readExpirationTimeInJwt.ts"],"names":[],"mappings":";;AAIA,0DAWC;AAfD,yCAAwC;AACxC,kDAAkD;AAElD,sFAAsF;AACtF,SAAgB,uBAAuB,CAAC,KAAa;IACjD,IAAI,GAAW,CAAC;IAEhB,IAAI,CAAC;QACD,GAAG,GAAG,IAAA,qBAAS,EAAkB,KAAK,CAAC,CAAC,GAAG,CAAC;QAC5C,IAAA,cAAM,EAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC;IACpC,CAAC;IAAC,WAAM,CAAC;QACL,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,OAAO,GAAG,GAAG,IAAI,CAAC;AACtB,CAAC"}

package/tools/startCountdown.d.ts

@@ -2,9 +2,10 @@ export declare function createStartCountdown(params: {
     tickCallback: (params: {
         secondsLeft: number | undefined;
     }) => void;
-    getCountdownEndTime: () => number;
 }): {
-    startCountdown: () => {
+    startCountdown: (params: {
+        countDownFromSeconds: number;
+    }) => {
         stopCountdown: () => void;
     };
 };

package/tools/startCountdown.js

@@ -39,17 +39,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createStartCountdown = createStartCountdown;
 var workerTimers_1 = require("../tools/workerTimers");
 function createStartCountdown(params) {
-    var getCountdownEndTime = params.getCountdownEndTime, tickCallback = params.tickCallback;
-    var getCountdownEndInMs = function () { return getCountdownEndTime() - Date.now(); };
-    function startCountdown() {
+    var tickCallback = params.tickCallback;
+    function startCountdown(params) {
         var _this = this;
+        var countDownFromSeconds = params.countDownFromSeconds;
         var timer;
         (function () { return __awaiter(_this, void 0, void 0, function () {
             var secondsLeft;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        secondsLeft = Math.floor(getCountdownEndInMs() / 1000);
+                        secondsLeft = Math.floor(countDownFromSeconds);
                         _a.label = 1;
                     case 1:
                         if (!(secondsLeft >= 0)) return [3 /*break*/, 3];

package/tools/startCountdown.js.map

@@ -1 +1 @@
-{"version":3,"file":"startCountdown.js","sourceRoot":"","sources":["../src/tools/startCountdown.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,oDAkCC;AApCD,sDAAiE;AAEjE,SAAgB,oBAAoB,CAAC,MAGpC;IACW,IAAA,mBAAmB,GAAmB,MAAM,oBAAzB,EAAE,YAAY,GAAK,MAAM,aAAX,CAAY;IAErD,IAAM,mBAAmB,GAAG,cAAM,OAAA,mBAAmB,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,EAAlC,CAAkC,CAAC;IAErE,SAAS,cAAc;QAAvB,iBAuBC;QAtBG,IAAI,KAAoC,CAAC;QAEzC,CAAC;;;;;wBACO,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,mBAAmB,EAAE,GAAG,IAAI,CAAC,CAAC;;;6BAEpD,CAAA,WAAW,IAAI,CAAC,CAAA;wBACnB,YAAY,CAAC,EAAE,WAAW,aAAA,EAAE,CAAC,CAAC;wBAE9B,qBAAM,IAAI,OAAO,CAAO,UAAA,OAAO;gCAC3B,KAAK,GAAG,IAAA,yBAAU,EAAC,OAAO,EAAE,IAAK,CAAC,CAAC;4BACvC,CAAC,CAAC,EAAA;;wBAFF,SAEE,CAAC;wBAEH,WAAW,EAAE,CAAC;;;;;aAErB,CAAC,EAAE,CAAC;QAEL,IAAM,aAAa,GAAG;YAClB,IAAA,2BAAY,EAAC,KAAK,CAAC,CAAC;YACpB,YAAY,CAAC,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC;QAC7C,CAAC,CAAC;QAEF,OAAO,EAAE,aAAa,eAAA,EAAE,CAAC;IAC7B,CAAC;IAED,OAAO,EAAE,cAAc,gBAAA,EAAE,CAAC;AAC9B,CAAC"}
+{"version":3,"file":"startCountdown.js","sourceRoot":"","sources":["../src/tools/startCountdown.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,oDAiCC;AAnCD,sDAAiE;AAEjE,SAAgB,oBAAoB,CAAC,MAEpC;IACW,IAAA,YAAY,GAAK,MAAM,aAAX,CAAY;IAEhC,SAAS,cAAc,CAAC,MAAwC;QAAhE,iBAyBC;QAxBW,IAAA,oBAAoB,GAAK,MAAM,qBAAX,CAAY;QAExC,IAAI,KAAoC,CAAC;QAEzC,CAAC;;;;;wBACO,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;;;6BAE5C,CAAA,WAAW,IAAI,CAAC,CAAA;wBACnB,YAAY,CAAC,EAAE,WAAW,aAAA,EAAE,CAAC,CAAC;wBAE9B,qBAAM,IAAI,OAAO,CAAO,UAAA,OAAO;gCAC3B,KAAK,GAAG,IAAA,yBAAU,EAAC,OAAO,EAAE,IAAK,CAAC,CAAC;4BACvC,CAAC,CAAC,EAAA;;wBAFF,SAEE,CAAC;wBAEH,WAAW,EAAE,CAAC;;;;;aAErB,CAAC,EAAE,CAAC;QAEL,IAAM,aAAa,GAAG;YAClB,IAAA,2BAAY,EAAC,KAAK,CAAC,CAAC;YACpB,YAAY,CAAC,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC;QAC7C,CAAC,CAAC;QAEF,OAAO,EAAE,aAAa,eAAA,EAAE,CAAC;IAC7B,CAAC;IAED,OAAO,EAAE,cAAc,gBAAA,EAAE,CAAC;AAC9B,CAAC"}