stream-chat 8.41.1 → 8.42.0

package/src/types.ts

@@ -1227,7 +1227,7 @@ export type Event<StreamChatGenerics extends ExtendableGenerics = DefaultGeneric
   online?: boolean;
   parent_id?: string;
   poll?: PollResponse<StreamChatGenerics>;
-  poll_vote?: PollVote<StreamChatGenerics>;
+  poll_vote?: PollVote<StreamChatGenerics> | PollAnswer<StreamChatGenerics>;
   queriedChannels?: {
     channels: ChannelAPIResponse<StreamChatGenerics>[];
     isLatestMessageSet?: boolean;
@@ -1490,6 +1490,12 @@ export type ChannelFilters<StreamChatGenerics extends ExtendableGenerics = Defau
     }
 >;
 
+export type QueryPollsParams = {
+  filter?: QueryPollsFilters;
+  options?: QueryPollsOptions;
+  sort?: PollSort;
+};
+
 export type QueryPollsOptions = Pager;
 
 export type VotesFiltersOptions = {
@@ -3017,30 +3023,23 @@ export type UpdatePollAPIResponse<StreamChatGenerics extends ExtendableGenerics
 
 export type PollResponse<
   StreamChatGenerics extends ExtendableGenerics = DefaultGenerics
-> = StreamChatGenerics['pollType'] & {
-  answers_count: number;
-  created_at: string;
-  created_by: UserResponse<StreamChatGenerics> | null;
-  created_by_id: string;
-  enforce_unique_vote: boolean;
-  id: string;
-  latest_answers: PollVote<StreamChatGenerics>[];
-  latest_votes_by_option: Record<string, PollVote<StreamChatGenerics>[]>;
-  max_votes_allowed: number;
-  name: string;
-  options: PollOption<StreamChatGenerics>[];
-  updated_at: string;
-  vote_count: number;
-  vote_counts_by_option: Record<string, number>;
-  allow_answers?: boolean;
-  allow_user_suggested_options?: boolean;
-  channel?: ChannelAPIResponse<StreamChatGenerics> | null;
-  cid?: string;
-  description?: string;
-  is_closed?: boolean;
-  own_votes?: PollVote<StreamChatGenerics>[];
-  voting_visibility?: VotingVisibility;
-};
+> = StreamChatGenerics['pollType'] &
+  PollEnrichData<StreamChatGenerics> & {
+    created_at: string;
+    created_by: UserResponse<StreamChatGenerics> | null;
+    created_by_id: string;
+    enforce_unique_vote: boolean;
+    id: string;
+    max_votes_allowed: number;
+    name: string;
+    options: PollOption<StreamChatGenerics>[];
+    updated_at: string;
+    allow_answers?: boolean;
+    allow_user_suggested_options?: boolean;
+    description?: string;
+    is_closed?: boolean;
+    voting_visibility?: VotingVisibility;
+  };
 
 export type PollOption<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
   created_at: string;
@@ -3057,15 +3056,24 @@ export enum VotingVisibility {
   public = 'public',
 }
 
+export type PollEnrichData<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
+  answers_count: number;
+  latest_answers: PollAnswer<StreamChatGenerics>[]; // not updated with WS events, ordered DESC by created_at, seems like updated_at cannot be different from created_at
+  latest_votes_by_option: Record<string, PollVote<StreamChatGenerics>[]>; // not updated with WS events; always null in anonymous polls
+  vote_count: number;
+  vote_counts_by_option: Record<string, number>;
+  own_votes?: (PollVote<StreamChatGenerics> | PollAnswer<StreamChatGenerics>)[]; // not updated with WS events
+};
+
 export type PollData<
   StreamChatGenerics extends ExtendableGenerics = DefaultGenerics
 > = StreamChatGenerics['pollType'] & {
+  id: string;
   name: string;
   allow_answers?: boolean;
   allow_user_suggested_options?: boolean;
   description?: string;
   enforce_unique_vote?: boolean;
-  id?: string;
   is_closed?: boolean;
   max_votes_allowed?: number;
   options?: PollOptionData<StreamChatGenerics>[];
@@ -3073,15 +3081,19 @@ export type PollData<
   voting_visibility?: VotingVisibility;
 };
 
+export type CreatePollData<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Partial<
+  PollData<StreamChatGenerics>
+> &
+  Pick<PollData<StreamChatGenerics>, 'name'>;
+
 export type PartialPollUpdate<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
-  // id: string;
-  set?: Partial<PollResponse<StreamChatGenerics>>;
-  unset?: Array<keyof PollResponse<StreamChatGenerics>>;
+  set?: Partial<PollData<StreamChatGenerics>>;
+  unset?: Array<keyof PollData<StreamChatGenerics>>;
 };
 
 export type PollOptionData<
   StreamChatGenerics extends ExtendableGenerics = DefaultGenerics
-> = StreamChatGenerics['pollType'] & {
+> = StreamChatGenerics['pollOptionType'] & {
   text: string;
   id?: string;
   position?: number;
@@ -3130,21 +3142,33 @@ export type PollOptionResponse<
 export type PollVote<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
   created_at: string;
   id: string;
-  is_answer: boolean;
   poll_id: string;
-  user_id: string;
-  answer_text?: string;
+  updated_at: string;
   option_id?: string;
   user?: UserResponse<StreamChatGenerics>;
+  user_id?: string;
+};
+
+export type PollAnswer<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Exclude<
+  PollVote<StreamChatGenerics>,
+  'option_id'
+> & {
+  answer_text: string;
+  is_answer: boolean; // this is absolutely redundant prop as answer_text indicates that a vote is an answer
 };
 
 export type PollVotesAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
-  votes: PollVote<StreamChatGenerics>[];
+  votes: (PollVote<StreamChatGenerics> | PollAnswer<StreamChatGenerics>)[];
+  next?: string;
+};
+
+export type PollAnswersAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
+  votes: PollAnswer<StreamChatGenerics>[]; // todo: should be changes to answers?
   next?: string;
 };
 
 export type CastVoteAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
-  vote: PollVote<StreamChatGenerics>;
+  vote: PollVote<StreamChatGenerics> | PollAnswer<StreamChatGenerics>;
 };
 
 export type QueryMessageHistoryFilters = QueryFilters<