zapo-js 0.1.2 → 0.3.0

package/dist/types/media/types.d.ts

@@ -1,8 +1,8 @@
 import type { Readable } from 'node:stream';
 import type { Logger } from '../infra/log/types';
-import type { WaProxyAgent, WaProxyDispatcher } from '../transport/types';
-export type MediaKind = 'image' | 'video' | 'audio' | 'document' | 'sticker';
-export type MediaCryptoType = MediaKind | 'ptt' | 'gif' | 'ptv' | 'history' | 'md-app-state';
+import type { WaProxyAgent } from '../transport/types';
+export type MediaKind = 'image' | 'video' | 'audio' | 'document' | 'sticker' | 'ptv';
+export type MediaCryptoType = MediaKind | 'ptt' | 'gif' | 'history' | 'md-app-state';
 export interface WaMediaConnHost {
     readonly hostname: string;
     readonly isFallback: boolean;
@@ -18,10 +18,9 @@ export interface WaMediaTransferClientOptions {
     readonly defaultTimeoutMs?: number;
     readonly defaultMaxReadBytes?: number;
     readonly defaultHeaders?: Readonly<Record<string, string>>;
-    readonly defaultUploadDispatcher?: WaProxyDispatcher;
-    readonly defaultDownloadDispatcher?: WaProxyDispatcher;
     readonly defaultUploadAgent?: WaProxyAgent;
     readonly defaultDownloadAgent?: WaProxyAgent;
+    readonly skipMacVerification?: boolean;
 }
 export interface WaMediaDerivedKeys {
     readonly iv: Uint8Array;
@@ -33,6 +32,8 @@ export interface WaMediaEncryptionResult {
     readonly ciphertextHmac: Uint8Array;
     readonly fileSha256: Uint8Array;
     readonly fileEncSha256: Uint8Array;
+    readonly streamingSidecar?: Uint8Array;
+    readonly firstFrameSidecar?: Uint8Array;
 }
 export interface WaMediaDecryptionResult {
     readonly plaintext: Uint8Array;
@@ -44,6 +45,9 @@ export interface WaMediaReadableEncryptionResult {
     readonly metadata: Promise<{
         readonly fileSha256: Uint8Array;
         readonly fileEncSha256: Uint8Array;
+        readonly plaintextLength: number;
+        readonly streamingSidecar?: Uint8Array;
+        readonly firstFrameSidecar?: Uint8Array;
     }>;
 }
 export interface WaMediaReadableDecryptionResult {
@@ -53,9 +57,19 @@ export interface WaMediaReadableDecryptionResult {
         readonly fileEncSha256: Uint8Array;
     }>;
 }
+export interface WaMediaFileEncryptionResult {
+    readonly filePath: string;
+    readonly fileSize: number;
+    readonly fileSha256: Uint8Array;
+    readonly fileEncSha256: Uint8Array;
+    readonly plaintextLength: number;
+    readonly streamingSidecar?: Uint8Array;
+    readonly firstFrameSidecar?: Uint8Array;
+}
 export interface WaMediaDecryptReadableOptions {
     readonly mediaType: MediaCryptoType;
     readonly mediaKey: Uint8Array;
     readonly expectedFileSha256?: Uint8Array;
     readonly expectedFileEncSha256?: Uint8Array;
+    readonly skipMacVerification?: boolean;
 }

package/dist/types/message/addon-crypto.d.ts

@@ -1,13 +1,18 @@
+import type { WaAddonKind } from '../client/types';
 import { WA_USE_CASE_SECRET_MODIFICATION_TYPES } from './use-case-secret';
+import { type Proto } from '..';
+import type { WaMessageSecretEntry, WaMessageSecretStore } from '../store/contracts/message-secret.store';
+import type { WaMessageStore } from '../store/contracts/message.store';
 type WaAddonBytes = Uint8Array | ArrayBuffer | ArrayBufferView;
-export declare function shouldUseAddonAdditionalData(modificationType: (typeof WA_USE_CASE_SECRET_MODIFICATION_TYPES)[keyof typeof WA_USE_CASE_SECRET_MODIFICATION_TYPES]): boolean;
+type ModificationType = (typeof WA_USE_CASE_SECRET_MODIFICATION_TYPES)[keyof typeof WA_USE_CASE_SECRET_MODIFICATION_TYPES];
+export declare function shouldUseAddonAdditionalData(modificationType: ModificationType): boolean;
 export declare function buildAddonAdditionalData(stanzaId: string, addOnSenderJid: string): Uint8Array;
 export declare function encryptAddonPayload(input: {
     readonly messageSecret: WaAddonBytes;
     readonly stanzaId: string;
     readonly parentMsgOriginalSender: string;
     readonly modificationSender: string;
-    readonly modificationType: (typeof WA_USE_CASE_SECRET_MODIFICATION_TYPES)[keyof typeof WA_USE_CASE_SECRET_MODIFICATION_TYPES];
+    readonly modificationType: ModificationType;
     readonly payload: WaAddonBytes;
     readonly iv: WaAddonBytes;
     readonly additionalData?: WaAddonBytes;
@@ -17,9 +22,35 @@ export declare function decryptAddonPayload(input: {
     readonly stanzaId: string;
     readonly parentMsgOriginalSender: string;
     readonly modificationSender: string;
-    readonly modificationType: (typeof WA_USE_CASE_SECRET_MODIFICATION_TYPES)[keyof typeof WA_USE_CASE_SECRET_MODIFICATION_TYPES];
+    readonly modificationType: ModificationType;
     readonly ciphertext: WaAddonBytes;
     readonly iv: WaAddonBytes;
     readonly additionalData?: WaAddonBytes;
 }): Promise<Uint8Array>;
+export interface WaIdentifiedEncAddon {
+    readonly kind: WaAddonKind;
+    readonly targetMessageKey: Proto.IMessageKey;
+    readonly encPayload: Uint8Array;
+    readonly encIv: Uint8Array;
+    readonly modificationType: ModificationType;
+    readonly raw: Proto.IMessage;
+}
+export declare function identifyEncryptedAddon(message: Proto.IMessage): WaIdentifiedEncAddon | null;
+export type WaDecodedAddon = {
+    readonly kind: 'reaction';
+    readonly reaction: Proto.Message.IReactionMessage;
+} | {
+    readonly kind: 'poll_vote';
+    readonly pollVote: Proto.Message.IPollVoteMessage;
+    readonly selectedOptionNames: readonly string[] | null;
+} | {
+    readonly kind: 'event_response';
+    readonly eventResponse: Proto.Message.IEventResponseMessage;
+} | {
+    readonly kind: 'comment';
+    readonly comment: Proto.Message.ICommentMessage;
+};
+export declare function decodeAddonPlaintext(kind: WaAddonKind, plaintext: Uint8Array): WaDecodedAddon;
+export declare function resolveParentMessageSecret(targetMessageId: string, messageSecretStore: WaMessageSecretStore, messageStore: WaMessageStore): Promise<WaMessageSecretEntry | null>;
+export declare function resolvePollOptionNames(selectedOptions: readonly Uint8Array[], pollCreationMessageId: string, messageStore: WaMessageStore): Promise<readonly string[] | null>;
 export {};

package/dist/types/message/content.d.ts

@@ -1,4 +1,14 @@
 import type { WaSendMediaMessage } from './types';
-import type { Proto } from '..';
+import { type Proto } from '..';
 export declare function isSendMediaMessage(content: unknown): content is WaSendMediaMessage;
+export declare function unwrapMessage(message: Proto.IMessage): Proto.IMessage;
 export declare function resolveMessageTypeAttr(message: Proto.IMessage): string;
+export declare function needsSecretPersistence(message: Proto.IMessage): boolean;
+export declare function resolveEditAttr(message: Proto.IMessage, subtype?: string): string | null;
+export declare function resolveEncMediaType(message: Proto.IMessage): string | null;
+export interface MessageMetaAttrs {
+    readonly polltype?: string;
+    readonly event_type?: string;
+    readonly view_once?: string;
+}
+export declare function resolveMetaAttrs(message: Proto.IMessage): MessageMetaAttrs | null;

package/dist/types/message/icdc.d.ts

@@ -0,0 +1,13 @@
+import type { Proto } from '..';
+import type { SignalAddress } from '../signal/types';
+import type { WaIdentityStore } from '../store/contracts/identity.store';
+export interface IcdcMeta {
+    readonly keyHash: Uint8Array;
+    readonly timestamp: number | undefined;
+}
+export declare function computeDeviceKeyHash(identityKeys: readonly Uint8Array[], hashLength?: number): Promise<Uint8Array>;
+export declare function resolveIcdcMeta(deviceJids: readonly string[], identityStore: WaIdentityStore, updatedAtMs: number | undefined, localIdentity?: {
+    readonly address: SignalAddress;
+    readonly pubKey: Uint8Array;
+}, hashLength?: number): Promise<IcdcMeta | null>;
+export declare function injectDeviceListMetadata(message: Proto.IMessage, senderIcdc: IcdcMeta | null, recipientIcdc: IcdcMeta | null): Proto.IMessage;

package/dist/types/message/reporting-token.d.ts

@@ -15,5 +15,4 @@ export interface BuildReportingTokenArtifactsResult {
     readonly reportingTokenContent: Uint8Array;
     readonly reportingTokenKey: Uint8Array;
 }
-export declare function buildReportingTokenNode(input: BuildReportingTokenNodeInput): Promise<BinaryNode | null>;
 export declare function buildReportingTokenArtifacts(input: BuildReportingTokenNodeInput): Promise<BuildReportingTokenArtifactsResult | null>;

package/dist/types/message/types.d.ts

@@ -1,4 +1,4 @@
-import type { MediaKind } from '../media/types';
+import type { Readable } from 'node:stream';
 import type { Proto } from '..';
 import type { BinaryNode } from '../transport/types';
 export interface WaMessagePublishOptions {
@@ -21,18 +21,40 @@ export interface WaMessagePublishResult {
     readonly ackNode: BinaryNode;
     readonly ack: WaMessageAckMetadata;
 }
-export interface WaSendMediaMessage {
-    readonly type: MediaKind;
-    readonly media: Uint8Array | ArrayBuffer;
+type MediaInput = Uint8Array | ArrayBuffer | Readable | string;
+type MediaFieldsFilledByBuilder = 'url' | 'mimetype' | 'fileSha256' | 'fileLength' | 'mediaKey' | 'fileEncSha256' | 'directPath' | 'mediaKeyTimestamp' | 'streamingSidecar' | 'metadataUrl';
+type UserMediaFields<T> = {
+    readonly [K in keyof Omit<T, MediaFieldsFilledByBuilder>]?: T[K];
+};
+interface WaSendMediaBase {
+    readonly media: MediaInput;
     readonly mimetype: string;
-    readonly caption?: string;
-    readonly fileName?: string;
-    readonly ptt?: boolean;
-    readonly gifPlayback?: boolean;
-    readonly seconds?: number;
-    readonly width?: number;
-    readonly height?: number;
+    readonly fileLength?: number;
 }
+interface WaSendMediaBaseOptionalMime {
+    readonly media: MediaInput;
+    readonly mimetype?: string;
+    readonly fileLength?: number;
+}
+interface WaSendImageMessage extends WaSendMediaBase, UserMediaFields<Proto.Message.IImageMessage> {
+    readonly type: 'image';
+}
+interface WaSendVideoMessage extends WaSendMediaBase, UserMediaFields<Proto.Message.IVideoMessage> {
+    readonly type: 'video';
+}
+interface WaSendPtvMessage extends WaSendMediaBase, UserMediaFields<Proto.Message.IVideoMessage> {
+    readonly type: 'ptv';
+}
+interface WaSendAudioMessage extends WaSendMediaBase, UserMediaFields<Proto.Message.IAudioMessage> {
+    readonly type: 'audio';
+}
+interface WaSendDocumentMessage extends WaSendMediaBase, UserMediaFields<Proto.Message.IDocumentMessage> {
+    readonly type: 'document';
+}
+interface WaSendStickerMessage extends WaSendMediaBaseOptionalMime, UserMediaFields<Proto.Message.IStickerMessage> {
+    readonly type: 'sticker';
+}
+export type WaSendMediaMessage = WaSendImageMessage | WaSendVideoMessage | WaSendPtvMessage | WaSendAudioMessage | WaSendDocumentMessage | WaSendStickerMessage;
 export type WaSendMessageContent = string | Proto.IMessage | WaSendMediaMessage;
 export interface WaEncryptedMessageInput {
     readonly to: string;
@@ -43,16 +65,25 @@ export interface WaEncryptedMessageInput {
     readonly encCount?: number;
     readonly id?: string;
     readonly type?: string;
+    readonly edit?: string;
+    readonly mediatype?: string;
     readonly category?: string;
     readonly pushPriority?: string;
     readonly participant?: string;
     readonly deviceFanout?: string;
+    readonly metaNode?: BinaryNode;
 }
 export interface WaSendReceiptInput {
     readonly to: string;
     readonly id: string;
     readonly type?: string;
     readonly participant?: string;
+    readonly recipient?: string;
+    readonly category?: string;
     readonly from?: string;
     readonly t?: string;
+    readonly peerParticipantPn?: string;
+    readonly listIds?: readonly string[];
+    readonly content?: readonly BinaryNode[];
 }
+export {};

package/dist/types/protocol/abprops.d.ts

@@ -0,0 +1,142 @@
+export declare const WA_ABPROPS_PROTOCOL_VERSION = "1";
+export declare const WA_ABPROPS_REFRESH_BOUNDS: Readonly<{
+    readonly MIN_S: 600;
+    readonly MAX_S: 604800;
+    readonly DEFAULT_S: 86400;
+}>;
+export type AbPropType = 'bool' | 'int' | 'string';
+export type AbPropValue = boolean | number | string;
+export interface AbPropConfigEntry {
+    readonly configCode: number;
+    readonly type: AbPropType;
+    readonly defaultValue: AbPropValue;
+}
+export declare const AB_PROP_CONFIGS: Readonly<{
+    readonly syncd_key_max_use_days: AbPropConfigEntry;
+    readonly syncd_wait_for_key_timeout_days: AbPropConfigEntry;
+    readonly syncd_sentinel_timeout_seconds: AbPropConfigEntry;
+    readonly syncd_inline_mutations_max_count: AbPropConfigEntry;
+    readonly syncd_patch_protobuf_max_size: AbPropConfigEntry;
+    readonly syncd_additional_mutations_count: AbPropConfigEntry;
+    readonly syncd_periodic_sync_days: AbPropConfigEntry;
+    readonly syncd_mutation_and_bundle_logging: AbPropConfigEntry;
+    readonly wa_web_enable_syncd_key_persistence_only_after_server_ack: AbPropConfigEntry;
+    readonly web_request_missing_keys_for_removes: AbPropConfigEntry;
+    readonly web_syncd_max_mutations_to_process_during_resume: AbPropConfigEntry;
+    readonly web_syncd_fatal_fields_from_L1104589PRV2: AbPropConfigEntry;
+    readonly web_enable_improved_bulk_merge: AbPropConfigEntry;
+    readonly snapshot_recovery_max_mutations_count_allowed: AbPropConfigEntry;
+    readonly md_syncd_logging_spec_enabled: AbPropConfigEntry;
+    readonly kmp_syncd_engine_crypto_enabled: AbPropConfigEntry;
+    readonly enable_syncd_debug_data_in_patch: AbPropConfigEntry;
+    readonly enable_mention_everyone_syncd_sender: AbPropConfigEntry;
+    readonly username_contact_syncd_support_enable: AbPropConfigEntry;
+    readonly after_read_sending_enabled: AbPropConfigEntry;
+    readonly after_read_fallback_duration: AbPropConfigEntry;
+    readonly after_read_receiver_enabled: AbPropConfigEntry;
+    readonly privacy_token_sending_on_all_1_on_1_messages: AbPropConfigEntry;
+    readonly flows_termination_message_v2_sending_enabled: AbPropConfigEntry;
+    readonly dm_initiator_trigger_groups: AbPropConfigEntry;
+    readonly placeholder_message_resend_maximum_days_limit: AbPropConfigEntry;
+    readonly message_edit_to_message_secret_sender_enabled: AbPropConfigEntry;
+    readonly message_edit_to_message_secret_receiver_enabled: AbPropConfigEntry;
+    readonly top_level_message_secret_check: AbPropConfigEntry;
+    readonly parse_encrypted_dsm_msg_fix: AbPropConfigEntry;
+    readonly rt_sender_dual_encrypted_msg_enabled: AbPropConfigEntry;
+    readonly rt_receiver_dual_encrypted_msg_enabled: AbPropConfigEntry;
+    readonly lid_one_to_one_migration_event_response_force_pn_jid: AbPropConfigEntry;
+    readonly web_anr_async_msg_send_handler: AbPropConfigEntry;
+    readonly message_keys_async_chunk_size: AbPropConfigEntry;
+    readonly synced_message_keys_processing_type: AbPropConfigEntry;
+    readonly limit_sharing_protocol_message_receiver_enabled: AbPropConfigEntry;
+    readonly web_pnless_stanzas: AbPropConfigEntry;
+    readonly wa_nct_token_send_enabled: AbPropConfigEntry;
+    readonly wa_nct_token_syncd_enabled: AbPropConfigEntry;
+    readonly wa_nct_token_history_sync_enabled: AbPropConfigEntry;
+    readonly community_announcement_group_size_limit: AbPropConfigEntry;
+    readonly group_size_limit: AbPropConfigEntry;
+    readonly group_max_subject: AbPropConfigEntry;
+    readonly group_description_length: AbPropConfigEntry;
+    readonly anyone_can_link_to_groups: AbPropConfigEntry;
+    readonly group_call_max_participants: AbPropConfigEntry;
+    readonly group_history_receive: AbPropConfigEntry;
+    readonly group_history_send: AbPropConfigEntry;
+    readonly group_history_settings: AbPropConfigEntry;
+    readonly group_history_settings_query: AbPropConfigEntry;
+    readonly group_history_message_count_limit: AbPropConfigEntry;
+    readonly group_history_message_count_receiver_upper_limit: AbPropConfigEntry;
+    readonly group_history_messages_time_limit_receiver_enforcement_secs: AbPropConfigEntry;
+    readonly group_history_bundle_time_limit_receiver_enforcement_secs: AbPropConfigEntry;
+    readonly group_history_notice_receive: AbPropConfigEntry;
+    readonly group_history_out_of_window_pin_sender: AbPropConfigEntry;
+    readonly group_history_out_of_window_pins_receiver: AbPropConfigEntry;
+    readonly group_history_reporting: AbPropConfigEntry;
+    readonly group_create_add_using_lid_jids: AbPropConfigEntry;
+    readonly group_member_updates_hide_in_thread_enabled: AbPropConfigEntry;
+    readonly group_status_receiver_enabled: AbPropConfigEntry;
+    readonly web_send_invisible_msg_max_group_size: AbPropConfigEntry;
+    readonly web_send_invisible_msg_min_group_size: AbPropConfigEntry;
+    readonly admin_only_mention_everyone_group_size: AbPropConfigEntry;
+    readonly web_abprop_drop_full_history_sync: AbPropConfigEntry;
+    readonly wa_web_history_sync_dynamic_throttling: AbPropConfigEntry;
+    readonly web_e2e_backfill_expire_time: AbPropConfigEntry;
+    readonly history_sync_on_demand: AbPropConfigEntry;
+    readonly history_sync_on_demand_message_count: AbPropConfigEntry;
+    readonly history_sync_on_demand_failure_limit: AbPropConfigEntry;
+    readonly history_sync_on_demand_cooldown_sec: AbPropConfigEntry;
+    readonly history_sync_on_demand_complete_companion: AbPropConfigEntry;
+    readonly history_sync_on_demand_with_android_beta: AbPropConfigEntry;
+    readonly web_anr_throttle_history_sync_db_writes: AbPropConfigEntry;
+    readonly web_force_lid_chats_in_history: AbPropConfigEntry;
+    readonly web_history_sync_allow_duplicate_in_bulk_error: AbPropConfigEntry;
+    readonly default_media_limit_mb: AbPropConfigEntry;
+    readonly web_image_max_edge: AbPropConfigEntry;
+    readonly web_image_max_hd_edge: AbPropConfigEntry;
+    readonly web_channel_video_server_transcode_upload: AbPropConfigEntry;
+    readonly web_deprecate_mms4_hash_based_download: AbPropConfigEntry;
+    readonly kaleidoscope_thumbnail_validation: AbPropConfigEntry;
+    readonly web_use_kaleidoscope_media_check_enabled: AbPropConfigEntry;
+    readonly low_cache_hit_rate_media_types: AbPropConfigEntry;
+    readonly web_anr_async_media_decryption_enabled: AbPropConfigEntry;
+    readonly web_anr_media_chunk_enc_delay_enabled: AbPropConfigEntry;
+    readonly web_media_compute_in_worker_enabled: AbPropConfigEntry;
+    readonly adv_accept_hosted_devices: AbPropConfigEntry;
+    readonly num_days_key_index_list_expiration: AbPropConfigEntry;
+    readonly num_days_before_device_expiry_check: AbPropConfigEntry;
+    readonly web_adv_logout_on_self_device_list_expired: AbPropConfigEntry;
+    readonly md_icdc_hash_length: AbPropConfigEntry;
+    readonly noise_pq_mode: AbPropConfigEntry;
+    readonly tctoken_duration: AbPropConfigEntry;
+    readonly tctoken_num_buckets: AbPropConfigEntry;
+    readonly tctoken_num_buckets_sender: AbPropConfigEntry;
+    readonly tctoken_duration_sender: AbPropConfigEntry;
+    readonly heartbeat_interval_s: AbPropConfigEntry;
+    readonly web_offline_message_processor_timeout_seconds: AbPropConfigEntry;
+    readonly web_offline_resume_wait_for_ping_response_enabled: AbPropConfigEntry;
+    readonly web_offline_resume_wait_for_ping_timeout_seconds: AbPropConfigEntry;
+    readonly web_comms_socket_reconnect_enabled: AbPropConfigEntry;
+    readonly web_resume_optimized_read_receipt_send_interval: AbPropConfigEntry;
+    readonly web_reaction_inactive_receipt: AbPropConfigEntry;
+    readonly lid_status_non_soaked_client_support_enabled: AbPropConfigEntry;
+    readonly s567418_mitigation_enabled: AbPropConfigEntry;
+    readonly web_signal_future_messages_max: AbPropConfigEntry;
+    readonly poll_add_option_enabled: AbPropConfigEntry;
+    readonly poll_add_option_receiving_enabled: AbPropConfigEntry;
+    readonly poll_creator_edit_enabled: AbPropConfigEntry;
+    readonly poll_creator_edit_receiving_version: AbPropConfigEntry;
+    readonly poll_end_time_enabled: AbPropConfigEntry;
+    readonly poll_end_time_receiving_enabled: AbPropConfigEntry;
+    readonly poll_hide_voters_enabled: AbPropConfigEntry;
+    readonly poll_hide_voters_receiving_enabled: AbPropConfigEntry;
+    readonly text_status_ttl_seconds_allowlist: AbPropConfigEntry;
+    readonly username_enabled_on_companion: AbPropConfigEntry;
+    readonly username_max_length: AbPropConfigEntry;
+    readonly username_min_length: AbPropConfigEntry;
+    readonly wa_individual_new_chat_msg_capping_enabled: AbPropConfigEntry;
+    readonly wa_individual_new_chat_msg_capping_limit: AbPropConfigEntry;
+    readonly wa_individual_new_chat_msg_capping_fetch_ttl_seconds: AbPropConfigEntry;
+    readonly enable_web_calling: AbPropConfigEntry;
+    readonly calling_lid_version: AbPropConfigEntry;
+}>;
+export type AbPropName = keyof typeof AB_PROP_CONFIGS;
+export declare function resolveAbPropNameByCode(configCode: number): AbPropName | undefined;

package/dist/types/protocol/appstate.d.ts

@@ -32,17 +32,6 @@ export declare const WA_APP_STATE_KDF_INFO: Readonly<{
     readonly MUTATION_KEYS: "WhatsApp Mutation Keys";
     readonly PATCH_INTEGRITY: "WhatsApp Patch Integrity";
 }>;
-export declare const WA_APP_STATE_CHAT_MUTATION_ACTIONS: Readonly<{
-    readonly STAR: "star";
-    readonly MUTE: "mute";
-    readonly PIN: "pin_v1";
-    readonly ARCHIVE: "archive";
-    readonly DELETE_MESSAGE_FOR_ME: "deleteMessageForMe";
-    readonly MARK_CHAT_AS_READ: "markChatAsRead";
-    readonly CLEAR_CHAT: "clearChat";
-    readonly DELETE_CHAT: "deleteChat";
-    readonly LOCK_CHAT: "lock";
-}>;
 export declare const WA_APP_STATE_CHAT_MUTATION_SPECS: Readonly<{
     readonly STAR: {
         readonly collection: "regular_high";

package/dist/types/protocol/browser.d.ts

@@ -20,3 +20,4 @@ export declare const WA_COMPANION_PLATFORM_IDS: Readonly<{
     readonly OTHER_WEB_CLIENT: "9";
 }>;
 export declare function getWaCompanionPlatformId(browser: string): string;
+export declare function getWaBrowserDisplayName(browser: string): string;

package/dist/types/protocol/constants.d.ts

@@ -1,12 +1,20 @@
 export { getWaCompanionPlatformId, WA_BROWSERS, WA_COMPANION_PLATFORM_IDS } from './browser';
 export { WA_SIGNALING, WA_PAIRING_KDF_INFO } from './auth';
-export { WA_DISCONNECT_REASONS, WA_LOGOUT_REASONS, WA_READY_STATES, WA_STREAM_SIGNALING } from './stream';
+export { WA_CONNECTION_REASONS, WA_DISCONNECT_REASONS, WA_FAILURE_REASONS, WA_LOGOUT_REASONS, WA_READY_STATES, WA_STREAM_SIGNALING } from './stream';
+export type { WaConnectionCode, WaConnectionOpenReason, WaDisconnectReason, WaFailureReasonCode, WaStreamErrorCode } from './stream';
 export { WA_IQ_TYPES, WA_NODE_TAGS, WA_XMLNS } from './nodes';
-export { WA_MESSAGE_TAGS, WA_MESSAGE_TYPES, WA_RETRYABLE_ACK_CODES } from './message';
-export { WA_APP_STATE_COLLECTIONS, WA_APP_STATE_COLLECTION_STATES, WA_APP_STATE_CHAT_MUTATION_ACTIONS, WA_APP_STATE_CHAT_MUTATION_SPECS, WA_APP_STATE_ERROR_CODES, WA_APP_STATE_KDF_INFO, WA_APP_STATE_KEY_TYPES, WA_APP_STATE_SYNC_DATA_TYPE } from './appstate';
+export { WA_EDIT_ATTRS, WA_ENC_MEDIA_TYPES, WA_EVENT_META_TYPES, WA_MESSAGE_TAGS, WA_MESSAGE_TYPES, WA_POLL_META_TYPES, WA_RETRYABLE_ACK_CODES, WA_STANZA_MSG_TYPES } from './message';
+export { WA_APP_STATE_COLLECTIONS, WA_APP_STATE_COLLECTION_STATES, WA_APP_STATE_CHAT_MUTATION_SPECS, WA_APP_STATE_ERROR_CODES, WA_APP_STATE_KDF_INFO, WA_APP_STATE_KEY_TYPES, WA_APP_STATE_SYNC_DATA_TYPE } from './appstate';
 export { getWaMediaHkdfInfo, WA_MEDIA_HKDF_INFO, WA_PREVIEW_MEDIA_HKDF_INFO } from './media';
 export { WA_ACCOUNT_SYNC_PROTOCOLS, WA_DIRTY_PROTOCOLS, WA_DIRTY_TYPES, WA_SUPPORTED_DIRTY_TYPES } from './dirty';
-export { WA_GROUP_NOTIFICATION_TAGS, WA_NOTIFICATION_TYPES } from './notification';
+export { WA_GROUP_NOTIFICATION_TAGS, WA_NOTIFICATION_TYPES, WA_REGISTRATION_NOTIFICATION_TAGS } from './notification';
+export { WA_PRIVACY_TOKEN_NOTIFICATION_TYPE, WA_PRIVACY_TOKEN_TAGS, WA_PRIVACY_TOKEN_TYPES, WA_TC_TOKEN_DEFAULTS } from './privacy-token';
+export { WA_PRIVACY_CATEGORIES, WA_PRIVACY_CATEGORY_TO_SETTING, WA_PRIVACY_DISALLOWED_LIST_CATEGORIES, WA_PRIVACY_SETTING_TO_CATEGORY, WA_PRIVACY_TAGS, WA_PRIVACY_VALUES } from './privacy';
+export type { WaPrivacyCategory, WaPrivacySettingName, WaPrivacyValue } from './privacy';
 export { WA_DEFAULTS } from './defaults';
+export { WA_EMAIL_CONTEXTS, WA_EMAIL_ERROR_CODES, WA_EMAIL_LIMITS, WA_EMAIL_TAGS, WA_EMAIL_XMLNS } from './email';
+export type { WaEmailContext, WaEmailErrorCode } from './email';
+export { AB_PROP_CONFIGS, resolveAbPropNameByCode, WA_ABPROPS_PROTOCOL_VERSION, WA_ABPROPS_REFRESH_BOUNDS } from './abprops';
+export type { AbPropConfigEntry, AbPropName, AbPropType, AbPropValue } from './abprops';
 export { WA_GROUP_PARTICIPANT_TYPES, type WaGroupSetting } from './group';
 export { WA_USYNC_CONTEXTS, WA_USYNC_DEFAULTS, WA_USYNC_MODES } from './usync';

package/dist/types/protocol/defaults.d.ts

@@ -2,6 +2,12 @@ export declare const WA_DEFAULTS: Readonly<{
     readonly HOST_DOMAIN: "s.whatsapp.net";
     readonly GROUP_SERVER: "g.us";
     readonly BROADCAST_SERVER: "broadcast";
+    readonly LID_SERVER: "lid";
+    readonly HOSTED_SERVER: "hosted";
+    readonly HOSTED_LID_SERVER: "hosted.lid";
+    readonly HOSTED_DEVICE_ID: 99;
+    readonly MSGR_SERVER: "msgr";
+    readonly INTEROP_SERVER: "interop";
     readonly DEVICE_BROWSER: "firefox";
     readonly DEVICE_PLATFORM: string;
     readonly CHAT_SOCKET_URLS: readonly ["wss://web.whatsapp.com/ws/chat", "wss://web.whatsapp.com:5222/ws/chat"];

package/dist/types/protocol/email.d.ts

@@ -0,0 +1,32 @@
+export declare const WA_EMAIL_XMLNS = "urn:xmpp:whatsapp:account";
+export declare const WA_EMAIL_TAGS: Readonly<{
+    readonly EMAIL: "email";
+    readonly EMAIL_ADDRESS: "email_address";
+    readonly VERIFY_EMAIL: "verify_email";
+    readonly CONFIRM_EMAIL: "confirm_email";
+    readonly CONTEXT: "context";
+    readonly CODE: "code";
+    readonly LG: "lg";
+    readonly LC: "lc";
+    readonly AUTO_VERIFY: "auto_verify";
+    readonly CONFIRMED: "confirmed";
+}>;
+export declare const WA_EMAIL_CONTEXTS: Readonly<{
+    readonly ONBOARDING: "onboarding";
+    readonly SETTINGS: "settings";
+}>;
+export type WaEmailContext = (typeof WA_EMAIL_CONTEXTS)[keyof typeof WA_EMAIL_CONTEXTS];
+export declare const WA_EMAIL_LIMITS: Readonly<{
+    readonly EMAIL_MAX_LENGTH: 320;
+    readonly CODE_LENGTH: 6;
+    readonly LOCALE_MIN_LENGTH: 2;
+    readonly LOCALE_MAX_LENGTH: 3;
+}>;
+export declare const WA_EMAIL_ERROR_CODES: Readonly<{
+    readonly FORBIDDEN: 403;
+    readonly LOCKOUT: 534;
+    readonly CODE_EXPIRED: 535;
+    readonly CODE_INCORRECT: 536;
+    readonly TOO_MANY_RETRIES: 537;
+}>;
+export type WaEmailErrorCode = (typeof WA_EMAIL_ERROR_CODES)[keyof typeof WA_EMAIL_ERROR_CODES];

package/dist/types/protocol/index.d.ts

@@ -1,3 +1,2 @@
 export * from './constants';
-export { getLoginIdentity, isGroupJid, normalizeDeviceJid, normalizeRecipientJid, parsePhoneJid, parseSignalAddressFromJid, splitJid, toUserJid } from './jid';
-export { WA_USYNC_CONTEXTS, WA_USYNC_DEFAULTS, WA_USYNC_MODES } from './usync';
+export { buildDeviceJid, canonicalizeSignalJid, canonicalizeSignalServer, getLoginIdentity, isHostedDeviceId, isHostedDeviceJid, isHostedServer, isGroupJid, normalizeDeviceJid, normalizeRecipientJid, parsePhoneJid, parseSignalAddressFromJid, splitJid, signalAddressKey, toUserJid } from './jid';

package/dist/types/protocol/jid.d.ts

@@ -4,13 +4,31 @@ export declare function splitJid(jid: string): {
     readonly server: string;
 };
 export declare function normalizeRecipientJid(to: string): string;
-export declare function isJidType(jid: string, type: string): boolean;
+export declare function isLidJid(jid: string): boolean;
 export declare function isGroupJid(jid: string): boolean;
 export declare function isBroadcastJid(jid: string): boolean;
 export declare function isGroupOrBroadcastJid(jid: string): boolean;
+export interface ParsedJid {
+    readonly address: SignalAddress;
+    readonly userJid: string;
+    readonly normalizedJid: string;
+}
 export declare function parseSignalAddressFromJid(jid: string): SignalAddress;
-export declare function toUserJid(jid: string): string;
+export declare function parseJidFull(jid: string): ParsedJid;
+export declare function canonicalizeSignalServer(server: string, hostDomain?: string): string;
+export declare function canonicalizeSignalJid(jid: string, hostDomain?: string): string;
+export declare function toUserJid(jid: string, options?: {
+    readonly canonicalizeSignalServer?: boolean;
+    readonly hostDomain?: string;
+}): string;
 export declare function normalizeDeviceJid(jid: string): string;
+export declare function isHostedDeviceId(deviceId: number): boolean;
+export declare function isHostedServer(server: string): boolean;
+export declare function isHostedDeviceJid(jid: string): boolean;
+export declare function buildDeviceJid(user: string, normalizedServer: string, deviceId: number, options?: {
+    readonly rawServer?: string;
+    readonly isHosted?: boolean;
+}): string;
 export declare function getLoginIdentity(meJid: string): {
     readonly username: number;
     readonly device: number;

package/dist/types/protocol/message.d.ts

@@ -11,6 +11,66 @@ export declare const WA_MESSAGE_TYPES: Readonly<{
     readonly ACK_TYPE_ERROR: "error";
     readonly ACK_CLASS_ERROR: "error";
     readonly ACK_CLASS_MESSAGE: "message";
+    readonly RECEIPT_TYPE_DELIVERY: "delivery";
+    readonly RECEIPT_TYPE_SENDER: "sender";
+    readonly RECEIPT_TYPE_INACTIVE: "inactive";
+    readonly RECEIPT_TYPE_READ: "read";
+    readonly RECEIPT_TYPE_READ_SELF: "read-self";
+    readonly RECEIPT_TYPE_PLAYED: "played";
+    readonly RECEIPT_TYPE_PLAYED_SELF: "played-self";
+    readonly RECEIPT_TYPE_HISTORY_SYNC: "hist_sync";
     readonly RECEIPT_TYPE_PEER: "peer_msg";
+    readonly RECEIPT_TYPE_SERVER_ERROR: "server-error";
+    readonly RECEIPT_TYPE_RETRY: "retry";
 }>;
 export declare const WA_RETRYABLE_ACK_CODES: readonly ["408", "429", "500", "503"];
+export declare const WA_STANZA_MSG_TYPES: Readonly<{
+    readonly TEXT: "text";
+    readonly MEDIA: "media";
+    readonly MEDIA_NOTIFY: "medianotify";
+    readonly PAY: "pay";
+    readonly POLL: "poll";
+    readonly REACTION: "reaction";
+    readonly EVENT: "event";
+}>;
+export declare const WA_EDIT_ATTRS: Readonly<{
+    readonly MESSAGE_EDIT: "1";
+    readonly PIN_IN_CHAT: "2";
+    readonly SENDER_REVOKE: "7";
+    readonly ADMIN_REVOKE: "8";
+}>;
+export declare const WA_POLL_META_TYPES: Readonly<{
+    readonly CREATION: "creation";
+    readonly VOTE: "vote";
+    readonly RESULT_SNAPSHOT: "result_snapshot";
+    readonly EDIT: "edit";
+}>;
+export declare const WA_EVENT_META_TYPES: Readonly<{
+    readonly CREATION: "creation";
+    readonly RESPONSE: "response";
+    readonly EDIT: "edit";
+}>;
+export declare const WA_ENC_MEDIA_TYPES: Readonly<{
+    readonly IMAGE: "image";
+    readonly VIDEO: "video";
+    readonly PTV: "ptv";
+    readonly AUDIO: "audio";
+    readonly PTT: "ptt";
+    readonly LOCATION: "location";
+    readonly LIVE_LOCATION: "livelocation";
+    readonly VCARD: "vcard";
+    readonly CONTACT_ARRAY: "contact_array";
+    readonly DOCUMENT: "document";
+    readonly URL: "url";
+    readonly GIF: "gif";
+    readonly STICKER: "sticker";
+    readonly STICKER_PACK: "sticker_pack";
+    readonly LIST: "list";
+    readonly LIST_RESPONSE: "list_response";
+    readonly BUTTON: "button";
+    readonly BUTTON_RESPONSE: "buttons_response";
+    readonly ORDER: "order";
+    readonly PRODUCT: "product";
+    readonly NATIVE_FLOW_RESPONSE: "native_flow_response";
+    readonly GROUP_HISTORY: "group_history";
+}>;

package/dist/types/protocol/nodes.d.ts

@@ -32,6 +32,7 @@ export declare const WA_NODE_TAGS: Readonly<{
     readonly DESCRIPTION: "description";
     readonly MY_ADDONS: "my_addons";
     readonly KEY: "key";
+    readonly OP: "op";
     readonly REGISTRATION: "registration";
     readonly TYPE: "type";
     readonly IDENTITY: "identity";
@@ -61,6 +62,7 @@ export declare const WA_NODE_TAGS: Readonly<{
     readonly EPHEMERAL: "ephemeral";
     readonly MEMBERSHIP_APPROVAL_MODE: "membership_approval_mode";
     readonly GROUP_JOIN: "group_join";
+    readonly ABPROPS: "abprops";
 }>;
 export declare const WA_IQ_TYPES: Readonly<{
     readonly GET: "get";
@@ -78,8 +80,12 @@ export declare const WA_XMLNS: Readonly<{
     readonly PRIVACY: "privacy";
     readonly BLOCKLIST: "blocklist";
     readonly USYNC: "usync";
+    readonly BUSINESS: "w:biz";
+    readonly STATUS: "status";
     readonly GROUPS: "w:g2";
     readonly NEWSLETTER: "newsletter";
     readonly XMPP_PING: "urn:xmpp:ping";
     readonly WHATSAPP_PING: "w:p";
+    readonly ABPROPS: "abt";
+    readonly MEX: "w:mex";
 }>;

package/dist/types/protocol/notification.d.ts

@@ -1,5 +1,13 @@
 export declare const WA_NOTIFICATION_TYPES: Readonly<{
     readonly GROUP: "w:gp2";
+    readonly ENCRYPT: "encrypt";
+    readonly DEVICES: "devices";
+    readonly SERVER: "server";
+    readonly REGISTRATION: "registration";
+}>;
+export declare const WA_REGISTRATION_NOTIFICATION_TAGS: Readonly<{
+    readonly WA_OLD_REGISTRATION: "wa_old_registration";
+    readonly DEVICE_LOGOUT: "device_logout";
 }>;
 export declare const WA_GROUP_NOTIFICATION_TAGS: Readonly<{
     readonly REMOVE: "remove";

package/dist/types/protocol/privacy-token.d.ts

@@ -0,0 +1,17 @@
+export declare const WA_PRIVACY_TOKEN_TYPES: Readonly<{
+    readonly TRUSTED_CONTACT: "trusted_contact";
+}>;
+export declare const WA_PRIVACY_TOKEN_TAGS: Readonly<{
+    readonly TOKENS: "tokens";
+    readonly TOKEN: "token";
+    readonly TC_TOKEN: "tctoken";
+    readonly CS_TOKEN: "cstoken";
+}>;
+export declare const WA_PRIVACY_TOKEN_NOTIFICATION_TYPE = "privacy_token";
+export declare const WA_TC_TOKEN_DEFAULTS: Readonly<{
+    readonly DURATION_S: 604800;
+    readonly NUM_BUCKETS: 4;
+    readonly SENDER_DURATION_S: 604800;
+    readonly SENDER_NUM_BUCKETS: 4;
+    readonly MAX_DURATION_S: 15552000;
+}>;