@brilab-mailer/template-handlebars 0.0.1-beta.47

package/README.md

@@ -0,0 +1,80 @@
+# @brilab-mailer/template-handlebars
+
+## Overview
+This package provides a Handlebars-powered template rendering engine fully compatible with the Brilab Mailer architecture.
+
+It implements:
+
+```ts
+export interface MailerTemplateEngine {
+  render(templateName: string, context: unknown): Promise<string>;
+}
+```
+
+---
+
+## Features
+- Layout support  
+- Partials  
+- Helpers  
+- Async rendering  
+- Template caching  
+
+---
+
+## Folder Structure Recommendation
+
+```
+templates/
+  welcome.hbs
+  reset-password.hbs
+layouts/
+  main.hbs
+partials/
+  footer.hbs
+  header.hbs
+```
+
+---
+
+## Usage in MailerModule
+
+```ts
+MailerModule.register({
+  providerClass: MailtrapApiProvider,
+  templateEngineClass: HandlebarsTemplateEngine,
+});
+```
+
+---
+
+## Example Template
+
+`templates/welcome.hbs`
+```hbs
+<h1>Hello {{name}}!</h1>
+<p>Welcome to our platform.</p>
+```
+
+---
+
+## Example Render Call
+
+```ts
+const html = await this.mailer.render('welcome', { name: 'John' });
+```
+
+---
+
+## Performance
+- Precompilation optional  
+- Lazy loading template files  
+- Cache invalidation on demand  
+
+---
+
+## Best Practices
+- Avoid complex helper logic  
+- Use layouts for branding consistency  
+- Store templates outside the src folder in production  
+

package/index.d.ts

@@ -0,0 +1,2 @@
+export * from './lib/handlebars-template.engine.js';
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAC"}

package/index.js

@@ -0,0 +1 @@
+export * from './lib/handlebars-template.engine.js';

package/lib/handlebars-template.engine.d.ts

@@ -0,0 +1,12 @@
+import { ConfigService } from '@nestjs/config';
+import { MailerTemplateEngine } from '@brilab-mailer/contracts';
+export declare class HandlebarsTemplateEngine implements MailerTemplateEngine {
+    private readonly config;
+    private readonly templatesDir;
+    private readonly layoutsDir;
+    constructor(config: ConfigService);
+    private loadTemplate;
+    private loadLayout;
+    render(templateKey: string, context?: Record<string, any>, layoutKey?: string): Promise<string>;
+}
+//# sourceMappingURL=handlebars-template.engine.d.ts.map

package/lib/handlebars-template.engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handlebars-template.engine.d.ts","sourceRoot":"","sources":["../../src/lib/handlebars-template.engine.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EACN,oBAAoB,EACpB,MAAM,0BAA0B,CAAC;AAKlC,qBACa,wBAAyB,YAAW,oBAAoB;IAIxD,OAAO,CAAC,QAAQ,CAAC,MAAM;IAHnC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;gBAEP,MAAM,EAAE,aAAa;IAUlD,OAAO,CAAC,YAAY;IASpB,OAAO,CAAC,UAAU;IAQZ,MAAM,CACX,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM,EACjC,SAAS,SAAY,GACnB,OAAO,CAAC,MAAM,CAAC;CASlB"}

package/lib/handlebars-template.engine.js

@@ -0,0 +1,47 @@
+import { __decorate, __metadata } from "tslib";
+import { Injectable } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import * as fs from 'fs';
+import * as path from 'path';
+import * as Handlebars from 'handlebars';
+let HandlebarsTemplateEngine = class HandlebarsTemplateEngine {
+    config;
+    templatesDir;
+    layoutsDir;
+    constructor(config) {
+        this.config = config;
+        const rootDir = process.cwd();
+        const baseDir = this.config.get('MAIL_TEMPLATES_DIR') ||
+            path.join(rootDir, 'templates', 'emails');
+        this.templatesDir = baseDir;
+        this.layoutsDir = path.join(baseDir, 'layouts');
+    }
+    loadTemplate(key) {
+        const filePath = path.join(this.templatesDir, `${key}.hbs`);
+        if (!fs.existsSync(filePath)) {
+            throw new Error(`Template not found: ${filePath}`);
+        }
+        const source = fs.readFileSync(filePath, 'utf8');
+        return Handlebars.compile(source);
+    }
+    loadLayout(key) {
+        const filePath = path.join(this.layoutsDir, `${key}.hbs`);
+        if (!fs.existsSync(filePath))
+            return null;
+        const source = fs.readFileSync(filePath, 'utf8');
+        return Handlebars.compile(source);
+    }
+    async render(templateKey, context = {}, layoutKey = 'default') {
+        const template = this.loadTemplate(templateKey);
+        const bodyHtml = template(context);
+        const layout = this.loadLayout(layoutKey);
+        if (!layout)
+            return bodyHtml;
+        return layout({ ...context, body: bodyHtml });
+    }
+};
+HandlebarsTemplateEngine = __decorate([
+    Injectable(),
+    __metadata("design:paramtypes", [ConfigService])
+], HandlebarsTemplateEngine);
+export { HandlebarsTemplateEngine };

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@brilab-mailer/template-handlebars",
+  "version": "0.0.1-beta.47",
+  "author": "Bohdan Radchenko <radchenkobs@gmail.com>",
+  "type": "module",
+  "main": "./index.js",
+  "module": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
+    }
+  },
+  "files": [
+    "**/*",
+    "!**/*.tsbuildinfo"
+  ],
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "directory": "dist"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^10.0.0",
+    "@nestjs/config": "^3.0.0",
+    "@brilab-mailer/contracts": "^0.0.1",
+    "@brilab-mailer/core": "^0.0.1"
+  },
+  "peerDependenciesMeta": {
+    "@brilab-mailer/contracts": {
+      "optional": false
+    },
+    "@brilab-mailer/core": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "handlebars": "4.7.8"
+  }
+}