@vibexnpm/talkx 5.1.0 → 5.3.0

package/README.md

@@ -75,6 +75,7 @@ await client.connect(jwtToken, { enablePush: true });
 | [chat.md](docs/chat.md) | 채팅방 관리, 메시지 전송, 파일 업로드, 답글, 리액션, 핀, 타이핑, 채팅방 리스트 실시간 갱신, **AI 어시스턴트 페르소나 (멘션 응답)** |
 | [push.md](docs/push.md) | **웹 푸시 알림.** 권한 lifecycle, 활성화 패턴 (자동 vs 사용자 액션), 디바이스 토글, 알림 클릭 라우팅 |
 | [webrtc.md](docs/webrtc.md) | 1:1 / 그룹 통화, 미디어 제어, 디바이스 관리, TURN 서버 |
+| [vote.md](docs/vote.md) | **투표.** 생성(멱등키 필수) · 투표/재투표 · 결과 마스킹 · 이미지 선택지 · 채팅 카드 렌더링 |
 | [events.md](docs/events.md) | 모든 이벤트 레퍼런스. 채팅 이벤트 처리 패턴 (`eventType` 분기 vs 상태 필드 렌더) |
 | [errors.md](docs/errors.md) | 에러 분류 (`PushErrorReason`, `ErrorTypes`), HTTP 상태 코드, 입력 제약 |
 

package/dist/index.d.ts

@@ -753,6 +753,177 @@ export interface ChatMessage {
     decisionRequest?: DecisionRequest | null;
     /** 사용자의 선택. 어느 카드인지는 {@code replyTo} 가 특정한다. */
     decisionResponse?: DecisionResponse | null;
+    /**
+     * 투표 카드 — 투표가 열리거나 마감·취소됐음을 알리는 메시지의 payload.
+     *
+     * <p><b>모르면 그냥 텍스트로 그려라 — 그게 정상 동작이다.</b> {@code content} 에 같은 내용이
+     * 사람이 읽는 형태로 들어 있다. 반대로 카드를 그린다면 {@code content} 를 다시 그리지 마라.</p>
+     *
+     * <p>카드에는 집계가 없다. 결과는 {@code voteId} 로 {@link ChatClient.getVote} 를 호출해 받는다 —
+     * 마스킹이 호출자마다 다르게 계산되기 때문이다.</p>
+     */
+    voteCard?: VoteCard | null;
+}
+
+/**
+ * 투표 카드 payload — 이벤트 하나당 메시지 하나다(개설·마감·취소).
+ *
+ * <p>이미 발행된 카드는 고쳐지지 않는다. 투표가 삭제돼도 개설 카드는 그대로 남고 조회가 404 가 되며,
+ * 「취소됨」 표시는 화면 몫이다(별도의 취소 카드도 함께 발행된다).</p>
+ */
+export interface VoteCard {
+    voteId: string;
+    /**
+     * {@code 'OPENED'} | {@code 'CLOSED'} | {@code 'CANCELED'}.
+     *
+     * <p>🔴 <b>모르는 값이 올 수 있다</b> — 서버가 나중에 종류를 늘려도 구버전이 깨지지 않도록 열린 문자열이다.
+     * switch 의 default 는 텍스트 폴백으로 둔다.</p>
+     */
+    kind: 'OPENED' | 'CLOSED' | 'CANCELED' | (string & {});
+    /**
+     * 발행 시점의 질문 <b>스냅샷</b>. 참여자가 0명인 동안 투표가 수정될 수 있으므로 최신값이 필요하면
+     * {@link ChatClient.getVote} 로 조회한다. 마감·취소 카드에서는 비어 있을 수 있다.
+     */
+    question?: string | null;
+    /** 마감 예정 시각 (epoch millis, UTC). 마감·취소 카드에서는 null 일 수 있다. */
+    closeAt?: number | null;
+}
+
+// ── 투표 (createVote / getVotes / getVote / submitVote ...) ──
+
+/** 투표 등록 폼 — 생성과 수정이 같은 타입이다({@code PATCH} 지만 부분 수정이 아니다). */
+export interface VoteForm {
+    /** 최대 500자. 공백만이면 거절. */
+    question: string;
+    type: 'SINGLE' | 'MULTIPLE';
+    /** 양수. {@code SINGLE} 이면 1. */
+    maxSelections: number;
+    /** {@code 'IMAGE'} 라는 값은 없다. */
+    optionType: 'TEXT' | 'TEXT_WITH_IMAGE';
+    /** 마감 시각 (epoch millis). 과거·현재 불가 · 최대 30일 뒤. 무기한 투표는 없다. */
+    closeAt: number;
+    /** 2~10개. */
+    options: VoteFormOption[];
+}
+
+export interface VoteFormOption {
+    /** {@code .} {@code $} NUL 사용 불가 · 최대 100자 · 중복 불가 (집계 필드명으로 쓰인다). */
+    id: string;
+    /** 최대 200자. */
+    content: string;
+    /** 표시 순서. */
+    order: number;
+    /**
+     * {@link ChatClient.uploadVoteImage} 가 돌려준 값을 <b>가공 없이</b> 넣는다 — 서버가 문자열로 비교한다.
+     * 채팅 첨부 URL 은 쓸 수 없다. {@code optionType: 'TEXT'} 면 넣으면 안 되고, 빈 문자열도 거절된다.
+     */
+    imageUrl?: string | null;
+}
+
+/** 투표 단건 + 집계 — 생성 · 수정 · 단건조회 · 접수 응답. */
+export interface Vote {
+    voteId: string;
+    roomId: string;
+    question: string;
+    type: 'SINGLE' | 'MULTIPLE';
+    optionType: 'TEXT' | 'TEXT_WITH_IMAGE';
+    maxSelections: number;
+    /**
+     * {@code 'OPEN'} | {@code 'CLOSED'}.
+     *
+     * <p>🔴 <b>이 값만으로 마감을 판정하면 안 된다</b> — 서버 자동 마감이 미구현이라 {@code closeAt} 이
+     * 지났는데도 {@code 'OPEN'} 인 투표가 있고, 그건 마감된 것으로 동작한다. 둘을 함께 본다.</p>
+     */
+    status: 'OPEN' | 'CLOSED' | (string & {});
+    /** epoch millis. */
+    closeAt: number;
+    /** 마감 전이면 null. epoch millis. */
+    closedAt?: number | null;
+    creatorId: string;
+    createdAt: number;
+    updatedAt: number;
+    /**
+     * 결과 공개 여부. 공개 조건은 「내가 응답했다」 또는 「마감됐다」.
+     *
+     * <p>🔴 {@code false} 일 때의 {@code count}/{@code ratio} 0 은 「참여자가 없다」가 아니라
+     * <b>서버가 가린 값</b>이다. 「아직 0표」로 표시하면 거짓말이 된다.</p>
+     */
+    revealed: boolean;
+    /** 응답자 수. <b>득표 합이 아니다</b> — 복수 선택에서 값이 다르다. */
+    totalResponses: number;
+    /** 호출자가 고른 선택지. 없으면 빈 배열. 비공개 상태에서도 채워진다(재투표 화면용). */
+    myOptionIds: string[];
+    options: VoteOptionResult[];
+}
+
+export interface VoteOptionResult {
+    optionId: string;
+    content: string;
+    order: number;
+    /** {@code optionType} 이 {@code 'TEXT'} 면 항상 null. */
+    imageUrl?: string | null;
+    /** 득표 수. 비공개면 0(가려진 값). */
+    count: number;
+    /**
+     * 응답자 대비 %, 소수 첫째 자리.
+     *
+     * <p>분모가 <b>응답자 수</b>이지 총 선택 수가 아니다 — 복수 선택 투표에서는 합이 100을 넘는 것이
+     * 정상이고, 화면이 「복수 응답」임을 표기해야 한다.</p>
+     */
+    ratio: number;
+}
+
+/** {@link ChatClient.getVotes} 옵션. */
+export interface GetVotesOptions {
+    /** 이전 응답의 {@code nextCursor} 를 <b>그대로</b>. 불투명 문자열이라 파싱하지 않는다. */
+    cursor?: string;
+    /** 기본 20, 최대 100. 초과분은 서버가 조용히 100 으로 보정한다(에러 아님). */
+    limit?: number;
+}
+
+/** {@link ChatClient.getVotes} 반환. */
+export interface VoteList {
+    /** 최신순. 비면 끝이다. */
+    items: VoteListItem[];
+    /** null 이면 끝. 마지막 페이지가 정확히 {@code limit} 개면 채워진 채 오고, 그 커서로 부르면 빈 목록이 온다. */
+    nextCursor?: string | null;
+}
+
+/** 목록 항목 — {@code optionType} · {@code options} · {@code myOptionIds} · {@code revealed} 가 <b>없다</b>. */
+export interface VoteListItem {
+    voteId: string;
+    question: string;
+    type: 'SINGLE' | 'MULTIPLE';
+    status: 'OPEN' | 'CLOSED' | (string & {});
+    closeAt: number;
+    creatorId: string;
+    createdAt: number;
+    /** 참여자 수. 선택지별 집계는 목록에 없다 — 마스킹이 사용자마다 다르기 때문이다. */
+    responseCount: number;
+}
+
+/** {@link ChatClient.createVote} 옵션. */
+export interface CreateVoteOptions {
+    /**
+     * 🔴 <b>필수.</b> SDK 가 대신 만들지 않는다 — 만들면 그 값이 호출자에게 남지 않아 응답만 유실된
+     * 타임아웃에서 복구가 불가능하다(다음 호출이 새 키를 만들어 투표가 두 개 생긴다).
+     *
+     * <p>한 투표당 한 번 만들어 보관하고, 같은 시도의 재시도에는 <b>같은 값</b>을 넘긴다 —
+     * 그러면 서버가 기존 투표를 돌려준다(201, 같은 voteId).</p>
+     */
+    idempotencyKey: string;
+}
+
+/** {@link ChatClient.uploadVoteImage} 옵션. */
+export interface UploadVoteImageOptions {
+    onProgress?: (progress: { loaded: number; total: number; percent: number }) => void;
+    signal?: AbortSignal;
+}
+
+/** {@link ChatClient.uploadVoteImage} 반환. */
+export interface VoteImage {
+    /** 생성·수정 본문의 {@code options[].imageUrl} 에 <b>가공 없이</b> 넣는다. */
+    imageUrl: string;
 }
 
 /**
@@ -1089,6 +1260,29 @@ export interface AssistantRoomProgressEvent {
     textAvailable?: boolean;
 }
 
+/** {@link ChatClient.getAssistantProgress} 가 돌려주는 stream 1건. */
+export interface AssistantProgressStreamSnapshot {
+    streamId: string;
+    personaId: string | null;
+    phase: 'THINKING' | 'SEARCHING' | 'PLANNING' | 'WRITING' | null;
+    label: string | null;
+    text: string | null;
+    textAvailable: boolean;
+    /** 서버 스냅샷으로 복원된 진행분이면 true. */
+    resumed: boolean;
+}
+
+/**
+ * 방의 **현재** AI 진행 상태 (v5.3.0 — {@link ChatClient.getAssistantProgress} 반환).
+ *
+ * <p>{@link AssistantRoomProgressEvent} 와 같은 형태에 stream 단위 UI 를 위한 `streams` 가 더해진다.
+ * 이벤트는 transient 라 화면을 나갔다 들어오면 다시 오지 않는다 — 마운트 시 이걸 한 번 읽는다.</p>
+ */
+export interface AssistantProgressSnapshot extends AssistantRoomProgressEvent {
+    /** 살아 있는 stream 전체 (도착 순서). 없으면 빈 배열. */
+    streams: AssistantProgressStreamSnapshot[];
+}
+
 // ============================================================================
 // Options — constructor & method
 // ============================================================================
@@ -1721,6 +1915,24 @@ export class ChatClient implements SdkEventEmitter<ChatClientEvents> {
     refreshSummary(roomId: string, options?: RefreshSummaryOptions): Promise<RefreshSummaryResult>;
     /** Rolling 누적 요약 조회 — rollup + segment 페이지. 저장된 요약의 단일 진실 소스. */
     getSummary(roomId: string, options?: GetSummaryOptions): Promise<RoomSummaryView>;
+
+    // ── 투표 ──
+    /** 투표 생성. {@code idempotencyKey} 필수 — 재시도에 같은 값을 넘겨야 투표가 두 개 안 생긴다. */
+    createVote(roomId: string, vote: VoteForm, options: CreateVoteOptions): Promise<Vote>;
+    /** 방의 투표 목록(최신순). 집계는 없고 참여자 수만 있다. */
+    getVotes(roomId: string, options?: GetVotesOptions): Promise<VoteList>;
+    /** 투표 단건 + 집계. 마스킹이 호출자마다 다르므로 공유 캐시에 넣지 않는다. */
+    getVote(roomId: string, voteId: string): Promise<Vote>;
+    /** 투표 수정 — 폼 전체를 보낸다. 개설자 + 참여자 0명일 때만. */
+    updateVote(roomId: string, voteId: string, vote: VoteForm): Promise<Vote>;
+    /** 투표 삭제(204). 이미 발행된 카드는 남고 조회가 404 가 된다. */
+    deleteVote(roomId: string, voteId: string): Promise<void>;
+    /** 수동 마감(204). 결과를 보려면 {@link getVote} 를 다시 호출한다. */
+    closeVote(roomId: string, voteId: string): Promise<void>;
+    /** 투표 접수 · 재투표 — 같은 메서드. 응답에 갱신된 집계가 함께 온다. */
+    submitVote(roomId: string, voteId: string, optionIds: string[]): Promise<Vote>;
+    /** 선택지 이미지 업로드. 반환 {@code imageUrl} 을 가공 없이 폼에 넣는다. */
+    uploadVoteImage(roomId: string, file: File | Blob, options?: UploadVoteImageOptions): Promise<VoteImage>;
     /** 방 PM 프롬프트 레이어 조회 — PM_BACKSTAGE 방 전용, 참여자 전체. 미등록 시 404. */
     getRoomPmPrompt(roomId: string): Promise<PmPromptLayerResponse>;
     /** 방 PM 프롬프트 레이어 등록/수정 (upsert, 새 버전 자동 기록) — 방 주인(OWNER) 전용. content 1~2,000자. */
@@ -1828,6 +2040,17 @@ export class ChatClient implements SdkEventEmitter<ChatClientEvents> {
 
     startTyping(roomId: string): void;
     stopTyping(roomId: string): void;
+
+    /**
+     * 방의 현재 AI 진행 상태를 즉시 반환 (네트워크 호출 없음, v5.3.0).
+     * 진행 표시 이벤트는 transient 라 방 화면 마운트 시 이걸 읽어 버블을 복원한다.
+     */
+    getAssistantProgress(roomId: string): AssistantProgressSnapshot;
+    /**
+     * 구독 중인 모든 방의 진행 스트림 스냅샷을 서버에서 다시 받는다 (v5.1.0).
+     * 재연결·탭 복귀 때 SDK 가 자동 호출하므로 보통은 직접 부를 일이 없다.
+     */
+    resumeAssistantStreams(reason?: string): Promise<void>;
 }
 
 export class WebRTCClient implements SdkEventEmitter<WebRTCClientEvents> {
@@ -2089,6 +2312,24 @@ export default class TalkFlowClient implements SdkEventEmitter<TalkFlowClientEve
     refreshSummary(roomId: string, options?: RefreshSummaryOptions): Promise<RefreshSummaryResult>;
     /** Rolling 누적 요약 조회 — rollup + segment 페이지. 저장된 요약의 단일 진실 소스. */
     getSummary(roomId: string, options?: GetSummaryOptions): Promise<RoomSummaryView>;
+
+    // ── 투표 ──
+    /** 투표 생성. {@code idempotencyKey} 필수 — 재시도에 같은 값을 넘겨야 투표가 두 개 안 생긴다. */
+    createVote(roomId: string, vote: VoteForm, options: CreateVoteOptions): Promise<Vote>;
+    /** 방의 투표 목록(최신순). 집계는 없고 참여자 수만 있다. */
+    getVotes(roomId: string, options?: GetVotesOptions): Promise<VoteList>;
+    /** 투표 단건 + 집계. 마스킹이 호출자마다 다르므로 공유 캐시에 넣지 않는다. */
+    getVote(roomId: string, voteId: string): Promise<Vote>;
+    /** 투표 수정 — 폼 전체를 보낸다. 개설자 + 참여자 0명일 때만. */
+    updateVote(roomId: string, voteId: string, vote: VoteForm): Promise<Vote>;
+    /** 투표 삭제(204). 이미 발행된 카드는 남고 조회가 404 가 된다. */
+    deleteVote(roomId: string, voteId: string): Promise<void>;
+    /** 수동 마감(204). 결과를 보려면 {@link getVote} 를 다시 호출한다. */
+    closeVote(roomId: string, voteId: string): Promise<void>;
+    /** 투표 접수 · 재투표 — 같은 메서드. 응답에 갱신된 집계가 함께 온다. */
+    submitVote(roomId: string, voteId: string, optionIds: string[]): Promise<Vote>;
+    /** 선택지 이미지 업로드. 반환 {@code imageUrl} 을 가공 없이 폼에 넣는다. */
+    uploadVoteImage(roomId: string, file: File | Blob, options?: UploadVoteImageOptions): Promise<VoteImage>;
     /** 방 PM 프롬프트 레이어 조회 — PM_BACKSTAGE 방 전용, 참여자 전체. 미등록 시 404. */
     getRoomPmPrompt(roomId: string): Promise<PmPromptLayerResponse>;
     /** 방 PM 프롬프트 레이어 등록/수정 (upsert, 새 버전 자동 기록) — 방 주인(OWNER) 전용. content 1~2,000자. */
@@ -2193,6 +2434,17 @@ export default class TalkFlowClient implements SdkEventEmitter<TalkFlowClientEve
     startTyping(roomId: string): void;
     stopTyping(roomId: string): void;
 
+    /**
+     * 방의 현재 AI 진행 상태를 즉시 반환 (네트워크 호출 없음, v5.3.0).
+     * 진행 표시 이벤트는 transient 라 방 화면 마운트 시 이걸 읽어 버블을 복원한다.
+     */
+    getAssistantProgress(roomId: string): AssistantProgressSnapshot;
+    /**
+     * 구독 중인 모든 방의 진행 스트림 스냅샷을 서버에서 다시 받는다 (v5.1.0).
+     * 재연결·탭 복귀 때 SDK 가 자동 호출하므로 보통은 직접 부를 일이 없다.
+     */
+    resumeAssistantStreams(reason?: string): Promise<void>;
+
     // WebRTC delegations
     initializeIceServers(): Promise<RTCIceServer[]>;
     getTurnCredentials(): Promise<{ iceServers: RTCIceServer[] }>;