NapCatQQ/packages/napcat-onebot/action/user/SetFriendRemark.ts
手瓜一十雪 b69352f6a1 Add payload and return schemas to OneBot actions
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.
2026-01-25 14:50:58 +08:00

26 lines
1.1 KiB
TypeScript

import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
import { ActionName } from '@/napcat-onebot/action/router';
import { Static, Type } from '@sinclair/typebox';
export const SetFriendRemarkPayloadSchema = Type.Object({
user_id: Type.Union([Type.String(), Type.Number()], { description: '好友 QQ 号' }),
remark: Type.String({ description: '备注' }),
});
export type SetFriendRemarkPayload = Static<typeof SetFriendRemarkPayloadSchema>;
export default class SetFriendRemark extends OneBotAction<SetFriendRemarkPayload, void> {
override actionName = ActionName.SetFriendRemark;
override payloadSchema = SetFriendRemarkPayloadSchema;
override returnSchema = Type.Null();
async _handle (payload: SetFriendRemarkPayload): Promise<void> {
const friendUid = await this.core.apis.UserApi.getUidByUinV2(payload.user_id.toString());
const is_friend = await this.core.apis.FriendApi.isBuddy(friendUid);
if (!is_friend) {
throw new Error(`用户 ${payload.user_id} 不是好友`);
}
await this.core.apis.FriendApi.setBuddyRemark(friendUid, payload.remark);
}
}