koishi-plugin-starfx-bot 0.24.2 → 0.25.0

package/lib/index.d.ts

@@ -54,7 +54,11 @@ export interface Config {
     originImg: boolean;
     originImgRSSUrl: string;
     filePathToBase64: boolean;
-    featureControl: string;
+    featureControl: Array<{
+        functionName: string;
+        whitelist: boolean;
+        groups: string;
+    }>;
 }
 export declare const Config: Schema<Schemastery.ObjectS<{}>, {} & import("cosmokit").Dict>;
 export declare function apply(ctx: Context, cfg: Config): void;

package/lib/index.js

@@ -63,7 +63,7 @@ var package_default = {
   contributors: [
     "StarFreedomX <starfreedomx@outlook.com>"
   ],
-  version: "0.24.2",
+  version: "0.25.0",
   main: "lib/index.js",
   typings: "lib/index.d.ts",
   files: [
@@ -693,15 +693,25 @@ async function iLoveYou(cfg, session, elements) {
   }
 }
 __name(iLoveYou, "iLoveYou");
-function parseJsonControl(text) {
+function parseFeatureControl(array) {
   try {
-    return JSON.parse(text);
+    return Object.fromEntries(
+      array.map(
+        ({ functionName, whitelist, groups }) => functionName?.length ? [
+          functionName,
+          {
+            whitelist: !!whitelist,
+            groups: groups?.split(",")?.map(Number).filter(Boolean) || []
+          }
+        ] : void 0
+      )
+    ) || {};
   } catch (e) {
-    starfxLogger.warn("[功能控制] JSON 解析失败", e);
-    return null;
+    starfxLogger.warn("[功能控制] 解析失败", e);
+    return {};
   }
 }
-__name(parseJsonControl, "parseJsonControl");
+__name(parseFeatureControl, "parseFeatureControl");
 function detectControl(controlJson, guildId, funName) {
   const rule = controlJson?.[funName];
   if (!rule || rule.whitelist === void 0 || !Array.isArray(rule.groups)) {
@@ -1221,6 +1231,26 @@ var usage = `
     <li>bdbd</li>
   `;
 var repeatContextMap = /* @__PURE__ */ new Map();
+var functionNames = [
+  "lock",
+  "sold",
+  "repeat",
+  "record",
+  "record-push",
+  "record-get",
+  "atNotSay",
+  "replyBot",
+  "iLoveYou",
+  "bdbd",
+  "roll",
+  "undo",
+  "echo",
+  "originImg",
+  "sendLocalImage",
+  "forward",
+  "exchangeRate",
+  "myId"
+];
 var Config = import_koishi5.Schema.intersect([
   import_koishi5.Schema.object({
     openLock: import_koishi5.Schema.boolean().default(true).description("开启明日方舟封印功能"),
@@ -1297,8 +1327,14 @@ var Config = import_koishi5.Schema.intersect([
     import_koishi5.Schema.object({})
   ]),
   import_koishi5.Schema.object({
-    featureControl: import_koishi5.Schema.string().role("textarea", { rows: [15] }).default("{\n\n}").description(`黑/白名单配置，语法为JSON格式(可以不缩进)，<br>
-可配置功能键及语法详见 [项目地址](https://github.com/StarFreedomX/starfx-bot)或[npm发布页](https://www.npmjs.com/package/koishi-plugin-bangdream-ccg)`)
+    featureControl: import_koishi5.Schema.array(
+      import_koishi5.Schema.object({
+        functionName: import_koishi5.Schema.union(functionNames),
+        whitelist: import_koishi5.Schema.boolean(),
+        groups: import_koishi5.Schema.string()
+      })
+    ).role("table").description(`黑/白名单配置，群组间用英文半角逗号分隔，<br>
+可配置功能键及用法详见 [项目地址](https://github.com/StarFreedomX/starfx-bot)或[npm发布页](https://www.npmjs.com/package/koishi-plugin-bangdream-ccg)`)
   }).description("高级配置")
 ]);
 function apply(ctx, cfg) {
@@ -1306,10 +1342,10 @@ function apply(ctx, cfg) {
   baseDir = ctx.baseDir;
   assetsDir = `${ctx.baseDir}/data/starfx-bot/assets`;
   initAssets();
-  const controlJson = parseJsonControl(cfg.featureControl);
+  const featureControl = parseFeatureControl(cfg.featureControl);
   if (cfg.openLock) {
     ctx.command("封印 [param]").action(async ({ session }, param) => {
-      if (ctx.QhzySharp && detectControl(controlJson, session.guildId, "lock"))
+      if (ctx.QhzySharp && detectControl(featureControl, session.guildId, "lock"))
         await session.send(
           await drawLock(ctx, await getImageSrc(session, param))
         );
@@ -1317,7 +1353,7 @@ function apply(ctx, cfg) {
   }
   if (cfg.openSold) {
     ctx.command("卖掉了 [param]").action(async ({ session }, param) => {
-      if (ctx.QhzySharp && detectControl(controlJson, session.guildId, "sold"))
+      if (ctx.QhzySharp && detectControl(featureControl, session.guildId, "sold"))
         await session.send(
           await drawSold(ctx, await getImageSrc(session, param))
         );
@@ -1325,14 +1361,14 @@ function apply(ctx, cfg) {
   }
   if (cfg.roll) {
     ctx.command("roll").action(async ({ session }) => {
-      if (detectControl(controlJson, session.guildId, "roll")) {
+      if (detectControl(featureControl, session.guildId, "roll")) {
         return handleRoll(session);
       }
     });
   }
   if (cfg.echo) {
     ctx.command("echo <params>").option("time", "-t <time: number> 指定时间(min)").action(async ({ session, options }, params) => {
-      if (detectControl(controlJson, session.guildId, "echo")) {
+      if (detectControl(featureControl, session.guildId, "echo")) {
         const elements = session.elements;
         const getEchoMessage = /* @__PURE__ */ __name(() => {
           try {
@@ -1376,7 +1412,7 @@ function apply(ctx, cfg) {
   }
   if (cfg.bangdreamBorder) {
     ctx.command("bdbd [param]").option("starNum", "-n <starNum: number>").option("color", "-c <color: string>").option("train", "-t <train: string>").option("band", "-b <band: string>").action(async ({ session, options }, param) => {
-      if (ctx.QhzySharp && detectControl(controlJson, session.guildId, "bdbd")) {
+      if (ctx.QhzySharp && detectControl(featureControl, session.guildId, "bdbd")) {
         const drawConfig = await handleBanGDreamConfig(options);
         const imgSrc = await getImageSrc(session, param);
         if (!imgSrc?.length) return "输入无效";
@@ -1392,7 +1428,7 @@ function apply(ctx, cfg) {
   }
   if (cfg.record) {
     ctx.command("投稿 [param]").action(async ({ session }, param) => {
-      if (detectControl(controlJson, session.guildId, "record") && detectControl(controlJson, session.guildId, "record-push")) {
+      if (detectControl(featureControl, session.guildId, "record") && detectControl(featureControl, session.guildId, "record-push")) {
         const imageSrc = await getImageSrc(session, param, {
           img: true,
           at: false,
@@ -1411,7 +1447,7 @@ function apply(ctx, cfg) {
       }
     });
     ctx.command("语录 [tag:string]").action(async ({ session }, tag) => {
-      if (detectControl(controlJson, session.guildId, "record") && detectControl(controlJson, session.guildId, "record-get")) {
+      if (detectControl(featureControl, session.guildId, "record") && detectControl(featureControl, session.guildId, "record-get")) {
         const filepath = await getRecord(
           cfg,
           session.gid.replaceAll(":", "_"),
@@ -1425,7 +1461,11 @@ function apply(ctx, cfg) {
   }
   for (const key in cfg.sendLocalImage) {
     ctx.command(key, { hidden: cfg.sendLocalImage[key].hiddenInHelp }).action(async ({ session }) => {
-      if (detectControl(controlJson, session.guildId, "sendLocalImage") && detectControl(controlJson, session.guildId, key))
+      if (detectControl(
+        featureControl,
+        session.guildId,
+        "sendLocalImage"
+      ) && detectControl(featureControl, session.guildId, key))
         return import_koishi5.h.image(
           safeQuote(cfg.sendLocalImage[key].imgPath, false)
         );
@@ -1468,13 +1508,13 @@ function apply(ctx, cfg) {
   }
   if (cfg.undo) {
     ctx.command("undo").alias("撤回").usage("撤回消息").action(async ({ session }) => {
-      if (detectControl(controlJson, session.guildId, "undo"))
+      if (detectControl(featureControl, session.guildId, "undo"))
         await undo(cfg, session);
     });
   }
   if (cfg.forward) {
     ctx.command("forward").option("group", "-g <group:string>").option("platform", "-p <platform:string>").usage("转发消息").action(async ({ session, options }) => {
-      if (detectControl(controlJson, session.guildId, "forward")) {
+      if (detectControl(featureControl, session.guildId, "forward")) {
         const mapPath = import_node_path4.default.join(assetsDir, "forward.json");
         const groupMap = readMap(mapPath);
         if (options.group) {
@@ -1504,7 +1544,7 @@ function apply(ctx, cfg) {
   }
   if (cfg.originImg) {
     ctx.command("获取X原图").alias("推特原图").usage("获取推特原图").action(async ({ session }) => {
-      if (detectControl(controlJson, session.guildId, "originImg")) {
+      if (detectControl(featureControl, session.guildId, "originImg")) {
         let [xUrls, xIndex] = await Promise.all([
           getXUrl(session?.quote?.content),
           getXNum(session)
@@ -1520,15 +1560,21 @@ function apply(ctx, cfg) {
     });
   }
   if (cfg.myId) {
-    ctx.command("my-gid").action(({ session }) => session.gid);
-    ctx.command("my-uid").action(({ session }) => session.uid);
-    ctx.command("my-cid").action(({ session }) => session.cid);
+    ctx.command("my-gid").action(
+      ({ session }) => detectControl(featureControl, session.guildId, "myId") ? session.gid : ""
+    );
+    ctx.command("my-uid").action(
+      ({ session }) => detectControl(featureControl, session.guildId, "myId") ? session.uid : ""
+    );
+    ctx.command("my-cid").action(
+      ({ session }) => detectControl(featureControl, session.guildId, "myId") ? session.cid : ""
+    );
   }
   if (cfg.searchExchangeRate) {
     ctx.command("查汇率 <exchangeParam:text>").usage("查询当前汇率").example("查汇率 JPY : 查询日元兑换人民币的汇率(3位字母)").example("查汇率 JPYCNY : 查询日元兑换人民币的汇率(6位字母)").example("查汇率 -r avdzk2 : 查询日元兑换人民币的汇率(msn代码avdzk2)").example(
       "查汇率 -r auvwoc : 查询黄金的价格(msn代码auvwoc, 很怪吧我也不知道为什么是这个)"
     ).option("raw", "-r <raw:string>").action(async ({ session, options }, exchangeParam) => {
-      if (ctx.skia && detectControl(controlJson, session.guildId, "exchangeRate")) {
+      if (ctx.skia && detectControl(featureControl, session.guildId, "exchangeRate")) {
         return await getExchangeRate(
           ctx,
           cfg,
@@ -1541,7 +1587,7 @@ function apply(ctx, cfg) {
   }
   if (cfg.intervalGetExchangeRate) {
     ctx.command("开启汇率推送 [exchangeParam:string]").action(async ({ session }, exchangeParam) => {
-      if (ctx.skia && detectControl(controlJson, session.guildId, "exchangeRate")) {
+      if (ctx.skia && detectControl(featureControl, session.guildId, "exchangeRate")) {
         const exchangeRatePath = import_node_path4.default.join(assetsDir, "exchangeRate.json");
         return await intervalGetExchangeRate(
           ctx,
@@ -1619,7 +1665,7 @@ function apply(ctx, cfg) {
   }
   ctx.middleware(async (session, next) => {
     const elements = session.elements;
-    if (cfg.openRepeat && detectControl(controlJson, session.guildId, "repeat")) {
+    if (cfg.openRepeat && detectControl(featureControl, session.guildId, "repeat")) {
       const content = session.content;
       const ctxArr = repeatContextMap.get(session.gid);
       if (!ctxArr || ctxArr[0] !== content) {
@@ -1631,11 +1677,11 @@ function apply(ctx, cfg) {
         }
       }
     }
-    if (cfg.atNotSay && detectControl(controlJson, session.guildId, "atNotSay"))
+    if (cfg.atNotSay && detectControl(featureControl, session.guildId, "atNotSay"))
       await atNotSayReply(cfg, session, elements);
-    if (cfg.replyBot && detectControl(controlJson, session.guildId, "replyBot"))
+    if (cfg.replyBot && detectControl(featureControl, session.guildId, "replyBot"))
       await replyBot(cfg, session, elements);
-    if (cfg.iLoveYou && detectControl(controlJson, session.guildId, "iLoveYou"))
+    if (cfg.iLoveYou && detectControl(featureControl, session.guildId, "iLoveYou"))
       await iLoveYou(cfg, session, elements);
     return next();
   });

package/lib/utils.d.ts

@@ -91,7 +91,11 @@ export declare function replyBot(cfg: Config, session: Session, elements: h[]):
  * @param elements 当前消息elements
  */
 export declare function iLoveYou(cfg: Config, session: Session, elements: h[]): Promise<void>;
-export declare function parseJsonControl(text: string): FeatureControl | null;
+export declare function parseFeatureControl(array: {
+    functionName: string;
+    whitelist: boolean;
+    groups: string;
+}[]): FeatureControl | null;
 export declare function detectControl(controlJson: FeatureControl, guildId: string, funName: string): boolean;
 export declare function handleRoll(session: Session): string;
 /**

package/package.json

@@ -4,7 +4,7 @@
   "contributors": [
     "StarFreedomX <starfreedomx@outlook.com>"
   ],
-  "version": "0.24.2",
+  "version": "0.25.0",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
   "files": [

package/readme.md

@@ -22,25 +22,26 @@ StarFreedomX机器人的小功能，自用
 * 撤回
 * 汇率推送
 * 黑白名单配置
+* 我的会话信息
 
 ## List to Do
 
-* 修改BanG Dream!边框的绘制为使用sharp等库，加快速度
+* 语录token通过聊天获取，并自动与语录web控制台通信
+* 语录支持bot端添加tag
 
 ## 语录tag可视化控制
 
 详情见[StarFreedomX/image-tag-editor-web: 为starfx-bot的语录功能可视化添加tag](https://github.com/StarFreedomX/image-tag-editor-web)
+
 配置项的imageFolderPath填写Koishi数据文件夹下的/data/starfx-bot/record/
 
 ## 🔧 功能权限控制（可选）
 
 本插件支持为各个功能设置 **群聊白名单 / 黑名单**，用于控制不同功能在指定群聊中是否启用。
 
-配置格式为 JSON
-
-- `whitelist: true`：启用白名单模式，仅允许列出的群使用该功能
-- `whitelist: false`：启用黑名单模式，禁止列出的群使用该功能
-- `groups`：群号数组，必须为数字
+- `whitelist: ✅`：启用白名单模式，仅允许列出的群使用该功能
+- `whitelist: 🟪`：启用黑名单模式，禁止列出的群使用该功能
+- `groups`：群号数组，必须为数字，用半角逗号分隔
 
 若未配置某功能项，则默认所有群均可使用。
 
@@ -68,23 +69,17 @@ StarFreedomX机器人的小功能，自用
 | `sendLocalImage` | 自定义指令发送图片功能(自定义指令也可配置，键为自定义的指令名称)     |
 | `forward`        | 消息转发功能                                |
 | `exchangeRate`   | 汇率播报功能                                |
+| `myId`           | 我的会话信息                                |
 
 ---
 
 ### 🧪 示例：仅允许特定群使用 `roll`，禁止某群使用 `sold`
 
-```json
-{
-  "roll": {
-    "whitelist": true,
-    "groups": [123456789,114514191]
-  },
-  "sold": {
-    "whitelist": false,
-    "groups": [987654321]
-  }
-}
-```
+
+| functionName | whitelist | groups    |
+|--------------|-----------|-----------|
+| roll         | ✅         | 123456789 |
+| sold         | 🟪        | 789456123 |
 
 ## 更新日志
 
@@ -130,3 +125,4 @@ StarFreedomX机器人的小功能，自用
 | `0.24.0`  | build                             |
 | `0.24.1`  | 检测sharp服务，删除无用配置                  |
 | `0.24.2`  | 修复检测逻辑                            |
+| `0.25.0`  | 优化功能控制模块                          |