zh-web-sdk 2.7.2 → 2.8.0

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

@@ -5,3 +5,4 @@ export declare const ACTION_PENDING_APPROVAL = "PENDING_APPROVAL";
 export declare const ACTION_COMPLETED = "COMPLETED";
 export declare const ACTION_FAILED = "FAILED";
 export declare const ACTION_SET_FILTERS = "ACTION_SET_FILTERS";
+export declare const ACTION_SET_NAVIGATE = "SET_NAVIGATE";

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

@@ -0,0 +1,13 @@
+export interface IFundState {
+    jwt: string;
+    isAppLoaded: boolean;
+    isAppActive: boolean;
+}
+export interface IFundAction {
+    type: string;
+    jwt?: string;
+    isAppActive?: boolean;
+    isAppLoaded?: boolean;
+}
+declare const fundReducer: (state: IFundState | undefined, action: IFundAction) => IFundState;
+export default fundReducer;

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

@@ -8,6 +8,6 @@ declare const rootReducer: import("redux").Reducer<import("redux").CombinedState
     "csp-crypto-withdrawals": import("./crypto-withdrawals").ICryptoWithdrawalsState;
     "csp-fiat-withdrawals": import("./fiat-withdrawals").IFiatWithdrawalsState;
     "csp-crypto-sell": import("./crypto-sell").ICryptoSellState;
-    "fund-with-crypto": import("./fund-with-crypto").IFundWithCryptoState;
-}>, import("./crypto-withdrawals").ICryptoWithdrawalsAction | import("./crypto-buy").ICryptoBuyAction>;
+    fund: import("./fund").IFundState;
+}>, import("./crypto-withdrawals").ICryptoWithdrawalsAction | import("./onboarding").IOnboardingAction | import("./crypto-buy").ICryptoBuyAction>;
 export default rootReducer;

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

@@ -1,13 +1,16 @@
+import { OnboardingPage } from "../../types";
 export interface IOnboardingState {
     jwt: string;
     isAppLoaded: boolean;
     isAppActive: boolean;
+    navigate?: OnboardingPage;
 }
 export interface IOnboardingAction {
     type: string;
     jwt?: string;
     isAppActive?: boolean;
     isAppLoaded?: boolean;
+    navigate?: OnboardingPage;
 }
 declare const onboardingReducer: (state: IOnboardingState | undefined, action: IOnboardingAction) => IOnboardingState;
 export default onboardingReducer;

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

@@ -8,6 +8,6 @@ declare const store: import("redux").Store<import("redux").EmptyObject & {
     "csp-crypto-withdrawals": import("../reducers/crypto-withdrawals").ICryptoWithdrawalsState;
     "csp-fiat-withdrawals": import("../reducers/fiat-withdrawals").IFiatWithdrawalsState;
     "csp-crypto-sell": import("../reducers/crypto-sell").ICryptoSellState;
-    "fund-with-crypto": import("../reducers/fund-with-crypto").IFundWithCryptoState;
-}, import("../reducers/crypto-withdrawals").ICryptoWithdrawalsAction | import("../reducers/crypto-buy").ICryptoBuyAction>;
+    fund: import("../reducers/fund").IFundState;
+}, import("../reducers/crypto-withdrawals").ICryptoWithdrawalsAction | import("../reducers/onboarding").IOnboardingAction | import("../reducers/crypto-buy").ICryptoBuyAction>;
 export default store;

package/dist/types.d.ts

@@ -67,11 +67,11 @@ export interface IInitializeParameters {
      */
     cryptoSellJWT?: string;
     /**
-     * fundWithCryptoJWT is the JWT that you received from
+     * fundJWT is the JWT that you received from
      * the ZeroHash HTTP API and have specific permissions to
-     * perform Fund With Crypto operations.
+     * perform Fund operations.
      */
-    fundWithCryptoJWT?: string;
+    fundJWT?: string;
     /**
      * zeroHashAppsURL is the base URL for all our Apps.
      * It defaults to https://web-sdk.zerohash.com/ and will
@@ -231,25 +231,25 @@ export declare enum IncomingMessageType {
      */
     CryptoSellFailed = "CRYPTO_SELL_FAILED",
     /**
-     * FundWithCryptoAppLoaded is received when the Fund Witch Crypto
+     * FundAppLoaded is received when the Fund
      * app has initialized.
      */
-    FundWithCryptoAppLoaded = "FUND_WITH_CRYPTO_APP_LOADED",
+    FundAppLoaded = "FUND_APP_LOADED",
     /**
-     * FundWithCryptoCloseButtonClicked is received when the close button
-     * has been clicked in the Fund With Crypto app
+     * FundCloseButtonClicked is received when the close button
+     * has been clicked in the Fund app
     */
-    FundWithCryptoCloseButtonClicked = "FUND_WITH_CRYPTO_CLOSE_BUTTON_CLICKED",
+    FundCloseButtonClicked = "FUND_CLOSE_BUTTON_CLICKED",
     /**
-     * FundWithCryptoCompleted is received when the
-     * Fund With Crypto flow  has completed successfully.
+     * FundCompleted is received when the
+     * Fund flow  has completed successfully.
     */
-    FundWithCryptoCompleted = "FUND_WITH_CRYPTO_COMPLETED",
+    FundCompleted = "FUND_COMPLETED",
     /**
-     * FundWithCryptoFailed is received when the
-     * Fund With Crypto flow has failed.
+     * FundFailed is received when the
+     * Fund flow has failed.
      */
-    FundWithCryptoFailed = "FUND_WITH_CRYPTO_FAILED"
+    FundFailed = "FUND_FAILED"
 }
 /**
  * IncomingMessage defines the structure of an incoming
@@ -291,7 +291,7 @@ export declare enum AppIdentifier {
     CSP_CRYPTO_WITHDRAWALS = "csp-crypto-withdrawals",
     CSP_FIAT_WITHDRAWALS = "csp-fiat-withdrawals",
     CSP_CRYPTO_SELL = "csp-crypto-sell",
-    FUND_WITH_CRYPTO = "fund-with-crypto"
+    FUND = "fund"
 }
 /**
 * Map that maps the app AppIdentifier to the redux action prefix
@@ -311,8 +311,25 @@ export interface IOpenModalParameters {
     jwt?: string;
     appIdentifier: AppIdentifier;
     filters?: Filters;
+    navigate?: Page;
 }
 export interface ISetFiltersParameters {
     appIdentifier: AppIdentifier;
     filters?: Filters;
 }
+export interface EditAddress {
+    to: "edit-address";
+}
+/**
+ * Since we may extend this in the future, we use a union type to make it easy
+ * to allow for example a new CryptoBuyPage type to be added in the future or
+ * new pages for the Onboarding App with specialized props.
+ * Page is expected to be a union of "AppPage" and each App shall have it's own
+ * union of pages, such as EditAddress.
+ */
+export type OnboardingPage = EditAddress;
+export type Page = OnboardingPage;
+export interface ISetNavigateParameters {
+    appIdentifier: AppIdentifier;
+    navigate: Page;
+}

package/package.json

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

package/src/iframe-container/AppContainer.tsx

@@ -16,6 +16,8 @@ import { closeModal } from "../redux/actions";
 import {
   AppIdentifier,
   Filters,
+  OnboardingPage,
+  Page,
   appIdentifierToActionPrefixMap,
 } from "../types";
 
@@ -26,6 +28,7 @@ interface AppContainerProps {
   zeroHashAppURL: string;
   appIdentifier: AppIdentifier;
   filters?: Filters;
+  navigate?: Page;
 }
 
 interface AppContainerMappedProps {
@@ -40,6 +43,7 @@ interface AppContainerMappedProps {
     isAppLoaded: boolean;
     jwt: string;
     filters?: Filters;
+    navigate?: OnboardingPage;
   };
   [AppIdentifier.FIAT_DEPOSITS]: {
     isAppActive: boolean;
@@ -83,7 +87,7 @@ interface AppContainerMappedProps {
     jwt: string;
     filters?: Filters;
   };
-  [AppIdentifier.FUND_WITH_CRYPTO]: {
+  [AppIdentifier.FUND]: {
     isAppActive: boolean;
     isAppLoaded: boolean;
     jwt: string;
@@ -103,7 +107,7 @@ const mapAppToTitle = {
   [AppIdentifier.CSP_CRYPTO_WITHDRAWALS]: "CBP Crypto Withdrawals",
   [AppIdentifier.CSP_FIAT_WITHDRAWALS]: "CBP Fiat Withdrawals",
   [AppIdentifier.CSP_CRYPTO_SELL]: "Crypto Sell",
-  [AppIdentifier.FUND_WITH_CRYPTO]: "Fund With Crypto",
+  [AppIdentifier.FUND]: "Fund"
 };
 
 const AppContainer = ({
@@ -112,6 +116,7 @@ const AppContainer = ({
   jwt,
   zeroHashAppURL,
   appIdentifier,
+  navigate,
 }: AppContainerProps) => {
   const title = mapAppToTitle[appIdentifier];
   const hasJwt = !!jwt;
@@ -133,17 +138,18 @@ const AppContainer = ({
   const iRef: React.MutableRefObject<HTMLIFrameElement | null> =
     useRef<HTMLIFrameElement | null>(null);
   useEffect(() => {
-    // Send JWT to iframe when all 3 props are ready
+    // Send events to the iframe when Apps are ready
     if (
       zeroHashAppURL &&
       isAppLoaded &&
       hasJwt &&
       iRef.current?.contentWindow
     ) {
-      // This loops all registered apps and sends their JWT tokens.
+      // This loops all registered apps and send events listed below.
       Object.keys(allAppsState).forEach((key: string) => {
         if (!allAppsState[key as AppIdentifier].jwt) return;
 
+        // Send JWT token
         iRef.current?.contentWindow?.postMessage(
           {
             type: `${appIdentifierToActionPrefixMap.get(
@@ -153,6 +159,7 @@ const AppContainer = ({
           },
           zeroHashAppURL
         );
+        // Send filters
         if (allAppsState[key as AppIdentifier].filters) {
           iRef.current?.contentWindow?.postMessage(
             {
@@ -164,9 +171,29 @@ const AppContainer = ({
             zeroHashAppURL
           );
         }
+        // Send navigate to Onboarding App
+        if (appIdentifier === AppIdentifier.ONBOARDING && navigate) {
+          iRef.current?.contentWindow?.postMessage(
+            {
+              type: `${appIdentifierToActionPrefixMap.get(
+                AppIdentifier.ONBOARDING
+              )}NAVIGATE`,
+              navigate,
+            },
+            zeroHashAppURL
+          );
+        }
       });
     }
-  }, [appIdentifier, hasJwt, isAppLoaded, jwt, zeroHashAppURL, allAppsState]);
+  }, [
+    appIdentifier,
+    hasJwt,
+    isAppLoaded,
+    jwt,
+    zeroHashAppURL,
+    allAppsState,
+    navigate,
+  ]);
 
   useEffect(() => {
     // set the styles when the screen size changes
@@ -236,6 +263,10 @@ const mapStateToProps = (
     isAppLoaded: state[ownProps.appIdentifier].isAppLoaded,
     jwt: state[ownProps.appIdentifier].jwt,
     filters: state[ownProps.appIdentifier].filters,
+    navigate:
+      ownProps.appIdentifier === AppIdentifier.ONBOARDING
+        ? state[ownProps.appIdentifier].navigate
+        : undefined,
   };
 };
 

package/src/index.tsx

@@ -10,6 +10,7 @@ import {
   IOpenOnboardingModalParameters,
   ISetFiltersParameters,
   ISetJWTParameters,
+  ISetNavigateParameters,
   ISetUserOnboardingJWTParameters,
   IZeroHashSDK,
 } from "./types";
@@ -18,7 +19,7 @@ import { DEFAULT_ZH_APPS_URL } from "./constants";
 import AppContainer from "./iframe-container/AppContainer";
 import { Provider } from "react-redux";
 import store from "./redux/store";
-import { ACTION_SET_FILTERS, ACTION_SET_JWT } from "./redux/reducers/constants";
+import { ACTION_SET_FILTERS, ACTION_SET_JWT, ACTION_SET_NAVIGATE } from "./redux/reducers/constants";
 import { appCompleted, appFailed, appLoaded, appPendingApproval, closeModal, openModal } from "./redux/actions";
 
 let _zeroHashAppsURL: string = DEFAULT_ZH_APPS_URL;
@@ -113,18 +114,18 @@ const appsMessageHandlers: {
   [IncomingMessageType.CryptoSellFailed]: () => {
     appFailed(AppIdentifier.CRYPTO_SELL);
   },
-  // Fund with crypto message handlers
-  [IncomingMessageType.FundWithCryptoAppLoaded]: () => {
-    appLoaded(AppIdentifier.FUND_WITH_CRYPTO);
+  // Fund message handlers
+  [IncomingMessageType.FundAppLoaded]: () => {
+    appLoaded(AppIdentifier.FUND);
   },
-  [IncomingMessageType.FundWithCryptoCloseButtonClicked]: () => {
-    closeModal(AppIdentifier.FUND_WITH_CRYPTO);
+  [IncomingMessageType.FundCloseButtonClicked]: () => {
+    closeModal(AppIdentifier.FUND);
   },
-  [IncomingMessageType.FundWithCryptoCompleted]: () => {
-    appCompleted(AppIdentifier.FUND_WITH_CRYPTO);
+  [IncomingMessageType.FundCompleted]: () => {
+    appCompleted(AppIdentifier.FUND);
   },
-  [IncomingMessageType.FundWithCryptoFailed]: () => {
-    appFailed(AppIdentifier.FUND_WITH_CRYPTO);
+  [IncomingMessageType.FundFailed]: () => {
+    appFailed(AppIdentifier.FUND);
   },
 };
 
@@ -164,7 +165,7 @@ export class ZeroHashSDK implements IZeroHashSDK {
     [AppIdentifier.FIAT_WITHDRAWALS, false],
     [AppIdentifier.CRYPTO_BUY, false],
     [AppIdentifier.CRYPTO_SELL, false],
-    [AppIdentifier.FUND_WITH_CRYPTO, false],
+    [AppIdentifier.FUND, false],
   ]);
 
   /**
@@ -181,7 +182,7 @@ export class ZeroHashSDK implements IZeroHashSDK {
     fiatWithdrawalsJWT,
     cryptoBuyJWT,
     cryptoSellJWT,
-    fundWithCryptoJWT,
+    fundJWT,
     zeroHashAppsURL,
   }: IInitializeParameters) {
     // The || is for backwards compatibility
@@ -231,10 +232,10 @@ export class ZeroHashSDK implements IZeroHashSDK {
         appIdentifier: AppIdentifier.CRYPTO_SELL,
       });
     }
-    if (fundWithCryptoJWT) {
+    if (fundJWT) {
       this.setJWT({
-        jwt: fundWithCryptoJWT,
-        appIdentifier: AppIdentifier.FUND_WITH_CRYPTO,
+        jwt: fundJWT,
+        appIdentifier: AppIdentifier.FUND,
       });
     }
   }
@@ -256,7 +257,13 @@ export class ZeroHashSDK implements IZeroHashSDK {
   setFilters({ filters, appIdentifier }: ISetFiltersParameters): void {
     dispatchActionBasedOnAppIdentifier(appIdentifier, ACTION_SET_FILTERS, { filters });
   }
-
+  /**
+   * Sets the navigate field for the appIdentifier provided. Currently this is 
+   * specific to Onboarding and is used to navigate to a specific page within the App.
+   */
+  setNavigate({ appIdentifier, navigate }: ISetNavigateParameters): void {
+    dispatchActionBasedOnAppIdentifier(appIdentifier, ACTION_SET_NAVIGATE, { navigate });
+  }
   /**
    * setUserOnboardingJWT sets the JWT to be whatever value is provided.
    * The JWT should be the UserJWT provided by ZeroHash via the platform
@@ -303,10 +310,13 @@ export class ZeroHashSDK implements IZeroHashSDK {
   /**
    * openModal opens the modal for the appIdentifier provided.
    */
-  openModal({ jwt, appIdentifier, filters }: IOpenModalParameters): void {
+  openModal({ jwt, appIdentifier, filters, navigate }: IOpenModalParameters): void {
     if (filters) {
       this.setFilters({filters, appIdentifier})
     }
+    if (navigate) {
+      this.setNavigate({ appIdentifier, navigate })
+    }
     if (jwt) {
       this.setJWT({
         jwt,

package/src/redux/reducers/constants.ts

@@ -5,4 +5,5 @@ export const ACTION_APP_LOADED = "APP_LOADED"
 export const ACTION_PENDING_APPROVAL = "PENDING_APPROVAL"
 export const ACTION_COMPLETED = "COMPLETED"
 export const ACTION_FAILED = "FAILED"
-export const ACTION_SET_FILTERS = "ACTION_SET_FILTERS"
+export const ACTION_SET_FILTERS = "ACTION_SET_FILTERS"
+export const ACTION_SET_NAVIGATE = "SET_NAVIGATE"

package/src/redux/reducers/fund.ts

@@ -0,0 +1,63 @@
+import { AppIdentifier } from "../../types";
+import { appIdentifierToActionPrefixMap } from "../../types";
+import {
+  ACTION_SET_JWT,
+  ACTION_SET_MODAL_STATE,
+  ACTION_APP_LOADED
+} from "./constants";
+
+export interface IFundState {
+  jwt: string;
+  isAppLoaded: boolean;
+  isAppActive: boolean;
+}
+
+export interface IFundAction {
+  type: string;
+  jwt?: string;
+  isAppActive?: boolean;
+  isAppLoaded?: boolean;
+}
+
+const INITIAL_STATE: IFundState = {
+  jwt: "",
+  isAppActive: false,
+  isAppLoaded: false
+}
+
+const applySetIsAppActive = (state: IFundState, action: IFundAction) : IFundState => {
+  return {
+      ...state,
+      isAppActive: !!action.isAppActive,
+  }
+}
+
+const applySetSendJWTToApp = (state: IFundState, action: IFundAction) : IFundState => {
+  return {
+      ...state,
+      isAppLoaded: !!action.isAppLoaded,
+  }
+}
+
+const applySetJWT = (state: IFundState, action: IFundAction) : IFundState => {
+  return {
+      ...state,
+      jwt: action.jwt as string,
+  }
+}
+
+const reducerMap: { [actionType: string]: (state: IFundState, action: IFundAction) => IFundState } = {
+  [`${appIdentifierToActionPrefixMap.get(AppIdentifier.FUND)}${ACTION_SET_JWT}`]: applySetJWT,
+  [`${appIdentifierToActionPrefixMap.get(AppIdentifier.FUND)}${ACTION_SET_MODAL_STATE}`]: applySetIsAppActive,
+  [`${appIdentifierToActionPrefixMap.get(AppIdentifier.FUND)}${ACTION_APP_LOADED}`]: applySetSendJWTToApp,
+};
+
+const fundReducer = (state = INITIAL_STATE, action: IFundAction) => {
+  if (!!action.type && !!reducerMap[action.type]) {
+      return reducerMap[action.type](state, action);
+  } else {
+      return state;
+  }
+}
+
+export default fundReducer;

package/src/redux/reducers/index.ts

@@ -5,7 +5,7 @@ import fiatDepositsReducer from "./fiat-deposits";
 import fiatWithdrawalsReducer from "./fiat-withdrawals";
 import cryptoBuyReducer from "./crypto-buy";
 import cryptoSellReducer from "./crypto-sell";
-import fundWithCryptoReducer from "./fund-with-crypto";
+import fundReducer from "./fund";
 
 const rootReducer = combineReducers({
     ["crypto-withdrawals"]: cryptoWithdrawalsReducer,
@@ -17,7 +17,7 @@ const rootReducer = combineReducers({
     ["csp-crypto-withdrawals"]: cryptoWithdrawalsReducer,
     ["csp-fiat-withdrawals"]: fiatWithdrawalsReducer,
     ["csp-crypto-sell"]: cryptoSellReducer,
-    ["fund-with-crypto"]: fundWithCryptoReducer,
+    ["fund"]: fundReducer,
 });
 
 export default rootReducer;

package/src/redux/reducers/onboarding.ts

@@ -1,15 +1,17 @@
-import { AppIdentifier } from "../../types";
+import { AppIdentifier, OnboardingPage } from "../../types";
 import { appIdentifierToActionPrefixMap } from "../../types";
 import {
   ACTION_SET_JWT,
   ACTION_SET_MODAL_STATE,
-  ACTION_APP_LOADED
+  ACTION_APP_LOADED,
+  ACTION_SET_NAVIGATE
 } from "./constants";
 
 export interface IOnboardingState {
   jwt: string;
   isAppLoaded: boolean;
   isAppActive: boolean;
+  navigate?: OnboardingPage;
 }
 
 export interface IOnboardingAction {
@@ -17,6 +19,7 @@ export interface IOnboardingAction {
   jwt?: string;
   isAppActive?: boolean;
   isAppLoaded?: boolean;
+  navigate?: OnboardingPage;
 }
 
 const INITIAL_STATE: IOnboardingState = {
@@ -45,12 +48,19 @@ const applySetJWT = (state: IOnboardingState, action: IOnboardingAction) : IOnbo
       jwt: action.jwt as string,
   }
 }
+const applySetNavigate = (state: IOnboardingState, action: IOnboardingAction): IOnboardingState => {
+  return {
+    ...state,
+    navigate: action.navigate,
+  }
+}
 
 const reducerMap: { [actionType: string]: (state: IOnboardingState, action: IOnboardingAction) => IOnboardingState } = {
   // Onboarding reducer
   [`${appIdentifierToActionPrefixMap.get(AppIdentifier.ONBOARDING)}${ACTION_SET_JWT}`]: applySetJWT,
   [`${appIdentifierToActionPrefixMap.get(AppIdentifier.ONBOARDING)}${ACTION_SET_MODAL_STATE}`]: applySetIsAppActive,
   [`${appIdentifierToActionPrefixMap.get(AppIdentifier.ONBOARDING)}${ACTION_APP_LOADED}`]: applySetSendJWTToApp,
+  [`${appIdentifierToActionPrefixMap.get(AppIdentifier.ONBOARDING)}${ACTION_SET_NAVIGATE}`]: applySetNavigate,
 };
 
 const onboardingReducer = (state = INITIAL_STATE, action: IOnboardingAction) => {