@neelegirl/baileys 1.5.3 → 1.5.5

package/lib/Types/Product.d.ts

@@ -1,92 +0,0 @@
-import { WAMediaUpload } from '@neelegirl/baileys/lib/Types/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/Product.js

@@ -1,3 +0,0 @@
-"use strict"
-
-Object.defineProperty(exports, "__esModule", { value: true })

package/lib/Types/Signal.d.ts

@@ -1,98 +0,0 @@
-import { proto } from '@neelegirl/baileys/WAProto'
-import { LIDMappingStore } from '@neelegirl/baileys/lib/Signal/lid-mapping'
-
-type DecryptGroupSignalOpts = {
-    group: string
-    authorJid: string
-    msg: Uint8Array
-}
-
-type EncryptMessageWithWireOpts = {
-    encryptionJid: string
-    wireJid: string
-    data: 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
-    }>
-    encryptMessageWithWire(opts: EncryptMessageWithWireOpts): Promise<{
-        type: 'pkmsg' | 'msg'
-        ciphertext: Uint8Array
-        wireJid: string
-    }>
-    encryptGroupMessage(opts: EncryptGroupMessageOpts): Promise<{
-        senderKeyDistributionMessage: Uint8Array
-        ciphertext: Uint8Array
-    }>
-    injectE2ESession(opts: E2ESessionOpts): Promise<void>
-    validateSession(jid: string): Promise<{
-        exists: boolean
-        reason?: string
-    }>
-    jidToSignalProtocolAddress(jid: string): string
-    migrateSession(fromJids: string[], toJid: string): Promise<{
-        migrated: number
-        skipped: number
-        total: number
-    }>
-    validateSession(jid: string): Promise<{
-        exists: boolean
-        reason?: string
-    }>
-    deleteSession(jids: string[]): Promise<void>
-}
-
-export interface SignalRepositoryWithLIDStore extends SignalRepository {
-    lidMapping: LIDMappingStore
-}
-
-export {}

package/lib/Types/Signal.js

@@ -1,3 +0,0 @@
-"use strict"
-
-Object.defineProperty(exports, "__esModule", { value: true })

package/lib/Types/Socket.d.ts

@@ -1,141 +0,0 @@
-import { AxiosRequestConfig } from 'axios'
-import type { Agent } from 'https'
-import { ILogger } from '@neelegirl/baileys/lib/Utils/logger'
-import type { URL } from 'url'
-import { proto } from '@neelegirl/baileys/WAProto'
-import { AuthenticationState, SignalAuthState, TransactionCapabilityOptions } from '@neelegirl/baileys/lib/Types/Auth'
-import { GroupMetadata } from '@neelegirl/baileys/lib/Types/GroupMetadata'
-import { MediaConnInfo } from '@neelegirl/baileys/lib/Types/Message'
-import { SignalRepositoryWithLIDStore } from '@neelegirl/baileys/lib/Types/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): Promise<T> | T | undefined
-    /** set a key in the cache */
-    set<T>(key: string, value: T): Promise<void> | void | number | boolean
-    /** delete a key from the cache */
-    del(key: string): void | Promise<void> | number | boolean
-    /** flush all data */
-    flushAll(): void | Promise<void>
-}
-
-export type PossiblyExtendedCacheStore = CacheStore & {
-    mget?: <T>(keys: string[]) => Promise<Record<string, T | undefined>>
-    mset?: <T>(entries: {
-        key: string
-        value: T
-    }[]) => Promise<void> | void | number | boolean
-    mdel?: (keys: string[]) => void | Promise<void> | number | boolean
-}
-
-export type PatchedMessageWithRecipientJID = proto.IMessage & {
-    recipientJid?: string
-}
-
-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
-     * @deprecated This feature has been removed
-    */
-    mobile?: boolean
-    /** proxy agent */
-    agent?: Agent
-    /** logger */
-    logger: ILogger
-    /** 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
-    /** alphanumeric country code (USA -> US) for the number used */
-    countryCode: string
-    /** 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?: PossiblyExtendedCacheStore
-    /** cache to store call offers */
-    callOfferCache?: CacheStore
-    /** cache to track placeholder resends */
-    placeholderResendCache?: 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
-    /** Enable automatic session recreation for failed messages */
-    enableAutoSessionRecreation: boolean
-    /** Enable recent message caching for retry handling */
-    enableRecentMessageCache: 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<PatchedMessageWithRecipientJID[] | PatchedMessageWithRecipientJID> | PatchedMessageWithRecipientJID[] | PatchedMessageWithRecipientJID
-    /** 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>
-    /** cached group metadata, use to prevent redundant requests to WA & speed up msg sending */
-    cachedGroupMetadata: (jid: string) => Promise<GroupMetadata | undefined>
-    makeSignalRepository: (auth: SignalAuthState, onWhatsAppFunc?: (...jids: string[]) => Promise<{
-        jid: string
-        exists: boolean
-        lid: string
-    }[] | undefined>) => SignalRepositoryWithLIDStore
-}

package/lib/Types/Socket.js

@@ -1,3 +0,0 @@
-"use strict"
-
-Object.defineProperty(exports, "__esModule", { value: true })

package/lib/Types/State.d.ts

@@ -1,41 +0,0 @@
-import { Boom } from '@hapi/boom'
-import { Contact } from '@neelegirl/baileys/lib/Types/Contact'
-
-export declare const enum SyncState {
-    /** The socket is connecting, but we haven't received pending notifications yet. */
-    Connecting = 0,
-    /** Pending notifications received. Buffering events until we decide whether to sync or not. */
-    AwaitingInitialSync = 1,
-    /** The initial app state sync (history, etc.) is in progress. Buffering continues. */
-    Syncing = 2,
-    /** Initial sync is complete, or was skipped. The socket is fully operational and events are processed in real-time. */
-    Online = 3
-}
-
-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: Boom | 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/State.js

@@ -1,14 +0,0 @@
-"use strict"
-
-Object.defineProperty(exports, "__esModule", { value: true })
-
-const SyncState = {
-	Connecting: 0,
-	AwaitingInitialSync: 1, 
-	Syncing: 2,
-	Online: 3
-}
-
-module.exports = {
-  SyncState
-}

package/lib/Types/USync.d.ts

@@ -1,26 +0,0 @@
-import { BinaryNode } from '@neelegirl/baileys/lib/WABinary'
-import { USyncUser } from '@neelegirl/baileys/lib/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/USync.js

@@ -1,3 +0,0 @@
-"use strict"
-
-Object.defineProperty(exports, "__esModule", { value: true })

package/lib/Types/index.d.ts

@@ -1,80 +0,0 @@
-export * from '@neelegirl/baileys/lib/Types/Auth'
-export * from '@neelegirl/baileys/lib/Types/Bussines'
-export * from '@neelegirl/baileys/lib/Types/Chat'
-export * from '@neelegirl/baileys/lib/Types/Contact'
-export * from '@neelegirl/baileys/lib/Types/GroupMetadata'
-export * from '@neelegirl/baileys/lib/Types/State'
-export * from '@neelegirl/baileys/lib/Types/MexUpdates'
-export * from '@neelegirl/baileys/lib/Types/Message'
-export * from '@neelegirl/baileys/lib/Types/Newsletter'
-export * from '@neelegirl/baileys/lib/Types/Socket'
-export * from '@neelegirl/baileys/lib/Types/Events'
-export * from '@neelegirl/baileys/lib/Types/Product'
-export * from '@neelegirl/baileys/lib/Types/Call'
-export * from '@neelegirl/baileys/lib/Types/Signal'
-
-import { AuthenticationState } from '@neelegirl/baileys/lib/Types/Auth'
-import { SocketConfig } from '@neelegirl/baileys/lib/Types/Socket'
-
-export type UserFacingSocketConfig = Partial<SocketConfig> & {
-    auth: AuthenticationState
-}
-
-export type BrowsersMap = {
-    ubuntu(browser: string): [string, string, string]
-    macOS(browser: string): [string, string, string]
-    windows(browser: string): [string, string, string]
-    linux(browser: string): [string, string, string]
-    android(browser: string): [string, string, string]
-    iOS(browser: string): [string, string, string]
-    baileys(browser: string): [string, string, string]
-    kaiOS(browser: string): [string, string, string]
-    chromeOS(browser: string): [string, string, string]
-    appropriate(browser: string): [string, string, string]
-    custom(platform: string, browser: string, version: string): [string, string, string]
-}
-
-export declare const 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/Types/index.js

@@ -1,50 +0,0 @@
-"use strict"
-
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k
-    var desc = Object.getOwnPropertyDescriptor(m, k)
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k] } }
-    }
-    Object.defineProperty(o, k2, desc)
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k
-    o[k2] = m[k]
-}))
-
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p)
-}
-
-Object.defineProperty(exports, "__esModule", { value: true })
-
-exports.DisconnectReason = void 0
-__exportStar(require("./Auth"), exports)
-__exportStar(require("./Bussines"), exports)
-__exportStar(require("./Chat"), exports)
-__exportStar(require("./Contact"), exports)
-__exportStar(require("./GroupMetadata"), exports)
-__exportStar(require("./State"), exports)
-__exportStar(require("./MexUpdates"), exports) 
-__exportStar(require("./Message"), exports)
-__exportStar(require("./Newsletter"), exports)
-__exportStar(require("./Socket"), exports)
-__exportStar(require("./Events"), exports)
-__exportStar(require("./Product"), exports)
-__exportStar(require("./Call"), exports)
-__exportStar(require("./Signal"), exports)
-
-const DisconnectReason = {
-    connectionClosed: 428,
-    connectionLost: 408,
-    connectionReplaced: 440,
-    timedOut: 408,
-    loggedOut: 401,
-    badSession: 500,
-    restartRequired: 515,
-    multideviceMismatch: 411,
-    forbidden: 403,
-    unavailableService: 503
-}
-
-exports.DisconnectReason = DisconnectReason

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

@@ -1,21 +0,0 @@
-import type { AuthenticationCreds, CacheStore, SignalKeyStore, SignalKeyStoreWithTransaction, TransactionCapabilityOptions } from '@neelegirl/baileys/lib/Types'
-import { ILogger } from '@neelegirl/baileys/lib/Utils/logger'
-
-/**
- * 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?: ILogger, _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?: ILogger, { maxCommitRetries, delayBetweenTriesMs }: TransactionCapabilityOptions) => SignalKeyStoreWithTransaction
-
-export declare const initAuthCreds: () => AuthenticationCreds