Northern_Lights/NapCatQQ
1
0
Fork 0
mirror of https://github.com/NapNeko/NapCatQQ.git synced 2026-02-06 13:05:09 +00:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Add payload and return schemas to OneBot actions

Browse Source 
Introduced explicit payloadSchema and returnSchema definitions for all OneBotAction classes using @sinclair/typebox. This improves type safety, API documentation, and validation for action payloads and return values. Also refactored method signatures and types for consistency across the codebase.
This commit is contained in:
手瓜一十雪
2026-01-25 14:50:58 +08:00
parent 81e4e54f25
commit b69352f6a1
150 changed files with 2015 additions and 1235 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
packages/napcat-onebot/action/user/SetFriendAddRequest.ts
View File

@@ -2,19 +2,20 @@ import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
import { ActionName } from '@/napcat-onebot/action/router';
import { Static, Type } from '@sinclair/typebox';
const SchemaData = Type.Object({
flag: Type.Union([Type.String(), Type.Number()]),
approve: Type.Optional(Type.Union([Type.String(), Type.Boolean()])),
remark: Type.Optional(Type.String()),
export const SetFriendAddRequestPayloadSchema = Type.Object({
flag: Type.Union([Type.String(), Type.Number()], { description: '加好友请求的 flag (需从上报中获取)' }),
approve: Type.Optional(Type.Union([Type.String(), Type.Boolean()], { description: '是否同意请求' })),
remark: Type.Optional(Type.String({ description: '添加后的好友备注' })),
});
type Payload = Static<typeof SchemaData>;
export type SetFriendAddRequestPayload = Static<typeof SetFriendAddRequestPayloadSchema>;
export default class SetFriendAddRequest extends OneBotAction<Payload, null> {
export default class SetFriendAddRequest extends OneBotAction<SetFriendAddRequestPayload, void> {
override actionName = ActionName.SetFriendAddRequest;
override payloadSchema = SchemaData;
override payloadSchema = SetFriendAddRequestPayloadSchema;
override returnSchema = Type.Null();
async _handle (payload: Payload): Promise<null> {
async _handle (payload: SetFriendAddRequestPayload): Promise<void> {
const approve = payload.approve?.toString() !== 'false';
const notify = (await this.core.apis.FriendApi.getBuddyReq()).buddyReqs.find(e => e.reqTime === payload.flag.toString());
if (!notify) {
@@ -24,6 +25,5 @@ export default class SetFriendAddRequest extends OneBotAction<Payload, null> {
if (payload.remark) {
await this.core.apis.FriendApi.setBuddyRemark(notify.friendUid, payload.remark);
}
return null;
}
}