@dynamic-labs/sdk-react-core 2.0.0-alpha.2 → 2.0.0-alpha.4

package/src/lib/shared/types/index.d.ts

@@ -1,220 +1,8 @@
-import React from 'react';
-import type { EvmRpcProvider, SolanaRpcProvider } from '@dynamic-labs/rpc-providers';
-import type { FetchPublicAddressOpts, WalletConnector } from '@dynamic-labs/wallet-connector-core';
-import { WalletProviderEnum, ProjectSettings, UserFields, NameServiceData, JwtVerifiedCredential, OauthProviderRequest, WalletAdditionalAddress } from '@dynamic-labs/sdk-api';
-import { NetworkConfigurationMap } from '@dynamic-labs/types';
-export type BrowserName = 'brave' | 'chrome' | 'edge' | 'firefox' | 'safari';
-export type Wallet = {
-    address: string;
-    chain: string;
-    /**
-     * If we are currently able to fetch information about this wallet from its provider.
-     * Will be false, for example, if you are connected through a browser extension and you lock it.
-     */
-    connected: boolean;
-    connector: WalletConnector;
-    id: string;
-    network?: string | number;
-    /**
-     * If there is a current user, this will be true if and only if the user has signed this wallet
-     * to link it to their account
-     */
-    authenticated: boolean;
-    /**
-     * Additional addresses associated to the wallet
-     * like ordinals and payment addresses for bitcoin wallets
-     */
-    additionalAddresses?: WalletAdditionalAddress[];
-};
-export type WalletAction = 'select' | 'unlink';
-export type WalletWithAction = {
-    action: WalletAction;
-    wallet: Wallet;
-};
-export type UserProfile = UserFields & {
-    chain?: string;
-    ens?: NameServiceData;
-    environmentId?: string;
-    isAuthenticatedWithAWallet: boolean;
-    lastVerifiedCredentialId: string | undefined;
-    lists?: string[];
-    newUser?: boolean;
-    sessionId: string;
-    userId?: string;
-    verifiedCredentials: JwtVerifiedCredential[];
-    wallet?: string;
-    scope?: string;
-};
-export type Icon = React.FunctionComponent<React.SVGProps<SVGSVGElement> & {
-    title?: string | undefined;
-}>;
-export type WalletNamesUnion = 'Coinbase Wallet' | 'Coinbase Wallet (Solana)' | 'MetaMask' | 'Phantom' | 'Phantom (EVM)' | 'Phantom (Ledger)' | 'Venly' | 'Rainbow' | 'Solflare' | 'Glow' | 'Slope' | 'Blocto (Flow)' | 'Blocto (EVM)' | 'Blocto (App)' | 'Brave Wallet (EVM)' | 'Brave Wallet (Solana)' | 'Braavos' | 'Argent X' | 'Dapper' | 'Opera Wallet' | 'Injected Wallet' | 'Exodus Wallet (EVM)' | 'Exodus Wallet (Solana)' | 'ZenGo' | 'Lilico';
-export type ChainNamesUnion = 'Solana' | 'Ethereum' | 'Flow' | 'EVM' | 'Algorand' | 'Starknet' | 'Cosmos' | 'Axelar' | 'Osmosis' | 'Bitcoin';
-export interface WalletOption {
-    isInstalledOnBrowser: boolean;
-    key: string;
-    name: string;
-    walletConnector: WalletConnector;
-    group?: string;
-    chainGroup?: string;
-    walletGroup?: string;
-    groupedWallets?: WalletOption[];
-    injectedConfig?: Array<Record<string, unknown>>;
-}
-export type WalletGroupOption = WalletOption & {
-    groupedWallets: WalletOption[];
-};
-export type ErrorWithCode = Error & {
-    code: string;
-};
-export interface CopyKey {
-    copykey?: string;
-}
-export interface ModalProps {
-    onClose: () => void;
-}
-export interface IAdditionalInformation {
-    appLogoUrl?: string;
-    appName?: string;
-    onboardingImageUrl?: string;
-    setWalletConnector: (connector: WalletConnector | null) => void;
-    walletConnector: WalletConnector;
-    wallets: WalletOption[];
-}
-export interface VerifyProps {
-    environmentId: string;
-}
-export interface VerifyCallbackArgs {
-    captchaToken?: string;
-    fetchPublicAddressOpts?: FetchPublicAddressOpts;
-    oauth?: OauthProviderRequest;
-    publicWalletAddress: string;
-    walletConnector: WalletConnector;
-    signedMessageOverride?: string;
-    messageToSignOverride?: string;
-}
-export interface VerifyWalletProps {
-    verifyWallet: ({ walletConnector, fetchPublicAddressOpts, }: VerifyCallbackArgs) => Promise<void>;
-}
-export interface ProjectSettingsProps {
-    projectSettings: ProjectSettings | undefined;
-}
-export type WalletProvider = `${WalletProviderEnum}`;
-export interface VerifyWallet {
-    captchaToken?: string;
-    chain: string | undefined;
-    messageToSign: string;
-    network: string | number | undefined;
-    oauth?: OauthProviderRequest;
-    publicWalletAddress: string;
-    signedMessage: string;
-    skipEmptyAccountCheck?: boolean;
-    walletName: string;
-    walletProvider: WalletProvider;
-    additionalWalletAddresses?: WalletAdditionalAddress[];
-}
-export type OnAuthSuccess = (params: {
-    authToken: string;
-    handleLogOut: () => Promise<void>;
-    isAuthenticated: boolean;
-    primaryWallet: Wallet | null;
-    user: UserProfile;
-    /** @deprecated Use primaryWallet.connector instead */
-    walletConnector: WalletConnector | undefined;
-}) => void;
-export type OnLinkSuccess = (params: {
-    authToken: string;
-    user: UserProfile;
-    wallet: Wallet | undefined;
-    /** @deprecated Use wallet.connector instead */
-    walletConnector: WalletConnector | undefined;
-}) => void;
-export type onConnect = (params: {
-    wallet: Wallet | undefined;
-    /** @deprecated Use wallet.connector instead */
-    walletConnector: WalletConnector | undefined;
-}) => void;
-export type OnDisconnect = (params: {
-    wallet: Wallet | undefined;
-    /** @deprecated Use wallet.connector instead */
-    walletConnector: WalletConnector | undefined;
-}) => void;
-export type OnEmailVerificationSuccess = (email: string) => void;
-export type OnEmailVerificationFailure = (email: string) => void;
-export type OnBeforeConnectSuccessConfirmation = (wallet: Partial<Wallet>) => Promise<boolean>;
-export type OnUserProfileUpdate = (user: UserProfile) => void;
-export type OnEmbeddedWalletCreated = (verifiedCredential: JwtVerifiedCredential | undefined) => void;
-export type MultiWalletWidgetState = 'idle' | 'awaiting_account_switch' | 'awaiting_connection' | 'awaiting_signature' | 'detected_new_wallet';
-export type AccountSwitchState = 'idle' | 'linking_new_wallet' | 'switching_primary' | 'primary_not_connected';
-export type AwaitingSignatureState = 'idle' | 'linking_new_wallet' | 'transferring_wallet';
-export type LocalStorageNonce = {
-    environmentId?: string;
-    expiry: number;
-    value: string | undefined;
-};
-export type LocalStorageNetworks = {
-    configurations: NetworkConfigurationMap;
-    environmentId?: string;
-    expiry: number;
-    version: number;
-};
-export type LocalStorageSettings = {
-    environmentId?: string;
-    expiry: number;
-    settings: ProjectSettings;
-};
-export type ChainToWalletMap = {
-    primary_chain: string;
-    wallets: {
-        algorand?: string;
-        bitcoin?: string;
-        cosmos?: string;
-        evm?: string;
-        flow?: string;
-        solana?: string;
-    };
-};
-export type AuthModeType = 'connect-only' | 'connect-and-sign';
-export type DynamicRPCProviders = {
-    evmDefaultProvider: EvmRpcProvider | undefined;
-    evmProviders: EvmRpcProvider[] | undefined;
-    getEvmRpcProviderByChainId: (chainId: number) => EvmRpcProvider | undefined;
-    solanaDefaultProvider: SolanaRpcProvider | undefined;
-    solanaProviders: SolanaRpcProvider[] | undefined;
-};
-export type DynamicEventsCallbacks = {
-    onSignedMessage?: (params: {
-        messageToSign: string;
-        signedMessage: string;
-    }) => void;
-    /** Called when the auth modal is closed before reaching success (due to user cancel or fail) */
-    onAuthFlowCancel?: () => void;
-    /** Called whenever the auth modal is closed */
-    onAuthFlowClose?: () => void;
-    onAuthFlowOpen?: () => void;
-    onAuthSuccess?: OnAuthSuccess;
-    onConnect?: onConnect;
-    onDisconnect?: OnDisconnect;
-    onEmailVerificationSuccess?: OnEmailVerificationSuccess;
-    onEmailVerificationFailure?: OnEmailVerificationFailure;
-    onBeforeConnectSuccessConfirmation?: OnBeforeConnectSuccessConfirmation;
-    onLinkSuccess?: OnLinkSuccess;
-    onLogout?: (user: UserProfile | undefined) => void;
-    onUnlinkSuccess?: (unlinkedWallet: JwtVerifiedCredential) => void;
-    onUserProfileUpdate?: (user: UserProfile) => void;
-    onEmbeddedWalletCreated?: OnEmbeddedWalletCreated;
-};
-export type AccessDeniedCustomButton = {
-    action?: () => void;
-    title: string;
-};
-export type EmbeddedWalletSessionSettings = {
-    emailCode: string;
-    userId: string;
-    createdAt: number;
-};
-export type EmbeddedWalletCurrentAction = 'signMessage' | 'sendTransaction' | 'helpSession' | 'reveal';
-export type RecommendedWallet = {
-    walletKey: string;
-    label?: string;
-};
+export * from './connectionAndSignature';
+export * from './dynamicEventsCallbacks';
+export * from './embeddedWallets';
+export * from './general';
+export * from './localStorage';
+export * from './ui';
+export * from './user';
+export * from './wallets';

package/src/lib/shared/types/localStorage.d.ts

@@ -0,0 +1,18 @@
+import { ProjectSettings } from '@dynamic-labs/sdk-api';
+import { NetworkConfigurationMap } from '@dynamic-labs/types';
+export type LocalStorageNonce = {
+    environmentId?: string;
+    expiry: number;
+    value: string | undefined;
+};
+export type LocalStorageNetworks = {
+    configurations: NetworkConfigurationMap;
+    environmentId?: string;
+    expiry: number;
+    version: number;
+};
+export type LocalStorageSettings = {
+    environmentId?: string;
+    expiry: number;
+    settings: ProjectSettings;
+};

package/src/lib/shared/types/ui.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="react" />
+export type Icon = React.FunctionComponent<React.SVGProps<SVGSVGElement> & {
+    title?: string | undefined;
+}>;
+export interface CopyKey {
+    copykey?: string;
+}
+export interface ModalProps {
+    onClose: () => void;
+}
+export type AccessDeniedCustomButton = {
+    action?: () => void;
+    title: string;
+};

package/src/lib/shared/types/user.d.ts

@@ -0,0 +1,15 @@
+import { JwtVerifiedCredential, NameServiceData, UserFields } from '@dynamic-labs/sdk-api';
+export type UserProfile = UserFields & {
+    chain?: string;
+    ens?: NameServiceData;
+    environmentId?: string;
+    isAuthenticatedWithAWallet: boolean;
+    lastVerifiedCredentialId: string | undefined;
+    lists?: string[];
+    newUser?: boolean;
+    sessionId: string;
+    userId?: string;
+    verifiedCredentials: JwtVerifiedCredential[];
+    wallet?: string;
+    scope?: string;
+};

package/src/lib/shared/types/wallets.d.ts

@@ -0,0 +1,85 @@
+import { EvmRpcProvider } from '@dynamic-labs/rpc-provider-ethereum';
+import { SolanaRpcProvider } from '@dynamic-labs/rpc-provider-solana';
+import { OauthProviderRequest, PasswordSourceTypeEnum, WalletAdditionalAddress, WalletProviderEnum } from '@dynamic-labs/sdk-api';
+import type { WalletConnector } from '@dynamic-labs/wallet-connector-core';
+export type Wallet = {
+    address: string;
+    chain: string;
+    /**
+     * If we are currently able to fetch information about this wallet from its provider.
+     * Will be false, for example, if you are connected through a browser extension and you lock it.
+     */
+    connected: boolean;
+    connector: WalletConnector;
+    id: string;
+    network?: string | number;
+    /**
+     * If there is a current user, this will be true if and only if the user has signed this wallet
+     * to link it to their account
+     */
+    authenticated: boolean;
+    /**
+     * Additional addresses associated to the wallet
+     * like ordinals and payment addresses for bitcoin wallets
+     */
+    additionalAddresses?: WalletAdditionalAddress[];
+};
+export type WalletAction = 'select' | 'unlink';
+export type WalletWithAction = {
+    action: WalletAction;
+    wallet: Wallet;
+};
+/** Defines the options that show in our log in wallet lists */
+export interface WalletOption {
+    isInstalledOnBrowser: boolean;
+    key: string;
+    name: string;
+    walletConnector: WalletConnector;
+    group?: string;
+    chainGroup?: string;
+    walletGroup?: string;
+    groupedWallets?: WalletOption[];
+    injectedConfig?: Array<Record<string, unknown>>;
+}
+export type WalletGroupOption = WalletOption & {
+    groupedWallets: WalletOption[];
+};
+export type WalletProvider = `${WalletProviderEnum}`;
+export interface VerifyWallet {
+    captchaToken?: string;
+    chain: string | undefined;
+    messageToSign: string;
+    network: string | number | undefined;
+    oauth?: OauthProviderRequest;
+    publicWalletAddress: string;
+    signedMessage: string;
+    skipEmptyAccountCheck?: boolean;
+    walletName: string;
+    walletProvider: WalletProvider;
+    additionalWalletAddresses?: WalletAdditionalAddress[];
+    backup?: string;
+    password?: string;
+    passwordSource?: PasswordSourceTypeEnum;
+}
+export type RecommendedWallet = {
+    walletKey: string;
+    label?: string;
+};
+export type ChainToWalletMap = {
+    primary_chain: string;
+    wallets: {
+        algorand?: string;
+        bitcoin?: string;
+        cosmos?: string;
+        evm?: string;
+        flow?: string;
+        solana?: string;
+    };
+};
+export type DynamicRPCProviders = {
+    evmDefaultProvider: EvmRpcProvider | undefined;
+    evmProviders: EvmRpcProvider[] | undefined;
+    getEvmRpcProviderByChainId: (chainId: number) => EvmRpcProvider | undefined;
+    solanaDefaultProvider: SolanaRpcProvider | undefined;
+    solanaProviders: SolanaRpcProvider[] | undefined;
+};

package/src/lib/shared/utils/functions/formatBigNumber/formatBigNumber.cjs

@@ -3,11 +3,18 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var viem = require('viem');
+var values = require('../../../../utils/constants/values.cjs');
 var ceil = require('../ceil/ceil.cjs');
 var trimEnd = require('../trimEnd/trimEnd.cjs');
 
-const formatBigNumber = (value, precision = 0) => {
-    const formatted = viem.formatEther(value);
+const formatBigNumber = (chain, value, precision = 0) => {
+    let formatted;
+    if (chain !== 'SOL') {
+        formatted = viem.formatEther(value);
+    }
+    else {
+        formatted = String(parseFloat(value.toString()) / values.LAMPORTS_PER_SOL);
+    }
     if (!precision) {
         return formatted;
     }

package/src/lib/shared/utils/functions/formatBigNumber/formatBigNumber.d.ts

@@ -1 +1,2 @@
-export declare const formatBigNumber: (value: bigint, precision?: number) => string;
+import { Chain } from '@dynamic-labs/wallet-connector-core';
+export declare const formatBigNumber: (chain: Chain | undefined, value: bigint, precision?: number) => string;

package/src/lib/shared/utils/functions/formatBigNumber/formatBigNumber.js

@@ -1,9 +1,16 @@
 import { formatEther } from 'viem';
+import { LAMPORTS_PER_SOL } from '../../../../utils/constants/values.js';
 import { ceil } from '../ceil/ceil.js';
 import { trimEnd } from '../trimEnd/trimEnd.js';
 
-const formatBigNumber = (value, precision = 0) => {
-    const formatted = formatEther(value);
+const formatBigNumber = (chain, value, precision = 0) => {
+    let formatted;
+    if (chain !== 'SOL') {
+        formatted = formatEther(value);
+    }
+    else {
+        formatted = String(parseFloat(value.toString()) / LAMPORTS_PER_SOL);
+    }
     if (!precision) {
         return formatted;
     }

package/src/lib/shared/utils/functions/generateRandomPassword/generateRandomPassword.cjs

@@ -0,0 +1,14 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const generateRandomPassword = (length = 20) => {
+    const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*()';
+    let generatedPassword = '';
+    for (let i = 0; i < length; i++) {
+        generatedPassword += characters.charAt(Math.floor(Math.random() * characters.length));
+    }
+    return generatedPassword;
+};
+
+exports.generateRandomPassword = generateRandomPassword;

package/src/lib/shared/utils/functions/generateRandomPassword/generateRandomPassword.d.ts

@@ -0,0 +1 @@
+export declare const generateRandomPassword: (length?: number) => string;

package/src/lib/shared/utils/functions/generateRandomPassword/generateRandomPassword.js

@@ -0,0 +1,10 @@
+const generateRandomPassword = (length = 20) => {
+    const characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*()';
+    let generatedPassword = '';
+    for (let i = 0; i < length; i++) {
+        generatedPassword += characters.charAt(Math.floor(Math.random() * characters.length));
+    }
+    return generatedPassword;
+};
+
+export { generateRandomPassword };

package/src/lib/shared/utils/functions/generateRandomPassword/index.d.ts

@@ -0,0 +1 @@
+export { generateRandomPassword } from './generateRandomPassword';

package/src/lib/shared/utils/functions/index.d.ts

@@ -14,3 +14,5 @@ export * from './formatBigNumber';
 export * from './trimEnd';
 export * from './ceil';
 export * from './providerLabel';
+export * from './validatePassword';
+export * from './generateRandomPassword';

package/src/lib/shared/utils/functions/providerLabel/providerLabel.cjs

@@ -6,6 +6,9 @@ var sdkApi = require('@dynamic-labs/sdk-api');
 var capitalize = require('../capitalize/capitalize.cjs');
 
 const providerLabel = (provider) => {
+    if (!provider) {
+        return undefined;
+    }
     if (provider === sdkApi.SocialSignInProviderEnum.Coinbasesocial) {
         return 'Coinbase';
     }

package/src/lib/shared/utils/functions/providerLabel/providerLabel.d.ts

@@ -1,2 +1,2 @@
 import { SocialSignInProviderEnum } from '@dynamic-labs/sdk-api';
-export declare const providerLabel: (provider: SocialSignInProviderEnum) => string;
+export declare const providerLabel: (provider?: SocialSignInProviderEnum) => string | undefined;

package/src/lib/shared/utils/functions/providerLabel/providerLabel.js

@@ -2,6 +2,9 @@ import { SocialSignInProviderEnum } from '@dynamic-labs/sdk-api';
 import { capitalize } from '../capitalize/capitalize.js';
 
 const providerLabel = (provider) => {
+    if (!provider) {
+        return undefined;
+    }
     if (provider === SocialSignInProviderEnum.Coinbasesocial) {
         return 'Coinbase';
     }

package/src/lib/shared/utils/functions/validatePassword/index.d.ts

@@ -0,0 +1 @@
+export { validatePassword } from './validatePassword';

package/src/lib/shared/utils/functions/validatePassword/validatePassword.cjs

@@ -0,0 +1,59 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const validatePassword = (password) => {
+    const hasProperLength = password.length >= 6;
+    const hasUpperCase = /[A-Z]/.test(password);
+    const hasLowerCase = /[a-z]/.test(password);
+    const hasNumbers = /\d/.test(password);
+    const hasNonalphas = /\W/.test(password);
+    let strength = [
+        hasLowerCase,
+        hasUpperCase,
+        hasNumbers,
+        hasNonalphas,
+        hasProperLength,
+    ].filter(Boolean).length;
+    if (strength >= 3 && password.length >= 12) {
+        strength = 5;
+    }
+    const securityCriteria = [
+        {
+            description: 'Password is atleast 6 characters in length',
+            key: 'hasProperLength',
+            value: hasProperLength,
+        },
+        {
+            description: 'Contains at least one uppercase letter',
+            key: 'hasUpperCase',
+            value: hasUpperCase,
+        },
+        {
+            description: 'Contains at least one lowercase letter',
+            key: 'hasLowerCase',
+            value: hasLowerCase,
+        },
+        {
+            description: 'Contains at least one number',
+            key: 'hasNumbers',
+            value: hasNumbers,
+        },
+        {
+            description: 'Contains at least one non-alphanumeric character',
+            key: 'hasNonalphas',
+            value: hasNonalphas,
+        },
+    ];
+    return {
+        hasLowerCase,
+        hasNonalphas,
+        hasNumbers,
+        hasProperLength,
+        hasUpperCase,
+        securityCriteria,
+        strength,
+    };
+};
+
+exports.validatePassword = validatePassword;

package/src/lib/shared/utils/functions/validatePassword/validatePassword.d.ts

@@ -0,0 +1,13 @@
+export declare const validatePassword: (password: string) => {
+    hasLowerCase: boolean;
+    hasNonalphas: boolean;
+    hasNumbers: boolean;
+    hasProperLength: boolean;
+    hasUpperCase: boolean;
+    securityCriteria: {
+        description: string;
+        key: string;
+        value: boolean;
+    }[];
+    strength: number;
+};

package/src/lib/shared/utils/functions/validatePassword/validatePassword.js

@@ -0,0 +1,55 @@
+const validatePassword = (password) => {
+    const hasProperLength = password.length >= 6;
+    const hasUpperCase = /[A-Z]/.test(password);
+    const hasLowerCase = /[a-z]/.test(password);
+    const hasNumbers = /\d/.test(password);
+    const hasNonalphas = /\W/.test(password);
+    let strength = [
+        hasLowerCase,
+        hasUpperCase,
+        hasNumbers,
+        hasNonalphas,
+        hasProperLength,
+    ].filter(Boolean).length;
+    if (strength >= 3 && password.length >= 12) {
+        strength = 5;
+    }
+    const securityCriteria = [
+        {
+            description: 'Password is atleast 6 characters in length',
+            key: 'hasProperLength',
+            value: hasProperLength,
+        },
+        {
+            description: 'Contains at least one uppercase letter',
+            key: 'hasUpperCase',
+            value: hasUpperCase,
+        },
+        {
+            description: 'Contains at least one lowercase letter',
+            key: 'hasLowerCase',
+            value: hasLowerCase,
+        },
+        {
+            description: 'Contains at least one number',
+            key: 'hasNumbers',
+            value: hasNumbers,
+        },
+        {
+            description: 'Contains at least one non-alphanumeric character',
+            key: 'hasNonalphas',
+            value: hasNonalphas,
+        },
+    ];
+    return {
+        hasLowerCase,
+        hasNonalphas,
+        hasNumbers,
+        hasProperLength,
+        hasUpperCase,
+        securityCriteria,
+        strength,
+    };
+};
+
+export { validatePassword };

package/src/lib/shared/utils/hooks/useThrottle/useThrottle.cjs

@@ -4,6 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var React = require('react');
 
+/* eslint-disable @typescript-eslint/no-explicit-any */
 /**
  * useThrottle hook to throttle a callback function.
  *

package/src/lib/shared/utils/hooks/useThrottle/useThrottle.d.ts

@@ -5,4 +5,4 @@
  * @param delay - The time in milliseconds to wait before the next call.
  * @returns A throttled version of the callback function.
  */
-export declare const useThrottle: <T extends (...args: unknown[]) => void>(callback: T, delay: number) => (...args: Parameters<T>) => void;
+export declare const useThrottle: <T extends (...args: any[]) => void>(callback: T, delay: number) => (...args: Parameters<T>) => void;

package/src/lib/shared/utils/hooks/useThrottle/useThrottle.js

@@ -1,5 +1,6 @@
 import { useRef, useCallback } from 'react';
 
+/* eslint-disable @typescript-eslint/no-explicit-any */
 /**
  * useThrottle hook to throttle a callback function.
  *