@talosjs/mailer 1.1.0 → 1.1.1

package/README.md

@@ -1,24 +1,6 @@
 # @talosjs/mailer
 
-Transactional email service supporting Nodemailer SMTP and Resend API -- send templated emails with attachments and delivery tracking.
-
-![Bun](https://img.shields.io/badge/Bun-Compatible-orange?style=flat-square&logo=bun)
-![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue?style=flat-square&logo=typescript)
-![MIT License](https://img.shields.io/badge/License-MIT-yellow?style=flat-square)
-
-## Features
-
-✅ **Resend API** - Send transactional emails via the Resend service
-
-✅ **React Templates** - Build email templates using React components with server-side rendering
-
-✅ **Layout System** - Pre-built email layout with header, body, and footer components
-
-✅ **Environment Configuration** - Configure sender and API keys via environment variables
-
-✅ **Container Integration** - Decorator-based registration with dependency injection
-
-✅ **Error Handling** - Comprehensive error handling with custom MailerException
+Transactional email service supporting Nodemailer SMTP and Resend API — send templated emails with attachments and delivery tracking
 
 ## Installation
 
@@ -26,393 +8,10 @@ Transactional email service supporting Nodemailer SMTP and Resend API -- send te
 bun add @talosjs/mailer
 ```
 
-## Usage
-
-### Basic Usage with Resend
-
-```typescript
-import { ResendMailer } from '@talosjs/mailer';
-
-const mailer = new ResendMailer({
-  apiKey: 'your-resend-api-key'
-});
-
-await mailer.send({
-  to: ['user@example.com'],
-  subject: 'Welcome to our platform!',
-  content: <WelcomeEmail userName="John" />
-});
-```
-
-### Using Nodemailer SMTP
-
-```typescript
-import { NodeMailerAdapter } from '@talosjs/mailer';
-
-const mailer = new NodeMailerAdapter({
-  host: 'smtp.example.com',
-  port: 587,
-  secure: false,
-  auth: {
-    user: 'your-username',
-    pass: 'your-password'
-  }
-});
-
-await mailer.send({
-  to: ['user@example.com'],
-  subject: 'Hello from Nodemailer!',
-  content: <SimpleEmail message="Hello World" />
-});
-```
-
-### With Environment Variables
-
-```typescript
-import { ResendMailer } from '@talosjs/mailer';
-
-// Automatically uses MAILER_RESEND_API_KEY environment variable
-const mailer = new ResendMailer();
-
-await mailer.send({
-  to: ['user@example.com'],
-  subject: 'Test Email',
-  content: <TestEmail />
-});
-```
-
-**Environment Variables:**
-- `MAILER_RESEND_API_KEY` - Resend API key
-- `MAILER_SMTP_HOST` - SMTP server host
-- `MAILER_SMTP_PORT` - SMTP server port
-- `MAILER_SMTP_USER` - SMTP username
-- `MAILER_SMTP_PASS` - SMTP password
-
-### Using the Email Layout
-
-```typescript
-import { MailerLayout } from '@talosjs/mailer';
-
-function WelcomeEmail({ userName }: { userName: string }) {
-  return (
-    <MailerLayout
-      title="Welcome"
-      previewText="Welcome to our platform!"
-    >
-      <h1>Hello, {userName}!</h1>
-      <p>Thank you for joining us.</p>
-      <a href="https://example.com/dashboard">Get Started</a>
-    </MailerLayout>
-  );
-}
-```
-
-### Custom Sender Information
-
-```typescript
-import { ResendMailer } from '@talosjs/mailer';
-
-const mailer = new ResendMailer();
-
-await mailer.send({
-  to: ['user@example.com'],
-  subject: 'Important Update',
-  content: <UpdateEmail />,
-  from: {
-    name: 'Support Team',
-    address: 'support@example.com'
-  }
-});
-```
-
-## API Reference
-
-### Classes
-
-#### `ResendMailer`
-
-Email adapter using the Resend API for sending emails.
-
-**Constructor:**
-```typescript
-new ResendMailer(options?: { apiKey?: string })
-```
-
-**Parameters:**
-- `options.apiKey` - Resend API key (optional if set via environment variable)
-
-**Methods:**
-
-##### `send(config: SendConfig): Promise<void>`
-
-Sends an email using the Resend API.
-
-**Parameters:**
-- `config.to` - Array of recipient email addresses
-- `config.subject` - Email subject line
-- `config.content` - React node to render as email body
-- `config.from` - Optional sender information
-
-**Example:**
-```typescript
-const mailer = new ResendMailer();
-
-await mailer.send({
-  to: ['recipient@example.com'],
-  subject: 'Welcome!',
-  content: <WelcomeEmail />
-});
-```
-
----
-
-#### `NodeMailerAdapter`
-
-Email adapter using Nodemailer for SMTP-based email sending.
-
-**Constructor:**
-```typescript
-new NodeMailerAdapter(options?: NodeMailerOptionsType)
-```
-
-**Parameters:**
-- `options.host` - SMTP server hostname
-- `options.port` - SMTP server port
-- `options.secure` - Use TLS (default: false for port 587)
-- `options.auth.user` - SMTP username
-- `options.auth.pass` - SMTP password
-
-**Methods:**
-
-##### `send(config: SendConfig): Promise<void>`
-
-Sends an email using SMTP.
-
-**Parameters:**
-Same as `ResendMailer.send()`
-
----
-
-#### `MailerLayout`
-
-React component providing a pre-styled email layout.
-
-**Props:**
-- `title` - Email title (for document head)
-- `previewText` - Preview text shown in email clients
-- `children` - Email content
-
-**Example:**
-```typescript
-<MailerLayout 
-  title="Order Confirmation" 
-  previewText="Your order has been confirmed"
->
-  <h1>Thank you for your order!</h1>
-  <p>Order #12345 has been confirmed.</p>
-</MailerLayout>
-```
-
-### Interfaces
-
-#### `IMailer`
-
-```typescript
-interface IMailer {
-  send: (config: {
-    to: string[];
-    subject: string;
-    content: React.ReactNode;
-    from?: { name: string; address: string };
-  }) => Promise<void>;
-}
-```
-
-### Types
-
-#### `MailerClassType`
-
-```typescript
-type MailerClassType = new (...args: any[]) => IMailer;
-```
-
-## Advanced Usage
-
-### Integration with Talos App
-
-```typescript
-import { App } from '@talosjs/app';
-import { ResendMailer } from '@talosjs/mailer';
-
-const app = new App({
-  mailer: ResendMailer,
-  // ... other config
-});
-
-await app.run();
-```
-
-### Using in Controllers
-
-```typescript
-import { Route } from '@talosjs/routing';
-import type { IController, ContextType } from '@talosjs/controller';
-
-@Route.http({
-  name: 'api.users.invite',
-  path: '/api/users/invite',
-  method: 'POST',
-  description: 'Send invitation email'
-})
-class InviteUserController implements IController {
-  public async index(context: ContextType): Promise<IResponse> {
-    const { email, name } = context.payload;
-    
-    await context.mailer?.send({
-      to: [email],
-      subject: 'You are invited!',
-      content: <InvitationEmail recipientName={name} />
-    });
-    
-    return context.response.json({ sent: true });
-  }
-}
-```
-
-### Container Registration with Decorator
-
-```typescript
-import { container } from '@talosjs/container';
-import { ResendMailer, decorator } from '@talosjs/mailer';
-
-// Register with container using decorator
-@decorator.mailer()
-class MyMailerService extends ResendMailer {
-  // Custom implementation
-}
-
-// Resolve from container
-const mailer = container.get(MyMailerService);
-```
-
-### Error Handling
-
-```typescript
-import { ResendMailer, MailerException } from '@talosjs/mailer';
-
-const mailer = new ResendMailer();
-
-try {
-  await mailer.send({
-    to: ['user@example.com'],
-    subject: 'Test',
-    content: <TestEmail />
-  });
-} catch (error) {
-  if (error instanceof MailerException) {
-    console.error('Mailer Error:', error.message);
-    // Handle email-specific error
-  }
-}
-```
-
-### Building Custom Email Templates
+## Documentation
 
-```typescript
-import { MailerLayout } from '@talosjs/mailer';
-
-interface OrderConfirmationProps {
-  orderId: string;
-  items: Array<{ name: string; price: number }>;
-  total: number;
-}
-
-function OrderConfirmationEmail({ orderId, items, total }: OrderConfirmationProps) {
-  return (
-    <MailerLayout
-      title="Order Confirmation"
-      previewText={`Order #${orderId} confirmed`}
-    >
-      <div style={{ fontFamily: 'Arial, sans-serif' }}>
-        <h1 style={{ color: '#333' }}>Order Confirmed!</h1>
-        <p>Order ID: <strong>{orderId}</strong></p>
-        
-        <table style={{ width: '100%', borderCollapse: 'collapse' }}>
-          <thead>
-            <tr>
-              <th style={{ textAlign: 'left', padding: '8px' }}>Item</th>
-              <th style={{ textAlign: 'right', padding: '8px' }}>Price</th>
-            </tr>
-          </thead>
-          <tbody>
-            {items.map((item, index) => (
-              <tr key={index}>
-                <td style={{ padding: '8px' }}>{item.name}</td>
-                <td style={{ textAlign: 'right', padding: '8px' }}>
-                  ${item.price.toFixed(2)}
-                </td>
-              </tr>
-            ))}
-          </tbody>
-          <tfoot>
-            <tr>
-              <td style={{ padding: '8px', fontWeight: 'bold' }}>Total</td>
-              <td style={{ textAlign: 'right', padding: '8px', fontWeight: 'bold' }}>
-                ${total.toFixed(2)}
-              </td>
-            </tr>
-          </tfoot>
-        </table>
-        
-        <p style={{ marginTop: '20px' }}>
-          Thank you for your purchase!
-        </p>
-      </div>
-    </MailerLayout>
-  );
-}
-```
-
-### Sending to Multiple Recipients
-
-```typescript
-import { ResendMailer } from '@talosjs/mailer';
-
-const mailer = new ResendMailer();
-
-await mailer.send({
-  to: [
-    'user1@example.com',
-    'user2@example.com',
-    'user3@example.com'
-  ],
-  subject: 'Team Announcement',
-  content: <AnnouncementEmail />
-});
-```
+Read the full documentation at [docs.talosjs.com/components/mailer](https://docs.talosjs.com/components/mailer).
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
-
-## Contributing
-
-Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
-
-### Development Setup
-
-1. Clone the repository
-2. Install dependencies: `bun install`
-3. Run tests: `bun run test`
-4. Build the project: `bun run build`
-
-### Guidelines
-
-- Write tests for new features
-- Follow the existing code style
-- Update documentation for API changes
-- Ensure all tests pass before submitting PR
-
----
-
-Made with ❤️ by the Talos team
+MIT

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@talosjs/mailer",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "module": "./dist/index.js",
   "dependencies": {
-    "@talosjs/app-env": "^1.1.0",
-    "@talosjs/container": "^1.1.0",
-    "@talosjs/exception": "^1.1.0",
-    "@talosjs/http-status": "^1.1.0",
-    "@talosjs/translation": "^1.1.0",
+    "@talosjs/app-env": "^1.1.2",
+    "@talosjs/container": "^1.1.1",
+    "@talosjs/exception": "^1.1.1",
+    "@talosjs/http-status": "^1.1.1",
+    "@talosjs/translation": "^1.1.1",
     "resend": "^6.4.2"
   },
   "exports": {
@@ -41,8 +41,8 @@
   "scripts": {
     "test": "bun test tests",
     "build": "bunup",
-    "lint": "tsgo --noEmit && bunx biome lint",
-    "npm:publish": "bun publish --tolerate-republish --force --production --access public"
+    "fmt": "bunx biome check --write",
+    "lint": "tsgo --noEmit && bunx biome lint"
   },
   "type": "module",
   "types": "./dist/index.d.ts"