fxtwitter 0.0.0-reserved → 2.0.0

package/dist/v2.mjs

@@ -0,0 +1,181 @@
+import { n as FxTwitterError, t as HttpClient } from "./http-BTdKgEdX.mjs";
+//#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 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 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 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
+export { FxTwitterV2, byUserId };

package/package.json

@@ -1,19 +1,92 @@
 {
   "name": "fxtwitter",
-  "version": "0.0.0-reserved",
-  "main": "index.js",
-  "scripts": {
-    "help": "node scripts/main.js --help",
-    "reserve": "node scripts/main.js"
+  "version": "2.0.0",
+  "description": "Typed wrapper for the FxTwitter API.",
+  "keywords": [
+    "x",
+    "twitter",
+    "fxtwitter",
+    "wrapper",
+    "api"
+  ],
+  "homepage": "https://github.com/otnc/fxtwitter-wrapper#readme",
+  "bugs": {
+    "url": "https://github.com/otnc/fxtwitter-wrapper/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/otnc/fxtwitter-wrapper.git"
+  },
+  "license": "MIT",
+  "author": "otoneko.",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.mts",
+  "exports": {
+    ".": {
+      "types": {
+        "import": "./dist/index.d.mts",
+        "require": "./dist/index.d.cts"
+      },
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    },
+    "./v1": {
+      "types": {
+        "import": "./dist/v1.d.mts",
+        "require": "./dist/v1.d.cts"
+      },
+      "import": "./dist/v1.mjs",
+      "require": "./dist/v1.cjs"
+    },
+    "./v2": {
+      "types": {
+        "import": "./dist/v2.d.mts",
+        "require": "./dist/v2.d.cts"
+      },
+      "import": "./dist/v2.mjs",
+      "require": "./dist/v2.cjs"
+    },
+    "./package.json": "./package.json"
   },
   "files": [
-    "index.js"
+    "dist"
   ],
-  "keywords": [],
-  "author": "otoneko.",
-  "description": "[Reserved]",
+  "engines": {
+    "node": ">=22"
+  },
+  "scripts": {
+    "setup": "node scripts/setup.js",
+    "build": "tsdown",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "typecheck": "tsc --noEmit",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "check": "prettier --write . && eslint --fix .",
+    "ci": "prettier --check . && eslint .",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "defu": "^6.1.7",
+    "ofetch": "^1.5.1",
+    "std-env": "^4.2.0"
+  },
   "devDependencies": {
-    "consola": "^3.4.2",
-    "dotenv": "^17.3.1"
+    "@eslint/js": "^10.0.1",
+    "@types/node": "^22.20.1",
+    "@vitest/coverage-v8": "^4.1.10",
+    "eslint": "^10.8.0",
+    "eslint-config-prettier": "^10.1.8",
+    "globals": "^17.8.0",
+    "prettier": "^3.9.6",
+    "tsdown": "^0.22.14",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.65.0",
+    "vitest": "^4.1.10"
   }
-}
+}

package/index.js

@@ -1 +0,0 @@
-module.exports = console.log("fxtwitter is reserved for otoneko.");