@wppconnect/wa-js 4.0.2-alpha.0 → 4.1.0

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2026 WPPConnect Team
+ * 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.
@@ -13,23 +13,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { z } from 'zod';
-declare const connSetKeepAliveSchema: z.ZodObject<{
-    enable: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strip>;
-export type ConnSetKeepAliveInput = z.infer<typeof connSetKeepAliveSchema>;
-export type ConnSetKeepAliveOutput = boolean;
 /**
  * Set keep alive state, that will force the focused and online state
  *
  * @example
  * ```javascript
  * // To enable
- * await WPP.conn.setKeepAlive({ enable: true });
+ * await WPP.conn.setKeepAlive();
  *
  * // To disable
- * await WPP.conn.setKeepAlive({ enable: false });
+ * await WPP.conn.setKeepAlive(false);
  * ```
  */
-export declare function setKeepAlive(params?: ConnSetKeepAliveInput): ConnSetKeepAliveOutput;
-export {};
+export declare function setKeepAlive(enable?: boolean): boolean;

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2026 WPPConnect Team
+ * 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.
@@ -13,45 +13,55 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { z } from 'zod';
-declare const connSetLimitSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
-    key: z.ZodLiteral<"maxMediaSize">;
-    value: z.ZodNumber;
-}, z.core.$strip>, z.ZodObject<{
-    key: z.ZodLiteral<"maxFileSize">;
-    value: z.ZodNumber;
-}, z.core.$strip>, z.ZodObject<{
-    key: z.ZodLiteral<"maxShare">;
-    value: z.ZodNumber;
-}, z.core.$strip>, z.ZodObject<{
-    key: z.ZodLiteral<"statusVideoMaxDuration">;
-    value: z.ZodNumber;
-}, z.core.$strip>, z.ZodObject<{
-    key: z.ZodLiteral<"unlimitedPin">;
-    value: z.ZodBoolean;
-}, z.core.$strip>], "key">;
-export type ConnSetLimitInput = z.infer<typeof connSetLimitSchema>;
-export type ConnSetLimitOutput = number | boolean | null;
 /**
- * Change a limit
+ * Change the limit of MediaSize
  *
  * @example
  * ```javascript
  *  //Change the maximum size (bytes) for uploading media (max 70MB)
- *  WPP.conn.setLimit({ key: 'maxMediaSize', value: 16777216 });
+ *  WPP.conn.setLimit('maxMediaSize',16777216);
+ * ```
+ * @deprecated
+ */
+export declare function setLimit(key: 'maxMediaSize', value: number): number;
+/**
+ * Change the limit of FileSize
  *
+ * @example
+ * ```javascript
  *  //Change the maximum size (bytes) for uploading files (max 1GB)
- *  WPP.conn.setLimit({ key: 'maxFileSize', value: 104857600 });
+ *  WPP.conn.setLimit('maxFileSize',104857600);
+ * ```
+ */
+export declare function setLimit(key: 'maxFileSize', value: number): number;
+/**
+ * Change the limit of Share
  *
+ * @example
+ * ```javascript
  *  //Change the maximum number of contacts that can be selected when sharing (Default 5)
- *  WPP.conn.setLimit({ key: 'maxShare', value: 100 });
+ *  WPP.conn.setLimit('maxShare',100);
+ * ```
+ */
+export declare function setLimit(key: 'maxShare', value: number): number;
+/**
+ * Change the limit of Status Video Duration
  *
+ * @example
+ * ```javascript
  *  //Change the maximum time (seconds) of a video status
- *  WPP.conn.setLimit({ key: 'statusVideoMaxDuration', value: 120 });
+ *  WPP.conn.setLimit('statusVideoMaxDuration',120);
+ * ```
+ * @deprecated
+ */
+export declare function setLimit(key: 'statusVideoMaxDuration', value: number): number;
+/**
+ * Change the limit of Pin
  *
+ * @example
+ * ```javascript
  *  //Remove pinned conversation limit (only whatsapp web) (Default 3)
- *  WPP.conn.setLimit({ key: 'unlimitedPin', value: true });
+ *  WPP.conn.setLimit('unlimitedPin',true);
  * ```
  */
-export declare function setLimit(params: ConnSetLimitInput): ConnSetLimitOutput;
-export {};
+export declare function setLimit(key: 'unlimitedPin', value: boolean): boolean;

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2026 WPPConnect Team
+ * 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.
@@ -13,18 +13,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { z } from 'zod';
-declare const connSetMultiDeviceSchema: z.ZodObject<{
-    md: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strip>;
-export type ConnSetMultiDeviceInput = z.infer<typeof connSetMultiDeviceSchema>;
-export type ConnSetMultiDeviceOutput = boolean;
 /**
- * @param params.md If it's true, WhatsApp WEB will switch to MD. If it's false, WhatsApp WEB will switch to Legacy.
+ * @param md If it's true, WhatsApp WEB will switch to MD. If it's false, WhatsApp WEB will switch to Legacy.
  * @example
  * ```javascript
- * WPP.conn.setMultiDevice({ md: true })
+ * WPP.conn.setMultiDevice(true)
  * ```
  */
-export declare function setMultiDevice(params?: ConnSetMultiDeviceInput): ConnSetMultiDeviceOutput;
-export {};
+export declare function setMultiDevice(md?: boolean): boolean;

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

@@ -13,13 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { z } from 'zod';
 import { Theme } from './getTheme';
-declare const connSetThemeSchema: z.ZodObject<{
-    theme: z.ZodEnum<typeof Theme>;
-}, z.core.$strip>;
-export type ConnSetThemeInput = z.infer<typeof connSetThemeSchema>;
-export type ConnSetThemeOutput = void;
 /**
  * Set theme and reload the page to apply changes
  *
@@ -27,17 +21,16 @@ export type ConnSetThemeOutput = void;
  * ```javascript
  * // Using Enum
  * import { Theme } from '@wppconnect/wa-js';
- * await WPP.conn.setTheme({ theme: Theme.LIGHT });
- * await WPP.conn.setTheme({ theme: Theme.DARK });
- * await WPP.conn.setTheme({ theme: Theme.SYSTEM });
+ * 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({ theme: 'light' });
- * await WPP.conn.setTheme({ theme: 'dark' });
- * await WPP.conn.setTheme({ theme: 'system' });
+ * await WPP.conn.setTheme("light");
+ * await WPP.conn.setTheme("dark");
+ * await WPP.conn.setTheme("system");
  * ```
  *
  * @category Config
  */
-export declare function setTheme(params: ConnSetThemeInput): Promise<ConnSetThemeOutput>;
-export {};
+export declare function setTheme(theme: Theme): Promise<void>;

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2026 WPPConnect Team
+ * Copyright 2023 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,22 +13,17 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { z } from 'zod';
-import { ContactModel } from '../../whatsapp';
-declare const contactGetSchema: z.ZodObject<{
-    chatId: z.ZodString;
-}, z.core.$strip>;
-export type ContactGetInput = z.infer<typeof contactGetSchema>;
-export type ContactGetOutput = ContactModel | undefined;
+import { ContactModel, Wid } from '../../whatsapp';
 /**
- * Get a contact by chatId
+ * Get a contact by id
  *
  * @example
  * ```javascript
- * await WPP.contact.get({ chatId: '[chatId]' });
+ * await WPP.contact.get('[number]@c.us');
+ * await WPP.contact.get('[number]@lid');
+ * await WPP.contact.get('[number]@g.us');
  * ```
  *
  * @category Contact
  */
-export declare function get(params: ContactGetInput): Promise<ContactGetOutput>;
-export {};
+export declare function get(contactId: string | Wid): Promise<ContactModel | undefined>;

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2026 WPPConnect Team
+ * 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.
@@ -13,22 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { z } from 'zod';
-import { BusinessProfileModel } from '../../whatsapp';
-declare const contactGetBusinessProfileSchema: z.ZodObject<{
-    chatId: z.ZodString;
-}, z.core.$strip>;
-export type ContactGetBusinessProfileInput = z.infer<typeof contactGetBusinessProfileSchema>;
-export type ContactGetBusinessProfileOutput = BusinessProfileModel;
+import { BusinessProfileModel, Wid } from '../../whatsapp';
 /**
- * Get the business profile of a contact
+ * Get the current text status
  *
  * @example
  * ```javascript
- * const url = await WPP.contact.getBusinessProfile({ chatId: '[chatId]' });
+ * const url = await WPP.contact.getBusinessProfile('[number]@c.us');
  * ```
  *
  * @category Contact
  */
-export declare function getBusinessProfile(params: ContactGetBusinessProfileInput): Promise<ContactGetBusinessProfileOutput>;
-export {};
+export declare function getBusinessProfile(contactId: string | Wid): Promise<BusinessProfileModel>;

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2026 WPPConnect Team
+ * Copyright 2023 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,22 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { z } from 'zod';
 import { Wid } from '../../whatsapp';
-declare const contactGetCommonGroupsSchema: z.ZodObject<{
-    chatId: z.ZodString;
-}, z.core.$strip>;
-export type ContactGetCommonGroupsInput = z.infer<typeof contactGetCommonGroupsSchema>;
-export type ContactGetCommonGroupsOutput = Wid[];
 /**
  * Get all commons groups for the contact
  *
  * @example
  * ```javascript
- * const groups_ids = await WPP.contact.getCommonGroups({ chatId: '[chatId]' });
+ * const groups_ids = await WPP.contact.getCommonGroups('[number]@c.us');
  * ```
  *
  * @category Contact
  */
-export declare function getCommonGroups(params: ContactGetCommonGroupsInput): Promise<ContactGetCommonGroupsOutput>;
-export {};
+export declare function getCommonGroups(wid: Wid | string): Promise<Wid[]>;

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2026 WPPConnect Team
+ * Copyright 2023 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,8 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { z } from 'zod';
 import { WPPError } from '../../util';
+import { Wid } from '../../whatsapp';
 export interface PnLidWid {
     id: string;
     server: string;
@@ -45,20 +45,15 @@ export declare class InvalidWidForGetPnLidEntry extends WPPError {
         _serialized: string;
     });
 }
-declare const contactGetPnLidEntrySchema: z.ZodObject<{
-    chatId: z.ZodString;
-}, z.core.$strip>;
-export type ContactGetPnLidEntryInput = z.infer<typeof contactGetPnLidEntrySchema>;
-export type ContactGetPnLidEntryOutput = PnLidEntryResult;
 /**
  * Get LID/PhoneNumber mapping and Contact information
  *
  * @example
  * ```javascript
- * await WPP.contact.getPnLidEntry({ chatId: '[chatId]' });
+ * await WPP.contact.getPnLidEntry('[number]@c.us');
+ * await WPP.contact.getPnLidEntry('[number]@lid');
  * ```
  *
  * @category Contact
  */
-export declare function getPnLidEntry(params: ContactGetPnLidEntryInput): Promise<ContactGetPnLidEntryOutput>;
-export {};
+export declare function getPnLidEntry(contactId: string | Wid): Promise<PnLidEntryResult>;

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2026 WPPConnect Team
+ * 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.
@@ -13,22 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { z } from 'zod';
-declare const contactGetProfilePictureUrlSchema: z.ZodObject<{
-    chatId: z.ZodString;
-    full: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strip>;
-export type ContactGetProfilePictureUrlInput = z.infer<typeof contactGetProfilePictureUrlSchema>;
-export type ContactGetProfilePictureUrlOutput = string | undefined | null;
+import { Wid } from '../../whatsapp';
 /**
- * Get the profile picture URL
+ * Get the current text status
  *
  * @example
  * ```javascript
- * const url = await WPP.contact.getProfilePictureUrl({ chatId: '[chatId]' });
+ * const url = await WPP.contact.getProfilePictureUrl('[number]@c.us');
  * ```
  *
  * @category Contact
  */
-export declare function getProfilePictureUrl(params: ContactGetProfilePictureUrlInput): Promise<ContactGetProfilePictureUrlOutput>;
-export {};
+export declare function getProfilePictureUrl(contactId: string | Wid, full?: boolean): Promise<string | null | undefined>;

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2026 WPPConnect Team
+ * 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.
@@ -13,21 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { z } from 'zod';
-declare const contactGetStatusSchema: z.ZodObject<{
-    chatId: z.ZodString;
-}, z.core.$strip>;
-export type ContactGetStatusInput = z.infer<typeof contactGetStatusSchema>;
-export type ContactGetStatusOutput = string | null;
+import { Wid } from '../../whatsapp';
 /**
  * Get the current text status
  *
  * @example
  * ```javascript
- * await WPP.contact.getStatus({ chatId: '[chatId]' });
+ * await WPP.contact.getStatus('[number]@c.us');
  * ```
  *
  * @category Contact
  */
-export declare function getStatus(params: ContactGetStatusInput): Promise<ContactGetStatusOutput>;
-export {};
+export declare function getStatus(contactId: string | Wid): Promise<string | null>;

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2026 WPPConnect Team
+ * Copyright 2023 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,16 +13,21 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export { ContactGetInput, ContactGetOutput, get } from './get';
-export { ContactGetBusinessProfileInput, ContactGetBusinessProfileOutput, getBusinessProfile, } from './getBusinessProfile';
-export { ContactGetCommonGroupsInput, ContactGetCommonGroupsOutput, getCommonGroups, } from './getCommonGroups';
-export { ContactGetPnLidEntryInput, ContactGetPnLidEntryOutput, getPnLidEntry, InvalidWidForGetPnLidEntry, PnLidContactInfo, PnLidEntryResult, PnLidWid, } from './getPnLidEntry';
-export { ContactGetProfilePictureUrlInput, ContactGetProfilePictureUrlOutput, getProfilePictureUrl, } from './getProfilePictureUrl';
-export { ContactGetStatusInput, ContactGetStatusOutput, getStatus, } from './getStatus';
-export { ContactListInput, ContactListOutput, list } from './list';
-export { ContactQueryExistsInput, ContactQueryExistsOutput, queryExists, QueryExistsResult, } from './queryExists';
-export { ContactRemoveInput, ContactRemoveOutput, remove } from './remove';
-export { ContactReportContactInput, ContactReportContactOutput, reportContact, ReportContactResult, } from './reportContact';
-export { ContactSaveInput, ContactSaveOutput, save } from './save';
-export { ContactSubscribePresenceInput, ContactSubscribePresenceOutput, subscribePresence, } from './subscribePresence';
-export { ContactUnsubscribePresenceInput, ContactUnsubscribePresenceOutput, unsubscribePresence, } from './unsubscribePresence';
+export { get } from './get';
+export { getBusinessProfile } from './getBusinessProfile';
+export { getCommonGroups } from './getCommonGroups';
+export { getPnLidEntry, InvalidWidForGetPnLidEntry, PnLidContactInfo, PnLidEntryResult, PnLidWid, } from './getPnLidEntry';
+export { getProfilePictureUrl } from './getProfilePictureUrl';
+export { getStatus } from './getStatus';
+export { ContactListOptions, list } from './list';
+/**
+ * @deprecated Use queryWidExists instead
+ */
+export { queryExists, QueryExistsResult } from './queryExists';
+export { queryUsernameExists, QueryUsernameExistsKeyRequired, QueryUsernameExistsResult, } from './queryUsernameExists';
+export { queryWidExists, QueryWidExistsResult } from './queryWidExists';
+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/list.d.ts

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2026 WPPConnect Team
+ * 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.
@@ -13,36 +13,32 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { z } from 'zod';
 import { ContactModel } from '../../whatsapp';
-declare const contactListSchema: z.ZodObject<{
-    onlyMyContacts: z.ZodOptional<z.ZodBoolean>;
-    withLabels: z.ZodOptional<z.ZodArray<z.ZodString>>;
-}, z.core.$strip>;
-export type ContactListInput = z.infer<typeof contactListSchema>;
-export type ContactListOutput = ContactModel[];
+export interface ContactListOptions {
+    onlyMyContacts?: boolean;
+    withLabels?: string[];
+}
 /**
  * Return a list of contacts
  *
  * @example
  * ```javascript
  * // All contacts
- * const contats = await WPP.contact.list({});
+ * const contats = await WPP.contact.list();
  *
  * // Only my contacts
- * const contacts = await WPP.contact.list({ onlyMyContacts: true });
+ * const contacts = await WPP.contact.list({onlyMyContacts: true});
  *
  * // Only with label Text
- * const contacts = await WPP.contact.list({ withLabels: ['Test'] });
+ * const contacts = await WPP.contact.list({withLabels: ['Test']});
  *
  * // Only with label id
- * const contacts = await WPP.contact.list({ withLabels: ['1'] });
+ * const contacts = await WPP.contact.list({withLabels: ['1']});
  *
  * // Only with label with one of text or id
- * const contacts = await WPP.contact.list({ withLabels: ['Alfa','5'] });
+ * const contacts = await WPP.contact.list({withLabels: ['Alfa','5']});
  * ```
  *
  * @category Contact
  */
-export declare function list(params?: ContactListInput): Promise<ContactListOutput>;
-export {};
+export declare function list(options?: ContactListOptions): Promise<ContactModel[]>;

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2026 WPPConnect Team
+ * 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.
@@ -13,44 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { z } from 'zod';
-import { Wid } from '../../whatsapp';
-export interface QueryExistsResult {
-    wid: Wid;
-    biz: boolean;
-    bizInfo?: {
-        verifiedName?: {
-            isApi: boolean;
-            level: string;
-            name: string;
-            privacyMode: any;
-            serial: string;
-        };
-    };
-    disappearingMode?: {
-        duration: number;
-        settingTimestamp: number;
-    };
-    status?: string;
-    lid?: Wid;
-}
-declare const contactQueryExistsSchema: z.ZodObject<{
-    chatId: z.ZodString;
-}, z.core.$strip>;
-export type ContactQueryExistsInput = z.infer<typeof contactQueryExistsSchema>;
-export type ContactQueryExistsOutput = QueryExistsResult | null;
-/**
- * Check if the number exists and what is correct ID
- *
- * This help to identify numbers with nine digit in Brazil
- *
- * @example
- * ```javascript
- * const result = await WPP.contact.queryExists({ chatId: '[chatId]' });
- * console.log(result.wid); // Correct ID
- * ```
- *
- * @category Contact
- */
-export declare function queryExists(params: ContactQueryExistsInput): Promise<ContactQueryExistsOutput>;
-export {};
+/** @deprecated Use QueryWidExistsResult instead */
+export type { QueryWidExistsResult as QueryExistsResult } from './queryWidExists';
+/** @deprecated Use queryWidExists instead */
+export { queryWidExists as queryExists } from './queryWidExists';

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

@@ -0,0 +1,61 @@
+/*!
+ * 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 { Wid } from '../../whatsapp';
+export interface QueryUsernameExistsResult {
+    wid: Wid;
+    biz: boolean;
+    bizInfo?: {
+        verifiedName?: {
+            isApi: boolean;
+            level: string;
+            name: string;
+            privacyMode: any;
+            serial?: string;
+        };
+    };
+    username?: string;
+    wasUpdated: boolean;
+    isUsernameSearch: true;
+}
+export interface QueryUsernameExistsKeyRequired {
+    keyRequired: true;
+    username?: string;
+    isUsernameSearch: true;
+}
+/**
+ * Check if a WhatsApp username (@username) exists
+ *
+ * Some accounts protect their username with a PIN. When the account has PIN
+ * protection enabled, this function returns `{ keyRequired: true }` instead of
+ * contact info. Pass the numeric PIN as `key` to unlock the result.
+ *
+ * @example
+ * ```javascript
+ * // Basic lookup
+ * const result = await WPP.contact.queryUsernameExists('someusername');
+ * if (result && 'keyRequired' in result) {
+ *   // Username is PIN-protected — prompt the user for the PIN
+ * } else if (result) {
+ *   console.log(result.wid); // The contact's WID
+ * }
+ *
+ * // With PIN
+ * const result = await WPP.contact.queryUsernameExists('someusername', '1234');
+ * ```
+ *
+ * @category Contact
+ */
+export declare function queryUsernameExists(username: string, key?: string): Promise<QueryUsernameExistsResult | QueryUsernameExistsKeyRequired | null>;

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

@@ -0,0 +1,51 @@
+/*!
+ * 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 { Wid } from '../../whatsapp';
+export interface QueryWidExistsResult {
+    wid: Wid;
+    biz: boolean;
+    bizInfo?: {
+        verifiedName?: {
+            isApi: boolean;
+            level: string;
+            name: string;
+            privacyMode: any;
+            serial?: string;
+        };
+    };
+    disappearingMode?: {
+        duration: number;
+        settingTimestamp: number;
+    };
+    status?: string;
+    lid?: Wid;
+    username?: string;
+}
+/**
+ * Check if the wid (phone number or LID) exists on WhatsApp
+ *
+ * This helps to identify numbers with nine digit in Brazil.
+ * Results are cached via ContactStore (persistent) and a 5-min in-memory cache.
+ *
+ * @example
+ * ```javascript
+ * const result = await WPP.contact.queryWidExists('[number]@c.us');
+ * console.log(result.wid); // Correct ID
+ * ```
+ *
+ * @category Contact
+ */
+export declare function queryWidExists(contactId: string | Wid): Promise<QueryWidExistsResult | null>;