zh-web-sdk 2.7.3 → 2.9.0

package/src/types.ts

@@ -1,8 +1,8 @@
 declare global {
-    interface Window {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        zerohash: any
-    }
+  interface Window {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    zerohash: any
+  }
 }
 
 /**
@@ -10,76 +10,82 @@ declare global {
  * required for initializing the platform SDK
  */
 export interface IInitializeParameters {
-    /**
-     * zeroHashOnboardingURL should be set to the URL of
-     * the webapp for onboarding users onto the ZeroHash
-     * platform.
-     * @deprecated please use zeroHashAppsURL.
-     */
-    zeroHashOnboardingURL?: string
-    /**
-     * rootQuerySelector is a query selector string that
-     * allows creating the ZeroHash UI subtree under a
-     * custom element.
-     *
-     * The default #zh-root query selector will be used
-     * instead otherwise. #zh-root will be a <div> appended
-     * as a child of the body in no specified order.
-     */
-    rootQuerySelector?: string
-    /**
-     * userOnboardingJWT is the JWT that you received from
-     * the ZeroHash HTTP API that pertains to the customer
-     * to be onboarded.
-     *
-     * This is optional in the constructor and can be
-     * deferred to setUserOnboardingJWT() at a later time
-     * but must be provided before opening the onboarding
-     * UI in order for the onboarding UI to be loaded.
-     */
-    userOnboardingJWT?: string
-    /**
-     * cryptoWithdrawalsJWT is the JWT that you received from
-     * the ZeroHash HTTP API and have specific permissions to
-     * perform crypto withdrawals.
-     */
-    cryptoWithdrawalsJWT?: string
-    /**
-     * fiatDepositsJWT is the JWT that you received from
-     * the ZeroHash HTTP API and have specific permissions to
-     * perform Fiat Deposits.
-     */
-    fiatDepositsJWT?: string
-    /**
-     * fiatWithdrawalsJWT is the JWT that you received from
-     * the ZeroHash HTTP API and have specific permissions to
-     * perform Fiat Withdrawals.
-     */
-    fiatWithdrawalsJWT?: string
-    /**
-     * cryptoBuyJWT is the JWT that you received from
-     * the ZeroHash HTTP API and have specific permissions to
-     * perform Crypto Buy.
-     */
-    cryptoBuyJWT?: string
-    /**
-     * cryptoSellJWT is the JWT that you received from
-     * the ZeroHash HTTP API and have specific permissions to
-     * perform Crypto Sell.
-     */
-    cryptoSellJWT?: string
-    /**
-     * fundJWT is the JWT that you received from
-     * the ZeroHash HTTP API and have specific permissions to
-     * perform Fund operations.
-     */
-    fundJWT?: string
-    /**
-     * zeroHashAppsURL is the base URL for all our Apps.
-     * It defaults to https://web-sdk.zerohash.com/ and will
-     * be a replacement for zeroHashOnboardingURL.
-     */
-    zeroHashAppsURL: string
+  /**
+   * zeroHashOnboardingURL should be set to the URL of
+   * the webapp for onboarding users onto the ZeroHash
+   * platform.
+   * @deprecated please use zeroHashAppsURL.
+   */
+  zeroHashOnboardingURL?: string
+  /**
+   * rootQuerySelector is a query selector string that
+   * allows creating the ZeroHash UI subtree under a
+   * custom element.
+   *
+   * The default #zh-root query selector will be used
+   * instead otherwise. #zh-root will be a <div> appended
+   * as a child of the body in no specified order.
+   */
+  rootQuerySelector?: string
+  /**
+   * userOnboardingJWT is the JWT that you received from
+   * the ZeroHash HTTP API that pertains to the customer
+   * to be onboarded.
+   *
+   * This is optional in the constructor and can be
+   * deferred to setUserOnboardingJWT() at a later time
+   * but must be provided before opening the onboarding
+   * UI in order for the onboarding UI to be loaded.
+   */
+  userOnboardingJWT?: string
+  /**
+   * cryptoWithdrawalsJWT is the JWT that you received from
+   * the ZeroHash HTTP API and have specific permissions to
+   * perform crypto withdrawals.
+   */
+  cryptoWithdrawalsJWT?: string
+  /**
+   * fiatDepositsJWT is the JWT that you received from
+   * the ZeroHash HTTP API and have specific permissions to
+   * perform Fiat Deposits.
+   */
+  fiatDepositsJWT?: string
+  /**
+   * fiatWithdrawalsJWT is the JWT that you received from
+   * the ZeroHash HTTP API and have specific permissions to
+   * perform Fiat Withdrawals.
+   */
+  fiatWithdrawalsJWT?: string
+  /**
+   * cryptoBuyJWT is the JWT that you received from
+   * the ZeroHash HTTP API and have specific permissions to
+   * perform Crypto Buy.
+   */
+  cryptoBuyJWT?: string
+  /**
+   * cryptoSellJWT is the JWT that you received from
+   * the ZeroHash HTTP API and have specific permissions to
+   * perform Crypto Sell.
+   */
+  cryptoSellJWT?: string
+  /**
+   * fundJWT is the JWT that you received from
+   * the ZeroHash HTTP API and have specific permissions to
+   * perform Fund operations.
+   */
+  fundJWT?: string
+  /**
+   * profileJWT is the JWT that you received from
+   * the ZeroHash HTTP API and have specific permissions to
+   * perform Profile operations.
+   */
+    profileJWT?: string
+  /**
+   * zeroHashAppsURL is the base URL for all our Apps.
+   * It defaults to https://web-sdk.zerohash.com/ and will
+   * be a replacement for zeroHashOnboardingURL.
+   */
+  zeroHashAppsURL: string
 }
 
 /**
@@ -88,21 +94,21 @@ export interface IInitializeParameters {
  * JWT.
  */
 export interface ISetUserOnboardingJWTParameters {
-    /**
-     * userOnboardingJWT is the JWT that you received from
-     * the ZeroHash HTTP API that pertains to the customer
-     * to be onboarded.
-     */
-    userOnboardingJWT: string
+  /**
+   * userOnboardingJWT is the JWT that you received from
+   * the ZeroHash HTTP API that pertains to the customer
+   * to be onboarded.
+   */
+  userOnboardingJWT: string
 }
 
 export interface IOpenOnboardingModalParameters {
-    /**
-     * userOnboardingJWT is the JWT that you received from
-     * the ZeroHash HTTP API that pertains to the customer
-     * to be onboarded.
-     */
-    userOnboardingJWT?: string
+  /**
+   * userOnboardingJWT is the JWT that you received from
+   * the ZeroHash HTTP API that pertains to the customer
+   * to be onboarded.
+   */
+  userOnboardingJWT?: string
 }
 
 /**
@@ -110,151 +116,166 @@ export interface IOpenOnboardingModalParameters {
  * are registered that the host can handle.
  */
 export enum IncomingMessageType {
-    /**
-     * OnboardingAppLoaded is received when the onboarding
-     * app has initialized.
-     */
-    OnboardingAppLoaded = "ONBOARDING_APP_LOADED",
-    /**
-     * OnboardingCloseButtonClicked is received when the close button
-     * 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.
-     */
-    CryptoWithdrawalsAppLoaded = "CRYPTO_WITHDRAWALS_APP_LOADED",
-    /**
-     * CryptoWithdrawalsCloseButtonClicked is received when the close button
-     * 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.
-     */
-    FiatDepositsAppLoaded = "FIAT_DEPOSITS_APP_LOADED",
-    /**
-     * FiatDepositsCloseButtonClicked is received when the close button
-     * 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.
-     */
-    FiatWithdrawalsAppLoaded = "FIAT_WITHDRAWALS_APP_LOADED",
-    /**
-     * FiatWithdrawalsCloseButtonClicked is received when the close button
-     * 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.
-     */
-    CryptoBuyAppLoaded = "CRYPTO_BUY_APP_LOADED",
-    /**
-     * CryptoBuyCloseButtonClicked is received when the close button
-     * 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.
-     */
-    CryptoSellAppLoaded = "CRYPTO_SELL_APP_LOADED",
-    /**
-     * CryptoSellCloseButtonClicked is received when the close button
-     * 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",
-    /**
-     * FundAppLoaded is received when the Fund
-     * app has initialized.
-     */
-    FundAppLoaded = "FUND_APP_LOADED",
-    /**
-     * FundCloseButtonClicked is received when the close button
-     * has been clicked in the Fund app
+  /**
+   * OnboardingAppLoaded is received when the onboarding
+   * app has initialized.
+   */
+  OnboardingAppLoaded = "ONBOARDING_APP_LOADED",
+  /**
+   * OnboardingCloseButtonClicked is received when the close button
+   * 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.
+   */
+  CryptoWithdrawalsAppLoaded = "CRYPTO_WITHDRAWALS_APP_LOADED",
+  /**
+   * CryptoWithdrawalsCloseButtonClicked is received when the close button
+   * 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.
+   */
+  FiatDepositsAppLoaded = "FIAT_DEPOSITS_APP_LOADED",
+  /**
+   * FiatDepositsCloseButtonClicked is received when the close button
+   * 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.
+   */
+  FiatWithdrawalsAppLoaded = "FIAT_WITHDRAWALS_APP_LOADED",
+  /**
+   * FiatWithdrawalsCloseButtonClicked is received when the close button
+   * 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.
+   */
+  CryptoBuyAppLoaded = "CRYPTO_BUY_APP_LOADED",
+  /**
+   * CryptoBuyCloseButtonClicked is received when the close button
+   * 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.
+   */
+  CryptoSellAppLoaded = "CRYPTO_SELL_APP_LOADED",
+  /**
+   * CryptoSellCloseButtonClicked is received when the close button
+   * 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",
+  /**
+   * FundAppLoaded is received when the Fund
+   * app has initialized.
+   */
+  FundAppLoaded = "FUND_APP_LOADED",
+  /**
+   * FundCloseButtonClicked is received when the close button
+   * has been clicked in the Fund app
+  */
+  FundCloseButtonClicked = "FUND_CLOSE_BUTTON_CLICKED",
+  /**
+   * FundCompleted is received when the
+   * Fund flow  has completed successfully.
+  */
+  FundCompleted = "FUND_COMPLETED",
+  /**
+   * FundFailed is received when the
+   * Fund flow has failed.
+   */
+  FundFailed = "FUND_FAILED",
+  /**
+   * ProfileAppLoaded is received when the Profile
+   * app has initialized.
+   */
+    ProfileAppLoaded = "PROFILE_APP_LOADED",
+    /**
+     * ProfileCloseButtonClicked is received when the close button
+     * has been clicked in the Profile app
     */
-    FundCloseButtonClicked = "FUND_CLOSE_BUTTON_CLICKED",
+    ProfileCloseButtonClicked = "PROFILE_CLOSE_BUTTON_CLICKED",
     /**
-     * FundCompleted is received when the
-     * Fund flow  has completed successfully.
-    */
-    FundCompleted = "FUND_COMPLETED",
-    /**
-     * FundFailed is received when the
-     * Fund flow has failed.
+     * ProfileFailed is received when the
+     * Profile flow has failed.
      */
-    FundFailed = "FUND_FAILED",
+    ProfileFailed = "PROFILE_FAILED",
 }
 
 /**
@@ -262,16 +283,16 @@ export enum IncomingMessageType {
  * message
  */
 export interface IncomingMessage {
-    /**
-     * type is the type of message that is used for routing
-     * the request to the appropriate handler
-     */
-    type: IncomingMessageType
-    /**
-     * payload is any freeform value that pertains to the
-     * request
-     */
-    payload: unknown
+  /**
+   * type is the type of message that is used for routing
+   * the request to the appropriate handler
+   */
+  type: IncomingMessageType
+  /**
+   * payload is any freeform value that pertains to the
+   * request
+   */
+  payload: unknown
 }
 
 export type IncomingMessageHandler = (payload: unknown) => void;
@@ -280,10 +301,10 @@ export type IncomingMessageHandler = (payload: unknown) => void;
  * IZeroHashSDK is the interface that you may use to interact with the ZeroHash SDK.
  */
 export interface IZeroHashSDK {
-    setUserOnboardingJWT(params: ISetUserOnboardingJWTParameters): void
-    isOnboardingModalOpen(): boolean
-    openOnboardingModal(params: IOpenOnboardingModalParameters): void
-    closeOnboardingModal(): void
+  setUserOnboardingJWT(params: ISetUserOnboardingJWTParameters): void
+  isOnboardingModalOpen(): boolean
+  openOnboardingModal(params: IOpenOnboardingModalParameters): void
+  closeOnboardingModal(): void
 }
 
 /**
@@ -291,55 +312,75 @@ export interface IZeroHashSDK {
  * the requested action, i.e. sdk.setJWT(AppIdentifier.ONBOARDING)
  */
 export enum AppIdentifier {
-    ONBOARDING = "onboarding",
-    CRYPTO_WITHDRAWALS = "crypto-withdrawals",
-    FIAT_DEPOSITS = "fiat-deposits",
-    FIAT_WITHDRAWALS = "fiat-withdrawals",
-    CRYPTO_BUY = "crypto-buy",
-    CRYPTO_SELL = "crypto-sell",
-    CSP_CRYPTO_WITHDRAWALS = "csp-crypto-withdrawals",
-    CSP_FIAT_WITHDRAWALS = "csp-fiat-withdrawals",
-    CSP_CRYPTO_SELL = "csp-crypto-sell",
-    FUND = "fund"
+  ONBOARDING = "onboarding",
+  CRYPTO_WITHDRAWALS = "crypto-withdrawals",
+  FIAT_DEPOSITS = "fiat-deposits",
+  FIAT_WITHDRAWALS = "fiat-withdrawals",
+  CRYPTO_BUY = "crypto-buy",
+  CRYPTO_SELL = "crypto-sell",
+  CSP_CRYPTO_WITHDRAWALS = "csp-crypto-withdrawals",
+  CSP_FIAT_WITHDRAWALS = "csp-fiat-withdrawals",
+  CSP_CRYPTO_SELL = "csp-crypto-sell",
+  FUND = "fund",
+  PROFILE = "profile"
 }
 
 /**
 * Map that maps the app AppIdentifier to the redux action prefix
 */
 export const appIdentifierToActionPrefixMap = new Map(
-    [
-        [AppIdentifier.ONBOARDING, "ONBOARDING_"],
-        [AppIdentifier.CRYPTO_WITHDRAWALS, "CRYPTO_WITHDRAWALS_"],
-        [AppIdentifier.FIAT_DEPOSITS, "FIAT_DEPOSITS_"],
-        [AppIdentifier.FIAT_WITHDRAWALS, "FIAT_WITHDRAWALS_"],
-        [AppIdentifier.CRYPTO_BUY, "CRYPTO_BUY_"],
-        [AppIdentifier.CRYPTO_SELL, "CRYPTO_SELL_"],
-        [AppIdentifier.CSP_CRYPTO_WITHDRAWALS, "CRYPTO_WITHDRAWALS_"], // CSP apps uses the same events as "regular" flow
-        [AppIdentifier.CSP_FIAT_WITHDRAWALS, "FIAT_WITHDRAWALS_"], // CSP apps uses the same events as "regular" flow
-        [AppIdentifier.CSP_CRYPTO_SELL, "CRYPTO_SELL_"],
-        [AppIdentifier.CSP_CRYPTO_SELL, "CRYPTO_SELL_"],
-        [AppIdentifier.FUND, "FUND_"],
-    ])
+  [
+    [AppIdentifier.ONBOARDING, "ONBOARDING_"],
+    [AppIdentifier.CRYPTO_WITHDRAWALS, "CRYPTO_WITHDRAWALS_"],
+    [AppIdentifier.FIAT_DEPOSITS, "FIAT_DEPOSITS_"],
+    [AppIdentifier.FIAT_WITHDRAWALS, "FIAT_WITHDRAWALS_"],
+    [AppIdentifier.CRYPTO_BUY, "CRYPTO_BUY_"],
+    [AppIdentifier.CRYPTO_SELL, "CRYPTO_SELL_"],
+    [AppIdentifier.CSP_CRYPTO_WITHDRAWALS, "CRYPTO_WITHDRAWALS_"], // CSP apps uses the same events as "regular" flow
+    [AppIdentifier.CSP_FIAT_WITHDRAWALS, "FIAT_WITHDRAWALS_"], // CSP apps uses the same events as "regular" flow
+    [AppIdentifier.CSP_CRYPTO_SELL, "CRYPTO_SELL_"],
+    [AppIdentifier.CSP_CRYPTO_SELL, "CRYPTO_SELL_"],
+    [AppIdentifier.FUND, "FUND_"],
+    [AppIdentifier.PROFILE, "PROFILE_"],
+  ])
 
 export interface ISetJWTParameters {
-    jwt: string;
-    appIdentifier: AppIdentifier;
+  jwt: string;
+  appIdentifier: AppIdentifier;
 }
 
 export interface Filters {
-    getAssets?: {
-        deposit_address_creation?: string
-        stablecoin?: boolean
-    }
+  getAssets?: {
+    deposit_address_creation?: string
+    stablecoin?: boolean
+  }
 }
 
 export interface IOpenModalParameters {
-    jwt?: string;
-    appIdentifier: AppIdentifier;
-    filters?: Filters;
+  jwt?: string;
+  appIdentifier: AppIdentifier;
+  filters?: Filters;
+  navigate?: Page;
 }
 
 export interface ISetFiltersParameters {
-    appIdentifier: AppIdentifier;
-    filters?: Filters
+  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;
 }