twitterapi-io-client 1.0.1 → 1.0.3

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
@@ -82,6 +86,13 @@ const client = new TwitterAPIIOClient({
 | Get Article | `GET /twitter/article` | ✅ Supported | `client.tweets.getArticle(articleId)` |
 | Advanced Search | `GET /twitter/search` | ✅ Supported | `client.tweets.searchTweets(query, queryType?, cursor?)` |
 
+### ✅ Stream Endpoint
+
+| Endpoint | Method | Status | Notes |
+|----------|--------|--------|-------|
+| Add User to Monitor | `POST /oapi/x_user_stream/add_user_to_monitor_tweet` | ✅ Supported | `client.stream.addUserToMonitor(xUserName)` |
+| Remove User from Monitor | `POST /oapi/x_user_stream/remove_user_from_monitor_tweet` | ✅ Supported | `client.stream.removeUserFromMonitor(xUserName)` |
+
 ## Not Supported Endpoints
 
 The following endpoint categories are **not yet implemented**:
@@ -111,11 +122,6 @@ The following endpoint categories are **not yet implemented**:
 - `POST /oapi/webhook/filter/update` - Update Webhook/Websocket Tweet Filter Rule
 - `DELETE /oapi/webhook/filter/delete` - Delete Webhook/Websocket Tweet Filter Rule
 
-### ❌ Stream Endpoint
-
-- `POST /oapi/stream/add` - Add a twitter user to monitor his tweets
-- `POST /oapi/stream/remove` - Remove a user from monitor list
-
 ### ❌ Deprecated Endpoints
 
 The following endpoints are marked as deprecated in the API documentation and are not implemented:
@@ -132,8 +138,8 @@ The following endpoints are marked as deprecated in the API documentation and ar
 
 ## Implementation Status Summary
 
-- **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
+- **Fully Supported**: 29 endpoints (10 User endpoints + 2 List endpoints + 1 My endpoint + 5 Communities endpoints + 1 Trend endpoint + 1 Spaces endpoint + 7 Tweet endpoints + 2 Stream endpoints)
+- **Not Implemented**: ~14+ endpoints across multiple categories
 
 ## Contributing
 
@@ -143,3 +149,6 @@ Contributions are welcome! If you'd like to add support for additional endpoints
 
 For detailed API documentation, visit: [https://docs.twitterapi.io](https://docs.twitterapi.io)
 
+## Support the project
+
+If you need to create your twitterapi-io account and you want to support this client to help me mantain it and make your implementation easier for you, you can do so by using this [affiliate link](https://twitterapi.io/?ref=jordi666). 

package/dist/client.d.ts

@@ -6,6 +6,7 @@ import { CommunitiesApi } from "./resources/communities";
 import { TrendsApi } from "./resources/trends";
 import { SpacesApi } from "./resources/spaces";
 import { TweetsApi } from "./resources/tweets";
+import { StreamApi } from "./resources/stream";
 export interface TwitterAPIIOClientOptions extends HttpClientOptions {
 }
 export declare class TwitterAPIIOClient {
@@ -16,5 +17,6 @@ export declare class TwitterAPIIOClient {
     readonly trends: TrendsApi;
     readonly spaces: SpacesApi;
     readonly tweets: TweetsApi;
+    readonly stream: StreamApi;
     constructor(options: TwitterAPIIOClientOptions);
 }

package/dist/client.js

@@ -9,6 +9,7 @@ const communities_1 = require("./resources/communities");
 const trends_1 = require("./resources/trends");
 const spaces_1 = require("./resources/spaces");
 const tweets_1 = require("./resources/tweets");
+const stream_1 = require("./resources/stream");
 class TwitterAPIIOClient {
     users;
     myEndpoint;
@@ -17,6 +18,7 @@ class TwitterAPIIOClient {
     trends;
     spaces;
     tweets;
+    stream;
     constructor(options) {
         const http = new httpClient_1.HttpClient(options);
         this.users = new users_1.UsersApi(http);
@@ -26,6 +28,7 @@ class TwitterAPIIOClient {
         this.trends = new trends_1.TrendsApi(http);
         this.spaces = new spaces_1.SpacesApi(http);
         this.tweets = new tweets_1.TweetsApi(http);
+        this.stream = new stream_1.StreamApi(http);
     }
 }
 exports.TwitterAPIIOClient = TwitterAPIIOClient;

package/dist/resources/stream.d.ts

@@ -0,0 +1,8 @@
+import type { HttpClient } from "../httpClient";
+import type { StreamResponse } from "../types/stream";
+export declare class StreamApi {
+    private http;
+    constructor(http: HttpClient);
+    addUserToMonitor(xUserName: string): Promise<StreamResponse>;
+    removeUserFromMonitor(xUserName: string): Promise<StreamResponse>;
+}

package/dist/resources/stream.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamApi = void 0;
+class StreamApi {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    async addUserToMonitor(xUserName) {
+        const body = {
+            x_user_name: xUserName,
+        };
+        return this.http.request("/oapi/x_user_stream/add_user_to_monitor_tweet", {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: JSON.stringify(body),
+        });
+    }
+    async removeUserFromMonitor(xUserName) {
+        const body = {
+            x_user_name: xUserName,
+        };
+        return this.http.request("/oapi/x_user_stream/remove_user_from_monitor_tweet", {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: JSON.stringify(body),
+        });
+    }
+}
+exports.StreamApi = StreamApi;

package/dist/resources/users.js

@@ -50,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)
@@ -59,7 +59,7 @@ class UsersApi {
                 has_next_page: false,
                 next_cursor: "",
                 status: response.status || "success",
-                message: response.msg
+                msg: response.msg
             };
         }
         return response;
@@ -99,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
@@ -108,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/index.d.ts

@@ -5,3 +5,4 @@ export * from "./spaces";
 export * from "./trends";
 export * from "./list";
 export * from "./myEndpoint";
+export * from "./stream";

package/dist/types/index.js

@@ -21,3 +21,4 @@ __exportStar(require("./spaces"), exports);
 __exportStar(require("./trends"), exports);
 __exportStar(require("./list"), exports);
 __exportStar(require("./myEndpoint"), exports);
+__exportStar(require("./stream"), exports);

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/stream.d.ts

@@ -0,0 +1,10 @@
+export interface AddUserToMonitorRequest {
+    x_user_name: string;
+}
+export interface RemoveUserFromMonitorRequest {
+    x_user_name: string;
+}
+export interface StreamResponse {
+    status: "success" | "error";
+    msg: string;
+}

package/dist/types/stream.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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,19 +133,19 @@ 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[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "twitterapi-io-client",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "A TypeScript client library for the TwitterAPI.io API",
   "author": "jorvixsky",
   "license": "MIT",
@@ -22,7 +22,15 @@
     "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",
+    "test:stream": "vitest run test/stream.test.ts"
   },
   "devDependencies": {
     "@types/node": "24.10.0",
@@ -30,6 +38,6 @@
     "vitest": "4.0.15"
   },
   "repository": {
-    "url": "https://github.com/jorvixsky/twitterapi-io-client"
+    "url": "git+https://github.com/jorvixsky/twitterapi-io-client.git"
   }
-}
+}