@frak-labs/nexus-sdk 0.0.10 → 0.0.11

package/dist/react/index.js

@@ -1,24 +1,24 @@
-import {
-  createIFrameNexusClient
-} from "../chunk-HOX3RRO6.js";
-import {
-  getArticleUnlockOptions,
-  sendInteraction,
-  sendTransaction,
-  siweAuthenticate,
-  watchUnlockStatus,
-  watchWalletStatus
-} from "../chunk-T54VMWHQ.js";
 import {
   ClientNotFound,
+  Deferred,
   FrakRpcError,
   RpcErrorCodes,
+  baseIframeProps,
   compressJson,
+  createIFrameNexusClient,
   decompressJson
-} from "../chunk-TPC5PMRC.js";
+} from "../chunk-7MVQQ2X6.js";
 import {
-  PressInteractionEncoder
-} from "../chunk-72IEHEQX.js";
+  displayModal,
+  openSso,
+  sendInteraction,
+  sendTransaction,
+  siweAuthenticate,
+  watchWalletStatus
+} from "../chunk-5CFD5FM2.js";
+import {
+  ReferralInteractionEncoder
+} from "../chunk-GUDT2W6I.js";
 import "../chunk-PKBMQBKP.js";
 
 // src/react/provider/NexusConfigProvider.ts
@@ -65,36 +65,8 @@ function useNexusClient() {
   return useContext2(NexusIFrameClientContext);
 }
 
-// src/react/hook/useArticleUnlockOptions.ts
-import { useQuery } from "@tanstack/react-query";
-function useArticleUnlockOptions({
-  articleId,
-  contentId
-}) {
-  const client = useNexusClient();
-  return useQuery({
-    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");
-      }
-      return await getArticleUnlockOptions(client, {
-        articleId,
-        contentId
-      });
-    },
-    enabled: !!client && !!articleId && !!contentId,
-    gcTime: 0
-  });
-}
-
 // 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();
@@ -108,75 +80,28 @@ function useWalletStatus() {
     },
     [queryClient]
   );
-  return useQuery2({
+  return useQuery({
     gcTime: 0,
     queryKey: ["nexus-sdk", "wallet-status-listener"],
     queryFn: async () => {
       if (!client) {
-        return { key: "waiting-response" };
+        throw new ClientNotFound();
       }
-      await watchWalletStatus(client, newStatusUpdated);
-      return { key: "waiting-response" };
+      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/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();
-  const client = useNexusClient();
-  const newStatusUpdated = useCallback2(
-    (event) => {
-      queryClient.setQueryData(
-        [
-          "nexus-sdk",
-          "article-unlock-status",
-          articleId ?? "no-article-id",
-          contentId ?? "no-contentId-id"
-        ],
-        event
-      );
-    },
-    [articleId, contentId, queryClient]
-  );
-  return useQuery3({
-    queryKey: [
-      "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;
-      }
-      await watchUnlockStatus(
-        client,
-        { articleId, contentId },
-        newStatusUpdated
-      );
-      return {
-        status: "waiting-response",
-        key: "waiting-response"
-      };
-    },
-    enabled: !!client && !!articleId && !!contentId
-  });
-}
-
 // src/react/hook/useSendTransaction.ts
 import { useMutation } from "@tanstack/react-query";
 function useSendTransactionAction({
@@ -217,18 +142,36 @@ function useSiweAuthenticate({
   });
 }
 
-// src/react/hook/helper/usePressReferralInteraction.ts
-import { useQuery as useQuery5 } from "@tanstack/react-query";
-import { useMemo as useMemo2 } 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/useSendInteraction.ts
+// src/react/hook/useDisplayModal.ts
 import { useMutation as useMutation3 } from "@tanstack/react-query";
-function useSendInteraction({
+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) => {
@@ -241,7 +184,7 @@ function useSendInteraction({
 }
 
 // src/react/hook/utils/useNexusContext.ts
-import { useMutation as useMutation4, useQuery as useQuery4 } from "@tanstack/react-query";
+import { useMutation as useMutation5, useQuery as useQuery2 } from "@tanstack/react-query";
 
 // src/react/hook/utils/useWindowLocation.ts
 import { useEffect as useEffect2, useMemo, useState as useState2 } from "react";
@@ -283,7 +226,7 @@ function useWindowLocation() {
 var contextKey = "nCtx";
 function useNexusContext() {
   const { location } = useWindowLocation();
-  const { data: nexusContext } = useQuery4({
+  const { data: nexusContext } = useQuery2({
     queryKey: ["nexus-sdk", "context", location?.href ?? "no-href"],
     queryFn: async () => {
       if (!location?.href) return null;
@@ -293,9 +236,10 @@ function useNexusContext() {
       const parsedContext = await decompressJson(nexusContext2);
       if (!parsedContext) return null;
       return parsedContext;
-    }
+    },
+    enabled: !!location?.href
   });
-  const { mutate: updateContext, mutateAsync: updateContextAsync } = useMutation4({
+  const { mutate: updateContext, mutateAsync: updateContextAsync } = useMutation5({
     mutationKey: ["nexus-sdk", "update-context"],
     mutationFn: async (newContext) => {
       if (!location || typeof window === "undefined") return;
@@ -307,47 +251,95 @@ function useNexusContext() {
       window.history.replaceState(null, "", url.toString());
     }
   });
-  return { nexusContext, updateContext, updateContextAsync };
+  return {
+    nexusContext,
+    updateContext,
+    updateContextAsync
+  };
 }
 
-// src/react/hook/helper/usePressReferralInteraction.ts
-function usePressReferralInteraction({ contentId }) {
+// src/react/hook/helper/useReferralInteraction.ts
+function useReferralInteraction({
+  contentId,
+  modalConfig
+} = {}) {
   const { nexusContext, updateContextAsync } = useNexusContext();
   const { data: walletStatus } = useWalletStatus();
   const { mutateAsync: sendInteraction2 } = useSendInteraction();
-  const { data, error, status } = useQuery5({
+  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);
+    }
+  }, [
+    nexusContext,
+    contentId,
+    ensureWalletConnected,
+    sendInteraction2,
+    updateContextAsync
+  ]);
+  const {
+    data: referralState,
+    error,
+    status
+  } = useQuery3({
     gcTime: 0,
+    staleTime: 0,
     queryKey: [
       "nexus-sdk",
-      "auto-press-referral-interaction",
+      "auto-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 };
-    }
+    queryFn: processReferral,
+    enabled: !!walletStatus
   });
-  return useOutputStateMapper({ data, error, status });
+  return useMemo2(() => {
+    if (status === "pending") return "processing";
+    if (status === "error") return mapErrorToState(error);
+    return referralState || "idle";
+  }, [referralState, status, error]);
 }
-function useOutputStateMapper({
-  data,
-  error,
-  status
+function useEnsureWalletConnected({
+  modalConfig,
+  walletStatus
 }) {
-  const errorState = useMemo2(() => {
-    if (!(error instanceof FrakRpcError)) return null;
+  const { mutateAsync: displayModal2 } = useDisplayModal();
+  return useCallback2(async () => {
+    if (walletStatus?.key !== "connected" || !walletStatus.interactionSession) {
+      if (!modalConfig) {
+        return void 0;
+      }
+      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";
@@ -356,32 +348,30 @@ function useOutputStateMapper({
       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";
+  }
+  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();
+      }
+      return openSso(client, params);
     }
-  }, [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
@@ -389,11 +379,9 @@ function NexusIFrameClientProvider({
   const config = useNexusConfig();
   const [client, setClient] = useState3(void 0);
   const iFrame = createElement2("iframe", {
-    id: "nexus-wallet",
-    name: "nexus-wallet",
+    ...baseIframeProps,
     src: `${config.walletUrl}/listener`,
-    style: style ?? defaultIframeStyle,
-    allow: "publickey-credentials-get *",
+    style: style ?? baseIframeProps.style,
     ref: (iframe) => {
       if (!iframe || client) {
         return;
@@ -418,11 +406,11 @@ export {
   NexusConfigProvider,
   NexusIFrameClientContext,
   NexusIFrameClientProvider,
-  useArticleUnlockOptions,
-  useArticleUnlockStatus,
+  useDisplayModal,
   useNexusClient,
   useNexusConfig,
-  usePressReferralInteraction,
+  useOpenSso,
+  useReferralInteraction,
   useSendInteraction,
   useSendTransactionAction,
   useSiweAuthenticate,

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 };

package/package.json

@@ -11,9 +11,12 @@
       "url": "https://twitter.com/QNivelais"
     }
   ],
-  "version": "0.0.10",
+  "version": "0.0.11",
   "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",
+  "repository": {
+    "url": "https://github.com/frak-id/wallet",
+    "directory": "packages/sdk"
+  },
   "homepage": "https://docs.frak.id/wallet-sdk",
   "keywords": [
     "frak-labs",
@@ -78,9 +81,9 @@
     "js-sha256": "^0.11.0"
   },
   "devDependencies": {
-    "@tanstack/react-query": ">=5.49.2",
-    "@types/node": "^20",
-    "tsup": "^8.1.0",
+    "@tanstack/react-query": ">=5.51.15",
+    "@types/node": "^22",
+    "tsup": "^8.2.3",
     "typescript": "^5"
   }
 }

package/dist/chunk-3T2FNW6E.cjs

@@ -1,100 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }
-
-
-var _chunkBPFJZRJ6cjs = require('./chunk-BPFJZRJ6.cjs');
-
-// src/core/actions/getUnlockOptions.ts
-function getArticleUnlockOptions(client, { articleId, contentId }) {
-  return client.request({
-    method: "frak_getArticleUnlockOptions",
-    params: [contentId, articleId]
-  });
-}
-
-// src/core/actions/watchUnlockStatus.ts
-function watchUnlockStatus(client, { articleId, contentId }, callback) {
-  return client.listenerRequest(
-    {
-      method: "frak_listenToArticleUnlockStatus",
-      params: [contentId, articleId]
-    },
-    callback
-  );
-}
-
-// src/core/actions/watchWalletStatus.ts
-function watchWalletStatus(client, callback) {
-  return client.listenerRequest(
-    {
-      method: "frak_listenToWalletStatus"
-    },
-    callback
-  );
-}
-
-// src/core/actions/startUnlock.ts
-async function getStartArticleUnlockUrl(config, params) {
-  const { compressed, compressedHash } = await _chunkBPFJZRJ6cjs.hashAndCompressData.call(void 0, {
-    method: "frak_startArticleUnlock",
-    params
-  });
-  const outputUrl = new URL(config.walletUrl);
-  outputUrl.pathname = "/paywall";
-  outputUrl.searchParams.set("params", encodeURIComponent(compressed));
-  outputUrl.searchParams.set("hash", encodeURIComponent(compressedHash));
-  return outputUrl.toString();
-}
-async function decodeStartUnlockReturn({
-  result,
-  hash
-}) {
-  return _chunkBPFJZRJ6cjs.decompressDataAndCheckHash.call(void 0, {
-    compressed: decodeURIComponent(result),
-    compressedHash: decodeURIComponent(hash)
-  });
-}
-
-// src/core/actions/sendTransaction.ts
-async function sendTransaction(client, { tx, context }) {
-  return await client.request({
-    method: "frak_sendTransaction",
-    params: [tx, context]
-  });
-}
-
-// src/core/actions/siweAuthenticate.ts
-var _siwe = require('viem/siwe');
-async function siweAuthenticate(client, { siwe, context }) {
-  const realStatement = _nullishCoalesce(_optionalChain([siwe, 'optionalAccess', _ => _.statement]), () => ( `I confirm that I want to use my Nexus wallet on: ${client.config.metadata.name}`));
-  const builtSiwe = {
-    ...siwe,
-    statement: realStatement,
-    nonce: _nullishCoalesce(_optionalChain([siwe, 'optionalAccess', _2 => _2.nonce]), () => ( _siwe.generateSiweNonce.call(void 0, ))),
-    uri: _nullishCoalesce(_optionalChain([siwe, 'optionalAccess', _3 => _3.uri]), () => ( `https://${client.config.domain}`)),
-    version: _nullishCoalesce(_optionalChain([siwe, 'optionalAccess', _4 => _4.version]), () => ( "1")),
-    domain: client.config.domain
-  };
-  return await client.request({
-    method: "frak_siweAuthenticate",
-    params: [builtSiwe, context]
-  });
-}
-
-// src/core/actions/sendInteraction.ts
-async function sendInteraction(client, { contentId, interaction, validation }) {
-  return await client.request({
-    method: "frak_sendInteraction",
-    params: [contentId, interaction, validation]
-  });
-}
-
-
-
-
-
-
-
-
-
-
-exports.getArticleUnlockOptions = getArticleUnlockOptions; exports.watchUnlockStatus = watchUnlockStatus; exports.watchWalletStatus = watchWalletStatus; exports.getStartArticleUnlockUrl = getStartArticleUnlockUrl; exports.decodeStartUnlockReturn = decodeStartUnlockReturn; exports.sendTransaction = sendTransaction; exports.siweAuthenticate = siweAuthenticate; exports.sendInteraction = sendInteraction;