cime-sdk 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,806 @@
+import { AxiosInstance } from 'axios';
+import { EventEmitter } from 'events';
+
+/**
+ * ci.me API에서 사용되는 권한(Scope) 목록입니다.
+ */
+type CimeScope = 'READ:USER' | 'READ:CHANNEL' | 'READ:LIVE_CHAT' | 'WRITE:LIVE_CHAT' | 'READ:DONATION' | 'WRITE:USER_BLOCK' | 'READ:USER_BLOCK' | 'READ:LIVE_STREAM_KEY' | 'READ:SUBSCRIPTION' | 'READ:LIVE_STREAM_SETTINGS' | 'WRITE:LIVE_STREAM_SETTINGS' | 'READ:LIVE_CHAT_SETTINGS' | 'WRITE:LIVE_CHAT_SETTINGS' | 'WRITE:LIVE_CHAT_NOTICE';
+/**
+ * 토큰 발급/갱신 요청 인터페이스
+ */
+interface CimeTokenRequest {
+    grantType: 'authorization_code' | 'refresh_token';
+    clientId: string;
+    clientSecret: string;
+    code?: string;
+    refreshToken?: string;
+}
+/**
+ * 토큰 발급/갱신 응답 인터페이스
+ */
+interface CimeTokenResponse {
+    accessToken: string;
+    refreshToken: string;
+    expiresIn: number;
+    tokenType: string;
+    scope: string;
+}
+/**
+ * 토큰 취소 요청 인터페이스
+ */
+interface CimeRevokeTokenRequest {
+    clientId: string;
+    clientSecret: string;
+    token: string;
+    tokenTypeHint: 'access_token' | 'refresh_token';
+}
+
+/**
+ * 내 정보(채널) 조회 API의 응답 객체 인터페이스입니다.
+ */
+interface CimeUser {
+    channelId: string;
+    channelName: string;
+    channelHandle: string;
+    channelImageUrl: string;
+}
+
+/**
+ * 배열 형태의 데이터를 반환하는 API의 공통 content 인터페이스입니다.
+ * API 응답이 `{ content: { data: [...] } }` 형태일 때 사용합니다.
+ */
+interface CimeDataList<T> {
+    data: T[];
+}
+/**
+ * 채널 기본 정보
+ */
+interface CimeChannelInfo {
+    channelId: string;
+    channelName: string;
+    channelHandle: string;
+    channelImageUrl: string | null;
+    channelDescription: string;
+    followerCount: number;
+}
+/**
+ * 팔로워 정보
+ */
+interface CimeFollower {
+    channelId: string;
+    channelName: string;
+    channelHandle: string;
+    /** 팔로우 시작 시간 (ISO 8601) */
+    createdDate: string;
+}
+/**
+ * 팔로워 목록 조회 파라미터
+ */
+interface CimeChannelFollowersParams {
+    /** 페이지 번호 (0부터 시작, 기본값: 0) */
+    page?: number;
+    /** 페이지 크기 (기본값: 20) */
+    size?: number;
+}
+/**
+ * 구독자 정보
+ */
+interface CimeSubscriber {
+    channelId: string;
+    channelName: string;
+    channelHandle: string;
+    /** 연속 구독 개월 수 */
+    month: number;
+    /** 구독 티어 번호 */
+    tierNo: number;
+    /** 구독 시작 시간 (ISO 8601) */
+    createdDate: string;
+}
+/**
+ * 구독자 목록 조회 파라미터
+ */
+interface CimeChannelSubscribersParams {
+    /** 페이지 번호 (0부터 시작, 기본값: 0) */
+    page?: number;
+    /** 페이지 크기 (1~50, 기본값: 30) */
+    size?: number;
+    /** 정렬 기준 (기본값: 'RECENT') */
+    sort?: 'RECENT' | 'LONGER';
+}
+/**
+ * 채널 관리자 역할 종류
+ */
+type CimeStreamingRole = 'STREAMING_CHANNEL_OWNER' | 'STREAMING_CHANNEL_MANAGER' | 'STREAMING_CHAT_MANAGER' | 'STREAMING_SETTLEMENT_MANAGER';
+/**
+ * 채널 관리자 정보
+ */
+interface CimeManager {
+    managerChannelId: string;
+    managerChannelName: string;
+    managerChannelHandle: string;
+    userRole: CimeStreamingRole;
+    /** 역할 부여 일시 (ISO 8601) */
+    createdDate: string;
+}
+
+/**
+ * 커서 기반 페이지네이션 응답의 페이지 정보
+ */
+interface CimeCursorPage {
+    next: string | null;
+}
+/**
+ * 커서 기반 페이지네이션을 사용하는 API의 공통 content 인터페이스입니다.
+ */
+interface CimeCursorList<T> {
+    data: T[];
+    page: CimeCursorPage;
+}
+/**
+ * 라이브 방송 기본 정보
+ */
+interface CimeLive {
+    liveId: string;
+    liveTitle: string;
+    liveThumbnailImageUrl: string | null;
+    concurrentUserCount: number;
+    /** 라이브 시작 시간 (ISO 8601) */
+    openedDate: string | null;
+    /** 연령 제한 설정 여부 */
+    adult: boolean;
+    tags: string[];
+    categoryType: string | null;
+    liveCategory: string | null;
+    liveCategoryValue: string | null;
+    channelId: string;
+    channelName: string;
+    channelHandle: string;
+    channelImageUrl: string | null;
+}
+/**
+ * 라이브 목록 조회 파라미터
+ */
+interface CimeLivesParams {
+    /** 페이지 크기 (1~20, 기본값: 20) */
+    size?: number;
+    /** 다음 페이지 커서 값 */
+    next?: string;
+}
+/**
+ * 라이브 설정 정보
+ */
+interface CimeLiveSetting {
+    defaultLiveTitle: string;
+    category: Record<string, any> | null;
+    tags: string[];
+}
+/**
+ * 라이브 설정 변경 파라미터
+ * 모든 필드는 선택 사항이며, 전달된 필드만 업데이트됩니다.
+ */
+interface CimeUpdateLiveSettingParams {
+    /** 라이브 제목 (1~100자) */
+    defaultLiveTitle?: string;
+    /** 태그 목록 (최대 6개) */
+    tags?: string[];
+    /** 카테고리 ID. null로 설정 시 카테고리 제거 */
+    categoryId?: string | null;
+}
+/**
+ * 스트림 키 정보
+ */
+interface CimeStreamKey {
+    streamKey: string;
+}
+/**
+ * 라이브 방송 상태 정보
+ */
+interface CimeLiveStatus {
+    isLive: boolean;
+    title: string | null;
+    openedAt: string | null;
+}
+
+/**
+ * 채팅 허용 그룹 (모두, 팔로워 전용, 관리자 전용)
+ */
+type CimeChatAllowedGroup = 'ALL' | 'FOLLOWER' | 'MANAGER';
+/**
+ * 채팅 설정 정보
+ */
+interface CimeChatSettings {
+    chatAllowedGroup: CimeChatAllowedGroup;
+    /** 최소 팔로우 시간 (분). FOLLOWER 모드일 때 적용됩니다. */
+    minFollowerMinute: number;
+    /** 팔로워 모드에서 구독자 즉시 채팅 허용 여부 */
+    followerSubscriberChatAllow: boolean | null;
+}
+/**
+ * 채팅 설정 변경 파라미터
+ * 모든 필드는 선택사항이며, 전달된 필드만 업데이트됩니다.
+ */
+interface CimeUpdateChatSettingsParams {
+    /** 이모지 전용 모드 여부 */
+    chatEmojiMode?: boolean;
+    /** 채팅 딜레이 (초) */
+    chatSlowModeSec?: number;
+    chatAllowedGroup?: CimeChatAllowedGroup;
+    /** 최소 팔로우 시간 (분) */
+    minFollowerMinute?: number;
+    /** 팔로워 모드에서 구독자 즉시 채팅 허용 여부 */
+    followerSubscriberChatAllow?: boolean;
+}
+/**
+ * 채팅 메시지 전송 파라미터
+ */
+interface CimeSendChatMessageParams {
+    /** 전송할 메시지 (1~100자) */
+    message: string;
+    /** * 발신자 타입 (기본값: APP)
+     * - APP: 애플리케이션 소유자 이름으로 표시
+     * - USER: 인증된 사용자 본인 이름으로 표시
+     */
+    senderType?: 'APP' | 'USER';
+}
+/**
+ * 채팅 메시지 전송 응답
+ */
+interface CimeSendChatMessageResponse {
+    messageId: string;
+}
+/**
+ * 채팅 공지 등록 파라미터
+ * 주의: message 또는 messageId 중 하나는 반드시 제공되어야 합니다.
+ */
+interface CimeRegisterChatNoticeParams {
+    /** 새 메시지로 공지 등록 시 사용 (1~100자) */
+    message?: string;
+    /** 기존 메시지를 공지로 등록 시 사용 */
+    messageId?: string;
+}
+/**
+ * 실시간 채팅 이벤트의 프로필 정보
+ */
+interface CimeChatProfile {
+    nickname: string;
+}
+/**
+ * 실시간 CHAT 이벤트 수신 시 전달되는 데이터 페이로드
+ */
+interface CimeChatEventData {
+    /** 채팅이 발생한 채널의 ID */
+    channelId: string;
+    /** 메시지 작성자의 채널 ID */
+    senderChannelId: string;
+    /** 작성자 프로필 정보 */
+    profile: CimeChatProfile;
+    /** 채팅 메시지 원본 (이모티콘 토큰 포함 가능) */
+    content: string;
+    /** 메시지 전송 시간 (ISO 8601) */
+    messageTime: string;
+    /** 이모티콘 토큰 -> 이미지 URL 매핑 객체 */
+    emojis: Record<string, string>;
+}
+
+/**
+ * 카테고리 정보
+ */
+interface CimeCategory {
+    categoryId: string;
+    categoryType: string;
+    categoryValue: string;
+    posterImageUrl: string | null;
+}
+/**
+ * 카테고리 검색 파라미터
+ */
+interface CimeSearchCategoriesParams {
+    /** 검색 키워드. 미입력 시 전체 카테고리를 반환합니다. */
+    keyword?: string;
+    /** 검색 결과 수 (1~50, 기본값: 20) */
+    size?: number;
+}
+
+/**
+ * 사용자 추방 및 추방 해제 파라미터
+ */
+interface CimeRestrictUserParams {
+    /** 추방(또는 해제)할 사용자의 채널 ID */
+    targetChannelId: string;
+}
+/**
+ * 추방 사용자 목록 조회 파라미터
+ */
+interface CimeGetRestrictedUsersParams {
+    /** 페이지 크기 (1~50, 기본값: 20) */
+    size?: number;
+    /** 다음 페이지 커서 값 */
+    next?: string;
+}
+/**
+ * 추방된 사용자 정보
+ */
+interface CimeRestrictedUser {
+    restrictedChannelId: string;
+    restrictedChannelName: string;
+    restrictedChannelHandle: string;
+    /** 추방 일시 (ISO 8601) */
+    createdDate: string;
+    /** 추방 만료 일시. 영구 추방 시 null */
+    releaseDate: string | null;
+}
+
+type CimeSessionType = 'USER' | 'CLIENT';
+type CimeEventName = 'chat' | 'donation' | 'subscription';
+/**
+ * 세션 생성 응답
+ */
+interface CimeSessionResponse {
+    /** WebSocket 연결 URL */
+    url: string;
+}
+/**
+ * 수신되는 실시간 이벤트 데이터의 공통 구조
+ */
+interface CimeEventPayload<T = any> {
+    event: 'CHAT' | 'DONATION' | 'SUBSCRIPTION';
+    data: T;
+}
+/**
+ * EventClient 옵션
+ */
+interface CimeEventClientOptions {
+    /** 세션 유형 (USER: 인증된 사용자 권한, CLIENT: 앱 공개 권한) */
+    type: 'USER' | 'CLIENT';
+    /**
+     * [SDK 자동 처리]
+     * 재연결 시 사용할 Refresh Token.
+     * 이 값을 제공하면 재연결 시 자동으로 `auth.refresh()`를 호출하여 토큰을 갱신합니다.
+     */
+    refreshToken?: string;
+    /**
+     * [수동 처리]
+     * DB 조회 등 커스텀 토큰 갱신 로직이 필요한 경우 직접 작성하는 콜백 함수.
+     * `refreshToken` 필드를 사용했다면 이 함수는 생략해도 무방합니다.
+     */
+    onTokenRefresh?: () => Promise<void>;
+    /** 핑(Ping) 전송 간격 (밀리초, 기본값 60000ms = 1분) */
+    pingInterval?: number;
+}
+
+/**
+ * 후원 유형 (채팅 후원 또는 영상 후원)
+ */
+type CimeDonationType = 'CHAT' | 'VIDEO';
+/**
+ * 실시간 DONATION 이벤트 수신 시 전달되는 데이터 페이로드
+ */
+interface CimeDonationEventData {
+    /** 후원 유형 */
+    donationType: CimeDonationType;
+    /** 후원이 발생한 채널의 ID */
+    channelId: string;
+    /** 후원자의 채널 ID (익명 후원 시 null) */
+    donatorChannelId: string | null;
+    /** 후원자 닉네임 (익명 후원 시 null) */
+    donatorNickname: string | null;
+    /** 후원 금액 (빔 단위, 정밀도 손실 방지를 위해 문자열 사용) */
+    payAmount: string;
+    /** 후원 메시지 */
+    donationText: string;
+    /** 이모티콘 토큰 -> 이미지 URL 매핑 객체 */
+    emojis: Record<string, string>;
+}
+
+/**
+ * 실시간 SUBSCRIPTION 이벤트 수신 시 전달되는 데이터 페이로드
+ */
+interface CimeSubscriptionEventData {
+    /** 구독이 발생한 채널의 ID */
+    channelId: string;
+    /** 구독자의 채널 ID */
+    subscriberChannelId: string;
+    /** 구독자의 채널 이름 (닉네임) */
+    subscriberChannelName: string;
+    /** 연속 구독 개월 수 */
+    month: number;
+    /** 구독 티어 번호 */
+    tierNo: number;
+    /** 구독 메시지 (이모티콘 토큰 포함 가능) */
+    subscriptionMessage: string;
+    /** 이모티콘 토큰 -> 이미지 URL 매핑 객체 */
+    emojis: Record<string, string>;
+}
+
+interface CimeCommonResponse<T = unknown> {
+    code: number;
+    message: string | null;
+    content: T;
+}
+interface CimeErrorResponse {
+    statusCode: number;
+    message: string;
+}
+interface CimeClientOptions {
+    clientId?: string;
+    clientSecret?: string;
+    accessToken?: string;
+    refreshToken?: string;
+    scopes?: string[];
+    timeout?: number;
+    retries?: number;
+}
+
+declare class AuthAPI {
+    private readonly http;
+    private readonly config;
+    constructor(http: AxiosInstance, config: {
+        clientId?: string;
+        clientSecret?: string;
+    });
+    /**
+     * Authorization Code를 사용하여 Access Token과 Refresh Token을 발급받습니다.
+     * @param code Redirect URI로 전달받은 인가 코드
+     */
+    get(code: string): Promise<CimeTokenResponse>;
+    /**
+     * Refresh Token을 사용하여 Access Token을 갱신합니다.
+     * @param refreshToken 이전에 발급받은 리프레시 토큰
+     */
+    refresh(refreshToken: string): Promise<CimeTokenResponse>;
+    /**
+     * 내부 헬퍼: 토큰 발급 시 필요한 Client ID 및 Secret 유효성 검사 (Fail-fast)
+     */
+    private validateCredentials;
+}
+
+/**
+ * 사용자(User) 관련 API를 담당하는 클래스입니다.
+ */
+declare class UsersAPI {
+    private readonly httpClient;
+    private readonly options;
+    constructor(httpClient: AxiosInstance, options: CimeClientOptions);
+    /**
+     * 현재 Access Token에 연결된 사용자의 채널 정보를 조회합니다.
+     *
+     * @requires Scope: `READ:USER`
+     * @throws {CimeAPIError} Access Token이 없거나 만료되었을 때 (401), 또는 권한이 부족할 때 발생합니다.
+     * @returns 사용자의 채널 상세 정보
+     * * @example
+     * ```typescript
+     * const me = await client.users.get();
+     * console.log(`안녕하세요, ${me.channelName}님!`);
+     * ```
+     */
+    get(): Promise<CimeUser>;
+}
+
+/**
+ * 채널(Channel) 관련 API를 담당하는 클래스입니다.
+ * 채널 정보, 팔로워, 구독자, 관리자 목록 조회 기능을 제공합니다.
+ */
+declare class ChannelsAPI {
+    private readonly httpClient;
+    private readonly options;
+    constructor(httpClient: AxiosInstance, options: CimeClientOptions);
+    /**
+     * 채널 ID 목록으로 채널의 기본 정보를 조회합니다. (최대 20개)
+     *
+     * @requires Auth: `Client ID / Secret` (공개 API)
+     * @param channelIds - 조회할 채널 ID 문자열 또는 ID 문자열의 배열
+     * @returns 채널 정보 목록
+     * * @example
+     * ```typescript
+     * const { data } = await client.channels.getChannels(['12345', '67890']);
+     * ```
+     */
+    getChannels(channelIds: string | string[]): Promise<CimeDataList<CimeChannelInfo>>;
+    /**
+     * 인증된 사용자 채널의 팔로워 목록을 조회합니다.
+     *
+     * @requires Auth: `Access Token`
+     * @requires Scope: `READ:CHANNEL`
+     * @param params - 페이징 파라미터 (page, size)
+     * @returns 팔로워 목록
+     */
+    getFollowers(params?: CimeChannelFollowersParams): Promise<CimeDataList<CimeFollower>>;
+    /**
+     * 인증된 사용자 채널의 구독자 목록을 조회합니다.
+     *
+     * @requires Auth: `Access Token`
+     * @requires Scope: `READ:SUBSCRIPTION`
+     * @param params - 페이징 및 정렬 파라미터 (page, size, sort)
+     * @returns 구독자 목록
+     */
+    getSubscribers(params?: CimeChannelSubscribersParams): Promise<CimeDataList<CimeSubscriber>>;
+    /**
+     * 인증된 사용자 채널의 관리자 목록을 조회합니다.
+     *
+     * @requires Auth: `Access Token`
+     * @requires Scope: `READ:CHANNEL`
+     * @returns 관리자 목록
+     */
+    getManagers(): Promise<CimeDataList<CimeManager>>;
+}
+
+/**
+ * 라이브(Live) 및 스트리밍 관련 API를 담당하는 클래스입니다.
+ */
+declare class LiveAPI {
+    private readonly httpClient;
+    private readonly options;
+    constructor(httpClient: AxiosInstance, options: CimeClientOptions);
+    /**
+     * 현재 진행 중인 라이브 방송 목록을 조회합니다.
+     *
+     * @requires Auth: `Client ID / Secret` (공개 API)
+     * @param params - 커서 기반 페이징 파라미터 (size, next)
+     * @returns 라이브 목록과 다음 페이지 커서 정보
+     */
+    getLives(params?: CimeLivesParams): Promise<CimeCursorList<CimeLive>>;
+    /**
+     * 인증된 사용자 채널의 라이브 설정을 조회합니다.
+     *
+     * @requires Auth: `Access Token`
+     * @requires Scope: `READ:LIVE_STREAM_SETTINGS`
+     * @returns 라이브 설정 정보
+     */
+    getSettings(): Promise<CimeLiveSetting>;
+    /**
+     * 인증된 사용자 채널의 라이브 설정을 변경합니다. (전달된 필드만 업데이트)
+     *
+     * @requires Auth: `Access Token`
+     * @requires Scope: `WRITE:LIVE_STREAM_SETTINGS`
+     * @param params - 변경할 라이브 설정 데이터
+     */
+    updateSettings(params: CimeUpdateLiveSettingParams): Promise<void>;
+    /**
+     * 인증된 사용자 채널의 스트림 키(Stream Key)를 조회합니다.
+     * OBS 등 외부 방송 도구 연동 시 사용됩니다.
+     *
+     * @requires Auth: `Access Token`
+     * @requires Scope: `READ:LIVE_STREAM_KEY`
+     * @returns 스트림 키
+     */
+    getStreamKey(): Promise<CimeStreamKey>;
+    /**
+     * 특정 채널의 라이브 방송 여부와 상태를 확인합니다.
+     * 이 API는 인증 없이 호출할 수 있는 완전 공개 API입니다.
+     *
+     * @requires Auth: 불필요
+     * @param channelId - 상태를 조회할 채널의 ID
+     * @returns 라이브 상태 정보
+     */
+    getLiveStatus(channelId: string): Promise<CimeLiveStatus>;
+}
+
+/**
+ * 라이브 채팅(Chat) 설정 및 메시지 전송 관련 API를 담당하는 클래스입니다.
+ */
+declare class ChatAPI {
+    private readonly httpClient;
+    private readonly options;
+    constructor(httpClient: AxiosInstance, options: CimeClientOptions);
+    /**
+     * 인증된 사용자 채널의 채팅 설정을 조회합니다.
+     *
+     * @requires Auth: `Access Token`
+     * @requires Scope: `READ:LIVE_CHAT_SETTINGS`
+     * @returns 채팅 설정 정보
+     */
+    getSettings(): Promise<CimeChatSettings>;
+    /**
+     * 인증된 사용자 채널의 채팅 설정을 변경합니다. (전달된 필드만 업데이트)
+     *
+     * @requires Auth: `Access Token`
+     * @requires Scope: `WRITE:LIVE_CHAT_SETTINGS`
+     * @param params - 변경할 채팅 설정 데이터
+     */
+    updateSettings(params: CimeUpdateChatSettingsParams): Promise<void>;
+    /**
+     * 인증된 사용자의 채널 라이브 채팅에 메시지를 전송합니다.
+     *
+     * @requires Auth: `Access Token`
+     * @requires Scope: `WRITE:LIVE_CHAT`
+     * @param params - 전송할 메시지 정보 및 발신자 타입
+     * @returns 전송된 메시지 ID
+     */
+    sendMessage(params: CimeSendChatMessageParams): Promise<CimeSendChatMessageResponse>;
+    /**
+     * 인증된 사용자의 채널 라이브 채팅에 공지사항을 등록합니다.
+     *
+     * @requires Auth: `Access Token`
+     * @requires Scope: `WRITE:LIVE_CHAT_NOTICE`
+     * @param params - 등록할 공지 메시지 내용 또는 기존 메시지 ID
+     * @throws {Error} 파라미터가 모두 누락된 경우 서버 요청 전 사전 차단합니다.
+     */
+    registerNotice(params: CimeRegisterChatNoticeParams): Promise<void>;
+}
+
+/**
+ * 카테고리(Category) 관련 API를 담당하는 클래스입니다.
+ */
+declare class CategoriesAPI {
+    private readonly httpClient;
+    constructor(httpClient: AxiosInstance);
+    /**
+     * 라이브 설정 등에 사용할 카테고리를 키워드로 검색합니다.
+     *
+     * @requires Auth: `Client ID / Secret` (공개 API)
+     * @param params - 검색 키워드 및 페이지 크기 파라미터
+     * @returns 검색된 카테고리 목록
+     */
+    searchCategories(params?: CimeSearchCategoriesParams): Promise<CimeDataList<CimeCategory>>;
+}
+
+/**
+ * 사용자 차단 및 추방(Restrict) 관련 API를 담당하는 클래스입니다.
+ */
+declare class RestrictAPI {
+    private readonly httpClient;
+    private readonly options;
+    constructor(httpClient: AxiosInstance, options: CimeClientOptions);
+    /**
+     * 인증된 사용자의 채널에서 특정 사용자를 추방합니다.
+     *
+     * @requires Auth: `Access Token`
+     * @requires Scope: `WRITE:USER_BLOCK`
+     * @param params - 추방할 대상 채널 ID
+     */
+    restrictUser(params: CimeRestrictUserParams): Promise<void>;
+    /**
+     * 인증된 사용자의 채널에서 추방된 사용자 목록을 조회합니다.
+     *
+     * @requires Auth: `Access Token`
+     * @requires Scope: `READ:USER_BLOCK`
+     * @param params - 커서 기반 페이징 파라미터 (size, next)
+     * @returns 추방된 사용자 목록
+     */
+    getRestrictedUsers(params?: CimeGetRestrictedUsersParams): Promise<CimeCursorList<CimeRestrictedUser>>;
+    /**
+     * 인증된 사용자의 채널에서 특정 사용자의 추방을 해제합니다.
+     *
+     * @requires Auth: `Access Token`
+     * @requires Scope: `WRITE:USER_BLOCK`
+     * @param params - 추방 해제할 대상 채널 ID
+     */
+    unrestrictUser(params: CimeRestrictUserParams): Promise<void>;
+}
+
+/**
+ * 세션(Session) 및 이벤트 구독 제어를 담당하는 클래스입니다.
+ */
+declare class SessionsAPI {
+    private readonly httpClient;
+    constructor(httpClient: AxiosInstance);
+    /**
+     * WebSocket 연결을 위한 새로운 세션을 생성합니다.
+     *
+     * @param type - 세션 유형 ('USER' 또는 'CLIENT')
+     * @returns WebSocket URL을 포함한 세션 정보
+     */
+    createSession(type: CimeSessionType): Promise<CimeSessionResponse>;
+    /**
+     * 특정 세션에 이벤트를 구독합니다.
+     *
+     * @requires Auth: `Access Token`
+     * @param event - 구독할 이벤트 이름 (chat, donation, subscription)
+     * @param sessionKey - 세션 키
+     */
+    subscribeEvent(event: CimeEventName, sessionKey: string): Promise<void>;
+    /**
+     * 특정 세션에서 이벤트 구독을 해제합니다.
+     *
+     * @requires Auth: `Access Token`
+     * @param event - 구독 해제할 이벤트 이름
+     * @param sessionKey - 세션 키
+     */
+    unsubscribeEvent(event: CimeEventName, sessionKey: string): Promise<void>;
+}
+
+type CimeLiveEventName = 'CHAT' | 'DONATION' | 'SUBSCRIPTION';
+declare interface CimeEventClient {
+    on(event: 'CHAT', listener: (data: CimeChatEventData) => void): this;
+    on(event: 'DONATION', listener: (data: CimeDonationEventData) => void): this;
+    on(event: 'SUBSCRIPTION', listener: (data: CimeSubscriptionEventData) => void): this;
+    on(event: 'connected', listener: () => void): this;
+    on(event: 'disconnected', listener: () => void): this;
+    on(event: 'error', listener: (error: Error) => void): this;
+    on(event: 'reconnecting', listener: () => void): this;
+    on(event: string | symbol, listener: (...args: any[]) => void): this;
+    emit(event: 'CHAT', data: CimeChatEventData): boolean;
+    emit(event: 'DONATION', data: CimeDonationEventData): boolean;
+    emit(event: 'SUBSCRIPTION', data: CimeSubscriptionEventData): boolean;
+    emit(event: 'connected'): boolean;
+    emit(event: 'disconnected'): boolean;
+    emit(event: 'error', error: Error): boolean;
+    emit(event: 'reconnecting'): boolean;
+    emit(event: string | symbol, ...args: any[]): boolean;
+}
+/**
+ * ci.me API의 실시간 이벤트를 수신하기 위한 WebSocket 클라이언트입니다.
+ */
+declare class CimeEventClient extends EventEmitter {
+    private readonly sessionsApi;
+    private readonly options;
+    private ws;
+    private sessionKey;
+    private pingTimer;
+    private reconnectTimer;
+    private isConnecting;
+    private isIntentionalClose;
+    private readonly activeSubscriptions;
+    constructor(sessionsApi: SessionsAPI, options: CimeEventClientOptions);
+    connect(): Promise<void>;
+    /**
+     * 실시간 이벤트를 구독합니다.
+     * @param event - 'CHAT' | 'DONATION' | 'SUBSCRIPTION'
+     */
+    subscribe(event: CimeLiveEventName): Promise<void>;
+    /**
+     * 실시간 이벤트 구독을 해제합니다.
+     * @param event - 'CHAT' | 'DONATION' | 'SUBSCRIPTION'
+     */
+    unsubscribe(event: CimeLiveEventName): Promise<void>;
+    disconnect(): void;
+    private handleMessage;
+    private startPing;
+    private cleanup;
+    private handleReconnect;
+}
+
+/**
+ * ci.me API를 사용하기 위한 메인 클라이언트 클래스입니다.
+ */
+declare class CimeClient {
+    private readonly httpClient;
+    private options;
+    readonly auth: AuthAPI;
+    readonly users: UsersAPI;
+    readonly channels: ChannelsAPI;
+    readonly live: LiveAPI;
+    readonly chat: ChatAPI;
+    readonly categories: CategoriesAPI;
+    readonly restrict: RestrictAPI;
+    readonly sessions: SessionsAPI;
+    constructor(options: CimeClientOptions);
+    setAccessToken(token: string): void;
+    /**
+     * 실시간 이벤트를 수신하기 위한 WebSocket 클라이언트를 생성합니다.
+     */
+    createEventClient(options: CimeEventClientOptions): CimeEventClient;
+    /** * OAuth 인증 플로우를 통해 Access Token을 발급받고 클라이언트에 설정합니다.
+     * @param code Redirect URI로 전달받은 인가 코드
+     * @throws 인증 정보(clientId/Secret)가 없으면 에러를 반환합니다.
+     */
+    authorize(code: string): Promise<CimeTokenResponse>;
+}
+
+/**
+ * ci.me API 요청 중 발생하는 에러를 캡슐화한 커스텀 에러 클래스입니다.
+ * HTTP 상태 코드와 API가 반환한 상세 메시지를 포함합니다.
+ */
+declare class CimeAPIError extends Error {
+    readonly statusCode: number;
+    /**
+     * @param errorResponse - API 서버에서 반환한 에러 객체
+     */
+    constructor(errorResponse: CimeErrorResponse);
+}
+
+/**
+ * 채팅 메시지 내의 이모티콘 토큰을 <img> 태그로 변환합니다.
+ * 따로 UI를 만드실 계획이 아니시라면, 별 쓸모는 없습니다.
+ * @param data 채팅 이벤트 데이터 (content, emojis)
+ * @param className <img> 태그에 부여할 CSS 클래스명 (기본값: 'cime-emoji')
+ * @returns 변환된 HTML 문자열
+ */
+declare function renderChatEmojisToHTML(data: Pick<CimeChatEventData, 'content' | 'emojis'>, className?: string): string;
+
+/**
+ * 로컬 패키지의 현재 버전을 반환합니다.
+ */
+declare function getVersion(): string;
+
+export { CimeAPIError, type CimeCategory, type CimeChannelFollowersParams, type CimeChannelInfo, type CimeChannelSubscribersParams, type CimeChatAllowedGroup, type CimeChatEventData, type CimeChatProfile, type CimeChatSettings, CimeClient, type CimeClientOptions, type CimeCommonResponse, type CimeCursorList, type CimeCursorPage, type CimeDataList, type CimeDonationEventData, type CimeDonationType, type CimeErrorResponse, CimeEventClient, type CimeEventClientOptions, type CimeEventName, type CimeEventPayload, type CimeFollower, type CimeGetRestrictedUsersParams, type CimeLive, type CimeLiveEventName, type CimeLiveSetting, type CimeLiveStatus, type CimeLivesParams, type CimeManager, type CimeRegisterChatNoticeParams, type CimeRestrictUserParams, type CimeRestrictedUser, type CimeRevokeTokenRequest, type CimeScope, type CimeSearchCategoriesParams, type CimeSendChatMessageParams, type CimeSendChatMessageResponse, type CimeSessionResponse, type CimeSessionType, type CimeStreamKey, type CimeStreamingRole, type CimeSubscriber, type CimeSubscriptionEventData, type CimeTokenRequest, type CimeTokenResponse, type CimeUpdateChatSettingsParams, type CimeUpdateLiveSettingParams, type CimeUser, getVersion, renderChatEmojisToHTML };