zapo-js 0.3.0 → 1.0.0

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

@@ -0,0 +1,13 @@
+import { createAdminOps } from '../newsletter/admin.js';
+import { createDiscoveryOps } from '../newsletter/discovery.js';
+import { createMessagingOps } from '../newsletter/messaging.js';
+export { parseNewsletterMetadata } from '../newsletter/parse.js';
+/** Builds a {@link WaNewsletterCoordinator} from its MEX/messaging dependencies. */
+export function createNewsletterCoordinator(options) {
+    const mexDeps = options;
+    return {
+        ...createDiscoveryOps(mexDeps),
+        ...createAdminOps(mexDeps),
+        ...createMessagingOps(options)
+    };
+}

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

@@ -1,7 +1,8 @@
-import { WA_DEFAULTS } from '../../protocol/constants.js';
+import { WA_DEFAULTS, WA_IQ_TYPES } from '../../protocol/constants.js';
 import { SIGNAL_SIGNED_PREKEY_ROTATION_INTERVAL_MS, SIGNAL_SIGNED_PREKEY_SERVER_ERROR_BACKOFF_MS, SIGNAL_UPLOAD_PREKEYS_COUNT } from '../../signal/api/constants.js';
 import { buildPreKeyUploadIq, parsePreKeyUploadFailure } from '../../signal/api/prekeys.js';
 import { generatePreKeyPair } from '../../signal/registration/keygen.js';
+import { buildPassiveModeIqNode } from '../../transport/node/builders/passive.js';
 import { toError } from '../../util/primitives.js';
 export class WaPassiveTasksCoordinator {
     constructor(options) {
@@ -52,7 +53,7 @@ export class WaPassiveTasksCoordinator {
     }
     async runPassiveTasksAfterConnect() {
         const credentials = this.runtime.getCurrentCredentials();
-        const isRegistered = credentials?.meJid !== null && credentials?.meJid !== undefined;
+        const isRegistered = !!credentials?.meJid;
         if (!isRegistered) {
             this.logger.trace('passive connect tasks skipped: session is not registered');
             return;
@@ -65,8 +66,8 @@ export class WaPassiveTasksCoordinator {
                 });
             });
         }
-        await this.runtime.sendPresenceAvailable().catch((error) => {
-            this.logger.warn('presence available send failed', {
+        await this.runtime.sendInitialPresence().catch((error) => {
+            this.logger.warn('initial presence send failed', {
                 message: toError(error).message
             });
         });
@@ -81,6 +82,17 @@ export class WaPassiveTasksCoordinator {
         await this.validateDigestAndRecoverPreKeys(prefetchedLocalKeyBundle);
         await this.rotateSignedPreKeyIfDue(signedPreKeyRotationTs);
         await this.flushDanglingReceipts();
+        await this.sendActiveModeIq();
+    }
+    async sendActiveModeIq() {
+        try {
+            await this.runtime.queryWithContext('passive.active', buildPassiveModeIqNode('active'), WA_DEFAULTS.IQ_TIMEOUT_MS);
+        }
+        catch (error) {
+            this.logger.warn('passive active iq failed', {
+                message: toError(error).message
+            });
+        }
     }
     async validateDigestAndRecoverPreKeys(prefetchedLocalKeyBundle) {
         try {
@@ -135,7 +147,7 @@ export class WaPassiveTasksCoordinator {
             count: preKeys.length,
             lastPreKeyId
         }, this.mobilePrimary ? { useSystemId: true } : undefined);
-        if (response.attrs.type === 'result') {
+        if (response.attrs.type === WA_IQ_TYPES.RESULT) {
             // Mark uploaded key first so the serverHasPreKeys flag never commits ahead of local key progress.
             await this.preKeyStore.markKeyAsUploaded(lastPreKeyId);
             await Promise.all([
@@ -151,6 +163,7 @@ export class WaPassiveTasksCoordinator {
         const failure = parsePreKeyUploadFailure(response);
         this.logger.warn('upload prekeys failed', {
             count: preKeys.length,
+            lastPreKeyId,
             errorCode: failure.errorCode,
             errorText: failure.errorText
         });

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

@@ -0,0 +1,18 @@
+import { buildChatstateNode } from '../../transport/node/builders/chatstate.js';
+import { buildPresenceNode, buildPresenceSubscribeNode } from '../../transport/node/builders/presence.js';
+/** Builds a {@link WaPresenceCoordinator} from its node-send dependency. */
+export function createPresenceCoordinator(options) {
+    const { sendNode, getCurrentCredentials } = options;
+    return {
+        send: async (type) => {
+            const credentials = getCurrentCredentials();
+            await sendNode(buildPresenceNode({ type, name: credentials?.meDisplayName ?? undefined }));
+        },
+        sendChatstate: async (jid, opts) => {
+            await sendNode(buildChatstateNode({ jid, ...opts }));
+        },
+        subscribe: async (jid, opts) => {
+            await sendNode(buildPresenceSubscribeNode({ jid, ...opts }));
+        }
+    };
+}

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

@@ -1,3 +1,4 @@
+import { WA_NODE_TAGS } from '../../protocol/nodes.js';
 import { WA_PRIVACY_CATEGORY_TO_SETTING, WA_PRIVACY_SETTING_TO_CATEGORY, WA_PRIVACY_TAGS, WA_PRIVACY_VALUES } from '../../protocol/privacy.js';
 import { buildBlocklistChangeIq, buildGetBlocklistIq, buildGetPrivacyDisallowedListIq, buildGetPrivacySettingsIq, buildSetPrivacyCategoryIq } from '../../transport/node/builders/privacy.js';
 import { findNodeChild, getNodeChildren, getNodeChildrenByTag } from '../../transport/node/helpers.js';
@@ -11,12 +12,12 @@ const IGNORED_SERVER_CATEGORIES = new Set([
     'dependent_account_calling',
     'groupcreation'
 ]);
+const VALID_PRIVACY_VALUES = new Set(Object.values(WA_PRIVACY_VALUES));
 function isValidPrivacyValue(value) {
-    return (value !== WA_PRIVACY_VALUES.ERROR &&
-        Object.values(WA_PRIVACY_VALUES).includes(value));
+    return value !== WA_PRIVACY_VALUES.ERROR && VALID_PRIVACY_VALUES.has(value);
 }
 function parsePrivacySettings(result) {
-    const privacyNode = findNodeChild(result, 'privacy');
+    const privacyNode = findNodeChild(result, WA_NODE_TAGS.PRIVACY);
     if (!privacyNode) {
         return {};
     }
@@ -43,7 +44,7 @@ function parsePrivacySettings(result) {
     return settings;
 }
 function parseDisallowedList(result) {
-    const privacyNode = findNodeChild(result, 'privacy');
+    const privacyNode = findNodeChild(result, WA_NODE_TAGS.PRIVACY);
     if (!privacyNode) {
         return { jids: [] };
     }
@@ -66,7 +67,7 @@ function parseDisallowedList(result) {
     return { jids, dhash };
 }
 function parseBlocklist(result) {
-    const listNode = findNodeChild(result, 'list');
+    const listNode = findNodeChild(result, WA_NODE_TAGS.LIST);
     if (!listNode) {
         return { jids: [] };
     }
@@ -84,6 +85,7 @@ function parseBlocklist(result) {
     jids.length = jidsCount;
     return { jids, dhash };
 }
+/** Builds a {@link WaPrivacyCoordinator} backed by the given IQ query function. */
 export function createPrivacyCoordinator(options) {
     const { queryWithContext } = options;
     return {

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

@@ -1,10 +1,15 @@
-import { buildDeleteProfilePictureIq, buildGetDisappearingModeUsyncQueryNode, buildGetProfilePictureIq, buildGetStatusUsyncQueryNodes, buildSetProfilePictureIq, buildSetStatusIq } from '../../transport/node/builders/profile.js';
-import { buildUsyncIq } from '../../transport/node/builders/usync.js';
-import { findNodeChild, getNodeChildren } from '../../transport/node/helpers.js';
+import { parseJidFull, parsePhoneJid } from '../../protocol/jid.js';
+import { WA_NODE_TAGS } from '../../protocol/nodes.js';
+import { buildDeleteProfilePictureIq, buildGetDisappearingModeUsyncQueryNode, buildGetProfilePictureIq, buildGetStatusUsyncQueryNodes, buildGetTextStatusUsyncQueryNode, buildGetUsernameUsyncQueryNode, buildSetDisappearingModeIq, buildSetProfilePictureIq, buildSetStatusIq } from '../../transport/node/builders/profile.js';
+import { buildUsyncIq, iterateUsyncUsers, parseUsyncResultEnvelope } from '../../transport/node/builders/usync.js';
+import { findNodeChild, getNodeTextContent } from '../../transport/node/helpers.js';
+import { runMexQuery } from '../../transport/node/mex/client.js';
 import { assertIqResult } from '../../transport/node/query.js';
-import { TEXT_DECODER } from '../../util/bytes.js';
+import { logUsyncProtocolErrors } from '../../transport/node/usync.js';
+import { tryAsRecord, tryAsString } from '../../util/coercion.js';
+import { parseOptionalInt, parseOptionalSignedInt } from '../../util/primitives.js';
 function parseProfilePicture(result) {
-    const pictureNode = findNodeChild(result, 'picture');
+    const pictureNode = findNodeChild(result, WA_NODE_TAGS.PICTURE);
     if (!pictureNode) {
         return {};
     }
@@ -16,26 +21,15 @@ function parseProfilePicture(result) {
     };
 }
 function parseSetPictureResult(result) {
-    const pictureNode = findNodeChild(result, 'picture');
+    const pictureNode = findNodeChild(result, WA_NODE_TAGS.PICTURE);
     return pictureNode?.attrs.id ?? null;
 }
 function parseUsyncProfiles(result) {
-    const usyncNode = findNodeChild(result, 'usync');
-    if (!usyncNode) {
-        return [];
-    }
-    const listNode = findNodeChild(usyncNode, 'list');
-    if (!listNode) {
-        return [];
-    }
-    const userNodes = getNodeChildren(listNode);
+    const userNodes = iterateUsyncUsers(result) ?? [];
     const profiles = new Array(userNodes.length);
     let count = 0;
     for (let i = 0; i < userNodes.length; i += 1) {
         const userNode = userNodes[i];
-        if (userNode.tag !== 'user') {
-            continue;
-        }
         const jid = userNode.attrs.jid;
         if (!jid) {
             continue;
@@ -49,32 +43,19 @@ function parseUsyncProfiles(result) {
         }
         for (let j = 0; j < userContent.length; j += 1) {
             const child = userContent[j];
-            if (child.tag === 'picture') {
-                const idAttr = child.attrs.id;
-                if (idAttr) {
-                    const parsed = Number.parseInt(idAttr, 10);
-                    if (Number.isSafeInteger(parsed)) {
-                        info.pictureId = parsed;
-                    }
+            if (child.tag === WA_NODE_TAGS.PICTURE) {
+                const pictureId = parseOptionalInt(child.attrs.id);
+                if (pictureId !== undefined) {
+                    info.pictureId = pictureId;
                 }
             }
-            else if (child.tag === 'status') {
+            else if (child.tag === WA_NODE_TAGS.STATUS) {
                 const code = child.attrs.code;
-                if (code !== undefined && Number.parseInt(code, 10) === 401) {
+                if (parseOptionalInt(code) === 401) {
                     info.status = '';
                 }
                 else {
-                    const content = child.content;
-                    if (content instanceof Uint8Array) {
-                        const decoded = TEXT_DECODER.decode(content);
-                        info.status = decoded.length > 0 ? decoded : null;
-                    }
-                    else if (typeof content === 'string') {
-                        info.status = content.length > 0 ? content : null;
-                    }
-                    else {
-                        info.status = null;
-                    }
+                    info.status = getNodeTextContent(child) || null;
                 }
             }
         }
@@ -85,31 +66,23 @@ function parseUsyncProfiles(result) {
     return profiles;
 }
 function parseUsyncDisappearingModes(result) {
-    const usyncNode = findNodeChild(result, 'usync');
-    if (!usyncNode)
-        return [];
-    const listNode = findNodeChild(usyncNode, 'list');
-    if (!listNode)
-        return [];
-    const userNodes = getNodeChildren(listNode);
+    const userNodes = iterateUsyncUsers(result) ?? [];
     const results = new Array(userNodes.length);
     let count = 0;
     for (let i = 0; i < userNodes.length; i += 1) {
         const userNode = userNodes[i];
-        if (userNode.tag !== 'user')
-            continue;
         const userContent = userNode.content;
         if (!Array.isArray(userContent))
             continue;
         for (let j = 0; j < userContent.length; j += 1) {
             const child = userContent[j];
-            if (child.tag !== 'disappearing_mode')
+            if (child.tag !== WA_NODE_TAGS.DISAPPEARING_MODE)
                 continue;
-            const errorNode = findNodeChild(child, 'error');
+            const errorNode = findNodeChild(child, WA_NODE_TAGS.ERROR);
             if (errorNode)
                 continue;
-            const duration = Number.parseInt(child.attrs.duration ?? '0', 10);
-            const timestamp = Number.parseInt(child.attrs.t ?? '0', 10);
+            const duration = parseOptionalInt(child.attrs.duration) ?? 0;
+            const timestamp = parseOptionalInt(child.attrs.t) ?? 0;
             const entry = { duration, timestamp };
             if (child.attrs.ephemerality_disabled === 'true') {
                 entry.ephemeralityDisabled = true;
@@ -121,6 +94,82 @@ function parseUsyncDisappearingModes(result) {
     results.length = count;
     return results;
 }
+function parseUsyncTextStatuses(result) {
+    const userNodes = iterateUsyncUsers(result) ?? [];
+    const results = new Array(userNodes.length);
+    let count = 0;
+    for (let i = 0; i < userNodes.length; i += 1) {
+        const userNode = userNodes[i];
+        const jid = userNode.attrs.jid;
+        if (!jid)
+            continue;
+        let entry = {
+            jid,
+            text: null,
+            emoji: null,
+            ephemeralDurationSec: null,
+            lastUpdateTime: null
+        };
+        const textStatusNode = findNodeChild(userNode, WA_NODE_TAGS.TEXT_STATUS);
+        if (textStatusNode && !findNodeChild(textStatusNode, WA_NODE_TAGS.ERROR)) {
+            const emojiNode = findNodeChild(textStatusNode, 'emoji');
+            entry = {
+                jid,
+                text: textStatusNode.attrs.text ?? null,
+                emoji: emojiNode?.attrs.content ?? null,
+                ephemeralDurationSec: parseOptionalSignedInt(textStatusNode.attrs.ephemeral_duration_sec) ?? null,
+                lastUpdateTime: parseOptionalInt(textStatusNode.attrs.last_update_time) ?? null
+            };
+        }
+        results[count] = entry;
+        count += 1;
+    }
+    results.length = count;
+    return results;
+}
+function parseUsyncUsernames(result) {
+    const userNodes = iterateUsyncUsers(result) ?? [];
+    const results = new Array(userNodes.length);
+    let count = 0;
+    for (let i = 0; i < userNodes.length; i += 1) {
+        const userNode = userNodes[i];
+        const jid = userNode.attrs.jid;
+        if (!jid)
+            continue;
+        const usernameNode = findNodeChild(userNode, WA_NODE_TAGS.USERNAME);
+        const hasUsernameError = usernameNode && findNodeChild(usernameNode, WA_NODE_TAGS.ERROR) !== undefined;
+        const username = usernameNode && !hasUsernameError ? getNodeTextContent(usernameNode) || null : null;
+        results[count] = { jid, username };
+        count += 1;
+    }
+    results.length = count;
+    return results;
+}
+function parseOwnUsernameMexResponse(data) {
+    const info = tryAsRecord(tryAsRecord(data?.xwa2_username_get)?.username_info);
+    return {
+        username: tryAsString(info?.username),
+        state: tryAsString(info?.state),
+        pin: tryAsString(info?.pin)
+    };
+}
+function isMexSetUsernameSuccess(data) {
+    return data?.xwa2_username_set?.result === 'SUCCESS';
+}
+function parseAboutStatusMexResponse(data) {
+    return data?.xwa2_users_updates_since?.[0]?.updates?.[0]?.text ?? null;
+}
+function parseUsernameAvailabilityMexResponse(data) {
+    const check = data?.xwa2_username_check;
+    const suggestions = (Array.isArray(check?.suggestions) ? check.suggestions : []).filter((s) => typeof s === 'string');
+    return { available: check?.result === 'SUCCESS', suggestions };
+}
+function isMexUsernameKeySetSuccess(data) {
+    return data?.xwa2_username_pin_set?.result === 'SUCCESS';
+}
+function isMexNotFoundError(error) {
+    return error instanceof Error && /\berrors?:\s*404\b/.test(error.message);
+}
 function parseUsyncStatus(result) {
     const profiles = parseUsyncProfiles(result);
     if (profiles.length === 0) {
@@ -128,8 +177,22 @@ function parseUsyncStatus(result) {
     }
     return { status: profiles[0].status ?? null };
 }
+function buildTextStatusMutationInput(input) {
+    const text = input.text === '' ? null : (input.text ?? null);
+    const emoji = input.emoji ?? null;
+    let ephemeralDurationSec = input.ephemeralDurationSec ?? 0;
+    if (text === null && emoji === null && ephemeralDurationSec !== 0) {
+        ephemeralDurationSec = 0;
+    }
+    return {
+        text,
+        emoji: emoji !== null ? { content: emoji } : undefined,
+        ephemeral_duration_sec: ephemeralDurationSec
+    };
+}
+/** Builds a {@link WaProfileCoordinator} from its IQ/MEX/SID dependencies. */
 export function createProfileCoordinator(options) {
-    const { queryWithContext, generateSid } = options;
+    const { queryWithContext, generateSid, mexSocket, queryLidsByPhoneJids, mutations, logger } = options;
     return {
         getProfilePicture: async (jid, type, existingId) => {
             const node = buildGetProfilePictureIq(jid, type, existingId);
@@ -168,6 +231,7 @@ export function createProfileCoordinator(options) {
                 jid
             });
             assertIqResult(result, 'profile.getStatus');
+            logUsyncProtocolErrors(parseUsyncResultEnvelope(result), logger, 'profile.getStatus');
             return parseUsyncStatus(result);
         },
         setStatus: async (text) => {
@@ -177,6 +241,9 @@ export function createProfileCoordinator(options) {
             });
             assertIqResult(result, 'profile.setStatus');
         },
+        setPushName: async (name) => {
+            await mutations.set({ schema: 'SettingPushName', name });
+        },
         getProfiles: async (jids) => {
             if (jids.length === 0) {
                 return [];
@@ -192,6 +259,7 @@ export function createProfileCoordinator(options) {
                 count: jids.length
             });
             assertIqResult(result, 'profile.getProfiles');
+            logUsyncProtocolErrors(parseUsyncResultEnvelope(result), logger, 'profile.getProfiles');
             return parseUsyncProfiles(result);
         },
         getDisappearingMode: async (jids) => {
@@ -205,7 +273,110 @@ export function createProfileCoordinator(options) {
             });
             const result = await queryWithContext('profile.getDisappearingMode', usyncNode, undefined, { count: jids.length });
             assertIqResult(result, 'profile.getDisappearingMode');
+            logUsyncProtocolErrors(parseUsyncResultEnvelope(result), logger, 'profile.getDisappearingMode');
             return parseUsyncDisappearingModes(result);
+        },
+        setDisappearingMode: async (durationSeconds) => {
+            if (!Number.isFinite(durationSeconds) ||
+                !Number.isSafeInteger(durationSeconds) ||
+                durationSeconds < 0) {
+                throw new Error(`invalid durationSeconds: ${durationSeconds}`);
+            }
+            const node = buildSetDisappearingModeIq(durationSeconds);
+            const result = await queryWithContext('profile.setDisappearingMode', node, undefined, {
+                durationSeconds
+            });
+            assertIqResult(result, 'profile.setDisappearingMode');
+        },
+        getTextStatuses: async (jids) => {
+            if (jids.length === 0)
+                return [];
+            const sid = await generateSid();
+            const usyncNode = buildUsyncIq({
+                sid,
+                queryProtocolNodes: [buildGetTextStatusUsyncQueryNode()],
+                users: jids.map((jid) => ({ jid }))
+            });
+            const result = await queryWithContext('profile.getTextStatuses', usyncNode, undefined, {
+                count: jids.length
+            });
+            assertIqResult(result, 'profile.getTextStatuses');
+            logUsyncProtocolErrors(parseUsyncResultEnvelope(result), logger, 'profile.getTextStatuses');
+            return parseUsyncTextStatuses(result);
+        },
+        setTextStatus: async (input) => {
+            await runMexQuery(mexSocket, 'UpdateTextStatus', {
+                input: buildTextStatusMutationInput(input)
+            });
+        },
+        getUsernames: async (jids) => {
+            if (jids.length === 0)
+                return [];
+            const sid = await generateSid();
+            const usyncNode = buildUsyncIq({
+                sid,
+                queryProtocolNodes: [buildGetUsernameUsyncQueryNode()],
+                users: jids.map((jid) => ({ jid }))
+            });
+            const result = await queryWithContext('profile.getUsernames', usyncNode, undefined, {
+                count: jids.length
+            });
+            assertIqResult(result, 'profile.getUsernames');
+            logUsyncProtocolErrors(parseUsyncResultEnvelope(result), logger, 'profile.getUsernames');
+            return parseUsyncUsernames(result);
+        },
+        getOwnUsername: async () => {
+            try {
+                const data = await runMexQuery(mexSocket, 'GetUsername', {});
+                return parseOwnUsernameMexResponse(data);
+            }
+            catch (error) {
+                if (isMexNotFoundError(error)) {
+                    return { username: null, state: null, pin: null };
+                }
+                throw error;
+            }
+        },
+        setUsername: async (input) => {
+            const data = await runMexQuery(mexSocket, 'SetUsername', {
+                input: input.username,
+                reserved: input.reserved ?? false,
+                session_id: input.sessionId ?? '',
+                source: input.source ?? 'USER_INPUT'
+            });
+            return isMexSetUsernameSuccess(data);
+        },
+        deleteUsername: async () => {
+            const data = await runMexQuery(mexSocket, 'SetUsername', {});
+            return isMexSetUsernameSuccess(data);
+        },
+        getAboutStatus: async (jid) => {
+            const data = await runMexQuery(mexSocket, 'FetchAboutStatus', {
+                user: { user_id: parseJidFull(jid).address.user }
+            });
+            return parseAboutStatusMexResponse(data);
+        },
+        checkUsernameAvailability: async (username) => {
+            const data = await runMexQuery(mexSocket, 'UsernameAvailability', {
+                input: username
+            });
+            return parseUsernameAvailabilityMexResponse(data);
+        },
+        setUsernameKey: async (pin) => {
+            const data = await runMexQuery(mexSocket, 'SetUsernameKey', { pin });
+            return isMexUsernameKeySetSuccess(data);
+        },
+        getLidsByPhoneNumbers: async (phoneNumbers) => {
+            if (phoneNumbers.length === 0)
+                return [];
+            const normalizedPhoneJids = new Array(phoneNumbers.length);
+            for (let index = 0; index < phoneNumbers.length; index += 1) {
+                normalizedPhoneJids[index] = parsePhoneJid(phoneNumbers[index]);
+            }
+            logger.trace('profile.getLidsByPhoneNumbers', {
+                phones: normalizedPhoneJids.length
+            });
+            return queryLidsByPhoneJids(normalizedPhoneJids);
         }
     };
 }