@frak-labs/nexus-sdk 0.0.25 → 0.0.27

package/dist/FrakContext-DjeuWC2U.d.ts

@@ -1,450 +0,0 @@
-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-BngPoHA0.js';
-
-/**
- * Configuration for the Nexus Wallet SDK
- */
-type NexusWalletSdkConfig = Readonly<{
-    walletUrl?: string;
-    metadata: {
-        name: string;
-        css?: string;
-        buttonShare?: string;
-    };
-    domain?: string;
-}>;
-
-/**
- * Event related to the iframe lifecycle
- */
-type IFrameLifecycleEvent = {
-    iframeLifecycle: "connected" | "show" | "hide";
-    data?: never;
-} | DoBackupEvent | RemoveBackupEvent;
-type DoBackupEvent = {
-    iframeLifecycle: "do-backup";
-    data: {
-        backup?: string;
-    };
-};
-type RemoveBackupEvent = {
-    iframeLifecycle: "remove-backup";
-};
-
-/**
- * Event related to the iframe lifecycle
- */
-type ClientLifecycleEvent = CustomCssEvent | RestoreBackupEvent;
-type CustomCssEvent = {
-    clientLifecycle: "modal-css";
-    data: {
-        cssLink: string;
-    };
-};
-type RestoreBackupEvent = {
-    clientLifecycle: "restore-backup";
-    data: {
-        backup: string;
-    };
-};
-
-/**
- * SSO Metadata
- */
-type SsoMetadata = {
-    logoUrl?: string;
-    homepageLink?: string;
-    links?: {
-        confidentialityLink?: string;
-        helpLink?: string;
-        cguLink?: string;
-    };
-};
-/**
- * Params to start a SSO
- */
-type OpenSsoParamsType = {
-    redirectUrl?: string;
-    directExit?: boolean;
-    lang?: "en" | "fr";
-    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", LoginWithSso | LoginWithoutSso, {
-    wallet: Address;
-}>;
-
-/**
- * Parameters of the send transaction rpc request
- */
-type SiweAuthenticationParams = Omit<SiweMessage, "address" | "chainId" | "expirationTime" | "issuedAt" | "notBefore"> & {
-    expirationTimeTimestamp?: number;
-    notBeforeTimestamp?: number;
-};
-/**
- * Return type of the send transaction rpc request
- */
-type SiweAuthenticateReturnType = Readonly<{
-    signature: Hex;
-    message: string;
-}>;
-/**
- * Generic type of modal we will display to the end user
- */
-type SiweAuthenticateModalStepType = GenericModalStepType<"siweAuthenticate", {
-    siwe: SiweAuthenticationParams;
-}, SiweAuthenticateReturnType>;
-
-/**
- * Generic format representing a tx to be sent
- */
-type SendTransactionTxType = Readonly<{
-    to: Address;
-    data?: Hex;
-    value?: Hex;
-}>;
-/**
- * Return type of the send transaction rpc request
- */
-type SendTransactionReturnType = Readonly<{
-    hash: Hex;
-}>;
-type SendTransactionModalStepType = GenericModalStepType<"sendTransaction", {
-    tx: SendTransactionTxType | SendTransactionTxType[];
-}, SendTransactionReturnType>;
-
-/**
- * Return type of the send transaction rpc request
- */
-type OpenInteractionSessionReturnType = Readonly<{
-    startTimestamp: number;
-    endTimestamp: number;
-}>;
-/**
- * Generic type of modal we will display to the end user
- */
-type OpenInteractionSessionModalStepType = GenericModalStepType<"openSession", object, OpenInteractionSessionReturnType>;
-
-/**
- * The final modal step type (displayed on success or dimissed)
- */
-type FinalModalStepType = GenericModalStepType<"final", {
-    dismissedMetadata?: ModalStepMetadata["metadata"];
-    action: FinalActionType;
-    autoSkip?: boolean;
-}, object>;
-type FinalActionType = {
-    key: "sharing";
-    options?: {
-        popupTitle?: string;
-        text?: string;
-        link?: string;
-    };
-} | {
-    key: "reward";
-    options?: never;
-};
-
-/**
- * Generic type of steps we will display in the modal to the end user
- */
-type ModalStepTypes = LoginModalStepType | SiweAuthenticateModalStepType | SendTransactionModalStepType | OpenInteractionSessionModalStepType | FinalModalStepType;
-/**
- * Type for the result of a modal request
- */
-type ModalRpcStepsResultType<T extends ModalStepTypes[] = ModalStepTypes[]> = {
-    [K in T[number]["key"]]: Extract<T[number], {
-        key: K;
-    }>["returns"];
-};
-/**
- * Type for the RPC input of a modal
- */
-type ModalRpcStepsInput<T extends ModalStepTypes[] = ModalStepTypes[]> = {
-    [K in T[number]["key"]]?: Extract<T[number], {
-        key: K;
-    }>["params"];
-};
-/**
- * RPC metadata for the modal
- */
-type ModalRpcMetadata = Readonly<{
-    header?: {
-        title?: string;
-        icon?: string;
-    };
-    context?: string;
-    lang?: "en" | "fr";
-} & ({
-    isDismissible: true;
-    dismissActionTxt?: string;
-} | {
-    isDismissible?: false;
-    dismissActionTxt?: never;
-})>;
-/**
- * Generic params used to display modals
- */
-type DisplayModalParamsType<T extends ModalStepTypes[]> = {
-    steps: ModalRpcStepsInput<T>;
-    metadata?: ModalRpcMetadata;
-};
-
-/**
- * The keys for each product types
- */
-type ProductTypesKey = keyof typeof productTypes;
-/**
- * List of the product types per denominator
- */
-declare const productTypes: {
-    dapp: number;
-    press: number;
-    webshop: number;
-    referral: number;
-    purchase: number;
-};
-/**
- * Bitmask for each product types
- */
-declare const productTypesMask: Record<ProductTypesKey, bigint>;
-
-type GetProductInformationReturnType = Readonly<{
-    /**
-     * Current product id
-     */
-    id: Hex;
-    /**
-     * Some metadata
-     */
-    onChainMetadata: {
-        /**
-         * Name of the product on-chain
-         */
-        name: string;
-        /**
-         * Domain of the product on-chain
-         */
-        domain: string;
-        /**
-         * The supported product types
-         */
-        productTypes: ProductTypesKey[];
-    };
-    /**
-     * Current the current estimated product reward
-     */
-    estimatedEurReward?: string;
-}>;
-
-type WalletStatusReturnType = Readonly<WalletConnected | WalletNotConnected>;
-type WalletConnected = {
-    key: "connected";
-    wallet: Address;
-    interactionToken?: string;
-    interactionSession?: {
-        startTimestamp: number;
-        endTimestamp: number;
-    };
-};
-type WalletNotConnected = {
-    key: "not-connected";
-    wallet?: never;
-    interactionToken?: never;
-    interactionSession?: never;
-};
-
-/**
- * RPC interface that's used for the iframe communication
- */
-type IFrameRpcSchema = [
-    /**
-     * Method used to listen to the wallet status
-     */
-    {
-        Method: "frak_listenToWalletStatus";
-        Parameters?: undefined;
-        ReturnType: WalletStatusReturnType;
-    },
-    /**
-     * Method to transmit a user interaction
-     */
-    {
-        Method: "frak_displayModal";
-        Parameters: [
-            requests: ModalRpcStepsInput,
-            name: string,
-            metadata?: ModalRpcMetadata
-        ];
-        ReturnType: ModalRpcStepsResultType;
-    },
-    /**
-     * Method to transmit a user interaction
-     */
-    {
-        Method: "frak_sendInteraction";
-        Parameters: [
-            productId: Hex,
-            interaction: PreparedInteraction,
-            signature?: Hex
-        ];
-        ReturnType: SendInteractionReturnType;
-    },
-    /**
-     * Method to start a SSO
-     *  todo: Should also support direct tracking via a consumeKey
-     */
-    {
-        Method: "frak_sso";
-        Parameters: [
-            params: OpenSsoParamsType,
-            name: string,
-            customCss?: string
-        ];
-        ReturnType: undefined;
-    },
-    /**
-     * Method to get current product information's
-     *  - Is product minted?
-     *  - Does it have running campaign?
-     *  - Estimated reward on actions
-     */
-    {
-        Method: "frak_getProductInformation";
-        Parameters?: undefined;
-        ReturnType: GetProductInformationReturnType;
-    }
-];
-
-/**
- * Type that extract the possible parameters from a RPC Schema
- */
-type ExtractedParametersFromRpc<TRpcSchema extends RpcSchema> = {
-    [K in keyof TRpcSchema]: Prettify<{
-        method: TRpcSchema[K] extends TRpcSchema[number] ? TRpcSchema[K]["Method"] : string;
-    } & (TRpcSchema[K] extends TRpcSchema[number] ? TRpcSchema[K]["Parameters"] extends undefined ? {
-        params?: never;
-    } : {
-        params: TRpcSchema[K]["Parameters"];
-    } : never)>;
-}[number];
-/**
- * Type that extract the possible return type from a RPC Schema
- */
-type ExtractedReturnTypeFromRpc<TRpcSchema extends RpcSchema, TParameters extends ExtractedParametersFromRpc<TRpcSchema> = ExtractedParametersFromRpc<TRpcSchema>> = ExtractedMethodFromRpc<TRpcSchema, TParameters["method"]>["ReturnType"];
-/**
- * Type that extract the possible return type from a RPC Schema
- */
-type ExtractedMethodFromRpc<TRpcSchema extends RpcSchema, TMethod extends ExtractedParametersFromRpc<TRpcSchema>["method"] = ExtractedParametersFromRpc<TRpcSchema>["method"]> = Extract<TRpcSchema[number], {
-    Method: TMethod;
-}>;
-/**
- * Raw response that we will receive after an rpc request
- */
-type RpcResponse<TRpcSchema extends RpcSchema, TMethod extends TRpcSchema[number]["Method"] = TRpcSchema[number]["Method"]> = {
-    result: Extract<TRpcSchema[number], {
-        Method: TMethod;
-    }>["ReturnType"];
-    error?: never;
-} | {
-    result?: never;
-    error: {
-        code: number;
-        message: string;
-        data?: unknown;
-    };
-};
-/**
- * Type used for a one shot request function
- */
-type RequestFn<TRpcSchema extends RpcSchema> = <TParameters extends ExtractedParametersFromRpc<TRpcSchema> = ExtractedParametersFromRpc<TRpcSchema>, _ReturnType = ExtractedReturnTypeFromRpc<TRpcSchema, TParameters>>(args: TParameters) => Promise<_ReturnType>;
-/**
- * Type used for a one shot request function
- */
-type ListenerRequestFn<TRpcSchema extends RpcSchema> = <TParameters extends ExtractedParametersFromRpc<TRpcSchema> = ExtractedParametersFromRpc<TRpcSchema>, _ReturnType = ExtractedReturnTypeFromRpc<TRpcSchema, TParameters>>(args: TParameters, callback: (result: _ReturnType) => void) => Promise<void>;
-/**
- * IFrame transport interface
- */
-type IFrameTransport = {
-    /**
-     * Wait for the connection to be established
-     */
-    waitForConnection: Promise<boolean>;
-    /**
-     * Wait for the setup to be done
-     */
-    waitForSetup: Promise<void>;
-    /**
-     * Function used to perform a single request via the iframe transport
-     */
-    request: RequestFn<IFrameRpcSchema>;
-    /**
-     * Function used to listen to a request response via the iframe transport
-     */
-    listenerRequest: ListenerRequestFn<IFrameRpcSchema>;
-    /**
-     * Function used to destroy the iframe transport
-     */
-    destroy: () => Promise<void>;
-};
-/**
- * Represent an iframe event
- */
-type IFrameEvent = IFrameRpcEvent | IFrameLifecycleEvent | ClientLifecycleEvent;
-/**
- * Represent an iframe rpc event
- */
-type IFrameRpcEvent = {
-    id: string;
-    topic: ExtractedParametersFromRpc<IFrameRpcSchema>["method"];
-    data: {
-        compressed: string;
-        compressedHash: string;
-    };
-};
-
-/**
- * Representing a Nexus client
- */
-type NexusClient = {
-    config: NexusWalletSdkConfig;
-} & IFrameTransport;
-
-/**
- * The type of the nexus context
- */
-type FrakContext = Readonly<{
-    r: Address;
-}>;
-
-export { type ClientLifecycleEvent as C, type DisplayModalParamsType as D, type ExtractedParametersFromRpc as E, type FrakContext as F, type GetProductInformationReturnType as G, type IFrameRpcSchema as I, type LoginModalStepType as L, type ModalStepTypes as M, type NexusWalletSdkConfig as N, type OpenSsoParamsType as O, type ProductTypesKey as P, type RpcResponse as R, type SsoMetadata as S, type WalletStatusReturnType as W, type NexusClient as a, productTypesMask as b, type ModalRpcMetadata as c, type ModalRpcStepsInput as d, type ModalRpcStepsResultType as e, type ModalStepMetadata as f, type SiweAuthenticateModalStepType as g, type SiweAuthenticationParams as h, type SiweAuthenticateReturnType as i, type SendTransactionTxType as j, type SendTransactionModalStepType as k, type SendTransactionReturnType as l, type OpenInteractionSessionReturnType as m, type OpenInteractionSessionModalStepType as n, type FinalModalStepType as o, productTypes as p, type FinalActionType as q, type IFrameTransport as r, type IFrameRpcEvent as s, type IFrameEvent as t, type IFrameLifecycleEvent as u, type ExtractedReturnTypeFromRpc as v };