# zerodytrash/tiktok-live-connector architecture

> Architecture diagram of the GitHub repository zerodytrash/tiktok-live-connector, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/zerodytrash/tiktok-live-connector
- Repository: https://github.com/zerodytrash/tiktok-live-connector

## Overview

##### 프로젝트 유형과 목적
- Node.js 환경에서 TikTok LIVE 내부 WebCast 푸시 서비스에 연결해 실시간 이벤트(채팅, 선물 등)를 수신하는 라이브러리.

##### 주요 컴포넌트 식별
- 사용자 애플리케이션 (Client App)
- tiktok-live-connector 라이브러리
- WebcastPushConnection (진입점)
- tiktokHttpClient (REST 요청 처리)
- tiktokSignatureProvider (요청 서명)
- tiktokCookieJar (쿠키 관리)
- webcastWebsocket (WebSocket 연결)
- webcastProtobuf (이벤트 파싱)
- utils, errors 등 보조 모듈
- 외부 시스템
- TikTok WebCast HTTP API (폴링)
- TikTok WebCast WebSocket 서버

##### 컴포넌트 상호작용
- Client App → WebcastPushConnection.connect()
- () 내부에서
a. SignatureProvider로 요청 파라미터 서명
b. HttpClient로 WebCast HTTP 엔드포인트 호출 (쿠키 Jar 사용)
c. WebSocket 업그레이드 가능 시 webcastWebsocket로 WS 연결
- WebSocket/HTTP 폴링으로 수신된 protobuf 메시지를 webcastProtobuf가 파싱
- WebcastPushConnection이 파싱된 이벤트를 사용자 코드에 emit

##### 다이어그램 작성 가이드
- 각 노드(컴포넌트)에 명확한 라벨 사용
- 화살표로 데이터 흐름/의존성 표시
- 단순한 직사각형 노드로 구분(색상은 선택 사항)
- 필요한 경우 HTTP vs WebSocket 경로를 별도 라인으로 구분

이 구조를 기본으로, 실제 서비스 환경에 맞춰 인증, 프록시(proxy-agent), 옵션(requestOptions/websocketOptions) 등을 추가로 레이어링하면 됩니다.

## Diagram (Mermaid)

```mermaid
graph TD
    A["Client App"]:::client
    B["WebcastPushConnection"]:::connector
    D["tiktokSignatureProvider"]:::service
    C["tiktokHttpClient"]:::service
    E["tiktokCookieJar"]:::service
    F["webcastWebsocket"]:::service
    G["webcastProtobuf"]:::service
    H["TikTok HTTP API"]:::external
    I["TikTok WebSocket"]:::external

    A -->|"require + connect()"| B
    B --> D
    B --> C
    B --> E
    B --> F
    C -->|"REST polling"| H
    F -->|"WebSocket"| I
    H --> G
    I --> G
    G -->|"parsed events"| A

    click B "https://github.com/zerodytrash/tiktok-live-connector/blob/main/src/index.js"
    click C "https://github.com/zerodytrash/tiktok-live-connector/blob/main/src/lib/tiktokHttpClient.js"
    click D "https://github.com/zerodytrash/tiktok-live-connector/blob/main/src/lib/tiktokSignatureProvider.js"
    click E "https://github.com/zerodytrash/tiktok-live-connector/blob/main/src/lib/tiktokCookieJar.js"
    click F "https://github.com/zerodytrash/tiktok-live-connector/blob/main/src/lib/webcastWebsocket.js"
    click G "https://github.com/zerodytrash/tiktok-live-connector/blob/main/src/lib/webcastProtobuf.js"

    classDef client fill:#f9f,stroke:#333,stroke-width:1px
    classDef connector fill:#bbf,stroke:#333,stroke-width:1px
    classDef service fill:#bfb,stroke:#333,stroke-width:1px
    classDef external fill:#fbb,stroke:#333,stroke-width:1px
```
