Compare commits
197 Commits
feat/backu
...
v1.7.0-rc.
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c0beab0f8a | ||
|
|
97519d96d7 | ||
|
|
cbf1d461f0 | ||
|
|
bed55c418d | ||
|
|
82ef4a32eb | ||
|
|
79f75843a7 | ||
|
|
91f0c47b33 | ||
|
|
28dff9dfe3 | ||
|
|
155930ecf4 | ||
|
|
b6b999b635 | ||
|
|
0d69eeaccf | ||
|
|
ff48ce0a58 | ||
|
|
a2de7d48be | ||
|
|
d4396b4890 | ||
|
|
283519f1fd | ||
|
|
bb41709ce8 | ||
|
|
c1f4b5b9b9 | ||
|
|
5fb59d21ec | ||
|
|
e8de31ca64 | ||
|
|
69d31a1e2b | ||
|
|
fd3b7f717d | ||
|
|
bcd7bc9f2d | ||
|
|
4dd92c3ce1 | ||
|
|
dc8df98929 | ||
|
|
0004a8cafe | ||
|
|
1992363580 | ||
|
|
c901771480 | ||
|
|
475f718efb | ||
|
|
2c3338939e | ||
|
|
64ca3802a4 | ||
|
|
fa361126b8 | ||
|
|
49903a1567 | ||
|
|
086b16a59c | ||
|
|
e2562d8224 | ||
|
|
c9be949853 | ||
|
|
ebfb1c5abf | ||
|
|
c1f1d7996d | ||
|
|
0a72c613af | ||
|
|
a1ac3207f1 | ||
|
|
f98a063a8f | ||
|
|
1cb2af57ae | ||
|
|
62309ae1bf | ||
|
|
c48f222cdb | ||
|
|
cea0058f87 | ||
|
|
852192dce6 | ||
|
|
eee49d1580 | ||
|
|
dcdd1bf852 | ||
|
|
a12b6bfeca | ||
|
|
0f1a487bb0 | ||
|
|
2df8bb58df | ||
|
|
62976f6fe0 | ||
|
|
77529b3cd3 | ||
|
|
c8e9a10190 | ||
|
|
0e011ff35f | ||
|
|
40a64a7c92 | ||
|
|
dc9503ef8b | ||
|
|
f2c8484c48 | ||
|
|
a9c9224835 | ||
|
|
43223fd1f5 | ||
|
|
4bac843b37 | ||
|
|
34723934f4 | ||
|
|
096c36caf8 | ||
|
|
139950e193 | ||
|
|
31eec403f7 | ||
|
|
7fd4837a47 | ||
|
|
90b0c8b4a6 | ||
|
|
556353e910 | ||
|
|
11fb730b4d | ||
|
|
2511113b62 | ||
|
|
a29b2bb3d6 | ||
|
|
d2be450906 | ||
|
|
9c020f0d56 | ||
|
|
e033eb5b5c | ||
|
|
073d43c7cb | ||
|
|
fa7646e18f | ||
|
|
038d30831c | ||
|
|
68ee5164f0 | ||
|
|
a1a3b9bd96 | ||
|
|
4e699c48bc | ||
|
|
75fcf8fbb5 | ||
|
|
35aa9d7355 | ||
|
|
b08aecb22b | ||
|
|
45fc6c2afd | ||
|
|
d6e7ce330e | ||
|
|
4f7d8731ea | ||
|
|
2b5ac5ab51 | ||
|
|
060fcd2ce6 | ||
|
|
a6182eaf85 | ||
|
|
649f9420a4 | ||
|
|
2552d97ea7 | ||
|
|
803f4b5a64 | ||
|
|
31f8fff6e2 | ||
|
|
2663cb19ce | ||
|
|
ce5d46bfc7 | ||
|
|
c1fa24522d | ||
|
|
2f66f5b511 | ||
|
|
2d8555c326 | ||
|
|
e2c8edab61 | ||
|
|
5e0a66fa1f | ||
|
|
bc8b0a8d53 | ||
|
|
e43562423e | ||
|
|
120ac122eb | ||
|
|
9013fcba14 | ||
|
|
c32f4badbd | ||
|
|
66f66fe08e | ||
|
|
d5826c2dc7 | ||
|
|
85a628f8dd | ||
|
|
ed453750fe | ||
|
|
57d9a31c0f | ||
|
|
58afbe8a79 | ||
|
|
9a10516b52 | ||
|
|
e268e69597 | ||
|
|
10e78ac60e | ||
|
|
44b2b859da | ||
|
|
bfef0c5580 | ||
|
|
1e8055031a | ||
|
|
8e33ff8d90 | ||
|
|
a619000340 | ||
|
|
78278ce96d | ||
|
|
76483d828e | ||
|
|
816a92c609 | ||
|
|
83e4d4363f | ||
|
|
1103449a4f | ||
|
|
56c7a7f066 | ||
|
|
caa59c4c50 | ||
|
|
2546dfbe5d | ||
|
|
5fea202a7d | ||
|
|
7dce1d776b | ||
|
|
346af4d338 | ||
|
|
abd5d3b96f | ||
|
|
49bd298d37 | ||
|
|
714a28ac29 | ||
|
|
0cf81c04c8 | ||
|
|
4186e9c990 | ||
|
|
d8f68a6056 | ||
|
|
11bf50e722 | ||
|
|
32a84311aa | ||
|
|
6eaa2b2461 | ||
|
|
9f00f00546 | ||
|
|
bd94d23343 | ||
|
|
5f1c14e2c0 | ||
|
|
cdc12d5092 | ||
|
|
e5967fd874 | ||
|
|
e2f1d80697 | ||
|
|
28bc89ac7c | ||
|
|
dc06c103e0 | ||
|
|
1f0381aebe | ||
|
|
fb02a61a48 | ||
|
|
562fbb3ff7 | ||
|
|
1018ad87b8 | ||
|
|
82ca35fc29 | ||
|
|
fe53b0914a | ||
|
|
67a379641f | ||
|
|
9dbc6fbf67 | ||
|
|
8da43ab794 | ||
|
|
2a06c606e1 | ||
|
|
b6dcf2f5fa | ||
|
|
68e0d8b0f1 | ||
|
|
7f1c234ac1 | ||
|
|
c1fd23742f | ||
|
|
d792bf7fe0 | ||
|
|
f8a599322f | ||
|
|
aa810a7ead | ||
|
|
b586e1796e | ||
|
|
fa2ec69fa9 | ||
|
|
dd8690b592 | ||
|
|
09e6b9741e | ||
|
|
0767952a6f | ||
|
|
72299f833a | ||
|
|
7badaf02b9 | ||
|
|
dfbfc2869c | ||
|
|
1575e97168 | ||
|
|
e0a2ed0481 | ||
|
|
5790c12011 | ||
|
|
352ecbc506 | ||
|
|
fc4f30feab | ||
|
|
888a183328 | ||
|
|
9a01e092f6 | ||
|
|
5986800c9d | ||
|
|
56d68276e1 | ||
|
|
29c1173365 | ||
|
|
c7ceb3035d | ||
|
|
7bcae6fba2 | ||
|
|
9776b4e46c | ||
|
|
250f59234b | ||
|
|
82132d479a | ||
|
|
44e01e5ad4 | ||
|
|
c5ce0b763b | ||
|
|
f5a1d3f8d0 | ||
|
|
d8f1a68e87 | ||
|
|
8054ed7ad8 | ||
|
|
487b5c4d8a | ||
|
|
dedfc79406 | ||
|
|
1f0fd8215a | ||
|
|
e69fd7f22b | ||
|
|
ac4aa33e79 | ||
|
|
6795a044fa |
4
.github/CODEOWNERS
vendored
@@ -1,4 +1,6 @@
|
|||||||
/src/renderer/src/store/ @0xfullex
|
/src/renderer/src/store/ @0xfullex
|
||||||
|
/src/renderer/src/databases/ @0xfullex
|
||||||
/src/main/services/ConfigManager.ts @0xfullex
|
/src/main/services/ConfigManager.ts @0xfullex
|
||||||
/packages/shared/IpcChannel.ts @0xfullex
|
/packages/shared/IpcChannel.ts @0xfullex
|
||||||
/src/main/ipc.ts @0xfullex
|
/src/main/ipc.ts @0xfullex
|
||||||
|
/app-upgrade-config.json @kangfenmao
|
||||||
|
|||||||
2
.github/ISSUE_TEMPLATE/0_bug_report.yml
vendored
@@ -1,4 +1,4 @@
|
|||||||
name: 🐛 Bug Report (English)
|
name: 🐛 Bug Report
|
||||||
description: Create a report to help us improve
|
description: Create a report to help us improve
|
||||||
title: '[Bug]: '
|
title: '[Bug]: '
|
||||||
labels: ['BUG']
|
labels: ['BUG']
|
||||||
|
|||||||
2
.github/ISSUE_TEMPLATE/1_feature_request.yml
vendored
@@ -1,4 +1,4 @@
|
|||||||
name: 💡 Feature Request (English)
|
name: 💡 Feature Request
|
||||||
description: Suggest an idea for this project
|
description: Suggest an idea for this project
|
||||||
title: '[Feature]: '
|
title: '[Feature]: '
|
||||||
labels: ['feature']
|
labels: ['feature']
|
||||||
|
|||||||
2
.github/ISSUE_TEMPLATE/3_others.yml
vendored
@@ -1,4 +1,4 @@
|
|||||||
name: 🤔 Other Questions (English)
|
name: 🤔 Other Questions
|
||||||
description: Submit questions that don't fit into bug reports or feature requests
|
description: Submit questions that don't fit into bug reports or feature requests
|
||||||
title: '[Other]: '
|
title: '[Other]: '
|
||||||
body:
|
body:
|
||||||
|
|||||||
12
.github/pull_request_template.md
vendored
@@ -3,6 +3,18 @@
|
|||||||
1. Consider creating this PR as draft: https://github.com/CherryHQ/cherry-studio/blob/main/CONTRIBUTING.md
|
1. Consider creating this PR as draft: https://github.com/CherryHQ/cherry-studio/blob/main/CONTRIBUTING.md
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
<!--
|
||||||
|
|
||||||
|
⚠️ Important: Redux/IndexedDB Data-Changing Feature PRs Temporarily On Hold ⚠️
|
||||||
|
|
||||||
|
Please note: For our current development cycle, we are not accepting feature Pull Requests that introduce changes to Redux data models or IndexedDB schemas.
|
||||||
|
|
||||||
|
While we value your contributions, PRs of this nature will be blocked without merge. We welcome all other contributions (bug fixes, perf enhancements, docs, etc.). Thank you!
|
||||||
|
|
||||||
|
Once version 2.0.0 is released, we will resume reviewing feature PRs.
|
||||||
|
|
||||||
|
-->
|
||||||
|
|
||||||
### What this PR does
|
### What this PR does
|
||||||
|
|
||||||
Before this PR:
|
Before this PR:
|
||||||
|
|||||||
89
.github/workflows/auto-i18n.yml
vendored
@@ -1,19 +1,21 @@
|
|||||||
name: Auto I18N
|
name: Auto I18N Weekly
|
||||||
|
|
||||||
env:
|
env:
|
||||||
TRANSLATION_API_KEY: ${{ secrets.TRANSLATE_API_KEY }}
|
TRANSLATION_API_KEY: ${{ secrets.TRANSLATE_API_KEY }}
|
||||||
TRANSLATION_MODEL: ${{ vars.AUTO_I18N_MODEL || 'deepseek/deepseek-v3.1'}}
|
TRANSLATION_MODEL: ${{ vars.AUTO_I18N_MODEL || 'deepseek/deepseek-v3.1'}}
|
||||||
TRANSLATION_BASE_URL: ${{ vars.AUTO_I18N_BASE_URL || 'https://api.ppinfra.com/openai'}}
|
TRANSLATION_BASE_URL: ${{ vars.AUTO_I18N_BASE_URL || 'https://api.ppinfra.com/openai'}}
|
||||||
|
TRANSLATION_BASE_LOCALE: ${{ vars.AUTO_I18N_BASE_LOCALE || 'en-us'}}
|
||||||
|
|
||||||
on:
|
on:
|
||||||
pull_request:
|
schedule:
|
||||||
types: [opened, synchronize, reopened]
|
# Runs at 00:00 UTC every Sunday.
|
||||||
|
# This corresponds to 08:00 AM UTC+8 (Beijing time) every Sunday.
|
||||||
|
- cron: "0 0 * * 0"
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
auto-i18n:
|
auto-i18n:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
if: github.event_name == 'workflow_dispatch' || github.event.pull_request.head.repo.full_name == 'CherryHQ/cherry-studio'
|
|
||||||
name: Auto I18N
|
name: Auto I18N
|
||||||
permissions:
|
permissions:
|
||||||
contents: write
|
contents: write
|
||||||
@@ -23,44 +25,69 @@ jobs:
|
|||||||
- name: 🐈⬛ Checkout
|
- name: 🐈⬛ Checkout
|
||||||
uses: actions/checkout@v5
|
uses: actions/checkout@v5
|
||||||
with:
|
with:
|
||||||
ref: ${{ github.event.pull_request.head.ref }}
|
fetch-depth: 0
|
||||||
|
|
||||||
- name: 📦 Setting Node.js
|
- name: 📦 Setting Node.js
|
||||||
uses: actions/setup-node@v5
|
uses: actions/setup-node@v6
|
||||||
with:
|
with:
|
||||||
node-version: 20
|
node-version: 22
|
||||||
|
|
||||||
- name: 📦 Install dependencies in isolated directory
|
- name: 📦 Install corepack
|
||||||
|
run: corepack enable && corepack prepare yarn@4.9.1 --activate
|
||||||
|
|
||||||
|
- name: 📂 Get yarn cache directory path
|
||||||
|
id: yarn-cache-dir-path
|
||||||
|
run: echo "dir=$(yarn config get cacheFolder)" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
- name: 💾 Cache yarn dependencies
|
||||||
|
uses: actions/cache@v4
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
${{ steps.yarn-cache-dir-path.outputs.dir }}
|
||||||
|
node_modules
|
||||||
|
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
|
||||||
|
restore-keys: |
|
||||||
|
${{ runner.os }}-yarn-
|
||||||
|
|
||||||
|
- name: 📦 Install dependencies
|
||||||
run: |
|
run: |
|
||||||
# 在临时目录安装依赖
|
yarn install
|
||||||
mkdir -p /tmp/translation-deps
|
|
||||||
cd /tmp/translation-deps
|
|
||||||
echo '{"dependencies": {"@cherrystudio/openai": "^6.5.0", "cli-progress": "^3.12.0", "tsx": "^4.20.3", "@biomejs/biome": "2.2.4"}}' > package.json
|
|
||||||
npm install --no-package-lock
|
|
||||||
|
|
||||||
# 设置 NODE_PATH 让项目能找到这些依赖
|
|
||||||
echo "NODE_PATH=/tmp/translation-deps/node_modules" >> $GITHUB_ENV
|
|
||||||
|
|
||||||
- name: 🏃♀️ Translate
|
- name: 🏃♀️ Translate
|
||||||
run: npx tsx scripts/sync-i18n.ts && npx tsx scripts/auto-translate-i18n.ts
|
run: yarn sync:i18n && yarn auto:i18n
|
||||||
|
|
||||||
- name: 🔍 Format
|
- name: 🔍 Format
|
||||||
run: cd /tmp/translation-deps && npx biome format --config-path /home/runner/work/cherry-studio/cherry-studio/biome.jsonc --write /home/runner/work/cherry-studio/cherry-studio/src/renderer/src/i18n/
|
run: yarn format
|
||||||
|
|
||||||
- name: 🔄 Commit changes
|
- name: 🔍 Check for changes
|
||||||
|
id: git_status
|
||||||
run: |
|
run: |
|
||||||
git config --local user.email "action@github.com"
|
# Check if there are any uncommitted changes
|
||||||
git config --local user.name "GitHub Action"
|
|
||||||
git add .
|
|
||||||
git reset -- package.json yarn.lock # 不提交 package.json 和 yarn.lock 的更改
|
git reset -- package.json yarn.lock # 不提交 package.json 和 yarn.lock 的更改
|
||||||
if git diff --cached --quiet; then
|
git diff --exit-code --quiet || echo "::set-output name=has_changes::true"
|
||||||
echo "No changes to commit"
|
git status --porcelain
|
||||||
else
|
|
||||||
git commit -m "fix(i18n): Auto update translations for PR #${{ github.event.pull_request.number }}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
- name: 🚀 Push changes
|
- name: 📅 Set current date for PR title
|
||||||
uses: ad-m/github-push-action@master
|
id: set_date
|
||||||
|
run: echo "CURRENT_DATE=$(date +'%b %d, %Y')" >> $GITHUB_ENV # e.g., "Jun 06, 2024"
|
||||||
|
|
||||||
|
- name: 🚀 Create Pull Request if changes exist
|
||||||
|
if: steps.git_status.outputs.has_changes == 'true'
|
||||||
|
uses: peter-evans/create-pull-request@v6
|
||||||
with:
|
with:
|
||||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
token: ${{ secrets.GITHUB_TOKEN }} # Use the built-in GITHUB_TOKEN for bot actions
|
||||||
branch: ${{ github.event.pull_request.head.ref }}
|
commit-message: "feat(bot): Weekly automated script run"
|
||||||
|
title: "🤖 Weekly Auto I18N Sync: ${{ env.CURRENT_DATE }}"
|
||||||
|
body: |
|
||||||
|
This PR includes changes generated by the weekly auto i18n.
|
||||||
|
Review the changes before merging.
|
||||||
|
|
||||||
|
---
|
||||||
|
_Generated by the automated weekly workflow_
|
||||||
|
branch: "auto-i18n-weekly-${{ github.run_id }}" # Unique branch name
|
||||||
|
base: "main" # Or 'develop', set your base branch
|
||||||
|
delete-branch: true # Delete the branch after merging or closing the PR
|
||||||
|
|
||||||
|
- name: 📢 Notify if no changes
|
||||||
|
if: steps.git_status.outputs.has_changes != 'true'
|
||||||
|
run: echo "Bot script ran, but no changes were detected. No PR created."
|
||||||
|
|||||||
10
.github/workflows/github-issue-tracker.yml
vendored
@@ -5,7 +5,7 @@ on:
|
|||||||
types: [opened]
|
types: [opened]
|
||||||
schedule:
|
schedule:
|
||||||
# Run every day at 8:30 Beijing Time (00:30 UTC)
|
# Run every day at 8:30 Beijing Time (00:30 UTC)
|
||||||
- cron: '30 0 * * *'
|
- cron: "30 0 * * *"
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
@@ -54,9 +54,9 @@ jobs:
|
|||||||
|
|
||||||
- name: Setup Node.js
|
- name: Setup Node.js
|
||||||
if: steps.check_time.outputs.should_delay == 'false'
|
if: steps.check_time.outputs.should_delay == 'false'
|
||||||
uses: actions/setup-node@v4
|
uses: actions/setup-node@v6
|
||||||
with:
|
with:
|
||||||
node-version: '20'
|
node-version: 22
|
||||||
|
|
||||||
- name: Process issue with Claude
|
- name: Process issue with Claude
|
||||||
if: steps.check_time.outputs.should_delay == 'false'
|
if: steps.check_time.outputs.should_delay == 'false'
|
||||||
@@ -121,9 +121,9 @@ jobs:
|
|||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Setup Node.js
|
- name: Setup Node.js
|
||||||
uses: actions/setup-node@v4
|
uses: actions/setup-node@v6
|
||||||
with:
|
with:
|
||||||
node-version: '20'
|
node-version: 22
|
||||||
|
|
||||||
- name: Process pending issues with Claude
|
- name: Process pending issues with Claude
|
||||||
uses: anthropics/claude-code-action@main
|
uses: anthropics/claude-code-action@main
|
||||||
|
|||||||
10
.github/workflows/issue-management.yml
vendored
@@ -21,7 +21,7 @@ jobs:
|
|||||||
contents: none
|
contents: none
|
||||||
steps:
|
steps:
|
||||||
- name: Close needs-more-info issues
|
- name: Close needs-more-info issues
|
||||||
uses: actions/stale@v9
|
uses: actions/stale@v10
|
||||||
with:
|
with:
|
||||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
only-labels: 'needs-more-info'
|
only-labels: 'needs-more-info'
|
||||||
@@ -29,8 +29,10 @@ jobs:
|
|||||||
days-before-close: 0 # Close immediately after stale
|
days-before-close: 0 # Close immediately after stale
|
||||||
stale-issue-label: 'inactive'
|
stale-issue-label: 'inactive'
|
||||||
close-issue-label: 'closed:no-response'
|
close-issue-label: 'closed:no-response'
|
||||||
|
exempt-all-milestones: true
|
||||||
|
exempt-all-assignees: true
|
||||||
stale-issue-message: |
|
stale-issue-message: |
|
||||||
This issue has been labeled as needing more information and has been inactive for ${{ env.daysBeforeStale }} days.
|
This issue has been labeled as needing more information and has been inactive for ${{ env.daysBeforeStale }} days.
|
||||||
It will be closed now due to lack of additional information.
|
It will be closed now due to lack of additional information.
|
||||||
|
|
||||||
该问题被标记为"需要更多信息"且已经 ${{ env.daysBeforeStale }} 天没有任何活动,将立即关闭。
|
该问题被标记为"需要更多信息"且已经 ${{ env.daysBeforeStale }} 天没有任何活动,将立即关闭。
|
||||||
@@ -40,12 +42,14 @@ jobs:
|
|||||||
days-before-pr-close: -1
|
days-before-pr-close: -1
|
||||||
|
|
||||||
- name: Close inactive issues
|
- name: Close inactive issues
|
||||||
uses: actions/stale@v9
|
uses: actions/stale@v10
|
||||||
with:
|
with:
|
||||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
days-before-stale: ${{ env.daysBeforeStale }}
|
days-before-stale: ${{ env.daysBeforeStale }}
|
||||||
days-before-close: ${{ env.daysBeforeClose }}
|
days-before-close: ${{ env.daysBeforeClose }}
|
||||||
stale-issue-label: 'inactive'
|
stale-issue-label: 'inactive'
|
||||||
|
exempt-all-milestones: true
|
||||||
|
exempt-all-assignees: true
|
||||||
stale-issue-message: |
|
stale-issue-message: |
|
||||||
This issue has been inactive for a prolonged period and will be closed automatically in ${{ env.daysBeforeClose }} days.
|
This issue has been inactive for a prolonged period and will be closed automatically in ${{ env.daysBeforeClose }} days.
|
||||||
该问题已长时间处于闲置状态,${{ env.daysBeforeClose }} 天后将自动关闭。
|
该问题已长时间处于闲置状态,${{ env.daysBeforeClose }} 天后将自动关闭。
|
||||||
|
|||||||
10
.github/workflows/nightly-build.yml
vendored
@@ -3,7 +3,7 @@ name: Nightly Build
|
|||||||
on:
|
on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
schedule:
|
schedule:
|
||||||
- cron: '0 17 * * *' # 1:00 BJ Time
|
- cron: "0 17 * * *" # 1:00 BJ Time
|
||||||
|
|
||||||
permissions:
|
permissions:
|
||||||
contents: write
|
contents: write
|
||||||
@@ -56,9 +56,9 @@ jobs:
|
|||||||
ref: main
|
ref: main
|
||||||
|
|
||||||
- name: Install Node.js
|
- name: Install Node.js
|
||||||
uses: actions/setup-node@v5
|
uses: actions/setup-node@v6
|
||||||
with:
|
with:
|
||||||
node-version: 20
|
node-version: 22
|
||||||
|
|
||||||
- name: macos-latest dependencies fix
|
- name: macos-latest dependencies fix
|
||||||
if: matrix.os == 'macos-latest'
|
if: matrix.os == 'macos-latest'
|
||||||
@@ -66,7 +66,7 @@ jobs:
|
|||||||
brew install python-setuptools
|
brew install python-setuptools
|
||||||
|
|
||||||
- name: Install corepack
|
- name: Install corepack
|
||||||
run: corepack enable && corepack prepare yarn@4.6.0 --activate
|
run: corepack enable && corepack prepare yarn@4.9.1 --activate
|
||||||
|
|
||||||
- name: Get yarn cache directory path
|
- name: Get yarn cache directory path
|
||||||
id: yarn-cache-dir-path
|
id: yarn-cache-dir-path
|
||||||
@@ -208,7 +208,7 @@ jobs:
|
|||||||
echo "总计: $(find renamed-artifacts -type f | wc -l) 个文件"
|
echo "总计: $(find renamed-artifacts -type f | wc -l) 个文件"
|
||||||
|
|
||||||
- name: Upload artifacts
|
- name: Upload artifacts
|
||||||
uses: actions/upload-artifact@v4
|
uses: actions/upload-artifact@v5
|
||||||
with:
|
with:
|
||||||
name: cherry-studio-nightly-${{ steps.date.outputs.date }}-${{ matrix.os }}
|
name: cherry-studio-nightly-${{ steps.date.outputs.date }}-${{ matrix.os }}
|
||||||
path: renamed-artifacts/*
|
path: renamed-artifacts/*
|
||||||
|
|||||||
6
.github/workflows/pr-ci.yml
vendored
@@ -24,12 +24,12 @@ jobs:
|
|||||||
uses: actions/checkout@v5
|
uses: actions/checkout@v5
|
||||||
|
|
||||||
- name: Install Node.js
|
- name: Install Node.js
|
||||||
uses: actions/setup-node@v5
|
uses: actions/setup-node@v6
|
||||||
with:
|
with:
|
||||||
node-version: 20
|
node-version: 22
|
||||||
|
|
||||||
- name: Install corepack
|
- name: Install corepack
|
||||||
run: corepack enable && corepack prepare yarn@4.6.0 --activate
|
run: corepack enable && corepack prepare yarn@4.9.1 --activate
|
||||||
|
|
||||||
- name: Get yarn cache directory path
|
- name: Get yarn cache directory path
|
||||||
id: yarn-cache-dir-path
|
id: yarn-cache-dir-path
|
||||||
|
|||||||
12
.github/workflows/release.yml
vendored
@@ -4,9 +4,9 @@ on:
|
|||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
inputs:
|
inputs:
|
||||||
tag:
|
tag:
|
||||||
description: 'Release tag (e.g. v1.0.0)'
|
description: "Release tag (e.g. v1.0.0)"
|
||||||
required: true
|
required: true
|
||||||
default: 'v1.0.0'
|
default: "v1.0.0"
|
||||||
push:
|
push:
|
||||||
tags:
|
tags:
|
||||||
- v*.*.*
|
- v*.*.*
|
||||||
@@ -47,9 +47,9 @@ jobs:
|
|||||||
npm version "$VERSION" --no-git-tag-version --allow-same-version
|
npm version "$VERSION" --no-git-tag-version --allow-same-version
|
||||||
|
|
||||||
- name: Install Node.js
|
- name: Install Node.js
|
||||||
uses: actions/setup-node@v5
|
uses: actions/setup-node@v6
|
||||||
with:
|
with:
|
||||||
node-version: 20
|
node-version: 22
|
||||||
|
|
||||||
- name: macos-latest dependencies fix
|
- name: macos-latest dependencies fix
|
||||||
if: matrix.os == 'macos-latest'
|
if: matrix.os == 'macos-latest'
|
||||||
@@ -57,7 +57,7 @@ jobs:
|
|||||||
brew install python-setuptools
|
brew install python-setuptools
|
||||||
|
|
||||||
- name: Install corepack
|
- name: Install corepack
|
||||||
run: corepack enable && corepack prepare yarn@4.6.0 --activate
|
run: corepack enable && corepack prepare yarn@4.9.1 --activate
|
||||||
|
|
||||||
- name: Get yarn cache directory path
|
- name: Get yarn cache directory path
|
||||||
id: yarn-cache-dir-path
|
id: yarn-cache-dir-path
|
||||||
@@ -127,5 +127,5 @@ jobs:
|
|||||||
allowUpdates: true
|
allowUpdates: true
|
||||||
makeLatest: false
|
makeLatest: false
|
||||||
tag: ${{ steps.get-tag.outputs.tag }}
|
tag: ${{ steps.get-tag.outputs.tag }}
|
||||||
artifacts: 'dist/*.exe,dist/*.zip,dist/*.dmg,dist/*.AppImage,dist/*.snap,dist/*.deb,dist/*.rpm,dist/*.tar.gz,dist/latest*.yml,dist/rc*.yml,dist/beta*.yml,dist/*.blockmap'
|
artifacts: "dist/*.exe,dist/*.zip,dist/*.dmg,dist/*.AppImage,dist/*.snap,dist/*.deb,dist/*.rpm,dist/*.tar.gz,dist/latest*.yml,dist/rc*.yml,dist/beta*.yml,dist/*.blockmap"
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|||||||
212
.github/workflows/update-app-upgrade-config.yml
vendored
Normal file
@@ -0,0 +1,212 @@
|
|||||||
|
name: Update App Upgrade Config
|
||||||
|
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types:
|
||||||
|
- released
|
||||||
|
- prereleased
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
tag:
|
||||||
|
description: "Release tag (e.g., v1.2.3)"
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
is_prerelease:
|
||||||
|
description: "Mark the tag as a prerelease when running manually"
|
||||||
|
required: false
|
||||||
|
default: false
|
||||||
|
type: boolean
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
pull-requests: write
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
propose-update:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
if: github.event_name == 'workflow_dispatch' || (github.event_name == 'release' && github.event.release.draft == false)
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Check if should proceed
|
||||||
|
id: check
|
||||||
|
run: |
|
||||||
|
EVENT="${{ github.event_name }}"
|
||||||
|
|
||||||
|
if [ "$EVENT" = "workflow_dispatch" ]; then
|
||||||
|
TAG="${{ github.event.inputs.tag }}"
|
||||||
|
else
|
||||||
|
TAG="${{ github.event.release.tag_name }}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
latest_tag=$(
|
||||||
|
curl -L \
|
||||||
|
-H "Accept: application/vnd.github+json" \
|
||||||
|
-H "Authorization: Bearer ${{ github.token }}" \
|
||||||
|
-H "X-GitHub-Api-Version: 2022-11-28" \
|
||||||
|
https://api.github.com/repos/${{ github.repository }}/releases/latest \
|
||||||
|
| jq -r '.tag_name'
|
||||||
|
)
|
||||||
|
|
||||||
|
if [ "$EVENT" = "workflow_dispatch" ]; then
|
||||||
|
MANUAL_IS_PRERELEASE="${{ github.event.inputs.is_prerelease }}"
|
||||||
|
if [ -z "$MANUAL_IS_PRERELEASE" ]; then
|
||||||
|
MANUAL_IS_PRERELEASE="false"
|
||||||
|
fi
|
||||||
|
if [ "$MANUAL_IS_PRERELEASE" = "true" ]; then
|
||||||
|
if ! echo "$TAG" | grep -E '(-beta([.-][0-9]+)?|-rc([.-][0-9]+)?)' >/dev/null; then
|
||||||
|
echo "Manual prerelease flag set but tag $TAG lacks beta/rc suffix. Skipping." >&2
|
||||||
|
echo "should_run=false" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "is_prerelease=false" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "latest_tag=$latest_tag" >> "$GITHUB_OUTPUT"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
echo "should_run=true" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "is_prerelease=$MANUAL_IS_PRERELEASE" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "latest_tag=$latest_tag" >> "$GITHUB_OUTPUT"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
IS_PRERELEASE="${{ github.event.release.prerelease }}"
|
||||||
|
|
||||||
|
if [ "$IS_PRERELEASE" = "true" ]; then
|
||||||
|
if ! echo "$TAG" | grep -E '(-beta([.-][0-9]+)?|-rc([.-][0-9]+)?)' >/dev/null; then
|
||||||
|
echo "Release marked as prerelease but tag $TAG lacks beta/rc suffix. Skipping." >&2
|
||||||
|
echo "should_run=false" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "is_prerelease=false" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "latest_tag=$latest_tag" >> "$GITHUB_OUTPUT"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
echo "should_run=true" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "is_prerelease=true" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "latest_tag=$latest_tag" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "Release is prerelease, proceeding"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ "${latest_tag}" == "$TAG" ]]; then
|
||||||
|
echo "should_run=true" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "is_prerelease=false" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "latest_tag=$latest_tag" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "Release is latest, proceeding"
|
||||||
|
else
|
||||||
|
echo "should_run=false" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "is_prerelease=false" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "latest_tag=$latest_tag" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "Release is neither prerelease nor latest, skipping"
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Prepare metadata
|
||||||
|
id: meta
|
||||||
|
if: steps.check.outputs.should_run == 'true'
|
||||||
|
run: |
|
||||||
|
EVENT="${{ github.event_name }}"
|
||||||
|
LATEST_TAG="${{ steps.check.outputs.latest_tag }}"
|
||||||
|
if [ "$EVENT" = "release" ]; then
|
||||||
|
TAG="${{ github.event.release.tag_name }}"
|
||||||
|
PRE="${{ github.event.release.prerelease }}"
|
||||||
|
|
||||||
|
if [ -n "$LATEST_TAG" ] && [ "$LATEST_TAG" = "$TAG" ]; then
|
||||||
|
LATEST="true"
|
||||||
|
else
|
||||||
|
LATEST="false"
|
||||||
|
fi
|
||||||
|
TRIGGER="release"
|
||||||
|
else
|
||||||
|
TAG="${{ github.event.inputs.tag }}"
|
||||||
|
PRE="${{ github.event.inputs.is_prerelease }}"
|
||||||
|
if [ -z "$PRE" ]; then
|
||||||
|
PRE="false"
|
||||||
|
fi
|
||||||
|
if [ -n "$LATEST_TAG" ] && [ "$LATEST_TAG" = "$TAG" ] && [ "$PRE" != "true" ]; then
|
||||||
|
LATEST="true"
|
||||||
|
else
|
||||||
|
LATEST="false"
|
||||||
|
fi
|
||||||
|
TRIGGER="manual"
|
||||||
|
fi
|
||||||
|
|
||||||
|
SAFE_TAG=$(echo "$TAG" | sed 's/[^A-Za-z0-9._-]/-/g')
|
||||||
|
echo "tag=$TAG" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "safe_tag=$SAFE_TAG" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "prerelease=$PRE" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "latest=$LATEST" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "trigger=$TRIGGER" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
|
- name: Checkout default branch
|
||||||
|
if: steps.check.outputs.should_run == 'true'
|
||||||
|
uses: actions/checkout@v5
|
||||||
|
with:
|
||||||
|
ref: ${{ github.event.repository.default_branch }}
|
||||||
|
path: main
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Checkout x-files/app-upgrade-config branch
|
||||||
|
if: steps.check.outputs.should_run == 'true'
|
||||||
|
uses: actions/checkout@v5
|
||||||
|
with:
|
||||||
|
ref: x-files/app-upgrade-config
|
||||||
|
path: cs
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Setup Node.js
|
||||||
|
if: steps.check.outputs.should_run == 'true'
|
||||||
|
uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: 22
|
||||||
|
|
||||||
|
- name: Enable Corepack
|
||||||
|
if: steps.check.outputs.should_run == 'true'
|
||||||
|
run: corepack enable && corepack prepare yarn@4.9.1 --activate
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
if: steps.check.outputs.should_run == 'true'
|
||||||
|
working-directory: main
|
||||||
|
run: yarn install --immutable
|
||||||
|
|
||||||
|
- name: Update upgrade config
|
||||||
|
if: steps.check.outputs.should_run == 'true'
|
||||||
|
working-directory: main
|
||||||
|
env:
|
||||||
|
RELEASE_TAG: ${{ steps.meta.outputs.tag }}
|
||||||
|
IS_PRERELEASE: ${{ steps.check.outputs.is_prerelease }}
|
||||||
|
run: |
|
||||||
|
yarn tsx scripts/update-app-upgrade-config.ts \
|
||||||
|
--tag "$RELEASE_TAG" \
|
||||||
|
--config ../cs/app-upgrade-config.json \
|
||||||
|
--is-prerelease "$IS_PRERELEASE"
|
||||||
|
|
||||||
|
- name: Detect changes
|
||||||
|
if: steps.check.outputs.should_run == 'true'
|
||||||
|
id: diff
|
||||||
|
working-directory: cs
|
||||||
|
run: |
|
||||||
|
if git diff --quiet -- app-upgrade-config.json; then
|
||||||
|
echo "changed=false" >> "$GITHUB_OUTPUT"
|
||||||
|
else
|
||||||
|
echo "changed=true" >> "$GITHUB_OUTPUT"
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Create pull request
|
||||||
|
if: steps.check.outputs.should_run == 'true' && steps.diff.outputs.changed == 'true'
|
||||||
|
uses: peter-evans/create-pull-request@v7
|
||||||
|
with:
|
||||||
|
path: cs
|
||||||
|
base: x-files/app-upgrade-config
|
||||||
|
branch: chore/update-app-upgrade-config/${{ steps.meta.outputs.safe_tag }}
|
||||||
|
commit-message: "🤖 chore: sync app-upgrade-config for ${{ steps.meta.outputs.tag }}"
|
||||||
|
title: "chore: update app-upgrade-config for ${{ steps.meta.outputs.tag }}"
|
||||||
|
body: |
|
||||||
|
Automated update triggered by `${{ steps.meta.outputs.trigger }}`.
|
||||||
|
|
||||||
|
- Source tag: `${{ steps.meta.outputs.tag }}`
|
||||||
|
- Pre-release: `${{ steps.meta.outputs.prerelease }}`
|
||||||
|
- Latest: `${{ steps.meta.outputs.latest }}`
|
||||||
|
- Workflow run: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
|
||||||
|
labels: |
|
||||||
|
automation
|
||||||
|
app-upgrade
|
||||||
|
|
||||||
|
- name: No changes detected
|
||||||
|
if: steps.check.outputs.should_run == 'true' && steps.diff.outputs.changed != 'true'
|
||||||
|
run: echo "No updates required for x-files/app-upgrade-config/app-upgrade-config.json"
|
||||||
@@ -22,7 +22,6 @@
|
|||||||
"eslint.config.mjs"
|
"eslint.config.mjs"
|
||||||
],
|
],
|
||||||
"overrides": [
|
"overrides": [
|
||||||
// set different env
|
|
||||||
{
|
{
|
||||||
"env": {
|
"env": {
|
||||||
"node": true
|
"node": true
|
||||||
@@ -36,8 +35,7 @@
|
|||||||
"files": [
|
"files": [
|
||||||
"src/renderer/**/*.{ts,tsx}",
|
"src/renderer/**/*.{ts,tsx}",
|
||||||
"packages/aiCore/**",
|
"packages/aiCore/**",
|
||||||
"packages/extension-table-plus/**",
|
"packages/extension-table-plus/**"
|
||||||
"resources/js/**"
|
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -53,76 +51,24 @@
|
|||||||
"node": true
|
"node": true
|
||||||
},
|
},
|
||||||
"files": ["src/preload/**"]
|
"files": ["src/preload/**"]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"files": ["packages/ai-sdk-provider/**"],
|
||||||
|
"globals": {
|
||||||
|
"fetch": "readonly"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
// We don't use the React plugin here because its behavior differs slightly from that of ESLint's React plugin.
|
|
||||||
"plugins": ["unicorn", "typescript", "oxc", "import"],
|
"plugins": ["unicorn", "typescript", "oxc", "import"],
|
||||||
"rules": {
|
"rules": {
|
||||||
"constructor-super": "error",
|
|
||||||
"for-direction": "error",
|
|
||||||
"getter-return": "error",
|
|
||||||
"no-array-constructor": "off",
|
"no-array-constructor": "off",
|
||||||
// "import/no-cycle": "error", // tons of error, bro
|
|
||||||
"no-async-promise-executor": "error",
|
|
||||||
"no-caller": "warn",
|
"no-caller": "warn",
|
||||||
"no-case-declarations": "error",
|
|
||||||
"no-class-assign": "error",
|
|
||||||
"no-compare-neg-zero": "error",
|
|
||||||
"no-cond-assign": "error",
|
|
||||||
"no-const-assign": "error",
|
|
||||||
"no-constant-binary-expression": "error",
|
|
||||||
"no-constant-condition": "error",
|
|
||||||
"no-control-regex": "error",
|
|
||||||
"no-debugger": "error",
|
|
||||||
"no-delete-var": "error",
|
|
||||||
"no-dupe-args": "error",
|
|
||||||
"no-dupe-class-members": "error",
|
|
||||||
"no-dupe-else-if": "error",
|
|
||||||
"no-dupe-keys": "error",
|
|
||||||
"no-duplicate-case": "error",
|
|
||||||
"no-empty": "error",
|
|
||||||
"no-empty-character-class": "error",
|
|
||||||
"no-empty-pattern": "error",
|
|
||||||
"no-empty-static-block": "error",
|
|
||||||
"no-eval": "warn",
|
"no-eval": "warn",
|
||||||
"no-ex-assign": "error",
|
|
||||||
"no-extra-boolean-cast": "error",
|
|
||||||
"no-fallthrough": "warn",
|
"no-fallthrough": "warn",
|
||||||
"no-func-assign": "error",
|
|
||||||
"no-global-assign": "error",
|
|
||||||
"no-import-assign": "error",
|
|
||||||
"no-invalid-regexp": "error",
|
|
||||||
"no-irregular-whitespace": "error",
|
|
||||||
"no-loss-of-precision": "error",
|
|
||||||
"no-misleading-character-class": "error",
|
|
||||||
"no-new-native-nonconstructor": "error",
|
|
||||||
"no-nonoctal-decimal-escape": "error",
|
|
||||||
"no-obj-calls": "error",
|
|
||||||
"no-octal": "error",
|
|
||||||
"no-prototype-builtins": "error",
|
|
||||||
"no-redeclare": "error",
|
|
||||||
"no-regex-spaces": "error",
|
|
||||||
"no-self-assign": "error",
|
|
||||||
"no-setter-return": "error",
|
|
||||||
"no-shadow-restricted-names": "error",
|
|
||||||
"no-sparse-arrays": "error",
|
|
||||||
"no-this-before-super": "error",
|
|
||||||
"no-unassigned-vars": "warn",
|
"no-unassigned-vars": "warn",
|
||||||
"no-undef": "error",
|
"no-unused-expressions": "off",
|
||||||
"no-unexpected-multiline": "error",
|
|
||||||
"no-unreachable": "error",
|
|
||||||
"no-unsafe-finally": "error",
|
|
||||||
"no-unsafe-negation": "error",
|
|
||||||
"no-unsafe-optional-chaining": "error",
|
|
||||||
"no-unused-expressions": "off", // this rule disallow us to use expression to call function, like `condition && fn()`
|
|
||||||
"no-unused-labels": "error",
|
|
||||||
"no-unused-private-class-members": "error",
|
|
||||||
"no-unused-vars": ["warn", { "caughtErrors": "none" }],
|
"no-unused-vars": ["warn", { "caughtErrors": "none" }],
|
||||||
"no-useless-backreference": "error",
|
|
||||||
"no-useless-catch": "error",
|
|
||||||
"no-useless-escape": "error",
|
|
||||||
"no-useless-rename": "warn",
|
"no-useless-rename": "warn",
|
||||||
"no-with": "error",
|
|
||||||
"oxc/bad-array-method-on-arguments": "warn",
|
"oxc/bad-array-method-on-arguments": "warn",
|
||||||
"oxc/bad-char-at-comparison": "warn",
|
"oxc/bad-char-at-comparison": "warn",
|
||||||
"oxc/bad-comparison-sequence": "warn",
|
"oxc/bad-comparison-sequence": "warn",
|
||||||
@@ -134,19 +80,17 @@
|
|||||||
"oxc/erasing-op": "warn",
|
"oxc/erasing-op": "warn",
|
||||||
"oxc/missing-throw": "warn",
|
"oxc/missing-throw": "warn",
|
||||||
"oxc/number-arg-out-of-range": "warn",
|
"oxc/number-arg-out-of-range": "warn",
|
||||||
"oxc/only-used-in-recursion": "off", // manually off bacause of existing warning. may turn it on in the future
|
"oxc/only-used-in-recursion": "off",
|
||||||
"oxc/uninvoked-array-callback": "warn",
|
"oxc/uninvoked-array-callback": "warn",
|
||||||
"require-yield": "error",
|
|
||||||
"typescript/await-thenable": "warn",
|
"typescript/await-thenable": "warn",
|
||||||
// "typescript/ban-ts-comment": "error",
|
"typescript/consistent-type-imports": "error",
|
||||||
"typescript/no-array-constructor": "error",
|
"typescript/no-array-constructor": "error",
|
||||||
// "typescript/consistent-type-imports": "error",
|
|
||||||
"typescript/no-array-delete": "warn",
|
"typescript/no-array-delete": "warn",
|
||||||
"typescript/no-base-to-string": "warn",
|
"typescript/no-base-to-string": "warn",
|
||||||
"typescript/no-duplicate-enum-values": "error",
|
"typescript/no-duplicate-enum-values": "error",
|
||||||
"typescript/no-duplicate-type-constituents": "warn",
|
"typescript/no-duplicate-type-constituents": "warn",
|
||||||
"typescript/no-empty-object-type": "off",
|
"typescript/no-empty-object-type": "off",
|
||||||
"typescript/no-explicit-any": "off", // not safe but too many errors
|
"typescript/no-explicit-any": "off",
|
||||||
"typescript/no-extra-non-null-assertion": "error",
|
"typescript/no-extra-non-null-assertion": "error",
|
||||||
"typescript/no-floating-promises": "warn",
|
"typescript/no-floating-promises": "warn",
|
||||||
"typescript/no-for-in-array": "warn",
|
"typescript/no-for-in-array": "warn",
|
||||||
@@ -155,7 +99,7 @@
|
|||||||
"typescript/no-misused-new": "error",
|
"typescript/no-misused-new": "error",
|
||||||
"typescript/no-misused-spread": "warn",
|
"typescript/no-misused-spread": "warn",
|
||||||
"typescript/no-namespace": "error",
|
"typescript/no-namespace": "error",
|
||||||
"typescript/no-non-null-asserted-optional-chain": "off", // it's off now. but may turn it on.
|
"typescript/no-non-null-asserted-optional-chain": "off",
|
||||||
"typescript/no-redundant-type-constituents": "warn",
|
"typescript/no-redundant-type-constituents": "warn",
|
||||||
"typescript/no-require-imports": "off",
|
"typescript/no-require-imports": "off",
|
||||||
"typescript/no-this-alias": "error",
|
"typescript/no-this-alias": "error",
|
||||||
@@ -173,20 +117,18 @@
|
|||||||
"typescript/triple-slash-reference": "error",
|
"typescript/triple-slash-reference": "error",
|
||||||
"typescript/unbound-method": "warn",
|
"typescript/unbound-method": "warn",
|
||||||
"unicorn/no-await-in-promise-methods": "warn",
|
"unicorn/no-await-in-promise-methods": "warn",
|
||||||
"unicorn/no-empty-file": "off", // manually off bacause of existing warning. may turn it on in the future
|
"unicorn/no-empty-file": "off",
|
||||||
"unicorn/no-invalid-fetch-options": "warn",
|
"unicorn/no-invalid-fetch-options": "warn",
|
||||||
"unicorn/no-invalid-remove-event-listener": "warn",
|
"unicorn/no-invalid-remove-event-listener": "warn",
|
||||||
"unicorn/no-new-array": "off", // manually off bacause of existing warning. may turn it on in the future
|
"unicorn/no-new-array": "off",
|
||||||
"unicorn/no-single-promise-in-promise-methods": "warn",
|
"unicorn/no-single-promise-in-promise-methods": "warn",
|
||||||
"unicorn/no-thenable": "off", // manually off bacause of existing warning. may turn it on in the future
|
"unicorn/no-thenable": "off",
|
||||||
"unicorn/no-unnecessary-await": "warn",
|
"unicorn/no-unnecessary-await": "warn",
|
||||||
"unicorn/no-useless-fallback-in-spread": "warn",
|
"unicorn/no-useless-fallback-in-spread": "warn",
|
||||||
"unicorn/no-useless-length-check": "warn",
|
"unicorn/no-useless-length-check": "warn",
|
||||||
"unicorn/no-useless-spread": "off", // manually off bacause of existing warning. may turn it on in the future
|
"unicorn/no-useless-spread": "off",
|
||||||
"unicorn/prefer-set-size": "warn",
|
"unicorn/prefer-set-size": "warn",
|
||||||
"unicorn/prefer-string-starts-ends-with": "warn",
|
"unicorn/prefer-string-starts-ends-with": "warn"
|
||||||
"use-isnan": "error",
|
|
||||||
"valid-typeof": "error"
|
|
||||||
},
|
},
|
||||||
"settings": {
|
"settings": {
|
||||||
"jsdoc": {
|
"jsdoc": {
|
||||||
|
|||||||
@@ -1,13 +0,0 @@
|
|||||||
diff --git a/dist/index.mjs b/dist/index.mjs
|
|
||||||
index 69ab1599c76801dc1167551b6fa283dded123466..f0af43bba7ad1196fe05338817e65b4ebda40955 100644
|
|
||||||
--- a/dist/index.mjs
|
|
||||||
+++ b/dist/index.mjs
|
|
||||||
@@ -477,7 +477,7 @@ function convertToGoogleGenerativeAIMessages(prompt, options) {
|
|
||||||
|
|
||||||
// src/get-model-path.ts
|
|
||||||
function getModelPath(modelId) {
|
|
||||||
- return modelId.includes("/") ? modelId : `models/${modelId}`;
|
|
||||||
+ return modelId?.includes("models/") ? modelId : `models/${modelId}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
// src/google-generative-ai-options.ts
|
|
||||||
26
.yarn/patches/@ai-sdk-google-npm-2.0.43-689ed559b3.patch
vendored
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
diff --git a/dist/index.js b/dist/index.js
|
||||||
|
index 51ce7e423934fb717cb90245cdfcdb3dae6780e6..0f7f7009e2f41a79a8669d38c8a44867bbff5e1f 100644
|
||||||
|
--- a/dist/index.js
|
||||||
|
+++ b/dist/index.js
|
||||||
|
@@ -474,7 +474,7 @@ function convertToGoogleGenerativeAIMessages(prompt, options) {
|
||||||
|
|
||||||
|
// src/get-model-path.ts
|
||||||
|
function getModelPath(modelId) {
|
||||||
|
- return modelId.includes("/") ? modelId : `models/${modelId}`;
|
||||||
|
+ return modelId.includes("models/") ? modelId : `models/${modelId}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
// src/google-generative-ai-options.ts
|
||||||
|
diff --git a/dist/index.mjs b/dist/index.mjs
|
||||||
|
index f4b77e35c0cbfece85a3ef0d4f4e67aa6dde6271..8d2fecf8155a226006a0bde72b00b6036d4014b6 100644
|
||||||
|
--- a/dist/index.mjs
|
||||||
|
+++ b/dist/index.mjs
|
||||||
|
@@ -480,7 +480,7 @@ function convertToGoogleGenerativeAIMessages(prompt, options) {
|
||||||
|
|
||||||
|
// src/get-model-path.ts
|
||||||
|
function getModelPath(modelId) {
|
||||||
|
- return modelId.includes("/") ? modelId : `models/${modelId}`;
|
||||||
|
+ return modelId.includes("models/") ? modelId : `models/${modelId}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
// src/google-generative-ai-options.ts
|
||||||
140
.yarn/patches/@ai-sdk-openai-compatible-npm-1.0.27-06f74278cf.patch
vendored
Normal file
@@ -0,0 +1,140 @@
|
|||||||
|
diff --git a/dist/index.js b/dist/index.js
|
||||||
|
index 73045a7d38faafdc7f7d2cd79d7ff0e2b031056b..8d948c9ac4ea4b474db9ef3c5491961e7fcf9a07 100644
|
||||||
|
--- a/dist/index.js
|
||||||
|
+++ b/dist/index.js
|
||||||
|
@@ -421,6 +421,17 @@ var OpenAICompatibleChatLanguageModel = class {
|
||||||
|
text: reasoning
|
||||||
|
});
|
||||||
|
}
|
||||||
|
+ if (choice.message.images) {
|
||||||
|
+ for (const image of choice.message.images) {
|
||||||
|
+ const match1 = image.image_url.url.match(/^data:([^;]+)/)
|
||||||
|
+ const match2 = image.image_url.url.match(/^data:[^;]*;base64,(.+)$/);
|
||||||
|
+ content.push({
|
||||||
|
+ type: 'file',
|
||||||
|
+ mediaType: match1 ? (match1[1] ?? 'image/jpeg') : 'image/jpeg',
|
||||||
|
+ data: match2 ? match2[1] : image.image_url.url,
|
||||||
|
+ });
|
||||||
|
+ }
|
||||||
|
+ }
|
||||||
|
if (choice.message.tool_calls != null) {
|
||||||
|
for (const toolCall of choice.message.tool_calls) {
|
||||||
|
content.push({
|
||||||
|
@@ -598,6 +609,17 @@ var OpenAICompatibleChatLanguageModel = class {
|
||||||
|
delta: delta.content
|
||||||
|
});
|
||||||
|
}
|
||||||
|
+ if (delta.images) {
|
||||||
|
+ for (const image of delta.images) {
|
||||||
|
+ const match1 = image.image_url.url.match(/^data:([^;]+)/)
|
||||||
|
+ const match2 = image.image_url.url.match(/^data:[^;]*;base64,(.+)$/);
|
||||||
|
+ controller.enqueue({
|
||||||
|
+ type: 'file',
|
||||||
|
+ mediaType: match1 ? (match1[1] ?? 'image/jpeg') : 'image/jpeg',
|
||||||
|
+ data: match2 ? match2[1] : image.image_url.url,
|
||||||
|
+ });
|
||||||
|
+ }
|
||||||
|
+ }
|
||||||
|
if (delta.tool_calls != null) {
|
||||||
|
for (const toolCallDelta of delta.tool_calls) {
|
||||||
|
const index = toolCallDelta.index;
|
||||||
|
@@ -765,6 +787,14 @@ var OpenAICompatibleChatResponseSchema = import_v43.z.object({
|
||||||
|
arguments: import_v43.z.string()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
+ ).nullish(),
|
||||||
|
+ images: import_v43.z.array(
|
||||||
|
+ import_v43.z.object({
|
||||||
|
+ type: import_v43.z.literal('image_url'),
|
||||||
|
+ image_url: import_v43.z.object({
|
||||||
|
+ url: import_v43.z.string(),
|
||||||
|
+ })
|
||||||
|
+ })
|
||||||
|
).nullish()
|
||||||
|
}),
|
||||||
|
finish_reason: import_v43.z.string().nullish()
|
||||||
|
@@ -795,6 +825,14 @@ var createOpenAICompatibleChatChunkSchema = (errorSchema) => import_v43.z.union(
|
||||||
|
arguments: import_v43.z.string().nullish()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
+ ).nullish(),
|
||||||
|
+ images: import_v43.z.array(
|
||||||
|
+ import_v43.z.object({
|
||||||
|
+ type: import_v43.z.literal('image_url'),
|
||||||
|
+ image_url: import_v43.z.object({
|
||||||
|
+ url: import_v43.z.string(),
|
||||||
|
+ })
|
||||||
|
+ })
|
||||||
|
).nullish()
|
||||||
|
}).nullish(),
|
||||||
|
finish_reason: import_v43.z.string().nullish()
|
||||||
|
diff --git a/dist/index.mjs b/dist/index.mjs
|
||||||
|
index 1c2b9560bbfbfe10cb01af080aeeed4ff59db29c..2c8ddc4fc9bfc5e7e06cfca105d197a08864c427 100644
|
||||||
|
--- a/dist/index.mjs
|
||||||
|
+++ b/dist/index.mjs
|
||||||
|
@@ -405,6 +405,17 @@ var OpenAICompatibleChatLanguageModel = class {
|
||||||
|
text: reasoning
|
||||||
|
});
|
||||||
|
}
|
||||||
|
+ if (choice.message.images) {
|
||||||
|
+ for (const image of choice.message.images) {
|
||||||
|
+ const match1 = image.image_url.url.match(/^data:([^;]+)/)
|
||||||
|
+ const match2 = image.image_url.url.match(/^data:[^;]*;base64,(.+)$/);
|
||||||
|
+ content.push({
|
||||||
|
+ type: 'file',
|
||||||
|
+ mediaType: match1 ? (match1[1] ?? 'image/jpeg') : 'image/jpeg',
|
||||||
|
+ data: match2 ? match2[1] : image.image_url.url,
|
||||||
|
+ });
|
||||||
|
+ }
|
||||||
|
+ }
|
||||||
|
if (choice.message.tool_calls != null) {
|
||||||
|
for (const toolCall of choice.message.tool_calls) {
|
||||||
|
content.push({
|
||||||
|
@@ -582,6 +593,17 @@ var OpenAICompatibleChatLanguageModel = class {
|
||||||
|
delta: delta.content
|
||||||
|
});
|
||||||
|
}
|
||||||
|
+ if (delta.images) {
|
||||||
|
+ for (const image of delta.images) {
|
||||||
|
+ const match1 = image.image_url.url.match(/^data:([^;]+)/)
|
||||||
|
+ const match2 = image.image_url.url.match(/^data:[^;]*;base64,(.+)$/);
|
||||||
|
+ controller.enqueue({
|
||||||
|
+ type: 'file',
|
||||||
|
+ mediaType: match1 ? (match1[1] ?? 'image/jpeg') : 'image/jpeg',
|
||||||
|
+ data: match2 ? match2[1] : image.image_url.url,
|
||||||
|
+ });
|
||||||
|
+ }
|
||||||
|
+ }
|
||||||
|
if (delta.tool_calls != null) {
|
||||||
|
for (const toolCallDelta of delta.tool_calls) {
|
||||||
|
const index = toolCallDelta.index;
|
||||||
|
@@ -749,6 +771,14 @@ var OpenAICompatibleChatResponseSchema = z3.object({
|
||||||
|
arguments: z3.string()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
+ ).nullish(),
|
||||||
|
+ images: z3.array(
|
||||||
|
+ z3.object({
|
||||||
|
+ type: z3.literal('image_url'),
|
||||||
|
+ image_url: z3.object({
|
||||||
|
+ url: z3.string(),
|
||||||
|
+ })
|
||||||
|
+ })
|
||||||
|
).nullish()
|
||||||
|
}),
|
||||||
|
finish_reason: z3.string().nullish()
|
||||||
|
@@ -779,6 +809,14 @@ var createOpenAICompatibleChatChunkSchema = (errorSchema) => z3.union([
|
||||||
|
arguments: z3.string().nullish()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
+ ).nullish(),
|
||||||
|
+ images: z3.array(
|
||||||
|
+ z3.object({
|
||||||
|
+ type: z3.literal('image_url'),
|
||||||
|
+ image_url: z3.object({
|
||||||
|
+ url: z3.string(),
|
||||||
|
+ })
|
||||||
|
+ })
|
||||||
|
).nullish()
|
||||||
|
}).nullish(),
|
||||||
|
finish_reason: z3.string().nullish()
|
||||||
74
.yarn/patches/@ai-sdk-openai-npm-2.0.72-234e68da87.patch
vendored
Normal file
@@ -0,0 +1,74 @@
|
|||||||
|
diff --git a/dist/index.js b/dist/index.js
|
||||||
|
index bf900591bf2847a3253fe441aad24c06da19c6c1..c1d9bb6fefa2df1383339324073db0a70ea2b5a2 100644
|
||||||
|
--- a/dist/index.js
|
||||||
|
+++ b/dist/index.js
|
||||||
|
@@ -274,6 +274,7 @@ var openaiChatResponseSchema = (0, import_provider_utils3.lazyValidator)(
|
||||||
|
message: import_v42.z.object({
|
||||||
|
role: import_v42.z.literal("assistant").nullish(),
|
||||||
|
content: import_v42.z.string().nullish(),
|
||||||
|
+ reasoning_content: import_v42.z.string().nullish(),
|
||||||
|
tool_calls: import_v42.z.array(
|
||||||
|
import_v42.z.object({
|
||||||
|
id: import_v42.z.string().nullish(),
|
||||||
|
@@ -340,6 +341,7 @@ var openaiChatChunkSchema = (0, import_provider_utils3.lazyValidator)(
|
||||||
|
delta: import_v42.z.object({
|
||||||
|
role: import_v42.z.enum(["assistant"]).nullish(),
|
||||||
|
content: import_v42.z.string().nullish(),
|
||||||
|
+ reasoning_content: import_v42.z.string().nullish(),
|
||||||
|
tool_calls: import_v42.z.array(
|
||||||
|
import_v42.z.object({
|
||||||
|
index: import_v42.z.number(),
|
||||||
|
@@ -795,6 +797,13 @@ var OpenAIChatLanguageModel = class {
|
||||||
|
if (text != null && text.length > 0) {
|
||||||
|
content.push({ type: "text", text });
|
||||||
|
}
|
||||||
|
+ const reasoning = choice.message.reasoning_content;
|
||||||
|
+ if (reasoning != null && reasoning.length > 0) {
|
||||||
|
+ content.push({
|
||||||
|
+ type: 'reasoning',
|
||||||
|
+ text: reasoning
|
||||||
|
+ });
|
||||||
|
+ }
|
||||||
|
for (const toolCall of (_a = choice.message.tool_calls) != null ? _a : []) {
|
||||||
|
content.push({
|
||||||
|
type: "tool-call",
|
||||||
|
@@ -876,6 +885,7 @@ var OpenAIChatLanguageModel = class {
|
||||||
|
};
|
||||||
|
let metadataExtracted = false;
|
||||||
|
let isActiveText = false;
|
||||||
|
+ let isActiveReasoning = false;
|
||||||
|
const providerMetadata = { openai: {} };
|
||||||
|
return {
|
||||||
|
stream: response.pipeThrough(
|
||||||
|
@@ -933,6 +943,21 @@ var OpenAIChatLanguageModel = class {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const delta = choice.delta;
|
||||||
|
+ const reasoningContent = delta.reasoning_content;
|
||||||
|
+ if (reasoningContent) {
|
||||||
|
+ if (!isActiveReasoning) {
|
||||||
|
+ controller.enqueue({
|
||||||
|
+ type: 'reasoning-start',
|
||||||
|
+ id: 'reasoning-0',
|
||||||
|
+ });
|
||||||
|
+ isActiveReasoning = true;
|
||||||
|
+ }
|
||||||
|
+ controller.enqueue({
|
||||||
|
+ type: 'reasoning-delta',
|
||||||
|
+ id: 'reasoning-0',
|
||||||
|
+ delta: reasoningContent,
|
||||||
|
+ });
|
||||||
|
+ }
|
||||||
|
if (delta.content != null) {
|
||||||
|
if (!isActiveText) {
|
||||||
|
controller.enqueue({ type: "text-start", id: "0" });
|
||||||
|
@@ -1045,6 +1070,9 @@ var OpenAIChatLanguageModel = class {
|
||||||
|
}
|
||||||
|
},
|
||||||
|
flush(controller) {
|
||||||
|
+ if (isActiveReasoning) {
|
||||||
|
+ controller.enqueue({ type: 'reasoning-end', id: 'reasoning-0' });
|
||||||
|
+ }
|
||||||
|
if (isActiveText) {
|
||||||
|
controller.enqueue({ type: "text-end", id: "0" });
|
||||||
|
}
|
||||||
@@ -1,26 +1,30 @@
|
|||||||
diff --git a/sdk.mjs b/sdk.mjs
|
diff --git a/sdk.mjs b/sdk.mjs
|
||||||
index 461e9a2ba246778261108a682762ffcf26f7224e..44bd667d9f591969d36a105ba5eb8b478c738dd8 100644
|
index bf429a344b7d59f70aead16b639f949b07688a81..f77d50cc5d3fb04292cb3ac7fa7085d02dcc628f 100755
|
||||||
--- a/sdk.mjs
|
--- a/sdk.mjs
|
||||||
+++ b/sdk.mjs
|
+++ b/sdk.mjs
|
||||||
@@ -6215,7 +6215,7 @@ function createAbortController(maxListeners = DEFAULT_MAX_LISTENERS) {
|
@@ -6250,7 +6250,7 @@ function createAbortController(maxListeners = DEFAULT_MAX_LISTENERS) {
|
||||||
}
|
}
|
||||||
|
|
||||||
// ../src/transport/ProcessTransport.ts
|
// ../src/transport/ProcessTransport.ts
|
||||||
-import { spawn } from "child_process";
|
-import { spawn } from "child_process";
|
||||||
+import { fork } from "child_process";
|
+import { fork } from "child_process";
|
||||||
import { createInterface } from "readline";
|
import { createInterface } from "readline";
|
||||||
|
|
||||||
// ../src/utils/fsOperations.ts
|
// ../src/utils/fsOperations.ts
|
||||||
@@ -6473,14 +6473,11 @@ class ProcessTransport {
|
@@ -6619,18 +6619,11 @@ class ProcessTransport {
|
||||||
const errorMessage = isNativeBinary(pathToClaudeCodeExecutable) ? `Claude Code native binary not found at ${pathToClaudeCodeExecutable}. Please ensure Claude Code is installed via native installer or specify a valid path with options.pathToClaudeCodeExecutable.` : `Claude Code executable not found at ${pathToClaudeCodeExecutable}. Is options.pathToClaudeCodeExecutable set?`;
|
const errorMessage = isNativeBinary(pathToClaudeCodeExecutable) ? `Claude Code native binary not found at ${pathToClaudeCodeExecutable}. Please ensure Claude Code is installed via native installer or specify a valid path with options.pathToClaudeCodeExecutable.` : `Claude Code executable not found at ${pathToClaudeCodeExecutable}. Is options.pathToClaudeCodeExecutable set?`;
|
||||||
throw new ReferenceError(errorMessage);
|
throw new ReferenceError(errorMessage);
|
||||||
}
|
}
|
||||||
- const isNative = isNativeBinary(pathToClaudeCodeExecutable);
|
- const isNative = isNativeBinary(pathToClaudeCodeExecutable);
|
||||||
- const spawnCommand = isNative ? pathToClaudeCodeExecutable : executable;
|
- const spawnCommand = isNative ? pathToClaudeCodeExecutable : executable;
|
||||||
- const spawnArgs = isNative ? args : [...executableArgs, pathToClaudeCodeExecutable, ...args];
|
- const spawnArgs = isNative ? [...executableArgs, ...args] : [...executableArgs, pathToClaudeCodeExecutable, ...args];
|
||||||
- this.logForDebugging(isNative ? `Spawning Claude Code native binary: ${pathToClaudeCodeExecutable} ${args.join(" ")}` : `Spawning Claude Code process: ${executable} ${[...executableArgs, pathToClaudeCodeExecutable, ...args].join(" ")}`);
|
- const spawnMessage = isNative ? `Spawning Claude Code native binary: ${spawnCommand} ${spawnArgs.join(" ")}` : `Spawning Claude Code process: ${spawnCommand} ${spawnArgs.join(" ")}`;
|
||||||
+ this.logForDebugging(`Forking Claude Code Node.js process: ${pathToClaudeCodeExecutable} ${args.join(" ")}`);
|
- logForSdkDebugging(spawnMessage);
|
||||||
const stderrMode = env.DEBUG || stderr ? "pipe" : "ignore";
|
- if (stderr) {
|
||||||
|
- stderr(spawnMessage);
|
||||||
|
- }
|
||||||
|
+ logForSdkDebugging(`Forking Claude Code Node.js process: ${pathToClaudeCodeExecutable} ${args.join(" ")}`);
|
||||||
|
const stderrMode = env.DEBUG_CLAUDE_AGENT_SDK || stderr ? "pipe" : "ignore";
|
||||||
- this.child = spawn(spawnCommand, spawnArgs, {
|
- this.child = spawn(spawnCommand, spawnArgs, {
|
||||||
+ this.child = fork(pathToClaudeCodeExecutable, args, {
|
+ this.child = fork(pathToClaudeCodeExecutable, args, {
|
||||||
cwd,
|
cwd,
|
||||||
@@ -1,71 +0,0 @@
|
|||||||
diff --git a/dist/utils/tiktoken.cjs b/dist/utils/tiktoken.cjs
|
|
||||||
index 973b0d0e75aeaf8de579419af31b879b32975413..f23c7caa8b9dc8bd404132725346a4786f6b278b 100644
|
|
||||||
--- a/dist/utils/tiktoken.cjs
|
|
||||||
+++ b/dist/utils/tiktoken.cjs
|
|
||||||
@@ -1,25 +1,14 @@
|
|
||||||
"use strict";
|
|
||||||
Object.defineProperty(exports, "__esModule", { value: true });
|
|
||||||
exports.encodingForModel = exports.getEncoding = void 0;
|
|
||||||
-const lite_1 = require("js-tiktoken/lite");
|
|
||||||
const async_caller_js_1 = require("./async_caller.cjs");
|
|
||||||
const cache = {};
|
|
||||||
const caller = /* #__PURE__ */ new async_caller_js_1.AsyncCaller({});
|
|
||||||
async function getEncoding(encoding) {
|
|
||||||
- if (!(encoding in cache)) {
|
|
||||||
- cache[encoding] = caller
|
|
||||||
- .fetch(`https://tiktoken.pages.dev/js/${encoding}.json`)
|
|
||||||
- .then((res) => res.json())
|
|
||||||
- .then((data) => new lite_1.Tiktoken(data))
|
|
||||||
- .catch((e) => {
|
|
||||||
- delete cache[encoding];
|
|
||||||
- throw e;
|
|
||||||
- });
|
|
||||||
- }
|
|
||||||
- return await cache[encoding];
|
|
||||||
+ throw new Error("TikToken Not implemented");
|
|
||||||
}
|
|
||||||
exports.getEncoding = getEncoding;
|
|
||||||
async function encodingForModel(model) {
|
|
||||||
- return getEncoding((0, lite_1.getEncodingNameForModel)(model));
|
|
||||||
+ throw new Error("TikToken Not implemented");
|
|
||||||
}
|
|
||||||
exports.encodingForModel = encodingForModel;
|
|
||||||
diff --git a/dist/utils/tiktoken.js b/dist/utils/tiktoken.js
|
|
||||||
index 8e41ee6f00f2f9c7fa2c59fa2b2f4297634b97aa..aa5f314a6349ad0d1c5aea8631a56aad099176e0 100644
|
|
||||||
--- a/dist/utils/tiktoken.js
|
|
||||||
+++ b/dist/utils/tiktoken.js
|
|
||||||
@@ -1,20 +1,9 @@
|
|
||||||
-import { Tiktoken, getEncodingNameForModel, } from "js-tiktoken/lite";
|
|
||||||
import { AsyncCaller } from "./async_caller.js";
|
|
||||||
const cache = {};
|
|
||||||
const caller = /* #__PURE__ */ new AsyncCaller({});
|
|
||||||
export async function getEncoding(encoding) {
|
|
||||||
- if (!(encoding in cache)) {
|
|
||||||
- cache[encoding] = caller
|
|
||||||
- .fetch(`https://tiktoken.pages.dev/js/${encoding}.json`)
|
|
||||||
- .then((res) => res.json())
|
|
||||||
- .then((data) => new Tiktoken(data))
|
|
||||||
- .catch((e) => {
|
|
||||||
- delete cache[encoding];
|
|
||||||
- throw e;
|
|
||||||
- });
|
|
||||||
- }
|
|
||||||
- return await cache[encoding];
|
|
||||||
+ throw new Error("TikToken Not implemented");
|
|
||||||
}
|
|
||||||
export async function encodingForModel(model) {
|
|
||||||
- return getEncoding(getEncodingNameForModel(model));
|
|
||||||
+ throw new Error("TikToken Not implemented");
|
|
||||||
}
|
|
||||||
diff --git a/package.json b/package.json
|
|
||||||
index 36072aecf700fca1bc49832a19be832eca726103..90b8922fba1c3d1b26f78477c891b07816d6238a 100644
|
|
||||||
--- a/package.json
|
|
||||||
+++ b/package.json
|
|
||||||
@@ -37,7 +37,6 @@
|
|
||||||
"ansi-styles": "^5.0.0",
|
|
||||||
"camelcase": "6",
|
|
||||||
"decamelize": "1.2.0",
|
|
||||||
- "js-tiktoken": "^1.0.12",
|
|
||||||
"langsmith": ">=0.2.8 <0.4.0",
|
|
||||||
"mustache": "^4.2.0",
|
|
||||||
"p-queue": "^6.6.2",
|
|
||||||
68
.yarn/patches/@langchain-core-npm-1.0.2-183ef83fe4.patch
vendored
Normal file
@@ -0,0 +1,68 @@
|
|||||||
|
diff --git a/dist/utils/tiktoken.cjs b/dist/utils/tiktoken.cjs
|
||||||
|
index c5b41f121d2e3d24c3a4969e31fa1acffdcad3b9..ec724489dcae79ee6c61acf2d4d84bd19daef036 100644
|
||||||
|
--- a/dist/utils/tiktoken.cjs
|
||||||
|
+++ b/dist/utils/tiktoken.cjs
|
||||||
|
@@ -1,6 +1,5 @@
|
||||||
|
const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
|
||||||
|
const require_utils_async_caller = require('./async_caller.cjs');
|
||||||
|
-const js_tiktoken_lite = require_rolldown_runtime.__toESM(require("js-tiktoken/lite"));
|
||||||
|
|
||||||
|
//#region src/utils/tiktoken.ts
|
||||||
|
var tiktoken_exports = {};
|
||||||
|
@@ -11,14 +10,10 @@ require_rolldown_runtime.__export(tiktoken_exports, {
|
||||||
|
const cache = {};
|
||||||
|
const caller = /* @__PURE__ */ new require_utils_async_caller.AsyncCaller({});
|
||||||
|
async function getEncoding(encoding) {
|
||||||
|
- if (!(encoding in cache)) cache[encoding] = caller.fetch(`https://tiktoken.pages.dev/js/${encoding}.json`).then((res) => res.json()).then((data) => new js_tiktoken_lite.Tiktoken(data)).catch((e) => {
|
||||||
|
- delete cache[encoding];
|
||||||
|
- throw e;
|
||||||
|
- });
|
||||||
|
- return await cache[encoding];
|
||||||
|
+ throw new Error("TikToken Not implemented");
|
||||||
|
}
|
||||||
|
async function encodingForModel(model) {
|
||||||
|
- return getEncoding((0, js_tiktoken_lite.getEncodingNameForModel)(model));
|
||||||
|
+ throw new Error("TikToken Not implemented");
|
||||||
|
}
|
||||||
|
|
||||||
|
//#endregion
|
||||||
|
diff --git a/dist/utils/tiktoken.js b/dist/utils/tiktoken.js
|
||||||
|
index 641acca03cb92f04a6fa5c9c31f1880ce635572e..707389970ad957aa0ff20ef37fa8dd2875be737c 100644
|
||||||
|
--- a/dist/utils/tiktoken.js
|
||||||
|
+++ b/dist/utils/tiktoken.js
|
||||||
|
@@ -1,6 +1,5 @@
|
||||||
|
import { __export } from "../_virtual/rolldown_runtime.js";
|
||||||
|
import { AsyncCaller } from "./async_caller.js";
|
||||||
|
-import { Tiktoken, getEncodingNameForModel } from "js-tiktoken/lite";
|
||||||
|
|
||||||
|
//#region src/utils/tiktoken.ts
|
||||||
|
var tiktoken_exports = {};
|
||||||
|
@@ -11,14 +10,10 @@ __export(tiktoken_exports, {
|
||||||
|
const cache = {};
|
||||||
|
const caller = /* @__PURE__ */ new AsyncCaller({});
|
||||||
|
async function getEncoding(encoding) {
|
||||||
|
- if (!(encoding in cache)) cache[encoding] = caller.fetch(`https://tiktoken.pages.dev/js/${encoding}.json`).then((res) => res.json()).then((data) => new Tiktoken(data)).catch((e) => {
|
||||||
|
- delete cache[encoding];
|
||||||
|
- throw e;
|
||||||
|
- });
|
||||||
|
- return await cache[encoding];
|
||||||
|
+ throw new Error("TikToken Not implemented");
|
||||||
|
}
|
||||||
|
async function encodingForModel(model) {
|
||||||
|
- return getEncoding(getEncodingNameForModel(model));
|
||||||
|
+ throw new Error("TikToken Not implemented");
|
||||||
|
}
|
||||||
|
|
||||||
|
//#endregion
|
||||||
|
diff --git a/package.json b/package.json
|
||||||
|
index a24f8fc61de58526051999260f2ebee5f136354b..e885359e8966e7730c51772533ce37e01edb3046 100644
|
||||||
|
--- a/package.json
|
||||||
|
+++ b/package.json
|
||||||
|
@@ -20,7 +20,6 @@
|
||||||
|
"ansi-styles": "^5.0.0",
|
||||||
|
"camelcase": "6",
|
||||||
|
"decamelize": "1.2.0",
|
||||||
|
- "js-tiktoken": "^1.0.12",
|
||||||
|
"langsmith": "^0.3.64",
|
||||||
|
"mustache": "^4.2.0",
|
||||||
|
"p-queue": "^6.6.2",
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
diff --git a/dist/embeddings.js b/dist/embeddings.js
|
|
||||||
index 1f8154be3e9c22442a915eb4b85fa6d2a21b0d0c..dc13ef4a30e6c282824a5357bcee9bd0ae222aab 100644
|
|
||||||
--- a/dist/embeddings.js
|
|
||||||
+++ b/dist/embeddings.js
|
|
||||||
@@ -214,10 +214,12 @@ export class OpenAIEmbeddings extends Embeddings {
|
|
||||||
* @returns Promise that resolves to an embedding for the document.
|
|
||||||
*/
|
|
||||||
async embedQuery(text) {
|
|
||||||
+ const isBaiduCloud = this.clientConfig.baseURL.includes('baidubce.com')
|
|
||||||
+ const input = this.stripNewLines ? text.replace(/\n/g, ' ') : text
|
|
||||||
const params = {
|
|
||||||
model: this.model,
|
|
||||||
- input: this.stripNewLines ? text.replace(/\n/g, " ") : text,
|
|
||||||
- };
|
|
||||||
+ input: isBaiduCloud ? [input] : input
|
|
||||||
+ }
|
|
||||||
if (this.dimensions) {
|
|
||||||
params.dimensions = this.dimensions;
|
|
||||||
}
|
|
||||||
17
.yarn/patches/@langchain-openai-npm-1.0.0-474d0ad9d4.patch
vendored
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
diff --git a/dist/embeddings.js b/dist/embeddings.js
|
||||||
|
index 6f4b928d3e4717309382e1b5c2e31ab5bc6c5af0..bc79429c88a6d27d4997a2740c4d8ae0707f5991 100644
|
||||||
|
--- a/dist/embeddings.js
|
||||||
|
+++ b/dist/embeddings.js
|
||||||
|
@@ -94,9 +94,11 @@ var OpenAIEmbeddings = class extends Embeddings {
|
||||||
|
* @returns Promise that resolves to an embedding for the document.
|
||||||
|
*/
|
||||||
|
async embedQuery(text) {
|
||||||
|
+ const isBaiduCloud = this.clientConfig.baseURL.includes('baidubce.com');
|
||||||
|
+ const input = this.stripNewLines ? text.replace(/\n/g, " ") : text
|
||||||
|
const params = {
|
||||||
|
model: this.model,
|
||||||
|
- input: this.stripNewLines ? text.replace(/\n/g, " ") : text
|
||||||
|
+ input: isBaiduCloud ? [input] : input
|
||||||
|
};
|
||||||
|
if (this.dimensions) params.dimensions = this.dimensions;
|
||||||
|
if (this.encodingFormat) params.encoding_format = this.encodingFormat;
|
||||||
@@ -1,276 +0,0 @@
|
|||||||
diff --git a/out/macPackager.js b/out/macPackager.js
|
|
||||||
index 852f6c4d16f86a7bb8a78bf1ed5a14647a279aa1..60e7f5f16a844541eb1909b215fcda1811e924b8 100644
|
|
||||||
--- a/out/macPackager.js
|
|
||||||
+++ b/out/macPackager.js
|
|
||||||
@@ -423,7 +423,7 @@ class MacPackager extends platformPackager_1.PlatformPackager {
|
|
||||||
}
|
|
||||||
appPlist.CFBundleName = appInfo.productName;
|
|
||||||
appPlist.CFBundleDisplayName = appInfo.productName;
|
|
||||||
- const minimumSystemVersion = this.platformSpecificBuildOptions.minimumSystemVersion;
|
|
||||||
+ const minimumSystemVersion = this.platformSpecificBuildOptions.LSMinimumSystemVersion;
|
|
||||||
if (minimumSystemVersion != null) {
|
|
||||||
appPlist.LSMinimumSystemVersion = minimumSystemVersion;
|
|
||||||
}
|
|
||||||
diff --git a/out/publish/updateInfoBuilder.js b/out/publish/updateInfoBuilder.js
|
|
||||||
index 7924c5b47d01f8dfccccb8f46658015fa66da1f7..1a1588923c3939ae1297b87931ba83f0ebc052d8 100644
|
|
||||||
--- a/out/publish/updateInfoBuilder.js
|
|
||||||
+++ b/out/publish/updateInfoBuilder.js
|
|
||||||
@@ -133,6 +133,7 @@ async function createUpdateInfo(version, event, releaseInfo) {
|
|
||||||
const customUpdateInfo = event.updateInfo;
|
|
||||||
const url = path.basename(event.file);
|
|
||||||
const sha512 = (customUpdateInfo == null ? null : customUpdateInfo.sha512) || (await (0, hash_1.hashFile)(event.file));
|
|
||||||
+ const minimumSystemVersion = customUpdateInfo == null ? null : customUpdateInfo.minimumSystemVersion;
|
|
||||||
const files = [{ url, sha512 }];
|
|
||||||
const result = {
|
|
||||||
// @ts-ignore
|
|
||||||
@@ -143,9 +144,13 @@ async function createUpdateInfo(version, event, releaseInfo) {
|
|
||||||
path: url /* backward compatibility, electron-updater 1.x - electron-updater 2.15.0 */,
|
|
||||||
// @ts-ignore
|
|
||||||
sha512 /* backward compatibility, electron-updater 1.x - electron-updater 2.15.0 */,
|
|
||||||
+ minimumSystemVersion,
|
|
||||||
...releaseInfo,
|
|
||||||
};
|
|
||||||
if (customUpdateInfo != null) {
|
|
||||||
+ if (customUpdateInfo.minimumSystemVersion) {
|
|
||||||
+ delete customUpdateInfo.minimumSystemVersion;
|
|
||||||
+ }
|
|
||||||
// file info or nsis web installer packages info
|
|
||||||
Object.assign("sha512" in customUpdateInfo ? files[0] : result, customUpdateInfo);
|
|
||||||
}
|
|
||||||
diff --git a/out/targets/ArchiveTarget.js b/out/targets/ArchiveTarget.js
|
|
||||||
index e1f52a5fa86fff6643b2e57eaf2af318d541f865..47cc347f154a24b365e70ae5e1f6d309f3582ed0 100644
|
|
||||||
--- a/out/targets/ArchiveTarget.js
|
|
||||||
+++ b/out/targets/ArchiveTarget.js
|
|
||||||
@@ -69,6 +69,9 @@ class ArchiveTarget extends core_1.Target {
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
+ if (updateInfo != null && this.packager.platformSpecificBuildOptions.minimumSystemVersion) {
|
|
||||||
+ updateInfo.minimumSystemVersion = this.packager.platformSpecificBuildOptions.minimumSystemVersion;
|
|
||||||
+ }
|
|
||||||
await packager.info.emitArtifactBuildCompleted({
|
|
||||||
updateInfo,
|
|
||||||
file: artifactPath,
|
|
||||||
diff --git a/out/targets/nsis/NsisTarget.js b/out/targets/nsis/NsisTarget.js
|
|
||||||
index e8bd7bb46c8a54b3f55cf3a853ef924195271e01..f956e9f3fe9eb903c78aef3502553b01de4b89b1 100644
|
|
||||||
--- a/out/targets/nsis/NsisTarget.js
|
|
||||||
+++ b/out/targets/nsis/NsisTarget.js
|
|
||||||
@@ -305,6 +305,9 @@ class NsisTarget extends core_1.Target {
|
|
||||||
if (updateInfo != null && isPerMachine && (oneClick || options.packElevateHelper)) {
|
|
||||||
updateInfo.isAdminRightsRequired = true;
|
|
||||||
}
|
|
||||||
+ if (updateInfo != null && this.packager.platformSpecificBuildOptions.minimumSystemVersion) {
|
|
||||||
+ updateInfo.minimumSystemVersion = this.packager.platformSpecificBuildOptions.minimumSystemVersion;
|
|
||||||
+ }
|
|
||||||
await packager.info.emitArtifactBuildCompleted({
|
|
||||||
file: installerPath,
|
|
||||||
updateInfo,
|
|
||||||
diff --git a/out/util/yarn.js b/out/util/yarn.js
|
|
||||||
index 1ee20f8b252a8f28d0c7b103789cf0a9a427aec1..c2878ec54d57da50bf14225e0c70c9c88664eb8a 100644
|
|
||||||
--- a/out/util/yarn.js
|
|
||||||
+++ b/out/util/yarn.js
|
|
||||||
@@ -140,6 +140,7 @@ async function rebuild(config, { appDir, projectDir }, options) {
|
|
||||||
arch,
|
|
||||||
platform,
|
|
||||||
buildFromSource,
|
|
||||||
+ ignoreModules: config.excludeReBuildModules || undefined,
|
|
||||||
projectRootPath: projectDir,
|
|
||||||
mode: config.nativeRebuilder || "sequential",
|
|
||||||
disablePreGypCopy: true,
|
|
||||||
diff --git a/scheme.json b/scheme.json
|
|
||||||
index 433e2efc9cef156ff5444f0c4520362ed2ef9ea7..0167441bf928a92f59b5dbe70b2317a74dda74c9 100644
|
|
||||||
--- a/scheme.json
|
|
||||||
+++ b/scheme.json
|
|
||||||
@@ -1825,6 +1825,20 @@
|
|
||||||
"string"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
+ "excludeReBuildModules": {
|
|
||||||
+ "anyOf": [
|
|
||||||
+ {
|
|
||||||
+ "items": {
|
|
||||||
+ "type": "string"
|
|
||||||
+ },
|
|
||||||
+ "type": "array"
|
|
||||||
+ },
|
|
||||||
+ {
|
|
||||||
+ "type": "null"
|
|
||||||
+ }
|
|
||||||
+ ],
|
|
||||||
+ "description": "The modules to exclude from the rebuild."
|
|
||||||
+ },
|
|
||||||
"executableArgs": {
|
|
||||||
"anyOf": [
|
|
||||||
{
|
|
||||||
@@ -1975,6 +1989,13 @@
|
|
||||||
],
|
|
||||||
"description": "The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing."
|
|
||||||
},
|
|
||||||
+ "minimumSystemVersion": {
|
|
||||||
+ "description": "The minimum os kernel version required to install the application.",
|
|
||||||
+ "type": [
|
|
||||||
+ "null",
|
|
||||||
+ "string"
|
|
||||||
+ ]
|
|
||||||
+ },
|
|
||||||
"packageCategory": {
|
|
||||||
"description": "backward compatibility + to allow specify fpm-only category for all possible fpm targets in one place",
|
|
||||||
"type": [
|
|
||||||
@@ -2327,6 +2348,13 @@
|
|
||||||
"MacConfiguration": {
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
+ "LSMinimumSystemVersion": {
|
|
||||||
+ "description": "The minimum version of macOS required for the app to run. Corresponds to `LSMinimumSystemVersion`.",
|
|
||||||
+ "type": [
|
|
||||||
+ "null",
|
|
||||||
+ "string"
|
|
||||||
+ ]
|
|
||||||
+ },
|
|
||||||
"additionalArguments": {
|
|
||||||
"anyOf": [
|
|
||||||
{
|
|
||||||
@@ -2527,6 +2555,20 @@
|
|
||||||
"string"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
+ "excludeReBuildModules": {
|
|
||||||
+ "anyOf": [
|
|
||||||
+ {
|
|
||||||
+ "items": {
|
|
||||||
+ "type": "string"
|
|
||||||
+ },
|
|
||||||
+ "type": "array"
|
|
||||||
+ },
|
|
||||||
+ {
|
|
||||||
+ "type": "null"
|
|
||||||
+ }
|
|
||||||
+ ],
|
|
||||||
+ "description": "The modules to exclude from the rebuild."
|
|
||||||
+ },
|
|
||||||
"executableName": {
|
|
||||||
"description": "The executable name. Defaults to `productName`.",
|
|
||||||
"type": [
|
|
||||||
@@ -2737,7 +2779,7 @@
|
|
||||||
"type": "boolean"
|
|
||||||
},
|
|
||||||
"minimumSystemVersion": {
|
|
||||||
- "description": "The minimum version of macOS required for the app to run. Corresponds to `LSMinimumSystemVersion`.",
|
|
||||||
+ "description": "The minimum os kernel version required to install the application.",
|
|
||||||
"type": [
|
|
||||||
"null",
|
|
||||||
"string"
|
|
||||||
@@ -2959,6 +3001,13 @@
|
|
||||||
"MasConfiguration": {
|
|
||||||
"additionalProperties": false,
|
|
||||||
"properties": {
|
|
||||||
+ "LSMinimumSystemVersion": {
|
|
||||||
+ "description": "The minimum version of macOS required for the app to run. Corresponds to `LSMinimumSystemVersion`.",
|
|
||||||
+ "type": [
|
|
||||||
+ "null",
|
|
||||||
+ "string"
|
|
||||||
+ ]
|
|
||||||
+ },
|
|
||||||
"additionalArguments": {
|
|
||||||
"anyOf": [
|
|
||||||
{
|
|
||||||
@@ -3159,6 +3208,20 @@
|
|
||||||
"string"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
+ "excludeReBuildModules": {
|
|
||||||
+ "anyOf": [
|
|
||||||
+ {
|
|
||||||
+ "items": {
|
|
||||||
+ "type": "string"
|
|
||||||
+ },
|
|
||||||
+ "type": "array"
|
|
||||||
+ },
|
|
||||||
+ {
|
|
||||||
+ "type": "null"
|
|
||||||
+ }
|
|
||||||
+ ],
|
|
||||||
+ "description": "The modules to exclude from the rebuild."
|
|
||||||
+ },
|
|
||||||
"executableName": {
|
|
||||||
"description": "The executable name. Defaults to `productName`.",
|
|
||||||
"type": [
|
|
||||||
@@ -3369,7 +3432,7 @@
|
|
||||||
"type": "boolean"
|
|
||||||
},
|
|
||||||
"minimumSystemVersion": {
|
|
||||||
- "description": "The minimum version of macOS required for the app to run. Corresponds to `LSMinimumSystemVersion`.",
|
|
||||||
+ "description": "The minimum os kernel version required to install the application.",
|
|
||||||
"type": [
|
|
||||||
"null",
|
|
||||||
"string"
|
|
||||||
@@ -6381,6 +6444,20 @@
|
|
||||||
"string"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
+ "excludeReBuildModules": {
|
|
||||||
+ "anyOf": [
|
|
||||||
+ {
|
|
||||||
+ "items": {
|
|
||||||
+ "type": "string"
|
|
||||||
+ },
|
|
||||||
+ "type": "array"
|
|
||||||
+ },
|
|
||||||
+ {
|
|
||||||
+ "type": "null"
|
|
||||||
+ }
|
|
||||||
+ ],
|
|
||||||
+ "description": "The modules to exclude from the rebuild."
|
|
||||||
+ },
|
|
||||||
"executableName": {
|
|
||||||
"description": "The executable name. Defaults to `productName`.",
|
|
||||||
"type": [
|
|
||||||
@@ -6507,6 +6584,13 @@
|
|
||||||
"string"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
+ "minimumSystemVersion": {
|
|
||||||
+ "description": "The minimum os kernel version required to install the application.",
|
|
||||||
+ "type": [
|
|
||||||
+ "null",
|
|
||||||
+ "string"
|
|
||||||
+ ]
|
|
||||||
+ },
|
|
||||||
"protocols": {
|
|
||||||
"anyOf": [
|
|
||||||
{
|
|
||||||
@@ -7153,6 +7237,20 @@
|
|
||||||
"string"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
+ "excludeReBuildModules": {
|
|
||||||
+ "anyOf": [
|
|
||||||
+ {
|
|
||||||
+ "items": {
|
|
||||||
+ "type": "string"
|
|
||||||
+ },
|
|
||||||
+ "type": "array"
|
|
||||||
+ },
|
|
||||||
+ {
|
|
||||||
+ "type": "null"
|
|
||||||
+ }
|
|
||||||
+ ],
|
|
||||||
+ "description": "The modules to exclude from the rebuild."
|
|
||||||
+ },
|
|
||||||
"executableName": {
|
|
||||||
"description": "The executable name. Defaults to `productName`.",
|
|
||||||
"type": [
|
|
||||||
@@ -7376,6 +7474,13 @@
|
|
||||||
],
|
|
||||||
"description": "MAS (Mac Application Store) development options (`mas-dev` target)."
|
|
||||||
},
|
|
||||||
+ "minimumSystemVersion": {
|
|
||||||
+ "description": "The minimum os kernel version required to install the application.",
|
|
||||||
+ "type": [
|
|
||||||
+ "null",
|
|
||||||
+ "string"
|
|
||||||
+ ]
|
|
||||||
+ },
|
|
||||||
"msi": {
|
|
||||||
"anyOf": [
|
|
||||||
{
|
|
||||||
14
.yarn/patches/electron-updater-npm-6.7.0-47b11bb0d4.patch
vendored
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
diff --git a/out/util.js b/out/util.js
|
||||||
|
index 9294ffd6ca8f02c2e0f90c663e7e9cdc02c1ac37..f52107493e2995320ee4efd0eb2a8c9bf03291a2 100644
|
||||||
|
--- a/out/util.js
|
||||||
|
+++ b/out/util.js
|
||||||
|
@@ -23,7 +23,8 @@ function newUrlFromBase(pathname, baseUrl, addRandomQueryToAvoidCaching = false)
|
||||||
|
result.search = search;
|
||||||
|
}
|
||||||
|
else if (addRandomQueryToAvoidCaching) {
|
||||||
|
- result.search = `noCache=${Date.now().toString(32)}`;
|
||||||
|
+ // use no cache header instead
|
||||||
|
+ // result.search = `noCache=${Date.now().toString(32)}`;
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}
|
||||||
@@ -7,11 +7,12 @@ This file provides guidance to AI coding assistants when working with code in th
|
|||||||
- **Keep it clear**: Write code that is easy to read, maintain, and explain.
|
- **Keep it clear**: Write code that is easy to read, maintain, and explain.
|
||||||
- **Match the house style**: Reuse existing patterns, naming, and conventions.
|
- **Match the house style**: Reuse existing patterns, naming, and conventions.
|
||||||
- **Search smart**: Prefer `ast-grep` for semantic queries; fall back to `rg`/`grep` when needed.
|
- **Search smart**: Prefer `ast-grep` for semantic queries; fall back to `rg`/`grep` when needed.
|
||||||
- **Build with HeroUI**: Use HeroUI for every new UI component; never add `antd` or `styled-components`.
|
|
||||||
- **Log centrally**: Route all logging through `loggerService` with the right context—no `console.log`.
|
- **Log centrally**: Route all logging through `loggerService` with the right context—no `console.log`.
|
||||||
- **Research via subagent**: Lean on `subagent` for external docs, APIs, news, and references.
|
- **Research via subagent**: Lean on `subagent` for external docs, APIs, news, and references.
|
||||||
- **Seek review**: Ask a human developer to review substantial changes before merging.
|
- **Always propose before executing**: Before making any changes, clearly explain your planned approach and wait for explicit user approval to ensure alignment and prevent unwanted modifications.
|
||||||
- **Commit in rhythm**: Keep commits small, conventional, and emoji-tagged.
|
- **Lint, test, and format before completion**: Coding tasks are only complete after running `yarn lint`, `yarn test`, and `yarn format` successfully.
|
||||||
|
- **Write conventional commits**: Commit small, focused changes using Conventional Commit messages (e.g., `feat:`, `fix:`, `refactor:`, `docs:`).
|
||||||
|
- **Follow PR template**: When submitting pull requests, follow the template in `.github/pull_request_template.md` to ensure complete context and documentation.
|
||||||
|
|
||||||
## Development Commands
|
## Development Commands
|
||||||
|
|
||||||
@@ -40,7 +41,6 @@ This file provides guidance to AI coding assistants when working with code in th
|
|||||||
- **Services** (`src/main/services/`): MCPService, KnowledgeService, WindowService, etc.
|
- **Services** (`src/main/services/`): MCPService, KnowledgeService, WindowService, etc.
|
||||||
- **Build System**: Electron-Vite with experimental rolldown-vite, yarn workspaces.
|
- **Build System**: Electron-Vite with experimental rolldown-vite, yarn workspaces.
|
||||||
- **State Management**: Redux Toolkit (`src/renderer/src/store/`) for predictable state.
|
- **State Management**: Redux Toolkit (`src/renderer/src/store/`) for predictable state.
|
||||||
- **UI Components**: HeroUI (`@heroui/*`) for all new UI elements.
|
|
||||||
|
|
||||||
### Logging
|
### Logging
|
||||||
```typescript
|
```typescript
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
[中文](docs/CONTRIBUTING.zh.md) | [English](CONTRIBUTING.md)
|
[中文](docs/zh/guides/contributing.md) | [English](CONTRIBUTING.md)
|
||||||
|
|
||||||
# Cherry Studio Contributor Guide
|
# Cherry Studio Contributor Guide
|
||||||
|
|
||||||
@@ -32,7 +32,7 @@ To help you get familiar with the codebase, we recommend tackling issues tagged
|
|||||||
|
|
||||||
### Testing
|
### Testing
|
||||||
|
|
||||||
Features without tests are considered non-existent. To ensure code is truly effective, relevant processes should be covered by unit tests and functional tests. Therefore, when considering contributions, please also consider testability. All tests can be run locally without dependency on CI. Please refer to the "Testing" section in the [Developer Guide](docs/dev.md).
|
Features without tests are considered non-existent. To ensure code is truly effective, relevant processes should be covered by unit tests and functional tests. Therefore, when considering contributions, please also consider testability. All tests can be run locally without dependency on CI. Please refer to the "Testing" section in the [Developer Guide](docs/zh/guides/development.md).
|
||||||
|
|
||||||
### Automated Testing for Pull Requests
|
### Automated Testing for Pull Requests
|
||||||
|
|
||||||
@@ -60,12 +60,33 @@ Maintainers are here to help you implement your use case within a reasonable tim
|
|||||||
|
|
||||||
### Participating in the Test Plan
|
### Participating in the Test Plan
|
||||||
|
|
||||||
The Test Plan aims to provide users with a more stable application experience and faster iteration speed. For details, please refer to the [Test Plan](docs/testplan-en.md).
|
The Test Plan aims to provide users with a more stable application experience and faster iteration speed. For details, please refer to the [Test Plan](docs/en/guides/test-plan.md).
|
||||||
|
|
||||||
### Other Suggestions
|
### Other Suggestions
|
||||||
|
|
||||||
- **Contact Developers**: Before submitting a PR, you can contact the developers first to discuss or get help.
|
- **Contact Developers**: Before submitting a PR, you can contact the developers first to discuss or get help.
|
||||||
- **Become a Core Developer**: If you contribute to the project consistently, congratulations, you can become a core developer and gain project membership status. Please check our [Membership Guide](https://github.com/CherryHQ/community/blob/main/docs/membership.en.md).
|
|
||||||
|
## Important Contribution Guidelines & Focus Areas
|
||||||
|
|
||||||
|
Please review the following critical information before submitting your Pull Request:
|
||||||
|
|
||||||
|
### Temporary Restriction on Data-Changing Feature PRs 🚫
|
||||||
|
|
||||||
|
**Currently, we are NOT accepting feature Pull Requests that introduce changes to our Redux data models or IndexedDB schemas.**
|
||||||
|
|
||||||
|
Our core team is currently focused on significant architectural updates that involve these data structures. To ensure stability and focus during this period, contributions of this nature will be temporarily managed internally.
|
||||||
|
|
||||||
|
* **PRs that require changes to Redux state shape or IndexedDB schemas will be closed.**
|
||||||
|
* **This restriction is temporary and will be lifted with the release of `v2.0.0`.** You can track the progress of `v2.0.0` and its related discussions on issue [#10162](https://github.com/CherryHQ/cherry-studio/pull/10162).
|
||||||
|
|
||||||
|
We highly encourage contributions for:
|
||||||
|
* Bug fixes 🐞
|
||||||
|
* Performance improvements 🚀
|
||||||
|
* Documentation updates 📚
|
||||||
|
* Features that **do not** alter Redux data models or IndexedDB schemas (e.g., UI enhancements, new components, minor refactors). ✨
|
||||||
|
|
||||||
|
We appreciate your understanding and continued support during this important development phase. Thank you!
|
||||||
|
|
||||||
|
|
||||||
## Contact Us
|
## Contact Us
|
||||||
|
|
||||||
|
|||||||
24
README.md
@@ -37,7 +37,7 @@
|
|||||||
<p align="center">English | <a href="./docs/README.zh.md">中文</a> | <a href="https://cherry-ai.com">Official Site</a> | <a href="https://docs.cherry-ai.com/cherry-studio-wen-dang/en-us">Documents</a> | <a href="./docs/dev.md">Development</a> | <a href="https://github.com/CherryHQ/cherry-studio/issues">Feedback</a><br></p>
|
<p align="center">English | <a href="./docs/README.zh.md">中文</a> | <a href="https://cherry-ai.com">Official Site</a> | <a href="https://docs.cherry-ai.com/cherry-studio-wen-dang/en-us">Documents</a> | <a href="./docs/dev.md">Development</a> | <a href="https://github.com/CherryHQ/cherry-studio/issues">Feedback</a><br></p>
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
[![][deepwiki-shield]][deepwiki-link]
|
[![][deepwiki-shield]][deepwiki-link]
|
||||||
[![][twitter-shield]][twitter-link]
|
[![][twitter-shield]][twitter-link]
|
||||||
[![][discord-shield]][discord-link]
|
[![][discord-shield]][discord-link]
|
||||||
@@ -45,7 +45,7 @@
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
[![][github-release-shield]][github-release-link]
|
[![][github-release-shield]][github-release-link]
|
||||||
[![][github-nightly-shield]][github-nightly-link]
|
[![][github-nightly-shield]][github-nightly-link]
|
||||||
[![][github-contributors-shield]][github-contributors-link]
|
[![][github-contributors-shield]][github-contributors-link]
|
||||||
@@ -67,7 +67,7 @@ Cherry Studio is a desktop client that supports multiple LLM providers, availabl
|
|||||||
|
|
||||||
👏 Join [Telegram Group](https://t.me/CherryStudioAI)|[Discord](https://discord.gg/wez8HtpxqQ) | [QQ Group(575014769)](https://qm.qq.com/q/lo0D4qVZKi)
|
👏 Join [Telegram Group](https://t.me/CherryStudioAI)|[Discord](https://discord.gg/wez8HtpxqQ) | [QQ Group(575014769)](https://qm.qq.com/q/lo0D4qVZKi)
|
||||||
|
|
||||||
❤️ Like Cherry Studio? Give it a star 🌟 or [Sponsor](docs/sponsor.md) to support the development!
|
❤️ Like Cherry Studio? Give it a star 🌟 or [Sponsor](docs/zh/guides/sponsor.md) to support the development!
|
||||||
|
|
||||||
# 🌠 Screenshot
|
# 🌠 Screenshot
|
||||||
|
|
||||||
@@ -82,7 +82,7 @@ Cherry Studio is a desktop client that supports multiple LLM providers, availabl
|
|||||||
1. **Diverse LLM Provider Support**:
|
1. **Diverse LLM Provider Support**:
|
||||||
|
|
||||||
- ☁️ Major LLM Cloud Services: OpenAI, Gemini, Anthropic, and more
|
- ☁️ Major LLM Cloud Services: OpenAI, Gemini, Anthropic, and more
|
||||||
- 🔗 AI Web Service Integration: Claude, Perplexity, Poe, and others
|
- 🔗 AI Web Service Integration: Claude, Perplexity, [Poe](https://poe.com/), and others
|
||||||
- 💻 Local Model Support with Ollama, LM Studio
|
- 💻 Local Model Support with Ollama, LM Studio
|
||||||
|
|
||||||
2. **AI Assistants & Conversations**:
|
2. **AI Assistants & Conversations**:
|
||||||
@@ -175,7 +175,7 @@ We welcome contributions to Cherry Studio! Here are some ways you can contribute
|
|||||||
6. **Community Engagement**: Join discussions and help users.
|
6. **Community Engagement**: Join discussions and help users.
|
||||||
7. **Promote Usage**: Spread the word about Cherry Studio.
|
7. **Promote Usage**: Spread the word about Cherry Studio.
|
||||||
|
|
||||||
Refer to the [Branching Strategy](docs/branching-strategy-en.md) for contribution guidelines
|
Refer to the [Branching Strategy](docs/en/guides/branching-strategy.md) for contribution guidelines
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
@@ -238,20 +238,16 @@ The Enterprise Edition addresses core challenges in team collaboration by centra
|
|||||||
|
|
||||||
## ✨ Online Demo
|
## ✨ Online Demo
|
||||||
|
|
||||||
> 🚧 **Public Beta Notice**
|
|
||||||
>
|
|
||||||
> The Enterprise Edition is currently in its early public beta stage, and we are actively iterating and optimizing its features. We are aware that it may not be perfectly stable yet. If you encounter any issues or have valuable suggestions during your trial, we would be very grateful if you could contact us via email to provide feedback.
|
|
||||||
|
|
||||||
**🔗 [Cherry Studio Enterprise](https://www.cherry-ai.com/enterprise)**
|
**🔗 [Cherry Studio Enterprise](https://www.cherry-ai.com/enterprise)**
|
||||||
|
|
||||||
## Version Comparison
|
## Version Comparison
|
||||||
|
|
||||||
| Feature | Community Edition | Enterprise Edition |
|
| Feature | Community Edition | Enterprise Edition |
|
||||||
| :---------------- | :----------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------- |
|
| :---------------- | :----------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| **Open Source** | ✅ Yes | ⭕️ Partially released to customers |
|
| **Open Source** | ✅ Yes | ⭕️ Partially released to customers |
|
||||||
| **Cost** | Free for Personal Use / Commercial License | Buyout / Subscription Fee |
|
| **Cost** | [AGPL-3.0 License](https://github.com/CherryHQ/cherry-studio?tab=AGPL-3.0-1-ov-file) | Buyout / Subscription Fee |
|
||||||
| **Admin Backend** | — | ● Centralized **Model** Access<br>● **Employee** Management<br>● Shared **Knowledge Base**<br>● **Access** Control<br>● **Data** Backup |
|
| **Admin Backend** | — | ● Centralized **Model** Access<br>● **Employee** Management<br>● Shared **Knowledge Base**<br>● **Access** Control<br>● **Data** Backup |
|
||||||
| **Server** | — | ✅ Dedicated Private Deployment |
|
| **Server** | — | ✅ Dedicated Private Deployment |
|
||||||
|
|
||||||
## Get the Enterprise Edition
|
## Get the Enterprise Edition
|
||||||
|
|
||||||
@@ -262,8 +258,12 @@ We believe the Enterprise Edition will become your team's AI productivity engine
|
|||||||
|
|
||||||
# 🔗 Related Projects
|
# 🔗 Related Projects
|
||||||
|
|
||||||
|
- [new-api](https://github.com/QuantumNous/new-api): The next-generation LLM gateway and AI asset management system supports multiple languages.
|
||||||
|
|
||||||
- [one-api](https://github.com/songquanpeng/one-api): LLM API management and distribution system supporting mainstream models like OpenAI, Azure, and Anthropic. Features a unified API interface, suitable for key management and secondary distribution.
|
- [one-api](https://github.com/songquanpeng/one-api): LLM API management and distribution system supporting mainstream models like OpenAI, Azure, and Anthropic. Features a unified API interface, suitable for key management and secondary distribution.
|
||||||
|
|
||||||
|
- [Poe](https://poe.com/): Poe gives you access to the best AI, all in one place. Explore GPT-5, Claude Opus 4.1, DeepSeek-R1, Veo 3, ElevenLabs, and millions of others.
|
||||||
|
|
||||||
- [ublacklist](https://github.com/iorate/ublacklist): Blocks specific sites from appearing in Google search results
|
- [ublacklist](https://github.com/iorate/ublacklist): Blocks specific sites from appearing in Google search results
|
||||||
|
|
||||||
# 🚀 Contributors
|
# 🚀 Contributors
|
||||||
|
|||||||
49
app-upgrade-config.json
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
{
|
||||||
|
"lastUpdated": "2025-11-10T08:14:28Z",
|
||||||
|
"versions": {
|
||||||
|
"1.6.7": {
|
||||||
|
"metadata": {
|
||||||
|
"segmentId": "legacy-v1",
|
||||||
|
"segmentType": "legacy"
|
||||||
|
},
|
||||||
|
"minCompatibleVersion": "1.0.0",
|
||||||
|
"description": "Last stable v1.7.x release - required intermediate version for users below v1.7",
|
||||||
|
"channels": {
|
||||||
|
"latest": {
|
||||||
|
"version": "1.6.7",
|
||||||
|
"feedUrls": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/download/v1.6.7",
|
||||||
|
"gitcode": "https://releases.cherry-ai.com"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"rc": {
|
||||||
|
"version": "1.6.0-rc.5",
|
||||||
|
"feedUrls": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/download/v1.6.0-rc.5",
|
||||||
|
"gitcode": "https://github.com/CherryHQ/cherry-studio/releases/download/v1.6.0-rc.5"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"beta": {
|
||||||
|
"version": "1.7.0-beta.3",
|
||||||
|
"feedUrls": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/download/v1.7.0-beta.3",
|
||||||
|
"gitcode": "https://github.com/CherryHQ/cherry-studio/releases/download/v1.7.0-beta.3"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"2.0.0": {
|
||||||
|
"metadata": {
|
||||||
|
"segmentId": "gateway-v2",
|
||||||
|
"segmentType": "breaking"
|
||||||
|
},
|
||||||
|
"minCompatibleVersion": "1.7.0",
|
||||||
|
"description": "Major release v2.0 - required intermediate version for v2.x upgrades",
|
||||||
|
"channels": {
|
||||||
|
"latest": null,
|
||||||
|
"rc": null,
|
||||||
|
"beta": null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -14,14 +14,18 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
"includes": ["**/*.json", "!*.json", "!**/package.json"]
|
"includes": ["**/*.json", "!*.json", "!**/package.json", "!coverage/**"]
|
||||||
},
|
},
|
||||||
"css": {
|
"css": {
|
||||||
"formatter": {
|
"formatter": {
|
||||||
"quoteStyle": "single"
|
"quoteStyle": "single"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"files": { "ignoreUnknown": false },
|
"files": {
|
||||||
|
"ignoreUnknown": false,
|
||||||
|
"includes": ["**", "!**/.claude/**", "!**/.vscode/**"],
|
||||||
|
"maxSize": 2097152
|
||||||
|
},
|
||||||
"formatter": {
|
"formatter": {
|
||||||
"attributePosition": "auto",
|
"attributePosition": "auto",
|
||||||
"bracketSameLine": false,
|
"bracketSameLine": false,
|
||||||
|
|||||||
@@ -1,21 +0,0 @@
|
|||||||
{
|
|
||||||
"$schema": "https://ui.shadcn.com/schema.json",
|
|
||||||
"aliases": {
|
|
||||||
"components": "@renderer/ui/third-party",
|
|
||||||
"hooks": "@renderer/hooks",
|
|
||||||
"lib": "@renderer/lib",
|
|
||||||
"ui": "@renderer/ui",
|
|
||||||
"utils": "@renderer/utils"
|
|
||||||
},
|
|
||||||
"iconLibrary": "lucide",
|
|
||||||
"rsc": false,
|
|
||||||
"style": "new-york",
|
|
||||||
"tailwind": {
|
|
||||||
"baseColor": "zinc",
|
|
||||||
"config": "",
|
|
||||||
"css": "src/renderer/src/assets/styles/tailwind.css",
|
|
||||||
"cssVariables": true,
|
|
||||||
"prefix": ""
|
|
||||||
},
|
|
||||||
"tsx": true
|
|
||||||
}
|
|
||||||
81
config/app-upgrade-segments.json
Normal file
@@ -0,0 +1,81 @@
|
|||||||
|
{
|
||||||
|
"segments": [
|
||||||
|
{
|
||||||
|
"id": "legacy-v1",
|
||||||
|
"type": "legacy",
|
||||||
|
"match": {
|
||||||
|
"range": ">=1.0.0 <2.0.0"
|
||||||
|
},
|
||||||
|
"minCompatibleVersion": "1.0.0",
|
||||||
|
"description": "Last stable v1.7.x release - required intermediate version for users below v1.7",
|
||||||
|
"channelTemplates": {
|
||||||
|
"latest": {
|
||||||
|
"feedTemplates": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/download/{{tag}}",
|
||||||
|
"gitcode": "https://releases.cherry-ai.com"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"rc": {
|
||||||
|
"feedTemplates": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/download/{{tag}}",
|
||||||
|
"gitcode": "https://github.com/CherryHQ/cherry-studio/releases/download/{{tag}}"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"beta": {
|
||||||
|
"feedTemplates": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/download/{{tag}}",
|
||||||
|
"gitcode": "https://github.com/CherryHQ/cherry-studio/releases/download/{{tag}}"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "gateway-v2",
|
||||||
|
"type": "breaking",
|
||||||
|
"match": {
|
||||||
|
"exact": ["2.0.0"]
|
||||||
|
},
|
||||||
|
"lockedVersion": "2.0.0",
|
||||||
|
"minCompatibleVersion": "1.7.0",
|
||||||
|
"description": "Major release v2.0 - required intermediate version for v2.x upgrades",
|
||||||
|
"channelTemplates": {
|
||||||
|
"latest": {
|
||||||
|
"feedTemplates": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/download/{{tag}}",
|
||||||
|
"gitcode": "https://gitcode.com/CherryHQ/cherry-studio/releases/download/{{tag}}"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "current-v2",
|
||||||
|
"type": "latest",
|
||||||
|
"match": {
|
||||||
|
"range": ">=2.0.0 <3.0.0",
|
||||||
|
"excludeExact": ["2.0.0"]
|
||||||
|
},
|
||||||
|
"minCompatibleVersion": "2.0.0",
|
||||||
|
"description": "Current latest v2.x release",
|
||||||
|
"channelTemplates": {
|
||||||
|
"latest": {
|
||||||
|
"feedTemplates": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/download/{{tag}}",
|
||||||
|
"gitcode": "https://gitcode.com/CherryHQ/cherry-studio/releases/download/{{tag}}"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"rc": {
|
||||||
|
"feedTemplates": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/download/{{tag}}",
|
||||||
|
"gitcode": "https://gitcode.com/CherryHQ/cherry-studio/releases/download/{{tag}}"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"beta": {
|
||||||
|
"feedTemplates": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/download/{{tag}}",
|
||||||
|
"gitcode": "https://gitcode.com/CherryHQ/cherry-studio/releases/download/{{tag}}"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
81
docs/README.md
Normal file
@@ -0,0 +1,81 @@
|
|||||||
|
# Cherry Studio Documentation / 文档
|
||||||
|
|
||||||
|
This directory contains the project documentation in multiple languages.
|
||||||
|
|
||||||
|
本目录包含多语言项目文档。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Languages / 语言
|
||||||
|
|
||||||
|
- **[中文文档](./zh/README.md)** - Chinese Documentation
|
||||||
|
- **English Documentation** - See sections below
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## English Documentation
|
||||||
|
|
||||||
|
### Guides
|
||||||
|
|
||||||
|
| Document | Description |
|
||||||
|
|----------|-------------|
|
||||||
|
| [Development Setup](./en/guides/development.md) | Development environment setup |
|
||||||
|
| [Branching Strategy](./en/guides/branching-strategy.md) | Git branching workflow |
|
||||||
|
| [i18n Guide](./en/guides/i18n.md) | Internationalization guide |
|
||||||
|
| [Logging Guide](./en/guides/logging.md) | How to use the logger service |
|
||||||
|
| [Test Plan](./en/guides/test-plan.md) | Test plan and release channels |
|
||||||
|
|
||||||
|
### References
|
||||||
|
|
||||||
|
| Document | Description |
|
||||||
|
|----------|-------------|
|
||||||
|
| [App Upgrade Config](./en/references/app-upgrade.md) | Application upgrade configuration |
|
||||||
|
| [CodeBlockView Component](./en/references/components/code-block-view.md) | Code block view component |
|
||||||
|
| [Image Preview Components](./en/references/components/image-preview.md) | Image preview components |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 中文文档
|
||||||
|
|
||||||
|
### 指南 (Guides)
|
||||||
|
|
||||||
|
| 文档 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| [开发环境设置](./zh/guides/development.md) | 开发环境配置 |
|
||||||
|
| [贡献指南](./zh/guides/contributing.md) | 如何贡献代码 |
|
||||||
|
| [分支策略](./zh/guides/branching-strategy.md) | Git 分支工作流 |
|
||||||
|
| [测试计划](./zh/guides/test-plan.md) | 测试计划和发布通道 |
|
||||||
|
| [国际化指南](./zh/guides/i18n.md) | 国际化开发指南 |
|
||||||
|
| [日志使用指南](./zh/guides/logging.md) | 如何使用日志服务 |
|
||||||
|
| [中间件开发](./zh/guides/middleware.md) | 如何编写中间件 |
|
||||||
|
| [记忆功能](./zh/guides/memory.md) | 记忆功能使用指南 |
|
||||||
|
| [赞助信息](./zh/guides/sponsor.md) | 赞助相关信息 |
|
||||||
|
|
||||||
|
### 参考 (References)
|
||||||
|
|
||||||
|
| 文档 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| [消息系统](./zh/references/message-system.md) | 消息系统架构和 API |
|
||||||
|
| [数据库结构](./zh/references/database.md) | 数据库表结构 |
|
||||||
|
| [服务](./zh/references/services.md) | 服务层文档 (KnowledgeService) |
|
||||||
|
| [代码执行](./zh/references/code-execution.md) | 代码执行功能 |
|
||||||
|
| [应用升级配置](./zh/references/app-upgrade.md) | 应用升级配置 |
|
||||||
|
| [CodeBlockView 组件](./zh/references/components/code-block-view.md) | 代码块视图组件 |
|
||||||
|
| [图像预览组件](./zh/references/components/image-preview.md) | 图像预览组件 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Missing Translations / 缺少翻译
|
||||||
|
|
||||||
|
The following documents are only available in Chinese and need English translations:
|
||||||
|
|
||||||
|
以下文档仅有中文版本,需要英文翻译:
|
||||||
|
|
||||||
|
- `guides/contributing.md`
|
||||||
|
- `guides/memory.md`
|
||||||
|
- `guides/middleware.md`
|
||||||
|
- `guides/sponsor.md`
|
||||||
|
- `references/message-system.md`
|
||||||
|
- `references/database.md`
|
||||||
|
- `references/services.md`
|
||||||
|
- `references/code-execution.md`
|
||||||
|
Before Width: | Height: | Size: 150 KiB After Width: | Height: | Size: 150 KiB |
|
Before Width: | Height: | Size: 40 KiB After Width: | Height: | Size: 40 KiB |
|
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 35 KiB |
|
Before Width: | Height: | Size: 563 KiB After Width: | Height: | Size: 563 KiB |
@@ -16,7 +16,7 @@ Cherry Studio implements a structured branching strategy to maintain code qualit
|
|||||||
- Only accepts documentation updates and bug fixes
|
- Only accepts documentation updates and bug fixes
|
||||||
- Thoroughly tested before production deployment
|
- Thoroughly tested before production deployment
|
||||||
|
|
||||||
For details about the `testplan` branch used in the Test Plan, please refer to the [Test Plan](testplan-en.md).
|
For details about the `testplan` branch used in the Test Plan, please refer to the [Test Plan](./test-plan.md).
|
||||||
|
|
||||||
## Contributing Branches
|
## Contributing Branches
|
||||||
|
|
||||||
@@ -18,13 +18,13 @@ yarn
|
|||||||
|
|
||||||
### Setup Node.js
|
### Setup Node.js
|
||||||
|
|
||||||
Download and install [Node.js v20.x.x](https://nodejs.org/en/download)
|
Download and install [Node.js v22.x.x](https://nodejs.org/en/download)
|
||||||
|
|
||||||
### Setup Yarn
|
### Setup Yarn
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
corepack enable
|
corepack enable
|
||||||
corepack prepare yarn@4.6.0 --activate
|
corepack prepare yarn@4.9.1 --activate
|
||||||
```
|
```
|
||||||
|
|
||||||
### Install Dependencies
|
### Install Dependencies
|
||||||
@@ -18,11 +18,11 @@ The plugin has already been configured in the project — simply install it to g
|
|||||||
|
|
||||||
### Demo
|
### Demo
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||

|

|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## i18n Conventions
|
## i18n Conventions
|
||||||
|
|
||||||
@@ -11,13 +11,15 @@ The Test Plan is divided into the RC channel and the Beta channel, with the foll
|
|||||||
|
|
||||||
Users can enable the "Test Plan" and select the version channel in the software's `Settings` > `About`. Please note that the versions in the "Test Plan" cannot guarantee data consistency, so be sure to back up your data before using them.
|
Users can enable the "Test Plan" and select the version channel in the software's `Settings` > `About`. Please note that the versions in the "Test Plan" cannot guarantee data consistency, so be sure to back up your data before using them.
|
||||||
|
|
||||||
|
After enabling the RC channel or Beta channel, if a stable version is released, users will still be upgraded to the stable version.
|
||||||
|
|
||||||
Users are welcome to submit issues or provide feedback through other channels for any bugs encountered during testing. Your feedback is very important to us.
|
Users are welcome to submit issues or provide feedback through other channels for any bugs encountered during testing. Your feedback is very important to us.
|
||||||
|
|
||||||
## Developer Guide
|
## Developer Guide
|
||||||
|
|
||||||
### Participating in the Test Plan
|
### Participating in the Test Plan
|
||||||
|
|
||||||
Developers should submit `PRs` according to the [Contributor Guide](../CONTRIBUTING.md) (and ensure the target branch is `main`). The repository maintainers will evaluate whether the `PR` should be included in the Test Plan based on factors such as the impact of the feature on the application, its importance, and whether broader testing is needed.
|
Developers should submit `PRs` according to the [Contributor Guide](../../CONTRIBUTING.md) (and ensure the target branch is `main`). The repository maintainers will evaluate whether the `PR` should be included in the Test Plan based on factors such as the impact of the feature on the application, its importance, and whether broader testing is needed.
|
||||||
|
|
||||||
If the `PR` is added to the Test Plan, the repository maintainers will:
|
If the `PR` is added to the Test Plan, the repository maintainers will:
|
||||||
|
|
||||||
430
docs/en/references/app-upgrade.md
Normal file
@@ -0,0 +1,430 @@
|
|||||||
|
# Update Configuration System Design Document
|
||||||
|
|
||||||
|
## Background
|
||||||
|
|
||||||
|
Currently, AppUpdater directly queries the GitHub API to retrieve beta and rc update information. To support users in China, we need to fetch a static JSON configuration file from GitHub/GitCode based on IP geolocation, which contains update URLs for all channels.
|
||||||
|
|
||||||
|
## Design Goals
|
||||||
|
|
||||||
|
1. Support different configuration sources based on IP geolocation (GitHub/GitCode)
|
||||||
|
2. Support version compatibility control (e.g., users below v1.x must upgrade to v1.7.0 before upgrading to v2.0)
|
||||||
|
3. Easy to extend, supporting future multi-major-version upgrade paths (v1.6 → v1.7 → v2.0 → v2.8 → v3.0)
|
||||||
|
4. Maintain compatibility with existing electron-updater mechanism
|
||||||
|
|
||||||
|
## Current Version Strategy
|
||||||
|
|
||||||
|
- **v1.7.x** is the last version of the 1.x series
|
||||||
|
- Users **below v1.7.0** must first upgrade to v1.7.0 (or higher 1.7.x version)
|
||||||
|
- Users **v1.7.0 and above** can directly upgrade to v2.x.x
|
||||||
|
|
||||||
|
## Automation Workflow
|
||||||
|
|
||||||
|
The `x-files/app-upgrade-config/app-upgrade-config.json` file is synchronized by the [`Update App Upgrade Config`](../../.github/workflows/update-app-upgrade-config.yml) workflow. The workflow runs the [`scripts/update-app-upgrade-config.ts`](../../scripts/update-app-upgrade-config.ts) helper so that every release tag automatically updates the JSON in `x-files/app-upgrade-config`.
|
||||||
|
|
||||||
|
### Trigger Conditions
|
||||||
|
|
||||||
|
- **Release events (`release: released/prereleased`)**
|
||||||
|
- Draft releases are ignored.
|
||||||
|
- When GitHub marks the release as _prerelease_, the tag must include `-beta`/`-rc` (with optional numeric suffix). Otherwise the workflow exits early.
|
||||||
|
- When GitHub marks the release as stable, the tag must match the latest release returned by the GitHub API. This prevents out-of-order updates when publishing historical tags.
|
||||||
|
- If the guard clauses pass, the version is tagged as `latest` or `beta/rc` based on its semantic suffix and propagated to the script through the `IS_PRERELEASE` flag.
|
||||||
|
- **Manual dispatch (`workflow_dispatch`)**
|
||||||
|
- Required input: `tag` (e.g., `v2.0.1`). Optional input: `is_prerelease` (defaults to `false`).
|
||||||
|
- When `is_prerelease=true`, the tag must carry a beta/rc suffix, mirroring the automatic validation.
|
||||||
|
- Manual runs still download the latest release metadata so that the workflow knows whether the tag represents the newest stable version (for documentation inside the PR body).
|
||||||
|
|
||||||
|
### Workflow Steps
|
||||||
|
|
||||||
|
1. **Guard + metadata preparation** – the `Check if should proceed` and `Prepare metadata` steps compute the target tag, prerelease flag, whether the tag is the newest release, and a `safe_tag` slug used for branch names. When any rule fails, the workflow stops without touching the config.
|
||||||
|
2. **Checkout source branches** – the default branch is checked out into `main/`, while the long-lived `x-files/app-upgrade-config` branch lives in `cs/`. All modifications happen in the latter directory.
|
||||||
|
3. **Install toolchain** – Node.js 22, Corepack, and frozen Yarn dependencies are installed inside `main/`.
|
||||||
|
4. **Run the update script** – `yarn tsx scripts/update-app-upgrade-config.ts --tag <tag> --config ../cs/app-upgrade-config.json --is-prerelease <flag>` updates the JSON in-place.
|
||||||
|
- The script normalizes the tag (e.g., strips `v` prefix), detects the release channel (`latest`, `rc`, `beta`), and loads segment rules from `config/app-upgrade-segments.json`.
|
||||||
|
- It validates that prerelease flags and semantic suffixes agree, enforces locked segments, builds mirror feed URLs, and performs release-availability checks (GitHub HEAD request for every channel; GitCode GET for latest channels, falling back to `https://releases.cherry-ai.com` when gitcode is delayed).
|
||||||
|
- After updating the relevant channel entry, the script rewrites the config with semver-sort order and a new `lastUpdated` timestamp.
|
||||||
|
5. **Detect changes + create PR** – if `cs/app-upgrade-config.json` changed, the workflow opens a PR `chore/update-app-upgrade-config/<safe_tag>` against `x-files/app-upgrade-config` with a commit message `🤖 chore: sync app-upgrade-config for <tag>`. Otherwise it logs that no update is required.
|
||||||
|
|
||||||
|
### Manual Trigger Guide
|
||||||
|
|
||||||
|
1. Open the Cherry Studio repository on GitHub → **Actions** tab → select **Update App Upgrade Config**.
|
||||||
|
2. Click **Run workflow**, choose the default branch (usually `main`), and fill in the `tag` input (e.g., `v2.1.0`).
|
||||||
|
3. Toggle `is_prerelease` only when the tag carries a prerelease suffix (`-beta`, `-rc`). Leave it unchecked for stable releases.
|
||||||
|
4. Start the run and wait for it to finish. Check the generated PR in the `x-files/app-upgrade-config` branch, verify the diff in `app-upgrade-config.json`, and merge once validated.
|
||||||
|
|
||||||
|
## JSON Configuration File Format
|
||||||
|
|
||||||
|
### File Location
|
||||||
|
|
||||||
|
- **GitHub**: `https://raw.githubusercontent.com/CherryHQ/cherry-studio/refs/heads/x-files/app-upgrade-config/app-upgrade-config.json`
|
||||||
|
- **GitCode**: `https://gitcode.com/CherryHQ/cherry-studio/raw/x-files/app-upgrade-config/app-upgrade-config.json`
|
||||||
|
|
||||||
|
**Note**: Both mirrors provide the same configuration file hosted on the `x-files/app-upgrade-config` branch. The client automatically selects the optimal mirror based on IP geolocation.
|
||||||
|
|
||||||
|
### Configuration Structure (Current Implementation)
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"lastUpdated": "2025-01-05T00:00:00Z",
|
||||||
|
"versions": {
|
||||||
|
"1.6.7": {
|
||||||
|
"minCompatibleVersion": "1.0.0",
|
||||||
|
"description": "Last stable v1.7.x release - required intermediate version for users below v1.7",
|
||||||
|
"channels": {
|
||||||
|
"latest": {
|
||||||
|
"version": "1.6.7",
|
||||||
|
"feedUrls": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/download/v1.6.7",
|
||||||
|
"gitcode": "https://gitcode.com/CherryHQ/cherry-studio/releases/download/v1.6.7"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"rc": {
|
||||||
|
"version": "1.6.0-rc.5",
|
||||||
|
"feedUrls": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/download/v1.6.0-rc.5",
|
||||||
|
"gitcode": "https://github.com/CherryHQ/cherry-studio/releases/download/v1.6.0-rc.5"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"beta": {
|
||||||
|
"version": "1.6.7-beta.3",
|
||||||
|
"feedUrls": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/download/v1.7.0-beta.3",
|
||||||
|
"gitcode": "https://github.com/CherryHQ/cherry-studio/releases/download/v1.7.0-beta.3"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"2.0.0": {
|
||||||
|
"minCompatibleVersion": "1.7.0",
|
||||||
|
"description": "Major release v2.0 - required intermediate version for v2.x upgrades",
|
||||||
|
"channels": {
|
||||||
|
"latest": null,
|
||||||
|
"rc": null,
|
||||||
|
"beta": null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Future Extension Example
|
||||||
|
|
||||||
|
When releasing v3.0, if users need to first upgrade to v2.8, you can add:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"2.8.0": {
|
||||||
|
"minCompatibleVersion": "2.0.0",
|
||||||
|
"description": "Stable v2.8 - required for v3 upgrade",
|
||||||
|
"channels": {
|
||||||
|
"latest": {
|
||||||
|
"version": "2.8.0",
|
||||||
|
"feedUrls": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/download/v2.8.0",
|
||||||
|
"gitcode": "https://gitcode.com/CherryHQ/cherry-studio/releases/download/v2.8.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"rc": null,
|
||||||
|
"beta": null
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"3.0.0": {
|
||||||
|
"minCompatibleVersion": "2.8.0",
|
||||||
|
"description": "Major release v3.0",
|
||||||
|
"channels": {
|
||||||
|
"latest": {
|
||||||
|
"version": "3.0.0",
|
||||||
|
"feedUrls": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/latest",
|
||||||
|
"gitcode": "https://gitcode.com/CherryHQ/cherry-studio/releases/latest"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"rc": {
|
||||||
|
"version": "3.0.0-rc.1",
|
||||||
|
"feedUrls": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/download/v3.0.0-rc.1",
|
||||||
|
"gitcode": "https://gitcode.com/CherryHQ/cherry-studio/releases/download/v3.0.0-rc.1"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"beta": null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Field Descriptions
|
||||||
|
|
||||||
|
- `lastUpdated`: Last update time of the configuration file (ISO 8601 format)
|
||||||
|
- `versions`: Version configuration object, key is the version number, sorted by semantic versioning
|
||||||
|
- `minCompatibleVersion`: Minimum compatible version that can upgrade to this version
|
||||||
|
- `description`: Version description
|
||||||
|
- `channels`: Update channel configuration
|
||||||
|
- `latest`: Stable release channel
|
||||||
|
- `rc`: Release Candidate channel
|
||||||
|
- `beta`: Beta testing channel
|
||||||
|
- Each channel contains:
|
||||||
|
- `version`: Version number for this channel
|
||||||
|
- `feedUrls`: Multi-mirror URL configuration
|
||||||
|
- `github`: electron-updater feed URL for GitHub mirror
|
||||||
|
- `gitcode`: electron-updater feed URL for GitCode mirror
|
||||||
|
- `metadata`: Stable mapping info for automation
|
||||||
|
- `segmentId`: ID from `config/app-upgrade-segments.json`
|
||||||
|
- `segmentType`: Optional flag (`legacy` | `breaking` | `latest`) for documentation/debugging
|
||||||
|
|
||||||
|
## TypeScript Type Definitions
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Mirror enum
|
||||||
|
enum UpdateMirror {
|
||||||
|
GITHUB = 'github',
|
||||||
|
GITCODE = 'gitcode'
|
||||||
|
}
|
||||||
|
|
||||||
|
interface UpdateConfig {
|
||||||
|
lastUpdated: string
|
||||||
|
versions: {
|
||||||
|
[versionKey: string]: VersionConfig
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
interface VersionConfig {
|
||||||
|
minCompatibleVersion: string
|
||||||
|
description: string
|
||||||
|
channels: {
|
||||||
|
latest: ChannelConfig | null
|
||||||
|
rc: ChannelConfig | null
|
||||||
|
beta: ChannelConfig | null
|
||||||
|
}
|
||||||
|
metadata?: {
|
||||||
|
segmentId: string
|
||||||
|
segmentType?: 'legacy' | 'breaking' | 'latest'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ChannelConfig {
|
||||||
|
version: string
|
||||||
|
feedUrls: Record<UpdateMirror, string>
|
||||||
|
// Equivalent to:
|
||||||
|
// feedUrls: {
|
||||||
|
// github: string
|
||||||
|
// gitcode: string
|
||||||
|
// }
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Segment Metadata & Breaking Markers
|
||||||
|
|
||||||
|
- **Segment definitions** now live in `config/app-upgrade-segments.json`. Each segment describes a semantic-version range (or exact matches) plus metadata such as `segmentId`, `segmentType`, `minCompatibleVersion`, and per-channel feed URL templates.
|
||||||
|
- Each entry under `versions` carries a `metadata.segmentId`. This acts as the stable key that scripts use to decide which slot to update, even if the actual semantic version string changes.
|
||||||
|
- Mark major upgrade gateways (e.g., `2.0.0`) by giving the related segment a `segmentType: "breaking"` and (optionally) `lockedVersion`. This prevents automation from accidentally moving that entry when other 2.x builds ship.
|
||||||
|
- Adding another breaking hop (e.g., `3.0.0`) only requires defining a new segment in the JSON file; the automation will pick it up on the next run.
|
||||||
|
|
||||||
|
## Automation Workflow
|
||||||
|
|
||||||
|
Starting from this change, `.github/workflows/update-app-upgrade-config.yml` listens to GitHub release events (published + prerelease). The workflow:
|
||||||
|
|
||||||
|
1. Checks out the default branch (for scripts) and the `x-files/app-upgrade-config` branch (where the config is hosted).
|
||||||
|
2. Runs `yarn tsx scripts/update-app-upgrade-config.ts --tag <tag> --config ../cs/app-upgrade-config.json` to regenerate the config directly inside the `x-files/app-upgrade-config` working tree.
|
||||||
|
3. If the file changed, it opens a PR against `x-files/app-upgrade-config` via `peter-evans/create-pull-request`, with the generated diff limited to `app-upgrade-config.json`.
|
||||||
|
|
||||||
|
You can run the same script locally via `yarn update:upgrade-config --tag v2.1.6 --config ../cs/app-upgrade-config.json` (add `--dry-run` to preview) to reproduce or debug whatever the workflow does. Passing `--skip-release-checks` along with `--dry-run` lets you bypass the release-page existence check (useful when the GitHub/GitCode pages aren’t published yet). Running without `--config` continues to update the copy in your current working directory (main branch) for documentation purposes.
|
||||||
|
|
||||||
|
## Version Matching Logic
|
||||||
|
|
||||||
|
### Algorithm Flow
|
||||||
|
|
||||||
|
1. Get user's current version (`currentVersion`) and requested channel (`requestedChannel`)
|
||||||
|
2. Get all version numbers from configuration file, sort in descending order by semantic versioning
|
||||||
|
3. Iterate through the sorted version list:
|
||||||
|
- Check if `currentVersion >= minCompatibleVersion`
|
||||||
|
- Check if the requested `channel` exists and is not `null`
|
||||||
|
- If conditions are met, return the channel configuration
|
||||||
|
4. If no matching version is found, return `null`
|
||||||
|
|
||||||
|
### Pseudocode Implementation
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
function findCompatibleVersion(
|
||||||
|
currentVersion: string,
|
||||||
|
requestedChannel: UpgradeChannel,
|
||||||
|
config: UpdateConfig
|
||||||
|
): ChannelConfig | null {
|
||||||
|
// Get all version numbers and sort in descending order
|
||||||
|
const versions = Object.keys(config.versions).sort(semver.rcompare)
|
||||||
|
|
||||||
|
for (const versionKey of versions) {
|
||||||
|
const versionConfig = config.versions[versionKey]
|
||||||
|
const channelConfig = versionConfig.channels[requestedChannel]
|
||||||
|
|
||||||
|
// Check version compatibility and channel availability
|
||||||
|
if (
|
||||||
|
semver.gte(currentVersion, versionConfig.minCompatibleVersion) &&
|
||||||
|
channelConfig !== null
|
||||||
|
) {
|
||||||
|
return channelConfig
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return null // No compatible version found
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Upgrade Path Examples
|
||||||
|
|
||||||
|
### Scenario 1: v1.6.5 User Upgrade (Below 1.7)
|
||||||
|
|
||||||
|
- **Current Version**: 1.6.5
|
||||||
|
- **Requested Channel**: latest
|
||||||
|
- **Match Result**: 1.7.0
|
||||||
|
- **Reason**: 1.6.5 >= 0.0.0 (satisfies 1.7.0's minCompatibleVersion), but doesn't satisfy 2.0.0's minCompatibleVersion (1.7.0)
|
||||||
|
- **Action**: Prompt user to upgrade to 1.7.0, which is the required intermediate version for v2.x upgrade
|
||||||
|
|
||||||
|
### Scenario 2: v1.6.5 User Requests rc/beta
|
||||||
|
|
||||||
|
- **Current Version**: 1.6.5
|
||||||
|
- **Requested Channel**: rc or beta
|
||||||
|
- **Match Result**: 1.7.0 (latest)
|
||||||
|
- **Reason**: 1.7.0 version doesn't provide rc/beta channels (values are null)
|
||||||
|
- **Action**: Upgrade to 1.7.0 stable version
|
||||||
|
|
||||||
|
### Scenario 3: v1.7.0 User Upgrades to Latest
|
||||||
|
|
||||||
|
- **Current Version**: 1.7.0
|
||||||
|
- **Requested Channel**: latest
|
||||||
|
- **Match Result**: 2.0.0
|
||||||
|
- **Reason**: 1.7.0 >= 1.7.0 (satisfies 2.0.0's minCompatibleVersion)
|
||||||
|
- **Action**: Directly upgrade to 2.0.0 (current latest stable version)
|
||||||
|
|
||||||
|
### Scenario 4: v1.7.2 User Upgrades to RC Version
|
||||||
|
|
||||||
|
- **Current Version**: 1.7.2
|
||||||
|
- **Requested Channel**: rc
|
||||||
|
- **Match Result**: 2.0.0-rc.1
|
||||||
|
- **Reason**: 1.7.2 >= 1.7.0 (satisfies 2.0.0's minCompatibleVersion), and rc channel exists
|
||||||
|
- **Action**: Upgrade to 2.0.0-rc.1
|
||||||
|
|
||||||
|
### Scenario 5: v1.7.0 User Upgrades to Beta Version
|
||||||
|
|
||||||
|
- **Current Version**: 1.7.0
|
||||||
|
- **Requested Channel**: beta
|
||||||
|
- **Match Result**: 2.0.0-beta.1
|
||||||
|
- **Reason**: 1.7.0 >= 1.7.0, and beta channel exists
|
||||||
|
- **Action**: Upgrade to 2.0.0-beta.1
|
||||||
|
|
||||||
|
### Scenario 6: v2.5.0 User Upgrade (Future)
|
||||||
|
|
||||||
|
Assuming v2.8.0 and v3.0.0 configurations have been added:
|
||||||
|
- **Current Version**: 2.5.0
|
||||||
|
- **Requested Channel**: latest
|
||||||
|
- **Match Result**: 2.8.0
|
||||||
|
- **Reason**: 2.5.0 >= 2.0.0 (satisfies 2.8.0's minCompatibleVersion), but doesn't satisfy 3.0.0's requirement
|
||||||
|
- **Action**: Prompt user to upgrade to 2.8.0, which is the required intermediate version for v3.x upgrade
|
||||||
|
|
||||||
|
## Code Changes
|
||||||
|
|
||||||
|
### Main Modifications
|
||||||
|
|
||||||
|
1. **New Methods**
|
||||||
|
- `_fetchUpdateConfig(ipCountry: string): Promise<UpdateConfig | null>` - Fetch configuration file based on IP
|
||||||
|
- `_findCompatibleChannel(currentVersion: string, channel: UpgradeChannel, config: UpdateConfig): ChannelConfig | null` - Find compatible channel configuration
|
||||||
|
|
||||||
|
2. **Modified Methods**
|
||||||
|
- `_getReleaseVersionFromGithub()` → Remove or refactor to `_getChannelFeedUrl()`
|
||||||
|
- `_setFeedUrl()` - Use new configuration system to replace existing logic
|
||||||
|
|
||||||
|
3. **New Type Definitions**
|
||||||
|
- `UpdateConfig`
|
||||||
|
- `VersionConfig`
|
||||||
|
- `ChannelConfig`
|
||||||
|
|
||||||
|
### Mirror Selection Logic
|
||||||
|
|
||||||
|
The client automatically selects the optimal mirror based on IP geolocation:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
private async _setFeedUrl() {
|
||||||
|
const currentVersion = app.getVersion()
|
||||||
|
const testPlan = configManager.getTestPlan()
|
||||||
|
const requestedChannel = testPlan ? this._getTestChannel() : UpgradeChannel.LATEST
|
||||||
|
|
||||||
|
// Determine mirror based on IP country
|
||||||
|
const ipCountry = await getIpCountry()
|
||||||
|
const mirror = ipCountry.toLowerCase() === 'cn' ? 'gitcode' : 'github'
|
||||||
|
|
||||||
|
// Fetch update config
|
||||||
|
const config = await this._fetchUpdateConfig(mirror)
|
||||||
|
|
||||||
|
if (config) {
|
||||||
|
const channelConfig = this._findCompatibleChannel(currentVersion, requestedChannel, config)
|
||||||
|
if (channelConfig) {
|
||||||
|
// Select feed URL from the corresponding mirror
|
||||||
|
const feedUrl = channelConfig.feedUrls[mirror]
|
||||||
|
this._setChannel(requestedChannel, feedUrl)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fallback logic
|
||||||
|
const defaultFeedUrl = mirror === 'gitcode'
|
||||||
|
? FeedUrl.PRODUCTION
|
||||||
|
: FeedUrl.GITHUB_LATEST
|
||||||
|
this._setChannel(UpgradeChannel.LATEST, defaultFeedUrl)
|
||||||
|
}
|
||||||
|
|
||||||
|
private async _fetchUpdateConfig(mirror: 'github' | 'gitcode'): Promise<UpdateConfig | null> {
|
||||||
|
const configUrl = mirror === 'gitcode'
|
||||||
|
? UpdateConfigUrl.GITCODE
|
||||||
|
: UpdateConfigUrl.GITHUB
|
||||||
|
|
||||||
|
try {
|
||||||
|
const response = await net.fetch(configUrl, {
|
||||||
|
headers: {
|
||||||
|
'User-Agent': generateUserAgent(),
|
||||||
|
'Accept': 'application/json',
|
||||||
|
'X-Client-Id': configManager.getClientId()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
return await response.json() as UpdateConfig
|
||||||
|
} catch (error) {
|
||||||
|
logger.error('Failed to fetch update config:', error)
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Fallback and Error Handling Strategy
|
||||||
|
|
||||||
|
1. **Configuration file fetch failure**: Log error, return current version, don't offer updates
|
||||||
|
2. **No matching version**: Notify user that current version doesn't support automatic upgrade
|
||||||
|
3. **Network exception**: Cache last successfully fetched configuration (optional)
|
||||||
|
|
||||||
|
## GitHub Release Requirements
|
||||||
|
|
||||||
|
To support intermediate version upgrades, the following files need to be retained:
|
||||||
|
|
||||||
|
- **v1.7.0 release** and its latest*.yml files (as upgrade target for users below v1.7)
|
||||||
|
- Future intermediate versions (e.g., v2.8.0) need to retain corresponding release and latest*.yml files
|
||||||
|
- Complete installation packages for each version
|
||||||
|
|
||||||
|
### Currently Required Releases
|
||||||
|
|
||||||
|
| Version | Purpose | Must Retain |
|
||||||
|
|---------|---------|-------------|
|
||||||
|
| v1.7.0 | Upgrade target for users below 1.7 | ✅ Yes |
|
||||||
|
| v2.0.0-rc.1 | RC testing channel | ❌ Optional |
|
||||||
|
| v2.0.0-beta.1 | Beta testing channel | ❌ Optional |
|
||||||
|
| latest | Latest stable version (automatic) | ✅ Yes |
|
||||||
|
|
||||||
|
## Advantages
|
||||||
|
|
||||||
|
1. **Flexibility**: Supports arbitrarily complex upgrade paths
|
||||||
|
2. **Extensibility**: Adding new versions only requires adding new entries to the configuration file
|
||||||
|
3. **Maintainability**: Configuration is separated from code, allowing upgrade strategy adjustments without releasing new versions
|
||||||
|
4. **Multi-source support**: Automatically selects optimal configuration source based on geolocation
|
||||||
|
5. **Version control**: Enforces intermediate version upgrades, ensuring data migration and compatibility
|
||||||
|
|
||||||
|
## Future Extensions
|
||||||
|
|
||||||
|
- Support more granular version range control (e.g., `>=1.5.0 <1.8.0`)
|
||||||
|
- Support multi-step upgrade path hints (e.g., notify user needs 1.5 → 1.8 → 2.0)
|
||||||
|
- Support A/B testing and gradual rollout
|
||||||
|
- Support local caching and expiration strategy for configuration files
|
||||||
@@ -85,7 +85,7 @@ Main responsibilities:
|
|||||||
- **SvgPreview**: SVG image preview
|
- **SvgPreview**: SVG image preview
|
||||||
- **GraphvizPreview**: Graphviz diagram preview
|
- **GraphvizPreview**: Graphviz diagram preview
|
||||||
|
|
||||||
All special view components share a common architecture for consistent user experience and functionality. For detailed information about these components and their implementation, see [Image Preview Components Documentation](./ImagePreview-en.md).
|
All special view components share a common architecture for consistent user experience and functionality. For detailed information about these components and their implementation, see [Image Preview Components Documentation](./image-preview.md).
|
||||||
|
|
||||||
#### StatusBar
|
#### StatusBar
|
||||||
|
|
||||||
@@ -192,4 +192,4 @@ Image Preview Components integrate seamlessly with CodeBlockView:
|
|||||||
- Shared state management
|
- Shared state management
|
||||||
- Responsive layout adaptation
|
- Responsive layout adaptation
|
||||||
|
|
||||||
For more information about the overall CodeBlockView architecture, see [CodeBlockView Documentation](./CodeBlockView-en.md).
|
For more information about the overall CodeBlockView architecture, see [CodeBlockView Documentation](./code-block-view.md).
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
# 消息的生命周期
|
|
||||||
|
|
||||||

|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# 数据库设置字段
|
|
||||||
|
|
||||||
此文档包含部分字段的数据类型说明。
|
|
||||||
|
|
||||||
## 字段
|
|
||||||
|
|
||||||
| 字段名 | 类型 | 说明 |
|
|
||||||
| ------------------------------ | ------------------------------ | ------------ |
|
|
||||||
| `translate:target:language` | `LanguageCode` | 翻译目标语言 |
|
|
||||||
| `translate:source:language` | `LanguageCode` | 翻译源语言 |
|
|
||||||
| `translate:bidirectional:pair` | `[LanguageCode, LanguageCode]` | 双向翻译对 |
|
|
||||||
@@ -1,127 +0,0 @@
|
|||||||
# messageBlock.ts 使用指南
|
|
||||||
|
|
||||||
该文件定义了用于管理应用程序中所有 `MessageBlock` 实体的 Redux Slice。它使用 Redux Toolkit 的 `createSlice` 和 `createEntityAdapter` 来高效地处理规范化的状态,并提供了一系列 actions 和 selectors 用于与消息块数据交互。
|
|
||||||
|
|
||||||
## 核心目标
|
|
||||||
|
|
||||||
- **状态管理**: 集中管理所有 `MessageBlock` 的状态。`MessageBlock` 代表消息中的不同内容单元(如文本、代码、图片、引用等)。
|
|
||||||
- **规范化**: 使用 `createEntityAdapter` 将 `MessageBlock` 数据存储在规范化的结构中(`{ ids: [], entities: {} }`),这有助于提高性能和简化更新逻辑。
|
|
||||||
- **可预测性**: 提供明确的 actions 来修改状态,并通过 selectors 安全地访问状态。
|
|
||||||
|
|
||||||
## 关键概念
|
|
||||||
|
|
||||||
- **Slice (`createSlice`)**: Redux Toolkit 的核心 API,用于创建包含 reducer 逻辑、action creators 和初始状态的 Redux 模块。
|
|
||||||
- **Entity Adapter (`createEntityAdapter`)**: Redux Toolkit 提供的工具,用于简化对规范化数据的 CRUD(创建、读取、更新、删除)操作。它会自动生成 reducer 函数和 selectors。
|
|
||||||
- **Selectors**: 用于从 Redux store 中派生和计算数据的函数。Selectors 可以被记忆化(memoized),以提高性能。
|
|
||||||
|
|
||||||
## State 结构
|
|
||||||
|
|
||||||
`messageBlocks` slice 的状态结构由 `createEntityAdapter` 定义,大致如下:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
{
|
|
||||||
ids: string[]; // 存储所有 MessageBlock ID 的有序列表
|
|
||||||
entities: { [id: string]: MessageBlock }; // 按 ID 存储 MessageBlock 对象的字典
|
|
||||||
loadingState: 'idle' | 'loading' | 'succeeded' | 'failed'; // (可选) 其他状态,如加载状态
|
|
||||||
error: string | null; // (可选) 错误信息
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Actions
|
|
||||||
|
|
||||||
该 slice 导出以下 actions (由 `createSlice` 和 `createEntityAdapter` 自动生成或自定义):
|
|
||||||
|
|
||||||
- **`upsertOneBlock(payload: MessageBlock)`**:
|
|
||||||
|
|
||||||
- 添加一个新的 `MessageBlock` 或更新一个已存在的 `MessageBlock`。如果 payload 中的 `id` 已存在,则执行更新;否则执行插入。
|
|
||||||
|
|
||||||
- **`upsertManyBlocks(payload: MessageBlock[])`**:
|
|
||||||
|
|
||||||
- 添加或更新多个 `MessageBlock`。常用于批量加载数据(例如,加载一个 Topic 的所有消息块)。
|
|
||||||
|
|
||||||
- **`removeOneBlock(payload: string)`**:
|
|
||||||
|
|
||||||
- 根据提供的 `id` (payload) 移除单个 `MessageBlock`。
|
|
||||||
|
|
||||||
- **`removeManyBlocks(payload: string[])`**:
|
|
||||||
|
|
||||||
- 根据提供的 `id` 数组 (payload) 移除多个 `MessageBlock`。常用于删除消息或清空 Topic 时清理相关的块。
|
|
||||||
|
|
||||||
- **`removeAllBlocks()`**:
|
|
||||||
|
|
||||||
- 移除 state 中的所有 `MessageBlock` 实体。
|
|
||||||
|
|
||||||
- **`updateOneBlock(payload: { id: string; changes: Partial<MessageBlock> })`**:
|
|
||||||
|
|
||||||
- 更新一个已存在的 `MessageBlock`。`payload` 需要包含块的 `id` 和一个包含要更改的字段的 `changes` 对象。
|
|
||||||
|
|
||||||
- **`setMessageBlocksLoading(payload: 'idle' | 'loading')`**:
|
|
||||||
|
|
||||||
- (自定义) 设置 `loadingState` 属性。
|
|
||||||
|
|
||||||
- **`setMessageBlocksError(payload: string)`**:
|
|
||||||
- (自定义) 设置 `loadingState` 为 `'failed'` 并记录错误信息。
|
|
||||||
|
|
||||||
**使用示例 (在 Thunk 或其他 Dispatch 的地方):**
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { upsertOneBlock, removeManyBlocks, updateOneBlock } from './messageBlock'
|
|
||||||
import store from './store' // 假设这是你的 Redux store 实例
|
|
||||||
|
|
||||||
// 添加或更新一个块
|
|
||||||
const newBlock: MessageBlock = {
|
|
||||||
/* ... block data ... */
|
|
||||||
}
|
|
||||||
store.dispatch(upsertOneBlock(newBlock))
|
|
||||||
|
|
||||||
// 更新一个块的内容
|
|
||||||
store.dispatch(updateOneBlock({ id: blockId, changes: { content: 'New content' } }))
|
|
||||||
|
|
||||||
// 删除多个块
|
|
||||||
const blockIdsToRemove = ['id1', 'id2']
|
|
||||||
store.dispatch(removeManyBlocks(blockIdsToRemove))
|
|
||||||
```
|
|
||||||
|
|
||||||
## Selectors
|
|
||||||
|
|
||||||
该 slice 导出由 `createEntityAdapter` 生成的基础 selectors,并通过 `messageBlocksSelectors` 对象访问:
|
|
||||||
|
|
||||||
- **`messageBlocksSelectors.selectIds(state: RootState): string[]`**: 返回包含所有块 ID 的数组。
|
|
||||||
- **`messageBlocksSelectors.selectEntities(state: RootState): { [id: string]: MessageBlock }`**: 返回块 ID 到块对象的映射字典。
|
|
||||||
- **`messageBlocksSelectors.selectAll(state: RootState): MessageBlock[]`**: 返回包含所有块对象的数组。
|
|
||||||
- **`messageBlocksSelectors.selectTotal(state: RootState): number`**: 返回块的总数。
|
|
||||||
- **`messageBlocksSelectors.selectById(state: RootState, id: string): MessageBlock | undefined`**: 根据 ID 返回单个块对象,如果找不到则返回 `undefined`。
|
|
||||||
|
|
||||||
**此外,还提供了一个自定义的、记忆化的 selector:**
|
|
||||||
|
|
||||||
- **`selectFormattedCitationsByBlockId(state: RootState, blockId: string | undefined): Citation[]`**:
|
|
||||||
- 接收一个 `blockId`。
|
|
||||||
- 如果该 ID 对应的块是 `CITATION` 类型,则提取并格式化其包含的引用信息(来自网页搜索、知识库等),进行去重和重新编号,最后返回一个 `Citation[]` 数组,用于在 UI 中显示。
|
|
||||||
- 如果块不存在或类型不匹配,返回空数组 `[]`。
|
|
||||||
- 这个 selector 封装了处理不同引用来源(Gemini, OpenAI, OpenRouter, Zhipu 等)的复杂逻辑。
|
|
||||||
|
|
||||||
**使用示例 (在 React 组件或 `useSelector` 中):**
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { useSelector } from 'react-redux'
|
|
||||||
import { messageBlocksSelectors, selectFormattedCitationsByBlockId } from './messageBlock'
|
|
||||||
import type { RootState } from './store'
|
|
||||||
|
|
||||||
// 获取所有块
|
|
||||||
const allBlocks = useSelector(messageBlocksSelectors.selectAll)
|
|
||||||
|
|
||||||
// 获取特定 ID 的块
|
|
||||||
const specificBlock = useSelector((state: RootState) => messageBlocksSelectors.selectById(state, someBlockId))
|
|
||||||
|
|
||||||
// 获取特定引用块格式化后的引用列表
|
|
||||||
const formattedCitations = useSelector((state: RootState) => selectFormattedCitationsByBlockId(state, citationBlockId))
|
|
||||||
|
|
||||||
// 在组件中使用引用数据
|
|
||||||
// {formattedCitations.map(citation => ...)}
|
|
||||||
```
|
|
||||||
|
|
||||||
## 集成
|
|
||||||
|
|
||||||
`messageBlock.ts` slice 通常与 `messageThunk.ts` 中的 Thunks 紧密协作。Thunks 负责处理异步逻辑(如 API 调用、数据库操作),并在需要时 dispatch `messageBlock` slice 的 actions 来更新状态。例如,当 `messageThunk` 接收到流式响应时,它会 dispatch `upsertOneBlock` 或 `updateOneBlock` 来实时更新对应的 `MessageBlock`。同样,删除消息的 Thunk 会 dispatch `removeManyBlocks`。
|
|
||||||
|
|
||||||
理解 `messageBlock.ts` 的职责是管理**状态本身**,而 `messageThunk.ts` 负责**触发状态变更**的异步流程,这对于维护清晰的应用架构至关重要。
|
|
||||||
@@ -1,105 +0,0 @@
|
|||||||
# messageThunk.ts 使用指南
|
|
||||||
|
|
||||||
该文件包含用于管理应用程序中消息流、处理助手交互以及同步 Redux 状态与 IndexedDB 数据库的核心 Thunk Action Creators。主要围绕 `Message` 和 `MessageBlock` 对象进行操作。
|
|
||||||
|
|
||||||
## 核心功能
|
|
||||||
|
|
||||||
1. **发送/接收消息**: 处理用户消息的发送,触发助手响应,并流式处理返回的数据,将其解析为不同的 `MessageBlock`。
|
|
||||||
2. **状态管理**: 确保 Redux store 中的消息和消息块状态与 IndexedDB 中的持久化数据保持一致。
|
|
||||||
3. **消息操作**: 提供删除、重发、重新生成、编辑后重发、追加响应、克隆等消息生命周期管理功能。
|
|
||||||
4. **Block 处理**: 动态创建、更新和保存各种类型的 `MessageBlock`(文本、思考过程、工具调用、引用、图片、错误、翻译等)。
|
|
||||||
|
|
||||||
## 主要 Thunks
|
|
||||||
|
|
||||||
以下是一些关键的 Thunk 函数及其用途:
|
|
||||||
|
|
||||||
1. **`sendMessage(userMessage, userMessageBlocks, assistant, topicId)`**
|
|
||||||
|
|
||||||
- **用途**: 发送一条新的用户消息。
|
|
||||||
- **流程**:
|
|
||||||
- 保存用户消息 (`userMessage`) 及其块 (`userMessageBlocks`) 到 Redux 和 DB。
|
|
||||||
- 检查 `@mentions` 以确定是单模型响应还是多模型响应。
|
|
||||||
- 创建助手消息(们)的存根 (Stub)。
|
|
||||||
- 将存根添加到 Redux 和 DB。
|
|
||||||
- 将核心处理逻辑 `fetchAndProcessAssistantResponseImpl` 添加到该 `topicId` 的队列中以获取实际响应。
|
|
||||||
- **Block 相关**: 主要处理用户消息的初始 `MessageBlock` 保存。
|
|
||||||
|
|
||||||
2. **`fetchAndProcessAssistantResponseImpl(dispatch, getState, topicId, assistant, assistantMessage)`**
|
|
||||||
|
|
||||||
- **用途**: (内部函数) 获取并处理单个助手响应的核心逻辑,被 `sendMessage`, `resend...`, `regenerate...`, `append...` 等调用。
|
|
||||||
- **流程**:
|
|
||||||
- 设置 Topic 加载状态。
|
|
||||||
- 准备上下文消息。
|
|
||||||
- 调用 `fetchChatCompletion` API 服务。
|
|
||||||
- 使用 `createStreamProcessor` 处理流式响应。
|
|
||||||
- 通过各种回调 (`onTextChunk`, `onThinkingChunk`, `onToolCallComplete`, `onImageGenerated`, `onError`, `onComplete` 等) 处理不同类型的事件。
|
|
||||||
- **Block 相关**:
|
|
||||||
- 根据流事件创建初始 `UNKNOWN` 块。
|
|
||||||
- 实时创建和更新 `MAIN_TEXT` 和 `THINKING` 块,使用 `throttledBlockUpdate` 和 `throttledBlockDbUpdate` 进行节流更新。
|
|
||||||
- 创建 `TOOL`, `CITATION`, `IMAGE`, `ERROR` 等类型的块。
|
|
||||||
- 在事件完成时(如 `onTextComplete`, `onToolCallComplete`)将块状态标记为 `SUCCESS` 或 `ERROR`,并使用 `saveUpdatedBlockToDB` 保存最终状态。
|
|
||||||
- 使用 `handleBlockTransition` 管理非流式块(如 `TOOL`, `CITATION`)的添加和状态更新。
|
|
||||||
|
|
||||||
3. **`loadTopicMessagesThunk(topicId, forceReload)`**
|
|
||||||
|
|
||||||
- **用途**: 从数据库加载指定主题的所有消息及其关联的 `MessageBlock`。
|
|
||||||
- **流程**:
|
|
||||||
- 从 DB 获取 `Topic` 及其 `messages` 列表。
|
|
||||||
- 根据消息 ID 列表从 DB 获取所有相关的 `MessageBlock`。
|
|
||||||
- 使用 `upsertManyBlocks` 将块更新到 Redux。
|
|
||||||
- 将消息更新到 Redux。
|
|
||||||
- **Block 相关**: 负责将持久化的 `MessageBlock` 加载到 Redux 状态。
|
|
||||||
|
|
||||||
4. **删除 Thunks**
|
|
||||||
|
|
||||||
- `deleteSingleMessageThunk(topicId, messageId)`: 删除单个消息及其所有 `MessageBlock`。
|
|
||||||
- `deleteMessageGroupThunk(topicId, askId)`: 删除一个用户消息及其所有相关的助手响应消息和它们的所有 `MessageBlock`。
|
|
||||||
- `clearTopicMessagesThunk(topicId)`: 清空主题下的所有消息及其所有 `MessageBlock`。
|
|
||||||
- **Block 相关**: 从 Redux 和 DB 中移除指定的 `MessageBlock`。
|
|
||||||
|
|
||||||
5. **重发/重新生成 Thunks**
|
|
||||||
|
|
||||||
- `resendMessageThunk(topicId, userMessageToResend, assistant)`: 重发用户消息。会重置(清空 Block 并标记为 PENDING)所有与该用户消息关联的助手响应,然后重新请求生成。
|
|
||||||
- `resendUserMessageWithEditThunk(topicId, originalMessage, mainTextBlockId, editedContent, assistant)`: 用户编辑消息内容后重发。先更新用户消息的 `MAIN_TEXT` 块内容,然后调用 `resendMessageThunk`。
|
|
||||||
- `regenerateAssistantResponseThunk(topicId, assistantMessageToRegenerate, assistant)`: 重新生成单个助手响应。重置该助手消息(清空 Block 并标记为 PENDING),然后重新请求生成。
|
|
||||||
- **Block 相关**: 删除旧的 `MessageBlock`,并在重新生成过程中创建新的 `MessageBlock`。
|
|
||||||
|
|
||||||
6. **`appendAssistantResponseThunk(topicId, existingAssistantMessageId, newModel, assistant)`**
|
|
||||||
|
|
||||||
- **用途**: 在已有的对话上下文中,针对同一个用户问题,使用新选择的模型追加一个新的助手响应。
|
|
||||||
- **流程**:
|
|
||||||
- 找到现有助手消息以获取原始 `askId`。
|
|
||||||
- 创建使用 `newModel` 的新助手消息存根(使用相同的 `askId`)。
|
|
||||||
- 添加新存根到 Redux 和 DB。
|
|
||||||
- 将 `fetchAndProcessAssistantResponseImpl` 添加到队列以生成新响应。
|
|
||||||
- **Block 相关**: 为新的助手响应创建全新的 `MessageBlock`。
|
|
||||||
|
|
||||||
7. **`cloneMessagesToNewTopicThunk(sourceTopicId, branchPointIndex, newTopic)`**
|
|
||||||
|
|
||||||
- **用途**: 将源主题的部分消息(及其 Block)克隆到一个**已存在**的新主题中。
|
|
||||||
- **流程**:
|
|
||||||
- 复制指定索引前的消息。
|
|
||||||
- 为所有克隆的消息和 Block 生成新的 UUID。
|
|
||||||
- 正确映射克隆消息之间的 `askId` 关系。
|
|
||||||
- 复制 `MessageBlock` 内容,更新其 `messageId` 指向新的消息 ID。
|
|
||||||
- 更新文件引用计数(如果 Block 是文件或图片)。
|
|
||||||
- 将克隆的消息和 Block 保存到新主题的 Redux 状态和 DB 中。
|
|
||||||
- **Block 相关**: 创建 `MessageBlock` 的副本,并更新其 ID 和 `messageId`。
|
|
||||||
|
|
||||||
8. **`initiateTranslationThunk(messageId, topicId, targetLanguage, sourceBlockId?, sourceLanguage?)`**
|
|
||||||
- **用途**: 为指定消息启动翻译流程,创建一个初始的 `TRANSLATION` 类型的 `MessageBlock`。
|
|
||||||
- **流程**:
|
|
||||||
- 创建一个状态为 `STREAMING` 的 `TranslationMessageBlock`。
|
|
||||||
- 将其添加到 Redux 和 DB。
|
|
||||||
- 更新原消息的 `blocks` 列表以包含新的翻译块 ID。
|
|
||||||
- **Block 相关**: 创建并保存一个占位的 `TranslationMessageBlock`。实际翻译内容的获取和填充需要后续步骤。
|
|
||||||
|
|
||||||
## 内部机制和注意事项
|
|
||||||
|
|
||||||
- **数据库交互**: 通过 `saveMessageAndBlocksToDB`, `updateExistingMessageAndBlocksInDB`, `saveUpdatesToDB`, `saveUpdatedBlockToDB`, `throttledBlockDbUpdate` 等辅助函数与 IndexedDB (`db`) 交互,确保数据持久化。
|
|
||||||
- **状态同步**: Thunks 负责协调 Redux Store 和 IndexedDB 之间的数据一致性。
|
|
||||||
- **队列 (`getTopicQueue`)**: 使用 `AsyncQueue` 确保对同一主题的操作(尤其是 API 请求)按顺序执行,避免竞态条件。
|
|
||||||
- **节流 (`throttle`)**: 对流式响应中频繁的 Block 更新(文本、思考)使用 `lodash.throttle` 优化性能,减少 Redux dispatch 和 DB 写入次数。
|
|
||||||
- **错误处理**: `fetchAndProcessAssistantResponseImpl` 内的回调函数(特别是 `onError`)处理流处理和 API 调用中可能出现的错误,并创建 `ERROR` 类型的 `MessageBlock`。
|
|
||||||
|
|
||||||
开发者在使用这些 Thunks 时,通常需要提供 `dispatch`, `getState` (由 Redux Thunk 中间件注入),以及如 `topicId`, `assistant` 配置对象, 相关的 `Message` 或 `MessageBlock` 对象/ID 等参数。理解每个 Thunk 的职责和它如何影响消息及块的状态至关重要。
|
|
||||||
@@ -1,156 +0,0 @@
|
|||||||
# useMessageOperations.ts 使用指南
|
|
||||||
|
|
||||||
该文件定义了一个名为 `useMessageOperations` 的自定义 React Hook。这个 Hook 的主要目的是为 React 组件提供一个便捷的接口,用于执行与特定主题(Topic)相关的各种消息操作。它封装了调用 Redux Thunks (`messageThunk.ts`) 和 Actions (`newMessage.ts`, `messageBlock.ts`) 的逻辑,简化了组件与消息数据交互的代码。
|
|
||||||
|
|
||||||
## 核心目标
|
|
||||||
|
|
||||||
- **封装**: 将复杂的消息操作逻辑(如删除、重发、重新生成、编辑、翻译等)封装在易于使用的函数中。
|
|
||||||
- **简化**: 让组件可以直接调用这些操作函数,而无需直接与 Redux `dispatch` 或 Thunks 交互。
|
|
||||||
- **上下文关联**: 所有操作都与传入的 `topic` 对象相关联,确保操作作用于正确的主题。
|
|
||||||
|
|
||||||
## 如何使用
|
|
||||||
|
|
||||||
在你的 React 函数组件中,导入并调用 `useMessageOperations` Hook,并传入当前活动的 `Topic` 对象。
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import React from 'react';
|
|
||||||
import { useMessageOperations } from '@renderer/hooks/useMessageOperations';
|
|
||||||
import type { Topic, Message, Assistant, Model } from '@renderer/types';
|
|
||||||
|
|
||||||
interface MyComponentProps {
|
|
||||||
currentTopic: Topic;
|
|
||||||
currentAssistant: Assistant;
|
|
||||||
}
|
|
||||||
|
|
||||||
function MyComponent({ currentTopic, currentAssistant }: MyComponentProps) {
|
|
||||||
const {
|
|
||||||
deleteMessage,
|
|
||||||
resendMessage,
|
|
||||||
regenerateAssistantMessage,
|
|
||||||
appendAssistantResponse,
|
|
||||||
getTranslationUpdater,
|
|
||||||
createTopicBranch,
|
|
||||||
// ... 其他操作函数
|
|
||||||
} = useMessageOperations(currentTopic);
|
|
||||||
|
|
||||||
const handleDelete = (messageId: string) => {
|
|
||||||
deleteMessage(messageId);
|
|
||||||
};
|
|
||||||
|
|
||||||
const handleResend = (message: Message) => {
|
|
||||||
resendMessage(message, currentAssistant);
|
|
||||||
};
|
|
||||||
|
|
||||||
const handleAppend = (existingMsg: Message, newModel: Model) => {
|
|
||||||
appendAssistantResponse(existingMsg, newModel, currentAssistant);
|
|
||||||
}
|
|
||||||
|
|
||||||
// ... 在组件中使用其他操作函数
|
|
||||||
|
|
||||||
return (
|
|
||||||
<div>
|
|
||||||
{/* Component UI */}
|
|
||||||
<button onClick={() => handleDelete('some-message-id')}>Delete Message</button>
|
|
||||||
{/* ... */}
|
|
||||||
</div>
|
|
||||||
);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## 返回值
|
|
||||||
|
|
||||||
`useMessageOperations(topic)` Hook 返回一个包含以下函数和值的对象:
|
|
||||||
|
|
||||||
- **`deleteMessage(id: string)`**:
|
|
||||||
|
|
||||||
- 删除指定 `id` 的单个消息。
|
|
||||||
- 内部调用 `deleteSingleMessageThunk`。
|
|
||||||
|
|
||||||
- **`deleteGroupMessages(askId: string)`**:
|
|
||||||
|
|
||||||
- 删除与指定 `askId` 相关联的一组消息(通常是用户提问及其所有助手回答)。
|
|
||||||
- 内部调用 `deleteMessageGroupThunk`。
|
|
||||||
|
|
||||||
- **`editMessage(messageId: string, updates: Partial<Message>)`**:
|
|
||||||
|
|
||||||
- 更新指定 `messageId` 的消息的部分属性。
|
|
||||||
- **注意**: 目前主要用于更新 Redux 状态
|
|
||||||
- 内部调用 `newMessagesActions.updateMessage`。
|
|
||||||
|
|
||||||
- **`resendMessage(message: Message, assistant: Assistant)`**:
|
|
||||||
|
|
||||||
- 重新发送指定的用户消息 (`message`),这将触发其所有关联助手响应的重新生成。
|
|
||||||
- 内部调用 `resendMessageThunk`。
|
|
||||||
|
|
||||||
- **`resendUserMessageWithEdit(message: Message, editedContent: string, assistant: Assistant)`**:
|
|
||||||
|
|
||||||
- 在用户消息的主要文本块被编辑后,重新发送该消息。
|
|
||||||
- 会先查找消息的 `MAIN_TEXT` 块 ID,然后调用 `resendUserMessageWithEditThunk`。
|
|
||||||
|
|
||||||
- **`clearTopicMessages(_topicId?: string)`**:
|
|
||||||
|
|
||||||
- 清除当前主题(或可选的指定 `_topicId`)下的所有消息。
|
|
||||||
- 内部调用 `clearTopicMessagesThunk`。
|
|
||||||
|
|
||||||
- **`createNewContext()`**:
|
|
||||||
|
|
||||||
- 发出一个全局事件 (`EVENT_NAMES.NEW_CONTEXT`),通常用于通知 UI 清空显示,准备新的上下文。不直接修改 Redux 状态。
|
|
||||||
|
|
||||||
- **`displayCount`**:
|
|
||||||
|
|
||||||
- (非操作函数) 从 Redux store 中获取当前的 `displayCount` 值。
|
|
||||||
|
|
||||||
- **`pauseMessages()`**:
|
|
||||||
|
|
||||||
- 尝试中止当前主题中正在进行的消息生成(状态为 `processing` 或 `pending`)。
|
|
||||||
- 通过查找相关的 `askId` 并调用 `abortCompletion` 来实现。
|
|
||||||
- 同时会 dispatch `setTopicLoading` action 将加载状态设为 `false`。
|
|
||||||
|
|
||||||
- **`resumeMessage(message: Message, assistant: Assistant)`**:
|
|
||||||
|
|
||||||
- 恢复/重新发送一个用户消息。目前实现为直接调用 `resendMessage`。
|
|
||||||
|
|
||||||
- **`regenerateAssistantMessage(message: Message, assistant: Assistant)`**:
|
|
||||||
|
|
||||||
- 重新生成指定的**助手**消息 (`message`) 的响应。
|
|
||||||
- 内部调用 `regenerateAssistantResponseThunk`。
|
|
||||||
|
|
||||||
- **`appendAssistantResponse(existingAssistantMessage: Message, newModel: Model, assistant: Assistant)`**:
|
|
||||||
|
|
||||||
- 针对 `existingAssistantMessage` 所回复的**同一用户提问**,使用 `newModel` 追加一个新的助手响应。
|
|
||||||
- 内部调用 `appendAssistantResponseThunk`。
|
|
||||||
|
|
||||||
- **`getTranslationUpdater(messageId: string, targetLanguage: string, sourceBlockId?: string, sourceLanguage?: string)`**:
|
|
||||||
|
|
||||||
- **用途**: 获取一个用于逐步更新翻译块内容的函数。
|
|
||||||
- **流程**:
|
|
||||||
1. 内部调用 `initiateTranslationThunk` 来创建或获取一个 `TRANSLATION` 类型的 `MessageBlock`,并获取其 `blockId`。
|
|
||||||
2. 返回一个**异步更新函数**。
|
|
||||||
- **返回的更新函数 `(accumulatedText: string, isComplete?: boolean) => void`**:
|
|
||||||
- 接收累积的翻译文本和完成状态。
|
|
||||||
- 调用 `updateOneBlock` 更新 Redux 中的翻译块内容和状态 (`STREAMING` 或 `SUCCESS`)。
|
|
||||||
- 调用 `throttledBlockDbUpdate` 将更新(节流地)保存到数据库。
|
|
||||||
- 如果初始化失败(Thunk 返回 `undefined`),则此函数返回 `null`。
|
|
||||||
|
|
||||||
- **`createTopicBranch(sourceTopicId: string, branchPointIndex: number, newTopic: Topic)`**:
|
|
||||||
- 创建一个主题分支,将 `sourceTopicId` 主题中 `branchPointIndex` 索引之前的消息克隆到 `newTopic` 中。
|
|
||||||
- **注意**: `newTopic` 对象必须是调用此函数**之前**已经创建并添加到 Redux 和数据库中的。
|
|
||||||
- 内部调用 `cloneMessagesToNewTopicThunk`。
|
|
||||||
|
|
||||||
## 依赖
|
|
||||||
|
|
||||||
- **`topic: Topic`**: 必须传入当前操作上下文的主题对象。Hook 返回的操作函数将始终作用于这个主题的 `topic.id`。
|
|
||||||
- **Redux `dispatch`**: Hook 内部使用 `useAppDispatch` 获取 `dispatch` 函数来调用 actions 和 thunks。
|
|
||||||
|
|
||||||
## 相关 Hooks
|
|
||||||
|
|
||||||
在同一文件中还定义了两个辅助 Hook:
|
|
||||||
|
|
||||||
- **`useTopicMessages(topic: Topic)`**:
|
|
||||||
|
|
||||||
- 使用 `selectMessagesForTopic` selector 来获取并返回指定主题的消息列表。
|
|
||||||
|
|
||||||
- **`useTopicLoading(topic: Topic)`**:
|
|
||||||
- 使用 `selectNewTopicLoading` selector 来获取并返回指定主题的加载状态。
|
|
||||||
|
|
||||||
这些 Hook 可以与 `useMessageOperations` 结合使用,方便地在组件中获取消息数据、加载状态,并执行相关操作。
|
|
||||||
@@ -70,7 +70,7 @@ Cherry Studio 是一款支持多个大语言模型(LLM)服务商的桌面客
|
|||||||
|
|
||||||
👏 欢迎加入 [Telegram 群组](https://t.me/CherryStudioAI)|[Discord](https://discord.gg/wez8HtpxqQ) | [QQ群(575014769)](https://qm.qq.com/q/lo0D4qVZKi)
|
👏 欢迎加入 [Telegram 群组](https://t.me/CherryStudioAI)|[Discord](https://discord.gg/wez8HtpxqQ) | [QQ群(575014769)](https://qm.qq.com/q/lo0D4qVZKi)
|
||||||
|
|
||||||
❤️ 喜欢 Cherry Studio? 点亮小星星 🌟 或 [赞助开发者](sponsor.md)! ❤️
|
❤️ 喜欢 Cherry Studio? 点亮小星星 🌟 或 [赞助开发者](./guides/sponsor.md)! ❤️
|
||||||
|
|
||||||
# 📖 使用教程
|
# 📖 使用教程
|
||||||
|
|
||||||
@@ -181,7 +181,7 @@ https://docs.cherry-ai.com
|
|||||||
6. **社区参与**:加入讨论并帮助用户
|
6. **社区参与**:加入讨论并帮助用户
|
||||||
7. **推广使用**:宣传 Cherry Studio
|
7. **推广使用**:宣传 Cherry Studio
|
||||||
|
|
||||||
参考[分支策略](branching-strategy-zh.md)了解贡献指南
|
参考[分支策略](./guides/branching-strategy.md)了解贡献指南
|
||||||
|
|
||||||
## 入门
|
## 入门
|
||||||
|
|
||||||
@@ -190,7 +190,7 @@ https://docs.cherry-ai.com
|
|||||||
3. **提交更改**:提交并推送您的更改
|
3. **提交更改**:提交并推送您的更改
|
||||||
4. **打开 Pull Request**:描述您的更改和原因
|
4. **打开 Pull Request**:描述您的更改和原因
|
||||||
|
|
||||||
有关更详细的指南,请参阅我们的 [贡献指南](CONTRIBUTING.zh.md)
|
有关更详细的指南,请参阅我们的 [贡献指南](./guides/contributing.md)
|
||||||
|
|
||||||
感谢您的支持和贡献!
|
感谢您的支持和贡献!
|
||||||
|
|
||||||
@@ -16,7 +16,7 @@ Cherry Studio 采用结构化的分支策略来维护代码质量并简化开发
|
|||||||
- 只接受文档更新和 bug 修复
|
- 只接受文档更新和 bug 修复
|
||||||
- 经过完整测试后可以发布到生产环境
|
- 经过完整测试后可以发布到生产环境
|
||||||
|
|
||||||
关于测试计划所使用的`testplan`分支,请查阅[测试计划](testplan-zh.md)。
|
关于测试计划所使用的`testplan`分支,请查阅[测试计划](./test-plan.md)。
|
||||||
|
|
||||||
## 贡献分支
|
## 贡献分支
|
||||||
|
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# Cherry Studio 贡献者指南
|
# Cherry Studio 贡献者指南
|
||||||
|
|
||||||
[**English**](../CONTRIBUTING.md) | [**中文**](CONTRIBUTING.zh.md)
|
[**English**](../../../CONTRIBUTING.md) | **中文**
|
||||||
|
|
||||||
欢迎来到 Cherry Studio 的贡献者社区!我们致力于将 Cherry Studio 打造成一个长期提供价值的项目,并希望邀请更多的开发者加入我们的行列。无论您是经验丰富的开发者还是刚刚起步的初学者,您的贡献都将帮助我们更好地服务用户,提升软件质量。
|
欢迎来到 Cherry Studio 的贡献者社区!我们致力于将 Cherry Studio 打造成一个长期提供价值的项目,并希望邀请更多的开发者加入我们的行列。无论您是经验丰富的开发者还是刚刚起步的初学者,您的贡献都将帮助我们更好地服务用户,提升软件质量。
|
||||||
|
|
||||||
@@ -24,7 +24,7 @@
|
|||||||
|
|
||||||
## 开始之前
|
## 开始之前
|
||||||
|
|
||||||
请确保阅读了[行为准则](../CODE_OF_CONDUCT.md)和[LICENSE](../LICENSE)。
|
请确保阅读了[行为准则](../../../CODE_OF_CONDUCT.md)和[LICENSE](../../../LICENSE)。
|
||||||
|
|
||||||
## 开始贡献
|
## 开始贡献
|
||||||
|
|
||||||
@@ -32,7 +32,7 @@
|
|||||||
|
|
||||||
### 测试
|
### 测试
|
||||||
|
|
||||||
未经测试的功能等同于不存在。为确保代码真正有效,应通过单元测试和功能测试覆盖相关流程。因此,在考虑贡献时,也请考虑可测试性。所有测试均可本地运行,无需依赖 CI。请参阅[开发者指南](dev.md#test)中的“Test”部分。
|
未经测试的功能等同于不存在。为确保代码真正有效,应通过单元测试和功能测试覆盖相关流程。因此,在考虑贡献时,也请考虑可测试性。所有测试均可本地运行,无需依赖 CI。请参阅[开发者指南](./development.md#test)中的"Test"部分。
|
||||||
|
|
||||||
### 拉取请求的自动化测试
|
### 拉取请求的自动化测试
|
||||||
|
|
||||||
@@ -60,16 +60,37 @@ git commit --signoff -m "Your commit message"
|
|||||||
|
|
||||||
### 获取代码审查/合并
|
### 获取代码审查/合并
|
||||||
|
|
||||||
维护者在此帮助您在合理时间内实现您的用例。他们会尽力在合理时间内审查您的代码并提供建设性反馈。但如果您在审查过程中受阻,或认为您的 Pull Request 未得到应有的关注,请通过 Issue 中的评论或者[社群](README.zh.md#-community)联系我们
|
维护者在此帮助您在合理时间内实现您的用例。他们会尽力在合理时间内审查您的代码并提供建设性反馈。但如果您在审查过程中受阻,或认为您的 Pull Request 未得到应有的关注,请通过 Issue 中的评论或者[社群](../README.md#-community)联系我们
|
||||||
|
|
||||||
### 参与测试计划
|
### 参与测试计划
|
||||||
|
|
||||||
测试计划旨在为用户提供更稳定的应用体验和更快的迭代速度,详细情况请参阅[测试计划](testplan-zh.md)。
|
测试计划旨在为用户提供更稳定的应用体验和更快的迭代速度,详细情况请参阅[测试计划](./test-plan.md)。
|
||||||
|
|
||||||
### 其他建议
|
### 其他建议
|
||||||
|
|
||||||
- **联系开发者**:在提交 PR 之前,您可以先和开发者进行联系,共同探讨或者获取帮助。
|
- **联系开发者**:在提交 PR 之前,您可以先和开发者进行联系,共同探讨或者获取帮助。
|
||||||
- **成为核心开发者**:如果您能够稳定为项目贡献,恭喜您可以成为项目核心开发者,获取到项目成员身份。请查看我们的[成员指南](https://github.com/CherryHQ/community/blob/main/membership.md)
|
|
||||||
|
## 重要贡献指南与关注点
|
||||||
|
|
||||||
|
在提交 Pull Request 之前,请务必阅读以下关键信息:
|
||||||
|
|
||||||
|
### 🚫 暂时限制涉及数据更改的功能性 PR
|
||||||
|
|
||||||
|
**目前,我们不接受涉及 Redux 数据模型或 IndexedDB schema 变更的功能性 Pull Request。**
|
||||||
|
|
||||||
|
我们的核心团队目前正专注于涉及这些数据结构的关键架构更新和基础工作。为确保在此期间的稳定性与专注,此类贡献将暂时由内部进行管理。
|
||||||
|
|
||||||
|
* **需要更改 Redux 状态结构或 IndexedDB schema 的 PR 将会被关闭。**
|
||||||
|
* **此限制是临时性的,并将在 `v2.0.0` 版本发布后解除。** 您可以通过 Issue [#10162](https://github.com/CherryHQ/cherry-studio/pull/10162) 跟踪 `v2.0.0` 的进展及相关讨论。
|
||||||
|
|
||||||
|
我们非常鼓励以下类型的贡献:
|
||||||
|
* 错误修复 🐞
|
||||||
|
* 性能改进 🚀
|
||||||
|
* 文档更新 📚
|
||||||
|
* 不改变 Redux 数据模型或 IndexedDB schema 的功能(例如,UI 增强、新组件、小型重构)。✨
|
||||||
|
|
||||||
|
感谢您在此重要开发阶段的理解与持续支持。谢谢!
|
||||||
|
|
||||||
|
|
||||||
## 联系我们
|
## 联系我们
|
||||||
|
|
||||||
73
docs/zh/guides/development.md
Normal file
@@ -0,0 +1,73 @@
|
|||||||
|
# 🖥️ Develop
|
||||||
|
|
||||||
|
## IDE Setup
|
||||||
|
|
||||||
|
- Editor: [Cursor](https://www.cursor.com/), etc. Any VS Code compatible editor.
|
||||||
|
- Linter: [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
||||||
|
- Formatter: [Biome](https://marketplace.visualstudio.com/items?itemName=biomejs.biome)
|
||||||
|
|
||||||
|
## Project Setup
|
||||||
|
|
||||||
|
### Install
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yarn
|
||||||
|
```
|
||||||
|
|
||||||
|
### Development
|
||||||
|
|
||||||
|
### Setup Node.js
|
||||||
|
|
||||||
|
Download and install [Node.js v22.x.x](https://nodejs.org/en/download)
|
||||||
|
|
||||||
|
### Setup Yarn
|
||||||
|
|
||||||
|
```bash
|
||||||
|
corepack enable
|
||||||
|
corepack prepare yarn@4.9.1 --activate
|
||||||
|
```
|
||||||
|
|
||||||
|
### Install Dependencies
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yarn install
|
||||||
|
```
|
||||||
|
|
||||||
|
### ENV
|
||||||
|
|
||||||
|
```bash
|
||||||
|
copy .env.example .env
|
||||||
|
```
|
||||||
|
|
||||||
|
### Start
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yarn dev
|
||||||
|
```
|
||||||
|
|
||||||
|
### Debug
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yarn debug
|
||||||
|
```
|
||||||
|
|
||||||
|
Then input chrome://inspect in browser
|
||||||
|
|
||||||
|
### Test
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yarn test
|
||||||
|
```
|
||||||
|
|
||||||
|
### Build
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# For windows
|
||||||
|
$ yarn build:win
|
||||||
|
|
||||||
|
# For macOS
|
||||||
|
$ yarn build:mac
|
||||||
|
|
||||||
|
# For Linux
|
||||||
|
$ yarn build:linux
|
||||||
|
```
|
||||||
@@ -15,11 +15,11 @@ i18n ally是一个强大的VSCode插件,它能在开发阶段提供实时反
|
|||||||
|
|
||||||
### 效果展示
|
### 效果展示
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||

|

|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## i18n 约定
|
## i18n 约定
|
||||||
|
|
||||||
@@ -11,13 +11,15 @@
|
|||||||
|
|
||||||
用户可以在软件的`设置`-`关于`中,开启“测试计划”并选择版本通道。请注意“测试计划”的版本无法保证数据的一致性,请使用前一定要备份数据。
|
用户可以在软件的`设置`-`关于`中,开启“测试计划”并选择版本通道。请注意“测试计划”的版本无法保证数据的一致性,请使用前一定要备份数据。
|
||||||
|
|
||||||
|
用户选择RC版通道或Beta版通道后,若发布了正式版,仍旧会升级到正式版。
|
||||||
|
|
||||||
用户在测试过程中发现的BUG,欢迎提交issue或通过其他渠道反馈。用户的反馈对我们非常重要。
|
用户在测试过程中发现的BUG,欢迎提交issue或通过其他渠道反馈。用户的反馈对我们非常重要。
|
||||||
|
|
||||||
## 开发者指南
|
## 开发者指南
|
||||||
|
|
||||||
### 参与测试计划
|
### 参与测试计划
|
||||||
|
|
||||||
开发者按照[贡献者指南](CONTRIBUTING.zh.md)要求正常提交`PR`(并注意提交target为`main`)。仓库维护者会综合考虑(例如该功能对应用的影响程度,功能的重要性,是否需要更广泛的测试等),决定该`PR`是否应加入测试计划。
|
开发者按照[贡献者指南](./contributing.md)要求正常提交`PR`(并注意提交target为`main`)。仓库维护者会综合考虑(例如该功能对应用的影响程度,功能的重要性,是否需要更广泛的测试等),决定该`PR`是否应加入测试计划。
|
||||||
|
|
||||||
若该`PR`加入测试计划,仓库维护者会做如下操作:
|
若该`PR`加入测试计划,仓库维护者会做如下操作:
|
||||||
|
|
||||||
430
docs/zh/references/app-upgrade.md
Normal file
@@ -0,0 +1,430 @@
|
|||||||
|
# 更新配置系统设计文档
|
||||||
|
|
||||||
|
## 背景
|
||||||
|
|
||||||
|
当前 AppUpdater 直接请求 GitHub API 获取 beta 和 rc 的更新信息。为了支持国内用户,需要根据 IP 地理位置,分别从 GitHub/GitCode 获取一个固定的 JSON 配置文件,该文件包含所有渠道的更新地址。
|
||||||
|
|
||||||
|
## 设计目标
|
||||||
|
|
||||||
|
1. 支持根据 IP 地理位置选择不同的配置源(GitHub/GitCode)
|
||||||
|
2. 支持版本兼容性控制(如 v1.x 以下必须先升级到 v1.7.0 才能升级到 v2.0)
|
||||||
|
3. 易于扩展,支持未来多个主版本的升级路径(v1.6 → v1.7 → v2.0 → v2.8 → v3.0)
|
||||||
|
4. 保持与现有 electron-updater 机制的兼容性
|
||||||
|
|
||||||
|
## 当前版本策略
|
||||||
|
|
||||||
|
- **v1.7.x** 是 1.x 系列的最后版本
|
||||||
|
- **v1.7.0 以下**的用户必须先升级到 v1.7.0(或更高的 1.7.x 版本)
|
||||||
|
- **v1.7.0 及以上**的用户可以直接升级到 v2.x.x
|
||||||
|
|
||||||
|
## 自动化工作流
|
||||||
|
|
||||||
|
`x-files/app-upgrade-config/app-upgrade-config.json` 由 [`Update App Upgrade Config`](../../.github/workflows/update-app-upgrade-config.yml) workflow 自动同步。工作流会调用 [`scripts/update-app-upgrade-config.ts`](../../scripts/update-app-upgrade-config.ts) 脚本,根据指定 tag 更新 `x-files/app-upgrade-config` 分支上的配置文件。
|
||||||
|
|
||||||
|
### 触发条件
|
||||||
|
|
||||||
|
- **Release 事件(`release: released/prereleased`)**
|
||||||
|
- Draft release 会被忽略。
|
||||||
|
- 当 GitHub 将 release 标记为 *prerelease* 时,tag 必须包含 `-beta`/`-rc`(可带序号),否则直接跳过。
|
||||||
|
- 当 release 标记为稳定版时,tag 必须与 GitHub API 返回的最新稳定版本一致,防止发布历史 tag 时意外挂起工作流。
|
||||||
|
- 满足上述条件后,工作流会根据语义化版本判断渠道(`latest`/`beta`/`rc`),并通过 `IS_PRERELEASE` 传递给脚本。
|
||||||
|
- **手动触发(`workflow_dispatch`)**
|
||||||
|
- 必填:`tag`(例:`v2.0.1`);选填:`is_prerelease`(默认 `false`)。
|
||||||
|
- 当 `is_prerelease=true` 时,同样要求 tag 带有 beta/rc 后缀。
|
||||||
|
- 手动运行仍会请求 GitHub 最新 release 信息,用于在 PR 说明中标注该 tag 是否是最新稳定版。
|
||||||
|
|
||||||
|
### 工作流步骤
|
||||||
|
|
||||||
|
1. **检查与元数据准备**:`Check if should proceed` 和 `Prepare metadata` 步骤会计算 tag、prerelease 标志、是否最新版本以及用于分支名的 `safe_tag`。若任意校验失败,工作流立即退出。
|
||||||
|
2. **检出分支**:默认分支被检出到 `main/`,长期维护的 `x-files/app-upgrade-config` 分支则在 `cs/` 中,所有改动都发生在 `cs/`。
|
||||||
|
3. **安装工具链**:安装 Node.js 22、启用 Corepack,并在 `main/` 目录执行 `yarn install --immutable`。
|
||||||
|
4. **运行更新脚本**:执行 `yarn tsx scripts/update-app-upgrade-config.ts --tag <tag> --config ../cs/app-upgrade-config.json --is-prerelease <flag>`。
|
||||||
|
- 脚本会标准化 tag(去掉 `v` 前缀等)、识别渠道、加载 `config/app-upgrade-segments.json` 中的分段规则。
|
||||||
|
- 校验 prerelease 标志与语义后缀是否匹配、强制锁定的 segment 是否满足、生成镜像的下载地址,并检查 release 是否已经在 GitHub/GitCode 可用(latest 渠道在 GitCode 不可用时会回退到 `https://releases.cherry-ai.com`)。
|
||||||
|
- 更新对应的渠道配置后,脚本会按 semver 排序写回 JSON,并刷新 `lastUpdated`。
|
||||||
|
5. **检测变更并创建 PR**:若 `cs/app-upgrade-config.json` 有变更,则创建 `chore/update-app-upgrade-config/<safe_tag>` 分支,提交信息为 `🤖 chore: sync app-upgrade-config for <tag>`,并向 `x-files/app-upgrade-config` 提 PR;无变更则输出提示。
|
||||||
|
|
||||||
|
### 手动触发指南
|
||||||
|
|
||||||
|
1. 进入 Cherry Studio 仓库的 GitHub **Actions** 页面,选择 **Update App Upgrade Config** 工作流。
|
||||||
|
2. 点击 **Run workflow**,保持默认分支(通常为 `main`),填写 `tag`(如 `v2.1.0`)。
|
||||||
|
3. 只有在 tag 带 `-beta`/`-rc` 后缀时才勾选 `is_prerelease`,稳定版保持默认。
|
||||||
|
4. 启动运行并等待完成,随后到 `x-files/app-upgrade-config` 分支的 PR 查看 `app-upgrade-config.json` 的变更并在验证后合并。
|
||||||
|
|
||||||
|
## JSON 配置文件格式
|
||||||
|
|
||||||
|
### 文件位置
|
||||||
|
|
||||||
|
- **GitHub**: `https://raw.githubusercontent.com/CherryHQ/cherry-studio/refs/heads/x-files/app-upgrade-config/app-upgrade-config.json`
|
||||||
|
- **GitCode**: `https://gitcode.com/CherryHQ/cherry-studio/raw/x-files/app-upgrade-config/app-upgrade-config.json`
|
||||||
|
|
||||||
|
**说明**:两个镜像源提供相同的配置文件,统一托管在 `x-files/app-upgrade-config` 分支上。客户端根据 IP 地理位置自动选择最优镜像源。
|
||||||
|
|
||||||
|
### 配置结构(当前实际配置)
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"lastUpdated": "2025-01-05T00:00:00Z",
|
||||||
|
"versions": {
|
||||||
|
"1.6.7": {
|
||||||
|
"minCompatibleVersion": "1.0.0",
|
||||||
|
"description": "Last stable v1.7.x release - required intermediate version for users below v1.7",
|
||||||
|
"channels": {
|
||||||
|
"latest": {
|
||||||
|
"version": "1.6.7",
|
||||||
|
"feedUrls": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/download/v1.6.7",
|
||||||
|
"gitcode": "https://gitcode.com/CherryHQ/cherry-studio/releases/download/v1.6.7"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"rc": {
|
||||||
|
"version": "1.6.0-rc.5",
|
||||||
|
"feedUrls": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/download/v1.6.0-rc.5",
|
||||||
|
"gitcode": "https://github.com/CherryHQ/cherry-studio/releases/download/v1.6.0-rc.5"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"beta": {
|
||||||
|
"version": "1.6.7-beta.3",
|
||||||
|
"feedUrls": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/download/v1.7.0-beta.3",
|
||||||
|
"gitcode": "https://github.com/CherryHQ/cherry-studio/releases/download/v1.7.0-beta.3"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"2.0.0": {
|
||||||
|
"minCompatibleVersion": "1.7.0",
|
||||||
|
"description": "Major release v2.0 - required intermediate version for v2.x upgrades",
|
||||||
|
"channels": {
|
||||||
|
"latest": null,
|
||||||
|
"rc": null,
|
||||||
|
"beta": null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 未来扩展示例
|
||||||
|
|
||||||
|
当需要发布 v3.0 时,如果需要强制用户先升级到 v2.8,可以添加:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"2.8.0": {
|
||||||
|
"minCompatibleVersion": "2.0.0",
|
||||||
|
"description": "Stable v2.8 - required for v3 upgrade",
|
||||||
|
"channels": {
|
||||||
|
"latest": {
|
||||||
|
"version": "2.8.0",
|
||||||
|
"feedUrls": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/download/v2.8.0",
|
||||||
|
"gitcode": "https://gitcode.com/CherryHQ/cherry-studio/releases/download/v2.8.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"rc": null,
|
||||||
|
"beta": null
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"3.0.0": {
|
||||||
|
"minCompatibleVersion": "2.8.0",
|
||||||
|
"description": "Major release v3.0",
|
||||||
|
"channels": {
|
||||||
|
"latest": {
|
||||||
|
"version": "3.0.0",
|
||||||
|
"feedUrls": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/latest",
|
||||||
|
"gitcode": "https://gitcode.com/CherryHQ/cherry-studio/releases/latest"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"rc": {
|
||||||
|
"version": "3.0.0-rc.1",
|
||||||
|
"feedUrls": {
|
||||||
|
"github": "https://github.com/CherryHQ/cherry-studio/releases/download/v3.0.0-rc.1",
|
||||||
|
"gitcode": "https://gitcode.com/CherryHQ/cherry-studio/releases/download/v3.0.0-rc.1"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"beta": null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 字段说明
|
||||||
|
|
||||||
|
- `lastUpdated`: 配置文件最后更新时间(ISO 8601 格式)
|
||||||
|
- `versions`: 版本配置对象,key 为版本号,按语义化版本排序
|
||||||
|
- `minCompatibleVersion`: 可以升级到此版本的最低兼容版本
|
||||||
|
- `description`: 版本描述
|
||||||
|
- `channels`: 更新渠道配置
|
||||||
|
- `latest`: 稳定版渠道
|
||||||
|
- `rc`: Release Candidate 渠道
|
||||||
|
- `beta`: Beta 测试渠道
|
||||||
|
- 每个渠道包含:
|
||||||
|
- `version`: 该渠道的版本号
|
||||||
|
- `feedUrls`: 多镜像源 URL 配置
|
||||||
|
- `github`: GitHub 镜像源的 electron-updater feed URL
|
||||||
|
- `gitcode`: GitCode 镜像源的 electron-updater feed URL
|
||||||
|
- `metadata`: 自动化匹配所需的稳定标识
|
||||||
|
- `segmentId`: 来自 `config/app-upgrade-segments.json` 的段位 ID
|
||||||
|
- `segmentType`: 可选字段(`legacy` | `breaking` | `latest`),便于文档/调试
|
||||||
|
|
||||||
|
## TypeScript 类型定义
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// 镜像源枚举
|
||||||
|
enum UpdateMirror {
|
||||||
|
GITHUB = 'github',
|
||||||
|
GITCODE = 'gitcode'
|
||||||
|
}
|
||||||
|
|
||||||
|
interface UpdateConfig {
|
||||||
|
lastUpdated: string
|
||||||
|
versions: {
|
||||||
|
[versionKey: string]: VersionConfig
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
interface VersionConfig {
|
||||||
|
minCompatibleVersion: string
|
||||||
|
description: string
|
||||||
|
channels: {
|
||||||
|
latest: ChannelConfig | null
|
||||||
|
rc: ChannelConfig | null
|
||||||
|
beta: ChannelConfig | null
|
||||||
|
}
|
||||||
|
metadata?: {
|
||||||
|
segmentId: string
|
||||||
|
segmentType?: 'legacy' | 'breaking' | 'latest'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ChannelConfig {
|
||||||
|
version: string
|
||||||
|
feedUrls: Record<UpdateMirror, string>
|
||||||
|
// 等同于:
|
||||||
|
// feedUrls: {
|
||||||
|
// github: string
|
||||||
|
// gitcode: string
|
||||||
|
// }
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 段位元数据(Break Change 标记)
|
||||||
|
|
||||||
|
- 所有段位定义(如 `legacy-v1`、`gateway-v2` 等)集中在 `config/app-upgrade-segments.json`,用于描述匹配范围、`segmentId`、`segmentType`、默认 `minCompatibleVersion/description` 以及各渠道的 URL 模板。
|
||||||
|
- `versions` 下的每个节点都会带上 `metadata.segmentId`。自动脚本始终依据该 ID 来定位并更新条目,即便 key 从 `2.1.5` 切换到 `2.1.6` 也不会错位。
|
||||||
|
- 如果某段需要锁死在特定版本(例如 `2.0.0` 的 break change),可在段定义中设置 `segmentType: "breaking"` 并提供 `lockedVersion`,脚本在遇到不匹配的 tag 时会短路报错,保证升级路径安全。
|
||||||
|
- 面对未来新的断层(例如 `3.0.0`),只需要在段定义里新增一段,自动化即可识别并更新。
|
||||||
|
|
||||||
|
## 自动化工作流
|
||||||
|
|
||||||
|
`.github/workflows/update-app-upgrade-config.yml` 会在 GitHub Release(包含正常发布与 Pre Release)触发:
|
||||||
|
|
||||||
|
1. 同时 Checkout 仓库默认分支(用于脚本)和 `x-files/app-upgrade-config` 分支(真实托管配置的分支)。
|
||||||
|
2. 在默认分支目录执行 `yarn tsx scripts/update-app-upgrade-config.ts --tag <tag> --config ../cs/app-upgrade-config.json`,直接重写 `x-files/app-upgrade-config` 分支里的配置文件。
|
||||||
|
3. 如果 `app-upgrade-config.json` 有变化,则通过 `peter-evans/create-pull-request` 自动创建一个指向 `x-files/app-upgrade-config` 的 PR,Diff 仅包含该文件。
|
||||||
|
|
||||||
|
如需本地调试,可执行 `yarn update:upgrade-config --tag v2.1.6 --config ../cs/app-upgrade-config.json`(加 `--dry-run` 仅打印结果)来复现 CI 行为。若需要暂时跳过 GitHub/GitCode Release 页面是否就绪的校验,可在 `--dry-run` 的同时附加 `--skip-release-checks`。不加 `--config` 时默认更新当前工作目录(通常是 main 分支)下的副本,方便文档/审查。
|
||||||
|
|
||||||
|
## 版本匹配逻辑
|
||||||
|
|
||||||
|
### 算法流程
|
||||||
|
|
||||||
|
1. 获取用户当前版本(`currentVersion`)和请求的渠道(`requestedChannel`)
|
||||||
|
2. 获取配置文件中所有版本号,按语义化版本从大到小排序
|
||||||
|
3. 遍历排序后的版本列表:
|
||||||
|
- 检查 `currentVersion >= minCompatibleVersion`
|
||||||
|
- 检查请求的 `channel` 是否存在且不为 `null`
|
||||||
|
- 如果满足条件,返回该渠道配置
|
||||||
|
4. 如果没有找到匹配版本,返回 `null`
|
||||||
|
|
||||||
|
### 伪代码实现
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
function findCompatibleVersion(
|
||||||
|
currentVersion: string,
|
||||||
|
requestedChannel: UpgradeChannel,
|
||||||
|
config: UpdateConfig
|
||||||
|
): ChannelConfig | null {
|
||||||
|
// 获取所有版本号并从大到小排序
|
||||||
|
const versions = Object.keys(config.versions).sort(semver.rcompare)
|
||||||
|
|
||||||
|
for (const versionKey of versions) {
|
||||||
|
const versionConfig = config.versions[versionKey]
|
||||||
|
const channelConfig = versionConfig.channels[requestedChannel]
|
||||||
|
|
||||||
|
// 检查版本兼容性和渠道可用性
|
||||||
|
if (
|
||||||
|
semver.gte(currentVersion, versionConfig.minCompatibleVersion) &&
|
||||||
|
channelConfig !== null
|
||||||
|
) {
|
||||||
|
return channelConfig
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return null // 没有找到兼容版本
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 升级路径示例
|
||||||
|
|
||||||
|
### 场景 1: v1.6.5 用户升级(低于 1.7)
|
||||||
|
|
||||||
|
- **当前版本**: 1.6.5
|
||||||
|
- **请求渠道**: latest
|
||||||
|
- **匹配结果**: 1.7.0
|
||||||
|
- **原因**: 1.6.5 >= 0.0.0(满足 1.7.0 的 minCompatibleVersion),但不满足 2.0.0 的 minCompatibleVersion (1.7.0)
|
||||||
|
- **操作**: 提示用户升级到 1.7.0,这是升级到 v2.x 的必要中间版本
|
||||||
|
|
||||||
|
### 场景 2: v1.6.5 用户请求 rc/beta
|
||||||
|
|
||||||
|
- **当前版本**: 1.6.5
|
||||||
|
- **请求渠道**: rc 或 beta
|
||||||
|
- **匹配结果**: 1.7.0 (latest)
|
||||||
|
- **原因**: 1.7.0 版本不提供 rc/beta 渠道(值为 null)
|
||||||
|
- **操作**: 升级到 1.7.0 稳定版
|
||||||
|
|
||||||
|
### 场景 3: v1.7.0 用户升级到最新版
|
||||||
|
|
||||||
|
- **当前版本**: 1.7.0
|
||||||
|
- **请求渠道**: latest
|
||||||
|
- **匹配结果**: 2.0.0
|
||||||
|
- **原因**: 1.7.0 >= 1.7.0(满足 2.0.0 的 minCompatibleVersion)
|
||||||
|
- **操作**: 直接升级到 2.0.0(当前最新稳定版)
|
||||||
|
|
||||||
|
### 场景 4: v1.7.2 用户升级到 RC 版本
|
||||||
|
|
||||||
|
- **当前版本**: 1.7.2
|
||||||
|
- **请求渠道**: rc
|
||||||
|
- **匹配结果**: 2.0.0-rc.1
|
||||||
|
- **原因**: 1.7.2 >= 1.7.0(满足 2.0.0 的 minCompatibleVersion),且 rc 渠道存在
|
||||||
|
- **操作**: 升级到 2.0.0-rc.1
|
||||||
|
|
||||||
|
### 场景 5: v1.7.0 用户升级到 Beta 版本
|
||||||
|
|
||||||
|
- **当前版本**: 1.7.0
|
||||||
|
- **请求渠道**: beta
|
||||||
|
- **匹配结果**: 2.0.0-beta.1
|
||||||
|
- **原因**: 1.7.0 >= 1.7.0,且 beta 渠道存在
|
||||||
|
- **操作**: 升级到 2.0.0-beta.1
|
||||||
|
|
||||||
|
### 场景 6: v2.5.0 用户升级(未来)
|
||||||
|
|
||||||
|
假设已添加 v2.8.0 和 v3.0.0 配置:
|
||||||
|
- **当前版本**: 2.5.0
|
||||||
|
- **请求渠道**: latest
|
||||||
|
- **匹配结果**: 2.8.0
|
||||||
|
- **原因**: 2.5.0 >= 2.0.0(满足 2.8.0 的 minCompatibleVersion),但不满足 3.0.0 的要求
|
||||||
|
- **操作**: 提示用户升级到 2.8.0,这是升级到 v3.x 的必要中间版本
|
||||||
|
|
||||||
|
## 代码改动计划
|
||||||
|
|
||||||
|
### 主要修改
|
||||||
|
|
||||||
|
1. **新增方法**
|
||||||
|
- `_fetchUpdateConfig(ipCountry: string): Promise<UpdateConfig | null>` - 根据 IP 获取配置文件
|
||||||
|
- `_findCompatibleChannel(currentVersion: string, channel: UpgradeChannel, config: UpdateConfig): ChannelConfig | null` - 查找兼容的渠道配置
|
||||||
|
|
||||||
|
2. **修改方法**
|
||||||
|
- `_getReleaseVersionFromGithub()` → 移除或重构为 `_getChannelFeedUrl()`
|
||||||
|
- `_setFeedUrl()` - 使用新的配置系统替代现有逻辑
|
||||||
|
|
||||||
|
3. **新增类型定义**
|
||||||
|
- `UpdateConfig`
|
||||||
|
- `VersionConfig`
|
||||||
|
- `ChannelConfig`
|
||||||
|
|
||||||
|
### 镜像源选择逻辑
|
||||||
|
|
||||||
|
客户端根据 IP 地理位置自动选择最优镜像源:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
private async _setFeedUrl() {
|
||||||
|
const currentVersion = app.getVersion()
|
||||||
|
const testPlan = configManager.getTestPlan()
|
||||||
|
const requestedChannel = testPlan ? this._getTestChannel() : UpgradeChannel.LATEST
|
||||||
|
|
||||||
|
// 根据 IP 国家确定镜像源
|
||||||
|
const ipCountry = await getIpCountry()
|
||||||
|
const mirror = ipCountry.toLowerCase() === 'cn' ? 'gitcode' : 'github'
|
||||||
|
|
||||||
|
// 获取更新配置
|
||||||
|
const config = await this._fetchUpdateConfig(mirror)
|
||||||
|
|
||||||
|
if (config) {
|
||||||
|
const channelConfig = this._findCompatibleChannel(currentVersion, requestedChannel, config)
|
||||||
|
if (channelConfig) {
|
||||||
|
// 从配置中选择对应镜像源的 URL
|
||||||
|
const feedUrl = channelConfig.feedUrls[mirror]
|
||||||
|
this._setChannel(requestedChannel, feedUrl)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fallback 逻辑
|
||||||
|
const defaultFeedUrl = mirror === 'gitcode'
|
||||||
|
? FeedUrl.PRODUCTION
|
||||||
|
: FeedUrl.GITHUB_LATEST
|
||||||
|
this._setChannel(UpgradeChannel.LATEST, defaultFeedUrl)
|
||||||
|
}
|
||||||
|
|
||||||
|
private async _fetchUpdateConfig(mirror: 'github' | 'gitcode'): Promise<UpdateConfig | null> {
|
||||||
|
const configUrl = mirror === 'gitcode'
|
||||||
|
? UpdateConfigUrl.GITCODE
|
||||||
|
: UpdateConfigUrl.GITHUB
|
||||||
|
|
||||||
|
try {
|
||||||
|
const response = await net.fetch(configUrl, {
|
||||||
|
headers: {
|
||||||
|
'User-Agent': generateUserAgent(),
|
||||||
|
'Accept': 'application/json',
|
||||||
|
'X-Client-Id': configManager.getClientId()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
return await response.json() as UpdateConfig
|
||||||
|
} catch (error) {
|
||||||
|
logger.error('Failed to fetch update config:', error)
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 降级和容错策略
|
||||||
|
|
||||||
|
1. **配置文件获取失败**: 记录错误日志,返回当前版本,不提供更新
|
||||||
|
2. **没有匹配的版本**: 提示用户当前版本不支持自动升级
|
||||||
|
3. **网络异常**: 缓存上次成功获取的配置(可选)
|
||||||
|
|
||||||
|
## GitHub Release 要求
|
||||||
|
|
||||||
|
为支持中间版本升级,需要保留以下文件:
|
||||||
|
|
||||||
|
- **v1.7.0 release** 及其 latest*.yml 文件(作为 v1.7 以下用户的升级目标)
|
||||||
|
- 未来如需强制中间版本(如 v2.8.0),需要保留对应的 release 和 latest*.yml 文件
|
||||||
|
- 各版本的完整安装包
|
||||||
|
|
||||||
|
### 当前需要的 Release
|
||||||
|
|
||||||
|
| 版本 | 用途 | 必须保留 |
|
||||||
|
|------|------|---------|
|
||||||
|
| v1.7.0 | 1.7 以下用户的升级目标 | ✅ 是 |
|
||||||
|
| v2.0.0-rc.1 | RC 测试渠道 | ❌ 可选 |
|
||||||
|
| v2.0.0-beta.1 | Beta 测试渠道 | ❌ 可选 |
|
||||||
|
| latest | 最新稳定版(自动) | ✅ 是 |
|
||||||
|
|
||||||
|
## 优势
|
||||||
|
|
||||||
|
1. **灵活性**: 支持任意复杂的升级路径
|
||||||
|
2. **可扩展性**: 新增版本只需在配置文件中添加新条目
|
||||||
|
3. **可维护性**: 配置与代码分离,无需发版即可调整升级策略
|
||||||
|
4. **多源支持**: 自动根据地理位置选择最优配置源
|
||||||
|
5. **版本控制**: 强制中间版本升级,确保数据迁移和兼容性
|
||||||
|
|
||||||
|
## 未来扩展
|
||||||
|
|
||||||
|
- 支持更细粒度的版本范围控制(如 `>=1.5.0 <1.8.0`)
|
||||||
|
- 支持多步升级路径提示(如提示用户需要 1.5 → 1.8 → 2.0)
|
||||||
|
- 支持 A/B 测试和灰度发布
|
||||||
|
- 支持配置文件的本地缓存和过期策略
|
||||||
@@ -85,7 +85,7 @@ graph TD
|
|||||||
- **SvgPreview**: SVG 图像预览
|
- **SvgPreview**: SVG 图像预览
|
||||||
- **GraphvizPreview**: Graphviz 图表预览
|
- **GraphvizPreview**: Graphviz 图表预览
|
||||||
|
|
||||||
所有特殊视图组件共享通用架构,以确保一致的用户体验和功能。有关这些组件及其实现的详细信息,请参阅 [图像预览组件文档](./ImagePreview-zh.md)。
|
所有特殊视图组件共享通用架构,以确保一致的用户体验和功能。有关这些组件及其实现的详细信息,请参阅[图像预览组件文档](./image-preview.md)。
|
||||||
|
|
||||||
#### StatusBar 状态栏
|
#### StatusBar 状态栏
|
||||||
|
|
||||||
@@ -192,4 +192,4 @@ const { containerRef, error, isLoading, triggerRender, cancelRender, clearError,
|
|||||||
- 共享状态管理
|
- 共享状态管理
|
||||||
- 响应式布局适应
|
- 响应式布局适应
|
||||||
|
|
||||||
有关整体 CodeBlockView 架构的更多信息,请参阅 [CodeBlockView 文档](./CodeBlockView-zh.md)。
|
有关整体 CodeBlockView 架构的更多信息,请参阅 [CodeBlockView 文档](./code-block-view.md)。
|
||||||
@@ -1,6 +1,24 @@
|
|||||||
# `translate_languages` 表技术文档
|
# 数据库参考文档
|
||||||
|
|
||||||
## 📄 概述
|
本文档介绍 Cherry Studio 的数据库结构,包括设置字段和翻译语言表。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 设置字段 (settings)
|
||||||
|
|
||||||
|
此部分包含设置相关字段的数据类型说明。
|
||||||
|
|
||||||
|
### 翻译相关字段
|
||||||
|
|
||||||
|
| 字段名 | 类型 | 说明 |
|
||||||
|
| ------------------------------ | ------------------------------ | ------------ |
|
||||||
|
| `translate:target:language` | `LanguageCode` | 翻译目标语言 |
|
||||||
|
| `translate:source:language` | `LanguageCode` | 翻译源语言 |
|
||||||
|
| `translate:bidirectional:pair` | `[LanguageCode, LanguageCode]` | 双向翻译对 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 翻译语言表 (translate_languages)
|
||||||
|
|
||||||
`translate_languages` 记录用户自定义的的语言类型(`Language`)。
|
`translate_languages` 记录用户自定义的的语言类型(`Language`)。
|
||||||
|
|
||||||
404
docs/zh/references/message-system.md
Normal file
@@ -0,0 +1,404 @@
|
|||||||
|
# 消息系统
|
||||||
|
|
||||||
|
本文档介绍 Cherry Studio 的消息系统架构,包括消息生命周期、状态管理和操作接口。
|
||||||
|
|
||||||
|
## 消息的生命周期
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# messageBlock.ts 使用指南
|
||||||
|
|
||||||
|
该文件定义了用于管理应用程序中所有 `MessageBlock` 实体的 Redux Slice。它使用 Redux Toolkit 的 `createSlice` 和 `createEntityAdapter` 来高效地处理规范化的状态,并提供了一系列 actions 和 selectors 用于与消息块数据交互。
|
||||||
|
|
||||||
|
## 核心目标
|
||||||
|
|
||||||
|
- **状态管理**: 集中管理所有 `MessageBlock` 的状态。`MessageBlock` 代表消息中的不同内容单元(如文本、代码、图片、引用等)。
|
||||||
|
- **规范化**: 使用 `createEntityAdapter` 将 `MessageBlock` 数据存储在规范化的结构中(`{ ids: [], entities: {} }`),这有助于提高性能和简化更新逻辑。
|
||||||
|
- **可预测性**: 提供明确的 actions 来修改状态,并通过 selectors 安全地访问状态。
|
||||||
|
|
||||||
|
## 关键概念
|
||||||
|
|
||||||
|
- **Slice (`createSlice`)**: Redux Toolkit 的核心 API,用于创建包含 reducer 逻辑、action creators 和初始状态的 Redux 模块。
|
||||||
|
- **Entity Adapter (`createEntityAdapter`)**: Redux Toolkit 提供的工具,用于简化对规范化数据的 CRUD(创建、读取、更新、删除)操作。它会自动生成 reducer 函数和 selectors。
|
||||||
|
- **Selectors**: 用于从 Redux store 中派生和计算数据的函数。Selectors 可以被记忆化(memoized),以提高性能。
|
||||||
|
|
||||||
|
## State 结构
|
||||||
|
|
||||||
|
`messageBlocks` slice 的状态结构由 `createEntityAdapter` 定义,大致如下:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
{
|
||||||
|
ids: string[]; // 存储所有 MessageBlock ID 的有序列表
|
||||||
|
entities: { [id: string]: MessageBlock }; // 按 ID 存储 MessageBlock 对象的字典
|
||||||
|
loadingState: 'idle' | 'loading' | 'succeeded' | 'failed'; // (可选) 其他状态,如加载状态
|
||||||
|
error: string | null; // (可选) 错误信息
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Actions
|
||||||
|
|
||||||
|
该 slice 导出以下 actions (由 `createSlice` 和 `createEntityAdapter` 自动生成或自定义):
|
||||||
|
|
||||||
|
- **`upsertOneBlock(payload: MessageBlock)`**:
|
||||||
|
|
||||||
|
- 添加一个新的 `MessageBlock` 或更新一个已存在的 `MessageBlock`。如果 payload 中的 `id` 已存在,则执行更新;否则执行插入。
|
||||||
|
|
||||||
|
- **`upsertManyBlocks(payload: MessageBlock[])`**:
|
||||||
|
|
||||||
|
- 添加或更新多个 `MessageBlock`。常用于批量加载数据(例如,加载一个 Topic 的所有消息块)。
|
||||||
|
|
||||||
|
- **`removeOneBlock(payload: string)`**:
|
||||||
|
|
||||||
|
- 根据提供的 `id` (payload) 移除单个 `MessageBlock`。
|
||||||
|
|
||||||
|
- **`removeManyBlocks(payload: string[])`**:
|
||||||
|
|
||||||
|
- 根据提供的 `id` 数组 (payload) 移除多个 `MessageBlock`。常用于删除消息或清空 Topic 时清理相关的块。
|
||||||
|
|
||||||
|
- **`removeAllBlocks()`**:
|
||||||
|
|
||||||
|
- 移除 state 中的所有 `MessageBlock` 实体。
|
||||||
|
|
||||||
|
- **`updateOneBlock(payload: { id: string; changes: Partial<MessageBlock> })`**:
|
||||||
|
|
||||||
|
- 更新一个已存在的 `MessageBlock`。`payload` 需要包含块的 `id` 和一个包含要更改的字段的 `changes` 对象。
|
||||||
|
|
||||||
|
- **`setMessageBlocksLoading(payload: 'idle' | 'loading')`**:
|
||||||
|
|
||||||
|
- (自定义) 设置 `loadingState` 属性。
|
||||||
|
|
||||||
|
- **`setMessageBlocksError(payload: string)`**:
|
||||||
|
- (自定义) 设置 `loadingState` 为 `'failed'` 并记录错误信息。
|
||||||
|
|
||||||
|
**使用示例 (在 Thunk 或其他 Dispatch 的地方):**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { upsertOneBlock, removeManyBlocks, updateOneBlock } from './messageBlock'
|
||||||
|
import store from './store' // 假设这是你的 Redux store 实例
|
||||||
|
|
||||||
|
// 添加或更新一个块
|
||||||
|
const newBlock: MessageBlock = {
|
||||||
|
/* ... block data ... */
|
||||||
|
}
|
||||||
|
store.dispatch(upsertOneBlock(newBlock))
|
||||||
|
|
||||||
|
// 更新一个块的内容
|
||||||
|
store.dispatch(updateOneBlock({ id: blockId, changes: { content: 'New content' } }))
|
||||||
|
|
||||||
|
// 删除多个块
|
||||||
|
const blockIdsToRemove = ['id1', 'id2']
|
||||||
|
store.dispatch(removeManyBlocks(blockIdsToRemove))
|
||||||
|
```
|
||||||
|
|
||||||
|
## Selectors
|
||||||
|
|
||||||
|
该 slice 导出由 `createEntityAdapter` 生成的基础 selectors,并通过 `messageBlocksSelectors` 对象访问:
|
||||||
|
|
||||||
|
- **`messageBlocksSelectors.selectIds(state: RootState): string[]`**: 返回包含所有块 ID 的数组。
|
||||||
|
- **`messageBlocksSelectors.selectEntities(state: RootState): { [id: string]: MessageBlock }`**: 返回块 ID 到块对象的映射字典。
|
||||||
|
- **`messageBlocksSelectors.selectAll(state: RootState): MessageBlock[]`**: 返回包含所有块对象的数组。
|
||||||
|
- **`messageBlocksSelectors.selectTotal(state: RootState): number`**: 返回块的总数。
|
||||||
|
- **`messageBlocksSelectors.selectById(state: RootState, id: string): MessageBlock | undefined`**: 根据 ID 返回单个块对象,如果找不到则返回 `undefined`。
|
||||||
|
|
||||||
|
**此外,还提供了一个自定义的、记忆化的 selector:**
|
||||||
|
|
||||||
|
- **`selectFormattedCitationsByBlockId(state: RootState, blockId: string | undefined): Citation[]`**:
|
||||||
|
- 接收一个 `blockId`。
|
||||||
|
- 如果该 ID 对应的块是 `CITATION` 类型,则提取并格式化其包含的引用信息(来自网页搜索、知识库等),进行去重和重新编号,最后返回一个 `Citation[]` 数组,用于在 UI 中显示。
|
||||||
|
- 如果块不存在或类型不匹配,返回空数组 `[]`。
|
||||||
|
- 这个 selector 封装了处理不同引用来源(Gemini, OpenAI, OpenRouter, Zhipu 等)的复杂逻辑。
|
||||||
|
|
||||||
|
**使用示例 (在 React 组件或 `useSelector` 中):**
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { useSelector } from 'react-redux'
|
||||||
|
import { messageBlocksSelectors, selectFormattedCitationsByBlockId } from './messageBlock'
|
||||||
|
import type { RootState } from './store'
|
||||||
|
|
||||||
|
// 获取所有块
|
||||||
|
const allBlocks = useSelector(messageBlocksSelectors.selectAll)
|
||||||
|
|
||||||
|
// 获取特定 ID 的块
|
||||||
|
const specificBlock = useSelector((state: RootState) => messageBlocksSelectors.selectById(state, someBlockId))
|
||||||
|
|
||||||
|
// 获取特定引用块格式化后的引用列表
|
||||||
|
const formattedCitations = useSelector((state: RootState) => selectFormattedCitationsByBlockId(state, citationBlockId))
|
||||||
|
|
||||||
|
// 在组件中使用引用数据
|
||||||
|
// {formattedCitations.map(citation => ...)}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 集成
|
||||||
|
|
||||||
|
`messageBlock.ts` slice 通常与 `messageThunk.ts` 中的 Thunks 紧密协作。Thunks 负责处理异步逻辑(如 API 调用、数据库操作),并在需要时 dispatch `messageBlock` slice 的 actions 来更新状态。例如,当 `messageThunk` 接收到流式响应时,它会 dispatch `upsertOneBlock` 或 `updateOneBlock` 来实时更新对应的 `MessageBlock`。同样,删除消息的 Thunk 会 dispatch `removeManyBlocks`。
|
||||||
|
|
||||||
|
理解 `messageBlock.ts` 的职责是管理**状态本身**,而 `messageThunk.ts` 负责**触发状态变更**的异步流程,这对于维护清晰的应用架构至关重要。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# messageThunk.ts 使用指南
|
||||||
|
|
||||||
|
该文件包含用于管理应用程序中消息流、处理助手交互以及同步 Redux 状态与 IndexedDB 数据库的核心 Thunk Action Creators。主要围绕 `Message` 和 `MessageBlock` 对象进行操作。
|
||||||
|
|
||||||
|
## 核心功能
|
||||||
|
|
||||||
|
1. **发送/接收消息**: 处理用户消息的发送,触发助手响应,并流式处理返回的数据,将其解析为不同的 `MessageBlock`。
|
||||||
|
2. **状态管理**: 确保 Redux store 中的消息和消息块状态与 IndexedDB 中的持久化数据保持一致。
|
||||||
|
3. **消息操作**: 提供删除、重发、重新生成、编辑后重发、追加响应、克隆等消息生命周期管理功能。
|
||||||
|
4. **Block 处理**: 动态创建、更新和保存各种类型的 `MessageBlock`(文本、思考过程、工具调用、引用、图片、错误、翻译等)。
|
||||||
|
|
||||||
|
## 主要 Thunks
|
||||||
|
|
||||||
|
以下是一些关键的 Thunk 函数及其用途:
|
||||||
|
|
||||||
|
1. **`sendMessage(userMessage, userMessageBlocks, assistant, topicId)`**
|
||||||
|
|
||||||
|
- **用途**: 发送一条新的用户消息。
|
||||||
|
- **流程**:
|
||||||
|
- 保存用户消息 (`userMessage`) 及其块 (`userMessageBlocks`) 到 Redux 和 DB。
|
||||||
|
- 检查 `@mentions` 以确定是单模型响应还是多模型响应。
|
||||||
|
- 创建助手消息(们)的存根 (Stub)。
|
||||||
|
- 将存根添加到 Redux 和 DB。
|
||||||
|
- 将核心处理逻辑 `fetchAndProcessAssistantResponseImpl` 添加到该 `topicId` 的队列中以获取实际响应。
|
||||||
|
- **Block 相关**: 主要处理用户消息的初始 `MessageBlock` 保存。
|
||||||
|
|
||||||
|
2. **`fetchAndProcessAssistantResponseImpl(dispatch, getState, topicId, assistant, assistantMessage)`**
|
||||||
|
|
||||||
|
- **用途**: (内部函数) 获取并处理单个助手响应的核心逻辑,被 `sendMessage`, `resend...`, `regenerate...`, `append...` 等调用。
|
||||||
|
- **流程**:
|
||||||
|
- 设置 Topic 加载状态。
|
||||||
|
- 准备上下文消息。
|
||||||
|
- 调用 `fetchChatCompletion` API 服务。
|
||||||
|
- 使用 `createStreamProcessor` 处理流式响应。
|
||||||
|
- 通过各种回调 (`onTextChunk`, `onThinkingChunk`, `onToolCallComplete`, `onImageGenerated`, `onError`, `onComplete` 等) 处理不同类型的事件。
|
||||||
|
- **Block 相关**:
|
||||||
|
- 根据流事件创建初始 `UNKNOWN` 块。
|
||||||
|
- 实时创建和更新 `MAIN_TEXT` 和 `THINKING` 块,使用 `throttledBlockUpdate` 和 `throttledBlockDbUpdate` 进行节流更新。
|
||||||
|
- 创建 `TOOL`, `CITATION`, `IMAGE`, `ERROR` 等类型的块。
|
||||||
|
- 在事件完成时(如 `onTextComplete`, `onToolCallComplete`)将块状态标记为 `SUCCESS` 或 `ERROR`,并使用 `saveUpdatedBlockToDB` 保存最终状态。
|
||||||
|
- 使用 `handleBlockTransition` 管理非流式块(如 `TOOL`, `CITATION`)的添加和状态更新。
|
||||||
|
|
||||||
|
3. **`loadTopicMessagesThunk(topicId, forceReload)`**
|
||||||
|
|
||||||
|
- **用途**: 从数据库加载指定主题的所有消息及其关联的 `MessageBlock`。
|
||||||
|
- **流程**:
|
||||||
|
- 从 DB 获取 `Topic` 及其 `messages` 列表。
|
||||||
|
- 根据消息 ID 列表从 DB 获取所有相关的 `MessageBlock`。
|
||||||
|
- 使用 `upsertManyBlocks` 将块更新到 Redux。
|
||||||
|
- 将消息更新到 Redux。
|
||||||
|
- **Block 相关**: 负责将持久化的 `MessageBlock` 加载到 Redux 状态。
|
||||||
|
|
||||||
|
4. **删除 Thunks**
|
||||||
|
|
||||||
|
- `deleteSingleMessageThunk(topicId, messageId)`: 删除单个消息及其所有 `MessageBlock`。
|
||||||
|
- `deleteMessageGroupThunk(topicId, askId)`: 删除一个用户消息及其所有相关的助手响应消息和它们的所有 `MessageBlock`。
|
||||||
|
- `clearTopicMessagesThunk(topicId)`: 清空主题下的所有消息及其所有 `MessageBlock`。
|
||||||
|
- **Block 相关**: 从 Redux 和 DB 中移除指定的 `MessageBlock`。
|
||||||
|
|
||||||
|
5. **重发/重新生成 Thunks**
|
||||||
|
|
||||||
|
- `resendMessageThunk(topicId, userMessageToResend, assistant)`: 重发用户消息。会重置(清空 Block 并标记为 PENDING)所有与该用户消息关联的助手响应,然后重新请求生成。
|
||||||
|
- `resendUserMessageWithEditThunk(topicId, originalMessage, mainTextBlockId, editedContent, assistant)`: 用户编辑消息内容后重发。先更新用户消息的 `MAIN_TEXT` 块内容,然后调用 `resendMessageThunk`。
|
||||||
|
- `regenerateAssistantResponseThunk(topicId, assistantMessageToRegenerate, assistant)`: 重新生成单个助手响应。重置该助手消息(清空 Block 并标记为 PENDING),然后重新请求生成。
|
||||||
|
- **Block 相关**: 删除旧的 `MessageBlock`,并在重新生成过程中创建新的 `MessageBlock`。
|
||||||
|
|
||||||
|
6. **`appendAssistantResponseThunk(topicId, existingAssistantMessageId, newModel, assistant)`**
|
||||||
|
|
||||||
|
- **用途**: 在已有的对话上下文中,针对同一个用户问题,使用新选择的模型追加一个新的助手响应。
|
||||||
|
- **流程**:
|
||||||
|
- 找到现有助手消息以获取原始 `askId`。
|
||||||
|
- 创建使用 `newModel` 的新助手消息存根(使用相同的 `askId`)。
|
||||||
|
- 添加新存根到 Redux 和 DB。
|
||||||
|
- 将 `fetchAndProcessAssistantResponseImpl` 添加到队列以生成新响应。
|
||||||
|
- **Block 相关**: 为新的助手响应创建全新的 `MessageBlock`。
|
||||||
|
|
||||||
|
7. **`cloneMessagesToNewTopicThunk(sourceTopicId, branchPointIndex, newTopic)`**
|
||||||
|
|
||||||
|
- **用途**: 将源主题的部分消息(及其 Block)克隆到一个**已存在**的新主题中。
|
||||||
|
- **流程**:
|
||||||
|
- 复制指定索引前的消息。
|
||||||
|
- 为所有克隆的消息和 Block 生成新的 UUID。
|
||||||
|
- 正确映射克隆消息之间的 `askId` 关系。
|
||||||
|
- 复制 `MessageBlock` 内容,更新其 `messageId` 指向新的消息 ID。
|
||||||
|
- 更新文件引用计数(如果 Block 是文件或图片)。
|
||||||
|
- 将克隆的消息和 Block 保存到新主题的 Redux 状态和 DB 中。
|
||||||
|
- **Block 相关**: 创建 `MessageBlock` 的副本,并更新其 ID 和 `messageId`。
|
||||||
|
|
||||||
|
8. **`initiateTranslationThunk(messageId, topicId, targetLanguage, sourceBlockId?, sourceLanguage?)`**
|
||||||
|
- **用途**: 为指定消息启动翻译流程,创建一个初始的 `TRANSLATION` 类型的 `MessageBlock`。
|
||||||
|
- **流程**:
|
||||||
|
- 创建一个状态为 `STREAMING` 的 `TranslationMessageBlock`。
|
||||||
|
- 将其添加到 Redux 和 DB。
|
||||||
|
- 更新原消息的 `blocks` 列表以包含新的翻译块 ID。
|
||||||
|
- **Block 相关**: 创建并保存一个占位的 `TranslationMessageBlock`。实际翻译内容的获取和填充需要后续步骤。
|
||||||
|
|
||||||
|
## 内部机制和注意事项
|
||||||
|
|
||||||
|
- **数据库交互**: 通过 `saveMessageAndBlocksToDB`, `updateExistingMessageAndBlocksInDB`, `saveUpdatesToDB`, `saveUpdatedBlockToDB`, `throttledBlockDbUpdate` 等辅助函数与 IndexedDB (`db`) 交互,确保数据持久化。
|
||||||
|
- **状态同步**: Thunks 负责协调 Redux Store 和 IndexedDB 之间的数据一致性。
|
||||||
|
- **队列 (`getTopicQueue`)**: 使用 `AsyncQueue` 确保对同一主题的操作(尤其是 API 请求)按顺序执行,避免竞态条件。
|
||||||
|
- **节流 (`throttle`)**: 对流式响应中频繁的 Block 更新(文本、思考)使用 `lodash.throttle` 优化性能,减少 Redux dispatch 和 DB 写入次数。
|
||||||
|
- **错误处理**: `fetchAndProcessAssistantResponseImpl` 内的回调函数(特别是 `onError`)处理流处理和 API 调用中可能出现的错误,并创建 `ERROR` 类型的 `MessageBlock`。
|
||||||
|
|
||||||
|
开发者在使用这些 Thunks 时,通常需要提供 `dispatch`, `getState` (由 Redux Thunk 中间件注入),以及如 `topicId`, `assistant` 配置对象, 相关的 `Message` 或 `MessageBlock` 对象/ID 等参数。理解每个 Thunk 的职责和它如何影响消息及块的状态至关重要。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# useMessageOperations.ts 使用指南
|
||||||
|
|
||||||
|
该文件定义了一个名为 `useMessageOperations` 的自定义 React Hook。这个 Hook 的主要目的是为 React 组件提供一个便捷的接口,用于执行与特定主题(Topic)相关的各种消息操作。它封装了调用 Redux Thunks (`messageThunk.ts`) 和 Actions (`newMessage.ts`, `messageBlock.ts`) 的逻辑,简化了组件与消息数据交互的代码。
|
||||||
|
|
||||||
|
## 核心目标
|
||||||
|
|
||||||
|
- **封装**: 将复杂的消息操作逻辑(如删除、重发、重新生成、编辑、翻译等)封装在易于使用的函数中。
|
||||||
|
- **简化**: 让组件可以直接调用这些操作函数,而无需直接与 Redux `dispatch` 或 Thunks 交互。
|
||||||
|
- **上下文关联**: 所有操作都与传入的 `topic` 对象相关联,确保操作作用于正确的主题。
|
||||||
|
|
||||||
|
## 如何使用
|
||||||
|
|
||||||
|
在你的 React 函数组件中,导入并调用 `useMessageOperations` Hook,并传入当前活动的 `Topic` 对象。
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import React from 'react';
|
||||||
|
import { useMessageOperations } from '@renderer/hooks/useMessageOperations';
|
||||||
|
import type { Topic, Message, Assistant, Model } from '@renderer/types';
|
||||||
|
|
||||||
|
interface MyComponentProps {
|
||||||
|
currentTopic: Topic;
|
||||||
|
currentAssistant: Assistant;
|
||||||
|
}
|
||||||
|
|
||||||
|
function MyComponent({ currentTopic, currentAssistant }: MyComponentProps) {
|
||||||
|
const {
|
||||||
|
deleteMessage,
|
||||||
|
resendMessage,
|
||||||
|
regenerateAssistantMessage,
|
||||||
|
appendAssistantResponse,
|
||||||
|
getTranslationUpdater,
|
||||||
|
createTopicBranch,
|
||||||
|
// ... 其他操作函数
|
||||||
|
} = useMessageOperations(currentTopic);
|
||||||
|
|
||||||
|
const handleDelete = (messageId: string) => {
|
||||||
|
deleteMessage(messageId);
|
||||||
|
};
|
||||||
|
|
||||||
|
const handleResend = (message: Message) => {
|
||||||
|
resendMessage(message, currentAssistant);
|
||||||
|
};
|
||||||
|
|
||||||
|
const handleAppend = (existingMsg: Message, newModel: Model) => {
|
||||||
|
appendAssistantResponse(existingMsg, newModel, currentAssistant);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ... 在组件中使用其他操作函数
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div>
|
||||||
|
{/* Component UI */}
|
||||||
|
<button onClick={() => handleDelete('some-message-id')}>Delete Message</button>
|
||||||
|
{/* ... */}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 返回值
|
||||||
|
|
||||||
|
`useMessageOperations(topic)` Hook 返回一个包含以下函数和值的对象:
|
||||||
|
|
||||||
|
- **`deleteMessage(id: string)`**:
|
||||||
|
|
||||||
|
- 删除指定 `id` 的单个消息。
|
||||||
|
- 内部调用 `deleteSingleMessageThunk`。
|
||||||
|
|
||||||
|
- **`deleteGroupMessages(askId: string)`**:
|
||||||
|
|
||||||
|
- 删除与指定 `askId` 相关联的一组消息(通常是用户提问及其所有助手回答)。
|
||||||
|
- 内部调用 `deleteMessageGroupThunk`。
|
||||||
|
|
||||||
|
- **`editMessage(messageId: string, updates: Partial<Message>)`**:
|
||||||
|
|
||||||
|
- 更新指定 `messageId` 的消息的部分属性。
|
||||||
|
- **注意**: 目前主要用于更新 Redux 状态
|
||||||
|
- 内部调用 `newMessagesActions.updateMessage`。
|
||||||
|
|
||||||
|
- **`resendMessage(message: Message, assistant: Assistant)`**:
|
||||||
|
|
||||||
|
- 重新发送指定的用户消息 (`message`),这将触发其所有关联助手响应的重新生成。
|
||||||
|
- 内部调用 `resendMessageThunk`。
|
||||||
|
|
||||||
|
- **`resendUserMessageWithEdit(message: Message, editedContent: string, assistant: Assistant)`**:
|
||||||
|
|
||||||
|
- 在用户消息的主要文本块被编辑后,重新发送该消息。
|
||||||
|
- 会先查找消息的 `MAIN_TEXT` 块 ID,然后调用 `resendUserMessageWithEditThunk`。
|
||||||
|
|
||||||
|
- **`clearTopicMessages(_topicId?: string)`**:
|
||||||
|
|
||||||
|
- 清除当前主题(或可选的指定 `_topicId`)下的所有消息。
|
||||||
|
- 内部调用 `clearTopicMessagesThunk`。
|
||||||
|
|
||||||
|
- **`createNewContext()`**:
|
||||||
|
|
||||||
|
- 发出一个全局事件 (`EVENT_NAMES.NEW_CONTEXT`),通常用于通知 UI 清空显示,准备新的上下文。不直接修改 Redux 状态。
|
||||||
|
|
||||||
|
- **`displayCount`**:
|
||||||
|
|
||||||
|
- (非操作函数) 从 Redux store 中获取当前的 `displayCount` 值。
|
||||||
|
|
||||||
|
- **`pauseMessages()`**:
|
||||||
|
|
||||||
|
- 尝试中止当前主题中正在进行的消息生成(状态为 `processing` 或 `pending`)。
|
||||||
|
- 通过查找相关的 `askId` 并调用 `abortCompletion` 来实现。
|
||||||
|
- 同时会 dispatch `setTopicLoading` action 将加载状态设为 `false`。
|
||||||
|
|
||||||
|
- **`resumeMessage(message: Message, assistant: Assistant)`**:
|
||||||
|
|
||||||
|
- 恢复/重新发送一个用户消息。目前实现为直接调用 `resendMessage`。
|
||||||
|
|
||||||
|
- **`regenerateAssistantMessage(message: Message, assistant: Assistant)`**:
|
||||||
|
|
||||||
|
- 重新生成指定的**助手**消息 (`message`) 的响应。
|
||||||
|
- 内部调用 `regenerateAssistantResponseThunk`。
|
||||||
|
|
||||||
|
- **`appendAssistantResponse(existingAssistantMessage: Message, newModel: Model, assistant: Assistant)`**:
|
||||||
|
|
||||||
|
- 针对 `existingAssistantMessage` 所回复的**同一用户提问**,使用 `newModel` 追加一个新的助手响应。
|
||||||
|
- 内部调用 `appendAssistantResponseThunk`。
|
||||||
|
|
||||||
|
- **`getTranslationUpdater(messageId: string, targetLanguage: string, sourceBlockId?: string, sourceLanguage?: string)`**:
|
||||||
|
|
||||||
|
- **用途**: 获取一个用于逐步更新翻译块内容的函数。
|
||||||
|
- **流程**:
|
||||||
|
1. 内部调用 `initiateTranslationThunk` 来创建或获取一个 `TRANSLATION` 类型的 `MessageBlock`,并获取其 `blockId`。
|
||||||
|
2. 返回一个**异步更新函数**。
|
||||||
|
- **返回的更新函数 `(accumulatedText: string, isComplete?: boolean) => void`**:
|
||||||
|
- 接收累积的翻译文本和完成状态。
|
||||||
|
- 调用 `updateOneBlock` 更新 Redux 中的翻译块内容和状态 (`STREAMING` 或 `SUCCESS`)。
|
||||||
|
- 调用 `throttledBlockDbUpdate` 将更新(节流地)保存到数据库。
|
||||||
|
- 如果初始化失败(Thunk 返回 `undefined`),则此函数返回 `null`。
|
||||||
|
|
||||||
|
- **`createTopicBranch(sourceTopicId: string, branchPointIndex: number, newTopic: Topic)`**:
|
||||||
|
- 创建一个主题分支,将 `sourceTopicId` 主题中 `branchPointIndex` 索引之前的消息克隆到 `newTopic` 中。
|
||||||
|
- **注意**: `newTopic` 对象必须是调用此函数**之前**已经创建并添加到 Redux 和数据库中的。
|
||||||
|
- 内部调用 `cloneMessagesToNewTopicThunk`。
|
||||||
|
|
||||||
|
## 依赖
|
||||||
|
|
||||||
|
- **`topic: Topic`**: 必须传入当前操作上下文的主题对象。Hook 返回的操作函数将始终作用于这个主题的 `topic.id`。
|
||||||
|
- **Redux `dispatch`**: Hook 内部使用 `useAppDispatch` 获取 `dispatch` 函数来调用 actions 和 thunks。
|
||||||
|
|
||||||
|
## 相关 Hooks
|
||||||
|
|
||||||
|
在同一文件中还定义了两个辅助 Hook:
|
||||||
|
|
||||||
|
- **`useTopicMessages(topic: Topic)`**:
|
||||||
|
|
||||||
|
- 使用 `selectMessagesForTopic` selector 来获取并返回指定主题的消息列表。
|
||||||
|
|
||||||
|
- **`useTopicLoading(topic: Topic)`**:
|
||||||
|
- 使用 `selectNewTopicLoading` selector 来获取并返回指定主题的加载状态。
|
||||||
|
|
||||||
|
这些 Hook 可以与 `useMessageOperations` 结合使用,方便地在组件中获取消息数据、加载状态,并执行相关操作。
|
||||||
@@ -21,6 +21,8 @@ files:
|
|||||||
- "**/*"
|
- "**/*"
|
||||||
- "!**/{.vscode,.yarn,.yarn-lock,.github,.cursorrules,.prettierrc}"
|
- "!**/{.vscode,.yarn,.yarn-lock,.github,.cursorrules,.prettierrc}"
|
||||||
- "!electron.vite.config.{js,ts,mjs,cjs}}"
|
- "!electron.vite.config.{js,ts,mjs,cjs}}"
|
||||||
|
- "!.*"
|
||||||
|
- "!components.json"
|
||||||
- "!**/{.eslintignore,.eslintrc.js,.eslintrc.json,.eslintcache,root.eslint.config.js,eslint.config.js,.eslintrc.cjs,.prettierignore,.prettierrc.yaml,eslint.config.mjs,dev-app-update.yml,CHANGELOG.md,README.md,biome.jsonc}"
|
- "!**/{.eslintignore,.eslintrc.js,.eslintrc.json,.eslintcache,root.eslint.config.js,eslint.config.js,.eslintrc.cjs,.prettierignore,.prettierrc.yaml,eslint.config.mjs,dev-app-update.yml,CHANGELOG.md,README.md,biome.jsonc}"
|
||||||
- "!**/{.env,.env.*,.npmrc,pnpm-lock.yaml}"
|
- "!**/{.env,.env.*,.npmrc,pnpm-lock.yaml}"
|
||||||
- "!**/{tsconfig.json,tsconfig.tsbuildinfo,tsconfig.node.json,tsconfig.web.json}"
|
- "!**/{tsconfig.json,tsconfig.tsbuildinfo,tsconfig.node.json,tsconfig.web.json}"
|
||||||
@@ -64,6 +66,12 @@ asarUnpack:
|
|||||||
- resources/**
|
- resources/**
|
||||||
- "**/*.{metal,exp,lib}"
|
- "**/*.{metal,exp,lib}"
|
||||||
- "node_modules/@img/sharp-libvips-*/**"
|
- "node_modules/@img/sharp-libvips-*/**"
|
||||||
|
|
||||||
|
# copy from node_modules/claude-code-plugins/plugins to resources/data/claude-code-pluginso
|
||||||
|
extraResources:
|
||||||
|
- from: "./node_modules/claude-code-plugins/plugins/"
|
||||||
|
to: "claude-code-plugins"
|
||||||
|
|
||||||
win:
|
win:
|
||||||
executableName: Cherry Studio
|
executableName: Cherry Studio
|
||||||
artifactName: ${productName}-${version}-${arch}-setup.${ext}
|
artifactName: ${productName}-${version}-${arch}-setup.${ext}
|
||||||
@@ -89,7 +97,6 @@ mac:
|
|||||||
entitlementsInherit: build/entitlements.mac.plist
|
entitlementsInherit: build/entitlements.mac.plist
|
||||||
notarize: false
|
notarize: false
|
||||||
artifactName: ${productName}-${version}-${arch}.${ext}
|
artifactName: ${productName}-${version}-${arch}.${ext}
|
||||||
minimumSystemVersion: "20.1.0" # 最低支持 macOS 11.0
|
|
||||||
extendInfo:
|
extendInfo:
|
||||||
- NSCameraUsageDescription: Application requests access to the device's camera.
|
- NSCameraUsageDescription: Application requests access to the device's camera.
|
||||||
- NSMicrophoneUsageDescription: Application requests access to the device's microphone.
|
- NSMicrophoneUsageDescription: Application requests access to the device's microphone.
|
||||||
@@ -127,60 +134,56 @@ artifactBuildCompleted: scripts/artifact-build-completed.js
|
|||||||
releaseInfo:
|
releaseInfo:
|
||||||
releaseNotes: |
|
releaseNotes: |
|
||||||
<!--LANG:en-->
|
<!--LANG:en-->
|
||||||
What's New in v1.7.0-beta.2
|
What's New in v1.7.0-rc.3
|
||||||
|
|
||||||
New Features:
|
✨ New Features:
|
||||||
- Session Settings: Manage session-specific settings and model configurations independently
|
- Provider: Added Silicon provider support for Anthropic API compatibility
|
||||||
- Notes Full-Text Search: Search across all notes with match highlighting
|
- Provider: AIHubMix support for nano banana
|
||||||
- Built-in DiDi MCP Server: Integration with DiDi ride-hailing services (China only)
|
|
||||||
- Intel OV OCR: Hardware-accelerated OCR using Intel NPU
|
|
||||||
- Auto-start API Server: Automatically starts when agents exist
|
|
||||||
|
|
||||||
Improvements:
|
🐛 Bug Fixes:
|
||||||
- Agent model selection now requires explicit user choice
|
- i18n: Clean up translation tags and untranslated strings
|
||||||
- Added Mistral AI provider support
|
- Provider: Fixed Silicon provider code list
|
||||||
- Added NewAPI generic provider support
|
- Provider: Fixed Poe API reasoning parameters for GPT-5 and reasoning models
|
||||||
- Improved navbar layout consistency across different modes
|
- Provider: Fixed duplicate /v1 in Anthropic API endpoints
|
||||||
- Enhanced chat component responsiveness
|
- Provider: Fixed Azure provider handling in AI SDK integration
|
||||||
- Better code block display on small screens
|
- Models: Added Claude Opus 4.5 pattern to THINKING_TOKEN_MAP
|
||||||
- Updated OVMS to 2025.3 official release
|
- Models: Improved Gemini reasoning and message handling
|
||||||
- Added Greek language support
|
- Models: Fixed custom parameters for Gemini models
|
||||||
|
- Models: Fixed qwen-mt-flash text delta support
|
||||||
|
- Models: Fixed Groq verbosity setting
|
||||||
|
- UI: Fixed quota display and quota tips
|
||||||
|
- UI: Fixed web search button condition
|
||||||
|
- Settings: Fixed updateAssistantPreset reducer to properly update preset
|
||||||
|
- Settings: Respect enableMaxTokens setting when maxTokens is not configured
|
||||||
|
- SDK: Fixed header merging logic in AI SDK
|
||||||
|
|
||||||
Bug Fixes:
|
⚡ Improvements:
|
||||||
- Fixed GitHub Copilot gpt-5-codex streaming issues
|
- SDK: Upgraded @anthropic-ai/claude-agent-sdk to 0.1.53
|
||||||
- Fixed assistant creation failures
|
|
||||||
- Fixed translate auto-copy functionality
|
|
||||||
- Fixed miniapps external link opening
|
|
||||||
- Fixed message layout and overflow issues
|
|
||||||
- Fixed API key parsing to preserve spaces
|
|
||||||
- Fixed agent display in different navbar layouts
|
|
||||||
|
|
||||||
<!--LANG:zh-CN-->
|
<!--LANG:zh-CN-->
|
||||||
v1.7.0-beta.2 新特性
|
v1.7.0-rc.3 更新内容
|
||||||
|
|
||||||
新功能:
|
✨ 新功能:
|
||||||
- 会话设置:独立管理会话特定的设置和模型配置
|
- 提供商:新增 Silicon 提供商对 Anthropic API 的兼容性支持
|
||||||
- 笔记全文搜索:跨所有笔记搜索并高亮匹配内容
|
- 提供商:AIHubMix 支持 nano banana
|
||||||
- 内置滴滴 MCP 服务器:集成滴滴打车服务(仅限中国地区)
|
|
||||||
- Intel OV OCR:使用 Intel NPU 的硬件加速 OCR
|
|
||||||
- 自动启动 API 服务器:当存在 Agent 时自动启动
|
|
||||||
|
|
||||||
改进:
|
🐛 问题修复:
|
||||||
- Agent 模型选择现在需要用户显式选择
|
- 国际化:清理翻译标签和未翻译字符串
|
||||||
- 添加 Mistral AI 提供商支持
|
- 提供商:修复 Silicon 提供商代码列表
|
||||||
- 添加 NewAPI 通用提供商支持
|
- 提供商:修复 Poe API 对 GPT-5 和推理模型的推理参数
|
||||||
- 改进不同模式下的导航栏布局一致性
|
- 提供商:修复 Anthropic API 端点重复 /v1 问题
|
||||||
- 增强聊天组件响应式设计
|
- 提供商:修复 Azure 提供商在 AI SDK 集成中的处理
|
||||||
- 优化小屏幕代码块显示
|
- 模型:Claude Opus 4.5 添加到 THINKING_TOKEN_MAP
|
||||||
- 更新 OVMS 至 2025.3 正式版
|
- 模型:改进 Gemini 推理和消息处理
|
||||||
- 添加希腊语支持
|
- 模型:修复 Gemini 模型自定义参数
|
||||||
|
- 模型:修复 qwen-mt-flash text delta 支持
|
||||||
|
- 模型:修复 Groq verbosity 设置
|
||||||
|
- 界面:修复配额显示和配额提示
|
||||||
|
- 界面:修复 Web 搜索按钮条件
|
||||||
|
- 设置:修复 updateAssistantPreset reducer 正确更新 preset
|
||||||
|
- 设置:尊重 enableMaxTokens 设置
|
||||||
|
- SDK:修复 AI SDK 中 header 合并逻辑
|
||||||
|
|
||||||
问题修复:
|
⚡ 改进:
|
||||||
- 修复 GitHub Copilot gpt-5-codex 流式传输问题
|
- SDK:升级 @anthropic-ai/claude-agent-sdk 到 0.1.53
|
||||||
- 修复助手创建失败
|
|
||||||
- 修复翻译自动复制功能
|
|
||||||
- 修复小程序外部链接打开
|
|
||||||
- 修复消息布局和溢出问题
|
|
||||||
- 修复 API 密钥解析以保留空格
|
|
||||||
- 修复不同导航栏布局中的 Agent 显示
|
|
||||||
<!--LANG:END-->
|
<!--LANG:END-->
|
||||||
|
|||||||
@@ -95,7 +95,8 @@ export default defineConfig({
|
|||||||
'@cherrystudio/ai-core/provider': resolve('packages/aiCore/src/core/providers'),
|
'@cherrystudio/ai-core/provider': resolve('packages/aiCore/src/core/providers'),
|
||||||
'@cherrystudio/ai-core/built-in/plugins': resolve('packages/aiCore/src/core/plugins/built-in'),
|
'@cherrystudio/ai-core/built-in/plugins': resolve('packages/aiCore/src/core/plugins/built-in'),
|
||||||
'@cherrystudio/ai-core': resolve('packages/aiCore/src'),
|
'@cherrystudio/ai-core': resolve('packages/aiCore/src'),
|
||||||
'@cherrystudio/extension-table-plus': resolve('packages/extension-table-plus/src')
|
'@cherrystudio/extension-table-plus': resolve('packages/extension-table-plus/src'),
|
||||||
|
'@cherrystudio/ai-sdk-provider': resolve('packages/ai-sdk-provider/src')
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
optimizeDeps: {
|
optimizeDeps: {
|
||||||
|
|||||||
87
package.json
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "CherryStudio",
|
"name": "CherryStudio",
|
||||||
"version": "1.7.0-beta.2",
|
"version": "1.7.0-rc.3",
|
||||||
"private": true,
|
"private": true,
|
||||||
"description": "A powerful AI assistant for producer.",
|
"description": "A powerful AI assistant for producer.",
|
||||||
"main": "./out/main/index.js",
|
"main": "./out/main/index.js",
|
||||||
@@ -58,6 +58,7 @@
|
|||||||
"update:i18n": "dotenv -e .env -- tsx scripts/update-i18n.ts",
|
"update:i18n": "dotenv -e .env -- tsx scripts/update-i18n.ts",
|
||||||
"auto:i18n": "dotenv -e .env -- tsx scripts/auto-translate-i18n.ts",
|
"auto:i18n": "dotenv -e .env -- tsx scripts/auto-translate-i18n.ts",
|
||||||
"update:languages": "tsx scripts/update-languages.ts",
|
"update:languages": "tsx scripts/update-languages.ts",
|
||||||
|
"update:upgrade-config": "tsx scripts/update-app-upgrade-config.ts",
|
||||||
"test": "vitest run --silent",
|
"test": "vitest run --silent",
|
||||||
"test:main": "vitest run --project main",
|
"test:main": "vitest run --project main",
|
||||||
"test:renderer": "vitest run --project renderer",
|
"test:renderer": "vitest run --project renderer",
|
||||||
@@ -73,25 +74,32 @@
|
|||||||
"format:check": "biome format && biome lint",
|
"format:check": "biome format && biome lint",
|
||||||
"prepare": "git config blame.ignoreRevsFile .git-blame-ignore-revs && husky",
|
"prepare": "git config blame.ignoreRevsFile .git-blame-ignore-revs && husky",
|
||||||
"claude": "dotenv -e .env -- claude",
|
"claude": "dotenv -e .env -- claude",
|
||||||
"release:aicore:alpha": "yarn workspace @cherrystudio/ai-core version prerelease --immediate && yarn workspace @cherrystudio/ai-core npm publish --tag alpha --access public",
|
"release:aicore:alpha": "yarn workspace @cherrystudio/ai-core version prerelease --preid alpha --immediate && yarn workspace @cherrystudio/ai-core build && yarn workspace @cherrystudio/ai-core npm publish --tag alpha --access public",
|
||||||
"release:aicore:beta": "yarn workspace @cherrystudio/ai-core version prerelease --immediate && yarn workspace @cherrystudio/ai-core npm publish --tag beta --access public",
|
"release:aicore:beta": "yarn workspace @cherrystudio/ai-core version prerelease --preid beta --immediate && yarn workspace @cherrystudio/ai-core build && yarn workspace @cherrystudio/ai-core npm publish --tag beta --access public",
|
||||||
"release:aicore": "yarn workspace @cherrystudio/ai-core version patch --immediate && yarn workspace @cherrystudio/ai-core npm publish --access public"
|
"release:aicore": "yarn workspace @cherrystudio/ai-core version patch --immediate && yarn workspace @cherrystudio/ai-core build && yarn workspace @cherrystudio/ai-core npm publish --access public",
|
||||||
|
"release:ai-sdk-provider": "yarn workspace @cherrystudio/ai-sdk-provider version patch --immediate && yarn workspace @cherrystudio/ai-sdk-provider build && yarn workspace @cherrystudio/ai-sdk-provider npm publish --access public"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@anthropic-ai/claude-agent-sdk": "patch:@anthropic-ai/claude-agent-sdk@npm%3A0.1.1#~/.yarn/patches/@anthropic-ai-claude-agent-sdk-npm-0.1.1-d937b73fed.patch",
|
"@anthropic-ai/claude-agent-sdk": "patch:@anthropic-ai/claude-agent-sdk@npm%3A0.1.53#~/.yarn/patches/@anthropic-ai-claude-agent-sdk-npm-0.1.53-4b77f4cf29.patch",
|
||||||
"@libsql/client": "0.14.0",
|
"@libsql/client": "0.14.0",
|
||||||
"@libsql/win32-x64-msvc": "^0.4.7",
|
"@libsql/win32-x64-msvc": "^0.4.7",
|
||||||
"@napi-rs/system-ocr": "patch:@napi-rs/system-ocr@npm%3A1.0.2#~/.yarn/patches/@napi-rs-system-ocr-npm-1.0.2-59e7a78e8b.patch",
|
"@napi-rs/system-ocr": "patch:@napi-rs/system-ocr@npm%3A1.0.2#~/.yarn/patches/@napi-rs-system-ocr-npm-1.0.2-59e7a78e8b.patch",
|
||||||
|
"@paymoapp/electron-shutdown-handler": "^1.1.2",
|
||||||
"@strongtz/win32-arm64-msvc": "^0.4.7",
|
"@strongtz/win32-arm64-msvc": "^0.4.7",
|
||||||
|
"emoji-picker-element-data": "^1",
|
||||||
"express": "^5.1.0",
|
"express": "^5.1.0",
|
||||||
"font-list": "^2.0.0",
|
"font-list": "^2.0.0",
|
||||||
"graceful-fs": "^4.2.11",
|
"graceful-fs": "^4.2.11",
|
||||||
|
"gray-matter": "^4.0.3",
|
||||||
|
"js-yaml": "^4.1.0",
|
||||||
"jsdom": "26.1.0",
|
"jsdom": "26.1.0",
|
||||||
"node-stream-zip": "^1.15.0",
|
"node-stream-zip": "^1.15.0",
|
||||||
"officeparser": "^4.2.0",
|
"officeparser": "^4.2.0",
|
||||||
"os-proxy-config": "^1.1.2",
|
"os-proxy-config": "^1.1.2",
|
||||||
|
"qrcode.react": "^4.2.0",
|
||||||
"selection-hook": "^1.0.12",
|
"selection-hook": "^1.0.12",
|
||||||
"sharp": "^0.34.3",
|
"sharp": "^0.34.3",
|
||||||
|
"socket.io": "^4.8.1",
|
||||||
"swagger-jsdoc": "^6.2.8",
|
"swagger-jsdoc": "^6.2.8",
|
||||||
"swagger-ui-express": "^5.0.1",
|
"swagger-ui-express": "^5.0.1",
|
||||||
"tesseract.js": "patch:tesseract.js@npm%3A6.0.1#~/.yarn/patches/tesseract.js-npm-6.0.1-2562a7e46d.patch",
|
"tesseract.js": "patch:tesseract.js@npm%3A6.0.1#~/.yarn/patches/tesseract.js-npm-6.0.1-2562a7e46d.patch",
|
||||||
@@ -101,18 +109,25 @@
|
|||||||
"@agentic/exa": "^7.3.3",
|
"@agentic/exa": "^7.3.3",
|
||||||
"@agentic/searxng": "^7.3.3",
|
"@agentic/searxng": "^7.3.3",
|
||||||
"@agentic/tavily": "^7.3.3",
|
"@agentic/tavily": "^7.3.3",
|
||||||
"@ai-sdk/amazon-bedrock": "^3.0.35",
|
"@ai-sdk/amazon-bedrock": "^3.0.61",
|
||||||
"@ai-sdk/google-vertex": "^3.0.40",
|
"@ai-sdk/anthropic": "^2.0.49",
|
||||||
"@ai-sdk/mistral": "^2.0.19",
|
"@ai-sdk/cerebras": "^1.0.31",
|
||||||
"@ai-sdk/perplexity": "^2.0.13",
|
"@ai-sdk/gateway": "^2.0.15",
|
||||||
|
"@ai-sdk/google": "patch:@ai-sdk/google@npm%3A2.0.43#~/.yarn/patches/@ai-sdk-google-npm-2.0.43-689ed559b3.patch",
|
||||||
|
"@ai-sdk/google-vertex": "^3.0.79",
|
||||||
|
"@ai-sdk/huggingface": "^0.0.10",
|
||||||
|
"@ai-sdk/mistral": "^2.0.24",
|
||||||
|
"@ai-sdk/openai": "patch:@ai-sdk/openai@npm%3A2.0.72#~/.yarn/patches/@ai-sdk-openai-npm-2.0.72-234e68da87.patch",
|
||||||
|
"@ai-sdk/perplexity": "^2.0.20",
|
||||||
|
"@ai-sdk/test-server": "^0.0.1",
|
||||||
"@ant-design/v5-patch-for-react-19": "^1.0.3",
|
"@ant-design/v5-patch-for-react-19": "^1.0.3",
|
||||||
"@anthropic-ai/sdk": "^0.41.0",
|
"@anthropic-ai/sdk": "^0.41.0",
|
||||||
"@anthropic-ai/vertex-sdk": "patch:@anthropic-ai/vertex-sdk@npm%3A0.11.4#~/.yarn/patches/@anthropic-ai-vertex-sdk-npm-0.11.4-c19cb41edb.patch",
|
"@anthropic-ai/vertex-sdk": "patch:@anthropic-ai/vertex-sdk@npm%3A0.11.4#~/.yarn/patches/@anthropic-ai-vertex-sdk-npm-0.11.4-c19cb41edb.patch",
|
||||||
"@aws-sdk/client-bedrock": "^3.840.0",
|
"@aws-sdk/client-bedrock": "^3.910.0",
|
||||||
"@aws-sdk/client-bedrock-runtime": "^3.840.0",
|
"@aws-sdk/client-bedrock-runtime": "^3.910.0",
|
||||||
"@aws-sdk/client-s3": "^3.840.0",
|
"@aws-sdk/client-s3": "^3.910.0",
|
||||||
"@biomejs/biome": "2.2.4",
|
"@biomejs/biome": "2.2.4",
|
||||||
"@cherrystudio/ai-core": "workspace:^1.0.0-alpha.18",
|
"@cherrystudio/ai-core": "workspace:^1.0.9",
|
||||||
"@cherrystudio/embedjs": "^0.1.31",
|
"@cherrystudio/embedjs": "^0.1.31",
|
||||||
"@cherrystudio/embedjs-libsql": "^0.1.31",
|
"@cherrystudio/embedjs-libsql": "^0.1.31",
|
||||||
"@cherrystudio/embedjs-loader-csv": "^0.1.31",
|
"@cherrystudio/embedjs-loader-csv": "^0.1.31",
|
||||||
@@ -126,7 +141,7 @@
|
|||||||
"@cherrystudio/embedjs-ollama": "^0.1.31",
|
"@cherrystudio/embedjs-ollama": "^0.1.31",
|
||||||
"@cherrystudio/embedjs-openai": "^0.1.31",
|
"@cherrystudio/embedjs-openai": "^0.1.31",
|
||||||
"@cherrystudio/extension-table-plus": "workspace:^",
|
"@cherrystudio/extension-table-plus": "workspace:^",
|
||||||
"@cherrystudio/openai": "^6.5.0",
|
"@cherrystudio/openai": "^6.9.0",
|
||||||
"@dnd-kit/core": "^6.3.1",
|
"@dnd-kit/core": "^6.3.1",
|
||||||
"@dnd-kit/modifiers": "^9.0.0",
|
"@dnd-kit/modifiers": "^9.0.0",
|
||||||
"@dnd-kit/sortable": "^10.0.0",
|
"@dnd-kit/sortable": "^10.0.0",
|
||||||
@@ -141,21 +156,22 @@
|
|||||||
"@eslint/js": "^9.22.0",
|
"@eslint/js": "^9.22.0",
|
||||||
"@google/genai": "patch:@google/genai@npm%3A1.0.1#~/.yarn/patches/@google-genai-npm-1.0.1-e26f0f9af7.patch",
|
"@google/genai": "patch:@google/genai@npm%3A1.0.1#~/.yarn/patches/@google-genai-npm-1.0.1-e26f0f9af7.patch",
|
||||||
"@hello-pangea/dnd": "^18.0.1",
|
"@hello-pangea/dnd": "^18.0.1",
|
||||||
"@heroui/react": "^2.8.3",
|
|
||||||
"@kangfenmao/keyv-storage": "^0.1.0",
|
"@kangfenmao/keyv-storage": "^0.1.0",
|
||||||
"@langchain/community": "^0.3.50",
|
"@langchain/community": "^1.0.0",
|
||||||
|
"@langchain/core": "patch:@langchain/core@npm%3A1.0.2#~/.yarn/patches/@langchain-core-npm-1.0.2-183ef83fe4.patch",
|
||||||
|
"@langchain/openai": "patch:@langchain/openai@npm%3A1.0.0#~/.yarn/patches/@langchain-openai-npm-1.0.0-474d0ad9d4.patch",
|
||||||
"@mistralai/mistralai": "^1.7.5",
|
"@mistralai/mistralai": "^1.7.5",
|
||||||
"@modelcontextprotocol/sdk": "^1.17.5",
|
"@modelcontextprotocol/sdk": "^1.17.5",
|
||||||
"@mozilla/readability": "^0.6.0",
|
"@mozilla/readability": "^0.6.0",
|
||||||
"@notionhq/client": "^2.2.15",
|
"@notionhq/client": "^2.2.15",
|
||||||
"@openrouter/ai-sdk-provider": "^1.1.2",
|
"@openrouter/ai-sdk-provider": "^1.2.5",
|
||||||
"@opentelemetry/api": "^1.9.0",
|
"@opentelemetry/api": "^1.9.0",
|
||||||
"@opentelemetry/core": "2.0.0",
|
"@opentelemetry/core": "2.0.0",
|
||||||
"@opentelemetry/exporter-trace-otlp-http": "^0.200.0",
|
"@opentelemetry/exporter-trace-otlp-http": "^0.200.0",
|
||||||
"@opentelemetry/sdk-trace-base": "^2.0.0",
|
"@opentelemetry/sdk-trace-base": "^2.0.0",
|
||||||
"@opentelemetry/sdk-trace-node": "^2.0.0",
|
"@opentelemetry/sdk-trace-node": "^2.0.0",
|
||||||
"@opentelemetry/sdk-trace-web": "^2.0.0",
|
"@opentelemetry/sdk-trace-web": "^2.0.0",
|
||||||
"@opeoginni/github-copilot-openai-compatible": "0.1.19",
|
"@opeoginni/github-copilot-openai-compatible": "^0.1.21",
|
||||||
"@playwright/test": "^1.52.0",
|
"@playwright/test": "^1.52.0",
|
||||||
"@radix-ui/react-context-menu": "^2.2.16",
|
"@radix-ui/react-context-menu": "^2.2.16",
|
||||||
"@reduxjs/toolkit": "^2.2.5",
|
"@reduxjs/toolkit": "^2.2.5",
|
||||||
@@ -194,14 +210,15 @@
|
|||||||
"@types/fs-extra": "^11",
|
"@types/fs-extra": "^11",
|
||||||
"@types/he": "^1",
|
"@types/he": "^1",
|
||||||
"@types/html-to-text": "^9",
|
"@types/html-to-text": "^9",
|
||||||
|
"@types/js-yaml": "^4.0.9",
|
||||||
"@types/lodash": "^4.17.5",
|
"@types/lodash": "^4.17.5",
|
||||||
"@types/markdown-it": "^14",
|
"@types/markdown-it": "^14",
|
||||||
"@types/md5": "^2.3.5",
|
"@types/md5": "^2.3.5",
|
||||||
"@types/mime-types": "^3",
|
"@types/mime-types": "^3",
|
||||||
"@types/node": "^22.17.1",
|
"@types/node": "^22.17.1",
|
||||||
"@types/pako": "^1.0.2",
|
"@types/pako": "^1.0.2",
|
||||||
"@types/react": "^19.0.12",
|
"@types/react": "^19.2.7",
|
||||||
"@types/react-dom": "^19.0.4",
|
"@types/react-dom": "^19.2.3",
|
||||||
"@types/react-infinite-scroll-component": "^5.0.0",
|
"@types/react-infinite-scroll-component": "^5.0.0",
|
||||||
"@types/react-transition-group": "^4.4.12",
|
"@types/react-transition-group": "^4.4.12",
|
||||||
"@types/react-window": "^1",
|
"@types/react-window": "^1",
|
||||||
@@ -223,7 +240,7 @@
|
|||||||
"@viz-js/lang-dot": "^1.0.5",
|
"@viz-js/lang-dot": "^1.0.5",
|
||||||
"@viz-js/viz": "^3.14.0",
|
"@viz-js/viz": "^3.14.0",
|
||||||
"@xyflow/react": "^12.4.4",
|
"@xyflow/react": "^12.4.4",
|
||||||
"ai": "^5.0.68",
|
"ai": "^5.0.98",
|
||||||
"antd": "patch:antd@npm%3A5.27.0#~/.yarn/patches/antd-npm-5.27.0-aa91c36546.patch",
|
"antd": "patch:antd@npm%3A5.27.0#~/.yarn/patches/antd-npm-5.27.0-aa91c36546.patch",
|
||||||
"archiver": "^7.0.1",
|
"archiver": "^7.0.1",
|
||||||
"async-mutex": "^0.5.0",
|
"async-mutex": "^0.5.0",
|
||||||
@@ -233,6 +250,7 @@
|
|||||||
"check-disk-space": "3.4.0",
|
"check-disk-space": "3.4.0",
|
||||||
"cheerio": "^1.1.2",
|
"cheerio": "^1.1.2",
|
||||||
"chokidar": "^4.0.3",
|
"chokidar": "^4.0.3",
|
||||||
|
"claude-code-plugins": "1.0.3",
|
||||||
"cli-progress": "^3.12.0",
|
"cli-progress": "^3.12.0",
|
||||||
"clsx": "^2.1.1",
|
"clsx": "^2.1.1",
|
||||||
"code-inspector-plugin": "^0.20.14",
|
"code-inspector-plugin": "^0.20.14",
|
||||||
@@ -248,12 +266,12 @@
|
|||||||
"dotenv-cli": "^7.4.2",
|
"dotenv-cli": "^7.4.2",
|
||||||
"drizzle-kit": "^0.31.4",
|
"drizzle-kit": "^0.31.4",
|
||||||
"drizzle-orm": "^0.44.5",
|
"drizzle-orm": "^0.44.5",
|
||||||
"electron": "38.4.0",
|
"electron": "38.7.0",
|
||||||
"electron-builder": "26.0.15",
|
"electron-builder": "26.1.0",
|
||||||
"electron-devtools-installer": "^3.2.0",
|
"electron-devtools-installer": "^3.2.0",
|
||||||
"electron-reload": "^2.0.0-alpha.1",
|
"electron-reload": "^2.0.0-alpha.1",
|
||||||
"electron-store": "^8.2.0",
|
"electron-store": "^8.2.0",
|
||||||
"electron-updater": "6.6.4",
|
"electron-updater": "patch:electron-updater@npm%3A6.7.0#~/.yarn/patches/electron-updater-npm-6.7.0-47b11bb0d4.patch",
|
||||||
"electron-vite": "4.0.1",
|
"electron-vite": "4.0.1",
|
||||||
"electron-window-state": "^5.0.3",
|
"electron-window-state": "^5.0.3",
|
||||||
"emittery": "^1.0.3",
|
"emittery": "^1.0.3",
|
||||||
@@ -339,6 +357,7 @@
|
|||||||
"striptags": "^3.2.0",
|
"striptags": "^3.2.0",
|
||||||
"styled-components": "^6.1.11",
|
"styled-components": "^6.1.11",
|
||||||
"swr": "^2.3.6",
|
"swr": "^2.3.6",
|
||||||
|
"tailwind-merge": "^3.3.1",
|
||||||
"tailwindcss": "^4.1.13",
|
"tailwindcss": "^4.1.13",
|
||||||
"tar": "^7.4.3",
|
"tar": "^7.4.3",
|
||||||
"tiny-pinyin": "^1.3.2",
|
"tiny-pinyin": "^1.3.2",
|
||||||
@@ -364,19 +383,16 @@
|
|||||||
"zod": "^4.1.5"
|
"zod": "^4.1.5"
|
||||||
},
|
},
|
||||||
"resolutions": {
|
"resolutions": {
|
||||||
|
"@smithy/types": "4.7.1",
|
||||||
"@codemirror/language": "6.11.3",
|
"@codemirror/language": "6.11.3",
|
||||||
"@codemirror/lint": "6.8.5",
|
"@codemirror/lint": "6.8.5",
|
||||||
"@codemirror/view": "6.38.1",
|
"@codemirror/view": "6.38.1",
|
||||||
"@langchain/core@npm:^0.3.26": "patch:@langchain/core@npm%3A0.3.44#~/.yarn/patches/@langchain-core-npm-0.3.44-41d5c3cb0a.patch",
|
"@langchain/core@npm:^0.3.26": "patch:@langchain/core@npm%3A1.0.2#~/.yarn/patches/@langchain-core-npm-1.0.2-183ef83fe4.patch",
|
||||||
"@langchain/openai@npm:^0.3.16": "patch:@langchain/openai@npm%3A0.3.16#~/.yarn/patches/@langchain-openai-npm-0.3.16-e525b59526.patch",
|
|
||||||
"@langchain/openai@npm:>=0.1.0 <0.4.0": "patch:@langchain/openai@npm%3A0.3.16#~/.yarn/patches/@langchain-openai-npm-0.3.16-e525b59526.patch",
|
|
||||||
"app-builder-lib@npm:26.0.13": "patch:app-builder-lib@npm%3A26.0.13#~/.yarn/patches/app-builder-lib-npm-26.0.13-a064c9e1d0.patch",
|
|
||||||
"app-builder-lib@npm:26.0.15": "patch:app-builder-lib@npm%3A26.0.15#~/.yarn/patches/app-builder-lib-npm-26.0.15-360e5b0476.patch",
|
|
||||||
"atomically@npm:^1.7.0": "patch:atomically@npm%3A1.7.0#~/.yarn/patches/atomically-npm-1.7.0-e742e5293b.patch",
|
"atomically@npm:^1.7.0": "patch:atomically@npm%3A1.7.0#~/.yarn/patches/atomically-npm-1.7.0-e742e5293b.patch",
|
||||||
"esbuild": "^0.25.0",
|
"esbuild": "^0.25.0",
|
||||||
"file-stream-rotator@npm:^0.6.1": "patch:file-stream-rotator@npm%3A0.6.1#~/.yarn/patches/file-stream-rotator-npm-0.6.1-eab45fb13d.patch",
|
"file-stream-rotator@npm:^0.6.1": "patch:file-stream-rotator@npm%3A0.6.1#~/.yarn/patches/file-stream-rotator-npm-0.6.1-eab45fb13d.patch",
|
||||||
"libsql@npm:^0.4.4": "patch:libsql@npm%3A0.4.7#~/.yarn/patches/libsql-npm-0.4.7-444e260fb1.patch",
|
"libsql@npm:^0.4.4": "patch:libsql@npm%3A0.4.7#~/.yarn/patches/libsql-npm-0.4.7-444e260fb1.patch",
|
||||||
"node-abi": "4.12.0",
|
"node-abi": "4.24.0",
|
||||||
"openai@npm:^4.77.0": "npm:@cherrystudio/openai@6.5.0",
|
"openai@npm:^4.77.0": "npm:@cherrystudio/openai@6.5.0",
|
||||||
"openai@npm:^4.87.3": "npm:@cherrystudio/openai@6.5.0",
|
"openai@npm:^4.87.3": "npm:@cherrystudio/openai@6.5.0",
|
||||||
"pdf-parse@npm:1.1.1": "patch:pdf-parse@npm%3A1.1.1#~/.yarn/patches/pdf-parse-npm-1.1.1-04a6109b2a.patch",
|
"pdf-parse@npm:1.1.1": "patch:pdf-parse@npm%3A1.1.1#~/.yarn/patches/pdf-parse-npm-1.1.1-04a6109b2a.patch",
|
||||||
@@ -385,13 +401,20 @@
|
|||||||
"undici": "6.21.2",
|
"undici": "6.21.2",
|
||||||
"vite": "npm:rolldown-vite@7.1.5",
|
"vite": "npm:rolldown-vite@7.1.5",
|
||||||
"tesseract.js@npm:*": "patch:tesseract.js@npm%3A6.0.1#~/.yarn/patches/tesseract.js-npm-6.0.1-2562a7e46d.patch",
|
"tesseract.js@npm:*": "patch:tesseract.js@npm%3A6.0.1#~/.yarn/patches/tesseract.js-npm-6.0.1-2562a7e46d.patch",
|
||||||
"@ai-sdk/google@npm:2.0.20": "patch:@ai-sdk/google@npm%3A2.0.20#~/.yarn/patches/@ai-sdk-google-npm-2.0.20-b9102f9d54.patch",
|
"@ai-sdk/openai@npm:^2.0.52": "patch:@ai-sdk/openai@npm%3A2.0.52#~/.yarn/patches/@ai-sdk-openai-npm-2.0.52-b36d949c76.patch",
|
||||||
"@img/sharp-darwin-arm64": "0.34.3",
|
"@img/sharp-darwin-arm64": "0.34.3",
|
||||||
"@img/sharp-darwin-x64": "0.34.3",
|
"@img/sharp-darwin-x64": "0.34.3",
|
||||||
"@img/sharp-linux-arm": "0.34.3",
|
"@img/sharp-linux-arm": "0.34.3",
|
||||||
"@img/sharp-linux-arm64": "0.34.3",
|
"@img/sharp-linux-arm64": "0.34.3",
|
||||||
"@img/sharp-linux-x64": "0.34.3",
|
"@img/sharp-linux-x64": "0.34.3",
|
||||||
"@img/sharp-win32-x64": "0.34.3"
|
"@img/sharp-win32-x64": "0.34.3",
|
||||||
|
"openai@npm:5.12.2": "npm:@cherrystudio/openai@6.5.0",
|
||||||
|
"@langchain/openai@npm:>=0.1.0 <0.6.0": "patch:@langchain/openai@npm%3A1.0.0#~/.yarn/patches/@langchain-openai-npm-1.0.0-474d0ad9d4.patch",
|
||||||
|
"@langchain/openai@npm:^0.3.16": "patch:@langchain/openai@npm%3A1.0.0#~/.yarn/patches/@langchain-openai-npm-1.0.0-474d0ad9d4.patch",
|
||||||
|
"@langchain/openai@npm:>=0.2.0 <0.7.0": "patch:@langchain/openai@npm%3A1.0.0#~/.yarn/patches/@langchain-openai-npm-1.0.0-474d0ad9d4.patch",
|
||||||
|
"@ai-sdk/openai@npm:^2.0.42": "patch:@ai-sdk/openai@npm%3A2.0.72#~/.yarn/patches/@ai-sdk-openai-npm-2.0.72-234e68da87.patch",
|
||||||
|
"@ai-sdk/google@npm:^2.0.40": "patch:@ai-sdk/google@npm%3A2.0.40#~/.yarn/patches/@ai-sdk-google-npm-2.0.40-47e0eeee83.patch",
|
||||||
|
"@ai-sdk/openai-compatible@npm:^1.0.27": "patch:@ai-sdk/openai-compatible@npm%3A1.0.27#~/.yarn/patches/@ai-sdk-openai-compatible-npm-1.0.27-06f74278cf.patch"
|
||||||
},
|
},
|
||||||
"packageManager": "yarn@4.9.1",
|
"packageManager": "yarn@4.9.1",
|
||||||
"lint-staged": {
|
"lint-staged": {
|
||||||
|
|||||||
39
packages/ai-sdk-provider/README.md
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
# @cherrystudio/ai-sdk-provider
|
||||||
|
|
||||||
|
CherryIN provider bundle for the [Vercel AI SDK](https://ai-sdk.dev/).
|
||||||
|
It exposes the CherryIN OpenAI-compatible entrypoints and dynamically routes Anthropic and Gemini model ids to their CherryIN upstream equivalents.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install ai @cherrystudio/ai-sdk-provider @ai-sdk/anthropic @ai-sdk/google @ai-sdk/openai
|
||||||
|
# or
|
||||||
|
yarn add ai @cherrystudio/ai-sdk-provider @ai-sdk/anthropic @ai-sdk/google @ai-sdk/openai
|
||||||
|
```
|
||||||
|
|
||||||
|
> **Note**: This package requires peer dependencies `ai`, `@ai-sdk/anthropic`, `@ai-sdk/google`, and `@ai-sdk/openai` to be installed.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { createCherryIn, cherryIn } from '@cherrystudio/ai-sdk-provider'
|
||||||
|
|
||||||
|
const cherryInProvider = createCherryIn({
|
||||||
|
apiKey: process.env.CHERRYIN_API_KEY,
|
||||||
|
// optional overrides:
|
||||||
|
// baseURL: 'https://open.cherryin.net/v1',
|
||||||
|
// anthropicBaseURL: 'https://open.cherryin.net/anthropic',
|
||||||
|
// geminiBaseURL: 'https://open.cherryin.net/gemini/v1beta',
|
||||||
|
})
|
||||||
|
|
||||||
|
// Chat models will auto-route based on the model id prefix:
|
||||||
|
const openaiModel = cherryInProvider.chat('gpt-4o-mini')
|
||||||
|
const anthropicModel = cherryInProvider.chat('claude-3-5-sonnet-latest')
|
||||||
|
const geminiModel = cherryInProvider.chat('gemini-2.0-pro-exp')
|
||||||
|
|
||||||
|
const { text } = await openaiModel.invoke('Hello CherryIN!')
|
||||||
|
```
|
||||||
|
|
||||||
|
The provider also exposes `completion`, `responses`, `embedding`, `image`, `transcription`, and `speech` helpers aligned with the upstream APIs.
|
||||||
|
|
||||||
|
See [AI SDK docs](https://ai-sdk.dev/providers/community-providers/custom-providers) for configuring custom providers.
|
||||||
64
packages/ai-sdk-provider/package.json
Normal file
@@ -0,0 +1,64 @@
|
|||||||
|
{
|
||||||
|
"name": "@cherrystudio/ai-sdk-provider",
|
||||||
|
"version": "0.1.3",
|
||||||
|
"description": "Cherry Studio AI SDK provider bundle with CherryIN routing.",
|
||||||
|
"keywords": [
|
||||||
|
"ai-sdk",
|
||||||
|
"provider",
|
||||||
|
"cherryin",
|
||||||
|
"vercel-ai-sdk",
|
||||||
|
"cherry-studio"
|
||||||
|
],
|
||||||
|
"author": "Cherry Studio",
|
||||||
|
"license": "MIT",
|
||||||
|
"homepage": "https://github.com/CherryHQ/cherry-studio",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git+https://github.com/CherryHQ/cherry-studio.git",
|
||||||
|
"directory": "packages/ai-sdk-provider"
|
||||||
|
},
|
||||||
|
"bugs": {
|
||||||
|
"url": "https://github.com/CherryHQ/cherry-studio/issues"
|
||||||
|
},
|
||||||
|
"type": "module",
|
||||||
|
"main": "dist/index.cjs",
|
||||||
|
"module": "dist/index.js",
|
||||||
|
"types": "dist/index.d.ts",
|
||||||
|
"files": [
|
||||||
|
"dist"
|
||||||
|
],
|
||||||
|
"scripts": {
|
||||||
|
"build": "tsdown",
|
||||||
|
"dev": "tsc -w",
|
||||||
|
"clean": "rm -rf dist",
|
||||||
|
"test": "vitest run",
|
||||||
|
"test:watch": "vitest"
|
||||||
|
},
|
||||||
|
"peerDependencies": {
|
||||||
|
"@ai-sdk/anthropic": "^2.0.29",
|
||||||
|
"@ai-sdk/google": "^2.0.23",
|
||||||
|
"@ai-sdk/openai": "^2.0.64",
|
||||||
|
"ai": "^5.0.26"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"@ai-sdk/provider": "^2.0.0",
|
||||||
|
"@ai-sdk/provider-utils": "^3.0.17"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"tsdown": "^0.13.3",
|
||||||
|
"typescript": "^5.8.2",
|
||||||
|
"vitest": "^3.2.4"
|
||||||
|
},
|
||||||
|
"sideEffects": false,
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18.0.0"
|
||||||
|
},
|
||||||
|
"exports": {
|
||||||
|
".": {
|
||||||
|
"types": "./dist/index.d.ts",
|
||||||
|
"import": "./dist/index.js",
|
||||||
|
"require": "./dist/index.cjs",
|
||||||
|
"default": "./dist/index.js"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
347
packages/ai-sdk-provider/src/cherryin-provider.ts
Normal file
@@ -0,0 +1,347 @@
|
|||||||
|
import { AnthropicMessagesLanguageModel } from '@ai-sdk/anthropic/internal'
|
||||||
|
import { GoogleGenerativeAILanguageModel } from '@ai-sdk/google/internal'
|
||||||
|
import type { OpenAIProviderSettings } from '@ai-sdk/openai'
|
||||||
|
import {
|
||||||
|
OpenAIChatLanguageModel,
|
||||||
|
OpenAICompletionLanguageModel,
|
||||||
|
OpenAIEmbeddingModel,
|
||||||
|
OpenAIImageModel,
|
||||||
|
OpenAIResponsesLanguageModel,
|
||||||
|
OpenAISpeechModel,
|
||||||
|
OpenAITranscriptionModel
|
||||||
|
} from '@ai-sdk/openai/internal'
|
||||||
|
import {
|
||||||
|
type EmbeddingModelV2,
|
||||||
|
type ImageModelV2,
|
||||||
|
type LanguageModelV2,
|
||||||
|
type ProviderV2,
|
||||||
|
type SpeechModelV2,
|
||||||
|
type TranscriptionModelV2
|
||||||
|
} from '@ai-sdk/provider'
|
||||||
|
import type { FetchFunction } from '@ai-sdk/provider-utils'
|
||||||
|
import { loadApiKey, withoutTrailingSlash } from '@ai-sdk/provider-utils'
|
||||||
|
|
||||||
|
export const CHERRYIN_PROVIDER_NAME = 'cherryin' as const
|
||||||
|
export const DEFAULT_CHERRYIN_BASE_URL = 'https://open.cherryin.net/v1'
|
||||||
|
export const DEFAULT_CHERRYIN_ANTHROPIC_BASE_URL = 'https://open.cherryin.net/v1'
|
||||||
|
export const DEFAULT_CHERRYIN_GEMINI_BASE_URL = 'https://open.cherryin.net/v1beta/models'
|
||||||
|
|
||||||
|
const ANTHROPIC_PREFIX = /^anthropic\//i
|
||||||
|
const GEMINI_PREFIX = /^google\//i
|
||||||
|
// const GEMINI_EXCLUDED_SUFFIXES = ['-nothink', '-search']
|
||||||
|
|
||||||
|
type HeaderValue = string | undefined
|
||||||
|
|
||||||
|
type HeadersInput = Record<string, HeaderValue> | (() => Record<string, HeaderValue>)
|
||||||
|
|
||||||
|
export interface CherryInProviderSettings {
|
||||||
|
/**
|
||||||
|
* CherryIN API key.
|
||||||
|
*
|
||||||
|
* If omitted, the provider will read the `CHERRYIN_API_KEY` environment variable.
|
||||||
|
*/
|
||||||
|
apiKey?: string
|
||||||
|
/**
|
||||||
|
* Optional custom fetch implementation.
|
||||||
|
*/
|
||||||
|
fetch?: FetchFunction
|
||||||
|
/**
|
||||||
|
* Base URL for OpenAI-compatible CherryIN endpoints.
|
||||||
|
*
|
||||||
|
* Defaults to `https://open.cherryin.net/v1`.
|
||||||
|
*/
|
||||||
|
baseURL?: string
|
||||||
|
/**
|
||||||
|
* Base URL for Anthropic-compatible endpoints.
|
||||||
|
*
|
||||||
|
* Defaults to `https://open.cherryin.net/anthropic`.
|
||||||
|
*/
|
||||||
|
anthropicBaseURL?: string
|
||||||
|
/**
|
||||||
|
* Base URL for Gemini-compatible endpoints.
|
||||||
|
*
|
||||||
|
* Defaults to `https://open.cherryin.net/gemini/v1beta`.
|
||||||
|
*/
|
||||||
|
geminiBaseURL?: string
|
||||||
|
/**
|
||||||
|
* Optional static headers applied to every request.
|
||||||
|
*/
|
||||||
|
headers?: HeadersInput
|
||||||
|
/**
|
||||||
|
* Optional endpoint type to distinguish different endpoint behaviors.
|
||||||
|
*/
|
||||||
|
endpointType?: 'openai' | 'openai-response' | 'anthropic' | 'gemini' | 'image-generation' | 'jina-rerank'
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CherryInProvider extends ProviderV2 {
|
||||||
|
(modelId: string, settings?: OpenAIProviderSettings): LanguageModelV2
|
||||||
|
languageModel(modelId: string, settings?: OpenAIProviderSettings): LanguageModelV2
|
||||||
|
chat(modelId: string, settings?: OpenAIProviderSettings): LanguageModelV2
|
||||||
|
responses(modelId: string): LanguageModelV2
|
||||||
|
completion(modelId: string, settings?: OpenAIProviderSettings): LanguageModelV2
|
||||||
|
embedding(modelId: string, settings?: OpenAIProviderSettings): EmbeddingModelV2<string>
|
||||||
|
textEmbedding(modelId: string, settings?: OpenAIProviderSettings): EmbeddingModelV2<string>
|
||||||
|
textEmbeddingModel(modelId: string, settings?: OpenAIProviderSettings): EmbeddingModelV2<string>
|
||||||
|
image(modelId: string, settings?: OpenAIProviderSettings): ImageModelV2
|
||||||
|
imageModel(modelId: string, settings?: OpenAIProviderSettings): ImageModelV2
|
||||||
|
transcription(modelId: string): TranscriptionModelV2
|
||||||
|
transcriptionModel(modelId: string): TranscriptionModelV2
|
||||||
|
speech(modelId: string): SpeechModelV2
|
||||||
|
speechModel(modelId: string): SpeechModelV2
|
||||||
|
}
|
||||||
|
|
||||||
|
const resolveApiKey = (options: CherryInProviderSettings): string =>
|
||||||
|
loadApiKey({
|
||||||
|
apiKey: options.apiKey,
|
||||||
|
environmentVariableName: 'CHERRYIN_API_KEY',
|
||||||
|
description: 'CherryIN'
|
||||||
|
})
|
||||||
|
|
||||||
|
const isAnthropicModel = (modelId: string) => ANTHROPIC_PREFIX.test(modelId)
|
||||||
|
const isGeminiModel = (modelId: string) => GEMINI_PREFIX.test(modelId)
|
||||||
|
|
||||||
|
const createCustomFetch = (originalFetch?: any) => {
|
||||||
|
return async (url: string, options: any) => {
|
||||||
|
if (options?.body) {
|
||||||
|
try {
|
||||||
|
const body = JSON.parse(options.body)
|
||||||
|
if (body.tools && Array.isArray(body.tools) && body.tools.length === 0 && body.tool_choice) {
|
||||||
|
delete body.tool_choice
|
||||||
|
options.body = JSON.stringify(body)
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
// ignore error
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return originalFetch ? originalFetch(url, options) : fetch(url, options)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
class CherryInOpenAIChatLanguageModel extends OpenAIChatLanguageModel {
|
||||||
|
constructor(modelId: string, settings: any) {
|
||||||
|
super(modelId, {
|
||||||
|
...settings,
|
||||||
|
fetch: createCustomFetch(settings.fetch)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const resolveConfiguredHeaders = (headers?: HeadersInput): Record<string, HeaderValue> => {
|
||||||
|
if (typeof headers === 'function') {
|
||||||
|
return { ...headers() }
|
||||||
|
}
|
||||||
|
return headers ? { ...headers } : {}
|
||||||
|
}
|
||||||
|
|
||||||
|
const toBearerToken = (authorization?: string) => (authorization ? authorization.replace(/^Bearer\s+/i, '') : undefined)
|
||||||
|
|
||||||
|
const createJsonHeadersGetter = (options: CherryInProviderSettings): (() => Record<string, HeaderValue>) => {
|
||||||
|
return () => ({
|
||||||
|
Authorization: `Bearer ${resolveApiKey(options)}`,
|
||||||
|
'Content-Type': 'application/json',
|
||||||
|
...resolveConfiguredHeaders(options.headers)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const createAuthHeadersGetter = (options: CherryInProviderSettings): (() => Record<string, HeaderValue>) => {
|
||||||
|
return () => ({
|
||||||
|
Authorization: `Bearer ${resolveApiKey(options)}`,
|
||||||
|
...resolveConfiguredHeaders(options.headers)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
export const createCherryIn = (options: CherryInProviderSettings = {}): CherryInProvider => {
|
||||||
|
const {
|
||||||
|
baseURL = DEFAULT_CHERRYIN_BASE_URL,
|
||||||
|
anthropicBaseURL = DEFAULT_CHERRYIN_ANTHROPIC_BASE_URL,
|
||||||
|
geminiBaseURL = DEFAULT_CHERRYIN_GEMINI_BASE_URL,
|
||||||
|
fetch,
|
||||||
|
endpointType
|
||||||
|
} = options
|
||||||
|
|
||||||
|
const getJsonHeaders = createJsonHeadersGetter(options)
|
||||||
|
const getAuthHeaders = createAuthHeadersGetter(options)
|
||||||
|
|
||||||
|
const url = ({ path }: { path: string; modelId: string }) => `${withoutTrailingSlash(baseURL)}${path}`
|
||||||
|
|
||||||
|
const createAnthropicModel = (modelId: string) =>
|
||||||
|
new AnthropicMessagesLanguageModel(modelId, {
|
||||||
|
provider: `${CHERRYIN_PROVIDER_NAME}.anthropic`,
|
||||||
|
baseURL: anthropicBaseURL,
|
||||||
|
headers: () => {
|
||||||
|
const headers = getJsonHeaders()
|
||||||
|
const apiKey = toBearerToken(headers.Authorization)
|
||||||
|
return {
|
||||||
|
...headers,
|
||||||
|
'x-api-key': apiKey
|
||||||
|
}
|
||||||
|
},
|
||||||
|
fetch,
|
||||||
|
supportedUrls: () => ({
|
||||||
|
'image/*': [/^https?:\/\/.*$/]
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
const createGeminiModel = (modelId: string) =>
|
||||||
|
new GoogleGenerativeAILanguageModel(modelId, {
|
||||||
|
provider: `${CHERRYIN_PROVIDER_NAME}.google`,
|
||||||
|
baseURL: geminiBaseURL,
|
||||||
|
headers: () => {
|
||||||
|
const headers = getJsonHeaders()
|
||||||
|
const apiKey = toBearerToken(headers.Authorization)
|
||||||
|
return {
|
||||||
|
...headers,
|
||||||
|
'x-goog-api-key': apiKey
|
||||||
|
}
|
||||||
|
},
|
||||||
|
fetch,
|
||||||
|
generateId: () => `${CHERRYIN_PROVIDER_NAME}-${Date.now()}`,
|
||||||
|
supportedUrls: () => ({})
|
||||||
|
})
|
||||||
|
|
||||||
|
const createOpenAIChatModel = (modelId: string, settings: OpenAIProviderSettings = {}) =>
|
||||||
|
new CherryInOpenAIChatLanguageModel(modelId, {
|
||||||
|
provider: `${CHERRYIN_PROVIDER_NAME}.openai-chat`,
|
||||||
|
url,
|
||||||
|
headers: () => ({
|
||||||
|
...getJsonHeaders(),
|
||||||
|
...settings.headers
|
||||||
|
}),
|
||||||
|
fetch
|
||||||
|
})
|
||||||
|
|
||||||
|
const createChatModelByModelId = (modelId: string, settings: OpenAIProviderSettings = {}) => {
|
||||||
|
if (isAnthropicModel(modelId)) {
|
||||||
|
return createAnthropicModel(modelId)
|
||||||
|
}
|
||||||
|
if (isGeminiModel(modelId)) {
|
||||||
|
return createGeminiModel(modelId)
|
||||||
|
}
|
||||||
|
return new OpenAIResponsesLanguageModel(modelId, {
|
||||||
|
provider: `${CHERRYIN_PROVIDER_NAME}.openai`,
|
||||||
|
url,
|
||||||
|
headers: () => ({
|
||||||
|
...getJsonHeaders(),
|
||||||
|
...settings.headers
|
||||||
|
}),
|
||||||
|
fetch
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const createChatModel = (modelId: string, settings: OpenAIProviderSettings = {}) => {
|
||||||
|
if (!endpointType) return createChatModelByModelId(modelId, settings)
|
||||||
|
switch (endpointType) {
|
||||||
|
case 'anthropic':
|
||||||
|
return createAnthropicModel(modelId)
|
||||||
|
case 'gemini':
|
||||||
|
return createGeminiModel(modelId)
|
||||||
|
case 'openai':
|
||||||
|
return createOpenAIChatModel(modelId)
|
||||||
|
case 'openai-response':
|
||||||
|
default:
|
||||||
|
return new OpenAIResponsesLanguageModel(modelId, {
|
||||||
|
provider: `${CHERRYIN_PROVIDER_NAME}.openai`,
|
||||||
|
url,
|
||||||
|
headers: () => ({
|
||||||
|
...getJsonHeaders(),
|
||||||
|
...settings.headers
|
||||||
|
}),
|
||||||
|
fetch
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const createCompletionModel = (modelId: string, settings: OpenAIProviderSettings = {}) =>
|
||||||
|
new OpenAICompletionLanguageModel(modelId, {
|
||||||
|
provider: `${CHERRYIN_PROVIDER_NAME}.completion`,
|
||||||
|
url,
|
||||||
|
headers: () => ({
|
||||||
|
...getJsonHeaders(),
|
||||||
|
...settings.headers
|
||||||
|
}),
|
||||||
|
fetch
|
||||||
|
})
|
||||||
|
|
||||||
|
const createEmbeddingModel = (modelId: string, settings: OpenAIProviderSettings = {}) =>
|
||||||
|
new OpenAIEmbeddingModel(modelId, {
|
||||||
|
provider: `${CHERRYIN_PROVIDER_NAME}.embeddings`,
|
||||||
|
url,
|
||||||
|
headers: () => ({
|
||||||
|
...getJsonHeaders(),
|
||||||
|
...settings.headers
|
||||||
|
}),
|
||||||
|
fetch
|
||||||
|
})
|
||||||
|
|
||||||
|
const createResponsesModel = (modelId: string) =>
|
||||||
|
new OpenAIResponsesLanguageModel(modelId, {
|
||||||
|
provider: `${CHERRYIN_PROVIDER_NAME}.responses`,
|
||||||
|
url,
|
||||||
|
headers: () => ({
|
||||||
|
...getJsonHeaders()
|
||||||
|
}),
|
||||||
|
fetch
|
||||||
|
})
|
||||||
|
|
||||||
|
const createImageModel = (modelId: string, settings: OpenAIProviderSettings = {}) =>
|
||||||
|
new OpenAIImageModel(modelId, {
|
||||||
|
provider: `${CHERRYIN_PROVIDER_NAME}.image`,
|
||||||
|
url,
|
||||||
|
headers: () => ({
|
||||||
|
...getJsonHeaders(),
|
||||||
|
...settings.headers
|
||||||
|
}),
|
||||||
|
fetch
|
||||||
|
})
|
||||||
|
|
||||||
|
const createTranscriptionModel = (modelId: string) =>
|
||||||
|
new OpenAITranscriptionModel(modelId, {
|
||||||
|
provider: `${CHERRYIN_PROVIDER_NAME}.transcription`,
|
||||||
|
url,
|
||||||
|
headers: () => ({
|
||||||
|
...getAuthHeaders()
|
||||||
|
}),
|
||||||
|
fetch
|
||||||
|
})
|
||||||
|
|
||||||
|
const createSpeechModel = (modelId: string) =>
|
||||||
|
new OpenAISpeechModel(modelId, {
|
||||||
|
provider: `${CHERRYIN_PROVIDER_NAME}.speech`,
|
||||||
|
url,
|
||||||
|
headers: () => ({
|
||||||
|
...getJsonHeaders()
|
||||||
|
}),
|
||||||
|
fetch
|
||||||
|
})
|
||||||
|
|
||||||
|
const provider: CherryInProvider = function (modelId: string, settings?: OpenAIProviderSettings) {
|
||||||
|
if (new.target) {
|
||||||
|
throw new Error('CherryIN provider function cannot be called with the new keyword.')
|
||||||
|
}
|
||||||
|
|
||||||
|
return createChatModel(modelId, settings)
|
||||||
|
}
|
||||||
|
|
||||||
|
provider.languageModel = createChatModel
|
||||||
|
provider.chat = createOpenAIChatModel
|
||||||
|
|
||||||
|
provider.responses = createResponsesModel
|
||||||
|
provider.completion = createCompletionModel
|
||||||
|
|
||||||
|
provider.embedding = createEmbeddingModel
|
||||||
|
provider.textEmbedding = createEmbeddingModel
|
||||||
|
provider.textEmbeddingModel = createEmbeddingModel
|
||||||
|
|
||||||
|
provider.image = createImageModel
|
||||||
|
provider.imageModel = createImageModel
|
||||||
|
|
||||||
|
provider.transcription = createTranscriptionModel
|
||||||
|
provider.transcriptionModel = createTranscriptionModel
|
||||||
|
|
||||||
|
provider.speech = createSpeechModel
|
||||||
|
provider.speechModel = createSpeechModel
|
||||||
|
|
||||||
|
return provider
|
||||||
|
}
|
||||||
|
|
||||||
|
export const cherryIn = createCherryIn()
|
||||||
1
packages/ai-sdk-provider/src/index.ts
Normal file
@@ -0,0 +1 @@
|
|||||||
|
export * from './cherryin-provider'
|
||||||
19
packages/ai-sdk-provider/tsconfig.json
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"allowSyntheticDefaultImports": true,
|
||||||
|
"declaration": true,
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"forceConsistentCasingInFileNames": true,
|
||||||
|
"module": "ESNext",
|
||||||
|
"moduleResolution": "bundler",
|
||||||
|
"noEmitOnError": false,
|
||||||
|
"outDir": "./dist",
|
||||||
|
"resolveJsonModule": true,
|
||||||
|
"rootDir": "./src",
|
||||||
|
"skipLibCheck": true,
|
||||||
|
"strict": true,
|
||||||
|
"target": "ES2020"
|
||||||
|
},
|
||||||
|
"exclude": ["node_modules", "dist"],
|
||||||
|
"include": ["src/**/*"]
|
||||||
|
}
|
||||||
12
packages/ai-sdk-provider/tsdown.config.ts
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
import { defineConfig } from 'tsdown'
|
||||||
|
|
||||||
|
export default defineConfig({
|
||||||
|
entry: {
|
||||||
|
index: 'src/index.ts'
|
||||||
|
},
|
||||||
|
outDir: 'dist',
|
||||||
|
format: ['esm', 'cjs'],
|
||||||
|
clean: true,
|
||||||
|
dts: true,
|
||||||
|
tsconfig: 'tsconfig.json'
|
||||||
|
})
|
||||||
@@ -71,7 +71,7 @@ Cherry Studio AI Core 是一个基于 Vercel AI SDK 的统一 AI Provider 接口
|
|||||||
## 安装
|
## 安装
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install @cherrystudio/ai-core ai
|
npm install @cherrystudio/ai-core ai @ai-sdk/google @ai-sdk/openai
|
||||||
```
|
```
|
||||||
|
|
||||||
### React Native
|
### React Native
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@cherrystudio/ai-core",
|
"name": "@cherrystudio/ai-core",
|
||||||
"version": "1.0.1",
|
"version": "1.0.9",
|
||||||
"description": "Cherry Studio AI Core - Unified AI Provider Interface Based on Vercel AI SDK",
|
"description": "Cherry Studio AI Core - Unified AI Provider Interface Based on Vercel AI SDK",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"module": "dist/index.mjs",
|
"module": "dist/index.mjs",
|
||||||
@@ -33,17 +33,19 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://github.com/CherryHQ/cherry-studio#readme",
|
"homepage": "https://github.com/CherryHQ/cherry-studio#readme",
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
|
"@ai-sdk/google": "^2.0.36",
|
||||||
|
"@ai-sdk/openai": "^2.0.64",
|
||||||
|
"@cherrystudio/ai-sdk-provider": "^0.1.3",
|
||||||
"ai": "^5.0.26"
|
"ai": "^5.0.26"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@ai-sdk/anthropic": "^2.0.27",
|
"@ai-sdk/anthropic": "^2.0.49",
|
||||||
"@ai-sdk/azure": "^2.0.49",
|
"@ai-sdk/azure": "^2.0.74",
|
||||||
"@ai-sdk/deepseek": "^1.0.23",
|
"@ai-sdk/deepseek": "^1.0.29",
|
||||||
"@ai-sdk/openai": "^2.0.48",
|
"@ai-sdk/openai-compatible": "patch:@ai-sdk/openai-compatible@npm%3A1.0.27#~/.yarn/patches/@ai-sdk-openai-compatible-npm-1.0.27-06f74278cf.patch",
|
||||||
"@ai-sdk/openai-compatible": "^1.0.22",
|
|
||||||
"@ai-sdk/provider": "^2.0.0",
|
"@ai-sdk/provider": "^2.0.0",
|
||||||
"@ai-sdk/provider-utils": "^3.0.12",
|
"@ai-sdk/provider-utils": "^3.0.17",
|
||||||
"@ai-sdk/xai": "^2.0.26",
|
"@ai-sdk/xai": "^2.0.36",
|
||||||
"zod": "^4.1.5"
|
"zod": "^4.1.5"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
|
|||||||
180
packages/aiCore/src/__tests__/fixtures/mock-providers.ts
Normal file
@@ -0,0 +1,180 @@
|
|||||||
|
/**
|
||||||
|
* Mock Provider Instances
|
||||||
|
* Provides mock implementations for all supported AI providers
|
||||||
|
*/
|
||||||
|
|
||||||
|
import type { ImageModelV2, LanguageModelV2 } from '@ai-sdk/provider'
|
||||||
|
import { vi } from 'vitest'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a mock language model with customizable behavior
|
||||||
|
*/
|
||||||
|
export function createMockLanguageModel(overrides?: Partial<LanguageModelV2>): LanguageModelV2 {
|
||||||
|
return {
|
||||||
|
specificationVersion: 'v1',
|
||||||
|
provider: 'mock-provider',
|
||||||
|
modelId: 'mock-model',
|
||||||
|
defaultObjectGenerationMode: 'tool',
|
||||||
|
|
||||||
|
doGenerate: vi.fn().mockResolvedValue({
|
||||||
|
text: 'Mock response text',
|
||||||
|
finishReason: 'stop',
|
||||||
|
usage: {
|
||||||
|
promptTokens: 10,
|
||||||
|
completionTokens: 20,
|
||||||
|
totalTokens: 30
|
||||||
|
},
|
||||||
|
rawCall: { rawPrompt: null, rawSettings: {} },
|
||||||
|
rawResponse: { headers: {} },
|
||||||
|
warnings: []
|
||||||
|
}),
|
||||||
|
|
||||||
|
doStream: vi.fn().mockReturnValue({
|
||||||
|
stream: (async function* () {
|
||||||
|
yield {
|
||||||
|
type: 'text-delta',
|
||||||
|
textDelta: 'Mock '
|
||||||
|
}
|
||||||
|
yield {
|
||||||
|
type: 'text-delta',
|
||||||
|
textDelta: 'streaming '
|
||||||
|
}
|
||||||
|
yield {
|
||||||
|
type: 'text-delta',
|
||||||
|
textDelta: 'response'
|
||||||
|
}
|
||||||
|
yield {
|
||||||
|
type: 'finish',
|
||||||
|
finishReason: 'stop',
|
||||||
|
usage: {
|
||||||
|
promptTokens: 10,
|
||||||
|
completionTokens: 15,
|
||||||
|
totalTokens: 25
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})(),
|
||||||
|
rawCall: { rawPrompt: null, rawSettings: {} },
|
||||||
|
rawResponse: { headers: {} },
|
||||||
|
warnings: []
|
||||||
|
}),
|
||||||
|
|
||||||
|
...overrides
|
||||||
|
} as LanguageModelV2
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a mock image model with customizable behavior
|
||||||
|
*/
|
||||||
|
export function createMockImageModel(overrides?: Partial<ImageModelV2>): ImageModelV2 {
|
||||||
|
return {
|
||||||
|
specificationVersion: 'v2',
|
||||||
|
provider: 'mock-provider',
|
||||||
|
modelId: 'mock-image-model',
|
||||||
|
|
||||||
|
doGenerate: vi.fn().mockResolvedValue({
|
||||||
|
images: [
|
||||||
|
{
|
||||||
|
base64: 'mock-base64-image-data',
|
||||||
|
uint8Array: new Uint8Array([1, 2, 3, 4, 5]),
|
||||||
|
mimeType: 'image/png'
|
||||||
|
}
|
||||||
|
],
|
||||||
|
warnings: []
|
||||||
|
}),
|
||||||
|
|
||||||
|
...overrides
|
||||||
|
} as ImageModelV2
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Mock provider configurations for testing
|
||||||
|
*/
|
||||||
|
export const mockProviderConfigs = {
|
||||||
|
openai: {
|
||||||
|
apiKey: 'sk-test-openai-key-123456789',
|
||||||
|
baseURL: 'https://api.openai.com/v1',
|
||||||
|
organization: 'test-org'
|
||||||
|
},
|
||||||
|
|
||||||
|
anthropic: {
|
||||||
|
apiKey: 'sk-ant-test-key-123456789',
|
||||||
|
baseURL: 'https://api.anthropic.com'
|
||||||
|
},
|
||||||
|
|
||||||
|
google: {
|
||||||
|
apiKey: 'test-google-api-key-123456789',
|
||||||
|
baseURL: 'https://generativelanguage.googleapis.com/v1'
|
||||||
|
},
|
||||||
|
|
||||||
|
xai: {
|
||||||
|
apiKey: 'xai-test-key-123456789',
|
||||||
|
baseURL: 'https://api.x.ai/v1'
|
||||||
|
},
|
||||||
|
|
||||||
|
azure: {
|
||||||
|
apiKey: 'test-azure-key-123456789',
|
||||||
|
resourceName: 'test-resource',
|
||||||
|
deployment: 'test-deployment'
|
||||||
|
},
|
||||||
|
|
||||||
|
deepseek: {
|
||||||
|
apiKey: 'sk-test-deepseek-key-123456789',
|
||||||
|
baseURL: 'https://api.deepseek.com/v1'
|
||||||
|
},
|
||||||
|
|
||||||
|
openrouter: {
|
||||||
|
apiKey: 'sk-or-test-key-123456789',
|
||||||
|
baseURL: 'https://openrouter.ai/api/v1'
|
||||||
|
},
|
||||||
|
|
||||||
|
huggingface: {
|
||||||
|
apiKey: 'hf_test_key_123456789',
|
||||||
|
baseURL: 'https://api-inference.huggingface.co'
|
||||||
|
},
|
||||||
|
|
||||||
|
'openai-compatible': {
|
||||||
|
apiKey: 'test-compatible-key-123456789',
|
||||||
|
baseURL: 'https://api.example.com/v1',
|
||||||
|
name: 'test-provider'
|
||||||
|
},
|
||||||
|
|
||||||
|
'openai-chat': {
|
||||||
|
apiKey: 'sk-test-chat-key-123456789',
|
||||||
|
baseURL: 'https://api.openai.com/v1'
|
||||||
|
}
|
||||||
|
} as const
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Mock provider instances for testing
|
||||||
|
*/
|
||||||
|
export const mockProviderInstances = {
|
||||||
|
openai: {
|
||||||
|
name: 'openai-mock',
|
||||||
|
languageModel: createMockLanguageModel({ provider: 'openai', modelId: 'gpt-4' }),
|
||||||
|
imageModel: createMockImageModel({ provider: 'openai', modelId: 'dall-e-3' })
|
||||||
|
},
|
||||||
|
|
||||||
|
anthropic: {
|
||||||
|
name: 'anthropic-mock',
|
||||||
|
languageModel: createMockLanguageModel({ provider: 'anthropic', modelId: 'claude-3-5-sonnet-20241022' })
|
||||||
|
},
|
||||||
|
|
||||||
|
google: {
|
||||||
|
name: 'google-mock',
|
||||||
|
languageModel: createMockLanguageModel({ provider: 'google', modelId: 'gemini-2.0-flash-exp' }),
|
||||||
|
imageModel: createMockImageModel({ provider: 'google', modelId: 'imagen-3.0-generate-001' })
|
||||||
|
},
|
||||||
|
|
||||||
|
xai: {
|
||||||
|
name: 'xai-mock',
|
||||||
|
languageModel: createMockLanguageModel({ provider: 'xai', modelId: 'grok-2-latest' }),
|
||||||
|
imageModel: createMockImageModel({ provider: 'xai', modelId: 'grok-2-image-latest' })
|
||||||
|
},
|
||||||
|
|
||||||
|
deepseek: {
|
||||||
|
name: 'deepseek-mock',
|
||||||
|
languageModel: createMockLanguageModel({ provider: 'deepseek', modelId: 'deepseek-chat' })
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export type ProviderId = keyof typeof mockProviderConfigs
|
||||||
331
packages/aiCore/src/__tests__/fixtures/mock-responses.ts
Normal file
@@ -0,0 +1,331 @@
|
|||||||
|
/**
|
||||||
|
* Mock Responses
|
||||||
|
* Provides realistic mock responses for all provider types
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { jsonSchema, type ModelMessage, type Tool } from 'ai'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Standard test messages for all scenarios
|
||||||
|
*/
|
||||||
|
export const testMessages = {
|
||||||
|
simple: [{ role: 'user' as const, content: 'Hello, how are you?' }],
|
||||||
|
|
||||||
|
conversation: [
|
||||||
|
{ role: 'user' as const, content: 'What is the capital of France?' },
|
||||||
|
{ role: 'assistant' as const, content: 'The capital of France is Paris.' },
|
||||||
|
{ role: 'user' as const, content: 'What is its population?' }
|
||||||
|
],
|
||||||
|
|
||||||
|
withSystem: [
|
||||||
|
{ role: 'system' as const, content: 'You are a helpful assistant that provides concise answers.' },
|
||||||
|
{ role: 'user' as const, content: 'Explain quantum computing in one sentence.' }
|
||||||
|
],
|
||||||
|
|
||||||
|
withImages: [
|
||||||
|
{
|
||||||
|
role: 'user' as const,
|
||||||
|
content: [
|
||||||
|
{ type: 'text' as const, text: 'What is in this image?' },
|
||||||
|
{
|
||||||
|
type: 'image' as const,
|
||||||
|
image:
|
||||||
|
'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=='
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
|
||||||
|
toolUse: [{ role: 'user' as const, content: 'What is the weather in San Francisco?' }],
|
||||||
|
|
||||||
|
multiTurn: [
|
||||||
|
{ role: 'user' as const, content: 'Can you help me with a math problem?' },
|
||||||
|
{ role: 'assistant' as const, content: 'Of course! What math problem would you like help with?' },
|
||||||
|
{ role: 'user' as const, content: 'What is 15 * 23?' },
|
||||||
|
{ role: 'assistant' as const, content: '15 * 23 = 345' },
|
||||||
|
{ role: 'user' as const, content: 'Now divide that by 5' }
|
||||||
|
]
|
||||||
|
} satisfies Record<string, ModelMessage[]>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Standard test tools for tool calling scenarios
|
||||||
|
*/
|
||||||
|
export const testTools: Record<string, Tool> = {
|
||||||
|
getWeather: {
|
||||||
|
description: 'Get the current weather in a given location',
|
||||||
|
inputSchema: jsonSchema({
|
||||||
|
type: 'object',
|
||||||
|
properties: {
|
||||||
|
location: {
|
||||||
|
type: 'string',
|
||||||
|
description: 'The city and state, e.g. San Francisco, CA'
|
||||||
|
},
|
||||||
|
unit: {
|
||||||
|
type: 'string',
|
||||||
|
enum: ['celsius', 'fahrenheit'],
|
||||||
|
description: 'The temperature unit to use'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
required: ['location']
|
||||||
|
}),
|
||||||
|
execute: async ({ location, unit = 'fahrenheit' }) => {
|
||||||
|
return {
|
||||||
|
location,
|
||||||
|
temperature: unit === 'celsius' ? 22 : 72,
|
||||||
|
unit,
|
||||||
|
condition: 'sunny'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
calculate: {
|
||||||
|
description: 'Perform a mathematical calculation',
|
||||||
|
inputSchema: jsonSchema({
|
||||||
|
type: 'object',
|
||||||
|
properties: {
|
||||||
|
operation: {
|
||||||
|
type: 'string',
|
||||||
|
enum: ['add', 'subtract', 'multiply', 'divide'],
|
||||||
|
description: 'The operation to perform'
|
||||||
|
},
|
||||||
|
a: {
|
||||||
|
type: 'number',
|
||||||
|
description: 'The first number'
|
||||||
|
},
|
||||||
|
b: {
|
||||||
|
type: 'number',
|
||||||
|
description: 'The second number'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
required: ['operation', 'a', 'b']
|
||||||
|
}),
|
||||||
|
execute: async ({ operation, a, b }) => {
|
||||||
|
const operations = {
|
||||||
|
add: (x: number, y: number) => x + y,
|
||||||
|
subtract: (x: number, y: number) => x - y,
|
||||||
|
multiply: (x: number, y: number) => x * y,
|
||||||
|
divide: (x: number, y: number) => x / y
|
||||||
|
}
|
||||||
|
return { result: operations[operation as keyof typeof operations](a, b) }
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
searchDatabase: {
|
||||||
|
description: 'Search for information in a database',
|
||||||
|
inputSchema: jsonSchema({
|
||||||
|
type: 'object',
|
||||||
|
properties: {
|
||||||
|
query: {
|
||||||
|
type: 'string',
|
||||||
|
description: 'The search query'
|
||||||
|
},
|
||||||
|
limit: {
|
||||||
|
type: 'number',
|
||||||
|
description: 'Maximum number of results to return',
|
||||||
|
default: 10
|
||||||
|
}
|
||||||
|
},
|
||||||
|
required: ['query']
|
||||||
|
}),
|
||||||
|
execute: async ({ query, limit = 10 }) => {
|
||||||
|
return {
|
||||||
|
results: [
|
||||||
|
{ id: 1, title: `Result 1 for ${query}`, relevance: 0.95 },
|
||||||
|
{ id: 2, title: `Result 2 for ${query}`, relevance: 0.87 }
|
||||||
|
].slice(0, limit)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Mock streaming chunks for different providers
|
||||||
|
*/
|
||||||
|
export const mockStreamingChunks = {
|
||||||
|
text: [
|
||||||
|
{ type: 'text-delta' as const, textDelta: 'Hello' },
|
||||||
|
{ type: 'text-delta' as const, textDelta: ', ' },
|
||||||
|
{ type: 'text-delta' as const, textDelta: 'this ' },
|
||||||
|
{ type: 'text-delta' as const, textDelta: 'is ' },
|
||||||
|
{ type: 'text-delta' as const, textDelta: 'a ' },
|
||||||
|
{ type: 'text-delta' as const, textDelta: 'test.' }
|
||||||
|
],
|
||||||
|
|
||||||
|
withToolCall: [
|
||||||
|
{ type: 'text-delta' as const, textDelta: 'Let me check the weather for you.' },
|
||||||
|
{
|
||||||
|
type: 'tool-call-delta' as const,
|
||||||
|
toolCallType: 'function' as const,
|
||||||
|
toolCallId: 'call_123',
|
||||||
|
toolName: 'getWeather',
|
||||||
|
argsTextDelta: '{"location":'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: 'tool-call-delta' as const,
|
||||||
|
toolCallType: 'function' as const,
|
||||||
|
toolCallId: 'call_123',
|
||||||
|
toolName: 'getWeather',
|
||||||
|
argsTextDelta: ' "San Francisco, CA"}'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
type: 'tool-call' as const,
|
||||||
|
toolCallType: 'function' as const,
|
||||||
|
toolCallId: 'call_123',
|
||||||
|
toolName: 'getWeather',
|
||||||
|
args: { location: 'San Francisco, CA' }
|
||||||
|
}
|
||||||
|
],
|
||||||
|
|
||||||
|
withFinish: [
|
||||||
|
{ type: 'text-delta' as const, textDelta: 'Complete response.' },
|
||||||
|
{
|
||||||
|
type: 'finish' as const,
|
||||||
|
finishReason: 'stop' as const,
|
||||||
|
usage: {
|
||||||
|
promptTokens: 10,
|
||||||
|
completionTokens: 5,
|
||||||
|
totalTokens: 15
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Mock complete responses for non-streaming scenarios
|
||||||
|
*/
|
||||||
|
export const mockCompleteResponses = {
|
||||||
|
simple: {
|
||||||
|
text: 'This is a simple response.',
|
||||||
|
finishReason: 'stop' as const,
|
||||||
|
usage: {
|
||||||
|
promptTokens: 15,
|
||||||
|
completionTokens: 8,
|
||||||
|
totalTokens: 23
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
withToolCalls: {
|
||||||
|
text: 'I will check the weather for you.',
|
||||||
|
toolCalls: [
|
||||||
|
{
|
||||||
|
toolCallId: 'call_456',
|
||||||
|
toolName: 'getWeather',
|
||||||
|
args: { location: 'New York, NY', unit: 'celsius' }
|
||||||
|
}
|
||||||
|
],
|
||||||
|
finishReason: 'tool-calls' as const,
|
||||||
|
usage: {
|
||||||
|
promptTokens: 25,
|
||||||
|
completionTokens: 12,
|
||||||
|
totalTokens: 37
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
withWarnings: {
|
||||||
|
text: 'Response with warnings.',
|
||||||
|
finishReason: 'stop' as const,
|
||||||
|
usage: {
|
||||||
|
promptTokens: 10,
|
||||||
|
completionTokens: 5,
|
||||||
|
totalTokens: 15
|
||||||
|
},
|
||||||
|
warnings: [
|
||||||
|
{
|
||||||
|
type: 'unsupported-setting' as const,
|
||||||
|
message: 'Temperature parameter not supported for this model'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Mock image generation responses
|
||||||
|
*/
|
||||||
|
export const mockImageResponses = {
|
||||||
|
single: {
|
||||||
|
image: {
|
||||||
|
base64: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==',
|
||||||
|
uint8Array: new Uint8Array([137, 80, 78, 71, 13, 10, 26, 10, 0, 0, 0, 13, 73, 72, 68, 82]),
|
||||||
|
mimeType: 'image/png' as const
|
||||||
|
},
|
||||||
|
warnings: []
|
||||||
|
},
|
||||||
|
|
||||||
|
multiple: {
|
||||||
|
images: [
|
||||||
|
{
|
||||||
|
base64: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==',
|
||||||
|
uint8Array: new Uint8Array([137, 80, 78, 71]),
|
||||||
|
mimeType: 'image/png' as const
|
||||||
|
},
|
||||||
|
{
|
||||||
|
base64: 'iVBORw0KGgoAAAANSUhEUgAAAAIAAAACCAYAAABytg0kAAAAEklEQVR42mNk+M9QzwAEjDAGACCKAgdZ9zImAAAAAElFTkSuQmCC',
|
||||||
|
uint8Array: new Uint8Array([137, 80, 78, 71]),
|
||||||
|
mimeType: 'image/png' as const
|
||||||
|
}
|
||||||
|
],
|
||||||
|
warnings: []
|
||||||
|
},
|
||||||
|
|
||||||
|
withProviderMetadata: {
|
||||||
|
image: {
|
||||||
|
base64: 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==',
|
||||||
|
uint8Array: new Uint8Array([137, 80, 78, 71]),
|
||||||
|
mimeType: 'image/png' as const
|
||||||
|
},
|
||||||
|
providerMetadata: {
|
||||||
|
openai: {
|
||||||
|
images: [
|
||||||
|
{
|
||||||
|
revisedPrompt: 'A detailed and enhanced version of the original prompt'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
warnings: []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Mock error responses
|
||||||
|
*/
|
||||||
|
export const mockErrors = {
|
||||||
|
invalidApiKey: {
|
||||||
|
name: 'APIError',
|
||||||
|
message: 'Invalid API key provided',
|
||||||
|
statusCode: 401
|
||||||
|
},
|
||||||
|
|
||||||
|
rateLimitExceeded: {
|
||||||
|
name: 'RateLimitError',
|
||||||
|
message: 'Rate limit exceeded. Please try again later.',
|
||||||
|
statusCode: 429,
|
||||||
|
headers: {
|
||||||
|
'retry-after': '60'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
modelNotFound: {
|
||||||
|
name: 'ModelNotFoundError',
|
||||||
|
message: 'The requested model was not found',
|
||||||
|
statusCode: 404
|
||||||
|
},
|
||||||
|
|
||||||
|
contextLengthExceeded: {
|
||||||
|
name: 'ContextLengthError',
|
||||||
|
message: "This model's maximum context length is 4096 tokens",
|
||||||
|
statusCode: 400
|
||||||
|
},
|
||||||
|
|
||||||
|
timeout: {
|
||||||
|
name: 'TimeoutError',
|
||||||
|
message: 'Request timed out after 30000ms',
|
||||||
|
code: 'ETIMEDOUT'
|
||||||
|
},
|
||||||
|
|
||||||
|
networkError: {
|
||||||
|
name: 'NetworkError',
|
||||||
|
message: 'Network connection failed',
|
||||||
|
code: 'ECONNREFUSED'
|
||||||
|
}
|
||||||
|
}
|
||||||
329
packages/aiCore/src/__tests__/helpers/provider-test-utils.ts
Normal file
@@ -0,0 +1,329 @@
|
|||||||
|
/**
|
||||||
|
* Provider-Specific Test Utilities
|
||||||
|
* Helper functions for testing individual providers with all their parameters
|
||||||
|
*/
|
||||||
|
|
||||||
|
import type { Tool } from 'ai'
|
||||||
|
import { expect } from 'vitest'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provider parameter configurations for comprehensive testing
|
||||||
|
*/
|
||||||
|
export const providerParameterMatrix = {
|
||||||
|
openai: {
|
||||||
|
models: ['gpt-4', 'gpt-4-turbo', 'gpt-3.5-turbo', 'gpt-4o'],
|
||||||
|
parameters: {
|
||||||
|
temperature: [0, 0.5, 0.7, 1.0, 1.5, 2.0],
|
||||||
|
maxTokens: [100, 500, 1000, 2000, 4000],
|
||||||
|
topP: [0.1, 0.5, 0.9, 1.0],
|
||||||
|
frequencyPenalty: [-2.0, -1.0, 0, 1.0, 2.0],
|
||||||
|
presencePenalty: [-2.0, -1.0, 0, 1.0, 2.0],
|
||||||
|
stop: [undefined, ['stop'], ['STOP', 'END']],
|
||||||
|
seed: [undefined, 12345, 67890],
|
||||||
|
responseFormat: [undefined, { type: 'json_object' as const }],
|
||||||
|
user: [undefined, 'test-user-123']
|
||||||
|
},
|
||||||
|
toolChoice: ['auto', 'required', 'none', { type: 'function' as const, name: 'getWeather' }],
|
||||||
|
parallelToolCalls: [true, false]
|
||||||
|
},
|
||||||
|
|
||||||
|
anthropic: {
|
||||||
|
models: ['claude-3-5-sonnet-20241022', 'claude-3-opus-20240229', 'claude-3-haiku-20240307'],
|
||||||
|
parameters: {
|
||||||
|
temperature: [0, 0.5, 1.0],
|
||||||
|
maxTokens: [100, 1000, 4000, 8000],
|
||||||
|
topP: [0.1, 0.5, 0.9, 1.0],
|
||||||
|
topK: [undefined, 1, 5, 10, 40],
|
||||||
|
stop: [undefined, ['Human:', 'Assistant:']],
|
||||||
|
metadata: [undefined, { userId: 'test-123' }]
|
||||||
|
},
|
||||||
|
toolChoice: ['auto', 'any', { type: 'tool' as const, name: 'getWeather' }]
|
||||||
|
},
|
||||||
|
|
||||||
|
google: {
|
||||||
|
models: ['gemini-2.0-flash-exp', 'gemini-1.5-pro', 'gemini-1.5-flash'],
|
||||||
|
parameters: {
|
||||||
|
temperature: [0, 0.5, 0.9, 1.0],
|
||||||
|
maxTokens: [100, 1000, 2000, 8000],
|
||||||
|
topP: [0.1, 0.5, 0.95, 1.0],
|
||||||
|
topK: [undefined, 1, 16, 40],
|
||||||
|
stopSequences: [undefined, ['END'], ['STOP', 'TERMINATE']]
|
||||||
|
},
|
||||||
|
safetySettings: [
|
||||||
|
undefined,
|
||||||
|
[
|
||||||
|
{ category: 'HARM_CATEGORY_HARASSMENT', threshold: 'BLOCK_MEDIUM_AND_ABOVE' },
|
||||||
|
{ category: 'HARM_CATEGORY_HATE_SPEECH', threshold: 'BLOCK_ONLY_HIGH' }
|
||||||
|
]
|
||||||
|
]
|
||||||
|
},
|
||||||
|
|
||||||
|
xai: {
|
||||||
|
models: ['grok-2-latest', 'grok-2-1212'],
|
||||||
|
parameters: {
|
||||||
|
temperature: [0, 0.5, 1.0, 1.5],
|
||||||
|
maxTokens: [100, 500, 2000, 4000],
|
||||||
|
topP: [0.1, 0.5, 0.9, 1.0],
|
||||||
|
stop: [undefined, ['STOP'], ['END', 'TERMINATE']],
|
||||||
|
seed: [undefined, 12345]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
deepseek: {
|
||||||
|
models: ['deepseek-chat', 'deepseek-coder'],
|
||||||
|
parameters: {
|
||||||
|
temperature: [0, 0.5, 1.0],
|
||||||
|
maxTokens: [100, 1000, 4000],
|
||||||
|
topP: [0.1, 0.5, 0.95],
|
||||||
|
frequencyPenalty: [0, 0.5, 1.0],
|
||||||
|
presencePenalty: [0, 0.5, 1.0],
|
||||||
|
stop: [undefined, ['```'], ['END']]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
azure: {
|
||||||
|
deployments: ['gpt-4-deployment', 'gpt-35-turbo-deployment'],
|
||||||
|
parameters: {
|
||||||
|
temperature: [0, 0.7, 1.0],
|
||||||
|
maxTokens: [100, 1000, 2000],
|
||||||
|
topP: [0.1, 0.5, 0.95],
|
||||||
|
frequencyPenalty: [0, 1.0],
|
||||||
|
presencePenalty: [0, 1.0],
|
||||||
|
stop: [undefined, ['STOP']]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} as const
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates test cases for all parameter combinations
|
||||||
|
*/
|
||||||
|
export function generateParameterTestCases<T extends Record<string, any[]>>(
|
||||||
|
params: T,
|
||||||
|
maxCombinations = 50
|
||||||
|
): Array<Partial<{ [K in keyof T]: T[K][number] }>> {
|
||||||
|
const keys = Object.keys(params) as Array<keyof T>
|
||||||
|
const testCases: Array<Partial<{ [K in keyof T]: T[K][number] }>> = []
|
||||||
|
|
||||||
|
// Generate combinations using sampling strategy for large parameter spaces
|
||||||
|
const totalCombinations = keys.reduce((acc, key) => acc * params[key].length, 1)
|
||||||
|
|
||||||
|
if (totalCombinations <= maxCombinations) {
|
||||||
|
// Generate all combinations if total is small
|
||||||
|
generateAllCombinations(params, keys, 0, {}, testCases)
|
||||||
|
} else {
|
||||||
|
// Sample diverse combinations if total is large
|
||||||
|
generateSampledCombinations(params, keys, maxCombinations, testCases)
|
||||||
|
}
|
||||||
|
|
||||||
|
return testCases
|
||||||
|
}
|
||||||
|
|
||||||
|
function generateAllCombinations<T extends Record<string, any[]>>(
|
||||||
|
params: T,
|
||||||
|
keys: Array<keyof T>,
|
||||||
|
index: number,
|
||||||
|
current: Partial<{ [K in keyof T]: T[K][number] }>,
|
||||||
|
results: Array<Partial<{ [K in keyof T]: T[K][number] }>>
|
||||||
|
) {
|
||||||
|
if (index === keys.length) {
|
||||||
|
results.push({ ...current })
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
const key = keys[index]
|
||||||
|
for (const value of params[key]) {
|
||||||
|
generateAllCombinations(params, keys, index + 1, { ...current, [key]: value }, results)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function generateSampledCombinations<T extends Record<string, any[]>>(
|
||||||
|
params: T,
|
||||||
|
keys: Array<keyof T>,
|
||||||
|
count: number,
|
||||||
|
results: Array<Partial<{ [K in keyof T]: T[K][number] }>>
|
||||||
|
) {
|
||||||
|
// Generate edge cases first (min/max values)
|
||||||
|
const edgeCase1: any = {}
|
||||||
|
const edgeCase2: any = {}
|
||||||
|
|
||||||
|
for (const key of keys) {
|
||||||
|
edgeCase1[key] = params[key][0]
|
||||||
|
edgeCase2[key] = params[key][params[key].length - 1]
|
||||||
|
}
|
||||||
|
|
||||||
|
results.push(edgeCase1, edgeCase2)
|
||||||
|
|
||||||
|
// Generate random combinations for the rest
|
||||||
|
for (let i = results.length; i < count; i++) {
|
||||||
|
const combination: any = {}
|
||||||
|
for (const key of keys) {
|
||||||
|
const values = params[key]
|
||||||
|
combination[key] = values[Math.floor(Math.random() * values.length)]
|
||||||
|
}
|
||||||
|
results.push(combination)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validates that all provider-specific parameters are correctly passed through
|
||||||
|
*/
|
||||||
|
export function validateProviderParams(providerId: string, actualParams: any, expectedParams: any): void {
|
||||||
|
const requiredFields: Record<string, string[]> = {
|
||||||
|
openai: ['model', 'messages'],
|
||||||
|
anthropic: ['model', 'messages'],
|
||||||
|
google: ['model', 'contents'],
|
||||||
|
xai: ['model', 'messages'],
|
||||||
|
deepseek: ['model', 'messages'],
|
||||||
|
azure: ['messages']
|
||||||
|
}
|
||||||
|
|
||||||
|
const fields = requiredFields[providerId] || ['model', 'messages']
|
||||||
|
|
||||||
|
for (const field of fields) {
|
||||||
|
expect(actualParams).toHaveProperty(field)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate optional parameters if they were provided
|
||||||
|
const optionalParams = ['temperature', 'max_tokens', 'top_p', 'stop', 'tools']
|
||||||
|
|
||||||
|
for (const param of optionalParams) {
|
||||||
|
if (expectedParams[param] !== undefined) {
|
||||||
|
expect(actualParams[param]).toEqual(expectedParams[param])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a comprehensive test suite for a provider
|
||||||
|
*/
|
||||||
|
// oxlint-disable-next-line no-unused-vars
|
||||||
|
export function createProviderTestSuite(_providerId: string) {
|
||||||
|
return {
|
||||||
|
testBasicCompletion: async (executor: any, model: string) => {
|
||||||
|
const result = await executor.generateText({
|
||||||
|
model,
|
||||||
|
messages: [{ role: 'user' as const, content: 'Hello' }]
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(result).toBeDefined()
|
||||||
|
expect(result.text).toBeDefined()
|
||||||
|
expect(typeof result.text).toBe('string')
|
||||||
|
},
|
||||||
|
|
||||||
|
testStreaming: async (executor: any, model: string) => {
|
||||||
|
const chunks: any[] = []
|
||||||
|
const result = await executor.streamText({
|
||||||
|
model,
|
||||||
|
messages: [{ role: 'user' as const, content: 'Hello' }]
|
||||||
|
})
|
||||||
|
|
||||||
|
for await (const chunk of result.textStream) {
|
||||||
|
chunks.push(chunk)
|
||||||
|
}
|
||||||
|
|
||||||
|
expect(chunks.length).toBeGreaterThan(0)
|
||||||
|
},
|
||||||
|
|
||||||
|
testTemperature: async (executor: any, model: string, temperatures: number[]) => {
|
||||||
|
for (const temperature of temperatures) {
|
||||||
|
const result = await executor.generateText({
|
||||||
|
model,
|
||||||
|
messages: [{ role: 'user' as const, content: 'Hello' }],
|
||||||
|
temperature
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(result).toBeDefined()
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
testMaxTokens: async (executor: any, model: string, maxTokensValues: number[]) => {
|
||||||
|
for (const maxTokens of maxTokensValues) {
|
||||||
|
const result = await executor.generateText({
|
||||||
|
model,
|
||||||
|
messages: [{ role: 'user' as const, content: 'Hello' }],
|
||||||
|
maxTokens
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(result).toBeDefined()
|
||||||
|
if (result.usage?.completionTokens) {
|
||||||
|
expect(result.usage.completionTokens).toBeLessThanOrEqual(maxTokens)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
testToolCalling: async (executor: any, model: string, tools: Record<string, Tool>) => {
|
||||||
|
const result = await executor.generateText({
|
||||||
|
model,
|
||||||
|
messages: [{ role: 'user' as const, content: 'What is the weather in SF?' }],
|
||||||
|
tools
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(result).toBeDefined()
|
||||||
|
},
|
||||||
|
|
||||||
|
testStopSequences: async (executor: any, model: string, stopSequences: string[][]) => {
|
||||||
|
for (const stop of stopSequences) {
|
||||||
|
const result = await executor.generateText({
|
||||||
|
model,
|
||||||
|
messages: [{ role: 'user' as const, content: 'Count to 10' }],
|
||||||
|
stop
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(result).toBeDefined()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generates test data for vision/multimodal testing
|
||||||
|
*/
|
||||||
|
export function createVisionTestData() {
|
||||||
|
return {
|
||||||
|
imageUrl: 'https://example.com/test-image.jpg',
|
||||||
|
base64Image:
|
||||||
|
'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==',
|
||||||
|
messages: [
|
||||||
|
{
|
||||||
|
role: 'user' as const,
|
||||||
|
content: [
|
||||||
|
{ type: 'text' as const, text: 'What is in this image?' },
|
||||||
|
{
|
||||||
|
type: 'image' as const,
|
||||||
|
image:
|
||||||
|
'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=='
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates mock responses for different finish reasons
|
||||||
|
*/
|
||||||
|
export function createFinishReasonMocks() {
|
||||||
|
return {
|
||||||
|
stop: {
|
||||||
|
text: 'Complete response.',
|
||||||
|
finishReason: 'stop' as const,
|
||||||
|
usage: { promptTokens: 10, completionTokens: 5, totalTokens: 15 }
|
||||||
|
},
|
||||||
|
length: {
|
||||||
|
text: 'Incomplete response due to',
|
||||||
|
finishReason: 'length' as const,
|
||||||
|
usage: { promptTokens: 10, completionTokens: 100, totalTokens: 110 }
|
||||||
|
},
|
||||||
|
'tool-calls': {
|
||||||
|
text: 'Calling tools',
|
||||||
|
finishReason: 'tool-calls' as const,
|
||||||
|
toolCalls: [{ toolCallId: 'call_1', toolName: 'getWeather', args: { location: 'SF' } }],
|
||||||
|
usage: { promptTokens: 10, completionTokens: 8, totalTokens: 18 }
|
||||||
|
},
|
||||||
|
'content-filter': {
|
||||||
|
text: '',
|
||||||
|
finishReason: 'content-filter' as const,
|
||||||
|
usage: { promptTokens: 10, completionTokens: 0, totalTokens: 10 }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
291
packages/aiCore/src/__tests__/helpers/test-utils.ts
Normal file
@@ -0,0 +1,291 @@
|
|||||||
|
/**
|
||||||
|
* Test Utilities
|
||||||
|
* Helper functions for testing AI Core functionality
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { expect, vi } from 'vitest'
|
||||||
|
|
||||||
|
import type { ProviderId } from '../fixtures/mock-providers'
|
||||||
|
import { createMockImageModel, createMockLanguageModel, mockProviderConfigs } from '../fixtures/mock-providers'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a test provider with streaming support
|
||||||
|
*/
|
||||||
|
export function createTestStreamingProvider(chunks: any[]) {
|
||||||
|
return createMockLanguageModel({
|
||||||
|
doStream: vi.fn().mockReturnValue({
|
||||||
|
stream: (async function* () {
|
||||||
|
for (const chunk of chunks) {
|
||||||
|
yield chunk
|
||||||
|
}
|
||||||
|
})(),
|
||||||
|
rawCall: { rawPrompt: null, rawSettings: {} },
|
||||||
|
rawResponse: { headers: {} },
|
||||||
|
warnings: []
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a test provider that throws errors
|
||||||
|
*/
|
||||||
|
export function createErrorProvider(error: Error) {
|
||||||
|
return createMockLanguageModel({
|
||||||
|
doGenerate: vi.fn().mockRejectedValue(error),
|
||||||
|
doStream: vi.fn().mockImplementation(() => {
|
||||||
|
throw error
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Collects all chunks from a stream
|
||||||
|
*/
|
||||||
|
export async function collectStreamChunks<T>(stream: AsyncIterable<T>): Promise<T[]> {
|
||||||
|
const chunks: T[] = []
|
||||||
|
for await (const chunk of stream) {
|
||||||
|
chunks.push(chunk)
|
||||||
|
}
|
||||||
|
return chunks
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Waits for a specific number of milliseconds
|
||||||
|
*/
|
||||||
|
export function wait(ms: number): Promise<void> {
|
||||||
|
return new Promise((resolve) => setTimeout(resolve, ms))
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a mock abort controller that aborts after a delay
|
||||||
|
*/
|
||||||
|
export function createDelayedAbortController(delayMs: number): AbortController {
|
||||||
|
const controller = new AbortController()
|
||||||
|
setTimeout(() => controller.abort(), delayMs)
|
||||||
|
return controller
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Asserts that a function throws an error with a specific message
|
||||||
|
*/
|
||||||
|
export async function expectError(fn: () => Promise<any>, expectedMessage?: string | RegExp): Promise<Error> {
|
||||||
|
try {
|
||||||
|
await fn()
|
||||||
|
throw new Error('Expected function to throw an error, but it did not')
|
||||||
|
} catch (error) {
|
||||||
|
if (expectedMessage) {
|
||||||
|
const message = (error as Error).message
|
||||||
|
if (typeof expectedMessage === 'string') {
|
||||||
|
if (!message.includes(expectedMessage)) {
|
||||||
|
throw new Error(`Expected error message to include "${expectedMessage}", but got "${message}"`)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
if (!expectedMessage.test(message)) {
|
||||||
|
throw new Error(`Expected error message to match ${expectedMessage}, but got "${message}"`)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return error as Error
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a spy function that tracks calls and arguments
|
||||||
|
*/
|
||||||
|
export function createSpy<T extends (...args: any[]) => any>() {
|
||||||
|
const calls: Array<{ args: Parameters<T>; result?: ReturnType<T>; error?: Error }> = []
|
||||||
|
|
||||||
|
const spy = vi.fn((...args: Parameters<T>) => {
|
||||||
|
try {
|
||||||
|
const result = undefined as ReturnType<T>
|
||||||
|
calls.push({ args, result })
|
||||||
|
return result
|
||||||
|
} catch (error) {
|
||||||
|
calls.push({ args, error: error as Error })
|
||||||
|
throw error
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
return {
|
||||||
|
fn: spy,
|
||||||
|
calls,
|
||||||
|
getCalls: () => calls,
|
||||||
|
getCallCount: () => calls.length,
|
||||||
|
getLastCall: () => calls[calls.length - 1],
|
||||||
|
reset: () => {
|
||||||
|
calls.length = 0
|
||||||
|
spy.mockClear()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validates provider configuration
|
||||||
|
*/
|
||||||
|
export function validateProviderConfig(providerId: ProviderId) {
|
||||||
|
const config = mockProviderConfigs[providerId]
|
||||||
|
if (!config) {
|
||||||
|
throw new Error(`No mock configuration found for provider: ${providerId}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!config.apiKey) {
|
||||||
|
throw new Error(`Provider ${providerId} is missing apiKey in mock config`)
|
||||||
|
}
|
||||||
|
|
||||||
|
return config
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a test context with common setup
|
||||||
|
*/
|
||||||
|
export function createTestContext() {
|
||||||
|
const mocks = {
|
||||||
|
languageModel: createMockLanguageModel(),
|
||||||
|
imageModel: createMockImageModel(),
|
||||||
|
providers: new Map<string, any>()
|
||||||
|
}
|
||||||
|
|
||||||
|
const cleanup = () => {
|
||||||
|
mocks.providers.clear()
|
||||||
|
vi.clearAllMocks()
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
mocks,
|
||||||
|
cleanup
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Measures execution time of an async function
|
||||||
|
*/
|
||||||
|
export async function measureTime<T>(fn: () => Promise<T>): Promise<{ result: T; duration: number }> {
|
||||||
|
const start = Date.now()
|
||||||
|
const result = await fn()
|
||||||
|
const duration = Date.now() - start
|
||||||
|
return { result, duration }
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retries a function until it succeeds or max attempts reached
|
||||||
|
*/
|
||||||
|
export async function retryUntilSuccess<T>(fn: () => Promise<T>, maxAttempts = 3, delayMs = 100): Promise<T> {
|
||||||
|
let lastError: Error | undefined
|
||||||
|
|
||||||
|
for (let attempt = 1; attempt <= maxAttempts; attempt++) {
|
||||||
|
try {
|
||||||
|
return await fn()
|
||||||
|
} catch (error) {
|
||||||
|
lastError = error as Error
|
||||||
|
if (attempt < maxAttempts) {
|
||||||
|
await wait(delayMs)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
throw lastError || new Error('All retry attempts failed')
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a mock streaming response that emits chunks at intervals
|
||||||
|
*/
|
||||||
|
export function createTimedStream<T>(chunks: T[], intervalMs = 10) {
|
||||||
|
return {
|
||||||
|
async *[Symbol.asyncIterator]() {
|
||||||
|
for (const chunk of chunks) {
|
||||||
|
await wait(intervalMs)
|
||||||
|
yield chunk
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Asserts that two objects are deeply equal, ignoring specified keys
|
||||||
|
*/
|
||||||
|
export function assertDeepEqualIgnoring<T extends Record<string, any>>(
|
||||||
|
actual: T,
|
||||||
|
expected: T,
|
||||||
|
ignoreKeys: string[] = []
|
||||||
|
): void {
|
||||||
|
const filterKeys = (obj: T): Partial<T> => {
|
||||||
|
const filtered = { ...obj }
|
||||||
|
for (const key of ignoreKeys) {
|
||||||
|
delete filtered[key]
|
||||||
|
}
|
||||||
|
return filtered
|
||||||
|
}
|
||||||
|
|
||||||
|
const filteredActual = filterKeys(actual)
|
||||||
|
const filteredExpected = filterKeys(expected)
|
||||||
|
|
||||||
|
expect(filteredActual).toEqual(filteredExpected)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a provider mock that simulates rate limiting
|
||||||
|
*/
|
||||||
|
export function createRateLimitedProvider(limitPerSecond: number) {
|
||||||
|
const calls: number[] = []
|
||||||
|
|
||||||
|
return createMockLanguageModel({
|
||||||
|
doGenerate: vi.fn().mockImplementation(async () => {
|
||||||
|
const now = Date.now()
|
||||||
|
calls.push(now)
|
||||||
|
|
||||||
|
// Remove calls older than 1 second
|
||||||
|
const recentCalls = calls.filter((time) => now - time < 1000)
|
||||||
|
|
||||||
|
if (recentCalls.length > limitPerSecond) {
|
||||||
|
throw new Error('Rate limit exceeded')
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
text: 'Rate limited response',
|
||||||
|
finishReason: 'stop' as const,
|
||||||
|
usage: { promptTokens: 10, completionTokens: 5, totalTokens: 15 },
|
||||||
|
rawCall: { rawPrompt: null, rawSettings: {} },
|
||||||
|
rawResponse: { headers: {} },
|
||||||
|
warnings: []
|
||||||
|
}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validates streaming response structure
|
||||||
|
*/
|
||||||
|
export function validateStreamChunk(chunk: any): void {
|
||||||
|
expect(chunk).toBeDefined()
|
||||||
|
expect(chunk).toHaveProperty('type')
|
||||||
|
|
||||||
|
if (chunk.type === 'text-delta') {
|
||||||
|
expect(chunk).toHaveProperty('textDelta')
|
||||||
|
expect(typeof chunk.textDelta).toBe('string')
|
||||||
|
} else if (chunk.type === 'finish') {
|
||||||
|
expect(chunk).toHaveProperty('finishReason')
|
||||||
|
expect(chunk).toHaveProperty('usage')
|
||||||
|
} else if (chunk.type === 'tool-call') {
|
||||||
|
expect(chunk).toHaveProperty('toolCallId')
|
||||||
|
expect(chunk).toHaveProperty('toolName')
|
||||||
|
expect(chunk).toHaveProperty('args')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a test logger that captures log messages
|
||||||
|
*/
|
||||||
|
export function createTestLogger() {
|
||||||
|
const logs: Array<{ level: string; message: string; meta?: any }> = []
|
||||||
|
|
||||||
|
return {
|
||||||
|
info: (message: string, meta?: any) => logs.push({ level: 'info', message, meta }),
|
||||||
|
warn: (message: string, meta?: any) => logs.push({ level: 'warn', message, meta }),
|
||||||
|
error: (message: string, meta?: any) => logs.push({ level: 'error', message, meta }),
|
||||||
|
debug: (message: string, meta?: any) => logs.push({ level: 'debug', message, meta }),
|
||||||
|
getLogs: () => logs,
|
||||||
|
clear: () => {
|
||||||
|
logs.length = 0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
12
packages/aiCore/src/__tests__/index.ts
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
/**
|
||||||
|
* Test Infrastructure Exports
|
||||||
|
* Central export point for all test utilities, fixtures, and helpers
|
||||||
|
*/
|
||||||
|
|
||||||
|
// Fixtures
|
||||||
|
export * from './fixtures/mock-providers'
|
||||||
|
export * from './fixtures/mock-responses'
|
||||||
|
|
||||||
|
// Helpers
|
||||||
|
export * from './helpers/provider-test-utils'
|
||||||
|
export * from './helpers/test-utils'
|
||||||
@@ -2,7 +2,7 @@
|
|||||||
* 中间件管理器
|
* 中间件管理器
|
||||||
* 专注于 AI SDK 中间件的管理,与插件系统分离
|
* 专注于 AI SDK 中间件的管理,与插件系统分离
|
||||||
*/
|
*/
|
||||||
import { LanguageModelV2Middleware } from '@ai-sdk/provider'
|
import type { LanguageModelV2Middleware } from '@ai-sdk/provider'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 创建中间件列表
|
* 创建中间件列表
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
/**
|
/**
|
||||||
* 中间件系统类型定义
|
* 中间件系统类型定义
|
||||||
*/
|
*/
|
||||||
import { LanguageModelV2Middleware } from '@ai-sdk/provider'
|
import type { LanguageModelV2Middleware } from '@ai-sdk/provider'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 具名中间件接口
|
* 具名中间件接口
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
* 模型包装工具函数
|
* 模型包装工具函数
|
||||||
* 用于将中间件应用到LanguageModel上
|
* 用于将中间件应用到LanguageModel上
|
||||||
*/
|
*/
|
||||||
import { LanguageModelV2, LanguageModelV2Middleware } from '@ai-sdk/provider'
|
import type { LanguageModelV2, LanguageModelV2Middleware } from '@ai-sdk/provider'
|
||||||
import { wrapLanguageModel } from 'ai'
|
import { wrapLanguageModel } from 'ai'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -5,7 +5,7 @@
|
|||||||
* 集成了来自 ModelCreator 的特殊处理逻辑
|
* 集成了来自 ModelCreator 的特殊处理逻辑
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { EmbeddingModelV2, ImageModelV2, LanguageModelV2, LanguageModelV2Middleware } from '@ai-sdk/provider'
|
import type { EmbeddingModelV2, ImageModelV2, LanguageModelV2, LanguageModelV2Middleware } from '@ai-sdk/provider'
|
||||||
|
|
||||||
import { wrapModelWithMiddlewares } from '../middleware/wrapper'
|
import { wrapModelWithMiddlewares } from '../middleware/wrapper'
|
||||||
import { DEFAULT_SEPARATOR, globalRegistryManagement } from '../providers/RegistryManagement'
|
import { DEFAULT_SEPARATOR, globalRegistryManagement } from '../providers/RegistryManagement'
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
/**
|
/**
|
||||||
* Creation 模块类型定义
|
* Creation 模块类型定义
|
||||||
*/
|
*/
|
||||||
import { LanguageModelV2Middleware } from '@ai-sdk/provider'
|
import type { LanguageModelV2Middleware } from '@ai-sdk/provider'
|
||||||
|
|
||||||
import type { ProviderId, ProviderSettingsMap } from '../providers/types'
|
import type { ProviderId, ProviderSettingsMap } from '../providers/types'
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { ExtractProviderOptions, ProviderOptionsMap, TypedProviderOptions } from './types'
|
import type { ExtractProviderOptions, ProviderOptionsMap, TypedProviderOptions } from './types'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 创建特定供应商的选项
|
* 创建特定供应商的选项
|
||||||
|
|||||||
@@ -4,12 +4,7 @@
|
|||||||
*/
|
*/
|
||||||
export const BUILT_IN_PLUGIN_PREFIX = 'built-in:'
|
export const BUILT_IN_PLUGIN_PREFIX = 'built-in:'
|
||||||
|
|
||||||
export { googleToolsPlugin } from './googleToolsPlugin'
|
export * from './googleToolsPlugin'
|
||||||
export { createLoggingPlugin } from './logging'
|
export * from './toolUsePlugin/promptToolUsePlugin'
|
||||||
export { createPromptToolUsePlugin } from './toolUsePlugin/promptToolUsePlugin'
|
export * from './toolUsePlugin/type'
|
||||||
export type {
|
export * from './webSearchPlugin'
|
||||||
PromptToolUseConfig,
|
|
||||||
ToolUseRequestContext,
|
|
||||||
ToolUseResult
|
|
||||||
} from './toolUsePlugin/type'
|
|
||||||
export { webSearchPlugin, type WebSearchPluginConfig } from './webSearchPlugin'
|
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ import type { AiRequestContext } from '../../types'
|
|||||||
import { StreamEventManager } from './StreamEventManager'
|
import { StreamEventManager } from './StreamEventManager'
|
||||||
import { type TagConfig, TagExtractor } from './tagExtraction'
|
import { type TagConfig, TagExtractor } from './tagExtraction'
|
||||||
import { ToolExecutor } from './ToolExecutor'
|
import { ToolExecutor } from './ToolExecutor'
|
||||||
import { PromptToolUseConfig, ToolUseResult } from './type'
|
import type { PromptToolUseConfig, ToolUseResult } from './type'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 工具使用标签配置
|
* 工具使用标签配置
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import { ToolSet } from 'ai'
|
import type { ToolSet } from 'ai'
|
||||||
|
|
||||||
import { AiRequestContext } from '../..'
|
import type { AiRequestContext } from '../..'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 解析结果类型
|
* 解析结果类型
|
||||||
|
|||||||
@@ -1,10 +1,12 @@
|
|||||||
import { anthropic } from '@ai-sdk/anthropic'
|
import { anthropic } from '@ai-sdk/anthropic'
|
||||||
import { google } from '@ai-sdk/google'
|
import { google } from '@ai-sdk/google'
|
||||||
import { openai } from '@ai-sdk/openai'
|
import { openai } from '@ai-sdk/openai'
|
||||||
import { InferToolInput, InferToolOutput, type Tool } from 'ai'
|
import type { InferToolInput, InferToolOutput } from 'ai'
|
||||||
|
import { type Tool } from 'ai'
|
||||||
|
|
||||||
import { ProviderOptionsMap } from '../../../options/types'
|
import { createOpenRouterOptions, createXaiOptions, mergeProviderOptions } from '../../../options'
|
||||||
import { OpenRouterSearchConfig } from './openrouter'
|
import type { ProviderOptionsMap } from '../../../options/types'
|
||||||
|
import type { OpenRouterSearchConfig } from './openrouter'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 从 AI SDK 的工具函数中提取参数类型,以确保类型安全。
|
* 从 AI SDK 的工具函数中提取参数类型,以确保类型安全。
|
||||||
@@ -94,3 +96,56 @@ export type WebSearchToolInputSchema = {
|
|||||||
google: InferToolInput<GoogleWebSearchTool>
|
google: InferToolInput<GoogleWebSearchTool>
|
||||||
'openai-chat': InferToolInput<OpenAIChatWebSearchTool>
|
'openai-chat': InferToolInput<OpenAIChatWebSearchTool>
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export const switchWebSearchTool = (providerId: string, config: WebSearchPluginConfig, params: any) => {
|
||||||
|
switch (providerId) {
|
||||||
|
case 'openai': {
|
||||||
|
if (config.openai) {
|
||||||
|
if (!params.tools) params.tools = {}
|
||||||
|
params.tools.web_search = openai.tools.webSearch(config.openai)
|
||||||
|
}
|
||||||
|
break
|
||||||
|
}
|
||||||
|
case 'openai-chat': {
|
||||||
|
if (config['openai-chat']) {
|
||||||
|
if (!params.tools) params.tools = {}
|
||||||
|
params.tools.web_search_preview = openai.tools.webSearchPreview(config['openai-chat'])
|
||||||
|
}
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
case 'anthropic': {
|
||||||
|
if (config.anthropic) {
|
||||||
|
if (!params.tools) params.tools = {}
|
||||||
|
params.tools.web_search = anthropic.tools.webSearch_20250305(config.anthropic)
|
||||||
|
}
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
case 'google': {
|
||||||
|
// case 'google-vertex':
|
||||||
|
if (!params.tools) params.tools = {}
|
||||||
|
params.tools.web_search = google.tools.googleSearch(config.google || {})
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
case 'xai': {
|
||||||
|
if (config.xai) {
|
||||||
|
const searchOptions = createXaiOptions({
|
||||||
|
searchParameters: { ...config.xai, mode: 'on' }
|
||||||
|
})
|
||||||
|
params.providerOptions = mergeProviderOptions(params.providerOptions, searchOptions)
|
||||||
|
}
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
case 'openrouter': {
|
||||||
|
if (config.openrouter) {
|
||||||
|
const searchOptions = createOpenRouterOptions(config.openrouter)
|
||||||
|
params.providerOptions = mergeProviderOptions(params.providerOptions, searchOptions)
|
||||||
|
}
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return params
|
||||||
|
}
|
||||||
|
|||||||
@@ -2,14 +2,11 @@
|
|||||||
* Web Search Plugin
|
* Web Search Plugin
|
||||||
* 提供统一的网络搜索能力,支持多个 AI Provider
|
* 提供统一的网络搜索能力,支持多个 AI Provider
|
||||||
*/
|
*/
|
||||||
import { anthropic } from '@ai-sdk/anthropic'
|
|
||||||
import { google } from '@ai-sdk/google'
|
|
||||||
import { openai } from '@ai-sdk/openai'
|
|
||||||
|
|
||||||
import { createOpenRouterOptions, createXaiOptions, mergeProviderOptions } from '../../../options'
|
|
||||||
import { definePlugin } from '../../'
|
import { definePlugin } from '../../'
|
||||||
import type { AiRequestContext } from '../../types'
|
import type { AiRequestContext } from '../../types'
|
||||||
import { DEFAULT_WEB_SEARCH_CONFIG, WebSearchPluginConfig } from './helper'
|
import type { WebSearchPluginConfig } from './helper'
|
||||||
|
import { DEFAULT_WEB_SEARCH_CONFIG, switchWebSearchTool } from './helper'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 网络搜索插件
|
* 网络搜索插件
|
||||||
@@ -23,62 +20,19 @@ export const webSearchPlugin = (config: WebSearchPluginConfig = DEFAULT_WEB_SEAR
|
|||||||
|
|
||||||
transformParams: async (params: any, context: AiRequestContext) => {
|
transformParams: async (params: any, context: AiRequestContext) => {
|
||||||
const { providerId } = context
|
const { providerId } = context
|
||||||
switch (providerId) {
|
switchWebSearchTool(providerId, config, params)
|
||||||
case 'openai': {
|
|
||||||
if (config.openai) {
|
|
||||||
if (!params.tools) params.tools = {}
|
|
||||||
params.tools.web_search = openai.tools.webSearch(config.openai)
|
|
||||||
}
|
|
||||||
break
|
|
||||||
}
|
|
||||||
case 'openai-chat': {
|
|
||||||
if (config['openai-chat']) {
|
|
||||||
if (!params.tools) params.tools = {}
|
|
||||||
params.tools.web_search_preview = openai.tools.webSearchPreview(config['openai-chat'])
|
|
||||||
}
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
case 'anthropic': {
|
if (providerId === 'cherryin' || providerId === 'cherryin-chat') {
|
||||||
if (config.anthropic) {
|
// cherryin.gemini
|
||||||
if (!params.tools) params.tools = {}
|
const _providerId = params.model.provider.split('.')[1]
|
||||||
params.tools.web_search = anthropic.tools.webSearch_20250305(config.anthropic)
|
switchWebSearchTool(_providerId, config, params)
|
||||||
}
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
case 'google': {
|
|
||||||
// case 'google-vertex':
|
|
||||||
if (!params.tools) params.tools = {}
|
|
||||||
params.tools.web_search = google.tools.googleSearch(config.google || {})
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
case 'xai': {
|
|
||||||
if (config.xai) {
|
|
||||||
const searchOptions = createXaiOptions({
|
|
||||||
searchParameters: { ...config.xai, mode: 'on' }
|
|
||||||
})
|
|
||||||
params.providerOptions = mergeProviderOptions(params.providerOptions, searchOptions)
|
|
||||||
}
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
case 'openrouter': {
|
|
||||||
if (config.openrouter) {
|
|
||||||
const searchOptions = createOpenRouterOptions(config.openrouter)
|
|
||||||
params.providerOptions = mergeProviderOptions(params.providerOptions, searchOptions)
|
|
||||||
}
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return params
|
return params
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
// 导出类型定义供开发者使用
|
// 导出类型定义供开发者使用
|
||||||
export type { WebSearchPluginConfig, WebSearchToolOutputSchema } from './helper'
|
export * from './helper'
|
||||||
|
|
||||||
// 默认导出
|
// 默认导出
|
||||||
export default webSearchPlugin
|
export default webSearchPlugin
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { AiPlugin, AiRequestContext } from './types'
|
import type { AiPlugin, AiRequestContext } from './types'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 插件管理器
|
* 插件管理器
|
||||||
|
|||||||
@@ -5,7 +5,7 @@
|
|||||||
* 例如: aihubmix:anthropic:claude-3.5-sonnet
|
* 例如: aihubmix:anthropic:claude-3.5-sonnet
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { ProviderV2 } from '@ai-sdk/provider'
|
import type { ProviderV2 } from '@ai-sdk/provider'
|
||||||
import { customProvider } from 'ai'
|
import { customProvider } from 'ai'
|
||||||
|
|
||||||
import { globalRegistryManagement } from './RegistryManagement'
|
import { globalRegistryManagement } from './RegistryManagement'
|
||||||
|
|||||||
@@ -4,7 +4,7 @@
|
|||||||
* 基于 AI SDK 原生的 createProviderRegistry
|
* 基于 AI SDK 原生的 createProviderRegistry
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { EmbeddingModelV2, ImageModelV2, LanguageModelV2, ProviderV2 } from '@ai-sdk/provider'
|
import type { EmbeddingModelV2, ImageModelV2, LanguageModelV2, ProviderV2 } from '@ai-sdk/provider'
|
||||||
import { createProviderRegistry, type ProviderRegistryProvider } from 'ai'
|
import { createProviderRegistry, type ProviderRegistryProvider } from 'ai'
|
||||||
|
|
||||||
type PROVIDERS = Record<string, ProviderV2>
|
type PROVIDERS = Record<string, ProviderV2>
|
||||||
|
|||||||
@@ -44,7 +44,7 @@ export {
|
|||||||
// ==================== 基础数据和类型 ====================
|
// ==================== 基础数据和类型 ====================
|
||||||
|
|
||||||
// 基础Provider数据源
|
// 基础Provider数据源
|
||||||
export { baseProviderIds, baseProviders } from './schemas'
|
export { baseProviderIds, baseProviders, isBaseProvider } from './schemas'
|
||||||
|
|
||||||
// 类型定义和Schema
|
// 类型定义和Schema
|
||||||
export type {
|
export type {
|
||||||
|
|||||||
@@ -9,10 +9,12 @@ import { createDeepSeek } from '@ai-sdk/deepseek'
|
|||||||
import { createGoogleGenerativeAI } from '@ai-sdk/google'
|
import { createGoogleGenerativeAI } from '@ai-sdk/google'
|
||||||
import { createOpenAI, type OpenAIProviderSettings } from '@ai-sdk/openai'
|
import { createOpenAI, type OpenAIProviderSettings } from '@ai-sdk/openai'
|
||||||
import { createOpenAICompatible } from '@ai-sdk/openai-compatible'
|
import { createOpenAICompatible } from '@ai-sdk/openai-compatible'
|
||||||
import { LanguageModelV2 } from '@ai-sdk/provider'
|
import type { LanguageModelV2 } from '@ai-sdk/provider'
|
||||||
import { createXai } from '@ai-sdk/xai'
|
import { createXai } from '@ai-sdk/xai'
|
||||||
|
import { type CherryInProviderSettings, createCherryIn } from '@cherrystudio/ai-sdk-provider'
|
||||||
import { createOpenRouter } from '@openrouter/ai-sdk-provider'
|
import { createOpenRouter } from '@openrouter/ai-sdk-provider'
|
||||||
import { customProvider, Provider } from 'ai'
|
import type { Provider } from 'ai'
|
||||||
|
import { customProvider } from 'ai'
|
||||||
import * as z from 'zod'
|
import * as z from 'zod'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -28,7 +30,9 @@ export const baseProviderIds = [
|
|||||||
'azure',
|
'azure',
|
||||||
'azure-responses',
|
'azure-responses',
|
||||||
'deepseek',
|
'deepseek',
|
||||||
'openrouter'
|
'openrouter',
|
||||||
|
'cherryin',
|
||||||
|
'cherryin-chat'
|
||||||
] as const
|
] as const
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -132,6 +136,26 @@ export const baseProviders = [
|
|||||||
name: 'OpenRouter',
|
name: 'OpenRouter',
|
||||||
creator: createOpenRouter,
|
creator: createOpenRouter,
|
||||||
supportsImageGeneration: true
|
supportsImageGeneration: true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 'cherryin',
|
||||||
|
name: 'CherryIN',
|
||||||
|
creator: createCherryIn,
|
||||||
|
supportsImageGeneration: true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 'cherryin-chat',
|
||||||
|
name: 'CherryIN Chat',
|
||||||
|
creator: (options: CherryInProviderSettings) => {
|
||||||
|
const provider = createCherryIn(options)
|
||||||
|
return customProvider({
|
||||||
|
fallbackProvider: {
|
||||||
|
...provider,
|
||||||
|
languageModel: (modelId: string) => provider.chat(modelId)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
},
|
||||||
|
supportsImageGeneration: true
|
||||||
}
|
}
|
||||||
] as const satisfies BaseProvider[]
|
] as const satisfies BaseProvider[]
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ import { type DeepSeekProviderSettings } from '@ai-sdk/deepseek'
|
|||||||
import { type GoogleGenerativeAIProviderSettings } from '@ai-sdk/google'
|
import { type GoogleGenerativeAIProviderSettings } from '@ai-sdk/google'
|
||||||
import { type OpenAIProviderSettings } from '@ai-sdk/openai'
|
import { type OpenAIProviderSettings } from '@ai-sdk/openai'
|
||||||
import { type OpenAICompatibleProviderSettings } from '@ai-sdk/openai-compatible'
|
import { type OpenAICompatibleProviderSettings } from '@ai-sdk/openai-compatible'
|
||||||
import {
|
import type {
|
||||||
EmbeddingModelV2 as EmbeddingModel,
|
EmbeddingModelV2 as EmbeddingModel,
|
||||||
ImageModelV2 as ImageModel,
|
ImageModelV2 as ImageModel,
|
||||||
LanguageModelV2 as LanguageModel,
|
LanguageModelV2 as LanguageModel,
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { ImageModelV2 } from '@ai-sdk/provider'
|
import type { ImageModelV2 } from '@ai-sdk/provider'
|
||||||
import { experimental_generateImage as aiGenerateImage, NoImageGeneratedError } from 'ai'
|
import { experimental_generateImage as aiGenerateImage, NoImageGeneratedError } from 'ai'
|
||||||
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
||||||
|
|
||||||
|
|||||||