talkyzap-wapp-api 1.0.22 → 1.0.23

package/CHANGELOG.md

@@ -1,4 +1,4 @@
-## 3.19.5 (2026-01-12)
+## 3.20.1 (2026-01-23)
 
 
 

package/README.md

@@ -169,6 +169,28 @@ To debug or inspect `wa-source` folder, format the files to be easier to underst
 npm run wa-source:format
 ```
 
+### Comparing WhatsApp Web Versions
+
+To compare changes between two WhatsApp Web versions, use the helper script:
+
+Note: You need to run locally in multiple versions to download the scripts to wa-source folder, otherwise will not have anything to compare. To do it use: `WA_VERSION="<version-here>" npm run launch:local`
+
+```bash
+# Compare two versions (overview of module differences)
+./scripts/compare-wa-versions.sh 2.3000.1031980585 2.3000.1031992593
+
+# Compare a specific module between versions
+./scripts/compare-wa-versions.sh 2.3000.1031980585 2.3000.1031992593 WAWebUpdateUnreadChatAction
+
+# List available versions
+./scripts/compare-wa-versions.sh
+```
+
+This is useful for:
+- Tracking API changes between WhatsApp Web updates
+- Identifying when function signatures changed
+- Finding new or removed modules
+
 ## How to use this project
 
 Basically, you need to inject the `wppconnect-wa.js` file into the browser after WhatsApp page load.

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

@@ -0,0 +1,83 @@
+/*!
+ * 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 { RawABPropConfig } from '../../whatsapp/functions/abPropsCache';
+/**
+ * A/B test property configuration
+ */
+export interface ABPropConfig extends RawABPropConfig {
+    /** The human-readable config name (e.g., "web_pwa_background_sync") */
+    name: string | null;
+}
+/**
+ * Get all A/B test property configurations for the current session
+ * These are experimental flags that WhatsApp uses for feature testing
+ *
+ * @example
+ * ```javascript
+ * // Get all A/B props as an array
+ * const abProps = WPP.conn.getABProps();
+ * console.log('Total A/B props:', abProps.length);
+ *
+ * // Log each prop with its name
+ * abProps.forEach(prop => {
+ *   console.log(`${prop.name}: ${prop.configValue}`);
+ * });
+ * ```
+ *
+ * @returns {ABPropConfig[]} Array of A/B property configurations with names
+ */
+export declare function getABProps(): ABPropConfig[];
+/**
+ * Get all A/B test property configurations as a Map
+ * The map is keyed by the config code for easier lookup
+ *
+ * @example
+ * ```javascript
+ * // Get all A/B props as a Map
+ * const abPropsMap = WPP.conn.getABPropsMap();
+ *
+ * // Check a specific config by code
+ * const specificProp = abPropsMap.get('12345');
+ * if (specificProp) {
+ *   console.log('Name:', specificProp.name);
+ *   console.log('Value:', specificProp.configValue);
+ * }
+ *
+ * // Convert to object for easy viewing
+ * const result = {};
+ * abPropsMap.forEach((value, key) => {
+ *   result[value.name || key] = value.configValue;
+ * });
+ * console.table(result);
+ * ```
+ *
+ * @returns {Map<string, ABPropConfig>} Map of config code to A/B property configuration with names
+ */
+export declare function getABPropsMap(): Map<string, ABPropConfig>;
+/**
+ * Get the human-readable name of an A/B config from its code
+ *
+ * @example
+ * ```javascript
+ * // Get name from config code
+ * const name = WPP.conn.getABPropName('12345');
+ * console.log('Config name:', name);
+ * ```
+ *
+ * @param configCode - The numeric config code
+ * @returns {string|null} The human-readable config name or null if not found
+ */
+export declare function getABPropName(configCode: string): string | null;

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

@@ -0,0 +1,34 @@
+/*!
+ * Copyright 2026 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 auto-download settings for media types
+ *
+ * @example
+ * ```javascript
+ * // Get current settings
+ * const settings = WPP.conn.getAutoDownloadSettings();
+ * console.log(settings);
+ * // { photos: true, audio: true, videos: false, documents: false }
+ * ```
+ *
+ * @category Config
+ */
+export declare function getAutoDownloadSettings(): {
+    photos: boolean;
+    audio: boolean;
+    videos: boolean;
+    documents: boolean;
+};

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

@@ -64,3 +64,18 @@ export declare function getBuildConstants(): BuildConstants | null;
  * @returns {boolean} True if current version is >= specified version
  */
 export declare function isWhatsAppVersionGTE(version: string): boolean;
+/**
+ * Check if the current WhatsApp version is less than or equal to a specified version
+ *
+ * @example
+ * ```javascript
+ * // Check if version is <= 2.3000.1029960097
+ * if (WPP.conn.isWhatsAppVersionLTE('2.3000.1029960097')) {
+ *   console.log('Using legacy 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 isWhatsAppVersionLTE(version: string): boolean;

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

@@ -24,8 +24,6 @@ export interface MigrationState {
     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 */

package/dist/{whatsapp/misc/UsernameGatingUtils.d.ts → conn/functions/getMyUserLid.d.ts}

@@ -13,14 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { Wid } from '../../whatsapp';
 /**
- * @whatsapp WAWebUsernameGatingUtils
+ * Return the current logged user LID (Locally Identified) without device id
+ *
+ * @example
+ * ```javascript
+ * const lid = WPP.conn.getMyUserLid();
+ * console.log(lid.toString()); // Output: 123@lid
+ * ```
  */
-export declare namespace UsernameGatingUtils {
-    /**
-     * Check if username feature is supported
-     * @whatsapp >= 2.3000.1030318976
-     * @returns true if username feature is supported
-     */
-    function usernameSupported(): boolean;
-}
+export declare function getMyUserLid(): Wid;

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

@@ -0,0 +1,39 @@
+/*!
+ * Copyright 2026 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 declare enum Theme {
+    LIGHT = "light",
+    DARK = "dark",
+    SYSTEM = "system"
+}
+/**
+ * Get current theme setting
+ *
+ * @example
+ * ```javascript
+ * // Get current theme
+ * const theme = WPP.conn.getTheme();
+ * console.log(theme); // "light", "dark", or "system"
+ *
+ * // Using enum
+ * import { Theme } from '@wppconnect/wa-js';
+ * if (theme === Theme.DARK) {
+ *   console.log('Dark mode is enabled');
+ * }
+ * ```
+ *
+ * @category Config
+ */
+export declare function getTheme(): Theme;

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

@@ -15,13 +15,18 @@
  */
 export { changeEnviromentDevice } from './changeEnviromentDevice';
 export { genLinkDeviceCodeForPhoneNumber } from './genLinkDeviceCodeForPhoneNumber';
+export { ABPropConfig, getABPropName, getABProps, getABPropsMap, } from './getABProps';
 export { getAuthCode } from './getAuthCode';
+export { getAutoDownloadSettings } from './getAutoDownloadSettings';
 export { BuildConstants, getBuildConstants, isWhatsAppVersionGTE, } from './getBuildConstants';
 export { getHistorySyncProgress, HistorySyncProgress, } from './getHistorySyncProgress';
 export { getMigrationState, MigrationState } from './getMigrationState';
 export { getMyDeviceId } from './getMyDeviceId';
 export { getMyUserId } from './getMyUserId';
+export { getMyUserLid } from './getMyUserLid';
+export { getMyUserWid } from './getMyUserWid';
 export { getPlatform } from './getPlatform';
+export { getTheme, Theme } from './getTheme';
 export { isAuthenticated } from './isAuthenticated';
 export { isIdle } from './isIdle';
 export { isMainInit } from './isMainInit';
@@ -35,6 +40,8 @@ export { logout } from './logout';
 export { markAvailable, markUnavailable } from './markAvailable';
 export { needsUpdate } from './needsUpdate';
 export { refreshQR } from './refreshQR';
+export { AutoDownloadSettings, setAutoDownloadSettings, } from './setAutoDownloadSettings';
 export { setKeepAlive } from './setKeepAlive';
 export { setLimit } from './setLimit';
 export { setMultiDevice } from './setMultiDevice';
+export { setTheme } from './setTheme';

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

@@ -0,0 +1,56 @@
+/*!
+ * Copyright 2026 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 AutoDownloadSettings {
+    /**
+     * Enable/disable auto-download for photos
+     */
+    photos?: boolean;
+    /**
+     * Enable/disable auto-download for audio
+     */
+    audio?: boolean;
+    /**
+     * Enable/disable auto-download for videos
+     */
+    videos?: boolean;
+    /**
+     * Enable/disable auto-download for documents
+     */
+    documents?: boolean;
+}
+/**
+ * Set auto-download settings for media types
+ *
+ * @example
+ * ```javascript
+ * // Disable video and document auto-download
+ * await WPP.conn.setAutoDownloadSettings({
+ *   videos: false,
+ *   documents: false
+ * });
+ *
+ * // Enable only photos
+ * await WPP.conn.setAutoDownloadSettings({
+ *   photos: true,
+ *   audio: false,
+ *   videos: false,
+ *   documents: false
+ * });
+ * ```
+ *
+ * @category Config
+ */
+export declare function setAutoDownloadSettings(settings: AutoDownloadSettings): Promise<void>;

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

@@ -0,0 +1,36 @@
+/*!
+ * Copyright 2026 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 { Theme } from './getTheme';
+/**
+ * Set theme and reload the page to apply changes
+ *
+ * @example
+ * ```javascript
+ * // Using Enum
+ * import { Theme } from '@wppconnect/wa-js';
+ * await WPP.conn.setTheme(Theme.LIGHT);
+ * await WPP.conn.setTheme(Theme.DARK);
+ * await WPP.conn.setTheme(Theme.SYSTEM);
+ *
+ * // Using string ("light", "dark", "system")
+ * await WPP.conn.setTheme("light");
+ * await WPP.conn.setTheme("dark");
+ * await WPP.conn.setTheme("system");
+ * ```
+ *
+ * @category Config
+ */
+export declare function setTheme(theme: Theme): Promise<void>;

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

@@ -22,6 +22,7 @@ export { getStatus } from './getStatus';
 export { ContactListOptions, list } from './list';
 export { queryExists } from './queryExists';
 export { remove } from './remove';
+export { reportContact, ReportContactResult } from './reportContact';
 export { save } from './save';
 export { subscribePresence } from './subscribePresence';
 export { unsubscribePresence } from './unsubscribePresence';

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

@@ -0,0 +1,62 @@
+/*!
+ * Copyright 2026 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, Wid } from '../../whatsapp';
+export interface ReportContactResult {
+    wid: Wid;
+    reportId?: string;
+    errorCode?: number;
+    errorText?: string;
+}
+/**
+ * Report a contact or chat to WhatsApp
+ *
+ * This function allows you to report contacts for spam, inappropriate behavior, or other violations.
+ *
+ * Available spam flow types:
+ * - 'ChatInfoReport' (default) - Report from chat info screen
+ * - 'MessageMenu' - Report from message menu
+ * - 'GroupInfoReport' - Report from group info screen
+ * - 'ChatFmxCardSafetyToolsReport' - Report from safety tools (trusted)
+ * - 'ChatFmxCardSafetyToolsReportSuspicious' - Report suspicious contact
+ * - 'GroupInfoLeaveReportUpsell' - Report when leaving group
+ *
+ * @example
+ * ```javascript
+ * // Basic contact report
+ * const result = await WPP.contact.reportContact('5511999999999@c.us');
+ * console.log('Report ID:', result.reportId);
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Report with specific type
+ * await WPP.contact.reportContact('5511999999999@c.us', 'ChatFmxCardSafetyToolsReportSuspicious');
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Report specific message
+ * const msg = await WPP.chat.getMessageById('msgId');
+ * await WPP.contact.reportContact('5511999999999@c.us', 'MessageMenu', msg);
+ * ```
+ *
+ * @category Contact
+ * @param contactId - Contact ID or Wid to report
+ * @param spamFlow - Optional spam flow type (default: 'ChatInfoReport')
+ * @param msg - Optional specific message to report
+ * @returns Promise with report result containing reportId or error details
+ */
+export declare function reportContact(contactId: string | Wid, spamFlow?: string, msg?: MsgModel): Promise<ReportContactResult>;

package/dist/newsletter/functions/follow.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * Copyright 2026 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.
+ */
+/**
+ * Follow/subscribe to a newsletter
+ *
+ * @example
+ * ```javascript
+ * // Follow a newsletter
+ * const success = await WPP.newsletter.follow('120363xxxxx@newsletter');
+ * ```
+ *
+ * @category Newsletter
+ */
+export declare function follow(id: string): Promise<boolean>;

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

@@ -16,5 +16,8 @@
 export { create } from './create';
 export { destroy } from './destroy';
 export { edit } from './edit';
+export { follow } from './follow';
 export { getSubscribers } from './getSubscribers';
 export { mute } from './mute';
+export { search } from './search';
+export { unfollow } from './unfollow';

package/dist/newsletter/functions/search.d.ts

@@ -0,0 +1,64 @@
+/*!
+ * Copyright 2026 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 NewsletterSearchOptions {
+    categories?: string[];
+    limit?: number;
+    cursorToken?: string;
+}
+export interface NewsletterSearchResult {
+    newsletters: Array<{
+        idJid: string;
+        name: string;
+        description: string;
+        picture: string;
+        subscribersCount: number;
+        verification: string;
+        handle: string | null;
+        inviteCode: string;
+        creationTime: number;
+        _raw?: any;
+    }>;
+    pageInfo?: {
+        hasNextPage?: boolean;
+        endCursor?: string;
+    };
+}
+/**
+ * Search for newsletters in the directory
+ *
+ * @example
+ * ```javascript
+ * // Basic search
+ * const result = await WPP.newsletter.search('technology');
+ *
+ * // Search with options
+ * const result = await WPP.newsletter.search('news', {
+ *   limit: 10,
+ *   categories: ['TECHNOLOGY', 'NEWS']
+ * });
+ *
+ * // Pagination
+ * const firstPage = await WPP.newsletter.search('tech');
+ * if (firstPage.pageInfo?.hasNextPage) {
+ *   const nextPage = await WPP.newsletter.search('tech', {
+ *     cursorToken: firstPage.pageInfo.endCursor
+ *   });
+ * }
+ * ```
+ *
+ * @category Newsletter
+ */
+export declare function search(query: string, options?: NewsletterSearchOptions): Promise<NewsletterSearchResult>;

package/dist/newsletter/functions/unfollow.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * Copyright 2026 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.
+ */
+/**
+ * Unfollow/unsubscribe from a newsletter
+ *
+ * @example
+ * ```javascript
+ * // Unfollow a newsletter
+ * const success = await WPP.newsletter.unfollow('120363xxxxx@newsletter');
+ * ```
+ *
+ * @category Newsletter
+ */
+export declare function unfollow(id: string): Promise<boolean>;

package/dist/util/index.d.ts

@@ -25,5 +25,6 @@ export * from './getVideoInfoFromBuffer';
 export * from './isBase64';
 export * from './isUrl';
 export * from './resizeImage';
+export * from './toArrayBuffer';
 export * from './types';
 export * from './wrapFunction';

package/dist/util/toArrayBuffer.d.ts

@@ -0,0 +1,21 @@
+/*!
+ * Copyright 2026 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.
+ */
+/**
+ * Convert different binary container types to a plain ArrayBuffer.
+ *
+ * Useful when dealing with APIs that may return TypedArrays or SharedArrayBuffer.
+ */
+export declare function toArrayBuffer(data: ArrayBuffer | ArrayBufferView | ArrayBufferLike | null | undefined): ArrayBuffer | null;

package/dist/whatsapp/enums/CHANNEL_EVENT_SURFACE.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * Copyright 2026 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 WAWebWamEnumChannelEventSurface >= 2.3000.1032373751
+ */
+export declare enum CHANNEL_EVENT_SURFACE {
+    CHANNEL_UPDATES_HOME = 1,
+    CHANNEL_THREAD = 2,
+    CHANNEL_DIRECTORY = 3,
+    CHANNEL_DIRECTORY_SEARCH = 4,
+    CHANNEL_PROFILE = 5,
+    CHANNEL_UPDATES_HOME_SEARCH = 6,
+    CHANNEL_DIRECTORY_CATEGORIES = 7,
+    CHANNEL_DIRECTORY_CATEGORIES_SEARCH = 8
+}

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

@@ -15,6 +15,7 @@
  */
 export * from './ACK';
 export * from './CALL_STATES';
+export * from './CHANNEL_EVENT_SURFACE';
 export * from './GROUP_SETTING_TYPE';
 export * from './KIC_ENTRY_POINT_TYP';
 export * from './LogoutReason';