@k-msg/core 0.8.0 → 0.10.0

package/dist/provider.d.ts

@@ -1,6 +1,6 @@
 import type { KMsgError } from "./errors";
 import type { Result } from "./result";
-import type { DeliveryStatusQuery, DeliveryStatusResult, KakaoChannel, KakaoChannelCategories, MessageType, SendOptions, SendResult } from "./types/index";
+import type { DeliveryStatusQuery, DeliveryStatusResult, KakaoChannel, KakaoChannelCategories, MessageType, ProviderOnboardingSpec, SendOptions, SendResult } from "./types/index";
 export interface Template {
     id: string;
     code: string;
@@ -71,4 +71,5 @@ export interface Provider {
     healthCheck(): Promise<ProviderHealthStatus>;
     send(params: SendOptions): Promise<Result<SendResult, KMsgError>>;
     getDeliveryStatus?(query: DeliveryStatusQuery): Promise<Result<DeliveryStatusResult | null, KMsgError>>;
+    getOnboardingSpec?(): ProviderOnboardingSpec;
 }

package/dist/types/index.d.ts

@@ -3,3 +3,4 @@ export * from "./delivery-status";
 export * from "./history";
 export * from "./kakao-channel";
 export * from "./message";
+export * from "./onboarding";

package/dist/types/message.d.ts

@@ -66,6 +66,7 @@ export interface CommonSendOptions {
 }
 export interface KakaoSendOptions {
     profileId?: string;
+    plusId?: string;
     disableSms?: boolean;
     adFlag?: boolean;
     buttons?: unknown[];
@@ -76,6 +77,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 +157,7 @@ export interface AlimTalkSendOptions extends CommonSendOptions {
     templateCode: string;
     variables: MessageVariables;
     kakao?: KakaoSendOptions;
+    failover?: AlimTalkFailoverOptions;
 }
 export interface FriendTalkSendOptions extends CommonSendOptions {
     type: "FRIENDTALK";
@@ -213,5 +227,6 @@ export interface SendResult {
     status: MessageStatus;
     type: MessageType;
     to: string;
+    warnings?: SendWarning[];
     raw?: unknown;
 }

package/dist/types/onboarding.d.ts

@@ -0,0 +1,42 @@
+export type ProviderOnboardingCheckKind = "manual" | "config" | "capability" | "api_probe" | "inference";
+export type ProviderOnboardingSeverity = "blocker" | "warning" | "info";
+export type ProviderOnboardingScope = "doctor" | "preflight" | "send";
+export type ProviderPlusIdPolicy = "optional" | "required" | "required_if_no_inference";
+export type ProviderPlusIdInferenceSupport = "supported" | "unsupported";
+export type ProviderChannelOnboardingMode = "manual" | "api" | "none";
+export type ProviderTemplateLifecycleAvailability = "available" | "unavailable";
+export type ProviderLiveTestSupport = "supported" | "partial" | "none";
+export type ProviderOnboardingProbeOperation = "list_templates" | "list_kakao_channels";
+export interface ProviderOnboardingCheckSpec {
+    id: string;
+    title: string;
+    description?: string;
+    kind: ProviderOnboardingCheckKind;
+    severity: ProviderOnboardingSeverity;
+    scopes: ProviderOnboardingScope[];
+    /**
+     * Relative key paths under provider config (e.g. "apiKey", "nested.token").
+     * Used when kind === "config".
+     */
+    configKeys?: string[];
+    /**
+     * Method names that must exist on provider instances.
+     * Used when kind === "capability".
+     */
+    capabilityMethods?: string[];
+    /**
+     * Well-known probe operation used when kind === "api_probe".
+     */
+    probeOperation?: ProviderOnboardingProbeOperation;
+}
+export interface ProviderOnboardingSpec {
+    providerId: string;
+    providerName?: string;
+    channelOnboarding: ProviderChannelOnboardingMode;
+    templateLifecycleApi: ProviderTemplateLifecycleAvailability;
+    plusIdPolicy: ProviderPlusIdPolicy;
+    plusIdInference: ProviderPlusIdInferenceSupport;
+    liveTestSupport?: ProviderLiveTestSupport;
+    checks: ProviderOnboardingCheckSpec[];
+    notes?: string[];
+}

package/package.json

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