node-karin 0.8.12 → 0.8.14

package/lib/adapter/input/index.js

@@ -48,10 +48,14 @@ export class AdapterInput {
         fs.readdirSync('./temp/input').forEach((file) => {
             fs.unlinkSync(`./temp/input/${file}`);
         });
-        /** 注册bot */
-        const index = listener.addBot({ bot: this, type: this.adapter.type });
-        if (index)
-            this.adapter.index = index;
+        // 等1秒
+        common.sleep(1000)
+            .then(() => {
+            /** 注册bot */
+            const index = listener.addBot({ bot: this, type: this.adapter.type });
+            if (index)
+                this.adapter.index = index;
+        });
         return this;
     }
     init() {

package/lib/cli/karin.js

@@ -77,7 +77,7 @@ class KarinCli {
       }
     }
     /** 启动 */
-    this.child = spawn(runner, cmd, { stdio: ['inherit', 'inherit', 'inherit', 'ipc'], cwd: process.cwd(), env: process.env, shell: true })
+    this.child = spawn(runner, cmd, { stdio: ['inherit', 'inherit', 'inherit', 'ipc'], cwd: process.cwd(), env: process.env })
     /** 监听退出 */
     this.child.once('exit', (code) => process.exit(code))
     /** 监听子进程消息 */
@@ -272,4 +272,5 @@ program.command('dev').description('JavaScript开发模式').action(() => cli.st
 program.command('ts').description('TypeScript开发模式').action(() => cli.start('dev' /* Mode.Dev */, 'ts' /* Lang.Ts */, 'tsx' /* Runner.Tsx */))
 program.command('log').description('查看日志').action(() => cli.log())
 program.command('up').description('更新依赖').action(() => cli.update())
+program.command('init').description('初始化karin').action(() => { import('./init.js') })
 program.parse(process.argv)

package/lib/core/karin.d.ts

@@ -1,4 +1,4 @@
-import { KarinMessage, PluginApps, KarinElement, Contact, KarinRenderType, PermissionType } from '../types/index.js';
+import { Contact, PluginApps, KarinElement, KarinMessage, KarinRenderType, PermissionType, RenderResult, NoticeListenEvent, RequestListenEvent, KarinNoticeType, KarinRequestType } from '../types/index.js';
 type FncFunction = (e: KarinMessage) => Promise<boolean>;
 type FncElement = string | KarinElement | Array<KarinElement>;
 export interface OptionsCommand {
@@ -116,13 +116,24 @@ export declare class Karin {
      */
     contact(peer: string, isGroup?: boolean, sub_peer?: string): Contact;
     /**
-     * - 渲染
+     * 快速渲染
+     * @param file - 文件路径、http地址
+     */
+    render(file: string): Promise<string>;
+    /**
+     * 分片渲染
+     * @param options - 渲染参数
+     */
+    render(file: string, multiPage: number | true): Promise<Array<string>>;
+    /**
+     * 正常渲染
      * @param options - 渲染参数
      */
-    render(options: KarinRenderType): Promise<string>;
+    render<T extends KarinRenderType>(options: T): Promise<RenderResult<T>>;
     /**
-     * - 上下文
+     * 上下文
      * @param e - 消息事件
+     * @param options - 上下文选项
      */
     ctx(e: KarinMessage, options?: {
         /**
@@ -142,6 +153,28 @@ export declare class Karin {
          */
         replyMsg?: string;
     }): Promise<KarinMessage>;
+    /**
+     * accept
+     * @param event - 监听事件
+     * @param fnc - 实现函数
+     */
+    accept(event: NoticeListenEvent | RequestListenEvent, fnc: (e: KarinNoticeType | KarinRequestType) => boolean, options?: {
+        /**
+         * - 插件名称
+         */
+        name?: string;
+        /**
+         * - 优先级
+         */
+        priority?: number;
+        /**
+         * - 触发函数是否打印日志
+         */
+        log?: boolean;
+    }): PluginApps;
+    /**
+     * - 启动
+     */
     run(): void;
 }
 export declare const karin: Karin;

package/lib/core/karin.js

@@ -121,15 +121,27 @@ export class Karin {
 
   /**
      * - 渲染
-     * @param options - 渲染参数
+     * @param data - 渲染参数
+     * @param multiPage - 分片高度
+     * @returns - 返回图片base64或数组
      */
-  render (options) {
-    return render.render(options)
+  render (data, multiPage) {
+    if (typeof data === 'string') {
+      /** 分片 */
+      if (typeof multiPage === 'number' || multiPage === true) {
+        return render.renderMultiHtml(data, multiPage)
+      }
+      /** 快速渲染 */
+      return render.renderHtml(data)
+    }
+    /** 正常渲染 */
+    return render.render(data)
   }
 
   /**
-     * - 上下文
+     * 上下文
      * @param e - 消息事件
+     * @param options - 上下文选项
      */
   async ctx (e, options) {
     const time = options?.time || 120
@@ -150,6 +162,25 @@ export class Karin {
     })
   }
 
+  /**
+     * accept
+     * @param event - 监听事件
+     * @param fnc - 实现函数
+     */
+  accept (event, fnc, options) {
+    const data = {
+      name: options?.name || 'accept',
+      priority: options?.priority,
+      event,
+      accept: fnc,
+      log: options?.log,
+    }
+    return PluginApp(data)
+  }
+
+  /**
+     * - 启动
+     */
   run () {
     if (this.start) { return }
     this.start = true

package/lib/core/listener.d.ts

@@ -4,6 +4,7 @@ import { KarinAdapter, Contact, KarinElement } from '../types/index.js';
  * 监听器管理
  */
 declare class Listeners extends EventEmitter {
+    #private;
     /**
      * Bot索引
      * @type - Bot索引
@@ -93,7 +94,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: Array<KarinElement>, options?: {
         recallMsg?: number;
         retry_count?: number;
     }): Promise<{

package/lib/core/listener.js

@@ -1,9 +1,10 @@
 import { EventEmitter } from 'events'
 import { pluginLoader } from './plugin.loader.js'
-import { common, logger, config } from '../utils/index.js'
+import { common, logger, config, segment } from '../utils/index.js'
 import NoticeHandler from '../event/notice.handler.js'
 import RequestHandler from '../event/request.handler.js'
 import { MessageHandler } from '../event/message.handler.js'
+import { level } from '../db/index.js'
 /**
  * 监听器管理
  */
@@ -51,11 +52,36 @@ class Listeners extends EventEmitter {
     }
     this.list.push({ index, type: data.type, bot: data.bot })
     logger.info(`[机器人][注册][${data.type}] ` + logger.green(`[account:${data.bot.account.uid || data.bot.account.uin}(${data.bot.account.name})]`))
-    this.emit('karin:online', data.bot.account.uid || data.bot.account.uin)
+    this.#online(data.bot.account.uid || data.bot.account.uin)
     logger.debug('注册', this.list)
     return index
   }
 
+  /**
+   * 发送上线通知
+   */
+  async #online (uid) {
+    /** 重启 */
+    const key = `karin:restart:${uid}`
+    const options = await level.get(key)
+    if (!options) { return }
+    const { id, contact, time, message_id } = options
+    /** 重启花费时间 保留2位小数 */
+    const restartTime = ((Date.now() - time) / 1000).toFixed(2)
+    /** 超过2分钟不发 */
+    if (Number(restartTime) > 120) {
+      await level.del(key)
+      return false
+    }
+    const element = [
+      segment.reply(message_id),
+      segment.text(`Karin 重启成功：${restartTime}秒`),
+    ]
+    await this.sendMsg(id, contact, element)
+    await level.del(key)
+    return true
+  }
+
   /**
      * 卸载Bot
      * @param index - Bot的索引id

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

@@ -10,6 +10,7 @@ export interface PluginAppType {
     event?: PluginApps['event'];
     priority?: number;
     accept?: boolean | Function;
+    log?: boolean;
     rule?: PluginApps['rule'];
     task?: PluginApps['task'];
     handler?: PluginApps['handler'];

package/lib/core/plugin.app.js

@@ -10,6 +10,7 @@ export default function PluginApp (options) {
     event: options.event || 'message' /* EventType.Message */,
     priority: options.priority || 10000,
     accept: options.accept ?? false,
+    log: options.log ?? true,
     rule: options.rule || [],
     task: options.task || [],
     handler: options.handler || [],

package/lib/core/plugin.d.ts

@@ -1,4 +1,4 @@
-import { PluginType, KarinElement, NodeElement, stateArrType, KarinNoticeType, KarinRequestType, KarinEventTypes, ReplyReturn } from '../types/index.js';
+import { PluginType, KarinElement, NodeElement, stateArrType, KarinNoticeType, KarinRequestType, ReplyReturn, EType } from '../types/index.js';
 /**
  * 插件基类
  */
@@ -150,7 +150,7 @@ export declare class Plugin implements PluginType {
      * 清除上下文状态
      */
     finish(): void;
-    e: KarinEventTypes;
+    e: EType<this>;
     replyCallback: PluginType['replyCallback'];
 }
 /**

package/lib/core/plugin.loader.js

@@ -340,9 +340,7 @@ class PluginLoader {
     try {
       const keys = Object.keys(this.dependErr)
       if (!keys.length) { return }
-      const msg = [
-        '-----依赖缺失----',
-      ]
+      const msg = ['-----依赖缺失----']
       keys.forEach(key => {
         const { dir, name, depend } = this.dependErr[key]
         msg.push(`[${dir}][${name}] 缺少依赖：${logger.red(depend)}`)

package/lib/core/server.d.ts

@@ -21,5 +21,5 @@ export declare const server: {
      */
     staticPath(): Promise<void>;
     /** 重启当前HTTP服务器 */
-    "__#14@#restartServer"(): Promise<void>;
+    "__#15@#restartServer"(): Promise<void>;
 };

package/lib/render/client.d.ts

@@ -1,6 +1,6 @@
 import WebSocket from 'ws';
 import { RenderBase } from './base.js';
-import { KarinRenderType } from '../types/render.js';
+import { KarinRenderType, RenderResult } from '../types/render.js';
 export declare class RenderClient extends RenderBase {
     url: string;
     type: string;
@@ -26,5 +26,5 @@ export declare class RenderClient extends RenderBase {
      * 渲染标准方法
      * @param options 渲染参数
      */
-    async<T extends KarinRenderType>(options: T): "" | Promise<unknown>;
+    render<T extends KarinRenderType>(options: T): Promise<RenderResult<T>>;
 }

package/lib/render/client.js

@@ -118,7 +118,7 @@ export class RenderClient extends RenderBase {
      * 渲染标准方法
      * @param options 渲染参数
      */
-  async (options) {
+  async render (options) {
     /** 渲染模板 */
     let file = options.file
     let action = 'renderHtml'

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

@@ -239,10 +239,22 @@ export declare const enum CombinedEventType {
      */
     RequestInvitedGroup = "request.invited_group"
 }
+/**
+ * - 消息监听事件
+ */
+export type MessageListenEvent = 'message' | 'message.group_message' | 'message.private_message' | 'message.guild_message' | 'message.nearby' | 'message.stranger';
+/**
+ * - 通知监听事件
+ */
+export type NoticeListenEvent = 'notice' | 'notice.private_poke' | 'notice.private_recall' | 'notice.private_file_uploaded' | 'notice.group_poke' | 'notice.group_card_changed' | 'notice.group_member_unique_title_changed' | 'notice.group_essence_changed' | 'notice.group_recall' | 'notice.group_member_increase' | 'notice.group_member_decrease' | 'notice.group_admin_changed' | 'notice.group_member_ban' | 'notice.group_sign_in' | 'notice.group_whole_ban' | 'notice.group_file_uploaded' | 'notice.group_message_reaction';
+/**
+ * - 请求监听事件
+ */
+export type RequestListenEvent = 'request' | 'request.private_apply' | 'request.group_apply' | 'request.invited_group';
 /**
  * 所有监听事件
  */
-export type AllListenEvent = 'message' | 'notice' | 'request' | 'message.group_message' | 'message.private_message' | 'message.guild_message' | 'message.nearby' | 'message.stranger' | 'notice.private_poke' | 'notice.private_recall' | 'notice.private_file_uploaded' | 'notice.group_poke' | 'notice.group_card_changed' | 'notice.group_member_unique_title_changed' | 'notice.group_essence_changed' | 'notice.group_recall' | 'notice.group_member_increase' | 'notice.group_member_decrease' | 'notice.group_admin_changed' | 'notice.group_member_ban' | 'notice.group_sign_in' | 'notice.group_whole_ban' | 'notice.group_file_uploaded' | 'notice.group_message_reaction' | 'request.private_apply' | 'request.group_apply' | 'request.invited_group';
+export type AllListenEvent = MessageListenEvent | NoticeListenEvent | RequestListenEvent;
 /**
  * 事件基类定义
  */

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

@@ -505,7 +505,7 @@ export declare class KarinNotice implements KarinNoticeEventBase {
     replyCallback: KarinNoticeType['replyCallback'];
     bot: KarinNoticeType['bot'];
     content: KarinNoticeType['content'];
-    constructor({ event_id, self_id, user_id, group_id, time, contact, sender, sub_event, content, }: BaseEventDataType & {
+    constructor({ event_id, self_id, user_id, group_id, time, contact, sender, sub_event, content, raw_event, }: BaseEventDataType & {
         sub_event: KarinNoticeType['sub_event'];
         content: KarinNoticeType['content'];
     });

package/lib/types/event/notice.js

@@ -26,7 +26,8 @@ export class KarinNotice {
     replyCallback;
     bot;
     content;
-    constructor({ event_id, self_id, user_id, group_id = '', time, contact, sender, sub_event, content, }) {
+    constructor({ event_id, self_id, user_id, group_id = '', time, contact, sender, sub_event, content, raw_event, }) {
+        this.raw_event = raw_event;
         this.self_id = self_id;
         this.user_id = user_id;
         this.group_id = contact.scene === 'group' ? (contact.peer || group_id) : group_id;

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

@@ -115,7 +115,7 @@ export declare class KarinRequest implements KarinRequestEventBase {
     bot: KarinRequestType['bot'];
     content: RequestType[RequestSubType];
     raw_event: KarinRequestType['raw_event'];
-    constructor({ self_id, user_id, group_id, time, contact, sender, sub_event, event_id, content, }: BaseEventDataType & {
+    constructor({ self_id, user_id, group_id, time, contact, sender, sub_event, event_id, content, raw_event, }: BaseEventDataType & {
         sub_event: KarinRequestType['sub_event'];
         /**
          * - 事件对应的内容参数

package/lib/types/event/request.js

@@ -26,7 +26,8 @@ export class KarinRequest {
     bot;
     content;
     raw_event;
-    constructor({ self_id, user_id, group_id = '', time, contact, sender, sub_event, event_id, content, }) {
+    constructor({ self_id, user_id, group_id = '', time, contact, sender, sub_event, event_id, content, raw_event, }) {
+        this.raw_event = raw_event;
         this.self_id = self_id;
         this.user_id = user_id;
         this.group_id = contact.scene === 'group' ? (contact.peer || group_id) : group_id;

package/lib/types/plugin.d.ts

@@ -1,7 +1,7 @@
 import schedule from 'node-schedule';
 import { Plugin } from '../core/index.js';
 import { Reply, replyCallback, replyForward } from './event/reply.js';
-import { KarinNoticeType, KarinRequestType, AllListenEvent, KarinEventTypes, KarinMessageType, PermissionType } from './event/index.js';
+import { KarinNoticeType, KarinRequestType, AllListenEvent, KarinMessageType, PermissionType } from './event/index.js';
 /**
  * - 插件根目录名称
  * - 例如: karin-plugin-example
@@ -127,6 +127,12 @@ export interface AppInfo {
      */
     name: fileName;
 }
+/**
+ * - 定义一个条件类型，根据是否存在accept方法来决定类型
+ */
+export type EType<T> = T extends {
+    accept: (e: KarinNoticeType | KarinRequestType) => Promise<void>;
+} ? KarinNoticeType | KarinRequestType : KarinMessageType;
 /**
  * - 插件基类
  */
@@ -178,9 +184,8 @@ export interface PluginType {
     timeout: NodeJS.Timeout | undefined;
     /**
      * - 上报事件
-     * - 根据上报中的event字段来获取e的事件类型
      */
-    e: KarinEventTypes;
+    e: EType<this>;
     init?: () => Promise<any>;
     /**
      * - 快速回复
@@ -254,9 +259,13 @@ export interface PluginApps {
      */
     priority: number;
     /**
-     * - accept函数存在
+     * - accept函数
      */
     accept: boolean | Function;
+    /**
+     * - accept函数触发是否打印日志
+     */
+    log: boolean;
     /**
      * - 命令规则
      */

package/lib/utils/handler.d.ts

@@ -1,4 +1,4 @@
-import { PluginType, PluginApps, KarinEventTypes } from '../types/index.js';
+import { PluginType, PluginApps } from '../types/index.js';
 /**
  * 事件处理器类
  */
@@ -23,7 +23,7 @@ export declare const handler: {
      */
     call(key: string, args: {
         [key: string]: any;
-        e?: KarinEventTypes;
+        e?: any;
     }): Promise<any>;
     /**
      * 检查是否存在指定键的事件处理器

package/package.json

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