@k-msg/core 0.7.3 → 0.9.0

package/dist/provider.d.ts

@@ -1,6 +1,6 @@
 import type { KMsgError } from "./errors";
 import type { Result } from "./result";
-import type { DeliveryStatusQuery, DeliveryStatusResult, MessageType, SendOptions, SendResult } from "./types/index";
+import type { DeliveryStatusQuery, DeliveryStatusResult, KakaoChannel, KakaoChannelCategories, MessageType, SendOptions, SendResult } from "./types/index";
 export interface Template {
     id: string;
     code: string;
@@ -13,16 +13,50 @@ export interface Template {
     createdAt: Date;
     updatedAt: Date;
 }
+export type TemplateCreateInput = {
+    name: string;
+    content: string;
+    category?: string;
+    buttons?: unknown[];
+    variables?: string[];
+};
+export type TemplateUpdateInput = Partial<TemplateCreateInput>;
+export type TemplateContext = {
+    /**
+     * Provider-specific Kakao channel key (e.g. Aligo senderKey).
+     */
+    kakaoChannelSenderKey?: string;
+};
 export interface TemplateProvider {
-    createTemplate(template: Omit<Template, "id" | "status" | "createdAt" | "updatedAt">): Promise<Result<Template, KMsgError>>;
-    updateTemplate(code: string, template: Partial<Omit<Template, "id" | "code" | "status" | "createdAt" | "updatedAt">>): Promise<Result<Template, KMsgError>>;
-    deleteTemplate(code: string): Promise<Result<void, KMsgError>>;
-    getTemplate(code: string): Promise<Result<Template, KMsgError>>;
+    createTemplate(input: TemplateCreateInput, ctx?: TemplateContext): Promise<Result<Template, KMsgError>>;
+    updateTemplate(code: string, patch: TemplateUpdateInput, ctx?: TemplateContext): Promise<Result<Template, KMsgError>>;
+    deleteTemplate(code: string, ctx?: TemplateContext): Promise<Result<void, KMsgError>>;
+    getTemplate(code: string, ctx?: TemplateContext): Promise<Result<Template, KMsgError>>;
     listTemplates(params?: {
         status?: string;
         page?: number;
         limit?: number;
-    }): Promise<Result<Template[], KMsgError>>;
+    }, ctx?: TemplateContext): Promise<Result<Template[], KMsgError>>;
+}
+export interface TemplateInspectionProvider {
+    requestTemplateInspection(code: string, ctx?: TemplateContext): Promise<Result<void, KMsgError>>;
+}
+export interface KakaoChannelProvider {
+    listKakaoChannels(params?: {
+        plusId?: string;
+        senderKey?: string;
+    }): Promise<Result<KakaoChannel[], KMsgError>>;
+    listKakaoChannelCategories?(): Promise<Result<KakaoChannelCategories, KMsgError>>;
+    requestKakaoChannelAuth?(params: {
+        plusId: string;
+        phoneNumber: string;
+    }): Promise<Result<void, KMsgError>>;
+    addKakaoChannel?(params: {
+        plusId: string;
+        authNum: string;
+        phoneNumber: string;
+        categoryCode: string;
+    }): Promise<Result<KakaoChannel, KMsgError>>;
 }
 export interface ProviderHealthStatus {
     healthy: boolean;

package/dist/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./balance";
 export * from "./delivery-status";
 export * from "./history";
+export * from "./kakao-channel";
 export * from "./message";

package/dist/types/kakao-channel.d.ts

@@ -0,0 +1,28 @@
+export interface KakaoChannel {
+    providerId: string;
+    /**
+     * Provider-specific Kakao channel key.
+     * - Aligo: senderKey
+     * - Solapi: pfId (profileId)
+     */
+    senderKey: string;
+    /**
+     * Kakao channel id including "@", when available (e.g. "@mybrand").
+     */
+    plusId?: string;
+    name?: string;
+    status?: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+    raw?: unknown;
+}
+export interface KakaoCategoryEntry {
+    code: string;
+    name: string;
+    parentCode?: string;
+}
+export interface KakaoChannelCategories {
+    first: KakaoCategoryEntry[];
+    second: KakaoCategoryEntry[];
+    third: KakaoCategoryEntry[];
+}

package/dist/types/message.d.ts

@@ -76,6 +76,18 @@ export interface KakaoSendOptions {
     imageLink?: string;
     [key: string]: any;
 }
+export interface AlimTalkFailoverOptions {
+    enabled?: boolean;
+    fallbackChannel?: "sms" | "lms";
+    fallbackContent?: string;
+    fallbackTitle?: string;
+}
+export type SendWarningCode = "FAILOVER_UNSUPPORTED_PROVIDER" | "FAILOVER_PARTIAL_PROVIDER" | "FALLBACK_CONTENT_MISSING" | (string & {});
+export interface SendWarning {
+    code: SendWarningCode;
+    message: string;
+    details?: Record<string, unknown>;
+}
 export interface NaverSendOptions {
     talkId?: string;
     /**
@@ -144,6 +156,7 @@ export interface AlimTalkSendOptions extends CommonSendOptions {
     templateCode: string;
     variables: MessageVariables;
     kakao?: KakaoSendOptions;
+    failover?: AlimTalkFailoverOptions;
 }
 export interface FriendTalkSendOptions extends CommonSendOptions {
     type: "FRIENDTALK";
@@ -213,5 +226,6 @@ export interface SendResult {
     status: MessageStatus;
     type: MessageType;
     to: string;
+    warnings?: SendWarning[];
     raw?: unknown;
 }

package/package.json

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