mirror of
https://github.com/NapNeko/NapCatQQ.git
synced 2026-02-05 15:11:15 +00:00
Added or updated actionSummary, actionTags, payloadExample, and returnExample properties for all OneBot action classes in the napcat-onebot package. This improves API documentation and discoverability by providing concise summaries, categorization tags, and usage examples for each action.
38 lines
1.6 KiB
TypeScript
38 lines
1.6 KiB
TypeScript
import { PacketBuf } from 'napcat-core/packet/transformer/base';
|
|
import { GetPacketStatusDepends } from '@/napcat-onebot/action/packet/GetPacketStatus';
|
|
import { ActionName } from '@/napcat-onebot/action/router';
|
|
import { Static, Type } from '@sinclair/typebox';
|
|
|
|
const PayloadSchema = Type.Object({
|
|
cmd: Type.String({ description: '命令字' }),
|
|
data: Type.String({ description: '十六进制数据' }),
|
|
rsp: Type.Union([Type.String(), Type.Boolean()], { default: true, description: '是否等待响应' }),
|
|
});
|
|
|
|
type PayloadType = Static<typeof PayloadSchema>;
|
|
|
|
const ReturnSchema = Type.Union([Type.String({ description: '响应十六进制数据' }), Type.Undefined()], { description: '发包结果' });
|
|
|
|
type ReturnType = Static<typeof ReturnSchema>;
|
|
|
|
export class SendPacket extends GetPacketStatusDepends<PayloadType, ReturnType> {
|
|
override payloadSchema = PayloadSchema;
|
|
override returnSchema = ReturnSchema;
|
|
override actionName = ActionName.SendPacket;
|
|
override actionSummary = '发送原始数据包';
|
|
override actionTags = ['系统扩展'];
|
|
override payloadExample = {
|
|
cmd: 'Example.Cmd',
|
|
data: '123456',
|
|
rsp: true
|
|
};
|
|
override returnExample = '123456';
|
|
|
|
async _handle (payload: PayloadType) {
|
|
const rsp = typeof payload.rsp === 'boolean' ? payload.rsp : payload.rsp === 'true';
|
|
const packetData = Buffer.from(payload.data, 'hex') as unknown as PacketBuf;
|
|
const data = await this.core.apis.PacketApi.pkt.operation.sendPacket({ cmd: payload.cmd, data: packetData }, rsp);
|
|
return typeof data === 'object' ? data.toString('hex') : undefined;
|
|
}
|
|
}
|