node-karin 0.8.6 → 0.8.7

package/lib/core/karin.d.ts

@@ -119,7 +119,7 @@ export declare class Karin {
      * - 渲染
      * @param options - 渲染参数
      */
-    render(options: KarinRenderType): Promise<string | string[]>;
+    render(options: KarinRenderType): Promise<string>;
     /**
      * - 上下文
      * @param e - 消息事件

package/lib/event/message.handler.js

@@ -11,7 +11,7 @@ export class MessageHandler extends EventHandler {
   /**
      * - 是否打印群消息日志
      */
-  GroupMsgPrint = false
+  GroupMsgPrint = true
   constructor (e) {
     super(e)
     this.e = e

package/lib/render/app.d.ts

@@ -31,13 +31,19 @@ declare class Renderers {
     /**
      * 调用标准渲染器
      */
-    render(options: KarinRenderType, id?: string): Promise<string | string[]>;
+    render<T extends KarinRenderType>(options: T, id?: string): Promise<import("../types/index.js").RenderResult<T>>;
     /**
      * 快速渲染
      * @param data html路径、http地址
      * @returns 返回图片base64或数组
      */
-    renderHtml(data: string): Promise<string | string[]>;
+    renderHtml(data: string): Promise<string>;
+    /**
+     * 快速分片渲染
+     * @param data html路径、http地址
+     * @param multiPage 分片高度 自动计算传true
+     */
+    renderMultiHtml(data: string, multiPage: number | true): Promise<Array<string>>;
 }
 /**
  * 渲染器管理器

package/lib/render/app.js

@@ -69,7 +69,13 @@ class Renderers {
      */
   async render (options, id) {
     const res = this.App(id)
-    return res.render(options)
+    if (typeof options.multiPage === 'number' || options.multiPage === true) {
+      const result = await res.render(options)
+      return result
+    } else {
+      const result = await res.render(options)
+      return result
+    }
   }
 
   /**
@@ -78,10 +84,25 @@ class Renderers {
      * @returns 返回图片base64或数组
      */
   async renderHtml (data) {
-    const app = this.App()
-    return app.render({
+    return this.render({
+      file: data,
+      name: 'render',
+      pageGotoParams: {
+        waitUntil: 'networkidle2',
+      },
+    })
+  }
+
+  /**
+     * 快速分片渲染
+     * @param data html路径、http地址
+     * @param multiPage 分片高度 自动计算传true
+     */
+  async renderMultiHtml (data, multiPage) {
+    return await this.render({
       file: data,
       name: 'render',
+      multiPage,
       pageGotoParams: {
         waitUntil: 'networkidle2',
       },

package/lib/render/base.d.ts

@@ -1,5 +1,5 @@
 import chokidar from 'chokidar';
-import { KarinRender, KarinRenderType } from '../types/render.js';
+import { KarinRender, KarinRenderType, RenderResult } from '../types/render.js';
 /**
  * 渲染器基类 所有渲染器都应该继承这个类
  */
@@ -26,5 +26,5 @@ export declare class RenderBase implements KarinRender {
     /**
      * 渲染标准方法
      */
-    render(options: KarinRenderType): Promise<string | Array<string>>;
+    render<T extends KarinRenderType>(options: T): Promise<RenderResult<T>>;
 }

package/lib/render/base.js

@@ -64,7 +64,6 @@ export class RenderBase {
      * 渲染标准方法
      */
   async render (options) {
-    logger.error('未实现渲染方法')
-    return ''
+    throw new Error('未实现渲染方法')
   }
 }

package/lib/render/client.d.ts

@@ -26,5 +26,5 @@ export declare class RenderClient extends RenderBase {
      * 渲染标准方法
      * @param options 渲染参数
      */
-    render(options: KarinRenderType): Promise<string | string[]>;
+    async<T extends KarinRenderType>(options: T): "" | Promise<unknown>;
 }

package/lib/render/client.js

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

package/lib/render/http.d.ts

@@ -15,5 +15,5 @@ export declare class HttpRenderer extends RenderBase {
     /**
      * 渲染
      */
-    render(options: KarinRenderType): Promise<string | Array<string>>;
+    render<T extends KarinRenderType>(options: T): Promise<any>;
 }

package/lib/render/server.d.ts

@@ -1,7 +1,7 @@
 import WebSocket from 'ws';
 import { RenderBase } from './base.js';
 import { IncomingMessage } from 'http';
-import { KarinRenderType } from '../types/index.js';
+import { KarinRenderType, RenderResult } from '../types/index.js';
 declare class Puppeteer extends RenderBase {
     socket: WebSocket;
     id: any;
@@ -13,25 +13,9 @@ declare class Puppeteer extends RenderBase {
     server(socket: WebSocket, request: IncomingMessage): Promise<void>;
     /**
      * 渲染模板
-     * @param {object} options 渲染参数
-     * @param {string} options.file http地址或本地文件路径
-     * @param {string} [options.name] 模板名称
-     * @param {string} [options.fileID] art-template后的文件名
-     * @param {object} [options.data] 传递给模板的数据 template.render(data)
-     * @param {'png'|'jpeg'|'webp'} [options.type] 截图类型 默认'webp'
-     * @param {number} [options.quality] 截图质量 默认90 1-100
-     * @param {boolean} options.omitBackground 是否隐藏背景 默认false
-     * @param {object} [options.setViewport] 设置视窗大小和设备像素比 默认1920*1080、1
-     * @param {number} [options.setViewport.width] 视窗宽度
-     * @param {number} [options.setViewport.height] 视窗高度
-     * @param {string} [options.setViewport.deviceScaleFactor] 设备像素比
-     * @param {number|boolean} [options.multiPage] 分页截图 传递数字则视为视窗高度 返回数组
-     * @param {object} [options.pageGotoParams] 页面goto时的参数
-     * @param {number} [options.pageGotoParams.timeout] 页面加载超时时间
-     * @param {'load'|'domcontentloaded'|'networkidle0'|'networkidle2'} [options.pageGotoParams.waitUntil] 页面加载状态
-     * @returns {Promise<string|string[]>} 返回图片base64或数组
+     * @param options 模板参数
      */
-    render(options: KarinRenderType): Promise<string | string[]>;
+    render<T extends KarinRenderType>(options: T): Promise<RenderResult<T>>;
 }
 export declare const RenderServer: {
     type: string;

package/lib/render/server.js

@@ -62,23 +62,7 @@ class Puppeteer extends RenderBase {
 
   /**
      * 渲染模板
-     * @param {object} options 渲染参数
-     * @param {string} options.file http地址或本地文件路径
-     * @param {string} [options.name] 模板名称
-     * @param {string} [options.fileID] art-template后的文件名
-     * @param {object} [options.data] 传递给模板的数据 template.render(data)
-     * @param {'png'|'jpeg'|'webp'} [options.type] 截图类型 默认'webp'
-     * @param {number} [options.quality] 截图质量 默认90 1-100
-     * @param {boolean} options.omitBackground 是否隐藏背景 默认false
-     * @param {object} [options.setViewport] 设置视窗大小和设备像素比 默认1920*1080、1
-     * @param {number} [options.setViewport.width] 视窗宽度
-     * @param {number} [options.setViewport.height] 视窗高度
-     * @param {string} [options.setViewport.deviceScaleFactor] 设备像素比
-     * @param {number|boolean} [options.multiPage] 分页截图 传递数字则视为视窗高度 返回数组
-     * @param {object} [options.pageGotoParams] 页面goto时的参数
-     * @param {number} [options.pageGotoParams.timeout] 页面加载超时时间
-     * @param {'load'|'domcontentloaded'|'networkidle0'|'networkidle2'} [options.pageGotoParams.waitUntil] 页面加载状态
-     * @returns {Promise<string|string[]>} 返回图片base64或数组
+     * @param options 模板参数
      */
   async render (options) {
     /** 渲染模板 */

package/lib/types/element.d.ts

@@ -442,7 +442,7 @@ export interface FileElement extends Element {
 /**
  * - 原生 Markdown 元素
  */
-export interface ContentElement extends Element {
+export interface RawMarkdownElement extends Element {
     type: 'markdown';
     /**
      * - 原生markdown内容
@@ -458,7 +458,7 @@ export interface ContentElement extends Element {
 /**
  * - 模板 Markdown 元素
  */
-export interface TemplateElement extends Element {
+export interface TplMarkdownElement extends Element {
     type: 'markdown_tpl';
     /**
      * - 模板ID
@@ -478,6 +478,16 @@ export interface TemplateElement extends Element {
         values: Array<string>;
     }>;
 }
+/**
+ * - Markdown 元素
+ */
+export interface MarkdownElement extends Element {
+    type: 'markdown';
+    /**
+     * - Markdown内容
+     */
+    content: string;
+}
 /**
  * - 按钮
  */
@@ -552,7 +562,7 @@ export interface LongMsgElement extends Element {
      */
     id: string;
 }
-export type KarinElement = TextElement | AtElement | FaceElement | BubbleFaceElement | ReplyElement | ImageElement | VoiceElement | VideoElement | BasketballElement | DiceElement | RpsElement | PokeElement | MusicElement | WeatherElement | LocationElement | ShareElement | GiftElement | MarketFaceElement | ForwardElement | ContactElement | JsonElement | XmlElement | FileElement | ButtonElement | RowElement | RecordElement | LongMsgElement | TemplateElement | ContentElement;
+export type KarinElement = TextElement | AtElement | FaceElement | BubbleFaceElement | ReplyElement | ImageElement | VoiceElement | VideoElement | BasketballElement | DiceElement | RpsElement | PokeElement | MusicElement | WeatherElement | LocationElement | ShareElement | GiftElement | MarketFaceElement | ForwardElement | ContactElement | JsonElement | XmlElement | FileElement | ButtonElement | RowElement | RecordElement | LongMsgElement | TplMarkdownElement | RawMarkdownElement;
 /**
  * - 构建自定义转发节点 此元素仅可通过专用接口发送 不支持混合发送
  */

package/lib/types/render.d.ts

@@ -72,6 +72,12 @@ export interface KarinRenderType {
         [key: string]: any;
     };
 }
+/**
+ * 渲染结果
+ */
+export type RenderResult<T> = T extends {
+    multiPage: true | number;
+} ? Array<string> : string;
 /**
  * 渲染基类
  */
@@ -98,7 +104,7 @@ export interface KarinRender {
      * 渲染
      * @param options - 标准渲染方法
      */
-    render: (options: KarinRenderType) => Promise<string | Array<string>>;
+    render: <T extends KarinRenderType>(options: T, id?: string) => Promise<RenderResult<T>>;
 }
 /**
  * 渲染器管理

package/lib/utils/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, TemplateElement, ContentElement, NodeElement, KarinElement, LongMsgElement, RecordElement } 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 } from '../types/index.js';
 export declare const segment: {
     /**
      * 纯文本
@@ -252,13 +252,13 @@ export declare const segment: {
      * @param content - 原生markdown内容
      * @param config - 未知的参数
      */
-    markdown(content: ContentElement["content"], config?: ContentElement["config"]): ContentElement;
+    markdown(content: RawMarkdownElement["content"], config?: RawMarkdownElement["config"]): RawMarkdownElement;
     /**
      * 构建模板Markdown
      * @param custom_template_id - 模板ID
      * @param params - 模板markdown参数
      */
-    markdown_tpl(custom_template_id: TemplateElement["custom_template_id"], params: TemplateElement["params"]): TemplateElement;
+    markdown_tpl(custom_template_id: TplMarkdownElement["custom_template_id"], params: TplMarkdownElement["params"]): TplMarkdownElement;
     /**
      * 按钮
      * @param data - 按钮数据

package/package.json

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