@tencent-weixin/openclaw-weixin-cli 1.0.3 → 2.1.1

package/README.md

@@ -0,0 +1,195 @@
+# openclaw-weixin-installer
+
+OpenClaw 微信消息通道插件的统一安装器。自动检测宿主 OpenClaw 版本，安装兼容的插件版本。
+
+## 快速开始
+
+```bash
+npx -y @tencent-weixin/openclaw-weixin-cli install
+```
+
+安装器会自动完成以下步骤：
+1. 检测本地 `openclaw --version`
+2. 根据兼容矩阵选择合适的插件版本（dist-tag）
+3. 调用 `openclaw plugins install` 安装对应版本
+4. 引导扫码连接微信
+5. 重启 OpenClaw Gateway
+
+**无需手动指定版本号。**
+
+## 兼容矩阵
+
+| openclaw-weixin | 支持的 OpenClaw       | dist-tag                              | 说明                 |
+|-----------------|-----------------------|---------------------------------------|----------------------|
+| 1.0.x           | >=2026.3.0 <2026.3.22 | `compat-host-gte2026.3.0-lt2026.3.22` | 兼容轨道             |
+| 2.0.x           | >=2026.3.22           | `latest`                              | 当前推荐主线         |
+
+> 从 2.0.0 开始，插件采用独立 semver 版本号，不再对齐宿主 OpenClaw 版本号。
+
+## 手动安装
+
+如果需要手动指定版本，可以直接使用 openclaw 命令：
+
+```bash
+# 查看当前 OpenClaw 版本
+openclaw --version
+
+# 当前推荐主线 (>=2026.3.22)
+openclaw plugins install @tencent/openclaw-weixin@latest
+
+# 兼容轨道 (<2026.3.22)
+openclaw plugins install @tencent/openclaw-weixin@compat-host-gte2026.3.0-lt2026.3.22
+```
+
+## 运行时版本校验
+
+插件在启动时会自动检查宿主版本兼容性。如果版本不匹配，将立即抛出错误：
+
+```
+[openclaw-weixin] 宿主版本不兼容!
+  当前 OpenClaw 版本: 2026.3.10
+  当前插件支持范围:   >=2026.3.22
+  请安装 openclaw-weixin@compat-host-gte2026.3.0-lt2026.3.22
+  或运行: npx @tencent-weixin/openclaw-weixin-cli install (自动选择兼容版本)
+```
+
+## 故障排查
+
+### 宿主版本不兼容
+
+**症状**：插件启动时报 `宿主版本不兼容` 错误。
+
+**解决**：
+```bash
+# 1. 确认 OpenClaw 版本
+openclaw --version
+
+# 2. 用统一安装器重新安装（自动匹配版本）
+npx -y @tencent-weixin/openclaw-weixin-cli install
+```
+
+### 如何查看当前 openclaw 版本
+
+```bash
+openclaw --version
+```
+
+## 发布策略
+
+### 本仓库（CLI installer）与插件仓库的关系
+
+本仓库发布的是 **CLI 安装器**（`openclaw-weixin-cli`），不是插件本身（`openclaw-weixin`）。
+
+- **插件仓库**：openclaw-weixin，通过各分支发布到不同的 npm dist-tag
+- **本仓库**：CLI 安装器，根据 `COMPAT_MATRIX` 自动选择正确的插件 dist-tag 来安装
+
+### 分支管理规则
+
+内网和外网通过不同分支管理，prerelease 分支从主分支拉出，合并回主分支：
+
+| 分支 | 用途 | package.json 状态 |
+|------|------|------------------|
+| `master-prerelease` | 日常开发 + 内网发布 | 内网发布后保持内网包名和版本 |
+| `master` | 外网发布 | 外网发布后保持外网包名和版本 |
+
+**核心原则：**
+- 日常开发和内网发布在 `-prerelease` 分支上进行
+- 需要发外网时，将 prerelease 分支合入对应主分支，再在主分支上发布
+- 发布后 package.json **不回退**，分支保持对应环境的最新发布状态
+- prerelease 和主分支同构（共用 `publish.config.json`），合并时自然更新
+
+### CLI 发布命令
+
+```bash
+# 在 prerelease 分支上发布内网
+node scripts/publish.mjs internal patch
+
+# dry run 预检
+node scripts/publish.mjs internal patch --dry-run
+```
+
+发布脚本会：
+1. 检查工作区是否干净
+2. 将 `package.json` 的 name/version 和 `cli.mjs` 的 PLUGIN_SPEC 替换为目标环境的值
+3. 更新 `publish.config.json` 中对应目标的版本号
+4. 提交 release commit 并打 git tag
+5. npm publish
+6. push commit + tag
+
+发布后 package.json 保持发布态，不回退。如果 npm publish 失败，自动回滚 release commit 和 tag。
+
+### 内网验证后发外网
+
+```bash
+# ① 在 prerelease 分支上完成内网发布和验证
+
+# ② 合入主分支
+git checkout master
+git merge master-prerelease
+
+# ③ 在主分支上发布外网
+node scripts/publish.mjs external patch
+```
+
+### 兼容轨道发版流程
+
+当 openclaw 发布破坏兼容性的新版本时：
+
+#### 1. 插件仓库操作（openclaw-weixin）
+
+```bash
+# 从当前分支拉出兼容轨道
+git checkout -b compat-host-gteX.Y.Z-ltA.B.C-prerelease master-prerelease
+git checkout -b compat-host-gteX.Y.Z-ltA.B.C master
+# 修改 compat 分支上的 publish.config.json，将 npmTag 改为轨道名
+
+# master-prerelease 上适配新宿主，major + 1
+```
+
+#### 2. CLI 仓库操作（本仓库）
+
+```bash
+# ① 更新 lib/compat.mjs 的 COMPAT_MATRIX
+
+# ② 在 prerelease 分支上发布内网验证
+node scripts/publish.mjs internal minor
+
+# ③ 验证后合入主分支发外网
+git checkout master && git merge master-prerelease
+node scripts/publish.mjs external minor
+```
+
+#### 3. 验证清单
+
+- [ ] `npx @tencent/openclaw-weixin-cli install` 在旧宿主上安装兼容轨道版本
+- [ ] `npx @tencent/openclaw-weixin-cli install` 在新宿主上安装 latest 版本
+- [ ] 已安装旧 tag 的用户重跑 CLI 后自动卸载旧版、安装新版
+- [ ] 插件运行时 `version-check.mjs` 报错信息指引正确
+
+### 兼容轨道 bug 修复
+
+```bash
+# ① 在 compat prerelease 分支上修复
+git checkout compat-host-gteX.Y.Z-ltA.B.C-prerelease
+# cherry-pick 或直接修复
+node scripts/publish.mjs internal patch
+
+# ② 需要发外网时合入 compat 主分支
+git checkout compat-host-gteX.Y.Z-ltA.B.C
+git merge compat-host-gteX.Y.Z-ltA.B.C-prerelease
+node scripts/publish.mjs external patch
+
+# ③ 评估是否需要同步到 master 和其他 compat 分支
+```
+
+> CLI 不需要重新发布——同一 dist-tag 下的 patch 更新，用户通过 `openclaw plugins update` 即可获取。
+
+## 开发
+
+```bash
+# 安装开发依赖
+npm install
+
+# 本地测试 install 命令
+node cli.mjs install
+```

package/cli.mjs

@@ -1,9 +1,25 @@
 #!/usr/bin/env node
 
 import { execSync, spawnSync } from "node:child_process";
+import fs from "node:fs";
+import path from "node:path";
+import os from "node:os";
+import {
+  COMPAT_MATRIX,
+  compareVersions,
+  findCompatEntry,
+  formatRange,
+} from "./lib/compat.mjs";
 
 const PLUGIN_SPEC = "@tencent-weixin/openclaw-weixin";
 const CHANNEL_ID = "openclaw-weixin";
+/** Only OpenClaw 2026.3.22–2026.3.23 need node_modules/openclaw symlink for jiti. */
+const SYMLINK_OPENCLAW_MIN = "2026.3.22";
+const SYMLINK_OPENCLAW_MAX = "2026.3.23";
+
+const LEGACY_TAG_ALIASES = {
+  legacy: "compat-host-gte2026.3.0-lt2026.3.22",
+};
 
 // ── helpers ──────────────────────────────────────────────────────────────────
 
@@ -35,6 +51,146 @@ function which(bin) {
   }
 }
 
+// ── version detection ───────────────────────────────────────────────────────
+
+function getOpenclawVersion() {
+  try {
+    const raw = run("openclaw --version");
+    const match = raw.match(/(\d+\.\d+\.\d+)/);
+    return match ? match[1] : null;
+  } catch {
+    return null;
+  }
+}
+
+function selectPluginTag(openclawVersion) {
+  const entry = findCompatEntry(openclawVersion);
+  if (entry) return entry;
+
+  error(`当前 OpenClaw 版本 ${openclawVersion} 不在任何已知兼容范围内`);
+  console.log("\n  已知兼容矩阵:");
+  for (const e of COMPAT_MATRIX) {
+    console.log(`    ${e.label}  →  OpenClaw ${formatRange(e.openclawRange)}`);
+  }
+  console.log();
+  return null;
+}
+
+// ── symlink ──────────────────────────────────────────────────────────────────
+
+/**
+ * Resolve the host openclaw package root from the `openclaw` binary.
+ * e.g. /Users/x/.nvm/versions/node/v22/lib/node_modules/openclaw
+ */
+function resolveHostOpenclawRoot() {
+  const bin = which("openclaw");
+  if (!bin) return null;
+  try {
+    // Follow symlinks to the real binary, then go up to the package root.
+    const real = fs.realpathSync(bin);
+    // binary is at <root>/openclaw.mjs or <root>/dist/index.js etc.
+    // Walk up until we find a package.json with name "openclaw".
+    let dir = path.dirname(real);
+    for (let i = 0; i < 6; i++) {
+      try {
+        const pkg = JSON.parse(fs.readFileSync(path.join(dir, "package.json"), "utf-8"));
+        if (pkg.name === "openclaw") return dir;
+      } catch {}
+      const parent = path.dirname(dir);
+      if (parent === dir) break;
+      dir = parent;
+    }
+  } catch {}
+  return null;
+}
+
+/**
+ * Resolve the plugin extensions directory.
+ * Default: ~/.openclaw/extensions/openclaw-weixin
+ */
+function resolvePluginExtDir() {
+  const stateDir = process.env.OPENCLAW_STATE_DIR || path.join(os.homedir(), ".openclaw");
+  return path.join(stateDir, "extensions", "openclaw-weixin");
+}
+
+/**
+ * Create a symlink from the plugin's node_modules/openclaw to the host
+ * openclaw package root. This lets jiti resolve openclaw/plugin-sdk/*
+ * without openclaw being a runtime dependency.
+ */
+function hostVersionNeedsOpenclawSymlink(hostVersion) {
+  if (!hostVersion) return false;
+  const geMin = compareVersions(hostVersion, SYMLINK_OPENCLAW_MIN);
+  const leMax = compareVersions(hostVersion, SYMLINK_OPENCLAW_MAX);
+  return (
+    !Number.isNaN(geMin) &&
+    !Number.isNaN(leMax) &&
+    geMin >= 0 &&
+    leMax <= 0
+  );
+}
+
+function ensureOpenclawSymlink(hostVersion) {
+  if (!hostVersionNeedsOpenclawSymlink(hostVersion)) {
+    return;
+  }
+
+  const hostRoot = resolveHostOpenclawRoot();
+  if (!hostRoot) {
+    error("无法定位宿主 openclaw 包根目录，跳过 symlink 创建");
+    return;
+  }
+
+  const pluginDir = resolvePluginExtDir();
+  if (!fs.existsSync(pluginDir)) {
+    // Plugin not in extensions dir (might be a -l link install); skip.
+    return;
+  }
+
+  const nmDir = path.join(pluginDir, "node_modules");
+  const linkPath = path.join(nmDir, "openclaw");
+
+  // Check if already correct
+  try {
+    const existing = fs.readlinkSync(linkPath);
+    if (fs.realpathSync(existing) === fs.realpathSync(hostRoot)) {
+      return;
+    }
+    // Wrong target — remove and recreate
+    fs.unlinkSync(linkPath);
+  } catch {
+    // Not a symlink or doesn't exist — fine
+  }
+
+  fs.mkdirSync(nmDir, { recursive: true });
+  fs.symlinkSync(hostRoot, linkPath);
+  log(`已创建 symlink: node_modules/openclaw → ${hostRoot}`);
+}
+
+// ── installed plugin detection ───────────────────────────────────────────────
+
+/**
+ * Read the openclaw config and return the dist-tag that was used to install
+ * the plugin.  OpenClaw stores `plugins.installs.<id>.spec` as the raw
+ * install spec (e.g. "@tencent/openclaw-weixin@latest").  We extract the
+ * trailing tag/version after the last "@".
+ * Returns the tag string, or null if not installed / unreadable.
+ */
+function getInstalledPluginTag() {
+  const stateDir = process.env.OPENCLAW_STATE_DIR || path.join(os.homedir(), ".openclaw");
+  const configPath = path.join(stateDir, "openclaw.json");
+  try {
+    const config = JSON.parse(fs.readFileSync(configPath, "utf-8"));
+    const spec = config?.plugins?.installs?.[CHANNEL_ID]?.spec;
+    if (!spec) return null;
+    const atIdx = spec.lastIndexOf("@");
+    const raw = atIdx > 0 ? spec.slice(atIdx + 1) : "latest";
+    return LEGACY_TAG_ALIASES[raw] || raw;
+  } catch {
+    return null;
+  }
+}
+
 // ── commands ─────────────────────────────────────────────────────────────────
 
 function install() {
@@ -47,10 +203,47 @@ function install() {
   }
   log("已找到本地安装的 openclaw");
 
-  // 2. Install plugin via openclaw
-  log("正在安装插件...");
+  // 2. Detect host version and select compatible plugin
+  const hostVersion = getOpenclawVersion();
+  if (!hostVersion) {
+    error("无法获取 openclaw 版本号，请确认 `openclaw --version` 正常工作");
+    process.exit(1);
+  }
+  log(`检测到 OpenClaw 版本: ${hostVersion}`);
+
+  const compat = selectPluginTag(hostVersion);
+  if (!compat) {
+    process.exit(1);
+  }
+
+  const pluginInstallSpec = `${PLUGIN_SPEC}@${compat.distTag}`;
+  log(`匹配兼容版本: ${compat.label} (dist-tag: ${compat.distTag})`);
+
+  // 3. If already installed with a different dist-tag, uninstall first
+  //    so the fresh install picks up the correct dist-tag.
+  //    If the installed spec is a pinned version number, skip entirely.
+  const installedTag = getInstalledPluginTag();
+  if (installedTag !== null && /^\d+\.\d+\.\d+/.test(installedTag)) {
+    log(`本地已安装插件为固定版本 ${installedTag}，跳过升级`);
+    return;
+  }
+  if (installedTag !== null && installedTag !== compat.distTag) {
+    log(`本地已安装插件为 @${installedTag}，与目标 @${compat.distTag} 不一致，先卸载旧版本...`);
+    try {
+      run(`echo y | openclaw plugins uninstall "${CHANNEL_ID}"`);
+      log("旧版本已卸载");
+    } catch (uninstallErr) {
+      error("旧版本卸载失败，请手动执行：");
+      if (uninstallErr.stderr) console.error(uninstallErr.stderr);
+      console.log(`  openclaw plugins uninstall "${CHANNEL_ID}"`);
+      process.exit(1);
+    }
+  }
+
+  // 4. Install plugin via openclaw
+  log(`正在安装插件 ${pluginInstallSpec}...`);
   try {
-    const installOut = run(`openclaw plugins install "${PLUGIN_SPEC}"`);
+    const installOut = run(`openclaw plugins install "${pluginInstallSpec}"`);
     if (installOut) log(installOut);
   } catch (installErr) {
     if (installErr.stderr && installErr.stderr.includes("already exists")) {
@@ -67,12 +260,16 @@ function install() {
     } else {
       error("插件安装失败，请手动执行：");
       if (installErr.stderr) console.error(installErr.stderr);
-      console.log(`  openclaw plugins install "${PLUGIN_SPEC}"`);
+      console.log(`  openclaw plugins install "${pluginInstallSpec}"`);
       process.exit(1);
     }
   }
 
-  // 3. Login (interactive QR scan)
+  // 5. Symlink host openclaw into plugin's node_modules (2026.3.22–2026.3.23 only)
+  //    so jiti can resolve openclaw/plugin-sdk/* without a runtime dependency.
+  ensureOpenclawSymlink(hostVersion);
+
+  // 6. Login (interactive QR scan)
   log("插件就绪，开始首次连接...");
   try {
     run(`openclaw channels login --channel ${CHANNEL_ID}`, { silent: false });
@@ -82,7 +279,7 @@ function install() {
     console.log(`  openclaw channels login --channel ${CHANNEL_ID}`);
   }
 
-  // 4. Restart gateway so it picks up the new account
+  // 7. Restart gateway so it picks up the new account
   log("正在重启 OpenClaw Gateway...");
   try {
     run(`openclaw gateway restart`, { silent: false });
@@ -90,7 +287,6 @@ function install() {
     error("重启失败，可手动执行：");
     console.log(`  openclaw gateway restart`);
   }
-
 }
 
 function help() {
@@ -98,9 +294,14 @@ function help() {
   用法: npx -y @tencent-weixin/openclaw-weixin-cli <命令>
 
   命令:
-    install   安装微信插件并扫码连接
+    install   自动检测 OpenClaw 版本，安装兼容的微信插件并扫码连接
     help      显示帮助信息
-`);
+
+  兼容矩阵:`);
+  for (const e of COMPAT_MATRIX) {
+    console.log(`    ${e.label.padEnd(28)} OpenClaw ${formatRange(e.openclawRange)}`);
+  }
+  console.log();
 }
 
 // ── main ─────────────────────────────────────────────────────────────────────

package/lib/compat.mjs

@@ -0,0 +1,61 @@
+// lib/compat.mjs
+// Centralized compatibility matrix for openclaw-weixin plugin versions.
+
+/**
+ * Each entry maps a plugin major version to the supported OpenClaw host range.
+ * Used by both the installer CLI (auto-select) and the plugin runtime (fail-fast).
+ */
+export const COMPAT_MATRIX = [
+  {
+    pluginMajor: 1,
+    distTag: 'compat-host-gte2026.3.0-lt2026.3.22',
+    openclawRange: { gte: '2026.3.0', lt: '2026.3.22' },
+    label: '1.0.x (兼容轨道: OpenClaw >=2026.3.0 <2026.3.22)',
+  },
+  {
+    pluginMajor: 2,
+    distTag: 'latest',
+    openclawRange: { gte: '2026.3.22' },
+    label: '2.0.x (当前最新主线)',
+  },
+];
+
+/** Parse a version string like "2026.3.22" into [major, minor, patch]. */
+export function parseVersion(v) {
+  const m = String(v).match(/(\d+)\.(\d+)\.(\d+)/);
+  if (!m) return null;
+  return [Number(m[1]), Number(m[2]), Number(m[3])];
+}
+
+/** Compare two version strings. Returns <0, 0, or >0. */
+export function compareVersions(a, b) {
+  const va = parseVersion(a);
+  const vb = parseVersion(b);
+  if (!va || !vb) return NaN;
+  for (let i = 0; i < 3; i++) {
+    if (va[i] !== vb[i]) return va[i] - vb[i];
+  }
+  return 0;
+}
+
+/** Check if `version` satisfies { gte, lt } range. */
+export function satisfiesRange(version, range) {
+  if (range.gte && compareVersions(version, range.gte) < 0) return false;
+  if (range.lt && compareVersions(version, range.lt) >= 0) return false;
+  return true;
+}
+
+/** Find the matching matrix entry for a given OpenClaw host version. */
+export function findCompatEntry(openclawVersion) {
+  return COMPAT_MATRIX.find(entry =>
+    satisfiesRange(openclawVersion, entry.openclawRange)
+  ) || null;
+}
+
+/** Format a range for display, e.g. ">=2026.3.22 <2026.4.0". */
+export function formatRange(range) {
+  const parts = [];
+  if (range.gte) parts.push(`>=${range.gte}`);
+  if (range.lt) parts.push(`<${range.lt}`);
+  return parts.join(' ');
+}

package/lib/version-check.mjs

@@ -0,0 +1,86 @@
+// lib/version-check.mjs
+// Runtime fail-fast version check — call at plugin initialization.
+//
+// Usage (in plugin entry point):
+//   import { assertHostCompat } from '@tencent/openclaw-weixin/lib/version-check.mjs';
+//   assertHostCompat();
+
+import { readFileSync } from 'node:fs';
+import { resolve, dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import {
+  COMPAT_MATRIX,
+  findCompatEntry,
+  parseVersion,
+  formatRange,
+} from './compat.mjs';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+/**
+ * Resolve the current OpenClaw host version.
+ * Checks (in order):
+ *   1. OPENCLAW_VERSION env var (set by host since 2026.3.x)
+ *   2. globalThis.__openclaw_version__ (injected by host runtime)
+ */
+export function getHostVersion() {
+  if (process.env.OPENCLAW_VERSION) return process.env.OPENCLAW_VERSION;
+  if (globalThis.__openclaw_version__) return String(globalThis.__openclaw_version__);
+  return null;
+}
+
+/**
+ * Read the plugin's own major version from its package.json.
+ */
+function getPluginMajor() {
+  try {
+    const pkg = JSON.parse(
+      readFileSync(resolve(__dirname, '..', 'package.json'), 'utf-8'),
+    );
+    return parseVersion(pkg.version)?.[0] ?? null;
+  } catch {
+    return null;
+  }
+}
+
+/**
+ * Assert that the current host is compatible with this plugin version.
+ * Throws a clear error if incompatible; silently returns on success.
+ */
+export function assertHostCompat() {
+  const hostVersion = getHostVersion();
+  if (!hostVersion) {
+    console.warn(
+      '[openclaw-weixin] 无法检测 OpenClaw 宿主版本，跳过兼容性检查',
+    );
+    return;
+  }
+
+  const pluginMajor = getPluginMajor();
+  const entry = COMPAT_MATRIX.find(e => e.pluginMajor === pluginMajor);
+  if (!entry) {
+    console.warn(
+      `[openclaw-weixin] 未知插件主版本 ${pluginMajor}，跳过兼容性检查`,
+    );
+    return;
+  }
+
+  const compat = findCompatEntry(hostVersion);
+  if (compat && compat.pluginMajor === pluginMajor) {
+    // Compatible — nothing to do.
+    return;
+  }
+
+  const supported = formatRange(entry.openclawRange);
+  const suggestion = compat
+    ? `请安装 openclaw-weixin@${compat.distTag} (${compat.label})`
+    : '请升级或降级 OpenClaw 宿主到受支持的版本';
+
+  throw new Error(
+    `[openclaw-weixin] 宿主版本不兼容!\n` +
+    `  当前 OpenClaw 版本: ${hostVersion}\n` +
+    `  当前插件支持范围:   ${supported}\n` +
+    `  ${suggestion}\n` +
+    `  或运行: npx @tencent-weixin/openclaw-weixin-cli install (自动选择兼容版本)`,
+  );
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tencent-weixin/openclaw-weixin-cli",
-  "version": "1.0.3",
+  "version": "2.1.1",
   "description": "Lightweight installer for the OpenClaw Weixin channel plugin",
   "license": "MIT",
   "author": "Tencent",
@@ -9,9 +9,21 @@
     "weixin-installer": "./cli.mjs"
   },
   "files": [
-    "cli.mjs"
+    "cli.mjs",
+    "lib/"
   ],
   "scripts": {},
+  "peerDependencies": {
+    "openclaw": ">=2026.3.0"
+  },
+  "peerDependenciesMeta": {
+    "openclaw": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "openclaw": "2026.3.22"
+  },
   "engines": {
     "node": ">=22"
   }