node-karin 0.12.16 → 0.12.19

package/lib/types/event/contact.d.ts

@@ -1,6 +1,4 @@
-/**
- * 事件来源枚举
- */
+/** 事件来源枚举 */
 export declare const enum Scene {
     /** 群 */
     Group = "group",
@@ -17,14 +15,12 @@ export declare const enum Scene {
     /** 临时群会话 */
     StrangerFromGroup = "stranger_from_group"
 }
-/**
- * 事件联系人信息 也就是从哪来的这条消息
- */
-export interface Contact {
+/** 事件联系人信息 也就是从哪来的这条消息 */
+export interface Contact<T extends `${Scene}` = `${Scene}`> {
     /** 事件来源场景 */
-    scene: `${Scene}`;
+    scene: T;
     /** 事件来源id 群号或者用户id */
     peer: string;
     /** 事件来源子id 仅在频道和临时会话中存在 */
-    sub_peer?: string;
+    sub_peer: T extends Scene.Guild | Scene.Nearby ? string : null;
 }

package/lib/types/event/event.d.ts

@@ -2,9 +2,7 @@ import { Sender } from './sender.js';
 import { Contact } from './contact.js';
 import { KarinAdapter } from '../../types/index.js';
 import { Reply, replyCallback } from './reply.js';
-/**
- * 事件类型枚举
- */
+/** 事件类型枚举 */
 export declare const enum EventType {
     /** 消息事件 */
     Message = "message",
@@ -13,9 +11,7 @@ export declare const enum EventType {
     /** 请求事件 */
     Request = "request"
 }
-/**
- * 消息事件子类型枚举
- */
+/** 消息事件子类型枚举 */
 export declare const enum MessageSubType {
     /** 群消息 */
     GroupMessage = "group_message",
@@ -30,9 +26,7 @@ export declare const enum MessageSubType {
     /** 陌生人消息 */
     Stranger = "stranger"
 }
-/**
- * 通知事件子类型枚举
- */
+/** 通知事件子类型枚举 */
 export declare const enum NoticeSubType {
     /** 私聊戳一戳 */
     PrivatePoke = "private_poke",
@@ -69,9 +63,7 @@ export declare const enum NoticeSubType {
     /** 好友增加 */
     FriendIncrease = "friend_increase"
 }
-/**
- * 请求事件子类型枚举
- */
+/** 请求事件子类型枚举 */
 export declare const enum RequestSubType {
     /** 好友申请 */
     PrivateApply = "private_apply",
@@ -86,29 +78,17 @@ export type EventToSubEvent = {
     [EventType.Notice]: NoticeSubType;
     [EventType.Request]: RequestSubType;
 };
-/**
- * 所有消息事件类型
- */
+/** 所有消息事件类型 */
 export type AllMessageSubType = `${EventType.Message}` | `${EventType.Message}.${MessageSubType}`;
-/**
- * 所有通知事件类型
- */
+/** 所有通知事件类型 */
 export type AllNoticeSubType = `${EventType.Notice}` | `${EventType.Notice}.${NoticeSubType}`;
-/**
- * 所有请求事件类型
- */
+/** 所有请求事件类型 */
 export type AllRequestSubType = `${EventType.Request}` | `${EventType.Request}.${RequestSubType}`;
-/**
- * 所有组合事件类型
- */
+/** 所有组合事件类型 */
 export type CombinedEventType = AllMessageSubType | AllNoticeSubType | AllRequestSubType;
-/**
- * 所有监听事件
- */
+/** 所有监听事件 */
 export type AllListenEvent = `${EventType}` | `${CombinedEventType}`;
-/**
- * 事件基类定义
- */
+/** 事件基类定义 */
 export interface KarinEventType {
     /** 机器人ID 请尽量使用UID */
     self_id: string;
@@ -161,6 +141,11 @@ export interface KarinEventType {
      * @default false
      */
     isGroupTemp: boolean;
+    /**
+     * - 是否为频道私信
+     * @default false
+     */
+    isDirect: boolean;
     /** 日志函数字符串 */
     logFnc: string;
     /** 日志用户字符串 */

package/lib/types/event/message.d.ts

@@ -14,30 +14,20 @@ export interface KarinMessageType extends KarinEventType {
     elements: Array<KarinElement>;
     /** 群ID */
     group_id: string;
-    /**
-     * 经过处理后的消息
-     */
+    /** 经过处理后的消息 */
     msg: string;
     /** 消息图片 */
     image: string[];
     /** 语音url */
     record: string;
     file: any;
-    /**
-     * 是否atBot
-     */
+    /** 是否atBot */
     atBot: boolean;
-    /**
-     * 是否atAll
-     */
+    /** 是否atAll */
     atAll: boolean;
-    /**
-     * at的用户列表 不会出现Bot自身的at
-     */
+    /** at的用户列表 不会出现Bot自身的at */
     at: string[];
-    /**
-     * 引用回复的消息id
-     */
+    /** 引用回复的消息id */
     reply_id: string;
     /** bot别名 */
     alias: string;
@@ -79,6 +69,7 @@ export declare class KarinMessage implements KarinMessageType {
     at: KarinMessageType['at'];
     reply_id: KarinMessageType['reply_id'];
     alias: KarinMessageType['alias'];
+    isDirect: KarinMessageType['isDirect'];
     constructor({ event, self_id: selfId, user_id: userId, group_id: groupId, time, contact, sender, sub_event: subEvent, event_id: eventId, message_id: messageId, message_seq: messageSeq, elements, raw_event: rawEvent, }: BaseEventDataType & {
         event: KarinMessageType['event'];
         sub_event: KarinMessageType['sub_event'];

package/lib/types/event/message.js

@@ -35,6 +35,7 @@ export class KarinMessage {
     at;
     reply_id;
     alias;
+    isDirect;
     constructor({ event, self_id: selfId, user_id: userId, group_id: groupId = '', time, contact, sender, sub_event: subEvent, event_id: eventId, message_id: messageId, message_seq: messageSeq, elements, raw_event: rawEvent, }) {
         this.self_id = selfId;
         this.user_id = userId;
@@ -55,6 +56,7 @@ export class KarinMessage {
         this.isGroup = false;
         this.isGuild = false;
         this.isGroupTemp = false;
+        this.isDirect = false;
         this.logFnc = '';
         this.logText = '';
         this.store = new Map();

package/lib/types/event/notice.d.ts

@@ -290,6 +290,7 @@ export declare class KarinNotice implements KarinNoticeEventBase {
     isGroup: KarinNoticeType['isGroup'];
     isGuild: KarinNoticeType['isGuild'];
     isGroupTemp: KarinNoticeType['isGroupTemp'];
+    isDirect: KarinNoticeType['isDirect'];
     logFnc: KarinNoticeType['logFnc'];
     logText: KarinNoticeType['logText'];
     store: KarinNoticeType['store'];

package/lib/types/event/notice.js

@@ -15,6 +15,7 @@ export class KarinNotice {
     isGroup;
     isGuild;
     isGroupTemp;
+    isDirect;
     logFnc;
     logText;
     store;
@@ -41,6 +42,7 @@ export class KarinNotice {
         this.isGroup = false;
         this.isGuild = false;
         this.isGroupTemp = false;
+        this.isDirect = false;
         this.logFnc = '';
         this.logText = '';
         this.store = new Map();

package/lib/types/event/request.d.ts

@@ -72,6 +72,7 @@ export declare class KarinRequest implements KarinRequestEventBase {
     isGroup: KarinRequestType['isGroup'];
     isGuild: KarinRequestType['isGuild'];
     isGroupTemp: KarinRequestType['isGroupTemp'];
+    isDirect: KarinRequestType['isDirect'];
     logFnc: KarinRequestType['logFnc'];
     logText: KarinRequestType['logText'];
     store: KarinRequestType['store'];

package/lib/types/event/request.js

@@ -15,6 +15,7 @@ export class KarinRequest {
     isGroup;
     isGuild;
     isGroupTemp;
+    isDirect;
     logFnc;
     logText;
     store;
@@ -42,6 +43,7 @@ export class KarinRequest {
         this.isGroup = false;
         this.isGuild = false;
         this.isGroupTemp = false;
+        this.isDirect = false;
         this.logFnc = '';
         this.logText = '';
         this.store = new Map();

package/lib/types/plugin/app.d.ts

@@ -33,6 +33,10 @@ export interface CommandInfo extends AppBase {
     perm: `${Permission}`;
     /** class */
     data: NewMessagePlugin | '';
+    /** 只有对应的适配器才会生效 */
+    adapter: Array<KarinAdapter['adapter']['name']>;
+    /** 指定的适配器无效 */
+    notAdapter: Array<KarinAdapter['adapter']['name']>;
 }
 /** task规则集类型 */
 export interface TaskInfo extends Omit<AppBase, 'rank'> {
@@ -75,10 +79,12 @@ export interface AcceptInfo extends AppBase {
     type: `${AppType.Accept}`;
     /** 监听事件 */
     event: `${AllNoticeSubType}` | `${AllRequestSubType}`;
+    /** 只有对应的适配器才会生效 */
+    adapter: Array<KarinAdapter['adapter']['name']>;
+    /** 指定的适配器无效 */
+    notAdapter: Array<KarinAdapter['adapter']['name']>;
 }
-/**
- * 初始化消息前 中间件实现方法
- */
+/** 初始化消息前 中间件实现方法 */
 export type UseRecvMsgFn = (
 /** 消息事件方法 */
 e: KarinMessageType, 
@@ -86,9 +92,7 @@ e: KarinMessageType,
 next: () => void, 
 /** 是否退出此条消息 不再执行匹配插件 */
 exit: () => void) => Promise<void>;
-/**
- * 回复消息前 中间件实现方法
- */
+/** 回复消息前 中间件实现方法 */
 export type UseSendMsgFn = (
 /** 消息事件方法 */
 e: KarinMessageType, 
@@ -98,9 +102,7 @@ element: KarinElement[],
 next: () => void, 
 /** 是否不发送此条消息 */
 exit: () => void) => Promise<void>;
-/**
- * 发送主动消息前 中间件实现方法
- */
+/** 发送主动消息前 中间件实现方法 */
 export type UseSendNoticeFn = (
 /** 发送的bot */
 uid: string, 
@@ -112,9 +114,7 @@ element: KarinElement[],
 next: () => void, 
 /** 是否不发送此条消息 */
 exit: () => void) => Promise<void>;
-/**
- * 发送合并转发前 中间件实现方法
- */
+/** 发送合并转发前 中间件实现方法 */
 export type UseForwardMsgFn = (bot: KarinAdapter, 
 /** 发送的目标信息 */
 contact: Contact, 
@@ -124,9 +124,7 @@ elements: Array<NodeElement>,
 next: () => void, 
 /** 是否不发送此条消息 */
 exit: () => void) => Promise<void>;
-/**
- * 消息事件没有找到任何匹配的插件触发 中间件实现方法
- */
+/** 消息事件没有找到任何匹配的插件触发 中间件实现方法 */
 export type UseNotFoundMsgFn = (
 /** 消息事件方法 */
 e: KarinMessageType, 

package/lib/types/plugin/plugin.d.ts

@@ -2,6 +2,7 @@ import schedule from 'node-schedule';
 import { Reply, replyCallback, replyForward } from '../event/reply.js';
 import { KarinNoticeType, KarinRequestType, AllListenEvent, KarinMessageType, AllMessageSubType, Permission } from '../event/index.js';
 import { AcceptInfo, ButtonInfo, CommandInfo, HandlerInfo, Plugin, UseForwardMsgFn, UseInfo, UseNotFoundMsgFn, UseRecvMsgFn, UseSendMsgFn, UseSendNoticeFn } from '../../core/index.js';
+import { KarinAdapter } from '../adapter/base.js';
 /**
  * - 插件根目录名称
  * - 例如: karin-plugin-example
@@ -15,9 +16,7 @@ export type dirName = `karin-plugin-${string}` | string;
  * - 例如: index.js index.ts
  */
 export type fileName = `${string}.js` | `${string}.ts`;
-/**
- * 插件类型枚举
- */
+/** 插件类型枚举 */
 export declare const enum AppsType {
     /** git插件 */
     Git = "git",
@@ -26,18 +25,14 @@ export declare const enum AppsType {
     /** 单个app插件 */
     Js = "js"
 }
-/**
- * 插件实现方法类型
- */
+/** 插件实现方法类型 */
 export declare const enum MethodType {
     /** 函数 */
     Function = "function",
     /** 类 */
     Class = "class"
 }
-/**
- * plugin基本信息
- */
+/** plugin基本信息 */
 export interface PluginInfoType {
     /** 插件包类型 */
     type: `${AppsType}`;
@@ -48,9 +43,7 @@ export interface PluginInfoType {
     /** 插件文件名称 index.js index.ts */
     file: string;
 }
-/**
- * Command规则集信息
- */
+/** Command规则集信息 */
 export interface PluginCommandInfoType {
     /** 插件基本信息的映射key */
     key: number;
@@ -74,10 +67,12 @@ export interface PluginCommandInfoType {
     event: CommandInfo['event'];
     /** 优先级 */
     rank: CommandInfo['rank'];
+    /** 只有对应的适配器才会生效 */
+    adapter: Array<KarinAdapter['adapter']['name']>;
+    /** 指定的适配器无效 */
+    notAdapter: Array<KarinAdapter['adapter']['name']>;
 }
-/**
- * accept规则集信息
- */
+/** accept规则集信息 */
 export interface PluginAcceptInfoType {
     /** 插件基本信息的映射key */
     key: number;
@@ -91,10 +86,12 @@ export interface PluginAcceptInfoType {
     event: AcceptInfo['event'];
     /** 执行打印日志方法 */
     log: AcceptInfo['log'];
+    /** 只有对应的适配器才会生效 */
+    adapter: Array<KarinAdapter['adapter']['name']>;
+    /** 指定的适配器无效 */
+    notAdapter: Array<KarinAdapter['adapter']['name']>;
 }
-/**
- * task规则集信息
- */
+/** task规则集信息 */
 export interface PluginTaskInfoType {
     /** 插件基本信息的映射key */
     key: number;
@@ -113,9 +110,7 @@ export interface PluginTaskInfoType {
     /** 停止函数 */
     schedule: schedule.Job;
 }
-/**
- * button规则集信息
- */
+/** button规则集信息 */
 export interface PluginButtonInfoType {
     /** 插件基本信息的映射key */
     key: number;
@@ -128,9 +123,7 @@ export interface PluginButtonInfoType {
     /** 优先级 */
     rank: ButtonInfo['rank'];
 }
-/**
- * handler规则集信息
- */
+/** handler规则集信息 */
 export interface PluginHandlerInfoType {
     /** 插件基本信息的映射key */
     key: number;
@@ -151,9 +144,7 @@ export interface UseBase<T> {
     /** 优先级 */
     rank: UseInfo['rank'];
 }
-/**
- * 中间件类型
- */
+/** 中间件类型 */
 export declare const enum UseKeyType {
     /** 收到消息后 */
     ReceiveMsg = "recvMsg",
@@ -166,9 +157,7 @@ export declare const enum UseKeyType {
     /** 消息事件没有找到任何匹配的插件触发 */
     NotFoundMsg = "notFoundMsg"
 }
-/**
- * 中间件映射
- */
+/** 中间件映射 */
 export interface UseMapType {
     [UseKeyType.ReceiveMsg]: Array<UseBase<UseRecvMsgFn>>;
     [UseKeyType.ReplyMsg]: Array<UseBase<UseSendMsgFn>>;
@@ -176,9 +165,7 @@ export interface UseMapType {
     [UseKeyType.ForwardMsg]: Array<UseBase<UseForwardMsgFn>>;
     [UseKeyType.NotFoundMsg]: Array<UseBase<UseNotFoundMsgFn>>;
 }
-/**
- * 上下文状态
- */
+/** 上下文状态 */
 export interface stateArrType {
     [key: string]: {
         type: 'fnc';
@@ -201,9 +188,7 @@ export interface PluginRule {
     event?: AllMessageSubType;
     /** 优先级 默认为10000 */
     priority?: number;
-    /**
-     * 权限
-     */
+    /** 权限 */
     permission?: `${Permission}`;
     /** 打印日志 默认为true */
     log?: boolean | Function;
@@ -329,7 +314,5 @@ export interface PluginApps {
     /** handler */
     handler: Array<PluginHandler>;
 }
-/**
- * 未实例化的插件
- */
+/** 未实例化的插件 */
 export type NewMessagePlugin = new (e?: KarinMessageType) => Plugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-karin",
-  "version": "0.12.16",
+  "version": "0.12.19",
   "private": false,
   "description": "基于 Kritor 进行开发的nodejs机器人框架",
   "homepage": "https://github.com/KarinJS/Karin",