Merge pull request #169 from PLhery/feat/pagination-v2-likes-rt

feat: Pagination for tweet liked by / tweet retweeted by

Author: alkihis

doc/v2.md

@@ -343,14 +343,20 @@ const tweets = await client.v2.tweets(['20', '141']);
 
 **Arguments**:
   - `tweetId: string`
-  - `options?: UsersV2Params`
+  - `options?: TweetRetweetedOrLikedByV2Params`
 
-**Returns**: `TweetV2LikedByResult`
+**Returns**: `TweetV2LikedByResult` or `TweetLikingUsersV2Paginator` (if `options.asPaginator`)
 
 **Example**
 ```ts
 const users = await client.v2.tweetLikedBy('20');
 console.log(users.data[0].id);
+
+const usersPaginated = await client.v2.tweetLikedBy('20', { asPaginator: true });
+
+for await (const user of usersPaginated) {
+  console.log(user.id);
+}
 ```
 
 ### <a name='Likeatweet'></a>Like a tweet
@@ -445,14 +451,20 @@ console.log(allTweetsWithNode.data[0].tweet_count);
 
 **Arguments**:
   - `tweetId: string`
-  - `options?: UsersV2Params`
+  - `options?: TweetRetweetedOrLikedByV2Params`
 
-**Returns**: `TweetV2RetweetedByResult`
+**Returns**: `TweetV2RetweetedByResult` or `TweetRetweetersUsersV2Paginator` (if `options.asPaginator`)
 
 **Example**
 ```ts
 const users = await client.v2.tweetRetweetedBy('20');
 console.log(users.data[0].id);
+
+const usersPaginated = await client.v2.tweetRetweetedBy('20', { asPaginator: true });
+
+for await (const user of usersPaginated) {
+  console.log(user.id);
+}
 ```
 
 ### <a name='Retweetatweet'></a>Retweet a tweet

src/paginators/user.paginator.v2.ts

@@ -42,3 +42,11 @@ export class UserListMembersV2Paginator extends UserTimelineV2Paginator<UserV2Ti
 export class UserListFollowersV2Paginator extends UserTimelineV2Paginator<UserV2TimelineResult, UserV2TimelineParams, { id: string }> {
   protected _endpoint = 'lists/:id/followers';
 }
+
+export class TweetLikingUsersV2Paginator extends UserTimelineV2Paginator<UserV2TimelineResult, UserV2TimelineParams, { id: string }> {
+  protected _endpoint = 'tweets/:id/liking_users';
+}
+
+export class TweetRetweetersUsersV2Paginator extends UserTimelineV2Paginator<UserV2TimelineResult, UserV2TimelineParams, { id: string }> {
+  protected _endpoint = 'tweets/:id/retweeted_by';
+}

src/types/v2/tweet.v2.types.ts

@@ -130,13 +130,17 @@ export type TweetV2LikeResult = DataV2<{
   liked: boolean;
 }>;
 
-export type TweetV2LikedByResult = DataAndIncludeV2<UserV2[], ApiV2Includes>;
+export type TweetV2LikedByResult = DataMetaAndIncludeV2<UserV2[], {
+  result_count: number;
+  next_token?: string;
+  previous_token?: string;
+}, ApiV2Includes>;
 
 /// -- Retweets
 
 export type TweetV2RetweetResult = DataV2<{ retweeted: boolean }>;
 
-export type TweetV2RetweetedByResult = DataMetaAndIncludeV2<UserV2[], { result_count: number }, ApiV2Includes>;
+export type TweetV2RetweetedByResult = TweetV2LikedByResult;
 
 /// Tweets
 

src/types/v2/user.v2.types.ts

@@ -29,6 +29,18 @@ export interface UserV2TimelineParams {
   pagination_token?: string;
 }
 
+export interface TweetRetweetedOrLikedByV2Params extends Partial<UsersV2Params> {
+  asPaginator?: boolean;
+}
+
+export interface TweetRetweetedOrLikedByV2ParamsWithoutPaginator extends TweetRetweetedOrLikedByV2Params {
+  asPaginator?: false;
+}
+
+export interface TweetRetweetedOrLikedByV2ParamsWithPaginator extends TweetRetweetedOrLikedByV2Params {
+  asPaginator: true;
+}
+
 export interface FollowersV2Params extends UserV2TimelineParams {
   asPaginator?: boolean;
 }

src/v2/client.v2.read.ts

@@ -46,6 +46,9 @@ import {
   ListGetV2Result,
   GetListTimelineV2Params,
   ListTimelineV2Result,
+  TweetRetweetedOrLikedByV2Params,
+  TweetRetweetedOrLikedByV2ParamsWithPaginator,
+  TweetRetweetedOrLikedByV2ParamsWithoutPaginator,
 } from '../types';
 import {
   TweetSearchAllV2Paginator,
@@ -59,7 +62,7 @@ import {
   TweetV2ListTweetsPaginator,
 } from '../paginators';
 import TwitterApiv2LabsReadOnly from '../v2-labs/client.v2.labs.read';
-import { UserBlockingUsersV2Paginator, UserFollowersV2Paginator, UserFollowingV2Paginator, UserListFollowersV2Paginator, UserListMembersV2Paginator, UserMutingUsersV2Paginator } from '../paginators/user.paginator.v2';
+import { TweetLikingUsersV2Paginator, TweetRetweetersUsersV2Paginator, UserBlockingUsersV2Paginator, UserFollowersV2Paginator, UserFollowingV2Paginator, UserListFollowersV2Paginator, UserListMembersV2Paginator, UserMutingUsersV2Paginator } from '../paginators/user.paginator.v2';
 import { isTweetStreamV2ErrorPayload } from '../helpers';
 import TweetStream from '../stream/TweetStream';
 import { PromiseOrType } from '../types/shared.types';
@@ -164,16 +167,52 @@ export default class TwitterApiv2ReadOnly extends TwitterApiSubClient {
    * Allows you to get information about who has Retweeted a Tweet.
    * https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/get-tweets-id-retweeted_by
    */
-  public tweetRetweetedBy(tweetId: string, options: Partial<UsersV2Params> = {}) {
-    return this.get<TweetV2RetweetedByResult>('tweets/:id/retweeted_by', options, { params: { id: tweetId } });
+  public tweetRetweetedBy(tweetId: string, options?: Partial<TweetRetweetedOrLikedByV2ParamsWithoutPaginator>): Promise<TweetV2RetweetedByResult>;
+  public tweetRetweetedBy(tweetId: string, options: TweetRetweetedOrLikedByV2ParamsWithPaginator): Promise<TweetRetweetersUsersV2Paginator>;
+  public async tweetRetweetedBy(tweetId: string, options: TweetRetweetedOrLikedByV2Params = {}) {
+    const { asPaginator, ...parameters } = options;
+    const initialRq = await this.get<TweetV2RetweetedByResult>('tweets/:id/retweeted_by', parameters as any, {
+      fullResponse: true,
+      params: { id: tweetId },
+    });
+
+    if (!asPaginator) {
+      return initialRq.data;
+    }
+
+    return new TweetRetweetersUsersV2Paginator({
+      realData: initialRq.data,
+      rateLimit: initialRq.rateLimit!,
+      instance: this,
+      queryParams: parameters,
+      sharedParams: { id: tweetId },
+    });
   }
 
   /**
    * Allows you to get information about who has Liked a Tweet.
    * https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/get-tweets-id-liking_users
    */
-  public tweetLikedBy(tweetId: string, options: Partial<UsersV2Params> = {}) {
-    return this.get<TweetV2LikedByResult>('tweets/:id/liking_users', options, { params: { id: tweetId } });
+  public tweetLikedBy(tweetId: string, options?: Partial<TweetRetweetedOrLikedByV2ParamsWithoutPaginator>): Promise<TweetV2LikedByResult>;
+  public tweetLikedBy(tweetId: string, options: TweetRetweetedOrLikedByV2ParamsWithPaginator): Promise<TweetLikingUsersV2Paginator>;
+  public async tweetLikedBy(tweetId: string, options: TweetRetweetedOrLikedByV2Params = {}) {
+    const { asPaginator, ...parameters } = options;
+    const initialRq = await this.get<TweetV2LikedByResult>('tweets/:id/liking_users', parameters as any, {
+      fullResponse: true,
+      params: { id: tweetId },
+    });
+
+    if (!asPaginator) {
+      return initialRq.data;
+    }
+
+    return new TweetLikingUsersV2Paginator({
+      realData: initialRq.data,
+      rateLimit: initialRq.rateLimit!,
+      instance: this,
+      queryParams: parameters,
+      sharedParams: { id: tweetId },
+    });
   }
 
   /**