@pidgeon-ai/sdk 1.12.0 → 1.13.0

package/CHANGELOG.md

@@ -9,6 +9,16 @@ call shapes, the result shape — not to the API behind it.
 
 ## Unreleased
 
+## 1.13.0 — what the agent reads
+
+`firewall.clean_text` on every inbound message: the new text with hidden
+content and invisible characters removed, and lines posing as a chat turn
+marked, under a one-line note saying what changed. `body=clean` on
+`GET /messages/{id}` and `GET /messages/await` returns it as `text` and
+`reply_text`, with `html` and `reply_html` empty. The default is still
+`original`. The MCP server and the AI SDK ask for `clean` unless told
+otherwise.
+
 ## 1.12.0 — Pidgeon Firewall
 
 Every inbound `Message` carries `firewall`: a `verdict` (`clean` or

package/dist/index.d.cts

@@ -547,6 +547,10 @@ type Message = {
             detail: string;
             where: 'subject' | 'text' | 'html' | 'from' | 'quoted';
         }>;
+        /**
+         * What an agent should read: the new text with hidden content and invisible characters removed and lines posing as a chat turn marked, under a one-line note saying what changed. The new text unchanged when nothing needed it. Ask for `body=clean` to get it in place of the body.
+         */
+        clean_text: string;
         /**
          * Bumped when the rules change in a way that could change a verdict.
          */
@@ -724,6 +728,10 @@ type AwaitedMessage = {
                 detail: string;
                 where: 'subject' | 'text' | 'html' | 'from' | 'quoted';
             }>;
+            /**
+             * What an agent should read: the new text with hidden content and invisible characters removed and lines posing as a chat turn marked, under a one-line note saying what changed. The new text unchanged when nothing needed it. Ask for `body=clean` to get it in place of the body.
+             */
+            clean_text: string;
             /**
              * Bumped when the rules change in a way that could change a verdict.
              */
@@ -2926,6 +2934,7 @@ type MessagesAwaitData = {
     path?: never;
     query: {
         identity_id: string;
+        body?: 'original' | 'clean';
         from?: string;
         subject_contains?: string;
         has_code?: 'true' | 'false';
@@ -2963,7 +2972,9 @@ type MessagesGetData = {
     path: {
         id: string;
     };
-    query?: never;
+    query?: {
+        body?: 'original' | 'clean';
+    };
     url: '/messages/{id}';
 };
 type MessagesGetErrors = {

package/dist/index.d.ts

@@ -547,6 +547,10 @@ type Message = {
             detail: string;
             where: 'subject' | 'text' | 'html' | 'from' | 'quoted';
         }>;
+        /**
+         * What an agent should read: the new text with hidden content and invisible characters removed and lines posing as a chat turn marked, under a one-line note saying what changed. The new text unchanged when nothing needed it. Ask for `body=clean` to get it in place of the body.
+         */
+        clean_text: string;
         /**
          * Bumped when the rules change in a way that could change a verdict.
          */
@@ -724,6 +728,10 @@ type AwaitedMessage = {
                 detail: string;
                 where: 'subject' | 'text' | 'html' | 'from' | 'quoted';
             }>;
+            /**
+             * What an agent should read: the new text with hidden content and invisible characters removed and lines posing as a chat turn marked, under a one-line note saying what changed. The new text unchanged when nothing needed it. Ask for `body=clean` to get it in place of the body.
+             */
+            clean_text: string;
             /**
              * Bumped when the rules change in a way that could change a verdict.
              */
@@ -2926,6 +2934,7 @@ type MessagesAwaitData = {
     path?: never;
     query: {
         identity_id: string;
+        body?: 'original' | 'clean';
         from?: string;
         subject_contains?: string;
         has_code?: 'true' | 'false';
@@ -2963,7 +2972,9 @@ type MessagesGetData = {
     path: {
         id: string;
     };
-    query?: never;
+    query?: {
+        body?: 'original' | 'clean';
+    };
     url: '/messages/{id}';
 };
 type MessagesGetErrors = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pidgeon-ai/sdk",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "Thin TypeScript client for the Pidgeon email API.",
   "keywords": [
     "pidgeon",