@vibexnpm/talkx 3.0.8 → 3.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vibexnpm/talkx",
3
- "version": "3.0.8",
3
+ "version": "3.2.0",
4
4
  "type": "module",
5
5
  "description": "TalkFlow SDK - Chat & WebRTC unified client",
6
6
  "main": "dist/talkflow-sdk.umd.js",
@@ -11,6 +11,13 @@ import { WebSocketPaths, LogLevel, RoomListEventType, ChatRoomType, DefaultConfi
11
11
 
12
12
  const MAX_FILES_PER_MESSAGE = 20;
13
13
 
14
+ /**
15
+ * 방 PM 프롬프트 레이어 본문 한도.
16
+ * 서버 도메인 상수(PmPromptLayer.ROOM_CONTENT_MAX)의 미러 — 서버가 바뀌면 여기도 함께 올려야 한다.
17
+ * 값이 뒤처지면 서버는 받아주는데 SDK 가 먼저 막아 "저장이 안 된다"로 보인다.
18
+ */
19
+ const MAX_ROOM_PM_PROMPT_LENGTH = 20000;
20
+
14
21
  class ChatClient extends EventEmitter {
15
22
  /**
16
23
  * @param {Object} options
@@ -643,11 +650,11 @@ class ChatClient extends EventEmitter {
643
650
  /**
644
651
  * 방 PM 프롬프트 레이어 등록/수정 (upsert) — <b>방 주인(OWNER) 전용</b>.
645
652
  *
646
- * <p>저장 시 새 버전이 자동 기록된다 ({@link #getRoomPmPromptVersions}). 본문 한도 2,000자.
653
+ * <p>저장 시 새 버전이 자동 기록된다 ({@link #getRoomPmPromptVersions}). 본문 한도 20,000자.
647
654
  * 비주인 호출은 403 ({@code NOT_ROOM_ADMIN}).</p>
648
655
  *
649
656
  * @param {string} roomId - 채팅방 ID
650
- * @param {string} content - 레이어 본문 (1~2,000자). 방의 목적/맥락/금지사항 등 PM 에게 줄 추가 지시문.
657
+ * @param {string} content - 레이어 본문 (1~20,000자). 방의 목적/맥락/금지사항 등 PM 에게 줄 추가 지시문.
651
658
  * @returns {Promise<Object>} 저장된 PmPromptLayer
652
659
  *
653
660
  * @example
@@ -657,8 +664,8 @@ class ChatClient extends EventEmitter {
657
664
  if (typeof content !== 'string' || !content.trim()) {
658
665
  throw new Error('upsertRoomPmPrompt requires non-blank content');
659
666
  }
660
- if (content.length > 2000) {
661
- throw new Error('upsertRoomPmPrompt content exceeds 2000 characters');
667
+ if (content.length > MAX_ROOM_PM_PROMPT_LENGTH) {
668
+ throw new Error(`upsertRoomPmPrompt content exceeds ${MAX_ROOM_PM_PROMPT_LENGTH} characters`);
662
669
  }
663
670
 
664
671
  const response = await this.apiClient.put(`/api/v1/rooms/${roomId}/pm-prompt`, { content });
@@ -1756,7 +1763,7 @@ class ChatClient extends EventEmitter {
1756
1763
  *
1757
1764
  * @param {string} roomId - 채팅방 ID
1758
1765
  * @param {string} messageId - 메시지 ID
1759
- * @param {string} message - 수정할 내용 (max 5000자)
1766
+ * @param {string} message - 수정할 내용 (max 20000자)
1760
1767
  * @returns {Promise<Object>}
1761
1768
  *
1762
1769
  * @example
@@ -2451,6 +2458,15 @@ class ChatClient extends EventEmitter {
2451
2458
  cutoffTime: event.cutoffTime
2452
2459
  });
2453
2460
  break;
2461
+ case RoomListEventType.ROOM_UNREAD_UPDATED:
2462
+ // 다른(또는 이) 기기에서 내가 읽어 방 미독이 바뀜 → badge 를 절대값으로 세팅.
2463
+ // roomUnreadCount 는 delta 가 아니라 절대값, unreadVersion 은 순서 역전 판별용.
2464
+ this.emit('roomListUnreadUpdated', {
2465
+ roomId: event.roomId,
2466
+ roomUnreadCount: event.roomUnreadCount,
2467
+ unreadVersion: event.unreadVersion
2468
+ });
2469
+ break;
2454
2470
  default:
2455
2471
  this.logger.warn('Unknown room list event type:', event.eventType);
2456
2472
  }
@@ -0,0 +1,125 @@
1
+ /**
2
+ * 방별 미독 카운트 계산기 (READ_SYNC_DESIGN v2.1 §6).
3
+ *
4
+ * <p>SDK 는 방 목록 상태를 소유하지 않는다(페이징·필터·프레임워크 상태와 충돌). 대신 순서 역전에
5
+ * 안전한 "카운트 계산"만 이 헬퍼로 제공하고, 앱이 결과를 자신의 room store 에 반영한다.</p>
6
+ *
7
+ * <p><b>왜 단순 절대값 세팅이 안 되나</b>: 서로 다른 발신 흐름에서 나온 이벤트는 도착 순서가 논리적
8
+ * 발생 순서와 다를 수 있다. 예컨대 내가 방을 읽어 나간 {@code ROOM_UNREAD_UPDATED(count=0, v=13)} 이
9
+ * 신규 {@code MESSAGE_RECEIVED(+1, v=12)} 보다 먼저 도착할 수 있다. 단순히 절대값을 덮으면 뒤늦게 온
10
+ * v12 delta 가 badge 를 1 로 되돌린다. 그래서 방마다 스냅샷(마지막 절대값)과 그 이후의 delta 를 분리
11
+ * 보관하고, version 으로 이미 반영된 delta 를 정리한다.</p>
12
+ *
13
+ * <p><b>방별 상태</b>: {@code snapshotCount}/{@code snapshotVersion}(마지막 절대값) +
14
+ * {@code pendingDeltas}(messageId → {version, delta}). 표시값 = snapshotCount + Σ pending.delta.</p>
15
+ *
16
+ * <p><b>버전 전제</b>: 순서 정합성은 서버가 이벤트/응답에 {@code version} 을 실어줄 때만 보장된다.
17
+ * version 이 아예 없는 구서버 구간에서는 순서 역전을 판별할 수 없다 — 이 경우 이미 versioned baseline 이
18
+ * 있으면 비교 불가한 legacy 스냅샷을 무시해 최신 pair 를 지키고, 최종 정합은 REST 재조회에 의존한다.</p>
19
+ *
20
+ * @example
21
+ * const reconciler = new RoomUnreadReconciler(client.userId); // JWT 에서 SDK 가 추출한 내 userId
22
+ * // 초기 REST 페이지를 baseline 으로 투입
23
+ * rooms.forEach(r => reconciler.applySnapshot(r.id, r.unreadCount, r.unreadVersion));
24
+ * client.on('roomListMessage', e => { reconciler.applyMessageReceived(e); render(e.roomId); });
25
+ * client.on('roomListUnreadUpdated', e => { reconciler.applySnapshot(e.roomId, e.roomUnreadCount, e.unreadVersion); render(e.roomId); });
26
+ * function render(roomId) { store.setBadge(roomId, reconciler.getCount(roomId)); } // null 이면 REST 로 표시
27
+ */
28
+ export class RoomUnreadReconciler {
29
+ /**
30
+ * @param {string} currentUserId - 내 사용자 ID. SDK 가 JWT 에서 추출한 값을 {@code client.userId} 로
31
+ * 얻는다(별도 관리 불필요). 내가 보낸 메시지의 MESSAGE_RECEIVED 가 내 badge 를 올리지 않도록 걸러내는
32
+ * 데만 쓰는 <b>표시용 값</b>이라 보안 결정에 관여하지 않는다. (서버도 발신자를 unread 대상에서 제외하지만,
33
+ * 방 리스트 이벤트는 발신자에게도 전달되므로 클라에서 한 번 더 거른다.)
34
+ */
35
+ constructor(currentUserId) {
36
+ this._currentUserId = currentUserId;
37
+ /** @type {Map<string, {snapshotCount: (number|null), snapshotVersion: (number|null), pendingDeltas: Map<string, {version: (number|null), delta: number}>}>} */
38
+ this._rooms = new Map();
39
+ }
40
+
41
+ _room(roomId) {
42
+ let state = this._rooms.get(roomId);
43
+ if (!state) {
44
+ state = { snapshotCount: null, snapshotVersion: null, pendingDeltas: new Map() };
45
+ this._rooms.set(roomId, state);
46
+ }
47
+ return state;
48
+ }
49
+
50
+ /**
51
+ * MESSAGE_RECEIVED(delta +1) 반영.
52
+ * @param {{roomId: string, messageId: string, actorId?: string, unreadVersion?: (number|null)}} event
53
+ */
54
+ applyMessageReceived(event) {
55
+ if (!event || !event.roomId || !event.messageId) return;
56
+ // 발신자 본인 메시지 → 내 badge 증가 금지.
57
+ if (event.actorId != null && event.actorId === this._currentUserId) return;
58
+
59
+ const state = this._room(event.roomId);
60
+ // 같은 메시지 중복 수신(서버측 멱등 race 복구 등) → 한 번만.
61
+ if (state.pendingDeltas.has(event.messageId)) return;
62
+
63
+ const version = event.unreadVersion == null ? null : event.unreadVersion;
64
+ // 이미 baseline 에 반영된 delta(스냅샷 version 이하) → 무시.
65
+ if (state.snapshotVersion != null && version != null && version <= state.snapshotVersion) return;
66
+
67
+ state.pendingDeltas.set(event.messageId, { version, delta: 1 });
68
+ }
69
+
70
+ /**
71
+ * 절대값 스냅샷 반영 — REST 응답 또는 ROOM_UNREAD_UPDATED.
72
+ * @param {string} roomId
73
+ * @param {(number|null|undefined)} count 방별 내 미독 절대값. null/undefined 면 무시(미계산 방).
74
+ * @param {(number|null|undefined)} version 그 카운트가 확정된 방 version.
75
+ */
76
+ applySnapshot(roomId, count, version) {
77
+ if (!roomId || count == null) return;
78
+ const v = version == null ? null : version;
79
+ const state = this._room(roomId);
80
+
81
+ // 이미 versioned baseline 이 있는데 version 없는(구서버) 스냅샷이 오면 비교 불가 → 무시.
82
+ // 그대로 count 를 덮으면 snapshotVersion 은 최신인데 count 는 옛 값인 (옛 count, 최신 version) 조합이
83
+ // 되어, 백엔드가 원자 read 로 막은 순서 훼손이 SDK 에서 재현된다.
84
+ if (state.snapshotVersion != null && v == null) return;
85
+
86
+ // 더 오래된 스냅샷은 무시(stale).
87
+ if (state.snapshotVersion != null && v != null && v < state.snapshotVersion) return;
88
+
89
+ state.snapshotCount = count;
90
+ if (v != null) state.snapshotVersion = v;
91
+
92
+ // 이 스냅샷에 이미 반영된 pending 제거, 더 최신 pending 은 보존(v13 유실 방지).
93
+ // version 이 있을 때만 정리 가능 — version 없는 스냅샷(구서버)은 pending 을 건드리지 않는다.
94
+ if (v != null) {
95
+ for (const [messageId, d] of state.pendingDeltas) {
96
+ if (d.version == null || d.version <= v) {
97
+ state.pendingDeltas.delete(messageId);
98
+ }
99
+ }
100
+ }
101
+ }
102
+
103
+ /**
104
+ * 방의 현재 표시 카운트.
105
+ * @param {string} roomId
106
+ * @returns {(number|null)} baseline(스냅샷)이 아직 없으면 null — 앱은 REST 조회 결과로 표시한다.
107
+ */
108
+ getCount(roomId) {
109
+ const state = this._rooms.get(roomId);
110
+ if (!state || state.snapshotCount == null) return null;
111
+ let sum = state.snapshotCount;
112
+ for (const d of state.pendingDeltas.values()) sum += d.delta;
113
+ return sum;
114
+ }
115
+
116
+ /** 방을 상태에서 제거(퇴장/추방 등). */
117
+ removeRoom(roomId) {
118
+ this._rooms.delete(roomId);
119
+ }
120
+
121
+ /** 전체 초기화(로그아웃/재연결 리셋 등). */
122
+ clear() {
123
+ this._rooms.clear();
124
+ }
125
+ }
package/src/constants.js CHANGED
@@ -298,7 +298,14 @@ export const RoomListEventType = {
298
298
  /** 방장에 의한 추방 + 영구 차단 → payload 는 ROOM_KICKED 와 동일, 재입장 거부됨. */
299
299
  ROOM_BANNED: 'ROOM_BANNED',
300
300
  /** 메시지 보관 기간 정리 → cutoffTime 이전 메시지를 UI에서 제거. */
301
- MESSAGE_RETENTION_CLEANUP: 'MESSAGE_RETENTION_CLEANUP'
301
+ MESSAGE_RETENTION_CLEANUP: 'MESSAGE_RETENTION_CLEANUP',
302
+ /**
303
+ * 내 unread 가 변경됨 → 방 리스트 badge 를 roomUnreadCount 절대값으로 세팅(delta 아님).
304
+ * 내가 어느 기기에서 읽든 같은 사용자의 다른 세션에 전달돼 크로스-디바이스로 badge 를 맞춘다.
305
+ * unreadVersion 으로 순서 역전(읽음 0 이 신규 메시지보다 먼저 도착)을 방어한다.
306
+ * SDK 는 이를 roomListUnreadUpdated 이벤트로 emit 한다.
307
+ */
308
+ ROOM_UNREAD_UPDATED: 'ROOM_UNREAD_UPDATED'
302
309
  };
303
310
 
304
311
  /**
package/src/index.js CHANGED
@@ -84,6 +84,8 @@ export { default as ConnectionManager } from './core/ConnectionManager.js';
84
84
 
85
85
  // 채팅
86
86
  export { default as ChatClient } from './chat/ChatClient.js';
87
+ // 방 미독 계산기 — ROOM_UNREAD_UPDATED / MESSAGE_RECEIVED 를 순서 역전에 안전하게 합산(READ_SYNC_DESIGN §6).
88
+ export { RoomUnreadReconciler } from './chat/RoomUnreadReconciler.js';
87
89
 
88
90
  // WebRTC
89
91
  export { default as WebRTCClient } from './webrtc/WebRTCClient.js';
@@ -42,6 +42,7 @@ const CHAT_EVENT_MAP = [
42
42
  ['roomListBanned', 'roomListBanned'],
43
43
  ['roomListSelfBanned', 'roomListSelfBanned'],
44
44
  ['roomListRoomUpdated', 'roomListRoomUpdated'],
45
+ ['roomListUnreadUpdated', 'roomListUnreadUpdated'],
45
46
  ['retentionCleanup', 'retentionCleanup']
46
47
  ];
47
48
 
package/types/index.d.ts CHANGED
@@ -484,6 +484,7 @@ export const RoomListEventType: {
484
484
  readonly ROOM_KICKED: 'ROOM_KICKED';
485
485
  readonly ROOM_BANNED: 'ROOM_BANNED';
486
486
  readonly MESSAGE_RETENTION_CLEANUP: 'MESSAGE_RETENTION_CLEANUP';
487
+ readonly ROOM_UNREAD_UPDATED: 'ROOM_UNREAD_UPDATED';
487
488
  };
488
489
  export type RoomListEventTypeValue = typeof RoomListEventType[keyof typeof RoomListEventType];
489
490
 
@@ -766,6 +767,11 @@ export interface ChatRoomResponse {
766
767
  description?: string;
767
768
  creatorId: string;
768
769
  unreadCount?: number | null;
770
+ /**
771
+ * unreadCount 가 확정된 방 version — {@link RoomUnreadReconciler} 의 baseline.
772
+ * 미참여 방 등 unread 미계산 응답 또는 구버전 서버에서는 없을 수 있음.
773
+ */
774
+ unreadVersion?: number | null;
769
775
  isParticipating?: boolean | null;
770
776
  activeParticipantCount: number;
771
777
  messageRetentionHours?: number | null;
@@ -851,9 +857,32 @@ export interface RoomListUpdateEvent {
851
857
  * SDK 내부에서 같은 메시지의 중복 수신 (서버측 멱등 race 복구 등) dedup 용도. 다른 eventType 에서는 undefined.
852
858
  */
853
859
  messageId?: string;
860
+ /**
861
+ * {@code ROOM_UNREAD_UPDATED} 전용 — 방별 내 미독 메시지 수 <b>절대값</b>(delta 아님).
862
+ * 다른 eventType 에서는 undefined. 전용 이벤트 {@link RoomUnreadUpdatedEvent} 로도 받을 수 있다.
863
+ */
864
+ roomUnreadCount?: number;
865
+ /**
866
+ * unread 를 바꾼 원자 연산이 확정한 방 단위 version. {@code MESSAGE_RECEIVED} 와
867
+ * {@code ROOM_UNREAD_UPDATED} 에 실려, 순서 역전을 {@link RoomUnreadReconciler} 가 판별한다.
868
+ */
869
+ unreadVersion?: number;
854
870
  [extra: string]: unknown;
855
871
  }
856
872
 
873
+ /**
874
+ * `roomListUnreadUpdated` 이벤트 payload — 내가 어느 기기에서 읽든 같은 사용자의 다른 세션에 전달된다.
875
+ *
876
+ * <p>{@link RoomUnreadReconciler.applySnapshot} 에 그대로 넣으면 순서 역전에 안전하게 badge 를 계산할 수 있다.</p>
877
+ */
878
+ export interface RoomUnreadUpdatedEvent {
879
+ roomId: string;
880
+ /** 방별 내 미독 메시지 수 절대값. */
881
+ roomUnreadCount: number;
882
+ /** 그 카운트가 확정된 방 version. */
883
+ unreadVersion: number;
884
+ }
885
+
857
886
  /** 포그라운드 푸시 알림 payload. */
858
887
  export interface PushNotificationPayload {
859
888
  title: string;
@@ -1333,6 +1362,8 @@ export interface TalkFlowClientEvents {
1333
1362
  /** 본인이 영구 차단당함. */
1334
1363
  roomListSelfBanned: RoomListUpdateEvent;
1335
1364
  roomListRoomUpdated: RoomListUpdateEvent;
1365
+ /** 내가 어느 기기에서 읽든 방별 미독 절대값(+version)을 통지 — 크로스-디바이스 badge 동기화. */
1366
+ roomListUnreadUpdated: RoomUnreadUpdatedEvent;
1336
1367
  retentionCleanup: RetentionCleanupPayload;
1337
1368
 
1338
1369
  // 갭 복구 — 복구된 메시지 자체는 일반 chatMessage 로 재생되므로 아래는 모두 선택 구독용.
@@ -1434,6 +1465,8 @@ export interface ChatClientEvents {
1434
1465
  /** 본인이 영구 차단당함. */
1435
1466
  roomListSelfBanned: RoomListUpdateEvent;
1436
1467
  roomListRoomUpdated: RoomListUpdateEvent;
1468
+ /** 내가 어느 기기에서 읽든 방별 미독 절대값(+version)을 통지 — 크로스-디바이스 badge 동기화. */
1469
+ roomListUnreadUpdated: RoomUnreadUpdatedEvent;
1437
1470
  retentionCleanup: RetentionCleanupPayload;
1438
1471
  messageRead: MessageReadEventPayload;
1439
1472
  typing: TypingEvent;
@@ -2021,3 +2054,32 @@ export class Logger {
2021
2054
  export class ConnectionManager {}
2022
2055
  export class MediaStreamManager {}
2023
2056
  export class PeerConnectionManager {}
2057
+
2058
+ /**
2059
+ * 방 미독 카운트 계산기 (READ_SYNC_DESIGN §6).
2060
+ *
2061
+ * <p>SDK 는 방 목록 상태를 소유하지 않는다 — 순서 역전에 안전한 카운트 계산만 제공하고 앱이 결과를
2062
+ * 자신의 room store 에 반영한다. 방마다 마지막 절대값 스냅샷과 그 이후 delta 를 분리 보관해,
2063
+ * 서로 다른 발신 흐름의 이벤트가 도착 순서가 뒤바뀌어도 서버 진실과 수렴한다.</p>
2064
+ *
2065
+ * @example
2066
+ * const reconciler = new RoomUnreadReconciler(client.userId); // JWT 에서 SDK 가 추출한 내 userId
2067
+ * rooms.forEach(r => reconciler.applySnapshot(r.id, r.unreadCount, r.unreadVersion)); // REST baseline
2068
+ * client.on('roomListMessage', e => { reconciler.applyMessageReceived(e); render(e.roomId); });
2069
+ * client.on('roomListUnreadUpdated', e => { reconciler.applySnapshot(e.roomId, e.roomUnreadCount, e.unreadVersion); render(e.roomId); });
2070
+ * // render: const c = reconciler.getCount(roomId); c == null ? useRestValue() : store.setBadge(roomId, c);
2071
+ */
2072
+ export class RoomUnreadReconciler {
2073
+ /** @param currentUserId 내 사용자 ID — 내가 보낸 메시지의 delta 를 걸러내는 데 쓴다. */
2074
+ constructor(currentUserId: string);
2075
+ /** MESSAGE_RECEIVED(delta +1) 반영. 발신자 본인 · 중복 messageId · 이미 반영된 version 은 무시. */
2076
+ applyMessageReceived(event: { roomId: string; messageId: string; actorId?: string; unreadVersion?: number | null }): void;
2077
+ /** 절대값 스냅샷(REST 또는 ROOM_UNREAD_UPDATED) 반영. stale version 은 무시, 반영된 pending 은 정리. */
2078
+ applySnapshot(roomId: string, count: number | null | undefined, version: number | null | undefined): void;
2079
+ /** 방의 현재 표시 카운트. baseline 이 아직 없으면 null(앱은 REST 값으로 표시). */
2080
+ getCount(roomId: string): number | null;
2081
+ /** 방을 상태에서 제거. */
2082
+ removeRoom(roomId: string): void;
2083
+ /** 전체 초기화. */
2084
+ clear(): void;
2085
+ }