feat: polls overhaul

packages/discord.js/src/client/actions/MessagePollVoteAdd.js

@@ -1,7 +1,10 @@
 'use strict';
 
 const Action = require('./Action');
+const { Poll } = require('../../structures/Poll');
+const { PollAnswer } = require('../../structures/PollAnswer');
 const Events = require('../../util/Events');
+const Partials = require('../../util/Partials');
 
 class MessagePollVoteAddAction extends Action {
   handle(data) {
@@ -13,9 +16,26 @@ class MessagePollVoteAddAction extends Action {
 
     const { poll } = message;
 
-    const answer = poll?.answers.get(data.answer_id);
-    if (!answer) return false;
+    const includePollPartial = this.client.options.partials.includes(Partials.Poll);
+    if (message.partial && !includePollPartial) return false;
 
+    if (!poll && includePollPartial) {
+      message.poll = new Poll(this.client, { ...data, partial: true }, message, channel);
+    }
+
+    const includePollAnswerPartial = this.client.options.partials.includes(Partials.PollAnswer);
+    if (message.partial && includePollPartial && !includePollAnswerPartial) return false;
+
+    const answer = poll?.answers?.get(data.answer_id);
+    if (!answer && poll) {
+      const pollAnswer = new PollAnswer(this.client, data, poll);
+
+      poll.answers.set(data.answer_id, pollAnswer);
+    } else {
+      return false;
+    }
+
+    answer.voters._add(data.user_id);
     answer.voteCount++;
 
     /**

packages/discord.js/src/client/actions/MessagePollVoteRemove.js

@@ -1,7 +1,10 @@
 'use strict';
 
 const Action = require('./Action');
+const { Poll } = require('../../structures/Poll');
+const { PollAnswer } = require('../../structures/PollAnswer');
 const Events = require('../../util/Events');
+const Partials = require('../../util/Partials');
 
 class MessagePollVoteRemoveAction extends Action {
   handle(data) {
@@ -13,9 +16,26 @@ class MessagePollVoteRemoveAction extends Action {
 
     const { poll } = message;
 
-    const answer = poll?.answers.get(data.answer_id);
-    if (!answer) return false;
+    const includePollPartial = this.client.options.partials.includes(Partials.Poll);
+    if (message.partial && !includePollPartial) return false;
 
+    if (!poll && includePollPartial) {
+      message.poll = new Poll(this.client, { ...data, partial: true }, message, channel);
+    }
+
+    const includePollAnswerPartial = this.client.options.partials.includes(Partials.PollAnswer);
+    if (message.partial && includePollPartial && !includePollAnswerPartial) return false;
+
+    const answer = poll?.answers?.get(data.answer_id);
+    if (!answer && poll) {
+      const pollAnswer = new PollAnswer(this.client, data, poll);
+
+      poll.answers.set(data.answer_id, pollAnswer);
+    } else {
+      return false;
+    }
+
+    answer.voters.cache.delete(data.user_id);
     answer.voteCount--;
 
     /**

packages/discord.js/src/managers/PollAnswerVoterManager.js

@@ -0,0 +1,62 @@
+'use strict';
+
+const { Collection } = require('@discordjs/collection');
+const { makeURLSearchParams } = require('@discordjs/rest');
+const { Routes } = require('discord-api-types/v10');
+const CachedManager = require('./CachedManager');
+const User = require('../structures/User');
+
+/**
+ * Manages API methods for users who voted on a poll and stores their cache.
+ * @extends {CachedManager}
+ */
+class PollAnswerVoterManager extends CachedManager {
+  constructor(answer, iterable) {
+    super(answer.client, User, iterable);
+
+    /**
+     * The poll answer that this manager belongs to
+     * @type {PollAnswer}
+     */
+    this.answer = answer;
+  }
+
+  /**
+   * The cache of this manager
+   * @type {Collection<Snowflake, User>}
+   * @name PollAnswerVoterManager#cache
+   */
+
+  /**
+   * Options used to fetch voters who voted for this poll answer.
+   * @typedef {Object} FetchPollAnswerVotersOptions
+   * @property {number} [limit] The maximum amount of users to fetch
+   * @property {Snowflake} [after] The user id to fetch voters after
+   */
+
+  /**
+   * Fetches all the voters that voted on this poll answer. Resolves with a collection of users, mapped by their ids.
+   * @param {FetchPollAnswerVotersOptions} [options] Options for fetching the users
+   * @returns {Promise<Collection<Snowflake, User>>}
+   */
+  async fetch({ after, limit }) {
+    const poll = this.answer.poll;
+    const query = makeURLSearchParams({ limit, after });
+    const data = await this.client.rest.get(Routes.pollAnswerVoters(poll.channelId, poll.messageId, this.answer.id), {
+      query,
+    });
+
+    const users = new Collection();
+    for (const rawUser of data) {
+      const user = this.client.users._add(rawUser);
+      this.cache.set(user.id, user);
+      users.set(user.id, user);
+    }
+
+    this.answer.voteCount = users.size;
+
+    return users;
+  }
+}
+
+module.exports = PollAnswerVoterManager;

packages/discord.js/src/structures/Poll.js

@@ -11,9 +11,30 @@ const { ErrorCodes } = require('../errors/index');
  * @extends {Base}
  */
 class Poll extends Base {
-  constructor(client, data, message) {
+  constructor(client, data, message, channel) {
     super(client);
 
+    /**
+     * The id of the channel that this poll is in
+     * @type {Snowflake}
+     */
+    this.channelId = data.channel_id;
+
+    /**
+     * The channel that this poll is in
+     * @name Poll#channel
+     * @type {TextBasedChannel}
+     * @readonly
+     */
+
+    Object.defineProperty(this, 'channel', { value: channel });
+
+    /**
+     * The id of the message that started this poll
+     * @type {Snowflake}
+     */
+    this.messageId = data.message_id;
+
     /**
      * The message that started this poll
      * @name Poll#message
@@ -39,7 +60,7 @@ class Poll extends Base {
 
     /**
      * The answers of this poll
-     * @type {Collection<number, PollAnswer>}
+     * @type {Collection<number, PollAnswer | PartialPollAnswer>}
      */
     this.answers = data.answers.reduce(
       (acc, answer) => acc.set(answer.answer_id, new PollAnswer(this.client, answer, this)),
@@ -93,6 +114,40 @@ class Poll extends Base {
     return new Date(this.expiresTimestamp);
   }
 
+  /**
+   * Whether or not this poll is a partial
+   * @type {boolean}
+   * @readonly
+   */
+  get partial() {
+    return (
+      typeof this.question.text !== 'string' ||
+      typeof this.layoutType !== 'number' ||
+      typeof this.allowMultiselect !== 'boolean'
+    );
+  }
+
+  /**
+   * Fetches the poll
+   * @returns {Promise<Poll>}
+   */
+  async fetch() {
+    const message = await this.message.channel.messages.fetch(this.message.id);
+
+    const existing = message.poll;
+    this._patch(existing);
+
+    return this;
+  }
+
+  /**
+   * Fetches the message that started this poll
+   * @returns {Promise<Message>}
+   */
+  fetchMessage() {
+    return this.message.channel.messages.fetch(this.message.id);
+  }
+
   /**
    * Ends this poll.
    * @returns {Promise<Message>}

packages/discord.js/src/structures/PollAnswer.js

@@ -2,6 +2,7 @@
 
 const Base = require('./Base');
 const { Emoji } = require('./Emoji');
+const PollAnswerVoterManager = require('../managers/PollAnswerVoterManager');
 
 /**
  * Represents an answer to a {@link Poll}
@@ -14,7 +15,7 @@ class PollAnswer extends Base {
     /**
      * The {@link Poll} this answer is part of
      * @name PollAnswer#poll
-     * @type {Poll}
+     * @type {Poll | PartialPoll}
      * @readonly
      */
     Object.defineProperty(this, 'poll', { value: poll });
@@ -31,6 +32,12 @@ class PollAnswer extends Base {
      */
     this.text = data.poll_media.text ?? null;
 
+    /**
+     * The manager of the voters that voted for this answer
+     * @type {PollAnswerVoterManager}
+     */
+    this.voters = new PollAnswerVoterManager(this, []);
+
     /**
      * The raw emoji of this answer
      * @name PollAnswer#_emoji
@@ -64,6 +71,14 @@ class PollAnswer extends Base {
     return this.client.emojis.resolve(this._emoji.id) ?? new Emoji(this.client, this._emoji);
   }
 
+  /**
+   * Whether or not this answer is a partial.
+   * @type {boolean}
+   */
+  get partial() {
+    return this.poll.partial || (this.text === null && this.emoji === null);
+  }
+
   /**
    * Options used for fetching voters of a poll answer.
    * @typedef {Object} BaseFetchPollAnswerVotersOptions
@@ -77,12 +92,7 @@ class PollAnswer extends Base {
    * @returns {Promise<Collection<Snowflake, User>>}
    */
   fetchVoters({ after, limit } = {}) {
-    return this.poll.message.channel.messages.fetchPollAnswerVoters({
-      messageId: this.poll.message.id,
-      answerId: this.id,
-      after,
-      limit,
-    });
+    return this.users.fetch({ after, limit });
   }
 }
 

packages/discord.js/typings/index.d.ts

@@ -2602,16 +2602,28 @@ export interface PollQuestionMedia {
   text: string;
 }
 
+export class PollAnswerVoterManager extends CachedManager<Snowflake, User, UserResolvable> {
+  public constructor(answer: PollAnswer, iterable: Iterable<APIUser>);
+  public answer: PollAnswer;
+  public fetch(): Promise<Collection<Snowflake, User>>;
+}
+
 export class Poll extends Base {
-  private constructor(client: Client<true>, data: APIPoll, message: Message);
+  private constructor(client: Client<true>, data: APIPoll, message: Message, channel: TextBasedChannel);
+  public readonly channel: TextBasedChannel;
+  public channelId: Snowflake;
   public readonly message: Message;
+  public messageId: Snowflake;
   public question: PollQuestionMedia;
-  public answers: Collection<number, PollAnswer>;
+  public answers: Collection<number, PollAnswer | PartialPollAnswer>;
   public expiresTimestamp: number;
   public get expiresAt(): Date;
   public allowMultiselect: boolean;
   public layoutType: PollLayoutType;
   public resultsFinalized: boolean;
+  public get partial(): false;
+  public fetch(): Promise<Poll>;
+  public fetchMessage(): Promise<Message>;
   public end(): Promise<Message>;
 }
 
@@ -2623,11 +2635,13 @@ export interface BaseFetchPollAnswerVotersOptions {
 export class PollAnswer extends Base {
   private constructor(client: Client<true>, data: APIPollAnswer & { count?: number }, poll: Poll);
   private _emoji: APIPartialEmoji | null;
-  public readonly poll: Poll;
+  public readonly poll: Poll | PartialPoll;
   public id: number;
   public text: string | null;
   public voteCount: number;
+  public users: PollAnswerVoterManager;
   public get emoji(): GuildEmoji | Emoji | null;
+  public get partial(): false;
   public fetchVoters(options?: BaseFetchPollAnswerVotersOptions): Promise<Collection<Snowflake, User>>;
 }
 
@@ -4678,7 +4692,9 @@ export type AllowedPartial =
   | Message
   | MessageReaction
   | GuildScheduledEvent
-  | ThreadMember;
+  | ThreadMember
+  | Poll
+  | PollAnswer;
 
 export type AllowedThreadTypeForNewsChannel = ChannelType.AnnouncementThread;
 
@@ -6535,6 +6551,14 @@ export interface PartialMessage
 
 export interface PartialMessageReaction extends Partialize<MessageReaction, 'count'> {}
 
+export interface PartialPoll
+  extends Partialize<
+    Poll,
+    'allowMultiselect' | 'answers' | 'expiresTimestamp' | 'layoutType' | 'question' | 'resultsFinalized' | 'message'
+  > {}
+
+export interface PartialPollAnswer extends Partialize<PollAnswer, 'voteCount' | 'emoji' | 'poll' | 'text'> {}
+
 export interface PartialGuildScheduledEvent
   extends Partialize<GuildScheduledEvent, 'userCount', 'status' | 'privacyLevel' | 'name' | 'entityType'> {}
 
@@ -6559,6 +6583,8 @@ export enum Partials {
   Reaction,
   GuildScheduledEvent,
   ThreadMember,
+  Poll,
+  PollAnswer,
 }
 
 export interface PartialUser extends Partialize<User, 'username' | 'tag' | 'discriminator'> {}