@green-api/greenapi-integration 0.6.0 → 0.6.2

package/dist/types/types.d.ts

@@ -109,7 +109,7 @@ export interface QueueMessage {
 export interface ClearMessagesQueue {
     isCleared: boolean;
 }
-export type MessageType = "textMessage" | "extendedTextMessage" | "imageMessage" | "videoMessage" | "documentMessage" | "audioMessage" | "contactMessage" | "locationMessage" | "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 +140,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 +163,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 +243,7 @@ export interface FileMessageData extends MediaMessage {
     caption: string;
     mimeType: string;
     fileName: string;
+    isAnimated?: boolean;
 }
 export interface LocationMessageData extends MediaMessage {
     nameLocation: string;
@@ -198,6 +273,15 @@ export type QuotedMessage = {
 } & ({
     typeMessage: "textMessage";
     textMessage: string;
+} | {
+    typeMessage: "extendedTextMessage";
+    textMessage: string;
+    extendedTextMessage: {
+        description?: string;
+        title?: string;
+        previewType?: string;
+        jpegThumbnail?: string | null;
+    };
 } | {
     typeMessage: "contactMessage";
     contact: {
@@ -224,6 +308,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;
@@ -236,7 +346,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.
@@ -274,6 +384,10 @@ export type WebhookMessageData = {
 } | {
     typeMessage: "imageMessage" | "videoMessage" | "documentMessage" | "audioMessage";
     fileMessageData: FileMessageData;
+} | {
+    typeMessage: "quotedMessage";
+    extendedTextMessageData: ExtendedTextMessageData;
+    quotedMessage: QuotedMessage;
 } | {
     typeMessage: "locationMessage";
     locationMessageData: LocationMessageData;
@@ -289,6 +403,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";
@@ -310,10 +449,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.
@@ -333,6 +485,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,41 +1,42 @@
-{
-  "name": "@green-api/greenapi-integration",
-  "version": "0.6.0",
-  "description": "GREEN-API Integration library",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "tsc",
-    "clean": "rimraf dist",
-    "prebuild": "npm run clean",
-    "prepare": "npm run build",
-    "docs": "typedoc",
-    "docs:watch": "typedoc --watch"
-  },
-  "keywords": [
-    "green-api",
-    "whatsapp",
-    "integration"
-  ],
-  "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"
-  },
-  "dependencies": {
-    "axios": "^1.7.9"
-  }
-}
+{
+  "name": "@green-api/greenapi-integration",
+  "version": "0.6.2",
+  "description": "GREEN-API Integration library",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rimraf dist",
+    "prebuild": "npm run clean",
+    "prepare": "npm run build",
+    "docs": "typedoc",
+    "docs:watch": "typedoc --watch"
+  },
+  "keywords": [
+    "green-api",
+    "whatsapp",
+    "integration"
+  ],
+  "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"
+  },
+  "dependencies": {
+    "axios": "^1.7.9"
+  }
+}