ts-mailkit 2.0.1 → 3.0.0

package/dist/transports/memory/memory-sender.d.ts

@@ -1,5 +1,6 @@
-import type { SendMailOptions, SendResult } from '../../core/types.js';
-import type { IEmailSender } from '../sender.interface.js';
+import type { SendMailOptions, SendResult } from "../../core/types.js";
+import type { BulkKnownTemplateSendOptions, BulkSendOptions, KnownTemplateSendOptions } from "../../core/types.js";
+import type { IEmailSender } from "../sender.interface.js";
 /**
  * In-memory email sender for automated testing, local development, and CI environments.
  * Captures all dispatched emails and provides inspection methods.
@@ -7,22 +8,41 @@ import type { IEmailSender } from '../sender.interface.js';
 export declare class MemoryEmailSender implements IEmailSender {
     readonly name = "memory";
     private sentMails;
+    private sentBulkMails;
+    private sentTemplateMails;
+    private sentBulkTemplateMails;
     private nextId;
+    private result;
     send(options: SendMailOptions): Promise<SendResult>;
+    sendBulk(options: BulkSendOptions): Promise<SendResult>;
+    sendKnownTemplate(options: KnownTemplateSendOptions): Promise<SendResult>;
+    sendBulkKnownTemplate(options: BulkKnownTemplateSendOptions): Promise<SendResult>;
     /**
-     * Returns a copy of all emails sent through this transport instance.
+     * Returns a copy of all single emails sent through this transport instance.
      */
     getSentMails(): SendMailOptions[];
     /**
-     * Returns the most recent email sent, or undefined if no emails have been sent.
+     * Returns the most recent single email sent, or undefined if none have been sent.
      */
     getLastMail(): SendMailOptions | undefined;
     /**
-     * Clears all recorded sent emails.
+     * Returns a copy of all bulk emails sent through this transport instance.
+     */
+    getSentBulkMails(): BulkSendOptions[];
+    /**
+     * Returns a copy of all single template emails sent through this transport instance.
+     */
+    getSentTemplateMails(): KnownTemplateSendOptions[];
+    /**
+     * Returns a copy of all bulk template emails sent through this transport instance.
+     */
+    getSentBulkTemplateMails(): BulkKnownTemplateSendOptions[];
+    /**
+     * Clears all recorded emails.
      */
     clear(): void;
     /**
-     * Returns the total count of sent emails.
+     * Returns the total count of single emails sent.
      */
     count(): number;
 }

package/dist/transports/memory/memory-sender.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"memory-sender.d.ts","sourceRoot":"","sources":["../../../src/transports/memory/memory-sender.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAE3D;;;GAGG;AACH,qBAAa,iBAAkB,YAAW,YAAY;IACpD,QAAQ,CAAC,IAAI,YAAY;IAEzB,OAAO,CAAC,SAAS,CAAyB;IAC1C,OAAO,CAAC,MAAM,CAAK;IAEb,IAAI,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,CAQxD;IAED;;OAEG;IACH,YAAY,IAAI,eAAe,EAAE,CAEhC;IAED;;OAEG;IACH,WAAW,IAAI,eAAe,GAAG,SAAS,CAIzC;IAED;;OAEG;IACH,KAAK,IAAI,IAAI,CAEZ;IAED;;OAEG;IACH,KAAK,IAAI,MAAM,CAEd;CACF"}
+{"version":3,"file":"memory-sender.d.ts","sourceRoot":"","sources":["../../../src/transports/memory/memory-sender.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,KAAK,EACV,4BAA4B,EAC5B,eAAe,EACf,wBAAwB,EACzB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAE3D;;;GAGG;AACH,qBAAa,iBAAkB,YAAW,YAAY;IACpD,QAAQ,CAAC,IAAI,YAAY;IAEzB,OAAO,CAAC,SAAS,CAAyB;IAC1C,OAAO,CAAC,aAAa,CAAyB;IAC9C,OAAO,CAAC,iBAAiB,CAAkC;IAC3D,OAAO,CAAC,qBAAqB,CAAsC;IACnE,OAAO,CAAC,MAAM,CAAK;IAEnB,OAAO,CAAC,MAAM;IAWR,IAAI,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,CAGxD;IAEK,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,CAG5D;IAEK,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,UAAU,CAAC,CAG9E;IAEK,qBAAqB,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,UAAU,CAAC,CAGtF;IAED;;OAEG;IACH,YAAY,IAAI,eAAe,EAAE,CAEhC;IAED;;OAEG;IACH,WAAW,IAAI,eAAe,GAAG,SAAS,CAEzC;IAED;;OAEG;IACH,gBAAgB,IAAI,eAAe,EAAE,CAEpC;IAED;;OAEG;IACH,oBAAoB,IAAI,wBAAwB,EAAE,CAEjD;IAED;;OAEG;IACH,wBAAwB,IAAI,4BAA4B,EAAE,CAEzD;IAED;;OAEG;IACH,KAAK,IAAI,IAAI,CAKZ;IAED;;OAEG;IACH,KAAK,IAAI,MAAM,CAEd;CACF"}

package/dist/transports/sender.interface.d.ts

@@ -1,20 +1,51 @@
-import type { SendMailOptions, SendResult } from '../core/types.js';
+import type { SendMailOptions, SendResult } from "../core/types.js";
+import type { BulkKnownTemplateSendOptions, BulkSendOptions, KnownTemplateSendOptions } from "../core/types.js";
 /**
  * Contract that every concrete email sender/transport must satisfy.
  * Implement this interface to create custom transports (e.g. SMTP, Resend, SendGrid, Postmark).
+ *
+ * Bulk/template capabilities are optional. Transports that do not implement
+ * them will cause `MailKit` to throw a `ConfigurationError` when those
+ * methods are used.
  */
 export interface IEmailSender {
     /**
-     * Unique identifier for the transport (e.g., 'zeptomail', 'memory', 'console', 'smtp').
+     * Unique identifier for the transport (e.g., 'cpaas', 'memory', 'console', 'smtp').
      */
     readonly name: string;
     /**
      * Dispatches an email using the transport adapter.
      *
      * @param options Structured email options including recipients, subject, HTML, text, attachments, etc.
-     * @returns A SendResult indicating success and optional provider messageId or response data.
+     * @returns A SendResult indicating success and optional provider messageId or raw response data.
      * @throws TransportError if the transport fails to send the email.
      */
     send(options: SendMailOptions): Promise<SendResult>;
+    /**
+     * Dispatches a batch of a single raw email content to many recipients.
+     * The provider delivers an individual copy to each recipient.
+     *
+     * @param options Structured bulk email options.
+     * @returns A SendResult indicating success and optional raw response data.
+     * @throws TransportError if the transport fails to send the batch.
+     */
+    sendBulk?(options: BulkSendOptions): Promise<SendResult>;
+    /**
+     * Dispatches a single email using a provider-side template.
+     *
+     * @param options Template identifier, recipient, and optional merge data.
+     * @returns A SendResult indicating success and optional raw response data.
+     * @throws TransportError if the transport fails to send the email.
+     */
+    sendKnownTemplate?(options: KnownTemplateSendOptions): Promise<SendResult>;
+    /**
+     * Dispatches a batch of emails using a provider-side template, with
+     * optional per-recipient merge data.
+     *
+     * @param options Template identifier, recipients, and optional merge data.
+     * @returns A SendResult indicating success and optional raw response data.
+     * @throws TransportError if the transport fails to send the batch.
+     */
+    sendBulkKnownTemplate?(options: BulkKnownTemplateSendOptions): Promise<SendResult>;
 }
 //# sourceMappingURL=sender.interface.d.ts.map

package/dist/transports/sender.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sender.interface.d.ts","sourceRoot":"","sources":["../../src/transports/sender.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEpE;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;;;;OAMG;IACH,IAAI,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CACrD"}
+{"version":3,"file":"sender.interface.d.ts","sourceRoot":"","sources":["../../src/transports/sender.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,KAAK,EACV,4BAA4B,EAC5B,eAAe,EACf,wBAAwB,EACzB,MAAM,kBAAkB,CAAC;AAE1B;;;;;;;GAOG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;;;;OAMG;IACH,IAAI,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAEpD;;;;;;;OAOG;IACH,QAAQ,CAAC,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAEzD;;;;;;OAMG;IACH,iBAAiB,CAAC,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAE3E;;;;;;;OAOG;IACH,qBAAqB,CAAC,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CACpF"}

package/package.json

@@ -1,12 +1,37 @@
 {
   "name": "ts-mailkit",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "description": "Strictly typed, modular, and composable email composition and dispatch library for TypeScript and modern edge runtimes.",
+  "keywords": [
+    "cpaas",
+    "dto",
+    "edge",
+    "email",
+    "mailer",
+    "transactional-email",
+    "typescript",
+    "workerd",
+    "zoho-mail"
+  ],
+  "homepage": "https://github.com/AD-RIAN-Studio/ts-mailkit#readme",
+  "bugs": {
+    "url": "https://github.com/AD-RIAN-Studio/ts-mailkit/issues"
+  },
+  "license": "MIT",
+  "author": "AD-RIAN Studio",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AD-RIAN-Studio/ts-mailkit.git"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "type": "module",
+  "sideEffects": false,
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "type": "module",
-  "sideEffects": false,
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -17,46 +42,23 @@
   "publishConfig": {
     "access": "public"
   },
-  "packageManager": "pnpm@11.22.0",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/AD-RIAN-Studio/ts-mailkit.git"
-  },
-  "bugs": {
-    "url": "https://github.com/AD-RIAN-Studio/ts-mailkit/issues"
-  },
-  "homepage": "https://github.com/AD-RIAN-Studio/ts-mailkit#readme",
-  "files": [
-    "dist",
-    "README.md"
-  ],
   "scripts": {
-    "build": "tsdown && tsc --emitDeclarationOnly",
-    "dev": "tsdown --watch",
+    "build": "vp pack && tsc --emitDeclarationOnly",
+    "dev": "vp pack --watch",
+    "check": "vp check",
+    "check:fix": "vp check --fix",
+    "lint": "vp lint",
+    "format": "vp fmt",
     "typecheck": "tsc --noEmit",
-    "test": "vitest run test/unit",
-    "test:unit": "vitest run test/unit",
-    "test:watch": "vitest test/unit",
-    "prepublishOnly": "pnpm run build && pnpm run test:unit"
+    "test": "vp test run test/unit",
+    "test:unit": "vp test run test/unit",
+    "test:watch": "vp test test/unit",
+    "prepublishOnly": "pnpm run check && pnpm run typecheck && pnpm run test:unit && pnpm run build"
   },
-  "keywords": [
-    "email",
-    "mailer",
-    "zeptomail",
-    "zoho-mail",
-    "typescript",
-    "dto",
-    "transactional-email",
-    "edge",
-    "workerd"
-  ],
-  "author": "AD-RIAN Studio",
-  "license": "MIT",
   "devDependencies": {
     "@types/node": "^26.1.1",
-    "tsdown": "^0.23.0",
     "tsx": "^4.19.3",
     "typescript": "^7.0.2",
-    "vitest": "^3.0.7"
+    "vite-plus": "catalog:"
   }
 }

package/dist/transports/zeptomail/types.d.ts

@@ -1,47 +0,0 @@
-import type { Recipient } from '../../core/types.js';
-export interface ZeptoMailHttpConfig {
-    /**
-     * Zoho ZeptoMail API host domain.
-     * Examples: 'api.zeptomail.com', 'api.zeptomail.eu', 'api.zeptomail.in'
-     * @default 'api.zeptomail.com'
-     */
-    apiHost?: string;
-    /**
-     * ZeptoMail Send Mail API Token.
-     */
-    apiToken: string;
-    /**
-     * Default verified sender email address or Recipient object.
-     */
-    from: Recipient;
-    /**
-     * Optional custom fetch implementation (useful for mocking, testing, or proxies).
-     * Defaults to global `fetch`.
-     */
-    fetch?: typeof fetch;
-}
-export interface ZeptoMailAddressObject {
-    address: string;
-    name?: string;
-}
-export interface ZeptoMailRecipientWrapper {
-    email_address: ZeptoMailAddressObject;
-}
-export interface ZeptoMailAttachmentPayload {
-    name: string;
-    content: string;
-    mime_type?: string;
-    cid?: string;
-}
-export interface ZeptoMailSendPayload {
-    from: ZeptoMailAddressObject;
-    to: ZeptoMailRecipientWrapper[];
-    subject: string;
-    htmlbody: string;
-    textbody?: string;
-    cc?: ZeptoMailRecipientWrapper[];
-    bcc?: ZeptoMailRecipientWrapper[];
-    reply_to?: ZeptoMailAddressObject[];
-    attachments?: ZeptoMailAttachmentPayload[];
-}
-//# sourceMappingURL=types.d.ts.map

package/dist/transports/zeptomail/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/transports/zeptomail/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAErD,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,SAAS,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,sBAAsB,CAAC;CACvC;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,sBAAsB,CAAC;IAC7B,EAAE,EAAE,yBAAyB,EAAE,CAAC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,EAAE,CAAC,EAAE,yBAAyB,EAAE,CAAC;IACjC,GAAG,CAAC,EAAE,yBAAyB,EAAE,CAAC;IAClC,QAAQ,CAAC,EAAE,sBAAsB,EAAE,CAAC;IACpC,WAAW,CAAC,EAAE,0BAA0B,EAAE,CAAC;CAC5C"}

package/dist/transports/zeptomail/zeptomail-sender.d.ts

@@ -1,22 +0,0 @@
-import { type SendMailOptions, type SendResult } from '../../core/types.js';
-import type { IEmailSender } from '../sender.interface.js';
-import type { ZeptoMailHttpConfig } from './types.js';
-/**
- * ZeptoMail (Zoho Mail transactional email HTTP API) transport adapter.
- *
- * Designed for zero dependencies and universal edge compatibility (Node.js, Bun, Deno, Cloudflare Workers)
- * by utilizing the standard global `fetch` API.
- */
-export declare class ZeptoMailHttpSender implements IEmailSender {
-    readonly name = "zeptomail";
-    private readonly apiUrl;
-    private readonly authHeader;
-    private readonly defaultFrom;
-    private readonly fetchImpl;
-    constructor(config: ZeptoMailHttpConfig);
-    /**
-     * Dispatches an email using Zoho ZeptoMail API v1.1.
-     */
-    send(options: SendMailOptions): Promise<SendResult>;
-}
-//# sourceMappingURL=zeptomail-sender.d.ts.map

package/dist/transports/zeptomail/zeptomail-sender.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"zeptomail-sender.d.ts","sourceRoot":"","sources":["../../../src/transports/zeptomail/zeptomail-sender.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,KAAK,eAAe,EACpB,KAAK,UAAU,EAChB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,EACV,mBAAmB,EAGpB,MAAM,YAAY,CAAC;AAEpB;;;;;GAKG;AACH,qBAAa,mBAAoB,YAAW,YAAY;IACtD,QAAQ,CAAC,IAAI,eAAe;IAE5B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqC;IACjE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IAEzC,YAAY,MAAM,EAAE,mBAAmB,EA4BtC;IAED;;OAEG;IACG,IAAI,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,CAmIxD;CACF"}