[core] Add chats endpoints

.eslintrc.js

@@ -25,6 +25,7 @@ module.exports = {
     "@typescript-eslint/interface-name-prefix": "off",
     "@typescript-eslint/explicit-function-return-type": "off",
     "@typescript-eslint/explicit-module-boundary-types": "off",
+    "@typescript-eslint/no-inferrable-types": "off",
     "@typescript-eslint/no-explicit-any": "off",
     "@typescript-eslint/ban-ts-ignore": "off",
     "@typescript-eslint/ban-ts-comment": "off",

Dockerfile

@@ -1,7 +1,7 @@
 #
 # Build
 #
-FROM node:18 as build
+FROM node:20-bullseye as build
 ENV PUPPETEER_SKIP_DOWNLOAD=True
 
 # npm packages
@@ -20,7 +20,7 @@ RUN yarn build && find ./dist -name "*.d.ts" -delete
 #
 # Final
 #
-FROM node:18 as release
+FROM node:20-bullseye as release
 ENV PUPPETEER_SKIP_DOWNLOAD=True
 ARG USE_BROWSER=chromium
 

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

@@ -0,0 +1,41 @@
+---
+title : "Chats"
+description: "Chats"
+lead: ""
+date: 2020-10-06T08:48:45+00:00
+lastmod: 2020-10-06T08:48:45+00:00
+draft: false
+images: []
+weight: 126
+---
+
+Chats methods.
+
+Parameters in path that you can find in below endpoints:
+- `{session}` - use the session name for Whatsapp instance that you created with `POST /api/session/start` endpoint
+- `{chatId}` - chat id in format `123123123123@[c.us|g.us]`, `c.us` for direct chats and `g.us` for groups.
+
+## Methods
+### Get all chats
+Get all chats
+`GET /api/{session}/chats`
+
+### Get messages from chat
+Get 100 messages from the chat
+
+`GET /api/{session}/chats/{chatId/messages?limit=100`
+
+
+Get 100 messages from the chat, skip downloading media (images, files)
+
+`GET /api/{session}/chats/{chatId/messages?limit=100&downloadMedia=false`
+
+### Delete chat
+Use the method to delete chat
+
+`DELETE /api/{session}/chats/{chatId}`
+
+### Clear messages
+Use the method to clear all messages from the chat
+
+`DELETE /api/{session}/chats/{chatId}/messages`

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

@@ -12,7 +12,55 @@ weight: 801
 You can get presence information (online, offline with last seen, typing status) for a contact if they share their
 presence information.
 
-{{< alert icon="👉" text="Presence endpoints and webhook is available only in **NOWEB** engine." />}}
+Possible presence statuses that you can set or get for chats:
+- `online`
+- `offline`
+- `typing`
+- `recording`
+- `paused` resets the chat presence after you were `typing`
+
+
+## Endpoints
+
+### Set presence
+You can set your global or chat-related presence with `POST /api/{session}/presence` endpoint
+
+Start typing to a chat (you can use `POST /startTyping` instead)
+```json
+{
+  "chatId": "111111111@c.us",
+  "presence": "typing"
+}
+```
+
+Clear "typing" state (you can use `POST /stopTyping` instead)
+```json
+{
+  "chatId": "111111111@c.us",
+  "presence": "paused"
+}
+```
+
+Set global "online", all contacts will see it
+```json
+{
+  "presence": "online"
+}
+```
+
+💡 In the multi-device version of WhatsApp - if a desktop client is active, WhatsApp doesn't send push notifications
+to the device.
+If you would like to receive said notifications - you need to mark a session's presence as `offline`.
+
+```json
+{
+  "presence": "offline"
+}
+```
+
+### Get all chats presence
+
+{{< alert icon="👉" text="Get presence endpoints and webhook is available only in **NOWEB** engine." />}}
 [Read more about engines to choose right for you ->]({{< relref "/docs/how-to/engines" >}})
 
 Here's few notes about fields:
@@ -22,9 +70,6 @@ Here's few notes about fields:
 - `lastKnownPresence` - contains the last known presence status, which can be
   `offline`, `online`, `typing`, `recording`, or `paused`
 
-## Endpoints
-
-### Get all presence
 
 You can get all presence information available for a session by calling `GET /api/{session}/presence/`.
 It returns both groups' and personal chats' presence information.

docs/site/content/en/docs/how-to/receive-messages/index.md

@@ -155,7 +155,10 @@ If you want to limit files lifetime, specify file types for download or change d
 ## Endpoints
 
 ### Get messages
-You can read messages from the history by using `GET /api/messages` endpoint.
+Read messages from the history - use `GET /api/messages` endpoint.
+
+You also can get messages for chats by using
+[**Get messages from chat ->**]({{< relref "/docs/how-to/chats" >}}) endpoint.
 
 {{< alert icon="👉" text="We do not recommend using this method in production, consider using webhooks instead!" />}}
 

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

@@ -12,6 +12,18 @@ menu:
 weight: 199
 toc: true
 ---
+## 2023.8
+August 2023
+- Added [chats endpoints](https://waha.devlike.pro/docs/how-to/chats)
+  - Get all chats - `GET /api/{session/chats`
+  - Delete chat - `DELETE /api/{session/chats/{chatId}`
+  - Get messages from chat - `GET /api/{session/chats/{chatId}/messages?limit=1000?downloadMedia=true`
+  - Clear messages in the chat `DELETE /api/{session/chats/{chatId}/messages`
+- Added `downloadMedia` flag to speed up `GET /api/messages` and `GET /api/{session/chats/{chatId}/messages` performance.
+- Added [set presence endpoint](https://waha.devlike.pro/docs/how-to/presence)!
+  - With `online` presence you can show your status as online [#121](https://github.com/devlikeapro/whatsapp-http-api/issues/121)
+  - With `offline` presence you can get notifications for your device [#28](https://github.com/devlikeapro/whatsapp-http-api/issues/28)
+
 ## 2023.7
 July 2023
 - Now session can have their own [Webhooks](https://waha.devlike.pro/docs/how-to/webhooks) -

docs/site/content/en/docs/overview/quick-start/index.md

@@ -16,6 +16,8 @@ toc: true
 On this page you're going to install WAHA, run it, authenticate the client using QR code and send the first text message
 to WhatsApp!
 
+![](swagger.png)
+
 ## Requirements
 
 Only thing that you must have - installed docker. Please follow the original

src/api/chats.controller.ts

@@ -0,0 +1,56 @@
+import { Controller, Delete, Get, Param, Post, Query } from '@nestjs/common';
+import { ApiOperation, ApiSecurity, ApiTags } from '@nestjs/swagger';
+
+import { SessionManager } from '../core/abc/manager.abc';
+import { WhatsappSession } from '../core/abc/session.abc';
+import { SessionApiParam, SessionParam } from './helpers';
+import { GetChatMessagesQuery } from '../structures/chats.dto';
+import { parseBool } from '../helpers';
+
+@ApiSecurity('api_key')
+@Controller('api/:session/chats')
+@ApiTags('chats')
+class ChatsController {
+  constructor(private manager: SessionManager) {}
+
+  @Get('')
+  @SessionApiParam
+  @ApiOperation({ summary: 'Get all chats' })
+  getAllChats(@SessionParam session: WhatsappSession) {
+    return session.getChats();
+  }
+
+  @Delete(':chatId')
+  @SessionApiParam
+  @ApiOperation({ summary: 'Deletes the chat' })
+  deleteChat(
+    @SessionParam session: WhatsappSession,
+    @Param('chatId') chatId: string,
+  ) {
+    return session.deleteChat(chatId);
+  }
+
+  @Get(':chatId/messages')
+  @SessionApiParam
+  @ApiOperation({ summary: 'Gets messages in the chat' })
+  getChatMessages(
+    @Query() query: GetChatMessagesQuery,
+    @SessionParam session: WhatsappSession,
+    @Param('chatId') chatId: string,
+  ) {
+    const downloadMedia = parseBool(query.downloadMedia);
+    return session.getChatMessages(chatId, query.limit, downloadMedia);
+  }
+
+  @Delete(':chatId/messages')
+  @SessionApiParam
+  @ApiOperation({ summary: 'Clears all messages from the chat' })
+  clearMessages(
+    @SessionParam session: WhatsappSession,
+    @Param('chatId') chatId: string,
+  ) {
+    return session.clearMessages(chatId);
+  }
+}
+
+export { ChatsController };

src/api/presence.controller.ts

@@ -1,10 +1,21 @@
-import { Controller, Get, Param, Post } from '@nestjs/common';
+import {
+  BadRequestException,
+  Body,
+  Controller,
+  Get,
+  Param,
+  Post,
+} from '@nestjs/common';
 import { ApiOperation, ApiSecurity, ApiTags } from '@nestjs/swagger';
 
 import { SessionManager } from '../core/abc/manager.abc';
 import { WhatsappSession } from '../core/abc/session.abc';
-import { WAHAChatPresences } from '../structures/presence.dto';
+import {
+  WAHAChatPresences,
+  WAHASessionPresence,
+} from '../structures/presence.dto';
 import { SessionApiParam, SessionParam } from './helpers';
+import { WAHAPresenceStatus } from '../structures/enums.dto';
 
 @ApiSecurity('api_key')
 @Controller('api/:session/presence')
@@ -12,6 +23,36 @@ import { SessionApiParam, SessionParam } from './helpers';
 export class PresenceController {
   constructor(private manager: SessionManager) {}
 
+  @Post('')
+  @SessionApiParam
+  @ApiOperation({ summary: 'Set session presence' })
+  setPresence(
+    @SessionParam session: WhatsappSession,
+    @Body() request: WAHASessionPresence,
+  ) {
+    // Validate request
+    const presencesWithoutChatId = [
+      WAHAPresenceStatus.ONLINE,
+      WAHAPresenceStatus.OFFLINE,
+    ];
+    const requiresNoChatId = presencesWithoutChatId.includes(request.presence);
+    const requiresChatId = !requiresNoChatId;
+
+    if (requiresNoChatId && request.chatId) {
+      const msg = {
+        detail: `'${request.presence}' presence works on the global scope and doesn't require 'chatId' field.`,
+      };
+      throw new BadRequestException(msg);
+    } else if (requiresChatId && !request.chatId) {
+      const msg = {
+        detail: `'${request.presence}' presence requires 'chatId' field.`,
+      };
+      throw new BadRequestException(msg);
+    }
+
+    return session.setPresence(request.presence, request.chatId);
+  }
+
   @Get('')
   @SessionApiParam
   @ApiOperation({ summary: 'Get all subscribed presence information.' })

src/core/abc/session.abc.ts

@@ -22,6 +22,7 @@ import { ContactQuery, ContactRequest } from '../../structures/contacts.dto';
 import {
   WAHAEngine,
   WAHAEvents,
+  WAHAPresenceStatus,
   WAHASessionStatus,
 } from '../../structures/enums.dto';
 import {
@@ -42,6 +43,7 @@ export function getBrowserExecutablePath() {
   }
   return CHROMIUM_PATH;
 }
+
 export function ensureSuffix(phone) {
   const suffix = '@c.us';
   if (phone.includes('@')) {
@@ -167,10 +169,35 @@ export abstract class WhatsappSession {
 
   abstract stopTyping(chat: ChatRequest);
 
-  abstract getMessages(query: GetMessageQuery);
+  getMessages(query: GetMessageQuery) {
+    throw new NotImplementedByEngineError();
+  }
 
   abstract setReaction(request: MessageReactionRequest);
 
+  /**
+   * Chats methods
+   */
+  public getChats() {
+    throw new NotImplementedByEngineError();
+  }
+
+  public deleteChat(chatId) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public getChatMessages(
+    chatId: string,
+    limit: number,
+    downloadMedia: boolean,
+  ) {
+    throw new NotImplementedByEngineError();
+  }
+
+  public clearMessages(chatId) {
+    throw new NotImplementedByEngineError();
+  }
+
   /**
    * Contacts methods
    */
@@ -257,6 +284,10 @@ export abstract class WhatsappSession {
     throw new NotImplementedByEngineError();
   }
 
+  public setPresence(presence: WAHAPresenceStatus, chatId?: string) {
+    throw new NotImplementedByEngineError();
+  }
+
   public getPresences(): Promise<WAHAChatPresences[]> {
     throw new NotImplementedByEngineError();
   }

src/core/abc/storage.abc.ts

@@ -19,7 +19,7 @@ abstract class SessionStorage {
     this.engine = engine;
   }
 
-  abstract init(): Promise<void>;
+  abstract init(sessionName?: string): Promise<void>;
 
   abstract clean(sessionName: string): Promise<void>;
 

src/core/app.module.core.ts

@@ -13,6 +13,7 @@ import { VersionController } from '../api/version.controller';
 import { WhatsappConfigService } from '../config.service';
 import { SessionManager } from './abc/manager.abc';
 import { SessionManagerCore } from './manager.core';
+import { ChatsController } from '../api/chats.controller';
 
 export const IMPORTS = [
   ConfigModule.forRoot({
@@ -36,6 +37,7 @@ export const IMPORTS = [
 export const CONTROLLERS = [
   SessionsController,
   ChattingController,
+  ChatsController,
   ContactsController,
   GroupsController,
   PresenceController,

src/core/manager.core.ts

@@ -107,9 +107,6 @@ export class SessionManagerCore extends SessionManager {
     const storage = new this.MediaStorageClass();
     const webhookLog = new ConsoleLogger(`Webhook - ${name}`);
     const webhook = new this.WebhookConductorClass(webhookLog);
-
-    await this.sessionStorage.init();
-
     const proxyConfig = this.getProxyConfig(request);
     const sessionConfig: SessionParams = {
       name,
@@ -119,6 +116,7 @@ export class SessionManagerCore extends SessionManager {
       proxyConfig: proxyConfig,
       sessionConfig: request.config,
     };
+    await this.sessionStorage.init(name);
     // @ts-ignore
     const session = new this.EngineClass(sessionConfig);
     this.session = session;

src/core/session.noweb.core.ts

@@ -12,6 +12,7 @@ import { Agent } from 'https';
 import * as lodash from 'lodash';
 import { Message } from 'whatsapp-web.js';
 
+import { flipObject } from '../helpers';
 import {
   Button,
   ChatRequest,
@@ -78,6 +79,7 @@ const PresenceStatuses = {
   recording: WAHAPresenceStatus.RECORDING,
   paused: WAHAPresenceStatus.PAUSED,
 };
+const ToEnginePresenceStatus = flipObject(PresenceStatuses);
 
 export class WhatsappSessionNoWebCore extends WhatsappSession {
   engine = WAHAEngine.NOWEB;
@@ -305,10 +307,6 @@ export class WhatsappSessionNoWebCore extends WhatsappSession {
     return this.sock.sendPresenceUpdate('paused', request.chatId);
   }
 
-  async getMessages(query: GetMessageQuery) {
-    throw new NotImplementedByEngineError();
-  }
-
   async setReaction(request: MessageReactionRequest) {
     const key = parseMessageId(request.messageId);
     const reactionMessage = {
@@ -414,6 +412,16 @@ export class WhatsappSessionNoWebCore extends WhatsappSession {
     return this.sock.groupParticipantsUpdate(id, participants, 'demote');
   }
 
+  public async setPresence(presence: WAHAPresenceStatus, chatId?: string) {
+    const enginePresence = ToEnginePresenceStatus[presence];
+    if (!enginePresence) {
+      throw new NotImplementedByEngineError(
+        `NOWEB engine doesn't support '${presence}' presence.`,
+      );
+    }
+    await this.sock.sendPresenceUpdate(enginePresence, chatId);
+  }
+
   public async getPresences(): Promise<WAHAChatPresences[]> {
     const result: WAHAChatPresences[] = [];
     for (const remoteJid in this.store.presences) {

src/core/session.venom.core.ts

@@ -228,16 +228,16 @@ export class WhatsappSessionVenomCore extends WhatsappSession {
     // return this.whatsapp.stopTyping(chat.chatId);
   }
 
-  async getMessages(query: GetMessageQuery) {
+  async getChatMessages(chatId: string, limit: number) {
     const messages = await this.whatsapp.getAllMessagesInChat(
-      query.chatId,
+      chatId,
       true,
       false,
     );
     // Go over messages, download media, and convert to right format.
     const result = [];
     for (const [count, message] of messages.entries()) {
-      if (count > query.limit) {
+      if (count > limit) {
         // Have enough in the list, stop processing
         break;
       }
@@ -246,6 +246,10 @@ export class WhatsappSessionVenomCore extends WhatsappSession {
     return result;
   }
 
+  async getMessages(query: GetMessageQuery) {
+    return this.getChatMessages(query.chatId, query.limit);
+  }
+
   setReaction(request: MessageReactionRequest) {
     throw new NotImplementedByEngineError();
   }

src/core/session.webjs.core.ts

@@ -33,6 +33,7 @@ import { ContactQuery, ContactRequest } from '../structures/contacts.dto';
 import {
   WAHAEngine,
   WAHAEvents,
+  WAHAPresenceStatus,
   WAHASessionStatus,
 } from '../structures/enums.dto';
 import {
@@ -211,18 +212,7 @@ export class WhatsappSessionWebJSCore extends WhatsappSession {
   }
 
   async getMessages(query: GetMessageQuery) {
-    const chat: Chat = await this.whatsapp.getChatById(
-      this.ensureSuffix(query.chatId),
-    );
-    const messages = await chat.fetchMessages({
-      limit: query.limit,
-    });
-    // Go over messages, download media, and convert to right format.
-    const result = [];
-    for (const message of messages) {
-      result.push(await this.processIncomingMessage(message));
-    }
-    return result;
+    return this.getChatMessages(query.chatId, query.limit, query.downloadMedia);
   }
 
   async setReaction(request: MessageReactionRequest) {
@@ -235,6 +225,39 @@ export class WhatsappSessionWebJSCore extends WhatsappSession {
     return message.react(request.reaction);
   }
 
+  /**
+   * Chats methods
+   */
+  getChats() {
+    return this.whatsapp.getChats();
+  }
+
+  async getChatMessages(chatId: string, limit: number, downloadMedia: boolean) {
+    const chat: Chat = await this.whatsapp.getChatById(
+      this.ensureSuffix(chatId),
+    );
+    const messages = await chat.fetchMessages({
+      limit: limit,
+    });
+    // Go over messages, download media, and convert to right format.
+    const result = [];
+    for (const message of messages) {
+      const msg = await this.processIncomingMessage(message, downloadMedia);
+      result.push(msg);
+    }
+    return result;
+  }
+
+  async deleteChat(chatId) {
+    const chat = await this.whatsapp.getChatById(chatId);
+    return chat.delete();
+  }
+
+  async clearMessages(chatId) {
+    const chat = await this.whatsapp.getChatById(chatId);
+    return chat.clearMessages();
+  }
+
   /**
    * Contacts methods
    */
@@ -366,6 +389,34 @@ export class WhatsappSessionWebJSCore extends WhatsappSession {
     return groupChat.demoteParticipants(participantIds);
   }
 
+  public async setPresence(presence: WAHAPresenceStatus, chatId?: string) {
+    let chat: Chat;
+    switch (presence) {
+      case WAHAPresenceStatus.ONLINE:
+        await this.whatsapp.sendPresenceAvailable();
+        break;
+      case WAHAPresenceStatus.OFFLINE:
+        await this.whatsapp.sendPresenceUnavailable();
+        break;
+      case WAHAPresenceStatus.TYPING:
+        chat = await this.whatsapp.getChatById(chatId);
+        await chat.sendStateTyping();
+        break;
+      case WAHAPresenceStatus.RECORDING:
+        chat = await this.whatsapp.getChatById(chatId);
+        await chat.sendStateRecording();
+        break;
+      case WAHAPresenceStatus.PAUSED:
+        chat = await this.whatsapp.getChatById(chatId);
+        await chat.clearState();
+        break;
+      default:
+        throw new NotImplementedByEngineError(
+          `WEBJS engine doesn't support '${presence}' presence.`,
+        );
+    }
+  }
+
   /**
    * END - Methods for API
    */
@@ -397,8 +448,16 @@ export class WhatsappSessionWebJSCore extends WhatsappSession {
     }
   }
 
-  private processIncomingMessage(message: Message) {
-    return this.downloadMedia(message).then(this.toWAMessage);
+  private async processIncomingMessage(message: Message, downloadMedia = true) {
+    if (downloadMedia) {
+      try {
+        message = await this.downloadMedia(message);
+      } catch (e) {
+        this.log.error('Failed when tried to download media for a message');
+        this.log.error(e, e.stack);
+      }
+    }
+    return await this.toWAMessage(message);
   }
 
   protected toWAMessage(message: Message): Promise<WAMessage> {

src/core/storage.core.ts

@@ -67,8 +67,11 @@ export class SessionStorageCore extends LocalSessionStorage {
     return path.join(this.sessionsFolder, this.engine);
   }
 
-  async init() {
-    await fs.mkdir(this.engineFolder, { recursive: true });
+  async init(sessionName?: string) {
+    const folder = sessionName
+      ? this.getFolderPath(sessionName)
+      : this.engineFolder;
+    await fs.mkdir(folder, { recursive: true });
   }
 
   getFolderPath(name: string): string {

src/core/swagger.module.core.ts

@@ -16,7 +16,8 @@ export class SwaggerModuleCore {
       .setVersion(VERSION.version)
       .addTag('sessions', 'Control WhatsApp sessions')
       .addTag('screenshot', 'Get screenshot of WhatsApp and show QR code')
-      .addTag('chatting', 'Chat methods')
+      .addTag('chatting', 'Chatting methods')
+      .addTag('chats', `Chats methods`)
       .addTag(
         'contacts',
         `Contacts methods.<br>
@@ -24,10 +25,7 @@ export class SwaggerModuleCore {
                 'E.g: \`12312312310\` OR \`12312312310@c.us\`<br>`,
       )
       .addTag('groups', `Groups methods.<br>`)
-      .addTag(
-        'presence',
-        `Presence information. Available in <b>NOWEB</b> engine only.<br>`,
-      )
+      .addTag('presence', `Presence information`)
       .addTag('other', 'Other methods')
       .addApiKey({
         type: 'apiKey',

src/helpers.ts

@@ -1,4 +1,4 @@
-export function parseBool(value: any): boolean {
+function parseBool(value: any): boolean {
   if (!value) {
     return false;
   }
@@ -18,3 +18,11 @@ export function parseBool(value: any): boolean {
     'Error: parseBool got unexpected value - use "true" or "false" values',
   );
 }
+
+function flipObject(object) {
+  return Object.fromEntries(
+    Object.entries(object).map(([key, value]) => [value, key]),
+  );
+}
+
+export { flipObject, parseBool };

src/structures/chats.dto.ts

@@ -0,0 +1,21 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+import { SessionBaseRequest, SessionQuery } from './base.dto';
+
+/**
+ * Queries
+ */
+
+export class GetChatMessagesQuery extends SessionQuery {
+  limit: number = 100;
+  @ApiProperty({
+    example: true,
+    required: false,
+    description: 'Download media for messages',
+  })
+  downloadMedia: boolean = true;
+}
+
+/**
+ * Requests
+ */

src/structures/chatting.dto.ts

@@ -28,6 +28,12 @@ export class ChatQuery extends SessionQuery {
 export class GetMessageQuery extends ChatQuery {
   @IsNumber()
   limit: number;
+  @ApiProperty({
+    example: true,
+    required: false,
+    description: 'Download media for messages',
+  })
+  downloadMedia: true;
 }
 
 export class GetPresenceQuery extends ChatQuery {}

src/structures/presence.dto.ts

@@ -22,3 +22,13 @@ export class WAHAChatPresences {
   id: string;
   presences: WAHAPresenceData[];
 }
+
+export class WAHASessionPresence {
+  presence: WAHAPresenceStatus;
+
+  @ApiProperty({
+    description: 'Chat ID - either group id or contact id',
+    example: '11111111111@c.us',
+  })
+  chatId: string;
+}

src/version.ts

@@ -26,7 +26,7 @@ export function getWAHAVersion(): WAHAVersion {
 }
 
 export const VERSION = {
-  version: '2023.7.1',
+  version: '2023.7.16',
   tier: getWAHAVersion(),
   browser: getBrowserExecutablePath(),
 };