@k-msg/channel 0.19.1 → 0.21.0

package/README.md

@@ -2,7 +2,7 @@
 
 > Canonical docs: [k-msg.and.guide](https://k-msg.and.guide)
 
-Channel and sender number management for the K-Message platform.
+Runtime-first Kakao channel orchestration for `k-msg`.
 
 ## Installation
 
@@ -12,72 +12,65 @@ npm install @k-msg/channel @k-msg/core
 bun add @k-msg/channel @k-msg/core
 ```
 
-## Features
+## Runtime API (`@k-msg/channel`)
 
-- **Channel Management**: Complete channel lifecycle management
-- **Sender Number Registration**: Automated sender number registration and verification
-- **Business Verification**: Business information verification for AlimTalk channels
-- **Permission Management**: Role-based access control for channels
-- **Status Monitoring**: Real-time channel status monitoring
+Root exports are runtime-focused:
 
-## Runtime Compatibility
+- `KakaoChannelCapabilityService`
+- `KakaoChannelBindingResolver`
+- `KakaoChannelLifecycleService`
+- runtime types (`KakaoChannelCapabilityMode`, `KakaoChannelBinding`, `ResolvedKakaoChannelBinding`, `KakaoChannelListItem`, ...)
 
-- Works in Edge runtimes without `nodejs_compat` (no runtime dependency on Node built-ins).
+### Capability modes
 
-## Basic Usage
+- `api`: provider exposes channel onboarding APIs (`list/auth/add/categories`)
+- `manual`: provider requires manual onboarding (no channel onboarding API calls)
+- `none`: provider does not support channel onboarding APIs
 
-```typescript
-import { ChannelService } from '@k-msg/channel';
+### Example: resolve config binding
 
-const channelService = new ChannelService();
+```ts
+import { KakaoChannelBindingResolver } from "@k-msg/channel";
 
-// Create a new AlimTalk channel
-const channel = await channelService.createChannel({
-  name: 'My Business Channel',
-  provider: 'iwinv',
-  businessInfo: {
-    name: 'My Company Ltd.',
-    registrationNumber: '123-45-67890',
-    category: 'E-COMMERCE',
-    contactEmail: 'contact@mycompany.com',
-    contactPhone: '02-1234-5678'
-  }
-});
+const resolver = new KakaoChannelBindingResolver(config);
 
-// Register sender number
-const senderNumber = await channelService.addSenderNumber(channel.id, {
-  phoneNumber: '15881234',
-  purpose: 'MARKETING'
+const resolved = resolver.resolve({
+  providerId: "solapi-main",
+  channelAlias: "main",
+  senderKey: undefined,
+  plusId: undefined,
 });
+
+// precedence: explicit > alias > defaults > provider config
+console.log(resolved.senderKey, resolved.plusId);
 ```
 
-## Channel Verification
+### Example: provider lifecycle calls
 
-```typescript
-// Verify business information
-const verification = await channelService.verifyBusiness(channel.id, {
-  documents: [
-    { type: 'BUSINESS_LICENSE', url: 'https://docs.example.com/license.pdf' },
-    { type: 'REPRESENTATIVE_ID', url: 'https://docs.example.com/id.pdf' }
-  ]
-});
+```ts
+import { KakaoChannelLifecycleService } from "@k-msg/channel";
+
+const service = new KakaoChannelLifecycleService(provider);
 
-// Check verification status
-const status = await channelService.getVerificationStatus(channel.id);
-console.log('Verification status:', status);
+const channels = await service.list();
+if (channels.isSuccess) {
+  console.log(channels.value); // KakaoChannelListItem[] with source="api"
+}
 ```
 
-## Sender Number Management
+## Toolkit API (`@k-msg/channel/toolkit`)
 
-```typescript
-// List all sender numbers for a channel
-const senderNumbers = await channelService.getSenderNumbers(channel.id);
+In-memory channel/sender helpers are now toolkit-only exports:
 
-// Verify sender number with SMS
-await channelService.verifySenderNumber(senderNumber.id, '123456');
+- `KakaoChannelManager`
+- `KakaoSenderNumberManager`
+- `ChannelCRUD`
+- `PermissionManager`
+- `ChannelService`
+- verification helpers and legacy channel types
 
-// Check sender number status
-const numberStatus = await channelService.getSenderNumberStatus(senderNumber.id);
+```ts
+import { KakaoChannelManager } from "@k-msg/channel/toolkit";
 ```
 
 ## License

package/dist/index.d.ts

@@ -1,8 +1,7 @@
-export { KakaoChannelManager } from "./kakao/channel";
-export { KakaoSenderNumberManager } from "./kakao/sender-number";
-export { type AuditLogEntry, ChannelCRUD, type ChannelCRUDOptions, type PaginatedResult, type PaginationOptions, } from "./management/crud";
-export { type AccessContext, ActionType, type Permission, type PermissionCheck, PermissionManager, type PermissionResult, PermissionScope, ResourceType, type Role, type User, } from "./management/permissions";
-export { ChannelService } from "./services/channel.service";
-export * from "./types/channel.types";
-export { type AutoVerificationResult, type BusinessInfo, BusinessVerifier, type BusinessVerifierOptions, type DocumentValidationResult, type VerificationRequest, } from "./verification/business.verify";
-export { NumberVerifier, type NumberVerifierOptions, type PhoneNumberInfo, type PhoneVerificationRequest, type PhoneVerificationStatus, type SMSProvider, type VerificationAttempt, VerificationMethod, VerificationType, type VoiceProvider, } from "./verification/number.verify";
+/**
+ * Runtime channel APIs
+ */
+export { KakaoChannelBindingResolver } from "./runtime/kakao-channel-binding-resolver";
+export { KakaoChannelCapabilityService } from "./runtime/kakao-channel-capability.service";
+export { KakaoChannelLifecycleService } from "./runtime/kakao-channel-lifecycle.service";
+export type { KakaoChannelAddParams, KakaoChannelAliasEntry, KakaoChannelApiAdapter, KakaoChannelApiOperation, KakaoChannelAuthParams, KakaoChannelBinding, KakaoChannelBindingSource, KakaoChannelCapability, KakaoChannelCapabilityMode, KakaoChannelListItem, KakaoChannelListParams, KakaoChannelResolveInput, KakaoChannelResolverConfig, KakaoChannelRuntimeProvider, KakaoProviderConfigEntry, ResolvedKakaoChannelBinding, } from "./runtime/types";