talkyzap-wapp-api 1.0.17 → 1.0.19

package/CHANGELOG.md

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

package/README.md

@@ -10,10 +10,11 @@
 [![Lint Status](https://img.shields.io/github/actions/workflow/status/wppconnect-team/wa-js/lint.yml??branch=main&label=lint)](https://github.com/wppconnect-team/wa-js/actions/workflows/lint.yml)
 [![release-it](https://img.shields.io/badge/%F0%9F%93%A6%F0%9F%9A%80-release--it-e10079.svg)](https://github.com/release-it/release-it)
 
-> WPPConnect/WA-JS is an open-source project with the aim of exporting functions from WhatsApp Web, which can be used to support the creation of any interaction, such as customer service, media sending, intelligence recognition based on phrases artificial and many other things, use your imagination...
+> WPPConnect/WA-JS is an open-source project with the aim of exporting functions from WhatsApp Web, which can be used to support the creation of any interaction, such as customer service, media sending, intelligence recognition based on phrases and many other things, use your imagination...
 
 ## Our online channels
 
+[![Discussions](https://img.shields.io/github/discussions/wppconnect-team/wa-js?label=Discussions&logo=github)](https://github.com/wppconnect-team/wa-js/discussions)
 [![Discord](https://img.shields.io/discord/844351092758413353?color=blueviolet&label=Discord&logo=discord&style=flat)](https://discord.gg/JU5JGGKGNG)
 [![YouTube](https://img.shields.io/youtube/channel/subscribers/UCD7J9LG08PmGQrF5IS7Yv9A?label=YouTube)](https://www.youtube.com/c/wppconnect)
 [![WhatsApp Group](https://img.shields.io/badge/WhatsApp-Group-25D366?logo=whatsapp)](https://chat.whatsapp.com/LJaQu6ZyNvnBPNAVRbX00K)
@@ -28,20 +29,20 @@
 
 ## How does it work
 
-This project extract some functions of WhatsApp sources, that uses webpack.
+This project extracts some functions of WhatsApp sources.
 
-After build, this project generate a file `dist/wppconnect-wa.js` to be used for injection in WhatsApp Web. When injected, it will explose a global variable named `WPP`.
+After build, this project generates a file `dist/wppconnect-wa.js` to be used for injection in WhatsApp Web. When injected, it will expose a global variable named `WPP`.
 
 Some parts of `WPP` variable:
 
-- `WPP.webpack` - Scripts to exports WhatsApp functions.
+- `WPP.webpack` - Scripts to export WhatsApp functions.
 - `WPP.whatsapp` - Only exported WhatsApp functions.
 - `WPP.chat` - Chat functions and events.
 - ...
 
 ## Exported WhatsApp modules
 
-There are a convection name for some exported modules:
+There are convention names for some exported modules:
 
 - `...Model` - Class for data structure (`ClassModel`, `MsgModel`)
 - `...Collection` - Class for collection of models (`ChatCollection`, `MsgCollection`)
@@ -55,43 +56,80 @@ There are a convection name for some exported modules:
 
 `WPP.conn.logout` - Logout from WhatsApp Web
 
-### Chat Functions
-`WPP.chat.sendTextMessage` - Send a text message
+`WPP.conn.getBuildConstants` - Current WhatsApp build constants
 
-`WPP.chat.sendImageMessage` - Send an image message
+For the most up-to-date list of available functions, launch the project locally and run this in your browser console:
 
-`WPP.chat.sendVideoMessage` - Send a video message
+`Object.keys(WPP.conn).sort()`
 
-`WPP.chat.sendFileMessage` - Send a file message
+### Chat Functions
+`WPP.chat.sendTextMessage` - Send a text message
 
-`WPP.chat.sendAudioMessage` - Send an audio message
+`WPP.chat.sendFileMessage` - Send a file message (medias in general [video, audio, image, pdf])
 
-`WPP.chat.getChat` - Get chat details
+`WPP.chat.get` - Get chat details
 
 `WPP.chat.deleteMessage` - Delete a message
 
-### Contact Functions
-`WPP.contact.getContact` - Get contact details
+For the most up-to-date list of available functions, launch the project locally and run this in your browser console:
 
-`WPP.contact.blockContact` - Block a contact
+`Object.keys(WPP.chat).sort()`
 
-`WPP.contact.unblockContact` - Unblock a contact
+### Contact Functions
+`WPP.contact.get` - Get contact details
 
 `WPP.contact.getAllContacts` - Get all contacts
 
+`WPP.contact.getStatus` - Get status (`about` field in profile)
+
+`WPP.contact.getCommonGroups` - Get groups in common with one contact
+
+`WPP.contact.getPnLidEntry` - Get PN (Phone Number), Lid and Contact from local cache
+
+For the most up-to-date list of available functions, launch the project locally and run this in your browser console:
+
+`Object.keys(WPP.contact).sort()`
+
+### Blocklist Functions
+
+`WPP.blocklist.blockContact` - Block a contact
+
+`WPP.blocklist.unblockContact` - Unblock a contact
+
+`WPP.blocklist.all` - All blocked contacts
+
+`WPP.blocklist.isBlocked` - Check if contact is blocked
+
+For the most up-to-date list of available functions, launch the project locally and run this in your browser console:
+
+`Object.keys(WPP.blocklist).sort()`
+
 ### Group Functions
-`WPP.group.createGroup` - Create a new group
 
-`WPP.group.addParticipant` - Add a participant to a group
+`WPP.group.create` - Create a new group
+
+`WPP.group.canAdd` - Check if contact can be added to group
+
+`WPP.group.addParticipants` - Add participants to a group
+
+`WPP.group.removeParticipants` - Remove participants from a group.
+
+`WPP.group.canPromote` - Check if contact can be promoted
 
-`WPP.group.removeParticipant` - Remove a participant from a group.
+`WPP.group.promoteParticipants` - Promote participants to admin
 
-`WPP.group.promoteParticipant` - Promote a participant to admin
+`WPP.group.canDemote` - Check if contact can be demoted
 
-`WPP.group.demoteParticipant` - Demote a participant from admin.
+`WPP.group.demoteParticipants` - Demote participants from admin.
 
 `WPP.group.getGroupInfoFromInviteCode` - Get group information from an invitation link or an invite code.
 
+`WPP.group.getAllGroups` - Get all groups
+
+For the most up-to-date list of available functions, launch the project locally and run this in your browser console:
+
+`Object.keys(WPP.group).sort()`
+
 ### Events
 `WPP.chat.on('chat.new_message')` - Event to dispatch on receive a new message
 
@@ -102,24 +140,38 @@ To see all events, check: [https://wppconnect.io/wa-js/types/ev.EventTypes.html]
 Steps to run locally:
 
 ```bash
-# install the depencencies
+# install the dependencies
 npm install
 
-# download whatsapp javascript and prettify (optional)
-npm run wa-source
-
 # build javascript files
 npm run build:prd # or build:dev for development
 
 # launch a local browser with automatic injection
+# this will also cache the files inside wa-source directory, for next requests
 npm run launch:local
 
 # or only run in VSCode
 ```
 
+Note: to run specific versions run:
+
+```sh
+npm run wa-source:clean
+
+npm run build:prd
+
+WA_VERSION="2.3000.1029560485" npm run launch:local
+```
+
+To debug or inspect `wa-source` folder, format the files to be easier to understand
+
+```sh
+npm run wa-source:format
+```
+
 ## How to use this project
 
-Basicaly, you need to inject the `wppconnect-wa.js` file into the browser after WhatsApp page load.
+Basically, you need to inject the `wppconnect-wa.js` file into the browser after WhatsApp page load.
 
 ### TamperMonkey or GreaseMonkey
 

package/dist/call/events/eventTypes.d.ts

@@ -13,7 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Wid } from '../../whatsapp';
 export interface CallEventTypes {
     /**
      * Triggered when you a incoming call
@@ -47,10 +46,10 @@ export interface CallEventTypes {
         /**
          * Wid of sender without device id
          */
-        sender: Wid;
+        sender: any;
         /**
          * Wid of sender with device id
          */
-        peerJid: Wid;
+        peerJid: any;
     };
 }

package/dist/call/events/registerIncomingCallEvent.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2022 WPPConnect Team
+ * 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.

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

@@ -14,19 +14,19 @@
  * limitations under the License.
  */
 import { MsgKey, Wid } from '../../whatsapp';
-export interface ForwardMessagesOptions {
+export interface ForwardMessageOptions {
     displayCaptionText?: boolean;
     multicast?: boolean;
 }
 /**
- * Forward messages to a chat
+ * Forward message to a chat
  *
  * @example
  * ```javascript
- * // Forward messages
+ * // Forward message
  * WPP.chat.forwardMessage('[number]@c.us', 'true_[number]@c.us_ABCDEF');
  * ```
  * @category Message
  * @return  {any} Any
  */
-export declare function forwardMessage(toChatId: string | Wid, msgId: string | MsgKey, options?: ForwardMessagesOptions): Promise<boolean>;
+export declare function forwardMessage(toChatId: string | Wid, msgId: string | MsgKey, options?: ForwardMessageOptions): Promise<boolean>;

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

@@ -0,0 +1,33 @@
+/*!
+ * Copyright 2021 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.
+ */
+import { MsgKey, MsgModel, Wid } from '../../whatsapp';
+export interface ForwardMessagesOptions {
+    displayCaptionText?: boolean;
+    multicast?: boolean;
+    appendedText?: boolean;
+}
+/**
+ * Forward many messages to a chat
+ *
+ * @example
+ * ```javascript
+ * // Forward messages
+ * WPP.chat.forwardMessagesWhatsApp('[number]@c.us', ['true_[number]@c.us_ABCDEF', ...]);
+ * ```
+ * @category Message
+ * @return  {any} Any
+ */
+export declare function forwardMessages(toChatId: string | Wid, msgsId: string[] | MsgKey[] | MsgModel[], options?: ForwardMessagesOptions): Promise<Array<any>>;

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

@@ -21,6 +21,7 @@ export interface GetMessagesOptions {
     id?: string;
     onlyUnread?: boolean;
     media?: 'url' | 'document' | 'all' | 'image';
+    includeCallMessages?: boolean;
 }
 /**
  * Fetch messages from a chat
@@ -79,6 +80,12 @@ export interface GetMessagesOptions {
  *   count: 20,
  *   media: 'url',
  * });
+ *
+ * // Include call messages along with chat messages
+ * WPP.chat.getMessages('[number]@c.us', {
+ *   count: 20,
+ *   includeCallMessages: true,
+ * });
  * ```
  * @category Message
  * @return  {RawMessage[]} List of raw messages

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

@@ -24,7 +24,8 @@ export { deleteMessage, DeleteMessageReturn } from './deleteMessage';
 export { downloadMedia } from './downloadMedia';
 export { editMessage } from './editMessage';
 export { find } from './find';
-export { forwardMessage, ForwardMessagesOptions } from './forwardMessage';
+export { forwardMessage, ForwardMessageOptions } from './forwardMessage';
+export { forwardMessages, ForwardMessagesOptions } from './forwardMessages';
 export { generateMessageID } from './generateMessageID';
 export { get } from './get';
 export { getActiveChat } from './getActiveChat';

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

@@ -23,6 +23,7 @@ export interface ChatListOptions {
     onlyNewsletter?: boolean;
     onlyUsers?: boolean;
     onlyWithUnreadMessage?: boolean;
+    onlyArchived?: boolean;
     withLabels?: string[];
 }
 /**
@@ -59,6 +60,9 @@ export interface ChatListOptions {
  *
  * // Only with label with one of text or id
  * const chats = await WPP.chat.list({withLabels: ['Alfa','5']});
+ *
+ * // Only archived chats
+ * const chats = await WPP.chat.list({onlyArchived: true});
  * ```
  *
  * @category Chat

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

@@ -22,6 +22,8 @@ import { Wid } from '../../whatsapp';
  * await WPP.chat.openChatAt('[number]@c.us', <message_id>);
  * ```
  *
+ * @argument chatEntryPoint Optional chat entry point: "Chatlist" for any existing chat in the left panel, undefined for any other case.
+ *
  * @category Chat
  */
-export declare function openChatAt(chatId: string | Wid, messageId: string): Promise<boolean>;
+export declare function openChatAt(chatId: string | Wid, messageId: string, chatEntryPoint?: string | undefined): Promise<boolean>;

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

@@ -22,6 +22,8 @@ import { Wid } from '../../whatsapp';
  * await WPP.chat.openChatBottom('[number]@c.us');
  * ```
  *
+ * @argument chatEntryPoint Optional chat entry point: "Chatlist" for any existing chat in the left panel, undefined for any other case.
+ *
  * @category Chat
  */
-export declare function openChatBottom(chatId: string | Wid): Promise<boolean>;
+export declare function openChatBottom(chatId: string | Wid, chatEntryPoint?: string | undefined): Promise<boolean>;

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

@@ -22,6 +22,8 @@ import { Wid } from '../../whatsapp';
  * await WPP.chat.openChatFromUnread('[number]@c.us');
  * ```
  *
+ * @argument chatEntryPoint Optional chat entry point: "Chatlist" for any existing chat in the left panel, undefined for any other case.
+ *
  * @category Chat
  */
-export declare function openChatFromUnread(chatId: string | Wid): Promise<boolean>;
+export declare function openChatFromUnread(chatId: string | Wid, chatEntryPoint?: string | undefined): Promise<boolean>;

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

@@ -14,17 +14,31 @@
  * limitations under the License.
  */
 import { MsgKey, MsgModel } from '../../whatsapp';
-import { SendMsgResult } from '../../whatsapp/enums';
+import { PinExpiryDurationOption, SendMsgResult } from '../../whatsapp/enums';
 /**
  * Pin a message in chat
  *
+ * @param msgId - Message ID to pin/unpin
+ * @param pin - True to pin, false to unpin
+ * @param duration - Pin duration option. Use PinExpiryDurationOption enum for precise control.
+ *
+ * @since 3.18.9 - BREAKING CHANGE: The `seconds` parameter (number) has been replaced with `PinExpiryDurationOption` enum.
+ * For backward compatibility, numbers are still accepted but will ALWAYS default to 7 days,
+ * regardless of the value passed. Use `PinExpiryDurationOption` enum for precise duration control.
+ *
  * @example
  * ```javascript
- * // Pin a message in chat
+ * // Pin a message in chat with default duration (7 days)
  * WPP.chat.pinMsg('true_[number]@c.us_ABCDEF');
  *
- * // Pin a message in chat for 30 days
- * WPP.chat.pinMsg('true_[number]@c.us_ABCDEF', 2592000);
+ * // Pin a message in chat for 30 days (RECOMMENDED)
+ * WPP.chat.pinMsg('true_[number]@c.us_ABCDEF', true, WPP.whatsapp.PinExpiryDurationOption.ThirtyDays);
+ *
+ * // Pin a message in chat for 1 day
+ * WPP.chat.pinMsg('true_[number]@c.us_ABCDEF', true, WPP.whatsapp.PinExpiryDurationOption.OneDay);
+ *
+ * // DEPRECATED: Passing numbers (always results in 7 days)
+ * WPP.chat.pinMsg('true_[number]@c.us_ABCDEF', true, 2592000); // Ignored, defaults to 7 days
  *
  * // Unpin a message
  * WPP.chat.pinMsg('true_[number]@c.us_ABCDEF', false);
@@ -33,7 +47,7 @@ import { SendMsgResult } from '../../whatsapp/enums';
  * ```
  * @category Chat
  */
-export declare function pinMsg(msgId: string | MsgKey, pin?: boolean, seconds?: number): Promise<{
+export declare function pinMsg(msgId: string | MsgKey, pin?: boolean, duration?: number | PinExpiryDurationOption): Promise<{
     message: MsgModel;
     pinned: boolean;
     result: SendMsgResult;

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

@@ -179,6 +179,19 @@ export interface VideoMessageOptions extends FileMessageOptions, MessageButtonsO
  *    isPtv: true,
  *  }
  * );
+ *
+ * // Media using Link, the link must be public accessible
+ * // CORS must be enabled on the server and available for all domains
+ * // (Access-Control-Allow-Origin: *)
+ * // If the server does not have CORS enabled, you can use a public CORS proxy
+ * WPP.chat.sendFileMessage(
+ *  '[number]@c.us',
+ *  'https://example.com/image.jpg',
+ *  {
+ *    type: 'image',
+ *    caption: 'My image from URL', // Optional
+ *  }
+ * );
  * ```
  * @category Message
  * @return  {SendMessageReturn} The result

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

@@ -20,9 +20,8 @@ export type TextMessageOptions = SendMessageOptions & MessageButtonsOptions & Li
  *
  * @example
  * ```javascript
- * WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
- *   createChat: true
- * });
+ * // Send a simple text message
+ * WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact');
  *
  * // With Buttons
  * // Attention: The buttons are an alternative solution we found to make it work. There is no guarantee that they will continue functioning, or when they might stop: The only certainty is: They will stop, so use them responsibly.

package/dist/chat/index.d.ts

@@ -18,3 +18,4 @@ import './patch';
 export * from './defaultSendMessageOptions';
 export * from './functions';
 export * from './types';
+export * from './util';

package/dist/chat/types.d.ts

@@ -13,12 +13,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { ModelPropertiesContructor, MsgKey, MsgModel, Wid } from '../whatsapp';
-import { SendMsgResult } from '../whatsapp/enums';
+import { ModelPropertiesContructor, MsgKey, MsgModel, SendMsgResultObject, Wid } from '../whatsapp';
+export type { SendMsgResultObject };
 export interface SendMessageOptions {
     /**
      * Create a new chat to a new contact
      *
+     * @deprecated This option is no longer used. Chats are automatically created when sending messages.
      * @default false
      *
      * @example
@@ -82,6 +83,13 @@ export interface SendMessageOptions {
      * ```
      */
     quotedMsg?: string | MsgKey | MsgModel;
+    /**
+     * Quote a message using a previously saved payload.
+     * The payload must be the JSON string representation of a raw message.
+     * Raw messages can be obtained when using {@link getMessageById} or {@link getMessages}
+     * When provided it has priority over {@link quotedMsg}.
+     */
+    quotedMsgPayload?: string;
     /**
      * Wait for send while the ACK of message is SENT(1)
      *
@@ -114,6 +122,6 @@ export interface SendMessageReturn {
     to?: string;
     latestEditMsgKey?: MsgKey;
     ack: number;
-    sendMsgResult: Promise<SendMsgResult>;
+    sendMsgResult: Promise<SendMsgResultObject>;
 }
 export type RawMessage = ModelPropertiesContructor<MsgModel>;

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

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export * from './rehydrateMessage';

package/dist/chat/util/rehydrateMessage.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * 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.
+ */
+import { MsgModel } from '../../whatsapp';
+export declare function rehydrateMessage(value: any): MsgModel | undefined;

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

@@ -0,0 +1,19 @@
+/*!
+ * Copyright 2021 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.
+ */
+/**
+ * Change the current environment device between Web and Windows.
+ */
+export declare function changeEnviromentDevice(): void;

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

@@ -0,0 +1,37 @@
+/*!
+ * Copyright 2021 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.
+ */
+/**
+ * Get the WhatsApp Web build constants
+ * Retrieves the internal WAWebBuildConstants module from WhatsApp source
+ *
+ * @example
+ * ```javascript
+ * const buildConstants = WPP.conn.getBuildConstants();
+ * console.log('Version:', buildConstants.VERSION_STR);
+ * console.log('Base Version:', buildConstants.VERSION_BASE);
+ * console.log('Windows Build:', buildConstants.WINDOWS_BUILD);
+ * ```
+ *
+ * @returns {object|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
+ * - VERSION_SECONDARY: Secondary version number
+ * - VERSION_TERTIARY: Tertiary version number
+ * - WINDOWS_BUILD: Windows build number (if applicable)
+ * - And other build-related constants
+ */
+export declare function getBuildConstants(): string | null;

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

@@ -0,0 +1,52 @@
+/*!
+ * 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.
+ */
+import { Wid } from '../../whatsapp/misc';
+/**
+ * Migration state information for the current WhatsApp account
+ */
+export interface MigrationState {
+    /** Whether the account has been migrated to LID (Linked Identity) system */
+    isLidMigrated: boolean;
+    /** Whether the sync session has been migrated */
+    isSyncdSessionMigrated: boolean;
+    /** Whether old messaging rules should still be applied */
+    shouldApplyNonMigratedMessagingRules: boolean;
+    /** Whether the account should have an account LID */
+    shouldHaveAccountLid: boolean;
+    /** The current user's LID, if available */
+    currentLid?: Wid;
+    /** The current user's PN, if available */
+    currentPn?: Wid;
+}
+/**
+ * Get comprehensive migration state information for debugging and monitoring
+ *
+ * This function aggregates various LID (Linked Identity) migration-related
+ * information to help understand the current state of the account's migration
+ * from the legacy @c.us addressing system to the newer @lid system.
+ *
+ * @returns Object containing all available migration state information
+ *
+ * @example
+ * ```typescript
+ * const state = WPP.conn.getMigrationState();
+ * console.log('Account migrated:', state.isLidMigrated);
+ * console.log('Current LID:', state.currentLid);
+ * console.log('Should have LID:', state.shouldHaveAccountLid);
+ * ```
+ * @category Connection
+ */
+export declare function getMigrationState(): MigrationState;

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

@@ -13,9 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export { changeEnviromentDevice } from './changeEnviromentDevice';
 export { genLinkDeviceCodeForPhoneNumber } from './genLinkDeviceCodeForPhoneNumber';
 export { getAuthCode } from './getAuthCode';
+export { getBuildConstants } from './getBuildConstants';
 export { getHistorySyncProgress, HistorySyncProgress, } from './getHistorySyncProgress';
+export { getMigrationState, MigrationState } from './getMigrationState';
 export { getMyDeviceId } from './getMyDeviceId';
 export { getMyUserId } from './getMyUserId';
 export { getPlatform } from './getPlatform';

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

@@ -20,6 +20,8 @@ import { ContactModel, Wid } from '../../whatsapp';
  * @example
  * ```javascript
  * await WPP.contact.get('[number]@c.us');
+ * await WPP.contact.get('[number]@lid');
+ * await WPP.contact.get('[number]@g.us');
  * ```
  *
  * @category Contact