@seayoo-web/gamer-api 2.2.2 → 2.3.1

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.
Files changed (64) hide show
  1. package/dist/index.js +736 -664
  2. package/package.json +6 -6
  3. package/types/src/club.d.ts +21 -21
  4. package/types/src/community.d.ts +20 -20
  5. package/types/src/event.config/feature.lottery.d.ts +1 -1
  6. package/types/src/event.config/reward.d.ts +1 -1
  7. package/types/src/event.d.ts +19 -19
  8. package/types/src/event.engage/index.d.ts +2 -2
  9. package/types/src/weixin.d.ts +4 -4
  10. package/types/index.d.ts +0 -5
  11. package/types/src/club.define.d.ts +0 -371
  12. package/types/src/club.enums.d.ts +0 -104
  13. package/types/src/club.guards.d.ts +0 -33
  14. package/types/src/community.define.d.ts +0 -331
  15. package/types/src/community.enums.d.ts +0 -99
  16. package/types/src/community.guards.d.ts +0 -52
  17. package/types/src/event.config/feature.base.d.ts +0 -23
  18. package/types/src/event.config/feature.cashback.d.ts +0 -18
  19. package/types/src/event.config/feature.checkIn.d.ts +0 -7
  20. package/types/src/event.config/feature.claimActivationKey.d.ts +0 -7
  21. package/types/src/event.config/feature.claimRewards.d.ts +0 -7
  22. package/types/src/event.config/feature.comment.d.ts +0 -14
  23. package/types/src/event.config/feature.d.ts +0 -40
  24. package/types/src/event.config/feature.follow.d.ts +0 -24
  25. package/types/src/event.config/feature.giftcode.d.ts +0 -24
  26. package/types/src/event.config/feature.invite.d.ts +0 -12
  27. package/types/src/event.config/feature.invitedRegister.d.ts +0 -7
  28. package/types/src/event.config/feature.lotteryDraw.d.ts +0 -14
  29. package/types/src/event.config/feature.preregister.d.ts +0 -7
  30. package/types/src/event.config/feature.quest.d.ts +0 -31
  31. package/types/src/event.config/feature.register.d.ts +0 -7
  32. package/types/src/event.config/feature.share.d.ts +0 -16
  33. package/types/src/event.config/feature.subscribe.d.ts +0 -12
  34. package/types/src/event.config/feature.survey.d.ts +0 -14
  35. package/types/src/event.config/feature.team.d.ts +0 -14
  36. package/types/src/event.config/feature.vote.d.ts +0 -44
  37. package/types/src/event.config/index.d.ts +0 -23
  38. package/types/src/event.config.d.ts +0 -228
  39. package/types/src/event.define.d.ts +0 -48
  40. package/types/src/event.engage/engage.cashback.d.ts +0 -9
  41. package/types/src/event.engage/engage.claimActivationKey.d.ts +0 -5
  42. package/types/src/event.engage/engage.comment.d.ts +0 -22
  43. package/types/src/event.engage/engage.d.ts +0 -49
  44. package/types/src/event.engage/engage.giftcode.d.ts +0 -5
  45. package/types/src/event.engage/engage.invite.d.ts +0 -9
  46. package/types/src/event.engage/engage.lottery.d.ts +0 -9
  47. package/types/src/event.engage/engage.lotteryDraw.d.ts +0 -40
  48. package/types/src/event.engage/engage.lotteryDraw.reward.d.ts +0 -38
  49. package/types/src/event.engage/engage.preregister.d.ts +0 -11
  50. package/types/src/event.engage/engage.quest.d.ts +0 -28
  51. package/types/src/event.engage/engage.share.d.ts +0 -9
  52. package/types/src/event.engage/engage.subscribe.d.ts +0 -14
  53. package/types/src/event.engage/engage.survey.d.ts +0 -7
  54. package/types/src/event.engage/engage.team.d.ts +0 -53
  55. package/types/src/event.engage/engage.vote.d.ts +0 -9
  56. package/types/src/event.engage/reward.d.ts +0 -52
  57. package/types/src/event.enums.d.ts +0 -392
  58. package/types/src/event.guards.d.ts +0 -38
  59. package/types/src/token.d.ts +0 -93
  60. package/types/src/token.define.d.ts +0 -31
  61. package/types/src/token.guards.d.ts +0 -5
  62. package/types/src/utils.d.ts +0 -12
  63. package/types/src/weixin.define.d.ts +0 -46
  64. package/types/src/weixin.guards.d.ts +0 -2
@@ -1,7 +0,0 @@
1
- import { type EventFeatureBaseConfig } from "./feature.base";
2
- declare const featureType: "invited_register";
3
- export type EventFeatureConfigOfInvitedRegister = EventFeatureBaseConfig & {
4
- feature_type: typeof featureType;
5
- };
6
- export declare const EventFeatureConfigOfInvitedRegisterValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfInvitedRegister, false, false>;
7
- export {};
@@ -1,14 +0,0 @@
1
- import { type EventFeatureBaseConfig } from "./feature.base";
2
- declare const featureType: "lottery_draw";
3
- export interface FeatureLotteryDrawConfig {
4
- /** 可开奖起始时间 */
5
- draw_not_before: number;
6
- /** 可开奖结束时间 */
7
- draw_not_after: number;
8
- }
9
- export type EventFeatureConfigOfLotteryDraw = EventFeatureBaseConfig & {
10
- feature_type: typeof featureType;
11
- config: FeatureLotteryDrawConfig;
12
- };
13
- export declare const EventFeatureConfigOfLotteryDrawValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfLotteryDraw, false, false>;
14
- export {};
@@ -1,7 +0,0 @@
1
- import { type EventFeatureBaseConfig } from "./feature.base";
2
- declare const featureType: "preregister";
3
- export type EventFeatureConfigOfPreregister = EventFeatureBaseConfig & {
4
- feature_type: typeof featureType;
5
- };
6
- export declare const EventFeatureConfigOfPreregisterValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfPreregister, false, false>;
7
- export {};
@@ -1,31 +0,0 @@
1
- import { type QuestObjective } from "../event.enums";
2
- import { type EventFeatureBaseConfig } from "./feature.base";
3
- declare const featureType: "quest";
4
- export interface FeatureQuestConfig {
5
- /** 任务目标 */
6
- objective: QuestObjective;
7
- /** 目标值 */
8
- completion_value: number;
9
- /** 团队任务配置 */
10
- team?: {
11
- /** 组队任务 ID */
12
- feature_id?: number;
13
- /** 目标值 */
14
- completion_value: number;
15
- };
16
- /** 任务专用配置,取决于任务目标类型 */
17
- config?: {
18
- /** 当任务目标为 community_posts 和 community_comments 有效,表示关联的社区话题,可能无值 */
19
- topic_id?: number;
20
- /** 参与对局的玩家数量,当任务目标为 player_match_counts 和 player_match_days 有效,不小于 1 */
21
- required_players?: number;
22
- /** 单日对局次数,当任务目标为 player_match_days 有效,不小于 1 */
23
- required_matches?: number;
24
- };
25
- }
26
- export type EventFeatureConfigOfQuest = EventFeatureBaseConfig & {
27
- feature_type: typeof featureType;
28
- config: FeatureQuestConfig;
29
- };
30
- export declare const EventFeatureConfigOfQuestValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfQuest, false, false>;
31
- export {};
@@ -1,7 +0,0 @@
1
- import { type EventFeatureBaseConfig } from "./feature.base";
2
- declare const featureType: "register";
3
- export type EventFeatureConfigOfRegister = EventFeatureBaseConfig & {
4
- feature_type: typeof featureType;
5
- };
6
- export declare const EventFeatureConfigOfRegisterValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfRegister, false, false>;
7
- export {};
@@ -1,16 +0,0 @@
1
- import { type EventFeatureBaseConfig } from "./feature.base";
2
- declare const featureType: "share";
3
- export interface FeatureShareConfig {
4
- /** 分享玩法配置分享平台 */
5
- share_platform: string;
6
- /** 分享玩法配置跳转地址 */
7
- jump_url?: string;
8
- /** 分享玩法分享平台图标 */
9
- icon_url?: string;
10
- }
11
- export type EventFeatureConfigOfShare = EventFeatureBaseConfig & {
12
- feature_type: typeof featureType;
13
- config: FeatureShareConfig;
14
- };
15
- export declare const EventFeatureConfigOfShareValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfShare, false, false>;
16
- export {};
@@ -1,12 +0,0 @@
1
- import { type EventFeatureBaseConfig } from "./feature.base";
2
- declare const featureType: "weixin_subscribe";
3
- export interface FeatureSubscribeConfig {
4
- /** 一组微信订阅消息模版 ID */
5
- weixin_template_ids: string[];
6
- }
7
- export type EventFeatureConfigOfSubscribe = EventFeatureBaseConfig & {
8
- feature_type: typeof featureType;
9
- config: FeatureSubscribeConfig;
10
- };
11
- export declare const EventFeatureConfigOfSubscribeValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfSubscribe, false, false>;
12
- export {};
@@ -1,14 +0,0 @@
1
- import { type EventFeatureBaseConfig } from "./feature.base";
2
- declare const featureType: "survey";
3
- export interface FeatureSurveyConfig {
4
- /** 问卷 ID */
5
- survey_id: string;
6
- /** 问卷 url 地址 */
7
- survey_url: string;
8
- }
9
- export type EventFeatureConfigOfSurvey = EventFeatureBaseConfig & {
10
- feature_type: typeof featureType;
11
- config: FeatureSurveyConfig;
12
- };
13
- export declare const EventFeatureConfigOfSurveyValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfSurvey, false, false>;
14
- export {};
@@ -1,14 +0,0 @@
1
- import { type EventFeatureBaseConfig } from "./feature.base";
2
- declare const featureType: "team";
3
- export interface FeatureTeamConfig {
4
- /** 队伍最大成员数 */
5
- max_members: number;
6
- /** 队伍最小成员数 */
7
- min_members: number;
8
- }
9
- export type EventFeatureConfigOfTeam = EventFeatureBaseConfig & {
10
- feature_type: typeof featureType;
11
- config: FeatureTeamConfig;
12
- };
13
- export declare const EventFeatureConfigOfTeamValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfTeam, false, false>;
14
- export {};
@@ -1,44 +0,0 @@
1
- import { type VoteOptionSource } from "../event.enums";
2
- import { type EventFeatureBaseConfig } from "./feature.base";
3
- import { type EventRewardItemConfig } from "./reward";
4
- declare const featureType: "vote";
5
- export interface FeatureVoteOption {
6
- /** 选项标识 */
7
- sn: string;
8
- /** 选项名称 */
9
- name: string;
10
- /** 选项图片地址 */
11
- img_urls?: string[];
12
- /** 选项视频地址 */
13
- video_urls?: string[];
14
- /** 选项描述文本 */
15
- descriptions?: string[];
16
- /** 跳转地址 */
17
- jump_url: string;
18
- /** 选项投票数量 */
19
- amount: number;
20
- /** 选项是否入围 */
21
- finalists: boolean;
22
- /** 最后投票时间秒级时间戳 */
23
- last_vote_time: number;
24
- }
25
- export interface FeatureVoteConfig {
26
- /** 关联一个或多个投票玩法 ID */
27
- vote_feature_ids: number[];
28
- /** 关联一个或多个投稿玩法 ID */
29
- submission_feature_ids: number[];
30
- /** 入围数量 */
31
- finalists_amount: number;
32
- /** 选项来源 */
33
- source: VoteOptionSource;
34
- /** 投票选项配置 */
35
- options: FeatureVoteOption[];
36
- /** 投票入围后用户可获得的奖励 */
37
- rewards: EventRewardItemConfig[];
38
- }
39
- export type EventFeatureConfigOfVote = EventFeatureBaseConfig & {
40
- feature_type: typeof featureType;
41
- config: FeatureVoteConfig;
42
- };
43
- export declare const EventFeatureConfigOfVoteValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfVote, false, false>;
44
- export {};
@@ -1,23 +0,0 @@
1
- import { type EventFeatureConfig } from "./feature";
2
- export * from "./feature";
3
- export * from "./reward";
4
- export interface EventConfig {
5
- /** 活动名称 */
6
- event_name: string;
7
- /** 面向玩家的富文本活动规则 */
8
- rules: string;
9
- /** 活动开始时间 */
10
- since: number;
11
- /** 活动结束时间 */
12
- until: number;
13
- /** 活动访问人数 */
14
- visit_count?: number;
15
- /** 活动下玩法列表 */
16
- features: EventFeatureConfig[];
17
- }
18
- export declare const EventConfigValidator: import("@seayoo-web/utils").ObjectValidator<EventConfig, false, false> & {
19
- plain: never;
20
- optional: never;
21
- maybeNull: never;
22
- lock: never;
23
- };
@@ -1,228 +0,0 @@
1
- import { type GamerItemType, EngageAccountType, EventPeriodType, FeatureType, QuestObjective, VoteOptionSource } from "./event.enums";
2
- export interface EventConfig {
3
- /** 活动名称 */
4
- event_name: string;
5
- /** 面向玩家的富文本活动规则 */
6
- rules: string;
7
- /** 活动开始时间 */
8
- since: number;
9
- /** 活动结束时间 */
10
- until: number;
11
- /** 活动访问人数 */
12
- visit_count?: number;
13
- /** 活动下玩法列表 */
14
- features: EventFeatureConfig[];
15
- }
16
- export declare function isEventConfig(data: unknown): data is EventConfig;
17
- export type EventFeatureConfig = EventFeatureBaseConfig<FeatureType.Preregister, NoopFeatureConfig> | EventFeatureBaseConfig<FeatureType.Lottery, FeatureLotteryConfig> | EventFeatureBaseConfig<FeatureType.Survey, FeatureSurveyConfig> | EventFeatureBaseConfig<FeatureType.Invite, FeatureInviteConfig> | EventFeatureBaseConfig<FeatureType.Share, FeatureShareConfig> | EventFeatureBaseConfig<FeatureType.Follow, FeatureFollowConfig> | EventFeatureBaseConfig<FeatureType.Subscribe, FeatureSubscribeConfig> | EventFeatureBaseConfig<FeatureType.Comment, FeatureCommentConfig> | EventFeatureBaseConfig<FeatureType.Vote, FeatureVoteConfig> | EventFeatureBaseConfig<FeatureType.Cashback, FeatureCashbackConfig> | EventFeatureBaseConfig<FeatureType.GiftCode, FeatureGiftCodeConfig> | EventFeatureBaseConfig<FeatureType.Register, NoopFeatureConfig> | EventFeatureBaseConfig<FeatureType.InvitedRegister, NoopFeatureConfig> | EventFeatureBaseConfig<FeatureType.ClaimRewards, NoopFeatureConfig> | EventFeatureBaseConfig<FeatureType.Quest, FeatureQuestConfig> | EventFeatureBaseConfig<FeatureType.Team, FeatureTeamConfig> | EventFeatureBaseConfig<FeatureType.LotteryDraw, FeatureLotteryDrawConfig> | EventFeatureBaseConfig<FeatureType.CheckIn, NoopFeatureConfig>;
18
- export interface EventRewardItemConfig {
19
- /** 玩法奖励道具 id */
20
- reward_item_id: number;
21
- /** 玩法奖励道具数量 */
22
- reward_amount: number;
23
- /** 玩法奖励道具名称 */
24
- reward_item_name: string;
25
- /** 玩法奖励道具图片地址 */
26
- reward_item_icon_url: string;
27
- /** 玩法奖励道具描述 */
28
- reward_item_desc?: string;
29
- /** 玩法奖励道具类型 */
30
- reward_item_type: Exclude<GamerItemType, GamerItemType.GiftCode | GamerItemType.LotteryTicket>;
31
- /** 奖励道具评级,用于前端展示 */
32
- reward_item_rating: number;
33
- }
34
- export interface RegularReward {
35
- engage_count: number;
36
- rewards: EventRewardItemConfig[];
37
- }
38
- export type FeatureReward = {
39
- feature_reward_type: "every";
40
- reward_details: EventRewardItemConfig[];
41
- } | {
42
- feature_reward_type: "regular";
43
- reward_details: RegularReward[];
44
- };
45
- export type NoopFeatureConfig = {} | null;
46
- export interface EventFeatureBaseConfig<T extends FeatureType = FeatureType, C extends object | null = object> {
47
- /** 玩法名称 */
48
- feature_name: string;
49
- /** 玩法 Id */
50
- feature_id: number;
51
- /** 玩法描述 */
52
- description: string;
53
- /** 玩法类型 */
54
- feature_type: T;
55
- /** 玩法配置 */
56
- config?: C;
57
- /** 玩法周期,即每多长时间可参与一次 */
58
- cycle: EventPeriodType;
59
- /** 允许的最大参与次数 */
60
- limit: number;
61
- /** 玩法开始时间 */
62
- since: number;
63
- /** 玩法结束时间 */
64
- until: number;
65
- /** 参与玩法维度账号类型 */
66
- engage_account: EngageAccountType;
67
- /** 玩法参与奖励 */
68
- feature_rewards?: FeatureReward;
69
- }
70
- export interface FeatureLotteryItemConfig {
71
- /** 抽奖奖励道具 id */
72
- reward_item_id: number;
73
- /** 抽奖奖励道具名称 */
74
- reward_item_name: string;
75
- /** 抽奖奖励道具类型 */
76
- reward_item_type: Exclude<GamerItemType, GamerItemType.GiftCode | GamerItemType.LotteryTicket>;
77
- /** 抽奖奖励道具图片地址 */
78
- reward_item_icon_url: string;
79
- /** 抽奖奖励道具描述 */
80
- reward_item_desc?: string;
81
- /** 抽奖奖励道具数量 */
82
- reward_amount: number;
83
- /** 抽奖奖励道具库存 */
84
- reward_remaining_stock: number;
85
- }
86
- export interface FeatureLotteryConfig {
87
- /** 抽奖消耗道具 id */
88
- consume_item_id: number;
89
- /** 抽奖消耗道具名称 */
90
- consume_item_name: number;
91
- /** 抽奖消耗道具图片地址 */
92
- consume_item_icon_url: string;
93
- /** 抽奖消耗道具数量配置 */
94
- consume_item_count: number;
95
- /** 抽奖消耗道具描述 */
96
- consume_item_desc?: string;
97
- /** 抽奖配置奖励列表 */
98
- rewards: FeatureLotteryItemConfig[];
99
- }
100
- export interface FeatureSurveyConfig {
101
- /** 问卷 ID */
102
- survey_id: string;
103
- /** 问卷 url 地址 */
104
- survey_url: string;
105
- }
106
- export interface FeatureInviteConfig {
107
- /** 邀请玩法配置分享链接 */
108
- share_url: string;
109
- }
110
- export interface FeatureShareConfig {
111
- /** 分享玩法配置分享平台 */
112
- share_platform: string;
113
- /** 分享玩法配置跳转地址 */
114
- jump_url?: string;
115
- /** 分享玩法分享平台图标 */
116
- icon_url?: string;
117
- }
118
- export interface FeatureFollowConfig {
119
- /**
120
- * 社交媒体平台的标识
121
- *
122
- * 比如 "bilibili", "douyin", "xiaohongshu", "weibo", "weixin_official_account", "qq"
123
- */
124
- platform: string;
125
- /** 社交媒体平台 icon */
126
- platform_icon?: string;
127
- /** 跳转链接 */
128
- link?: string;
129
- /** 二维码链接地址 */
130
- qr_code_url?: string;
131
- /** 社交媒体平台描述 */
132
- platform_desc?: string;
133
- }
134
- export interface FeatureSubscribeConfig {
135
- /** 一组微信订阅消息模版 ID */
136
- weixin_template_ids: string[];
137
- }
138
- export interface FeatureCommentConfig {
139
- /** 活动配置的弹幕信息,用于快捷选择 */
140
- comments: string[];
141
- /** 发送频率限制,单位:秒 */
142
- send_rate: number;
143
- }
144
- export interface FeatureVoteConfig {
145
- /** 关联一个或多个投票玩法 ID */
146
- vote_feature_ids: number[];
147
- /** 关联一个或多个投稿玩法 ID */
148
- submission_feature_ids: number[];
149
- /** 入围数量 */
150
- finalists_amount: number;
151
- /** 选项来源 */
152
- source: VoteOptionSource;
153
- /** 投票选项配置 */
154
- options: FeatureVoteOption[];
155
- /** 投票入围后用户可获得的奖励 */
156
- rewards: EventRewardItemConfig[];
157
- }
158
- export interface FeatureVoteOption {
159
- /** 选项标识 */
160
- sn: string;
161
- /** 选项名称 */
162
- name: string;
163
- /** 选项图片地址 */
164
- img_urls?: string[];
165
- /** 选项视频地址 */
166
- video_urls?: string[];
167
- /** 选项描述文本 */
168
- descriptions?: string[];
169
- /** 跳转地址 */
170
- jump_url: string;
171
- /** 选项投票数量 */
172
- amount: number;
173
- /** 选项是否入围 */
174
- finalists: boolean;
175
- /** 最后投票时间秒级时间戳 */
176
- last_vote_time: number;
177
- }
178
- export interface FeatureCashbackConfig {
179
- /** 计算充值总额的开始时间 */
180
- order_start_time: number;
181
- /** 计算充值总额的结束时间 */
182
- order_end_time: number;
183
- /** 可领取充值返还奖励的开始时间 */
184
- claim_rewards_start_time: number;
185
- /** 可领取充值返还奖励的结束时间 */
186
- claim_rewards_end_time: number;
187
- }
188
- export interface FeatureGiftCodeConfig {
189
- /** 用于前端显示礼包码兑换后会获得的奖励内容 */
190
- gift_items: EventGiftItemConfig[];
191
- /** 社媒平台链接 */
192
- mp_url?: string;
193
- /** 社媒平台二维码 */
194
- mp_qrcode_url?: string;
195
- }
196
- export interface EventGiftItemConfig {
197
- /** 用于前端展示的游戏道具名称 */
198
- name: string;
199
- /** 用于前端展示的游戏道具图片地址 */
200
- icon_url: string;
201
- /** 用于前端展示的游戏道具数量 */
202
- count: number;
203
- }
204
- export interface FeatureQuestConfig {
205
- /** 任务目标 */
206
- objective: QuestObjective;
207
- /** 目标值 */
208
- completion_value: number;
209
- /** 团队任务配置 */
210
- team?: {
211
- /** 组队任务 ID */
212
- feature_id?: number;
213
- /** 目标值 */
214
- completion_value: number;
215
- };
216
- }
217
- export interface FeatureTeamConfig {
218
- /** 队伍最大成员数 */
219
- max_members: number;
220
- /** 队伍最小成员数 */
221
- min_members: number;
222
- }
223
- export interface FeatureLotteryDrawConfig {
224
- /** 可开奖起始时间 */
225
- draw_not_before: number;
226
- /** 可开奖结束时间 */
227
- draw_not_after: number;
228
- }
@@ -1,48 +0,0 @@
1
- import { type UserEngagementData, type EngageReward } from "./event.engage";
2
- import { type ClaimRewardStatus } from "./event.enums";
3
- export * from "./event.config";
4
- export * from "./event.engage";
5
- export interface VerifyMobileResult {
6
- /** 手机号是否允许登录此游戏(游戏 ID 由 Request Header 的 Origin 或 Referer 决定) */
7
- allowed: boolean;
8
- /** 手机号是否已注册世游通行证 */
9
- registered: boolean;
10
- }
11
- export declare const VerifyMobileResultValidator: import("@seayoo-web/utils").ObjectValidator<VerifyMobileResult, false, false>;
12
- export interface UserFeatureStatus {
13
- /** 玩法 ID */
14
- feature_id: number;
15
- /**
16
- * 是否可参与玩法。false 代表当前已不可再参与。
17
- *
18
- * 💡注意这里的语义是已经达到了参与次数的上限,不能再调用 engage,而不是没有资格参与。
19
- */
20
- can_engage: boolean;
21
- /** 是否有已获得但尚未领取的玩法参与奖励 */
22
- has_unclaimed_rewards: boolean;
23
- }
24
- export declare const UserFeatureStatusValidator: import("@seayoo-web/utils").ObjectValidator<UserFeatureStatus, false, false>;
25
- export interface EngageResponse {
26
- /** 当前参与记录 ID */
27
- engagement_id: number;
28
- /** 用户玩法参与记录 */
29
- engagement?: {
30
- engagement_id: number;
31
- sequence: number;
32
- feature_id: number;
33
- /** 附带的数据,由 feature_id 的类型决定 */
34
- data?: UserEngagementData;
35
- };
36
- /** 用户参与玩法得到的奖励 */
37
- rewards?: EngageReward[];
38
- /** 参与玩法后是否需要微信扫码 */
39
- scan?: boolean;
40
- }
41
- export declare const EngageResponseValidator: import("@seayoo-web/utils").ObjectValidator<EngageResponse, false, false>;
42
- export interface ClaimedItem {
43
- /** 用户奖励记录 id */
44
- reward_id: number;
45
- /** 领取后的奖励状态 */
46
- reward_status: ClaimRewardStatus;
47
- }
48
- export declare const ClaimedItemValidator: import("@seayoo-web/utils").ObjectValidator<ClaimedItem, false, false>;
@@ -1,9 +0,0 @@
1
- export interface CashbackEngagementData {
2
- /** 用户充值订单总金额(分) */
3
- order_total_amount: `${number}` | number;
4
- /** 充值返还的总金额(分) */
5
- cashback_total_amount: `${number}` | number;
6
- /** 充值返还的总金额所对应的游戏道具数量 */
7
- game_item_count: `${number}` | number;
8
- }
9
- export declare const CashbackEngagementDataValidator: import("@seayoo-web/utils").ObjectValidator<CashbackEngagementData, false, false>;
@@ -1,5 +0,0 @@
1
- export interface ClaimActivationKeyEngagementData {
2
- /** 激活码 */
3
- activation_key: string;
4
- }
5
- export declare const ClaimActivationKeyEngagementDataValidator: import("@seayoo-web/utils").ObjectValidator<ClaimActivationKeyEngagementData, false, false>;
@@ -1,22 +0,0 @@
1
- /** 评论玩法的参与记录 */
2
- export interface CommentEngagement {
3
- /** 用户世游通行证 ID */
4
- user_id: string;
5
- /** 用户昵称 */
6
- name: string;
7
- /** 用户头像地址 */
8
- avatar_url: string;
9
- /** 评论信息 */
10
- comment: string;
11
- /** 用户发布弹幕的视频点 */
12
- video_note: number;
13
- /** 用户发布弹幕的时间 */
14
- created_at: number;
15
- }
16
- export declare const CommentEngagementValidator: import("@seayoo-web/utils").ObjectValidator<CommentEngagement, false, false>;
17
- export interface CommentEngagementParam {
18
- /** 用户发送弹幕内容 */
19
- comment: string;
20
- /** 用户发布弹幕的视频点 */
21
- video_note?: number;
22
- }
@@ -1,49 +0,0 @@
1
- import { type CashbackEngagementData } from "./engage.cashback";
2
- import { type ClaimActivationKeyEngagementData } from "./engage.claimActivationKey";
3
- import { type GiftCodeEngagementData } from "./engage.giftcode";
4
- import { type InviteEngagementData } from "./engage.invite";
5
- import { type LotteryEngagementData } from "./engage.lottery";
6
- import { type LotteryDrawEngagementData } from "./engage.lotteryDraw";
7
- import { type PreregisterEngagementData } from "./engage.preregister";
8
- import { type QuestEngagementData } from "./engage.quest";
9
- import { type ShareEngagementData } from "./engage.share";
10
- import { type WeixinSubscribeEngagementData } from "./engage.subscribe";
11
- import { type SurveyEngagementData } from "./engage.survey";
12
- import { type TeamEngagementData } from "./engage.team";
13
- import { type VoteEngagementData } from "./engage.vote";
14
- export * from "./engage.cashback";
15
- export * from "./engage.comment";
16
- export * from "./engage.giftcode";
17
- export * from "./engage.invite";
18
- export * from "./engage.lottery";
19
- export * from "./engage.lotteryDraw";
20
- export * from "./engage.preregister";
21
- export * from "./engage.quest";
22
- export * from "./engage.share";
23
- export * from "./engage.subscribe";
24
- export * from "./engage.survey";
25
- export * from "./engage.team";
26
- export * from "./engage.vote";
27
- export * from "./engage.claimActivationKey";
28
- export type EmptyObject = Record<string | number | symbol, never>;
29
- export type UserEngagementData = PreregisterEngagementData | LotteryEngagementData | SurveyEngagementData | InviteEngagementData | ShareEngagementData | VoteEngagementData | WeixinSubscribeEngagementData | CashbackEngagementData | GiftCodeEngagementData | TeamEngagementData | QuestEngagementData | LotteryDrawEngagementData | ClaimActivationKeyEngagementData | EmptyObject;
30
- export declare const UserEngagementDataValidator: import("@seayoo-web/utils").UnionValidator<[import("@seayoo-web/utils").ObjectValidator<{
31
- platforms: string[];
32
- }, false, false>, import("@seayoo-web/utils").ObjectValidator<LotteryEngagementData, false, false>, import("@seayoo-web/utils").ObjectValidator<{
33
- serial_number: number;
34
- }, false, false>, import("@seayoo-web/utils").ObjectValidator<InviteEngagementData, false, false>, import("@seayoo-web/utils").ObjectValidator<ShareEngagementData, false, false>, import("@seayoo-web/utils").ObjectValidator<VoteEngagementData, false, false>, import("@seayoo-web/utils").ObjectValidator<WeixinSubscribeEngagementData, false, false>, import("@seayoo-web/utils").ObjectValidator<CashbackEngagementData, false, false>, import("@seayoo-web/utils").ObjectValidator<GiftCodeEngagementData, false, false>, import("@seayoo-web/utils").ObjectValidator<TeamEngagementData, false, false>, import("@seayoo-web/utils").ObjectValidator<QuestEngagementData, false, false>, import("@seayoo-web/utils").ObjectValidator<{
35
- tickets: ({
36
- ticket: /*elided*/ any;
37
- status: /*elided*/ any;
38
- } | {
39
- ticket: /*elided*/ any;
40
- status: /*elided*/ any;
41
- reward: /*elided*/ any;
42
- })[];
43
- }, false, false>, import("@seayoo-web/utils").ObjectValidator<ClaimActivationKeyEngagementData, false, false>, import("@seayoo-web/utils").CustomValidator<EmptyObject, false, false>], false, false> & {
44
- optional: never;
45
- maybeNull: never;
46
- key: never;
47
- satisfies: never;
48
- lock: never;
49
- };
@@ -1,5 +0,0 @@
1
- export interface GiftCodeEngagementData {
2
- /** 礼包码 */
3
- gift_code: string;
4
- }
5
- export declare const GiftCodeEngagementDataValidator: import("@seayoo-web/utils").ObjectValidator<GiftCodeEngagementData, false, false>;
@@ -1,9 +0,0 @@
1
- export interface InviteEngagementData {
2
- /** 被邀请人的世游通行证 ID */
3
- user_id: string;
4
- /** 被邀请人昵称 */
5
- name?: string;
6
- /** 被邀请人头像地址 */
7
- avatar_url?: string;
8
- }
9
- export declare const InviteEngagementDataValidator: import("@seayoo-web/utils").ObjectValidator<InviteEngagementData, false, false>;
@@ -1,9 +0,0 @@
1
- export interface LotteryEngagementData {
2
- /** 用户抽奖次数 */
3
- lottery_count: number;
4
- }
5
- export declare const LotteryEngagementDataValidator: import("@seayoo-web/utils").ObjectValidator<LotteryEngagementData, false, false>;
6
- export interface LotteryEngagementParam {
7
- /** 用户抽奖次数 */
8
- lottery_count: number;
9
- }
@@ -1,40 +0,0 @@
1
- import { type InferType } from "@seayoo-web/utils";
2
- import { LotteryTicketStatus, type LotteryDrawAction } from "../event.enums";
3
- import { type UserReward } from "./engage.lotteryDraw.reward";
4
- export * from "./engage.lotteryDraw.reward";
5
- declare const noRewardStatus: import("@seayoo-web/utils").StringValidator<"unknown" | "pending", false, false>;
6
- export type LotteryDrawTicket = {
7
- /** 抽奖券 */
8
- ticket: string;
9
- /** 抽奖券状态 */
10
- status: InferType<typeof noRewardStatus>;
11
- } | {
12
- /** 抽奖券 */
13
- ticket: string;
14
- /** 抽奖券状态 */
15
- status: Exclude<LotteryTicketStatus, InferType<typeof noRewardStatus>>;
16
- /** 抽奖券奖励物品,status = drawn 时 reward_id = 0 */
17
- reward: UserReward;
18
- };
19
- export interface LotteryDrawEngagementData {
20
- tickets: LotteryDrawTicket[];
21
- }
22
- export declare const LotteryDrawEngagementDataValidator: import("@seayoo-web/utils").ObjectValidator<{
23
- tickets: ({
24
- ticket: /*elided*/ any;
25
- status: /*elided*/ any;
26
- } | {
27
- ticket: /*elided*/ any;
28
- status: /*elided*/ any;
29
- reward: /*elided*/ any;
30
- })[];
31
- }, false, false>;
32
- export type LotteryDrawEngagementParam = {
33
- /** 参与抽奖券的动作类型 */
34
- action: Exclude<LotteryDrawAction, typeof LotteryDrawAction.Claim>;
35
- } | {
36
- /** 参与抽奖券的动作类型 */
37
- action: typeof LotteryDrawAction.Claim;
38
- /** 抽奖券 */
39
- ticket: string;
40
- };