node-karin 0.12.13 → 0.12.15

package/lib/index.js

@@ -1,3 +1,8 @@
+import yaml from 'yaml';
+import axios from 'axios';
+import moment from 'moment';
+import lodash from 'lodash';
+import express from 'express';
 export * from './core/index.js';
 export * from './event/index.js';
 export * from './db/index.js';
@@ -6,3 +11,4 @@ export * from './utils/index.js';
 export * from './types/index.js';
 export * from './adapter/index.js';
 export { karin as default } from './core/index.js';
+export { axios, moment, lodash, express, yaml };

package/lib/modules.d.ts

@@ -11,5 +11,5 @@ import { Level as level } from 'level';
 import schedule from 'node-schedule';
 import yaml from 'yaml';
 import log4js from 'log4js';
-import art_template from 'art-template';
-export { fs, ws, path, axios, lodash, moment, express, chalk, chokidar, level, schedule, yaml, log4js, art_template, };
+import artTemplate from 'art-template';
+export { fs, ws, path, axios, lodash, moment, express, chalk, chokidar, level, schedule, yaml, log4js, artTemplate as art_template, };

package/lib/modules.js

@@ -1,3 +1,4 @@
+/* eslint-disable camelcase */
 import fs from 'fs';
 import path from 'path';
 import ws from 'ws';
@@ -11,5 +12,5 @@ import { Level as level } from 'level';
 import schedule from 'node-schedule';
 import yaml from 'yaml';
 import log4js from 'log4js';
-import art_template from 'art-template';
-export { fs, ws, path, axios, lodash, moment, express, chalk, chokidar, level, schedule, yaml, log4js, art_template, };
+import artTemplate from 'art-template';
+export { fs, ws, path, axios, lodash, moment, express, chalk, chokidar, level, schedule, yaml, log4js, artTemplate as art_template, };

package/lib/types/adapter/accept.d.ts

@@ -0,0 +1,24 @@
+import { KarinNoticeType, KarinRequestType, NoticeEvent, NoticeSubType, RequestEvent, RequestSubType } from '../event/index.js';
+export interface AcceptDict {
+    ['request']: KarinRequestType;
+    ['request.private_apply']: RequestEvent<RequestSubType.PrivateApply>;
+    ['request.group_apply']: RequestEvent<RequestSubType.GroupApply>;
+    ['request.invited_group']: RequestEvent<RequestSubType.InvitedGroup>;
+    ['notice']: KarinNoticeType;
+    ['notice.private_poke']: NoticeEvent<NoticeSubType.PrivatePoke>;
+    ['notice.private_recall']: NoticeEvent<NoticeSubType.PrivateRecall>;
+    ['notice.private_file_uploaded']: NoticeEvent<NoticeSubType.PrivateFileUploaded>;
+    ['notice.group_poke']: NoticeEvent<NoticeSubType.GroupPoke>;
+    ['notice.group_recall']: NoticeEvent<NoticeSubType.GroupRecall>;
+    ['notice.group_file_uploaded']: NoticeEvent<NoticeSubType.GroupFileUploaded>;
+    ['notice.group_card_changed']: NoticeEvent<NoticeSubType.GroupCardChanged>;
+    ['notice.group_member_unique_title_changed']: NoticeEvent<NoticeSubType.GroupMemberUniqueTitleChanged>;
+    ['notice.group_essence_changed']: NoticeEvent<NoticeSubType.GroupEssenceChanged>;
+    ['notice.group_member_increase']: NoticeEvent<NoticeSubType.GroupMemberIncrease>;
+    ['notice.group_member_decrease']: NoticeEvent<NoticeSubType.GroupMemberDecrease>;
+    ['notice.group_admin_changed']: NoticeEvent<NoticeSubType.GroupAdminChanged>;
+    ['notice.group_sign_in']: NoticeEvent<NoticeSubType.GroupSignIn>;
+    ['notice.group_member_ban']: NoticeEvent<NoticeSubType.GroupMemberBan>;
+    ['notice.group_whole_ban']: NoticeEvent<NoticeSubType.GroupWholeBan>;
+    ['notice.group_message_reaction']: NoticeEvent<NoticeSubType.GroupMessageReaction>;
+}

package/lib/types/adapter/accept.js

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

package/lib/types/adapter/api.d.ts

@@ -1,129 +1,67 @@
 import { Contact, KarinElement, Role, Sender } from '../index.js';
-/**
- * - 基本消息结构
- */
+/** 基本消息结构 */
 export interface PushMessageBody {
-    /**
-     * - 消息发送时间
-     */
+    /** 消息发送时间 */
     time: number;
-    /**
-     * - 消息ID
-     */
+    /** 消息ID */
     message_id: string;
-    /**
-     * - 消息序列号
-     */
+    /** 消息序列号 */
     message_seq: number;
-    /**
-     * - 消息来源
-     */
+    /** 消息来源 */
     contact: Contact;
-    /**
-     * - 消息发送者
-     */
+    /** 消息发送者 */
     sender: Sender;
-    /**
-     * - 消息元素
-     */
+    /** 消息元素 */
     elements: Array<KarinElement>;
 }
-/**
- * - 精华消息返回的结构
- */
+/** 精华消息返回的结构 */
 export interface EssenceMessageBody {
-    /**
-     * - 群ID
-     */
+    /** 群ID */
     group_id: string;
-    /**
-     * - 发送者uid
-     */
+    /** 发送者uid */
     sender_uid: string;
-    /**
-     * - 发送者uin
-     */
+    /** 发送者uin */
     sender_uin: string;
-    /**
-     * - 发送者昵称
-     */
+    /** 发送者昵称 */
     sender_nick: string;
-    /**
-     * - 操作者uid
-     */
+    /** 操作者uid */
     operator_uid: string;
-    /**
-     * - 操作者uin
-     */
+    /** 操作者uin */
     operator_uin: string;
-    /**
-     * - 操作者昵称
-     */
+    /** 操作者昵称 */
     operator_nick: string;
-    /**
-     * - 操作时间
-     */
+    /** 操作时间 */
     operation_time: number;
-    /**
-     * - 消息时间
-     */
+    /** 消息时间 */
     message_time: number;
-    /**
-     * - 消息ID
-     */
+    /** 消息ID */
     message_id: string;
-    /**
-     * - 消息序列号
-     */
+    /** 消息序列号 */
     message_seq: number;
-    /**
-     * - 被设置的精华消息元素文本
-     */
+    /** 被设置的精华消息元素文本 */
     json_elements: string;
 }
-/**
- * - QQ好友信息
- */
+/** QQ好友信息 */
 export interface FriendInfo {
-    /**
-     * - 用户UID
-     */
+    /** 用户UID */
     uid: string;
-    /**
-     * - 用户UIN
-     */
+    /** 用户UIN */
     uin: string;
-    /**
-     * - qid
-     */
+    /** qid */
     qid: string;
-    /**
-     * - 名称
-     */
+    /** 名称 */
     nick: string;
-    /**
-     * - 备注
-     */
+    /** 备注 */
     remark?: string;
-    /**
-     * - 用户等级
-     */
+    /** 用户等级 */
     level?: number;
-    /**
-     * - 生日
-     */
+    /** 生日 */
     birthday?: string;
-    /**
-     * - 登录天数
-     */
+    /** 登录天数 */
     login_day?: number;
-    /**
-     * - 点赞数
-     */
+    /** 点赞数 */
     vote_cnt?: number;
-    /**
-     * - 学校是否已核实
-     */
+    /** 学校是否已核实 */
     is_school_verified?: boolean;
     /**
      * - 年龄
@@ -158,242 +96,128 @@ export interface FriendInfo {
         voted?: boolean;
     };
 }
-/**
- * - QQ群信息
- */
+/** QQ群信息 */
 export interface GroupInfo {
-    /**
-     * - 群ID
-     */
+    /** 群ID */
     group_id: string;
-    /**
-     * - 群名称
-     */
+    /** 群名称 */
     group_name: string;
-    /**
-     * - 群备注
-     */
+    /** 群备注 */
     group_remark?: string;
-    /**
-     * - 群主UID
-     */
+    /** 群主UID */
     owner: string;
-    /**
-     * - 群管理员UID列表
-     */
+    /** 群管理员UID列表 */
     admins: Array<string>;
-    /**
-     * - 最大成员数
-     */
+    /** 最大成员数 */
     max_member_count: number;
-    /**
-     * - 当前成员数
-     */
+    /** 当前成员数 */
     member_count: number;
-    /**
-     * - 群UIN
-     */
+    /** 群UIN */
     group_uin?: string;
-    /**
-     * - 群描述
-     */
+    /** 群描述 */
     group_desc?: string;
 }
-/**
- * - 群成员信息
- */
+/** 群成员信息 */
 export interface GroupMemberInfo {
-    /**
-     * - 用户UID
-     */
+    /** 用户UID */
     uid: string;
-    /**
-     * - 用户UIN
-     */
+    /** 用户UIN */
     uin: string;
-    /**
-     * - 用户角色
-     */
+    /** 用户角色 */
     role: Role;
-    /**
-     * - 用户昵称
-     */
+    /** 用户昵称 */
     nick: string;
-    /**
-     * - 年龄
-     */
+    /** 年龄 */
     age: number;
-    /**
-     * - 群内头衔
-     */
+    /** 群内头衔 */
     unique_title: string;
-    /**
-     * - 群内头衔过期时间
-     */
+    /** 群内头衔过期时间 */
     unique_title_expire_time: number;
-    /**
-     * - 群名片
-     */
+    /** 群名片 */
     card?: string;
-    /**
-     * - 加群时间
-     */
+    /** 加群时间 */
     join_time?: number;
-    /**
-     * - 最后活跃时间
-     */
+    /** 最后活跃时间 */
     last_active_time?: number;
-    /**
-     * - 用户等级
-     */
+    /** 用户等级 */
     level: number;
-    /**
-     * - 禁言时间
-     */
+    /** 禁言时间 */
     shut_up_time: number;
-    /**
-     * - 距离
-     */
+    /** 距离 */
     distance?: number;
-    /**
-     * - 荣誉列表
-     */
+    /** 荣誉列表 */
     honors?: Array<number>;
-    /**
-     * - 是否好友
-     */
+    /** 是否好友 */
     unfriendly?: boolean;
-    /**
-     * - 是否可修改群名片
-     */
+    /** 是否可修改群名片 */
     card_changeable?: boolean;
 }
 /**
  * 群荣誉信息
  */
 export interface GroupHonorInfo {
-    /**
-     * - 荣誉成员uid
-     */
+    /** 荣誉成员uid */
     uid: string;
-    /**
-     * - 荣誉成员uin
-     */
+    /** 荣誉成员uin */
     uin: string;
-    /**
-     * - 荣誉成员昵称
-     */
+    /** 荣誉成员昵称 */
     nick: string;
-    /**
-     * - 荣誉名称
-     */
+    /** 荣誉名称 */
     honor_name: string;
-    /**
-     * - 荣誉图标url
-     */
+    /** 荣誉图标url */
     avatar: string;
-    /**
-     * - 荣誉id
-     */
+    /** 荣誉id */
     id: number;
-    /**
-     * - 荣誉描述
-     */
+    /** 荣誉描述 */
     description: string;
 }
-/**
- * - 群文件信息
- */
+/** 群文件信息 */
 export interface GroupFileInfo {
-    /**
-     * - 文件ID
-     */
+    /** 文件ID */
     file_id: string;
-    /**
-     * - 文件名
-     */
+    /** 文件名 */
     file_name: string;
-    /**
-     * - 文件大小
-     */
+    /** 文件大小 */
     file_size: number;
-    /**
-     * - 上传时间
-     */
+    /** 上传时间 */
     upload_time: number;
-    /**
-     * - 过期时间
-     */
+    /** 过期时间 */
     expire_time: number;
-    /**
-     * - 修改时间
-     */
+    /** 修改时间 */
     modify_time: number;
-    /**
-     * - 下载次数
-     */
+    /** 下载次数 */
     download_times: number;
-    /**
-     * - 上传者UID
-     */
+    /** 上传者UID */
     uploader: string;
-    /**
-     * - 上传者昵称
-     */
+    /** 上传者昵称 */
     uploader_name: string;
-    /**
-     * - SHA1
-     */
+    /** SHA1 */
     sha: string;
-    /**
-     * - SHA3
-     */
+    /** SHA3 */
     sha3: string;
-    /**
-     * - MD5
-     */
+    /** MD5 */
     md5: string;
 }
-/**
- * - 群文件夹信息
- */
+/** 群文件夹信息 */
 export interface GroupFolderInfo {
-    /**
-     * - 文件夹ID
-     */
+    /** 文件夹ID */
     folder_id: string;
-    /**
-     * - 文件夹名
-     */
+    /** 文件夹名 */
     folder_name: string;
-    /**
-     * - 文件数量
-     */
+    /** 文件数量 */
     total_file_count: number;
-    /**
-     * - 创建时间
-     */
+    /** 创建时间 */
     create_time: number;
-    /**
-     * - 创建者UID
-     */
+    /** 创建者UID */
     creator: string;
-    /**
-     * - 创建者昵称
-     */
+    /** 创建者昵称 */
     creator_name: string;
 }
 export interface GetRemainCountAtAllResponse {
-    /**
-     * - 是否允许at全体成员
-     */
+    /** 是否允许at全体成员 */
     access_at_all: boolean;
-    /**
-     * - 全群剩余次数
-     */
+    /** 全群剩余次数 */
     remain_count_for_group: number;
-    /**
-     * - 个人剩余次数
-     */
+    /** 个人剩余次数 */
     remain_count_for_self: number;
 }

package/lib/types/adapter/base.d.ts

@@ -322,7 +322,7 @@ export interface KarinAdapter {
     }>;
     /**
      * 设置好友请求结果
-     * @param request_id - 请求ID
+     * @param request_id - 请求事件ID
      * @param is_approve - 是否同意
      * @param remark - 好友备注 同意时有效
      * @returns 设置结果
@@ -330,7 +330,7 @@ export interface KarinAdapter {
     SetFriendApplyResult(request_id: string, is_approve: boolean, remark?: string): Promise<void | boolean>;
     /**
      * 设置申请加入群请求结果
-     * @param request_id - 请求ID
+     * @param request_id - 请求事件ID
      * @param is_approve - 是否同意
      * @param deny_reason - 拒绝理由 拒绝时有效
      * @returns 此接口标准是无返回值的，karin在此拓展可选返回一个boolean
@@ -338,7 +338,7 @@ export interface KarinAdapter {
     SetGroupApplyResult(request_id: string, is_approve: boolean, deny_reason?: string): Promise<void | boolean>;
     /**
      * 设置邀请加入群请求结果
-     * @param request_id - 请求ID
+     * @param request_id - 请求事件ID
      * @param is_approve - 是否同意
      * @returns 此接口标准是无返回值的，karin在此拓展可选返回一个boolean
      */

package/lib/types/config/config.d.ts

@@ -141,21 +141,13 @@ export interface Config {
      *
      */
     AdapterInput: {
-        /**
-         * - 是否开启input适配器
-         */
+        /** 是否开启input适配器 */
         enable: boolean;
-        /**
-         * - 是否将语音、图片、视频消息转为文件 转为文件后可通过url访问
-         */
+        /** 是否将语音、图片、视频消息转为文件 转为文件后可通过url访问 */
         msgToFile: boolean;
-        /**
-         * - url访问token 如果为 AdapterInput 每次启动后会重新生成
-         */
+        /** url访问token 如果为 AdapterInput 每次启动后会重新生成 */
         token: string;
-        /**
-         * - ip地址
-         */
+        /** ip地址 */
         ip: string;
     };
     /**