zh-web-sdk 2.4.0 → 2.4.1

package/dist/redux/actions/index.d.ts

@@ -2,3 +2,6 @@ import { AppIdentifier } from "../../types";
 export declare const openModal: (appIdentifier: AppIdentifier) => void;
 export declare const closeModal: (appIdentifier: AppIdentifier) => void;
 export declare const appLoaded: (appIdentifier: AppIdentifier) => void;
+export declare const appPendingApproval: (appIdentifier: AppIdentifier) => void;
+export declare const appCompleted: (appIdentifier: AppIdentifier) => void;
+export declare const appFailed: (appIdentifier: AppIdentifier) => void;

package/dist/redux/reducers/constants.d.ts

@@ -1,3 +1,6 @@
 export declare const ACTION_SET_MODAL_STATE = "SET_MODAL_STATE";
 export declare const ACTION_SET_JWT = "SET_JWT";
 export declare const ACTION_APP_LOADED = "APP_LOADED";
+export declare const ACTION_PENDING_APPROVAL = "PENDING_APPROVAL";
+export declare const ACTION_COMPLETED = "COMPLETED";
+export declare const ACTION_FAILED = "FAILED";

package/dist/types.d.ts

@@ -109,6 +109,21 @@ export declare enum IncomingMessageType {
      * has been clicked in the onboarding app
      */
     OnboardingCloseButtonClicked = "ONBOARDING_CLOSE_BUTTON_CLICKED",
+    /**
+     * OnboardingCompleted is received when the onboarding flow has completed
+     * successfully with participant approved and webview can be closed.
+     */
+    OnboardingCompleted = "ONBOARDING_COMPLETED",
+    /**
+     * OnboardingFailed is received when the onboarding
+     * flow has failed.
+     */
+    OnboardingFailed = "ONBOARDING_FAILED",
+    /**
+     * OnboardingPendingApproval is received when the onboarding
+     * flow has completed successfully but the participant is pending approval.
+     */
+    OnboardingPendingApproval = "ONBOARDING_PENDING_APPROVAL",
     /**
      * CryptoWithdrawalsAppLoaded is received when the crypto
      * withdrawals app has initialized.
@@ -119,6 +134,16 @@ export declare enum IncomingMessageType {
      * has been clicked in the Crypto Withdrawals app
      */
     CryptoWithdrawalsCloseButtonClicked = "CRYPTO_WITHDRAWALS_CLOSE_BUTTON_CLICKED",
+    /**
+     * CryptoWithdrawalsCompleted is received when the Crypto
+     * withdrawals flow has completed successfully.
+     */
+    CryptoWithdrawalsCompleted = "CRYPTO_WITHDRAWALS_COMPLETED",
+    /**
+     * CryptoWithdrawalsFailed is received when the Crypto
+     * withdrawals flow has failed.
+     */
+    CryptoWithdrawalsFailed = "CRYPTO_WITHDRAWALS_FAILED",
     /**
      * FiatDepositsAppLoaded is received when the Fiat
      * deposits app has initialized.
@@ -129,6 +154,16 @@ export declare enum IncomingMessageType {
      * has been clicked in the Fiat Deposits app
     */
     FiatDepositsCloseButtonClicked = "FIAT_DEPOSITS_CLOSE_BUTTON_CLICKED",
+    /**
+     * FiatDepositsCompleted is received when the Fiat
+     * deposits flow has completed successfully.
+     */
+    FiatDepositsCompleted = "FIAT_DEPOSITS_COMPLETED",
+    /**
+     * FiatDepositsFailed is received when the Fiat
+     * deposits flow has failed.
+     */
+    FiatDepositsFailed = "FIAT_DEPOSITS_FAILED",
     /**
      * FiatWithdrawalsAppLoaded is received when the Fiat
      * withdrawals app has initialized.
@@ -139,6 +174,16 @@ export declare enum IncomingMessageType {
      * has been clicked in the Fiat Withdrawals app
     */
     FiatWithdrawalsCloseButtonClicked = "FIAT_WITHDRAWALS_CLOSE_BUTTON_CLICKED",
+    /**
+     * FiatWithdrawalsCompleted is received when the Fiat
+     * withdrawals flow has completed successfully.
+     */
+    FiatWithdrawalsCompleted = "FIAT_WITHDRAWALS_COMPLETED",
+    /**
+     * FiatWithdrawalsFailed is received when the Fiat
+     * withdrawals flow has failed.
+     */
+    FiatWithdrawalsFailed = "FIAT_WITHDRAWALS_FAILED",
     /**
      * CryptoBuyAppLoaded is received when the Crypto
      * buy app has initialized.
@@ -149,6 +194,16 @@ export declare enum IncomingMessageType {
      * has been clicked in the Crypto buy app
     */
     CryptoBuyCloseButtonClicked = "CRYPTO_BUY_CLOSE_BUTTON_CLICKED",
+    /**
+     * CryptoBuyCompleted is received when the Crypto
+     * buy flow flow has completed successfully.
+     */
+    CryptoBuyCompleted = "CRYPTO_BUY_COMPLETED",
+    /**
+     * CryptoBuyFailed is received when the Crypto
+     * buy flow has failed.
+     */
+    CryptoBuyFailed = "CRYPTO_BUY_FAILED",
     /**
      * CryptoSellAppLoaded is received when the Crypto
      * sell app has initialized.
@@ -158,7 +213,17 @@ export declare enum IncomingMessageType {
      * CryptoSellCloseButtonClicked is received when the close button
      * has been clicked in the Crypto sell app
     */
-    CryptoSellCloseButtonClicked = "CRYPTO_SELL_CLOSE_BUTTON_CLICKED"
+    CryptoSellCloseButtonClicked = "CRYPTO_SELL_CLOSE_BUTTON_CLICKED",
+    /**
+     * CryptoSellCompleted is received when the Crypto
+     * sell flow has completed successfully.
+     */
+    CryptoSellCompleted = "CRYPTO_SELL_COMPLETED",
+    /**
+     * CryptoSellFailed is received when the Crypto
+     * sell flow has failed.
+     */
+    CryptoSellFailed = "CRYPTO_SELL_FAILED"
 }
 /**
  * IncomingMessage defines the structure of an incoming

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zh-web-sdk",
-  "version": "2.4.0",
+  "version": "2.4.1",
   "private": false,
   "description": "ZeroHash Web SDK",
   "homepage": "https://github.com/seedcx/zh-web-sdk",

package/src/index.tsx

@@ -18,7 +18,7 @@ import AppContainer from "./iframe-container/AppContainer";
 import { Provider } from "react-redux";
 import store from "./redux/store";
 import { ACTION_SET_JWT } from "./redux/reducers/constants";
-import { appLoaded, closeModal, openModal } from "./redux/actions";
+import { appCompleted, appFailed, appLoaded, appPendingApproval, closeModal, openModal } from "./redux/actions";
 
 let _zeroHashAppsURL: string = DEFAULT_ZH_APPS_URL;
 let _zeroHashAppsOrigin: string = "";
@@ -38,6 +38,15 @@ const appsMessageHandlers: {
   [IncomingMessageType.OnboardingCloseButtonClicked]: () => {
     closeModal(AppIdentifier.ONBOARDING);
   },
+  [IncomingMessageType.OnboardingPendingApproval]: () => {
+    appPendingApproval(AppIdentifier.ONBOARDING);
+  },
+  [IncomingMessageType.OnboardingCompleted]: () => {
+    appCompleted(AppIdentifier.ONBOARDING);
+  },
+  [IncomingMessageType.OnboardingFailed]: () => {
+    appFailed(AppIdentifier.ONBOARDING);
+  },
   // Crypto Withdrawals message handlers
   [IncomingMessageType.CryptoWithdrawalsCloseButtonClicked]: () => {
     closeModal(AppIdentifier.CRYPTO_WITHDRAWALS);
@@ -45,6 +54,12 @@ const appsMessageHandlers: {
   [IncomingMessageType.CryptoWithdrawalsAppLoaded]: () => {
     appLoaded(AppIdentifier.CRYPTO_WITHDRAWALS);
   },
+  [IncomingMessageType.CryptoWithdrawalsCompleted]: () => {
+    appCompleted(AppIdentifier.CRYPTO_WITHDRAWALS);
+  },
+  [IncomingMessageType.CryptoWithdrawalsFailed]: () => {
+    appFailed(AppIdentifier.CRYPTO_WITHDRAWALS);
+  },
   // Fiat Deposits message handlers
   [IncomingMessageType.FiatDepositsCloseButtonClicked]: () => {
     closeModal(AppIdentifier.FIAT_DEPOSITS);
@@ -52,6 +67,12 @@ const appsMessageHandlers: {
   [IncomingMessageType.FiatDepositsAppLoaded]: () => {
     appLoaded(AppIdentifier.FIAT_DEPOSITS);
   },
+  [IncomingMessageType.FiatDepositsCompleted]: () => {
+    appCompleted(AppIdentifier.FIAT_DEPOSITS);
+  },
+  [IncomingMessageType.FiatDepositsFailed]: () => {
+    appFailed(AppIdentifier.FIAT_DEPOSITS);
+  },
   // Fiat Withdrawals message handlers
   [IncomingMessageType.FiatWithdrawalsCloseButtonClicked]: () => {
     closeModal(AppIdentifier.FIAT_WITHDRAWALS);
@@ -59,6 +80,12 @@ const appsMessageHandlers: {
   [IncomingMessageType.FiatWithdrawalsAppLoaded]: () => {
     appLoaded(AppIdentifier.FIAT_WITHDRAWALS);
   },
+  [IncomingMessageType.FiatWithdrawalsCompleted]: () => {
+    appCompleted(AppIdentifier.FIAT_WITHDRAWALS);
+  },
+  [IncomingMessageType.FiatWithdrawalsFailed]: () => {
+    appFailed(AppIdentifier.FIAT_WITHDRAWALS);
+  },
   // Crypto buy message handlers
   [IncomingMessageType.CryptoBuyCloseButtonClicked]: () => {
     closeModal(AppIdentifier.CRYPTO_BUY);
@@ -66,6 +93,12 @@ const appsMessageHandlers: {
   [IncomingMessageType.CryptoBuyAppLoaded]: () => {
     appLoaded(AppIdentifier.CRYPTO_BUY);
   },
+  [IncomingMessageType.CryptoBuyCompleted]: () => {
+    appCompleted(AppIdentifier.CRYPTO_BUY);
+  },
+  [IncomingMessageType.CryptoBuyFailed]: () => {
+    appFailed(AppIdentifier.CRYPTO_BUY);
+  },
   // Crypto sell message handlers
   [IncomingMessageType.CryptoSellCloseButtonClicked]: () => {
     closeModal(AppIdentifier.CRYPTO_SELL);
@@ -73,6 +106,12 @@ const appsMessageHandlers: {
   [IncomingMessageType.CryptoSellAppLoaded]: () => {
     appLoaded(AppIdentifier.CRYPTO_SELL);
   },
+  [IncomingMessageType.CryptoSellCompleted]: () => {
+    appCompleted(AppIdentifier.CRYPTO_SELL);
+  },
+  [IncomingMessageType.CryptoSellFailed]: () => {
+    appFailed(AppIdentifier.CRYPTO_SELL);
+  },
 };
 
 /**

package/src/redux/actions/index.ts

@@ -1,4 +1,4 @@
-import { ACTION_APP_LOADED, ACTION_SET_MODAL_STATE } from "../reducers/constants";
+import { ACTION_APP_LOADED, ACTION_COMPLETED, ACTION_FAILED, ACTION_PENDING_APPROVAL, ACTION_SET_MODAL_STATE } from "../reducers/constants";
 import { AppIdentifier } from "../../types";
 import { dispatchActionBasedOnAppIdentifier } from "../../utils";
 
@@ -13,3 +13,15 @@ export const closeModal = (appIdentifier: AppIdentifier) => {
 export const appLoaded = (appIdentifier: AppIdentifier) => {
   dispatchActionBasedOnAppIdentifier(appIdentifier, ACTION_APP_LOADED, { isAppLoaded: true })
 }
+
+export const appPendingApproval = (appIdentifier: AppIdentifier) => {
+  dispatchActionBasedOnAppIdentifier(appIdentifier, ACTION_PENDING_APPROVAL, {})
+}
+
+export const appCompleted = (appIdentifier: AppIdentifier) => {
+  dispatchActionBasedOnAppIdentifier(appIdentifier, ACTION_COMPLETED, {})
+}
+
+export const appFailed = (appIdentifier: AppIdentifier) => {
+  dispatchActionBasedOnAppIdentifier(appIdentifier, ACTION_FAILED, {})
+}

package/src/redux/reducers/constants.ts

@@ -2,3 +2,6 @@
 export const ACTION_SET_MODAL_STATE = "SET_MODAL_STATE"
 export const ACTION_SET_JWT = "SET_JWT"
 export const ACTION_APP_LOADED = "APP_LOADED"
+export const ACTION_PENDING_APPROVAL = "PENDING_APPROVAL"
+export const ACTION_COMPLETED = "COMPLETED"
+export const ACTION_FAILED = "FAILED"

package/src/types.ts

@@ -114,6 +114,21 @@ export enum IncomingMessageType {
      * has been clicked in the onboarding app
      */
     OnboardingCloseButtonClicked = "ONBOARDING_CLOSE_BUTTON_CLICKED",
+    /**
+     * OnboardingCompleted is received when the onboarding flow has completed
+     * successfully with participant approved and webview can be closed.
+     */
+    OnboardingCompleted = "ONBOARDING_COMPLETED",
+    /**
+     * OnboardingFailed is received when the onboarding
+     * flow has failed.
+     */
+    OnboardingFailed = "ONBOARDING_FAILED",
+    /**
+     * OnboardingPendingApproval is received when the onboarding
+     * flow has completed successfully but the participant is pending approval.
+     */
+    OnboardingPendingApproval = "ONBOARDING_PENDING_APPROVAL",
     /**
      * CryptoWithdrawalsAppLoaded is received when the crypto
      * withdrawals app has initialized.
@@ -124,6 +139,16 @@ export enum IncomingMessageType {
      * has been clicked in the Crypto Withdrawals app
      */
     CryptoWithdrawalsCloseButtonClicked = "CRYPTO_WITHDRAWALS_CLOSE_BUTTON_CLICKED",
+    /**
+     * CryptoWithdrawalsCompleted is received when the Crypto
+     * withdrawals flow has completed successfully.
+     */
+    CryptoWithdrawalsCompleted = "CRYPTO_WITHDRAWALS_COMPLETED",
+    /**
+     * CryptoWithdrawalsFailed is received when the Crypto
+     * withdrawals flow has failed.
+     */
+    CryptoWithdrawalsFailed = "CRYPTO_WITHDRAWALS_FAILED",
     /**
      * FiatDepositsAppLoaded is received when the Fiat
      * deposits app has initialized.
@@ -134,6 +159,16 @@ export enum IncomingMessageType {
      * has been clicked in the Fiat Deposits app
     */
     FiatDepositsCloseButtonClicked = "FIAT_DEPOSITS_CLOSE_BUTTON_CLICKED",
+    /**
+     * FiatDepositsCompleted is received when the Fiat
+     * deposits flow has completed successfully.
+     */ 
+    FiatDepositsCompleted = "FIAT_DEPOSITS_COMPLETED",
+    /**
+     * FiatDepositsFailed is received when the Fiat
+     * deposits flow has failed.
+     */
+    FiatDepositsFailed = "FIAT_DEPOSITS_FAILED",
     /**
      * FiatWithdrawalsAppLoaded is received when the Fiat
      * withdrawals app has initialized.
@@ -144,6 +179,16 @@ export enum IncomingMessageType {
      * has been clicked in the Fiat Withdrawals app
     */
     FiatWithdrawalsCloseButtonClicked = "FIAT_WITHDRAWALS_CLOSE_BUTTON_CLICKED",
+    /**
+     * FiatWithdrawalsCompleted is received when the Fiat
+     * withdrawals flow has completed successfully.
+     */
+    FiatWithdrawalsCompleted = "FIAT_WITHDRAWALS_COMPLETED",
+    /**
+     * FiatWithdrawalsFailed is received when the Fiat
+     * withdrawals flow has failed.
+     */
+    FiatWithdrawalsFailed = "FIAT_WITHDRAWALS_FAILED",
     /**
      * CryptoBuyAppLoaded is received when the Crypto
      * buy app has initialized.
@@ -154,6 +199,16 @@ export enum IncomingMessageType {
      * has been clicked in the Crypto buy app
     */
     CryptoBuyCloseButtonClicked = "CRYPTO_BUY_CLOSE_BUTTON_CLICKED",
+    /**
+     * CryptoBuyCompleted is received when the Crypto
+     * buy flow flow has completed successfully.
+     */
+    CryptoBuyCompleted = "CRYPTO_BUY_COMPLETED",
+    /**
+     * CryptoBuyFailed is received when the Crypto
+     * buy flow has failed.
+     */
+    CryptoBuyFailed = "CRYPTO_BUY_FAILED",
     /**
      * CryptoSellAppLoaded is received when the Crypto
      * sell app has initialized.
@@ -164,6 +219,16 @@ export enum IncomingMessageType {
      * has been clicked in the Crypto sell app
     */
     CryptoSellCloseButtonClicked = "CRYPTO_SELL_CLOSE_BUTTON_CLICKED",
+    /**
+     * CryptoSellCompleted is received when the Crypto
+     * sell flow has completed successfully.
+     */
+    CryptoSellCompleted = "CRYPTO_SELL_COMPLETED",
+    /**
+     * CryptoSellFailed is received when the Crypto
+     * sell flow has failed.
+     */
+    CryptoSellFailed = "CRYPTO_SELL_FAILED",
 }
 
 /**