🤖 Merge PR DefinitelyTyped#74249 [nodemailer] Remove AWS SDK from dependencies, use structural types by @benjaminpjones

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>

Author: benjaminpjones

types/nodemailer/lib/ses-transport/index.d.ts

@@ -1,6 +1,5 @@
 /// <reference types="node" />
 
-import * as aws from "@aws-sdk/client-sesv2";
 import { EventEmitter } from "node:events";
 
 import { Transport, TransportOptions } from "../..";
@@ -12,25 +11,66 @@ import MailMessage = require("../mailer/mail-message");
 import MimeNode = require("../mime-node");
 
 declare namespace SESTransport {
+    /**
+     * Minimal structural shape of SESv2 SendEmail input.
+     * This is intentionally structural so @types/nodemailer does not require
+     * installing @aws-sdk/client-sesv2.
+     *
+     * If you want the full, exact type, install @aws-sdk/client-sesv2 in your
+     * app and use its types directly in your own code.
+     */
+    interface SendEmailRequestLike {
+        FromEmailAddress?: string;
+        Destination?: {
+            ToAddresses?: string[];
+            CcAddresses?: string[];
+            BccAddresses?: string[];
+        };
+        ReplyToAddresses?: string[];
+        Content?: unknown;
+        EmailTags?: Array<{ Name?: string; Value?: string }>;
+        ConfigurationSetName?: string;
+        ListManagementOptions?: unknown;
+        FeedbackForwardingEmailAddress?: string;
+        // Allow extra fields without forcing the SDK type package
+        [key: string]: unknown;
+    }
+
+    /** Structural type matching SESv2Client from @aws-sdk/client-sesv2 */
+    interface SESv2ClientLike {
+        send(command: unknown, options?: unknown): Promise<{ MessageId?: string }>;
+        config?: {
+            region?: string | (() => Promise<string>);
+        };
+    }
+
+    /**
+     * Constructor type for SendEmailCommand from @aws-sdk/client-sesv2.
+     * The real type is: new(input: SendEmailCommandInput) => SendEmailCommand
+     * Contravariance prevents typing this more strictly without pulling in aws-sdk as a dependency.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    type SendEmailCommandConstructorLike = new(input: any) => unknown;
+
     interface MailOptions extends Mail.Options {
-        /** list of keys that SendRawEmail method can take */
+        /** Options passed to AWS SESv2 SendEmailCommand */
         ses?: MailSesOptions | undefined;
     }
 
     // Keep it as an interface for backward-compatibility
     // eslint-disable-next-line @typescript-eslint/no-empty-interface
-    interface MailSesOptions extends Partial<aws.SendEmailRequest> {}
+    interface MailSesOptions extends Partial<SendEmailRequestLike> {}
 
     interface Options extends MailOptions, TransportOptions {
-        /** is an option that expects an instantiated aws.SES object */
+        /** An object containing an instantiated SESv2Client and the SendEmailCommand class */
         SES: {
-            sesClient: aws.SESv2Client;
-            SendEmailCommand: typeof aws.SendEmailCommand;
+            sesClient: SESv2ClientLike;
+            SendEmailCommand: SendEmailCommandConstructorLike;
         };
     }
 
     interface SentMessageInfo {
-        /** an envelope object {from:‘address’, to:[‘address’]} */
+        /** an envelope object {from:'address', to:['address']} */
         envelope: MimeNode.Envelope;
         /** the Message-ID header value. This value is derived from the response of SES API, so it differs from the Message-ID values used in logging. */
         messageId: string;

types/nodemailer/package.json

@@ -7,10 +7,10 @@
         "https://nodemailer.com"
     ],
     "dependencies": {
-        "@aws-sdk/client-sesv2": "^3.839.0",
         "@types/node": "*"
     },
     "devDependencies": {
+        "@aws-sdk/client-sesv2": "^3.839.0",
         "@types/nodemailer": "workspace:."
     },
     "owners": [

types/nodemailer/v6/lib/ses-transport/index.d.ts

@@ -1,6 +1,5 @@
 /// <reference types="node" />
 
-import * as aws from "@aws-sdk/client-ses";
 import { EventEmitter } from "node:events";
 
 import { Transport, TransportOptions } from "../..";
@@ -10,31 +9,74 @@ import MailMessage = require("../mailer/mail-message");
 import MimeNode = require("../mime-node");
 
 declare namespace SESTransport {
+    /**
+     * Minimal structural shape of SES SendEmail input.
+     * This is intentionally structural so @types/nodemailer does not require
+     * installing @aws-sdk/client-ses.
+     *
+     * If you want the full, exact type, install @aws-sdk/client-ses in your
+     * app and use its types directly in your own code.
+     */
+    interface SendEmailRequestLike {
+        Source?: string;
+        Destination?: {
+            ToAddresses?: string[];
+            CcAddresses?: string[];
+            BccAddresses?: string[];
+        };
+        Message?: unknown;
+        ReplyToAddresses?: string[];
+        ReturnPath?: string;
+        SourceArn?: string;
+        ReturnPathArn?: string;
+        Tags?: Array<{ Name?: string; Value?: string }>;
+        ConfigurationSetName?: string;
+        // Allow extra fields without forcing the SDK type package
+        [key: string]: unknown;
+    }
+
+    /** Structural type matching SES client from @aws-sdk/client-ses */
+    interface SESClientLike {
+        /** Used with v3 low-level client + SendRawEmailCommand */
+        send?(command: unknown): Promise<{ MessageId?: string }>;
+        /** Used with v3 high-level SES class or v2 SDK */
+        sendRawEmail?(params: unknown, options?: unknown): Promise<{ MessageId?: string }>;
+        config?: {
+            region?: string | (() => Promise<string>);
+        };
+    }
+
+    /** Structural type matching the aws module shape */
+    interface AwsModuleLike {
+        SendRawEmailCommand?: unknown;
+        [key: string]: unknown;
+    }
+
     interface MailOptions extends Mail.Options {
         /** list of keys that SendRawEmail method can take */
         ses?: MailSesOptions | undefined;
     }
 
     // Keep it as an interface for backward-compatibility
     // eslint-disable-next-line @typescript-eslint/no-empty-interface
-    interface MailSesOptions extends Partial<aws.SendEmailRequest> {}
+    interface MailSesOptions extends Partial<SendEmailRequestLike> {}
 
     interface Options extends MailOptions, TransportOptions {
         /** An option that expects an instantiated aws.SES object */
         SES:
             | {
-                ses: aws.SES;
-                aws: typeof aws;
+                ses: SESClientLike;
+                aws: AwsModuleLike;
             }
-            | aws.SES;
+            | SESClientLike;
         /** How many messages per second is allowed to be delivered to SES */
         maxConnections?: number | undefined;
         /** How many parallel connections to allow towards SES */
         sendingRate?: number | undefined;
     }
 
     interface SentMessageInfo {
-        /** an envelope object {from:‘address’, to:[‘address’]} */
+        /** an envelope object {from:'address', to:['address']} */
         envelope: MimeNode.Envelope;
         /** the Message-ID header value. This value is derived from the response of SES API, so it differs from the Message-ID values used in logging. */
         messageId: string;

types/nodemailer/v6/package.json

@@ -7,10 +7,10 @@
         "https://nodemailer.com"
     ],
     "dependencies": {
-        "@aws-sdk/client-ses": "^3.731.1",
         "@types/node": "*"
     },
     "devDependencies": {
+        "@aws-sdk/client-ses": "^3.731.1",
         "@types/nodemailer": "workspace:."
     },
     "owners": [