node-karin 0.6.18 → 0.6.20

package/lib/types/onebot11/segment.d.ts

@@ -0,0 +1,268 @@
+/**
+ * - OneBot11消息类型枚举
+ */
+export declare enum OB11SegmentType {
+    Text = "text",
+    Face = "face",
+    Image = "image",
+    Record = "record",
+    Video = "video",
+    At = "at",
+    Rps = "rps",
+    Dice = "dice",
+    Shake = "shake",
+    Poke = "poke",
+    Anonymous = "anonymous",
+    Share = "share",
+    Contact = "contact",
+    Location = "location",
+    Music = "music",
+    MusicCustom = "music_custom",
+    Reply = "reply",
+    Forward = "forward",
+    Node = "node",
+    NodeCustom = "node_custom",
+    Xml = "xml",
+    Json = "json",
+    File = "file"
+}
+export interface Segment {
+    type: OB11SegmentType;
+}
+/**
+ * - 纯文本
+ */
+export interface TextSegment extends Segment {
+    type: OB11SegmentType.Text;
+    data: {
+        text: string;
+    };
+}
+/**
+ * - QQ表情
+ */
+export interface FaceSegment extends Segment {
+    type: OB11SegmentType.Face;
+    data: {
+        id: string;
+    };
+}
+/**
+ * - 图片消息段
+ */
+export interface ImageSegment extends Segment {
+    type: OB11SegmentType.Image;
+    data: {
+        file: string;
+        type?: 'flash';
+        url?: string;
+        cache?: 0 | 1;
+        proxy?: 0 | 1;
+        timeout?: number;
+    };
+}
+/**
+ * - 语音消息段
+ */
+export interface RecordSegment extends Segment {
+    type: OB11SegmentType.Record;
+    data: {
+        file: string;
+        magic?: 0 | 1;
+        url?: string;
+        cache?: 0 | 1;
+        proxy?: 0 | 1;
+        timeout?: number;
+    };
+}
+/**
+ * - 短视频消息段
+ */
+export interface VideoSegment extends Segment {
+    type: OB11SegmentType.Video;
+    data: {
+        file: string;
+        url?: string;
+        cache?: 0 | 1;
+        proxy?: 0 | 1;
+        timeout?: number;
+    };
+}
+/**
+ * - @某人消息段
+ */
+export interface AtSegment extends Segment {
+    type: OB11SegmentType.At;
+    data: {
+        qq: string | 'all';
+    };
+}
+/**
+ * - 猜拳魔法表情消息段
+ */
+export interface RpsSegment extends Segment {
+    type: OB11SegmentType.Rps;
+    data: {};
+}
+/**
+ * - 掷骰子魔法表情消息段
+ */
+export interface DiceSegment extends Segment {
+    type: OB11SegmentType.Dice;
+    data: {};
+}
+/**
+ * - 窗口抖动（戳一戳）消息段
+ */
+export interface ShakeSegment extends Segment {
+    type: OB11SegmentType.Shake;
+    data: {};
+}
+/**
+ * - 戳一戳消息段
+ */
+export interface PokeSegment extends Segment {
+    type: OB11SegmentType.Poke;
+    data: {
+        type: string;
+        id: string;
+        name?: string;
+    };
+}
+/**
+ * - 匿名发消息消息段
+ */
+export interface AnonymousSegment extends Segment {
+    type: OB11SegmentType.Anonymous;
+    data: {
+        ignore?: 0 | 1;
+    };
+}
+/**
+ * - 链接分享消息段
+ */
+export interface ShareSegment extends Segment {
+    type: OB11SegmentType.Share;
+    data: {
+        url: string;
+        title: string;
+        content?: string;
+        image?: string;
+    };
+}
+/**
+ * - 推荐好友/群消息段
+ */
+export interface ContactSegment extends Segment {
+    type: OB11SegmentType.Contact;
+    data: {
+        type: 'qq' | 'group';
+        id: string;
+    };
+}
+/**
+ * - 位置消息段
+ */
+export interface LocationSegment extends Segment {
+    type: OB11SegmentType.Location;
+    data: {
+        lat: string;
+        lon: string;
+        title?: string;
+        content?: string;
+    };
+}
+/**
+ * - 音乐分享消息段
+ */
+export interface MusicSegment extends Segment {
+    type: OB11SegmentType.Music;
+    data: {
+        type: 'qq' | '163' | 'xm';
+        id: string;
+    };
+}
+/**
+ * - 音乐自定义分享消息段
+ */
+export interface CustomMusicSegment extends Segment {
+    type: OB11SegmentType.MusicCustom;
+    data: {
+        type: 'custom';
+        url: string;
+        audio: string;
+        title: string;
+        content?: string;
+        image?: string;
+    };
+}
+/**
+ * - 回复消息段
+ */
+export interface ReplySegment extends Segment {
+    type: OB11SegmentType.Reply;
+    data: {
+        id: string;
+    };
+}
+export interface FileSegment extends Segment {
+    type: OB11SegmentType.File;
+    data: {
+        file: string;
+    };
+}
+/**
+ * - 合并转发消息段
+ */
+export interface ForwardSegment extends Segment {
+    type: OB11SegmentType.Forward;
+    data: {
+        id: string;
+    };
+}
+/**
+ * - 合并转发节点消息段
+ */
+export interface NodeSegment extends Segment {
+    type: OB11SegmentType.Node;
+    data: {
+        id: string;
+    };
+}
+/**
+ * - XML消息段
+ */
+export interface XmlSegment extends Segment {
+    type: OB11SegmentType.Xml;
+    data: {
+        data: string;
+    };
+}
+/**
+ * - JSON消息段
+ */
+export interface JsonSegment extends Segment {
+    type: OB11SegmentType.Json;
+    data: {
+        data: string;
+    };
+}
+/**
+ * - OneBot11消息段
+ */
+export type OB11SegmentBase = TextSegment | FaceSegment | ImageSegment | RecordSegment | VideoSegment | AtSegment | RpsSegment | DiceSegment | ShakeSegment | PokeSegment | AnonymousSegment | ShareSegment | ContactSegment | LocationSegment | MusicSegment | CustomMusicSegment | ReplySegment | ForwardSegment | NodeSegment | XmlSegment | JsonSegment;
+/**
+ * - 合并转发自定义节点消息段
+ */
+export interface CustomNodeSegment extends Segment {
+    type: OB11SegmentType.NodeCustom;
+    data: {
+        user_id: string;
+        nickname: string;
+        content: OB11SegmentBase[];
+    };
+}
+/**
+ * - OneBot11消息段
+ */
+export type OB11Segment = OB11SegmentBase | CustomNodeSegment;

package/lib/types/onebot11/segment.js

@@ -0,0 +1,30 @@
+/* eslint-disable no-unused-vars */
+/**
+ * - OneBot11消息类型枚举
+ */
+export var OB11SegmentType;
+(function (OB11SegmentType) {
+    OB11SegmentType["Text"] = "text";
+    OB11SegmentType["Face"] = "face";
+    OB11SegmentType["Image"] = "image";
+    OB11SegmentType["Record"] = "record";
+    OB11SegmentType["Video"] = "video";
+    OB11SegmentType["At"] = "at";
+    OB11SegmentType["Rps"] = "rps";
+    OB11SegmentType["Dice"] = "dice";
+    OB11SegmentType["Shake"] = "shake";
+    OB11SegmentType["Poke"] = "poke";
+    OB11SegmentType["Anonymous"] = "anonymous";
+    OB11SegmentType["Share"] = "share";
+    OB11SegmentType["Contact"] = "contact";
+    OB11SegmentType["Location"] = "location";
+    OB11SegmentType["Music"] = "music";
+    OB11SegmentType["MusicCustom"] = "music_custom";
+    OB11SegmentType["Reply"] = "reply";
+    OB11SegmentType["Forward"] = "forward";
+    OB11SegmentType["Node"] = "node";
+    OB11SegmentType["NodeCustom"] = "node_custom";
+    OB11SegmentType["Xml"] = "xml";
+    OB11SegmentType["Json"] = "json";
+    OB11SegmentType["File"] = "file";
+})(OB11SegmentType || (OB11SegmentType = {}));

package/lib/types/onebot11/sender.d.ts

@@ -0,0 +1,59 @@
+export type OB11Sex = 'male' | 'female' | 'unknown';
+export type OB11Role = 'owner' | 'admin' | 'member' | '';
+export interface PrivateSender {
+    /**
+     * - 发送者 QQ 号
+     */
+    user_id: string;
+    /**
+     * - 昵称 不存在则为空字符串
+     */
+    nickname: string;
+    /**
+     * - 性别
+     */
+    sex?: OB11Sex;
+    /**
+     * - 年龄
+     */
+    age?: number;
+}
+export interface GroupSender {
+    /**
+     * - 发送者 QQ 号
+     */
+    user_id: string;
+    /**
+     * - 昵称 不存在则为空字符串
+     */
+    nickname: string;
+    /**
+     * - 性别
+     */
+    sex?: OB11Sex;
+    /**
+     * - 年龄
+     */
+    age?: number;
+    /**
+     * - 群名片/备注
+     */
+    card?: string;
+    /**
+     * - 地区
+     */
+    area?: string;
+    /**
+     * - 成员等级
+     */
+    level?: string;
+    /**
+     * - 角色 不存在则为空字符串
+     */
+    role: OB11Role;
+    /**
+     * - 专属头衔
+     */
+    title?: string;
+}
+export type ob11Sender = PrivateSender | GroupSender;

package/lib/types/onebot11/sender.js

@@ -0,0 +1 @@
+export {};

package/lib/types/plugin.d.ts

@@ -1,8 +1,7 @@
 import schedule from 'node-schedule';
 import { Plugin } from '../core/index.js';
-import { Reply, replyCallback, replyForward } from './reply.js';
-import { EventType, Event, Permission, SubEvent, KarinMessageEvent, KarinNoticeEvent, KarinRequestEvent } from './event.js';
-import { KarinMessage } from '../event/index.js';
+import { Reply, replyCallback, replyForward } from './event/reply.js';
+import { KarinNoticeType, KarinRequestType, AllListenEvent, KarinEventTypes, KarinMessageType, PermissionType } from './event/index.js';
 /**
  * - 插件根目录名称
  * - 例如: karin-plugin-example
@@ -42,13 +41,13 @@ export interface PluginRule {
      */
     fnc: string | Function;
     /**
-     * - 子事件
+     * - 监听子事件
      */
-    event?: Event | `${Event}.${SubEvent}`;
+    event?: AllListenEvent;
     /**
      * 权限
      */
-    permission?: Permission;
+    permission?: PermissionType;
     /**
      * - 打印日志 默认为true
      */
@@ -146,7 +145,7 @@ export interface PluginType {
     /**
      * - 监听事件 默认为message
      */
-    event: Event | `${Event}.${SubEvent}`;
+    event: AllListenEvent;
     /**
      * - 优先级 默认为10000
      */
@@ -179,7 +178,7 @@ export interface PluginType {
      * - 上报事件
      * - 根据上报中的event字段来获取e的事件类型
      */
-    e: KarinMessageEvent | KarinNoticeEvent | KarinRequestEvent;
+    e: KarinEventTypes;
     init?: () => Promise<any>;
     /**
      * - 快速回复
@@ -220,7 +219,7 @@ export interface PluginType {
     /**
      * - accept标准方法 给通知、请求事件使用
      */
-    accept?(e: EventType<this>): Promise<void>;
+    accept?(e: KarinNoticeType | KarinRequestType): Promise<void>;
 }
 /**
  * - Apps
@@ -246,7 +245,7 @@ export interface PluginApps {
     /**
      * - 插件事件
      */
-    event: Event | `${Event}.${SubEvent}`;
+    event: AllListenEvent;
     /**
      * - 插件优先级
      * @default 10000
@@ -276,4 +275,4 @@ export interface PluginApps {
 /**
  * 未实例化的插件
  */
-export type NewPlugin = new (e?: KarinMessage) => Plugin;
+export type NewMessagePlugin = new (e?: KarinMessageType) => Plugin;

package/lib/utils/button.d.ts

@@ -1,2 +1,2 @@
-import { KarinMessageEvent } from '../types/index.js';
-export declare const button: (e: KarinMessageEvent) => Promise<any>;
+import { KarinMessageType } from '../types/index.js';
+export declare const button: (e: KarinMessageType) => Promise<any>;

package/lib/utils/common.d.ts

@@ -1,7 +1,7 @@
 import { AxiosRequestConfig } from 'axios';
 import { Readable } from 'stream';
 import { fs } from '../modules.js';
-import { dirName, KarinElement, KarinNodeElement } from '../types/index.js';
+import { dirName, KarinElement, NodeElement } from '../types/index.js';
 /**
  * 常用方法
  */
@@ -134,7 +134,7 @@ export declare const common: {
      * @param fakeUin 用户id
      * @param fakeNick 用户昵称
      */
-    makeForward(elements: KarinElement | KarinElement[], fakeUin: string, fakeNick: string): Array<KarinNodeElement>;
+    makeForward(elements: KarinElement | KarinElement[], fakeUin: string, fakeNick: string): Array<NodeElement>;
     /**
      * 获取所有插件列表
      * @param isDir - 返回绝对路径

package/lib/utils/config.js

@@ -221,8 +221,8 @@ export const config = new (class Cfg {
       return res
     }
     /** 取配置 */
-    const Config = this.getYaml('config', 'group')
-    const defCfg = this.getYaml('defSet', 'group')
+    const Config = this.getYaml('config', 'group', true)
+    const defCfg = this.getYaml('defSet', 'group', false)
     const data = { Config, defCfg }
     /** 缓存 */
     res = this.change.set(key, data)
@@ -252,7 +252,7 @@ export const config = new (class Cfg {
   async watch (type, name, file) {
     const key = `change.${name}`
     /** 已经监听过了 */
-    const res = this.change.get(key)
+    const res = this.watcher.get(key)
     if (res) { return true }
     /** 监听文件 */
     const watcher = chokidar.watch(file)

package/lib/utils/handler.d.ts

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

package/lib/utils/handler.js

@@ -85,7 +85,7 @@ export const handler = new (class EventHandler {
           res = await v.fnc(args, reject)
         } else {
           const cla = new info.file.Fnc()
-          cla.e = args.e
+          if (args.e) { cla.e = args.e }
           res = await cla[v.fnc](args, reject)
         }
         if (done) {

package/lib/utils/init.d.ts

@@ -22,7 +22,7 @@ export declare class KarinInit {
     /**
      * 从npm包内复制默认配置出来
      */
-    copyFile(): Promise<void>;
+    copyFile(): void;
     /**
      * 修改package.json以支持运行
      */

package/lib/utils/init.js

@@ -59,7 +59,7 @@ export class KarinInit {
   /**
      * 从npm包内复制默认配置出来
      */
-  async copyFile () {
+  copyFile () {
     /** 配置 */
     const list = ['config/defSet', 'config/view']
     list.forEach(dir => {
@@ -67,6 +67,7 @@ export class KarinInit {
       const projDir = path.join(process.cwd(), dir)
       /** 清空projDir目录下的文件 保留目录 */
       if (fs.existsSync(projDir)) { fs.rmdirSync(projDir, { recursive: true }) }
+      this.mkdir(projDir)
       /** 读取pkgDir目录下的所有文件 复制到projDir下 */
       const files = fs.readdirSync(pkgDir).filter(file => file.endsWith('.yaml'))
       files.forEach(file => {

package/lib/utils/segment.d.ts

@@ -1,4 +1,4 @@
-import { TextElement, AtElement, ImageElement, FaceElement, BubbleFaceElement, ReplyElement, VoiceElement, VideoElement, BasketballElement, DiceElement, RpsElement, PokeElement, MusicElement, WeatherElement, LocationElement, ShareElement, GiftElement, MarketFaceElement, ForwardElement, ContactElement, JsonElement, XmlElement, FileElement, ButtonElement, CustomMusicElemen, TemplateElement, ContentElement, KarinNodeElement, KarinElement, LongMsgElement } from '../types/index.js';
+import { TextElement, AtElement, ImageElement, FaceElement, BubbleFaceElement, ReplyElement, VoiceElement, VideoElement, BasketballElement, DiceElement, RpsElement, PokeElement, MusicElement, WeatherElement, LocationElement, ShareElement, GiftElement, MarketFaceElement, ForwardElement, ContactElement, JsonElement, XmlElement, FileElement, ButtonElement, CustomMusicElemen, TemplateElement, ContentElement, NodeElement, KarinElement, LongMsgElement } from '../types/index.js';
 export declare const segment: {
     /**
      * 纯文本
@@ -275,5 +275,5 @@ export declare const segment: {
      * @param nickname - 用户昵称
      * @param content - 节点内容
      */
-    node(user_id: string, nickname: string, content: KarinElement | Array<KarinElement>): KarinNodeElement;
+    node(user_id: string, nickname: string, content: KarinElement | Array<KarinElement>): NodeElement;
 };

package/package.json

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