@wppconnect/wa-js 3.0.1 → 3.1.0

package/CHANGELOG.md

@@ -1,9 +1,9 @@
-## 3.0.1 (2024-03-25)
+# 3.1.0 (2024-03-28)
 
 
-### Bug Fixes
+### Reverts
 
-* Fixed isOfficialClient check ([#1769](https://github.com/wppconnect-team/wa-js/issues/1769)) ([88f1f0e](https://github.com/wppconnect-team/wa-js/commit/88f1f0e6daf18b0492ceffb6274adef02323dc35))
+* Added template to changelog ([9ebf70b](https://github.com/wppconnect-team/wa-js/commit/9ebf70b6defd370eba39cc5786bcc49df6cb5b2a))
 
 
 

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

@@ -75,6 +75,7 @@ export * from './handleSingleMsg';
 export * from './initializeAltDeviceLinking';
 export * from './isAnimatedWebp';
 export * from './isAuthenticated';
+export * from './isLegitErrorStack';
 export * from './isRegistered';
 export * from './isUnreadTypeMsg';
 export * from './joinGroupViaInvite';
@@ -107,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/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/misc/IsOfficialClient.d.ts

@@ -17,6 +17,5 @@
  * @whatsapp >= 2.3000.x
  */
 export declare namespace IsOfficialClient {
-    function isLegitErrorStack(): boolean;
     let isOfficialClient: boolean;
 }

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;