SuperAPI AI 工具集

cometchat-onboarding

编程与开发

查看项目

更新于 10-21 20:29

技能介绍

用途

这是向任意应用添加 CometChat 的共享入口(front door)。它始终最先运行,是一个咨询式、企业级的「发现 → 理解 → 规划」流程,在编写任何代码之前完成。它不产出任何集成代码,唯一输出是:(1) 共享的规划产物;(2) 下发给框架核心的限定范围构建指令。

适用场景:任意技术栈上的首次「添加 CometChat」意图,例如「add chat」「add cometchat」「add chat to my app」「add voice/video calling」「integrate cometchat」。路由器(cometchat)始终首先路由到这里,这是一个强制关卡。升级请求(如「upgrade my v6 UI Kit to v7」)属于对账而非接入,路由器会直接送往迁移技能。已集成仓库的再次进入会短路处理。

主要能力(四个节拍)

按顺序执行四个节拍,以咨询式对话进行(资深工程师语气:给出带理由的建议、揭示权衡,而非空白表单)。任何节拍都不写入用户代码,首次写入只发生在节拍 4 批准之后、在框架核心内。最终输出是生产就绪的。

构建模型:UI Kit 优先,SDK 按功能回退(不询问「用哪种方式」)。 在有已发布 UI Kit 的平台上,可渲染应用始终以 UI Kit 作为 UI 层。不存在「UI Kit vs SDK」的架构选择。而是按功能处理:UI Kit 有对应组件/属性则用组件;没有则直接调用平台的 Chat SDK 方法(已随 UI Kit 安装)。SDK 是 UI Kit 未暴露能力的回退(AI 智能体、活动、高级/AI 审核、瞬态消息、机器人、webhook 等)。唯一例外:后端/无 DOM/不可渲染环境没有 UI 层,此时 SDK 就是整个构建。

1. DETECT(检测环境与整个当前仓库)

运行 detect 探针,然后阅读仓库获取其余信息。以框架无关方式捕获,信号缺失时优雅降级(记为 null,绝不猜测):

  • 框架与构建:framework、framework_version、bundler、router、ssr_strategy、env_prefix、package_manager、language、project_name(移动端另有版本字段)。非 Web 平台字段不同。
  • 应用集成状态:已安装 UI Kit + version_conflict、现有 CometChat 集成、凭据存在情况。
  • 应用架构(从源码推断,缺失为 null):认证系统、样式/设计系统、状态管理。

version_conflict 停止规则在此仍适用。若检测到 UI Kit 主版本与家族目标不符,停止并在计划中呈现(先对账)。若 CometChat 已为当前主版本接好,则进入再次进入流程。信号缺失是数据而非阻碍。

2. UNDERSTAND(功能与设计对话)

简短、咨询式问答,每个问题都带仓库推断出的推荐默认值:

  • 原型/形态:1:1/市场、支持、社区/群组、全功能信使、嵌入式。从路由推断。
  • 功能:从检测到的平台清单中选择能力。核心聊天(1:1 + 群组、消息、线程、媒体/附件、输入中、回执、反应、提及)是推荐默认且始终包含;反应和提及在 v7 核心中默认开启,不是扩展。然后提供附加项:语音/视频通话、搜索、投票/贴纸、翻译、推送通知、AI/智能回复、审核、AI 智能体。不要将反应/提及列为附加项,也不要提供已弃用功能。先减去已存在的功能。每个所选功能映射到 UI Kit 组件或 SDK 方法。
  • 设计/主题:呈现浅色/深色模式与调色板,始终包含 AUTO 选项(跟随设备 OS 设置,新应用推荐默认)。选项包括:自动、固定浅色预设、固定深色预设、匹配现有设计系统、品牌调色板、自定义设计系统。省略自动/跟随系统选项是缺陷。
  • 范围/放置:满足原型的最小界面(默认)vs 完整组合应用。默认最小合理生产就绪界面。

3. PLAN(在写入任何内容前分享完整规划产物)

组装并呈现规划产物,必须包含计划完整性契约的每个部分:

  • 我发现了什么:节拍 1 的发现摘要,适用于检测平台的字段,每个值或 null。
  • 你想要什么(功能覆盖):确认的意图翻译为 CometChat 能力,每个标记 UI Kit 组件或 SDK 方法。标记 SDK 支持的功能。
  • 我将做什么:编号的行动列表(限定范围的构建步骤,按顺序)。
  • 将更改的文件:构建将触及的具体路径/区域(追加,绝不替换)。
  • 包:计划安装的确切包(命名,带主版本固定)。
  • 凭据 + 认证策略:开发 Auth Key vs 生产服务器签发认证令牌,从发现中选择。在此不获取凭据。计划中说明核心将提供从仪表板获取 App ID/Region/Auth Key 或让用户粘贴。
  • 修改或批准关卡:明确邀请用户编辑计划或批准。批准前不写入任何内容。

4. MODIFY 或 START(编辑计划,否则向核心下发限定指令)

用户可编辑计划任何部分,重新渲染并重新呈现关卡,循环直到批准。批准后,发出限定范围的构建指令并交接:

  • 检测到框架:从 peers.yaml 解析家族(React web → react-v7;Angular → angular-v5;iOS → ios;React Native/Expo → react-native;Android → android-v6;Flutter → flutter-v6),交接给 cometchat-<family>-core,仅拉入计划指定的额外已发布技能。核心优先构建 UI Kit,并对计划标记的 SDK 支持功能接入 SDK 方法。Android 额外:cohort 拆分技能。凭据写入 app/src/main/assets/cometchat-settings.json(gitignored),而非 .env。
  • 检测到无已发布核心的框架:仍交付完整发现→理解→规划,然后明确说明该平台的实现核心尚未构建。不要伪造实现。
  • 限定范围,而非大杂烩。指令命名批准计划所需的最小界面。

通话优先意图

当主要首次接触意图是通话时,运行 references/calling-first.md 决策树,而非默认 UI Kit 路径。通话是唯一合法存在方式选择的意图。简要:检测 UI Kit → 提供预构建 vs 从零独立;若无 UI Kit,询问「也要聊天,还是仅通话?」;从零则询问一对一(响铃)vs 会议式,然后交接给平台的无头 Calls SDK v5 技能。仍先运行节拍 1–3 + 简短计划。

交接边界(复用核心,不要分叉)

本技能负责发现 + 理解 + 规划。框架核心负责凭据 + 实现 + 验证。界线是节拍 4 的批准。

  • 接入拥有:全仓库发现、带推荐的意图引出、规划产物、修改/批准关卡、限定指令。
  • 核心拥有(不要在此重述或分叉):凭据获取/配置 + 环境写入、init→login→render、组件/属性选择、生产就绪构建。它复用此发现。

存在竞品 SDK(migrate_from 非 null)

在计划中命名供应商并提供一键迁移;收到「migrate」/「replace」直接交给该条目的技能(无计划关卡,端到端运行)。绝不静默地将 CometChat 与 Sendbird/Stream 并装。

再次进入(已集成仓库)

若节拍 1 发现 CometChat 已为当前主版本接好,不要重跑完整流程。总结已集成内容,询问用户想添加或更改什么,将该增量请求直接路由到框架核心。接入是首次接触的前门,不是每次后续变更的关卡。

本包中不存在的技能与尚未构建的核心(优雅降级姿态)

规则:只交接本包中已发布(skills/ 下存在且 peers.yaml 中声明)的核心/技能。绝不路由到未安装技能,也绝不假装它存在;完整运行节拍 1–3,产出规划产物,在节拍 4 诚实说明并提供最近的已发布替代。React、Angular、iOS、React Native、Android 和 Flutter 均发布完整集合。仅当某能力确实无已发布技能,或平台无 peers.yaml 对等项(如今 Vue)时,才应用此姿态。

使用方式

在任意技术栈上首次提出「添加 CometChat」意图时触发。路由器会首先路由到此。按四个节拍顺序执行,以咨询式对话进行,最终产出规划产物并等待用户批准,批准后向框架核心下发限定范围的构建指令。

适用场景

  • 任意技术栈首次接入 CometChat(聊天、通话、集成)。
  • 需要先发现、理解、规划再写代码的接入请求。
  • 通话优先的首次接触意图(走专门决策树)。
  • 存在竞品 SDK 需要迁移的场景。

限制

  • 本技能不生成任何集成代码,唯一输出是规划产物与限定构建指令。
  • 凭据获取与实现属于框架核心,不在本技能内进行。
  • 仅交接本包中已发布的核心/技能,未发布平台(如 Vue)只交付计划并说明实现技能尚未构建。
  • 具体收费、价格、平台支持细节等资料未提供,暂未提供。