SuperAPI AI 工具集

cometchat-angular-v5-migration

编程与开发

查看项目

更新于 10-21 20:28

技能介绍

用途

该技能用于把 Angular 应用中的 CometChat UI Kit 从 v4 升级到 v5,即把依赖 @cometchat/chat-uikit-angular 从 ^4 升级到 ^5。前提是项目当前确实安装了 @cometchat/chat-uikit-angular@4;如果已经是 @5,则无需迁移。

主要能力

  • 检测迁移起点:确认 package.json 中的版本,并识别应用是否使用了复合组件(…WithMessages/…WithDetails)、CometChatThemeService、*Style 输入、DataSource/ChatConfigurator 或自定义本地化键。
  • 更新依赖:安装 @cometchat/chat-uikit-angular@5、@cometchat/chat-sdk-javascript@^4.1.13、@cometchat/cards-angular@^1.0.0,并卸载 @cometchat/uikit-elements、@cometchat/uikit-resources、@cometchat/uikit-shared。其中 @cometchat/cards-angular 是 5.1.0 新增的 peer 依赖,官方迁移指南未提及,缺失会导致构建因 peer 依赖错误而失败。
  • 扫描仓库中的 v4 用法:依据内置迁移指南中的符号列表(复合组件、无对应替代的独立组件、DataSource/装饰器、约 35 个 *Style 对象,以及 33 项裸名重命名)生成具体变更清单。
  • 应用破坏性变更映射:包括符号移除与重命名、主题化(CometChatThemeService + *Style → CSS 变量 + 真正的 ThemeService)、事件输入改为 Output、DataSource/ChatConfigurator 改为 MessageBubbleConfigService 或自动渲染、移除 CUSTOM_ELEMENTS_SCHEMA 并转为 standalone、可选的 ChatStateService 采用、本地化方法重命名。
  • 重建复合组件:v5 不再提供复合组件,需用模块手工拼接(参考配套技能的 core-surface.md 或 combined-app.md),复现行为而非逐项移植配置。
  • 验证:构建/类型检查通过,仓库中不再残留 v4 符号,每个 kit 组件都出现在使用方的 imports: [] 中,应用在 init→login 完成后正常渲染。

使用方式

该技能以技能(skill)形式提供,配套技能包括 cometchat-angular-v5-core(v5 初始化/登录/渲染)、cometchat-angular-v5-components(v5 组件目录)、cometchat-angular-v5-placement(如何用 v5 模块重建 v4 复合组件)。迁移工作应在分支上进行,采用追加/转换方式修改用户代码,绝不删除用户代码,批量编辑前需确认。

适用场景

适用于需要将现有 Angular 应用中的 CometChat UI Kit 从 v4 升级到 v5 的开发者,例如“升级我的 v4 UI Kit 到 v5”“迁移 CometChat Angular v4→v5”“把 @cometchat/chat-uikit-angular 升级到 v5”。

限制与注意事项

  • 内置的变更映射是封闭列表,不是完整的属性参考;其余细节需从配套技能或官方文档获取。
  • 不要照搬官方指南中的主题化示例(手写 matchMedia 监听),应使用 ThemeService.initFromPreference()。
  • 不要把仅被重命名的裸名当作已移除,需先检查重命名列表。
  • 移除 CUSTOM_ELEMENTS_SCHEMA 后必须把组件加入 imports: [],否则 standalone 组件会静默不渲染。
  • 不要逐项移植 v4 复合组件的配置,应复现其行为。
  • 并非所有 DataSourceDecorator 都需要 MessageBubbleConfigService,部分内置扩展在 v5 中启用后会自动渲染。
  • 具体收费、价格、平台支持等信息暂未提供。