Merge pull request #409 from judsonjuniorr/feat/labels

Feat/labels

Author: DavidsonGomes

CHANGELOG.md

@@ -7,6 +7,7 @@
 * Join in Group by Invite Code
 * Read messages from whatsapp in chatwoot
 * Add support to use use redis in cacheservice
+* Add support for labels
 
 ### Fixed
 

Docker/.env.example

@@ -84,6 +84,8 @@ WEBHOOK_EVENTS_GROUPS_UPSERT=true
 WEBHOOK_EVENTS_GROUPS_UPDATE=true
 WEBHOOK_EVENTS_GROUP_PARTICIPANTS_UPDATE=true
 WEBHOOK_EVENTS_CONNECTION_UPDATE=true
+WEBHOOK_EVENTS_LABELS_EDIT=true
+WEBHOOK_EVENTS_LABELS_ASSOCIATION=true
 WEBHOOK_EVENTS_CALL=true
 # This event fires every time a new token is requested via the refresh route
 WEBHOOK_EVENTS_NEW_JWT_TOKEN=false

Docker/evolution-api-all-services/.env.example

@@ -73,6 +73,8 @@ WEBHOOK_EVENTS_GROUPS_UPSERT=true
 WEBHOOK_EVENTS_GROUPS_UPDATE=true
 WEBHOOK_EVENTS_GROUP_PARTICIPANTS_UPDATE=true
 WEBHOOK_EVENTS_CONNECTION_UPDATE=true
+WEBHOOK_EVENTS_LABELS_EDIT=true
+WEBHOOK_EVENTS_LABELS_ASSOCIATION=true
 # This event fires every time a new token is requested via the refresh route
 WEBHOOK_EVENTS_NEW_JWT_TOKEN=false
 

Dockerfile

@@ -98,6 +98,8 @@ ENV WEBHOOK_EVENTS_GROUPS_UPSERT=true
 ENV WEBHOOK_EVENTS_GROUPS_UPDATE=true
 ENV WEBHOOK_EVENTS_GROUP_PARTICIPANTS_UPDATE=true
 ENV WEBHOOK_EVENTS_CONNECTION_UPDATE=true
+ENV WEBHOOK_EVENTS_LABELS_EDIT=true
+ENV WEBHOOK_EVENTS_LABELS_ASSOCIATION=true
 ENV WEBHOOK_EVENTS_CALL=true
 
 ENV WEBHOOK_EVENTS_NEW_JWT_TOKEN=false

src/config/env.config.ts

@@ -34,13 +34,15 @@ export type SaveData = {
   MESSAGE_UPDATE: boolean;
   CONTACTS: boolean;
   CHATS: boolean;
+  LABELS: boolean;
 };
 
 export type StoreConf = {
   MESSAGES: boolean;
   MESSAGE_UP: boolean;
   CONTACTS: boolean;
   CHATS: boolean;
+  LABELS: boolean;
 };
 
 export type CleanStoreConf = {
@@ -103,6 +105,8 @@ export type EventsWebhook = {
   CHATS_DELETE: boolean;
   CHATS_UPSERT: boolean;
   CONNECTION_UPDATE: boolean;
+  LABELS_EDIT: boolean;
+  LABELS_ASSOCIATION: boolean;
   GROUPS_UPSERT: boolean;
   GROUP_UPDATE: boolean;
   GROUP_PARTICIPANTS_UPDATE: boolean;
@@ -237,6 +241,7 @@ export class ConfigService {
         MESSAGE_UP: process.env?.STORE_MESSAGE_UP === 'true',
         CONTACTS: process.env?.STORE_CONTACTS === 'true',
         CHATS: process.env?.STORE_CHATS === 'true',
+        LABELS: process.env?.STORE_LABELS === 'true',
       },
       CLEAN_STORE: {
         CLEANING_INTERVAL: Number.isInteger(process.env?.CLEAN_STORE_CLEANING_TERMINAL)
@@ -259,6 +264,7 @@ export class ConfigService {
           MESSAGE_UPDATE: process.env?.DATABASE_SAVE_MESSAGE_UPDATE === 'true',
           CONTACTS: process.env?.DATABASE_SAVE_DATA_CONTACTS === 'true',
           CHATS: process.env?.DATABASE_SAVE_DATA_CHATS === 'true',
+          LABELS: process.env?.DATABASE_SAVE_DATA_LABELS === 'true',
         },
       },
       REDIS: {
@@ -323,6 +329,8 @@ export class ConfigService {
           CHATS_UPSERT: process.env?.WEBHOOK_EVENTS_CHATS_UPSERT === 'true',
           CHATS_DELETE: process.env?.WEBHOOK_EVENTS_CHATS_DELETE === 'true',
           CONNECTION_UPDATE: process.env?.WEBHOOK_EVENTS_CONNECTION_UPDATE === 'true',
+          LABELS_EDIT: process.env?.WEBHOOK_EVENTS_LABELS_EDIT === 'true',
+          LABELS_ASSOCIATION: process.env?.WEBHOOK_EVENTS_LABELS_ASSOCIATION === 'true',
           GROUPS_UPSERT: process.env?.WEBHOOK_EVENTS_GROUPS_UPSERT === 'true',
           GROUP_UPDATE: process.env?.WEBHOOK_EVENTS_GROUPS_UPDATE === 'true',
           GROUP_PARTICIPANTS_UPDATE: process.env?.WEBHOOK_EVENTS_GROUP_PARTICIPANTS_UPDATE === 'true',

src/dev-env.yml

@@ -127,6 +127,8 @@ WEBHOOK:
     GROUP_UPDATE: true
     GROUP_PARTICIPANTS_UPDATE: true
     CONNECTION_UPDATE: true
+    LABELS_EDIT: true
+    LABELS_ASSOCIATION: true
     CALL: true
     # This event fires every time a new token is requested via the refresh route
     NEW_JWT_TOKEN: false

src/docs/swagger.yaml

@@ -51,6 +51,7 @@ tags:
   - name: Send Message Controller
   - name: Chat Controller
   - name: Group Controller
+  - name: Label Controller
   - name: Profile Settings
   - name: JWT
   - name: Settings
@@ -1856,6 +1857,8 @@ paths:
                       "GROUP_UPDATE",
                       "GROUP_PARTICIPANTS_UPDATE",
                       "CONNECTION_UPDATE",
+                      "LABELS_EDIT",
+                      "LABELS_ASSOCIATION",
                       "CALL",
                       "NEW_JWT_TOKEN",
                     ]
@@ -1932,6 +1935,8 @@ paths:
                       "GROUP_UPDATE",
                       "GROUP_PARTICIPANTS_UPDATE",
                       "CONNECTION_UPDATE",
+                      "LABELS_EDIT",
+                      "LABELS_ASSOCIATION",
                       "CALL",
                       "NEW_JWT_TOKEN",
                     ]
@@ -2008,6 +2013,8 @@ paths:
                       "GROUP_UPDATE",
                       "GROUP_PARTICIPANTS_UPDATE",
                       "CONNECTION_UPDATE",
+                      "LABELS_EDIT",
+                      "LABELS_ASSOCIATION",
                       "CALL",
                       "NEW_JWT_TOKEN",
                     ]
@@ -2046,6 +2053,97 @@ paths:
           content:
             application/json: {}
 
+  /label/findLabels/{instanceName}:
+    get:
+      tags:
+        - Label Controller
+      summary: List all labels for an instance.
+      parameters:
+        - name: instanceName
+          in: path
+          schema:
+            type: string
+          required: true
+          description: "- required"
+          example: "evolution"
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    color:
+                      type: integer
+                    name:
+                      type: string
+                    id:
+                      type: string
+                    predefinedId:
+                      type: string
+                  required:
+                    - color
+                    - name
+                    - id
+  /label/handleLabel/{instanceName}:
+    put:
+      tags:
+        - Label Controller
+      summary: Change the label (add or remove) for an specific chat.
+      parameters:
+        - name: instanceName
+          in: path
+          schema:
+            type: string
+          required: true
+          description: "- required"
+          example: "evolution"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                number:
+                  type: string
+                labelId:
+                  type: string
+                action:
+                  type: string
+                  enum:
+                    - add
+                    - remove
+              required:
+                - number
+                - labelId
+                - action
+            example:
+              number: '553499999999'
+              labelId: '1'
+              action: add
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  numberJid:
+                    type: string
+                  labelId:
+                    type: string
+                  remove:
+                    type: boolean
+                  add:
+                    type: boolean
+                required:
+                  - numberJid
+                  - labelId
+
   /settings/set/{instanceName}:
     post:
       tags:

src/validate/validate.schema.ts

@@ -53,6 +53,8 @@ export const instanceNameSchema: JSONSchema7 = {
           'GROUP_UPDATE',
           'GROUP_PARTICIPANTS_UPDATE',
           'CONNECTION_UPDATE',
+          'LABELS_EDIT',
+          'LABELS_ASSOCIATION',
           'CALL',
           'NEW_JWT_TOKEN',
           'TYPEBOT_START',
@@ -897,6 +899,8 @@ export const webhookSchema: JSONSchema7 = {
           'GROUP_UPDATE',
           'GROUP_PARTICIPANTS_UPDATE',
           'CONNECTION_UPDATE',
+          'LABELS_EDIT',
+          'LABELS_ASSOCIATION',
           'CALL',
           'NEW_JWT_TOKEN',
           'TYPEBOT_START',
@@ -977,6 +981,8 @@ export const websocketSchema: JSONSchema7 = {
           'GROUP_UPDATE',
           'GROUP_PARTICIPANTS_UPDATE',
           'CONNECTION_UPDATE',
+          'LABELS_EDIT',
+          'LABELS_ASSOCIATION',
           'CALL',
           'NEW_JWT_TOKEN',
           'TYPEBOT_START',
@@ -1020,6 +1026,8 @@ export const rabbitmqSchema: JSONSchema7 = {
           'GROUP_UPDATE',
           'GROUP_PARTICIPANTS_UPDATE',
           'CONNECTION_UPDATE',
+          'LABELS_EDIT',
+          'LABELS_ASSOCIATION',
           'CALL',
           'NEW_JWT_TOKEN',
           'TYPEBOT_START',
@@ -1063,6 +1071,8 @@ export const sqsSchema: JSONSchema7 = {
           'GROUP_UPDATE',
           'GROUP_PARTICIPANTS_UPDATE',
           'CONNECTION_UPDATE',
+          'LABELS_EDIT',
+          'LABELS_ASSOCIATION',
           'CALL',
           'NEW_JWT_TOKEN',
           'TYPEBOT_START',
@@ -1150,3 +1160,14 @@ export const chamaaiSchema: JSONSchema7 = {
   required: ['enabled', 'url', 'token', 'waNumber', 'answerByAudio'],
   ...isNotEmpty('enabled', 'url', 'token', 'waNumber', 'answerByAudio'),
 };
+
+export const handleLabelSchema: JSONSchema7 = {
+  $id: v4(),
+  type: 'object',
+  properties: {
+    number: { ...numberDefinition },
+    labelId: { type: 'string' },
+    action: { type: 'string', enum: ['add', 'remove'] },
+  },
+  required: ['number', 'labelId', 'action'],
+};

src/whatsapp/controllers/instance.controller.ts

@@ -151,6 +151,8 @@ export class InstanceController {
               'GROUP_UPDATE',
               'GROUP_PARTICIPANTS_UPDATE',
               'CONNECTION_UPDATE',
+              'LABELS_EDIT',
+              'LABELS_ASSOCIATION',
               'CALL',
               'NEW_JWT_TOKEN',
               'TYPEBOT_START',
@@ -201,6 +203,8 @@ export class InstanceController {
               'GROUP_UPDATE',
               'GROUP_PARTICIPANTS_UPDATE',
               'CONNECTION_UPDATE',
+              'LABELS_EDIT',
+              'LABELS_ASSOCIATION',
               'CALL',
               'NEW_JWT_TOKEN',
               'TYPEBOT_START',
@@ -248,6 +252,8 @@ export class InstanceController {
               'GROUP_UPDATE',
               'GROUP_PARTICIPANTS_UPDATE',
               'CONNECTION_UPDATE',
+              'LABELS_EDIT',
+              'LABELS_ASSOCIATION',
               'CALL',
               'NEW_JWT_TOKEN',
               'TYPEBOT_START',
@@ -295,6 +301,8 @@ export class InstanceController {
               'GROUP_UPDATE',
               'GROUP_PARTICIPANTS_UPDATE',
               'CONNECTION_UPDATE',
+              'LABELS_EDIT',
+              'LABELS_ASSOCIATION',
               'CALL',
               'NEW_JWT_TOKEN',
               'TYPEBOT_START',

src/whatsapp/controllers/label.controller.ts

@@ -0,0 +1,20 @@
+import { Logger } from '../../config/logger.config';
+import { InstanceDto } from '../dto/instance.dto';
+import { HandleLabelDto } from '../dto/label.dto';
+import { WAMonitoringService } from '../services/monitor.service';
+
+const logger = new Logger('LabelController');
+
+export class LabelController {
+  constructor(private readonly waMonitor: WAMonitoringService) {}
+
+  public async fetchLabels({ instanceName }: InstanceDto) {
+    logger.verbose('requested fetchLabels from ' + instanceName + ' instance');
+    return await this.waMonitor.waInstances[instanceName].fetchLabels();
+  }
+
+  public async handleLabel({ instanceName }: InstanceDto, data: HandleLabelDto) {
+    logger.verbose('requested chat label change from ' + instanceName + ' instance');
+    return await this.waMonitor.waInstances[instanceName].handleLabel(data);
+  }
+}