@youmind-openlab/rettiwt-api 1.0.0

package/dist/models/data/Notification.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Notification = void 0;
+const Notification_1 = require("../../enums/Notification");
+const JsonUtils_1 = require("../../helper/JsonUtils");
+/**
+ * The details of a single notification.
+ *
+ * @public
+ */
+class Notification {
+    /** The raw notification details. */
+    _raw;
+    from;
+    id;
+    message;
+    receivedAt;
+    target;
+    type;
+    /**
+     * @param notification - The raw notification details.
+     */
+    constructor(notification) {
+        this._raw = { ...notification };
+        // Getting the original notification type
+        const notificationType = notification.notification_icon.toString();
+        this.from = notification.template.from_users
+            ? notification.template.from_users.map((item) => item.user_results.result.rest_id)
+            : [];
+        this.id = notification.id;
+        this.message = notification.rich_message.text;
+        this.receivedAt = new Date(notification.timestamp_ms).toISOString();
+        this.target = notification.template.target_objects
+            ? notification.template.target_objects.map((item) => item.tweet_results.result.rest_id)
+            : [];
+        this.type = notificationType
+            ? Notification_1.NotificationType[notificationType]
+            : Notification_1.NotificationType.UNDEFINED;
+    }
+    /** The raw notification details. */
+    get raw() {
+        return { ...this._raw };
+    }
+    /**
+     * Extracts and deserializes the list of notifications from the given raw response data.
+     *
+     * @param response - The raw response data.
+     *
+     * @returns The deserialized list of notifications.
+     */
+    static list(response) {
+        const notifications = [];
+        // Extracting the matching data
+        const extract = (0, JsonUtils_1.findByFilter)(response, '__typename', 'TimelineNotification');
+        // Deserializing valid data
+        for (const item of extract) {
+            notifications.push(new Notification(item));
+        }
+        return notifications;
+    }
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON() {
+        return {
+            from: this.from,
+            id: this.id,
+            message: this.message,
+            receivedAt: this.receivedAt,
+            target: this.target,
+            type: this.type,
+        };
+    }
+}
+exports.Notification = Notification;
+//# sourceMappingURL=Notification.js.map

package/dist/models/data/Notification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Notification.js","sourceRoot":"","sources":["../../../src/models/data/Notification.ts"],"names":[],"mappings":";;;AAAA,2DAA4D;AAC5D,sDAAsD;AAItD;;;;GAIG;AACH,MAAa,YAAY;IACxB,oCAAoC;IACnB,IAAI,CAAmB;IAEjC,IAAI,CAAW;IACf,EAAE,CAAS;IACX,OAAO,CAAS;IAChB,UAAU,CAAS;IACnB,MAAM,CAAW;IACjB,IAAI,CAAoB;IAE/B;;OAEG;IACH,YAAmB,YAA8B;QAChD,IAAI,CAAC,IAAI,GAAG,EAAE,GAAG,YAAY,EAAE,CAAC;QAEhC,yCAAyC;QACzC,MAAM,gBAAgB,GAAG,YAAY,CAAC,iBAAiB,CAAC,QAAQ,EAAE,CAAC;QAEnE,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC,QAAQ,CAAC,UAAU;YAC3C,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC;YAClF,CAAC,CAAC,EAAE,CAAC;QACN,IAAI,CAAC,EAAE,GAAG,YAAY,CAAC,EAAE,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC;QAC9C,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,CAAC;QACpE,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC,QAAQ,CAAC,cAAc;YACjD,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC;YACvF,CAAC,CAAC,EAAE,CAAC;QACN,IAAI,CAAC,IAAI,GAAG,gBAAgB;YAC3B,CAAC,CAAC,+BAAgB,CAAC,gBAAiD,CAAC;YACrE,CAAC,CAAC,+BAAgB,CAAC,SAAS,CAAC;IAC/B,CAAC;IAED,oCAAoC;IACpC,IAAW,GAAG;QACb,OAAO,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,IAAI,CAAC,QAA8B;QAChD,MAAM,aAAa,GAAmB,EAAE,CAAC;QAEzC,+BAA+B;QAC/B,MAAM,OAAO,GAAG,IAAA,wBAAY,EAAmB,QAAQ,EAAE,YAAY,EAAE,sBAAsB,CAAC,CAAC;QAE/F,2BAA2B;QAC3B,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC5B,aAAa,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5C,CAAC;QAED,OAAO,aAAa,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,MAAM;QACZ,OAAO;YACN,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,IAAI,EAAE,IAAI,CAAC,IAAI;SACf,CAAC;IACH,CAAC;CACD;AAzED,oCAyEC"}

package/dist/models/data/Tweet.d.ts

@@ -0,0 +1,129 @@
+import { MediaType } from '../../enums/Media';
+import { ITweet, ITweetEntities, ITweetMedia } from '../../types/data/Tweet';
+import { IExtendedMedia as IRawExtendedMedia } from '../../types/raw/base/Media';
+import { ITweet as IRawTweet, IEntities as IRawTweetEntities } from '../../types/raw/base/Tweet';
+import { User } from './User';
+/**
+ * The details of a single tweet.
+ *
+ * @public
+ */
+export declare class Tweet implements ITweet {
+    /** The raw tweet details. */
+    private readonly _raw;
+    bookmarkCount?: number;
+    conversationId: string;
+    createdAt: string;
+    entities: TweetEntities;
+    fullText: string;
+    id: string;
+    lang: string;
+    likeCount?: number;
+    media?: TweetMedia[];
+    quoteCount?: number;
+    quoted?: Tweet;
+    replyCount?: number;
+    replyTo?: string;
+    retweetCount?: number;
+    retweetedTweet?: Tweet;
+    tweetBy: User;
+    url: string;
+    viewCount?: number;
+    /**
+     * @param tweet - The raw tweet details.
+     */
+    constructor(tweet: IRawTweet);
+    /** The raw tweet details. */
+    get raw(): IRawTweet;
+    /**
+     * Extract and deserialize the original quoted tweet from the given raw tweet.
+     *
+     * @param tweet - The raw tweet.
+     *
+     * @returns - The deserialized original quoted tweet.
+     */
+    private _getQuotedTweet;
+    /**
+     * Extract and deserialize the original retweeted tweet from the given raw tweet.
+     *
+     * @param tweet - The raw tweet.
+     *
+     * @returns - The deserialized original retweeted tweet.
+     */
+    private _getRetweetedTweet;
+    /**
+     * Extracts and deserializes multiple target tweets from the given raw response data.
+     *
+     * @param response - The raw response data.
+     * @param ids - The ids of the target tweets.
+     *
+     * @returns The target deserialized tweets.
+     */
+    static multiple(response: NonNullable<unknown>, ids: string[]): Tweet[];
+    /**
+     * Extracts and deserializes a single target tweet from the given raw response data.
+     *
+     * @param response - The raw response data.
+     * @param id - The id of the target tweet.
+     *
+     * @returns The target deserialized tweet.
+     */
+    static single(response: NonNullable<unknown>, id: string): Tweet | undefined;
+    /**
+     * Extracts and deserializes the timeline of tweets from the given raw response data.
+     *
+     * @param response - The raw response data.
+     * @param ids - The IDs of specific tweets that need to be extracted.
+     *
+     * @returns The deserialized timeline of tweets.
+     */
+    static timeline(response: NonNullable<unknown>): Tweet[];
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON(): ITweet;
+}
+/**
+ * The different types parsed entities like urls, media, mentions, hashtags, etc.
+ *
+ * @public
+ */
+export declare class TweetEntities implements ITweetEntities {
+    /** The list of hashtags mentioned in the tweet. */
+    hashtags: string[];
+    /** The list of IDs of users mentioned in the tweet. */
+    mentionedUsers: string[];
+    /** The list of urls mentioned in the tweet. */
+    urls: string[];
+    /**
+     * @param entities - The raw tweet entities.
+     */
+    constructor(entities: IRawTweetEntities);
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON(): ITweetEntities;
+}
+/**
+ * The details of a single media content included in a tweet.
+ *
+ * @public
+ */
+export declare class TweetMedia implements ITweetMedia {
+    /** The ID of the media. */
+    id: string;
+    /** The thumbnail URL for the video content of the tweet. */
+    thumbnailUrl?: string;
+    /** The type of media. */
+    type: MediaType;
+    /** The direct URL to the media. */
+    url: string;
+    /**
+     * @param media - The raw media details.
+     */
+    constructor(media: IRawExtendedMedia);
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON(): ITweetMedia;
+}

package/dist/models/data/Tweet.js

@@ -0,0 +1,344 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TweetMedia = exports.TweetEntities = exports.Tweet = void 0;
+const Logging_1 = require("../../enums/Logging");
+const Media_1 = require("../../enums/Media");
+const Media_2 = require("../../enums/raw/Media");
+const JsonUtils_1 = require("../../helper/JsonUtils");
+const LogService_1 = require("../../services/internal/LogService");
+const User_1 = require("./User");
+/**
+ * The details of a single tweet.
+ *
+ * @public
+ */
+class Tweet {
+    /** The raw tweet details. */
+    _raw;
+    bookmarkCount;
+    conversationId;
+    createdAt;
+    entities;
+    fullText;
+    id;
+    lang;
+    likeCount;
+    media;
+    quoteCount;
+    quoted;
+    replyCount;
+    replyTo;
+    retweetCount;
+    retweetedTweet;
+    tweetBy;
+    url;
+    viewCount;
+    /**
+     * @param tweet - The raw tweet details.
+     */
+    constructor(tweet) {
+        this._raw = { ...tweet };
+        this.id = tweet.rest_id;
+        this.conversationId = tweet.legacy.conversation_id_str;
+        this.createdAt = new Date(tweet.legacy.created_at).toISOString();
+        this.tweetBy = new User_1.User(tweet.core.user_results.result);
+        this.entities = new TweetEntities(tweet.legacy.entities);
+        this.media = tweet.legacy.extended_entities?.media?.map((media) => new TweetMedia(media));
+        this.quoted = this._getQuotedTweet(tweet);
+        this.fullText = tweet.note_tweet?.note_tweet_results?.result?.text
+            ? tweet.note_tweet.note_tweet_results.result.text
+            : tweet.legacy.full_text;
+        this.replyTo = tweet.legacy.in_reply_to_status_id_str;
+        this.lang = tweet.legacy.lang;
+        this.quoteCount = tweet.legacy.quote_count;
+        this.replyCount = tweet.legacy.reply_count;
+        this.retweetCount = tweet.legacy.retweet_count;
+        this.likeCount = tweet.legacy.favorite_count;
+        this.viewCount = tweet.views?.count ? parseInt(tweet.views.count) : undefined;
+        this.bookmarkCount = tweet.legacy.bookmark_count;
+        this.retweetedTweet = this._getRetweetedTweet(tweet);
+        this.url = `https://x.com/${this.tweetBy.userName}/status/${this.id}`;
+    }
+    /** The raw tweet details. */
+    get raw() {
+        return { ...this._raw };
+    }
+    /**
+     * Extract and deserialize the original quoted tweet from the given raw tweet.
+     *
+     * @param tweet - The raw tweet.
+     *
+     * @returns - The deserialized original quoted tweet.
+     */
+    _getQuotedTweet(tweet) {
+        // If tweet with limited visibility
+        if (tweet.quoted_status_result &&
+            tweet.quoted_status_result?.result?.__typename == 'TweetWithVisibilityResults' &&
+            tweet.quoted_status_result.result?.tweet?.legacy) {
+            return new Tweet(tweet.quoted_status_result.result.tweet);
+        }
+        // If normal tweet
+        else if (tweet.quoted_status_result?.result?.rest_id) {
+            return new Tweet(tweet.quoted_status_result.result);
+        }
+        // Else, skip
+        else {
+            return undefined;
+        }
+    }
+    /**
+     * Extract and deserialize the original retweeted tweet from the given raw tweet.
+     *
+     * @param tweet - The raw tweet.
+     *
+     * @returns - The deserialized original retweeted tweet.
+     */
+    _getRetweetedTweet(tweet) {
+        // If retweet with limited visibility
+        if (tweet.legacy?.retweeted_status_result &&
+            tweet.legacy?.retweeted_status_result?.result?.__typename == 'TweetWithVisibilityResults' &&
+            tweet.legacy?.retweeted_status_result?.result?.tweet?.legacy) {
+            return new Tweet(tweet.legacy.retweeted_status_result.result.tweet);
+        }
+        // If normal tweet
+        else if (tweet.legacy?.retweeted_status_result?.result?.rest_id) {
+            return new Tweet(tweet.legacy.retweeted_status_result.result);
+        }
+        // Else, skip
+        else {
+            return undefined;
+        }
+    }
+    /**
+     * Extracts and deserializes multiple target tweets from the given raw response data.
+     *
+     * @param response - The raw response data.
+     * @param ids - The ids of the target tweets.
+     *
+     * @returns The target deserialized tweets.
+     */
+    static multiple(response, ids) {
+        let tweets = [];
+        // Extracting the matching data
+        const extract = (0, JsonUtils_1.findByFilter)(response, '__typename', 'Tweet');
+        // Deserializing valid data
+        for (const item of extract) {
+            if (item.legacy) {
+                // Logging
+                LogService_1.LogService.log(Logging_1.LogActions.DESERIALIZE, { id: item.rest_id });
+                tweets.push(new Tweet(item));
+            }
+            else {
+                // Logging
+                LogService_1.LogService.log(Logging_1.LogActions.WARNING, {
+                    action: Logging_1.LogActions.DESERIALIZE,
+                    message: `Tweet not found, skipping`,
+                });
+            }
+        }
+        // Filtering only required tweets, if required
+        if (ids && ids.length) {
+            tweets = tweets.filter((tweet) => ids.includes(tweet.id));
+        }
+        return tweets;
+    }
+    /**
+     * Extracts and deserializes a single target tweet from the given raw response data.
+     *
+     * @param response - The raw response data.
+     * @param id - The id of the target tweet.
+     *
+     * @returns The target deserialized tweet.
+     */
+    static single(response, id) {
+        const tweets = [];
+        // Extracting the matching data
+        const extract = (0, JsonUtils_1.findByFilter)(response, 'rest_id', id);
+        // Deserializing valid data
+        for (const item of extract) {
+            if (item.legacy) {
+                // Logging
+                LogService_1.LogService.log(Logging_1.LogActions.DESERIALIZE, { id: item.rest_id });
+                tweets.push(new Tweet(item));
+            }
+            else {
+                // Logging
+                LogService_1.LogService.log(Logging_1.LogActions.WARNING, {
+                    action: Logging_1.LogActions.DESERIALIZE,
+                    message: `Tweet not found, skipping`,
+                });
+            }
+        }
+        return tweets.length ? tweets[0] : undefined;
+    }
+    /**
+     * Extracts and deserializes the timeline of tweets from the given raw response data.
+     *
+     * @param response - The raw response data.
+     * @param ids - The IDs of specific tweets that need to be extracted.
+     *
+     * @returns The deserialized timeline of tweets.
+     */
+    static timeline(response) {
+        const tweets = [];
+        // Extracting the matching data
+        const extract = (0, JsonUtils_1.findByFilter)(response, '__typename', 'TimelineTweet');
+        // Deserializing valid data
+        for (const item of extract) {
+            // If tweet with limited visibility
+            if (item.tweet_results?.result &&
+                item.tweet_results?.result?.__typename == 'TweetWithVisibilityResults' &&
+                item.tweet_results?.result?.tweet?.legacy) {
+                tweets.push(new Tweet(item.tweet_results.result.tweet));
+            }
+            // If normal tweet
+            else if (item.tweet_results?.result?.legacy) {
+                // Logging
+                LogService_1.LogService.log(Logging_1.LogActions.DESERIALIZE, { id: item.tweet_results.result.rest_id });
+                tweets.push(new Tweet(item.tweet_results.result));
+            }
+            // If invalid/unrecognized tweet
+            else {
+                // Logging
+                LogService_1.LogService.log(Logging_1.LogActions.WARNING, {
+                    action: Logging_1.LogActions.DESERIALIZE,
+                    message: `Tweet not found, skipping`,
+                });
+            }
+        }
+        return tweets;
+    }
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON() {
+        return {
+            bookmarkCount: this.bookmarkCount,
+            conversationId: this.conversationId,
+            createdAt: this.createdAt,
+            entities: this.entities.toJSON(),
+            fullText: this.fullText,
+            id: this.id,
+            lang: this.lang,
+            likeCount: this.likeCount,
+            media: this.media?.map((item) => item.toJSON()),
+            quoteCount: this.quoteCount,
+            quoted: this.quoted?.toJSON(),
+            replyCount: this.replyCount,
+            replyTo: this.replyTo,
+            retweetCount: this.retweetCount,
+            retweetedTweet: this.retweetedTweet?.toJSON(),
+            tweetBy: this.tweetBy.toJSON(),
+            url: this.url,
+            viewCount: this.viewCount,
+        };
+    }
+}
+exports.Tweet = Tweet;
+/**
+ * The different types parsed entities like urls, media, mentions, hashtags, etc.
+ *
+ * @public
+ */
+class TweetEntities {
+    /** The list of hashtags mentioned in the tweet. */
+    hashtags = [];
+    /** The list of IDs of users mentioned in the tweet. */
+    mentionedUsers = [];
+    /** The list of urls mentioned in the tweet. */
+    urls = [];
+    /**
+     * @param entities - The raw tweet entities.
+     */
+    constructor(entities) {
+        // Extracting user mentions
+        if (entities.user_mentions) {
+            for (const user of entities.user_mentions) {
+                this.mentionedUsers.push(user.screen_name);
+            }
+        }
+        // Extracting urls
+        if (entities.urls) {
+            for (const url of entities.urls) {
+                this.urls.push(url.expanded_url);
+            }
+        }
+        // Extracting hashtags
+        if (entities.hashtags) {
+            for (const hashtag of entities.hashtags) {
+                this.hashtags.push(hashtag.text);
+            }
+        }
+    }
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON() {
+        return {
+            hashtags: this.hashtags,
+            mentionedUsers: this.mentionedUsers,
+            urls: this.urls,
+        };
+    }
+}
+exports.TweetEntities = TweetEntities;
+/**
+ * The details of a single media content included in a tweet.
+ *
+ * @public
+ */
+class TweetMedia {
+    /** The ID of the media. */
+    id;
+    /** The thumbnail URL for the video content of the tweet. */
+    thumbnailUrl;
+    /** The type of media. */
+    type;
+    /** The direct URL to the media. */
+    url = '';
+    /**
+     * @param media - The raw media details.
+     */
+    constructor(media) {
+        this.id = media.id_str;
+        // If the media is a photo
+        if (media.type == Media_2.RawMediaType.PHOTO) {
+            this.type = Media_1.MediaType.PHOTO;
+            this.url = media.media_url_https;
+        }
+        // If the media is a gif
+        else if (media.type == Media_2.RawMediaType.GIF) {
+            this.type = Media_1.MediaType.GIF;
+            this.url = media.video_info?.variants[0].url;
+        }
+        // If the media is a video
+        else {
+            this.type = Media_1.MediaType.VIDEO;
+            this.thumbnailUrl = media.media_url_https;
+            /** The highest bitrate of all variants. */
+            let highestRate = 0;
+            /**
+             * Selecting the URL of the video variant with the highest bitrate.
+             */
+            media.video_info?.variants.forEach((variant) => {
+                if (variant.bitrate > highestRate) {
+                    highestRate = variant.bitrate;
+                    this.url = variant.url;
+                }
+            });
+        }
+    }
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON() {
+        return {
+            id: this.id,
+            thumbnailUrl: this.thumbnailUrl,
+            type: this.type,
+            url: this.url,
+        };
+    }
+}
+exports.TweetMedia = TweetMedia;
+//# sourceMappingURL=Tweet.js.map

package/dist/models/data/Tweet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Tweet.js","sourceRoot":"","sources":["../../../src/models/data/Tweet.ts"],"names":[],"mappings":";;;AAAA,iDAAiD;AACjD,6CAA8C;AAC9C,iDAAqD;AACrD,sDAAsD;AAEtD,mEAAgE;AAQhE,iCAA8B;AAE9B;;;;GAIG;AACH,MAAa,KAAK;IACjB,6BAA6B;IACZ,IAAI,CAAY;IAE1B,aAAa,CAAU;IACvB,cAAc,CAAS;IACvB,SAAS,CAAS;IAClB,QAAQ,CAAgB;IACxB,QAAQ,CAAS;IACjB,EAAE,CAAS;IACX,IAAI,CAAS;IACb,SAAS,CAAU;IACnB,KAAK,CAAgB;IACrB,UAAU,CAAU;IACpB,MAAM,CAAS;IACf,UAAU,CAAU;IACpB,OAAO,CAAU;IACjB,YAAY,CAAU;IACtB,cAAc,CAAS;IACvB,OAAO,CAAO;IACd,GAAG,CAAS;IACZ,SAAS,CAAU;IAE1B;;OAEG;IACH,YAAmB,KAAgB;QAClC,IAAI,CAAC,IAAI,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC;QACxB,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,mBAAmB,CAAC;QACvD,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,CAAC;QACjE,IAAI,CAAC,OAAO,GAAG,IAAI,WAAI,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QACxD,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACzD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,iBAAiB,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1F,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,UAAU,EAAE,kBAAkB,EAAE,MAAM,EAAE,IAAI;YACjE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,kBAAkB,CAAC,MAAM,CAAC,IAAI;YACjD,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,yBAAyB,CAAC;QACtD,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC;QAC3C,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC9E,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC;QACjD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACrD,IAAI,CAAC,GAAG,GAAG,iBAAiB,IAAI,CAAC,OAAO,CAAC,QAAQ,WAAW,IAAI,CAAC,EAAE,EAAE,CAAC;IACvE,CAAC;IAED,6BAA6B;IAC7B,IAAW,GAAG;QACb,OAAO,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACK,eAAe,CAAC,KAAgB;QACvC,mCAAmC;QACnC,IACC,KAAK,CAAC,oBAAoB;YAC1B,KAAK,CAAC,oBAAoB,EAAE,MAAM,EAAE,UAAU,IAAI,4BAA4B;YAC7E,KAAK,CAAC,oBAAoB,CAAC,MAAkC,EAAE,KAAK,EAAE,MAAM,EAC5E,CAAC;YACF,OAAO,IAAI,KAAK,CAAE,KAAK,CAAC,oBAAoB,CAAC,MAAkC,CAAC,KAAK,CAAC,CAAC;QACxF,CAAC;QACD,kBAAkB;aACb,IAAK,KAAK,CAAC,oBAAoB,EAAE,MAAoB,EAAE,OAAO,EAAE,CAAC;YACrE,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,oBAAoB,CAAC,MAAmB,CAAC,CAAC;QAClE,CAAC;QACD,aAAa;aACR,CAAC;YACL,OAAO,SAAS,CAAC;QAClB,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACK,kBAAkB,CAAC,KAAgB;QAC1C,qCAAqC;QACrC,IACC,KAAK,CAAC,MAAM,EAAE,uBAAuB;YACrC,KAAK,CAAC,MAAM,EAAE,uBAAuB,EAAE,MAAM,EAAE,UAAU,IAAI,4BAA4B;YACxF,KAAK,CAAC,MAAM,EAAE,uBAAuB,EAAE,MAAkC,EAAE,KAAK,EAAE,MAAM,EACxF,CAAC;YACF,OAAO,IAAI,KAAK,CAAE,KAAK,CAAC,MAAM,CAAC,uBAAuB,CAAC,MAAkC,CAAC,KAAK,CAAC,CAAC;QAClG,CAAC;QACD,kBAAkB;aACb,IAAK,KAAK,CAAC,MAAM,EAAE,uBAAuB,EAAE,MAAoB,EAAE,OAAO,EAAE,CAAC;YAChF,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,uBAAuB,CAAC,MAAmB,CAAC,CAAC;QAC5E,CAAC;QACD,aAAa;aACR,CAAC;YACL,OAAO,SAAS,CAAC;QAClB,CAAC;IACF,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,QAAQ,CAAC,QAA8B,EAAE,GAAa;QACnE,IAAI,MAAM,GAAY,EAAE,CAAC;QAEzB,+BAA+B;QAC/B,MAAM,OAAO,GAAG,IAAA,wBAAY,EAAY,QAAQ,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;QAEzE,2BAA2B;QAC3B,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC5B,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBACjB,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,oBAAU,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;gBAE7D,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;YAC9B,CAAC;iBAAM,CAAC;gBACP,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,oBAAU,CAAC,OAAO,EAAE;oBAClC,MAAM,EAAE,oBAAU,CAAC,WAAW;oBAC9B,OAAO,EAAE,2BAA2B;iBACpC,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;QAED,8CAA8C;QAC9C,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YACvB,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3D,CAAC;QAED,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAA8B,EAAE,EAAU;QAC9D,MAAM,MAAM,GAAY,EAAE,CAAC;QAE3B,+BAA+B;QAC/B,MAAM,OAAO,GAAG,IAAA,wBAAY,EAAY,QAAQ,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;QAEjE,2BAA2B;QAC3B,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC5B,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBACjB,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,oBAAU,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;gBAE7D,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;YAC9B,CAAC;iBAAM,CAAC;gBACP,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,oBAAU,CAAC,OAAO,EAAE;oBAClC,MAAM,EAAE,oBAAU,CAAC,WAAW;oBAC9B,OAAO,EAAE,2BAA2B;iBACpC,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9C,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,QAAQ,CAAC,QAA8B;QACpD,MAAM,MAAM,GAAY,EAAE,CAAC;QAE3B,+BAA+B;QAC/B,MAAM,OAAO,GAAG,IAAA,wBAAY,EAAiB,QAAQ,EAAE,YAAY,EAAE,eAAe,CAAC,CAAC;QAEtF,2BAA2B;QAC3B,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC5B,mCAAmC;YACnC,IACC,IAAI,CAAC,aAAa,EAAE,MAAM;gBAC1B,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,IAAI,4BAA4B;gBACrE,IAAI,CAAC,aAAa,EAAE,MAAkC,EAAE,KAAK,EAAE,MAAM,EACrE,CAAC;gBACF,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAE,IAAI,CAAC,aAAa,CAAC,MAAkC,CAAC,KAAK,CAAC,CAAC,CAAC;YACtF,CAAC;YACD,kBAAkB;iBACb,IAAK,IAAI,CAAC,aAAa,EAAE,MAAoB,EAAE,MAAM,EAAE,CAAC;gBAC5D,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,oBAAU,CAAC,WAAW,EAAE,EAAE,EAAE,EAAG,IAAI,CAAC,aAAa,CAAC,MAAoB,CAAC,OAAO,EAAE,CAAC,CAAC;gBAEjG,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,MAAmB,CAAC,CAAC,CAAC;YAChE,CAAC;YACD,gCAAgC;iBAC3B,CAAC;gBACL,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,oBAAU,CAAC,OAAO,EAAE;oBAClC,MAAM,EAAE,oBAAU,CAAC,WAAW;oBAC9B,OAAO,EAAE,2BAA2B;iBACpC,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;QAED,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;OAEG;IACI,MAAM;QACZ,OAAO;YACN,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YAChC,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YAC/C,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE;YAC7B,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,MAAM,EAAE;YAC7C,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YAC9B,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,SAAS,EAAE,IAAI,CAAC,SAAS;SACzB,CAAC;IACH,CAAC;CACD;AAvPD,sBAuPC;AAED;;;;GAIG;AACH,MAAa,aAAa;IACzB,mDAAmD;IAC5C,QAAQ,GAAa,EAAE,CAAC;IAE/B,uDAAuD;IAChD,cAAc,GAAa,EAAE,CAAC;IAErC,+CAA+C;IACxC,IAAI,GAAa,EAAE,CAAC;IAE3B;;OAEG;IACH,YAAmB,QAA2B;QAC7C,2BAA2B;QAC3B,IAAI,QAAQ,CAAC,aAAa,EAAE,CAAC;YAC5B,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,aAAa,EAAE,CAAC;gBAC3C,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC5C,CAAC;QACF,CAAC;QAED,kBAAkB;QAClB,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,MAAM,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACjC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAClC,CAAC;QACF,CAAC;QAED,sBAAsB;QACtB,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;YACvB,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBACzC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAClC,CAAC;QACF,CAAC;IACF,CAAC;IAED;;OAEG;IACI,MAAM;QACZ,OAAO;YACN,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,IAAI,EAAE,IAAI,CAAC,IAAI;SACf,CAAC;IACH,CAAC;CACD;AA9CD,sCA8CC;AAED;;;;GAIG;AACH,MAAa,UAAU;IACtB,2BAA2B;IACpB,EAAE,CAAS;IAElB,4DAA4D;IACrD,YAAY,CAAU;IAE7B,yBAAyB;IAClB,IAAI,CAAY;IAEvB,mCAAmC;IAC5B,GAAG,GAAG,EAAE,CAAC;IAEhB;;OAEG;IACH,YAAmB,KAAwB;QAC1C,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC;QAEvB,0BAA0B;QAC1B,IAAI,KAAK,CAAC,IAAI,IAAI,oBAAY,CAAC,KAAK,EAAE,CAAC;YACtC,IAAI,CAAC,IAAI,GAAG,iBAAS,CAAC,KAAK,CAAC;YAC5B,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,eAAe,CAAC;QAClC,CAAC;QACD,wBAAwB;aACnB,IAAI,KAAK,CAAC,IAAI,IAAI,oBAAY,CAAC,GAAG,EAAE,CAAC;YACzC,IAAI,CAAC,IAAI,GAAG,iBAAS,CAAC,GAAG,CAAC;YAC1B,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAa,CAAC;QACxD,CAAC;QACD,0BAA0B;aACrB,CAAC;YACL,IAAI,CAAC,IAAI,GAAG,iBAAS,CAAC,KAAK,CAAC;YAC5B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,eAAe,CAAC;YAE1C,2CAA2C;YAC3C,IAAI,WAAW,GAAG,CAAC,CAAC;YAEpB;;eAEG;YACH,KAAK,CAAC,UAAU,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC9C,IAAI,OAAO,CAAC,OAAO,GAAG,WAAW,EAAE,CAAC;oBACnC,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;oBAC9B,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;gBACxB,CAAC;YACF,CAAC,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAED;;OAEG;IACI,MAAM;QACZ,OAAO;YACN,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,GAAG,EAAE,IAAI,CAAC,GAAG;SACb,CAAC;IACH,CAAC;CACD;AA5DD,gCA4DC"}

package/dist/models/data/User.d.ts

@@ -0,0 +1,62 @@
+import { IUser } from '../../types/data/User';
+import { IUser as IRawUser } from '../../types/raw/base/User';
+/**
+ * The details of a single user.
+ *
+ * @public
+ */
+export declare class User implements IUser {
+    /** The raw user details. */
+    private readonly _raw;
+    createdAt: string;
+    description?: string;
+    followersCount: number;
+    followingsCount: number;
+    fullName: string;
+    id: string;
+    isFollowed?: boolean;
+    isFollowing?: boolean;
+    isVerified: boolean;
+    likeCount: number;
+    location?: string;
+    pinnedTweet?: string;
+    profileBanner?: string;
+    profileImage: string;
+    statusesCount: number;
+    userName: string;
+    /**
+     * @param user - The raw user details.
+     */
+    constructor(user: IRawUser);
+    /** The raw user details. */
+    get raw(): IRawUser;
+    /**
+     * Extracts and deserializes multiple target users from the given raw response data.
+     *
+     * @param response - The raw response data.
+     * @param ids - The ids of the target users.
+     *
+     * @returns The target deserialized users.
+     */
+    static multiple(response: NonNullable<unknown>, ids: string[]): User[];
+    /**
+     * Extracts and deserializes a single target user from the given raw response data.
+     *
+     * @param response - The raw response data.
+     *
+     * @returns The target deserialized user.
+     */
+    static single(response: NonNullable<unknown>): User | undefined;
+    /**
+     * Extracts and deserializes the timeline of users from the given raw response data.
+     *
+     * @param response - The raw response data.
+     *
+     * @returns The deserialized timeline of users.
+     */
+    static timeline(response: NonNullable<unknown>): User[];
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON(): IUser;
+}