Compare commits
238 Commits
v1.7.0-bet
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3045f924ce | ||
|
|
a6ba5d34e0 | ||
|
|
8ab375161d | ||
|
|
42260710d8 | ||
|
|
5e8646c6a5 | ||
|
|
7e93e8b9b2 | ||
|
|
eb7a2cc85a | ||
|
|
fd6986076a | ||
|
|
6309cc179d | ||
|
|
c04529a23c | ||
|
|
0f1b3afa72 | ||
|
|
0cf0072b51 | ||
|
|
150bb3e3a0 | ||
|
|
739096deca | ||
|
|
1d5dafa325 | ||
|
|
bdfda7afb1 | ||
|
|
ef25eef0eb | ||
|
|
c676a93595 | ||
|
|
e85009fcd6 | ||
|
|
99d7223a0a | ||
|
|
bdd272b7cd | ||
|
|
782f8496e0 | ||
|
|
bfeef7ef91 | ||
|
|
784fdd4fed | ||
|
|
432b31c7b1 | ||
|
|
f2b4a2382b | ||
|
|
b66787280a | ||
|
|
d41229c69b | ||
|
|
aeebd343d7 | ||
|
|
71df9d61fd | ||
|
|
4d3d5ae4ce | ||
|
|
a1f0addafb | ||
|
|
e78f25ff91 | ||
|
|
68f70e3b16 | ||
|
|
fd921103dd | ||
|
|
a1e44a6827 | ||
|
|
ee7eee24da | ||
|
|
f0ec2354dc | ||
|
|
5bd550bfb4 | ||
|
|
dc0c47c64d | ||
|
|
66feee714b | ||
|
|
96aba33077 | ||
|
|
97f6275104 | ||
|
|
b906849c17 | ||
|
|
f742ebed1f | ||
|
|
d7b9a6e09a | ||
|
|
be9a8b8699 | ||
|
|
512d872ac3 | ||
|
|
95f5853d7d | ||
|
|
c1bf6cfbb7 | ||
|
|
595a0f194a | ||
|
|
a91c69982c | ||
|
|
6b25fbb901 | ||
|
|
c52a2dbc48 | ||
|
|
367c4fe6b6 | ||
|
|
5f3af646f4 | ||
|
|
ed695a8620 | ||
|
|
8cd4b1b747 | ||
|
|
9ac7e2c78d | ||
|
|
c4fd48376d | ||
|
|
600a045ff7 | ||
|
|
880673c4eb | ||
|
|
03db02d5f7 | ||
|
|
fda2287475 | ||
|
|
76524d68c6 | ||
|
|
96085707ce | ||
|
|
711f805a5b | ||
|
|
6df60a69c3 | ||
|
|
058a2c763b | ||
|
|
7507443d8b | ||
|
|
8ede7b197f | ||
|
|
086190228a | ||
|
|
adbadf5da6 | ||
|
|
73fc74d875 | ||
|
|
bc00c11a00 | ||
|
|
f8c33db450 | ||
|
|
61c171dafc | ||
|
|
e1e6702425 | ||
|
|
e6003463ac | ||
|
|
0cc4c96bc0 | ||
|
|
d35434b6d6 | ||
|
|
ef5b97813c | ||
|
|
4c4f832bc7 | ||
|
|
9f7e47304d | ||
|
|
1a737f5137 | ||
|
|
82ec18c0fb | ||
|
|
0cabdefb9a | ||
|
|
224ab6a69b | ||
|
|
bba7ecae6e | ||
|
|
516b8479d6 | ||
|
|
b58a2fce03 | ||
|
|
ebfc60b039 | ||
|
|
8f39ecf762 | ||
|
|
8d1d09b1ec | ||
|
|
3cedb95db3 | ||
|
|
9d6d827f88 | ||
|
|
968210faa7 | ||
|
|
ea36b918f1 | ||
|
|
92bb05950d | ||
|
|
a566cd65f4 | ||
|
|
cd699825ed | ||
|
|
86a16f5762 | ||
|
|
6343628739 | ||
|
|
a2a6c62f48 | ||
|
|
981bb9f451 | ||
|
|
9637fb8a43 | ||
|
|
fb20173194 | ||
|
|
387e8f77f5 | ||
|
|
4f701d3e45 | ||
|
|
aeabc28451 | ||
|
|
f571dd7af0 | ||
|
|
33457686ac | ||
|
|
6696bcacb8 | ||
|
|
a1e95b55f8 | ||
|
|
600199dfcf | ||
|
|
77fd90ef7d | ||
|
|
fb45d94efb | ||
|
|
3aedf6f138 | ||
|
|
3e6dc56196 | ||
|
|
b3a58ec321 | ||
|
|
0097ca80e2 | ||
|
|
d968df4612 | ||
|
|
2bd680361a | ||
|
|
cc676d4bef | ||
|
|
3b1155b538 | ||
|
|
03ff6e1ca6 | ||
|
|
706fac898a | ||
|
|
f5c144404d | ||
|
|
50a217a638 | ||
|
|
444c13e1e3 | ||
|
|
255b19d6ee | ||
|
|
f1f4831157 | ||
|
|
876f59d650 | ||
|
|
c23e88ecd1 | ||
|
|
284d0f99e1 | ||
|
|
13ac5d564a | ||
|
|
4620b71aee | ||
|
|
1b926178f1 | ||
|
|
5167c927be | ||
|
|
b18c64b725 | ||
|
|
7ce1590eaf | ||
|
|
77a9504f74 | ||
|
|
bf35902696 | ||
|
|
0d12b5fbc2 | ||
|
|
1746e8b21f | ||
|
|
0836eef1a6 | ||
|
|
d0bd10190d | ||
|
|
d8191bd4fb | ||
|
|
d15571c727 | ||
|
|
a2f67dddb6 | ||
|
|
8f00321a60 | ||
|
|
eb4670c22c | ||
|
|
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 |
1
.github/CODEOWNERS
vendored
@ -3,3 +3,4 @@
|
|||||||
/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
|
||||||
|
|||||||
6
.github/workflows/auto-i18n.yml
vendored
@ -23,7 +23,7 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: 🐈⬛ Checkout
|
- name: 🐈⬛ Checkout
|
||||||
uses: actions/checkout@v5
|
uses: actions/checkout@v6
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
@ -54,7 +54,7 @@ jobs:
|
|||||||
yarn install
|
yarn install
|
||||||
|
|
||||||
- name: 🏃♀️ Translate
|
- name: 🏃♀️ Translate
|
||||||
run: yarn sync:i18n && yarn auto:i18n
|
run: yarn i18n:sync && yarn i18n:translate
|
||||||
|
|
||||||
- name: 🔍 Format
|
- name: 🔍 Format
|
||||||
run: yarn format
|
run: yarn format
|
||||||
@ -77,7 +77,7 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
token: ${{ secrets.GITHUB_TOKEN }} # Use the built-in GITHUB_TOKEN for bot actions
|
token: ${{ secrets.GITHUB_TOKEN }} # Use the built-in GITHUB_TOKEN for bot actions
|
||||||
commit-message: "feat(bot): Weekly automated script run"
|
commit-message: "feat(bot): Weekly automated script run"
|
||||||
title: "🤖 Weekly Automated Update: ${{ env.CURRENT_DATE }}"
|
title: "🤖 Weekly Auto I18N Sync: ${{ env.CURRENT_DATE }}"
|
||||||
body: |
|
body: |
|
||||||
This PR includes changes generated by the weekly auto i18n.
|
This PR includes changes generated by the weekly auto i18n.
|
||||||
Review the changes before merging.
|
Review the changes before merging.
|
||||||
|
|||||||
2
.github/workflows/claude-code-review.yml
vendored
@ -27,7 +27,7 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v5
|
uses: actions/checkout@v6
|
||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
|
|||||||
2
.github/workflows/claude-translator.yml
vendored
@ -32,7 +32,7 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v5
|
uses: actions/checkout@v6
|
||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
|
|||||||
2
.github/workflows/claude.yml
vendored
@ -37,7 +37,7 @@ jobs:
|
|||||||
actions: read # Required for Claude to read CI results on PRs
|
actions: read # Required for Claude to read CI results on PRs
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v5
|
uses: actions/checkout@v6
|
||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
|
|
||||||
|
|||||||
2
.github/workflows/dispatch-docs-update.yml
vendored
@ -19,7 +19,7 @@ jobs:
|
|||||||
echo "tag=${{ github.event.release.tag_name }}" >> $GITHUB_OUTPUT
|
echo "tag=${{ github.event.release.tag_name }}" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
- name: Dispatch update-download-version workflow to cherry-studio-docs
|
- name: Dispatch update-download-version workflow to cherry-studio-docs
|
||||||
uses: peter-evans/repository-dispatch@v3
|
uses: peter-evans/repository-dispatch@v4
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.REPO_DISPATCH_TOKEN }}
|
token: ${{ secrets.REPO_DISPATCH_TOKEN }}
|
||||||
repository: CherryHQ/cherry-studio-docs
|
repository: CherryHQ/cherry-studio-docs
|
||||||
|
|||||||
6
.github/workflows/github-issue-tracker.yml
vendored
@ -19,7 +19,7 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
- name: Check Beijing Time
|
- name: Check Beijing Time
|
||||||
id: check_time
|
id: check_time
|
||||||
@ -42,7 +42,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Add pending label if in quiet hours
|
- name: Add pending label if in quiet hours
|
||||||
if: steps.check_time.outputs.should_delay == 'true'
|
if: steps.check_time.outputs.should_delay == 'true'
|
||||||
uses: actions/github-script@v7
|
uses: actions/github-script@v8
|
||||||
with:
|
with:
|
||||||
script: |
|
script: |
|
||||||
github.rest.issues.addLabels({
|
github.rest.issues.addLabels({
|
||||||
@ -118,7 +118,7 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
- name: Setup Node.js
|
- name: Setup Node.js
|
||||||
uses: actions/setup-node@v6
|
uses: actions/setup-node@v6
|
||||||
|
|||||||
2
.github/workflows/nightly-build.yml
vendored
@ -51,7 +51,7 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Check out Git repository
|
- name: Check out Git repository
|
||||||
uses: actions/checkout@v5
|
uses: actions/checkout@v6
|
||||||
with:
|
with:
|
||||||
ref: main
|
ref: main
|
||||||
|
|
||||||
|
|||||||
4
.github/workflows/pr-ci.yml
vendored
@ -21,7 +21,7 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Check out Git repository
|
- name: Check out Git repository
|
||||||
uses: actions/checkout@v5
|
uses: actions/checkout@v6
|
||||||
|
|
||||||
- name: Install Node.js
|
- name: Install Node.js
|
||||||
uses: actions/setup-node@v6
|
uses: actions/setup-node@v6
|
||||||
@ -58,7 +58,7 @@ jobs:
|
|||||||
run: yarn typecheck
|
run: yarn typecheck
|
||||||
|
|
||||||
- name: i18n Check
|
- name: i18n Check
|
||||||
run: yarn check:i18n
|
run: yarn i18n:check
|
||||||
|
|
||||||
- name: Test
|
- name: Test
|
||||||
run: yarn test
|
run: yarn test
|
||||||
|
|||||||
2
.github/workflows/release.yml
vendored
@ -25,7 +25,7 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Check out Git repository
|
- name: Check out Git repository
|
||||||
uses: actions/checkout@v5
|
uses: actions/checkout@v6
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
|
|||||||
305
.github/workflows/sync-to-gitcode.yml
vendored
Normal file
@ -0,0 +1,305 @@
|
|||||||
|
name: Sync Release to GitCode
|
||||||
|
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types: [published]
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
tag:
|
||||||
|
description: 'Release tag (e.g. v1.0.0)'
|
||||||
|
required: true
|
||||||
|
clean:
|
||||||
|
description: 'Clean node_modules before build'
|
||||||
|
type: boolean
|
||||||
|
default: false
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build-and-sync-to-gitcode:
|
||||||
|
runs-on: [self-hosted, windows-signing]
|
||||||
|
steps:
|
||||||
|
- name: Get tag name
|
||||||
|
id: get-tag
|
||||||
|
shell: bash
|
||||||
|
run: |
|
||||||
|
if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
|
||||||
|
echo "tag=${{ github.event.inputs.tag }}" >> $GITHUB_OUTPUT
|
||||||
|
else
|
||||||
|
echo "tag=${{ github.event.release.tag_name }}" >> $GITHUB_OUTPUT
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Check out Git repository
|
||||||
|
uses: actions/checkout@v6
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
ref: ${{ steps.get-tag.outputs.tag }}
|
||||||
|
|
||||||
|
- name: Set package.json version
|
||||||
|
shell: bash
|
||||||
|
run: |
|
||||||
|
TAG="${{ steps.get-tag.outputs.tag }}"
|
||||||
|
VERSION="${TAG#v}"
|
||||||
|
npm version "$VERSION" --no-git-tag-version --allow-same-version
|
||||||
|
|
||||||
|
- name: Install Node.js
|
||||||
|
uses: actions/setup-node@v6
|
||||||
|
with:
|
||||||
|
node-version: 22
|
||||||
|
|
||||||
|
- name: Install corepack
|
||||||
|
shell: bash
|
||||||
|
run: corepack enable && corepack prepare yarn@4.9.1 --activate
|
||||||
|
|
||||||
|
- name: Clean node_modules
|
||||||
|
if: ${{ github.event.inputs.clean == 'true' }}
|
||||||
|
shell: bash
|
||||||
|
run: rm -rf node_modules
|
||||||
|
|
||||||
|
- name: Install Dependencies
|
||||||
|
shell: bash
|
||||||
|
run: yarn install
|
||||||
|
|
||||||
|
- name: Build Windows with code signing
|
||||||
|
shell: bash
|
||||||
|
run: yarn build:win
|
||||||
|
env:
|
||||||
|
WIN_SIGN: true
|
||||||
|
CHERRY_CERT_PATH: ${{ secrets.CHERRY_CERT_PATH }}
|
||||||
|
CHERRY_CERT_KEY: ${{ secrets.CHERRY_CERT_KEY }}
|
||||||
|
CHERRY_CERT_CSP: ${{ secrets.CHERRY_CERT_CSP }}
|
||||||
|
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
NODE_OPTIONS: --max-old-space-size=8192
|
||||||
|
MAIN_VITE_CHERRYAI_CLIENT_SECRET: ${{ secrets.MAIN_VITE_CHERRYAI_CLIENT_SECRET }}
|
||||||
|
MAIN_VITE_MINERU_API_KEY: ${{ secrets.MAIN_VITE_MINERU_API_KEY }}
|
||||||
|
RENDERER_VITE_AIHUBMIX_SECRET: ${{ secrets.RENDERER_VITE_AIHUBMIX_SECRET }}
|
||||||
|
RENDERER_VITE_PPIO_APP_SECRET: ${{ secrets.RENDERER_VITE_PPIO_APP_SECRET }}
|
||||||
|
|
||||||
|
- name: List built Windows artifacts
|
||||||
|
shell: bash
|
||||||
|
run: |
|
||||||
|
echo "Built Windows artifacts:"
|
||||||
|
ls -la dist/*.exe dist/*.blockmap dist/latest*.yml
|
||||||
|
|
||||||
|
- name: Download GitHub release assets
|
||||||
|
shell: bash
|
||||||
|
env:
|
||||||
|
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
TAG_NAME: ${{ steps.get-tag.outputs.tag }}
|
||||||
|
run: |
|
||||||
|
echo "Downloading release assets for $TAG_NAME..."
|
||||||
|
mkdir -p release-assets
|
||||||
|
cd release-assets
|
||||||
|
|
||||||
|
# Download all assets from the release
|
||||||
|
gh release download "$TAG_NAME" \
|
||||||
|
--repo "${{ github.repository }}" \
|
||||||
|
--pattern "*" \
|
||||||
|
--skip-existing
|
||||||
|
|
||||||
|
echo "Downloaded GitHub release assets:"
|
||||||
|
ls -la
|
||||||
|
|
||||||
|
- name: Replace Windows files with signed versions
|
||||||
|
shell: bash
|
||||||
|
run: |
|
||||||
|
echo "Replacing Windows files with signed versions..."
|
||||||
|
|
||||||
|
# Verify signed files exist first
|
||||||
|
if ! ls dist/*.exe 1>/dev/null 2>&1; then
|
||||||
|
echo "ERROR: No signed .exe files found in dist/"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Remove unsigned Windows files from downloaded assets
|
||||||
|
# *.exe, *.exe.blockmap, latest.yml (Windows only)
|
||||||
|
rm -f release-assets/*.exe release-assets/*.exe.blockmap release-assets/latest.yml 2>/dev/null || true
|
||||||
|
|
||||||
|
# Copy signed Windows files with error checking
|
||||||
|
cp dist/*.exe release-assets/ || { echo "ERROR: Failed to copy .exe files"; exit 1; }
|
||||||
|
cp dist/*.exe.blockmap release-assets/ || { echo "ERROR: Failed to copy .blockmap files"; exit 1; }
|
||||||
|
cp dist/latest.yml release-assets/ || { echo "ERROR: Failed to copy latest.yml"; exit 1; }
|
||||||
|
|
||||||
|
echo "Final release assets:"
|
||||||
|
ls -la release-assets/
|
||||||
|
|
||||||
|
- name: Get release info
|
||||||
|
id: release-info
|
||||||
|
shell: bash
|
||||||
|
env:
|
||||||
|
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
TAG_NAME: ${{ steps.get-tag.outputs.tag }}
|
||||||
|
LANG: C.UTF-8
|
||||||
|
LC_ALL: C.UTF-8
|
||||||
|
run: |
|
||||||
|
# Always use gh cli to avoid special character issues
|
||||||
|
RELEASE_NAME=$(gh release view "$TAG_NAME" --repo "${{ github.repository }}" --json name -q '.name')
|
||||||
|
# Use delimiter to safely handle special characters in release name
|
||||||
|
{
|
||||||
|
echo 'name<<EOF'
|
||||||
|
echo "$RELEASE_NAME"
|
||||||
|
echo 'EOF'
|
||||||
|
} >> $GITHUB_OUTPUT
|
||||||
|
# Extract releaseNotes from electron-builder.yml (from releaseNotes: | to end of file, remove 4-space indent)
|
||||||
|
sed -n '/releaseNotes: |/,$ { /releaseNotes: |/d; s/^ //; p }' electron-builder.yml > release_body.txt
|
||||||
|
|
||||||
|
- name: Create GitCode release and upload files
|
||||||
|
shell: bash
|
||||||
|
env:
|
||||||
|
GITCODE_TOKEN: ${{ secrets.GITCODE_TOKEN }}
|
||||||
|
GITCODE_OWNER: ${{ vars.GITCODE_OWNER }}
|
||||||
|
GITCODE_REPO: ${{ vars.GITCODE_REPO }}
|
||||||
|
GITCODE_API_URL: ${{ vars.GITCODE_API_URL }}
|
||||||
|
TAG_NAME: ${{ steps.get-tag.outputs.tag }}
|
||||||
|
RELEASE_NAME: ${{ steps.release-info.outputs.name }}
|
||||||
|
LANG: C.UTF-8
|
||||||
|
LC_ALL: C.UTF-8
|
||||||
|
run: |
|
||||||
|
# Validate required environment variables
|
||||||
|
if [ -z "$GITCODE_TOKEN" ]; then
|
||||||
|
echo "ERROR: GITCODE_TOKEN is not set"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if [ -z "$GITCODE_OWNER" ]; then
|
||||||
|
echo "ERROR: GITCODE_OWNER is not set"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if [ -z "$GITCODE_REPO" ]; then
|
||||||
|
echo "ERROR: GITCODE_REPO is not set"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
API_URL="${GITCODE_API_URL:-https://api.gitcode.com/api/v5}"
|
||||||
|
|
||||||
|
echo "Creating GitCode release..."
|
||||||
|
echo "Tag: $TAG_NAME"
|
||||||
|
echo "Repo: $GITCODE_OWNER/$GITCODE_REPO"
|
||||||
|
|
||||||
|
# Step 1: Create release
|
||||||
|
# Use --rawfile to read body directly from file, avoiding shell variable encoding issues
|
||||||
|
jq -n \
|
||||||
|
--arg tag "$TAG_NAME" \
|
||||||
|
--arg name "$RELEASE_NAME" \
|
||||||
|
--rawfile body release_body.txt \
|
||||||
|
'{
|
||||||
|
tag_name: $tag,
|
||||||
|
name: $name,
|
||||||
|
body: $body,
|
||||||
|
target_commitish: "main"
|
||||||
|
}' > /tmp/release_payload.json
|
||||||
|
|
||||||
|
RELEASE_RESPONSE=$(curl -s -w "\n%{http_code}" -X POST \
|
||||||
|
--connect-timeout 30 --max-time 60 \
|
||||||
|
"${API_URL}/repos/${GITCODE_OWNER}/${GITCODE_REPO}/releases" \
|
||||||
|
-H "Content-Type: application/json; charset=utf-8" \
|
||||||
|
-H "Authorization: Bearer ${GITCODE_TOKEN}" \
|
||||||
|
--data-binary "@/tmp/release_payload.json")
|
||||||
|
|
||||||
|
HTTP_CODE=$(echo "$RELEASE_RESPONSE" | tail -n1)
|
||||||
|
RESPONSE_BODY=$(echo "$RELEASE_RESPONSE" | sed '$d')
|
||||||
|
|
||||||
|
if [ "$HTTP_CODE" -ge 200 ] && [ "$HTTP_CODE" -lt 300 ]; then
|
||||||
|
echo "Release created successfully"
|
||||||
|
else
|
||||||
|
echo "Warning: Release creation returned HTTP $HTTP_CODE"
|
||||||
|
echo "$RESPONSE_BODY"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Step 2: Upload files to release
|
||||||
|
echo "Uploading files to GitCode release..."
|
||||||
|
|
||||||
|
# Function to upload a single file with retry
|
||||||
|
upload_file() {
|
||||||
|
local file="$1"
|
||||||
|
local filename=$(basename "$file")
|
||||||
|
local max_retries=3
|
||||||
|
local retry=0
|
||||||
|
local curl_status=0
|
||||||
|
|
||||||
|
echo "Uploading: $filename"
|
||||||
|
|
||||||
|
# URL encode the filename
|
||||||
|
encoded_filename=$(printf '%s' "$filename" | jq -sRr @uri)
|
||||||
|
|
||||||
|
while [ $retry -lt $max_retries ]; do
|
||||||
|
# Get upload URL
|
||||||
|
curl_status=0
|
||||||
|
UPLOAD_INFO=$(curl -s --connect-timeout 30 --max-time 60 \
|
||||||
|
-H "Authorization: Bearer ${GITCODE_TOKEN}" \
|
||||||
|
"${API_URL}/repos/${GITCODE_OWNER}/${GITCODE_REPO}/releases/${TAG_NAME}/upload_url?file_name=${encoded_filename}") || curl_status=$?
|
||||||
|
|
||||||
|
if [ $curl_status -eq 0 ]; then
|
||||||
|
UPLOAD_URL=$(echo "$UPLOAD_INFO" | jq -r '.url // empty')
|
||||||
|
|
||||||
|
if [ -n "$UPLOAD_URL" ]; then
|
||||||
|
# Write headers to temp file to avoid shell escaping issues
|
||||||
|
echo "$UPLOAD_INFO" | jq -r '.headers | to_entries[] | "header = \"" + .key + ": " + .value + "\""' > /tmp/upload_headers.txt
|
||||||
|
|
||||||
|
# Upload file using PUT with headers from file
|
||||||
|
curl_status=0
|
||||||
|
UPLOAD_RESPONSE=$(curl -s -w "\n%{http_code}" -X PUT \
|
||||||
|
-K /tmp/upload_headers.txt \
|
||||||
|
--data-binary "@${file}" \
|
||||||
|
"$UPLOAD_URL") || curl_status=$?
|
||||||
|
|
||||||
|
if [ $curl_status -eq 0 ]; then
|
||||||
|
HTTP_CODE=$(echo "$UPLOAD_RESPONSE" | tail -n1)
|
||||||
|
RESPONSE_BODY=$(echo "$UPLOAD_RESPONSE" | sed '$d')
|
||||||
|
|
||||||
|
if [ "$HTTP_CODE" -ge 200 ] && [ "$HTTP_CODE" -lt 300 ]; then
|
||||||
|
echo " Uploaded: $filename"
|
||||||
|
return 0
|
||||||
|
else
|
||||||
|
echo " Failed (HTTP $HTTP_CODE), retry $((retry + 1))/$max_retries"
|
||||||
|
echo " Response: $RESPONSE_BODY"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
echo " Upload request failed (curl exit $curl_status), retry $((retry + 1))/$max_retries"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
echo " Failed to get upload URL, retry $((retry + 1))/$max_retries"
|
||||||
|
echo " Response: $UPLOAD_INFO"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
echo " Failed to get upload URL (curl exit $curl_status), retry $((retry + 1))/$max_retries"
|
||||||
|
echo " Response: $UPLOAD_INFO"
|
||||||
|
fi
|
||||||
|
|
||||||
|
retry=$((retry + 1))
|
||||||
|
[ $retry -lt $max_retries ] && sleep 3
|
||||||
|
done
|
||||||
|
|
||||||
|
echo " Failed: $filename after $max_retries retries"
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# Upload non-yml/json files first
|
||||||
|
for file in release-assets/*; do
|
||||||
|
if [ -f "$file" ]; then
|
||||||
|
filename=$(basename "$file")
|
||||||
|
if [[ ! "$filename" =~ \.(yml|yaml|json)$ ]]; then
|
||||||
|
upload_file "$file"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
# Upload yml/json files last
|
||||||
|
for file in release-assets/*; do
|
||||||
|
if [ -f "$file" ]; then
|
||||||
|
filename=$(basename "$file")
|
||||||
|
if [[ "$filename" =~ \.(yml|yaml|json)$ ]]; then
|
||||||
|
upload_file "$file"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
echo "GitCode release sync completed!"
|
||||||
|
|
||||||
|
- name: Cleanup temp files
|
||||||
|
if: always()
|
||||||
|
shell: bash
|
||||||
|
run: |
|
||||||
|
rm -f /tmp/release_payload.json /tmp/upload_headers.txt release_body.txt
|
||||||
|
rm -rf release-assets/
|
||||||
206
.github/workflows/update-app-upgrade-config.yml
vendored
Normal file
@ -0,0 +1,206 @@
|
|||||||
|
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
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
update-config:
|
||||||
|
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@v6
|
||||||
|
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@v6
|
||||||
|
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: Commit and push changes
|
||||||
|
if: steps.check.outputs.should_run == 'true' && steps.diff.outputs.changed == 'true'
|
||||||
|
working-directory: cs
|
||||||
|
run: |
|
||||||
|
git config user.name "github-actions[bot]"
|
||||||
|
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||||
|
git add app-upgrade-config.json
|
||||||
|
git commit -m "chore: sync app-upgrade-config for ${{ steps.meta.outputs.tag }}" -m "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 }}"
|
||||||
|
git push origin x-files/app-upgrade-config
|
||||||
|
|
||||||
|
- 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"
|
||||||
@ -11,6 +11,7 @@
|
|||||||
"dist/**",
|
"dist/**",
|
||||||
"out/**",
|
"out/**",
|
||||||
"local/**",
|
"local/**",
|
||||||
|
"tests/**",
|
||||||
".yarn/**",
|
".yarn/**",
|
||||||
".gitignore",
|
".gitignore",
|
||||||
"scripts/cloudflare-worker.js",
|
"scripts/cloudflare-worker.js",
|
||||||
|
|||||||
@ -1,8 +1,8 @@
|
|||||||
diff --git a/dist/index.js b/dist/index.js
|
diff --git a/dist/index.js b/dist/index.js
|
||||||
index ff305b112779b718f21a636a27b1196125a332d9..cf32ff5086d4d9e56f8fe90c98724559083bafc3 100644
|
index d004b415c5841a1969705823614f395265ea5a8a..6b1e0dad4610b0424393ecc12e9114723bbe316b 100644
|
||||||
--- a/dist/index.js
|
--- a/dist/index.js
|
||||||
+++ b/dist/index.js
|
+++ b/dist/index.js
|
||||||
@@ -471,7 +471,7 @@ function convertToGoogleGenerativeAIMessages(prompt, options) {
|
@@ -474,7 +474,7 @@ function convertToGoogleGenerativeAIMessages(prompt, options) {
|
||||||
|
|
||||||
// src/get-model-path.ts
|
// src/get-model-path.ts
|
||||||
function getModelPath(modelId) {
|
function getModelPath(modelId) {
|
||||||
@ -12,10 +12,10 @@ index ff305b112779b718f21a636a27b1196125a332d9..cf32ff5086d4d9e56f8fe90c98724559
|
|||||||
|
|
||||||
// src/google-generative-ai-options.ts
|
// src/google-generative-ai-options.ts
|
||||||
diff --git a/dist/index.mjs b/dist/index.mjs
|
diff --git a/dist/index.mjs b/dist/index.mjs
|
||||||
index 57659290f1cec74878a385626ad75b2a4d5cd3fc..d04e5927ec3725b6ffdb80868bfa1b5a48849537 100644
|
index 1780dd2391b7f42224a0b8048c723d2f81222c44..1f12ed14399d6902107ce9b435d7d8e6cc61e06b 100644
|
||||||
--- a/dist/index.mjs
|
--- a/dist/index.mjs
|
||||||
+++ b/dist/index.mjs
|
+++ b/dist/index.mjs
|
||||||
@@ -477,7 +477,7 @@ function convertToGoogleGenerativeAIMessages(prompt, options) {
|
@@ -480,7 +480,7 @@ function convertToGoogleGenerativeAIMessages(prompt, options) {
|
||||||
|
|
||||||
// src/get-model-path.ts
|
// src/get-model-path.ts
|
||||||
function getModelPath(modelId) {
|
function getModelPath(modelId) {
|
||||||
@ -24,3 +24,14 @@ index 57659290f1cec74878a385626ad75b2a4d5cd3fc..d04e5927ec3725b6ffdb80868bfa1b5a
|
|||||||
}
|
}
|
||||||
|
|
||||||
// src/google-generative-ai-options.ts
|
// src/google-generative-ai-options.ts
|
||||||
|
@@ -1909,8 +1909,7 @@ function createGoogleGenerativeAI(options = {}) {
|
||||||
|
}
|
||||||
|
var google = createGoogleGenerativeAI();
|
||||||
|
export {
|
||||||
|
- VERSION,
|
||||||
|
createGoogleGenerativeAI,
|
||||||
|
- google
|
||||||
|
+ google, VERSION
|
||||||
|
};
|
||||||
|
//# sourceMappingURL=index.mjs.map
|
||||||
|
\ No newline at end of file
|
||||||
@ -1,131 +0,0 @@
|
|||||||
diff --git a/dist/index.mjs b/dist/index.mjs
|
|
||||||
index b3f018730a93639aad7c203f15fb1aeb766c73f4..ade2a43d66e9184799d072153df61ef7be4ea110 100644
|
|
||||||
--- a/dist/index.mjs
|
|
||||||
+++ b/dist/index.mjs
|
|
||||||
@@ -296,7 +296,14 @@ var HuggingFaceResponsesLanguageModel = class {
|
|
||||||
metadata: huggingfaceOptions == null ? void 0 : huggingfaceOptions.metadata,
|
|
||||||
instructions: huggingfaceOptions == null ? void 0 : huggingfaceOptions.instructions,
|
|
||||||
...preparedTools && { tools: preparedTools },
|
|
||||||
- ...preparedToolChoice && { tool_choice: preparedToolChoice }
|
|
||||||
+ ...preparedToolChoice && { tool_choice: preparedToolChoice },
|
|
||||||
+ ...(huggingfaceOptions?.reasoningEffort != null && {
|
|
||||||
+ reasoning: {
|
|
||||||
+ ...(huggingfaceOptions?.reasoningEffort != null && {
|
|
||||||
+ effort: huggingfaceOptions.reasoningEffort,
|
|
||||||
+ }),
|
|
||||||
+ },
|
|
||||||
+ }),
|
|
||||||
};
|
|
||||||
return { args: baseArgs, warnings };
|
|
||||||
}
|
|
||||||
@@ -365,6 +372,20 @@ var HuggingFaceResponsesLanguageModel = class {
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
+ case 'reasoning': {
|
|
||||||
+ for (const contentPart of part.content) {
|
|
||||||
+ content.push({
|
|
||||||
+ type: 'reasoning',
|
|
||||||
+ text: contentPart.text,
|
|
||||||
+ providerMetadata: {
|
|
||||||
+ huggingface: {
|
|
||||||
+ itemId: part.id,
|
|
||||||
+ },
|
|
||||||
+ },
|
|
||||||
+ });
|
|
||||||
+ }
|
|
||||||
+ break;
|
|
||||||
+ }
|
|
||||||
case "mcp_call": {
|
|
||||||
content.push({
|
|
||||||
type: "tool-call",
|
|
||||||
@@ -519,6 +540,11 @@ var HuggingFaceResponsesLanguageModel = class {
|
|
||||||
id: value.item.call_id,
|
|
||||||
toolName: value.item.name
|
|
||||||
});
|
|
||||||
+ } else if (value.item.type === 'reasoning') {
|
|
||||||
+ controller.enqueue({
|
|
||||||
+ type: 'reasoning-start',
|
|
||||||
+ id: value.item.id,
|
|
||||||
+ });
|
|
||||||
}
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
@@ -570,6 +596,22 @@ var HuggingFaceResponsesLanguageModel = class {
|
|
||||||
});
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
+ if (isReasoningDeltaChunk(value)) {
|
|
||||||
+ controller.enqueue({
|
|
||||||
+ type: 'reasoning-delta',
|
|
||||||
+ id: value.item_id,
|
|
||||||
+ delta: value.delta,
|
|
||||||
+ });
|
|
||||||
+ return;
|
|
||||||
+ }
|
|
||||||
+
|
|
||||||
+ if (isReasoningEndChunk(value)) {
|
|
||||||
+ controller.enqueue({
|
|
||||||
+ type: 'reasoning-end',
|
|
||||||
+ id: value.item_id,
|
|
||||||
+ });
|
|
||||||
+ return;
|
|
||||||
+ }
|
|
||||||
},
|
|
||||||
flush(controller) {
|
|
||||||
controller.enqueue({
|
|
||||||
@@ -593,7 +635,8 @@ var HuggingFaceResponsesLanguageModel = class {
|
|
||||||
var huggingfaceResponsesProviderOptionsSchema = z2.object({
|
|
||||||
metadata: z2.record(z2.string(), z2.string()).optional(),
|
|
||||||
instructions: z2.string().optional(),
|
|
||||||
- strictJsonSchema: z2.boolean().optional()
|
|
||||||
+ strictJsonSchema: z2.boolean().optional(),
|
|
||||||
+ reasoningEffort: z2.string().optional(),
|
|
||||||
});
|
|
||||||
var huggingfaceResponsesResponseSchema = z2.object({
|
|
||||||
id: z2.string(),
|
|
||||||
@@ -727,12 +770,31 @@ var responseCreatedChunkSchema = z2.object({
|
|
||||||
model: z2.string()
|
|
||||||
})
|
|
||||||
});
|
|
||||||
+var reasoningTextDeltaChunkSchema = z2.object({
|
|
||||||
+ type: z2.literal('response.reasoning_text.delta'),
|
|
||||||
+ item_id: z2.string(),
|
|
||||||
+ output_index: z2.number(),
|
|
||||||
+ content_index: z2.number(),
|
|
||||||
+ delta: z2.string(),
|
|
||||||
+ sequence_number: z2.number(),
|
|
||||||
+});
|
|
||||||
+
|
|
||||||
+var reasoningTextEndChunkSchema = z2.object({
|
|
||||||
+ type: z2.literal('response.reasoning_text.done'),
|
|
||||||
+ item_id: z2.string(),
|
|
||||||
+ output_index: z2.number(),
|
|
||||||
+ content_index: z2.number(),
|
|
||||||
+ text: z2.string(),
|
|
||||||
+ sequence_number: z2.number(),
|
|
||||||
+});
|
|
||||||
var huggingfaceResponsesChunkSchema = z2.union([
|
|
||||||
responseOutputItemAddedSchema,
|
|
||||||
responseOutputItemDoneSchema,
|
|
||||||
textDeltaChunkSchema,
|
|
||||||
responseCompletedChunkSchema,
|
|
||||||
responseCreatedChunkSchema,
|
|
||||||
+ reasoningTextDeltaChunkSchema,
|
|
||||||
+ reasoningTextEndChunkSchema,
|
|
||||||
z2.object({ type: z2.string() }).loose()
|
|
||||||
// fallback for unknown chunks
|
|
||||||
]);
|
|
||||||
@@ -751,6 +813,12 @@ function isResponseCompletedChunk(chunk) {
|
|
||||||
function isResponseCreatedChunk(chunk) {
|
|
||||||
return chunk.type === "response.created";
|
|
||||||
}
|
|
||||||
+function isReasoningDeltaChunk(chunk) {
|
|
||||||
+ return chunk.type === 'response.reasoning_text.delta';
|
|
||||||
+}
|
|
||||||
+function isReasoningEndChunk(chunk) {
|
|
||||||
+ return chunk.type === 'response.reasoning_text.done';
|
|
||||||
+}
|
|
||||||
|
|
||||||
// src/huggingface-provider.ts
|
|
||||||
function createHuggingFace(options = {}) {
|
|
||||||
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()
|
||||||
@ -1,8 +1,8 @@
|
|||||||
diff --git a/dist/index.js b/dist/index.js
|
diff --git a/dist/index.js b/dist/index.js
|
||||||
index 992c85ac6656e51c3471af741583533c5a7bf79f..83c05952a07aebb95fc6c62f9ddb8aa96b52ac0d 100644
|
index 130094d194ea1e8e7d3027d07d82465741192124..4d13dcee8c962ca9ee8f1c3d748f8ffe6a3cfb47 100644
|
||||||
--- a/dist/index.js
|
--- a/dist/index.js
|
||||||
+++ b/dist/index.js
|
+++ b/dist/index.js
|
||||||
@@ -274,6 +274,7 @@ var openaiChatResponseSchema = (0, import_provider_utils3.lazyValidator)(
|
@@ -290,6 +290,7 @@ var openaiChatResponseSchema = (0, import_provider_utils3.lazyValidator)(
|
||||||
message: import_v42.z.object({
|
message: import_v42.z.object({
|
||||||
role: import_v42.z.literal("assistant").nullish(),
|
role: import_v42.z.literal("assistant").nullish(),
|
||||||
content: import_v42.z.string().nullish(),
|
content: import_v42.z.string().nullish(),
|
||||||
@ -10,7 +10,7 @@ index 992c85ac6656e51c3471af741583533c5a7bf79f..83c05952a07aebb95fc6c62f9ddb8aa9
|
|||||||
tool_calls: import_v42.z.array(
|
tool_calls: import_v42.z.array(
|
||||||
import_v42.z.object({
|
import_v42.z.object({
|
||||||
id: import_v42.z.string().nullish(),
|
id: import_v42.z.string().nullish(),
|
||||||
@@ -340,6 +341,7 @@ var openaiChatChunkSchema = (0, import_provider_utils3.lazyValidator)(
|
@@ -356,6 +357,7 @@ var openaiChatChunkSchema = (0, import_provider_utils3.lazyValidator)(
|
||||||
delta: import_v42.z.object({
|
delta: import_v42.z.object({
|
||||||
role: import_v42.z.enum(["assistant"]).nullish(),
|
role: import_v42.z.enum(["assistant"]).nullish(),
|
||||||
content: import_v42.z.string().nullish(),
|
content: import_v42.z.string().nullish(),
|
||||||
@ -18,7 +18,7 @@ index 992c85ac6656e51c3471af741583533c5a7bf79f..83c05952a07aebb95fc6c62f9ddb8aa9
|
|||||||
tool_calls: import_v42.z.array(
|
tool_calls: import_v42.z.array(
|
||||||
import_v42.z.object({
|
import_v42.z.object({
|
||||||
index: import_v42.z.number(),
|
index: import_v42.z.number(),
|
||||||
@@ -785,6 +787,13 @@ var OpenAIChatLanguageModel = class {
|
@@ -814,6 +816,13 @@ var OpenAIChatLanguageModel = class {
|
||||||
if (text != null && text.length > 0) {
|
if (text != null && text.length > 0) {
|
||||||
content.push({ type: "text", text });
|
content.push({ type: "text", text });
|
||||||
}
|
}
|
||||||
@ -32,7 +32,7 @@ index 992c85ac6656e51c3471af741583533c5a7bf79f..83c05952a07aebb95fc6c62f9ddb8aa9
|
|||||||
for (const toolCall of (_a = choice.message.tool_calls) != null ? _a : []) {
|
for (const toolCall of (_a = choice.message.tool_calls) != null ? _a : []) {
|
||||||
content.push({
|
content.push({
|
||||||
type: "tool-call",
|
type: "tool-call",
|
||||||
@@ -866,6 +875,7 @@ var OpenAIChatLanguageModel = class {
|
@@ -895,6 +904,7 @@ var OpenAIChatLanguageModel = class {
|
||||||
};
|
};
|
||||||
let metadataExtracted = false;
|
let metadataExtracted = false;
|
||||||
let isActiveText = false;
|
let isActiveText = false;
|
||||||
@ -40,7 +40,7 @@ index 992c85ac6656e51c3471af741583533c5a7bf79f..83c05952a07aebb95fc6c62f9ddb8aa9
|
|||||||
const providerMetadata = { openai: {} };
|
const providerMetadata = { openai: {} };
|
||||||
return {
|
return {
|
||||||
stream: response.pipeThrough(
|
stream: response.pipeThrough(
|
||||||
@@ -923,6 +933,21 @@ var OpenAIChatLanguageModel = class {
|
@@ -952,6 +962,21 @@ var OpenAIChatLanguageModel = class {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
const delta = choice.delta;
|
const delta = choice.delta;
|
||||||
@ -62,7 +62,7 @@ index 992c85ac6656e51c3471af741583533c5a7bf79f..83c05952a07aebb95fc6c62f9ddb8aa9
|
|||||||
if (delta.content != null) {
|
if (delta.content != null) {
|
||||||
if (!isActiveText) {
|
if (!isActiveText) {
|
||||||
controller.enqueue({ type: "text-start", id: "0" });
|
controller.enqueue({ type: "text-start", id: "0" });
|
||||||
@@ -1035,6 +1060,9 @@ var OpenAIChatLanguageModel = class {
|
@@ -1064,6 +1089,9 @@ var OpenAIChatLanguageModel = class {
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
flush(controller) {
|
flush(controller) {
|
||||||
@ -1,8 +1,8 @@
|
|||||||
diff --git a/sdk.mjs b/sdk.mjs
|
diff --git a/sdk.mjs b/sdk.mjs
|
||||||
index 8cc6aaf0b25bcdf3c579ec95cde12d419fcb2a71..3b3b8beaea5ad2bbac26a15f792058306d0b059f 100755
|
index dea7766a3432a1e809f12d6daba4f2834a219689..e0b02ef73da177ba32b903887d7bbbeaa08cc6d3 100755
|
||||||
--- a/sdk.mjs
|
--- a/sdk.mjs
|
||||||
+++ b/sdk.mjs
|
+++ b/sdk.mjs
|
||||||
@@ -6213,7 +6213,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
|
||||||
@ -11,16 +11,20 @@ index 8cc6aaf0b25bcdf3c579ec95cde12d419fcb2a71..3b3b8beaea5ad2bbac26a15f79205830
|
|||||||
import { createInterface } from "readline";
|
import { createInterface } from "readline";
|
||||||
|
|
||||||
// ../src/utils/fsOperations.ts
|
// ../src/utils/fsOperations.ts
|
||||||
@@ -6505,14 +6505,11 @@ class ProcessTransport {
|
@@ -6644,18 +6644,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 ? [...executableArgs, ...args] : [...executableArgs, pathToClaudeCodeExecutable, ...args];
|
- const spawnArgs = isNative ? [...executableArgs, ...args] : [...executableArgs, pathToClaudeCodeExecutable, ...args];
|
||||||
- this.logForDebugging(isNative ? `Spawning Claude Code native binary: ${spawnCommand} ${spawnArgs.join(" ")}` : `Spawning Claude Code process: ${spawnCommand} ${spawnArgs.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,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;
|
||||||
|
}
|
||||||
145
.yarn/patches/ollama-ai-provider-v2-npm-1.5.5-8bef249af9.patch
vendored
Normal file
@ -0,0 +1,145 @@
|
|||||||
|
diff --git a/dist/index.d.ts b/dist/index.d.ts
|
||||||
|
index 8dd9b498050dbecd8dd6b901acf1aa8ca38a49af..ed644349c9d38fe2a66b2fb44214f7c18eb97f89 100644
|
||||||
|
--- a/dist/index.d.ts
|
||||||
|
+++ b/dist/index.d.ts
|
||||||
|
@@ -4,7 +4,7 @@ import { z } from 'zod/v4';
|
||||||
|
|
||||||
|
type OllamaChatModelId = "athene-v2" | "athene-v2:72b" | "aya-expanse" | "aya-expanse:8b" | "aya-expanse:32b" | "codegemma" | "codegemma:2b" | "codegemma:7b" | "codellama" | "codellama:7b" | "codellama:13b" | "codellama:34b" | "codellama:70b" | "codellama:code" | "codellama:python" | "command-r" | "command-r:35b" | "command-r-plus" | "command-r-plus:104b" | "command-r7b" | "command-r7b:7b" | "deepseek-r1" | "deepseek-r1:1.5b" | "deepseek-r1:7b" | "deepseek-r1:8b" | "deepseek-r1:14b" | "deepseek-r1:32b" | "deepseek-r1:70b" | "deepseek-r1:671b" | "deepseek-coder-v2" | "deepseek-coder-v2:16b" | "deepseek-coder-v2:236b" | "deepseek-v3" | "deepseek-v3:671b" | "devstral" | "devstral:24b" | "dolphin3" | "dolphin3:8b" | "exaone3.5" | "exaone3.5:2.4b" | "exaone3.5:7.8b" | "exaone3.5:32b" | "falcon2" | "falcon2:11b" | "falcon3" | "falcon3:1b" | "falcon3:3b" | "falcon3:7b" | "falcon3:10b" | "firefunction-v2" | "firefunction-v2:70b" | "gemma" | "gemma:2b" | "gemma:7b" | "gemma2" | "gemma2:2b" | "gemma2:9b" | "gemma2:27b" | "gemma3" | "gemma3:1b" | "gemma3:4b" | "gemma3:12b" | "gemma3:27b" | "granite3-dense" | "granite3-dense:2b" | "granite3-dense:8b" | "granite3-guardian" | "granite3-guardian:2b" | "granite3-guardian:8b" | "granite3-moe" | "granite3-moe:1b" | "granite3-moe:3b" | "granite3.1-dense" | "granite3.1-dense:2b" | "granite3.1-dense:8b" | "granite3.1-moe" | "granite3.1-moe:1b" | "granite3.1-moe:3b" | "llama2" | "llama2:7b" | "llama2:13b" | "llama2:70b" | "llama3" | "llama3:8b" | "llama3:70b" | "llama3-chatqa" | "llama3-chatqa:8b" | "llama3-chatqa:70b" | "llama3-gradient" | "llama3-gradient:8b" | "llama3-gradient:70b" | "llama3.1" | "llama3.1:8b" | "llama3.1:70b" | "llama3.1:405b" | "llama3.2" | "llama3.2:1b" | "llama3.2:3b" | "llama3.2-vision" | "llama3.2-vision:11b" | "llama3.2-vision:90b" | "llama3.3" | "llama3.3:70b" | "llama4" | "llama4:16x17b" | "llama4:128x17b" | "llama-guard3" | "llama-guard3:1b" | "llama-guard3:8b" | "llava" | "llava:7b" | "llava:13b" | "llava:34b" | "llava-llama3" | "llava-llama3:8b" | "llava-phi3" | "llava-phi3:3.8b" | "marco-o1" | "marco-o1:7b" | "mistral" | "mistral:7b" | "mistral-large" | "mistral-large:123b" | "mistral-nemo" | "mistral-nemo:12b" | "mistral-small" | "mistral-small:22b" | "mixtral" | "mixtral:8x7b" | "mixtral:8x22b" | "moondream" | "moondream:1.8b" | "openhermes" | "openhermes:v2.5" | "nemotron" | "nemotron:70b" | "nemotron-mini" | "nemotron-mini:4b" | "olmo" | "olmo:7b" | "olmo:13b" | "opencoder" | "opencoder:1.5b" | "opencoder:8b" | "phi3" | "phi3:3.8b" | "phi3:14b" | "phi3.5" | "phi3.5:3.8b" | "phi4" | "phi4:14b" | "qwen" | "qwen:7b" | "qwen:14b" | "qwen:32b" | "qwen:72b" | "qwen:110b" | "qwen2" | "qwen2:0.5b" | "qwen2:1.5b" | "qwen2:7b" | "qwen2:72b" | "qwen2.5" | "qwen2.5:0.5b" | "qwen2.5:1.5b" | "qwen2.5:3b" | "qwen2.5:7b" | "qwen2.5:14b" | "qwen2.5:32b" | "qwen2.5:72b" | "qwen2.5-coder" | "qwen2.5-coder:0.5b" | "qwen2.5-coder:1.5b" | "qwen2.5-coder:3b" | "qwen2.5-coder:7b" | "qwen2.5-coder:14b" | "qwen2.5-coder:32b" | "qwen3" | "qwen3:0.6b" | "qwen3:1.7b" | "qwen3:4b" | "qwen3:8b" | "qwen3:14b" | "qwen3:30b" | "qwen3:32b" | "qwen3:235b" | "qwq" | "qwq:32b" | "sailor2" | "sailor2:1b" | "sailor2:8b" | "sailor2:20b" | "shieldgemma" | "shieldgemma:2b" | "shieldgemma:9b" | "shieldgemma:27b" | "smallthinker" | "smallthinker:3b" | "smollm" | "smollm:135m" | "smollm:360m" | "smollm:1.7b" | "tinyllama" | "tinyllama:1.1b" | "tulu3" | "tulu3:8b" | "tulu3:70b" | (string & {});
|
||||||
|
declare const ollamaProviderOptions: z.ZodObject<{
|
||||||
|
- think: z.ZodOptional<z.ZodBoolean>;
|
||||||
|
+ think: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<['low', 'medium', 'high']>]>>;
|
||||||
|
options: z.ZodOptional<z.ZodObject<{
|
||||||
|
num_ctx: z.ZodOptional<z.ZodNumber>;
|
||||||
|
repeat_last_n: z.ZodOptional<z.ZodNumber>;
|
||||||
|
@@ -27,9 +27,11 @@ interface OllamaCompletionSettings {
|
||||||
|
* the model's thinking from the model's output. When disabled, the model will not think
|
||||||
|
* and directly output the content.
|
||||||
|
*
|
||||||
|
+ * For gpt-oss models, you can also use 'low', 'medium', or 'high' to control the depth of thinking.
|
||||||
|
+ *
|
||||||
|
* Only supported by certain models like DeepSeek R1 and Qwen 3.
|
||||||
|
*/
|
||||||
|
- think?: boolean;
|
||||||
|
+ think?: boolean | 'low' | 'medium' | 'high';
|
||||||
|
/**
|
||||||
|
* Echo back the prompt in addition to the completion.
|
||||||
|
*/
|
||||||
|
@@ -146,7 +148,7 @@ declare const ollamaEmbeddingProviderOptions: z.ZodObject<{
|
||||||
|
type OllamaEmbeddingProviderOptions = z.infer<typeof ollamaEmbeddingProviderOptions>;
|
||||||
|
|
||||||
|
declare const ollamaCompletionProviderOptions: z.ZodObject<{
|
||||||
|
- think: z.ZodOptional<z.ZodBoolean>;
|
||||||
|
+ think: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodEnum<['low', 'medium', 'high']>]>>;
|
||||||
|
user: z.ZodOptional<z.ZodString>;
|
||||||
|
suffix: z.ZodOptional<z.ZodString>;
|
||||||
|
echo: z.ZodOptional<z.ZodBoolean>;
|
||||||
|
diff --git a/dist/index.js b/dist/index.js
|
||||||
|
index 35b5142ce8476ce2549ed7c2ec48e7d8c46c90d9..2ef64dc9a4c2be043e6af608241a6a8309a5a69f 100644
|
||||||
|
--- a/dist/index.js
|
||||||
|
+++ b/dist/index.js
|
||||||
|
@@ -158,7 +158,7 @@ function getResponseMetadata({
|
||||||
|
|
||||||
|
// src/completion/ollama-completion-language-model.ts
|
||||||
|
var ollamaCompletionProviderOptions = import_v42.z.object({
|
||||||
|
- think: import_v42.z.boolean().optional(),
|
||||||
|
+ think: import_v42.z.union([import_v42.z.boolean(), import_v42.z.enum(['low', 'medium', 'high'])]).optional(),
|
||||||
|
user: import_v42.z.string().optional(),
|
||||||
|
suffix: import_v42.z.string().optional(),
|
||||||
|
echo: import_v42.z.boolean().optional()
|
||||||
|
@@ -662,7 +662,7 @@ function convertToOllamaChatMessages({
|
||||||
|
const images = content.filter((part) => part.type === "file" && part.mediaType.startsWith("image/")).map((part) => part.data);
|
||||||
|
messages.push({
|
||||||
|
role: "user",
|
||||||
|
- content: userText.length > 0 ? userText : [],
|
||||||
|
+ content: userText.length > 0 ? userText : '',
|
||||||
|
images: images.length > 0 ? images : void 0
|
||||||
|
});
|
||||||
|
break;
|
||||||
|
@@ -813,9 +813,11 @@ var ollamaProviderOptions = import_v44.z.object({
|
||||||
|
* the model's thinking from the model's output. When disabled, the model will not think
|
||||||
|
* and directly output the content.
|
||||||
|
*
|
||||||
|
+ * For gpt-oss models, you can also use 'low', 'medium', or 'high' to control the depth of thinking.
|
||||||
|
+ *
|
||||||
|
* Only supported by certain models like DeepSeek R1 and Qwen 3.
|
||||||
|
*/
|
||||||
|
- think: import_v44.z.boolean().optional(),
|
||||||
|
+ think: import_v44.z.union([import_v44.z.boolean(), import_v44.z.enum(['low', 'medium', 'high'])]).optional(),
|
||||||
|
options: import_v44.z.object({
|
||||||
|
num_ctx: import_v44.z.number().optional(),
|
||||||
|
repeat_last_n: import_v44.z.number().optional(),
|
||||||
|
@@ -929,14 +931,16 @@ var OllamaRequestBuilder = class {
|
||||||
|
prompt,
|
||||||
|
systemMessageMode: "system"
|
||||||
|
}),
|
||||||
|
- temperature,
|
||||||
|
- top_p: topP,
|
||||||
|
max_output_tokens: maxOutputTokens,
|
||||||
|
...(responseFormat == null ? void 0 : responseFormat.type) === "json" && {
|
||||||
|
format: responseFormat.schema != null ? responseFormat.schema : "json"
|
||||||
|
},
|
||||||
|
think: (_a = ollamaOptions == null ? void 0 : ollamaOptions.think) != null ? _a : false,
|
||||||
|
- options: (_b = ollamaOptions == null ? void 0 : ollamaOptions.options) != null ? _b : void 0
|
||||||
|
+ options: {
|
||||||
|
+ ...temperature !== void 0 && { temperature },
|
||||||
|
+ ...topP !== void 0 && { top_p: topP },
|
||||||
|
+ ...((_b = ollamaOptions == null ? void 0 : ollamaOptions.options) != null ? _b : {})
|
||||||
|
+ }
|
||||||
|
};
|
||||||
|
}
|
||||||
|
};
|
||||||
|
diff --git a/dist/index.mjs b/dist/index.mjs
|
||||||
|
index e2a634a78d80ac9542f2cc4f96cf2291094b10cf..67b23efce3c1cf4f026693d3ff9246988a3ef26e 100644
|
||||||
|
--- a/dist/index.mjs
|
||||||
|
+++ b/dist/index.mjs
|
||||||
|
@@ -144,7 +144,7 @@ function getResponseMetadata({
|
||||||
|
|
||||||
|
// src/completion/ollama-completion-language-model.ts
|
||||||
|
var ollamaCompletionProviderOptions = z2.object({
|
||||||
|
- think: z2.boolean().optional(),
|
||||||
|
+ think: z2.union([z2.boolean(), z2.enum(['low', 'medium', 'high'])]).optional(),
|
||||||
|
user: z2.string().optional(),
|
||||||
|
suffix: z2.string().optional(),
|
||||||
|
echo: z2.boolean().optional()
|
||||||
|
@@ -662,7 +662,7 @@ function convertToOllamaChatMessages({
|
||||||
|
const images = content.filter((part) => part.type === "file" && part.mediaType.startsWith("image/")).map((part) => part.data);
|
||||||
|
messages.push({
|
||||||
|
role: "user",
|
||||||
|
- content: userText.length > 0 ? userText : [],
|
||||||
|
+ content: userText.length > 0 ? userText : '',
|
||||||
|
images: images.length > 0 ? images : void 0
|
||||||
|
});
|
||||||
|
break;
|
||||||
|
@@ -815,9 +815,11 @@ var ollamaProviderOptions = z4.object({
|
||||||
|
* the model's thinking from the model's output. When disabled, the model will not think
|
||||||
|
* and directly output the content.
|
||||||
|
*
|
||||||
|
+ * For gpt-oss models, you can also use 'low', 'medium', or 'high' to control the depth of thinking.
|
||||||
|
+ *
|
||||||
|
* Only supported by certain models like DeepSeek R1 and Qwen 3.
|
||||||
|
*/
|
||||||
|
- think: z4.boolean().optional(),
|
||||||
|
+ think: z4.union([z4.boolean(), z4.enum(['low', 'medium', 'high'])]).optional(),
|
||||||
|
options: z4.object({
|
||||||
|
num_ctx: z4.number().optional(),
|
||||||
|
repeat_last_n: z4.number().optional(),
|
||||||
|
@@ -931,14 +933,16 @@ var OllamaRequestBuilder = class {
|
||||||
|
prompt,
|
||||||
|
systemMessageMode: "system"
|
||||||
|
}),
|
||||||
|
- temperature,
|
||||||
|
- top_p: topP,
|
||||||
|
max_output_tokens: maxOutputTokens,
|
||||||
|
...(responseFormat == null ? void 0 : responseFormat.type) === "json" && {
|
||||||
|
format: responseFormat.schema != null ? responseFormat.schema : "json"
|
||||||
|
},
|
||||||
|
think: (_a = ollamaOptions == null ? void 0 : ollamaOptions.think) != null ? _a : false,
|
||||||
|
- options: (_b = ollamaOptions == null ? void 0 : ollamaOptions.options) != null ? _b : void 0
|
||||||
|
+ options: {
|
||||||
|
+ ...temperature !== void 0 && { temperature },
|
||||||
|
+ ...topP !== void 0 && { top_p: topP },
|
||||||
|
+ ...((_b = ollamaOptions == null ? void 0 : ollamaOptions.options) != null ? _b : {})
|
||||||
|
+ }
|
||||||
|
};
|
||||||
|
}
|
||||||
|
};
|
||||||
21
CLAUDE.md
@ -10,15 +10,25 @@ This file provides guidance to AI coding assistants when working with code in th
|
|||||||
- **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.
|
||||||
- **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.
|
- **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.
|
||||||
|
- **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:`).
|
- **Write conventional commits**: Commit small, focused changes using Conventional Commit messages (e.g., `feat:`, `fix:`, `refactor:`, `docs:`).
|
||||||
|
|
||||||
|
## Pull Request Workflow (CRITICAL)
|
||||||
|
|
||||||
|
When creating a Pull Request, you MUST:
|
||||||
|
|
||||||
|
1. **Read the PR template first**: Always read `.github/pull_request_template.md` before creating the PR
|
||||||
|
2. **Follow ALL template sections**: Structure the `--body` parameter to include every section from the template
|
||||||
|
3. **Never skip sections**: Include all sections even if marking them as N/A or "None"
|
||||||
|
4. **Use proper formatting**: Match the template's markdown structure exactly (headings, checkboxes, code blocks)
|
||||||
|
|
||||||
## Development Commands
|
## Development Commands
|
||||||
|
|
||||||
- **Install**: `yarn install` - Install all project dependencies
|
- **Install**: `yarn install` - Install all project dependencies
|
||||||
- **Development**: `yarn dev` - Runs Electron app in development mode with hot reload
|
- **Development**: `yarn dev` - Runs Electron app in development mode with hot reload
|
||||||
- **Debug**: `yarn debug` - Starts with debugging enabled, use `chrome://inspect` to attach debugger
|
- **Debug**: `yarn debug` - Starts with debugging enabled, use `chrome://inspect` to attach debugger
|
||||||
- **Build Check**: `yarn build:check` - **REQUIRED** before commits (lint + test + typecheck)
|
- **Build Check**: `yarn build:check` - **REQUIRED** before commits (lint + test + typecheck)
|
||||||
- If having i18n sort issues, run `yarn sync:i18n` first to sync template
|
- If having i18n sort issues, run `yarn i18n:sync` first to sync template
|
||||||
- If having formatting issues, run `yarn format` first
|
- If having formatting issues, run `yarn format` first
|
||||||
- **Test**: `yarn test` - Run all tests (Vitest) across main and renderer processes
|
- **Test**: `yarn test` - Run all tests (Vitest) across main and renderer processes
|
||||||
- **Single Test**:
|
- **Single Test**:
|
||||||
@ -30,20 +40,23 @@ This file provides guidance to AI coding assistants when working with code in th
|
|||||||
## Project Architecture
|
## Project Architecture
|
||||||
|
|
||||||
### Electron Structure
|
### Electron Structure
|
||||||
|
|
||||||
- **Main Process** (`src/main/`): Node.js backend with services (MCP, Knowledge, Storage, etc.)
|
- **Main Process** (`src/main/`): Node.js backend with services (MCP, Knowledge, Storage, etc.)
|
||||||
- **Renderer Process** (`src/renderer/`): React UI with Redux state management
|
- **Renderer Process** (`src/renderer/`): React UI with Redux state management
|
||||||
- **Preload Scripts** (`src/preload/`): Secure IPC bridge
|
- **Preload Scripts** (`src/preload/`): Secure IPC bridge
|
||||||
|
|
||||||
### Key Components
|
### Key Components
|
||||||
|
|
||||||
- **AI Core** (`src/renderer/src/aiCore/`): Middleware pipeline for multiple AI providers.
|
- **AI Core** (`src/renderer/src/aiCore/`): Middleware pipeline for multiple AI providers.
|
||||||
- **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.
|
||||||
|
|
||||||
### Logging
|
### Logging
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { loggerService } from '@logger'
|
import { loggerService } from "@logger";
|
||||||
const logger = loggerService.withContext('moduleName')
|
const logger = loggerService.withContext("moduleName");
|
||||||
// Renderer: loggerService.initWindowSource('windowName') first
|
// Renderer: loggerService.initWindowSource('windowName') first
|
||||||
logger.info('message', CONTEXT)
|
logger.info("message", CONTEXT);
|
||||||
```
|
```
|
||||||
|
|||||||
@ -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,7 +60,7 @@ 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
|
||||||
|
|
||||||
|
|||||||
@ -34,7 +34,7 @@
|
|||||||
</a>
|
</a>
|
||||||
</h1>
|
</h1>
|
||||||
|
|
||||||
<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/zh/README.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/en/guides/development.md">Development</a> | <a href="https://github.com/CherryHQ/cherry-studio/issues">Feedback</a><br></p>
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
@ -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
|
||||||
|
|
||||||
@ -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
|
||||||
|
|
||||||
|
|||||||
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,7 +14,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
"includes": ["**/*.json", "!*.json", "!**/package.json"]
|
"includes": ["**/*.json", "!*.json", "!**/package.json", "!coverage/**"]
|
||||||
},
|
},
|
||||||
"css": {
|
"css": {
|
||||||
"formatter": {
|
"formatter": {
|
||||||
@ -23,7 +23,7 @@
|
|||||||
},
|
},
|
||||||
"files": {
|
"files": {
|
||||||
"ignoreUnknown": false,
|
"ignoreUnknown": false,
|
||||||
"includes": ["**", "!**/.claude/**"],
|
"includes": ["**", "!**/.claude/**", "!**/.vscode/**", "!**/.conductor/**"],
|
||||||
"maxSize": 2097152
|
"maxSize": 2097152
|
||||||
},
|
},
|
||||||
"formatter": {
|
"formatter": {
|
||||||
|
|||||||
@ -12,8 +12,13 @@
|
|||||||
|
|
||||||
; https://github.com/electron-userland/electron-builder/issues/1122
|
; https://github.com/electron-userland/electron-builder/issues/1122
|
||||||
!ifndef BUILD_UNINSTALLER
|
!ifndef BUILD_UNINSTALLER
|
||||||
|
; Check VC++ Redistributable based on architecture stored in $1
|
||||||
Function checkVCRedist
|
Function checkVCRedist
|
||||||
ReadRegDWORD $0 HKLM "SOFTWARE\Microsoft\VisualStudio\14.0\VC\Runtimes\x64" "Installed"
|
${If} $1 == "arm64"
|
||||||
|
ReadRegDWORD $0 HKLM "SOFTWARE\Microsoft\VisualStudio\14.0\VC\Runtimes\ARM64" "Installed"
|
||||||
|
${Else}
|
||||||
|
ReadRegDWORD $0 HKLM "SOFTWARE\Microsoft\VisualStudio\14.0\VC\Runtimes\x64" "Installed"
|
||||||
|
${EndIf}
|
||||||
FunctionEnd
|
FunctionEnd
|
||||||
|
|
||||||
Function checkArchitectureCompatibility
|
Function checkArchitectureCompatibility
|
||||||
@ -97,29 +102,47 @@
|
|||||||
|
|
||||||
Call checkVCRedist
|
Call checkVCRedist
|
||||||
${If} $0 != "1"
|
${If} $0 != "1"
|
||||||
MessageBox MB_YESNO "\
|
; VC++ is required - install automatically since declining would abort anyway
|
||||||
NOTE: ${PRODUCT_NAME} requires $\r$\n\
|
; Select download URL based on system architecture (stored in $1)
|
||||||
'Microsoft Visual C++ Redistributable'$\r$\n\
|
${If} $1 == "arm64"
|
||||||
to function properly.$\r$\n$\r$\n\
|
StrCpy $2 "https://aka.ms/vs/17/release/vc_redist.arm64.exe"
|
||||||
Download and install now?" /SD IDYES IDYES InstallVCRedist IDNO DontInstall
|
StrCpy $3 "$TEMP\vc_redist.arm64.exe"
|
||||||
InstallVCRedist:
|
${Else}
|
||||||
inetc::get /CAPTION " " /BANNER "Downloading Microsoft Visual C++ Redistributable..." "https://aka.ms/vs/17/release/vc_redist.x64.exe" "$TEMP\vc_redist.x64.exe"
|
StrCpy $2 "https://aka.ms/vs/17/release/vc_redist.x64.exe"
|
||||||
ExecWait "$TEMP\vc_redist.x64.exe /install /norestart"
|
StrCpy $3 "$TEMP\vc_redist.x64.exe"
|
||||||
;IfErrors InstallError ContinueInstall ; vc_redist exit code is unreliable :(
|
${EndIf}
|
||||||
Call checkVCRedist
|
|
||||||
${If} $0 == "1"
|
|
||||||
Goto ContinueInstall
|
|
||||||
${EndIf}
|
|
||||||
|
|
||||||
;InstallError:
|
inetc::get /CAPTION " " /BANNER "Downloading Microsoft Visual C++ Redistributable..." \
|
||||||
MessageBox MB_ICONSTOP "\
|
$2 $3 /END
|
||||||
There was an unexpected error installing$\r$\n\
|
Pop $0 ; Get download status from inetc::get
|
||||||
Microsoft Visual C++ Redistributable.$\r$\n\
|
${If} $0 != "OK"
|
||||||
The installation of ${PRODUCT_NAME} cannot continue."
|
MessageBox MB_ICONSTOP|MB_YESNO "\
|
||||||
DontInstall:
|
Failed to download Microsoft Visual C++ Redistributable.$\r$\n$\r$\n\
|
||||||
|
Error: $0$\r$\n$\r$\n\
|
||||||
|
Would you like to open the download page in your browser?$\r$\n\
|
||||||
|
$2" IDYES openDownloadUrl IDNO skipDownloadUrl
|
||||||
|
openDownloadUrl:
|
||||||
|
ExecShell "open" $2
|
||||||
|
skipDownloadUrl:
|
||||||
Abort
|
Abort
|
||||||
|
${EndIf}
|
||||||
|
|
||||||
|
ExecWait "$3 /install /quiet /norestart"
|
||||||
|
; Note: vc_redist exit code is unreliable, verify via registry check instead
|
||||||
|
|
||||||
|
Call checkVCRedist
|
||||||
|
${If} $0 != "1"
|
||||||
|
MessageBox MB_ICONSTOP|MB_YESNO "\
|
||||||
|
Microsoft Visual C++ Redistributable installation failed.$\r$\n$\r$\n\
|
||||||
|
Would you like to open the download page in your browser?$\r$\n\
|
||||||
|
$2$\r$\n$\r$\n\
|
||||||
|
The installation of ${PRODUCT_NAME} cannot continue." IDYES openInstallUrl IDNO skipInstallUrl
|
||||||
|
openInstallUrl:
|
||||||
|
ExecShell "open" $2
|
||||||
|
skipInstallUrl:
|
||||||
|
Abort
|
||||||
|
${EndIf}
|
||||||
${EndIf}
|
${EndIf}
|
||||||
ContinueInstall:
|
|
||||||
Pop $4
|
Pop $4
|
||||||
Pop $3
|
Pop $3
|
||||||
Pop $2
|
Pop $2
|
||||||
|
|||||||
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,11 +18,11 @@ The plugin has already been configured in the project — simply install it to g
|
|||||||
|
|
||||||
### Demo
|
### Demo
|
||||||
|
|
||||||

|

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

|

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

|

|
||||||
|
|
||||||
## i18n Conventions
|
## i18n Conventions
|
||||||
|
|
||||||
@ -71,7 +71,7 @@ Tools like i18n Ally cannot parse dynamic content within template strings, resul
|
|||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
// Not recommended - Plugin cannot resolve
|
// Not recommended - Plugin cannot resolve
|
||||||
const message = t(`fruits.${fruit}`)
|
const message = t(`fruits.${fruit}`);
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 2. **No Real-time Rendering in Editor**
|
#### 2. **No Real-time Rendering in Editor**
|
||||||
@ -91,14 +91,14 @@ For example:
|
|||||||
```ts
|
```ts
|
||||||
// src/renderer/src/i18n/label.ts
|
// src/renderer/src/i18n/label.ts
|
||||||
const themeModeKeyMap = {
|
const themeModeKeyMap = {
|
||||||
dark: 'settings.theme.dark',
|
dark: "settings.theme.dark",
|
||||||
light: 'settings.theme.light',
|
light: "settings.theme.light",
|
||||||
system: 'settings.theme.system'
|
system: "settings.theme.system",
|
||||||
} as const
|
} as const;
|
||||||
|
|
||||||
export const getThemeModeLabel = (key: string): string => {
|
export const getThemeModeLabel = (key: string): string => {
|
||||||
return themeModeKeyMap[key] ? t(themeModeKeyMap[key]) : key
|
return themeModeKeyMap[key] ? t(themeModeKeyMap[key]) : key;
|
||||||
}
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
By avoiding template strings, you gain better developer experience, more reliable translation checks, and a more maintainable codebase.
|
By avoiding template strings, you gain better developer experience, more reliable translation checks, and a more maintainable codebase.
|
||||||
@ -107,7 +107,7 @@ By avoiding template strings, you gain better developer experience, more reliabl
|
|||||||
|
|
||||||
The project includes several scripts to automate i18n-related tasks:
|
The project includes several scripts to automate i18n-related tasks:
|
||||||
|
|
||||||
### `check:i18n` - Validate i18n Structure
|
### `i18n:check` - Validate i18n Structure
|
||||||
|
|
||||||
This script checks:
|
This script checks:
|
||||||
|
|
||||||
@ -116,10 +116,10 @@ This script checks:
|
|||||||
- Whether keys are properly sorted
|
- Whether keys are properly sorted
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn check:i18n
|
yarn i18n:check
|
||||||
```
|
```
|
||||||
|
|
||||||
### `sync:i18n` - Synchronize JSON Structure and Sort Order
|
### `i18n:sync` - Synchronize JSON Structure and Sort Order
|
||||||
|
|
||||||
This script uses `zh-cn.json` as the source of truth to sync structure across all language files, including:
|
This script uses `zh-cn.json` as the source of truth to sync structure across all language files, including:
|
||||||
|
|
||||||
@ -128,14 +128,14 @@ This script uses `zh-cn.json` as the source of truth to sync structure across al
|
|||||||
3. Sorting keys automatically
|
3. Sorting keys automatically
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn sync:i18n
|
yarn i18n:sync
|
||||||
```
|
```
|
||||||
|
|
||||||
### `auto:i18n` - Automatically Translate Pending Texts
|
### `i18n:translate` - Automatically Translate Pending Texts
|
||||||
|
|
||||||
This script fills in texts marked as `[to be translated]` using machine translation.
|
This script fills in texts marked as `[to be translated]` using machine translation.
|
||||||
|
|
||||||
Typically, after adding new texts in `zh-cn.json`, run `sync:i18n`, then `auto:i18n` to complete translations.
|
Typically, after adding new texts in `zh-cn.json`, run `i18n:sync`, then `i18n:translate` to complete translations.
|
||||||
|
|
||||||
Before using this script, set the required environment variables:
|
Before using this script, set the required environment variables:
|
||||||
|
|
||||||
@ -148,30 +148,20 @@ MODEL="qwen-plus-latest"
|
|||||||
Alternatively, add these variables directly to your `.env` file.
|
Alternatively, add these variables directly to your `.env` file.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn auto:i18n
|
yarn i18n:translate
|
||||||
```
|
|
||||||
|
|
||||||
### `update:i18n` - Object-level Translation Update
|
|
||||||
|
|
||||||
Updates translations in language files under `src/renderer/src/i18n/translate` at the object level, preserving existing translations and only updating new content.
|
|
||||||
|
|
||||||
**Not recommended** — prefer `auto:i18n` for translation tasks.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
yarn update:i18n
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Workflow
|
### Workflow
|
||||||
|
|
||||||
1. During development, first add the required text in `zh-cn.json`
|
1. During development, first add the required text in `zh-cn.json`
|
||||||
2. Confirm it displays correctly in the Chinese environment
|
2. Confirm it displays correctly in the Chinese environment
|
||||||
3. Run `yarn sync:i18n` to propagate the keys to other language files
|
3. Run `yarn i18n:sync` to propagate the keys to other language files
|
||||||
4. Run `yarn auto:i18n` to perform machine translation
|
4. Run `yarn i18n:translate` to perform machine translation
|
||||||
5. Grab a coffee and let the magic happen!
|
5. Grab a coffee and let the magic happen!
|
||||||
|
|
||||||
## Best Practices
|
## Best Practices
|
||||||
|
|
||||||
1. **Use Chinese as Source Language**: All development starts in Chinese, then translates to other languages.
|
1. **Use Chinese as Source Language**: All development starts in Chinese, then translates to other languages.
|
||||||
2. **Run Check Script Before Commit**: Use `yarn check:i18n` to catch i18n issues early.
|
2. **Run Check Script Before Commit**: Use `yarn i18n:check` to catch i18n issues early.
|
||||||
3. **Translate in Small Increments**: Avoid accumulating a large backlog of untranslated content.
|
3. **Translate in Small Increments**: Avoid accumulating a large backlog of untranslated content.
|
||||||
4. **Keep Keys Semantically Clear**: Keys should clearly express their purpose, e.g., `user.profile.avatar.upload.error`
|
4. **Keep Keys Semantically Clear**: Keys should clearly express their purpose, e.g., `user.profile.avatar.upload.error`
|
||||||
@ -19,7 +19,7 @@ Users are welcome to submit issues or provide feedback through other channels fo
|
|||||||
|
|
||||||
### 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` 结合使用,方便地在组件中获取消息数据、加载状态,并执行相关操作。
|
|
||||||
@ -34,7 +34,7 @@
|
|||||||
</a>
|
</a>
|
||||||
</h1>
|
</h1>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://github.com/CherryHQ/cherry-studio">English</a> | 中文 | <a href="https://cherry-ai.com">官方网站</a> | <a href="https://docs.cherry-ai.com/cherry-studio-wen-dang/zh-cn">文档</a> | <a href="./dev.md">开发</a> | <a href="https://github.com/CherryHQ/cherry-studio/issues">反馈</a><br>
|
<a href="https://github.com/CherryHQ/cherry-studio">English</a> | 中文 | <a href="https://cherry-ai.com">官方网站</a> | <a href="https://docs.cherry-ai.com/cherry-studio-wen-dang/zh-cn">文档</a> | <a href="./guides/development.md">开发</a> | <a href="https://github.com/CherryHQ/cherry-studio/issues">反馈</a><br>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<!-- 题头徽章组合 -->
|
<!-- 题头徽章组合 -->
|
||||||
@ -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,11 +60,11 @@ 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)。
|
||||||
|
|
||||||
### 其他建议
|
### 其他建议
|
||||||
|
|
||||||
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
|
||||||
|
```
|
||||||
@ -1,31 +1,31 @@
|
|||||||
# 如何优雅地做好 i18n
|
# 如何优雅地做好 i18n
|
||||||
|
|
||||||
## 使用i18n ally插件提升开发体验
|
## 使用 i18n ally 插件提升开发体验
|
||||||
|
|
||||||
i18n ally是一个强大的VSCode插件,它能在开发阶段提供实时反馈,帮助开发者更早发现文案缺失和错译问题。
|
i18n ally 是一个强大的 VSCode 插件,它能在开发阶段提供实时反馈,帮助开发者更早发现文案缺失和错译问题。
|
||||||
|
|
||||||
项目中已经配置好了插件设置,直接安装即可。
|
项目中已经配置好了插件设置,直接安装即可。
|
||||||
|
|
||||||
### 开发时优势
|
### 开发时优势
|
||||||
|
|
||||||
- **实时预览**:翻译文案会直接显示在编辑器中
|
- **实时预览**:翻译文案会直接显示在编辑器中
|
||||||
- **错误检测**:自动追踪标记出缺失的翻译或未使用的key
|
- **错误检测**:自动追踪标记出缺失的翻译或未使用的 key
|
||||||
- **快速跳转**:可通过key直接跳转到定义处(Ctrl/Cmd + click)
|
- **快速跳转**:可通过 key 直接跳转到定义处(Ctrl/Cmd + click)
|
||||||
- **自动补全**:输入i18n key时提供自动补全建议
|
- **自动补全**:输入 i18n key 时提供自动补全建议
|
||||||
|
|
||||||
### 效果展示
|
### 效果展示
|
||||||
|
|
||||||

|

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

|

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

|

|
||||||
|
|
||||||
## i18n 约定
|
## i18n 约定
|
||||||
|
|
||||||
### **绝对避免使用flat格式**
|
### **绝对避免使用 flat 格式**
|
||||||
|
|
||||||
绝对避免使用flat格式,如`"add.button.tip": "添加"`。应采用清晰的嵌套结构:
|
绝对避免使用 flat 格式,如`"add.button.tip": "添加"`。应采用清晰的嵌套结构:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
// 错误示例 - flat结构
|
// 错误示例 - flat结构
|
||||||
@ -52,14 +52,14 @@ i18n ally是一个强大的VSCode插件,它能在开发阶段提供实时反
|
|||||||
#### 为什么要使用嵌套结构
|
#### 为什么要使用嵌套结构
|
||||||
|
|
||||||
1. **自然分组**:通过对象结构天然能将相关上下文的文案分到一个组别中
|
1. **自然分组**:通过对象结构天然能将相关上下文的文案分到一个组别中
|
||||||
2. **插件要求**:i18n ally 插件需要嵌套或flat格式其一的文件才能正常分析
|
2. **插件要求**:i18n ally 插件需要嵌套或 flat 格式其一的文件才能正常分析
|
||||||
|
|
||||||
### **避免在`t()`中使用模板字符串**
|
### **避免在`t()`中使用模板字符串**
|
||||||
|
|
||||||
**强烈建议避免使用模板字符串**进行动态插值。虽然模板字符串在JavaScript开发中非常方便,但在国际化场景下会带来一系列问题。
|
**强烈建议避免使用模板字符串**进行动态插值。虽然模板字符串在 JavaScript 开发中非常方便,但在国际化场景下会带来一系列问题。
|
||||||
|
|
||||||
1. **插件无法跟踪**
|
1. **插件无法跟踪**
|
||||||
i18n ally等工具无法解析模板字符串中的动态内容,导致:
|
i18n ally 等工具无法解析模板字符串中的动态内容,导致:
|
||||||
|
|
||||||
- 无法正确显示实时预览
|
- 无法正确显示实时预览
|
||||||
- 无法检测翻译缺失
|
- 无法检测翻译缺失
|
||||||
@ -67,11 +67,11 @@ i18n ally是一个强大的VSCode插件,它能在开发阶段提供实时反
|
|||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
// 不推荐 - 插件无法解析
|
// 不推荐 - 插件无法解析
|
||||||
const message = t(`fruits.${fruit}`)
|
const message = t(`fruits.${fruit}`);
|
||||||
```
|
```
|
||||||
|
|
||||||
2. **编辑器无法实时渲染**
|
2. **编辑器无法实时渲染**
|
||||||
在IDE中,模板字符串会显示为原始代码而非最终翻译结果,降低了开发体验。
|
在 IDE 中,模板字符串会显示为原始代码而非最终翻译结果,降低了开发体验。
|
||||||
|
|
||||||
3. **更难以维护**
|
3. **更难以维护**
|
||||||
由于插件无法跟踪这样的文案,编辑器中也无法渲染,开发者必须人工确认语言文件中是否存在相应的文案。
|
由于插件无法跟踪这样的文案,编辑器中也无法渲染,开发者必须人工确认语言文件中是否存在相应的文案。
|
||||||
@ -85,36 +85,36 @@ i18n ally是一个强大的VSCode插件,它能在开发阶段提供实时反
|
|||||||
```ts
|
```ts
|
||||||
// src/renderer/src/i18n/label.ts
|
// src/renderer/src/i18n/label.ts
|
||||||
const themeModeKeyMap = {
|
const themeModeKeyMap = {
|
||||||
dark: 'settings.theme.dark',
|
dark: "settings.theme.dark",
|
||||||
light: 'settings.theme.light',
|
light: "settings.theme.light",
|
||||||
system: 'settings.theme.system'
|
system: "settings.theme.system",
|
||||||
} as const
|
} as const;
|
||||||
|
|
||||||
export const getThemeModeLabel = (key: string): string => {
|
export const getThemeModeLabel = (key: string): string => {
|
||||||
return themeModeKeyMap[key] ? t(themeModeKeyMap[key]) : key
|
return themeModeKeyMap[key] ? t(themeModeKeyMap[key]) : key;
|
||||||
}
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
通过避免模板字符串,可以获得更好的开发体验、更可靠的翻译检查以及更易维护的代码库。
|
通过避免模板字符串,可以获得更好的开发体验、更可靠的翻译检查以及更易维护的代码库。
|
||||||
|
|
||||||
## 自动化脚本
|
## 自动化脚本
|
||||||
|
|
||||||
项目中有一系列脚本来自动化i18n相关任务:
|
项目中有一系列脚本来自动化 i18n 相关任务:
|
||||||
|
|
||||||
### `check:i18n` - 检查i18n结构
|
### `i18n:check` - 检查 i18n 结构
|
||||||
|
|
||||||
此脚本会检查:
|
此脚本会检查:
|
||||||
|
|
||||||
- 所有语言文件是否为嵌套结构
|
- 所有语言文件是否为嵌套结构
|
||||||
- 是否存在缺失的key
|
- 是否存在缺失的 key
|
||||||
- 是否存在多余的key
|
- 是否存在多余的 key
|
||||||
- 是否已经有序
|
- 是否已经有序
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn check:i18n
|
yarn i18n:check
|
||||||
```
|
```
|
||||||
|
|
||||||
### `sync:i18n` - 同步json结构与排序
|
### `i18n:sync` - 同步 json 结构与排序
|
||||||
|
|
||||||
此脚本以`zh-cn.json`文件为基准,将结构同步到其他语言文件,包括:
|
此脚本以`zh-cn.json`文件为基准,将结构同步到其他语言文件,包括:
|
||||||
|
|
||||||
@ -123,14 +123,14 @@ yarn check:i18n
|
|||||||
3. 自动排序
|
3. 自动排序
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn sync:i18n
|
yarn i18n:sync
|
||||||
```
|
```
|
||||||
|
|
||||||
### `auto:i18n` - 自动翻译待翻译文本
|
### `i18n:translate` - 自动翻译待翻译文本
|
||||||
|
|
||||||
次脚本自动将标记为待翻译的文本通过机器翻译填充。
|
次脚本自动将标记为待翻译的文本通过机器翻译填充。
|
||||||
|
|
||||||
通常,在`zh-cn.json`中添加所需文案后,执行`sync:i18n`即可自动完成翻译。
|
通常,在`zh-cn.json`中添加所需文案后,执行`i18n:sync`即可自动完成翻译。
|
||||||
|
|
||||||
使用该脚本前,需要配置环境变量,例如:
|
使用该脚本前,需要配置环境变量,例如:
|
||||||
|
|
||||||
@ -143,29 +143,19 @@ MODEL="qwen-plus-latest"
|
|||||||
你也可以通过直接编辑`.env`文件来添加环境变量。
|
你也可以通过直接编辑`.env`文件来添加环境变量。
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn auto:i18n
|
yarn i18n:translate
|
||||||
```
|
|
||||||
|
|
||||||
### `update:i18n` - 对象级别翻译更新
|
|
||||||
|
|
||||||
对`src/renderer/src/i18n/translate`中的语言文件进行对象级别的翻译更新,保留已有翻译,只更新新增内容。
|
|
||||||
|
|
||||||
**不建议**使用该脚本,更推荐使用`auto:i18n`进行翻译。
|
|
||||||
|
|
||||||
```bash
|
|
||||||
yarn update:i18n
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### 工作流
|
### 工作流
|
||||||
|
|
||||||
1. 开发阶段,先在`zh-cn.json`中添加所需文案
|
1. 开发阶段,先在`zh-cn.json`中添加所需文案
|
||||||
2. 确认在中文环境下显示无误后,使用`yarn sync:i18n`将文案同步到其他语言文件
|
2. 确认在中文环境下显示无误后,使用`yarn i18n:sync`将文案同步到其他语言文件
|
||||||
3. 使用`yarn auto:i18n`进行自动翻译
|
3. 使用`yarn i18n:translate`进行自动翻译
|
||||||
4. 喝杯咖啡,等翻译完成吧!
|
4. 喝杯咖啡,等翻译完成吧!
|
||||||
|
|
||||||
## 最佳实践
|
## 最佳实践
|
||||||
|
|
||||||
1. **以中文为源语言**:所有开发首先使用中文,再翻译为其他语言
|
1. **以中文为源语言**:所有开发首先使用中文,再翻译为其他语言
|
||||||
2. **提交前运行检查脚本**:使用`yarn check:i18n`检查i18n是否有问题
|
2. **提交前运行检查脚本**:使用`yarn i18n:check`检查 i18n 是否有问题
|
||||||
3. **小步提交翻译**:避免积累大量未翻译文本
|
3. **小步提交翻译**:避免积累大量未翻译文本
|
||||||
4. **保持key语义明确**:key应能清晰表达其用途,如`user.profile.avatar.upload.error`
|
4. **保持 key 语义明确**:key 应能清晰表达其用途,如`user.profile.avatar.upload.error`
|
||||||
@ -19,7 +19,7 @@
|
|||||||
|
|
||||||
### 参与测试计划
|
### 参与测试计划
|
||||||
|
|
||||||
开发者按照[贡献者指南](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` 结合使用,方便地在组件中获取消息数据、加载状态,并执行相关操作。
|
||||||
@ -97,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.
|
||||||
@ -135,42 +134,38 @@ artifactBuildCompleted: scripts/artifact-build-completed.js
|
|||||||
releaseInfo:
|
releaseInfo:
|
||||||
releaseNotes: |
|
releaseNotes: |
|
||||||
<!--LANG:en-->
|
<!--LANG:en-->
|
||||||
What's New in v1.7.0-beta.6
|
Cherry Studio 1.7.6 - New Models & MCP Enhancements
|
||||||
|
|
||||||
New Features:
|
This release adds support for new AI models and includes a new MCP server for memory management.
|
||||||
- Enhanced Input Bar: Completely redesigned input bar with improved responsiveness and functionality
|
|
||||||
- Better File Handling: Improved drag-and-drop and paste support for images and documents
|
|
||||||
- Smart Tool Suggestions: Enhanced quick panel with better item selection and keyboard shortcuts
|
|
||||||
|
|
||||||
Improvements:
|
✨ New Features
|
||||||
- Smoother Input Experience: Better auto-resizing and text handling in chat input
|
- [Models] Add support for Xiaomi MiMo model
|
||||||
- Enhanced AI Performance: Improved connection stability and response speed
|
- [Models] Add support for Gemini 3 Flash and Pro model detection
|
||||||
- More Reliable File Uploads: Better support for various file types and upload scenarios
|
- [Models] Add support for Volcengine Doubao-Seed-1.8 model
|
||||||
- Cleaner Interface: Optimized UI elements for better visual consistency
|
- [MCP] Add Nowledge Mem builtin MCP server for memory management
|
||||||
|
- [Settings] Add default reasoning effort option to resolve confusion between undefined and none
|
||||||
|
|
||||||
Bug Fixes:
|
🐛 Bug Fixes
|
||||||
- Fixed image selection issue when adding custom AI providers
|
- [Azure] Restore deployment-based URLs for non-v1 apiVersion
|
||||||
- Fixed file upload problems with certain API configurations
|
- [Translation] Disable reasoning mode for translation to improve efficiency
|
||||||
- Fixed input bar responsiveness issues
|
- [Image] Update API path for image generation requests in OpenAIBaseClient
|
||||||
- Fixed quick panel not working properly in some situations
|
- [Windows] Auto-discover and persist Git Bash path on Windows for scoop users
|
||||||
|
|
||||||
<!--LANG:zh-CN-->
|
<!--LANG:zh-CN-->
|
||||||
v1.7.0-beta.6 新特性
|
Cherry Studio 1.7.6 - 新模型与 MCP 增强
|
||||||
|
|
||||||
新功能:
|
本次更新添加了多个新 AI 模型支持,并新增记忆管理 MCP 服务器。
|
||||||
- 增强输入栏:完全重新设计的输入栏,响应更灵敏,功能更强大
|
|
||||||
- 更好的文件处理:改进的拖拽和粘贴功能,支持图片和文档
|
|
||||||
- 智能工具建议:增强的快速面板,更好的项目选择和键盘快捷键
|
|
||||||
|
|
||||||
改进:
|
✨ 新功能
|
||||||
- 更流畅的输入体验:聊天输入框的自动调整和文本处理更佳
|
- [模型] 添加小米 MiMo 模型支持
|
||||||
- 增强 AI 性能:改进连接稳定性和响应速度
|
- [模型] 添加 Gemini 3 Flash 和 Pro 模型检测支持
|
||||||
- 更可靠的文件上传:更好地支持各种文件类型和上传场景
|
- [模型] 添加火山引擎 Doubao-Seed-1.8 模型支持
|
||||||
- 更简洁的界面:优化 UI 元素,视觉一致性更好
|
- [MCP] 新增 Nowledge Mem 内置 MCP 服务器,用于记忆管理
|
||||||
|
- [设置] 添加默认推理强度选项,解决 undefined 和 none 之间的混淆
|
||||||
|
|
||||||
问题修复:
|
🐛 问题修复
|
||||||
- 修复添加自定义 AI 提供商时的图片选择问题
|
- [Azure] 修复非 v1 apiVersion 的部署 URL 问题
|
||||||
- 修复某些 API 配置下的文件上传问题
|
- [翻译] 禁用翻译时的推理模式以提高效率
|
||||||
- 修复输入栏响应性问题
|
- [图像] 更新 OpenAIBaseClient 中图像生成请求的 API 路径
|
||||||
- 修复快速面板在某些情况下无法正常工作的问题
|
- [Windows] 自动发现并保存 Windows scoop 用户的 Git Bash 路径
|
||||||
<!--LANG:END-->
|
<!--LANG:END-->
|
||||||
|
|||||||
@ -58,8 +58,10 @@ export default defineConfig([
|
|||||||
'dist/**',
|
'dist/**',
|
||||||
'out/**',
|
'out/**',
|
||||||
'local/**',
|
'local/**',
|
||||||
|
'tests/**',
|
||||||
'.yarn/**',
|
'.yarn/**',
|
||||||
'.gitignore',
|
'.gitignore',
|
||||||
|
'.conductor/**',
|
||||||
'scripts/cloudflare-worker.js',
|
'scripts/cloudflare-worker.js',
|
||||||
'src/main/integration/nutstore/sso/lib/**',
|
'src/main/integration/nutstore/sso/lib/**',
|
||||||
'src/main/integration/cherryai/index.js',
|
'src/main/integration/cherryai/index.js',
|
||||||
|
|||||||
78
package.json
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "CherryStudio",
|
"name": "CherryStudio",
|
||||||
"version": "1.7.0-beta.3",
|
"version": "1.7.6",
|
||||||
"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",
|
||||||
@ -53,14 +53,16 @@
|
|||||||
"typecheck": "concurrently -n \"node,web\" -c \"cyan,magenta\" \"npm run typecheck:node\" \"npm run typecheck:web\"",
|
"typecheck": "concurrently -n \"node,web\" -c \"cyan,magenta\" \"npm run typecheck:node\" \"npm run typecheck:web\"",
|
||||||
"typecheck:node": "tsgo --noEmit -p tsconfig.node.json --composite false",
|
"typecheck:node": "tsgo --noEmit -p tsconfig.node.json --composite false",
|
||||||
"typecheck:web": "tsgo --noEmit -p tsconfig.web.json --composite false",
|
"typecheck:web": "tsgo --noEmit -p tsconfig.web.json --composite false",
|
||||||
"check:i18n": "dotenv -e .env -- tsx scripts/check-i18n.ts",
|
"i18n:check": "dotenv -e .env -- tsx scripts/check-i18n.ts",
|
||||||
"sync:i18n": "dotenv -e .env -- tsx scripts/sync-i18n.ts",
|
"i18n:sync": "dotenv -e .env -- tsx scripts/sync-i18n.ts",
|
||||||
"update:i18n": "dotenv -e .env -- tsx scripts/update-i18n.ts",
|
"i18n:translate": "dotenv -e .env -- tsx scripts/auto-translate-i18n.ts",
|
||||||
"auto:i18n": "dotenv -e .env -- tsx scripts/auto-translate-i18n.ts",
|
"i18n:all": "yarn i18n:check && yarn i18n:sync && yarn i18n:translate",
|
||||||
"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",
|
||||||
|
"test:aicore": "vitest run --project aiCore",
|
||||||
"test:update": "yarn test:renderer --update",
|
"test:update": "yarn test:renderer --update",
|
||||||
"test:coverage": "vitest run --coverage --silent",
|
"test:coverage": "vitest run --coverage --silent",
|
||||||
"test:ui": "vitest --ui",
|
"test:ui": "vitest --ui",
|
||||||
@ -68,22 +70,24 @@
|
|||||||
"test:e2e": "yarn playwright test",
|
"test:e2e": "yarn playwright test",
|
||||||
"test:lint": "oxlint --deny-warnings && eslint . --ext .js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --cache",
|
"test:lint": "oxlint --deny-warnings && eslint . --ext .js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --cache",
|
||||||
"test:scripts": "vitest scripts",
|
"test:scripts": "vitest scripts",
|
||||||
"lint": "oxlint --fix && eslint . --ext .js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --cache && yarn typecheck && yarn check:i18n && yarn format:check",
|
"lint": "oxlint --fix && eslint . --ext .js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --cache && yarn typecheck && yarn i18n:check && yarn format:check",
|
||||||
"format": "biome format --write && biome lint --write",
|
"format": "biome format --write && biome lint --write",
|
||||||
"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.30#~/.yarn/patches/@anthropic-ai-claude-agent-sdk-npm-0.1.30-b50a299674.patch",
|
"@anthropic-ai/claude-agent-sdk": "patch:@anthropic-ai/claude-agent-sdk@npm%3A0.1.62#~/.yarn/patches/@anthropic-ai-claude-agent-sdk-npm-0.1.62-23ae56f8c8.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",
|
"@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",
|
||||||
@ -106,11 +110,17 @@
|
|||||||
"@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.53",
|
"@ai-sdk/amazon-bedrock": "^3.0.61",
|
||||||
"@ai-sdk/google-vertex": "^3.0.62",
|
"@ai-sdk/anthropic": "^2.0.49",
|
||||||
"@ai-sdk/huggingface": "patch:@ai-sdk/huggingface@npm%3A0.0.8#~/.yarn/patches/@ai-sdk-huggingface-npm-0.0.8-d4d0aaac93.patch",
|
"@ai-sdk/cerebras": "^1.0.31",
|
||||||
"@ai-sdk/mistral": "^2.0.23",
|
"@ai-sdk/gateway": "^2.0.15",
|
||||||
"@ai-sdk/perplexity": "^2.0.17",
|
"@ai-sdk/google": "patch:@ai-sdk/google@npm%3A2.0.49#~/.yarn/patches/@ai-sdk-google-npm-2.0.49-84720f41bd.patch",
|
||||||
|
"@ai-sdk/google-vertex": "^3.0.94",
|
||||||
|
"@ai-sdk/huggingface": "^0.0.10",
|
||||||
|
"@ai-sdk/mistral": "^2.0.24",
|
||||||
|
"@ai-sdk/openai": "patch:@ai-sdk/openai@npm%3A2.0.85#~/.yarn/patches/@ai-sdk-openai-npm-2.0.85-27483d1d6a.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",
|
||||||
@ -118,7 +128,7 @@
|
|||||||
"@aws-sdk/client-bedrock-runtime": "^3.910.0",
|
"@aws-sdk/client-bedrock-runtime": "^3.910.0",
|
||||||
"@aws-sdk/client-s3": "^3.910.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",
|
||||||
@ -132,7 +142,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.12.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",
|
||||||
@ -152,18 +162,18 @@
|
|||||||
"@langchain/core": "patch:@langchain/core@npm%3A1.0.2#~/.yarn/patches/@langchain-core-npm-1.0.2-183ef83fe4.patch",
|
"@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",
|
"@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.23.0",
|
||||||
"@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.2.0",
|
"@openrouter/ai-sdk-provider": "^1.2.8",
|
||||||
"@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.55.1",
|
||||||
"@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",
|
||||||
"@shikijs/markdown-it": "^3.12.0",
|
"@shikijs/markdown-it": "^3.12.0",
|
||||||
@ -197,6 +207,7 @@
|
|||||||
"@types/content-type": "^1.1.9",
|
"@types/content-type": "^1.1.9",
|
||||||
"@types/cors": "^2.8.19",
|
"@types/cors": "^2.8.19",
|
||||||
"@types/diff": "^7",
|
"@types/diff": "^7",
|
||||||
|
"@types/dotenv": "^8.2.3",
|
||||||
"@types/express": "^5",
|
"@types/express": "^5",
|
||||||
"@types/fs-extra": "^11",
|
"@types/fs-extra": "^11",
|
||||||
"@types/he": "^1",
|
"@types/he": "^1",
|
||||||
@ -208,8 +219,8 @@
|
|||||||
"@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",
|
||||||
@ -231,7 +242,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.90",
|
"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",
|
||||||
@ -257,12 +268,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",
|
||||||
@ -307,12 +318,12 @@
|
|||||||
"motion": "^12.10.5",
|
"motion": "^12.10.5",
|
||||||
"notion-helper": "^1.3.22",
|
"notion-helper": "^1.3.22",
|
||||||
"npx-scope-finder": "^1.2.0",
|
"npx-scope-finder": "^1.2.0",
|
||||||
|
"ollama-ai-provider-v2": "patch:ollama-ai-provider-v2@npm%3A1.5.5#~/.yarn/patches/ollama-ai-provider-v2-npm-1.5.5-8bef249af9.patch",
|
||||||
"oxlint": "^1.22.0",
|
"oxlint": "^1.22.0",
|
||||||
"oxlint-tsgolint": "^0.2.0",
|
"oxlint-tsgolint": "^0.2.0",
|
||||||
"p-queue": "^8.1.0",
|
"p-queue": "^8.1.0",
|
||||||
"pdf-lib": "^1.17.1",
|
"pdf-lib": "^1.17.1",
|
||||||
"pdf-parse": "^1.1.1",
|
"pdf-parse": "^1.1.1",
|
||||||
"playwright": "^1.55.1",
|
|
||||||
"proxy-agent": "^6.5.0",
|
"proxy-agent": "^6.5.0",
|
||||||
"react": "^19.2.0",
|
"react": "^19.2.0",
|
||||||
"react-dom": "^19.2.0",
|
"react-dom": "^19.2.0",
|
||||||
@ -379,13 +390,11 @@
|
|||||||
"@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%3A1.0.2#~/.yarn/patches/@langchain-core-npm-1.0.2-183ef83fe4.patch",
|
"@langchain/core@npm:^0.3.26": "patch:@langchain/core@npm%3A1.0.2#~/.yarn/patches/@langchain-core-npm-1.0.2-183ef83fe4.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",
|
||||||
@ -405,9 +414,10 @@
|
|||||||
"@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.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.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",
|
"@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.64": "patch:@ai-sdk/openai@npm%3A2.0.64#~/.yarn/patches/@ai-sdk-openai-npm-2.0.64-48f99f5bf3.patch",
|
"@ai-sdk/openai@npm:^2.0.42": "patch:@ai-sdk/openai@npm%3A2.0.85#~/.yarn/patches/@ai-sdk-openai-npm-2.0.85-27483d1d6a.patch",
|
||||||
"@ai-sdk/openai@npm:^2.0.42": "patch:@ai-sdk/openai@npm%3A2.0.64#~/.yarn/patches/@ai-sdk-openai-npm-2.0.64-48f99f5bf3.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/google@npm:2.0.31": "patch:@ai-sdk/google@npm%3A2.0.31#~/.yarn/patches/@ai-sdk-google-npm-2.0.31-b0de047210.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",
|
||||||
|
"@ai-sdk/google@npm:2.0.49": "patch:@ai-sdk/google@npm%3A2.0.49#~/.yarn/patches/@ai-sdk-google-npm-2.0.49-84720f41bd.patch"
|
||||||
},
|
},
|
||||||
"packageManager": "yarn@4.9.1",
|
"packageManager": "yarn@4.9.1",
|
||||||
"lint-staged": {
|
"lint-staged": {
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@cherrystudio/ai-sdk-provider",
|
"name": "@cherrystudio/ai-sdk-provider",
|
||||||
"version": "0.1.0",
|
"version": "0.1.3",
|
||||||
"description": "Cherry Studio AI SDK provider bundle with CherryIN routing.",
|
"description": "Cherry Studio AI SDK provider bundle with CherryIN routing.",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"ai-sdk",
|
"ai-sdk",
|
||||||
@ -41,8 +41,9 @@
|
|||||||
"ai": "^5.0.26"
|
"ai": "^5.0.26"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
"@ai-sdk/openai-compatible": "^1.0.28",
|
||||||
"@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"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"tsdown": "^0.13.3",
|
"tsdown": "^0.13.3",
|
||||||
|
|||||||
@ -2,7 +2,6 @@ import { AnthropicMessagesLanguageModel } from '@ai-sdk/anthropic/internal'
|
|||||||
import { GoogleGenerativeAILanguageModel } from '@ai-sdk/google/internal'
|
import { GoogleGenerativeAILanguageModel } from '@ai-sdk/google/internal'
|
||||||
import type { OpenAIProviderSettings } from '@ai-sdk/openai'
|
import type { OpenAIProviderSettings } from '@ai-sdk/openai'
|
||||||
import {
|
import {
|
||||||
OpenAIChatLanguageModel,
|
|
||||||
OpenAICompletionLanguageModel,
|
OpenAICompletionLanguageModel,
|
||||||
OpenAIEmbeddingModel,
|
OpenAIEmbeddingModel,
|
||||||
OpenAIImageModel,
|
OpenAIImageModel,
|
||||||
@ -10,6 +9,7 @@ import {
|
|||||||
OpenAISpeechModel,
|
OpenAISpeechModel,
|
||||||
OpenAITranscriptionModel
|
OpenAITranscriptionModel
|
||||||
} from '@ai-sdk/openai/internal'
|
} from '@ai-sdk/openai/internal'
|
||||||
|
import { OpenAICompatibleChatLanguageModel } from '@ai-sdk/openai-compatible'
|
||||||
import {
|
import {
|
||||||
type EmbeddingModelV2,
|
type EmbeddingModelV2,
|
||||||
type ImageModelV2,
|
type ImageModelV2,
|
||||||
@ -67,6 +67,11 @@ export interface CherryInProviderSettings {
|
|||||||
* Optional static headers applied to every request.
|
* Optional static headers applied to every request.
|
||||||
*/
|
*/
|
||||||
headers?: HeadersInput
|
headers?: HeadersInput
|
||||||
|
/**
|
||||||
|
* Optional endpoint type to distinguish different endpoint behaviors.
|
||||||
|
* "image-generation" is also openai endpoint, but specifically for image generation.
|
||||||
|
*/
|
||||||
|
endpointType?: 'openai' | 'openai-response' | 'anthropic' | 'gemini' | 'image-generation' | 'jina-rerank'
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface CherryInProvider extends ProviderV2 {
|
export interface CherryInProvider extends ProviderV2 {
|
||||||
@ -113,7 +118,7 @@ const createCustomFetch = (originalFetch?: any) => {
|
|||||||
return originalFetch ? originalFetch(url, options) : fetch(url, options)
|
return originalFetch ? originalFetch(url, options) : fetch(url, options)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
class CherryInOpenAIChatLanguageModel extends OpenAIChatLanguageModel {
|
class CherryInOpenAIChatLanguageModel extends OpenAICompatibleChatLanguageModel {
|
||||||
constructor(modelId: string, settings: any) {
|
constructor(modelId: string, settings: any) {
|
||||||
super(modelId, {
|
super(modelId, {
|
||||||
...settings,
|
...settings,
|
||||||
@ -151,7 +156,8 @@ export const createCherryIn = (options: CherryInProviderSettings = {}): CherryIn
|
|||||||
baseURL = DEFAULT_CHERRYIN_BASE_URL,
|
baseURL = DEFAULT_CHERRYIN_BASE_URL,
|
||||||
anthropicBaseURL = DEFAULT_CHERRYIN_ANTHROPIC_BASE_URL,
|
anthropicBaseURL = DEFAULT_CHERRYIN_ANTHROPIC_BASE_URL,
|
||||||
geminiBaseURL = DEFAULT_CHERRYIN_GEMINI_BASE_URL,
|
geminiBaseURL = DEFAULT_CHERRYIN_GEMINI_BASE_URL,
|
||||||
fetch
|
fetch,
|
||||||
|
endpointType
|
||||||
} = options
|
} = options
|
||||||
|
|
||||||
const getJsonHeaders = createJsonHeadersGetter(options)
|
const getJsonHeaders = createJsonHeadersGetter(options)
|
||||||
@ -205,7 +211,7 @@ export const createCherryIn = (options: CherryInProviderSettings = {}): CherryIn
|
|||||||
fetch
|
fetch
|
||||||
})
|
})
|
||||||
|
|
||||||
const createChatModel = (modelId: string, settings: OpenAIProviderSettings = {}) => {
|
const createChatModelByModelId = (modelId: string, settings: OpenAIProviderSettings = {}) => {
|
||||||
if (isAnthropicModel(modelId)) {
|
if (isAnthropicModel(modelId)) {
|
||||||
return createAnthropicModel(modelId)
|
return createAnthropicModel(modelId)
|
||||||
}
|
}
|
||||||
@ -223,6 +229,29 @@ export const createCherryIn = (options: CherryInProviderSettings = {}): CherryIn
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
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 = {}) =>
|
const createCompletionModel = (modelId: string, settings: OpenAIProviderSettings = {}) =>
|
||||||
new OpenAICompletionLanguageModel(modelId, {
|
new OpenAICompletionLanguageModel(modelId, {
|
||||||
provider: `${CHERRYIN_PROVIDER_NAME}.completion`,
|
provider: `${CHERRYIN_PROVIDER_NAME}.completion`,
|
||||||
|
|||||||
@ -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,19 +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.43",
|
"@ai-sdk/anthropic": "^2.0.49",
|
||||||
"@ai-sdk/azure": "^2.0.66",
|
"@ai-sdk/azure": "^2.0.87",
|
||||||
"@ai-sdk/deepseek": "^1.0.27",
|
"@ai-sdk/deepseek": "^1.0.31",
|
||||||
"@ai-sdk/google": "patch:@ai-sdk/google@npm%3A2.0.31#~/.yarn/patches/@ai-sdk-google-npm-2.0.31-b0de047210.patch",
|
"@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": "patch:@ai-sdk/openai@npm%3A2.0.64#~/.yarn/patches/@ai-sdk-openai-npm-2.0.64-48f99f5bf3.patch",
|
|
||||||
"@ai-sdk/openai-compatible": "^1.0.26",
|
|
||||||
"@ai-sdk/provider": "^2.0.0",
|
"@ai-sdk/provider": "^2.0.0",
|
||||||
"@ai-sdk/provider-utils": "^3.0.16",
|
"@ai-sdk/provider-utils": "^3.0.17",
|
||||||
"@ai-sdk/xai": "^2.0.31",
|
"@ai-sdk/xai": "^2.0.36",
|
||||||
"@cherrystudio/ai-sdk-provider": "workspace:*",
|
|
||||||
"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
|
||||||
238
packages/aiCore/src/__tests__/fixtures/mock-responses.ts
Normal file
@ -0,0 +1,238 @@
|
|||||||
|
/**
|
||||||
|
* Mock Responses
|
||||||
|
* Provides realistic mock responses for all provider types
|
||||||
|
*/
|
||||||
|
|
||||||
|
import type { ModelMessage, Tool } from 'ai'
|
||||||
|
import { jsonSchema } from 'ai'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Standard test messages for all scenarios
|
||||||
|
*/
|
||||||
|
export const testMessages: Record<string, ModelMessage[]> = {
|
||||||
|
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' }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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 complete responses for non-streaming scenarios
|
||||||
|
* Note: AI SDK v5 uses inputTokens/outputTokens instead of promptTokens/completionTokens
|
||||||
|
*/
|
||||||
|
export const mockCompleteResponses = {
|
||||||
|
simple: {
|
||||||
|
text: 'This is a simple response.',
|
||||||
|
finishReason: 'stop' as const,
|
||||||
|
usage: {
|
||||||
|
inputTokens: 15,
|
||||||
|
outputTokens: 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: {
|
||||||
|
inputTokens: 25,
|
||||||
|
outputTokens: 12,
|
||||||
|
totalTokens: 37
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
withWarnings: {
|
||||||
|
text: 'Response with warnings.',
|
||||||
|
finishReason: 'stop' as const,
|
||||||
|
usage: {
|
||||||
|
inputTokens: 10,
|
||||||
|
outputTokens: 5,
|
||||||
|
totalTokens: 15
|
||||||
|
},
|
||||||
|
warnings: [
|
||||||
|
{
|
||||||
|
type: 'unsupported-setting' as const,
|
||||||
|
setting: 'temperature',
|
||||||
|
details: '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: []
|
||||||
|
}
|
||||||
|
}
|
||||||
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'
|
||||||
35
packages/aiCore/src/__tests__/mocks/ai-sdk-provider.ts
Normal file
@ -0,0 +1,35 @@
|
|||||||
|
/**
|
||||||
|
* Mock for @cherrystudio/ai-sdk-provider
|
||||||
|
* This mock is used in tests to avoid importing the actual package
|
||||||
|
*/
|
||||||
|
|
||||||
|
export type CherryInProviderSettings = {
|
||||||
|
apiKey?: string
|
||||||
|
baseURL?: string
|
||||||
|
}
|
||||||
|
|
||||||
|
// oxlint-disable-next-line no-unused-vars
|
||||||
|
export const createCherryIn = (_options?: CherryInProviderSettings) => ({
|
||||||
|
// oxlint-disable-next-line no-unused-vars
|
||||||
|
languageModel: (_modelId: string) => ({
|
||||||
|
specificationVersion: 'v1',
|
||||||
|
provider: 'cherryin',
|
||||||
|
modelId: 'mock-model',
|
||||||
|
doGenerate: async () => ({ text: 'mock response' }),
|
||||||
|
doStream: async () => ({ stream: (async function* () {})() })
|
||||||
|
}),
|
||||||
|
// oxlint-disable-next-line no-unused-vars
|
||||||
|
chat: (_modelId: string) => ({
|
||||||
|
specificationVersion: 'v1',
|
||||||
|
provider: 'cherryin-chat',
|
||||||
|
modelId: 'mock-model',
|
||||||
|
doGenerate: async () => ({ text: 'mock response' }),
|
||||||
|
doStream: async () => ({ stream: (async function* () {})() })
|
||||||
|
}),
|
||||||
|
// oxlint-disable-next-line no-unused-vars
|
||||||
|
textEmbeddingModel: (_modelId: string) => ({
|
||||||
|
specificationVersion: 'v1',
|
||||||
|
provider: 'cherryin',
|
||||||
|
modelId: 'mock-embedding-model'
|
||||||
|
})
|
||||||
|
})
|
||||||
9
packages/aiCore/src/__tests__/setup.ts
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
/**
|
||||||
|
* Vitest Setup File
|
||||||
|
* Global test configuration and mocks for @cherrystudio/ai-core package
|
||||||
|
*/
|
||||||
|
|
||||||
|
// Mock Vite SSR helper to avoid Node environment errors
|
||||||
|
;(globalThis as any).__vite_ssr_exportName__ = (_name: string, value: any) => value
|
||||||
|
|
||||||
|
// Note: @cherrystudio/ai-sdk-provider is mocked via alias in vitest.config.ts
|
||||||
109
packages/aiCore/src/core/options/__tests__/factory.test.ts
Normal file
@ -0,0 +1,109 @@
|
|||||||
|
import { describe, expect, it } from 'vitest'
|
||||||
|
|
||||||
|
import { createOpenAIOptions, createOpenRouterOptions, mergeProviderOptions } from '../factory'
|
||||||
|
|
||||||
|
describe('mergeProviderOptions', () => {
|
||||||
|
it('deep merges provider options for the same provider', () => {
|
||||||
|
const reasoningOptions = createOpenRouterOptions({
|
||||||
|
reasoning: {
|
||||||
|
enabled: true,
|
||||||
|
effort: 'medium'
|
||||||
|
}
|
||||||
|
})
|
||||||
|
const webSearchOptions = createOpenRouterOptions({
|
||||||
|
plugins: [{ id: 'web', max_results: 5 }]
|
||||||
|
})
|
||||||
|
|
||||||
|
const merged = mergeProviderOptions(reasoningOptions, webSearchOptions)
|
||||||
|
|
||||||
|
expect(merged.openrouter).toEqual({
|
||||||
|
reasoning: {
|
||||||
|
enabled: true,
|
||||||
|
effort: 'medium'
|
||||||
|
},
|
||||||
|
plugins: [{ id: 'web', max_results: 5 }]
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('preserves options from other providers while merging', () => {
|
||||||
|
const openRouter = createOpenRouterOptions({
|
||||||
|
reasoning: { enabled: true }
|
||||||
|
})
|
||||||
|
const openAI = createOpenAIOptions({
|
||||||
|
reasoningEffort: 'low'
|
||||||
|
})
|
||||||
|
const merged = mergeProviderOptions(openRouter, openAI)
|
||||||
|
|
||||||
|
expect(merged.openrouter).toEqual({ reasoning: { enabled: true } })
|
||||||
|
expect(merged.openai).toEqual({ reasoningEffort: 'low' })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('overwrites primitive values with later values', () => {
|
||||||
|
const first = createOpenAIOptions({
|
||||||
|
reasoningEffort: 'low',
|
||||||
|
user: 'user-123'
|
||||||
|
})
|
||||||
|
const second = createOpenAIOptions({
|
||||||
|
reasoningEffort: 'high',
|
||||||
|
maxToolCalls: 5
|
||||||
|
})
|
||||||
|
|
||||||
|
const merged = mergeProviderOptions(first, second)
|
||||||
|
|
||||||
|
expect(merged.openai).toEqual({
|
||||||
|
reasoningEffort: 'high', // overwritten by second
|
||||||
|
user: 'user-123', // preserved from first
|
||||||
|
maxToolCalls: 5 // added from second
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('overwrites arrays with later values instead of merging', () => {
|
||||||
|
const first = createOpenRouterOptions({
|
||||||
|
models: ['gpt-4', 'gpt-3.5-turbo']
|
||||||
|
})
|
||||||
|
const second = createOpenRouterOptions({
|
||||||
|
models: ['claude-3-opus', 'claude-3-sonnet']
|
||||||
|
})
|
||||||
|
|
||||||
|
const merged = mergeProviderOptions(first, second)
|
||||||
|
|
||||||
|
// Array is completely replaced, not merged
|
||||||
|
expect(merged.openrouter?.models).toEqual(['claude-3-opus', 'claude-3-sonnet'])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('deeply merges nested objects while overwriting primitives', () => {
|
||||||
|
const first = createOpenRouterOptions({
|
||||||
|
reasoning: {
|
||||||
|
enabled: true,
|
||||||
|
effort: 'low'
|
||||||
|
},
|
||||||
|
user: 'user-123'
|
||||||
|
})
|
||||||
|
const second = createOpenRouterOptions({
|
||||||
|
reasoning: {
|
||||||
|
effort: 'high',
|
||||||
|
max_tokens: 500
|
||||||
|
},
|
||||||
|
user: 'user-456'
|
||||||
|
})
|
||||||
|
|
||||||
|
const merged = mergeProviderOptions(first, second)
|
||||||
|
|
||||||
|
expect(merged.openrouter).toEqual({
|
||||||
|
reasoning: {
|
||||||
|
enabled: true, // preserved from first
|
||||||
|
effort: 'high', // overwritten by second
|
||||||
|
max_tokens: 500 // added from second
|
||||||
|
},
|
||||||
|
user: 'user-456' // overwritten by second
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('replaces arrays instead of merging them', () => {
|
||||||
|
const first = createOpenRouterOptions({ plugins: [{ id: 'old' }] })
|
||||||
|
const second = createOpenRouterOptions({ plugins: [{ id: 'new' }] })
|
||||||
|
const merged = mergeProviderOptions(first, second)
|
||||||
|
// @ts-expect-error type-check for openrouter options is skipped. see function signature of createOpenRouterOptions
|
||||||
|
expect(merged.openrouter?.plugins).toEqual([{ id: 'new' }])
|
||||||
|
})
|
||||||
|
})
|
||||||
@ -26,13 +26,65 @@ export function createGenericProviderOptions<T extends string>(
|
|||||||
return { [provider]: options } as Record<T, Record<string, any>>
|
return { [provider]: options } as Record<T, Record<string, any>>
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type PlainObject = Record<string, any>
|
||||||
|
|
||||||
|
const isPlainObject = (value: unknown): value is PlainObject => {
|
||||||
|
return typeof value === 'object' && value !== null && !Array.isArray(value)
|
||||||
|
}
|
||||||
|
|
||||||
|
function deepMergeObjects<T extends PlainObject>(target: T, source: PlainObject): T {
|
||||||
|
const result: PlainObject = { ...target }
|
||||||
|
Object.entries(source).forEach(([key, value]) => {
|
||||||
|
if (isPlainObject(value) && isPlainObject(result[key])) {
|
||||||
|
result[key] = deepMergeObjects(result[key], value)
|
||||||
|
} else {
|
||||||
|
result[key] = value
|
||||||
|
}
|
||||||
|
})
|
||||||
|
return result as T
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 合并多个供应商的options
|
* Deep-merge multiple provider-specific options.
|
||||||
* @param optionsMap 包含多个供应商选项的对象
|
* Nested objects are recursively merged; primitive values are overwritten.
|
||||||
* @returns 合并后的TypedProviderOptions
|
*
|
||||||
|
* When the same key appears in multiple options:
|
||||||
|
* - If both values are plain objects: they are deeply merged (recursive merge)
|
||||||
|
* - If values are primitives/arrays: the later value overwrites the earlier one
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* mergeProviderOptions(
|
||||||
|
* { openrouter: { reasoning: { enabled: true, effort: 'low' }, user: 'user-123' } },
|
||||||
|
* { openrouter: { reasoning: { effort: 'high', max_tokens: 500 }, models: ['gpt-4'] } }
|
||||||
|
* )
|
||||||
|
* // Result: {
|
||||||
|
* // openrouter: {
|
||||||
|
* // reasoning: { enabled: true, effort: 'high', max_tokens: 500 },
|
||||||
|
* // user: 'user-123',
|
||||||
|
* // models: ['gpt-4']
|
||||||
|
* // }
|
||||||
|
* // }
|
||||||
|
*
|
||||||
|
* @param optionsMap Objects containing options for multiple providers
|
||||||
|
* @returns Fully merged TypedProviderOptions
|
||||||
*/
|
*/
|
||||||
export function mergeProviderOptions(...optionsMap: Partial<TypedProviderOptions>[]): TypedProviderOptions {
|
export function mergeProviderOptions(...optionsMap: Partial<TypedProviderOptions>[]): TypedProviderOptions {
|
||||||
return Object.assign({}, ...optionsMap)
|
return optionsMap.reduce<TypedProviderOptions>((acc, options) => {
|
||||||
|
if (!options) {
|
||||||
|
return acc
|
||||||
|
}
|
||||||
|
Object.entries(options).forEach(([providerId, providerOptions]) => {
|
||||||
|
if (!providerOptions) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if (acc[providerId]) {
|
||||||
|
acc[providerId] = deepMergeObjects(acc[providerId] as PlainObject, providerOptions as PlainObject)
|
||||||
|
} else {
|
||||||
|
acc[providerId] = providerOptions as any
|
||||||
|
}
|
||||||
|
})
|
||||||
|
return acc
|
||||||
|
}, {} as TypedProviderOptions)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@ -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'
|
|
||||||
|
|||||||
@ -62,7 +62,7 @@ export class StreamEventManager {
|
|||||||
const recursiveResult = await context.recursiveCall(recursiveParams)
|
const recursiveResult = await context.recursiveCall(recursiveParams)
|
||||||
|
|
||||||
if (recursiveResult && recursiveResult.fullStream) {
|
if (recursiveResult && recursiveResult.fullStream) {
|
||||||
await this.pipeRecursiveStream(controller, recursiveResult.fullStream, context)
|
await this.pipeRecursiveStream(controller, recursiveResult.fullStream)
|
||||||
} else {
|
} else {
|
||||||
console.warn('[MCP Prompt] No fullstream found in recursive result:', recursiveResult)
|
console.warn('[MCP Prompt] No fullstream found in recursive result:', recursiveResult)
|
||||||
}
|
}
|
||||||
@ -74,11 +74,7 @@ export class StreamEventManager {
|
|||||||
/**
|
/**
|
||||||
* 将递归流的数据传递到当前流
|
* 将递归流的数据传递到当前流
|
||||||
*/
|
*/
|
||||||
private async pipeRecursiveStream(
|
private async pipeRecursiveStream(controller: StreamController, recursiveStream: ReadableStream): Promise<void> {
|
||||||
controller: StreamController,
|
|
||||||
recursiveStream: ReadableStream,
|
|
||||||
context?: AiRequestContext
|
|
||||||
): Promise<void> {
|
|
||||||
const reader = recursiveStream.getReader()
|
const reader = recursiveStream.getReader()
|
||||||
try {
|
try {
|
||||||
while (true) {
|
while (true) {
|
||||||
@ -86,18 +82,14 @@ export class StreamEventManager {
|
|||||||
if (done) {
|
if (done) {
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
|
if (value.type === 'start') {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
if (value.type === 'finish') {
|
if (value.type === 'finish') {
|
||||||
// 迭代的流不发finish,但需要累加其 usage
|
|
||||||
if (value.usage && context?.accumulatedUsage) {
|
|
||||||
this.accumulateUsage(context.accumulatedUsage, value.usage)
|
|
||||||
}
|
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
// 对于 finish-step 类型,累加其 usage
|
|
||||||
if (value.type === 'finish-step' && value.usage && context?.accumulatedUsage) {
|
|
||||||
this.accumulateUsage(context.accumulatedUsage, value.usage)
|
|
||||||
}
|
|
||||||
// 将递归流的数据传递到当前流
|
|
||||||
controller.enqueue(value)
|
controller.enqueue(value)
|
||||||
}
|
}
|
||||||
} finally {
|
} finally {
|
||||||
@ -135,10 +127,8 @@ export class StreamEventManager {
|
|||||||
// 构建新的对话消息
|
// 构建新的对话消息
|
||||||
const newMessages: ModelMessage[] = [
|
const newMessages: ModelMessage[] = [
|
||||||
...(context.originalParams.messages || []),
|
...(context.originalParams.messages || []),
|
||||||
{
|
// 只有当 textBuffer 有内容时才添加 assistant 消息,避免空消息导致 API 错误
|
||||||
role: 'assistant',
|
...(textBuffer ? [{ role: 'assistant' as const, content: textBuffer }] : []),
|
||||||
content: textBuffer
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
role: 'user',
|
role: 'user',
|
||||||
content: toolResultsText
|
content: toolResultsText
|
||||||
@ -161,7 +151,7 @@ export class StreamEventManager {
|
|||||||
/**
|
/**
|
||||||
* 累加 usage 数据
|
* 累加 usage 数据
|
||||||
*/
|
*/
|
||||||
private accumulateUsage(target: any, source: any): void {
|
accumulateUsage(target: any, source: any): void {
|
||||||
if (!target || !source) return
|
if (!target || !source) return
|
||||||
|
|
||||||
// 累加各种 token 类型
|
// 累加各种 token 类型
|
||||||
|
|||||||
@ -411,7 +411,10 @@ export const createPromptToolUsePlugin = (config: PromptToolUseConfig = {}) => {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// 如果没有执行工具调用,直接传递原始finish-step事件
|
// 如果没有执行工具调用,累加 usage 后透传 finish-step 事件
|
||||||
|
if (chunk.usage && context.accumulatedUsage) {
|
||||||
|
streamEventManager.accumulateUsage(context.accumulatedUsage, chunk.usage)
|
||||||
|
}
|
||||||
controller.enqueue(chunk)
|
controller.enqueue(chunk)
|
||||||
|
|
||||||
// 清理状态
|
// 清理状态
|
||||||
|
|||||||
@ -6,6 +6,7 @@ import { type Tool } from 'ai'
|
|||||||
|
|
||||||
import { createOpenRouterOptions, createXaiOptions, mergeProviderOptions } from '../../../options'
|
import { createOpenRouterOptions, createXaiOptions, mergeProviderOptions } from '../../../options'
|
||||||
import type { ProviderOptionsMap } from '../../../options/types'
|
import type { ProviderOptionsMap } from '../../../options/types'
|
||||||
|
import type { AiRequestContext } from '../../'
|
||||||
import type { OpenRouterSearchConfig } from './openrouter'
|
import type { OpenRouterSearchConfig } from './openrouter'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -35,7 +36,6 @@ export interface WebSearchPluginConfig {
|
|||||||
anthropic?: AnthropicSearchConfig
|
anthropic?: AnthropicSearchConfig
|
||||||
xai?: ProviderOptionsMap['xai']['searchParameters']
|
xai?: ProviderOptionsMap['xai']['searchParameters']
|
||||||
google?: GoogleSearchConfig
|
google?: GoogleSearchConfig
|
||||||
'google-vertex'?: GoogleSearchConfig
|
|
||||||
openrouter?: OpenRouterSearchConfig
|
openrouter?: OpenRouterSearchConfig
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -44,7 +44,6 @@ export interface WebSearchPluginConfig {
|
|||||||
*/
|
*/
|
||||||
export const DEFAULT_WEB_SEARCH_CONFIG: WebSearchPluginConfig = {
|
export const DEFAULT_WEB_SEARCH_CONFIG: WebSearchPluginConfig = {
|
||||||
google: {},
|
google: {},
|
||||||
'google-vertex': {},
|
|
||||||
openai: {},
|
openai: {},
|
||||||
'openai-chat': {},
|
'openai-chat': {},
|
||||||
xai: {
|
xai: {
|
||||||
@ -97,55 +96,84 @@ export type WebSearchToolInputSchema = {
|
|||||||
'openai-chat': InferToolInput<OpenAIChatWebSearchTool>
|
'openai-chat': InferToolInput<OpenAIChatWebSearchTool>
|
||||||
}
|
}
|
||||||
|
|
||||||
export const switchWebSearchTool = (providerId: string, config: WebSearchPluginConfig, params: any) => {
|
/**
|
||||||
switch (providerId) {
|
* Helper function to ensure params.tools object exists
|
||||||
case 'openai': {
|
*/
|
||||||
if (config.openai) {
|
const ensureToolsObject = (params: any) => {
|
||||||
if (!params.tools) params.tools = {}
|
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) {
|
* Helper function to apply tool-based web search configuration
|
||||||
if (!params.tools) params.tools = {}
|
*/
|
||||||
params.tools.web_search = anthropic.tools.webSearch_20250305(config.anthropic)
|
const applyToolBasedSearch = (params: any, toolName: string, toolInstance: any) => {
|
||||||
}
|
ensureToolsObject(params)
|
||||||
break
|
params.tools[toolName] = toolInstance
|
||||||
}
|
}
|
||||||
|
|
||||||
case 'google': {
|
/**
|
||||||
// case 'google-vertex':
|
* Helper function to apply provider options-based web search configuration
|
||||||
if (!params.tools) params.tools = {}
|
*/
|
||||||
params.tools.web_search = google.tools.googleSearch(config.google || {})
|
const applyProviderOptionsSearch = (params: any, searchOptions: any) => {
|
||||||
break
|
params.providerOptions = mergeProviderOptions(params.providerOptions, searchOptions)
|
||||||
}
|
}
|
||||||
|
|
||||||
case 'xai': {
|
export const switchWebSearchTool = (config: WebSearchPluginConfig, params: any, context?: AiRequestContext) => {
|
||||||
if (config.xai) {
|
const providerId = context?.providerId
|
||||||
const searchOptions = createXaiOptions({
|
|
||||||
searchParameters: { ...config.xai, mode: 'on' }
|
|
||||||
})
|
|
||||||
params.providerOptions = mergeProviderOptions(params.providerOptions, searchOptions)
|
|
||||||
}
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
case 'openrouter': {
|
// Provider-specific configuration map
|
||||||
if (config.openrouter) {
|
const providerHandlers: Record<string, () => void> = {
|
||||||
const searchOptions = createOpenRouterOptions(config.openrouter)
|
openai: () => {
|
||||||
params.providerOptions = mergeProviderOptions(params.providerOptions, searchOptions)
|
const cfg = config.openai ?? DEFAULT_WEB_SEARCH_CONFIG.openai
|
||||||
}
|
applyToolBasedSearch(params, 'web_search', openai.tools.webSearch(cfg))
|
||||||
|
},
|
||||||
|
'openai-chat': () => {
|
||||||
|
const cfg = (config['openai-chat'] ?? DEFAULT_WEB_SEARCH_CONFIG['openai-chat']) as OpenAISearchPreviewConfig
|
||||||
|
applyToolBasedSearch(params, 'web_search_preview', openai.tools.webSearchPreview(cfg))
|
||||||
|
},
|
||||||
|
anthropic: () => {
|
||||||
|
const cfg = config.anthropic ?? DEFAULT_WEB_SEARCH_CONFIG.anthropic
|
||||||
|
applyToolBasedSearch(params, 'web_search', anthropic.tools.webSearch_20250305(cfg))
|
||||||
|
},
|
||||||
|
google: () => {
|
||||||
|
const cfg = (config.google ?? DEFAULT_WEB_SEARCH_CONFIG.google) as GoogleSearchConfig
|
||||||
|
applyToolBasedSearch(params, 'web_search', google.tools.googleSearch(cfg))
|
||||||
|
},
|
||||||
|
xai: () => {
|
||||||
|
const cfg = config.xai ?? DEFAULT_WEB_SEARCH_CONFIG.xai
|
||||||
|
const searchOptions = createXaiOptions({ searchParameters: { ...cfg, mode: 'on' } })
|
||||||
|
applyProviderOptionsSearch(params, searchOptions)
|
||||||
|
},
|
||||||
|
openrouter: () => {
|
||||||
|
const cfg = (config.openrouter ?? DEFAULT_WEB_SEARCH_CONFIG.openrouter) as OpenRouterSearchConfig
|
||||||
|
const searchOptions = createOpenRouterOptions(cfg)
|
||||||
|
applyProviderOptionsSearch(params, searchOptions)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Try provider-specific handler first
|
||||||
|
const handler = providerId && providerHandlers[providerId]
|
||||||
|
if (handler) {
|
||||||
|
handler()
|
||||||
|
return params
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fallback: apply based on available config keys (prioritized order)
|
||||||
|
const fallbackOrder: Array<keyof WebSearchPluginConfig> = [
|
||||||
|
'openai',
|
||||||
|
'openai-chat',
|
||||||
|
'anthropic',
|
||||||
|
'google',
|
||||||
|
'xai',
|
||||||
|
'openrouter'
|
||||||
|
]
|
||||||
|
|
||||||
|
for (const key of fallbackOrder) {
|
||||||
|
if (config[key]) {
|
||||||
|
providerHandlers[key]()
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return params
|
return params
|
||||||
}
|
}
|
||||||
|
|||||||
@ -4,7 +4,6 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
import { definePlugin } from '../../'
|
import { definePlugin } from '../../'
|
||||||
import type { AiRequestContext } from '../../types'
|
|
||||||
import type { WebSearchPluginConfig } from './helper'
|
import type { WebSearchPluginConfig } from './helper'
|
||||||
import { DEFAULT_WEB_SEARCH_CONFIG, switchWebSearchTool } from './helper'
|
import { DEFAULT_WEB_SEARCH_CONFIG, switchWebSearchTool } from './helper'
|
||||||
|
|
||||||
@ -18,21 +17,28 @@ export const webSearchPlugin = (config: WebSearchPluginConfig = DEFAULT_WEB_SEAR
|
|||||||
name: 'webSearch',
|
name: 'webSearch',
|
||||||
enforce: 'pre',
|
enforce: 'pre',
|
||||||
|
|
||||||
transformParams: async (params: any, context: AiRequestContext) => {
|
transformParams: async (params: any, context) => {
|
||||||
const { providerId } = context
|
let { providerId } = context
|
||||||
switchWebSearchTool(providerId, config, params)
|
|
||||||
|
|
||||||
|
// For cherryin providers, extract the actual provider from the model's provider string
|
||||||
|
// Expected format: "cherryin.{actualProvider}" (e.g., "cherryin.gemini")
|
||||||
if (providerId === 'cherryin' || providerId === 'cherryin-chat') {
|
if (providerId === 'cherryin' || providerId === 'cherryin-chat') {
|
||||||
// cherryin.gemini
|
const provider = params.model?.provider
|
||||||
const _providerId = params.model.provider.split('.')[1]
|
if (provider && typeof provider === 'string' && provider.includes('.')) {
|
||||||
switchWebSearchTool(_providerId, config, params)
|
const extractedProviderId = provider.split('.')[1]
|
||||||
|
if (extractedProviderId) {
|
||||||
|
providerId = extractedProviderId
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
switchWebSearchTool(config, params, { ...context, providerId })
|
||||||
return params
|
return params
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
// 导出类型定义供开发者使用
|
// 导出类型定义供开发者使用
|
||||||
export type { WebSearchPluginConfig, WebSearchToolOutputSchema } from './helper'
|
export * from './helper'
|
||||||
|
|
||||||
// 默认导出
|
// 默认导出
|
||||||
export default webSearchPlugin
|
export default webSearchPlugin
|
||||||
|
|||||||
@ -19,15 +19,20 @@ describe('Provider Schemas', () => {
|
|||||||
expect(Array.isArray(baseProviders)).toBe(true)
|
expect(Array.isArray(baseProviders)).toBe(true)
|
||||||
expect(baseProviders.length).toBeGreaterThan(0)
|
expect(baseProviders.length).toBeGreaterThan(0)
|
||||||
|
|
||||||
|
// These are the actual base providers defined in schemas.ts
|
||||||
const expectedIds = [
|
const expectedIds = [
|
||||||
'openai',
|
'openai',
|
||||||
'openai-responses',
|
'openai-chat',
|
||||||
'openai-compatible',
|
'openai-compatible',
|
||||||
'anthropic',
|
'anthropic',
|
||||||
'google',
|
'google',
|
||||||
'xai',
|
'xai',
|
||||||
'azure',
|
'azure',
|
||||||
'deepseek'
|
'azure-responses',
|
||||||
|
'deepseek',
|
||||||
|
'openrouter',
|
||||||
|
'cherryin',
|
||||||
|
'cherryin-chat'
|
||||||
]
|
]
|
||||||
const actualIds = baseProviders.map((p) => p.id)
|
const actualIds = baseProviders.map((p) => p.id)
|
||||||
expectedIds.forEach((id) => {
|
expectedIds.forEach((id) => {
|
||||||
|
|||||||
@ -44,7 +44,7 @@ export {
|
|||||||
// ==================== 基础数据和类型 ====================
|
// ==================== 基础数据和类型 ====================
|
||||||
|
|
||||||
// 基础Provider数据源
|
// 基础Provider数据源
|
||||||
export { baseProviderIds, baseProviders } from './schemas'
|
export { baseProviderIds, baseProviders, isBaseProvider } from './schemas'
|
||||||
|
|
||||||
// 类型定义和Schema
|
// 类型定义和Schema
|
||||||
export type {
|
export type {
|
||||||
|
|||||||
@ -7,7 +7,6 @@ import { createAzure } from '@ai-sdk/azure'
|
|||||||
import { type AzureOpenAIProviderSettings } from '@ai-sdk/azure'
|
import { type AzureOpenAIProviderSettings } from '@ai-sdk/azure'
|
||||||
import { createDeepSeek } from '@ai-sdk/deepseek'
|
import { createDeepSeek } from '@ai-sdk/deepseek'
|
||||||
import { createGoogleGenerativeAI } from '@ai-sdk/google'
|
import { createGoogleGenerativeAI } from '@ai-sdk/google'
|
||||||
import { createHuggingFace } from '@ai-sdk/huggingface'
|
|
||||||
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 type { LanguageModelV2 } from '@ai-sdk/provider'
|
import type { LanguageModelV2 } from '@ai-sdk/provider'
|
||||||
@ -33,8 +32,7 @@ export const baseProviderIds = [
|
|||||||
'deepseek',
|
'deepseek',
|
||||||
'openrouter',
|
'openrouter',
|
||||||
'cherryin',
|
'cherryin',
|
||||||
'cherryin-chat',
|
'cherryin-chat'
|
||||||
'huggingface'
|
|
||||||
] as const
|
] as const
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -158,12 +156,6 @@ export const baseProviders = [
|
|||||||
})
|
})
|
||||||
},
|
},
|
||||||
supportsImageGeneration: true
|
supportsImageGeneration: true
|
||||||
},
|
|
||||||
{
|
|
||||||
id: 'huggingface',
|
|
||||||
name: 'HuggingFace',
|
|
||||||
creator: createHuggingFace,
|
|
||||||
supportsImageGeneration: true
|
|
||||||
}
|
}
|
||||||
] as const satisfies BaseProvider[]
|
] as const satisfies BaseProvider[]
|
||||||
|
|
||||||
|
|||||||
@ -232,11 +232,13 @@ describe('RuntimeExecutor.generateImage', () => {
|
|||||||
|
|
||||||
expect(pluginCallOrder).toEqual(['onRequestStart', 'transformParams', 'transformResult', 'onRequestEnd'])
|
expect(pluginCallOrder).toEqual(['onRequestStart', 'transformParams', 'transformResult', 'onRequestEnd'])
|
||||||
|
|
||||||
|
// transformParams receives params without model (model is handled separately)
|
||||||
|
// and context with core fields + dynamic fields (requestId, startTime, etc.)
|
||||||
expect(testPlugin.transformParams).toHaveBeenCalledWith(
|
expect(testPlugin.transformParams).toHaveBeenCalledWith(
|
||||||
{ prompt: 'A test image' },
|
expect.objectContaining({ prompt: 'A test image' }),
|
||||||
expect.objectContaining({
|
expect.objectContaining({
|
||||||
providerId: 'openai',
|
providerId: 'openai',
|
||||||
modelId: 'dall-e-3'
|
model: 'dall-e-3'
|
||||||
})
|
})
|
||||||
)
|
)
|
||||||
|
|
||||||
@ -273,11 +275,12 @@ describe('RuntimeExecutor.generateImage', () => {
|
|||||||
|
|
||||||
await executorWithPlugin.generateImage({ model: 'dall-e-3', prompt: 'A test image' })
|
await executorWithPlugin.generateImage({ model: 'dall-e-3', prompt: 'A test image' })
|
||||||
|
|
||||||
|
// resolveModel receives model id and context with core fields
|
||||||
expect(modelResolutionPlugin.resolveModel).toHaveBeenCalledWith(
|
expect(modelResolutionPlugin.resolveModel).toHaveBeenCalledWith(
|
||||||
'dall-e-3',
|
'dall-e-3',
|
||||||
expect.objectContaining({
|
expect.objectContaining({
|
||||||
providerId: 'openai',
|
providerId: 'openai',
|
||||||
modelId: 'dall-e-3'
|
model: 'dall-e-3'
|
||||||
})
|
})
|
||||||
)
|
)
|
||||||
|
|
||||||
@ -339,12 +342,11 @@ describe('RuntimeExecutor.generateImage', () => {
|
|||||||
.generateImage({ model: 'invalid-model', prompt: 'A test image' })
|
.generateImage({ model: 'invalid-model', prompt: 'A test image' })
|
||||||
.catch((error) => error)
|
.catch((error) => error)
|
||||||
|
|
||||||
expect(thrownError).toBeInstanceOf(ImageGenerationError)
|
// Error is thrown from pluginEngine directly as ImageModelResolutionError
|
||||||
expect(thrownError.message).toContain('Failed to generate image:')
|
expect(thrownError).toBeInstanceOf(ImageModelResolutionError)
|
||||||
|
expect(thrownError.message).toContain('Failed to resolve image model: invalid-model')
|
||||||
expect(thrownError.providerId).toBe('openai')
|
expect(thrownError.providerId).toBe('openai')
|
||||||
expect(thrownError.modelId).toBe('invalid-model')
|
expect(thrownError.modelId).toBe('invalid-model')
|
||||||
expect(thrownError.cause).toBeInstanceOf(ImageModelResolutionError)
|
|
||||||
expect(thrownError.cause.message).toContain('Failed to resolve image model: invalid-model')
|
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should handle ImageModelResolutionError without provider', async () => {
|
it('should handle ImageModelResolutionError without provider', async () => {
|
||||||
@ -362,8 +364,9 @@ describe('RuntimeExecutor.generateImage', () => {
|
|||||||
const apiError = new Error('API request failed')
|
const apiError = new Error('API request failed')
|
||||||
vi.mocked(aiGenerateImage).mockRejectedValue(apiError)
|
vi.mocked(aiGenerateImage).mockRejectedValue(apiError)
|
||||||
|
|
||||||
|
// Error propagates directly from pluginEngine without wrapping
|
||||||
await expect(executor.generateImage({ model: 'dall-e-3', prompt: 'A test image' })).rejects.toThrow(
|
await expect(executor.generateImage({ model: 'dall-e-3', prompt: 'A test image' })).rejects.toThrow(
|
||||||
'Failed to generate image:'
|
'API request failed'
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
@ -376,8 +379,9 @@ describe('RuntimeExecutor.generateImage', () => {
|
|||||||
vi.mocked(aiGenerateImage).mockRejectedValue(noImageError)
|
vi.mocked(aiGenerateImage).mockRejectedValue(noImageError)
|
||||||
vi.mocked(NoImageGeneratedError.isInstance).mockReturnValue(true)
|
vi.mocked(NoImageGeneratedError.isInstance).mockReturnValue(true)
|
||||||
|
|
||||||
|
// Error propagates directly from pluginEngine
|
||||||
await expect(executor.generateImage({ model: 'dall-e-3', prompt: 'A test image' })).rejects.toThrow(
|
await expect(executor.generateImage({ model: 'dall-e-3', prompt: 'A test image' })).rejects.toThrow(
|
||||||
'Failed to generate image:'
|
'No image generated'
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
@ -398,15 +402,17 @@ describe('RuntimeExecutor.generateImage', () => {
|
|||||||
[errorPlugin]
|
[errorPlugin]
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// Error propagates directly from pluginEngine
|
||||||
await expect(executorWithPlugin.generateImage({ model: 'dall-e-3', prompt: 'A test image' })).rejects.toThrow(
|
await expect(executorWithPlugin.generateImage({ model: 'dall-e-3', prompt: 'A test image' })).rejects.toThrow(
|
||||||
'Failed to generate image:'
|
'Generation failed'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// onError receives the original error and context with core fields
|
||||||
expect(errorPlugin.onError).toHaveBeenCalledWith(
|
expect(errorPlugin.onError).toHaveBeenCalledWith(
|
||||||
error,
|
error,
|
||||||
expect.objectContaining({
|
expect.objectContaining({
|
||||||
providerId: 'openai',
|
providerId: 'openai',
|
||||||
modelId: 'dall-e-3'
|
model: 'dall-e-3'
|
||||||
})
|
})
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
@ -419,9 +425,10 @@ describe('RuntimeExecutor.generateImage', () => {
|
|||||||
const abortController = new AbortController()
|
const abortController = new AbortController()
|
||||||
setTimeout(() => abortController.abort(), 10)
|
setTimeout(() => abortController.abort(), 10)
|
||||||
|
|
||||||
|
// Error propagates directly from pluginEngine
|
||||||
await expect(
|
await expect(
|
||||||
executor.generateImage({ model: 'dall-e-3', prompt: 'A test image', abortSignal: abortController.signal })
|
executor.generateImage({ model: 'dall-e-3', prompt: 'A test image', abortSignal: abortController.signal })
|
||||||
).rejects.toThrow('Failed to generate image:')
|
).rejects.toThrow('Operation was aborted')
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|||||||
504
packages/aiCore/src/core/runtime/__tests__/generateText.test.ts
Normal file
@ -0,0 +1,504 @@
|
|||||||
|
/**
|
||||||
|
* RuntimeExecutor.generateText Comprehensive Tests
|
||||||
|
* Tests non-streaming text generation across all providers with various parameters
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { generateText } from 'ai'
|
||||||
|
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
||||||
|
|
||||||
|
import {
|
||||||
|
createMockLanguageModel,
|
||||||
|
mockCompleteResponses,
|
||||||
|
mockProviderConfigs,
|
||||||
|
testMessages,
|
||||||
|
testTools
|
||||||
|
} from '../../../__tests__'
|
||||||
|
import type { AiPlugin } from '../../plugins'
|
||||||
|
import { globalRegistryManagement } from '../../providers/RegistryManagement'
|
||||||
|
import { RuntimeExecutor } from '../executor'
|
||||||
|
|
||||||
|
// Mock AI SDK - use importOriginal to keep jsonSchema and other non-mocked exports
|
||||||
|
vi.mock('ai', async (importOriginal) => {
|
||||||
|
const actual = (await importOriginal()) as Record<string, unknown>
|
||||||
|
return {
|
||||||
|
...actual,
|
||||||
|
generateText: vi.fn()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
vi.mock('../../providers/RegistryManagement', () => ({
|
||||||
|
globalRegistryManagement: {
|
||||||
|
languageModel: vi.fn()
|
||||||
|
},
|
||||||
|
DEFAULT_SEPARATOR: '|'
|
||||||
|
}))
|
||||||
|
|
||||||
|
describe('RuntimeExecutor.generateText', () => {
|
||||||
|
let executor: RuntimeExecutor<'openai'>
|
||||||
|
let mockLanguageModel: any
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
vi.clearAllMocks()
|
||||||
|
|
||||||
|
executor = RuntimeExecutor.create('openai', mockProviderConfigs.openai)
|
||||||
|
|
||||||
|
mockLanguageModel = createMockLanguageModel({
|
||||||
|
provider: 'openai',
|
||||||
|
modelId: 'gpt-4'
|
||||||
|
})
|
||||||
|
|
||||||
|
vi.mocked(globalRegistryManagement.languageModel).mockReturnValue(mockLanguageModel)
|
||||||
|
vi.mocked(generateText).mockResolvedValue(mockCompleteResponses.simple as any)
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('Basic Functionality', () => {
|
||||||
|
it('should generate text with minimal parameters', async () => {
|
||||||
|
const result = await executor.generateText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(generateText).toHaveBeenCalledWith({
|
||||||
|
model: mockLanguageModel,
|
||||||
|
messages: testMessages.simple
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(result.text).toBe('This is a simple response.')
|
||||||
|
expect(result.finishReason).toBe('stop')
|
||||||
|
expect(result.usage).toBeDefined()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should generate with system messages', async () => {
|
||||||
|
await executor.generateText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.withSystem
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(generateText).toHaveBeenCalledWith({
|
||||||
|
model: mockLanguageModel,
|
||||||
|
messages: testMessages.withSystem
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should generate with conversation history', async () => {
|
||||||
|
await executor.generateText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.conversation
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(generateText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
messages: testMessages.conversation
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('All Parameter Combinations', () => {
|
||||||
|
it('should support all parameters together', async () => {
|
||||||
|
await executor.generateText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple,
|
||||||
|
temperature: 0.7,
|
||||||
|
maxOutputTokens: 500,
|
||||||
|
topP: 0.9,
|
||||||
|
frequencyPenalty: 0.5,
|
||||||
|
presencePenalty: 0.3,
|
||||||
|
stopSequences: ['STOP'],
|
||||||
|
seed: 12345
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(generateText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
temperature: 0.7,
|
||||||
|
maxOutputTokens: 500,
|
||||||
|
topP: 0.9,
|
||||||
|
frequencyPenalty: 0.5,
|
||||||
|
presencePenalty: 0.3,
|
||||||
|
stopSequences: ['STOP'],
|
||||||
|
seed: 12345
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should support partial parameters', async () => {
|
||||||
|
await executor.generateText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple,
|
||||||
|
temperature: 0.5,
|
||||||
|
maxOutputTokens: 100
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(generateText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
temperature: 0.5,
|
||||||
|
maxOutputTokens: 100
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('Tool Calling', () => {
|
||||||
|
beforeEach(() => {
|
||||||
|
vi.mocked(generateText).mockResolvedValue(mockCompleteResponses.withToolCalls as any)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should support tool calling', async () => {
|
||||||
|
const result = await executor.generateText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.toolUse,
|
||||||
|
tools: testTools
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(generateText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
tools: testTools
|
||||||
|
})
|
||||||
|
)
|
||||||
|
|
||||||
|
expect(result.toolCalls).toBeDefined()
|
||||||
|
expect(result.toolCalls).toHaveLength(1)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should support toolChoice auto', async () => {
|
||||||
|
await executor.generateText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.toolUse,
|
||||||
|
tools: testTools,
|
||||||
|
toolChoice: 'auto'
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(generateText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
toolChoice: 'auto'
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should support toolChoice required', async () => {
|
||||||
|
await executor.generateText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.toolUse,
|
||||||
|
tools: testTools,
|
||||||
|
toolChoice: 'required'
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(generateText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
toolChoice: 'required'
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should support toolChoice none', async () => {
|
||||||
|
vi.mocked(generateText).mockResolvedValue(mockCompleteResponses.simple as any)
|
||||||
|
|
||||||
|
await executor.generateText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple,
|
||||||
|
tools: testTools,
|
||||||
|
toolChoice: 'none'
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(generateText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
toolChoice: 'none'
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should support specific tool selection', async () => {
|
||||||
|
await executor.generateText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.toolUse,
|
||||||
|
tools: testTools,
|
||||||
|
toolChoice: {
|
||||||
|
type: 'tool',
|
||||||
|
toolName: 'getWeather'
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(generateText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
toolChoice: {
|
||||||
|
type: 'tool',
|
||||||
|
toolName: 'getWeather'
|
||||||
|
}
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('Multiple Providers', () => {
|
||||||
|
it('should work with Anthropic provider', async () => {
|
||||||
|
const anthropicExecutor = RuntimeExecutor.create('anthropic', mockProviderConfigs.anthropic)
|
||||||
|
|
||||||
|
const anthropicModel = createMockLanguageModel({
|
||||||
|
provider: 'anthropic',
|
||||||
|
modelId: 'claude-3-5-sonnet-20241022'
|
||||||
|
})
|
||||||
|
|
||||||
|
vi.mocked(globalRegistryManagement.languageModel).mockReturnValue(anthropicModel)
|
||||||
|
|
||||||
|
await anthropicExecutor.generateText({
|
||||||
|
model: 'claude-3-5-sonnet-20241022',
|
||||||
|
messages: testMessages.simple
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(globalRegistryManagement.languageModel).toHaveBeenCalledWith('anthropic|claude-3-5-sonnet-20241022')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should work with Google provider', async () => {
|
||||||
|
const googleExecutor = RuntimeExecutor.create('google', mockProviderConfigs.google)
|
||||||
|
|
||||||
|
const googleModel = createMockLanguageModel({
|
||||||
|
provider: 'google',
|
||||||
|
modelId: 'gemini-2.0-flash-exp'
|
||||||
|
})
|
||||||
|
|
||||||
|
vi.mocked(globalRegistryManagement.languageModel).mockReturnValue(googleModel)
|
||||||
|
|
||||||
|
await googleExecutor.generateText({
|
||||||
|
model: 'gemini-2.0-flash-exp',
|
||||||
|
messages: testMessages.simple
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(globalRegistryManagement.languageModel).toHaveBeenCalledWith('google|gemini-2.0-flash-exp')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should work with xAI provider', async () => {
|
||||||
|
const xaiExecutor = RuntimeExecutor.create('xai', mockProviderConfigs.xai)
|
||||||
|
|
||||||
|
const xaiModel = createMockLanguageModel({
|
||||||
|
provider: 'xai',
|
||||||
|
modelId: 'grok-2-latest'
|
||||||
|
})
|
||||||
|
|
||||||
|
vi.mocked(globalRegistryManagement.languageModel).mockReturnValue(xaiModel)
|
||||||
|
|
||||||
|
await xaiExecutor.generateText({
|
||||||
|
model: 'grok-2-latest',
|
||||||
|
messages: testMessages.simple
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(globalRegistryManagement.languageModel).toHaveBeenCalledWith('xai|grok-2-latest')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should work with DeepSeek provider', async () => {
|
||||||
|
const deepseekExecutor = RuntimeExecutor.create('deepseek', mockProviderConfigs.deepseek)
|
||||||
|
|
||||||
|
const deepseekModel = createMockLanguageModel({
|
||||||
|
provider: 'deepseek',
|
||||||
|
modelId: 'deepseek-chat'
|
||||||
|
})
|
||||||
|
|
||||||
|
vi.mocked(globalRegistryManagement.languageModel).mockReturnValue(deepseekModel)
|
||||||
|
|
||||||
|
await deepseekExecutor.generateText({
|
||||||
|
model: 'deepseek-chat',
|
||||||
|
messages: testMessages.simple
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(globalRegistryManagement.languageModel).toHaveBeenCalledWith('deepseek|deepseek-chat')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('Plugin Integration', () => {
|
||||||
|
it('should execute all plugin hooks', async () => {
|
||||||
|
const pluginCalls: string[] = []
|
||||||
|
|
||||||
|
const testPlugin: AiPlugin = {
|
||||||
|
name: 'test-plugin',
|
||||||
|
onRequestStart: vi.fn(async () => {
|
||||||
|
pluginCalls.push('onRequestStart')
|
||||||
|
}),
|
||||||
|
transformParams: vi.fn(async (params) => {
|
||||||
|
pluginCalls.push('transformParams')
|
||||||
|
return { ...params, temperature: 0.8 }
|
||||||
|
}),
|
||||||
|
transformResult: vi.fn(async (result) => {
|
||||||
|
pluginCalls.push('transformResult')
|
||||||
|
return { ...result, text: result.text + ' [modified]' }
|
||||||
|
}),
|
||||||
|
onRequestEnd: vi.fn(async () => {
|
||||||
|
pluginCalls.push('onRequestEnd')
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const executorWithPlugin = RuntimeExecutor.create('openai', mockProviderConfigs.openai, [testPlugin])
|
||||||
|
|
||||||
|
const result = await executorWithPlugin.generateText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(pluginCalls).toEqual(['onRequestStart', 'transformParams', 'transformResult', 'onRequestEnd'])
|
||||||
|
|
||||||
|
// Verify transformed parameters
|
||||||
|
expect(generateText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
temperature: 0.8
|
||||||
|
})
|
||||||
|
)
|
||||||
|
|
||||||
|
// Verify transformed result
|
||||||
|
expect(result.text).toContain('[modified]')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle multiple plugins in order', async () => {
|
||||||
|
const pluginOrder: string[] = []
|
||||||
|
|
||||||
|
const plugin1: AiPlugin = {
|
||||||
|
name: 'plugin-1',
|
||||||
|
transformParams: vi.fn(async (params) => {
|
||||||
|
pluginOrder.push('plugin-1')
|
||||||
|
return { ...params, temperature: 0.5 }
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const plugin2: AiPlugin = {
|
||||||
|
name: 'plugin-2',
|
||||||
|
transformParams: vi.fn(async (params) => {
|
||||||
|
pluginOrder.push('plugin-2')
|
||||||
|
return { ...params, maxTokens: 200 }
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const executorWithPlugins = RuntimeExecutor.create('openai', mockProviderConfigs.openai, [plugin1, plugin2])
|
||||||
|
|
||||||
|
await executorWithPlugins.generateText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(pluginOrder).toEqual(['plugin-1', 'plugin-2'])
|
||||||
|
|
||||||
|
expect(generateText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
temperature: 0.5,
|
||||||
|
maxTokens: 200
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('Error Handling', () => {
|
||||||
|
it('should handle API errors', async () => {
|
||||||
|
const error = new Error('API request failed')
|
||||||
|
vi.mocked(generateText).mockRejectedValue(error)
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
executor.generateText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple
|
||||||
|
})
|
||||||
|
).rejects.toThrow('API request failed')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should execute onError plugin hook', async () => {
|
||||||
|
const error = new Error('Generation failed')
|
||||||
|
vi.mocked(generateText).mockRejectedValue(error)
|
||||||
|
|
||||||
|
const errorPlugin: AiPlugin = {
|
||||||
|
name: 'error-handler',
|
||||||
|
onError: vi.fn()
|
||||||
|
}
|
||||||
|
|
||||||
|
const executorWithPlugin = RuntimeExecutor.create('openai', mockProviderConfigs.openai, [errorPlugin])
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
executorWithPlugin.generateText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple
|
||||||
|
})
|
||||||
|
).rejects.toThrow('Generation failed')
|
||||||
|
|
||||||
|
// onError receives the original error and context with core fields
|
||||||
|
expect(errorPlugin.onError).toHaveBeenCalledWith(
|
||||||
|
error,
|
||||||
|
expect.objectContaining({
|
||||||
|
providerId: 'openai',
|
||||||
|
model: 'gpt-4'
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle model not found error', async () => {
|
||||||
|
const error = new Error('Model not found: invalid-model')
|
||||||
|
vi.mocked(globalRegistryManagement.languageModel).mockImplementation(() => {
|
||||||
|
throw error
|
||||||
|
})
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
executor.generateText({
|
||||||
|
model: 'invalid-model',
|
||||||
|
messages: testMessages.simple
|
||||||
|
})
|
||||||
|
).rejects.toThrow('Model not found')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('Usage and Metadata', () => {
|
||||||
|
it('should return usage information', async () => {
|
||||||
|
const result = await executor.generateText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(result.usage).toBeDefined()
|
||||||
|
expect(result.usage.inputTokens).toBe(15)
|
||||||
|
expect(result.usage.outputTokens).toBe(8)
|
||||||
|
expect(result.usage.totalTokens).toBe(23)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle warnings', async () => {
|
||||||
|
vi.mocked(generateText).mockResolvedValue(mockCompleteResponses.withWarnings as any)
|
||||||
|
|
||||||
|
const result = await executor.generateText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple,
|
||||||
|
temperature: 2.5 // Unsupported value
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(result.warnings).toBeDefined()
|
||||||
|
expect(result.warnings).toHaveLength(1)
|
||||||
|
expect(result.warnings![0].type).toBe('unsupported-setting')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('Abort Signal', () => {
|
||||||
|
it('should support abort signal', async () => {
|
||||||
|
const abortController = new AbortController()
|
||||||
|
|
||||||
|
await executor.generateText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple,
|
||||||
|
abortSignal: abortController.signal
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(generateText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
abortSignal: abortController.signal
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle aborted request', async () => {
|
||||||
|
const abortError = new Error('Request aborted')
|
||||||
|
abortError.name = 'AbortError'
|
||||||
|
|
||||||
|
vi.mocked(generateText).mockRejectedValue(abortError)
|
||||||
|
|
||||||
|
const abortController = new AbortController()
|
||||||
|
abortController.abort()
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
executor.generateText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple,
|
||||||
|
abortSignal: abortController.signal
|
||||||
|
})
|
||||||
|
).rejects.toThrow('Request aborted')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
531
packages/aiCore/src/core/runtime/__tests__/streamText.test.ts
Normal file
@ -0,0 +1,531 @@
|
|||||||
|
/**
|
||||||
|
* RuntimeExecutor.streamText Comprehensive Tests
|
||||||
|
* Tests streaming text generation across all providers with various parameters
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { streamText } from 'ai'
|
||||||
|
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
||||||
|
|
||||||
|
import { collectStreamChunks, createMockLanguageModel, mockProviderConfigs, testMessages } from '../../../__tests__'
|
||||||
|
import type { AiPlugin } from '../../plugins'
|
||||||
|
import { globalRegistryManagement } from '../../providers/RegistryManagement'
|
||||||
|
import { RuntimeExecutor } from '../executor'
|
||||||
|
|
||||||
|
// Mock AI SDK - use importOriginal to keep jsonSchema and other non-mocked exports
|
||||||
|
vi.mock('ai', async (importOriginal) => {
|
||||||
|
const actual = (await importOriginal()) as Record<string, unknown>
|
||||||
|
return {
|
||||||
|
...actual,
|
||||||
|
streamText: vi.fn()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
vi.mock('../../providers/RegistryManagement', () => ({
|
||||||
|
globalRegistryManagement: {
|
||||||
|
languageModel: vi.fn()
|
||||||
|
},
|
||||||
|
DEFAULT_SEPARATOR: '|'
|
||||||
|
}))
|
||||||
|
|
||||||
|
describe('RuntimeExecutor.streamText', () => {
|
||||||
|
let executor: RuntimeExecutor<'openai'>
|
||||||
|
let mockLanguageModel: any
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
vi.clearAllMocks()
|
||||||
|
|
||||||
|
executor = RuntimeExecutor.create('openai', mockProviderConfigs.openai)
|
||||||
|
|
||||||
|
mockLanguageModel = createMockLanguageModel({
|
||||||
|
provider: 'openai',
|
||||||
|
modelId: 'gpt-4'
|
||||||
|
})
|
||||||
|
|
||||||
|
vi.mocked(globalRegistryManagement.languageModel).mockReturnValue(mockLanguageModel)
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('Basic Functionality', () => {
|
||||||
|
it('should stream text with minimal parameters', async () => {
|
||||||
|
const mockStream = {
|
||||||
|
textStream: (async function* () {
|
||||||
|
yield 'Hello'
|
||||||
|
yield ' '
|
||||||
|
yield 'World'
|
||||||
|
})(),
|
||||||
|
fullStream: (async function* () {
|
||||||
|
yield { type: 'text-delta', textDelta: 'Hello' }
|
||||||
|
yield { type: 'text-delta', textDelta: ' ' }
|
||||||
|
yield { type: 'text-delta', textDelta: 'World' }
|
||||||
|
})(),
|
||||||
|
usage: Promise.resolve({ promptTokens: 5, completionTokens: 3, totalTokens: 8 })
|
||||||
|
}
|
||||||
|
|
||||||
|
vi.mocked(streamText).mockResolvedValue(mockStream as any)
|
||||||
|
|
||||||
|
const result = await executor.streamText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(streamText).toHaveBeenCalledWith({
|
||||||
|
model: mockLanguageModel,
|
||||||
|
messages: testMessages.simple
|
||||||
|
})
|
||||||
|
|
||||||
|
const chunks = await collectStreamChunks(result.textStream)
|
||||||
|
expect(chunks).toEqual(['Hello', ' ', 'World'])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should stream with system messages', async () => {
|
||||||
|
const mockStream = {
|
||||||
|
textStream: (async function* () {
|
||||||
|
yield 'Response'
|
||||||
|
})(),
|
||||||
|
fullStream: (async function* () {
|
||||||
|
yield { type: 'text-delta', textDelta: 'Response' }
|
||||||
|
})()
|
||||||
|
}
|
||||||
|
|
||||||
|
vi.mocked(streamText).mockResolvedValue(mockStream as any)
|
||||||
|
|
||||||
|
await executor.streamText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.withSystem
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(streamText).toHaveBeenCalledWith({
|
||||||
|
model: mockLanguageModel,
|
||||||
|
messages: testMessages.withSystem
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should stream multi-turn conversations', async () => {
|
||||||
|
const mockStream = {
|
||||||
|
textStream: (async function* () {
|
||||||
|
yield 'Multi-turn response'
|
||||||
|
})(),
|
||||||
|
fullStream: (async function* () {
|
||||||
|
yield { type: 'text-delta', textDelta: 'Multi-turn response' }
|
||||||
|
})()
|
||||||
|
}
|
||||||
|
|
||||||
|
vi.mocked(streamText).mockResolvedValue(mockStream as any)
|
||||||
|
|
||||||
|
await executor.streamText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.multiTurn
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(streamText).toHaveBeenCalled()
|
||||||
|
expect(streamText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
messages: testMessages.multiTurn
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('Temperature Parameter', () => {
|
||||||
|
const temperatures = [0, 0.3, 0.5, 0.7, 0.9, 1.0, 1.5, 2.0]
|
||||||
|
|
||||||
|
it.each(temperatures)('should support temperature=%s', async (temperature) => {
|
||||||
|
const mockStream = {
|
||||||
|
textStream: (async function* () {
|
||||||
|
yield 'Response'
|
||||||
|
})(),
|
||||||
|
fullStream: (async function* () {
|
||||||
|
yield { type: 'text-delta', textDelta: 'Response' }
|
||||||
|
})()
|
||||||
|
}
|
||||||
|
|
||||||
|
vi.mocked(streamText).mockResolvedValue(mockStream as any)
|
||||||
|
|
||||||
|
await executor.streamText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple,
|
||||||
|
temperature
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(streamText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
temperature
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('Max Tokens Parameter', () => {
|
||||||
|
const maxTokensValues = [10, 50, 100, 500, 1000, 2000, 4000]
|
||||||
|
|
||||||
|
it.each(maxTokensValues)('should support maxOutputTokens=%s', async (maxOutputTokens) => {
|
||||||
|
const mockStream = {
|
||||||
|
textStream: (async function* () {
|
||||||
|
yield 'Response'
|
||||||
|
})(),
|
||||||
|
fullStream: (async function* () {
|
||||||
|
yield { type: 'text-delta', textDelta: 'Response' }
|
||||||
|
})()
|
||||||
|
}
|
||||||
|
|
||||||
|
vi.mocked(streamText).mockResolvedValue(mockStream as any)
|
||||||
|
|
||||||
|
await executor.streamText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple,
|
||||||
|
maxOutputTokens
|
||||||
|
})
|
||||||
|
|
||||||
|
// Parameters are passed through without transformation
|
||||||
|
expect(streamText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
maxOutputTokens
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('Top P Parameter', () => {
|
||||||
|
const topPValues = [0.1, 0.3, 0.5, 0.7, 0.9, 0.95, 1.0]
|
||||||
|
|
||||||
|
it.each(topPValues)('should support topP=%s', async (topP) => {
|
||||||
|
const mockStream = {
|
||||||
|
textStream: (async function* () {
|
||||||
|
yield 'Response'
|
||||||
|
})(),
|
||||||
|
fullStream: (async function* () {
|
||||||
|
yield { type: 'text-delta', textDelta: 'Response' }
|
||||||
|
})()
|
||||||
|
}
|
||||||
|
|
||||||
|
vi.mocked(streamText).mockResolvedValue(mockStream as any)
|
||||||
|
|
||||||
|
await executor.streamText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple,
|
||||||
|
topP
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(streamText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
topP
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('Frequency and Presence Penalty', () => {
|
||||||
|
it('should support frequency penalty', async () => {
|
||||||
|
const penalties = [-2.0, -1.0, 0, 0.5, 1.0, 1.5, 2.0]
|
||||||
|
|
||||||
|
for (const frequencyPenalty of penalties) {
|
||||||
|
vi.clearAllMocks()
|
||||||
|
|
||||||
|
const mockStream = {
|
||||||
|
textStream: (async function* () {
|
||||||
|
yield 'Response'
|
||||||
|
})(),
|
||||||
|
fullStream: (async function* () {
|
||||||
|
yield { type: 'text-delta', textDelta: 'Response' }
|
||||||
|
})()
|
||||||
|
}
|
||||||
|
|
||||||
|
vi.mocked(streamText).mockResolvedValue(mockStream as any)
|
||||||
|
|
||||||
|
await executor.streamText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple,
|
||||||
|
frequencyPenalty
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(streamText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
frequencyPenalty
|
||||||
|
})
|
||||||
|
)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should support presence penalty', async () => {
|
||||||
|
const penalties = [-2.0, -1.0, 0, 0.5, 1.0, 1.5, 2.0]
|
||||||
|
|
||||||
|
for (const presencePenalty of penalties) {
|
||||||
|
vi.clearAllMocks()
|
||||||
|
|
||||||
|
const mockStream = {
|
||||||
|
textStream: (async function* () {
|
||||||
|
yield 'Response'
|
||||||
|
})(),
|
||||||
|
fullStream: (async function* () {
|
||||||
|
yield { type: 'text-delta', textDelta: 'Response' }
|
||||||
|
})()
|
||||||
|
}
|
||||||
|
|
||||||
|
vi.mocked(streamText).mockResolvedValue(mockStream as any)
|
||||||
|
|
||||||
|
await executor.streamText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple,
|
||||||
|
presencePenalty
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(streamText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
presencePenalty
|
||||||
|
})
|
||||||
|
)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should support both penalties together', async () => {
|
||||||
|
const mockStream = {
|
||||||
|
textStream: (async function* () {
|
||||||
|
yield 'Response'
|
||||||
|
})(),
|
||||||
|
fullStream: (async function* () {
|
||||||
|
yield { type: 'text-delta', textDelta: 'Response' }
|
||||||
|
})()
|
||||||
|
}
|
||||||
|
|
||||||
|
vi.mocked(streamText).mockResolvedValue(mockStream as any)
|
||||||
|
|
||||||
|
await executor.streamText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple,
|
||||||
|
frequencyPenalty: 0.5,
|
||||||
|
presencePenalty: 0.5
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(streamText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
frequencyPenalty: 0.5,
|
||||||
|
presencePenalty: 0.5
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('Seed Parameter', () => {
|
||||||
|
it('should support seed for deterministic output', async () => {
|
||||||
|
const seeds = [0, 12345, 67890, 999999]
|
||||||
|
|
||||||
|
for (const seed of seeds) {
|
||||||
|
vi.clearAllMocks()
|
||||||
|
|
||||||
|
const mockStream = {
|
||||||
|
textStream: (async function* () {
|
||||||
|
yield 'Response'
|
||||||
|
})(),
|
||||||
|
fullStream: (async function* () {
|
||||||
|
yield { type: 'text-delta', textDelta: 'Response' }
|
||||||
|
})()
|
||||||
|
}
|
||||||
|
|
||||||
|
vi.mocked(streamText).mockResolvedValue(mockStream as any)
|
||||||
|
|
||||||
|
await executor.streamText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple,
|
||||||
|
seed
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(streamText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
seed
|
||||||
|
})
|
||||||
|
)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('Abort Signal', () => {
|
||||||
|
it('should support abort signal', async () => {
|
||||||
|
const abortController = new AbortController()
|
||||||
|
|
||||||
|
const mockStream = {
|
||||||
|
textStream: (async function* () {
|
||||||
|
yield 'Response'
|
||||||
|
})(),
|
||||||
|
fullStream: (async function* () {
|
||||||
|
yield { type: 'text-delta', textDelta: 'Response' }
|
||||||
|
})()
|
||||||
|
}
|
||||||
|
|
||||||
|
vi.mocked(streamText).mockResolvedValue(mockStream as any)
|
||||||
|
|
||||||
|
await executor.streamText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple,
|
||||||
|
abortSignal: abortController.signal
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(streamText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
abortSignal: abortController.signal
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should handle abort during streaming', async () => {
|
||||||
|
const abortController = new AbortController()
|
||||||
|
|
||||||
|
const mockStream = {
|
||||||
|
textStream: (async function* () {
|
||||||
|
yield 'Start'
|
||||||
|
// Simulate abort
|
||||||
|
abortController.abort()
|
||||||
|
throw new Error('Aborted')
|
||||||
|
})(),
|
||||||
|
fullStream: (async function* () {
|
||||||
|
yield { type: 'text-delta', textDelta: 'Start' }
|
||||||
|
throw new Error('Aborted')
|
||||||
|
})()
|
||||||
|
}
|
||||||
|
|
||||||
|
vi.mocked(streamText).mockResolvedValue(mockStream as any)
|
||||||
|
|
||||||
|
const result = await executor.streamText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple,
|
||||||
|
abortSignal: abortController.signal
|
||||||
|
})
|
||||||
|
|
||||||
|
await expect(async () => {
|
||||||
|
// oxlint-disable-next-line no-unused-vars
|
||||||
|
for await (const _chunk of result.textStream) {
|
||||||
|
// Stream should be interrupted
|
||||||
|
}
|
||||||
|
}).rejects.toThrow('Aborted')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('Plugin Integration', () => {
|
||||||
|
it('should execute plugins during streaming', async () => {
|
||||||
|
const pluginCalls: string[] = []
|
||||||
|
|
||||||
|
const testPlugin: AiPlugin = {
|
||||||
|
name: 'test-plugin',
|
||||||
|
onRequestStart: vi.fn(async () => {
|
||||||
|
pluginCalls.push('onRequestStart')
|
||||||
|
}),
|
||||||
|
transformParams: vi.fn(async (params) => {
|
||||||
|
pluginCalls.push('transformParams')
|
||||||
|
return { ...params, temperature: 0.5 }
|
||||||
|
}),
|
||||||
|
onRequestEnd: vi.fn(async () => {
|
||||||
|
pluginCalls.push('onRequestEnd')
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const executorWithPlugin = RuntimeExecutor.create('openai', mockProviderConfigs.openai, [testPlugin])
|
||||||
|
|
||||||
|
const mockStream = {
|
||||||
|
textStream: (async function* () {
|
||||||
|
yield 'Response'
|
||||||
|
})(),
|
||||||
|
fullStream: (async function* () {
|
||||||
|
yield { type: 'text-delta', textDelta: 'Response' }
|
||||||
|
})()
|
||||||
|
}
|
||||||
|
|
||||||
|
vi.mocked(streamText).mockResolvedValue(mockStream as any)
|
||||||
|
|
||||||
|
const result = await executorWithPlugin.streamText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple
|
||||||
|
})
|
||||||
|
|
||||||
|
// Consume stream
|
||||||
|
// oxlint-disable-next-line no-unused-vars
|
||||||
|
for await (const _chunk of result.textStream) {
|
||||||
|
// Stream chunks
|
||||||
|
}
|
||||||
|
|
||||||
|
expect(pluginCalls).toContain('onRequestStart')
|
||||||
|
expect(pluginCalls).toContain('transformParams')
|
||||||
|
|
||||||
|
// Verify transformed parameters were used
|
||||||
|
expect(streamText).toHaveBeenCalledWith(
|
||||||
|
expect.objectContaining({
|
||||||
|
temperature: 0.5
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('Full Stream with Finish Reason', () => {
|
||||||
|
it('should provide finish reason in full stream', async () => {
|
||||||
|
const mockStream = {
|
||||||
|
textStream: (async function* () {
|
||||||
|
yield 'Response'
|
||||||
|
})(),
|
||||||
|
fullStream: (async function* () {
|
||||||
|
yield { type: 'text-delta', textDelta: 'Response' }
|
||||||
|
yield {
|
||||||
|
type: 'finish',
|
||||||
|
finishReason: 'stop',
|
||||||
|
usage: { promptTokens: 5, completionTokens: 3, totalTokens: 8 }
|
||||||
|
}
|
||||||
|
})()
|
||||||
|
}
|
||||||
|
|
||||||
|
vi.mocked(streamText).mockResolvedValue(mockStream as any)
|
||||||
|
|
||||||
|
const result = await executor.streamText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple
|
||||||
|
})
|
||||||
|
|
||||||
|
const fullChunks = await collectStreamChunks(result.fullStream)
|
||||||
|
|
||||||
|
expect(fullChunks).toHaveLength(2)
|
||||||
|
expect(fullChunks[0]).toEqual({ type: 'text-delta', textDelta: 'Response' })
|
||||||
|
expect(fullChunks[1]).toEqual({
|
||||||
|
type: 'finish',
|
||||||
|
finishReason: 'stop',
|
||||||
|
usage: { promptTokens: 5, completionTokens: 3, totalTokens: 8 }
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('Error Handling', () => {
|
||||||
|
it('should handle streaming errors', async () => {
|
||||||
|
const error = new Error('Streaming failed')
|
||||||
|
vi.mocked(streamText).mockRejectedValue(error)
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
executor.streamText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple
|
||||||
|
})
|
||||||
|
).rejects.toThrow('Streaming failed')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should execute onError plugin hook on failure', async () => {
|
||||||
|
const error = new Error('Stream error')
|
||||||
|
vi.mocked(streamText).mockRejectedValue(error)
|
||||||
|
|
||||||
|
const errorPlugin: AiPlugin = {
|
||||||
|
name: 'error-handler',
|
||||||
|
onError: vi.fn()
|
||||||
|
}
|
||||||
|
|
||||||
|
const executorWithPlugin = RuntimeExecutor.create('openai', mockProviderConfigs.openai, [errorPlugin])
|
||||||
|
|
||||||
|
await expect(
|
||||||
|
executorWithPlugin.streamText({
|
||||||
|
model: 'gpt-4',
|
||||||
|
messages: testMessages.simple
|
||||||
|
})
|
||||||
|
).rejects.toThrow('Stream error')
|
||||||
|
|
||||||
|
// onError receives the original error and context with core fields
|
||||||
|
expect(errorPlugin.onError).toHaveBeenCalledWith(
|
||||||
|
error,
|
||||||
|
expect.objectContaining({
|
||||||
|
providerId: 'openai',
|
||||||
|
model: 'gpt-4'
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@ -1,12 +1,20 @@
|
|||||||
|
import path from 'node:path'
|
||||||
|
import { fileURLToPath } from 'node:url'
|
||||||
|
|
||||||
import { defineConfig } from 'vitest/config'
|
import { defineConfig } from 'vitest/config'
|
||||||
|
|
||||||
|
const __dirname = path.dirname(fileURLToPath(import.meta.url))
|
||||||
|
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
test: {
|
test: {
|
||||||
globals: true
|
globals: true,
|
||||||
|
setupFiles: [path.resolve(__dirname, './src/__tests__/setup.ts')]
|
||||||
},
|
},
|
||||||
resolve: {
|
resolve: {
|
||||||
alias: {
|
alias: {
|
||||||
'@': './src'
|
'@': path.resolve(__dirname, './src'),
|
||||||
|
// Mock external packages that may not be available in test environment
|
||||||
|
'@cherrystudio/ai-sdk-provider': path.resolve(__dirname, './src/__tests__/mocks/ai-sdk-provider.ts')
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
esbuild: {
|
esbuild: {
|
||||||
|
|||||||
@ -41,6 +41,7 @@ export enum IpcChannel {
|
|||||||
App_SetFullScreen = 'app:set-full-screen',
|
App_SetFullScreen = 'app:set-full-screen',
|
||||||
App_IsFullScreen = 'app:is-full-screen',
|
App_IsFullScreen = 'app:is-full-screen',
|
||||||
App_GetSystemFonts = 'app:get-system-fonts',
|
App_GetSystemFonts = 'app:get-system-fonts',
|
||||||
|
APP_CrashRenderProcess = 'app:crash-render-process',
|
||||||
|
|
||||||
App_MacIsProcessTrusted = 'app:mac-is-process-trusted',
|
App_MacIsProcessTrusted = 'app:mac-is-process-trusted',
|
||||||
App_MacRequestProcessTrust = 'app:mac-request-process-trust',
|
App_MacRequestProcessTrust = 'app:mac-request-process-trust',
|
||||||
@ -54,6 +55,8 @@ export enum IpcChannel {
|
|||||||
Webview_SetOpenLinkExternal = 'webview:set-open-link-external',
|
Webview_SetOpenLinkExternal = 'webview:set-open-link-external',
|
||||||
Webview_SetSpellCheckEnabled = 'webview:set-spell-check-enabled',
|
Webview_SetSpellCheckEnabled = 'webview:set-spell-check-enabled',
|
||||||
Webview_SearchHotkey = 'webview:search-hotkey',
|
Webview_SearchHotkey = 'webview:search-hotkey',
|
||||||
|
Webview_PrintToPDF = 'webview:print-to-pdf',
|
||||||
|
Webview_SaveAsHTML = 'webview:save-as-html',
|
||||||
|
|
||||||
// Open
|
// Open
|
||||||
Open_Path = 'open:path',
|
Open_Path = 'open:path',
|
||||||
@ -89,6 +92,8 @@ export enum IpcChannel {
|
|||||||
Mcp_AbortTool = 'mcp:abort-tool',
|
Mcp_AbortTool = 'mcp:abort-tool',
|
||||||
Mcp_GetServerVersion = 'mcp:get-server-version',
|
Mcp_GetServerVersion = 'mcp:get-server-version',
|
||||||
Mcp_Progress = 'mcp:progress',
|
Mcp_Progress = 'mcp:progress',
|
||||||
|
Mcp_GetServerLogs = 'mcp:get-server-logs',
|
||||||
|
Mcp_ServerLog = 'mcp:server-log',
|
||||||
// Python
|
// Python
|
||||||
Python_Execute = 'python:execute',
|
Python_Execute = 'python:execute',
|
||||||
|
|
||||||
@ -195,6 +200,9 @@ export enum IpcChannel {
|
|||||||
File_ValidateNotesDirectory = 'file:validateNotesDirectory',
|
File_ValidateNotesDirectory = 'file:validateNotesDirectory',
|
||||||
File_StartWatcher = 'file:startWatcher',
|
File_StartWatcher = 'file:startWatcher',
|
||||||
File_StopWatcher = 'file:stopWatcher',
|
File_StopWatcher = 'file:stopWatcher',
|
||||||
|
File_PauseWatcher = 'file:pauseWatcher',
|
||||||
|
File_ResumeWatcher = 'file:resumeWatcher',
|
||||||
|
File_BatchUploadMarkdown = 'file:batchUploadMarkdown',
|
||||||
File_ShowInFolder = 'file:showInFolder',
|
File_ShowInFolder = 'file:showInFolder',
|
||||||
|
|
||||||
// file service
|
// file service
|
||||||
@ -234,6 +242,10 @@ export enum IpcChannel {
|
|||||||
System_GetDeviceType = 'system:getDeviceType',
|
System_GetDeviceType = 'system:getDeviceType',
|
||||||
System_GetHostname = 'system:getHostname',
|
System_GetHostname = 'system:getHostname',
|
||||||
System_GetCpuName = 'system:getCpuName',
|
System_GetCpuName = 'system:getCpuName',
|
||||||
|
System_CheckGitBash = 'system:checkGitBash',
|
||||||
|
System_GetGitBashPath = 'system:getGitBashPath',
|
||||||
|
System_GetGitBashPathInfo = 'system:getGitBashPathInfo',
|
||||||
|
System_SetGitBashPath = 'system:setGitBashPath',
|
||||||
|
|
||||||
// DevTools
|
// DevTools
|
||||||
System_ToggleDevTools = 'system:toggleDevTools',
|
System_ToggleDevTools = 'system:toggleDevTools',
|
||||||
@ -288,6 +300,8 @@ export enum IpcChannel {
|
|||||||
Selection_ActionWindowClose = 'selection:action-window-close',
|
Selection_ActionWindowClose = 'selection:action-window-close',
|
||||||
Selection_ActionWindowMinimize = 'selection:action-window-minimize',
|
Selection_ActionWindowMinimize = 'selection:action-window-minimize',
|
||||||
Selection_ActionWindowPin = 'selection:action-window-pin',
|
Selection_ActionWindowPin = 'selection:action-window-pin',
|
||||||
|
// [Windows only] Electron bug workaround - can be removed once https://github.com/electron/electron/issues/48554 is fixed
|
||||||
|
Selection_ActionWindowResize = 'selection:action-window-resize',
|
||||||
Selection_ProcessAction = 'selection:process-action',
|
Selection_ProcessAction = 'selection:process-action',
|
||||||
Selection_UpdateActionData = 'selection:update-action-data',
|
Selection_UpdateActionData = 'selection:update-action-data',
|
||||||
|
|
||||||
|
|||||||
@ -7,6 +7,11 @@ export const documentExts = ['.pdf', '.doc', '.docx', '.pptx', '.xlsx', '.odt',
|
|||||||
export const thirdPartyApplicationExts = ['.draftsExport']
|
export const thirdPartyApplicationExts = ['.draftsExport']
|
||||||
export const bookExts = ['.epub']
|
export const bookExts = ['.epub']
|
||||||
|
|
||||||
|
export const API_SERVER_DEFAULTS = {
|
||||||
|
HOST: '127.0.0.1',
|
||||||
|
PORT: 23333
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A flat array of all file extensions known by the linguist database.
|
* A flat array of all file extensions known by the linguist database.
|
||||||
* This is the primary source for identifying code files.
|
* This is the primary source for identifying code files.
|
||||||
@ -197,12 +202,22 @@ export enum FeedUrl {
|
|||||||
GITHUB_LATEST = 'https://github.com/CherryHQ/cherry-studio/releases/latest/download'
|
GITHUB_LATEST = 'https://github.com/CherryHQ/cherry-studio/releases/latest/download'
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export enum UpdateConfigUrl {
|
||||||
|
GITHUB = 'https://raw.githubusercontent.com/CherryHQ/cherry-studio/refs/heads/x-files/app-upgrade-config/app-upgrade-config.json',
|
||||||
|
GITCODE = 'https://raw.gitcode.com/CherryHQ/cherry-studio/raw/x-files%2Fapp-upgrade-config/app-upgrade-config.json'
|
||||||
|
}
|
||||||
|
|
||||||
export enum UpgradeChannel {
|
export enum UpgradeChannel {
|
||||||
LATEST = 'latest', // 最新稳定版本
|
LATEST = 'latest', // 最新稳定版本
|
||||||
RC = 'rc', // 公测版本
|
RC = 'rc', // 公测版本
|
||||||
BETA = 'beta' // 预览版本
|
BETA = 'beta' // 预览版本
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export enum UpdateMirror {
|
||||||
|
GITHUB = 'github',
|
||||||
|
GITCODE = 'gitcode'
|
||||||
|
}
|
||||||
|
|
||||||
export const defaultTimeout = 10 * 1000 * 60
|
export const defaultTimeout = 10 * 1000 * 60
|
||||||
|
|
||||||
export const occupiedDirs = ['logs', 'Network', 'Partitions/webview/Network']
|
export const occupiedDirs = ['logs', 'Network', 'Partitions/webview/Network']
|
||||||
@ -473,3 +488,11 @@ export const MACOS_TERMINALS_WITH_COMMANDS: TerminalConfigWithCommand[] = [
|
|||||||
|
|
||||||
// resources/scripts should be maintained manually
|
// resources/scripts should be maintained manually
|
||||||
export const HOME_CHERRY_DIR = '.cherrystudio'
|
export const HOME_CHERRY_DIR = '.cherrystudio'
|
||||||
|
|
||||||
|
// Git Bash path configuration types
|
||||||
|
export type GitBashPathSource = 'manual' | 'auto'
|
||||||
|
|
||||||
|
export interface GitBashPathInfo {
|
||||||
|
path: string | null
|
||||||
|
source: GitBashPathSource | null
|
||||||
|
}
|
||||||
|
|||||||
48
packages/shared/config/providers.ts
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
/**
|
||||||
|
* @fileoverview Shared provider configuration for Claude Code and Anthropic API compatibility
|
||||||
|
*
|
||||||
|
* This module defines which models from specific providers support the Anthropic API endpoint.
|
||||||
|
* Used by both the Code Tools page and the Anthropic SDK client.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Silicon provider models that support Anthropic API endpoint.
|
||||||
|
* These models can be used with Claude Code via the Anthropic-compatible API.
|
||||||
|
*
|
||||||
|
* @see https://docs.siliconflow.cn/cn/api-reference/chat-completions/messages
|
||||||
|
*/
|
||||||
|
export const SILICON_ANTHROPIC_COMPATIBLE_MODELS: readonly string[] = [
|
||||||
|
// DeepSeek V3.1 series
|
||||||
|
'Pro/deepseek-ai/DeepSeek-V3.1-Terminus',
|
||||||
|
'deepseek-ai/DeepSeek-V3.1',
|
||||||
|
'Pro/deepseek-ai/DeepSeek-V3.1',
|
||||||
|
// DeepSeek V3 series
|
||||||
|
'deepseek-ai/DeepSeek-V3',
|
||||||
|
'Pro/deepseek-ai/DeepSeek-V3',
|
||||||
|
// Moonshot/Kimi series
|
||||||
|
'moonshotai/Kimi-K2-Instruct-0905',
|
||||||
|
'Pro/moonshotai/Kimi-K2-Instruct-0905',
|
||||||
|
'moonshotai/Kimi-Dev-72B',
|
||||||
|
// Baidu ERNIE
|
||||||
|
'baidu/ERNIE-4.5-300B-A47B'
|
||||||
|
]
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a Set for efficient lookup of silicon Anthropic-compatible model IDs.
|
||||||
|
*/
|
||||||
|
const SILICON_ANTHROPIC_COMPATIBLE_MODEL_SET = new Set(SILICON_ANTHROPIC_COMPATIBLE_MODELS)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks if a model ID is compatible with Anthropic API on Silicon provider.
|
||||||
|
*
|
||||||
|
* @param modelId - The model ID to check
|
||||||
|
* @returns true if the model supports Anthropic API endpoint
|
||||||
|
*/
|
||||||
|
export function isSiliconAnthropicCompatibleModel(modelId: string): boolean {
|
||||||
|
return SILICON_ANTHROPIC_COMPATIBLE_MODEL_SET.has(modelId)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Silicon provider's Anthropic API host URL.
|
||||||
|
*/
|
||||||
|
export const SILICON_ANTHROPIC_API_HOST = 'https://api.siliconflow.cn'
|
||||||
@ -10,7 +10,7 @@ export type LoaderReturn = {
|
|||||||
messageSource?: 'preprocess' | 'embedding' | 'validation'
|
messageSource?: 'preprocess' | 'embedding' | 'validation'
|
||||||
}
|
}
|
||||||
|
|
||||||
export type FileChangeEventType = 'add' | 'change' | 'unlink' | 'addDir' | 'unlinkDir'
|
export type FileChangeEventType = 'add' | 'change' | 'unlink' | 'addDir' | 'unlinkDir' | 'refresh'
|
||||||
|
|
||||||
export type FileChangeEvent = {
|
export type FileChangeEvent = {
|
||||||
eventType: FileChangeEventType
|
eventType: FileChangeEventType
|
||||||
@ -23,6 +23,14 @@ export type MCPProgressEvent = {
|
|||||||
progress: number // 0-1 range
|
progress: number // 0-1 range
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export type MCPServerLogEntry = {
|
||||||
|
timestamp: number
|
||||||
|
level: 'debug' | 'info' | 'warn' | 'error' | 'stderr' | 'stdout'
|
||||||
|
message: string
|
||||||
|
data?: any
|
||||||
|
source?: string
|
||||||
|
}
|
||||||
|
|
||||||
export type WebviewKeyEvent = {
|
export type WebviewKeyEvent = {
|
||||||
webviewId: number
|
webviewId: number
|
||||||
key: string
|
key: string
|
||||||
|
|||||||
@ -4,3 +4,34 @@ export const defaultAppHeaders = () => {
|
|||||||
'X-Title': 'Cherry Studio'
|
'X-Title': 'Cherry Studio'
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Following two function are not being used for now.
|
||||||
|
// I may use them in the future, so just keep them commented. - by eurfelux
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Converts an `undefined` value to `null`, otherwise returns the value as-is.
|
||||||
|
* @param value - The value to check
|
||||||
|
* @returns `null` if the input is `undefined`; otherwise the input value
|
||||||
|
*/
|
||||||
|
|
||||||
|
// export function toNullIfUndefined<T>(value: T | undefined): T | null {
|
||||||
|
// if (value === undefined) {
|
||||||
|
// return null
|
||||||
|
// } else {
|
||||||
|
// return value
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Converts a `null` value to `undefined`, otherwise returns the value as-is.
|
||||||
|
* @param value - The value to check
|
||||||
|
* @returns `undefined` if the input is `null`; otherwise the input value
|
||||||
|
*/
|
||||||
|
|
||||||
|
// export function toUndefinedIfNull<T>(value: T | null): T | undefined {
|
||||||
|
// if (value === null) {
|
||||||
|
// return undefined
|
||||||
|
// } else {
|
||||||
|
// return value
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
|||||||
@ -1,42 +1,64 @@
|
|||||||
import { defineConfig, devices } from '@playwright/test'
|
import { defineConfig } from '@playwright/test'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* See https://playwright.dev/docs/test-configuration.
|
* Playwright configuration for Electron e2e testing.
|
||||||
|
* See https://playwright.dev/docs/test-configuration
|
||||||
*/
|
*/
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
// Look for test files, relative to this configuration file.
|
// Look for test files in the specs directory
|
||||||
testDir: './tests/e2e',
|
testDir: './tests/e2e/specs',
|
||||||
/* Run tests in files in parallel */
|
|
||||||
fullyParallel: true,
|
|
||||||
/* Fail the build on CI if you accidentally left test.only in the source code. */
|
|
||||||
forbidOnly: !!process.env.CI,
|
|
||||||
/* Retry on CI only */
|
|
||||||
retries: process.env.CI ? 2 : 0,
|
|
||||||
/* Opt out of parallel tests on CI. */
|
|
||||||
workers: process.env.CI ? 1 : undefined,
|
|
||||||
/* Reporter to use. See https://playwright.dev/docs/test-reporters */
|
|
||||||
reporter: 'html',
|
|
||||||
/* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
|
|
||||||
use: {
|
|
||||||
/* Base URL to use in actions like `await page.goto('/')`. */
|
|
||||||
// baseURL: 'http://localhost:3000',
|
|
||||||
|
|
||||||
/* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
|
// Global timeout for each test
|
||||||
trace: 'on-first-retry'
|
timeout: 60000,
|
||||||
|
|
||||||
|
// Assertion timeout
|
||||||
|
expect: {
|
||||||
|
timeout: 10000
|
||||||
},
|
},
|
||||||
|
|
||||||
/* Configure projects for major browsers */
|
// Electron apps should run tests sequentially to avoid conflicts
|
||||||
|
fullyParallel: false,
|
||||||
|
workers: 1,
|
||||||
|
|
||||||
|
// Fail the build on CI if you accidentally left test.only in the source code
|
||||||
|
forbidOnly: !!process.env.CI,
|
||||||
|
|
||||||
|
// Retry on CI only
|
||||||
|
retries: process.env.CI ? 2 : 0,
|
||||||
|
|
||||||
|
// Reporter configuration
|
||||||
|
reporter: [['html', { outputFolder: 'playwright-report' }], ['list']],
|
||||||
|
|
||||||
|
// Global setup and teardown
|
||||||
|
globalSetup: './tests/e2e/global-setup.ts',
|
||||||
|
globalTeardown: './tests/e2e/global-teardown.ts',
|
||||||
|
|
||||||
|
// Output directory for test artifacts
|
||||||
|
outputDir: './test-results',
|
||||||
|
|
||||||
|
// Shared settings for all tests
|
||||||
|
use: {
|
||||||
|
// Collect trace when retrying the failed test
|
||||||
|
trace: 'retain-on-failure',
|
||||||
|
|
||||||
|
// Take screenshot only on failure
|
||||||
|
screenshot: 'only-on-failure',
|
||||||
|
|
||||||
|
// Record video only on failure
|
||||||
|
video: 'retain-on-failure',
|
||||||
|
|
||||||
|
// Action timeout
|
||||||
|
actionTimeout: 15000,
|
||||||
|
|
||||||
|
// Navigation timeout
|
||||||
|
navigationTimeout: 30000
|
||||||
|
},
|
||||||
|
|
||||||
|
// Single project for Electron testing
|
||||||
projects: [
|
projects: [
|
||||||
{
|
{
|
||||||
name: 'chromium',
|
name: 'electron',
|
||||||
use: { ...devices['Desktop Chrome'] }
|
testMatch: '**/*.spec.ts'
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|
||||||
/* Run your local dev server before starting the tests */
|
|
||||||
// webServer: {
|
|
||||||
// command: 'npm run start',
|
|
||||||
// url: 'http://localhost:3000',
|
|
||||||
// reuseExistingServer: !process.env.CI,
|
|
||||||
// },
|
|
||||||
})
|
})
|
||||||
|
|||||||
@ -11,7 +11,7 @@ const OVMS_EX_URL = 'https://gitcode.com/gcw_ggDjjkY3/kjfile/releases/download/d
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* error code:
|
* error code:
|
||||||
* 101: Unsupported CPU (not Intel Ultra)
|
* 101: Unsupported CPU (not Intel)
|
||||||
* 102: Unsupported platform (not Windows)
|
* 102: Unsupported platform (not Windows)
|
||||||
* 103: Download failed
|
* 103: Download failed
|
||||||
* 104: Installation failed
|
* 104: Installation failed
|
||||||
@ -213,8 +213,8 @@ async function installOvms() {
|
|||||||
console.log(`CPU Name: ${cpuName}`)
|
console.log(`CPU Name: ${cpuName}`)
|
||||||
|
|
||||||
// Check if CPU name contains "Ultra"
|
// Check if CPU name contains "Ultra"
|
||||||
if (!cpuName.toLowerCase().includes('intel') || !cpuName.toLowerCase().includes('ultra')) {
|
if (!cpuName.toLowerCase().includes('intel')) {
|
||||||
console.error('OVMS installation requires an Intel(R) Core(TM) Ultra CPU.')
|
console.error('OVMS installation requires an Intel CPU.')
|
||||||
return 101
|
return 101
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@ -50,7 +50,7 @@ Usage Instructions:
|
|||||||
- pt-pt (Portuguese)
|
- pt-pt (Portuguese)
|
||||||
|
|
||||||
Run Command:
|
Run Command:
|
||||||
yarn auto:i18n
|
yarn i18n:translate
|
||||||
|
|
||||||
Performance Optimization Recommendations:
|
Performance Optimization Recommendations:
|
||||||
- For stable API services: MAX_CONCURRENT_TRANSLATIONS=8, TRANSLATION_DELAY_MS=50
|
- For stable API services: MAX_CONCURRENT_TRANSLATIONS=8, TRANSLATION_DELAY_MS=50
|
||||||
|
|||||||
@ -145,7 +145,7 @@ export function main() {
|
|||||||
console.log('i18n 检查已通过')
|
console.log('i18n 检查已通过')
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
console.error(e)
|
console.error(e)
|
||||||
throw new Error(`检查未通过。尝试运行 yarn sync:i18n 以解决问题。`)
|
throw new Error(`检查未通过。尝试运行 yarn i18n:sync 以解决问题。`)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||