@green-api/greenapi-integration 0.6.1 → 0.7.0

package/README.md

@@ -1020,7 +1020,6 @@ async function main() {
 	await visitorClient.sendMessage({
 		chatId: formatPhoneNumber(process.env.AGENT_PHONE_NUMBER!),
 		message: "Hello! This is a test message from a visitor.",
-		type: "text",
 	});
 
 	console.log("Initial message sent! Check the agent WhatsApp app to see the response.");

package/dist/core/guard.js

@@ -56,18 +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 });
             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 });
             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 });
             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 });
             throw new errors_1.AuthenticationError("Invalid token");
         }
         return true;

package/dist/types/types.d.ts

@@ -16,40 +16,43 @@ export interface Instance extends BaseInstance {
     [key: string]: any;
 }
 /**
- * Union type representing all possible message formats that can be sent through GREEN-API.
- * Each message type has its own specific structure and required fields.
+ * Common properties shared by all message types.
  */
-export type Message = ({
-    type: "text";
+export interface BaseMessage {
+    chatId: string;
+    quotedMessageId?: string;
+}
+export interface ForwardMessagesResponse {
+    messages: string[];
+}
+export interface PollOption {
+    optionName: string;
+}
+export interface SendMessage extends BaseMessage {
     message: string;
     linkPreview?: boolean;
-} & BaseMessage) | ({
-    type: "upload-file";
+}
+export interface SendFileByUpload extends BaseMessage {
     caption?: string;
     file: {
         data: Blob | File;
         fileName: string;
     };
-} & BaseMessage) | ({
-    type: "url-file";
+}
+export interface SendFileByUrl extends BaseMessage {
     caption?: string;
     file: {
         url: string;
         fileName: string;
     };
-} & BaseMessage) | ({
-    type: "poll";
-    message: string;
-    options: PollOption[];
-    multipleAnswers?: boolean;
-} & BaseMessage) | ({
-    type: "location";
+}
+export interface SendLocation extends BaseMessage {
     nameLocation?: string;
     address?: string;
     latitude: number;
     longitude: number;
-} & BaseMessage) | ({
-    type: "contact";
+}
+export interface SendContact extends BaseMessage {
     contact: {
         phoneContact: number;
         firstName?: string;
@@ -57,47 +60,32 @@ export type Message = ({
         lastName?: string;
         company?: string;
     };
-} & BaseMessage) | {
-    type: "forward";
+}
+export interface SendPoll extends BaseMessage {
+    message: string;
+    options: PollOption[];
+    multipleAnswers?: boolean;
+}
+export interface ForwardMessages {
     chatId: string;
     chatIdFrom: string;
     messages: string[];
-};
-/**
- * Common properties shared by all message types.
- */
-export interface BaseMessage {
-    chatId: string;
-    quotedMessageId?: string;
-}
-export type SendMessageType = "text" | "upload-file" | "url-file" | "poll" | "location" | "contact" | "forward";
-export interface ForwardMessagesResponse {
-    messages: string[];
-}
-export interface PollOption {
-    optionName: string;
 }
-export type SendMessage = Extract<Message, {
+export type Message = (SendMessage & {
     type: "text";
-}>;
-export type SendFileByUpload = Extract<Message, {
+}) | (SendFileByUpload & {
     type: "upload-file";
-}>;
-export type SendFileByUrl = Extract<Message, {
+}) | (SendFileByUrl & {
     type: "url-file";
-}>;
-export type SendLocation = Extract<Message, {
+}) | (SendPoll & {
+    type: "poll";
+}) | (SendLocation & {
     type: "location";
-}>;
-export type SendContact = Extract<Message, {
+}) | (SendContact & {
     type: "contact";
-}>;
-export type SendPoll = Extract<Message, {
-    type: "poll";
-}>;
-export type ForwardMessages = Extract<Message, {
+}) | (ForwardMessages & {
     type: "forward";
-}>;
+});
 export type QueueMessageType = "sendMessage" | "sendPoll" | "sendFileByUrl" | "sendLocation" | "sendContact" | "ForwardMessages";
 export type QueueMessageBody = SendMessage | SendPoll | SendFileByUrl | SendLocation | SendContact | ForwardMessages;
 export interface QueueMessage {
@@ -109,7 +97,7 @@ export interface QueueMessage {
 export interface ClearMessagesQueue {
     isCleared: boolean;
 }
-export type MessageType = "textMessage" | "extendedTextMessage" | "imageMessage" | "videoMessage" | "documentMessage" | "audioMessage" | "contactMessage" | "locationMessage" | "contactsArrayMessage" | "pollMessage" | "reactionMessage" | "pollUpdateMessage" | "quotedMessage" | "stickerMessage";
+export type MessageType = "textMessage" | "extendedTextMessage" | "imageMessage" | "videoMessage" | "documentMessage" | "audioMessage" | "contactMessage" | "locationMessage" | "contactsArrayMessage" | "pollMessage" | "reactionMessage" | "pollUpdateMessage" | "quotedMessage" | "stickerMessage" | "editedMessage" | "deletedMessage" | "buttonsMessage" | "listMessage" | "templateMessage" | "groupInviteMessage";
 export interface GetMessage {
     chatId: string;
     idMessage: string;
@@ -140,13 +128,17 @@ export interface OutgoingJournalFields {
 export type BaseIncomingJournalMessage = BaseJournalMessage & IncomingJournalFields;
 export type BaseOutgoingJournalMessage = BaseJournalMessage & OutgoingJournalFields;
 export type BaseJournalResponse = BaseIncomingJournalMessage | BaseOutgoingJournalMessage;
-export type OutgoingJournalResponse = BaseOutgoingJournalMessage & WebhookMessageData & {
+export type JournalMessageData<T> = T extends {
+    typeMessage: "imageMessage" | "videoMessage" | "documentMessage" | "audioMessage" | "stickerMessage";
+    fileMessageData: FileMessageData;
+} ? Omit<T, "fileMessageData"> & FileMessageData : T;
+export type OutgoingJournalResponse = BaseOutgoingJournalMessage & JournalMessageData<WebhookMessageData> & {
     quotedMessage?: QuotedMessage;
 };
-export type IncomingJournalResponse = BaseIncomingJournalMessage & WebhookMessageData & {
+export type IncomingJournalResponse = BaseIncomingJournalMessage & JournalMessageData<WebhookMessageData> & {
     quotedMessage?: QuotedMessage;
 };
-export type JournalResponse = BaseJournalResponse & WebhookMessageData & {
+export type JournalResponse = BaseJournalResponse & JournalMessageData<WebhookMessageData> & {
     quotedMessage?: QuotedMessage;
 };
 export interface ForwardableMessage {
@@ -159,6 +151,76 @@ export interface MediaMessage extends ForwardableMessage {
 export interface TextMessageData {
     textMessage: string;
 }
+export interface EditedMessageData {
+    textMessage?: string;
+    caption?: string;
+    stanzaId: string;
+}
+export interface DeletedMessageData {
+    stanzaId: string;
+}
+export interface ReactionMessageData {
+    text: string;
+}
+export interface ButtonData {
+    buttonId: string;
+    buttonText: string;
+}
+export interface ButtonsMessageData extends ForwardableMessage {
+    contentText: string;
+    footer: string;
+    buttons: ButtonData[];
+}
+export interface ListRowData {
+    title: string;
+    rowId: string;
+    description?: string;
+}
+export interface ListSectionData {
+    title: string;
+    rows: ListRowData[];
+}
+export interface ListMessageData extends ForwardableMessage {
+    contentText: string;
+    title?: string;
+    footer?: string;
+    buttonText?: string;
+    sections: ListSectionData[];
+}
+export interface UrlButtonData {
+    displayText: string;
+    url: string;
+}
+export interface CallButtonData {
+    displayText: string;
+    phoneNumber: string;
+}
+export interface QuickReplyButtonData {
+    displayText: string;
+    id: string;
+}
+export interface TemplateButtonData {
+    index: number;
+    urlButton?: UrlButtonData;
+    callButton?: CallButtonData;
+    quickReplyButton?: QuickReplyButtonData;
+}
+export interface TemplateMessageData extends ForwardableMessage {
+    namespace?: string;
+    elementName?: string;
+    contentText: string;
+    footer?: string;
+    buttons: TemplateButtonData[];
+}
+export interface GroupInviteMessageData {
+    groupJid: string;
+    inviteCode: string;
+    inviteExpiration: string;
+    groupName: string;
+    caption: string;
+    name: string;
+    jpegThumbnail: string;
+}
 export interface ExtendedTextMessageData extends MediaMessage {
     text: string;
     description: string;
@@ -169,6 +231,7 @@ export interface FileMessageData extends MediaMessage {
     caption: string;
     mimeType: string;
     fileName: string;
+    isAnimated?: boolean;
 }
 export interface LocationMessageData extends MediaMessage {
     nameLocation: string;
@@ -233,6 +296,32 @@ export type QuotedMessage = {
     downloadUrl: string;
     caption: string;
     jpegThumbnail: string;
+} | {
+    typeMessage: "stickerMessage";
+    downloadUrl: string;
+    caption: string;
+    jpegThumbnail: string;
+    isAnimated: boolean;
+} | {
+    typeMessage: "buttonsMessage";
+    contentText: string;
+    footer?: string;
+    buttons: ButtonData[];
+} | {
+    typeMessage: "listMessage";
+    contentText: string;
+    title?: string;
+    footer?: string;
+    buttonText?: string;
+    sections: ListSectionData[];
+} | {
+    typeMessage: "templateMessage";
+    contentText: string;
+    footer?: string;
+    buttons: TemplateButtonData[];
+} | {
+    typeMessage: "groupInviteMessage";
+    groupInviteMessageData: GroupInviteMessageData;
 });
 export interface PollVote {
     optionName: string;
@@ -245,7 +334,7 @@ export interface PollUpdateMessageData {
     multipleAnswers: boolean;
 }
 export type OutgoingMessageStatus = "sent" | "delivered" | "read" | "failed" | "noAccount" | "notInGroup" | "yellowCard";
-export type WebhookType = "stateInstanceChanged" | "outgoingMessageStatus" | "outgoingAPIMessageReceived" | "outgoingMessageReceived" | "incomingMessageReceived";
+export type WebhookType = "stateInstanceChanged" | "outgoingMessageStatus" | "outgoingAPIMessageReceived" | "outgoingMessageReceived" | "incomingMessageReceived" | "incomingCall";
 /**
  * Webhook payload received when a message status changes.
  * Used to track delivery and read receipts.
@@ -302,6 +391,31 @@ export type WebhookMessageData = {
 } | {
     typeMessage: "contactsArrayMessage";
     messageData: ContactsArrayMessageData;
+} | {
+    typeMessage: "editedMessage";
+    editedMessageData: EditedMessageData;
+} | {
+    typeMessage: "deletedMessage";
+    deletedMessageData: DeletedMessageData;
+} | {
+    typeMessage: "reactionMessage";
+    extendedTextMessageData: ReactionMessageData;
+    quotedMessage: QuotedMessage;
+} | {
+    typeMessage: "buttonsMessage";
+    buttonsMessage: ButtonsMessageData;
+} | {
+    typeMessage: "listMessage";
+    listMessage: ListMessageData;
+} | {
+    typeMessage: "templateMessage";
+    templateMessage: TemplateMessageData;
+} | {
+    typeMessage: "stickerMessage";
+    fileMessageData: FileMessageData;
+} | {
+    typeMessage: "groupInviteMessage";
+    groupInviteMessageData: GroupInviteMessageData;
 };
 export interface MessageWebhook {
     typeWebhook: "incomingMessageReceived" | "outgoingMessageReceived" | "outgoingAPIMessageReceived";
@@ -323,10 +437,23 @@ export interface MessageWebhook {
         quotedMessage?: QuotedMessage;
     };
 }
+export type CallStatus = "offer" | "pickUp" | "hangUp" | "missed" | "declined";
+export interface IncomingCallWebhook {
+    from: string;
+    typeWebhook: "incomingCall";
+    instanceData: {
+        idInstance: number;
+        wid: string;
+        typeInstance: string;
+    };
+    status: CallStatus;
+    timestamp: number;
+    idMessage: string;
+}
 /**
  * Primary webhook types received from GREEN-API.
  */
-export type GreenApiWebhook = MessageWebhook | OutgoingMessageStatusWebhook | StateInstanceWebhook;
+export type GreenApiWebhook = MessageWebhook | OutgoingMessageStatusWebhook | StateInstanceWebhook | IncomingCallWebhook;
 /**
  * Configuration settings for a GREEN-API instance.
  * Controls webhook behavior, message handling, and other instance features.
@@ -346,6 +473,9 @@ export interface Settings {
     keepOnlineStatus?: "yes" | "no";
     pollMessageWebhook?: "yes" | "no";
     incomingCallWebhook?: "yes" | "no";
+    incomingBlockWebhook?: "yes" | "no";
+    editedMessageWebhook?: "yes" | "no";
+    deletedMessageWebhook?: "yes" | "no";
 }
 export interface Reboot {
     isReboot: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@green-api/greenapi-integration",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "GREEN-API Integration library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",