@gravito/signal 1.0.0-alpha.3 → 1.0.0-alpha.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravito/signal",
-  "version": "1.0.0-alpha.3",
+  "version": "1.0.0-alpha.5",
   "description": "Powerful email framework for Gravito applications with Dev UI and multi-renderer support.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -26,11 +26,11 @@
     "nodemailer": "^6.9.1"
   },
   "peerDependencies": {
-    "gravito-core": "1.0.0-beta.2",
-    "@gravito/stream": "1.0.0-alpha.2",
-    "@gravito/prism": "^0.1.0",
-    "react": "^18.0.0",
-    "react-dom": "^18.0.0",
+    "gravito-core": "1.0.0-beta.4",
+    "@gravito/stream": "1.0.0-alpha.5",
+    "@gravito/prism": "1.0.0-beta.4",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
     "vue": "^3.0.0"
   },
   "peerDependenciesMeta": {
@@ -48,15 +48,15 @@
     }
   },
   "devDependencies": {
-    "@gravito/stream": "1.0.0-alpha.2",
-    "@gravito/prism": "^0.1.0",
+    "@gravito/prism": "1.0.0-beta.4",
+    "@gravito/stream": "1.0.0-alpha.5",
     "@types/mjml": "^4.7.4",
     "@types/nodemailer": "^6.4.14",
-    "@types/react": "^18.2.0",
-    "@types/react-dom": "^18.2.0",
+    "@types/react": "^19.0.0",
+    "@types/react-dom": "^19.0.0",
     "@vue/server-renderer": "^3.0.0",
-    "gravito-core": "1.0.0-beta.2",
-    "tsup": "^8.0.2",
+    "gravito-core": "1.0.0-beta.4",
+    "tsup": "8.5.1",
     "typescript": "^5.0.0",
     "vue": "^3.0.0"
   },
@@ -69,4 +69,4 @@
     "url": "git+https://github.com/gravito-framework/gravito.git",
     "directory": "packages/signal"
   }
-}
+}

package/src/OrbitSignal.ts

@@ -18,6 +18,9 @@ export class OrbitSignal implements GravitoOrbit {
 
   /**
    * Get the singleton instance of OrbitSignal
+   *
+   * @returns The singleton instance of OrbitSignal.
+   * @throws {Error} If OrbitSignal has not been initialized.
    */
   static getInstance(): OrbitSignal {
     if (!OrbitSignal.instance) {
@@ -28,6 +31,9 @@ export class OrbitSignal implements GravitoOrbit {
 
   /**
    * Configure the OrbitSignal instance
+   *
+   * @param config - The mail configuration object.
+   * @returns A new instance of OrbitSignal.
    */
   static configure(config: MailConfig): OrbitSignal {
     // Basic validation
@@ -40,6 +46,8 @@ export class OrbitSignal implements GravitoOrbit {
 
   /**
    * Install the orbit into PlanetCore
+   *
+   * @param core - The PlanetCore instance.
    */
   install(core: PlanetCore): void {
     core.logger.info('[OrbitSignal] Initializing Mail Service (Exposed as: mail)')
@@ -72,6 +80,10 @@ export class OrbitSignal implements GravitoOrbit {
 
   /**
    * Send a mailable instance
+   *
+   * @param mailable - The mailable object to send.
+   * @returns A promise that resolves when the email is sent.
+   * @throws {Error} If the message is missing "from" or "to" addresses, or if no transport is configured.
    */
   async send(mailable: Mailable): Promise<void> {
     // 1. Build envelope and get configuration
@@ -116,6 +128,9 @@ export class OrbitSignal implements GravitoOrbit {
    *
    * Push a mailable into the queue for execution.
    * Requires OrbitStream to be installed and available in the context.
+   *
+   * @param mailable - The mailable object to queue.
+   * @returns A promise that resolves when the job is pushed to the queue or sent immediately if no queue service is found.
    */
   async queue(mailable: Mailable): Promise<void> {
     // Try to get queue service from context.
@@ -136,14 +151,3 @@ export class OrbitSignal implements GravitoOrbit {
     }
   }
 }
-
-// Module augmentation for GravitoVariables (new abstraction)
-declare module 'gravito-core' {
-  interface GravitoVariables {
-    /** Mail service for sending emails */
-    mail?: {
-      send: (mailable: Mailable) => Promise<void>
-      queue: (mailable: Mailable) => Promise<void>
-    }
-  }
-}

package/src/augmentation.ts

@@ -0,0 +1,13 @@
+export {}
+
+// Module augmentation for GravitoVariables (new abstraction)
+declare module 'gravito-core' {
+  interface GravitoVariables {
+    /** Mail service for sending emails */
+    mail?: {
+      // Use any for params to break circularity in dts generation if any
+      send: (mailable: any) => Promise<void>
+      queue: (mailable: any) => Promise<void>
+    }
+  }
+}

package/src/dev/DevServer.ts

@@ -24,8 +24,11 @@ export class DevServer {
     // 2. Single Email Preview
     router.get(`${prefix}/:id`, (ctx) => {
       const id = ctx.req.param('id')
-      const entry = this.mailbox.get(id)
+      if (!id) {
+        return ctx.text('Bad Request', 400)
+      }
 
+      const entry = this.mailbox.get(id)
       if (!entry) {
         return ctx.text('Email not found', 404)
       }
@@ -35,6 +38,10 @@ export class DevServer {
     // 3. Iframe Content: HTML
     router.get(`${prefix}/:id/html`, (ctx) => {
       const id = ctx.req.param('id')
+      if (!id) {
+        return ctx.text('Bad Request', 400)
+      }
+
       const entry = this.mailbox.get(id)
       if (!entry) {
         return ctx.text('Not found', 404)
@@ -45,18 +52,26 @@ export class DevServer {
     // 4. Iframe Content: Text
     router.get(`${prefix}/:id/text`, (ctx) => {
       const id = ctx.req.param('id')
+      if (!id) {
+        return ctx.text('Bad Request', 400)
+      }
+
       const entry = this.mailbox.get(id)
       if (!entry) {
         return ctx.text('Not found', 404)
       }
-      return ctx.text(entry.text || 'No text content', 200, {
-        'Content-Type': 'text/plain; charset=utf-8',
-      })
+
+      ctx.header('Content-Type', 'text/plain; charset=utf-8')
+      return ctx.text(entry.text || 'No text content', 200)
     })
 
     // 5. Raw JSON
     router.get(`${prefix}/:id/raw`, (ctx) => {
       const id = ctx.req.param('id')
+      if (!id) {
+        return ctx.json({ error: 'Bad Request' }, 400)
+      }
+
       const entry = this.mailbox.get(id)
       if (!entry) {
         return ctx.json({ error: 'Not found' }, 404)
@@ -66,12 +81,16 @@ export class DevServer {
 
     // 6. API: Delete Single
     router.get(`${prefix}/:id/delete`, (ctx) => {
-      // Using GET for simple links/redirects without JS fetch if needed, but better use fetch from UI
-      // Actually let's accept POST or DELETE
       return ctx.text('Method not allowed', 405)
     })
+
     router.delete(`${prefix}/:id`, (ctx) => {
-      const success = this.mailbox.delete(ctx.req.param('id'))
+      const id = ctx.req.param('id')
+      if (!id) {
+        return ctx.json({ success: false, error: 'Bad Request' }, 400)
+      }
+
+      const success = this.mailbox.delete(id)
       return ctx.json({ success })
     })
 
@@ -81,9 +100,6 @@ export class DevServer {
       return ctx.json({ success: true })
     })
 
-    // Redirect /__mail/ to /__mail
-    // core.router.get(prefix + '/', (c) => c.redirect(prefix));
-
     core.logger.info(`[OrbitSignal] Dev Mailbox available at ${prefix}`)
   }
 }

package/src/index.ts

@@ -1,3 +1,5 @@
+import './augmentation'
+
 export type { Queueable } from '@gravito/stream'
 export { DevMailbox, type MailboxEntry } from './dev/DevMailbox'
 export { Mailable } from './Mailable'

package/src/renderers/ReactRenderer.ts

@@ -1,17 +1,18 @@
-import { type ComponentType, createElement } from 'react'
-import { renderToStaticMarkup } from 'react-dom/server'
 import type { Renderer, RenderResult } from './Renderer'
 
 export class ReactRenderer<P extends object = object> implements Renderer {
   constructor(
-    private component: ComponentType<P>,
+    private component: any, // Use any to avoid hard React dependency in types
     private props?: P
   ) {}
 
   async render(data: Record<string, unknown>): Promise<RenderResult> {
+    // Dynamic imports to avoid hard dependencies on react/react-dom
+    const { createElement } = await import('react')
+    const { renderToStaticMarkup } = await import('react-dom/server')
+
     const mergedProps = { ...this.props, ...data } as P
 
-    // We assume the component is a standard React component
     const element = createElement(this.component, mergedProps)
     const html = renderToStaticMarkup(element)
 

package/src/renderers/TemplateRenderer.ts

@@ -1,20 +1,22 @@
-import { TemplateEngine } from '@gravito/prism'
 import type { Renderer, RenderResult } from './Renderer'
 
 export class TemplateRenderer implements Renderer {
-  private engine: TemplateEngine
   private template: string
+  private viewsDir: string
 
   constructor(templateName: string, viewsDir?: string) {
     this.template = templateName
     // Default to src/emails if not provided, falling back to process cwd
-    const defaultDir = viewsDir || `${process.cwd()}/src/emails`
-    this.engine = new TemplateEngine(defaultDir)
+    this.viewsDir = viewsDir || `${process.cwd()}/src/emails`
   }
 
   async render(data: Record<string, unknown>): Promise<RenderResult> {
+    // Dynamic import to avoid hard dependency on @gravito/prism
+    const { TemplateEngine } = await import('@gravito/prism')
+    const engine = new TemplateEngine(this.viewsDir)
+
     // Disable automatic layout by default for emails, unless explicitly handled in template
-    const html = this.engine.render(this.template, data, {})
+    const html = engine.render(this.template, data, {})
 
     return {
       html,

package/src/renderers/VueRenderer.ts

@@ -1,14 +1,16 @@
-import { renderToString } from '@vue/server-renderer'
-import { type Component, createSSRApp, h } from 'vue'
 import type { Renderer, RenderResult } from './Renderer'
 
 export class VueRenderer<P extends object = object> implements Renderer {
   constructor(
-    private component: Component,
+    private component: any, // Use any to avoid hard Vue dependency in types
     private props?: P
   ) {}
 
   async render(data: Record<string, unknown>): Promise<RenderResult> {
+    // Dynamic imports to avoid hard dependencies on vue/@vue/server-renderer
+    const { createSSRApp, h } = await import('vue')
+    const { renderToString } = await import('@vue/server-renderer')
+
     const mergedProps = { ...this.props, ...data }
 
     const app = createSSRApp({