zapo-js 0.3.0 → 1.0.0

package/dist/protocol/jid.js

@@ -3,8 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.splitJid = splitJid;
 exports.normalizeRecipientJid = normalizeRecipientJid;
 exports.isLidJid = isLidJid;
+exports.isUserJid = isUserJid;
+exports.isBotJid = isBotJid;
 exports.isGroupJid = isGroupJid;
 exports.isBroadcastJid = isBroadcastJid;
+exports.isStatusBroadcastJid = isStatusBroadcastJid;
+exports.isNewsletterJid = isNewsletterJid;
 exports.isGroupOrBroadcastJid = isGroupOrBroadcastJid;
 exports.parseSignalAddressFromJid = parseSignalAddressFromJid;
 exports.parseJidFull = parseJidFull;
@@ -12,6 +16,7 @@ exports.canonicalizeSignalServer = canonicalizeSignalServer;
 exports.canonicalizeSignalJid = canonicalizeSignalJid;
 exports.toUserJid = toUserJid;
 exports.normalizeDeviceJid = normalizeDeviceJid;
+exports.applyDeviceToJid = applyDeviceToJid;
 exports.isHostedDeviceId = isHostedDeviceId;
 exports.isHostedServer = isHostedServer;
 exports.isHostedDeviceJid = isHostedDeviceJid;
@@ -28,7 +33,9 @@ const KNOWN_SERVERS = {
     [constants_1.WA_DEFAULTS.HOSTED_SERVER]: constants_1.WA_DEFAULTS.HOSTED_SERVER,
     [constants_1.WA_DEFAULTS.HOSTED_LID_SERVER]: constants_1.WA_DEFAULTS.HOSTED_LID_SERVER,
     [constants_1.WA_DEFAULTS.MSGR_SERVER]: constants_1.WA_DEFAULTS.MSGR_SERVER,
-    [constants_1.WA_DEFAULTS.INTEROP_SERVER]: constants_1.WA_DEFAULTS.INTEROP_SERVER
+    [constants_1.WA_DEFAULTS.INTEROP_SERVER]: constants_1.WA_DEFAULTS.INTEROP_SERVER,
+    [constants_1.WA_DEFAULTS.NEWSLETTER_SERVER]: constants_1.WA_DEFAULTS.NEWSLETTER_SERVER,
+    [constants_1.WA_DEFAULTS.BOT_SERVER]: constants_1.WA_DEFAULTS.BOT_SERVER
 };
 /**
  * Returns the canonical reference for known server strings, avoiding
@@ -53,10 +60,20 @@ function findAtIndex(jid) {
         throw new Error(`invalid jid: ${jid}`);
     return atIndex;
 }
+/**
+ * Splits a JID into `user` and `server` parts at the `@` separator.
+ * Throws if the input does not contain a valid `user@server` shape.
+ */
 function splitJid(jid) {
     const atIndex = findAtIndex(jid);
     return { user: jid.slice(0, atIndex), server: internServer(jid.slice(atIndex + 1)) };
 }
+/**
+ * Normalizes a user-supplied recipient (phone number, group id, or full JID)
+ * into a canonical JID. Strings already containing `@` are returned as-is;
+ * dashed inputs map to `<input>@g.us` (group); pure-digit inputs map to
+ * `<digits>@s.whatsapp.net`.
+ */
 function normalizeRecipientJid(to) {
     const input = to.trim();
     if (input.length === 0)
@@ -79,23 +96,51 @@ function normalizeRecipientJid(to) {
 }
 function isJidType(jid, type) {
     const atIndex = jid.length - type.length - 1;
-    return (atIndex >= 1 &&
-        jid.charCodeAt(atIndex) === 64 &&
-        jid.indexOf('@') === atIndex &&
-        jid.endsWith(type));
+    if (atIndex < 1 || jid.charCodeAt(atIndex) !== 64 || !jid.endsWith(type))
+        return false;
+    // Reject multi-@ JIDs (consistency with splitJid). Manual loop beats indexOf.
+    for (let i = 0; i < atIndex; i += 1) {
+        if (jid.charCodeAt(i) === 64)
+            return false;
+    }
+    return true;
 }
+/** Returns `true` for JIDs in the `@lid` server (linked-device identity). */
 function isLidJid(jid) {
     return isJidType(jid, constants_1.WA_DEFAULTS.LID_SERVER);
 }
+/** Returns `true` for JIDs in the `@s.whatsapp.net` server (phone-number user JIDs). */
+function isUserJid(jid) {
+    return isJidType(jid, constants_1.WA_DEFAULTS.HOST_DOMAIN);
+}
+/** Returns `true` for JIDs in the `@bot` server. */
+function isBotJid(jid) {
+    return isJidType(jid, constants_1.WA_DEFAULTS.BOT_SERVER);
+}
+/** Returns `true` for JIDs in the `@g.us` server (groups). */
 function isGroupJid(jid) {
     return isJidType(jid, constants_1.WA_DEFAULTS.GROUP_SERVER);
 }
+/** Returns `true` for JIDs in the `@broadcast` server (broadcast lists). */
 function isBroadcastJid(jid) {
     return isJidType(jid, constants_1.WA_DEFAULTS.BROADCAST_SERVER);
 }
+/** Returns `true` for the special `status@broadcast` JID. */
+function isStatusBroadcastJid(jid) {
+    return jid === constants_1.WA_DEFAULTS.STATUS_BROADCAST_JID;
+}
+/** Returns `true` for JIDs in the `@newsletter` server. */
+function isNewsletterJid(jid) {
+    return isJidType(jid, constants_1.WA_DEFAULTS.NEWSLETTER_SERVER);
+}
+/** Returns `true` for any group or broadcast JID. */
 function isGroupOrBroadcastJid(jid) {
     return isGroupJid(jid) || isBroadcastJid(jid);
 }
+/**
+ * Parses a JID into a Signal-style `{ user, server, device }` address.
+ * `device` is `0` when the JID has no `:device` segment.
+ */
 function parseSignalAddressFromJid(jid) {
     const atIndex = findAtIndex(jid);
     const colonIndex = jid.indexOf(':', 0);
@@ -116,12 +161,21 @@ function parseSignalAddressFromJid(jid) {
     }
     return { user: jid.slice(0, colonIndex), server, device };
 }
+/**
+ * Parses a JID and returns the Signal address plus the user-only and
+ * fully-normalized device JID forms in a single pass.
+ */
 function parseJidFull(jid) {
     const address = parseSignalAddressFromJid(jid);
     const userJid = `${address.user}@${address.server}`;
     const normalizedJid = address.device === 0 ? userJid : `${address.user}:${address.device}@${address.server}`;
     return { address, userJid, normalizedJid };
 }
+/**
+ * Maps the hosted-account server variants (`hosted` / `hosted.lid`) back to
+ * their canonical Signal server (`hostDomain` / `lid`). Other servers are
+ * returned unchanged.
+ */
 function canonicalizeSignalServer(server, hostDomain = constants_1.WA_DEFAULTS.HOST_DOMAIN) {
     if (server === constants_1.WA_DEFAULTS.HOSTED_SERVER)
         return hostDomain;
@@ -129,6 +183,11 @@ function canonicalizeSignalServer(server, hostDomain = constants_1.WA_DEFAULTS.H
         return constants_1.WA_DEFAULTS.LID_SERVER;
     return server;
 }
+/**
+ * Returns the JID rewritten with its server canonicalized via
+ * {@link canonicalizeSignalServer} – used to derive the address Signal
+ * sessions are keyed by.
+ */
 function canonicalizeSignalJid(jid, hostDomain = constants_1.WA_DEFAULTS.HOST_DOMAIN) {
     const address = parseSignalAddressFromJid(jid);
     const server = canonicalizeSignalServer(address.server ?? constants_1.WA_DEFAULTS.HOST_DOMAIN, hostDomain);
@@ -136,6 +195,11 @@ function canonicalizeSignalJid(jid, hostDomain = constants_1.WA_DEFAULTS.HOST_DO
         return `${address.user}@${server}`;
     return `${address.user}:${address.device}@${server}`;
 }
+/**
+ * Strips the `:device` segment from a JID, returning the bare `user@server`
+ * form. Set `options.canonicalizeSignalServer` to also rewrite hosted servers
+ * via {@link canonicalizeSignalServer}.
+ */
 function toUserJid(jid, options = {}) {
     const canonicalize = options.canonicalizeSignalServer === true;
     if (!canonicalize) {
@@ -153,18 +217,38 @@ function toUserJid(jid, options = {}) {
         : address.server;
     return `${address.user}@${server}`;
 }
+/**
+ * Returns the JID in its full device form. JIDs with `device === 0` lose the
+ * device segment (`user@server`); all others keep `user:device@server`.
+ */
 function normalizeDeviceJid(jid) {
     const address = parseSignalAddressFromJid(jid);
     if (address.device === 0)
         return `${address.user}@${address.server}`;
     return `${address.user}:${address.device}@${address.server}`;
 }
+/**
+ * Appends `:device` to a bare user JID. A falsy `device` returns the input
+ * unchanged.
+ */
+function applyDeviceToJid(userJid, device) {
+    if (!device)
+        return userJid;
+    const address = parseSignalAddressFromJid(userJid);
+    return buildDeviceJid(address.user, address.server ?? constants_1.WA_DEFAULTS.HOST_DOMAIN, device);
+}
+/** Returns `true` when `deviceId` matches the WhatsApp hosted-device id. */
 function isHostedDeviceId(deviceId) {
     return deviceId === constants_1.WA_DEFAULTS.HOSTED_DEVICE_ID;
 }
+/** Returns `true` for the hosted server variants (`hosted` and `hosted.lid`). */
 function isHostedServer(server) {
     return server === constants_1.WA_DEFAULTS.HOSTED_SERVER || server === constants_1.WA_DEFAULTS.HOSTED_LID_SERVER;
 }
+/**
+ * Returns `true` when the JID refers to a hosted device – either by server
+ * (`@hosted` / `@hosted.lid`) or by a `:HOSTED_DEVICE_ID@…` device segment.
+ */
 function isHostedDeviceJid(jid) {
     if (isJidType(jid, constants_1.WA_DEFAULTS.HOSTED_SERVER) ||
         isJidType(jid, constants_1.WA_DEFAULTS.HOSTED_LID_SERVER)) {
@@ -187,6 +271,11 @@ function isHostedDeviceJid(jid) {
     }
     return isHostedDeviceId(deviceId);
 }
+/**
+ * Builds a device JID from its parts. When `options.isHosted` is set, the
+ * hosted-server variant is selected (preserving LID vs phone) and the canonical
+ * hosted device id is used.
+ */
 function buildDeviceJid(user, normalizedServer, deviceId, options = {}) {
     if (options.isHosted === true) {
         if (!isHostedDeviceId(deviceId)) {
@@ -203,6 +292,11 @@ function buildDeviceJid(user, normalizedServer, deviceId, options = {}) {
     }
     return `${user}:${deviceId}@${normalizedServer}`;
 }
+/**
+ * Extracts the numeric username and device id from the authenticated user's
+ * own JID. Throws when either segment is missing, non-numeric, or out of the
+ * safe-integer range.
+ */
 function getLoginIdentity(meJid) {
     const atIndex = findAtIndex(meJid);
     const colonIndex = meJid.indexOf(':', 0);
@@ -218,12 +312,20 @@ function getLoginIdentity(meJid) {
         throw new Error(`invalid device from ${meJid}`);
     return { username, device };
 }
+/**
+ * Builds a `<digits>@s.whatsapp.net` JID from a free-form phone number,
+ * stripping non-digit characters. Throws when no digits are found.
+ */
 function parsePhoneJid(input) {
     const digits = extractDigits(input);
     if (!digits)
         throw new Error('phone number is empty after normalization');
     return `${digits}@${constants_1.WA_DEFAULTS.HOST_DOMAIN}`;
 }
+/**
+ * Returns a stable `user|server|device` key for a Signal address, suitable
+ * as a Map/Set key.
+ */
 function signalAddressKey(address) {
     const server = address.server ?? constants_1.WA_DEFAULTS.HOST_DOMAIN;
     return `${address.user}|${server}|${address.device}`;

package/dist/protocol/media.js

@@ -2,20 +2,33 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WA_PREVIEW_MEDIA_HKDF_INFO = exports.WA_MEDIA_HKDF_INFO = void 0;
 exports.getWaMediaHkdfInfo = getWaMediaHkdfInfo;
+const bytes_1 = require("../util/bytes");
+const IMAGE_KEYS = bytes_1.TEXT_ENCODER.encode('WhatsApp Image Keys');
+const VIDEO_KEYS = bytes_1.TEXT_ENCODER.encode('WhatsApp Video Keys');
+const AUDIO_KEYS = bytes_1.TEXT_ENCODER.encode('WhatsApp Audio Keys');
+const HISTORY_KEYS = bytes_1.TEXT_ENCODER.encode('WhatsApp History Keys');
 exports.WA_MEDIA_HKDF_INFO = Object.freeze({
-    document: 'WhatsApp Document Keys',
-    image: 'WhatsApp Image Keys',
-    sticker: 'WhatsApp Image Keys',
-    'xma-image': 'WhatsApp Image Keys',
-    video: 'WhatsApp Video Keys',
-    gif: 'WhatsApp Video Keys',
-    audio: 'WhatsApp Audio Keys',
-    ptt: 'WhatsApp Audio Keys',
-    'md-app-state': 'WhatsApp App State Keys',
-    'md-msg-hist': 'WhatsApp History Keys',
-    history: 'WhatsApp History Keys'
+    document: bytes_1.TEXT_ENCODER.encode('WhatsApp Document Keys'),
+    image: IMAGE_KEYS,
+    sticker: IMAGE_KEYS,
+    'xma-image': IMAGE_KEYS,
+    video: VIDEO_KEYS,
+    gif: VIDEO_KEYS,
+    audio: AUDIO_KEYS,
+    ptt: AUDIO_KEYS,
+    'md-app-state': bytes_1.TEXT_ENCODER.encode('WhatsApp App State Keys'),
+    'md-msg-hist': HISTORY_KEYS,
+    history: HISTORY_KEYS,
+    'sticker-pack': bytes_1.TEXT_ENCODER.encode('WhatsApp Sticker Pack Keys'),
+    'thumbnail-sticker-pack': bytes_1.TEXT_ENCODER.encode('WhatsApp Sticker Pack Thumbnail Keys'),
+    'thumbnail-link': bytes_1.TEXT_ENCODER.encode('WhatsApp Link Thumbnail Keys')
 });
-exports.WA_PREVIEW_MEDIA_HKDF_INFO = 'Messenger Preview Keys';
+exports.WA_PREVIEW_MEDIA_HKDF_INFO = bytes_1.TEXT_ENCODER.encode('Messenger Preview Keys');
+/**
+ * Returns the HKDF `info` bytes used to derive per-media keys for a given
+ * media type. Throws for unsupported types – see {@link WA_MEDIA_HKDF_INFO}
+ * for the supported set.
+ */
 function getWaMediaHkdfInfo(mediaType) {
     const info = exports.WA_MEDIA_HKDF_INFO[mediaType];
     if (info !== undefined)

package/dist/protocol/message.js

@@ -14,6 +14,7 @@ exports.WA_MESSAGE_TYPES = Object.freeze({
     ACK_TYPE_ERROR: 'error',
     ACK_CLASS_ERROR: 'error',
     ACK_CLASS_MESSAGE: 'message',
+    ACK_CLASS_CALL: 'call',
     RECEIPT_TYPE_DELIVERY: 'delivery',
     RECEIPT_TYPE_SENDER: 'sender',
     RECEIPT_TYPE_INACTIVE: 'inactive',
@@ -24,7 +25,8 @@ exports.WA_MESSAGE_TYPES = Object.freeze({
     RECEIPT_TYPE_HISTORY_SYNC: 'hist_sync',
     RECEIPT_TYPE_PEER: 'peer_msg',
     RECEIPT_TYPE_SERVER_ERROR: 'server-error',
-    RECEIPT_TYPE_RETRY: 'retry'
+    RECEIPT_TYPE_RETRY: 'retry',
+    RECEIPT_TYPE_ENC_REKEY_RETRY: 'enc_rekey_retry'
 });
 exports.WA_RETRYABLE_ACK_CODES = Object.freeze(['408', '429', '500', '503']);
 exports.WA_STANZA_MSG_TYPES = Object.freeze({
@@ -39,6 +41,7 @@ exports.WA_STANZA_MSG_TYPES = Object.freeze({
 exports.WA_EDIT_ATTRS = Object.freeze({
     MESSAGE_EDIT: '1',
     PIN_IN_CHAT: '2',
+    NEWSLETTER_EDIT: '3',
     SENDER_REVOKE: '7',
     ADMIN_REVOKE: '8'
 });

package/dist/protocol/newsletter.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WA_NEWSLETTER_VERIFICATION_STATES = exports.WA_NEWSLETTER_RECEIVE_TYPES = exports.WA_NEWSLETTER_SEND_TYPES = exports.WA_NEWSLETTER_MUTE_VALUES = exports.WA_NEWSLETTER_MUTE_TYPES = exports.WA_NEWSLETTER_VIEW_ROLES = exports.WA_NEWSLETTER_FETCH_KEY_TYPES = exports.WA_NEWSLETTER_PICTURE_TYPES = exports.WA_NEWSLETTER_STATE_TYPES = exports.WA_NEWSLETTER_ROLES = void 0;
+exports.WA_NEWSLETTER_ROLES = Object.freeze({
+    SUBSCRIBER: 'SUBSCRIBER',
+    GUEST: 'GUEST',
+    ADMIN: 'ADMIN',
+    OWNER: 'OWNER'
+});
+exports.WA_NEWSLETTER_STATE_TYPES = Object.freeze({
+    ACTIVE: 'ACTIVE',
+    SUSPENDED: 'SUSPENDED',
+    GEOSUSPENDED: 'GEOSUSPENDED',
+    DELETED: 'DELETED',
+    NON_EXISTING: 'NON_EXISTING'
+});
+exports.WA_NEWSLETTER_PICTURE_TYPES = Object.freeze({
+    IMAGE: 'IMAGE',
+    PREVIEW: 'PREVIEW'
+});
+exports.WA_NEWSLETTER_FETCH_KEY_TYPES = Object.freeze({
+    JID: 'JID',
+    INVITE: 'INVITE'
+});
+exports.WA_NEWSLETTER_VIEW_ROLES = Object.freeze({
+    GUEST: 'GUEST',
+    SUBSCRIBER: 'SUBSCRIBER',
+    ADMIN: 'ADMIN',
+    OWNER: 'OWNER'
+});
+exports.WA_NEWSLETTER_MUTE_TYPES = Object.freeze({
+    ADMIN_ACTIVITY: 'MUTE_ADMIN_ACTIVITY',
+    FOLLOWER_ACTIVITY: 'MUTE_FOLLOWER_ACTIVITY'
+});
+exports.WA_NEWSLETTER_MUTE_VALUES = Object.freeze({
+    ON: 'ON',
+    OFF: 'OFF'
+});
+exports.WA_NEWSLETTER_SEND_TYPES = Object.freeze({
+    TEXT: 'text',
+    MEDIA: 'media',
+    REACTION: 'reaction',
+    REVOKE: 'revoke'
+});
+exports.WA_NEWSLETTER_RECEIVE_TYPES = Object.freeze({
+    TEXT: 'NewsletterText',
+    MEDIA: 'NewsletterMedia',
+    REACTION: 'NewsletterReaction',
+    REACTION_REVOKE: 'NewsletterReactionRevoke',
+    REVOKE: 'NewsletterRevoke',
+    EDIT: 'NewsletterEdit',
+    POLL_CREATION: 'NewsletterPollCreation',
+    POLL_VOTE: 'NewsletterPollVote',
+    POLL_RESULT_SNAPSHOT: 'NewsletterPollResultSnapshot',
+    QUIZ_CREATION: 'NewsletterQuizCreation',
+    QUESTION: 'NewsletterQuestion',
+    QUESTION_REPLY: 'NewsletterQuestionReply',
+    QUESTION_RESPONSE: 'NewsletterQuestionResponse',
+    WAMO_EMPTY: 'NewsletterWAMOEmpty'
+});
+exports.WA_NEWSLETTER_VERIFICATION_STATES = Object.freeze({
+    VERIFIED: 'VERIFIED',
+    UNVERIFIED: 'UNVERIFIED'
+});

package/dist/protocol/nodes.js

@@ -65,7 +65,23 @@ exports.WA_NODE_TAGS = Object.freeze({
     EPHEMERAL: 'ephemeral',
     MEMBERSHIP_APPROVAL_MODE: 'membership_approval_mode',
     GROUP_JOIN: 'group_join',
-    ABPROPS: 'abprops'
+    ABPROPS: 'abprops',
+    PLAINTEXT: 'plaintext',
+    PRESENCE: 'presence',
+    CHATSTATE: 'chatstate',
+    CALL: 'call',
+    COMPOSING: 'composing',
+    PAUSED: 'paused',
+    BIZ: 'biz',
+    INTERACTIVE: 'interactive',
+    NATIVE_FLOW: 'native_flow',
+    BOT: 'bot',
+    META: 'meta',
+    STATUS: 'status',
+    USERNAME: 'username',
+    TEXT_STATUS: 'text_status',
+    DISAPPEARING_MODE: 'disappearing_mode',
+    BUSINESS: 'business'
 });
 exports.WA_IQ_TYPES = Object.freeze({
     GET: 'get',
@@ -87,8 +103,12 @@ exports.WA_XMLNS = Object.freeze({
     STATUS: 'status',
     GROUPS: 'w:g2',
     NEWSLETTER: 'newsletter',
+    TOS: 'tos',
     XMPP_PING: 'urn:xmpp:ping',
     WHATSAPP_PING: 'w:p',
     ABPROPS: 'abt',
-    MEX: 'w:mex'
+    MEX: 'w:mex',
+    BOT: 'bot',
+    DISAPPEARING_MODE: 'disappearing_mode',
+    PASSIVE: 'passive'
 });

package/dist/protocol/notification.js

@@ -1,12 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WA_GROUP_NOTIFICATION_TAGS = exports.WA_REGISTRATION_NOTIFICATION_TAGS = exports.WA_NOTIFICATION_TYPES = void 0;
+exports.WA_GROUP_NOTIFICATION_TAGS = exports.WA_REGISTRATION_NOTIFICATION_TAGS = exports.WA_NEWSLETTER_NOTIFICATION_TAGS = exports.WA_BUSINESS_NOTIFICATION_TAGS = exports.WA_NOTIFICATION_TYPES = void 0;
 exports.WA_NOTIFICATION_TYPES = Object.freeze({
     GROUP: 'w:gp2',
     ENCRYPT: 'encrypt',
     DEVICES: 'devices',
     SERVER: 'server',
-    REGISTRATION: 'registration'
+    REGISTRATION: 'registration',
+    NEWSLETTER: 'newsletter',
+    BUSINESS: 'business',
+    PICTURE: 'picture'
+});
+exports.WA_BUSINESS_NOTIFICATION_TAGS = Object.freeze({
+    VERIFIED_NAME: 'verified_name',
+    REMOVE: 'remove',
+    PROFILE: 'profile',
+    PRODUCT_CATALOG: 'product_catalog',
+    SUBSCRIPTIONS: 'subscriptions',
+    FEATURE_FLAGS: 'feature_flags'
+});
+exports.WA_NEWSLETTER_NOTIFICATION_TAGS = Object.freeze({
+    LIVE_UPDATES: 'live_updates'
 });
 exports.WA_REGISTRATION_NOTIFICATION_TAGS = Object.freeze({
     WA_OLD_REGISTRATION: 'wa_old_registration',
@@ -57,5 +71,7 @@ exports.WA_GROUP_NOTIFICATION_TAGS = Object.freeze({
     IS_CAPI_HOSTED_GROUP: 'is_capi_hosted_group',
     GROUP_SAFETY_CHECK: 'group_safety_check',
     LIMIT_SHARING_ENABLED: 'limit_sharing_enabled',
-    MISSING_PARTICIPANT_IDENTIFICATION: 'missing_participant_identification'
+    MISSING_PARTICIPANT_IDENTIFICATION: 'missing_participant_identification',
+    GROUP_HISTORY: 'group_history',
+    NO_GROUP_HISTORY: 'no_group_history'
 });

package/dist/protocol/presence.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WA_CHATSTATE_MEDIA = exports.WA_PRESENCE_LAST_SENTINELS = exports.WA_PRESENCE_TYPES = void 0;
+exports.WA_PRESENCE_TYPES = Object.freeze({
+    AVAILABLE: 'available',
+    UNAVAILABLE: 'unavailable',
+    SUBSCRIBE: 'subscribe'
+});
+exports.WA_PRESENCE_LAST_SENTINELS = Object.freeze({
+    DENY: 'deny',
+    NONE: 'none',
+    ERROR: 'error'
+});
+exports.WA_CHATSTATE_MEDIA = Object.freeze({
+    AUDIO: 'audio'
+});

package/dist/protocol/status.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WA_STATUS_DISTRIBUTION_SETTINGS = void 0;
+exports.WA_STATUS_DISTRIBUTION_SETTINGS = Object.freeze({
+    CONTACTS: 'contacts',
+    ALLOWLIST: 'allowlist',
+    DENYLIST: 'denylist',
+    CLOSE_FRIENDS: 'close_friends'
+});

package/dist/retry/codec.js

@@ -20,6 +20,10 @@ const RETRY_PAYLOAD_ENC_TYPE_REVERSE = Object.freeze({
     2: 'pkmsg',
     3: 'skmsg'
 });
+/**
+ * Encodes a {@link WaRetryReplayPayload} into the on-disk codec format used
+ * by the retry store. Supports the `plaintext`/`encrypted`/`opaque_node` modes.
+ */
 function encodeRetryReplayPayload(payload) {
     const chunks = [];
     if (payload.mode === 'plaintext') {
@@ -60,6 +64,7 @@ function encodeRetryReplayPayload(payload) {
     pushBytesField(chunks, payload.node, 'node');
     return (0, bytes_1.concatBytes)(chunks);
 }
+/** Inverse of {@link encodeRetryReplayPayload}. Throws on bad magic/version. */
 function decodeRetryReplayPayload(raw) {
     if (raw.byteLength < 3) {
         throw new Error('invalid retry replay payload: unsupported codec version');

package/dist/retry/parse.js

@@ -51,47 +51,25 @@ function parseRetryKeyBundle(node) {
     if (!node) {
         return undefined;
     }
-    const [identityNode, signedKeyNode, keyNode, deviceIdentityNode] = (0, helpers_1.findNodeChildrenByTags)(node, [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]);
-    const identity = requireNode(identityNode, 'retry keys section missing identity or skey');
-    const signedKey = requireNode(signedKeyNode, 'retry keys section missing identity or skey');
-    const [signedKeyIdNode, signedKeyValueNode, signedKeySignatureNode] = (0, helpers_1.findNodeChildrenByTags)(signedKey, [constants_1.WA_NODE_TAGS.ID, constants_1.WA_NODE_TAGS.VALUE, constants_1.WA_NODE_TAGS.SIGNATURE]);
-    const signedKeyId = requireNode(signedKeyIdNode, 'retry keys section has incomplete skey');
-    const signedKeyValue = requireNode(signedKeyValueNode, 'retry keys section has incomplete skey');
-    const signedKeySignature = requireNode(signedKeySignatureNode, 'retry keys section has incomplete skey');
-    let keyIdNode;
-    let keyValueNode;
-    if (keyNode) {
-        const keyNodes = (0, helpers_1.findNodeChildrenByTags)(keyNode, [constants_1.WA_NODE_TAGS.ID, constants_1.WA_NODE_TAGS.VALUE]);
-        keyIdNode = keyNodes[0];
-        keyValueNode = keyNodes[1];
-    }
-    const keyId = keyNode ? requireNode(keyIdNode, 'retry keys section has incomplete key') : null;
-    const keyValue = keyNode
-        ? requireNode(keyValueNode, 'retry keys section has incomplete key')
-        : null;
+    const parsed = (0, codec_1.parseSignalKeyBundleFromNode)(node, 'retry.keys');
     return {
-        identity: (0, codec_1.decodeExactLength)(identity.content, 'retry.keys.identity', constants_2.SIGNAL_KEY_DATA_LENGTH),
-        deviceIdentity: deviceIdentityNode
-            ? (0, helpers_1.decodeNodeContentBase64OrBytes)(deviceIdentityNode.content, 'retry.keys.device-identity')
-            : undefined,
-        key: keyId && keyValue
-            ? {
-                id: (0, codec_1.parseUint)((0, codec_1.decodeExactLength)(keyId.content, 'retry.keys.key.id', constants_2.SIGNAL_KEY_ID_LENGTH), 'retry.keys.key.id'),
-                publicKey: (0, codec_1.decodeExactLength)(keyValue.content, 'retry.keys.key.value', constants_2.SIGNAL_KEY_DATA_LENGTH)
-            }
-            : undefined,
-        skey: {
-            id: (0, codec_1.parseUint)((0, codec_1.decodeExactLength)(signedKeyId.content, 'retry.keys.skey.id', constants_2.SIGNAL_KEY_ID_LENGTH), 'retry.keys.skey.id'),
-            publicKey: (0, codec_1.decodeExactLength)(signedKeyValue.content, 'retry.keys.skey.value', constants_2.SIGNAL_KEY_DATA_LENGTH),
-            signature: (0, codec_1.decodeExactLength)(signedKeySignature.content, 'retry.keys.skey.signature', constants_2.SIGNAL_SIGNATURE_LENGTH)
-        }
+        identity: parsed.identity,
+        ...(parsed.deviceIdentity ? { deviceIdentity: parsed.deviceIdentity } : {}),
+        ...(parsed.oneTimeKey ? { key: parsed.oneTimeKey } : {}),
+        skey: parsed.signedKey
     };
 }
+/**
+ * Parses an incoming `receipt` stanza into a {@link WaParsedRetryRequest}.
+ * Returns `null` when the stanza is not a retry/rekey-retry receipt; throws
+ * when required attrs/children are missing.
+ */
 function parseRetryReceiptRequest(node, options) {
     if (node.tag !== constants_1.WA_MESSAGE_TAGS.RECEIPT) {
         return null;
     }
-    const receiptType = node.attrs.type === 'retry' || node.attrs.type === 'enc_rekey_retry'
+    const receiptType = node.attrs.type === constants_1.WA_MESSAGE_TYPES.RECEIPT_TYPE_RETRY ||
+        node.attrs.type === constants_1.WA_MESSAGE_TYPES.RECEIPT_TYPE_ENC_REKEY_RETRY
         ? node.attrs.type
         : null;
     if (!receiptType) {
@@ -131,6 +109,10 @@ function parseRetryReceiptRequest(node, options) {
         keyBundle: parseRetryKeyBundle(keysNode)
     };
 }
+/**
+ * Returns whichever of `left`/`right` represents the more advanced retry
+ * state (according to the internal precedence rank).
+ */
 function pickRetryStateMax(left, right) {
     return RETRY_STATE_RANK[left] >= RETRY_STATE_RANK[right] ? left : right;
 }

package/dist/retry/reason.js

@@ -40,6 +40,11 @@ const RETRY_REASON_MATCHERS = [
         code: constants_1.RETRY_REASON.StatusRevokeDelay
     }
 ];
+/**
+ * Maps a decryption/Signal error to the appropriate {@link WaRetryReasonCode}
+ * so an outbound retry receipt carries the correct `error` attribute.
+ * Returns `undefined` when no known reason matches.
+ */
 function mapRetryReasonFromError(error) {
     const message = (0, primitives_1.toError)(error).message.toLowerCase();
     for (const matcher of RETRY_REASON_MATCHERS) {