@lemoncloud/chatic-sockets-api 0.26.403 → 0.26.517

package/dist/libs/wss/wss-types.d.ts

@@ -1,698 +0,0 @@
-/**
- * `wss-types.ts`
- * - WebSocket 통신을 위한 타입 정의
- *
- * @author      Steve <steve@lemoncloud.io>
- * @date        2020-06-30 initial version
- * @author      Aiden <aiden@lemoncloud.io>
- * @date        2025-07-31 refactored for WebSocket support
- * @date        2026-01-11 redesigned with envelope pattern
- *
- * @copyright   (C) 2026 LemonCloud Co Ltd. - All Rights Reserved.
- */
-import type { AuthState } from '../../modules/auth/types';
-import type { UserHead } from '../../modules/auth/model';
-/**
- * interface: `ConnectionInfo`
- * - 연결 정보 공통 모델
- */
-export interface ConnectionInfo {
-    /** stage of api-gateway */
-    stage?: string;
-    /** connected domain */
-    domain?: string;
-    /** api-gateway id */
-    apiId?: string;
-    /** connection-id */
-    connectionId?: string;
-}
-/**
- * interface: `SocketEvent`
- * - Lambda에서 수신하는 WebSocket 이벤트
- */
-export interface SocketEvent extends ConnectionInfo {
-    /** request-id */
-    id: string;
-    type: WSSEventType;
-    route: WSSRouteKeyType;
-    authorization?: string;
-    stage: WSSStageType;
-    direction: WSSDirectionType;
-    disconnectCode?: WSSDisconnectStatusCode;
-    reason: string;
-    domain: string;
-    origin: string;
-    agent: string;
-    connectionId: string;
-    messageId: string;
-    apiId: string;
-    connectedAt: number;
-    remote: string;
-    body?: string;
-    param: {
-        [key: string]: string;
-    };
-}
-/**
- * lookup table
- */
-declare const $LUT: {
-    /**
-     * EventType
-     */
-    EventType: {
-        '': string;
-        /** CONNECT */
-        CONNECT: string;
-        /** DISCONNECT */
-        DISCONNECT: string;
-        /** MESSAGE */
-        MESSAGE: string;
-    };
-    /**
-     * RouteKeyType
-     */
-    RouteKeyType: {
-        /** $connect */
-        $connect: string;
-        /** $disconnect */
-        $disconnect: string;
-        /** $default */
-        $default: string;
-        /** echo */
-        echo: string;
-    };
-    /**
-     * StageType
-     */
-    StageType: {
-        '': string;
-        /** dev */
-        dev: string;
-        /** prod */
-        prod: string;
-        /** local */
-        local: string;
-    };
-    /**
-     * DirectionType
-     */
-    DirectionType: {
-        '': string;
-        /** IN */
-        IN: string;
-        /** OUT */
-        OUT: string;
-    };
-    /**
-     * DisconnectStatusCode
-     */
-    DisconnectStatusCode: {
-        /** 1000 - Normal closure */
-        1000: string;
-        /** 1001 - Server shutdown/page navigation */
-        1001: string;
-        /** 1002 - Protocol error */
-        1002: string;
-        /** 1003 - Unsupported data */
-        1003: string;
-        /** 1005 - No status code received */
-        1005: string;
-        /** 1006 - Abnormal closure */
-        1006: string;
-        /** 1007 - Invalid frame payload */
-        1007: string;
-        /** 1008 - Policy violation */
-        1008: string;
-        /** 1009 - Message too big */
-        1009: string;
-        /** 1011 - Internal server error */
-        1011: string;
-        /** 1012 - Service restart */
-        1012: string;
-        /** 1013 - Try again later */
-        1013: string;
-        /** 1015 - TLS handshake failure */
-        1015: string;
-    };
-    /**
-     * EventDomainType
-     * - 이벤트 도메인
-     */
-    EventDomainType: {
-        '': string;
-        /** auth - authentication domain */
-        auth: string;
-        /** system */
-        system: string;
-        /** sync - client state synchronization */
-        sync: string;
-        /** model */
-        model: string;
-        /** channel - dynamic channel subscription */
-        channel: string;
-        /** chat - chat message domain (send/read via $protocol) */
-        chat: string;
-        /** user */
-        user: string;
-        /** @deprecated use 'sync' instead */
-        presence: string;
-        /** @deprecated use 'sync' instead */
-        position: string;
-    };
-    /**
-     * SystemActionType
-     * - system 도메인 액션
-     */
-    SystemActionType: {
-        '': string;
-        /** ping */
-        ping: string;
-        /** pong */
-        pong: string;
-        /** info */
-        info: string;
-        /** message */
-        message: string;
-        /** error */
-        error: string;
-    };
-    /**
-     * ModelActionType
-     * - data 도메인 액션
-     */
-    ModelActionType: {
-        '': string;
-        /** create */
-        create: string;
-        /** update */
-        update: string;
-        /** delete */
-        delete: string;
-    };
-    /**
-     * SyncActionType
-     */
-    SyncActionType: {
-        '': string;
-        /** update - client state update */
-        update: string;
-        /** info - get current state */
-        info: string;
-        /** @deprecated use 'update' instead */
-        sync: string;
-    };
-    /**
-     * AuthActionType
-     * - auth domain actions
-     */
-    AuthActionType: {
-        '': string;
-        /** update - state synchronization */
-        update: string;
-    };
-    /**
-     * ChannelActionType
-     * - channel domain actions
-     */
-    ChannelActionType: {
-        '': string;
-        /** subscribe - join channels */
-        subscribe: string;
-        /** unsubscribe - leave channels */
-        unsubscribe: string;
-    };
-    /**
-     * ChatActionType
-     * - chat domain actions
-     */
-    ChatActionType: {
-        '': string;
-        /** send - send chat message */
-        send: string;
-        /** read - mark as read */
-        read: string;
-        /** start - start conversation */
-        start: string;
-        /** feed - get chat feed */
-        feed: string;
-        /** mine - get my channels */
-        mine: string;
-        /** users - get channel members */
-        users: string;
-        /** invite - invite users to channel */
-        invite: string;
-        /** leave - leave or kick from channel */
-        leave: string;
-        /** update-channel - update channel info */
-        'update-channel': string;
-        /** update-join - update join (participation) settings */
-        'update-join': string;
-        /** delete-channel - delete channel */
-        'delete-channel': string;
-        /** get-self - get or create personal channel */
-        'get-self': string;
-        /** error - error response */
-        error: string;
-    };
-    /**
-     * UserActionType
-     * - user domain actions
-     */
-    UserActionType: {
-        '': string;
-        /** invite: 유저초대 */
-        invite: string;
-        /** my-site: 접근 가능 사이트 목록 조회 */
-        'my-site': string;
-        /** make-site: 사이트 생성 */
-        'make-site': string;
-        /** update-profile: 프로필 수정 */
-        'update-profile': string;
-        /** update-site: 플레이스 수정 */
-        'update-site': string;
-        /** error - error response */
-        error: string;
-    };
-    /**
-     * ClientStatusType
-     */
-    ClientStatusType: {
-        '': string;
-        /** green - online */
-        green: string;
-        /** red - offline */
-        red: string;
-        /** yellow - away/idle */
-        yellow: string;
-    };
-};
-/**
- * type: `WSSEventType
- */
-export declare type WSSEventType = keyof typeof $LUT.EventType;
-/**
- * type: `WSSRouteKeyType
- */
-export declare type WSSRouteKeyType = keyof typeof $LUT.RouteKeyType;
-/**
- * type: `WSSDirectionType
- */
-export declare type WSSDirectionType = keyof typeof $LUT.DirectionType;
-/**
- * type: `WSSDisconnectStatusCode
- */
-export declare type WSSDisconnectStatusCode = keyof typeof $LUT.DisconnectStatusCode;
-/**
- * type: `WSSStageType
- */
-export declare type WSSStageType = keyof typeof $LUT.StageType;
-/**
- * type: `WSSEventDomainType
- */
-export declare type WSSEventDomainType = keyof typeof $LUT.EventDomainType;
-/**
- * type: `WSSSystemActionType
- */
-export declare type WSSSystemActionType = keyof typeof $LUT.SystemActionType;
-/**
- * type: `WSSModelActionType
- */
-export declare type WSSModelActionType = keyof typeof $LUT.ModelActionType;
-/**
- * type: `WSSSyncActionType`
- */
-export declare type WSSSyncActionType = keyof typeof $LUT.SyncActionType;
-/**
- * type: `WSSAuthActionType`
- */
-export declare type WSSAuthActionType = keyof typeof $LUT.AuthActionType;
-/**
- * type: `WSSChannelActionType`
- */
-export declare type WSSChannelActionType = keyof typeof $LUT.ChannelActionType;
-/**
- * type: `WSSChatActionType`
- */
-export declare type WSSChatActionType = keyof typeof $LUT.ChatActionType;
-/**
- * type: `WSSUserActionType`
- */
-export declare type WSSUserActionType = keyof typeof $LUT.UserActionType;
-/**
- * type: `ClientStatusType`
- */
-export declare type ClientStatusType = keyof typeof $LUT.ClientStatusType;
-/**
- * type: `WSSActionType`
- */
-export declare type WSSActionType = WSSSystemActionType | WSSModelActionType | WSSSyncActionType | WSSAuthActionType | WSSChannelActionType | WSSChatActionType | WSSUserActionType;
-/**
- * interface: `WSSConnectParam`
- */
-export interface WSSConnectParam {
-    /** get connection info after connect */
-    info?: string | boolean;
-    /** trigger auth event on connect (token if string) */
-    auth?: string | boolean;
-    /** join default channel */
-    default?: string | boolean;
-    /** use notify queue */
-    notify?: string | boolean;
-    /** (test) throw error */
-    throws?: string;
-    /** channel ids to subscribe */
-    channels?: string[];
-    /** device-id  */
-    deviceId?: string;
-    /** device-name */
-    deviceName?: string;
-}
-/**
- * interface: `WSSEnvelope`
- * - 양방향 WebSocket 통신 메시지 봉투
- */
-export interface WSSEnvelope<T = any> {
-    /** event domain */
-    type: WSSEventDomainType;
-    /** action within domain */
-    action: WSSActionType;
-    /** (optional) payload data */
-    payload?: T;
-    /** (optional) message-id (for Server) */
-    mid?: string;
-    /** (optional) meta data (for Server) */
-    meta?: WSSMeta;
-    /** (internal) target user-ids for broadcast (only for server.) */
-    userIds?: string[];
-}
-/**
- * interface: `WSSMeta`
- * - 메시지 메타데이터
- */
-export interface WSSMeta {
-    /** timestamp (ms) */
-    ts: number;
-    /** sequence number */
-    seq?: number;
-    /** target channel */
-    channel?: string;
-    /** reference-id (for ack) */
-    ref?: string;
-}
-/**
- * interface: `WSSPayload`
- * - base payload
- */
-export interface WSSPayload {
-    /** payload-id */
-    id?: string;
-    /** reference id (for ack) */
-    ref?: string;
-}
-/**
- * interface: `SystemPayload`
- * - system domain payload
- */
-export interface SystemPayload extends WSSPayload {
-    /** content */
-    content?: string;
-    /** ping-pong count */
-    count?: number;
-}
-/**
- * interface: `ClientSyncPayload`
- * - client sync domain payload
- */
-export interface ClientSyncPayload extends WSSPayload {
-    /**
-     * tick count (from Server)
-     * 1. [Client] sends its current tick(Payload) to Server ONLY if tick is changed.
-     * 2. [Server] compares Client.tick with its own tick:
-     *   - if equal, no action needed (Client is in sync)
-     *   - if different, Server responds with updated state and its current tick
-     *
-     * NOTE 주의! 무한 핑/퐁
-     */
-    tick: number;
-    /** x position (for Client) */
-    posX: number;
-    /** y position (for Client) */
-    posY: number;
-    /** (optional) client timestamp (ms) */
-    ts?: number;
-    /**
-     * ONLY for Client.
-     * - status indicator
-     */
-    status: ClientStatusType;
-}
-/**
- * interface: `ModelSyncPayload`
- * - model sync domain payload
- * - only for Server
- */
-export interface ModelSyncPayload extends WSSPayload {
-    /** id of model */
-    sourceId?: string;
-    /** type of model */
-    sourceType?: string;
-    /** service of source */
-    service?: string;
-    /** sid of model */
-    sid?: string;
-    /** uid of model */
-    uid?: string;
-    /** gid of model */
-    gid?: string;
-    /** oid of model (owner) */
-    oid?: string;
-}
-/**
- * interface: `AuthPayload`
- * - auth domain payload for bidirectional communication
- */
-export interface AuthPayload extends WSSPayload {
-    /** [Client] JWT token (issued by main backend) */
-    token?: string;
-    /** dry-run execution flag */
-    dryRun?: boolean;
-    /** [Server] current auth state */
-    state?: AuthState;
-    /** [Server] state transition timestamp */
-    stateAt?: number;
-    /** [Server] internal error */
-    error?: string;
-    /** (internal) authed conn-id */
-    connId?: string;
-    /** (internal) authed device-id */
-    deviceId?: string;
-    /** (internal) authed auth-id */
-    authId?: string;
-    /** (internal) authed member-id */
-    memberId?: string;
-    /** [Server] member info on success */
-    readonly member$?: UserHead;
-}
-/**
- * interface: `ChannelPayload`
- * - channel domain payload for subscribe/unsubscribe
- */
-export interface ChannelPayload extends WSSPayload {
-    /** [Client] channel ids to subscribe/unsubscribe */
-    channels?: string[];
-    /** [Server] channel ids successfully subscribed */
-    subscribed?: string[];
-    /** [Server] channel ids successfully unsubscribed */
-    unsubscribed?: string[];
-}
-/**
- * interface: `ChatSendPayload`
- * - chat:send request payload
- */
-export interface ChatSendPayload extends WSSPayload {
-    /** target channel id */
-    channelId: string;
-    /** message content */
-    content: string;
-    /** message type (default: "text") */
-    contentType?: string;
-    /** thread/reply parent id */
-    parentId?: string;
-}
-/**
- * interface: `ChatReadPayload`
- * - chat:read request payload
- */
-export interface ChatReadPayload extends WSSPayload {
-    /** target channel id */
-    channelId: string;
-    /** last read chat number (>= 1) */
-    chatNo: number;
-}
-/**
- * interface: `ChatErrorPayload`
- * - chat:error response payload
- */
-export interface ChatErrorPayload extends WSSPayload {
-    /** error message */
-    error: string;
-}
-/**
- * interface: `ChatStartPayload`
- * - chat:start request payload
- */
-export interface ChatStartPayload extends WSSPayload {
-    /** channel type: dm, self, public, private */
-    stereo: 'dm' | 'self' | 'public' | 'private';
-    /** channel name */
-    name?: string;
-    /** user ids to invite (excluding self) */
-    userIds?: string[];
-    /** first message content */
-    content?: string;
-    /** message type (default: "text") */
-    contentType?: string;
-}
-/**
- * interface: `ChatFeedPayload`
- * - chat:feed request payload
- */
-export interface ChatFeedPayload extends WSSPayload {
-    /** target channel id */
-    channelId: string;
-    /** cursor: fetch chatNo < cursorNo (exclusive upper bound) */
-    cursorNo?: number;
-    /** page size (default 20) */
-    limit?: number;
-}
-/**
- * interface: `ChatMinePayload`
- * - chat:mine request payload
- */
-export interface ChatMinePayload extends WSSPayload {
-    /** page size (default 5) */
-    limit?: number;
-    /** page number (default 0) */
-    page?: number;
-    /** include detail */
-    detail?: boolean;
-}
-/**
- * interface: `ChatUsersPayload`
- * - chat:users request payload
- */
-export interface ChatUsersPayload extends WSSPayload {
-    /** target channel id */
-    channelId: string;
-    /** page size (default 5) */
-    limit?: number;
-    /** page number (default 0) */
-    page?: number;
-    /** include detail */
-    detail?: boolean;
-}
-/**
- * interface: `ChatInvitePayload`
- * - chat:invite request payload
- */
-export interface ChatInvitePayload extends WSSPayload {
-    /** target channel id */
-    channelId: string;
-    /** user ids to invite */
-    userIds: string[];
-}
-/**
- * interface: `ChatLeavePayload`
- * - chat:leave request payload
- */
-export interface ChatLeavePayload extends WSSPayload {
-    /** target channel id */
-    channelId: string;
-    /** kick target user id (omit for self-leave) */
-    userId?: string;
-    /** kick reason */
-    reason?: string;
-}
-/**
- * interface: `ChatUpdateChannelPayload`
- * - chat:update-channel request payload
- */
-export interface ChatUpdateChannelPayload extends WSSPayload {
-    /** target channel id */
-    channelId: string;
-    /** channel name */
-    name?: string;
-    /** channel description */
-    desc?: string;
-    /** channel stereo */
-    stereo?: '' | 'dm' | 'self' | 'public' | 'private';
-    /** invite rule */
-    inviteRule?: '' | 'owner' | 'all';
-}
-/**
- * interface: `ChatUpdateJoinPayload`
- * - chat:update-join request payload
- */
-export interface ChatUpdateJoinPayload extends WSSPayload {
-    /** target channel id (joinId = channelId@userId, userId from conn.uid) */
-    channelId: string;
-    /** nick name in channel */
-    nick?: string;
-    /** notification setting */
-    notify?: '' | 'all' | 'mention' | 'none';
-}
-/**
- * interface: `ChatDeleteChannelPayload`
- * - chat:delete-channel request payload
- */
-export interface ChatDeleteChannelPayload extends WSSPayload {
-    /** target channel id */
-    channelId: string;
-}
-/**
- * interface: `UserMakeSitePayload`
- * - user:make-site request payload
- */
-export interface UserMakeSitePayload extends WSSPayload {
-    /** place name */
-    name: string;
-}
-/**
- * interface: `UserInvitePayload`
- * - user:invite request payload
- */
-export interface UserInvitePayload extends WSSPayload {
-    /** (optional) target channel id  */
-    channelId?: string;
-    /** user name to invite */
-    name: string;
-    /** user phone to invite */
-    phone: string;
-}
-/**
- * interface: `UserUpdateProfilePayload`
- * - user:update-profile request payload
- */
-export interface UserUpdateProfilePayload extends WSSPayload {
-    /** name */
-    name?: string;
-    /** nick */
-    nick?: string;
-    /** thumbnail image (base64 encoded) */
-    thumbnail?: string;
-}
-/**
- * interface: `UserUpdateSitePayload`
- * - user:update-site request payload
- * - 주의) sid 없으면 현재 세션의 sid로 요청됨!
- */
-export interface UserUpdateSitePayload extends WSSPayload {
-    /** target site-id */
-    sid?: string;
-    /** name */
-    name?: string;
-    /** thumbnail image (base64 encoded) */
-    thumbnail?: string;
-}
-export default $LUT;