@frak-labs/core-sdk 0.1.0 → 0.1.1-beta.4dfea079

package/dist/openSso-tkqaDQLV.d.ts

@@ -0,0 +1,1019 @@
+import { Address, Hex } from "viem";
+import { LifecycleMessage, RpcClient } from "@frak-labs/frame-connector";
+import { OpenPanel } from "@openpanel/web";
+import { SiweMessage } from "viem/siwe";
+
+//#region src/types/config.d.ts
+/**
+ * All the currencies available
+ * @category Config
+ */
+type Currency = "eur" | "usd" | "gbp";
+/**
+ * All the languages available
+ * @category Config
+ */
+type Language = "fr" | "en";
+/**
+ * Configuration for the Frak Wallet SDK
+ * @category Config
+ */
+type FrakWalletSdkConfig = {
+  /**
+   * The Frak wallet url
+   * @defaultValue "https://wallet.frak.id"
+   */
+  walletUrl?: string;
+  /**
+   * Some metadata about your implementation of the Frak SDK
+   */
+  metadata: {
+    /**
+     * Your application name (will be displayed in a few modals and in SSO)
+     */
+    name: string;
+    /**
+     * Your merchant ID from the Frak dashboard (UUID format)
+     * Used for referral tracking and analytics
+     * If not provided, will be auto-fetched from the backend using your domain
+     */
+    merchantId?: string;
+    /**
+     * Language to display in the modal
+     * If undefined, will default to the browser language
+     */
+    lang?: Language;
+    /**
+     * The currency to display in the modal
+     * @defaultValue `"eur"`
+     */
+    currency?: Currency;
+    /**
+     * The logo URL that will be displayed in a few components
+     */
+    logoUrl?: string;
+    /**
+     * The homepage link that could be displayed in a few components
+     */
+    homepageLink?: string;
+  };
+  /**
+   * Some customization for the modal
+   */
+  customizations?: {
+    /**
+     * Custom CSS styles to apply to the modals and components
+     */
+    css?: `${string}.css`;
+    /**
+     * Custom i18n configuration for the modal
+     */
+    i18n?: I18nConfig;
+  };
+  /**
+   * The domain name of your application
+   * @defaultValue window.location.host
+   */
+  domain?: string;
+};
+/**
+ * Custom i18n configuration for the modal
+ *  See [i18next json format](https://www.i18next.com/misc/json-format#i18next-json-v4)
+ *
+ * Available variables
+ *  - `{{ productName }}` : The name of your website (`metadata.name`)
+ *  - `{{ productOrigin }}` : The origin url of your website
+ *  - `{{ estimatedReward }}` : The estimated reward for the user (based on the specific `targetInteraction` you can specify, or the max referrer reward if no target interaction is specified)
+ *
+ * Context of the translation [see i18n context](https://www.i18next.com/translation-function/context)
+ *  - For modal display, the key of the final action (`sharing`, `reward`, or undefined)
+ *  - For embedded wallet display, the key of the logged in action (`sharing` or undefined)
+ *
+ * @example
+ * ```ts
+ * // Multi language config
+ * const multiI18n = {
+ *  fr: {
+ *      "sdk.modal.title": "Titre de modal",
+ *      "sdk.modal.description": "Description de modal, avec {{ estimatedReward }} de gains possible",
+ *  },
+ *  en: "https://example.com/en.json"
+ * }
+ *
+ * // Single language config
+ * const singleI18n = {
+ *      "sdk.modal.title": "Modal title",
+ *      "sdk.modal.description": "Modal description, with {{ estimatedReward }} of gains possible",
+ * }
+ * ```
+ *
+ * @category Config
+ */
+type I18nConfig = Record<Language, LocalizedI18nConfig> | LocalizedI18nConfig;
+/**
+ * A localized i18n config
+ * @category Config
+ */
+type LocalizedI18nConfig = `${string}.css` | {
+  [key: string]: string;
+};
+//#endregion
+//#region src/types/lifecycle/client.d.ts
+/**
+ * Event related to the iframe lifecycle
+ * @ignore
+ */
+type ClientLifecycleEvent = CustomCssEvent | CustomI18nEvent | RestoreBackupEvent | HearbeatEvent | HandshakeResponse | SsoRedirectCompleteEvent | DeepLinkFailedEvent;
+type CustomCssEvent = {
+  clientLifecycle: "modal-css";
+  data: {
+    cssLink: string;
+  };
+};
+type CustomI18nEvent = {
+  clientLifecycle: "modal-i18n";
+  data: {
+    i18n: I18nConfig;
+  };
+};
+type RestoreBackupEvent = {
+  clientLifecycle: "restore-backup";
+  data: {
+    backup: string;
+  };
+};
+type HearbeatEvent = {
+  clientLifecycle: "heartbeat";
+  data?: never;
+};
+type HandshakeResponse = {
+  clientLifecycle: "handshake-response";
+  data: {
+    token: string;
+    currentUrl: string;
+    /**
+     * The anonymous client ID for identity tracking
+     * Generated by SDK, stored in partner site's localStorage
+     */
+    clientId: string;
+    /**
+     * Pending merge token extracted from URL (?fmt= parameter)
+     * When present, listener should execute identity merge in background
+     * URL is cleaned after handshake response is sent
+     */
+    pendingMergeToken?: string;
+    /**
+     * Explicit domain from SDK config (FrakWalletSdkConfig.domain)
+     * When present, listener should prefer this over URL-derived domain
+     * for merchant resolution (handles proxied/tunneled environments)
+     */
+    configDomain?: string;
+  };
+};
+type SsoRedirectCompleteEvent = {
+  clientLifecycle: "sso-redirect-complete";
+  data: {
+    compressed: string;
+  };
+};
+type DeepLinkFailedEvent = {
+  clientLifecycle: "deep-link-failed";
+  data: {
+    originalUrl: string;
+  };
+};
+//#endregion
+//#region src/types/lifecycle/iframe.d.ts
+/**
+ * Event related to the iframe lifecycle
+ * @ignore
+ */
+type IFrameLifecycleEvent = {
+  iframeLifecycle: "connected" | "show" | "hide" | "remove-backup";
+  data?: never;
+} | DoBackupEvent | HandshakeRequestEvent | RedirectRequestEvent;
+type DoBackupEvent = {
+  iframeLifecycle: "do-backup";
+  data: {
+    backup?: string;
+  };
+};
+type HandshakeRequestEvent = {
+  iframeLifecycle: "handshake";
+  data: {
+    token: string;
+  };
+};
+type RedirectRequestEvent = {
+  iframeLifecycle: "redirect";
+  data: {
+    /**
+     * The base url to redirect to
+     *  If it contain a query param `u`, the client need will suffix the current url to the base url
+     */
+    baseRedirectUrl: string;
+    /**
+     * Optional merge token for anonymous identity merging
+     * When provided, appended as ?fmt= query parameter to the final redirect URL
+     * Used when redirecting out of social browsers to preserve identity across contexts
+     */
+    mergeToken?: string;
+  };
+};
+//#endregion
+//#region src/constants/interactionTypes.d.ts
+/**
+ * The supported interaction type keys
+ *
+ * - `referral` - User arrived via a referral link
+ * - `create_referral_link` - User created/shared a referral link
+ * - `purchase` - User completed a purchase
+ * - `custom.${string}` - Custom interaction type defined per campaign
+ *
+ * @inline
+ */
+type InteractionTypeKey = "referral" | "create_referral_link" | "purchase" | `custom.${string}`;
+//#endregion
+//#region src/types/rpc/modal/generic.d.ts
+/**
+ * Represent a generic modal step type
+ * @ignore
+ * @inline
+ */
+type GenericModalStepType<TKey, TParams, TReturns> = {
+  key: TKey;
+  params: TParams extends never ? ModalStepMetadata : ModalStepMetadata & TParams;
+  returns: TReturns;
+};
+/**
+ * Metadata that can be used to customize a modal step
+ * @group Modal Display
+ * @deprecated Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
+ */
+type ModalStepMetadata = {
+  metadata?: {
+    /**
+     * Custom title for the step
+     * If none provided, it will use an internationalized text
+     * @deprecated Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
+     */
+    title?: string;
+    /**
+     * Custom description for the step
+     * If none provided, it will use an internationalized text
+     * @deprecated Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
+     */
+    description?: string;
+    /**
+     * Custom text for the primary action of the step
+     * If none provided, it will use an internationalized text
+     * @deprecated Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
+     */
+    primaryActionText?: string;
+    /**
+     * Custom text for the secondary action of the step
+     * If none provided, it will use an internationalized text
+     * @deprecated Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
+     */
+    secondaryActionText?: string;
+  };
+};
+//#endregion
+//#region src/types/rpc/modal/final.d.ts
+/**
+ * The final modal step type, could be used to display sharing options or a success reward screen.
+ *
+ * **Input**: What type final step to display?
+ * **Output**: None
+ *
+ * @group Modal Display
+ */
+type FinalModalStepType = GenericModalStepType<"final", {
+  dismissedMetadata?: ModalStepMetadata["metadata"];
+  action: FinalActionType;
+  autoSkip?: boolean;
+}, object>;
+/**
+ * The different types of final actions we can display in the final step
+ * @group Modal Display
+ */
+type FinalActionType = {
+  key: "sharing";
+  options?: {
+    /**
+     * @deprecated Use the top level `config.metadata.i18n` instead
+     */
+    popupTitle?: string;
+    /**
+     * @deprecated Use the top level `config.metadata.i18n` instead
+     */
+    text?: string;
+    link?: string;
+  };
+} | {
+  key: "reward";
+  options?: never;
+};
+//#endregion
+//#region src/types/rpc/sso.d.ts
+/**
+ * SSO Metadata
+ */
+type SsoMetadata = {
+  /**
+   * URL to your client, if provided will be displayed in the SSO header
+   */
+  logoUrl?: string;
+  /**
+   * Link to your homepage, if referenced your app name will contain a link on the sso page
+   */
+  homepageLink?: string;
+};
+/**
+ * Params for preparing SSO (generating URL)
+ * Same as OpenSsoParamsType but without openInSameWindow (popup-only operation)
+ * @group RPC Schema
+ */
+type PrepareSsoParamsType = {
+  /**
+   * Redirect URL after the SSO (optional)
+   */
+  redirectUrl?: string;
+  /**
+   * If the SSO should directly exit after completion
+   * @defaultValue true
+   */
+  directExit?: boolean;
+  /**
+   * Language of the SSO page (optional)
+   * It will default to the current user language (or "en" if unsupported language)
+   */
+  lang?: "en" | "fr";
+  /**
+   * Custom SSO metadata
+   */
+  metadata?: SsoMetadata;
+};
+/**
+ * Response after preparing SSO
+ * @group RPC Schema
+ */
+type PrepareSsoReturnType = {
+  /**
+   * The SSO URL that should be opened in a popup
+   */
+  ssoUrl: string;
+};
+/**
+ * Response after an SSO has been openned
+ */
+type OpenSsoReturnType = {
+  /**
+   * Optional wallet address, returned when SSO completes via postMessage
+   * Note: Only present when SSO flow completes (not immediately on open)
+   */
+  wallet?: Hex;
+};
+/**
+ * Params to start a SSO
+ * @group RPC Schema
+ */
+type OpenSsoParamsType = PrepareSsoParamsType & {
+  /**
+   * Indicate whether we want todo the flow within the same window context, or if we want to do it with an external popup window openned
+   * Note: Default true if redirectUrl is present, otherwise, false
+   */
+  openInSameWindow?: boolean;
+  /**
+   * Custom SSO popup url if user want additionnal customisation
+   */
+  ssoPopupUrl?: string;
+};
+//#endregion
+//#region src/types/rpc/modal/login.d.ts
+/** @inline */
+type LoginWithSso = {
+  allowSso: true;
+  ssoMetadata?: SsoMetadata;
+};
+/** @inline */
+type LoginWithoutSso = {
+  allowSso?: false;
+  ssoMetadata?: never;
+};
+/**
+ * The login step for a Modal
+ *
+ * **Input**: Do we allow SSO or not? Is yes then the SSO metadata
+ * **Output**: The logged in wallet address
+ *
+ * @group Modal Display
+ */
+type LoginModalStepType = GenericModalStepType<"login", LoginWithSso | LoginWithoutSso, {
+  wallet: Address;
+  webauthnProof?: {
+    challenge: Hex;
+    authenticatorResponse: string;
+  };
+}>;
+//#endregion
+//#region src/types/rpc/modal/siweAuthenticate.d.ts
+/**
+ * Parameters used send a SIWE rpc request
+ */
+type SiweAuthenticationParams = Omit<SiweMessage, "address" | "chainId" | "expirationTime" | "issuedAt" | "notBefore"> & {
+  expirationTimeTimestamp?: number;
+  notBeforeTimestamp?: number;
+};
+/**
+ * Return type of the Siwe transaction rpc request
+ * @inline
+ */
+type SiweAuthenticateReturnType = {
+  signature: Hex;
+  message: string;
+};
+/**
+ * The SIWE authentication step for a Modal
+ *
+ * **Input**: SIWE message parameters
+ * **Output**: SIWE result (message signed and wallet signature)
+ *
+ * @group Modal Display
+ */
+type SiweAuthenticateModalStepType = GenericModalStepType<"siweAuthenticate", {
+  siwe: SiweAuthenticationParams;
+}, SiweAuthenticateReturnType>;
+//#endregion
+//#region src/types/rpc/modal/transaction.d.ts
+/**
+ * Generic format representing a tx to be sent
+ */
+type SendTransactionTxType = {
+  to: Address;
+  data?: Hex;
+  value?: Hex;
+};
+/**
+ * Return type of the send transaction rpc request
+ * @inline
+ */
+type SendTransactionReturnType = {
+  hash: Hex;
+};
+/**
+ * The send transaction step for a Modal
+ *
+ * **Input**: Either a single tx or an array of tx to be sent
+ * **Output**: The hash of the tx(s) hash (in case of multiple tx, still returns a single hash because it's bundled on the wallet level)
+ *
+ * @group Modal Display
+ */
+type SendTransactionModalStepType = GenericModalStepType<"sendTransaction", {
+  tx: SendTransactionTxType | SendTransactionTxType[];
+}, SendTransactionReturnType>;
+//#endregion
+//#region src/types/rpc/displayModal.d.ts
+/**
+ * Generic type of steps we will display in the modal to the end user
+ * @group Modal Display
+ */
+type ModalStepTypes = LoginModalStepType | SiweAuthenticateModalStepType | SendTransactionModalStepType | FinalModalStepType;
+/**
+ * Type for the result of a modal request
+ * Just the `returns` type of each `ModalStepTypes`
+ * @typeParam T - The list of modal steps we expect to have in the modal
+ * @group Modal Display
+ * @group RPC Schema
+ */
+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
+ * Just the `params` type of each `ModalStepTypes`
+ * @typeParam T - The list of modal steps we expect to have in the modal
+ * @group Modal Display
+ * @group RPC Schema
+ */
+type ModalRpcStepsInput<T extends ModalStepTypes[] = ModalStepTypes[]> = { [K in T[number]["key"]]?: Extract<T[number], {
+  key: K;
+}>["params"] };
+/**
+ * RPC metadata for the modal, used on top level modal configuration
+ * @group Modal Display
+ * @group RPC Schema
+ */
+type ModalRpcMetadata = {
+  header?: {
+    title?: string;
+    icon?: string;
+  };
+  targetInteraction?: InteractionTypeKey;
+  /**
+   * Some i18n override for the displayed modal (i.e. update the displayed text only for this modal)
+   */
+  i18n?: I18nConfig;
+} & ({
+  isDismissible: true;
+  /**
+   * @deprecated Use `config.customizations.i18n` or `metadata.i18n` instead
+   */
+  dismissActionTxt?: string;
+} | {
+  isDismissible?: false;
+  dismissActionTxt?: never;
+});
+/**
+ * Params used to display a modal
+ * @typeParam T - The list of modal steps we expect to have in the modal
+ * @group Modal Display
+ */
+type DisplayModalParamsType<T extends ModalStepTypes[]> = {
+  steps: ModalRpcStepsInput<T>;
+  metadata?: ModalRpcMetadata;
+};
+//#endregion
+//#region src/types/rpc/embedded/loggedIn.d.ts
+/**
+ * The different type of action we can have on the embedded view (once the user is logged in)
+ *
+ * @group Embedded wallet
+ */
+type EmbeddedViewActionSharing = {
+  key: "sharing";
+  /**
+   * Some sharing options
+   */
+  options?: {
+    /**
+     * The title that will be displayed on the system popup once the system sharing window is open
+     * @deprecated Use the top level `config.metadata.i18n` instead
+     */
+    popupTitle?: string;
+    /**
+     * The text that will be shared alongside the link.
+     * Can contain the variable `{LINK}` to specify where the link is placed, otherwise it will be added at the end
+     * @deprecated Use the top level `config.metadata.i18n` instead
+     */
+    text?: string;
+    /**
+     * The link to be shared (will be suffixed with the Frak sharing context)
+     */
+    link?: string;
+  };
+};
+/**
+ * The action to display on the logged out embedded view when the user is referred
+ *
+ * @group Embedded wallet
+ */
+type EmbeddedViewActionReferred = {
+  key: "referred";
+  /**
+   * No options for a referred action
+   */
+  options?: never;
+};
+/**
+ * Some configuration options for the embedded view
+ *
+ * @group Embedded wallet
+ */
+type LoggedInEmbeddedView = {
+  /**
+   * The main action to display on the logged in embedded view
+   */
+  action?: EmbeddedViewActionSharing | EmbeddedViewActionReferred;
+};
+//#endregion
+//#region src/types/rpc/embedded/loggedOut.d.ts
+/**
+ * The view when a user is logged out
+ * @group Embedded wallet
+ */
+type LoggedOutEmbeddedView = {
+  /**
+   * Metadata option when displaying the embedded view
+   */
+  metadata?: {
+    /**
+     * The main CTA for the logged out view
+     *  - can include some variable, available ones are:
+     *      - `{REWARD}` -> The maximum reward a user can receive when interacting on your website
+     *  - can be formatted in markdown
+     *
+     * If not set, it will default to a internationalized message
+     * @deprecated Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
+     */
+    text?: string;
+    /**
+     * The text that will be displayed on the login button
+     *
+     * If not set, it will default to a internationalized message
+     * @deprecated Use the top level `config.customizations.i18n`, or `metadata.i18n` instead
+     */
+    buttonText?: string;
+  };
+};
+//#endregion
+//#region src/types/rpc/embedded/index.d.ts
+/**
+ * The params used to display the embedded wallet
+ *
+ * @group Embedded wallet
+ */
+type DisplayEmbeddedWalletParamsType = {
+  /**
+   * The embedded view to display once the user is logged in
+   */
+  loggedIn?: LoggedInEmbeddedView;
+  /**
+   * The embedded view to display once the user is logged out
+   */
+  loggedOut?: LoggedOutEmbeddedView;
+  /**
+   * Some metadata to customize the embedded view
+   */
+  metadata?: {
+    /**
+     * The logo to display on the embedded wallet
+     * If undefined, will default to no logo displayed
+     */
+    logo?: string;
+    /**
+     * Link to the homepage of the calling website
+     * If undefined, will default to the domain of the calling website
+     */
+    homepageLink?: string;
+    /**
+     * The target interaction behind this modal
+     */
+    targetInteraction?: InteractionTypeKey;
+    /**
+     * The position of the component
+     */
+    position?: "left" | "right";
+    /**
+     * Some i18n override for the displayed modal (i.e. update the displayed text only for this modal)
+     */
+    i18n?: I18nConfig;
+  };
+};
+/**
+ * The result of the display embedded wallet rpc request
+ *
+ * @group Embedded wallet
+ */
+type DisplayEmbeddedWalletResultType = {
+  wallet: Address;
+};
+//#endregion
+//#region src/types/rpc/interaction.d.ts
+/**
+ * Parameters for sending interactions via RPC
+ *
+ * Note: merchantId and clientId come from WalletRpcContext
+ * and are NOT included in the params - they are resolved by the listener
+ *
+ * @group RPC Schema
+ */
+type SendInteractionParamsType = {
+  type: "arrival";
+  referrerWallet?: Address;
+  landingUrl?: string;
+  utmSource?: string;
+  utmMedium?: string;
+  utmCampaign?: string;
+  utmTerm?: string;
+  utmContent?: string;
+} | {
+  type: "sharing";
+} | {
+  type: "custom";
+  customType: string;
+  data?: Record<string, unknown>;
+  idempotencyKey?: string;
+};
+//#endregion
+//#region src/types/rpc/merchantInformation.d.ts
+/**
+ * The type for the amount of tokens
+ */
+type TokenAmountType = {
+  amount: number;
+  eurAmount: number;
+  usdAmount: number;
+  gbpAmount: number;
+};
+/**
+ * A tier definition for tiered rewards
+ */
+type RewardTier = {
+  minValue: number;
+  maxValue?: number;
+  amount: TokenAmountType;
+};
+/**
+ * Estimated reward amount — discriminated union by payout type
+ *
+ * - `fixed`: A known token amount (with fiat equivalents)
+ * - `percentage`: A percent of a purchase field (e.g. 5% of purchase_amount), with optional min/max caps
+ * - `tiered`: Amount depends on a field value matching tier brackets
+ */
+type EstimatedReward = {
+  payoutType: "fixed";
+  amount: TokenAmountType;
+} | {
+  payoutType: "percentage";
+  percent: number;
+  percentOf: string;
+  maxAmount?: TokenAmountType;
+  minAmount?: TokenAmountType;
+} | {
+  payoutType: "tiered";
+  tierField: string;
+  tiers: RewardTier[];
+};
+/**
+ * Response of the `frak_getMerchantInformation` RPC method
+ * @group RPC Schema
+ */
+type GetMerchantInformationReturnType = {
+  /**
+   * Current merchant id
+   */
+  id: string;
+  /**
+   * Some metadata
+   */
+  onChainMetadata: {
+    /**
+     * Name of the merchant on-chain
+     */
+    name: string;
+    /**
+     * Domain of the merchant on-chain
+     */
+    domain: string;
+  };
+  rewards: {
+    token?: Address;
+    campaignId: string;
+    interactionTypeKey: InteractionTypeKey;
+    referrer?: EstimatedReward;
+    referee?: EstimatedReward;
+  }[];
+};
+//#endregion
+//#region src/types/rpc/walletStatus.d.ts
+/**
+ * RPC Response for the method `frak_listenToWalletStatus`
+ * @group RPC Schema
+ */
+type WalletStatusReturnType = WalletConnected | WalletNotConnected;
+/**
+ * @ignore
+ * @inline
+ */
+type WalletConnected = {
+  key: "connected";
+  wallet: Address;
+  interactionToken?: string;
+};
+/**
+ * @ignore
+ * @inline
+ */
+type WalletNotConnected = {
+  key: "not-connected";
+  wallet?: never;
+  interactionToken?: never;
+};
+//#endregion
+//#region src/types/rpc.d.ts
+/**
+ * RPC interface that's used for the iframe communication
+ *
+ * Define all the methods available within the iFrame RPC client with response type annotations
+ *
+ * @group RPC Schema
+ *
+ * @remarks
+ * Each method in the schema now includes a ResponseType field that indicates:
+ * - "promise": One-shot request that resolves once
+ * - "stream": Streaming request that can emit multiple values
+ *
+ * ### Methods:
+ *
+ * #### frak_listenToWalletStatus
+ *  - Params: None
+ *  - Returns: {@link WalletStatusReturnType}
+ *  - Response Type: stream (emits updates when wallet status changes)
+ *
+ * #### frak_displayModal
+ * - Params: [requests: {@link ModalRpcStepsInput}, metadata?: {@link ModalRpcMetadata}, configMetadata: {@link FrakWalletSdkConfig}["metadata"]]
+ * - Returns: {@link ModalRpcStepsResultType}
+ * - Response Type: promise (one-shot)
+ *
+ * #### frak_sso
+ *  - Params: [params: {@link OpenSsoParamsType}, name: string, customCss?: string]
+ *  - Returns: {@link OpenSsoReturnType}
+ *  - Response Type: promise (one-shot)
+ *
+ * #### frak_getMerchantInformation
+ *  - Params: None
+ *  - Returns: {@link GetMerchantInformationReturnType}
+ *  - Response Type: promise (one-shot)
+ *
+ * #### frak_displayEmbeddedWallet
+ * - Params: [request: {@link DisplayEmbeddedWalletParamsType}, metadata: {@link FrakWalletSdkConfig}["metadata"]]
+ * - Returns: {@link DisplayEmbeddedWalletResultType}
+ * - Response Type: promise (one-shot)
+ */
+type IFrameRpcSchema = [
+/**
+ * Method used to listen to the wallet status
+ * This is a streaming method that emits updates when wallet status changes
+ */
+{
+  Method: "frak_listenToWalletStatus";
+  Parameters?: undefined;
+  ReturnType: WalletStatusReturnType;
+},
+/**
+ * Method to display a modal with the provided steps
+ * This is a one-shot request
+ */
+{
+  Method: "frak_displayModal";
+  Parameters: [requests: ModalRpcStepsInput, metadata: ModalRpcMetadata | undefined, configMetadata: FrakWalletSdkConfig["metadata"]];
+  ReturnType: ModalRpcStepsResultType;
+},
+/**
+ * Method to prepare SSO (generate URL for popup)
+ * Returns the SSO URL that should be opened in a popup
+ * Only used for popup flows (not redirect flows)
+ */
+{
+  Method: "frak_prepareSso";
+  Parameters: [params: PrepareSsoParamsType, name: string, customCss?: string];
+  ReturnType: PrepareSsoReturnType;
+},
+/**
+ * Method to open/trigger SSO
+ * Either triggers redirect (if openInSameWindow/redirectUrl)
+ * Or waits for popup completion (if popup mode)
+ * This method handles BOTH redirect and popup flows
+ */
+{
+  Method: "frak_openSso";
+  Parameters: [params: OpenSsoParamsType, name: string, customCss?: string];
+  ReturnType: OpenSsoReturnType;
+},
+/**
+ * Method to get current merchant information
+ *  - Is merchant registered?
+ *  - Does it have running campaign?
+ *  - Estimated reward on actions
+ * This is a one-shot request
+ */
+{
+  Method: "frak_getMerchantInformation";
+  Parameters?: undefined;
+  ReturnType: GetMerchantInformationReturnType;
+},
+/**
+ * Method to show the embedded wallet, with potential customization
+ * This is a one-shot request
+ */
+{
+  Method: "frak_displayEmbeddedWallet";
+  Parameters: [request: DisplayEmbeddedWalletParamsType, metadata: FrakWalletSdkConfig["metadata"]];
+  ReturnType: DisplayEmbeddedWalletResultType;
+},
+/**
+ * Method to send interactions (arrival, sharing, custom events)
+ * Fire-and-forget method - no return value expected
+ * merchantId and clientId are resolved from context
+ */
+{
+  Method: "frak_sendInteraction";
+  Parameters: [interaction: SendInteractionParamsType];
+  ReturnType: undefined;
+}];
+//#endregion
+//#region src/types/transport.d.ts
+/**
+ * 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: RpcClient<IFrameRpcSchema, LifecycleMessage>["request"];
+  /**
+   * Function used to listen to a request response via the iframe transport
+   */
+  listenerRequest: RpcClient<IFrameRpcSchema, LifecycleMessage>["listen"];
+  /**
+   * Function used to destroy the iframe transport
+   */
+  destroy: () => Promise<void>;
+};
+/**
+ * Represent an iframe event
+ */
+type FrakLifecycleEvent = IFrameLifecycleEvent | ClientLifecycleEvent;
+//#endregion
+//#region src/types/client.d.ts
+/**
+ * Representing a Frak client, used to interact with the Frak Wallet
+ */
+type FrakClient = {
+  config: FrakWalletSdkConfig;
+  debugInfo: {
+    formatDebugInfo: (error: Error | unknown | string) => string;
+  };
+  openPanel?: OpenPanel;
+} & IFrameTransport;
+//#endregion
+//#region src/types/context.d.ts
+/**
+ * The current Frak Context
+ *
+ * For now, only contain a referrer address.
+ *
+ * @ignore
+ */
+type FrakContext = {
+  r: Address;
+};
+//#endregion
+//#region src/actions/openSso.d.ts
+declare const ssoPopupFeatures = "menubar=no,status=no,scrollbars=no,fullscreen=no,width=500, height=800";
+declare const ssoPopupName = "frak-sso";
+/**
+ * Function used to open the SSO
+ * @param client - The current Frak Client
+ * @param args - The SSO parameters
+ *
+ * @description Two SSO flow modes:
+ *
+ * **Redirect Mode** (openInSameWindow: true):
+ * - Wallet generates URL and triggers redirect
+ * - Used when redirectUrl is provided
+ *
+ * **Popup Mode** (openInSameWindow: false/omitted):
+ * - SDK generates URL client-side (or uses provided ssoPopupUrl)
+ * - Opens popup synchronously (prevents popup blockers)
+ * - Waits for SSO completion via postMessage
+ *
+ * @example
+ * First we build the sso metadata
+ * ```ts
+ * // Build the metadata
+ * const metadata: SsoMetadata = {
+ *     logoUrl: "https://my-app.com/logo.png",
+ *     homepageLink: "https://my-app.com",
+ * };
+ * ```
+ *
+ * Then, either use it with direct exit (and so user is directly redirected to your website), or a custom redirect URL
+ * :::code-group
+ * ```ts [Popup (default)]
+ * // Opens in popup, SDK generates URL automatically
+ * await openSso(frakConfig, {
+ *     directExit: true,
+ *     metadata,
+ * });
+ * ```
+ * ```ts [Redirect]
+ * // Opens in same window with redirect
+ * await openSso(frakConfig, {
+ *     redirectUrl: "https://my-app.com/frak-sso",
+ *     metadata,
+ *     openInSameWindow: true,
+ * });
+ * ```
+ * ```ts [Custom popup URL]
+ * // Advanced: provide custom SSO URL
+ * const { ssoUrl } = await prepareSso(frakConfig, { metadata });
+ * await openSso(frakConfig, {
+ *     metadata,
+ *     ssoPopupUrl: `${ssoUrl}&custom=param`,
+ * });
+ * ```
+ * :::
+ */
+declare function openSso(client: FrakClient, args: OpenSsoParamsType): Promise<OpenSsoReturnType>;
+//#endregion
+export { SiweAuthenticateReturnType as A, ModalStepMetadata as B, ModalRpcStepsInput as C, SendTransactionReturnType as D, SendTransactionModalStepType as E, PrepareSsoParamsType as F, FrakWalletSdkConfig as G, IFrameLifecycleEvent as H, PrepareSsoReturnType as I, LocalizedI18nConfig as J, I18nConfig as K, SsoMetadata as L, LoginModalStepType as M, OpenSsoParamsType as N, SendTransactionTxType as O, OpenSsoReturnType as P, FinalActionType as R, ModalRpcMetadata as S, ModalStepTypes as T, ClientLifecycleEvent as U, InteractionTypeKey as V, Currency as W, LoggedOutEmbeddedView as _, FrakClient as a, LoggedInEmbeddedView as b, IFrameRpcSchema as c, GetMerchantInformationReturnType as d, RewardTier as f, DisplayEmbeddedWalletResultType as g, DisplayEmbeddedWalletParamsType as h, FrakContext as i, SiweAuthenticationParams as j, SiweAuthenticateModalStepType as k, WalletStatusReturnType as l, SendInteractionParamsType as m, ssoPopupFeatures as n, FrakLifecycleEvent as o, TokenAmountType as p, Language as q, ssoPopupName as r, IFrameTransport as s, openSso as t, EstimatedReward as u, EmbeddedViewActionReferred as v, ModalRpcStepsResultType as w, DisplayModalParamsType as x, EmbeddedViewActionSharing as y, FinalModalStepType as z };