@wppconnect/wa-js 2.28.1 → 3.0.1

package/CHANGELOG.md

@@ -1,4 +1,9 @@
-## 2.28.1 (2023-12-20)
+## 3.0.1 (2024-03-25)
+
+
+### Bug Fixes
+
+* Fixed isOfficialClient check ([#1769](https://github.com/wppconnect-team/wa-js/issues/1769)) ([88f1f0e](https://github.com/wppconnect-team/wa-js/commit/88f1f0e6daf18b0492ceffb6274adef02323dc35))
 
 
 

package/README.md

@@ -99,7 +99,7 @@ import * as playwright from 'playwright-chromium';
 
 async function start() {
   const browser = await playwright.chromium.launch();
-  const page = browser.newPage();
+  const page = await browser.newPage();
 
   await page.goto('https://web.whatsapp.com/');
 
@@ -112,7 +112,7 @@ async function start() {
 
   // Evaluating code: See https://playwright.dev/docs/evaluating/
   const isAuthenticated: string = await page.evaluate(() =>
-    WPP.auth.isAuthenticated()
+    WPP.conn.isAuthenticated()
   );
 
   // Sending message: See https://playwright.dev/docs/evaluating/

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

@@ -73,6 +73,14 @@ export interface ChatEventTypes {
          */
         ids: MsgKey[];
     };
+    /**
+     * On Message edit
+     */
+    'chat.msg_edited': {
+        chat: Wid;
+        id: string;
+        msg: MsgModel;
+    };
     'chat.live_location_start': {
         id: Wid;
         msgId: MsgKey;

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

@@ -22,3 +22,4 @@ import './registerPresenceChange';
 import './registerReactionsEvent';
 import './registerRevokeMessageEvent';
 import './registerLabelEvent';
+import './registerEditedMessageEvent';

package/dist/{whatsapp/misc/Locale.d.ts → chat/events/registerEditedMessageEvent.d.ts}

@@ -13,12 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-declare class LocaleClass {
-}
-/** @whatsapp 14296
- * @whatsapp 43725 >= 2.2204.13
- * @whatsapp 914296 >= 2.2222.8
- * @whatsapp 568064 >= 2.2230.8
- */
-export declare const Locale: LocaleClass;
 export {};

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

@@ -55,6 +55,7 @@ export { prepareRawMessage } from './prepareRawMessage';
 export { requestPhoneNumber } from './requestPhoneNumber';
 export { PoolMessageOptions, sendCreatePollMessage, } from './sendCreatePollMessage';
 export { AudioMessageOptions, AutoDetectMessageOptions, DocumentMessageOptions, FileMessageOptions, ImageMessageOptions, sendFileMessage, StickerMessageOptions, VideoMessageOptions, } from './sendFileMessage';
+export { GroupInviteMessage, sendGroupInviteMessage, } from './sendGroupInviteMessage';
 export { ListMessageOptions, sendListMessage } from './sendListMessage';
 export { LocationMessageOptions, sendLocationMessage, } from './sendLocationMessage';
 export { OrderItems, OrderMessageOptions, sendOrderMessage, } from './sendOrderMessage';

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

@@ -0,0 +1,56 @@
+/*!
+ * 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';
+import { SendMessageOptions, SendMessageReturn } from '..';
+export interface GroupInviteMessage extends SendMessageOptions {
+    jpegThumbnail?: string;
+    inviteCode: string;
+    inviteCodeExpiration?: number;
+    groupId: string | Wid;
+    groupName?: string;
+    caption?: string;
+}
+/**
+ * Send a group invite message
+ *
+ * @example
+ * ```javascript
+ * WPP.chat.sendGroupInviteMessage(
+ *  '[number]@c.us',
+ *  {
+ *    inviteCode: '123',
+ *    groupId: '789@g.us'
+ *  }
+ * );
+ *
+ * // After a invite
+ * const result = await WPP.group.addParticipants('789@g.us', '123@c.us');
+ * const participant = result['123@c.us'];
+ * if (participant.invite_code) {
+ *   WPP.chat.sendGroupInviteMessage(
+ *     '123@c.us',
+ *     {
+ *       inviteCode: participant.invite_code,
+ *       inviteCodeExpiration: participant.invite_code_exp,
+ *       groupId: '789@g.us'
+ *     }
+ *   );
+ * }
+ * ```
+ *
+ * @category Message
+ */
+export declare function sendGroupInviteMessage(chatId: any, options: GroupInviteMessage): Promise<SendMessageReturn>;

package/dist/conn/index.d.ts

@@ -14,5 +14,6 @@
  * limitations under the License.
  */
 import './events';
+import './patch';
 export * from './functions';
 export * from './types';

package/dist/conn/patch.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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 {};

package/dist/labels/functions/addNewLabel.d.ts

@@ -28,8 +28,9 @@ export interface NewLabelOptions {
  * await WPP.labels.addNewLabel(`Name of label`);
  * //or
  * await WPP.labels.addNewLabel(`Name of label`, { labelColor: '#dfaef0' });
- * //or
- * await WPP.labels.addNewLabel(`Name of label`, { labelColor: 4292849392 });
+ * ```
+ * //or with color index
+ * await WPP.labels.addNewLabel(`Name of label`, { labelColor: 16 });
  * ```
  */
-export declare function addNewLabel(labelName: string, options?: NewLabelOptions): Promise<any>;
+export declare function addNewLabel(labelName: string, options?: NewLabelOptions): Promise<import("..").Label>;

package/dist/labels/functions/deleteLabel.d.ts

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

package/dist/labels/functions/editLabel.d.ts

@@ -0,0 +1,37 @@
+/*!
+ * 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 EditLabelOptions {
+    /**
+     * If it's decimal, send it as a number. If it's hexadecimal, send it as a string.
+     * If labelColor is omitted, the color will be generated automatically
+     */
+    labelColor?: string | number;
+    name?: string;
+}
+/**
+ * Edit a label
+ * For get a new color, use await WPP.labels.getLabelColorPalette() to get the list of available colors
+ * @example
+ * ```javascript
+ * await WPP.labels.editLabel(`Name of label`);
+ * //or
+ * await WPP.labels.editLabel(`Name of label`, { labelColor: '#dfaef0' });
+ * ```
+ * //or with color index
+ * await WPP.labels.editLabel(`Name of label`, { labelColor: 16 });
+ * ```
+ */
+export declare function editLabel(id: string, options?: EditLabelOptions): Promise<import("..").Label>;

package/dist/labels/functions/getLabelColorPalette.d.ts

@@ -14,6 +14,6 @@
  * limitations under the License.
  */
 /**
- * Returns an array of color palette in positive decimal
+ * Returns an array of color palette in hex code
  */
-export declare function getLabelColorPalette(): Promise<number[]>;
+export declare function getLabelColorPalette(): Promise<string[]>;

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

@@ -18,6 +18,7 @@ export { addOrRemoveLabels, AddOrRemoveLabelsOptions, } from './addOrRemoveLabel
 export { colorIsInLabelPalette } from './colorIsInLabelPalette';
 export { deleteAllLabels } from './deleteAllLabels';
 export { deleteLabel, DeleteLabelReturn } from './deleteLabel';
+export { editLabel } from './editLabel';
 export { getAllLabels } from './getAllLabels';
 export { getLabelById } from './getLabelById';
 export { getLabelColorPalette } from './getLabelColorPalette';

package/dist/labels/types.d.ts

@@ -19,4 +19,5 @@ export interface Label {
     color: number | null;
     count: number;
     hexColor: string;
+    colorIndex: number;
 }

package/dist/profile/functions/getMyProfileName.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * 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 your current profile name
+ *
+ * @example
+ * ```javascript
+ * const myProfileName = WPP.profile.getMyProfileName();
+ * ```
+ *
+ * @category Profile
+ */
+export declare function getMyProfileName(): string;

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

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 export { editBusinessProfile } from './editBusinessProfile';
+export { getMyProfileName } from './getMyProfileName';
 export { getMyStatus } from './getMyStatus';
 export { isBusiness } from './isBusiness';
 export { removeMyProfilePicture } from './removeMyProfilePicture';

package/dist/webpack/index.d.ts

@@ -13,6 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * Is setted true when the loader is injected
+ */
+export declare let loaderType: 'meta' | 'unknown' | 'webpack';
 /**
  * Is setted true when the loader is injected
  */
@@ -29,6 +33,11 @@ export declare function onInjected(listener: () => void, delay?: number): void;
 export declare function onReady(listener: () => void, delay?: number): void;
 export declare function onFullReady(listener: () => void, delay?: number): void;
 export type SearchModuleCondition = (module: any, moduleId: string) => boolean;
+export declare const __debug: () => {
+    modulesMap: {
+        [key: string]: any;
+    };
+};
 export declare let webpackRequire: (<T = any>(moduleId: string) => T) & {
     /**
      * module list

package/dist/whatsapp/collections/LabelCollection.d.ts

@@ -31,6 +31,7 @@ export declare class LabelCollection extends BaseCollection<LabelModel> {
     deleteLabel(id: string): any;
     updateLabel(e?: any, t?: any): any;
     getNewLabelColor(): any;
+    getNextAvailableColor(): any;
     getLabelColorPalette(): any;
     handleRemove(e?: any): any;
     updateChecksum(e?: any): any;

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

@@ -0,0 +1,20 @@
+/*!
+ * 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.
+ * 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 885910
+ */
+export declare function colorIndexToHex(index: number): string;
+export declare function getAllLabelColors(): string[];

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

@@ -0,0 +1,18 @@
+/*!
+ * 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.
+ * 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 263133
+ */
+export declare function getNextLabelId(): Promise<number>;

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

@@ -0,0 +1,19 @@
+/*!
+ * 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.
+ * 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 135963 >= 2.2310.5
+ */
+export declare function getPushname(): string;

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

@@ -22,6 +22,7 @@ export * from './canEditMsg';
 export * from './canReplyMsg';
 export * from './changeOptInStatusForExternalWebBeta';
 export * from './collections';
+export * from './colorIndexToHex';
 export * from './contactFunctions';
 export * from './createFanoutMsgStanza';
 export * from './createGroup';
@@ -57,9 +58,11 @@ export * from './getGroupSenderKeyList';
 export * from './getGroupSizeLimit';
 export * from './getHistorySyncProgress';
 export * from './getMembershipApprovalRequests';
+export * from './getNextLabelId';
 export * from './getNumChatsPinned';
 export * from './getOrderInfo';
 export * from './getParticipants';
+export * from './getPushname';
 export * from './getQuotedMsgObj';
 export * from './getReactions';
 export * from './getSearchContext';
@@ -76,6 +79,8 @@ export * from './isRegistered';
 export * from './isUnreadTypeMsg';
 export * from './joinGroupViaInvite';
 export * from './keepMessage';
+export * from './labelAddAction';
+export * from './labelAddAction';
 export * from './markSeen';
 export * from './mediaTypeFromProtobuf';
 export * from './membershipApprovalRequestAction';

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

@@ -0,0 +1,20 @@
+/*!
+ * 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.
+ * 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 165820
+ */
+export declare function labelAddAction(name: string, colorIndex: number): Promise<any>;
+export declare function labelDeleteAction(id: string, name: string, colorIndex: number): Promise<number>;
+export declare function labelEditAction(id: string, name: string, predefinedId: number, colorIndex: number): Promise<any>;

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

@@ -15,8 +15,17 @@
  */
 import { ChatModel } from '../models';
 /**
+ * @deprecated
  * @whatsapp 59992
  * @whatsapp 259992 >= 2.2222.8
  * @whatsapp 503153 >= 2.2228.4
+ * <= 2.3000.x
  */
 export declare function setArchive(chat: ChatModel, archive: boolean, id?: string): Promise<void>;
+/**
+ * @whatsapp >= 2.3000.1012117641
+ */
+export declare function setArchive(args: {
+    id: string;
+    archive: boolean;
+}[]): Promise<void>;

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

@@ -0,0 +1,22 @@
+/*!
+ * 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.
+ */
+/**
+ * @whatsapp >= 2.3000.x
+ */
+export declare namespace IsOfficialClient {
+    function isLegitErrorStack(): boolean;
+    let isOfficialClient: boolean;
+}

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

@@ -21,7 +21,7 @@ export * from './Conn';
 export * from './Constants';
 export * from './EventEmitter';
 export * from './ImageUtils';
-export * from './Locale';
+export * from './IsOfficialClient';
 export * from './MediaBlobCache';
 export * from './MediaEntry';
 export * from './MediaObject';

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

@@ -190,6 +190,7 @@ interface Props {
     totalCurrencyCode?: any;
     historySyncMetaData?: any;
     mdDowngrade?: any;
+    isCaptionByUser: boolean;
     isSendFailure: boolean;
     appStateSyncKeyShare?: any;
     appStateSyncKeyRequest?: any;