@frak-labs/nexus-sdk 0.0.10 → 0.0.11

package/dist/react/index.d.cts

@@ -1,13 +1,13 @@
 import * as react from 'react';
 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 { 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 { 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 { 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';
 
@@ -18,6 +18,7 @@ declare const NexusConfigContext: react.Context<Readonly<{
     walletUrl: string;
     metadata: {
         name: string;
+        css?: string;
     };
     domain: string;
 }> | undefined>;
@@ -38,6 +39,7 @@ declare function NexusConfigProvider(parameters: PropsWithChildren<NexusConfigPr
     walletUrl: string;
     metadata: {
         name: string;
+        css?: string;
     };
     domain: string;
 }> | undefined>>;
@@ -72,6 +74,7 @@ declare function useNexusConfig(): Readonly<{
     walletUrl: string;
     metadata: {
         name: string;
+        css?: string;
     };
     domain: string;
 }>;
@@ -81,53 +84,25 @@ declare function useNexusConfig(): Readonly<{
  */
 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?: viem.Hex;
-    prices: {
-        index: number;
-        unlockDurationInSec: number;
-        frkAmount: viem.Hex;
-        isUserAccessible: boolean | null;
-    }[];
-}> | undefined, Error>;
-
-type WalletStatusQueryReturnType = WalletStatusReturnType | {
-    key: "waiting-response";
-};
 /**
  * Hooks used to listen to the current wallet status
  */
-declare function useWalletStatus(): _tanstack_react_query.UseQueryResult<WalletStatusQueryReturnType, Error>;
-
-type ArticleUnlockStatusQueryReturnType = ArticleUnlockStatusReturnType | {
-    status: "waiting-response";
-    key: "waiting-response";
-};
-/**
- * Hooks used to listen to the current article unlock status
- */
-declare function useArticleUnlockStatus({ articleId, contentId, }: WatchUnlockStatusParams): _tanstack_react_query.UseQueryResult<ArticleUnlockStatusQueryReturnType | null, Error>;
+declare function useWalletStatus(): _tanstack_react_query.UseQueryResult<WalletStatusReturnType, Error>;
 
-type MutationOptions$2 = Omit<UseMutationOptions<SendTransactionReturnType, FrakRpcError, SendTransactionActionParamsType>, "mutationFn" | "mutationKey">;
+type MutationOptions$4 = Omit<UseMutationOptions<SendTransactionReturnType, FrakRpcError, SendTransactionParams>, "mutationFn" | "mutationKey">;
 interface UseSendTransactionParams {
-    mutations?: MutationOptions$2;
+    mutations?: MutationOptions$4;
 }
 /**
  * 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>;
+}>, FrakRpcError<undefined>, SendTransactionParams, unknown>;
 
-type MutationOptions$1 = Omit<UseMutationOptions<SiweAuthenticateReturnType, FrakRpcError, SiweAuthenticateActionParamsType>, "mutationFn" | "mutationKey">;
+type MutationOptions$3 = Omit<UseMutationOptions<SiweAuthenticateReturnType, FrakRpcError, SiweAuthenticateModalParams>, "mutationFn" | "mutationKey">;
 interface UseSiweAuthenticateParams {
-    mutations?: MutationOptions$1;
+    mutations?: MutationOptions$3;
 }
 /**
  * Trigger a dashboard action to the wallet
@@ -135,29 +110,47 @@ interface UseSiweAuthenticateParams {
 declare function useSiweAuthenticate({ mutations, }?: UseSiweAuthenticateParams): _tanstack_react_query.UseMutationResult<Readonly<{
     signature: viem.Hex;
     message: string;
-}>, FrakRpcError<undefined>, Readonly<{
-    siwe?: Partial<SiweAuthenticationParams>;
-    context?: string;
-}>, unknown>;
+}>, FrakRpcError<undefined>, SiweAuthenticateModalParams, unknown>;
 
+type ReferralState = "idle" | "processing" | "success" | "no-wallet" | "no-session" | "error" | "no-referrer" | "self-referral";
 /**
- * Helper hook to automatically submit a press referral interaction when detected
+ * 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 usePressReferralInteraction({ contentId }: {
-    contentId: Hex;
-}): "error" | "loading" | "no-referral" | "referred" | "no-wallet" | "no-session";
+declare function useReferralInteraction({ contentId, modalConfig, }?: {
+    contentId?: Hex;
+    modalConfig?: DisplayModalParamsType<ModalStepTypes[]>;
+}): ReferralState;
 
-type MutationOptions = Omit<UseMutationOptions<SendInteractionReturnType, FrakRpcError, SendInteractionParamsType>, "mutationFn" | "mutationKey">;
-interface UseSendInteractionParams {
-    mutations?: MutationOptions;
+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): _tanstack_react_query.UseMutationResult<Readonly<{
-    hash: viem.Hex;
+declare function useSendInteraction({ mutations, }?: UseSendInteractionParams$1): _tanstack_react_query.UseMutationResult<Readonly<{
+    delegationId: string;
 }>, 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 };
+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;
+}
+/**
+ * Open the SSO
+ */
+declare function useOpenSso({ mutations }?: UseSendInteractionParams): _tanstack_react_query.UseMutationResult<void, FrakRpcError<undefined>, OpenSsoParamsType, unknown>;
+
+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,13 +1,13 @@
 import * as react from 'react';
 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 { 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 { 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 { 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';
 
@@ -18,6 +18,7 @@ declare const NexusConfigContext: react.Context<Readonly<{
     walletUrl: string;
     metadata: {
         name: string;
+        css?: string;
     };
     domain: string;
 }> | undefined>;
@@ -38,6 +39,7 @@ declare function NexusConfigProvider(parameters: PropsWithChildren<NexusConfigPr
     walletUrl: string;
     metadata: {
         name: string;
+        css?: string;
     };
     domain: string;
 }> | undefined>>;
@@ -72,6 +74,7 @@ declare function useNexusConfig(): Readonly<{
     walletUrl: string;
     metadata: {
         name: string;
+        css?: string;
     };
     domain: string;
 }>;
@@ -81,53 +84,25 @@ declare function useNexusConfig(): Readonly<{
  */
 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?: viem.Hex;
-    prices: {
-        index: number;
-        unlockDurationInSec: number;
-        frkAmount: viem.Hex;
-        isUserAccessible: boolean | null;
-    }[];
-}> | undefined, Error>;
-
-type WalletStatusQueryReturnType = WalletStatusReturnType | {
-    key: "waiting-response";
-};
 /**
  * Hooks used to listen to the current wallet status
  */
-declare function useWalletStatus(): _tanstack_react_query.UseQueryResult<WalletStatusQueryReturnType, Error>;
-
-type ArticleUnlockStatusQueryReturnType = ArticleUnlockStatusReturnType | {
-    status: "waiting-response";
-    key: "waiting-response";
-};
-/**
- * Hooks used to listen to the current article unlock status
- */
-declare function useArticleUnlockStatus({ articleId, contentId, }: WatchUnlockStatusParams): _tanstack_react_query.UseQueryResult<ArticleUnlockStatusQueryReturnType | null, Error>;
+declare function useWalletStatus(): _tanstack_react_query.UseQueryResult<WalletStatusReturnType, Error>;
 
-type MutationOptions$2 = Omit<UseMutationOptions<SendTransactionReturnType, FrakRpcError, SendTransactionActionParamsType>, "mutationFn" | "mutationKey">;
+type MutationOptions$4 = Omit<UseMutationOptions<SendTransactionReturnType, FrakRpcError, SendTransactionParams>, "mutationFn" | "mutationKey">;
 interface UseSendTransactionParams {
-    mutations?: MutationOptions$2;
+    mutations?: MutationOptions$4;
 }
 /**
  * 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>;
+}>, FrakRpcError<undefined>, SendTransactionParams, unknown>;
 
-type MutationOptions$1 = Omit<UseMutationOptions<SiweAuthenticateReturnType, FrakRpcError, SiweAuthenticateActionParamsType>, "mutationFn" | "mutationKey">;
+type MutationOptions$3 = Omit<UseMutationOptions<SiweAuthenticateReturnType, FrakRpcError, SiweAuthenticateModalParams>, "mutationFn" | "mutationKey">;
 interface UseSiweAuthenticateParams {
-    mutations?: MutationOptions$1;
+    mutations?: MutationOptions$3;
 }
 /**
  * Trigger a dashboard action to the wallet
@@ -135,29 +110,47 @@ interface UseSiweAuthenticateParams {
 declare function useSiweAuthenticate({ mutations, }?: UseSiweAuthenticateParams): _tanstack_react_query.UseMutationResult<Readonly<{
     signature: viem.Hex;
     message: string;
-}>, FrakRpcError<undefined>, Readonly<{
-    siwe?: Partial<SiweAuthenticationParams>;
-    context?: string;
-}>, unknown>;
+}>, FrakRpcError<undefined>, SiweAuthenticateModalParams, unknown>;
 
+type ReferralState = "idle" | "processing" | "success" | "no-wallet" | "no-session" | "error" | "no-referrer" | "self-referral";
 /**
- * Helper hook to automatically submit a press referral interaction when detected
+ * 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 usePressReferralInteraction({ contentId }: {
-    contentId: Hex;
-}): "error" | "loading" | "no-referral" | "referred" | "no-wallet" | "no-session";
+declare function useReferralInteraction({ contentId, modalConfig, }?: {
+    contentId?: Hex;
+    modalConfig?: DisplayModalParamsType<ModalStepTypes[]>;
+}): ReferralState;
 
-type MutationOptions = Omit<UseMutationOptions<SendInteractionReturnType, FrakRpcError, SendInteractionParamsType>, "mutationFn" | "mutationKey">;
-interface UseSendInteractionParams {
-    mutations?: MutationOptions;
+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): _tanstack_react_query.UseMutationResult<Readonly<{
-    hash: viem.Hex;
+declare function useSendInteraction({ mutations, }?: UseSendInteractionParams$1): _tanstack_react_query.UseMutationResult<Readonly<{
+    delegationId: string;
 }>, 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 };
+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;
+}
+/**
+ * Open the SSO
+ */
+declare function useOpenSso({ mutations }?: UseSendInteractionParams): _tanstack_react_query.UseMutationResult<void, FrakRpcError<undefined>, OpenSsoParamsType, unknown>;
+
+export { NexusConfigContext, NexusConfigProvider, type NexusConfigProviderProps, NexusIFrameClientContext, type NexusIFrameClientProps, NexusIFrameClientProvider, useDisplayModal, useNexusClient, useNexusConfig, useOpenSso, useReferralInteraction, useSendInteraction, useSendTransactionAction, useSiweAuthenticate, useWalletStatus };