@ulthon/ul-opencode-event 0.1.0 → 0.1.1

package/README.md

@@ -142,6 +142,14 @@ You can configure multiple channels, and all enabled channels will receive notif
 1. Check if `enabled: true` is set
 2. Check if the event type is enabled in `events`
 3. Check SMTP credentials are correct
+4. Ensure plugin config file exists at `.opencode/ul-opencode-event.json`, `./ul-opencode-event.json`, or `~/.config/opencode/ul-opencode-event.json`
+5. Enable debug logs with environment variable `UL_OPENCODE_EVENT_DEBUG=1`
+
+### How to view logs
+
+- Start OpenCode from terminal to view stdout/stderr logs
+- Plugin logs use prefix `[ul-opencode-event]`
+- You will see errors for JSON parse failure, invalid config shape, and event handling failures
 
 ### SMTP authentication failed
 

package/dist/config.d.ts

@@ -1,4 +1,4 @@
-import type { NotificationConfig } from './types';
+import type { NotificationConfig } from './types.js';
 /**
  * Load and merge notification configuration
  *

package/dist/config.js

@@ -0,0 +1,151 @@
+import * as fs from 'fs';
+import * as path from 'path';
+import * as os from 'os';
+const SUPPORTED_CHANNEL_TYPES = ['smtp'];
+const LOG_PREFIX = '[ul-opencode-event]';
+const DEBUG_ENABLED = process.env.UL_OPENCODE_EVENT_DEBUG === '1' || process.env.UL_OPENCODE_EVENT_DEBUG === 'true';
+/**
+ * Default configuration returned when no config files exist
+ */
+const DEFAULT_CONFIG = {
+    channels: [],
+};
+/**
+ * Load and parse a JSON config file if it exists
+ */
+function loadConfigFile(filePath) {
+    try {
+        if (!fs.existsSync(filePath)) {
+            return null;
+        }
+        const content = fs.readFileSync(filePath, 'utf-8');
+        const config = JSON.parse(content);
+        if (!Array.isArray(config.channels)) {
+            console.error(`${LOG_PREFIX} Invalid config format in ${filePath}: "channels" must be an array`);
+            return null;
+        }
+        if (DEBUG_ENABLED) {
+            console.info(`${LOG_PREFIX} Loaded config: ${filePath} (${config.channels.length} channels)`);
+        }
+        return config;
+    }
+    catch (error) {
+        console.error(`${LOG_PREFIX} Failed to parse config file: ${filePath}`, error);
+        return null;
+    }
+}
+/**
+ * Validate that all channel types are supported
+ * @throws Error if any channel has an unsupported type
+ */
+function validateChannelTypes(channels) {
+    for (const channel of channels) {
+        if (!SUPPORTED_CHANNEL_TYPES.includes(channel.type)) {
+            throw new Error(`Unsupported channel type: "${channel.type}". Supported types: ${SUPPORTED_CHANNEL_TYPES.join(', ')}`);
+        }
+    }
+}
+/**
+ * Deep merge channels by name
+ * - If project channel name matches global channel name, project overrides global
+ * - If no name match, project channels are appended to global channels
+ */
+function mergeChannels(globalChannels, projectChannels) {
+    if (!globalChannels?.length && !projectChannels?.length) {
+        return [];
+    }
+    if (!globalChannels?.length) {
+        return projectChannels ?? [];
+    }
+    if (!projectChannels?.length) {
+        return globalChannels;
+    }
+    const result = [...globalChannels];
+    for (const projectChannel of projectChannels) {
+        const existingIndex = result.findIndex((c) => c.name !== undefined && c.name === projectChannel.name);
+        if (existingIndex >= 0) {
+            // Override global channel with project channel (same name)
+            result[existingIndex] = projectChannel;
+        }
+        else {
+            // Append project channel (no name match)
+            result.push(projectChannel);
+        }
+    }
+    return result;
+}
+/**
+ * Filter channels to only include enabled ones
+ * A channel is enabled if enabled is true or undefined (defaults to true)
+ */
+function filterEnabledChannels(channels) {
+    return channels.filter((channel) => channel.enabled !== false);
+}
+/**
+ * Get global config file path: ~/.config/opencode/ul-opencode-event.json
+ */
+function getGlobalConfigPath() {
+    return path.join(os.homedir(), '.config', 'opencode', 'ul-opencode-event.json');
+}
+/**
+ * Get project config file path
+ * Priority: .opencode/ul-opencode-event.json > ./ul-opencode-event.json
+ */
+function getProjectConfigPath() {
+    const opencodePath = path.join(process.cwd(), '.opencode', 'ul-opencode-event.json');
+    if (fs.existsSync(opencodePath)) {
+        return opencodePath;
+    }
+    const localPath = path.join(process.cwd(), 'ul-opencode-event.json');
+    if (fs.existsSync(localPath)) {
+        return localPath;
+    }
+    return null;
+}
+/**
+ * Load and merge notification configuration
+ *
+ * Config locations (in order of priority):
+ * 1. Project-level: .opencode/ul-opencode-event.json or ./ul-opencode-event.json
+ * 2. Global: ~/.config/opencode/ul-opencode-event.json
+ *
+ * Merge strategy:
+ * - Channels are merged by `name` field
+ * - If names match, project channel overrides global channel
+ * - If no name match, project channels are appended to global channels
+ *
+ * Filtering:
+ * - Only returns channels where enabled is true (or undefined, which defaults to true)
+ * - Channels with enabled: false are excluded
+ *
+ * Validation:
+ * - Channel type must be 'smtp' (only supported type in phase 1)
+ * - Throws clear error for unsupported channel types
+ *
+ * @returns Merged and filtered configuration, or default config if no files exist
+ * @throws Error if any channel has an unsupported type
+ */
+export function loadConfig() {
+    // Load global config
+    const globalConfigPath = getGlobalConfigPath();
+    const globalConfig = loadConfigFile(globalConfigPath);
+    // Load project config
+    const projectConfigPath = getProjectConfigPath();
+    const projectConfig = projectConfigPath ? loadConfigFile(projectConfigPath) : null;
+    // If no configs exist, return default
+    if (!globalConfig && !projectConfig) {
+        if (DEBUG_ENABLED) {
+            console.info(`${LOG_PREFIX} No config found. Checked: ${globalConfigPath}, ${path.join(process.cwd(), '.opencode', 'ul-opencode-event.json')}, ${path.join(process.cwd(), 'ul-opencode-event.json')}`);
+        }
+        return DEFAULT_CONFIG;
+    }
+    // Merge channels
+    const mergedChannels = mergeChannels(globalConfig?.channels, projectConfig?.channels);
+    // Validate channel types
+    validateChannelTypes(mergedChannels);
+    // Filter enabled channels
+    const enabledChannels = filterEnabledChannels(mergedChannels);
+    return {
+        channels: enabledChannels,
+    };
+}

package/dist/email.d.ts

@@ -1,4 +1,4 @@
-import type { Channel } from './types';
+import type { Channel } from './types.js';
 export interface EmailSender {
     send: (subject: string, body: string) => Promise<void>;
 }

package/dist/email.js

@@ -0,0 +1,56 @@
+/**
+ * Email sender module for SMTP-based notifications
+ */
+import * as nodemailer from 'nodemailer';
+/**
+ * Creates an email sender for the given SMTP channel
+ * @param channel - The channel configuration (must be SMTP type)
+ * @returns EmailSender instance or null if channel is invalid/disabled
+ */
+export function createEmailSender(channel) {
+    // Type guard: return null for non-smtp channels
+    if (channel.type !== 'smtp') {
+        return null;
+    }
+    // Return null for disabled channels
+    if (channel.enabled === false) {
+        return null;
+    }
+    // Return null if no recipients configured
+    if (!channel.recipients || channel.recipients.length === 0) {
+        return null;
+    }
+    const config = channel.config;
+    const fromName = channel.name || 'Notification';
+    // Create nodemailer transport with SMTP config
+    const transport = nodemailer.createTransport({
+        host: config.host,
+        port: config.port,
+        secure: config.secure,
+        auth: {
+            user: config.auth.user,
+            pass: config.auth.pass,
+        },
+    });
+    // Set security options
+    transport.set('disableFileAccess', true);
+    transport.set('disableUrlAccess', true);
+    return {
+        async send(subject, body) {
+            try {
+                await transport.sendMail({
+                    from: `"${fromName}" <${config.auth.user}>`,
+                    to: channel.recipients.join(', '),
+                    subject,
+                    html: body,
+                    text: body,
+                });
+            }
+            catch (error) {
+                // Silent failure: log error but don't throw
+                const timestamp = new Date().toISOString();
+                console.error(`[${timestamp}] [${fromName}] Failed to send email:`, error);
+            }
+        },
+    };
+}

package/dist/handler.d.ts

@@ -1,7 +1,7 @@
 /**
  * Multi-channel event handler for notifications
  */
-import type { NotificationConfig, EventPayload, EventType } from './types';
+import type { NotificationConfig, EventPayload, EventType } from './types.js';
 export interface EventHandler {
     handle: (eventType: EventType, payload: EventPayload) => Promise<void>;
 }

package/dist/handler.js

@@ -0,0 +1,78 @@
+import { renderTemplate } from './template.js';
+import { createEmailSender } from './email.js';
+// Default templates when channel doesn't have custom templates
+const defaultTemplates = {
+    created: {
+        subject: '[OpenCode] Task Started - {{projectName}}',
+        body: 'Task started at {{timestamp}}\nProject: {{projectName}}\nSession: {{sessionId}}',
+    },
+    idle: {
+        subject: '[OpenCode] Task Completed - {{projectName}}',
+        body: 'Task completed at {{timestamp}}\nDuration: {{duration}}\nMessage: {{message}}',
+    },
+    error: {
+        subject: '[OpenCode] Task Error - {{projectName}}',
+        body: 'Error at {{timestamp}}\nError: {{error}}',
+    },
+};
+/**
+ * Creates an event handler that dispatches notifications to all enabled channels
+ */
+export function createEventHandler(config) {
+    return {
+        handle: async (eventType, payload) => {
+            // Process each channel
+            for (const channel of config.channels) {
+                // Skip disabled channels
+                if (channel.enabled === false) {
+                    continue;
+                }
+                // Check if this event type is enabled for the channel
+                const eventEnabled = channel.events[eventType];
+                if (eventEnabled === false) {
+                    continue;
+                }
+                // Get template (channel-specific or default)
+                const template = channel.templates?.[eventType] ?? defaultTemplates[eventType];
+                // Prepare template variables from payload
+                const variables = {
+                    eventType: payload.eventType,
+                    timestamp: payload.timestamp,
+                    projectName: payload.projectName,
+                    sessionId: payload.sessionId,
+                    message: payload.message,
+                    error: payload.error,
+                    duration: payload.duration,
+                };
+                // Render templates
+                const subject = template.subject ? renderTemplate(template.subject, variables) : '';
+                const body = template.body ? renderTemplate(template.body, variables) : '';
+                // Dispatch based on channel type
+                await dispatchToChannel(channel, subject, body);
+            }
+        },
+    };
+}
+/**
+ * Dispatch notification to the appropriate channel sender
+ */
+async function dispatchToChannel(channel, subject, body) {
+    switch (channel.type) {
+        case 'smtp': {
+            const sender = createEmailSender(channel);
+            if (sender) {
+                await sender.send(subject, body);
+            }
+            break;
+        }
+        case 'feishu':
+        case 'dingtalk':
+            // Skip unsupported channel types silently
+            break;
+        default: {
+            // Log warning for unknown channel types
+            const _exhaustiveCheck = channel.type;
+            console.warn(`[EventHandler] Unsupported channel type: ${_exhaustiveCheck}`);
+        }
+    }
+}