rettiwt-api 1.0.6 → 1.0.8

package/dist/types/raw/user/Users.d.ts

@@ -1,120 +0,0 @@
-export default interface Root {
-    data: Data;
-}
-export interface Data {
-    users: User[];
-}
-export interface User {
-    result: Result;
-}
-export interface Result {
-    __typename: string;
-    id: string;
-    rest_id: string;
-    affiliates_highlighted_label: AffiliatesHighlightedLabel;
-    has_graduated_access: boolean;
-    has_nft_avatar: boolean;
-    is_blue_verified: boolean;
-    legacy: Legacy;
-    smart_blocked_by: boolean;
-    smart_blocking: boolean;
-    super_follow_eligible: boolean;
-    super_followed_by: boolean;
-    super_following: boolean;
-    verified_phone_status: boolean;
-    legacy_extended_profile: LegacyExtendedProfile;
-    is_profile_translatable: boolean;
-}
-export interface AffiliatesHighlightedLabel {
-}
-export interface Legacy {
-    blocked_by: boolean;
-    blocking: boolean;
-    can_dm: boolean;
-    can_media_tag: boolean;
-    created_at: string;
-    default_profile: boolean;
-    default_profile_image: boolean;
-    description: string;
-    entities: Entities;
-    fast_followers_count: number;
-    favourites_count: number;
-    follow_request_sent: boolean;
-    followed_by: boolean;
-    followers_count: number;
-    following: boolean;
-    friends_count: number;
-    has_custom_timelines: boolean;
-    is_translator: boolean;
-    listed_count: number;
-    location: string;
-    media_count: number;
-    muting: boolean;
-    name: string;
-    normal_followers_count: number;
-    notifications: boolean;
-    pinned_tweet_ids_str: string[];
-    possibly_sensitive: boolean;
-    profile_banner_extensions: ProfileBannerExtensions;
-    profile_banner_url: string;
-    profile_image_extensions: ProfileImageExtensions;
-    profile_image_url_https: string;
-    profile_interstitial_type: string;
-    protected: boolean;
-    screen_name: string;
-    statuses_count: number;
-    translator_type: string;
-    verified: boolean;
-    want_retweets: boolean;
-    withheld_in_countries: any[];
-}
-export interface Entities {
-    description: Description;
-}
-export interface Description {
-    urls: any[];
-}
-export interface ProfileBannerExtensions {
-    mediaColor: MediaColor;
-}
-export interface MediaColor {
-    r: R;
-}
-export interface R {
-    ok: Ok;
-}
-export interface Ok {
-    palette: Palette[];
-}
-export interface Palette {
-    percentage: number;
-    rgb: Rgb;
-}
-export interface Rgb {
-    blue: number;
-    green: number;
-    red: number;
-}
-export interface ProfileImageExtensions {
-    mediaColor: MediaColor2;
-}
-export interface MediaColor2 {
-    r: R2;
-}
-export interface R2 {
-    ok: Ok2;
-}
-export interface Ok2 {
-    palette: Palette2[];
-}
-export interface Palette2 {
-    percentage: number;
-    rgb: Rgb2;
-}
-export interface Rgb2 {
-    blue: number;
-    green: number;
-    red: number;
-}
-export interface LegacyExtendedProfile {
-}

package/dist/types/raw/user/Users.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Users.js","sourceRoot":"","sources":["../../../../src/types/raw/user/Users.ts"],"names":[],"mappings":""}

package/src/services/data/UserAccountService.ts

@@ -1,176 +0,0 @@
-// SERVICES
-import { FetcherService } from '../FetcherService';
-import { AuthService } from '../AuthService';
-
-// TYPES
-import { User } from '../../types/UserAccount';
-import { Tweet } from '../../types/Tweet';
-import { CursoredData } from '../../types/Service';
-import RawUser from '../../types/raw/user/User';
-import RawUserFollowers from '../../types/raw/user/Followers';
-import RawUserFollowing from '../../types/raw/user/Following';
-import RawUserLikes from '../../types/raw/user/Likes';
-
-// URLS
-import * as Urls from '../helper/Urls';
-
-// EXTRACTORS
-import * as Extractors from '../helper/Extractors';
-
-// DESERIALIZERS
-import * as Deserializers from '../helper/Deserializers';
-
-/**
- * A service that deals with fetching of data related to user account
- */
-export class UserAccountService extends FetcherService {
-    // MEMBER METHODS
-    constructor(auth: AuthService) {
-        super(auth);
-    }
-
-    /**
-     * @returns The user account details of the given user
-     * @param screenName The screen name of the target user.
-     */
-    async getUserAccountDetails(screenName: string): Promise<User> {
-        // Fetching the raw data
-        let res: RawUser = await this.request<RawUser>(Urls.userAccountUrl(screenName), false).then(res => res.data);
-        
-        // Extracting data
-        let data = Extractors.extractUserAccountDetails(res);
-
-        // Caching data
-        this.cacheData(data);
-
-        // Parsing data
-        let user = Deserializers.toUser(data.required[0]);
-            
-        return user;
-    }
-
-    /**
-     * @returns The user account details of the user with given rest id
-     * @param restId The screen name of the target user.
-     */
-    async getUserAccountDetailsById(restId: string): Promise<User> {
-        // Getting data from cache
-        let cachedData = await this.readData(restId);
-
-        // If data exists in cache
-        if(cachedData) {
-            return cachedData;
-        }
-        // If data does not exist in cache
-        else {
-            // Fetchin the raw data
-            let res = await this.request<RawUser>(Urls.userAccountByIdUrl(restId), false).then(res => res.data);
-
-            // Extracting data
-            let data = Extractors.extractUserAccountDetails(res);
-
-            // Caching data
-            this.cacheData(data);
-
-            // Parsing data
-            let user = Deserializers.toUser(data.required[0]);
-                
-            return user;
-        }
-    }
-
-    /**
-     * @returns The list of users followed by the target user
-     * @param userId The rest id of the target user
-     * @param count The batch size of the list
-     * @param cursor The cursor to next batch. If blank, first batch is fetched
-     */
-    async getUserFollowing(userId: string, count: number, cursor: string): Promise<CursoredData<User>> {
-        // If user is not authenticated, abort
-        if(!this.isAuthenticated) {
-            return { error: new Error('Cannot fetch user following without authentication!') };
-        }
-
-        // Fetchin the raw data
-        let res = await this.request<RawUserFollowing>(Urls.userFollowingUrl(userId, count, cursor)).then(res => res.data);
-        
-        // Extracting data
-        let data = Extractors.extractUserFollow(res);
-
-        // Caching data
-        this.cacheData(data);
-
-        // Parsing data
-        let users = data.required.map(item => Deserializers.toUser(item));
-
-        return {
-            list: users,
-            next: { value: data.cursor }
-        };
-    }
-
-    /**
-     * @returns The list of users following the target user
-     * @param userId The rest id of the target user
-     * @param count The batch size of the list
-     * @param cursor The cursor to next batch. If blank, first batch is fetched
-     */
-    async getUserFollowers(userId: string, count: number, cursor: string): Promise<CursoredData<User>> {
-        // If user is not authenticated, abort
-        if(!this.isAuthenticated) {
-            return { error: new Error('Cannot fetch user followers without authentication!') };
-        }
-
-        /**
-         * When fetching list of followers, the official Twitter API seems to be fetching n + 20 followers,
-         * where n is the actual required number of followers.
-         * So changing count to count - 20, fixes fetching more than required number of follower
-         */
-        // Fetching the raw data
-        let res = await this.request<RawUserFollowers>(Urls.userFollowersUrl(userId, (count > 20) ? (count - 20) : count, cursor)).then(res => res.data);
-        
-        // Extracting data
-        let data = Extractors.extractUserFollow(res);
-
-        // Caching data
-        this.cacheData(data);
-
-        // Parsing data
-        let users = data.required.map(item => Deserializers.toUser(item));
-
-        return {
-            list: users,
-            next: { value: data.cursor }
-        };
-    }
-
-    /**
-     * @returns The list of tweets liked by the target user
-     * @param userId The rest id of the target user
-     * @param count The batch size of the list
-     * @param cursor The cursor to next batch. If blank, first batch is fetched
-     */
-    async getUserLikes(userId: string, count: number, cursor: string): Promise<CursoredData<Tweet>> {
-        // If user is not authenticated, abort
-        if(!this.isAuthenticated) {
-            return { error: new Error('Cannot fetch user likes without authentication!') };
-        }
-
-        // Fetching the raw data
-        let res = await this.request<RawUserLikes>(Urls.userLikesUrl(userId, count, cursor)).then(res => res.data);
-        
-        // Extracting data
-        let data = Extractors.extractUserLikes(res);
-
-        // Caching data
-        this.cacheData(data);
-
-        // Parsing data
-        let tweets = data.required.map(item => Deserializers.toTweet(item));
-
-        return {
-            list: tweets,
-            next: { value: data.cursor }
-        };
-    }
-};