@green-api/greenapi-integration 0.2.0 → 0.4.0

package/dist/types/types.d.ts

@@ -2,10 +2,11 @@
  * Base interface for GREEN-API WhatsApp instances.
  * Contains the essential credentials needed to interact with the API.
  */
-interface BaseInstance {
+export interface BaseInstance {
     idInstance: number | bigint;
     apiTokenInstance: string;
-    settings?: Settings;
+    stateInstance?: InstanceState;
+    settings?: Settings | Record<string, any>;
 }
 /**
  * Extended instance interface that allows for additional platform-specific properties.
@@ -21,6 +22,7 @@ export interface Instance extends BaseInstance {
 export type Message = ({
     type: "text";
     message: string;
+    linkPreview?: boolean;
 } & BaseMessage) | ({
     type: "upload-file";
     caption?: string;
@@ -96,7 +98,57 @@ export type SendPoll = Extract<Message, {
 export type ForwardMessages = Extract<Message, {
     type: "forward";
 }>;
-export type MessageType = "textMessage" | "extendedTextMessage" | "imageMessage" | "videoMessage" | "documentMessage" | "audioMessage" | "contactMessage" | "locationMessage" | "pollMessage";
+export type QueueMessageType = "sendMessage" | "sendPoll" | "sendFileByUrl" | "sendLocation" | "sendContact" | "ForwardMessages";
+export type QueueMessageBody = SendMessage | SendPoll | SendFileByUrl | SendLocation | SendContact | ForwardMessages;
+export interface QueueMessage {
+    messageID?: string;
+    messagesIDs?: string[];
+    type: QueueMessageType;
+    body: QueueMessageBody;
+}
+export interface ClearMessagesQueue {
+    isCleared: boolean;
+}
+export type MessageType = "textMessage" | "extendedTextMessage" | "imageMessage" | "videoMessage" | "documentMessage" | "audioMessage" | "contactMessage" | "locationMessage" | "pollMessage" | "reactionMessage" | "pollUpdateMessage" | "quotedMessage" | "stickerMessage";
+export interface GetMessage {
+    chatId: string;
+    idMessage: string;
+}
+export interface GetChatHistory {
+    chatId: string;
+    count?: number;
+}
+export interface BaseJournalMessage {
+    idMessage: string;
+    timestamp: number;
+    typeMessage: MessageType;
+    chatId: string;
+    isForwarded: boolean;
+    forwardingScore: number;
+}
+export interface IncomingJournalFields {
+    type: "incoming";
+    senderId: string;
+    senderName: string;
+    senderContactName: string;
+}
+export interface OutgoingJournalFields {
+    type: "outgoing";
+    statusMessage: OutgoingMessageStatus;
+    sendByApi: boolean;
+}
+export type BaseIncomingJournalMessage = BaseJournalMessage & IncomingJournalFields;
+export type BaseOutgoingJournalMessage = BaseJournalMessage & OutgoingJournalFields;
+export type BaseJournalResponse = BaseIncomingJournalMessage | BaseOutgoingJournalMessage;
+export type OutgoingJournalResponse = BaseOutgoingJournalMessage & WebhookMessageData & {
+    quotedMessage?: QuotedMessage;
+};
+export type IncomingJournalResponse = BaseIncomingJournalMessage & WebhookMessageData & {
+    quotedMessage?: QuotedMessage;
+};
+export type JournalResponse = BaseJournalResponse & WebhookMessageData & {
+    quotedMessage?: QuotedMessage;
+};
 export interface ForwardableMessage {
     forwardingScore: number;
     isForwarded: boolean;
@@ -172,6 +224,7 @@ export interface PollUpdateMessageData {
     multipleAnswers: boolean;
 }
 export type OutgoingMessageStatus = "sent" | "delivered" | "read" | "failed" | "noAccount" | "notInGroup" | "yellowCard";
+export type WebhookType = "stateInstanceChanged" | "outgoingMessageStatus" | "outgoingAPIMessageReceived" | "outgoingMessageReceived" | "incomingMessageReceived";
 /**
  * Webhook payload received when a message status changes.
  * Used to track delivery and read receipts.
@@ -190,6 +243,16 @@ export interface OutgoingMessageStatusWebhook {
     description?: string;
     sendByApi: boolean;
 }
+export interface StateInstanceWebhook {
+    typeWebhook: "stateInstanceChanged";
+    instanceData: {
+        idInstance: number;
+        wid: string;
+        typeInstance: string;
+    };
+    timestamp: number;
+    stateInstance: InstanceState;
+}
 export type WebhookMessageData = {
     typeMessage: "textMessage";
     textMessageData: TextMessageData;
@@ -235,7 +298,7 @@ export interface MessageWebhook {
 /**
  * Primary webhook types received from GREEN-API.
  */
-export type GreenApiWebhook = MessageWebhook | OutgoingMessageStatusWebhook;
+export type GreenApiWebhook = MessageWebhook | OutgoingMessageStatusWebhook | StateInstanceWebhook;
 /**
  * Configuration settings for a GREEN-API instance.
  * Controls webhook behavior, message handling, and other instance features.
@@ -262,6 +325,83 @@ export interface Reboot {
 export interface Logout {
     isLogout: boolean;
 }
+export interface ReadChat {
+    chatId: string;
+    idMessage?: string;
+}
+export interface ReadChatResponse {
+    setRead: boolean;
+}
+export interface CheckWhatsapp {
+    phoneNumber: number;
+}
+export interface CheckWhatsappResponse {
+    existsWhatsapp: boolean;
+}
+export interface GetAvatar {
+    chatId: string;
+}
+export interface GetAvatarResponse {
+    urlAvatar: string;
+    available: boolean;
+}
+export type ContactType = "user" | "group";
+export interface Contact {
+    id: string;
+    name: string;
+    contactName: string;
+    type: ContactType;
+}
+export interface ProductImageUrls {
+    requested: string;
+    original: string;
+}
+export interface ProductReviewStatus {
+    whatsapp: string;
+}
+export interface Product {
+    id: string;
+    imageUrls: ProductImageUrls;
+    reviewStatus: ProductReviewStatus;
+    availability: string;
+    name: string;
+    description?: string;
+    price: string | null;
+    isHidden: boolean;
+}
+export interface ContactInfo {
+    avatar: string;
+    name: string;
+    contactName: string;
+    email: string;
+    category: string;
+    description: string;
+    products: Product[];
+    chatId: string;
+    lastSeen: string | null;
+    isArchive: boolean;
+    isDisappearing: boolean;
+    isMute: boolean;
+    messageExpiration: number;
+    muteExpiration: number | null;
+    isBusiness: boolean;
+}
+export interface ArchiveChat {
+    chatId: string;
+}
+export interface UnarchiveChat {
+    chatId: string;
+}
+export type EphemeralExpiration = 0 | 86400 | 604800 | 7776000;
+export interface SetDisappearingChat {
+    chatId: string;
+    ephemeralExpiration: EphemeralExpiration;
+}
+export interface SetDisappearingChatResponse {
+    chatId: string;
+    disappearingMessagesInChat: boolean;
+    ephemeralExpiration: EphemeralExpiration;
+}
 /**
  * Represents an instance state in the GREEN-API system.
  */
@@ -301,6 +441,84 @@ export interface SetProfilePicture {
     urlAvatar: string;
     setProfilePicture: boolean;
 }
+export interface CreateGroup {
+    groupName: string;
+    chatIds: string[];
+}
+export interface CreateGroupResponse {
+    created: boolean;
+    chatId: string;
+    groupInviteLink: string;
+}
+export interface UpdateGroupName {
+    groupId: string;
+    groupName: string;
+}
+export interface UpdateGroupNameResponse {
+    updateGroupName: boolean;
+}
+export interface GroupParticipant {
+    id: string;
+    isAdmin: boolean;
+    isSuperAdmin: boolean;
+}
+export interface GroupData {
+    groupId: string;
+    owner: string;
+    subject: string;
+    creation: number;
+    participants: GroupParticipant[];
+    subjectTime: number;
+    subjectOwner: string;
+    groupInviteLink: string;
+}
+export interface GetGroupData {
+    groupId: string;
+}
+export interface AddGroupParticipant {
+    groupId: string;
+    participantChatId: string;
+}
+export interface AddGroupParticipantResponse {
+    addParticipant: boolean;
+}
+export interface RemoveGroupParticipant {
+    groupId: string;
+    participantChatId: string;
+}
+export interface RemoveGroupParticipantResponse {
+    removeParticipant: boolean;
+}
+export interface SetGroupAdmin {
+    groupId: string;
+    participantChatId: string;
+}
+export interface SetGroupAdminResponse {
+    setGroupAdmin: boolean;
+}
+export interface RemoveAdmin {
+    groupId: string;
+    participantChatId: string;
+}
+export interface RemoveAdminResponse {
+    removeAdmin: boolean;
+}
+export interface SetGroupPicture {
+    groupId: string;
+    file: Blob | File;
+}
+export interface SetGroupPictureResponse {
+    setGroupPicture: boolean;
+    urlAvatar: string | null;
+    reason: string;
+}
+export interface LeaveGroup {
+    groupId: string;
+}
+export interface LeaveGroupResponse {
+    leaveGroup?: boolean;
+    removeAdmin?: boolean;
+}
 export interface BaseRequest {
     headers: Record<string, any>;
     body: any;

package/dist/utils/helpers.d.ts

@@ -1,3 +1,4 @@
+import { Settings } from "../types/types";
 /**
  * Utility functions for working with phone numbers, tokens, and vCards.
  *
@@ -39,3 +40,34 @@ export declare function generateRandomToken(length?: number): string;
  * extractPhoneNumberFromVCard(vcard)  // Returns '+1234567890'
  */
 export declare function extractPhoneNumberFromVCard(vcard: string): string | null;
+/**
+ * Validates if a value is appropriate for a specific Settings interface key.
+ * Checks type compatibility for numbers, strings, and yes/no enums.
+ *
+ * @param key - The settings key to validate
+ * @param value - The value to check against the key's expected type
+ * @returns Boolean indicating if the value is valid for the given key
+ *
+ * @example
+ * isValidSettingValue('delaySendMessagesMilliseconds', 1000)     // Returns true
+ * isValidSettingValue('outgoingWebhook', 'maybe')                // Returns false
+ * isValidSettingValue('webhookUrl', 'https://example.com')       // Returns true
+ */
+export declare function isValidSettingValue(key: keyof Settings, value: any): boolean;
+/**
+ * Validates and cleans a settings object against the Settings interface.
+ * Removes any properties that don't match the interface or have invalid values.
+ *
+ * @param settings - The settings object to validate and clean
+ * @returns A new Settings object containing only valid properties and values
+ *
+ * @example
+ * const input = {
+ *   webhookUrl: 'https://example.com',
+ *   outgoingWebhook: 'yes',
+ *   invalidKey: 'value',
+ *   delaySendMessagesMilliseconds: 'invalid'
+ * };
+ * validateAndCleanSettings(input)  // Returns { webhookUrl: 'https://example.com', outgoingWebhook: 'yes' }
+ */
+export declare function validateAndCleanSettings(settings: any): Settings;

package/dist/utils/helpers.js

@@ -36,6 +36,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.formatPhoneNumber = formatPhoneNumber;
 exports.generateRandomToken = generateRandomToken;
 exports.extractPhoneNumberFromVCard = extractPhoneNumberFromVCard;
+exports.isValidSettingValue = isValidSettingValue;
+exports.validateAndCleanSettings = validateAndCleanSettings;
 const crypto = __importStar(require("crypto"));
 /**
  * Utility functions for working with phone numbers, tokens, and vCards.
@@ -86,3 +88,65 @@ function extractPhoneNumberFromVCard(vcard) {
     const phoneMatch = vcard.match(/TEL(?:;[^:]+)?:([+\d\s-]+)/);
     return phoneMatch ? phoneMatch[1] : null;
 }
+/**
+ * Validates if a value is appropriate for a specific Settings interface key.
+ * Checks type compatibility for numbers, strings, and yes/no enums.
+ *
+ * @param key - The settings key to validate
+ * @param value - The value to check against the key's expected type
+ * @returns Boolean indicating if the value is valid for the given key
+ *
+ * @example
+ * isValidSettingValue('delaySendMessagesMilliseconds', 1000)     // Returns true
+ * isValidSettingValue('outgoingWebhook', 'maybe')                // Returns false
+ * isValidSettingValue('webhookUrl', 'https://example.com')       // Returns true
+ */
+function isValidSettingValue(key, value) {
+    switch (key) {
+        case "delaySendMessagesMilliseconds":
+            return typeof value === "number";
+        case "wid":
+        case "webhookUrl":
+        case "webhookUrlToken":
+            return typeof value === "string";
+        case "markIncomingMessagesReaded":
+        case "markIncomingMessagesReadedOnReply":
+        case "outgoingWebhook":
+        case "outgoingMessageWebhook":
+        case "outgoingAPIMessageWebhook":
+        case "stateWebhook":
+        case "incomingWebhook":
+        case "keepOnlineStatus":
+        case "pollMessageWebhook":
+        case "incomingCallWebhook":
+            return value === "yes" || value === "no";
+        default:
+            return false;
+    }
+}
+/**
+ * Validates and cleans a settings object against the Settings interface.
+ * Removes any properties that don't match the interface or have invalid values.
+ *
+ * @param settings - The settings object to validate and clean
+ * @returns A new Settings object containing only valid properties and values
+ *
+ * @example
+ * const input = {
+ *   webhookUrl: 'https://example.com',
+ *   outgoingWebhook: 'yes',
+ *   invalidKey: 'value',
+ *   delaySendMessagesMilliseconds: 'invalid'
+ * };
+ * validateAndCleanSettings(input)  // Returns { webhookUrl: 'https://example.com', outgoingWebhook: 'yes' }
+ */
+function validateAndCleanSettings(settings) {
+    const validSettings = {};
+    const settingsKeys = Object.keys(settings);
+    for (const key of settingsKeys) {
+        if (key in validSettings && isValidSettingValue(key, settings[key])) {
+            validSettings[key] = settings[key];
+        }
+    }
+    return validSettings;
+}

package/package.json

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