zapo-js 0.1.0 → 0.1.2

package/dist/esm/auth/WaAuthClient.js

@@ -50,7 +50,7 @@ export class WaAuthClient {
     getState(connected = false) {
         return {
             connected,
-            registered: this.credentials?.meJid !== null && this.credentials?.meJid !== undefined,
+            registered: hasMeJid(this.credentials),
             hasQr: this.qrFlow.hasQr(),
             hasPairingCode: this.pairingFlow.hasPairingSession()
         };
@@ -67,7 +67,7 @@ export class WaAuthClient {
                 signalStore: this.signalStore
             });
             this.logger.info('auth client credentials ready', {
-                registered: this.credentials.meJid !== null && this.credentials.meJid !== undefined
+                registered: hasMeJid(this.credentials)
             });
             return this.credentials;
         });
@@ -141,51 +141,47 @@ export class WaAuthClient {
             }
         });
     }
-    async persistMeLid(meLid) {
-        await this.persistSuccessAttributes({
-            meLid
-        });
-    }
     async persistSuccessAttributes(attributes) {
-        let changes = {};
         await this.patchCredentials((credentials) => {
-            const nextMeLid = attributes.meLid ?? credentials.meLid;
-            const nextMeDisplayName = attributes.meDisplayName ?? credentials.meDisplayName;
-            const nextCompanionEncStatic = attributes.companionEncStatic ?? credentials.companionEncStatic;
-            const nextLastSuccessTs = attributes.lastSuccessTs ?? credentials.lastSuccessTs;
-            const nextPropsVersion = attributes.propsVersion ?? credentials.propsVersion;
-            const nextAbPropsVersion = attributes.abPropsVersion ?? credentials.abPropsVersion;
-            const nextConnectionLocation = attributes.connectionLocation ?? credentials.connectionLocation;
-            const nextAccountCreationTs = attributes.accountCreationTs ?? credentials.accountCreationTs;
-            changes = {
-                lidChanged: nextMeLid !== credentials.meLid,
-                displayNameChanged: nextMeDisplayName !== credentials.meDisplayName,
-                companionChanged: (credentials.companionEncStatic === undefined) !==
-                    (nextCompanionEncStatic === undefined) ||
-                    (credentials.companionEncStatic !== undefined &&
-                        nextCompanionEncStatic !== undefined &&
-                        !uint8Equal(credentials.companionEncStatic, nextCompanionEncStatic)),
-                lastSuccessTsChanged: nextLastSuccessTs !== credentials.lastSuccessTs,
-                propsVersionChanged: nextPropsVersion !== credentials.propsVersion,
-                abPropsVersionChanged: nextAbPropsVersion !== credentials.abPropsVersion,
-                connectionLocationChanged: nextConnectionLocation !== credentials.connectionLocation,
-                accountCreationTsChanged: nextAccountCreationTs !== credentials.accountCreationTs
-            };
             return {
                 ...credentials,
-                meLid: nextMeLid,
-                meDisplayName: nextMeDisplayName,
-                companionEncStatic: nextCompanionEncStatic,
-                lastSuccessTs: nextLastSuccessTs,
-                propsVersion: nextPropsVersion,
-                abPropsVersion: nextAbPropsVersion,
-                connectionLocation: nextConnectionLocation,
-                accountCreationTs: nextAccountCreationTs
+                meLid: attributes.meLid ?? credentials.meLid,
+                meDisplayName: attributes.meDisplayName ?? credentials.meDisplayName,
+                companionEncStatic: attributes.companionEncStatic ?? credentials.companionEncStatic,
+                lastSuccessTs: attributes.lastSuccessTs ?? credentials.lastSuccessTs,
+                propsVersion: attributes.propsVersion ?? credentials.propsVersion,
+                abPropsVersion: attributes.abPropsVersion ?? credentials.abPropsVersion,
+                connectionLocation: attributes.connectionLocation ?? credentials.connectionLocation,
+                accountCreationTs: attributes.accountCreationTs ?? credentials.accountCreationTs
             };
         }, {
-            shouldPersist: () => Object.values(changes).some(Boolean),
-            onPersist: () => {
-                this.logger.debug('persisting success attributes', changes);
+            shouldPersist: (current, next) => next.meLid !== current.meLid ||
+                next.meDisplayName !== current.meDisplayName ||
+                (current.companionEncStatic === undefined) !==
+                    (next.companionEncStatic === undefined) ||
+                (current.companionEncStatic !== undefined &&
+                    next.companionEncStatic !== undefined &&
+                    !uint8Equal(current.companionEncStatic, next.companionEncStatic)) ||
+                next.lastSuccessTs !== current.lastSuccessTs ||
+                next.propsVersion !== current.propsVersion ||
+                next.abPropsVersion !== current.abPropsVersion ||
+                next.connectionLocation !== current.connectionLocation ||
+                next.accountCreationTs !== current.accountCreationTs,
+            onPersist: (current, next) => {
+                this.logger.debug('persisting success attributes', {
+                    lidChanged: next.meLid !== current.meLid,
+                    displayNameChanged: next.meDisplayName !== current.meDisplayName,
+                    companionChanged: (current.companionEncStatic === undefined) !==
+                        (next.companionEncStatic === undefined) ||
+                        (current.companionEncStatic !== undefined &&
+                            next.companionEncStatic !== undefined &&
+                            !uint8Equal(current.companionEncStatic, next.companionEncStatic)),
+                    lastSuccessTsChanged: next.lastSuccessTs !== current.lastSuccessTs,
+                    propsVersionChanged: next.propsVersion !== current.propsVersion,
+                    abPropsVersionChanged: next.abPropsVersion !== current.abPropsVersion,
+                    connectionLocationChanged: next.connectionLocation !== current.connectionLocation,
+                    accountCreationTsChanged: next.accountCreationTs !== current.accountCreationTs
+                });
             }
         });
     }
@@ -200,24 +196,18 @@ export class WaAuthClient {
         return this.runHandled(() => this.pairingFlow.fetchPairingCountryCodeIso());
     }
     async handleIncomingIqSet(node) {
-        return this.runHandled(async () => {
-            this.logger.trace('auth client handleIncomingIqSet', { id: node.attrs.id });
-            return this.pairingFlow.handleIncomingIqSet(node);
-        });
+        this.logger.trace('auth client handleIncomingIqSet', { id: node.attrs.id });
+        return this.runHandled(() => this.pairingFlow.handleIncomingIqSet(node));
     }
     async handleLinkCodeNotification(node) {
-        return this.runHandled(async () => {
-            this.logger.trace('auth client handleLinkCodeNotification', { id: node.attrs.id });
-            return this.pairingFlow.handleLinkCodeNotification(node);
-        });
+        this.logger.trace('auth client handleLinkCodeNotification', { id: node.attrs.id });
+        return this.runHandled(() => this.pairingFlow.handleLinkCodeNotification(node));
     }
     async handleCompanionRegRefreshNotification(node) {
-        return this.runHandled(async () => {
-            this.logger.trace('auth client handleCompanionRegRefreshNotification', {
-                id: node.attrs.id
-            });
-            return this.pairingFlow.handleCompanionRegRefreshNotification(node);
+        this.logger.trace('auth client handleCompanionRegRefreshNotification', {
+            id: node.attrs.id
         });
+        return this.runHandled(() => this.pairingFlow.handleCompanionRegRefreshNotification(node));
     }
     async patchCredentials(buildNext, options = {}) {
         const current = this.requireCredentials();
@@ -240,7 +230,7 @@ export class WaAuthClient {
     }
     async updateCredentials(credentials) {
         this.logger.trace('auth client update credentials', {
-            registered: credentials.meJid !== null && credentials.meJid !== undefined
+            registered: hasMeJid(credentials)
         });
         this.credentials = credentials;
         await persistCredentials({
@@ -260,3 +250,6 @@ export class WaAuthClient {
         this.callbacks.onError?.(error);
     }
 }
+function hasMeJid(credentials) {
+    return credentials?.meJid !== null && credentials?.meJid !== undefined;
+}

package/dist/esm/auth/flow/WaAuthCredentialsFlow.js

@@ -4,22 +4,23 @@ import { X25519 } from '../../crypto/curves/X25519.js';
 import { getLoginIdentity } from '../../protocol/jid.js';
 import { verifySignalSignature } from '../../signal/crypto/WaAdvSignature.js';
 import { createAndStoreInitialKeys } from '../../signal/registration/utils.js';
+import { toProxyAgent, toProxyDispatcher } from '../../transport/proxy.js';
 import { toError } from '../../util/primitives.js';
 export async function loadOrCreateCredentials(args) {
     args.logger.trace('auth credentials loadOrCreate start');
     const existing = await args.authStore.load();
     if (!existing) {
-        const credentials = await createAndPersistFreshCredentials(args);
+        const credentials = await createFreshAndPersistCredentials(args);
         args.logger.info('created fresh auth credentials');
         return credentials;
     }
     args.logger.debug('auth credentials loaded from store', {
-        registered: existing.meJid !== null && existing.meJid !== undefined,
+        registered: isRegistered(existing),
         hasServerStaticKey: existing.serverStaticKey !== null && existing.serverStaticKey !== undefined
     });
     if (!existing.meJid && !(await hasValidSignedPreKey(args.logger, existing))) {
         args.logger.warn('signed pre-key is invalid, regenerating credentials');
-        const fresh = await createAndPersistFreshCredentials(args);
+        const fresh = await createFreshAndPersistCredentials(args);
         args.logger.info('regenerated credentials due to invalid signed pre-key');
         return fresh;
     }
@@ -29,13 +30,15 @@ export async function loadOrCreateCredentials(args) {
 }
 export async function persistCredentials(args, credentials) {
     args.logger.trace('persisting auth credentials', {
-        registered: credentials.meJid !== null && credentials.meJid !== undefined
+        registered: isRegistered(credentials)
     });
     await args.authStore.save(credentials);
 }
 export function buildCommsConfig(logger, credentials, socketOptions, clientOptions) {
-    const registered = credentials.meJid !== null && credentials.meJid !== undefined;
-    const loginIdentity = registered ? getLoginIdentity(credentials.meJid) : null;
+    const meJid = credentials.meJid;
+    const registered = meJid !== null && meJid !== undefined;
+    const loginIdentity = registered ? getLoginIdentity(meJid) : null;
+    const wsProxy = socketOptions.proxy?.ws;
     logger.debug('building comms config from credentials', {
         registered,
         hasServerStaticKey: credentials.serverStaticKey !== null && credentials.serverStaticKey !== undefined
@@ -44,6 +47,8 @@ export function buildCommsConfig(logger, credentials, socketOptions, clientOptio
         url: socketOptions.url,
         urls: socketOptions.urls,
         protocols: socketOptions.protocols,
+        dispatcher: toProxyDispatcher(wsProxy),
+        agent: toProxyAgent(wsProxy),
         connectTimeoutMs: socketOptions.connectTimeoutMs,
         reconnectIntervalMs: socketOptions.reconnectIntervalMs,
         timeoutIntervalMs: socketOptions.timeoutIntervalMs,
@@ -88,9 +93,10 @@ async function createFreshCredentials(signalStore, logger) {
         advSecretKey
     };
 }
-async function createAndPersistFreshCredentials(args) {
+async function createFreshAndPersistCredentials(args) {
     const credentials = await createFreshCredentials(args.signalStore, args.logger);
-    await persistFreshCredentials(args, credentials);
+    await args.authStore.save(credentials);
+    await restoreSignalStore(args.signalStore, credentials);
     return credentials;
 }
 async function hasValidSignedPreKey(logger, credentials) {
@@ -108,11 +114,12 @@ async function hasValidSignedPreKey(logger, credentials) {
     }
 }
 async function restoreSignalStore(signalStore, credentials) {
-    await signalStore.setRegistrationInfo(credentials.registrationInfo);
-    await signalStore.setSignedPreKey(credentials.signedPreKey);
-    await signalStore.setServerHasPreKeys(credentials.serverHasPreKeys === true);
+    await Promise.all([
+        signalStore.setRegistrationInfo(credentials.registrationInfo),
+        signalStore.setSignedPreKey(credentials.signedPreKey),
+        signalStore.setServerHasPreKeys(credentials.serverHasPreKeys === true)
+    ]);
 }
-async function persistFreshCredentials(args, credentials) {
-    await args.authStore.save(credentials);
-    await restoreSignalStore(args.signalStore, credentials);
+function isRegistered(credentials) {
+    return credentials.meJid !== null && credentials.meJid !== undefined;
 }

package/dist/esm/auth/index.js

@@ -1,5 +1,4 @@
 export * from './types.js';
-export { getLoginIdentity } from '../protocol/jid.js';
 export { WaAuthClient } from './WaAuthClient.js';
 export { completeCompanionFinish, createCompanionHello } from './pairing/WaPairingCodeCrypto.js';
 export { WaAuthSqliteStore } from '../store/providers/sqlite/auth.store.js';

package/dist/esm/auth/pairing/WaPairingFlow.js

@@ -5,9 +5,9 @@ import { WA_DEFAULTS, WA_IQ_TYPES, WA_NODE_TAGS, WA_SIGNALING } from '../../prot
 import { parsePhoneJid } from '../../protocol/jid.js';
 import { ADV_PREFIX_HOSTED_ACCOUNT_SIGNATURE, computeAdvIdentityHmac, generateDeviceSignature, verifyDeviceIdentityAccountSignature } from '../../signal/crypto/WaAdvSignature.js';
 import { buildCompanionFinishRequestNode, buildCompanionHelloRequestNode, buildGetCountryCodeRequestNode, buildIqResultNode, buildNotificationAckNode } from '../../transport/node/builders/pairing.js';
-import { decodeNodeContentUtf8OrBytes, findNodeChild, getFirstNodeChild, getNodeChildrenByTag, hasNodeChild } from '../../transport/node/helpers.js';
-import { decodeProtoBytes } from '../../util/base64.js';
-import { concatBytes, TEXT_DECODER, uint8Equal } from '../../util/bytes.js';
+import { decodeNodeContentUtf8OrBytes, findNodeChildrenByTags, findNodeChild, getFirstNodeChild, getNodeChildrenNonEmptyUtf8ByTag, hasNodeChild } from '../../transport/node/helpers.js';
+import { decodeProtoBytes } from '../../util/bytes.js';
+import { concatBytes, uint8Equal } from '../../util/bytes.js';
 export class WaPairingFlow {
     constructor(options) {
         this.opts = options;
@@ -153,9 +153,7 @@ export class WaPairingFlow {
         return true;
     }
     async handlePairDevice(iqNode, pairDeviceNode) {
-        const refs = getNodeChildrenByTag(pairDeviceNode, WA_NODE_TAGS.REF)
-            .map((child) => TEXT_DECODER.decode(decodeNodeContentUtf8OrBytes(child.content, 'pair-device.ref')))
-            .filter((ref) => ref.length > 0);
+        const refs = getNodeChildrenNonEmptyUtf8ByTag(pairDeviceNode, WA_NODE_TAGS.REF, 'pair-device.ref');
         await this.rotateAdvSecret(this.requireCredentials());
         this.opts.qrFlow.setRefs(refs);
         this.opts.logger.info('pair-device refs updated', { refsCount: refs.length });
@@ -164,9 +162,7 @@ export class WaPairingFlow {
     async handlePairSuccess(iqNode, pairSuccessNode) {
         this.opts.logger.info('processing pair-success node');
         const credentials = this.requireCredentials();
-        const deviceIdentityNode = findNodeChild(pairSuccessNode, WA_NODE_TAGS.DEVICE_IDENTITY);
-        const deviceNode = findNodeChild(pairSuccessNode, 'device');
-        const platformNode = findNodeChild(pairSuccessNode, WA_NODE_TAGS.PLATFORM);
+        const [deviceIdentityNode, deviceNode, platformNode] = findNodeChildrenByTags(pairSuccessNode, [WA_NODE_TAGS.DEVICE_IDENTITY, 'device', WA_NODE_TAGS.PLATFORM]);
         if (!deviceIdentityNode || !deviceNode || !platformNode) {
             this.opts.logger.error('pair-success missing required nodes', {
                 hasDeviceIdentity: !!deviceIdentityNode,
@@ -267,9 +263,11 @@ export class WaPairingFlow {
         if (pairingSession.attempts > 3) {
             throw new Error('pairing code exceeded maximum primary hello attempts');
         }
-        const refNode = findNodeChild(linkCodeNode, WA_NODE_TAGS.LINK_CODE_PAIRING_REF);
-        const wrappedPrimaryNode = findNodeChild(linkCodeNode, 'link_code_pairing_wrapped_primary_ephemeral_pub');
-        const primaryIdentityNode = findNodeChild(linkCodeNode, 'primary_identity_pub');
+        const [refNode, wrappedPrimaryNode, primaryIdentityNode] = findNodeChildrenByTags(linkCodeNode, [
+            WA_NODE_TAGS.LINK_CODE_PAIRING_REF,
+            'link_code_pairing_wrapped_primary_ephemeral_pub',
+            'primary_identity_pub'
+        ]);
         if (!refNode || !wrappedPrimaryNode || !primaryIdentityNode) {
             throw new Error('primary_hello notification is missing fields');
         }
@@ -290,10 +288,6 @@ export class WaPairingFlow {
             companionEphemeralPrivKey: pairingSession.companionEphemeralKeyPair.privKey,
             registrationIdentityKeyPair: credentials.registrationInfo.identityKeyPair
         });
-        await this.opts.auth.updateCredentials({
-            ...credentials,
-            advSecretKey: finish.advSecret
-        });
         const result = await this.opts.socket.query(buildCompanionFinishRequestNode({
             phoneJid: pairingSession.phoneJid,
             wrappedKeyBundle: finish.wrappedKeyBundle,
@@ -303,6 +297,10 @@ export class WaPairingFlow {
         if (result.attrs.type === WA_IQ_TYPES.ERROR) {
             throw new Error('companion_finish returned error');
         }
+        await this.opts.auth.updateCredentials({
+            ...credentials,
+            advSecretKey: finish.advSecret
+        });
         pairingSession.finished = true;
         this.opts.logger.info('primary_hello completed with companion_finish success');
     }

package/dist/esm/auth/pairing/WaQrFlow.js

@@ -1,5 +1,5 @@
 import { WA_DEFAULTS } from '../../protocol/constants.js';
-import { bytesToBase64 } from '../../util/base64.js';
+import { bytesToBase64 } from '../../util/bytes.js';
 export class WaQrFlow {
     constructor(args) {
         this.logger = args.logger;
@@ -7,11 +7,11 @@ export class WaQrFlow {
         this.getDevicePlatform = args.getDevicePlatform;
         this.emitQr = args.emitQr;
         this.qrRefs = [];
-        this.currentRef = null;
+        this.qrRefIndex = 0;
         this.currentQrTimer = null;
     }
     hasQr() {
-        return this.qrRefs.length > 0 || this.currentQrTimer !== null;
+        return this.qrRefIndex < this.qrRefs.length || this.currentQrTimer !== null;
     }
     clear() {
         this.logger.trace('qr flow clear');
@@ -20,28 +20,32 @@ export class WaQrFlow {
             this.currentQrTimer = null;
         }
         this.qrRefs = [];
-        this.currentRef = null;
+        this.qrRefIndex = 0;
     }
     refreshCurrentQr() {
-        if (!this.currentRef) {
+        if (this.qrRefIndex === 0) {
             this.logger.trace('qr flow refresh skipped: no active ref');
             return false;
         }
+        const ref = this.qrRefs[this.qrRefIndex - 1];
         const credentials = this.getCredentials();
         if (!credentials) {
             this.logger.warn('qr flow refresh skipped: missing credentials');
             return false;
         }
-        const ttlMs = this.qrRefs.length === 5
+        const ttlMs = this.qrRefs.length - this.qrRefIndex === 5
             ? WA_DEFAULTS.QR_INITIAL_TTL_MS
             : WA_DEFAULTS.QR_ROTATION_TTL_MS;
-        this.logger.debug('qr flow refresh emit', { ttlMs, remainingRefs: this.qrRefs.length });
-        this.emitQr(this.buildQr(this.currentRef, credentials), ttlMs);
+        this.logger.debug('qr flow refresh emit', {
+            ttlMs,
+            remainingRefs: this.qrRefs.length - this.qrRefIndex
+        });
+        this.emitQr(this.buildQr(ref, credentials), ttlMs);
         return true;
     }
     setRefs(refs) {
         this.clear();
-        this.qrRefs = [...refs];
+        this.qrRefs = refs;
         this.logger.info('qr refs updated', { count: this.qrRefs.length });
         if (this.qrRefs.length === 0) {
             return;
@@ -54,29 +58,38 @@ export class WaQrFlow {
             this.clear();
             return;
         }
-        const ref = this.qrRefs.shift();
-        if (!ref) {
+        if (this.qrRefIndex >= this.qrRefs.length) {
             this.clear();
             return;
         }
-        this.currentRef = ref;
-        const ttlMs = this.qrRefs.length === 5
-            ? WA_DEFAULTS.QR_INITIAL_TTL_MS
-            : WA_DEFAULTS.QR_ROTATION_TTL_MS;
-        this.logger.trace('qr flow emit new code', { ttlMs, remainingRefs: this.qrRefs.length });
-        this.emitQr(this.buildQr(ref, credentials), ttlMs);
+        const ref = this.qrRefs[this.qrRefIndex++];
+        const remainingRefs = this.qrRefs.length - this.qrRefIndex;
+        const ttlMs = remainingRefs === 5 ? WA_DEFAULTS.QR_INITIAL_TTL_MS : WA_DEFAULTS.QR_ROTATION_TTL_MS;
+        this.logger.trace('qr flow emit new code', { ttlMs, remainingRefs });
         this.currentQrTimer = setTimeout(() => {
             this.currentQrTimer = null;
             this.rotateRef();
         }, ttlMs);
+        try {
+            this.emitQr(this.buildQr(ref, credentials), ttlMs);
+        }
+        catch (error) {
+            if (this.currentQrTimer) {
+                clearTimeout(this.currentQrTimer);
+                this.currentQrTimer = null;
+            }
+            throw error;
+        }
     }
     buildQr(ref, credentials) {
-        return [
-            ref,
-            bytesToBase64(credentials.noiseKeyPair.pubKey),
-            bytesToBase64(credentials.registrationInfo.identityKeyPair.pubKey),
-            bytesToBase64(credentials.advSecretKey),
-            this.getDevicePlatform()
-        ].join(',');
+        return (ref +
+            ',' +
+            bytesToBase64(credentials.noiseKeyPair.pubKey) +
+            ',' +
+            bytesToBase64(credentials.registrationInfo.identityKeyPair.pubKey) +
+            ',' +
+            bytesToBase64(credentials.advSecretKey) +
+            ',' +
+            this.getDevicePlatform());
     }
 }