@noverachat/sdk-web 0.0.3 → 0.2.0

package/src/types.ts

@@ -37,175 +37,73 @@ export type {
   WsError, WsCloseNotice,
 };
 
-export interface SenderMini {
-  userId: string;
-  nickname?: string | null;
-  profileImageUrl?: string | null;
-}
+/* ------------------------------------------------------------------ *
+ * REST DTO 는 GENERATED 이다 — packages/protocol/schema/openapi.dev.json
+ * (dev 서버 OpenAPI vendor 본) 이 SSOT. camelCase 인터페이스 + `parseX(json)`
+ * 변환 함수는 ./generated/rest.ts 에 함께 방출된다(REST_MODELS 화이트리스트,
+ * scripts/gen.mjs). 손으로 고치지 말고 vendor 본을 갱신한 뒤 `pnpm gen`.
+ * 아래에서 그대로 re-export 하고, 기존 공개 이름은 alias 로 유지한다.
+ * ------------------------------------------------------------------ */
+export type {
+  SenderMini,
+  ReactionEntry,
+  MemberPreview,
+  RoomUnread,
+  UnreadRoomItem,
+  UnreadSummary,
+  AppPolicy,
+  MessageListResponse,
+  RoomMemberOut,
+  RoomMemberListResponse,
+  BulkDeleteResult,
+  BulkDeleteBySenderResult,
+  FileOut,
+  FileCreateResponse,
+  RoomOut,
+  DeviceListResponse,
+  PushPreferencesOut,
+  JoinRequestOut,
+  JoinRequestListResponse,
+  JoinRequestCreateResponse,
+} from "./generated/rest.js";
 
-export interface ReactionEntry {
-  key: string;
-  userIds: string[];
-  updatedAt: number; // unix ms
-}
+// 공개 이름 유지 — 이전 손 DTO 이름을 생성물 이름으로 alias (0.x, minor 브레이킹 허용).
+export type {
+  AnnouncementOut as Announcement,
+  BlockOut as Block,
+  InviteTokenOut as InviteToken,
+  InviteAcceptResponse as AcceptInviteResult,
+  DeviceOut as DeviceInfo,
+  MessageListResponse as MessagePage,
+} from "./generated/rest.js";
 
-export interface MessageOut {
-  appId: string;
-  roomId: string;
-  messageId: MessageIdStr;
-  sender?: SenderMini | null;
-  senderId?: string | null;
-  messageType: MessageType;
-  customType?: string | null;
-  content?: string | null;
-  data?: Record<string, unknown> | null;
-  meta?: Record<string, unknown> | null;
-  /** Custom metadata attached by the sender (extracted from `data._customMeta`).
-   *  Null when the sender didn't attach anything. */
-  customMeta?: Record<string, unknown> | null;
-  /** Snowflake bigint (string) of the attached file, when this is a file
-   *  message. Use ``chat.getFileUrl(fileId)`` to obtain a short-lived
-   *  signed download URL, or ``chat.getFileMeta(fileId)`` for metadata
-   *  without the download. Null for text-only messages. */
-  fileId?: MessageIdStr | null;
-  /** Inline file metadata embedded by the server on chat_receive — lets
-   *  the UI render a placeholder (filename, size, dimensions, thumbnail
-   *  status) without an extra round-trip. May be null even when `fileId`
-   *  is set (e.g. for messages loaded via REST history before the inline
-   *  metadata feature shipped); call ``getFileMeta()`` in that case. */
+import type { MessageOut as RestMessageOut, ReactionEntry } from "./generated/rest.js";
+
+/**
+ * Canonical message shape surfaced to SDK callers. Structurally the
+ * GENERATED REST `MessageOut` PLUS two client-side enhancements the server
+ * doesn't send verbatim:
+ *   - `file` / `files` parsed into the camelCase `FileInline` shape (the
+ *     generated model leaves them free-form since the OpenAPI schema does),
+ *   - `customMeta` lifted out of `data._customMeta`.
+ * Built by `toMessageOut` in features/room.ts.
+ */
+export interface MessageOut
+  extends Omit<RestMessageOut, "file" | "files" | "reactions"> {
+  /** Inline file metadata embedded by the server on chat_receive / REST
+   *  history — lets the UI render a placeholder (filename, size, dims,
+   *  thumbnail status) without an extra round-trip. May be null even when
+   *  `fileId` is set (older history predating inline meta); call
+   *  ``getFileMeta()`` in that case. */
   file?: FileInline | null;
-  /** Multi-file bundle — set when the message references multiple files
-   *  via ``data.file_ids`` (kind = "file_group"). Each entry has the
-   *  same shape as ``file``. Null for single-file / text-only messages.
-   *  UIs should check ``files?.length > 0`` first and only fall through
-   *  to the ``file`` singleton when the bundle field is absent. */
+  /** Multi-file bundle (kind = "file_group"). Null for single-file /
+   *  text-only messages. Check ``files?.length`` first, then fall back to
+   *  the ``file`` singleton. */
   files?: FileInline[] | null;
-  replyToId?: MessageIdStr | null;
   reactions: ReactionEntry[];
-  createdAt: string;      // ISO
-  createdAtMs: number;    // unix ms
-  updatedAt?: string | null;
-  updatedAtMs?: number | null;
-  deletedAt?: string | null;
-  deletedByUserId?: string | null;
-  deleteScope?: DeleteScope | null;
-  editedCount: number;
-}
-
-export interface RoomUnread {
-  roomId: string;
-  unreadCount: number;
-  lastReadMessageId: MessageIdStr | null;
-  lastMessageId: MessageIdStr | null;
-}
-
-export interface Announcement {
-  id: number;
-  roomId: string;
-  content: string;
-  createdBy: string;
-  createdAt: string;
-  updatedAt: string;
-}
-
-/** One-way user block — KakaoTalk-style.
- *
- *  A row in the caller's block list. The blocked user is NOT told they're
- *  blocked; they keep sending messages that just don't reach the blocker.
- *  See ``chat.blockUser`` / ``chat.unblockUser`` / ``chat.listBlocks``.
- */
-export interface Block {
-  blockedUserId: string;
-  reason: string | null;
-  /** ISO-8601 UTC. */
-  createdAt: string;
-}
-
-/** 방 초대 링크 (카톡 오픈채팅 URL 스타일). Minted by an OPERATOR via
- *  ``room.createInvite()``; consumed by any user via ``chat.acceptInvite()``. */
-export interface InviteToken {
-  /** URL-safe short id (~22 chars). Embed in the shareable URL as-is. */
-  token: string;
-  roomId: string;
-  createdBy: string;
-  /** ISO-8601 UTC. */
-  createdAt: string;
-  /** ISO-8601 UTC. `null` = never expires. */
-  expiresAt: string | null;
-  /** `null` = unlimited uses. */
-  maxUses: number | null;
-  /** Successful `accept` calls so far. */
-  usedCount: number;
-  /** ISO-8601 UTC. `null` = still active (assuming not expired / exhausted). */
-  revokedAt: string | null;
-}
-
-/** Result of `chat.acceptInvite(token)`. */
-export interface AcceptInviteResult {
-  roomId: string;
-  roomName: string | null;
-  /** True when the caller was already an active member — the call is a
-   *  no-op and does NOT bump the invite's `used_count`. Useful for
-   *  deep-link flows that may be triggered on re-open. */
-  wasAlreadyMember: boolean;
-}
-
-/** One member shown in a channel-list avatar mosaic. */
-export interface MemberPreview {
-  userId: string;
-  nickname: string | null;
-  profileImageUrl: string | null;
-  /** Cluster-wide presence dot. `null` = not resolved (endpoint didn't
-   *  include it). Consumers rendering a green/gray dot should treat
-   *  `null` and `false` differently only if they care about the
-   *  "unknown" state. */
-  isOnline: boolean | null;
-}
-
-export interface UnreadRoomItem {
-  roomId: string;
-  name: string | null;
-  /** "ONE" | "GROUP" | "SUPER_GROUP" — lets the UI pick a 1-up vs mosaic avatar. */
-  roomType: string | null;
-  unreadCount: number;
-  lastMessageId: MessageIdStr | null;
-  /** One-line preview shown under the room name in the channel list.
-   *  TEXT/SYSTEM → first 200 chars, EMOTICON → "[이모티콘]", images/videos/
-   *  files → "[사진]" / "[동영상]" / "[파일] name". Null when the room has
-   *  no messages yet (or was just cleared). */
-  lastMessagePreview: string | null;
-  lastReadMessageId: MessageIdStr | null;
-  /** Total active (non-KICKED) members incl. the caller — the count badge. */
-  memberCount: number;
-  /** Up to 4 OTHER members (caller excluded) for the avatar mosaic. */
-  members: MemberPreview[];
-}
-
-export interface UnreadSummary {
-  total: number;
-  rooms: UnreadRoomItem[];
-}
-
-export interface AppPolicy {
-  appId: string;
-  /** When true, any non-KICKED room member can call
-   *  `room.deleteAllMessages()`. When false, only operators (or super-admin)
-   *  can. UIs should gate the destructive button on this. */
-  allowMemberBulkDelete: boolean;
-  /** When false, server does NOT broadcast `sync_tick` frames — hide
-   *  read-receipt badges client-side. Per-user unread counts via REST
-   *  still work (DB tracking is independent of the broadcast). */
-  readReceiptsEnabled: boolean;
-  /** When false, the server silently drops inbound `typing` frames and
-   *  no peer ever sees "alice is typing…". SDK callers should also
-   *  short-circuit `room.setTyping()` based on this flag so a disabled
-   *  app doesn't pay the WS frame cost per keystroke. */
-  typingIndicatorsEnabled: boolean;
-  /** When true, any non-KICKED room member can hard-delete another
-   *  member's message (scope=ALL). Default false — sender-or-operator
-   *  only. UIs should gate the "Delete for everyone" button on other
-   *  users' messages by this flag. */
-  deleteAnyMessageEnabled: boolean;
+  /** Custom metadata attached by the sender (extracted from
+   *  `data._customMeta`). Null when the sender didn't attach anything. */
+  customMeta?: Record<string, unknown> | null;
 }
 
 /** Push providers we can deliver to. Matches the backend `TokenType`. */
@@ -227,19 +125,6 @@ export interface RegisterDeviceParams {
   appVersion?: string;
 }
 
-export interface DeviceInfo {
-  deviceId: string;
-  tokenType: DeviceTokenType;
-  /** Server returns only a short prefix of the token — it's a credential
-   *  and the caller already holds the full value. */
-  tokenPreview: string;
-  os: DeviceOS | null;
-  appVersion: string | null;
-  pushEnabled: boolean;
-  lastActiveAt: string | null;
-  createdAt: string;
-}
-
 export interface SendParams {
   content?: string;
   messageType?: "TEXT" | "FILE" | "EMOTICON";