@frak-labs/react-sdk 0.2.1 → 1.0.0

package/src/hook/useGetUserReferralStatus.ts

@@ -0,0 +1,63 @@
+import type { UserReferralStatusType } from "@frak-labs/core-sdk";
+import { getUserReferralStatus } from "@frak-labs/core-sdk/actions";
+import { ClientNotFound, type FrakRpcError } from "@frak-labs/frame-connector";
+import { type UseQueryOptions, useQuery } from "@tanstack/react-query";
+import { useFrakClient } from "./useFrakClient";
+
+/** @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
+ */
+export function useGetUserReferralStatus({
+    query,
+    cacheTime,
+}: UseGetUserReferralStatusParams = {}) {
+    const client = useFrakClient();
+
+    return useQuery({
+        ...query,
+        queryKey: ["frak-sdk", "get-user-referral-status"],
+        queryFn: async () => {
+            if (!client) {
+                throw new ClientNotFound();
+            }
+            return getUserReferralStatus(client, { cacheTime });
+        },
+    });
+}

package/src/hook/useSetupReferral.ts

@@ -0,0 +1,35 @@
+import { setupReferral } from "@frak-labs/core-sdk/actions";
+import { ClientNotFound } from "@frak-labs/frame-connector";
+import { useQuery } from "@tanstack/react-query";
+import { useFrakClient } from "./useFrakClient";
+
+/**
+ * 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
+ */
+export function useSetupReferral() {
+    const client = useFrakClient();
+
+    return useQuery({
+        queryKey: ["frak-sdk", "setup-referral"],
+        queryFn: async () => {
+            if (!client) {
+                throw new ClientNotFound();
+            }
+            await setupReferral(client);
+            return null;
+        },
+        enabled: !!client,
+        staleTime: Number.POSITIVE_INFINITY,
+    });
+}

package/src/index.ts

@@ -3,13 +3,17 @@
 // Hooks export
 export {
     useDisplayModal,
+    useDisplaySharingPage,
     useFrakClient,
     useFrakConfig,
     useGetMerchantInformation,
+    useGetMergeToken,
+    useGetUserReferralStatus,
     useOpenSso,
     usePrepareSso,
     useReferralInteraction,
     useSendTransactionAction,
+    useSetupReferral,
     useSiweAuthenticate,
     useWalletStatus,
 } from "./hook";