[core] Add /api/sessions/{session}/me endpoint

Fix #191

Author: allburov

docs/site/content/en/docs/how-to/sessions/index.md

@@ -128,6 +128,28 @@ In order to log out the session - call `POST /api/sessions/logout`
 }
 ```
 
+### Get me
+
+Get information about the associated account for that session (if any).
+```bash
+GET /api/sessions/{session}/me
+```
+
+**Authenticated and working** session's response:
+```json
+{
+  "id": "[email protected]",
+  "pushName": "string"
+}
+```
+
+**Stopped** or **not authenticated** session returns null:
+```json
+null
+```
+
+
+
 
 ## Authentication
 ### Get QR

docs/site/content/en/docs/overview/changelog.md

@@ -14,6 +14,7 @@ toc: true
 ---
 ## 2023.9
 September 2023
+- Add `GET /api/sessions/{session/me` endpoint so you [can get the phone number associated with the session](https://waha.devlike.pro/docs/how-to/sessions/#get-me)
 - Add [polls support in NOWEB engine](https://waha.devlike.pro/docs/how-to/polls)
 - Add dedicated [Get QR](https://waha.devlike.pro/docs/how-to/sessions/#get-qr) endpoint!
 - Support [pairing method (NOWEB)](https://waha.devlike.pro/docs/how-to/sessions/#get-pairing-code) - you can connect with a code instead of QR.

src/api/groups.controller.ts

@@ -51,8 +51,14 @@ export class GroupsController {
 
   @Put(':id/settings/security/info-admin-only')
   @SessionApiParam
-  @ApiOperation({ summary: 'Updates the group settings to only allow admins to edit group info (title, description, photo).' })
-  setGroupAdminOnly(@SessionParam session: WhatsappSession, @Param('id') id: string) {
+  @ApiOperation({
+    summary:
+      'Updates the group settings to only allow admins to edit group info (title, description, photo).',
+  })
+  setGroupAdminOnly(
+    @SessionParam session: WhatsappSession,
+    @Param('id') id: string,
+  ) {
     return session.setInfoAdminsOnly(id, true);
   }
 

src/api/sessions.controller.ts

@@ -6,16 +6,21 @@ import { SessionManager } from '../core/abc/manager.abc';
 import { parseBool } from '../helpers';
 import {
   ListSessionsQuery,
+  MeInfo,
   SessionDTO,
+  SessionInfo,
   SessionLogoutRequest,
   SessionStartRequest,
   SessionStopRequest,
 } from '../structures/sessions.dto';
+import { SessionApiParam, SessionParam } from './helpers';
+import { WhatsappSession } from '../core/abc/session.abc';
+import { WAHAChatPresences } from '../structures/presence.dto';
 
 @ApiSecurity('api_key')
 @Controller('api/sessions')
 @ApiTags('sessions')
-export class SessionsController {
+class SessionsController {
   constructor(private manager: SessionManager) {}
 
   @Post('/start/')
@@ -45,8 +50,24 @@ export class SessionsController {
   }
 
   @Get('/')
-  async list(@Query() query: ListSessionsQuery): Promise<SessionDTO[]> {
+  async list(@Query() query: ListSessionsQuery): Promise<SessionInfo[]> {
     const all = parseBool(query.all);
     return this.manager.getSessions(all);
   }
 }
+
+@ApiSecurity('api_key')
+@Controller('api/sessions/:session')
+@ApiTags('sessions')
+class SessionController {
+  constructor(private manager: SessionManager) {}
+
+  @Get('me')
+  @SessionApiParam
+  @ApiOperation({ summary: 'Get information about the authenticated account' })
+  getMe(@SessionParam session: WhatsappSession): Promise<MeInfo> {
+    return session.getSessionMeInfo();
+  }
+}
+
+export { SessionController, SessionsController };

src/core/abc/manager.abc.ts

@@ -3,6 +3,7 @@ import { OnApplicationShutdown } from '@nestjs/common';
 import { WAHAEngine } from '../../structures/enums.dto';
 import {
   SessionDTO,
+  SessionInfo,
   SessionLogoutRequest,
   SessionStartRequest,
   SessionStopRequest,
@@ -35,5 +36,5 @@ export abstract class SessionManager implements OnApplicationShutdown {
 
   abstract getSession(name: string, error?: boolean): WhatsappSession;
 
-  abstract getSessions(all: boolean): Promise<SessionDTO[]>;
+  abstract getSessions(all: boolean): Promise<SessionInfo[]>;
 }

src/core/abc/session.abc.ts

@@ -31,7 +31,11 @@ import {
   ParticipantsRequest,
 } from '../../structures/groups.dto';
 import { WAHAChatPresences } from '../../structures/presence.dto';
-import { ProxyConfig, SessionConfig } from '../../structures/sessions.dto';
+import {
+  MeInfo,
+  ProxyConfig,
+  SessionConfig,
+} from '../../structures/sessions.dto';
 import { NotImplementedByEngineError } from '../exceptions';
 import { LocalSessionStorage, MediaStorage } from './storage.abc';
 import { OTPRequest, RequestCodeRequest } from '../../structures/auth.dto';
@@ -168,6 +172,10 @@ export abstract class WhatsappSession {
 
   abstract getScreenshot(): Promise<Buffer | string>;
 
+  public getSessionMeInfo(): Promise<MeInfo | null> {
+    throw new NotImplementedByEngineError();
+  }
+
   /**
    * Other methods
    */

src/core/app.module.core.ts

@@ -8,7 +8,10 @@ import { ContactsController } from '../api/contacts.controller';
 import { GroupsController } from '../api/groups.controller';
 import { PresenceController } from '../api/presence.controller';
 import { ScreenshotController } from '../api/screenshot.controller';
-import { SessionsController } from '../api/sessions.controller';
+import {
+  SessionController,
+  SessionsController,
+} from '../api/sessions.controller';
 import { VersionController } from '../api/version.controller';
 import { WhatsappConfigService } from '../config.service';
 import { SessionManager } from './abc/manager.abc';
@@ -39,6 +42,7 @@ export const IMPORTS = [
 export const CONTROLLERS = [
   AuthController,
   SessionsController,
+  SessionController,
   ChattingController,
   ChatsController,
   StatusController,

src/core/manager.core.ts

@@ -10,6 +10,7 @@ import { WAHAEngine, WAHASessionStatus } from '../structures/enums.dto';
 import {
   ProxyConfig,
   SessionDTO,
+  SessionInfo,
   SessionLogoutRequest,
   SessionStartRequest,
   SessionStopRequest,
@@ -191,7 +192,7 @@ export class SessionManagerCore extends SessionManager {
     return session;
   }
 
-  async getSessions(all: boolean): Promise<SessionDTO[]> {
+  async getSessions(all: boolean): Promise<SessionInfo[]> {
     if (!this.session) {
       if (!all) {
         return [];
@@ -201,14 +202,17 @@ export class SessionManagerCore extends SessionManager {
           name: this.DEFAULT,
           status: WAHASessionStatus.STOPPED,
           config: undefined,
+          me: null,
         },
       ];
     }
+    const me = await this.session.getSessionMeInfo().catch((err) => null);
     return [
       {
         name: this.session.name,
         status: this.session.status,
         config: this.session.sessionConfig,
+        me: me,
       },
     ];
   }

src/core/session.noweb.core.ts

@@ -4,6 +4,7 @@ import makeWASocket, {
   getAggregateVotesInPollMessage,
   getKeyAuthor,
   isJidGroup,
+  jidNormalizedUser,
   makeInMemoryStore,
   PresenceData,
   proto,
@@ -76,6 +77,7 @@ import {
 } from './exceptions';
 import { createAgentProxy } from './helpers.proxy';
 import { QR } from './QR';
+import { MeInfo } from '../structures/sessions.dto';
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const QRCode = require('qrcode');
@@ -240,6 +242,19 @@ export class WhatsappSessionNoWebCore extends WhatsappSession {
     return;
   }
 
+  async getSessionMeInfo(): Promise<MeInfo | null> {
+    const me = this.sock.authState?.creds?.me;
+    if (!me) {
+      return null;
+    }
+    const meId = jidNormalizedUser(me.id);
+    const meInfo: MeInfo = {
+      id: toCusFormat(meId),
+      pushName: me.name,
+    };
+    return meInfo;
+  }
+
   /**
    * START - Methods for API
    */

src/core/session.webjs.core.ts

@@ -50,6 +50,8 @@ import {
   NotImplementedByEngineError,
 } from './exceptions';
 import { QR } from './QR';
+import { MeInfo } from '../structures/sessions.dto';
+import { jidNormalizedUser } from '@adiwajshing/baileys';
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const QRCode = require('qrcode');
@@ -113,6 +115,19 @@ export class WhatsappSessionWebJSCore extends WhatsappSession {
     return this.whatsapp.destroy();
   }
 
+  async getSessionMeInfo(): Promise<MeInfo | null> {
+    const clientInfo = this.whatsapp?.info;
+    if (!clientInfo) {
+      return null;
+    }
+    const wid = clientInfo.wid;
+    const meInfo: MeInfo = {
+      id: wid._serialized,
+      pushName: clientInfo.pushname,
+    };
+    return meInfo;
+  }
+
   protected listenConnectionEvents() {
     this.whatsapp.on(Events.QR_RECEIVED, (qr) => {
       this.log.debug('QR received');