zapo-js 1.0.0 → 1.1.0

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src=".github/assets/logo.png" alt="zapo" width="400" />
+  <img src="https://raw.githubusercontent.com/vinikjkkj/zapo/master/.github/assets/logo.png" alt="zapo" width="400" />
 </p>
 
 <p align="center">

package/dist/{types/appstate → appstate}/crypto/WaAppStateCrypto.d.ts

@@ -1,4 +1,4 @@
-import { type Proto } from '../..';
+import { type Proto } from '../../proto';
 interface WaAppStateDerivedKeys {
     readonly indexHmacKey: Uint8Array;
     readonly valueEncryptionAesKey: Uint8Array;

package/dist/appstate/crypto/WaAppStateCrypto.js

@@ -5,7 +5,7 @@ const constants_1 = require("../constants");
 const hkdf_1 = require("../../crypto/core/hkdf");
 const primitives_1 = require("../../crypto/core/primitives");
 const random_1 = require("../../crypto/core/random");
-const _proto_1 = require("../../proto.js");
+const _proto_1 = require("../../proto");
 const constants_2 = require("../../protocol/constants");
 const bytes_1 = require("../../util/bytes");
 const collections_1 = require("../../util/collections");

package/dist/appstate/parsers/encoding.js

@@ -4,7 +4,7 @@ exports.encodeAppStateFingerprint = encodeAppStateFingerprint;
 exports.decodeAppStateFingerprint = decodeAppStateFingerprint;
 exports.decodeAppStateSyncKeys = decodeAppStateSyncKeys;
 exports.decodeAppStateCollections = decodeAppStateCollections;
-const _proto_1 = require("../../proto.js");
+const _proto_1 = require("../../proto");
 const coercion_1 = require("../../util/coercion");
 const primitives_1 = require("../../util/primitives");
 /** Serializes an app-state sync key fingerprint to its protobuf bytes, or `null` when absent. */

package/dist/{types/appstate → appstate}/parsers/response-parser.d.ts

@@ -1,5 +1,5 @@
 import type { AppStateCollectionName, AppStateCollectionState } from '../types';
-import { type Proto } from '../..';
+import { type Proto } from '../../proto';
 import type { BinaryNode } from '../../transport/types';
 export interface CollectionResponsePayload {
     readonly collection: AppStateCollectionName;

package/dist/appstate/parsers/response-parser.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseSyncResponse = parseSyncResponse;
 exports.parseCollectionState = parseCollectionState;
 const utils_1 = require("../utils");
-const _proto_1 = require("../../proto.js");
+const _proto_1 = require("../../proto");
 const constants_1 = require("../../protocol/constants");
 const helpers_1 = require("../../transport/node/helpers");
 const primitives_1 = require("../../util/primitives");

package/dist/{types/appstate → appstate}/sync/WaAppStateSyncClient.d.ts

@@ -1,6 +1,6 @@
 import type { WaAppStateMissingKeysEvent, WaAppStateSyncKey, WaAppStateSyncOptions, WaAppStateSyncResult } from '../types';
 import type { Logger } from '../../infra/log/types';
-import { type Proto } from '../..';
+import { type Proto } from '../../proto';
 import type { WaAppStateStore } from '../../store/contracts/appstate.store';
 import type { BinaryNode } from '../../transport/types';
 import type { ServerClock } from '../../util/clock';

package/dist/appstate/sync/WaAppStateSyncClient.js

@@ -4,8 +4,8 @@ exports.WaAppStateSyncClient = void 0;
 const constants_1 = require("../constants");
 const WaAppStateCrypto_1 = require("../crypto/WaAppStateCrypto");
 const response_parser_1 = require("../parsers/response-parser");
-const _crypto_1 = require("../../crypto/index.js");
-const _proto_1 = require("../../proto.js");
+const _crypto_1 = require("../../crypto");
+const _proto_1 = require("../../proto");
 const constants_2 = require("../../protocol/constants");
 const jid_1 = require("../../protocol/jid");
 const query_1 = require("../../transport/node/query");

package/dist/{types/appstate → appstate}/types.d.ts

@@ -1,4 +1,4 @@
-import type { Proto } from '..';
+import type { Proto } from '../proto';
 import type { WA_APP_STATE_COLLECTION_STATES, WA_APP_STATE_COLLECTIONS } from '../protocol/constants';
 export type AppStateCollectionName = (typeof WA_APP_STATE_COLLECTIONS)[keyof typeof WA_APP_STATE_COLLECTIONS];
 export type AppStateCollectionState = (typeof WA_APP_STATE_COLLECTION_STATES)[keyof typeof WA_APP_STATE_COLLECTION_STATES];

package/dist/{types/appstate → appstate}/utils.d.ts

@@ -1,6 +1,6 @@
 import type { AppStateCollectionName, WaAppStateSyncKey } from './types';
 import type { WaMediaTransferClient } from '../media/transfer/WaMediaTransferClient';
-import type { Proto } from '..';
+import type { Proto } from '../proto';
 /**
  * Returns `value` typed as a known {@link AppStateCollectionName}, or `null`
  * when the string is unrecognized.

package/dist/{types/appstate-spec.d.ts → appstate-spec.d.ts}

@@ -1,4 +1,4 @@
-import { proto, type Proto } from '.';
+import { proto, type Proto } from './proto';
 import { WA_APPSTATE_SCHEMAS as RAW_WA_APPSTATE_SCHEMAS, type WaAppstateActionKey, type WaAppstateSchema, type WaAppstateValueEnumFields } from '../spec/appstate';
 export { WA_APPSTATE_COLLECTIONS, WA_APPSTATE_SCHEMAS } from '../spec/appstate';
 export type { WaAppstateActionKey, WaAppstateCollection, WaAppstateIndexArgs, WaAppstateIndexPart, WaAppstateIndexValueOf, WaAppstateSchema, WaAppstateScope, WaAppstateValueEnumFields } from '../spec/appstate';

package/dist/appstate-spec.js

@@ -6,7 +6,7 @@ exports.resolveEnumObject = resolveEnumObject;
 exports.encodeEnumValue = encodeEnumValue;
 exports.decodeEnumValue = decodeEnumValue;
 exports.decodeIndexArgsFromSchema = decodeIndexArgsFromSchema;
-const _proto_1 = require("./proto.js");
+const _proto_1 = require("./proto");
 const appstate_1 = require("../spec/appstate");
 var appstate_2 = require("../spec/appstate");
 Object.defineProperty(exports, "WA_APPSTATE_COLLECTIONS", { enumerable: true, get: function () { return appstate_2.WA_APPSTATE_COLLECTIONS; } });

package/dist/auth/credentials-flow.js

@@ -3,11 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadOrCreateCredentials = loadOrCreateCredentials;
 exports.persistCredentials = persistCredentials;
 exports.buildCommsConfig = buildCommsConfig;
-const _crypto_1 = require("../crypto/index.js");
+const _crypto_1 = require("../crypto");
 const keys_1 = require("../crypto/core/keys");
 const X25519_1 = require("../crypto/curves/X25519");
 const jid_1 = require("../protocol/jid");
-const _signal_1 = require("../signal/index.js");
+const _signal_1 = require("../signal");
 const WaMobileTcpSocket_1 = require("../transport/node/WaMobileTcpSocket");
 const WaMobileClientPayload_1 = require("../transport/noise/WaMobileClientPayload");
 const proxy_1 = require("../transport/proxy");

package/dist/auth/pairing/WaPairingFlow.js

@@ -2,8 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WaPairingFlow = void 0;
 const pairing_code_crypto_1 = require("../pairing/pairing-code-crypto");
-const _crypto_1 = require("../../crypto/index.js");
-const _proto_1 = require("../../proto.js");
+const _crypto_1 = require("../../crypto");
+const _proto_1 = require("../../proto");
 const browser_1 = require("../../protocol/browser");
 const constants_1 = require("../../protocol/constants");
 const jid_1 = require("../../protocol/jid");

package/dist/auth/pairing/pairing-code-crypto.js

@@ -4,7 +4,7 @@ exports.PBKDF2_ITERATIONS = void 0;
 exports.normalizeCustomPairingCode = normalizeCustomPairingCode;
 exports.createCompanionHello = createCompanionHello;
 exports.completeCompanionFinish = completeCompanionFinish;
-const _crypto_1 = require("../../crypto/index.js");
+const _crypto_1 = require("../../crypto");
 const X25519_1 = require("../../crypto/curves/X25519");
 const constants_1 = require("../../protocol/constants");
 const bytes_1 = require("../../util/bytes");

package/dist/{types/auth → auth}/types.d.ts

@@ -1,5 +1,5 @@
 import type { SignalKeyPair } from '../crypto/curves/types';
-import type { Proto } from '..';
+import type { Proto } from '../proto';
 import type { RegistrationInfo, SignedPreKeyRecord } from '../signal/types';
 import type { WaMobileTransportDeviceInfo } from '../transport/noise/WaMobileClientPayload';
 import type { WaCommsConfig, WaProxyTransport } from '../transport/types';

package/dist/client/WaClient.js

@@ -8,7 +8,7 @@ const mailbox_1 = require("./persistence/mailbox");
 const WriteBehindPersistence_1 = require("./persistence/WriteBehindPersistence");
 const WaClientFactory_1 = require("./WaClientFactory");
 const ConsoleLogger_1 = require("../infra/log/ConsoleLogger");
-const _proto_1 = require("../proto.js");
+const _proto_1 = require("../proto");
 const constants_1 = require("../protocol/constants");
 const jid_1 = require("../protocol/jid");
 const stream_1 = require("../protocol/stream");
@@ -35,7 +35,7 @@ const SYNC_RELATED_PROTOCOL_TYPES = new Set([
  *
  * @example
  * ```ts
- * import { createPinoLogger, createStore, WaClient } from '../index.js'
+ * import { createPinoLogger, createStore, WaClient } from '..'
  * import { createSqliteStore } from '@zapo-js/store-sqlite'
  *
  * const store = createStore({

package/dist/client/WaClientFactory.js

@@ -153,7 +153,8 @@ function createIncomingNodeRuntime(input) {
         emitRegistrationCode: (event) => emitEvent('mobile_registration_code', event),
         emitAccountTakeoverNotice: (event) => emitEvent('mobile_account_takeover_notice', event),
         emitGroupEvent: (event) => {
-            emitEvent('group', event);
+            // Register the cache mutation before emitting so a handler that
+            // sends synchronously sees the fresh participants, not the stale ones.
             void messageDispatch.mutateGroupMetadataCacheFromGroupEvent(event).catch((error) => {
                 logger.warn('failed to mutate group metadata cache from group event', {
                     action: event.action,
@@ -162,6 +163,7 @@ function createIncomingNodeRuntime(input) {
                     message: (0, primitives_1.toError)(error).message
                 });
             });
+            emitEvent('group', event);
         },
         emitBusinessEvent: (event) => emitEvent('business', event),
         emitPictureEvent: (event) => emitEvent('picture', event),

package/dist/{types/client → client}/coordinators/WaAppStateMutationCoordinator.d.ts

@@ -1,10 +1,10 @@
 import type { WaAppStateSyncClient } from '../../appstate/sync/WaAppStateSyncClient';
 import type { WaAppStateSyncOptions, WaAppStateSyncResult } from '../../appstate/types';
-import { type DataForKey, type WaAppstateActionKey, type WaAppstateIndexArgs } from '../..';
+import { type DataForKey, type WaAppstateActionKey, type WaAppstateIndexArgs } from '../../appstate-spec';
 import type { WaAppStateMessageKey, WaAppStateMutationEvent, WaClearChatOptions, WaDeleteChatOptions, WaDeleteMessageForMeOptions } from '../types';
 import type { Logger } from '../../infra/log/types';
 import type { WaMediaTransferClient } from '../../media/transfer/WaMediaTransferClient';
-import { proto, type Proto } from '../..';
+import { proto, type Proto } from '../../proto';
 import type { WaStoredContactRecord } from '../../store/contracts/contact.store';
 import type { WaMessageStore } from '../../store/contracts/message.store';
 import type { ServerClock } from '../../util/clock';

package/dist/client/coordinators/WaAppStateMutationCoordinator.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WaAppStateMutationCoordinator = void 0;
 const utils_1 = require("../../appstate/utils");
-const _appstate_spec_1 = require("../../appstate-spec.js");
+const _appstate_spec_1 = require("../../appstate-spec");
 const appstate_mutation_1 = require("../events/appstate-mutation");
-const _proto_1 = require("../../proto.js");
+const _proto_1 = require("../../proto");
 const constants_1 = require("../../protocol/constants");
 const jid_1 = require("../../protocol/jid");
 const coercion_1 = require("../../util/coercion");

package/dist/{types/client → client}/coordinators/WaBotCoordinator.d.ts

@@ -2,7 +2,7 @@ import type { WaAuthCredentials } from '../../auth/types';
 import type { WaIncomingBotChunkEvent, WaIncomingMessageEvent, WaSendMessageOptions } from '../types';
 import type { Logger } from '../../infra/log/types';
 import type { WaMessageBuildResult, WaMessagePublishResult, WaSendMessageContent } from '../../message/types';
-import { proto } from '../..';
+import { proto } from '../../proto';
 import type { WaMessageSecretStore } from '../../store/contracts/message-secret.store';
 import type { WaMessageStore } from '../../store/contracts/message.store';
 import type { BinaryNode } from '../../transport/types';

package/dist/client/coordinators/WaBotCoordinator.js

@@ -6,7 +6,7 @@ const context_info_1 = require("../../message/context-info");
 const addon_crypto_1 = require("../../message/crypto/addon-crypto");
 const content_1 = require("../../message/encode/content");
 const bot_1 = require("../../message/kinds/bot");
-const _proto_1 = require("../../proto.js");
+const _proto_1 = require("../../proto");
 const bot_2 = require("../../protocol/bot");
 const constants_1 = require("../../protocol/constants");
 const jid_1 = require("../../protocol/jid");

package/dist/{types/client → client}/coordinators/WaBroadcastListCoordinator.d.ts

@@ -1,7 +1,7 @@
 import type { WaAppStateMutationCoordinator, WaSetBroadcastListInput } from '../coordinators/WaAppStateMutationCoordinator';
 import type { WaSendMessageOptions } from '../types';
 import type { WaMessageBuildResult, WaMessagePublishResult, WaSendMessageContent } from '../../message/types';
-import type { Proto } from '../..';
+import type { Proto } from '../../proto';
 export interface WaBroadcastListCoordinatorOptions {
     readonly appStateMutations: WaAppStateMutationCoordinator;
     readonly buildMessageContent: (content: WaSendMessageContent) => Promise<WaMessageBuildResult>;

package/dist/{types/client → client}/coordinators/WaMessageCoordinator.d.ts

@@ -6,7 +6,7 @@ import type { Logger } from '../../infra/log/types';
 import type { WaMediaTransferClient } from '../../media/transfer/WaMediaTransferClient';
 import type { PeerDataOperationRequester } from '../../message/primitives/peer-data-operation';
 import type { WaMessagePublishResult, WaSendMessageContent, WaSendReceiptEventOptions, WaSendReceiptOptions } from '../../message/types';
-import { type Proto } from '../..';
+import { type Proto } from '../../proto';
 import type { WaMessageSecretStore } from '../../store/contracts/message-secret.store';
 import type { WaMessageStore } from '../../store/contracts/message.store';
 import { type WaMexQuerySocket } from '../../transport/node/mex/client';

package/dist/client/coordinators/WaMessageCoordinator.js

@@ -4,10 +4,10 @@ exports.WaMessageCoordinator = void 0;
 const node_fs_1 = require("node:fs");
 const promises_1 = require("node:stream/promises");
 const receipt_1 = require("../events/receipt");
+const media_1 = require("../media");
 const addon_crypto_1 = require("../../message/crypto/addon-crypto");
 const content_1 = require("../../message/encode/content");
-const media_payload_1 = require("../../message/encode/media-payload");
-const _proto_1 = require("../../proto.js");
+const _proto_1 = require("../../proto");
 const jid_1 = require("../../protocol/jid");
 const client_1 = require("../../transport/node/mex/client");
 const bytes_1 = require("../../util/bytes");
@@ -235,23 +235,7 @@ class WaMessageCoordinator {
      * for one-shot verified downloads.
      */
     async download(source, options = {}) {
-        const message = 'rawNode' in source ? source.message : source;
-        const payload = (0, media_payload_1.resolveMediaPayload)(message);
-        if (!payload) {
-            throw new Error('message has no downloadable media');
-        }
-        const { plaintext, metadata } = await this.mediaTransfer.downloadAndDecryptStream({
-            directPath: payload.directPath,
-            mediaType: payload.mediaType,
-            mediaKey: payload.mediaKey,
-            fileSha256: payload.fileSha256,
-            fileEncSha256: payload.fileEncSha256,
-            timeoutMs: options.timeoutMs,
-            signal: options.signal,
-            maxBytes: options.maxBytes
-        });
-        metadata.catch(() => undefined);
-        return plaintext;
+        return (0, media_1.downloadMediaMessage)(source, { ...options, transfer: this.mediaTransfer });
     }
     /**
      * Convenience wrapper around {@link download} that streams the decrypted

package/dist/{types/client → client}/coordinators/WaMessageDispatchCoordinator.d.ts

@@ -9,7 +9,7 @@ import { type WaSendContextInfo } from '../../message/context-info';
 import { type IcdcMeta } from '../../message/crypto/icdc';
 import type { WaEncryptedMessageInput, WaMessageBuildResult, WaMessagePublishOptions, WaMessagePublishResult, WaSendMessageContent, WaSendReceiptInput } from '../../message/types';
 import type { WaMessageClient } from '../../message/WaMessageClient';
-import { type Proto } from '../..';
+import { type Proto } from '../../proto';
 import { type WaStatusDistributionSetting } from '../../protocol/constants';
 import type { OutboundRetryTracker } from '../../retry/tracker';
 import type { SignalDeviceSyncApi } from '../../signal/api/SignalDeviceSyncApi';

package/dist/client/coordinators/WaMessageDispatchCoordinator.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WaMessageDispatchCoordinator = void 0;
-const _crypto_1 = require("../../crypto/index.js");
+const _crypto_1 = require("../../crypto");
 const primitives_1 = require("../../crypto/core/primitives");
 const PromiseDedup_1 = require("../../infra/perf/PromiseDedup");
-const _message_1 = require("../../message/index.js");
+const _message_1 = require("../../message");
 const context_info_1 = require("../../message/context-info");
 const icdc_1 = require("../../message/crypto/icdc");
 const phash_1 = require("../../message/crypto/phash");
@@ -13,7 +13,7 @@ const content_1 = require("../../message/encode/content");
 const device_sent_1 = require("../../message/encode/device-sent");
 const padding_1 = require("../../message/encode/padding");
 const bot_1 = require("../../message/kinds/bot");
-const _proto_1 = require("../../proto.js");
+const _proto_1 = require("../../proto");
 const constants_1 = require("../../protocol/constants");
 const jid_1 = require("../../protocol/jid");
 const binary_1 = require("../../transport/binary");
@@ -164,7 +164,8 @@ class WaMessageDispatchCoordinator {
             quote: options.quote,
             forward: options.forward,
             mentions: options.mentions,
-            meLid: this.deps.getCurrentCredentials()?.meLid
+            meLid: this.deps.getCurrentCredentials()?.meLid,
+            targetJid: recipientJid
         });
         const withCtx = ctx ? (0, context_info_1.applyContextInfo)(built.message, ctx) : built.message;
         const withViewOnce = options.viewOnce ? (0, content_1.wrapAsViewOnce)(withCtx) : withCtx;

package/dist/client/coordinators/WaRetryCoordinator.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WaRetryCoordinator = void 0;
 const incoming_1 = require("../../message/primitives/incoming");
-const _proto_1 = require("../../proto.js");
+const _proto_1 = require("../../proto");
 const constants_1 = require("../../protocol/constants");
 const jid_1 = require("../../protocol/jid");
 const constants_2 = require("../../retry/constants");

package/dist/{types/client → client}/coordinators/WaStatusCoordinator.d.ts

@@ -1,7 +1,7 @@
 import type { WaAppStateMutationCoordinator, WaSetStatusPrivacyInput } from '../coordinators/WaAppStateMutationCoordinator';
 import type { WaSendMessageOptions } from '../types';
 import type { WaMessageBuildResult, WaMessagePublishResult, WaSendMessageContent } from '../../message/types';
-import { type Proto } from '../..';
+import { type Proto } from '../../proto';
 import type { WaStatusDistributionSetting } from '../../protocol/status';
 export interface WaStatusCoordinatorOptions {
     readonly appStateMutations: WaAppStateMutationCoordinator;

package/dist/client/coordinators/WaStatusCoordinator.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createStatusCoordinator = createStatusCoordinator;
-const _proto_1 = require("../../proto.js");
+const _proto_1 = require("../../proto");
 const defaults_1 = require("../../protocol/defaults");
 /** Builds a {@link WaStatusCoordinator} from its dependencies. */
 function createStatusCoordinator(options) {

package/dist/client/coordinators/WaStreamControlCoordinator.js

@@ -53,11 +53,10 @@ function createStreamControlHandler(options) {
         const reason = constants_1.WA_DISCONNECT_REASONS.STREAM_ERROR_FORCE_LOGIN;
         stopCommsImmediately();
         await runStreamControlLifecycle(reason, async () => {
-            logger.warn('received forced login stream error; starting login lifecycle', {
+            logger.warn('received forced login stream error; reconnecting, keeping credentials', {
                 code
             });
-            await disconnect(reason, true, code);
-            await clearStoredCredentials();
+            await disconnect(reason, false, code);
             await restartBackendAfterStreamControl(reason);
         });
     };

package/dist/client/events/appstate-mutation.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseAppStateMutationEvent = parseAppStateMutationEvent;
-const _appstate_spec_1 = require("../../appstate-spec.js");
+const _appstate_spec_1 = require("../../appstate-spec");
 function parseAppStateMutationEvent(mutation) {
     const parts = parseIndexParts(mutation.index);
     if (!parts || parts.length === 0) {

package/dist/client/events/business.js

@@ -4,7 +4,7 @@ exports.parseVerifiedNameNode = parseVerifiedNameNode;
 exports.parseBusinessProfileNode = parseBusinessProfileNode;
 exports.parseBusinessNotificationEvents = parseBusinessNotificationEvents;
 const incoming_1 = require("../events/incoming");
-const _proto_1 = require("../../proto.js");
+const _proto_1 = require("../../proto");
 const constants_1 = require("../../protocol/constants");
 const nodes_1 = require("../../protocol/nodes");
 const helpers_1 = require("../../transport/node/helpers");

package/dist/client/events/incoming.js

@@ -18,6 +18,7 @@ const call_1 = require("../events/call");
 const group_1 = require("../events/group");
 const mex_notification_1 = require("../events/mex-notification");
 const picture_1 = require("../events/picture");
+const receipt_1 = require("../events/receipt");
 const registration_1 = require("../events/registration");
 const constants_1 = require("../../protocol/constants");
 const jid_1 = require("../../protocol/jid");
@@ -188,7 +189,8 @@ function createIncomingReceiptHandler(options) {
                 status: mapped.status,
                 fromSelfDevice: mapped.fromSelfDevice,
                 participantJid: node.attrs.participant,
-                recipientJid: node.attrs.recipient
+                recipientJid: node.attrs.recipient,
+                messageIds: (0, receipt_1.extractReceiptIds)(node)
             });
         }
         else if (node.attrs.type && !INTERNAL_ONLY_RECEIPT_TYPES.has(node.attrs.type)) {

package/dist/client/events/receipt.d.ts

@@ -0,0 +1,30 @@
+import type { BinaryNode } from '../../transport/types';
+interface ReceiptTarget {
+    readonly chatJid: string;
+    readonly id: string;
+    readonly senderJid?: string;
+    readonly isGroupChat?: boolean;
+    readonly isBroadcastChat?: boolean;
+}
+interface AggregatedReceiptGroup {
+    readonly jid: string;
+    readonly ids: readonly string[];
+    readonly participant?: string;
+}
+export declare function aggregateReceiptTargets(targets: readonly ReceiptTarget[]): readonly AggregatedReceiptGroup[];
+/**
+ * Resolves every message id a `<receipt>` acknowledges, mirroring WhatsApp
+ * Web's `externalIds`. A batch receipt carries the extra ids in a
+ * `<list><item id=.../>` block; the top-level `attrs.id` is just one of them.
+ *
+ * - `<list><item>` ids come first. For `type="view"` receipts the item key is
+ *   `server_id` (not `id`), and the top-level id is NOT appended.
+ * - Otherwise the top-level `attrs.id` is appended last.
+ * - Aggregated receipts (carrying a `<participants>` child) are out of scope:
+ *   their ids live in `<user>` children, so this falls back to the single
+ *   top-level id for them.
+ *
+ * No dedup: matches wa-web, which pushes the top id without checking the list.
+ */
+export declare function extractReceiptIds(node: BinaryNode): readonly string[];
+export {};

package/dist/client/events/receipt.js

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.aggregateReceiptTargets = aggregateReceiptTargets;
+exports.extractReceiptIds = extractReceiptIds;
+const constants_1 = require("../../protocol/constants");
 const jid_1 = require("../../protocol/jid");
+const helpers_1 = require("../../transport/node/helpers");
 function needsParticipant(target) {
     if (target.isGroupChat !== undefined || target.isBroadcastChat !== undefined) {
         return target.isGroupChat === true || target.isBroadcastChat === true;
@@ -24,3 +27,32 @@ function aggregateReceiptTargets(targets) {
     }
     return [...groups.values()];
 }
+/**
+ * Resolves every message id a `<receipt>` acknowledges, mirroring WhatsApp
+ * Web's `externalIds`. A batch receipt carries the extra ids in a
+ * `<list><item id=.../>` block; the top-level `attrs.id` is just one of them.
+ *
+ * - `<list><item>` ids come first. For `type="view"` receipts the item key is
+ *   `server_id` (not `id`), and the top-level id is NOT appended.
+ * - Otherwise the top-level `attrs.id` is appended last.
+ * - Aggregated receipts (carrying a `<participants>` child) are out of scope:
+ *   their ids live in `<user>` children, so this falls back to the single
+ *   top-level id for them.
+ *
+ * No dedup: matches wa-web, which pushes the top id without checking the list.
+ */
+function extractReceiptIds(node) {
+    const topId = node.attrs.id;
+    if ((0, helpers_1.hasNodeChild)(node, 'participants')) {
+        return topId ? [topId] : [];
+    }
+    const isView = node.attrs.type === constants_1.WA_MESSAGE_TYPES.RECEIPT_TYPE_VIEW;
+    const list = (0, helpers_1.findNodeChild)(node, 'list');
+    const ids = list
+        ? [...(0, helpers_1.getNodeChildrenNonEmptyAttrValuesByTag)(list, 'item', isView ? 'server_id' : 'id')]
+        : [];
+    if (!isView && topId) {
+        ids.push(topId);
+    }
+    return ids;
+}

package/dist/{types/client → client}/media.d.ts

@@ -1,9 +1,11 @@
 import { type Readable } from 'node:stream';
-import type { WaMediaOptions } from './types';
+import type { WaDownloadMediaOptions, WaIncomingMessageEvent, WaMediaOptions } from './types';
 import type { Logger } from '../infra/log/types';
-import type { WaMediaTransferClient } from '../media/transfer/WaMediaTransferClient';
+import { WaMediaTransferClient } from '../media/transfer/WaMediaTransferClient';
 import type { WaMediaConn } from '../media/types';
 import type { WaSendMediaMessage } from '../message/types';
+import type { Proto } from '../proto';
+import type { WaProxyTransport } from '../transport/types';
 export interface ProcessedMediaFields {
     readonly jpegThumbnail?: Uint8Array;
     readonly pngThumbnail?: Uint8Array;
@@ -62,4 +64,59 @@ export declare function shouldNormalizeVoiceNote(media: WaMediaOptions | undefin
 export declare function hasMediaProcessingTasks(media: WaMediaOptions | undefined, content: WaSendMediaMessage): boolean;
 export declare function getScopedMediaLogger(parent: Logger): Logger;
 export declare function runMediaProcessor(media: WaMediaOptions | undefined, input: Uint8Array | string | undefined, content: WaSendMediaMessage, logger: Logger): Promise<ProcessedMediaFields>;
+export interface WaDownloadMediaMessageOptions extends WaDownloadMediaOptions {
+    /**
+     * Reuse an existing transfer client instead of creating a fresh one. Lets
+     * the download inherit proxy agents, timeouts, and the MAC-verification
+     * toggle, and avoids spinning up a new HTTP client per call in a loop. A
+     * stateless {@link WaMediaTransferClient} is created when omitted - fine
+     * for one-off downloads.
+     */
+    readonly transfer?: WaMediaTransferClient;
+    /**
+     * Proxy for the CDN download leg, mirroring `proxy.mediaDownload` on the
+     * client. The fetch runs over `node:http`/`node:https`, so only the Node
+     * `http.Agent` form is used; an undici dispatcher is ignored (same as the
+     * client treats `mediaDownload`). Takes precedence over the default agent
+     * of a `transfer` you pass.
+     */
+    readonly proxy?: WaProxyTransport;
+}
+/**
+ * Streams and decrypts the media attached to a message without a connected
+ * `WaClient`. Resolves the encrypted payload (directPath, mediaKey, file
+ * hashes) from `source`, fetches the ciphertext from the WhatsApp media CDN,
+ * and decrypts it on the fly.
+ *
+ * The media keys come from the (already decrypted) message itself, so this is
+ * for re-downloading media you have persisted - not for fetching media you
+ * never received. The CDN download needs no session or auth token; only the
+ * upload path does.
+ *
+ * **The caller owns the returned stream** - pipe it somewhere or call
+ * `.destroy()` to release the socket; an unconsumed stream leaks the
+ * connection. MAC + SHA-256 verification runs as bytes are consumed, so
+ * aborting mid-read leaves you with unverified bytes. Pass `options.signal`
+ * to cancel cleanly.
+ *
+ * @throws when `source` carries no downloadable media.
+ * @example
+ * ```ts
+ * import { downloadMediaMessage } from '..'
+ * import { createWriteStream } from 'node:fs'
+ *
+ * const stream = await downloadMediaMessage(event)
+ * stream.pipe(createWriteStream('photo.jpg'))
+ * ```
+ * @example
+ * ```ts
+ * // Route the CDN download through an http.Agent-style proxy
+ * import { HttpsProxyAgent } from 'https-proxy-agent'
+ *
+ * const stream = await downloadMediaMessage(event, {
+ *     proxy: new HttpsProxyAgent('http://127.0.0.1:8080')
+ * })
+ * ```
+ */
+export declare function downloadMediaMessage(source: Proto.IMessage | WaIncomingMessageEvent, options?: WaDownloadMediaMessageOptions): Promise<Readable>;
 export {};