패키지 가이드
프로젝트에 맞는 패키지를 빠르게 고를 수 있도록 역할별로 정리한 허브입니다.
- 먼저 읽기: 패키지 선택 가이드
- 대부분의 사용자 시작점: k-msg
- 저수준 커스터마이징이 필요하면: @k-msg/core
빠른 선택
섹션 제목: “빠른 선택”| 지금 필요한 것 | 먼저 볼 패키지 | 보통 같이 보는 것 |
|---|---|---|
| 앱에서 바로 메시지를 보내고 싶음 | k-msg | @k-msg/provider |
| Provider를 직접 구현하거나 저수준 제어가 필요함 | @k-msg/core | @k-msg/provider, @k-msg/messaging |
| 큐, 배달 추적, 런타임 어댑터가 필요함 | @k-msg/messaging | k-msg, @k-msg/provider |
| 템플릿 파싱과 변수 치환이 중심임 | @k-msg/template | k-msg |
| 채널/발신번호 운영 도구를 만들고 싶음 | @k-msg/channel | @k-msg/provider |
| 웹훅 런타임과 재시도 흐름이 필요함 | @k-msg/webhook | @k-msg/messaging |
| 배달 추적 데이터를 리포트로 보고 싶음 | @k-msg/analytics | @k-msg/messaging |
추천 읽는 순서
섹션 제목: “추천 읽는 순서”- 대부분의 앱 팀: 패키지 선택 가이드 -> k-msg -> 프로바이더 선택 가이드 -> 예제 가이드
- 플랫폼/인프라 팀: @k-msg/core -> @k-msg/messaging -> @k-msg/provider
- 운영/백오피스 도구 팀: @k-msg/channel -> @k-msg/webhook -> @k-msg/analytics
패키지별 역할
섹션 제목: “패키지별 역할”- @k-msg/analytics: 배달 추적 데이터를 기반으로 통계와 리포트를 만듭니다.
- @k-msg/channel: 프로바이더별 채널 lifecycle helper와 인메모리 toolkit helper를 제공합니다.
- @k-msg/core: 저수준 타입, Result, 에러, 복원력 유틸을 제공합니다.
- @k-msg/messaging: KMsg 뒤에서 라우팅, 큐, 배달 추적, 런타임 어댑터를 담당합니다.
- @k-msg/provider: 내장 provider 구현체와 onboarding 메타데이터를 제공합니다.
- @k-msg/template: 템플릿 파싱, 치환, lifecycle, toolkit 유틸을 제공합니다.
- @k-msg/webhook: 웹훅 runtime, persistence, 재시도, Cloudflare 어댑터를 제공합니다.
- k-msg: 대부분의 앱이 먼저 시작해야 하는 통합 facade입니다.