Add user login status & user logout events

Author: debajitr

README.md

@@ -28,7 +28,7 @@ let transak = new Transak(transakConfig);
 
 transak.init();
 
-// To get all the events
+// To get all SDK events
 Transak.on('*', (data) => {
   console.log(data);
 });

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@transak/transak-sdk",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "Transak SDK that allows you to easily integrate fiat on/off ramp",
   "type": "module",
   "types": "lib/index.d.ts",

src/Constants/environments.ts

@@ -1,4 +1,5 @@
 export enum Environments {
+  DEVELOPMENT = 'DEVELOPMENT',
   STAGING = 'STAGING',
   PRODUCTION = 'PRODUCTION',
 }

src/Constants/events.ts

@@ -7,4 +7,7 @@ export enum Events {
   TRANSAK_WALLET_REDIRECTION = 'TRANSAK_WALLET_REDIRECTION',
   TRANSAK_WIDGET_CLOSE_REQUEST = 'TRANSAK_WIDGET_CLOSE_REQUEST',
   TRANSAK_WIDGET_CLOSE = 'TRANSAK_WIDGET_CLOSE',
+  TRANSAK_USER_INFO_RECEIVED = 'TRANSAK_USER_INFO_RECEIVED',
+  TRANSAK_GET_USER_REQUEST = 'TRANSAK_GET_USER_REQUEST',
+  TRANSAK_LOGOUT_USER_REQUEST = 'TRANSAK_LOGOUT_USER_REQUEST',
 }

src/Constants/web-app-urls.ts

@@ -1,6 +1,7 @@
 import { Environments } from './environments';
 
 export const WebAppUrls = {
+  [Environments.DEVELOPMENT]: 'https://localhost:5005/',
   [Environments.STAGING]: 'https://global-stg.transak.com',
   [Environments.PRODUCTION]: 'https://global.transak.com',
 };

src/Types/query-params.types.d.ts

@@ -29,6 +29,8 @@ type NFT = {
   nftType: string;
 };
 
+type ColorMode = 'LIGHT' | 'DARK';
+
 export type QueryParams = {
   apiKey: string;
   exchangeScreenTitle?: string;
@@ -72,4 +74,12 @@ export type QueryParams = {
   estimatedGasLimit?: number;
   cryptoAmount?: number;
   walletRedirection?: boolean;
+  referrerDomain?: string;
+  colorMode?: ColorMode;
+  backgroundColors?: string | string[];
+  textColors?: string | string[];
+  borderColors?: string | string[];
+  isTransakOne?: boolean;
+  sourceTokenData?: string;
+  cryptoCurrencyData?: string;
 };

src/Utils/handle-message.ts

@@ -70,6 +70,15 @@ export function makeHandleMessage(eventEmitter: EventEmitter, close: () => void)
 
           break;
         }
+
+        case Events.TRANSAK_USER_INFO_RECEIVED: {
+          eventEmitter.emit(Events.TRANSAK_USER_INFO_RECEIVED, {
+            eventName: Events.TRANSAK_USER_INFO_RECEIVED,
+            status: event.data.data,
+          });
+
+          break;
+        }
       }
     }
   };

src/transak.ts

@@ -64,14 +64,16 @@ class Transak {
     this.#isInitialized = false;
   };
 
+  getUser = () => {
+    this.#iframeElement?.contentWindow?.postMessage({ event_id: Events.TRANSAK_GET_USER_REQUEST }, '*');
+  };
+
+  logoutUser = () => {
+    this.#iframeElement?.contentWindow?.postMessage({ event_id: Events.TRANSAK_LOGOUT_USER_REQUEST }, '*');
+  };
+
   #closeRequest = () => {
-    this.#iframeElement?.contentWindow?.postMessage(
-      {
-        event_id: Events.TRANSAK_WIDGET_CLOSE_REQUEST,
-        data: true,
-      },
-      '*',
-    );
+    this.#iframeElement?.contentWindow?.postMessage({ event_id: Events.TRANSAK_WIDGET_CLOSE_REQUEST }, '*');
   };
 
   #removeEventListener = () => {