@breadstone/archipel-platform-mailing 0.0.21 → 0.0.23

package/README.md

@@ -66,7 +66,7 @@ Set `MAIL_DELIVERY_STRATEGY` to one of: `smtp`, `postmark`, `resend`, `sendgrid`
 ## Features
 
 - **Multi-provider**: Switch between SMTP, Postmark, Resend, SendGrid, or Mailgun via config
-- **Subpath imports**: Each provider lives in its own subpath — install only the SDK you need
+- **Subpath imports**: Each provider lives in its own subpath - install only the SDK you need
 - **Template engines**: File-based or blob-based template fetching with variable substitution
 - **Health checks**: Built-in `MailHealthIndicator` for readiness probes
 - **Email verification**: `MailVerificationService` for address verification flows

package/package.json

@@ -1,12 +1,18 @@
 {
   "name": "@breadstone/archipel-platform-mailing",
-  "version": "0.0.21",
+  "version": "0.0.23",
   "description": "Email delivery with strategy-based transport and template engines for NestJS applications.",
   "type": "commonjs",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",
   "typesVersions": {
     "*": {
+      "log": [
+        "./src/log/index.d.ts"
+      ],
+      "smtp": [
+        "./src/smtp/index.d.ts"
+      ],
       "mailgun": [
         "./src/mailgun/index.d.ts"
       ],
@@ -26,6 +32,14 @@
       "types": "./src/index.d.ts",
       "default": "./src/index.js"
     },
+    "./log": {
+      "types": "./src/log/index.d.ts",
+      "default": "./src/log/index.js"
+    },
+    "./smtp": {
+      "types": "./src/smtp/index.d.ts",
+      "default": "./src/smtp/index.js"
+    },
     "./mailgun": {
       "types": "./src/mailgun/index.d.ts",
       "default": "./src/mailgun/index.js"
@@ -43,6 +57,7 @@
       "default": "./src/sendgrid/index.js"
     },
     "./package.json": "./package.json",
+    "./smtp/index": "./src/smtp/index.js",
     "./postmark/index": "./src/postmark/index.js",
     "./resend/index": "./src/resend/index.js",
     "./sendgrid/index": "./src/sendgrid/index.js",
@@ -58,6 +73,7 @@
     "nestjs",
     "email",
     "mailing",
+    "log",
     "smtp",
     "postmark",
     "resend",
@@ -75,18 +91,20 @@
     "README.md"
   ],
   "dependencies": {
-    "@breadstone/archipel-platform-blob-storage": "0.0.21",
-    "@breadstone/archipel-platform-configuration": "0.0.21",
-    "@breadstone/archipel-platform-core": "0.0.21",
-    "form-data": "4.0.5",
-    "nodemailer": "8.0.5",
+    "@breadstone/archipel-platform-blob-storage": "0.0.23",
+    "@breadstone/archipel-platform-configuration": "0.0.23",
+    "@breadstone/archipel-platform-core": "0.0.23",
+    "@breadstone/archipel-platform-health": "0.0.23",
+    "@breadstone/archipel-platform-resources": "0.0.23",
     "tslib": "2.8.1"
   },
   "peerDependencies": {
     "@nestjs/common": ">=11.0.0",
     "@nestjs/terminus": ">=11.0.0",
     "@sendgrid/mail": ">=8.0.0",
+    "form-data": ">=4.0.0",
     "mailgun.js": ">=10.0.0",
+    "nodemailer": ">=8.0.0",
     "postmark": ">=4.0.0",
     "resend": ">=4.0.0",
     "rxjs": ">=7.0.0"
@@ -95,9 +113,15 @@
     "@sendgrid/mail": {
       "optional": true
     },
+    "form-data": {
+      "optional": true
+    },
     "mailgun.js": {
       "optional": true
     },
+    "nodemailer": {
+      "optional": true
+    },
     "postmark": {
       "optional": true
     },
@@ -111,6 +135,7 @@
     "@sendgrid/mail": "8.1.6",
     "form-data": "4.0.5",
     "mailgun.js": "13.0.0",
+    "nodemailer": "8.0.5",
     "postmark": "4.0.7",
     "resend": "6.12.2",
     "rxjs": "7.8.2",

package/src/index.d.ts

@@ -1,16 +1,12 @@
 export * from './env';
 export * from './errors/MailDeliveryError';
 export * from './events';
-export * from './MailModule';
 export * from './MailTokens';
 export * from './models/IMailAttachment';
 export * from './services/MailService';
 export * from './services/MailVerificationService';
 export * from './services/strategies/abstracts/DeliveryStrategyBase';
-export * from './services/strategies/LogDeliveryStrategy';
-export * from './services/strategies/SmtpDeliveryStrategy';
 export * from './templating/MailTemplateEngine';
 export * from './templating/strategies/abstracts/TemplateFetchStrategyBase';
-export * from './templating/strategies/BlobTemplateFetchStrategy';
-export * from './templating/strategies/FileTemplateFetchStrategy';
 export * from './terminus/MailHealthIndicator';
+export * from './tokens/MailModule';

package/src/index.js

@@ -4,17 +4,13 @@ const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./env"), exports);
 tslib_1.__exportStar(require("./errors/MailDeliveryError"), exports);
 tslib_1.__exportStar(require("./events"), exports);
-tslib_1.__exportStar(require("./MailModule"), exports);
 tslib_1.__exportStar(require("./MailTokens"), exports);
 tslib_1.__exportStar(require("./models/IMailAttachment"), exports);
 tslib_1.__exportStar(require("./services/MailService"), exports);
 tslib_1.__exportStar(require("./services/MailVerificationService"), exports);
 tslib_1.__exportStar(require("./services/strategies/abstracts/DeliveryStrategyBase"), exports);
-tslib_1.__exportStar(require("./services/strategies/LogDeliveryStrategy"), exports);
-tslib_1.__exportStar(require("./services/strategies/SmtpDeliveryStrategy"), exports);
 tslib_1.__exportStar(require("./templating/MailTemplateEngine"), exports);
 tslib_1.__exportStar(require("./templating/strategies/abstracts/TemplateFetchStrategyBase"), exports);
-tslib_1.__exportStar(require("./templating/strategies/BlobTemplateFetchStrategy"), exports);
-tslib_1.__exportStar(require("./templating/strategies/FileTemplateFetchStrategy"), exports);
 tslib_1.__exportStar(require("./terminus/MailHealthIndicator"), exports);
+tslib_1.__exportStar(require("./tokens/MailModule"), exports);
 //# sourceMappingURL=index.js.map

package/src/logger/index.d.ts

@@ -0,0 +1 @@
+export { LogDeliveryStrategy } from '../services/strategies/LogDeliveryStrategy';

package/src/logger/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogDeliveryStrategy = void 0;
+var LogDeliveryStrategy_1 = require("../services/strategies/LogDeliveryStrategy");
+Object.defineProperty(exports, "LogDeliveryStrategy", { enumerable: true, get: function () { return LogDeliveryStrategy_1.LogDeliveryStrategy; } });
+//# sourceMappingURL=index.js.map

package/src/services/MailVerificationService.d.ts

@@ -1,7 +1,7 @@
 import { ConfigService } from '@breadstone/archipel-platform-configuration';
 /**
  * Verifies SMTP server connectivity. Does **not** validate individual email
- * addresses — only checks whether the configured SMTP transport is reachable.
+ * addresses - only checks whether the configured SMTP transport is reachable.
  *
  * @public
  * @deprecated Renamed to `SmtpConnectionVerifier` in a future release to better

package/src/services/MailVerificationService.js

@@ -11,7 +11,7 @@ const env_1 = require("../env");
 // #endregion
 /**
  * Verifies SMTP server connectivity. Does **not** validate individual email
- * addresses — only checks whether the configured SMTP transport is reachable.
+ * addresses - only checks whether the configured SMTP transport is reachable.
  *
  * @public
  * @deprecated Renamed to `SmtpConnectionVerifier` in a future release to better

package/src/smtp/env.d.ts

@@ -0,0 +1,13 @@
+import { IConfigRegistryEntry } from '@breadstone/archipel-platform-configuration';
+/** SMTP server host. */
+export declare const SMTP_HOST: import("@breadstone/archipel-platform-configuration").IConfigKey<string>;
+/** SMTP server port. */
+export declare const SMTP_PORT: import("@breadstone/archipel-platform-configuration").IConfigKey<number>;
+/** Whether the SMTP connection uses TLS. */
+export declare const SMTP_SECURE: import("@breadstone/archipel-platform-configuration").IConfigKey<boolean>;
+/** SMTP authentication username. */
+export declare const SMTP_USER: import("@breadstone/archipel-platform-configuration").IConfigKey<string>;
+/** SMTP authentication password. */
+export declare const SMTP_PASSWORD: import("@breadstone/archipel-platform-configuration").IConfigKey<string>;
+/** Configuration entries required by the SMTP delivery provider. */
+export declare const SMTP_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;

package/src/smtp/env.js

@@ -0,0 +1,31 @@
+"use strict";
+// #region Imports
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SMTP_CONFIG_ENTRIES = exports.SMTP_PASSWORD = exports.SMTP_USER = exports.SMTP_SECURE = exports.SMTP_PORT = exports.SMTP_HOST = void 0;
+const archipel_platform_configuration_1 = require("@breadstone/archipel-platform-configuration");
+// #endregion
+// ──────────────────────────────────────────────────────────────
+// SMTP
+// ──────────────────────────────────────────────────────────────
+/** SMTP server host. */
+exports.SMTP_HOST = (0, archipel_platform_configuration_1.createConfigKey)('MAIL_SMTP_HOST');
+/** SMTP server port. */
+exports.SMTP_PORT = (0, archipel_platform_configuration_1.createConfigKey)('MAIL_SMTP_PORT');
+/** Whether the SMTP connection uses TLS. */
+exports.SMTP_SECURE = (0, archipel_platform_configuration_1.createConfigKey)('MAIL_SMTP_SECURE');
+/** SMTP authentication username. */
+exports.SMTP_USER = (0, archipel_platform_configuration_1.createConfigKey)('MAIL_SMTP_USER');
+/** SMTP authentication password. */
+exports.SMTP_PASSWORD = (0, archipel_platform_configuration_1.createConfigKey)('MAIL_SMTP_PASSWORD');
+// ──────────────────────────────────────────────────────────────
+// Registry entries
+// ──────────────────────────────────────────────────────────────
+/** Configuration entries required by the SMTP delivery provider. */
+exports.SMTP_CONFIG_ENTRIES = [
+    { key: exports.SMTP_HOST, required: true, defaultValue: 'localhost', description: 'SMTP server host.' },
+    { key: exports.SMTP_PORT, required: true, defaultValue: 587, description: 'SMTP server port.' },
+    { key: exports.SMTP_SECURE, required: false, defaultValue: true, description: 'Whether SMTP uses TLS.' },
+    { key: exports.SMTP_USER, required: false, defaultValue: '', description: 'SMTP authentication username.' },
+    { key: exports.SMTP_PASSWORD, required: false, defaultValue: '', description: 'SMTP authentication password.' },
+];
+//# sourceMappingURL=env.js.map

package/src/smtp/index.d.ts

@@ -0,0 +1,2 @@
+export { SmtpDeliveryStrategy } from '../services/strategies/SmtpDeliveryStrategy';
+export { SMTP_CONFIG_ENTRIES, SMTP_HOST, SMTP_PASSWORD, SMTP_PORT, SMTP_SECURE, SMTP_USER } from './env';

package/src/smtp/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SMTP_USER = exports.SMTP_SECURE = exports.SMTP_PORT = exports.SMTP_PASSWORD = exports.SMTP_HOST = exports.SMTP_CONFIG_ENTRIES = exports.SmtpDeliveryStrategy = void 0;
+var SmtpDeliveryStrategy_1 = require("../services/strategies/SmtpDeliveryStrategy");
+Object.defineProperty(exports, "SmtpDeliveryStrategy", { enumerable: true, get: function () { return SmtpDeliveryStrategy_1.SmtpDeliveryStrategy; } });
+var env_1 = require("./env");
+Object.defineProperty(exports, "SMTP_CONFIG_ENTRIES", { enumerable: true, get: function () { return env_1.SMTP_CONFIG_ENTRIES; } });
+Object.defineProperty(exports, "SMTP_HOST", { enumerable: true, get: function () { return env_1.SMTP_HOST; } });
+Object.defineProperty(exports, "SMTP_PASSWORD", { enumerable: true, get: function () { return env_1.SMTP_PASSWORD; } });
+Object.defineProperty(exports, "SMTP_PORT", { enumerable: true, get: function () { return env_1.SMTP_PORT; } });
+Object.defineProperty(exports, "SMTP_SECURE", { enumerable: true, get: function () { return env_1.SMTP_SECURE; } });
+Object.defineProperty(exports, "SMTP_USER", { enumerable: true, get: function () { return env_1.SMTP_USER; } });
+//# sourceMappingURL=index.js.map

package/src/templating/strategies/FileTemplateFetchStrategy.d.ts

@@ -1,4 +1,4 @@
-import { ResourceManager } from '@breadstone/archipel-platform-core';
+import { ResourceManager } from '@breadstone/archipel-platform-resources';
 import { TemplateFetchStrategyBase } from './abstracts/TemplateFetchStrategyBase';
 import { IMailTemplateVariants } from '../../MailTokens';
 /**

package/src/templating/strategies/FileTemplateFetchStrategy.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FileTemplateFetchStrategy = void 0;
 const tslib_1 = require("tslib");
 const common_1 = require("@nestjs/common");
-const archipel_platform_core_1 = require("@breadstone/archipel-platform-core");
+const archipel_platform_resources_1 = require("@breadstone/archipel-platform-resources");
 const TemplateFetchStrategyBase_1 = require("./abstracts/TemplateFetchStrategyBase");
 // #endregion
 /**
@@ -66,6 +66,6 @@ let FileTemplateFetchStrategy = FileTemplateFetchStrategy_1 = class FileTemplate
 exports.FileTemplateFetchStrategy = FileTemplateFetchStrategy;
 exports.FileTemplateFetchStrategy = FileTemplateFetchStrategy = FileTemplateFetchStrategy_1 = tslib_1.__decorate([
     (0, common_1.Injectable)(),
-    tslib_1.__metadata("design:paramtypes", [archipel_platform_core_1.ResourceManager])
+    tslib_1.__metadata("design:paramtypes", [archipel_platform_resources_1.ResourceManager])
 ], FileTemplateFetchStrategy);
 //# sourceMappingURL=FileTemplateFetchStrategy.js.map

package/src/terminus/MailHealthIndicator.d.ts

@@ -1,5 +1,5 @@
 import { ConfigService } from '@breadstone/archipel-platform-configuration';
-import { IHealthIndicator } from '@breadstone/archipel-platform-core';
+import { IHealthIndicator } from '@breadstone/archipel-platform-health';
 import { HealthIndicatorResult } from '@nestjs/terminus';
 /**
  * Health indicator for mail service.

package/src/{MailModule.js → tokens/MailModule.js}

@@ -6,16 +6,16 @@ const tslib_1 = require("tslib");
 const archipel_platform_blob_storage_1 = require("@breadstone/archipel-platform-blob-storage");
 const archipel_platform_configuration_1 = require("@breadstone/archipel-platform-configuration");
 const archipel_platform_core_1 = require("@breadstone/archipel-platform-core");
+const archipel_platform_health_1 = require("@breadstone/archipel-platform-health");
+const archipel_platform_resources_1 = require("@breadstone/archipel-platform-resources");
 const common_1 = require("@nestjs/common");
-const env_1 = require("./env");
-const MailEventSubscriber_1 = require("./events/listeners/MailEventSubscriber");
-const MailTokens_1 = require("./MailTokens");
-const MailService_1 = require("./services/MailService");
-const MailVerificationService_1 = require("./services/MailVerificationService");
-const MailTemplateEngine_1 = require("./templating/MailTemplateEngine");
-const BlobTemplateFetchStrategy_1 = require("./templating/strategies/BlobTemplateFetchStrategy");
-const FileTemplateFetchStrategy_1 = require("./templating/strategies/FileTemplateFetchStrategy");
-const MailHealthIndicator_1 = require("./terminus/MailHealthIndicator");
+const env_1 = require("../env");
+const MailEventSubscriber_1 = require("../events/listeners/MailEventSubscriber");
+const MailTokens_1 = require("../MailTokens");
+const MailService_1 = require("../services/MailService");
+const MailVerificationService_1 = require("../services/MailVerificationService");
+const MailTemplateEngine_1 = require("../templating/MailTemplateEngine");
+const MailHealthIndicator_1 = require("../terminus/MailHealthIndicator");
 // #endregion
 /**
  * Represents the mail module.
@@ -32,49 +32,51 @@ exports.MailModule = MailModule = tslib_1.__decorate([
             archipel_platform_configuration_1.ConfigModule.register('platform-mailing', env_1.PLATFORM_MAILING_CONFIG_ENTRIES),
             archipel_platform_blob_storage_1.BlobModule,
             archipel_platform_core_1.EventModule,
-            archipel_platform_core_1.HealthModule,
+            archipel_platform_health_1.HealthModule,
         ],
         providers: [
             {
                 provide: MailTokens_1.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN,
-                useFactory: (configService, blobService, resourceManager) => {
+                useFactory: async (configService, blobService, resourceManager) => {
                     const templateStrategy = configService.get(env_1.MAIL_TEMPLATE_STRATEGY.key);
                     if (templateStrategy === 'file') {
-                        return new FileTemplateFetchStrategy_1.FileTemplateFetchStrategy(resourceManager);
+                        const { FileTemplateFetchStrategy } = await Promise.resolve().then(() => tslib_1.__importStar(require('../templating/strategies/FileTemplateFetchStrategy')));
+                        return new FileTemplateFetchStrategy(resourceManager);
                     }
                     if (templateStrategy === 'blob') {
-                        return new BlobTemplateFetchStrategy_1.BlobTemplateFetchStrategy(blobService);
+                        const { BlobTemplateFetchStrategy } = await Promise.resolve().then(() => tslib_1.__importStar(require('../templating/strategies/BlobTemplateFetchStrategy')));
+                        return new BlobTemplateFetchStrategy(blobService);
                     }
                     throw new Error(`Unknown template strategy: ${templateStrategy}`);
                 },
-                inject: [archipel_platform_configuration_1.ConfigService, archipel_platform_blob_storage_1.BlobService, archipel_platform_core_1.ResourceManager],
+                inject: [archipel_platform_configuration_1.ConfigService, archipel_platform_blob_storage_1.BlobService, archipel_platform_resources_1.ResourceManager],
             },
             {
                 provide: MailTokens_1.MAIL_DELIVERY_STRATEGY_TOKEN,
                 useFactory: async (configService) => {
                     const deliveryStrategy = configService.get(env_1.MAIL_DELIVERY_STRATEGY.key);
                     if (deliveryStrategy === 'log') {
-                        const { LogDeliveryStrategy } = await Promise.resolve().then(() => tslib_1.__importStar(require('./services/strategies/LogDeliveryStrategy')));
+                        const { LogDeliveryStrategy } = await Promise.resolve().then(() => tslib_1.__importStar(require('../services/strategies/LogDeliveryStrategy')));
                         return new LogDeliveryStrategy();
                     }
                     if (deliveryStrategy === 'smtp') {
-                        const { SmtpDeliveryStrategy } = await Promise.resolve().then(() => tslib_1.__importStar(require('./services/strategies/SmtpDeliveryStrategy')));
+                        const { SmtpDeliveryStrategy } = await Promise.resolve().then(() => tslib_1.__importStar(require('../services/strategies/SmtpDeliveryStrategy')));
                         return new SmtpDeliveryStrategy(configService);
                     }
                     if (deliveryStrategy === 'postmark') {
-                        const { PostmarkDeliveryStrategy } = await Promise.resolve().then(() => tslib_1.__importStar(require('./services/strategies/PostmarkDeliveryStrategy')));
+                        const { PostmarkDeliveryStrategy } = await Promise.resolve().then(() => tslib_1.__importStar(require('../services/strategies/PostmarkDeliveryStrategy')));
                         return new PostmarkDeliveryStrategy(configService);
                     }
                     if (deliveryStrategy === 'resend') {
-                        const { ResendDeliveryStrategy } = await Promise.resolve().then(() => tslib_1.__importStar(require('./services/strategies/ResendDeliveryStrategy')));
+                        const { ResendDeliveryStrategy } = await Promise.resolve().then(() => tslib_1.__importStar(require('../services/strategies/ResendDeliveryStrategy')));
                         return new ResendDeliveryStrategy(configService);
                     }
                     if (deliveryStrategy === 'sendgrid') {
-                        const { SendGridDeliveryStrategy } = await Promise.resolve().then(() => tslib_1.__importStar(require('./services/strategies/SendGridDeliveryStrategy')));
+                        const { SendGridDeliveryStrategy } = await Promise.resolve().then(() => tslib_1.__importStar(require('../services/strategies/SendGridDeliveryStrategy')));
                         return new SendGridDeliveryStrategy(configService);
                     }
                     if (deliveryStrategy === 'mailgun') {
-                        const { MailgunDeliveryStrategy } = await Promise.resolve().then(() => tslib_1.__importStar(require('./services/strategies/MailgunDeliveryStrategy')));
+                        const { MailgunDeliveryStrategy } = await Promise.resolve().then(() => tslib_1.__importStar(require('../services/strategies/MailgunDeliveryStrategy')));
                         return new MailgunDeliveryStrategy(configService);
                     }
                     throw new Error(`Unknown delivery strategy: ${deliveryStrategy}`);
@@ -93,7 +95,7 @@ exports.MailModule = MailModule = tslib_1.__decorate([
                     orchestrator.registerIndicator(indicator);
                     return true;
                 },
-                inject: [archipel_platform_core_1.HealthOrchestrator, MailHealthIndicator_1.MailHealthIndicator],
+                inject: [archipel_platform_health_1.HealthOrchestrator, MailHealthIndicator_1.MailHealthIndicator],
             },
         ],
         exports: [MailService_1.MailService, MailVerificationService_1.MailVerificationService, MailHealthIndicator_1.MailHealthIndicator],