@orderly.network/trading-leaderboard 2.2.0 → 2.3.0

package/dist/index.d.mts

@@ -1,15 +1,9 @@
 import * as react from 'react';
-import { FC, PropsWithChildren } from 'react';
+import { PropsWithChildren, FC, ReactNode } from 'react';
 import * as embla_carousel_react from 'embla-carousel-react';
-import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as _orderly_network_ui from '@orderly.network/ui';
 import { TableSort } from '@orderly.network/ui';
-
-type CampaignsWidgetProps = {
-    className?: string;
-    style?: React.CSSProperties;
-};
-declare const CampaignsWidget: FC<CampaignsWidgetProps>;
+import * as react_jsx_runtime from 'react/jsx-runtime';
 
 type Campaign = {
     title: string;
@@ -27,7 +21,7 @@ type Campaign = {
 /**
  * Trading leaderboard provider state
  */
-type TradingLeaderboardState = {
+type TradingLeaderboardState$1 = {
     /** campaigns config, if not provided, will not show campaigns section */
     campaigns?: Campaign[];
     /** background src, it can be a image resource or video resource */
@@ -37,13 +31,38 @@ type TradingLeaderboardState = {
         trading: string;
     };
 };
+type TradingLeaderboardProviderProps$1 = PropsWithChildren<TradingLeaderboardState$1>;
+
+type LeaderboardScriptReturn = ReturnType<typeof useLeaderboardScript>;
+type LeaderboardScriptOptions = {
+    backgroundSrc?: string;
+    campaigns?: Campaign[];
+};
+declare function useLeaderboardScript(options: LeaderboardScriptOptions): {
+    backgroundSrc: string | undefined;
+    isVideo: boolean;
+    showCampaigns: boolean;
+    isMobile: boolean;
+};
+
+type LeaderboardProps = {
+    style?: React.CSSProperties;
+    className?: string;
+} & LeaderboardScriptReturn;
+declare const Leaderboard: FC<LeaderboardProps>;
+
+type LeaderboardWidgetProps = TradingLeaderboardProviderProps$1 & Pick<LeaderboardProps, "style" | "className">;
 /**
- * Trading leaderboard context
+ * @deprecated use LeaderboardPage instead
+ * it will be removed in next version
  */
-declare const TradingLeaderboardContext: react.Context<TradingLeaderboardState>;
-type TradingLeaderboardProviderProps = PropsWithChildren<TradingLeaderboardState>;
-declare const TradingLeaderboardProvider: (props: TradingLeaderboardProviderProps) => react_jsx_runtime.JSX.Element;
-declare const useTradingLeaderboardContext: () => TradingLeaderboardState;
+declare const LeaderboardWidget: FC<LeaderboardWidgetProps>;
+
+type CampaignsWidgetProps = {
+    className?: string;
+    style?: React.CSSProperties;
+};
+declare const CampaignsWidget: FC<CampaignsWidgetProps>;
 
 type CampaignsScriptReturn = ReturnType<typeof useCampaignsScript>;
 type CategorizedCampaigns = {
@@ -108,17 +127,17 @@ type TradingData = {
     key?: string;
 };
 type TradingListScriptReturn = ReturnType<typeof useTradingListScript>;
-declare const FilterDays: readonly [7, 14, 30, 90];
-type TFilterDays = (typeof FilterDays)[number];
-type DateRange = {
+declare const FilterDays$1: readonly [7, 14, 30, 90];
+type TFilterDays$1 = (typeof FilterDays$1)[number];
+type DateRange$1 = {
     from?: Date;
     to?: Date;
 };
 declare function useTradingListScript(): {
     pagination: _orderly_network_ui.PaginationMeta;
-    dateRange: DateRange;
+    dateRange: DateRange$1;
     filterDay: 30 | 7 | 14 | 90 | null;
-    updateFilterDay: (day: TFilterDays) => void;
+    updateFilterDay: (day: TFilterDays$1) => void;
     filterItems: any;
     onFilter: (filter: {
         name: string;
@@ -135,7 +154,6 @@ declare function useTradingListScript(): {
     sentinelRef: react.MutableRefObject<HTMLDivElement | null>;
     dataList: TradingData[];
     address: string | undefined;
-    canTrade: boolean | "" | undefined;
 };
 
 type TradingListProps = {
@@ -145,27 +163,266 @@ type TradingListProps = {
 declare const TradingList: FC<TradingListProps>;
 
 type TradingListWidgetProps = Pick<TradingListProps, "style" | "className">;
+/**
+ * @deprecated use TradingListPage instead
+ * it will be removed in next version
+ */
 declare const TradingListWidget: FC<TradingListWidgetProps>;
 
-type LeaderboardScriptReturn = ReturnType<typeof useLeaderboardScript>;
-type LeaderboardScriptOptions = {
+declare enum CampaignTagEnum {
+    ONGOING = "ongoing",
+    COMING = "coming",
+    ENDED = "ended",
+    EXCLUSIVE = "exclusive"
+}
+interface CampaignStatistics {
+    total_participants?: number;
+    total_volume?: number;
+}
+interface PrizePoolTier {
+    position?: number;
+    position_range?: [number, number];
+    amount: number;
+}
+interface PrizePool {
+    pool_id: string;
+    label: string;
+    total_prize: number;
+    currency: string;
+    metric: "volume" | "pnl";
+    tiers: PrizePoolTier[];
+}
+interface TicketTierRule {
+    value: number;
+    tickets: number;
+}
+interface TicketLinearRule {
+    every: number;
+    tickets: number;
+}
+interface TicketRules {
+    total_prize: number;
+    currency: string;
+    metric: "volume" | "pnl";
+    mode: "tiered" | "linear";
+    tiers?: TicketTierRule[];
+    linear?: TicketLinearRule;
+}
+interface CampaignConfig {
+    campaign_id: number | string;
+    title: string;
+    description: string;
+    start_time: string;
+    end_time: string;
+    reward_distribution_time?: string;
+    volume_scope?: string | string[];
+    referral_codes?: string[] | string;
+    prize_pools?: PrizePool[];
+    ticket_rules?: TicketRules;
+    image?: string;
+    rule_url?: string;
+    trading_url?: string;
+    href?: string;
+}
+interface UserData {
+    rank?: number | string;
+    pnl: number;
+    total_participants?: number;
+    volume: number;
+    referral_code?: string;
+}
+type CampaignStatsDetailsResponse = {
+    broker_id: string;
+    user_count: number;
+    volume: number;
+    symbol: string;
+}[];
+
+/**
+ * Trading leaderboard provider state
+ */
+type TradingLeaderboardState = {
+    /** campaigns config, if not provided, will not show campaigns section */
+    campaigns?: CampaignConfig[];
+    /** background src, it can be a image resource or video resource */
     backgroundSrc?: string;
-    campaigns?: Campaign[];
+    href?: {
+        /** default trading now button url */
+        trading: string;
+    };
+    currentCampaignId: string;
+    currentCampaign?: CampaignConfig;
+    onCampaignChange: (campaignId: string) => void;
+    /** leaderboard user data, it will be used to calculate the rewards */
+    userData?: UserData;
+    /** set leaderboard user data */
+    setUserData?: (userdata: UserData) => void;
+    /** campaign ranking list updated time */
+    updatedTime?: number;
+    /** set snapshot time */
+    setUpdatedTime?: (updatedTime?: number) => void;
 };
-declare function useLeaderboardScript(options: LeaderboardScriptOptions): {
-    backgroundSrc: string | undefined;
-    isVideo: boolean;
-    showCampaigns: boolean;
+/**
+ * Trading leaderboard context
+ */
+declare const TradingLeaderboardContext: react.Context<TradingLeaderboardState>;
+type TradingLeaderboardProviderProps = PropsWithChildren<Pick<TradingLeaderboardState, "campaigns" | "href" | "backgroundSrc">> & {
+    campaignId?: string | number;
+    onCampaignChange?: (campaignId: string | number) => void;
+};
+declare const TradingLeaderboardProvider: (props: TradingLeaderboardProviderProps) => react_jsx_runtime.JSX.Element;
+declare const useTradingLeaderboardContext: () => TradingLeaderboardState;
+
+type CampaignRankingData = {
+    broker_id: string;
+    account_id: string;
+    address: string;
+    volume: number;
+    pnl: number;
+    total_deposit_amount: number;
+    total_withdrawal_amount: number;
+    start_account_value: number;
+    end_account_value: number;
+    key?: string;
+    rank?: number | string;
+    rewards?: {
+        amount: number;
+        currency: string;
+    };
+};
+type CampaignRankingScriptOptions = {
+    campaignId: number | string;
+    sortKey?: "volume" | "pnl";
+};
+declare function useCampaignRankingScript(options: CampaignRankingScriptOptions): {
+    pagination: _orderly_network_ui.PaginationMeta;
+    initialSort: TableSort;
+    dataSource: any[];
+    isLoading: boolean;
     isMobile: boolean;
+    sentinelRef: react.MutableRefObject<HTMLDivElement | null>;
+    dataList: any[];
+    address: string | undefined;
 };
 
-type LeaderboardProps = {
+type DateRange = {
+    from?: Date;
+    to?: Date;
+};
+declare enum LeaderboardTab {
+    Volume = "volume",
+    Pnl = "pnl"
+}
+
+type GeneralRankingData = {
+    account_id: string;
+    address: string;
+    broker_fee: number;
+    date: string;
+    perp_maker_volume: number;
+    perp_taker_volume: number;
+    perp_volume: number;
+    realized_pnl: number;
+    total_fee: number;
+    key?: string;
+    rank?: number | string;
+    volume?: number;
+    pnl?: number;
+};
+type GeneralRankingScriptReturn = ReturnType<typeof useGeneralRankingScript>;
+type GeneralRankingScriptOptions = {
+    dateRange?: DateRange;
+    address?: string;
+    sortKey?: "perp_volume" | "realized_pnl";
+};
+declare function useGeneralRankingScript(options?: GeneralRankingScriptOptions): {
+    pagination: _orderly_network_ui.PaginationMeta;
+    initialSort: TableSort;
+    onSort: (sort?: TableSort) => void;
+    dataSource: any[];
+    isLoading: boolean;
+    isMobile: boolean;
+    sentinelRef: react.MutableRefObject<HTMLDivElement | null>;
+    dataList: any[];
+    address: string | undefined;
+};
+
+type RankingColumnFields = "rank" | "address" | "volume" | "pnl" | "rewards";
+
+type RankingData = GeneralRankingData | CampaignRankingData;
+type RankingProps = {
     style?: React.CSSProperties;
     className?: string;
-} & LeaderboardScriptReturn;
-declare const Leaderboard: FC<LeaderboardProps>;
+    fields: RankingColumnFields[];
+} & Omit<GeneralRankingScriptReturn, "dataList" | "dataSource"> & {
+    dataList: RankingData[];
+    dataSource: RankingData[];
+};
+declare const Ranking: FC<RankingProps>;
 
-type LeaderboardWidgetProps = TradingLeaderboardProviderProps & Pick<LeaderboardProps, "style" | "className">;
-declare const LeaderboardWidget: FC<LeaderboardWidgetProps>;
+type GeneralRankingWidgetProps = Pick<RankingProps, "style" | "className" | "fields"> & GeneralRankingScriptOptions;
+declare const GeneralRankingWidget: FC<GeneralRankingWidgetProps>;
+
+type CampaignRankingWidgetProps = Pick<RankingProps, "style" | "className" | "fields"> & CampaignRankingScriptOptions;
+declare const CampaignRankingWidget: FC<CampaignRankingWidgetProps>;
+
+type GeneralLeaderboardScriptReturn = ReturnType<typeof useGeneralLeaderboardScript>;
+declare const FilterDays: readonly [7, 14, 30, 90];
+type TFilterDays = (typeof FilterDays)[number];
+declare function useGeneralLeaderboardScript(): {
+    activeTab: LeaderboardTab;
+    onTabChange: react.Dispatch<react.SetStateAction<LeaderboardTab>>;
+    searchValue: string;
+    onSearchValueChange: (value: string) => void;
+    clearSearchValue: () => void;
+    filterItems: any;
+    onFilter: (filter: {
+        name: string;
+        value: any;
+    }) => void;
+    dateRange: DateRange;
+    filterDay: 30 | 7 | 14 | 90 | null;
+    updateFilterDay: (day: TFilterDays) => void;
+};
+
+type GeneralLeaderboardProps = {
+    style?: React.CSSProperties;
+    className?: string;
+} & GeneralLeaderboardScriptReturn;
+declare const GeneralLeaderboard: FC<GeneralLeaderboardProps>;
+
+type GeneralLeaderboardWidgetProps = Pick<GeneralLeaderboardProps, "style" | "className">;
+declare const GeneralLeaderboardWidget: FC<GeneralLeaderboardWidgetProps>;
+
+type CampaignLeaderboardScriptReturn = ReturnType<typeof useCampaignLeaderboardScript>;
+declare function useCampaignLeaderboardScript(): {
+    activeTab: LeaderboardTab;
+    onTabChange: react.Dispatch<react.SetStateAction<LeaderboardTab>>;
+};
+
+type CampaignLeaderboardProps = {
+    style?: React.CSSProperties;
+    className?: string;
+    campaignId: number | string;
+} & CampaignLeaderboardScriptReturn;
+declare const CampaignLeaderboard: FC<CampaignLeaderboardProps>;
+
+type CampaignLeaderboardWidgetProps = Pick<CampaignLeaderboardProps, "style" | "className" | "campaignId">;
+declare const CampaignLeaderboardWidget: FC<CampaignLeaderboardWidgetProps>;
+
+type LeaderboardPageProps = GeneralLeaderboardWidgetProps & TradingLeaderboardProviderProps & {
+    style?: React.CSSProperties;
+    className?: string;
+};
+declare const LeaderboardPage: FC<LeaderboardPageProps>;
+type LeaderboardSectionProps = {
+    style?: React.CSSProperties;
+    className?: string;
+};
+declare const LeaderboardSection: FC<LeaderboardSectionProps>;
+declare const LeaderboardTitle: (props: {
+    title: ReactNode;
+    isMobile?: boolean;
+}) => react_jsx_runtime.JSX.Element;
 
-export { type Campaign, Campaigns, type CampaignsProps, CampaignsWidget, Leaderboard, type LeaderboardProps, LeaderboardWidget, type LeaderboardWidgetProps, TradingLeaderboardContext, TradingLeaderboardProvider, type TradingLeaderboardProviderProps, type TradingLeaderboardState, TradingList, type TradingListProps, TradingListWidget, type TradingListWidgetProps, useCampaignsScript, useLeaderboardScript, useTradingLeaderboardContext, useTradingListScript };
+export { type Campaign, type CampaignConfig, CampaignLeaderboard, type CampaignLeaderboardProps, CampaignLeaderboardWidget, type CampaignLeaderboardWidgetProps, CampaignRankingWidget, type CampaignRankingWidgetProps, type CampaignStatistics, type CampaignStatsDetailsResponse, CampaignTagEnum, Campaigns, type CampaignsProps, CampaignsWidget, GeneralLeaderboard, type GeneralLeaderboardProps, GeneralLeaderboardWidget, type GeneralLeaderboardWidgetProps, GeneralRankingWidget, type GeneralRankingWidgetProps, Leaderboard, LeaderboardPage, type LeaderboardPageProps, type LeaderboardProps, LeaderboardSection, LeaderboardTitle, LeaderboardWidget, type LeaderboardWidgetProps, type PrizePool, type PrizePoolTier, Ranking, type RankingProps, type TicketLinearRule, type TicketRules, type TicketTierRule, TradingLeaderboardContext, TradingLeaderboardProvider, type TradingLeaderboardProviderProps, type TradingLeaderboardState, TradingList, type TradingListProps, TradingListWidget, type TradingListWidgetProps, type UserData, useCampaignLeaderboardScript, useCampaignRankingScript, useCampaignsScript, useGeneralLeaderboardScript, useGeneralRankingScript, useLeaderboardScript, useTradingLeaderboardContext, useTradingListScript };