@zhin.js/adapter-icqq 1.0.71 → 1.1.0

package/schema.json

@@ -0,0 +1,162 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "master": {
+      "type": ["string", "number"],
+      "description": "框架 master QQ uin（/approve、AI/工具权限）；endpoints[i].master 可逐项覆盖"
+    },
+    "trusted": {
+      "type": "array",
+      "items": { "type": ["string", "number"] },
+      "description": "框架 trusted QQ uin 列表（弱于 master）"
+    },
+    "password": {
+      "type": "string",
+      "description": "QQ 密码（可选，不填则扫码登录）"
+    },
+    "platform": {
+      "type": "number",
+      "enum": [1, 2, 3, 4, 5, 6, 7],
+      "default": 1,
+      "description": "登录设备平台：1=Android, 2=aPad, 3=Watch, 4=iMac, 5=iPad, 6=Tim, 7=Custom"
+    },
+    "ver": {
+      "type": "string",
+      "description": "协议版本号，仅在对应 platform 有多个版本时有效，不填则使用最新版本"
+    },
+    "signApiAddr": {
+      "type": "string",
+      "description": "签名服务器地址；未配置时若安装了 @icqqjs/qqsign 则自动使用本地签名"
+    },
+    "dataDir": {
+      "type": "string",
+      "description": "数据存储文件夹路径，默认为主模块下的 data 文件夹"
+    },
+    "autoReconnect": {
+      "type": "boolean",
+      "default": true,
+      "description": "断线后是否自动重连（默认 true）"
+    },
+    "outboundMedia": {
+      "type": "string",
+      "enum": ["file", "base64"],
+      "default": "file",
+      "description": "出站媒体模式：file=落盘本地路径（默认）; base64=CQ base64:// 内联"
+    },
+    "ignoreSelf": {
+      "type": "boolean",
+      "default": true,
+      "description": "群聊和频道中是否过滤自己的消息（默认 true）"
+    },
+    "resend": {
+      "type": "boolean",
+      "default": false,
+      "description": "被风控时是否尝试用分片发送（默认 false）"
+    },
+    "cacheGroupMember": {
+      "type": "boolean",
+      "default": true,
+      "description": "是否缓存群员列表（默认 true）；群多时（500+）会多占约 100MB+ 内存"
+    },
+    "autoServer": {
+      "type": "boolean",
+      "default": true,
+      "description": "是否自动选择最优服务器（默认 true）"
+    },
+    "qqnt": {
+      "type": "boolean",
+      "default": true,
+      "description": "是否使用 QQNT 协议（默认 true）"
+    },
+    "ntLogin": {
+      "type": "boolean",
+      "description": "是否使用 NT 登录方式"
+    },
+    "endpoints": {
+      "type": "array",
+      "description": "多账号：一个插件实例挂多个 endpoint。每项与顶层字段同构（id 必填，其余覆盖顶层）",
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "QQ uin"
+          },
+          "master": {
+            "type": ["string", "number"],
+            "description": "本 endpoint 的 master QQ uin；覆盖顶层 master"
+          },
+          "trusted": {
+            "type": "array",
+            "items": { "type": ["string", "number"] },
+            "description": "本 endpoint 的 trusted 列表"
+          },
+          "password": {
+            "type": "string",
+            "description": "本 endpoint 的 QQ 密码"
+          },
+          "platform": {
+            "type": "number",
+            "enum": [1, 2, 3, 4, 5, 6, 7],
+            "description": "登录设备平台：1=Android, 2=aPad, 3=Watch, 4=iMac, 5=iPad, 6=Tim, 7=Custom"
+          },
+          "ver": {
+            "type": "string",
+            "description": "协议版本号"
+          },
+          "signApiAddr": {
+            "type": "string",
+            "description": "签名服务器地址"
+          },
+          "dataDir": {
+            "type": "string",
+            "description": "数据存储文件夹路径"
+          },
+          "autoReconnect": {
+            "type": "boolean",
+            "description": "断线后是否自动重连"
+          },
+          "outboundMedia": {
+            "type": "string",
+            "enum": ["file", "base64"],
+            "description": "出站媒体模式"
+          },
+          "ignoreSelf": {
+            "type": "boolean",
+            "description": "是否过滤自己的消息"
+          },
+          "resend": {
+            "type": "boolean",
+            "description": "被风控时是否分片发送"
+          },
+          "cacheGroupMember": {
+            "type": "boolean",
+            "description": "是否缓存群员列表"
+          },
+          "autoServer": {
+            "type": "boolean",
+            "description": "是否自动选择最优服务器"
+          },
+          "qqnt": {
+            "type": "boolean",
+            "description": "是否使用 QQNT 协议"
+          },
+          "ntLogin": {
+            "type": "boolean",
+            "description": "是否使用 NT 登录方式"
+          }
+        },
+        "required": ["id"]
+      }
+    },
+    "commandPrefix": {
+      "type": "string",
+      "default": "",
+      "description": "命令前缀（默认 '' 无前缀）。endpoints[i] 可逐项覆盖"
+    }
+  },
+  "required": ["master", "endpoints"]
+}

package/src/client.ts

@@ -0,0 +1,29 @@
+import type { Client, EventMap } from '@icqqjs/icqq';
+import { defineEndpointClient } from 'zhin.js/adapter';
+
+type EventPayload<TListener> = TListener extends (
+  event: infer TEvent,
+  ...rest: readonly unknown[]
+) => unknown
+  ? TEvent
+  : never;
+
+/** The actual ICQQ SDK instance exposed by every ICQQ Endpoint event. */
+export type IcqqClient = Client;
+
+/** Native ICQQ event-name → first public event payload, derived from the SDK SSOT. */
+export type IcqqClientEventMap = {
+  readonly [TName in keyof EventMap]: EventPayload<EventMap[TName]>;
+};
+
+declare module '@zhin.js/feature-kit' {
+  interface AdapterClientRegistry {
+    readonly icqq: {
+      readonly client: IcqqClient;
+      readonly events: IcqqClientEventMap;
+    };
+  }
+}
+
+/** Typed, generation-checked identity used by handlers, commands, tools and schedules. */
+export const icqqClient = defineEndpointClient<IcqqClient, IcqqClientEventMap>('icqq');

package/src/cq-message.ts

@@ -0,0 +1,113 @@
+/** ICQQ 历史文本视图 → canonical MessageSegment。出站只使用原生 Sendable。 */
+import { isMediaRef, type MediaRef } from "@zhin.js/core";
+import type { MessageSegment } from "zhin.js";
+
+const MAX_CQ_PARSE_LEN = 256_000;
+
+/**
+ * CQ 媒体参数 / 入站元素媒体值 → canonical MediaRef：
+ * `base64://` → base64；http(s) → url；本机路径 → path；其余视为平台不透明引用（file）。
+ */
+export function icqqMediaRefFromString(value: string): MediaRef {
+  if (value.startsWith("base64://")) {
+    return { kind: "base64", value: value.slice("base64://".length) };
+  }
+  if (value.startsWith("http://") || value.startsWith("https://")) {
+    return { kind: "url", value };
+  }
+  if (value.startsWith("/") || /^[a-zA-Z]:[\\/]/.test(value)) {
+    return { kind: "path", value };
+  }
+  return { kind: "file", value };
+}
+
+/**
+ * canonical MediaRef（`data.media`，唯一媒体来源）→ ICQQ native
+ * element 的 file 参数。base64 使用 ICQQ 原生支持的 `base64://` 前缀。
+ */
+export function resolveIcqqMediaFile(
+  data: Record<string, unknown> | undefined,
+): string | undefined {
+  const media = data?.media;
+  if (!isMediaRef(media)) return undefined;
+  if (media.kind === "base64") {
+    return media.value.startsWith("base64://") ? media.value : `base64://${media.value}`;
+  }
+  return media.value;
+}
+
+function pushCqSegment(segments: MessageSegment[], type: string, arg: string): void {
+  switch (type) {
+    case "face":
+      segments.push({ type: "face", data: { id: Number(arg) } });
+      break;
+    case "image":
+      segments.push({ type: "image", data: { media: icqqMediaRefFromString(arg) } });
+      break;
+    case "at":
+      if (arg === "all") {
+        segments.push({ type: "at", data: { qq: "all" } });
+      } else {
+        segments.push({ type: "at", data: { qq: arg } });
+      }
+      break;
+    case "dice":
+      segments.push({ type: "dice", data: {} });
+      break;
+    case "rps":
+      segments.push({ type: "rps", data: {} });
+      break;
+    case "record":
+    case "audio":
+      segments.push({ type: "audio", data: { media: icqqMediaRefFromString(arg) } });
+      break;
+    case "video":
+      segments.push({ type: "video", data: { media: icqqMediaRefFromString(arg) } });
+      break;
+    case "reply":
+      segments.push({ type: "reply", data: { message_id: arg } });
+      break;
+    case "json":
+      segments.push({ type: "json", data: { text: arg } });
+      break;
+    default:
+      segments.push({ type, data: { text: `[${type}:${arg}]` } });
+      break;
+  }
+}
+
+export function parseCqMessage(raw: string): MessageSegment[] {
+  const text = raw.length > MAX_CQ_PARSE_LEN ? raw.slice(0, MAX_CQ_PARSE_LEN) : raw;
+  const segments: MessageSegment[] = [];
+  let i = 0;
+
+  while (i < text.length) {
+    if (text[i] !== "[") {
+      const next = text.indexOf("[", i);
+      const chunk = next === -1 ? text.slice(i) : text.slice(i, next);
+      if (chunk) segments.push({ type: "text", data: { text: chunk } });
+      if (next === -1) break;
+      i = next;
+      continue;
+    }
+
+    const close = text.indexOf("]", i + 1);
+    if (close === -1) {
+      segments.push({ type: "text", data: { text: text.slice(i) } });
+      break;
+    }
+
+    const inner = text.slice(i + 1, close);
+    const colon = inner.indexOf(":");
+    const type = (colon === -1 ? inner : inner.slice(0, colon)).trim().toLowerCase();
+    const arg = colon === -1 ? "" : inner.slice(colon + 1);
+    if (/^[a-z_]+$/.test(type)) {
+      pushCqSegment(segments, type, arg);
+    } else {
+      segments.push({ type: "text", data: { text: text.slice(i, close + 1) } });
+    }
+    i = close + 1;
+  }
+
+  return segments.length ? segments : [{ type: "text", data: { text: raw } }];
+}