@vibexnpm/talkx 8.6.0 → 8.9.0

package/dist/index.d.ts

@@ -26,6 +26,8 @@ export const ErrorTypes: {
     readonly CONNECTION_FAILED: 'CONNECTION_FAILED';
     readonly CONNECTION_LOST: 'CONNECTION_LOST';
     readonly CONNECTION_TIMEOUT: 'CONNECTION_TIMEOUT';
+    /** 회사 구독 없음(결제 전·해지) — 웹소켓이 멈췄다. 결제 확인 뒤 `connect()` 를 다시 부른다. */
+    readonly SUBSCRIPTION_REQUIRED: 'SUBSCRIPTION_REQUIRED';
     readonly JWT_INVALID: 'JWT_INVALID';
     readonly JWT_EXPIRED: 'JWT_EXPIRED';
     readonly JWT_PARSE_FAILED: 'JWT_PARSE_FAILED';
@@ -1044,14 +1046,20 @@ export interface DecisionResponse {
     optionId: string;
 }
 
+/**
+ * 회사 역할. `GUEST` 는 회사 밖에서 초대받아 그 회사 계정을 가진 사람이다 — 초대받은 방에서 채팅만 하고 PM·AI 버튼·조직도·
+ * 방 만들기·초대 등은 서버가 막는다(403 `GUEST_FORBIDDEN`). 화면 노출 판단용이며 인가 근거는 아니다.
+ */
+export type CompanyRole = 'PARTNER' | 'MEMBER' | 'GUEST';
+
 /** 로그인한 회원. `userId` 는 메시지 발신자 식별과 같은 값이다. */
 export interface LoginMember {
     userId: string;
     email?: string | null;
     nickname?: string | null;
     profileUrl?: string | null;
-    /** 회사 역할 — 클라이언트가 파트너 화면 노출을 결정한다. 인가 근거는 아니다(서버가 재확인). */
-    companyRole: 'PARTNER' | 'MEMBER';
+    /** 회사 역할 — 클라이언트가 파트너·게스트 화면 노출을 결정한다. 인가 근거는 아니다(서버가 재확인). */
+    companyRole: CompanyRole;
     preferredLanguage?: string | null;
     /**
      * 초기 비밀번호를 아직 안 바꿨는가 — `true` 면 **비밀번호 변경 화면으로 보내라**.
@@ -1063,11 +1071,11 @@ export interface LoginMember {
 }
 
 /**
- * `TalkFlowClient.loginUser` 응답.
- *
- * 회사 선택 단계가 없다 — 로그인 키가 전역 유일이라 이메일 하나로 회원과 회사가 함께 정해진다.
+ * `TalkFlowClient.loginUser` 의 로그인 성공 응답. 회사 선택이 필요하면 대신 {@link WorkspaceSelection} 이 온다 —
+ * `workspaceSelectionRequired` 로 가른다.
  */
 export interface LoginResult {
+    workspaceSelectionRequired?: false;
     /** SDK가 저장·회전하는 갱신 자격. 직접 API를 쓰는 경우에만 응답에서 사용한다. */
     refreshToken?: string;
     /** 서버 현재 시각 및 refresh 만료 시각, Unix epoch 밀리초. */
@@ -1083,6 +1091,23 @@ export interface LoginResult {
     user: LoginMember;
 }
 
+/** 로그인 회사 선택지 하나. */
+export interface Workspace {
+    projectId: string;
+    companyName: string | null;
+    /** 그 회사에서의 역할 — 선택 화면에 «게스트» 표시를 붙이는 데 쓴다. */
+    companyRole: CompanyRole;
+}
+
+/**
+ * 로그인 회사 선택 결과 — 같은 이메일의 여러 회사 계정에서 비밀번호가 둘 이상 맞았다. **토큰이 없고 저장된 세션은 그대로다.**
+ * 고른 `projectId` 를 실어 같은 이메일·비밀번호로 `loginUser` 를 다시 부른다.
+ */
+export interface WorkspaceSelection {
+    workspaceSelectionRequired: true;
+    workspaces: Workspace[];
+}
+
 /** 회사 조직도의 회원 — 초대 UI 에 필요한 것만. */
 export interface DirectoryMember {
     userId: string;
@@ -1124,7 +1149,7 @@ export interface MyProfile {
     phone?: string | null;
     profileUrl?: string | null;
     /** 회사 역할 — 방 역할(ParticipantResponse.role)과 다른 축이다. */
-    companyRole: 'PARTNER' | 'MEMBER';
+    companyRole: CompanyRole;
     orgNodeId?: string | null;
     orgName?: string | null;
     preferredLanguage?: string | null;
@@ -1170,6 +1195,10 @@ export interface ParticipantResponse {
     role: 'OWNER' | 'ADMIN' | 'MEMBER' | 'ASSISTANT';
     /** 참가 시각(epoch millis). */
     joinedAt: number;
+    /**
+     * 회사 역할 — 게스트 배지(`GUEST`)용. 방 역할({@link role})과 다른 축이다. PM(ASSISTANT)·정보를 못 찾은 참여자는 없다.
+     */
+    companyRole?: CompanyRole;
 }
 
 /** 채팅방 last message preview. */
@@ -1280,6 +1309,8 @@ export interface RoomListMemberInfo {
     userId: string;
     nickname?: string | null;
     profileUrl?: string | null;
+    /** 회사 역할 — 방금 들어온 게스트에도 다시 읽지 않고 배지를 그린다. PM·역할을 모르는 경로는 없다. */
+    companyRole?: CompanyRole;
 }
 
 export interface RoomListUpdateEvent {
@@ -1478,7 +1509,7 @@ export interface AssistantProgressEvent {
     /** 진행 주체 페르소나 ID. */
     personaId: string | null;
     /** 진행 단계 — `active:true` 일 때. 종료 시 null. */
-    phase: 'THINKING' | 'SEARCHING' | 'PLANNING' | 'DOCUMENT_ANALYSIS' | 'VIDEO_ANALYSIS' | 'WRITING' | null;
+    phase: 'THINKING' | 'SEARCHING' | 'PLANNING' | 'DOCUMENT_ANALYSIS' | 'VIDEO_ANALYSIS' | 'WEB_READING' | 'WRITING' | null;
     /** DOCUMENT_ANALYSIS의 실측 진행률. 같은 phase heartbeat 사이와 재입장 후에도 보존된다. */
     progress?: DocumentAnalysisProgress | null;
     /** phase 의 기본 표시 라벨(예: "생각 중…"). SDK 매핑 — 커스텀하려면 `phase` 사용. 종료 시 null. */
@@ -1549,7 +1580,7 @@ export interface AssistantRoomProgressEvent {
     /** 표시 기준이 된 stream (가장 최근 갱신). 없으면 null. */
     streamId: string | null;
     personaId: string | null;
-    phase: 'THINKING' | 'SEARCHING' | 'PLANNING' | 'DOCUMENT_ANALYSIS' | 'VIDEO_ANALYSIS' | 'WRITING' | null;
+    phase: 'THINKING' | 'SEARCHING' | 'PLANNING' | 'DOCUMENT_ANALYSIS' | 'VIDEO_ANALYSIS' | 'WEB_READING' | 'WRITING' | null;
     progress?: DocumentAnalysisProgress | null;
     label: string | null;
     /** 표시 기준 stream 의 누적 본문. `textAvailable:false` 거나 진행 중이 아니면 null. */
@@ -1562,7 +1593,7 @@ export interface AssistantRoomProgressEvent {
 export interface AssistantProgressStreamSnapshot {
     streamId: string;
     personaId: string | null;
-    phase: 'THINKING' | 'SEARCHING' | 'PLANNING' | 'DOCUMENT_ANALYSIS' | 'VIDEO_ANALYSIS' | 'WRITING' | null;
+    phase: 'THINKING' | 'SEARCHING' | 'PLANNING' | 'DOCUMENT_ANALYSIS' | 'VIDEO_ANALYSIS' | 'WEB_READING' | 'WRITING' | null;
     progress?: DocumentAnalysisProgress | null;
     label: string | null;
     text: string | null;
@@ -1934,7 +1965,7 @@ export interface ChatMessageReceivedPayload {
 
 export interface MemberChangePayload {
     roomId: string;
-    members: Array<{ userId: string; nickname?: string; profileUrl?: string | null }>;
+    members: Array<{ userId: string; nickname?: string; profileUrl?: string | null; companyRole?: CompanyRole }>;
     participantCount: number;
     timestamp?: number;
 }
@@ -1968,7 +1999,7 @@ export interface RetentionCleanupPayload {
 /**
  * TalkFlowClient 이벤트 맵 — 런타임 {@code TalkFlowClient.js} 의 {@code this.emit(...)} 호출 기반.
  *
- * <p><b>Connection 관련</b>: stateChange, connected, disconnected, reconnecting, reconnected, resumed, connectionError, tokenSet, loggedOut</p>
+ * <p><b>Connection 관련</b>: stateChange, connected, disconnected, reconnecting, reconnected, resumed, subscriptionRequired, connectionError, tokenSet, loggedOut</p>
  * <p><b>Chat 관련 (ChatClient 이벤트를 이 이름으로 re-emit)</b>: chatMessage, newChatMessage, messageUpdated, messageDeleted, reactionChanged, linkPreviewAttached, messageRead, typing, assistantProgress, memberJoined, memberLeft, roomSubscribed, roomUnsubscribed, roomListSubscribed, roomListUnsubscribed, roomListUpdate, roomListMessage, roomListCreated, roomListJoined, roomListLeft, roomListSelfLeft, roomListRoomUpdated, retentionCleanup</p>
  * <p><b>Push 관련</b>: pushEnabled, pushFailed, pushNotification</p>
  * <p><b>WebRTC 관련</b>: localStreamStarted, localStreamStopped, remoteTrack, screenShareStarted, screenShareEnded, deviceChange, mediaStateChanged, callStarted, callEnded, callRequested, callAccepted, callRejected, callCancelled, callInvitation, callBusy, incomingCall, incomingCallWhileBusy, userJoined, userLeft, participantLeft, participantMediaState, peerConnected, peerDisconnected, peerClosed, webrtcError</p>
@@ -1993,6 +2024,15 @@ export interface TalkFlowClientEvents {
      * 발행된다(두 이벤트가 겹치지 않아 재동기화가 중복 실행되지 않는다).</p>
      */
     resumed: { reason: 'visibilitychange' | 'pageshow' | 'online' };
+    /**
+     * 회사 구독 없음 — 서버가 웹소켓 연결·구독·전송을 `NOT_SUBSCRIBED` 로 거부했다(결제 전·해지 회사). SDK 는 재연결하지 않고
+     * 토큰도 거부된 것으로 기록하지 않는다(로그인·토큰 갱신은 그대로). 대기에 들어갈 때 한 번 발행되며 `connectionError` 는 내지 않는다.
+     *
+     * <p>앱: 파트너면 결제 화면, 그 밖은 «회사 구독이 필요합니다. 관리자에게 문의하세요.» 안내. 결제가 확인되면
+     * (`subscription === 'ACTIVE'`) 같은 토큰으로 `connect()` 를 다시 부른다. 구독 확인 일시 실패(`SUBSCRIPTION_CHECK_UNAVAILABLE`)는
+     * 이 이벤트가 아니다 — 평소처럼 재연결한다.</p>
+     */
+    subscriptionRequired: { code: 'NOT_SUBSCRIBED'; message: string };
     connectionError: unknown;
     tokenSet: { userId: string };
     loggedOut: void;
@@ -2602,16 +2642,18 @@ export default class TalkFlowClient implements SdkEventEmitter<TalkFlowClientEve
     /**
      * 회원 로그인 — 클라이언트 생성 **전에** 호출한다. Server Key 도 고객사 BFF 도 필요 없다.
      * 응답의 `clientKey`/`projectId`/`accessToken` 이 그대로 SDK 초기화 입력이다.
-     * 회사 선택 단계가 없다 — 로그인 키가 전역 유일이다.
+     * 같은 이메일로 비밀번호가 맞는 회사 계정이 둘 이상이면 {@link WorkspaceSelection} 이 온다 — 고른 `projectId` 로 다시 부른다.
      */
     static loginUser(options: {
         serverUrl: string;
         email: string;
         password: string;
-    }): Promise<LoginResult>;
+        /** 회사 선택 응답에서 고른 회사. */
+        projectId?: string;
+    }): Promise<LoginResult | WorkspaceSelection>;
 
-    /** 회원 로그인 (인스턴스) — 재로그인·계정 전환용. 성공 시 토큰을 자동 설정한다. */
-    loginUser(credentials: { email: string; password: string }): Promise<LoginResult>;
+    /** 회원 로그인 (인스턴스) — 재로그인·계정 전환용. 성공 시 토큰을 자동 설정한다. 회사 선택 결과면 토큰을 설정하지 않는다. */
+    loginUser(credentials: { email: string; password: string; projectId?: string }): Promise<LoginResult | WorkspaceSelection>;
 
     /** localStorage의 refresh로 복구. 세션이 없으면 null, 네트워크/서버 장애는 reject. */
     static restoreSession(options: { serverUrl: string }): Promise<LoginResult | null>;
@@ -2648,6 +2690,8 @@ export default class TalkFlowClient implements SdkEventEmitter<TalkFlowClientEve
     /**
      * 연결 완료까지 기다립니다. 이전 연결의 자동 복구가 이어지는 동안 재시도 한도 소진으로 reject하지 않습니다.
      * 복구 연결 시 resolve하며, 명시적 disconnect·인증 종료·최초 연결 실패 시 reject합니다.
+     * 회사 구독이 없으면(서버 `NOT_SUBSCRIBED`) `code: 'NOT_SUBSCRIBED'`·`type: 'SUBSCRIPTION_REQUIRED'` 로 reject 하고
+     * 재연결하지 않습니다 — {@link TalkFlowClientEvents.subscriptionRequired} 참고.
      */
     connect(jwt?: string, options?: ConnectOptions): Promise<void>;
     disconnect(): Promise<void>;
@@ -2655,6 +2699,11 @@ export default class TalkFlowClient implements SdkEventEmitter<TalkFlowClientEve
     setToken(token: string): Promise<void>;
     updateToken(newToken: string): Promise<void>;
     isConnected(): boolean;
+    /**
+     * 회사 구독 대기 중인가 — 서버가 웹소켓을 `NOT_SUBSCRIBED` 로 거부해 연결을 멈췄다(결제 전·해지 회사).
+     * 결제가 확인되면(`GET /api/v1/company/billing` 의 `subscription === 'ACTIVE'`) 같은 토큰으로 `connect()` 를 다시 부른다.
+     */
+    isSubscriptionRequired(): boolean;
     getState(): ConnectionStateValue;
     hasToken(): boolean;