@asgardeo/auth-spa 0.2.21 → 0.3.1

package/src/clients/main-thread-client.ts

@@ -19,6 +19,7 @@
 import {
     AUTHORIZATION_CODE,
     AsgardeoAuthClient,
+    AsgardeoAuthException,
     AuthClientConfig,
     AuthenticationUtils,
     BasicUserInfo,
@@ -45,7 +46,6 @@ import {
     SILENT_SIGN_IN_STATE,
     Storage
 } from "../constants";
-import { AsgardeoSPAException } from "../exception";
 import { SPAHelper, SessionManagementHelper } from "../helpers";
 import { HttpClient, HttpClientInstance } from "../http-client";
 import {
@@ -105,7 +105,7 @@ export const MainThreadClient = async (
         if (requestConfig.attachToken) {
             request.headers = {
                 ...request.headers,
-                Authorization: `Bearer ${await _authenticationClient.getAccessToken()}`
+                Authorization: `Bearer ${ await _authenticationClient.getAccessToken() }`
             };
         }
     };
@@ -132,9 +132,10 @@ export const MainThreadClient = async (
     const httpRequest = async (requestConfig: HttpRequestConfig): Promise<HttpResponse> => {
         let matches = false;
         const config = await _dataLayer.getConfigData();
+        const serverOrigin = (config as any).baseUrl || (config as any).serverOrigin;
 
-        for (const baseUrl of [...((await config?.resourceServerURLs) ?? []), config?.serverOrigin]) {
-            if (requestConfig?.url?.startsWith(baseUrl)) {
+        for (const baseUrl of [ ...((await config?.resourceServerURLs) ?? []), serverOrigin ]) {
+            if (baseUrl && requestConfig?.url?.startsWith(baseUrl)) {
                 matches = true;
 
                 break;
@@ -163,15 +164,12 @@ export const MainThreadClient = async (
                                 }
                             }
 
-                            return Promise.reject(
-                                new AsgardeoSPAException(
-                                    "MAIN_THREAD_CLIENT-HR-ES01",
-                                    "main-thread-client",
-                                    "httpRequest",
-                                    "",
-                                    "",
-                                    refreshError
-                                )
+                            throw new AsgardeoAuthException(
+                                "SPA-MAIN_THREAD_CLIENT-HR-SE01",
+                                refreshError?.name ?? "Refresh token request failed.",
+                                refreshError?.message ??
+                                "An error occurred while trying to refresh the " +
+                                "access token following a 401 response from the server."
                             );
                         }
 
@@ -207,16 +205,12 @@ export const MainThreadClient = async (
                     return Promise.reject(error);
                 });
         } else {
-            return Promise.reject(
-                new AsgardeoSPAException(
-                    "MAIN_THREAD_CLIENT-HR-IV02",
-                    "main-thread-client",
-                    "httpRequest",
-                    "Request to the provided endpoint is prohibited.",
-                    "Requests can only be sent to resource servers specified by the `resourceServerURLs`" +
-                        " attribute while initializing the SDK. The specified endpoint in this request " +
-                        "cannot be found among the `resourceServerURLs`"
-                )
+            throw new AsgardeoAuthException(
+                "SPA-MAIN_THREAD_CLIENT-HR-IV02",
+                "Request to the provided endpoint is prohibited.",
+                "Requests can only be sent to resource servers specified by the `resourceServerURLs`" +
+                " attribute while initializing the SDK. The specified endpoint in this request " +
+                "cannot be found among the `resourceServerURLs`"
             );
         }
     };
@@ -225,11 +219,16 @@ export const MainThreadClient = async (
         let matches = true;
         const config = await _dataLayer.getConfigData();
 
+        const serverOrigin = (config as any).baseUrl || (config as any).serverOrigin;
+
         for (const requestConfig of requestConfigs) {
             let urlMatches = false;
 
-            for (const baseUrl of [...((await config)?.resourceServerURLs ?? []), config?.serverOrigin]) {
-                if (requestConfig.url?.startsWith(baseUrl)) {
+            for (const baseUrl of [
+                ...((await config)?.resourceServerURLs ?? []),
+                serverOrigin
+            ]) {
+                if (baseUrl && requestConfig.url?.startsWith(baseUrl)) {
                     urlMatches = true;
 
                     break;
@@ -259,7 +258,7 @@ export const MainThreadClient = async (
                     })
                     .catch(async (error: HttpError) => {
                         if (error?.response?.status === 401 || !error?.response) {
-                            let refreshTokenResponse;
+                            let refreshTokenResponse: TokenResponse;
                             try {
                                 refreshTokenResponse = await _authenticationClient.refreshAccessToken();
                             } catch (refreshError: any) {
@@ -272,20 +271,18 @@ export const MainThreadClient = async (
                                     }
                                 }
 
-                                return Promise.reject(
-                                    new AsgardeoSPAException(
-                                        "MAIN_THREAD_CLIENT-HRA-ES01",
-                                        "main-thread-client",
-                                        "httpRequestAll",
-                                        "",
-                                        "",
-                                        refreshError
-                                    )
+                                throw new AsgardeoAuthException(
+                                    "SPA-MAIN_THREAD_CLIENT-HRA-SE01",
+                                    refreshError?.name ?? "Refresh token request failed.",
+                                    refreshError?.message ??
+                                    "An error occurred while trying to refresh the " +
+                                    "access token following a 401 response from the server."
                                 );
                             }
 
                             if (refreshTokenResponse) {
-                                return _httpClient.all &&
+                                return (
+                                    _httpClient.all &&
                                     _httpClient
                                         .all(requests)
                                         .then((response) => {
@@ -302,7 +299,8 @@ export const MainThreadClient = async (
                                             }
 
                                             return Promise.reject(error);
-                                        });
+                                        })
+                                );
                             }
                         }
 
@@ -319,16 +317,12 @@ export const MainThreadClient = async (
                     })
             );
         } else {
-            return Promise.reject(
-                new AsgardeoSPAException(
-                    "MAIN_THREAD_CLIENT-HRA-IV02",
-                    "main-thread-client",
-                    "httpRequest",
-                    "Request to the provided endpoint is prohibited.",
-                    "Requests can only be sent to resource servers specified by the `resourceServerURLs`" +
-                        " attribute while initializing the SDK. The specified endpoint in this request " +
-                        "cannot be found among the `resourceServerURLs`"
-                )
+            throw new AsgardeoAuthException(
+                "SPA-MAIN_THREAD_CLIENT-HRA-IV02",
+                "Request to the provided endpoint is prohibited.",
+                "Requests can only be sent to resource servers specified by the `resourceServerURLs`" +
+                " attribute while initializing the SDK. The specified endpoint in this request " +
+                "cannot be found among the `resourceServerURLs`"
             );
         }
     };
@@ -362,7 +356,7 @@ export const MainThreadClient = async (
             config.checkSessionInterval ?? 3,
             config.sessionRefreshInterval ?? 300,
             config.signInRedirectURL,
-            async (params?: GetAuthURLConfig): Promise<string> =>  _authenticationClient.getAuthorizationURL(params)
+            async (params?: GetAuthURLConfig): Promise<string> => _authenticationClient.getAuthorizationURL(params)
         );
     };
 
@@ -421,7 +415,7 @@ export const MainThreadClient = async (
             SPAUtils.removeAuthorizationCode();
         }
 
-        if (resolvedAuthorizationCode) {
+        if (resolvedAuthorizationCode && resolvedState) {
             return requestAccessToken(resolvedAuthorizationCode, resolvedSessionState, resolvedState);
         }
 
@@ -435,15 +429,7 @@ export const MainThreadClient = async (
 
             history.pushState(null, document.title, url.toString());
 
-            return Promise.reject(
-                new AsgardeoSPAException(
-                    "MAIN_THREAD_CLIENT-SI-BE",
-                    "main-thread-client",
-                    "signIn",
-                    error,
-                    errorDescription ?? ""
-                )
-            );
+            throw new AsgardeoAuthException("SPA-MAIN_THREAD_CLIENT-SI-SE01", error, errorDescription ?? "");
         }
 
         return _authenticationClient.getAuthorizationURL(signInConfig).then(async (url: string) => {
@@ -470,7 +456,7 @@ export const MainThreadClient = async (
     };
 
     const signOut = async (): Promise<boolean> => {
-        if (await _authenticationClient.isAuthenticated() && !_getSignOutURLFromSessionStorage) {
+        if ((await _authenticationClient.isAuthenticated()) && !_getSignOutURLFromSessionStorage) {
             location.href = await _authenticationClient.signOut();
         } else {
             location.href = SPAUtils.getSignOutURL();
@@ -489,22 +475,24 @@ export const MainThreadClient = async (
     const requestCustomGrant = async (config: SPACustomGrantConfig): Promise<BasicUserInfo | FetchResponse> => {
         let useDefaultEndpoint = true;
         let matches = false;
-        const clientConfig = await _dataLayer.getConfigData();
+
+        const serverOrigin = (config as any).baseUrl || (config as any).serverOrigin;
 
         // If the config does not contains a token endpoint, default token endpoint will be used.
         if (config?.tokenEndpoint) {
             useDefaultEndpoint = false;
+
             for (const baseUrl of [
                 ...((await _dataLayer.getConfigData())?.resourceServerURLs ?? []),
-                clientConfig?.serverOrigin
+                serverOrigin
             ]) {
-                if (config.tokenEndpoint?.startsWith(baseUrl)) {
+                if (baseUrl && config.tokenEndpoint?.startsWith(baseUrl)) {
                     matches = true;
                     break;
                 }
             }
         }
-        if(config.shouldReplayAfterRefresh) {
+        if (config.shouldReplayAfterRefresh) {
             _dataLayer.setTemporaryDataParameter(CUSTOM_GRANT_CONFIG, JSON.stringify(config));
         }
         if (useDefaultEndpoint || matches) {
@@ -528,14 +516,12 @@ export const MainThreadClient = async (
                 });
         } else {
             return Promise.reject(
-                new AsgardeoSPAException(
-                    "MAIN_THREAD_CLIENT-RCG-IV01",
-                    "main-thread-client",
-                    "requestCustomGrant",
+                new AsgardeoAuthException(
+                    "SPA-MAIN_THREAD_CLIENT-RCG-IV01",
                     "Request to the provided endpoint is prohibited.",
                     "Requests can only be sent to resource servers specified by the `resourceServerURLs`" +
-                        " attribute while initializing the SDK. The specified token endpoint in this request " +
-                        "cannot be found among the `resourceServerURLs`"
+                    " attribute while initializing the SDK. The specified token endpoint in this request " +
+                    "cannot be found among the `resourceServerURLs`"
                 )
             );
         }
@@ -580,7 +566,8 @@ export const MainThreadClient = async (
 
             await _authenticationClient.setPKCECode(
                 AuthenticationUtils.extractPKCEKeyFromStateParam(resolvedState),
-                pkce);
+                pkce
+            );
         }
 
         return _authenticationClient
@@ -652,8 +639,9 @@ export const MainThreadClient = async (
                 const state = urlObject.searchParams.get(STATE);
 
                 SPAUtils.setPKCE(
-                    AuthenticationUtils.extractPKCEKeyFromStateParam( state ?? ""),
-                    (await _authenticationClient.getPKCECode(state ?? "")) as string);
+                    AuthenticationUtils.extractPKCEKeyFromStateParam(state ?? ""),
+                    (await _authenticationClient.getPKCECode(state ?? "")) as string
+                );
             }
 
             promptNoneIFrame.src = url;
@@ -742,11 +730,11 @@ export const MainThreadClient = async (
     };
 
     const getCustomGrantConfigData = async (): Promise<AuthClientConfig<CustomGrantConfig> | null> => {
-        const configString =  await _dataLayer.getTemporaryDataParameter(CUSTOM_GRANT_CONFIG);
-        if(configString) {
+        const configString = await _dataLayer.getTemporaryDataParameter(CUSTOM_GRANT_CONFIG);
+        if (configString) {
             return JSON.parse(configString as string);
         } else {
-            return null
+            return null;
         }
     };
 

package/src/clients/web-worker-client.ts

@@ -18,6 +18,7 @@
 
 import {
     AUTHORIZATION_CODE,
+    AsgardeoAuthException,
     AuthClientConfig,
     AuthenticationUtils,
     BasicUserInfo,
@@ -26,7 +27,6 @@ import {
     FetchResponse,
     GetAuthURLConfig,
     OIDCEndpoints,
-    OIDCProviderMetaData,
     ResponseMode,
     SESSION_STATE,
     STATE
@@ -65,7 +65,6 @@ import {
     START_AUTO_REFRESH_TOKEN,
     UPDATE_CONFIG
 } from "../constants";
-import { AsgardeoSPAException } from "../exception";
 import { SessionManagementHelper } from "../helpers";
 import {
     AuthorizationInfo,
@@ -83,7 +82,8 @@ import { SPACustomGrantConfig } from "../models/request-custom-grant";
 import { SPAUtils } from "../utils";
 
 export const WebWorkerClient = async (
-    config: AuthClientConfig<WebWorkerClientConfig>): Promise<WebWorkerClientInterface> => {
+    config: AuthClientConfig<WebWorkerClientConfig>
+): Promise<WebWorkerClientInterface> => {
     /**
      * HttpClient handlers
      */
@@ -118,24 +118,22 @@ export const WebWorkerClient = async (
     const communicate = <T, R>(message: Message<T>): Promise<R> => {
         const channel = new MessageChannel();
 
-        worker.postMessage(message, [channel.port2]);
+        worker.postMessage(message, [ channel.port2 ]);
 
         return new Promise((resolve, reject) => {
             const timer = setTimeout(() => {
                 reject(
-                    new AsgardeoSPAException(
-                        "WEB_WORKER_CLIENT-COM-TO-01",
-                        "web-worker-client",
-                        "communicate",
+                    new AsgardeoAuthException(
+                        "SPA-WEB_WORKER_CLIENT-COM-TO01",
                         "Operation timed out.",
                         "No response was received from the web worker for " +
-                            _requestTimeout / 1000 +
-                            " since dispatching the request"
+                        _requestTimeout / 1000 +
+                        " since dispatching the request"
                     )
                 );
             }, _requestTimeout);
 
-            return (channel.port1.onmessage = ({ data }: { data: ResponseMessage<string> }) => {
+            return (channel.port1.onmessage = ({ data }: { data: ResponseMessage<string>; }) => {
                 clearTimeout(timer);
 
                 if (data?.success) {
@@ -466,13 +464,15 @@ export const WebWorkerClient = async (
             async (response: AuthorizationResponse) => {
                 if (response.pkce && config.enablePKCE) {
                     const pkceKey: string = AuthenticationUtils.extractPKCEKeyFromStateParam(
-                        new URL(response.authorizationURL).searchParams.get(STATE) ?? "");
+                        new URL(response.authorizationURL).searchParams.get(STATE) ?? ""
+                    );
 
                     SPAUtils.setPKCE(pkceKey, response.pkce);
                 }
 
                 return Promise.resolve(response);
-        });
+            }
+        );
     };
 
     const requestAccessToken = async (
@@ -486,9 +486,7 @@ export const WebWorkerClient = async (
         const message: Message<AuthorizationInfo> = {
             data: {
                 code: resolvedAuthorizationCode,
-                pkce: config.enablePKCE
-                    ? SPAUtils.getPKCE(pkceKey)
-                    : undefined,
+                pkce: config.enablePKCE ? SPAUtils.getPKCE(pkceKey) : undefined,
                 sessionState: resolvedSessionState,
                 state: resolvedState
             },
@@ -566,15 +564,7 @@ export const WebWorkerClient = async (
 
             history.pushState(null, document.title, url.toString());
 
-            return Promise.reject(
-                new AsgardeoSPAException(
-                    "WEB_WORKER_CLIENT-SI-BE",
-                    "web-worker-client",
-                    "signIn",
-                    error,
-                    errorDescription ?? ""
-                )
-            );
+            throw new AsgardeoAuthException("SPA-WEB_WORKER_CLIENT-SI-SE01", error, errorDescription ?? "");
         }
 
         if (await isAuthenticated()) {
@@ -604,12 +594,12 @@ export const WebWorkerClient = async (
             SPAUtils.removeAuthorizationCode();
         }
 
-        if (resolvedAuthorizationCode) {
+        if (resolvedAuthorizationCode && resolvedState) {
             return requestAccessToken(resolvedAuthorizationCode, resolvedSessionState, resolvedState);
         }
 
-        return getAuthorizationURL(params).then(async (response: AuthorizationResponse)=>{
-
+        return getAuthorizationURL(params)
+            .then(async (response: AuthorizationResponse) => {
                 location.href = response.authorizationURL;
 
                 await SPAUtils.waitTillPageRedirect();
@@ -686,12 +676,12 @@ export const WebWorkerClient = async (
             });
     };
 
-    const getOIDCServiceEndpoints = (): Promise<OIDCProviderMetaData> => {
+    const getOIDCServiceEndpoints = (): Promise<OIDCEndpoints> => {
         const message: Message<null> = {
             type: GET_OIDC_SERVICE_ENDPOINTS
         };
 
-        return communicate<null, OIDCProviderMetaData>(message)
+        return communicate<null, OIDCEndpoints>(message)
             .then((response) => {
                 return Promise.resolve(response);
             })

package/src/models/client.ts

@@ -22,8 +22,7 @@ import {
     CustomGrantConfig,
     DecodedIDTokenPayload,
     FetchResponse,
-    OIDCEndpoints,
-    OIDCProviderMetaData
+    OIDCEndpoints
 } from "@asgardeo/auth-js";
 import {
     HttpError,
@@ -80,7 +79,7 @@ export interface WebWorkerClientInterface {
     ): Promise<BasicUserInfo>;
     signOut(signOutRedirectURL?: string): Promise<boolean>;
     revokeAccessToken(): Promise<boolean>;
-    getOIDCServiceEndpoints(): Promise<OIDCProviderMetaData>;
+    getOIDCServiceEndpoints(): Promise<OIDCEndpoints>;
     getBasicUserInfo(): Promise<BasicUserInfo>;
     getDecodedIDToken(): Promise<DecodedIDTokenPayload>;
     getIDToken(): Promise<string>;

package/src/utils/crypto-utils.ts

@@ -21,11 +21,9 @@ import { CryptoUtils, JWKInterface } from "@asgardeo/auth-js";
 import base64url from "base64url";
 import sha256 from "fast-sha256";
 import { createLocalJWKSet, jwtVerify } from "jose";
-import { FlattenedJWSInput, GetKeyFunction, JWSHeaderParameters } from "jose/dist/types/types";
 import randombytes from "randombytes";
 
-export class SPACryptoUtils
-    implements CryptoUtils<Buffer | string, GetKeyFunction<JWSHeaderParameters, FlattenedJWSInput>>
+export class SPACryptoUtils implements CryptoUtils<Buffer | string>
 {
     /**
      * Get URL encoded string.
@@ -48,30 +46,28 @@ export class SPACryptoUtils
         return randombytes(length);
     }
 
-    public parseJwk(key: Partial<JWKInterface>): Promise<GetKeyFunction<JWSHeaderParameters, FlattenedJWSInput>> {
-        return Promise.resolve(
-            createLocalJWKSet({
-                keys: [ key ]
-            })
-        );
-    }
-
     public verifyJwt(
         idToken: string,
-        jwk: GetKeyFunction<JWSHeaderParameters, FlattenedJWSInput>,
+        jwk: Partial<JWKInterface>,
         algorithms: string[],
         clientID: string,
         issuer: string,
         subject: string,
         clockTolerance?: number
     ): Promise<boolean> {
-        return jwtVerify(idToken, jwk, {
-            algorithms: algorithms,
-            audience: clientID,
-            clockTolerance: clockTolerance,
-            issuer: issuer,
-            subject: subject
-        }).then(() => {
+        return jwtVerify(
+            idToken,
+            createLocalJWKSet({
+                keys: [jwk]
+            }),
+            {
+                algorithms: algorithms,
+                audience: clientID,
+                clockTolerance: clockTolerance,
+                issuer: issuer,
+                subject: subject
+            }
+        ).then(() => {
             return Promise.resolve(true);
         });
     }

package/src/worker/client.worker.ts

@@ -16,7 +16,7 @@
  * under the License.
  */
 
-import { AuthClientConfig, BasicUserInfo } from "@asgardeo/auth-js";
+import { AsgardeoAuthException, AuthClientConfig, BasicUserInfo } from "@asgardeo/auth-js";
 import { WebWorkerCore } from "./worker-core";
 import {
     DISABLE_HTTP_HANDLER,
@@ -44,7 +44,6 @@ import {
     START_AUTO_REFRESH_TOKEN,
     UPDATE_CONFIG
 } from "../constants";
-import { AsgardeoSPAException } from "../exception";
 import {
     AuthorizationResponse,
     HttpResponse,
@@ -63,10 +62,8 @@ ctx.onmessage = async ({ data, ports }) => {
     if (data.type !== INIT && !webWorker) {
         port.postMessage(
             MessageUtils.generateFailureMessage(
-                new AsgardeoSPAException(
-                    "CLIENT_WORKER-ONMSG-NF01",
-                    "client.worker",
-                    data.type,
+                new AsgardeoAuthException(
+                    "SPA-CLIENT_WORKER-ONMSG-NF01",
                     "The web worker has not been initialized yet.",
                     "The initialize method needs to be called before the specified operation can be carried out."
                 )
@@ -264,10 +261,8 @@ ctx.onmessage = async ({ data, ports }) => {
         default:
             port?.postMessage(
                 MessageUtils.generateFailureMessage(
-                    new AsgardeoSPAException(
-                        "CLIENT_WORKER-ONMSG-IV02",
-                        "client.worker",
-                        "onmessage",
+                    new AsgardeoAuthException(
+                        "SPA-CLIENT_WORKER-ONMSG-IV02",
                         "The message type is invalid.",
                         `The message type provided, ${data.type}, is invalid.`
                     )