@frak-labs/core-sdk/src/rewards/format.test.ts

Core SDK of the Frak wallet, low level library to interact directly with the frak ecosystem.

import { describe, expect, it } from "vitest";
import type { EstimatedReward } from "../types";
import {
    applyRewardPlaceholder,
    formatEstimatedReward,
    formatRewardOrHide,
} from "./format";

const amount = (eur: number) => ({
    amount: eur,
    eurAmount: eur,
    usdAmount: eur,
    gbpAmount: eur,
});

describe("formatEstimatedReward", () => {
    it("formats a fixed reward in the default currency, rounded", () => {
        const reward: EstimatedReward = {
            payoutType: "fixed",
            amount: amount(5.4),
        };
        // Intl renders a narrow no-break space before "€" — assert content.
        const formatted = formatEstimatedReward(reward);
        expect(formatted).toContain("5");
        expect(formatted).not.toContain("6");
        expect(formatted).toContain("€");
    });

    it("renders a percentage reward as a percent string (never a basket amount)", () => {
        const reward: EstimatedReward = {
            payoutType: "percentage",
            percent: 10,
            percentOf: "purchase_amount",
            maxAmount: amount(50),
        };
        expect(formatEstimatedReward(reward)).toBe("10 %");
    });

    it("uses the richest token tier for a tiered reward", () => {
        const reward: EstimatedReward = {
            payoutType: "tiered",
            tierField: "purchase.amount",
            tiers: [
                { minValue: 0, maxValue: 50, amount: amount(2) },
                { minValue: 50, amount: amount(8) },
            ],
        };
        const formatted = formatEstimatedReward(reward);
        expect(formatted).toContain("8");
        expect(formatted).toContain("€");
    });

    it("falls back to the max percent when tiers carry no token amount", () => {
        const reward: EstimatedReward = {
            payoutType: "tiered",
            tierField: "purchase.amount",
            tiers: [
                { minValue: 0, maxValue: 50, percent: 5 },
                { minValue: 50, percent: 12 },
            ],
        };
        expect(formatEstimatedReward(reward)).toBe("12 %");
    });

    it("respects the requested currency", () => {
        const reward: EstimatedReward = {
            payoutType: "fixed",
            amount: amount(5),
        };
        const formatted = formatEstimatedReward(reward, "usd");
        expect(formatted).toContain("5");
        expect(formatted).toContain("$");
    });
});

describe("formatRewardOrHide", () => {
    it("returns undefined for a missing reward", () => {
        expect(formatRewardOrHide(undefined)).toBeUndefined();
    });

    it("formats a fixed reward that carries money value", () => {
        const formatted = formatRewardOrHide({
            payoutType: "fixed",
            amount: amount(5),
        });
        expect(formatted).toContain("5");
        expect(formatted).toContain("€");
    });

    it("hides a fixed reward with no money value", () => {
        expect(
            formatRewardOrHide({ payoutType: "fixed", amount: amount(0) })
        ).toBeUndefined();
    });

    it("always shows a capped percentage as a percent string", () => {
        expect(
            formatRewardOrHide({
                payoutType: "percentage",
                percent: 10,
                percentOf: "purchase_amount",
                maxAmount: amount(50),
            })
        ).toBe("10 %");
    });

    it("shows an uncapped percentage as a percent string (no money value)", () => {
        expect(
            formatRewardOrHide({
                payoutType: "percentage",
                percent: 8,
                percentOf: "purchase_amount",
            })
        ).toBe("8 %");
    });

    it("shows a percent-only tiered reward instead of hiding it", () => {
        expect(
            formatRewardOrHide({
                payoutType: "tiered",
                tierField: "purchase.amount",
                tiers: [
                    { minValue: 0, maxValue: 50, percent: 5 },
                    { minValue: 50, percent: 12 },
                ],
            })
        ).toBe("12 %");
    });
});

describe("applyRewardPlaceholder", () => {
    it("substitutes the reward into the placeholder", () => {
        expect(applyRewardPlaceholder("Earn {REWARD} now", "5 €")).toBe(
            "Earn 5 € now"
        );
    });

    it("strips the placeholder when no reward is provided", () => {
        expect(applyRewardPlaceholder("Earn {REWARD} now", undefined)).toBe(
            "Earn  now"
        );
    });
});