@youmind-openlab/rettiwt-api 1.0.0

package/dist/browser/browser/services/BrowserTweetService.js

@@ -0,0 +1,247 @@
+import { Extractors } from '../../collections/Extractors';
+import { ResourceType } from '../../enums/Resource';
+import { BrowserFetcherService } from './BrowserFetcherService';
+/**
+ * Browser-compatible tweet service.
+ * Handles interacting with resources related to tweets.
+ * Uses Blob/File API instead of fs for media uploads.
+ *
+ * @public
+ */
+export class BrowserTweetService extends BrowserFetcherService {
+    /**
+     * @param config - The browser config object for configuring the Rettiwt instance.
+     */
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * Bookmark a tweet.
+     *
+     * @param id - The ID of the tweet to be bookmarked.
+     * @returns Whether bookmarking was successful or not.
+     */
+    async bookmark(id) {
+        const resource = ResourceType.TWEET_BOOKMARK;
+        const response = await this.request(resource, {
+            id: id,
+        });
+        const data = Extractors[resource](response) ?? false;
+        return data;
+    }
+    async details(id) {
+        // If single ID
+        if (typeof id === 'string') {
+            const resource = ResourceType.TWEET_DETAILS;
+            const response = await this.request(resource, {
+                id: id,
+            });
+            const data = Extractors[resource](response, id);
+            return data;
+        }
+        // If multiple IDs
+        else {
+            const resource = ResourceType.TWEET_DETAILS_BULK;
+            const response = await this.request(resource, {
+                ids: id,
+            });
+            const data = Extractors[resource](response, id);
+            return data;
+        }
+    }
+    /**
+     * Like a tweet.
+     *
+     * @param id - The ID of the tweet to be liked.
+     * @returns Whether liking was successful or not.
+     */
+    async like(id) {
+        const resource = ResourceType.TWEET_LIKE;
+        const response = await this.request(resource, {
+            id: id,
+        });
+        const data = Extractors[resource](response) ?? false;
+        return data;
+    }
+    /**
+     * Get the list of users who liked a tweet.
+     *
+     * @param id - The ID of the target tweet.
+     * @param count - The number of likers to fetch, must be <= 100.
+     * @param cursor - The cursor to the batch of likers to fetch.
+     * @returns The list of users who liked the target tweet.
+     */
+    async likers(id, count, cursor) {
+        const resource = ResourceType.TWEET_LIKERS;
+        const response = await this.request(resource, {
+            id: id,
+            count: count,
+            cursor: cursor,
+        });
+        const data = Extractors[resource](response);
+        return data;
+    }
+    /**
+     * Post a new tweet.
+     *
+     * @param tweet - The tweet to be posted.
+     * @returns The ID of the posted tweet, or undefined if posting failed.
+     */
+    async post(tweet) {
+        const resource = ResourceType.TWEET_POST;
+        const response = await this.request(resource, {
+            tweet: tweet,
+        });
+        const data = Extractors[resource](response);
+        return data;
+    }
+    /**
+     * Get the replies to a tweet.
+     *
+     * @param id - The ID of the target tweet.
+     * @param cursor - The cursor to the batch of replies to fetch.
+     * @param sortBy - The type of sorting for the replies.
+     * @returns The list of replies to the target tweet.
+     */
+    async replies(id, cursor, sortBy) {
+        const resource = ResourceType.TWEET_REPLIES;
+        const response = await this.request(resource, {
+            id: id,
+            cursor: cursor,
+            sortBy: sortBy,
+        });
+        const data = Extractors[resource](response);
+        return data;
+    }
+    /**
+     * Retweet a tweet.
+     *
+     * @param id - The ID of the tweet to be retweeted.
+     * @returns Whether retweeting was successful or not.
+     */
+    async retweet(id) {
+        const resource = ResourceType.TWEET_RETWEET;
+        const response = await this.request(resource, {
+            id: id,
+        });
+        const data = Extractors[resource](response) ?? false;
+        return data;
+    }
+    /**
+     * Get the list of users who retweeted a tweet.
+     *
+     * @param id - The ID of the target tweet.
+     * @param count - The number of retweeters to fetch, must be <= 100.
+     * @param cursor - The cursor to the batch of retweeters to fetch.
+     * @returns The list of users who retweeted the target tweet.
+     */
+    async retweeters(id, count, cursor) {
+        const resource = ResourceType.TWEET_RETWEETERS;
+        const response = await this.request(resource, {
+            id: id,
+            count: count,
+            cursor: cursor,
+        });
+        const data = Extractors[resource](response);
+        return data;
+    }
+    /**
+     * Search for tweets.
+     *
+     * @param filter - The filter for searching tweets.
+     * @param count - The number of tweets to fetch, must be <= 100.
+     * @param cursor - The cursor to the batch of tweets to fetch.
+     * @returns The list of tweets matching the given filter.
+     */
+    async search(filter, count, cursor) {
+        const resource = ResourceType.TWEET_SEARCH;
+        const response = await this.request(resource, {
+            filter: filter,
+            count: count,
+            cursor: cursor,
+        });
+        const data = Extractors[resource](response);
+        return data;
+    }
+    /**
+     * Unbookmark a tweet.
+     *
+     * @param id - The ID of the tweet to be unbookmarked.
+     * @returns Whether unbookmarking was successful or not.
+     */
+    async unbookmark(id) {
+        const resource = ResourceType.TWEET_UNBOOKMARK;
+        const response = await this.request(resource, {
+            id: id,
+        });
+        const data = Extractors[resource](response) ?? false;
+        return data;
+    }
+    /**
+     * Unlike a tweet.
+     *
+     * @param id - The ID of the tweet to be unliked.
+     * @returns Whether unliking was successful or not.
+     */
+    async unlike(id) {
+        const resource = ResourceType.TWEET_UNLIKE;
+        const response = await this.request(resource, {
+            id: id,
+        });
+        const data = Extractors[resource](response) ?? false;
+        return data;
+    }
+    /**
+     * Unpost (delete) a tweet.
+     *
+     * @param id - The ID of the tweet to be unposted.
+     * @returns Whether unposting was successful or not.
+     */
+    async unpost(id) {
+        const resource = ResourceType.TWEET_UNPOST;
+        const response = await this.request(resource, {
+            id: id,
+        });
+        const data = Extractors[resource](response) ?? false;
+        return data;
+    }
+    /**
+     * Unretweet a tweet.
+     *
+     * @param id - The ID of the tweet to be unretweeted.
+     * @returns Whether unretweeting was successful or not.
+     */
+    async unretweet(id) {
+        const resource = ResourceType.TWEET_UNRETWEET;
+        const response = await this.request(resource, {
+            id: id,
+        });
+        const data = Extractors[resource](response) ?? false;
+        return data;
+    }
+    /**
+     * Upload media for use in tweets.
+     * Uses browser-native Blob/File API instead of fs.
+     *
+     * @param media - The media to upload (Blob, File, or ArrayBuffer).
+     * @returns The media ID string for use in tweet posts.
+     */
+    async upload(media) {
+        // Get size from Blob/File/ArrayBuffer
+        const size = media instanceof ArrayBuffer ? media.byteLength : media.size;
+        // INITIALIZE
+        const id = (await this.request(ResourceType.MEDIA_UPLOAD_INITIALIZE, {
+            upload: { size: size },
+        })).media_id_string;
+        // APPEND - convert ArrayBuffer to Blob if needed
+        // Note: We need to convert Blob to ArrayBuffer for the request
+        const arrayBuffer = media instanceof ArrayBuffer ? media : await media.arrayBuffer();
+        await this.request(ResourceType.MEDIA_UPLOAD_APPEND, {
+            upload: { id: id, media: arrayBuffer },
+        });
+        // FINALIZE
+        await this.request(ResourceType.MEDIA_UPLOAD_FINALIZE, { upload: { id: id } });
+        return id;
+    }
+}
+//# sourceMappingURL=BrowserTweetService.js.map

package/dist/browser/browser/services/BrowserTweetService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrowserTweetService.js","sourceRoot":"","sources":["../../../../src/browser/services/BrowserTweetService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AA2BpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAQhE;;;;;;GAMG;AACH,MAAM,OAAO,mBAAoB,SAAQ,qBAAqB;IAC7D;;OAEG;IACH,YAAmB,MAA4B;QAC9C,KAAK,CAAC,MAAM,CAAC,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CAAC,EAAU;QAC/B,MAAM,QAAQ,GAAG,YAAY,CAAC,cAAc,CAAC;QAE7C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAyB,QAAQ,EAAE;YACrE,EAAE,EAAE,EAAE;SACN,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACb,CAAC;IAkBM,KAAK,CAAC,OAAO,CAAC,EAAqB;QACzC,eAAe;QACf,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;YAC5B,MAAM,QAAQ,GAAG,YAAY,CAAC,aAAa,CAAC;YAE5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAwB,QAAQ,EAAE;gBACpE,EAAE,EAAE,EAAE;aACN,CAAC,CAAC;YAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAEhD,OAAO,IAAI,CAAC;QACb,CAAC;QACD,kBAAkB;aACb,CAAC;YACL,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC;YAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAA4B,QAAQ,EAAE;gBACxE,GAAG,EAAE,EAAE;aACP,CAAC,CAAC;YAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAEhD,OAAO,IAAI,CAAC;QACb,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI,CAAC,EAAU;QAC3B,MAAM,QAAQ,GAAG,YAAY,CAAC,UAAU,CAAC;QAEzC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAqB,QAAQ,EAAE;YACjE,EAAE,EAAE,EAAE;SACN,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,KAAc,EAAE,MAAe;QAC9D,MAAM,QAAQ,GAAG,YAAY,CAAC,YAAY,CAAC;QAE3C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,QAAQ,EAAE;YACnE,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI,CAAC,KAAgB;QACjC,MAAM,QAAQ,GAAG,YAAY,CAAC,UAAU,CAAC;QAEzC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAqB,QAAQ,EAAE;YACjE,KAAK,EAAE,KAAK;SACZ,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,OAAO,CACnB,EAAU,EACV,MAAe,EACf,MAA6B;QAE7B,MAAM,QAAQ,GAAG,YAAY,CAAC,aAAa,CAAC;QAE5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAwB,QAAQ,EAAE;YACpE,EAAE,EAAE,EAAE;YACN,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAC,EAAU;QAC9B,MAAM,QAAQ,GAAG,YAAY,CAAC,aAAa,CAAC;QAE5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAwB,QAAQ,EAAE;YACpE,EAAE,EAAE,EAAE;SACN,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,UAAU,CAAC,EAAU,EAAE,KAAc,EAAE,MAAe;QAClE,MAAM,QAAQ,GAAG,YAAY,CAAC,gBAAgB,CAAC;QAE/C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAA2B,QAAQ,EAAE;YACvE,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,MAAM,CAAC,MAAoB,EAAE,KAAc,EAAE,MAAe;QACxE,MAAM,QAAQ,GAAG,YAAY,CAAC,YAAY,CAAC;QAE3C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,QAAQ,EAAE;YACnE,MAAM,EAAE,MAAM;YACd,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,UAAU,CAAC,EAAU;QACjC,MAAM,QAAQ,GAAG,YAAY,CAAC,gBAAgB,CAAC;QAE/C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAA2B,QAAQ,EAAE;YACvE,EAAE,EAAE,EAAE;SACN,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU;QAC7B,MAAM,QAAQ,GAAG,YAAY,CAAC,YAAY,CAAC;QAE3C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,QAAQ,EAAE;YACnE,EAAE,EAAE,EAAE;SACN,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU;QAC7B,MAAM,QAAQ,GAAG,YAAY,CAAC,YAAY,CAAC;QAE3C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,QAAQ,EAAE;YACnE,EAAE,EAAE,EAAE;SACN,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CAAC,EAAU;QAChC,MAAM,QAAQ,GAAG,YAAY,CAAC,eAAe,CAAC;QAE9C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAA0B,QAAQ,EAAE;YACtE,EAAE,EAAE,EAAE;SACN,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAAC,KAAmB;QACtC,sCAAsC;QACtC,MAAM,IAAI,GAAG,KAAK,YAAY,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;QAE1E,aAAa;QACb,MAAM,EAAE,GAAW,CAClB,MAAM,IAAI,CAAC,OAAO,CAAiC,YAAY,CAAC,uBAAuB,EAAE;YACxF,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE;SACtB,CAAC,CACF,CAAC,eAAe,CAAC;QAElB,iDAAiD;QACjD,+DAA+D;QAC/D,MAAM,WAAW,GAAG,KAAK,YAAY,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,WAAW,EAAE,CAAC;QACrF,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,mBAAmB,EAAE;YACpD,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,WAAW,EAAE;SACtC,CAAC,CAAC;QAEH,WAAW;QACX,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,qBAAqB,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAE/E,OAAO,EAAE,CAAC;IACX,CAAC;CACD"}

package/dist/browser/browser/services/BrowserUserService.d.ts

@@ -0,0 +1,104 @@
+import { CursoredData } from '../../models/data/CursoredData';
+import { Tweet } from '../../models/data/Tweet';
+import { User } from '../../models/data/User';
+import { BrowserFetcherService } from './BrowserFetcherService';
+import { BrowserRettiwtConfig } from '../config/BrowserRettiwtConfig';
+/**
+ * Browser-compatible user service.
+ * Handles interacting with resources related to user account.
+ *
+ * @public
+ */
+export declare class BrowserUserService extends BrowserFetcherService {
+    /**
+     * @param config - The browser config object for configuring the Rettiwt instance.
+     */
+    constructor(config: BrowserRettiwtConfig);
+    /**
+     * Get the details of the currently logged in user.
+     *
+     * @returns The details of the logged in user.
+     */
+    details(): Promise<User | undefined>;
+    /**
+     * Get the details of a user by username.
+     *
+     * @param id - The username of the target user.
+     * @returns The details of the user.
+     */
+    detailsByUserName(id: string): Promise<User | undefined>;
+    /**
+     * Get the details of a user by ID.
+     *
+     * @param id - The ID of the target user.
+     * @returns The details of the user.
+     */
+    detailsById(id: string): Promise<User | undefined>;
+    /**
+     * Get the list of users following a user.
+     *
+     * @param id - The ID of the target user.
+     * @param count - The number of followers to fetch, must be <= 100.
+     * @param cursor - The cursor to the batch of followers to fetch.
+     * @returns The list of users following the target user.
+     */
+    followers(id: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
+    /**
+     * Get the list of users followed by a user.
+     *
+     * @param id - The ID of the target user.
+     * @param count - The number of following to fetch, must be <= 100.
+     * @param cursor - The cursor to the batch of following to fetch.
+     * @returns The list of users followed by the target user.
+     */
+    following(id: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
+    /**
+     * Get the list of tweets liked by a user.
+     *
+     * @param id - The ID of the target user.
+     * @param count - The number of likes to fetch, must be <= 100.
+     * @param cursor - The cursor to the batch of likes to fetch.
+     * @returns The list of tweets liked by the target user.
+     */
+    likes(id: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
+    /**
+     * Get the timeline of a user.
+     *
+     * @param id - The ID of the target user.
+     * @param count - The number of tweets to fetch, must be <= 100.
+     * @param cursor - The cursor to the batch of tweets to fetch.
+     * @returns The timeline of the target user.
+     */
+    timeline(id: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
+    /**
+     * Follow a user.
+     *
+     * @param id - The ID of the user to follow.
+     * @returns Whether the follow was successful.
+     */
+    follow(id: string): Promise<boolean>;
+    /**
+     * Unfollow a user.
+     *
+     * @param id - The ID of the user to unfollow.
+     * @returns Whether the unfollow was successful.
+     */
+    unfollow(id: string): Promise<boolean>;
+    /**
+     * Search for users.
+     *
+     * @param query - The search query.
+     * @param count - The number of users to fetch.
+     * @param cursor - The cursor for pagination.
+     * @returns The list of users matching the query.
+     */
+    search(userName: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
+    /**
+     * Get the bookmarks of the logged in user.
+     *
+     * @param count - The number of bookmarks to fetch, must be <= 100.
+     * @param cursor - The cursor to the batch of bookmarks to fetch.
+     * @returns The list of bookmarked tweets.
+     */
+    bookmarks(count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
+}

package/dist/browser/browser/services/BrowserUserService.js

@@ -0,0 +1,193 @@
+import { Extractors } from '../../collections/Extractors';
+import { ResourceType } from '../../enums/Resource';
+import { BrowserFetcherService } from './BrowserFetcherService';
+/**
+ * Browser-compatible user service.
+ * Handles interacting with resources related to user account.
+ *
+ * @public
+ */
+export class BrowserUserService extends BrowserFetcherService {
+    /**
+     * @param config - The browser config object for configuring the Rettiwt instance.
+     */
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * Get the details of the currently logged in user.
+     *
+     * @returns The details of the logged in user.
+     */
+    async details() {
+        const resource = ResourceType.USER_DETAILS_BY_ID;
+        const response = await this.request(resource, {
+            id: this.config.userId,
+        });
+        const data = Extractors[resource](response);
+        return data;
+    }
+    /**
+     * Get the details of a user by username.
+     *
+     * @param id - The username of the target user.
+     * @returns The details of the user.
+     */
+    async detailsByUserName(id) {
+        const resource = ResourceType.USER_DETAILS_BY_USERNAME;
+        const response = await this.request(resource, {
+            id: id,
+        });
+        const data = Extractors[resource](response);
+        return data;
+    }
+    /**
+     * Get the details of a user by ID.
+     *
+     * @param id - The ID of the target user.
+     * @returns The details of the user.
+     */
+    async detailsById(id) {
+        const resource = ResourceType.USER_DETAILS_BY_ID;
+        const response = await this.request(resource, {
+            id: id,
+        });
+        const data = Extractors[resource](response);
+        return data;
+    }
+    /**
+     * Get the list of users following a user.
+     *
+     * @param id - The ID of the target user.
+     * @param count - The number of followers to fetch, must be <= 100.
+     * @param cursor - The cursor to the batch of followers to fetch.
+     * @returns The list of users following the target user.
+     */
+    async followers(id, count, cursor) {
+        const resource = ResourceType.USER_FOLLOWERS;
+        const response = await this.request(resource, {
+            id: id,
+            count: count,
+            cursor: cursor,
+        });
+        const data = Extractors[resource](response);
+        return data;
+    }
+    /**
+     * Get the list of users followed by a user.
+     *
+     * @param id - The ID of the target user.
+     * @param count - The number of following to fetch, must be <= 100.
+     * @param cursor - The cursor to the batch of following to fetch.
+     * @returns The list of users followed by the target user.
+     */
+    async following(id, count, cursor) {
+        const resource = ResourceType.USER_FOLLOWING;
+        const response = await this.request(resource, {
+            id: id,
+            count: count,
+            cursor: cursor,
+        });
+        const data = Extractors[resource](response);
+        return data;
+    }
+    /**
+     * Get the list of tweets liked by a user.
+     *
+     * @param id - The ID of the target user.
+     * @param count - The number of likes to fetch, must be <= 100.
+     * @param cursor - The cursor to the batch of likes to fetch.
+     * @returns The list of tweets liked by the target user.
+     */
+    async likes(id, count, cursor) {
+        const resource = ResourceType.USER_LIKES;
+        const response = await this.request(resource, {
+            id: id,
+            count: count,
+            cursor: cursor,
+        });
+        const data = Extractors[resource](response);
+        return data;
+    }
+    /**
+     * Get the timeline of a user.
+     *
+     * @param id - The ID of the target user.
+     * @param count - The number of tweets to fetch, must be <= 100.
+     * @param cursor - The cursor to the batch of tweets to fetch.
+     * @returns The timeline of the target user.
+     */
+    async timeline(id, count, cursor) {
+        const resource = ResourceType.USER_TIMELINE;
+        const response = await this.request(resource, {
+            id: id,
+            count: count,
+            cursor: cursor,
+        });
+        const data = Extractors[resource](response);
+        return data;
+    }
+    /**
+     * Follow a user.
+     *
+     * @param id - The ID of the user to follow.
+     * @returns Whether the follow was successful.
+     */
+    async follow(id) {
+        const resource = ResourceType.USER_FOLLOW;
+        const response = await this.request(resource, {
+            id: id,
+        });
+        const data = Extractors[resource](response) ?? false;
+        return data;
+    }
+    /**
+     * Unfollow a user.
+     *
+     * @param id - The ID of the user to unfollow.
+     * @returns Whether the unfollow was successful.
+     */
+    async unfollow(id) {
+        const resource = ResourceType.USER_UNFOLLOW;
+        const response = await this.request(resource, {
+            id: id,
+        });
+        const data = Extractors[resource](response) ?? false;
+        return data;
+    }
+    /**
+     * Search for users.
+     *
+     * @param query - The search query.
+     * @param count - The number of users to fetch.
+     * @param cursor - The cursor for pagination.
+     * @returns The list of users matching the query.
+     */
+    async search(userName, count, cursor) {
+        const resource = ResourceType.USER_SEARCH;
+        const response = await this.request(resource, {
+            id: userName,
+            count: count,
+            cursor: cursor,
+        });
+        const data = Extractors[resource](response);
+        return data;
+    }
+    /**
+     * Get the bookmarks of the logged in user.
+     *
+     * @param count - The number of bookmarks to fetch, must be <= 100.
+     * @param cursor - The cursor to the batch of bookmarks to fetch.
+     * @returns The list of bookmarked tweets.
+     */
+    async bookmarks(count, cursor) {
+        const resource = ResourceType.USER_BOOKMARKS;
+        const response = await this.request(resource, {
+            count: count,
+            cursor: cursor,
+        });
+        const data = Extractors[resource](response);
+        return data;
+    }
+}
+//# sourceMappingURL=BrowserUserService.js.map

package/dist/browser/browser/services/BrowserUserService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrowserUserService.js","sourceRoot":"","sources":["../../../../src/browser/services/BrowserUserService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAkCpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAGhE;;;;;GAKG;AACH,MAAM,OAAO,kBAAmB,SAAQ,qBAAqB;IAC5D;;OAEG;IACH,YAAmB,MAA4B;QAC9C,KAAK,CAAC,MAAM,CAAC,CAAC;IACf,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,QAAQ,EAAE;YACnE,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;SACtB,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,iBAAiB,CAAC,EAAU;QACxC,MAAM,QAAQ,GAAG,YAAY,CAAC,wBAAwB,CAAC;QAEvD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,QAAQ,EAAE;YACnE,EAAE,EAAE,EAAE;SACN,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,WAAW,CAAC,EAAU;QAClC,MAAM,QAAQ,GAAG,YAAY,CAAC,kBAAkB,CAAC;QAEjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,QAAQ,EAAE;YACnE,EAAE,EAAE,EAAE;SACN,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,SAAS,CAAC,EAAU,EAAE,KAAc,EAAE,MAAe;QACjE,MAAM,QAAQ,GAAG,YAAY,CAAC,cAAc,CAAC;QAE7C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAyB,QAAQ,EAAE;YACrE,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,SAAS,CAAC,EAAU,EAAE,KAAc,EAAE,MAAe;QACjE,MAAM,QAAQ,GAAG,YAAY,CAAC,cAAc,CAAC;QAE7C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAyB,QAAQ,EAAE;YACrE,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,KAAK,CAAC,EAAU,EAAE,KAAc,EAAE,MAAe;QAC7D,MAAM,QAAQ,GAAG,YAAY,CAAC,UAAU,CAAC;QAEzC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAqB,QAAQ,EAAE;YACjE,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,KAAc,EAAE,MAAe;QAChE,MAAM,QAAQ,GAAG,YAAY,CAAC,aAAa,CAAC;QAE5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAsB,QAAQ,EAAE;YAClE,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU;QAC7B,MAAM,QAAQ,GAAG,YAAY,CAAC,WAAW,CAAC;QAE1C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAsB,QAAQ,EAAE;YAClE,EAAE,EAAE,EAAE;SACN,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CAAC,EAAU;QAC/B,MAAM,QAAQ,GAAG,YAAY,CAAC,aAAa,CAAC;QAE5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAwB,QAAQ,EAAE;YACpE,EAAE,EAAE,EAAE;SACN,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,MAAM,CAAC,QAAgB,EAAE,KAAc,EAAE,MAAe;QACpE,MAAM,QAAQ,GAAG,YAAY,CAAC,WAAW,CAAC;QAE1C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAsB,QAAQ,EAAE;YAClE,EAAE,EAAE,QAAQ;YACZ,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAC,KAAc,EAAE,MAAe;QACrD,MAAM,QAAQ,GAAG,YAAY,CAAC,cAAc,CAAC;QAE7C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAyB,QAAQ,EAAE;YACrE,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;CACD"}

package/dist/browser/collections/Extractors.d.ts

@@ -0,0 +1,116 @@
+import { Analytics } from '../models/data/Analytics';
+import { BookmarkFolder } from '../models/data/BookmarkFolder';
+import { Conversation } from '../models/data/Conversation';
+import { CursoredData } from '../models/data/CursoredData';
+import { Inbox } from '../models/data/Inbox';
+import { List } from '../models/data/List';
+import { Notification } from '../models/data/Notification';
+import { Tweet } from '../models/data/Tweet';
+import { User } from '../models/data/User';
+import { IConversationTimelineResponse } from '../types/raw/dm/Conversation';
+import { IInboxInitialResponse } from '../types/raw/dm/InboxInitial';
+import { IInboxTimelineResponse } from '../types/raw/dm/InboxTimeline';
+import { IListMemberAddResponse } from '../types/raw/list/AddMember';
+import { IListDetailsResponse } from '../types/raw/list/Details';
+import { IListMembersResponse } from '../types/raw/list/Members';
+import { IListMemberRemoveResponse } from '../types/raw/list/RemoveMember';
+import { IListTweetsResponse } from '../types/raw/list/Tweets';
+import { IMediaInitializeUploadResponse } from '../types/raw/media/InitalizeUpload';
+import { ITweetBookmarkResponse } from '../types/raw/tweet/Bookmark';
+import { ITweetDetailsResponse } from '../types/raw/tweet/Details';
+import { ITweetDetailsBulkResponse } from '../types/raw/tweet/DetailsBulk';
+import { ITweetLikeResponse } from '../types/raw/tweet/Like';
+import { ITweetLikersResponse } from '../types/raw/tweet/Likers';
+import { ITweetPostResponse } from '../types/raw/tweet/Post';
+import { ITweetRepliesResponse } from '../types/raw/tweet/Replies';
+import { ITweetRetweetResponse } from '../types/raw/tweet/Retweet';
+import { ITweetRetweetersResponse } from '../types/raw/tweet/Retweeters';
+import { ITweetScheduleResponse } from '../types/raw/tweet/Schedule';
+import { ITweetSearchResponse } from '../types/raw/tweet/Search';
+import { ITweetUnbookmarkResponse } from '../types/raw/tweet/Unbookmark';
+import { ITweetUnlikeResponse } from '../types/raw/tweet/Unlike';
+import { ITweetUnpostResponse } from '../types/raw/tweet/Unpost';
+import { ITweetUnretweetResponse } from '../types/raw/tweet/Unretweet';
+import { ITweetUnscheduleResponse } from '../types/raw/tweet/Unschedule';
+import { IUserAffiliatesResponse } from '../types/raw/user/Affiliates';
+import { IUserAnalyticsResponse } from '../types/raw/user/Analytics';
+import { IUserBookmarkFoldersResponse } from '../types/raw/user/BookmarkFolders';
+import { IUserBookmarkFolderTweetsResponse } from '../types/raw/user/BookmarkFolderTweets';
+import { IUserBookmarksResponse } from '../types/raw/user/Bookmarks';
+import { IUserDetailsResponse } from '../types/raw/user/Details';
+import { IUserDetailsBulkResponse } from '../types/raw/user/DetailsBulk';
+import { IUserFollowResponse } from '../types/raw/user/Follow';
+import { IUserFollowedResponse } from '../types/raw/user/Followed';
+import { IUserFollowersResponse } from '../types/raw/user/Followers';
+import { IUserFollowingResponse } from '../types/raw/user/Following';
+import { IUserHighlightsResponse } from '../types/raw/user/Highlights';
+import { IUserLikesResponse } from '../types/raw/user/Likes';
+import { IUserListsResponse } from '../types/raw/user/Lists';
+import { IUserMediaResponse } from '../types/raw/user/Media';
+import { IUserNotificationsResponse } from '../types/raw/user/Notifications';
+import { IUserProfileUpdateResponse } from '../types/raw/user/ProfileUpdate';
+import { IUserRecommendedResponse } from '../types/raw/user/Recommended';
+import { IUserSearchResponse } from '../types/raw/user/Search';
+import { IUserSubscriptionsResponse } from '../types/raw/user/Subscriptions';
+import { IUserTweetsResponse } from '../types/raw/user/Tweets';
+import { IUserTweetsAndRepliesResponse } from '../types/raw/user/TweetsAndReplies';
+import { IUserUnfollowResponse } from '../types/raw/user/Unfollow';
+/**
+ * Collection of data extractors for each resource.
+ *
+ * @internal
+ */
+export declare const Extractors: {
+    LIST_DETAILS: (response: IListDetailsResponse, id: string) => List | undefined;
+    LIST_MEMBERS: (response: IListMembersResponse) => CursoredData<User>;
+    LIST_MEMBER_ADD: (response: IListMemberAddResponse) => number | undefined;
+    LIST_MEMBER_REMOVE: (response: IListMemberRemoveResponse) => number | undefined;
+    LIST_TWEETS: (response: IListTweetsResponse) => CursoredData<Tweet>;
+    MEDIA_UPLOAD_APPEND: () => void;
+    MEDIA_UPLOAD_FINALIZE: () => void;
+    MEDIA_UPLOAD_INITIALIZE: (response: IMediaInitializeUploadResponse) => string;
+    DM_CONVERSATION: (response: IConversationTimelineResponse) => Conversation | undefined;
+    DM_INBOX_INITIAL_STATE: (response: IInboxInitialResponse) => Inbox;
+    DM_INBOX_TIMELINE: (response: IInboxTimelineResponse) => Inbox;
+    TWEET_BOOKMARK: (response: ITweetBookmarkResponse) => boolean;
+    TWEET_DETAILS: (response: ITweetDetailsResponse, id: string) => Tweet | undefined;
+    TWEET_DETAILS_ALT: (response: ITweetRepliesResponse, id: string) => Tweet | undefined;
+    TWEET_DETAILS_BULK: (response: ITweetDetailsBulkResponse, ids: string[]) => Tweet[];
+    TWEET_LIKE: (response: ITweetLikeResponse) => boolean;
+    TWEET_LIKERS: (response: ITweetLikersResponse) => CursoredData<User>;
+    TWEET_POST: (response: ITweetPostResponse) => string;
+    TWEET_REPLIES: (response: ITweetDetailsResponse) => CursoredData<Tweet>;
+    TWEET_RETWEET: (response: ITweetRetweetResponse) => boolean;
+    TWEET_RETWEETERS: (response: ITweetRetweetersResponse) => CursoredData<User>;
+    TWEET_SCHEDULE: (response: ITweetScheduleResponse) => string;
+    TWEET_SEARCH: (response: ITweetSearchResponse) => CursoredData<Tweet>;
+    TWEET_UNBOOKMARK: (response: ITweetUnbookmarkResponse) => boolean;
+    TWEET_UNLIKE: (response: ITweetUnlikeResponse) => boolean;
+    TWEET_UNPOST: (response: ITweetUnpostResponse) => boolean;
+    TWEET_UNRETWEET: (response: ITweetUnretweetResponse) => boolean;
+    TWEET_UNSCHEDULE: (response: ITweetUnscheduleResponse) => boolean;
+    USER_AFFILIATES: (response: IUserAffiliatesResponse) => CursoredData<User>;
+    USER_ANALYTICS: (response: IUserAnalyticsResponse) => Analytics;
+    USER_BOOKMARKS: (response: IUserBookmarksResponse) => CursoredData<Tweet>;
+    USER_BOOKMARK_FOLDERS: (response: IUserBookmarkFoldersResponse) => CursoredData<BookmarkFolder>;
+    USER_BOOKMARK_FOLDER_TWEETS: (response: IUserBookmarkFolderTweetsResponse) => CursoredData<Tweet>;
+    USER_DETAILS_BY_USERNAME: (response: IUserDetailsResponse) => User | undefined;
+    USER_DETAILS_BY_ID: (response: IUserDetailsResponse) => User | undefined;
+    USER_DETAILS_BY_IDS_BULK: (response: IUserDetailsBulkResponse, ids: string[]) => User[];
+    USER_FEED_FOLLOWED: (response: IUserFollowedResponse) => CursoredData<Tweet>;
+    USER_FEED_RECOMMENDED: (response: IUserRecommendedResponse) => CursoredData<Tweet>;
+    USER_FOLLOW: (response: IUserFollowResponse) => boolean;
+    USER_FOLLOWING: (response: IUserFollowingResponse) => CursoredData<User>;
+    USER_FOLLOWERS: (response: IUserFollowersResponse) => CursoredData<User>;
+    USER_HIGHLIGHTS: (response: IUserHighlightsResponse) => CursoredData<Tweet>;
+    USER_LISTS: (response: IUserListsResponse) => CursoredData<List>;
+    USER_LIKES: (response: IUserLikesResponse) => CursoredData<Tweet>;
+    USER_MEDIA: (response: IUserMediaResponse) => CursoredData<Tweet>;
+    USER_NOTIFICATIONS: (response: IUserNotificationsResponse) => CursoredData<Notification>;
+    USER_SEARCH: (response: IUserSearchResponse) => CursoredData<User>;
+    USER_SUBSCRIPTIONS: (response: IUserSubscriptionsResponse) => CursoredData<User>;
+    USER_TIMELINE: (response: IUserTweetsResponse) => CursoredData<Tweet>;
+    USER_TIMELINE_AND_REPLIES: (response: IUserTweetsAndRepliesResponse) => CursoredData<Tweet>;
+    USER_UNFOLLOW: (response: IUserUnfollowResponse) => boolean;
+    USER_PROFILE_UPDATE: (response: IUserProfileUpdateResponse) => boolean;
+};