upstream(ts-sdk): Add new router utilities to dapp-kit (#7599)

Porting commit:
MystenLabs/sui@640b757

Author: panteleymonchuk

.changeset/warm-parrots-flow.md

@@ -0,0 +1,5 @@
+---
+'@iota/dapp-kit': patch
+---
+
+Add `getIotaClientQuery` to get the `queryOptions` config for usage with the `QueryClient` outside of React hooks. Added `useIotaClientSuspenseQuery` to support suspense-based data fetching.

sdk/dapp-kit/src/hooks/useIotaClientQuery.ts

@@ -3,8 +3,13 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import type { IotaClient } from '@iota/iota-sdk/client';
-import type { UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
-import { useQuery } from '@tanstack/react-query';
+import type {
+    UndefinedInitialDataOptions,
+    UseQueryOptions,
+    UseQueryResult,
+} from '@tanstack/react-query';
+import { queryOptions, useQuery, useSuspenseQuery } from '@tanstack/react-query';
+import { useMemo } from 'react';
 
 import type { PartialBy } from '../types/utilityTypes.js';
 import { useIotaClientContext } from './useIotaClient.js';
@@ -38,6 +43,34 @@ export type UseIotaClientQueryOptions<T extends keyof IotaRpcMethods, TData> = P
     'queryKey'
 >;
 
+export type GetIotaClientQueryOptions<T extends keyof IotaRpcMethods> = {
+    client: IotaClient;
+    network: string;
+    method: T;
+    options?: PartialBy<
+        Omit<UndefinedInitialDataOptions<IotaRpcMethods[T]['result']>, 'queryFn'>,
+        'queryKey'
+    >;
+} & (undefined extends IotaRpcMethods[T]['params']
+    ? { params?: IotaRpcMethods[T]['params'] }
+    : { params: IotaRpcMethods[T]['params'] });
+
+export function getIotaClientQuery<T extends keyof IotaRpcMethods>({
+    client,
+    network,
+    method,
+    params,
+    options,
+}: GetIotaClientQueryOptions<T>) {
+    return queryOptions<IotaRpcMethods[T]['result']>({
+        ...options,
+        queryKey: [network, method, params],
+        queryFn: async () => {
+            return await client[method](params as never);
+        },
+    });
+}
+
 export function useIotaClientQuery<
     T extends keyof IotaRpcMethods,
     TData = IotaRpcMethods[T]['result'],
@@ -72,3 +105,40 @@ export function useIotaClientQuery<
         },
     });
 }
+
+export function useIotaClientSuspenseQuery<
+    T extends keyof IotaRpcMethods,
+    TData = IotaRpcMethods[T]['result'],
+>(
+    ...args: undefined extends IotaRpcMethods[T]['params']
+        ? [
+              method: T,
+              params?: IotaRpcMethods[T]['params'],
+              options?: UndefinedInitialDataOptions<TData>,
+          ]
+        : [
+              method: T,
+              params: IotaRpcMethods[T]['params'],
+              options?: UndefinedInitialDataOptions<TData>,
+          ]
+) {
+    const [method, params, options = {}] = args as [
+        method: T,
+        params?: IotaRpcMethods[T]['params'],
+        options?: UndefinedInitialDataOptions<TData>,
+    ];
+
+    const iotaContext = useIotaClientContext();
+
+    const query = useMemo(() => {
+        return getIotaClientQuery<T>({
+            client: iotaContext.client,
+            network: iotaContext.network,
+            method,
+            params,
+            options,
+        });
+    }, [iotaContext.network, method, params, options]);
+
+    return useSuspenseQuery(query);
+}