@inrupt/solid-client-authn-browser 3.0.0 → 3.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inrupt/solid-client-authn-browser",
-  "version": "3.0.0",
+  "version": "3.1.1",
   "license": "MIT",
   "types": "dist/index.d.ts",
   "browser": "dist/index.js",
@@ -26,18 +26,17 @@
     "build-docs-preview-site": "npm run build-api-docs; cd docs/api; make html"
   },
   "devDependencies": {
-    "@types/node": "^24.0.7",
+    "@types/node": "^24.9.1",
     "@types/uuid": "^10.0.0"
   },
   "dependencies": {
-    "@inrupt/oidc-client-ext": "^3.0.0",
-    "@inrupt/solid-client-authn-core": "^3.0.0",
+    "@inrupt/oidc-client-ext": "^3.1.1",
+    "@inrupt/solid-client-authn-core": "^3.1.1",
     "events": "^3.3.0",
     "jose": "^5.1.3",
     "uuid": "^11.1.0"
   },
   "publishConfig": {
     "access": "public"
-  },
-  "gitHead": "af698e70dec2fe50f82ec6b85f7192161bbef482"
+  }
 }

package/src/defaultSession.ts

@@ -49,10 +49,12 @@ export function getDefaultSession(): Session {
  * @since 1.3.0
  */
 /* eslint-disable-next-line no-shadow */
-export const fetch: Session["fetch"] = (...args) => {
+export function fetch(
+  ...args: Parameters<Session["fetch"]>
+): ReturnType<Session["fetch"]> {
   const session = getDefaultSession();
   return session.fetch(...args);
-};
+}
 
 /**
  * Triggers the login process. Note that this method will redirect the user away from your app.
@@ -61,10 +63,12 @@ export const fetch: Session["fetch"] = (...args) => {
  * @returns This method should redirect the user away from the app: it does not return anything. The login process is completed by [[handleIncomingRedirect]].
  * @since 1.3.0
  */
-export const login: Session["login"] = (...args) => {
+export function login(
+  ...args: Parameters<Session["login"]>
+): ReturnType<Session["login"]> {
   const session = getDefaultSession();
   return session.login(...args);
-};
+}
 
 /**
  * Logs the user out of the application.
@@ -75,10 +79,12 @@ export const login: Session["login"] = (...args) => {
  *
  * @since 1.3.0
  */
-export const logout: Session["logout"] = (...args) => {
+export function logout(
+  ...args: Parameters<Session["logout"]>
+): ReturnType<Session["logout"]> {
   const session = getDefaultSession();
   return session.logout(...args);
-};
+}
 
 /**
  * Completes the login process by processing the information provided by the Solid identity provider through redirect.
@@ -86,18 +92,18 @@ export const logout: Session["logout"] = (...args) => {
  * @param url The URL of the page handling the redirect, including the query parameters — these contain the information to process the login.
  * @since 1.3.0
  */
-export const handleIncomingRedirect: Session["handleIncomingRedirect"] = (
-  ...args
-) => {
+export function handleIncomingRedirect(
+  ...args: Parameters<Session["handleIncomingRedirect"]>
+): ReturnType<Session["handleIncomingRedirect"]> {
   const session = getDefaultSession();
   return session.handleIncomingRedirect(...args);
-};
+}
 
 /**
  * {@link SessionEventEmitter} instance to subscribe to events by the default session.
  *
  * @since 1.14.0
  */
-export const events = (): Session["events"] => {
+export function events(): Session["events"] {
   return getDefaultSession().events;
-};
+}

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

@@ -58,6 +58,18 @@ describe("OidcLoginHandler", () => {
     );
   }
 
+  const oidcHandlerWithMocks = () => {
+    const actualHandler = defaultMocks.oidcHandler;
+    const issuerConfig = IssuerConfigFetcherFetchConfigResponse;
+    const handler = getInitialisedHandler({
+      issuerConfigFetcher: mockIssuerConfigFetcher(
+        issuerConfig,
+      ) as jest.Mocked<IIssuerConfigFetcher>,
+      oidcHandler: actualHandler,
+    });
+    return { handler, mockOidcHandler: actualHandler };
+  };
+
   it("should call the actual handler when an Oidc Issuer is provided", async () => {
     const actualHandler = defaultMocks.oidcHandler;
     const handler = getInitialisedHandler({ oidcHandler: actualHandler });
@@ -322,4 +334,67 @@ describe("OidcLoginHandler", () => {
       }),
     );
   });
+
+  it("ignores malformed scopes", async () => {
+    const { handler, mockOidcHandler } = oidcHandlerWithMocks();
+    await handler.handle({
+      sessionId: "mySession",
+      oidcIssuer: "https://arbitrary.url",
+      redirectUrl: "https://app.com/redirect",
+      tokenType: "DPoP",
+      keepAlive: false,
+      customScopes: [
+        // @ts-expect-error This tests misuse of the API.
+        { not: "a string" },
+        "some invalid scope including spaces",
+        "valid_scope",
+      ],
+    });
+    expect(mockOidcHandler.handle).toHaveBeenCalledWith(
+      expect.objectContaining({
+        scopes: ["openid", "offline_access", "webid", "valid_scope"],
+      }),
+    );
+  });
+
+  it("adds provided scopes to default ones", async () => {
+    const { handler, mockOidcHandler } = oidcHandlerWithMocks();
+    await handler.handle({
+      sessionId: "mySession",
+      oidcIssuer: "https://arbitrary.url",
+      redirectUrl: "https://app.com/redirect",
+      tokenType: "DPoP",
+      keepAlive: false,
+      customScopes: ["scope_1", "scope_2", "scope_3"],
+    });
+    expect(mockOidcHandler.handle).toHaveBeenCalledWith(
+      expect.objectContaining({
+        scopes: [
+          "openid",
+          "offline_access",
+          "webid",
+          "scope_1",
+          "scope_2",
+          "scope_3",
+        ],
+      }),
+    );
+  });
+
+  it("de-dupes scopes", async () => {
+    const { handler, mockOidcHandler } = oidcHandlerWithMocks();
+    await handler.handle({
+      sessionId: "mySession",
+      oidcIssuer: "https://arbitrary.url",
+      redirectUrl: "https://app.com/redirect",
+      tokenType: "DPoP",
+      keepAlive: false,
+      customScopes: ["webid", "custom_scope", "custom_scope"],
+    });
+    expect(mockOidcHandler.handle).toHaveBeenCalledWith(
+      expect.objectContaining({
+        scopes: ["openid", "offline_access", "webid", "custom_scope"],
+      }),
+    );
+  });
 });

package/src/login/oidc/OidcLoginHandler.ts

@@ -42,6 +42,7 @@ import type {
 import {
   ConfigurationError,
   handleRegistration,
+  normalizeScopes,
 } from "@inrupt/solid-client-authn-core";
 
 function hasIssuer(
@@ -116,6 +117,7 @@ export default class OidcLoginHandler implements ILoginHandler {
       ...options,
       issuerConfiguration: issuerConfig,
       client: clientRegistration,
+      scopes: normalizeScopes(options.customScopes),
     };
 
     // Call proper OIDC Handler

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

@@ -19,7 +19,10 @@
 // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 //
 
-import type { IOidcOptions } from "@inrupt/solid-client-authn-core";
+import {
+  DEFAULT_SCOPES,
+  type IOidcOptions,
+} from "@inrupt/solid-client-authn-core";
 import { jest } from "@jest/globals";
 
 export const standardOidcOptions: IOidcOptions = {
@@ -42,4 +45,5 @@ export const standardOidcOptions: IOidcOptions = {
     clientId: "coolApp",
     clientType: "dynamic",
   },
+  scopes: DEFAULT_SCOPES,
 };

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

@@ -235,7 +235,7 @@ describe("AuthorizationCodeWithPkceOidcHandler", () => {
       );
     });
 
-    it("requests both openid, offline_access and webid scopes", async () => {
+    it("includes the provided scopes in the authorization request", async () => {
       const oidcModule = mockOidcModule();
       const authorizationCodeWithPkceOidcHandler =
         getAuthorizationCodeWithPkceOidcHandler();
@@ -245,11 +245,12 @@ describe("AuthorizationCodeWithPkceOidcHandler", () => {
           ...standardOidcOptions.issuerConfiguration,
           grantTypesSupported: ["authorization_code"],
         },
+        scopes: ["openid", "webid", "custom_scope"],
       };
       await authorizationCodeWithPkceOidcHandler.handle(oidcOptions);
       expect(oidcModule.OidcClient).toHaveBeenCalledWith(
         expect.objectContaining({
-          scope: "openid offline_access webid",
+          scope: "openid webid custom_scope",
         }),
       );
     });

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

@@ -32,10 +32,7 @@ import type {
   IOidcOptions,
   LoginResult,
 } from "@inrupt/solid-client-authn-core";
-import {
-  DEFAULT_SCOPES,
-  AuthorizationCodeWithPkceOidcHandlerBase,
-} from "@inrupt/solid-client-authn-core";
+import { AuthorizationCodeWithPkceOidcHandlerBase } from "@inrupt/solid-client-authn-core";
 import { OidcClient } from "@inrupt/oidc-client-ext";
 
 /**
@@ -55,7 +52,7 @@ export default class AuthorizationCodeWithPkceOidcHandler
       client_secret: oidcLoginOptions.client.clientSecret,
       redirect_uri: oidcLoginOptions.redirectUrl,
       response_type: "code",
-      scope: DEFAULT_SCOPES,
+      scope: oidcLoginOptions.scopes.join(" "),
       filterProtocolClaims: true,
       // The userinfo endpoint on NSS fails, so disable this for now
       // Note that in Solid, information should be retrieved from the

package/tsconfig.json

@@ -6,14 +6,6 @@
     "outDir": "./dist"
   },
 
-  "typedocOptions": {
-    "out": "website/docs/api/browser",
-    "entryPoints": ["./src/index.ts"],
-    "entryDocument": "index.rst",
-    "hideInPageTOC": true,
-    "plugin": ["typedoc-plugin-markdown"]
-  },
-
   "include": ["src/**/*"],
   "exclude": ["src/**/*.spec.ts", "**/__mocks__/*"]
 }

package/typedoc.config.mjs

@@ -0,0 +1,39 @@
+//
+// 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
+// the Software without restriction, including without limitation the rights to use,
+// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+// Software, and to permit persons to whom the Software is furnished to do so,
+// subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+// PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+
+export default {
+  compilerOptions: {
+    skipLibCheck: true,
+  },
+  out: "../../docs/api/browser",
+  entryPoints: ["./src/index.ts"],
+  exclude: [
+    "node_modules/**",
+    "**/*.test.ts",
+    // Internal helpers:
+    "**/*.internal.ts",
+    // End-to-end tests:
+    "e2e/**",
+  ],
+  navigation: {
+    includeCategories: true,
+  },
+};

package/LICENSE

@@ -1,21 +0,0 @@
-Begin license text.
-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 
-the Software without restriction, including without limitation the rights to use, 
-copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the 
-Software, and to permit persons to whom the Software is furnished to do so, 
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in 
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
-INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
-PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 
-HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-End license text.Source Distributions