oidc-spa 6.1.13 → 6.1.15

package/src/oidc/loginSilent.ts

@@ -2,9 +2,9 @@ import type { UserManager as OidcClientTsUserManager } from "../vendor/frontend/
 import { Deferred } from "../tools/Deferred";
 import { id, assert } from "../vendor/frontend/tsafe";
 import { getStateData, clearStateStore, type StateData } from "./StateData";
-import { addQueryParamToUrl } from "../tools/urlQueryParams";
 import { getDownlinkAndRtt } from "../tools/getDownlinkAndRtt";
 import { getIsDev } from "../tools/isDev";
+import type { User as OidcClientTsUser } from "../vendor/frontend/oidc-client-ts-and-jwt-decode";
 
 export type AuthResponse = {
     state: string;
@@ -16,27 +16,27 @@ function getIsAuthResponse(data: any): data is AuthResponse {
 }
 
 export function authResponseToUrl(authResponse: AuthResponse): string {
-    let authResponseUrl = "https://dummy.com";
+    const authResponseUrl = new URL("https://dummy.com");
 
     for (const [name, value] of Object.entries(authResponse)) {
-        authResponseUrl = addQueryParamToUrl({
-            url: authResponseUrl,
-            name,
-            value
-        }).newUrl;
+        authResponseUrl.searchParams.set(name, value);
     }
 
-    return authResponseUrl;
+    return authResponseUrl.href;
 }
 
 type ResultOfLoginSilent =
     | {
-          isSuccess: true;
+          outcome: "success iframe";
           authResponse: AuthResponse;
       }
     | {
-          isSuccess: false;
+          outcome: "failure";
           cause: "timeout" | "can't reach well-known oidc endpoint";
+      }
+    | {
+          outcome: "refresh token used";
+          oidcClientTsUser: OidcClientTsUser;
       };
 
 export async function loginSilent(params: {
@@ -73,7 +73,7 @@ export async function loginSilent(params: {
 
     const timeout = setTimeout(async () => {
         dResult.resolve({
-            isSuccess: false,
+            outcome: "failure",
             cause: "timeout"
         });
     }, timeoutDelayMs);
@@ -99,7 +99,7 @@ export async function loginSilent(params: {
         window.removeEventListener("message", listener);
 
         dResult.resolve({
-            isSuccess: true,
+            outcome: "success iframe",
             authResponse
         });
     };
@@ -115,30 +115,42 @@ export async function loginSilent(params: {
             silentRequestTimeoutInSeconds: timeoutDelayMs / 1000,
             extraTokenParams: getExtraTokenParams?.()
         })
-        .catch((error: Error) => {
-            if (error.message === "Failed to fetch") {
-                // NOTE: If we got an error here it means that the fetch to the
-                // well-known oidc endpoint failed.
-                // This usually means that the server is down or that the issuerUri
-                // is not pointing to a valid oidc server.
-                // It could be a CORS error on the well-known endpoint but it's unlikely.
+        .then(
+            oidcClientTsUser => {
+                assert(oidcClientTsUser !== null);
 
                 clearTimeout(timeout);
 
                 dResult.resolve({
-                    isSuccess: false,
-                    cause: "can't reach well-known oidc endpoint"
+                    outcome: "refresh token used",
+                    oidcClientTsUser
                 });
-
-                return;
+            },
+            (error: Error) => {
+                if (error.message === "Failed to fetch") {
+                    // NOTE: If we got an error here it means that the fetch to the
+                    // well-known oidc endpoint failed.
+                    // This usually means that the server is down or that the issuerUri
+                    // is not pointing to a valid oidc server.
+                    // It could be a CORS error on the well-known endpoint but it's unlikely.
+
+                    clearTimeout(timeout);
+
+                    dResult.resolve({
+                        outcome: "failure",
+                        cause: "can't reach well-known oidc endpoint"
+                    });
+
+                    return;
+                }
+
+                // NOTE: Here, except error on our understanding there can't be any other
+                // error than timeout so we fail silently and let the timeout expire.
             }
-
-            // NOTE: Here, except error on our understanding there can't be any other
-            // error than timeout so we fail silently and let the timeout expire.
-        });
+        );
 
     dResult.pr.then(result => {
-        if (!result.isSuccess) {
+        if (result.outcome === "failure") {
             clearStateStore({ stateQueryParamValue: stateQueryParamValue_instance });
         }
     });

package/src/oidc/oidcClientTsUserToTokens.ts

@@ -39,9 +39,11 @@ export function oidcClientTsUserToTokens<DecodedIdToken extends Record<string, u
 
     const refreshToken = oidcClientTsUser.refresh_token;
 
-    assert(refreshToken !== undefined, "No refresh token provided by the oidc server");
-
     const refreshTokenExpirationTime = (() => {
+        if (refreshToken === undefined) {
+            return Number.POSITIVE_INFINITY;
+        }
+
         read_from_jwt: {
             const expirationTime = readExpirationTimeInJwt(refreshToken);
 
@@ -71,7 +73,7 @@ export function oidcClientTsUserToTokens<DecodedIdToken extends Record<string, u
     const tokens: Oidc.Tokens<DecodedIdToken> = {
         accessToken,
         accessTokenExpirationTime,
-        refreshToken,
+        refreshToken: refreshToken ?? "",
         refreshTokenExpirationTime,
         idToken,
         decodedIdToken: null as any

package/src/oidc/persistedLogoutState.ts

@@ -0,0 +1,29 @@
+function getKey(params: { configId: string }) {
+    const { configId } = params;
+
+    return `oidc-spa:is-logged-out:${configId}`;
+}
+
+export function persistLogoutState(params: { configId: string }) {
+    const { configId } = params;
+
+    const key = getKey({ configId });
+
+    localStorage.setItem(key, "true");
+}
+
+export function clearPersistedLogoutState(params: { configId: string }) {
+    const { configId } = params;
+
+    const key = getKey({ configId });
+
+    localStorage.removeItem(key);
+}
+
+export function getIsPersistedLogoutState(params: { configId: string }) {
+    const { configId } = params;
+
+    const key = getKey({ configId });
+
+    return localStorage.getItem(key) === "true";
+}

package/src/tools/urlQueryParams.ts

@@ -1,113 +0,0 @@
-export function addQueryParamToUrl(params: { url: string; name: string; value: string }): {
-    newUrl: string;
-} {
-    const { url, name, value } = params;
-
-    let newUrl = url;
-
-    const result = retrieveQueryParamFromUrl({
-        url,
-        name
-    });
-
-    if (result.wasPresent) {
-        newUrl = result.newUrl;
-    }
-
-    newUrl += `${
-        newUrl.includes("?") ? "&" : newUrl.endsWith("?") ? "" : "?"
-    }${name}=${encodeURIComponent(value)}`;
-
-    return { newUrl };
-}
-
-export function retrieveAllQueryParamStartingWithPrefixFromUrl<
-    Prefix extends string,
-    DoLeave extends boolean
->(params: {
-    url: string;
-    prefix: Prefix;
-    doLeavePrefixInResults: DoLeave;
-}): { newUrl: string; values: Record<DoLeave extends true ? `${Prefix}${string}` : string, string> } {
-    const { url, prefix, doLeavePrefixInResults } = params;
-
-    const { baseUrl, locationSearch } = (() => {
-        const [baseUrl, ...rest] = url.split("?");
-
-        return {
-            baseUrl,
-            locationSearch: rest.join("?").trim()
-        };
-    })();
-
-    const values: Record<string, string> = {};
-
-    const { newLocationSearch } = (() => {
-        let newLocationSearch = locationSearch
-            .split("&")
-            .filter(part => part !== "")
-            .map(part => part.split("=") as [string, string])
-            .filter(([key, value_i]) =>
-                !key.startsWith(prefix)
-                    ? true
-                    : ((values[doLeavePrefixInResults ? key : key.substring(prefix.length)] =
-                          decodeURIComponent(value_i)),
-                      false)
-            )
-            .map(entry => entry.join("="))
-            .join("&");
-        newLocationSearch = newLocationSearch === "" ? "" : `?${newLocationSearch}`;
-
-        return { newLocationSearch };
-    })();
-
-    return {
-        newUrl: `${baseUrl}${newLocationSearch}`,
-        values
-    };
-}
-
-export function retrieveAllQueryParamFromUrl(params: { url: string }): {
-    newUrl: string;
-    values: Record<string, string>;
-} {
-    return retrieveAllQueryParamStartingWithPrefixFromUrl({
-        url: params.url,
-        prefix: "",
-        doLeavePrefixInResults: true
-    });
-}
-
-export function retrieveQueryParamFromUrl(params: {
-    url: string;
-    name: string;
-}): { wasPresent: false } | { wasPresent: true; newUrl: string; value: string } {
-    const { url, name } = params;
-
-    let { newUrl, values } = retrieveAllQueryParamStartingWithPrefixFromUrl({
-        url,
-        prefix: name,
-        doLeavePrefixInResults: true
-    });
-
-    if (!(name in values)) {
-        return { wasPresent: false };
-    }
-
-    const { [name]: value, ...rest } = values;
-
-    Object.entries(rest).forEach(
-        ([name, value]) =>
-            (newUrl = addQueryParamToUrl({
-                name,
-                url: newUrl,
-                value
-            }).newUrl)
-    );
-
-    return {
-        wasPresent: true,
-        newUrl,
-        value: values[name]
-    };
-}

package/tools/urlQueryParams.d.ts

@@ -1,31 +0,0 @@
-export declare function addQueryParamToUrl(params: {
-    url: string;
-    name: string;
-    value: string;
-}): {
-    newUrl: string;
-};
-export declare function retrieveAllQueryParamStartingWithPrefixFromUrl<Prefix extends string, DoLeave extends boolean>(params: {
-    url: string;
-    prefix: Prefix;
-    doLeavePrefixInResults: DoLeave;
-}): {
-    newUrl: string;
-    values: Record<DoLeave extends true ? `${Prefix}${string}` : string, string>;
-};
-export declare function retrieveAllQueryParamFromUrl(params: {
-    url: string;
-}): {
-    newUrl: string;
-    values: Record<string, string>;
-};
-export declare function retrieveQueryParamFromUrl(params: {
-    url: string;
-    name: string;
-}): {
-    wasPresent: false;
-} | {
-    wasPresent: true;
-    newUrl: string;
-    value: string;
-};

package/tools/urlQueryParams.js

@@ -1,112 +0,0 @@
-"use strict";
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-var __read = (this && this.__read) || function (o, n) {
-    var m = typeof Symbol === "function" && o[Symbol.iterator];
-    if (!m) return o;
-    var i = m.call(o), r, ar = [], e;
-    try {
-        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
-    }
-    catch (error) { e = { error: error }; }
-    finally {
-        try {
-            if (r && !r.done && (m = i["return"])) m.call(i);
-        }
-        finally { if (e) throw e.error; }
-    }
-    return ar;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addQueryParamToUrl = addQueryParamToUrl;
-exports.retrieveAllQueryParamStartingWithPrefixFromUrl = retrieveAllQueryParamStartingWithPrefixFromUrl;
-exports.retrieveAllQueryParamFromUrl = retrieveAllQueryParamFromUrl;
-exports.retrieveQueryParamFromUrl = retrieveQueryParamFromUrl;
-function addQueryParamToUrl(params) {
-    var url = params.url, name = params.name, value = params.value;
-    var newUrl = url;
-    var result = retrieveQueryParamFromUrl({
-        url: url,
-        name: name
-    });
-    if (result.wasPresent) {
-        newUrl = result.newUrl;
-    }
-    newUrl += "".concat(newUrl.includes("?") ? "&" : newUrl.endsWith("?") ? "" : "?").concat(name, "=").concat(encodeURIComponent(value));
-    return { newUrl: newUrl };
-}
-function retrieveAllQueryParamStartingWithPrefixFromUrl(params) {
-    var url = params.url, prefix = params.prefix, doLeavePrefixInResults = params.doLeavePrefixInResults;
-    var _a = (function () {
-        var _a = __read(url.split("?")), baseUrl = _a[0], rest = _a.slice(1);
-        return {
-            baseUrl: baseUrl,
-            locationSearch: rest.join("?").trim()
-        };
-    })(), baseUrl = _a.baseUrl, locationSearch = _a.locationSearch;
-    var values = {};
-    var newLocationSearch = (function () {
-        var newLocationSearch = locationSearch
-            .split("&")
-            .filter(function (part) { return part !== ""; })
-            .map(function (part) { return part.split("="); })
-            .filter(function (_a) {
-            var _b = __read(_a, 2), key = _b[0], value_i = _b[1];
-            return !key.startsWith(prefix)
-                ? true
-                : ((values[doLeavePrefixInResults ? key : key.substring(prefix.length)] =
-                    decodeURIComponent(value_i)),
-                    false);
-        })
-            .map(function (entry) { return entry.join("="); })
-            .join("&");
-        newLocationSearch = newLocationSearch === "" ? "" : "?".concat(newLocationSearch);
-        return { newLocationSearch: newLocationSearch };
-    })().newLocationSearch;
-    return {
-        newUrl: "".concat(baseUrl).concat(newLocationSearch),
-        values: values
-    };
-}
-function retrieveAllQueryParamFromUrl(params) {
-    return retrieveAllQueryParamStartingWithPrefixFromUrl({
-        url: params.url,
-        prefix: "",
-        doLeavePrefixInResults: true
-    });
-}
-function retrieveQueryParamFromUrl(params) {
-    var url = params.url, name = params.name;
-    var _a = retrieveAllQueryParamStartingWithPrefixFromUrl({
-        url: url,
-        prefix: name,
-        doLeavePrefixInResults: true
-    }), newUrl = _a.newUrl, values = _a.values;
-    if (!(name in values)) {
-        return { wasPresent: false };
-    }
-    var _b = values, _c = name, value = _b[_c], rest = __rest(_b, [typeof _c === "symbol" ? _c : _c + ""]);
-    Object.entries(rest).forEach(function (_a) {
-        var _b = __read(_a, 2), name = _b[0], value = _b[1];
-        return (newUrl = addQueryParamToUrl({
-            name: name,
-            url: newUrl,
-            value: value
-        }).newUrl);
-    });
-    return {
-        wasPresent: true,
-        newUrl: newUrl,
-        value: values[name]
-    };
-}
-//# sourceMappingURL=urlQueryParams.js.map

package/tools/urlQueryParams.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"urlQueryParams.js","sourceRoot":"","sources":["../src/tools/urlQueryParams.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gDAqBC;AAED,wGA4CC;AAED,oEASC;AAED,8DAgCC;AAhHD,SAAgB,kBAAkB,CAAC,MAAoD;IAG3E,IAAA,GAAG,GAAkB,MAAM,IAAxB,EAAE,IAAI,GAAY,MAAM,KAAlB,EAAE,KAAK,GAAK,MAAM,MAAX,CAAY;IAEpC,IAAI,MAAM,GAAG,GAAG,CAAC;IAEjB,IAAM,MAAM,GAAG,yBAAyB,CAAC;QACrC,GAAG,KAAA;QACH,IAAI,MAAA;KACP,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;QACpB,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC3B,CAAC;IAED,MAAM,IAAI,UACN,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,SAC7D,IAAI,cAAI,kBAAkB,CAAC,KAAK,CAAC,CAAE,CAAC;IAEvC,OAAO,EAAE,MAAM,QAAA,EAAE,CAAC;AACtB,CAAC;AAED,SAAgB,8CAA8C,CAG5D,MAID;IACW,IAAA,GAAG,GAAqC,MAAM,IAA3C,EAAE,MAAM,GAA6B,MAAM,OAAnC,EAAE,sBAAsB,GAAK,MAAM,uBAAX,CAAY;IAEjD,IAAA,KAA8B,CAAC;QAC3B,IAAA,KAAA,OAAqB,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA,EAAlC,OAAO,QAAA,EAAK,IAAI,cAAkB,CAAC;QAE1C,OAAO;YACH,OAAO,SAAA;YACP,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE;SACxC,CAAC;IACN,CAAC,CAAC,EAAE,EAPI,OAAO,aAAA,EAAE,cAAc,oBAO3B,CAAC;IAEL,IAAM,MAAM,GAA2B,EAAE,CAAC;IAElC,IAAA,iBAAiB,GAAK,CAAC;QAC3B,IAAI,iBAAiB,GAAG,cAAc;aACjC,KAAK,CAAC,GAAG,CAAC;aACV,MAAM,CAAC,UAAA,IAAI,IAAI,OAAA,IAAI,KAAK,EAAE,EAAX,CAAW,CAAC;aAC3B,GAAG,CAAC,UAAA,IAAI,IAAI,OAAA,IAAI,CAAC,KAAK,CAAC,GAAG,CAAqB,EAAnC,CAAmC,CAAC;aAChD,MAAM,CAAC,UAAC,EAAc;gBAAd,KAAA,aAAc,EAAb,GAAG,QAAA,EAAE,OAAO,QAAA;YAClB,OAAA,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC;gBACnB,CAAC,CAAC,IAAI;gBACN,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;oBACjE,kBAAkB,CAAC,OAAO,CAAC,CAAC;oBAChC,KAAK,CAAC;QAJZ,CAIY,CACf;aACA,GAAG,CAAC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAf,CAAe,CAAC;aAC7B,IAAI,CAAC,GAAG,CAAC,CAAC;QACf,iBAAiB,GAAG,iBAAiB,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAI,iBAAiB,CAAE,CAAC;QAE5E,OAAO,EAAE,iBAAiB,mBAAA,EAAE,CAAC;IACjC,CAAC,CAAC,EAAE,kBAjBqB,CAiBpB;IAEL,OAAO;QACH,MAAM,EAAE,UAAG,OAAO,SAAG,iBAAiB,CAAE;QACxC,MAAM,QAAA;KACT,CAAC;AACN,CAAC;AAED,SAAgB,4BAA4B,CAAC,MAAuB;IAIhE,OAAO,8CAA8C,CAAC;QAClD,GAAG,EAAE,MAAM,CAAC,GAAG;QACf,MAAM,EAAE,EAAE;QACV,sBAAsB,EAAE,IAAI;KAC/B,CAAC,CAAC;AACP,CAAC;AAED,SAAgB,yBAAyB,CAAC,MAGzC;IACW,IAAA,GAAG,GAAW,MAAM,IAAjB,EAAE,IAAI,GAAK,MAAM,KAAX,CAAY;IAEzB,IAAA,KAAqB,8CAA8C,CAAC;QACpE,GAAG,KAAA;QACH,MAAM,EAAE,IAAI;QACZ,sBAAsB,EAAE,IAAI;KAC/B,CAAC,EAJI,MAAM,YAAA,EAAE,MAAM,YAIlB,CAAC;IAEH,IAAI,CAAC,CAAC,IAAI,IAAI,MAAM,CAAC,EAAE,CAAC;QACpB,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;IACjC,CAAC;IAED,IAAmC,KAAA,MAAM,EAAjC,KAAC,IAAK,EAAE,KAAK,SAAA,EAAK,IAAI,cAAxB,uCAA0B,CAAS,CAAC;IAE1C,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CACxB,UAAC,EAAa;YAAb,KAAA,aAAa,EAAZ,IAAI,QAAA,EAAE,KAAK,QAAA;QACT,OAAA,CAAC,MAAM,GAAG,kBAAkB,CAAC;YACzB,IAAI,MAAA;YACJ,GAAG,EAAE,MAAM;YACX,KAAK,OAAA;SACR,CAAC,CAAC,MAAM,CAAC;IAJV,CAIU,CACjB,CAAC;IAEF,OAAO;QACH,UAAU,EAAE,IAAI;QAChB,MAAM,QAAA;QACN,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC;KACtB,CAAC;AACN,CAAC"}