fxtwitter 1.0.0 → 2.0.0

package/dist/v2.cjs

@@ -0,0 +1,183 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_http = require("./http-Cs4GJeg-.cjs");
+//#region src/v2.ts
+/** Builds the `id:<rest_id>` handle form accepted by the profile endpoints. */
+function byUserId(id) {
+	return `id:${id}`;
+}
+/**
+* Recovers the body of a 404 that carries a well-formed, empty result page,
+* which is how the list endpoints report "no results or timeline unavailable".
+*/
+function emptyPage(error) {
+	if (!(error instanceof require_http.FxTwitterError) || error.status !== 404) return null;
+	const body = error.body;
+	if (typeof body !== "object" || body === null) return null;
+	const results = body.results;
+	return Array.isArray(results) ? body : null;
+}
+/** Client for the FxTwitter/FxEmbed v2 API (https://docs.fxembed.com/api/twitter/). */
+var FxTwitterV2 = class {
+	http;
+	constructor(options = {}) {
+		this.http = new require_http.HttpClient(options);
+	}
+	/** Only `/2/profile/{handle}/statuses` can answer 204, so everything else demands a body. */
+	async get(path, query, signal) {
+		const body = await this.http.get({
+			path,
+			query,
+			signal
+		});
+		if (body === null) throw new require_http.FxTwitterError("The API returned an empty response");
+		return body;
+	}
+	/**
+	* Same as {@link get}, for the endpoints that report "no results" as a 404
+	* carrying an otherwise normal body. An empty page is a result, not an
+	* error, so it is returned rather than thrown.
+	*
+	* The API uses that same 404 for an unknown handle, which it does not
+	* distinguish from an empty timeline.
+	*/
+	async getPage(path, query, signal) {
+		try {
+			return await this.get(path, query, signal);
+		} catch (error) {
+			const page = emptyPage(error);
+			if (page) return page;
+			throw error;
+		}
+	}
+	/** `GET /2/status/{id}` — a single post by snowflake ID. */
+	getStatus(id, options = {}) {
+		return this.get(`/2/status/${encodeURIComponent(id)}`, {
+			about_account: options.aboutAccount ? "1" : void 0,
+			lang: options.lang
+		}, options.signal);
+	}
+	/** `GET /2/status/{id}/reposts` — users who reposted a post. */
+	getStatusReposts(id, options = {}) {
+		return this.getPage(`/2/status/${encodeURIComponent(id)}/reposts`, {
+			count: options.count,
+			cursor: options.cursor
+		}, options.signal);
+	}
+	/** `GET /2/status/{id}/quotes` — posts quoting a post. */
+	getStatusQuotes(id, options = {}) {
+		return this.getPage(`/2/status/${encodeURIComponent(id)}/quotes`, {
+			count: options.count,
+			cursor: options.cursor,
+			lang: options.lang
+		}, options.signal);
+	}
+	/** `GET /2/thread/{id}` — a post with its unrolled thread. */
+	getThread(id, options = {}) {
+		return this.get(`/2/thread/${encodeURIComponent(id)}`, {
+			about_account: options.aboutAccount ? "1" : void 0,
+			lang: options.lang
+		}, options.signal);
+	}
+	/** `GET /2/conversation/{id}` — a post, its thread, and ranked replies. */
+	getConversation(id, options = {}) {
+		return this.get(`/2/conversation/${encodeURIComponent(id)}`, {
+			ranking_mode: options.rankingMode,
+			cursor: options.cursor,
+			about_account: options.aboutAccount ? "1" : void 0,
+			lang: options.lang
+		}, options.signal);
+	}
+	/**
+	* `GET /2/profile/{handle}` — a user's profile. `handle` is a username
+	* without `@`, or `byUserId(id)` for a numeric user ID.
+	*/
+	getProfile(handle, options = {}) {
+		return this.get(`/2/profile/${encodeURIComponent(handle)}`, { about_account: options.aboutAccount ? "1" : void 0 }, options.signal);
+	}
+	/**
+	* `GET /2/profile/{handle}/statuses` — a user's posts. Resolves to `null`
+	* when `since` is set (without `cursor`) and nothing is newer than it.
+	*/
+	async getProfileStatuses(handle, options = {}) {
+		try {
+			return await this.http.get({
+				path: `/2/profile/${encodeURIComponent(handle)}/statuses`,
+				query: {
+					count: options.count,
+					cursor: options.cursor,
+					since: options.since,
+					with_replies: options.withReplies ? "1" : void 0,
+					groupthreads: options.groupThreads ? "1" : void 0,
+					lang: options.lang
+				},
+				signal: options.signal
+			});
+		} catch (error) {
+			const page = emptyPage(error);
+			if (page) return page;
+			throw error;
+		}
+	}
+	/** `GET /2/profile/{handle}/articles` — a user's long-form articles. */
+	getProfileArticles(handle, options = {}) {
+		return this.getPage(`/2/profile/${encodeURIComponent(handle)}/articles`, {
+			count: options.count,
+			cursor: options.cursor,
+			lang: options.lang
+		}, options.signal);
+	}
+	/** `GET /2/profile/{handle}/about` — account metadata (based-in country, name changes). */
+	getProfileAbout(handle, options = {}) {
+		return this.get(`/2/profile/${encodeURIComponent(handle)}/about`, void 0, options.signal);
+	}
+	/** `GET /2/profile/{handle}/media` — a user's posts that contain media. */
+	getProfileMedia(handle, options = {}) {
+		return this.getPage(`/2/profile/${encodeURIComponent(handle)}/media`, {
+			count: options.count,
+			cursor: options.cursor,
+			lang: options.lang
+		}, options.signal);
+	}
+	/** `GET /2/profile/{handle}/followers` — a user's followers. */
+	getProfileFollowers(handle, options = {}) {
+		return this.getPage(`/2/profile/${encodeURIComponent(handle)}/followers`, {
+			count: options.count,
+			cursor: options.cursor
+		}, options.signal);
+	}
+	/** `GET /2/profile/{handle}/following` — accounts a user follows. */
+	getProfileFollowing(handle, options = {}) {
+		return this.getPage(`/2/profile/${encodeURIComponent(handle)}/following`, {
+			count: options.count,
+			cursor: options.cursor
+		}, options.signal);
+	}
+	/** `GET /2/search` — search posts. */
+	search(query, options = {}) {
+		return this.getPage("/2/search", {
+			q: query,
+			feed: options.feed,
+			count: options.count,
+			cursor: options.cursor,
+			lang: options.lang
+		}, options.signal);
+	}
+	/** `GET /2/typeahead` — search-box autocomplete suggestions. */
+	typeahead(query, options = {}) {
+		return this.get("/2/typeahead", {
+			q: query,
+			result_type: options.resultType?.join(","),
+			src: options.src
+		}, options.signal);
+	}
+	/** `GET /2/trends` — trending topics. */
+	trends(options = {}) {
+		return this.get("/2/trends", {
+			type: "trending",
+			count: options.count
+		}, options.signal);
+	}
+};
+//#endregion
+exports.FxTwitterV2 = FxTwitterV2;
+exports.byUserId = byUserId;