@huma-finance/widgets 0.0.35 → 0.0.37

package/dist/index.d.ts

@@ -2,7 +2,24 @@ 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 { BigNumber } from 'ethers';
+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
@@ -111,13 +128,13 @@ type JsonRpcConnectionMap = {
  * @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|JsonRpcProvider|null|undefined} provider Optional EIP-1193 provider or JsonRpc Provider
+ * @property {Eip1193Provider|JsonRpcProviderl} provider EIP-1193 provider or JsonRpc Provider
  */
 type WidgetProps = {
     handleClose?: () => void;
     desiredChainId?: number;
     jsonRpcUrlMap?: JsonRpcConnectionMap;
-    provider?: Provider | JsonRpcProvider | null;
+    provider: Provider | JsonRpcProvider;
 };
 /**
  * Invoice factoring pool borrow widget props
@@ -129,7 +146,7 @@ type InvoiceFactoringBorrowWidgetProps = InvoiceFactoringBorrowProps & WidgetPro
 /**
  * Invoice factoring borrow widget
  *
- * @param {InvoiceFactoringBorrowProps | WidgetProps} props - The invoice factoring pool borrow widget props.
+ * @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;
@@ -143,7 +160,7 @@ type InvoiceFactoringPaymentWidgetProps = InvoiceFactoringPaymentProps & WidgetP
 /**
  * Invoice factoring payment widget
  *
- * @param {InvoiceFactoringPaymentProps | WidgetProps} props - The invoice factoring pool payment widget props.
+ * @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;
@@ -157,7 +174,7 @@ type CreditLineBorrowWidgetProps = CreditLineBorrowProps & WidgetProps;
 /**
  * Credit line borrow widget
  *
- * @param {CreditLineBorrowProps | WidgetProps} props - The credit line pool borrow widget props.
+ * @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;
@@ -171,10 +188,25 @@ type CreditLinePaymentWidgetProps = CreditLinePaymentProps & WidgetProps;
 /**
  * Credit line payment widget
  *
- * @param {CreditLinePaymentProps | WidgetProps} props - The credit line pool payment widget props.
+ * @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
@@ -185,7 +217,7 @@ type LendSupplyWidgetProps = LendSupplyProps & WidgetProps;
 /**
  * Lend supply widget
  *
- * @param {LendSupplyProps | WidgetProps} props - The lend pool supply widget props.
+ * @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;
@@ -199,7 +231,7 @@ type LendWithdrawWidgetProps = LendWithdrawProps & WidgetProps;
 /**
  * Lend withdraw widget
  *
- * @param {LendWithdrawProps | WidgetProps} props The lend pool withdraw widget props
+ * @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;
@@ -211,4 +243,4 @@ declare function LendWithdrawWidget(props: LendWithdrawWidgetProps): _emotion_re
  */
 declare function SuperfluidFactoringWidget(props: WidgetProps): _emotion_react_jsx_runtime.JSX.Element;
 
-export { CreditLineBorrowWidget, CreditLinePaymentWidget, InvoiceFactoringBorrowWidget, InvoiceFactoringPaymentWidget, LendSupplyWidget, LendWithdrawWidget, SuperfluidFactoringWidget };
+export { CreditLineApproveWidget, CreditLineBorrowWidget, CreditLinePaymentWidget, InvoiceFactoringBorrowWidget, InvoiceFactoringPaymentWidget, LendSupplyWidget, LendWithdrawWidget, SuperfluidFactoringWidget };