socketon 1.31.2-rc → 1.51.16

package/lib/Types/Message.d.ts

@@ -1,273 +0,0 @@
-/// <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 { BinaryNode } from '../WABinary';
-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;
-    /** if set to true, will send as a `video note` */
-    ptv?: boolean;
-} & 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;
-    };
-    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[];
-};
-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;
-    additionalNodes?: BinaryNode[];
-    /** 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;
-    /** if it is broadcast */
-    broadcast?: boolean;
-};
-export type MessageGenerationOptionsFromContent = MiscMessageGenerationOptions & {
-    userJid: string;
-};
-export type WAMediaUploadFunctionOpts = {
-    fileEncSha256B64: string;
-    mediaType: MediaType;
-    newsletter?: boolean;
-    timeoutMs?: number;
-};
-export type WAMediaUploadFunction = (readStream: Readable | Buffer, opts: WAMediaUploadFunctionOpts) => Promise<{
-    mediaUrl: string;
-    directPath: string;
-    handle?: 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;
-    /** The message is for newsletter? */
-    newsletter?: boolean;
-};
-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/Newsletter.d.ts

@@ -1,103 +0,0 @@
-import { proto } from "../../WAProto"
-
-export type NewsletterReactionMode = "ALL" | "BASIC" | "NONE"
-export type NewsletterState = "ACTIVE" | "GEOSUSPENDED" | "SUSPENDED"
-export type NewsletterVerification = "VERIFIED" | "UNVERIFIED"
-export type NewsletterMute = "ON" | "OFF" | "UNDEFINED"
-export type NewsletterViewRole = "ADMIN" | "GUEST" | "OWNER" | "SUBSCRIBER"
-
-export type NewsletterViewerMetadata = {
-  mute: NewsletterMute
-  view_role: NewsletterViewRole
-}
-
-export type NewsletterMetadata = {
-  /** jid of newsletter */
-  id: string
-  /** state of newsletter */
-  state: NewsletterState
-  /** creation timestamp of newsletter */
-  creation_time: number
-  /** name of newsletter */
-  name: string
-  /** timestamp of last name modification of newsletter */
-  nameTime: number
-  /** description of newsletter */
-  description: string
-  /** timestamp of last description modification of newsletter */
-  descriptionTime: number
-  /** invite code of newsletter */
-  invite: string
-  /** direct path of picture */
-  picture: string | null
-  /** direct path of picture preview (lower quality) */
-  preview: string | null
-  /** reaction mode of newsletter */
-  reaction_codes?: NewsletterReactionMode
-  /** subscribers count of newsletter */
-  subscribers: number
-  /** verification state of newsletter */
-  verification: NewsletterVerification
-  /** viewer metadata */
-  viewer_metadata: NewsletterViewerMetadata
-}
-
-export type SubscriberAction = "promote" | "demote"
-
-export type ReactionModeUpdate = {
-  reaction_codes: {
-    blocked_codes: null
-    enabled_ts_sec: null
-    value: NewsletterReactionMode
-  }
-}
-
-/** only exists reaction mode update */
-export type NewsletterSettingsUpdate = ReactionModeUpdate
-
-export type NewsletterReaction = {
-  count: number
-  code: string
-}
-
-export type NewsletterFetchedUpdate = {
-  /** id of message in newsletter, starts from 100 */
-  server_id: string
-  /** count of views in this message */
-  views?: number
-  /** reactions in this message */
-  reactions: NewsletterReaction[]
-  /** the message, if you requested only updates, you will not receive message */
-  message?: proto.IWebMessageInfo
-}
-
-export const MexOperations = {
-  PROMOTE: "NotificationNewsletterAdminPromote",
-  DEMOTE: "NotificationNewsletterAdminDemote",
-  UPDATE: "NotificationNewsletterUpdate"
-} as const
-
-export const XWAPaths = {
-  PROMOTE: "xwa2_notify_newsletter_admin_promote",
-  DEMOTE: "xwa2_notify_newsletter_admin_demote",
-  ADMIN_COUNT: "xwa2_newsletter_admin",
-  CREATE: "xwa2_newsletter_create",
-  NEWSLETTER: "xwa2_newsletter",
-  SUBSCRIBED: "xwa2_newsletter_subscribed",
-  METADATA_UPDATE: "xwa2_notify_newsletter_on_metadata_update"
-} as const
-
-export const QueryIds = {
-  JOB_MUTATION: "7150902998257522",
-  METADATA: "6620195908089573",
-  UNFOLLOW: "7238632346214362",
-  FOLLOW: "7871414976211147",
-  UNMUTE: "7337137176362961",
-  MUTE: "25151904754424642",
-  CREATE: "6996806640408138",
-  ADMIN_COUNT: "7130823597031706",
-  CHANGE_OWNER: "7341777602580933",
-  DELETE: "8316537688363079",
-  DEMOTE: "6551828931592903",
-  SUBSCRIBED: "6388546374527196"
-} as const

package/lib/Types/Product.d.ts

@@ -1,78 +0,0 @@
-import { WAMediaUpload } from './Message';
-export type CatalogResult = {
-    data: {
-        paging: {
-            cursors: {
-                before: string;
-                after: string;
-            };
-        };
-        data: any[];
-    };
-};
-export type ProductCreateResult = {
-    data: {
-        product: {};
-    };
-};
-export type CatalogStatus = {
-    status: string;
-    canAppeal: boolean;
-};
-export type CatalogCollection = {
-    id: string;
-    name: string;
-    products: Product[];
-    status: CatalogStatus;
-};
-export type ProductAvailability = 'in stock';
-export type ProductBase = {
-    name: string;
-    retailerId?: string;
-    url?: string;
-    description: string;
-    price: number;
-    currency: string;
-    isHidden?: boolean;
-};
-export type ProductCreate = ProductBase & {
-    /** ISO country code for product origin. Set to undefined for no country */
-    originCountryCode: string | undefined;
-    /** images of the product */
-    images: WAMediaUpload[];
-};
-export type ProductUpdate = Omit<ProductCreate, 'originCountryCode'>;
-export type Product = ProductBase & {
-    id: string;
-    imageUrls: {
-        [_: string]: string;
-    };
-    reviewStatus: {
-        [_: string]: string;
-    };
-    availability: ProductAvailability;
-};
-export type OrderPrice = {
-    currency: string;
-    total: number;
-};
-export type OrderProduct = {
-    id: string;
-    imageUrl: string;
-    name: string;
-    quantity: number;
-    currency: string;
-    price: number;
-};
-export type OrderDetails = {
-    price: OrderPrice;
-    products: OrderProduct[];
-};
-export type CatalogCursor = string;
-export type GetCatalogOptions = {
-    /** cursor to start from */
-    cursor?: CatalogCursor;
-    /** number of products to fetch */
-    limit?: number;
-    jid?: string;
-};

package/lib/Types/Signal.d.ts

@@ -1,57 +0,0 @@
-import { proto } from '../../WAProto';
-type DecryptGroupSignalOpts = {
-    group: string;
-    authorJid: string;
-    msg: Uint8Array;
-};
-type ProcessSenderKeyDistributionMessageOpts = {
-    item: proto.Message.ISenderKeyDistributionMessage;
-    authorJid: string;
-};
-type DecryptSignalProtoOpts = {
-    jid: string;
-    type: 'pkmsg' | 'msg';
-    ciphertext: Uint8Array;
-};
-type EncryptMessageOpts = {
-    jid: string;
-    data: Uint8Array;
-};
-type EncryptGroupMessageOpts = {
-    group: string;
-    data: Uint8Array;
-    meId: string;
-};
-type PreKey = {
-    keyId: number;
-    publicKey: Uint8Array;
-};
-type SignedPreKey = PreKey & {
-    signature: Uint8Array;
-};
-type E2ESession = {
-    registrationId: number;
-    identityKey: Uint8Array;
-    signedPreKey: SignedPreKey;
-    preKey: PreKey;
-};
-type E2ESessionOpts = {
-    jid: string;
-    session: E2ESession;
-};
-export type SignalRepository = {
-    decryptGroupMessage(opts: DecryptGroupSignalOpts): Promise<Uint8Array>;
-    processSenderKeyDistributionMessage(opts: ProcessSenderKeyDistributionMessageOpts): Promise<void>;
-    decryptMessage(opts: DecryptSignalProtoOpts): Promise<Uint8Array>;
-    encryptMessage(opts: EncryptMessageOpts): Promise<{
-        type: 'pkmsg' | 'msg';
-        ciphertext: Uint8Array;
-    }>;
-    encryptGroupMessage(opts: EncryptGroupMessageOpts): Promise<{
-        senderKeyDistributionMessage: Uint8Array;
-        ciphertext: Uint8Array;
-    }>;
-    injectE2ESession(opts: E2ESessionOpts): Promise<void>;
-    jidToSignalProtocolAddress(jid: string): string;
-};
-export {};

package/lib/Types/Socket.d.ts

@@ -1,111 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { AxiosRequestConfig } from 'axios';
-import type { Agent } from 'https';
-import type { Logger } from 'pino';
-import type { URL } from 'url';
-import { proto } from '../../WAProto';
-import { AuthenticationState, SignalAuthState, TransactionCapabilityOptions } from './Auth';
-import { MediaConnInfo } from './Message';
-import { SignalRepository } from './Signal';
-export type WAVersion = [number, number, number];
-export type WABrowserDescription = [string, string, string];
-export type CacheStore = {
-    /** get a cached key and change the stats */
-    get<T>(key: string): T | undefined;
-    /** set a key in the cache */
-    set<T>(key: string, value: T): void;
-    /** delete a key from the cache */
-    del(key: string): void;
-    /** flush all data */
-    flushAll(): void;
-};
-export type SocketConfig = {
-    /** the WS url to connect to WA */
-    waWebSocketUrl: string | URL;
-    /** Fails the connection if the socket times out in this interval */
-    connectTimeoutMs: number;
-    /** Default timeout for queries, undefined for no timeout */
-    defaultQueryTimeoutMs: number | undefined;
-    /** ping-pong interval for WS connection */
-    keepAliveIntervalMs: number;
-    /** should baileys use the mobile api instead of the multi device api */
-    mobile?: boolean;
-    /** proxy agent */
-    agent?: Agent;
-    /** pino logger */
-    logger: Logger;
-    /** version to connect with */
-    version: WAVersion;
-    /** override browser config */
-    browser: WABrowserDescription;
-    /** agent used for fetch requests -- uploading/downloading media */
-    fetchAgent?: Agent;
-    /** should the QR be printed in the terminal */
-    printQRInTerminal: boolean;
-    /** should events be emitted for actions done by this socket connection */
-    emitOwnEvents: boolean;
-    /** custom upload hosts to upload media to */
-    customUploadHosts: MediaConnInfo['hosts'];
-    /** time to wait between sending new retry requests */
-    retryRequestDelayMs: number;
-    /** max retry count */
-    maxMsgRetryCount: number;
-    /** time to wait for the generation of the next QR in ms */
-    qrTimeout?: number;
-    /** provide an auth state object to maintain the auth state */
-    auth: AuthenticationState;
-    /** manage history processing with this control; by default will sync up everything */
-    shouldSyncHistoryMessage: (msg: proto.Message.IHistorySyncNotification) => boolean;
-    /** transaction capability options for SignalKeyStore */
-    transactionOpts: TransactionCapabilityOptions;
-    /** marks the client as online whenever the socket successfully connects */
-    markOnlineOnConnect: boolean;
-    /** provide a cache to store media, so does not have to be re-uploaded */
-    mediaCache?: CacheStore;
-    /**
-     * map to store the retry counts for failed messages;
-     * used to determine whether to retry a message or not */
-    msgRetryCounterCache?: CacheStore;
-    /** provide a cache to store a user's device list */
-    userDevicesCache?: CacheStore;
-    /** cache to store call offers */
-    callOfferCache?: CacheStore;
-    /** width for link preview images */
-    linkPreviewImageThumbnailWidth: number;
-    /** Should Baileys ask the phone for full history, will be received async */
-    syncFullHistory: boolean;
-    /** Should baileys fire init queries automatically, default true */
-    fireInitQueries: boolean;
-    /**
-     * generate a high quality link preview,
-     * entails uploading the jpegThumbnail to WA
-     * */
-    generateHighQualityLinkPreview: boolean;
-    /**
-     * Returns if a jid should be ignored,
-     * no event for that jid will be triggered.
-     * Messages from that jid will also not be decrypted
-     * */
-    shouldIgnoreJid: (jid: string) => boolean | undefined;
-    /**
-     * Optionally patch the message before sending out
-     * */
-    patchMessageBeforeSending: (msg: proto.IMessage, recipientJids: string[]) => Promise<proto.IMessage> | proto.IMessage;
-    /** verify app state MACs */
-    appStateMacVerification: {
-        patch: boolean;
-        snapshot: boolean;
-    };
-    /** options for axios */
-    options: AxiosRequestConfig<{}>;
-    /**
-     * fetch a message from your store
-     * implement this so that messages failed to send
-     * (solves the "this message can take a while" issue) can be retried
-     * */
-    getMessage: (key: proto.IMessageKey) => Promise<proto.IMessage | undefined>;
-    makeSignalRepository: (auth: SignalAuthState) => SignalRepository;
-    /** Socket passthrough */
-    socket?: any;
-};

package/lib/Types/State.d.ts

@@ -1,27 +0,0 @@
-import { Contact } from './Contact';
-export type WAConnectionState = 'open' | 'connecting' | 'close';
-export type ConnectionState = {
-    /** connection is now open, connecting or closed */
-    connection: WAConnectionState;
-    /** the error that caused the connection to close */
-    lastDisconnect?: {
-        error: Error | undefined;
-        date: Date;
-    };
-    /** is this a new login */
-    isNewLogin?: boolean;
-    /** the current QR code */
-    qr?: string;
-    /** has the device received all pending notifications while it was offline */
-    receivedPendingNotifications?: boolean;
-    /** legacy connection options */
-    legacy?: {
-        phoneConnected: boolean;
-        user?: Contact;
-    };
-    /**
-     * if the client is shown as an active, online client.
-     * If this is false, the primary phone and other devices will receive notifs
-     * */
-    isOnline?: boolean;
-};

package/lib/Types/USync.d.ts

@@ -1,25 +0,0 @@
-import { BinaryNode } from '../WABinary';
-import { USyncUser } from '../WAUSync';
-/**
- * Defines the interface for a USyncQuery protocol
- */
-export interface USyncQueryProtocol {
-    /**
-     * The name of the protocol
-     */
-    name: string;
-    /**
-     * Defines what goes inside the query part of a USyncQuery
-     */
-    getQueryElement: () => BinaryNode;
-    /**
-     * Defines what goes inside the user part of a USyncQuery
-     */
-    getUserElement: (user: USyncUser) => BinaryNode | null;
-    /**
-     * Parse the result of the query
-     * @param data Data from the result
-     * @returns Whatever the protocol is supposed to return
-     */
-    parser: (data: BinaryNode) => unknown;
-}