NapCatQQ/packages/napcat-onebot/action/system/GetCredentials.ts
手瓜一十雪 60a9114495 Add action metadata to OneBot action classes
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.
2026-01-25 19:19:03 +08:00

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 GetCredentialsPayloadSchema = Type.Object({
domain: Type.String({ description: '需要获取 cookies 的域名' }),
});
export type GetCredentialsPayload = Static<typeof GetCredentialsPayloadSchema>;
export const GetCredentialsReturnSchema = Type.Object({
cookies: Type.String({ description: 'Cookies' }),
token: Type.Number({ description: 'CSRF Token' }),
});
export type GetCredentialsResponse = Static<typeof GetCredentialsReturnSchema>;
export class GetCredentials extends OneBotAction<GetCredentialsPayload, GetCredentialsResponse> {
override actionName = ActionName.GetCredentials;
override payloadSchema = GetCredentialsPayloadSchema;
override returnSchema = GetCredentialsReturnSchema;
override actionSummary = '获取登录凭证';
override actionDescription = '获取登录凭证';
override actionTags = ['系统接口'];
override payloadExample = {
domain: 'qun.qq.com'
};
override returnExample = {
cookies: 'uin=o123456789; skey=@abc12345;',
token: 123456789
};
async _handle (payload: GetCredentialsPayload) {
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, token: +bkn };
}
}