Merge branch 'release/1.1.4'

Author: dgcode-tec

.gitignore

@@ -2,6 +2,8 @@
 /dist
 /node_modules
 
+/Docker/.env
+
 # Logs
 logs/**.json
 *.log
@@ -12,6 +14,7 @@ yarn-error.log*
 lerna-debug.log*
 
 /docker-compose-data
+/docker-data
 
 # Package
 /yarn.lock

CHANGELOG.md

@@ -1,3 +1,19 @@
+# 1.1.4 (2023-07-08 11:01)
+
+### Features
+
+* Route to send status broadcast
+* Added verbose logs
+* Insert allContacts in payload of endpoint sendStatus
+
+### Fixed
+
+* Adjusted set in webhook to go empty when enabled false
+* Adjust in store files
+* Fixed the problem when do not save contacts when receive messages
+* Changed owner of the jid for instanceName
+* Create .env for installation in docker
+
 # 1.1.3 (2023-07-06 11:43)
 
 ### Features

Docker/.env.example

@@ -0,0 +1,91 @@
+CORS_ORIGIN='*' # Or separate by commas -  ex.: 'yourdomain1.com, yourdomain2.com'
+CORS_METHODS='POST,GET,PUT,DELETE'
+CORS_CREDENTIALS=true
+
+# Determine the logs to be displayed
+LOG_LEVEL='ERROR,WARN,DEBUG,INFO,LOG,VERBOSE,DARK,WEBHOOKS'
+LOG_COLOR=true
+LOG_BAILEYS=error # "fatal" | "error" | "warn" | "info" | "debug" | "trace"
+
+# Determine how long the instance should be deleted from memory in case of no connection.
+# Default time: 5 minutes
+# If you don't even want an expiration, enter the value false
+DEL_INSTANCE=false
+
+# Temporary data storage
+STORE_MESSAGES=true
+STORE_MESSAGE_UP=true
+STORE_CONTACTS=true
+STORE_CHATS=true
+CLEAN_STORE_CLEANING_INTERVAL=7200 # seconds === 2h
+CLEAN_STORE_MESSAGES=true
+CLEAN_STORE_MESSAGE_UP=true
+CLEAN_STORE_CONTACTS=true
+CLEAN_STORE_CHATS=true
+
+# Permanent data storage
+DATABASE_ENABLED=false
+DATABASE_CONNECTION_URI=mongodb://root:root@mongodb:27017/?authSource=admin&readPreference=primary&ssl=false&directConnection=true
+DATABASE_CONNECTION_DB_PREFIX_NAME=evolution
+
+# Choose the data you want to save in the application's database or store
+DATABASE_SAVE_DATA_INSTANCE=true
+DATABASE_SAVE_DATA_OLD_MESSAGE=false
+DATABASE_SAVE_DATA_NEW_MESSAGE=true
+DATABASE_SAVE_MESSAGE_UPDATE=true
+DATABASE_SAVE_DATA_CONTACTS=true
+DATABASE_SAVE_DATA_CHATS=true
+
+REDIS_ENABLED=false
+REDIS_URI=redis://redis:6379/1
+REDIS_PREFIX_KEY=evolution
+
+# Webhook Settings
+## Define a global webhook that will listen for enabled events from all instances
+WEBHOOK_GLOBAL_URL='<url>'
+WEBHOOK_GLOBAL_ENABLED=false
+# With this option activated, you work with a url per webhook event, respecting the global url and the name of each event
+WEBHOOK_GLOBAL_WEBHOOK_BY_EVENTS=false
+## Set the events you want to hear  
+WEBHOOK_EVENTS_APPLICATION_STARTUP=false
+WEBHOOK_EVENTS_QRCODE_UPDATED=true
+WEBHOOK_EVENTS_MESSAGES_SET=true
+WEBHOOK_EVENTS_MESSAGES_UPSERT=true
+WEBHOOK_EVENTS_MESSAGES_UPDATE=true
+WEBHOOK_EVENTS_CONTACTS_SET=true
+WEBHOOK_EVENTS_CONTACTS_UPSERT=true
+WEBHOOK_EVENTS_CONTACTS_UPDATE=true
+WEBHOOK_EVENTS_PRESENCE_UPDATE=true
+WEBHOOK_EVENTS_CHATS_SET=true
+WEBHOOK_EVENTS_CHATS_UPSERT=true
+WEBHOOK_EVENTS_CHATS_UPDATE=true
+WEBHOOK_EVENTS_CHATS_DELETE=true
+WEBHOOK_EVENTS_GROUPS_UPSERT=true
+WEBHOOK_EVENTS_GROUPS_UPDATE=true
+WEBHOOK_EVENTS_GROUP_PARTICIPANTS_UPDATE=true
+WEBHOOK_EVENTS_CONNECTION_UPDATE=true
+# This event fires every time a new token is requested via the refresh route
+WEBHOOK_EVENTS_NEW_JWT_TOKEN=true
+
+# Name that will be displayed on smartphone connection
+CONFIG_SESSION_PHONE_CLIENT=Evolution API
+CONFIG_SESSION_PHONE_NAME=chrome # chrome | firefox | edge | opera | safari
+
+# Set qrcode display limit
+QRCODE_LIMIT=30
+
+# Defines an authentication type for the api
+AUTHENTICATION_TYPE='apikey' # jwt or 'apikey'
+## Define a global apikey to access all instances.
+### OBS: This key must be inserted in the request header to create an instance.
+AUTHENTICATION_API_KEY='B6D711FCDE4D4FD5936544120E713976'
+AUTHENTICATION_EXPOSE_IN_FETCH_INSTANCES=true
+## Set the secret key to encrypt and decrypt your token and its expiration time
+AUTHENTICATION_JWT_EXPIRIN_IN=0 # seconds - 3600s ===1h | zero (0) - never expires
+AUTHENTICATION_JWT_SECRET='L0YWtjb2w554WFqPG'
+# Set the instance name and webhook url to create an instance in init the application
+# With this option activated, you work with a url per webhook event, respecting the local url and the name of each event
+AUTHENTICATION_INSTANCE_MODE=server # container or server
+# if you are using container mode, set the container name and the webhook url to default instance
+AUTHENTICATION_INSTANCE_NAME=evolution
+AUTHENTICATION_INSTANCE_WEBHOOK_URL=<url>

Docker/redis/docker-compose.yaml

@@ -7,16 +7,6 @@ networks:
 services:
   redis:
     image: redis:latest
-    command: >
-      redis-server
-      --port 6379
-      --appendonly yes
-      --save 900 1
-      --save 300 10
-      --save 60 10000
-      --appendfsync everysec
-    volumes:
-      - evolution_redis:/data
     container_name: redis
     ports:
       - 6379:6379

Dockerfile

@@ -48,6 +48,7 @@ ENV DATABASE_SAVE_DATA_CHATS=$DATABASE_SAVE_DATA_CHATS
 
 ENV REDIS_ENABLED=$REDIS_ENABLED
 ENV REDIS_URI=$REDIS_URI
+ENV REDIS_PREFIX_KEY=$REDIS_PREFIX_KEY
 
 ENV WEBHOOK_GLOBAL_URL=$WEBHOOK_GLOBAL_URL
 ENV WEBHOOK_GLOBAL_ENABLED=$WEBHOOK_GLOBAL_ENABLED

docker-compose.yaml

@@ -8,89 +8,14 @@ services:
   api:
     container_name: evolution_api
     image: evolution/api:local
+    restart: always
     ports:
       - 8080:8080
     volumes:
       - evolution_instances:/evolution/instances
       - evolution_store:/evolution/store
-    environment:
-      - LOG_LEVEL=ERROR,WARN,DEBUG,INFO,LOG,VERBOSE,DARK,WEBHOOKS
-      - LOG_BAILEYS=error
-      # Determine how long the instance should be deleted from memory in case of no connection.
-      # Default time: 5 minutes
-      # If you don't even want an expiration, enter the value false
-      - DEL_INSTANCE=false # 5 or false
-      # Temporary data storage
-      - STORE_MESSAGES=true
-      - STORE_MESSAGE_UP=true
-      - STORE_CONTACTS=true
-      - STORE_CHATS=true
-      - CLEAN_STORE_CLEANING_INTERVAL=7200 # seconds === 2h
-      - CLEAN_STORE_MESSAGES=true
-      - CLEAN_STORE_MESSAGE_UP=true
-      - CLEAN_STORE_CONTACTS=true
-      - CLEAN_STORE_CHATS=true
-      # Permanent data storage
-      - DATABASE_ENABLED=false
-      - DATABASE_CONNECTION_URI=mongodb://root:root@mongodb:27017/?authSource=admin&readPreference=primary&ssl=false&directConnection=true
-      - DATABASE_CONNECTION_DB_PREFIX_NAME=evolution
-      # Choose the data you want to save in the application's database or store
-      - DATABASE_SAVE_DATA_INSTANCE=true
-      - DATABASE_SAVE_DATA_OLD_MESSAGE=false
-      - DATABASE_SAVE_DATA_NEW_MESSAGE=true
-      - DATABASE_SAVE_MESSAGE_UPDATE=true
-      - DATABASE_SAVE_DATA_CONTACTS=true
-      - DATABASE_SAVE_DATA_CHATS=true
-      - REDIS_ENABLED=true
-      - REDIS_URI=redis://redis:6379/1
-      - REDIS_PREFIX_KEY=evolution
-      # Webhook Settings
-      # Define a global webhook that will listen for enabled events from all instances
-      - WEBHOOK_GLOBAL_URL=<url>
-      - WEBHOOK_GLOBAL_ENABLED=false
-      # With this option activated, you work with a url per webhook event, respecting the global url and the name of each event
-      - WEBHOOK_GLOBAL_WEBHOOK_BY_EVENTS=false
-      # Automatically maps webhook paths
-      # Set the events you want to hear 
-      - WEBHOOK_EVENTS_APPLICATION_STARTUP=false
-      - WEBHOOK_EVENTS_QRCODE_UPDATED=true
-      - WEBHOOK_EVENTS_MESSAGES_SET=true
-      - WEBHOOK_EVENTS_MESSAGES_UPSERT=true
-      - WEBHOOK_EVENTS_MESSAGES_UPDATE=true
-      - WEBHOOK_EVENTS_CONTACTS_SET=true
-      - WEBHOOK_EVENTS_CONTACTS_UPSERT=true
-      - WEBHOOK_EVENTS_CONTACTS_UPDATE=true
-      - WEBHOOK_EVENTS_PRESENCE_UPDATE=true
-      - WEBHOOK_EVENTS_CHATS_SET=true
-      - WEBHOOK_EVENTS_CHATS_UPSERT=true
-      - WEBHOOK_EVENTS_CHATS_UPDATE=true
-      - WEBHOOK_EVENTS_CHATS_DELETE=true
-      - WEBHOOK_EVENTS_GROUPS_UPSERT=true
-      - WEBHOOK_EVENTS_GROUPS_UPDATE=true
-      - WEBHOOK_EVENTS_GROUP_PARTICIPANTS_UPDATE=true
-      - WEBHOOK_EVENTS_CONNECTION_UPDATE=true
-      # This event fires every time a new token is requested via the refresh route
-      - WEBHOOK_EVENTS_NEW_JWT_TOKEN=true
-      # Name that will be displayed on smartphone connection
-      - CONFIG_SESSION_PHONE_CLIENT=Evolution API
-      - CONFIG_SESSION_PHONE_NAME=chrome # chrome | firefox | edge | opera | safari
-      # Set qrcode display limit
-      - QRCODE_LIMIT=30
-      # Defines an authentication type for the api
-      - AUTHENTICATION_TYPE=apikey # jwt or apikey
-      # Define a global apikey to access all instances
-      # OBS: This key must be inserted in the request header to create an instance.
-      - AUTHENTICATION_API_KEY=B6D711FCDE4D4FD5936544120E713976
-      # Expose the api key on return from fetch instances
-      - AUTHENTICATION_EXPOSE_IN_FETCH_INSTANCES=true
-      # Set the secret key to encrypt and decrypt your token and its expiration time.
-      - AUTHENTICATION_JWT_EXPIRIN_IN=0 # seconds - 3600s === 1h | zero (0) - never expires
-      # Set the instance name and webhook url to create an instance in init the application
-      # With this option activated, you work with a url per webhook event, respecting the local url and the name of each event
-      - AUTHENTICATION_INSTANCE_MODE=server # container or server
-      # if you are using container mode, set the container name and the webhook url to default instance
-      - AUTHENTICATION_INSTANCE_NAME=evolution
-      - AUTHENTICATION_INSTANCE_WEBHOOK_URL=<url>
+    env_file:
+      - ./Docker/.env
     command: ['node', './dist/src/main.js']
     networks:
       - evolution-net

package.json

@@ -1,6 +1,6 @@
 {
   "name": "evolution-api",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "Rest api for communication with WhatsApp",
   "main": "./dist/src/main.js",
   "scripts": {
@@ -12,7 +12,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/DavidsonGomes/evolution-api.git"
+    "url": "git+https://github.com/EvolutionAPI/evolution-api.git"
   },
   "keywords": [
     "chat",
@@ -36,14 +36,14 @@
   },
   "license": "GPL-3.0",
   "bugs": {
-    "url": "https://github.com/DavidsonGomes/evolution-api/issues"
+    "url": "https://github.com/EvolutionAPI/evolution-api/issues"
   },
-  "homepage": "https://github.com/DavidsonGomes/evolution-api#readme",
+  "homepage": "https://github.com/EvolutionAPI/evolution-api#readme",
   "dependencies": {
     "@adiwajshing/keyed-db": "^0.2.4",
     "@ffmpeg-installer/ffmpeg": "^1.1.0",
     "@hapi/boom": "^10.0.1",
-    "@whiskeysockets/baileys": "^6.3.0",
+    "@whiskeysockets/baileys": "github:EvolutionAPI/Baileys",
     "axios": "^1.3.5",
     "class-validator": "^0.13.2",
     "compression": "^1.7.4",
@@ -65,6 +65,7 @@
     "node-cache": "^5.1.2",
     "node-mime-types": "^1.1.0",
     "pino": "^8.11.0",
+    "proxy-agent": "^6.2.1",
     "qrcode": "^1.5.1",
     "qrcode-terminal": "^0.12.0",
     "redis": "^4.6.5",

src/config/path.config.ts

@@ -4,3 +4,4 @@ export const ROOT_DIR = process.cwd();
 export const INSTANCE_DIR = join(ROOT_DIR, 'instances');
 export const SRC_DIR = join(ROOT_DIR, 'src');
 export const AUTH_DIR = join(ROOT_DIR, 'store', 'auth');
+export const STORE_DIR = join(ROOT_DIR, 'store');

src/db/redis.client.ts

@@ -104,9 +104,11 @@ export class RedisCache {
   public async delAll(hash?: string) {
     try {
       this.logger.verbose('instance delAll: ' + hash);
-      return await this.client.del(
+      const result = await this.client.del(
         hash || this.redisEnv.PREFIX_KEY + ':' + this.instanceName,
       );
+
+      return result;
     } catch (error) {
       this.logger.error(error);
     }

src/validate/validate.schema.ts

@@ -30,7 +30,7 @@ export const instanceNameSchema: JSONSchema7 = {
     webhook_by_events: { type: 'boolean' },
     events: {
       type: 'array',
-      minItems: 1,
+      minItems: 0,
       items: {
         type: 'string',
         enum: [
@@ -189,6 +189,37 @@ export const pollMessageSchema: JSONSchema7 = {
   required: ['pollMessage', 'number'],
 };
 
+export const statusMessageSchema: JSONSchema7 = {
+  $id: v4(),
+  type: 'object',
+  properties: {
+    statusMessage: {
+      type: 'object',
+      properties: {
+        type: { type: 'string', enum: ['text', 'image', 'audio', 'video'] },
+        content: { type: 'string' },
+        caption: { type: 'string' },
+        backgroundColor: { type: 'string' },
+        font: { type: 'integer', minimum: 0, maximum: 5 },
+        statusJidList: {
+          type: 'array',
+          minItems: 1,
+          uniqueItems: true,
+          items: {
+            type: 'string',
+            pattern: '^\\d+',
+            description: '"statusJidList" must be an array of numeric strings',
+          },
+        },
+        allContacts: { type: 'boolean', enum: [true, false] },
+      },
+      required: ['type', 'content'],
+      ...isNotEmpty('type', 'content'),
+    },
+  },
+  required: ['statusMessage'],
+};
+
 export const mediaMessageSchema: JSONSchema7 = {
   $id: v4(),
   type: 'object',
@@ -795,7 +826,7 @@ export const webhookSchema: JSONSchema7 = {
     enabled: { type: 'boolean', enum: [true, false] },
     events: {
       type: 'array',
-      minItems: 1,
+      minItems: 0,
       items: {
         type: 'string',
         enum: [