node-karin 0.12.13 → 0.12.15

package/lib/types/render/render.d.ts

@@ -3,71 +3,39 @@ import chokidar from 'chokidar';
  * 渲染标准方法传参
  */
 export interface KarinRenderType {
-    /**
-     * - 渲染文件路径或HTTP地址 与vue二选一
-     */
+    /** 渲染文件路径或HTTP地址 与vue二选一 */
     file: string;
-    /**
-     * - vue文件路径 与file二选一
-     */
+    /** vue文件路径 与file二选一 */
     vue?: boolean;
     props?: any;
-    /**
-     * - 模板名称
-     */
+    /** 模板名称 */
     name?: string;
-    /**
-     * - art-template后的文件名
-     */
+    /** art-template后的文件名 */
     fileID?: string;
-    /**
-     * - 传递给模板的数据 template.render(data)
-     */
+    /** 传递给模板的数据 template.render(data) */
     data?: object;
-    /**
-     * - 截图类型 默认'webp'
-     */
+    /** 截图类型 默认'webp' */
     type?: 'png' | 'jpeg' | 'webp';
-    /**
-     * - 截图质量 默认90 1-100
-     */
+    /** 截图质量 默认90 1-100 */
     quality?: number;
-    /**
-     * - 是否隐藏背景 默认false
-     */
+    /** 是否隐藏背景 默认false */
     omitBackground?: boolean;
-    /**
-     * - 设置视窗大小和设备像素比 默认1920*1080、1
-     */
+    /** 设置视窗大小和设备像素比 默认1920*1080、1 */
     setViewport?: {
-        /**
-         * - 视窗宽度
-         */
+        /** 视窗宽度 */
         width?: number;
-        /**
-         * - 视窗高度
-         */
+        /** 视窗高度 */
         height?: number;
-        /**
-         * - 设备像素比
-         */
+        /** 设备像素比 */
         deviceScaleFactor?: number;
     };
-    /**
-     * - 分页截图 传递数字则视为视窗高度 返回数组
-     */
+    /** 分页截图 传递数字则视为视窗高度 返回数组 */
     multiPage?: number | boolean;
-    /**
-     * - 页面goto时的参数
-     */
+    /** 页面goto时的参数 */
     pageGotoParams?: {
-        /**
-         * - 页面加载超时时间
-         */
+        /** 页面加载超时时间 */
         timeout?: number;
-        /**
-         * - 页面加载状态
-         */
+        /** 页面加载状态 */
         waitUntil?: 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2';
         [key: string]: any;
     };

package/lib/utils/common/common.js

@@ -464,8 +464,7 @@ export class Common {
         const hour = Math.floor((time % 86400) / 3600);
         const min = Math.floor((time % 3600) / 60);
         const sec = Math.floor(time % 60);
-        const parts = [day ? `${day}天` : '', hour ? `${hour}小时` : '', min ? `${min}分钟` : '', !day && sec ? `${sec}秒` : ''];
-        return parts.filter(Boolean).join('');
+        return `${day}天${hour}小时${min}分钟${sec}秒`.replace(/0[天时分秒]/g, '');
     }
     /**
      * 构建消息体日志
@@ -558,6 +557,9 @@ export class Common {
                 case 'long_msg':
                     logs.push(`[long_msg: ${val.id}]`);
                     break;
+                case 'pasmsg':
+                    logs.push(`[pasmsg: ${val.id}]`);
+                    break;
                 default:
                     logs.push(`[未知: ${JSON.stringify(val)}]`);
             }

package/lib/utils/config/config.js

@@ -318,7 +318,7 @@ export const config = new (class Cfg {
         await this.#review();
     }
     async #review() {
-        // 应该改成事件监听
+        // todo: 应该改成事件监听
         if (this.review)
             return;
         this.review = true;

package/lib/utils/core/logger.js

@@ -5,9 +5,9 @@ import { config } from '../config/config.js';
 const logsDir = './logs';
 if (!fs.existsSync(logsDir))
     fs.mkdirSync(logsDir);
-const { log_level, log_days_Keep, log4jsCfg } = config.Config;
-const level = log_level || log4jsCfg.level || 'info';
-const daysToKeep = log_days_Keep || log4jsCfg.daysToKeep || 7;
+const { log_level: logLevel, log_days_Keep: logDaysKeep, log4jsCfg } = config.Config;
+const level = logLevel || log4jsCfg.level || 'info';
+const daysToKeep = logDaysKeep || log4jsCfg.daysToKeep || 7;
 const { overall, fragments, maxLogSize } = log4jsCfg;
 const defaultOptions = { appenders: ['console'], level, enableCallStack: process.env.karin_app_mode === 'dev' };
 const options = {

package/lib/utils/core/segment.d.ts

@@ -1,4 +1,4 @@
-import { TextElement, AtElement, ImageElement, FaceElement, BubbleFaceElement, ReplyElement, VideoElement, BasketballElement, DiceElement, RpsElement, PokeElement, MusicElement, WeatherElement, LocationElement, ShareElement, GiftElement, MarketFaceElement, ForwardElement, ContactElement, JsonElement, XmlElement, FileElement, ButtonElement, CustomMusicElemen, TplMarkdownElement, RawMarkdownElement, NodeElement, KarinElement, LongMsgElement, RecordElement, KeyBoardElement, Button, RawElement } from '../../types/index.js';
+import { TextElement, AtElement, ImageElement, FaceElement, BubbleFaceElement, ReplyElement, VideoElement, BasketballElement, DiceElement, RpsElement, PokeElement, MusicElement, WeatherElement, LocationElement, ShareElement, GiftElement, MarketFaceElement, ForwardElement, ContactElement, JsonElement, XmlElement, FileElement, ButtonElement, CustomMusicElemen, TplMarkdownElement, RawMarkdownElement, NodeElement, KarinElement, LongMsgElement, RecordElement, KeyBoardElement, Button, RawElement, PasmsgElement } from '../../types/index.js';
 export declare const segment: {
     /**
      * 纯文本
@@ -18,10 +18,10 @@ export declare const segment: {
     /**
      * 表情
      * @param id - 表情ID
-     * @param is_big - 是否大表情，默认不是
+     * @param isBig - 是否大表情，默认不是
      * @returns {FaceElement} 表情元素
      */
-    face(id: number, is_big?: boolean): FaceElement;
+    face(id: number, isBig?: boolean): FaceElement;
     /**
      * 弹射表情
      * @param id - 表情ID
@@ -31,10 +31,10 @@ export declare const segment: {
     bubble_face(id: number, count?: number): BubbleFaceElement;
     /**
      * 引用回复
-     * @param message_id - 消息ID
+     * @param messageId - 消息ID
      * @returns {ReplyElement} 引用回复元素
      */
-    reply(message_id: string): ReplyElement;
+    reply(messageId: string): ReplyElement;
     /**
      * 图片
      * - 一般情况提供一个file参数即可，其他参数一般为收到的消息中的参数
@@ -43,29 +43,17 @@ export declare const segment: {
      * @returns {ImageElement} 图片元素
      */
     image(file: string, options?: {
-        /**
-         * - 图片类型，show: 展示图片，flash: 闪照，original: 原图
-         */
+        /** 图片类型，show: 展示图片，flash: 闪照，original: 原图 */
         file_type?: "show" | "flash" | "original";
-        /**
-         * - 图片名称
-         */
+        /** 图片名称 */
         name?: string;
-        /**
-         * - 图片MD5
-         */
+        /** 图片MD5 */
         md5?: string;
-        /**
-         * - 图片子类型
-         */
+        /** 图片子类型 */
         sub_type?: string;
-        /**
-         * - 图片宽度
-         */
+        /** 图片宽度 */
         width?: number;
-        /**
-         * - 图片高度
-         */
+        /** 图片高度 */
         height?: number;
     }): ImageElement;
     /**
@@ -113,11 +101,11 @@ export declare const segment: {
     /**
      * 戳一戳
      * @param id - 戳一戳ID
-     * @param poke_type - 戳一戳类型
+     * @param pokeType - 戳一戳类型
      * @param strength - 戳一戳强度(1-5 默认1)
      * @returns {PokeElement} 戳一戳元素
      */
-    poke(id: number, poke_type: number, strength?: number): PokeElement;
+    poke(id: number, pokeType: number, strength?: number): PokeElement;
     /**
      * 自定义音乐
      * @param url - 跳转链接
@@ -175,13 +163,13 @@ export declare const segment: {
     marketFace(id: string): MarketFaceElement;
     /**
      * 转发
-     * @param res_id - 资源ID
+     * @param resId - 资源ID
      * @param uniseq - 序列号(可能不对?)
      * @param summary - 摘要
      * @param description - 描述
      * @returns {ForwardElement} 转发元素
      */
-    forward(res_id: string, uniseq?: string, summary?: string, description?: string): ForwardElement;
+    forward(resId: string, uniseq?: string, summary?: string, description?: string): ForwardElement;
     /**
      * 分享名片
      * @param scene - 分享类型
@@ -205,37 +193,21 @@ export declare const segment: {
      * 文件
      */
     file(options: {
-        /**
-         * - 文件URL
-         */
+        /** 文件URL */
         url: string;
-        /**
-         * - 文件名称
-         */
+        /** 文件名称 */
         name?: string;
-        /**
-         * - 文件大小
-         */
+        /** 文件大小 */
         size?: number;
-        /**
-         * - 文件过期时间
-         */
+        /** 文件过期时间 */
         expire_time?: number;
-        /**
-         * - 文件ID
-         */
+        /** 文件ID */
         id?: string;
-        /**
-         * - 未知
-         */
+        /** 未知 */
         biz?: number;
-        /**
-         * - 文件子ID
-         */
+        /** 文件子ID */
         sub_id?: string;
-        /**
-         * - 文件MD5
-         */
+        /** 文件MD5 */
         md5?: string;
     }): FileElement;
     /**
@@ -251,10 +223,10 @@ export declare const segment: {
     markdown(content: RawMarkdownElement["content"], config?: RawMarkdownElement["config"]): RawMarkdownElement;
     /**
      * 构建模板Markdown
-     * @param custom_template_id - 模板ID
+     * @param customTemplateId - 模板ID
      * @param params - 模板markdown参数
      */
-    markdown_tpl(custom_template_id: TplMarkdownElement["custom_template_id"], params: TplMarkdownElement["params"]): TplMarkdownElement;
+    markdown_tpl(customTemplateId: TplMarkdownElement["custom_template_id"], params: TplMarkdownElement["params"]): TplMarkdownElement;
     /**
      * 按钮 构建单行单个(obj)、多个按钮(obj[])
      * @param data - 按钮数据
@@ -268,11 +240,11 @@ export declare const segment: {
     keyboard(data: Array<Button> | Array<Array<Button>>): KeyBoardElement;
     /**
      * 转发自定义节点
-     * @param user_id - 用户ID
+     * @param userId - 用户ID
      * @param nickname - 用户昵称
      * @param content - 节点内容
      */
-    node(user_id: string, nickname: string, content: KarinElement | Array<KarinElement>): NodeElement;
+    node(userId: string, nickname: string, content: KarinElement | Array<KarinElement>): NodeElement;
     /**
      * 发送原生格式给予适配器处理
      * @param data - 原生数据
@@ -281,8 +253,5 @@ export declare const segment: {
     /**
      * 回复被动消息
      */
-    passive_reply(id: string): {
-        type: "passive_reply";
-        id: string;
-    };
+    pasmsg(id: string): PasmsgElement;
 };

package/lib/utils/core/segment.js

@@ -29,14 +29,14 @@ export const segment = new (class Segment {
     /**
      * 表情
      * @param id - 表情ID
-     * @param is_big - 是否大表情，默认不是
+     * @param isBig - 是否大表情，默认不是
      * @returns {FaceElement} 表情元素
      */
-    face(id, is_big = false) {
+    face(id, isBig = false) {
         return {
             type: 'face',
             id: Number(id),
-            is_big,
+            is_big: isBig,
         };
     }
     /**
@@ -54,13 +54,13 @@ export const segment = new (class Segment {
     }
     /**
      * 引用回复
-     * @param message_id - 消息ID
+     * @param messageId - 消息ID
      * @returns {ReplyElement} 引用回复元素
      */
-    reply(message_id) {
+    reply(messageId) {
         return {
             type: 'reply',
-            message_id: message_id + '',
+            message_id: messageId + '',
         };
     }
     /**
@@ -71,19 +71,19 @@ export const segment = new (class Segment {
      * @returns {ImageElement} 图片元素
      */
     image(file, options = {}) {
-        const file_type = options.file_type || 'original';
+        const fileType = options.file_type || 'original';
         const name = options.name || '';
         const md5 = options.md5 || '';
-        const sub_type = options.sub_type || '';
+        const subType = options.sub_type || '';
         const width = options.width || 0;
         const height = options.height || 0;
         return {
             type: 'image',
             file,
-            file_type,
+            file_type: fileType,
             name,
             md5,
-            sub_type,
+            sub_type: subType,
             width,
             height,
         };
@@ -171,15 +171,15 @@ export const segment = new (class Segment {
     /**
      * 戳一戳
      * @param id - 戳一戳ID
-     * @param poke_type - 戳一戳类型
+     * @param pokeType - 戳一戳类型
      * @param strength - 戳一戳强度(1-5 默认1)
      * @returns {PokeElement} 戳一戳元素
      */
-    poke(id, poke_type, strength = 1) {
+    poke(id, pokeType, strength = 1) {
         return {
             type: 'poke',
             id,
-            poke_type,
+            poke_type: pokeType,
             strength,
         };
     }
@@ -290,16 +290,16 @@ export const segment = new (class Segment {
     }
     /**
      * 转发
-     * @param res_id - 资源ID
+     * @param resId - 资源ID
      * @param uniseq - 序列号(可能不对?)
      * @param summary - 摘要
      * @param description - 描述
      * @returns {ForwardElement} 转发元素
      */
-    forward(res_id, uniseq, summary, description) {
+    forward(resId, uniseq, summary, description) {
         return {
             type: 'forward',
-            res_id,
+            res_id: resId,
             uniseq: uniseq || '',
             summary: summary || '',
             description: description || '',
@@ -381,21 +381,17 @@ export const segment = new (class Segment {
     }
     /**
      * 构建模板Markdown
-     * @param custom_template_id - 模板ID
+     * @param customTemplateId - 模板ID
      * @param params - 模板markdown参数
      */
     markdown_tpl(
-    /**
-     * - 模板ID
-     */
-    custom_template_id, 
-    /**
-     * - 模板markdown参数
-     */
+    /** 模板ID */
+    customTemplateId, 
+    /** 模板markdown参数 */
     params) {
         return {
             type: 'markdown_tpl',
-            custom_template_id,
+            custom_template_id: customTemplateId,
             params,
         };
     }
@@ -436,14 +432,14 @@ export const segment = new (class Segment {
     }
     /**
      * 转发自定义节点
-     * @param user_id - 用户ID
+     * @param userId - 用户ID
      * @param nickname - 用户昵称
      * @param content - 节点内容
      */
-    node(user_id, nickname, content) {
+    node(userId, nickname, content) {
         return {
             type: 'node',
-            user_id,
+            user_id: userId,
             nickname,
             content,
         };
@@ -461,9 +457,9 @@ export const segment = new (class Segment {
     /**
      * 回复被动消息
      */
-    passive_reply(id) {
+    pasmsg(id) {
         return {
-            type: 'passive_reply',
+            type: 'pasmsg',
             id,
         };
     }

package/lib/utils/tools/restart.d.ts

@@ -1,12 +1,12 @@
 import { Contact } from '../../types/index.js';
 /**
  * 重启Bot
- * @param self_id - 机器人的id 传e.self_id
+ * @param selfId - 机器人的id 传e.self_id
  * @param contact - 事件联系人信息 也就是从哪来的这条消息 传e.contact即可
- * @param message_id - 消息id 传e.message_id
+ * @param messageId - 消息id 传e.message_id
  * @param isFront - 是否为前台重启 默认是
  */
-export declare const restart: (self_id: string, contact: Contact, message_id: string, isFront?: boolean) => Promise<{
+export declare const restart: (selfId: string, contact: Contact, messageId: string, isFront?: boolean) => Promise<{
     status: string;
     data: string;
 } | {

package/lib/utils/tools/restart.js

@@ -3,16 +3,16 @@ import { level } from '../../db/index.js';
 import { config } from '../config/config.js';
 /**
  * 重启Bot
- * @param self_id - 机器人的id 传e.self_id
+ * @param selfId - 机器人的id 传e.self_id
  * @param contact - 事件联系人信息 也就是从哪来的这条消息 传e.contact即可
- * @param message_id - 消息id 传e.message_id
+ * @param messageId - 消息id 传e.message_id
  * @param isFront - 是否为前台重启 默认是
  */
-export const restart = async (self_id, contact, message_id, isFront = true) => {
+export const restart = async (selfId, contact, messageId, isFront = true) => {
     const options = {
-        id: self_id,
+        id: selfId,
         contact,
-        message_id,
+        message_id: messageId,
         time: Date.now(),
     };
     const key = `karin:restart:${options.id}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-karin",
-  "version": "0.12.13",
+  "version": "0.12.15",
   "private": false,
   "description": "基于 Kritor 进行开发的nodejs机器人框架",
   "homepage": "https://github.com/KarinJS/Karin",
@@ -124,7 +124,6 @@
     "fix": "eslint lib/**/*.js --fix",
     "fix:all": "eslint lib/**/*.js --fix && eslint lib/**/*.d.ts --fix",
     "init": "node lib/cli/init.js",
-    "postinstall": "npm run init",
     "pub": "npm publish --access public",
     "sort": "npx sort-package-json && sort-json tsconfig.json",
     "start": "node lib/cli/start.js start"