@frak-labs/core-sdk 0.2.1-beta.b38eef2e → 0.2.1-beta.d04602ec

package/src/types/rpc.ts

@@ -4,6 +4,10 @@ import type {
     ModalRpcStepsInput,
     ModalRpcStepsResultType,
 } from "./rpc/displayModal";
+import type {
+    DisplaySharingPageParamsType,
+    DisplaySharingPageResultType,
+} from "./rpc/displaySharingPage";
 import type {
     DisplayEmbeddedWalletParamsType,
     DisplayEmbeddedWalletResultType,
@@ -16,6 +20,7 @@ import type {
     PrepareSsoParamsType,
     PrepareSsoReturnType,
 } from "./rpc/sso";
+import type { UserReferralStatusType } from "./rpc/userReferralStatus";
 import type { WalletStatusReturnType } from "./rpc/walletStatus";
 
 /**
@@ -38,7 +43,7 @@ import type { WalletStatusReturnType } from "./rpc/walletStatus";
  *  - Response Type: stream (emits updates when wallet status changes)
  *
  * #### frak_displayModal
- * - Params: [requests: {@link ModalRpcStepsInput}, metadata?: {@link ModalRpcMetadata}, configMetadata: {@link FrakWalletSdkConfig}["metadata"]]
+ * - Params: [requests: {@link ModalRpcStepsInput}, metadata?: {@link ModalRpcMetadata}, configMetadata: {@link FrakWalletSdkConfig}["metadata"], placement?: string]
  * - Returns: {@link ModalRpcStepsResultType}
  * - Response Type: promise (one-shot)
  *
@@ -53,9 +58,14 @@ import type { WalletStatusReturnType } from "./rpc/walletStatus";
  *  - Response Type: promise (one-shot)
  *
  * #### frak_displayEmbeddedWallet
- * - Params: [request: {@link DisplayEmbeddedWalletParamsType}, metadata: {@link FrakWalletSdkConfig}["metadata"]]
+ * - Params: [request: {@link DisplayEmbeddedWalletParamsType}, metadata: {@link FrakWalletSdkConfig}["metadata"], placement?: string]
  * - Returns: {@link DisplayEmbeddedWalletResultType}
  * - Response Type: promise (one-shot)
+ *
+ * #### frak_displaySharingPage
+ * - Params: [request: {@link DisplaySharingPageParamsType}, configMetadata: {@link FrakWalletSdkConfig}["metadata"], placement?: string]
+ * - Returns: {@link DisplaySharingPageResultType}
+ * - Response Type: promise (one-shot)
  */
 export type IFrameRpcSchema = [
     /**
@@ -77,6 +87,7 @@ export type IFrameRpcSchema = [
             requests: ModalRpcStepsInput,
             metadata: ModalRpcMetadata | undefined,
             configMetadata: FrakWalletSdkConfig["metadata"],
+            placement?: string,
         ];
         ReturnType: ModalRpcStepsResultType;
     },
@@ -89,7 +100,7 @@ export type IFrameRpcSchema = [
         Method: "frak_prepareSso";
         Parameters: [
             params: PrepareSsoParamsType,
-            name: string,
+            name?: string,
             customCss?: string,
         ];
         ReturnType: PrepareSsoReturnType;
@@ -104,7 +115,7 @@ export type IFrameRpcSchema = [
         Method: "frak_openSso";
         Parameters: [
             params: OpenSsoParamsType,
-            name: string,
+            name?: string,
             customCss?: string,
         ];
         ReturnType: OpenSsoReturnType;
@@ -130,6 +141,7 @@ export type IFrameRpcSchema = [
         Parameters: [
             request: DisplayEmbeddedWalletParamsType,
             metadata: FrakWalletSdkConfig["metadata"],
+            placement?: string,
         ];
         ReturnType: DisplayEmbeddedWalletResultType;
     },
@@ -137,7 +149,7 @@ export type IFrameRpcSchema = [
      * 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
+     * clientId is passed via metadata as safeguard against race conditions
      */
     {
         Method: "frak_sendInteraction";
@@ -147,4 +159,29 @@ export type IFrameRpcSchema = [
         ];
         ReturnType: undefined;
     },
+    /**
+     * Method to get the current user's referral status on this merchant.
+     * Returns whether the user was referred (has a referral link as referee).
+     * Returns null when the user's identity cannot be resolved.
+     * This is a one-shot request.
+     */
+    {
+        Method: "frak_getUserReferralStatus";
+        Parameters?: undefined;
+        ReturnType: UserReferralStatusType | null;
+    },
+    /**
+     * Method to display a sharing page with product info and sharing buttons
+     * Resolves on first user action (share/copy) but the page stays visible
+     * This is a one-shot request
+     */
+    {
+        Method: "frak_displaySharingPage";
+        Parameters: [
+            request: DisplaySharingPageParamsType,
+            configMetadata: FrakWalletSdkConfig["metadata"],
+            placement?: string,
+        ];
+        ReturnType: DisplaySharingPageResultType;
+    },
 ];

package/src/utils/backendUrl.test.ts

@@ -15,13 +15,13 @@ describe("getBackendUrl", () => {
     describe("with explicit walletUrl", () => {
         test("should return localhost backend for localhost:3000", () => {
             expect(getBackendUrl("https://localhost:3000")).toBe(
-                "http://localhost:3030"
+                "https://localhost:3030"
             );
         });
 
         test("should return localhost backend for localhost:3010", () => {
             expect(getBackendUrl("https://localhost:3010")).toBe(
-                "http://localhost:3030"
+                "https://localhost:3030"
             );
         });
 

package/src/utils/backendUrl.ts

@@ -19,7 +19,7 @@ function isLocalDevelopment(walletUrl: string): boolean {
  */
 function deriveBackendUrl(walletUrl: string): string {
     if (isLocalDevelopment(walletUrl)) {
-        return "http://localhost:3030";
+        return "https://localhost:3030";
     }
     // Dev environment
     if (

package/src/utils/cache/index.ts

@@ -0,0 +1,7 @@
+export { LruMap } from "./lruMap";
+export {
+    clearAllCache,
+    DEFAULT_CACHE_TIME,
+    getCache,
+    withCache,
+} from "./withCache";

package/src/utils/cache/lruMap.test.ts

@@ -0,0 +1,55 @@
+import { describe, expect, it } from "../../../tests/vitest-fixtures";
+import { LruMap } from "./lruMap";
+
+describe("LruMap", () => {
+    it("should store and retrieve values", () => {
+        const map = new LruMap<number>(3);
+        map.set("a", 1);
+        map.set("b", 2);
+
+        expect(map.get("a")).toBe(1);
+        expect(map.get("b")).toBe(2);
+    });
+
+    it("should evict least recently used when exceeding max size", () => {
+        const map = new LruMap<number>(2);
+        map.set("a", 1);
+        map.set("b", 2);
+        map.set("c", 3); // Should evict "a"
+
+        expect(map.get("a")).toBeUndefined();
+        expect(map.get("b")).toBe(2);
+        expect(map.get("c")).toBe(3);
+    });
+
+    it("should promote accessed keys to most recently used", () => {
+        const map = new LruMap<number>(2);
+        map.set("a", 1);
+        map.set("b", 2);
+
+        // Access "a" to promote it
+        map.get("a");
+
+        // "b" is now least recently used, should be evicted
+        map.set("c", 3);
+
+        expect(map.get("a")).toBe(1);
+        expect(map.get("b")).toBeUndefined();
+        expect(map.get("c")).toBe(3);
+    });
+
+    it("should overwrite existing keys without increasing size", () => {
+        const map = new LruMap<number>(2);
+        map.set("a", 1);
+        map.set("b", 2);
+        map.set("a", 10); // Overwrite, not a new entry
+
+        expect(map.size).toBe(2);
+        expect(map.get("a")).toBe(10);
+    });
+
+    it("should return undefined for missing keys", () => {
+        const map = new LruMap<number>(2);
+        expect(map.get("missing")).toBeUndefined();
+    });
+});

package/src/utils/cache/lruMap.ts

@@ -0,0 +1,38 @@
+/**
+ * Map with a LRU (Least Recently Used) eviction policy.
+ *
+ * When the map exceeds `maxSize`, the least recently accessed entry is removed.
+ * Accessing a key via `get()` promotes it to "most recently used".
+ *
+ * Adapted from viem's LruMap utility.
+ * @link https://en.wikipedia.org/wiki/Cache_replacement_policies#LRU
+ */
+export class LruMap<TValue = unknown> extends Map<string, TValue> {
+    maxSize: number;
+
+    constructor(size: number) {
+        super();
+        this.maxSize = size;
+    }
+
+    override get(key: string) {
+        const value = super.get(key);
+        if (super.has(key)) {
+            // Move to end (most recently used)
+            super.delete(key);
+            super.set(key, value as TValue);
+        }
+        return value;
+    }
+
+    override set(key: string, value: TValue) {
+        if (super.has(key)) super.delete(key);
+        super.set(key, value);
+        // Evict least recently used if over capacity
+        if (this.maxSize && this.size > this.maxSize) {
+            const firstKey = super.keys().next().value;
+            if (firstKey !== undefined) super.delete(firstKey);
+        }
+        return this;
+    }
+}

package/src/utils/cache/withCache.test.ts

@@ -0,0 +1,162 @@
+import {
+    afterEach,
+    beforeEach,
+    describe,
+    expect,
+    it,
+    vi,
+} from "../../../tests/vitest-fixtures";
+import { clearAllCache, withCache } from "./withCache";
+
+describe("withCache", () => {
+    beforeEach(() => {
+        clearAllCache();
+    });
+
+    afterEach(() => {
+        vi.restoreAllMocks();
+    });
+
+    describe("caching behavior", () => {
+        it("should call fn on first invocation", async () => {
+            const fn = vi.fn().mockResolvedValue("result");
+
+            const result = await withCache(fn, {
+                cacheKey: "test-key",
+            });
+
+            expect(fn).toHaveBeenCalledOnce();
+            expect(result).toBe("result");
+        });
+
+        it("should return cached result on subsequent calls within TTL", async () => {
+            const fn = vi.fn().mockResolvedValue("result");
+
+            await withCache(fn, {
+                cacheKey: "test-key",
+                cacheTime: 10_000,
+            });
+            const result = await withCache(fn, {
+                cacheKey: "test-key",
+                cacheTime: 10_000,
+            });
+
+            expect(fn).toHaveBeenCalledOnce();
+            expect(result).toBe("result");
+        });
+
+        it("should re-fetch after cache expires", async () => {
+            vi.useFakeTimers();
+
+            const fn = vi
+                .fn()
+                .mockResolvedValueOnce("first")
+                .mockResolvedValueOnce("second");
+
+            const first = await withCache(fn, {
+                cacheKey: "test-key",
+                cacheTime: 100,
+            });
+            expect(first).toBe("first");
+
+            // Advance past TTL
+            vi.advanceTimersByTime(200);
+
+            const second = await withCache(fn, {
+                cacheKey: "test-key",
+                cacheTime: 100,
+            });
+            expect(second).toBe("second");
+            expect(fn).toHaveBeenCalledTimes(2);
+
+            vi.useRealTimers();
+        });
+
+        it("should not cache when cacheTime is 0", async () => {
+            const fn = vi.fn().mockResolvedValue("result");
+
+            await withCache(fn, { cacheKey: "test-key", cacheTime: 0 });
+            await withCache(fn, { cacheKey: "test-key", cacheTime: 0 });
+
+            expect(fn).toHaveBeenCalledTimes(2);
+        });
+
+        it("should use different caches for different keys", async () => {
+            const fnA = vi.fn().mockResolvedValue("a");
+            const fnB = vi.fn().mockResolvedValue("b");
+
+            const a = await withCache(fnA, { cacheKey: "key-a" });
+            const b = await withCache(fnB, { cacheKey: "key-b" });
+
+            expect(a).toBe("a");
+            expect(b).toBe("b");
+            expect(fnA).toHaveBeenCalledOnce();
+            expect(fnB).toHaveBeenCalledOnce();
+        });
+    });
+
+    describe("deduplication", () => {
+        it("should deduplicate concurrent calls with the same key", async () => {
+            let resolvePromise: (value: string) => void;
+            const fn = vi.fn().mockImplementation(
+                () =>
+                    new Promise<string>((resolve) => {
+                        resolvePromise = resolve;
+                    })
+            );
+
+            const promise1 = withCache(fn, { cacheKey: "dedup-key" });
+            const promise2 = withCache(fn, { cacheKey: "dedup-key" });
+
+            // fn should only be called once
+            expect(fn).toHaveBeenCalledOnce();
+
+            // Both should resolve to the same value
+            resolvePromise!("shared");
+            const [result1, result2] = await Promise.all([promise1, promise2]);
+            expect(result1).toBe("shared");
+            expect(result2).toBe("shared");
+        });
+    });
+
+    describe("error handling", () => {
+        it("should propagate errors from fn", async () => {
+            const fn = vi.fn().mockRejectedValue(new Error("fetch failed"));
+
+            await expect(
+                withCache(fn, { cacheKey: "error-key" })
+            ).rejects.toThrow("fetch failed");
+        });
+
+        it("should not cache errors — subsequent call retries", async () => {
+            const fn = vi
+                .fn()
+                .mockRejectedValueOnce(new Error("fail"))
+                .mockResolvedValueOnce("recovered");
+
+            await expect(
+                withCache(fn, { cacheKey: "retry-key" })
+            ).rejects.toThrow("fail");
+
+            const result = await withCache(fn, { cacheKey: "retry-key" });
+            expect(result).toBe("recovered");
+            expect(fn).toHaveBeenCalledTimes(2);
+        });
+    });
+
+    describe("clearAllCache", () => {
+        it("should clear all cached data", async () => {
+            const fn = vi
+                .fn()
+                .mockResolvedValueOnce("first")
+                .mockResolvedValueOnce("second");
+
+            await withCache(fn, { cacheKey: "clear-key" });
+            clearAllCache();
+            const result = await withCache(fn, { cacheKey: "clear-key" });
+
+            expect(result).toBe("second");
+            expect(fn).toHaveBeenCalledTimes(2);
+        });
+    });
+});

package/src/utils/cache/withCache.ts

@@ -0,0 +1,105 @@
+import { LruMap } from "./lruMap";
+
+type CacheEntry<TData> = {
+    data: TData;
+    created: number;
+};
+
+/** Global cache for in-flight promises (dedup concurrent calls) */
+const promiseCache = new LruMap<Promise<unknown>>(1024);
+
+/** Global cache for resolved responses (TTL-based) */
+const responseCache = new LruMap<CacheEntry<unknown>>(1024);
+
+/** Default cache time: 30 seconds */
+export const DEFAULT_CACHE_TIME = 30_000;
+
+type WithCacheOptions = {
+    /** The key to cache the data against */
+    cacheKey: string;
+    /** Time in ms that cached data will remain valid. Default: 30_000 (30s). Set to 0 to disable caching. */
+    cacheTime?: number;
+};
+
+/**
+ * Returns the result of a given promise, and caches the result for
+ * subsequent invocations against a provided cache key.
+ *
+ * Also deduplicates concurrent calls — if multiple callers request the same
+ * cache key while the promise is pending, they share the same promise.
+ *
+ * @example
+ * ```ts
+ * // First call fetches, subsequent calls return cached data for 30s
+ * const data = await withCache(
+ *     () => client.request({ method: "frak_getMerchantInformation" }),
+ *     { cacheKey: "merchantInfo", cacheTime: 30_000 }
+ * );
+ * ```
+ */
+export async function withCache<TData>(
+    fn: () => Promise<TData>,
+    { cacheKey, cacheTime = DEFAULT_CACHE_TIME }: WithCacheOptions
+): Promise<TData> {
+    // Check response cache — return immediately if fresh
+    if (cacheTime > 0) {
+        const cached = responseCache.get(cacheKey) as
+            | CacheEntry<TData>
+            | undefined;
+        if (cached) {
+            const age = Date.now() - cached.created;
+            if (age < cacheTime) return cached.data;
+        }
+    }
+
+    // Check if there's already a pending promise (dedup concurrent calls)
+    let promise = promiseCache.get(cacheKey) as Promise<TData> | undefined;
+    if (!promise) {
+        promise = fn();
+        promiseCache.set(cacheKey, promise);
+    }
+
+    try {
+        const data = await promise;
+        // Store the response with a timestamp
+        responseCache.set(cacheKey, { data, created: Date.now() });
+        return data;
+    } finally {
+        // Clear the promise cache so subsequent calls can re-fetch after TTL
+        promiseCache.delete(cacheKey);
+    }
+}
+
+/**
+ * Get a cache handle for a specific key, useful for manual invalidation.
+ *
+ * @example
+ * ```ts
+ * // Invalidate merchant info cache after a mutation
+ * getCache("frak_getMerchantInformation").clear();
+ * ```
+ */
+export function getCache(cacheKey: string) {
+    return {
+        /** Clear both the pending promise and the cached response */
+        clear: () => {
+            promiseCache.delete(cacheKey);
+            responseCache.delete(cacheKey);
+        },
+        /** Check if a non-expired response exists */
+        has: (cacheTime: number = DEFAULT_CACHE_TIME) => {
+            const cached = responseCache.get(cacheKey);
+            if (!cached) return false;
+            return Date.now() - cached.created < cacheTime;
+        },
+    };
+}
+
+/**
+ * Clear all cached data (both pending promises and resolved responses).
+ * Called automatically when the client is destroyed.
+ */
+export function clearAllCache() {
+    promiseCache.clear();
+    responseCache.clear();
+}

package/src/utils/inAppBrowser.ts

@@ -0,0 +1,60 @@
+/**
+ * Check if the current device runs iOS (including iPadOS 13+).
+ */
+function checkIsIOS(): boolean {
+    if (typeof navigator === "undefined") return false;
+    const ua = navigator.userAgent;
+    // Standard iOS devices
+    if (/iPhone|iPad|iPod/i.test(ua)) return true;
+    // iPadOS 13+ reports as Macintosh — detect via touch support
+    if (/Macintosh/i.test(ua) && navigator.maxTouchPoints > 1) return true;
+    return false;
+}
+
+/**
+ * Whether the current device runs iOS (including iPadOS 13+).
+ */
+export const isIOS: boolean = checkIsIOS();
+
+/**
+ * Check if the current browser is a social media in-app browser
+ * (Instagram, Facebook WebView).
+ */
+function checkInAppBrowser(): boolean {
+    if (typeof navigator === "undefined") return false;
+    const ua = navigator.userAgent.toLowerCase();
+    return (
+        ua.includes("instagram") ||
+        ua.includes("fban") ||
+        ua.includes("fbav") ||
+        ua.includes("facebook")
+    );
+}
+
+/**
+ * Whether the current browser is a social media in-app browser
+ * (Instagram, Facebook).
+ */
+export const isInAppBrowser: boolean = checkInAppBrowser();
+
+/**
+ * Redirect to external browser from in-app WebView.
+ *
+ * - **iOS**: Uses `x-safari-https://` scheme — server-side 302 redirects
+ *   to custom URL schemes are silently swallowed by WKWebView.
+ *   Direct `window.location.href` assignment works (confirmed iOS 17+).
+ *
+ * - **Android**: Uses backend `/common/social` endpoint which returns a PDF
+ *   Content-Type response, forcing the WebView to hand off to the default browser.
+ *
+ * @param targetUrl - The URL to open in the external browser
+ */
+export function redirectToExternalBrowser(targetUrl: string): void {
+    if (isIOS && targetUrl.startsWith("https://")) {
+        window.location.href = `x-safari-https://${targetUrl.slice(8)}`;
+    } else if (isIOS && targetUrl.startsWith("http://")) {
+        window.location.href = `x-safari-http://${targetUrl.slice(7)}`;
+    } else {
+        window.location.href = `${process.env.BACKEND_URL}/common/social?u=${encodeURIComponent(targetUrl)}`;
+    }
+}

package/src/utils/index.ts

@@ -1,5 +1,6 @@
 export { Deferred } from "@frak-labs/frame-connector";
 export { getBackendUrl } from "./backendUrl";
+export { clearAllCache, getCache, withCache } from "./cache";
 export { getClientId } from "./clientId";
 export { base64urlDecode, base64urlEncode } from "./compression/b64";
 export { compressJsonToB64 } from "./compression/compress";
@@ -23,10 +24,11 @@ export {
     findIframeInOpener,
 } from "./iframeHelper";
 export {
-    clearMerchantIdCache,
-    fetchMerchantId,
-    resolveMerchantId,
-} from "./merchantId";
+    isInAppBrowser,
+    isIOS,
+    redirectToExternalBrowser,
+} from "./inAppBrowser";
+export { sdkConfigStore } from "./sdkConfigStore";
 export {
     type AppSpecificSsoMetadata,
     type CompressedSsoData,