node-karin 0.6.18 → 0.6.20

package/lib/cli/init.js

@@ -1,12 +1,20 @@
 #!/usr/bin/env node
 import { select } from '@inquirer/prompts'
 import { KarinInit } from '../utils/init.js'
+/**
+ * 休眠函数
+ * @param ms 毫秒
+ */
+function sleep (ms) {
+  return new Promise(resolve => setTimeout(resolve, ms))
+}
 async function main () {
   /** 捕获错误 打印日志 */
   process.on('uncaughtException', err => console.error(err))
   process.on('unhandledRejection', err => console.error(err))
   const init = new KarinInit()
   init.init()
+  await sleep(1000)
   const prompt = await select({
     message: '请选择npm源 中国大陆服务器一定要更换!!!',
     choices: [
@@ -14,8 +22,11 @@ async function main () {
       { name: '官方源', value: 'https://registry.npmjs.org' },
     ],
   })
+  console.log('正在更换npm源...请稍等~')
+  await sleep(1000)
   /** 结果 */
   await init.changeRegistry(prompt)
+  await sleep(1000)
   const pkg = await select({
     message: '请选择包管理器 如果不知道怎么选 请选pnpm',
     choices: [

package/lib/core/karin.d.ts

@@ -1,5 +1,4 @@
-import { KarinMessage } from '../event/message.js';
-import { Permission, PluginApps, KarinElement, contact, KarinRenderType } from '../types/index.js';
+import { KarinMessage, PluginApps, KarinElement, Contact, KarinRenderType, PermissionType } from '../types/index.js';
 type FncFunction = (e: KarinMessage) => Promise<boolean>;
 type FncElement = string | KarinElement | Array<KarinElement>;
 export interface OptionsCommand {
@@ -16,7 +15,7 @@ export interface OptionsCommand {
      * - 权限
      * @default 'all'
      */
-    permission?: Permission;
+    permission?: PermissionType;
     /**
      * - 打印日志
      * @default false
@@ -113,7 +112,7 @@ export declare class Karin {
      * @param isGroup - 是否是群聊
      * @param sub_peer - 子id
      */
-    contact(peer: string, isGroup?: boolean, sub_peer?: string): contact;
+    contact(peer: string, isGroup?: boolean, sub_peer?: string): Contact;
     /**
      * - 渲染
      * @param options - 渲染参数

package/lib/core/karin.js

@@ -3,6 +3,7 @@ import { common } from '../utils/index.js'
 import { render } from '../render/index.js'
 import { stateArr } from './plugin.js'
 import { listener } from './listener.js'
+import { Scene } from '../types/index.js'
 export class Karin {
   /**
      * - 快速构建命令
@@ -99,13 +100,13 @@ export class Karin {
   contact (peer, isGroup = true, sub_peer) {
     if (isGroup) {
       return {
-        scene: 'group',
+        scene: Scene.Group,
         peer,
         sub_peer: sub_peer || '',
       }
     }
     return {
-      scene: 'friend',
+      scene: Scene.Private,
       peer,
       sub_peer: sub_peer || '',
     }

package/lib/core/listener.d.ts

@@ -1,5 +1,5 @@
 import { EventEmitter } from 'events';
-import { KarinAdapter, contact, KarinElement } from '../types/index.js';
+import { KarinAdapter, Contact, KarinElement } from '../types/index.js';
 /**
  * 监听器管理
  */
@@ -93,7 +93,7 @@ declare class Listeners extends EventEmitter {
      * @param options.recallMsg - 发送成功后撤回消息时间
      * @param options.retry_count - 重试次数
      */
-    sendMsg(uid: string, contact: contact, elements: KarinElement, options?: {
+    sendMsg(uid: string, contact: Contact, elements: KarinElement, options?: {
         recallMsg?: number;
         retry_count?: number;
     }): Promise<{

package/lib/core/listener.js

@@ -1,9 +1,9 @@
 import { EventEmitter } from 'events'
 import { pluginLoader } from './plugin.loader.js'
 import { common, logger, config } from '../utils/index.js'
-import { MessageHandler } from '../event/message.handler.js'
 import NoticeHandler from '../event/notice.handler.js'
 import RequestHandler from '../event/request.handler.js'
+import { MessageHandler } from '../event/message.handler.js'
 /**
  * 监听器管理
  */
@@ -29,7 +29,7 @@ class Listeners extends EventEmitter {
     this.on('load.plugin', () => pluginLoader.load())
     this.on('adapter', data => {
       let path = data.path || '无'
-      if (path && data.type !== 'grpc') { path = `ws://127.0.0.1:/${config.Server.http.port}${data.path}` }
+      if (path && data.type !== 'grpc') { path = `ws://127.0.0.1:${config.Server.http.port}${data.path}` }
       path = logger.green(path)
       logger.info(`[适配器][注册][${data.type}]: ` + path)
       this.addAdapter(data)

package/lib/core/plugin.app.js

@@ -1,3 +1,4 @@
+import { EventType } from '../types/index.js'
 export default function PluginApp (options) {
   return {
     file: {
@@ -7,7 +8,7 @@ export default function PluginApp (options) {
       Fnc: options?.file?.fnc || '',
     },
     name: options.name || '',
-    event: options.event || 'message',
+    event: options.event || EventType.Message,
     priority: options.priority || 10000,
     accept: options.accept ?? false,
     rule: options.rule || [],

package/lib/core/plugin.d.ts

@@ -1,4 +1,4 @@
-import { PluginType, KarinElement, KarinNodeElement, EventType, KarinNoticeEvent, KarinRequestEvent, stateArrType } from '../types/index.js';
+import { PluginType, KarinElement, NodeElement, stateArrType, KarinNoticeType, KarinRequestType, KarinEventTypes } from '../types/index.js';
 /**
  * 插件基类
  */
@@ -124,7 +124,7 @@ export declare class Plugin implements PluginType {
     /**
      * - 快速回复合并转发
      */
-    replyForward(msg: KarinNodeElement[]): Promise<{
+    replyForward(msg: NodeElement[]): Promise<{
         message_id?: string;
     }>;
     /**
@@ -155,7 +155,7 @@ export declare class Plugin implements PluginType {
      * 清除上下文状态
      */
     finish(): void;
-    e: EventType<this>;
+    e: KarinEventTypes;
     replyCallback: PluginType['replyCallback'];
 }
 /**
@@ -166,5 +166,5 @@ export declare const stateArr: stateArrType;
  * 通知事件 插件类型
  */
 export interface ExtendedPlugin extends Plugin {
-    accept: (e: KarinNoticeEvent | KarinRequestEvent) => Promise<void>;
+    accept: (e: KarinNoticeType | KarinRequestType) => Promise<void>;
 }

package/lib/core/plugin.js

@@ -1,3 +1,4 @@
+import { EventType } from '../types/index.js'
 /**
  * 插件基类
  */
@@ -47,7 +48,7 @@ export class Plugin {
      * @param timeout - 上下文超时
      */
   timeout
-  constructor ({ name, dsc = name, desc = name, event = 'message', priority = 10000, task = [], rule = [], handler = [], button = [] }) {
+  constructor ({ name, dsc = name, desc = name, event = EventType.Message, priority = 10000, task = [], rule = [], handler = [], button = [] }) {
     this.name = name
     this.dsc = dsc
     this.desc = desc

package/lib/core/plugin.loader.d.ts

@@ -1,7 +1,7 @@
 import chokidar from 'chokidar';
 import schedule from 'node-schedule';
 import { Plugin } from './plugin.js';
-import { PluginApps, PluginTask, dirName, fileName, AppInfo, NewPlugin } from '../types/index.js';
+import { PluginApps, PluginTask, dirName, fileName, AppInfo, NewMessagePlugin } from '../types/index.js';
 declare class PluginLoader {
     dir: './plugins';
     dirPath: string;
@@ -53,7 +53,7 @@ declare class PluginLoader {
      * - 定时任务
      */
     task: Array<PluginTask & {
-        App: NewPlugin;
+        App: NewMessagePlugin;
         schedule?: schedule.Job;
         file: {
             dir: dirName;
@@ -118,7 +118,7 @@ declare class PluginLoader {
     /**
      * 新增task
      */
-    addTask(dir: dirName, name: fileName, index: number, Class: Plugin, App: NewPlugin): Promise<void>;
+    addTask(dir: dirName, name: fileName, index: number, Class: Plugin, App: NewMessagePlugin): Promise<void>;
     /**
      * 新增accept、handler
      */

package/lib/core/plugin.loader.js

@@ -7,6 +7,7 @@ import { listener } from './listener.js'
 import PluginApp from './plugin.app.js'
 import { render } from '../render/index.js'
 import { common, handler, logger } from '../utils/index.js'
+import { Permission } from '../types/index.js'
 class PluginLoader {
   dir
   dirPath
@@ -321,7 +322,7 @@ class PluginLoader {
         reg: val.reg instanceof RegExp ? val.reg : new RegExp(val.reg),
         fnc: val.fnc,
         event: val.event,
-        permission: val.permission || 'all',
+        permission: val.permission || Permission.All,
         log: val.log === false ? (id, log) => logger.debug('mark', id, log) : (id, log) => logger.bot('mark', id, log),
       })
     })

package/lib/core/server.js

@@ -1,13 +1,13 @@
 import fs from 'fs'
 import Process from './process.js'
-import { listener } from './listener.js'
 import { WebSocketServer } from 'ws'
 import { createServer } from 'http'
+import { listener } from './listener.js'
 import express from 'express'
+import { KritorGrpc } from '../adapter/index.js'
 import { exec, config, logger, common } from '../utils/index.js'
+import { AdapterOneBot11 } from '../adapter/onebot/11/index.js'
 import { render, HttpRenderer, Wormhole, RenderClient } from '../render/index.js'
-import { AdapterOneBot11 } from '../adapter/onebot/onebot11.js'
-import { KritorGrpc } from '../adapter/index.js'
 export const server = new (class Server {
   reg
   list

package/lib/event/event.handler.d.ts

@@ -1,6 +1,6 @@
-import { Event, Permission, SubEvent, GroupCfg, KarinMessageEvent, KarinNoticeEvent, KarinRequestEvent } from '../types/index.js';
+import { GroupCfg, KarinEventTypes, AllListenEvent, PluginRule } from '../types/index.js';
 export default class EventHandler {
-    e: KarinMessageEvent | KarinNoticeEvent | KarinRequestEvent;
+    e: KarinEventTypes;
     config: GroupCfg | {};
     /**
      * - 是否打印群消息日志
@@ -9,7 +9,7 @@ export default class EventHandler {
     /**
      * 处理事件，加入自定义字段
      */
-    constructor(e: KarinMessageEvent | KarinNoticeEvent | KarinRequestEvent);
+    constructor(e: KarinEventTypes);
     /**
      * 事件处理
      */
@@ -17,11 +17,11 @@ export default class EventHandler {
     /**
      * 根据事件类型过滤事件
      */
-    filtEvent(event: Event | `${Event}.${SubEvent}`): boolean;
+    filtEvent(event: AllListenEvent): boolean;
     /**
      * 判断权限
      */
-    filterPermission(permission: Permission | undefined): boolean;
+    filterPermission(permission?: PluginRule['permission']): boolean;
     /**
      * 快速回复
      */

package/lib/event/event.handler.js

@@ -1,5 +1,5 @@
-import { review } from './review.handler.js'
 import { listener } from '../core/index.js'
+import { review } from './review.handler.js'
 import { segment, common, logger, config } from '../utils/index.js'
 export default class EventHandler {
   e
@@ -90,10 +90,11 @@ export default class EventHandler {
         },
       }
       const role = list[permission]
-      if (role && this.e.sender?.role !== role.role) {
-        this.e.reply(`暂无权限，只有${role.name}才能操作`)
-        return false
-      }
+      if (!role) { return true }
+      if (role.role === 'owner' && this.e.sender?.role === 'owner') { return true }
+      if (role.role === 'admin' && (this.e.sender?.role === 'owner' || this.e.sender?.role === 'admin')) { return true }
+      this.e.reply(`暂无权限，只有${role.name}才能操作`)
+      return false
     }
     return true
   }

package/lib/event/index.d.ts

@@ -1,9 +1,5 @@
-export * from './event.js';
 export * from './event.handler.js';
-export * from './message.js';
 export * from './message.handler.js';
-export * from './notice.js';
 export * from './notice.handler.js';
-export * from './request.js';
 export * from './request.handler.js';
 export * from './review.handler.js';

package/lib/event/index.js

@@ -1,9 +1,5 @@
-export * from './event.js'
 export * from './event.handler.js'
-export * from './message.js'
 export * from './message.handler.js'
-export * from './notice.js'
 export * from './notice.handler.js'
-export * from './request.js'
 export * from './request.handler.js'
 export * from './review.handler.js'

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

@@ -1,15 +1,15 @@
 import EventHandler from './event.handler.js';
-import { KarinMessageEvent } from '../types/index.js';
+import { KarinMessageType } from '../types/index.js';
 /**
  * 消息事件
  */
 export declare class MessageHandler extends EventHandler {
-    e: KarinMessageEvent;
+    e: KarinMessageType;
     /**
      * - 是否打印群消息日志
      */
     GroupMsgPrint: boolean;
-    constructor(e: KarinMessageEvent);
+    constructor(e: KarinMessageType);
     /**
      * 处理消息
      */

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

@@ -1,11 +1,11 @@
 import EventHandler from './event.handler.js';
-import { KarinNoticeEvent } from '../types/index.js';
+import { KarinNoticeType } from '../types/index.js';
 /**
  * 通知事件
  */
 export default class NoticeHandler extends EventHandler {
-    e: KarinNoticeEvent;
-    constructor(e: KarinNoticeEvent);
+    e: KarinNoticeType;
+    constructor(e: KarinNoticeType);
     /**
      * 处理事件
      */

package/lib/event/notice.handler.js

@@ -1,6 +1,7 @@
 import { review } from './review.handler.js'
 import EventHandler from './event.handler.js'
 import { logger, config } from '../utils/index.js'
+import { NoticeSubType } from '../types/index.js'
 import { pluginLoader } from '../core/index.js'
 /**
  * 通知事件
@@ -84,48 +85,48 @@ export default class NoticeHandler extends EventHandler {
   raw_message () {
     switch (this.e.sub_event) {
       /** 好友头像戳一戳 */
-      case 'private_poke': {
+      case NoticeSubType.PrivatePoke: {
         this.e.raw_message = '[好友戳一戳]: 戳了你一下'
         break
       }
       /** 好友消息撤回 */
-      case 'private_recall': {
+      case NoticeSubType.PrivateRecall: {
         this.e.raw_message = `[好友消息撤回]: ${this.e.content.message_id}`
         break
       }
       /** 私聊文件上传 */
-      case 'private_file_uploaded': {
+      case NoticeSubType.PrivateFileUploaded: {
         const content = this.e.content
         const { file_url } = content
         this.e.raw_message = `[私聊文件上传]: ${file_url}`
         break
       }
       /** 群头像戳一戳 */
-      case 'group_poke': {
+      case NoticeSubType.GroupPoke: {
         const { operator_uid, operator_uin, target_uid, target_uin } = this.e.content
         this.e.raw_message = `[群戳一戳]: ${operator_uid || operator_uin} 戳了戳 ${target_uid || target_uin}`
         break
       }
       /** 群消息撤回 */
-      case 'group_recall': {
+      case NoticeSubType.GroupRecall: {
         const { operator_uid, operator_uin, message_id } = this.e.content
         this.e.raw_message = `[群消息撤回]: ${operator_uid || operator_uin} 撤回了一条消息 ${message_id}`
         break
       }
       /** 群文件上传 */
-      case 'group_file_uploaded': {
+      case NoticeSubType.GroupFileUploaded: {
         const { file_url, operator_uid, operator_uin } = this.e.content
         this.e.raw_message = `[群文件上传]: ${operator_uid || operator_uin} 上传了 ${file_url}`
         break
       }
       /** 群成员增加 */
-      case 'group_member_increase': {
+      case NoticeSubType.GroupMemberIncrease: {
         const { operator_uid, operator_uin, target_uid, target_uin, type } = this.e.content
         this.e.raw_message = `[群成员新增]: ${operator_uid || operator_uin} ${type === 'invite' ? '邀请' : '同意'}  ${target_uid || target_uin} 加入群聊`
         break
       }
       /** 群成员减少 */
-      case 'group_member_decrease': {
+      case NoticeSubType.GroupMemberDecrease: {
         switch (this.e.content.type) {
           case 'leave': {
             const { target_uid, target_uin } = this.e.content
@@ -148,49 +149,49 @@ export default class NoticeHandler extends EventHandler {
         break
       }
       /** 群管理员变动 */
-      case 'group_admin_changed': {
+      case NoticeSubType.GroupAdminChanged: {
         const { target_uid, target_uin, is_admin } = this.e.content
         this.e.raw_message = `[群管理员变动]: ${target_uid || target_uin} 被${is_admin ? '设置' : '取消'}群管理员`
         break
       }
       /** 群成员被禁言 */
-      case 'group_member_ban': {
+      case NoticeSubType.GroupMemberBan: {
         const { operator_uid, operator_uin, target_uid, target_uin, type } = this.e.content
         this.e.raw_message = `[群成员禁言]: ${operator_uid || operator_uin} ${type === 'ban' ? '禁言' : '解禁'}了 ${target_uid || target_uin}`
         break
       }
       /** 群签到 */
-      case 'group_sign_in': {
+      case NoticeSubType.GroupSignIn: {
         const { target_uid, target_uin } = this.e.content
         this.e.raw_message = `[群签到]: ${target_uid || target_uin}`
         break
       }
       /** 群全员禁言 */
-      case 'group_whole_ban': {
+      case NoticeSubType.GroupWholeBan: {
         const { operator_uid, operator_uin, is_ban } = this.e.content
         this.e.raw_message = `[群全员禁言]: ${operator_uid || operator_uin} ${is_ban ? '开启全员禁言' : '解除全员禁言'}`
         break
       }
       /** 群名片改变 */
-      case 'group_card_changed': {
+      case NoticeSubType.GroupCardChanged: {
         const { operator_uid, operator_uin, target_uid, target_uin, new_card } = this.e.content
         this.e.raw_message = `[群名片改变]: ${operator_uid || operator_uin} 修改了 ${target_uid || target_uin} 的名片为 ${new_card}`
         break
       }
       /** 群成员专属头衔改变 */
-      case 'group_member_unique_title_changed': {
+      case NoticeSubType.GroupMemberUniqueTitleChanged: {
         const { target_uid, target_uin, title } = this.e.content
         this.e.raw_message = `[群头衔更改]: ${target_uid || target_uin} 的专属头衔改变为 ${title}`
         break
       }
       /** 群精华消息改变 */
-      case 'group_essence_changed': {
+      case NoticeSubType.GroupEssenceChanged: {
         const { operator_uid, operator_uin, target_uid, target_uin, message_id, is_set } = this.e.content
         this.e.raw_message = `[群精华消息]: ${operator_uid || operator_uin} ${is_set ? `将${target_uid || target_uin}的消息${message_id}设置为精华消息` : `取消了${target_uid || target_uin}精华消息 ${message_id}`}`
         break
       }
       /** 群表情回应 */
-      case 'group_message_reaction': {
+      case NoticeSubType.GroupMessageReaction: {
         const { message_id, face_id } = this.e.content
         this.e.raw_message = `[群表情回应]: ${this.e.user_id} 给消息 ${message_id} 回应了一个${face_id}的表情`
         break

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

@@ -1,11 +1,11 @@
 import EventHandler from './event.handler.js';
-import { KarinRequestEvent } from '../types/index.js';
+import { KarinRequestType } from '../types/index.js';
 /**
  * 请求事件
  */
 export default class RequestHandler extends EventHandler {
-    e: KarinRequestEvent;
-    constructor(e: KarinRequestEvent);
+    e: KarinRequestType;
+    constructor(e: KarinRequestType);
     /**
      * 处理事件
      */

package/lib/event/request.handler.js

@@ -1,6 +1,7 @@
 import { review } from './review.handler.js'
 import EventHandler from './event.handler.js'
 import { logger, config } from '../utils/index.js'
+import { RequestSubType } from '../types/index.js'
 import { pluginLoader } from '../core/index.js'
 /**
  * 请求事件
@@ -84,19 +85,19 @@ export default class RequestHandler extends EventHandler {
   raw_message () {
     switch (this.e.sub_event) {
       /** 好友申请 */
-      case 'private_apply': {
+      case RequestSubType.PrivateApply: {
         const { applier_uid, applier_uin, message } = this.e.content
         this.e.raw_message = `[好友申请]: ${applier_uid || applier_uin} 申请理由: ${message}`
         break
       }
       /** 群申请 */
-      case 'group_apply': {
+      case RequestSubType.GroupApply: {
         const { group_id, applier_uid, applier_uin, inviter_uid, inviter_uin, reason } = this.e.content
         this.e.raw_message = `[群申请]: ${group_id} 申请人: ${applier_uid || applier_uin} 邀请人: ${inviter_uid || inviter_uin} 理由: ${reason}`
         break
       }
       /** 邀请入群 */
-      case 'invited_group': {
+      case RequestSubType.InvitedGroup: {
         const { group_id, inviter_uid, inviter_uin } = this.e.content
         this.e.raw_message = `[邀请入群]: ${group_id} 邀请人: ${inviter_uid || inviter_uin}`
         break

package/lib/event/review.handler.d.ts

@@ -1,5 +1,4 @@
-import { KarinMessage } from '../event/index.js';
-import { EType, PluginApps, GroupCfg } from '../types/index.js';
+import { KarinMessageType, PluginApps, GroupCfg, KarinEventTypes } from '../types/index.js';
 /**
  * 事件拦截器
  * 利用可执行函数的特性，热更新所有拦截器
@@ -14,12 +13,12 @@ export declare const review: {
     };
     App: import("../types/index.js").App;
     Config: import("../types/index.js").Config;
-    CD: (e: EType, config: GroupCfg) => boolean;
-    mode: (e: KarinMessage, config: GroupCfg) => boolean;
-    alias: (e: KarinMessage, config: GroupCfg) => boolean;
-    GroupEnable: (e: EType) => boolean;
-    UserEnable: (e: EType) => boolean;
-    GroupMsgPrint: (e: EType) => boolean;
+    CD: (e: KarinEventTypes, config: GroupCfg) => boolean;
+    mode: (e: KarinMessageType, config: GroupCfg) => boolean;
+    alias: (e: KarinMessageType, config: GroupCfg) => boolean;
+    GroupEnable: (e: KarinEventTypes) => boolean;
+    UserEnable: (e: KarinEventTypes) => boolean;
+    GroupMsgPrint: (e: KarinEventTypes) => boolean;
     PluginEnable: (app: PluginApps, config: GroupCfg) => boolean;
     main(): void;
     /**

package/lib/index.js

@@ -15,7 +15,7 @@ export * from './adapter/index.js';
 import { config, update } from './utils/index.js';
 import { render } from './render/index.js';
 import { RenderServer } from './render/index.js';
-import OneBot11 from './adapter/onebot/onebot11.js';
+import OneBot11 from './adapter/onebot/11/index.js';
 import { server, Karin, listener, Plugin } from './core/index.js';
 // 初始化
 server.init();