@elizaos/plugin-twitter 1.0.13 → 1.2.0

package/dist/index.d.ts

@@ -37,146 +37,6 @@ declare class TwitterAuth {
     hasToken(): boolean;
 }
 
-/**
- * Represents an array type for parameters used in the fetch function,
- * with the first element being input of type RequestInfo or URL,
- * and the second element being init of type RequestInit or optional if not provided.
- */
-type FetchParameters = [input: RequestInfo | URL, init?: RequestInit];
-/**
- * @typedef {Object} FetchTransformOptions
- * @property {Function} request Transforms the request options before a request is made. This executes after all of the default
- * parameters have been configured, and is stateless. It is safe to return new request options
- * objects.
- * @param {FetchParameters} args The request options.
- * @returns {FetchParameters|Promise<FetchParameters>} The transformed request options.
- *
- * @property {Function} response Transforms the response after a request completes. This executes immediately after the request
- * completes, and is stateless. It is safe to return a new response object.
- * @param {Response} response The response object.
- * @returns {Response|Promise<Response>} The transformed response object.
- */
-interface FetchTransformOptions {
-    /**
-     * Transforms the request options before a request is made. This executes after all of the default
-     * parameters have been configured, and is stateless. It is safe to return new request options
-     * objects.
-     * @param args The request options.
-     * @returns The transformed request options.
-     */
-    request: (...args: FetchParameters) => FetchParameters | Promise<FetchParameters>;
-    /**
-     * Transforms the response after a request completes. This executes immediately after the request
-     * completes, and is stateless. It is safe to return a new response object.
-     * @param response The response object.
-     * @returns The transformed response object.
-     */
-    response: (response: Response) => Response | Promise<Response>;
-}
-
-/**
- * A parsed profile object.
- */
-/**
- * Interface representing a user profile.
- * @typedef {Object} Profile
- * @property {string} [avatar] - The URL to the user's avatar.
- * @property {string} [banner] - The URL to the user's banner image.
- * @property {string} [biography] - The user's biography.
- * @property {string} [birthday] - The user's birthday.
- * @property {number} [followersCount] - The number of followers the user has.
- * @property {number} [followingCount] - The number of users the user is following.
- * @property {number} [friendsCount] - The number of friends the user has.
- * @property {number} [mediaCount] - The number of media items the user has posted.
- * @property {number} [statusesCount] - The number of statuses the user has posted.
- * @property {boolean} [isPrivate] - Indicates if the user's profile is private.
- * @property {boolean} [isVerified] - Indicates if the user account is verified.
- * @property {boolean} [isBlueVerified] - Indicates if the user account has blue verification badge.
- * @property {Date} [joined] - The date the user joined the platform.
- * @property {number} [likesCount] - The number of likes the user has received.
- * @property {number} [listedCount] - The number of times the user has been listed.
- * @property {string} location - The user's location.
- * @property {string} [name] - The user's name.
- * @property {string[]} [pinnedTweetIds] - The IDs of the user's pinned tweets.
- * @property {number} [tweetsCount] - The number of tweets the user has posted.
- * @property {string} [url] - The user's website URL.
- * @property {string} [userId] - The unique user ID.
- * @property {string} [username] - The user's username.
- * @property {string} [website] - The user's website.
- * @property {boolean} [canDm] - Indicates if the user can receive direct messages.
- */
-interface Profile {
-    avatar?: string;
-    banner?: string;
-    biography?: string;
-    birthday?: string;
-    followersCount?: number;
-    followingCount?: number;
-    friendsCount?: number;
-    mediaCount?: number;
-    statusesCount?: number;
-    isPrivate?: boolean;
-    isVerified?: boolean;
-    isBlueVerified?: boolean;
-    joined?: Date;
-    likesCount?: number;
-    listedCount?: number;
-    location: string;
-    name?: string;
-    pinnedTweetIds?: string[];
-    tweetsCount?: number;
-    url?: string;
-    userId?: string;
-    username?: string;
-    website?: string;
-    canDm?: boolean;
-}
-
-/**
- * A paginated tweets API response. The `next` field can be used to fetch the next page of results,
- * and the `previous` can be used to fetch the previous results (or results created after the
- * initial request)
- */
-/**
- * Interface representing the response from a query tweets request.
- * @typedef {Object} QueryTweetsResponse
- * @property {Tweet[]} tweets - An array of Tweet objects.
- * @property {string} [next] - Optional. The token for fetching the next page of tweets.
- * @property {string} [previous] - Optional. The token for fetching the previous page of tweets.
- */
-interface QueryTweetsResponse {
-    tweets: Tweet$1[];
-    next?: string;
-    previous?: string;
-}
-/**
- * A paginated profiles API response. The `next` field can be used to fetch the next page of results.
- */
-interface QueryProfilesResponse {
-    profiles: Profile[];
-    next?: string;
-    previous?: string;
-}
-
-/**
- * Interface representing a timeline article.
- * @typedef {Object} TimelineArticle
- * @property {string} id - The unique identifier for the article.
- * @property {string} articleId - The identifier for the article.
- * @property {string} title - The title of the article.
- * @property {string} previewText - The preview text of the article.
- * @property {string} [coverMediaUrl] - The URL of the cover media for the article. (Optional)
- * @property {string} text - The main text content of the article.
- */
-interface TimelineArticle {
-    id: string;
-    articleId: string;
-    title: string;
-    previewText: string;
-    coverMediaUrl?: string;
-    text: string;
-}
-
 /**
  * Interface representing a mention.
  * @typedef {Object} Mention
@@ -357,6 +217,98 @@ interface Retweeter {
 }
 type TweetQuery = Partial<Tweet$1> | ((tweet: Tweet$1) => boolean | Promise<boolean>);
 
+/**
+ * Common types for Twitter plugin API responses
+ */
+
+/**
+ * Response for paginated tweets queries
+ */
+interface QueryTweetsResponse {
+    tweets: Tweet$1[];
+    next?: string;
+    previous?: string;
+}
+/**
+ * Response for paginated profiles queries
+ */
+interface QueryProfilesResponse {
+    profiles: Profile[];
+    next?: string;
+    previous?: string;
+}
+/**
+ * Options for request transformation
+ */
+interface FetchTransformOptions {
+    /**
+     * Transforms the request options before a request is made.
+     */
+    request: (...args: [input: RequestInfo | URL, init?: RequestInit]) => [input: RequestInfo | URL, init?: RequestInit] | Promise<[input: RequestInfo | URL, init?: RequestInit]>;
+    /**
+     * Transforms the response after a request completes.
+     */
+    response: (response: Response) => Response | Promise<Response>;
+}
+
+/**
+ * A parsed profile object.
+ */
+/**
+ * Interface representing a user profile.
+ * @typedef {Object} Profile
+ * @property {string} [avatar] - The URL to the user's avatar.
+ * @property {string} [banner] - The URL to the user's banner image.
+ * @property {string} [biography] - The user's biography.
+ * @property {string} [birthday] - The user's birthday.
+ * @property {number} [followersCount] - The number of followers the user has.
+ * @property {number} [followingCount] - The number of users the user is following.
+ * @property {number} [friendsCount] - The number of friends the user has.
+ * @property {number} [mediaCount] - The number of media items the user has posted.
+ * @property {number} [statusesCount] - The number of statuses the user has posted.
+ * @property {boolean} [isPrivate] - Indicates if the user's profile is private.
+ * @property {boolean} [isVerified] - Indicates if the user account is verified.
+ * @property {boolean} [isBlueVerified] - Indicates if the user account has blue verification badge.
+ * @property {Date} [joined] - The date the user joined the platform.
+ * @property {number} [likesCount] - The number of likes the user has received.
+ * @property {number} [listedCount] - The number of times the user has been listed.
+ * @property {string} location - The user's location.
+ * @property {string} [name] - The user's name.
+ * @property {string[]} [pinnedTweetIds] - The IDs of the user's pinned tweets.
+ * @property {number} [tweetsCount] - The number of tweets the user has posted.
+ * @property {string} [url] - The user's website URL.
+ * @property {string} [userId] - The unique user ID.
+ * @property {string} [username] - The user's username.
+ * @property {string} [website] - The user's website.
+ * @property {boolean} [canDm] - Indicates if the user can receive direct messages.
+ */
+interface Profile {
+    avatar?: string;
+    banner?: string;
+    biography?: string;
+    birthday?: string;
+    followersCount?: number;
+    followingCount?: number;
+    friendsCount?: number;
+    mediaCount?: number;
+    statusesCount?: number;
+    isPrivate?: boolean;
+    isVerified?: boolean;
+    isBlueVerified?: boolean;
+    joined?: Date;
+    likesCount?: number;
+    listedCount?: number;
+    location: string;
+    name?: string;
+    pinnedTweetIds?: string[];
+    tweetsCount?: number;
+    url?: string;
+    userId?: string;
+    username?: string;
+    website?: string;
+    canDm?: boolean;
+}
+
 /**
  * The categories that can be used in Twitter searches.
  */
@@ -496,19 +448,21 @@ declare class Client {
      */
     fetchProfileFollowers(userId: string, maxProfiles: number, cursor?: string): Promise<QueryProfilesResponse>;
     /**
-     * Fetches the home timeline for the current user. (for you feed)
+     * Fetches the home timeline for the current user using Twitter API v2.
+     * Note: Twitter API v2 doesn't distinguish between "For You" and "Following" feeds.
      * @param count The number of tweets to fetch.
-     * @param seenTweetIds An array of tweet IDs that have already been seen.
-     * @returns A promise that resolves to the home timeline response.
+     * @param seenTweetIds An array of tweet IDs that have already been seen (not used in v2).
+     * @returns A promise that resolves to an array of tweets.
      */
-    fetchHomeTimeline(count: number, seenTweetIds: string[]): Promise<any[]>;
+    fetchHomeTimeline(count: number, seenTweetIds: string[]): Promise<Tweet$1[]>;
     /**
-     * Fetches the home timeline for the current user. (following feed)
+     * Fetches the home timeline for the current user (same as fetchHomeTimeline in v2).
+     * Twitter API v2 doesn't provide separate "Following" timeline endpoint.
      * @param count The number of tweets to fetch.
-     * @param seenTweetIds An array of tweet IDs that have already been seen.
-     * @returns A promise that resolves to the home timeline response.
+     * @param seenTweetIds An array of tweet IDs that have already been seen (not used in v2).
+     * @returns A promise that resolves to an array of tweets.
      */
-    fetchFollowingTimeline(count: number, seenTweetIds: string[]): Promise<any[]>;
+    fetchFollowingTimeline(count: number, seenTweetIds: string[]): Promise<Tweet$1[]>;
     getUserTweets(userId: string, maxTweets?: number, cursor?: string): Promise<{
         tweets: Tweet$1[];
         next?: string;
@@ -724,20 +678,6 @@ declare class Client {
      * Note: With API v2, logout is not applicable as we use API credentials.
      */
     logout(): Promise<void>;
-    /**
-     * Sets the optional cookie to be used in requests.
-     * @param _cookie The cookie to be used in requests.
-     * @deprecated This function no longer represents any part of Twitter's auth flow.
-     * @returns This client instance.
-     */
-    withCookie(_cookie: string): Client;
-    /**
-     * Sets the optional CSRF token to be used in requests.
-     * @param _token The CSRF token to be used in requests.
-     * @deprecated This function no longer represents any part of Twitter's auth flow.
-     * @returns This client instance.
-     */
-    withXCsrfToken(_token: string): Client;
     /**
      * Sends a quote tweet.
      * @param text The text of the tweet.
@@ -797,12 +737,6 @@ declare class Client {
     sendDirectMessage(conversationId: string, text: string): Promise<any>;
     private getAuthOptions;
     private handleResponse;
-    /**
-     * Fetches a article (long form tweet) by its ID.
-     * @param id The ID of the article to fetch. In the format of (http://x.com/i/article/id)
-     * @returns The {@link TimelineArticle} object, or `null` if it couldn't be fetched.
-     */
-    getArticle(id: string): Promise<TimelineArticle | null>;
     /**
      * Retrieves all users who retweeted the given tweet.
      * @param tweetId The ID of the tweet.
@@ -1089,7 +1023,6 @@ declare class ClientBase {
      * @param {number} [maxDepth=3] - The maximum depth allowed for parsing nested quotes/retweets.
      * @returns {Tweet} The parsed Tweet object.
      */
-    parseTweet(raw: any, depth?: number, maxDepth?: number): Tweet$1;
     state: any;
     constructor(runtime: IAgentRuntime, state: any);
     init(): Promise<void>;