@queenanya/baileys 6.7.0 → 6.8.0

package/lib/Types/Message.d.ts

@@ -1,261 +1,261 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-import { AxiosRequestConfig } from 'axios';
-import type { Logger } from 'pino';
-import type { Readable } from 'stream';
-import type { URL } from 'url';
-import { proto } from '../../WAProto';
-import { MEDIA_HKDF_KEY_MAPPING } from '../Defaults';
-import type { GroupMetadata } from './GroupMetadata';
-import { CacheStore } from './Socket';
-export { proto as WAProto };
-export type WAMessage = proto.IWebMessageInfo;
-export type WAMessageContent = proto.IMessage;
-export type WAContactMessage = proto.Message.IContactMessage;
-export type WAContactsArrayMessage = proto.Message.IContactsArrayMessage;
-export type WAMessageKey = proto.IMessageKey;
-export type WATextMessage = proto.Message.IExtendedTextMessage;
-export type WAContextInfo = proto.IContextInfo;
-export type WALocationMessage = proto.Message.ILocationMessage;
-export type WAGenericMediaMessage = proto.Message.IVideoMessage | proto.Message.IImageMessage | proto.Message.IAudioMessage | proto.Message.IDocumentMessage | proto.Message.IStickerMessage;
-export import WAMessageStubType = proto.WebMessageInfo.StubType;
-export import WAMessageStatus = proto.WebMessageInfo.Status;
-export type WAMediaUpload = Buffer | {
-    url: URL | string;
-} | {
-    stream: Readable;
-};
-/** Set of message types that are supported by the library */
-export type MessageType = keyof proto.Message;
-export type DownloadableMessage = {
-    mediaKey?: Uint8Array | null;
-    directPath?: string | null;
-    url?: string | null;
-};
-export type MessageReceiptType = 'read' | 'read-self' | 'hist_sync' | 'peer_msg' | 'sender' | 'inactive' | 'played' | undefined;
-export type MediaConnInfo = {
-    auth: string;
-    ttl: number;
-    hosts: {
-        hostname: string;
-        maxContentLengthBytes: number;
-    }[];
-    fetchDate: Date;
-};
-export interface WAUrlInfo {
-    'canonical-url': string;
-    'matched-text': string;
-    title: string;
-    description?: string;
-    jpegThumbnail?: Buffer;
-    highQualityThumbnail?: proto.Message.IImageMessage;
-    originalThumbnailUrl?: string;
-}
-type Mentionable = {
-    /** list of jids that are mentioned in the accompanying text */
-    mentions?: string[];
-};
-type Contextable = {
-    /** add contextInfo to the message */
-    contextInfo?: proto.IContextInfo;
-};
-type ViewOnce = {
-    viewOnce?: boolean;
-};
-type Buttonable = {
-    /** add buttons to the message  */
-    buttons?: proto.Message.ButtonsMessage.IButton[];
-};
-type Templatable = {
-    /** add buttons to the message (conflicts with normal buttons)*/
-    templateButtons?: proto.IHydratedTemplateButton[];
-    footer?: string;
-};
-type Editable = {
-    edit?: WAMessageKey;
-};
-type Listable = {
-    /** Sections of the List */
-    sections?: proto.Message.ListMessage.ISection[];
-    /** Title of a List Message only */
-    title?: string;
-    /** Text of the bnutton on the list (required) */
-    buttonText?: string;
-};
-type WithDimensions = {
-    width?: number;
-    height?: number;
-};
-export type PollMessageOptions = {
-    name: string;
-    selectableCount?: number;
-    values: string[];
-    /** 32 byte message secret to encrypt poll selections */
-    messageSecret?: Uint8Array;
-};
-type SharePhoneNumber = {
-    sharePhoneNumber: boolean;
-};
-type RequestPhoneNumber = {
-    requestPhoneNumber: boolean;
-};
-export type MediaType = keyof typeof MEDIA_HKDF_KEY_MAPPING;
-export type AnyMediaMessageContent = (({
-    image: WAMediaUpload;
-    caption?: string;
-    jpegThumbnail?: string;
-} & Mentionable & Contextable & Buttonable & Templatable & WithDimensions) | ({
-    video: WAMediaUpload;
-    caption?: string;
-    gifPlayback?: boolean;
-    jpegThumbnail?: string;
-} & Mentionable & Contextable & Buttonable & Templatable & WithDimensions) | {
-    audio: WAMediaUpload;
-    /** if set to true, will send as a `voice note` */
-    ptt?: boolean;
-    /** optionally tell the duration of the audio */
-    seconds?: number;
-} | ({
-    sticker: WAMediaUpload;
-    isAnimated?: boolean;
-} & WithDimensions) | ({
-    document: WAMediaUpload;
-    mimetype: string;
-    fileName?: string;
-    caption?: string;
-} & Contextable & Buttonable & Templatable)) & {
-    mimetype?: string;
-} & Editable;
-export type ButtonReplyInfo = {
-    displayText: string;
-    id: string;
-    index: number;
-};
-export type WASendableProduct = Omit<proto.Message.ProductMessage.IProductSnapshot, 'productImage'> & {
-    productImage: WAMediaUpload;
-};
-export type AnyRegularMessageContent = (({
-    text: string;
-    linkPreview?: WAUrlInfo | null;
-} & Mentionable & Contextable & Buttonable & Templatable & Listable & Editable) | AnyMediaMessageContent | ({
-    poll: PollMessageOptions;
-} & Mentionable & Contextable & Buttonable & Templatable & Editable) | {
-    contacts: {
-        displayName?: string;
-        contacts: proto.Message.IContactMessage[];
-    };
-} | {
-    location: WALocationMessage;
-} | {
-    react: proto.Message.IReactionMessage;
-} | {
-    buttonReply: ButtonReplyInfo;
-    type: 'template' | 'plain';
-} | {
-    listReply: Omit<proto.Message.IListResponseMessage, 'contextInfo'>;
-} | {
-    product: WASendableProduct;
-    businessOwnerJid?: string;
-    body?: string;
-    footer?: string;
-} | SharePhoneNumber | RequestPhoneNumber) & ViewOnce;
-export type AnyMessageContent = AnyRegularMessageContent | {
-    forward: WAMessage;
-    force?: boolean;
-} | {
-    /** Delete your message or anyone's message in a group (admin required) */
-    delete: WAMessageKey;
-} | {
-    disappearingMessagesInChat: boolean | number;
-};
-export type GroupMetadataParticipants = Pick<GroupMetadata, 'participants'>;
-type MinimalRelayOptions = {
-    /** override the message ID with a custom provided string */
-    messageId?: string;
-    /** cached group metadata, use to prevent redundant requests to WA & speed up msg sending */
-    cachedGroupMetadata?: (jid: string) => Promise<GroupMetadataParticipants | undefined>;
-};
-export type MessageRelayOptions = MinimalRelayOptions & {
-    /** only send to a specific participant; used when a message decryption fails for a single user */
-    participant?: {
-        jid: string;
-        count: number;
-    };
-    /** additional attributes to add to the WA binary node */
-    additionalAttributes?: {
-        [_: string]: string;
-    };
-    /** should we use the devices cache, or fetch afresh from the server; default assumed to be "true" */
-    useUserDevicesCache?: boolean;
-    /** jid list of participants for status@broadcast */
-    statusJidList?: string[];
-};
-export type MiscMessageGenerationOptions = MinimalRelayOptions & {
-    /** optional, if you want to manually set the timestamp of the message */
-    timestamp?: Date;
-    /** the message you want to quote */
-    quoted?: WAMessage;
-    /** disappearing messages settings */
-    ephemeralExpiration?: number | string;
-    /** timeout for media upload to WA server */
-    mediaUploadTimeoutMs?: number;
-    /** jid list of participants for status@broadcast */
-    statusJidList?: string[];
-    /** backgroundcolor for status */
-    backgroundColor?: string;
-    /** font type for status */
-    font?: number;
-};
-export type MessageGenerationOptionsFromContent = MiscMessageGenerationOptions & {
-    userJid: string;
-};
-export type WAMediaUploadFunction = (readStream: Readable, opts: {
-    fileEncSha256B64: string;
-    mediaType: MediaType;
-    timeoutMs?: number;
-}) => Promise<{
-    mediaUrl: string;
-    directPath: string;
-}>;
-export type MediaGenerationOptions = {
-    logger?: Logger;
-    mediaTypeOverride?: MediaType;
-    upload: WAMediaUploadFunction;
-    /** cache media so it does not have to be uploaded again */
-    mediaCache?: CacheStore;
-    mediaUploadTimeoutMs?: number;
-    options?: AxiosRequestConfig;
-    backgroundColor?: string;
-    font?: number;
-};
-export type MessageContentGenerationOptions = MediaGenerationOptions & {
-    getUrlInfo?: (text: string) => Promise<WAUrlInfo | undefined>;
-};
-export type MessageGenerationOptions = MessageContentGenerationOptions & MessageGenerationOptionsFromContent;
-/**
- * Type of message upsert
- * 1. notify => notify the user, this message was just received
- * 2. append => append the message to the chat history, no notification required
- */
-export type MessageUpsertType = 'append' | 'notify';
-export type MessageUserReceipt = proto.IUserReceipt;
-export type WAMessageUpdate = {
-    update: Partial<WAMessage>;
-    key: proto.IMessageKey;
-};
-export type WAMessageCursor = {
-    before: WAMessageKey | undefined;
-} | {
-    after: WAMessageKey | undefined;
-};
-export type MessageUserReceiptUpdate = {
-    key: proto.IMessageKey;
-    receipt: MessageUserReceipt;
-};
-export type MediaDecryptionKeyInfo = {
-    iv: Buffer;
-    cipherKey: Buffer;
-    macKey?: Buffer;
-};
-export type MinimalMessage = Pick<proto.IWebMessageInfo, 'key' | 'messageTimestamp'>;
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import { AxiosRequestConfig } from 'axios';
+import type { Logger } from 'pino';
+import type { Readable } from 'stream';
+import type { URL } from 'url';
+import { proto } from '../../WAProto';
+import { MEDIA_HKDF_KEY_MAPPING } from '../Defaults';
+import type { GroupMetadata } from './GroupMetadata';
+import { CacheStore } from './Socket';
+export { proto as WAProto };
+export type WAMessage = proto.IWebMessageInfo;
+export type WAMessageContent = proto.IMessage;
+export type WAContactMessage = proto.Message.IContactMessage;
+export type WAContactsArrayMessage = proto.Message.IContactsArrayMessage;
+export type WAMessageKey = proto.IMessageKey;
+export type WATextMessage = proto.Message.IExtendedTextMessage;
+export type WAContextInfo = proto.IContextInfo;
+export type WALocationMessage = proto.Message.ILocationMessage;
+export type WAGenericMediaMessage = proto.Message.IVideoMessage | proto.Message.IImageMessage | proto.Message.IAudioMessage | proto.Message.IDocumentMessage | proto.Message.IStickerMessage;
+export import WAMessageStubType = proto.WebMessageInfo.StubType;
+export import WAMessageStatus = proto.WebMessageInfo.Status;
+export type WAMediaUpload = Buffer | {
+    url: URL | string;
+} | {
+    stream: Readable;
+};
+/** Set of message types that are supported by the library */
+export type MessageType = keyof proto.Message;
+export type DownloadableMessage = {
+    mediaKey?: Uint8Array | null;
+    directPath?: string | null;
+    url?: string | null;
+};
+export type MessageReceiptType = 'read' | 'read-self' | 'hist_sync' | 'peer_msg' | 'sender' | 'inactive' | 'played' | undefined;
+export type MediaConnInfo = {
+    auth: string;
+    ttl: number;
+    hosts: {
+        hostname: string;
+        maxContentLengthBytes: number;
+    }[];
+    fetchDate: Date;
+};
+export interface WAUrlInfo {
+    'canonical-url': string;
+    'matched-text': string;
+    title: string;
+    description?: string;
+    jpegThumbnail?: Buffer;
+    highQualityThumbnail?: proto.Message.IImageMessage;
+    originalThumbnailUrl?: string;
+}
+type Mentionable = {
+    /** list of jids that are mentioned in the accompanying text */
+    mentions?: string[];
+};
+type Contextable = {
+    /** add contextInfo to the message */
+    contextInfo?: proto.IContextInfo;
+};
+type ViewOnce = {
+    viewOnce?: boolean;
+};
+type Buttonable = {
+    /** add buttons to the message  */
+    buttons?: proto.Message.ButtonsMessage.IButton[];
+};
+type Templatable = {
+    /** add buttons to the message (conflicts with normal buttons)*/
+    templateButtons?: proto.IHydratedTemplateButton[];
+    footer?: string;
+};
+type Editable = {
+    edit?: WAMessageKey;
+};
+type Listable = {
+    /** Sections of the List */
+    sections?: proto.Message.ListMessage.ISection[];
+    /** Title of a List Message only */
+    title?: string;
+    /** Text of the bnutton on the list (required) */
+    buttonText?: string;
+};
+type WithDimensions = {
+    width?: number;
+    height?: number;
+};
+export type PollMessageOptions = {
+    name: string;
+    selectableCount?: number;
+    values: string[];
+    /** 32 byte message secret to encrypt poll selections */
+    messageSecret?: Uint8Array;
+};
+type SharePhoneNumber = {
+    sharePhoneNumber: boolean;
+};
+type RequestPhoneNumber = {
+    requestPhoneNumber: boolean;
+};
+export type MediaType = keyof typeof MEDIA_HKDF_KEY_MAPPING;
+export type AnyMediaMessageContent = (({
+    image: WAMediaUpload;
+    caption?: string;
+    jpegThumbnail?: string;
+} & Mentionable & Contextable & Buttonable & Templatable & WithDimensions) | ({
+    video: WAMediaUpload;
+    caption?: string;
+    gifPlayback?: boolean;
+    jpegThumbnail?: string;
+} & Mentionable & Contextable & Buttonable & Templatable & WithDimensions) | {
+    audio: WAMediaUpload;
+    /** if set to true, will send as a `voice note` */
+    ptt?: boolean;
+    /** optionally tell the duration of the audio */
+    seconds?: number;
+} | ({
+    sticker: WAMediaUpload;
+    isAnimated?: boolean;
+} & WithDimensions) | ({
+    document: WAMediaUpload;
+    mimetype: string;
+    fileName?: string;
+    caption?: string;
+} & Contextable & Buttonable & Templatable)) & {
+    mimetype?: string;
+} & Editable;
+export type ButtonReplyInfo = {
+    displayText: string;
+    id: string;
+    index: number;
+};
+export type WASendableProduct = Omit<proto.Message.ProductMessage.IProductSnapshot, 'productImage'> & {
+    productImage: WAMediaUpload;
+};
+export type AnyRegularMessageContent = (({
+    text: string;
+    linkPreview?: WAUrlInfo | null;
+} & Mentionable & Contextable & Buttonable & Templatable & Listable & Editable) | AnyMediaMessageContent | ({
+    poll: PollMessageOptions;
+} & Mentionable & Contextable & Buttonable & Templatable & Editable) | {
+    contacts: {
+        displayName?: string;
+        contacts: proto.Message.IContactMessage[];
+    };
+} | {
+    location: WALocationMessage;
+} | {
+    react: proto.Message.IReactionMessage;
+} | {
+    buttonReply: ButtonReplyInfo;
+    type: 'template' | 'plain';
+} | {
+    listReply: Omit<proto.Message.IListResponseMessage, 'contextInfo'>;
+} | {
+    product: WASendableProduct;
+    businessOwnerJid?: string;
+    body?: string;
+    footer?: string;
+} | SharePhoneNumber | RequestPhoneNumber) & ViewOnce;
+export type AnyMessageContent = AnyRegularMessageContent | {
+    forward: WAMessage;
+    force?: boolean;
+} | {
+    /** Delete your message or anyone's message in a group (admin required) */
+    delete: WAMessageKey;
+} | {
+    disappearingMessagesInChat: boolean | number;
+};
+export type GroupMetadataParticipants = Pick<GroupMetadata, 'participants'>;
+type MinimalRelayOptions = {
+    /** override the message ID with a custom provided string */
+    messageId?: string;
+    /** cached group metadata, use to prevent redundant requests to WA & speed up msg sending */
+    cachedGroupMetadata?: (jid: string) => Promise<GroupMetadataParticipants | undefined>;
+};
+export type MessageRelayOptions = MinimalRelayOptions & {
+    /** only send to a specific participant; used when a message decryption fails for a single user */
+    participant?: {
+        jid: string;
+        count: number;
+    };
+    /** additional attributes to add to the WA binary node */
+    additionalAttributes?: {
+        [_: string]: string;
+    };
+    /** should we use the devices cache, or fetch afresh from the server; default assumed to be "true" */
+    useUserDevicesCache?: boolean;
+    /** jid list of participants for status@broadcast */
+    statusJidList?: string[];
+};
+export type MiscMessageGenerationOptions = MinimalRelayOptions & {
+    /** optional, if you want to manually set the timestamp of the message */
+    timestamp?: Date;
+    /** the message you want to quote */
+    quoted?: WAMessage;
+    /** disappearing messages settings */
+    ephemeralExpiration?: number | string;
+    /** timeout for media upload to WA server */
+    mediaUploadTimeoutMs?: number;
+    /** jid list of participants for status@broadcast */
+    statusJidList?: string[];
+    /** backgroundcolor for status */
+    backgroundColor?: string;
+    /** font type for status */
+    font?: number;
+};
+export type MessageGenerationOptionsFromContent = MiscMessageGenerationOptions & {
+    userJid: string;
+};
+export type WAMediaUploadFunction = (readStream: Readable, opts: {
+    fileEncSha256B64: string;
+    mediaType: MediaType;
+    timeoutMs?: number;
+}) => Promise<{
+    mediaUrl: string;
+    directPath: string;
+}>;
+export type MediaGenerationOptions = {
+    logger?: Logger;
+    mediaTypeOverride?: MediaType;
+    upload: WAMediaUploadFunction;
+    /** cache media so it does not have to be uploaded again */
+    mediaCache?: CacheStore;
+    mediaUploadTimeoutMs?: number;
+    options?: AxiosRequestConfig;
+    backgroundColor?: string;
+    font?: number;
+};
+export type MessageContentGenerationOptions = MediaGenerationOptions & {
+    getUrlInfo?: (text: string) => Promise<WAUrlInfo | undefined>;
+};
+export type MessageGenerationOptions = MessageContentGenerationOptions & MessageGenerationOptionsFromContent;
+/**
+ * Type of message upsert
+ * 1. notify => notify the user, this message was just received
+ * 2. append => append the message to the chat history, no notification required
+ */
+export type MessageUpsertType = 'append' | 'notify';
+export type MessageUserReceipt = proto.IUserReceipt;
+export type WAMessageUpdate = {
+    update: Partial<WAMessage>;
+    key: proto.IMessageKey;
+};
+export type WAMessageCursor = {
+    before: WAMessageKey | undefined;
+} | {
+    after: WAMessageKey | undefined;
+};
+export type MessageUserReceiptUpdate = {
+    key: proto.IMessageKey;
+    receipt: MessageUserReceipt;
+};
+export type MediaDecryptionKeyInfo = {
+    iv: Buffer;
+    cipherKey: Buffer;
+    macKey?: Buffer;
+};
+export type MinimalMessage = Pick<proto.IWebMessageInfo, 'key' | 'messageTimestamp'>;

package/lib/Types/Message.js

@@ -1,9 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WAMessageStatus = exports.WAMessageStubType = exports.WAProto = void 0;
-const WAProto_1 = require("../../WAProto");
-Object.defineProperty(exports, "WAProto", { enumerable: true, get: function () { return WAProto_1.proto; } });
-// eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
-exports.WAMessageStubType = WAProto_1.proto.WebMessageInfo.StubType;
-// eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
-exports.WAMessageStatus = WAProto_1.proto.WebMessageInfo.Status;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WAMessageStatus = exports.WAMessageStubType = exports.WAProto = void 0;
+const WAProto_1 = require("../../WAProto");
+Object.defineProperty(exports, "WAProto", { enumerable: true, get: function () { return WAProto_1.proto; } });
+// eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
+exports.WAMessageStubType = WAProto_1.proto.WebMessageInfo.StubType;
+// eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
+exports.WAMessageStatus = WAProto_1.proto.WebMessageInfo.Status;