node-karin 0.0.3 → 0.1.0

package/lib/core/plugin.d.ts

@@ -1,182 +1,182 @@
-import { Plugin as PluginType } from '../types/plugin.js';
-import { KarinElement, KarinNodeElement } from '../types/element.js';
-import { E } from '../types/types.js';
-/**
- * 插件基类
- */
-export default class Plugin implements PluginType {
-    e: PluginType['e'];
-    init?: () => void;
-    accept?: (e: E) => Promise<void>;
-    replyCallback: PluginType['replyCallback'];
-    /**
-     * @param name - 插件名称
-     */
-    name: PluginType['name'];
-    /**
-     * @param dsc - 插件描述
-     * @deprecated 请使用desc
-     */
-    dsc: PluginType['dsc'];
-    /**
-     * @param desc - 插件描述
-     */
-    desc: PluginType['desc'];
-    /**
-     * @param event - 监听事件
-     */
-    event: PluginType['event'];
-    /**
-     * @param priority - 优先级 默认5000
-     */
-    priority: PluginType['priority'];
-    /**
-     * @param task - 定时任务
-     */
-    task: PluginType['task'];
-    /**
-     * @param rule - 命令规则
-     */
-    rule: PluginType['rule'];
-    /**
-     * @param button - 按钮
-     */
-    button: PluginType['button'];
-    /**
-     * @param handler - handler
-     */
-    handler: PluginType['handler'];
-    /**
-     * @param userId - 用户ID 一般上下文使用
-     */
-    userId?: PluginType['userId'];
-    /**
-     * @param timeout - 上下文超时
-     */
-    timeout: PluginType['timeout'];
-    constructor({ name, dsc, desc, event, priority, task, rule, handler, button, }: {
-        /**
-         * - 插件名称
-         */
-        name: string;
-        /**
-         * - 插件描述 没有则默认为名称
-         */
-        dsc: string;
-        /**
-         * - 插件描述 没有则默认为插件名称
-         */
-        desc?: string;
-        /**
-         * - 监听事件 默认为message
-         */
-        event?: PluginType['event'];
-        /**
-         * - 优先级 默认为5000
-         */
-        priority?: PluginType['priority'];
-        /**
-         * - 定时任务
-         */
-        task?: PluginType['task'];
-        /**
-         * - 命令规则
-         */
-        rule?: PluginType['rule'];
-        /**
-         * - handler
-         */
-        handler?: PluginType['handler'];
-        /**
-         * - 按钮
-         */
-        button?: PluginType['button'];
-    });
-    /**
-     * - 快速回复
-     */
-    reply(msg?: string | KarinElement | Array<KarinElement | string>, options?: {
-        /**
-         * @param at - 是否at用户
-         * @default false
-         */
-        at?: boolean;
-        /**
-         * @param reply - 是否引用回复
-         * @default false
-         */
-        reply?: boolean;
-        /**
-         * @param recallMsg - 群聊是否撤回消息，0-120秒，0不撤回
-         * @default 0
-         */
-        recallMsg?: number;
-        /**
-         * @param button - 是否使用按钮
-         * @default false
-         */
-        button?: boolean;
-        /**
-         * @param retry_count - 重试次数
-         * @default 1
-         */
-        retry_count?: number;
-    }): Promise<{
-        /**
-         * @param message_id - 消息发送成功返回的消息ID
-         */
-        message_id?: string;
-    }>;
-    /**
-     * - 快速回复合并转发
-     */
-    replyForward(msg: KarinNodeElement[]): Promise<{
-        message_id?: string;
-    }>;
-    /**
-     * - 构建上下文键
-     */
-    conKey(): string;
-    /**
-     * 设置上下文状态
-     */
-    setContext(
-    /**
-     * @param fnc - 执行方法
-     */
-    fnc: string, 
-    /**
-     * @param reply - 超时后是否回复
-     */
-    reply?: boolean, 
-    /**
-     * @param time - 超时时间，默认120秒
-     */
-    time?: number): void;
-    /**
-     * 获取上下文状态
-     */
-    getContext(): {
-        plugin: Plugin;
-        fnc: string;
-    };
-    /**
-     * 清除上下文状态
-     */
-    finish(): void;
-}
-/**
- * 上下文状态
- */
-export declare const stateArr: {
-    [key: string]: {
-        /**
-         * @param plugin - 插件实例
-         */
-        plugin: Plugin;
-        /**
-         * @param fnc - 执行方法名称
-         */
-        fnc: string;
-    };
-};
+import { Plugin as PluginType } from '../types/plugin.js';
+import { KarinElement, KarinNodeElement } from '../types/element.js';
+import { E } from '../types/types.js';
+/**
+ * 插件基类
+ */
+export default class Plugin implements PluginType {
+    e: PluginType['e'];
+    init?: () => void;
+    accept?: (e: E) => Promise<void>;
+    replyCallback: PluginType['replyCallback'];
+    /**
+     * @param name - 插件名称
+     */
+    name: PluginType['name'];
+    /**
+     * @param dsc - 插件描述
+     * @deprecated 请使用desc
+     */
+    dsc: PluginType['dsc'];
+    /**
+     * @param desc - 插件描述
+     */
+    desc: PluginType['desc'];
+    /**
+     * @param event - 监听事件
+     */
+    event: PluginType['event'];
+    /**
+     * @param priority - 优先级 默认5000
+     */
+    priority: PluginType['priority'];
+    /**
+     * @param task - 定时任务
+     */
+    task: PluginType['task'];
+    /**
+     * @param rule - 命令规则
+     */
+    rule: PluginType['rule'];
+    /**
+     * @param button - 按钮
+     */
+    button: PluginType['button'];
+    /**
+     * @param handler - handler
+     */
+    handler: PluginType['handler'];
+    /**
+     * @param userId - 用户ID 一般上下文使用
+     */
+    userId?: PluginType['userId'];
+    /**
+     * @param timeout - 上下文超时
+     */
+    timeout: PluginType['timeout'];
+    constructor({ name, dsc, desc, event, priority, task, rule, handler, button, }: {
+        /**
+         * - 插件名称
+         */
+        name: string;
+        /**
+         * - 插件描述 没有则默认为名称
+         */
+        dsc: string;
+        /**
+         * - 插件描述 没有则默认为插件名称
+         */
+        desc?: string;
+        /**
+         * - 监听事件 默认为message
+         */
+        event?: PluginType['event'];
+        /**
+         * - 优先级 默认为5000
+         */
+        priority?: PluginType['priority'];
+        /**
+         * - 定时任务
+         */
+        task?: PluginType['task'];
+        /**
+         * - 命令规则
+         */
+        rule?: PluginType['rule'];
+        /**
+         * - handler
+         */
+        handler?: PluginType['handler'];
+        /**
+         * - 按钮
+         */
+        button?: PluginType['button'];
+    });
+    /**
+     * - 快速回复
+     */
+    reply(msg?: string | KarinElement | Array<KarinElement | string>, options?: {
+        /**
+         * @param at - 是否at用户
+         * @default false
+         */
+        at?: boolean;
+        /**
+         * @param reply - 是否引用回复
+         * @default false
+         */
+        reply?: boolean;
+        /**
+         * @param recallMsg - 群聊是否撤回消息，0-120秒，0不撤回
+         * @default 0
+         */
+        recallMsg?: number;
+        /**
+         * @param button - 是否使用按钮
+         * @default false
+         */
+        button?: boolean;
+        /**
+         * @param retry_count - 重试次数
+         * @default 1
+         */
+        retry_count?: number;
+    }): Promise<{
+        /**
+         * @param message_id - 消息发送成功返回的消息ID
+         */
+        message_id?: string;
+    }>;
+    /**
+     * - 快速回复合并转发
+     */
+    replyForward(msg: KarinNodeElement[]): Promise<{
+        message_id?: string;
+    }>;
+    /**
+     * - 构建上下文键
+     */
+    conKey(): string;
+    /**
+     * 设置上下文状态
+     */
+    setContext(
+    /**
+     * @param fnc - 执行方法
+     */
+    fnc: string, 
+    /**
+     * @param reply - 超时后是否回复
+     */
+    reply?: boolean, 
+    /**
+     * @param time - 超时时间，默认120秒
+     */
+    time?: number): void;
+    /**
+     * 获取上下文状态
+     */
+    getContext(): {
+        plugin: Plugin;
+        fnc: string;
+    };
+    /**
+     * 清除上下文状态
+     */
+    finish(): void;
+}
+/**
+ * 上下文状态
+ */
+export declare const stateArr: {
+    [key: string]: {
+        /**
+         * @param plugin - 插件实例
+         */
+        plugin: Plugin;
+        /**
+         * @param fnc - 执行方法名称
+         */
+        fnc: string;
+    };
+};

package/lib/core/plugin.js

@@ -1,138 +1,138 @@
-/**
- * 插件基类
- */
-export default class Plugin {
-  e
-  init
-  accept
-  replyCallback
-  /**
-     * @param name - 插件名称
-     */
-  name
-  /**
-     * @param dsc - 插件描述
-     * @deprecated 请使用desc
-     */
-  dsc
-  /**
-     * @param desc - 插件描述
-     */
-  desc
-  /**
-     * @param event - 监听事件
-     */
-  event
-  /**
-     * @param priority - 优先级 默认5000
-     */
-  priority
-  /**
-     * @param task - 定时任务
-     */
-  task
-  /**
-     * @param rule - 命令规则
-     */
-  rule
-  /**
-     * @param button - 按钮
-     */
-  button
-  /**
-     * @param handler - handler
-     */
-  handler
-  /**
-     * @param userId - 用户ID 一般上下文使用
-     */
-  userId
-  /**
-     * @param timeout - 上下文超时
-     */
-  timeout
-  constructor ({ name, dsc = name, desc = name, event = 'message', priority = 5000, task = [], rule = [], handler = [], button = [] }) {
-    this.name = name
-    this.dsc = dsc
-    this.desc = desc
-    this.event = event
-    this.priority = priority
-    this.task = task
-    this.rule = rule
-    this.button = button
-    this.handler = handler
+/**
+ * 插件基类
+ */
+export default class Plugin {
+  e
+  init
+  accept
+  replyCallback
+  /**
+     * @param name - 插件名称
+     */
+  name
+  /**
+     * @param dsc - 插件描述
+     * @deprecated 请使用desc
+     */
+  dsc
+  /**
+     * @param desc - 插件描述
+     */
+  desc
+  /**
+     * @param event - 监听事件
+     */
+  event
+  /**
+     * @param priority - 优先级 默认5000
+     */
+  priority
+  /**
+     * @param task - 定时任务
+     */
+  task
+  /**
+     * @param rule - 命令规则
+     */
+  rule
+  /**
+     * @param button - 按钮
+     */
+  button
+  /**
+     * @param handler - handler
+     */
+  handler
+  /**
+     * @param userId - 用户ID 一般上下文使用
+     */
+  userId
+  /**
+     * @param timeout - 上下文超时
+     */
+  timeout
+  constructor ({ name, dsc = name, desc = name, event = 'message', priority = 5000, task = [], rule = [], handler = [], button = [] }) {
+    this.name = name
+    this.dsc = dsc
+    this.desc = desc
+    this.event = event
+    this.priority = priority
+    this.task = task
+    this.rule = rule
+    this.button = button
+    this.handler = handler
   }
-
-  /**
-     * - 快速回复
-     */
-  reply (msg = '', options = { reply: false, recallMsg: 0, at: false, button: false, retry_count: 1 }) {
-    return this.e.reply(msg, options)
+
+  /**
+     * - 快速回复
+     */
+  reply (msg = '', options = { reply: false, recallMsg: 0, at: false, button: false, retry_count: 1 }) {
+    return this.e.reply(msg, options)
   }
-
-  /**
-     * - 快速回复合并转发
-     */
-  async replyForward (msg) {
-    const result = await this.e.bot.sendForwardMessage(this.e.contact, msg)
-    return result
+
+  /**
+     * - 快速回复合并转发
+     */
+  async replyForward (msg) {
+    const result = await this.e.bot.sendForwardMessage(this.e.contact, msg)
+    return result
   }
-
-  /**
-     * - 构建上下文键
-     */
-  conKey () {
-    return `${this.e.isGroup ? `${this.e.group_id}.` : ''}` + (this.userId || this.e.user_id)
+
+  /**
+     * - 构建上下文键
+     */
+  conKey () {
+    return `${this.e.isGroup ? `${this.e.group_id}.` : ''}` + (this.userId || this.e.user_id)
   }
-
-  /**
-     * 设置上下文状态
-     */
-  setContext (
-    /**
-     * @param fnc - 执行方法
-     */
-    fnc,
-    /**
-     * @param reply - 超时后是否回复
-     */
-    reply = true,
-    /**
-     * @param time - 超时时间，默认120秒
-     */
-    time = 120) {
-    const key = this.conKey()
-    stateArr[key] = { plugin: this, fnc }
-    /** 操作时间 */
-    this.timeout = setTimeout(() => {
-      if (stateArr[key]) {
-        delete stateArr[key]
-        if (reply) { this.e.reply('操作超时已取消', { at: true }) }
-      }
-    }, time * 1000)
+
+  /**
+     * 设置上下文状态
+     */
+  setContext (
+    /**
+     * @param fnc - 执行方法
+     */
+    fnc,
+    /**
+     * @param reply - 超时后是否回复
+     */
+    reply = true,
+    /**
+     * @param time - 超时时间，默认120秒
+     */
+    time = 120) {
+    const key = this.conKey()
+    stateArr[key] = { plugin: this, fnc }
+    /** 操作时间 */
+    this.timeout = setTimeout(() => {
+      if (stateArr[key]) {
+        delete stateArr[key]
+        if (reply) { this.e.reply('操作超时已取消', { at: true }) }
+      }
+    }, time * 1000)
   }
-
-  /**
-     * 获取上下文状态
-     */
-  getContext () {
-    const key = this.conKey()
-    return stateArr[key]
+
+  /**
+     * 获取上下文状态
+     */
+  getContext () {
+    const key = this.conKey()
+    return stateArr[key]
   }
-
-  /**
-     * 清除上下文状态
-     */
-  finish () {
-    const key = this.conKey()
-    if (stateArr[key] && stateArr[key]) {
-      /** 清除定时器 */
-      clearTimeout(this.timeout)
-      delete stateArr[key]
-    }
-  }
-}
-/**
- * 上下文状态
- */
-export const stateArr = {}
+
+  /**
+     * 清除上下文状态
+     */
+  finish () {
+    const key = this.conKey()
+    if (stateArr[key] && stateArr[key]) {
+      /** 清除定时器 */
+      clearTimeout(this.timeout)
+      delete stateArr[key]
+    }
+  }
+}
+/**
+ * 上下文状态
+ */
+export const stateArr = {}