@k-msg/provider 0.3.0 → 0.5.0

package/README.md

@@ -1,6 +1,6 @@
 # @k-msg/provider
 
-Provider system and interfaces for the K-Message platform.
+Provider implementations for `k-msg` (SendOptions + Result based).
 
 ## Installation
 
@@ -10,133 +10,44 @@ npm install @k-msg/provider @k-msg/core
 bun add @k-msg/provider @k-msg/core
 ```
 
-## Features
-
-- **Complete Provider System**: All-in-one package with providers, adapters, and implementations
-- **Built-in IWINV Provider**: Production-ready IWINV AlimTalk integration
-- **BaseAlimTalkProvider**: Abstract base class for creating custom providers
-- **Request/Response Adapters**: Standardized API communication adapters
-- **Provider Registry**: Centralized provider management and registration
-- **Contract System**: Modular contract-based architecture
-- **Configuration Validation**: Built-in configuration validation with schemas
-- **Health Monitoring**: Comprehensive health checks and diagnostics
-
 ## Built-in Providers
 
-### IWINV Provider
-
-Production-ready AlimTalk provider with full feature support:
-
-- ✅ AlimTalk message sending with variable substitution
-- ✅ SMS/LMS fallback for failed AlimTalk messages
-- ✅ Template management (create, update, delete, list)
-- ✅ Account balance and profile information
-- ✅ Real-time delivery tracking and status updates
-- ✅ Channel and sender number management
-- ✅ Analytics and usage statistics
-- ✅ Configuration validation and health checks
-
-## Basic Usage
-
-```typescript
-import { IWINVProvider } from '@k-msg/provider';
-
-// Use the built-in IWINV provider
-const iwinvProvider = new IWINVProvider({
-  apiKey: process.env.IWINV_API_KEY!,
-  baseUrl: 'https://alimtalk.bizservice.iwinv.kr',
-  debug: false
-});
-
-// Send a message
-const result = await iwinvProvider.sendMessage({
-  templateCode: 'TPL001',
-  phoneNumber: '01012345678',
-  variables: { code: '123456' }
-});
-
-console.log('Message sent:', result.messageId);
-```
-
-### Custom Provider Registration
-
-```typescript
-import { PluginRegistry } from '@k-msg/provider';
-
-const registry = new PluginRegistry();
-
-// Register a custom provider plugin
-await registry.registerPlugin({
-  id: 'custom-provider',
-  name: 'Custom Provider',
-  version: '1.0.0',
-  capabilities: {
-    messaging: true,
-    templates: true,
-    analytics: false
+- `SolapiProvider` (SOLAPI)
+- `IWINVProvider` (IWINV AlimTalk + optional SMS v2)
+- `AligoProvider` (Aligo)
+
+All providers implement the `Provider` interface from `@k-msg/core`:
+
+- `supportedTypes` declares supported message `type`s
+- `send(options: SendOptions)` returns `Result<SendResult, KMsgError>` (never throws)
+
+## Usage (with KMsg)
+
+```ts
+import { KMsg } from "@k-msg/messaging";
+import { IWINVProvider, SolapiProvider } from "@k-msg/provider";
+
+const kmsg = new KMsg({
+  providers: [
+    new SolapiProvider({
+      apiKey: process.env.SOLAPI_API_KEY!,
+      apiSecret: process.env.SOLAPI_API_SECRET!,
+      defaultFrom: "01000000000",
+    }),
+    new IWINVProvider({
+      apiKey: process.env.IWINV_API_KEY!,
+      baseUrl: "https://alimtalk.bizservice.iwinv.kr",
+      smsApiKey: process.env.IWINV_SMS_API_KEY,
+      smsAuthKey: process.env.IWINV_SMS_AUTH_KEY,
+      smsSenderNumber: "01000000000",
+    }),
+  ],
+  routing: {
+    defaultProviderId: "solapi",
+    byType: { ALIMTALK: "iwinv" },
   },
-  factory: () => new CustomProvider()
 });
 
-// Get registered providers
-const providers = registry.getRegisteredPlugins();
-console.log('Available providers:', providers);
-```
-
-## Creating Custom Providers
-
-```typescript
-import { BasePlugin } from '@k-msg/provider';
-
-export class CustomProvider extends BasePlugin {
-  constructor() {
-    super({
-      id: 'custom-provider',
-      name: 'Custom Provider',
-      version: '1.0.0'
-    });
-  }
-
-  async initialize(config: any): Promise<void> {
-    // Initialize provider with configuration
-    this.config = config;
-  }
-
-  async sendMessage(options: MessageSendOptions): Promise<MessageResult> {
-    // Implement message sending logic
-    return {
-      messageId: 'msg-123',
-      status: 'SENT'
-    };
-  }
-
-  async getHealth(): Promise<HealthStatus> {
-    // Implement health check
-    return {
-      healthy: true,
-      latency: 150
-    };
-  }
-}
+await kmsg.send({ to: "01012345678", text: "hello" });
 ```
 
-## Service Interfaces
-
-```typescript
-import { MessagingService, TemplateService } from '@k-msg/provider';
-
-// Implement messaging service
-class CustomMessagingService implements MessagingService {
-  async sendMessage(request: MessageRequest): Promise<MessageResponse> {
-    // Custom implementation
-  }
-
-  async getMessageStatus(messageId: string): Promise<MessageStatus> {
-    // Custom implementation
-  }
-}
-```
-
-## License
-
-MIT

package/dist/aligo/provider.d.ts

@@ -1,18 +1,28 @@
-import { type SendOptions, type StandardRequest, UniversalProvider } from "@k-msg/core";
+import { KMsgError, type MessageType, type Provider, type ProviderHealthStatus, type Result, type SendOptions, type SendResult } from "@k-msg/core";
 import type { AligoConfig } from "../types/aligo";
-export declare class AligoProvider extends UniversalProvider {
+export declare class AligoProvider implements Provider {
+    private readonly config;
+    readonly id = "aligo";
+    readonly name = "Aligo Smart SMS";
+    readonly supportedTypes: readonly MessageType[];
+    private readonly SMS_HOST;
+    private readonly ALIMTALK_HOST;
     constructor(config: AligoConfig);
-    send(params: SendOptions | StandardRequest | any): Promise<any>;
-    getBalance(): Promise<number>;
+    healthCheck(): Promise<ProviderHealthStatus>;
+    send(options: SendOptions): Promise<Result<SendResult, KMsgError>>;
+    private getEndpoint;
+    private formatAligoDate;
+    private request;
+    private mapAligoError;
+    private interpolateMessage;
+    private sendSMS;
+    private sendAlimTalk;
+    private sendFriendTalk;
 }
 export declare const createAligoProvider: (config: AligoConfig) => AligoProvider;
 export declare const createDefaultAligoProvider: () => AligoProvider;
 export declare class AligoProviderFactory {
     static create(config: AligoConfig): AligoProvider;
     static createDefault(): AligoProvider;
-    static getInstance(): {
-        createProvider: (config: AligoConfig) => AligoProvider;
-        initialize: () => void;
-    };
 }
 export declare function initializeAligo(): void;

package/dist/index.d.ts

@@ -1,33 +1,12 @@
 /**
  * @k-msg/provider
- * Complete provider system with adapters and implementations
+ *
+ * Provider implementations for the unified `SendOptions + Result` API.
  */
-export type { NotificationRequest, NotificationResponse, } from "./interfaces";
-export * from "./interfaces/plugin";
-export * from "./middleware";
-export * from "./registry";
-export type { BaseProvider, BaseProviderConfig, ChannelInfo, HealthCheckResult, HistoryFilters, MediaAttachment, MessageButton, MessageChannel, MessageContent, MessageType, SenderNumber, SenderVerificationResult, SendOptions, SendResult, TemplateCreateRequest, TemplateFilters, TemplateResult, TemplateUpdateRequest, } from "./types/base";
-export * from "./utils";
-export { BaseAlimTalkProvider } from "./abstract/provider.base";
-export { AligoAdapter } from "./adapters/aligo.adapter";
-export { IWINVAdapter, IWINVAdapterFactory, } from "./adapters/iwinv.adapter";
-export { SolapiAdapter } from "./adapters/solapi.adapter";
-export type { AccountContract, AnalyticsContract, ChannelContract, ConfigurationField, MessagingContract, ProviderCapabilities, ProviderConfiguration, ProviderMessageRequest, ProviderMessageResult, ScheduleResult, TemplateContract, } from "./contracts/provider.contract";
-export * from "./providers/mock";
-export * from "./services/provider.manager";
-export * from "./services/provider.service";
-export { AligoProvider, AligoProviderFactory, createAligoProvider, createDefaultAligoProvider, initializeAligo, } from "./aligo/provider";
-export type * from "./contracts/sms.contract";
-export { createDefaultIWINVProvider, createIWINVProvider, IWINVProvider, IWINVProviderFactory, initializeIWINV, } from "./iwinv/provider";
-export { createDefaultIWINVMultiProvider, createIWINVMultiProvider, IWINVMultiProvider, } from "./iwinv/provider-multi";
-export { createDefaultIWINVSMSProvider, createIWINVSMSProvider, IWINVSMSProvider, } from "./iwinv/provider-sms";
-export type * from "./iwinv/types/iwinv";
-export { createDefaultSolapiProvider, createSolapiProvider, initializeSolapi, SolapiProvider, SolapiProviderFactory, } from "./solapi/provider";
+export { AligoProvider, AligoProviderFactory, createAligoProvider, createDefaultAligoProvider, initializeAligo } from "./aligo/provider";
+export type { AligoConfig } from "./types/aligo";
+export { IWINVProvider, IWINVProviderFactory, createIWINVProvider, createDefaultIWINVProvider, initializeIWINV } from "./iwinv/provider";
+export type { IWINVConfig } from "./iwinv/types/iwinv";
+export { SolapiProvider, SolapiProviderFactory, createSolapiProvider, createDefaultSolapiProvider, initializeSolapi } from "./solapi/provider";
 export type { SolapiConfig } from "./solapi/types/solapi";
-export type * from "./types/aligo";
-export type { TemplateCode, TemplateVariables, TypedRequest, TypedResult, ValidationResult, } from "./types/typed-templates";
-export { TEMPLATE_REGISTRY, TemplateTypeConverter, TemplateValidator, TypedProvider, } from "./types/typed-templates";
-export type { AlimTalkConfig, IWINVBaseConfig, MonitoringConfig, PerformanceConfig, SMSConfig, UnifiedProviderConfig, } from "./types/unified-config";
-export { isValidIWINVBaseConfig, isValidUnifiedConfig, toLegacyIWINVConfig, UnifiedConfigBuilder, UnifiedConfigFactory, } from "./types/unified-config";
-export type { BaseErrorInfo, ErrorStats, NetworkErrorInfo, ProviderErrorInfo, TemplateErrorInfo, UnifiedErrorInfo, } from "./types/unified-errors";
-export { ErrorAnalyzer, ErrorCategory, ErrorConverter, ErrorFactory, ErrorSeverity, isNetworkError, isProviderError, isRetryableError, isTemplateError, isUnifiedError, NetworkError, ProviderError, TemplateError, UnifiedError, } from "./types/unified-errors";
+export { MockProvider } from "./providers/mock/mock.provider";