LLOneBot/src/onebot11/types.ts

import { PicSubType, RawMessage } from '../ntqqapi/types'
import { EventType } from './event/OB11BaseEvent'
import { IdMusicSignPostData, CustomMusicSignPostData } from '../common/utils/sign'

export interface OB11User {
  user_id: number
  nickname: string
  remark?: string
  sex?: OB11UserSex
  level?: number
  age?: number
  qid?: string
  login_days?: number
  categroyName?: string
  categoryId?: number
}

export enum OB11UserSex {
  male = 'male',
  female = 'female',
  unknown = 'unknown',
}

export enum OB11GroupMemberRole {
  owner = 'owner',
  admin = 'admin',
  member = 'member',
}

export interface OB11GroupMember {
  group_id: number
  user_id: number
  nickname: string
  card?: string
  sex?: OB11UserSex
  age?: number
  join_time?: number
  last_sent_time?: number
  level?: string
  qq_level?: number
  role?: OB11GroupMemberRole
  title?: string
  area?: string
  unfriendly?: boolean
  title_expire_time?: number
  card_changeable?: boolean
  // 以下为gocq字段
  shut_up_timestamp?: number
  // 以下为扩展字段
  is_robot?: boolean
  qage?: number
}

export interface OB11Group {
  group_id: number
  group_name: string
  group_memo: string
  group_create_time: number
  member_count: number
  max_member_count: number
}

interface OB11Sender {
  user_id: number
  nickname: string
  sex?: OB11UserSex
  age?: number
  card?: string // 群名片
  level?: string // 群等级
  role?: OB11GroupMemberRole
  group_id?: number // 当私聊 sub_type 为 group 时
  title?: string // 群聊专属头衔
}

export enum OB11MessageType {
  private = 'private',
  group = 'group',
}

export interface OB11Message {
  target_id?: number // 自己发送的消息才有此字段
  self_id?: number
  time: number
  message_id: number
  message_seq: number // go-cqhttp字段，实际上是message_id
  real_id: number
  user_id: number
  group_id?: number
  message_type: 'private' | 'group'
  sub_type?: 'friend' | 'group' | 'normal'
  sender: OB11Sender
  message: OB11MessageData[] | string
  message_format: 'array' | 'string'
  raw_message: string
  font: number
  post_type?: EventType
  raw?: RawMessage
  temp_source?: 0 | 1 | 2 | 3 | 4 | 6 | 7 | 8 | 9
}

export interface OB11ForwardMessage extends OB11Message {
  content: OB11MessageData[] | string
}

export interface OB11Return<DataType> {
  status: string
  retcode: number
  data: DataType
  message: string
  echo?: unknown // ws调用api才有此字段
  wording?: string // go-cqhttp字段，错误信息
}

export enum OB11MessageDataType {
  text = 'text',
  image = 'image',
  music = 'music',
  video = 'video',
  voice = 'record',
  file = 'file',
  at = 'at',
  reply = 'reply',
  json = 'json',
  face = 'face',
  mface = 'mface', // 商城表情
  markdown = 'markdown',
  node = 'node', // 合并转发消息节点
  forward = 'forward', // 合并转发消息，用于上报
  xml = 'xml',
  poke = 'poke',
  dice = 'dice',
  RPS = 'rps',
  contact = 'contact',
  shake = 'shake',
}

export interface OB11MessageMFace {
  type: OB11MessageDataType.mface
  data: {
    emoji_package_id: number
    emoji_id: string
    key: string
    summary?: string
    url?: string
  }
}

export interface OB11MessageDice {
  type: OB11MessageDataType.dice
  data: {
    result: number /* intended */ | string /* in fact */
  }
}
export interface OB11MessageRPS {
  type: OB11MessageDataType.RPS
  data: {
    result: number | string
  }
}

export interface OB11MessageText {
  type: OB11MessageDataType.text
  data: {
    text: string // 纯文本
  }
}

export interface OB11MessagePoke {
  type: OB11MessageDataType.poke
  data: {
    qq?: number
    id?: number
  }
}

export interface OB11MessageFileBase {
  data: {
    thumb?: string
    name?: string
    file: string
    url?: string
    file_size?: string //扩展
  }
}

export interface OB11MessageImage extends OB11MessageFileBase {
  type: OB11MessageDataType.image
  data: OB11MessageFileBase['data'] & {
    summary?: string // 图片摘要
    subType?: PicSubType
    type?: 'flash' | 'show'
  }
}

export interface OB11MessageRecord extends OB11MessageFileBase {
  type: OB11MessageDataType.voice
  data: OB11MessageFileBase['data'] & {
    path?: string //扩展
  }
}

export interface OB11MessageFile extends OB11MessageFileBase {
  type: OB11MessageDataType.file
  data: OB11MessageFileBase['data'] & {
    file_id?: string
    path?: string
  }
}

export interface OB11MessageVideo extends OB11MessageFileBase {
  type: OB11MessageDataType.video
  data: OB11MessageFileBase['data'] & {
    path?: string //扩展
  }
}

export interface OB11MessageAt {
  type: OB11MessageDataType.at
  data: {
    qq: string | 'all'
    name?: string
  }
}

export interface OB11MessageReply {
  type: OB11MessageDataType.reply
  data: {
    id: string
  }
}

export interface OB11MessageFace {
  type: OB11MessageDataType.face
  data: {
    id: string
  }
}

export type OB11MessageMixType = OB11MessageData[] | string | OB11MessageData

export interface OB11MessageNode {
  type: OB11MessageDataType.node
  data: {
    id?: string
    user_id?: number
    nickname: string
    content: OB11MessageMixType
  }
}

export interface OB11MessageIdMusic {
  type: OB11MessageDataType.music
  data: IdMusicSignPostData
}

export interface OB11MessageCustomMusic {
  type: OB11MessageDataType.music
  data: Omit<CustomMusicSignPostData, 'singer'> & { content?: string }
}

export type OB11MessageMusic = OB11MessageIdMusic | OB11MessageCustomMusic

export interface OB11MessageJson {
  type: OB11MessageDataType.json
  data: { data: string /* , config: { token: string } */ }
}

export interface OB11MessageMarkdown {
  type: OB11MessageDataType.markdown
  data: {
    data: string
  }
}

export interface OB11MessageForward {
  type: OB11MessageDataType.forward
  data: {
    id: string
  }
}

export interface OB11MessageContact {
  type: OB11MessageDataType.contact
  data: {
    type: 'qq' | 'group'
    id: string
  }
}

export interface OB11MessageShake {
  type: OB11MessageDataType.shake
  data: Record<string, never>
}

export type OB11MessageData =
  | OB11MessageText
  | OB11MessageFace
  | OB11MessageMFace
  | OB11MessageAt
  | OB11MessageReply
  | OB11MessageImage
  | OB11MessageRecord
  | OB11MessageFile
  | OB11MessageVideo
  | OB11MessageNode
  | OB11MessageIdMusic
  | OB11MessageCustomMusic
  | OB11MessageJson
  | OB11MessagePoke
  | OB11MessageDice
  | OB11MessageRPS
  | OB11MessageMarkdown
  | OB11MessageForward
  | OB11MessageContact
  | OB11MessageShake

export interface OB11PostSendMsg {
  message_type?: 'private' | 'group'
  user_id?: string | number
  group_id?: string | number
  message: OB11MessageMixType
  messages?: OB11MessageMixType // 兼容 go-cqhttp
  auto_escape?: boolean | string
}

export interface OB11Version {
  app_name: 'LLOneBot'
  app_version: string
  protocol_version: 'v11'
}

export interface OB11Status {
  online: boolean | null
  good: boolean
}

export interface OB11GroupFile {
  group_id: number
  file_id: string
  file_name: string
  busid: number
  file_size: number
  upload_time: number
  dead_time: number
  modify_time: number
  download_times: number
  uploader: number
  uploader_name: string
}

export interface OB11GroupFileFolder {
  group_id: number
  folder_id: string
  folder_name: string
  create_time: number
  creator: number
  creator_name: string
  total_file_count: number
}