zapo-js 0.2.0 → 0.3.0

package/dist/client/WaClient.js

@@ -9,12 +9,16 @@ const mailbox_1 = require("./mailbox");
 const WriteBehindPersistence_1 = require("./persistence/WriteBehindPersistence");
 const WaClientFactory_1 = require("./WaClientFactory");
 const ConsoleLogger_1 = require("../infra/log/ConsoleLogger");
+const addon_crypto_1 = require("../message/addon-crypto");
 const _proto_1 = require("../proto.js");
 const constants_1 = require("../protocol/constants");
 const jid_1 = require("../protocol/jid");
+const stream_1 = require("../protocol/stream");
+const noop_store_1 = require("../store/noop.store");
+const device_1 = require("../transport/node/builders/device");
+const presence_1 = require("../transport/node/builders/presence");
 const query_1 = require("../transport/node/query");
 const bytes_1 = require("../util/bytes");
-const bytes_2 = require("../util/bytes");
 const primitives_1 = require("../util/primitives");
 const SYNC_RELATED_PROTOCOL_TYPES = new Set([
     _proto_1.proto.Message.ProtocolMessage.Type.APP_STATE_SYNC_KEY_REQUEST,
@@ -22,8 +26,6 @@ const SYNC_RELATED_PROTOCOL_TYPES = new Set([
     _proto_1.proto.Message.ProtocolMessage.Type.PEER_DATA_OPERATION_REQUEST_MESSAGE,
     _proto_1.proto.Message.ProtocolMessage.Type.PEER_DATA_OPERATION_REQUEST_RESPONSE_MESSAGE
 ]);
-const WA_APP_STATE_KEY_SHARE_WAIT_TIMEOUT_MS = 15000;
-const WA_APP_STATE_KEY_SHARE_MAX_RETRIES = 2;
 class WaClient extends node_events_1.EventEmitter {
     constructor(options, logger = new ConsoleLogger_1.ConsoleLogger('info')) {
         super();
@@ -37,11 +39,15 @@ class WaClient extends node_events_1.EventEmitter {
         this.appStateStore = base.sessionStore.appState;
         this.contactStore = base.sessionStore.contacts;
         this.messageStore = base.sessionStore.messages;
+        this.messageSecretStore = base.sessionStore.messageSecret;
         this.participantsStore = base.sessionStore.participants;
         this.privacyTokenStore = base.sessionStore.privacyToken;
         this.deviceListStore = base.sessionStore.deviceList;
         this.retryStore = base.sessionStore.retry;
         this.signalStore = base.sessionStore.signal;
+        this.preKeyStore = base.sessionStore.preKey;
+        this.sessionStore = base.sessionStore.session;
+        this.identityStore = base.sessionStore.identity;
         this.senderKeyStore = base.sessionStore.senderKey;
         this.threadStore = base.sessionStore.threads;
         this.writeBehind = new WriteBehindPersistence_1.WriteBehindPersistence({
@@ -49,11 +55,16 @@ class WaClient extends node_events_1.EventEmitter {
             threadStore: this.threadStore,
             contactStore: this.contactStore
         }, this.logger, this.options.writeBehind);
+        if (this.options.addons?.autoDecrypt &&
+            this.messageSecretStore === noop_store_1.NOOP_MESSAGE_SECRET_STORE) {
+            this.logger.warn('addons.autoDecrypt is enabled but messageSecret cache is noop — ' +
+                'addon decryption will only work if secrets are in the message store');
+        }
         const dependencies = (0, WaClientFactory_1.buildWaClientDependencies)({
             base,
             runtime: {
                 sendNode: (node) => this.sendNode(node),
-                query: (node, timeoutMs) => this.query(node, timeoutMs),
+                query: (node, timeoutMs, options) => this.query(node, timeoutMs, options),
                 queryWithContext: this.queryWithContext.bind(this),
                 syncAppState: () => this.syncAppState().then(() => { }),
                 syncAppStateWithOptions: (syncOptions) => this.syncAppState(syncOptions),
@@ -112,12 +123,16 @@ class WaClient extends node_events_1.EventEmitter {
             throw normalized;
         }
     }
-    async query(node, timeoutMs = this.options.iqTimeoutMs ?? constants_1.WA_DEFAULTS.IQ_TIMEOUT_MS) {
+    async sendPresence(type) {
+        const credentials = this.authClient.getCurrentCredentials();
+        await this.nodeOrchestrator.sendNode((0, presence_1.buildPresenceNode)({ type, name: credentials?.meDisplayName ?? undefined }), false);
+    }
+    async query(node, timeoutMs = this.options.iqTimeoutMs ?? constants_1.WA_DEFAULTS.IQ_TIMEOUT_MS, options = {}) {
         if (!this.connectionManager.isConnected()) {
             throw new Error('client is not connected');
         }
         this.logger.debug('wa client query', { tag: node.tag, id: node.attrs.id, timeoutMs });
-        return this.nodeOrchestrator.query(node, timeoutMs);
+        return this.nodeOrchestrator.query(node, timeoutMs, options);
     }
     registerIncomingHandler(registration) {
         return this.incomingNode.registerIncomingHandler(registration);
@@ -144,8 +159,17 @@ class WaClient extends node_events_1.EventEmitter {
             void (0, mailbox_1.persistIncomingMailboxEntities)({
                 logger: this.logger,
                 writeBehind: this.writeBehind,
+                messageSecretStore: this.messageSecretStore,
                 event
             });
+            if (this.options.addons?.autoDecrypt && event.message) {
+                void this.tryDecryptAddon(event).catch((err) => {
+                    this.logger.warn('addon auto-decrypt failed', {
+                        id: event.stanzaId,
+                        message: (0, primitives_1.toError)(err).message
+                    });
+                });
+            }
             const protocolMessage = event.message?.protocolMessage;
             if (!protocolMessage) {
                 return;
@@ -212,16 +236,6 @@ class WaClient extends node_events_1.EventEmitter {
                 imported
             });
             if (imported > 0) {
-                const hadWaiters = this.keyShareCoordinator.hasWaiters();
-                this.keyShareCoordinator.notifyReceived();
-                if (hadWaiters) {
-                    this.logger.debug('app-state key share imported and waiters released', {
-                        id: event.stanzaId,
-                        from: event.chatJid,
-                        imported
-                    });
-                    return;
-                }
                 void this.syncAppState().catch((error) => {
                     this.logger.warn('failed to sync app-state after key share import', {
                         id: event.stanzaId,
@@ -320,7 +334,7 @@ class WaClient extends node_events_1.EventEmitter {
         for (const key of request.keyIds ?? []) {
             try {
                 const keyId = (0, bytes_1.decodeProtoBytes)(key.keyId, 'appStateSyncKeyRequest.keyIds[].keyId');
-                const keyHex = (0, bytes_2.bytesToHex)(keyId);
+                const keyHex = (0, bytes_1.bytesToHex)(keyId);
                 if (deduped.has(keyHex)) {
                     continue;
                 }
@@ -362,8 +376,8 @@ class WaClient extends node_events_1.EventEmitter {
             });
         }
     }
-    async queryWithContext(context, node, timeoutMs = this.options.iqTimeoutMs ?? constants_1.WA_DEFAULTS.IQ_TIMEOUT_MS, contextData = {}) {
-        return (0, query_1.queryWithContext)(async (queryNode, queryTimeoutMs) => this.query(queryNode, queryTimeoutMs), this.logger, context, node, timeoutMs, contextData);
+    async queryWithContext(context, node, timeoutMs = this.options.iqTimeoutMs ?? constants_1.WA_DEFAULTS.IQ_TIMEOUT_MS, contextData = {}, options = {}) {
+        return (0, query_1.queryWithContext)(async (queryNode, queryTimeoutMs) => this.query(queryNode, queryTimeoutMs, options), this.logger, context, node, timeoutMs, contextData);
     }
     async handleIncomingFrame(frame) {
         try {
@@ -403,7 +417,6 @@ class WaClient extends node_events_1.EventEmitter {
                 remaining: writeBehindFlush.remaining
             });
         }
-        this.keyShareCoordinator.notifyDisconnected();
         await this.connectionManager.disconnect();
         this.emit('connection', {
             status: 'close',
@@ -413,12 +426,12 @@ class WaClient extends node_events_1.EventEmitter {
             isNewLogin: false
         });
     }
-    async requestPairingCode(phoneNumber, shouldShowPushNotification = false) {
+    async requestPairingCode(phoneNumber, shouldShowPushNotification = false, customCode) {
         if (!this.connectionManager.isConnected() || !this.authClient.getCurrentCredentials()) {
             throw new Error('client is not connected');
         }
         this.logger.debug('wa client request pairing code');
-        return this.authClient.requestPairingCode(phoneNumber, shouldShowPushNotification);
+        return this.authClient.requestPairingCode(phoneNumber, shouldShowPushNotification, customCode);
     }
     async fetchPairingCountryCodeIso() {
         if (!this.connectionManager.isConnected() || !this.authClient.getCurrentCredentials()) {
@@ -467,6 +480,22 @@ class WaClient extends node_events_1.EventEmitter {
     get business() {
         return this.businessCoordinator;
     }
+    get email() {
+        return this.emailCoordinator;
+    }
+    async logout(reason = stream_1.WA_LOGOUT_REASONS.USER_INITIATED) {
+        const meJid = this.authClient.getCurrentCredentials()?.meJid;
+        if (!meJid) {
+            throw new Error('cannot logout: client is not authenticated');
+        }
+        const deviceJid = (0, jid_1.normalizeDeviceJid)(meJid);
+        const node = (0, device_1.buildRemoveCompanionDeviceIq)(deviceJid, reason);
+        const result = await this.queryWithContext('client.logout', node, undefined, {
+            jid: deviceJid,
+            reason
+        });
+        (0, query_1.assertIqResult)(result, 'client.logout');
+    }
     sendReceipt(input) {
         return this.messageDispatch.sendReceipt(input);
     }
@@ -483,60 +512,11 @@ class WaClient extends node_events_1.EventEmitter {
         if (!this.connectionManager.isConnected()) {
             throw new Error('client is not connected');
         }
-        const shouldWaitForKeyShare = (await this.appStateStore.getActiveSyncKey()) === null;
-        if (shouldWaitForKeyShare && !this.keyShareCoordinator.isBootstrapDone()) {
-            this.keyShareCoordinator.markBootstrapDone();
-            this.logger.info('app-state bootstrap pre-sync waiting for key share', {
-                timeoutMs: WA_APP_STATE_KEY_SHARE_WAIT_TIMEOUT_MS
-            });
-            const received = await this.keyShareCoordinator.waitForShare(WA_APP_STATE_KEY_SHARE_WAIT_TIMEOUT_MS);
-            if (received) {
-                this.logger.info('app-state bootstrap pre-sync received key share, continuing sync');
-            }
-            else {
-                this.logger.warn('app-state bootstrap pre-sync key share wait timed out, continuing sync', {
-                    timeoutMs: WA_APP_STATE_KEY_SHARE_WAIT_TIMEOUT_MS
-                });
-            }
-        }
-        let syncResult = await this.executeAppStateSync(options);
-        let blockedCollections = this.getBlockedAppStateCollections(syncResult);
-        if (!shouldWaitForKeyShare || blockedCollections.length === 0) {
-            this.emitChatEventsFromAppStateSyncResult(syncResult);
-            return syncResult;
-        }
-        let retryCount = 0;
-        let observedKeyShareVersion = this.keyShareCoordinator.getVersion();
-        while (blockedCollections.length > 0 && retryCount < WA_APP_STATE_KEY_SHARE_MAX_RETRIES) {
-            const hasFreshShare = this.keyShareCoordinator.getVersion() !== observedKeyShareVersion;
-            if (!hasFreshShare) {
-                this.logger.info('app-state bootstrap waiting for key share', {
-                    blockedCollections: blockedCollections.join(','),
-                    timeoutMs: WA_APP_STATE_KEY_SHARE_WAIT_TIMEOUT_MS,
-                    retryCount: retryCount + 1
-                });
-                const received = await this.keyShareCoordinator.waitForShare(WA_APP_STATE_KEY_SHARE_WAIT_TIMEOUT_MS);
-                if (!received) {
-                    this.logger.warn('app-state bootstrap key share wait timed out', {
-                        blockedCollections: blockedCollections.join(','),
-                        timeoutMs: WA_APP_STATE_KEY_SHARE_WAIT_TIMEOUT_MS
-                    });
-                    break;
-                }
-            }
-            observedKeyShareVersion = this.keyShareCoordinator.getVersion();
-            retryCount += 1;
-            this.logger.info('app-state bootstrap retrying sync after key share', {
-                retryCount,
-                blockedCollections: blockedCollections.join(',')
-            });
-            syncResult = await this.executeAppStateSync(options);
-            blockedCollections = this.getBlockedAppStateCollections(syncResult);
-        }
+        const syncResult = await this.executeAppStateSync(options);
+        const blockedCollections = this.getBlockedAppStateCollections(syncResult);
         if (blockedCollections.length > 0) {
-            this.logger.warn('app-state bootstrap still blocked after waiting for key share', {
-                blockedCollections: blockedCollections.join(','),
-                retries: retryCount
+            this.logger.warn('app-state sync has blocked collections', {
+                blockedCollections: blockedCollections.join(',')
             });
         }
         this.emitChatEventsFromAppStateSyncResult(syncResult);
@@ -637,6 +617,8 @@ class WaClient extends node_events_1.EventEmitter {
             await this.contactStore.clear();
         if (shouldClear('messages'))
             await this.messageStore.clear();
+        if (shouldClear('messageSecret'))
+            await this.messageSecretStore.clear();
         if (shouldClear('participants'))
             await this.participantsStore.clear();
         if (shouldClear('deviceList'))
@@ -645,6 +627,12 @@ class WaClient extends node_events_1.EventEmitter {
             await this.retryStore.clear();
         if (shouldClear('signal'))
             await this.signalStore.clear();
+        if (shouldClear('preKey'))
+            await this.preKeyStore.clear();
+        if (shouldClear('session'))
+            await this.sessionStore.clear();
+        if (shouldClear('identity'))
+            await this.identityStore.clear();
         if (shouldClear('senderKey'))
             await this.senderKeyStore.clear();
         if (shouldClear('threads'))
@@ -652,6 +640,58 @@ class WaClient extends node_events_1.EventEmitter {
         if (shouldClear('privacyToken'))
             await this.privacyTokenStore.clear();
     }
+    async tryDecryptAddon(event) {
+        const message = event.message;
+        if (!message)
+            return;
+        const addon = (0, addon_crypto_1.identifyEncryptedAddon)(message);
+        if (!addon)
+            return;
+        const targetMessageId = addon.targetMessageKey.id;
+        if (!targetMessageId)
+            return;
+        const parentEntry = await (0, addon_crypto_1.resolveParentMessageSecret)(targetMessageId, this.messageSecretStore, this.messageStore);
+        if (!parentEntry) {
+            this.logger.debug('addon parent message secret not found', {
+                id: event.stanzaId,
+                targetId: targetMessageId
+            });
+            return;
+        }
+        const parentMsgOriginalSender = parentEntry.senderJid;
+        const modificationSender = event.senderJid ?? '';
+        const plaintext = await (0, addon_crypto_1.decryptAddonPayload)({
+            messageSecret: parentEntry.secret,
+            stanzaId: targetMessageId,
+            parentMsgOriginalSender,
+            modificationSender,
+            modificationType: addon.modificationType,
+            ciphertext: addon.encPayload,
+            iv: addon.encIv,
+            additionalData: (0, addon_crypto_1.shouldUseAddonAdditionalData)(addon.modificationType)
+                ? (0, addon_crypto_1.buildAddonAdditionalData)(targetMessageId, modificationSender)
+                : undefined
+        });
+        let decrypted = (0, addon_crypto_1.decodeAddonPlaintext)(addon.kind, plaintext);
+        if (decrypted.kind === 'poll_vote' && decrypted.pollVote.selectedOptions) {
+            const names = await (0, addon_crypto_1.resolvePollOptionNames)(decrypted.pollVote.selectedOptions, targetMessageId, this.messageStore);
+            if (names) {
+                decrypted = { ...decrypted, selectedOptionNames: names };
+            }
+        }
+        const addonEvent = {
+            rawNode: event.rawNode,
+            stanzaId: event.stanzaId,
+            chatJid: event.chatJid,
+            stanzaType: event.stanzaType,
+            kind: addon.kind,
+            targetMessageId,
+            senderJid: modificationSender,
+            decrypted,
+            raw: message
+        };
+        this.emit('message_addon', addonEvent);
+    }
     tryEnterIncomingHandler() {
         if (!this.acceptingIncomingEvents) {
             return false;