[dapp-kit] fix esm typescript types (#14586)

## Description Describe the changes or additions included in this PR. ## Test Plan How did you test the new or updated feature? --- If your changes are not user-facing and not a breaking change, you can skip the following section. Otherwise, please indicate what changed, and then add to the Release Notes section as highlighted during the release process. ### Type of Change (Check all that apply) - [ ] protocol change - [ ] user-visible impact - [ ] breaking change for a client SDKs - [ ] breaking change for FNs (FN binary must upgrade) - [ ] breaking change for validators or node operators (must upgrade binaries) - [ ] breaking change for on-chain data layout - [ ] necessitate either a data wipe or data migration ### Release notes
iotaledger · Nov 1, 2023 · b359868 · b359868
1 parent 1059576
commit b359868
Show file tree

Hide file tree

Showing 15 changed files with 65 additions and 25 deletions.
diff --git a/.changeset/blue-bulldogs-provide.md b/.changeset/blue-bulldogs-provide.md
@@ -0,0 +1,5 @@
+---
+'@mysten/dapp-kit': minor
+---
+
+Fix how esm types are built
diff --git a/sdk/dapp-kit/src/components/AccountDropdownMenu.tsx b/sdk/dapp-kit/src/components/AccountDropdownMenu.tsx
@@ -35,7 +35,7 @@ export function AccountDropdownMenu({ currentAccount }: AccountDropdownMenuProps
 				<DropdownMenu.Trigger asChild>
 					<Button size="lg" className={styles.connectedAccount}>
 						<Text mono weight="bold">
-							{currentAccount.label ?? domain ?? formatAddress(currentAccount.address)}
+							{currentAccount.label ?? domain?.data ?? formatAddress(currentAccount.address)}
 						</Text>
 						<ChevronIcon />
 					</Button>
@@ -80,7 +80,7 @@ export function AccountDropdownMenuItem({
 			className={clsx(styles.menuItem, styles.switchAccountMenuItem)}
 			onSelect={() => switchAccount({ account })}
 		>
-			<Text mono>{account.label ?? domain ?? formatAddress(account.address)}</Text>
+			<Text mono>{account.label ?? domain?.data ?? formatAddress(account.address)}</Text>
 			{active ? <CheckIcon /> : null}
 		</DropdownMenu.Item>
 	);

diff --git a/sdk/dapp-kit/src/hooks/useResolveSuiNSNames.ts b/sdk/dapp-kit/src/hooks/useResolveSuiNSNames.ts
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import type { ResolvedNameServiceNames } from '@mysten/sui.js/client';
-import type { UseQueryOptions } from '@tanstack/react-query';
+import type { UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
 
 import { useSuiClientQuery } from './useSuiClientQuery.js';
 
@@ -12,7 +12,7 @@ export function useResolveSuiNSName(
 		UseQueryOptions<ResolvedNameServiceNames, Error, string | null, unknown[]>,
 		'queryFn' | 'queryKey'
 	>,
-) {
+): UseQueryResult<ResolvedNameServiceNames, Error> {
 	return useSuiClientQuery(
 		'resolveNameServiceNames',
 		{

diff --git a/sdk/dapp-kit/src/hooks/useSuiClientInfiniteQuery.ts b/sdk/dapp-kit/src/hooks/useSuiClientInfiniteQuery.ts
@@ -2,7 +2,11 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import type { SuiClient } from '@mysten/sui.js/client';
-import type { InfiniteData, UseInfiniteQueryOptions } from '@tanstack/react-query';
+import type {
+	InfiniteData,
+	UseInfiniteQueryOptions,
+	UseInfiniteQueryResult,
+} from '@tanstack/react-query';
 import { useInfiniteQuery } from '@tanstack/react-query';
 
 import type { PartialBy } from '../types/utilityTypes.js';
@@ -59,7 +63,7 @@ export function useSuiClientInfiniteQuery<
 		enabled = !!params,
 		...options
 	}: UseSuiClientInfiniteQueryOptions<T, TData> = {},
-) {
+): UseInfiniteQueryResult<TData, Error> {
 	const suiContext = useSuiClientContext();
 
 	return useInfiniteQuery({

diff --git a/sdk/dapp-kit/src/hooks/useSuiClientMutation.ts b/sdk/dapp-kit/src/hooks/useSuiClientMutation.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import type { UseMutationOptions } from '@tanstack/react-query';
+import type { UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
 import { useMutation } from '@tanstack/react-query';
 
 import { useSuiClientContext } from './useSuiClient.js';
@@ -15,7 +15,7 @@ export type UseSuiClientMutationOptions<T extends keyof SuiRpcMethods> = Omit<
 export function useSuiClientMutation<T extends keyof SuiRpcMethods>(
 	method: T,
 	options: UseSuiClientMutationOptions<T> = {},
-) {
+): UseMutationResult<SuiRpcMethods[T]['result'], Error, SuiRpcMethods[T]['params'], unknown[]> {
 	const suiContext = useSuiClientContext();
 
 	return useMutation({

diff --git a/sdk/dapp-kit/src/hooks/useSuiClientQuery.ts b/sdk/dapp-kit/src/hooks/useSuiClientQuery.ts
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import type { SuiClient } from '@mysten/sui.js/client';
-import type { UseQueryOptions } from '@tanstack/react-query';
+import type { UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
 import { useQuery } from '@tanstack/react-query';
 
 import type { PartialBy } from '../types/utilityTypes.js';
@@ -42,7 +42,7 @@ export function useSuiClientQuery<
 	...args: undefined extends SuiRpcMethods[T]['params']
 		? [method: T, params?: SuiRpcMethods[T]['params'], options?: UseSuiClientQueryOptions<T, TData>]
 		: [method: T, params: SuiRpcMethods[T]['params'], options?: UseSuiClientQueryOptions<T, TData>]
-) {
+): UseQueryResult<SuiRpcMethods[T]['result'], Error> {
 	const [method, params, { queryKey = [], ...options } = {}] = args as [
 		method: T,
 		params?: SuiRpcMethods[T]['params'],

diff --git a/sdk/dapp-kit/src/hooks/wallet/useAccounts.ts b/sdk/dapp-kit/src/hooks/wallet/useAccounts.ts
@@ -1,11 +1,13 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
+import type { WalletAccount } from '@mysten/wallet-standard';
+
 import { useWalletStore } from './useWalletStore.js';
 
 /**
  * Retrieves a list of connected accounts authorized by the dApp.
  */
-export function useAccounts() {
+export function useAccounts(): readonly WalletAccount[] {
 	return useWalletStore((state) => state.accounts);
 }
diff --git a/sdk/dapp-kit/src/hooks/wallet/useConnectWallet.ts b/sdk/dapp-kit/src/hooks/wallet/useConnectWallet.ts
@@ -7,7 +7,7 @@ import type {
 	WalletAccount,
 	WalletWithRequiredFeatures,
 } from '@mysten/wallet-standard';
-import type { UseMutationOptions } from '@tanstack/react-query';
+import type { UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
 import { useMutation } from '@tanstack/react-query';
 
 import { walletMutationKeys } from '../../constants/walletMutationKeys.js';
@@ -34,7 +34,12 @@ type UseConnectWalletMutationOptions = Omit<
 export function useConnectWallet({
 	mutationKey,
 	...mutationOptions
-}: UseConnectWalletMutationOptions = {}) {
+}: UseConnectWalletMutationOptions = {}): UseMutationResult<
+	ConnectWalletResult,
+	Error,
+	ConnectWalletArgs,
+	unknown
+> {
 	const setWalletConnected = useWalletStore((state) => state.setWalletConnected);
 	const setConnectionStatus = useWalletStore((state) => state.setConnectionStatus);
 

diff --git a/sdk/dapp-kit/src/hooks/wallet/useCurrentAccount.ts b/sdk/dapp-kit/src/hooks/wallet/useCurrentAccount.ts
@@ -1,11 +1,13 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
+import type { WalletAccount } from '@mysten/wallet-standard';
+
 import { useWalletStore } from './useWalletStore.js';
 
 /**
  * Retrieves the wallet account that is currently selected, if one exists.
  */
-export function useCurrentAccount() {
+export function useCurrentAccount(): WalletAccount | null {
 	return useWalletStore((state) => state.currentAccount);
 }
diff --git a/sdk/dapp-kit/src/hooks/wallet/useDisconnectWallet.ts b/sdk/dapp-kit/src/hooks/wallet/useDisconnectWallet.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import type { UseMutationOptions } from '@tanstack/react-query';
+import type { UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
 import { useMutation } from '@tanstack/react-query';
 
 import { walletMutationKeys } from '../../constants/walletMutationKeys.js';
@@ -22,7 +22,11 @@ type UseDisconnectWalletMutationOptions = Omit<
 export function useDisconnectWallet({
 	mutationKey,
 	...mutationOptions
-}: UseDisconnectWalletMutationOptions = {}) {
+}: UseDisconnectWalletMutationOptions = {}): UseMutationResult<
+	void,
+	UseDisconnectWalletError,
+	void
+> {
 	const { currentWallet } = useCurrentWallet();
 	const setWalletDisconnected = useWalletStore((state) => state.setWalletDisconnected);
 

diff --git a/sdk/dapp-kit/src/hooks/wallet/useSignAndExecuteTransactionBlock.ts b/sdk/dapp-kit/src/hooks/wallet/useSignAndExecuteTransactionBlock.ts
@@ -5,7 +5,7 @@ import type {
 	SuiSignAndExecuteTransactionBlockInput,
 	SuiSignAndExecuteTransactionBlockOutput,
 } from '@mysten/wallet-standard';
-import type { UseMutationOptions } from '@tanstack/react-query';
+import type { UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
 import { useMutation } from '@tanstack/react-query';
 
 import { walletMutationKeys } from '../../constants/walletMutationKeys.js';
@@ -51,7 +51,11 @@ export function useSignAndExecuteTransactionBlock({
 	mutationKey,
 	executeFromWallet,
 	...mutationOptions
-}: UseSignAndExecuteTransactionBlockMutationOptions = {}) {
+}: UseSignAndExecuteTransactionBlockMutationOptions = {}): UseMutationResult<
+	UseSignAndExecuteTransactionBlockResult,
+	UseSignAndExecuteTransactionBlockError,
+	UseSignAndExecuteTransactionBlockArgs
+> {
 	const { currentWallet } = useCurrentWallet();
 	const currentAccount = useCurrentAccount();
 	const client = useSuiClient();

diff --git a/sdk/dapp-kit/src/hooks/wallet/useSignPersonalMessage.ts b/sdk/dapp-kit/src/hooks/wallet/useSignPersonalMessage.ts
@@ -5,7 +5,7 @@ import type {
 	SuiSignPersonalMessageInput,
 	SuiSignPersonalMessageOutput,
 } from '@mysten/wallet-standard';
-import type { UseMutationOptions } from '@tanstack/react-query';
+import type { UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
 import { useMutation } from '@tanstack/react-query';
 
 import {
@@ -44,7 +44,11 @@ type UseSignPersonalMessageMutationOptions = Omit<
 export function useSignPersonalMessage({
 	mutationKey,
 	...mutationOptions
-}: UseSignPersonalMessageMutationOptions = {}) {
+}: UseSignPersonalMessageMutationOptions = {}): UseMutationResult<
+	UseSignPersonalMessageResult,
+	UseSignPersonalMessageError,
+	UseSignPersonalMessageArgs
+> {
 	const { currentWallet } = useCurrentWallet();
 	const currentAccount = useCurrentAccount();
 

diff --git a/sdk/dapp-kit/src/hooks/wallet/useSignTransactionBlock.ts b/sdk/dapp-kit/src/hooks/wallet/useSignTransactionBlock.ts
@@ -5,7 +5,7 @@ import type {
 	SuiSignTransactionBlockInput,
 	SuiSignTransactionBlockOutput,
 } from '@mysten/wallet-standard';
-import type { UseMutationOptions } from '@tanstack/react-query';
+import type { UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
 import { useMutation } from '@tanstack/react-query';
 
 import {
@@ -44,7 +44,11 @@ type UseSignTransactionBlockMutationOptions = Omit<
 export function useSignTransactionBlock({
 	mutationKey,
 	...mutationOptions
-}: UseSignTransactionBlockMutationOptions = {}) {
+}: UseSignTransactionBlockMutationOptions = {}): UseMutationResult<
+	UseSignTransactionBlockResult,
+	UseSignTransactionBlockError,
+	UseSignTransactionBlockArgs
+> {
 	const { currentWallet } = useCurrentWallet();
 	const currentAccount = useCurrentAccount();
 

diff --git a/sdk/dapp-kit/src/hooks/wallet/useSwitchAccount.ts b/sdk/dapp-kit/src/hooks/wallet/useSwitchAccount.ts
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import type { WalletAccount } from '@mysten/wallet-standard';
-import type { UseMutationOptions } from '@tanstack/react-query';
+import type { UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
 import { useMutation } from '@tanstack/react-query';
 
 import { walletMutationKeys } from '../../constants/walletMutationKeys.js';
@@ -29,7 +29,11 @@ type UseSwitchAccountMutationOptions = Omit<
 export function useSwitchAccount({
 	mutationKey,
 	...mutationOptions
-}: UseSwitchAccountMutationOptions = {}) {
+}: UseSwitchAccountMutationOptions = {}): UseMutationResult<
+	SwitchAccountResult,
+	UseSwitchAccountError,
+	SwitchAccountArgs
+> {
 	const { currentWallet } = useCurrentWallet();
 	const setAccountSwitched = useWalletStore((state) => state.setAccountSwitched);
 

diff --git a/sdk/dapp-kit/tsconfig.esm.json b/sdk/dapp-kit/tsconfig.esm.json
@@ -1,7 +1,9 @@
 {
 	"extends": "./tsconfig.json",
 	"compilerOptions": {
-		"module": "ESNext",
+		"target": "ESNext",
+		"module": "Node16",
+		"moduleResolution": "Node16",
 		"outDir": "dist/esm"
 	}
 }