twitterapi-io-client 1.0.0 → 1.0.2

package/README.md

@@ -10,12 +10,16 @@ npm install twitterapi-io-client
 
 ## Usage
 
+### Setup
+
 ```typescript
 import { TwitterAPIIOClient } from 'twitterapi-io-client';
 
 const client = new TwitterAPIIOClient({
   apiKey: 'your-api-key'
 });
+
+const accountInfo = await client.getUserProfileAbout("jorvixsky")
 ```
 
 ## Supported Endpoints
@@ -25,6 +29,7 @@ const client = new TwitterAPIIOClient({
 | Endpoint | Method | Status | Notes |
 |----------|--------|--------|-------|
 | Get User Profile About | `GET /twitter/user_about` | ✅ Supported | `client.users.getUserProfileAbout(userName)` |
+| Batch Get User Info By UserIds | `GET /twitter/user/batch_info_by_ids` | ✅ Supported | `client.users.batchGetUserInfoByUserIds(userIds)` |
 | Get User Info | `GET /twitter/user/info` | ✅ Supported | `client.users.getUserInfo(userName)` |
 | Get User Last Tweets | `GET /twitter/user/latest_tweets` | ✅ Supported | `client.users.getUserLatestTweets(userId?, userName?, cursor?, pageSize?, includeReplies?)` |
 | Get User Followers | `GET /twitter/user/followers` | ✅ Supported | `client.users.getUserFollowers(userName, cursor?, pageSize?)` |
@@ -33,7 +38,6 @@ const client = new TwitterAPIIOClient({
 | Check Follow Relationship | `GET /twitter/user/check_follow_relationship` | ✅ Supported | `client.users.checkFollowRelationship(sourceUserName, targetUserName)` |
 | Search user by keyword | `GET /twitter/user/search` | ✅ Supported | `client.users.searchUserByKeyword(query, cursor?)` |
 | Get User Verified Followers | `GET /twitter/user/verifiedFollowers` | ✅ Supported | `client.users.getUserVerifiedFollowers(userId, cursor?)` |
-| Batch Get User Info By UserIds | `GET /twitter/user/batch` | ❌ Not Supported | - |
 
 ### ✅ List Endpoint
 
@@ -132,7 +136,7 @@ The following endpoints are marked as deprecated in the API documentation and ar
 
 ## Implementation Status Summary
 
-- **Fully Supported**: 26 endpoints (9 User endpoints + 2 List endpoints + 1 My endpoint + 5 Communities endpoints + 1 Trend endpoint + 1 Spaces endpoint + 7 Tweet endpoints)
+- **Fully Supported**: 27 endpoints (10 User endpoints + 2 List endpoints + 1 My endpoint + 5 Communities endpoints + 1 Trend endpoint + 1 Spaces endpoint + 7 Tweet endpoints)
 - **Not Implemented**: ~16+ endpoints across multiple categories
 
 ## Contributing

package/dist/resources/users.d.ts

@@ -1,9 +1,10 @@
 import type { HttpClient } from "../httpClient";
-import type { FollowRelationshipResponse, SearchUserByKeywordResponse, UserFollowersResponse, UserFollowingsResponse, UserInfoResponse, UserLatestTweetsResponse, UserMentionsResponse, UserProfileAboutResponse, UserVerifiedFollowersResponse } from "../types/users";
+import type { BatchUserInfoByUserIdsResponse, FollowRelationshipResponse, SearchUserByKeywordResponse, UserFollowersResponse, UserFollowingsResponse, UserInfoResponse, UserLatestTweetsResponse, UserMentionsResponse, UserProfileAboutResponse, UserVerifiedFollowersResponse } from "../types/users";
 export declare class UsersApi {
     private http;
     constructor(http: HttpClient);
     getUserProfileAbout(userName: string): Promise<UserProfileAboutResponse>;
+    batchGetUserInfoByUserIds(userIds: string[]): Promise<BatchUserInfoByUserIdsResponse>;
     getUserInfo(userName: string): Promise<UserInfoResponse>;
     getUserLatestTweets(userId?: string, userName?: string, cursor?: string, pageSize?: number, includeReplies?: boolean): Promise<UserLatestTweetsResponse>;
     getUserFollowers(userName: string, cursor?: string, pageSize?: number): Promise<UserFollowersResponse>;

package/dist/resources/users.js

@@ -11,6 +11,11 @@ class UsersApi {
         const response = await this.http.request(`/twitter/user_about?${params.toString()}`);
         return response;
     }
+    async batchGetUserInfoByUserIds(userIds) {
+        const params = new URLSearchParams({ userIds: userIds.join(",") });
+        const response = await this.http.request(`/twitter/user/batch_info_by_ids?${params.toString()}`);
+        return response;
+    }
     async getUserInfo(userName) {
         const params = new URLSearchParams({ userName });
         const response = await this.http.request(`/twitter/user/info?${params.toString()}`);
@@ -45,7 +50,7 @@ class UsersApi {
                     has_next_page: data.has_next_page ?? false,
                     next_cursor: data.next_cursor ?? "",
                     status: data.status || response.status || "success",
-                    message: data.message || response.msg
+                    msg: data.msg || response.msg
                 };
             }
             // If data doesn't have tweets, return empty structure (API might be returning wrong data)
@@ -54,7 +59,7 @@ class UsersApi {
                 has_next_page: false,
                 next_cursor: "",
                 status: response.status || "success",
-                message: response.msg
+                msg: response.msg
             };
         }
         return response;
@@ -94,7 +99,7 @@ class UsersApi {
                     has_next_page: data.has_next_page ?? false,
                     next_cursor: data.next_cursor ?? "",
                     status: data.status || response.status || "success",
-                    message: data.message || response.msg
+                    msg: data.msg || response.msg
                 };
             }
             // If data doesn't have tweets, return empty structure
@@ -103,7 +108,7 @@ class UsersApi {
                 has_next_page: false,
                 next_cursor: "",
                 status: response.status || "success",
-                message: response.msg
+                msg: response.msg
             };
         }
         return response;

package/dist/types/communities.d.ts

@@ -11,33 +11,33 @@ export interface CommunityInfoResponse {
     banner_image?: string;
     profile_image?: string;
     status: string;
-    message?: string;
+    msg: string;
 }
 export interface CommunityMembersResponse {
     members: UserInfoResponse[];
     has_next_page: boolean;
     next_cursor: string;
     status: string;
-    msg?: string;
+    msg: string;
 }
 export interface CommunityModeratorsResponse {
     moderators: UserInfoResponse[];
     has_next_page: boolean;
     next_cursor: string;
     status: string;
-    msg?: string;
+    msg: string;
 }
 export interface CommunityTweetsResponse {
     tweets: Tweet[];
     has_next_page: boolean;
     next_cursor: string;
     status: string;
-    message?: string;
+    msg: string;
 }
 export interface CommunitySearchResponse {
     tweets: Tweet[];
     has_next_page: boolean;
     next_cursor: string;
     status: string;
-    message?: string;
+    msg: string;
 }

package/dist/types/list.d.ts

@@ -4,12 +4,12 @@ export interface ListFollowersResponse {
     has_next_page: boolean;
     next_cursor: string;
     status: string;
-    msg?: string;
+    msg: string;
 }
 export interface ListMembersResponse {
     members: UserInfoResponse[];
     has_next_page: boolean;
     next_cursor: string;
     status: string;
-    msg?: string;
+    msg: string;
 }

package/dist/types/spaces.d.ts

@@ -19,5 +19,5 @@ export interface SpaceDetailResponse {
     hosts?: UserInfoResponse[];
     speakers?: UserInfoResponse[];
     status: string;
-    message?: string;
+    msg: string;
 }

package/dist/types/trends.d.ts

@@ -15,5 +15,5 @@ export interface TrendsResponse {
     created_at: string;
     locations: TrendLocation[];
     status: string;
-    message?: string;
+    msg: string;
 }

package/dist/types/tweets.d.ts

@@ -44,33 +44,33 @@ export interface Tweet {
 export interface TweetsByIdsResponse {
     tweets: Tweet[];
     status: string;
-    message?: string;
+    msg: string;
 }
 export interface TweetRepliesResponse {
     tweets: Tweet[];
     has_next_page: boolean;
     next_cursor: string;
     status: string;
-    message?: string;
+    msg: string;
 }
 export interface TweetQuotationsResponse {
     tweets: Tweet[];
     has_next_page: boolean;
     next_cursor: string;
     status: string;
-    message?: string;
+    msg: string;
 }
 export interface TweetRetweetersResponse {
     retweeters: UserInfoResponse[];
     has_next_page: boolean;
     next_cursor: string;
     status: string;
-    message?: string;
+    msg: string;
 }
 export interface TweetThreadContextResponse {
     tweets: Tweet[];
     status: string;
-    message?: string;
+    msg: string;
 }
 export interface ArticleResponse {
     article: {
@@ -83,12 +83,12 @@ export interface ArticleResponse {
         content?: string;
     };
     status: string;
-    message?: string;
+    msg: string;
 }
 export interface SearchTweetsResponse {
     tweets: Tweet[];
     has_next_page: boolean;
     next_cursor: string;
     status: string;
-    message?: string;
+    msg: string;
 }

package/dist/types/users.d.ts

@@ -27,7 +27,7 @@ export interface UserInfoResponse {
     isAutomated: boolean;
     automatedBy: string;
     unavailable?: boolean;
-    message?: string;
+    msg: string;
     unavailableReason?: string;
     profile_bio: {
         description: string;
@@ -56,14 +56,14 @@ export interface UserFollowersResponse {
     has_next_page: boolean;
     next_cursor: string;
     status: string;
-    message?: string;
+    msg: string;
 }
 export interface UserFollowingsResponse {
     followings: UserInfoResponse[];
     has_next_page: boolean;
     next_cursor: string;
     status: string;
-    message?: string;
+    msg: string;
 }
 export interface UserProfileAboutResponse {
     data: {
@@ -118,14 +118,14 @@ export interface UserLatestTweetsResponse {
     has_next_page: boolean;
     next_cursor: string;
     status: string;
-    message?: string;
+    msg: string;
 }
 export interface UserMentionsResponse {
     tweets: Tweet[];
     has_next_page: boolean;
     next_cursor: string;
     status: string;
-    message?: string;
+    msg: string;
 }
 export interface FollowRelationshipResponse {
     data: {
@@ -133,17 +133,22 @@ export interface FollowRelationshipResponse {
         followed_by: boolean;
     };
     status: string;
-    message?: string;
+    msg: string;
 }
 export interface SearchUserByKeywordResponse {
     users: UserInfoResponse[];
     has_next_page: boolean;
     next_cursor: string;
     status: string;
-    msg?: string;
+    msg: string;
 }
 export interface UserVerifiedFollowersResponse {
     followers: UserInfoResponse[];
     status: string;
-    message?: string;
+    msg: string;
+}
+export interface BatchUserInfoByUserIdsResponse {
+    users: UserInfoResponse[];
+    status: string;
+    msg: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "twitterapi-io-client",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "A TypeScript client library for the TwitterAPI.io API",
   "author": "jorvixsky",
   "license": "MIT",
@@ -22,11 +22,21 @@
     "build": "tsc -p tsconfig.json",
     "prepublishOnly": "npm run build && npm test",
     "test": "vitest run",
-    "test:watch": "vitest"
+    "test:watch": "vitest",
+    "test:environment": "vitest run test/environment.test.ts",
+    "test:users": "vitest run test/users.test.ts",
+    "test:list": "vitest run test/list.test.ts",
+    "test:communities": "vitest run test/communities.test.ts",
+    "test:trends": "vitest run test/trends.test.ts",
+    "test:spaces": "vitest run test/spaces.test.ts",
+    "test:tweets": "vitest run test/tweets.test.ts"
   },
   "devDependencies": {
     "@types/node": "24.10.0",
     "typescript": "5.9.3",
     "vitest": "4.0.15"
+  },
+  "repository": {
+    "url": "git+https://github.com/jorvixsky/twitterapi-io-client.git"
   }
-}
+}