koishi-plugin-best-cave 2.0.0 → 2.0.1

package/lib/index.d.ts

@@ -0,0 +1,68 @@
+import { Context, Schema } from 'koishi';
+export declare const name = "best-cave";
+export declare const inject: string[];
+export declare const usage = "\n<div style=\"border-radius: 10px; border: 1px solid #ddd; padding: 16px; margin-bottom: 20px; box-shadow: 0 2px 5px rgba(0,0,0,0.1);\">\n  <h2 style=\"margin-top: 0; color: #4a6ee0;\">\uD83D\uDCCC \u63D2\u4EF6\u8BF4\u660E</h2>\n  <p>\uD83D\uDCD6 <strong>\u4F7F\u7528\u6587\u6863</strong>\uFF1A\u8BF7\u70B9\u51FB\u5DE6\u4E0A\u89D2\u7684 <strong>\u63D2\u4EF6\u4E3B\u9875</strong> \u67E5\u770B\u63D2\u4EF6\u4F7F\u7528\u6587\u6863</p>\n  <p>\uD83D\uDD0D <strong>\u66F4\u591A\u63D2\u4EF6</strong>\uFF1A\u53EF\u8BBF\u95EE <a href=\"https://github.com/YisRime\" style=\"color:#4a6ee0;text-decoration:none;\">\u82E1\u6DDE\u7684 GitHub</a> \u67E5\u770B\u672C\u4EBA\u7684\u6240\u6709\u63D2\u4EF6</p>\n</div>\n\n<div style=\"border-radius: 10px; border: 1px solid #ddd; padding: 16px; margin-bottom: 20px; box-shadow: 0 2px 5px rgba(0,0,0,0.1);\">\n  <h2 style=\"margin-top: 0; color: #e0574a;\">\u2764\uFE0F \u652F\u6301\u4E0E\u53CD\u9988</h2>\n  <p>\uD83C\uDF1F \u559C\u6B22\u8FD9\u4E2A\u63D2\u4EF6\uFF1F\u8BF7\u5728 <a href=\"https://github.com/YisRime\" style=\"color:#e0574a;text-decoration:none;\">GitHub</a> \u4E0A\u7ED9\u6211\u4E00\u4E2A Star\uFF01</p>\n  <p>\uD83D\uDC1B \u9047\u5230\u95EE\u9898\uFF1F\u8BF7\u901A\u8FC7 <strong>Issues</strong> \u63D0\u4EA4\u53CD\u9988\uFF0C\u6216\u52A0\u5165 QQ \u7FA4 <a href=\"https://qm.qq.com/q/PdLMx9Jowq\" style=\"color:#e0574a;text-decoration:none;\"><strong>855571375</strong></a> \u8FDB\u884C\u4EA4\u6D41</p>\n</div>\n";
+/**
+ * 存储在数据库中的单个消息元素。
+ * @property type - 元素类型。
+ * @property content - 文本内容，仅用于 'text' 类型。
+ * @property file - 文件标识符（本地文件名或 S3 Key），用于媒体类型。
+ */
+export interface StoredElement {
+    type: 'text' | 'img' | 'video' | 'audio' | 'file';
+    content?: string;
+    file?: string;
+}
+/**
+ * 数据库中 `cave` 表的完整对象模型。
+ * @property id - 回声洞的唯一数字 ID。
+ * @property elements - 构成回声洞内容的元素数组。
+ * @property channelId - 提交回声洞的频道 ID，若为私聊则为 null。
+ * @property userId - 提交用户的 ID。
+ * @property userName - 提交用户的昵称。
+ * @property status - 回声洞状态: 'active' (活跃), 'delete' (待删除), 'pending' (待审核)。
+ * @property time - 提交时间。
+ */
+export interface CaveObject {
+    id: number;
+    elements: StoredElement[];
+    channelId: string;
+    userId: string;
+    userName: string;
+    status: 'active' | 'delete' | 'pending';
+    time: Date;
+}
+declare module 'koishi' {
+    interface Tables {
+        cave: CaveObject;
+    }
+}
+/**
+ * 插件的配置接口。
+ */
+export interface Config {
+    cooldown: number;
+    perChannel: boolean;
+    adminUsers: string[];
+    enableProfile: boolean;
+    enableDataIO: boolean;
+    enableReview: boolean;
+    caveFormat: string;
+    enableS3: boolean;
+    endpoint?: string;
+    region?: string;
+    accessKeyId?: string;
+    secretAccessKey?: string;
+    bucket?: string;
+    publicUrl?: string;
+}
+/**
+ * 使用 Koishi Schema 定义插件的配置项，用于生成配置界面。
+ */
+export declare const Config: Schema<Config>;
+/**
+ * 插件的入口函数。
+ * @param ctx - Koishi 上下文。
+ * @param config - 用户提供的插件配置。
+ */
+export declare function apply(ctx: Context, config: Config): void;

package/lib/index.js

@@ -298,23 +298,40 @@ async function mediaElementToBase64(element, fileManager, logger2) {
 __name(mediaElementToBase64, "mediaElementToBase64");
 async function buildCaveMessage(cave, config, fileManager, logger2) {
   const caveHElements = storedFormatToHElements(cave.elements);
-  const processedElements = await Promise.all(caveHElements.map((element) => {
+  const processedElements = await Promise.all(caveHElements.map(async (element) => {
     const isMedia = ["image", "video", "audio", "file"].includes(element.type);
     const fileName = element.attrs.src;
     if (!isMedia || !fileName) {
-      return Promise.resolve(element);
+      return element;
     }
     if (config.enableS3 && config.publicUrl) {
       const fullUrl = config.publicUrl.endsWith("/") ? `${config.publicUrl}${fileName}` : `${config.publicUrl}/${fileName}`;
-      return Promise.resolve((0, import_koishi.h)(element.type, { ...element.attrs, src: fullUrl }));
+      return (0, import_koishi.h)(element.type, { ...element.attrs, src: fullUrl });
     }
     return mediaElementToBase64(element, fileManager, logger2);
   }));
-  return [
-    (0, import_koishi.h)("p", {}, `回声洞 ——（${cave.id}）`),
-    ...processedElements,
-    (0, import_koishi.h)("p", {}, `—— ${cave.userName}`)
-  ];
+  const finalMessage = [];
+  const formatString = config.caveFormat;
+  const separatorIndex = formatString.indexOf("|");
+  let headerFormat;
+  let footerFormat;
+  if (separatorIndex === -1) {
+    headerFormat = formatString;
+    footerFormat = "";
+  } else {
+    headerFormat = formatString.substring(0, separatorIndex);
+    footerFormat = formatString.substring(separatorIndex + 1);
+  }
+  const headerText = headerFormat.replace("{id}", cave.id.toString()).replace("{name}", cave.userName);
+  if (headerText.trim()) {
+    finalMessage.push((0, import_koishi.h)("p", {}, headerText));
+  }
+  finalMessage.push(...processedElements);
+  const footerText = footerFormat.replace("{id}", cave.id.toString()).replace("{name}", cave.userName);
+  if (footerText.trim()) {
+    finalMessage.push((0, import_koishi.h)("p", {}, footerText));
+  }
+  return finalMessage;
 }
 __name(buildCaveMessage, "buildCaveMessage");
 async function cleanupPendingDeletions(ctx, fileManager, logger2) {
@@ -620,7 +637,8 @@ var Config = import_koishi3.Schema.intersect([
     perChannel: import_koishi3.Schema.boolean().default(false).description("启用分群模式"),
     enableProfile: import_koishi3.Schema.boolean().default(false).description("启用自定义昵称"),
     enableDataIO: import_koishi3.Schema.boolean().default(false).description("启用导入导出"),
-    adminUsers: import_koishi3.Schema.array(import_koishi3.Schema.string()).default([]).description("管理员 ID 列表")
+    adminUsers: import_koishi3.Schema.array(import_koishi3.Schema.string()).default([]).description("管理员 ID 列表"),
+    caveFormat: import_koishi3.Schema.string().default("回声洞 ——（{id}）|—— {name}").required().description("自定义文本(使用|分隔)")
   }).description("基础配置"),
   import_koishi3.Schema.object({
     enableReview: import_koishi3.Schema.boolean().default(false).description("启用审核")

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "koishi-plugin-best-cave",
   "description": "最强大的回声洞现已重构完成啦！注意数据格式需要使用脚本转换哦~",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "contributors": [
     "Yis_Rime <yis_rime@outlook.com>"
   ],