Free, Open Source, Self-Hosted WhatsApp API Gateway
TypeScript apibotgatewayself-hostedwhatsappwhatsapp-apiwhatsapp-automationwhatsapp-botwhatsapp-gatewaywhatsapp-gateway-apiwhatsapp-webwhatsapp-web-api
docs(changelog): align unreleased entries with the final behavior
Yudhi Armyndharisd2e70a7b2cbe
diff --git a/CHANGELOG.md b/CHANGELOG.mdindex 12101ffd3..1d40d7d7a 100644--- a/CHANGELOG.md+++ b/CHANGELOG.md@@ -42,7 +42,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0- Refuse a `muteUntil` above 9007199254740991 on `POST /api/sessions/{id}/chats/mute` with 400; larger values are not exact integers and wrapped the Baileys int64.- Mark the fields the gateway always sends as required in the JavaScript, Python and Go SDK response types and drop the `null` it never sends; Python `ParticipantsResult` no longer extends `SuccessResult`, from the next SDK release after 0.6.0.- Keep the dashboard chat unread state in step with the tab: the open chat is not marked read while the browser tab is hidden (the read is sent when it is visible again), and on Baileys an opened chat acknowledges all its loaded unread incoming messages, not only the newest.-- Show the saved Use Built-in mode of the Infrastructure page after a reload, with a pending-restart note per card, so settings typed while a bundled/external switch awaits a restart are no longer discarded on save.+- Add `builtInSet` per section to `GET /api/infra/config` and show the saved Use Built-in mode on the Infrastructure page after a reload (what runs when nothing is saved or a pinned host decides), with a pending-restart note per card, so settings typed while a bundled/external switch awaits a restart are no longer discarded on save.### Fixed@@ -93,21 +93,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0- Remove the secrets of a wildcard integration instance from the plugin config when the instance is deleted, disabled, moved to one session or saved without them, where they stayed in use.- Answer 400 instead of 500 on PostgreSQL for a `GET /api/search` `dateFrom` or `dateTo` outside the safe integer range, and publish that range in the schema.- Answer an empty page instead of 500 for a list `offset` of 2^63 or more on the audit, session, webhook, delivery failure and message lists.-- Stop a Redis that stops answering or answers slowly from making the WebSocket publish client hold every event in memory: events a node raises while its Redis connection is down (a restart, a failover, an outage, or a silence over 10 s), plus its reconnect backoff of up to 5 s, are dropped for clients on other replicas instead of replayed late, those written to the dropped connection in its first 10 s may be lost or arrive late and after newer ones, and a slow Redis is held to 12,000 unanswered events.+- Stop a Redis that stops answering or answers slowly from making the WebSocket publish client hold every event in memory: events a node raises while its Redis connection is down (a restart, a failover, an outage, or a silence over 10 s), plus its reconnect backoff of up to 5 s, are dropped for clients on other replicas instead of replayed late; those written to the dropped connection in the first 10 s of a longer silence may be lost or arrive late and after newer ones, and a slow Redis is held to about 12,000 unanswered events plus roughly 2 s of traffic.- Count in `GET /api/infra/storage/files/count` only the keys the export carries, leaving out S3 folder placeholders and unsafe keys.- Fall back to the 5000 ms default for a negative `SIMULATE_TYPING_MAX_MS`, which cut the typing pause to about 1 ms.- Never fail a log call on metadata that holds a circular reference, a BigInt or a throwing getter, and redact secret-named keys at any depth instead of the first five levels, including on an object with its own `toJSON`; an array of 1000 or more entries, or a typed array or object over the node budget, below the fifth level is written as `[Truncated]`.- Redact credentials at any depth in the Baileys wire log (`BAILEYS_LOG_LEVEL`) and copy nested errors before they are written.-- Relay the log metadata of a sandboxed plugin without blocking the host: metadata over 8192 values is replaced by the size marker at once, and `ctx.logger.error` without an error no longer writes the trace `undefined`.+- Leave functions out of log lines (a function with its own `toJSON` could be written), and write a plugin log call with a string, array, boxed string, typed array, Map, Date, Error or class instance as meta as one `meta` field instead of one field per character or index.+- Relay the log metadata of a sandboxed plugin without blocking the host: metadata over 8192 values and characters (a value counts as one, a string or typed array by its length, a property name by its length) is replaced by the size marker at once, a non-string message becomes `[non-string log message]`, and `ctx.logger.error` without an error no longer writes the trace `undefined`.- Apply a delete for everyone, an edit or a reaction that reaches a whatsapp-web.js message on SQLite while its contact or media is still being fetched, instead of hooking, storing and announcing the message with its deleted or unedited content.- Store a Baileys reaction to a message that is still downloading its media with the message on SQLite, as on PostgreSQL, and announce it and an edit of the same window once the gateway has the message.- Keep Baileys chat pin, mute and archive state from reverting, or coming back for a deleted or unlinked chat, or reading as defaults for a lid-addressed contact, when a restore, a session start or a chat-list read overlaps a change.- Refuse a chat id that is not in the form `localpart@host` in the MCP tools `SessionSubscribePresence`, `SessionMarkChatRead` and `SessionMarkChatUnread`, as their REST routes do.- Send the method of a raw `client.Do` (Go) or `client.request` (JavaScript) call in upper case, so a lowercase verb no longer reaches the gateway as `patch` and answers 400, from the next SDK release after 0.6.0.-- Refuse every spelling of `/` (`//`, `/.`, a link to `/`) as the data directory in `scripts/restore.sh`, where its safety snapshot copied the filesystem into itself.+- Refuse every spelling of `/` (`//`, `/.`, `/..`, a link to `/`, `<link to />/..`) for `OPENWA_DATA_DIR`, the state directories, `MAIN_DATABASE_NAME`, `DATABASE_NAME` and `BOOTSTRAP_KEY_FILE` in `scripts/restore.sh`, and resolve `..` after a symlink as the kernel does; run as root, its safety snapshot could copy the filesystem into itself.+- Describe the 400 of `POST /api/sessions/{id}/messages/react` and `/delete` as `Session not active or invalid request` in the OpenAPI schema; a missing message answers 404.- Fix the Infrastructure page reverting a database, Redis, queue or storage switch that was saved and awaits a restart (and deleting its stored credentials) on the next save, saving with the PostgreSQL pool size emptied, and a plugin config whose secret field declares a pattern.- Stop the Webhooks and Templates pages from sending operator-only reads as a viewer key, and the Sessions and Plugins pages from reading "No sessions found" / "No plugins installed" under the error banner when the first list read failed.- Keep the dashboard chat thread where the reader is: reopen a chat left at the bottom at its newest message, keep a saved position while images decode, scroll to new messages the account sent elsewhere, and key the saved position by session and chat.+- Keep keyboard focus on the Copy button after a copy where the Clipboard API is missing (plain HTTP), on the API keys, webhooks, templates and plugin pages.- Fix the dashboard layout on phones, short and half-screen windows: the Sessions and Dashboard tables, login screen, API key names, install dialog header, webhook filter rows and popover, Infrastructure, Plugins and Templates columns, the Plugins rail, the navigation drawer edge and the language menu.- Make the dashboard usable by keyboard and in more languages: Infrastructure choices and toggles reachable with visible focus, the close icon and select arrow shown, one main landmark per page, readable error and button text contrast, reduced motion honoured, and mirrored layout and icons under Arabic and Hebrew.- Stop the Message Tester multi-group send when the session is not running or the gateway cannot be reached, and read phone numbers typed in native digits in the Message Tester, bulk list, webhook filter and pairing field.