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

package/src/actions/watchWalletStatus.test.ts

@@ -0,0 +1,372 @@
+/**
+ * Tests for watchWalletStatus action
+ * Tests wallet status watching and side effects
+ */
+
+import { vi } from "vitest";
+
+// Mock Deferred before imports
+vi.mock("@frak-labs/frame-connector", () => ({
+    Deferred: class {
+        promise: Promise<any>;
+        resolve: (value: any) => void;
+
+        constructor() {
+            let resolveFunc: (value: any) => void;
+            this.promise = new Promise((resolve) => {
+                resolveFunc = resolve;
+            });
+            this.resolve = resolveFunc!;
+        }
+    },
+}));
+
+import type { Address } from "viem";
+import {
+    afterEach,
+    beforeEach,
+    describe,
+    expect,
+    it,
+} from "../../tests/vitest-fixtures";
+import type { FrakClient, WalletStatusReturnType } from "../types";
+import { watchWalletStatus } from "./watchWalletStatus";
+
+describe("watchWalletStatus", () => {
+    let mockSessionStorage: {
+        getItem: ReturnType<typeof vi.fn>;
+        setItem: ReturnType<typeof vi.fn>;
+        removeItem: ReturnType<typeof vi.fn>;
+    };
+
+    beforeEach(() => {
+        // Mock sessionStorage
+        mockSessionStorage = {
+            getItem: vi.fn(),
+            setItem: vi.fn(),
+            removeItem: vi.fn(),
+        };
+        Object.defineProperty(window, "sessionStorage", {
+            value: mockSessionStorage,
+            writable: true,
+            configurable: true,
+        });
+    });
+
+    afterEach(() => {
+        vi.clearAllMocks();
+    });
+
+    describe("without callback", () => {
+        it("should make one-shot request", async () => {
+            const mockStatus: WalletStatusReturnType = {
+                key: "connected",
+                wallet: "0x1234567890123456789012345678901234567890" as Address,
+                interactionToken: "token-123",
+            };
+
+            const mockClient = {
+                request: vi.fn().mockResolvedValue(mockStatus),
+                openPanel: {
+                    setGlobalProperties: vi.fn(),
+                },
+            } as unknown as FrakClient;
+
+            const result = await watchWalletStatus(mockClient);
+
+            expect(mockClient.request).toHaveBeenCalledWith({
+                method: "frak_listenToWalletStatus",
+            });
+            expect(result).toEqual(mockStatus);
+        });
+
+        it("should save interaction token to sessionStorage", async () => {
+            const mockStatus: WalletStatusReturnType = {
+                key: "connected",
+                wallet: "0x1234567890123456789012345678901234567890" as Address,
+                interactionToken: "token-abc",
+            };
+
+            const mockClient = {
+                request: vi.fn().mockResolvedValue(mockStatus),
+                openPanel: {
+                    setGlobalProperties: vi.fn(),
+                },
+            } as unknown as FrakClient;
+
+            await watchWalletStatus(mockClient);
+
+            expect(mockSessionStorage.setItem).toHaveBeenCalledWith(
+                "frak-wallet-interaction-token",
+                "token-abc"
+            );
+        });
+
+        it("should remove interaction token when not present", async () => {
+            const mockStatus: WalletStatusReturnType = {
+                key: "not-connected",
+            };
+
+            const mockClient = {
+                request: vi.fn().mockResolvedValue(mockStatus),
+                openPanel: {
+                    setGlobalProperties: vi.fn(),
+                },
+            } as unknown as FrakClient;
+
+            await watchWalletStatus(mockClient);
+
+            expect(mockSessionStorage.removeItem).toHaveBeenCalledWith(
+                "frak-wallet-interaction-token"
+            );
+        });
+
+        it("should update OpenPanel global properties", async () => {
+            const mockStatus: WalletStatusReturnType = {
+                key: "connected",
+                wallet: "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd" as Address,
+            };
+
+            const mockClient = {
+                request: vi.fn().mockResolvedValue(mockStatus),
+                openPanel: {
+                    setGlobalProperties: vi.fn(),
+                },
+            } as unknown as FrakClient;
+
+            await watchWalletStatus(mockClient);
+
+            expect(
+                mockClient.openPanel?.setGlobalProperties
+            ).toHaveBeenCalledWith({
+                wallet: "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd",
+            });
+        });
+
+        it("should set wallet to null when not connected", async () => {
+            const mockStatus: WalletStatusReturnType = {
+                key: "not-connected",
+            };
+
+            const mockClient = {
+                request: vi.fn().mockResolvedValue(mockStatus),
+                openPanel: {
+                    setGlobalProperties: vi.fn(),
+                },
+            } as unknown as FrakClient;
+
+            await watchWalletStatus(mockClient);
+
+            expect(
+                mockClient.openPanel?.setGlobalProperties
+            ).toHaveBeenCalledWith({
+                wallet: null,
+            });
+        });
+
+        it("should work without openPanel", async () => {
+            const mockStatus: WalletStatusReturnType = {
+                key: "connected",
+                wallet: "0x1234567890123456789012345678901234567890" as Address,
+            };
+
+            const mockClient = {
+                request: vi.fn().mockResolvedValue(mockStatus),
+            } as unknown as FrakClient;
+
+            const result = await watchWalletStatus(mockClient);
+
+            expect(result).toEqual(mockStatus);
+        });
+    });
+
+    describe("with callback", () => {
+        it("should setup listener request", async () => {
+            const mockStatus: WalletStatusReturnType = {
+                key: "connected",
+                wallet: "0x1234567890123456789012345678901234567890" as Address,
+            };
+
+            const mockCallback = vi.fn();
+            const mockClient = {
+                listenerRequest: vi.fn((_params, callback) => {
+                    // Simulate status update
+                    setTimeout(() => callback(mockStatus), 0);
+                }),
+                openPanel: {
+                    setGlobalProperties: vi.fn(),
+                },
+            } as unknown as FrakClient;
+
+            const resultPromise = watchWalletStatus(mockClient, mockCallback);
+
+            expect(mockClient.listenerRequest).toHaveBeenCalled();
+
+            await resultPromise;
+        });
+
+        it("should call callback with status updates", async () => {
+            const mockStatus: WalletStatusReturnType = {
+                key: "connected",
+                wallet: "0x1234567890123456789012345678901234567890" as Address,
+                interactionToken: "token-123",
+            };
+
+            const mockCallback = vi.fn();
+            const mockClient = {
+                listenerRequest: vi.fn((_params, callback) => {
+                    setTimeout(() => callback(mockStatus), 0);
+                }),
+                openPanel: {
+                    setGlobalProperties: vi.fn(),
+                },
+            } as unknown as FrakClient;
+
+            await watchWalletStatus(mockClient, mockCallback);
+
+            expect(mockCallback).toHaveBeenCalledWith(mockStatus);
+        });
+
+        it("should resolve promise with first status", async () => {
+            const firstStatus: WalletStatusReturnType = {
+                key: "connected",
+                wallet: "0x1234567890123456789012345678901234567890" as Address,
+            };
+
+            const secondStatus: WalletStatusReturnType = {
+                key: "connected",
+                wallet: "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd" as Address,
+            };
+
+            const mockCallback = vi.fn();
+            const mockClient = {
+                listenerRequest: vi.fn((_params, callback) => {
+                    setTimeout(() => {
+                        callback(firstStatus);
+                        callback(secondStatus);
+                    }, 0);
+                }),
+                openPanel: {
+                    setGlobalProperties: vi.fn(),
+                },
+            } as unknown as FrakClient;
+
+            const result = await watchWalletStatus(mockClient, mockCallback);
+
+            expect(result).toEqual(firstStatus);
+            expect(mockCallback).toHaveBeenCalledTimes(2);
+        });
+
+        it("should handle side effects for each status update", async () => {
+            const firstStatus: WalletStatusReturnType = {
+                key: "connected",
+                wallet: "0x1234567890123456789012345678901234567890" as Address,
+                interactionToken: "token-1",
+            };
+
+            const secondStatus: WalletStatusReturnType = {
+                key: "connected",
+                wallet: "0x1234567890123456789012345678901234567890" as Address,
+                interactionToken: "token-2",
+            };
+
+            const mockCallback = vi.fn();
+            const mockClient = {
+                listenerRequest: vi.fn((_params, callback) => {
+                    setTimeout(() => {
+                        callback(firstStatus);
+                        callback(secondStatus);
+                    }, 0);
+                }),
+                openPanel: {
+                    setGlobalProperties: vi.fn(),
+                },
+            } as unknown as FrakClient;
+
+            await watchWalletStatus(mockClient, mockCallback);
+
+            // Both tokens should be saved
+            expect(mockSessionStorage.setItem).toHaveBeenCalledWith(
+                "frak-wallet-interaction-token",
+                "token-1"
+            );
+            expect(mockSessionStorage.setItem).toHaveBeenCalledWith(
+                "frak-wallet-interaction-token",
+                "token-2"
+            );
+        });
+
+        it("should save and remove interaction token based on status", async () => {
+            const connectedStatus: WalletStatusReturnType = {
+                key: "connected",
+                wallet: "0x1234567890123456789012345678901234567890" as Address,
+                interactionToken: "token-123",
+            };
+
+            const disconnectedStatus: WalletStatusReturnType = {
+                key: "not-connected",
+            };
+
+            const mockCallback = vi.fn();
+            const mockClient = {
+                listenerRequest: vi.fn((_params, callback) => {
+                    setTimeout(() => {
+                        callback(connectedStatus);
+                        callback(disconnectedStatus);
+                    }, 0);
+                }),
+                openPanel: {
+                    setGlobalProperties: vi.fn(),
+                },
+            } as unknown as FrakClient;
+
+            await watchWalletStatus(mockClient, mockCallback);
+
+            expect(mockSessionStorage.setItem).toHaveBeenCalledWith(
+                "frak-wallet-interaction-token",
+                "token-123"
+            );
+            expect(mockSessionStorage.removeItem).toHaveBeenCalledWith(
+                "frak-wallet-interaction-token"
+            );
+        });
+
+        it("should update OpenPanel properties with each status", async () => {
+            const firstStatus: WalletStatusReturnType = {
+                key: "connected",
+                wallet: "0x1111111111111111111111111111111111111111" as Address,
+            };
+
+            const secondStatus: WalletStatusReturnType = {
+                key: "connected",
+                wallet: "0x2222222222222222222222222222222222222222" as Address,
+            };
+
+            const mockCallback = vi.fn();
+            const mockClient = {
+                listenerRequest: vi.fn((_params, callback) => {
+                    setTimeout(() => {
+                        callback(firstStatus);
+                        callback(secondStatus);
+                    }, 0);
+                }),
+                openPanel: {
+                    setGlobalProperties: vi.fn(),
+                },
+            } as unknown as FrakClient;
+
+            await watchWalletStatus(mockClient, mockCallback);
+
+            expect(
+                mockClient.openPanel?.setGlobalProperties
+            ).toHaveBeenCalledWith({
+                wallet: "0x1111111111111111111111111111111111111111",
+            });
+            expect(
+                mockClient.openPanel?.setGlobalProperties
+            ).toHaveBeenCalledWith({
+                wallet: "0x2222222222222222222222222222222222222222",
+            });
+        });
+    });
+});

package/src/actions/watchWalletStatus.ts

@@ -0,0 +1,94 @@
+import { Deferred } from "@frak-labs/frame-connector";
+import type { FrakClient } from "../types/client";
+import type { WalletStatusReturnType } from "../types/rpc/walletStatus";
+
+/**
+ * Function used to watch the current frak wallet status
+ * @param client - The current Frak Client
+ * @param callback - The callback that will receive any wallet status change
+ * @returns A promise resolving with the initial wallet status
+ *
+ * @description This function will return the current wallet status, and will listen to any change in the wallet status.
+ *
+ * @example
+ * await watchWalletStatus(frakConfig, (status: WalletStatusReturnType) => {
+ *     if (status.key === "connected") {
+ *         console.log("Wallet connected:", status.wallet);
+ *         console.log("Current interaction session:", status.interactionSession);
+ *     } else {
+ *         console.log("Wallet not connected");
+ *     }
+ * });
+ */
+export function watchWalletStatus(
+    client: FrakClient,
+    callback?: (status: WalletStatusReturnType) => void
+): Promise<WalletStatusReturnType> {
+    // If no callback is provided, just do a request with deferred result
+    if (!callback) {
+        return client
+            .request({ method: "frak_listenToWalletStatus" })
+            .then((result) => {
+                // Handle side effects of this request
+                walletStatusSideEffect(client, result);
+
+                // Return the result
+                return result;
+            });
+    }
+
+    // Otherwise, listen to the wallet status and return the first one received
+    const firstResult = new Deferred<WalletStatusReturnType>();
+    let hasResolved = false;
+
+    // Start the listening request, and return the first result
+    client.listenerRequest(
+        {
+            method: "frak_listenToWalletStatus",
+        },
+        (status) => {
+            // Handle side effects of this request
+            walletStatusSideEffect(client, status);
+
+            // Transmit the status to the callback
+            callback(status);
+
+            // If the promise hasn't resolved yet, resolve it
+            if (!hasResolved) {
+                firstResult.resolve(status);
+                hasResolved = true;
+            }
+        }
+    );
+
+    return firstResult.promise;
+}
+
+/**
+ * Helper to save a potential interaction token
+ * @param interactionToken
+ */
+function walletStatusSideEffect(
+    client: FrakClient,
+    status: WalletStatusReturnType
+) {
+    if (typeof window === "undefined") {
+        return;
+    }
+
+    // Update the global properties
+    client.openPanel?.setGlobalProperties({
+        wallet: status.wallet ?? null,
+    });
+
+    if (status.interactionToken) {
+        // If we got an interaction token, save it
+        window.sessionStorage.setItem(
+            "frak-wallet-interaction-token",
+            status.interactionToken
+        );
+    } else {
+        // Otherwise, remove it
+        window.sessionStorage.removeItem("frak-wallet-interaction-token");
+    }
+}

package/src/actions/wrapper/modalBuilder.ts

@@ -0,0 +1,212 @@
+import type {
+    DisplayModalParamsType,
+    FinalActionType,
+    FinalModalStepType,
+    FrakClient,
+    LoginModalStepType,
+    ModalRpcMetadata,
+    ModalRpcStepsResultType,
+    ModalStepTypes,
+    OpenInteractionSessionModalStepType,
+    SendTransactionModalStepType,
+} from "../../types";
+import { displayModal } from "../displayModal";
+
+/**
+ * Represent the type of the modal step builder
+ */
+export type ModalStepBuilder<
+    Steps extends ModalStepTypes[] = ModalStepTypes[],
+> = {
+    /**
+     * The current modal params
+     */
+    params: DisplayModalParamsType<Steps>;
+    /**
+     * Add a send transaction step to the modal
+     */
+    sendTx: (
+        options: SendTransactionModalStepType["params"]
+    ) => ModalStepBuilder<[...Steps, SendTransactionModalStepType]>;
+    /**
+     * Add a final step of type reward to the modal
+     */
+    reward: (
+        options?: Omit<FinalModalStepType["params"], "action">
+    ) => ModalStepBuilder<[...Steps, FinalModalStepType]>;
+    /**
+     * Add a final step of type sharing to the modal
+     */
+    sharing: (
+        sharingOptions?: Extract<
+            FinalActionType,
+            { key: "sharing" }
+        >["options"],
+        options?: Omit<FinalModalStepType["params"], "action">
+    ) => ModalStepBuilder<[...Steps, FinalModalStepType]>;
+    /**
+     * Display the modal
+     * @param metadataOverride - Function returning optional metadata to override the current modal metadata
+     */
+    display: (
+        metadataOverride?: (
+            current?: ModalRpcMetadata
+        ) => ModalRpcMetadata | undefined
+    ) => Promise<ModalRpcStepsResultType<Steps>>;
+};
+
+/**
+ * Represent the output type of the modal builder
+ */
+export type ModalBuilder = ModalStepBuilder<
+    [LoginModalStepType, OpenInteractionSessionModalStepType]
+>;
+
+/**
+ * Helper to craft Frak modal, and share a base initial config
+ * @param client - The current Frak Client
+ * @param args
+ * @param args.metadata - Common modal metadata (customisation, language etc)
+ * @param args.login - Login step parameters
+ * @param args.openSession - Open session step parameters
+ *
+ * @description This function will create a modal builder with the provided metadata, login and open session parameters.
+ *
+ * @example
+ * Here is an example of how to use the `modalBuilder` to create and display a sharing modal:
+ *
+ * ```js
+ * // Create the modal builder
+ * const modalBuilder = window.FrakSDK.modalBuilder(frakClient, baseModalConfig);
+ *
+ * // Configure the information to be shared via the sharing link
+ * const sharingConfig = {
+ *   popupTitle: "Share this with your friends",
+ *   text: "Discover our product!",
+ *   link: window.location.href,
+ * };
+ *
+ * // Display the sharing modal
+ * function modalShare() {
+ *   modalBuilder.sharing(sharingConfig).display();
+ * }
+ * ```
+ *
+ * @see {@link ModalStepTypes} for more info about each modal step types and their parameters
+ * @see {@link ModalRpcMetadata} for more info about the metadata that can be passed to the modal
+ * @see {@link ModalRpcStepsResultType} for more info about the result of each modal steps
+ * @see {@link displayModal} for more info about how the modal is displayed
+ */
+export function modalBuilder(
+    client: FrakClient,
+    {
+        metadata,
+        login,
+        openSession,
+    }: {
+        metadata?: ModalRpcMetadata;
+        login?: LoginModalStepType["params"];
+        openSession?: OpenInteractionSessionModalStepType["params"];
+    }
+): ModalBuilder {
+    // Build the initial modal params
+    const baseParams: DisplayModalParamsType<
+        [LoginModalStepType, OpenInteractionSessionModalStepType]
+    > = {
+        steps: {
+            login: login ?? {},
+            openSession: openSession ?? {},
+        },
+        metadata,
+    };
+
+    // Return the step builder
+    return modalStepsBuilder(client, baseParams);
+}
+
+/**
+ * Modal step builder, allowing to add new steps to the modal, and to build and display it
+ */
+function modalStepsBuilder<CurrentSteps extends ModalStepTypes[]>(
+    client: FrakClient,
+    params: DisplayModalParamsType<CurrentSteps>
+): ModalStepBuilder<CurrentSteps> {
+    // Function add the send tx step
+    function sendTx(options: SendTransactionModalStepType["params"]) {
+        return modalStepsBuilder<
+            [...CurrentSteps, SendTransactionModalStepType]
+        >(client, {
+            ...params,
+            steps: {
+                ...params.steps,
+                sendTransaction: options,
+            },
+        } as DisplayModalParamsType<
+            [...CurrentSteps, SendTransactionModalStepType]
+        >);
+    }
+
+    // Function to add a reward step at the end
+    function reward(options?: Omit<FinalModalStepType["params"], "action">) {
+        return modalStepsBuilder<[...CurrentSteps, FinalModalStepType]>(
+            client,
+            {
+                ...params,
+                steps: {
+                    ...params.steps,
+                    final: {
+                        ...options,
+                        action: { key: "reward" },
+                    },
+                },
+            } as DisplayModalParamsType<[...CurrentSteps, FinalModalStepType]>
+        );
+    }
+
+    // Function to add sharing step at the end
+    function sharing(
+        sharingOptions?: Extract<
+            FinalActionType,
+            { key: "sharing" }
+        >["options"],
+        options?: Omit<FinalModalStepType["params"], "action">
+    ) {
+        return modalStepsBuilder<[...CurrentSteps, FinalModalStepType]>(
+            client,
+            {
+                ...params,
+                steps: {
+                    ...params.steps,
+                    final: {
+                        ...options,
+                        action: { key: "sharing", options: sharingOptions },
+                    },
+                },
+            } as DisplayModalParamsType<[...CurrentSteps, FinalModalStepType]>
+        );
+    }
+
+    // Function to display it
+    async function display(
+        metadataOverride?: (
+            current?: ModalRpcMetadata
+        ) => ModalRpcMetadata | undefined
+    ) {
+        // If we have a metadata override, apply it
+        if (metadataOverride) {
+            params.metadata = metadataOverride(params.metadata ?? {});
+        }
+        return await displayModal(client, params);
+    }
+
+    return {
+        // Access current modal params
+        params,
+        // Function to add new steps
+        sendTx,
+        reward,
+        sharing,
+        // Display the modal
+        display,
+    };
+}