refactor: simplify the PacketClient availability check process & add action nc_get_packet_status

src/onebot/action/extends/GetRkey.ts

@@ -1,23 +1,11 @@
-import BaseAction from '../BaseAction';
 import { ActionName } from '../types';
-import { FromSchema, JSONSchema } from 'json-schema-to-ts';
+import { GetPacketStatusDepends } from "@/onebot/action/packet/GetPacketStatus";
-// no_cache get时传字符串
-const SchemaData = {
-    type: 'object',
-    properties: {
-    },
-} as const satisfies JSONSchema;
 
-type Payload = FromSchema<typeof SchemaData>;
 
-export class GetRkey extends BaseAction<Payload, Array<any>> {
+export class GetRkey extends GetPacketStatusDepends<null, Array<any>> {
     actionName = ActionName.GetRkey;
-    payloadSchema = SchemaData;
 
-    async _handle(payload: Payload) {
+    async _handle() {
-        if (!this.core.apis.PacketApi.available) {
-            throw new Error('PacketClient is not init');
-        }
         return await this.core.apis.PacketApi.sendRkeyPacket();
     }
 }

src/onebot/action/extends/SetSpecialTittle.ts

@@ -1,6 +1,6 @@
-import BaseAction from '../BaseAction';
 import { ActionName } from '../types';
 import { FromSchema, JSONSchema } from 'json-schema-to-ts';
+import { GetPacketStatusDepends } from "@/onebot/action/packet/GetPacketStatus";
 const SchemaData = {
     type: 'object',
     properties: {
@@ -13,14 +13,11 @@ const SchemaData = {
 
 type Payload = FromSchema<typeof SchemaData>;
 
-export class SetSpecialTittle extends BaseAction<Payload, any> {
+export class SetSpecialTittle extends GetPacketStatusDepends<Payload, any> {
     actionName = ActionName.SetSpecialTittle;
     payloadSchema = SchemaData;
 
     async _handle(payload: Payload) {
-        if (!this.core.apis.PacketApi.available) {
-            throw new Error('PacketClient is not init');
-        }
         const uid = await this.core.apis.UserApi.getUidByUinV2(payload.user_id.toString());
         if(!uid) throw new Error('User not found');
         await this.core.apis.PacketApi.sendSetSpecialTittlePacket(payload.group_id.toString(), uid, payload.special_title);

src/onebot/action/file/GetGroupFileUrl.ts

@@ -1,7 +1,7 @@
-import BaseAction from '../BaseAction';
 import { ActionName } from '../types';
 import { FromSchema, JSONSchema } from 'json-schema-to-ts';
-import {FileNapCatOneBotUUID} from "@/common/helper";
+import { FileNapCatOneBotUUID } from "@/common/helper";
+import { GetPacketStatusDepends } from "@/onebot/action/packet/GetPacketStatus";
 
 const SchemaData = {
     type: 'object',
@@ -18,14 +18,11 @@ interface GetGroupFileUrlResponse {
     url?: string;
 }
 
-export class GetGroupFileUrl extends BaseAction<Payload, GetGroupFileUrlResponse> {
+export class GetGroupFileUrl extends GetPacketStatusDepends<Payload, GetGroupFileUrlResponse> {
     actionName = ActionName.GOCQHTTP_GetGroupFileUrl;
     payloadSchema = SchemaData;
 
     async _handle(payload: Payload) {
-        if (!this.core.apis.PacketApi.available) {
-            throw new Error('PacketClient is not init');
-        }
         const contextMsgFile = FileNapCatOneBotUUID.decode(payload.file_id) || FileNapCatOneBotUUID.decodeModelId(payload.file_id);
         if (contextMsgFile?.fileUUID) {
             return {

src/onebot/action/group/GroupPoke.ts

@@ -1,6 +1,6 @@
-import BaseAction from '../BaseAction';
 import { ActionName } from '../types';
 import { FromSchema, JSONSchema } from 'json-schema-to-ts';
+import {GetPacketStatusDepends} from "@/onebot/action/packet/GetPacketStatus";
 // no_cache get时传字符串
 const SchemaData = {
     type: 'object',
@@ -13,14 +13,11 @@ const SchemaData = {
 
 type Payload = FromSchema<typeof SchemaData>;
 
-export class GroupPoke extends BaseAction<Payload, any> {
+export class GroupPoke extends GetPacketStatusDepends<Payload, any> {
     actionName = ActionName.GroupPoke;
     payloadSchema = SchemaData;
 
     async _handle(payload: Payload) {
-        if (!this.core.apis.PacketApi.available) {
-            throw new Error('PacketClient is not init');
-        }
         await this.core.apis.PacketApi.sendPokePacket(+payload.group_id, +payload.user_id);
     }
 }

src/onebot/action/index.ts

@@ -91,6 +91,7 @@ import { UploadForwardMsg } from "@/onebot/action/extends/UploadForwardMsg";
 import { GetGroupShutList } from './group/GetGroupShutList';
 import { GetGroupMemberList } from './group/GetGroupMemberList';
 import { GetGroupFileUrl } from "@/onebot/action/file/GetGroupFileUrl";
+import {GetPacketStatus} from "@/onebot/action/packet/GetPacketStatus";
 
 
 export type ActionMap = Map<string, BaseAction<any, any>>;
@@ -187,6 +188,7 @@ export function createActionMap(obContext: NapCatOneBot11Adapter, core: NapCatCo
         new GetGroupFilesByFolder(obContext, core),
         new GetGroupSystemMsg(obContext, core),
         new FetchUserProfileLike(obContext, core),
+        new GetPacketStatus(obContext, core),
         new GroupPoke(obContext, core),
         new GetUserStatus(obContext, core),
         new GetRkey(obContext, core),

src/onebot/action/packet/GetPacketStatus.ts

@@ -0,0 +1,25 @@
+import BaseAction from '../BaseAction';
+import {ActionName, BaseCheckResult} from '../types';
+
+
+export abstract class GetPacketStatusDepends<PT, RT> extends BaseAction<PT, RT> {
+    actionName = ActionName.GetPacketStatus;
+
+    protected async check(): Promise<BaseCheckResult>{
+        if (!this.core.apis.PacketApi.available) {
+            return {
+                valid: false,
+                message: "PacketClient is not available!",
+            }
+        }
+        return {
+            valid: true,
+        }
+    }
+}
+
+export class GetPacketStatus extends GetPacketStatusDepends<any, null> {
+    async _handle(payload: any) {
+        return null
+    }
+}

src/onebot/action/types.ts

@@ -121,6 +121,7 @@ export enum ActionName {
     GetGroupInfoEx = "get_group_info_ex",
     GetGroupSystemMsg = 'get_group_system_msg',
     FetchUserProfileLike = "fetch_user_profile_like",
+    GetPacketStatus = 'nc_get_packet_status',
     GetUserStatus = "nc_get_user_status",
     GetRkey = "nc_get_rkey",
     SetSpecialTittle = "set_group_special_title",