@whanext/core 0.19.18 → 0.19.20

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Changelog
 
+## 0.19.20
+
+### Ingress diagnostics
+- Added opt-in provider ingress tracing with `providerDiagnostics.ingress`, correlating Zapo transport message stanzas through decrypt and terminal provider events without logging message content or decrypted bytes.
+- Added a bounded ingress watchdog through `providerDiagnostics.ingressStallTimeoutMs`, defaulting to 10 seconds. A decoded `<message>` stanza that never becomes `message`, `message_unavailable`, a decode failure, or a decrypt failure emits `messageIngressStalled` and temporarily marks the provider as degraded.
+- Added transport decode diagnostics from Zapo 1.8.0 `debug_transport_decode_error` with a typed `transportDecodeFailure` event. Only frame size and error metadata are exposed; raw frame bytes are never logged or emitted.
+- Expanded `health().messaging` with `transportFramesIn`, `transportNodesIn`, `transportDecodeErrors`, `messageStanzasIn`, and `ingressStalls`.
+- When ingress diagnostics are enabled, message stanzas log their stanza id, chat, participant, addressing mode, encryption types, decrypt stage, and terminal provider stage. Message text and plaintext payloads are never included.
+
+### Reliability
+- Correlates decrypt warnings with pending message stanzas so known Signal failures do not appear as generic ingress stalls.
+- Normalizes device-qualified PN/LID JIDs before ingress correlation, keeping group and direct-message diagnostics aligned with Zapo message keys.
+
+## 0.19.19
+
+### Provider
+- Updated the official provider from `zapo-js@1.7.1` to `zapo-js@1.8.0`.
+- Kept full received LID/PN addressing metadata when replying, reacting, editing, revoking, and pinning messages.
+- Inherits Zapo 1.8.0 mailbox `fromMe` persistence fixes, group-status stanza attribute unwrapping, username support, expired-CDN media resend support, and mobile-primary WhatsApp Business support.
+
+### Incoming message observability
+- Added `message_unavailable` tracking with primary-device resend correlation and a bounded 30-second recovery window.
+- Added `debug_decrypted_payload` correlation with `debug_unhandled_stanza` so decrypted-but-undecodable payloads are visible without logging plaintext bytes.
+- Expanded `health().messaging` with `decryptedPayloads`, `unavailable`, `resendRequested`, `recovered`, `recoveryFailed`, `unavailableUnrecoverable`, `decodeFailures`, `unhandledStanzas`, `ignoredOffline`, `duplicates`, and `normalizationFailures`.
+- Added typed `messageUnavailable`, `messageRecovered`, `messageRecoveryFailed`, `messageDecodeFailure`, and `messageDiscarded` application events.
+- Recovery failures and decrypted-payload decode failures temporarily mark provider stability as `degraded`; expected unrecoverable placeholders such as consumed view-once messages are counted without automatically degrading the session.
+
+### Safety
+- Raw decrypted payload bytes from Zapo are never emitted through the WhaNext public events or written to logs.
+- Existing `received`, `sent`, and `failed` counters keep their previous semantics; the new counters explain why an inbound stanza may not have become a public WhaNext `Message`.
+
 ## 0.19.18
 
 ### Stability

package/README.md

@@ -331,7 +331,34 @@ console.log(health.timeouts);
 
 `status` continua representando o ciclo da aplicação: `idle`, `starting`, `ready` ou `stopped`. `stability` representa a saúde operacional do provider: `healthy`, `degraded`, `reconnecting` ou `offline`.
 
-O provider Zapo contabiliza reconexões, mensagens enviadas/recebidas, falhas de envio, falhas de descriptografia, `sender key id mismatch`, falhas de addons, divergências de `phash` e recuperações de metadata. O router contabiliza execuções ativas, fila atual, expirações e rejeições por fila cheia.
+O provider Zapo contabiliza reconexões, mensagens enviadas/recebidas, falhas de envio, falhas de descriptografia, `sender key id mismatch`, falhas de addons, divergências de `phash` e recuperações de metadata. Com Zapo 1.8.0, `health.messaging` também mostra mensagens indisponíveis, pedidos de resend, recuperações, payloads descriptografados, falhas de decode, stanzas não tratadas, duplicatas, mensagens offline ignoradas e falhas de normalização. O router contabiliza execuções ativas, fila atual, expirações e rejeições por fila cheia.
+
+```ts
+const { messaging } = app.health();
+
+console.log(messaging.unavailable);
+console.log(messaging.resendRequested);
+console.log(messaging.recovered);
+console.log(messaging.recoveryFailed);
+console.log(messaging.decodeFailures);
+console.log(messaging.ignoredOffline);
+console.log(messaging.duplicates);
+```
+
+`decryptedPayloads` conta payloads `<enc>` individuais, portanto pode ser maior que `received` em fanout para vários devices. O WhaNext usa esse sinal apenas para correlação e nunca expõe os bytes descriptografados no health, eventos públicos ou logs.
+
+Para diagnosticar mensagens que chegam ao socket mas não viram um `Message` público, ative a trilha de ingresso:
+
+```ts
+const app = await create({
+  providerDiagnostics: {
+    ingress: true,
+    ingressStallTimeoutMs: 10_000,
+  },
+});
+```
+
+Com essa opção, o provider registra apenas metadados seguros de stanzas `<message>` e correlaciona `debug_transport_node_in`, `debug_decrypted_payload`, `message`, `message_unavailable`, falhas de decrypt e falhas de decode. `health().messaging` também expõe `transportFramesIn`, `transportNodesIn`, `transportDecodeErrors`, `messageStanzasIn` e `ingressStalls`. Frames brutos, bytes descriptografados e texto das mensagens nunca são escritos nos logs.
 
 ```ts
 server.get('/health', async () => app.health());
@@ -390,6 +417,26 @@ app.on('cryptoDegraded', ({ kind, chatId }) => {
   console.log(kind, chatId);
 });
 
+app.on('messageUnavailable', ({ messageId, resendRequested }) => {
+  console.log(messageId, resendRequested);
+});
+
+app.on('messageRecovered', ({ messageId, recoveryMs }) => {
+  console.log(messageId, recoveryMs);
+});
+
+app.on('messageRecoveryFailed', ({ messageId, waitedMs }) => {
+  console.log(messageId, waitedMs);
+});
+
+app.on('messageDecodeFailure', ({ stanzaId, reason }) => {
+  console.log(stanzaId, reason);
+});
+
+app.on('messageDiscarded', ({ messageId, reason }) => {
+  console.log(messageId, reason);
+});
+
 app.on('commandQueueTimeout', ({ command, queuedForMs }) => {
   console.log(command, queuedForMs);
 });

package/dist/index.d.ts

@@ -315,6 +315,22 @@ interface ProviderMessagingHealth {
     sent: number;
     received: number;
     failed: number;
+    decryptedPayloads: number;
+    unavailable: number;
+    resendRequested: number;
+    recovered: number;
+    recoveryFailed: number;
+    unavailableUnrecoverable: number;
+    decodeFailures: number;
+    unhandledStanzas: number;
+    ignoredOffline: number;
+    duplicates: number;
+    normalizationFailures: number;
+    transportFramesIn: number;
+    transportNodesIn: number;
+    transportDecodeErrors: number;
+    messageStanzasIn: number;
+    ingressStalls: number;
     lastIncomingAt?: Date;
     lastOutgoingAt?: Date;
 }
@@ -354,12 +370,86 @@ interface CryptoDegradedEvent {
     chatId?: string;
     participantId?: string;
 }
+interface MessageUnavailableEvent {
+    kind: 'view_once' | 'hosted' | 'bot' | 'other';
+    resendRequested: boolean;
+    occurredAt: Date;
+    messageId?: string;
+    chatId?: string;
+    participantId?: string;
+}
+interface MessageRecoveredEvent {
+    recoveredAt: Date;
+    recoveryMs: number;
+    messageId?: string;
+    chatId?: string;
+    participantId?: string;
+}
+interface MessageRecoveryFailedEvent {
+    failedAt: Date;
+    waitedMs: number;
+    messageId?: string;
+    chatId?: string;
+    participantId?: string;
+}
+interface MessageDecodeFailureEvent {
+    occurredAt: Date;
+    reason: string;
+    stanzaId?: string;
+    chatId?: string;
+    encType?: string;
+}
+type MessageDiscardReason = 'offline' | 'duplicate' | 'normalization_failed';
+interface MessageDiscardedEvent {
+    reason: MessageDiscardReason;
+    occurredAt: Date;
+    messageId?: string;
+    chatId?: string;
+}
+type MessageIngressStage = 'stanza_received' | 'decrypted';
+interface MessageIngressStalledEvent {
+    occurredAt: Date;
+    waitedMs: number;
+    lastStage: MessageIngressStage;
+    stanzaId: string;
+    chatId?: string;
+    participantId?: string;
+    stanzaType?: string;
+    addressingMode?: string;
+}
+interface TransportDecodeFailureEvent {
+    occurredAt: Date;
+    frameBytes: number;
+    errorName: string;
+    errorMessage: string;
+}
 type ProviderStabilityEvent = {
     type: 'groupMetadataRecovered';
     payload: GroupMetadataRecoveredEvent;
 } | {
     type: 'cryptoDegraded';
     payload: CryptoDegradedEvent;
+} | {
+    type: 'messageUnavailable';
+    payload: MessageUnavailableEvent;
+} | {
+    type: 'messageRecovered';
+    payload: MessageRecoveredEvent;
+} | {
+    type: 'messageRecoveryFailed';
+    payload: MessageRecoveryFailedEvent;
+} | {
+    type: 'messageDecodeFailure';
+    payload: MessageDecodeFailureEvent;
+} | {
+    type: 'messageDiscarded';
+    payload: MessageDiscardedEvent;
+} | {
+    type: 'messageIngressStalled';
+    payload: MessageIngressStalledEvent;
+} | {
+    type: 'transportDecodeFailure';
+    payload: TransportDecodeFailureEvent;
 } | {
     type: 'healthRefresh';
     payload: {
@@ -936,6 +1026,13 @@ interface AppEvents {
     connectionRecovered: ConnectionRecoveredEvent;
     groupMetadataRecovered: GroupMetadataRecoveredEvent;
     cryptoDegraded: CryptoDegradedEvent;
+    messageUnavailable: MessageUnavailableEvent;
+    messageRecovered: MessageRecoveredEvent;
+    messageRecoveryFailed: MessageRecoveryFailedEvent;
+    messageDecodeFailure: MessageDecodeFailureEvent;
+    messageDiscarded: MessageDiscardedEvent;
+    messageIngressStalled: MessageIngressStalledEvent;
+    transportDecodeFailure: TransportDecodeFailureEvent;
     commandQueueTimeout: CommandQueueTimeoutEvent;
     commandQueueFull: CommandQueueFullEvent;
 }
@@ -1001,6 +1098,10 @@ interface ProviderTimeoutOptions {
     connectTimeoutMs?: number;
     nodeQueryTimeoutMs?: number;
 }
+interface ProviderDiagnosticsOptions {
+    ingress?: boolean;
+    ingressStallTimeoutMs?: number;
+}
 interface ReconnectOptions {
     enabled?: boolean;
     maxAttempts?: number;
@@ -1018,6 +1119,7 @@ interface CreateOptions {
     router?: Omit<RouterOptions, 'prefix'>;
     reconnect?: ReconnectOptions;
     providerTimeouts?: ProviderTimeoutOptions;
+    providerDiagnostics?: ProviderDiagnosticsOptions;
     messageCacheSize?: number;
     processOfflineMessages?: boolean;
     provider?: WhatsAppProvider;
@@ -1105,4 +1207,4 @@ declare class SqliteMuteStore implements MuteStore {
     close(): void;
 }
 
-export { AccountService, type AddMuteOptions, type AddMuteResult, type AppEvents, type AppHealth, type AppHealthStatus, ArgsParser, type AudioContent, type BooleanOption, Browser, type ButtonsContent, type CacheOptions, type CacheStore, type CallEvent, type CallStatus, type ChangeResult, type CommandAccountContext, type CommandCatalogOptions, type CommandCatalogView, type CommandChatContext, type CommandConcurrency, type CommandConcurrencyContext, type CommandConcurrencyEvent, type CommandConcurrencyHealth, type CommandContext, type CommandCooldown, type CommandDefinition, type CommandErrorHandler, type CommandGroupContext, type CommandGroupDefinition, type CommandGuard, type CommandHelpOptions, type CommandHooks, type CommandLocalization, type CommandMetadata, type CommandMiddleware, type CommandOptionDefinition, type CommandOptionSchema, type CommandOptionValue, type CommandOptionValues, type CommandQueueFullEvent, type CommandQueueTimeoutEvent, type CommandRegistrar, CommandRouter, type CommandRouterEvents, type CommandRuntimeServices, type CommandScope, type ConcurrencyStrategy, type ConnectionRecoveredEvent, type ConnectionState, type ConnectionUpdate, type CopyCodeButton, type CreateMultiOptions, type CreateOptions, type CryptoAccelerationBackend, type CryptoDegradationKind, type CryptoDegradedEvent, DeferredReply, type DownloadedMedia, type DurationOption, type EnumOption, type ExecutableCommandDefinition, type GroupAccess, type GroupAddressingMode, type GroupMetadataRecoveredEvent, type GroupParticipant, type GroupParticipantAction, type GroupParticipantsChanged, type GroupRole, type GroupSnapshot, type GuardResult, type HealthChangedEvent, type ImageContent, type InteractiveResponse, type InteractiveResponseKind, type InviteResult, type LinkButton, type ListContent, type ListRow, type ListSection, type LoadCommandsOptions, type LoadCommandsResult, type LoadedCommand, type LogContext, type LogEntry, type LogFormat, type LogLevel, type LogWriter, Logger, type LoggerConfig, type LoggerOptions, type LoginOptions, type MediaKind, type MediaSource, type MemberActionState, MemoryCache, type MemoryCacheStats, type MentionTarget, type Message, type MessageButton, type MessageContent, type MessageContentKind, type MessageDeleted, type MessageEdited, type MessageKey, type MessageMedia, type MessagePayloadKind, type MessageProtocolKind, type MultiAccountOptions, type MultiAppEvent, type MultiAppHealth, MultiCommandRouter, type MultiLoadCommandsResult, type MultiLoginOptions, type MuteChangeResult, type MuteEnforcement, type MuteOptions, type MuteRecord, MuteService, type MuteStore, type NumberOption, ParsedCommandOptions, type ParticipantUpdateResult, type PollContent, type PresenceState, type ProviderConnectionHealth, type ProviderCryptoHealth, type ProviderGroupHealth, type ProviderHealth, type ProviderMessagingHealth, type ProviderStabilityEvent, type ProviderTimeoutHealth, type ProviderTimeoutOptions, type QuickReplyButton, type QuotedMessage, type ReconnectOptions, type RegisteredCommand, type RemoveMuteResult, type ReplyOptions, type RepostMessageOptions, type RouterOptions, type SentMessage, SqliteMuteStore, type StabilityHealthStatus, type StickerContent, type StoredMute, type StringOption, type TextContent, User, type UserData, type UserOption, type VideoContent, WhaNextApp, WhaNextError, type WhaNextErrorCode, WhaNextMultiApp, type WhatsAppProvider, create, createMulti, defineCommand, defineCommandGroup, defineCommands, defineSubcommand, guards, isCommandGroup, loadCommands, option, toWhaNextError };
+export { AccountService, type AddMuteOptions, type AddMuteResult, type AppEvents, type AppHealth, type AppHealthStatus, ArgsParser, type AudioContent, type BooleanOption, Browser, type ButtonsContent, type CacheOptions, type CacheStore, type CallEvent, type CallStatus, type ChangeResult, type CommandAccountContext, type CommandCatalogOptions, type CommandCatalogView, type CommandChatContext, type CommandConcurrency, type CommandConcurrencyContext, type CommandConcurrencyEvent, type CommandConcurrencyHealth, type CommandContext, type CommandCooldown, type CommandDefinition, type CommandErrorHandler, type CommandGroupContext, type CommandGroupDefinition, type CommandGuard, type CommandHelpOptions, type CommandHooks, type CommandLocalization, type CommandMetadata, type CommandMiddleware, type CommandOptionDefinition, type CommandOptionSchema, type CommandOptionValue, type CommandOptionValues, type CommandQueueFullEvent, type CommandQueueTimeoutEvent, type CommandRegistrar, CommandRouter, type CommandRouterEvents, type CommandRuntimeServices, type CommandScope, type ConcurrencyStrategy, type ConnectionRecoveredEvent, type ConnectionState, type ConnectionUpdate, type CopyCodeButton, type CreateMultiOptions, type CreateOptions, type CryptoAccelerationBackend, type CryptoDegradationKind, type CryptoDegradedEvent, DeferredReply, type DownloadedMedia, type DurationOption, type EnumOption, type ExecutableCommandDefinition, type GroupAccess, type GroupAddressingMode, type GroupMetadataRecoveredEvent, type GroupParticipant, type GroupParticipantAction, type GroupParticipantsChanged, type GroupRole, type GroupSnapshot, type GuardResult, type HealthChangedEvent, type ImageContent, type InteractiveResponse, type InteractiveResponseKind, type InviteResult, type LinkButton, type ListContent, type ListRow, type ListSection, type LoadCommandsOptions, type LoadCommandsResult, type LoadedCommand, type LogContext, type LogEntry, type LogFormat, type LogLevel, type LogWriter, Logger, type LoggerConfig, type LoggerOptions, type LoginOptions, type MediaKind, type MediaSource, type MemberActionState, MemoryCache, type MemoryCacheStats, type MentionTarget, type Message, type MessageButton, type MessageContent, type MessageContentKind, type MessageDecodeFailureEvent, type MessageDeleted, type MessageDiscardReason, type MessageDiscardedEvent, type MessageEdited, type MessageIngressStage, type MessageIngressStalledEvent, type MessageKey, type MessageMedia, type MessagePayloadKind, type MessageProtocolKind, type MessageRecoveredEvent, type MessageRecoveryFailedEvent, type MessageUnavailableEvent, type MultiAccountOptions, type MultiAppEvent, type MultiAppHealth, MultiCommandRouter, type MultiLoadCommandsResult, type MultiLoginOptions, type MuteChangeResult, type MuteEnforcement, type MuteOptions, type MuteRecord, MuteService, type MuteStore, type NumberOption, ParsedCommandOptions, type ParticipantUpdateResult, type PollContent, type PresenceState, type ProviderConnectionHealth, type ProviderCryptoHealth, type ProviderDiagnosticsOptions, type ProviderGroupHealth, type ProviderHealth, type ProviderMessagingHealth, type ProviderStabilityEvent, type ProviderTimeoutHealth, type ProviderTimeoutOptions, type QuickReplyButton, type QuotedMessage, type ReconnectOptions, type RegisteredCommand, type RemoveMuteResult, type ReplyOptions, type RepostMessageOptions, type RouterOptions, type SentMessage, SqliteMuteStore, type StabilityHealthStatus, type StickerContent, type StoredMute, type StringOption, type TextContent, type TransportDecodeFailureEvent, User, type UserData, type UserOption, type VideoContent, WhaNextApp, WhaNextError, type WhaNextErrorCode, WhaNextMultiApp, type WhatsAppProvider, create, createMulti, defineCommand, defineCommandGroup, defineCommands, defineSubcommand, guards, isCommandGroup, loadCommands, option, toWhaNextError };