@gravito/signal 1.0.0-alpha.2

package/README.md

@@ -0,0 +1,129 @@
+
+# Orbit Mail
+
+A powerful, multi-driver email framework for Gravito applications. Supports HTML, Template, React, and Vue renderers, with built-in development tools.
+
+## Features
+
+- **Multi-Driver Transport**: SMTP, AWS SES, Log, Memory.
+- **Content Renderers**:
+  - Raw HTML
+  - OrbitPrism Templates
+  - React Components (lazy-loaded)
+  - Vue Components (lazy-loaded)
+- **Development Mode**: Intercept emails and view them in a built-in UI (`/__mail`).
+- **Flexible API**: Fluent interface for building emails.
+- **Queue Support**: Built-in `Queueable` interface for async sending.
+
+## Installation
+
+```bash
+bun add @gravito/signal
+```
+
+For AWS SES support:
+```bash
+bun add @aws-sdk/client-ses
+```
+
+## Basic Usage
+
+### Configuration
+
+Configure OrbitSignal in your generic startup or creation logic:
+
+```typescript
+import { OrbitSignal, SmtpTransport } from '@gravito/signal';
+
+const mail = OrbitSignal.configure({
+  from: { name: 'My App', address: 'noreply@myapp.com' },
+  transport: new SmtpTransport({
+    host: 'smtp.mailtrap.io',
+    port: 2525,
+    auth: { user: '...', pass: '...' }
+  }),
+  devMode: process.env.NODE_ENV === 'development',
+});
+
+// Install into PlanetCore
+mail.install(core);
+```
+
+### Creating Mailables
+
+Extend the `Mailable` class to create email definitions.
+
+```typescript
+import { Mailable } from '@gravito/signal';
+
+export class WelcomeEmail extends Mailable {
+  constructor(private user: User) {
+    super();
+  }
+
+  build() {
+    return this
+      .to(this.user.email)
+      .subject('Welcome to Gravito!')
+      .view('emails/welcome', { name: this.user.name });
+  }
+}
+```
+
+### Sending Email
+
+```typescript
+import { WelcomeEmail } from './mail/WelcomeEmail';
+
+// In a controller/handler
+await new WelcomeEmail(user).renderContent(); // Validate content
+await context.get('mail').send(new WelcomeEmail(user));
+```
+
+### Queueing Email
+
+OrbitSignal supports queuing mail for background processing.
+
+```typescript
+const email = new WelcomeEmail(user)
+  .onQueue('high-priority')
+  .delay(60);
+
+// Queue the email
+await email.queue();
+```
+
+## Transports
+
+### SMTP
+Standard SMTP transport using `nodemailer`.
+
+### AWS SES
+Send via Amazon SES API.
+
+```typescript
+import { SesTransport } from '@gravito/signal';
+
+const transport = new SesTransport({
+  region: 'us-east-1',
+  accessKeyId: '...', // Optional if using environment variables
+  secretAccessKey: '...'
+});
+```
+
+### Log
+Logs email content to the console (useful for debugging).
+
+### Memory
+Stores emails in memory (used by Dev Mode).
+
+## Renderers
+
+- **html(string)**: Raw HTML string.
+- **view(template, data)**: Uses generic template engine.
+- **react(Component, props)**: Renders a React component to HTML.
+- **vue(Component, props)**: Renders a Vue component to HTML.
+
+## License
+
+MIT

package/dist/OrbitMail-2Z7ZTKYA.mjs

@@ -0,0 +1,7 @@
+import {
+  OrbitMail
+} from "./chunk-XAWO7RSP.mjs";
+import "./chunk-6DZX6EAA.mjs";
+export {
+  OrbitMail
+};

package/dist/OrbitMail-BGV32HWN.mjs

@@ -0,0 +1,7 @@
+import {
+  OrbitMail
+} from "./chunk-DT3R2TNV.mjs";
+import "./chunk-6DZX6EAA.mjs";
+export {
+  OrbitMail
+};

package/dist/OrbitMail-FUYZQSAV.mjs

@@ -0,0 +1,7 @@
+import {
+  OrbitMail
+} from "./chunk-OKRNL6PN.mjs";
+import "./chunk-6DZX6EAA.mjs";
+export {
+  OrbitMail
+};

package/dist/OrbitMail-NAPCRK7B.mjs

@@ -0,0 +1,7 @@
+import {
+  OrbitMail
+} from "./chunk-HHKFAMSE.mjs";
+import "./chunk-6DZX6EAA.mjs";
+export {
+  OrbitMail
+};

package/dist/OrbitMail-REGJ276B.mjs

@@ -0,0 +1,7 @@
+import {
+  OrbitMail
+} from "./chunk-3XFC4T6M.mjs";
+import "./chunk-6DZX6EAA.mjs";
+export {
+  OrbitMail
+};

package/dist/OrbitMail-TCFBJWDT.mjs

@@ -0,0 +1,7 @@
+import {
+  OrbitMail
+} from "./chunk-3U2CYJO5.mjs";
+import "./chunk-6DZX6EAA.mjs";
+export {
+  OrbitMail
+};

package/dist/OrbitMail-XZZW6U4N.mjs

@@ -0,0 +1,7 @@
+import {
+  OrbitMail
+} from "./chunk-ULN3GMY2.mjs";
+import "./chunk-6DZX6EAA.mjs";
+export {
+  OrbitMail
+};

package/dist/OrbitSignal-ZKKMEC27.mjs

@@ -0,0 +1,7 @@
+import {
+  OrbitSignal
+} from "./chunk-GADWIVC4.mjs";
+import "./chunk-6DZX6EAA.mjs";
+export {
+  OrbitSignal
+};

package/dist/ReactRenderer-L5INVYKT.mjs

@@ -0,0 +1,27 @@
+import "./chunk-6DZX6EAA.mjs";
+
+// src/renderers/ReactRenderer.ts
+import { createElement } from "react";
+import { renderToStaticMarkup } from "react-dom/server";
+var ReactRenderer = class {
+  constructor(component, props) {
+    this.component = component;
+    this.props = props;
+  }
+  async render(data) {
+    const mergedProps = { ...this.props, ...data };
+    const element = createElement(this.component, mergedProps);
+    const html = renderToStaticMarkup(element);
+    const fullHtml = html.startsWith("<!DOCTYPE") ? html : `<!DOCTYPE html>${html}`;
+    return {
+      html: fullHtml,
+      text: this.stripHtml(html)
+    };
+  }
+  stripHtml(html) {
+    return html.replace(/<style[^>]*>[\s\S]*?<\/style>/gi, "").replace(/<script[^>]*>[\s\S]*?<\/script>/gi, "").replace(/<[^>]+>/g, "").replace(/&nbsp;/g, " ").replace(/\s+/g, " ").trim();
+  }
+};
+export {
+  ReactRenderer
+};