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.
41 lines
1.6 KiB
TypeScript
41 lines
1.6 KiB
TypeScript
import { OneBotAction } from '@/napcat-onebot/action/OneBotAction';
|
|
import { ActionName } from '@/napcat-onebot/action/router';
|
|
import { Static, Type } from '@sinclair/typebox';
|
|
|
|
export const GetCookiesPayloadSchema = Type.Object({
|
|
domain: Type.String({ description: '需要获取 cookies 的域名' }),
|
|
});
|
|
|
|
export type GetCookiesPayload = Static<typeof GetCookiesPayloadSchema>;
|
|
|
|
export const GetCookiesReturnSchema = Type.Object({
|
|
cookies: Type.String({ description: 'Cookies' }),
|
|
bkn: Type.String({ description: 'CSRF Token' }),
|
|
});
|
|
|
|
export type GetCookiesResponse = Static<typeof GetCookiesReturnSchema>;
|
|
|
|
export class GetCookies extends OneBotAction<GetCookiesPayload, GetCookiesResponse> {
|
|
override actionName = ActionName.GetCookies;
|
|
override payloadSchema = GetCookiesPayloadSchema;
|
|
override returnSchema = GetCookiesReturnSchema;
|
|
override actionSummary = '获取 Cookies';
|
|
override actionDescription = '获取指定域名的 Cookies';
|
|
override actionTags = ['用户接口'];
|
|
override payloadExample = {
|
|
domain: 'qun.qq.com'
|
|
};
|
|
override returnExample = {
|
|
cookies: 'uin=o123456789; skey=@abc12345;',
|
|
bkn: '123456789'
|
|
};
|
|
|
|
async _handle (payload: GetCookiesPayload) {
|
|
const cookiesObject = await this.core.apis.UserApi.getCookies(payload.domain);
|
|
// 把获取到的cookiesObject转换成 k=v; 格式字符串拼接在一起
|
|
const cookies = Object.entries(cookiesObject).map(([key, value]) => `${key}=${value}`).join('; ');
|
|
const bkn = cookiesObject?.['skey'] ? this.core.apis.WebApi.getBknFromCookie(cookiesObject) : '';
|
|
return { cookies, bkn };
|
|
}
|
|
}
|