@frak-labs/react-sdk 0.2.1 → 1.0.0-beta.bd7d4823

package/dist/index.cjs

@@ -1 +1 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});let e=require(`@frak-labs/core-sdk/actions`),t=require(`@frak-labs/frame-connector`),n=require(`@tanstack/react-query`),r=require(`react`),i=require(`@frak-labs/core-sdk`);const a=(0,r.createContext)(void 0);function o(e){let{children:t,config:n}=e;return(0,r.createElement)(a.Provider,{value:{...n,walletUrl:n.walletUrl??`https://wallet.frak.id`,domain:n.domain??(typeof window<`u`?window?.location?.host:void 0)??`not-found`}},t)}const s=(0,r.createContext)(void 0);function c({style:e,children:t}){let n=g(),[a,o]=(0,r.useState)(void 0);return(0,r.createElement)(r.Fragment,null,(0,r.createElement)(`iframe`,{...i.baseIframeProps,src:`${n.walletUrl}/listener`,style:e??i.baseIframeProps.style,ref:e=>{!e||a||o((0,i.createIFrameFrakClient)({iframe:e,config:n}))}}),(0,r.createElement)(s.Provider,{value:a},t))}function l(){return(0,r.useContext)(s)}function u(){let i=(0,n.useQueryClient)(),a=l(),o=(0,r.useCallback)(e=>{i.setQueryData([`frak-sdk`,`wallet-status-listener`],e)},[i]);return(0,n.useQuery)({gcTime:0,staleTime:0,queryKey:[`frak-sdk`,`wallet-status-listener`],queryFn:async()=>{if(!a)throw new t.ClientNotFound;return(0,e.watchWalletStatus)(a,o)},enabled:!!a})}function d(){let[e,t]=(0,r.useState)(!1);return(0,r.useEffect)(()=>{t(!0)},[]),e}function f(){let e=d(),[t,n]=(0,r.useState)(e?window.location:void 0);return(0,r.useEffect)(()=>{if(!e)return;function r(){n(window.location)}return t||r(),window.addEventListener(`popstate`,r),()=>{window.removeEventListener(`popstate`,r)}},[e,t]),{location:t,href:(0,r.useMemo)(()=>t?.href,[t?.href])}}function p(){let{location:e}=f();return{frakContext:(0,r.useMemo)(()=>e?.href?i.FrakContextManager.parse({url:e.href}):null,[e?.href]),updateContext:(0,r.useCallback)(t=>{console.log(`Updating context`,{newContext:t}),i.FrakContextManager.replaceUrl({url:e?.href,context:t})},[e?.href])}}function m({options:i}={}){let a=l(),{frakContext:o}=p(),{data:s}=u(),{data:c,error:d,status:f}=(0,n.useQuery)({gcTime:0,staleTime:0,queryKey:[`frak-sdk`,`auto-referral-interaction`,o?.r??`no-referrer`,s?.key??`no-wallet-status`],queryFn:()=>{if(!a)throw new t.ClientNotFound;return(0,e.processReferral)(a,{walletStatus:s,frakContext:o,options:i})},enabled:!!s});return(0,r.useMemo)(()=>f===`pending`?`processing`:f===`error`?d:c||`idle`,[c,f,d])}function h({mutations:r}={}){let i=l();return(0,n.useMutation)({...r,mutationKey:[`frak-sdk`,`display-modal`],mutationFn:async n=>{if(!i)throw new t.ClientNotFound;return(0,e.displayModal)(i,n)}})}function g(){let e=(0,r.useContext)(a);if(!e)throw new t.FrakRpcError(t.RpcErrorCodes.configError,`Frak config not found`);return e}function _({query:r}={}){let i=l();return(0,n.useQuery)({...r,queryKey:[`frak-sdk`,`get-merchant-information`],queryFn:async()=>{if(!i)throw new t.ClientNotFound;return(0,e.getMerchantInformation)(i)}})}function v({mutations:r}={}){let i=l();return(0,n.useMutation)({...r,mutationKey:[`frak-sdk`,`open-sso`],mutationFn:async n=>{if(!i)throw new t.ClientNotFound;return(0,e.openSso)(i,n)}})}function y(r){let i=l();return(0,n.useQuery)({queryKey:[`frak-sdk`,`prepare-sso`,r],queryFn:async()=>{if(!i)throw new t.ClientNotFound;return(0,e.prepareSso)(i,r)}})}function b({mutations:r}={}){let i=l();return(0,n.useMutation)({...r,mutationKey:[`frak-sdk`,`send-transaction`],mutationFn:async n=>{if(!i)throw new t.ClientNotFound;return(0,e.sendTransaction)(i,n)}})}function x({mutations:r}={}){let i=l();return(0,n.useMutation)({...r,mutationKey:[`frak-sdk`,`siwe-authenticate`,i?.config.domain??`no-domain`],mutationFn:async n=>{if(!i)throw new t.ClientNotFound;return(0,e.siweAuthenticate)(i,n)}})}exports.FrakConfigContext=a,exports.FrakConfigProvider=o,exports.FrakIFrameClientContext=s,exports.FrakIFrameClientProvider=c,exports.useDisplayModal=h,exports.useFrakClient=l,exports.useFrakConfig=g,exports.useGetMerchantInformation=_,exports.useOpenSso=v,exports.usePrepareSso=y,exports.useReferralInteraction=m,exports.useSendTransactionAction=b,exports.useSiweAuthenticate=x,exports.useWalletStatus=u;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});let e=require(`@frak-labs/core-sdk/actions`),t=require(`@frak-labs/frame-connector`),n=require(`@tanstack/react-query`),r=require(`react`),i=require(`@frak-labs/core-sdk`);const a=(0,r.createContext)(void 0);function o(e){let{children:t,config:n}=e;return(0,r.createElement)(a.Provider,{value:{...n,walletUrl:n.walletUrl??`https://wallet.frak.id`,domain:n.domain??(typeof window<`u`?window?.location?.host:void 0)??`not-found`}},t)}const s=(0,r.createContext)(void 0);function c({style:e,children:t}){let n=p(),[a,o]=(0,r.useState)(void 0);return(0,r.createElement)(r.Fragment,null,(0,r.createElement)(`iframe`,{...i.baseIframeProps,src:`${n.walletUrl}/listener`,style:e??i.baseIframeProps.style,ref:e=>{!e||a||o((0,i.createIFrameFrakClient)({iframe:e,config:n}))}}),(0,r.createElement)(s.Provider,{value:a},t))}function l(){return(0,r.useContext)(s)}function u({options:i}={}){let a=l(),{data:o,error:s,status:c}=(0,n.useQuery)({queryKey:[`frak-sdk`,`auto-referral-interaction`],queryFn:async()=>{if(!a)throw new t.ClientNotFound;return(0,e.referralInteraction)(a,{options:i})},enabled:!!a,staleTime:1/0});return(0,r.useMemo)(()=>c===`pending`?`processing`:c===`error`?s:o||`idle`,[o,c,s])}function d({mutations:r}={}){let i=l();return(0,n.useMutation)({...r,mutationKey:[`frak-sdk`,`display-modal`],mutationFn:async({placement:n,...r})=>{if(!i)throw new t.ClientNotFound;return(0,e.displayModal)(i,r,n)}})}function f({mutations:r}={}){let i=l();return(0,n.useMutation)({...r,mutationKey:[`frak-sdk`,`display-sharing-page`],mutationFn:async({placement:n,...r})=>{if(!i)throw new t.ClientNotFound;return(0,e.displaySharingPage)(i,r,n)}})}function p(){let e=(0,r.useContext)(a);if(!e)throw new t.FrakRpcError(t.RpcErrorCodes.configError,`Frak config not found`);return e}function m({query:r,cacheTime:i}={}){let a=l();return(0,n.useQuery)({...r,queryKey:[`frak-sdk`,`get-merchant-information`],queryFn:async()=>{if(!a)throw new t.ClientNotFound;return(0,e.getMerchantInformation)(a,{cacheTime:i})}})}function h({query:r,cacheTime:i}={}){let a=l();return(0,n.useQuery)({...r,queryKey:[`frak-sdk`,`get-merge-token`],queryFn:async()=>{if(!a)throw new t.ClientNotFound;return(0,e.getMergeToken)(a,{cacheTime:i})}})}function g({query:r,cacheTime:i}={}){let a=l();return(0,n.useQuery)({...r,queryKey:[`frak-sdk`,`get-user-referral-status`],queryFn:async()=>{if(!a)throw new t.ClientNotFound;return(0,e.getUserReferralStatus)(a,{cacheTime:i})}})}function _({mutations:r}={}){let i=l();return(0,n.useMutation)({...r,mutationKey:[`frak-sdk`,`open-sso`],mutationFn:async n=>{if(!i)throw new t.ClientNotFound;return(0,e.openSso)(i,n)}})}function v(r){let i=l();return(0,n.useQuery)({queryKey:[`frak-sdk`,`prepare-sso`,r],queryFn:async()=>{if(!i)throw new t.ClientNotFound;return(0,e.prepareSso)(i,r)}})}function y({mutations:r}={}){let i=l();return(0,n.useMutation)({...r,mutationKey:[`frak-sdk`,`send-transaction`],mutationFn:async n=>{if(!i)throw new t.ClientNotFound;return(0,e.sendTransaction)(i,n)}})}function b(){let r=l();return(0,n.useQuery)({queryKey:[`frak-sdk`,`setup-referral`],queryFn:async()=>{if(!r)throw new t.ClientNotFound;return await(0,e.setupReferral)(r),null},enabled:!!r,staleTime:1/0})}function x({mutations:r}={}){let i=l();return(0,n.useMutation)({...r,mutationKey:[`frak-sdk`,`siwe-authenticate`,i?.config.domain??`no-domain`],mutationFn:async n=>{if(!i)throw new t.ClientNotFound;return(0,e.siweAuthenticate)(i,n)}})}function S(){let i=(0,n.useQueryClient)(),a=l(),o=(0,r.useCallback)(e=>{i.setQueryData([`frak-sdk`,`wallet-status-listener`],e)},[i]);return(0,n.useQuery)({gcTime:0,staleTime:0,queryKey:[`frak-sdk`,`wallet-status-listener`],queryFn:async()=>{if(!a)throw new t.ClientNotFound;return(0,e.watchWalletStatus)(a,o)},enabled:!!a})}exports.FrakConfigContext=a,exports.FrakConfigProvider=o,exports.FrakIFrameClientContext=s,exports.FrakIFrameClientProvider=c,exports.useDisplayModal=d,exports.useDisplaySharingPage=f,exports.useFrakClient=l,exports.useFrakConfig=p,exports.useGetMerchantInformation=m,exports.useGetMergeToken=h,exports.useGetUserReferralStatus=g,exports.useOpenSso=_,exports.usePrepareSso=v,exports.useReferralInteraction=u,exports.useSendTransactionAction=y,exports.useSetupReferral=b,exports.useSiweAuthenticate=x,exports.useWalletStatus=S;

package/dist/index.d.cts

@@ -1,16 +1,18 @@
 import { ProcessReferralOptions, SendTransactionParams, SiweAuthenticateModalParams } from "@frak-labs/core-sdk/actions";
-import * as _tanstack_react_query0 from "@tanstack/react-query";
+import * as _$_tanstack_react_query0 from "@tanstack/react-query";
 import { UseMutationOptions, UseQueryOptions } from "@tanstack/react-query";
-import * as _frak_labs_core_sdk0 from "@frak-labs/core-sdk";
-import { DisplayModalParamsType, FrakClient, FrakWalletSdkConfig, GetMerchantInformationReturnType, ModalRpcStepsResultType, ModalStepTypes, OpenSsoParamsType, OpenSsoReturnType, PrepareSsoParamsType, SendTransactionReturnType, SiweAuthenticateReturnType, WalletStatusReturnType } from "@frak-labs/core-sdk";
+import * as _$_frak_labs_core_sdk0 from "@frak-labs/core-sdk";
+import { DisplayModalParamsType, DisplaySharingPageParamsType, DisplaySharingPageResultType, FrakClient, FrakWalletSdkConfig, GetMerchantInformationReturnType, ModalRpcStepsResultType, ModalStepTypes, OpenSsoParamsType, OpenSsoReturnType, PrepareSsoParamsType, SendTransactionReturnType, SiweAuthenticateReturnType, UserReferralStatusType, WalletStatusReturnType } from "@frak-labs/core-sdk";
 import { FrakRpcError } from "@frak-labs/frame-connector";
-import * as react from "react";
+import * as _$react from "react";
 import { CSSProperties, PropsWithChildren, ReactNode } from "react";
 
 //#region src/hook/helper/useReferralInteraction.d.ts
 /**
  * Helper hook to automatically submit a referral interaction when detected
  *
+ * Runs once when the Frak client becomes available.
+ *
  * @group hooks
  *
  * @param args
@@ -20,23 +22,25 @@ import { CSSProperties, PropsWithChildren, ReactNode } from "react";
  *
  * @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
+ * @see {@link @frak-labs/core-sdk!actions.referralInteraction | `referralInteraction()`} for more details on the automatic referral handling process
  */
 declare function useReferralInteraction({
   options
 }?: {
   options?: ProcessReferralOptions;
-}): "processing" | Error | "no-referrer" | "idle" | "success" | "self-referral";
+}): Error | "processing" | "idle" | "success" | "no-referrer" | "self-referral";
 //#endregion
 //#region src/hook/useDisplayModal.d.ts
 /** @ignore */
-type MutationOptions$3<T extends ModalStepTypes[]> = Omit<UseMutationOptions<ModalRpcStepsResultType<T>, FrakRpcError, DisplayModalParamsType<T>>, "mutationFn" | "mutationKey">;
+type MutationOptions$4<T extends ModalStepTypes[]> = Omit<UseMutationOptions<ModalRpcStepsResultType<T>, FrakRpcError, DisplayModalParamsType<T> & {
+  placement?: string;
+}>, "mutationFn" | "mutationKey">;
 /** @inline */
 interface UseDisplayModalParams<T extends ModalStepTypes[] = ModalStepTypes[]> {
   /**
    * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
    */
-  mutations?: MutationOptions$3<T>;
+  mutations?: MutationOptions$4<T>;
 }
 /**
  * Hook that return a mutation helping to display a modal to the user
@@ -62,7 +66,44 @@ interface UseDisplayModalParams<T extends ModalStepTypes[] = ModalStepTypes[]> {
  */
 declare function useDisplayModal<T extends ModalStepTypes[] = ModalStepTypes[]>({
   mutations
-}?: UseDisplayModalParams<T>): _tanstack_react_query0.UseMutationResult<ModalRpcStepsResultType<T>, FrakRpcError<undefined>, DisplayModalParamsType<T>, unknown>;
+}?: UseDisplayModalParams<T>): _$_tanstack_react_query0.UseMutationResult<ModalRpcStepsResultType<T>, FrakRpcError<undefined>, DisplayModalParamsType<T> & {
+  placement?: string;
+}, unknown>;
+//#endregion
+//#region src/hook/useDisplaySharingPage.d.ts
+/** @ignore */
+type MutationOptions$3 = Omit<UseMutationOptions<DisplaySharingPageResultType, FrakRpcError, DisplaySharingPageParamsType & {
+  placement?: string;
+}>, "mutationFn" | "mutationKey">;
+/** @inline */
+interface UseDisplaySharingPageParams {
+  /**
+   * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
+   */
+  mutations?: MutationOptions$3;
+}
+/**
+ * Hook that return a mutation helping to display a sharing page to the user
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.displaySharingPage | `displaySharingPage()`} action
+ *
+ * @param args - Optional config object with `mutations` for customizing the underlying {@link @tanstack/react-query!useMutation | `useMutation()`}
+ *
+ * @group hooks
+ *
+ * @returns
+ * The mutation hook wrapping the `displaySharingPage()` action
+ * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!index.DisplaySharingPageParamsType | `DisplaySharingPageParamsType`} with optional `placement`
+ * The `data` result is a {@link @frak-labs/core-sdk!index.DisplaySharingPageResultType | `DisplaySharingPageResultType`}
+ *
+ * @see {@link @frak-labs/core-sdk!actions.displaySharingPage | `displaySharingPage()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
+ */
+declare function useDisplaySharingPage({
+  mutations
+}?: UseDisplaySharingPageParams): _$_tanstack_react_query0.UseMutationResult<DisplaySharingPageResultType, FrakRpcError<undefined>, DisplaySharingPageParamsType & {
+  placement?: string;
+}, unknown>;
 //#endregion
 //#region src/hook/useFrakClient.d.ts
 /**
@@ -70,7 +111,7 @@ declare function useDisplayModal<T extends ModalStepTypes[] = ModalStepTypes[]>(
  *
  * @group hooks
  */
-declare function useFrakClient(): _frak_labs_core_sdk0.FrakClient | undefined;
+declare function useFrakClient(): _$_frak_labs_core_sdk0.FrakClient | undefined;
 //#endregion
 //#region src/hook/useFrakConfig.d.ts
 /**
@@ -81,17 +122,21 @@ declare function useFrakClient(): _frak_labs_core_sdk0.FrakClient | undefined;
  * @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
  */
-declare function useFrakConfig(): _frak_labs_core_sdk0.FrakWalletSdkConfig;
+declare function useFrakConfig(): _$_frak_labs_core_sdk0.FrakWalletSdkConfig;
 //#endregion
 //#region src/hook/useGetMerchantInformation.d.ts
 /** @ignore */
-type QueryOptions = Omit<UseQueryOptions<GetMerchantInformationReturnType, FrakRpcError, GetMerchantInformationReturnType>, "queryKey" | "queryFn">;
+type QueryOptions$2 = Omit<UseQueryOptions<GetMerchantInformationReturnType, FrakRpcError, GetMerchantInformationReturnType>, "queryKey" | "queryFn">;
 /** @inline */
 interface UseGetMerchantInformationParams {
   /**
    * Optional query options, see {@link @tanstack/react-query!useQuery | `useQuery()`} for more infos
    */
-  query?: QueryOptions;
+  query?: QueryOptions$2;
+  /**
+   * Time in ms to cache the result at the core SDK level. Default: 30_000 (30s). Set to 0 to disable.
+   */
+  cacheTime?: number;
 }
 /**
  * Hook that return a query helping to get the current merchant information
@@ -110,8 +155,84 @@ interface UseGetMerchantInformationParams {
  * @see {@link @tanstack/react-query!useQuery | `useQuery()`} for more info about the useQuery options and response
  */
 declare function useGetMerchantInformation({
-  query
-}?: UseGetMerchantInformationParams): _tanstack_react_query0.UseQueryResult<GetMerchantInformationReturnType, FrakRpcError<undefined>>;
+  query,
+  cacheTime
+}?: UseGetMerchantInformationParams): _$_tanstack_react_query0.UseQueryResult<GetMerchantInformationReturnType, FrakRpcError<undefined>>;
+//#endregion
+//#region src/hook/useGetMergeToken.d.ts
+/** @ignore */
+type QueryOptions$1 = Omit<UseQueryOptions<string | null, FrakRpcError, string | null>, "queryKey" | "queryFn">;
+/** @inline */
+interface UseGetMergeTokenParams {
+  /**
+   * Optional query options, see {@link @tanstack/react-query!useQuery | `useQuery()`} for more infos
+   */
+  query?: QueryOptions$1;
+  /**
+   * Time in ms to cache the result at the core SDK level. Default: 30_000 (30s). Set to 0 to disable.
+   */
+  cacheTime?: number;
+}
+/**
+ * Hook that return a query to fetch a merge token for the current anonymous identity
+ *
+ * Used by in-app browser redirect flows to preserve identity
+ * when switching from a WebView to the system browser.
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.getMergeToken | `getMergeToken()`} action
+ *
+ * @param args - Optional config object with `query` for customizing the underlying {@link @tanstack/react-query!useQuery | `useQuery()`}
+ *
+ * @group hooks
+ *
+ * @returns
+ * The query hook wrapping the `getMergeToken()` action
+ * The `data` result is a `string | null`
+ *
+ * @see {@link @frak-labs/core-sdk!actions.getMergeToken | `getMergeToken()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useQuery | `useQuery()`} for more info about the useQuery options and response
+ */
+declare function useGetMergeToken({
+  query,
+  cacheTime
+}?: UseGetMergeTokenParams): _$_tanstack_react_query0.UseQueryResult<string | null, FrakRpcError<undefined>>;
+//#endregion
+//#region src/hook/useGetUserReferralStatus.d.ts
+/** @ignore */
+type QueryOptions = Omit<UseQueryOptions<UserReferralStatusType | null, FrakRpcError, UserReferralStatusType | null>, "queryKey" | "queryFn">;
+/** @inline */
+interface UseGetUserReferralStatusParams {
+  /**
+   * Optional query options, see {@link @tanstack/react-query!useQuery | `useQuery()`} for more infos
+   */
+  query?: QueryOptions;
+  /**
+   * Time in ms to cache the result at the core SDK level. Default: 30_000 (30s). Set to 0 to disable.
+   */
+  cacheTime?: number;
+}
+/**
+ * Hook that return a query to fetch the current user's referral status on the current merchant
+ *
+ * Returns `null` when the user's identity cannot be resolved.
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.getUserReferralStatus | `getUserReferralStatus()`} action
+ *
+ * @param args - Optional config object with `query` for customizing the underlying {@link @tanstack/react-query!useQuery | `useQuery()`}
+ *
+ * @group hooks
+ *
+ * @returns
+ * The query hook wrapping the `getUserReferralStatus()` action
+ * The `data` result is a {@link @frak-labs/core-sdk!index.UserReferralStatusType | `UserReferralStatusType`} or `null`
+ *
+ * @see {@link @frak-labs/core-sdk!actions.getUserReferralStatus | `getUserReferralStatus()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useQuery | `useQuery()`} for more info about the useQuery options and response
+ */
+declare function useGetUserReferralStatus({
+  query,
+  cacheTime
+}?: UseGetUserReferralStatusParams): _$_tanstack_react_query0.UseQueryResult<UserReferralStatusType | null, FrakRpcError<undefined>>;
 //#endregion
 //#region src/hook/useOpenSso.d.ts
 /** @ignore */
@@ -142,7 +263,7 @@ interface UseOpenSsoParams {
  */
 declare function useOpenSso({
   mutations
-}?: UseOpenSsoParams): _tanstack_react_query0.UseMutationResult<OpenSsoReturnType, FrakRpcError<undefined>, OpenSsoParamsType, unknown>;
+}?: UseOpenSsoParams): _$_tanstack_react_query0.UseMutationResult<OpenSsoReturnType, FrakRpcError<undefined>, OpenSsoParamsType, unknown>;
 //#endregion
 //#region src/hook/usePrepareSso.d.ts
 /**
@@ -181,7 +302,7 @@ declare function useOpenSso({
  * @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
  */
-declare function usePrepareSso(params: PrepareSsoParamsType): _tanstack_react_query0.UseQueryResult<_frak_labs_core_sdk0.PrepareSsoReturnType, Error>;
+declare function usePrepareSso(params: PrepareSsoParamsType): _$_tanstack_react_query0.UseQueryResult<_$_frak_labs_core_sdk0.PrepareSsoReturnType, Error>;
 //#endregion
 //#region src/hook/useSendTransaction.d.ts
 /** @ignore */
@@ -212,7 +333,24 @@ interface UseSendTransactionParams {
  */
 declare function useSendTransactionAction({
   mutations
-}?: UseSendTransactionParams): _tanstack_react_query0.UseMutationResult<SendTransactionReturnType, FrakRpcError<undefined>, SendTransactionParams, unknown>;
+}?: UseSendTransactionParams): _$_tanstack_react_query0.UseMutationResult<SendTransactionReturnType, FrakRpcError<undefined>, SendTransactionParams, unknown>;
+//#endregion
+//#region src/hook/useSetupReferral.d.ts
+/**
+ * Hook that automatically processes referral context and emits a DOM event on success
+ *
+ * Runs once when the Frak client becomes available. Fire-and-forget — the referral
+ * result is tracked via a `"frak:referral-success"` DOM event on `window`, not via
+ * the returned query data.
+ *
+ * @group hooks
+ *
+ * @returns The query handle (data is not meaningful — listen for `REFERRAL_SUCCESS_EVENT` on `window` instead)
+ *
+ * @see {@link @frak-labs/core-sdk!actions.setupReferral | `setupReferral()`} for more info about the underlying action
+ * @see {@link @frak-labs/core-sdk!actions.REFERRAL_SUCCESS_EVENT | `REFERRAL_SUCCESS_EVENT`} for the event name constant
+ */
+declare function useSetupReferral(): _$_tanstack_react_query0.UseQueryResult<null, Error>;
 //#endregion
 //#region src/hook/useSiweAuthenticate.d.ts
 /** @inline */
@@ -243,7 +381,7 @@ interface UseSiweAuthenticateParams {
  */
 declare function useSiweAuthenticate({
   mutations
-}?: UseSiweAuthenticateParams): _tanstack_react_query0.UseMutationResult<SiweAuthenticateReturnType, FrakRpcError<undefined>, SiweAuthenticateModalParams, unknown>;
+}?: UseSiweAuthenticateParams): _$_tanstack_react_query0.UseMutationResult<SiweAuthenticateReturnType, FrakRpcError<undefined>, SiweAuthenticateModalParams, unknown>;
 //#endregion
 //#region src/hook/useWalletStatus.d.ts
 /**
@@ -260,14 +398,14 @@ declare function useSiweAuthenticate({
  * @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
  */
-declare function useWalletStatus(): _tanstack_react_query0.UseQueryResult<WalletStatusReturnType, Error>;
+declare function useWalletStatus(): _$_tanstack_react_query0.UseQueryResult<WalletStatusReturnType, Error>;
 //#endregion
 //#region src/provider/FrakConfigProvider.d.ts
 /**
  * The context that will keep the Frak Wallet SDK configuration
  * @ignore
  */
-declare const FrakConfigContext: react.Context<FrakWalletSdkConfig | undefined>;
+declare const FrakConfigContext: _$react.Context<FrakWalletSdkConfig | undefined>;
 /**
  * Props to instantiate the Frak Wallet SDK configuration provider
  *
@@ -289,14 +427,14 @@ type FrakConfigProviderProps = {
  *
  * @param parameters
  */
-declare function FrakConfigProvider(parameters: PropsWithChildren<FrakConfigProviderProps>): react.FunctionComponentElement<react.ProviderProps<FrakWalletSdkConfig | undefined>>;
+declare function FrakConfigProvider(parameters: PropsWithChildren<FrakConfigProviderProps>): _$react.FunctionComponentElement<_$react.ProviderProps<FrakWalletSdkConfig | undefined>>;
 //#endregion
 //#region src/provider/FrakIFrameClientProvider.d.ts
 /**
  * The context that will keep the Frak Wallet SDK client
  * @ignore
  */
-declare const FrakIFrameClientContext: react.Context<FrakClient | undefined>;
+declare const FrakIFrameClientContext: _$react.Context<FrakClient | undefined>;
 /**
  * Props to instantiate the Frak Wallet SDK configuration provider
  *
@@ -324,6 +462,6 @@ declare function FrakIFrameClientProvider({
 }: {
   style?: CSSProperties;
   children?: ReactNode;
-}): react.FunctionComponentElement<react.FragmentProps>;
+}): _$react.FunctionComponentElement<_$react.FragmentProps>;
 //#endregion
-export { FrakConfigContext, FrakConfigProvider, type FrakConfigProviderProps, FrakIFrameClientContext, type FrakIFrameClientProps, FrakIFrameClientProvider, useDisplayModal, useFrakClient, useFrakConfig, useGetMerchantInformation, useOpenSso, usePrepareSso, useReferralInteraction, useSendTransactionAction, useSiweAuthenticate, useWalletStatus };
+export { FrakConfigContext, FrakConfigProvider, type FrakConfigProviderProps, FrakIFrameClientContext, type FrakIFrameClientProps, FrakIFrameClientProvider, useDisplayModal, useDisplaySharingPage, useFrakClient, useFrakConfig, useGetMerchantInformation, useGetMergeToken, useGetUserReferralStatus, useOpenSso, usePrepareSso, useReferralInteraction, useSendTransactionAction, useSetupReferral, useSiweAuthenticate, useWalletStatus };

package/dist/index.d.ts

@@ -1,16 +1,18 @@
 import { ProcessReferralOptions, SendTransactionParams, SiweAuthenticateModalParams } from "@frak-labs/core-sdk/actions";
 import { FrakRpcError } from "@frak-labs/frame-connector";
-import * as _tanstack_react_query0 from "@tanstack/react-query";
+import * as _$_tanstack_react_query0 from "@tanstack/react-query";
 import { UseMutationOptions, UseQueryOptions } from "@tanstack/react-query";
-import * as react from "react";
+import * as _$react from "react";
 import { CSSProperties, PropsWithChildren, ReactNode } from "react";
-import * as _frak_labs_core_sdk0 from "@frak-labs/core-sdk";
-import { DisplayModalParamsType, FrakClient, FrakWalletSdkConfig, GetMerchantInformationReturnType, ModalRpcStepsResultType, ModalStepTypes, OpenSsoParamsType, OpenSsoReturnType, PrepareSsoParamsType, SendTransactionReturnType, SiweAuthenticateReturnType, WalletStatusReturnType } from "@frak-labs/core-sdk";
+import * as _$_frak_labs_core_sdk0 from "@frak-labs/core-sdk";
+import { DisplayModalParamsType, DisplaySharingPageParamsType, DisplaySharingPageResultType, FrakClient, FrakWalletSdkConfig, GetMerchantInformationReturnType, ModalRpcStepsResultType, ModalStepTypes, OpenSsoParamsType, OpenSsoReturnType, PrepareSsoParamsType, SendTransactionReturnType, SiweAuthenticateReturnType, UserReferralStatusType, WalletStatusReturnType } from "@frak-labs/core-sdk";
 
 //#region src/hook/helper/useReferralInteraction.d.ts
 /**
  * Helper hook to automatically submit a referral interaction when detected
  *
+ * Runs once when the Frak client becomes available.
+ *
  * @group hooks
  *
  * @param args
@@ -20,23 +22,25 @@ import { DisplayModalParamsType, FrakClient, FrakWalletSdkConfig, GetMerchantInf
  *
  * @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
+ * @see {@link @frak-labs/core-sdk!actions.referralInteraction | `referralInteraction()`} for more details on the automatic referral handling process
  */
 declare function useReferralInteraction({
   options
 }?: {
   options?: ProcessReferralOptions;
-}): "processing" | Error | "no-referrer" | "idle" | "success" | "self-referral";
+}): Error | "processing" | "idle" | "success" | "no-referrer" | "self-referral";
 //#endregion
 //#region src/hook/useDisplayModal.d.ts
 /** @ignore */
-type MutationOptions$3<T extends ModalStepTypes[]> = Omit<UseMutationOptions<ModalRpcStepsResultType<T>, FrakRpcError, DisplayModalParamsType<T>>, "mutationFn" | "mutationKey">;
+type MutationOptions$4<T extends ModalStepTypes[]> = Omit<UseMutationOptions<ModalRpcStepsResultType<T>, FrakRpcError, DisplayModalParamsType<T> & {
+  placement?: string;
+}>, "mutationFn" | "mutationKey">;
 /** @inline */
 interface UseDisplayModalParams<T extends ModalStepTypes[] = ModalStepTypes[]> {
   /**
    * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
    */
-  mutations?: MutationOptions$3<T>;
+  mutations?: MutationOptions$4<T>;
 }
 /**
  * Hook that return a mutation helping to display a modal to the user
@@ -62,7 +66,44 @@ interface UseDisplayModalParams<T extends ModalStepTypes[] = ModalStepTypes[]> {
  */
 declare function useDisplayModal<T extends ModalStepTypes[] = ModalStepTypes[]>({
   mutations
-}?: UseDisplayModalParams<T>): _tanstack_react_query0.UseMutationResult<ModalRpcStepsResultType<T>, FrakRpcError<undefined>, DisplayModalParamsType<T>, unknown>;
+}?: UseDisplayModalParams<T>): _$_tanstack_react_query0.UseMutationResult<ModalRpcStepsResultType<T>, FrakRpcError<undefined>, DisplayModalParamsType<T> & {
+  placement?: string;
+}, unknown>;
+//#endregion
+//#region src/hook/useDisplaySharingPage.d.ts
+/** @ignore */
+type MutationOptions$3 = Omit<UseMutationOptions<DisplaySharingPageResultType, FrakRpcError, DisplaySharingPageParamsType & {
+  placement?: string;
+}>, "mutationFn" | "mutationKey">;
+/** @inline */
+interface UseDisplaySharingPageParams {
+  /**
+   * Optional mutation options, see {@link @tanstack/react-query!useMutation | `useMutation()`} for more infos
+   */
+  mutations?: MutationOptions$3;
+}
+/**
+ * Hook that return a mutation helping to display a sharing page to the user
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.displaySharingPage | `displaySharingPage()`} action
+ *
+ * @param args - Optional config object with `mutations` for customizing the underlying {@link @tanstack/react-query!useMutation | `useMutation()`}
+ *
+ * @group hooks
+ *
+ * @returns
+ * The mutation hook wrapping the `displaySharingPage()` action
+ * The `mutate` and `mutateAsync` argument is of type {@link @frak-labs/core-sdk!index.DisplaySharingPageParamsType | `DisplaySharingPageParamsType`} with optional `placement`
+ * The `data` result is a {@link @frak-labs/core-sdk!index.DisplaySharingPageResultType | `DisplaySharingPageResultType`}
+ *
+ * @see {@link @frak-labs/core-sdk!actions.displaySharingPage | `displaySharingPage()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useMutation | `useMutation()`} for more info about the mutation options and response
+ */
+declare function useDisplaySharingPage({
+  mutations
+}?: UseDisplaySharingPageParams): _$_tanstack_react_query0.UseMutationResult<DisplaySharingPageResultType, FrakRpcError<undefined>, DisplaySharingPageParamsType & {
+  placement?: string;
+}, unknown>;
 //#endregion
 //#region src/hook/useFrakClient.d.ts
 /**
@@ -70,7 +111,7 @@ declare function useDisplayModal<T extends ModalStepTypes[] = ModalStepTypes[]>(
  *
  * @group hooks
  */
-declare function useFrakClient(): _frak_labs_core_sdk0.FrakClient | undefined;
+declare function useFrakClient(): _$_frak_labs_core_sdk0.FrakClient | undefined;
 //#endregion
 //#region src/hook/useFrakConfig.d.ts
 /**
@@ -81,17 +122,21 @@ declare function useFrakClient(): _frak_labs_core_sdk0.FrakClient | undefined;
  * @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
  */
-declare function useFrakConfig(): _frak_labs_core_sdk0.FrakWalletSdkConfig;
+declare function useFrakConfig(): _$_frak_labs_core_sdk0.FrakWalletSdkConfig;
 //#endregion
 //#region src/hook/useGetMerchantInformation.d.ts
 /** @ignore */
-type QueryOptions = Omit<UseQueryOptions<GetMerchantInformationReturnType, FrakRpcError, GetMerchantInformationReturnType>, "queryKey" | "queryFn">;
+type QueryOptions$2 = Omit<UseQueryOptions<GetMerchantInformationReturnType, FrakRpcError, GetMerchantInformationReturnType>, "queryKey" | "queryFn">;
 /** @inline */
 interface UseGetMerchantInformationParams {
   /**
    * Optional query options, see {@link @tanstack/react-query!useQuery | `useQuery()`} for more infos
    */
-  query?: QueryOptions;
+  query?: QueryOptions$2;
+  /**
+   * Time in ms to cache the result at the core SDK level. Default: 30_000 (30s). Set to 0 to disable.
+   */
+  cacheTime?: number;
 }
 /**
  * Hook that return a query helping to get the current merchant information
@@ -110,8 +155,84 @@ interface UseGetMerchantInformationParams {
  * @see {@link @tanstack/react-query!useQuery | `useQuery()`} for more info about the useQuery options and response
  */
 declare function useGetMerchantInformation({
-  query
-}?: UseGetMerchantInformationParams): _tanstack_react_query0.UseQueryResult<GetMerchantInformationReturnType, FrakRpcError<undefined>>;
+  query,
+  cacheTime
+}?: UseGetMerchantInformationParams): _$_tanstack_react_query0.UseQueryResult<GetMerchantInformationReturnType, FrakRpcError<undefined>>;
+//#endregion
+//#region src/hook/useGetMergeToken.d.ts
+/** @ignore */
+type QueryOptions$1 = Omit<UseQueryOptions<string | null, FrakRpcError, string | null>, "queryKey" | "queryFn">;
+/** @inline */
+interface UseGetMergeTokenParams {
+  /**
+   * Optional query options, see {@link @tanstack/react-query!useQuery | `useQuery()`} for more infos
+   */
+  query?: QueryOptions$1;
+  /**
+   * Time in ms to cache the result at the core SDK level. Default: 30_000 (30s). Set to 0 to disable.
+   */
+  cacheTime?: number;
+}
+/**
+ * Hook that return a query to fetch a merge token for the current anonymous identity
+ *
+ * Used by in-app browser redirect flows to preserve identity
+ * when switching from a WebView to the system browser.
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.getMergeToken | `getMergeToken()`} action
+ *
+ * @param args - Optional config object with `query` for customizing the underlying {@link @tanstack/react-query!useQuery | `useQuery()`}
+ *
+ * @group hooks
+ *
+ * @returns
+ * The query hook wrapping the `getMergeToken()` action
+ * The `data` result is a `string | null`
+ *
+ * @see {@link @frak-labs/core-sdk!actions.getMergeToken | `getMergeToken()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useQuery | `useQuery()`} for more info about the useQuery options and response
+ */
+declare function useGetMergeToken({
+  query,
+  cacheTime
+}?: UseGetMergeTokenParams): _$_tanstack_react_query0.UseQueryResult<string | null, FrakRpcError<undefined>>;
+//#endregion
+//#region src/hook/useGetUserReferralStatus.d.ts
+/** @ignore */
+type QueryOptions = Omit<UseQueryOptions<UserReferralStatusType | null, FrakRpcError, UserReferralStatusType | null>, "queryKey" | "queryFn">;
+/** @inline */
+interface UseGetUserReferralStatusParams {
+  /**
+   * Optional query options, see {@link @tanstack/react-query!useQuery | `useQuery()`} for more infos
+   */
+  query?: QueryOptions;
+  /**
+   * Time in ms to cache the result at the core SDK level. Default: 30_000 (30s). Set to 0 to disable.
+   */
+  cacheTime?: number;
+}
+/**
+ * Hook that return a query to fetch the current user's referral status on the current merchant
+ *
+ * Returns `null` when the user's identity cannot be resolved.
+ *
+ * It's a {@link @tanstack/react-query!home | `tanstack`} wrapper around the {@link @frak-labs/core-sdk!actions.getUserReferralStatus | `getUserReferralStatus()`} action
+ *
+ * @param args - Optional config object with `query` for customizing the underlying {@link @tanstack/react-query!useQuery | `useQuery()`}
+ *
+ * @group hooks
+ *
+ * @returns
+ * The query hook wrapping the `getUserReferralStatus()` action
+ * The `data` result is a {@link @frak-labs/core-sdk!index.UserReferralStatusType | `UserReferralStatusType`} or `null`
+ *
+ * @see {@link @frak-labs/core-sdk!actions.getUserReferralStatus | `getUserReferralStatus()`} for more info about the underlying action
+ * @see {@link @tanstack/react-query!useQuery | `useQuery()`} for more info about the useQuery options and response
+ */
+declare function useGetUserReferralStatus({
+  query,
+  cacheTime
+}?: UseGetUserReferralStatusParams): _$_tanstack_react_query0.UseQueryResult<UserReferralStatusType | null, FrakRpcError<undefined>>;
 //#endregion
 //#region src/hook/useOpenSso.d.ts
 /** @ignore */
@@ -142,7 +263,7 @@ interface UseOpenSsoParams {
  */
 declare function useOpenSso({
   mutations
-}?: UseOpenSsoParams): _tanstack_react_query0.UseMutationResult<OpenSsoReturnType, FrakRpcError<undefined>, OpenSsoParamsType, unknown>;
+}?: UseOpenSsoParams): _$_tanstack_react_query0.UseMutationResult<OpenSsoReturnType, FrakRpcError<undefined>, OpenSsoParamsType, unknown>;
 //#endregion
 //#region src/hook/usePrepareSso.d.ts
 /**
@@ -181,7 +302,7 @@ declare function useOpenSso({
  * @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
  */
-declare function usePrepareSso(params: PrepareSsoParamsType): _tanstack_react_query0.UseQueryResult<_frak_labs_core_sdk0.PrepareSsoReturnType, Error>;
+declare function usePrepareSso(params: PrepareSsoParamsType): _$_tanstack_react_query0.UseQueryResult<_$_frak_labs_core_sdk0.PrepareSsoReturnType, Error>;
 //#endregion
 //#region src/hook/useSendTransaction.d.ts
 /** @ignore */
@@ -212,7 +333,24 @@ interface UseSendTransactionParams {
  */
 declare function useSendTransactionAction({
   mutations
-}?: UseSendTransactionParams): _tanstack_react_query0.UseMutationResult<SendTransactionReturnType, FrakRpcError<undefined>, SendTransactionParams, unknown>;
+}?: UseSendTransactionParams): _$_tanstack_react_query0.UseMutationResult<SendTransactionReturnType, FrakRpcError<undefined>, SendTransactionParams, unknown>;
+//#endregion
+//#region src/hook/useSetupReferral.d.ts
+/**
+ * Hook that automatically processes referral context and emits a DOM event on success
+ *
+ * Runs once when the Frak client becomes available. Fire-and-forget — the referral
+ * result is tracked via a `"frak:referral-success"` DOM event on `window`, not via
+ * the returned query data.
+ *
+ * @group hooks
+ *
+ * @returns The query handle (data is not meaningful — listen for `REFERRAL_SUCCESS_EVENT` on `window` instead)
+ *
+ * @see {@link @frak-labs/core-sdk!actions.setupReferral | `setupReferral()`} for more info about the underlying action
+ * @see {@link @frak-labs/core-sdk!actions.REFERRAL_SUCCESS_EVENT | `REFERRAL_SUCCESS_EVENT`} for the event name constant
+ */
+declare function useSetupReferral(): _$_tanstack_react_query0.UseQueryResult<null, Error>;
 //#endregion
 //#region src/hook/useSiweAuthenticate.d.ts
 /** @inline */
@@ -243,7 +381,7 @@ interface UseSiweAuthenticateParams {
  */
 declare function useSiweAuthenticate({
   mutations
-}?: UseSiweAuthenticateParams): _tanstack_react_query0.UseMutationResult<SiweAuthenticateReturnType, FrakRpcError<undefined>, SiweAuthenticateModalParams, unknown>;
+}?: UseSiweAuthenticateParams): _$_tanstack_react_query0.UseMutationResult<SiweAuthenticateReturnType, FrakRpcError<undefined>, SiweAuthenticateModalParams, unknown>;
 //#endregion
 //#region src/hook/useWalletStatus.d.ts
 /**
@@ -260,14 +398,14 @@ declare function useSiweAuthenticate({
  * @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
  */
-declare function useWalletStatus(): _tanstack_react_query0.UseQueryResult<WalletStatusReturnType, Error>;
+declare function useWalletStatus(): _$_tanstack_react_query0.UseQueryResult<WalletStatusReturnType, Error>;
 //#endregion
 //#region src/provider/FrakConfigProvider.d.ts
 /**
  * The context that will keep the Frak Wallet SDK configuration
  * @ignore
  */
-declare const FrakConfigContext: react.Context<FrakWalletSdkConfig | undefined>;
+declare const FrakConfigContext: _$react.Context<FrakWalletSdkConfig | undefined>;
 /**
  * Props to instantiate the Frak Wallet SDK configuration provider
  *
@@ -289,14 +427,14 @@ type FrakConfigProviderProps = {
  *
  * @param parameters
  */
-declare function FrakConfigProvider(parameters: PropsWithChildren<FrakConfigProviderProps>): react.FunctionComponentElement<react.ProviderProps<FrakWalletSdkConfig | undefined>>;
+declare function FrakConfigProvider(parameters: PropsWithChildren<FrakConfigProviderProps>): _$react.FunctionComponentElement<_$react.ProviderProps<FrakWalletSdkConfig | undefined>>;
 //#endregion
 //#region src/provider/FrakIFrameClientProvider.d.ts
 /**
  * The context that will keep the Frak Wallet SDK client
  * @ignore
  */
-declare const FrakIFrameClientContext: react.Context<FrakClient | undefined>;
+declare const FrakIFrameClientContext: _$react.Context<FrakClient | undefined>;
 /**
  * Props to instantiate the Frak Wallet SDK configuration provider
  *
@@ -324,6 +462,6 @@ declare function FrakIFrameClientProvider({
 }: {
   style?: CSSProperties;
   children?: ReactNode;
-}): react.FunctionComponentElement<react.FragmentProps>;
+}): _$react.FunctionComponentElement<_$react.FragmentProps>;
 //#endregion
-export { FrakConfigContext, FrakConfigProvider, type FrakConfigProviderProps, FrakIFrameClientContext, type FrakIFrameClientProps, FrakIFrameClientProvider, useDisplayModal, useFrakClient, useFrakConfig, useGetMerchantInformation, useOpenSso, usePrepareSso, useReferralInteraction, useSendTransactionAction, useSiweAuthenticate, useWalletStatus };
+export { FrakConfigContext, FrakConfigProvider, type FrakConfigProviderProps, FrakIFrameClientContext, type FrakIFrameClientProps, FrakIFrameClientProvider, useDisplayModal, useDisplaySharingPage, useFrakClient, useFrakConfig, useGetMerchantInformation, useGetMergeToken, useGetUserReferralStatus, useOpenSso, usePrepareSso, useReferralInteraction, useSendTransactionAction, useSetupReferral, useSiweAuthenticate, useWalletStatus };