@meshconnect/web-link-sdk 2.1.0-rc.1 → 2.1.0-rc.3

package/index.d.ts

@@ -1,289 +1,3 @@
-import { BrokerType } from '@meshconnect/node-api';
-import { Hash, Chain } from 'viem';
-
-type LinkEventType = IntegrationConnected | IntegrationConnectionError | TransferCompleted | IntegrationSelected | CredentialsEntered | TransferStarted | TransferPreviewed | TransferPreviewError | TransferExecutionError | PageLoaded | IntegrationMfaRequired | IntegrationMfaEntered | IntegrationOAuthStarted | IntegrationAccountSelectionRequired | TransferAssetSelected | TransferNetworkSelected | TransferAmountEntered | TransferMfaRequired | TransferMfaEntered | TransferKycRequired | DoneEvent | CloseEvent;
-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", "done", "close"];
-type LinkEventTypeKeys = (typeof LINK_EVENT_TYPE_KEYS)[number];
-declare function isLinkEventTypeKey(key: string): key is LinkEventTypeKeys;
-interface LinkEventBase {
-    type: LinkEventTypeKeys;
-}
-interface PageLoaded {
-    type: 'pageLoaded';
-}
-interface IntegrationConnected extends LinkEventBase {
-    type: 'integrationConnected';
-    payload: LinkPayload;
-}
-interface IntegrationConnectionError extends LinkEventBase {
-    type: 'integrationConnectionError';
-    payload: {
-        errorMessage: string;
-    };
-}
-interface TransferCompleted extends LinkEventBase {
-    type: 'transferCompleted';
-    payload: TransferFinishedPayload;
-}
-interface IntegrationSelected extends LinkEventBase {
-    type: 'integrationSelected';
-    payload: {
-        integrationType: string;
-        integrationName: string;
-    };
-}
-interface CredentialsEntered extends LinkEventBase {
-    type: 'credentialsEntered';
-}
-interface TransferStarted extends LinkEventBase {
-    type: 'transferStarted';
-}
-interface TransferPreviewed extends LinkEventBase {
-    type: 'transferPreviewed';
-    payload: {
-        amount: number;
-        symbol: string;
-        toAddress: string;
-        networkId: string;
-        previewId: string;
-        networkName?: string;
-        amountInFiat?: number;
-        estimatedNetworkGasFee?: {
-            fee?: number;
-            feeCurrency?: string;
-            feeInFiat?: number;
-        };
-    };
-}
-interface TransferPreviewError extends LinkEventBase {
-    type: 'transferPreviewError';
-    payload: {
-        errorMessage: string;
-    };
-}
-interface TransferExecutionError extends LinkEventBase {
-    type: 'transferExecutionError';
-    payload: {
-        errorMessage: string;
-    };
-}
-interface IntegrationMfaRequired extends LinkEventBase {
-    type: 'integrationMfaRequired';
-}
-interface IntegrationMfaEntered extends LinkEventBase {
-    type: 'integrationMfaEntered';
-}
-interface IntegrationOAuthStarted extends LinkEventBase {
-    type: 'integrationOAuthStarted';
-}
-interface IntegrationAccountSelectionRequired extends LinkEventBase {
-    type: 'integrationAccountSelectionRequired';
-}
-interface TransferAssetSelected extends LinkEventBase {
-    type: 'transferAssetSelected';
-    payload: {
-        symbol: string;
-    };
-}
-interface TransferNetworkSelected extends LinkEventBase {
-    type: 'transferNetworkSelected';
-    payload: {
-        id: string;
-        name: string;
-    };
-}
-interface TransferAmountEntered extends LinkEventBase {
-    type: 'transferAmountEntered';
-}
-interface TransferMfaRequired extends LinkEventBase {
-    type: 'transferMfaRequired';
-}
-interface TransferMfaEntered extends LinkEventBase {
-    type: 'transferMfaEntered';
-}
-interface TransferKycRequired extends LinkEventBase {
-    type: 'transferKycRequired';
-}
-interface DoneEvent extends LinkEventBase {
-    type: 'done';
-    payload: SessionSymmary;
-}
-interface CloseEvent extends LinkEventBase {
-    type: 'close';
-    payload: SessionSymmary;
-}
-interface SessionSymmary {
-    /**
-     *   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.
-     */
-    page: string;
-    /** Selected integration */
-    selectedIntegration?: {
-        id?: string;
-        name?: string;
-    };
-    /** Transfer information */
-    transfer?: {
-        previewId?: string;
-        symbol?: string;
-        amount?: number;
-        amountInFiat?: number;
-        transactionId?: string;
-        networkId?: string;
-    };
-    errorMessage?: string;
-}
-
-type EventType = 'brokerageAccountAccessToken' | 'delayedAuthentication' | 'loaded' | 'oauthLinkOpen' | 'transferFinished';
-interface Link {
-    /**
-     * A function that takes linkToken parameter from `/api/v1/linktoken` endpoint as an input, and opens the Link UI popup
-     */
-    openLink: (linkToken: string) => Promise<void>;
-    /**
-     * A function to close Link UI popup
-     */
-    closeLink: () => void;
-}
-interface AccountToken {
-    account: Account;
-    accessToken: string;
-    refreshToken?: string;
-}
-interface Account {
-    accountId: string;
-    accountName: string;
-    fund?: number;
-    cash?: number;
-    isReconnected?: boolean;
-}
-interface BrandInfo {
-    brokerLogo: string;
-    brokerPrimaryColor?: string;
-}
-interface LinkPayload {
-    accessToken?: AccessTokenPayload;
-    delayedAuth?: DelayedAuthPayload;
-}
-interface AccessTokenPayload {
-    accountTokens: AccountToken[];
-    brokerBrandInfo: BrandInfo;
-    expiresInSeconds?: number;
-    refreshTokenExpiresInSeconds?: number;
-    brokerType: BrokerType;
-    brokerName: string;
-}
-interface DelayedAuthPayload {
-    refreshTokenExpiresInSeconds?: number;
-    brokerType: BrokerType;
-    refreshToken: string;
-    brokerName: string;
-    brokerBrandInfo: BrandInfo;
-}
-interface TransferFinishedPayload {
-    status: 'success';
-    txId: string;
-    fromAddress: string;
-    toAddress: string;
-    symbol: string;
-    amount: number;
-    networkId: string;
-}
-interface IntegrationAccessToken {
-    accountId: string;
-    accountName: string;
-    accessToken: string;
-    brokerType: BrokerType;
-    brokerName: string;
-}
-interface WagmiInjectedConnectorData {
-    id: string;
-    name: string;
-    type: string;
-    icon?: string;
-    uid: string;
-}
-interface ConnectReturnTypeAndTxHash {
-    accounts: string[];
-    chainId: number;
-    txSigned: Hash;
-}
-interface IncomingConfig {
-    chains: Chain[];
-    transports: Record<number, string | string[]>;
-}
-interface AbiItem {
-    name: string;
-    type: string;
-    inputs: {
-        name: string;
-        type: string;
-    }[];
-    outputs?: {
-        name: string;
-        type: string;
-    }[];
-    stateMutability?: string;
-}
-type Abi = AbiItem[];
-interface LinkOptions {
-    /**
-     * Client ID that can be obtained at https://dashboard.meshconnect.com/company/keys
-     */
-    clientId: string;
-    /**
-     * A callback function that is called when an integration is successfully connected.
-     * It receives a payload of type `LinkPayload`.
-     */
-    onIntegrationConnected: (payload: LinkPayload) => void;
-    /**
-     * (Optional) A callback function that is called when the Front iframe is closed.
-     */
-    onExit?: (error?: string, summary?: SessionSymmary) => void;
-    /**
-     * (Optional) A callback function that is called when a transfer is finished.
-     * It receives a payload of type `TransferFinishedPayload`.
-     */
-    onTransferFinished?: (payload: TransferFinishedPayload) => void;
-    /**
-     * (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;
-    /**
-     * (Optional) An array of integration access tokens.
-     * These access tokens are used to initialize crypto transfers flow at 'Select asset step'
-     */
-    accessTokens?: IntegrationAccessToken[];
-    /**
-     * (Optional) An array of integration access tokens.
-     * Can be used to initialize the crypto transfers flow as an alternative to the target addresses.
-     */
-    transferDestinationTokens?: IntegrationAccessToken[];
-}
-interface LinkStyle {
-    ir: number;
-    io: number;
-}
-
-declare const createLink: (options: LinkOptions) => Link;
-
-export { type Abi, type AbiItem, type AccessTokenPayload, type Account, type AccountToken, type BrandInfo, type CloseEvent, type ConnectReturnTypeAndTxHash, type CredentialsEntered, type DelayedAuthPayload, type DoneEvent, type EventType, type IncomingConfig, type IntegrationAccessToken, type IntegrationAccountSelectionRequired, type IntegrationConnected, type IntegrationConnectionError, type IntegrationMfaEntered, type IntegrationMfaRequired, type IntegrationOAuthStarted, type IntegrationSelected, type Link, type LinkEventType, type LinkEventTypeKeys, type LinkOptions, type LinkPayload, type LinkStyle, type PageLoaded, type SessionSymmary, type TransferAmountEntered, type TransferAssetSelected, type TransferCompleted, type TransferExecutionError, type TransferFinishedPayload, type TransferKycRequired, type TransferMfaEntered, type TransferMfaRequired, type TransferNetworkSelected, type TransferPreviewError, type TransferPreviewed, type TransferStarted, type WagmiInjectedConnectorData, createLink, isLinkEventTypeKey };
+export * from './utils/types';
+export * from './utils/event-types';
+export { createLink } from './Link';