rettiwt-api 6.3.0-alpha.1 → 7.0.1

package/src/services/public/FetcherService.ts

@@ -1,6 +1,6 @@
-import axios, { AxiosError, isAxiosError } from 'axios';
+import axios, { AxiosError, AxiosResponse, isAxiosError } from 'axios';
 import { Cookie } from 'cookiejar';
-import { JSDOM } from 'jsdom';
+import { parseHTML } from 'linkedom';
 import { ClientTransaction } from 'x-client-transaction-id';
 
 import { AllowGuestAuthenticationGroup, FetchResourcesGroup, PostResourcesGroup } from '../../collections/Groups';
@@ -128,13 +128,13 @@ export class FetcherService {
 		// Fetch X.com homepage
 		const homePageResponse = await axios.get<string>('https://x.com', {
 			headers: this.config.headers,
-			httpAgent: this.config.httpsAgent,
+			httpAgent: this.config.httpAgent,
 			httpsAgent: this.config.httpsAgent,
+			proxy: this.config.axiosProxyConfig,
 		});
 
 		// Parse HTML using linkedom
-		let dom = new JSDOM(homePageResponse.data);
-		let document = dom.window.document;
+		let document = parseHTML(homePageResponse.data).document;
 
 		// Check for migration redirection links
 		const migrationRedirectionRegex = new RegExp(
@@ -151,12 +151,12 @@ export class FetcherService {
 		if (migrationRedirectionUrl) {
 			// Follow redirection URL
 			const redirectResponse = await axios.get<string>(migrationRedirectionUrl[0], {
-				httpAgent: this.config.httpsAgent,
+				httpAgent: this.config.httpAgent,
 				httpsAgent: this.config.httpsAgent,
+				proxy: this.config.axiosProxyConfig,
 			});
 
-			dom = new JSDOM(redirectResponse.data);
-			document = dom.window.document;
+			document = parseHTML(redirectResponse.data).document;
 		}
 
 		// Handle migration form if present
@@ -193,12 +193,12 @@ export class FetcherService {
 
 					/* eslint-enable @typescript-eslint/naming-convention */
 				},
-				httpAgent: this.config.httpsAgent,
+				httpAgent: this.config.httpAgent,
 				httpsAgent: this.config.httpsAgent,
+				proxy: this.config.axiosProxyConfig,
 			});
 
-			dom = new JSDOM(formResponse.data);
-			document = dom.window.document;
+			document = parseHTML(formResponse.data).document;
 		}
 
 		// Return final DOM document
@@ -254,11 +254,11 @@ export class FetcherService {
 	 * Makes an HTTP request according to the given parameters.
 	 *
 	 * @param resource - The requested resource.
-	 * @param config - The request configuration.
+	 * @param args - The args to be used for the request.
 	 *
 	 * @typeParam T - The type of the returned response data.
 	 *
-	 * @returns The raw data response received.
+	 * @returns The raw Axios response.
 	 *
 	 * @example
 	 *
@@ -279,7 +279,7 @@ export class FetcherService {
 	 * });
 	 * ```
 	 */
-	public async request<T = unknown>(resource: ResourceType, args: IFetchArgs | IPostArgs): Promise<T> {
+	public async request<T = unknown>(resource: ResourceType, args: IFetchArgs | IPostArgs): Promise<AxiosResponse<T>> {
 		/** The current retry number. */
 		let retry = 0;
 
@@ -307,8 +307,9 @@ export class FetcherService {
 			...cred.toHeader(),
 			...this.config.headers,
 		};
-		config.httpAgent = this.config.httpsAgent;
+		config.httpAgent = this.config.httpAgent;
 		config.httpsAgent = this.config.httpsAgent;
+		config.proxy = this.config.axiosProxyConfig;
 		config.timeout = this._timeout;
 
 		// Using retries for error 404
@@ -325,7 +326,8 @@ export class FetcherService {
 				await this._wait();
 
 				// Getting the response body
-				const responseData = (await axios<T>(config)).data;
+				const response = await axios<T>(config);
+				const responseData = response.data;
 
 				// Check for Twitter API errors in response body
 				// Type guard to check if response contains errors
@@ -348,8 +350,13 @@ export class FetcherService {
 					throw new TwitterError(axiosError);
 				}
 
-				// Returning the reponse body
-				return responseData;
+				// Calling the request middleware, if configured
+				if (this.config.responseMiddleware !== undefined) {
+					await this.config.responseMiddleware(response);
+				}
+
+				// Returning the response
+				return response;
 			} catch (err) {
 				// If it's an error 404, retry
 				if (isAxiosError(err) && err.status === 404) {

package/src/services/public/ListService.ts

@@ -59,7 +59,7 @@ export class ListService extends FetcherService {
 		});
 
 		// Deserializing response
-		const data = Extractors[resource](response);
+		const data = Extractors[resource](response.data);
 
 		return data;
 	}
@@ -100,7 +100,7 @@ export class ListService extends FetcherService {
 		const response = await this.request<IListDetailsResponse>(resource, { id: id });
 
 		// Deserializing response
-		const data = Extractors[resource](response, id);
+		const data = Extractors[resource](response.data, id);
 
 		return data;
 	}
@@ -145,7 +145,7 @@ export class ListService extends FetcherService {
 		});
 
 		// Deserializing response
-		const data = Extractors[resource](response);
+		const data = Extractors[resource](response.data);
 
 		return data;
 	}
@@ -186,7 +186,7 @@ export class ListService extends FetcherService {
 		});
 
 		// Deserializing response
-		const data = Extractors[resource](response);
+		const data = Extractors[resource](response.data);
 
 		return data;
 	}
@@ -231,7 +231,7 @@ export class ListService extends FetcherService {
 		});
 
 		// Deserializing response
-		const data = Extractors[resource](response);
+		const data = Extractors[resource](response.data);
 
 		// Sorting the tweets by date, from recent to oldest
 		data.list.sort((a, b) => new Date(b.createdAt).valueOf() - new Date(a.createdAt).valueOf());

package/src/services/public/SpaceService.ts

@@ -0,0 +1,65 @@
+import { Extractors } from '../../collections/Extractors';
+import { ResourceType } from '../../enums/Resource';
+import { Space } from '../../models/data/Space';
+import { RettiwtConfig } from '../../models/RettiwtConfig';
+import { ISpaceDetailsOptions } from '../../types/args/FetchArgs';
+import { IAudioSpaceByIdResponse } from '../../types/raw/space/AudioSpaceById';
+
+import { FetcherService } from './FetcherService';
+
+/**
+ * Handles interacting with resources related to spaces.
+ *
+ * @public
+ */
+export class SpaceService extends FetcherService {
+	/**
+	 * @param config - The config object for configuring the Rettiwt instance.
+	 *
+	 * @internal
+	 */
+	public constructor(config: RettiwtConfig) {
+		super(config);
+	}
+
+	/**
+	 * Get the details of a space.
+	 *
+	 * @param id - The ID of the target space.
+	 * @param options - Additional options for the fetch.
+	 *
+	 * @returns The details of the space with the given ID.
+	 *
+	 * @example
+	 *
+	 * ```ts
+	 * import { Rettiwt } from 'rettiwt-api';
+	 *
+	 * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+	 *
+	 * rettiwt.space.details('1YqJDNEzvoVKV', { withListeners: true })
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 */
+	public async details(id: string, options?: ISpaceDetailsOptions): Promise<Space | undefined> {
+		const resource = ResourceType.SPACE_DETAILS;
+
+		// Fetching raw space details
+		const response = await this.request<IAudioSpaceByIdResponse>(resource, {
+			id: id,
+			withReplays: options?.withReplays,
+			withListeners: options?.withListeners,
+			isMetatagsQuery: options?.isMetatagsQuery,
+		});
+
+		// Deserializing response
+		const data = Extractors[resource](response.data);
+
+		return data;
+	}
+}

package/src/services/public/TweetService.ts

@@ -17,7 +17,7 @@ import { ITweetDetailsResponse } from '../../types/raw/tweet/Details';
 import { ITweetDetailsBulkResponse } from '../../types/raw/tweet/DetailsBulk';
 import { ITweetLikeResponse } from '../../types/raw/tweet/Like';
 import { ITweetLikersResponse } from '../../types/raw/tweet/Likers';
-import { ITweetPostResponse } from '../../types/raw/tweet/Post';
+import { ITweetPostNoteResponse, ITweetPostResponse } from '../../types/raw/tweet/Post';
 import { ITweetRepliesResponse } from '../../types/raw/tweet/Replies';
 import { ITweetRetweetResponse } from '../../types/raw/tweet/Retweet';
 import { ITweetRetweetersResponse } from '../../types/raw/tweet/Retweeters';
@@ -80,7 +80,7 @@ export class TweetService extends FetcherService {
 		});
 
 		// Deserializing response
-		const data = Extractors[resource](response) ?? false;
+		const data = Extractors[resource](response.data) ?? false;
 
 		return data;
 	}
@@ -146,7 +146,7 @@ export class TweetService extends FetcherService {
 			const response = await this.request<ITweetRepliesResponse>(resource, { id: id });
 
 			// Deserializing response
-			const data = Extractors[resource](response, id);
+			const data = Extractors[resource](response.data, id);
 
 			return data as T extends string ? Tweet | undefined : Tweet[];
 		}
@@ -158,7 +158,7 @@ export class TweetService extends FetcherService {
 			const response = await this.request<ITweetDetailsBulkResponse>(resource, { ids: id });
 
 			// Deserializing response
-			const data = Extractors[resource](response, id);
+			const data = Extractors[resource](response.data, id);
 
 			return data as T extends string ? Tweet | undefined : Tweet[];
 		}
@@ -170,7 +170,7 @@ export class TweetService extends FetcherService {
 			const response = await this.request<ITweetDetailsResponse>(resource, { id: String(id) });
 
 			// Deserializing response
-			const data = Extractors[resource](response, String(id));
+			const data = Extractors[resource](response.data, String(id));
 
 			return data as T extends string ? Tweet | undefined : Tweet[];
 		}
@@ -210,7 +210,7 @@ export class TweetService extends FetcherService {
 		});
 
 		// Deserializing response
-		const data = Extractors[resource](response) ?? false;
+		const data = Extractors[resource](response.data) ?? false;
 
 		return data;
 	}
@@ -253,7 +253,7 @@ export class TweetService extends FetcherService {
 		});
 
 		// Deserializing response
-		const data = Extractors[resource](response);
+		const data = Extractors[resource](response.data);
 
 		return data;
 	}
@@ -342,15 +342,18 @@ export class TweetService extends FetcherService {
 	 * ```
 	 */
 	public async post(options: INewTweet): Promise<string | undefined> {
-		const resource = ResourceType.TWEET_POST;
+		// Use CreateNoteTweet endpoint for long-form tweets (X Premium, >280 chars)
+		if ((options.text?.length ?? 0) > 280) {
+			const response = await this.request<ITweetPostNoteResponse>(ResourceType.TWEET_POST_NOTE, {
+				tweet: options,
+			});
 
-		// Posting the tweet
-		const response = await this.request<ITweetPostResponse>(resource, { tweet: options });
+			return Extractors[ResourceType.TWEET_POST_NOTE](response.data);
+		}
 
-		// Deserializing response
-		const data = Extractors[resource](response);
+		const response = await this.request<ITweetPostResponse>(ResourceType.TWEET_POST, { tweet: options });
 
-		return data;
+		return Extractors[ResourceType.TWEET_POST](response.data);
 	}
 
 	/**
@@ -403,7 +406,7 @@ export class TweetService extends FetcherService {
 		});
 
 		// Deserializing response
-		const data = Extractors[resource](response);
+		const data = Extractors[resource](response.data);
 
 		return data;
 	}
@@ -440,7 +443,7 @@ export class TweetService extends FetcherService {
 		const response = await this.request<ITweetRetweetResponse>(resource, { id: id });
 
 		// Deserializing response
-		const data = Extractors[resource](response) ?? false;
+		const data = Extractors[resource](response.data) ?? false;
 
 		return data;
 	}
@@ -483,7 +486,7 @@ export class TweetService extends FetcherService {
 		});
 
 		// Deserializing response
-		const data = Extractors[resource](response);
+		const data = Extractors[resource](response.data);
 
 		return data;
 	}
@@ -525,7 +528,7 @@ export class TweetService extends FetcherService {
 		const response = await this.request<ITweetScheduleResponse>(resource, { tweet: options });
 
 		// Deserializing response
-		const data = Extractors[resource](response);
+		const data = Extractors[resource](response.data);
 
 		return data;
 	}
@@ -573,7 +576,7 @@ export class TweetService extends FetcherService {
 		});
 
 		// Deserializing response
-		const data = Extractors[resource](response);
+		const data = Extractors[resource](response.data);
 
 		// Sorting the tweets by date, from recent to oldest
 		data.list.sort((a, b) => new Date(b.createdAt).valueOf() - new Date(a.createdAt).valueOf());
@@ -682,7 +685,7 @@ export class TweetService extends FetcherService {
 		const response = await this.request<ITweetUnbookmarkResponse>(resource, { id: id });
 
 		// Deserializing the response
-		const data = Extractors[resource](response) ?? false;
+		const data = Extractors[resource](response.data) ?? false;
 
 		return data;
 	}
@@ -719,7 +722,7 @@ export class TweetService extends FetcherService {
 		const response = await this.request<ITweetUnlikeResponse>(resource, { id: id });
 
 		// Deserializing the response
-		const data = Extractors[resource](response) ?? false;
+		const data = Extractors[resource](response.data) ?? false;
 
 		return data;
 	}
@@ -756,7 +759,7 @@ export class TweetService extends FetcherService {
 		const response = await this.request<ITweetUnpostResponse>(resource, { id: id });
 
 		// Deserializing the response
-		const data = Extractors[resource](response) ?? false;
+		const data = Extractors[resource](response.data) ?? false;
 
 		return data;
 	}
@@ -793,7 +796,7 @@ export class TweetService extends FetcherService {
 		const response = await this.request<ITweetUnretweetResponse>(resource, { id: id });
 
 		// Deserializing the response
-		const data = Extractors[resource](response) ?? false;
+		const data = Extractors[resource](response.data) ?? false;
 
 		return data;
 	}
@@ -830,7 +833,7 @@ export class TweetService extends FetcherService {
 		const response = await this.request<ITweetUnscheduleResponse>(resource, { id: id });
 
 		// Deserializing the response
-		const data = Extractors[resource](response) ?? false;
+		const data = Extractors[resource](response.data) ?? false;
 
 		return data;
 	}
@@ -873,7 +876,7 @@ export class TweetService extends FetcherService {
 			await this.request<IMediaInitializeUploadResponse>(ResourceType.MEDIA_UPLOAD_INITIALIZE, {
 				upload: { size: size },
 			})
-		).media_id_string;
+		).data.media_id_string;
 
 		// APPEND
 		await this.request<unknown>(ResourceType.MEDIA_UPLOAD_APPEND, { upload: { id: id, media: media } });