Skip to content

armgit / cindy

Public Imported from GitHub
0

Consider it done. The open-source AI agent that works out of the box · 想到,就能做到。开源、开箱即用的 AI Agent。

12.2 KB
Raw Blame
/**
 * brand-identity — 产品**标识符层**身份的单一事实源(构建期单点)。
 *
 * 与 `branding.ts`(展示名层,`BRAND_NAME`)互补:那边管用户/LLM 看到的名字,
 * 这边管 OS 注册身份与磁盘/协议标识符——exe 名、AppUserModelId/bundle id、
 * 深链 scheme、userData 目录名、CDN 渠道前缀、更新器产物名等。
 *
 * 2026-07-17 身份翻转(Cindy 渠道分叉,老 /xdt-maker 渠道冻结不再发版):
 * 主值全部切换为 Cindy 系,旧值移入 legacy 数组供兼容读取与未来数据迁移方案
 * 使用。本仓构建从此产出 Cindy 身份的包(新装用户直装);存量 xdt-maker 用户
 * 停留在冻结渠道,待后续独立设计的自动迁移方案接走。
 *
 * ⚠️ 语义边界:
 *  - 这是**构建期单点,不是运行时开关**。区域(cn/global)是唯一的构建期维度,
 *    经打包命令的 CINDY_AUTH_REGION 选择,默认 global。appId / userData 目录名
 *    按区域派生(cn 与 global 是两个可并存的系统身份,appId 与 mobile 的
 *    com.xd.cindycn / com.xd.cindy 同一套);exe 名 cn/global 同值 'Cindy'
 *    (2026-07-26 显示名统一决策,文件层双装隔离随之放弃,dev 仍独立)。
 *  - 历史兼容锚点(旧 scheme 解析、旧 userData / DB 文件识别)由
 *    `legacySchemes` / `legacyUserDataDirNames(ByRegion)` / `legacyDbFilePrefixes`
 *    承载,只增不减:老用户机器上的存量注册与文件可能永远带着旧值。
 *  - 永久不随本配置变化的标识符(settings 键名 `xdtMaker.*`、
 *    `xdt-image://` 等进程内 scheme、`.cshare` 扩展名、
 *    localStorage 键等)由各自协议/存储模块维护,
 *    不要试图从这里派生它们。
 *  - `updaterName` = `cindy-updater`(2026-07-17 经 owner 确认随品牌翻转改名,
 *    docs/dev-rules/cindy-updater.md;老渠道已冻结、新应用未发过版,无自更新兼容包袱)。
 *    消费方:updateService(resources 源名 + %TEMP% 运行名)、forge prePackage
 *    构建/签名/extraResource、notices 脚本登记路径。
 *
 * 消费方:
 *  - apps/desktop forge.config.ts(executableName / appId / protocols / UTI)
 *  - apps/desktop main 常量(AUMID、深链、orphan-reaper 路径标记、skillhub
 *    usageIndexer 的 userData 兜底路径、localDb 文件名前缀)
 *  - release / publish / smoke 脚本(产物名、OSS 前缀)
 */

import { BRAND_NAME } from './branding.js';

/**
 * 构建期区域维度(与 mobile 的 EXPO_PUBLIC_CINDY_AUTH_REGION 同语义)。
 * 2026-07-20 新增第三目标 `dev`:独立系统身份(CindyDev,可与 cn/global 同机
 * 三装),连接独立的 dev 服务器(config/endpoint.dev.json,服务端就绪前为
 * 约定占位域名)。行为语义上 dev 归 cn 系(登录线/文案等运行时按区域分支处
 * 与 cn 同待遇),差异只在端点与身份。注意与「开发模式(未注入区域的本地
 * dev 构建)」区分:那仍默认 global 身份。
 */
export type CindyRegion = 'cn' | 'global' | 'dev';

/** 默认区域:Global。开发模式 / 未显式注入区域的构建一律落在这里。 */
export const DEFAULT_CINDY_REGION: CindyRegion = 'global';

/**
 * 归一化区域输入(构建脚本 env / 运行时注入值)。空值 → 默认 global;
 * 非法值抛错——打包链路宁可失败也不能默默打出身份错误的包。
 */
export function resolveCindyRegion(raw?: string | null): CindyRegion {
  const v = raw?.trim().toLowerCase();
  if (!v) return DEFAULT_CINDY_REGION;
  if (v === 'cn' || v === 'global' || v === 'dev') return v;
  throw new Error(`Invalid Cindy region: ${raw}; expected cn, global or dev`);
}

/** 标识符层身份配置的完整形状。字段语义见各注释;全部为纯数据,零运行时逻辑。 */
export interface BrandIdentity {
  /** 展示名(与 branding.ts 的 BRAND_NAME 同源,这里仅聚合成完整档案)。 */
  readonly displayName: string;
  /**
   * 可执行文件基名(Windows 加 .exe;mac Mach-O 名同源派生)。
   * 首字母大写是产品决策(Cindy.exe,同 Discord/Slack 惯例);Windows 进程
   * 匹配大小写不敏感,产物 / OSS key 命名走小写的 `cdnPrefix`,互不影响。
   * ⚠️ 这是 **cn / dev 基线值**;2026-07-18 支持同机双装后,打包与运行时
   * 一律走 `brandExecutableName(region)` 取区域值,本字段仅供 dev 链路
   * (restart 脚本镜像)与 legacy 消费点使用。
   */
  readonly executableName: string;
  /**
   * 按区域派生的可执行文件基名(exe / mac .app 包名 / 安装目录 / NSIS
   * 快捷方式全部跟随)。2026-07-26 owner 决策:cn 与 global 同值 'Cindy',
   * 让 global 包在 Dock / Finder / 菜单栏 / Windows 快捷方式等全部位置显示
   * Cindy——代价是 cn/global 同机双装时安装目录 / .app / .lnk 同名互抢
   * (第二个安装覆盖第一个的文件与快捷方式,更新器按 exe 名杀进程会波及另一
   * 区域),该场景明确放弃支持;appId 与 userData 目录仍按区域分离,系统身份
   * 与数据互不影响。dev 保持独立名(CindyDev,可与正式包并存)。区域名不含
   * 空格(部分系统对带空格路径的兼容性差,owner 决策)。
   */
  readonly executableNameByRegion: Readonly<Record<CindyRegion, string>>;
  /**
   * Windows AppUserModelId = NSIS appId = macOS bundle id,按区域派生
   * (cn/global 是两个可并存的系统身份,与 mobile 同一套命名)。
   * ⚠️ AUMID 三位一体:NSIS appId、运行时 setAppUserModelId、快捷方式 AUMID
   * 必须逐字符一致,否则 Windows toast 通知被静默丢弃。取值经 `brandAppId()`。
   */
  readonly appIdByRegion: Readonly<Record<CindyRegion, string>>;
  /** 深链主 scheme(OS 级注册,`<scheme>://session/...`;cn/global 不区分)。 */
  readonly primaryScheme: string;
  /** 历史 scheme,永久保持注册 + 解析兼容(存量链接不能死)。只增不减。 */
  readonly legacySchemes: readonly string[];
  /**
   * Electron 默认派生的 userData 目录名(= package.json productName)。已发布的
   * cn 构建沿用该目录;global 继续使用历史独立目录 `CindyGlobal`,避免启动时
   * 改名或搬迁用户数据。
   */
  readonly userDataDirName: string;
  /** 按区域派生的 userData 目录名。 */
  readonly userDataDirNameByRegion: Readonly<Record<CindyRegion, string>>;
  /** 品牌翻转前的共享历史 userData 目录名(首登 mToc 迁移使用)。只增不减。 */
  readonly legacyUserDataDirNames: readonly string[];
  /**
   * 各区域曾经使用过的 userData 目录名。按路径识别进程的消费点只能匹配本区域,
   * 不能把另一发行版的历史目录纳入自己的 kill / 回收范围。只增不减。
   */
  readonly legacyUserDataDirNamesByRegion: Readonly<
    Record<CindyRegion, readonly string[]>
  >;
  /**
   * 各区域的 sessions.working_dir 迁移来源。它与进程路径归属清单故意分离。
   */
  readonly legacyDialogueUserDataDirNamesByRegion: Readonly<
    Record<CindyRegion, readonly string[]>
  >;
  /**
   * 更新分发 CDN / OSS 的一级路径前缀(渠道身份,老客户端永远只看自己的前缀)。
   * ⚠️ 两区共用(owner 决策 2026-07-18):cn / global 的发布渠道靠**不同
   * OSS bucket** 区分,不靠路径前缀——本字段不做区域派生,发布侧矩阵按
   * region 选 bucket。
   */
  readonly cdnPrefix: string;
  /** 更新器/迁移执行器产物基名(`<updaterName>.exe`)。 */
  readonly updaterName: string;
  /** 本地主库文件名前缀(`<dbFilePrefix>-<userId>.db`)。 */
  readonly dbFilePrefix: string;
  /** 历史主库文件名前缀;首登本地迁移扫描旧库时只增不减。 */
  readonly legacyDbFilePrefixes: readonly string[];
}

/**
 * 当前生效的身份档案(Cindy,2026-07-17 翻转)。
 * 旧 xdt-maker 值全部下沉 legacy 数组。
 *
 * 区域差异字段:appId、userDataDirName 按区域派生(cn/global 是两个可并存
 * 的系统身份,数据分库);executableName 自 2026-07-26 起 cn/global 同值
 * (显示统一为 Cindy,放弃文件层双装隔离,见 executableNameByRegion doc),
 * 仅 dev 保持独立名;深链 scheme、展示名 BRAND_NAME、cdnPrefix、dbFilePrefix、
 * updaterName 两区共用(scheme 共用是 owner 决策:双装时后注册者赢,单装用户
 * 无感;cdnPrefix 共用因发布渠道靠不同 OSS bucket 区分;db 前缀因 userData
 * 已分目录无需再区分)。
 */
export const BRAND_IDENTITY: BrandIdentity = Object.freeze({
  displayName: BRAND_NAME,
  executableName: 'Cindy',
  executableNameByRegion: Object.freeze({
    cn: 'Cindy',
    // 2026-07-26 与 cn 同值(见字段 doc):global 包全部可见位置显示 Cindy,
    // 放弃 cn/global 同机双装的文件层隔离;appId / userData 仍分区。
    global: 'Cindy',
    dev: 'CindyDev',
  }),
  appIdByRegion: Object.freeze({
    cn: 'com.xd.cindycn',
    global: 'com.xd.cindy',
    dev: 'com.xd.cindydev',
  }),
  primaryScheme: 'cindy',
  legacySchemes: Object.freeze(['xdt-maker']),
  userDataDirName: 'Cindy',
  userDataDirNameByRegion: Object.freeze({
    cn: 'Cindy',
    global: 'CindyGlobal',
    dev: 'CindyDev',
  }),
  legacyUserDataDirNames: Object.freeze(['xdt-maker']),
  legacyUserDataDirNamesByRegion: Object.freeze({
    cn: Object.freeze(['xdt-maker']),
    global: Object.freeze([]),
    dev: Object.freeze([]),
  }),
  legacyDialogueUserDataDirNamesByRegion: Object.freeze({
    cn: Object.freeze(['xdt-maker']),
    // xdt-maker 是旧 CN 渠道的数据来源;Global 不导入或改写 CN 的历史 cwd。
    global: Object.freeze([]),
    dev: Object.freeze([]),
  }),
  cdnPrefix: 'cindy',
  updaterName: 'cindy-updater',
  dbFilePrefix: 'cindy',
  legacyDbFilePrefixes: Object.freeze(['xdt-maker']),
});

/** 按区域取 appId(AUMID / bundle id);默认 global。 */
export function brandAppId(
  region: CindyRegion = DEFAULT_CINDY_REGION,
  identity: BrandIdentity = BRAND_IDENTITY,
): string {
  return identity.appIdByRegion[region];
}

/** 自有 UTI / ProgId 等派生标识的前缀(如 `<prefix>.cindy` UTI),随区域 appId 走。 */
export function brandBundleIdPrefix(
  region: CindyRegion = DEFAULT_CINDY_REGION,
  identity: BrandIdentity = BRAND_IDENTITY,
): string {
  return identity.appIdByRegion[region];
}

/** 按区域取可执行文件基名(exe / mac .app / 安装目录 / 快捷方式名);默认 global。 */
export function brandExecutableName(
  region: CindyRegion = DEFAULT_CINDY_REGION,
  identity: BrandIdentity = BRAND_IDENTITY,
): string {
  return identity.executableNameByRegion[region];
}

/** 按区域取 Electron userData 目录名;默认 global。 */
export function brandUserDataDirName(
  region: CindyRegion = DEFAULT_CINDY_REGION,
  identity: BrandIdentity = BRAND_IDENTITY,
): string {
  return identity.userDataDirNameByRegion[region];
}

/** 深链需要注册/解析的全部 scheme(主 + 历史),顺序稳定:主 scheme 恒为首位。 */
export function allDeepLinkSchemes(identity: BrandIdentity = BRAND_IDENTITY): readonly string[] {
  return [identity.primaryScheme, ...identity.legacySchemes];
}

/**
 * 按路径识别本产品 userData 的全部目录名(本区域当前 + 本区域明确拥有的历史名),
 * 本区域目录名恒为首位。⚠️ 故意**不包含另一区域当前或历史使用的目录**:同机双装
 * 时 orphan-reaper 等按路径匹配的消费点只应认领自己区域的进程,跨区域匹配会误杀。
 */
export function allUserDataDirNames(
  region: CindyRegion = DEFAULT_CINDY_REGION,
  identity: BrandIdentity = BRAND_IDENTITY,
): readonly string[] {
  return [
    identity.userDataDirNameByRegion[region],
    ...identity.legacyUserDataDirNamesByRegion[region],
  ];
}

/**
 * 按区域取持久化 dialogue cwd 的历史 userData 目录名。只用于数据迁移,
 * 绝不能用于判断进程归属或清理另一实例。
 */
export function legacyDialogueUserDataDirNames(
  region: CindyRegion = DEFAULT_CINDY_REGION,
  identity: BrandIdentity = BRAND_IDENTITY,
): readonly string[] {
  return identity.legacyDialogueUserDataDirNamesByRegion[region];
}

/** 品牌翻转前的共享老目录候选,仅供 cn 的 mToc 首登数据导入。 */
export function legacyBrandUserDataDirNames(
  identity: BrandIdentity = BRAND_IDENTITY,
): readonly string[] {
  return identity.legacyUserDataDirNames;
}