@k-msg/provider 0.1.1 → 0.1.3

package/dist/contracts/provider.contract.d.ts

@@ -0,0 +1,355 @@
+export interface ProviderResponse {
+    success: boolean;
+    data?: unknown;
+    error?: {
+        code: string;
+        message: string;
+        details?: Record<string, unknown>;
+    };
+}
+export interface TemplateVariable {
+    name: string;
+    type: string;
+    required: boolean;
+    description?: string;
+}
+export interface TemplateButton {
+    type: string;
+    title: string;
+    url?: string;
+}
+export interface AlimTalkTemplate {
+    id: string;
+    name: string;
+    content: string;
+    variables?: TemplateVariable[];
+    buttons?: TemplateButton[];
+}
+export interface Channel {
+    id: string;
+    name: string;
+    profileKey: string;
+    status: "active" | "inactive" | "pending" | "blocked";
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface SenderNumber {
+    id: string;
+    channelId: string;
+    phoneNumber: string;
+    isVerified: boolean;
+    verifiedAt?: Date;
+    createdAt: Date;
+}
+import type { BaseProvider, StandardRequest, StandardResult } from "@k-msg/core";
+export interface AlimTalkRequest extends StandardRequest {
+    templateCode: string;
+    phoneNumber: string;
+    variables: Record<string, any>;
+    senderNumber?: string;
+    options?: MessageOptions;
+}
+export interface AlimTalkResult extends StandardResult {
+    messageId: string;
+    status: any;
+    provider: string;
+    timestamp: Date;
+    templateCode: string;
+    phoneNumber: string;
+    deliveredAt?: Date;
+    error?: ProviderError;
+}
+export interface AlimTalkProvider extends BaseProvider<AlimTalkRequest, AlimTalkResult> {
+    readonly type: "messaging";
+    readonly capabilities: ProviderCapabilities;
+    templates: TemplateContract;
+    channels: ChannelContract;
+    messaging: MessagingContract;
+    analytics: AnalyticsContract;
+    account: AccountContract;
+}
+export interface ProviderCapabilities {
+    templates: {
+        maxLength: number;
+        maxVariables: number;
+        maxButtons: number;
+        supportedButtonTypes: string[];
+        requiresApproval: boolean;
+        approvalTime: string;
+    };
+    messaging: {
+        maxRecipientsPerRequest: number;
+        maxRequestsPerSecond: number;
+        supportsBulk: boolean;
+        supportsScheduling: boolean;
+        maxScheduleDays: number;
+        supportsFallback: boolean;
+    };
+    channels: {
+        requiresBusinessVerification: boolean;
+        maxSenderNumbers: number;
+        supportsMultipleChannels: boolean;
+    };
+}
+export interface TemplateContract {
+    create(template: TemplateCreateRequest): Promise<TemplateCreateResult>;
+    update(templateId: string, template: TemplateUpdateRequest): Promise<TemplateUpdateResult>;
+    delete(templateId: string): Promise<void>;
+    get(templateId: string): Promise<ProviderTemplate>;
+    list(filters?: TemplateFilters): Promise<ProviderTemplate[]>;
+    sync(): Promise<SyncResult>;
+}
+export interface TemplateCreateRequest {
+    name: string;
+    content: string;
+    variables: TemplateVariableDefinition[];
+    buttons?: TemplateButtonDefinition[];
+    category?: string;
+}
+export interface TemplateUpdateRequest {
+    name?: string;
+    content?: string;
+    variables?: TemplateVariableDefinition[];
+    buttons?: TemplateButtonDefinition[];
+}
+export interface TemplateCreateResult {
+    templateId: string;
+    providerTemplateCode: string;
+    status: TemplateStatus;
+    message?: string;
+}
+export interface TemplateUpdateResult {
+    templateId: string;
+    status: TemplateStatus;
+    message?: string;
+}
+export interface ProviderTemplate {
+    id: string;
+    code: string;
+    name: string;
+    content: string;
+    status: TemplateStatus;
+    createdAt: Date;
+    updatedAt: Date;
+    approvedAt?: Date;
+    rejectedAt?: Date;
+    rejectionReason?: string;
+}
+export declare enum TemplateStatus {
+    DRAFT = "DRAFT",
+    PENDING = "PENDING",
+    APPROVED = "APPROVED",
+    REJECTED = "REJECTED",
+    DISABLED = "DISABLED"
+}
+export interface TemplateVariableDefinition {
+    name: string;
+    type: string;
+    required: boolean;
+    maxLength?: number;
+    format?: string;
+}
+export interface TemplateButtonDefinition {
+    type: string;
+    name: string;
+    linkMobile?: string;
+    linkPc?: string;
+    linkIos?: string;
+    linkAndroid?: string;
+    schemeIos?: string;
+    schemeAndroid?: string;
+}
+export interface TemplateFilters {
+    status?: TemplateStatus;
+    category?: string;
+    createdAfter?: Date;
+    createdBefore?: Date;
+    page?: number;
+    size?: number;
+}
+export interface SyncResult {
+    synced: number;
+    created: number;
+    updated: number;
+    deleted: number;
+    errors: SyncError[];
+}
+export interface SyncError {
+    templateId: string;
+    error: string;
+}
+export interface ChannelContract {
+    register(channel: ChannelRequest): Promise<Channel>;
+    list(): Promise<Channel[]>;
+    addSenderNumber(channelId: string, number: string): Promise<SenderNumber>;
+    verifySenderNumber(number: string, verificationCode: string): Promise<boolean>;
+}
+export interface ChannelRequest {
+    name: string;
+    profileKey: string;
+    businessInfo?: BusinessInfo;
+}
+export interface BusinessInfo {
+    name: string;
+    registrationNumber: string;
+    category: string;
+    contactPerson: string;
+    contactEmail: string;
+    contactPhone: string;
+}
+export interface MessagingContract {
+    send(message: ProviderMessageRequest): Promise<ProviderMessageResult>;
+    sendBulk(messages: ProviderMessageRequest[]): Promise<ProviderBulkResult>;
+    schedule(message: ProviderMessageRequest, scheduledAt: Date): Promise<ScheduleResult>;
+    cancel(messageId: string): Promise<void>;
+    getStatus(messageId: string): Promise<MessageStatus>;
+}
+export interface ProviderMessageRequest {
+    templateCode: string;
+    phoneNumber: string;
+    variables: Record<string, unknown>;
+    senderNumber?: string;
+    options?: MessageOptions;
+}
+export interface MessageOptions {
+    priority?: "high" | "normal" | "low";
+    ttl?: number;
+    tracking?: boolean;
+    webhookUrl?: string;
+    scheduledAt?: Date;
+}
+export interface ProviderMessageResult {
+    messageId: string;
+    status: MessageStatus;
+    sentAt?: Date;
+    error?: ProviderError;
+}
+export interface ProviderBulkResult {
+    requestId: string;
+    results: ProviderMessageResult[];
+    summary: {
+        total: number;
+        sent: number;
+        failed: number;
+    };
+}
+export interface ScheduleResult {
+    scheduleId: string;
+    messageId: string;
+    scheduledAt: Date;
+    status: "scheduled" | "cancelled";
+}
+export declare enum MessageStatus {
+    QUEUED = "QUEUED",
+    SENDING = "SENDING",
+    SENT = "SENT",
+    DELIVERED = "DELIVERED",
+    FAILED = "FAILED",
+    CANCELLED = "CANCELLED"
+}
+export interface ProviderError {
+    code: any;
+    message: string;
+    retryable: boolean;
+    details?: Record<string, any>;
+}
+export interface AnalyticsContract {
+    getUsage(period: DateRange): Promise<UsageStats>;
+    getTemplateStats(templateId: string, period: DateRange): Promise<TemplateStats>;
+    getDeliveryReport(messageId: string): Promise<DeliveryReport>;
+}
+export interface DateRange {
+    from: Date;
+    to: Date;
+}
+export interface UsageStats {
+    period: DateRange;
+    totalMessages: number;
+    sentMessages: number;
+    deliveredMessages: number;
+    failedMessages: number;
+    deliveryRate: number;
+    failureRate: number;
+    breakdown: {
+        byTemplate: Record<string, number>;
+        byDay: Record<string, number>;
+        byHour: Record<string, number>;
+    };
+}
+export interface TemplateStats {
+    templateId: string;
+    period: DateRange;
+    totalSent: number;
+    delivered: number;
+    failed: number;
+    clickRate?: number;
+    deliveryRate: number;
+    averageDeliveryTime: number;
+}
+export interface DeliveryReport {
+    messageId: string;
+    phoneNumber: string;
+    templateCode: string;
+    status: MessageStatus;
+    sentAt?: Date;
+    deliveredAt?: Date;
+    failedAt?: Date;
+    clickedAt?: Date;
+    error?: ProviderError;
+    attempts: DeliveryAttempt[];
+}
+export interface DeliveryAttempt {
+    attemptNumber: number;
+    attemptedAt: Date;
+    status: MessageStatus;
+    error?: ProviderError;
+}
+export interface AccountContract {
+    getBalance(): Promise<Balance>;
+    getProfile(): Promise<AccountProfile>;
+}
+export interface Balance {
+    current: number;
+    currency: string;
+    lastUpdated: Date;
+    threshold?: number;
+}
+export interface AccountProfile {
+    accountId: string;
+    name: string;
+    email: string;
+    phone: string;
+    status: "active" | "suspended" | "blocked";
+    tier: "basic" | "standard" | "premium" | "enterprise";
+    features: string[];
+    limits: {
+        dailyMessageLimit: number;
+        monthlyMessageLimit: number;
+        rateLimit: number;
+    };
+}
+export interface ProviderRegistration {
+    id: string;
+    name: string;
+    description: string;
+    version: string;
+    capabilities: ProviderCapabilities;
+    configuration: ProviderConfiguration;
+}
+export interface ProviderConfiguration {
+    required: ConfigurationField[];
+    optional: ConfigurationField[];
+}
+export interface ConfigurationField {
+    key: string;
+    name: string;
+    type: "string" | "number" | "boolean" | "password" | "url";
+    description: string;
+    required: boolean;
+    default?: unknown;
+    validation?: {
+        pattern?: string;
+        min?: number;
+        max?: number;
+    };
+}

package/dist/contracts/sms.contract.d.ts

@@ -0,0 +1,135 @@
+import type { BaseProvider, DeliveryStatus } from "@k-msg/core";
+export interface SMSRequest {
+    phoneNumber: string;
+    text: string;
+    senderNumber?: string;
+    options?: SMSOptions;
+}
+export interface SMSOptions {
+    priority?: "high" | "normal" | "low";
+    encoding?: "UTF-8" | "EUC-KR";
+    scheduledAt?: Date;
+    subject?: string;
+    messageType?: "SMS" | "LMS";
+}
+export interface SMSResult {
+    messageId: string;
+    status: DeliveryStatus;
+    provider: string;
+    timestamp: Date;
+    phoneNumber: string;
+    messageType: "SMS" | "LMS";
+    deliveredAt?: Date;
+    error?: SMSError;
+}
+export interface BulkSMSResult {
+    requestId: string;
+    results: SMSResult[];
+    summary: {
+        total: number;
+        sent: number;
+        failed: number;
+    };
+}
+export interface SMSError {
+    code: string;
+    message: string;
+    retryable: boolean;
+    details?: Record<string, unknown>;
+}
+export interface SMSProvider extends BaseProvider<SMSRequest, SMSResult> {
+    readonly type: "sms";
+    sendBulkSMS?(requests: SMSRequest[]): Promise<BulkSMSResult>;
+    sms: SMSContract;
+    account: SMSAccountContract;
+}
+export interface SMSContract {
+    send(request: SMSSendRequest): Promise<SMSResult>;
+    sendBulk?(requests: SMSSendRequest[]): Promise<BulkSMSResult>;
+    schedule?(request: SMSSendRequest, scheduledAt: Date): Promise<ScheduleResult>;
+    cancel?(messageId: string): Promise<void>;
+    getStatus(messageId: string): Promise<SMSStatus>;
+}
+export interface SMSSendRequest {
+    phoneNumber: string;
+    text: string;
+    senderNumber?: string;
+    messageType?: "SMS" | "LMS";
+    subject?: string;
+    options?: SMSSendOptions;
+}
+export interface SMSSendOptions {
+    priority?: "high" | "normal" | "low";
+    encoding?: "UTF-8" | "EUC-KR";
+    webhookUrl?: string;
+    tracking?: boolean;
+    scheduledAt?: Date;
+}
+export interface ScheduleResult {
+    scheduleId: string;
+    messageId: string;
+    scheduledAt: Date;
+    status: "scheduled" | "cancelled";
+}
+export declare enum SMSStatus {
+    QUEUED = "QUEUED",
+    SENDING = "SENDING",
+    SENT = "SENT",
+    DELIVERED = "DELIVERED",
+    FAILED = "FAILED",
+    CANCELLED = "CANCELLED"
+}
+export interface SMSAccountContract {
+    getBalance(): Promise<SMSBalance>;
+    getProfile(): Promise<SMSAccountProfile>;
+    getSenderNumbers(): Promise<SMSSenderNumber[]>;
+    addSenderNumber?(phoneNumber: string): Promise<SMSSenderNumber>;
+    verifySenderNumber?(phoneNumber: string, verificationCode: string): Promise<boolean>;
+}
+export interface SMSBalance {
+    sms: number;
+    lms: number;
+    currency: string;
+    lastUpdated: Date;
+}
+export interface SMSAccountProfile {
+    accountId: string;
+    name: string;
+    status: "active" | "suspended" | "blocked";
+    tier: "basic" | "standard" | "premium";
+    limits: {
+        dailySMSLimit: number;
+        dailyLMSLimit: number;
+        monthlyLimit: number;
+        rateLimit: number;
+    };
+}
+export interface SMSSenderNumber {
+    id: string;
+    phoneNumber: string;
+    isVerified: boolean;
+    verifiedAt?: Date;
+    status: "active" | "inactive" | "pending";
+    createdAt: Date;
+}
+export interface SMSCapabilities {
+    sms: {
+        maxLength: number;
+        supportsBulk: boolean;
+        maxRecipientsPerRequest: number;
+        maxRequestsPerSecond: number;
+        supportsScheduling: boolean;
+        maxScheduleDays: number;
+    };
+    lms: {
+        maxLength: number;
+        supportsSubject: boolean;
+        maxSubjectLength: number;
+        supportsBulk: boolean;
+    };
+    senderNumbers: {
+        requiresVerification: boolean;
+        maxSenderNumbers: number;
+        supportsCustomNumbers: boolean;
+    };
+}