@fruga/sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,398 @@
+import React, { ReactNode } from 'react';
+import * as zustand from 'zustand';
+
+type RequiredActionType = 'ADD_PAYOUT_METHOD';
+interface RequiredAction {
+    type: RequiredActionType;
+    transactionId?: number;
+}
+interface Wallet {
+    available: number;
+    pending: number;
+    totalBalance: number;
+    lifetimeEarned: number;
+    lifetimeRedeemed: number;
+    updatedAt: string;
+    requiredActions: RequiredAction[] | null;
+}
+
+type PayoutMethodType = 'BANK';
+type PayoutMethodStatus = 'ACTIVE' | 'INACTIVE' | 'PENDING';
+interface BankInfo {
+    accountLast4: string;
+    sortCodeMasked: string;
+    accountHolderName: string;
+}
+interface PayoutMethod {
+    id: string | number;
+    methodType: PayoutMethodType;
+    isDefault: boolean;
+    status: PayoutMethodStatus;
+    bank: BankInfo;
+    createdAt: string;
+    updatedAt: string;
+}
+interface AddBankPayload {
+    accountHolderName: string;
+    accountNumber: string;
+    sortCode: string;
+}
+interface PayoutMethodListResponse {
+    items: PayoutMethod[];
+}
+
+interface Transaction {
+    id: number;
+    brandName: string;
+    brandLogo: string;
+    offerName: string;
+    purchaseAmount: number;
+    activityAmount: number;
+    occuredAt: string;
+    type: string;
+    status: string;
+    flow: string;
+    blockingReason?: string;
+    notes?: string;
+    partnerEventId: string;
+    redemptionContext: string;
+}
+interface Activity {
+    actorType: string;
+    partnerId: number;
+    transactions: Transaction[];
+}
+interface PaginatedActivity {
+    actorType: string;
+    partnerId: number;
+    transactions: Transaction[];
+}
+
+declare const DEFAULT_THEME: {
+    widgetTitle: string;
+    launcherLabel: string;
+    launcherIcon: "gift" | "sparkles" | "credit" | "arrow" | "none";
+    showLauncher: boolean;
+    mode: "dark" | "light";
+    allowUserThemeControl: boolean;
+    defaultTheme: "dark" | "light";
+    uiVersion: "legacy" | "current";
+    primary: string;
+    accent: string;
+    accentTextLight: string;
+    accentTextDark: string;
+    bg: string;
+    panel: string;
+    panel2: string;
+    itemBg: string;
+    text: string;
+    muted: string;
+    border: string;
+    success: string;
+    danger: string;
+    warning: string;
+    lightBg: string;
+    lightPanel: string;
+    lightPanel2: string;
+    lightItemBg: string;
+    lightText: string;
+    lightMuted: string;
+    lightBorder: string;
+};
+type Theme = typeof DEFAULT_THEME & {
+    textColorDark?: string;
+    textColorLight?: string;
+};
+type ResolvedTheme = Pick<Theme, "primary" | "accent" | "accentTextLight" | "accentTextDark" | "success" | "warning" | "widgetTitle" | "launcherLabel" | "launcherIcon" | "danger" | "allowUserThemeControl"> & {
+    bg: string;
+    panel: string;
+    panel2: string;
+    itemBg: string;
+    text: string;
+    muted: string;
+    border: string;
+    subtleBg: string;
+    tooltipBg: string;
+    tooltipBorder: string;
+    accentText: string;
+    isLight: boolean;
+    mode: "light" | "dark";
+};
+declare function getResolvedTheme(theme: Theme): ResolvedTheme;
+
+interface OfferCategory {
+    id: number;
+    name: string;
+    rank: number;
+    offerCount: number;
+}
+type OfferCategoryResponse = OfferCategory[];
+
+type Category = string;
+interface Offer {
+    id: number;
+    name: string;
+    brandName: string;
+    description: string;
+    terms: string;
+    link: string;
+    type: "AFFILIATE_LINK" | "PAYMENT_LINK" | "GIFTCARD" | string;
+    logo: string;
+    cashback: number;
+    endDate: string;
+    featured: boolean;
+    categories: OfferCategory[];
+}
+
+interface PaginatedResponse<T> {
+    content: T[];
+    totalElements: number;
+    totalPages: number;
+    number: number;
+    size: number;
+    numberOfElements: number;
+    numberOfPages: number;
+}
+
+interface OfferQuery {
+    pageNumber?: number;
+    pageSize?: number;
+    type?: "AFFILIATE_LINK" | "PAYMENT_LINK" | "GIFTCARD" | string;
+    query?: string;
+    featured?: boolean;
+    categories?: string[];
+}
+
+type PartnerType = 'RELAY' | 'CONNECT' | 'EXTERNAL_TENANT';
+interface PartnerConfig {
+    partnerId: string;
+    partnerType: PartnerType;
+    theme?: {
+        primaryColor?: string;
+        mode?: 'light' | 'dark';
+    };
+    features?: Record<string, boolean>;
+    appUrl?: string;
+    partnerKey?: string;
+    userId?: string;
+}
+interface WidgetUiConfig {
+    accent: string;
+    defaultTheme: 'light' | 'dark';
+    launcherIcon: string;
+    showLauncher: boolean;
+    launcherLabel: string;
+    accentTextDark: string;
+    accentTextLight: string;
+    allowUserThemeControl: boolean;
+}
+interface BootstrapAuth {
+    mode: string;
+    audience: string;
+    issuer: string;
+    tokenTtlSeconds: number;
+}
+interface WidgetBootstrap {
+    partnerEnvId: string;
+    partnerId: string;
+    partnerType: PartnerType;
+    partnerPayout: 'PARTNER' | 'USER';
+    auth: BootstrapAuth;
+    config: {
+        ui: WidgetUiConfig;
+        validValues: {
+            defaultTheme: string[];
+            launcherIcon: string[];
+        };
+    };
+}
+interface RelayConfig {
+    containerId: string;
+    partnerKey: string;
+    token?: string;
+    baseUrl?: string;
+    theme?: 'light' | 'dark';
+    primaryColor?: string;
+    userId?: string;
+    bootstrapConfig?: WidgetBootstrap;
+    isHostMobile?: boolean;
+    hostHeight?: number;
+}
+interface RelayState {
+    isOpen: boolean;
+    isClaimed: boolean;
+}
+declare global {
+    interface Window {
+        FrugaRelay?: {
+            init: (config: RelayConfig) => void;
+        };
+    }
+}
+
+interface IWalletService {
+    getWallet(): Promise<Wallet>;
+}
+
+interface IActivityService {
+    getActivity(pageNumber?: number, pageSize?: number): Promise<PaginatedActivity>;
+}
+
+interface IOffersService {
+    getCategories(): Promise<OfferCategoryResponse>;
+    getOffers(query: OfferQuery): Promise<PaginatedResponse<Offer>>;
+}
+
+interface IPayoutService {
+    listMethods(): Promise<PayoutMethod[]>;
+    addBankMethod(payload: AddBankPayload): Promise<PayoutMethod>;
+    deleteMethod(id: string | number): Promise<void>;
+}
+
+declare class HttpWalletService implements IWalletService {
+    private readonly baseUrl;
+    private readonly token;
+    constructor(baseUrl: string, token: string);
+    getWallet(): Promise<Wallet>;
+    private getEmptyWallet;
+}
+
+type QueryParamValue = string | number | boolean | string[] | undefined | null;
+declare abstract class BaseHttpService {
+    protected readonly baseUrl: string;
+    protected readonly token: string;
+    constructor(baseUrl: string, token: string);
+    protected fetchQuery(path: string, queryParams?: Record<string, QueryParamValue>): Promise<Response>;
+}
+
+declare class HttpActivityService extends BaseHttpService implements IActivityService {
+    constructor(baseUrl: string, token: string);
+    getActivity(pageNumber?: number, pageSize?: number): Promise<PaginatedActivity>;
+    private getEmptyActivity;
+}
+
+declare class HttpOffersService extends BaseHttpService implements IOffersService {
+    constructor(baseUrl: string, token: string);
+    getCategories(): Promise<OfferCategoryResponse>;
+    getOffers(query: OfferQuery): Promise<PaginatedResponse<Offer>>;
+    private getEmptyPaginatedResponse;
+}
+
+declare class HttpPayoutService implements IPayoutService {
+    private readonly baseUrl;
+    private readonly token;
+    constructor(baseUrl: string, token: string);
+    listMethods(): Promise<PayoutMethod[]>;
+    addBankMethod(payload: AddBankPayload): Promise<PayoutMethod>;
+    deleteMethod(id: string | number): Promise<void>;
+}
+
+interface ButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
+    variant?: 'primary' | 'secondary';
+}
+declare const WidgetButton: React.FC<ButtonProps>;
+declare const WidgetHeader: React.FC<{
+    title: string;
+}>;
+
+interface WidgetContainerProps {
+    children: ReactNode;
+    hostHeight?: number;
+    isMobile?: boolean;
+    theme: Theme;
+}
+declare const WidgetContainer: React.FC<WidgetContainerProps>;
+
+interface WidgetContextType {
+    isOpen: boolean;
+    toggle: () => void;
+    setOpen: (open: boolean) => void;
+}
+/**
+ * @deprecated Use useWidgetStore instead or the updated useWidget hook.
+ * The WidgetProvider is no longer required as we are using Zustand for state management.
+ */
+declare const WidgetProvider: React.FC<{
+    children: ReactNode;
+}>;
+declare const useWidget: () => WidgetContextType;
+
+interface WidgetState {
+    isOpen: boolean;
+    isFocused: boolean;
+    isIdle: boolean;
+    mode: 'light' | 'dark';
+    token: string | null;
+    partnerPayout: 'PARTNER' | 'USER' | null;
+    toggle: () => void;
+    setOpen: (open: boolean) => void;
+    setFocused: (focused: boolean) => void;
+    setIdle: (idle: boolean) => void;
+    available: number;
+    pending: number;
+    setBalances: (available: number, pending: number) => void;
+    setMode: (mode: 'light' | 'dark') => void;
+    setToken: (token: string | null) => void;
+    setPartnerPayout: (payout: 'PARTNER' | 'USER') => void;
+    isAddingPayoutFromAlert: boolean;
+    setIsAddingPayoutFromAlert: (val: boolean) => void;
+    showPayoutSuccess: boolean;
+    setShowPayoutSuccess: (val: boolean) => void;
+}
+declare const useWidgetStore: zustand.UseBoundStore<zustand.StoreApi<WidgetState>>;
+
+/**
+ * A hook that returns a debounced version of the provided value.
+ * @param value The value to debounce
+ * @param delay The delay in milliseconds
+ * @returns The debounced value
+ */
+declare const useDebounce: <T>(value: T, delay: number) => T;
+
+declare const STORAGE_KEYS: {
+    readonly BOOTSTRAP_DATA: "fruga_bootstrap";
+    readonly BOOTSTRAP_CONFIG: "fruga_active_config";
+};
+declare class StorageService {
+    static set<T>(key: string, value: T): void;
+    static get<T>(key: string): T | null;
+    static remove(key: string): void;
+    static clear(): void;
+}
+
+/**
+ * Default API Base URL for the Fruga SDK.
+ * This can be overridden at build-time using the VITE_FRUGA_API_URL environment variable.
+ */
+declare const DEFAULT_API_URL: string;
+declare const getBaseUrl: (override?: string) => string;
+
+/**
+ * Formats a date string to "DD-MM-YYYY"
+ * @param dateStr Date string in various formats (e.g., "YYYY-MM-DD", "DD/MM/YYYY", ISO)
+ * @returns Formatted date string "DD-MM-YYYY" (e.g., "09-04-2026")
+ */
+declare const formatDate: (dateStr?: string) => string;
+/**
+ * Checks if a date is within a certain number of days from now
+ * @param dateStr Date string
+ * @param daysLimit Number of days
+ * @returns boolean
+ */
+declare const isWithinDays: (dateStr?: string, daysLimit?: number) => boolean;
+/**
+ * Gets the number of days remaining until a target date
+ * @param dateStr Date string
+ * @returns Number of days (0 or more) or null if invalid
+ */
+declare const getDaysRemaining: (dateStr?: string) => number | null;
+
+/**
+ * Truncates a string if it exceeds a certain length and adds an ellipsis.
+ * @param str The string to truncate
+ * @param maxLength The maximum length before truncation (default 40)
+ * @returns The truncated string with "..." if it was truncated, otherwise the original string.
+ */
+declare const truncateText: (str: string | undefined | null, maxLength?: number) => string;
+
+export { type Activity, type AddBankPayload, type BankInfo, type BootstrapAuth, type Category, DEFAULT_API_URL, DEFAULT_THEME, DEFAULT_THEME as DefaultTheme, HttpActivityService, HttpOffersService, HttpPayoutService, HttpWalletService, type IActivityService, type IOffersService, type IPayoutService, type IWalletService, type Offer, type OfferCategory, type OfferCategoryResponse, type OfferQuery, type PaginatedActivity, type PaginatedResponse, type PartnerConfig, type PartnerType, type PayoutMethod, type PayoutMethodListResponse, type PayoutMethodStatus, type PayoutMethodType, type RelayConfig, type RelayState, type RequiredAction, type RequiredActionType, type ResolvedTheme, STORAGE_KEYS, StorageService, type Theme, type Transaction, type Wallet, type WidgetBootstrap, WidgetButton, WidgetContainer, type WidgetContainerProps, type WidgetContextType, WidgetHeader, WidgetProvider, type WidgetState, type WidgetUiConfig, formatDate, getBaseUrl, getDaysRemaining, getResolvedTheme, isWithinDays, truncateText, useDebounce, useWidget, useWidgetStore };