@upyo/smtp 0.6.0-dev.311 → 0.6.0-dev.314

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
@@ -79,12 +79,24 @@ interface DkimSignature {
79
79
  * @since 0.4.0
80
80
  */
81
81
  type DkimSigningFailureAction = "throw" | "send-unsigned";
82
+ /**
83
+ * Whether signing buffers the MIME body once or reads replayable sources twice.
84
+ * @since 0.6.0
85
+ */
86
+ type DkimBodyMode = "buffered" | "streaming";
82
87
  /**
83
88
  * Configuration for DKIM signing in SMTP transport.
84
89
  *
85
90
  * @since 0.4.0
86
91
  */
87
92
  interface DkimConfig {
93
+ /**
94
+ * Body processing strategy. Streaming uses bounded attachment memory but
95
+ * requires a second source read; buffered reads once and retains all MIME.
96
+ * @default "buffered"
97
+ * @since 0.6.0
98
+ */
99
+ readonly bodyMode?: DkimBodyMode;
88
100
  /**
89
101
  * Array of DKIM signature configurations.
90
102
  * Each configuration will result in one DKIM-Signature header.
@@ -97,9 +109,9 @@ interface DkimConfig {
97
109
  readonly onSigningFailure?: DkimSigningFailureAction;
98
110
  }
99
111
  /**
100
- * Result of DKIM signing operation.
101
- *
102
- * @since 0.4.0
112
+ * Validates the runtime body-mode option without changing config identity.
113
+ * @param config Optional signing configuration.
114
+ * @throws {TypeError} If the body mode is unsupported.
103
115
  */
104
116
  //#endregion
105
117
  //#region src/config.d.ts
@@ -850,6 +862,17 @@ declare class SmtpAuthError extends Error {
850
862
  * @returns The Base64-encoded XOAUTH2 initial client response.
851
863
  * @since 0.5.0
852
864
  */
865
+ //#endregion
866
+ //#region src/message-stream.d.ts
867
+ /**
868
+ * A replayable attachment changed between DKIM body reads.
869
+ * @since 0.6.0
870
+ */
871
+ declare class SmtpAttachmentReplayError extends TypeError {
872
+ /** Creates a replay validation failure. */
873
+ constructor();
874
+ }
875
+ /** The final bytes and known size of an SMTP DATA transaction. */
853
876
 
854
877
  //#endregion
855
- export { DkimAlgorithm, DkimCanonicalization, DkimConfig, DkimSignature, DkimSigningFailureAction, OAuth2TokenProvider, SmtpAuth, SmtpAuthError, SmtpConfig, SmtpDsnNotification, SmtpDsnOptions, SmtpDsnRecipientOptions, SmtpDsnUnsupportedError, SmtpDsnValidationError, SmtpEnhancedStatusCode, SmtpEnvelopeOptions, SmtpEnvelopeResolver, SmtpEnvelopeValidationError, SmtpMessageSizeProviderDetails, SmtpOAuth2Auth, SmtpOAuth2RefreshAuth, SmtpOAuth2TokenAuth, SmtpProviderDetails, SmtpReceipt, SmtpRejectedRecipient, SmtpResponseProviderDetails, SmtpTlsOptions, SmtpTransport, SmtpTransportOptions, SmtpUserPassAuth, SmtpUtf8ProviderDetails, isSmtpResponseProviderDetails };
878
+ export { DkimAlgorithm, DkimBodyMode, DkimCanonicalization, DkimConfig, DkimSignature, DkimSigningFailureAction, OAuth2TokenProvider, SmtpAttachmentReplayError, SmtpAuth, SmtpAuthError, SmtpConfig, SmtpDsnNotification, SmtpDsnOptions, SmtpDsnRecipientOptions, SmtpDsnUnsupportedError, SmtpDsnValidationError, SmtpEnhancedStatusCode, SmtpEnvelopeOptions, SmtpEnvelopeResolver, SmtpEnvelopeValidationError, SmtpMessageSizeProviderDetails, SmtpOAuth2Auth, SmtpOAuth2RefreshAuth, SmtpOAuth2TokenAuth, SmtpProviderDetails, SmtpReceipt, SmtpRejectedRecipient, SmtpResponseProviderDetails, SmtpTlsOptions, SmtpTransport, SmtpTransportOptions, SmtpUserPassAuth, SmtpUtf8ProviderDetails, isSmtpResponseProviderDetails };
package/dist/index.d.ts CHANGED
@@ -79,12 +79,24 @@ interface DkimSignature {
79
79
  * @since 0.4.0
80
80
  */
81
81
  type DkimSigningFailureAction = "throw" | "send-unsigned";
82
+ /**
83
+ * Whether signing buffers the MIME body once or reads replayable sources twice.
84
+ * @since 0.6.0
85
+ */
86
+ type DkimBodyMode = "buffered" | "streaming";
82
87
  /**
83
88
  * Configuration for DKIM signing in SMTP transport.
84
89
  *
85
90
  * @since 0.4.0
86
91
  */
87
92
  interface DkimConfig {
93
+ /**
94
+ * Body processing strategy. Streaming uses bounded attachment memory but
95
+ * requires a second source read; buffered reads once and retains all MIME.
96
+ * @default "buffered"
97
+ * @since 0.6.0
98
+ */
99
+ readonly bodyMode?: DkimBodyMode;
88
100
  /**
89
101
  * Array of DKIM signature configurations.
90
102
  * Each configuration will result in one DKIM-Signature header.
@@ -97,9 +109,9 @@ interface DkimConfig {
97
109
  readonly onSigningFailure?: DkimSigningFailureAction;
98
110
  }
99
111
  /**
100
- * Result of DKIM signing operation.
101
- *
102
- * @since 0.4.0
112
+ * Validates the runtime body-mode option without changing config identity.
113
+ * @param config Optional signing configuration.
114
+ * @throws {TypeError} If the body mode is unsupported.
103
115
  */
104
116
  //#endregion
105
117
  //#region src/config.d.ts
@@ -850,6 +862,17 @@ declare class SmtpAuthError extends Error {
850
862
  * @returns The Base64-encoded XOAUTH2 initial client response.
851
863
  * @since 0.5.0
852
864
  */
865
+ //#endregion
866
+ //#region src/message-stream.d.ts
867
+ /**
868
+ * A replayable attachment changed between DKIM body reads.
869
+ * @since 0.6.0
870
+ */
871
+ declare class SmtpAttachmentReplayError extends TypeError {
872
+ /** Creates a replay validation failure. */
873
+ constructor();
874
+ }
875
+ /** The final bytes and known size of an SMTP DATA transaction. */
853
876
 
854
877
  //#endregion
855
- export { DkimAlgorithm, DkimCanonicalization, DkimConfig, DkimSignature, DkimSigningFailureAction, OAuth2TokenProvider, SmtpAuth, SmtpAuthError, SmtpConfig, SmtpDsnNotification, SmtpDsnOptions, SmtpDsnRecipientOptions, SmtpDsnUnsupportedError, SmtpDsnValidationError, SmtpEnhancedStatusCode, SmtpEnvelopeOptions, SmtpEnvelopeResolver, SmtpEnvelopeValidationError, SmtpMessageSizeProviderDetails, SmtpOAuth2Auth, SmtpOAuth2RefreshAuth, SmtpOAuth2TokenAuth, SmtpProviderDetails, SmtpReceipt, SmtpRejectedRecipient, SmtpResponseProviderDetails, SmtpTlsOptions, SmtpTransport, SmtpTransportOptions, SmtpUserPassAuth, SmtpUtf8ProviderDetails, isSmtpResponseProviderDetails };
878
+ export { DkimAlgorithm, DkimBodyMode, DkimCanonicalization, DkimConfig, DkimSignature, DkimSigningFailureAction, OAuth2TokenProvider, SmtpAttachmentReplayError, SmtpAuth, SmtpAuthError, SmtpConfig, SmtpDsnNotification, SmtpDsnOptions, SmtpDsnRecipientOptions, SmtpDsnUnsupportedError, SmtpDsnValidationError, SmtpEnhancedStatusCode, SmtpEnvelopeOptions, SmtpEnvelopeResolver, SmtpEnvelopeValidationError, SmtpMessageSizeProviderDetails, SmtpOAuth2Auth, SmtpOAuth2RefreshAuth, SmtpOAuth2TokenAuth, SmtpProviderDetails, SmtpReceipt, SmtpRejectedRecipient, SmtpResponseProviderDetails, SmtpTlsOptions, SmtpTransport, SmtpTransportOptions, SmtpUserPassAuth, SmtpUtf8ProviderDetails, isSmtpResponseProviderDetails };