@wppconnect/wa-js 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -1,4 +1,9 @@
-# 3.0.0 (2024-03-09)
+# 3.1.0 (2024-03-28)
+
+
+### Reverts
+
+* Added template to changelog ([9ebf70b](https://github.com/wppconnect-team/wa-js/commit/9ebf70b6defd370eba39cc5786bcc49df6cb5b2a))
 
 
 

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/functions/index.d.ts

@@ -49,6 +49,7 @@ export { openChatAt } from './openChatAt';
 export { openChatBottom } from './openChatBottom';
 export { openChatFromUnread } from './openChatFromUnread';
 export { pin, unpin } from './pin';
+export { pinMsg, unpinMsg } from './pinMsg';
 export { LinkPreviewOptions, prepareLinkPreview } from './prepareLinkPreview';
 export { MessageButtonsOptions, prepareMessageButtons, } from './prepareMessageButtons';
 export { prepareRawMessage } from './prepareRawMessage';

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

@@ -0,0 +1,60 @@
+/*!
+ * 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.
+ */
+import { MsgKey, MsgModel } from '../../whatsapp';
+import { SendMsgResult } from '../../whatsapp/enums';
+/**
+ * Pin a message in chat
+ *
+ * @example
+ * ```javascript
+ * // Pin a message in chat
+ * 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);
+ *
+ * // Unpin a message
+ * WPP.chat.pinMsg('true_[number]@c.us_ABCDEF', false);
+ * // or
+ * WPP.chat.unpinMsg('true_[number]@c.us_ABCDEF');
+ * ```
+ * @category Chat
+ */
+export declare function pinMsg(msgId: string | MsgKey, pin?: boolean, seconds?: number): Promise<{
+    message: MsgModel;
+    pinned: boolean;
+    result: SendMsgResult;
+}>;
+/**
+ * Unpin a message in chat
+ *
+ * @alias pin
+ *
+ * @example
+ * ```javascript
+ * // Unpin a message
+ * WPP.chat.unpinMsg('true_[number]@c.us_ABCDEF');
+ *
+ * // Alias for
+ * WPP.chat.pinMsg('true_[number]@c.us_ABCDEF', false);
+ * ```
+ * @category Chat
+ */
+export declare function unpinMsg(msgId: string | MsgKey): Promise<{
+    message: MsgModel;
+    pinned: boolean;
+    result: SendMsgResult;
+}>;

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/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/collections/PinInChatCollection.d.ts

@@ -0,0 +1,29 @@
+/*!
+ * 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.
+ */
+import { PinInChatModel } from '../models/PinInChatModel';
+import { Collection } from './Collection';
+/**
+ * @whatsapp WAWebPinInChatCollection >= 2.3000.1012170943
+ */
+export declare class PinInChatCollection extends Collection<PinInChatModel> {
+    static model: PinInChatModel;
+    static cachePolicy?: any;
+    deleteByParentMessageKey(a?: any): any;
+    getByMsgKey(a?: any): PinInChatModel;
+    getByParentMsgKey(a?: any): PinInChatModel;
+    byChatId(a?: any): PinInChatModel[];
+    byIsFailedByMe(a?: any): any;
+}

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

@@ -40,6 +40,7 @@ export * from './MuteCollection';
 export * from './OrderCollection';
 export * from './OrderItemCollection';
 export * from './ParticipantCollection';
+export * from './PinInChatCollection';
 export * from './PresenceCollection';
 export * from './ProductCollCollection';
 export * from './ProductCollection';

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

@@ -0,0 +1,22 @@
+/*!
+ * 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.
+ */
+/** @whatsapp WAWebPinMsgConstants >= 2.3000.1012170943
+ */
+export declare enum PIN_STATE {
+    INVALID = 0,
+    PIN = 1,
+    UNPIN = 2
+}

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

@@ -20,4 +20,5 @@ export * from './KIC_ENTRY_POINT_TYP';
 export * from './LogoutReason';
 export * from './MSG_TYPE';
 export * from './OUTWARD_TYPES';
+export * from './PIN_STATE';
 export * from './SendMsgResult';

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/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,6 +58,7 @@ export * from './getGroupSenderKeyList';
 export * from './getGroupSizeLimit';
 export * from './getHistorySyncProgress';
 export * from './getMembershipApprovalRequests';
+export * from './getNextLabelId';
 export * from './getNumChatsPinned';
 export * from './getOrderInfo';
 export * from './getParticipants';
@@ -73,10 +75,13 @@ export * from './handleSingleMsg';
 export * from './initializeAltDeviceLinking';
 export * from './isAnimatedWebp';
 export * from './isAuthenticated';
+export * from './isLegitErrorStack';
 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';
@@ -103,6 +108,7 @@ export * from './sendExitGroup';
 export * from './sendGroupParticipants';
 export * from './sendJoinGroupViaInvite';
 export * from './sendNewsletterMessageJob';
+export * from './sendPinInChatMsg';
 export * from './sendQueryExists';
 export * from './sendQueryGroupInvite';
 export * from './sendQueryGroupInviteCode';

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

@@ -0,0 +1,19 @@
+/*!
+ * 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 525438
+ */
+export declare function isLegitErrorStack(): boolean;

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/sendPinInChatMsg.d.ts

@@ -0,0 +1,25 @@
+/*!
+ * 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.
+ */
+import { SendMsgResult } from '../enums';
+import { PIN_STATE } from '../enums/PIN_STATE';
+import { MsgModel } from '../models';
+/** @whatsapp WAWebSendPinMessageAction >= 2.3000.1012170943
+ */
+export declare function sendPinInChatMsg(msg: MsgModel, type: PIN_STATE, time?: number, d?: any): Promise<{
+    count: number;
+    messageSendResult: SendMsgResult;
+    t: number;
+}>;

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,21 @@
+/*!
+ * 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 {
+    let isOfficialClient: boolean;
+}

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

@@ -21,6 +21,7 @@ export * from './Conn';
 export * from './Constants';
 export * from './EventEmitter';
 export * from './ImageUtils';
+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;

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

@@ -39,10 +39,16 @@ export declare class MuteModel extends Model<MuteCollection> {
     idClass: typeof Wid;
     allowedIds?: any;
     constructor(proterties?: ModelPropertiesContructor<MuteModel>, options?: ModelOptions);
-    setMute(e?: any, t?: any): any;
-    mute(expiration: number, sendAction?: boolean, sequence?: number): Promise<number>;
+    setMute(expiration?: number, isAutoMuted?: boolean, sendDevice?: boolean): any;
+    mute(args: {
+        expiration: number;
+        sendDevice?: boolean;
+        isAutoMuted?: boolean;
+    }): Promise<number>;
     canMute(): boolean;
-    unmute(sendAction?: boolean, sequence?: number): Promise<void>;
+    unmute(args: {
+        sendDevice?: boolean;
+    }): Promise<void>;
     getCollection(): MuteCollection;
 }
 export {};

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

@@ -0,0 +1,50 @@
+/*!
+ * 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.
+ */
+import { CartCollection } from '../collections';
+import { PinInChatCollection } from '../collections/PinInChatCollection';
+import { MsgKey, Wid } from '../misc';
+import { Model, ModelOptions, ModelPropertiesContructor, ModelProxy } from './Model';
+interface Props {
+    msgKey: MsgKey;
+    parentMsgKey: MsgKey;
+    senderTimestampMs: number;
+    t: number;
+    sender: Wid;
+    chatId: Wid;
+    pinType: number;
+    pinExpiryDuration: number;
+    id: MsgKey;
+    read: boolean;
+}
+interface Session {
+}
+interface Derived {
+}
+/**
+ * @whatsapp WAWebPinInChatModel >= 2.3000.1012170943
+ */
+export declare interface PinInChatModel extends ModelProxy<Props, Session, Derived> {
+}
+/**
+ * @whatsapp WAWebPinInChatModel >= 2.3000.1012170943
+ */
+export declare class PinInChatModel extends Model<CartCollection> {
+    constructor(proterties?: ModelPropertiesContructor<PinInChatModel>, options?: ModelOptions);
+    deleteByParentMessageKey(): void;
+    getByMsgKey(): CartCollection;
+    getByParentMsgKey(): PinInChatCollection;
+}
+export {};

package/dist/whatsapp/stores.d.ts

@@ -125,3 +125,4 @@ export declare const StickerPackStore: collections.StickerPackCollection;
  * @whatsapp 545068 >= 2.2222.8
  */
 export declare const StickerSearchStore: collections.StickerSearchCollection;
+export declare const PinInChatStore: collections.PinInChatCollection;