@pidgeon-ai/sdk 1.59.1 → 1.60.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +34 -2
- package/dist/index.d.ts +34 -2
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -570,6 +570,15 @@ type SenderVerification = {
|
|
|
570
570
|
kid: string | null;
|
|
571
571
|
reason: string | null;
|
|
572
572
|
};
|
|
573
|
+
/**
|
|
574
|
+
* An HTTP request’s signature (RFC 9421, Web Bot Auth), when `request` was sent. `none` for a message.
|
|
575
|
+
*/
|
|
576
|
+
request: {
|
|
577
|
+
result: 'pass' | 'fail' | 'unverifiable' | 'none';
|
|
578
|
+
domain: string | null;
|
|
579
|
+
keyid: string | null;
|
|
580
|
+
reason: string | null;
|
|
581
|
+
};
|
|
573
582
|
};
|
|
574
583
|
/**
|
|
575
584
|
* The sender’s agent card, when we issue it.
|
|
@@ -3085,7 +3094,30 @@ type CardsGetResponses = {
|
|
|
3085
3094
|
type CardsGetResponse = CardsGetResponses[keyof CardsGetResponses];
|
|
3086
3095
|
type VerifySenderData = {
|
|
3087
3096
|
body: {
|
|
3088
|
-
|
|
3097
|
+
/**
|
|
3098
|
+
* The raw message, or its headers. Send this or `request`.
|
|
3099
|
+
*/
|
|
3100
|
+
message?: string;
|
|
3101
|
+
/**
|
|
3102
|
+
* An HTTP request an agent signed (HTTP Message Signatures, Web Bot Auth), as received. Send this or `message`.
|
|
3103
|
+
*/
|
|
3104
|
+
request?: {
|
|
3105
|
+
method: string;
|
|
3106
|
+
/**
|
|
3107
|
+
* The URL the request was sent to.
|
|
3108
|
+
*/
|
|
3109
|
+
url: string;
|
|
3110
|
+
/**
|
|
3111
|
+
* The request’s headers as received, `Signature-Input` and `Signature` among them.
|
|
3112
|
+
*/
|
|
3113
|
+
headers: {
|
|
3114
|
+
[key: string]: string;
|
|
3115
|
+
};
|
|
3116
|
+
/**
|
|
3117
|
+
* The body as UTF-8, to check against a covered `Content-Digest`.
|
|
3118
|
+
*/
|
|
3119
|
+
body?: string;
|
|
3120
|
+
};
|
|
3089
3121
|
recipient?: string;
|
|
3090
3122
|
};
|
|
3091
3123
|
path?: never;
|
|
@@ -11429,7 +11461,7 @@ declare const cardsGet: <ThrowOnError extends boolean = false>(options: Options<
|
|
|
11429
11461
|
/**
|
|
11430
11462
|
* Check who sent a message
|
|
11431
11463
|
*
|
|
11432
|
-
* Public, with no key. Send a raw message, or its headers alone; the answer says whether an AI agent sent it, on whose behalf, and whether its signatures hold — the signed agent declaration (`Agent-of` under an aligned DKIM signature) and the `Post-Envelope` — for Pidgeon’s mail and any other signer using the same formats. Act on `verdict`. Pass `recipient`, the address it reached you at, to catch a signed message replayed to you. Nothing sent is stored. Limited per IP; a key may be sent and is not required.
|
|
11464
|
+
* Public, with no key. Send a raw message, or its headers alone; the answer says whether an AI agent sent it, on whose behalf, and whether its signatures hold — the signed agent declaration (`Agent-of` under an aligned DKIM signature) and the `Post-Envelope` — for Pidgeon’s mail and any other signer using the same formats. Act on `verdict`. Pass `recipient`, the address it reached you at, to catch a signed message replayed to you. Or send `request` instead of `message`: an HTTP request an agent signed with HTTP Message Signatures (RFC 9421) in Web Bot Auth’s profile, which is also how an MCP call over HTTP is signed; the key is found by its `keyid` among domains proved with `pidgeon id`, or in the directory its `Signature-Agent` names. Nothing sent is stored. Limited per IP; a key may be sent and is not required.
|
|
11433
11465
|
*/
|
|
11434
11466
|
declare const verifySender: <ThrowOnError extends boolean = false>(options: Options<VerifySenderData, ThrowOnError>) => RequestResult<VerifySenderResponses, VerifySenderErrors, ThrowOnError>;
|
|
11435
11467
|
/**
|
package/dist/index.d.ts
CHANGED
|
@@ -570,6 +570,15 @@ type SenderVerification = {
|
|
|
570
570
|
kid: string | null;
|
|
571
571
|
reason: string | null;
|
|
572
572
|
};
|
|
573
|
+
/**
|
|
574
|
+
* An HTTP request’s signature (RFC 9421, Web Bot Auth), when `request` was sent. `none` for a message.
|
|
575
|
+
*/
|
|
576
|
+
request: {
|
|
577
|
+
result: 'pass' | 'fail' | 'unverifiable' | 'none';
|
|
578
|
+
domain: string | null;
|
|
579
|
+
keyid: string | null;
|
|
580
|
+
reason: string | null;
|
|
581
|
+
};
|
|
573
582
|
};
|
|
574
583
|
/**
|
|
575
584
|
* The sender’s agent card, when we issue it.
|
|
@@ -3085,7 +3094,30 @@ type CardsGetResponses = {
|
|
|
3085
3094
|
type CardsGetResponse = CardsGetResponses[keyof CardsGetResponses];
|
|
3086
3095
|
type VerifySenderData = {
|
|
3087
3096
|
body: {
|
|
3088
|
-
|
|
3097
|
+
/**
|
|
3098
|
+
* The raw message, or its headers. Send this or `request`.
|
|
3099
|
+
*/
|
|
3100
|
+
message?: string;
|
|
3101
|
+
/**
|
|
3102
|
+
* An HTTP request an agent signed (HTTP Message Signatures, Web Bot Auth), as received. Send this or `message`.
|
|
3103
|
+
*/
|
|
3104
|
+
request?: {
|
|
3105
|
+
method: string;
|
|
3106
|
+
/**
|
|
3107
|
+
* The URL the request was sent to.
|
|
3108
|
+
*/
|
|
3109
|
+
url: string;
|
|
3110
|
+
/**
|
|
3111
|
+
* The request’s headers as received, `Signature-Input` and `Signature` among them.
|
|
3112
|
+
*/
|
|
3113
|
+
headers: {
|
|
3114
|
+
[key: string]: string;
|
|
3115
|
+
};
|
|
3116
|
+
/**
|
|
3117
|
+
* The body as UTF-8, to check against a covered `Content-Digest`.
|
|
3118
|
+
*/
|
|
3119
|
+
body?: string;
|
|
3120
|
+
};
|
|
3089
3121
|
recipient?: string;
|
|
3090
3122
|
};
|
|
3091
3123
|
path?: never;
|
|
@@ -11429,7 +11461,7 @@ declare const cardsGet: <ThrowOnError extends boolean = false>(options: Options<
|
|
|
11429
11461
|
/**
|
|
11430
11462
|
* Check who sent a message
|
|
11431
11463
|
*
|
|
11432
|
-
* Public, with no key. Send a raw message, or its headers alone; the answer says whether an AI agent sent it, on whose behalf, and whether its signatures hold — the signed agent declaration (`Agent-of` under an aligned DKIM signature) and the `Post-Envelope` — for Pidgeon’s mail and any other signer using the same formats. Act on `verdict`. Pass `recipient`, the address it reached you at, to catch a signed message replayed to you. Nothing sent is stored. Limited per IP; a key may be sent and is not required.
|
|
11464
|
+
* Public, with no key. Send a raw message, or its headers alone; the answer says whether an AI agent sent it, on whose behalf, and whether its signatures hold — the signed agent declaration (`Agent-of` under an aligned DKIM signature) and the `Post-Envelope` — for Pidgeon’s mail and any other signer using the same formats. Act on `verdict`. Pass `recipient`, the address it reached you at, to catch a signed message replayed to you. Or send `request` instead of `message`: an HTTP request an agent signed with HTTP Message Signatures (RFC 9421) in Web Bot Auth’s profile, which is also how an MCP call over HTTP is signed; the key is found by its `keyid` among domains proved with `pidgeon id`, or in the directory its `Signature-Agent` names. Nothing sent is stored. Limited per IP; a key may be sent and is not required.
|
|
11433
11465
|
*/
|
|
11434
11466
|
declare const verifySender: <ThrowOnError extends boolean = false>(options: Options<VerifySenderData, ThrowOnError>) => RequestResult<VerifySenderResponses, VerifySenderErrors, ThrowOnError>;
|
|
11435
11467
|
/**
|