@meshconnect/web-link-sdk 3.10.1 → 3.10.4

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@meshconnect/web-link-sdk",
-  "version": "3.10.1",
+  "version": "3.10.4",
   "description": "A client-side JS library for integrating with Mesh Connect",
   "exports": "./index.js",
   "license": "MIT",
   "repository": "https://github.com/FrontFin/mesh-web-sdk.git",
   "homepage": "https://github.com/FrontFin/mesh-web-sdk",
   "dependencies": {
-    "@meshconnect/node-api": "^2.0.27",
+    "@meshconnect/node-api": "^2.0.28",
     "@meshconnect/uwc-bridge-parent": "1.4.0"
   },
   "jest": {

package/utils/event-types.d.ts

@@ -1,6 +1,6 @@
 import { LinkPayload, TransferFinishedPayload } from './types';
-export type LinkEventType = IntegrationConnected | IntegrationConnectionError | TransferCompleted | IntegrationSelected | CredentialsEntered | TransferStarted | TransferPreviewed | TransferPreviewError | TransferExecutionError | PageLoaded | IntegrationMfaRequired | IntegrationMfaEntered | IntegrationOAuthStarted | IntegrationAccountSelectionRequired | TransferAssetSelected | TransferNetworkSelected | TransferAmountEntered | TransferMfaRequired | TransferMfaEntered | TransferKycRequired | TransferInitiated | TransferExecuted | TransferNoEligibleAssets | WalletMessageSigned | DoneEvent | CloseEvent | VerifyWalletRejected | VerifyDonePage | SDKinjectedWalletProviders | LegalTermsViewed | SeeWhatHappenedClicked | FundingOptionsUpdated | FundingOptionsViewed | GasIncreaseWarning | ExecuteFundingStep | LinkTransferQrGenerated | HomePageMethodSelected;
-declare const LINK_EVENT_TYPE_KEYS: readonly ["integrationConnected", "integrationConnectionError", "integrationMfaRequired", "integrationMfaEntered", "integrationOAuthStarted", "integrationAccountSelectionRequired", "transferCompleted", "integrationSelected", "credentialsEntered", "transferStarted", "transferPreviewed", "transferPreviewError", "transferExecutionError", "pageLoaded", "transferAssetSelected", "transferNetworkSelected", "transferAmountEntered", "transferMfaRequired", "transferMfaEntered", "transferKycRequired", "transferExecuted", "transferInitiated", "transferNoEligibleAssets", "walletMessageSigned", "verifyDonePage", "verifyWalletRejected", "connectionDeclined", "transferConfigureError", "connectionUnavailable", "transferDeclined", "done", "close", "SDKinjectedWalletProviders", "legalTermsViewed", "seeWhatHappenedClicked", "executeFundingStep", "fundingOptionsUpdated", "fundingOptionsViewed", "gasIncreaseWarning", "linkTransferQRGenerated", "methodSelected"];
+export type LinkEventType = IntegrationConnected | IntegrationConnectionError | TransferCompleted | IntegrationSelected | CredentialsEntered | TransferStarted | TransferPreviewed | TransferPreviewError | TransferExecutionError | TransferConfigureError | PageLoaded | IntegrationMfaRequired | IntegrationMfaEntered | IntegrationOAuthStarted | IntegrationAccountSelectionRequired | TransferAssetSelected | TransferNetworkSelected | TransferAmountEntered | TransferMfaRequired | TransferMfaEntered | TransferKycRequired | TransferInitiated | TransferExecuted | TransferNoEligibleAssets | WalletMessageSigned | DoneEvent | CloseEvent | VerifyWalletRejected | VerifyDonePage | SDKinjectedWalletProviders | LegalTermsViewed | SeeWhatHappenedClicked | FundingOptionsUpdated | FundingOptionsViewed | GasIncreaseWarning | ExecuteFundingStep | LinkTransferQrGenerated | HomePageMethodSelected | ConnectionUnavailable | ConnectionDeclined | TransferDeclined | DefiWalletError | HomePageLoaded;
+declare const LINK_EVENT_TYPE_KEYS: readonly ["integrationConnected", "integrationConnectionError", "integrationMfaRequired", "integrationMfaEntered", "integrationOAuthStarted", "integrationAccountSelectionRequired", "transferCompleted", "integrationSelected", "credentialsEntered", "transferStarted", "transferPreviewed", "transferPreviewError", "transferExecutionError", "transferConfigureError", "pageLoaded", "transferAssetSelected", "transferNetworkSelected", "transferAmountEntered", "transferMfaRequired", "transferMfaEntered", "transferKycRequired", "transferExecuted", "transferInitiated", "transferNoEligibleAssets", "walletMessageSigned", "verifyDonePage", "verifyWalletRejected", "connectionDeclined", "connectionUnavailable", "transferDeclined", "done", "close", "SDKinjectedWalletProviders", "legalTermsViewed", "seeWhatHappenedClicked", "executeFundingStep", "fundingOptionsUpdated", "fundingOptionsViewed", "gasIncreaseWarning", "linkTransferQRGenerated", "methodSelected", "defiWalletError", "homePageLoaded"];
 export type LinkEventTypeKeys = (typeof LINK_EVENT_TYPE_KEYS)[number];
 export declare function isLinkEventTypeKey(key: string): key is LinkEventTypeKeys;
 interface LinkEventBase {
@@ -17,6 +17,7 @@ export interface IntegrationConnectionError extends LinkEventBase {
     type: 'integrationConnectionError';
     payload: {
         errorMessage: string;
+        requestId?: string;
     };
 }
 export interface TransferCompleted extends LinkEventBase {
@@ -28,6 +29,8 @@ export interface IntegrationSelected extends LinkEventBase {
     payload: {
         integrationType: string;
         integrationName: string;
+        nativeLink?: string;
+        userSearched?: boolean;
     };
 }
 export interface CredentialsEntered extends LinkEventBase {
@@ -35,6 +38,10 @@ export interface CredentialsEntered extends LinkEventBase {
 }
 export interface TransferStarted extends LinkEventBase {
     type: 'transferStarted';
+    payload: {
+        integrationType?: string;
+        integrationName: string;
+    };
 }
 export interface TransferInitiated extends LinkEventBase {
     type: 'transferInitiated';
@@ -72,6 +79,27 @@ export interface TransferNoEligibleAssets extends LinkEventBase {
         }[];
     };
 }
+export interface TransferFee {
+    fee?: number;
+    feeCurrency?: string;
+    feeInFiat?: number;
+}
+export interface CryptocurrencyFundingOption {
+    cryptocurrencyFundingOptionType?: string;
+    name?: string;
+    paymentMethodType?: string;
+    usedAmountInCryptocurrency?: number;
+    usedAmountInFiat?: number;
+    cryptocurrencySymbol?: string;
+    fee?: {
+        amountInFiat?: number;
+        fiatSymbol?: string;
+        amountInCryptocurrency?: number;
+        cryptocurrencySymbol?: string;
+        isInclusive?: boolean;
+        usedCurrencyType?: string;
+    };
+}
 export interface TransferPreviewed extends LinkEventBase {
     type: 'transferPreviewed';
     payload: {
@@ -82,23 +110,36 @@ export interface TransferPreviewed extends LinkEventBase {
         previewId: string;
         networkName?: string;
         amountInFiat?: number;
-        estimatedNetworkGasFee?: {
-            fee?: number;
-            feeCurrency?: string;
-            feeInFiat?: number;
-        };
+        fiatCurrency?: string;
+        integrationType?: string;
+        integrationName?: string;
+        estimatedNetworkGasFee?: TransferFee;
+        institutionTransferFee?: TransferFee;
+        customClientFee?: TransferFee;
+        cryptocurrencyFundingOptions?: CryptocurrencyFundingOption[];
+        userId?: string;
+        clientTransactionId?: string;
     };
 }
 export interface TransferPreviewError extends LinkEventBase {
     type: 'transferPreviewError';
     payload: {
         errorMessage: string;
+        requestId?: string;
     };
 }
 export interface TransferExecutionError extends LinkEventBase {
     type: 'transferExecutionError';
     payload: {
         errorMessage: string;
+        requestId?: string;
+    };
+}
+export interface TransferConfigureError extends LinkEventBase {
+    type: 'transferConfigureError';
+    payload: {
+        errorMessage: string;
+        requestId?: string;
     };
 }
 export interface IntegrationMfaRequired extends LinkEventBase {
@@ -138,6 +179,37 @@ export interface TransferMfaEntered extends LinkEventBase {
 export interface TransferKycRequired extends LinkEventBase {
     type: 'transferKycRequired';
 }
+export interface ConnectionUnavailable extends LinkEventBase {
+    type: 'connectionUnavailable';
+    payload: {
+        integrationType?: string;
+        integrationName: string;
+        reason: string;
+    };
+}
+export interface ConnectionDeclined extends LinkEventBase {
+    type: 'connectionDeclined';
+    payload: {
+        integrationType?: string;
+        integrationName: string;
+        reason: string;
+        networkId?: string;
+        toAddress?: string;
+        errorMessage?: string;
+    };
+}
+export interface TransferDeclined extends LinkEventBase {
+    type: 'transferDeclined';
+    payload: {
+        integrationType?: string;
+        integrationName: string;
+        toAddress?: string;
+        token?: string;
+        network?: string;
+        amount?: number;
+        status: string;
+    };
+}
 export interface DoneEvent extends LinkEventBase {
     type: 'done';
     payload: SessionSummary;
@@ -154,6 +226,22 @@ export interface WalletMessageSigned extends LinkEventBase {
         address: string;
         timeStamp: number;
         isVerified: boolean;
+        verifiedAddresses?: string[];
+    };
+}
+export interface DefiWalletError extends LinkEventBase {
+    type: 'defiWalletError';
+    payload: {
+        integrationName: string;
+        errorType: 'timeout' | 'verifyMismatch';
+        details: {
+            requestedAddress?: string;
+            connectedAddress?: string;
+            requestedNetwork?: string;
+            connectedNetwork?: string;
+            connectUri?: string;
+        };
+        timeStamp: number;
     };
 }
 export interface VerifyDonePage extends LinkEventBase {
@@ -163,34 +251,14 @@ export interface VerifyWalletRejected extends LinkEventBase {
     type: 'verifyWalletRejected';
 }
 export interface SessionSummary {
-    /**
-     *   Current page of application. Possible values:
-     * `startPage`
-     * `integrationsCatalogPage`
-     * `integrationLoginPage`
-     * `integrationMfaPage`
-     * `integrationAccountSelectPage`
-     * `integrationConnectedPage`
-     * `errorPage`
-     * `transferKycPage`
-     * `transferHoldingSelectionPage`
-     * `transferNetworkSelectionPage`
-     * `transferAmountSelectionPage`
-     * `transferPreviewPage`
-     * `transferMfaPage`
-     * `transferFundingPage`
-     * `transferExecutedPage`
-     * `termsAndConditionPage`
-     *
-     * This list may change in future.
-     */
+    /** The page the user was on when the session ended (e.g. 'transferExecutedPage', 'integrationConnectedPage'). */
     page: string;
-    /** Selected integration */
     selectedIntegration?: {
         id?: string;
         name?: string;
+        integrationType?: string;
+        integrationName?: string;
     };
-    /** Transfer information */
     transfer?: {
         previewId?: string;
         symbol?: string;
@@ -247,4 +315,7 @@ export interface HomePageMethodSelected {
         method: 'embedded' | 'manual' | 'buy';
     };
 }
+export interface HomePageLoaded extends LinkEventBase {
+    type: 'homePageLoaded';
+}
 export {};

package/utils/event-types.js

@@ -12,6 +12,7 @@ var LINK_EVENT_TYPE_KEYS = [
     'transferPreviewed',
     'transferPreviewError',
     'transferExecutionError',
+    'transferConfigureError',
     'pageLoaded',
     'transferAssetSelected',
     'transferNetworkSelected',
@@ -26,7 +27,6 @@ var LINK_EVENT_TYPE_KEYS = [
     'verifyDonePage',
     'verifyWalletRejected',
     'connectionDeclined',
-    'transferConfigureError',
     'connectionUnavailable',
     'transferDeclined',
     'done',
@@ -39,7 +39,9 @@ var LINK_EVENT_TYPE_KEYS = [
     'fundingOptionsViewed',
     'gasIncreaseWarning',
     'linkTransferQRGenerated',
-    'methodSelected'
+    'methodSelected',
+    'defiWalletError',
+    'homePageLoaded'
 ];
 export function isLinkEventTypeKey(key) {
     return LINK_EVENT_TYPE_KEYS.includes(key);

package/utils/types.d.ts

@@ -108,6 +108,7 @@ export interface LinkOptions {
      */
     clientId?: string;
     /**
+     * @deprecated This callback is now obsolete. Please use server-side webhooks instead for 'integration connected' events.
      * A callback function that is called when an integration is successfully connected.
      * It receives a payload of type `LinkPayload`.
      */
@@ -117,16 +118,19 @@ export interface LinkOptions {
      */
     onExit?: (error?: string, summary?: SessionSummary) => void;
     /**
+     * @deprecated This callback is now obsolete. Please use server-side webhooks instead for 'transfer finished' events.
      * (Optional) A callback function that is called when a transfer is finished.
      * It receives a payload of type `TransferFinishedPayload`.
      */
     onTransferFinished?: (payload: TransferFinishedPayload) => void;
     /**
+     * @deprecated This callback is now obsolete. Please use server-side webhooks instead for all events.
      * (Optional) A callback function that is called when various events occur within the Front iframe.
      * It receives an object with type `LinkEventTypeKeys` indicating the event, and an optional 'payload' containing additional data.
      */
     onEvent?: (event: LinkEventType) => void;
     /**
+     * @deprecated This property is now obsolete.
      * (Optional) An array of integration access tokens.
      * These access tokens are used to initialize crypto transfers flow at 'Select asset step'
      */

package/utils/version.d.ts

@@ -1 +1 @@
-export declare const sdkVersion = "3.10.1";
+export declare const sdkVersion = "3.10.4";

package/utils/version.js

@@ -1 +1 @@
-export var sdkVersion = '3.10.1';
+export var sdkVersion = '3.10.4';