@frak-labs/core-sdk 0.1.0-beta.afa252b0 → 0.1.0-beta.dd44738a

package/src/clients/createIFrameFrakClient.ts

@@ -0,0 +1,287 @@
+import {
+    FrakRpcError,
+    type RpcClient,
+    RpcErrorCodes,
+    createRpcClient,
+} from "@frak-labs/frame-connector";
+import { createClientCompressionMiddleware } from "@frak-labs/frame-connector/middleware";
+import { OpenPanel } from "@openpanel/web";
+import type { FrakLifecycleEvent } from "../types";
+import type { FrakClient } from "../types/client";
+import type { FrakWalletSdkConfig } from "../types/config";
+import type { IFrameRpcSchema } from "../types/rpc";
+import { BACKUP_KEY } from "../utils/constants";
+import { setupSsoUrlListener } from "../utils/ssoUrlListener";
+import { DebugInfoGatherer } from "./DebugInfo";
+import {
+    type IframeLifecycleManager,
+    createIFrameLifecycleManager,
+} from "./transports/iframeLifecycleManager";
+
+type SdkRpcClient = RpcClient<IFrameRpcSchema, FrakLifecycleEvent>;
+
+/**
+ * Create a new iframe Frak client
+ * @param args
+ * @param args.config - The configuration to use for the Frak Wallet SDK
+ * @param args.iframe - The iframe to use for the communication
+ * @returns The created Frak Client
+ *
+ * @example
+ * const frakConfig: FrakWalletSdkConfig = {
+ *     metadata: {
+ *         name: "My app title",
+ *     },
+ * }
+ * const iframe = await createIframe({ config: frakConfig });
+ * const client = createIFrameFrakClient({ config: frakConfig, iframe });
+ */
+export function createIFrameFrakClient({
+    config,
+    iframe,
+}: {
+    config: FrakWalletSdkConfig;
+    iframe: HTMLIFrameElement;
+}): FrakClient {
+    const frakWalletUrl = config?.walletUrl ?? "https://wallet.frak.id";
+
+    // Create lifecycle manager
+    const lifecycleManager = createIFrameLifecycleManager({ iframe });
+
+    // Create our debug info gatherer
+    const debugInfo = new DebugInfoGatherer(config, iframe);
+
+    // Validate iframe
+    if (!iframe.contentWindow) {
+        throw new FrakRpcError(
+            RpcErrorCodes.configError,
+            "The iframe does not have a content window"
+        );
+    }
+
+    // Create RPC client with middleware and lifecycle handlers
+    const rpcClient = createRpcClient<IFrameRpcSchema, FrakLifecycleEvent>({
+        emittingTransport: iframe.contentWindow,
+        listeningTransport: window,
+        targetOrigin: frakWalletUrl,
+        // Add compression middleware to handle request/response compression
+        middleware: [
+            // Ensure we are connected before sending request
+            {
+                async onRequest(_message, ctx) {
+                    // Ensure the iframe is connected
+                    const isConnected = await lifecycleManager.isConnected;
+                    if (!isConnected) {
+                        throw new FrakRpcError(
+                            RpcErrorCodes.clientNotConnected,
+                            "The iframe provider isn't connected yet"
+                        );
+                    }
+                    return ctx;
+                },
+            },
+            createClientCompressionMiddleware(),
+            // Save debug info
+            {
+                onRequest(message, ctx) {
+                    debugInfo.setLastRequest(message);
+                    return ctx;
+                },
+                onResponse(message, response) {
+                    debugInfo.setLastResponse(message, response);
+                    return response;
+                },
+            },
+        ],
+        // Add lifecycle handlers to process iframe lifecycle events
+        lifecycleHandlers: {
+            iframeLifecycle: async (event, _context) => {
+                // Delegate to lifecycle manager  (cast for type compatibility)
+                await lifecycleManager.handleEvent(event);
+            },
+        },
+    });
+
+    // Setup heartbeat
+    const stopHeartbeat = setupHeartbeat(rpcClient, lifecycleManager);
+
+    // Build our destroy function
+    const destroy = async () => {
+        // Stop heartbeat
+        stopHeartbeat();
+        // Cleanup the RPC client
+        rpcClient.cleanup();
+        // Remove the iframe
+        iframe.remove();
+    };
+
+    // Init open panel
+    let openPanel: OpenPanel | undefined;
+    if (
+        process.env.OPEN_PANEL_API_URL &&
+        process.env.OPEN_PANEL_SDK_CLIENT_ID
+    ) {
+        console.log("[Frak SDK] Initializing OpenPanel");
+        openPanel = new OpenPanel({
+            apiUrl: process.env.OPEN_PANEL_API_URL,
+            clientId: process.env.OPEN_PANEL_SDK_CLIENT_ID,
+            trackScreenViews: true,
+            trackOutgoingLinks: true,
+            trackAttributes: false,
+            // We use a filter to ensure we got the open panel instance initialized
+            //  A bit hacky, but this way we are sure that we got everything needed for the first event ever sent
+            filter: ({ type, payload }) => {
+                if (type !== "track") return true;
+                if (!payload?.properties) return true;
+
+                // Check if we we got the properties once initialized
+                if (!("sdkVersion" in payload.properties)) {
+                    payload.properties = {
+                        ...payload.properties,
+                        sdkVersion: process.env.SDK_VERSION,
+                    };
+                }
+
+                return true;
+            },
+        });
+        openPanel.setGlobalProperties({
+            sdkVersion: process.env.SDK_VERSION,
+        });
+        openPanel.init();
+    }
+
+    // Perform the post connection setup
+    const waitForSetup = postConnectionSetup({
+        config,
+        rpcClient,
+        lifecycleManager,
+    }).then(() => debugInfo.updateSetupStatus(true));
+
+    return {
+        config,
+        debugInfo,
+        waitForConnection: lifecycleManager.isConnected,
+        waitForSetup,
+        request: rpcClient.request,
+        listenerRequest: rpcClient.listen,
+        destroy,
+        openPanel,
+    };
+}
+
+/**
+ * Setup the heartbeat
+ * @param rpcClient - RPC client to send lifecycle events
+ * @param lifecycleManager - Lifecycle manager to track connection
+ */
+function setupHeartbeat(
+    rpcClient: SdkRpcClient,
+    lifecycleManager: IframeLifecycleManager
+) {
+    const HEARTBEAT_INTERVAL = 1_000; // Send heartbeat every 100ms until we are connected
+    const HEARTBEAT_TIMEOUT = 30_000; // 30 seconds timeout
+    let heartbeatInterval: NodeJS.Timeout;
+    let timeoutId: NodeJS.Timeout;
+
+    const sendHeartbeat = () =>
+        rpcClient.sendLifecycle({
+            clientLifecycle: "heartbeat",
+        });
+
+    // Start sending heartbeats
+    async function startHeartbeat() {
+        sendHeartbeat(); // Send initial heartbeat
+        heartbeatInterval = setInterval(sendHeartbeat, HEARTBEAT_INTERVAL);
+
+        // Set up timeout
+        timeoutId = setTimeout(() => {
+            stopHeartbeat();
+            console.log("Heartbeat timeout: connection failed");
+        }, HEARTBEAT_TIMEOUT);
+
+        // Once connected, stop it
+        await lifecycleManager.isConnected;
+
+        // We are now connected, stop the heartbeat
+        stopHeartbeat();
+    }
+
+    // Stop sending heartbeats
+    function stopHeartbeat() {
+        if (heartbeatInterval) {
+            clearInterval(heartbeatInterval);
+        }
+        if (timeoutId) {
+            clearTimeout(timeoutId);
+        }
+    }
+
+    startHeartbeat();
+
+    // Return cleanup function
+    return stopHeartbeat;
+}
+
+/**
+ * Perform the post connection setup
+ * @param config - SDK configuration
+ * @param rpcClient - RPC client to send lifecycle events
+ * @param lifecycleManager - Lifecycle manager to track connection
+ */
+async function postConnectionSetup({
+    config,
+    rpcClient,
+    lifecycleManager,
+}: {
+    config: FrakWalletSdkConfig;
+    rpcClient: SdkRpcClient;
+    lifecycleManager: IframeLifecycleManager;
+}): Promise<void> {
+    // Wait for the handler to be connected
+    await lifecycleManager.isConnected;
+
+    // Setup SSO URL listener to detect and forward SSO redirects
+    // This checks for ?sso= parameter and forwards compressed data to iframe
+    setupSsoUrlListener(rpcClient, lifecycleManager.isConnected);
+
+    // Push raw CSS if needed
+    async function pushCss() {
+        const cssLink = config.customizations?.css;
+        if (!cssLink) return;
+
+        const message = {
+            clientLifecycle: "modal-css" as const,
+            data: { cssLink },
+        };
+        rpcClient.sendLifecycle(message);
+    }
+
+    // Push i18n if needed
+    async function pushI18n() {
+        const i18n = config.customizations?.i18n;
+        if (!i18n) return;
+
+        const message = {
+            clientLifecycle: "modal-i18n" as const,
+            data: { i18n },
+        };
+        rpcClient.sendLifecycle(message);
+    }
+
+    // Push local backup if needed
+    async function pushBackup() {
+        if (typeof window === "undefined") return;
+
+        const backup = window.localStorage.getItem(BACKUP_KEY);
+        if (!backup) return;
+
+        const message = {
+            clientLifecycle: "restore-backup" as const,
+            data: { backup },
+        };
+        rpcClient.sendLifecycle(message);
+    }
+
+    await Promise.allSettled([pushCss(), pushI18n(), pushBackup()]);
+}

package/src/clients/index.ts

@@ -0,0 +1,3 @@
+export { createIFrameFrakClient } from "./createIFrameFrakClient";
+export { setupClient } from "./setupClient";
+export { DebugInfoGatherer } from "./DebugInfo";

package/src/clients/setupClient.ts

@@ -0,0 +1,71 @@
+import { createIFrameFrakClient } from "../clients";
+import type { FrakClient, FrakWalletSdkConfig } from "../types";
+import { createIframe, getSupportedCurrency } from "../utils";
+
+/**
+ * Directly setup the Frak client with an iframe
+ * Return when the FrakClient is ready (setup and communication estbalished with the wallet)
+ *
+ * @param config - The configuration to use for the Frak Wallet SDK
+ * @returns a Promise with the Frak Client
+ *
+ * @example
+ * const frakConfig: FrakWalletSdkConfig = {
+ *     metadata: {
+ *         name: "My app title",
+ *     },
+ * }
+ * const client = await setupClient({ config: frakConfig });
+ */
+export async function setupClient({
+    config,
+}: { config: FrakWalletSdkConfig }): Promise<FrakClient | undefined> {
+    // Prepare the config
+    const preparedConfig = prepareConfig(config);
+
+    // Create our iframe
+    const iframe = await createIframe({
+        config: preparedConfig,
+    });
+
+    if (!iframe) {
+        console.error("Failed to create iframe");
+        return;
+    }
+
+    // Create our client
+    const client = createIFrameFrakClient({
+        config: preparedConfig,
+        iframe,
+    });
+
+    // Wait for the client to be all setup
+    await client.waitForSetup;
+
+    // Wait for the connection to be established
+    const waitForConnection = await client.waitForConnection;
+    if (!waitForConnection) {
+        console.error("Failed to connect to client");
+        return;
+    }
+
+    return client;
+}
+
+/**
+ * Prepare the config for the Frak Client
+ * @param config - The configuration to use for the Frak Wallet SDK
+ * @returns The prepared configuration with the supported currency
+ */
+function prepareConfig(config: FrakWalletSdkConfig): FrakWalletSdkConfig {
+    // Get the supported currency (e.g. "eur")
+    const supportedCurrency = getSupportedCurrency(config.metadata?.currency);
+
+    return {
+        ...config,
+        metadata: {
+            ...config.metadata,
+            currency: supportedCurrency,
+        },
+    };
+}

package/src/clients/transports/iframeLifecycleManager.ts

@@ -0,0 +1,88 @@
+import { Deferred } from "@frak-labs/frame-connector";
+import type { FrakLifecycleEvent } from "../../types";
+import { BACKUP_KEY } from "../../utils/constants";
+import { changeIframeVisibility } from "../../utils/iframeHelper";
+
+/** @ignore */
+export type IframeLifecycleManager = {
+    isConnected: Promise<boolean>;
+    handleEvent: (messageEvent: FrakLifecycleEvent) => Promise<void>;
+};
+
+/**
+ * Create a new iframe lifecycle handler
+ * @ignore
+ */
+export function createIFrameLifecycleManager({
+    iframe,
+}: { iframe: HTMLIFrameElement }): IframeLifecycleManager {
+    // Create the isConnected listener
+    const isConnectedDeferred = new Deferred<boolean>();
+
+    // Build the handler itself
+    const handler = async (messageEvent: FrakLifecycleEvent) => {
+        if (!("iframeLifecycle" in messageEvent)) return;
+
+        const { iframeLifecycle: event, data } = messageEvent;
+
+        switch (event) {
+            // Resolve the isConnected promise
+            case "connected":
+                isConnectedDeferred.resolve(true);
+                break;
+            // Perform a frak backup
+            case "do-backup":
+                if (data.backup) {
+                    localStorage.setItem(BACKUP_KEY, data.backup);
+                } else {
+                    localStorage.removeItem(BACKUP_KEY);
+                }
+                break;
+            // Remove frak backup
+            case "remove-backup":
+                localStorage.removeItem(BACKUP_KEY);
+                break;
+            // Change iframe visibility
+            case "show":
+            case "hide":
+                changeIframeVisibility({
+                    iframe,
+                    isVisible: event === "show",
+                });
+                break;
+            // Handshake handling
+            case "handshake": {
+                iframe.contentWindow?.postMessage(
+                    {
+                        clientLifecycle: "handshake-response",
+                        data: {
+                            token: data.token,
+                            currentUrl: window.location.href,
+                        },
+                    },
+                    "*"
+                );
+                break;
+            }
+            // Redirect handling
+            case "redirect": {
+                const redirectUrl = new URL(data.baseRedirectUrl);
+
+                // If we got a u append the current location dynamicly
+                if (redirectUrl.searchParams.has("u")) {
+                    redirectUrl.searchParams.delete("u");
+                    redirectUrl.searchParams.append("u", window.location.href);
+                    window.location.href = redirectUrl.toString();
+                } else {
+                    window.location.href = data.baseRedirectUrl;
+                }
+                break;
+            }
+        }
+    };
+
+    return {
+        handleEvent: handler,
+        isConnected: isConnectedDeferred.promise,
+    };
+}

package/src/constants/interactionTypes.ts

@@ -0,0 +1,44 @@
+/**
+ * The final keys for each interaction types (e.g. `openArticle`) -> interaction type
+ * @inline
+ */
+export 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
+ * @inline
+ */
+export 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
+ */
+export const interactionTypes = {
+    press: {
+        openArticle: "0xc0a24ffb",
+        readArticle: "0xd5bd0fbe",
+    },
+    dapp: {
+        proofVerifiableStorageUpdate: "0x2ab2aeef",
+        callableVerifiableStorageUpdate: "0xa07da986",
+    },
+    webshop: {
+        open: "0xb311798f",
+    },
+    referral: {
+        referred: "0x010cc3b9",
+        createLink: "0xb2c0f17c",
+    },
+    purchase: {
+        started: "0xd87e90c3",
+        completed: "0x8403aeb4",
+        unsafeCompleted: "0x4d5b14e0",
+    },
+    retail: {
+        customerMeeting: "0x74489004",
+    },
+} as const;

package/src/constants/locales.ts

@@ -0,0 +1,14 @@
+/**
+ * The keys for each locales
+ * @inline
+ */
+export type LocalesKey = keyof typeof locales;
+
+/**
+ * Map the currency to the locale
+ */
+export const locales = {
+    eur: "fr-FR",
+    usd: "en-US",
+    gbp: "en-GB",
+} as const;

package/src/constants/productTypes.ts

@@ -0,0 +1,33 @@
+/**
+ * The keys for each product types
+ * @inline
+ */
+export type ProductTypesKey = keyof typeof productTypes;
+
+/**
+ * List of the product types per denominator
+ */
+export const productTypes = {
+    // content type
+    dapp: 1,
+    press: 2,
+    webshop: 3,
+    retail: 4,
+
+    // feature type
+    referral: 30,
+    purchase: 31,
+};
+
+/**
+ * Bitmask for each product types
+ */
+export const productTypesMask: Record<ProductTypesKey, bigint> = Object.entries(
+    productTypes
+).reduce(
+    (acc, [key, value]) => {
+        acc[key as ProductTypesKey] = BigInt(1) << BigInt(value);
+        return acc;
+    },
+    {} as Record<ProductTypesKey, bigint>
+);

package/src/index.ts

@@ -0,0 +1,103 @@
+// Clients
+export {
+    createIFrameFrakClient,
+    setupClient,
+    DebugInfoGatherer,
+} from "./clients";
+
+// Utils
+export {
+    compressJsonToB64,
+    decompressJsonFromB64,
+    createIframe,
+    FrakContextManager,
+    baseIframeProps,
+    findIframeInOpener,
+    getSupportedCurrency,
+    getSupportedLocale,
+    getCurrencyAmountKey,
+    formatAmount,
+    base64urlDecode,
+    base64urlEncode,
+    trackEvent,
+    generateSsoUrl,
+    type CompressedSsoData,
+    type FullSsoParams,
+    type AppSpecificSsoMetadata,
+} from "./utils";
+
+// Constants
+export {
+    type ProductTypesKey,
+    productTypes,
+    productTypesMask,
+} from "./constants/productTypes";
+export {
+    interactionTypes,
+    type InteractionTypesKey,
+    type FullInteractionTypesKey,
+} from "./constants/interactionTypes";
+export { locales, type LocalesKey } from "./constants/locales";
+export { ssoPopupFeatures, ssoPopupName } from "./actions/openSso";
+
+// Types
+export type {
+    // Rpc
+    WalletStatusReturnType,
+    IFrameRpcSchema,
+    PreparedInteraction,
+    SendInteractionParamsType,
+    SendInteractionReturnType,
+    SsoMetadata,
+    PrepareSsoParamsType,
+    PrepareSsoReturnType,
+    OpenSsoParamsType,
+    OpenSsoReturnType,
+    Currency,
+    Language,
+    I18nConfig,
+    LocalizedI18nConfig,
+    TokenAmountType,
+    GetProductInformationReturnType,
+    // RPC Embedded wallet
+    DisplayEmbeddedWalletParamsType,
+    DisplayEmbeddedWalletResultType,
+    LoggedOutEmbeddedView,
+    LoggedInEmbeddedView,
+    EmbeddedViewActionReferred,
+    EmbeddedViewActionSharing,
+    // RPC Modal generics
+    ModalStepTypes,
+    ModalRpcMetadata,
+    DisplayModalParamsType,
+    ModalRpcStepsInput,
+    ModalRpcStepsResultType,
+    // RPC Modal types
+    ModalStepMetadata,
+    LoginModalStepType,
+    SiweAuthenticateModalStepType,
+    SiweAuthenticationParams,
+    SiweAuthenticateReturnType,
+    SendTransactionTxType,
+    SendTransactionModalStepType,
+    SendTransactionReturnType,
+    OpenInteractionSessionReturnType,
+    OpenInteractionSessionModalStepType,
+    FinalModalStepType,
+    FinalActionType,
+    // Client
+    FrakClient,
+    // Transport
+    IFrameTransport,
+    IFrameLifecycleEvent,
+    ClientLifecycleEvent,
+    FrakLifecycleEvent,
+    // Config
+    FrakWalletSdkConfig,
+    // Compression
+    KeyProvider,
+    CompressedData,
+    HashProtectedData,
+    // Utils
+    FrakContext,
+} from "./types";

package/src/interactions/index.ts

@@ -0,0 +1,5 @@
+export { PressInteractionEncoder } from "./pressEncoder";
+export { ReferralInteractionEncoder } from "./referralEncoder";
+export { PurchaseInteractionEncoder } from "./purchaseEncoder";
+export { WebShopInteractionEncoder } from "./webshopEncoder";
+export { RetailInteractionEncoder } from "./retailEncoder";