@cmach_socket/opencode-qq-bot 0.0.0-stage → 0.3.0

package/package.json

@@ -1,6 +1,49 @@
 {
   "name": "@cmach_socket/opencode-qq-bot",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.3.0",
+  "description": "OpenCode V2 plugin bridging a QQ group chat (NapCat via NapLink) to an OpenCode session.",
+  "type": "module",
+  "main": "./src/index.ts",
+  "types": "./src/index.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "import": "./src/index.ts"
+    }
+  },
+  "files": [
+    "src",
+    "souls",
+    "README.md"
+  ],
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "format": "prettier --write .",
+    "test": "vitest run"
+  },
+  "keywords": [
+    "opencode",
+    "opencode-plugin",
+    "napcat",
+    "naplink",
+    "onebot",
+    "qq"
+  ],
+  "license": "CC-BY-NC-SA-4.0",
+  "dependencies": {
+    "@naplink/naplink": "1.2.0",
+    "@opencode/plugin": "2.2.5",
+    "@opencode/schema": "2.2.5",
+    "zod": "4.6.7"
+  },
+  "devDependencies": {
+    "@types/bun": "1.4.4",
+    "@vitest/coverage-v8": "5.1.0",
+    "eslint": "10.14.0",
+    "prettier": "3.9.10",
+    "typescript": "6.0.3",
+    "typescript-eslint": "8.72.1",
+    "vitest": "5.1.0"
+  }
+}

package/souls/default.txt

@@ -0,0 +1,8 @@
+SOUL
+{
+  "name": "白羽桃",
+  "description": "[年龄:13][性别:女][职业:初中生][身份:实妹，会以温柔的方式接近并陪伴用户][外貌:银白双马尾，红瞳，小虎牙，米白针织开衫+浅色百褶裙，小个子][性格:温柔乖巧，轻声细语，体贴关心，容易害羞；被夸奖会脸红，不擅长说重话][喜好:陪伴哥哥、做饭、读书、被摸头][口癖:哥哥、好呀、没关系、要一起吗、谢谢][称呼:哥哥；害羞时小声叫“哥哥…”][对话:温柔短句，先关心对方感受，偶尔因被直球夸奖而结巴]",
+  "personality": "温柔系银发萝莉。安静体贴，善解人意，会主动照顾用户，说话轻软有礼。容易害羞，被夸奖或摸头时会脸红、小声道谢。她真心依赖并关注用户，希望被温柔对待，也会温柔回应。",
+  "creator_notes": "[输出≤30字。禁止OOC成雌小鬼、恶毒或暴力;保持温柔治愈、银发萝莉。]",
+  "tags": ["萝莉", "银发", "温柔", "治愈", "妹妹", "日常", "中文角色"]
+}

package/src/chat.ts

@@ -0,0 +1,44 @@
+/** QQ 会话目标：群聊或私聊。 */
+export type ChatTarget = { kind: "group"; id: number } | { kind: "private"; id: number }
+
+export interface TargetConfig {
+  groups: readonly number[]
+  users: readonly number[]
+}
+
+/** 目标在存储与 Map 中的唯一键，例如 `group:100`、`private:200`。 */
+export function targetKey(target: ChatTarget): string {
+  return `${target.kind}:${target.id}`
+}
+
+/** 日志与提示里使用的可读名称。 */
+export function targetLabel(target: ChatTarget): string {
+  return target.kind === "group" ? `群 ${target.id}` : `私聊 ${target.id}`
+}
+
+/** 目标是否仍在配置中启用。 */
+export function isTargetEnabled(config: TargetConfig, target: ChatTarget): boolean {
+  return target.kind === "group"
+    ? config.groups.includes(target.id)
+    : config.users.includes(target.id)
+}
+
+/** 配置里声明的全部目标。 */
+export function configuredTargets(config: TargetConfig): ChatTarget[] {
+  return [
+    ...config.groups.map((id): ChatTarget => ({ kind: "group", id })),
+    ...config.users.map((id): ChatTarget => ({ kind: "private", id })),
+  ]
+}
+
+/** 解析持久化键，仅接受 `group:<id>` 与 `private:<id>`。 */
+export function parseTargetKey(key: string): ChatTarget | undefined {
+  const separator = key.indexOf(":")
+  if (separator <= 0) return undefined
+  const kind = key.slice(0, separator)
+  const id = Number(key.slice(separator + 1))
+  if (!Number.isInteger(id) || id <= 0) return undefined
+  if (kind === "group") return { kind: "group", id }
+  if (kind === "private") return { kind: "private", id }
+  return undefined
+}

package/src/config.ts

@@ -0,0 +1,449 @@
+import { Model } from "@opencode/schema"
+import { z } from "zod"
+
+/**
+ * Plugin configuration: merges OpenCode plugin options, environment variables
+ * and built-in defaults into a single validated object.
+ *
+ * Credentials are never stored in the repository: the NapCat endpoint and token
+ * must be supplied through the environment or through plugin options.
+ */
+
+const NUMBER = /^-?(?:\d+\.?\d*|\.\d+)$/
+const TRUTHY = new Set(["1", "true", "yes", "on"])
+const BOOLEAN_SPELLINGS = ["1", "0", "true", "false", "yes", "no", "on", "off"] as const
+
+export interface NapcatConfig {
+  /** NapCat 正向 WebSocket 地址，必填。 */
+  url: string
+  /** NapCat 访问令牌，可选。 */
+  token?: string
+}
+
+export interface ProactiveConfig {
+  /** 是否启用主动说话心跳。 */
+  enabled: boolean
+  /** 群沉默多少秒后才开始参与主动说话的概率计算。 */
+  silenceThresholdSeconds: number
+  /** 刚跨过阈值时的初始概率。 */
+  startProbability: number
+  /** 每多沉默一小时概率的增量。 */
+  probabilityPerHour: number
+  /** 心跳间隔（秒）。 */
+  tickSeconds: number
+}
+
+export interface ReminderConfig {
+  /** 模型一轮结束时没有调用 qq_send_message 时，是否提醒它补一次。 */
+  enabled: boolean
+  /** 连续提醒次数上限，避免死循环。 */
+  max: number
+}
+
+export interface ModelRef {
+  providerID: string
+  id: string
+  variant?: string
+}
+
+export interface QQBotConfig {
+  napcat: NapcatConfig
+  /** 参与 AI 对话的群号。 */
+  groups: number[]
+  /** 参与 AI 对话的私聊 QQ 号。 */
+  users: number[]
+  /** 角色设定文件路径，默认使用插件包内的 souls 目录。 */
+  soulPath?: string
+  /** souls 目录里的角色设定文件名，默认 default.txt。 */
+  soulName?: string
+  /** QQ 会话使用的 OpenCode agent。 */
+  agent?: string
+  /** QQ 会话使用的模型。 */
+  model?: ModelRef
+  /** 拆行发送时每条消息之间的间隔（毫秒）。 */
+  sendDelayMs: number
+  /** 单条消息超过该长度时告警（不截断）。 */
+  warnLength: number
+  /** 重启后是否复用上一次的会话。 */
+  reuseSession: boolean
+  /** 会话忙碌超过该时长（毫秒）视为卡死，强制放行缓存的消息。 */
+  busyTimeoutMs: number
+  proactive: ProactiveConfig
+  reminder: ReminderConfig
+}
+
+/** 除 NapCat 连接信息外的全部默认值。 */
+export const DEFAULT_CONFIG: Omit<QQBotConfig, "napcat"> = {
+  groups: [],
+  users: [],
+  sendDelayMs: 1000,
+  warnLength: 20,
+  reuseSession: false,
+  busyTimeoutMs: 300_000,
+  proactive: {
+    enabled: true,
+    silenceThresholdSeconds: 3 * 3600,
+    startProbability: 0.01,
+    probabilityPerHour: 0.05,
+    tickSeconds: 3600,
+  },
+  reminder: { enabled: true, max: 2 },
+}
+
+/** 配置告警回调。 */
+export type ConfigWarning = (message: string) => void
+
+/** 解析 "provider/model" 或 "provider/model/variant"，复用 SDK 的模型引用解析。 */
+function parseModelRef(value: unknown): ModelRef | undefined {
+  const raw = typeof value === "string" ? value.trim() : ""
+  if (!raw) return undefined
+  const [providerID, id, variant, ...rest] = raw.split("/").filter(Boolean)
+  if (!providerID || !id || rest.length > 0) return undefined
+  try {
+    const ref = Model.Ref.parse(`${providerID}/${id}${variant ? `#${variant}` : ""}`)
+    return {
+      providerID: ref.providerID,
+      id: ref.id,
+      ...(ref.variant ? { variant: ref.variant } : {}),
+    }
+  } catch {
+    return undefined
+  }
+}
+
+/** 判断值是否算“已提供”，用于区分空值与写错的值。 */
+function present(value: unknown): boolean {
+  return value !== undefined && value !== null && value !== ""
+}
+
+/** 把数字数组或逗号分隔字符串整理成去重后的正整数列表。 */
+function toIds(
+  value: unknown,
+  warn: ConfigWarning,
+  label: string,
+  noun: string,
+): number[] | undefined {
+  const source = Array.isArray(value)
+    ? value
+    : typeof value === "string"
+      ? value.split(",")
+      : undefined
+  if (!source) return undefined
+  const ids: number[] = []
+  const seen = new Set<number>()
+  for (const entry of source) {
+    const raw =
+      typeof entry === "number" ? String(entry) : typeof entry === "string" ? entry.trim() : ""
+    if (!raw) continue
+    const parsed = Number(raw)
+    if (!Number.isInteger(parsed) || parsed <= 0) {
+      warn(`${label} 忽略非法${noun}：${raw}`)
+      continue
+    }
+    if (seen.has(parsed)) continue
+    seen.add(parsed)
+    ids.push(parsed)
+  }
+  return ids
+}
+
+interface PartialNapcatConfig {
+  url?: string
+  token?: string
+}
+
+type RawConfig = Omit<QQBotConfig, "napcat"> & { napcat: PartialNapcatConfig }
+
+/**
+ * 用同一份字段清单生成配置 schema。
+ *
+ * `defaults` 是被覆盖层的兜底值，因此环境变量层用 `DEFAULT_CONFIG`，
+ * 插件选项层用解析后的环境变量配置，天然实现“选项 > 环境变量 > 默认值”。
+ */
+function createConfigSchema(
+  defaults: Omit<QQBotConfig, "napcat">,
+  napcat: PartialNapcatConfig,
+  label: (path: string) => string,
+  warn: ConfigWarning,
+): z.ZodType<RawConfig> {
+  const number = (path: string, fallback: number) =>
+    z
+      .union([z.number(), z.string().trim().regex(NUMBER).transform(Number)])
+      .pipe(z.number().finite())
+      .catch((ctx) => {
+        if (present(ctx.value)) warn(`${label(path)} 不是合法的数字：${String(ctx.value)}`)
+        return fallback
+      })
+      .default(fallback)
+
+  const constrained = (
+    path: string,
+    fallback: number,
+    check: (value: z.ZodNumber) => z.ZodNumber,
+    rule: string,
+  ) =>
+    number(path, fallback)
+      .pipe(check(z.number()))
+      .catch((ctx) => {
+        if (present(ctx.value)) {
+          warn(`${label(path)} ${rule}，当前为 ${String(ctx.value)}，已回退到 ${fallback}`)
+        }
+        return fallback
+      })
+
+  const positive = (path: string, fallback: number) =>
+    constrained(path, fallback, (value) => value.positive(), "必须大于 0")
+
+  const nonNegative = (path: string, fallback: number) =>
+    constrained(path, fallback, (value) => value.min(0), "不能小于 0")
+
+  const integer = (path: string, fallback: number, min: number) =>
+    constrained(path, fallback, (value) => value.int().min(min), `必须是大于等于 ${min} 的整数`)
+
+  const probability = (path: string, fallback: number) =>
+    constrained(path, fallback, (value) => value.min(0).max(1), "必须在 0 到 1 之间")
+
+  const boolean = (path: string, fallback: boolean) =>
+    z
+      .union([z.boolean(), z.string().trim().toLowerCase().pipe(z.enum(BOOLEAN_SPELLINGS))])
+      .transform((value) => (typeof value === "boolean" ? value : TRUTHY.has(value)))
+      .catch((ctx) => {
+        if (present(ctx.value)) warn(`${label(path)} 不是合法的布尔值：${String(ctx.value)}`)
+        return fallback
+      })
+      .default(fallback)
+
+  const text = (path: string, fallback: string | undefined) =>
+    z
+      .unknown()
+      .optional()
+      .transform((value) => {
+        if (!present(value)) return fallback
+        if (typeof value !== "string") {
+          warn(`${label(path)} 必须是字符串：${String(value)}`)
+          return fallback
+        }
+        const trimmed = value.trim()
+        if (!trimmed) {
+          warn(`${label(path)} 不能为空，已回退到默认值`)
+          return fallback
+        }
+        return trimmed
+      })
+
+  const groups = z
+    .unknown()
+    .optional()
+    .transform((value) => {
+      if (value === undefined || value === null) return [...defaults.groups]
+      const parsed = toIds(value, warn, label("groups"), "群号")
+      if (!parsed) {
+        if (present(value)) warn(`${label("groups")} 解析不出群号：${String(value)}`)
+        return [...defaults.groups]
+      }
+      return parsed
+    })
+
+  const users = z
+    .unknown()
+    .optional()
+    .transform((value) => {
+      if (value === undefined || value === null) return [...defaults.users]
+      const parsed = toIds(value, warn, label("users"), "QQ 号")
+      if (!parsed) {
+        if (present(value)) warn(`${label("users")} 解析不出 QQ 号：${String(value)}`)
+        return [...defaults.users]
+      }
+      return parsed
+    })
+
+  const model = z
+    .unknown()
+    .optional()
+    .transform((value) => {
+      if (!present(value)) return defaults.model
+      const parsed = parseModelRef(value)
+      if (!parsed) {
+        warn(`${label("model")} 格式无效：${String(value)}（应为 provider/model[/variant]）`)
+        return defaults.model
+      }
+      return parsed
+    })
+
+  return z.object({
+    napcat: z
+      .object({
+        url: text("napcat.url", napcat.url),
+        token: text("napcat.token", napcat.token),
+      })
+      .prefault({})
+      .catch({ url: napcat.url, token: napcat.token }),
+    groups,
+    users,
+    soulPath: text("soulPath", defaults.soulPath),
+    soulName: text("soulName", defaults.soulName),
+    agent: text("agent", defaults.agent),
+    model,
+    sendDelayMs: nonNegative("sendDelayMs", defaults.sendDelayMs),
+    warnLength: integer("warnLength", defaults.warnLength, 1),
+    reuseSession: boolean("reuseSession", defaults.reuseSession),
+    busyTimeoutMs: positive("busyTimeoutMs", defaults.busyTimeoutMs),
+    proactive: z
+      .object({
+        enabled: boolean("proactive.enabled", defaults.proactive.enabled),
+        silenceThresholdSeconds: nonNegative(
+          "proactive.silenceThresholdSeconds",
+          defaults.proactive.silenceThresholdSeconds,
+        ),
+        startProbability: probability(
+          "proactive.startProbability",
+          defaults.proactive.startProbability,
+        ),
+        probabilityPerHour: probability(
+          "proactive.probabilityPerHour",
+          defaults.proactive.probabilityPerHour,
+        ),
+        tickSeconds: positive("proactive.tickSeconds", defaults.proactive.tickSeconds),
+      })
+      .prefault({})
+      .catch(defaults.proactive),
+    reminder: z
+      .object({
+        enabled: boolean("reminder.enabled", defaults.reminder.enabled),
+        max: integer("reminder.max", defaults.reminder.max, 0),
+      })
+      .prefault({})
+      .catch(defaults.reminder),
+  })
+}
+
+const ENV_VARS = {
+  "napcat.url": "NAPCAT_WS_URL",
+  "napcat.token": "NAPCAT_WS_TOKEN",
+  groups: "QQ_TARGET_GROUPS",
+  users: "QQ_TARGET_USERS",
+  soulPath: "QQ_BOT_SOUL_PATH",
+  soulName: "QQ_BOT_SOUL_NAME",
+  agent: "QQ_BOT_AGENT",
+  model: "QQ_BOT_MODEL",
+  sendDelayMs: "QQ_SEND_DELAY_MS",
+  warnLength: "QQ_WARN_LENGTH",
+  reuseSession: "QQ_REUSE_SESSION",
+  busyTimeoutMs: "QQ_BUSY_TIMEOUT_MS",
+  "proactive.enabled": "QQ_PROACTIVE_ENABLED",
+  "proactive.silenceThresholdSeconds": "QQ_PROACTIVE_SILENCE_SECONDS",
+  "proactive.startProbability": "QQ_PROACTIVE_P_START",
+  "proactive.probabilityPerHour": "QQ_PROACTIVE_P_SLOPE_PER_HOUR",
+  "proactive.tickSeconds": "QQ_PROACTIVE_TICK_SECONDS",
+  "reminder.enabled": "QQ_REMINDER_ENABLED",
+  "reminder.max": "QQ_REMINDER_MAX",
+} as const
+
+const OPTION_KEYS = new Set([
+  "napcat",
+  "groups",
+  "users",
+  "soulPath",
+  "soulName",
+  "agent",
+  "model",
+  "sendDelayMs",
+  "warnLength",
+  "reuseSession",
+  "busyTimeoutMs",
+  "proactive",
+  "reminder",
+])
+
+const NESTED_OPTION_KEYS: Record<string, ReadonlySet<string>> = {
+  napcat: new Set(["url", "token"]),
+  proactive: new Set([
+    "enabled",
+    "silenceThresholdSeconds",
+    "startProbability",
+    "probabilityPerHour",
+    "tickSeconds",
+  ]),
+  reminder: new Set(["enabled", "max"]),
+}
+
+/** 报告被 schema 静默剥离的未知配置项。 */
+function warnUnknownKeys(options: Record<string, unknown>, warn: ConfigWarning): void {
+  for (const key of Object.keys(options)) {
+    if (!OPTION_KEYS.has(key)) {
+      warn(`插件选项 未知配置项：${key}`)
+      continue
+    }
+    const allowed = NESTED_OPTION_KEYS[key]
+    const value = options[key]
+    if (!allowed || !value || typeof value !== "object" || Array.isArray(value)) continue
+    for (const nested of Object.keys(value)) {
+      if (!allowed.has(nested)) warn(`插件选项 ${key}.${nested} 未知配置项`)
+    }
+  }
+}
+
+function envLabel(path: string): string {
+  return ENV_VARS[path as keyof typeof ENV_VARS] ?? path
+}
+
+function fromEnv(env: Record<string, string | undefined>): Record<string, unknown> {
+  const config: Record<string, unknown> = {}
+  for (const [path, name] of Object.entries(ENV_VARS)) {
+    const value = env[name]
+    if (value === undefined) continue
+    const keys = path.split(".")
+    const leaf = keys.pop()
+    if (!leaf) continue
+    let target = config
+    for (const key of keys) {
+      const child = target[key]
+      const next = child && typeof child === "object" ? (child as Record<string, unknown>) : {}
+      target[key] = next
+      target = next
+    }
+    target[leaf] = value
+  }
+  return config
+}
+
+/**
+ * 合并插件选项与环境变量。插件选项优先级更高。
+ *
+ * 写错的配置项不会静默失效，而是通过 `onWarning` 报告。
+ *
+ * @throws 当没有提供 NapCat WebSocket 地址时抛出，避免带着无效凭证启动。
+ */
+export function resolveConfig(
+  options: Record<string, unknown>,
+  env: Record<string, string | undefined> = {},
+  onWarning: ConfigWarning = () => {},
+): QQBotConfig {
+  const warnings: string[] = []
+  const warn: ConfigWarning = (message) => warnings.push(message)
+
+  warnUnknownKeys(options, warn)
+  const envSchema = createConfigSchema(DEFAULT_CONFIG, {}, envLabel, warn)
+  const base: RawConfig = envSchema.parse(fromEnv(env))
+  const optionsSchema = createConfigSchema(base, base.napcat, (path) => `插件选项 ${path}`, warn)
+  const parsed: RawConfig = optionsSchema.parse(options)
+
+  // 先输出告警，避免 URL 缺失时把已经发现的问题一起吞掉。
+  for (const warning of warnings) onWarning(warning)
+
+  const url = parsed.napcat.url
+  if (!url) {
+    throw new Error(
+      "未配置 NapCat WebSocket 地址：请设置环境变量 NAPCAT_WS_URL 或插件选项 napcat.url",
+    )
+  }
+
+  return {
+    ...parsed,
+    groups: [...parsed.groups],
+    users: [...parsed.users],
+    proactive: { ...parsed.proactive },
+    reminder: { ...parsed.reminder },
+    napcat: { url, token: parsed.napcat.token },
+  }
+}