@inrupt/solid-client-authn-browser 1.16.0 → 1.17.1

package/src/login/oidc/IssuerConfigFetcher.spec.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2022 Inrupt Inc.
+// Copyright Inrupt Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal in
@@ -21,8 +21,8 @@
 
 import { jest, it, describe, expect } from "@jest/globals";
 import { mockStorageUtility } from "@inrupt/solid-client-authn-core";
-import { fetch, Response as NodeResponse } from "@inrupt/universal-fetch";
-import * as UniversalFetch from "@inrupt/universal-fetch";
+import { Response as NodeResponse } from "@inrupt/universal-fetch";
+import type * as UniversalFetch from "@inrupt/universal-fetch";
 import IssuerConfigFetcher from "./IssuerConfigFetcher";
 
 jest.mock("@inrupt/universal-fetch", () => {
@@ -31,7 +31,7 @@ jest.mock("@inrupt/universal-fetch", () => {
   ) as typeof UniversalFetch;
   return {
     ...fetchModule,
-    fetch: jest.fn<typeof fetch>(),
+    fetch: jest.fn<(typeof UniversalFetch)["fetch"]>(),
   };
 });
 
@@ -65,6 +65,7 @@ describe("IssuerConfigFetcher", () => {
           // eslint-disable-next-line camelcase
           claim_types_supported: "oidc",
           bleepBloop: "Meep Moop",
+          end_session_endpoint: "https://example.com/endSessionEndpoint",
         })
       )
     );
@@ -75,6 +76,9 @@ describe("IssuerConfigFetcher", () => {
     expect(fetchedConfig.issuer).toBe("https://example.com");
     expect((fetchedConfig as any).claim_types_supported).toBeUndefined();
     expect(fetchedConfig.claimTypesSupported).toBe("oidc");
+    expect(fetchedConfig.endSessionEndpoint).toBe(
+      "https://example.com/endSessionEndpoint"
+    );
     expect((fetchedConfig as any).bleepBloop).toBeUndefined();
   });
 

package/src/login/oidc/IssuerConfigFetcher.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2022 Inrupt Inc.
+// Copyright Inrupt Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal in
@@ -27,13 +27,13 @@
 /**
  * Responsible for fetching an IDP configuration
  */
-import {
+import type {
   IIssuerConfig,
   IIssuerConfigFetcher,
   IStorageUtility,
-  ConfigurationError,
 } from "@inrupt/solid-client-authn-core";
-import { fetch } from "@inrupt/universal-fetch";
+import { ConfigurationError } from "@inrupt/solid-client-authn-core";
+import { fetch as uniFetch } from "@inrupt/universal-fetch";
 
 export const WELL_KNOWN_OPENID_CONFIG = ".well-known/openid-configuration";
 
@@ -66,6 +66,10 @@ const issuerConfigKeyMap: Record<
     toKey: "registrationEndpoint",
     convertToUrl: true,
   },
+  end_session_endpoint: {
+    toKey: "endSessionEndpoint",
+    convertToUrl: true,
+  },
   scopes_supported: { toKey: "scopesSupported" },
   response_types_supported: { toKey: "responseTypesSupported" },
   response_modes_supported: { toKey: "responseModesSupported" },
@@ -166,7 +170,10 @@ export default class IssuerConfigFetcher implements IIssuerConfigFetcher {
       // includes the full issuer path. See https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig.
       issuer.endsWith("/") ? issuer : `${issuer}/`
     ).href;
-    const issuerConfigRequestBody = await fetch(openIdConfigUrl);
+    const issuerConfigRequestBody = await uniFetch.call(
+      globalThis,
+      openIdConfigUrl
+    );
     // Check the validity of the fetched config
     try {
       issuerConfig = processConfig(await issuerConfigRequestBody.json());

package/src/login/oidc/OidcLoginHandler.spec.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2022 Inrupt Inc.
+// Copyright Inrupt Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal in
@@ -20,10 +20,8 @@
 //
 
 import { jest, it, describe, expect } from "@jest/globals";
-import {
-  IIssuerConfigFetcher,
-  StorageUtility,
-} from "@inrupt/solid-client-authn-core";
+import type { IIssuerConfigFetcher } from "@inrupt/solid-client-authn-core";
+import { StorageUtility } from "@inrupt/solid-client-authn-core";
 import {
   StorageUtilityMock,
   mockStorage,

package/src/login/oidc/OidcLoginHandler.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2022 Inrupt Inc.
+// Copyright Inrupt Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal in
@@ -28,7 +28,7 @@
  * Handles Common Oidc login functions (Like fetching the configuration)
  */
 
-import {
+import type {
   IClientRegistrar,
   IIssuerConfig,
   IIssuerConfigFetcher,
@@ -37,8 +37,10 @@ import {
   IOidcHandler,
   IOidcOptions,
   IStorageUtility,
-  ConfigurationError,
   LoginResult,
+} from "@inrupt/solid-client-authn-core";
+import {
+  ConfigurationError,
   handleRegistration,
 } from "@inrupt/solid-client-authn-core";
 

package/src/login/oidc/Redirector.spec.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2022 Inrupt Inc.
+// Copyright Inrupt Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal in

package/src/login/oidc/Redirector.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2022 Inrupt Inc.
+// Copyright Inrupt Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal in
@@ -24,7 +24,7 @@
  * @packageDocumentation
  */
 
-import {
+import type {
   IRedirector,
   IRedirectorOptions,
 } from "@inrupt/solid-client-authn-core";

package/src/login/oidc/__mocks__/ClientRegistrar.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2022 Inrupt Inc.
+// Copyright Inrupt Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal in
@@ -19,7 +19,7 @@
 // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 //
 
-import {
+import type {
   IClient,
   IClientRegistrar,
   IClientRegistrarOptions,

package/src/login/oidc/__mocks__/IOidcHandler.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2022 Inrupt Inc.
+// Copyright Inrupt Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal in
@@ -19,7 +19,7 @@
 // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 //
 
-import {
+import type {
   IOidcHandler,
   IOidcOptions,
   ISessionInfo,

package/src/login/oidc/__mocks__/IOidcOptions.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2022 Inrupt Inc.
+// Copyright Inrupt Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal in
@@ -19,7 +19,7 @@
 // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 //
 
-import { IOidcOptions } from "@inrupt/solid-client-authn-core";
+import type { IOidcOptions } from "@inrupt/solid-client-authn-core";
 import { jest } from "@jest/globals";
 
 export const standardOidcOptions: IOidcOptions = {

package/src/login/oidc/__mocks__/IssuerConfigFetcher.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2022 Inrupt Inc.
+// Copyright Inrupt Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal in
@@ -19,7 +19,7 @@
 // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 //
 
-import {
+import type {
   IIssuerConfig,
   IIssuerConfigFetcher,
 } from "@inrupt/solid-client-authn-core";

package/src/login/oidc/__mocks__/Redirector.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2022 Inrupt Inc.
+// Copyright Inrupt Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal in
@@ -19,7 +19,7 @@
 // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 //
 
-import {
+import type {
   IRedirector,
   IRedirectorOptions,
 } from "@inrupt/solid-client-authn-core";

package/src/login/oidc/incomingRedirectHandler/AuthCodeRedirectHandler.spec.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2022 Inrupt Inc.
+// Copyright Inrupt Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal in
@@ -19,26 +19,27 @@
 // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 //
 
-import {
+import type {
   IClient,
   IClientRegistrar,
   IClientRegistrarOptions,
   IIssuerConfigFetcher,
-  USER_SESSION_PREFIX,
   IIssuerConfig,
+  buildAuthenticatedFetch,
 } from "@inrupt/solid-client-authn-core";
+import { USER_SESSION_PREFIX } from "@inrupt/solid-client-authn-core";
 import {
   StorageUtilityMock,
   mockStorageUtility,
 } from "@inrupt/solid-client-authn-core/mocks";
-import type * as SolidClientAuthnCore from "@inrupt/solid-client-authn-core";
 import { jest, it, describe, expect } from "@jest/globals";
-import { CodeExchangeResult, getBearerToken } from "@inrupt/oidc-client-ext";
+import { getBearerToken } from "@inrupt/oidc-client-ext";
 import type * as OidcClientExt from "@inrupt/oidc-client-ext";
 import { fetch, Response, Headers } from "@inrupt/universal-fetch";
-import * as UniversalFetch from "@inrupt/universal-fetch";
-import { JWK, importJWK } from "jose";
-import { KeyObject } from "crypto";
+import type * as UniversalFetch from "@inrupt/universal-fetch";
+import type { JWK } from "jose";
+import { importJWK } from "jose";
+import type { KeyObject } from "crypto";
 import { AuthCodeRedirectHandler } from "./AuthCodeRedirectHandler";
 import { SessionInfoManagerMock } from "../../../sessionInfo/__mocks__/SessionInfoManager";
 import { LocalStorageMock } from "../../../storage/__mocks__/LocalStorage";
@@ -116,31 +117,33 @@ const mockAccessTokenDpop = (): AccessJwt => {
 const mockAccessTokenBearer = (): string => "some token";
 
 const MOCK_EXPIRE_TIME = 1337;
-const mockTokenEndpointBearerResponse = (): CodeExchangeResult => {
-  return {
-    accessToken: mockAccessTokenBearer(),
-    idToken: mockIdToken(),
-    webId: mockWebId(),
-    expiresIn: MOCK_EXPIRE_TIME,
-    refreshToken: "some refresh token",
+const mockTokenEndpointBearerResponse =
+  (): OidcClientExt.CodeExchangeResult => {
+    return {
+      accessToken: mockAccessTokenBearer(),
+      idToken: mockIdToken(),
+      webId: mockWebId(),
+      expiresIn: MOCK_EXPIRE_TIME,
+      refreshToken: "some refresh token",
+    };
   };
-};
 
-const mockTokenEndpointDpopResponse = async (): Promise<CodeExchangeResult> => {
-  return {
-    accessToken: JSON.stringify(mockAccessTokenDpop()),
-    idToken: mockIdToken(),
-    webId: mockWebId(),
-    dpopKey: {
-      privateKey: (await importJWK(mockJwk())) as KeyObject,
-      // Note that here for convenience the private key is also used as public key.
-      // Obviously, this should never be done in non-test code.
-      publicKey: mockJwk(),
-    },
-    expiresIn: MOCK_EXPIRE_TIME,
-    refreshToken: "some DPoP-bound refresh token",
+const mockTokenEndpointDpopResponse =
+  async (): Promise<OidcClientExt.CodeExchangeResult> => {
+    return {
+      accessToken: JSON.stringify(mockAccessTokenDpop()),
+      idToken: mockIdToken(),
+      webId: mockWebId(),
+      dpopKey: {
+        privateKey: (await importJWK(mockJwk())) as KeyObject,
+        // Note that here for convenience the private key is also used as public key.
+        // Obviously, this should never be done in non-test code.
+        publicKey: mockJwk(),
+      },
+      expiresIn: MOCK_EXPIRE_TIME,
+      refreshToken: "some DPoP-bound refresh token",
+    };
   };
-};
 
 const mockLocalStorage = (stored: Record<string, string>) => {
   // Kinda weird: `(window as any).localStorage = new LocalStorageMock(stored)` does
@@ -154,11 +157,6 @@ const mockLocalStorage = (stored: Record<string, string>) => {
 };
 
 jest.mock("@inrupt/oidc-client-ext");
-// jest.mock("cross-fetch", () => ({
-//   ...(jest.requireActual("cross-fetch") as typeof CrossFetch),
-//   default: jest.fn<typeof fetch>(),
-//   fetch: jest.fn<typeof fetch>(),
-// }));
 
 jest.useFakeTimers();
 
@@ -558,7 +556,7 @@ describe("AuthCodeRedirectHandler", () => {
         mockRedirectUrl()
       );
 
-      expect(sessionInfo.expirationDate).toBeNull();
+      expect(sessionInfo.expirationDate).toBeUndefined();
     });
 
     it("clears the oidc-client specific session information", async () => {
@@ -580,9 +578,9 @@ describe("AuthCodeRedirectHandler", () => {
   it("returns a fetch that supports the refresh flow", async () => {
     mockOidcClient();
     const mockedStorage = mockDefaultStorageUtility();
-    const coreModule = jest.requireActual<typeof SolidClientAuthnCore>(
-      "@inrupt/solid-client-authn-core"
-    );
+    const coreModule = jest.requireActual<{
+      buildAuthenticatedFetch: typeof buildAuthenticatedFetch;
+    }>("@inrupt/solid-client-authn-core");
     const mockAuthenticatedFetchBuild = jest.spyOn(
       coreModule,
       "buildAuthenticatedFetch"

package/src/login/oidc/incomingRedirectHandler/AuthCodeRedirectHandler.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2022 Inrupt Inc.
+// Copyright Inrupt Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal in
@@ -27,27 +27,30 @@
 // being unauthenticated. This should be looked into when migrating to universal-fetch.
 // import { fetch } from "cross-fetch";
 
-import { fetch } from "@inrupt/universal-fetch";
+import { fetch as uniFetch } from "@inrupt/universal-fetch";
 
-import {
-  buildAuthenticatedFetch,
+import type {
   IClient,
   IClientRegistrar,
   IIssuerConfigFetcher,
   IIncomingRedirectHandler,
-  ISessionInfo,
   ISessionInfoManager,
   IStorageUtility,
   ITokenRefresher,
-  loadOidcContextFromStorage,
   RefreshOptions,
+  IncomingRedirectResult,
 } from "@inrupt/solid-client-authn-core";
 import {
-  getDpopToken,
-  getBearerToken,
-  CodeExchangeResult,
-} from "@inrupt/oidc-client-ext";
-import { EventEmitter } from "events";
+  buildAuthenticatedFetch,
+  loadOidcContextFromStorage,
+  maybeBuildRpInitiatedLogout,
+} from "@inrupt/solid-client-authn-core";
+import type { CodeExchangeResult } from "@inrupt/oidc-client-ext";
+import { getDpopToken, getBearerToken } from "@inrupt/oidc-client-ext";
+import type { EventEmitter } from "events";
+
+const globalFetch: typeof uniFetch = (...args) =>
+  uniFetch.call(globalThis, ...args);
 
 /**
  * @hidden
@@ -78,7 +81,7 @@ export class AuthCodeRedirectHandler implements IIncomingRedirectHandler {
   async handle(
     redirectUrl: string,
     eventEmitter?: EventEmitter
-  ): Promise<ISessionInfo & { fetch: typeof fetch }> {
+  ): Promise<IncomingRedirectResult> {
     if (!(await this.canHandle(redirectUrl))) {
       throw new Error(
         `AuthCodeRedirectHandler cannot handle [${redirectUrl}]: it is missing one of [code, state].`
@@ -162,12 +165,16 @@ export class AuthCodeRedirectHandler implements IIncomingRedirectHandler {
       };
     }
 
-    const authFetch = await buildAuthenticatedFetch(fetch, tokens.accessToken, {
-      dpopKey: tokens.dpopKey,
-      refreshOptions,
-      eventEmitter,
-      expiresIn: tokens.expiresIn,
-    });
+    const authFetch = await buildAuthenticatedFetch(
+      globalFetch,
+      tokens.accessToken,
+      {
+        dpopKey: tokens.dpopKey,
+        refreshOptions,
+        eventEmitter,
+        expiresIn: tokens.expiresIn,
+      }
+    );
 
     await this.storageUtility.setForUser(
       storedSessionId,
@@ -185,10 +192,14 @@ export class AuthCodeRedirectHandler implements IIncomingRedirectHandler {
 
     return Object.assign(sessionInfo, {
       fetch: authFetch,
+      getLogoutUrl: maybeBuildRpInitiatedLogout({
+        idTokenHint: tokens.idToken,
+        endSessionEndpoint: issuerConfig.endSessionEndpoint,
+      }),
       expirationDate:
         typeof tokens.expiresIn === "number"
           ? tokenCreatedAt + tokens.expiresIn * 1000
-          : null,
-    });
+          : undefined,
+    } as IncomingRedirectResult);
   }
 }

package/src/login/oidc/incomingRedirectHandler/ErrorOidcHandler.spec.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2022 Inrupt Inc.
+// Copyright Inrupt Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal in
@@ -22,8 +22,7 @@
 import { jest, it, describe, expect } from "@jest/globals";
 import { EventEmitter } from "events";
 import { EVENTS } from "@inrupt/solid-client-authn-core";
-import { fetch } from "@inrupt/universal-fetch";
-import * as UniversalFetch from "@inrupt/universal-fetch";
+import type * as UniversalFetch from "@inrupt/universal-fetch";
 import { ErrorOidcHandler } from "./ErrorOidcHandler";
 
 jest.mock("@inrupt/universal-fetch", () => {
@@ -32,7 +31,7 @@ jest.mock("@inrupt/universal-fetch", () => {
   ) as typeof UniversalFetch;
   return {
     ...fetchModule,
-    fetch: jest.fn<typeof fetch>(),
+    fetch: jest.fn<(typeof UniversalFetch)["fetch"]>(),
   };
 });
 

package/src/login/oidc/incomingRedirectHandler/ErrorOidcHandler.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2022 Inrupt Inc.
+// Copyright Inrupt Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal in
@@ -24,11 +24,11 @@
  * @packageDocumentation
  */
 
-import {
-  EVENTS,
+import type {
   IIncomingRedirectHandler,
   ISessionInfo,
 } from "@inrupt/solid-client-authn-core";
+import { EVENTS } from "@inrupt/solid-client-authn-core";
 import type { EventEmitter } from "events";
 
 import { getUnauthenticatedSession } from "../../../sessionInfo/SessionInfoManager";

package/src/login/oidc/incomingRedirectHandler/FallbackRedirectHandler.spec.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2022 Inrupt Inc.
+// Copyright Inrupt Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal in
@@ -20,8 +20,7 @@
 //
 
 import { jest, it, describe, expect } from "@jest/globals";
-import { fetch } from "@inrupt/universal-fetch";
-import * as UniversalFetch from "@inrupt/universal-fetch";
+import type * as UniversalFetch from "@inrupt/universal-fetch";
 import { FallbackRedirectHandler } from "./FallbackRedirectHandler";
 
 jest.mock("@inrupt/universal-fetch", () => {
@@ -30,7 +29,7 @@ jest.mock("@inrupt/universal-fetch", () => {
   ) as typeof UniversalFetch;
   return {
     ...fetchModule,
-    fetch: jest.fn<typeof fetch>(),
+    fetch: jest.fn<(typeof UniversalFetch)["fetch"]>(),
   };
 });
 

package/src/login/oidc/incomingRedirectHandler/FallbackRedirectHandler.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2022 Inrupt Inc.
+// Copyright Inrupt Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal in
@@ -24,7 +24,7 @@
  * @packageDocumentation
  */
 
-import {
+import type {
   IIncomingRedirectHandler,
   ISessionInfo,
 } from "@inrupt/solid-client-authn-core";

package/src/login/oidc/oidcHandlers/AuthorizationCodeWithPkceOidcHandler.spec.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2022 Inrupt Inc.
+// Copyright Inrupt Inc.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to deal in
@@ -25,11 +25,11 @@ import mockConsole from "jest-mock-console";
 /**
  * Test for AuthorizationCodeWithPkceOidcHandler
  */
-import {
+import type {
   IOidcOptions,
   IRedirectorOptions,
-  StorageUtility,
 } from "@inrupt/solid-client-authn-core";
+import { StorageUtility } from "@inrupt/solid-client-authn-core";
 import {
   StorageUtilityMock,
   mockStorage,