@whiskeysockets/baileys
Version:
A WebSockets library for interacting with WhatsApp Web
100 lines • 4.86 kB
TypeScript
import { proto } from '../../WAProto/index.js';
import type { BaileysEventEmitter, ChatModification, ChatMutation, Contact, InitialAppStateSyncOptions, LTHashState, WAPatchCreate, WAPatchName } from '../Types/index.js';
import { type BinaryNode } from '../WABinary/index.js';
import type { ILogger } from './logger.js';
type FetchAppStateSyncKey = (keyId: string) => Promise<proto.Message.IAppStateSyncKeyData | null | undefined>;
export type ChatMutationMap = {
[index: string]: ChatMutation;
};
type Mac = {
indexMac: Uint8Array;
valueMac: Uint8Array;
operation: proto.SyncdMutation.SyncdOperation;
};
export declare const makeLtHashGenerator: ({ indexValueMap, hash }: Pick<LTHashState, "hash" | "indexValueMap">) => {
mix: ({ indexMac, valueMac, operation }: Mac) => void;
finish: () => {
hash: Buffer<ArrayBuffer>;
indexValueMap: {
[indexMacBase64: string]: {
valueMac: Uint8Array | Buffer;
};
};
};
};
export declare const newLTHashState: () => LTHashState;
export declare const ensureLTHashStateVersion: (state: LTHashState) => LTHashState;
export declare const MAX_SYNC_ATTEMPTS = 2;
/**
* Check if an error is a missing app state sync key.
* WA Web treats these as "Blocked" (waits for key arrival), not fatal.
* In Baileys we retry with a snapshot which may use a different key.
*/
export declare const isMissingKeyError: (error: any) => boolean;
/**
* Determines if an app state sync error is unrecoverable.
* TypeError indicates a WASM crash; otherwise we give up after MAX_SYNC_ATTEMPTS.
* Missing keys are NOT checked here — they are handled separately as "Blocked".
*/
export declare const isAppStateSyncIrrecoverable: (error: any, attempts: number) => boolean;
export declare const encodeSyncdPatch: ({ type, index, syncAction, apiVersion, operation }: WAPatchCreate, myAppStateKeyId: string, state: LTHashState, getAppStateSyncKey: FetchAppStateSyncKey) => Promise<{
patch: proto.ISyncdPatch;
state: LTHashState;
}>;
export declare const decodeSyncdMutations: (msgMutations: (proto.ISyncdMutation | proto.ISyncdRecord)[], initialState: LTHashState, getAppStateSyncKey: FetchAppStateSyncKey, onMutation: (mutation: ChatMutation) => void, validateMacs: boolean) => Promise<{
hash: Buffer<ArrayBuffer>;
indexValueMap: {
[indexMacBase64: string]: {
valueMac: Uint8Array | Buffer;
};
};
}>;
export declare const decodeSyncdPatch: (msg: proto.ISyncdPatch, name: WAPatchName, initialState: LTHashState, getAppStateSyncKey: FetchAppStateSyncKey, onMutation: (mutation: ChatMutation) => void, validateMacs: boolean) => Promise<{
hash: Buffer<ArrayBuffer>;
indexValueMap: {
[indexMacBase64: string]: {
valueMac: Uint8Array | Buffer;
};
};
}>;
export declare const extractSyncdPatches: (result: BinaryNode, options: RequestInit) => Promise<{
critical_unblock_low: {
patches: proto.ISyncdPatch[];
hasMorePatches: boolean;
snapshot?: proto.ISyncdSnapshot;
};
regular_high: {
patches: proto.ISyncdPatch[];
hasMorePatches: boolean;
snapshot?: proto.ISyncdSnapshot;
};
regular_low: {
patches: proto.ISyncdPatch[];
hasMorePatches: boolean;
snapshot?: proto.ISyncdSnapshot;
};
critical_block: {
patches: proto.ISyncdPatch[];
hasMorePatches: boolean;
snapshot?: proto.ISyncdSnapshot;
};
regular: {
patches: proto.ISyncdPatch[];
hasMorePatches: boolean;
snapshot?: proto.ISyncdSnapshot;
};
}>;
export declare const downloadExternalBlob: (blob: proto.IExternalBlobReference, options: RequestInit) => Promise<Buffer<ArrayBuffer>>;
export declare const downloadExternalPatch: (blob: proto.IExternalBlobReference, options: RequestInit) => Promise<proto.SyncdMutations>;
export declare const decodeSyncdSnapshot: (name: WAPatchName, snapshot: proto.ISyncdSnapshot, getAppStateSyncKey: FetchAppStateSyncKey, minimumVersionNumber: number | undefined, validateMacs?: boolean, logger?: ILogger) => Promise<{
state: LTHashState;
mutationMap: ChatMutationMap;
}>;
export declare const decodePatches: (name: WAPatchName, syncds: proto.ISyncdPatch[], initial: LTHashState, getAppStateSyncKey: FetchAppStateSyncKey, options: RequestInit, minimumVersionNumber?: number, logger?: ILogger, validateMacs?: boolean) => Promise<{
state: LTHashState;
mutationMap: ChatMutationMap;
}>;
export declare const chatModificationToAppPatch: (mod: ChatModification, jid: string) => WAPatchCreate;
export declare const processSyncAction: (syncAction: ChatMutation, ev: BaileysEventEmitter, me: Contact, initialSyncOpts?: InitialAppStateSyncOptions, logger?: ILogger) => void;
export {};
//# sourceMappingURL=chat-utils.d.ts.map