@frak-labs/react-sdk 0.1.0-beta.afa252b0 → 0.1.0-beta.dd44738a

package/dist/hook/helper/useReferralInteraction.d.cts

@@ -0,0 +1,24 @@
+import type { DisplayEmbeddedWalletParamsType } from "@frak-labs/core-sdk";
+import { type ProcessReferralOptions } from "@frak-labs/core-sdk/actions";
+import type { Hex } from "viem";
+/**
+ * Helper hook to automatically submit a referral interaction when detected
+ *
+ * @group hooks
+ *
+ * @param args
+ * @param args.productId - The product id to interact with (if not specified will be recomputed from the current domain)
+ * @param args.modalConfig - The modal configuration to display if the user is not logged in
+ * @param args.options - Some options for the referral interaction
+ *
+ * @returns  The resulting referral state, or a potential error
+ *
+ * @description This function will automatically handle the referral interaction process
+ *
+ * @see {@link @frak-labs/core-sdk!actions.processReferral | `processReferral()`} for more details on the automatic referral handling process
+ */
+export declare function useReferralInteraction({ productId, modalConfig, options, }?: {
+    productId?: Hex;
+    modalConfig?: DisplayEmbeddedWalletParamsType;
+    options?: ProcessReferralOptions;
+}): Error | ("error" | "no-referrer" | "idle" | "processing" | "success" | "no-wallet" | "no-session" | "self-referral");

package/dist/hook/helper/useReferralInteraction.d.ts

@@ -0,0 +1,24 @@
+import type { DisplayEmbeddedWalletParamsType } from "@frak-labs/core-sdk";
+import { type ProcessReferralOptions } from "@frak-labs/core-sdk/actions";
+import type { Hex } from "viem";
+/**
+ * Helper hook to automatically submit a referral interaction when detected
+ *
+ * @group hooks
+ *
+ * @param args
+ * @param args.productId - The product id to interact with (if not specified will be recomputed from the current domain)
+ * @param args.modalConfig - The modal configuration to display if the user is not logged in
+ * @param args.options - Some options for the referral interaction
+ *
+ * @returns  The resulting referral state, or a potential error
+ *
+ * @description This function will automatically handle the referral interaction process
+ *
+ * @see {@link @frak-labs/core-sdk!actions.processReferral | `processReferral()`} for more details on the automatic referral handling process
+ */
+export declare function useReferralInteraction({ productId, modalConfig, options, }?: {
+    productId?: Hex;
+    modalConfig?: DisplayEmbeddedWalletParamsType;
+    options?: ProcessReferralOptions;
+}): Error | ("error" | "no-referrer" | "idle" | "processing" | "success" | "no-wallet" | "no-session" | "self-referral");

package/dist/hook/index.d.cts

@@ -0,0 +1,11 @@
+export { useFrakConfig } from "./useFrakConfig";
+export { useFrakClient } from "./useFrakClient";
+export { useWalletStatus } from "./useWalletStatus";
+export { useSendTransactionAction } from "./useSendTransaction";
+export { useSiweAuthenticate } from "./useSiweAuthenticate";
+export { useReferralInteraction } from "./helper/useReferralInteraction";
+export { useSendInteraction } from "./useSendInteraction";
+export { useDisplayModal } from "./useDisplayModal";
+export { useOpenSso } from "./useOpenSso";
+export { usePrepareSso } from "./usePrepareSso";
+export { useGetProductInformation } from "./useGetProductInformation";

package/dist/hook/index.d.ts

@@ -0,0 +1,11 @@
+export { useFrakConfig } from "./useFrakConfig";
+export { useFrakClient } from "./useFrakClient";
+export { useWalletStatus } from "./useWalletStatus";
+export { useSendTransactionAction } from "./useSendTransaction";
+export { useSiweAuthenticate } from "./useSiweAuthenticate";
+export { useReferralInteraction } from "./helper/useReferralInteraction";
+export { useSendInteraction } from "./useSendInteraction";
+export { useDisplayModal } from "./useDisplayModal";
+export { useOpenSso } from "./useOpenSso";
+export { usePrepareSso } from "./usePrepareSso";
+export { useGetProductInformation } from "./useGetProductInformation";

package/dist/hook/useDisplayModal.d.cts

@@ -0,0 +1,38 @@
+import type { DisplayModalParamsType, ModalRpcStepsResultType, ModalStepTypes } from "@frak-labs/core-sdk";
+import { type FrakRpcError } from "@frak-labs/frame-connector";
+import { type UseMutationOptions } from "@tanstack/react-query";
+/** @ignore */
+type MutationOptions<T extends ModalStepTypes[]> = Omit<UseMutationOptions<ModalRpcStepsResultType<T>, FrakRpcError, DisplayModalParamsType<T>>, "mutationFn" | "mutationKey">;
+/** @inline */
+interface UseDisplayModalParams<T extends ModalStepTypes[] = ModalStepTypes[]> {
+    /**
+     * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
+     */
+    mutations?: MutationOptions<T>;
+}
+/**
+ * Hook that return a mutation helping to display a modal to the user
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.displayModal | `displayModal()`} action
+ *
+ * @param args
+ *
+ * @typeParam T
+ * The modal steps types to display (the result will correspond to the steps types asked in params)
+ * An array of {@link @frak-labs/core-sdk!index.ModalStepTypes | `ModalStepTypes`}
+ * If not provided, it will default to a generic array of `ModalStepTypes`
+ *
+ * @group hooks
+ *
+ * @returns
+ * The mutation hook wrapping the `displayModal()` action
+ * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!index.DisplayModalParamsType | `DisplayModalParamsType<T>`}, with type params `T` being the modal steps types to display
+ * The `data` result is a {@link @frak-labs/core-sdk!index.ModalRpcStepsResultType | `ModalRpcStepsResultType`}
+ *
+ * @see {@link @frak-labs/core-sdk!actions.displayModal | `displayModal()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
+ */
+export declare function useDisplayModal<T extends ModalStepTypes[] = ModalStepTypes[]>({ mutations, }?: UseDisplayModalParams<T>): import("@tanstack/react-query").UseMutationResult<{ [K in T[number]["key"]]: Extract<T[number], {
+    key: K;
+}>["returns"]; }, FrakRpcError<undefined>, DisplayModalParamsType<T>, unknown>;
+export {};

package/dist/hook/useDisplayModal.d.ts

@@ -0,0 +1,38 @@
+import type { DisplayModalParamsType, ModalRpcStepsResultType, ModalStepTypes } from "@frak-labs/core-sdk";
+import { type FrakRpcError } from "@frak-labs/frame-connector";
+import { type UseMutationOptions } from "@tanstack/react-query";
+/** @ignore */
+type MutationOptions<T extends ModalStepTypes[]> = Omit<UseMutationOptions<ModalRpcStepsResultType<T>, FrakRpcError, DisplayModalParamsType<T>>, "mutationFn" | "mutationKey">;
+/** @inline */
+interface UseDisplayModalParams<T extends ModalStepTypes[] = ModalStepTypes[]> {
+    /**
+     * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
+     */
+    mutations?: MutationOptions<T>;
+}
+/**
+ * Hook that return a mutation helping to display a modal to the user
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.displayModal | `displayModal()`} action
+ *
+ * @param args
+ *
+ * @typeParam T
+ * The modal steps types to display (the result will correspond to the steps types asked in params)
+ * An array of {@link @frak-labs/core-sdk!index.ModalStepTypes | `ModalStepTypes`}
+ * If not provided, it will default to a generic array of `ModalStepTypes`
+ *
+ * @group hooks
+ *
+ * @returns
+ * The mutation hook wrapping the `displayModal()` action
+ * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!index.DisplayModalParamsType | `DisplayModalParamsType<T>`}, with type params `T` being the modal steps types to display
+ * The `data` result is a {@link @frak-labs/core-sdk!index.ModalRpcStepsResultType | `ModalRpcStepsResultType`}
+ *
+ * @see {@link @frak-labs/core-sdk!actions.displayModal | `displayModal()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
+ */
+export declare function useDisplayModal<T extends ModalStepTypes[] = ModalStepTypes[]>({ mutations, }?: UseDisplayModalParams<T>): import("@tanstack/react-query").UseMutationResult<{ [K in T[number]["key"]]: Extract<T[number], {
+    key: K;
+}>["returns"]; }, FrakRpcError<undefined>, DisplayModalParamsType<T>, unknown>;
+export {};

package/dist/hook/useFrakClient.d.cts

@@ -0,0 +1,6 @@
+/**
+ * Get the current Frak client
+ *
+ * @group hooks
+ */
+export declare function useFrakClient(): import("@frak-labs/core-sdk").FrakClient | undefined;

package/dist/hook/useFrakClient.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get the current Frak client
+ *
+ * @group hooks
+ */
+export declare function useFrakClient(): import("@frak-labs/core-sdk").FrakClient | undefined;

package/dist/hook/useFrakConfig.d.cts

@@ -0,0 +1,9 @@
+/**
+ * Get the current Frak config
+ * @throws {FrakRpcError} if the config is not found (only if this hooks is used outside a FrakConfigProvider)
+ * @group hooks
+ *
+ * @see {@link @frak-labs/react-sdk!FrakConfigProvider | FrakConfigProvider} for the config provider
+ * @see {@link @frak-labs/core-sdk!index.FrakWalletSdkConfig | FrakWalletSdkConfig} for the config type
+ */
+export declare function useFrakConfig(): import("@frak-labs/core-sdk").FrakWalletSdkConfig;

package/dist/hook/useFrakConfig.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Get the current Frak config
+ * @throws {FrakRpcError} if the config is not found (only if this hooks is used outside a FrakConfigProvider)
+ * @group hooks
+ *
+ * @see {@link @frak-labs/react-sdk!FrakConfigProvider | FrakConfigProvider} for the config provider
+ * @see {@link @frak-labs/core-sdk!index.FrakWalletSdkConfig | FrakWalletSdkConfig} for the config type
+ */
+export declare function useFrakConfig(): import("@frak-labs/core-sdk").FrakWalletSdkConfig;

package/dist/hook/useGetProductInformation.d.cts

@@ -0,0 +1,30 @@
+import type { GetProductInformationReturnType } from "@frak-labs/core-sdk";
+import { type FrakRpcError } from "@frak-labs/frame-connector";
+import { type UseQueryOptions } from "@tanstack/react-query";
+/** @ignore */
+type QueryOptions = Omit<UseQueryOptions<GetProductInformationReturnType, FrakRpcError, undefined>, "queryKey" | "queryFn">;
+/** @inline */
+interface UseGetProductInformationParams {
+    /**
+     * Optional query options, see {@link @tanstack/react-query!useQuery | `useQuery()`} for more infos
+     */
+    query?: QueryOptions;
+}
+/**
+ * Hook that return a query helping to get the current product information
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.getProductInformation | `getProductInformation()`} action
+ *
+ * @param args
+ *
+ * @group hooks
+ *
+ * @returns
+ * The query hook wrapping the `getProductInformation()` action
+ * The `data` result is a {@link @frak-labs/core-sdk!index.GetProductInformationReturnType | `GetProductInformationReturnType`}
+ *
+ * @see {@link @frak-labs/core-sdk!actions.getProductInformation | `getProductInformation()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useQuery | `useQuery()`} for more info about the useQuery options and response
+ */
+export declare function useGetProductInformation({ query, }?: UseGetProductInformationParams): import("@tanstack/react-query").UseQueryResult<undefined, FrakRpcError<undefined>>;
+export {};

package/dist/hook/useGetProductInformation.d.ts

@@ -0,0 +1,30 @@
+import type { GetProductInformationReturnType } from "@frak-labs/core-sdk";
+import { type FrakRpcError } from "@frak-labs/frame-connector";
+import { type UseQueryOptions } from "@tanstack/react-query";
+/** @ignore */
+type QueryOptions = Omit<UseQueryOptions<GetProductInformationReturnType, FrakRpcError, undefined>, "queryKey" | "queryFn">;
+/** @inline */
+interface UseGetProductInformationParams {
+    /**
+     * Optional query options, see {@link @tanstack/react-query!useQuery | `useQuery()`} for more infos
+     */
+    query?: QueryOptions;
+}
+/**
+ * Hook that return a query helping to get the current product information
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.getProductInformation | `getProductInformation()`} action
+ *
+ * @param args
+ *
+ * @group hooks
+ *
+ * @returns
+ * The query hook wrapping the `getProductInformation()` action
+ * The `data` result is a {@link @frak-labs/core-sdk!index.GetProductInformationReturnType | `GetProductInformationReturnType`}
+ *
+ * @see {@link @frak-labs/core-sdk!actions.getProductInformation | `getProductInformation()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useQuery | `useQuery()`} for more info about the useQuery options and response
+ */
+export declare function useGetProductInformation({ query, }?: UseGetProductInformationParams): import("@tanstack/react-query").UseQueryResult<undefined, FrakRpcError<undefined>>;
+export {};

package/dist/hook/useOpenSso.d.cts

@@ -0,0 +1,33 @@
+import type { OpenSsoParamsType, OpenSsoReturnType } from "@frak-labs/core-sdk";
+import { type FrakRpcError } from "@frak-labs/frame-connector";
+import { type UseMutationOptions } from "@tanstack/react-query";
+/** @ignore */
+type MutationOptions = Omit<UseMutationOptions<OpenSsoReturnType, FrakRpcError, OpenSsoParamsType>, "mutationFn" | "mutationKey">;
+/** @inline */
+interface UseOpenSsoParams {
+    /**
+     * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
+     */
+    mutations?: MutationOptions;
+}
+/**
+ * Hook that return a mutation helping to open the SSO page
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.openSso | `openSso()`} action
+ *
+ * @param args
+ *
+ * @group hooks
+ *
+ * @returns
+ * The mutation hook wrapping the `openSso()` action
+ * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!index.OpenSsoParamsType | `OpenSsoParamsType`}
+ * The mutation doesn't output any value
+ *
+ * @see {@link @frak-labs/core-sdk!actions.openSso | `openSso()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
+ */
+export declare function useOpenSso({ mutations }?: UseOpenSsoParams): import("@tanstack/react-query").UseMutationResult<{
+    wallet?: import("viem").Hex;
+}, FrakRpcError<undefined>, OpenSsoParamsType, unknown>;
+export {};

package/dist/hook/useOpenSso.d.ts

@@ -0,0 +1,33 @@
+import type { OpenSsoParamsType, OpenSsoReturnType } from "@frak-labs/core-sdk";
+import { type FrakRpcError } from "@frak-labs/frame-connector";
+import { type UseMutationOptions } from "@tanstack/react-query";
+/** @ignore */
+type MutationOptions = Omit<UseMutationOptions<OpenSsoReturnType, FrakRpcError, OpenSsoParamsType>, "mutationFn" | "mutationKey">;
+/** @inline */
+interface UseOpenSsoParams {
+    /**
+     * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
+     */
+    mutations?: MutationOptions;
+}
+/**
+ * Hook that return a mutation helping to open the SSO page
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.openSso | `openSso()`} action
+ *
+ * @param args
+ *
+ * @group hooks
+ *
+ * @returns
+ * The mutation hook wrapping the `openSso()` action
+ * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!index.OpenSsoParamsType | `OpenSsoParamsType`}
+ * The mutation doesn't output any value
+ *
+ * @see {@link @frak-labs/core-sdk!actions.openSso | `openSso()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
+ */
+export declare function useOpenSso({ mutations }?: UseOpenSsoParams): import("@tanstack/react-query").UseMutationResult<{
+    wallet?: import("viem").Hex;
+}, FrakRpcError<undefined>, OpenSsoParamsType, unknown>;
+export {};

package/dist/hook/usePrepareSso.d.cts

@@ -0,0 +1,40 @@
+import type { PrepareSsoParamsType } from "@frak-labs/core-sdk";
+/**
+ * Hook that generates SSO URL for popup flow
+ *
+ * This is a **synchronous** hook (no async calls) that generates the SSO URL
+ * client-side without communicating with the wallet iframe.
+ *
+ * @param params - SSO parameters for URL generation
+ *
+ * @group hooks
+ *
+ * @returns
+ * Object containing:
+ * - `ssoUrl`: Generated SSO URL (or undefined if client not ready)
+ * - `isReady`: Boolean indicating if URL is available
+ *
+ * @example
+ * ```tsx
+ * function MyComponent() {
+ *   const { data } = usePrepareSso({
+ *     metadata: { logoUrl: "..." },
+ *     directExit: true
+ *   });
+ *
+ *   const handleClick = () => {
+ *     if (ssoUrl) {
+ *       window.open(data?.ssoUrl, "_blank");
+ *     }
+ *   };
+ *
+ *   return <button onClick={handleClick} disabled={!isReady}>Login</button>;
+ * }
+ * ```
+ *
+ * @see {@link @frak-labs/core-sdk!actions.prepareSso | `prepareSso()`} for the underlying action
+ * @see {@link @frak-labs/core-sdk!actions.openSso | `openSso()`} for the recommended high-level API
+ */
+export declare function usePrepareSso(params: PrepareSsoParamsType): import("@tanstack/react-query").UseQueryResult<{
+    ssoUrl: string;
+}, Error>;

package/dist/hook/usePrepareSso.d.ts

@@ -0,0 +1,40 @@
+import type { PrepareSsoParamsType } from "@frak-labs/core-sdk";
+/**
+ * Hook that generates SSO URL for popup flow
+ *
+ * This is a **synchronous** hook (no async calls) that generates the SSO URL
+ * client-side without communicating with the wallet iframe.
+ *
+ * @param params - SSO parameters for URL generation
+ *
+ * @group hooks
+ *
+ * @returns
+ * Object containing:
+ * - `ssoUrl`: Generated SSO URL (or undefined if client not ready)
+ * - `isReady`: Boolean indicating if URL is available
+ *
+ * @example
+ * ```tsx
+ * function MyComponent() {
+ *   const { data } = usePrepareSso({
+ *     metadata: { logoUrl: "..." },
+ *     directExit: true
+ *   });
+ *
+ *   const handleClick = () => {
+ *     if (ssoUrl) {
+ *       window.open(data?.ssoUrl, "_blank");
+ *     }
+ *   };
+ *
+ *   return <button onClick={handleClick} disabled={!isReady}>Login</button>;
+ * }
+ * ```
+ *
+ * @see {@link @frak-labs/core-sdk!actions.prepareSso | `prepareSso()`} for the underlying action
+ * @see {@link @frak-labs/core-sdk!actions.openSso | `openSso()`} for the recommended high-level API
+ */
+export declare function usePrepareSso(params: PrepareSsoParamsType): import("@tanstack/react-query").UseQueryResult<{
+    ssoUrl: string;
+}, Error>;

package/dist/hook/useSendInteraction.d.cts

@@ -0,0 +1,33 @@
+import type { SendInteractionParamsType, SendInteractionReturnType } from "@frak-labs/core-sdk";
+import { type FrakRpcError } from "@frak-labs/frame-connector";
+import { type UseMutationOptions } from "@tanstack/react-query";
+/** @ignore */
+type MutationOptions = Omit<UseMutationOptions<SendInteractionReturnType, FrakRpcError, SendInteractionParamsType>, "mutationFn" | "mutationKey">;
+/** @inline */
+interface UseSendInteractionParams {
+    /**
+     * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
+     */
+    mutations?: MutationOptions;
+}
+/**
+ * Hook that return a mutation helping to send a user interaction
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.sendInteraction | `sendInteraction()`} action
+ *
+ * @param args
+ *
+ * @group hooks
+ *
+ * @returns
+ * The mutation hook wrapping the `sendInteraction()` action
+ * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!index.SendInteractionParamsType | `SendInteractionParamsType`}
+ * The `data` result is a {@link @frak-labs/core-sdk!index.SendInteractionReturnType | `SendInteractionReturnType`}
+ *
+ * @see {@link @frak-labs/core-sdk!actions.sendInteraction | `sendInteraction()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
+ */
+export declare function useSendInteraction({ mutations, }?: UseSendInteractionParams): import("@tanstack/react-query").UseMutationResult<{
+    delegationId: string;
+}, FrakRpcError<undefined>, SendInteractionParamsType, unknown>;
+export {};

package/dist/hook/useSendInteraction.d.ts

@@ -0,0 +1,33 @@
+import type { SendInteractionParamsType, SendInteractionReturnType } from "@frak-labs/core-sdk";
+import { type FrakRpcError } from "@frak-labs/frame-connector";
+import { type UseMutationOptions } from "@tanstack/react-query";
+/** @ignore */
+type MutationOptions = Omit<UseMutationOptions<SendInteractionReturnType, FrakRpcError, SendInteractionParamsType>, "mutationFn" | "mutationKey">;
+/** @inline */
+interface UseSendInteractionParams {
+    /**
+     * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
+     */
+    mutations?: MutationOptions;
+}
+/**
+ * Hook that return a mutation helping to send a user interaction
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.sendInteraction | `sendInteraction()`} action
+ *
+ * @param args
+ *
+ * @group hooks
+ *
+ * @returns
+ * The mutation hook wrapping the `sendInteraction()` action
+ * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!index.SendInteractionParamsType | `SendInteractionParamsType`}
+ * The `data` result is a {@link @frak-labs/core-sdk!index.SendInteractionReturnType | `SendInteractionReturnType`}
+ *
+ * @see {@link @frak-labs/core-sdk!actions.sendInteraction | `sendInteraction()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
+ */
+export declare function useSendInteraction({ mutations, }?: UseSendInteractionParams): import("@tanstack/react-query").UseMutationResult<{
+    delegationId: string;
+}, FrakRpcError<undefined>, SendInteractionParamsType, unknown>;
+export {};

package/dist/hook/useSendTransaction.d.cts

@@ -0,0 +1,34 @@
+import type { SendTransactionReturnType } from "@frak-labs/core-sdk";
+import { type SendTransactionParams } from "@frak-labs/core-sdk/actions";
+import { type FrakRpcError } from "@frak-labs/frame-connector";
+import { type UseMutationOptions } from "@tanstack/react-query";
+/** @ignore */
+type MutationOptions = Omit<UseMutationOptions<SendTransactionReturnType, FrakRpcError, SendTransactionParams>, "mutationFn" | "mutationKey">;
+/** @inline */
+interface UseSendTransactionParams {
+    /**
+     * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
+     */
+    mutations?: MutationOptions;
+}
+/**
+ * Hook that return a mutation helping to send a transaction
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.sendTransaction | `sendTransaction()`} action
+ *
+ * @param args
+ *
+ * @group hooks
+ *
+ * @returns
+ * The mutation hook wrapping the `sendTransaction()` action
+ * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!actions.SendTransactionParams | `SendTransactionParams`}
+ * The `data` result is a {@link @frak-labs/core-sdk!index.SendTransactionReturnType | `SendTransactionReturnType`}
+ *
+ * @see {@link @frak-labs/core-sdk!actions.sendTransaction | `sendTransaction()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
+ */
+export declare function useSendTransactionAction({ mutations, }?: UseSendTransactionParams): import("@tanstack/react-query").UseMutationResult<{
+    hash: import("viem").Hex;
+}, FrakRpcError<undefined>, SendTransactionParams, unknown>;
+export {};

package/dist/hook/useSendTransaction.d.ts

@@ -0,0 +1,34 @@
+import type { SendTransactionReturnType } from "@frak-labs/core-sdk";
+import { type SendTransactionParams } from "@frak-labs/core-sdk/actions";
+import { type FrakRpcError } from "@frak-labs/frame-connector";
+import { type UseMutationOptions } from "@tanstack/react-query";
+/** @ignore */
+type MutationOptions = Omit<UseMutationOptions<SendTransactionReturnType, FrakRpcError, SendTransactionParams>, "mutationFn" | "mutationKey">;
+/** @inline */
+interface UseSendTransactionParams {
+    /**
+     * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
+     */
+    mutations?: MutationOptions;
+}
+/**
+ * Hook that return a mutation helping to send a transaction
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.sendTransaction | `sendTransaction()`} action
+ *
+ * @param args
+ *
+ * @group hooks
+ *
+ * @returns
+ * The mutation hook wrapping the `sendTransaction()` action
+ * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!actions.SendTransactionParams | `SendTransactionParams`}
+ * The `data` result is a {@link @frak-labs/core-sdk!index.SendTransactionReturnType | `SendTransactionReturnType`}
+ *
+ * @see {@link @frak-labs/core-sdk!actions.sendTransaction | `sendTransaction()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
+ */
+export declare function useSendTransactionAction({ mutations, }?: UseSendTransactionParams): import("@tanstack/react-query").UseMutationResult<{
+    hash: import("viem").Hex;
+}, FrakRpcError<undefined>, SendTransactionParams, unknown>;
+export {};

package/dist/hook/useSiweAuthenticate.d.cts

@@ -0,0 +1,35 @@
+import type { SiweAuthenticateReturnType } from "@frak-labs/core-sdk";
+import { type SiweAuthenticateModalParams } from "@frak-labs/core-sdk/actions";
+import { type FrakRpcError } from "@frak-labs/frame-connector";
+import { type UseMutationOptions } from "@tanstack/react-query";
+/** @inline */
+type MutationOptions = Omit<UseMutationOptions<SiweAuthenticateReturnType, FrakRpcError, SiweAuthenticateModalParams>, "mutationFn" | "mutationKey">;
+/** @ignore */
+interface UseSiweAuthenticateParams {
+    /**
+     * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
+     */
+    mutations?: MutationOptions;
+}
+/**
+ * Hook that return a mutation helping to send perform a SIWE authentication
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.sendTransaction | `sendTransaction()`} action
+ *
+ * @param args
+ *
+ * @group hooks
+ *
+ * @returns
+ * The mutation hook wrapping the `siweAuthenticate()` action
+ * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!actions.SiweAuthenticateModalParams | `SiweAuthenticateModalParams`}
+ * The `data` result is a {@link @frak-labs/core-sdk!index.SiweAuthenticateReturnType | `SiweAuthenticateReturnType`}
+ *
+ * @see {@link @frak-labs/core-sdk!actions.siweAuthenticate | `siweAuthenticate()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
+ */
+export declare function useSiweAuthenticate({ mutations, }?: UseSiweAuthenticateParams): import("@tanstack/react-query").UseMutationResult<{
+    signature: import("viem").Hex;
+    message: string;
+}, FrakRpcError<undefined>, SiweAuthenticateModalParams, unknown>;
+export {};

package/dist/hook/useSiweAuthenticate.d.ts

@@ -0,0 +1,35 @@
+import type { SiweAuthenticateReturnType } from "@frak-labs/core-sdk";
+import { type SiweAuthenticateModalParams } from "@frak-labs/core-sdk/actions";
+import { type FrakRpcError } from "@frak-labs/frame-connector";
+import { type UseMutationOptions } from "@tanstack/react-query";
+/** @inline */
+type MutationOptions = Omit<UseMutationOptions<SiweAuthenticateReturnType, FrakRpcError, SiweAuthenticateModalParams>, "mutationFn" | "mutationKey">;
+/** @ignore */
+interface UseSiweAuthenticateParams {
+    /**
+     * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
+     */
+    mutations?: MutationOptions;
+}
+/**
+ * Hook that return a mutation helping to send perform a SIWE authentication
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.sendTransaction | `sendTransaction()`} action
+ *
+ * @param args
+ *
+ * @group hooks
+ *
+ * @returns
+ * The mutation hook wrapping the `siweAuthenticate()` action
+ * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!actions.SiweAuthenticateModalParams | `SiweAuthenticateModalParams`}
+ * The `data` result is a {@link @frak-labs/core-sdk!index.SiweAuthenticateReturnType | `SiweAuthenticateReturnType`}
+ *
+ * @see {@link @frak-labs/core-sdk!actions.siweAuthenticate | `siweAuthenticate()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
+ */
+export declare function useSiweAuthenticate({ mutations, }?: UseSiweAuthenticateParams): import("@tanstack/react-query").UseMutationResult<{
+    signature: import("viem").Hex;
+    message: string;
+}, FrakRpcError<undefined>, SiweAuthenticateModalParams, unknown>;
+export {};

package/dist/hook/useWalletStatus.d.cts

@@ -0,0 +1,16 @@
+import type { WalletStatusReturnType } from "@frak-labs/core-sdk";
+/**
+ * Hook that return a query helping to get the current wallet status.
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.watchWalletStatus | `watchWalletStatus()`} action
+ *
+ * @group hooks
+ *
+ * @returns
+ * The query hook wrapping the `watchWalletStatus()` action
+ * The `data` result is a {@link @frak-labs/core-sdk!index.WalletStatusReturnType | `WalletStatusReturnType`}
+ *
+ * @see {@link @frak-labs/core-sdk!actions.watchWalletStatus | `watchWalletStatus()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useQuery | `useQuery()`} for more info about the useQuery response
+ */
+export declare function useWalletStatus(): import("@tanstack/react-query").UseQueryResult<WalletStatusReturnType, Error>;