amiudmodz 6.1.7 → 6.1.8

package/lib/Utils/messages.d.ts

@@ -4,10 +4,6 @@ import type { AnyMediaMessageContent, AnyMessageContent, MessageContentGeneratio
 import type { ILogger } from './logger.js';
 import { type MediaDownloadOptions } from './messages-media.js';
 type ExtractByKey<T, K extends PropertyKey> = T extends Record<K, any> ? T : never;
-type RequireKey<T, K extends keyof T> = T & {
-    [P in K]-?: Exclude<T[P], null | undefined>;
-};
-type WithKey<T, K extends PropertyKey> = T extends unknown ? (K extends keyof T ? RequireKey<T, K> : never) : never;
 /**
  * Uses a regex to test whether the string contains a URL, and returns the URL if it does.
  * @param text eg. hello https://google.com
@@ -24,39 +20,72 @@ export declare const prepareDisappearingMessageSettingContent: (ephemeralExpirat
  */
 export declare const generateForwardMessageContent: (message: WAMessage, forceForward?: boolean) => proto.IMessage;
 export declare const hasNonNullishProperty: <K extends PropertyKey>(message: AnyMessageContent, key: K) => message is ExtractByKey<AnyMessageContent, K>;
-export declare const hasOptionalProperty: <T, K extends PropertyKey>(obj: T, key: K) => obj is WithKey<T, K>;
-export declare const hasValidAlbumMedia: (message: any) => any;
-export declare const hasValidInteractiveHeader: (message: any) => any;
-export declare const hasValidCarouselHeader: (message: any) => any;
-export declare const generateWAMessageContent: (message: AnyMessageContent, options: MessageContentGenerationOptions) => Promise<proto.IMessage>;
-export declare const generateWAMessageFromContent: (jid: string, message: WAMessageContent, options: MessageGenerationOptionsFromContent) => any;
+export declare const generateWAMessageContent: (message: AnyMessageContent, options: MessageContentGenerationOptions) => Promise<proto.Message>;
+export declare const generateWAMessageFromContent: (jid: string, message: WAMessageContent, options: MessageGenerationOptionsFromContent) => WAMessage;
 export declare const generateWAMessage: (jid: string, content: AnyMessageContent, options: MessageGenerationOptions) => Promise<WAMessage>;
-export declare const getContentType: (content: WAMessageContent | undefined) => keyof proto.IMessage | undefined;
+/** Get the key to access the true type of content */
+export declare const getContentType: (content: proto.IMessage | undefined) => keyof proto.IMessage | undefined;
+/**
+ * Normalizes ephemeral, view once messages to regular message content
+ * Eg. image messages in ephemeral messages, in view once messages etc.
+ * @param content
+ * @returns
+ */
 export declare const normalizeMessageContent: (content: WAMessageContent | null | undefined) => WAMessageContent | undefined;
-export declare const extractMessageContent: (content: WAMessageContent | null | undefined) => WAMessageContent | undefined;
+/**
+ * Extract the true message content from a message
+ * Eg. extracts the inner message from a disappearing message/view once message
+ */
+export declare const extractMessageContent: (content: WAMessageContent | undefined | null) => WAMessageContent | undefined;
+/**
+ * Returns the device predicted by message ID
+ */
 export declare const getDevice: (id: string) => "web" | "unknown" | "android" | "ios" | "desktop";
-export declare const updateMessageWithReceipt: (msg: WAMessage, receipt: MessageUserReceipt) => void;
-export declare const updateMessageWithReaction: (msg: WAMessage, reaction: proto.IReaction) => void;
-export declare const updateMessageWithPollUpdate: (msg: WAMessage, update: any) => void;
-export declare const updateMessageWithEventResponse: (msg: WAMessage, update: any) => void;
-export declare function getAggregateVotesInPollMessage({ message, pollUpdates }: WAMessage, meId?: string): {
+/** Upserts a receipt in the message */
+export declare const updateMessageWithReceipt: (msg: Pick<WAMessage, "userReceipt">, receipt: MessageUserReceipt) => void;
+/** Update the message with a new reaction */
+export declare const updateMessageWithReaction: (msg: Pick<WAMessage, "reactions">, reaction: proto.IReaction) => void;
+/** Update the message with a new poll update */
+export declare const updateMessageWithPollUpdate: (msg: Pick<WAMessage, "pollUpdates">, update: proto.IPollUpdate) => void;
+/** Update the message with a new event response */
+export declare const updateMessageWithEventResponse: (msg: Pick<WAMessage, "eventResponses">, update: proto.IEventResponse) => void;
+type VoteAggregation = {
     name: string;
     voters: string[];
-}[];
-export declare function getAggregateResponsesInEventMessage({ eventResponses }: WAMessage, meId?: string): {
+};
+/**
+ * Aggregates all poll updates in a poll.
+ * @param msg the poll creation message
+ * @param meId your jid
+ * @returns A list of options & their voters
+ */
+export declare function getAggregateVotesInPollMessage({ message, pollUpdates }: Pick<WAMessage, 'pollUpdates' | 'message'>, meId?: string): VoteAggregation[];
+type ResponseAggregation = {
     response: string;
     responders: string[];
-}[];
+};
+/**
+ * Aggregates all event responses in an event message.
+ * @param msg the event creation message
+ * @param meId your jid
+ * @returns A list of response types & their responders
+ */
+export declare function getAggregateResponsesInEventMessage({ eventResponses }: Pick<WAMessage, 'eventResponses'>, meId?: string): ResponseAggregation[];
+/** Given a list of message keys, aggregates them by chat & sender. Useful for sending read receipts in bulk */
 export declare const aggregateMessageKeysNotFromMe: (keys: WAMessageKey[]) => {
     jid: string;
     participant: string | undefined;
     messageIds: string[];
 }[];
-export declare const downloadMediaMessage: <Type extends "buffer" | "stream">(message: WAMessage, type: Type, options: MediaDownloadOptions, ctx?: {
-    logger: ILogger;
+type DownloadMediaMessageContext = {
     reuploadRequest: (msg: WAMessage) => Promise<WAMessage>;
-}) => Promise<Type extends "buffer" ? Buffer<ArrayBufferLike> : Transform>;
-export declare const assertMediaContent: (content: proto.IMessage | null | undefined) => proto.Message.IDocumentMessage | proto.Message.IImageMessage | proto.Message.IVideoMessage | proto.Message.IAudioMessage | proto.Message.IStickerMessage;
-export declare const shouldIncludeBizBinaryNode: (message: proto.IMessage) => boolean;
+    logger: ILogger;
+};
+/**
+ * Downloads the given message. Throws an error if it's not a media message
+ */
+export declare const downloadMediaMessage: <Type extends "buffer" | "stream">(message: WAMessage, type: Type, options: MediaDownloadOptions, ctx?: DownloadMediaMessageContext) => Promise<Type extends "buffer" ? Buffer<ArrayBufferLike> : Transform>;
+/** Checks whether the given message is a media message; if it is returns the inner content */
+export declare const assertMediaContent: (content: proto.IMessage | null | undefined) => proto.Message.IVideoMessage | proto.Message.IImageMessage | proto.Message.IAudioMessage | proto.Message.IDocumentMessage | proto.Message.IStickerMessage;
 export {};
 //# sourceMappingURL=messages.d.ts.map

package/lib/Utils/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/Utils/messages.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,QAAQ,CAAA;AAEvC,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAA;AAW9C,OAAO,KAAK,EACX,sBAAsB,EACtB,iBAAiB,EAEjB,+BAA+B,EAC/B,wBAAwB,EACxB,mCAAmC,EACnC,kBAAkB,EAGlB,SAAS,EACT,gBAAgB,EAChB,YAAY,EAEZ,MAAM,UAAU,CAAA;AAcjB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AACvC,OAAO,EAWN,KAAK,oBAAoB,EACzB,MAAM,kBAAkB,CAAA;AAIzB,KAAK,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,IAAI,CAAC,SAAS,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;AAClF,KAAK,UAAU,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,GAAG;KAC1C,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;CAC3C,CAAA;AAED,KAAK,OAAO,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,IAAI,CAAC,SAAS,OAAO,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,KAAK,CAAA;AAsCnH;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAAI,MAAM,MAAM,uBAA+B,CAAA;AAE9E,eAAO,MAAM,6BAA6B,GACzC,MAAM,MAAM,EACZ,YAAY,wBAAwB,CAAC,YAAY,CAAC,EAClD,QAAQ,wBAAwB,CAAC,QAAQ,CAAC,sDAY1C,CAAA;AAiBD,eAAO,MAAM,qBAAqB,GACjC,SAAS,sBAAsB,EAC/B,SAAS,+BAA+B,2BAqPxC,CAAA;AAED,eAAO,MAAM,wCAAwC,GAAI,sBAAsB,MAAM,kBAapF,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,6BAA6B,GAAI,SAAS,SAAS,EAAE,eAAe,OAAO,mBA6BvF,CAAA;AAED,eAAO,MAAM,qBAAqB,GAAI,CAAC,SAAS,WAAW,EAC1D,SAAS,iBAAiB,EAC1B,KAAK,CAAC,KACJ,OAAO,IAAI,YAAY,CAAC,iBAAiB,EAAE,CAAC,CAQ9C,CAAA;AAED,eAAO,MAAM,mBAAmB,GAAI,CAAC,EAAE,CAAC,SAAS,WAAW,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,KAAG,GAAG,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,CAEjG,CAAA;AAwWD,eAAO,MAAM,kBAAkB,GAAI,SAAS,GAAG,QAE9C,CAAA;AAED,eAAO,MAAM,yBAAyB,GAAI,SAAS,GAAG,QAQrD,CAAA;AAED,eAAO,MAAM,sBAAsB,GAAI,SAAS,GAAG,QAElD,CAAA;AAUD,eAAO,MAAM,wBAAwB,GACpC,SAAS,iBAAiB,EAC1B,SAAS,+BAA+B,KACtC,OAAO,CAAC,KAAK,CAAC,QAAQ,CA2tBxB,CAAA;AAED,eAAO,MAAM,4BAA4B,GACxC,KAAK,MAAM,EACX,SAAS,gBAAgB,EACzB,SAAS,mCAAmC,KA+Ea,GACzD,CAAA;AAED,eAAO,MAAM,iBAAiB,GAC7B,KAAK,MAAM,EACX,SAAS,iBAAiB,EAC1B,SAAS,wBAAwB,KAC/B,OAAO,CAAC,SAAS,CAOnB,CAAA;AAED,eAAO,MAAM,cAAc,GAAI,SAAS,gBAAgB,GAAG,SAAS,qCAMnE,CAAA;AAED,eAAO,MAAM,uBAAuB,GAAI,SAAS,gBAAgB,GAAG,IAAI,GAAG,SAAS,KAAG,gBAAgB,GAAG,SA+CzG,CAAA;AAED,eAAO,MAAM,qBAAqB,GAAI,SAAS,gBAAgB,GAAG,IAAI,GAAG,SAAS,KAAG,gBAAgB,GAAG,SAmCvG,CAAA;AAED,eAAO,MAAM,SAAS,GAAI,IAAI,MAAM,sDASpB,CAAA;AAEhB,eAAO,MAAM,wBAAwB,GAAI,KAAK,SAAS,EAAE,SAAS,kBAAkB,SAQnF,CAAA;AAED,eAAO,MAAM,yBAAyB,GAAI,KAAK,SAAS,EAAE,UAAU,KAAK,CAAC,SAAS,SAMlF,CAAA;AAED,eAAO,MAAM,2BAA2B,GAAI,KAAK,SAAS,EAAE,QAAQ,GAAG,SAOtE,CAAA;AAED,eAAO,MAAM,8BAA8B,GAAI,KAAK,SAAS,EAAE,QAAQ,GAAG,SAKzE,CAAA;AAED,wBAAgB,8BAA8B,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,MAAM;UAa7D,MAAM;YAAU,MAAM,EAAE;IAwB3D;AAED,wBAAgB,mCAAmC,CAAC,EAAE,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,MAAM;cAEvC,MAAM;gBAAc,MAAM,EAAE;IAgBpF;AAED,eAAO,MAAM,6BAA6B,GAAI,MAAM,YAAY,EAAE;SACzB,MAAM;iBAAe,MAAM,GAAG,SAAS;gBAAc,MAAM,EAAE;GAiBrG,CAAA;AAID,eAAO,MAAM,oBAAoB,GAAU,IAAI,SAAS,QAAQ,GAAG,QAAQ,EAC1E,SAAS,SAAS,EAClB,MAAM,IAAI,EACV,SAAS,oBAAoB,EAC7B,MAAM;IACL,MAAM,EAAE,OAAO,CAAA;IACf,eAAe,EAAE,CAAC,GAAG,EAAE,SAAS,KAAK,OAAO,CAAC,SAAS,CAAC,CAAA;CACvD,yEAwDD,CAAA;AAED,eAAO,MAAM,kBAAkB,GAAI,SAAS,KAAK,CAAC,QAAQ,GAAG,IAAI,GAAG,SAAS,6JAc5E,CAAA;AAED,eAAO,MAAM,0BAA0B,GAAI,SAAS,KAAK,CAAC,QAAQ,KAAG,OAapE,CAAA"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/Utils/messages.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,QAAQ,CAAA;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAA;AAS9C,OAAO,KAAK,EACX,sBAAsB,EACtB,iBAAiB,EAEjB,+BAA+B,EAC/B,wBAAwB,EACxB,mCAAmC,EACnC,kBAAkB,EAGlB,SAAS,EACT,gBAAgB,EAChB,YAAY,EAEZ,MAAM,UAAU,CAAA;AAKjB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AACvC,OAAO,EAON,KAAK,oBAAoB,EACzB,MAAM,kBAAkB,CAAA;AAGzB,KAAK,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,IAAI,CAAC,SAAS,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;AAwClF;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAAI,MAAM,MAAM,uBAA+B,CAAA;AAE9E,eAAO,MAAM,6BAA6B,GACzC,MAAM,MAAM,EACZ,YAAY,wBAAwB,CAAC,YAAY,CAAC,EAClD,QAAQ,wBAAwB,CAAC,QAAQ,CAAC,sDAY1C,CAAA;AAiBD,eAAO,MAAM,qBAAqB,GACjC,SAAS,sBAAsB,EAC/B,SAAS,+BAA+B,2BAuMxC,CAAA;AAED,eAAO,MAAM,wCAAwC,GAAI,sBAAsB,MAAM,kBAapF,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,6BAA6B,GAAI,SAAS,SAAS,EAAE,eAAe,OAAO,mBA6BvF,CAAA;AAED,eAAO,MAAM,qBAAqB,GAAI,CAAC,SAAS,WAAW,EAC1D,SAAS,iBAAiB,EAC1B,KAAK,CAAC,KACJ,OAAO,IAAI,YAAY,CAAC,iBAAiB,EAAE,CAAC,CAQ9C,CAAA;AAMD,eAAO,MAAM,wBAAwB,GACpC,SAAS,iBAAiB,EAC1B,SAAS,+BAA+B,2BA2RxC,CAAA;AAED,eAAO,MAAM,4BAA4B,GACxC,KAAK,MAAM,EACX,SAAS,gBAAgB,EACzB,SAAS,mCAAmC,KA8Ea,SACzD,CAAA;AAED,eAAO,MAAM,iBAAiB,GAAU,KAAK,MAAM,EAAE,SAAS,iBAAiB,EAAE,SAAS,wBAAwB,uBAKjH,CAAA;AAED,qDAAqD;AACrD,eAAO,MAAM,cAAc,GAAI,SAAS,KAAK,CAAC,QAAQ,GAAG,SAAS,qCAMjE,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,GAAI,SAAS,gBAAgB,GAAG,IAAI,GAAG,SAAS,KAAG,gBAAgB,GAAG,SA8BzG,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB,GAAI,SAAS,gBAAgB,GAAG,SAAS,GAAG,IAAI,KAAG,gBAAgB,GAAG,SAuCvG,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,SAAS,GAAI,IAAI,MAAM,sDASpB,CAAA;AAEhB,uCAAuC;AACvC,eAAO,MAAM,wBAAwB,GAAI,KAAK,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,EAAE,SAAS,kBAAkB,SAQxG,CAAA;AAED,6CAA6C;AAC7C,eAAO,MAAM,yBAAyB,GAAI,KAAK,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,EAAE,UAAU,KAAK,CAAC,SAAS,SAOrG,CAAA;AAED,gDAAgD;AAChD,eAAO,MAAM,2BAA2B,GAAI,KAAK,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,EAAE,QAAQ,KAAK,CAAC,WAAW,SASzG,CAAA;AAED,mDAAmD;AACnD,eAAO,MAAM,8BAA8B,GAC1C,KAAK,IAAI,CAAC,SAAS,EAAE,gBAAgB,CAAC,EACtC,QAAQ,KAAK,CAAC,cAAc,SAQ5B,CAAA;AAED,KAAK,eAAe,GAAG;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,EAAE,CAAA;CAChB,CAAA;AAED;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAC7C,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,IAAI,CAAC,SAAS,EAAE,aAAa,GAAG,SAAS,CAAC,EACpE,IAAI,CAAC,EAAE,MAAM,qBAyCb;AAED,KAAK,mBAAmB,GAAG;IAC1B,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,EAAE,CAAA;CACpB,CAAA;AAED;;;;;GAKG;AACH,wBAAgB,mCAAmC,CAClD,EAAE,cAAc,EAAE,EAAE,IAAI,CAAC,SAAS,EAAE,gBAAgB,CAAC,EACrD,IAAI,CAAC,EAAE,MAAM,yBAoBb;AAED,+GAA+G;AAC/G,eAAO,MAAM,6BAA6B,GAAI,MAAM,YAAY,EAAE;SAC5B,MAAM;iBAAe,MAAM,GAAG,SAAS;gBAAc,MAAM,EAAE;GAiBlG,CAAA;AAED,KAAK,2BAA2B,GAAG;IAClC,eAAe,EAAE,CAAC,GAAG,EAAE,SAAS,KAAK,OAAO,CAAC,SAAS,CAAC,CAAA;IACvD,MAAM,EAAE,OAAO,CAAA;CACf,CAAA;AAID;;GAEG;AACH,eAAO,MAAM,oBAAoB,GAAU,IAAI,SAAS,QAAQ,GAAG,QAAQ,EAC1E,SAAS,SAAS,EAClB,MAAM,IAAI,EACV,SAAS,oBAAoB,EAC7B,MAAM,2BAA2B,yEAyDjC,CAAA;AAED,8FAA8F;AAC9F,eAAO,MAAM,kBAAkB,GAAI,SAAS,KAAK,CAAC,QAAQ,GAAG,IAAI,GAAG,SAAS,6JAa5E,CAAA"}