coze-js
coze-js copied to clipboard
Add realtime-uniapp example
Summary by CodeRabbit
-
New Features
- Launched a complete starter project for a real-time web application with a responsive, structured interface.
- Rolled out unified theming and navigation settings that support mobile, web, and mini-program experiences.
-
Chores
- Introduced extensive build and development configurations to streamline cross-platform project setup.
Walkthrough
This update introduces a new example project for UniApp V2 under the examples directory, including full project setup, configuration, and sample pages. The README files are updated to reference new UniApp examples. Additionally, the configuration is expanded to allow more UniApp-related package versions, and global SCSS variables are provided for styling consistency.
Changes
| File(s) | Change Summary |
|---|---|
| README.md, README.zh-CN.md | Added entries in the Examples section for UniApp V2 and V3 demos. |
| common/config/subspaces/default/common-versions.json | Appended allowed alternative version ranges for multiple @dcloudio UniApp-related packages and vue. |
| examples/coze-js-uniapp-v2/... (all new files in this directory) | Introduced a new UniApp V2 example project with configuration (package.json, manifest.json, pages.json, etc.), environment setup (.env.production), build scripts, Babel and PostCSS configs, TypeScript shims, SCSS variables, and Vue components for App, index, chat, and webview pages. Implements real-time voice chat demo using WebSocket, navigation UI, and platform-specific logic. |
| examples/coze-js-uniapp-v2/src/pages/chat-h5/use-voice-chat.js | Added a Vue 2 mixin for handling real-time voice chat via WebSocket, including state management, event handling, and UI integration. |
| examples/coze-js-uniapp-v2/src/uni.promisify.adaptor.js | Added a global interceptor for the uni object to adapt returned Promises for error handling. |
| examples/coze-js-uniapp-v2/src/uni.scss | Added a global SCSS file with standardized color, size, and article-related variables for consistent styling across the project. |
Sequence Diagram(s)
sequenceDiagram
participant User
participant UniAppPage (chat-h5)
participant VoiceChatMixin
participant WsChatClient
User->>UniAppPage: Clicks "Start Chat"
UniAppPage->>VoiceChatMixin: startChat()
VoiceChatMixin->>WsChatClient: Connect and initialize
WsChatClient-->>VoiceChatMixin: Emit 'connect' event
VoiceChatMixin-->>UniAppPage: Update UI (connected)
User->>UniAppPage: Speak or type message
UniAppPage->>VoiceChatMixin: sendMessage()
VoiceChatMixin->>WsChatClient: Send message
WsChatClient-->>VoiceChatMixin: Emit 'delta'/'done' events
VoiceChatMixin-->>UniAppPage: Update messages in UI
User->>UniAppPage: Clicks "Stop Chat"
UniAppPage->>VoiceChatMixin: stopChat()
VoiceChatMixin->>WsChatClient: Disconnect
WsChatClient-->>VoiceChatMixin: Emit 'disconnect' event
VoiceChatMixin-->>UniAppPage: Update UI (disconnected)
Possibly related PRs
- coze-dev/coze-js#201: Introduces core support for the Coze UniApp API, including client implementation and platform-specific integration, which directly relates to the new UniApp example and configuration in this PR.
Suggested reviewers
- DingGao-Devin
Poem
In a meadow of code, where UniApp grows,
A new V2 demo now proudly shows.
With chat that speaks and pages that glide,
Configs and styles set up with pride.
From README to SCSS, all in line—
This rabbit hops where examples shine! 🐇✨
[!WARNING] There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.
🔧 dotenv-linter (3.3.0)
examples/coze-js-uniapp-v2/.env.production
Tool run failed: Command failed with exit code 2: jk_cp -o -k -j
ERROR: need at least a chroot directory and a file to copy
Usage: /usr/sbin/jk_cp -j
[OPTIONS] -h --help : this help screen -j, --jail : the jail to copy to -v, --verbose : show what is being copied -f, --force : overwrite existing files -k, --hardlink : use hardlinks if possible -o, --owner : retain file ownership and group -s, --setuid : retain file setuid/setgid bits
Note: if no jail is specified, the first argument is considered to be the jail
✨ Finishing Touches
- [ ] 📝 Generate Docstrings
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
🪧 Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
I pushed a fix in commit <commit_id>, please review it.Explain this complex logic.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai explain this code block.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.@coderabbitai read src/utils.ts and explain its main purpose.@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.@coderabbitai help me debug CodeRabbit configuration file.
Support
Need help? Create a ticket on our support page for assistance with any issues or questions.
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.
CodeRabbit Commands (Invoked using PR comments)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
shenxiaojie.316 seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.