NapCatQQ source snapshot

packages/napcat-onebot/action/example/ExtendsActionsExamples.ts

@@ -0,0 +1,53 @@
+export const ExtendsActionsExamples = {
+  OCRImage: {
+    payload: { image: 'image_id_123' },
+    response: { texts: [{ text: '识别内容', coordinates: [] }] },
+  },
+  GetAiCharacters: {
+    payload: { group_id: '123456' },
+    response: [
+      {
+        type: 'string',
+        characters: [
+          { character_id: 'id', character_name: 'name', preview_url: 'url' },
+        ],
+      },
+    ],
+  },
+  GetClientkey: {
+    payload: {},
+    response: { clientkey: 'abcdef123456' },
+  },
+  SetQQAvatar: {
+    payload: { file: 'base64://...' },
+    response: null,
+  },
+  SetGroupKickMembers: {
+    payload: { group_id: '123456', user_id: ['123456789'], reject_add_request: false },
+    response: null,
+  },
+  TranslateEnWordToZn: {
+    payload: { words: ['hello'] },
+    response: { words: ['你好'] },
+  },
+  GetRkey: {
+    payload: {},
+    response: { rkey: '...' },
+  },
+  SetLongNick: {
+    payload: { longNick: '个性签名' },
+    response: null,
+  },
+  SetSpecialTitle: {
+    payload: { group_id: '123456', user_id: '123456789', special_title: '头衔' },
+    response: null,
+  },
+  SendQzoneMsg: {
+    payload: { content: '今天天气不错', images: [], ugc_right: 1, target_uins: [] },
+    response: { tid: '1234567890abcdef1234567890' },
+  },
+  DeleteQzoneMsg: {
+    payload: { tid: '1234567890abcdef1234567890' },
+    response: null,
+  },
+};

packages/napcat-onebot/action/example/FileActionsExamples.ts

@@ -0,0 +1,22 @@
+export const FileActionsExamples = {
+  GetFile: {
+    payload: { file: 'file_id_123' },
+    response: { file: '/path/to/file', url: 'http://...', file_size: 1024, file_name: 'test.jpg' },
+  },
+  GetGroupFileUrl: {
+    payload: { group_id: '123456', file_id: 'file_id_123', busid: 102 },
+    response: { url: 'http://...' },
+  },
+  GetImage: {
+    payload: { file: 'image_id_123' },
+    response: { file: '/path/to/image', url: 'http://...' },
+  },
+  GetPrivateFileUrl: {
+    payload: { user_id: '123456789', file_id: 'file_id_123' },
+    response: { url: 'http://...' },
+  },
+  GetRecord: {
+    payload: { file: 'record_id_123', out_format: 'mp3' },
+    response: { file: '/path/to/record', url: 'http://...' },
+  },
+};

packages/napcat-onebot/action/example/GoCQHTTPActionsExamples.ts

@@ -0,0 +1,102 @@
+export const GoCQHTTPActionsExamples = {
+  GetStrangerInfo: {
+    payload: { user_id: '123456789' },
+    response: { user_id: 123456789, nickname: '昵称', sex: 'unknown' },
+  },
+  GetGroupHonorInfo: {
+    payload: { group_id: '123456', type: 'all' },
+    response: { group_id: 123456, current_talkative: {}, talkative_list: [] },
+  },
+  GetForwardMsg: {
+    payload: { message_id: '123456' },
+    response: { messages: [] },
+  },
+  SendForwardMsg: {
+    payload: { group_id: '123456', messages: [] },
+    response: { message_id: 123456 },
+  },
+  GetGroupAtAllRemain: {
+    payload: { group_id: '123456' },
+    response: { can_at_all: true, remain_at_all_count_for_group: 10, remain_at_all_count_for_self: 10 },
+  },
+  CreateGroupFileFolder: {
+    payload: { group_id: '123456', name: '测试目录' },
+    response: { result: {}, groupItem: {} },
+  },
+  DeleteGroupFile: {
+    payload: { group_id: '123456', file_id: 'file_uuid_123', bus_id: 104 },
+    response: {},
+  },
+  DeleteGroupFileFolder: {
+    payload: { group_id: '123456', folder_id: 'folder_uuid_123' },
+    response: {},
+  },
+  DownloadFile: {
+    payload: { url: 'https://example.com/file.png', thread_count: 1, headers: 'User-Agent: NapCat' },
+    response: { file: '/path/to/downloaded/file' },
+  },
+  GetFriendMsgHistory: {
+    payload: { user_id: '123456789', message_seq: 0, count: 20 },
+    response: { messages: [] },
+  },
+  GetGroupFilesByFolder: {
+    payload: { group_id: '123456', folder_id: 'folder_id' },
+    response: { files: [], folders: [] },
+  },
+  GetGroupFileSystemInfo: {
+    payload: { group_id: '123456' },
+    response: { file_count: 10, limit_count: 10000, used_space: 1024, total_space: 10737418240 },
+  },
+  GetGroupMsgHistory: {
+    payload: { group_id: '123456', message_seq: 0, count: 20 },
+    response: { messages: [] },
+  },
+  GetGroupRootFiles: {
+    payload: { group_id: '123456' },
+    response: { files: [], folders: [] },
+  },
+  GetOnlineClient: {
+    payload: { no_cache: false },
+    response: [],
+  },
+  GoCQHTTPCheckUrlSafely: {
+    payload: { url: 'https://example.com' },
+    response: { level: 1 },
+  },
+  GoCQHTTPDeleteFriend: {
+    payload: { user_id: '123456789' },
+    response: {},
+  },
+  GoCQHTTPGetModelShow: {
+    payload: { model: 'iPhone 13' },
+    response: { variants: [] },
+  },
+  GoCQHTTPSetModelShow: {
+    payload: { model: 'iPhone 13', model_show: 'iPhone 13' },
+    response: {},
+  },
+  QuickAction: {
+    payload: { context: {}, operation: {} },
+    response: {},
+  },
+  SendGroupNotice: {
+    payload: { group_id: '123456', content: '公告内容', image: 'base64://...' },
+    response: {},
+  },
+  SetGroupPortrait: {
+    payload: { group_id: '123456', file: 'base64://...' },
+    response: { result: 0, errMsg: '' },
+  },
+  SetQQProfile: {
+    payload: { nickname: '新昵称', personal_note: '个性签名' },
+    response: {},
+  },
+  UploadGroupFile: {
+    payload: { group_id: '123456', file: '/path/to/file', name: 'test.txt' },
+    response: { file_id: 'file_uuid_123' },
+  },
+  UploadPrivateFile: {
+    payload: { user_id: '123456789', file: '/path/to/file', name: 'test.txt' },
+    response: { file_id: 'file_uuid_123' },
+  },
+};

packages/napcat-onebot/action/example/GroupActionsExamples.ts

@@ -0,0 +1,96 @@
+export const GroupActionsExamples = {
+  SetGroupMemberInvitePolicy: {
+    payload: { group_id: '123456', policy: 'require_approval' },
+    response: null,
+  },
+  SetGroupMemberPermissions: {
+    payload: {
+      group_id: '123456',
+      allow_member_upload_album: true,
+      allow_member_temporary_session: true,
+      allow_member_create_group: true,
+    },
+    response: null,
+  },
+  SetGroupNewMemberHistoryVisibility: {
+    payload: { group_id: '123456', visible: true },
+    response: null,
+  },
+  DelEssenceMsg: {
+    payload: { message_id: 123456 },
+    response: null,
+  },
+  DelGroupNotice: {
+    payload: { group_id: '123456', notice_id: 'notice_123' },
+    response: null,
+  },
+  GetGroupDetailInfo: {
+    payload: { group_id: '123456' },
+    response: { group_id: 123456, group_name: '测试群', member_count: 100, max_member_count: 500 },
+  },
+  GetGroupEssence: {
+    payload: { group_id: '123456' },
+    response: [{ message_id: 123456, sender_id: 123456, sender_nick: '昵称', operator_id: 123456, operator_nick: '昵称', operator_time: 1710000000, content: '精华内容' }],
+  },
+  GetGroupInfo: {
+    payload: { group_id: '123456' },
+    response: { group_id: 123456, group_name: '测试群', member_count: 100, max_member_count: 500 },
+  },
+  GetGroupList: {
+    payload: {},
+    response: [{ group_id: 123456, group_name: '测试群', member_count: 100, max_member_count: 500 }],
+  },
+  GetGroupMemberInfo: {
+    payload: { group_id: '123456', user_id: '123456789' },
+    response: { group_id: 123456, user_id: 123456789, nickname: '昵称', card: '名片', role: 'member' },
+  },
+  GetGroupMemberList: {
+    payload: { group_id: '123456' },
+    response: [{ group_id: 123456, user_id: 123456789, nickname: '昵称', card: '名片', role: 'member' }],
+  },
+  GetGroupNotice: {
+    payload: { group_id: '123456' },
+    response: [{ notice_id: 'notice_123', sender_id: 123456, publish_time: 1710000000, message: { text: '公告内容', image: [] } }],
+  },
+  SendGroupMsg: {
+    payload: { group_id: '123456', message: 'hello' },
+    response: { message_id: 123456 },
+  },
+  SetEssenceMsg: {
+    payload: { message_id: 123456 },
+    response: null,
+  },
+  SetGroupAddRequest: {
+    payload: { flag: 'flag_123', sub_type: 'add', approve: true },
+    response: null,
+  },
+  SetGroupAdmin: {
+    payload: { group_id: '123456', user_id: '123456789', enable: true },
+    response: null,
+  },
+  SetGroupBan: {
+    payload: { group_id: '123456', user_id: '123456789', duration: 1800 },
+    response: null,
+  },
+  SetGroupCard: {
+    payload: { group_id: '123456', user_id: '123456789', card: '新名片' },
+    response: null,
+  },
+  SetGroupKick: {
+    payload: { group_id: '123456', user_id: '123456789', reject_add_request: false },
+    response: null,
+  },
+  SetGroupLeave: {
+    payload: { group_id: '123456', is_dismiss: false },
+    response: null,
+  },
+  SetGroupName: {
+    payload: { group_id: '123456', group_name: '新群名' },
+    response: null,
+  },
+  SetGroupWholeBan: {
+    payload: { group_id: '123456', enable: true },
+    response: null,
+  },
+
+};

packages/napcat-onebot/action/example/GuildActionsExamples.ts

@@ -0,0 +1,10 @@
+export const GuildActionsExamples = {
+  GetGuildList: {
+    payload: {},
+    response: [{ guild_id: '123456', guild_name: '测试频道' }],
+  },
+  GetGuildProfile: {
+    payload: { guild_id: '123456' },
+    response: { guild_id: '123456', guild_name: '测试频道', guild_display_id: '123' },
+  },
+};

packages/napcat-onebot/action/example/NewActionsExamples.ts

@@ -0,0 +1,10 @@
+export const NewActionsExamples = {
+  GetDoubtFriendsAddRequest: {
+    payload: { count: 10 },
+    response: [{ user_id: 123456789, nickname: '昵称', age: 20, sex: 'male', reason: '申请理由', flag: 'flag_123' }],
+  },
+  SetDoubtFriendsAddRequest: {
+    payload: { flag: 'flag_123', approve: true },
+    response: {},
+  },
+};

packages/napcat-onebot/action/example/PacketActionsExamples.ts

@@ -0,0 +1,22 @@
+export const PacketActionsExamples = {
+  GetPacketStatus: {
+    payload: {},
+    response: { status: 'ok' },
+  },
+  SendPoke: {
+    payload: { user_id: '123456789' },
+    response: {},
+  },
+  SetGroupTodo: {
+    payload: { group_id: '123456', message_id: '123456789' },
+    response: {},
+  },
+  CompleteGroupTodo: {
+    payload: { group_id: '123456', message_id: '123456789' },
+    response: {},
+  },
+  CancelGroupTodo: {
+    payload: { group_id: '123456', message_id: '123456789' },
+    response: {},
+  },
+};

packages/napcat-onebot/action/example/SystemActionsExamples.ts

@@ -0,0 +1,42 @@
+export const SystemActionsExamples = {
+  CanSendImage: {
+    payload: {},
+    response: { yes: true },
+  },
+  CanSendRecord: {
+    payload: {},
+    response: { yes: true },
+  },
+  CleanCache: {
+    payload: {},
+    response: {},
+  },
+  GetCredentials: {
+    payload: {},
+    response: { cookies: '...', csrf_token: 123456789 },
+  },
+  GetCSRF: {
+    payload: {},
+    response: { token: 123456789 },
+  },
+  GetLoginInfo: {
+    payload: {},
+    response: { user_id: 123456789, nickname: '机器人' },
+  },
+  GetStatus: {
+    payload: {},
+    response: { online: true, good: true },
+  },
+  GetSystemMsg: {
+    payload: {},
+    response: { invited_requests: [], join_requests: [] },
+  },
+  GetVersionInfo: {
+    payload: {},
+    response: { app_name: 'NapCatQQ', app_version: '1.0.0', protocol_version: 'v11' },
+  },
+  SetRestart: {
+    payload: { delay: 0 },
+    response: {},
+  },
+};

packages/napcat-onebot/action/example/UserActionsExamples.ts

@@ -0,0 +1,38 @@
+export const UserActionsExamples = {
+  GetCookies: {
+    payload: { domain: 'qun.qq.com' },
+    response: { cookies: 'p_skey=xxx; p_uin=o0123456789;' },
+  },
+  GetFriendList: {
+    payload: {},
+    response: [{ user_id: 123456789, nickname: '昵称', remark: '备注' }],
+  },
+  GetRecentContact: {
+    payload: { count: 10 },
+    response: [
+      {
+        lastestMsg: 'hello',
+        peerUin: '123456789',
+        remark: 'remark',
+        msgTime: '1710000000',
+        chatType: 1,
+        msgId: '12345',
+        sendNickName: 'nick',
+        sendMemberName: 'card',
+        peerName: 'name',
+      },
+    ],
+  },
+  SendLike: {
+    payload: { user_id: '123456789', times: 10 },
+    response: {},
+  },
+  SetFriendAddRequest: {
+    payload: { flag: 'flag_123', approve: true, remark: '好友' },
+    response: {},
+  },
+  SetFriendRemark: {
+    payload: { user_id: '123456789', remark: '新备注' },
+    response: {},
+  },
+};