@seayoo-web/gamer-api 2.11.1 → 2.12.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@seayoo-web/gamer-api",
   "description": "agent for gamer api",
-  "version": "2.11.1",
+  "version": "2.12.1",
   "type": "module",
   "source": "index.ts",
   "main": "./dist/index.js",
@@ -30,17 +30,17 @@
   "license": "MIT",
   "devDependencies": {
     "@types/node": "^22.13.1",
-    "@seayoo-web/scripts": "3.1.5",
+    "@seayoo-web/combo-webview": "2.8.0",
     "@seayoo-web/request": "3.4.0",
-    "@seayoo-web/combo-webview": "2.7.0",
+    "@seayoo-web/scripts": "3.1.5",
     "@seayoo-web/tsconfig": "1.0.5",
     "@seayoo-web/utils": "4.1.3",
     "@seayoo-web/validator": "1.1.1"
   },
   "peerDependencies": {
-    "@seayoo-web/validator": "^1.1.1",
-    "@seayoo-web/combo-webview": "^2.7.0",
-    "@seayoo-web/utils": "^4.1.3"
+    "@seayoo-web/utils": "^4.1.3",
+    "@seayoo-web/combo-webview": "^2.8.0",
+    "@seayoo-web/validator": "^1.1.1"
   },
   "scripts": {
     "prebuild": "pnpm -F validator build && pnpm -F request build && pnpm -F combo-webview build",

package/types/src/event.config/feature.d.ts

@@ -16,6 +16,7 @@ import type { EventFeatureConfigOfShare } from "./feature.share";
 import type { EventFeatureConfigOfSubscribe } from "./feature.subscribe";
 import type { EventFeatureConfigOfSurvey } from "./feature.survey";
 import type { EventFeatureConfigOfTeam } from "./feature.team";
+import type { EventFeatureConfigOfUgc } from "./feature.ugc";
 import type { EventFeatureConfigOfVote } from "./feature.vote";
 import type { EventFeatureConfigOfVote2 } from "./feature.vote2";
 import type { EventFeatureConfigOfZeroChatgpt } from "./feature.zeroChatgpt";
@@ -39,5 +40,6 @@ export * from "./feature.team";
 export * from "./feature.vote";
 export * from "./feature.vote2";
 export * from "./feature.claimActivationKey";
-export type EventFeatureConfig = EventFeatureConfigOfCashback | EventFeatureConfigOfCheckIn | EventFeatureConfigOfClaimRewards | EventFeatureConfigOfComment | EventFeatureConfigOfFollow | EventFeatureConfigOfGiftCode | EventFeatureConfigOfInvite | EventFeatureConfigOfInvitedRegister | EventFeatureConfigOfLottery | EventFeatureConfigOfLotteryDraw | EventFeatureConfigOfPreregister | EventFeatureConfigOfQuest | EventFeatureConfigOfRegister | EventFeatureConfigOfShare | EventFeatureConfigOfSubscribe | EventFeatureConfigOfSurvey | EventFeatureConfigOfTeam | EventFeatureConfigOfVote | EventFeatureConfigOfVote2 | EventFeatureConfigOfClaimActivationKey | EventFeatureConfigOfZeroChatgpt;
-export declare const EventFeatureConfigValidator: import("@seayoo-web/validator").UnionValidator<[import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfCashback, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfCheckIn, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfClaimRewards, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfComment, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfFollow, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfGiftCode, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfInvite, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfInvitedRegister, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfLottery, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfLotteryDraw, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfPreregister, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfQuest, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfRegister, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfShare, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfSubscribe, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfSurvey, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfTeam, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfVote, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfVote2, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfClaimActivationKey, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfZeroChatgpt, false, false>], false, false>;
+export * from "./feature.ugc";
+export type EventFeatureConfig = EventFeatureConfigOfCashback | EventFeatureConfigOfCheckIn | EventFeatureConfigOfClaimRewards | EventFeatureConfigOfComment | EventFeatureConfigOfFollow | EventFeatureConfigOfGiftCode | EventFeatureConfigOfInvite | EventFeatureConfigOfInvitedRegister | EventFeatureConfigOfLottery | EventFeatureConfigOfLotteryDraw | EventFeatureConfigOfPreregister | EventFeatureConfigOfQuest | EventFeatureConfigOfRegister | EventFeatureConfigOfShare | EventFeatureConfigOfSubscribe | EventFeatureConfigOfSurvey | EventFeatureConfigOfTeam | EventFeatureConfigOfVote | EventFeatureConfigOfVote2 | EventFeatureConfigOfClaimActivationKey | EventFeatureConfigOfZeroChatgpt | EventFeatureConfigOfUgc;
+export declare const EventFeatureConfigValidator: import("@seayoo-web/validator").UnionValidator<[import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfCashback, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfCheckIn, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfClaimRewards, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfComment, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfFollow, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfGiftCode, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfInvite, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfInvitedRegister, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfLottery, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfLotteryDraw, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfPreregister, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfQuest, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfRegister, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfShare, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfSubscribe, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfSurvey, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfTeam, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfVote, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfVote2, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfClaimActivationKey, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfZeroChatgpt, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfUgc, false, false>], false, false>;

package/types/src/event.config/feature.lottery.d.ts

@@ -1,6 +1,6 @@
 import type { EventFeatureBaseConfig } from "./feature.base";
 import type { InferType } from "@seayoo-web/validator";
-declare const rewardItemTypeValidator: import("@seayoo-web/validator").StringValidator<"credit" | "activation_key" | "event_item" | "game_item" | "physical_item" | "weixin_hongbao" | "external_gift_code" | "void_item", false, false>;
+declare const rewardItemTypeValidator: import("@seayoo-web/validator").StringValidator<"event_item" | "game_item" | "physical_item" | "weixin_hongbao" | "activation_key" | "credit" | "external_gift_code" | "void_item", false, false>;
 declare const featureType: "lottery";
 export interface FeatureLotteryItemConfig {
     /** 抽奖奖励道具 id */

package/types/src/event.config/feature.ugc.d.ts

@@ -0,0 +1,15 @@
+import type { EventFeatureBaseConfig } from "./feature.base";
+import type { EventRewardItemConfig } from "./reward";
+declare const featureType: "ugc";
+export interface FeatureUgcConfig {
+    /** 允许的社交媒体,未配置时表示不限制 */
+    allowed_social_medias?: string[];
+    /** 审核通过后发放的投稿通过奖励内容 */
+    acceptance_rewards?: EventRewardItemConfig[];
+}
+export type EventFeatureConfigOfUgc = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+    config: FeatureUgcConfig;
+};
+export declare const EventFeatureConfigOfUgcValidator: import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfUgc, false, false>;
+export {};

package/types/src/event.config/reward.d.ts

@@ -1,5 +1,5 @@
 import type { InferType } from "@seayoo-web/validator";
-declare const rewardItemTypeValidator: import("@seayoo-web/validator").StringValidator<"credit" | "activation_key" | "gift_code" | "event_item" | "game_item" | "physical_item" | "weixin_hongbao" | "lottery_ticket" | "external_gift_code" | "void_item", false, false>;
+declare const rewardItemTypeValidator: import("@seayoo-web/validator").StringValidator<"event_item" | "game_item" | "physical_item" | "weixin_hongbao" | "gift_code" | "activation_key" | "lottery_ticket" | "credit" | "external_gift_code" | "void_item", false, false>;
 export interface EventRewardItemConfig {
     /** 玩法奖励道具 id */
     reward_item_id: number;

package/types/src/event.config.d.ts

@@ -0,0 +1,228 @@
+import { type GamerItemType, EngageAccountType, EventPeriodType, FeatureType, QuestObjective, VoteOptionSource } from "./event.enums";
+export interface EventConfig {
+    /** 活动名称 */
+    event_name: string;
+    /** 面向玩家的富文本活动规则 */
+    rules: string;
+    /** 活动开始时间 */
+    since: number;
+    /** 活动结束时间 */
+    until: number;
+    /** 活动访问人数 */
+    visit_count?: number;
+    /** 活动下玩法列表 */
+    features: EventFeatureConfig[];
+}
+export declare function isEventConfig(data: unknown): data is EventConfig;
+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>;
+export interface EventRewardItemConfig {
+    /** 玩法奖励道具 id */
+    reward_item_id: number;
+    /** 玩法奖励道具数量 */
+    reward_amount: number;
+    /** 玩法奖励道具名称 */
+    reward_item_name: string;
+    /** 玩法奖励道具图片地址 */
+    reward_item_icon_url: string;
+    /** 玩法奖励道具描述 */
+    reward_item_desc?: string;
+    /** 玩法奖励道具类型  */
+    reward_item_type: Exclude<GamerItemType, GamerItemType.GiftCode | GamerItemType.LotteryTicket>;
+    /** 奖励道具评级，用于前端展示 */
+    reward_item_rating: number;
+}
+export interface RegularReward {
+    engage_count: number;
+    rewards: EventRewardItemConfig[];
+}
+export type FeatureReward = {
+    feature_reward_type: "every";
+    reward_details: EventRewardItemConfig[];
+} | {
+    feature_reward_type: "regular";
+    reward_details: RegularReward[];
+};
+export type NoopFeatureConfig = {} | null;
+export interface EventFeatureBaseConfig<T extends FeatureType = FeatureType, C extends object | null = object> {
+    /** 玩法名称 */
+    feature_name: string;
+    /** 玩法 Id */
+    feature_id: number;
+    /** 玩法描述 */
+    description: string;
+    /** 玩法类型 */
+    feature_type: T;
+    /** 玩法配置 */
+    config?: C;
+    /** 玩法周期，即每多长时间可参与一次 */
+    cycle: EventPeriodType;
+    /** 允许的最大参与次数 */
+    limit: number;
+    /** 玩法开始时间 */
+    since: number;
+    /** 玩法结束时间 */
+    until: number;
+    /** 参与玩法维度账号类型 */
+    engage_account: EngageAccountType;
+    /** 玩法参与奖励 */
+    feature_rewards?: FeatureReward;
+}
+export interface FeatureLotteryItemConfig {
+    /** 抽奖奖励道具 id */
+    reward_item_id: number;
+    /** 抽奖奖励道具名称 */
+    reward_item_name: string;
+    /** 抽奖奖励道具类型   */
+    reward_item_type: Exclude<GamerItemType, GamerItemType.GiftCode | GamerItemType.LotteryTicket>;
+    /** 抽奖奖励道具图片地址 */
+    reward_item_icon_url: string;
+    /** 抽奖奖励道具描述 */
+    reward_item_desc?: string;
+    /** 抽奖奖励道具数量 */
+    reward_amount: number;
+    /** 抽奖奖励道具库存 */
+    reward_remaining_stock: number;
+}
+export interface FeatureLotteryConfig {
+    /** 抽奖消耗道具 id */
+    consume_item_id: number;
+    /** 抽奖消耗道具名称 */
+    consume_item_name: number;
+    /** 抽奖消耗道具图片地址 */
+    consume_item_icon_url: string;
+    /** 抽奖消耗道具数量配置 */
+    consume_item_count: number;
+    /** 抽奖消耗道具描述 */
+    consume_item_desc?: string;
+    /** 抽奖配置奖励列表  */
+    rewards: FeatureLotteryItemConfig[];
+}
+export interface FeatureSurveyConfig {
+    /** 问卷 ID */
+    survey_id: string;
+    /** 问卷 url 地址 */
+    survey_url: string;
+}
+export interface FeatureInviteConfig {
+    /** 邀请玩法配置分享链接 */
+    share_url: string;
+}
+export interface FeatureShareConfig {
+    /** 分享玩法配置分享平台 */
+    share_platform: string;
+    /** 分享玩法配置跳转地址 */
+    jump_url?: string;
+    /** 分享玩法分享平台图标 */
+    icon_url?: string;
+}
+export interface FeatureFollowConfig {
+    /**
+     * 社交媒体平台的标识
+     *
+     * 比如 "bilibili", "douyin", "xiaohongshu", "weibo", "weixin_official_account", "qq"
+     */
+    platform: string;
+    /** 社交媒体平台 icon */
+    platform_icon?: string;
+    /** 跳转链接 */
+    link?: string;
+    /** 二维码链接地址 */
+    qr_code_url?: string;
+    /** 社交媒体平台描述 */
+    platform_desc?: string;
+}
+export interface FeatureSubscribeConfig {
+    /** 一组微信订阅消息模版 ID */
+    weixin_template_ids: string[];
+}
+export interface FeatureCommentConfig {
+    /** 活动配置的弹幕信息，用于快捷选择 */
+    comments: string[];
+    /** 发送频率限制，单位：秒 */
+    send_rate: number;
+}
+export interface FeatureVoteConfig {
+    /** 关联一个或多个投票玩法 ID */
+    vote_feature_ids: number[];
+    /** 关联一个或多个投稿玩法 ID */
+    submission_feature_ids: number[];
+    /** 入围数量 */
+    finalists_amount: number;
+    /** 选项来源 */
+    source: VoteOptionSource;
+    /** 投票选项配置 */
+    options: FeatureVoteOption[];
+    /** 投票入围后用户可获得的奖励 */
+    rewards: EventRewardItemConfig[];
+}
+export interface FeatureVoteOption {
+    /** 选项标识 */
+    sn: string;
+    /** 选项名称 */
+    name: string;
+    /** 选项图片地址 */
+    img_urls?: string[];
+    /** 选项视频地址 */
+    video_urls?: string[];
+    /** 选项描述文本 */
+    descriptions?: string[];
+    /** 跳转地址 */
+    jump_url: string;
+    /** 选项投票数量 */
+    amount: number;
+    /** 选项是否入围 */
+    finalists: boolean;
+    /** 最后投票时间秒级时间戳 */
+    last_vote_time: number;
+}
+export interface FeatureCashbackConfig {
+    /** 计算充值总额的开始时间 */
+    order_start_time: number;
+    /** 计算充值总额的结束时间 */
+    order_end_time: number;
+    /** 可领取充值返还奖励的开始时间 */
+    claim_rewards_start_time: number;
+    /** 可领取充值返还奖励的结束时间 */
+    claim_rewards_end_time: number;
+}
+export interface FeatureGiftCodeConfig {
+    /** 用于前端显示礼包码兑换后会获得的奖励内容 */
+    gift_items: EventGiftItemConfig[];
+    /** 社媒平台链接 */
+    mp_url?: string;
+    /** 社媒平台二维码 */
+    mp_qrcode_url?: string;
+}
+export interface EventGiftItemConfig {
+    /** 用于前端展示的游戏道具名称 */
+    name: string;
+    /** 用于前端展示的游戏道具图片地址 */
+    icon_url: string;
+    /** 用于前端展示的游戏道具数量 */
+    count: number;
+}
+export interface FeatureQuestConfig {
+    /** 任务目标 */
+    objective: QuestObjective;
+    /** 目标值 */
+    completion_value: number;
+    /** 团队任务配置 */
+    team?: {
+        /** 组队任务 ID */
+        feature_id?: number;
+        /** 目标值 */
+        completion_value: number;
+    };
+}
+export interface FeatureTeamConfig {
+    /** 队伍最大成员数 */
+    max_members: number;
+    /** 队伍最小成员数 */
+    min_members: number;
+}
+export interface FeatureLotteryDrawConfig {
+    /** 可开奖起始时间 */
+    draw_not_before: number;
+    /** 可开奖结束时间 */
+    draw_not_after: number;
+}

package/types/src/event.d.ts

@@ -313,11 +313,13 @@ export declare class EventApi {
         error: RequestInternalError | "invalid_token" | "feature_not_found";
     } | null>;
     /**
-     * 领取投票（vote2）玩法获得的奖励
+     * 产生投票（vote2）玩法获得的奖励，并非发放给用户；领取需要调用 claimRewardsV2
+     *
+     * path: event/vote2/rewards
      *
      * https://www.kdocs.cn/l/chlVWKom7DzU?linkname=fabGKteIEK
      */
-    claimVote2Rewards(featureId: number, requestOptions?: IRequestOptions): Promise<import("./event.engage").Vote2ClaimRewardsResponse | {
+    vote2Rewards(featureId: number, requestOptions?: IRequestOptions): Promise<import("./event.engage").Vote2ClaimRewardsResponse | {
         message: string;
         code: RequestInternalError | "vote_rewards_not_started" | "vote_rewards_already_ended" | "engagement_not_found";
     } | null>;
@@ -336,4 +338,43 @@ export declare class EventApi {
         message: string;
         error: RequestInternalError | "event_not_found" | "feature_not_found";
     } | null>;
+    /**
+     * 获取当前登录用户的投稿记录
+     *
+     * https://www.kdocs.cn/l/ckWFDcOsYEUA?linkname=biEwrNKhAF
+     */
+    getUgcRecord(option: {
+        feature_id: number;
+        /** 查询返回最大参与记录数 */
+        max_results: number;
+        /** 分页标识，不传默认首页查询 */
+        next_token?: string;
+    }, requestOptions?: IRequestOptions): Promise<import("./event.engage").UgcRecordResponse | {
+        message: string;
+        error: RequestInternalError | "event_not_found" | "feature_not_found";
+    } | null>;
+    /**
+     * 媒体资源预上传地址获取，为投稿玩法（UGC）提供 S3 预签名上传 URL，供用户客户端上传图片资源
+     *
+     * 仅允许上传 image/jpeg 和 image/png 格式的图片。
+     * 图片会按照 event_id / feature_id 维度分目录存储在S3 对象存储中。
+     * 投稿玩法不调用任何第三方（网易易盾等）进行内容安全检测。
+     *
+     * https://www.kdocs.cn/l/ckWFDcOsYEUA?linkname=xhGGpJEbol
+     */
+    ugcUploadImage(option: {
+        feature_id: number;
+        image_type: "png" | "jpg" | "jpeg";
+        /** 媒体文件大小 */
+        size: number;
+        /** 媒体文件内容的 SHA-256 哈希值 用于校验上传对象的完整性 */
+        sha256: string;
+    }, requestOptions?: IRequestOptions): Promise<{
+        existed: boolean;
+        upload_url: string | undefined;
+        image_url: string;
+    } | {
+        message: string;
+        code: RequestInternalError | "event_not_found" | "feature_not_found";
+    } | null>;
 }

package/types/src/event.engage/engage.d.ts

@@ -10,6 +10,7 @@ import type { ShareEngagementData } from "./engage.share";
 import type { WeixinSubscribeEngagementData } from "./engage.subscribe";
 import type { SurveyEngagementData } from "./engage.survey";
 import type { TeamEngagementData } from "./engage.team";
+import type { UgcEngagementData } from "./engage.ugc";
 import type { VoteEngagementData } from "./engage.vote";
 import type { Vote2EngagementData } from "./engage.vote2";
 import type { ZeroChatGPTData } from "./engage.zeroChatGPT";
@@ -28,8 +29,10 @@ export * from "./engage.team";
 export * from "./engage.vote";
 export * from "./engage.vote2";
 export * from "./engage.claimActivationKey";
+export * from "./engage.zeroChatGPT";
+export * from "./engage.ugc";
 export type EmptyObject = Record<string | number | symbol, never>;
-export type UserEngagementData = PreregisterEngagementData | LotteryEngagementData | SurveyEngagementData | InviteEngagementData | ShareEngagementData | VoteEngagementData | Vote2EngagementData | WeixinSubscribeEngagementData | CashbackEngagementData | GiftCodeEngagementData | TeamEngagementData | QuestEngagementData | LotteryDrawEngagementData | ClaimActivationKeyEngagementData | ZeroChatGPTData | EmptyObject;
+export type UserEngagementData = PreregisterEngagementData | LotteryEngagementData | SurveyEngagementData | InviteEngagementData | ShareEngagementData | VoteEngagementData | Vote2EngagementData | WeixinSubscribeEngagementData | CashbackEngagementData | GiftCodeEngagementData | TeamEngagementData | QuestEngagementData | LotteryDrawEngagementData | ClaimActivationKeyEngagementData | ZeroChatGPTData | UgcEngagementData | EmptyObject;
 export declare const UserEngagementDataValidator: import("@seayoo-web/validator").UnionValidator<[import("@seayoo-web/validator").ObjectValidator<{
     platforms: string[];
 }, false, false>, import("@seayoo-web/validator").ObjectValidator<LotteryEngagementData, false, false>, import("@seayoo-web/validator").ObjectValidator<{
@@ -48,7 +51,7 @@ export declare const UserEngagementDataValidator: import("@seayoo-web/validator"
         role: /*elided*/ any;
         content: /*elided*/ any;
     }[];
-}, false, false>, import("@seayoo-web/validator").CustomValidator<EmptyObject, false, false>], false, false> & {
+}, false, false>, import("@seayoo-web/validator").ObjectValidator<UgcEngagementData, false, false>, import("@seayoo-web/validator").CustomValidator<EmptyObject, false, false>], false, false> & {
     optional: never;
     maybeNull: never;
     key: never;

package/types/src/event.engage/engage.ugc.d.ts

@@ -0,0 +1,75 @@
+import { UgcReviewStatus } from "../event.enums";
+import type { UgcSocialMedia } from "../event.enums";
+export type UgcEngagementParam = {
+    /** 标题 */
+    title: string;
+    /** 正文 */
+    content?: string;
+    /** 图片 URL 列表 */
+    image_urls?: string[];
+    /** 媒体平台 */
+    social_media?: UgcSocialMedia;
+    /** 社交媒体上的链接地址 */
+    social_media_url?: string;
+};
+export interface UgcEngagementData {
+    /** 投稿记录 ID */
+    ugc_id: string;
+    /** 标题 */
+    title: string;
+    /** 描述 */
+    content?: string;
+    /** 图片 URL 列表 */
+    image_urls?: string[];
+    /** 媒体平台 */
+    social_media?: UgcSocialMedia;
+    /** 社交媒体上的链接地址 */
+    social_media_url?: string;
+}
+export declare const UgcEngagementDataValidator: import("@seayoo-web/validator").ObjectValidator<UgcEngagementData, false, false>;
+export interface UgcRecord {
+    /** 投稿记录 ID */
+    ugc_id: number;
+    /** 状态 */
+    review_status: UgcReviewStatus;
+    /** 标题 */
+    title: string;
+    /** 描述 */
+    content?: string;
+    /** 图片 URL 列表 */
+    image_urls?: string[];
+    /** 媒体平台 */
+    social_media?: UgcSocialMedia;
+    /** 社交媒体上的链接地址 */
+    social_media_url?: string;
+    /** 服务器 ID */
+    server_id?: number;
+    /** 服务器名称 */
+    server_name?: string;
+    /** 角色 ID */
+    role_id?: string;
+    /** 角色名称 */
+    role_name?: string;
+    /** 投稿记录获得的总赞数 */
+    total_likes?: number;
+}
+export interface UgcRecordResponse {
+    /** 稿件列表 */
+    ugcs: Array<UgcRecord>;
+    /** 分页标识，返回空表示后续没有数据了 */
+    next_token?: string;
+}
+export declare const UgcRecordResponseValidator: import("@seayoo-web/validator").ObjectValidator<UgcRecordResponse, false, false>;
+export interface UgcUploadImageResponse {
+    /** 图片是否已存在，已存在无需上传。 */
+    existed: boolean;
+    /** 图片的临时上传地址（有效期 5min）。 */
+    upload_url?: string;
+    /** 图片的访问地址。 */
+    image_url: string;
+}
+export declare const UgcUploadImageValidator: import("@seayoo-web/validator").ObjectValidator<{
+    existed: boolean;
+    upload_url: string | undefined;
+    image_url: string;
+}, false, false>;

package/types/src/event.engage/index.d.ts

@@ -1,4 +1,4 @@
-import type { UserEngagementData, CommentEngagementParam, PreregisterEngagementParam, LotteryEngagementParam, LotteryDrawEngagementParam, ShareEngagementParam, SubscribeEngagementParam, TeamEngagementParam, VoteEngagementParam, Vote2EngagementParam, Vote2EngagementError, LotteryEngagementError, ClaimActivationKeyEngagementError, LotteryDrawEngagementError, TeamEngagementError, GiftCodeEngagementError } from "./engage";
+import type { UserEngagementData, CommentEngagementParam, PreregisterEngagementParam, LotteryEngagementParam, LotteryDrawEngagementParam, ShareEngagementParam, SubscribeEngagementParam, TeamEngagementParam, VoteEngagementParam, Vote2EngagementParam, UgcEngagementParam, Vote2EngagementError, LotteryEngagementError, ClaimActivationKeyEngagementError, LotteryDrawEngagementError, TeamEngagementError, GiftCodeEngagementError } from "./engage";
 import type { Reward } from "./reward";
 import type { FeatureType } from "../event.enums";
 import type { ZeroChatGPTEngagementParam } from "./engage.zeroChatGPT";
@@ -32,12 +32,12 @@ export declare const UserEngagementValidator: import("@seayoo-web/validator").Ob
 /**
  * 部分玩法参与时需要提供的参数
  */
-export type EngagementParam = null | PreregisterEngagementParam | LotteryEngagementParam | CommentEngagementParam | ShareEngagementParam | VoteEngagementParam | Vote2EngagementParam | SubscribeEngagementParam | TeamEngagementParam | LotteryDrawEngagementParam | ZeroChatGPTEngagementParam;
+export type EngagementParam = null | PreregisterEngagementParam | LotteryEngagementParam | CommentEngagementParam | ShareEngagementParam | VoteEngagementParam | Vote2EngagementParam | SubscribeEngagementParam | TeamEngagementParam | LotteryDrawEngagementParam | ZeroChatGPTEngagementParam | UgcEngagementParam;
 export type EngagementFeatureType = FeatureType | unknown;
 /**
  * 根据玩法类型推导需要提交的参数数据类型
  */
-export type InferEngagementParam<T extends EngagementFeatureType> = [T] extends ["preregister"] ? PreregisterEngagementParam : [T] extends ["lottery"] ? LotteryEngagementParam : [T] extends ["comment"] ? CommentEngagementParam : [T] extends ["share"] ? ShareEngagementParam : [T] extends ["vote"] ? VoteEngagementParam : [T] extends ["vote2"] ? Vote2EngagementParam : [T] extends ["weixin_subscribe"] ? SubscribeEngagementParam : [T] extends ["team"] ? TeamEngagementParam : [T] extends ["lottery_draw"] ? LotteryDrawEngagementParam : [T] extends ["zero_chatgpt"] ? ZeroChatGPTEngagementParam : EngagementParam;
+export type InferEngagementParam<T extends EngagementFeatureType> = [T] extends ["preregister"] ? PreregisterEngagementParam : [T] extends ["lottery"] ? LotteryEngagementParam : [T] extends ["comment"] ? CommentEngagementParam : [T] extends ["share"] ? ShareEngagementParam : [T] extends ["vote"] ? VoteEngagementParam : [T] extends ["vote2"] ? Vote2EngagementParam : [T] extends ["weixin_subscribe"] ? SubscribeEngagementParam : [T] extends ["team"] ? TeamEngagementParam : [T] extends ["lottery_draw"] ? LotteryDrawEngagementParam : [T] extends ["zero_chatgpt"] ? ZeroChatGPTEngagementParam : [T] extends ["ugc"] ? UgcEngagementParam : EngagementParam;
 export type EngagementCommonError = "invalid_token" | "event_not_found" | "feature_not_found" | "visit_record_not_found" | "event_not_started" | "event_already_ended" | "engage_feature_reached_limit" | "invalid_merchant_parameter" | "budget_not_enough" | "combo_id_not_found";
 export type EngagementError = EngagementCommonError | TeamEngagementError | Vote2EngagementError | ClaimActivationKeyEngagementError | LotteryDrawEngagementError | LotteryEngagementError | GiftCodeEngagementError;
 /**

package/types/src/event.enums.d.ts

@@ -146,6 +146,8 @@ export declare const FeatureType: {
     readonly ClaimActivationKey: "claim_activation_key";
     /** 不朽箴言特有的 AI 聊天 */
     readonly ZeroChatgpt: "zero_chatgpt";
+    /** 投稿 */
+    readonly Ugc: "ugc";
 };
 export type FeatureType = ValueOf<typeof FeatureType>;
 export declare const FeatureTypeValidator: import("@seayoo-web/validator").StringValidator<FeatureType, false, false> & {
@@ -434,3 +436,42 @@ export declare const Vote2RewardTypeValidator: import("@seayoo-web/validator").S
     maybeNull: never;
     lock: never;
 };
+/** 投稿活动的社交媒体 */
+export declare const UgcSocialMedia: {
+    /** 抖音 */
+    readonly Douyin: "douyin";
+    /** 小红书 */
+    readonly Xiaohongshu: "xiaohongshu";
+    /** Tap Tap */
+    readonly Taptap: "taptap";
+    /** B站 */
+    readonly Bilibili: "bilibili";
+    /** 微博 */
+    readonly Weibo: "weibo";
+    /** 虎牙 */
+    readonly Huya: "huya";
+    /** 斗鱼 */
+    readonly Douyu: "douyu";
+};
+export type UgcSocialMedia = ValueOf<typeof UgcSocialMedia>;
+export declare const UgcSocialMediaValidator: import("@seayoo-web/validator").StringValidator<"douyin" | "xiaohongshu" | "taptap" | "bilibili" | "weibo" | "huya" | "douyu", true, false>;
+/** 投稿活动的稿件的审核状态 */
+export declare const UgcReviewStatus: {
+    /** 已提交 */
+    readonly Submitted: "submitted";
+    /** 已接收 */
+    readonly Accepted: "accepted";
+    /** 已拒绝 */
+    readonly Rejected: "rejected";
+};
+export type UgcReviewStatus = ValueOf<typeof UgcReviewStatus>;
+export declare const UgcReviewStatusValidator: import("@seayoo-web/validator").StringValidator<UgcReviewStatus, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};

package/types/src/event.guards.d.ts

@@ -48,3 +48,9 @@ export declare const isVote2LeaderboardResponse: (data: unknown) => data is {
     candidate_votes: import("./event.engage").CandidateVote[];
 };
 export declare const isCashbackQueryResponse: (data: unknown) => data is import("./event.engage").CashbackEngagementData;
+export declare const isUgcResponse: (data: unknown) => data is import("./event.engage").UgcRecordResponse;
+export declare const isUgcUploadImageResponse: (data: unknown) => data is {
+    existed: boolean;
+    upload_url: string | undefined;
+    image_url: string;
+};