@frak-labs/nexus-sdk 0.0.9 → 0.0.11

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, e as SetUserReferredParams, c as SetUserReferredReturnType } from '../client-BwzXSgqQ.cjs';
+import { PropsWithChildren, CSSProperties, ReactNode } from 'react';
+import { f as NexusWalletSdkConfig, N as NexusClient, W as WalletStatusReturnType, c as SendTransactionReturnType, a as SiweAuthenticateReturnType, D as DisplayModalParamsType, d as ModalStepTypes, e as ModalRpcStepsResultType, O as OpenSsoParamsType } from '../client-C7u9zGwC.cjs';
 import * as _tanstack_react_query from '@tanstack/react-query';
-import { G as GetUnlockOptionsParams, W as WatchUnlockStatusParams } from '../watchUnlockStatus-DXClCYH9.cjs';
-import 'viem';
+import { UseMutationOptions } from '@tanstack/react-query';
+import * as viem from 'viem';
+import { Hex } from 'viem';
+import { F as FrakRpcError } from '../error-C4Zm5nQe.cjs';
+import { b as SendTransactionParams, S as SiweAuthenticateModalParams } from '../sendTransaction-BZW627cT.cjs';
+import { S as SendInteractionParamsType, a as SendInteractionReturnType } from '../interaction-D3-M3nBh.cjs';
 import 'viem/chains';
+import 'viem/siwe';
 
 /**
  * The context that will keep the Nexus Wallet SDK configuration
@@ -13,13 +18,17 @@ declare const NexusConfigContext: react.Context<Readonly<{
     walletUrl: string;
     metadata: {
         name: string;
+        css?: 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
@@ -30,7 +39,9 @@ declare function NexusConfigProvider(parameters: PropsWithChildren<NexusConfigPr
     walletUrl: string;
     metadata: {
         name: string;
+        css?: string;
     };
+    domain: string;
 }> | undefined>>;
 
 /**
@@ -49,10 +60,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;
 }>;
 
 /**
@@ -62,52 +74,83 @@ declare function useNexusConfig(): Readonly<{
     walletUrl: string;
     metadata: {
         name: string;
+        css?: 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
+ * Hooks used to listen to the current wallet status
  */
-declare function useArticleUnlockOptions({ articleId, contentId, }: GetUnlockOptionsParams): _tanstack_react_query.UseQueryResult<Readonly<{
-    frkBalanceAsHex?: `0x${string}` | undefined;
-    prices: {
-        index: number;
-        unlockDurationInSec: number;
-        frkAmount: `0x${string}`;
-        isUserAccessible: boolean | null;
-    }[];
-}>, Error>;
+declare function useWalletStatus(): _tanstack_react_query.UseQueryResult<WalletStatusReturnType, Error>;
 
-type WalletStatusQueryReturnType = WalletStatusReturnType | {
-    key: "waiting-response";
-};
+type MutationOptions$4 = Omit<UseMutationOptions<SendTransactionReturnType, FrakRpcError, SendTransactionParams>, "mutationFn" | "mutationKey">;
+interface UseSendTransactionParams {
+    mutations?: MutationOptions$4;
+}
 /**
- * Hooks used to listen to the current wallet status
+ * Trigger a dashboard action to the wallet
  */
-declare function useWalletStatus(): _tanstack_react_query.UseQueryResult<WalletStatusQueryReturnType, Error>;
+declare function useSendTransactionAction({ mutations, }?: UseSendTransactionParams): _tanstack_react_query.UseMutationResult<Readonly<{
+    hash: viem.Hex;
+}>, FrakRpcError<undefined>, SendTransactionParams, unknown>;
 
-type ArticleUnlockStatusQueryReturnType = ArticleUnlockStatusReturnType | {
-    status: "waiting-response";
-    key: "waiting-response";
-};
+type MutationOptions$3 = Omit<UseMutationOptions<SiweAuthenticateReturnType, FrakRpcError, SiweAuthenticateModalParams>, "mutationFn" | "mutationKey">;
+interface UseSiweAuthenticateParams {
+    mutations?: MutationOptions$3;
+}
 /**
- * Hooks used to listen to the current article unlock status
+ * Trigger a dashboard action to the wallet
  */
-declare function useArticleUnlockStatus({ articleId, contentId, }: WatchUnlockStatusParams): _tanstack_react_query.UseQueryResult<ArticleUnlockStatusQueryReturnType | null, Error>;
+declare function useSiweAuthenticate({ mutations, }?: UseSiweAuthenticateParams): _tanstack_react_query.UseMutationResult<Readonly<{
+    signature: viem.Hex;
+    message: string;
+}>, FrakRpcError<undefined>, SiweAuthenticateModalParams, unknown>;
 
-type SetUserReferredQueryReturnType = SetUserReferredReturnType | {
-    key: "waiting-response";
-} | {
-    key: "no-referrer";
-};
+type ReferralState = "idle" | "processing" | "success" | "no-wallet" | "no-session" | "error" | "no-referrer" | "self-referral";
+/**
+ * Helper hook to automatically submit a referral interaction when detected
+ *   -> And automatically set the referral context in the url
+ * @param contentId
+ * @param modalConfig
+ */
+declare function useReferralInteraction({ contentId, modalConfig, }?: {
+    contentId?: Hex;
+    modalConfig?: DisplayModalParamsType<ModalStepTypes[]>;
+}): ReferralState;
+
+type MutationOptions$2 = Omit<UseMutationOptions<SendInteractionReturnType, FrakRpcError, SendInteractionParamsType>, "mutationFn" | "mutationKey">;
+interface UseSendInteractionParams$1 {
+    mutations?: MutationOptions$2;
+}
+/**
+ * Send a user interaction
+ */
+declare function useSendInteraction({ mutations, }?: UseSendInteractionParams$1): _tanstack_react_query.UseMutationResult<Readonly<{
+    delegationId: string;
+}>, FrakRpcError<undefined>, SendInteractionParamsType, unknown>;
+
+type MutationOptions$1<T extends ModalStepTypes[]> = Omit<UseMutationOptions<ModalRpcStepsResultType<T>, FrakRpcError, DisplayModalParamsType<T>>, "mutationFn" | "mutationKey">;
+interface UseDisplayModalParams<T extends ModalStepTypes[] = ModalStepTypes[]> {
+    mutations?: MutationOptions$1<T>;
+}
+/**
+ * Send a user interaction
+ */
+declare function useDisplayModal<T extends ModalStepTypes[] = ModalStepTypes[]>({ mutations, }?: UseDisplayModalParams<T>): _tanstack_react_query.UseMutationResult<ModalRpcStepsResultType<T>, FrakRpcError<undefined>, DisplayModalParamsType<T>, unknown>;
+
+type MutationOptions = Omit<UseMutationOptions<void, FrakRpcError, OpenSsoParamsType>, "mutationFn" | "mutationKey">;
+interface UseSendInteractionParams {
+    mutations?: MutationOptions;
+}
 /**
- * Use the current nexus referral
+ * Open the SSO
  */
-declare function useNexusReferral({ contentId }: SetUserReferredParams): _tanstack_react_query.UseQueryResult<SetUserReferredQueryReturnType, Error>;
+declare function useOpenSso({ mutations }?: UseSendInteractionParams): _tanstack_react_query.UseMutationResult<void, FrakRpcError<undefined>, OpenSsoParamsType, unknown>;
 
-export { type ArticleUnlockStatusQueryReturnType, NexusConfigContext, NexusConfigProvider, type NexusConfigProviderProps, NexusIFrameClientContext, type NexusIFrameClientProps, NexusIFrameClientProvider, type WalletStatusQueryReturnType, useArticleUnlockOptions, useArticleUnlockStatus, useNexusClient, useNexusConfig, useNexusReferral, useWalletStatus };
+export { NexusConfigContext, NexusConfigProvider, type NexusConfigProviderProps, NexusIFrameClientContext, type NexusIFrameClientProps, NexusIFrameClientProvider, useDisplayModal, useNexusClient, useNexusConfig, useOpenSso, useReferralInteraction, useSendInteraction, useSendTransactionAction, useSiweAuthenticate, useWalletStatus };

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, e as SetUserReferredParams, c as SetUserReferredReturnType } from '../client-BwzXSgqQ.js';
+import { PropsWithChildren, CSSProperties, ReactNode } from 'react';
+import { f as NexusWalletSdkConfig, N as NexusClient, W as WalletStatusReturnType, c as SendTransactionReturnType, a as SiweAuthenticateReturnType, D as DisplayModalParamsType, d as ModalStepTypes, e as ModalRpcStepsResultType, O as OpenSsoParamsType } from '../client-gE3fYzkD.js';
 import * as _tanstack_react_query from '@tanstack/react-query';
-import { G as GetUnlockOptionsParams, W as WatchUnlockStatusParams } from '../watchUnlockStatus-WJxoDliF.js';
-import 'viem';
+import { UseMutationOptions } from '@tanstack/react-query';
+import * as viem from 'viem';
+import { Hex } from 'viem';
+import { F as FrakRpcError } from '../error-C4Zm5nQe.js';
+import { b as SendTransactionParams, S as SiweAuthenticateModalParams } from '../sendTransaction-DpJTfGJc.js';
+import { S as SendInteractionParamsType, a as SendInteractionReturnType } from '../interaction-D3-M3nBh.js';
 import 'viem/chains';
+import 'viem/siwe';
 
 /**
  * The context that will keep the Nexus Wallet SDK configuration
@@ -13,13 +18,17 @@ declare const NexusConfigContext: react.Context<Readonly<{
     walletUrl: string;
     metadata: {
         name: string;
+        css?: 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
@@ -30,7 +39,9 @@ declare function NexusConfigProvider(parameters: PropsWithChildren<NexusConfigPr
     walletUrl: string;
     metadata: {
         name: string;
+        css?: string;
     };
+    domain: string;
 }> | undefined>>;
 
 /**
@@ -49,10 +60,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;
 }>;
 
 /**
@@ -62,52 +74,83 @@ declare function useNexusConfig(): Readonly<{
     walletUrl: string;
     metadata: {
         name: string;
+        css?: 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
+ * Hooks used to listen to the current wallet status
  */
-declare function useArticleUnlockOptions({ articleId, contentId, }: GetUnlockOptionsParams): _tanstack_react_query.UseQueryResult<Readonly<{
-    frkBalanceAsHex?: `0x${string}` | undefined;
-    prices: {
-        index: number;
-        unlockDurationInSec: number;
-        frkAmount: `0x${string}`;
-        isUserAccessible: boolean | null;
-    }[];
-}>, Error>;
+declare function useWalletStatus(): _tanstack_react_query.UseQueryResult<WalletStatusReturnType, Error>;
 
-type WalletStatusQueryReturnType = WalletStatusReturnType | {
-    key: "waiting-response";
-};
+type MutationOptions$4 = Omit<UseMutationOptions<SendTransactionReturnType, FrakRpcError, SendTransactionParams>, "mutationFn" | "mutationKey">;
+interface UseSendTransactionParams {
+    mutations?: MutationOptions$4;
+}
 /**
- * Hooks used to listen to the current wallet status
+ * Trigger a dashboard action to the wallet
  */
-declare function useWalletStatus(): _tanstack_react_query.UseQueryResult<WalletStatusQueryReturnType, Error>;
+declare function useSendTransactionAction({ mutations, }?: UseSendTransactionParams): _tanstack_react_query.UseMutationResult<Readonly<{
+    hash: viem.Hex;
+}>, FrakRpcError<undefined>, SendTransactionParams, unknown>;
 
-type ArticleUnlockStatusQueryReturnType = ArticleUnlockStatusReturnType | {
-    status: "waiting-response";
-    key: "waiting-response";
-};
+type MutationOptions$3 = Omit<UseMutationOptions<SiweAuthenticateReturnType, FrakRpcError, SiweAuthenticateModalParams>, "mutationFn" | "mutationKey">;
+interface UseSiweAuthenticateParams {
+    mutations?: MutationOptions$3;
+}
 /**
- * Hooks used to listen to the current article unlock status
+ * Trigger a dashboard action to the wallet
  */
-declare function useArticleUnlockStatus({ articleId, contentId, }: WatchUnlockStatusParams): _tanstack_react_query.UseQueryResult<ArticleUnlockStatusQueryReturnType | null, Error>;
+declare function useSiweAuthenticate({ mutations, }?: UseSiweAuthenticateParams): _tanstack_react_query.UseMutationResult<Readonly<{
+    signature: viem.Hex;
+    message: string;
+}>, FrakRpcError<undefined>, SiweAuthenticateModalParams, unknown>;
 
-type SetUserReferredQueryReturnType = SetUserReferredReturnType | {
-    key: "waiting-response";
-} | {
-    key: "no-referrer";
-};
+type ReferralState = "idle" | "processing" | "success" | "no-wallet" | "no-session" | "error" | "no-referrer" | "self-referral";
+/**
+ * Helper hook to automatically submit a referral interaction when detected
+ *   -> And automatically set the referral context in the url
+ * @param contentId
+ * @param modalConfig
+ */
+declare function useReferralInteraction({ contentId, modalConfig, }?: {
+    contentId?: Hex;
+    modalConfig?: DisplayModalParamsType<ModalStepTypes[]>;
+}): ReferralState;
+
+type MutationOptions$2 = Omit<UseMutationOptions<SendInteractionReturnType, FrakRpcError, SendInteractionParamsType>, "mutationFn" | "mutationKey">;
+interface UseSendInteractionParams$1 {
+    mutations?: MutationOptions$2;
+}
+/**
+ * Send a user interaction
+ */
+declare function useSendInteraction({ mutations, }?: UseSendInteractionParams$1): _tanstack_react_query.UseMutationResult<Readonly<{
+    delegationId: string;
+}>, FrakRpcError<undefined>, SendInteractionParamsType, unknown>;
+
+type MutationOptions$1<T extends ModalStepTypes[]> = Omit<UseMutationOptions<ModalRpcStepsResultType<T>, FrakRpcError, DisplayModalParamsType<T>>, "mutationFn" | "mutationKey">;
+interface UseDisplayModalParams<T extends ModalStepTypes[] = ModalStepTypes[]> {
+    mutations?: MutationOptions$1<T>;
+}
+/**
+ * Send a user interaction
+ */
+declare function useDisplayModal<T extends ModalStepTypes[] = ModalStepTypes[]>({ mutations, }?: UseDisplayModalParams<T>): _tanstack_react_query.UseMutationResult<ModalRpcStepsResultType<T>, FrakRpcError<undefined>, DisplayModalParamsType<T>, unknown>;
+
+type MutationOptions = Omit<UseMutationOptions<void, FrakRpcError, OpenSsoParamsType>, "mutationFn" | "mutationKey">;
+interface UseSendInteractionParams {
+    mutations?: MutationOptions;
+}
 /**
- * Use the current nexus referral
+ * Open the SSO
  */
-declare function useNexusReferral({ contentId }: SetUserReferredParams): _tanstack_react_query.UseQueryResult<SetUserReferredQueryReturnType, Error>;
+declare function useOpenSso({ mutations }?: UseSendInteractionParams): _tanstack_react_query.UseMutationResult<void, FrakRpcError<undefined>, OpenSsoParamsType, unknown>;
 
-export { type ArticleUnlockStatusQueryReturnType, NexusConfigContext, NexusConfigProvider, type NexusConfigProviderProps, NexusIFrameClientContext, type NexusIFrameClientProps, NexusIFrameClientProvider, type WalletStatusQueryReturnType, useArticleUnlockOptions, useArticleUnlockStatus, useNexusClient, useNexusConfig, useNexusReferral, useWalletStatus };
+export { NexusConfigContext, NexusConfigProvider, type NexusConfigProviderProps, NexusIFrameClientContext, type NexusIFrameClientProps, NexusIFrameClientProvider, useDisplayModal, useNexusClient, useNexusConfig, useOpenSso, useReferralInteraction, useSendInteraction, useSendTransactionAction, useSiweAuthenticate, useWalletStatus };