@wppconnect/wa-js 2.14.1 → 2.15.1

package/CHANGELOG.md

@@ -1,5 +1 @@
-## 2.14.1 (2022-11-01)
-
-### Bug Fixes
-
-- Fixed WPP.chat.starMessage function (fix [#729](https://github.com/wppconnect-team/wa-js/issues/729)) ([bfa6969](https://github.com/wppconnect-team/wa-js/commit/bfa69697e8adbc8e2da82b4a9984d46daf01d79f))
+## 2.15.1 (2022-11-08)

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

@@ -0,0 +1,33 @@
+/*!
+ * 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 { MsgKey, Wid } from '../../whatsapp';
+import { RawMessage } from '..';
+export interface ForwardMessagesOptions {
+    displayCaptionText?: boolean;
+    multicast?: boolean;
+}
+/**
+ * Forward messages to a chat
+ *
+ * @example
+ * ```javascript
+ * // Forward messages
+ * WPP.chat.forwardMessage('[number]@c.us', 'true_[number]@c.us_ABCDEF');
+ * ```
+ * @category Message
+ * @return  {any} Any
+ */
+export declare function forwardMessage(toChatId: string | Wid, msgId: string | MsgKey, options?: ForwardMessagesOptions): Promise<RawMessage[]>;

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

@@ -0,0 +1,60 @@
+/*!
+ * 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 { MsgKey, Wid } from '../../whatsapp';
+import { ACK } from '../../whatsapp/enums';
+export interface ParticipantStatusACK {
+    id: string;
+    wid: Wid;
+    deliveredAt?: number;
+    readAt?: number;
+    playedAt?: number;
+}
+/**
+ * Get message ACK from a message
+ *
+ * @example
+ * ```javascript
+ * // Get message ACK
+ * const ackInfo = await WPP.chat.getMessageACK('true_[number]@c.us_ABCDEF');
+ *
+ * console.log(ackInfo.deliveryRemaining); // Delivery Remaining
+ * console.log(ackInfo.readRemaining); // Read Remaining
+ * console.log(ackInfo.playedRemaining); // PlayedRemaining, for audio(ptt) only
+ *
+ * console.log(ackInfo.participants[0].deliveredAt); // Delivered At, in timestamp format
+ * console.log(ackInfo.participants[0].readAt); // Read At, in timestamp format
+ * console.log(ackInfo.participants[0].playedAt); // Played At, in timestamp format, for audio(ptt) only
+ *
+ * //To get only how was received
+ * const received = ackInfo.participants.filter(p => p.deliveredAt || p.readAt || p.playedAt);
+ *
+ * //To get only how was read
+ * const read = ackInfo.participants.filter(p => p.readAt || p.playedAt);
+ *
+ * //To get only how was played
+ * const played = ackInfo.participants.filter(p => p.playedAt);
+ * ```
+ * @category Message
+ * @return  {any} Any
+ */
+export declare function getMessageACK(msgId: string | MsgKey): Promise<{
+    ack: ACK;
+    fromMe: boolean;
+    deliveryRemaining: number;
+    readRemaining: number;
+    playedRemaining: number;
+    participants: ParticipantStatusACK[];
+}>;

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

@@ -22,9 +22,11 @@ export { delete } from './delete';
 export { deleteMessage, DeleteMessageReturn } from './deleteMessage';
 export { downloadMedia } from './downloadMedia';
 export { find } from './find';
+export { forwardMessage, ForwardMessagesOptions } from './forwardMessage';
 export { generateMessageID } from './generateMessageID';
 export { get } from './get';
 export { getLastSeen } from './getLastSeen';
+export { getMessageACK } from './getMessageACK';
 export { getMessageById } from './getMessageById';
 export { getMessages, GetMessagesOptions } from './getMessages';
 export { getPlatformFromMessage } from './getPlatformFromMessage';

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

@@ -19,7 +19,7 @@ import { Wid } from '../../whatsapp';
  *
  * @example
  * ```javascript
- * const url = await WPP.contact.getProfilePicture('[number]@c.us');
+ * const url = await WPP.contact.getProfilePictureUrl('[number]@c.us');
  * ```
  *
  * @category Chat

package/dist/{whatsapp/functions/getOrGenerate.d.ts → util/blobToArrayBuffer.d.ts}

@@ -13,9 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-/** @whatsapp 98250
- * @whatsapp 16413 >= 2.2204.13
- * @whatsapp 66333 >= 2.2218.4
- * @whatsapp 266333 >= 2.2222.8
- */
-export declare function getOrGenerate(): string;
+export declare function blobToArrayBuffer(blob: Blob): Promise<ArrayBuffer>;

package/dist/util/index.d.ts

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export * from './blobToArrayBuffer';
 export * from './blobToBase64';
 export * from './convertToFile';
 export * from './createWid';

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

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { ChatModel } from '../models';
+import { ChatModel, MsgModel } from '../models';
 import { BaseCollection } from './BaseCollection';
 /** @whatsapp 69951
  * @whatsapp 669951 >= 2.2222.8
@@ -31,5 +31,5 @@ export declare class ChatCollection extends BaseCollection<ChatModel> {
     getKeysForResyncMsgs(): any;
     resyncMessages(): any;
     unstarAllMessages(e?: any, t?: any): any;
-    forwardMessagesToChats(e?: any, t?: any): any;
+    forwardMessagesToChats(msgs: MsgModel[], chats: ChatModel[], displayCaptionText?: boolean): any;
 }

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

@@ -14,11 +14,12 @@
  * limitations under the License.
  */
 import { MsgInfoModel } from '../models';
-import { Collection } from './Collection';
-/** @whatsapp 17972
+import { BaseCollection } from './BaseCollection';
+/**
  * @whatsapp 617972 >= 2.2222.8
+ * @whatsapp 739245 >= 2.2242.6
  */
-export declare class MsgInfoCollection extends Collection<MsgInfoModel> {
+export declare class MsgInfoCollection extends BaseCollection<MsgInfoModel> {
     static model: MsgInfoModel;
     static staleCollection?: any;
     updateInfo(e?: any, t?: any, r?: any, a?: any, i?: any, n?: any): any;

package/dist/whatsapp/collections/{StarredStickerCollection.d.ts → MsgInfoParticipantCollection.d.ts}

@@ -13,15 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { StickerModel } from '../models';
+import { MsgInfoParticipantModel } from '../models';
 import { Collection } from './Collection';
-/** @whatsapp 16774 */
-export declare class StarredStickerCollection extends Collection<StickerModel> {
-    static model: StickerModel;
-    syncNextPage(): any;
-    sync(e?: any): any;
-    isSynced(): boolean;
-    canLoadMore(): boolean;
-    getRemaining(): any;
+/**
+ * @whatsapp 738482 >= 2.2242.6
+ */
+export declare class MsgInfoParticipantCollection extends Collection<MsgInfoParticipantModel> {
+    static model: MsgInfoParticipantModel;
     static comparator(): any;
 }

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

@@ -15,9 +15,11 @@
  */
 import { ParticipantModel } from '../models';
 import { Collection } from './Collection';
-/** @whatsapp 96091
+/**
+ * @whatsapp 96091
  * @whatsapp 54311 >= 2.2212.8
  * @whatsapp 754311 >= 2.2222.8
+ * @whatsapp 164560 >= 2.2242.6
  */
 export declare class ParticipantCollection extends Collection<ParticipantModel> {
     static model: ParticipantModel;

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

@@ -36,6 +36,7 @@ export * from './LabelItemCollection';
 export * from './LiveLocationCollection';
 export * from './MsgCollection';
 export * from './MsgInfoCollection';
+export * from './MsgInfoParticipantCollection';
 export * from './MuteCollection';
 export * from './OrderCollection';
 export * from './OrderItemCollection';
@@ -52,7 +53,6 @@ export * from './ReactionsSendersCollection';
 export * from './RecentEmojiCollection';
 export * from './RecentStickerCollection';
 export * from './StarredMsgCollection';
-export * from './StarredStickerCollection';
 export * from './StatusCollection';
 export * from './StatusV3Collection';
 export * from './StickerCollection';

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

@@ -31,15 +31,16 @@ export * from './generateVideoThumbsAndDuration';
 export * from './genMinimalLinkPreview';
 export * from './getFanOutList';
 export * from './getGroupSenderKeyList';
-export * from './getOrGenerate';
 export * from './getSearchContext';
 export * from './groupParticipants';
 export * from './handleAck';
+export * from './isAnimatedWebp';
 export * from './isAuthenticated';
 export * from './isRegistered';
 export * from './markSeen';
 export * from './mediaTypeFromProtobuf';
 export * from './msgFindQuery';
+export * from './processRawSticker';
 export * from './products';
 export * from './productVisibilitySet';
 export * from './profilePic';

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

@@ -0,0 +1,19 @@
+/*!
+ * Copyright 2022 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 176819 >= 2.2242.6
+ */
+export declare function isAnimatedWebp(data: ArrayBuffer): boolean;

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

@@ -0,0 +1,26 @@
+/*!
+ * Copyright 2022 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 { OpaqueData } from '../misc';
+/**
+ * @whatsapp 232294 >= 2.2242.6
+ */
+export declare function processRawSticker(data: OpaqueData): Promise<{
+    type: 'sticker';
+    mediaBlob: OpaqueData;
+    mimetype: string;
+    fullWidth: number;
+    fullHeight: number;
+}>;

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

@@ -154,7 +154,7 @@ export declare class ChatModel extends ModelChatBase {
     getWebcChatType(): any;
     deregisterExpiredViewOnceBulkMessages(e?: any): any;
     sendGroupInviteMessage(e?: any, t?: any, r?: any, a?: any, i?: any, n?: any): any;
-    forwardMessages(e?: any, t?: boolean): any;
+    forwardMessages(msgs: MsgModel[], multicast?: any, displayCaptionText?: boolean): any;
     updateReadOnly(): any;
     updateIsAnnounceGrpRestrict(): any;
     sortMsgs(e?: any): any;

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

@@ -13,15 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { MsgInfoCollection } from '../collections';
+import { MsgInfoCollection, MsgInfoParticipantCollection } from '../collections';
 import { MsgKey } from '../misc';
 import { Model, ModelOptions, ModelPropertiesContructor, ModelProxy } from './Model';
 interface Props {
     id: MsgKey;
     usePlayReceipt?: any;
-    playedRemaining?: any;
-    readRemaining?: any;
-    deliveryRemaining?: any;
+    playedRemaining: number;
+    readRemaining: number;
+    deliveryRemaining: number;
     deliveryPrivacyMode?: any;
 }
 interface Session {
@@ -30,16 +30,22 @@ interface Session {
 interface Derived {
     settled?: any;
 }
-/** @whatsapp 54311
+/**
+ * @whatsapp 54311
  * @whatsapp 754311 >= 2.2222.8
+ * @whatsapp 738482 >= 2.2242.6
  */
 export declare interface MsgInfoModel extends ModelProxy<Props, Session, Derived> {
 }
-/** @whatsapp 54311
- * @whatsapp 754311 >= 2.2222.8
+/**
+ * @whatsapp 54311
+ * @whatsapp 738482 >= 2.2222.8
  */
 export declare class MsgInfoModel extends Model<MsgInfoCollection> {
     idClass: typeof MsgKey;
+    played: MsgInfoParticipantCollection;
+    read: MsgInfoParticipantCollection;
+    delivery: MsgInfoParticipantCollection;
     constructor(proterties?: ModelPropertiesContructor<MsgInfoModel>, options?: ModelOptions);
     getCollection(): MsgInfoCollection;
 }

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

@@ -0,0 +1,41 @@
+/*!
+ * 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 { MsgInfoCollection } from '../collections';
+import { Wid } from '../misc';
+import { ContactModel } from './ContactModel';
+import { Model, ModelOptions, ModelPropertiesContructor, ModelProxy } from './Model';
+interface Props {
+    id: Wid;
+    t: number;
+}
+interface Session {
+    contact: ContactModel;
+}
+interface Derived {
+}
+/**
+ * @whatsapp 738482 >= 2.2242.6
+ */
+export declare interface MsgInfoParticipantModel extends ModelProxy<Props, Session, Derived> {
+}
+/**
+ * @whatsapp 738482 >= 2.2242.6
+ */
+export declare class MsgInfoParticipantModel extends Model<MsgInfoCollection> {
+    constructor(proterties?: ModelPropertiesContructor<MsgInfoParticipantModel>, options?: ModelOptions);
+    getCollection(): MsgInfoCollection;
+}
+export {};

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

@@ -15,6 +15,7 @@
  */
 import { TextFontStyle } from '../../enums';
 import { ButtonCollection, MsgCollection, TemplateButtonCollection } from '../collections';
+import { ACK } from '../enums';
 import { MediaObject, MsgKey, Wid } from '../misc';
 import { ChatModel, MediaDataModel } from '.';
 import { Model, ModelOptions, ModelPropertiesContructor, ModelProxy } from './Model';
@@ -33,7 +34,7 @@ interface Props {
     /**
      * See {@link Constants}
      */
-    ack?: number;
+    ack?: ACK;
     invis?: any;
     isNewMsg: boolean;
     star?: any;

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

@@ -40,6 +40,7 @@ export * from './Model';
 export * from './ModelChatBase';
 export * from './MsgButtonReplyMsgModel';
 export * from './MsgInfoModel';
+export * from './MsgInfoParticipantModel';
 export * from './MsgModel';
 export * from './MuteModel';
 export * from './OrderItemModel';

package/dist/whatsapp/stores.d.ts

@@ -107,8 +107,6 @@ export declare const RecentStickerStore: collections.RecentStickerCollection;
  * @whatsapp 719011 >= 2.2222.8
  */
 export declare const StarredMsgStore: collections.StarredMsgCollection;
-/** @whatsapp 16774 */
-export declare const StarredStickerStore: collections.StarredStickerCollection;
 /** @whatsapp 46133 */
 export declare const StatusStore: collections.StatusCollection;
 /** @whatsapp 59387