@oxidezap/whatsapp-rust-bridge 0.18.0 → 0.20.0

package/dist/whatsapp_rust_bridge.d.ts

@@ -116,6 +116,19 @@ export interface AppStateSyncKey {
     timestamp: number | string;
 }
 
+/** Why, and with what, a session connected without a freshly resolved version.  Only the browser version source falls back this way; see the source constants in the client crate's `version` module for the reason. */
+export interface AppVersionFallback {
+    /** The version the session actually connected with. */
+    version: [number, number, number];
+    /** True when that version is the one compiled into this library, so its staleness is the release's age. False when the device already carried a different one, whose provenance this does not claim to know: it may have been resolved earlier or supplied by the caller. */
+    compiled_default: boolean;
+    /** What stopped the resolution. Worth distinguishing, because one is routine and the other is news. */
+    reason: AppVersionFallbackReason;
+}
+
+/** Why a version could not be resolved. */
+export type AppVersionFallbackReason = "SourceUnreachable" | "SourceUnparsable";
+
 export interface ArchiveUpdate {
     /** The chat being archived or unarchived. */
     jid: Jid;
@@ -346,6 +359,12 @@ export interface ConnectFailure {
 /** Wire codes: 400=Generic, 401=LoggedOut, 402=TempBanned, 403=AccountLocked, 406=UnknownLogout, 405=ClientOutdated, 409=BadUserAgent, 413=CatExpired, 414=CatInvalid, 415=NotFound, 418=ClientUnknown, 500=InternalServerError, 501=Experimental, 503=ServiceUnavailable */
 export type ConnectFailureReason = number;
 
+/** The session is authenticated and has asked the server to leave passive mode.  That request is best effort: a failure to go active is logged and the connection is announced anyway, on the same reasoning as below, so treat this as "the client believes stanzas should be flowing" rather than a guarantee that the server agrees.  After a fresh pairing the client waits for the critical app-state collections before publishing this, so the push name and blocklist are normally in place by now. It waits, but it does not withhold: a critical collection the server refused or could not deliver is reported as [`AppStateSyncFailed`] and the connection is announced regardless, because a session already delivering messages is not one a consumer should be left believing never opened. */
+export interface Connected {
+    /** Present when version resolution could not reach its source and the session connected on the version the device already held. Absent on every normal connect, so `Some` is the whole signal: a consumer that cares can warn, refuse, or pin a version of its own. */
+    app_version_fallback?: AppVersionFallback | null;
+}
+
 /** A contact changed their phone number.  Emitted from `<notification type="contacts"><modify old="..." new="..." old_lid="..." new_lid="..."/>`.  The library updates the global LID-PN cache when both `old_lid` and `new_lid` are present, mirroring `WAWebDBCreateLidPnMappings`. No Signal session is wiped (WA Web `WAWebHandleContactNotification` also leaves sessions intact). Group participant updates arrive via separate `w:gp2` notifications, so per-group caches are not touched here. Consumers can subscribe and refresh their own caches if needed. */
 export interface ContactNumberChanged {
     /** Old phone number JID. */
@@ -480,21 +499,19 @@ export interface DeviceElement {
     lid?: Jid | null;
 }
 
-/** Device information for registry tracking. */
+/** Device information for registry tracking.  Packed into 8 bytes rather than the 16 the obvious three fields occupy: a `u32` device id, an `Option<u32>` key index and a `bool` carry 5 bytes of information and 11 bytes of alignment padding, and a device registry holds one of these per device per known contact. The device id is a `u16` because that is what it is on the wire — [`Jid::device`] has always been one — and the hosted flag and the key index's presence share one byte.  Serialized as the `{device_id, key_index, is_hosted}` object the previous layout wrote, so stored device-list blobs are unchanged in both directions. */
 export interface DeviceInfo {
-    /** The device ID (0 = primary device, 1+ = companion devices) */
     device_id: number;
-    /** The key index, if known */
+    /** Meaningful only when [`Self::HAS_KEY_INDEX`] is set. */
     key_index?: number | null;
-    /** Whether the device uses the hosted PN/LID address space. */
     is_hosted: boolean;
 }
 
-/** Device list record matching WhatsApp Web's DeviceListRecord structure. */
+/** Device list record matching WhatsApp Web's DeviceListRecord structure.  Serialized through a private shadow struct whose fields are the `String`, `Vec` and `Option<String>` the previous layout used. Deriving serde on the compact fields directly would stamp a second set of `Box<[T]>` and `Option<Box<str>>` codecs into every crate that persists a record, for a blob that is byte-for-byte the same either way. */
 export interface DeviceListRecord {
-    /** The user part of the JID (phone number or LID) */
+    /** The user part of the JID (phone number or LID) `Arc<str>`, so the registry cache can key the record by exactly this string instead of allocating a second copy of it: every write stores the record under its own `user`, and the two used to be separate `String` allocations of identical content. */
     user: string;
-    /** List of known devices for this user */
+    /** List of known devices for this user.  Boxed rather than a `Vec`: the list is built once and then read for the life of the cache entry, so the capacity field is dead weight — and worse, `retain_devices_by_key_index` shortens it without releasing the capacity, leaving the dropped devices' slots resident. Mutations go through [`DeviceListRecord::edit_devices`]. */
     devices: DeviceInfo[];
     /** Timestamp when this record was last updated */
     timestamp: number | string;
@@ -706,7 +723,7 @@ export interface GroupInfo {
     addressing_mode: AddressingMode;
     /** Whether this group is a Community Announcement Group (WA Web `isCag`, derived from `default_sub_group`). `None` means the persisted blob predates the field, so the answer is unknown and callers must re-query. */
     is_community_announce?: boolean | null;
-    /** Maps a LID user identifier (the `user` part of the LID JID) to the corresponding phone-number JID. This is used for device queries since LID usync requests may not work reliably. */
+    /** LID→PN mappings, sorted by the LID user part, looked up by binary search. Used for device queries, since LID usync requests may not work reliably.  A sorted slice rather than a `HashMap`: a 1024-member group needs 2048 hashbrown buckets, so roughly half the map's bytes were empty slots, and the entries are read far more often than they are written (member changes arrive on notifications; lookups run once per participant per send). Serialized as the `lid_to_pn_map` object the previous layout wrote, so the persisted `group_metadata` blob is unchanged. */
     lid_to_pn_map: Record<string, Jid>;
 }
 
@@ -717,7 +734,7 @@ export type GroupNotificationAction =
 | { type: "promote"; participants: GroupParticipantInfo[] }
 | { type: "demote"; participants: GroupParticipantInfo[] }
 | { type: "modify"; participants: GroupParticipantInfo[] }
-| { type: "subject"; subject: string; subject_owner?: Jid | null; subject_time?: number | string | null }
+| { type: "subject"; subject: string; subject_owner?: Jid | null; subject_owner_pn?: Jid | null; subject_owner_username?: string | null; subject_time?: number | string | null }
 | { type: "description"; id: string; description?: string | null }
 | { type: "locked"; threshold?: string | null }
 | { type: "unlocked" }
@@ -807,7 +824,7 @@ export interface GroupUpdate {
     is_lid_addressing_mode: boolean;
     /** Whether participant identity information was incomplete in the source stanza. */
     has_incomplete_participant_information: boolean;
-    /** The specific action */
+    /** The specific action.  Boxed, like the `action` of every sync-action payload in this file (`ContactUpdate`, `PinUpdate`, `MuteUpdate`, …): at 288 bytes it made `GroupUpdate` the largest variant of `Event`, and `Event` is what sizes the single `Arc` allocation every dispatch makes, group update or not. */
     action: GroupNotificationAction;
 }
 
@@ -827,6 +844,10 @@ export interface IdentityChange {
 export interface InboundMessage {
     message: import('./proto-types').proto.IMessage;
     info: MessageInfo;
+    /** Ephemeral duration in seconds, from the decrypted message's `contextInfo.expiration`. Lives here rather than on `info` because it is only known after decryption, and `info` is shared with every `<enc>` of the stanza by then: writing it there cost a deep copy of the whole `MessageInfo` on every disappearing-chat message. */
+    ephemeral_expiration?: number | null;
+    /** Parent post key when `message` is a decrypted CAG channel comment (`enc_comment_message`). The inner `Message` proto has no slot for the threading link, so it surfaces here. Boxed: rare. */
+    comment_target?: import('./proto-types').proto.IMessageKey | null;
 }
 
 export interface IncomingCall {
@@ -843,6 +864,8 @@ export interface IncomingCall {
     timestamp: number;
     offline: boolean;
     action: CallAction;
+    /** The rotation the sending device announced on this stanza's `<video>` child, in `0..=3`. Only an `<offer>` and an `<accept>` carry one; `None` everywhere else, and for a stanza whose value was out of range.  A video-from-start peer announces its camera rotation exactly once, in that stanza, and sends no `<video>` of its own until the camera actually turns -- so dropping this leaves every frame of a call from a sideways camera stamped upright.  On the payload rather than inside [`CallAction::Offer`] / [`Accept`]: those variants are plain struct variants, so a new field there breaks every consumer that destructures them without a `..` rest. This struct is `#[non_exhaustive]` with a `bon` builder, which is exactly the shape the `Event` stability policy reserves for a payload that has to grow.  [`Accept`]: CallAction::Accept */
+    video_orientation?: number | null;
     /** Group snapshot embedded in an initial offer or active-call invitation. */
     group?: GroupCallUpdate | null;
 }
@@ -960,6 +983,7 @@ export interface MessageInfo {
     server_id: number;
     /** The envelope's `type` attribute. `None` when the stanza carried none. */
     type?: StanzaMessageType | null;
+    /** The sender's `notify` display name. Inline up to 24 bytes, which covers most names, so a message does not allocate for it. */
     push_name: string;
     timestamp: number;
     category: MessageCategory;
@@ -967,13 +991,14 @@ export interface MessageInfo {
     /** The `mediatype` the stanza's `<enc>` nodes declared, aggregated to one value per message.  A fan-out stanza carries one `<enc>` per device and the attribute is a property of the message, not of a device copy, so the first `<enc>` that carries one wins in the order the client enumerates them: the direct `<enc>` children first, then this device's under `<participants><to>`. Divergent values across a fan-out are not reconciled and the later ones are dropped; a consumer that needs per-node values reads them from [`DecryptedPayload`](crate::types::events::DecryptedPayload).  Those fan-out nodes are a wider source than WA Web's parser, which maps only the direct `<enc>` children. The two agree on every stanza seen so far, since the attribute describes the message and every device copy repeats it, so the wider read only fills the field on a stanza whose direct children carry nothing.  `None` when no `<enc>` carried the attribute. */
     media_type?: EncMediaType | null;
     edit: EditAttribute;
+    /** The `<bot>` child. Boxed: most messages carry none. */
     bot_info?: MsgBotInfo | null;
-    meta_info: MsgMetaInfo;
+    /** The `<meta>` and `<reporting>` children, `None` when the stanza carries neither. Boxed: it is 280 bytes of mostly-absent fields, and every `MessageInfo` is retained per message through the commit batch and every consumer that keeps a message. */
+    meta_info?: MsgMetaInfo | null;
     /** Decoded `<verified_name>` child cert of business senders; the display name is in `.name`. Boxed: most messages carry none. */
     verified_name?: VerifiedName | null;
+    /** Set on a self-fanout of an own outgoing message. Boxed: rare. */
     device_sent_meta?: DeviceSentMeta | null;
-    /** Ephemeral duration in seconds, extracted from `contextInfo.expiration`. */
-    ephemeral_expiration?: number | null;
     /** Whether this message was delivered during offline sync. */
     is_offline: boolean;
     /** Set when this message was recovered via PDO rather than normal decryption. Contains the PDO request message ID. */
@@ -986,8 +1011,6 @@ export interface MessageInfo {
     verified_name_serial?: number | string | null;
     /** Envelope `peer_recipient_pn` attr. Present on companion-device self-synced DM stanzas to identify the peer's PN (so the receipt goes to the right routing target). */
     peer_recipient_pn?: Jid | null;
-    /** Parent post key when the dispatched message is a decrypted CAG channel comment (`enc_comment_message`). The inner `Message` proto has no slot for the threading link, so it surfaces here. */
-    comment_target?: import('./proto-types').proto.IMessageKey | null;
     /** Broadcast-contact-list recipients from `<participants><to jid>` on an incoming broadcast/status stanza. Populated only for broadcasts; used to validate a `deviceSentMessage.phash` (WA Web `validateBclHash`). Empty otherwise. */
     bcl_participants: Jid[];
 }
@@ -1111,7 +1134,7 @@ export interface MuteUpdate {
     from_full_sync: boolean;
 }
 
-/** Wire codes: 421=StaleGroupAddressingMode, 475=NewChatMessagesCapped, 487=ParsingError, 488=UnrecognizedStanza, 489=UnrecognizedStanzaClass, 490=UnrecognizedStanzaType, 491=InvalidProtobuf, 493=InvalidHostedCompanionStanza, 495=MissingMessageSecret, 496=SignalErrorOldCounter, 499=MessageDeletedOnPeer, 500=UnhandledError, 550=UnsupportedAdminRevoke, 551=UnsupportedLIDGroup, 552=DBOperationFailed */
+/** Wire codes: 415=UnsupportedMessage, 421=StaleGroupAddressingMode, 475=NewChatMessagesCapped, 487=ParsingError, 488=UnrecognizedStanza, 489=UnrecognizedStanzaClass, 490=UnrecognizedStanzaType, 491=InvalidProtobuf, 493=InvalidHostedCompanionStanza, 495=MissingMessageSecret, 496=SignalErrorOldCounter, 499=MessageDeletedOnPeer, 500=UnhandledError, 550=UnsupportedAdminRevoke, 551=UnsupportedLIDGroup, 552=DBOperationFailed */
 export type NackReason = number;
 
 /** A newsletter live update notification, typically containing updated reaction counts for one or more messages. */
@@ -1142,6 +1165,14 @@ export interface OfflineSyncCompleted {
     count: number;
 }
 
+/** An offline backlog drain ended without its `<ib><offline>` end marker, because the connection went away first.  This is the counterpart of [`OfflineSyncCompleted`], not a variant of it: the drain did not finish, the client is not caught up, and the remainder of the backlog is still queued server-side. Nothing was lost — an offline message is only acked through the aggregate receipt flush that a *completed* drain performs, so everything undelivered (and the last open batch) is redelivered on the next connection, where a fresh [`OfflineSyncPreview`] announces it.  A consumer that gates "caught up" UI or startup work on [`OfflineSyncCompleted`] should treat this as "not caught up, wait for the next preview" rather than as completion. */
+export interface OfflineSyncInterrupted {
+    /** What the preview announced for this drain. */
+    total: number;
+    /** Offline stanzas processed before the connection ended. Never larger than `total` in practice, but the server owns both numbers, so treat the pair as a progress report rather than an invariant. */
+    delivered: number;
+}
+
 /** `total` is authoritative; the per-kind counts need not sum to it. */
 export interface OfflineSyncPreview {
     total: number;
@@ -1474,6 +1505,8 @@ export interface UsyncBotPrompt {
 
 export interface UsyncBusinessResult {
     verified_name?: VerifiedName | null;
+    /** Phone-number JID the server attaches to `<business>` when the queried user was addressed by LID. It is the only place a username lookup can learn the PN, since such a query never carries one. */
+    pn_jid?: Jid | null;
 }
 
 export interface UsyncContactResult {
@@ -1980,7 +2013,7 @@ interface WasmWhatsAppClient {
 
 /**
  * A catalog product. Only `id` is guaranteed; the server omits rather than
- * blanks, so an absent name is absent, not `\"\"`.
+ * blanks, so an absent name is absent, not `""`.
  */
 export interface ProductResult {
     id: string;
@@ -1990,7 +2023,7 @@ export interface ProductResult {
     url?: string;
     /**
      * The link-shimmed form of `url`, carried alongside it rather than
-     * instead. Which to open is a consumer\'s call.
+     * instead. Which to open is a consumer's call.
      */
     shimmedUrl?: string;
     price?: PriceResult;
@@ -2011,9 +2044,9 @@ export interface ProductResult {
 }
 
 /**
- * A delta on the account\'s own business profile.
+ * A delta on the account's own business profile.
  *
- * Absent means \"leave alone\"; an empty value means \"clear\" (`\"\"` for text,
+ * Absent means "leave alone"; an empty value means "clear" (`""` for text,
  * `[]` for `websites`). The core rejects a delta with nothing set.
  */
 export interface BusinessProfileUpdateInput {
@@ -2045,7 +2078,7 @@ export interface OrderProductResult {
     images: ProductImageResult[];
     /**
      * Empty for a product with no variants. Without it a variant order cannot
-     * be fulfilled: id, name and price are shared across one listing\'s
+     * be fulfilled: id, name and price are shared across one listing's
      * variants.
      */
     variantProperties: VariantPropertyResult[];
@@ -2091,7 +2124,7 @@ export interface ParticipantChangeResult {
 }
 
 /**
- * A postal address, as sent for a product\'s importer of record.
+ * A postal address, as sent for a product's importer of record.
  */
 export interface ImporterAddressResult {
     street1?: string;
@@ -2103,16 +2136,16 @@ export interface ImporterAddressResult {
 }
 
 /**
- * A price, in thousandths of the currency\'s main unit.
+ * A price, in thousandths of the currency's main unit.
  *
  * WhatsApp scales money by 1000, not 100, and the protobuf field is an
  * `int64`. `amount1000` therefore crosses as a **string**: a `number` is exact
  * only below 2^53, and a large order would be silently wrong rather than
- * rejected. Dividing by 1000 for display is the consumer\'s decision.
+ * rejected. Dividing by 1000 for display is the consumer's decision.
  */
 export interface PriceResult {
     /**
-     * Thousandths of one currency unit: `\"1990\"` is 1.99 in `currency`.
+     * Thousandths of one currency unit: `"1990"` is 1.99 in `currency`.
      */
     amount1000: string;
     /**
@@ -2164,6 +2197,11 @@ export interface UserInfoResult {
      * the server returned no device list.
      */
     devices: number[];
+    /**
+     * Meta username, without the display-only `@` prefix. Absent when the
+     * server reported none, which is also how it reports a deleted one.
+     */
+    username?: string;
 }
 
 /**
@@ -2187,7 +2225,7 @@ export interface CommunitySubgroupResult {
 }
 
 /**
- * Allocation churn attributed by whatsapp-rust\'s own `AllocMeter` to tasks
+ * Allocation churn attributed by whatsapp-rust's own `AllocMeter` to tasks
  * spawned for this client. Available in diagnostics builds only.
  */
 export interface CoreAllocationSnapshotResult {
@@ -2222,7 +2260,7 @@ export interface CoreSpanAllocationSnapshot {
 }
 
 /**
- * An admin\'s published profile on a newsletter.
+ * An admin's published profile on a newsletter.
  */
 export interface NewsletterAdminProfileResult {
     id?: string;
@@ -2372,7 +2410,7 @@ export interface ParticipantAddRequestResult {
 
 /**
  * Key of an existing message targeted by `sendReaction` / `sendCommentBytes`.
- * The chat JID comes from the method\'s `jid` argument; `participant` is the
+ * The chat JID comes from the method's `jid` argument; `participant` is the
  * original sender (required for group/status targets).
  */
 export interface TargetMessageKey {
@@ -2389,7 +2427,7 @@ export type MediaType = "image" | "video" | "audio" | "document" | "sticker" | "
 /**
  * Mirrors `device_props.HistorySyncConfig`. Only fields a consumer would
  * realistically tune are exposed individually; partial overrides merge into
- * `wacore::store::default_history_sync_config()` so callers don\'t accidentally
+ * `wacore::store::default_history_sync_config()` so callers don't accidentally
  * drop the WA-Web-aligned support_* claims by setting just one field.
  */
 export interface DeviceHistorySyncConfig {
@@ -2406,7 +2444,7 @@ export interface DeviceHistorySyncConfig {
 
 /**
  * Mirrors `device_props.PlatformType`. The display value the phone shows in
- * \"Linked Devices\" — and the type WhatsApp\'s server uses to decide whether
+ * "Linked Devices" — and the type WhatsApp's server uses to decide whether
  * features like view-once are deliverable as payload or as `absent` stub.
  * Variant names render as `SCREAMING_SNAKE_CASE` in TS to match the proto
  * enum identifiers callers see in WhatsApp documentation / wire dumps.
@@ -2478,7 +2516,7 @@ export interface CommunityLinkFailureResult {
 export interface NewsletterFollowerResult {
     jid: string;
     /**
-     * Withheld by the server when the follower\'s privacy settings hide it.
+     * Withheld by the server when the follower's privacy settings hide it.
      */
     phoneJid?: string;
     displayName?: string;
@@ -2552,10 +2590,10 @@ export interface CatalogResult {
 }
 
 /**
- * One page of a business\'s collections.
+ * One page of a business's collections.
  *
  * Forward cursor only — the collections paging object has no `before`, and
- * the asymmetry with the catalog is the wire\'s, not an oversight.
+ * the asymmetry with the catalog is the wire's, not an oversight.
  */
 export interface CollectionsResult {
     collections: CollectionResult[];
@@ -2586,7 +2624,7 @@ export interface BusinessHoursUpdateInput {
 
 /**
  * Optional Noise-payload overrides applied on top of every preset.
- * Leaving any field `None` preserves wacore\'s default, which matches
+ * Leaving any field `None` preserves wacore's default, which matches
  * WA Web (notably `phoneId` stays unset on the wire).
  */
 export interface ClientProfileOverrides {
@@ -2597,13 +2635,13 @@ export interface ClientProfileOverrides {
 }
 
 /**
- * Options for `getCatalog`. Omitted fields take the core\'s own defaults; no
+ * Options for `getCatalog`. Omitted fields take the core's own defaults; no
  * second default is applied here.
  */
 export interface CatalogOptionsInput {
     limit?: number | undefined;
     /**
-     * Cursor from a previous page\'s `afterCursor`.
+     * Cursor from a previous page's `afterCursor`.
      */
     after?: string | undefined;
     imageWidth?: number | undefined;
@@ -2629,7 +2667,7 @@ export interface CollectionOptionsInput {
 }
 
 /**
- * Per-mode colours for a bot\'s card.
+ * Per-mode colours for a bot's card.
  */
 export interface BotThemeResult {
     mode: string;
@@ -2652,7 +2690,7 @@ export type PresenceStatus = "available" | "unavailable";
  * Public error shape that crosses the WASM→JS boundary.
  *
  * Variants are intentionally flat — no `#[from]` on enum variants, no
- * `#[serde(flatten)]`. Translation from the core\'s typed errors happens in
+ * `#[serde(flatten)]`. Translation from the core's typed errors happens in
  * `From` impls below by walking the source chain. This keeps the JS object
  * shape predictable and the codegen / `Tsify` output simple.
  */
@@ -2696,7 +2734,7 @@ export interface EncryptMediaResult {
  * Result from `fetchNewChatMessageCappingInfo`.
  *
  * Every field is optional because the server omits the ones that do not apply
- * to an account\'s tier. `remainingQuota` is the core\'s own derivation, present
+ * to an account's tier. `remainingQuota` is the core's own derivation, present
  * only when both quota fields are.
  */
 export interface NewChatMessageCappingResult {
@@ -2724,7 +2762,7 @@ export interface FetchStatusResult {
  *
  * Sections arrive as the server grouped them. The core keeps every section
  * because a bot can be carried by a `category` or `featured` section and by no
- * other, so flattening is a consumer\'s decision, not the bridge\'s.
+ * other, so flattening is a consumer's decision, not the bridge's.
  */
 export interface BotListResult {
     version: string;
@@ -2874,6 +2912,28 @@ export interface OrderResult {
     creationTimestamp?: number;
 }
 
+/**
+ * Result from `getUsername`: this account's own Meta username.
+ *
+ * Every field is optional because the server omits the ones that do not
+ * apply. An account with no username at all comes back as `null` from the
+ * method rather than as an all-absent object.
+ */
+export interface OwnUsernameResult {
+    /**
+     * The handle, without the display-only `@` prefix.
+     */
+    username?: string;
+    /**
+     * `ACTIVE` or `RESERVED`.
+     */
+    state?: string;
+    /**
+     * The numeric username key that guards lookups of this account by handle.
+     */
+    key?: string;
+}
+
 /**
  * Result from `groupRequestParticipantsList`.
  */
@@ -2887,7 +2947,7 @@ export interface MembershipRequestResult {
  *
  * Mirrors the core `IsOnWhatsAppResult` so callers get the LID/PN counterpart
  * and business flag from the same usync round trip — no follow-up
- * `fetchUserInfo` IQ needed for the common \"check + enrich\" flow.
+ * `fetchUserInfo` IQ needed for the common "check + enrich" flow.
  */
 export interface IsOnWhatsAppResult {
     jid: string;
@@ -2906,6 +2966,11 @@ export interface IsOnWhatsAppResult {
      * Verified business name from the usync `<business><verified_name>` cert, if any.
      */
     verifiedName?: string;
+    /**
+     * Meta username, without the display-only `@` prefix. Absent when the
+     * server reported none, which is also how it reports a deleted one.
+     */
+    username?: string;
 }
 
 /**
@@ -2978,14 +3043,14 @@ export interface CommunityLinkResult {
 /**
  * Selects which `ClientProfile` preset to use for the noise-handshake
  * `ClientPayload.UserAgent`. Independent of `DeviceProps`: `setDeviceProps`
- * controls the \"Linked Devices\" display on the phone, this controls what
+ * controls the "Linked Devices" display on the phone, this controls what
  * the server sees in the noise layer.
  *
- * Use `{ preset: \'android\', osVersion: \'13\' }` to advertise
+ * Use `{ preset: 'android', osVersion: '13' }` to advertise
  * `UserAgent.platform = ANDROID` with `web_info` omitted.
  *
  * Every variant flattens the [`ClientProfileOverrides`] fields, so the
- * JS literal is flat (e.g. `{ preset: \'web\', phoneId: \'fixed-id\' }`).
+ * JS literal is flat (e.g. `{ preset: 'web', phoneId: 'fixed-id' }`).
  */
 export type ClientProfileInput = ({ preset: "web" } & {} & ClientProfileOverrides) | ({ preset: "android" } & { osVersion: string } & ClientProfileOverrides) | ({ preset: "smbAndroid" } & { osVersion: string } & ClientProfileOverrides) | ({ preset: "ios" } & { osVersion: string } & ClientProfileOverrides) | ({ preset: "macos" } & { osVersion: string } & ClientProfileOverrides) | ({ preset: "windows" } & { osVersion: string } & ClientProfileOverrides);
 
@@ -3033,15 +3098,24 @@ export interface CoverPhotoUploadInput {
 }
 
 /**
- * What the client\'s connection state means for work handed to it now.
+ * What `findByUsername` learned about a Meta username.
  *
- * The core\'s `Reachability`, carried across unflattened. A refused call says
+ * Mirrors the core `UsernameLookup`, which is a three-way answer rather than
+ * an optional user: a username the server confirms but will not resolve
+ * without the account's username key is neither a hit nor a miss.
+ */
+export type UsernameLookupResult = { status: "notFound" } | { status: "keyRequired"; username?: string } | { status: "found"; jid: string; pnJid?: string; username?: string; isBusiness: boolean; verifiedName?: string };
+
+/**
+ * What the client's connection state means for work handed to it now.
+ *
+ * The core's `Reachability`, carried across unflattened. A refused call says
  * what happened to that attempt; this says what the client is, which is the
  * only thing that answers whether asking again is worth it — so it is read
  * when the question comes up rather than stamped onto an error that is a fact
  * about one instant.
  *
- * `unknown` is not one of the core\'s: the enum is `#[non_exhaustive]`, and a
+ * `unknown` is not one of the core's: the enum is `#[non_exhaustive]`, and a
  * state added upstream has no name here yet. Naming the gap beats reporting it
  * as one of its neighbours.
  */
@@ -3082,7 +3156,7 @@ export interface HistorySyncAllocationSnapshot {
     largestCompressedBytes: number;
     largestDecompressedBytes: number;
     /**
-     * Compressed history events waiting in the bridge\'s ordered event queue.
+     * Compressed history events waiting in the bridge's ordered event queue.
      */
     queuedEvents: number;
     queuedCompressedBytes: number;
@@ -3330,7 +3404,7 @@ export interface WasmAllocationSnapshot {
     largestAllocationBytes: number;
     /**
      * Mutually exclusive allocation-site buckets. Core task allocation is a
-     * second measurement through the core\'s `AllocMeter`, exposed on the
+     * second measurement through the core's `AllocMeter`, exposed on the
      * client for cross-checking this host-side scope.
      */
     other: AllocationBucketSnapshot;
@@ -3386,6 +3460,7 @@ export type WhatsAppEvent =
 | { type: 'self_push_name_updated'; data: SelfPushNameUpdated }
 | { type: 'offline_sync_preview'; data: OfflineSyncPreview }
 | { type: 'offline_sync_completed'; data: OfflineSyncCompleted }
+| { type: 'offline_sync_interrupted'; data: OfflineSyncInterrupted }
 | { type: 'dirty_state'; data: { dirty_type: DirtyType; timestamp?: number | null } }
 | { type: 'device_list_update'; data: DeviceListUpdate }
 | { type: 'identity_change'; data: IdentityChange }
@@ -3678,6 +3753,19 @@ export class WasmWhatsAppClient {
      * Fetch user status/about text for one or more JIDs.
      */
     fetchStatus(jids: string[]): Promise<FetchStatusResult[]>;
+    /**
+     * Resolve a Meta username to the account behind it.
+     *
+     * **Experimental.** The core builds the request exactly as WhatsApp Web
+     * does, but no capture of a server answering it backs the implementation,
+     * so a rejection here is not necessarily a bug.
+     *
+     * `username` is the bare handle; a leading `@` is display-only and the
+     * core strips it. `usernameKey` is the account's numeric username key,
+     * which some accounts require before the server discloses an identity at
+     * all — without it the answer is `{ status: "keyRequired" }`.
+     */
+    findByUsername(username: string, username_key?: string | null): Promise<UsernameLookupResult>;
     /**
      * Get the ADV signed device identity (account), if available.
      * Exposes the persisted account identity to credential consumers.
@@ -3763,6 +3851,15 @@ export class WasmWhatsAppClient {
      * query takes neither.
      */
     getUSyncDevices(jids: string[], _use_cache: boolean, _ignore_zero_devices: boolean): Promise<any>;
+    /**
+     * Read this account's own Meta username, its state and its username key.
+     *
+     * `null` means no username is set: the server answers 404 and the core
+     * reads it that way. Only the read is exposed — setting a username or its
+     * key changes the account's identity in a way the server does not undo,
+     * so the core leaves those two MEX operations unwrapped.
+     */
+    getUsername(): Promise<OwnUsernameResult | undefined>;
     /**
      * Join a group using an invite code.
      */
@@ -4579,8 +4676,8 @@ export interface InitOutput {
     readonly decryptPollVotePayload: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number) => void;
     readonly encodeSenderKeyRecordComponents: (a: number, b: number) => void;
     readonly encodeSessionRecordComponents: (a: number, b: number) => void;
-    readonly generateKeyPair: () => number;
-    readonly getEnabledFeatures: () => number;
+    readonly generateKeyPair: (a: number) => void;
+    readonly getEnabledFeatures: (a: number) => void;
     readonly getPublicFromPrivateKey: (a: number, b: number, c: number) => void;
     readonly getWasmAllocationSnapshot: (a: number) => void;
     readonly hasLogger: () => number;
@@ -4629,13 +4726,14 @@ export interface InitOutput {
     readonly wasmwhatsappclient_fetchReachoutTimelock: (a: number) => number;
     readonly wasmwhatsappclient_fetchStatus: (a: number, b: number, c: number) => number;
     readonly wasmwhatsappclient_fetchUserInfo: (a: number, b: number, c: number) => number;
+    readonly wasmwhatsappclient_findByUsername: (a: number, b: number, c: number, d: number, e: number) => number;
     readonly wasmwhatsappclient_getAccount: (a: number) => number;
     readonly wasmwhatsappclient_getBotList: (a: number) => number;
     readonly wasmwhatsappclient_getBusinessProfile: (a: number, b: number, c: number) => number;
     readonly wasmwhatsappclient_getCatalog: (a: number, b: number, c: number, d: number) => number;
     readonly wasmwhatsappclient_getCollections: (a: number, b: number, c: number, d: number) => number;
     readonly wasmwhatsappclient_getCommunitySubgroups: (a: number, b: number, c: number) => number;
-    readonly wasmwhatsappclient_getCoreAllocationSnapshot: (a: number) => number;
+    readonly wasmwhatsappclient_getCoreAllocationSnapshot: (a: number, b: number) => void;
     readonly wasmwhatsappclient_getGroupMetadata: (a: number, b: number, c: number) => number;
     readonly wasmwhatsappclient_getJid: (a: number) => number;
     readonly wasmwhatsappclient_getLid: (a: number) => number;
@@ -4644,6 +4742,7 @@ export interface InitOutput {
     readonly wasmwhatsappclient_getOrder: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => number;
     readonly wasmwhatsappclient_getPushName: (a: number) => number;
     readonly wasmwhatsappclient_getUSyncDevices: (a: number, b: number, c: number, d: number, e: number) => number;
+    readonly wasmwhatsappclient_getUsername: (a: number) => number;
     readonly wasmwhatsappclient_groupAcceptInvite: (a: number, b: number, c: number) => number;
     readonly wasmwhatsappclient_groupAcceptInviteV4: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => number;
     readonly wasmwhatsappclient_groupFetchAllParticipating: (a: number) => number;
@@ -4698,7 +4797,7 @@ export interface InitOutput {
     readonly wasmwhatsappclient_profilePictureUrl: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
     readonly wasmwhatsappclient_queryNode: (a: number, b: number, c: number, d: number) => number;
     readonly wasmwhatsappclient_queryUsync: (a: number, b: number) => number;
-    readonly wasmwhatsappclient_reachability: (a: number) => number;
+    readonly wasmwhatsappclient_reachability: (a: number, b: number) => void;
     readonly wasmwhatsappclient_readMessages: (a: number, b: number) => number;
     readonly wasmwhatsappclient_reconnect: (a: number) => number;
     readonly wasmwhatsappclient_refreshPreKeys: (a: number, b: number) => number;
@@ -4784,12 +4883,12 @@ export interface InitOutput {
     readonly intounderlyingsink_write: (a: number, b: number) => number;
     readonly intounderlyingsource_cancel: (a: number) => void;
     readonly intounderlyingsource_pull: (a: number, b: number) => number;
-    readonly __wasm_bindgen_func_elem_4417: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_26574: (a: number, b: number, c: number, d: number) => void;
-    readonly __wasm_bindgen_func_elem_26576: (a: number, b: number, c: number, d: number) => void;
-    readonly __wasm_bindgen_func_elem_9408: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_4416: (a: number, b: number, c: number) => void;
-    readonly __wasm_bindgen_func_elem_4415: (a: number, b: number) => void;
+    readonly __wasm_bindgen_func_elem_4571: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_27550: (a: number, b: number, c: number, d: number) => void;
+    readonly __wasm_bindgen_func_elem_27552: (a: number, b: number, c: number, d: number) => void;
+    readonly __wasm_bindgen_func_elem_9675: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_4570: (a: number, b: number, c: number) => void;
+    readonly __wasm_bindgen_func_elem_4569: (a: number, b: number) => void;
     readonly __wbindgen_export: (a: number, b: number) => number;
     readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
     readonly __wbindgen_export3: (a: number) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@oxidezap/whatsapp-rust-bridge",
-    "version": "0.18.0",
+    "version": "0.20.0",
     "description": "A high-performance utilities for WhatsApp, powered by Rust and WebAssembly.",
     "author": "João Lucas <jlucaso@hotmail.com>",
     "license": "MIT",
@@ -64,6 +64,7 @@
         "@bufbuild/protobuf": "^2.12.0",
         "@types/bun": "^1.3.13",
         "@types/node": "^25.6.0",
+        "pkg-pr-new": "^0.0.88",
         "ts-proto": "^2.11.6",
         "typescript": "^6.0.3"
     },