zapo-js 0.1.0

package/dist/esm/message/types.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "module"
+}

package/dist/esm/proto.js

@@ -0,0 +1,3 @@
+import protoModule from '../proto.js'
+
+export const proto = protoModule.proto

package/dist/esm/protocol/appstate.js

@@ -0,0 +1,34 @@
+export const WA_APP_STATE_COLLECTIONS = Object.freeze({
+    REGULAR: 'regular',
+    REGULAR_LOW: 'regular_low',
+    REGULAR_HIGH: 'regular_high',
+    CRITICAL_BLOCK: 'critical_block',
+    CRITICAL_UNBLOCK_LOW: 'critical_unblock_low'
+});
+export const WA_APP_STATE_COLLECTION_STATES = Object.freeze({
+    SUCCESS: 'success',
+    SUCCESS_HAS_MORE: 'success_has_more',
+    CONFLICT: 'conflict',
+    CONFLICT_HAS_MORE: 'conflict_has_more',
+    ERROR_RETRY: 'error_retry',
+    ERROR_FATAL: 'error_fatal',
+    BLOCKED: 'blocked'
+});
+export const WA_APP_STATE_ERROR_CODES = Object.freeze({
+    CONFLICT: '409',
+    BAD_REQUEST: '400',
+    NOT_FOUND: '404'
+});
+export const WA_APP_STATE_SYNC_DATA_TYPE = Object.freeze({
+    PATCH: 'Patch',
+    SNAPSHOT: 'Snapshot',
+    LOCAL: 'Local'
+});
+export const WA_APP_STATE_KEY_TYPES = Object.freeze({
+    MD_APP_STATE: 'md-app-state',
+    MD_MSG_HIST: 'md-msg-hist'
+});
+export const WA_APP_STATE_KDF_INFO = Object.freeze({
+    MUTATION_KEYS: 'WhatsApp Mutation Keys',
+    PATCH_INTEGRITY: 'WhatsApp Patch Integrity'
+});

package/dist/esm/protocol/auth.js

@@ -0,0 +1,12 @@
+export const WA_SIGNALING = Object.freeze({
+    LINK_CODE_STAGE_COMPANION_HELLO: 'companion_hello',
+    LINK_CODE_STAGE_GET_COUNTRY_CODE: 'get_country_code',
+    LINK_CODE_STAGE_COMPANION_FINISH: 'companion_finish',
+    LINK_CODE_STAGE_REFRESH_CODE: 'refresh_code',
+    LINK_CODE_STAGE_PRIMARY_HELLO: 'primary_hello',
+    COMPANION_REG_REFRESH_NOTIFICATION: 'companion_reg_refresh'
+});
+export const WA_PAIRING_KDF_INFO = Object.freeze({
+    LINK_CODE_BUNDLE: 'link_code_pairing_key_bundle_encryption_key',
+    ADV_SECRET: 'adv_secret'
+});

package/dist/esm/protocol/browser.js

@@ -0,0 +1,41 @@
+export const WA_BROWSERS = Object.freeze({
+    CHROME: 'chrome',
+    CHROMIUM: 'chromium',
+    FIREFOX: 'firefox',
+    SAFARI: 'safari',
+    IE: 'ie',
+    OPERA: 'opera',
+    EDGE: 'edge'
+});
+export const WA_COMPANION_PLATFORM_IDS = Object.freeze({
+    UNKNOWN: '0',
+    CHROME: '1',
+    EDGE: '2',
+    FIREFOX: '3',
+    IE: '4',
+    OPERA: '5',
+    SAFARI: '6',
+    ELECTRON: '7',
+    UWP: '8',
+    OTHER_WEB_CLIENT: '9'
+});
+export function getWaCompanionPlatformId(browser) {
+    const normalized = browser.trim().toLowerCase();
+    switch (normalized) {
+        case WA_BROWSERS.CHROME:
+            return WA_COMPANION_PLATFORM_IDS.CHROME;
+        case WA_BROWSERS.FIREFOX:
+            return WA_COMPANION_PLATFORM_IDS.FIREFOX;
+        case WA_BROWSERS.IE:
+            return WA_COMPANION_PLATFORM_IDS.IE;
+        case WA_BROWSERS.OPERA:
+            return WA_COMPANION_PLATFORM_IDS.OPERA;
+        case WA_BROWSERS.SAFARI:
+            return WA_COMPANION_PLATFORM_IDS.SAFARI;
+        case WA_BROWSERS.EDGE:
+            return WA_COMPANION_PLATFORM_IDS.EDGE;
+        case WA_BROWSERS.CHROMIUM:
+        default:
+            return WA_COMPANION_PLATFORM_IDS.OTHER_WEB_CLIENT;
+    }
+}

package/dist/esm/protocol/constants.js

@@ -0,0 +1,11 @@
+export { getWaCompanionPlatformId, WA_BROWSERS, WA_COMPANION_PLATFORM_IDS } from './browser.js';
+export { WA_SIGNALING, WA_PAIRING_KDF_INFO } from './auth.js';
+export { WA_DISCONNECT_REASONS, WA_LOGOUT_REASONS, WA_READY_STATES, WA_STREAM_SIGNALING } from './stream.js';
+export { WA_IQ_TYPES, WA_NODE_TAGS, WA_XMLNS } from './nodes.js';
+export { WA_MESSAGE_TAGS, WA_MESSAGE_TYPES, WA_RETRYABLE_ACK_CODES } from './message.js';
+export { WA_APP_STATE_COLLECTIONS, WA_APP_STATE_COLLECTION_STATES, WA_APP_STATE_ERROR_CODES, WA_APP_STATE_KDF_INFO, WA_APP_STATE_KEY_TYPES, WA_APP_STATE_SYNC_DATA_TYPE } from './appstate.js';
+export { getWaMediaHkdfInfo, WA_MEDIA_HKDF_INFO, WA_PREVIEW_MEDIA_HKDF_INFO } from './media.js';
+export { WA_ACCOUNT_SYNC_PROTOCOLS, WA_DIRTY_PROTOCOLS, WA_DIRTY_TYPES, WA_SUPPORTED_DIRTY_TYPES } from './dirty.js';
+export { WA_GROUP_NOTIFICATION_TAGS, WA_NOTIFICATION_TYPES } from './notification.js';
+export { WA_DEFAULTS } from './defaults.js';
+export { WA_GROUP_PARTICIPANT_TYPES } from './group.js';

package/dist/esm/protocol/defaults.js

@@ -0,0 +1,27 @@
+import { getWaCompanionPlatformId, WA_BROWSERS } from './browser.js';
+export const WA_DEFAULTS = Object.freeze({
+    HOST_DOMAIN: 's.whatsapp.net',
+    GROUP_SERVER: 'g.us',
+    BROADCAST_SERVER: 'broadcast',
+    DEVICE_BROWSER: WA_BROWSERS.FIREFOX,
+    DEVICE_PLATFORM: getWaCompanionPlatformId(WA_BROWSERS.FIREFOX),
+    CHAT_SOCKET_URLS: ['wss://web.whatsapp.com/ws/chat', 'wss://web.whatsapp.com:5222/ws/chat'],
+    NOISE_RESUME_FAILURES_BEFORE_FULL_HANDSHAKE: 1,
+    IQ_TIMEOUT_MS: 15000,
+    NODE_QUERY_TIMEOUT_MS: 15000,
+    CONNECT_TIMEOUT_MS: 10000,
+    SOCKET_TIMEOUT_MS: 10000,
+    RECONNECT_INTERVAL_MS: 2000,
+    HEALTH_CHECK_INTERVAL_MS: 15000,
+    DEAD_SOCKET_TIMEOUT_MS: 20000,
+    MEDIA_TIMEOUT_MS: 30000,
+    APP_STATE_SYNC_TIMEOUT_MS: 30000,
+    SIGNAL_FETCH_KEY_BUNDLES_TIMEOUT_MS: 20000,
+    MESSAGE_ACK_TIMEOUT_MS: 10000,
+    MESSAGE_MAX_ATTEMPTS: 3,
+    MESSAGE_RETRY_DELAY_MS: 750,
+    PAIRING_CODE_MAX_AGE_SECONDS: 180,
+    QR_INITIAL_TTL_MS: 60000,
+    QR_ROTATION_TTL_MS: 20000,
+    MAX_DANGLING_RECEIPTS: 2048
+});

package/dist/esm/protocol/dirty.js

@@ -0,0 +1,26 @@
+export const WA_DIRTY_TYPES = Object.freeze({
+    ACCOUNT_SYNC: 'account_sync',
+    GROUPS: 'groups',
+    SYNCD_APP_STATE: 'syncd_app_state',
+    NEWSLETTER_METADATA: 'newsletter_metadata'
+});
+export const WA_DIRTY_PROTOCOLS = Object.freeze({
+    DEVICES: 'devices',
+    PICTURE: 'picture',
+    PRIVACY: 'privacy',
+    BLOCKLIST: 'blocklist',
+    NOTICE: 'notice'
+});
+export const WA_ACCOUNT_SYNC_PROTOCOLS = Object.freeze([
+    WA_DIRTY_PROTOCOLS.DEVICES,
+    WA_DIRTY_PROTOCOLS.PICTURE,
+    WA_DIRTY_PROTOCOLS.PRIVACY,
+    WA_DIRTY_PROTOCOLS.BLOCKLIST,
+    WA_DIRTY_PROTOCOLS.NOTICE
+]);
+export const WA_SUPPORTED_DIRTY_TYPES = Object.freeze([
+    WA_DIRTY_TYPES.ACCOUNT_SYNC,
+    WA_DIRTY_TYPES.SYNCD_APP_STATE,
+    WA_DIRTY_TYPES.GROUPS,
+    WA_DIRTY_TYPES.NEWSLETTER_METADATA
+]);

package/dist/esm/protocol/group.js

@@ -0,0 +1,5 @@
+export const WA_GROUP_PARTICIPANT_TYPES = Object.freeze({
+    SUPERADMIN: 'superadmin',
+    ADMIN: 'admin',
+    REGULAR: 'participant'
+});

package/dist/esm/protocol/index.js

@@ -0,0 +1,11 @@
+export { getWaCompanionPlatformId, WA_BROWSERS, WA_COMPANION_PLATFORM_IDS } from './browser.js';
+export { WA_SIGNALING, WA_PAIRING_KDF_INFO } from './auth.js';
+export { WA_DISCONNECT_REASONS, WA_LOGOUT_REASONS, WA_READY_STATES, WA_STREAM_SIGNALING } from './stream.js';
+export { WA_IQ_TYPES, WA_NODE_TAGS, WA_XMLNS } from './nodes.js';
+export { WA_MESSAGE_TAGS, WA_MESSAGE_TYPES, WA_RETRYABLE_ACK_CODES } from './message.js';
+export { WA_APP_STATE_COLLECTIONS, WA_APP_STATE_COLLECTION_STATES, WA_APP_STATE_ERROR_CODES, WA_APP_STATE_KDF_INFO, WA_APP_STATE_KEY_TYPES, WA_APP_STATE_SYNC_DATA_TYPE } from './appstate.js';
+export { getWaMediaHkdfInfo, WA_MEDIA_HKDF_INFO, WA_PREVIEW_MEDIA_HKDF_INFO } from './media.js';
+export { WA_ACCOUNT_SYNC_PROTOCOLS, WA_DIRTY_PROTOCOLS, WA_DIRTY_TYPES, WA_SUPPORTED_DIRTY_TYPES } from './dirty.js';
+export { WA_GROUP_NOTIFICATION_TAGS, WA_NOTIFICATION_TYPES } from './notification.js';
+export { WA_DEFAULTS } from './defaults.js';
+export { getLoginIdentity, isGroupJid, normalizeDeviceJid, normalizeRecipientJid, parsePhoneJid, parseSignalAddressFromJid, splitJid, toUserJid } from './jid.js';

package/dist/esm/protocol/jid.js

@@ -0,0 +1,94 @@
+import { WA_DEFAULTS } from './constants.js';
+export function splitJid(jid) {
+    const atIndex = jid.indexOf('@');
+    if (atIndex < 1 || atIndex >= jid.length - 1) {
+        throw new Error(`invalid jid: ${jid}`);
+    }
+    return {
+        user: jid.slice(0, atIndex),
+        server: jid.slice(atIndex + 1)
+    };
+}
+export function normalizeRecipientJid(to) {
+    const input = to.trim();
+    if (input.length === 0) {
+        throw new Error('recipient cannot be empty');
+    }
+    if (input.includes('@')) {
+        return input;
+    }
+    if (input.includes('-')) {
+        return `${input}@${WA_DEFAULTS.GROUP_SERVER}`;
+    }
+    const digits = input.replace(/\D/g, '');
+    if (digits.length === 0) {
+        throw new Error(`invalid recipient: ${to}`);
+    }
+    return `${digits}@${WA_DEFAULTS.HOST_DOMAIN}`;
+}
+export function isJidType(jid, type) {
+    return jid.endsWith(`@${type}`);
+}
+export function isGroupJid(jid) {
+    return isJidType(jid, WA_DEFAULTS.GROUP_SERVER);
+}
+export function isBroadcastJid(jid) {
+    return isJidType(jid, WA_DEFAULTS.BROADCAST_SERVER);
+}
+export function isGroupOrBroadcastJid(jid) {
+    return isGroupJid(jid) || isBroadcastJid(jid);
+}
+export function parseSignalAddressFromJid(jid) {
+    const parsed = splitJid(jid);
+    const colonIndex = parsed.user.indexOf(':');
+    if (colonIndex === -1) {
+        return {
+            user: parsed.user,
+            server: parsed.server,
+            device: 0
+        };
+    }
+    const user = parsed.user.slice(0, colonIndex);
+    const deviceRaw = parsed.user.slice(colonIndex + 1);
+    const device = Number.parseInt(deviceRaw, 10);
+    if (!Number.isFinite(device) || device < 0) {
+        throw new Error(`invalid jid device: ${jid}`);
+    }
+    return {
+        user,
+        server: parsed.server,
+        device
+    };
+}
+export function toUserJid(jid) {
+    const address = parseSignalAddressFromJid(jid);
+    return `${address.user}@${address.server}`;
+}
+export function normalizeDeviceJid(jid) {
+    const address = parseSignalAddressFromJid(jid);
+    if (address.device === 0) {
+        return `${address.user}@${address.server}`;
+    }
+    return `${address.user}:${address.device}@${address.server}`;
+}
+export function getLoginIdentity(meJid) {
+    const parsed = splitJid(meJid);
+    const [userAndAgent, devicePart = '0'] = parsed.user.split(':');
+    const userPart = userAndAgent.split('.')[0];
+    const username = Number.parseInt(userPart, 10);
+    const device = Number.parseInt(devicePart, 10);
+    if (!Number.isSafeInteger(username) || username <= 0) {
+        throw new Error(`invalid numeric username from ${meJid}`);
+    }
+    if (!Number.isSafeInteger(device) || device < 0) {
+        throw new Error(`invalid device from ${meJid}`);
+    }
+    return { username, device };
+}
+export function parsePhoneJid(input) {
+    const digits = input.replace(/\D+/g, '');
+    if (!digits) {
+        throw new Error('phone number is empty after normalization');
+    }
+    return `${digits}@${WA_DEFAULTS.HOST_DOMAIN}`;
+}

package/dist/esm/protocol/media.js

@@ -0,0 +1,20 @@
+export const 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'
+});
+export const WA_PREVIEW_MEDIA_HKDF_INFO = 'Messenger Preview Keys';
+export function getWaMediaHkdfInfo(mediaType) {
+    if (mediaType in WA_MEDIA_HKDF_INFO) {
+        return WA_MEDIA_HKDF_INFO[mediaType];
+    }
+    throw new Error(`unsupported media type: ${mediaType}`);
+}

package/dist/esm/protocol/message.js

@@ -0,0 +1,16 @@
+export const WA_MESSAGE_TAGS = Object.freeze({
+    MESSAGE: 'message',
+    ENC: 'enc',
+    RECEIPT: 'receipt',
+    ACK: 'ack',
+    ERROR: 'error'
+});
+export const WA_MESSAGE_TYPES = Object.freeze({
+    ENC_VERSION: '2',
+    MEDIA_NOTIFY: 'medianotify',
+    ACK_TYPE_ERROR: 'error',
+    ACK_CLASS_ERROR: 'error',
+    ACK_CLASS_MESSAGE: 'message',
+    RECEIPT_TYPE_PEER: 'peer_msg'
+});
+export const WA_RETRYABLE_ACK_CODES = Object.freeze(['408', '429', '500', '503']);

package/dist/esm/protocol/nodes.js

@@ -0,0 +1,83 @@
+export const WA_NODE_TAGS = Object.freeze({
+    IQ: 'iq',
+    SYNC: 'sync',
+    COLLECTION: 'collection',
+    PATCH: 'patch',
+    PATCHES: 'patches',
+    SNAPSHOT: 'snapshot',
+    ERROR: 'error',
+    ACK: 'ack',
+    NOTIFICATION: 'notification',
+    SUCCESS: 'success',
+    INFO_BULLETIN: 'ib',
+    DIRTY: 'dirty',
+    EDGE_ROUTING: 'edge_routing',
+    ROUTING_INFO: 'routing_info',
+    MEDIA_CONN: 'media_conn',
+    HOST: 'host',
+    USYNC: 'usync',
+    QUERY: 'query',
+    DEVICES: 'devices',
+    DEVICE: 'device',
+    DIGEST: 'digest',
+    KEY_FETCH: 'key_fetch',
+    LIST: 'list',
+    USER: 'user',
+    PICTURE: 'picture',
+    PRIVACY: 'privacy',
+    PARTICIPATING: 'participating',
+    PARTICIPANTS: 'participants',
+    DESCRIPTION: 'description',
+    MY_ADDONS: 'my_addons',
+    KEY: 'key',
+    REGISTRATION: 'registration',
+    TYPE: 'type',
+    IDENTITY: 'identity',
+    SKEY: 'skey',
+    ID: 'id',
+    REF: 'ref',
+    VALUE: 'value',
+    SIGNATURE: 'signature',
+    HASH: 'hash',
+    ROTATE: 'rotate',
+    PAIR_DEVICE: 'pair-device',
+    PAIR_SUCCESS: 'pair-success',
+    LINK_CODE_COMPANION_REG: 'link_code_companion_reg',
+    LINK_CODE_PAIRING_REF: 'link_code_pairing_ref',
+    COUNTRY_CODE: 'country_code',
+    DEVICE_IDENTITY: 'device-identity',
+    PLATFORM: 'platform',
+    SUBJECT: 'subject',
+    BODY: 'body',
+    PARTICIPANT: 'participant',
+    INVITE: 'invite',
+    LEAVE: 'leave',
+    GROUP: 'group',
+    LOCKED: 'locked',
+    UNLOCKED: 'unlocked',
+    ANNOUNCEMENT: 'announcement',
+    EPHEMERAL: 'ephemeral',
+    MEMBERSHIP_APPROVAL_MODE: 'membership_approval_mode',
+    GROUP_JOIN: 'group_join'
+});
+export const WA_IQ_TYPES = Object.freeze({
+    GET: 'get',
+    SET: 'set',
+    RESULT: 'result',
+    ERROR: 'error'
+});
+export const WA_XMLNS = Object.freeze({
+    MD: 'md',
+    APP_STATE_SYNC: 'w:sync:app:state',
+    MEDIA: 'w:m',
+    SIGNAL: 'encrypt',
+    DIRTY_BITS: 'urn:xmpp:whatsapp:dirty',
+    PROFILE_PICTURE: 'w:profile:picture',
+    PRIVACY: 'privacy',
+    BLOCKLIST: 'blocklist',
+    USYNC: 'usync',
+    GROUPS: 'w:g2',
+    NEWSLETTER: 'newsletter',
+    XMPP_PING: 'urn:xmpp:ping',
+    WHATSAPP_PING: 'w:p'
+});

package/dist/esm/protocol/notification.js

@@ -0,0 +1,50 @@
+export const WA_NOTIFICATION_TYPES = Object.freeze({
+    GROUP: 'w:gp2'
+});
+export const WA_GROUP_NOTIFICATION_TAGS = Object.freeze({
+    REMOVE: 'remove',
+    ADD: 'add',
+    DEMOTE: 'demote',
+    DELETE: 'delete',
+    PROMOTE: 'promote',
+    MODIFY: 'modify',
+    CREATE: 'create',
+    SUBJECT: 'subject',
+    DESCRIPTION: 'description',
+    LOCKED: 'locked',
+    UNLOCKED: 'unlocked',
+    ANNOUNCEMENT: 'announcement',
+    NOT_ANNOUNCEMENT: 'not_announcement',
+    NO_FREQUENTLY_FORWARDED: 'no_frequently_forwarded',
+    FREQUENTLY_FORWARDED_OK: 'frequently_forwarded_ok',
+    INVITE: 'invite',
+    EPHEMERAL: 'ephemeral',
+    NOT_EPHEMERAL: 'not_ephemeral',
+    REVOKE: 'revoke',
+    SUSPENDED: 'suspended',
+    UNSUSPENDED: 'unsuspended',
+    GROWTH_LOCKED: 'growth_locked',
+    GROWTH_UNLOCKED: 'growth_unlocked',
+    LINK: 'link',
+    UNLINK: 'unlink',
+    LINKED_GROUP_PROMOTE: 'linked_group_promote',
+    LINKED_GROUP_DEMOTE: 'linked_group_demote',
+    MEMBERSHIP_APPROVAL_MODE: 'membership_approval_mode',
+    MEMBERSHIP_APPROVAL_REQUEST: 'membership_approval_request',
+    CREATED_MEMBERSHIP_REQUESTS: 'created_membership_requests',
+    REVOKED_MEMBERSHIP_REQUESTS: 'revoked_membership_requests',
+    ALLOW_NON_ADMIN_SUB_GROUP_CREATION: 'allow_non_admin_sub_group_creation',
+    NOT_ALLOW_NON_ADMIN_SUB_GROUP_CREATION: 'not_allow_non_admin_sub_group_creation',
+    ALLOW_ADMIN_REPORTS: 'allow_admin_reports',
+    NOT_ALLOW_ADMIN_REPORTS: 'not_allow_admin_reports',
+    REPORTS: 'reports',
+    CREATED_SUB_GROUP_SUGGESTION: 'created_sub_group_suggestion',
+    REVOKED_SUB_GROUP_SUGGESTIONS: 'revoked_sub_group_suggestions',
+    CHANGE_NUMBER: 'change_number',
+    MEMBER_ADD_MODE: 'member_add_mode',
+    AUTO_ADD_DISABLED: 'auto_add_disabled',
+    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'
+});

package/dist/esm/protocol/stream.js

@@ -0,0 +1,60 @@
+export const WA_READY_STATES = Object.freeze({
+    CONNECTING: 0,
+    OPEN: 1,
+    CLOSING: 2,
+    CLOSED: 3
+});
+export const WA_LOGOUT_REASONS = Object.freeze({
+    USER_INITIATED: 'user_initiated',
+    SYNCD_FAILURE: 'syncd_failure',
+    INVALID_ADV_STATUS: 'invalid_adv_status',
+    CRITICAL_SYNC_TIMEOUT: 'critical_sync_timeout',
+    SYNCD_TIMEOUT: 'syncd_timeout',
+    HISTORY_SYNC_TIMEOUT: 'history_sync_timeout',
+    ACCOUNT_SYNC_TIMEOUT: 'account_sync_timeout',
+    MD_OPT_OUT: 'md_opt_out',
+    UNKNOWN_COMPANION: 'unknown_companion',
+    CLIENT_VERSION_OUTDATED: 'client_version_outdated',
+    SYNCD_ERROR_DURING_BOOTSTRAP: 'syncd_error_during_bootstrap',
+    ACCOUNT_SYNC_ERROR: 'account_sync_error',
+    STORAGE_QUOTA_EXCEEDED: 'storage_quota_exceeded',
+    PRIMARY_IDENTITY_KEY_CHANGE: 'primary_identity_key_change',
+    MISSING_ENC_SALT: 'missing_enc_salt',
+    MISSING_SCREEN_LOCK_SALT: 'missing_screen_lock_salt',
+    ACCOUNT_LOCKED: 'account_locked',
+    LID_MIGRATION_SPLIT_THREAD_MISMATCH: 'lid_migration_split_thread_mismatch',
+    LID_MIGRATION_NO_LID_AVAILABLE: 'lid_migration_no_lid_available',
+    LID_MIGRATION_PRIMARY_MAPPINGS_OBSOLETE: 'lid_migration_primary_mappings_obsolete',
+    LID_MIGRATION_PEER_MAPPINGS_NOT_RECEIVED: 'lid_migration_peer_mapping_not_received',
+    LID_MIGRATION_STATE_DISCREPANCY: 'lid_migration_state_discrepancy',
+    LID_MIGRATION_PEER_MAPPINGS_MALFORMED: 'lid_migration_peer_mapping_malformed',
+    LID_MIGRATION_FAILED_TO_PARSE_MAPPING: 'lid_migration_failed_to_parse_mapping',
+    LID_MIGRATION_COMPANION_INCOMPATIBLE_KILLSWITCH: 'lid_migration_companion_incompatible_killswitch',
+    LID_MIGRATION_ONE_ON_ONE_THREAD_MIGRATION_INTERNAL_ERROR: 'lid_migration_one_on_one_thread_migration_internal_error',
+    LID_BLOCKLIST_PN_WHEN_MIGRATED: 'lid_blocklist_pn_when_migrated',
+    LID_BLOCKLIST_CHAT_DB_UNMIGRATED: 'lid_blocklist_chat_db_unmigrated',
+    WEB_FAIL_ADD_CHAT: 'web_fail_add_chat',
+    WEB_FAIL_OFFLINE_RESUME: 'web_fail_offline_resume',
+    WEB_FAIL_STORAGE_INITIALIZATION: 'web_fail_storage_initialization',
+    WEB_FAIL_ENC_SALT: 'web_fail_enc_salt',
+    CACHE_STORAGE_OPEN_FAILED: 'cache_storage_open_failed'
+});
+export const WA_STREAM_SIGNALING = Object.freeze({
+    STREAM_ERROR_TAG: 'stream:error',
+    XML_STREAM_END_TAG: 'xmlstreamend',
+    CONFLICT_TAG: 'conflict',
+    ACK_TAG: 'ack',
+    XML_NOT_WELL_FORMED_TAG: 'xml-not-well-formed',
+    REPLACED_TYPE: 'replaced',
+    FORCE_LOGIN_CODE: 515,
+    FORCE_LOGOUT_CODE: 516
+});
+export const WA_DISCONNECT_REASONS = Object.freeze({
+    CLIENT_DISCONNECTED: 'client_disconnected',
+    COMMS_STOPPED: 'comms_stopped',
+    STREAM_ERROR_REPLACED: 'stream_error_replaced',
+    STREAM_ERROR_DEVICE_REMOVED: 'stream_error_device_removed',
+    STREAM_ERROR_ACK: 'stream_error_ack',
+    STREAM_ERROR_XML_NOT_WELL_FORMED: 'stream_error_xml_not_well_formed',
+    STREAM_ERROR_OTHER: 'stream_error_other'
+});

package/dist/esm/retry/constants.js

@@ -0,0 +1,20 @@
+export const MAX_RETRY_ATTEMPTS = 5;
+export const RETRY_KEYS_MIN_COUNT = 2;
+export const RETRY_OUTBOUND_TTL_MS = 7 * 24 * 60 * 60 * 1000;
+export const RETRY_RECEIPT_VERSION = '1';
+export const RETRY_REASON = Object.freeze({
+    UnknownError: 0,
+    SignalErrorNoSession: 1,
+    SignalErrorInvalidKey: 2,
+    SignalErrorInvalidKeyId: 3,
+    SignalErrorInvalidMessage: 4,
+    SignalErrorInvalidSignature: 5,
+    SignalErrorFutureMessage: 6,
+    SignalErrorBadMac: 7,
+    SignalErrorInvalidSession: 8,
+    SignalErrorInvalidMsgKey: 9,
+    BadBroadcastEphemeralSetting: 10,
+    UnknownCompanionNoPrekey: 11,
+    AdvFailure: 12,
+    StatusRevokeDelay: 13
+});

package/dist/esm/retry/index.js

@@ -0,0 +1,5 @@
+export { MAX_RETRY_ATTEMPTS, RETRY_KEYS_MIN_COUNT, RETRY_OUTBOUND_TTL_MS, RETRY_REASON, RETRY_RECEIPT_VERSION } from './constants.js';
+export { mapRetryReasonFromError } from './reason.js';
+export { parseRetryReceiptRequest } from './parse.js';
+export { decodeRetryReplayPayload, encodeRetryReplayPayload, pickRetryStateMax } from './outbound.js';
+export { WaRetryReplayService } from './replay.js';

package/dist/esm/retry/outbound.js

@@ -0,0 +1,83 @@
+import { base64ToBytes, bytesToBase64 } from '../util/base64.js';
+import { TEXT_DECODER, TEXT_ENCODER } from '../util/bytes.js';
+function requireObject(value) {
+    if (!value || typeof value !== 'object') {
+        throw new Error('invalid retry replay payload');
+    }
+    return value;
+}
+function requireString(value, field) {
+    if (typeof value !== 'string') {
+        throw new Error(`invalid retry replay payload field: ${field}`);
+    }
+    return value;
+}
+export function encodeRetryReplayPayload(payload) {
+    const serialized = payload.mode === 'plaintext'
+        ? {
+            mode: payload.mode,
+            to: payload.to,
+            type: payload.type,
+            plaintext: bytesToBase64(payload.plaintext)
+        }
+        : payload.mode === 'encrypted'
+            ? {
+                mode: payload.mode,
+                to: payload.to,
+                type: payload.type,
+                encType: payload.encType,
+                ciphertext: bytesToBase64(payload.ciphertext),
+                participant: payload.participant
+            }
+            : {
+                mode: payload.mode,
+                node: bytesToBase64(payload.node)
+            };
+    return TEXT_ENCODER.encode(JSON.stringify(serialized));
+}
+export function decodeRetryReplayPayload(raw) {
+    const json = JSON.parse(TEXT_DECODER.decode(raw));
+    const parsed = requireObject(json);
+    const mode = requireString(parsed.mode, 'mode');
+    if (mode === 'plaintext') {
+        return {
+            mode,
+            to: requireString(parsed.to, 'to'),
+            type: requireString(parsed.type, 'type'),
+            plaintext: base64ToBytes(requireString(parsed.plaintext, 'plaintext'), 'retry.plaintext')
+        };
+    }
+    if (mode === 'encrypted') {
+        const encType = requireString(parsed.encType, 'encType');
+        if (encType !== 'msg' && encType !== 'pkmsg' && encType !== 'skmsg') {
+            throw new Error(`invalid retry encrypted encType: ${encType}`);
+        }
+        return {
+            mode,
+            to: requireString(parsed.to, 'to'),
+            type: requireString(parsed.type, 'type'),
+            encType,
+            ciphertext: base64ToBytes(requireString(parsed.ciphertext, 'ciphertext'), 'retry.ciphertext'),
+            participant: parsed.participant === undefined
+                ? undefined
+                : requireString(parsed.participant, 'participant')
+        };
+    }
+    if (mode === 'opaque_node') {
+        return {
+            mode,
+            node: base64ToBytes(requireString(parsed.node, 'node'), 'retry.node')
+        };
+    }
+    throw new Error(`invalid retry replay payload mode: ${mode}`);
+}
+const RETRY_STATE_RANK = {
+    pending: 0,
+    delivered: 1,
+    read: 2,
+    played: 3,
+    ineligible: 4
+};
+export function pickRetryStateMax(left, right) {
+    return RETRY_STATE_RANK[left] >= RETRY_STATE_RANK[right] ? left : right;
+}