zh-web-sdk 2.3.2 → 2.3.4

package/README.md

@@ -89,9 +89,9 @@ We forward events that come from the UI to the Native App using the `postMessage
 - **Crypto Withdrawals:**
   - `CRYPTO_WITHDRAWALS_APP_LOADED` Sent when the App is loaded in the first time
   - `CRYPTO_WITHDRAWALS_CLOSE_BUTTON_CLICKED` Sent when the user clicks the Close button on the top-right corner
-- **ACH Deposits:**
-  - `ACH_DEPOSITS_APP_LOADED` Sent when the App is loaded in the first time
-  - `ACH_DEPOSITS_CLOSE_BUTTON_CLICKED` Sent when the user clicks the Close button on the top-right corner
+- **Fiat Deposits:**
+  - `FIAT_DEPOSITS_APP_LOADED` Sent when the App is loaded in the first time
+  - `FIAT_DEPOSITS_CLOSE_BUTTON_CLICKED` Sent when the user clicks the Close button on the top-right corner
 - **Fiat Withdrawals:**
   - `FIAT_WITHDRAWALS_APP_LOADED` Sent when the App is loaded in the first time
   - `FIAT_WITHDRAWALS_CLOSE_BUTTON_CLICKED` Sent when the user clicks the Close button on the top-right corner
@@ -110,9 +110,9 @@ To control the `WebView` you can also send messages *down*, using the `postMessa
 - **Crypto Withdrawals**
   - `{type: "OPEN_MODAL", payload:{jwt: "<JWT_HERE>", appIdentifier: "crypto-withdrawals"} }`: It will open the Crypto Withdrawals modal with the JWT provided
   - `{type: "CLOSE_MODAL", payload:{appIdentifier: "crypto-withdrawals"}}`: It will close the Crypto Withdrawals modal
-- **ACH Deposits**
-  - `{type: "OPEN_MODAL", payload:{jwt: "<JWT_HERE>", appIdentifier: "ach-deposits"} }`: It will open the ACH Deposits modal with the JWT provided
-  - `{type: "CLOSE_MODAL", payload:{appIdentifier: "ach-deposits"}}`: It will close the ACH Deposits modal
+- **Fiat Deposits**
+  - `{type: "OPEN_MODAL", payload:{jwt: "<JWT_HERE>", appIdentifier: "fiat-deposits"} }`: It will open the FIAT Deposits modal with the JWT provided
+  - `{type: "CLOSE_MODAL", payload:{appIdentifier: "fiat-deposits"}}`: It will close the Fiat Deposits modal
 - **Fiat Withdrawals**
   - `{type: "OPEN_MODAL", payload:{jwt: "<JWT_HERE>", appIdentifier: "fiat-withdrawals"} }`: It will open the Fiat withdrawals modal with the JWT provided
   - `{type: "CLOSE_MODAL", payload:{appIdentifier: "fiat-withdrawals"}}`: It will close the Fiat withdrawals modal
@@ -125,6 +125,8 @@ To control the `WebView` you can also send messages *down*, using the `postMessa
 
 #### Notes
 A postMessage call is required to open the modal when the webview is loaded (type: OPEN_MODAL). This requirement was added in version `https://{SDK_SERVER_URL}/v1` and is not present in `https://{SDK_SERVER_URL}/`, which opens the onboarding app automatically. The latter will be deprecated and will not be available for use in the future.
+
+To safely trigger the "OPEN_MODAL" event in the version 1, listen for an event sent by sdk-mobile indicating that the app is ready to receive events. This event generate by sdk-mobile is called **SDK_MOBILE_READY**.
  
 The example below shows how you can implement the mentioned methods in a `react-native` project
 
@@ -138,19 +140,18 @@ const App = () => {
   const mockJWT =
     'eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJ6ZXJvaGFzaC5jb20iLCJzdWIiOiJ0ZXN0U3ViamVjdCIsImF1ZCI6WyJ6ZXJvaGFzaC5jb20iXSwiZXhwIjoxNjk1OTc2OTMzLCJpYXQiOjE2OTMzODQ5MzMsInBheWxvYWQiOnsiZW1haWwiOiJteS1lbWFpbEB0ZXN0LmNvbSIsInBhcnRpY2lwYW50X2NvZGUiOiJwYXJ0aWNpcGFudC1jb2RlIiwicGxhdGZvcm1fbmFtZSI6InBsYXRmb3JtLW5hbWUiLCJwbGF0Zm9ybV9jb2RlIjoicGxhdGZvcm0tY29kZSIsInBsYXRmb3JtX2FncmVlbWVudF9saW5rIjoicGxhdGZvcm0tYWdyZWVtZW50LWxpbmsifX0.r549t4J_iQ8wP5pnD2uTdRaRm4nHLO722lDmhbGoIc0E_cKVyVYnxZTO1DnXJ6NUJ6a3DvnkGv78iQHqvnFTmg'
   const apps = {
-    achDeposits: { identifier: 'ach-deposits', jwt: mockJWT },
+    fiatDeposits: { identifier: 'fiat-deposits', jwt: mockJWT },
     cryptoBuy: { identifier: 'crypto-buy', jwt: mockJWT },
     cryptoSell: { identifier: 'crypto-sell', jwt: mockJWT },
     cryptoWithdrawals: { identifier: 'crypto-withdrawals', jwt: mockJWT },
     fiatWithdrawals: { identifier: 'fiat-withdrawals', jwt: mockJWT },
     userOnboarding: { identifier: 'onboarding', jwt: mockJWT },
   }
-
   /**
    * Receive messages from sdk-mobile. Currently we expose the following event types:
    * "ONBOARDING_APP_LOADED", "ONBOARDING_CLOSE_BUTTON_CLICKED",
    * "CRYPTO_WITHDRAWALS_APP_LOADED", "CRYPTO_WITHDRAWALS_CLOSE_BUTTON_CLICKED",
-   * "ACH_DEPOSITS_APP_LOADED", "ACH_DEPOSITS_CLOSE_BUTTON_CLICKED",
+   * "FIAT_DEPOSITS_APP_LOADED", "FIAT_DEPOSITS_CLOSE_BUTTON_CLICKED",
    * "FIAT_WITHDRAWALS_APP_LOADED", "FIAT_WITHDRAWALS_CLOSE_BUTTON_CLICKED",
    * "CRYPTO_BUY_APP_LOADED", "CRYPTO_BUY_CLOSE_BUTTON_CLICKED",
    * "CRYPTO_SELL_APP_LOADED", "CRYPTO_SELL_CLOSE_BUTTON_CLICKED",
@@ -160,16 +161,21 @@ const App = () => {
     const closeModalEvents = [
       'ONBOARDING_CLOSE_BUTTON_CLICKED',
       'CRYPTO_WITHDRAWALS_CLOSE_BUTTON_CLICKED',
-      'ACH_DEPOSITS_CLOSE_BUTTON_CLICKED',
+      'FIAT_DEPOSITS_CLOSE_BUTTON_CLICKED',
       'FIAT_WITHDRAWALS_CLOSE_BUTTON_CLICKED',
       'CRYPTO_BUY_CLOSE_BUTTON_CLICKED',
       'CRYPTO_SELL_CLOSE_BUTTON_CLICKED',
     ]
     try {
       const parsedMessage = JSON.parse(event.nativeEvent.data)
+      console.log('Received message:', parsedMessage)
       if (closeModalEvents.includes(parsedMessage.type)) {
         setIsWebViewOpen(false)
       }
+      if (parsedMessage.type === 'SDK_MOBILE_READY') {
+        console.log('SDK is ready, opening modal...')
+        openModal()
+      }
     } catch (e) {
       alert(
         `could not parse message: ${JSON.stringify(event.nativeEvent.data)}`,
@@ -195,7 +201,6 @@ const App = () => {
     ) {
       throw new Error('Invalid app identifier')
     }
-
     if (useJWT) {
       // You can send events with JWTs. See the example below
       // { "type": "OPEN_MODAL", "payload": { "appIdentifier": "onboarding", "jwt": "some-jwt-token"}}
@@ -207,7 +212,6 @@ const App = () => {
     // { "type": "CLOSE_MODAL", "payload": { "appIdentifier": "onboarding"}}
     return `{ "type": "${eventType}", "payload": { "appIdentifier": "${eventAppIdentifier}"}}`
   }
-
   const openModal = () => {
     setIsWebViewOpen(true)
     webViewRef.current?.injectJavaScript(
@@ -282,13 +286,6 @@ const App = () => {
               ref={webViewRef}
               onMessage={handleMessage}
               source={{ uri: generateURL() }}
-              onNavigationStateChange={(navState) => {
-                if (!navState.loading) {
-                  setTimeout(() => {
-                    openModal()
-                  }, 100)
-                }
-              }}
             />
           )}
         </View>

package/dist/index.d.ts

@@ -12,7 +12,7 @@ export declare class ZeroHashSDK implements IZeroHashSDK {
      *
      * For more information, see {@code IInitializeParameters}
      */
-    constructor({ zeroHashOnboardingURL, rootQuerySelector, userOnboardingJWT, cryptoWithdrawalsJWT, achDepositsJWT, fiatWithdrawalsJWT, cryptoBuyJWT, cryptoSellJWT, zeroHashAppsURL, }: IInitializeParameters);
+    constructor({ zeroHashOnboardingURL, rootQuerySelector, userOnboardingJWT, cryptoWithdrawalsJWT, fiatDepositsJWT, fiatWithdrawalsJWT, cryptoBuyJWT, cryptoSellJWT, zeroHashAppsURL, }: IInitializeParameters);
     /**
      * setJWT sets the JWT for the appIdentifier provided.
      * The JWT should be the JWT provided by ZeroHash via the platform