@orderly.network/trading-leaderboard 2.8.10-alpha.0 → 2.8.11-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -1,175 +1,9 @@
1
1
  import * as react from 'react';
2
- import react__default, { FC, ReactNode } from 'react';
2
+ import react__default, { ReactNode, FC } from 'react';
3
3
  import * as _orderly_network_ui from '@orderly.network/ui';
4
4
  import { TableSort } from '@orderly.network/ui';
5
5
  import * as react_jsx_runtime from 'react/jsx-runtime';
6
6
 
7
- type Campaign = {
8
- title: string;
9
- description: string;
10
- image: string;
11
- startTime: Date | string;
12
- endTime: Date | string;
13
- href: string | {
14
- /** learn more url */
15
- learnMore: string;
16
- /** trading url, if provided, will override default trading now button url */
17
- trading: string;
18
- };
19
- };
20
- /**
21
- * Trading leaderboard provider state
22
- */
23
- type TradingLeaderboardState$1 = {
24
- /** campaigns config, if not provided, will not show campaigns section */
25
- campaigns?: Campaign[];
26
- /** background src, it can be a image resource or video resource */
27
- backgroundSrc?: string;
28
- href?: {
29
- /** default trading now button url */
30
- trading: string;
31
- };
32
- };
33
- type TradingLeaderboardProviderProps$1 = react__default.PropsWithChildren<TradingLeaderboardState$1>;
34
-
35
- type LeaderboardScriptReturn = ReturnType<typeof useLeaderboardScript>;
36
- type LeaderboardScriptOptions = {
37
- backgroundSrc?: string;
38
- campaigns?: Campaign[];
39
- };
40
- declare function useLeaderboardScript(options: LeaderboardScriptOptions): {
41
- backgroundSrc: string | undefined;
42
- isVideo: boolean;
43
- showCampaigns: boolean;
44
- isMobile: boolean;
45
- };
46
-
47
- type LeaderboardProps = {
48
- style?: React.CSSProperties;
49
- className?: string;
50
- } & LeaderboardScriptReturn;
51
- declare const Leaderboard: FC<LeaderboardProps>;
52
-
53
- type LeaderboardWidgetProps = TradingLeaderboardProviderProps$1 & Pick<LeaderboardProps, "style" | "className">;
54
- /**
55
- * @deprecated use LeaderboardPage instead
56
- * it will be removed in next version
57
- */
58
- declare const LeaderboardWidget: FC<LeaderboardWidgetProps>;
59
-
60
- type CampaignsWidgetProps = {
61
- className?: string;
62
- style?: React.CSSProperties;
63
- };
64
- declare const CampaignsWidget: FC<CampaignsWidgetProps>;
65
-
66
- type CampaignsScriptReturn = ReturnType<typeof useCampaignsScript>;
67
- type CategorizedCampaigns = {
68
- ongoing: Campaign[];
69
- past: Campaign[];
70
- future: Campaign[];
71
- };
72
- type CurrentCampaigns = Campaign & {
73
- displayTime: string;
74
- learnMoreUrl: string;
75
- tradingUrl: string;
76
- };
77
- type TEmblaApi = {
78
- scrollTo?: (index: number) => void;
79
- };
80
- type CategoryKey = keyof CategorizedCampaigns;
81
- declare function useCampaignsScript(): {
82
- options: {
83
- label: string;
84
- value: CategoryKey;
85
- }[];
86
- currentCampaigns: {
87
- displayTime: string;
88
- learnMoreUrl: string;
89
- tradingUrl: string;
90
- title: string;
91
- description: string;
92
- image: string;
93
- startTime: Date | string;
94
- endTime: Date | string;
95
- href: string | {
96
- learnMore: string;
97
- trading: string;
98
- };
99
- }[];
100
- category: keyof CategorizedCampaigns;
101
- onCategoryChange: (value: string) => void;
102
- tradingUrl: string | undefined;
103
- emblaRef: _orderly_network_ui.EmblaViewportRefType;
104
- emblaApi: TEmblaApi;
105
- scrollIndex: number;
106
- enableScroll: boolean;
107
- onLearnMore: (campaign: CurrentCampaigns) => void;
108
- onTradeNow: (campaign: CurrentCampaigns) => void;
109
- };
110
-
111
- type CampaignsProps = {
112
- className?: string;
113
- style?: React.CSSProperties;
114
- } & CampaignsScriptReturn;
115
- declare const Campaigns: FC<CampaignsProps>;
116
-
117
- type TradingData = {
118
- account_id: string;
119
- address: string;
120
- broker_fee: number;
121
- date: string;
122
- perp_maker_volume: number;
123
- perp_taker_volume: number;
124
- perp_volume: number;
125
- total_fee: number;
126
- key?: string;
127
- };
128
- type TradingListScriptReturn = ReturnType<typeof useTradingListScript>;
129
- declare const FilterDays$1: readonly [7, 14, 30, 90];
130
- type TFilterDays$1 = (typeof FilterDays$1)[number];
131
- type DateRange$1 = {
132
- from?: Date;
133
- to?: Date;
134
- };
135
- declare function useTradingListScript(): {
136
- pagination: _orderly_network_ui.PaginationMeta;
137
- dateRange: DateRange$1;
138
- filterDay: 30 | 7 | 14 | 90 | null;
139
- updateFilterDay: (day: TFilterDays$1) => void;
140
- filterItems: any;
141
- onFilter: (filter: {
142
- name: string;
143
- value: any;
144
- }) => void;
145
- initialSort: TableSort;
146
- onSort: (sort?: TableSort) => void;
147
- dataSource: TradingData[];
148
- isLoading: boolean;
149
- searchValue: string;
150
- onSearchValueChange: (value: string) => void;
151
- clearSearchValue: () => void;
152
- isMobile: boolean;
153
- sentinelRef: react.MutableRefObject<HTMLDivElement | null>;
154
- dataList: TradingData[];
155
- address: string | undefined;
156
- };
157
-
158
- type TradingListProps = {
159
- style?: React.CSSProperties;
160
- className?: string;
161
- } & TradingListScriptReturn;
162
- declare const TradingList: FC<TradingListProps>;
163
-
164
- type TradingListWidgetProps = Pick<TradingListProps, "style" | "className">;
165
- /**
166
- * @deprecated use TradingListPage instead
167
- * it will be removed in next version
168
- */
169
- declare const TradingListWidget: FC<TradingListWidgetProps>;
170
-
171
- type RankingColumnFields = "rank" | "address" | "volume" | "pnl" | "rewards";
172
-
173
7
  type ListStyle = "disc" | "decimal" | "none" | "circle" | "square" | "decimal-leading-zero" | "lower-alpha" | "upper-alpha" | "lower-roman" | "upper-roman";
174
8
  type DescriptionItem = {
175
9
  content: string;
@@ -257,9 +91,6 @@ interface CampaignConfig {
257
91
  format?: string;
258
92
  };
259
93
  href?: string;
260
- hide_arena?: boolean;
261
- hide_rewards?: boolean;
262
- hide_estimated_rewards?: boolean;
263
94
  highlight_pool_id?: string;
264
95
  user_account_label?: string;
265
96
  rule?: {
@@ -267,20 +98,6 @@ interface CampaignConfig {
267
98
  terms: DescriptionItem[];
268
99
  ruleConfig?: DescriptionConfig;
269
100
  };
270
- leaderboard_config?: LeaderboardConfig;
271
- emphasisConfig?: {
272
- subtitle: string;
273
- walletConnect: {
274
- title: string;
275
- description: string;
276
- };
277
- hideConnectWallet: boolean;
278
- };
279
- }
280
- interface LeaderboardConfig {
281
- use_general_leaderboard?: boolean;
282
- exclude_leaderboard_columns?: RankingColumnFields[];
283
- week_one_addresses?: string[];
284
101
  }
285
102
  interface UserData {
286
103
  rank?: number | string;
@@ -438,6 +255,8 @@ declare function useGeneralRankingScript(options?: GeneralRankingScriptOptions):
438
255
  address: string | undefined;
439
256
  };
440
257
 
258
+ type RankingColumnFields = "rank" | "address" | "volume" | "pnl" | "rewards";
259
+
441
260
  type RankingData = GeneralRankingData | CampaignRankingData;
442
261
  type RankingProps = {
443
262
  style?: React.CSSProperties;
@@ -448,7 +267,6 @@ type RankingProps = {
448
267
  dataSource: RankingData[];
449
268
  type?: "general" | "campaign";
450
269
  };
451
- declare const Ranking: FC<RankingProps>;
452
270
 
453
271
  type GeneralRankingWidgetProps = Pick<RankingProps, "style" | "className" | "fields"> & GeneralRankingScriptOptions;
454
272
  declare const GeneralRankingWidget: FC<GeneralRankingWidgetProps>;
@@ -508,7 +326,6 @@ type CampaignLeaderboardScriptReturn = ReturnType<typeof useCampaignLeaderboardS
508
326
  declare function useCampaignLeaderboardScript(): {
509
327
  activeTab: LeaderboardTab;
510
328
  onTabChange: react.Dispatch<react.SetStateAction<LeaderboardTab>>;
511
- excludeColumns: RankingColumnFields[];
512
329
  };
513
330
 
514
331
  type CampaignLeaderboardProps = {
@@ -553,4 +370,4 @@ type BackgroundProps = {
553
370
  };
554
371
  declare const LeaderboardBackground: FC<BackgroundProps>;
555
372
 
556
- export { type Campaign, type CampaignConfig, CampaignLeaderboard, type CampaignLeaderboardProps, CampaignLeaderboardWidget, type CampaignLeaderboardWidgetProps, CampaignRankingWidget, type CampaignRankingWidgetProps, type CampaignStatistics, type CampaignStatsDetailsResponse, type CampaignStatsResponse, CampaignTagEnum, Campaigns, CampaignsHeaderWidget, type CampaignsProps, CampaignsWidget, GeneralLeaderboard, type GeneralLeaderboardProps, GeneralLeaderboardWidget, type GeneralLeaderboardWidgetProps, GeneralRankingWidget, type GeneralRankingWidgetProps, Leaderboard, LeaderboardBackground, type LeaderboardConfig, 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 UserCampaignsResponse, type UserData, useCampaignLeaderboardScript, useCampaignRankingScript, useCampaignsScript, useGeneralLeaderboardScript, useGeneralRankingScript, useLeaderboardScript, useTradingLeaderboardContext, useTradingListScript };
373
+ export { type CampaignConfig, CampaignLeaderboard, type CampaignLeaderboardProps, CampaignLeaderboardWidget, type CampaignLeaderboardWidgetProps, CampaignRankingWidget, type CampaignRankingWidgetProps, type CampaignStatistics, type CampaignStatsDetailsResponse, type CampaignStatsResponse, CampaignTagEnum, CampaignsHeaderWidget, GeneralLeaderboard, type GeneralLeaderboardProps, GeneralLeaderboardWidget, type GeneralLeaderboardWidgetProps, GeneralRankingWidget, type GeneralRankingWidgetProps, LeaderboardBackground, LeaderboardPage, type LeaderboardPageProps, LeaderboardSection, LeaderboardTitle, type PrizePool, type PrizePoolTier, type TicketLinearRule, type TicketRules, type TicketTierRule, TradingLeaderboardContext, TradingLeaderboardProvider, type TradingLeaderboardProviderProps, type TradingLeaderboardState, type UserCampaignsResponse, type UserData, useCampaignLeaderboardScript, useCampaignRankingScript, useGeneralLeaderboardScript, useGeneralRankingScript, useTradingLeaderboardContext };
package/dist/index.d.ts CHANGED
@@ -1,175 +1,9 @@
1
1
  import * as react from 'react';
2
- import react__default, { FC, ReactNode } from 'react';
2
+ import react__default, { ReactNode, FC } from 'react';
3
3
  import * as _orderly_network_ui from '@orderly.network/ui';
4
4
  import { TableSort } from '@orderly.network/ui';
5
5
  import * as react_jsx_runtime from 'react/jsx-runtime';
6
6
 
7
- type Campaign = {
8
- title: string;
9
- description: string;
10
- image: string;
11
- startTime: Date | string;
12
- endTime: Date | string;
13
- href: string | {
14
- /** learn more url */
15
- learnMore: string;
16
- /** trading url, if provided, will override default trading now button url */
17
- trading: string;
18
- };
19
- };
20
- /**
21
- * Trading leaderboard provider state
22
- */
23
- type TradingLeaderboardState$1 = {
24
- /** campaigns config, if not provided, will not show campaigns section */
25
- campaigns?: Campaign[];
26
- /** background src, it can be a image resource or video resource */
27
- backgroundSrc?: string;
28
- href?: {
29
- /** default trading now button url */
30
- trading: string;
31
- };
32
- };
33
- type TradingLeaderboardProviderProps$1 = react__default.PropsWithChildren<TradingLeaderboardState$1>;
34
-
35
- type LeaderboardScriptReturn = ReturnType<typeof useLeaderboardScript>;
36
- type LeaderboardScriptOptions = {
37
- backgroundSrc?: string;
38
- campaigns?: Campaign[];
39
- };
40
- declare function useLeaderboardScript(options: LeaderboardScriptOptions): {
41
- backgroundSrc: string | undefined;
42
- isVideo: boolean;
43
- showCampaigns: boolean;
44
- isMobile: boolean;
45
- };
46
-
47
- type LeaderboardProps = {
48
- style?: React.CSSProperties;
49
- className?: string;
50
- } & LeaderboardScriptReturn;
51
- declare const Leaderboard: FC<LeaderboardProps>;
52
-
53
- type LeaderboardWidgetProps = TradingLeaderboardProviderProps$1 & Pick<LeaderboardProps, "style" | "className">;
54
- /**
55
- * @deprecated use LeaderboardPage instead
56
- * it will be removed in next version
57
- */
58
- declare const LeaderboardWidget: FC<LeaderboardWidgetProps>;
59
-
60
- type CampaignsWidgetProps = {
61
- className?: string;
62
- style?: React.CSSProperties;
63
- };
64
- declare const CampaignsWidget: FC<CampaignsWidgetProps>;
65
-
66
- type CampaignsScriptReturn = ReturnType<typeof useCampaignsScript>;
67
- type CategorizedCampaigns = {
68
- ongoing: Campaign[];
69
- past: Campaign[];
70
- future: Campaign[];
71
- };
72
- type CurrentCampaigns = Campaign & {
73
- displayTime: string;
74
- learnMoreUrl: string;
75
- tradingUrl: string;
76
- };
77
- type TEmblaApi = {
78
- scrollTo?: (index: number) => void;
79
- };
80
- type CategoryKey = keyof CategorizedCampaigns;
81
- declare function useCampaignsScript(): {
82
- options: {
83
- label: string;
84
- value: CategoryKey;
85
- }[];
86
- currentCampaigns: {
87
- displayTime: string;
88
- learnMoreUrl: string;
89
- tradingUrl: string;
90
- title: string;
91
- description: string;
92
- image: string;
93
- startTime: Date | string;
94
- endTime: Date | string;
95
- href: string | {
96
- learnMore: string;
97
- trading: string;
98
- };
99
- }[];
100
- category: keyof CategorizedCampaigns;
101
- onCategoryChange: (value: string) => void;
102
- tradingUrl: string | undefined;
103
- emblaRef: _orderly_network_ui.EmblaViewportRefType;
104
- emblaApi: TEmblaApi;
105
- scrollIndex: number;
106
- enableScroll: boolean;
107
- onLearnMore: (campaign: CurrentCampaigns) => void;
108
- onTradeNow: (campaign: CurrentCampaigns) => void;
109
- };
110
-
111
- type CampaignsProps = {
112
- className?: string;
113
- style?: React.CSSProperties;
114
- } & CampaignsScriptReturn;
115
- declare const Campaigns: FC<CampaignsProps>;
116
-
117
- type TradingData = {
118
- account_id: string;
119
- address: string;
120
- broker_fee: number;
121
- date: string;
122
- perp_maker_volume: number;
123
- perp_taker_volume: number;
124
- perp_volume: number;
125
- total_fee: number;
126
- key?: string;
127
- };
128
- type TradingListScriptReturn = ReturnType<typeof useTradingListScript>;
129
- declare const FilterDays$1: readonly [7, 14, 30, 90];
130
- type TFilterDays$1 = (typeof FilterDays$1)[number];
131
- type DateRange$1 = {
132
- from?: Date;
133
- to?: Date;
134
- };
135
- declare function useTradingListScript(): {
136
- pagination: _orderly_network_ui.PaginationMeta;
137
- dateRange: DateRange$1;
138
- filterDay: 30 | 7 | 14 | 90 | null;
139
- updateFilterDay: (day: TFilterDays$1) => void;
140
- filterItems: any;
141
- onFilter: (filter: {
142
- name: string;
143
- value: any;
144
- }) => void;
145
- initialSort: TableSort;
146
- onSort: (sort?: TableSort) => void;
147
- dataSource: TradingData[];
148
- isLoading: boolean;
149
- searchValue: string;
150
- onSearchValueChange: (value: string) => void;
151
- clearSearchValue: () => void;
152
- isMobile: boolean;
153
- sentinelRef: react.MutableRefObject<HTMLDivElement | null>;
154
- dataList: TradingData[];
155
- address: string | undefined;
156
- };
157
-
158
- type TradingListProps = {
159
- style?: React.CSSProperties;
160
- className?: string;
161
- } & TradingListScriptReturn;
162
- declare const TradingList: FC<TradingListProps>;
163
-
164
- type TradingListWidgetProps = Pick<TradingListProps, "style" | "className">;
165
- /**
166
- * @deprecated use TradingListPage instead
167
- * it will be removed in next version
168
- */
169
- declare const TradingListWidget: FC<TradingListWidgetProps>;
170
-
171
- type RankingColumnFields = "rank" | "address" | "volume" | "pnl" | "rewards";
172
-
173
7
  type ListStyle = "disc" | "decimal" | "none" | "circle" | "square" | "decimal-leading-zero" | "lower-alpha" | "upper-alpha" | "lower-roman" | "upper-roman";
174
8
  type DescriptionItem = {
175
9
  content: string;
@@ -257,9 +91,6 @@ interface CampaignConfig {
257
91
  format?: string;
258
92
  };
259
93
  href?: string;
260
- hide_arena?: boolean;
261
- hide_rewards?: boolean;
262
- hide_estimated_rewards?: boolean;
263
94
  highlight_pool_id?: string;
264
95
  user_account_label?: string;
265
96
  rule?: {
@@ -267,20 +98,6 @@ interface CampaignConfig {
267
98
  terms: DescriptionItem[];
268
99
  ruleConfig?: DescriptionConfig;
269
100
  };
270
- leaderboard_config?: LeaderboardConfig;
271
- emphasisConfig?: {
272
- subtitle: string;
273
- walletConnect: {
274
- title: string;
275
- description: string;
276
- };
277
- hideConnectWallet: boolean;
278
- };
279
- }
280
- interface LeaderboardConfig {
281
- use_general_leaderboard?: boolean;
282
- exclude_leaderboard_columns?: RankingColumnFields[];
283
- week_one_addresses?: string[];
284
101
  }
285
102
  interface UserData {
286
103
  rank?: number | string;
@@ -438,6 +255,8 @@ declare function useGeneralRankingScript(options?: GeneralRankingScriptOptions):
438
255
  address: string | undefined;
439
256
  };
440
257
 
258
+ type RankingColumnFields = "rank" | "address" | "volume" | "pnl" | "rewards";
259
+
441
260
  type RankingData = GeneralRankingData | CampaignRankingData;
442
261
  type RankingProps = {
443
262
  style?: React.CSSProperties;
@@ -448,7 +267,6 @@ type RankingProps = {
448
267
  dataSource: RankingData[];
449
268
  type?: "general" | "campaign";
450
269
  };
451
- declare const Ranking: FC<RankingProps>;
452
270
 
453
271
  type GeneralRankingWidgetProps = Pick<RankingProps, "style" | "className" | "fields"> & GeneralRankingScriptOptions;
454
272
  declare const GeneralRankingWidget: FC<GeneralRankingWidgetProps>;
@@ -508,7 +326,6 @@ type CampaignLeaderboardScriptReturn = ReturnType<typeof useCampaignLeaderboardS
508
326
  declare function useCampaignLeaderboardScript(): {
509
327
  activeTab: LeaderboardTab;
510
328
  onTabChange: react.Dispatch<react.SetStateAction<LeaderboardTab>>;
511
- excludeColumns: RankingColumnFields[];
512
329
  };
513
330
 
514
331
  type CampaignLeaderboardProps = {
@@ -553,4 +370,4 @@ type BackgroundProps = {
553
370
  };
554
371
  declare const LeaderboardBackground: FC<BackgroundProps>;
555
372
 
556
- export { type Campaign, type CampaignConfig, CampaignLeaderboard, type CampaignLeaderboardProps, CampaignLeaderboardWidget, type CampaignLeaderboardWidgetProps, CampaignRankingWidget, type CampaignRankingWidgetProps, type CampaignStatistics, type CampaignStatsDetailsResponse, type CampaignStatsResponse, CampaignTagEnum, Campaigns, CampaignsHeaderWidget, type CampaignsProps, CampaignsWidget, GeneralLeaderboard, type GeneralLeaderboardProps, GeneralLeaderboardWidget, type GeneralLeaderboardWidgetProps, GeneralRankingWidget, type GeneralRankingWidgetProps, Leaderboard, LeaderboardBackground, type LeaderboardConfig, 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 UserCampaignsResponse, type UserData, useCampaignLeaderboardScript, useCampaignRankingScript, useCampaignsScript, useGeneralLeaderboardScript, useGeneralRankingScript, useLeaderboardScript, useTradingLeaderboardContext, useTradingListScript };
373
+ export { type CampaignConfig, CampaignLeaderboard, type CampaignLeaderboardProps, CampaignLeaderboardWidget, type CampaignLeaderboardWidgetProps, CampaignRankingWidget, type CampaignRankingWidgetProps, type CampaignStatistics, type CampaignStatsDetailsResponse, type CampaignStatsResponse, CampaignTagEnum, CampaignsHeaderWidget, GeneralLeaderboard, type GeneralLeaderboardProps, GeneralLeaderboardWidget, type GeneralLeaderboardWidgetProps, GeneralRankingWidget, type GeneralRankingWidgetProps, LeaderboardBackground, LeaderboardPage, type LeaderboardPageProps, LeaderboardSection, LeaderboardTitle, type PrizePool, type PrizePoolTier, type TicketLinearRule, type TicketRules, type TicketTierRule, TradingLeaderboardContext, TradingLeaderboardProvider, type TradingLeaderboardProviderProps, type TradingLeaderboardState, type UserCampaignsResponse, type UserData, useCampaignLeaderboardScript, useCampaignRankingScript, useGeneralLeaderboardScript, useGeneralRankingScript, useTradingLeaderboardContext };