@alannxd/baileys 6.0.6 → 6.0.9

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/Newsletter.js

@@ -1,38 +0,0 @@
-"use strict"
-
-Object.defineProperty(exports, "__esModule", { value: true })
-
-const MexOperations = {
-  PROMOTE: "NotificationNewsletterAdminPromote",
-  DEMOTE: "NotificationNewsletterAdminDemote",
-  UPDATE: "NotificationNewsletterUpdate"
-}
-
-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"
-}
-
-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"
-}
-
-exports.MexOperations = MexOperations
-exports.XWAPaths = XWAPaths
-exports.QueryIds = QueryIds

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;
-}

package/lib/Types/index.d.ts

@@ -1,57 +0,0 @@
-export * from './Auth';
-export * from './GroupMetadata';
-export * from './Chat';
-export * from './Contact';
-export * from './State';
-export * from './Message';
-export * from './Newsletter';
-export * from './Socket';
-export * from './Events';
-export * from './Product';
-export * from './Call';
-export * from './Signal';
-import { AuthenticationState } from './Auth';
-import { SocketConfig } from './Socket';
-export type UserFacingSocketConfig = Partial<SocketConfig> & {
-    auth: AuthenticationState;
-};
-export declare enum DisconnectReason {
-    connectionClosed = 428,
-    connectionLost = 408,
-    connectionReplaced = 440,
-    timedOut = 408,
-    loggedOut = 401,
-    badSession = 500,
-    restartRequired = 515,
-    multideviceMismatch = 411,
-    forbidden = 403,
-    unavailableService = 503
-}
-export type WAInitResponse = {
-    ref: string;
-    ttl: number;
-    status: 200;
-};
-export type WABusinessHoursConfig = {
-    day_of_week: string;
-    mode: string;
-    open_time?: number;
-    close_time?: number;
-};
-export type WABusinessProfile = {
-    description: string;
-    email: string | undefined;
-    business_hours: {
-        timezone?: string;
-        config?: WABusinessHoursConfig[];
-        business_config?: WABusinessHoursConfig[];
-    };
-    website: string[];
-    category?: string;
-    wid?: string;
-    address?: string;
-};
-export type CurveKeyPair = {
-    private: Uint8Array;
-    public: Uint8Array;
-};

package/lib/Utils/auth-utils.d.ts

@@ -1,18 +0,0 @@
-import type { Logger } from 'pino';
-import type { AuthenticationCreds, CacheStore, SignalKeyStore, SignalKeyStoreWithTransaction, TransactionCapabilityOptions } from '../Types';
-/**
- * Adds caching capability to a SignalKeyStore
- * @param store the store to add caching to
- * @param logger to log trace events
- * @param _cache cache store to use
- */
-export declare function makeCacheableSignalKeyStore(store: SignalKeyStore, logger: Logger, _cache?: CacheStore): SignalKeyStore;
-/**
- * Adds DB like transaction capability (https://en.wikipedia.org/wiki/Database_transaction) to the SignalKeyStore,
- * this allows batch read & write operations & improves the performance of the lib
- * @param state the key store to apply this capability to
- * @param logger logger to log events
- * @returns SignalKeyStore with transaction capability
- */
-export declare const addTransactionCapability: (state: SignalKeyStore, logger: Logger, { maxCommitRetries, delayBetweenTriesMs }: TransactionCapabilityOptions) => SignalKeyStoreWithTransaction;
-export declare const initAuthCreds: () => AuthenticationCreds;

package/lib/Utils/baileys-event-stream.d.ts

@@ -1,16 +0,0 @@
-import type { BaileysEventEmitter } from '../Types';
-/**
- * Captures events from a baileys event emitter & stores them in a file
- * @param ev The event emitter to read events from
- * @param filename File to save to
- */
-export declare const captureEventStream: (ev: BaileysEventEmitter, filename: string) => void;
-/**
- * Read event file and emit events from there
- * @param filename filename containing event data
- * @param delayIntervalMs delay between each event emit
- */
-export declare const readAndEmitEventStream: (filename: string, delayIntervalMs?: number) => {
-    ev: BaileysEventEmitter;
-    task: Promise<void>;
-};

package/lib/Utils/baileys-event-stream.js

@@ -1,63 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.readAndEmitEventStream = exports.captureEventStream = void 0;
-const events_1 = __importDefault(require("events"));
-const fs_1 = require("fs");
-const promises_1 = require("fs/promises");
-const readline_1 = require("readline");
-const generics_1 = require("./generics");
-const make_mutex_1 = require("./make-mutex");
-/**
- * Captures events from a baileys event emitter & stores them in a file
- * @param ev The event emitter to read events from
- * @param filename File to save to
- */
-const captureEventStream = (ev, filename) => {
-    const oldEmit = ev.emit;
-    // write mutex so data is appended in order
-    const writeMutex = (0, make_mutex_1.makeMutex)();
-    // monkey patch eventemitter to capture all events
-    ev.emit = function (...args) {
-        const content = JSON.stringify({ timestamp: Date.now(), event: args[0], data: args[1] }) + '\n';
-        const result = oldEmit.apply(ev, args);
-        writeMutex.mutex(async () => {
-            await (0, promises_1.writeFile)(filename, content, { flag: 'a' });
-        });
-        return result;
-    };
-};
-exports.captureEventStream = captureEventStream;
-/**
- * Read event file and emit events from there
- * @param filename filename containing event data
- * @param delayIntervalMs delay between each event emit
- */
-const readAndEmitEventStream = (filename, delayIntervalMs = 0) => {
-    const ev = new events_1.default();
-    const fireEvents = async () => {
-        // from: https://stackoverflow.com/questions/6156501/read-a-file-one-line-at-a-time-in-node-js
-        const fileStream = (0, fs_1.createReadStream)(filename);
-        const rl = (0, readline_1.createInterface)({
-            input: fileStream,
-            crlfDelay: Infinity
-        });
-        // Note: we use the crlfDelay option to recognize all instances of CR LF
-        // ('\r\n') in input.txt as a single line break.
-        for await (const line of rl) {
-            if (line) {
-                const { event, data } = JSON.parse(line);
-                ev.emit(event, data);
-                delayIntervalMs && await (0, generics_1.delay)(delayIntervalMs);
-            }
-        }
-        fileStream.close();
-    };
-    return {
-        ev,
-        task: fireEvents()
-    };
-};
-exports.readAndEmitEventStream = readAndEmitEventStream;

package/lib/Utils/business.d.ts

@@ -1,22 +0,0 @@
-import { CatalogCollection, OrderDetails, Product, ProductCreate, ProductUpdate, WAMediaUpload, WAMediaUploadFunction } from '../Types';
-import { BinaryNode } from '../WABinary';
-export declare const parseCatalogNode: (node: BinaryNode) => {
-    products: Product[];
-    nextPageCursor: string | undefined;
-};
-export declare const parseCollectionsNode: (node: BinaryNode) => {
-    collections: CatalogCollection[];
-};
-export declare const parseOrderDetailsNode: (node: BinaryNode) => OrderDetails;
-export declare const toProductNode: (productId: string | undefined, product: ProductCreate | ProductUpdate) => BinaryNode;
-export declare const parseProductNode: (productNode: BinaryNode) => Product;
-/**
- * Uploads images not already uploaded to WA's servers
- */
-export declare function uploadingNecessaryImagesOfProduct<T extends ProductUpdate | ProductCreate>(product: T, waUploadToServer: WAMediaUploadFunction, timeoutMs?: number): Promise<T>;
-/**
- * Uploads images not already uploaded to WA's servers
- */
-export declare const uploadingNecessaryImages: (images: WAMediaUpload[], waUploadToServer: WAMediaUploadFunction, timeoutMs?: number) => Promise<{
-    url: string;
-}[]>;