Merge pull request #25 from abcfy2/main

feat: add me() api to get logged in user's profile

README.md

@@ -135,6 +135,9 @@ const profile = await scraper.getProfile('TwitterDev');
 
 // Get a user ID from their screen name
 const userId = await scraper.getUserIdByScreenName('TwitterDev');
+
+// Get logged-in user's profile
+const me = await scraper.me();
 ```
 
 ### Search

src/auth-user.ts

@@ -7,6 +7,7 @@ import { TwitterApiErrorRaw } from './errors';
 import { Type, type Static } from '@sinclair/typebox';
 import { Check } from '@sinclair/typebox/value';
 import * as OTPAuth from 'otpauth';
+import { LegacyUserRaw, parseProfile, type Profile } from './profile';
 
 interface TwitterUserAuthFlowInitRequest {
   flow_name: string;
@@ -53,6 +54,8 @@ type FlowTokenResult = FlowTokenResultSuccess | { status: 'error'; err: Error };
  * A user authentication token manager.
  */
 export class TwitterUserAuth extends TwitterGuestAuth {
+  private userProfile: Profile | undefined;
+
   constructor(bearerToken: string, options?: Partial<TwitterAuthOptions>) {
     super(bearerToken, options);
   }
@@ -67,9 +70,21 @@ export class TwitterUserAuth extends TwitterGuestAuth {
     }
 
     const { value: verify } = res;
+    this.userProfile = parseProfile(
+      verify as LegacyUserRaw,
+      (verify as unknown as { verified: boolean }).verified,
+    );
     return verify && !verify.errors?.length;
   }
 
+  async me(): Promise<Profile | undefined> {
+    if (this.userProfile) {
+      return this.userProfile;
+    }
+    await this.isLoggedIn();
+    return this.userProfile;
+  }
+
   async login(
     username: string,
     password: string,

src/auth.ts

@@ -3,6 +3,7 @@ import { updateCookieJar } from './requests';
 import { Headers } from 'headers-polyfill';
 import { FetchTransformOptions } from './api';
 import { TwitterApi } from 'twitter-api-v2';
+import { Profile } from './profile';
 
 export interface TwitterAuthOptions {
   fetch: typeof fetch;
@@ -38,6 +39,11 @@ export interface TwitterAuth {
    */
   isLoggedIn(): Promise<boolean>;
 
+  /**
+   * Fetches the current user's profile.
+   */
+  me(): Promise<Profile | undefined>;
+
   /**
    * Logs into a Twitter account.
    * @param username The username to log in with.
@@ -151,6 +157,10 @@ export class TwitterGuestAuth implements TwitterAuth {
     return Promise.resolve(false);
   }
 
+  async me(): Promise<Profile | undefined> {
+    return undefined;
+  }
+
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   login(_username: string, _password: string, _email?: string): Promise<void> {
     return this.updateGuestToken();

src/scraper.ts

@@ -692,6 +692,14 @@ export class Scraper {
     );
   }
 
+  /**
+   * Returns the currently logged in user
+   * @returns The currently logged in user
+   */
+  public async me(): Promise<Profile | undefined> {
+    return this.auth.me();
+  }
+
   /**
    * Login to Twitter as a real Twitter account. This enables running
    * searches.