@frak-labs/core-sdk 0.1.1 → 0.2.0

package/dist/{openSso-D--Airj6.d.cts → openSso-BCJGchIb.d.cts}

@@ -1,4 +1,3 @@
-import { r as SendInteractionReturnType, t as PreparedInteraction } from "./interaction-DMJ3ZfaF.cjs";
 import { OpenPanel } from "@openpanel/web";
 import { LifecycleMessage, RpcClient } from "@frak-labs/frame-connector";
 import { Address, Hex } from "viem";
@@ -33,6 +32,12 @@ type FrakWalletSdkConfig = {
      * 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
@@ -118,7 +123,7 @@ type LocalizedI18nConfig = `${string}.css` | {
  * Event related to the iframe lifecycle
  * @ignore
  */
-type ClientLifecycleEvent = CustomCssEvent | CustomI18nEvent | RestoreBackupEvent | HearbeatEvent | HandshakeResponse | SsoRedirectCompleteEvent;
+type ClientLifecycleEvent = CustomCssEvent | CustomI18nEvent | RestoreBackupEvent | HearbeatEvent | HandshakeResponse | SsoRedirectCompleteEvent | DeepLinkFailedEvent;
 type CustomCssEvent = {
   clientLifecycle: "modal-css";
   data: {
@@ -146,6 +151,23 @@ type HandshakeResponse = {
   data: {
     token: string;
     currentUrl: 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;
+    /**
+     * Client ID for identity tracking (belt & suspenders fallback)
+     * Primary delivery is via iframe URL query param; handshake is backup for SSR
+     */
+    clientId?: 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 = {
@@ -154,6 +176,12 @@ type SsoRedirectCompleteEvent = {
     compressed: string;
   };
 };
+type DeepLinkFailedEvent = {
+  clientLifecycle: "deep-link-failed";
+  data: {
+    originalUrl: string;
+  };
+};
 //#endregion
 //#region src/types/lifecycle/iframe.d.ts
 /**
@@ -184,48 +212,27 @@ type RedirectRequestEvent = {
      *  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 final keys for each interaction types (e.g. `openArticle`) -> interaction type
- * @inline
- */
-type InteractionTypesKey = { [K in keyof typeof interactionTypes]: keyof (typeof interactionTypes)[K] }[keyof typeof interactionTypes];
-/**
- * The keys for each interaction types (e.g. `press.openArticle`) -> category_type.interaction_type
+ * 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 FullInteractionTypesKey = { [Category in keyof typeof interactionTypes]: `${Category & string}.${keyof (typeof interactionTypes)[Category] & string}` }[keyof typeof interactionTypes];
-/**
- * Each interactions types according to the product types
- */
-declare const interactionTypes: {
-  readonly press: {
-    readonly openArticle: "0xc0a24ffb";
-    readonly readArticle: "0xd5bd0fbe";
-  };
-  readonly dapp: {
-    readonly proofVerifiableStorageUpdate: "0x2ab2aeef";
-    readonly callableVerifiableStorageUpdate: "0xa07da986";
-  };
-  readonly webshop: {
-    readonly open: "0xb311798f";
-  };
-  readonly referral: {
-    readonly referred: "0x010cc3b9";
-    readonly createLink: "0xb2c0f17c";
-  };
-  readonly purchase: {
-    readonly started: "0xd87e90c3";
-    readonly completed: "0x8403aeb4";
-    readonly unsafeCompleted: "0x4d5b14e0";
-  };
-  readonly retail: {
-    readonly customerMeeting: "0x74489004";
-  };
-};
+type InteractionTypeKey = "referral" | "create_referral_link" | "purchase" | `custom.${string}`;
 //#endregion
 //#region src/types/rpc/modal/generic.d.ts
 /**
@@ -404,28 +411,12 @@ type LoginWithoutSso = {
  */
 type LoginModalStepType = GenericModalStepType<"login", LoginWithSso | LoginWithoutSso, {
   wallet: Address;
+  webauthnProof?: {
+    challenge: Hex;
+    authenticatorResponse: string;
+  };
 }>;
 //#endregion
-//#region src/types/rpc/modal/openSession.d.ts
-/**
- * Return type of the open session modal step
- * @inline
- * @ignore
- */
-type OpenInteractionSessionReturnType = {
-  startTimestamp: number;
-  endTimestamp: number;
-};
-/**
- * The open interaction session step for a Modal
- *
- * **Input**: None
- * **Output**: The interactions session period (start and end timestamp)
- *
- * @group Modal Display
- */
-type OpenInteractionSessionModalStepType = GenericModalStepType<"openSession", object, OpenInteractionSessionReturnType>;
-//#endregion
 //#region src/types/rpc/modal/siweAuthenticate.d.ts
 /**
  * Parameters used send a SIWE rpc request
@@ -487,7 +478,7 @@ type SendTransactionModalStepType = GenericModalStepType<"sendTransaction", {
  * Generic type of steps we will display in the modal to the end user
  * @group Modal Display
  */
-type ModalStepTypes = LoginModalStepType | SiweAuthenticateModalStepType | SendTransactionModalStepType | OpenInteractionSessionModalStepType | FinalModalStepType;
+type ModalStepTypes = LoginModalStepType | SiweAuthenticateModalStepType | SendTransactionModalStepType | FinalModalStepType;
 /**
  * Type for the result of a modal request
  * Just the `returns` type of each `ModalStepTypes`
@@ -518,7 +509,7 @@ type ModalRpcMetadata = {
     title?: string;
     icon?: string;
   };
-  targetInteraction?: FullInteractionTypesKey;
+  targetInteraction?: InteractionTypeKey;
   /**
    * Some i18n override for the displayed modal (i.e. update the displayed text only for this modal)
    */
@@ -658,7 +649,7 @@ type DisplayEmbeddedWalletParamsType = {
     /**
      * The target interaction behind this modal
      */
-    targetInteraction?: FullInteractionTypesKey;
+    targetInteraction?: InteractionTypeKey;
     /**
      * The position of the component
      */
@@ -678,29 +669,34 @@ type DisplayEmbeddedWalletResultType = {
   wallet: Address;
 };
 //#endregion
-//#region src/constants/productTypes.d.ts
-/**
- * The keys for each product types
- * @inline
- */
-type ProductTypesKey = keyof typeof productTypes;
+//#region src/types/rpc/interaction.d.ts
 /**
- * List of the product types per denominator
+ * 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
  */
-declare const productTypes: {
-  dapp: number;
-  press: number;
-  webshop: number;
-  retail: number;
-  referral: number;
-  purchase: number;
+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;
 };
-/**
- * Bitmask for each product types
- */
-declare const productTypesMask: Record<ProductTypesKey, bigint>;
 //#endregion
-//#region src/types/rpc/productInformation.d.ts
+//#region src/types/rpc/merchantInformation.d.ts
 /**
  * The type for the amount of tokens
  */
@@ -711,48 +707,62 @@ type TokenAmountType = {
   gbpAmount: number;
 };
 /**
- * Response of the `frak_getProductInformation` RPC method
+ * 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 GetProductInformationReturnType = {
+type GetMerchantInformationReturnType = {
   /**
-   * Current product id
+   * Current merchant id
    */
-  id: Hex;
+  id: string;
   /**
    * Some metadata
    */
   onChainMetadata: {
     /**
-     * Name of the product on-chain
+     * Name of the merchant on-chain
      */
     name: string;
     /**
-     * Domain of the product on-chain
+     * Domain of the merchant on-chain
      */
     domain: string;
-    /**
-     * The supported product types
-     */
-    productTypes: ProductTypesKey[];
   };
-  /**
-   * The max potential reward for the referrer
-   */
-  maxReferrer?: TokenAmountType;
-  /**
-   * The max potential reward for the referee
-   */
-  maxReferee?: TokenAmountType;
-  /**
-   * List of all the potentials reward arround this product
-   */
   rewards: {
-    token: Address;
-    campaign: Address;
-    interactionTypeKey: FullInteractionTypesKey;
-    referrer: TokenAmountType;
-    referee: TokenAmountType;
+    token?: Address;
+    campaignId: string;
+    interactionTypeKey: InteractionTypeKey;
+    referrer?: EstimatedReward;
+    referee?: EstimatedReward;
   }[];
 };
 //#endregion
@@ -770,10 +780,6 @@ type WalletConnected = {
   key: "connected";
   wallet: Address;
   interactionToken?: string;
-  interactionSession?: {
-    startTimestamp: number;
-    endTimestamp: number;
-  };
 };
 /**
  * @ignore
@@ -783,7 +789,6 @@ type WalletNotConnected = {
   key: "not-connected";
   wallet?: never;
   interactionToken?: never;
-  interactionSession?: never;
 };
 //#endregion
 //#region src/types/rpc.d.ts
@@ -811,19 +816,14 @@ type WalletNotConnected = {
  * - Returns: {@link ModalRpcStepsResultType}
  * - Response Type: promise (one-shot)
  *
- * #### frak_sendInteraction
- *  - Params: [productId: Hex, interaction: {@link PreparedInteraction}, signature?: Hex]
- *  - Returns: {@link SendInteractionReturnType}
- *  - Response Type: promise (one-shot)
- *
  * #### frak_sso
  *  - Params: [params: {@link OpenSsoParamsType}, name: string, customCss?: string]
  *  - Returns: {@link OpenSsoReturnType}
  *  - Response Type: promise (one-shot)
  *
- * #### frak_getProductInformation
+ * #### frak_getMerchantInformation
  *  - Params: None
- *  - Returns: {@link GetProductInformationReturnType}
+ *  - Returns: {@link GetMerchantInformationReturnType}
  *  - Response Type: promise (one-shot)
  *
  * #### frak_displayEmbeddedWallet
@@ -850,15 +850,6 @@ type IFrameRpcSchema = [
   Parameters: [requests: ModalRpcStepsInput, metadata: ModalRpcMetadata | undefined, configMetadata: FrakWalletSdkConfig["metadata"]];
   ReturnType: ModalRpcStepsResultType;
 },
-/**
- * Method to transmit a user interaction
- * This is a one-shot request
- */
-{
-  Method: "frak_sendInteraction";
-  Parameters: [productId: Hex, interaction: PreparedInteraction, signature?: Hex];
-  ReturnType: SendInteractionReturnType;
-},
 /**
  * Method to prepare SSO (generate URL for popup)
  * Returns the SSO URL that should be opened in a popup
@@ -881,16 +872,16 @@ type IFrameRpcSchema = [
   ReturnType: OpenSsoReturnType;
 },
 /**
- * Method to get current product information's
- *  - Is product minted?
+ * 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_getProductInformation";
+  Method: "frak_getMerchantInformation";
   Parameters?: undefined;
-  ReturnType: GetProductInformationReturnType;
+  ReturnType: GetMerchantInformationReturnType;
 },
 /**
  * Method to show the embedded wallet, with potential customization
@@ -900,6 +891,19 @@ type IFrameRpcSchema = [
   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 is resolved from context
+ * clientId is passed via metadata as safeguard against handshake race condition
+ */
+{
+  Method: "frak_sendInteraction";
+  Parameters: [interaction: SendInteractionParamsType, metadata?: {
+    clientId?: string;
+  }];
+  ReturnType: undefined;
 }];
 //#endregion
 //#region src/types/transport.d.ts
@@ -1015,4 +1019,4 @@ declare const ssoPopupName = "frak-sso";
  */
 declare function openSso(client: FrakClient, args: OpenSsoParamsType): Promise<OpenSsoReturnType>;
 //#endregion
-export { SiweAuthenticateReturnType as A, FinalActionType as B, ModalRpcStepsInput as C, SendTransactionReturnType as D, SendTransactionModalStepType as E, OpenSsoParamsType as F, interactionTypes as G, ModalStepMetadata as H, OpenSsoReturnType as I, Currency as J, IFrameLifecycleEvent as K, PrepareSsoParamsType as L, OpenInteractionSessionModalStepType as M, OpenInteractionSessionReturnType as N, SendTransactionTxType as O, LoginModalStepType as P, LocalizedI18nConfig as Q, PrepareSsoReturnType as R, ModalRpcMetadata as S, ModalStepTypes as T, FullInteractionTypesKey as U, FinalModalStepType as V, InteractionTypesKey as W, I18nConfig as X, FrakWalletSdkConfig as Y, Language as Z, LoggedOutEmbeddedView as _, FrakClient as a, LoggedInEmbeddedView as b, IFrameRpcSchema as c, TokenAmountType as d, ProductTypesKey as f, DisplayEmbeddedWalletResultType as g, DisplayEmbeddedWalletParamsType as h, FrakContext as i, SiweAuthenticationParams as j, SiweAuthenticateModalStepType as k, WalletStatusReturnType as l, productTypesMask as m, ssoPopupFeatures as n, FrakLifecycleEvent as o, productTypes as p, ClientLifecycleEvent as q, ssoPopupName as r, IFrameTransport as s, openSso as t, GetProductInformationReturnType as u, EmbeddedViewActionReferred as v, ModalRpcStepsResultType as w, DisplayModalParamsType as x, EmbeddedViewActionSharing as y, SsoMetadata as z };
+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 };