@imtbl/sdk 0.1.5-alpha → 0.1.6-alpha

package/dist/checkout_widgets.d.ts

@@ -547,6 +547,34 @@ declare class Web3Provider extends JsonRpcProvider {
     send(method: string, params: Array<any>): Promise<any>;
 }
 
+/**
+ * Interface representing token information.
+ * @property {string} name - The token name.
+ * @property {string} symbol - The token symbol.
+ * @property {number} decimals - The token decimals.
+ * @property {string} [address] - The token contract address.
+ * @property {string} [icon] - The token icon URL/data:image.
+ */
+interface TokenInfo {
+    name: string;
+    symbol: string;
+    decimals: number;
+    address?: string;
+    icon?: string;
+}
+/**
+ * Interface representing the information of a network.
+ * @property {string} name - The name of the network.
+ * @property {number} chainId - The ID of the network.
+ * @property {TokenInfo} nativeCurrency - The info of the network's native currency.
+ * @property {boolean} isSupported - Flag indicating if the network is supported by the application.
+ */
+interface NetworkInfo {
+    name: string;
+    chainId: number;
+    nativeCurrency: TokenInfo;
+    isSupported: boolean;
+}
 /**
  * Enum representing the list of default supported providers.
  */
@@ -14863,195 +14891,463 @@ declare global {
     }
 }
 
+/**
+ * Enum representing the events emitted by the widgets.
+ */
 declare enum IMTBLWidgetEvents {
     IMTBL_CONNECT_WIDGET_EVENT = "imtbl-connect-widget",
     IMTBL_WALLET_WIDGET_EVENT = "imtbl-wallet-widget",
     IMTBL_SWAP_WIDGET_EVENT = "imtbl-swap-widget",
     IMTBL_BRIDGE_WIDGET_EVENT = "imtbl-bridge-widget",
-    IMTBL_BUY_WIDGET_EVENT = "imtbl-buy-widget"
+    IMTBL_BUY_WIDGET_EVENT = "imtbl-buy-widget",
+    IMTBL_ONRAMP_WIDGET_EVENT = "imtbl-onramp-widget"
 }
+/**
+ * Enum representing possible Connect Widget event types.
+ */
 declare enum ConnectEventType {
     SUCCESS = "success",
     FAILURE = "failure",
     CLOSE_WIDGET = "close-widget"
 }
+/**
+ * Represents an event object emitted by the Connect Widget.
+ * @property {BuyEventType} type - The type of the event.
+ * @property {T} data - The data contained in the event.
+ */
 type ConnectEvent<T> = {
     type: ConnectEventType;
     data: T;
 };
+/**
+ * Type representing a Connect Widget event with type SUCCESS.
+ * @property {ConnectionProviders} providerPreference - The user's preferred connection provider.
+ */
 type ConnectionSuccess = {
     providerPreference: ConnectionProviders;
 };
+/**
+ * Type representing a Connect Widget event with type FAILURE.
+ * @property {string} reason - A description of the reason for the failed connection attempt.
+ */
 type ConnectionFailed = {
     reason: string;
 };
+/**
+ * Enum representing possible Wallet Widget event types.
+ */
 declare enum WalletEventType {
     CLOSE_WIDGET = "close-widget",
-    NETWORK_SWITCH = "network-switch"
+    NETWORK_SWITCH = "network-switch",
+    ADD_COINS = "add-coins",
+    REQUEST_SWAP = "request-swap",
+    REQUEST_BRIDGE = "request-bridge",
+    REQUEST_ONRAMP = "request-onramp"
 }
+/**
+ * Type representing the data emitted by the network switch event.
+ * @property {string} network - The name of the selected network.
+ * @property {number} chainId - The chain ID of the selected network.
+ */
 type WalletNetworkSwitchEvent = {
     network: string;
     chainId: number;
 };
+type WalletAddCoinsEvent = {
+    network?: NetworkInfo;
+    token?: TokenInfo;
+    tokenAmount?: string;
+};
+type WalletRequestSwapEvent = {
+    fromTokenAddress: string;
+    toTokenAddress: string;
+    amount: string;
+};
+type WalletRequestBridgeEvent = {
+    fromNetwork: string;
+    tokenAddress: string;
+    amount: string;
+};
+type WalletRequestOnrampEvent = {
+    tokenAddress: string;
+    amount: string;
+};
+/**
+ * Represents an event object emitted by the Wallet Widget.
+ * @property {WalletEventType} type - The type of the event.
+ * @property {T} data - The data contained in the event.
+ */
 type WalletEvent<T> = {
     type: WalletEventType;
     data: T;
 };
+/**
+ * Represents an event object emitted by the Swap Widget.
+ * @property {SwapEventType} type - The type of the event.
+ * @property {T} data - The data contained in the event.
+ */
 type SwapEvent<T> = {
     type: SwapEventType;
     data: T;
 };
+/**
+ * Enum representing possible Swap Widget event types.
+ */
 declare enum SwapEventType {
     SUCCESS = "success",
     FAILURE = "failure"
 }
+/**
+ * Type representing a Swap Widget with type SUCCESS.
+ * @property {number} timestamp - The timestamp of the successful swap.
+ */
 type SwapSuccess = {
     timestamp: number;
 };
+/**
+ * Type representing a Swap Widget with type FAILURE.
+ * @property {string} reason - The reason why the swap failed.
+ * @property {number} timestamp - The timestamp of the failed swap.
+ */
 type SwapFailed = {
     reason: string;
     timestamp: number;
 };
+/**
+ * Represents an event object emitted by the Bridge Widget.
+ * @property {BridgeEventType} type - The type of the event.
+ * @property {T} data - The data associated with the event.
+ */
 type BridgeEvent<T> = {
     type: BridgeEventType;
     data: T;
 };
+/**
+ * Enum of possible Bridge Widget event types.
+ */
 declare enum BridgeEventType {
     CLOSE_WIDGET = "close-widget",
     SUCCESS = "success",
     FAILURE = "failure"
 }
+/**
+ * Type representing a Bridge Widget event with type SUCCESS
+ * @property {number} timestamp - The UNIX timestamp (in milliseconds) when the event occurred.
+ */
 type BridgeSuccess = {
     timestamp: number;
 };
+/**
+ * Type representing a Bridge Widget event with type FAILURE
+ * @property {string} reason - The reason for the failure.
+ * @property {number} timestamp - The UNIX timestamp (in milliseconds) when the event occurred.
+ */
 type BridgeFailed = {
     reason: string;
     timestamp: number;
 };
+/**
+ * Represents an event object emitted by the Buy Widget.
+ * @property {BuyEventType} type - The type of the event.
+ * @property {T} data - The data contained in the event.
+ */
 type BuyEvent<T> = {
     type: BuyEventType;
     data: T;
 };
+/**
+ * Enum representing possible Buy Widget event types.
+ */
 declare enum BuyEventType {
     SUCCESS = "success",
     FAILURE = "failure",
     NOT_CONNECTED = "not_connected",
     CLOSE = "close"
 }
+/**
+ * Type representing a Buy Widget event with type CLOSE.
+ */
 type BuyClose = {};
+/**
+ * Type representing a Buy Widget event with type NOT_CONNECTED.
+ * @property {string} providerPreference - The preferred provider used for the connection within the Buy Widget.
+ */
 type BuyNotConnected = {
     providerPreference: string;
 };
+/**
+ * Type representing a Buy Widget event with type SUCCESS.
+ * @property {number} timestamp - The timestamp of the successful buy.
+ */
 type BuySuccess = {
     timestamp: number;
 };
+/**
+ * Type representing a Buy Widget event with type FAILURE.
+ * @property {string} reason - The reason why the buy failed.
+ * @property {number} timestamp - The timestamp of the failed buy.
+ */
 type BuyFailed = {
     reason: string;
     timestamp: number;
 };
-interface ImtblConnectProps extends undefined<undefined<HTMLElement>, HTMLElement> {
+type OnRampEvent<T> = {
+    type: OnRampEventType;
+    data: T;
+};
+declare enum OnRampEventType {
+}
+/**
+ * Props for the Connect Widget component
+ * @property {string} providerPreference - The preferred wallet provider to connect to.
+ * @property {string} theme - The theme to use.
+ */
+interface ImtblConnectProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
     providerPreference: string;
     theme: string;
 }
-interface ImtblWalletProps extends undefined<undefined<HTMLElement>, HTMLElement> {
+/**
+ * Props for the Wallet Widget component
+ * @property {string} providerPreference - The preferred wallet provider to connect to.
+ * @property {string} theme - The theme to use.
+ */
+interface ImtblWalletProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
     providerPreference: string;
+    isOnRampEnabled?: string;
+    isSwapEnabled?: string;
+    isBridgeEnabled?: string;
     theme: string;
 }
-interface ImtblSwapProps extends undefined<undefined<HTMLElement>, HTMLElement> {
+/**
+ * Props for the Swap Widget component
+ * @property {string} providerPreference - The preferred wallet provider to connect to.
+ * @property {string} theme - The theme to use.
+ * @property {string} amount - The amount to swap.
+ * @property {string} fromContractAddress - The contract address of the source token.
+ * @property {string} toContractAddress - The contract address of the destination token.
+ */
+interface ImtblSwapProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
     providerPreference: string;
     theme: string;
     amount: string;
     fromContractAddress: string;
     toContractAddress: string;
 }
-interface ImtblBridgeProps extends undefined<undefined<HTMLElement>, HTMLElement> {
+/**
+ * Props for the Bridge Widget component
+ * @property {string} providerPreference - The preferred wallet provider to connect to.
+ * @property {string} theme - The theme to use.
+ * @property {string} fromContractAddress - The contract address of the source token.
+ * @property {string} fromNetwork - The network of the source token.
+ * @property {string} amount - The amount to bridge.
+ */
+interface ImtblBridgeProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
     providerPreference: string;
     theme: string;
     fromContractAddress: string;
     fromNetwork: string;
     amount: string;
 }
-interface ImtblExampleProps extends undefined<undefined<HTMLElement>, HTMLElement> {
+/**
+ * Props for the Example Widget component
+ * @property {string} providerPreference - The preferred wallet provider to connect to.
+ * @property {string} theme - The theme to use.
+ * @experimental
+ */
+interface ImtblExampleProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
     providerPreference: string;
     theme: string;
 }
-interface ImtblBuyProps extends undefined<undefined<HTMLElement>, HTMLElement> {
+/**
+ * Props for the Buy Widget component
+ * @property {string} providerPreference - The preferred wallet provider to connect to.
+ * @property {string} theme - The theme to use.
+ * @property {string} orderId - The id of the order to buy.
+ */
+interface ImtblBuyProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
     providerPreference: string;
     theme: string;
     orderId: string;
 }
-interface ImtblTransitionExampleProps extends undefined<undefined<HTMLElement>, HTMLElement> {
+/**
+ * Props for the TransitionExample Widget component
+ * @property {string} providerPreference - The preferred wallet provider to connect to.
+ * @property {string} theme - The theme to use.
+ */
+interface ImtblTransitionExampleProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
     providerPreference: string;
     theme: string;
 }
-interface ImtblInnerWidgetExampleProps extends undefined<undefined<HTMLElement>, HTMLElement> {
+/**
+ * Props for the InnerWidgetExample Widget component
+ * @property {string} providerPreference - The preferred wallet provider to connect to.
+ * @property {string} theme - The theme to use.
+ */
+interface ImtblInnerWidgetExampleProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
     providerPreference: string;
     theme: string;
 }
-interface ImtblOuterWidgetExampleProps extends undefined<undefined<HTMLElement>, HTMLElement> {
+/**
+ * Props for the OuterWidgetExample Widget component
+ * @property {string} providerPreference - The preferred wallet provider to connect to.
+ * @property {string} theme - The theme to use.
+ */
+interface ImtblOuterWidgetExampleProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
     providerPreference: string;
     theme: string;
 }
+/**
+ * Enum representing the networks supported by Checkout.
+ */
 declare enum Network {
     ETHEREUM = "Ethereum",
     GOERLI = "Goerli",
     POLYGON = "Polygon"
 }
+/**
+ * Enum representing the themes for the Checkout widgets.
+ */
 declare enum WidgetTheme {
     LIGHT = "light",
     DARK = "dark",
     CUSTOM = "custom"
 }
+/**
+ * Enum representing the default Web3 providers supported by the Checkout widgets.
+ */
 declare enum WidgetConnectionProviders {
     METAMASK = "metamask"
 }
+/**
+ * Enum representing list of Checkout Widgets DOM tags.
+ */
 declare enum CheckoutWidgetTagNames {
     CONNECT = "imtbl-connect",
     WALLET = "imtbl-wallet",
     SWAP = "imtbl-swap",
     BUY = "imtbl-buy",
     BRIDGE = "imtbl-bridge",
-    EXAMPLe = "imtbl-example"
+    EXAMPLE = "imtbl-example"
 }
+/**
+ * Represents the configuration options for the Checkout Widgets.
+ * @property {WidgetTheme} theme - The theme of the Checkout Widget.
+ */
 type CheckoutWidgetsConfig = {
     theme?: WidgetTheme;
 };
+/**
+ * Interface representing the props for the Bridge Widget component.
+ * @property {WidgetConnectionProviders} providerPreference - The preferred provider for the Bridge Widget (default: {@link WidgetConnectionProviders.METAMASK}).
+ * @property {string} fromContractAddress - The contract address to send tokens from.
+ * @property {string} amount - The amount of tokens to send.
+ * @property {Network} fromNetwork - The network to send tokens from.
+ */
 interface BridgeReactProps {
     providerPreference: WidgetConnectionProviders;
     fromContractAddress?: string;
     amount?: string;
     fromNetwork?: Network;
 }
+/**
+ * A React functional component that renders the Checkout Bridge Widget.
+ * @param {BridgeReactProps} props - The props for the Bridge Widget component.
+ * @returns {JSX.Element} - The rendered Bridge Widget component.
+ */
 declare function BridgeReact(props: BridgeReactProps): JSX.Element;
+/**
+ * Interface representing the props for the Buy Widget component.
+ * @property {WidgetConnectionProviders} providerPreference - The preferred provider for the Buy Widget (default: {@link WidgetConnectionProviders.METAMASK}).
+ * @property {string} orderId - The ID that identifies the open buy order associated to the assets to buy.
+ */
 interface BuyReactProps {
     providerPreference: WidgetConnectionProviders;
     orderId: string;
 }
+/**
+ * A React functional component that renders the Checkout Buy Widget.
+ * @param {BuyReactProps} props - The props for the Buy Widget component.
+ * @returns {JSX.Element} - The rendered Buy Widget component.
+ */
 declare function BuyReact(props: BuyReactProps): JSX.Element;
-declare function CheckoutWidgets(config?: CheckoutWidgetsConfig): void;
-declare function UpdateConfig(config: CheckoutWidgetsConfig): void;
-declare function SetProvider(tagName: CheckoutWidgetTagNames, provider: Web3Provider | null): void;
+/**
+ * Interface representing the props for the Connect Widget component.
+ * @property {WidgetConnectionProviders} providerPreference - The preferred provider for the Connect Widget (default: {@link WidgetConnectionProviders.METAMASK}).
+ */
 interface ConnectReactProps {
     providerPreference?: WidgetConnectionProviders;
 }
+/**
+ * A React functional component that renders the Checkout Connect Widget.
+ * @param {ConnectReactProps} props - The props for the Connect Widget component.
+ * @returns {JSX.Element} - The rendered Connect Widget component.
+ */
 declare function ConnectReact(props: ConnectReactProps): JSX.Element;
+/**
+ * Interface representing the props for the Swap Widget component.
+ * @property {WidgetConnectionProviders} providerPreference - The preferred provider for the Swap Widget (default: {@link WidgetConnectionProviders.METAMASK}).
+ * @property {string} fromContractAddress - The contract address to swap tokens from.
+ * @property {string} amount - The amount of tokens to send.
+ * @property {Network} toContractAddress - The contract address to swap tokens to.
+ */
 interface SwapReactProps {
     providerPreference: WidgetConnectionProviders;
     fromContractAddress?: string;
     amount?: string;
     toContractAddress?: string;
 }
+/**
+ * A React functional component that renders the Checkout Swap Widget.
+ * @param {SwapReactProps} props - The props for the Swap Widget component.
+ * @returns {JSX.Element} - The rendered Swap Widget component.
+ */
 declare function SwapReact(props: SwapReactProps): JSX.Element;
+/**
+ * Interface representing the props for the Wallet Widget component.
+ * @property {WidgetConnectionProviders} providerPreference - The preferred provider for the Wallet Widget (default: {@link WidgetConnectionProviders.METAMASK}).
+ */
 interface WalletReactProps {
     providerPreference?: WidgetConnectionProviders;
+    isOnRampEnabled?: boolean;
+    isSwapEnabled?: boolean;
+    isBridgeEnabled?: boolean;
 }
+/**
+ * A React functional component that renders the Checkout Wallet Widget.
+ * @param {WalletReactProps} props - The props for the Wallet Widget component.
+ * @returns {JSX.Element} - The rendered Wallet Widget component.
+ */
 declare function WalletReact(props: WalletReactProps): JSX.Element;
+/**
+ * Interface representing the props for the Example Widget component.
+ * @experimental
+ */
 interface ExampleReactProps {
     providerPreference: WidgetConnectionProviders;
     fromContractAddress?: string;
     amount?: string;
     fromNetwork?: Network;
 }
+/**
+ * A React functional component that renders the Checkout Example Widget.
+ * @experimental
+ */
 declare function ExampleReact(props: ExampleReactProps): JSX.Element;
+/**
+ * CheckoutWidgets allows to inject the Checkout Widgets into your application.
+ * @param {CheckoutWidgetsConfig|undefined} config - Checkout Widget global configurations.
+ */
+declare function CheckoutWidgets(config?: CheckoutWidgetsConfig): void;
+/**
+ * UpdateConfig allows to update the configuration of an existing Checkout Widgets instance.
+ * @param {CheckoutWidgetsConfig} config - new Checkout Widget global configurations.
+ */
+declare function UpdateConfig(config: CheckoutWidgetsConfig): void;
+/**
+ * SetProvider allows to set the provider for an existing Checkout Widgets instance.
+ * @param {CheckoutWidgetTagNames} tagName - target Checkout Widget widget.
+ * @param {Web3Provider} provider - the provider to connect to the blockchain network.
+ */
+declare function SetProvider(tagName: CheckoutWidgetTagNames, provider: Web3Provider | null): void;
 
-export { BridgeEvent, BridgeEventType, BridgeFailed, BridgeReact, BridgeReactProps, BridgeSuccess, BuyClose, BuyEvent, BuyEventType, BuyFailed, BuyNotConnected, BuyReact, BuyReactProps, BuySuccess, CheckoutWidgetTagNames, CheckoutWidgets, CheckoutWidgetsConfig, ConnectEvent, ConnectEventType, ConnectReact, ConnectReactProps, ConnectionFailed, ConnectionSuccess, ExampleReact, ExampleReactProps, IMTBLWidgetEvents, ImtblBridgeProps, ImtblBuyProps, ImtblConnectProps, ImtblExampleProps, ImtblInnerWidgetExampleProps, ImtblOuterWidgetExampleProps, ImtblSwapProps, ImtblTransitionExampleProps, ImtblWalletProps, Network, SetProvider, SwapEvent, SwapEventType, SwapFailed, SwapReact, SwapReactProps, SwapSuccess, UpdateConfig, WalletEvent, WalletEventType, WalletNetworkSwitchEvent, WalletReact, WalletReactProps, WidgetConnectionProviders, WidgetTheme };
+export { BridgeEvent, BridgeEventType, BridgeFailed, BridgeReact, BridgeReactProps, BridgeSuccess, BuyClose, BuyEvent, BuyEventType, BuyFailed, BuyNotConnected, BuyReact, BuyReactProps, BuySuccess, CheckoutWidgetTagNames, CheckoutWidgets, CheckoutWidgetsConfig, ConnectEvent, ConnectEventType, ConnectReact, ConnectReactProps, ConnectionFailed, ConnectionSuccess, ExampleReact, ExampleReactProps, IMTBLWidgetEvents, ImtblBridgeProps, ImtblBuyProps, ImtblConnectProps, ImtblExampleProps, ImtblInnerWidgetExampleProps, ImtblOuterWidgetExampleProps, ImtblSwapProps, ImtblTransitionExampleProps, ImtblWalletProps, Network, OnRampEvent, OnRampEventType, SetProvider, SwapEvent, SwapEventType, SwapFailed, SwapReact, SwapReactProps, SwapSuccess, UpdateConfig, WalletAddCoinsEvent, WalletEvent, WalletEventType, WalletNetworkSwitchEvent, WalletReact, WalletReactProps, WalletRequestBridgeEvent, WalletRequestOnrampEvent, WalletRequestSwapEvent, WidgetConnectionProviders, WidgetTheme };