@jadedm/nestjs-verify-ses 0.6.0 → 0.7.0

package/README.md

@@ -9,7 +9,7 @@ pnpm add @jadedm/nestjs-verify-ses @aws-sdk/client-sesv2
 ## Usage
 
 ```ts
-import { VerifyModule } from '@jadedm/nestjs-verify';
+import { VerifyModule, createMemoryStores } from '@jadedm/nestjs-verify';
 import { SesEmailProvider } from '@jadedm/nestjs-verify-ses';
 
 VerifyModule.forRoot({
@@ -21,17 +21,17 @@ VerifyModule.forRoot({
     }),
     subject: 'Your Example sign-in code',
   },
-  stores: { /* ... */ },
+  stores: createMemoryStores(), // or a durable store adapter
 });
 ```
 
 Start a verification with `channel: 'email'` and an email address in `to`.
 
-Credentials come from the AWS SDK's default chain (environment, shared config, instance or task role). Pass `client` to use your own `SESv2Client`.
+Credentials and region come from the AWS SDK's default chain (environment, shared config, instance or task role). If no region is set anywhere, every send fails with "Region is missing" and the next provider is tried, so set `region` or `AWS_REGION`. Pass `client` to use your own `SESv2Client`.
 
 ## Errors and retries
 
-The AWS SDK retries throttling and server errors itself (three attempts by default). Anything it gives up on, and any rejection such as an unverified identity or a recipient outside the sandbox, is thrown, so `nestjs-verify` moves on to the next provider in `email.fallbacks`.
+The AWS SDK retries throttling and server errors itself (three attempts by default). Anything it gives up on, and any rejection such as an unverified identity or a recipient outside the sandbox, is thrown, so `nestjs-verify` moves on to the next provider in `email.fallbacks`. The SDK sets no request timeout of its own; the core's `delivery` limits stop waiting and abort the request. Logged errors keep the SES request id.
 
 ## Requirements
 
@@ -39,5 +39,5 @@ Node 20 or newer: current `@aws-sdk/client-sesv2` releases require it, though th
 
 ## Peers
 
-- `@jadedm/nestjs-verify` 0.x
+- `@jadedm/nestjs-verify` within the range in `peerDependencies` (one or more 0.x minors)
 - `@aws-sdk/client-sesv2` 3.x

package/dist/index.d.mts

@@ -22,7 +22,9 @@ declare class SesEmailProvider implements EmailProvider {
     readonly name = "ses";
     private readonly client;
     constructor(opts: SesEmailProviderOptions);
-    send(params: EmailSendParams): Promise<EmailSendResult>;
+    send(params: EmailSendParams, options?: {
+        signal?: AbortSignal;
+    }): Promise<EmailSendResult>;
 }
 
 export { SesEmailProvider, type SesEmailProviderOptions };

package/dist/index.d.ts

@@ -22,7 +22,9 @@ declare class SesEmailProvider implements EmailProvider {
     readonly name = "ses";
     private readonly client;
     constructor(opts: SesEmailProviderOptions);
-    send(params: EmailSendParams): Promise<EmailSendResult>;
+    send(params: EmailSendParams, options?: {
+        signal?: AbortSignal;
+    }): Promise<EmailSendResult>;
 }
 
 export { SesEmailProvider, type SesEmailProviderOptions };

package/dist/index.js

@@ -40,7 +40,9 @@ var SesEmailProvider = class {
       region: opts.region
     });
   }
-  async send(params) {
+  // The options type is written out rather than imported, so these
+  // declarations still type-check against a core version that lacks it.
+  async send(params, options) {
     const result = await this.client.send(new import_client_sesv2.SendEmailCommand({
       FromEmailAddress: this.opts.from,
       Destination: {
@@ -63,7 +65,9 @@ var SesEmailProvider = class {
         }
       },
       ConfigurationSetName: this.opts.configurationSetName
-    }));
+    }), {
+      abortSignal: options?.signal
+    });
     if (!result.MessageId) throw new Error("SES returned no MessageId");
     return {
       providerMessageId: result.MessageId,

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/ses-email.provider.ts"],"sourcesContent":["export * from './ses-email.provider.js';\n","import type {\n  EmailProvider,\n  EmailSendParams,\n  EmailSendResult,\n} from '@jadedm/nestjs-verify';\nimport { SendEmailCommand, SESv2Client } from '@aws-sdk/client-sesv2';\n\nexport interface SesEmailProviderOptions {\n  /** Verified SES identity to send from, e.g. 'no-reply@example.com' or 'Example <no-reply@example.com>'. */\n  from: string;\n  /** Region of the SES identity, e.g. 'ap-south-1'. Ignored when `client` is given. */\n  region?: string;\n  /** A configured client, for custom credentials or endpoints. */\n  client?: SESv2Client;\n  /** Optional SES configuration set, for event publishing. */\n  configurationSetName?: string;\n}\n\n/**\n * Sends verification codes through Amazon SES (API v2). Credentials come from\n * the AWS SDK's default chain unless a client is passed. The SDK retries\n * throttling and server errors itself; anything it gives up on is thrown, so\n * the core can try a fallback provider.\n */\nexport class SesEmailProvider implements EmailProvider {\n  readonly name = 'ses';\n  private readonly client: SESv2Client;\n\n  constructor(private readonly opts: SesEmailProviderOptions) {\n    this.client = opts.client ?? new SESv2Client({ region: opts.region });\n  }\n\n  async send(params: EmailSendParams): Promise<EmailSendResult> {\n    const result = await this.client.send(\n      new SendEmailCommand({\n        FromEmailAddress: this.opts.from,\n        Destination: { ToAddresses: [params.to] },\n        Content: {\n          Simple: {\n            Subject: { Data: params.subject, Charset: 'UTF-8' },\n            Body: { Text: { Data: params.text, Charset: 'UTF-8' } },\n          },\n        },\n        ConfigurationSetName: this.opts.configurationSetName,\n      }),\n    );\n    if (!result.MessageId) throw new Error('SES returned no MessageId');\n    return { providerMessageId: result.MessageId, provider: this.name };\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;ACKA,0BAA8C;AAmBvC,IAAMA,mBAAN,MAAMA;EAnBb,OAmBaA;;;;EACFC,OAAO;EACCC;EAEjB,YAA6BC,MAA+B;SAA/BA,OAAAA;AAC3B,SAAKD,SAASC,KAAKD,UAAU,IAAIE,gCAAY;MAAEC,QAAQF,KAAKE;IAAO,CAAA;EACrE;EAEA,MAAMC,KAAKC,QAAmD;AAC5D,UAAMC,SAAS,MAAM,KAAKN,OAAOI,KAC/B,IAAIG,qCAAiB;MACnBC,kBAAkB,KAAKP,KAAKQ;MAC5BC,aAAa;QAAEC,aAAa;UAACN,OAAOO;;MAAI;MACxCC,SAAS;QACPC,QAAQ;UACNC,SAAS;YAAEC,MAAMX,OAAOY;YAASC,SAAS;UAAQ;UAClDC,MAAM;YAAEC,MAAM;cAAEJ,MAAMX,OAAOgB;cAAMH,SAAS;YAAQ;UAAE;QACxD;MACF;MACAI,sBAAsB,KAAKrB,KAAKsB;IAClC,CAAA,CAAA;AAEF,QAAI,CAACjB,OAAOkB,UAAW,OAAM,IAAIC,MAAM,2BAAA;AACvC,WAAO;MAAEC,mBAAmBpB,OAAOkB;MAAWG,UAAU,KAAK5B;IAAK;EACpE;AACF;","names":["SesEmailProvider","name","client","opts","SESv2Client","region","send","params","result","SendEmailCommand","FromEmailAddress","from","Destination","ToAddresses","to","Content","Simple","Subject","Data","subject","Charset","Body","Text","text","ConfigurationSetName","configurationSetName","MessageId","Error","providerMessageId","provider"]}
+{"version":3,"sources":["../src/index.ts","../src/ses-email.provider.ts"],"sourcesContent":["export * from './ses-email.provider.js';\n","import type {\n  EmailProvider,\n  EmailSendParams,\n  EmailSendResult,\n} from '@jadedm/nestjs-verify';\nimport { SendEmailCommand, SESv2Client } from '@aws-sdk/client-sesv2';\n\nexport interface SesEmailProviderOptions {\n  /** Verified SES identity to send from, e.g. 'no-reply@example.com' or 'Example <no-reply@example.com>'. */\n  from: string;\n  /** Region of the SES identity, e.g. 'ap-south-1'. Ignored when `client` is given. */\n  region?: string;\n  /** A configured client, for custom credentials or endpoints. */\n  client?: SESv2Client;\n  /** Optional SES configuration set, for event publishing. */\n  configurationSetName?: string;\n}\n\n/**\n * Sends verification codes through Amazon SES (API v2). Credentials come from\n * the AWS SDK's default chain unless a client is passed. The SDK retries\n * throttling and server errors itself; anything it gives up on is thrown, so\n * the core can try a fallback provider.\n */\nexport class SesEmailProvider implements EmailProvider {\n  readonly name = 'ses';\n  private readonly client: SESv2Client;\n\n  constructor(private readonly opts: SesEmailProviderOptions) {\n    this.client = opts.client ?? new SESv2Client({ region: opts.region });\n  }\n\n  // The options type is written out rather than imported, so these\n  // declarations still type-check against a core version that lacks it.\n  async send(params: EmailSendParams, options?: { signal?: AbortSignal }): Promise<EmailSendResult> {\n    const result = await this.client.send(\n      new SendEmailCommand({\n        FromEmailAddress: this.opts.from,\n        Destination: { ToAddresses: [params.to] },\n        Content: {\n          Simple: {\n            Subject: { Data: params.subject, Charset: 'UTF-8' },\n            Body: { Text: { Data: params.text, Charset: 'UTF-8' } },\n          },\n        },\n        ConfigurationSetName: this.opts.configurationSetName,\n      }),\n      { abortSignal: options?.signal },\n    );\n    if (!result.MessageId) throw new Error('SES returned no MessageId');\n    return { providerMessageId: result.MessageId, provider: this.name };\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;ACKA,0BAA8C;AAmBvC,IAAMA,mBAAN,MAAMA;EAnBb,OAmBaA;;;;EACFC,OAAO;EACCC;EAEjB,YAA6BC,MAA+B;SAA/BA,OAAAA;AAC3B,SAAKD,SAASC,KAAKD,UAAU,IAAIE,gCAAY;MAAEC,QAAQF,KAAKE;IAAO,CAAA;EACrE;;;EAIA,MAAMC,KAAKC,QAAyBC,SAA8D;AAChG,UAAMC,SAAS,MAAM,KAAKP,OAAOI,KAC/B,IAAII,qCAAiB;MACnBC,kBAAkB,KAAKR,KAAKS;MAC5BC,aAAa;QAAEC,aAAa;UAACP,OAAOQ;;MAAI;MACxCC,SAAS;QACPC,QAAQ;UACNC,SAAS;YAAEC,MAAMZ,OAAOa;YAASC,SAAS;UAAQ;UAClDC,MAAM;YAAEC,MAAM;cAAEJ,MAAMZ,OAAOiB;cAAMH,SAAS;YAAQ;UAAE;QACxD;MACF;MACAI,sBAAsB,KAAKtB,KAAKuB;IAClC,CAAA,GACA;MAAEC,aAAanB,SAASoB;IAAO,CAAA;AAEjC,QAAI,CAACnB,OAAOoB,UAAW,OAAM,IAAIC,MAAM,2BAAA;AACvC,WAAO;MAAEC,mBAAmBtB,OAAOoB;MAAWG,UAAU,KAAK/B;IAAK;EACpE;AACF;","names":["SesEmailProvider","name","client","opts","SESv2Client","region","send","params","options","result","SendEmailCommand","FromEmailAddress","from","Destination","ToAddresses","to","Content","Simple","Subject","Data","subject","Charset","Body","Text","text","ConfigurationSetName","configurationSetName","abortSignal","signal","MessageId","Error","providerMessageId","provider"]}

package/dist/index.mjs

@@ -16,7 +16,9 @@ var SesEmailProvider = class {
       region: opts.region
     });
   }
-  async send(params) {
+  // The options type is written out rather than imported, so these
+  // declarations still type-check against a core version that lacks it.
+  async send(params, options) {
     const result = await this.client.send(new SendEmailCommand({
       FromEmailAddress: this.opts.from,
       Destination: {
@@ -39,7 +41,9 @@ var SesEmailProvider = class {
         }
       },
       ConfigurationSetName: this.opts.configurationSetName
-    }));
+    }), {
+      abortSignal: options?.signal
+    });
     if (!result.MessageId) throw new Error("SES returned no MessageId");
     return {
       providerMessageId: result.MessageId,

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/ses-email.provider.ts"],"sourcesContent":["import type {\n  EmailProvider,\n  EmailSendParams,\n  EmailSendResult,\n} from '@jadedm/nestjs-verify';\nimport { SendEmailCommand, SESv2Client } from '@aws-sdk/client-sesv2';\n\nexport interface SesEmailProviderOptions {\n  /** Verified SES identity to send from, e.g. 'no-reply@example.com' or 'Example <no-reply@example.com>'. */\n  from: string;\n  /** Region of the SES identity, e.g. 'ap-south-1'. Ignored when `client` is given. */\n  region?: string;\n  /** A configured client, for custom credentials or endpoints. */\n  client?: SESv2Client;\n  /** Optional SES configuration set, for event publishing. */\n  configurationSetName?: string;\n}\n\n/**\n * Sends verification codes through Amazon SES (API v2). Credentials come from\n * the AWS SDK's default chain unless a client is passed. The SDK retries\n * throttling and server errors itself; anything it gives up on is thrown, so\n * the core can try a fallback provider.\n */\nexport class SesEmailProvider implements EmailProvider {\n  readonly name = 'ses';\n  private readonly client: SESv2Client;\n\n  constructor(private readonly opts: SesEmailProviderOptions) {\n    this.client = opts.client ?? new SESv2Client({ region: opts.region });\n  }\n\n  async send(params: EmailSendParams): Promise<EmailSendResult> {\n    const result = await this.client.send(\n      new SendEmailCommand({\n        FromEmailAddress: this.opts.from,\n        Destination: { ToAddresses: [params.to] },\n        Content: {\n          Simple: {\n            Subject: { Data: params.subject, Charset: 'UTF-8' },\n            Body: { Text: { Data: params.text, Charset: 'UTF-8' } },\n          },\n        },\n        ConfigurationSetName: this.opts.configurationSetName,\n      }),\n    );\n    if (!result.MessageId) throw new Error('SES returned no MessageId');\n    return { providerMessageId: result.MessageId, provider: this.name };\n  }\n}\n"],"mappings":";;;;AAKA,SAASA,kBAAkBC,mBAAmB;AAmBvC,IAAMC,mBAAN,MAAMA;EAnBb,OAmBaA;;;;EACFC,OAAO;EACCC;EAEjB,YAA6BC,MAA+B;SAA/BA,OAAAA;AAC3B,SAAKD,SAASC,KAAKD,UAAU,IAAIE,YAAY;MAAEC,QAAQF,KAAKE;IAAO,CAAA;EACrE;EAEA,MAAMC,KAAKC,QAAmD;AAC5D,UAAMC,SAAS,MAAM,KAAKN,OAAOI,KAC/B,IAAIG,iBAAiB;MACnBC,kBAAkB,KAAKP,KAAKQ;MAC5BC,aAAa;QAAEC,aAAa;UAACN,OAAOO;;MAAI;MACxCC,SAAS;QACPC,QAAQ;UACNC,SAAS;YAAEC,MAAMX,OAAOY;YAASC,SAAS;UAAQ;UAClDC,MAAM;YAAEC,MAAM;cAAEJ,MAAMX,OAAOgB;cAAMH,SAAS;YAAQ;UAAE;QACxD;MACF;MACAI,sBAAsB,KAAKrB,KAAKsB;IAClC,CAAA,CAAA;AAEF,QAAI,CAACjB,OAAOkB,UAAW,OAAM,IAAIC,MAAM,2BAAA;AACvC,WAAO;MAAEC,mBAAmBpB,OAAOkB;MAAWG,UAAU,KAAK5B;IAAK;EACpE;AACF;","names":["SendEmailCommand","SESv2Client","SesEmailProvider","name","client","opts","SESv2Client","region","send","params","result","SendEmailCommand","FromEmailAddress","from","Destination","ToAddresses","to","Content","Simple","Subject","Data","subject","Charset","Body","Text","text","ConfigurationSetName","configurationSetName","MessageId","Error","providerMessageId","provider"]}
+{"version":3,"sources":["../src/ses-email.provider.ts"],"sourcesContent":["import type {\n  EmailProvider,\n  EmailSendParams,\n  EmailSendResult,\n} from '@jadedm/nestjs-verify';\nimport { SendEmailCommand, SESv2Client } from '@aws-sdk/client-sesv2';\n\nexport interface SesEmailProviderOptions {\n  /** Verified SES identity to send from, e.g. 'no-reply@example.com' or 'Example <no-reply@example.com>'. */\n  from: string;\n  /** Region of the SES identity, e.g. 'ap-south-1'. Ignored when `client` is given. */\n  region?: string;\n  /** A configured client, for custom credentials or endpoints. */\n  client?: SESv2Client;\n  /** Optional SES configuration set, for event publishing. */\n  configurationSetName?: string;\n}\n\n/**\n * Sends verification codes through Amazon SES (API v2). Credentials come from\n * the AWS SDK's default chain unless a client is passed. The SDK retries\n * throttling and server errors itself; anything it gives up on is thrown, so\n * the core can try a fallback provider.\n */\nexport class SesEmailProvider implements EmailProvider {\n  readonly name = 'ses';\n  private readonly client: SESv2Client;\n\n  constructor(private readonly opts: SesEmailProviderOptions) {\n    this.client = opts.client ?? new SESv2Client({ region: opts.region });\n  }\n\n  // The options type is written out rather than imported, so these\n  // declarations still type-check against a core version that lacks it.\n  async send(params: EmailSendParams, options?: { signal?: AbortSignal }): Promise<EmailSendResult> {\n    const result = await this.client.send(\n      new SendEmailCommand({\n        FromEmailAddress: this.opts.from,\n        Destination: { ToAddresses: [params.to] },\n        Content: {\n          Simple: {\n            Subject: { Data: params.subject, Charset: 'UTF-8' },\n            Body: { Text: { Data: params.text, Charset: 'UTF-8' } },\n          },\n        },\n        ConfigurationSetName: this.opts.configurationSetName,\n      }),\n      { abortSignal: options?.signal },\n    );\n    if (!result.MessageId) throw new Error('SES returned no MessageId');\n    return { providerMessageId: result.MessageId, provider: this.name };\n  }\n}\n"],"mappings":";;;;AAKA,SAASA,kBAAkBC,mBAAmB;AAmBvC,IAAMC,mBAAN,MAAMA;EAnBb,OAmBaA;;;;EACFC,OAAO;EACCC;EAEjB,YAA6BC,MAA+B;SAA/BA,OAAAA;AAC3B,SAAKD,SAASC,KAAKD,UAAU,IAAIE,YAAY;MAAEC,QAAQF,KAAKE;IAAO,CAAA;EACrE;;;EAIA,MAAMC,KAAKC,QAAyBC,SAA8D;AAChG,UAAMC,SAAS,MAAM,KAAKP,OAAOI,KAC/B,IAAII,iBAAiB;MACnBC,kBAAkB,KAAKR,KAAKS;MAC5BC,aAAa;QAAEC,aAAa;UAACP,OAAOQ;;MAAI;MACxCC,SAAS;QACPC,QAAQ;UACNC,SAAS;YAAEC,MAAMZ,OAAOa;YAASC,SAAS;UAAQ;UAClDC,MAAM;YAAEC,MAAM;cAAEJ,MAAMZ,OAAOiB;cAAMH,SAAS;YAAQ;UAAE;QACxD;MACF;MACAI,sBAAsB,KAAKtB,KAAKuB;IAClC,CAAA,GACA;MAAEC,aAAanB,SAASoB;IAAO,CAAA;AAEjC,QAAI,CAACnB,OAAOoB,UAAW,OAAM,IAAIC,MAAM,2BAAA;AACvC,WAAO;MAAEC,mBAAmBtB,OAAOoB;MAAWG,UAAU,KAAK/B;IAAK;EACpE;AACF;","names":["SendEmailCommand","SESv2Client","SesEmailProvider","name","client","opts","SESv2Client","region","send","params","options","result","SendEmailCommand","FromEmailAddress","from","Destination","ToAddresses","to","Content","Simple","Subject","Data","subject","Charset","Body","Text","text","ConfigurationSetName","configurationSetName","abortSignal","signal","MessageId","Error","providerMessageId","provider"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jadedm/nestjs-verify-ses",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Amazon SES email provider adapter for @jadedm/nestjs-verify.",
   "keywords": [
     "nestjs",
@@ -38,12 +38,12 @@
     "LICENSE"
   ],
   "peerDependencies": {
-    "@aws-sdk/client-sesv2": "^3.500.0",
-    "@jadedm/nestjs-verify": "^0.6.0"
+    "@jadedm/nestjs-verify": ">=0.6.8 <0.8.0",
+    "@aws-sdk/client-sesv2": "^3.500.0"
   },
   "devDependencies": {
     "@aws-sdk/client-sesv2": "^3.500.0",
-    "@jadedm/nestjs-verify": "0.6.0"
+    "@jadedm/nestjs-verify": "0.7.0"
   },
   "engines": {
     "node": ">=20"