5 Commits
Author SHA1 Message Date
yuta 0caf2677e4 Release v0.9.0
CI / test (push) Successful in 10m2s
Publish npm package / publish (push) Successful in 9m53s
2026-06-26 13:24:01 +09:00
yuta 9340ed3f47 Add profileImageUrl to TweetData.author
CI / test (push) Successful in 11m4s
2026-06-26 01:56:14 +09:00
yuta 2e293ad65b Add user profile resolution
CI / test (push) Successful in 10m0s
2026-06-24 20:46:34 +09:00
yuta 826de66d78 Add home timeline pagination flags
CI / test (push) Successful in 9m58s
2026-06-24 20:17:02 +09:00
yuta 01f4b58b99 test: require explicit relay fixture
CI / test (push) Successful in 9m59s
2026-06-24 19:20:39 +09:00
21 changed files with 965 additions and 54 deletions
+9
View File
@@ -1,5 +1,14 @@
# Changelog # Changelog
## 0.9.0 — 2026-06-26
### Added
- `users` command for user profile lookup with avatars and descriptions.
- `home` pagination: `--all`, `--max-pages`, `--cursor` flags.
### Changed
- Tweet output now includes `profileImageUrl` in author data.
## 0.8.0 — 2026-01-19 ## 0.8.0 — 2026-01-19
### Added ### Added
+19 -1
View File
@@ -87,6 +87,10 @@ bird following --user 12345678 -n 10 # by user ID
bird followers -n 20 bird followers -n 20
bird followers --user 12345678 -n 10 # by user ID bird followers --user 12345678 -n 10 # by user ID
# Rich profile resolution
bird user @steipete --json
bird profiles @steipete 12345678 --json
# Refresh GraphQL query IDs cache (no rebuild) # Refresh GraphQL query IDs cache (no rebuild)
bird query-ids --fresh bird query-ids --fresh
``` ```
@@ -175,7 +179,7 @@ Fields:
- `bird reply <tweet-id-or-url> "<text>"` — reply to a tweet using its ID or URL. - `bird reply <tweet-id-or-url> "<text>"` — reply to a tweet using its ID or URL.
- `bird help [command]` — show help (or help for a subcommand). - `bird help [command]` — show help (or help for a subcommand).
- `bird query-ids [--fresh] [--json]` — inspect or refresh cached GraphQL query IDs. - `bird query-ids [--fresh] [--json]` — inspect or refresh cached GraphQL query IDs.
- `bird home [-n count] [--following] [--json] [--json-full]` — fetch your home timeline (For You) or Following feed. - `bird home [-n count] [--following] [--all] [--max-pages n] [--cursor string] [--delay ms] [--json] [--json-full]` — fetch your home timeline (For You) or Following feed; `--max-pages` implies pagination.
- `bird read <tweet-id-or-url> [--json]` — fetch tweet content as text or JSON. - `bird read <tweet-id-or-url> [--json]` — fetch tweet content as text or JSON.
- `bird <tweet-id-or-url> [--json]` — shorthand for `read` when only a URL or ID is provided. - `bird <tweet-id-or-url> [--json]` — shorthand for `read` when only a URL or ID is provided.
- `bird replies <tweet-id-or-url> [--all] [--max-pages n] [--cursor string] [--delay ms] [--json]` — list replies to a tweet. - `bird replies <tweet-id-or-url> [--all] [--max-pages n] [--cursor string] [--delay ms] [--json]` — list replies to a tweet.
@@ -192,6 +196,8 @@ Fields:
- `bird list-timeline <list-id-or-url> [-n count] [--all] [--max-pages n] [--cursor string] [--json]` — get tweets from a list timeline; `--max-pages` implies `--all`. - `bird list-timeline <list-id-or-url> [-n count] [--all] [--max-pages n] [--cursor string] [--json]` — get tweets from a list timeline; `--max-pages` implies `--all`.
- `bird following [--user <userId>] [-n count] [--cursor string] [--all] [--max-pages n] [--json]` — list users that you (or another user) follow; `--max-pages` requires `--all`. - `bird following [--user <userId>] [-n count] [--cursor string] [--all] [--max-pages n] [--json]` — list users that you (or another user) follow; `--max-pages` requires `--all`.
- `bird followers [--user <userId>] [-n count] [--cursor string] [--all] [--max-pages n] [--json]` — list users that follow you (or another user); `--max-pages` requires `--all`. - `bird followers [--user <userId>] [-n count] [--cursor string] [--all] [--max-pages n] [--json]` — list users that follow you (or another user); `--max-pages` requires `--all`.
- `bird user <@handle-or-id> [--json]` — resolve a rich user profile.
- `bird profiles <@handle-or-id...> [--json]` — resolve rich user profiles with per-target errors.
- `bird about <@handle> [--json]` — get account origin and location information for a user. - `bird about <@handle> [--json]` — get account origin and location information for a user.
- `bird whoami` — print which Twitter account your relay belongs to. - `bird whoami` — print which Twitter account your relay belongs to.
- `bird check` — verify relay configuration and account access. - `bird check` — verify relay configuration and account access.
@@ -293,6 +299,18 @@ When using `--json` with `following`/`followers`, user objects include:
| `profileImageUrl` | string? | Profile image URL | | `profileImageUrl` | string? | Profile image URL |
| `createdAt` | string? | Account creation timestamp | | `createdAt` | string? | Account creation timestamp |
When using `--json` with `user`/`profiles`, profile objects include the user fields above plus richer metadata when available:
| Field | Type | Description |
|-------|------|-------------|
| `location` | string? | Profile location |
| `url` | string? | Expanded profile URL |
| `verified` | boolean? | Verified status |
| `verifiedType` | string? | Verification type |
| `entities` | object? | Raw profile URL/bio entities |
| `affiliation` | object? | Highlighted-label organization metadata |
| `raw` | object? | Raw GraphQL user payload |
When using `--json` with `news`/`trending`, news objects include: When using `--json` with `news`/`trending`, news objects include:
| Field | Type | Description | | Field | Type | Description |
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "@yuta/bird", "name": "@yuta/bird",
"version": "0.8.0", "version": "0.9.0",
"description": "CLI tool for tweeting and replying via Twitter/X GraphQL API", "description": "CLI tool for tweeting and replying via Twitter/X GraphQL API",
"type": "module", "type": "module",
"main": "dist/index.js", "main": "dist/index.js",
+3 -1
View File
@@ -31,6 +31,8 @@ export const KNOWN_COMMANDS = new Set([
'unfollow', 'unfollow',
'following', 'following',
'followers', 'followers',
'user',
'profiles',
'likes', 'likes',
'lists', 'lists',
'list-timeline', 'list-timeline',
@@ -96,7 +98,7 @@ export function createProgram(ctx: CliContext): Command {
].join('\n\n')}\n\n${ctx.colors.section('Shortcuts')}\n${[ ].join('\n\n')}\n\n${ctx.colors.section('Shortcuts')}\n${[
formatExample('bird <tweet-id-or-url> [--json]', 'Shorthand for `bird read <tweet-id-or-url>`'), formatExample('bird <tweet-id-or-url> [--json]', 'Shorthand for `bird read <tweet-id-or-url>`'),
].join('\n\n')}\n\n${ctx.colors.section('JSON Output')}\n${ctx.colors.muted( ].join('\n\n')}\n\n${ctx.colors.section('JSON Output')}\n${ctx.colors.muted(
` Add ${ctx.colors.option('--json')} to: read, replies, thread, search, mentions, bookmarks, likes, following, followers, about, lists, list-timeline, user-tweets, query-ids`, ` Add ${ctx.colors.option('--json')} to: read, replies, thread, search, mentions, bookmarks, likes, following, followers, user, profiles, about, lists, list-timeline, user-tweets, query-ids`,
)}\n${ctx.colors.muted( )}\n${ctx.colors.muted(
` Add ${ctx.colors.option('--json-full')} to include raw API response in ${ctx.colors.argument('_raw')} field (tweet commands only)`, ` Add ${ctx.colors.option('--json-full')} to include raw API response in ${ctx.colors.argument('_raw')} field (tweet commands only)`,
)}\n${ctx.colors.muted(` (Run ${ctx.colors.command('bird <command> --help')} to see per-command flags.)`)}`, )}\n${ctx.colors.muted(` (Run ${ctx.colors.command('bird <command> --help')} to see per-command flags.)`)}`,
+63 -25
View File
@@ -1,4 +1,5 @@
import type { Command } from 'commander'; import type { Command } from 'commander';
import { parsePaginationFlags } from '../cli/pagination.js';
import type { CliContext } from '../cli/shared.js'; import type { CliContext } from '../cli/shared.js';
import { TwitterClient } from '../lib/twitter-client.js'; import { TwitterClient } from '../lib/twitter-client.js';
@@ -7,36 +8,73 @@ export function registerHomeCommand(program: Command, ctx: CliContext): void {
.command('home') .command('home')
.description('Get your home timeline ("For You" feed)') .description('Get your home timeline ("For You" feed)')
.option('-n, --count <number>', 'Number of tweets to fetch', '20') .option('-n, --count <number>', 'Number of tweets to fetch', '20')
.option('--all', 'Fetch all available pages up to --count')
.option('--max-pages <number>', 'Stop after N pages')
.option('--cursor <string>', 'Resume pagination from a cursor')
.option('--delay <ms>', 'Delay in ms between page fetches', '1000')
.option('--following', 'Get "Following" feed (chronological) instead of "For You"') .option('--following', 'Get "Following" feed (chronological) instead of "For You"')
.option('--json', 'Output as JSON') .option('--json', 'Output as JSON')
.option('--json-full', 'Output as JSON with full raw API response in _raw field') .option('--json-full', 'Output as JSON with full raw API response in _raw field')
.action(async (cmdOpts: { count?: string; following?: boolean; json?: boolean; jsonFull?: boolean }) => { .action(
const opts = program.opts(); async (cmdOpts: {
const timeoutMs = ctx.resolveTimeoutFromOptions(opts); count?: string;
const count = Number.parseInt(cmdOpts.count || '20', 10); all?: boolean;
const relayBaseUrl = ctx.resolveRelayBaseUrlFromOptions(opts); maxPages?: string;
const profileName = ctx.resolveProfileNameFromOptions(opts); cursor?: string;
delay?: string;
following?: boolean;
json?: boolean;
jsonFull?: boolean;
}) => {
const opts = program.opts();
const timeoutMs = ctx.resolveTimeoutFromOptions(opts);
const count = Number.parseInt(cmdOpts.count || '20', 10);
const pagination = parsePaginationFlags(cmdOpts, {
maxPagesImpliesPagination: true,
includeDelay: true,
});
if (!pagination.ok) {
console.error(`${ctx.p('err')}${pagination.error}`);
process.exit(1);
}
const relayBaseUrl = ctx.resolveRelayBaseUrlFromOptions(opts);
const profileName = ctx.resolveProfileNameFromOptions(opts);
if (!Number.isFinite(count) || count <= 0) { if (!Number.isFinite(count) || count <= 0) {
console.error(`${ctx.p('err')}Invalid --count. Expected a positive integer.`); console.error(`${ctx.p('err')}Invalid --count. Expected a positive integer.`);
process.exit(1); process.exit(1);
} }
const client = new TwitterClient({ relayBaseUrl, profileName, timeoutMs }); const client = new TwitterClient({ relayBaseUrl, profileName, timeoutMs });
const includeRaw = cmdOpts.jsonFull ?? false; const includeRaw = cmdOpts.jsonFull ?? false;
const usePagination = pagination.usePagination;
const fetchOptions = {
includeRaw,
maxPages: pagination.maxPages,
cursor: pagination.cursor,
pageDelayMs: pagination.pageDelayMs,
};
const result = cmdOpts.following const result = cmdOpts.following
? await client.getHomeLatestTimeline(count, { includeRaw }) ? await client.getHomeLatestTimeline(count, fetchOptions)
: await client.getHomeTimeline(count, { includeRaw }); : await client.getHomeTimeline(count, fetchOptions);
if (result.success) { if (result.success) {
const feedType = cmdOpts.following ? 'Following' : 'For You'; const feedType = cmdOpts.following ? 'Following' : 'For You';
const emptyMessage = `No tweets found in ${feedType} timeline.`; const emptyMessage = `No tweets found in ${feedType} timeline.`;
const isJson = Boolean(cmdOpts.json || cmdOpts.jsonFull); const isJson = Boolean(cmdOpts.json || cmdOpts.jsonFull);
ctx.printTweets(result.tweets, { json: isJson, emptyMessage }); ctx.printTweetsResult(result, {
} else { json: isJson,
console.error(`${ctx.p('err')}Failed to fetch home timeline: ${result.error}`); usePagination,
process.exit(1); emptyMessage,
} });
}); if (result.nextCursor && !cmdOpts.json && !cmdOpts.jsonFull) {
console.error(`${ctx.p('info')}More tweets available. Use --cursor "${result.nextCursor}" to continue.`);
}
} else {
console.error(`${ctx.p('err')}Failed to fetch home timeline: ${result.error}`);
process.exit(1);
}
},
);
} }
+84 -1
View File
@@ -2,7 +2,7 @@ import type { Command } from 'commander';
import type { CliContext } from '../cli/shared.js'; import type { CliContext } from '../cli/shared.js';
import { normalizeHandle } from '../lib/normalize-handle.js'; import { normalizeHandle } from '../lib/normalize-handle.js';
import { TwitterClient } from '../lib/twitter-client.js'; import { TwitterClient } from '../lib/twitter-client.js';
import type { AboutAccountProfile, TwitterUser } from '../lib/twitter-client-types.js'; import type { AboutAccountProfile, TwitterUser, TwitterUserProfile } from '../lib/twitter-client-types.js';
function formatAboutProfile(profile: AboutAccountProfile, ctx: CliContext, handle: string): string[] { function formatAboutProfile(profile: AboutAccountProfile, ctx: CliContext, handle: string): string[] {
const lines: string[] = [`${ctx.p('info')}Account information for @${handle}:`]; const lines: string[] = [`${ctx.p('info')}Account information for @${handle}:`];
@@ -64,6 +64,32 @@ function printUsers(users: TwitterUser[], ctx: CliContext): void {
} }
} }
function printProfile(profile: TwitterUserProfile, ctx: CliContext): void {
console.log(`@${profile.username} (${profile.name})`);
console.log(`${ctx.l('userId')}${profile.id}`);
if (profile.description) {
console.log(` ${profile.description}`);
}
if (profile.location) {
console.log(` Location: ${profile.location}`);
}
if (profile.url) {
console.log(` URL: ${profile.url}`);
}
if (profile.followersCount !== undefined) {
console.log(` ${ctx.p('info')}${profile.followersCount.toLocaleString()} followers`);
}
if (profile.followingCount !== undefined) {
console.log(` ${ctx.p('info')}${profile.followingCount.toLocaleString()} following`);
}
if (profile.verifiedType || profile.verified) {
console.log(` Verified: ${profile.verifiedType ?? 'yes'}`);
}
if (profile.affiliation?.description) {
console.log(` Affiliation: ${profile.affiliation.description}`);
}
}
async function resolveUserIdOrExit( async function resolveUserIdOrExit(
client: TwitterClient, client: TwitterClient,
requestedUserId: string | undefined, requestedUserId: string | undefined,
@@ -216,6 +242,63 @@ export function registerUserCommands(program: Command, ctx: CliContext): void {
fetch: (client, userId, count, cursor) => client.getFollowers(userId, count, cursor), fetch: (client, userId, count, cursor) => client.getFollowers(userId, count, cursor),
}); });
program
.command('user')
.description('Resolve a rich user profile by handle or user ID')
.argument('<target>', 'Username (with or without @) or numeric user ID')
.option('--json', 'Output as JSON')
.action(async (target: string, cmdOpts: { json?: boolean }) => {
const opts = program.opts();
const timeoutMs = ctx.resolveTimeoutFromOptions(opts);
const relayBaseUrl = ctx.resolveRelayBaseUrlFromOptions(opts);
const profileName = ctx.resolveProfileNameFromOptions(opts);
const client = new TwitterClient({ relayBaseUrl, profileName, timeoutMs });
const result = await client.getUserProfile(target);
if (!result.success) {
console.error(`${ctx.p('err')}Failed to resolve user: ${result.error}`);
process.exit(1);
}
if (cmdOpts.json) {
console.log(JSON.stringify(result.profile, null, 2));
return;
}
printProfile(result.profile, ctx);
});
program
.command('profiles')
.description('Resolve rich user profiles by handle or user ID')
.argument('<targets...>', 'Usernames or numeric user IDs')
.option('--json', 'Output as JSON')
.action(async (targets: string[], cmdOpts: { json?: boolean }) => {
const opts = program.opts();
const timeoutMs = ctx.resolveTimeoutFromOptions(opts);
const relayBaseUrl = ctx.resolveRelayBaseUrlFromOptions(opts);
const profileName = ctx.resolveProfileNameFromOptions(opts);
const client = new TwitterClient({ relayBaseUrl, profileName, timeoutMs });
const result = await client.getUserProfiles(targets);
const users = result.results.flatMap((item) => ('profile' in item ? [item.profile] : []));
const errors = result.results.flatMap((item) =>
'error' in item ? [{ target: item.target, error: item.error }] : [],
);
if (cmdOpts.json) {
console.log(JSON.stringify({ users, errors }, null, 2));
return;
}
for (const profile of users) {
printProfile(profile, ctx);
console.log('──────────────────────────────────────────────────');
}
for (const error of errors) {
console.error(`${ctx.p('err')}${error.target}: ${error.error}`);
}
if (users.length === 0 && errors.length > 0) {
process.exit(1);
}
});
program program
.command('likes') .command('likes')
.description('Get your liked tweets') .description('Get your liked tweets')
+2
View File
@@ -39,6 +39,8 @@ export const FALLBACK_QUERY_IDS = {
GenericTimelineById: 'uGSr7alSjR9v6QJAIaqSKQ', GenericTimelineById: 'uGSr7alSjR9v6QJAIaqSKQ',
TrendHistory: 'Sj4T-jSB9pr0Mxtsc1UKZQ', TrendHistory: 'Sj4T-jSB9pr0Mxtsc1UKZQ',
AboutAccountQuery: 'zs_jFPFT78rBpXv9Z3U2YQ', AboutAccountQuery: 'zs_jFPFT78rBpXv9Z3U2YQ',
UserByScreenName: 'IGgvgiOx4QZndDHuD3x9TQ',
UserByRestId: 'VQfQ9wwYdk6j_u2O4vt64Q',
} as const; } as const;
export type OperationName = keyof typeof FALLBACK_QUERY_IDS; export type OperationName = keyof typeof FALLBACK_QUERY_IDS;
+32 -4
View File
@@ -14,6 +14,12 @@ function isQueryIdMismatch(errors: Array<{ message?: string }>): boolean {
export interface HomeTimelineFetchOptions { export interface HomeTimelineFetchOptions {
/** Include raw GraphQL response in `_raw` field */ /** Include raw GraphQL response in `_raw` field */
includeRaw?: boolean; includeRaw?: boolean;
/** Starting cursor for pagination */
cursor?: string;
/** Maximum number of pages to fetch */
maxPages?: number;
/** Delay in milliseconds between page fetches */
pageDelayMs?: number;
} }
export interface TwitterClientHomeMethods { export interface TwitterClientHomeMethods {
@@ -64,7 +70,17 @@ export function withHome<TBase extends AbstractConstructor<TwitterClientBase>>(
const pageSize = 20; const pageSize = 20;
const seen = new Set<string>(); const seen = new Set<string>();
const tweets: TweetData[] = []; const tweets: TweetData[] = [];
let cursor: string | undefined; let cursor: string | undefined = options.cursor;
let nextCursor: string | undefined;
let pagesFetched = 0;
const effectiveMaxPages =
options.maxPages !== undefined && Number.isFinite(options.maxPages) && options.maxPages > 0
? Math.floor(options.maxPages)
: Number.POSITIVE_INFINITY;
const pageDelayMs =
options.pageDelayMs !== undefined && Number.isFinite(options.pageDelayMs) && options.pageDelayMs > 0
? options.pageDelayMs
: 0;
const fetchPage = async (pageCount: number, pageCursor?: string) => { const fetchPage = async (pageCount: number, pageCursor?: string) => {
let lastError: string | undefined; let lastError: string | undefined;
@@ -168,11 +184,16 @@ export function withHome<TBase extends AbstractConstructor<TwitterClientBase>>(
}; };
while (tweets.length < count) { while (tweets.length < count) {
if (pagesFetched > 0 && pageDelayMs > 0) {
await this.sleep(pageDelayMs);
}
const pageCount = Math.min(pageSize, count - tweets.length); const pageCount = Math.min(pageSize, count - tweets.length);
const page = await fetchWithRefresh(pageCount, cursor); const page = await fetchWithRefresh(pageCount, cursor);
if (!page.success) { if (!page.success) {
return { success: false, error: page.error }; return { success: false, error: page.error };
} }
pagesFetched += 1;
let added = 0; let added = 0;
for (const tweet of page.tweets) { for (const tweet of page.tweets) {
@@ -187,13 +208,20 @@ export function withHome<TBase extends AbstractConstructor<TwitterClientBase>>(
} }
} }
if (!page.cursor || page.cursor === cursor || page.tweets.length === 0 || added === 0) { const pageCursor = page.cursor;
if (!pageCursor || pageCursor === cursor || page.tweets.length === 0 || added === 0) {
nextCursor = undefined;
break; break;
} }
cursor = page.cursor; if (pagesFetched >= effectiveMaxPages) {
nextCursor = pageCursor;
break;
}
cursor = pageCursor;
nextCursor = pageCursor;
} }
return { success: true, tweets }; return { success: true, tweets, nextCursor };
} }
} }
+57
View File
@@ -47,11 +47,15 @@ export type GraphqlTweetResult = {
legacy?: { legacy?: {
screen_name?: string; screen_name?: string;
name?: string; name?: string;
profile_image_url_https?: string;
}; };
core?: { core?: {
screen_name?: string; screen_name?: string;
name?: string; name?: string;
}; };
avatar?: {
image_url?: string;
};
}; };
}; };
}; };
@@ -263,6 +267,7 @@ export interface TweetData {
author: { author: {
username: string; username: string;
name: string; name: string;
profileImageUrl?: string;
}; };
authorId?: string; authorId?: string;
createdAt?: string; createdAt?: string;
@@ -334,6 +339,58 @@ export interface TwitterUser {
createdAt?: string; createdAt?: string;
} }
export interface TwitterUserUrlEntity {
url?: string;
expanded_url?: string;
display_url?: string;
}
export interface TwitterUserProfile {
id: string;
username: string;
name: string;
description?: string;
location?: string;
url?: string;
verified?: boolean;
verifiedType?: string;
followersCount?: number;
followingCount?: number;
profileImageUrl?: string;
createdAt?: string;
entities?: Record<string, unknown>;
affiliation?: {
description?: string;
url?: string;
badgeUrl?: string;
};
raw?: unknown;
}
export type UserProfileResult =
| {
success: true;
profile: TwitterUserProfile;
}
| {
success: false;
error: string;
};
export type UserProfilesResult = {
success: true;
results: Array<
| {
target: string;
profile: TwitterUserProfile;
}
| {
target: string;
error: string;
}
>;
};
export interface FollowingResult { export interface FollowingResult {
success: boolean; success: boolean;
users?: TwitterUser[]; users?: TwitterUser[];
+265 -1
View File
@@ -1,7 +1,14 @@
import { normalizeHandle } from './normalize-handle.js'; import { normalizeHandle } from './normalize-handle.js';
import type { AbstractConstructor, Mixin, TwitterClientBase } from './twitter-client-base.js'; import type { AbstractConstructor, Mixin, TwitterClientBase } from './twitter-client-base.js';
import { TWITTER_API_BASE } from './twitter-client-constants.js'; import { TWITTER_API_BASE } from './twitter-client-constants.js';
import type { AboutAccountResult } from './twitter-client-types.js'; import type {
AboutAccountResult,
TwitterUserProfile,
UserProfileResult,
UserProfilesResult,
} from './twitter-client-types.js';
const NUMERIC_USER_ID_PATTERN = /^[0-9]+$/;
/** Result of username to userId lookup */ /** Result of username to userId lookup */
export interface UserLookupResult { export interface UserLookupResult {
@@ -14,9 +21,119 @@ export interface UserLookupResult {
export interface TwitterClientUserLookupMethods { export interface TwitterClientUserLookupMethods {
getUserIdByUsername(username: string): Promise<UserLookupResult>; getUserIdByUsername(username: string): Promise<UserLookupResult>;
getUserProfile(target: string): Promise<UserProfileResult>;
getUserProfiles(targets: string[]): Promise<UserProfilesResult>;
getUserAboutAccount(username: string): Promise<AboutAccountResult>; getUserAboutAccount(username: string): Promise<AboutAccountResult>;
} }
type UserProfileGraphqlResult = {
__typename?: string;
rest_id?: string;
is_blue_verified?: boolean;
avatar?: {
image_url?: string;
};
verification_info?: unknown;
legacy?: {
screen_name?: string;
name?: string;
description?: string;
location?: string;
url?: string;
created_at?: string;
verified?: boolean;
verified_type?: string;
followers_count?: number;
friends_count?: number;
profile_image_url_https?: string;
entities?: Record<string, unknown>;
};
core?: {
screen_name?: string;
name?: string;
created_at?: string;
};
location?: {
location?: string;
};
affiliates_highlighted_label?: {
label?: {
description?: string;
url?: { url?: string };
badge?: { url?: string };
};
};
user?: UserProfileGraphqlResult;
};
function isNumericUserId(value: string): boolean {
return NUMERIC_USER_ID_PATTERN.test(value.trim());
}
function firstExpandedUrl(entities: Record<string, unknown> | undefined): string | undefined {
const urlEntity = entities?.url;
if (!urlEntity || typeof urlEntity !== 'object') {
return undefined;
}
const urls = (urlEntity as { urls?: unknown }).urls;
if (!Array.isArray(urls)) {
return undefined;
}
const first = urls[0];
if (!first || typeof first !== 'object') {
return undefined;
}
const expandedUrl = (first as { expanded_url?: unknown }).expanded_url;
const url = (first as { url?: unknown }).url;
return typeof expandedUrl === 'string' ? expandedUrl : typeof url === 'string' ? url : undefined;
}
function normalizeGraphqlUserResult(result: UserProfileGraphqlResult): TwitterUserProfile | null {
const user = result.__typename === 'UserWithVisibilityResults' && result.user ? result.user : result;
if (user.__typename === 'UserUnavailable') {
return null;
}
const id = user.rest_id;
const username = user.legacy?.screen_name ?? user.core?.screen_name;
if (!id || !username) {
return null;
}
const entities = user.legacy?.entities;
const location = user.legacy?.location ?? user.location?.location;
const createdAt = user.legacy?.created_at ?? user.core?.created_at;
const label = user.affiliates_highlighted_label?.label;
const affiliation =
label?.description || label?.url?.url || label?.badge?.url
? {
...(label.description ? { description: label.description } : {}),
...(label.url?.url ? { url: label.url.url } : {}),
...(label.badge?.url ? { badgeUrl: label.badge.url } : {}),
}
: undefined;
return {
id,
username,
name: user.legacy?.name ?? user.core?.name ?? username,
...(user.legacy?.description ? { description: user.legacy.description } : {}),
...(location ? { location } : {}),
...(firstExpandedUrl(entities) ? { url: firstExpandedUrl(entities) } : {}),
...(typeof user.is_blue_verified === 'boolean' || typeof user.legacy?.verified === 'boolean'
? { verified: Boolean(user.is_blue_verified || user.legacy?.verified) }
: {}),
...(user.legacy?.verified_type ? { verifiedType: user.legacy.verified_type } : {}),
...(typeof user.legacy?.followers_count === 'number' ? { followersCount: user.legacy.followers_count } : {}),
...(typeof user.legacy?.friends_count === 'number' ? { followingCount: user.legacy.friends_count } : {}),
...(user.avatar?.image_url || user.legacy?.profile_image_url_https
? { profileImageUrl: user.avatar?.image_url ?? user.legacy?.profile_image_url_https }
: {}),
...(createdAt ? { createdAt } : {}),
...(entities ? { entities } : {}),
...(affiliation ? { affiliation } : {}),
raw: user,
};
}
export function withUserLookup<TBase extends AbstractConstructor<TwitterClientBase>>( export function withUserLookup<TBase extends AbstractConstructor<TwitterClientBase>>(
Base: TBase, Base: TBase,
): Mixin<TBase, TwitterClientUserLookupMethods> { ): Mixin<TBase, TwitterClientUserLookupMethods> {
@@ -208,6 +325,153 @@ export function withUserLookup<TBase extends AbstractConstructor<TwitterClientBa
return { success: false, error: lastError ?? 'Unknown error looking up user' }; return { success: false, error: lastError ?? 'Unknown error looking up user' };
} }
private buildUserByScreenNameFeatures(): Record<string, boolean> {
return {
hidden_profile_subscriptions_enabled: true,
profile_label_improvements_pcf_label_in_post_enabled: true,
responsive_web_profile_redirect_enabled: false,
rweb_tipjar_consumption_enabled: false,
verified_phone_label_enabled: false,
subscriptions_verification_info_is_identity_verified_enabled: true,
subscriptions_verification_info_verified_since_enabled: true,
highlights_tweets_tab_ui_enabled: true,
responsive_web_twitter_article_notes_tab_enabled: true,
subscriptions_feature_can_gift_premium: true,
creator_subscriptions_tweet_preview_api_enabled: true,
responsive_web_graphql_skip_user_profile_image_extensions_enabled: false,
responsive_web_graphql_timeline_navigation_enabled: true,
};
}
private buildUserByRestIdFeatures(): Record<string, boolean> {
return {
hidden_profile_subscriptions_enabled: true,
profile_label_improvements_pcf_label_in_post_enabled: true,
responsive_web_profile_redirect_enabled: false,
rweb_tipjar_consumption_enabled: false,
verified_phone_label_enabled: false,
highlights_tweets_tab_ui_enabled: true,
responsive_web_twitter_article_notes_tab_enabled: true,
subscriptions_feature_can_gift_premium: true,
creator_subscriptions_tweet_preview_api_enabled: true,
responsive_web_graphql_skip_user_profile_image_extensions_enabled: false,
responsive_web_graphql_timeline_navigation_enabled: true,
};
}
private async getUserProfileByScreenName(screenName: string): Promise<UserProfileResult> {
const queryId = await this.getQueryId('UserByScreenName');
const variables = {
screen_name: screenName,
withGrokTranslatedBio: true,
};
const params = new URLSearchParams({
variables: JSON.stringify(variables),
features: JSON.stringify(this.buildUserByScreenNameFeatures()),
fieldToggles: JSON.stringify({
withPayments: false,
withAuxiliaryUserLabels: true,
}),
});
const response = await this.fetchWithTimeout(
`${TWITTER_API_BASE}/${queryId}/UserByScreenName?${params.toString()}`,
{
method: 'GET',
headers: this.getHeaders(),
},
);
if (!response.ok) {
const text = await response.text();
return { success: false, error: `HTTP ${response.status}: ${text.slice(0, 200)}` };
}
const data = (await response.json()) as {
data?: { user?: { result?: UserProfileGraphqlResult } };
errors?: Array<{ message?: string }>;
};
if (data.errors?.length) {
return { success: false, error: data.errors.map((error) => error.message ?? 'GraphQL error').join(', ') };
}
const result = data.data?.user?.result;
if (result?.__typename === 'UserUnavailable') {
return { success: false, error: `User @${screenName} not found or unavailable` };
}
const profile = result ? normalizeGraphqlUserResult(result) : null;
if (!profile) {
return { success: false, error: `Could not parse profile for @${screenName}` };
}
return { success: true, profile };
}
private async getUserProfileByRestId(userId: string): Promise<UserProfileResult> {
const queryId = await this.getQueryId('UserByRestId');
const params = new URLSearchParams({
variables: JSON.stringify({ userId }),
features: JSON.stringify(this.buildUserByRestIdFeatures()),
});
const response = await this.fetchWithTimeout(`${TWITTER_API_BASE}/${queryId}/UserByRestId?${params.toString()}`, {
method: 'GET',
headers: this.getHeaders(),
});
if (!response.ok) {
const text = await response.text();
return { success: false, error: `HTTP ${response.status}: ${text.slice(0, 200)}` };
}
const data = (await response.json()) as {
data?: { user?: { result?: UserProfileGraphqlResult } };
errors?: Array<{ message?: string }>;
};
if (data.errors?.length) {
return { success: false, error: data.errors.map((error) => error.message ?? 'GraphQL error').join(', ') };
}
const result = data.data?.user?.result;
if (result?.__typename === 'UserUnavailable') {
return { success: false, error: `User ${userId} not found or unavailable` };
}
const profile = result ? normalizeGraphqlUserResult(result) : null;
if (!profile) {
return { success: false, error: `Could not parse profile for ${userId}` };
}
return { success: true, profile };
}
async getUserProfile(target: string): Promise<UserProfileResult> {
const trimmed = target.trim();
if (!trimmed) {
return { success: false, error: 'User target is required' };
}
if (isNumericUserId(trimmed)) {
return this.getUserProfileByRestId(trimmed);
}
const cleanUsername = normalizeHandle(trimmed);
if (!cleanUsername) {
return { success: false, error: `Invalid username: ${target}` };
}
return this.getUserProfileByScreenName(cleanUsername);
}
async getUserProfiles(targets: string[]): Promise<UserProfilesResult> {
const results: UserProfilesResult['results'] = [];
const seen = new Set<string>();
for (const target of targets) {
const trimmed = target.trim();
if (!trimmed || seen.has(trimmed)) {
continue;
}
seen.add(trimmed);
const result = await this.getUserProfile(trimmed);
if (result.success) {
results.push({ target: trimmed, profile: result.profile });
} else {
results.push({ target: trimmed, error: result.error });
}
}
return { success: true, results };
}
private async getAboutAccountQueryIds(): Promise<string[]> { private async getAboutAccountQueryIds(): Promise<string[]> {
const primary = await this.getQueryId('AboutAccountQuery'); const primary = await this.getQueryId('AboutAccountQuery');
return Array.from(new Set([primary, 'zs_jFPFT78rBpXv9Z3U2YQ'])); return Array.from(new Set([primary, 'zs_jFPFT78rBpXv9Z3U2YQ']));
+1
View File
@@ -566,6 +566,7 @@ export function mapTweetResult(
author: { author: {
username, username,
name: name || username, name: name || username,
profileImageUrl: userLegacy?.profile_image_url_https ?? userResult?.avatar?.image_url,
}, },
authorId: userId, authorId: userId,
quotedTweet, quotedTweet,
+3
View File
@@ -67,5 +67,8 @@ export type {
TwitterClientOptions, TwitterClientOptions,
TwitterList, TwitterList,
TwitterUser, TwitterUser,
TwitterUserProfile,
UploadMediaResult, UploadMediaResult,
UserProfileResult,
UserProfilesResult,
} from './twitter-client-types.js'; } from './twitter-client-types.js';
+7
View File
@@ -14,6 +14,8 @@ describe('cli-args', () => {
'bookmarks', 'bookmarks',
'following', 'following',
'followers', 'followers',
'user',
'profiles',
'likes', 'likes',
'help', 'help',
'whoami', 'whoami',
@@ -58,6 +60,11 @@ describe('cli-args', () => {
expect(result.argv).toBeNull(); expect(result.argv).toBeNull();
}); });
it('does not rewrite numeric profile targets when profiles command is provided', () => {
const result = resolveCliInvocation(['profiles', '@steipete', '25401953', '--json'], known);
expect(result.argv).toBeNull();
});
it('does not rewrite unknown commands', () => { it('does not rewrite unknown commands', () => {
const result = resolveCliInvocation(['https://example.com'], known); const result = resolveCliInvocation(['https://example.com'], known);
expect(result.argv).toBeNull(); expect(result.argv).toBeNull();
+61
View File
@@ -0,0 +1,61 @@
import { Command } from 'commander';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import type { CliContext } from '../src/cli/shared.js';
import { registerHomeCommand } from '../src/commands/home.js';
import { TwitterClient } from '../src/lib/twitter-client.js';
describe('home command', () => {
let program: Command;
let mockContext: Partial<CliContext>;
beforeEach(() => {
program = new Command();
mockContext = {
resolveTimeoutFromOptions: () => undefined,
resolveRelayBaseUrlFromOptions: () => 'https://relay.example',
resolveProfileNameFromOptions: () => undefined,
p: () => '',
printTweetsResult: vi.fn(),
};
});
it('uses cursor pagination when --cursor is set', async () => {
registerHomeCommand(program, mockContext as CliContext);
const timelineSpy = vi
.spyOn(TwitterClient.prototype, 'getHomeLatestTimeline')
.mockResolvedValue({ success: true, tweets: [], nextCursor: 'next-1' });
try {
await program.parseAsync(['node', 'bird', 'home', '--following', '--cursor', 'cursor-1']);
expect(timelineSpy).toHaveBeenCalledWith(20, expect.objectContaining({ cursor: 'cursor-1' }));
expect(mockContext.printTweetsResult).toHaveBeenCalledWith(expect.objectContaining({ nextCursor: 'next-1' }), {
json: false,
usePagination: true,
emptyMessage: 'No tweets found in Following timeline.',
});
} finally {
timelineSpy.mockRestore();
}
});
it('uses paged home timeline when --max-pages is set', async () => {
registerHomeCommand(program, mockContext as CliContext);
const timelineSpy = vi.spyOn(TwitterClient.prototype, 'getHomeTimeline').mockResolvedValue({
success: true,
tweets: [],
nextCursor: 'next-2',
});
try {
await program.parseAsync(['node', 'bird', 'home', '--max-pages', '3', '--json']);
expect(timelineSpy).toHaveBeenCalledWith(20, expect.objectContaining({ maxPages: 3 }));
expect(mockContext.printTweetsResult).toHaveBeenCalledWith(expect.objectContaining({ nextCursor: 'next-2' }), {
json: true,
usePagination: true,
emptyMessage: 'No tweets found in For You timeline.',
});
} finally {
timelineSpy.mockRestore();
}
});
});
+40
View File
@@ -209,4 +209,44 @@ describe('users commands', () => {
expect(payload.nextCursor).toBeNull(); expect(payload.nextCursor).toBeNull();
expect(followingSpy).toHaveBeenCalledTimes(2); expect(followingSpy).toHaveBeenCalledTimes(2);
}); });
it('prints a single profile as JSON', async () => {
const program = new Command();
registerUserCommands(program, baseCtx);
const profileSpy = vi.spyOn(TwitterClient.prototype, 'getUserProfile').mockResolvedValue({
success: true,
profile: { id: '1', username: 'alpha', name: 'Alpha' },
});
const logSpy = vi.spyOn(console, 'log').mockImplementation(() => undefined);
await program.parseAsync(['node', 'bird', 'user', '@alpha', '--json']);
expect(profileSpy).toHaveBeenCalledWith('@alpha');
expect(JSON.parse(String(logSpy.mock.calls[0]?.[0]))).toMatchObject({
id: '1',
username: 'alpha',
name: 'Alpha',
});
});
it('prints batch profiles with per-target errors as JSON', async () => {
const program = new Command();
registerUserCommands(program, baseCtx);
const profilesSpy = vi.spyOn(TwitterClient.prototype, 'getUserProfiles').mockResolvedValue({
success: true,
results: [
{ target: 'alpha', profile: { id: '1', username: 'alpha', name: 'Alpha' } },
{ target: 'missing', error: 'not found' },
],
});
const logSpy = vi.spyOn(console, 'log').mockImplementation(() => undefined);
await program.parseAsync(['node', 'bird', 'profiles', 'alpha', 'missing', '--json']);
expect(profilesSpy).toHaveBeenCalledWith(['alpha', 'missing']);
expect(JSON.parse(String(logSpy.mock.calls[0]?.[0]))).toEqual({
users: [{ id: '1', username: 'alpha', name: 'Alpha' }],
errors: [{ target: 'missing', error: 'not found' }],
});
});
}); });
+2
View File
@@ -17,6 +17,8 @@ describe('root help output', () => {
expect(help).toContain('following'); expect(help).toContain('following');
expect(help).toContain('followers'); expect(help).toContain('followers');
expect(help).toContain('user');
expect(help).toContain('profiles');
expect(help).toContain('likes'); expect(help).toContain('likes');
expect(help).toContain('bird <tweet-id-or-url>'); expect(help).toContain('bird <tweet-id-or-url>');
+10 -10
View File
@@ -1,6 +1,6 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'; import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { TwitterClient } from '../src/lib/twitter-client.js'; import { TwitterClient } from '../src/lib/twitter-client.js';
import { validCookies } from './twitter-client-fixtures.js'; import { testRelayBaseUrl } from './twitter-client-fixtures.js';
const originalFetch = global.fetch; const originalFetch = global.fetch;
@@ -25,7 +25,7 @@ describe('TwitterClient engagement', () => {
json: async () => ({ data: { favorite_tweet: 'Done' } }), json: async () => ({ data: { favorite_tweet: 'Done' } }),
}); });
const client = new TwitterClient({ cookies: validCookies }); const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.like('1234567890'); const result = await client.like('1234567890');
expect(result.success).toBe(true); expect(result.success).toBe(true);
@@ -45,7 +45,7 @@ describe('TwitterClient engagement', () => {
text: async () => 'Forbidden', text: async () => 'Forbidden',
}); });
const client = new TwitterClient({ cookies: validCookies }); const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.like('1234567890'); const result = await client.like('1234567890');
expect(result.success).toBe(false); expect(result.success).toBe(false);
@@ -61,7 +61,7 @@ describe('TwitterClient engagement', () => {
}), }),
}); });
const client = new TwitterClient({ cookies: validCookies }); const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.like('1234567890'); const result = await client.like('1234567890');
expect(result.success).toBe(false); expect(result.success).toBe(false);
@@ -75,7 +75,7 @@ describe('TwitterClient engagement', () => {
json: async () => ({ data: { favorite_tweet: 'Done' } }), json: async () => ({ data: { favorite_tweet: 'Done' } }),
}); });
const client = new TwitterClient({ cookies: validCookies }); const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.like('1234567890'); const result = await client.like('1234567890');
expect(result.success).toBe(true); expect(result.success).toBe(true);
@@ -91,7 +91,7 @@ describe('TwitterClient engagement', () => {
json: async () => ({ data: { unfavorite_tweet: 'Done' } }), json: async () => ({ data: { unfavorite_tweet: 'Done' } }),
}); });
const client = new TwitterClient({ cookies: validCookies }); const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.unlike('1234567890'); const result = await client.unlike('1234567890');
expect(result.success).toBe(true); expect(result.success).toBe(true);
@@ -111,7 +111,7 @@ describe('TwitterClient engagement', () => {
json: async () => ({ data: { create_retweet: { retweet_results: { result: {} } } } }), json: async () => ({ data: { create_retweet: { retweet_results: { result: {} } } } }),
}); });
const client = new TwitterClient({ cookies: validCookies }); const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.retweet('1234567890'); const result = await client.retweet('1234567890');
expect(result.success).toBe(true); expect(result.success).toBe(true);
@@ -131,7 +131,7 @@ describe('TwitterClient engagement', () => {
json: async () => ({ data: { unretweet: { source_tweet_results: {} } } }), json: async () => ({ data: { unretweet: { source_tweet_results: {} } } }),
}); });
const client = new TwitterClient({ cookies: validCookies }); const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.unretweet('1234567890'); const result = await client.unretweet('1234567890');
expect(result.success).toBe(true); expect(result.success).toBe(true);
@@ -154,7 +154,7 @@ describe('TwitterClient engagement', () => {
json: async () => ({ data: { tweet_bookmark_put: 'Done' } }), json: async () => ({ data: { tweet_bookmark_put: 'Done' } }),
}); });
const client = new TwitterClient({ cookies: validCookies }); const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.bookmark('1234567890'); const result = await client.bookmark('1234567890');
expect(result.success).toBe(true); expect(result.success).toBe(true);
@@ -170,7 +170,7 @@ describe('TwitterClient engagement', () => {
it('catches network errors', async () => { it('catches network errors', async () => {
mockFetch.mockRejectedValueOnce(new Error('Network error')); mockFetch.mockRejectedValueOnce(new Error('Network error'));
const client = new TwitterClient({ cookies: validCookies }); const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.like('1234567890'); const result = await client.like('1234567890');
expect(result.success).toBe(false); expect(result.success).toBe(false);
+115
View File
@@ -145,6 +145,121 @@ describe('TwitterClient home timeline', () => {
}); });
describe('pagination', () => { describe('pagination', () => {
it('returns the next cursor when stopping before the end', async () => {
mockFetch.mockResolvedValueOnce({
ok: true,
json: async () => ({
data: {
home: {
home_timeline_urt: {
instructions: [
{
entries: [
{
content: {
itemContent: {
tweet_results: {
result: {
rest_id: 'tweet1',
legacy: { full_text: 'First tweet', created_at: 'Mon Jan 06 00:00:00 +0000 2025' },
core: {
user_results: {
result: { rest_id: 'u1', legacy: { screen_name: 'user1', name: 'User 1' } },
},
},
},
},
},
},
},
{
content: {
cursorType: 'Bottom',
value: 'cursor123',
},
},
],
},
],
},
},
},
}),
});
const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.getHomeTimeline(1);
expect(result.success).toBe(true);
expect(result.nextCursor).toBe('cursor123');
});
it('resumes from a provided cursor', async () => {
mockFetch.mockResolvedValueOnce({
ok: true,
json: async () => makeHomeTimelineResponse('tweet2', 'Second page tweet', 'user2'),
});
const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.getHomeLatestTimeline(1, { cursor: 'resume-cursor' });
expect(result.success).toBe(true);
const callUrl = String(mockFetch.mock.calls[0]?.[0]);
const variables = JSON.parse(new URL(callUrl).searchParams.get('variables') ?? '{}') as { cursor?: string };
expect(variables.cursor).toBe('resume-cursor');
});
it('stops at maxPages and returns the cursor to resume', async () => {
mockFetch.mockResolvedValueOnce({
ok: true,
json: async () => ({
data: {
home: {
home_timeline_urt: {
instructions: [
{
entries: [
{
content: {
itemContent: {
tweet_results: {
result: {
rest_id: 'tweet1',
legacy: { full_text: 'First tweet', created_at: 'Mon Jan 06 00:00:00 +0000 2025' },
core: {
user_results: {
result: { rest_id: 'u1', legacy: { screen_name: 'user1', name: 'User 1' } },
},
},
},
},
},
},
},
{
content: {
cursorType: 'Bottom',
value: 'cursor-page-2',
},
},
],
},
],
},
},
},
}),
});
const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.getHomeTimeline(5, { maxPages: 1 });
expect(result.success).toBe(true);
expect(result.tweets).toHaveLength(1);
expect(result.nextCursor).toBe('cursor-page-2');
expect(mockFetch).toHaveBeenCalledTimes(1);
});
it('should deduplicate tweets across pages', async () => { it('should deduplicate tweets across pages', async () => {
// First page // First page
mockFetch.mockResolvedValueOnce({ mockFetch.mockResolvedValueOnce({
+10 -10
View File
@@ -1,6 +1,6 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'; import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { TwitterClient } from '../src/lib/twitter-client.js'; import { TwitterClient } from '../src/lib/twitter-client.js';
import { validCookies } from './twitter-client-fixtures.js'; import { testRelayBaseUrl } from './twitter-client-fixtures.js';
const originalFetch = global.fetch; const originalFetch = global.fetch;
@@ -38,7 +38,7 @@ describe('TwitterClient getUserAboutAccount', () => {
}), }),
}); });
const client = new TwitterClient({ cookies: validCookies }); const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.getUserAboutAccount('testuser'); const result = await client.getUserAboutAccount('testuser');
expect(result.success).toBe(true); expect(result.success).toBe(true);
@@ -67,7 +67,7 @@ describe('TwitterClient getUserAboutAccount', () => {
}), }),
}); });
const client = new TwitterClient({ cookies: validCookies }); const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.getUserAboutAccount('@testuser'); const result = await client.getUserAboutAccount('@testuser');
expect(result.success).toBe(true); expect(result.success).toBe(true);
@@ -75,7 +75,7 @@ describe('TwitterClient getUserAboutAccount', () => {
}); });
it('returns error for invalid username', async () => { it('returns error for invalid username', async () => {
const client = new TwitterClient({ cookies: validCookies }); const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.getUserAboutAccount(''); const result = await client.getUserAboutAccount('');
expect(result.success).toBe(false); expect(result.success).toBe(false);
@@ -95,7 +95,7 @@ describe('TwitterClient getUserAboutAccount', () => {
}), }),
}); });
const client = new TwitterClient({ cookies: validCookies }); const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.getUserAboutAccount('testuser'); const result = await client.getUserAboutAccount('testuser');
expect(result.success).toBe(false); expect(result.success).toBe(false);
@@ -111,7 +111,7 @@ describe('TwitterClient getUserAboutAccount', () => {
}), }),
}); });
const client = new TwitterClient({ cookies: validCookies }); const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.getUserAboutAccount('testuser'); const result = await client.getUserAboutAccount('testuser');
expect(result.success).toBe(false); expect(result.success).toBe(false);
@@ -125,7 +125,7 @@ describe('TwitterClient getUserAboutAccount', () => {
text: async () => 'Not Found', text: async () => 'Not Found',
}); });
const client = new TwitterClient({ cookies: validCookies }); const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.getUserAboutAccount('testuser'); const result = await client.getUserAboutAccount('testuser');
expect(result.success).toBe(false); expect(result.success).toBe(false);
@@ -139,7 +139,7 @@ describe('TwitterClient getUserAboutAccount', () => {
text: async () => 'Internal Server Error', text: async () => 'Internal Server Error',
}); });
const client = new TwitterClient({ cookies: validCookies }); const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.getUserAboutAccount('testuser'); const result = await client.getUserAboutAccount('testuser');
expect(result.success).toBe(false); expect(result.success).toBe(false);
@@ -149,7 +149,7 @@ describe('TwitterClient getUserAboutAccount', () => {
it('handles network errors', async () => { it('handles network errors', async () => {
mockFetch.mockRejectedValueOnce(new Error('Network error')); mockFetch.mockRejectedValueOnce(new Error('Network error'));
const client = new TwitterClient({ cookies: validCookies }); const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.getUserAboutAccount('testuser'); const result = await client.getUserAboutAccount('testuser');
expect(result.success).toBe(false); expect(result.success).toBe(false);
@@ -174,7 +174,7 @@ describe('TwitterClient getUserAboutAccount', () => {
}), }),
}); });
const client = new TwitterClient({ cookies: validCookies }); const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.getUserAboutAccount('testuser'); const result = await client.getUserAboutAccount('testuser');
expect(result.success).toBe(true); expect(result.success).toBe(true);
+180
View File
@@ -163,4 +163,184 @@ describe('TwitterClient getUserIdByUsername', () => {
expect(result.userId).toBe('99999'); expect(result.userId).toBe('99999');
expect(mockFetch).toHaveBeenCalledTimes(3); expect(mockFetch).toHaveBeenCalledTimes(3);
}); });
it('resolves a rich profile by screen name', async () => {
mockFetch.mockResolvedValueOnce({
ok: true,
status: 200,
json: async () => ({
data: {
user: {
result: {
__typename: 'User',
rest_id: '12345',
is_blue_verified: true,
verification_info: { reason: { verified_since_msec: '1700000000000' } },
avatar: { image_url: 'https://pbs.twimg.com/profile_images/123/avatar_normal.jpg' },
legacy: {
screen_name: 'testuser',
name: 'Test User',
description: 'Building tools',
location: 'Internet',
url: 'https://t.co/site',
created_at: 'Mon Jan 06 00:00:00 +0000 2025',
verified: false,
verified_type: 'Business',
followers_count: 123,
friends_count: 45,
profile_image_url_https: 'https://pbs.twimg.com/profile_images/123/legacy_normal.jpg',
entities: {
url: {
urls: [
{
url: 'https://t.co/site',
expanded_url: 'https://example.com',
display_url: 'example.com',
},
],
},
description: {
urls: [
{
url: 'https://t.co/bio',
expanded_url: 'https://bio.example',
display_url: 'bio.example',
},
],
},
},
},
affiliates_highlighted_label: {
label: {
description: 'Example Org',
url: { url: 'https://x.com/example' },
badge: { url: 'https://pbs.twimg.com/profile_images/org/badge.png' },
},
},
},
},
},
}),
});
const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.getUserProfile('@testuser');
expect(result).toEqual({
success: true,
profile: expect.objectContaining({
id: '12345',
username: 'testuser',
name: 'Test User',
description: 'Building tools',
location: 'Internet',
url: 'https://example.com',
verified: true,
verifiedType: 'Business',
followersCount: 123,
followingCount: 45,
profileImageUrl: 'https://pbs.twimg.com/profile_images/123/avatar_normal.jpg',
entities: expect.objectContaining({
url: expect.objectContaining({
urls: [expect.objectContaining({ expanded_url: 'https://example.com' })],
}),
}),
affiliation: {
description: 'Example Org',
url: 'https://x.com/example',
badgeUrl: 'https://pbs.twimg.com/profile_images/org/badge.png',
},
raw: expect.any(Object),
}),
});
});
it('resolves a rich profile by user id', async () => {
mockFetch.mockResolvedValueOnce({
ok: true,
status: 200,
json: async () => ({
data: {
user: {
result: {
__typename: 'User',
rest_id: '42',
core: {
screen_name: 'byid',
name: 'By Id',
created_at: 'Tue Feb 01 00:00:00 +0000 2022',
},
location: {
location: 'Vienna & London',
},
legacy: {
description: 'Lookup by id',
followers_count: 10,
friends_count: 2,
},
},
},
},
}),
});
const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.getUserProfile('42');
expect(result.success).toBe(true);
expect(result.profile).toMatchObject({
id: '42',
username: 'byid',
name: 'By Id',
description: 'Lookup by id',
location: 'Vienna & London',
createdAt: 'Tue Feb 01 00:00:00 +0000 2022',
followersCount: 10,
followingCount: 2,
});
expect(String(mockFetch.mock.calls[0]?.[0])).toContain('/UserByRestId?');
});
it('resolves profile batches with per-target errors', async () => {
mockFetch
.mockResolvedValueOnce({
ok: true,
status: 200,
json: async () => ({
data: {
user: {
result: {
__typename: 'User',
rest_id: '1',
legacy: { screen_name: 'alpha', name: 'Alpha' },
},
},
},
}),
})
.mockResolvedValueOnce({
ok: true,
status: 200,
json: async () => ({
data: {
user: {
result: {
__typename: 'UserUnavailable',
},
},
},
}),
});
const client = new TwitterClient({ relayBaseUrl: testRelayBaseUrl });
const result = await client.getUserProfiles(['alpha', 'missing']);
expect(result).toEqual({
success: true,
results: [
{ target: 'alpha', profile: expect.objectContaining({ id: '1', username: 'alpha' }) },
{ target: 'missing', error: 'User @missing not found or unavailable' },
],
});
});
}); });
+1
View File
@@ -5,3 +5,4 @@
- When the user asks to investigate odd API counts, do not change client-side limiting behavior unless they explicitly approve the behavior change. - When the user asks to investigate odd API counts, do not change client-side limiting behavior unless they explicitly approve the behavior change.
- When adding package registry publishing for this repository, use the `@yuta` package scope unless the user explicitly asks for another namespace. - When adding package registry publishing for this repository, use the `@yuta` package scope unless the user explicitly asks for another namespace.
- Gitea Actions secret and variable names are case-insensitive, alphanumeric or underscore only, and cannot start with `GITEA_` or `GITHUB_`; use names like `PACKAGE_TOKEN`. - Gitea Actions secret and variable names are case-insensitive, alphanumeric or underscore only, and cannot start with `GITEA_` or `GITHUB_`; use names like `PACKAGE_TOKEN`.
- When adapting upstream tests to this fork, run tests with `TWITTER_RELAY_BASE_URL` unset; local relay environment variables can hide missing explicit `relayBaseUrl` fixtures.