@frak-labs/nexus-sdk 0.0.10 → 0.0.11

package/dist/{client-6_BJp7Ub.d.ts → client-C7u9zGwC.d.cts}

@@ -1,7 +1,7 @@
-import { Hex, Address, RpcSchema } from 'viem';
+import { Address, Hex, RpcSchema } from 'viem';
 import { Prettify } from 'viem/chains';
 import { SiweMessage } from 'viem/siwe';
-import { P as PreparedInteraction, a as SendInteractionReturnType } from './interaction-D_CzyqRE.js';
+import { P as PreparedInteraction, a as SendInteractionReturnType } from './interaction-D3-M3nBh.cjs';
 
 /**
  * Configuration for the Nexus Wallet SDK
@@ -10,21 +10,70 @@ type NexusWalletSdkConfig = Readonly<{
     walletUrl: string;
     metadata: {
         name: string;
+        css?: string;
     };
     domain: string;
 }>;
 
 /**
- * Parameters of the send transaction rpc request
+ * SSO Metadata
  */
-type SiweAuthenticationParams = Omit<SiweMessage, "address" | "chainId">;
+type SsoMetadata = {
+    logoUrl: string;
+    homepageLink: string;
+    links?: {
+        confidentialityLink?: string;
+        helpLink?: string;
+        cguLink?: string;
+    };
+};
 /**
- * Same stuff but in an object format for better readability
+ * Params to start a SSO
  */
-type SiweAuthenticateActionParamsType = Readonly<{
-    siwe?: Partial<SiweAuthenticationParams>;
-    context?: string;
+type OpenSsoParamsType = {
+    redirectUrl?: string;
+    directExit?: boolean;
+    metadata: SsoMetadata;
+};
+
+/**
+ * Represent a generic modal step type
+ */
+type GenericModalStepType<TKey, TParams, TReturns> = {
+    key: TKey;
+    params: TParams extends never ? ModalStepMetadata : ModalStepMetadata & TParams;
+    returns: TReturns;
+};
+type ModalStepMetadata = {
+    metadata?: {
+        title?: string;
+        description?: string;
+        primaryActionText?: string;
+        secondaryActionText?: string;
+    };
+};
+
+type LoginWithSso = {
+    allowSso: true;
+    ssoMetadata: SsoMetadata;
+};
+type LoginWithoutSso = {
+    allowSso?: false;
+    ssoMetadata?: never;
+};
+/**
+ * Generic type of modal we will display to the end user
+ */
+type LoginModalStepType = GenericModalStepType<"login", {
+    articleUrl?: string;
+} & (LoginWithSso | LoginWithoutSso), {
+    wallet: Address;
 }>;
+
+/**
+ * Parameters of the send transaction rpc request
+ */
+type SiweAuthenticationParams = Omit<SiweMessage, "address" | "chainId">;
 /**
  * Return type of the send transaction rpc request
  */
@@ -32,25 +81,21 @@ type SiweAuthenticateReturnType = Readonly<{
     signature: Hex;
     message: string;
 }>;
-
 /**
- * Parameters of the send transaction rpc request
+ * Generic type of modal we will display to the end user
  */
-type SendTransactionRpcParamsType = [
-    tx: SendTransactionTxType | SendTransactionTxType[],
-    context?: string
-];
+type SiweAuthenticateModalStepType = GenericModalStepType<"siweAuthenticate", {
+    siwe: SiweAuthenticationParams;
+}, SiweAuthenticateReturnType>;
+
 /**
- * Same stuff but in an object format for better readability
+ * Generic format representing a tx to be sent
+ *  todo: exploit the EIP-5792 here? https://eips.ethereum.org/EIPS/eip-5792
  */
-type SendTransactionActionParamsType = Readonly<{
-    tx: SendTransactionTxType | SendTransactionTxType[];
-    context?: string;
-}>;
 type SendTransactionTxType = Readonly<{
     to: Address;
-    data: Hex;
-    value: Hex;
+    data?: Hex;
+    value?: Hex;
 }>;
 /**
  * Return type of the send transaction rpc request
@@ -58,114 +103,79 @@ type SendTransactionTxType = Readonly<{
 type SendTransactionReturnType = Readonly<{
     hash: Hex;
 }>;
-
-type PaidArticleUnlockPrice = Readonly<{
-    index: number;
-    unlockDurationInSec: number;
-    frkAmount: Hex;
-}>;
+type SendTransactionModalStepType = GenericModalStepType<"sendTransaction", {
+    tx: SendTransactionTxType | SendTransactionTxType[];
+}, SendTransactionReturnType>;
 
 /**
- * Request to unlock a paid article
+ * Return type of the send transaction rpc request
  */
-type StartArticleUnlockParams = Readonly<{
-    articleId: Hex;
-    contentId: Hex;
-    imageUrl: string;
-    articleTitle: string;
-    contentTitle: string;
-    price: PaidArticleUnlockPrice;
-    articleUrl: string;
-    redirectUrl: string;
-    previewUrl?: string;
-    provider: "le-monde" | "wired" | "l-equipe";
+type OpenInteractionSessionReturnType = Readonly<{
+    startTimestamp: number;
+    endTimestamp: number;
 }>;
 /**
- * Return type of the unlock request
+ * Generic type of modal we will display to the end user
  */
-type StartArticleUnlockReturnType = UnlockSuccess | AlreadyUnlocked | UnlockError;
-type UnlockSuccess = {
-    key: "success";
-    status: "in-progress";
-    user: Address;
-    userOpHash: Hex;
-};
-type AlreadyUnlocked = {
-    key: "already-unlocked";
-    status: "unlocked";
-    user: Address;
-};
-type UnlockError = {
-    key: "error" | "cancelled";
-    status: "locked";
-    user?: Address;
-    reason?: string;
-};
+type OpenInteractionSessionModalStepType = GenericModalStepType<"openSession", object, OpenInteractionSessionReturnType>;
 
 /**
- * The response to the get unlock options response
+ * Generic type of modal we will display to the end user
  */
-type UnlockOptionsReturnType = Readonly<{
-    frkBalanceAsHex?: Hex;
-    prices: {
-        index: number;
-        unlockDurationInSec: number;
-        frkAmount: Hex;
-        isUserAccessible: boolean | null;
-    }[];
-}>;
+type SuccessModalStepType = GenericModalStepType<"success", {
+    sharing?: {
+        popupTitle?: string;
+        text?: string;
+        link?: string;
+    };
+}, object>;
 
 /**
- * The different types of response for the current unlock status
+ * Generic type of steps we will display in the modal to the end user
  */
-type ArticleUnlockStatusReturnType = Readonly<UnlockStatusLocked | UnlockStatusProcessing | UnlockStatusValid | UnlockStatusError>;
+type ModalStepTypes = LoginModalStepType | SiweAuthenticateModalStepType | SendTransactionModalStepType | OpenInteractionSessionModalStepType | SuccessModalStepType;
 /**
- * When the content unlocked was expired or not unlocked
+ * Type for the result of a modal request
  */
-type UnlockStatusLocked = {
-    key: "expired";
-    status: "locked";
-    expiredAt: number;
-} | {
-    key: "not-unlocked";
-    status: "locked";
+type ModalRpcStepsResultType<T extends ModalStepTypes[] = ModalStepTypes[]> = {
+    [K in T[number]["key"]]: Extract<T[number], {
+        key: K;
+    }>["returns"];
 };
 /**
- * When the content unlock is in progress
+ * Type for the RPC input of a modal
  */
-type UnlockStatusProcessing = {
-    status: "in-progress";
-} & ({
-    key: "preparing" | "waiting-user-validation";
-} | {
-    key: "waiting-transaction-bundling";
-    userOpHash: Hex;
-} | {
-    key: "waiting-transaction-confirmation";
-    userOpHash: Hex;
-    txHash: Hex;
-});
+type ModalRpcStepsInput<T extends ModalStepTypes[] = ModalStepTypes[]> = {
+    [K in T[number]["key"]]?: Extract<T[number], {
+        key: K;
+    }>["params"];
+};
 /**
- * When the content is unlocked
+ * RPC metadata for the modal
  */
-type UnlockStatusValid = {
-    key: "valid";
-    status: "unlocked";
-    allowedUntil: number;
-};
+type ModalRpcMetadata = Readonly<{
+    header?: {
+        title?: string;
+        icon?: string;
+    };
+    context?: string;
+}>;
 /**
- * When the unlock content is in error
+ * Generic params used to display modals
  */
-type UnlockStatusError = {
-    key: "error";
-    status: "locked";
-    reason: string;
+type DisplayModalParamsType<T extends ModalStepTypes[]> = {
+    steps: ModalRpcStepsInput<T>;
+    metadata?: ModalRpcMetadata;
 };
 
 type WalletStatusReturnType = Readonly<WalletConnected | WalletNotConnected>;
 type WalletConnected = {
     key: "connected";
     wallet: Address;
+    interactionSession?: {
+        startTimestamp: number;
+        endTimestamp: number;
+    };
 };
 type WalletNotConnected = {
     key: "not-connected";
@@ -175,14 +185,6 @@ type WalletNotConnected = {
  * RPC interface that's used for the iframe communication
  */
 type IFrameRpcSchema = [
-    /**
-     * Method used to fetch an article unlock options
-     */
-    {
-        Method: "frak_getArticleUnlockOptions";
-        Parameters: [contentId: Hex, articleId: Hex];
-        ReturnType: UnlockOptionsReturnType;
-    },
     /**
      * Method used to listen to the wallet status
      */
@@ -192,28 +194,16 @@ type IFrameRpcSchema = [
         ReturnType: WalletStatusReturnType;
     },
     /**
-     * Method used to listen to an article unlock status
-     */
-    {
-        Method: "frak_listenToArticleUnlockStatus";
-        Parameters: [contentId: Hex, articleId: Hex];
-        ReturnType: ArticleUnlockStatusReturnType;
-    },
-    /**
-     * Method to ask the user to send a transaction
-     */
-    {
-        Method: "frak_sendTransaction";
-        Parameters: SendTransactionRpcParamsType;
-        ReturnType: SendTransactionReturnType;
-    },
-    /**
-     * Method to ask the user for a strong authentication
+     * Method to transmit a user interaction
      */
     {
-        Method: "frak_siweAuthenticate";
-        Parameters: [request: SiweAuthenticationParams, context?: string];
-        ReturnType: SiweAuthenticateReturnType;
+        Method: "frak_displayModal";
+        Parameters: [
+            requests: ModalRpcStepsInput,
+            name: string,
+            metadata?: ModalRpcMetadata
+        ];
+        ReturnType: ModalRpcStepsResultType;
     },
     /**
      * Method to transmit a user interaction
@@ -226,20 +216,18 @@ type IFrameRpcSchema = [
             signature?: Hex
         ];
         ReturnType: SendInteractionReturnType;
-    }
-];
-/**
- * RPC interface that's used for the redirection communication
- */
-type RedirectRpcSchema = [
+    },
     /**
-     * Method used to start the unlock of an article
+     * Method to start a SSO
      */
     {
-        Method: "frak_startArticleUnlock";
-        Path: "/paywall";
-        Parameters: StartArticleUnlockParams;
-        ReturnType: StartArticleUnlockReturnType;
+        Method: "frak_sso";
+        Parameters: [
+            params: OpenSsoParamsType,
+            name: string,
+            customCss?: string
+        ];
+        ReturnType: undefined;
     }
 ];
 
@@ -327,6 +315,11 @@ type IFrameRpcEvent = {
 };
 type IFrameLifecycleEvent = {
     lifecycle: "connected" | "show" | "hide";
+    data: never;
+} | LifecycleEventCSS;
+type LifecycleEventCSS = {
+    lifecycle: "modal-css";
+    data: string;
 };
 
 /**
@@ -336,4 +329,4 @@ type NexusClient = {
     config: NexusWalletSdkConfig;
 } & IFrameTransport;
 
-export type { ArticleUnlockStatusReturnType as A, ExtractedParametersFromRpc as E, IFrameRpcSchema as I, NexusClient as N, PaidArticleUnlockPrice as P, RedirectRpcSchema as R, StartArticleUnlockParams as S, UnlockOptionsReturnType as U, WalletStatusReturnType as W, NexusWalletSdkConfig as a, StartArticleUnlockReturnType as b, SendTransactionActionParamsType as c, SendTransactionReturnType as d, SendTransactionTxType as e, SiweAuthenticateReturnType as f, SiweAuthenticateActionParamsType as g, SiweAuthenticationParams as h, RpcResponse as i, IFrameTransport as j, IFrameRpcEvent as k, IFrameEvent as l, ExtractedReturnTypeFromRpc as m };
+export type { DisplayModalParamsType as D, ExtractedParametersFromRpc as E, IFrameRpcSchema as I, LoginModalStepType as L, ModalRpcMetadata as M, NexusClient as N, OpenSsoParamsType as O, RpcResponse as R, SiweAuthenticationParams as S, WalletStatusReturnType as W, SiweAuthenticateReturnType as a, SendTransactionModalStepType as b, SendTransactionReturnType as c, ModalStepTypes as d, ModalRpcStepsResultType as e, NexusWalletSdkConfig as f, SuccessModalStepType as g, SsoMetadata as h, ModalRpcStepsInput as i, ModalStepMetadata as j, SiweAuthenticateModalStepType as k, SendTransactionTxType as l, OpenInteractionSessionReturnType as m, OpenInteractionSessionModalStepType as n, IFrameTransport as o, IFrameRpcEvent as p, IFrameEvent as q, ExtractedReturnTypeFromRpc as r };