@asgardeo/auth-spa 0.4.0 → 0.4.3

package/src/client.ts

@@ -21,6 +21,7 @@ import {
     AsgardeoAuthException,
     AuthClientConfig,
     BasicUserInfo,
+    CryptoHelper,
     CustomGrantConfig,
     DataLayer,
     DecodedIDTokenPayload,
@@ -707,6 +708,32 @@ export class AsgardeoSPAClient {
         return this._client?.getDecodedIDToken();
     }
 
+    /**
+     * This method returns the CryptoHelper instance.
+     *
+     * @return {Promise<DecodedIdTokenPayloadInterface>} - A Promise that resolves with
+     * the CryptoHelper instance.
+     *
+     * @example
+     * ```
+     * auth.getCryptoHelper().then((response)=>{
+     *     // console.log(response);
+     * }).catch((error)=>{
+     *     // console.error(error);
+     * });
+     * ```
+     * @link https://github.com/asgardeo/asgardeo-auth-spa-sdk/tree/master#getCryptoHelper
+     *
+     * @memberof AsgardeoSPAClient
+     *
+     * @preserve
+     */
+     public async getCryptoHelper(): Promise<CryptoHelper | undefined> {
+        await this._validateMethod();
+
+        return this._client?.getCryptoHelper();
+    }
+
     /**
      * This method return the ID token.
      *
@@ -796,7 +823,7 @@ export class AsgardeoSPAClient {
         if (this._storage && [ (Storage.WebWorker, Storage.BrowserMemory) ].includes(this._storage)) {
             return Promise.reject(
                 new AsgardeoAuthException(
-                    "SPA-AUTH_CLIENT-GAT-IV01",
+                    "SPA-AUTH_CLIENT-GIAT-IV01",
                     "The access token cannot be returned.",
                     "The access token cannot be returned when the storage type is set to webWorker or browserMemory."
                 )
@@ -835,9 +862,9 @@ export class AsgardeoSPAClient {
         if (this._storage && [ (Storage.WebWorker, Storage.BrowserMemory) ].includes(this._storage)) {
             return Promise.reject(
                 new AsgardeoAuthException(
-                    "SPA-AUTH_CLIENT-GAT-IV01",
-                    "The access token cannot be returned.",
-                    "The access token cannot be returned when the storage type is set to webWorker or browserMemory."
+                    "SPA-AUTH_CLIENT-GDL-IV01",
+                    "The data layer cannot be returned.",
+                    "The data layer cannot be returned when the storage type is set to webWorker or browserMemory."
                 )
             );
         }

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

@@ -22,6 +22,7 @@ import {
     AuthClientConfig,
     AuthenticationUtils,
     BasicUserInfo,
+    CryptoHelper,
     DataLayer,
     DecodedIDTokenPayload,
     FetchResponse,
@@ -96,11 +97,19 @@ export const MainThreadClient = async (
 
     const attachToken = async (request: HttpRequestConfig): Promise<void> => {
         const requestConfig = { attachToken: true, ...request };
+        
         if (requestConfig.attachToken) {
-            request.headers = {
-                ...request.headers,
-                Authorization: `Bearer ${ await _authenticationHelper.getAccessToken() }`
-            };
+            if(requestConfig.shouldAttachIDPAccessToken) {
+                request.headers = {
+                    ...request.headers,
+                    Authorization: `Bearer ${ await _authenticationHelper.getIDPAccessToken() }`
+                };
+            } else {
+                request.headers = {
+                    ...request.headers,
+                    Authorization: `Bearer ${ await _authenticationHelper.getAccessToken() }`
+                };
+            }
         }
     }
 
@@ -356,6 +365,10 @@ export const MainThreadClient = async (
         return _authenticationHelper.getDecodedIDToken();
     };
 
+    const getCryptoHelper = async (): Promise<CryptoHelper> => {
+        return _authenticationHelper.getCryptoHelper();
+    };
+
     const getIDToken = async (): Promise<string> => {
         return _authenticationHelper.getIDToken();
     };
@@ -403,6 +416,7 @@ export const MainThreadClient = async (
         enableHttpHandler,
         getAccessToken,
         getBasicUserInfo,
+        getCryptoHelper,
         getDataLayer,
         getDecodedIDToken,
         getHttpClient,

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

@@ -23,6 +23,7 @@ import {
     AuthClientConfig,
     AuthenticationUtils,
     BasicUserInfo,
+    CryptoHelper,
     CustomGrantConfig,
     DecodedIDTokenPayload,
     FetchResponse,
@@ -39,6 +40,8 @@ import {
     GET_AUTH_URL,
     GET_BASIC_USER_INFO,
     GET_CONFIG_DATA,
+    GET_CRYPTO_HELPER,
+    GET_DECODED_IDP_ID_TOKEN,
     GET_DECODED_ID_TOKEN,
     GET_ID_TOKEN,
     GET_OIDC_SERVICE_ENDPOINTS,
@@ -691,6 +694,34 @@ export const WebWorkerClient = async (
             });
     };
 
+    const getDecodedIDPIDToken = (): Promise<DecodedIDTokenPayload> => {
+        const message: Message<null> = {
+            type: GET_DECODED_IDP_ID_TOKEN
+        };
+
+        return communicate<null, DecodedIDTokenPayload>(message)
+            .then((response) => {
+                return Promise.resolve(response);
+            })
+            .catch((error) => {
+                return Promise.reject(error);
+            });
+    };
+
+    const getCryptoHelper = (): Promise<CryptoHelper> => {
+        const message: Message<null> = {
+            type: GET_CRYPTO_HELPER
+        };
+
+        return communicate<null, CryptoHelper>(message)
+            .then((response) => {
+                return Promise.resolve(response);
+            })
+            .catch((error) => {
+                return Promise.reject(error);
+            });
+    };
+
     const getIDToken = (): Promise<string> => {
         const message: Message<null> = {
             type: GET_ID_TOKEN
@@ -783,6 +814,8 @@ export const WebWorkerClient = async (
         disableHttpHandler,
         enableHttpHandler,
         getBasicUserInfo,
+        getCryptoHelper,
+        getDecodedIDPIDToken,
         getDecodedIDToken,
         getIDToken,
         getOIDCServiceEndpoints,

package/src/constants/messages-types.ts

@@ -32,6 +32,8 @@ export const REQUEST_FINISH = "request-finish";
 export const GET_OIDC_SERVICE_ENDPOINTS = "get-oidc-service-endpoints";
 export const GET_BASIC_USER_INFO = "get-basic-user-info";
 export const GET_DECODED_ID_TOKEN = "get-decoded-id-token";
+export const GET_DECODED_IDP_ID_TOKEN = "get-decoded-idp-id-token";
+export const GET_CRYPTO_HELPER = "get-crypto-helper"
 export const ENABLE_HTTP_HANDLER = "enable_http_handler";
 export const DISABLE_HTTP_HANDLER = "disable_http_handler";
 export const GET_AUTH_URL = "get_auth_url";

package/src/helpers/authentication-helper.ts

@@ -22,6 +22,7 @@ import {
     AuthClientConfig, 
     AuthenticationUtils, 
     BasicUserInfo, 
+    CryptoHelper, 
     CustomGrantConfig, 
     DataLayer, 
     DecodedIDTokenPayload, 
@@ -609,6 +610,14 @@ export class AuthenticationHelper<
         return this._authenticationClient.getDecodedIDToken();
     }
 
+    public async getDecodedIDPIDToken(): Promise<DecodedIDTokenPayload> {
+        return this._authenticationClient.getDecodedIDToken();
+    }
+
+    public async getCryptoHelper(): Promise<CryptoHelper> {
+        return this._authenticationClient.getCryptoHelper();
+    }
+
     public async getIDToken(): Promise<string> {
         return this._authenticationClient.getIDToken();
     }
@@ -621,6 +630,10 @@ export class AuthenticationHelper<
         return this._authenticationClient.getAccessToken();
     }
 
+    public async getIDPAccessToken(): Promise<string> {
+        return (await this._dataLayer.getSessionData())?.access_token;
+    }
+
     public getDataLayer(): DataLayer<T> {
         return this._dataLayer;
     }

package/src/helpers/session-management-helper.ts

@@ -98,7 +98,6 @@ export const SessionManagementHelper = (() => {
         const opIframe: HTMLIFrameElement
             = rpIFrame?.contentDocument?.getElementById(OP_IFRAME) as HTMLIFrameElement;
         opIframe.src = _checkSessionEndpoint + "?client_id=" + _clientID + "&redirect_uri=" + _redirectURL;
-        await checkSession();
 
         _checkSessionIntervalTimeout =  setInterval(checkSession, _interval * 1000) as unknown as number;
 

package/src/models/client.ts

@@ -19,6 +19,7 @@
 import {
     AuthClientConfig,
     BasicUserInfo,
+    CryptoHelper,
     CustomGrantConfig,
     DataLayer,
     DecodedIDTokenPayload,
@@ -57,6 +58,7 @@ export interface MainThreadClientInterface {
     revokeAccessToken(): Promise<boolean>;
     getBasicUserInfo(): Promise<BasicUserInfo>;
     getDecodedIDToken(): Promise<DecodedIDTokenPayload>;
+    getCryptoHelper(): Promise<CryptoHelper>;
     getIDToken(): Promise<string>;
     getOIDCServiceEndpoints(): Promise<OIDCEndpoints>;
     getAccessToken(): Promise<string>;
@@ -84,6 +86,8 @@ export interface WebWorkerClientInterface {
     getOIDCServiceEndpoints(): Promise<OIDCEndpoints>;
     getBasicUserInfo(): Promise<BasicUserInfo>;
     getDecodedIDToken(): Promise<DecodedIDTokenPayload>;
+    getDecodedIDPIDToken(): Promise<DecodedIDTokenPayload>;
+    getCryptoHelper(): Promise<CryptoHelper>;
     getIDToken(): Promise<string>;
     isAuthenticated(): Promise<boolean>;
     setHttpRequestSuccessCallback(callback: (response: HttpResponse) => void): void;

package/src/models/http-client.ts

@@ -29,6 +29,7 @@ export interface HttpClient {
 export interface HttpRequestConfig extends AxiosRequestConfig {
     attachToken?: boolean;
     shouldEncodeToFormData?: boolean;
+    shouldAttachIDPAccessToken?: boolean;
     startTimeInMs?: number
 }
 

package/src/models/message.ts

@@ -26,6 +26,8 @@ import {
     GET_AUTH_URL,
     GET_BASIC_USER_INFO,
     GET_CONFIG_DATA,
+    GET_CRYPTO_HELPER,
+    GET_DECODED_IDP_ID_TOKEN,
     GET_DECODED_ID_TOKEN,
     GET_ID_TOKEN,
     GET_OIDC_SERVICE_ENDPOINTS,
@@ -86,6 +88,8 @@ export type MessageType =
     | typeof GET_OIDC_SERVICE_ENDPOINTS
     | typeof GET_BASIC_USER_INFO
     | typeof GET_DECODED_ID_TOKEN
+    | typeof GET_CRYPTO_HELPER
+    | typeof GET_DECODED_IDP_ID_TOKEN
     | typeof ENABLE_HTTP_HANDLER
     | typeof DISABLE_HTTP_HANDLER
     | typeof GET_AUTH_URL

package/src/models/web-worker.ts

@@ -20,6 +20,7 @@ import {
     AuthClientConfig,
     AuthorizationURLParams,
     BasicUserInfo,
+    CryptoHelper,
     CustomGrantConfig,
     DecodedIDTokenPayload,
     FetchResponse,
@@ -58,6 +59,8 @@ export interface WebWorkerCoreInterface {
     revokeAccessToken(): Promise<boolean>;
     getBasicUserInfo(): Promise<BasicUserInfo>;
     getDecodedIDToken(): Promise<DecodedIDTokenPayload>;
+    getDecodedIDPIDToken(): Promise<DecodedIDTokenPayload>;
+    getCryptoHelper(): Promise<CryptoHelper>;
     getIDToken(): Promise<string>;
     getOIDCServiceEndpoints(): Promise<OIDCEndpoints>;
     getAccessToken(): Promise<string>;

package/src/public-api.ts

@@ -31,6 +31,13 @@ export * from "./constants/hooks";
 
 export * from "@asgardeo/auth-js";
 
+// clients
+export * from "./clients/main-thread-client";
+export * from "./clients/web-worker-client";
+
+// models
+export * from "./models/request-custom-grant";
+
 // helpers
 export * from "./helpers/authentication-helper";
 export * from "./helpers/spa-helper";

package/src/worker/worker-core.ts

@@ -21,6 +21,7 @@ import {
     AuthClientConfig,
     AuthorizationURLParams,
     BasicUserInfo,
+    CryptoHelper,
     CustomGrantConfig,
     DecodedIDTokenPayload,
     FetchResponse,
@@ -65,10 +66,17 @@ export const WebWorkerCore = async (
     const attachToken = async (request: HttpRequestConfig): Promise<void> => {
         const requestConfig = { attachToken: true, ...request };
         if (requestConfig.attachToken) {
-            request.headers = {
-                ...request.headers,
-                Authorization: `Bearer ${ await _authenticationHelper.getAccessToken() }`
-            };
+            if(requestConfig.shouldAttachIDPAccessToken) {
+                request.headers = {
+                    ...request.headers,
+                    Authorization: `Bearer ${ await _authenticationHelper.getIDPAccessToken() }`
+                };
+            } else {
+                request.headers = {
+                    ...request.headers,
+                    Authorization: `Bearer ${ await _authenticationHelper.getAccessToken() }`
+                };
+            }
         }
     };
 
@@ -186,6 +194,14 @@ export const WebWorkerCore = async (
         return _authenticationHelper.getDecodedIDToken();
     };
 
+    const getCryptoHelper = async (): Promise<CryptoHelper> => {
+        return _authenticationHelper.getCryptoHelper();
+    };
+
+    const getDecodedIDPIDToken = async (): Promise<DecodedIDTokenPayload> => {
+        return _authenticationHelper.getDecodedIDPIDToken();
+    };
+
     const getIDToken = async (): Promise<string> => {
         return _authenticationHelper.getIDToken();
     };
@@ -224,6 +240,8 @@ export const WebWorkerCore = async (
         getAuthorizationURL,
         getBasicUserInfo,
         getConfigData,
+        getCryptoHelper,
+        getDecodedIDPIDToken,
         getDecodedIDToken,
         getIDToken,
         getOIDCServiceEndpoints,

package/src/worker/worker-receiver.ts

@@ -29,6 +29,7 @@ import {
     GET_AUTH_URL,
     GET_BASIC_USER_INFO,
     GET_CONFIG_DATA,
+    GET_CRYPTO_HELPER,
     GET_DECODED_ID_TOKEN,
     GET_ID_TOKEN,
     GET_OIDC_SERVICE_ENDPOINTS,
@@ -195,6 +196,14 @@ export const workerReceiver = (
                     port.postMessage(MessageUtils.generateFailureMessage(error));
                 }
 
+                break;
+            case GET_CRYPTO_HELPER:
+                try {
+                    port.postMessage(MessageUtils.generateSuccessMessage(await webWorker.getCryptoHelper()));
+                } catch (error) {
+                    port.postMessage(MessageUtils.generateFailureMessage(error));
+                }
+
                 break;
             case GET_ID_TOKEN:
                 try {