feat: manually mirror opencoze's code from bytedance
Change-Id: I09a73aadda978ad9511264a756b2ce51f5761adf
This commit is contained in:
107
frontend/packages/studio/stores/bot-detail/README.md
Normal file
107
frontend/packages/studio/stores/bot-detail/README.md
Normal file
@@ -0,0 +1,107 @@
|
||||
# @coze-studio/bot-detail-store
|
||||
|
||||
bot detail store
|
||||
|
||||
## Overview
|
||||
|
||||
This package is part of the Coze Studio monorepo and provides state management functionality. It includes hook, store, manager and more.
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Installation
|
||||
|
||||
Add this package to your `package.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"dependencies": {
|
||||
"@coze-studio/bot-detail-store": "workspace:*"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Then run:
|
||||
|
||||
```bash
|
||||
rush update
|
||||
```
|
||||
|
||||
### Usage
|
||||
|
||||
```typescript
|
||||
import { /* exported functions/components */ } from '@coze-studio/bot-detail-store';
|
||||
|
||||
// Example usage
|
||||
// TODO: Add specific usage examples
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
- Hook
|
||||
- Store
|
||||
- Manager
|
||||
- Modal
|
||||
|
||||
## API Reference
|
||||
|
||||
### Exports
|
||||
|
||||
- `avatarBackgroundWebSocket`
|
||||
- `useBotDetailIsReadonly`
|
||||
- `TTSInfo,
|
||||
type VariableItem,
|
||||
VariableKeyErrType,
|
||||
type TableMemoryItem,
|
||||
type SuggestQuestionMessage,
|
||||
type BotDetailSkill,
|
||||
type WorkFlowItemType,
|
||||
type DatabaseInfo,
|
||||
type DatabaseList,
|
||||
type KnowledgeConfig,
|
||||
type TagListType,
|
||||
type ExtendOnboardingContent,
|
||||
TimeCapsuleOptionsEnum,`
|
||||
- `updateHeaderStatus`
|
||||
- `initBotDetailStore`
|
||||
- `useBotDetailStoreSet`
|
||||
- `autosaveManager,
|
||||
personaSaveManager,
|
||||
botSkillSaveManager,
|
||||
multiAgentSaveManager,
|
||||
registerMultiAgentConfig,
|
||||
getBotDetailDtoInfo,
|
||||
saveConnectorType,
|
||||
saveDeleteAgents,
|
||||
saveUpdateAgents,
|
||||
saveMultiAgentData,
|
||||
saveFileboxMode,
|
||||
saveTableMemory,
|
||||
saveTTSConfig,
|
||||
saveTimeCapsule,
|
||||
saveDevHooksConfig,
|
||||
updateShortcutSort,
|
||||
updateBotRequest,`
|
||||
- `getBotDetailIsReadonly`
|
||||
- `uniqMemoryList`
|
||||
- `verifyBracesAndToast`
|
||||
|
||||
*And more...*
|
||||
|
||||
For detailed API documentation, please refer to the TypeScript definitions.
|
||||
|
||||
## Development
|
||||
|
||||
This package is built with:
|
||||
|
||||
- TypeScript
|
||||
- Modern JavaScript
|
||||
- Vitest for testing
|
||||
- ESLint for code quality
|
||||
|
||||
## Contributing
|
||||
|
||||
This package is part of the Coze Studio monorepo. Please follow the monorepo contribution guidelines.
|
||||
|
||||
## License
|
||||
|
||||
Apache-2.0
|
||||
Reference in New Issue
Block a user