@frak-labs/core-sdk 0.1.0-beta.b0bd1f8a → 0.1.0-beta.b77c23c7

package/src/utils/ssoUrlListener.test.ts

@@ -0,0 +1,252 @@
+import type { RpcClient } from "@frak-labs/frame-connector";
+import {
+    afterEach,
+    beforeEach,
+    describe,
+    expect,
+    it,
+    vi,
+} from "../../tests/vitest-fixtures";
+import type { FrakLifecycleEvent } from "../types";
+import type { IFrameRpcSchema } from "../types/rpc";
+import { setupSsoUrlListener } from "./ssoUrlListener";
+
+describe("setupSsoUrlListener", () => {
+    let mockRpcClient: RpcClient<IFrameRpcSchema, FrakLifecycleEvent>;
+    let mockWaitForConnection: Promise<boolean>;
+    let originalLocation: Location;
+    let originalHistory: History;
+    let consoleLogSpy: ReturnType<typeof vi.spyOn>;
+    let consoleErrorSpy: ReturnType<typeof vi.spyOn>;
+
+    beforeEach(() => {
+        // Save original values
+        originalLocation = window.location;
+        originalHistory = window.history;
+
+        // Mock RPC client
+        mockRpcClient = {
+            sendLifecycle: vi.fn(),
+        } as any;
+
+        // Mock console methods
+        consoleLogSpy = vi.spyOn(console, "log").mockImplementation(() => {});
+        consoleErrorSpy = vi
+            .spyOn(console, "error")
+            .mockImplementation(() => {});
+
+        // Mock history.replaceState
+        window.history.replaceState = vi.fn();
+    });
+
+    afterEach(() => {
+        vi.clearAllMocks();
+        consoleLogSpy.mockRestore();
+        consoleErrorSpy.mockRestore();
+
+        // Restore original values
+        Object.defineProperty(window, "location", {
+            value: originalLocation,
+            writable: true,
+        });
+        Object.defineProperty(window, "history", {
+            value: originalHistory,
+            writable: true,
+        });
+    });
+
+    it("should do nothing when window is undefined", () => {
+        const originalWindow = global.window;
+        // @ts-expect-error - intentionally removing window for test
+        delete global.window;
+
+        setupSsoUrlListener(mockRpcClient, Promise.resolve(true));
+
+        expect(mockRpcClient.sendLifecycle).not.toHaveBeenCalled();
+
+        // Restore window
+        global.window = originalWindow;
+    });
+
+    it("should do nothing when no SSO parameter in URL", () => {
+        Object.defineProperty(window, "location", {
+            value: {
+                href: "https://example.com/test",
+            },
+            writable: true,
+        });
+
+        setupSsoUrlListener(mockRpcClient, Promise.resolve(true));
+
+        expect(mockRpcClient.sendLifecycle).not.toHaveBeenCalled();
+        expect(window.history.replaceState).not.toHaveBeenCalled();
+    });
+
+    it("should forward SSO data to iframe when connection is ready", async () => {
+        const compressedSso = "compressed-sso-data";
+        Object.defineProperty(window, "location", {
+            value: {
+                href: `https://example.com/test?sso=${compressedSso}`,
+            },
+            writable: true,
+        });
+
+        mockWaitForConnection = Promise.resolve(true);
+
+        setupSsoUrlListener(mockRpcClient, mockWaitForConnection);
+
+        await mockWaitForConnection;
+
+        // Wait for promise to resolve
+        await new Promise((resolve) => setTimeout(resolve, 0));
+
+        expect(mockRpcClient.sendLifecycle).toHaveBeenCalledWith({
+            clientLifecycle: "sso-redirect-complete",
+            data: { compressed: compressedSso },
+        });
+
+        expect(consoleLogSpy).toHaveBeenCalledWith(
+            "[SSO URL Listener] Forwarded compressed SSO data to iframe"
+        );
+    });
+
+    it("should clean URL immediately after detecting SSO parameter", async () => {
+        const compressedSso = "compressed-sso-data";
+        const originalUrl = `https://example.com/test?sso=${compressedSso}`;
+        Object.defineProperty(window, "location", {
+            value: {
+                href: originalUrl,
+            },
+            writable: true,
+        });
+
+        mockWaitForConnection = Promise.resolve(true);
+
+        setupSsoUrlListener(mockRpcClient, mockWaitForConnection);
+
+        // URL should be cleaned immediately, before connection resolves
+        expect(window.history.replaceState).toHaveBeenCalledWith(
+            {},
+            "",
+            "https://example.com/test"
+        );
+
+        expect(consoleLogSpy).toHaveBeenCalledWith(
+            "[SSO URL Listener] SSO parameter detected and URL cleaned"
+        );
+    });
+
+    it("should handle connection promise rejection", async () => {
+        const compressedSso = "compressed-sso-data";
+        Object.defineProperty(window, "location", {
+            value: {
+                href: `https://example.com/test?sso=${compressedSso}`,
+            },
+            writable: true,
+        });
+
+        const connectionError = new Error("Connection failed");
+        mockWaitForConnection = Promise.reject(connectionError);
+
+        setupSsoUrlListener(mockRpcClient, mockWaitForConnection);
+
+        await mockWaitForConnection.catch(() => {});
+
+        // Wait for promise to reject
+        await new Promise((resolve) => setTimeout(resolve, 0));
+
+        expect(mockRpcClient.sendLifecycle).not.toHaveBeenCalled();
+        expect(consoleErrorSpy).toHaveBeenCalledWith(
+            "[SSO URL Listener] Failed to forward SSO data:",
+            connectionError
+        );
+    });
+
+    it("should handle URL with multiple parameters", async () => {
+        const compressedSso = "compressed-sso-data";
+        Object.defineProperty(window, "location", {
+            value: {
+                href: `https://example.com/test?param1=value1&sso=${compressedSso}&param2=value2`,
+            },
+            writable: true,
+        });
+
+        mockWaitForConnection = Promise.resolve(true);
+
+        setupSsoUrlListener(mockRpcClient, mockWaitForConnection);
+
+        await mockWaitForConnection;
+        await new Promise((resolve) => setTimeout(resolve, 0));
+
+        expect(mockRpcClient.sendLifecycle).toHaveBeenCalledWith({
+            clientLifecycle: "sso-redirect-complete",
+            data: { compressed: compressedSso },
+        });
+
+        // Should remove only the sso parameter
+        expect(window.history.replaceState).toHaveBeenCalledWith(
+            {},
+            "",
+            "https://example.com/test?param1=value1&param2=value2"
+        );
+    });
+
+    it("should not process empty SSO parameter", () => {
+        Object.defineProperty(window, "location", {
+            value: {
+                href: "https://example.com/test?sso=",
+            },
+            writable: true,
+        });
+
+        setupSsoUrlListener(mockRpcClient, Promise.resolve(true));
+
+        // Empty string is falsy, so it should not process
+        expect(window.history.replaceState).not.toHaveBeenCalled();
+        expect(mockRpcClient.sendLifecycle).not.toHaveBeenCalled();
+    });
+
+    it("should clean URL even if connection fails", async () => {
+        const compressedSso = "compressed-sso-data";
+        Object.defineProperty(window, "location", {
+            value: {
+                href: `https://example.com/test?sso=${compressedSso}`,
+            },
+            writable: true,
+        });
+
+        const connectionError = new Error("Connection failed");
+        mockWaitForConnection = Promise.reject(connectionError);
+
+        setupSsoUrlListener(mockRpcClient, mockWaitForConnection);
+
+        // URL should still be cleaned even if connection fails
+        expect(window.history.replaceState).toHaveBeenCalledWith(
+            {},
+            "",
+            "https://example.com/test"
+        );
+
+        await mockWaitForConnection.catch(() => {});
+        await new Promise((resolve) => setTimeout(resolve, 0));
+    });
+
+    it("should handle URL with hash", () => {
+        const compressedSso = "compressed-sso-data";
+        Object.defineProperty(window, "location", {
+            value: {
+                href: `https://example.com/test?sso=${compressedSso}#section`,
+            },
+            writable: true,
+        });
+
+        setupSsoUrlListener(mockRpcClient, Promise.resolve(true));
+
+        // Should preserve hash when cleaning URL
+        expect(window.history.replaceState).toHaveBeenCalledWith(
+            {},
+            "",
+            "https://example.com/test#section"
+        );
+    });
+});

package/src/utils/trackEvent.ts

@@ -4,7 +4,9 @@ export type FrakEvent =
     | "share_button_clicked"
     | "wallet_button_clicked"
     | "share_modal_error"
-    | "user_referred";
+    | "user_referred_started"
+    | "user_referred_completed"
+    | "user_referred_error";
 
 type EventProps = Record<string, unknown>;
 

package/dist/actions-CEEObPYc.js

@@ -1 +0,0 @@
-import{n as e,t,u as n}from"./trackEvent-CHnYa85W.js";import{r}from"./interactions-DnfM3oe0.js";import{isAddressEqual as i}from"viem";import{Deferred as a,FrakRpcError as o,RpcErrorCodes as s}from"@frak-labs/frame-connector";import{generateSiweNonce as c}from"viem/siwe";async function l(e,t){return await e.request({method:`frak_displayEmbeddedWallet`,params:[t,e.config.metadata]})}async function u(e,{steps:t,metadata:n}){return await e.request({method:`frak_displayModal`,params:[t,n,e.config.metadata]})}async function d(e){return await e.request({method:`frak_getProductInformation`})}async function f(e,t){let{metadata:n,customizations:r}=e.config;return await e.request({method:`frak_prepareSso`,params:[t,n.name,r?.css]})}async function p(n,{walletStatus:i,frakContext:a,modalConfig:o,productId:s,options:c}){let l=!1;async function u(){if(!l)return l=!0,h(n,{modalConfig:{...o,loggedIn:{action:{key:`referred`}}},walletStatus:i})}async function d(e){let i=r.referred({referrer:e});await Promise.allSettled([v(n,{productId:s,interaction:i}),t(n,`user_referred`,{properties:{referrer:e}})])}try{let{status:t,currentWallet:n}=await m({initialWalletStatus:i,getFreshWalletStatus:u,pushReferralInteraction:d,frakContext:a});return e.replaceUrl({url:window.location?.href,context:c?.alwaysAppendUrl?{r:n}:null}),t}catch(t){return console.log(`Error processing referral`,{error:t}),e.replaceUrl({url:window.location?.href,context:c?.alwaysAppendUrl?{r:i?.wallet}:null}),g(t)}}async function m({initialWalletStatus:e,getFreshWalletStatus:t,pushReferralInteraction:n,frakContext:r}){let a=e?.wallet;return r?.r?(a||=await t(),a&&i(r.r,a)?{status:`self-referral`,currentWallet:a}:(e?.interactionSession||(a=await t()),await n(r.r),{status:`success`,currentWallet:a})):{status:`no-referrer`,currentWallet:a}}async function h(e,{modalConfig:t,walletStatus:n}){return n?.interactionSession?n.wallet??void 0:(await l(e,t??{}))?.wallet??void 0}function g(e){if(e instanceof o)switch(e.code){case s.walletNotConnected:return`no-wallet`;case s.serverErrorForInteractionDelegation:return`no-session`;default:return`error`}return`error`}async function _(t,{productId:n,modalConfig:r,options:i}={}){let a=e.parse({url:window.location.href}),o=await b(t);try{return await p(t,{walletStatus:o,frakContext:a,modalConfig:r,productId:n,options:i})}catch(e){console.warn(`Error processing referral`,{error:e})}}async function v(e,{productId:t,interaction:r,validation:i}){let a=t??n(e.config);return await e.request({method:`frak_sendInteraction`,params:[a,r,i]})}async function y(e){if(typeof window>`u`){console.warn(`[Frak] No window found, can't track purchase`);return}let t=window.sessionStorage.getItem(`frak-wallet-interaction-token`);if(!t){console.warn(`[Frak] No frak session found, skipping purchase check`);return}await fetch(`https://backend.frak.id/interactions/listenForPurchase`,{method:`POST`,headers:{Accept:`application/json`,"Content-Type":`application/json`,"x-wallet-sdk-auth":t},body:JSON.stringify(e)})}function b(e,t){if(!t)return e.request({method:`frak_listenToWalletStatus`}).then(t=>(x(e,t),t));let n=new a,r=!1;return e.listenerRequest({method:`frak_listenToWalletStatus`},i=>{x(e,i),t(i),r||=(n.resolve(i),!0)}),n.promise}function x(e,t){typeof window>`u`||(e.openPanel?.setGlobalProperties({wallet:t.wallet??null}),t.interactionToken?window.sessionStorage.setItem(`frak-wallet-interaction-token`,t.interactionToken):window.sessionStorage.removeItem(`frak-wallet-interaction-token`))}function S(e,{metadata:t,login:n,openSession:r}){return C(e,{steps:{login:n??{},openSession:r??{}},metadata:t})}function C(e,t){function n(n){return C(e,{...t,steps:{...t.steps,sendTransaction:n}})}function r(n){return C(e,{...t,steps:{...t.steps,final:{...n,action:{key:`reward`}}}})}function i(n,r){return C(e,{...t,steps:{...t.steps,final:{...r,action:{key:`sharing`,options:n}}}})}async function a(n){return n&&(t.metadata=n(t.metadata??{})),await u(e,t)}return{params:t,sendTx:n,reward:r,sharing:i,display:a}}async function w(e,{tx:t,metadata:n}){return(await u(e,{metadata:n,steps:{login:{},sendTransaction:{tx:t}}})).sendTransaction}async function T(e,{siwe:t,metadata:n}){let r=e.config?.domain??window.location.host,i=t?.statement??`I confirm that I want to use my Frak wallet on: ${e.config.metadata.name}`;return(await u(e,{metadata:n,steps:{login:{},siweAuthenticate:{siwe:{...t,statement:i,nonce:t?.nonce??c(),uri:t?.uri??`https://${r}`,version:t?.version??`1`,domain:r}}}})).siweAuthenticate}export{y as a,p as c,u as d,l as f,b as i,f as l,w as n,v as o,S as r,_ as s,T as t,d as u};

package/dist/actions-DbQhWYx8.cjs

@@ -1 +0,0 @@
-const e=require(`./trackEvent-GuQm_1Nm.cjs`),t=require(`./interactions-EIXhNLf6.cjs`);let n=require(`viem`),r=require(`@frak-labs/frame-connector`),i=require(`viem/siwe`);async function a(e,t){return await e.request({method:`frak_displayEmbeddedWallet`,params:[t,e.config.metadata]})}async function o(e,{steps:t,metadata:n}){return await e.request({method:`frak_displayModal`,params:[t,n,e.config.metadata]})}async function s(e){return await e.request({method:`frak_getProductInformation`})}async function c(e,t){let{metadata:n,customizations:r}=e.config;return await e.request({method:`frak_prepareSso`,params:[t,n.name,r?.css]})}async function l(n,{walletStatus:r,frakContext:i,modalConfig:a,productId:o,options:s}){let c=!1;async function l(){if(!c)return c=!0,d(n,{modalConfig:{...a,loggedIn:{action:{key:`referred`}}},walletStatus:r})}async function p(r){let i=t.r.referred({referrer:r});await Promise.allSettled([m(n,{productId:o,interaction:i}),e.t(n,`user_referred`,{properties:{referrer:r}})])}try{let{status:t,currentWallet:n}=await u({initialWalletStatus:r,getFreshWalletStatus:l,pushReferralInteraction:p,frakContext:i});return e.n.replaceUrl({url:window.location?.href,context:s?.alwaysAppendUrl?{r:n}:null}),t}catch(t){return console.log(`Error processing referral`,{error:t}),e.n.replaceUrl({url:window.location?.href,context:s?.alwaysAppendUrl?{r:r?.wallet}:null}),f(t)}}async function u({initialWalletStatus:e,getFreshWalletStatus:t,pushReferralInteraction:r,frakContext:i}){let a=e?.wallet;return i?.r?(a||=await t(),a&&(0,n.isAddressEqual)(i.r,a)?{status:`self-referral`,currentWallet:a}:(e?.interactionSession||(a=await t()),await r(i.r),{status:`success`,currentWallet:a})):{status:`no-referrer`,currentWallet:a}}async function d(e,{modalConfig:t,walletStatus:n}){return n?.interactionSession?n.wallet??void 0:(await a(e,t??{}))?.wallet??void 0}function f(e){if(e instanceof r.FrakRpcError)switch(e.code){case r.RpcErrorCodes.walletNotConnected:return`no-wallet`;case r.RpcErrorCodes.serverErrorForInteractionDelegation:return`no-session`;default:return`error`}return`error`}async function p(t,{productId:n,modalConfig:r,options:i}={}){let a=e.n.parse({url:window.location.href}),o=await g(t);try{return await l(t,{walletStatus:o,frakContext:a,modalConfig:r,productId:n,options:i})}catch(e){console.warn(`Error processing referral`,{error:e})}}async function m(t,{productId:n,interaction:r,validation:i}){let a=n??e.u(t.config);return await t.request({method:`frak_sendInteraction`,params:[a,r,i]})}async function h(e){if(typeof window>`u`){console.warn(`[Frak] No window found, can't track purchase`);return}let t=window.sessionStorage.getItem(`frak-wallet-interaction-token`);if(!t){console.warn(`[Frak] No frak session found, skipping purchase check`);return}await fetch(`https://backend.frak.id/interactions/listenForPurchase`,{method:`POST`,headers:{Accept:`application/json`,"Content-Type":`application/json`,"x-wallet-sdk-auth":t},body:JSON.stringify(e)})}function g(e,t){if(!t)return e.request({method:`frak_listenToWalletStatus`}).then(t=>(_(e,t),t));let n=new r.Deferred,i=!1;return e.listenerRequest({method:`frak_listenToWalletStatus`},r=>{_(e,r),t(r),i||=(n.resolve(r),!0)}),n.promise}function _(e,t){typeof window>`u`||(e.openPanel?.setGlobalProperties({wallet:t.wallet??null}),t.interactionToken?window.sessionStorage.setItem(`frak-wallet-interaction-token`,t.interactionToken):window.sessionStorage.removeItem(`frak-wallet-interaction-token`))}function v(e,{metadata:t,login:n,openSession:r}){return y(e,{steps:{login:n??{},openSession:r??{}},metadata:t})}function y(e,t){function n(n){return y(e,{...t,steps:{...t.steps,sendTransaction:n}})}function r(n){return y(e,{...t,steps:{...t.steps,final:{...n,action:{key:`reward`}}}})}function i(n,r){return y(e,{...t,steps:{...t.steps,final:{...r,action:{key:`sharing`,options:n}}}})}async function a(n){return n&&(t.metadata=n(t.metadata??{})),await o(e,t)}return{params:t,sendTx:n,reward:r,sharing:i,display:a}}async function b(e,{tx:t,metadata:n}){return(await o(e,{metadata:n,steps:{login:{},sendTransaction:{tx:t}}})).sendTransaction}async function x(e,{siwe:t,metadata:n}){let r=e.config?.domain??window.location.host,a=t?.statement??`I confirm that I want to use my Frak wallet on: ${e.config.metadata.name}`;return(await o(e,{metadata:n,steps:{login:{},siweAuthenticate:{siwe:{...t,statement:a,nonce:t?.nonce??(0,i.generateSiweNonce)(),uri:t?.uri??`https://${r}`,version:t?.version??`1`,domain:r}}}})).siweAuthenticate}Object.defineProperty(exports,`a`,{enumerable:!0,get:function(){return h}}),Object.defineProperty(exports,`c`,{enumerable:!0,get:function(){return l}}),Object.defineProperty(exports,`d`,{enumerable:!0,get:function(){return o}}),Object.defineProperty(exports,`f`,{enumerable:!0,get:function(){return a}}),Object.defineProperty(exports,`i`,{enumerable:!0,get:function(){return g}}),Object.defineProperty(exports,`l`,{enumerable:!0,get:function(){return c}}),Object.defineProperty(exports,`n`,{enumerable:!0,get:function(){return b}}),Object.defineProperty(exports,`o`,{enumerable:!0,get:function(){return m}}),Object.defineProperty(exports,`r`,{enumerable:!0,get:function(){return v}}),Object.defineProperty(exports,`s`,{enumerable:!0,get:function(){return p}}),Object.defineProperty(exports,`t`,{enumerable:!0,get:function(){return x}}),Object.defineProperty(exports,`u`,{enumerable:!0,get:function(){return s}});