@polyv/vote-sdk 2.0.0

package/index.es.d.ts

@@ -0,0 +1,267 @@
+import { EventEmitter } from '@polyv/utils/es/event';
+import { InteractionCore } from '@polyv/interaction-core';
+
+declare class InteractionBase {
+    /**
+     * @deprecated 兼容旧版具备 __iarCore 属性，后续将移除
+     */
+    public __iarCore: InteractionCore;
+
+    /**
+     * @deprecated 兼容旧版具备 iarCore 属性，后续将移除
+     */
+    public iarCore: InteractionCore;
+
+    constructor(public interactionCore: InteractionCore) {
+        this.__iarCore = interactionCore;
+        this.iarCore = interactionCore;
+    }
+}
+
+export declare class Vote extends InteractionBase {
+    static appName: string;
+    VoteEvent: typeof VoteEvent;
+    eventEmitter: EventEmitter<VoteEventRelations, VoteEvent>;
+    /** 当前已投票列表 */
+    private __curVotedList;
+    /** 当前在进行的投票活动 */
+    private __votingList;
+    /** 缓存的投票结果数据 */
+    private __cachedVoteResult;
+    constructor(interactionCore: InteractionCore);
+    /**
+     * 处理socket缓存
+     */
+    private __processSocketCache;
+    /**
+     * 处理初始化消息中的投票信息
+     */
+    private __onSliceID;
+    /**
+     * 处理投票开始事件
+     */
+    private __onVoteStart;
+    /**
+     * 处理投票结束事件
+     */
+    private __onVoteStop;
+    /**
+     * 处理投票结果事件
+     */
+    private __onVoteResult;
+    /**
+     * 处理清空投票事件
+     */
+    private __onVoteDeleteAll;
+    /**
+     * 处理删除投票事件
+     */
+    private __onVoteDelete;
+    /**
+     * 处理更改投票顺序事件
+     */
+    private __onVoteChangeOrder;
+    /**
+     * 给选项投票
+     * @param id 投票ID
+     * @returns {Promise<VoteResponse>} 投票结果
+     * @example
+     * ```ts
+     * const res = await voteTarget.toVote('voteId');
+     * console.log('投票结果', res);
+     * ```
+     */
+    toVote(id: string): Promise<VoteResponse>;
+    /**
+     * 获取已投票列表
+     * @returns {string[]} 已投票 id 列表
+     * @example
+     * ```ts
+     * const list = voteTarget.getVotedList();
+     * console.log('已投票列表', list);
+     * ```
+     */
+    getVotedList(): string[];
+    /**
+     * 新增已投票的id
+     * @param id 投票 id
+     * @returns {void} 无返回值
+     * @example
+     * ```ts
+     * voteTarget.pushVotedList('voteId');
+     * ```
+     */
+    pushVotedList(id: string): void;
+    /**
+     * 获取投票选项列表
+     * @returns {Promise<VoteListResponse | undefined>} 投票列表
+     * @example
+     * ```ts
+     * const data = await voteTarget.getVoteList();
+     * console.log('投票列表', data);
+     * ```
+     */
+    getVoteList(): Promise<VoteListResponse | undefined>;
+    /**
+     * 应用投票结果到投票列表
+     */
+    private __applyVoteResult;
+    /**
+     * 获取缓存的投票结果
+     * @returns {VoteResultSocketData['list'] | null} 缓存投票结果
+     * @example
+     * ```ts
+     * const result = voteTarget.getCachedVoteResult();
+     * console.log('缓存结果', result);
+     * ```
+     */
+    getCachedVoteResult(): VoteResultSocketData['list'] | null;
+    /**
+     * 获取当前投票列表
+     * @returns {Record<string, VoteListItem>} 当前投票列表
+     * @example
+     * ```ts
+     * const list = voteTarget.getVotingList();
+     * console.log('当前投票列表', list);
+     * ```
+     */
+    getVotingList(): Record<string, VoteListItem>;
+}
+
+/**
+ * 投票数据
+ */
+export declare interface VoteData extends VoteListItem {
+    coverUrl?: string;
+}
+
+export declare enum VoteEvent {
+    /**
+     * 更新已投票列表
+     */
+    UpdateVotedList = "UpdateVotedList",
+    /**
+     * 发起投票
+     */
+    Start = "Start",
+    /**
+     * 结束投票
+     */
+    Stop = "Stop",
+    /**
+     * 投票结果
+     */
+    VoteResult = "VoteResult",
+    /**
+     * 清空投票
+     */
+    DeleteAll = "DeleteAll",
+    /**
+     * 删除投票
+     */
+    Delete = "Delete",
+    /**
+     * 更改投票顺序
+     */
+    UpdateVoteOrder = "UpdateVoteOrder"
+}
+
+export declare type VoteEventRelations = {
+    [VoteEvent.UpdateVotedList]: {
+        /** 已投票列表 */
+        curVotedList: string[];
+    };
+    [VoteEvent.Start]: {
+        /** 投票数据 */
+        voteData: VoteData;
+    };
+    [VoteEvent.Stop]: {
+        /** 投票ID */
+        id: string;
+    };
+    [VoteEvent.VoteResult]: {
+        /** 投票人数 */
+        voteCount: number;
+        /** 投票结果列表 */
+        list: VoteResultItem[];
+    };
+    [VoteEvent.DeleteAll]: null;
+    [VoteEvent.Delete]: {
+        /** 投票ID */
+        id: string;
+    };
+    [VoteEvent.UpdateVoteOrder]: {
+        /** 投票ID */
+        id: string;
+        /** 旧顺序 */
+        oldOrder: number;
+        /** 新顺序 */
+        newOrder: number;
+    };
+};
+
+/**
+ * 投票列表项
+ */
+export declare interface VoteListItem {
+    /** 投票ID */
+    id: string;
+    /** 投票名称 */
+    name: string;
+    /** 选项状态，Y表示在投票中，N表示投票已结束 */
+    status?: 'Y' | 'N';
+    /** 是否展示票数 */
+    showVoteCount?: boolean;
+    /** 票数 */
+    voteCount?: number;
+    /** 图片 */
+    voteCoverImage?: string;
+    /** 顺序 */
+    voteOrder?: number;
+}
+
+/**
+ * 投票列表接口返回数据
+ */
+export declare interface VoteListResponse {
+    code: number;
+    data: {
+        list: VoteListItem[];
+    } | null;
+    message?: string;
+}
+
+/**
+ * 投票响应
+ */
+export declare interface VoteResponse {
+    code: number;
+    message?: string;
+}
+
+/**
+ * 每项投票的结果
+ */
+export declare interface VoteResultItem {
+    /** 投票ID */
+    id: string;
+    /** 投票名称 */
+    name: string;
+    /** 投票的数量 */
+    times: number;
+}
+
+/**
+ * 投票结果socket数据
+ */
+declare interface VoteResultSocketData {
+    EVENT: 'VOTE_RESULT';
+    voteCount: number;
+    list: Array<{
+        id: string;
+        name: string;
+        times: number;
+    }>;
+}
+
+export { }