zapo-js 1.3.0 → 1.5.0

package/dist/esm/client/WaClientFactory.js

@@ -13,6 +13,7 @@ import { WaIncomingNodeCoordinator } from './coordinators/WaIncomingNodeCoordina
 import { createLowLevelCoordinator } from './coordinators/WaLowLevelCoordinator.js';
 import { WaMessageCoordinator } from './coordinators/WaMessageCoordinator.js';
 import { WaMessageDispatchCoordinator } from './coordinators/WaMessageDispatchCoordinator.js';
+import { WaMobileCoordinator } from './coordinators/WaMobileCoordinator.js';
 import { createNewsletterCoordinator } from './coordinators/WaNewsletterCoordinator.js';
 import { WaOfflineResumeCoordinator } from './coordinators/WaOfflineResumeCoordinator.js';
 import { WaPassiveTasksCoordinator } from './coordinators/WaPassiveTasksCoordinator.js';
@@ -38,7 +39,7 @@ import { processNewsletterLiveUpdates } from '../message/kinds/newsletter.js';
 import { handleIncomingMessageAck } from '../message/primitives/incoming.js';
 import { createPeerDataOperationRequester } from '../message/primitives/peer-data-operation.js';
 import { WaMessageClient } from '../message/WaMessageClient.js';
-import { getWaCompanionPlatformId, WA_DEFAULTS, WA_DISCONNECT_REASONS, WA_NEWSLETTER_NOTIFICATION_TAGS, WA_NODE_TAGS, WA_NOTIFICATION_TYPES, WA_PRIVACY_TOKEN_NOTIFICATION_TYPE } from '../protocol/constants.js';
+import { resolveWaDeviceIdentity, WA_DEFAULTS, WA_DISCONNECT_REASONS, WA_NEWSLETTER_NOTIFICATION_TAGS, WA_NODE_TAGS, WA_NOTIFICATION_TYPES, WA_PRIVACY_TOKEN_NOTIFICATION_TYPE } from '../protocol/constants.js';
 import { isNewsletterJid, isOwnAccountJid, parseSignalAddressFromJid, toUserJid } from '../protocol/jid.js';
 import { WA_PRESENCE_TYPES } from '../protocol/presence.js';
 import { createOutboundRetryTracker } from '../retry/tracker.js';
@@ -61,7 +62,6 @@ import { WaNodeTransport } from '../transport/node/WaNodeTransport.js';
 import { isProxyTransport, toProxyAgent } from '../transport/proxy.js';
 import { createServerClock } from '../util/clock.js';
 import { toError } from '../util/primitives.js';
-import { getRuntimeOsDisplayName } from '../util/runtime.js';
 function assertProxyTransport(value, path) {
     if (value === undefined) {
         return;
@@ -85,7 +85,7 @@ function validateProxyOptions(options) {
 }
 export function resolveWaClientBase(options, logger) {
     validateProxyOptions(options);
-    const deviceBrowser = options.deviceBrowser ?? WA_DEFAULTS.DEVICE_BROWSER;
+    const device = resolveWaDeviceIdentity(options);
     const sessionId = options.sessionId.trim();
     if (sessionId.length === 0) {
         throw new Error('sessionId must be a non-empty string');
@@ -94,9 +94,9 @@ export function resolveWaClientBase(options, logger) {
     const normalizedOptions = Object.freeze({
         ...options,
         sessionId,
-        deviceBrowser,
-        deviceOsDisplayName: options.deviceOsDisplayName ?? getRuntimeOsDisplayName(),
-        devicePlatform: options.devicePlatform ?? getWaCompanionPlatformId(deviceBrowser),
+        deviceBrowser: device.browser,
+        deviceOsDisplayName: device.osDisplayName,
+        devicePlatform: device.platform,
         urls: options.urls ?? options.chatSocketUrls ?? WA_DEFAULTS.CHAT_SOCKET_URLS,
         iqTimeoutMs: options.iqTimeoutMs ?? WA_DEFAULTS.IQ_TIMEOUT_MS,
         nodeQueryTimeoutMs: options.nodeQueryTimeoutMs ?? WA_DEFAULTS.NODE_QUERY_TIMEOUT_MS,
@@ -348,7 +348,9 @@ export function buildWaClientDependencies(input) {
                 runtime.emitEvent('auth_paired', { credentials });
                 scheduleReconnectAfterPairing();
             },
-            onError: (error) => runtime.handleError(error)
+            onError: (error) => runtime.handleError(error),
+            onPasskeyRequired: (hasSigner) => runtime.emitEvent('auth_passkey_required', { hasSigner }),
+            signPasskeyAssertion: options.signPasskeyAssertion
         }
     });
     const getCurrentCredentials = authClient.getCurrentCredentials.bind(authClient);
@@ -449,6 +451,7 @@ export function buildWaClientDependencies(input) {
     });
     messageDispatch = new WaMessageDispatchCoordinator({
         logger,
+        emitMessageSend: (event) => runtime.emitEvent('message_send', event),
         messageClient,
         retryTracker,
         sessionResolver,
@@ -585,6 +588,7 @@ export function buildWaClientDependencies(input) {
         serverClock,
         emitSnapshotMutations: options.chatEvents?.emitSnapshotMutations === true,
         emitMutation: (event) => runtime.emitEvent('mutation', event),
+        emitMutationSend: (event) => runtime.emitEvent('mutation_send', event),
         nctSaltSink: (salt) => trustedContactToken.handleNctSaltSync(salt),
         contactSink: runtime.persistContact,
         pushNameSink: (name) => {
@@ -1011,6 +1015,20 @@ export function buildWaClientDependencies(input) {
         isConnected: () => connectionManager?.isConnected() ?? false,
         defaultIqTimeoutMs: options.iqTimeoutMs
     });
+    const mobileCoordinator = new WaMobileCoordinator({
+        logger,
+        authClient,
+        messageDispatch,
+        chatCoordinator: appStateMutations,
+        deviceSync: signalDeviceSync,
+        appStateStore: sessionStore.appState,
+        queryWithContext: runtime.queryWithContext,
+        emitEvent: runtime.emitEvent,
+        registerIncomingHandler: (registration) => incomingNode.registerIncomingHandler(registration),
+        isMobilePrimary,
+        persistence: options.companionHost?.persistence,
+        includePem: options.companionHost?.includePem
+    });
     return {
         nodeTransport,
         nodeOrchestrator,
@@ -1051,6 +1069,8 @@ export function buildWaClientDependencies(input) {
         connectionManager,
         trustedContactToken,
         abPropsCoordinator,
-        peerDataOperation
+        peerDataOperation,
+        mobileCoordinator,
+        isMobilePrimary
     };
 }

package/dist/esm/client/coordinators/WaAppStateMutationCoordinator.js

@@ -11,6 +11,8 @@ const WA_APP_STATE_MUTATION_FLUSH_SUCCESS_STATES = new Set([
     WA_APP_STATE_COLLECTION_STATES.SUCCESS_HAS_MORE
 ]);
 const WA_APP_STATE_ARCHIVE_RANGE_DEFAULT_LIMIT = 256;
+/** Placeholder MACs for locally-emitted mutation events (the parser ignores them). */
+const WA_EMPTY_MUTATION_MAC = new Uint8Array(0);
 function buildMutationIndexFromSchema(schema, indexArgs) {
     const parts = new Array(schema.indexParts.length);
     const args = indexArgs;
@@ -157,7 +159,6 @@ function buildRemoveMutationFromSchema(input) {
         collection: input.schema.collection,
         operation: 'remove',
         index: buildMutationIndexFromSchema(input.schema, input.indexArgs),
-        previousValue: { timestamp: input.timestamp },
         version: input.schema.version,
         timestamp: input.timestamp
     };
@@ -177,6 +178,7 @@ export class WaAppStateMutationCoordinator {
         this.serverClock = options.serverClock;
         this.archiveRangeLimit = resolvePositive(options.archiveRangeLimit, WA_APP_STATE_ARCHIVE_RANGE_DEFAULT_LIMIT, 'WaAppStateMutationCoordinatorOptions.archiveRangeLimit');
         this.emitMutation = options.emitMutation;
+        this.emitMutationSend = options.emitMutationSend;
         this.emitSnapshotMutations = options.emitSnapshotMutations === true;
         this.nctSaltSink = options.nctSaltSink;
         this.contactSink = options.contactSink;
@@ -614,9 +616,43 @@ export class WaAppStateMutationCoordinator {
     async enqueueAndFlush(mutations) {
         for (const mutation of mutations) {
             this.enqueueMutation(mutation);
+            this.emitLocalMutation(mutation);
         }
         await this.flushMutations();
     }
+    /**
+     * Surfaces an action this client is sending via the outbound `mutation_send`
+     * event, so consumers can observe their own change at action time. Parse
+     * failures are swallowed (best-effort).
+     */
+    emitLocalMutation(input) {
+        if (!this.emitMutationSend)
+            return;
+        const value = input.operation === 'set' ? input.value : null;
+        try {
+            const event = parseAppStateMutationEvent({
+                collection: input.collection,
+                operation: input.operation,
+                source: 'local',
+                index: input.index,
+                value,
+                version: input.version,
+                indexMac: WA_EMPTY_MUTATION_MAC,
+                valueMac: WA_EMPTY_MUTATION_MAC,
+                keyId: WA_EMPTY_MUTATION_MAC,
+                timestamp: input.timestamp
+            });
+            if (event)
+                this.emitMutationSend(event);
+        }
+        catch (error) {
+            this.logger.debug('failed to emit local app-state mutation event', {
+                collection: input.collection,
+                index: input.index,
+                message: toError(error).message
+            });
+        }
+    }
     enqueueMutation(mutation) {
         const key = `${mutation.collection}\u0001${mutation.index}`;
         if (this.pendingMutations.has(key)) {

package/dist/esm/client/coordinators/WaGroupCoordinator.js

@@ -2,6 +2,7 @@ import { parseParticipants as parseGroupEventParticipants } from '../events/grou
 import { WA_DEFAULTS } from '../../protocol/defaults.js';
 import { WA_GROUP_PARTICIPANT_TYPES } from '../../protocol/group.js';
 import { parseJidFull } from '../../protocol/jid.js';
+import { WA_ADDRESSING_MODES } from '../../protocol/message.js';
 import { WA_IQ_TYPES, WA_NODE_TAGS, WA_XMLNS } from '../../protocol/nodes.js';
 import { WA_GROUP_NOTIFICATION_TAGS } from '../../protocol/notification.js';
 import { buildListParticipatingGroupsIq } from '../../transport/node/builders/account-sync.js';
@@ -87,7 +88,11 @@ function parseGroupCommons(target) {
         ? findNodeChild(membershipApprovalNode, WA_NODE_TAGS.GROUP_JOIN)
         : undefined;
     const addressingModeRaw = attrs.addressing_mode;
-    const addressingMode = addressingModeRaw === 'lid' ? 'lid' : addressingModeRaw === 'pn' ? 'pn' : undefined;
+    const addressingMode = addressingModeRaw === WA_ADDRESSING_MODES.LID
+        ? WA_ADDRESSING_MODES.LID
+        : addressingModeRaw === WA_ADDRESSING_MODES.PN
+            ? WA_ADDRESSING_MODES.PN
+            : undefined;
     const rawJid = attrs.id ?? attrs.jid ?? '';
     const jid = rawJid && !rawJid.includes('@') ? `${rawJid}@${WA_DEFAULTS.GROUP_SERVER}` : rawJid;
     return {

package/dist/esm/client/coordinators/WaMessageDispatchCoordinator.js

@@ -11,7 +11,7 @@ import { wrapDeviceSentMessage } from '../../message/encode/device-sent.js';
 import { writeRandomPadMax16 } from '../../message/encode/padding.js';
 import { buildBotInvokeProtoCopy, extractInvokedBotJid, genBotMsgSecret } from '../../message/kinds/bot.js';
 import { proto } from '../../proto.js';
-import { WA_DEFAULTS, WA_NACK_REASONS } from '../../protocol/constants.js';
+import { WA_ADDRESSING_MODES, WA_DEFAULTS, WA_NACK_REASONS } from '../../protocol/constants.js';
 import { canonicalizeOwnAccountJid, isBotJid, isGroupJid, isHostedDeviceJid, isLidJid, isNewsletterJid, isUserJid, normalizeDeviceJid, normalizeRecipientJid, parseJidFull, parseSignalAddressFromJid, signalAddressKey, toUserJid } from '../../protocol/jid.js';
 import { encodeBinaryNode } from '../../transport/binary/index.js';
 import { buildButtonAddonNode, buildDirectMessageFanoutNode, buildGroupSenderKeyMessageNode, buildMetaNode } from '../../transport/node/builders/message.js';
@@ -200,6 +200,16 @@ export class WaMessageDispatchCoordinator {
             }
             : withViewOnce;
         const upload = built.upload;
+        if (this.deps.emitMessageSend) {
+            try {
+                this.deps.emitMessageSend({ to: recipientJid, id: sendOptions.id, message });
+            }
+            catch (error) {
+                this.deps.logger.debug('message_send emit failed', {
+                    message: toError(error).message
+                });
+            }
+        }
         const messageWithOverride = options.messageSecret
             ? {
                 ...message,
@@ -891,17 +901,17 @@ export class WaMessageDispatchCoordinator {
     resolveGroupAddressingMode(participantUserJids, groupJid) {
         for (let index = 0; index < participantUserJids.length; index += 1) {
             if (isLidJid(participantUserJids[index])) {
-                return 'lid';
+                return WA_ADDRESSING_MODES.LID;
             }
         }
         this.deps.logger.trace('group addressing mode resolved to pn (default)', {
             groupJid,
             participants: participantUserJids.length
         });
-        return 'pn';
+        return WA_ADDRESSING_MODES.PN;
     }
     resolveSenderForAddressingMode(addressingMode, meJid) {
-        if (addressingMode === 'lid') {
+        if (addressingMode === WA_ADDRESSING_MODES.LID) {
             const meLid = this.deps.getCurrentCredentials()?.meLid;
             if (meLid && meLid.includes('@')) {
                 try {