koishi-plugin-bilibili-notify 3.0.0-beta.1 → 3.0.0

package/lib/comRegister.d.ts

@@ -1,7 +1,7 @@
 import { type Bot, type Context, type FlatPick, type Logger, Schema } from "koishi";
 import type { Notifier } from "@koishijs/plugin-notifier";
 import type { LoginBili } from "./database";
-import { LiveType, type MasterInfo, type SubManager, type Target } from "./type";
+import { LiveType, type MasterInfo, type SubItem, type SubManager, type Target } from "./type";
 declare class ComRegister {
     static inject: string[];
     qqRelatedBotList: Array<string>;
@@ -28,15 +28,9 @@ declare class ComRegister {
     sendMsg(targets: Target, content: any, live?: boolean): Promise<void>;
     dynamicDetect(): (...args: any[]) => void;
     debug_dynamicDetect(): (...args: any[]) => void;
-    sendLiveNotifyCard(info: {
-        username: string;
-        userface: string;
-        target: Target;
-        data: any;
-    }, liveType: LiveType, followerDisplay: string, liveNotifyMsg?: string): Promise<void>;
     useMasterInfo(uid: string, masterInfo: MasterInfo, liveType: LiveType): Promise<MasterInfo>;
     useLiveRoomInfo(roomId: string): Promise<any>;
-    liveDetectWithListener(roomId: string, target: Target): Promise<void>;
+    liveDetectWithListener(roomId: string, target: Target, cardStyle: SubItem["card"]): Promise<void>;
     subShow(): string;
     updateSubNotifier(): void;
     checkIfLoginInfoIsLoaded(): Promise<unknown>;
@@ -65,6 +59,13 @@ declare namespace ComRegister {
                 }>;
                 platform: string;
             }>;
+            card: {
+                enable: boolean;
+                cardColorStart: string;
+                cardColorEnd: string;
+                cardBasePlateColor: string;
+                cardBasePlateBorder: string;
+            };
         }>;
         master: {
             enable: boolean;

package/lib/comRegister.js

@@ -590,7 +590,7 @@ class ComRegister {
                         // 推送该条动态
                         const buffer = await (0, utils_1.withRetry)(async () => {
                             // 渲染图片
-                            return await this.ctx.gi.generateDynamicImg(items[num]);
+                            return await this.ctx.gi.generateDynamicImg(items[num], sub.card);
                         }, 1).catch(async (e) => {
                             // 直播开播动态，不做处理
                             if (e.message === "直播开播动态，不做处理")
@@ -778,7 +778,7 @@ class ComRegister {
                         // 推送该条动态
                         const buffer = await (0, utils_1.withRetry)(async () => {
                             // 渲染图片
-                            return await this.ctx.gi.generateDynamicImg(items[num]);
+                            return await this.ctx.gi.generateDynamicImg(items[num], sub.card);
                         }, 1).catch(async (e) => {
                             // 直播开播动态，不做处理
                             if (e.message === "直播开播动态，不做处理")
@@ -837,23 +837,6 @@ class ComRegister {
         // 加工handler并返回
         return (0, utils_1.withLock)(handler);
     }
-    // 定义发送直播通知卡片方法
-    async sendLiveNotifyCard(info, liveType, followerDisplay, liveNotifyMsg) {
-        // 生成图片
-        const buffer = await (0, utils_1.withRetry)(async () => {
-            // 获取直播通知卡片
-            return await this.ctx.gi.generateLiveImg(info.data, info.username, info.userface, followerDisplay, liveType);
-        }, 1).catch((e) => {
-            this.logger.error(`liveDetect generateLiveImg() 推送卡片生成失败，原因：${e.message}`);
-        });
-        // 发送私聊消息并重启服务
-        if (!buffer)
-            return await this.sendPrivateMsgAndStopService();
-        // 推送直播信息
-        const msg = ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [koishi_1.h.image(buffer, "image/png"), liveNotifyMsg || ""] }));
-        // 只有在开播时才艾特全体成员
-        return await this.sendMsg(info.target, msg, liveType === type_1.LiveType.StartBroadcasting);
-    }
     // 定义获取主播信息方法
     async useMasterInfo(uid, masterInfo, liveType) {
         // 获取主播信息
@@ -906,7 +889,7 @@ class ComRegister {
         // 返回
         return data;
     }
-    async liveDetectWithListener(roomId, target) {
+    async liveDetectWithListener(roomId, target, cardStyle) {
         // 定义开播时间
         let liveTime;
         // 定义定时推送定时器
@@ -923,6 +906,23 @@ class ComRegister {
         let liveRoomInfo;
         let masterInfo;
         let watchedNum;
+        // 定义发送直播通知卡片方法
+        const sendLiveNotifyCard = async (liveType, followerDisplay, liveNotifyMsg) => {
+            // 生成图片
+            const buffer = await (0, utils_1.withRetry)(async () => {
+                // 获取直播通知卡片
+                return await this.ctx.gi.generateLiveImg(liveRoomInfo, masterInfo.username, masterInfo.userface, followerDisplay, liveType, cardStyle);
+            }, 1).catch((e) => {
+                this.logger.error(`liveDetect generateLiveImg() 推送卡片生成失败，原因：${e.message}`);
+            });
+            // 发送私聊消息并重启服务
+            if (!buffer)
+                return await this.sendPrivateMsgAndStopService();
+            // 推送直播信息
+            const msg = ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [koishi_1.h.image(buffer, "image/png"), liveNotifyMsg || ""] }));
+            // 只有在开播时才艾特全体成员
+            return await this.sendMsg(target, msg, liveType === type_1.LiveType.StartBroadcasting);
+        };
         // 找到频道/群组对应的
         const liveGuardBuyPushTargetArr = target.map((channel) => {
             // 获取符合条件的target
@@ -955,12 +955,7 @@ class ComRegister {
                     .replace("-link", `https://live.bilibili.com/${liveRoomInfo.short_id === 0 ? liveRoomInfo.room_id : liveRoomInfo.short_id}`)
                 : null;
             // 发送直播通知卡片
-            await this.sendLiveNotifyCard({
-                username: masterInfo.username,
-                userface: masterInfo.userface,
-                target,
-                data: liveRoomInfo,
-            }, type_1.LiveType.LiveBroadcast, watched, liveMsg);
+            await sendLiveNotifyCard(type_1.LiveType.LiveBroadcast, watched, liveMsg);
         };
         // 定义直播间信息获取函数
         const useMasterAndLiveRoomInfo = async (liveType) => {
@@ -1038,12 +1033,7 @@ class ComRegister {
                         .replace("-link", `https://live.bilibili.com/${liveRoomInfo.short_id === 0 ? liveRoomInfo.room_id : liveRoomInfo.short_id}`)
                     : null;
                 // 推送开播通知
-                await this.sendLiveNotifyCard({
-                    username: masterInfo.username,
-                    userface: masterInfo.userface,
-                    target,
-                    data: liveRoomInfo,
-                }, type_1.LiveType.StartBroadcasting, follower, liveStartMsg);
+                await sendLiveNotifyCard(type_1.LiveType.StartBroadcasting, follower, liveStartMsg);
                 // 判断定时器是否已开启
                 if (!pushAtTimeTimer) {
                     // 开始直播，开启定时器
@@ -1084,12 +1074,7 @@ class ComRegister {
                         .replace("-follower_change", followerChange)
                     : null;
                 // 推送通知卡片
-                await this.sendLiveNotifyCard({
-                    username: masterInfo.username,
-                    userface: masterInfo.userface,
-                    target,
-                    data: liveRoomInfo,
-                }, type_1.LiveType.StopBroadcast, followerChange, liveEndMsg);
+                await sendLiveNotifyCard(type_1.LiveType.StopBroadcast, followerChange, liveEndMsg);
                 // 关闭定时推送定时器
                 pushAtTimeTimer();
                 // 将推送定时器变量置空
@@ -1119,12 +1104,7 @@ class ComRegister {
                 : null;
             // 发送直播通知卡片
             if (this.config.restartPush) {
-                await this.sendLiveNotifyCard({
-                    username: masterInfo.username,
-                    userface: masterInfo.userface,
-                    target,
-                    data: liveRoomInfo,
-                }, type_1.LiveType.LiveBroadcast, watched, liveMsg);
+                await sendLiveNotifyCard(type_1.LiveType.LiveBroadcast, watched, liveMsg);
             }
             // 正在直播，开启定时器，判断定时器是否已开启
             if (!pushAtTimeTimer) {
@@ -1311,7 +1291,7 @@ class ComRegister {
                 // 判断是否订阅直播
                 if (sub.live) {
                     // 启动直播监测
-                    await this.liveDetectWithListener(data.live_room.roomid, sub.target);
+                    await this.liveDetectWithListener(data.live_room.roomid, sub.target, sub.card);
                 }
             }
             // 在B站中订阅该对象
@@ -1329,6 +1309,7 @@ class ComRegister {
                 platform: "",
                 live: sub.live,
                 dynamic: sub.dynamic,
+                card: sub.card,
             });
             this.logger.info(`UID:${sub.uid}订阅加载完毕！`);
         }
@@ -1375,6 +1356,13 @@ class ComRegister {
                 })).description("频道/群组信息"),
                 platform: koishi_1.Schema.string().description("推送平台"),
             })).description("订阅用户需要发送的频道/群组信息"),
+            card: koishi_1.Schema.object({
+                enable: koishi_1.Schema.boolean(),
+                cardColorStart: koishi_1.Schema.string(),
+                cardColorEnd: koishi_1.Schema.string(),
+                cardBasePlateColor: koishi_1.Schema.string(),
+                cardBasePlateBorder: koishi_1.Schema.string(),
+            }).description("自定义推送卡片颜色，默认使用插件内置的颜色，设置后会覆盖插件内置的颜色"),
         }))
             .role("table")
             .description("手动输入订阅信息，方便自定义订阅内容，这里的订阅内容不会存入数据库。uid: 订阅用户UID，dynamic: 是否需要订阅动态，live: 是否需要订阅直播"),

package/lib/generateImg.d.ts

@@ -9,8 +9,18 @@ declare class GenerateImg extends Service {
     giConfig: GenerateImg.Config;
     constructor(ctx: Context, config: GenerateImg.Config);
     imgHandler(html: string): Promise<Buffer<ArrayBufferLike>>;
-    generateLiveImg(data: any, username: string, userface: string, followerDisplay: string, liveStatus: number): Promise<Buffer<ArrayBufferLike>>;
-    generateDynamicImg(data: any): Promise<Buffer<ArrayBufferLike>>;
+    generateLiveImg(data: any, username: string, userface: string, followerDisplay: string, liveStatus: number, { cardColorStart, cardColorEnd, cardBasePlateColor, cardBasePlateBorder, }: {
+        cardColorStart?: string;
+        cardColorEnd?: string;
+        cardBasePlateColor?: string;
+        cardBasePlateBorder?: string;
+    }): Promise<Buffer<ArrayBufferLike>>;
+    generateDynamicImg(data: any, { cardColorStart, cardColorEnd, cardBasePlateColor, cardBasePlateBorder, }: {
+        cardColorStart?: string;
+        cardColorEnd?: string;
+        cardBasePlateColor?: string;
+        cardBasePlateBorder?: string;
+    }): Promise<Buffer<ArrayBufferLike>>;
     getLiveStatus(time: string, liveStatus: number): Promise<[string, string, boolean]>;
     getTimeDifference(dateString: string): Promise<string>;
     unixTimestampToString(timestamp: number): string;

package/lib/generateImg.js

@@ -51,7 +51,7 @@ class GenerateImg extends koishi_1.Service {
     }
     async generateLiveImg(
     // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-    data, username, userface, followerDisplay, liveStatus /*0未开播 1刚开播 2已开播 3停止直播*/) {
+    data, username, userface, followerDisplay, liveStatus /*0未开播 1刚开播 2已开播 3停止直播*/, { cardColorStart = this.giConfig.cardColorStart, cardColorEnd = this.giConfig.cardColorEnd, cardBasePlateColor = this.giConfig.cardBasePlateColor, cardBasePlateBorder = this.giConfig.cardBasePlateBorder, }) {
         const [titleStatus, liveTime, cover] = await this.getLiveStatus(data.live_time, liveStatus);
         // 加载字体
         const fontURL = (0, node_url_1.pathToFileURL)((0, node_path_1.resolve)(__dirname, "font/HYZhengYuan-75W.ttf"));
@@ -83,7 +83,7 @@ class GenerateImg extends koishi_1.Service {
                         width: 100%;
                         height: auto;
                         padding: 15px;
-                        background: linear-gradient(to right bottom, ${this.giConfig.cardColorStart}, ${this.giConfig.cardColorEnd});
+                        background: linear-gradient(to right bottom, ${cardColorStart}, ${cardColorEnd});
                         overflow: hidden;
                     }
         
@@ -91,11 +91,11 @@ class GenerateImg extends koishi_1.Service {
                         width: 100%;
                         height: auto;
                         box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2);
-                        padding: ${this.giConfig.cardBasePlateBorder};
+                        padding: ${cardBasePlateBorder};
                         border-radius: 10px;
-                        background-color: ${this.giConfig.cardBasePlateColor};
+                        background-color: ${cardBasePlateColor};
                     }
-        
+
                     .card {
                         width: 100%;
                         height: auto;
@@ -214,8 +214,9 @@ class GenerateImg extends koishi_1.Service {
             throw new Error(`生成图片失败！错误: ${e.toString()}`);
         });
     }
+    async generateDynamicImg(
     // biome-ignore lint/suspicious/noExplicitAny: <explanation>
-    async generateDynamicImg(data) {
+    data, { cardColorStart = this.giConfig.cardColorStart, cardColorEnd = this.giConfig.cardColorEnd, cardBasePlateColor = this.giConfig.cardBasePlateColor, cardBasePlateBorder = this.giConfig.cardBasePlateBorder, }) {
         // module_author
         const module_author = data.modules.module_author;
         const avatarUrl = module_author.face;
@@ -288,7 +289,6 @@ class GenerateImg extends koishi_1.Service {
                 if (module_dynamic.major?.draw) {
                     if (module_dynamic.major.draw.items.length === 1) {
                         const height = module_dynamic.major.draw.items[0].height;
-                        console.log(height);
                         if (height > 3000) {
                             major += /* html */ `
                                 <div class="single-photo-container">
@@ -586,7 +586,7 @@ class GenerateImg extends koishi_1.Service {
                 width: 100%;
                 height: auto;
                 padding: 15px;
-                background: linear-gradient(to right bottom, ${this.giConfig.cardColorStart}, ${this.giConfig.cardColorEnd});
+                background: linear-gradient(to right bottom, ${cardColorStart}, ${cardColorEnd});
                 overflow: hidden;
             }
 
@@ -594,9 +594,9 @@ class GenerateImg extends koishi_1.Service {
                 width: 100%;
                 height: auto;
                 box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2);
-                padding: ${this.giConfig.cardBasePlateBorder};
+                padding: ${cardBasePlateBorder};
                 border-radius: 10px;
-                background-color: ${this.giConfig.cardBasePlateColor};
+                background-color: ${cardBasePlateColor};
             }
 
             .card {
@@ -951,7 +951,7 @@ class GenerateImg extends koishi_1.Service {
                 width: 100%;
                 height: auto;
                 padding: 15px;
-                background: linear-gradient(to right bottom, ${this.giConfig.cardColorStart}, ${this.giConfig.cardColorEnd});
+                background: linear-gradient(to right bottom, ${cardColorStart}, ${cardColorEnd});
                 overflow: hidden;
             }
 
@@ -959,9 +959,9 @@ class GenerateImg extends koishi_1.Service {
                 width: 100%;
                 height: auto;
                 box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2);
-                padding: ${this.giConfig.cardBasePlateBorder};
+                padding: ${cardBasePlateBorder};
                 border-radius: 10px;
-                background-color: ${this.giConfig.cardBasePlateColor};
+                background-color: ${cardBasePlateColor};
             }
     
             .card {

package/lib/index.d.ts

@@ -36,6 +36,7 @@ export interface Config {
         uid: string;
         dynamic: boolean;
         live: boolean;
+        card: {};
         target: Array<{
             channelIdArr: Array<{
                 channelId: string;

package/lib/index.js

@@ -303,6 +303,32 @@ exports.Config = koishi_1.Schema.object({
                 .required()
                 .description("需推送的频道/群组详细设置"),
         })).description("订阅用户需要发送的平台和频道/群组信息(一个平台下可以推送多个频道/群组)"),
+        card: koishi_1.Schema.intersect([
+            koishi_1.Schema.object({
+                enable: koishi_1.Schema.boolean()
+                    .default(false)
+                    .description("是否开启自定义卡片颜色")
+                    .experimental(),
+            }),
+            koishi_1.Schema.union([
+                koishi_1.Schema.object({
+                    enable: koishi_1.Schema.const(true).required(),
+                    cardColorStart: koishi_1.Schema.string()
+                        .pattern(/^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/)
+                        .description("推送卡片的开始渐变背景色，请填入16进制颜色代码，参考网站：https://webkul.github.io/coolhue/"),
+                    cardColorEnd: koishi_1.Schema.string()
+                        .pattern(/^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/)
+                        .description("推送卡片的结束渐变背景色，请填入16进制颜色代码，参考网站：https://colorate.azurewebsites.net/"),
+                    cardBasePlateColor: koishi_1.Schema.string()
+                        .pattern(/^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/)
+                        .description("推送卡片底板颜色，请填入16进制颜色代码"),
+                    cardBasePlateBorder: koishi_1.Schema.string()
+                        .pattern(/\d*\.?\d+(?:px|em|rem|%|vh|vw|vmin|vmax)/)
+                        .description("推送卡片底板边框宽度，请填入css单位，例如1px，12.5rem，100%"),
+                }),
+                koishi_1.Schema.object({}),
+            ]),
+        ]),
     }).collapse())
         .collapse()
         .description("输入订阅信息，自定义订阅内容； uid: 订阅用户UID，dynamic: 是否需要订阅动态，live: 是否需要订阅直播"),

package/lib/type/index.d.ts

@@ -26,6 +26,13 @@ export type SubItem = {
     platform: string;
     live: boolean;
     dynamic: boolean;
+    card: {
+        enable: boolean;
+        cardColorStart: string;
+        cardColorEnd: string;
+        cardBasePlateColor: string;
+        cardBasePlateBorder: string;
+    };
 };
 export type SubManager = Array<SubItem>;
 export type MasterInfo = {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "koishi-plugin-bilibili-notify",
   "description": "Koishi bilibili notify plugin",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0",
   "contributors": [
     "Akokko <admin@akokko.com>"
   ],

package/readme.md

@@ -211,6 +211,8 @@
 - ver 3.0.0-alpha.25 修复：输入指令 `bili ll` 时报错 `TypeError: Cannot read properties of null (reading 'items')`，当某个订阅只订阅动态时无法成功订阅且后续订阅都无法加载； 优化：部分代码结构
 - ver 3.0.0-beta.0 移除：配置项 `renderType`，推送卡片渲染模式 `render`，现默认为 `page` 渲染模式； 优化：部分代码结构
 - ver 3.0.0-beta.1 修复：使用动态屏蔽时，同时开启动态debug模式，当检测到屏蔽动态时会直接报错关闭插件； 新增：配置项 `pushImgsInDynamic` 是否推送动态中的图片，默认不开启。开启后会单独推送动态中的图片，上舰信息直播间提示
+- ver 3.0.0-beta.2 新增：配置项 `sub.card`，能更改每个订阅的推送卡片样式，未更改的样式与全局样式保持一致
+- ver 3.0.0 优化：配置项 `sub.card` 添加实验性标识
 
 ## 交流群