@huma-finance/widgets 0.0.39 → 0.0.42-beta.76

package/dist/index.d.ts

@@ -0,0 +1,246 @@
+import * as _emotion_react_jsx_runtime from '@emotion/react/jsx-runtime';
+import { JsonRpcProvider } from '@ethersproject/providers';
+import { Provider } from '@web3-react/types';
+import { POOL_NAME, POOL_TYPE } from '@huma-finance/shared';
+import { BigNumberish, BigNumber } from 'ethers';
+
+/**
+ * Credit line pool approve allowance props
+ * @typedef {Object} CreditLineApproveProps
+ * @property {POOL_NAME} poolName The name of the pool.
+ * @property {POOL_TYPE} poolType The type of the pool.
+ * @property {BigNumberish|undefined} amount The amount to approve.
+ * @property {function():void} handleClose Function to notify to close the widget modal when user clicks the 'x' close button.
+ * @property {function((number|undefined)):void|undefined} handleSuccess Optional function to notify that the credit line pool approve allowance action is successful.
+ */
+type CreditLineApproveProps = {
+    poolName: keyof typeof POOL_NAME;
+    poolType: keyof typeof POOL_TYPE;
+    amount?: BigNumberish;
+    handleClose: () => void;
+    handleSuccess?: (blockNumber?: number) => void;
+};
+
+/**
+ * Credit line pool borrow props
+ * @typedef {Object} CreditLineBorrowProps
+ * @property {POOL_NAME} poolName The name of the pool.
+ * @property {POOL_TYPE} poolType The type of the pool.
+ * @property {function():void} handleClose Function to notify to close the widget modal when user clicks the 'x' close button.
+ * @property {function():void|undefined} handleApprove Optional function to notify when user is approved successfully to borrow again pool.
+ * @property {function((number|undefined)):void|undefined} handleSuccess Optional function to notify that the credit line pool borrow action is successful.
+ */
+interface CreditLineBorrowProps {
+    poolName: keyof typeof POOL_NAME;
+    poolType: keyof typeof POOL_TYPE;
+    handleClose: () => void;
+    handleApprove?: () => void;
+    handleSuccess?: (blockNumber?: number) => void;
+}
+
+/**
+ * Credit line pool payment props
+ * @typedef {Object} CreditLinePaymentProps
+ * @property {POOL_NAME} poolName The name of the pool.
+ * @property {POOL_TYPE} poolType The type of the pool.
+ * @property {function():void} handleClose Function to notify to close the widget modal when user clicks the 'x' close button.
+ * @property {function((number|undefined)):void|undefined} handleSuccess Optional function to notify that the credit line pool payment action is successful.
+ */
+type CreditLinePaymentProps = {
+    poolName: keyof typeof POOL_NAME;
+    poolType: keyof typeof POOL_TYPE;
+    handleClose: () => void;
+    handleSuccess?: (blockNumber?: number) => void;
+};
+
+/**
+ * Invoice factoring pool borrow props
+ * @typedef {Object} InvoiceFactoringBorrowProps
+ * @property {POOL_NAME} poolName The name of the pool.
+ * @property {POOL_TYPE} poolType The type of the pool.
+ * @property {string|BigNumber} tokenId The NFT token id representing invoice.
+ * @property {function():void} handleClose Function to notify to close the widget modal when user clicks the 'x' close button.
+ * @property {function((number|undefined)):void|undefined} handleSuccess Optional function to notify that the invoice pool borrow action is successful.
+ */
+interface InvoiceFactoringBorrowProps {
+    poolName: keyof typeof POOL_NAME;
+    poolType: keyof typeof POOL_TYPE;
+    tokenId: string | BigNumber;
+    handleClose: () => void;
+    handleSuccess?: (blockNumber?: number) => void;
+}
+
+/**
+ * Invoice factoring pool payment props
+ * @typedef {Object} InvoiceFactoringPaymentProps
+ * @property {POOL_NAME} poolName The name of the pool.
+ * @property {POOL_TYPE} poolType The type of the pool.
+ * @property {function():void} handleClose Function to notify to close the widget modal when user clicks the 'x' close button.
+ * @property {function((number|undefined)):void|undefined} handleSuccess Optional function to notify that the invoice pool payment action is successful.
+ */
+type InvoiceFactoringPaymentProps = {
+    poolName: keyof typeof POOL_NAME;
+    poolType: keyof typeof POOL_TYPE;
+    handleClose: () => void;
+    handleSuccess?: (blockNumber?: number) => void;
+};
+
+/**
+ * Lend pool supply props
+ * @typedef {Object} LendSupplyProps
+ * @property {POOL_NAME} poolName The name of the pool.
+ * @property {POOL_TYPE} poolType The type of the pool.
+ * @property {function():void} handleClose Function to notify to close the widget modal when user clicks the 'x' close button.
+ * @property {function((number|undefined)):void|undefined} handleSuccess Optional function to notify that the lending pool supply action is successful.
+ */
+interface LendSupplyProps {
+    poolName: keyof typeof POOL_NAME;
+    poolType: keyof typeof POOL_TYPE;
+    handleClose: () => void;
+    handleSuccess?: (blockNumber?: number) => void;
+}
+
+/**
+ * Lend pool withdraw props
+ * @typedef {Object} LendWithdrawProps
+ * @property {POOL_NAME} poolName The name of the pool.
+ * @property {POOL_TYPE} poolType The type of the pool.
+ * @property {function():void} handleClose Function to notify to close the widget modal when user clicks the 'x' close button.
+ * @property {function((number|undefined)):void|undefined} handleSuccess Optional function to notify that the lending pool withdraw action is successful.
+ */
+type LendWithdrawProps = {
+    poolName: keyof typeof POOL_NAME;
+    poolType: keyof typeof POOL_TYPE;
+    handleClose: () => void;
+    handleSuccess?: (blockNumber?: number) => void;
+};
+
+/**
+ * Mapping of your JSON-RPC connections indexed by chainId
+ * @typedef {Object} JsonRpcConnectionMap
+ * @property {Object.<number, string|Array<string>|JsonRpcProvider|Array<JsonRpcProvider>>} chainId Chain id to map the JSON-RPC URL/URLs or JsonRpcProvider/JsonRpcProviders
+ */
+type JsonRpcConnectionMap = {
+    [chainId: number]: string | string[] | JsonRpcProvider | JsonRpcProvider[];
+};
+/**
+ * Object representing the props passed to web3 provider
+ * @typedef {Object} WidgetProps
+ * @property {desiredChainId|undefined} desiredChainId Optional desired chain id, will trigger the switch network action if different from the current chain id
+ * @property {JsonRpcConnectionMap|undefined} jsonRpcUrlMap Optional mapping of your JSON-RPC connections indexed by chainId
+ * @property {Eip1193Provider|JsonRpcProviderl} provider EIP-1193 provider or JsonRpc Provider
+ */
+type WidgetProps = {
+    handleClose?: () => void;
+    desiredChainId?: number;
+    jsonRpcUrlMap?: JsonRpcConnectionMap;
+    provider: Provider | JsonRpcProvider;
+};
+/**
+ * Invoice factoring pool borrow widget props
+ * @typedef {Object} InvoiceFactoringBorrowWidgetProps
+ * @property {InvoiceFactoringBorrowProps} InvoiceFactoringBorrowProps - Invoice factoring pool borrow props.
+ * @property {WidgetProps} WidgetProps - Widget general props.
+ */
+type InvoiceFactoringBorrowWidgetProps = InvoiceFactoringBorrowProps & WidgetProps;
+/**
+ * Invoice factoring borrow widget
+ *
+ * @param {InvoiceFactoringBorrowWidgetProps} props - The invoice factoring pool borrow widget props.
+ * @returns Invoice factoring pool borrow widget component
+ */
+declare function InvoiceFactoringBorrowWidget(props: InvoiceFactoringBorrowWidgetProps): _emotion_react_jsx_runtime.JSX.Element;
+/**
+ * Invoice factoring pool payment widget props
+ * @typedef {Object} InvoiceFactoringPaymentWidgetProps
+ * @property {InvoiceFactoringPaymentProps} InvoiceFactoringPaymentProps - Invoice factoring pool payment props.
+ * @property {WidgetProps} WidgetProps - Widget general props.
+ */
+type InvoiceFactoringPaymentWidgetProps = InvoiceFactoringPaymentProps & WidgetProps;
+/**
+ * Invoice factoring payment widget
+ *
+ * @param {InvoiceFactoringPaymentWidgetProps} props - The invoice factoring pool payment widget props.
+ * @returns Invoice factoring pool payment widget component
+ */
+declare function InvoiceFactoringPaymentWidget(props: InvoiceFactoringPaymentWidgetProps): _emotion_react_jsx_runtime.JSX.Element;
+/**
+ * Credit line pool borrow widget props
+ * @typedef {Object} CreditLineBorrowWidgetProps
+ * @property {CreditLineBorrowProps} CreditLineBorrowProps - Credit line pool borrow props.
+ * @property {WidgetProps} WidgetProps - Widget general props.
+ */
+type CreditLineBorrowWidgetProps = CreditLineBorrowProps & WidgetProps;
+/**
+ * Credit line borrow widget
+ *
+ * @param {CreditLineBorrowWidgetProps} props - The credit line pool borrow widget props.
+ * @returns Credit line pool borrow widget component
+ */
+declare function CreditLineBorrowWidget(props: CreditLineBorrowWidgetProps): _emotion_react_jsx_runtime.JSX.Element;
+/**
+ * Credit line pool payment widget props
+ * @typedef {Object} CreditLinePaymentWidgetProps
+ * @property {CreditLinePaymentProps} CreditLinePaymentProps - Credit line pool payment props.
+ * @property {WidgetProps} WidgetProps - Widget general props.
+ */
+type CreditLinePaymentWidgetProps = CreditLinePaymentProps & WidgetProps;
+/**
+ * Credit line payment widget
+ *
+ * @param {CreditLinePaymentWidgetProps} props - The credit line pool payment widget props.
+ * @returns Credit line pool payment widget component
+ */
+declare function CreditLinePaymentWidget(props: CreditLinePaymentWidgetProps): _emotion_react_jsx_runtime.JSX.Element;
+/**
+ * Credit line allowance approval widget props
+ * @typedef {Object} CreditLinePaymentWidgetProps
+ * @property {CreditLineApproveProps} CreditLineApproveProps - Credit line allowance approve props.
+ * @property {WidgetProps} WidgetProps - Widget general props.
+ */
+type CreditLineApproveWidgetProps = CreditLineApproveProps & WidgetProps;
+/**
+ * Credit line allowance approve widget to top up a pool's ERC20 token allowance.
+ * To be used when re-enabling autopay and other pool actions that require allowance.
+ *
+ * @param {CreditLineApproveWidgetProps} props - The credit line pool approve widget props.
+ * @returns Credit line pool approve widget component
+ */
+declare function CreditLineApproveWidget(props: CreditLineApproveWidgetProps): _emotion_react_jsx_runtime.JSX.Element;
+/**
+ * Lend pool supply widget props
+ * @typedef {Object} LendSupplyWidgetProps
+ * @property {LendSupplyProps} LendSupplyProps - Lend pool supply props.
+ * @property {WidgetProps} WidgetProps - Widget general props.
+ */
+type LendSupplyWidgetProps = LendSupplyProps & WidgetProps;
+/**
+ * Lend supply widget
+ *
+ * @param {LendSupplyWidgetProps} props - The lend pool supply widget props.
+ * @returns Lend pool supply widget component
+ */
+declare function LendSupplyWidget(props: LendSupplyWidgetProps): _emotion_react_jsx_runtime.JSX.Element;
+/**
+ * Lend pool withdraw widget props
+ * @typedef {Object} LendWithdrawWidgetProps
+ * @property {LendWithdrawProps} LendWithdrawProps - Lend pool withdraw props.
+ * @property {WidgetProps} WidgetProps - Widget general props.
+ */
+type LendWithdrawWidgetProps = LendWithdrawProps & WidgetProps;
+/**
+ * Lend withdraw widget
+ *
+ * @param {LendWithdrawWidgetProps} props The lend pool withdraw widget props
+ * @returns Lend pool withdraw widget component
+ */
+declare function LendWithdrawWidget(props: LendWithdrawWidgetProps): _emotion_react_jsx_runtime.JSX.Element;
+/**
+ * Superfluid factoring widget
+ *
+ * @param {WidgetProps} props - The superfluid factoring widget props.
+ * @returns Superfluid factoring widget component
+ */
+declare function SuperfluidFactoringWidget(props: WidgetProps): _emotion_react_jsx_runtime.JSX.Element;
+
+export { CreditLineApproveWidget, CreditLineBorrowWidget, CreditLinePaymentWidget, InvoiceFactoringBorrowWidget, InvoiceFactoringPaymentWidget, LendSupplyWidget, LendWithdrawWidget, SuperfluidFactoringWidget };