@spfn/notification 0.1.0-beta.1

package/dist/server.d.ts

@@ -0,0 +1,683 @@
+export { NotificationConfig, configureNotification, getAppName, getEmailFrom, getEmailReplyTo, getNotificationConfig, getSmsDefaultCountryCode } from './config/index.js';
+import { S as SendEmailParams, a as SendResult, E as EmailProvider, b as SendSMSParams, c as SMSProvider, T as TemplateDefinition, d as TemplateData, N as NotificationChannel$1, R as RenderedTemplate } from './index-D_XTwHmO.js';
+export { e as EmailTemplateContent, g as SlackTemplateContent, f as SmsTemplateContent } from './index-D_XTwHmO.js';
+import * as drizzle_orm_pg_core from 'drizzle-orm/pg-core';
+import * as _spfn_core_job from '@spfn/core/job';
+import '@spfn/core/env';
+
+/**
+ * @spfn/notification - Email Channel
+ */
+
+/**
+ * Register custom email provider
+ */
+declare function registerEmailProvider(provider: EmailProvider): void;
+/**
+ * Send email
+ */
+declare function sendEmail(params: SendEmailParams): Promise<SendResult>;
+/**
+ * Send bulk emails
+ */
+declare function sendEmailBulk(items: SendEmailParams[]): Promise<{
+    results: SendResult[];
+    successCount: number;
+    failureCount: number;
+}>;
+
+/**
+ * @spfn/notification - SMS Channel
+ */
+
+/**
+ * Register custom SMS provider
+ */
+declare function registerSMSProvider(provider: SMSProvider): void;
+/**
+ * Send SMS
+ */
+declare function sendSMS(params: SendSMSParams): Promise<SendResult>;
+/**
+ * Send bulk SMS
+ */
+declare function sendSMSBulk(items: SendSMSParams[]): Promise<{
+    results: SendResult[];
+    successCount: number;
+    failureCount: number;
+}>;
+
+/**
+ * @spfn/notification - Schedule Service
+ *
+ * Schedule notifications for later delivery
+ */
+
+/**
+ * Schedule options
+ */
+interface ScheduleOptions {
+    /**
+     * When to send
+     */
+    scheduledAt: Date;
+    /**
+     * Reference to related entity
+     */
+    referenceType?: string;
+    referenceId?: string;
+}
+/**
+ * Result of scheduling
+ */
+interface ScheduleResult {
+    success: boolean;
+    notificationId?: number;
+    jobId?: string;
+    error?: string;
+}
+/**
+ * Schedule email for later delivery
+ */
+declare function scheduleEmail(params: SendEmailParams, options: ScheduleOptions): Promise<ScheduleResult>;
+/**
+ * Schedule SMS for later delivery
+ */
+declare function scheduleSMS(params: SendSMSParams, options: ScheduleOptions): Promise<ScheduleResult>;
+
+/**
+ * @spfn/notification - Template Registry
+ */
+
+/**
+ * Register a template
+ */
+declare function registerTemplate(template: TemplateDefinition): void;
+/**
+ * Get template by name
+ */
+declare function getTemplate(name: string): TemplateDefinition | undefined;
+/**
+ * Check if template exists
+ */
+declare function hasTemplate(name: string): boolean;
+/**
+ * Render template with data
+ */
+declare function renderTemplate(name: string, data: TemplateData, channel?: NotificationChannel$1): RenderedTemplate;
+/**
+ * Get all registered template names
+ */
+declare function getTemplateNames(): string[];
+
+/**
+ * @spfn/notification - Template Renderer
+ *
+ * Simple template engine with variable substitution and filters
+ *
+ * Syntax:
+ * - {{variable}} - Basic substitution
+ * - {{variable | filter}} - With filter
+ * - {{variable | filter:arg}} - Filter with argument
+ */
+
+/**
+ * Register custom filter
+ */
+declare function registerFilter(name: string, fn: (value: unknown, arg?: string) => string): void;
+
+/**
+ * @spfn/notification - Template System
+ */
+
+/**
+ * Register all built-in templates
+ */
+declare function registerBuiltinTemplates(): void;
+
+/**
+ * @spfn/notification - Notifications Entity
+ *
+ * Stores notification sending history for tracking and auditing
+ */
+/**
+ * Notification channel types
+ */
+declare const NOTIFICATION_CHANNELS: readonly ["email", "sms", "slack", "push"];
+type NotificationChannel = typeof NOTIFICATION_CHANNELS[number];
+/**
+ * Notification status types
+ */
+declare const NOTIFICATION_STATUSES: readonly ["scheduled", "pending", "sent", "failed", "cancelled"];
+type NotificationStatus = typeof NOTIFICATION_STATUSES[number];
+/**
+ * Notifications table - stores all notification sending history
+ */
+declare const notifications: drizzle_orm_pg_core.PgTableWithColumns<{
+    name: "history";
+    schema: string;
+    columns: {
+        createdAt: drizzle_orm_pg_core.PgColumn<{
+            name: "created_at";
+            tableName: "history";
+            dataType: "date";
+            columnType: "PgTimestamp";
+            data: Date;
+            driverParam: string;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        updatedAt: drizzle_orm_pg_core.PgColumn<{
+            name: "updated_at";
+            tableName: "history";
+            dataType: "date";
+            columnType: "PgTimestamp";
+            data: Date;
+            driverParam: string;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        id: drizzle_orm_pg_core.PgColumn<{
+            name: "id";
+            tableName: "history";
+            dataType: "number";
+            columnType: "PgBigSerial53";
+            data: number;
+            driverParam: number;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: true;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        channel: drizzle_orm_pg_core.PgColumn<{
+            name: "channel";
+            tableName: "history";
+            dataType: "string";
+            columnType: "PgText";
+            data: "email" | "sms" | "slack" | "push";
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: ["email", "sms", "slack", "push"];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        recipient: drizzle_orm_pg_core.PgColumn<{
+            name: "recipient";
+            tableName: "history";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        templateName: drizzle_orm_pg_core.PgColumn<{
+            name: "template_name";
+            tableName: "history";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        templateData: drizzle_orm_pg_core.PgColumn<{
+            name: "template_data";
+            tableName: "history";
+            dataType: "json";
+            columnType: "PgJsonb";
+            data: unknown;
+            driverParam: unknown;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        subject: drizzle_orm_pg_core.PgColumn<{
+            name: "subject";
+            tableName: "history";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        content: drizzle_orm_pg_core.PgColumn<{
+            name: "content";
+            tableName: "history";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        status: drizzle_orm_pg_core.PgColumn<{
+            name: "status";
+            tableName: "history";
+            dataType: "string";
+            columnType: "PgText";
+            data: "scheduled" | "pending" | "sent" | "failed" | "cancelled";
+            driverParam: string;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: ["scheduled", "pending", "sent", "failed", "cancelled"];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        providerMessageId: drizzle_orm_pg_core.PgColumn<{
+            name: "provider_message_id";
+            tableName: "history";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        providerName: drizzle_orm_pg_core.PgColumn<{
+            name: "provider_name";
+            tableName: "history";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        errorMessage: drizzle_orm_pg_core.PgColumn<{
+            name: "error_message";
+            tableName: "history";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        scheduledAt: drizzle_orm_pg_core.PgColumn<{
+            name: string;
+            tableName: "history";
+            dataType: "date";
+            columnType: "PgTimestamp";
+            data: Date;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        sentAt: drizzle_orm_pg_core.PgColumn<{
+            name: string;
+            tableName: "history";
+            dataType: "date";
+            columnType: "PgTimestamp";
+            data: Date;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        jobId: drizzle_orm_pg_core.PgColumn<{
+            name: "job_id";
+            tableName: "history";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        batchId: drizzle_orm_pg_core.PgColumn<{
+            name: "batch_id";
+            tableName: "history";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        referenceType: drizzle_orm_pg_core.PgColumn<{
+            name: "reference_type";
+            tableName: "history";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        referenceId: drizzle_orm_pg_core.PgColumn<{
+            name: "reference_id";
+            tableName: "history";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+    };
+    dialect: "pg";
+}>;
+/**
+ * Type inference
+ */
+type Notification = typeof notifications.$inferSelect;
+type NewNotification = typeof notifications.$inferInsert;
+
+/**
+ * @spfn/notification - Notification Service
+ *
+ * Core service for tracking notification history
+ */
+
+/**
+ * Create notification record (pending status)
+ */
+declare function createNotificationRecord(data: Omit<NewNotification, 'id' | 'createdAt' | 'updatedAt'>): Promise<Notification>;
+/**
+ * Create scheduled notification record
+ */
+declare function createScheduledNotification(data: Omit<NewNotification, 'id' | 'createdAt' | 'updatedAt' | 'status'> & {
+    scheduledAt: Date;
+}): Promise<Notification>;
+/**
+ * Update job ID for scheduled notification
+ */
+declare function updateNotificationJobId(id: number, jobId: string): Promise<Notification | null>;
+/**
+ * Mark notification as sent
+ */
+declare function markNotificationSent(id: number, providerMessageId?: string): Promise<Notification | null>;
+/**
+ * Mark notification as failed
+ */
+declare function markNotificationFailed(id: number, errorMessage: string): Promise<Notification | null>;
+/**
+ * Mark scheduled notification as pending (job started)
+ */
+declare function markNotificationPending(id: number): Promise<Notification | null>;
+/**
+ * Cancel scheduled notification
+ */
+declare function cancelScheduledNotification(id: number): Promise<Notification | null>;
+/**
+ * Find notification by job ID
+ */
+declare function findNotificationByJobId(jobId: string): Promise<Notification | null>;
+/**
+ * Query options for finding notifications
+ */
+interface FindNotificationsOptions {
+    channel?: NotificationChannel;
+    status?: NotificationStatus;
+    recipient?: string;
+    referenceType?: string;
+    referenceId?: string;
+    from?: Date;
+    to?: Date;
+    limit?: number;
+    offset?: number;
+}
+/**
+ * Find notifications with filters
+ */
+declare function findNotifications(options?: FindNotificationsOptions): Promise<Notification[]>;
+/**
+ * Count notifications with filters
+ */
+declare function countNotifications(options?: Omit<FindNotificationsOptions, 'limit' | 'offset'>): Promise<number>;
+/**
+ * Get notification statistics
+ */
+interface NotificationStats {
+    total: number;
+    scheduled: number;
+    pending: number;
+    sent: number;
+    failed: number;
+    cancelled: number;
+}
+declare function getNotificationStats(options?: {
+    channel?: NotificationChannel;
+    from?: Date;
+    to?: Date;
+}): Promise<NotificationStats>;
+/**
+ * Find scheduled notifications (for dashboard)
+ */
+declare function findScheduledNotifications(options?: {
+    channel?: NotificationChannel;
+    from?: Date;
+    to?: Date;
+    limit?: number;
+    offset?: number;
+}): Promise<Notification[]>;
+
+/**
+ * @spfn/notification - Cancel Service
+ *
+ * Cancel scheduled notifications
+ */
+interface CancelResult {
+    success: boolean;
+    error?: string;
+}
+/**
+ * Cancel a scheduled notification by ID
+ */
+declare function cancelNotification(notificationId: number): Promise<CancelResult>;
+/**
+ * Cancel all scheduled notifications for a reference
+ */
+declare function cancelNotificationsByReference(referenceType: string, referenceId: string): Promise<{
+    cancelled: number;
+    errors: number;
+}>;
+
+/**
+ * @spfn/notification - Scheduled Email Job
+ */
+/**
+ * Scheduled email sending job
+ */
+declare const sendScheduledEmailJob: _spfn_core_job.JobDef<{
+    subject?: string | undefined;
+    html?: string | undefined;
+    text?: string | undefined;
+    data?: {
+        [x: string]: unknown;
+    } | undefined;
+    from?: string | undefined;
+    template?: string | undefined;
+    replyTo?: string | undefined;
+    to: string | string[];
+    notificationId: number;
+}, void>;
+
+/**
+ * @spfn/notification - Scheduled SMS Job
+ */
+/**
+ * Scheduled SMS sending job
+ */
+declare const sendScheduledSmsJob: _spfn_core_job.JobDef<{
+    message?: string | undefined;
+    data?: {
+        [x: string]: unknown;
+    } | undefined;
+    template?: string | undefined;
+    to: string | string[];
+    notificationId: number;
+}, void>;
+
+/**
+ * @spfn/notification - Job Router
+ */
+/**
+ * Notification job router
+ *
+ * Register this with your server config:
+ * @example
+ * ```typescript
+ * import { notificationJobRouter } from '@spfn/notification/server';
+ *
+ * defineServerConfig()
+ *     .routes(appRouter)
+ *     .jobs(defineJobRouter({
+ *         notification: notificationJobRouter,
+ *         // ... other jobs
+ *     }))
+ *     .build();
+ * ```
+ */
+declare const notificationJobRouter: _spfn_core_job.JobRouter<{
+    sendScheduledEmail: _spfn_core_job.JobDef<{
+        subject?: string | undefined;
+        html?: string | undefined;
+        text?: string | undefined;
+        data?: {
+            [x: string]: unknown;
+        } | undefined;
+        from?: string | undefined;
+        template?: string | undefined;
+        replyTo?: string | undefined;
+        to: string | string[];
+        notificationId: number;
+    }, void>;
+    sendScheduledSms: _spfn_core_job.JobDef<{
+        message?: string | undefined;
+        data?: {
+            [x: string]: unknown;
+        } | undefined;
+        template?: string | undefined;
+        to: string | string[];
+        notificationId: number;
+    }, void>;
+}>;
+
+export { type CancelResult, EmailProvider, type FindNotificationsOptions, NOTIFICATION_CHANNELS, NOTIFICATION_STATUSES, type NewNotification, type Notification, NotificationChannel$1 as NotificationChannel, type NotificationStats, type NotificationStatus, SMSProvider, type ScheduleOptions, type ScheduleResult, SendEmailParams, SendResult, SendSMSParams, TemplateData, TemplateDefinition, cancelNotification, cancelNotificationsByReference, cancelScheduledNotification, countNotifications, createNotificationRecord, createScheduledNotification, findNotificationByJobId, findNotifications, findScheduledNotifications, getNotificationStats, getTemplate, getTemplateNames, hasTemplate, markNotificationFailed, markNotificationPending, markNotificationSent, notificationJobRouter, notifications, registerBuiltinTemplates, registerEmailProvider, registerFilter, registerSMSProvider, registerTemplate, renderTemplate, scheduleEmail, scheduleSMS, sendEmail, sendEmailBulk, sendSMS, sendSMSBulk, sendScheduledEmailJob, sendScheduledSmsJob, updateNotificationJobId };