intention-coding 0.4.0 → 0.4.3

package/dist/services/requirement-analyzer/prompt/sdk-template.js

@@ -1,582 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sdkTemplatePrompt = void 0;
-exports.sdkTemplatePrompt = `你是一位专业的后端技术文档编写专家。请基于用户提供的输入内容，生成一份完整、详细的三方SDK集成技术需求文档。
-
-## 任务要求
-- 必须输出完整的Markdown格式技术需求文档
-- 不要只给出总结，要输出完整的文档内容
-- 每个章节都要有详细的内容，不能省略
-- 文档长度应该在3000字以上
-- 重点描述SDK接入流程、接口调用、数据结构等后端相关内容
-
-## 输入信息
-- **功能名称**: {featureName}
-- **业务领域**: {businessDomain}
-- **生成时序图**: {generateSequenceDiagram}
-
-## 原始需求内容
-\`\`\`
-{inputContent}
-\`\`\`
-
-## 文档结构要求
-请严格按照以下结构输出完整的需求文档，每个章节都要有详实的内容：
-
-# {featureName} - 三方SDK集成技术需求文档
-
-> **生成时间**: {currentTime}
-> **业务领域**: {businessDomain}
-> **集成类型**: 三方SDK集成
-
----
-
-## 1. 需求背景
-
-**背景**: [详细描述SDK集成的背景、业务需求和目标]
-
-**关键功能**: [列出SDK集成的主要功能点]
-
-**涉及角色**: [列出所有相关系统角色]
-
-## 2. {featureName}功能设计说明
-
-| | | | | |
-|---|---|---|---|---|
-|**流程编号**|F001|**流程名称**|{featureName}|
-|**业务功能编号**|BF001|**业务功能名称**|{featureName}|
-|**功能设计编号**|FD001|**系统功能名称**|{featureName}|
-|**前置条件**|[详细描述SDK集成的前置条件]|
-|**角色（岗位）**|[详细描述系统角色及其权限]|
-|**入口渠道**|[描述SDK调用入口]|
-|**功能描述**|[详细的功能描述]|
-|**调用能力域/中心**|[如适用的其他系统接口]|
-
-## 3. SDK接入流程
-
-### 3.1 接入准备工作
-[详细描述SDK接入前的准备工作，包括环境准备、依赖安装等]
-
-### 3.2 SDK初始化配置
-[详细描述SDK的初始化配置过程，包括配置参数、密钥设置等]
-
-### 3.3 SDK注册与认证
-[详细描述SDK的注册和认证流程]
-
-### 3.4 功能集成步骤
-[详细描述SDK各项功能的集成步骤]
-
-### 3.5 安全配置
-[详细描述SDK的安全配置要求，如证书、加密等]
-
-### 3.6 测试环境配置
-[详细描述SDK在测试环境中的配置要求]
-
-## 4. 接口调用说明
-
-### 4.1 主要API接口
-[列出SDK提供的主要API接口]
-
-### 4.2 接口调用示例
-[提供详细的接口调用示例代码]
-
-### 4.3 请求参数说明
-[详细说明各接口的请求参数]
-
-### 4.4 响应数据结构
-[详细说明各接口的响应数据结构]
-
-### 4.5 错误码说明
-[详细说明SDK返回的错误码及其含义]
-
-### 4.6 接口调用限制
-[详细说明SDK接口的调用频率限制和配额管理]
-
-### 4.7 异步回调处理
-[详细说明SDK异步回调的处理机制]
-
-## 5. 数据结构定义
-
-### 5.1 请求数据结构
-[详细定义请求数据的结构]
-
-### 5.2 响应数据结构
-[详细定义响应数据的结构]
-
-### 5.3 数据类型说明
-[详细说明各数据字段的类型和含义]
-
-### 5.4 数据验证规则
-[详细说明数据的验证规则和约束条件]
-
-### 5.5 数据转换规范
-[详细说明数据在不同系统间的转换规范]
-
-### 5.6 敏感数据处理
-[详细说明敏感数据的加密和处理要求]
-
-## 6. 交互逻辑说明
-
-### 6.1 调用时序
-[详细描述SDK调用的时序逻辑]
-
-### 6.2 回调处理
-[详细描述SDK回调的处理逻辑]
-
-### 6.3 异常处理
-[详细描述SDK调用异常的处理逻辑]
-
-### 6.4 重试机制
-[详细描述SDK调用失败时的重试机制]
-
-### 6.5 状态管理
-[详细描述SDK调用过程中的状态管理]
-
-### 6.6 超时处理
-[详细描述SDK调用的超时处理机制]
-
-### 6.7 并发处理
-[详细描述SDK的并发调用处理机制]
-
-## 7. 配置参数说明
-
-| | | | |
-|---|---|---|---|
-|**参数名称**|**参数类型**|**是否必填**|**说明**|
-|[参数1]|[字符串/数字等]|[是/否]|[详细说明]|
-|[参数2]|[字符串/数字等]|[是/否]|[详细说明]|
-|[添加更多参数...]|||
-
-### 7.1 环境配置参数
-[详细说明不同环境下的配置参数差异]
-
-### 7.2 性能配置参数
-[详细说明影响SDK性能的配置参数]
-
-### 7.3 安全配置参数
-[详细说明安全相关的配置参数]
-
-## 8. 安全性考虑
-
-### 8.1 数据加密
-[详细描述数据传输和存储的加密要求]
-
-### 8.2 访问控制
-[详细描述SDK访问的权限控制机制]
-
-### 8.3 密钥管理
-[详细描述密钥的管理方式]
-
-### 8.4 日志记录
-[详细描述SDK调用的日志记录要求]
-
-### 8.5 安全审计
-[详细描述SDK调用的安全审计要求]
-
-### 8.6 防御机制
-[详细描述针对SDK调用的安全防御机制]
-
-## 9. 性能优化要求
-
-### 9.1 调用性能
-[详细描述SDK调用的性能要求]
-
-### 9.2 资源占用
-[详细描述SDK对系统资源的占用要求]
-
-### 9.3 缓存策略
-[详细描述SDK的缓存使用策略]
-
-### 9.4 连接池管理
-[详细描述SDK连接池的管理策略]
-
-### 9.5 负载均衡
-[详细描述SDK调用的负载均衡策略]
-
-### 9.6 监控指标
-[详细描述SDK调用的监控指标要求]
-
-## 10. 业务对象时序图
-
-\`\`\`mermaid
-sequenceDiagram
-    participant 应用系统
-    participant SDK
-    participant 认证服务
-    participant 权限服务
-    participant 第三方服务
-    participant 数据库
-    participant 缓存服务
-    participant 消息队列
-    participant 日志服务
-    participant 监控服务
-    
-    应用系统->>SDK: 初始化请求
-    SDK->>认证服务: 验证应用凭证
-    认证服务-->>SDK: 返回认证结果
-    SDK->>权限服务: 检查应用权限
-    权限服务-->>SDK: 返回权限信息
-    SDK->>第三方服务: 发送初始化请求
-    第三方服务-->>SDK: 返回初始化响应
-    SDK->>缓存服务: 存储初始化状态
-    SDK-->>应用系统: 返回初始化成功
-    
-    %% SDK业务调用流程
-    应用系统->>SDK: 发送业务请求
-    SDK->>缓存服务: 查询缓存数据
-    alt 缓存中有数据
-        缓存服务-->>SDK: 返回缓存数据
-        SDK->>监控服务: 记录缓存命中
-    else 缓存中无数据
-        SDK->>第三方服务: 发送API调用
-        第三方服务-->>SDK: 返回API响应
-        SDK->>缓存服务: 存储到缓存
-        SDK->>监控服务: 记录API调用
-    end
-    SDK->>消息队列: 发送异步消息
-    SDK->>日志服务: 记录调用日志
-    SDK-->>应用系统: 返回业务响应
-\`\`\`
-
-### 10.2 替代流程（不同有效路径）
-
-#### 10.2.1 安全规范流程
-\`\`\`mermaid
-sequenceDiagram
-    participant 应用系统
-    participant SDK
-    participant 安全服务
-    participant 加密服务
-    participant 第三方服务
-    participant 日志服务
-    
-    应用系统->>SDK: 发送包含敏感数据的请求
-    SDK->>安全服务: 检查数据安全性
-    安全服务-->>SDK: 返回安全检查结果
-    alt 数据安全合规
-        SDK->>加密服务: 加密敏感数据
-        加密服务-->>SDK: 返回加密数据
-        SDK->>第三方服务: 发送加密请求
-        第三方服务-->>SDK: 返回响应
-        SDK-->>应用系统: 返回处理结果
-    else 数据存在安全风险
-        SDK->>日志服务: 记录安全风险
-        SDK-->>应用系统: 返回安全错误
-    end
-\`\`\`
-
-#### 10.2.2 回调处理流程
-\`\`\`mermaid
-sequenceDiagram
-    participant 应用系统
-    participant SDK
-    participant 第三方服务
-    participant 回调处理器
-    participant 状态管理器
-    participant 日志服务
-    
-    应用系统->>SDK: 发起异步操作请求
-    SDK->>第三方服务: 发送异步请求
-    第三方服务-->>SDK: 返回接收确认
-    第三方服务->>回调处理器: 发送处理结果
-    回调处理器->>状态管理器: 更新操作状态
-    状态管理器-->>回调处理器: 返回状态更新结果
-    回调处理器->>日志服务: 记录回调日志
-    回调处理器->>应用系统: 发送回调通知
-\`\`\`
-
-#### 10.2.3 SDK安全规范流程
-\`\`\`mermaid
-sequenceDiagram
-    participant 应用系统
-    participant SDK
-    participant 安全服务
-    participant 加密模块
-    participant 证书管理器
-    participant 日志服务
-    
-    应用系统->>SDK: 发送敏感数据请求
-    SDK->>安全服务: 验证请求安全性
-    安全服务-->>SDK: 返回安全检查结果
-    alt 请求安全合规
-        SDK->>加密模块: 加密敏感数据
-        加密模块-->>SDK: 返回加密数据
-        SDK->>证书管理器: 验证证书有效性
-        证书管理器-->>SDK: 返回证书验证结果
-        SDK->>第三方服务: 发送安全请求
-        第三方服务-->>SDK: 返回响应
-        SDK-->>应用系统: 返回处理结果
-    else 存在安全风险
-        SDK->>日志服务: 记录安全违规事件
-        SDK->>应用系统: 返回安全错误提示
-    end
-\`\`\`
-
-### 10.3 异常流程（错误处理）
-
-#### 10.3.1 SDK兼容性错误
-\`\`\`mermaid
-sequenceDiagram
-    participant 应用系统
-    participant SDK
-    participant 兼容性检查器
-    participant 错误处理器
-    participant 日志服务
-    
-    应用系统->>SDK: 初始化请求
-    SDK->>兼容性检查器: 检查SDK版本兼容性
-    兼容性检查器-->>SDK: 返回兼容性错误
-    SDK->>错误处理器: 处理兼容性错误
-    错误处理器->>日志服务: 记录兼容性错误
-    错误处理器-->>SDK: 返回错误处理结果
-    SDK-->>应用系统: 返回兼容性错误提示
-\`\`\`
-
-#### 10.3.2 配置冲突错误
-\`\`\`mermaid
-sequenceDiagram
-    participant 应用系统
-    participant SDK
-    participant 配置管理器
-    participant 错误处理器
-    participant 日志服务
-    
-    应用系统->>SDK: 发送配置参数
-    SDK->>配置管理器: 验证配置参数
-    配置管理器-->>SDK: 返回配置冲突
-    SDK->>错误处理器: 处理配置错误
-    错误处理器->>日志服务: 记录配置错误
-    错误处理器->>SDK: 应用默认配置
-    SDK-->>应用系统: 返回配置警告及默认配置结果
-\`\`\`
-
-#### 10.3.3 SDK初始化冲突
-\`\`\`mermaid
-sequenceDiagram
-    participant 应用系统
-    participant SDK
-    participant 初始化检查器
-    participant 依赖管理器
-    participant 错误处理器
-    participant 日志服务
-    
-    应用系统->>SDK: 发起初始化请求
-    SDK->>初始化检查器: 检查初始化状态
-    初始化检查器-->>SDK: 返回初始化状态
-    alt 未初始化
-        SDK->>依赖管理器: 检查依赖项
-        依赖管理器-->>SDK: 返回依赖检查结果
-        SDK->>SDK: 执行初始化逻辑
-        SDK-->>应用系统: 返回初始化成功
-    else 已初始化
-        SDK->>日志服务: 记录重复初始化
-        SDK-->>应用系统: 返回已初始化状态
-    else 依赖缺失
-        SDK->>错误处理器: 处理依赖错误
-        错误处理器->>日志服务: 记录依赖缺失
-        错误处理器-->>SDK: 返回错误处理结果
-        SDK-->>应用系统: 返回依赖缺失错误
-    end
-\`\`\`
-
-### 10.4 边缘情况流程（并发、超时等）
-
-#### 10.4.1 离线SDK功能处理
-\`\`\`mermaid
-sequenceDiagram
-    participant 应用系统
-    participant SDK
-    participant 网络状态检测器
-    participant 离线数据管理器
-    participant 本地数据库
-    participant 状态管理器
-    
-    应用系统->>SDK: 发送数据操作请求
-    SDK->>网络状态检测器: 检查网络状态
-    网络状态检测器-->>SDK: 返回无网络连接
-    SDK->>离线数据管理器: 处理离线操作
-    离线数据管理器->>本地数据库: 存储离线数据
-    本地数据库-->>离线数据管理器: 返回存储结果
-    离线数据管理器->>状态管理器: 更新离线状态
-    状态管理器-->>离线数据管理器: 返回状态更新结果
-    离线数据管理器-->>SDK: 返回离线处理结果
-    SDK-->>应用系统: 返回离线操作成功提示
-\`\`\`
-
-#### 10.4.2 性能优化要求
-\`\`\`mermaid
-sequenceDiagram
-    participant 应用系统
-    participant SDK
-    participant 性能优化器
-    participant 连接池管理器
-    participant 缓存管理器
-    participant 监控服务
-    
-    应用系统->>SDK: 发起高并发请求
-    SDK->>性能优化器: 分析性能需求
-    性能优化器-->>SDK: 返回优化策略
-    SDK->>连接池管理器: 应用连接池策略
-    连接池管理器-->>SDK: 返回连接池配置
-    SDK->>缓存管理器: 配置缓存策略
-    缓存管理器-->>SDK: 返回缓存配置
-    SDK->>监控服务: 记录性能指标
-    SDK-->>应用系统: 返回优化后响应
-\`\`\`
-
-#### 10.4.3 SDK资源泄漏检测
-\`\`\`mermaid
-sequenceDiagram
-    participant 应用系统
-    participant SDK
-    participant 资源管理器
-    participant 内存监控器
-    participant 日志服务
-    participant 监控服务
-    
-    应用系统->>SDK: 长时间使用SDK
-    SDK->>资源管理器: 定期检查资源状态
-    资源管理器->>内存监控器: 检查内存使用情况
-    内存监控器-->>资源管理器: 返回内存状态
-    alt 内存使用正常
-        资源管理器->>SDK: 继续正常运行
-    else 发现内存泄漏
-        资源管理器->>日志服务: 记录资源泄漏事件
-        资源管理器->>监控服务: 发送告警通知
-        资源管理器->>资源管理器: 执行资源回收
-        资源管理器-->>SDK: 返回资源回收结果
-    end
-    SDK-->>应用系统: 返回运行状态
-\`\`\`
-
-## 11. 业务状态描述
-
-| | | |
-|---|---|---|
-|**状态编号**|**状态名称**|**描述**|
-|01|未初始化|SDK未初始化状态|
-|02|初始化中|SDK初始化进行中|
-|03|已初始化|SDK初始化完成|
-|04|调用中|SDK接口调用中|
-|05|调用成功|SDK接口调用成功|
-|06|调用失败|SDK接口调用失败|
-|[添加更多状态...]
-
-## 12. 处理逻辑详细说明
-
-### 12.1 SDK初始化逻辑
-[详细描述SDK初始化的处理逻辑]
-
-### 12.2 接口调用逻辑
-[详细描述SDK接口调用的处理逻辑]
-
-### 12.3 回调处理逻辑
-[详细描述SDK回调的处理逻辑]
-
-### 12.4 错误处理逻辑
-[详细描述SDK调用错误的处理逻辑]
-
-### 12.5 资源释放逻辑
-[详细描述SDK资源释放的处理逻辑]
-
-### 12.6 重试逻辑
-[详细描述SDK调用失败时的重试处理逻辑]
-
-### 12.7 缓存逻辑
-[详细描述SDK调用中的缓存处理逻辑]
-
-## 13. 测试验证要求
-
-### 13.1 功能测试
-[详细描述SDK功能的测试要求]
-
-### 13.2 性能测试
-[详细描述SDK性能的测试要求]
-
-### 13.3 安全测试
-[详细描述SDK安全性的测试要求]
-
-### 13.4 兼容性测试
-[详细描述SDK兼容性的测试要求]
-
-### 13.5 异常测试
-[详细描述SDK异常情况的测试要求]
-
-### 13.6 回归测试
-[详细描述SDK回归测试的要求]
-
-## 14. 伪代码示例
-
-\`\`\`gherkin
-Scenario Outline: 用户通过SDK进行支付操作
-  Given 系统已初始化<sdk_name>SDK
-  When 用户发起支付请求，金额为<amount>，订单号为<order_id>
-  Then SDK应返回支付结果<result>
-
-  Examples:
-    | sdk_name | amount | order_id | result        |
-    | 支付宝    | 100.00 | ORD001   | 支付成功       |
-    | 微信支付  | 200.00 | ORD002   | 支付失败-余额不足 |
-
-Scenario Outline: SDK初始化与认证流程
-  Given 应用系统使用<sdk_type>类型的SDK
-  When 系统启动SDK初始化过程时
-  Then SDK应:
-    1. 验证应用凭证的有效性
-    2. 检查应用权限
-    3. 连接第三方服务
-    4. 返回初始化结果
-
-  Examples:
-    | sdk_type | 预期行为                              |
-    | 支付SDK  | 验证商户ID和密钥，连接支付网关        |
-    | 地图SDK  | 验证API Key，连接地图服务             |
-    | 推送SDK  | 验证应用标识，连接推送服务            |
-    | 无效凭证 | 返回初始化失败，记录错误日志          |
-
-Scenario Outline: SDK接口调用与回调处理
-  Given 应用系统已初始化<sdk_name>SDK
-  When 调用<api_method>接口并传入<parameter_status>参数时
-  Then SDK应:
-    1. 验证参数有效性
-    2. 执行API调用
-    3. 处理异步回调
-    4. 返回调用结果
-
-  Examples:
-    | sdk_name | api_method | parameter_status | 处理逻辑                                       |
-    | 支付宝    | pay        | 有效参数         | 发起支付请求，监听支付结果回调                |
-    | 微信支付  | refund     | 缺失必填参数     | 返回参数错误，详细说明缺失字段                |
-    | 地图SDK  | getLocation| 网络异常         | 重试3次后返回网络错误，提供离线定位方案       |
-    | 推送SDK  | sendMessage| 超时参数         | 设置5秒超时，超时后返回失败并记录日志         |
-    | 存储SDK  | uploadFile | 大文件           | 分块上传，支持断点续传和进度回调              |
-
-Scenario Outline: SDK错误处理与恢复机制
-  Given SDK在执行<operation_type>操作时遇到<error_type>错误
-  When 系统检测到错误并启动恢复流程时
-  Then SDK应:
-    1. 记录详细的错误日志
-    2. 根据错误类型执行恢复策略
-    3. 通知应用系统处理结果
-    4. 更新内部状态管理
-
-  Examples:
-    | operation_type | error_type    | 恢复策略                                       |
-    | 支付操作       | 网络超时      | 指数退避重试，最多重试3次，失败后返回错误码   |
-    | 文件上传       | 服务器错误    | 暂停上传，等待5分钟后自动恢复，支持手动重试   |
-    | 位置获取       | 权限拒绝      | 引导用户开启权限，提供降级方案（如IP定位）    |
-    | 消息推送       | 证书过期      | 自动更新证书，重新建立安全连接                |
-    | 数据同步       | 数据冲突      | 冲突检测与合并策略，记录冲突详情供人工处理    |
-\`\`\`
-
----
-
-**重要提醒**: 
-1. 请输出完整的Markdown文档，不要省略任何章节
-2. 每个章节都要有实质性的内容，不能只是模板
-3. 根据输入的原始内容进行具体分析，不要使用通用模板
-4. 文档总长度应该在3000字以上
-5. 表格中的内容要填写具体信息，不要保留占位符
-6. 重点关注SDK接入流程、接口调用、数据结构等技术细节
-
-现在请开始生成完整的三方SDK集成技术需求文档：`;