@imtbl/checkout-sdk 2.0.0-alpha.0

package/dist/types/widgets/definitions/events/onramp.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Enum of possible OnRamp Widget event types.
+ */
+export declare enum OnRampEventType {
+    CLOSE_WIDGET = "close-widget",
+    SUCCESS = "success",
+    FAILURE = "failure",
+    LANGUAGE_CHANGED = "language-changed"
+}
+/**
+ * Represents a successful on-ramp transaction.
+ * @property {string} transactionHash
+ */
+export type OnRampSuccess = {
+    /** The transaction hash of the successful transaction. */
+    transactionHash: string;
+};
+/**
+ * Type representing a On-ramp Widget with type FAILURE.
+ * @property {string} reason
+ * @property {number} timestamp
+ */
+export type OnRampFailed = {
+    /** The reason why the on-ramp failed. */
+    reason: string;
+    /** The timestamp of the failed transaction. */
+    timestamp: number;
+};

package/dist/types/widgets/definitions/events/orchestration.d.ts

@@ -0,0 +1,84 @@
+import { WrappedBrowserProvider } from '../../../types';
+/**
+ * Enum representing different types of orchestration events.
+ */
+export declare enum OrchestrationEventType {
+    REQUEST_CONNECT = "request-connect",
+    REQUEST_WALLET = "request-wallet",
+    REQUEST_SWAP = "request-swap",
+    REQUEST_BRIDGE = "request-bridge",
+    REQUEST_ONRAMP = "request-onramp",
+    REQUEST_ADD_TOKENS = "request-add-tokens",
+    REQUEST_PURCHASE = "request-purchase",
+    REQUEST_GO_BACK = "request-go-back"
+}
+/**
+ * Represents the connect event object when the connect widget is requested.
+ * @property {string} walletProviderName
+ */
+export type RequestConnectEvent = {
+    /** The wallet provider name. */
+    walletProviderName: string;
+};
+/**
+ * Represents the wallet event object when the wallet widget is requested.
+ * @property {string} walletProviderName
+ */
+export type RequestWalletEvent = {
+    /** The wallet provider name. */
+    walletProviderName: string;
+};
+/**
+ * Represents the swap event object when the swap widget is requested.
+ * @property {string} fromTokenAddress
+ * @property {string} toTokenAddress
+ * @property {string} amount
+ */
+export type RequestSwapEvent = {
+    /** The address of the token to swap from. */
+    fromTokenAddress: string;
+    /** The address of the token to swap to. */
+    toTokenAddress: string;
+    /** The amount of from tokens to swap. */
+    amount: string;
+};
+/**
+ * Represents the bridge event object when the bridge widget is requested.
+ * @property {string} tokenAddress
+ * @property {string} amount
+ */
+export type RequestBridgeEvent = {
+    /** The address of the token to bridge. */
+    tokenAddress: string;
+    /** The amount of tokens to bridge. */
+    amount: string;
+};
+/**
+ * Represents the onramp event object when the onramp widget is requested.
+ * @property {string} tokenAddress
+ * @property {string} amount
+ */
+export type RequestOnrampEvent = {
+    /** The address of the token to be used for onramp. */
+    tokenAddress: string;
+    /** The amount of tokens to onramp. */
+    amount: string;
+    /** The connected provider. */
+    provider?: WrappedBrowserProvider;
+};
+/**
+ * Represents the add tokens event object when the add tokens widget is requested.
+ */
+export type RequestAddTokensEvent = {
+    /** Token address of the fund to be added */
+    toTokenAddress?: string;
+    /** Amount of the fund to be added */
+    toAmount?: string;
+    /** Whether to show a back button on the first screen, on click triggers REQUEST_GO_BACK event */
+    showBackButton?: boolean;
+};
+/**
+ * Represents the object provide after go back event is requested
+ */
+export type RequestGoBackEvent = {};
+export type OrchestrationEventData = RequestConnectEvent | RequestWalletEvent | RequestSwapEvent | RequestBridgeEvent | RequestOnrampEvent | RequestGoBackEvent | RequestAddTokensEvent;

package/dist/types/widgets/definitions/events/purchase.d.ts

@@ -0,0 +1,30 @@
+import { EIP6963ProviderInfo, WrappedBrowserProvider } from '../../../types';
+export declare enum PurchaseEventType {
+    CLOSE_WIDGET = "close-widget",
+    CONNECT_SUCCESS = "connect-success",
+    SUCCESS = "success",
+    FAILURE = "failure"
+}
+/**
+ * Represents a successful purchase.
+ */
+export type PurchaseSuccess = {};
+/**
+ * Type representing a purchase failure
+ * @property {string} reason
+ */
+export type PurchaseFailed = {
+    reason: string;
+    timestamp: number;
+};
+/**
+ * Type representing a successful provider connection
+ * @property {WrappedBrowserProvider} provider
+ * @property {EIP6963ProviderInfo} providerInfo
+ * @property {'from' | 'to'} providerType
+ */
+export type PurchaseConnectSuccess = {
+    provider: WrappedBrowserProvider;
+    providerInfo: EIP6963ProviderInfo;
+    providerType: 'from' | 'to';
+};

package/dist/types/widgets/definitions/events/sale.d.ts

@@ -0,0 +1,103 @@
+import { TokenInfo } from '../../../types';
+/**
+ * Enum representing possible Sale Widget event types.
+ */
+export declare enum SaleEventType {
+    CLOSE_WIDGET = "close-widget",
+    SUCCESS = "success",
+    FAILURE = "failure",
+    REJECTED = "rejected",
+    TRANSACTION_SUCCESS = "transaction-success",
+    LANGUAGE_CHANGED = "language-changed",
+    PAYMENT_METHOD = "payment-method",
+    REQUEST_BRIDGE = "request-bridge",
+    REQUEST_ONRAMP = "request-onramp",
+    REQUEST_SWAP = "request-swap",
+    PAYMENT_TOKEN = "payment-token"
+}
+/**
+ * Represents a successful Sale transaction.
+ * @property {Array} transactions -
+ */
+export type SaleSuccess = {
+    /** Chosen payment method */
+    paymentMethod: SalePaymentTypes | undefined;
+    /** The minted items token ids  */
+    tokenIds: string[];
+    /** The executed transactions */
+    transactions: {
+        method: string;
+        hash: string | undefined;
+    }[];
+    /** The order reference id, use it to trace order throughout flow */
+    transactionId: string;
+    [key: string]: unknown;
+};
+/**
+ * Type representing a Sale Widget with type FAILURE.
+ * @property {string} reason
+ * @property {number} timestamp
+ * @property {Array} transactions
+ */
+export type SaleFailed = {
+    /** The reason why sale transaction failed. */
+    reason: string;
+    /** The error object. */
+    error: Record<string, unknown>;
+    /** The timestamp of the failed swap. */
+    timestamp: number;
+    /** Chosen payment method */
+    paymentMethod: SalePaymentTypes | undefined;
+    /** The executed transactions */
+    transactions: {
+        method: string;
+        hash: string | undefined;
+    }[];
+    /** The order reference id, use it to trace order throughout flow */
+    transactionId: string;
+};
+/**
+ * Type representing a Sale Widget with type TRANSACTION_SUCCESS.
+ * @property {Object} transactions
+ */
+export type SaleTransactionSuccess = {
+    paymentMethod: SalePaymentTypes | undefined;
+    /** The executed transactions */
+    transactions: {
+        method: string;
+        hash: string | undefined;
+    }[];
+};
+/**
+ * Type representing a Sale Widget with type PAYMENT_METHOD.
+ * @property {Object} transactions
+ */
+export type SalePaymentMethod = {
+    /** Chosen payment method */
+    paymentMethod: SalePaymentTypes | undefined;
+};
+/**
+ * Type representing a Sale Widget with type PAYMENT_TOKEN.
+ * @property {Object} transactions
+ */
+export type SalePaymentToken = {
+    /** Chosen payment token */
+    settlementType: string;
+    type: string;
+    token: TokenInfo;
+    amount: string;
+    balance: string;
+    fiat: {
+        amount: string;
+        balance: string;
+        symbol: string;
+    };
+};
+/**
+ * Enum representing Sale Widget available payment types.
+ */
+export declare enum SalePaymentTypes {
+    CRYPTO = "crypto",
+    DEBIT = "debit",
+    CREDIT = "credit"
+}

package/dist/types/widgets/definitions/events/swap.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Enum representing possible Swap Widget event types.
+ */
+export declare enum SwapEventType {
+    CLOSE_WIDGET = "close-widget",
+    SUCCESS = "success",
+    FAILURE = "failure",
+    REJECTED = "rejected",
+    LANGUAGE_CHANGED = "language-changed"
+}
+/**
+ * Represents a successful swap transaction.
+ * @property {string} transactionHash
+ */
+export type SwapSuccess = {
+    /** The hash of the successful transaction. */
+    transactionHash: string;
+};
+/**
+ * Type representing a Swap Widget with type FAILURE.
+ * @property {string} reason
+ * @property {number} timestamp
+ */
+export type SwapFailed = {
+    /** The reason why the swap failed. */
+    reason: string;
+    /** The timestamp of the failed swap. */
+    timestamp: number;
+};
+/**
+ * Type representing a Swap Widget with type REJECTED.
+ * @property {string} reason -
+ * @property {number} timestamp -
+ */
+export type SwapRejected = {
+    /** The reason why the swap failed. */
+    reason: string;
+    /** The timestamp of the failed swap. */
+    timestamp: number;
+};

package/dist/types/widgets/definitions/events/wallet.d.ts

@@ -0,0 +1,28 @@
+import { WrappedBrowserProvider } from '../../../types';
+/**
+ * Enum representing possible Wallet Widget event types.
+ */
+export declare enum WalletEventType {
+    CLOSE_WIDGET = "close-widget",
+    NETWORK_SWITCH = "network-switch",
+    DISCONNECT_WALLET = "disconnect-wallet",
+    LANGUAGE_CHANGED = "language-changed"
+}
+/**
+ * Represents an event that is triggered when the user switches the network in their wallet.
+ * @property {string} network
+ * @property {number} chainId
+ * @property {WrappedBrowserProvider} provider
+ */
+export type WalletNetworkSwitch = {
+    /**  The name of the network that the user switched to. */
+    network: string;
+    /**  The chain ID of the network that the user switched to. */
+    chainId: number;
+    /** The Web3 provider object for the switched network. */
+    provider: WrappedBrowserProvider;
+};
+/**
+ * Represents an event that is triggered when a wallet is disconnected.
+ */
+export type WalletDisconnect = {};

package/dist/types/widgets/definitions/events/widgets.d.ts

@@ -0,0 +1,35 @@
+import { WidgetLanguage } from '../configurations';
+import { WrappedBrowserProvider } from '../../../types';
+/**
+ * Enum representing the events emitted by the widgets.
+ */
+export declare enum IMTBLWidgetEvents {
+    IMTBL_WIDGETS_PROVIDER = "imtbl-widgets-provider",
+    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_ONRAMP_WIDGET_EVENT = "imtbl-onramp-widget",
+    IMTBL_SALE_WIDGET_EVENT = "imtbl-sale-widget",
+    IMTBL_COMMERCE_WIDGET_EVENT = "imtbl-commerce-widget",
+    IMTBL_ADD_TOKENS_WIDGET_EVENT = "imtbl-add-tokens-widget",
+    IMTBL_PURCHASE_WIDGET_EVENT = "imtbl-purchase-widget"
+}
+/**
+ * Enum for events raised for about provider objects
+ */
+export declare enum ProviderEventType {
+    PROVIDER_UPDATED = "PROVIDER_UPDATED"
+}
+/**
+ * Payload type for the PROVIDER_UPDATED event
+ */
+export type ProviderUpdated = {
+    provider: WrappedBrowserProvider;
+};
+/**
+ * Payload type for the LANGUAGE_CHANGED event
+ */
+export type LanguageChanged = {
+    language: WidgetLanguage;
+};

package/dist/types/widgets/definitions/global.d.ts

@@ -0,0 +1,73 @@
+import { Checkout } from '../../sdk';
+import { WrappedBrowserProvider } from '../../types';
+import { CheckoutWidgetsConfig, WidgetParameters, IWidgetsFactory, Widget, WidgetProperties, WidgetType, WidgetEventData, IWidgetsFactoryCreate } from './types';
+/**
+ * Declares global interfaces and namespaces for the application.
+ * @global
+ * @namespace ImmutableCheckoutWidgets
+ * */
+declare global {
+    namespace ImmutableCheckoutWidgets {
+        class WidgetsFactory implements IWidgetsFactory {
+            constructor(sdk: Checkout, config: CheckoutWidgetsConfig);
+            create: IWidgetsFactoryCreate;
+            updateProvider(provider: WrappedBrowserProvider): void;
+        }
+        class Connect<T extends WidgetType> implements Widget<T> {
+            constructor(sdk: Checkout, props: WidgetProperties<T>);
+            mount(id: string, params?: WidgetParameters[T]): void;
+            unmount(): void;
+            update(props: WidgetProperties<T>): void;
+            addListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName, callback: (data: WidgetEventData[T][KEventName]) => void): void;
+            removeListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName): void;
+        }
+        class Bridge<T extends WidgetType> implements Widget<T> {
+            constructor(sdk: Checkout, props: WidgetProperties<T>);
+            mount(id: string, params?: WidgetParameters[T]): void;
+            unmount(): void;
+            update(props: WidgetProperties<T>): void;
+            addListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName, callback: (data: WidgetEventData[T][KEventName]) => void): void;
+            removeListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName): void;
+        }
+        class Wallet<T extends WidgetType> implements Widget<T> {
+            constructor(sdk: Checkout, props: WidgetProperties<T>);
+            mount(id: string, params?: WidgetParameters[T]): void;
+            unmount(): void;
+            update(props: WidgetProperties<T>): void;
+            addListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName, callback: (data: WidgetEventData[T][KEventName]) => void): void;
+            removeListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName): void;
+        }
+        class Swap<T extends WidgetType> implements Widget<T> {
+            constructor(sdk: Checkout, props: WidgetProperties<T>);
+            mount(id: string, params?: WidgetParameters[T]): void;
+            unmount(): void;
+            update(props: WidgetProperties<T>): void;
+            addListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName, callback: (data: WidgetEventData[T][KEventName]) => void): void;
+            removeListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName): void;
+        }
+        class OnRamp<T extends WidgetType> implements Widget<T> {
+            constructor(sdk: Checkout, props: WidgetProperties<T>);
+            mount(id: string, params?: WidgetParameters[T]): void;
+            unmount(): void;
+            update(props: WidgetProperties<T>): void;
+            addListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName, callback: (data: WidgetEventData[T][KEventName]) => void): void;
+            removeListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName): void;
+        }
+        class Sale<T extends WidgetType> implements Widget<T> {
+            constructor(sdk: Checkout, props: WidgetProperties<T>);
+            mount(id: string, params?: WidgetParameters[T]): void;
+            unmount(): void;
+            update(props: WidgetProperties<T>): void;
+            addListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName, callback: (data: WidgetEventData[T][KEventName]) => void): void;
+            removeListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName): void;
+        }
+        class Commerce<T extends WidgetType> implements Widget<T> {
+            constructor(sdk: Checkout, props: WidgetProperties<T>);
+            mount(id: string, params?: WidgetParameters[T]): void;
+            unmount(): void;
+            update(props: WidgetProperties<T>): void;
+            addListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName, callback: (data: WidgetEventData[T][KEventName]) => void): void;
+            removeListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName): void;
+        }
+    }
+}

package/dist/types/widgets/definitions/parameters/addTokens.d.ts

@@ -0,0 +1,20 @@
+import { WrappedBrowserProvider } from '../../../types';
+import { WidgetLanguage } from '../configurations';
+export type AddTokensWidgetParams = {
+    /** The language to use for the Add Tokens widget */
+    language?: WidgetLanguage;
+    /** Configure to show on-ramp option */
+    showOnrampOption?: boolean;
+    /** Configure to show swap option */
+    showSwapOption?: boolean;
+    /** Configure to show on bridge option */
+    showBridgeOption?: boolean;
+    /** Token address of the fund to be added */
+    toTokenAddress?: string;
+    /** Amount of the fund to be added */
+    toAmount?: string;
+    /** Whether to show a back button on the first screen, on click triggers REQUEST_GO_BACK event */
+    showBackButton?: boolean;
+    /** The destination wallet provider, when requiring to lock destination of funds */
+    toProvider?: WrappedBrowserProvider;
+};

package/dist/types/widgets/definitions/parameters/bridge.d.ts

@@ -0,0 +1,20 @@
+import { WalletProviderName } from '../../../types';
+import { WidgetLanguage } from '../configurations';
+/**
+ * Bridge Widget parameters
+ * @property {string | undefined} tokenAddress
+ * @property {string | undefined} amount
+ * @property {WalletProviderName | undefined} walletProviderName
+ */
+export type BridgeWidgetParams = {
+    /** The contract address of the token to bridge from, used to populate the bridge form token field */
+    tokenAddress?: string;
+    /** The formatted amount to bridge, used to populate the bridge form amount field */
+    amount?: string;
+    /** The wallet provider name to use for the bridge widget */
+    walletProviderName?: WalletProviderName;
+    /** The language to use for the bridge widget */
+    language?: WidgetLanguage;
+    /** Whether to show a back button on the first screen, on click triggers REQUEST_GO_BACK event */
+    showBackButton?: boolean;
+};

package/dist/types/widgets/definitions/parameters/commerce.d.ts

@@ -0,0 +1,44 @@
+import { WidgetLanguage, WidgetTheme } from '../configurations';
+import { ConnectWidgetParams } from './connect';
+import { BridgeWidgetParams } from './bridge';
+import { WalletWidgetParams } from './wallet';
+import { SwapWidgetParams } from './swap';
+import { OnRampWidgetParams } from './onramp';
+import { SaleWidgetParams } from './sale';
+import { AddTokensWidgetParams } from './addTokens';
+export declare enum CommerceFlowType {
+    CONNECT = "CONNECT",
+    WALLET = "WALLET",
+    SALE = "SALE",
+    SWAP = "SWAP",
+    BRIDGE = "BRIDGE",
+    ONRAMP = "ONRAMP",
+    ADD_TOKENS = "ADD_TOKENS"
+}
+export type CommerceWidgetConnectFlowParams = {
+    flow: CommerceFlowType.CONNECT;
+} & ConnectWidgetParams;
+export type CommerceWidgetWalletFlowParams = {
+    flow: CommerceFlowType.WALLET;
+} & WalletWidgetParams;
+export type CommerceWidgetSwapFlowParams = {
+    flow: CommerceFlowType.SWAP;
+} & SwapWidgetParams;
+export type CommerceWidgetBridgeFlowParams = {
+    flow: CommerceFlowType.BRIDGE;
+} & BridgeWidgetParams;
+export type CommerceWidgetOnRampFlowParams = {
+    flow: CommerceFlowType.ONRAMP;
+} & OnRampWidgetParams;
+export type CommerceWidgetSaleFlowParams = {
+    flow: CommerceFlowType.SALE;
+} & SaleWidgetParams;
+export type CommerceWidgetAddTokensFlowParams = {
+    flow: CommerceFlowType.ADD_TOKENS;
+} & AddTokensWidgetParams;
+export type CommerceWidgetFlowParams = CommerceWidgetConnectFlowParams | CommerceWidgetWalletFlowParams | CommerceWidgetSwapFlowParams | CommerceWidgetBridgeFlowParams | CommerceWidgetOnRampFlowParams | CommerceWidgetSaleFlowParams | CommerceWidgetAddTokensFlowParams;
+export type CommerceWidgetParams = {
+    /** The language to use for the Commerce Widget */
+    language?: WidgetLanguage;
+    theme?: WidgetTheme;
+} & CommerceWidgetFlowParams;

package/dist/types/widgets/definitions/parameters/connect.d.ts

@@ -0,0 +1,16 @@
+import { ChainId, WalletProviderRdns } from '../../../types';
+import { WidgetLanguage } from '../configurations';
+export declare enum ConnectTargetLayer {
+    LAYER1 = "LAYER1",
+    LAYER2 = "LAYER2"
+}
+export type ConnectWidgetParams = {
+    /** The language to use for the connect widget */
+    language?: WidgetLanguage;
+    /** The target chain to connect to as part of the connection process (defaults to Immutable zkEVM / Immutable zkEVM Testnet) */
+    targetChainId?: ChainId;
+    /** The target wallet to establish a connection with */
+    targetWalletRdns?: string | WalletProviderRdns;
+    /** List of wallets rdns to exclude from the connect widget */
+    blocklistWalletRdns?: string[];
+};

package/dist/types/widgets/definitions/parameters/index.d.ts

@@ -0,0 +1,9 @@
+export type { AddTokensWidgetParams } from './addTokens';
+export * from './connect';
+export * from './bridge';
+export * from './wallet';
+export * from './swap';
+export * from './onramp';
+export * from './sale';
+export * from './commerce';
+export * from './purchase';

package/dist/types/widgets/definitions/parameters/onramp.d.ts

@@ -0,0 +1,20 @@
+import { WalletProviderName } from '../../../types';
+import { WidgetLanguage } from '../configurations';
+/**
+ * OnRamp Widget parameters
+ * @property {string | undefined} tokenAddress
+ * @property {string | undefined} amount
+ * @property {WalletProviderName | undefined} walletProviderName
+ */
+export type OnRampWidgetParams = {
+    /** The contract address of the token to onramp */
+    tokenAddress?: string;
+    /** The formatted amount to onramp, used to populate the onramp form amount field */
+    amount?: string;
+    /** The wallet provider name to use for the onramp widget */
+    walletProviderName?: WalletProviderName;
+    /** The language to use for the onramp widget */
+    language?: WidgetLanguage;
+    /** Whether to show a back button on the first screen, on click triggers REQUEST_GO_BACK event */
+    showBackButton?: boolean;
+};

package/dist/types/widgets/definitions/parameters/purchase.d.ts

@@ -0,0 +1,18 @@
+import { WidgetLanguage } from '../configurations';
+export type PurchaseWidgetParams = {
+    /** The language to use for the Purchase widget */
+    language?: WidgetLanguage;
+    /** Environment id from Immutable Hub */
+    environmentId?: string;
+    /** Whether to show a back button on the first screen, on click triggers REQUEST_GO_BACK event */
+    showBackButton?: boolean;
+    /** The list of products to be purchased */
+    items?: PurchaseItem[];
+};
+export type PurchaseItem = {
+    productId: string;
+    qty: number;
+    name: string;
+    image: string;
+    description: string;
+};

package/dist/types/widgets/definitions/parameters/sale.d.ts

@@ -0,0 +1,50 @@
+import { WalletProviderName } from '../../../types';
+import { WidgetLanguage } from '../configurations';
+import { SalePaymentTypes } from '../events/sale';
+/**
+ * Sale Widget parameters
+ * @property {string} amount
+ * @property {string} environmentId
+ * @property {SaleItem[]} items
+ * @property {WalletProviderName | undefined} walletProviderName
+ */
+export type SaleWidgetParams = {
+    /** Environment id from Immutable Hub */
+    environmentId?: string;
+    /** The list of products to be purchased */
+    items?: SaleItem[];
+    /** The name of the NFT collection on sale */
+    collectionName?: string;
+    /** The wallet provider name to default to if no browserProvider is passed */
+    walletProviderName?: WalletProviderName;
+    /** The language to use for the sales widget */
+    language?: WidgetLanguage;
+    /** The disabled payment types */
+    excludePaymentTypes?: SalePaymentTypes[];
+    /** Fiat currencies excluded from on-ramp */
+    excludeFiatCurrencies?: string[];
+    /** Preferred currency, replacing the backend's base currency */
+    preferredCurrency?: string;
+    /** Custom key-value pairs to be passed to the order */
+    customOrderData?: Record<string, unknown>;
+};
+/**
+ * A product to be purchased
+ * @property {string} productId
+ * @property {number} qty
+ * @property {string} name
+ * @property {string} image
+ * @property {string} description
+ */
+export type SaleItem = {
+    /** The id of the product */
+    productId: string;
+    /** The quantity to be purchased */
+    qty: number;
+    /** The name of the item */
+    name: string;
+    /** The image url of the item */
+    image: string;
+    /** The description of the item */
+    description: string;
+};

package/dist/types/widgets/definitions/parameters/swap.d.ts

@@ -0,0 +1,31 @@
+import { WalletProviderName } from '../../../types';
+import { WidgetLanguage } from '../configurations';
+export declare enum SwapDirection {
+    FROM = "FROM",
+    TO = "TO"
+}
+/**
+ * Swap Widget parameters
+ * @property {string | undefined} amount
+ * @property {string | undefined} fromTokenAddress
+ * @property {string | undefined} toTokenAddress
+ * @property {WalletProviderName | undefined} walletProviderName
+ */
+export type SwapWidgetParams = {
+    /** The formatted amount to swap, used to populate the swap from amount field */
+    amount?: string;
+    /** The contract address of the token to swap from */
+    fromTokenAddress?: string;
+    /** The contract address of the token to swap to */
+    toTokenAddress?: string;
+    /** The wallet provider name to use for the swap widget */
+    walletProviderName?: WalletProviderName;
+    /** The language to use for the swap widget */
+    language?: WidgetLanguage;
+    /** Whether the swap widget should display the form or automatically proceed with the swap */
+    autoProceed?: boolean;
+    /** The direction of the swap */
+    direction?: SwapDirection;
+    /** Whether to show a back button on the first screen, on click triggers REQUEST_GO_BACK event */
+    showBackButton?: boolean;
+};