@imtbl/sdk 0.1.8-alpha.2 → 0.1.9-alpha

package/dist/checkout_widgets.d.ts

@@ -11060,7 +11060,13 @@ declare namespace React {
     type ComponentType<P = {}> = ComponentClass<P> | FunctionComponent<P>;
 
     type JSXElementConstructor<P> =
-        | ((props: P) => ReactElement<any, any> | null)
+        | ((
+              props: P,
+              /**
+               * @deprecated https://legacy.react/ts5.0js.org/docs/legacy-context.html#referencing-context-in-stateless-function-components
+               */
+              deprecatedLegacyContext?: any,
+          ) => ReactElement<any, any> | null)
         | (new (props: P) => Component<any, any>);
 
     interface RefObject<T> {
@@ -11221,6 +11227,10 @@ declare namespace React {
      * @deprecated Use either `ReactNode[]` if you need an array or `Iterable<ReactNode>` if its passed to a host component.
      */
     interface ReactNodeArray extends ReadonlyArray<ReactNode> {}
+    /**
+     * WARNING: Not related to `React.Fragment`.
+     * @deprecated - This type is not relevant when using React. Inline the type instead to make the intent clear.
+     */
     type ReactFragment = Iterable<ReactNode>;
 
     /**
@@ -11233,7 +11243,7 @@ declare namespace React {
         | ReactElement
         | string
         | number
-        | ReactFragment
+        | Iterable<ReactNode>
         | ReactPortal
         | boolean
         | null
@@ -12611,6 +12621,16 @@ declare namespace React {
          */
         'aria-autocomplete'?: 'none' | 'inline' | 'list' | 'both' | undefined;
         /** Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user. */
+        /**
+         * Defines a string value that labels the current element, which is intended to be converted into Braille.
+         * @see aria-label.
+         */
+        'aria-braillelabel'?: string | undefined;
+        /**
+         * Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
+         * @see aria-roledescription.
+         */
+        'aria-brailleroledescription'?: string | undefined;
         'aria-busy'?: Booleanish | undefined;
         /**
          * Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
@@ -12627,6 +12647,11 @@ declare namespace React {
          * @see aria-colcount @see aria-colspan.
          */
         'aria-colindex'?: number | undefined;
+        /**
+         * Defines a human readable text alternative of aria-colindex.
+         * @see aria-rowindextext.
+         */
+        'aria-colindextext'?: string | undefined;
         /**
          * Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
          * @see aria-colindex @see aria-rowspan.
@@ -12644,6 +12669,11 @@ declare namespace React {
          * @see aria-labelledby
          */
         'aria-describedby'?: string | undefined;
+        /**
+         * Defines a string value that describes or annotates the current element.
+         * @see related aria-describedby.
+         */
+        'aria-description'?: string | undefined;
         /**
          * Identifies the element that provides a detailed, extended description for the object.
          * @see aria-describedby.
@@ -12757,6 +12787,11 @@ declare namespace React {
          * @see aria-rowcount @see aria-rowspan.
          */
         'aria-rowindex'?: number | undefined;
+        /**
+         * Defines a human readable text alternative of aria-rowindex.
+         * @see aria-colindextext.
+         */
+        'aria-rowindextext'?: string | undefined;
         /**
          * Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
          * @see aria-rowindex @see aria-colspan.
@@ -13313,6 +13348,7 @@ declare namespace React {
     interface LinkHTMLAttributes<T> extends HTMLAttributes<T> {
         as?: string | undefined;
         crossOrigin?: "anonymous" | "use-credentials" | "" | undefined;
+        fetchpriority?: "high" | "low" | "auto";
         href?: string | undefined;
         hrefLang?: string | undefined;
         integrity?: string | undefined;
@@ -13919,6 +13955,7 @@ declare namespace React {
         ruby: DetailedHTMLFactory<HTMLAttributes<HTMLElement>, HTMLElement>;
         s: DetailedHTMLFactory<HTMLAttributes<HTMLElement>, HTMLElement>;
         samp: DetailedHTMLFactory<HTMLAttributes<HTMLElement>, HTMLElement>;
+        search: DetailedHTMLFactory<HTMLAttributes<HTMLElement>, HTMLElement>;
         slot: DetailedHTMLFactory<SlotHTMLAttributes<HTMLSlotElement>, HTMLSlotElement>;
         script: DetailedHTMLFactory<ScriptHTMLAttributes<HTMLScriptElement>, HTMLScriptElement>;
         section: DetailedHTMLFactory<HTMLAttributes<HTMLElement>, HTMLElement>;
@@ -14274,6 +14311,7 @@ declare global {
             ruby: React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement>;
             s: React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement>;
             samp: React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement>;
+            search: React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement>;
             slot: React.DetailedHTMLProps<React.SlotHTMLAttributes<HTMLSlotElement>, HTMLSlotElement>;
             script: React.DetailedHTMLProps<React.ScriptHTMLAttributes<HTMLScriptElement>, HTMLScriptElement>;
             section: React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement>;
@@ -14948,9 +14986,9 @@ declare enum Environment {
 }
 
 /**
- * Enum representing the list of default supported providers.
+ * Enum representing the avaiable wallet providers to use when creating a provider
  */
-declare enum ConnectionProviders {
+declare enum WalletProviderName {
     METAMASK = "metamask"
 }
 
@@ -14964,10 +15002,10 @@ declare enum BridgeEventType {
 }
 /**
  * Type representing a Bridge Widget event with type SUCCESS
- * @property {number} timestamp - The UNIX timestamp (in milliseconds) when the event occurred.
+ * @property {string} transactionHash - The transactionHash of the bridge transaction
  */
 type BridgeSuccess = {
-    timestamp: number;
+    transactionHash: string;
 };
 /**
  * Type representing a Bridge Widget event with type FAILURE
@@ -14978,42 +15016,6 @@ type BridgeFailed = {
     reason: string;
     timestamp: number;
 };
-/**
- * Enum representing possible Buy Widget event types.
- */
-declare enum BuyEventType {
-    CLOSE_WIDGET = "close-widget",
-    SUCCESS = "success",
-    FAILURE = "failure",
-    NOT_CONNECTED = "not_connected"
-}
-/**
- * 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;
-};
 /**
  * Enum representing possible Connect Widget event types.
  */
@@ -15027,7 +15029,8 @@ declare enum ConnectEventType {
  * @property {ConnectionProviders} providerPreference - The user's preferred connection provider.
  */
 type ConnectionSuccess = {
-    providerPreference: ConnectionProviders;
+    provider: Web3Provider;
+    providerName: WalletProviderName | undefined;
 };
 /**
  * Type representing a Connect Widget event with type FAILURE.
@@ -15076,7 +15079,7 @@ declare enum SwapEventType {
  * @property {number} timestamp - The timestamp of the successful swap.
  */
 type SwapSuccess = {
-    timestamp: number;
+    transactionHash: string;
 };
 /**
  * Type representing a Swap Widget with type FAILURE.
@@ -15112,6 +15115,7 @@ declare enum WalletEventType {
 type WalletNetworkSwitchEvent = {
     network: string;
     chainId: number;
+    provider: Web3Provider;
 };
 type WalletDisconnectWalletEvent = {};
 /**
@@ -15121,17 +15125,15 @@ 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_ONRAMP_WIDGET_EVENT = "imtbl-onramp-widget"
+    IMTBL_BRIDGE_WIDGET_EVENT = "imtbl-bridge-widget"
 }
 /**
  * Represents an event object emitted by any of the widgets.
- * @property {OrchestrationEventType | ConnectEventType | WalletEventType | SwapEventType | BridgeEventType | BuyEventType} type - The type of the event.
+ * @property {OrchestrationEventType | ConnectEventType | WalletEventType | SwapEventType | BridgeEventType} type - The type of the event.
  * @property {T} data - The data contained in the event.
  */
 type WidgetEvent<T> = {
-    type: OrchestrationEventType | ConnectEventType | WalletEventType | SwapEventType | BridgeEventType | BuyEventType;
+    type: OrchestrationEventType | ConnectEventType | WalletEventType | SwapEventType | BridgeEventType;
     data: T;
 };
 declare global {
@@ -15144,11 +15146,6 @@ declare global {
             'imtbl-wallet': ImtblWalletProps;
             'imtbl-swap': ImtblSwapProps;
             'imtbl-bridge': ImtblBridgeProps;
-            'imtbl-buy': ImtblBuyProps;
-            'imtbl-example': ImtblExampleProps;
-            'imtbl-transition-example': ImtblTransitionExampleProps;
-            'imtbl-inner-widget-example': ImtblInnerWidgetExampleProps;
-            'imtbl-outer-widget-example': ImtblOuterWidgetExampleProps;
         }
     }
     interface ImmutableWebComponent {
@@ -15163,7 +15160,7 @@ declare global {
  * @property {string} environment - The environment configuration
  */
 interface ImtblConnectProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
-    providerPreference: string;
+    walletProvider?: string;
     widgetConfig?: string;
 }
 /**
@@ -15173,8 +15170,7 @@ interface ImtblConnectProps extends React.DetailedHTMLProps<React.HTMLAttributes
  * @property {string} environment - The environment configuration
  */
 interface ImtblWalletProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
-    providerPreference: string;
-    useConnectWidget?: string;
+    walletProvider?: string;
     widgetConfig?: string;
 }
 /**
@@ -15187,9 +15183,8 @@ interface ImtblWalletProps extends React.DetailedHTMLProps<React.HTMLAttributes<
  * @property {string} toContractAddress - The contract address of the destination token.
  */
 interface ImtblSwapProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
-    providerPreference: string;
+    walletProvider?: string;
     widgetConfig?: string;
-    useConnectWidget?: string;
     amount: string;
     fromContractAddress: string;
     toContractAddress: string;
@@ -15204,69 +15199,12 @@ interface ImtblSwapProps extends React.DetailedHTMLProps<React.HTMLAttributes<HT
  * @property {string} amount - The amount to bridge.
  */
 interface ImtblBridgeProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
-    providerPreference: string;
+    walletProvider?: string;
     widgetConfig?: string;
     fromContractAddress: string;
     fromNetwork: string;
     amount: string;
 }
-/**
- * Props for the Example Widget component
- * @property {string} providerPreference - The preferred wallet provider to connect to.
- * @property {string} theme - The theme to use.
- * @property {string} environment - The environment configuration
- * @experimental
- */
-interface ImtblExampleProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
-    providerPreference: string;
-    theme: string;
-    environment: string;
-}
-/**
- * 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} environment - The environment configuration
- * @property {string} orderId - The id of the order to buy.
- */
-interface ImtblBuyProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
-    providerPreference: string;
-    widgetConfig?: string;
-    orderId: string;
-}
-/**
- * Props for the TransitionExample Widget component
- * @property {string} providerPreference - The preferred wallet provider to connect to.
- * @property {string} theme - The theme to use.
- * @property {string} environment - The environment configuration
- */
-interface ImtblTransitionExampleProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
-    providerPreference: string;
-    theme: string;
-    environment: string;
-}
-/**
- * Props for the InnerWidgetExample Widget component
- * @property {string} providerPreference - The preferred wallet provider to connect to.
- * @property {string} theme - The theme to use.
- * @property {string} environment - The environment configuration
- */
-interface ImtblInnerWidgetExampleProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
-    providerPreference: string;
-    theme: string;
-    environment: string;
-}
-/**
- * Props for the OuterWidgetExample Widget component
- * @property {string} providerPreference - The preferred wallet provider to connect to.
- * @property {string} theme - The theme to use.
- * @property {string} environment - The environment configuration
- */
-interface ImtblOuterWidgetExampleProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
-    providerPreference: string;
-    theme: string;
-    environment: string;
-}
 /**
  * Enum representing the networks supported by Checkout.
  */
@@ -15293,9 +15231,7 @@ declare enum CheckoutWidgetTagNames {
     CONNECT = "imtbl-connect",
     WALLET = "imtbl-wallet",
     SWAP = "imtbl-swap",
-    BUY = "imtbl-buy",
-    BRIDGE = "imtbl-bridge",
-    EXAMPLE = "imtbl-example"
+    BRIDGE = "imtbl-bridge"
 }
 /**
  * Represents the configuration options for the Checkout Widgets.
@@ -15314,14 +15250,14 @@ type CheckoutWidgetsConfig = {
 };
 /**
  * Interface representing the props for the Bridge Widget component.
- * @property {string} providerPreference - The preferred provider for the Bridge Widget
+ * @property {string} walletProvider - The preferred provider for the Bridge Widget
  * (default: "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: string;
+    walletProvider?: WalletProviderName;
     fromContractAddress?: string;
     amount?: string;
     fromNetwork?: Network;
@@ -15332,29 +15268,13 @@ interface BridgeReactProps {
  * @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 {string} providerPreference - The preferred provider for the Buy Widget
- * (default: "metamask").
- * @property {string} orderId - The ID that identifies the open buy order associated to the assets to buy.
- */
-interface BuyReactProps {
-    providerPreference: string;
-    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;
 /**
  * Interface representing the props for the Connect Widget component.
  * @property {string} providerPreference - The preferred provider for the Connect Widget
  * (default: "metamask").
  */
 interface ConnectReactProps {
-    providerPreference?: string;
+    walletProvider?: string;
 }
 /**
  * A React functional component that renders the Checkout Connect Widget.
@@ -15364,13 +15284,13 @@ interface ConnectReactProps {
 declare function ConnectReact(props: ConnectReactProps): JSX.Element;
 /**
  * Interface representing the props for the Swap Widget component.
- * @property {string} providerPreference - The preferred provider for the Swap Widget (default: "metamask"}).
+ * @property {string} walletProvider - The preferred provider for the Swap Widget (default: "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: string;
+    walletProvider?: WalletProviderName;
     fromContractAddress?: string;
     amount?: string;
     toContractAddress?: string;
@@ -15387,8 +15307,7 @@ declare function SwapReact(props: SwapReactProps): JSX.Element;
  * (default: "metamask").
  */
 interface WalletReactProps {
-    providerPreference?: string;
-    useConnectWidget?: boolean;
+    walletProvider?: WalletProviderName;
 }
 /**
  * A React functional component that renders the Checkout Wallet Widget.
@@ -15396,18 +15315,6 @@ interface WalletReactProps {
  * @returns {JSX.Element} - The rendered Wallet Widget component.
  */
 declare function WalletReact(props: WalletReactProps): JSX$1.Element;
-/**
- * Interface representing the props for the Example Widget component.
- * @experimental
- */
-interface ExampleReactProps extends CheckoutWidgetsConfig {
-    providerPreference: string;
-}
-/**
- * A React functional component that renders the Checkout Example Widget.
- * @experimental
- */
-declare function ExampleReact(props: ExampleReactProps): JSX$1.Element;
 /**
  * CheckoutWidgets allows to inject the Checkout Widgets into your application.
  * @param {CheckoutWidgetsConfig|undefined} config - Checkout Widget global configurations.
@@ -15425,4 +15332,4 @@ declare function UpdateConfig(config: CheckoutWidgetsConfig): void;
  */
 declare function SetProvider(tagName: CheckoutWidgetTagNames, provider: Web3Provider | null): void;
 
-export { BridgeEventType, BridgeFailed, BridgeReact, BridgeReactProps, BridgeSuccess, BuyClose, BuyEventType, BuyFailed, BuyNotConnected, BuyReact, BuyReactProps, BuySuccess, CheckoutWidgetTagNames, CheckoutWidgets, CheckoutWidgetsConfig, ConnectEventType, ConnectReact, ConnectReactProps, ConnectionFailed, ConnectionSuccess, ExampleReact, ExampleReactProps, IMTBLWidgetEvents, ImtblBridgeProps, ImtblBuyProps, ImtblConnectProps, ImtblExampleProps, ImtblInnerWidgetExampleProps, ImtblOuterWidgetExampleProps, ImtblSwapProps, ImtblTransitionExampleProps, ImtblWalletProps, Network, OrchestrationEventType, RequestBridgeEvent, RequestConnectEvent, RequestOnrampEvent, RequestSwapEvent, RequestWalletEvent, SetProvider, SwapEventType, SwapFailed, SwapReact, SwapReactProps, SwapRejected, SwapSuccess, UpdateConfig, WalletDisconnectWalletEvent, WalletEventType, WalletNetworkSwitchEvent, WalletReact, WalletReactProps, WidgetEvent, WidgetTheme };
+export { BridgeEventType, BridgeFailed, BridgeReact, BridgeReactProps, BridgeSuccess, CheckoutWidgetTagNames, CheckoutWidgets, CheckoutWidgetsConfig, ConnectEventType, ConnectReact, ConnectReactProps, ConnectionFailed, ConnectionSuccess, IMTBLWidgetEvents, ImtblBridgeProps, ImtblConnectProps, ImtblSwapProps, ImtblWalletProps, Network, OrchestrationEventType, RequestBridgeEvent, RequestConnectEvent, RequestOnrampEvent, RequestSwapEvent, RequestWalletEvent, SetProvider, SwapEventType, SwapFailed, SwapReact, SwapReactProps, SwapRejected, SwapSuccess, UpdateConfig, WalletDisconnectWalletEvent, WalletEventType, WalletNetworkSwitchEvent, WalletReact, WalletReactProps, WidgetEvent, WidgetTheme };