@spfn/notification 0.1.0-beta.1

package/dist/index-D_XTwHmO.d.ts

@@ -0,0 +1,170 @@
+/**
+ * @spfn/notification - Channel Types
+ */
+/**
+ * Channel types
+ */
+type NotificationChannel = 'email' | 'sms' | 'slack' | 'push';
+/**
+ * Send result
+ */
+interface SendResult {
+    success: boolean;
+    messageId?: string;
+    error?: string;
+}
+/**
+ * Channel provider interface
+ */
+interface ChannelProvider<TSendParams, TResult = SendResult> {
+    name: string;
+    send(params: TSendParams): Promise<TResult>;
+}
+
+/**
+ * @spfn/notification - Email Channel Types
+ */
+
+/**
+ * Parameters for sending email
+ */
+interface SendEmailParams {
+    /**
+     * Recipient email address(es)
+     */
+    to: string | string[];
+    /**
+     * Email subject (required if not using template)
+     */
+    subject?: string;
+    /**
+     * Template name
+     */
+    template?: string;
+    /**
+     * Template data for variable substitution
+     */
+    data?: Record<string, unknown>;
+    /**
+     * Plain text content (if not using template)
+     */
+    text?: string;
+    /**
+     * HTML content (if not using template)
+     */
+    html?: string;
+    /**
+     * From address (overrides default)
+     */
+    from?: string;
+    /**
+     * Reply-to address
+     */
+    replyTo?: string;
+}
+/**
+ * Email provider interface
+ */
+interface EmailProvider extends ChannelProvider<InternalSendEmailParams, SendResult> {
+    name: 'aws-ses' | 'sendgrid' | 'smtp' | string;
+}
+/**
+ * Internal send email params (after template rendering)
+ */
+interface InternalSendEmailParams {
+    to: string[];
+    from: string;
+    replyTo?: string;
+    subject: string;
+    text?: string;
+    html?: string;
+}
+
+/**
+ * @spfn/notification - SMS Channel Types
+ */
+
+/**
+ * Parameters for sending SMS
+ */
+interface SendSMSParams {
+    /**
+     * Phone number(s) in E.164 format (e.g., +821012345678)
+     */
+    to: string | string[];
+    /**
+     * Template name
+     */
+    template?: string;
+    /**
+     * Template data for variable substitution
+     */
+    data?: Record<string, unknown>;
+    /**
+     * Message content (if not using template)
+     */
+    message?: string;
+}
+/**
+ * SMS provider interface
+ */
+interface SMSProvider extends ChannelProvider<InternalSendSMSParams, SendResult> {
+    name: 'aws-sns' | 'twilio' | string;
+}
+/**
+ * Internal send SMS params (after template rendering)
+ */
+interface InternalSendSMSParams {
+    to: string;
+    message: string;
+}
+
+/**
+ * @spfn/notification - Template Types
+ */
+
+/**
+ * Email template content
+ */
+interface EmailTemplateContent {
+    subject: string;
+    html?: string;
+    text?: string;
+}
+/**
+ * SMS template content
+ */
+interface SmsTemplateContent {
+    message: string;
+}
+/**
+ * Slack template content
+ */
+interface SlackTemplateContent {
+    text?: string;
+    blocks?: unknown[];
+}
+/**
+ * Template definition
+ */
+interface TemplateDefinition {
+    name: string;
+    channels: NotificationChannel[];
+    email?: EmailTemplateContent;
+    sms?: SmsTemplateContent;
+    slack?: SlackTemplateContent;
+}
+/**
+ * Rendered template result
+ */
+interface RenderedTemplate {
+    email?: EmailTemplateContent;
+    sms?: SmsTemplateContent;
+    slack?: SlackTemplateContent;
+}
+/**
+ * Template data (variables for substitution)
+ */
+type TemplateData = Record<string, unknown>;
+
+export type { EmailProvider as E, NotificationChannel as N, RenderedTemplate as R, SendEmailParams as S, TemplateDefinition as T, SendResult as a, SendSMSParams as b, SMSProvider as c, TemplateData as d, EmailTemplateContent as e, SmsTemplateContent as f, SlackTemplateContent as g };

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { e as EmailTemplateContent, N as NotificationChannel, S as SendEmailParams, a as SendResult, b as SendSMSParams, g as SlackTemplateContent, f as SmsTemplateContent, d as TemplateData, T as TemplateDefinition } from './index-D_XTwHmO.js';

package/dist/index.js

@@ -0,0 +1 @@
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}