@pidgeon-ai/sdk 1.59.0 → 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/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
- message: string;
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;
@@ -11423,13 +11455,13 @@ declare const agentVerify: <ThrowOnError extends boolean = false>(options: Optio
11423
11455
  /**
11424
11456
  * Read an agent card
11425
11457
  *
11426
- * Public, with no key. An agent or service address’s identity, signed by the domain that vouches for it: `jws` is a compact JWS (EdDSA) to check against the keys at `<iss>/.well-known/post.json`, and `card` is its payload, decoded for reading. Good for a day (`exp`). The URL is permanent, and every agent message names it in its signed `Agent-attribution`. Anything that has no card — a person’s address, a deleted one, an id that is nothing — answers the same 404. Limited per IP.
11458
+ * Public, with no key. An agent or service address’s identity, signed by the domain that vouches for it: `jws` is a compact JWS (EdDSA) to check against the keys at `<iss>/.well-known/post.json`, and `card` is its payload, decoded for reading. Good for a day (`exp`). The URL is permanent, and every agent message names it in its signed `Agent-attribution`. A person’s or a team’s address has one once software has sent from it as an agent. Anything that has no card — a person’s address only people send from, a deleted one, an id that is nothing — answers the same 404. Limited per IP.
11427
11459
  */
11428
11460
  declare const cardsGet: <ThrowOnError extends boolean = false>(options: Options<CardsGetData, ThrowOnError>) => RequestResult<CardsGetResponses, CardsGetErrors, ThrowOnError>;
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
  /**
@@ -11475,7 +11507,7 @@ declare const identitiesUpdate: <ThrowOnError extends boolean = false>(options:
11475
11507
  /**
11476
11508
  * This address’s agent card
11477
11509
  *
11478
- * The signed card for an agent or service address: who it is, for whom, which keys sign its mail, and a coarse standing. The same document anyone can read without a key at `GET /cards/{id}`. A person’s address has no card and answers 404.
11510
+ * The signed card for an address an agent or a service sends from: who it is, for whom, which keys sign its mail, and a coarse standing. The same document anyone can read without a key at `GET /cards/{id}`. A person’s or a team’s address has one once software has sent from it as an agent; until then it answers 404.
11479
11511
  */
11480
11512
  declare const identitiesCard: <ThrowOnError extends boolean = false>(options: Options<IdentitiesCardData, ThrowOnError>) => RequestResult<IdentitiesCardResponses, IdentitiesCardErrors, ThrowOnError>;
11481
11513
  /**
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
- message: string;
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;
@@ -11423,13 +11455,13 @@ declare const agentVerify: <ThrowOnError extends boolean = false>(options: Optio
11423
11455
  /**
11424
11456
  * Read an agent card
11425
11457
  *
11426
- * Public, with no key. An agent or service address’s identity, signed by the domain that vouches for it: `jws` is a compact JWS (EdDSA) to check against the keys at `<iss>/.well-known/post.json`, and `card` is its payload, decoded for reading. Good for a day (`exp`). The URL is permanent, and every agent message names it in its signed `Agent-attribution`. Anything that has no card — a person’s address, a deleted one, an id that is nothing — answers the same 404. Limited per IP.
11458
+ * Public, with no key. An agent or service address’s identity, signed by the domain that vouches for it: `jws` is a compact JWS (EdDSA) to check against the keys at `<iss>/.well-known/post.json`, and `card` is its payload, decoded for reading. Good for a day (`exp`). The URL is permanent, and every agent message names it in its signed `Agent-attribution`. A person’s or a team’s address has one once software has sent from it as an agent. Anything that has no card — a person’s address only people send from, a deleted one, an id that is nothing — answers the same 404. Limited per IP.
11427
11459
  */
11428
11460
  declare const cardsGet: <ThrowOnError extends boolean = false>(options: Options<CardsGetData, ThrowOnError>) => RequestResult<CardsGetResponses, CardsGetErrors, ThrowOnError>;
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
  /**
@@ -11475,7 +11507,7 @@ declare const identitiesUpdate: <ThrowOnError extends boolean = false>(options:
11475
11507
  /**
11476
11508
  * This address’s agent card
11477
11509
  *
11478
- * The signed card for an agent or service address: who it is, for whom, which keys sign its mail, and a coarse standing. The same document anyone can read without a key at `GET /cards/{id}`. A person’s address has no card and answers 404.
11510
+ * The signed card for an address an agent or a service sends from: who it is, for whom, which keys sign its mail, and a coarse standing. The same document anyone can read without a key at `GET /cards/{id}`. A person’s or a team’s address has one once software has sent from it as an agent; until then it answers 404.
11479
11511
  */
11480
11512
  declare const identitiesCard: <ThrowOnError extends boolean = false>(options: Options<IdentitiesCardData, ThrowOnError>) => RequestResult<IdentitiesCardResponses, IdentitiesCardErrors, ThrowOnError>;
11481
11513
  /**