@frak-labs/nexus-sdk 0.0.8 → 0.0.10

package/dist/react/index.cjs

@@ -1,12 +1,25 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }
+"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 _chunkJXQKTLEEcjs = require('../chunk-JXQKTLEE.cjs');
+var _chunkSGLR6RFAcjs = require('../chunk-SGLR6RFA.cjs');
 
 
 
 
-var _chunk6V4UCVTDcjs = require('../chunk-6V4UCVTD.cjs');
-require('../chunk-2XUJYDD3.cjs');
+
+
+
+var _chunk3T2FNW6Ecjs = require('../chunk-3T2FNW6E.cjs');
+
+
+
+
+
+
+var _chunkBPFJZRJ6cjs = require('../chunk-BPFJZRJ6.cjs');
+
+
+var _chunkNIFJZD3Mcjs = require('../chunk-NIFJZD3M.cjs');
+require('../chunk-ETV4XYOV.cjs');
 
 // src/react/provider/NexusConfigProvider.ts
 var _react = require('react');
@@ -15,7 +28,12 @@ function NexusConfigProvider(parameters) {
   const { children, config } = parameters;
   return _react.createElement.call(void 0, 
     NexusConfigContext.Provider,
-    { value: config },
+    {
+      value: {
+        ...config,
+        domain: _nullishCoalesce(_nullishCoalesce(config.domain, () => ( (typeof window !== "undefined" ? _optionalChain([window, 'optionalAccess', _ => _.location, 'optionalAccess', _2 => _2.host]) : void 0))), () => ( "not-found"))
+      }
+    },
     children
   );
 }
@@ -28,13 +46,15 @@ function NexusConfigProvider(parameters) {
 
 
 
-
 // src/react/hook/useNexusConfig.ts
 
 function useNexusConfig() {
   const config = _react.useContext.call(void 0, NexusConfigContext);
   if (!config) {
-    throw new Error("NexusConfigProvider is not found");
+    throw new (0, _chunkBPFJZRJ6cjs.FrakRpcError)(
+      _chunkBPFJZRJ6cjs.RpcErrorCodes.configError,
+      "Nexus config not found"
+    );
   }
   return config;
 }
@@ -42,11 +62,7 @@ function useNexusConfig() {
 // src/react/hook/useNexusClient.ts
 
 function useNexusClient() {
-  const client = _react.useContext.call(void 0, NexusIFrameClientContext);
-  if (!client) {
-    throw new Error("NexusIFrameClientProvider is not found");
-  }
-  return client;
+  return _react.useContext.call(void 0, NexusIFrameClientContext);
 }
 
 // src/react/hook/useArticleUnlockOptions.ts
@@ -57,17 +73,22 @@ function useArticleUnlockOptions({
 }) {
   const client = useNexusClient();
   return _reactquery.useQuery.call(void 0, {
-    queryKey: ["articleUnlockOptions", _nullishCoalesce(articleId, () => ( "no-article-id"))],
+    queryKey: [
+      "nexus-sdk",
+      "article-unlock-options",
+      _nullishCoalesce(articleId, () => ( "no-article-id"))
+    ],
     queryFn: async () => {
+      if (!client) return;
       if (!(articleId && contentId)) {
         throw new Error("No article id provided");
       }
-      return await _chunk6V4UCVTDcjs.getArticleUnlockOptions.call(void 0, client, {
+      return await _chunk3T2FNW6Ecjs.getArticleUnlockOptions.call(void 0, client, {
         articleId,
         contentId
       });
     },
-    enabled: !!articleId && !!contentId,
+    enabled: !!client && !!articleId && !!contentId,
     gcTime: 0
   });
 }
@@ -80,17 +101,24 @@ function useWalletStatus() {
   const client = useNexusClient();
   const newStatusUpdated = _react.useCallback.call(void 0, 
     (event) => {
-      queryClient.setQueryData(["walletStatusListener"], event);
+      queryClient.setQueryData(
+        ["nexus-sdk", "wallet-status-listener"],
+        event
+      );
     },
     [queryClient]
   );
   return _reactquery.useQuery.call(void 0, {
     gcTime: 0,
-    queryKey: ["walletStatusListener"],
+    queryKey: ["nexus-sdk", "wallet-status-listener"],
     queryFn: async () => {
-      await _chunk6V4UCVTDcjs.watchWalletStatus.call(void 0, client, newStatusUpdated);
+      if (!client) {
+        return { key: "waiting-response" };
+      }
+      await _chunk3T2FNW6Ecjs.watchWalletStatus.call(void 0, client, newStatusUpdated);
       return { key: "waiting-response" };
-    }
+    },
+    enabled: !!client
   });
 }
 
@@ -107,7 +135,8 @@ function useArticleUnlockStatus({
     (event) => {
       queryClient.setQueryData(
         [
-          "articleUnlockStatusListener",
+          "nexus-sdk",
+          "article-unlock-status",
           _nullishCoalesce(articleId, () => ( "no-article-id")),
           _nullishCoalesce(contentId, () => ( "no-contentId-id"))
         ],
@@ -118,16 +147,23 @@ function useArticleUnlockStatus({
   );
   return _reactquery.useQuery.call(void 0, {
     queryKey: [
-      "articleUnlockStatusListener",
+      "nexus-sdk",
+      "article-unlock-status",
       _nullishCoalesce(articleId, () => ( "no-article-id")),
       _nullishCoalesce(contentId, () => ( "no-contentId-id"))
     ],
     gcTime: 0,
     queryFn: async () => {
+      if (!client) {
+        return {
+          status: "waiting-response",
+          key: "waiting-response"
+        };
+      }
       if (!(articleId && contentId)) {
         return null;
       }
-      await _chunk6V4UCVTDcjs.watchUnlockStatus.call(void 0, 
+      await _chunk3T2FNW6Ecjs.watchUnlockStatus.call(void 0, 
         client,
         { articleId, contentId },
         newStatusUpdated
@@ -137,43 +173,237 @@ function useArticleUnlockStatus({
         key: "waiting-response"
       };
     },
-    enabled: !!articleId && !!contentId
+    enabled: !!client && !!articleId && !!contentId
+  });
+}
+
+// src/react/hook/useSendTransaction.ts
+
+function useSendTransactionAction({
+  mutations
+} = {}) {
+  const client = useNexusClient();
+  return _reactquery.useMutation.call(void 0, {
+    ...mutations,
+    mutationKey: ["nexus-sdk", "send-transaction"],
+    mutationFn: async (params) => {
+      if (!client) {
+        throw new (0, _chunkBPFJZRJ6cjs.ClientNotFound)();
+      }
+      return _chunk3T2FNW6Ecjs.sendTransaction.call(void 0, client, params);
+    }
+  });
+}
+
+// src/react/hook/useSiweAuthenticate.ts
+
+function useSiweAuthenticate({
+  mutations
+} = {}) {
+  const client = useNexusClient();
+  return _reactquery.useMutation.call(void 0, {
+    ...mutations,
+    mutationKey: [
+      "nexus-sdk",
+      "siwe-authenticate",
+      _nullishCoalesce(_optionalChain([client, 'optionalAccess', _3 => _3.config, 'access', _4 => _4.domain]), () => ( "no-domain"))
+    ],
+    mutationFn: async (params) => {
+      if (!client) {
+        throw new (0, _chunkBPFJZRJ6cjs.ClientNotFound)();
+      }
+      return _chunk3T2FNW6Ecjs.siweAuthenticate.call(void 0, client, params);
+    }
+  });
+}
+
+// src/react/hook/helper/usePressReferralInteraction.ts
+
+
+var _viem = require('viem');
+
+// src/react/hook/useSendInteraction.ts
+
+function useSendInteraction({
+  mutations
+} = {}) {
+  const client = useNexusClient();
+  return _reactquery.useMutation.call(void 0, {
+    ...mutations,
+    mutationKey: ["nexus-sdk", "send-interaction"],
+    mutationFn: async (params) => {
+      if (!client) {
+        throw new (0, _chunkBPFJZRJ6cjs.ClientNotFound)();
+      }
+      return _chunk3T2FNW6Ecjs.sendInteraction.call(void 0, client, params);
+    }
+  });
+}
+
+// src/react/hook/utils/useNexusContext.ts
+
+
+// src/react/hook/utils/useWindowLocation.ts
+
+
+// src/react/hook/utils/useMounted.ts
+
+function useMounted() {
+  const [mounted, setMounted] = _react.useState.call(void 0, false);
+  _react.useEffect.call(void 0, () => {
+    setMounted(true);
+  }, []);
+  return mounted;
+}
+
+// src/react/hook/utils/useWindowLocation.ts
+function useWindowLocation() {
+  const isMounted = useMounted();
+  const [location, setLocation] = _react.useState.call(void 0, 
+    isMounted ? window.location : void 0
+  );
+  _react.useEffect.call(void 0, () => {
+    if (!isMounted) return;
+    function setWindowLocation() {
+      setLocation(window.location);
+    }
+    if (!location) {
+      setWindowLocation();
+    }
+    window.addEventListener("popstate", setWindowLocation);
+    return () => {
+      window.removeEventListener("popstate", setWindowLocation);
+    };
+  }, [isMounted, location]);
+  const href = _react.useMemo.call(void 0, () => _optionalChain([location, 'optionalAccess', _5 => _5.href]), [_optionalChain([location, 'optionalAccess', _6 => _6.href])]);
+  return { location, href };
+}
+
+// src/react/hook/utils/useNexusContext.ts
+var contextKey = "nCtx";
+function useNexusContext() {
+  const { location } = useWindowLocation();
+  const { data: nexusContext } = _reactquery.useQuery.call(void 0, {
+    queryKey: ["nexus-sdk", "context", _nullishCoalesce(_optionalChain([location, 'optionalAccess', _7 => _7.href]), () => ( "no-href"))],
+    queryFn: async () => {
+      if (!_optionalChain([location, 'optionalAccess', _8 => _8.href])) return null;
+      const url = new URL(location.href);
+      const nexusContext2 = url.searchParams.get(contextKey);
+      if (!nexusContext2) return null;
+      const parsedContext = await _chunkBPFJZRJ6cjs.decompressJson.call(void 0, nexusContext2);
+      if (!parsedContext) return null;
+      return parsedContext;
+    }
+  });
+  const { mutate: updateContext, mutateAsync: updateContextAsync } = _reactquery.useMutation.call(void 0, {
+    mutationKey: ["nexus-sdk", "update-context"],
+    mutationFn: async (newContext) => {
+      if (!location || typeof window === "undefined") return;
+      const fullNewContext = nexusContext ? { ...nexusContext, ...newContext } : newContext;
+      const compressedContext = await _chunkBPFJZRJ6cjs.compressJson.call(void 0, 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 } = _reactquery.useQuery.call(void 0, {
+    gcTime: 0,
+    queryKey: [
+      "nexus-sdk",
+      "auto-press-referral-interaction",
+      _nullishCoalesce(_optionalChain([nexusContext, 'optionalAccess', _9 => _9.r]), () => ( "no-referrer")),
+      _nullishCoalesce(_optionalChain([walletStatus, 'optionalAccess', _10 => _10.key]), () => ( "no-wallet-status"))
+    ],
+    queryFn: async () => {
+      if (!nexusContext && _optionalChain([walletStatus, 'optionalAccess', _11 => _11.key]) === "connected") {
+        await updateContextAsync({ r: walletStatus.wallet });
+        return null;
+      }
+      if (!nexusContext || _optionalChain([walletStatus, 'optionalAccess', _12 => _12.key]) !== "connected") return null;
+      if (_viem.isAddressEqual.call(void 0, nexusContext.r, walletStatus.wallet))
+        return null;
+      const interaction = _chunkNIFJZD3Mcjs.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 = _react.useMemo.call(void 0, () => {
+    if (!(error instanceof _chunkBPFJZRJ6cjs.FrakRpcError)) return null;
+    switch (error.code) {
+      case _chunkBPFJZRJ6cjs.RpcErrorCodes.walletNotConnected:
+        return "no-wallet";
+      case _chunkBPFJZRJ6cjs.RpcErrorCodes.noInteractionSession:
+        return "no-session";
+      default:
+        return "error";
+    }
+  }, [error]);
+  return _react.useMemo.call(void 0, () => {
+    switch (status) {
+      case "pending":
+        return "loading";
+      case "success":
+        return data === null ? "no-referral" : "referred";
+      case "error":
+        return _nullishCoalesce(errorState, () => ( "error"));
+    }
+  }, [data, errorState, status]);
 }
 
 // src/react/provider/NexusIFrameClientProvider.ts
 var NexusIFrameClientContext = _react.createContext.call(void 0, 
   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] = _react.useState.call(void 0, 
-    void 0
-  );
-  const client = _react.useMemo.call(void 0, 
-    () => iframeElem ? _chunkJXQKTLEEcjs.createIFrameNexusClient.call(void 0, { iframe: iframeElem, config }) : void 0,
-    [iframeElem, config]
-  );
+  const [client, setClient] = _react.useState.call(void 0, void 0);
   const iFrame = _react.createElement.call(void 0, "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: _nullishCoalesce(style, () => ( defaultIframeStyle)),
+    allow: "publickey-credentials-get *",
     ref: (iframe) => {
-      if (!iframe) {
-        setIframeElem(void 0);
+      if (!iframe || client) {
         return;
       }
-      setIframeElem(iframe);
+      setClient(
+        _chunkSGLR6RFAcjs.createIFrameNexusClient.call(void 0, {
+          iframe,
+          config
+        })
+      );
     }
   });
   const providerComponent = _react.createElement.call(void 0, 
@@ -193,4 +423,8 @@ function NexusIFrameClientProvider({
 
 
 
-exports.NexusConfigContext = NexusConfigContext; exports.NexusConfigProvider = NexusConfigProvider; exports.NexusIFrameClientContext = NexusIFrameClientContext; exports.NexusIFrameClientProvider = NexusIFrameClientProvider; exports.useArticleUnlockOptions = useArticleUnlockOptions; exports.useArticleUnlockStatus = useArticleUnlockStatus; exports.useNexusClient = useNexusClient; exports.useNexusConfig = useNexusConfig; exports.useWalletStatus = useWalletStatus;
+
+
+
+
+exports.NexusConfigContext = NexusConfigContext; exports.NexusConfigProvider = NexusConfigProvider; exports.NexusIFrameClientContext = NexusIFrameClientContext; exports.NexusIFrameClientProvider = NexusIFrameClientProvider; exports.useArticleUnlockOptions = useArticleUnlockOptions; exports.useArticleUnlockStatus = useArticleUnlockStatus; exports.useNexusClient = useNexusClient; exports.useNexusConfig = useNexusConfig; exports.usePressReferralInteraction = usePressReferralInteraction; exports.useSendInteraction = useSendInteraction; exports.useSendTransactionAction = useSendTransactionAction; exports.useSiweAuthenticate = useSiweAuthenticate; exports.useWalletStatus = useWalletStatus;

package/dist/react/index.d.cts

@@ -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.cjs';
+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--U_6SK0l.cjs';
 import * as _tanstack_react_query from '@tanstack/react-query';
-import { G as GetUnlockOptionsParams, W as WatchUnlockStatusParams } from '../watchUnlockStatus-DqWkImYK.cjs';
-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-CxnibdQx.cjs';
+import { F as FrakRpcError } from '../error-C4Zm5nQe.cjs';
+import { S as SendInteractionParamsType, a as SendInteractionReturnType } from '../interaction-D_CzyqRE.cjs';
 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 };