zapo-js 1.4.0 → 1.5.0

package/dist/esm/transport/node/builders/mobile.js

@@ -0,0 +1,113 @@
+import { proto } from '../../../proto.js';
+import { WA_DEFAULTS } from '../../../protocol/defaults.js';
+import { WA_IQ_TYPES, WA_NODE_TAGS, WA_XMLNS } from '../../../protocol/nodes.js';
+import { buildIqNode } from '../../node/query.js';
+/**
+ * Builds the primary's `<iq type="set" xmlns="md">` carrying `<pair-device>`
+ * with `ref`, `pub-key`, `device-identity`, `key-index-list`, and optional
+ * `client-props`/`pem` children. The `id` is assigned by the send path.
+ */
+export function buildPairDeviceIq(input) {
+    const children = [
+        { tag: WA_NODE_TAGS.REF, attrs: {}, content: input.ref },
+        { tag: WA_NODE_TAGS.PUB_KEY, attrs: {}, content: input.companionNoisePublicKey },
+        { tag: WA_NODE_TAGS.DEVICE_IDENTITY, attrs: {}, content: input.deviceIdentityBytes },
+        {
+            tag: WA_NODE_TAGS.KEY_INDEX_LIST,
+            attrs: { ts: String(input.keyIndexListTimestampSeconds) },
+            content: input.keyIndexListBytes
+        }
+    ];
+    if (input.clientProps) {
+        children.push({
+            tag: WA_NODE_TAGS.CLIENT_PROPS,
+            attrs: {},
+            content: proto.ClientPairingProps.encode({
+                isChatDbLidMigrated: input.clientProps.isChatDbLidMigrated,
+                isSyncdPureLidSession: input.clientProps.isSyncdPureLidSession,
+                isSyncdSnapshotRecoveryEnabled: input.clientProps.isSyncdSnapshotRecoveryEnabled
+            }).finish()
+        });
+    }
+    if (input.pem) {
+        children.push({
+            tag: WA_NODE_TAGS.PEM,
+            attrs: { version: '1', algorithm: 'rsa2048' },
+            content: [
+                { tag: WA_NODE_TAGS.PEM, attrs: {}, content: input.pem.aesGcmKeyBytes },
+                { tag: WA_NODE_TAGS.TTL, attrs: { ts_s: String(input.pem.ttlSeconds) } },
+                { tag: WA_NODE_TAGS.KEY_ID, attrs: {}, content: '1' }
+            ]
+        });
+    }
+    return buildIqNode(WA_IQ_TYPES.SET, WA_DEFAULTS.HOST_DOMAIN, WA_XMLNS.MD, [
+        { tag: WA_NODE_TAGS.PAIR_DEVICE, attrs: {}, content: children }
+    ]);
+}
+/**
+ * Builds the standalone key-index-list publish `<iq>` the primary sends when its
+ * companion set changes.
+ */
+export function buildKeyIndexListPublishIq(input) {
+    return buildIqNode(WA_IQ_TYPES.SET, WA_DEFAULTS.HOST_DOMAIN, WA_XMLNS.MD, [
+        {
+            tag: WA_NODE_TAGS.KEY_INDEX_LIST,
+            attrs: { ts: String(input.timestampSeconds) },
+            content: input.keyIndexListBytes
+        }
+    ]);
+}
+/**
+ * Builds the `remove-companion-device` IQ that unlinks a companion from the
+ * account. The device is identified by its full device jid; `reason` is a
+ * free-form label the server records.
+ */
+export function buildRemoveCompanionDeviceIq(input) {
+    return buildIqNode(WA_IQ_TYPES.SET, WA_DEFAULTS.HOST_DOMAIN, WA_XMLNS.MD, [
+        {
+            tag: WA_NODE_TAGS.REMOVE_COMPANION_DEVICE,
+            attrs: { jid: input.deviceJid, reason: input.reason }
+        }
+    ]);
+}
+/**
+ * Builds the `remove-companion-device` IQ that unlinks EVERY companion in one
+ * stanza: `all="true"` (no `jid`), mirroring the phone's "log out all companion
+ * devices". `excludeHostedCompanion` adds `exclude_hosted_companion="true"` to
+ * spare companions this account itself hosts.
+ */
+export function buildRemoveAllCompanionDevicesIq(input) {
+    const attrs = { all: 'true', reason: input.reason };
+    if (input.excludeHostedCompanion) {
+        attrs.exclude_hosted_companion = 'true';
+    }
+    return buildIqNode(WA_IQ_TYPES.SET, WA_DEFAULTS.HOST_DOMAIN, WA_XMLNS.MD, [
+        { tag: WA_NODE_TAGS.REMOVE_COMPANION_DEVICE, attrs }
+    ]);
+}
+/**
+ * Builds the `primary_hello` IQ the primary sends to drive a link-code (pairing
+ * code) handshake: the code-wrapped primary ephemeral, the primary ADV identity
+ * public key, and the companion's pairing ref.
+ */
+export function buildPrimaryHelloIq(input) {
+    return buildIqNode(WA_IQ_TYPES.SET, WA_DEFAULTS.HOST_DOMAIN, WA_XMLNS.MD, [
+        {
+            tag: WA_NODE_TAGS.LINK_CODE_COMPANION_REG,
+            attrs: { stage: 'primary_hello' },
+            content: [
+                {
+                    tag: WA_NODE_TAGS.LINK_CODE_PAIRING_WRAPPED_PRIMARY_EPHEMERAL_PUB,
+                    attrs: {},
+                    content: input.wrappedPrimaryEphemeralPub
+                },
+                {
+                    tag: WA_NODE_TAGS.PRIMARY_IDENTITY_PUB,
+                    attrs: {},
+                    content: input.primaryIdentityPub
+                },
+                { tag: WA_NODE_TAGS.LINK_CODE_PAIRING_REF, attrs: {}, content: input.ref }
+            ]
+        }
+    ]);
+}

package/dist/esm/transport/noise/WaClientPayload.js

@@ -4,16 +4,21 @@ import { proto } from '../../proto.js';
 import { intToBytes } from '../../util/bytes.js';
 import { WA_VERSION } from '../../version-spec.js';
 function parseVersion(versionBase) {
-    const [p = '2', s = '3000', t = '0'] = versionBase.split('.');
+    const parts = versionBase.split('.');
+    const [p = '2', s = '3000', t = '0'] = parts;
     const primary = Number.parseInt(p, 10);
     const secondary = Number.parseInt(s, 10);
     const tertiary = Number.parseInt(t, 10);
+    const quaternary = parts.length > 3 ? Number.parseInt(parts[3], 10) : undefined;
+    const quinary = parts.length > 4 ? Number.parseInt(parts[4], 10) : undefined;
     if (!Number.isSafeInteger(primary) ||
         !Number.isSafeInteger(secondary) ||
-        !Number.isSafeInteger(tertiary)) {
+        !Number.isSafeInteger(tertiary) ||
+        (quaternary !== undefined && !Number.isSafeInteger(quaternary)) ||
+        (quinary !== undefined && !Number.isSafeInteger(quinary))) {
         throw new Error(`invalid versionBase: ${versionBase}`);
     }
-    return { primary, secondary, tertiary };
+    return { primary, secondary, tertiary, quaternary, quinary };
 }
 let cachedLocale = null;
 function resolveLocale() {
@@ -67,7 +72,7 @@ export function resolveDevicePropsPlatformType(deviceBrowser) {
     }
 }
 function defaultUserAgent(versionBase, deviceOsDisplayName, version) {
-    const { primary, secondary, tertiary } = version ?? parseVersion(versionBase);
+    const { primary, secondary, tertiary, quaternary, quinary } = version ?? parseVersion(versionBase);
     const locale = resolveLocale();
     return {
         platform: proto.ClientPayload.UserAgent.Platform.WEB,
@@ -75,7 +80,9 @@ function defaultUserAgent(versionBase, deviceOsDisplayName, version) {
         appVersion: {
             primary,
             secondary,
-            tertiary
+            tertiary,
+            quaternary,
+            quinary
         },
         mcc: '000',
         mnc: '000',
@@ -89,13 +96,15 @@ function defaultUserAgent(versionBase, deviceOsDisplayName, version) {
     };
 }
 function defaultDeviceProps(versionBase, config, version) {
-    const { primary, secondary, tertiary } = version ?? parseVersion(versionBase);
+    const { primary, secondary, tertiary, quaternary, quinary } = version ?? parseVersion(versionBase);
     return proto.DeviceProps.encode({
         os: config.deviceOsDisplayName ?? process.platform,
         version: {
             primary,
             secondary,
-            tertiary
+            tertiary,
+            quaternary,
+            quinary
         },
         platformType: resolveDevicePropsPlatformType(config.deviceBrowser),
         requireFullSync: config.requireFullSync === true,

package/dist/esm/transport/wa-version-fetcher.js

@@ -0,0 +1,152 @@
+import { toProxyDispatcher } from './proxy.js';
+import { toError } from '../util/primitives.js';
+const DEFAULT_USER_AGENT = 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36';
+const DEFAULT_TIMEOUT_MS = 10000;
+const SW_JS_URL = 'https://web.whatsapp.com/sw.js';
+const CLIENT_REVISION_PATTERN = /\\?"client_revision\\?":\s*(\d+)/;
+/**
+ * Public app-listing page whose markup embeds the current WhatsApp for
+ * Android release. WhatsApp's own `whatsapp.com/android` page only shows a
+ * stale minimum-requirement version, so a mirror that tracks the live
+ * release is used as the default source.
+ */
+const MOBILE_SOURCE_URL = 'https://whatsapp-messenger.en.uptodown.com/android';
+/**
+ * Matches a WhatsApp for Android version. These always start with `2.` and
+ * carry exactly four dotted numeric parts (`2.YY.WW.RR`) - the shape a mobile
+ * session requires in its login payload. The first match on the listing page
+ * is the current release; older releases appear further down the document.
+ */
+const MOBILE_VERSION_PATTERN = /\b(2(?:\.\d{1,4}){3})\b/;
+/**
+ * Fetches `url` with the shared timeout/abort/proxy scaffolding and returns
+ * the response body text. `label` names the source in error messages
+ * (`failed to fetch <label>: ...`, `<label> timed out after ...`).
+ */
+async function fetchSourceText(url, label, defaultHeaders, options) {
+    const timeoutMs = options.timeoutMs ?? DEFAULT_TIMEOUT_MS;
+    const dispatcher = toProxyDispatcher(options.proxy);
+    const fetchImpl = options.fetch ?? fetch;
+    const controller = new AbortController();
+    const timer = setTimeout(() => controller.abort(new Error(`fetch ${label} timed out after ${timeoutMs}ms`)), timeoutMs);
+    timer.unref?.();
+    let onExternalAbort = null;
+    const externalSignal = options.signal;
+    if (externalSignal) {
+        if (externalSignal.aborted) {
+            controller.abort(externalSignal.reason);
+        }
+        else {
+            onExternalAbort = () => controller.abort(externalSignal.reason);
+            externalSignal.addEventListener('abort', onExternalAbort, { once: true });
+        }
+    }
+    try {
+        const headers = {
+            ...defaultHeaders,
+            'user-agent': options.userAgent ?? DEFAULT_USER_AGENT
+        };
+        if (options.headers) {
+            for (const key in options.headers) {
+                headers[key.toLowerCase()] = options.headers[key];
+            }
+        }
+        const init = {
+            method: 'GET',
+            headers,
+            signal: controller.signal
+        };
+        if (dispatcher) {
+            ;
+            init.dispatcher = dispatcher;
+        }
+        let response;
+        try {
+            response = await fetchImpl(url, init);
+        }
+        catch (error) {
+            throw new Error(`failed to fetch ${label}: ${toError(error).message}`);
+        }
+        if (!response.ok) {
+            throw new Error(`failed to fetch ${label}: http ${response.status}`);
+        }
+        return await response.text();
+    }
+    finally {
+        clearTimeout(timer);
+        if (externalSignal && onExternalAbort) {
+            externalSignal.removeEventListener('abort', onExternalAbort);
+        }
+    }
+}
+/**
+ * Fetches the current WhatsApp Web `client_revision` from the public
+ * `sw.js` served by the WhatsApp Web frontend and assembles a
+ * `2.3000.x` version string suitable for `WaClientOptions.version`.
+ *
+ * Use this when the library's hardcoded default starts being rejected by
+ * the server with HTTP 405 / `failure_client_too_old`, and you need to
+ * refresh the version without waiting for a library bump.
+ *
+ * Network failures and parse errors throw; wrap in a `try`/`catch` and
+ * fall back to the hardcoded default.
+ *
+ * @example
+ * const latest = await fetchLatestWaWebVersion()
+ * const client = new WaClient({ store, sessionId, version: latest.version })
+ */
+export async function fetchLatestWaWebVersion(options = {}) {
+    const body = await fetchSourceText(SW_JS_URL, 'sw.js', { 'sec-fetch-site': 'none' }, options);
+    const match = CLIENT_REVISION_PATTERN.exec(body);
+    if (!match?.[1]) {
+        throw new Error('client_revision not found in sw.js response');
+    }
+    const revision = Number.parseInt(match[1], 10);
+    if (!Number.isSafeInteger(revision) || revision <= 0) {
+        throw new Error(`invalid client_revision in sw.js: ${match[1]}`);
+    }
+    return {
+        version: `2.3000.${revision}`,
+        parts: [2, 3000, revision]
+    };
+}
+/**
+ * Fetches the current WhatsApp for Android app version by scraping a public
+ * app-listing page and assembles a `2.26.x.y` version string suitable for
+ * `WaMobileTransportDeviceInfo.appVersion` (the mobile login payload).
+ *
+ * This is the mobile counterpart to {@link fetchLatestWaWebVersion}. The Web
+ * client exposes its `client_revision` in a stable JSON blob (`sw.js`); the
+ * Android app version is only published on app-listing pages, so this reads
+ * HTML and is inherently more layout-dependent. Retarget it with `url` /
+ * `versionPattern` if the default source changes.
+ *
+ * Use this when the app version baked into your `deviceInfo` starts being
+ * rejected by the server as too old, and you need to refresh it without
+ * waiting for a library bump.
+ *
+ * Network failures and parse errors throw; wrap in a `try`/`catch` and fall
+ * back to a known-good hardcoded version.
+ *
+ * @example
+ * const latest = await fetchLatestWaMobileVersion()
+ * const deviceInfo = { ...baseDeviceInfo, appVersion: latest.version }
+ */
+export async function fetchLatestWaMobileVersion(options = {}) {
+    const versionPattern = options.versionPattern ?? MOBILE_VERSION_PATTERN;
+    const body = await fetchSourceText(options.url ?? MOBILE_SOURCE_URL, 'wa-mobile version page', { accept: 'text/html,application/xhtml+xml', 'accept-language': 'en-US,en;q=0.9' }, options);
+    versionPattern.lastIndex = 0;
+    const match = versionPattern.exec(body);
+    if (!match?.[1]) {
+        throw new Error('wa-mobile version not found in page response');
+    }
+    const version = match[1];
+    const parts = version.split('.').map((part) => Number.parseInt(part, 10));
+    if (parts.length !== 4 || parts.some((part) => !Number.isSafeInteger(part) || part < 0)) {
+        throw new Error(`invalid wa-mobile version parsed from page: ${version}`);
+    }
+    return {
+        version,
+        parts: parts
+    };
+}

package/dist/esm/util/index.js

@@ -1,3 +1,4 @@
+export { delay } from './async.js';
 export { base64ToBytes, bytesToBase64, bytesToBase64UrlSafe, bytesToHex, concatBytes, decodeBase64Url, EMPTY_BYTES, hexToBytes, TEXT_DECODER, TEXT_ENCODER, toBytesView, uint8Equal, uint8TimingSafeEqual } from './bytes.js';
 export { asBytes, asNumber, asOptionalBytes, asOptionalNumber, asOptionalString, asString, resolvePositive, toBoolOrUndef } from './coercion.js';
 export { normalizeQueryLimit } from './collections.js';

package/dist/index.d.ts

@@ -4,7 +4,7 @@ export type { WaClientDependencies } from './client/WaClientFactory';
 export type { WaClientEventMap, WaClientOptions, WaClientProxyOptions, WaDownloadMediaOptions, WaHistorySyncChunkEvent, WaHistorySyncOptions, WaWriteBehindOptions } from './client/types';
 export type { WaClientPluginContext, WaClientPluginDefinition } from './client/plugins';
 export type { WaMessageCoordinator } from './client/coordinators/WaMessageCoordinator';
-export type { WaAccountTakeoverNoticeEvent, WaAppStateMutationEvent, WaAppStateMutationSource, WaBusinessEvent, WaBusinessEventAction, WaBusinessProfileResult, WaConnectionEvent, WaGroupEvent, WaGroupEventAction, WaGroupEventLinkedGroup, WaGroupEventMembershipRequest, WaGroupEventParticipant, WaGroupEventSubgroupSuggestion, WaIgnoreKey, WaIgnoreKeyContext, WaIgnoreKeyPredicate, WaIgnoreStanzaKind, WaIncomingAddonEvent, WaIncomingBaseEvent, WaIncomingBotChunkEvent, WaIncomingCallEvent, WaIncomingChatstateEvent, WaIncomingErrorStanzaEvent, WaIncomingFailureEvent, WaIncomingMessageEvent, WaIncomingMessageKey, WaIncomingNewsletterEvent, WaIncomingNewsletterMessageUpdateEvent, WaIncomingNodeHandler, WaIncomingNodeHandlerRegistration, WaIncomingNotificationEvent, WaIncomingPresenceEvent, WaIncomingProtocolMessageEvent, WaIncomingReceiptEvent, WaIncomingStanzaFilter, WaIncomingUnavailableMessageEvent, WaIncomingUnhandledStanzaEvent, WaMexLidChangeEvent, WaMexMessageCappingEvent, WaMexMessageCappingStatus, WaMexNotificationEvent, WaMexNotificationGraphQlError, WaMexNotificationOperationName, WaMexNotificationUnknownEvent, WaMexOwnUsernameSyncEvent, WaMexTextStatusUpdateEvent, WaMexTextStatusUpdateHintEvent, WaMexUsernameDeleteEvent, WaMexUsernameSetEvent, WaMexUsernameUpdateHintEvent, WaOfflineResumeEvent, WaPictureEvent, WaPictureEventAction, WaPrivacyTokenUpdateEvent, WaReceiptStatus, WaRegistrationCodeEvent, WaSendMessageOptions, WaUnavailableMessageKind, WaVerifiedNameResult, WaAddonKind, WaNewsletterEventAction, WaNewsletterMessageUpdate, WaNewsletterPollVoteEntry, WaNewsletterReactionEntry } from './client/types';
+export type { WaAccountTakeoverNoticeEvent, WaAppStateMutationEvent, WaAppStateMutationSource, WaBusinessEvent, WaBusinessEventAction, WaBusinessProfileResult, WaConnectionEvent, WaGroupEvent, WaGroupEventAction, WaGroupEventLinkedGroup, WaGroupEventMembershipRequest, WaGroupEventParticipant, WaGroupEventSubgroupSuggestion, WaIgnoreKey, WaIgnoreKeyContext, WaIgnoreKeyPredicate, WaIgnoreStanzaKind, WaIncomingAddonEvent, WaIncomingBaseEvent, WaIncomingBotChunkEvent, WaIncomingCallEvent, WaIncomingChatstateEvent, WaIncomingErrorStanzaEvent, WaIncomingFailureEvent, WaIncomingMessageEvent, WaIncomingMessageKey, WaIncomingNewsletterEvent, WaIncomingNewsletterMessageUpdateEvent, WaIncomingNodeHandler, WaIncomingNodeHandlerRegistration, WaIncomingNotificationEvent, WaIncomingPresenceEvent, WaIncomingProtocolMessageEvent, WaIncomingReceiptEvent, WaIncomingStanzaFilter, WaIncomingUnavailableMessageEvent, WaIncomingUnhandledStanzaEvent, WaMexLidChangeEvent, WaMexMessageCappingEvent, WaMexMessageCappingStatus, WaMexNotificationEvent, WaMexNotificationGraphQlError, WaMexNotificationOperationName, WaMexNotificationUnknownEvent, WaMexOwnUsernameSyncEvent, WaMexTextStatusUpdateEvent, WaMexTextStatusUpdateHintEvent, WaMexUsernameDeleteEvent, WaMexUsernameSetEvent, WaMexUsernameUpdateHintEvent, WaOfflineResumeEvent, WaOutgoingMessageEvent, WaPictureEvent, WaPictureEventAction, WaPrivacyTokenUpdateEvent, WaReceiptStatus, WaRegistrationCodeEvent, WaSendMessageOptions, WaUnavailableMessageKind, WaVerifiedNameResult, WaAddonKind, WaNewsletterEventAction, WaNewsletterMessageUpdate, WaNewsletterPollVoteEntry, WaNewsletterReactionEntry } from './client/types';
 export type { WaAppStateMutationCoordinator, WaBroadcastListParticipant, WaSetBroadcastListInput, WaSetStatusPrivacyInput } from './client/coordinators/WaAppStateMutationCoordinator';
 export type { WaBotCoordinator, WaBotInfo, WaBotPosingAsProfessional, WaBotProfileCommand, WaBotProfilePrompt, WaBotProfileResult, WaBotPromptOptions, WaGetBotProfileOptions } from './client/coordinators/WaBotCoordinator';
 export type { WaBroadcastListCoordinator, WaSendBroadcastListMessageInput } from './client/coordinators/WaBroadcastListCoordinator';
@@ -14,6 +14,9 @@ export type { WaDownloadMediaMessageOptions, WaUploadMediaSource } from './clien
 export type { WaEditBusinessProfileInput } from './transport/node/builders/business';
 export type { WaEmailCoordinator, WaEmailStatus, WaEmailVerifyCodeResult } from './client/coordinators/WaEmailCoordinator';
 export type { WaCommunityCreateOptions, WaCommunitySubGroup, WaCommunitySubGroupResult, WaCommunitySubGroupsResult, WaGroupCoordinator, WaGroupCreateOptions, WaGroupMetadata, WaGroupParticipant, WaLinkSubGroupsResult, WaMembershipRequest, WaUnlinkSubGroupsResult } from './client/coordinators/WaGroupCoordinator';
+export type { LinkCompanionResult, WaMobileCoordinator } from './client/coordinators/WaMobileCoordinator';
+export { createFileCompanionHostPersistence } from './client/persistence/companion-host';
+export type { CompanionHostEpochState, CompanionHostPersistence, CompanionRecord } from './client/persistence/companion-host';
 export type { WaNewsletterAdminInfo, WaNewsletterAdminInviteInput, WaNewsletterAdminInviteResult, WaNewsletterAdminProfile, WaNewsletterCapabilityExposure, WaNewsletterCoordinator, WaNewsletterCreateInput, WaNewsletterDehydratedMetadata, WaNewsletterDirectoryCategoriesPreviewOptions, WaNewsletterDirectoryCategoryPreview, WaNewsletterDirectoryListOptions, WaNewsletterDirectoryResults, WaNewsletterDirectorySearchOptions, WaNewsletterDirectoryView, WaNewsletterFetchOptions, WaNewsletterFollower, WaNewsletterFollowersOptions, WaNewsletterFollowersPage, WaNewsletterInsightMetricRequest, WaNewsletterMetadata, WaNewsletterMuteInput, WaNewsletterPicture, WaNewsletterPollVoter, WaNewsletterReactInput, WaNewsletterReactionSenders, WaNewsletterRecommendedOptions, WaNewsletterRevokeInput, WaNewsletterSendOptions, WaNewsletterSendResult, WaNewsletterSimilarOptions, WaNewsletterUpdateInput, WaNewsletterViewReceiptInput, WaNewsletterVotePollInput, WaPageInfo } from './client/coordinators/WaNewsletterCoordinator';
 export type { WaBlocklistResult, WaPrivacyCoordinator, WaPrivacyDisallowedListResult, WaPrivacySettings } from './client/coordinators/WaPrivacyCoordinator';
 export type { WaDisappearingModeResult, WaOwnUsernameResult, WaProfileCoordinator, WaProfileInfo, WaProfilePictureResult, WaProfileStatusResult, WaSetTextStatusInput, WaSetUsernameInput, WaTextStatusResult, WaUsernameResult } from './client/coordinators/WaProfileCoordinator';
@@ -22,7 +25,8 @@ export { parseUsyncResultEnvelope } from './transport/node/builders/usync';
 export type { WaUsyncProtocolError, WaUsyncResultEnvelope } from './transport/node/builders/usync';
 export type { WaSendStatusInput, WaStatusCoordinator } from './client/coordinators/WaStatusCoordinator';
 export type { WaEncryptedMessageInput, WaMessageAckMetadata, WaMessageKey, WaMessagePublishOptions, WaMessagePublishResult, WaMessageRef, WaMessageTargetInput, WaSendEditKey, WaSendEventLocation, WaSendEventMessage, WaSendEventParent, WaSendEventResponseMessage, WaSendEventResponseType, WaSendKeepMessage, WaSendMediaMessage, WaSendMessageContent, WaSendPinMessage, WaSendPollMessage, WaSendPollOptionInput, WaSendPollParent, WaSendPollVoteMessage, WaSendReactionMessage, WaSendReceiptEventOptions, WaSendReceiptInput, WaSendReceiptOptions, WaSendRevokeMessage, WaSendStickerPackMessage, WaSendStickerPackStickerInput, WaSendStickerPackTrayIcon, WaSendTextMessage } from './message/types';
-export { getContentType, resolveMessageTarget } from './message/encode/content';
+export { getContentType, resolveEncMediaType, resolveMessageTarget, unwrapMessage } from './message/encode/content';
+export { getContextInfo } from './message/context-info';
 export { resolveMediaPayload } from './message/encode/media-payload';
 export { unpadPkcs7, writeRandomPadMax16 } from './message/encode/padding';
 export type { WaResolvedMediaPayload } from './message/encode/media-payload';
@@ -32,16 +36,18 @@ export type { SignalLidSyncResult } from './signal/api/SignalDeviceSyncApi';
 export type { WaAuthCredentials, WaVersionResolver } from './auth/types';
 export type { WaShortcakeAssertionSigner } from './auth/pairing/WaShortcakeFlow';
 export type { BinaryNode } from './transport/types';
-export { fetchLatestWaWebVersion } from './transport/wa-web-version-fetcher';
-export type { WaFetchLatestWebVersionOptions, WaLatestWebVersion } from './transport/wa-web-version-fetcher';
+export { fetchLatestWaWebVersion, fetchLatestWaMobileVersion } from './transport/wa-version-fetcher';
+export type { WaFetchVersionOptions, WaFetchLatestWebVersionOptions, WaFetchLatestMobileVersionOptions, WaLatestWebVersion, WaLatestMobileVersion } from './transport/wa-version-fetcher';
 export { ConsoleLogger } from './infra/log/ConsoleLogger';
 export { PinoLogger, createPinoLogger } from './infra/log/PinoLogger';
 export type { PinoLoggerOptions } from './infra/log/PinoLogger';
 export { createNoopLogger } from './infra/log/types';
 export type { Logger, LogLevel } from './infra/log/types';
+export { WA_VERSION } from './version-spec';
 export { createStore, WaAuthMemoryStore } from './store';
 export type { WaAppStateCollectionStoreState, WaAppStateStore, WaAuthStore, WaContactStore, WaCreateStoreOptions, WaCreateStoreOptionsStrict, WaDeviceListSnapshot, WaDeviceListStore, WaGroupMetadataSnapshot, WaGroupMetadataStore, WaMessageStore, WaRetryStore, WaSenderKeyStore, WaSessionStore, WaSignalStore, WaIdentityStore, WaPreKeyStore, WaStoredContactRecord, WaStoredMessageRecord, WaStoredThreadRecord, WaStore, WaStoreBackend, WaStoreSession, WaThreadStore } from './store';
 export { delay } from './util/async';
 export { buildDeviceJid, canonicalizeSignalJid, canonicalizeSignalServer, getLoginIdentity, getWaCompanionPlatformId, getWaMediaHkdfInfo, isBotJid, isBroadcastJid, isGroupJid, isGroupOrBroadcastJid, isHostedDeviceId, isHostedDeviceJid, isHostedServer, isLidJid, isNewsletterJid, isStatusBroadcastJid, isUserJid, normalizeDeviceJid, normalizeRecipientJid, parseJidFull, parsePhoneJid, parseSignalAddressFromJid, signalAddressKey, splitJid, toUserJid, WA_ACCOUNT_SYNC_PROTOCOLS, WA_APP_STATE_COLLECTIONS, WA_APP_STATE_COLLECTION_STATES, WA_APP_STATE_ERROR_CODES, WA_APP_STATE_KDF_INFO, WA_APP_STATE_KEY_TYPES, WA_APP_STATE_SYNC_DATA_TYPE, WA_BROWSERS, WA_BUSINESS_HOURS_DAYS, WA_BUSINESS_HOURS_MODES, WA_COMPANION_PLATFORM_IDS, WA_DEFAULTS, WA_DIRTY_PROTOCOLS, WA_DIRTY_TYPES, WA_DISCONNECT_REASONS, WA_IQ_TYPES, WA_LOGOUT_REASONS, WA_MESSAGE_TAGS, WA_MESSAGE_TYPES, WA_MEDIA_HKDF_INFO, WA_NODE_TAGS, WA_PAIRING_KDF_INFO, WA_PREVIEW_MEDIA_HKDF_INFO, WA_READY_STATES, WA_RETRYABLE_ACK_CODES, WA_SIGNALING, WA_STREAM_SIGNALING, WA_SUPPORTED_DIRTY_TYPES, WA_PRIVACY_CATEGORIES, WA_PRIVACY_CATEGORY_TO_SETTING, WA_PRIVACY_DISALLOWED_LIST_CATEGORIES, WA_PRIVACY_SETTING_TO_CATEGORY, WA_PRIVACY_TAGS, WA_PRIVACY_VALUES, WA_XMLNS } from './protocol';
 export type { ParsedJid, WaBusinessHoursDay, WaBusinessHoursMode, WaConnectionCode, WaConnectionOpenReason, WaDisconnectReason, WaFailureReasonCode, WaLogoutReason, WaPrivacyCategory, WaPrivacySettingName, WaPrivacyValue, WaStreamErrorCode } from './protocol';
 export { proto } from './proto';
+export type { Proto } from './proto';

package/dist/index.js

@@ -1,25 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WA_BROWSERS = exports.WA_APP_STATE_SYNC_DATA_TYPE = exports.WA_APP_STATE_KEY_TYPES = exports.WA_APP_STATE_KDF_INFO = exports.WA_APP_STATE_ERROR_CODES = exports.WA_APP_STATE_COLLECTION_STATES = exports.WA_APP_STATE_COLLECTIONS = exports.WA_ACCOUNT_SYNC_PROTOCOLS = exports.toUserJid = exports.splitJid = exports.signalAddressKey = exports.parseSignalAddressFromJid = exports.parsePhoneJid = exports.parseJidFull = exports.normalizeRecipientJid = exports.normalizeDeviceJid = exports.isUserJid = exports.isStatusBroadcastJid = exports.isNewsletterJid = exports.isLidJid = exports.isHostedServer = exports.isHostedDeviceJid = exports.isHostedDeviceId = exports.isGroupOrBroadcastJid = exports.isGroupJid = exports.isBroadcastJid = exports.isBotJid = exports.getWaMediaHkdfInfo = exports.getWaCompanionPlatformId = exports.getLoginIdentity = exports.canonicalizeSignalServer = exports.canonicalizeSignalJid = exports.buildDeviceJid = exports.delay = exports.WaAuthMemoryStore = exports.createStore = exports.createNoopLogger = exports.createPinoLogger = exports.PinoLogger = exports.ConsoleLogger = exports.fetchLatestWaWebVersion = exports.writeRandomPadMax16 = exports.unpadPkcs7 = exports.resolveMediaPayload = exports.resolveMessageTarget = exports.getContentType = exports.parseUsyncResultEnvelope = exports.downloadMediaMessage = exports.defineWaClientPlugin = exports.WaClient = void 0;
-exports.proto = exports.WA_XMLNS = exports.WA_PRIVACY_VALUES = exports.WA_PRIVACY_TAGS = exports.WA_PRIVACY_SETTING_TO_CATEGORY = exports.WA_PRIVACY_DISALLOWED_LIST_CATEGORIES = exports.WA_PRIVACY_CATEGORY_TO_SETTING = exports.WA_PRIVACY_CATEGORIES = exports.WA_SUPPORTED_DIRTY_TYPES = exports.WA_STREAM_SIGNALING = exports.WA_SIGNALING = exports.WA_RETRYABLE_ACK_CODES = exports.WA_READY_STATES = exports.WA_PREVIEW_MEDIA_HKDF_INFO = exports.WA_PAIRING_KDF_INFO = exports.WA_NODE_TAGS = exports.WA_MEDIA_HKDF_INFO = exports.WA_MESSAGE_TYPES = exports.WA_MESSAGE_TAGS = exports.WA_LOGOUT_REASONS = exports.WA_IQ_TYPES = exports.WA_DISCONNECT_REASONS = exports.WA_DIRTY_TYPES = exports.WA_DIRTY_PROTOCOLS = exports.WA_DEFAULTS = exports.WA_COMPANION_PLATFORM_IDS = exports.WA_BUSINESS_HOURS_MODES = exports.WA_BUSINESS_HOURS_DAYS = void 0;
+exports.WA_APP_STATE_COLLECTIONS = exports.WA_ACCOUNT_SYNC_PROTOCOLS = exports.toUserJid = exports.splitJid = exports.signalAddressKey = exports.parseSignalAddressFromJid = exports.parsePhoneJid = exports.parseJidFull = exports.normalizeRecipientJid = exports.normalizeDeviceJid = exports.isUserJid = exports.isStatusBroadcastJid = exports.isNewsletterJid = exports.isLidJid = exports.isHostedServer = exports.isHostedDeviceJid = exports.isHostedDeviceId = exports.isGroupOrBroadcastJid = exports.isGroupJid = exports.isBroadcastJid = exports.isBotJid = exports.getWaMediaHkdfInfo = exports.getWaCompanionPlatformId = exports.getLoginIdentity = exports.canonicalizeSignalServer = exports.canonicalizeSignalJid = exports.buildDeviceJid = exports.delay = exports.WaAuthMemoryStore = exports.createStore = exports.WA_VERSION = exports.createNoopLogger = exports.createPinoLogger = exports.PinoLogger = exports.ConsoleLogger = exports.fetchLatestWaMobileVersion = exports.fetchLatestWaWebVersion = exports.writeRandomPadMax16 = exports.unpadPkcs7 = exports.resolveMediaPayload = exports.getContextInfo = exports.unwrapMessage = exports.resolveMessageTarget = exports.resolveEncMediaType = exports.getContentType = exports.parseUsyncResultEnvelope = exports.createFileCompanionHostPersistence = exports.downloadMediaMessage = exports.defineWaClientPlugin = exports.WaClient = void 0;
+exports.proto = exports.WA_XMLNS = exports.WA_PRIVACY_VALUES = exports.WA_PRIVACY_TAGS = exports.WA_PRIVACY_SETTING_TO_CATEGORY = exports.WA_PRIVACY_DISALLOWED_LIST_CATEGORIES = exports.WA_PRIVACY_CATEGORY_TO_SETTING = exports.WA_PRIVACY_CATEGORIES = exports.WA_SUPPORTED_DIRTY_TYPES = exports.WA_STREAM_SIGNALING = exports.WA_SIGNALING = exports.WA_RETRYABLE_ACK_CODES = exports.WA_READY_STATES = exports.WA_PREVIEW_MEDIA_HKDF_INFO = exports.WA_PAIRING_KDF_INFO = exports.WA_NODE_TAGS = exports.WA_MEDIA_HKDF_INFO = exports.WA_MESSAGE_TYPES = exports.WA_MESSAGE_TAGS = exports.WA_LOGOUT_REASONS = exports.WA_IQ_TYPES = exports.WA_DISCONNECT_REASONS = exports.WA_DIRTY_TYPES = exports.WA_DIRTY_PROTOCOLS = exports.WA_DEFAULTS = exports.WA_COMPANION_PLATFORM_IDS = exports.WA_BUSINESS_HOURS_MODES = exports.WA_BUSINESS_HOURS_DAYS = exports.WA_BROWSERS = exports.WA_APP_STATE_SYNC_DATA_TYPE = exports.WA_APP_STATE_KEY_TYPES = exports.WA_APP_STATE_KDF_INFO = exports.WA_APP_STATE_ERROR_CODES = exports.WA_APP_STATE_COLLECTION_STATES = void 0;
 var _client_1 = require("./client");
 Object.defineProperty(exports, "WaClient", { enumerable: true, get: function () { return _client_1.WaClient; } });
 var plugins_1 = require("./client/plugins");
 Object.defineProperty(exports, "defineWaClientPlugin", { enumerable: true, get: function () { return plugins_1.defineWaClientPlugin; } });
 var media_1 = require("./client/media");
 Object.defineProperty(exports, "downloadMediaMessage", { enumerable: true, get: function () { return media_1.downloadMediaMessage; } });
+var companion_host_1 = require("./client/persistence/companion-host");
+Object.defineProperty(exports, "createFileCompanionHostPersistence", { enumerable: true, get: function () { return companion_host_1.createFileCompanionHostPersistence; } });
 var usync_1 = require("./transport/node/builders/usync");
 Object.defineProperty(exports, "parseUsyncResultEnvelope", { enumerable: true, get: function () { return usync_1.parseUsyncResultEnvelope; } });
 var content_1 = require("./message/encode/content");
 Object.defineProperty(exports, "getContentType", { enumerable: true, get: function () { return content_1.getContentType; } });
+Object.defineProperty(exports, "resolveEncMediaType", { enumerable: true, get: function () { return content_1.resolveEncMediaType; } });
 Object.defineProperty(exports, "resolveMessageTarget", { enumerable: true, get: function () { return content_1.resolveMessageTarget; } });
+Object.defineProperty(exports, "unwrapMessage", { enumerable: true, get: function () { return content_1.unwrapMessage; } });
+var context_info_1 = require("./message/context-info");
+Object.defineProperty(exports, "getContextInfo", { enumerable: true, get: function () { return context_info_1.getContextInfo; } });
 var media_payload_1 = require("./message/encode/media-payload");
 Object.defineProperty(exports, "resolveMediaPayload", { enumerable: true, get: function () { return media_payload_1.resolveMediaPayload; } });
 var padding_1 = require("./message/encode/padding");
 Object.defineProperty(exports, "unpadPkcs7", { enumerable: true, get: function () { return padding_1.unpadPkcs7; } });
 Object.defineProperty(exports, "writeRandomPadMax16", { enumerable: true, get: function () { return padding_1.writeRandomPadMax16; } });
-var wa_web_version_fetcher_1 = require("./transport/wa-web-version-fetcher");
-Object.defineProperty(exports, "fetchLatestWaWebVersion", { enumerable: true, get: function () { return wa_web_version_fetcher_1.fetchLatestWaWebVersion; } });
+var wa_version_fetcher_1 = require("./transport/wa-version-fetcher");
+Object.defineProperty(exports, "fetchLatestWaWebVersion", { enumerable: true, get: function () { return wa_version_fetcher_1.fetchLatestWaWebVersion; } });
+Object.defineProperty(exports, "fetchLatestWaMobileVersion", { enumerable: true, get: function () { return wa_version_fetcher_1.fetchLatestWaMobileVersion; } });
 var ConsoleLogger_1 = require("./infra/log/ConsoleLogger");
 Object.defineProperty(exports, "ConsoleLogger", { enumerable: true, get: function () { return ConsoleLogger_1.ConsoleLogger; } });
 var PinoLogger_1 = require("./infra/log/PinoLogger");
@@ -27,6 +34,8 @@ Object.defineProperty(exports, "PinoLogger", { enumerable: true, get: function (
 Object.defineProperty(exports, "createPinoLogger", { enumerable: true, get: function () { return PinoLogger_1.createPinoLogger; } });
 var types_1 = require("./infra/log/types");
 Object.defineProperty(exports, "createNoopLogger", { enumerable: true, get: function () { return types_1.createNoopLogger; } });
+var _version_spec_1 = require("./version-spec");
+Object.defineProperty(exports, "WA_VERSION", { enumerable: true, get: function () { return _version_spec_1.WA_VERSION; } });
 var _store_1 = require("./store");
 Object.defineProperty(exports, "createStore", { enumerable: true, get: function () { return _store_1.createStore; } });
 Object.defineProperty(exports, "WaAuthMemoryStore", { enumerable: true, get: function () { return _store_1.WaAuthMemoryStore; } });

package/dist/message/WaMessageClient.js

@@ -229,7 +229,8 @@ class WaMessageClient {
     }
     extractAckMetadata(ackNode) {
         const addressingModeRaw = ackNode.attrs.addressing_mode;
-        const addressingMode = addressingModeRaw === 'pn' || addressingModeRaw === 'lid'
+        const addressingMode = addressingModeRaw === constants_1.WA_ADDRESSING_MODES.PN ||
+            addressingModeRaw === constants_1.WA_ADDRESSING_MODES.LID
             ? addressingModeRaw
             : undefined;
         return {

package/dist/message/context-info.d.ts

@@ -27,6 +27,8 @@ export declare function applyContextInfo(message: Proto.IMessage, ctx: WaSendCon
  * `undefined` when no submessage has an `expiration` set.
  */
 export declare function pickIncomingExpirationSeconds(message: Proto.IMessage | undefined): number | undefined;
+/** Reads the `contextInfo` off a message's first content submessage (null when absent). */
+export declare function getContextInfo(message: Proto.IMessage): Proto.IContextInfo | null;
 /**
  * Anything that identifies a quoted message. Accepts a {@link WaQuoteRef}, a
  * {@link WaMessageKey} (bare proto key), or a full incoming message event (its

package/dist/message/context-info.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildContextInfoProto = buildContextInfoProto;
 exports.applyContextInfo = applyContextInfo;
 exports.pickIncomingExpirationSeconds = pickIncomingExpirationSeconds;
+exports.getContextInfo = getContextInfo;
 exports.resolveSendContextInfo = resolveSendContextInfo;
 const jid_1 = require("../protocol/jid");
 function buildContextInfoProto(input) {
@@ -91,6 +92,10 @@ function pickContextInfoTarget(message) {
     }
     return null;
 }
+/** Reads the `contextInfo` off a message's first content submessage (null when absent). */
+function getContextInfo(message) {
+    return pickContextInfoTarget(message)?.contextInfo ?? null;
+}
 function resolveSendContextInfo(input) {
     const ctx = {
         ...(input.contentLevel ?? {}),

package/dist/protocol/constants.d.ts

@@ -1,12 +1,14 @@
-export { getWaCompanionPlatformId, WA_BROWSERS, WA_COMPANION_PLATFORM_IDS } from './browser';
+export { getWaBrowserDisplayName, getWaCompanionPlatformId, WA_BROWSERS, WA_COMPANION_PLATFORM_IDS } from './browser';
+export { resolveWaDeviceIdentity } from './device-identity';
+export type { WaDeviceIdentity, WaDeviceIdentityOptions } from './device-identity';
 export { WA_SIGNALING, WA_PAIRING_KDF_INFO } from './auth';
 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, WaLogoutReason, WaStreamErrorCode } from './stream';
 export { WA_IQ_TYPES, WA_NODE_TAGS, WA_XMLNS } from './nodes';
 export { WA_CALL_CHILD_TAGS, WA_CALL_NODE_ATTRS, WA_CALL_PAYLOAD_TAGS, WA_CALL_RECEIPT_PAYLOAD_TAGS } from './call';
 export type { WaCallPayloadTag } from './call';
-export { WA_EDIT_ATTRS, WA_ENC_MEDIA_TYPES, WA_EVENT_META_TYPES, WA_MESSAGE_TAGS, WA_MESSAGE_TYPES, WA_NACK_REASONS, WA_POLL_META_TYPES, WA_RETRYABLE_ACK_CODES, WA_STANZA_MSG_TYPES } from './message';
-export type { WaOutboundReceiptType } from './message';
+export { WA_ADDRESSING_MODES, WA_EDIT_ATTRS, WA_ENC_CIPHERTEXT_TYPES, WA_ENC_MEDIA_TYPES, WA_EVENT_META_TYPES, WA_MESSAGE_TAGS, WA_MESSAGE_TYPES, WA_NACK_REASONS, WA_POLL_META_TYPES, WA_RETRYABLE_ACK_CODES, WA_STANZA_MSG_TYPES } from './message';
+export type { WaAddressingMode, WaEncCiphertextType, WaOutboundReceiptType } from './message';
 export { WA_APP_STATE_COLLECTIONS, WA_APP_STATE_COLLECTION_STATES, 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';
@@ -27,7 +29,7 @@ export { WA_EMAIL_CONTEXTS, WA_EMAIL_ERROR_CODES, WA_EMAIL_LIMITS, WA_EMAIL_TAGS
 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_GROUP_MEMBERSHIP_ACTION_TAGS, WA_GROUP_PARTICIPANT_TYPES, type WaGroupSetting } from './group';
 export { WA_USYNC_CONTEXTS, WA_USYNC_DEFAULTS, WA_USYNC_MODES } from './usync';
 export { WA_NEWSLETTER_FETCH_KEY_TYPES, WA_NEWSLETTER_MUTE_TYPES, WA_NEWSLETTER_MUTE_VALUES, WA_NEWSLETTER_PICTURE_TYPES, WA_NEWSLETTER_RECEIVE_TYPES, WA_NEWSLETTER_ROLES, WA_NEWSLETTER_SEND_TYPES, WA_NEWSLETTER_STATE_TYPES, WA_NEWSLETTER_VERIFICATION_STATES, WA_NEWSLETTER_VIEW_ROLES } from './newsletter';
 export type { WaNewsletterReceiveType, WaNewsletterRole, WaNewsletterSendType, WaNewsletterStateType } from './newsletter';

package/dist/protocol/constants.js

@@ -1,11 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WA_PRESENCE_TYPES = exports.WA_PRESENCE_LAST_SENTINELS = exports.WA_CHATSTATE_MEDIA = exports.WA_BUSINESS_HOURS_MODES = exports.WA_BUSINESS_HOURS_DAYS = exports.WA_REGISTRATION_NOTIFICATION_TAGS = exports.WA_NOTIFICATION_TYPES = exports.WA_NEWSLETTER_NOTIFICATION_TAGS = exports.WA_GROUP_NOTIFICATION_TAGS = exports.WA_BUSINESS_NOTIFICATION_TAGS = exports.WA_SUPPORTED_DIRTY_TYPES = exports.WA_DIRTY_TYPES = exports.WA_DIRTY_PROTOCOLS = exports.WA_ACCOUNT_SYNC_PROTOCOLS = exports.WA_PREVIEW_MEDIA_HKDF_INFO = exports.WA_MEDIA_HKDF_INFO = exports.getWaMediaHkdfInfo = exports.WA_APP_STATE_SYNC_DATA_TYPE = exports.WA_APP_STATE_KEY_TYPES = exports.WA_APP_STATE_KDF_INFO = exports.WA_APP_STATE_ERROR_CODES = exports.WA_APP_STATE_COLLECTION_STATES = exports.WA_APP_STATE_COLLECTIONS = exports.WA_STANZA_MSG_TYPES = exports.WA_RETRYABLE_ACK_CODES = exports.WA_POLL_META_TYPES = exports.WA_NACK_REASONS = exports.WA_MESSAGE_TYPES = exports.WA_MESSAGE_TAGS = exports.WA_EVENT_META_TYPES = exports.WA_ENC_MEDIA_TYPES = exports.WA_EDIT_ATTRS = exports.WA_CALL_RECEIPT_PAYLOAD_TAGS = exports.WA_CALL_PAYLOAD_TAGS = exports.WA_CALL_NODE_ATTRS = exports.WA_CALL_CHILD_TAGS = exports.WA_XMLNS = exports.WA_NODE_TAGS = exports.WA_IQ_TYPES = exports.WA_STREAM_SIGNALING = exports.WA_READY_STATES = exports.WA_LOGOUT_REASONS = exports.WA_FAILURE_REASONS = exports.WA_DISCONNECT_REASONS = exports.WA_CONNECTION_REASONS = exports.WA_PAIRING_KDF_INFO = exports.WA_SIGNALING = exports.WA_COMPANION_PLATFORM_IDS = exports.WA_BROWSERS = exports.getWaCompanionPlatformId = void 0;
-exports.WA_NEWSLETTER_VIEW_ROLES = exports.WA_NEWSLETTER_VERIFICATION_STATES = exports.WA_NEWSLETTER_STATE_TYPES = exports.WA_NEWSLETTER_SEND_TYPES = exports.WA_NEWSLETTER_ROLES = exports.WA_NEWSLETTER_RECEIVE_TYPES = exports.WA_NEWSLETTER_PICTURE_TYPES = exports.WA_NEWSLETTER_MUTE_VALUES = exports.WA_NEWSLETTER_MUTE_TYPES = exports.WA_NEWSLETTER_FETCH_KEY_TYPES = exports.WA_USYNC_MODES = exports.WA_USYNC_DEFAULTS = exports.WA_USYNC_CONTEXTS = exports.WA_GROUP_PARTICIPANT_TYPES = exports.WA_ABPROPS_REFRESH_BOUNDS = exports.WA_ABPROPS_PROTOCOL_VERSION = exports.resolveAbPropNameByCode = exports.AB_PROP_CONFIGS = exports.WA_EMAIL_XMLNS = exports.WA_EMAIL_TAGS = exports.WA_EMAIL_LIMITS = exports.WA_EMAIL_ERROR_CODES = exports.WA_EMAIL_CONTEXTS = exports.WA_STATUS_DISTRIBUTION_SETTINGS = exports.WA_META_NODE_ATTRS_BOT = exports.WA_BOT_NODE_ATTRS = exports.WA_BOT_MSG_SECRET_BYTES = exports.WA_BOT_MSG_EDIT_TYPES = exports.WA_BOT_MSG_BODY_TYPES = exports.WA_BOT_KNOWN_JIDS = exports.WA_BOT_HKDF_INFO = exports.WA_BOT_DEFAULT_CAPABILITIES = exports.WA_BIZ_BOT_TYPES = exports.WA_DEFAULTS = exports.WA_PRIVACY_VALUES = exports.WA_PRIVACY_TAGS = exports.WA_PRIVACY_SETTING_TO_CATEGORY = exports.WA_PRIVACY_DISALLOWED_LIST_CATEGORIES = exports.WA_PRIVACY_CATEGORY_TO_SETTING = exports.WA_PRIVACY_CATEGORIES = exports.WA_TC_TOKEN_DEFAULTS = exports.WA_PRIVACY_TOKEN_TYPES = exports.WA_PRIVACY_TOKEN_TAGS = exports.WA_PRIVACY_TOKEN_NOTIFICATION_TYPE = void 0;
+exports.WA_BUSINESS_HOURS_DAYS = exports.WA_REGISTRATION_NOTIFICATION_TAGS = exports.WA_NOTIFICATION_TYPES = exports.WA_NEWSLETTER_NOTIFICATION_TAGS = exports.WA_GROUP_NOTIFICATION_TAGS = exports.WA_BUSINESS_NOTIFICATION_TAGS = exports.WA_SUPPORTED_DIRTY_TYPES = exports.WA_DIRTY_TYPES = exports.WA_DIRTY_PROTOCOLS = exports.WA_ACCOUNT_SYNC_PROTOCOLS = exports.WA_PREVIEW_MEDIA_HKDF_INFO = exports.WA_MEDIA_HKDF_INFO = exports.getWaMediaHkdfInfo = exports.WA_APP_STATE_SYNC_DATA_TYPE = exports.WA_APP_STATE_KEY_TYPES = exports.WA_APP_STATE_KDF_INFO = exports.WA_APP_STATE_ERROR_CODES = exports.WA_APP_STATE_COLLECTION_STATES = exports.WA_APP_STATE_COLLECTIONS = exports.WA_STANZA_MSG_TYPES = exports.WA_RETRYABLE_ACK_CODES = exports.WA_POLL_META_TYPES = exports.WA_NACK_REASONS = exports.WA_MESSAGE_TYPES = exports.WA_MESSAGE_TAGS = exports.WA_EVENT_META_TYPES = exports.WA_ENC_MEDIA_TYPES = exports.WA_ENC_CIPHERTEXT_TYPES = exports.WA_EDIT_ATTRS = exports.WA_ADDRESSING_MODES = exports.WA_CALL_RECEIPT_PAYLOAD_TAGS = exports.WA_CALL_PAYLOAD_TAGS = exports.WA_CALL_NODE_ATTRS = exports.WA_CALL_CHILD_TAGS = exports.WA_XMLNS = exports.WA_NODE_TAGS = exports.WA_IQ_TYPES = exports.WA_STREAM_SIGNALING = exports.WA_READY_STATES = exports.WA_LOGOUT_REASONS = exports.WA_FAILURE_REASONS = exports.WA_DISCONNECT_REASONS = exports.WA_CONNECTION_REASONS = exports.WA_PAIRING_KDF_INFO = exports.WA_SIGNALING = exports.resolveWaDeviceIdentity = exports.WA_COMPANION_PLATFORM_IDS = exports.WA_BROWSERS = exports.getWaCompanionPlatformId = exports.getWaBrowserDisplayName = void 0;
+exports.WA_NEWSLETTER_VIEW_ROLES = exports.WA_NEWSLETTER_VERIFICATION_STATES = exports.WA_NEWSLETTER_STATE_TYPES = exports.WA_NEWSLETTER_SEND_TYPES = exports.WA_NEWSLETTER_ROLES = exports.WA_NEWSLETTER_RECEIVE_TYPES = exports.WA_NEWSLETTER_PICTURE_TYPES = exports.WA_NEWSLETTER_MUTE_VALUES = exports.WA_NEWSLETTER_MUTE_TYPES = exports.WA_NEWSLETTER_FETCH_KEY_TYPES = exports.WA_USYNC_MODES = exports.WA_USYNC_DEFAULTS = exports.WA_USYNC_CONTEXTS = exports.WA_GROUP_PARTICIPANT_TYPES = exports.WA_GROUP_MEMBERSHIP_ACTION_TAGS = exports.WA_ABPROPS_REFRESH_BOUNDS = exports.WA_ABPROPS_PROTOCOL_VERSION = exports.resolveAbPropNameByCode = exports.AB_PROP_CONFIGS = exports.WA_EMAIL_XMLNS = exports.WA_EMAIL_TAGS = exports.WA_EMAIL_LIMITS = exports.WA_EMAIL_ERROR_CODES = exports.WA_EMAIL_CONTEXTS = exports.WA_STATUS_DISTRIBUTION_SETTINGS = exports.WA_META_NODE_ATTRS_BOT = exports.WA_BOT_NODE_ATTRS = exports.WA_BOT_MSG_SECRET_BYTES = exports.WA_BOT_MSG_EDIT_TYPES = exports.WA_BOT_MSG_BODY_TYPES = exports.WA_BOT_KNOWN_JIDS = exports.WA_BOT_HKDF_INFO = exports.WA_BOT_DEFAULT_CAPABILITIES = exports.WA_BIZ_BOT_TYPES = exports.WA_DEFAULTS = exports.WA_PRIVACY_VALUES = exports.WA_PRIVACY_TAGS = exports.WA_PRIVACY_SETTING_TO_CATEGORY = exports.WA_PRIVACY_DISALLOWED_LIST_CATEGORIES = exports.WA_PRIVACY_CATEGORY_TO_SETTING = exports.WA_PRIVACY_CATEGORIES = exports.WA_TC_TOKEN_DEFAULTS = exports.WA_PRIVACY_TOKEN_TYPES = exports.WA_PRIVACY_TOKEN_TAGS = exports.WA_PRIVACY_TOKEN_NOTIFICATION_TYPE = exports.WA_PRESENCE_TYPES = exports.WA_PRESENCE_LAST_SENTINELS = exports.WA_CHATSTATE_MEDIA = exports.WA_BUSINESS_HOURS_MODES = void 0;
 var browser_1 = require("./browser");
+Object.defineProperty(exports, "getWaBrowserDisplayName", { enumerable: true, get: function () { return browser_1.getWaBrowserDisplayName; } });
 Object.defineProperty(exports, "getWaCompanionPlatformId", { enumerable: true, get: function () { return browser_1.getWaCompanionPlatformId; } });
 Object.defineProperty(exports, "WA_BROWSERS", { enumerable: true, get: function () { return browser_1.WA_BROWSERS; } });
 Object.defineProperty(exports, "WA_COMPANION_PLATFORM_IDS", { enumerable: true, get: function () { return browser_1.WA_COMPANION_PLATFORM_IDS; } });
+var device_identity_1 = require("./device-identity");
+Object.defineProperty(exports, "resolveWaDeviceIdentity", { enumerable: true, get: function () { return device_identity_1.resolveWaDeviceIdentity; } });
 var auth_1 = require("./auth");
 Object.defineProperty(exports, "WA_SIGNALING", { enumerable: true, get: function () { return auth_1.WA_SIGNALING; } });
 Object.defineProperty(exports, "WA_PAIRING_KDF_INFO", { enumerable: true, get: function () { return auth_1.WA_PAIRING_KDF_INFO; } });
@@ -26,7 +29,9 @@ Object.defineProperty(exports, "WA_CALL_NODE_ATTRS", { enumerable: true, get: fu
 Object.defineProperty(exports, "WA_CALL_PAYLOAD_TAGS", { enumerable: true, get: function () { return call_1.WA_CALL_PAYLOAD_TAGS; } });
 Object.defineProperty(exports, "WA_CALL_RECEIPT_PAYLOAD_TAGS", { enumerable: true, get: function () { return call_1.WA_CALL_RECEIPT_PAYLOAD_TAGS; } });
 var message_1 = require("./message");
+Object.defineProperty(exports, "WA_ADDRESSING_MODES", { enumerable: true, get: function () { return message_1.WA_ADDRESSING_MODES; } });
 Object.defineProperty(exports, "WA_EDIT_ATTRS", { enumerable: true, get: function () { return message_1.WA_EDIT_ATTRS; } });
+Object.defineProperty(exports, "WA_ENC_CIPHERTEXT_TYPES", { enumerable: true, get: function () { return message_1.WA_ENC_CIPHERTEXT_TYPES; } });
 Object.defineProperty(exports, "WA_ENC_MEDIA_TYPES", { enumerable: true, get: function () { return message_1.WA_ENC_MEDIA_TYPES; } });
 Object.defineProperty(exports, "WA_EVENT_META_TYPES", { enumerable: true, get: function () { return message_1.WA_EVENT_META_TYPES; } });
 Object.defineProperty(exports, "WA_MESSAGE_TAGS", { enumerable: true, get: function () { return message_1.WA_MESSAGE_TAGS; } });
@@ -102,6 +107,7 @@ Object.defineProperty(exports, "resolveAbPropNameByCode", { enumerable: true, ge
 Object.defineProperty(exports, "WA_ABPROPS_PROTOCOL_VERSION", { enumerable: true, get: function () { return abprops_1.WA_ABPROPS_PROTOCOL_VERSION; } });
 Object.defineProperty(exports, "WA_ABPROPS_REFRESH_BOUNDS", { enumerable: true, get: function () { return abprops_1.WA_ABPROPS_REFRESH_BOUNDS; } });
 var group_1 = require("./group");
+Object.defineProperty(exports, "WA_GROUP_MEMBERSHIP_ACTION_TAGS", { enumerable: true, get: function () { return group_1.WA_GROUP_MEMBERSHIP_ACTION_TAGS; } });
 Object.defineProperty(exports, "WA_GROUP_PARTICIPANT_TYPES", { enumerable: true, get: function () { return group_1.WA_GROUP_PARTICIPANT_TYPES; } });
 var usync_1 = require("./usync");
 Object.defineProperty(exports, "WA_USYNC_CONTEXTS", { enumerable: true, get: function () { return usync_1.WA_USYNC_CONTEXTS; } });

package/dist/protocol/device-identity.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Raw device-identity inputs a caller may set. Any field left unset is filled
+ * with the same default the client uses, so callers that resolve identity
+ * independently (e.g. the WAM analytics plugin) stay consistent with the
+ * pairing `ClientPayload`.
+ */
+export interface WaDeviceIdentityOptions {
+    readonly deviceBrowser?: string;
+    readonly deviceOsDisplayName?: string;
+    readonly devicePlatform?: string;
+}
+/** Fully-resolved device identity advertised to WhatsApp. */
+export interface WaDeviceIdentity {
+    readonly browser: string;
+    readonly osDisplayName: string;
+    readonly platform: string;
+}
+/**
+ * Resolves the device identity from raw options, applying the shared defaults:
+ * browser falls back to {@link WA_DEFAULTS}.DEVICE_BROWSER, OS name to the
+ * detected runtime OS, and platform id is inferred from the browser. This is
+ * the single source of truth used by both the client factory and the auth
+ * client so the pairing payload and any analytics/telemetry agree.
+ */
+export declare function resolveWaDeviceIdentity(options: WaDeviceIdentityOptions): WaDeviceIdentity;

package/dist/protocol/device-identity.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveWaDeviceIdentity = resolveWaDeviceIdentity;
+const browser_1 = require("./browser");
+const defaults_1 = require("./defaults");
+const runtime_1 = require("../util/runtime");
+/**
+ * Resolves the device identity from raw options, applying the shared defaults:
+ * browser falls back to {@link WA_DEFAULTS}.DEVICE_BROWSER, OS name to the
+ * detected runtime OS, and platform id is inferred from the browser. This is
+ * the single source of truth used by both the client factory and the auth
+ * client so the pairing payload and any analytics/telemetry agree.
+ */
+function resolveWaDeviceIdentity(options) {
+    const browser = options.deviceBrowser ?? defaults_1.WA_DEFAULTS.DEVICE_BROWSER;
+    return Object.freeze({
+        browser,
+        osDisplayName: options.deviceOsDisplayName ?? (0, runtime_1.getRuntimeOsDisplayName)(),
+        platform: options.devicePlatform ?? (0, browser_1.getWaCompanionPlatformId)(browser)
+    });
+}

package/dist/protocol/group.d.ts

@@ -3,4 +3,10 @@ export declare const WA_GROUP_PARTICIPANT_TYPES: Readonly<{
     readonly ADMIN: "admin";
     readonly REGULAR: "participant";
 }>;
+/** `<membership_requests_action>` child tags for approving/rejecting group join requests. */
+export declare const WA_GROUP_MEMBERSHIP_ACTION_TAGS: Readonly<{
+    readonly REQUESTS_ACTION: "membership_requests_action";
+    readonly APPROVE: "approve";
+    readonly REJECT: "reject";
+}>;
 export type WaGroupSetting = 'announcement' | 'restrict' | 'ephemeral' | 'membership_approval_mode' | 'allow_non_admin_sub_group_creation' | 'group_history' | 'allow_admin_reports' | 'no_frequently_forwarded';