@frak-labs/nexus-sdk 0.0.9 → 0.0.11

package/dist/react/index.js

@@ -1,13 +1,25 @@
 import {
-  createIFrameNexusClient
-} from "../chunk-SZUN32YC.js";
+  ClientNotFound,
+  Deferred,
+  FrakRpcError,
+  RpcErrorCodes,
+  baseIframeProps,
+  compressJson,
+  createIFrameNexusClient,
+  decompressJson
+} from "../chunk-7MVQQ2X6.js";
 import {
-  getArticleUnlockOptions,
-  setUserReferred,
-  watchUnlockStatus,
+  displayModal,
+  openSso,
+  sendInteraction,
+  sendTransaction,
+  siweAuthenticate,
   watchWalletStatus
-} from "../chunk-PDR3CF3P.js";
-import "../chunk-VK7GPKK4.js";
+} from "../chunk-5CFD5FM2.js";
+import {
+  ReferralInteractionEncoder
+} from "../chunk-GUDT2W6I.js";
+import "../chunk-PKBMQBKP.js";
 
 // src/react/provider/NexusConfigProvider.ts
 import { createContext, createElement } from "react";
@@ -16,7 +28,12 @@ function NexusConfigProvider(parameters) {
   const { children, config } = parameters;
   return createElement(
     NexusConfigContext.Provider,
-    { value: config },
+    {
+      value: {
+        ...config,
+        domain: config.domain ?? (typeof window !== "undefined" ? window?.location?.host : void 0) ?? "not-found"
+      }
+    },
     children
   );
 }
@@ -26,8 +43,7 @@ import {
   Fragment,
   createContext as createContext2,
   createElement as createElement2,
-  useMemo,
-  useState as useState4
+  useState as useState3
 } from "react";
 
 // src/react/hook/useNexusConfig.ts
@@ -35,7 +51,10 @@ import { useContext } from "react";
 function useNexusConfig() {
   const config = useContext(NexusConfigContext);
   if (!config) {
-    throw new Error("NexusConfigProvider is not found");
+    throw new FrakRpcError(
+      RpcErrorCodes.configError,
+      "Nexus config not found"
+    );
   }
   return config;
 }
@@ -43,114 +62,134 @@ function useNexusConfig() {
 // src/react/hook/useNexusClient.ts
 import { useContext as useContext2 } from "react";
 function useNexusClient() {
-  const client = useContext2(NexusIFrameClientContext);
-  if (!client) {
-    throw new Error("NexusIFrameClientProvider is not found");
-  }
-  return client;
-}
-
-// src/react/hook/useArticleUnlockOptions.ts
-import { useQuery } from "@tanstack/react-query";
-function useArticleUnlockOptions({
-  articleId,
-  contentId
-}) {
-  const client = useNexusClient();
-  return useQuery({
-    queryKey: ["articleUnlockOptions", articleId ?? "no-article-id"],
-    queryFn: async () => {
-      if (!(articleId && contentId)) {
-        throw new Error("No article id provided");
-      }
-      return await getArticleUnlockOptions(client, {
-        articleId,
-        contentId
-      });
-    },
-    enabled: !!articleId && !!contentId,
-    gcTime: 0
-  });
+  return useContext2(NexusIFrameClientContext);
 }
 
 // src/react/hook/useWalletStatus.ts
-import { useQuery as useQuery2, useQueryClient } from "@tanstack/react-query";
+import { useQuery, useQueryClient } from "@tanstack/react-query";
 import { useCallback } from "react";
 function useWalletStatus() {
   const queryClient = useQueryClient();
   const client = useNexusClient();
   const newStatusUpdated = useCallback(
     (event) => {
-      queryClient.setQueryData(["walletStatusListener"], event);
+      queryClient.setQueryData(
+        ["nexus-sdk", "wallet-status-listener"],
+        event
+      );
     },
     [queryClient]
   );
-  return useQuery2({
+  return useQuery({
     gcTime: 0,
-    queryKey: ["walletStatusListener"],
+    queryKey: ["nexus-sdk", "wallet-status-listener"],
     queryFn: async () => {
-      await watchWalletStatus(client, newStatusUpdated);
-      return { key: "waiting-response" };
+      if (!client) {
+        throw new ClientNotFound();
+      }
+      const firstResult = new Deferred();
+      let hasResolved = false;
+      await watchWalletStatus(client, (status) => {
+        newStatusUpdated(status);
+        if (!hasResolved) {
+          firstResult.resolve(status);
+          hasResolved = true;
+        }
+      });
+      return firstResult.promise;
+    },
+    enabled: !!client
+  });
+}
+
+// src/react/hook/useSendTransaction.ts
+import { useMutation } from "@tanstack/react-query";
+function useSendTransactionAction({
+  mutations
+} = {}) {
+  const client = useNexusClient();
+  return useMutation({
+    ...mutations,
+    mutationKey: ["nexus-sdk", "send-transaction"],
+    mutationFn: async (params) => {
+      if (!client) {
+        throw new ClientNotFound();
+      }
+      return sendTransaction(client, params);
     }
   });
 }
 
-// src/react/hook/useArticleUnlockStatus.ts
-import { useQuery as useQuery3, useQueryClient as useQueryClient2 } from "@tanstack/react-query";
-import { useCallback as useCallback2 } from "react";
-function useArticleUnlockStatus({
-  articleId,
-  contentId
-}) {
-  const queryClient = useQueryClient2();
+// src/react/hook/useSiweAuthenticate.ts
+import { useMutation as useMutation2 } from "@tanstack/react-query";
+function useSiweAuthenticate({
+  mutations
+} = {}) {
   const client = useNexusClient();
-  const newStatusUpdated = useCallback2(
-    (event) => {
-      queryClient.setQueryData(
-        [
-          "articleUnlockStatusListener",
-          articleId ?? "no-article-id",
-          contentId ?? "no-contentId-id"
-        ],
-        event
-      );
-    },
-    [articleId, contentId, queryClient]
-  );
-  return useQuery3({
-    queryKey: [
-      "articleUnlockStatusListener",
-      articleId ?? "no-article-id",
-      contentId ?? "no-contentId-id"
+  return useMutation2({
+    ...mutations,
+    mutationKey: [
+      "nexus-sdk",
+      "siwe-authenticate",
+      client?.config.domain ?? "no-domain"
     ],
-    gcTime: 0,
-    queryFn: async () => {
-      if (!(articleId && contentId)) {
-        return null;
+    mutationFn: async (params) => {
+      if (!client) {
+        throw new ClientNotFound();
       }
-      await watchUnlockStatus(
-        client,
-        { articleId, contentId },
-        newStatusUpdated
-      );
-      return {
-        status: "waiting-response",
-        key: "waiting-response"
-      };
-    },
-    enabled: !!articleId && !!contentId
+      return siweAuthenticate(client, params);
+    }
   });
 }
 
-// src/react/hook/useNexusReferral.ts
-import { useQuery as useQuery4, useQueryClient as useQueryClient3 } from "@tanstack/react-query";
-import { useCallback as useCallback3, useEffect as useEffect3, useState as useState3 } from "react";
+// src/react/hook/helper/useReferralInteraction.ts
+import { useQuery as useQuery3 } from "@tanstack/react-query";
+import { useCallback as useCallback2, useMemo as useMemo2 } from "react";
 import { isAddressEqual } from "viem";
 
-// src/react/hook/useWindowLocation.ts
-import { useEffect as useEffect2, useState as useState2 } from "react";
+// src/react/hook/useDisplayModal.ts
+import { useMutation as useMutation3 } from "@tanstack/react-query";
+function useDisplayModal({
+  mutations
+} = {}) {
+  const client = useNexusClient();
+  return useMutation3({
+    ...mutations,
+    mutationKey: ["nexus-sdk", "display-modal"],
+    mutationFn: async (args) => {
+      if (!client) {
+        throw new ClientNotFound();
+      }
+      return displayModal(client, args);
+    }
+  });
+}
+
+// src/react/hook/useSendInteraction.ts
+import { useMutation as useMutation4 } from "@tanstack/react-query";
+function useSendInteraction({
+  mutations
+} = {}) {
+  const client = useNexusClient();
+  return useMutation4({
+    ...mutations,
+    mutationKey: ["nexus-sdk", "send-interaction"],
+    mutationFn: async (params) => {
+      if (!client) {
+        throw new ClientNotFound();
+      }
+      return sendInteraction(client, params);
+    }
+  });
+}
+
+// src/react/hook/utils/useNexusContext.ts
+import { useMutation as useMutation5, useQuery as useQuery2 } from "@tanstack/react-query";
 
-// src/react/hook/useMounted.ts
+// src/react/hook/utils/useWindowLocation.ts
+import { useEffect as useEffect2, useMemo, useState as useState2 } from "react";
+
+// src/react/hook/utils/useMounted.ts
 import { useEffect, useState } from "react";
 function useMounted() {
   const [mounted, setMounted] = useState(false);
@@ -160,22 +199,17 @@ function useMounted() {
   return mounted;
 }
 
-// src/react/hook/useWindowLocation.ts
-var useWindowLocation = () => {
+// src/react/hook/utils/useWindowLocation.ts
+function useWindowLocation() {
   const isMounted = useMounted();
   const [location, setLocation] = useState2(
     isMounted ? window.location : void 0
   );
-  const [href, setHref] = useState2(
-    isMounted ? window.location.href : void 0
-  );
   useEffect2(() => {
-    if (!isMounted)
-      return;
-    const setWindowLocation = () => {
+    if (!isMounted) return;
+    function setWindowLocation() {
       setLocation(window.location);
-      setHref(window.location.href);
-    };
+    }
     if (!location) {
       setWindowLocation();
     }
@@ -184,68 +218,153 @@ var useWindowLocation = () => {
       window.removeEventListener("popstate", setWindowLocation);
     };
   }, [isMounted, location]);
+  const href = useMemo(() => location?.href, [location?.href]);
   return { location, href };
-};
+}
 
-// src/react/hook/useNexusReferral.ts
-function useNexusReferral({ contentId }) {
-  const { href } = useWindowLocation();
-  const queryClient = useQueryClient3();
-  const client = useNexusClient();
-  const { data: walletStatus } = useWalletStatus();
-  const [referrerAddress, setReferrerAddress] = useState3();
-  const newStatusUpdated = useCallback3(
-    (event) => {
-      queryClient.setQueryData(
-        ["setUserReferredQueryReturnTypeListener"],
-        event
-      );
-      if (event.key === "referred-successful" || event.key === "referred-history") {
-        if (!href)
-          return;
-        const url = new URL(href);
-        if (walletStatus?.key === "connected") {
-          url.searchParams.set("nexusContext", walletStatus?.wallet);
-        }
-        if (walletStatus?.key === "not-connected") {
-          url.searchParams.delete("nexusContext");
-        }
-        window.history.replaceState(null, "", url.toString());
-      }
+// src/react/hook/utils/useNexusContext.ts
+var contextKey = "nCtx";
+function useNexusContext() {
+  const { location } = useWindowLocation();
+  const { data: nexusContext } = useQuery2({
+    queryKey: ["nexus-sdk", "context", location?.href ?? "no-href"],
+    queryFn: async () => {
+      if (!location?.href) return null;
+      const url = new URL(location.href);
+      const nexusContext2 = url.searchParams.get(contextKey);
+      if (!nexusContext2) return null;
+      const parsedContext = await decompressJson(nexusContext2);
+      if (!parsedContext) return null;
+      return parsedContext;
     },
-    [queryClient, href, walletStatus]
-  );
-  useEffect3(() => {
-    if (!href)
-      return;
-    const url = new URL(href);
-    const context = url.searchParams.get("nexusContext");
-    if (!context && walletStatus?.key === "connected") {
-      url.searchParams.set("nexusContext", walletStatus?.wallet);
+    enabled: !!location?.href
+  });
+  const { mutate: updateContext, mutateAsync: updateContextAsync } = useMutation5({
+    mutationKey: ["nexus-sdk", "update-context"],
+    mutationFn: async (newContext) => {
+      if (!location || typeof window === "undefined") return;
+      const fullNewContext = nexusContext ? { ...nexusContext, ...newContext } : newContext;
+      const compressedContext = await compressJson(fullNewContext);
+      if (!compressedContext) return;
+      const url = new URL(location.href);
+      url.searchParams.set(contextKey, compressedContext);
       window.history.replaceState(null, "", url.toString());
     }
-    if (context) {
-      setReferrerAddress(context);
+  });
+  return {
+    nexusContext,
+    updateContext,
+    updateContextAsync
+  };
+}
+
+// src/react/hook/helper/useReferralInteraction.ts
+function useReferralInteraction({
+  contentId,
+  modalConfig
+} = {}) {
+  const { nexusContext, updateContextAsync } = useNexusContext();
+  const { data: walletStatus } = useWalletStatus();
+  const { mutateAsync: sendInteraction2 } = useSendInteraction();
+  const ensureWalletConnected = useEnsureWalletConnected({
+    modalConfig,
+    walletStatus
+  });
+  const processReferral = useCallback2(async () => {
+    try {
+      const currentWallet = await ensureWalletConnected();
+      if (!nexusContext?.r) {
+        if (currentWallet) {
+          await updateContextAsync({ r: currentWallet });
+        }
+        return "no-referrer";
+      }
+      if (currentWallet && isAddressEqual(nexusContext.r, currentWallet)) {
+        return "self-referral";
+      }
+      const interaction = ReferralInteractionEncoder.referred({
+        referrer: nexusContext.r
+      });
+      await sendInteraction2({ contentId, interaction });
+      if (currentWallet) {
+        await updateContextAsync({ r: currentWallet });
+      }
+      return "success";
+    } catch (error2) {
+      return mapErrorToState(error2);
     }
-  }, [href, walletStatus]);
-  return useQuery4({
+  }, [
+    nexusContext,
+    contentId,
+    ensureWalletConnected,
+    sendInteraction2,
+    updateContextAsync
+  ]);
+  const {
+    data: referralState,
+    error,
+    status
+  } = useQuery3({
     gcTime: 0,
-    queryKey: ["setUserReferredQueryReturnTypeListener"],
-    queryFn: async () => {
-      if (!(contentId && referrerAddress)) {
-        return { key: "no-referrer" };
+    staleTime: 0,
+    queryKey: [
+      "nexus-sdk",
+      "auto-referral-interaction",
+      nexusContext?.r ?? "no-referrer",
+      walletStatus?.key ?? "no-wallet-status"
+    ],
+    queryFn: processReferral,
+    enabled: !!walletStatus
+  });
+  return useMemo2(() => {
+    if (status === "pending") return "processing";
+    if (status === "error") return mapErrorToState(error);
+    return referralState || "idle";
+  }, [referralState, status, error]);
+}
+function useEnsureWalletConnected({
+  modalConfig,
+  walletStatus
+}) {
+  const { mutateAsync: displayModal2 } = useDisplayModal();
+  return useCallback2(async () => {
+    if (walletStatus?.key !== "connected" || !walletStatus.interactionSession) {
+      if (!modalConfig) {
+        return void 0;
       }
-      if (walletStatus?.key === "connected" && walletStatus?.wallet && isAddressEqual(walletStatus?.wallet, referrerAddress)) {
-        return { key: "same-wallet" };
+      const result = await displayModal2(modalConfig);
+      return result?.login?.wallet ?? void 0;
+    }
+    return walletStatus.wallet ?? void 0;
+  }, [walletStatus, modalConfig, displayModal2]);
+}
+function mapErrorToState(error) {
+  if (error instanceof FrakRpcError) {
+    switch (error.code) {
+      case RpcErrorCodes.walletNotConnected:
+        return "no-wallet";
+      case RpcErrorCodes.noInteractionSession:
+        return "no-session";
+      default:
+        return "error";
+    }
+  }
+  return "error";
+}
+
+// src/react/hook/useOpenSso.ts
+import { useMutation as useMutation6 } from "@tanstack/react-query";
+function useOpenSso({ mutations } = {}) {
+  const client = useNexusClient();
+  return useMutation6({
+    ...mutations,
+    mutationKey: ["nexus-sdk", "open-sso"],
+    mutationFn: async (params) => {
+      if (!client) {
+        throw new ClientNotFound();
       }
-      await setUserReferred(
-        client,
-        { contentId, walletAddress: referrerAddress },
-        newStatusUpdated
-      );
-      return { key: "waiting-response" };
-    },
-    enabled: !!contentId && !!referrerAddress && walletStatus?.key !== void 0 && walletStatus?.key !== "waiting-response"
+      return openSso(client, params);
+    }
   });
 }
 
@@ -254,34 +373,25 @@ var NexusIFrameClientContext = createContext2(
   void 0
 );
 function NexusIFrameClientProvider({
+  style,
   children
 }) {
   const config = useNexusConfig();
-  const [iframeElem, setIframeElem] = useState4(
-    void 0
-  );
-  const client = useMemo(
-    () => iframeElem ? createIFrameNexusClient({ iframe: iframeElem, config }) : void 0,
-    [iframeElem, config]
-  );
+  const [client, setClient] = useState3(void 0);
   const iFrame = createElement2("iframe", {
-    id: "nexus-wallet",
-    name: "nexus-wallet",
+    ...baseIframeProps,
     src: `${config.walletUrl}/listener`,
-    style: {
-      width: "0",
-      height: "0",
-      border: "0",
-      position: "absolute",
-      top: "-1000px",
-      left: "-1000px"
-    },
+    style: style ?? baseIframeProps.style,
     ref: (iframe) => {
-      if (!iframe) {
-        setIframeElem(void 0);
+      if (!iframe || client) {
         return;
       }
-      setIframeElem(iframe);
+      setClient(
+        createIFrameNexusClient({
+          iframe,
+          config
+        })
+      );
     }
   });
   const providerComponent = createElement2(
@@ -296,10 +406,13 @@ export {
   NexusConfigProvider,
   NexusIFrameClientContext,
   NexusIFrameClientProvider,
-  useArticleUnlockOptions,
-  useArticleUnlockStatus,
+  useDisplayModal,
   useNexusClient,
   useNexusConfig,
-  useNexusReferral,
+  useOpenSso,
+  useReferralInteraction,
+  useSendInteraction,
+  useSendTransactionAction,
+  useSiweAuthenticate,
   useWalletStatus
 };

package/dist/sendTransaction-BZW627cT.d.cts

@@ -0,0 +1,30 @@
+import { S as SiweAuthenticationParams, M as ModalRpcMetadata, N as NexusClient, a as SiweAuthenticateReturnType, b as SendTransactionModalStepType, c as SendTransactionReturnType } from './client-C7u9zGwC.cjs';
+
+/**
+ * Partial SIWE params, since we can rebuild them from the SDK if they are empty
+ */
+type SiweAuthenticateModalParams = {
+    siwe?: Partial<SiweAuthenticationParams>;
+    metadata?: ModalRpcMetadata;
+};
+/**
+ * Function used to launch a siwe authentication
+ * @param client
+ * @param siwe
+ * @param context
+ */
+declare function siweAuthenticate(client: NexusClient, { siwe, metadata }: SiweAuthenticateModalParams): Promise<SiweAuthenticateReturnType>;
+
+type SendTransactionParams = {
+    tx: SendTransactionModalStepType["params"]["tx"];
+    metadata?: ModalRpcMetadata;
+};
+/**
+ * Function used to send a user transaction
+ * @param client
+ * @param tx
+ * @param context
+ */
+declare function sendTransaction(client: NexusClient, { tx, metadata }: SendTransactionParams): Promise<SendTransactionReturnType>;
+
+export { type SiweAuthenticateModalParams as S, sendTransaction as a, type SendTransactionParams as b, siweAuthenticate as s };

package/dist/sendTransaction-DpJTfGJc.d.ts

@@ -0,0 +1,30 @@
+import { S as SiweAuthenticationParams, M as ModalRpcMetadata, N as NexusClient, a as SiweAuthenticateReturnType, b as SendTransactionModalStepType, c as SendTransactionReturnType } from './client-gE3fYzkD.js';
+
+/**
+ * Partial SIWE params, since we can rebuild them from the SDK if they are empty
+ */
+type SiweAuthenticateModalParams = {
+    siwe?: Partial<SiweAuthenticationParams>;
+    metadata?: ModalRpcMetadata;
+};
+/**
+ * Function used to launch a siwe authentication
+ * @param client
+ * @param siwe
+ * @param context
+ */
+declare function siweAuthenticate(client: NexusClient, { siwe, metadata }: SiweAuthenticateModalParams): Promise<SiweAuthenticateReturnType>;
+
+type SendTransactionParams = {
+    tx: SendTransactionModalStepType["params"]["tx"];
+    metadata?: ModalRpcMetadata;
+};
+/**
+ * Function used to send a user transaction
+ * @param client
+ * @param tx
+ * @param context
+ */
+declare function sendTransaction(client: NexusClient, { tx, metadata }: SendTransactionParams): Promise<SendTransactionReturnType>;
+
+export { type SiweAuthenticateModalParams as S, sendTransaction as a, type SendTransactionParams as b, siweAuthenticate as s };