@xbibzlibrary/whatsbibz 1.3.0

package/lib/Types/Label.js

@@ -0,0 +1,24 @@
+/** WhatsApp has 20 predefined colors */
+export var LabelColor;
+(function (LabelColor) {
+    LabelColor[LabelColor["Color1"] = 0] = "Color1";
+    LabelColor[LabelColor["Color2"] = 1] = "Color2";
+    LabelColor[LabelColor["Color3"] = 2] = "Color3";
+    LabelColor[LabelColor["Color4"] = 3] = "Color4";
+    LabelColor[LabelColor["Color5"] = 4] = "Color5";
+    LabelColor[LabelColor["Color6"] = 5] = "Color6";
+    LabelColor[LabelColor["Color7"] = 6] = "Color7";
+    LabelColor[LabelColor["Color8"] = 7] = "Color8";
+    LabelColor[LabelColor["Color9"] = 8] = "Color9";
+    LabelColor[LabelColor["Color10"] = 9] = "Color10";
+    LabelColor[LabelColor["Color11"] = 10] = "Color11";
+    LabelColor[LabelColor["Color12"] = 11] = "Color12";
+    LabelColor[LabelColor["Color13"] = 12] = "Color13";
+    LabelColor[LabelColor["Color14"] = 13] = "Color14";
+    LabelColor[LabelColor["Color15"] = 14] = "Color15";
+    LabelColor[LabelColor["Color16"] = 15] = "Color16";
+    LabelColor[LabelColor["Color17"] = 16] = "Color17";
+    LabelColor[LabelColor["Color18"] = 17] = "Color18";
+    LabelColor[LabelColor["Color19"] = 18] = "Color19";
+    LabelColor[LabelColor["Color20"] = 19] = "Color20";
+})(LabelColor || (LabelColor = {}));

package/lib/Types/LabelAssociation.d.ts

@@ -0,0 +1,29 @@
+/** Association type */
+export declare enum LabelAssociationType {
+    Chat = "label_jid",
+    Message = "label_message"
+}
+export type LabelAssociationTypes = `${LabelAssociationType}`;
+/** Association for chat */
+export interface ChatLabelAssociation {
+    type: LabelAssociationType.Chat;
+    chatId: string;
+    labelId: string;
+}
+/** Association for message */
+export interface MessageLabelAssociation {
+    type: LabelAssociationType.Message;
+    chatId: string;
+    messageId: string;
+    labelId: string;
+}
+export type LabelAssociation = ChatLabelAssociation | MessageLabelAssociation;
+/** Body for add/remove chat label association action */
+export interface ChatLabelAssociationActionBody {
+    labelId: string;
+}
+/** body for add/remove message label association action */
+export interface MessageLabelAssociationActionBody {
+    labelId: string;
+    messageId: string;
+}

package/lib/Types/LabelAssociation.js

@@ -0,0 +1,6 @@
+/** Association type */
+export var LabelAssociationType;
+(function (LabelAssociationType) {
+    LabelAssociationType["Chat"] = "label_jid";
+    LabelAssociationType["Message"] = "label_message";
+})(LabelAssociationType || (LabelAssociationType = {}));

package/lib/Types/Message.d.ts

@@ -0,0 +1,427 @@
+import type { Readable } from "stream";
+import type { URL } from "url";
+import { proto } from "../../WAProto/index.js";
+import type { MediaType } from "../Defaults/index.js";
+import type { BinaryNode } from "../WABinary/index.js";
+import type { GroupMetadata } from "./GroupMetadata.js";
+import type { CacheStore } from "./Socket.js";
+export { proto as WAProto };
+export type WAMessage = proto.IWebMessageInfo & {
+  key: WAMessageKey;
+  messageStubParameters?: any;
+  category?: string;
+  retryCount?: number;
+};
+export type WAMessageContent = proto.IMessage;
+export type WAContactMessage = proto.Message.IContactMessage;
+export type WAContactsArrayMessage = proto.Message.IContactsArrayMessage;
+export type WAMessageKey = proto.IMessageKey & {
+  remoteJidAlt?: string;
+  participantAlt?: string;
+  server_id?: string;
+  addressingMode?: string;
+  isViewOnce?: boolean;
+};
+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 declare const WAMessageStubType: typeof proto.WebMessageInfo.StubType;
+export declare const WAMessageStatus: typeof proto.WebMessageInfo.Status;
+import type { ILogger } from "../Utils/logger.js";
+export type WAMediaPayloadURL = {
+  url: URL | string;
+};
+export type WAMediaPayloadStream = {
+  stream: Readable;
+};
+export type WAMediaUpload = Buffer | WAMediaPayloadStream | WAMediaPayloadURL;
+/** Set of message types that are supported by the library */
+export type MessageType = keyof proto.Message;
+export declare enum WAMessageAddressingMode {
+  PN = "pn",
+  LID = "lid",
+}
+export type MessageWithContextInfo =
+  | "imageMessage"
+  | "contactMessage"
+  | "locationMessage"
+  | "extendedTextMessage"
+  | "documentMessage"
+  | "audioMessage"
+  | "videoMessage"
+  | "call"
+  | "contactsArrayMessage"
+  | "liveLocationMessage"
+  | "templateMessage"
+  | "stickerMessage"
+  | "groupInviteMessage"
+  | "templateButtonReplyMessage"
+  | "productMessage"
+  | "listMessage"
+  | "orderMessage"
+  | "listResponseMessage"
+  | "buttonsMessage"
+  | "buttonsResponseMessage"
+  | "interactiveMessage"
+  | "interactiveResponseMessage"
+  | "pollCreationMessage"
+  | "requestPhoneNumberMessage"
+  | "messageHistoryBundle"
+  | "eventMessage"
+  | "newsletterAdminInviteMessage"
+  | "albumMessage"
+  | "stickerPackMessage"
+  | "pollResultSnapshotMessage"
+  | "messageHistoryNotice";
+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[];
+  /** mention all */
+  mentionAll?: boolean;
+};
+type Contextable = {
+  /** add contextInfo to the message */
+  contextInfo?: proto.IContextInfo;
+};
+type ViewOnce = {
+  viewOnce?: boolean;
+};
+type Editable = {
+  edit?: WAMessageKey;
+};
+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;
+  toAnnouncementGroup?: boolean;
+};
+export type EventMessageOptions = {
+  name: string;
+  description?: string;
+  startDate: Date;
+  endDate?: Date;
+  location?: WALocationMessage;
+  call?: "audio" | "video";
+  isCancelled?: boolean;
+  isScheduleCall?: boolean;
+  extraGuestsAllowed?: boolean;
+  messageSecret?: Uint8Array<ArrayBufferLike>;
+};
+type SharePhoneNumber = {
+  sharePhoneNumber: boolean;
+};
+type RequestPhoneNumber = {
+  requestPhoneNumber: boolean;
+};
+export type AnyMediaMessageContent = (
+  | ({
+      image: WAMediaUpload;
+      caption?: string;
+      jpegThumbnail?: string;
+    } & Mentionable &
+      Contextable &
+      WithDimensions)
+  | ({
+      video: WAMediaUpload;
+      caption?: string;
+      gifPlayback?: boolean;
+      jpegThumbnail?: string;
+      /** if set to true, will send as a `video note` */
+      ptv?: boolean;
+    } & Mentionable &
+      Contextable &
+      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)
+) & {
+  mimetype?: string;
+} & Editable;
+export type ButtonReplyInfo = {
+  displayText: string;
+  id: string;
+  index: number;
+};
+export type GroupInviteInfo = {
+  inviteCode: string;
+  inviteExpiration: number;
+  text: string;
+  jid: string;
+  subject: string;
+};
+export type WASendableProduct = Omit<
+  proto.Message.ProductMessage.IProductSnapshot,
+  "productImage"
+> & {
+  productImage: WAMediaUpload;
+};
+export type StickerPackItem =
+  | WAMediaUpload
+  | {
+      sticker: WAMediaUpload;
+      emojis?: string[];
+      accessibilityLabel?: string;
+    };
+export type StickerPackContent = {
+  name: string;
+  publisher?: string;
+  description?: string;
+  packId?: string;
+  stickers: StickerPackItem[];
+  cover?: WAMediaUpload;
+};
+export type AnyRegularMessageContent = (
+  | ({
+      text: string;
+      linkPreview?: WAUrlInfo | null;
+    } & Mentionable &
+      Contextable &
+      Editable)
+  | AnyMediaMessageContent
+  | {
+      event: EventMessageOptions;
+    }
+  | ({
+      poll: PollMessageOptions;
+    } & Mentionable &
+      Contextable &
+      Editable)
+  | {
+      contacts: {
+        displayName?: string;
+        contacts: proto.Message.IContactMessage[];
+      };
+    }
+  | {
+      location: WALocationMessage;
+    }
+  | {
+      react: proto.Message.IReactionMessage;
+    }
+  | {
+      buttonReply: ButtonReplyInfo;
+      type: "template" | "plain";
+    }
+  | {
+      groupInvite: GroupInviteInfo;
+    }
+  | {
+      listReply: Omit<proto.Message.IListResponseMessage, "contextInfo">;
+    }
+  | {
+      pin: WAMessageKey;
+      type: proto.PinInChat.Type;
+      /**
+       * 24 hours, 7 days, 30 days
+       */
+      time?: 86400 | 604800 | 2592000;
+    }
+  | {
+      product: WASendableProduct;
+      businessOwnerJid?: string;
+      body?: string;
+      footer?: string;
+    }
+  | ({
+      stickerPack: StickerPackContent;
+    } & Mentionable &
+      Contextable)
+  | 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;
+    }
+  | {
+      limitSharing: boolean;
+    };
+export type GroupMetadataParticipants = Pick<GroupMetadata, "participants">;
+type MinimalRelayOptions = {
+  /** override the message ID with a custom provided string */
+  messageId?: string;
+  /** should we use group metadata cache, or fetch afresh from the server; default assumed to be "true" */
+  useCachedGroupMetadata?: boolean;
+};
+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;
+  };
+  additionalNodes?: BinaryNode[];
+  /** 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[];
+  recipientOverrides?: string[];
+  specificRecipient?: string;
+  specificRecipients?: 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[];
+  recipientOverrides?: string[];
+  specificRecipient?: string;
+  specificRecipients?: string[];
+  /** backgroundcolor for status */
+  backgroundColor?: string;
+  /** font type for status */
+  font?: number;
+  /** if it is broadcast */
+  broadcast?: boolean;
+};
+export type MessageGenerationOptionsFromContent =
+  MiscMessageGenerationOptions & {
+    userJid: string;
+  };
+export type WAMediaUploadFunction = (
+  encFilePath: string,
+  opts: {
+    fileEncSha256B64: string;
+    mediaType: MediaType;
+    newsletter?: boolean;
+    timeoutMs?: number;
+  },
+) => Promise<{
+  mediaUrl: string;
+  directPath: string;
+  meta_hmac?: string;
+  ts?: number;
+  fbid?: number;
+}>;
+export type MediaGenerationOptions = {
+  logger?: ILogger;
+  mediaTypeOverride?: MediaType;
+  upload: WAMediaUploadFunction;
+  /** cache media so it does not have to be uploaded again */
+  mediaCache?: CacheStore;
+  mediaUploadTimeoutMs?: number;
+  options?: RequestInit;
+  backgroundColor?: string;
+  font?: number;
+};
+export type MessageContentGenerationOptions = MediaGenerationOptions & {
+  getUrlInfo?: (text: string) => Promise<WAUrlInfo | undefined>;
+  getProfilePicUrl?: (
+    jid: string,
+    type: "image" | "preview",
+  ) => Promise<string | undefined>;
+  getCallLink?: (
+    type: "audio" | "video",
+    event?: {
+      startTime: number;
+    },
+  ) => Promise<string | undefined>;
+  jid?: string;
+};
+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: WAMessageKey;
+};
+export type WAMessageCursor =
+  | {
+      before: WAMessageKey | undefined;
+    }
+  | {
+      after: WAMessageKey | undefined;
+    };
+export type MessageUserReceiptUpdate = {
+  key: WAMessageKey;
+  receipt: MessageUserReceipt;
+};
+export type MediaDecryptionKeyInfo = {
+  iv: Uint8Array;
+  cipherKey: Uint8Array;
+  macKey?: Uint8Array;
+};
+export type MinimalMessage = Pick<WAMessage, "key" | "messageTimestamp">;

package/lib/Types/Message.js

@@ -0,0 +1,10 @@
+import { proto } from '../../WAProto/index.js';
+// export the WAMessage Prototypes
+export { proto as WAProto };
+export const WAMessageStubType = proto.WebMessageInfo.StubType;
+export const WAMessageStatus = proto.WebMessageInfo.Status;
+export var WAMessageAddressingMode;
+(function (WAMessageAddressingMode) {
+    WAMessageAddressingMode["PN"] = "pn";
+    WAMessageAddressingMode["LID"] = "lid";
+})(WAMessageAddressingMode || (WAMessageAddressingMode = {}));

package/lib/Types/Newsletter.d.ts

@@ -0,0 +1,134 @@
+export declare enum XWAPaths {
+    xwa2_newsletter_create = "xwa2_newsletter_create",
+    xwa2_newsletter_subscribers = "xwa2_newsletter_subscribers",
+    xwa2_newsletter_view = "xwa2_newsletter_view",
+    xwa2_newsletter_metadata = "xwa2_newsletter",
+    xwa2_newsletter_admin_count = "xwa2_newsletter_admin",
+    xwa2_newsletter_mute_v2 = "xwa2_newsletter_mute_v2",
+    xwa2_newsletter_unmute_v2 = "xwa2_newsletter_unmute_v2",
+    xwa2_newsletter_follow = "xwa2_newsletter_follow",
+    xwa2_newsletter_unfollow = "xwa2_newsletter_unfollow",
+    xwa2_newsletter_change_owner = "xwa2_newsletter_change_owner",
+    xwa2_newsletter_demote = "xwa2_newsletter_demote",
+    xwa2_newsletter_delete_v2 = "xwa2_newsletter_delete_v2"
+}
+export declare enum QueryIds {
+    CREATE = "8823471724422422",
+    UPDATE_METADATA = "24250201037901610",
+    METADATA = "6563316087068696",
+    SUBSCRIBERS = "9783111038412085",
+    FOLLOW = "7871414976211147",
+    UNFOLLOW = "7238632346214362",
+    MUTE = "29766401636284406",
+    UNMUTE = "9864994326891137",
+    ADMIN_COUNT = "7130823597031706",
+    CHANGE_OWNER = "7341777602580933",
+    DEMOTE = "6551828931592903",
+    DELETE = "30062808666639665"
+}
+export type NewsletterUpdate = {
+    name?: string;
+    description?: string;
+    picture?: string;
+};
+export interface NewsletterCreateResponse {
+    id: string;
+    state: {
+        type: string;
+    };
+    thread_metadata: {
+        creation_time: string;
+        description: {
+            id: string;
+            text: string;
+            update_time: string;
+        };
+        handle: string | null;
+        invite: string;
+        name: {
+            id: string;
+            text: string;
+            update_time: string;
+        };
+        picture: {
+            direct_path: string;
+            id: string;
+            type: string;
+        };
+        preview: {
+            direct_path: string;
+            id: string;
+            type: string;
+        };
+        subscribers_count: string;
+        verification: 'VERIFIED' | 'UNVERIFIED';
+    };
+    viewer_metadata: {
+        mute: 'ON' | 'OFF';
+        role: NewsletterViewRole;
+    };
+}
+export interface NewsletterCreateResponse {
+    id: string;
+    state: {
+        type: string;
+    };
+    thread_metadata: {
+        creation_time: string;
+        description: {
+            id: string;
+            text: string;
+            update_time: string;
+        };
+        handle: string | null;
+        invite: string;
+        name: {
+            id: string;
+            text: string;
+            update_time: string;
+        };
+        picture: {
+            direct_path: string;
+            id: string;
+            type: string;
+        };
+        preview: {
+            direct_path: string;
+            id: string;
+            type: string;
+        };
+        subscribers_count: string;
+        verification: 'VERIFIED' | 'UNVERIFIED';
+    };
+    viewer_metadata: {
+        mute: 'ON' | 'OFF';
+        role: NewsletterViewRole;
+    };
+}
+export type NewsletterViewRole = 'ADMIN' | 'GUEST' | 'OWNER' | 'SUBSCRIBER';
+export interface NewsletterMetadata {
+    id: string;
+    owner?: string;
+    name: string;
+    description?: string;
+    invite?: string;
+    creation_time?: number;
+    subscribers?: number;
+    picture?: {
+        url?: string;
+        directPath?: string;
+        mediaKey?: string;
+        id?: string;
+    };
+    verification?: 'VERIFIED' | 'UNVERIFIED';
+    reaction_codes?: {
+        code: string;
+        count: number;
+    }[];
+    mute_state?: 'ON' | 'OFF';
+    thread_metadata?: {
+        creation_time?: number;
+        name?: string;
+        description?: string;
+    };
+}

package/lib/Types/Newsletter.js

@@ -0,0 +1,30 @@
+export var XWAPaths;
+(function (XWAPaths) {
+    XWAPaths["xwa2_newsletter_create"] = "xwa2_newsletter_create";
+    XWAPaths["xwa2_newsletter_subscribers"] = "xwa2_newsletter_subscribers";
+    XWAPaths["xwa2_newsletter_view"] = "xwa2_newsletter_view";
+    XWAPaths["xwa2_newsletter_metadata"] = "xwa2_newsletter";
+    XWAPaths["xwa2_newsletter_admin_count"] = "xwa2_newsletter_admin";
+    XWAPaths["xwa2_newsletter_mute_v2"] = "xwa2_newsletter_mute_v2";
+    XWAPaths["xwa2_newsletter_unmute_v2"] = "xwa2_newsletter_unmute_v2";
+    XWAPaths["xwa2_newsletter_follow"] = "xwa2_newsletter_follow";
+    XWAPaths["xwa2_newsletter_unfollow"] = "xwa2_newsletter_unfollow";
+    XWAPaths["xwa2_newsletter_change_owner"] = "xwa2_newsletter_change_owner";
+    XWAPaths["xwa2_newsletter_demote"] = "xwa2_newsletter_demote";
+    XWAPaths["xwa2_newsletter_delete_v2"] = "xwa2_newsletter_delete_v2";
+})(XWAPaths || (XWAPaths = {}));
+export var QueryIds;
+(function (QueryIds) {
+    QueryIds["CREATE"] = "8823471724422422";
+    QueryIds["UPDATE_METADATA"] = "24250201037901610";
+    QueryIds["METADATA"] = "6563316087068696";
+    QueryIds["SUBSCRIBERS"] = "9783111038412085";
+    QueryIds["FOLLOW"] = "7871414976211147";
+    QueryIds["UNFOLLOW"] = "7238632346214362";
+    QueryIds["MUTE"] = "29766401636284406";
+    QueryIds["UNMUTE"] = "9864994326891137";
+    QueryIds["ADMIN_COUNT"] = "7130823597031706";
+    QueryIds["CHANGE_OWNER"] = "7341777602580933";
+    QueryIds["DEMOTE"] = "6551828931592903";
+    QueryIds["DELETE"] = "30062808666639665";
+})(QueryIds || (QueryIds = {}));