@green-api/greenapi-integration 0.9.0 → 0.10.0

package/dist/core/base-adapter.js

@@ -61,6 +61,8 @@ class BaseAdapter {
         return new green_api_client_1.GreenApiClient({
             idInstance: instance.idInstance,
             apiTokenInstance: instance.apiTokenInstance,
+            apiUrl: instance.apiUrl,
+            mediaUrl: instance.mediaUrl,
         });
     }
     /**

package/dist/core/green-api.client.d.ts

@@ -1,4 +1,4 @@
-import { Instance, Settings, SendMessage, SendFileByUrl, SendFileByUpload, SendPoll, StateInstance, Reboot, Logout, QR, SendResponse, SendFileByUploadResponse, SetSettingsResponse, GetAuthorizationCode, SetProfilePicture, WaSettings, AccountSettings, UploadFile, SendLocation, SendContact, ForwardMessages, ForwardMessagesResponse, QueueMessage, ClearMessagesQueue, ReadChatResponse, ReadChat, CheckWhatsapp, CheckWhatsappResponse, CheckAccount, CheckAccountResponse, GetAvatarResponse, GetAvatar, Contact, ContactInfo, ArchiveChat, UnarchiveChat, SetDisappearingChat, SetDisappearingChatResponse, CreateGroupResponse, CreateGroup, UpdateGroupName, UpdateGroupNameResponse, GetGroupData, GroupData, AddGroupParticipant, AddGroupParticipantResponse, RemoveGroupParticipant, RemoveGroupParticipantResponse, SetGroupAdmin, SetGroupAdminResponse, RemoveAdminResponse, RemoveAdmin, SetGroupPicture, SetGroupPictureResponse, LeaveGroup, LeaveGroupResponse, GetMessage, JournalResponse, GetChatHistory, IncomingJournalResponse, OutgoingJournalResponse, SendInteractiveButtons, SendInteractiveButtonsReply, SendTextStatus, SendVoiceStatus, SendMediaStatus, GetStatusStatisticResponse } from "../types/types";
+import { Instance, Settings, SendMessage, SendFileByUrl, SendFileByUpload, SendPoll, StateInstance, Reboot, Logout, QR, SendResponse, SendFileByUploadResponse, SetSettingsResponse, GetAuthorizationCode, SetProfilePicture, WaSettings, AccountSettings, UploadFile, SendLocation, SendContact, ForwardMessages, ForwardMessagesResponse, QueueMessage, ClearMessagesQueue, ReadChatResponse, ReadChat, CheckWhatsapp, CheckWhatsappResponse, CheckAccount, CheckAccountResponse, GetAvatarResponse, GetAvatar, Contact, ContactInfo, ArchiveChat, UnarchiveChat, SetDisappearingChat, SetDisappearingChatResponse, CreateGroupResponse, CreateGroup, UpdateGroupName, UpdateGroupNameResponse, GetGroupData, GroupData, AddGroupParticipant, AddGroupParticipantResponse, RemoveGroupParticipant, RemoveGroupParticipantResponse, SetGroupAdmin, SetGroupAdminResponse, RemoveAdminResponse, RemoveAdmin, SetGroupPicture, SetGroupPictureResponse, LeaveGroup, LeaveGroupResponse, GetMessage, JournalResponse, GetChatHistory, IncomingJournalResponse, OutgoingJournalResponse, SendInteractiveButtons, SendInteractiveButtonsReply, SendTextStatus, SendVoiceStatus, SendMediaStatus, GetStatusStatisticResponse, GreenApiClientOptions, ReceiveNotificationResponse, DeleteNotificationResponse } from "../types/types";
 /**
  * Client for direct interaction with GREEN-API's WhatsApp gateway.
  * Provides methods for sending messages, managing instances, and handling files.
@@ -22,16 +22,22 @@ import { Instance, Settings, SendMessage, SendFileByUrl, SendFileByUpload, SendP
 export declare class GreenApiClient {
     private instance;
     private client;
+    private mediaClient;
     private readonly baseUrl;
+    private readonly mediaBaseUrl;
     private readonly gaLogger;
     /**
      * Creates a GREEN-API client instance.
      *
-     * @param instance - Configuration containing idInstance and apiTokenInstance
+     * @param instance - Configuration containing idInstance, apiTokenInstance and optionally apiUrl and mediaUrl
+     * @param options - Client options, e.g. `logger: null` to disable request logging
      */
-    constructor(instance: Instance);
+    constructor(instance: Instance, options?: GreenApiClientOptions);
     private buildUrl;
+    private toBlob;
+    private toBuffer;
     private buildEndpoint;
+    private redactToken;
     private makeRequest;
     private makeFileUploadRequest;
     /**
@@ -266,18 +272,32 @@ export declare class GreenApiClient {
     /**
      * Sets the profile picture for the WhatsApp account.
      *
-     * @param file - Image file to use as profile picture
+     * @param file - Image file (jpg) to use as profile picture
+     * @param fileName - File name with extension
      * @returns Promise resolving to profile picture update response
      */
-    setProfilePicture(file: Blob | File): Promise<SetProfilePicture>;
+    setProfilePicture(file: Blob | File | Uint8Array, fileName?: string): Promise<SetProfilePicture>;
     /**
      * Uploads a file to GREEN-API servers.
      *
      * @param file - File to upload
-     * @param customFileName - Optional custom name for the file
+     * @param fileName - File name with extension
      * @returns Promise resolving to upload response with file URL
      */
-    uploadFile(file: Blob | File, customFileName?: string): Promise<UploadFile>;
+    uploadFile(file: Blob | File | Uint8Array, fileName?: string): Promise<UploadFile>;
+    /**
+     * Calls any GREEN-API method that takes a file.
+     *
+     * @param endpoint - GREEN-API method name, e.g. "setGroupPicture"
+     * @param file - File content and file name
+     * @param fields - Other form fields
+     * @returns Promise resolving to the raw response body
+     */
+    requestWithFile<T = unknown>(endpoint: string, file: {
+        data: Blob | File | Uint8Array;
+        fileName: string;
+    }, fields?: Record<string, string | number | boolean>): Promise<T>;
+    private pictureFileName;
     /**
      * Gets authorization code for a phone number.
      *
@@ -315,6 +335,43 @@ export declare class GreenApiClient {
      * ```
      */
     clearMessagesQueue(): Promise<ClearMessagesQueue>;
+    /**
+     * Calls any GREEN-API method by name.
+     *
+     * @param method - HTTP method
+     * @param endpoint - GREEN-API method name, e.g. "getContacts"
+     * @param data - Request body for POST
+     * @param queryParams - Query parameters
+     * @returns Promise resolving to the raw response body
+     *
+     * @example
+     * ```typescript
+     * const contacts = await client.request("get", "getContacts");
+     * ```
+     */
+    request<T = unknown>(method: "get" | "post" | "delete", endpoint: string, data?: unknown, queryParams?: Record<string, string | number>): Promise<T>;
+    /**
+     * Receives the next notification from the instance queue.
+     *
+     * @param receiveTimeout - Seconds to wait for a notification, 5 to 60
+     * @returns Promise resolving to the notification, or null when the queue stayed empty
+     *
+     * @example
+     * ```typescript
+     * const notification = await client.receiveNotification(20);
+     * if (notification) {
+     *   await client.deleteNotification(notification.receiptId);
+     * }
+     * ```
+     */
+    receiveNotification(receiveTimeout?: number): Promise<ReceiveNotificationResponse | null>;
+    /**
+     * Deletes a processed notification from the instance queue.
+     *
+     * @param receiptId - Receipt ID from receiveNotification
+     * @returns Promise resolving to deletion result
+     */
+    deleteNotification(receiptId: number): Promise<DeleteNotificationResponse>;
     /**
      * Marks messages in a chat as read.
      * For this to work, "Receive webhooks on incoming messages and files" setting must be enabled.

package/dist/core/green-api.client.js

@@ -32,47 +32,71 @@ class GreenApiClient {
     /**
      * Creates a GREEN-API client instance.
      *
-     * @param instance - Configuration containing idInstance and apiTokenInstance
+     * @param instance - Configuration containing idInstance, apiTokenInstance and optionally apiUrl and mediaUrl
+     * @param options - Client options, e.g. `logger: null` to disable request logging
      */
-    constructor(instance) {
+    constructor(instance, options = {}) {
         this.instance = instance;
-        this.gaLogger = logger_1.GreenApiLogger.getInstance(GreenApiClient.name);
         this.baseUrl = (instance.apiUrl || defaults_1.DEFAULT_API_URL).replace(/\/+$/, "");
+        this.mediaBaseUrl = (instance.mediaUrl || this.baseUrl).replace(/\/+$/, "");
         this.client = axios_1.default.create({
-            baseURL: this.buildUrl(),
+            baseURL: this.buildUrl(this.baseUrl),
         });
+        this.mediaClient = axios_1.default.create({
+            baseURL: this.buildUrl(this.mediaBaseUrl),
+        });
+        this.gaLogger = options.logger === undefined ? logger_1.GreenApiLogger.getInstance(GreenApiClient.name) : options.logger;
+    }
+    buildUrl(host) {
+        return `${host}/waInstance${this.instance.idInstance}`;
+    }
+    toBlob(data) {
+        return data instanceof Blob ? data : new Blob([data]);
     }
-    buildUrl() {
-        return `${this.baseUrl}/waInstance${this.instance.idInstance}`;
+    toBuffer(data) {
+        return Buffer.isBuffer(data) ? data : Buffer.from(data.buffer, data.byteOffset, data.byteLength);
     }
     buildEndpoint(endpoint) {
         return `/${endpoint}/${this.instance.apiTokenInstance}`;
     }
-    async makeRequest(method, endpoint, data, queryParams, config) {
+    redactToken(text) {
+        const token = this.instance.apiTokenInstance;
+        return token ? text.split(token).join(defaults_1.REDACTED_TOKEN) : text;
+    }
+    async makeRequest(method, endpoint, data, queryParams, config, pathAfterToken, host = "api") {
         try {
-            this.gaLogger.info("Making a request", {
+            this.gaLogger?.info("Making a request", {
                 idInstance: this.instance.idInstance,
                 endpoint,
                 method,
-                data,
+                data: Buffer.isBuffer(data) ? `${data.length} bytes` : data,
                 queryParams,
                 config,
             });
-            const url = this.buildEndpoint(endpoint) + (queryParams ? "?" + new URLSearchParams(Object.entries(queryParams).map(([key, value]) => [key, value.toString()])).toString() : "");
-            const response = await (method === "get"
-                ? this.client.get(url, config)
-                : this.client.post(url, data, config));
+            const url = this.buildEndpoint(endpoint) + (pathAfterToken ? `/${pathAfterToken}` : "") + (queryParams ? "?" + new URLSearchParams(Object.entries(queryParams).map(([key, value]) => [key, value.toString()])).toString() : "");
+            const client = host === "media" ? this.mediaClient : this.client;
+            let response;
+            if (method === "get") {
+                response = await client.get(url, config);
+            }
+            else if (method === "delete") {
+                response = await client.delete(url, config);
+            }
+            else {
+                response = await client.post(url, data, config);
+            }
             return response.data;
         }
         catch (error) {
-            throw new errors_1.IntegrationError(`Failed to ${endpoint.replace(/([A-Z])/g, " $1").toLowerCase()}: ${error.message}. ${JSON.stringify(error.response?.data)}`, "INTEGRATION_ERROR", error.response?.status ?? 500, error.response?.data);
+            const responseData = error.response?.data === undefined
+                ? undefined
+                : JSON.parse(this.redactToken(JSON.stringify(error.response.data)));
+            const reason = this.redactToken(String(error.message));
+            throw new errors_1.IntegrationError(`Failed to ${endpoint.replace(/([A-Z])/g, " $1").toLowerCase()}: ${reason}${responseData === undefined ? "" : `. ${JSON.stringify(responseData)}`}`, "INTEGRATION_ERROR", error.response?.status ?? 500, responseData);
         }
     }
-    async makeFileUploadRequest(endpoint, formData, headers) {
-        return this.makeRequest("post", endpoint, formData, undefined, {
-            headers: { "Content-Type": "multipart/form-data" },
-            ...headers,
-        });
+    async makeFileUploadRequest(endpoint, formData, host = "api") {
+        return this.makeRequest("post", endpoint, formData, undefined, { headers: { "Content-Type": "multipart/form-data" } }, undefined, host);
     }
     /**
      * Sends a text message to a WhatsApp chat.
@@ -143,14 +167,14 @@ class GreenApiClient {
      */
     async sendFileByUpload(message) {
         const formData = new FormData();
-        formData.append("file", message.file.data, message.file.fileName);
+        formData.append("file", this.toBlob(message.file.data), message.file.fileName);
         formData.append("chatId", message.chatId);
         formData.append("fileName", message.file.fileName);
         if (message.caption)
             formData.append("caption", message.caption);
         if (message.quotedMessageId)
             formData.append("quotedMessageId", message.quotedMessageId);
-        return this.makeFileUploadRequest("sendFileByUpload", formData);
+        return this.makeFileUploadRequest("sendFileByUpload", formData, "media");
     }
     /**
      * Creates a poll in a WhatsApp chat.
@@ -393,38 +417,50 @@ class GreenApiClient {
     /**
      * Sets the profile picture for the WhatsApp account.
      *
-     * @param file - Image file to use as profile picture
+     * @param file - Image file (jpg) to use as profile picture
+     * @param fileName - File name with extension
      * @returns Promise resolving to profile picture update response
      */
-    async setProfilePicture(file) {
-        const formData = new FormData();
-        formData.append("file", file);
-        return this.makeFileUploadRequest("setProfilePicture", formData);
+    async setProfilePicture(file, fileName) {
+        return this.requestWithFile("setProfilePicture", { data: file, fileName: this.pictureFileName(file, fileName) });
     }
     /**
      * Uploads a file to GREEN-API servers.
      *
      * @param file - File to upload
-     * @param customFileName - Optional custom name for the file
+     * @param fileName - File name with extension
      * @returns Promise resolving to upload response with file URL
      */
-    async uploadFile(file, customFileName) {
-        const formData = new FormData();
-        formData.append("file", file);
+    async uploadFile(file, fileName) {
+        const mimeType = file instanceof Blob ? file.type : "";
         const headers = {};
-        if (file instanceof File) {
-            const mimeType = file.type;
-            if (mimeType) {
-                headers["Content-Type"] = mimeType;
-            }
-            else if (customFileName) {
-                headers["GA-Filename"] = customFileName;
-            }
+        if (mimeType) {
+            headers["Content-Type"] = mimeType;
+        }
+        else if (fileName) {
+            headers["GA-Filename"] = fileName;
         }
-        else if (customFileName) {
-            headers["GA-Filename"] = customFileName;
+        const body = file instanceof Blob ? Buffer.from(await file.arrayBuffer()) : this.toBuffer(file);
+        return this.makeRequest("post", "uploadFile", body, undefined, { headers }, undefined, "media");
+    }
+    /**
+     * Calls any GREEN-API method that takes a file.
+     *
+     * @param endpoint - GREEN-API method name, e.g. "setGroupPicture"
+     * @param file - File content and file name
+     * @param fields - Other form fields
+     * @returns Promise resolving to the raw response body
+     */
+    async requestWithFile(endpoint, file, fields = {}) {
+        const formData = new FormData();
+        formData.append("file", this.toBlob(file.data), file.fileName);
+        for (const [key, value] of Object.entries(fields)) {
+            formData.append(key, String(value));
         }
-        return this.makeFileUploadRequest("uploadFile", formData, headers);
+        return this.makeFileUploadRequest(endpoint, formData);
+    }
+    pictureFileName(file, fileName) {
+        return fileName || (file instanceof File && file.name ? file.name : defaults_1.DEFAULT_PICTURE_FILE_NAME);
     }
     /**
      * Gets authorization code for a phone number.
@@ -472,6 +508,50 @@ class GreenApiClient {
     async clearMessagesQueue() {
         return this.makeRequest("get", "clearMessagesQueue");
     }
+    /**
+     * Calls any GREEN-API method by name.
+     *
+     * @param method - HTTP method
+     * @param endpoint - GREEN-API method name, e.g. "getContacts"
+     * @param data - Request body for POST
+     * @param queryParams - Query parameters
+     * @returns Promise resolving to the raw response body
+     *
+     * @example
+     * ```typescript
+     * const contacts = await client.request("get", "getContacts");
+     * ```
+     */
+    async request(method, endpoint, data, queryParams) {
+        return this.makeRequest(method, endpoint, data, queryParams);
+    }
+    /**
+     * Receives the next notification from the instance queue.
+     *
+     * @param receiveTimeout - Seconds to wait for a notification, 5 to 60
+     * @returns Promise resolving to the notification, or null when the queue stayed empty
+     *
+     * @example
+     * ```typescript
+     * const notification = await client.receiveNotification(20);
+     * if (notification) {
+     *   await client.deleteNotification(notification.receiptId);
+     * }
+     * ```
+     */
+    async receiveNotification(receiveTimeout) {
+        const response = await this.makeRequest("get", "receiveNotification", undefined, receiveTimeout === undefined ? undefined : { receiveTimeout });
+        return response || null;
+    }
+    /**
+     * Deletes a processed notification from the instance queue.
+     *
+     * @param receiptId - Receipt ID from receiveNotification
+     * @returns Promise resolving to deletion result
+     */
+    async deleteNotification(receiptId) {
+        return this.makeRequest("delete", "deleteNotification", undefined, undefined, undefined, receiptId.toString());
+    }
     /**
      * Marks messages in a chat as read.
      * For this to work, "Receive webhooks on incoming messages and files" setting must be enabled.
@@ -673,10 +753,7 @@ class GreenApiClient {
      * @returns Promise resolving to picture update status
      */
     async setGroupPicture(params) {
-        const formData = new FormData();
-        formData.append("file", params.file);
-        formData.append("groupId", params.groupId);
-        return this.makeFileUploadRequest("setGroupPicture", formData);
+        return this.requestWithFile("setGroupPicture", { data: params.file, fileName: this.pictureFileName(params.file, params.fileName) }, { groupId: params.groupId });
     }
     /**
      * Makes the current account leave a group chat.

package/dist/core/guard.js

@@ -56,22 +56,22 @@ class BaseGreenApiAuthGuard {
     async validateRequest(request) {
         const token = request.headers["authorization"];
         if (!token) {
-            this.gaLogger.warn("Authentication header is missing", { body: request.body, headers: request.headers });
+            this.gaLogger.warn("Authentication header is missing", { body: request.body });
             throw new errors_1.AuthenticationError("Authentication header is missing");
         }
         this.gaLogger.info("Request from GREEN-API", { body: request.body });
         const idInstance = request.body?.instanceData?.idInstance;
         if (!idInstance) {
-            this.gaLogger.warn("Invalid webhook format", { body: request.body, headers: request.headers });
+            this.gaLogger.warn("Invalid webhook format", { body: request.body });
             throw new errors_1.AuthenticationError("Invalid webhook format");
         }
         const instance = await this.storage.getInstance(idInstance);
         if (!instance) {
-            this.gaLogger.warn(`No instance with such ID ${idInstance}`, { body: request.body, headers: request.headers });
+            this.gaLogger.warn(`No instance with such ID ${idInstance}`, { body: request.body });
             throw new errors_1.AuthenticationError(`No instance with such ID ${idInstance}`);
         }
         if (instance.settings?.webhookUrlToken !== token.split(" ")[1]) {
-            this.gaLogger.warn("Invalid token", { body: request.body, headers: request.headers });
+            this.gaLogger.warn("Invalid token", { body: request.body });
             throw new errors_1.AuthenticationError("Invalid token");
         }
         return true;

package/dist/core/logger.js

@@ -195,9 +195,7 @@ class GreenApiLogger {
                 status: axiosError.response?.status,
                 statusText: axiosError.response?.statusText,
                 data: axiosError.response?.data,
-                url: axiosError.config?.url,
                 method: axiosError.config?.method,
-                headers: axiosError.response?.headers,
                 timestamp: new Date().toISOString(),
                 ...additionalContext,
             });

package/dist/defaults.d.ts

@@ -1 +1,3 @@
 export declare const DEFAULT_API_URL = "https://api.green-api.com";
+export declare const REDACTED_TOKEN = "***";
+export declare const DEFAULT_PICTURE_FILE_NAME = "picture.jpg";

package/dist/defaults.js

@@ -1,4 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_API_URL = void 0;
+exports.DEFAULT_PICTURE_FILE_NAME = exports.REDACTED_TOKEN = exports.DEFAULT_API_URL = void 0;
 exports.DEFAULT_API_URL = "https://api.green-api.com";
+exports.REDACTED_TOKEN = "***";
+exports.DEFAULT_PICTURE_FILE_NAME = "picture.jpg";

package/dist/types/types.d.ts

@@ -8,6 +8,7 @@ export interface BaseInstance {
     stateInstance?: InstanceState | null;
     settings?: Settings | Record<string, any> | null;
     apiUrl?: string | null;
+    mediaUrl?: string | null;
 }
 /**
  * Extended instance interface that allows for additional platform-specific properties.
@@ -36,7 +37,7 @@ export interface SendMessage extends BaseMessage {
 export interface SendFileByUpload extends BaseMessage {
     caption?: string;
     file: {
-        data: Blob | File;
+        data: Blob | File | Uint8Array;
         fileName: string;
     };
 }
@@ -124,6 +125,19 @@ export interface QueueMessage {
 export interface ClearMessagesQueue {
     isCleared: boolean;
 }
+export interface ReceiveNotificationResponse {
+    receiptId: number;
+    body: GreenApiWebhook;
+}
+export interface DeleteNotificationResponse {
+    result: boolean;
+}
+export interface GreenApiClientLogger {
+    info(message: string, context?: Record<string, any>): void;
+}
+export interface GreenApiClientOptions {
+    logger?: GreenApiClientLogger | null;
+}
 export type MessageType = "textMessage" | "extendedTextMessage" | "imageMessage" | "videoMessage" | "documentMessage" | "audioMessage" | "contactMessage" | "locationMessage" | "contactsArrayMessage" | "pollMessage" | "reactionMessage" | "pollUpdateMessage" | "quotedMessage" | "stickerMessage" | "editedMessage" | "deletedMessage" | "buttonsMessage" | "listMessage" | "templateMessage" | "groupInviteMessage" | "interactiveButtons" | "interactiveButtonsReply" | "templateButtonsReplyMessage";
 export interface GetMessage {
     chatId: string;
@@ -773,7 +787,8 @@ export interface RemoveAdminResponse {
 }
 export interface SetGroupPicture {
     groupId: string;
-    file: Blob | File;
+    file: Blob | File | Uint8Array;
+    fileName?: string;
 }
 export interface SetGroupPictureResponse {
     setGroupPicture: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@green-api/greenapi-integration",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "GREEN-API Integration library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -24,19 +24,16 @@
   "author": "GREEN-API team",
   "license": "MIT",
   "devDependencies": {
-    "@types/express": "^5.0.0",
-    "@types/jest": "^29.5.14",
-    "@types/node": "^22.10.2",
-    "express": "^4.21.2",
-    "jest": "^29.7.0",
-    "rimraf": "^6.0.1",
-    "ts-jest": "^29.2.5",
-    "ts-node": "^10.9.2",
-    "typedoc": "^0.27.6",
-    "typedoc-plugin-markdown": "^4.4.1",
-    "typescript": "^5.7.2"
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.20.5",
+    "jest": "^30.5.2",
+    "rimraf": "^6.1.3",
+    "ts-jest": "^29.4.15",
+    "typedoc": "^0.28.20",
+    "typedoc-plugin-markdown": "^4.14.1",
+    "typescript": "^6.0.3"
   },
   "dependencies": {
-    "axios": "^1.9.0"
+    "axios": "^1.20.0"
   }
 }