rettiwt-api 5.0.0-alpha.3 → 5.0.0

package/dist/services/public/ListService.d.ts

@@ -13,14 +13,15 @@ export declare class ListService extends FetcherService {
     /**
      * Get the list of members of a tweet list.
      *
-     * @param id - The id of target list.
+     * @param id - The ID of target list.
      * @param count - The number of members to fetch, must be \<= 100.
      * @param cursor - The cursor to the batch of members to fetch.
      *
      * @returns The list tweets in the given list.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -42,14 +43,15 @@ export declare class ListService extends FetcherService {
     /**
      * Get the list of tweets from a tweet list.
      *
-     * @param id - The id of target list.
+     * @param id - The ID of target list.
      * @param count - The number of tweets to fetch, must be \<= 100.
      * @param cursor - The cursor to the batch of tweets to fetch.
      *
      * @returns The list tweets in the given list.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'

package/dist/services/public/ListService.js

@@ -16,14 +16,15 @@ class ListService extends FetcherService_1.FetcherService {
     /**
      * Get the list of members of a tweet list.
      *
-     * @param id - The id of target list.
+     * @param id - The ID of target list.
      * @param count - The number of members to fetch, must be \<= 100.
      * @param cursor - The cursor to the batch of members to fetch.
      *
      * @returns The list tweets in the given list.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -56,14 +57,15 @@ class ListService extends FetcherService_1.FetcherService {
     /**
      * Get the list of tweets from a tweet list.
      *
-     * @param id - The id of target list.
+     * @param id - The ID of target list.
      * @param count - The number of tweets to fetch, must be \<= 100.
      * @param cursor - The cursor to the batch of tweets to fetch.
      *
      * @returns The list tweets in the given list.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'

package/dist/services/public/ListService.js.map

@@ -1 +1 @@
-{"version":3,"file":"ListService.js","sourceRoot":"","sources":["../../../src/services/public/ListService.ts"],"names":[],"mappings":";;;AAAA,6DAA0D;AAC1D,mDAAqD;AAQrD,qDAAkD;AAElD,MAAa,WAAY,SAAQ,+BAAc;IAC9C;;;;OAIG;IACH,YAAmB,MAAqB;QACvC,KAAK,CAAC,MAAM,CAAC,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACI,KAAK,CAAC,OAAO,CAAC,EAAU,EAAE,KAAc,EAAE,MAAe;QAC/D,MAAM,QAAQ,GAAkB,wBAAa,CAAC,YAAY,CAAC;QAE3D,mCAAmC;QACnC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,QAAQ,EAAE;YACnE,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,KAAc,EAAE,MAAe;QAC9D,MAAM,QAAQ,GAAG,wBAAa,CAAC,WAAW,CAAC;QAE3C,2BAA2B;QAC3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAsB,QAAQ,EAAE;YAClE,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,oDAAoD;QACpD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAE5F,OAAO,IAAI,CAAC;IACb,CAAC;CACD;AApGD,kCAoGC"}
+{"version":3,"file":"ListService.js","sourceRoot":"","sources":["../../../src/services/public/ListService.ts"],"names":[],"mappings":";;;AAAA,6DAA0D;AAC1D,mDAAqD;AAQrD,qDAAkD;AAElD,MAAa,WAAY,SAAQ,+BAAc;IAC9C;;;;OAIG;IACH,YAAmB,MAAqB;QACvC,KAAK,CAAC,MAAM,CAAC,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACI,KAAK,CAAC,OAAO,CAAC,EAAU,EAAE,KAAc,EAAE,MAAe;QAC/D,MAAM,QAAQ,GAAkB,wBAAa,CAAC,YAAY,CAAC;QAE3D,mCAAmC;QACnC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,QAAQ,EAAE;YACnE,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,KAAc,EAAE,MAAe;QAC9D,MAAM,QAAQ,GAAG,wBAAa,CAAC,WAAW,CAAC;QAE3C,2BAA2B;QAC3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAsB,QAAQ,EAAE;YAClE,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,oDAAoD;QACpD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAE5F,OAAO,IAAI,CAAC;IACb,CAAC;CACD;AAtGD,kCAsGC"}

package/dist/services/public/TweetService.d.ts

@@ -1,3 +1,4 @@
+import { ETweetRepliesSortType } from '../../enums/Tweet';
 import { CursoredData } from '../../models/data/CursoredData';
 import { Tweet } from '../../models/data/Tweet';
 import { User } from '../../models/data/User';
@@ -18,16 +19,21 @@ export declare class TweetService extends FetcherService {
      */
     constructor(config: RettiwtConfig);
     /**
-     * Get the details of a tweet.
+     * Get the details of one or more tweets.
      *
-     * @param id - The id(s) of the target tweet/tweets.
+     * @param id - The ID/IDs of the target tweet/tweets.
      *
      * @returns
-     * The details of the tweet with the given id.
-     * If no tweet matches the given id, returns `undefined`.
+     * The details of the tweet with the given ID.
+     *
+     * If more than one ID is provided, returns a list.
+     *
+     * If no tweet/tweets matches the given ID/IDs, returns `undefined`/`[]`.
      *
      * @example
-     * ```
+     *
+     * #### Fetching the details of a single tweet
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -36,57 +42,50 @@ export declare class TweetService extends FetcherService {
      * // Fetching the details of the tweet with the id '1234567890'
      * rettiwt.tweet.details('1234567890')
      * .then(res => {
-     * 	console.log(res);
+     * 	console.log(res);	# 'res' is a single tweet
      * })
      * .catch(err => {
      * 	console.log(err);
      * });
      * ```
-     */
-    details<T extends string | string[]>(id: T): Promise<T extends string ? Tweet | undefined : Tweet[]>;
-    /**
-     * Like a tweet.
-     *
-     * @param id - The id of the tweet to be liked.
-     *
-     * @returns Whether liking was successful or not.
      *
      * @example
-     * ```
+     *
+     * #### Fetching the details of multiple tweets
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
      * const rettiwt = new Rettiwt({ apiKey: API_KEY });
      *
-     * // Liking the Tweet with id '1234567890'
-     * rettiwt.tweet.like('1234567890')
+     * // Fetching the details of the tweets with IDs '123', '456', '789'
+     * rettiwt.tweet.details(['123', '456', '789'])
      * .then(res => {
-     * 	console.log(res);
+     * 	console.log(res);	# 'res' is an array of tweets
      * })
      * .catch(err => {
      * 	console.log(err);
      * });
      * ```
      */
-    like(id: string): Promise<boolean>;
+    details<T extends string | string[]>(id: T): Promise<T extends string ? Tweet | undefined : Tweet[]>;
     /**
-     * Get the list of users who liked a tweet. Only works for your own tweets.
+     * Like a tweet.
      *
-     * @param id - The id of the target tweet.
-     * @param count - The number of likers to fetch, must be \<= 100.
-     * @param cursor - The cursor to the batch of likers to fetch.
+     * @param id - The ID of the tweet to be liked.
      *
-     * @returns The list of users who liked the given tweet.
+     * @returns Whether liking was successful or not.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
      * const rettiwt = new Rettiwt({ apiKey: API_KEY });
      *
-     * // Fetching the most recent 100 likers of the Tweet with id '1234567890'
-     * rettiwt.tweet.likers('1234567890')
+     * // Liking the Tweet with id '1234567890'
+     * rettiwt.tweet.like('1234567890')
      * .then(res => {
      * 	console.log(res);
      * })
@@ -95,25 +94,26 @@ export declare class TweetService extends FetcherService {
      * });
      * ```
      */
-    likers(id: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
+    like(id: string): Promise<boolean>;
     /**
-     * Get the list of tweets from a tweet list.
+     * Get the list of users who liked a tweet. Only works for your own tweets.
      *
-     * @param id - The id of target list.
-     * @param count - The number of tweets to fetch, must be \<= 100.
-     * @param cursor - The cursor to the batch of tweets to fetch.
+     * @param id - The ID of the target tweet.
+     * @param count - The number of likers to fetch, must be \<= 100.
+     * @param cursor - The cursor to the batch of likers to fetch.
      *
-     * @returns The list tweets in the given list.
+     * @returns The list of users who liked the given tweet.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
      * const rettiwt = new Rettiwt({ apiKey: API_KEY });
      *
-     * // Fetching the most recent 100 tweets of the Twitter list with id '1234567890'
-     * rettiwt.tweet.list('1234567890')
+     * // Fetching the most recent 100 likers of the Tweet with id '1234567890'
+     * rettiwt.tweet.likers('1234567890')
      * .then(res => {
      * 	console.log(res);
      * })
@@ -121,20 +121,19 @@ export declare class TweetService extends FetcherService {
      * 	console.log(err);
      * });
      * ```
-     *
-     * @remarks Due a bug in Twitter API, the count is ignored when no cursor is provided and defaults to 100.
      */
-    list(id: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
+    likers(id: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
     /**
      * Post a tweet.
      *
      * @param options - The options describing the tweet to be posted. Check {@link TweetArgs} for available options.
      *
-     * @returns The id of the posted tweet.
+     * @returns The ID of the posted tweet.
      *
      * @example
-     * Posting a simple text
-     * ```
+     *
+     * #### Posting a simple text
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -151,14 +150,15 @@ export declare class TweetService extends FetcherService {
      * ```
      *
      * @example
-     * Posting a tweet with an image that has been already uploaded
-     * ```
+     *
+     * #### Posting a tweet with an image that has been already uploaded
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
      * const rettiwt = new Rettiwt({ apiKey: API_KEY });
      *
-     * // Posting a tweet, containing an image called 'mountains.jpg', to twitter
+     * // Posting a tweet, containing an image with ID '1234567890', to twitter
      * rettiwt.tweet.post({ text: 'What a nice view!', media: [{ id: '1234567890' }] })
      * .then(res => {
      * 	console.log(res);
@@ -169,8 +169,9 @@ export declare class TweetService extends FetcherService {
      * ```
      *
      * @example
-     * Posting a reply to a tweet
-     * ```
+     *
+     * #### Posting a reply to a tweet
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -186,9 +187,10 @@ export declare class TweetService extends FetcherService {
      * });
      * ```
      *
-     * * @example
-     * Posting a tweet that quotes another tweet
-     * ```
+     * @example
+     *
+     * #### Posting a tweet that quotes another tweet
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -208,13 +210,15 @@ export declare class TweetService extends FetcherService {
     /**
      * Get the list of replies to a tweet.
      *
-     * @param id - The id of the target tweet.
+     * @param id - The ID of the target tweet.
      * @param cursor - The cursor to the batch of replies to fetch.
+     * @param sortBy - The sorting order of the replies to fetch. Default is {@link ETweetRepliesSortType.RECENT}.
      *
      * @returns The list of replies to the given tweet.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -229,17 +233,22 @@ export declare class TweetService extends FetcherService {
      * 	console.log(err);
      * });
      * ```
+     *
+     * @remarks
+     *
+     * If the given tweet is the start of/part of a thread, the first batch always contains all the tweets in the thread.
      */
-    replies(id: string, cursor?: string): Promise<CursoredData<Tweet>>;
+    replies(id: string, cursor?: string, sortBy?: ETweetRepliesSortType): Promise<CursoredData<Tweet>>;
     /**
      * Retweet a tweet.
      *
-     * @param id - The id of the target tweet.
+     * @param id - The ID of the target tweet.
      *
      * @returns Whether retweeting was successful or not.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -259,14 +268,15 @@ export declare class TweetService extends FetcherService {
     /**
      * Get the list of users who retweeted a tweet.
      *
-     * @param id - The id of the target tweet.
+     * @param id - The ID of the target tweet.
      * @param count - The number of retweeters to fetch, must be \<= 100.
      * @param cursor - The cursor to the batch of retweeters to fetch.
      *
      * @returns The list of users who retweeted the given tweet.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -288,11 +298,12 @@ export declare class TweetService extends FetcherService {
      *
      * @param options - The options describing the tweet to be posted. Check {@link TweetArgs} for available options.
      *
-     * @returns The id of the schedule.
+     * @returns The ID of the schedule.
      *
      * @example
-     * Scheduling a simple text
-     * ```
+     *
+     * #### Scheduling a simple text
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -309,6 +320,7 @@ export declare class TweetService extends FetcherService {
      * ```
      *
      * @remarks
+     *
      * Scheduling a tweet is similar to {@link post}ing, except that an extra parameter called `scheduleFor` is used.
      */
     schedule(options: INewTweet): Promise<string | undefined>;
@@ -323,7 +335,8 @@ export declare class TweetService extends FetcherService {
      * @returns The list of tweets that match the given filter.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -339,7 +352,9 @@ export declare class TweetService extends FetcherService {
      * });
      * ```
      *
-     * @remarks For details about available filters, refer to {@link TweetFilter}
+     * @remarks
+     *
+     * For details about available filters, refer to {@link TweetFilter}
      */
     search(filter: ITweetFilter, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
     /**
@@ -351,7 +366,8 @@ export declare class TweetService extends FetcherService {
      * @returns An async generator that yields matching tweets as they are found.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -361,7 +377,7 @@ export declare class TweetService extends FetcherService {
      * async function streamTweets() {
      * 	try {
      * 		// Awaiting for the tweets returned by the AsyncGenerator returned by the method
-     * 		for await (const tweet of rettiwt.tweet.stream({ fromUsers: ['user1'] }, 1000)) {
+     * 		for await (const tweet of rettiwt.tweet.stream({ fromUsers: ['user1'] }, 5000)) {
      * 			console.log(tweet.fullText);
      * 		}
      * 	}
@@ -378,12 +394,13 @@ export declare class TweetService extends FetcherService {
     /**
      * Unlike a tweet.
      *
-     * @param id - The id of the target tweet.
+     * @param id - The ID of the target tweet.
      *
      * @returns Whether unliking was successful or not.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -403,12 +420,13 @@ export declare class TweetService extends FetcherService {
     /**
      * Unpost a tweet.
      *
-     * @param id - The id of the target tweet.
+     * @param id - The ID of the target tweet.
      *
      * @returns Whether unposting was successful or not.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -428,12 +446,13 @@ export declare class TweetService extends FetcherService {
     /**
      * Unretweet a tweet.
      *
-     * @param id - The id of the target tweet.
+     * @param id - The ID of the target tweet.
      *
      * @returns Whether unretweeting was successful or not.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -453,12 +472,13 @@ export declare class TweetService extends FetcherService {
     /**
      * Unschedule a tweet.
      *
-     * @param id - The id of the scheduled tweet.
+     * @param id - The ID of the scheduled tweet.
      *
      * @returns Whether unscheduling was successful or not.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -480,10 +500,11 @@ export declare class TweetService extends FetcherService {
      *
      * @param media - The path or ArrayBuffer to the media file to upload.
      *
-     * @returns The id of the uploaded media.
+     * @returns The ID of the uploaded media.
      *
      * @example
-     * ```
+     *
+     * ```ts
      * import { Rettiwt } from 'rettiwt-api';
      *
      * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -500,6 +521,7 @@ export declare class TweetService extends FetcherService {
      * ```
      *
      * @remarks
+     *
      * - The uploaded media exists for 24 hrs within which it can be included in a tweet to be posted.
      * If not posted in a tweet within this period, the uploaded media is removed.
      * - Instead of a path to the media, an ArrayBuffer containing the media can also be uploaded.