@pidgeon-ai/sdk 1.19.2 → 1.22.0

package/CHANGELOG.md

@@ -7,6 +7,52 @@ the two would publish a release for every unrelated product deploy.
 Semver applies to **this package's own surface** — the exported names, the
 call shapes, the result shape — not to the API behind it.
 
+## 1.22.0 — typed data, and the declared sender
+
+Every send — `messagesSend`, `messagesReply`, `messagesReplyAll`,
+`messagesForward`, and `draftsCreate` and `draftsUpdate` for a draft sent or
+scheduled later — takes an optional `data: { schema, body }`: `schema` is an
+http or https URL naming what `body` is, and `body` is up to 64 KB of JSON.
+It travels as its own part beside the text, which ordinary mail clients do
+not show, and comes back as `data` on the message, on a Pidgeon recipient's
+copy and on any received mail that carries one. It is never mixed into
+`text`, and the Firewall does not read it as prose.
+
+Every message has `sender: { address, kind, on_behalf_of }`. A message sent
+from Pidgeon declares `kind` (`person`, `agent` or `service`, from the
+address's type) and `on_behalf_of` (the workspace's name, which only an owner
+can change). Mail that arrived as ordinary email declared neither, and
+says `origin: "smtp"`; `authentication` is what is known about it.
+`message.sent` carries `sender` too. Additive; nothing narrows.
+
+## 1.21.0 — every send takes a key, and receipts
+
+`Idempotency-Key` is a declared header on every operation that honours it,
+so each takes `headers: { 'Idempotency-Key': … }` typed rather than as a
+raw header. It is honoured now on every send: `messagesReply`,
+`messagesReplyAll`, `messagesForward`, `draftsSend`, `draftsSchedule`,
+`calendarCreateEvent`, `calendarUpdateEvent`, `calendarDeleteEvent`,
+`calendarRespondToEvent` and `messagesRespondToInvitation`, beside
+`messagesSend` and the creates that had it. The same key with the same
+request returns the first answer and sends nothing; with a different
+request, `409`. Reuse one key across your own retries of one send.
+
+Two event types, both receipts from a Pidgeon address you wrote to:
+`message.read` (its agent read the message through the API, the first
+time — only from an address with the new `readReceipts` capability, off by
+default) and `message.handed_off` (it handed the conversation to a person).
+Each carries `message_id`, `recipient`, `kind` and `at`, and is
+subscribable like any other. Additive; nothing narrows.
+
+## 1.20.0 — a wait looks back before it waits
+
+`messagesAwait` with no `after` returns the newest matching message from
+the last two minutes before it starts waiting. An agent submits a form and
+then asks for the code, and a fast sender's code was already there: the
+wait started at "now" and timed out on it. `after` also takes `"now"`, the
+old start. A caller that looped without passing `cursor` back may now see a
+message twice; pass the cursor, as before.
+
 ## 1.19.2 — what `/raw` answers
 
 The description of `GET /messages/{id}/raw` said it 404s once the original