@k-msg/core 0.1.6 → 0.3.0

package/dist/platform.d.ts

@@ -1,4 +1,4 @@
-import type { BaseProvider, Config, KMsg, MessageSendOptions, MessageSendResult, PlatformHealthStatus, PlatformInfo } from "./types/index";
+import type { BalanceQuery, BalanceResult, BaseProvider, Config, HistoryQuery, HistoryResult, KMsg, MessageSendOptions, MessageSendResult, PlatformHealthStatus, PlatformInfo } from "./types/index";
 /**
  * Core AlimTalk Platform implementation
  */
@@ -33,31 +33,41 @@ export declare class AlimTalkPlatform implements KMsg {
     healthCheck(): Promise<PlatformHealthStatus>;
     get messages(): {
         send: (options: MessageSendOptions) => Promise<MessageSendResult>;
-        getStatus: (messageId: string) => Promise<string>;
+        getStatus: (_messageId: string) => Promise<string>;
     };
+    balance(providerId?: string): Promise<{
+        get: (query?: BalanceQuery) => Promise<BalanceResult>;
+    }>;
     /**
      * @deprecated Template operations are not yet migrated to the new provider interface.
      * Use the provider's adapter directly for template management.
      */
     templates(providerId?: string): Promise<{
         /** @deprecated Not yet implemented */
-        list: (_page?: number, _size?: number, _filters?: any) => Promise<never>;
+        list: (_page?: number, _size?: number, _filters?: Record<string, unknown>) => Promise<never>;
         /** @deprecated Not yet implemented */
-        create: (_name: string, _content: string, _category?: string, _variables?: any[], _buttons?: any[]) => Promise<never>;
+        create: (_name: string, _content: string, _category?: string, _variables?: unknown[], _buttons?: unknown[]) => Promise<never>;
         /** @deprecated Not yet implemented */
-        modify: (_templateCode: string, _name: string, _content: string, _buttons?: any[]) => Promise<never>;
+        modify: (_templateCode: string, _name: string, _content: string, _buttons?: unknown[]) => Promise<never>;
         /** @deprecated Not yet implemented */
         delete: (_templateCode: string) => Promise<never>;
     }>;
     /**
-     * @deprecated History operations are not yet migrated to the new provider interface.
-     * Use the provider's adapter directly for history queries.
+     * History operations (common API surface).
+     *
+     * Notes:
+     * - Not all providers implement history. This method will throw when unsupported.
+     * - For provider-specific, advanced fields, use provider adapter directly.
      */
     history(providerId?: string): Promise<{
-        /** @deprecated Not yet implemented */
-        list: (_page?: number, _size?: number, _filters?: any) => Promise<never>;
-        /** @deprecated Not yet implemented */
+        list: (queryOrPage?: HistoryQuery | number, pageSize?: number, filters?: Partial<Omit<HistoryQuery, "page" | "pageSize">> & {
+            channel?: HistoryQuery["channel"];
+        }) => Promise<HistoryResult>;
         cancelReservation: (_messageId: string) => Promise<never>;
     }>;
     providerHealth(providerId: string): Promise<import(".").ProviderHealthStatus>;
+    private getProviderAdapter;
+    private isSmsChannel;
+    private normalizeHistoryQuery;
+    private getFunction;
 }

package/dist/types/balance.d.ts

@@ -0,0 +1,12 @@
+import type { MessageType } from "./message";
+export type BalanceChannel = MessageType;
+export interface BalanceQuery {
+    channel?: BalanceChannel;
+}
+export interface BalanceResult {
+    providerId: string;
+    channel?: BalanceChannel;
+    amount: number;
+    currency?: string;
+    raw?: unknown;
+}

package/dist/types/history.d.ts

@@ -0,0 +1,40 @@
+import type { MessageType } from "./message";
+export type HistoryChannel = MessageType;
+export interface HistoryQuery {
+    channel: HistoryChannel;
+    startDate: string | Date;
+    endDate: string | Date;
+    page?: number;
+    pageSize?: number;
+    /**
+     * Cursor key for providers that use cursor-based pagination (e.g. SOLAPI).
+     * When provided, it takes precedence over `page`.
+     */
+    startKey?: string;
+    phone?: string;
+    requestNo?: string;
+    companyId?: string;
+}
+export interface HistoryItem {
+    providerId: string;
+    channel: HistoryChannel;
+    messageId: string;
+    to?: string;
+    from?: string;
+    status?: string;
+    statusCode?: string;
+    statusMessage?: string;
+    sentAt?: Date;
+    raw: unknown;
+}
+export interface HistoryResult {
+    providerId: string;
+    channel: HistoryChannel;
+    totalCount: number;
+    /**
+     * Cursor key for fetching the next page when provider supports cursor pagination.
+     */
+    nextKey?: string | null;
+    items: HistoryItem[];
+    raw?: unknown;
+}

package/dist/types/index.d.ts

@@ -1,3 +1,5 @@
+export * from "./balance";
+export * from "./history";
 export * from "./message";
 export * from "./platform";
 export * from "./provider";

package/dist/types/message.d.ts

@@ -1,4 +1,4 @@
-export type MessageType = "ALIMTALK" | "FRIENDTALK" | "SMS" | "LMS" | "MMS";
+export type MessageType = "ALIMTALK" | "FRIENDTALK" | "SMS" | "LMS" | "MMS" | "RCS_SMS" | "RCS_LMS" | "RCS_MMS" | "RCS_TPL" | "RCS_ITPL" | "RCS_LTPL";
 export interface BaseOptions {
     to: string;
     from: string;

package/dist/types/platform.d.ts

@@ -1,4 +1,7 @@
+import type { BalanceQuery, BalanceResult } from "./balance";
+import type { HistoryQuery, HistoryResult } from "./history";
 import type { Button, MessageType } from "./message";
+import type { BaseProvider } from "./provider";
 export interface PlatformHealthStatus {
     healthy: boolean;
     providers: Record<string, boolean>;
@@ -13,20 +16,20 @@ export interface LegacyMessageSendOptions {
     templateId: string;
     recipients: {
         phoneNumber: string;
-        variables?: Record<string, any>;
+        variables?: Record<string, unknown>;
     }[];
-    variables: Record<string, any>;
+    variables: Record<string, unknown>;
 }
 export interface UnifiedMessageRecipient {
     phoneNumber: string;
-    variables?: Record<string, any>;
+    variables?: Record<string, unknown>;
 }
 export interface UnifiedMessageSendOptions {
     channel: MessageType;
     recipients: Array<string | UnifiedMessageRecipient>;
     providerId?: string;
     templateCode?: string;
-    variables?: Record<string, any>;
+    variables?: Record<string, unknown>;
     text?: string;
     subject?: string;
     imageUrl?: string;
@@ -35,7 +38,7 @@ export interface UnifiedMessageSendOptions {
         scheduledAt?: Date;
         senderNumber?: string;
         subject?: string;
-        [key: string]: any;
+        [key: string]: unknown;
     };
 }
 export type MessageSendOptions = LegacyMessageSendOptions | UnifiedMessageSendOptions;
@@ -56,10 +59,19 @@ export interface MessageSendResult {
 }
 export interface KMsg {
     getInfo(): PlatformInfo;
-    registerProvider(provider: any): void;
-    getProvider(providerId: string): any | null;
+    registerProvider(provider: BaseProvider): void;
+    getProvider(providerId: string): BaseProvider | null;
     listProviders(): string[];
     healthCheck(): Promise<PlatformHealthStatus>;
+    balance(providerId?: string): Promise<{
+        get(query?: BalanceQuery): Promise<BalanceResult>;
+    }>;
+    history(providerId?: string): Promise<{
+        list(query: HistoryQuery): Promise<HistoryResult>;
+        list(page?: number, pageSize?: number, filters?: Partial<Omit<HistoryQuery, "page" | "pageSize">> & {
+            channel?: HistoryQuery["channel"];
+        }): Promise<HistoryResult>;
+    }>;
     messages: {
         send(options: MessageSendOptions): Promise<MessageSendResult>;
         getStatus(messageId: string): Promise<string>;

package/dist/types/standard.d.ts

@@ -25,13 +25,13 @@ export interface StandardError {
     code: StandardErrorCode;
     message: string;
     retryable: boolean;
-    details?: Record<string, any>;
+    details?: Record<string, unknown>;
 }
 export interface StandardRequest {
     channel?: MessageType;
     templateCode: string;
     phoneNumber: string;
-    variables: Record<string, any>;
+    variables: Record<string, unknown>;
     text?: string;
     imageUrl?: string;
     buttons?: Button[];
@@ -39,6 +39,31 @@ export interface StandardRequest {
         scheduledAt?: Date;
         senderNumber?: string;
         subject?: string;
+        /**
+         * Provider-specific KakaoTalk options (e.g. SOLAPI kakaoOptions).
+         */
+        kakaoOptions?: {
+            pfId?: string;
+            templateId?: string;
+            variables?: Record<string, string>;
+            disableSms?: boolean;
+            adFlag?: boolean;
+            buttons?: unknown[];
+            imageId?: string;
+            [key: string]: unknown;
+        };
+        /**
+         * Provider-specific RCS options (e.g. SOLAPI rcsOptions).
+         */
+        rcsOptions?: {
+            brandId?: string;
+            templateId?: string;
+            variables?: Record<string, string>;
+            disableSms?: boolean;
+            buttons?: unknown[];
+            additionalBody?: unknown;
+            [key: string]: unknown;
+        };
         [key: string]: any;
     };
 }
@@ -49,7 +74,7 @@ export interface StandardResult {
     timestamp: Date;
     phoneNumber: string;
     error?: StandardError;
-    metadata?: Record<string, any>;
+    metadata?: Record<string, unknown>;
 }
 export declare enum TemplateCategory {
     AUTHENTICATION = "AUTHENTICATION",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@k-msg/core",
-  "version": "0.1.6",
+  "version": "0.3.0",
   "packageManager": "bun@1.3.8",
   "description": "Core types and interfaces for K-Message platform",
   "type": "module",