coze-studio/frontend/packages/arch/bot-tea
fanlv 890153324f feat: manually mirror opencoze's code from bytedance
Change-Id: I09a73aadda978ad9511264a756b2ce51f5761adf
2025-07-20 17:36:12 +08:00
..
__tests__ feat: manually mirror opencoze's code from bytedance 2025-07-20 17:36:12 +08:00
config feat: manually mirror opencoze's code from bytedance 2025-07-20 17:36:12 +08:00
src feat: manually mirror opencoze's code from bytedance 2025-07-20 17:36:12 +08:00
README.md feat: manually mirror opencoze's code from bytedance 2025-07-20 17:36:12 +08:00
eslint.config.js feat: manually mirror opencoze's code from bytedance 2025-07-20 17:36:12 +08:00
package.json feat: manually mirror opencoze's code from bytedance 2025-07-20 17:36:12 +08:00
tsconfig.build.json feat: manually mirror opencoze's code from bytedance 2025-07-20 17:36:12 +08:00
tsconfig.json feat: manually mirror opencoze's code from bytedance 2025-07-20 17:36:12 +08:00
tsconfig.misc.json feat: manually mirror opencoze's code from bytedance 2025-07-20 17:36:12 +08:00
vitest.config.ts feat: manually mirror opencoze's code from bytedance 2025-07-20 17:36:12 +08:00

README.md

@coze-arch/bot-tea

bot tea wrapper

Overview

This package is part of the Coze Studio monorepo and provides architecture functionality. It includes store, plugin, logger.

Getting Started

Installation

Add this package to your package.json:

{
  "dependencies": {
    "@coze-arch/bot-tea": "workspace:*"
  }
}

Then run:

rush update

Usage

import { /* exported functions/components */ } from '@coze-arch/bot-tea';

// Example usage
// TODO: Add specific usage examples

Features

  • Store
  • Plugin
  • Logger

API Reference

Exports

  • EVENT_NAMES, AddWorkflowToStoreEntry, ExploreBotCardCommonParams, ShareRecallPageFrom, PluginMockSetCommonParams, SideNavClickCommonParams, AddPluginToStoreEntry, AddBotToStoreEntry, PublishAction, BotDetailPageAction, PluginPrivacyAction, PluginMockDataGenerateMode, ParamsTypeDefine, BotShareConversationClick, FlowStoreType, FlowResourceFrom, FlowDuplicateType, /** product event types */ ProductEventSource, ProductEventFilterTag, ProductEventEntityType, ProductShowFrontParams, DocClickCommonParams,
  • const LANDING_PAGE_URL_KEY = 'coze_landing_page_url';

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