@xbongbong/xbbcli 2.4.1 → 2.4.2

package/README.md

@@ -98,6 +98,20 @@ xbbcli auth-login --keepOpen      # 登录成功后保留浏览器窗口（默
 - `--debug` 输出请求体、返回体与浏览器信息（密钥只显示掩码），`--raw` 输出换取 API token 接口的原始响应
 - 失败时返回合成错误行：`NO_BROWSER`、`BROWSER_CLOSED`、`LOGIN_TIMEOUT`、`API_TOKEN_FAILED`、`CORPID_MISMATCH`、`SAVE_FAILED` 等
 
+### 刷新本地缓存（auth-refresh-cache）
+
+`token-set` / `auth-login` 保存凭证时会顺带刷新三份本地缓存。插件升级（新增命令导致命令映射变化）、缓存过期或被删除后，可以单独重刷，不需要重新输入 token：
+
+```bash
+xbbcli auth-refresh-cache -f json
+```
+
+- 刷新范围（仅当前启用公司）：`~/.xbbcli/<corpid>.formlist.json`（表单清单）、`~/.xbbcli/<corpid>.command-map.md`（命令映射）、`~/.xbbcli/<corpid>.department-user.json`（部门/员工清单），并把 `corpName` / `userName` 回填进 `config.env`
+- 环境变量模式（`XBB_*`）下同样可用：只刷新缓存文件，不回填 `config.env`
+- 只支持当前启用公司：底层接口一律使用启用公司的凭证，切换公司请先用 `xbbcli token-use`
+- `--userId` 覆盖用于匹配 `userName` 的员工 id（默认取配置里的 `userId`）；`--debug` 在 stderr 输出配置来源、corpid 与三份缓存文件路径
+- 失败时返回 `status=error`、`code=CACHE_REFRESH_FAILED`，`message` 以「步骤 formlist / command-map / department-user / profile」指出中断位置，已完成的部分照常在对应列输出
+
 `token-set` 会按 `corpid` 新增或覆盖一家公司，并把该公司置为 `enable=true`（其余公司自动置为 `false`），同时写入公司名称 `corpName`（取部门 `id` 为 `1` 的部门名称）和操作人姓名 `userName`（从员工列表中按 `userId` 匹配）。除 `token-set`、`token-list`、`token-use`、`token-del`、`auth-status`、`auth-logout` 外，其余命令都使用 `enable` 为 `true` 的公司配置。
 
 同时会自动拉取两份表单清单并合并缓存到：
@@ -145,7 +159,7 @@ xbbcli user-list --pageSize 200 -f json
 xbbcli auth-status                # 回显当前激活的配置（token 默认掩码）
 xbbcli auth-status --showToken    # 需要完整 token 时
 xbbcli auth-logout                # 登出：删除激活的那一家配置 + 清除 XBB_* 环境变量
-xbbcli auth-logout --noEnv        # 只删 config.env，保留环境变量
+xbbcli auth-logout --env 0        # 只删 config.env，保留环境变量
 ```
 
 - `auth-status` 以 `key` / `value` 两列回显当前生效的配置值，固定 6 行：`corpid`、`corpName`、`userName`、`userId`、`baseurl`、`token`；不再输出 `status`、`source`、`message`、`enable`、`companyCount`、`envActive`、`configFile`、`code`、`msg` 这些元信息列。
@@ -166,7 +180,7 @@ note      以上取值来自环境变量 XBB_*（config.env 中没有启用公
 - `auth-status` 默认把 token 掩码为「前 6 + `***` + 后 4」（长度不足 11 时只保留前 2 位），只有 `--showToken` 才输出明文。
 - `auth-logout` 只删除 `enable=true` 的那一条，**不会**把其他公司自动提升为启用：登出后本地可能一个启用公司都没有，需要 `xbbcli token-use --corpid <CORPID>` 或重新 `auth-login` / `token-set`。想保留其他公司并可切换时，用 `xbbcli token-del --corpid <CORPID>`（它会保证剩余配置仍有且仅有一个启用）。
 - 删除前 `config.env` 会整份备份到 `~/.xbbcli/config.env.bak`（每次登出覆盖），`backupFile` 列给出路径；误删把 `.bak` 复制回 `config.env` 即可恢复。
-- 默认**同时**清除 `XBB_*` 环境变量：Windows 用 `reg delete HKCU\Environment` 删除用户级变量（已打开的终端要重开才生效，`envStored` 为 `user`，原本就不存在时为 `none`）；macOS/Linux 清理 `~/.xbbcli/env.sh` 里的 `export XBB_*` 行（文件清空则删除，`envStored` 为 `cleared` / `removed` / `none`）。加 `--noEnv`（或 `--env=false`）时只删 `config.env`，此时若环境变量仍在，`message` 会提示「业务命令会回落到它，本次不算彻底登出」（`XBB_ENV_ONLY=1` 时提示为「已强制只用环境变量」）。
+- 默认**同时**清除 `XBB_*` 环境变量：Windows 用 `reg delete HKCU\Environment` 删除用户级变量（已打开的终端要重开才生效，`envStored` 为 `user`，原本就不存在时为 `none`）；macOS/Linux 清理 `~/.xbbcli/env.sh` 里的 `export XBB_*` 行（文件清空则删除，`envStored` 为 `cleared` / `removed` / `none`）。传 `--env 0` 时只删 `config.env`，此时若环境变量仍在，`message` 会提示「业务命令会回落到它，本次不算彻底登出」（`XBB_ENV_ONLY=1` 时提示为「已强制只用环境变量」）。
 - `config.env` 没有启用公司时：只有在环境变量确实存在时才只清环境变量（`config.env` 保持不动）；两者都不存在则返回 `NO_ACTIVE_CONFIG`，不写任何文件。
 - 任何情况都不改动 `<corpid>.formlist.json` / `<corpid>.command-map.md` / `<corpid>.department-user.json` 三份缓存，重新启用该公司时无需再次拉取。
 
@@ -204,7 +218,8 @@ note      以上取值来自环境变量 XBB_*（config.env 中没有启用公
 
 - `auth-login`：拉起本地浏览器完成交互式登录（账号密码 / 短信 / 扫码均可），自动读取 Web 会话、换取 API token 并复用 `token-set` 落盘；支持 `--browser`、`--timeout`、`--corpid`、`--keepOpen`、`--env`、`--debug`、`--raw`
 - `auth-status`：以 `key` / `value` 两列回显当前激活配置的 `corpid`、`corpName`、`userName`、`userId`、`baseurl`、`token`（token 默认中间掩码，`--showToken` 出明文），来源与冲突提醒以 `note` 行追加，无生效配置时六个值留空并给出 `note`；`--debug` 在 stderr 输出配置文件路径、公司数量与生效的环境变量名
-- `auth-logout`：删除 `config.env` 中 `enable=true` 的那一条配置，删除前整份备份为 `~/.xbbcli/config.env.bak`；不自动把其他公司提升为启用；默认同时清除 `XBB_*` 环境变量（`--noEnv` / `--env=false` 跳过，返回 `envStored` / `envFile`）；既无启用公司又无环境变量时返回 `NO_ACTIVE_CONFIG` 且不改动文件
+- `auth-logout`：删除 `config.env` 中 `enable=true` 的那一条配置，删除前整份备份为 `~/.xbbcli/config.env.bak`；不自动把其他公司提升为启用；默认同时清除 `XBB_*` 环境变量（`--env 0` 跳过，返回 `envStored` / `envFile`）；既无启用公司又无环境变量时返回 `NO_ACTIVE_CONFIG` 且不改动文件
+- `auth-refresh-cache`：对当前启用公司重新拉取表单缓存、命令映射与部门/员工缓存，并回填 `corpName` / `userName`；失败时返回 `code=CACHE_REFRESH_FAILED`，`message` 注明中断步骤（`formlist` / `command-map` / `department-user` / `profile`），已完成的部分照常输出；支持 `--userId`、`--debug`
 - `token-set`：保存个人 token、`corpid`、`userId`、`baseurl`，并刷新本地表单缓存、命令映射文件与部门/员工缓存；传入的 token 不以 `user_` 开头时，会先为该 `userId` 刷新并保存个人 token；`--env` 控制存储方式：`0`（默认）仅写入本地文件，`1` 仅写入 `XBB_*` 环境变量（Windows 用 `setx`，其他平台写 `~/.xbbcli/env.sh`）且不写任何本地文件；返回 `envStored` / `envFile` 两列
 - `token-list`：列出本地保存的所有公司配置和唯一启用的公司（含 `corpName` 公司名称与 `userName` 操作人姓名，`source` 列标记来源 `config`/`env`）；`--showToken` 显示完整 token（默认脱敏）；环境变量模式下单行显示
 - `token-use`：切换当前启用的公司（`xbbcli token-use --corpid <CORPID>`），保证仅且只有一个公司被启用
@@ -452,7 +467,7 @@ note      以上取值来自环境变量 XBB_*（config.env 中没有启用公
 ## 通用行为
 
 - 先执行一次 `token-set`（或 `auth-login`）保存有效的 `corpid`、`token`、`userId`
-- 用 `xbbcli auth-status` 查看当前生效的配置来自 `config.env` 还是环境变量；`xbbcli auth-logout` 删除激活配置并默认清除 `XBB_*` 环境变量（`--noEnv` 保留）
+- 用 `xbbcli auth-status` 查看当前生效的配置来自 `config.env` 还是环境变量；`xbbcli auth-logout` 删除激活配置并默认清除 `XBB_*` 环境变量（`--env 0` 保留）
 - 除 `token-set` 外，其余命令都会从 `~/.xbbcli/config.env` 读取 `corpid`
 - 大部分命令会从 `~/.xbbcli/config.env` 读取 `token`
 - 未配置 `config.env`（或其中没有启用公司）时，命令会回落到 `XBB_CORPID` / `XBB_TOKEN` / `XBB_BASEURL` / `XBB_USERID` / `XBB_CORPNAME` / `XBB_USERNAME` 环境变量；`XBB_ENV_ONLY=1` 可强制只用环境变量

package/auth-login.js

@@ -287,7 +287,7 @@ async function authLogin(kwargs) {
 cli({
   site: 'xbb',
   name: 'auth-login',
-  description: '打开浏览器完成销帮帮登录授权（等价于token-set）',
+  description: '打开浏览器完成销帮帮登录授权',
   strategy: Strategy.PUBLIC,
   access: 'write',
   browser: false,

package/auth-logout.js

@@ -61,7 +61,7 @@ function previewCorpids(companies) {
 }
 
 async function authLogout(kwargs) {
-  const alsoEnv = !kwargs.noEnv && kwargs.env !== false;
+  const alsoEnv = String(kwargs.env ?? '1').trim() !== '0';
   const companies = readCompanies();
   const index = companies.findIndex((item) => item && item.enable === true);
   const envPresent = hasEnvConfig();
@@ -76,7 +76,7 @@ async function authLogout(kwargs) {
       ? `本地共 ${companies.length} 家公司（${previewCorpids(companies)}）且均未启用；要登出某家请先用 xbbcli token-use --corpid <CORPID> 启用，或改用 xbbcli token-del --corpid <CORPID> 直接删除`
       : '本地没有任何公司配置';
     const envNote = envPresent
-      ? '环境变量 XBB_* 仍存在，本次未清除（去掉 --noEnv / --env=false 即可一并清除）'
+      ? '环境变量 XBB_* 仍存在，本次未清除（用 --env 1 或不指定该参数即可一并清除）'
       : '环境变量 XBB_* 也不存在，本次无可清除内容';
     const hint = `${scope}；${envNote}`;
     return createRow({
@@ -139,7 +139,7 @@ async function authLogout(kwargs) {
     }
   } else if (envBefore) {
     const forced = isEnvOnly() ? '且 XBB_ENV_ONLY=1 已强制只用环境变量' : '业务命令会回落到它';
-    parts.push(`注意：环境变量 XBB_*（corpid=${envBefore}）仍然有效，${forced}，本次不算彻底登出；如需一并清除请去掉 --noEnv（auth-logout 默认会清除环境变量）`);
+    parts.push(`注意：环境变量 XBB_*（corpid=${envBefore}）仍然有效，${forced}，本次不算彻底登出；如需一并清除请改用 --env 1（或不指定该参数，auth-logout 默认会清除环境变量）`);
   }
 
   const remainingCompanies = target ? remaining : readCompanies();
@@ -166,8 +166,7 @@ cli({
   browser: false,
   domain: 'proapi.xbongbong.com',
   args: [
-    { name: 'env', type: 'bool', default: true, help: '同时清除 XBB_* 环境变量（默认开启；--env=false 跳过）。Windows 删除用户级变量，其他平台清理 ~/.xbbcli/env.sh' },
-    { name: 'noEnv', type: 'bool', default: false, help: '不清除环境变量，仅删除 config.env 中的激活配置（等价于 --env=false）' },
+    { name: 'env', type: 'str', default: '1', help: '是否同时清除 XBB_* 环境变量：1 清除（默认），0 仅删除 config.env 保留环境变量。Windows 删除用户级变量，其他平台清理 ~/.xbbcli/env.sh' },
     { name: 'debug', type: 'bool', default: false, help: '输出配置文件、备份路径与生效的环境变量名（不打印 token）' },
   ],
   columns: ['status', 'message', 'configFile', 'backupFile', 'corpid', 'corpName', 'userId', 'companyCount', 'hasActive', 'envStored', 'envFile', 'code', 'msg'],

package/auth-refresh-cache.js

@@ -0,0 +1,117 @@
+import { cli, Strategy } from './xbb-registry.js';
+import { readActiveConfig, isEnvActive } from './xbb-config.js';
+import {
+  refreshLocalCaches,
+  getFormlistFile,
+  getCommandMapFile,
+  getDepartmentUserFile,
+} from './xbb-token-store.js';
+
+function trim(value) {
+  return String(value ?? '').trim();
+}
+
+// 统一输出：成功时给出三份缓存与回填结果，失败时回落到合成错误行（不抛异常）
+function makeRow(fields) {
+  return [{
+    status: '',
+    message: '',
+    corpid: '',
+    userId: '',
+    corpName: '',
+    userName: '',
+    formlistFile: '',
+    formlistCount: '',
+    commandMapFile: '',
+    departmentUserFile: '',
+    departmentCount: '',
+    userCount: '',
+    profileUpdated: '',
+    code: '',
+    msg: '',
+    ...fields,
+  }];
+}
+
+function makeErrorRow(code, msg, extra = {}) {
+  return makeRow({ status: 'error', code, msg, message: msg, ...extra });
+}
+
+async function authRefreshCache(kwargs) {
+  const active = readActiveConfig();
+  const corpid = trim(active.corpid);
+  const userId = trim(kwargs.userId) || trim(active.userId);
+
+  if (kwargs.debug) {
+    const source = isEnvActive() ? 'env' : 'config';
+    process.stderr.write(`[debug] ConfigSource: ${source}\n[debug] Corpid: ${corpid || '(none)'}\n[debug] UserId: ${userId || '(none)'}\n[debug] FormlistFile: ${corpid ? getFormlistFile(corpid) : ''}\n[debug] CommandMapFile: ${corpid ? getCommandMapFile(corpid) : ''}\n[debug] DepartmentUserFile: ${corpid ? getDepartmentUserFile(corpid) : ''}\n`);
+  }
+
+  if (!corpid) {
+    return makeErrorRow('NO_ACTIVE_CONFIG', '没有生效的配置：config.env 中不存在 enable=true 的公司，环境变量 XBB_* 也为空；请先执行 xbbcli auth-login 或 xbbcli token-set');
+  }
+
+  let cache;
+  try {
+    cache = await refreshLocalCaches(corpid, userId);
+  } catch (error) {
+    const partial = error.cache || {};
+    const step = trim(error.step) || 'unknown';
+    const message = `刷新本地缓存失败（步骤 ${step}）：${error.message || error}`;
+    return makeRow({
+      status: 'error',
+      code: 'CACHE_REFRESH_FAILED',
+      msg: message,
+      message,
+      corpid,
+      userId,
+      corpName: partial.corpName ?? '',
+      userName: partial.userName ?? '',
+      formlistFile: partial.formlistFile ?? '',
+      formlistCount: partial.formlistCount ?? '',
+      commandMapFile: partial.commandMapFile ?? '',
+      departmentUserFile: partial.departmentUserFile ?? '',
+      departmentCount: partial.departmentCount ?? '',
+      userCount: partial.userCount ?? '',
+      profileUpdated: partial.profileUpdated ?? '',
+    });
+  }
+
+  const message = cache.profileUpdated
+    ? '已刷新表单清单缓存、命令映射与部门/员工缓存，并回填 corpName/userName 到 config.env'
+    : isEnvActive()
+      ? '已刷新表单清单缓存、命令映射与部门/员工缓存；当前为环境变量模式，corpName/userName 未回填 config.env'
+      : '已刷新表单清单缓存、命令映射与部门/员工缓存；该公司不在 config.env 中，corpName/userName 未回填';
+
+  return makeRow({
+    status: 'ok',
+    message,
+    corpid,
+    userId,
+    corpName: cache.corpName,
+    userName: cache.userName,
+    formlistFile: cache.formlistFile,
+    formlistCount: cache.formlistCount,
+    commandMapFile: cache.commandMapFile,
+    departmentUserFile: cache.departmentUserFile,
+    departmentCount: cache.departmentCount,
+    userCount: cache.userCount,
+    profileUpdated: cache.profileUpdated,
+  });
+}
+
+cli({
+  site: 'xbb',
+  name: 'auth-refresh-cache',
+  description: '刷新当前启用公司的本地缓存（表单清单、命令映射等）',
+  strategy: Strategy.PUBLIC,
+  access: 'write',
+  browser: false,
+  domain: 'proapi.xbongbong.com',
+  args: [
+    { name: 'userId', type: 'str', default: '', help: '操作人 id，用于从员工清单匹配 userName；默认取当前启用配置的 userId' },
+    { name: 'debug', type: 'bool', default: false, help: '在 stderr 输出配置来源、corpid 与三份缓存文件路径' },
+  ],
+  columns: ['status', 'message', 'corpid', 'userId', 'corpName', 'userName', 'formlistFile', 'formlistCount', 'commandMapFile', 'departmentUserFile', 'departmentCount', 'userCount', 'profileUpdated', 'code', 'msg'],
+  func: authRefreshCache,
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xbongbong/xbbcli",
-  "version": "2.4.1",
+  "version": "2.4.2",
   "description": "销帮帮 CRM 的独立命令行工具",
   "type": "module",
   "bin": {

package/xbb-token-store.js

@@ -109,7 +109,7 @@ async function writeFormlistFile(corpid) {
   const mergedRows = [...customForms, ...systemForms];
 
   fs.writeFileSync(formlistFile, JSON.stringify(mergedRows, null, 2) + '\n', 'utf8');
-  return formlistFile;
+  return { file: formlistFile, count: mergedRows.length };
 }
 
 async function fetchAllRows(name, pageSize) {
@@ -178,7 +178,7 @@ async function writeDepartmentUserFile(corpid, userId) {
   const file = getDepartmentUserFile(corpid);
   fs.mkdirSync(CONFIG_DIR, { recursive: true });
   fs.writeFileSync(file, JSON.stringify(payload, null, 2) + '\n', 'utf8');
-  return { file, corpName: getCorpName(departmentRows), userName: getUserName(userRows, userId) };
+  return { file, corpName: getCorpName(departmentRows), userName: getUserName(userRows, userId), departmentCount: departmentRows.length, userCount: userRows.length };
 }
 
 function getCorpName(departmentRows) {
@@ -196,16 +196,89 @@ function getUserName(userRows, userId) {
   return matched ? String(matched.name || '').trim() : '';
 }
 
+// 把 corpName / userName 合并进 config.env 对应公司，返回是否真的写过文件
+// config.env 里没有这家公司的条目时（纯环境变量模式）直接跳过，避免凭空生成一份只有 corpName 的 config.env
 export function writeCompanyProfile(corpid, profile) {
+  const target = String(corpid || '').trim();
   const fields = Object.entries(profile).filter(([, value]) => String(value || '').trim() !== '');
-  if (!fields.length) {
-    return;
+  if (!target || !fields.length) {
+    return false;
+  }
+  const companies = readCompanies();
+  const index = companies.findIndex((item) => String(item.corpid || '').trim() === target);
+  if (index === -1) {
+    return false;
   }
   const patch = Object.fromEntries(fields);
-  const companies = readCompanies().map((item) => (
-    String(item.corpid || '').trim() === corpid ? { ...item, ...patch } : item
-  ));
-  fs.writeFileSync(CONFIG_FILE, JSON.stringify(companies, null, 2) + '\n', 'utf8');
+  const next = companies.map((item, itemIndex) => (itemIndex === index ? { ...item, ...patch } : item));
+  fs.writeFileSync(CONFIG_FILE, JSON.stringify(next, null, 2) + '\n', 'utf8');
+  return true;
+}
+
+// token-set / auth-login / auth-refresh-cache 共用：刷新三份本地缓存并回填 corpName、userName
+// 失败时抛出的 error 上带 step（formlist/command-map/department-user/profile）与已完成部分的 cache，便于命令回显进度
+export async function refreshLocalCaches(corpid, userId) {
+  const target = String(corpid || '').trim();
+  if (!target) {
+    const error = new Error('缺少 corpid，无法确定要刷新哪家公司的缓存');
+    error.step = 'formlist';
+    error.cache = { formlistFile: '', commandMapFile: '', departmentUserFile: '', formlistCount: '', departmentCount: '', userCount: '', corpName: '', userName: '', profileUpdated: false };
+    throw error;
+  }
+  const cache = {
+    formlistFile: getFormlistFile(target),
+    commandMapFile: '',
+    departmentUserFile: '',
+    formlistCount: '',
+    departmentCount: '',
+    userCount: '',
+    corpName: '',
+    userName: '',
+    profileUpdated: false,
+  };
+
+  fs.mkdirSync(CONFIG_DIR, { recursive: true });
+
+  try {
+    const formlist = await writeFormlistFile(target);
+    cache.formlistFile = formlist.file;
+    cache.formlistCount = formlist.count;
+  } catch (error) {
+    error.step = 'formlist';
+    error.cache = cache;
+    throw error;
+  }
+
+  try {
+    cache.commandMapFile = writeCommandMap(target);
+  } catch (error) {
+    error.step = 'command-map';
+    error.cache = cache;
+    throw error;
+  }
+
+  try {
+    const departmentUser = await writeDepartmentUserFile(target, userId);
+    cache.departmentUserFile = departmentUser.file;
+    cache.corpName = departmentUser.corpName;
+    cache.userName = departmentUser.userName;
+    cache.departmentCount = departmentUser.departmentCount;
+    cache.userCount = departmentUser.userCount;
+  } catch (error) {
+    error.step = 'department-user';
+    error.cache = cache;
+    throw error;
+  }
+
+  try {
+    cache.profileUpdated = writeCompanyProfile(target, { corpName: cache.corpName, userName: cache.userName });
+  } catch (error) {
+    error.step = 'profile';
+    error.cache = cache;
+    throw error;
+  }
+
+  return cache;
 }
 
 function normalizeBusinessType(value) {
@@ -373,15 +446,13 @@ export async function saveCompanyCredentials(kwargs) {
   fs.writeFileSync(CONFIG_FILE, JSON.stringify(companies, null, 2) + '\n', 'utf8');
 
   try {
-    const formlistFile = await writeFormlistFile(corpid);
-    const commandMapFile = writeCommandMap(corpid);
-    const { file: departmentUserFile, corpName, userName } = await writeDepartmentUserFile(corpid, userId);
-    writeCompanyProfile(corpid, { corpName, userName });
+    const cache = await refreshLocalCaches(corpid, userId);
+    const { formlistFile, commandMapFile, departmentUserFile, corpName, userName } = cache;
     return createResult('ok', '已保存 corpid、token、baseurl、userId，并同步表单模板缓存、命令映射文件与部门/员工缓存', corpid, baseurl, userId, formlistFile, commandMapFile, true, companies.length, departmentUserFile, corpName, userName, 'skipped', '');
   } catch (error) {
     return createResult(
       'partial',
-      `已保存 corpid、token、baseurl、userId，但同步缓存失败：${error.message}`,
+      `已保存 corpid、token、baseurl、userId，但同步缓存失败${error.step ? `（步骤 ${error.step}）` : ''}：${error.message}`,
       corpid,
       baseurl,
       userId,