zcw-shared 2.26.0 → 2.29.1

package/types/im-api.d.ts

@@ -3,14 +3,13 @@
  *
  * - **终端 UI 展示**见 `zcw-shared/types/im-chat`（`ChatMessage` / `ChatConversation`，camelCase、含 sender 对象等），
  *   与本文件的 `ImApiMessage` 在设计上不同：前者是列表/气泡视图模型，后者是接口契约。
+ * - 核心 HTTP 形状以 `ApiSchema['ImApiMessage']` / `ImApiConversation` 为契约来源，此处放宽 `id` 与 `extra_data` 以兼容多存储驱动。
  */
 
+import type { ApiSchema } from './api-contract'
+
 /** 出站投递状态（与送达已读 status 分离）；库内成功落库行一般为 success */
-export type ImOutboundStatus =
-  | 'queued'
-  | 'sending'
-  | 'failed'
-  | 'success'
+export type ImOutboundStatus = NonNullable<ApiSchema['ImApiMessage']['outbound_status']>
 
 /** ImProxy 落库：用户停止或模型/流异常时的助手消息标记 */
 export interface ImApiAiReplyExtra {
@@ -63,13 +62,16 @@ export interface ImApiMessage {
    * 智能体中断回复：`extra_data.ai_reply` 见 {@link ImApiAiReplyExtra}。
    * 智能体回复用量：`extra_data.llm_context` 见 `types/im-llm-context.d.ts` 的 {@link ImLlmContextExtra}。
    */
-  extra_data?: Record<string, any>
+  extra_data?: any
   created_at?: string
   updated_at?: string
   /** 软删除时刻（ISO）；存在时列表接口不应返回该条（服务端过滤） */
   deleted_at?: string | null
 }
 
+/** TypeSpec 契约形状（`id` 为 string；`extra_data` 为 unknown） */
+export type ImApiMessageContract = ApiSchema['ImApiMessage']
+
 /** 会话对象（接口返回；成员 id 列表 + 可选最后一条消息） */
 export interface ImApiConversation {
   id: string
@@ -88,6 +90,8 @@ export interface ImApiConversation {
   updated_at?: string
 }
 
+export type ImApiConversationContract = ApiSchema['ImApiConversation']
+
 /** `registerMediaOutbound` 响应：附件 id、已落库消息、OSS 直传目标 */
 export interface ImRegisterMediaOutboundResult {
   attachmentId: string
@@ -113,7 +117,7 @@ export interface ImDbMessageRow {
   client_message_id?: string | null
   send_retry_count?: number | null
   outbound_status?: string | null
-  extra_data?: Record<string, any>
+  extra_data?: any
   created_at?: string
   updated_at?: string
   deleted_at?: string | null
@@ -157,7 +161,7 @@ export type ImMessage = ImApiMessage
 /** 与 `ImApiConversation` 相同 */
 export type ImConversation = ImApiConversation
 
-/** 与 `ImApiConversation` 相同（历史泛名，建议新代码用 ImApiConversation） */
+/** @deprecated 请使用 {@link ImConversation} */
 export type Conversation = ImApiConversation
 
 export type RegisterMediaOutboundResult = ImRegisterMediaOutboundResult

package/types/im-call.d.ts

@@ -1,3 +1,5 @@
+import type { ApiOpData } from './api-contract'
+
 /** IM 实时通话媒体类型（WebRTC，非文件消息） */
 export type ImCallMedia = 'audio' | 'video'
 
@@ -39,6 +41,5 @@ export interface ImCallSignalEventPayload extends ImCallSignalPayload {
   fromUserId: string
 }
 
-export interface ImCallIceServersResponse {
-  iceServers: RTCIceServer[]
-}
+/** GET /im/call/ice-servers → `ApiEnvelope.data` */
+export type ImCallIceServersData = ApiOpData<'ImCore_callIceServers'>

package/types/im-composer.d.ts

@@ -20,4 +20,6 @@ export type ImComposerMobileMoreItemSpec = {
 export type ImComposerToolbarOptions = {
   /** 双人会话时显示语音/视频通话入口 */
   showVoiceCall?: boolean
+  /** 双人会话时显示远程协助入口 */
+  showRemoteAssist?: boolean
 }

package/types/im-remote-assist.d.ts

@@ -0,0 +1,83 @@
+/** 远程协助：谁共享屏幕 */
+export type ImRemoteAssistHostRole = 'self' | 'peer'
+
+/** WebRTC 信令（与 im-call 一致） */
+export type ImRemoteAssistSignalType = 'offer' | 'answer' | 'ice-candidate'
+
+export interface ImRemoteAssistSignalPayload {
+  assistId: string
+  type: ImRemoteAssistSignalType
+  sdp?: RTCSessionDescriptionInit
+  candidate?: RTCIceCandidateInit
+}
+
+export interface ImRemoteAssistPeerMachine {
+  machineId: string
+  machineLabel: string | null
+  online: boolean
+}
+
+export interface ImRemoteAssistPeerMachinesPayload {
+  conversationId: string
+  peerUserId: string
+  machines: ImRemoteAssistPeerMachine[]
+}
+
+export interface ImRemoteAssistInviteSentPayload {
+  assistId: string
+  conversationId: string
+  hostRole: ImRemoteAssistHostRole
+  hostUserId: string
+  targetMachineId?: string
+  targetMachineLabel?: string | null
+  callerMachineId?: string
+}
+
+export interface ImRemoteAssistIncomingPayload {
+  assistId: string
+  conversationId: string
+  hostRole: ImRemoteAssistHostRole
+  hostUserId: string
+  callerId: string
+  /** 指定由对端哪台桌面设备接听（未指定则广播至其全部桌面端） */
+  targetMachineId?: string
+  targetMachineLabel?: string | null
+}
+
+export interface ImRemoteAssistHandledElsewherePayload {
+  assistId: string
+  machineLabel?: string | null
+}
+
+export interface ImRemoteAssistAcceptedPayload {
+  assistId: string
+  conversationId: string
+  hostUserId: string
+}
+
+export interface ImRemoteAssistEndedPayload {
+  assistId: string
+  conversationId?: string
+  reason?: 'rejected' | 'cancelled' | 'ended' | 'busy' | 'timeout'
+  /** 对端结束时的说明（如屏幕共享失败） */
+  message?: string
+}
+
+export interface ImRemoteAssistSignalEventPayload extends ImRemoteAssistSignalPayload {
+  fromUserId: string
+}
+
+/** DataChannel 控制消息（归一化坐标 0–1，相对共享画面） */
+export type ImRemoteAssistControlMessage =
+  | { type: 'control-request' }
+  | { type: 'control-granted' }
+  | { type: 'control-denied'; reason?: 'desktop-required' | 'rejected' }
+  | { type: 'control-revoked' }
+  /** 共享方 DataChannel 就绪后告知是否支持键鼠注入（仅桌面客户端为 true） */
+  | { type: 'host-capability'; canInjectInput: boolean }
+  | { type: 'mousemove'; x: number; y: number }
+  | { type: 'mousedown'; x: number; y: number; button: number }
+  | { type: 'mouseup'; x: number; y: number; button: number }
+  | { type: 'wheel'; x: number; y: number; deltaX: number; deltaY: number }
+  | { type: 'keydown'; key: string; code: string; ctrlKey?: boolean; shiftKey?: boolean; altKey?: boolean; metaKey?: boolean }
+  | { type: 'keyup'; key: string; code: string; ctrlKey?: boolean; shiftKey?: boolean; altKey?: boolean; metaKey?: boolean }

package/types/lowcode.d.ts

@@ -1,8 +1,4 @@
-/** 低代码页面 schema（存库 / 运行时） */
-export interface LowcodePageSchema {
-  version: '1.0'
-  root: LowcodeNodeSnapshot[]
-}
+import type { ApiSchema } from './api-contract'
 
 /** 可序列化节点（不含 Vue Component 引用） */
 export interface LowcodeNodeSnapshot {
@@ -12,50 +8,17 @@ export interface LowcodeNodeSnapshot {
   children?: LowcodeNodeSnapshot[]
 }
 
-export interface LowcodeApp {
-  id: string
-  app_key: string
-  name: string
-  description?: string | null
-  status: 'active' | 'inactive'
-  created_at?: string
-  updated_at?: string
-}
-
-export interface LowcodePage {
-  id: string
-  app_id: string
-  page_key: string
-  title: string
-  route_path: string
-  draft_schema: LowcodePageSchema | Record<string, unknown>
-  published_schema?: LowcodePageSchema | Record<string, unknown> | null
-  published_at?: string | null
-  status: 'active' | 'inactive'
-  created_at?: string
-  updated_at?: string
-}
-
-export interface LowcodePageDetail extends LowcodePage {
-  app_key: string
-  app_name: string
-}
-
-export interface LowcodeRuntimePage {
-  app_key: string
-  page_key: string
-  title: string
-  route_path: string
-  schema: LowcodePageSchema | Record<string, unknown>
-  published_at?: string | null
+/** 低代码页面 schema（存库 / 运行时） */
+export type LowcodePageSchema = Omit<ApiSchema['LowcodePageSchema'], 'root'> & {
+  version: '1.0'
+  root: LowcodeNodeSnapshot[]
 }
 
-export interface LowcodeRuntimePageMeta {
-  page_key: string
-  title: string
-  route_path: string
-  published_at?: string | null
-}
+export type LowcodeApp = ApiSchema['LowcodeApp']
+export type LowcodePage = ApiSchema['LowcodePage']
+export type LowcodePageDetail = ApiSchema['LowcodePageDetail']
+export type LowcodeRuntimePage = ApiSchema['LowcodeRuntimePage']
+export type LowcodeRuntimePageMeta = ApiSchema['LowcodeRuntimePageSummary']
 
 export const EMPTY_LOWCODE_PAGE_SCHEMA: LowcodePageSchema = {
   version: '1.0',

package/types/music.d.ts

@@ -1,33 +1,7 @@
-export interface MusicTrack {
-  id: number
-  title: string
-  artist: string
-  cover_url?: string
-  audio_url?: string
-  duration?: number
-  lyrics?: string
-  tags?: string[]
-  like_count?: number
-  comment_count?: number
-  share_count?: number
-  play_count?: number
-  created_at?: string
-  updated_at?: string
-}
+import type { ApiSchema } from './api-contract'
 
-export interface MusicListResponse {
-  data: MusicTrack[]
-  total: number
-  limit: number
-  offset: number
-}
+export type MusicTrack = ApiSchema['MusicTrack']
 
-export interface MusicDetailResponse {
-  data: MusicTrack
-}
+export type CreateMusicPayload = ApiSchema['CreateMusicTrackRequest']
 
-export interface CreateMusicPayload
-  extends Omit<MusicTrack, 'id' | 'created_at' | 'updated_at'> {}
-
-export interface UpdateMusicPayload
-  extends Partial<Omit<MusicTrack, 'id' | 'created_at' | 'updated_at'>> {}
+export type UpdateMusicPayload = ApiSchema['UpdateMusicTrackRequest']

package/types/notification.d.ts

@@ -1,37 +1,7 @@
-export type NotificationType =
-  | 'system'
-  | 'comment'
-  | 'reply'
-  | 'like'
-  | 'follow'
-  | 'post'
-  | 'order'
-  | 'payment'
+import type { ApiSchema } from './api-contract'
 
-export interface Notification {
-  id: number
-  user_id?: string
-  type?: NotificationType
-  title?: string
-  content?: string
-  status?: string
-  related_id?: string
-  related_type?: string
-  extra_data?: Record<string, unknown>
-  created_at?: string
-  updated_at?: string
-}
+export type NotificationType = ApiSchema['NotificationSummary']['type']
 
-export interface NotificationListResponse {
-  data: Notification[]
-}
+export type Notification = ApiSchema['NotificationSummary']
 
-export interface CreateNotificationPayload {
-  user_id: string
-  type: NotificationType
-  title: string
-  content?: string
-  related_id?: string
-  related_type?: string
-  extra_data?: Record<string, unknown>
-}
+export type CreateNotificationPayload = ApiSchema['CreateNotificationRequest']