talkyzap-wapp-api 1.0.19 → 1.0.21

package/CHANGELOG.md

@@ -1,4 +1,4 @@
-## 3.18.8 (2025-11-10)
+## 3.19.3 (2025-11-26)
 
 
 

package/dist/chat/functions/editMessage.d.ts

@@ -17,10 +17,10 @@ import { MsgKey } from '../../whatsapp';
 import { LinkPreviewOptions, SendMessageOptions, SendMessageReturn } from '..';
 export type EditMessageOptions = SendMessageOptions & LinkPreviewOptions;
 /**
- * Send a text message
+ * Edit a message previously sent.
  *
  * @example
- * WPP.chat.editMessage('[number]@c.us', 'New text for message', {
+ * WPP.chat.editMessage('true_[number]@c.us_[msgId]', 'New text for message', {
  *   linkPreview: true,
  *   mentionedJidList: ['5521985232287@c.us']
  * });

package/dist/chat/functions/index.d.ts

@@ -57,6 +57,7 @@ export { pinMsg, unpinMsg } from './pinMsg';
 export { LinkPreviewOptions, prepareLinkPreview } from './prepareLinkPreview';
 export { MessageButtonsOptions, prepareMessageButtons, } from './prepareMessageButtons';
 export { prepareRawMessage } from './prepareRawMessage';
+export { ButtonReplyOptions, replyToButtonMessage, } from './replyToButtonMessage';
 export { requestPhoneNumber } from './requestPhoneNumber';
 export { sendCatalogMessage } from './sendCatalogMessage';
 export { OrderItems, OrderMessageOptions, sendChargeMessage, } from './sendChargeMessage';

package/dist/chat/functions/replyToButtonMessage.d.ts

@@ -0,0 +1,44 @@
+/*!
+ * Copyright 2024 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export interface ButtonReplyOptions {
+    /**
+     * The index of the button to reply to (0-based)
+     * For example: 0 for first button, 1 for second button
+     */
+    buttonIndex: number;
+}
+/**
+ * Reply to a button message by clicking a specific button
+ *
+ * @example
+ * ```javascript
+ * // Reply to the first button (Yes)
+ * await WPP.chat.replyToButtonMessage(
+ *   '[number]@c.us',
+ *   'messageId',
+ *   { buttonIndex: 0 }
+ * );
+ *
+ * // Reply to the second button (No)
+ * await WPP.chat.replyToButtonMessage(
+ *   '[number]@c.us',
+ *   'messageId',
+ *   { buttonIndex: 1 }
+ * );
+ * ```
+ * @category Message
+ */
+export declare function replyToButtonMessage(chatId: any, messageId: string, options: ButtonReplyOptions): Promise<any>;

package/dist/conn/functions/getBuildConstants.d.ts

@@ -13,6 +13,20 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export interface BuildConstants {
+    VERSION_STR: string;
+    VERSION_BASE: string;
+    VERSION_PRIMARY: string;
+    VERSION_SECONDARY: string;
+    VERSION_TERTIARY: string;
+    WINDOWS_BUILD: string | null;
+    PARSED: {
+        PRIMARY: number;
+        SECONDARY: number;
+        TERTIARY: number;
+    };
+    [key: string]: any;
+}
 /**
  * Get the WhatsApp Web build constants
  * Retrieves the internal WAWebBuildConstants module from WhatsApp source
@@ -25,7 +39,7 @@
  * console.log('Windows Build:', buildConstants.WINDOWS_BUILD);
  * ```
  *
- * @returns {object|null} Object containing version constants or null if not available
+ * @returns {BuildConstants|null} Object containing version constants or null if not available
  * - VERSION_STR: Full version string (e.g., "2.3000.1234567")
  * - VERSION_BASE: Base version (e.g., "2.3000.1234567")
  * - VERSION_PRIMARY: Primary version number
@@ -34,4 +48,19 @@
  * - WINDOWS_BUILD: Windows build number (if applicable)
  * - And other build-related constants
  */
-export declare function getBuildConstants(): string | null;
+export declare function getBuildConstants(): BuildConstants | null;
+/**
+ * Check if the current WhatsApp version is greater than or equal to a specified version
+ *
+ * @example
+ * ```javascript
+ * // Check if version is >= 2.3000.1030110621
+ * if (WPP.conn.isWhatsAppVersionGTE('2.3000.1030110621')) {
+ *   console.log('Using new API');
+ * }
+ * ```
+ *
+ * @param version - Version string to compare against (e.g., "2.3000.1029")
+ * @returns {boolean} True if current version is >= specified version
+ */
+export declare function isWhatsAppVersionGTE(version: string): boolean;

package/dist/conn/functions/index.d.ts

@@ -16,7 +16,7 @@
 export { changeEnviromentDevice } from './changeEnviromentDevice';
 export { genLinkDeviceCodeForPhoneNumber } from './genLinkDeviceCodeForPhoneNumber';
 export { getAuthCode } from './getAuthCode';
-export { getBuildConstants } from './getBuildConstants';
+export { BuildConstants, getBuildConstants, isWhatsAppVersionGTE, } from './getBuildConstants';
 export { getHistorySyncProgress, HistorySyncProgress, } from './getHistorySyncProgress';
 export { getMigrationState, MigrationState } from './getMigrationState';
 export { getMyDeviceId } from './getMyDeviceId';

package/dist/contact/functions/save.d.ts

@@ -21,13 +21,17 @@ import { ContactModel } from '../../whatsapp';
  * ```javascript
  * await WPP.contact.save('5533999999999@c.us', 'John', {
  *   surname: 'Doe',
- *   syncAdressBook: true,
+ *   syncAddressBook: true,
  * });
  * ```
  *
  * @category Contact
  */
-export declare function save(contactId: string | any, name: string, options?: {
+export declare function save(contactId: string | any, firstName: string, options?: {
+    /** @deprecated Use lastName instead */
     surname?: string;
+    /** @deprecated Use syncAddressBook instead, this one with typo was updated */
     syncAdressBook?: boolean;
+    lastName?: string;
+    syncAddressBook?: boolean;
 }): Promise<ContactModel | undefined>;

package/dist/gtag/Tracker.d.ts

@@ -47,6 +47,6 @@ export declare class Tracker {
      * Send a user engagement each 5 minutes
      */
     private processUserEngagement;
-    trackEvent(_eventName: string, _params?: Record<string, string | number | boolean>): void;
+    trackEvent(eventName: string, params?: Record<string, string | number | boolean>): void;
     setUserProperty(key: string, value: any): void;
 }

package/dist/whatsapp/functions/addAndSendMessageEdit.d.ts

@@ -14,7 +14,9 @@
  * limitations under the License.
  */
 import { ModelPropertiesContructor, MsgModel } from '../models';
-import { SendMsgResultObject } from '../types';
-/** @whatsapp 375399
+/**
+ * @whatsapp >= 2.3000.1027602471
+ * @note Since WhatsApp Web version ~2.3000.1027602471, this function no longer returns
+ *       a send result object. It only returns void after sending the edit message.
  */
-export declare function addAndSendMessageEdit(editMsg: MsgModel, message: ModelPropertiesContructor<MsgModel>): Promise<[Promise<MsgModel>, Promise<SendMsgResultObject>]>;
+export declare function addAndSendMessageEdit(editMsg: MsgModel, message: ModelPropertiesContructor<MsgModel>): Promise<void>;

package/dist/whatsapp/functions/addAndSendMsgToChat.d.ts

@@ -15,8 +15,9 @@
  */
 import { ChatModel, ModelPropertiesContructor, MsgModel } from '../models';
 import { SendMsgResultObject } from '../types';
-/** @whatsapp 75887
+/**
  * @whatsapp 975887 >= 2.2222.8
  * @whatsapp 623631 >= 2.2228.4
+ * @whatsapp >= 2.3000.1030351223
  */
 export declare function addAndSendMsgToChat(chat: ChatModel, message: ModelPropertiesContructor<MsgModel>): Promise<[Promise<MsgModel>, Promise<SendMsgResultObject>]>;

package/dist/whatsapp/functions/contactFunctions.d.ts

@@ -14,10 +14,6 @@
  * limitations under the License.
  */
 import { ContactModel } from '../models';
-/**
- * @whatsapp 660666 >= 2.2327.4
- */
-export declare function getMentionName(contact: ContactModel): string;
 /**
  * @whatsapp 660666 >= 2.2327.4
  */
@@ -78,10 +74,6 @@ export declare function getIsSupportAccount(contact: ContactModel): any;
  * @whatsapp 660666 >= 2.2327.4
  */
 export declare function getIsWAContact(contact: ContactModel): any;
-/**
- * @whatsapp 660666 >= 2.2327.4
- */
-export declare function getIsMyContact(contact: ContactModel): boolean;
 /**
  * @whatsapp 660666 >= 2.2327.4
  */
@@ -147,3 +139,11 @@ export declare function getFormattedName(contact: ContactModel): any;
  * @whatsapp 714574 >= 2.2327.4
  */
 export declare function getFormattedUser(contact: ContactModel): any;
+/**
+ * @whatsapp >= 2.3000.1030318976 (last check)
+ */
+export declare function getIsMyContact(contact: ContactModel): boolean;
+/**
+ * @whatsapp >= 2.3000.1030318976 (last check)
+ */
+export declare function getMentionName(contact: ContactModel): string;

package/dist/whatsapp/functions/deleteContactAction.d.ts

@@ -13,7 +13,46 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { Wid } from '../misc';
 /**
+ * Deletes a contact from the contact list (legacy API).
+ *
  * @whatsapp WAWebDeleteContactAction >= 2.3000.0
+ * @whatsapp ~2.3000.1030040369
+ *
+ * @param number - Phone number string
+ *
+ * @deprecated Since around WhatsApp version 2.3000.1030110621. Use the new object-based API instead.
+ *             Use `deleteContactActionV2({ phoneNumber: wid })` for regular contacts
+ *             or `deleteContactActionV2({ username, lid })` for username contacts.
+ *
+ * @example
+ * // Deprecated usage
+ * await deleteContactAction('5511999999999');
+ *
+ * // Use this instead
+ * await deleteContactActionV2({ phoneNumber: wid });
  */
 export declare function deleteContactAction(number: string): Promise<void>;
+/**
+ * Deletes a contact from the contact list.
+ *
+ * @whatsapp WAWebDeleteContactAction >= 2.3000.1030110621
+ *
+ * @param params - Object with contact identifiers
+ * @param params.phoneNumber - Contact phone number as Wid (for regular contacts)
+ * @param params.username - Contact username (for username contacts)
+ * @param params.lid - Contact LID (for username contacts)
+ *
+ * @example
+ * // Delete regular contact by phone number
+ * await deleteContactActionV2({ phoneNumber: wid });
+ *
+ * // Delete username contact
+ * await deleteContactActionV2({ username: 'john', lid: '123' });
+ */
+export declare function deleteContactActionV2(params: {
+    phoneNumber?: Wid;
+    username?: string;
+    lid?: string;
+}): Promise<void>;

package/dist/whatsapp/functions/isFilterExcludedFromSearchTreatmentInInboxFlow.d.ts

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export declare function isFilterExcludedFromSearchTreatmentInInboxFlow(type?: string): void;
+export declare function isFilterExcludedFromSearchTreatmentInInboxFlow(type?: string): boolean;

package/dist/whatsapp/functions/saveContactAction.d.ts

@@ -14,9 +14,10 @@
  * limitations under the License.
  */
 /**
+ * Save contact action (legacy positional parameters API)
  * @whatsapp WAWebSaveContactAction >= 2.3000.0
- */
-/**
+ * @deprecated Use saveContactActionV2 instead for versions >= 2.3000.1030209354
+ * @whatsapp WAWebSaveContactAction >= 2.3000.0, < 2.3000.1030209354
  * @param user 5521980809090
  * @param userToDelete 5521980809090
  * @param e_fullName Contact Full Name
@@ -26,3 +27,21 @@
  * @param syncToAddressbook Sync to Addressbook boolean
  */
 export declare function saveContactAction(userToCreate: string, userToDelete: string | null, e_fullName?: any, f_firstName?: any, name?: any, surname?: any, syncToAddressbook?: boolean): Promise<undefined>;
+/**
+ * Object parameter interface for saveContactActionV2 (>= 2.3000.1030209354)
+ */
+export interface SaveContactActionParamsV2 {
+    phoneNumber?: string | null;
+    prevPhoneNumber?: string | null;
+    lid?: string | null;
+    username?: string | null;
+    firstName: string;
+    lastName: string;
+    syncToAddressbook?: boolean;
+}
+/**
+ * Save contact action (new object parameter API)
+ * @whatsapp WAWebSaveContactAction >= 2.3000.1030209354
+ * @param params Contact parameters object
+ */
+export declare function saveContactActionV2(params: SaveContactActionParamsV2): Promise<undefined>;

package/dist/whatsapp/misc/UsernameGatingUtils.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * Copyright 2025 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * @whatsapp WAWebUsernameGatingUtils
+ */
+export declare namespace UsernameGatingUtils {
+    /**
+     * Check if username feature is supported
+     * @whatsapp >= 2.3000.1030318976
+     * @returns true if username feature is supported
+     */
+    function usernameSupported(): boolean;
+}

package/dist/whatsapp/misc/index.d.ts

@@ -43,6 +43,7 @@ export * from './ServerProps';
 export * from './ServerPropsConstants';
 export * from './Socket';
 export * from './Stream';
+export * from './UsernameGatingUtils';
 export * from './UserPrefs';
 export * from './USyncQuery';
 export * from './USyncUser';

package/dist/whatsapp/models/ChatModel.d.ts

@@ -65,7 +65,10 @@ interface Session extends SessionChatBase {
     composeQuotedMsg?: any;
     composeQuotedMsgRemoteJid?: any;
     quotedMsgAdminGroupJid?: any;
+    groupSafetyChecked?: boolean;
     groupMetadata?: GroupMetadataModel;
+    groupType?: any;
+    newsletterMetadata?: any;
     presence?: any;
     mute: MuteModel;
     contact?: any;

package/dist/whatsapp/models/ContactModel.d.ts

@@ -32,6 +32,7 @@ interface Props {
     labels?: string[];
     disappearingModeDuration?: any;
     disappearingModeSettingTimestamp?: any;
+    username?: string;
 }
 interface Session {
     stale?: any;