@frak-labs/nexus-sdk 0.0.8 → 0.0.10

package/dist/react/index.d.ts

@@ -1,10 +1,15 @@
 import * as react from 'react';
-import { PropsWithChildren, ReactNode } from 'react';
-import { a as NexusWalletSdkConfig, N as NexusClient, W as WalletStatusReturnType, A as ArticleUnlockStatusReturnType } from '../client-MgLVRfPw.js';
+import { PropsWithChildren, CSSProperties, ReactNode } from 'react';
+import { a as NexusWalletSdkConfig, N as NexusClient, W as WalletStatusReturnType, A as ArticleUnlockStatusReturnType, e as SendTransactionTxType, d as SendTransactionReturnType, c as SendTransactionActionParamsType, h as SiweAuthenticationParams, f as SiweAuthenticateReturnType, g as SiweAuthenticateActionParamsType } from '../client-6_BJp7Ub.js';
 import * as _tanstack_react_query from '@tanstack/react-query';
-import { G as GetUnlockOptionsParams, W as WatchUnlockStatusParams } from '../watchUnlockStatus-DQYfUj46.js';
-import 'viem';
+import { UseMutationOptions } from '@tanstack/react-query';
+import * as viem from 'viem';
+import { Hex } from 'viem';
+import { G as GetUnlockOptionsParams, W as WatchUnlockStatusParams } from '../watchUnlockStatus-g8wIxpeM.js';
+import { F as FrakRpcError } from '../error-C4Zm5nQe.js';
+import { S as SendInteractionParamsType, a as SendInteractionReturnType } from '../interaction-D_CzyqRE.js';
 import 'viem/chains';
+import 'viem/siwe';
 
 /**
  * The context that will keep the Nexus Wallet SDK configuration
@@ -14,12 +19,15 @@ declare const NexusConfigContext: react.Context<Readonly<{
     metadata: {
         name: string;
     };
+    domain: string;
 }> | undefined>;
 /**
  * Props to instantiate the Nexus Wallet SDK configuration provider
  */
 type NexusConfigProviderProps = {
-    config: NexusWalletSdkConfig;
+    config: Omit<NexusWalletSdkConfig, "domain"> & {
+        domain?: string;
+    };
 };
 /**
  * Simple config provider for the Nexus Wallet SDK
@@ -31,6 +39,7 @@ declare function NexusConfigProvider(parameters: PropsWithChildren<NexusConfigPr
     metadata: {
         name: string;
     };
+    domain: string;
 }> | undefined>>;
 
 /**
@@ -49,10 +58,11 @@ type NexusIFrameClientProps = {
  * @param parameters
  * @constructor
  */
-declare function NexusIFrameClientProvider({ children, }: {
+declare function NexusIFrameClientProvider({ style, children, }: {
+    style?: CSSProperties;
     children?: ReactNode;
 }): react.FunctionComponentElement<{
-    children?: ReactNode;
+    children?: ReactNode | undefined;
 }>;
 
 /**
@@ -63,25 +73,26 @@ declare function useNexusConfig(): Readonly<{
     metadata: {
         name: string;
     };
+    domain: string;
 }>;
 
 /**
  * Use the current nexus iframe client
  */
-declare function useNexusClient(): NexusClient;
+declare function useNexusClient(): NexusClient | undefined;
 
 /**
  * Hook used to get the unlock options for an article
  */
 declare function useArticleUnlockOptions({ articleId, contentId, }: GetUnlockOptionsParams): _tanstack_react_query.UseQueryResult<Readonly<{
-    frkBalanceAsHex?: `0x${string}` | undefined;
+    frkBalanceAsHex?: viem.Hex;
     prices: {
         index: number;
         unlockDurationInSec: number;
-        frkAmount: `0x${string}`;
+        frkAmount: viem.Hex;
         isUserAccessible: boolean | null;
     }[];
-}>, Error>;
+}> | undefined, Error>;
 
 type WalletStatusQueryReturnType = WalletStatusReturnType | {
     key: "waiting-response";
@@ -100,4 +111,53 @@ type ArticleUnlockStatusQueryReturnType = ArticleUnlockStatusReturnType | {
  */
 declare function useArticleUnlockStatus({ articleId, contentId, }: WatchUnlockStatusParams): _tanstack_react_query.UseQueryResult<ArticleUnlockStatusQueryReturnType | null, Error>;
 
-export { type ArticleUnlockStatusQueryReturnType, NexusConfigContext, NexusConfigProvider, type NexusConfigProviderProps, NexusIFrameClientContext, type NexusIFrameClientProps, NexusIFrameClientProvider, type WalletStatusQueryReturnType, useArticleUnlockOptions, useArticleUnlockStatus, useNexusClient, useNexusConfig, useWalletStatus };
+type MutationOptions$2 = Omit<UseMutationOptions<SendTransactionReturnType, FrakRpcError, SendTransactionActionParamsType>, "mutationFn" | "mutationKey">;
+interface UseSendTransactionParams {
+    mutations?: MutationOptions$2;
+}
+/**
+ * Trigger a dashboard action to the wallet
+ */
+declare function useSendTransactionAction({ mutations, }?: UseSendTransactionParams): _tanstack_react_query.UseMutationResult<Readonly<{
+    hash: viem.Hex;
+}>, FrakRpcError<undefined>, Readonly<{
+    tx: SendTransactionTxType | SendTransactionTxType[];
+    context?: string;
+}>, unknown>;
+
+type MutationOptions$1 = Omit<UseMutationOptions<SiweAuthenticateReturnType, FrakRpcError, SiweAuthenticateActionParamsType>, "mutationFn" | "mutationKey">;
+interface UseSiweAuthenticateParams {
+    mutations?: MutationOptions$1;
+}
+/**
+ * Trigger a dashboard action to the wallet
+ */
+declare function useSiweAuthenticate({ mutations, }?: UseSiweAuthenticateParams): _tanstack_react_query.UseMutationResult<Readonly<{
+    signature: viem.Hex;
+    message: string;
+}>, FrakRpcError<undefined>, Readonly<{
+    siwe?: Partial<SiweAuthenticationParams>;
+    context?: string;
+}>, unknown>;
+
+/**
+ * Helper hook to automatically submit a press referral interaction when detected
+ *   -> And automatically set the referral context in the url
+ * @param contentId
+ */
+declare function usePressReferralInteraction({ contentId }: {
+    contentId: Hex;
+}): "error" | "loading" | "no-referral" | "referred" | "no-wallet" | "no-session";
+
+type MutationOptions = Omit<UseMutationOptions<SendInteractionReturnType, FrakRpcError, SendInteractionParamsType>, "mutationFn" | "mutationKey">;
+interface UseSendInteractionParams {
+    mutations?: MutationOptions;
+}
+/**
+ * Send a user interaction
+ */
+declare function useSendInteraction({ mutations, }?: UseSendInteractionParams): _tanstack_react_query.UseMutationResult<Readonly<{
+    hash: viem.Hex;
+}>, FrakRpcError<undefined>, SendInteractionParamsType, unknown>;
+
+export { type ArticleUnlockStatusQueryReturnType, NexusConfigContext, NexusConfigProvider, type NexusConfigProviderProps, NexusIFrameClientContext, type NexusIFrameClientProps, NexusIFrameClientProvider, type WalletStatusQueryReturnType, useArticleUnlockOptions, useArticleUnlockStatus, useNexusClient, useNexusConfig, usePressReferralInteraction, useSendInteraction, useSendTransactionAction, useSiweAuthenticate, useWalletStatus };

package/dist/react/index.js

@@ -1,12 +1,25 @@
 import {
   createIFrameNexusClient
-} from "../chunk-OXP3VK26.js";
+} from "../chunk-HOX3RRO6.js";
 import {
   getArticleUnlockOptions,
+  sendInteraction,
+  sendTransaction,
+  siweAuthenticate,
   watchUnlockStatus,
   watchWalletStatus
-} from "../chunk-4VFMYMTH.js";
-import "../chunk-5QWG35A2.js";
+} from "../chunk-T54VMWHQ.js";
+import {
+  ClientNotFound,
+  FrakRpcError,
+  RpcErrorCodes,
+  compressJson,
+  decompressJson
+} from "../chunk-TPC5PMRC.js";
+import {
+  PressInteractionEncoder
+} from "../chunk-72IEHEQX.js";
+import "../chunk-PKBMQBKP.js";
 
 // src/react/provider/NexusConfigProvider.ts
 import { createContext, createElement } from "react";
@@ -15,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
   );
 }
@@ -25,8 +43,7 @@ import {
   Fragment,
   createContext as createContext2,
   createElement as createElement2,
-  useMemo,
-  useState
+  useState as useState3
 } from "react";
 
 // src/react/hook/useNexusConfig.ts
@@ -34,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;
 }
@@ -42,11 +62,7 @@ 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;
+  return useContext2(NexusIFrameClientContext);
 }
 
 // src/react/hook/useArticleUnlockOptions.ts
@@ -57,8 +73,13 @@ function useArticleUnlockOptions({
 }) {
   const client = useNexusClient();
   return useQuery({
-    queryKey: ["articleUnlockOptions", articleId ?? "no-article-id"],
+    queryKey: [
+      "nexus-sdk",
+      "article-unlock-options",
+      articleId ?? "no-article-id"
+    ],
     queryFn: async () => {
+      if (!client) return;
       if (!(articleId && contentId)) {
         throw new Error("No article id provided");
       }
@@ -67,7 +88,7 @@ function useArticleUnlockOptions({
         contentId
       });
     },
-    enabled: !!articleId && !!contentId,
+    enabled: !!client && !!articleId && !!contentId,
     gcTime: 0
   });
 }
@@ -80,17 +101,24 @@ function useWalletStatus() {
   const client = useNexusClient();
   const newStatusUpdated = useCallback(
     (event) => {
-      queryClient.setQueryData(["walletStatusListener"], event);
+      queryClient.setQueryData(
+        ["nexus-sdk", "wallet-status-listener"],
+        event
+      );
     },
     [queryClient]
   );
   return useQuery2({
     gcTime: 0,
-    queryKey: ["walletStatusListener"],
+    queryKey: ["nexus-sdk", "wallet-status-listener"],
     queryFn: async () => {
+      if (!client) {
+        return { key: "waiting-response" };
+      }
       await watchWalletStatus(client, newStatusUpdated);
       return { key: "waiting-response" };
-    }
+    },
+    enabled: !!client
   });
 }
 
@@ -107,7 +135,8 @@ function useArticleUnlockStatus({
     (event) => {
       queryClient.setQueryData(
         [
-          "articleUnlockStatusListener",
+          "nexus-sdk",
+          "article-unlock-status",
           articleId ?? "no-article-id",
           contentId ?? "no-contentId-id"
         ],
@@ -118,12 +147,19 @@ function useArticleUnlockStatus({
   );
   return useQuery3({
     queryKey: [
-      "articleUnlockStatusListener",
+      "nexus-sdk",
+      "article-unlock-status",
       articleId ?? "no-article-id",
       contentId ?? "no-contentId-id"
     ],
     gcTime: 0,
     queryFn: async () => {
+      if (!client) {
+        return {
+          status: "waiting-response",
+          key: "waiting-response"
+        };
+      }
       if (!(articleId && contentId)) {
         return null;
       }
@@ -137,43 +173,237 @@ function useArticleUnlockStatus({
         key: "waiting-response"
       };
     },
-    enabled: !!articleId && !!contentId
+    enabled: !!client && !!articleId && !!contentId
+  });
+}
+
+// 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/useSiweAuthenticate.ts
+import { useMutation as useMutation2 } from "@tanstack/react-query";
+function useSiweAuthenticate({
+  mutations
+} = {}) {
+  const client = useNexusClient();
+  return useMutation2({
+    ...mutations,
+    mutationKey: [
+      "nexus-sdk",
+      "siwe-authenticate",
+      client?.config.domain ?? "no-domain"
+    ],
+    mutationFn: async (params) => {
+      if (!client) {
+        throw new ClientNotFound();
+      }
+      return siweAuthenticate(client, params);
+    }
   });
 }
 
+// src/react/hook/helper/usePressReferralInteraction.ts
+import { useQuery as useQuery5 } from "@tanstack/react-query";
+import { useMemo as useMemo2 } from "react";
+import { isAddressEqual } from "viem";
+
+// src/react/hook/useSendInteraction.ts
+import { useMutation as useMutation3 } from "@tanstack/react-query";
+function useSendInteraction({
+  mutations
+} = {}) {
+  const client = useNexusClient();
+  return useMutation3({
+    ...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 useMutation4, useQuery as useQuery4 } from "@tanstack/react-query";
+
+// 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);
+  useEffect(() => {
+    setMounted(true);
+  }, []);
+  return mounted;
+}
+
+// src/react/hook/utils/useWindowLocation.ts
+function useWindowLocation() {
+  const isMounted = useMounted();
+  const [location, setLocation] = useState2(
+    isMounted ? window.location : void 0
+  );
+  useEffect2(() => {
+    if (!isMounted) return;
+    function setWindowLocation() {
+      setLocation(window.location);
+    }
+    if (!location) {
+      setWindowLocation();
+    }
+    window.addEventListener("popstate", setWindowLocation);
+    return () => {
+      window.removeEventListener("popstate", setWindowLocation);
+    };
+  }, [isMounted, location]);
+  const href = useMemo(() => location?.href, [location?.href]);
+  return { location, href };
+}
+
+// src/react/hook/utils/useNexusContext.ts
+var contextKey = "nCtx";
+function useNexusContext() {
+  const { location } = useWindowLocation();
+  const { data: nexusContext } = useQuery4({
+    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;
+    }
+  });
+  const { mutate: updateContext, mutateAsync: updateContextAsync } = useMutation4({
+    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());
+    }
+  });
+  return { nexusContext, updateContext, updateContextAsync };
+}
+
+// src/react/hook/helper/usePressReferralInteraction.ts
+function usePressReferralInteraction({ contentId }) {
+  const { nexusContext, updateContextAsync } = useNexusContext();
+  const { data: walletStatus } = useWalletStatus();
+  const { mutateAsync: sendInteraction2 } = useSendInteraction();
+  const { data, error, status } = useQuery5({
+    gcTime: 0,
+    queryKey: [
+      "nexus-sdk",
+      "auto-press-referral-interaction",
+      nexusContext?.r ?? "no-referrer",
+      walletStatus?.key ?? "no-wallet-status"
+    ],
+    queryFn: async () => {
+      if (!nexusContext && walletStatus?.key === "connected") {
+        await updateContextAsync({ r: walletStatus.wallet });
+        return null;
+      }
+      if (!nexusContext || walletStatus?.key !== "connected") return null;
+      if (isAddressEqual(nexusContext.r, walletStatus.wallet))
+        return null;
+      const interaction = PressInteractionEncoder.referred({
+        referrer: nexusContext.r
+      });
+      await sendInteraction2({ contentId, interaction });
+      await updateContextAsync({ r: walletStatus.wallet });
+      return { referrer: nexusContext.r };
+    }
+  });
+  return useOutputStateMapper({ data, error, status });
+}
+function useOutputStateMapper({
+  data,
+  error,
+  status
+}) {
+  const errorState = useMemo2(() => {
+    if (!(error instanceof FrakRpcError)) return null;
+    switch (error.code) {
+      case RpcErrorCodes.walletNotConnected:
+        return "no-wallet";
+      case RpcErrorCodes.noInteractionSession:
+        return "no-session";
+      default:
+        return "error";
+    }
+  }, [error]);
+  return useMemo2(() => {
+    switch (status) {
+      case "pending":
+        return "loading";
+      case "success":
+        return data === null ? "no-referral" : "referred";
+      case "error":
+        return errorState ?? "error";
+    }
+  }, [data, errorState, status]);
+}
+
 // src/react/provider/NexusIFrameClientProvider.ts
 var NexusIFrameClientContext = createContext2(
   void 0
 );
+var defaultIframeStyle = {
+  width: "0",
+  height: "0",
+  border: "0",
+  position: "absolute",
+  zIndex: 1e3,
+  top: "-1000px",
+  left: "-1000px"
+};
 function NexusIFrameClientProvider({
+  style,
   children
 }) {
   const config = useNexusConfig();
-  const [iframeElem, setIframeElem] = useState(
-    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",
     src: `${config.walletUrl}/listener`,
-    style: {
-      width: "0",
-      height: "0",
-      border: "0",
-      position: "absolute",
-      top: "-1000px",
-      left: "-1000px"
-    },
+    style: style ?? defaultIframeStyle,
+    allow: "publickey-credentials-get *",
     ref: (iframe) => {
-      if (!iframe) {
-        setIframeElem(void 0);
+      if (!iframe || client) {
         return;
       }
-      setIframeElem(iframe);
+      setClient(
+        createIFrameNexusClient({
+          iframe,
+          config
+        })
+      );
     }
   });
   const providerComponent = createElement2(
@@ -192,5 +422,9 @@ export {
   useArticleUnlockStatus,
   useNexusClient,
   useNexusConfig,
+  usePressReferralInteraction,
+  useSendInteraction,
+  useSendTransactionAction,
+  useSiweAuthenticate,
   useWalletStatus
 };

package/dist/{watchUnlockStatus-DQYfUj46.d.ts → watchUnlockStatus-CxnibdQx.d.cts}

@@ -1,5 +1,5 @@
 import { Hex } from 'viem';
-import { N as NexusClient, A as ArticleUnlockStatusReturnType } from './client-MgLVRfPw.js';
+import { N as NexusClient, A as ArticleUnlockStatusReturnType } from './client--U_6SK0l.cjs';
 
 /**
  * Type used to get the unlock options
@@ -15,11 +15,11 @@ type GetUnlockOptionsParams = {
  * @param contentId
  */
 declare function getArticleUnlockOptions(client: NexusClient, { articleId, contentId }: GetUnlockOptionsParams): Promise<Readonly<{
-    frkBalanceAsHex?: `0x${string}` | undefined;
+    frkBalanceAsHex?: Hex;
     prices: {
         index: number;
         unlockDurationInSec: number;
-        frkAmount: `0x${string}`;
+        frkAmount: Hex;
         isUserAccessible: boolean | null;
     }[];
 }>>;

package/dist/{watchUnlockStatus-DqWkImYK.d.cts → watchUnlockStatus-g8wIxpeM.d.ts}

@@ -1,5 +1,5 @@
 import { Hex } from 'viem';
-import { N as NexusClient, A as ArticleUnlockStatusReturnType } from './client-MgLVRfPw.cjs';
+import { N as NexusClient, A as ArticleUnlockStatusReturnType } from './client-6_BJp7Ub.js';
 
 /**
  * Type used to get the unlock options
@@ -15,11 +15,11 @@ type GetUnlockOptionsParams = {
  * @param contentId
  */
 declare function getArticleUnlockOptions(client: NexusClient, { articleId, contentId }: GetUnlockOptionsParams): Promise<Readonly<{
-    frkBalanceAsHex?: `0x${string}` | undefined;
+    frkBalanceAsHex?: Hex;
     prices: {
         index: number;
         unlockDurationInSec: number;
-        frkAmount: `0x${string}`;
+        frkAmount: Hex;
         isUserAccessible: boolean | null;
     }[];
 }>>;

package/package.json

@@ -11,7 +11,7 @@
       "url": "https://twitter.com/QNivelais"
     }
   ],
-  "version": "0.0.8",
+  "version": "0.0.10",
   "description": "Nexus Wallet client SDK, helping any person to interact with the Frak wallet, and require the unlock of a premium article within the Frak ecosystem.",
   "repository": "https://github.com/frak-id/wallet",
   "homepage": "https://docs.frak.id/wallet-sdk",
@@ -49,6 +49,11 @@
       "import": "./dist/core/actions/index.js",
       "default": "./dist/core/actions/index.cjs"
     },
+    "./interactions": {
+      "types": "./dist/core/interactions/index.d.ts",
+      "import": "./dist/core/interactions/index.js",
+      "default": "./dist/core/interactions/index.cjs"
+    },
     "./react": {
       "types": "./dist/react/index.d.ts",
       "import": "./dist/react/index.js",
@@ -58,9 +63,10 @@
   "scripts": {
     "lint": "biome lint .",
     "format:check": "biome check .",
-    "format": "biome check --apply .",
+    "format": "biome check --write .",
     "clean": "rimraf dist",
-    "build": "tsup --splitting"
+    "build": "tsup --splitting",
+    "build:watch": "tsup --watch --splitting --format esm"
   },
   "peerDependencies": {
     "viem": "^2.x",
@@ -72,9 +78,9 @@
     "js-sha256": "^0.11.0"
   },
   "devDependencies": {
-    "@tanstack/react-query": ">=5.32.0",
+    "@tanstack/react-query": ">=5.49.2",
     "@types/node": "^20",
-    "tsup": "^8.0.2",
+    "tsup": "^8.1.0",
     "typescript": "^5"
   }
 }