@pidgeon-ai/sdk 1.37.0 → 1.38.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 +9 -0
- package/dist/index.d.cts +22 -2
- package/dist/index.d.ts +22 -2
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,15 @@ the two would publish a release for every unrelated product deploy.
|
|
|
7
7
|
Semver applies to **this package's own surface** — the exported names, the
|
|
8
8
|
call shapes, the result shape — not to the API behind it.
|
|
9
9
|
|
|
10
|
+
## 1.38.0 — a Gmail forward Google vouched for
|
|
11
|
+
|
|
12
|
+
`authentication` gains `arc`: `{ sealer: "google.com", dmarc: "pass" }` on a
|
|
13
|
+
message forwarded through Gmail or Workspace whose sender failed DMARC here
|
|
14
|
+
(it signs nothing, and SPF passed for Google, not for it), when Google's ARC
|
|
15
|
+
seal verified and recorded DMARC pass for the same domain as `From:`. Such a
|
|
16
|
+
message counts as authenticated for allow lists, sender rules and
|
|
17
|
+
`messagesAwait`'s `from`. Null otherwise. Additive.
|
|
18
|
+
|
|
10
19
|
## 1.37.0 — every endpoint keeps the API's promises
|
|
11
20
|
|
|
12
21
|
- **Every write takes an `Idempotency-Key` header**, not only the sends and
|
package/dist/index.d.cts
CHANGED
|
@@ -497,7 +497,7 @@ type Message = {
|
|
|
497
497
|
[key: string]: string;
|
|
498
498
|
};
|
|
499
499
|
/**
|
|
500
|
-
* What the receiving transport said about the sending domain. Null means it did not report, not that the check failed — normal on outbound, and on inbound it is the difference between unknown and forged. A `From:` is the sending domain's own word when `dmarc` or `signature` is `pass
|
|
500
|
+
* What the receiving transport said about the sending domain. Null means it did not report, not that the check failed — normal on outbound, and on inbound it is the difference between unknown and forged. A `From:` is the sending domain's own word when `dmarc` or `signature` is `pass`, or `arc` is set.
|
|
501
501
|
*/
|
|
502
502
|
authentication: {
|
|
503
503
|
spf: string | null;
|
|
@@ -507,6 +507,16 @@ type Message = {
|
|
|
507
507
|
* `pass` when the message came from another Pidgeon address directly, and its signed sender verified against the sending domain's published key. Null on mail that came through SMTP, which DMARC speaks for instead.
|
|
508
508
|
*/
|
|
509
509
|
signature: string | null;
|
|
510
|
+
/**
|
|
511
|
+
* Set when `dmarc` did not pass here, but the message was forwarded by a sealer Pidgeon trusts (Google, for a Gmail or Workspace forward), its ARC chain verified, and that sealer recorded DMARC pass for the `From:` domain. Null otherwise.
|
|
512
|
+
*/
|
|
513
|
+
arc: {
|
|
514
|
+
/**
|
|
515
|
+
* The forwarder that sealed it, such as `google.com`.
|
|
516
|
+
*/
|
|
517
|
+
sealer: string;
|
|
518
|
+
dmarc: 'pass';
|
|
519
|
+
} | null;
|
|
510
520
|
};
|
|
511
521
|
/**
|
|
512
522
|
* Who this message says it is from. A Pidgeon sender declares it on every message it sends; mail from ordinary email has only the address.
|
|
@@ -717,7 +727,7 @@ type AwaitedMessage = {
|
|
|
717
727
|
[key: string]: string;
|
|
718
728
|
};
|
|
719
729
|
/**
|
|
720
|
-
* What the receiving transport said about the sending domain. Null means it did not report, not that the check failed — normal on outbound, and on inbound it is the difference between unknown and forged. A `From:` is the sending domain's own word when `dmarc` or `signature` is `pass
|
|
730
|
+
* What the receiving transport said about the sending domain. Null means it did not report, not that the check failed — normal on outbound, and on inbound it is the difference between unknown and forged. A `From:` is the sending domain's own word when `dmarc` or `signature` is `pass`, or `arc` is set.
|
|
721
731
|
*/
|
|
722
732
|
authentication: {
|
|
723
733
|
spf: string | null;
|
|
@@ -727,6 +737,16 @@ type AwaitedMessage = {
|
|
|
727
737
|
* `pass` when the message came from another Pidgeon address directly, and its signed sender verified against the sending domain's published key. Null on mail that came through SMTP, which DMARC speaks for instead.
|
|
728
738
|
*/
|
|
729
739
|
signature: string | null;
|
|
740
|
+
/**
|
|
741
|
+
* Set when `dmarc` did not pass here, but the message was forwarded by a sealer Pidgeon trusts (Google, for a Gmail or Workspace forward), its ARC chain verified, and that sealer recorded DMARC pass for the `From:` domain. Null otherwise.
|
|
742
|
+
*/
|
|
743
|
+
arc: {
|
|
744
|
+
/**
|
|
745
|
+
* The forwarder that sealed it, such as `google.com`.
|
|
746
|
+
*/
|
|
747
|
+
sealer: string;
|
|
748
|
+
dmarc: 'pass';
|
|
749
|
+
} | null;
|
|
730
750
|
};
|
|
731
751
|
/**
|
|
732
752
|
* Who this message says it is from. A Pidgeon sender declares it on every message it sends; mail from ordinary email has only the address.
|
package/dist/index.d.ts
CHANGED
|
@@ -497,7 +497,7 @@ type Message = {
|
|
|
497
497
|
[key: string]: string;
|
|
498
498
|
};
|
|
499
499
|
/**
|
|
500
|
-
* What the receiving transport said about the sending domain. Null means it did not report, not that the check failed — normal on outbound, and on inbound it is the difference between unknown and forged. A `From:` is the sending domain's own word when `dmarc` or `signature` is `pass
|
|
500
|
+
* What the receiving transport said about the sending domain. Null means it did not report, not that the check failed — normal on outbound, and on inbound it is the difference between unknown and forged. A `From:` is the sending domain's own word when `dmarc` or `signature` is `pass`, or `arc` is set.
|
|
501
501
|
*/
|
|
502
502
|
authentication: {
|
|
503
503
|
spf: string | null;
|
|
@@ -507,6 +507,16 @@ type Message = {
|
|
|
507
507
|
* `pass` when the message came from another Pidgeon address directly, and its signed sender verified against the sending domain's published key. Null on mail that came through SMTP, which DMARC speaks for instead.
|
|
508
508
|
*/
|
|
509
509
|
signature: string | null;
|
|
510
|
+
/**
|
|
511
|
+
* Set when `dmarc` did not pass here, but the message was forwarded by a sealer Pidgeon trusts (Google, for a Gmail or Workspace forward), its ARC chain verified, and that sealer recorded DMARC pass for the `From:` domain. Null otherwise.
|
|
512
|
+
*/
|
|
513
|
+
arc: {
|
|
514
|
+
/**
|
|
515
|
+
* The forwarder that sealed it, such as `google.com`.
|
|
516
|
+
*/
|
|
517
|
+
sealer: string;
|
|
518
|
+
dmarc: 'pass';
|
|
519
|
+
} | null;
|
|
510
520
|
};
|
|
511
521
|
/**
|
|
512
522
|
* Who this message says it is from. A Pidgeon sender declares it on every message it sends; mail from ordinary email has only the address.
|
|
@@ -717,7 +727,7 @@ type AwaitedMessage = {
|
|
|
717
727
|
[key: string]: string;
|
|
718
728
|
};
|
|
719
729
|
/**
|
|
720
|
-
* What the receiving transport said about the sending domain. Null means it did not report, not that the check failed — normal on outbound, and on inbound it is the difference between unknown and forged. A `From:` is the sending domain's own word when `dmarc` or `signature` is `pass
|
|
730
|
+
* What the receiving transport said about the sending domain. Null means it did not report, not that the check failed — normal on outbound, and on inbound it is the difference between unknown and forged. A `From:` is the sending domain's own word when `dmarc` or `signature` is `pass`, or `arc` is set.
|
|
721
731
|
*/
|
|
722
732
|
authentication: {
|
|
723
733
|
spf: string | null;
|
|
@@ -727,6 +737,16 @@ type AwaitedMessage = {
|
|
|
727
737
|
* `pass` when the message came from another Pidgeon address directly, and its signed sender verified against the sending domain's published key. Null on mail that came through SMTP, which DMARC speaks for instead.
|
|
728
738
|
*/
|
|
729
739
|
signature: string | null;
|
|
740
|
+
/**
|
|
741
|
+
* Set when `dmarc` did not pass here, but the message was forwarded by a sealer Pidgeon trusts (Google, for a Gmail or Workspace forward), its ARC chain verified, and that sealer recorded DMARC pass for the `From:` domain. Null otherwise.
|
|
742
|
+
*/
|
|
743
|
+
arc: {
|
|
744
|
+
/**
|
|
745
|
+
* The forwarder that sealed it, such as `google.com`.
|
|
746
|
+
*/
|
|
747
|
+
sealer: string;
|
|
748
|
+
dmarc: 'pass';
|
|
749
|
+
} | null;
|
|
730
750
|
};
|
|
731
751
|
/**
|
|
732
752
|
* Who this message says it is from. A Pidgeon sender declares it on every message it sends; mail from ordinary email has only the address.
|