zh-web-sdk 2.7.3 → 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/index.d.ts

@@ -9,5 +9,5 @@ declare const rootReducer: import("redux").Reducer<import("redux").CombinedState
     "csp-fiat-withdrawals": import("./fiat-withdrawals").IFiatWithdrawalsState;
     "csp-crypto-sell": import("./crypto-sell").ICryptoSellState;
     fund: import("./fund").IFundState;
-}>, import("./crypto-withdrawals").ICryptoWithdrawalsAction | import("./crypto-buy").ICryptoBuyAction>;
+}>, 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

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

package/dist/types.d.ts

@@ -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.3",
+  "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;
@@ -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;
@@ -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/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) => {