zapo-js 0.3.0 → 1.0.0

package/dist/retry/replay.js

@@ -1,19 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WaRetryReplayService = void 0;
-const device_sent_1 = require("../message/device-sent");
-const padding_1 = require("../message/padding");
+const icdc_1 = require("../message/crypto/icdc");
+const device_sent_1 = require("../message/encode/device-sent");
+const padding_1 = require("../message/encode/padding");
 const _proto_1 = require("../proto.js");
+const constants_1 = require("../protocol/constants");
 const jid_1 = require("../protocol/jid");
 const codec_1 = require("./codec");
 const binary_1 = require("../transport/binary");
 const message_1 = require("../transport/node/builders/message");
 const helpers_1 = require("../transport/node/helpers");
 const primitives_1 = require("../util/primitives");
+/**
+ * Replays a previously-sent outbound message in response to an incoming
+ * retry receipt. Dispatches to plaintext/encrypted/opaque-node handlers
+ * based on the stored payload shape.
+ */
 class WaRetryReplayService {
     constructor(options) {
         this.options = options;
     }
+    /**
+     * Resends `outbound` to `requesterJid`. Returns `'resent'` on a fresh
+     * send or `'ineligible'` when the cached payload cannot satisfy the
+     * request (e.g. requester not in the original device list).
+     */
     async resendOutboundMessage(outbound, requesterJid, retryCount) {
         const payload = outbound.replayPayload instanceof Uint8Array
             ? (0, codec_1.decodeRetryReplayPayload)(outbound.replayPayload)
@@ -42,43 +54,137 @@ class WaRetryReplayService {
         catch {
             return 'ineligible';
         }
-        if (payloadUserJid !== requesterUserJid) {
+        const requesterIsSelf = this.isRequesterCurrentAccount(requesterJid);
+        if (payloadUserJid !== requesterUserJid && !requesterIsSelf) {
             return 'ineligible';
         }
-        const encrypted = await this.options.signalProtocol.encryptMessage(requesterAddress, payload.plaintext);
+        const plaintext = (await this.refreshRetryPlaintext(payload, {
+            wrapAsDeviceSent: requesterIsSelf,
+            includeRecipientIcdc: true,
+            logContext: 'direct'
+        })) ?? payload.plaintext;
+        await this.options.sessionResolver.ensureSession(requesterAddress, requesterJid);
+        const encrypted = await this.options.signalProtocol.encryptMessage(requesterAddress, plaintext);
+        const deviceIdentity = encrypted.type === 'pkmsg' ? this.resolveSignedDeviceIdentity('direct') : undefined;
+        const metaNode = (0, jid_1.isHostedDeviceJid)(requesterJid)
+            ? (0, message_1.buildMetaNode)({ sender_intent: 'hosted' })
+            : undefined;
         await this.options.messageClient.sendEncrypted({
             to: requesterJid,
             encType: encrypted.type,
             ciphertext: encrypted.ciphertext,
             encCount: retryCount,
             id: outbound.messageId,
-            type: payload.type
+            type: payload.type,
+            deviceIdentity,
+            metaNode
         });
         return 'resent';
     }
+    resolveSignedDeviceIdentity(context) {
+        const signedIdentity = this.options.getCurrentCredentials()?.signedIdentity;
+        if (!signedIdentity) {
+            this.options.logger.warn('retry request missing signed identity for pkmsg envelope', {
+                context
+            });
+            return undefined;
+        }
+        return _proto_1.proto.ADVSignedDeviceIdentity.encode(signedIdentity).finish();
+    }
+    async refreshRetryPlaintext(payload, options) {
+        if (!options.wrapAsDeviceSent && !this.options.resolveUserIcdc) {
+            return null;
+        }
+        try {
+            const messageBytes = (0, padding_1.unpadPkcs7)(payload.plaintext);
+            const decoded = _proto_1.proto.Message.decode(messageBytes);
+            let message = decoded;
+            let changed = false;
+            if (this.options.resolveUserIcdc) {
+                const meUserJid = this.safeUserJid(this.options.getCurrentCredentials()?.meJid);
+                const recipientUserJid = options.includeRecipientIcdc
+                    ? this.safeUserJid(payload.to)
+                    : null;
+                const [senderIcdc, recipientIcdc] = await Promise.all([
+                    meUserJid ? this.options.resolveUserIcdc(meUserJid) : Promise.resolve(null),
+                    recipientUserJid
+                        ? this.options.resolveUserIcdc(recipientUserJid)
+                        : Promise.resolve(null)
+                ]);
+                const injected = (0, icdc_1.injectDeviceListMetadata)(message, senderIcdc, recipientIcdc);
+                if (injected !== message) {
+                    message = injected;
+                    changed = true;
+                }
+            }
+            if (options.wrapAsDeviceSent && !message.deviceSentMessage) {
+                message = (0, device_sent_1.wrapDeviceSentMessage)(message, payload.to);
+                changed = true;
+            }
+            if (!changed) {
+                return null;
+            }
+            return (0, padding_1.writeRandomPadMax16)(_proto_1.proto.Message.encode(message).finish());
+        }
+        catch (error) {
+            this.options.logger.warn('retry request failed to refresh plaintext', {
+                context: options.logContext,
+                to: payload.to,
+                message: (0, primitives_1.toError)(error).message
+            });
+            return null;
+        }
+    }
+    safeUserJid(jid) {
+        if (!jid)
+            return null;
+        try {
+            return (0, jid_1.toUserJid)(jid);
+        }
+        catch {
+            return null;
+        }
+    }
     async resendGroupPlaintextPayload(outbound, payload, requesterJid, requesterAddress, retryCount) {
-        const plaintext = (await this.maybeWrapGroupRetryPlaintextForSelfDevice(payload, requesterJid)) ??
-            payload.plaintext;
+        const plaintext = (await this.refreshRetryPlaintext(payload, {
+            wrapAsDeviceSent: this.isRequesterCurrentAccount(requesterJid),
+            includeRecipientIcdc: false,
+            logContext: 'group'
+        })) ?? payload.plaintext;
         const encrypted = await this.options.signalProtocol.encryptMessage(requesterAddress, plaintext);
         let deviceIdentity;
         if (encrypted.type === 'pkmsg') {
-            const signedIdentity = this.options.getCurrentSignedIdentity();
+            const signedIdentity = this.options.getCurrentCredentials()?.signedIdentity;
             if (!signedIdentity) {
                 this.options.logger.warn('retry request rejected: missing signed identity for pkmsg group retry');
                 return 'ineligible';
             }
             deviceIdentity = _proto_1.proto.ADVSignedDeviceIdentity.encode(signedIdentity).finish();
         }
+        const isStatus = (0, jid_1.isStatusBroadcastJid)(payload.to);
+        const metaAttrs = {};
+        if (isStatus) {
+            metaAttrs.status_setting = payload.statusSetting ?? 'contacts';
+        }
+        if ((0, jid_1.isHostedDeviceJid)(requesterJid)) {
+            metaAttrs.sender_intent = 'hosted';
+        }
+        const metaNode = Object.keys(metaAttrs).length > 0 ? (0, message_1.buildMetaNode)(metaAttrs) : undefined;
         const retryNode = (0, message_1.buildGroupRetryMessageNode)({
             to: payload.to,
             type: payload.type,
             id: outbound.messageId,
             requesterJid,
-            addressingMode: requesterAddress.server === 'lid' ? 'lid' : 'pn',
+            addressingMode: isStatus
+                ? undefined
+                : requesterAddress.server === constants_1.WA_DEFAULTS.LID_SERVER
+                    ? 'lid'
+                    : 'pn',
             encType: encrypted.type,
             ciphertext: encrypted.ciphertext,
             retryCount,
-            deviceIdentity
+            deviceIdentity,
+            metaNode
         });
         await this.options.messageClient.sendMessageNode(retryNode);
         return 'resent';
@@ -90,6 +196,12 @@ class WaRetryReplayService {
         if ((0, jid_1.normalizeDeviceJid)(payload.to) !== normalizedRequesterJid) {
             return 'ineligible';
         }
+        const deviceIdentity = payload.encType === 'pkmsg'
+            ? this.resolveSignedDeviceIdentity('encrypted_replay')
+            : undefined;
+        const metaNode = (0, jid_1.isHostedDeviceJid)(requesterJid)
+            ? (0, message_1.buildMetaNode)({ sender_intent: 'hosted' })
+            : undefined;
         await this.options.messageClient.sendEncrypted({
             to: requesterJid,
             encType: payload.encType,
@@ -97,7 +209,9 @@ class WaRetryReplayService {
             encCount: retryCount,
             id: outbound.messageId,
             type: payload.type,
-            participant: payload.participant
+            participant: payload.participant,
+            deviceIdentity,
+            metaNode
         });
         return 'resent';
     }
@@ -118,39 +232,19 @@ class WaRetryReplayService {
         await this.options.messageClient.sendMessageNode(replayNode);
         return 'resent';
     }
-    async maybeWrapGroupRetryPlaintextForSelfDevice(payload, requesterJid) {
-        if (!this.isRequesterCurrentAccount(requesterJid)) {
-            return null;
-        }
-        try {
-            const messageBytes = (0, padding_1.unpadPkcs7)(payload.plaintext);
-            const message = _proto_1.proto.Message.decode(messageBytes);
-            const wrapped = (0, device_sent_1.wrapDeviceSentMessage)(message, payload.to);
-            return (0, padding_1.writeRandomPadMax16)(_proto_1.proto.Message.encode(wrapped).finish());
-        }
-        catch (error) {
-            this.options.logger.warn('retry request failed to wrap deviceSent payload for self requester', {
-                requester: requesterJid,
-                to: payload.to,
-                message: (0, primitives_1.toError)(error).message
-            });
-            return null;
-        }
-    }
     isRequesterCurrentAccount(requesterJid) {
         const requesterUser = (0, jid_1.toUserJid)(requesterJid);
-        const meJid = this.options.getCurrentMeJid();
-        if (meJid && (0, jid_1.toUserJid)(meJid) === requesterUser) {
+        const credentials = this.options.getCurrentCredentials();
+        if (credentials?.meJid && (0, jid_1.toUserJid)(credentials.meJid) === requesterUser) {
             return true;
         }
-        const meLid = this.options.getCurrentMeLid();
-        if (meLid && (0, jid_1.toUserJid)(meLid) === requesterUser) {
+        if (credentials?.meLid && (0, jid_1.toUserJid)(credentials.meLid) === requesterUser) {
             return true;
         }
         return false;
     }
     isOpaqueReplayCompatible(node, normalizedRequesterJid) {
-        const participantsNode = (0, helpers_1.findNodeChild)(node, 'participants');
+        const participantsNode = (0, helpers_1.findNodeChild)(node, constants_1.WA_NODE_TAGS.PARTICIPANTS);
         if (participantsNode) {
             const participantsContent = Array.isArray(participantsNode.content)
                 ? participantsNode.content

package/dist/retry/tracker.js

@@ -5,6 +5,7 @@ const jid_1 = require("../protocol/jid");
 const codec_1 = require("./codec");
 const constants_1 = require("./constants");
 const primitives_1 = require("../util/primitives");
+/** Builds an {@link OutboundRetryTracker} backed by a {@link WaRetryStore}. */
 function createOutboundRetryTracker(options) {
     const { retryStore, logger } = options;
     const retryTtlMs = retryStore.getTtlMs?.() ?? constants_1.RETRY_OUTBOUND_TTL_MS;
@@ -20,7 +21,7 @@ function createOutboundRetryTracker(options) {
                 continue;
             }
             try {
-                deduped.add((0, jid_1.normalizeDeviceJid)(raw));
+                deduped.add((0, jid_1.toUserJid)(raw));
             }
             catch {
                 continue;
@@ -48,7 +49,6 @@ function createOutboundRetryTracker(options) {
     };
     return {
         track: async (hint, publish) => {
-            const nowMs = Date.now();
             const replayMode = hint.replayPayload.mode;
             const resolvedToJid = hint.toJid ?? (replayMode === 'opaque_node' ? '' : hint.replayPayload.to);
             const replayPayload = supportsRawReplayPayload
@@ -59,7 +59,7 @@ function createOutboundRetryTracker(options) {
                 resolvedToJid &&
                 !(0, jid_1.isGroupOrBroadcastJid)(resolvedToJid)) {
                 try {
-                    eligibleRequesterDeviceJids = [(0, jid_1.normalizeDeviceJid)(resolvedToJid)];
+                    eligibleRequesterDeviceJids = [(0, jid_1.toUserJid)(resolvedToJid)];
                 }
                 catch {
                     eligibleRequesterDeviceJids = undefined;
@@ -68,15 +68,11 @@ function createOutboundRetryTracker(options) {
             const createRetryOutboundRecord = (messageId, updatedAtMs, expiresAtMs) => ({
                 messageId,
                 toJid: resolvedToJid,
-                participantJid: hint.participantJid,
-                recipientJid: hint.recipientJid,
                 eligibleRequesterDeviceJids,
                 deliveredRequesterDeviceJids: [],
-                messageType: hint.type,
                 replayMode,
                 replayPayload,
                 state: 'pending',
-                createdAtMs: nowMs,
                 updatedAtMs,
                 expiresAtMs
             });

package/dist/signal/api/SignalDeviceSyncApi.js

@@ -8,6 +8,10 @@ const usync_1 = require("../../transport/node/builders/usync");
 const helpers_1 = require("../../transport/node/helpers");
 const query_1 = require("../../transport/node/query");
 const usync_2 = require("../../transport/node/usync");
+/**
+ * Resolves the device list and LID mapping for a set of users via the `usync`
+ * protocol. Concurrent calls for the same JIDs are deduplicated.
+ */
 class SignalDeviceSyncApi {
     constructor(options) {
         this.syncDedup = new PromiseDedup_1.PromiseDedup();
@@ -19,6 +23,10 @@ class SignalDeviceSyncApi {
         this.hostDomain = options.hostDomain ?? constants_1.WA_DEFAULTS.HOST_DOMAIN;
         this.generateSid = options.generateSid ?? (0, usync_2.createUsyncSidGenerator)();
     }
+    /**
+     * Refreshes the device list for every JID in `userJids`. Returns the
+     * resolved per-user device JIDs (matches the on-store snapshot).
+     */
     syncDeviceList(userJids, timeoutMs = this.defaultTimeoutMs) {
         const normalizedUsers = this.normalizeUsers(userJids);
         if (normalizedUsers.length === 0) {
@@ -87,6 +95,10 @@ class SignalDeviceSyncApi {
         });
         return merged;
     }
+    /**
+     * Looks up LIDs for a list of phone JIDs via a `lid` usync query. Returns
+     * one entry per input JID with `exists` indicating server-side presence.
+     */
     async queryLidsByPhoneJids(phoneJids, timeoutMs = this.defaultTimeoutMs) {
         const normalizedPhoneJids = this.normalizeUsers(phoneJids);
         if (normalizedPhoneJids.length === 0) {
@@ -128,8 +140,51 @@ class SignalDeviceSyncApi {
             users: result.length,
             found
         });
+        await this.propagateAltUserJids(result);
         return result;
     }
+    /**
+     * Enriches existing device-list snapshots with the resolved LID equivalents
+     * so {@link WaDeviceListStore.findByAnyUserJid} can later match a retry
+     * receipt arriving in LID form against an eligible list stored in PN form
+     * (and vice versa). Skips users with no cached snapshot — the alt gets
+     * recorded on the next {@link syncDeviceList} sweep.
+     */
+    async propagateAltUserJids(results) {
+        if (!this.deviceListStore || results.length === 0)
+            return;
+        const nowMs = Date.now();
+        const lidByPhoneJid = new Map();
+        const phoneJids = [];
+        for (const entry of results) {
+            if (entry.lidJid && entry.phoneJid) {
+                lidByPhoneJid.set(entry.phoneJid, entry.lidJid);
+                phoneJids.push(entry.phoneJid);
+            }
+        }
+        if (phoneJids.length === 0)
+            return;
+        const existing = await this.deviceListStore.getUserDevicesBatch(phoneJids, nowMs);
+        const updates = [];
+        for (let index = 0; index < phoneJids.length; index += 1) {
+            const snapshot = existing[index];
+            if (!snapshot)
+                continue;
+            const phoneJid = phoneJids[index];
+            const lidJid = lidByPhoneJid.get(phoneJid);
+            if (!lidJid || snapshot.altUserJid === lidJid)
+                continue;
+            updates.push({
+                userJid: snapshot.userJid,
+                altUserJid: lidJid,
+                deviceJids: snapshot.deviceJids,
+                updatedAtMs: nowMs
+            });
+        }
+        if (updates.length > 0) {
+            await this.deviceListStore.upsertUserDevicesBatch(updates);
+        }
+    }
     async collectUsersToQuery(normalizedUsers, nowMs, cachedByUser, store) {
         const records = await store.getUserDevicesBatch(normalizedUsers, nowMs);
         const usersToQuery = new Array(normalizedUsers.length);
@@ -203,16 +258,12 @@ class SignalDeviceSyncApi {
     }
     parseDeviceSyncResponse(node, requestedUsers) {
         (0, query_1.assertIqResult)(node, 'signal device sync');
-        const usyncNode = (0, helpers_1.findNodeChild)(node, constants_1.WA_NODE_TAGS.USYNC);
-        if (!usyncNode) {
-            throw new Error('signal device sync response missing usync node');
-        }
-        const listNode = (0, helpers_1.findNodeChild)(usyncNode, constants_1.WA_NODE_TAGS.LIST);
-        if (!listNode) {
-            throw new Error('signal device sync response missing list node');
+        (0, usync_2.logUsyncProtocolErrors)((0, usync_1.parseUsyncResultEnvelope)(node), this.logger, 'signal.deviceSync');
+        const userNodes = (0, usync_1.iterateUsyncUsers)(node);
+        if (!userNodes) {
+            throw new Error('signal device sync response missing usync envelope');
         }
         const requestedSet = new Set(requestedUsers);
-        const userNodes = (0, helpers_1.getNodeChildrenByTag)(listNode, constants_1.WA_NODE_TAGS.USER);
         const parsed = new Array(userNodes.length);
         let parsedCount = 0;
         for (let index = 0; index < userNodes.length; index += 1) {
@@ -236,16 +287,12 @@ class SignalDeviceSyncApi {
     }
     parseLidSyncResponse(node, requestedUsers) {
         (0, query_1.assertIqResult)(node, 'signal lid sync');
-        const usyncNode = (0, helpers_1.findNodeChild)(node, constants_1.WA_NODE_TAGS.USYNC);
-        if (!usyncNode) {
-            throw new Error('signal lid sync response missing usync node');
-        }
-        const listNode = (0, helpers_1.findNodeChild)(usyncNode, constants_1.WA_NODE_TAGS.LIST);
-        if (!listNode) {
-            throw new Error('signal lid sync response missing list node');
+        (0, usync_2.logUsyncProtocolErrors)((0, usync_1.parseUsyncResultEnvelope)(node), this.logger, 'signal.lidSync');
+        const userNodes = (0, usync_1.iterateUsyncUsers)(node);
+        if (!userNodes) {
+            throw new Error('signal lid sync response missing usync envelope');
         }
         const requestedSet = new Set(requestedUsers);
-        const userNodes = (0, helpers_1.getNodeChildrenByTag)(listNode, constants_1.WA_NODE_TAGS.USER);
         const parsed = new Array(userNodes.length);
         let parsedCount = 0;
         for (let index = 0; index < userNodes.length; index += 1) {
@@ -335,7 +382,7 @@ class SignalDeviceSyncApi {
             ? rawUserJid.slice(rawAtIndex + 1)
             : parsedNormalizedUser.server;
         const dedup = new Set();
-        for (const deviceNode of (0, helpers_1.getNodeChildrenByTag)(deviceListNode, 'device')) {
+        for (const deviceNode of (0, helpers_1.getNodeChildrenByTag)(deviceListNode, constants_1.WA_NODE_TAGS.DEVICE)) {
             const parsedId = deviceNode.attrs.id
                 ? Number.parseInt(deviceNode.attrs.id, 10)
                 : Number.NaN;

package/dist/signal/api/SignalDigestSyncApi.js

@@ -9,6 +9,11 @@ const constants_2 = require("../api/constants");
 const helpers_1 = require("../../transport/node/helpers");
 const query_1 = require("../../transport/node/query");
 const bytes_1 = require("../../util/bytes");
+/**
+ * Validates the local Signal key bundle (identity, signed prekey, one-time
+ * prekey ids) against the server-side digest. Used to detect drift after a
+ * crash or partial sync and decide whether to re-upload.
+ */
 class SignalDigestSyncApi {
     constructor(options) {
         this.logger = options.logger;
@@ -123,7 +128,7 @@ class SignalDigestSyncApi {
             }
             bytesToHash.push((0, keys_1.toRawPubKey)(preKey.keyPair.pubKey));
         }
-        const localHash = (await (0, _crypto_1.sha1)((0, bytes_1.concatBytes)(bytesToHash))).subarray(0, digest.hash.byteLength);
+        const localHash = (0, _crypto_1.sha1)(bytesToHash).subarray(0, digest.hash.byteLength);
         if (!(0, bytes_1.uint8Equal)(localHash, digest.hash)) {
             return {
                 valid: false,

package/dist/signal/api/SignalIdentitySyncApi.js

@@ -9,6 +9,11 @@ const codec_1 = require("../api/codec");
 const constants_2 = require("../api/constants");
 const helpers_1 = require("../../transport/node/helpers");
 const query_1 = require("../../transport/node/query");
+/**
+ * Fetches identity keys for a list of JIDs from the server and persists them
+ * into the identity store. Concurrent calls for the same JID set are
+ * deduplicated.
+ */
 class SignalIdentitySyncApi {
     constructor(options) {
         this.syncDedup = new PromiseDedup_1.PromiseDedup();
@@ -19,6 +24,10 @@ class SignalIdentitySyncApi {
             options.defaultTimeoutMs ?? constants_1.WA_DEFAULTS.SIGNAL_FETCH_KEY_BUNDLES_TIMEOUT_MS;
         this.hostDomain = options.hostDomain ?? constants_1.WA_DEFAULTS.HOST_DOMAIN;
     }
+    /**
+     * Fetches and persists identity keys for `targetJids`. Returns one entry
+     * per JID the server resolved; missing/erroring users are skipped.
+     */
     syncIdentityKeys(targetJids, timeoutMs = this.defaultTimeoutMs) {
         const dedupKey = `${timeoutMs}:${targetJids.join(',')}`;
         return this.syncDedup.run(dedupKey, () => this.syncIdentityKeysInternal(targetJids, timeoutMs));

package/dist/signal/api/SignalMissingPreKeysSyncApi.js

@@ -12,6 +12,10 @@ const query_1 = require("../../transport/node/query");
 function isMissingPreKeysUserResultPreferred(result) {
     return 'devices' in result;
 }
+/**
+ * Fetches missing prekey bundles for specific (user, device, registration id)
+ * triples – used during message encryption when a Signal session is missing.
+ */
 class SignalMissingPreKeysSyncApi {
     constructor(options) {
         this.logger = options.logger;
@@ -19,6 +23,10 @@ class SignalMissingPreKeysSyncApi {
         this.defaultTimeoutMs =
             options.defaultTimeoutMs ?? constants_1.WA_DEFAULTS.SIGNAL_FETCH_KEY_BUNDLES_TIMEOUT_MS;
     }
+    /**
+     * Fetches prekey bundles for the requested `targets` in a single IQ.
+     * Returns either a per-device bundle list or an error envelope per user.
+     */
     async fetchMissingPreKeys(targets, timeoutMs = this.defaultTimeoutMs) {
         if (targets.length === 0) {
             return [];
@@ -94,69 +102,22 @@ class SignalMissingPreKeysSyncApi {
             if (!Number.isSafeInteger(deviceId) || deviceId < 0) {
                 throw new Error(`missing prekeys device[${index}].id is invalid`);
             }
-            const [registrationNode, identityNode, signedKeyNode, oneTimeNode, deviceIdentityNode] = (0, helpers_1.findNodeChildrenByTags)(deviceNode, [
-                constants_1.WA_NODE_TAGS.REGISTRATION,
-                constants_1.WA_NODE_TAGS.IDENTITY,
-                constants_1.WA_NODE_TAGS.SKEY,
-                constants_1.WA_NODE_TAGS.KEY,
-                constants_1.WA_NODE_TAGS.DEVICE_IDENTITY
-            ]);
-            if (!registrationNode || !identityNode || !signedKeyNode) {
+            const registrationNode = (0, helpers_1.findNodeChild)(deviceNode, constants_1.WA_NODE_TAGS.REGISTRATION);
+            if (!registrationNode) {
                 throw new Error(`missing prekeys device payload is incomplete for ${userJid}`);
             }
-            const [signedKeyIdNode, signedKeyValueNode, signedKeySignatureNode] = (0, helpers_1.findNodeChildrenByTags)(signedKeyNode, [
-                constants_1.WA_NODE_TAGS.ID,
-                constants_1.WA_NODE_TAGS.VALUE,
-                constants_1.WA_NODE_TAGS.SIGNATURE
-            ]);
-            if (!signedKeyIdNode || !signedKeyValueNode || !signedKeySignatureNode) {
-                throw new Error(`missing prekeys signed pre-key is incomplete for ${userJid}`);
-            }
-            let oneTimeIdNode;
-            let oneTimeValueNode;
-            if (oneTimeNode) {
-                const oneTimeNodes = (0, helpers_1.findNodeChildrenByTags)(oneTimeNode, [
-                    constants_1.WA_NODE_TAGS.ID,
-                    constants_1.WA_NODE_TAGS.VALUE
-                ]);
-                oneTimeIdNode = oneTimeNodes[0];
-                oneTimeValueNode = oneTimeNodes[1];
-            }
-            if (oneTimeNode && (!oneTimeIdNode || !oneTimeValueNode)) {
-                throw new Error(`missing prekeys one-time key is incomplete for ${userJid}`);
-            }
-            const baseBundle = {
-                regId: (0, codec_1.parseUint)((0, codec_1.decodeExactLength)(registrationNode.content, 'missing prekeys device registration', constants_2.SIGNAL_REGISTRATION_ID_LENGTH), 'missing prekeys device registration'),
-                identity: (0, codec_1.decodeExactLength)(identityNode.content, 'missing prekeys device identity', constants_2.SIGNAL_KEY_DATA_LENGTH),
-                signedKey: {
-                    id: (0, codec_1.parseUint)((0, codec_1.decodeExactLength)(signedKeyIdNode.content, 'missing prekeys device skey.id', constants_2.SIGNAL_KEY_ID_LENGTH), 'missing prekeys device skey.id'),
-                    publicKey: (0, codec_1.decodeExactLength)(signedKeyValueNode.content, 'missing prekeys device skey.value', constants_2.SIGNAL_KEY_DATA_LENGTH),
-                    signature: (0, codec_1.decodeExactLength)(signedKeySignatureNode.content, 'missing prekeys device skey.signature', constants_2.SIGNAL_SIGNATURE_LENGTH)
-                }
+            const regId = (0, codec_1.parseUint)((0, codec_1.decodeExactLength)(registrationNode.content, 'missing prekeys device registration', constants_2.SIGNAL_REGISTRATION_ID_LENGTH), 'missing prekeys device registration');
+            const parsed = (0, codec_1.parseSignalKeyBundleFromNode)(deviceNode, 'missing prekeys device');
+            const bundle = {
+                regId,
+                identity: parsed.identity,
+                signedKey: parsed.signedKey,
+                ...(parsed.oneTimeKey ? { oneTimeKey: parsed.oneTimeKey } : {})
             };
-            const bundle = oneTimeIdNode && oneTimeValueNode
-                ? {
-                    ...baseBundle,
-                    oneTimeKey: {
-                        id: (0, codec_1.parseUint)((0, codec_1.decodeExactLength)(oneTimeIdNode.content, 'missing prekeys device key.id', constants_2.SIGNAL_KEY_ID_LENGTH), 'missing prekeys device key.id'),
-                        publicKey: (0, codec_1.decodeExactLength)(oneTimeValueNode.content, 'missing prekeys device key.value', constants_2.SIGNAL_KEY_DATA_LENGTH)
-                    }
-                }
-                : baseBundle;
-            let deviceIdentity;
-            if (deviceIdentityNode) {
-                deviceIdentity = (0, helpers_1.decodeNodeContentBase64OrBytes)(deviceIdentityNode.content, 'missing prekeys device device-identity');
-            }
-            bundles[index] = deviceIdentity
-                ? {
-                    deviceJid: deviceId === 0 ? userJid : `${user}:${deviceId}@${server}`,
-                    bundle,
-                    deviceIdentity
-                }
-                : {
-                    deviceJid: deviceId === 0 ? userJid : `${user}:${deviceId}@${server}`,
-                    bundle
-                };
+            const deviceJid = deviceId === 0 ? userJid : `${user}:${deviceId}@${server}`;
+            bundles[index] = parsed.deviceIdentity
+                ? { deviceJid, bundle, deviceIdentity: parsed.deviceIdentity }
+                : { deviceJid, bundle };
         }
         return bundles;
     }

package/dist/signal/api/SignalRotateKeyApi.js

@@ -5,6 +5,11 @@ const constants_1 = require("../../protocol/constants");
 const prekeys_1 = require("../api/prekeys");
 const keygen_1 = require("../registration/keygen");
 const query_1 = require("../../transport/node/query");
+/**
+ * Generates a fresh signed prekey and uploads it to the server. Handles the
+ * `406`/`409`/`5xx` error codes by signaling whether a digest re-validation
+ * is required.
+ */
 class SignalRotateKeyApi {
     constructor(options) {
         this.logger = options.logger;
@@ -12,6 +17,11 @@ class SignalRotateKeyApi {
         this.signalStore = options.signalStore;
         this.defaultTimeoutMs = options.defaultTimeoutMs ?? constants_1.WA_DEFAULTS.IQ_TIMEOUT_MS;
     }
+    /**
+     * Rotates the signed prekey by generating a new one (next key id) and
+     * uploading it. Returns `shouldDigestKey: true` when the caller should
+     * re-run a digest validation after the rotation.
+     */
     async rotateSignedPreKey(timeoutMs = this.defaultTimeoutMs) {
         const [registrationInfo, currentSignedPreKey] = await Promise.all([
             this.signalStore.getRegistrationInfo(),