@k-msg/messaging 0.1.0 → 0.1.2

package/dist/types/message.types.d.ts

@@ -0,0 +1,280 @@
+import type { RetryOptions } from "@k-msg/core";
+import { z } from "zod";
+export interface MessageRequest {
+    templateId: string;
+    recipients: Recipient[];
+    variables: VariableMap;
+    scheduling?: SchedulingOptions;
+    options?: SendingOptions;
+}
+export interface Recipient {
+    phoneNumber: string;
+    variables?: VariableMap;
+    metadata?: Record<string, any>;
+}
+export interface VariableMap {
+    [key: string]: string | number | Date;
+}
+export interface SchedulingOptions {
+    scheduledAt: Date;
+    timezone?: string;
+    retryCount?: number;
+}
+export interface SendingOptions {
+    priority?: "high" | "normal" | "low";
+    ttl?: number;
+    failover?: {
+        enabled: boolean;
+        fallbackChannel?: "sms" | "lms";
+        fallbackContent?: string;
+    };
+    deduplication?: {
+        enabled: boolean;
+        window: number;
+    };
+    tracking?: {
+        enabled: boolean;
+        webhookUrl?: string;
+    };
+}
+export interface MessageResult {
+    requestId: string;
+    results: RecipientResult[];
+    summary: {
+        total: number;
+        queued: number;
+        sent: number;
+        failed: number;
+    };
+    metadata: {
+        createdAt: Date;
+        provider: string;
+        templateId: string;
+    };
+}
+export interface RecipientResult {
+    phoneNumber: string;
+    messageId?: string;
+    status: MessageStatus;
+    error?: MessageError;
+    metadata?: Record<string, any>;
+}
+export declare enum MessageStatus {
+    QUEUED = "QUEUED",// 큐에 대기 중
+    SENDING = "SENDING",// 발송 중
+    SENT = "SENT",// 발송 완료
+    DELIVERED = "DELIVERED",// 전달 완료
+    FAILED = "FAILED",// 발송 실패
+    CLICKED = "CLICKED",// 버튼 클릭됨
+    CANCELLED = "CANCELLED"
+}
+export interface MessageError {
+    code: string;
+    message: string;
+    details?: Record<string, any>;
+}
+export interface DeliveryReport {
+    messageId: string;
+    phoneNumber: string;
+    status: MessageStatus;
+    sentAt?: Date;
+    deliveredAt?: Date;
+    clickedAt?: Date;
+    failedAt?: Date;
+    error?: MessageError;
+    attempts: DeliveryAttempt[];
+    metadata: Record<string, any>;
+}
+export interface DeliveryAttempt {
+    attemptNumber: number;
+    attemptedAt: Date;
+    status: MessageStatus;
+    error?: MessageError;
+    provider: string;
+}
+export interface BulkMessageRequest {
+    templateId: string;
+    recipients: BulkRecipient[];
+    commonVariables?: VariableMap;
+    options?: BulkSendingOptions;
+}
+export interface BulkRecipient {
+    phoneNumber: string;
+    variables: VariableMap;
+    metadata?: Record<string, any>;
+}
+export interface BulkSendingOptions extends SendingOptions {
+    batchSize?: number;
+    batchDelay?: number;
+    maxConcurrency?: number;
+    retryOptions?: Partial<RetryOptions>;
+}
+export interface BulkMessageResult {
+    requestId: string;
+    totalRecipients: number;
+    batches: BulkBatchResult[];
+    summary: {
+        queued: number;
+        sent: number;
+        failed: number;
+        processing: number;
+    };
+    createdAt: Date;
+    completedAt?: Date;
+}
+export interface BulkBatchResult {
+    batchId: string;
+    batchNumber: number;
+    recipients: RecipientResult[];
+    status: "pending" | "processing" | "completed" | "failed";
+    createdAt: Date;
+    completedAt?: Date;
+}
+export declare enum MessageEventType {
+    TEMPLATE_CREATED = "template.created",
+    TEMPLATE_APPROVED = "template.approved",
+    TEMPLATE_REJECTED = "template.rejected",
+    TEMPLATE_UPDATED = "template.updated",
+    TEMPLATE_DELETED = "template.deleted",
+    MESSAGE_QUEUED = "message.queued",
+    MESSAGE_SENT = "message.sent",
+    MESSAGE_DELIVERED = "message.delivered",
+    MESSAGE_FAILED = "message.failed",
+    MESSAGE_CLICKED = "message.clicked",
+    MESSAGE_CANCELLED = "message.cancelled",
+    CHANNEL_CREATED = "channel.created",
+    CHANNEL_VERIFIED = "channel.verified",
+    SENDER_NUMBER_ADDED = "sender_number.added",
+    QUOTA_WARNING = "system.quota_warning",
+    QUOTA_EXCEEDED = "system.quota_exceeded",
+    PROVIDER_ERROR = "system.provider_error"
+}
+export interface MessageEvent<T = any> {
+    id: string;
+    type: MessageEventType;
+    timestamp: Date;
+    data: T;
+    metadata: {
+        providerId?: string;
+        userId?: string;
+        organizationId?: string;
+        correlationId?: string;
+    };
+}
+export declare const VariableMapSchema: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodDate]>>;
+export declare const RecipientSchema: z.ZodObject<{
+    phoneNumber: z.ZodString;
+    variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodDate]>>>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, z.core.$strip>;
+export declare const SchedulingOptionsSchema: z.ZodObject<{
+    scheduledAt: z.ZodDate;
+    timezone: z.ZodOptional<z.ZodString>;
+    retryCount: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+}, z.core.$strip>;
+export declare const SendingOptionsSchema: z.ZodObject<{
+    priority: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+        high: "high";
+        normal: "normal";
+        low: "low";
+    }>>>;
+    ttl: z.ZodOptional<z.ZodNumber>;
+    failover: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodBoolean;
+        fallbackChannel: z.ZodOptional<z.ZodEnum<{
+            sms: "sms";
+            lms: "lms";
+        }>>;
+        fallbackContent: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    deduplication: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodBoolean;
+        window: z.ZodNumber;
+    }, z.core.$strip>>;
+    tracking: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodBoolean;
+        webhookUrl: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const MessageRequestSchema: z.ZodObject<{
+    templateId: z.ZodString;
+    recipients: z.ZodArray<z.ZodObject<{
+        phoneNumber: z.ZodString;
+        variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodDate]>>>;
+        metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, z.core.$strip>>;
+    variables: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodDate]>>;
+    scheduling: z.ZodOptional<z.ZodObject<{
+        scheduledAt: z.ZodDate;
+        timezone: z.ZodOptional<z.ZodString>;
+        retryCount: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    }, z.core.$strip>>;
+    options: z.ZodOptional<z.ZodObject<{
+        priority: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+            high: "high";
+            normal: "normal";
+            low: "low";
+        }>>>;
+        ttl: z.ZodOptional<z.ZodNumber>;
+        failover: z.ZodOptional<z.ZodObject<{
+            enabled: z.ZodBoolean;
+            fallbackChannel: z.ZodOptional<z.ZodEnum<{
+                sms: "sms";
+                lms: "lms";
+            }>>;
+            fallbackContent: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        deduplication: z.ZodOptional<z.ZodObject<{
+            enabled: z.ZodBoolean;
+            window: z.ZodNumber;
+        }, z.core.$strip>>;
+        tracking: z.ZodOptional<z.ZodObject<{
+            enabled: z.ZodBoolean;
+            webhookUrl: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const MessageErrorSchema: z.ZodObject<{
+    code: z.ZodString;
+    message: z.ZodString;
+    details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, z.core.$strip>;
+export declare const RecipientResultSchema: z.ZodObject<{
+    phoneNumber: z.ZodString;
+    messageId: z.ZodOptional<z.ZodString>;
+    status: z.ZodEnum<typeof MessageStatus>;
+    error: z.ZodOptional<z.ZodObject<{
+        code: z.ZodString;
+        message: z.ZodString;
+        details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, z.core.$strip>>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, z.core.$strip>;
+export declare const MessageResultSchema: z.ZodObject<{
+    requestId: z.ZodString;
+    results: z.ZodArray<z.ZodObject<{
+        phoneNumber: z.ZodString;
+        messageId: z.ZodOptional<z.ZodString>;
+        status: z.ZodEnum<typeof MessageStatus>;
+        error: z.ZodOptional<z.ZodObject<{
+            code: z.ZodString;
+            message: z.ZodString;
+            details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+        }, z.core.$strip>>;
+        metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, z.core.$strip>>;
+    summary: z.ZodObject<{
+        total: z.ZodNumber;
+        queued: z.ZodNumber;
+        sent: z.ZodNumber;
+        failed: z.ZodNumber;
+    }, z.core.$strip>;
+    metadata: z.ZodObject<{
+        createdAt: z.ZodDate;
+        provider: z.ZodString;
+        templateId: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type MessageRequestType = z.infer<typeof MessageRequestSchema>;
+export type RecipientType = z.infer<typeof RecipientSchema>;
+export type MessageResultType = z.infer<typeof MessageResultSchema>;

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@k-msg/messaging",
-  "version": "0.1.0",
+  "version": "0.1.2",
+  "packageManager": "bun@1.3.8",
   "description": "AlimTalk messaging core for sending, queuing, and tracking messages",
   "type": "module",
   "main": "dist/index.js",
@@ -17,20 +18,26 @@
     "access": "public"
   },
   "scripts": {
-    "build": "tsup",
+    "build": "bun run build:esm && bun run build:cjs && bun run build:types",
+    "build:esm": "bun build ./src/index.ts --outdir ./dist --format esm --minify --sourcemap --entry-naming '[name].mjs' --external 'bun:test' --external 'bun:sqlite'",
+    "build:cjs": "bun build ./src/index.ts --outdir ./dist --format cjs --minify --sourcemap --entry-naming '[name].js' --external 'bun:test' --external 'bun:sqlite'",
+    "build:types": "tsc",
     "dev": "tsc --watch",
     "test": "bun test",
-    "clean": "rm -rf dist"
+    "clean": "rm -rf dist",
+    "pack": "bun pm pack",
+    "publish": "bun publish --access public"
   },
   "dependencies": {
-    "zod": "catalog:",
-    "@k-msg/core": "workspace:*"
+    "zod": "^4.0.14",
+    "@k-msg/core": "0.1.1",
+    "@k-msg/provider": "0.1.1",
+    "@k-msg/template": "0.1.1"
   },
   "devDependencies": {
-    "typescript": "catalog:",
-    "@types/bun": "catalog:",
-    "@types/node": "catalog:",
-    "tsup": "^8.5.0"
+    "typescript": "^5.7.2",
+    "@types/bun": "latest",
+    "@types/node": "^22.0.0"
   },
   "files": [
     "dist",
@@ -45,12 +52,12 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/k-otp/k-message.git"
+    "url": "git+https://github.com/k-otp/k-msg.git"
   },
-  "homepage": "https://github.com/k-otp/k-message",
+  "homepage": "https://github.com/k-otp/k-msg",
   "bugs": {
-    "url": "https://github.com/k-otp/k-message/issues"
+    "url": "https://github.com/k-otp/k-msg/issues"
   },
   "author": "imjlk",
   "license": "MIT"
-}
+}